python钩子_如何使用预提交钩子来改善python代码样式

python钩子

Maintaining style and consistency is key to developing quality and legible Python code. But, as anyone with some experience with coding can attest to, manually enforcing a code style is a real pain and eats into valuable development time. In this blog post, I explain how you can configure and use pre-commit hooks to automatically style your Python code. I also highlight some of the advantages of automating code style enforcement.

保持样式和一致性是开发高质量和清晰的Python代码的关键。 但是，正如任何具有一定编码经验的人所能证明的那样，手动执行代码样式确实是一个痛苦，并且会占用宝贵的开发时间。 在此博客文章中，我将说明如何配置和使用预提交挂钩来自动设置Python代码样式。 我还强调了自动化代码样式强制执行的一些优点。

保持良好的Python代码风格：自动化案例 (Maintaining good Python code style: The case for automation)

Consistent and legible code is key to any production-level (Python) codebase. A dev team will typically have an internal style guide that sets the parameters of good code. Such guidelines may include (but are not limited to), the docstrings conventions, the spaces and white lines used between function and class definitions, the maximum line length, and the order of imports.

一致且清晰的代码是任何生产级(Python)代码库的关键。 一个开发团队通常将有一个内部样式指南，该指南设置了良好代码的参数。 此类准则可能包括(但不限于)，文档字符串约定，函数和类定义之间使用的空格和白线，最大行长以及导入顺序。

Enforcing code style is key to streamlining development processes

强制执行代码样式是简化开发流程的关键

Style guides are an important method to streamline development processes: these guidelines make it easier for colleagues to read and review your code, eases on-boarding of new team members, and ensures consistency in the codebase over time and between different developers on your team.

样式指南是简化开发过程的重要方法：这些指南使同事更容易阅读和查看您的代码，简化新团队成员的入职工作，并确保代码库随时间推移以及团队中不同开发人员之间的一致性。

However, manually enforcing code style presents a number of challenges. First, it is time consuming. It takes time to familiarise yourself with code style rules (especially when onboarding new colleagues), and even more time to make them part of your development routine and implement them consistently while coding.

但是，手动执行代码样式带来了许多挑战。 首先，这很耗时。 您需要花费一些时间来熟悉代码风格规则(尤其是在招募新同事时)，甚至需要更多的时间才能使它们成为开发例程的一部分，并在编码时始终如一地实现它们。

Second, code quality suffers when code style is enforced manually. Your colleagues have to pay attention to and manually correct inevitable errors in code style. This comes at the expense of focusing on problems with and improvements of the code itself.

其次，手动执行代码样式会降低代码质量。 您的同事必须注意并手动纠正不可避免的代码样式错误。 这是以牺牲代码本身的问题和改进为代价的。

In my own e