VSCode 配置 python 代码格式化工具（yapf，autopep8）-Toy模板网

这篇具有很好参考价值的文章主要介绍了VSCode 配置 python 代码格式化工具（yapf，autopep8）。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

1.安装yapf

pip install yapf

2.VSCode setting.josn配置

"python.formatting.provider": "yapf",    					//使用yapf作为Python代码格式化工具。
"editor.formatOnSave": true,								//开启文件保存时自动格式化
"python.formatting.yapfArgs": [
    "--style=pep8",											//格式化风格，PEP 8是Python社区推荐的Python代码风格指南
    "{column_limit: 100}",									//每行代码的最大长度，多出的就会换行
    "{indent_width: 4}",									//设置缩进使用4个空格	
    "{align_closing_bracket_with_visual_indent:true}",		//是否将闭括号与视觉缩进对齐
    "{allow_split_before_dict_value:true}",					//在字典值前是否允许换行
    "{continuation_indent_width:4}",						//续行时使用的缩进宽度
    "{split_arguments_when_comma_terminated:true}",			//在逗号结尾时是否换行
    "{split_before_expression_after_opening_paren:true}",	//在左括号后是否换行
    
]

需要注意的是，yapf的配置选项都是可选的，你可以根据自己的需要选择使用哪些选项。不过，使用太多选项可能会导致代码格式化的规则变得复杂，对代码的可读性有影响。因此，建议尽量使用最少的选项来保持代码的简洁性。

3.安装autopep8

pip install autopep8

4.VSCode setting.josn配置

"editor.formatOnSave": true,
"python.formatting.provider": "autopep8",
    "python.formatting.autopep8Args": [
        "--aggressive",
        "--max-line-length=120",
        "--ignore=E402",
        "--exclude=venv",
        "--ignore-local-config"
],

aggressive: 这个选项表示在格式化代码时使用更激进的策略。它会应用更多的代码转换规则，以尽可能地改进代码的格式和风格。
max-line-length=120: 这个选项指定每行代码的最大字符数限制。当一行代码超过这个限制时，autopep8将尝试自动调整代码以使其适应这个限制。
ignore=E402: 这个选项告诉autopep8忽略指定的错误代码。在这种情况下，E402表示 “module level import not at top of file”，即模块级别的导入不在文件顶部。这个选项可以用来避免autopep8对这类错误的修复。
exclude=venv: 这个选项指定要排除的目录或文件。在这种情况下，“venv” 是指要排除的目录名。autopep8将不会对这个目录下的文件进行格式化。
ignore-local-config: 这个选项告诉autopep8忽略本地配置文件。autopep8通常会查找并应用项目目录中的配置文件，如 .editorconfig 或 pyproject.toml。使用这个选项可以防止autopep8读取和应用这些本地配置文件