使Pylint能够强制使用一致的文件头。

pylintfileheader的Python项目详细描述


Pylint文件头

PypiPyPI - Python VersionPyPI - DownloadsStars
PyPI - LicenseBuild StatusCodecovPRs Welcome
Donate

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

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java如何在Android上的可访问文件夹中创建文件?(非根)   tomcat Unix脚本未使用Process Runtime在Java中运行   模拟器中的java Android AudioTrack速度异常   java是否创建具有特定@ConditionalOnProperty的注释?   java如何使用json数据从gridview中的URL加载图像?(类别和子类别)   ConcurrentHashMap的java锁定值对象   如何在具有额外属性的Java枚举上执行Javadoc?   java如何修复SocketException连接重置问题?   无附加表的java JPA实体继承   java Android应用程序在启动屏幕后崩溃   java如何将Arraylist保存到文件?   java restTemplate从restfull Web服务获取文件数组   java活动带布局隐藏导航栏   socket未接收任何内容的java BufferedReader