跳到内容

未文档化的公共初始化方法 (D107)

源自 pydocstyle 代码检查器。

作用

检查缺少文档字符串的公共 __init__ 方法定义。

为什么这不好？

公共 __init__ 方法用于初始化对象。__init__ 方法应该通过文档字符串记录其行为、参数、副作用、异常以及任何可能与用户相关的信息。

如果代码库遵循 __init__ 方法文档字符串的标准格式，请遵循该格式以保持一致性。

示例

class City:
    def __init__(self, name: str, population: int) -> None:
        self.name: str = name
        self.population: int = population

建议改为

class City:
    def __init__(self, name: str, population: int) -> None:
        """Initialize a city with a name and population."""
        self.name: str = name
        self.population: int = population

Options (选项)

参考