python - 使用下划线忽略传递给我们不需要的函数的值是一种好习惯吗？

Question

我正在开发 Django 休息框架，它为 ModelViewSet 中的 detail_route 指定了函数原型(prototype)的集合格式。一些背景:-该函数接受 request object 和 lookup_field，后者可以是特定表的主键。

@detail_route(methods=["get"], url_path="get-some-data")
    def get_some_data(self, request, id=None):
        return Response(get_some_data(id))

现在如你所见，我这里不需要请求对象，所以我应该保持这样吗？或者改成

@detail_route(methods=["get"], url_path="get-some-data")
    def get_some_data(self, _, id=None):
        return Response(get_some_data(id))

这里我把request改成了_，表示不需要这个值。

应该遵循哪种方法？我应该让它保留为请求，还是将其更改为下划线？

Answer 1

对于方法参数，我会始终使用正确的变量名称，这样将来无论是我还是我的同事，如果我将此代码提供给其他人，他们都不必费力去理解它是什么。

现在你可能会想忽略它，但因为它是一个方法参数，所以最好有一个它代表的名字。

---

或者，假设您要添加一个文档字符串，您要在其中包含并定义哪个参数是什么。如果有人拥有，您自己会很感激:

@param request: HTTP request object

代替:

@param _: HTTP request object