invalid-module-name (N999)
源自 pep8-naming linter。
作用
检查模块名称是否遵循 snake_case
命名约定或是否无效。
为什么这不好?
PEP 8 建议模块名称使用 snake_case
命名约定。
模块应具有简短的全小写名称。如果使用下划线可以提高可读性,则可以在模块名称中使用下划线。Python 包也应具有简短的全小写名称,但不鼓励使用下划线。
当用 C 或 C++ 编写的扩展模块具有一个伴随的 Python 模块,该模块提供更高级别的接口(例如,更面向对象的接口)时,C/C++ 模块具有前导下划线(例如,
_socket
)。
此外,为了使 Python 模块可以导入,它们必须是有效的标识符。因此,它们不能以数字开头,也不能与硬关键字(如 import
或 class
)冲突。
示例
- 不要使用
example-module-name
或example module name
,请使用example_module_name
。 - 不要使用
ExampleModule
,请使用example_module
。