用pep8检查python文件的git commit钩子。

git-pep8-commit-hook的Python项目详细描述


git_pep8_commit_钩子

Build Status

git预提交钩子,用于检查python代码的编码风格。钩子 需要PEP8。它将检查扩展名为.py的文件和文件 第一行包含#!(shebang)和python。沉重的 灵感来源于塞巴斯蒂安的git-pylint-commit-hook,部分来源于塞巴斯蒂安的git-pylint-commit-hook 达尔格伦。

由于pep8本身在默认情况下会在 存储库根目录,这个脚本也是。剧本没有 setup.cfg文件。可以放置脚本的选项 在配置文件的[pep8_pre_commit_hook]部分中,或者 作为命令行参数传递。如果在中指定了相同的选项 配置文件和参数,配置文件 优先考虑。

安装

通过pypi安装

pip install git_pep8_commit_hook

使用量

安装脚本后,如果将其添加到pre-commit文件中 应该放在git文件夹的hooks子文件夹中 (通常是.git/hooks),当您运行 git commit。如果要跳过特定提交的检查,则 可以添加-n标志并运行git commit -n

配置

默认情况下,脚本在根目录中查找setup.cfg。 你的仓库。如果脚本找不到配置文件,则 使用默认设置。文件可能如下所示:

[pep8]
ignore = E226,E302,E41
max-line-length = 79

[pep8_pre_commit_hook]
max-violations-per-file = 5

pep8使用[pep8]部分。那[pep8_pre_commit_hook] 节由commit hook脚本使用。您可以指定以下内容 选项:

  • pep8 command用于实际命令,例如,如果pep8是 不是全局安装,而是在项目内的virtualenv中 本身。
  • pep8 params允许将自定义参数传递给pep8
  • max每个文件的冲突允许您指定 您愿意接受的任何文件的PEP 0008标准。如果在 至少有一个文件具有超过指定数量的冲突,则 提交将被阻止。默认值为0。

或者,您可以将上述内容直接传递给commit hook脚本 作为论据。除上述内容外,您还可以通过以下 脚本参数:

  • config允许您为两个pep8指定备用配置文件 自身和commit hook脚本。
  • version显示提交挂钩脚本的当前版本。
  • help显示解释参数的帮助消息。

运行测试

测试使用pytest编写。你可以在没有 安装pytest,但不通过键入 python runtests.py。或者,您可以通过运行 pip install pytest。脚本本身可以安装在 从根目录运行pip install -e .的开发模式 存储库的。然后可以通过执行py.test来运行测试。

要求

这个提交钩子是用python编写的,它具有以下特性 要求:

  • pep8sudo pip install pep8
  • python=2.7

发行说明

0.1.0(2015-09-11)

  • 初次发布。

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

推荐PyPI第三方库


热门话题
java如何强制用户在允许访问活动之前处理对话框?我的许可证代码怎么了?   java ArraysList作为JSON   mysql如何在java中创建包含多个可选where子句的搜索语句?   java如何让Apache Camel在“直接”路径的末尾删除文件?   使用socket在两个Androids之间进行java实时数据传输。IO(websocket)和4G   如何在java中实现两个CORBA服务器之间的通信   会话树xml表示为java对象   java Skype4Java编号swtwin323325   java RecyclerView getAdapterPosition()不工作:第一次单击返回正确位置,第二次单击返回1   java在$TOMCAT/conf/context上为JNDI设置资源。xml   java为什么第二个矩形冲突在第一个矩形冲突时不起作用?   JScrollPane上的java JTextArea未出现在JPanel上   java如何将实现的PriorityQueue打印为字符串?   jpa使用Jersey更新用户角色RESTJava(JAXRS)