使用aotupep8自动批量调整代码以符合PEP-8规范

蔚落 2022-09-03 08:27 197阅读 0赞

PEP-8是Python的官方编码规范，像Huawei和Google这样的公司也会基于此出台用于公司内部的编码规范。PEP-8的文档地址在 **[这里][Link 1]** 。  
可以使用Python的外部工具，对代码进行自动检查和==（单文件内）批量==调整，使其满足PEP-8的（大部分）要求。步骤如下：

###### 1. 安装autopep8 ######

pip install autopep8

![请添加图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZtMDUxNw_size_16_color_FFFFFF_t_70]

###### 2. 配置autopep8 ######

在“File - Settings - Tools - External Tools”中添加外部工具，具体参数如下：

Name: 				autopep8（可以自己起名字） 
    Program: 			autopep8
    Arguments: 			--in-place --aggressive $FilePath$
    Working directory: 	$ProjectFileDir$
    Output filters: 	$FILE_PATH$\:$LINE$\:$COLUMN$\:.*

![请添加图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZtMDUxNw_size_16_color_FFFFFF_t_70 1]

###### 3. 例子代码 ######

写了一段简单的代码，里面有4种不符合PEP-8规范的编码习惯  
3.1. 用于分隔多个参数的逗号之后，缺少空格  
![请添加图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZtMDUxNw_size_16_color_FFFFFF_t_70 2]  
3.2. 方法之间空行数量不足  
![请添加图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZtMDUxNw_size_16_color_FFFFFF_t_70 3]  
3.3. 单行文本超长  
![请添加图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZtMDUxNw_size_16_color_FFFFFF_t_70 4]  
3.4. 将多行代码写在一行  
![请添加图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZtMDUxNw_size_16_color_FFFFFF_t_70 5]

###### 4. 自动调整 ######

右键单击需要调整的文件，选择“External Tools - autopep8（步骤2中起的名字）”  
即可实现自动（（单文件内）批量）检查代码规范，并且自动调整代码格式。  
注意：autopep8能对大部分问题进行自动调整，但不是全部。例如3.3的超长文本就不行。  
![请添加图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZtMDUxNw_size_16_color_FFFFFF_t_70 6]

##### 5. 手动调整 #####

对于不成功的部分，可以手动调用修改建议进行调整。  
![请添加图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZtMDUxNw_size_16_color_FFFFFF_t_70 7]

##### 6. 多文件批量修改 #####

autopep8的命令行执行方式是：

autopep8 --in-place --aggressive filename.py

所以可以编写批处理脚本 autopep8\_srcipt\_generator.cmd ：

@echo= >./autopep8_batch_exec.bat
    for /r activity_handlers %%i in (*.py) do @echo autopep8 --in-place --aggressive %%i >>./autopep8_batch_exec.bat
    for /r application %%i in (*.py) do @echo autopep8 --in-place --aggressive %%i >>./autopep8_batch_exec.bat
    for /r performance_analyzer %%i in (*.py) do @echo autopep8 --in-place --aggressive %%i >>./autopep8_batch_exec.bat
    for /r rcqueues %%i in (*.py) do @echo autopep8 --in-place --aggressive %%i >>./autopep8_batch_exec.bat
    for /r standard %%i in (*.py) do @echo autopep8 --in-place --aggressive %%i >>./autopep8_batch_exec.bat
    for /r util %%i in (*.py) do @echo autopep8 --in-place --aggressive %%i >>./autopep8_batch_exec.bat
    for /r xml_parser %%i in (*.py) do @echo autopep8 --in-place --aggressive %%i >>./autopep8_batch_exec.bat
    @echo autopep8 --in-place --aggressive main.py >>./autopep8_batch_exec.bat
    @echo del autopep8_batch_exec.bat >>./autopep8_batch_exec.bat

运行后可以在当前目录下自动查找python文件，生成 autopep8\_batch\_exec.bat  
然后运行 autopep8\_batch\_exec.bat，可以批量修改所有文件中的编码规范。

[Link 1]: https://www.python.org/dev/peps/pep-0008/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZtMDUxNw_size_16_color_FFFFFF_t_70]: /images/20220829/d8d4a8cb66634410b7a00df51d1d20ff.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZtMDUxNw_size_16_color_FFFFFF_t_70 1]: /images/20220829/417fad1a29684a81b3289fa45d684238.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZtMDUxNw_size_16_color_FFFFFF_t_70 2]: /images/20220829/2d8ec8e62ae448eaa11ec140cffdf4d7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZtMDUxNw_size_16_color_FFFFFF_t_70 3]: /images/20220829/dead2d62d9c043509042424865c518fb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZtMDUxNw_size_16_color_FFFFFF_t_70 4]: /images/20220829/ce6bd8148a7045aca2abdc9e03b90b45.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZtMDUxNw_size_16_color_FFFFFF_t_70 5]: /images/20220829/748591f19d1247a8a94ae48cb98d4b03.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZtMDUxNw_size_16_color_FFFFFF_t_70 6]: /images/20220829/253b4565ce294f41b3c497756a4a3704.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZtMDUxNw_size_16_color_FFFFFF_t_70 7]: /images/20220829/c8dd095e760e4904a8d3542f9f6eac55.png