使Pylint能够强制使用一致的文件头。
pylintfileheader的Python项目详细描述
Pylint文件头
Pylint插件强制执行一致的文件/模块头。
安装
您可以使用pypi中的pip
安装包:
pip install pylintfileheader
配置
通过执行pylint --generate-rcfile
生成.pylintrc
文件。
然后将pylintfileheader
添加到要加载的插件中,并将file-header
选项设置为文件头应该匹配的regular expression。
当省略file-header
设置时,pylint将通过。
示例
设置
.pylintrc:
[MASTER] load-plugins=pylintfileheader file-header=# -----------\n# lorem ipsum\n# -----------
有效的示例.py:
# -----------# lorem ipsum# -----------print('I am a valid example')
无效的示例。py:
# lorem ipsumprint('I am an invalid example')
评估
pylint valid_example.py
计算结果为:Using config file /path/to/your/.pylintrc ------------------------------------ Your code has been rated at 10.00/10
pylint invalid_example.py
计算结果为:Using config file /path/to/your/.pylintrc ************* Module invalid_example C: 1, 0: File header should match regex "# -----------\n# lorem ipsum\n# -----------\ (invalid-file-header) ----------------------------------- Your code has been rated at 8.57/10
贡献
如果发现错误或缺少功能,请毫不犹豫地file an issue。
欢迎拉取请求!
支架
当你喜欢这个包时,一定要star the repository。我一直在寻找新的想法和反馈。
此外,还可以donate via paypal。