谷歌开源!一个格式化 Python 代码的好帮手
发布时间: 2023-07-11

大部分人使用Python中的代码格式化工具时都会选择autopep8之类的工具,这些工具可能有一定的局限性,比如不会重新格式化已经符合 PEP8 的代码。

而本文即将介绍的 Yapf,不仅能将代码格式化为符合 PEP8 代码指南的格式,还能格式化为符合 Google 代码指南的格式,可选项更多,让你的代码更加漂亮。

1.准备

请选择以下任一种方式输入命令安装依赖:

1. Windows 环境 打开 Cmd (开始-运行-CMD)。

2. MacOS 环境 打开 Terminal (command+空格输入Terminal)。

3. 如果你用的是 VSCode编辑器 或 Pycharm,可以直接使用界面下方的Terminal.

pip install yapf

YAPF 支持 Python 2.7 和 3.6.4+。

2.Yapf 使用方法

你可以在命令行中直接使用 Yapf, 参数如下:

yapf [-h][-v][-d | -i | -q][-r | -l START-END][-e PATTERN]

[--style STYLE][--style-help][--no-local-style][-p]

[-vv]

[files ...]

展开全文

必选参数:

files 需要被格式化的文件

可选参数:

-h, --help 显示帮助信息

-v, --version 显示程序的版本号

-d, --diff 打印格式化前后差异

-i, --in-place 格式化文件并替换

-q, --quiet 什么都不输出

-r, --recursive 在目录上递归运行

-l START-END, --lines START-END 重新格式化的行范围,基于一个

-e PATTERN, --exclude PATTERN 需要排除的文件

--style STYLE 指定格式化样式(例如“pep8”或“google”)

-p, --parallel 并行格式化(多个文件时有效)

-vv, --verbose 在处理时打印出文件名

举个例子,如果我们有以下的混乱格式代码 1.py :

x = { 'a': 37, 'b': 42,

'c': 927}

y = 'hello ''world'

z = 'hello '+ 'world'

a = 'hello {}'.format( 'world')

classfoo( object ):

deff(self ):

return37*-+ 2

defg(self, x,y= 42) :

returny

deff( a ):

return37+-+a[ 42-x : y** 3]

为了格式化它,我们可以在命令行中执行以下命令:

yapf -i 1.py

效果如下:

3.Yapf 作为模块使用

Yapf 不仅可以在命令行中使用,我们还可以在项目运行时使用。

一个比较常见的场景是用户在你的web网站上提交了python代码,你希望能一件格式化这些代码,那将yapf作为格式化的模块则再好不过。

Yapf 最主要的两个 API 是 FormatCode 和 FormatFile:

fromyapf.yapflib.yapf_api importFormatCode

formatted_code, changed = FormatCode( "f ( a = 1, b = 2 )")

print(formatted_code)

# 'f(a=1, b=2)\n'

print(changed)

# True

你还可以传递 style_config 决定使用哪种指南做格式化:

fromyapf.yapflib.yapf_api importFormatCode

print(FormatCode( "def g:\n return True", style_config= 'pep8')[ 0])

# 'def g:\n return True\n'

FormatFile,这个函数可以从文件中读取代码并格式化:

fromyapf.yapflib.yapf_api importFormatFile

print(open( "foo.py").read)

# a==b

reformatted_code, encoding, changed = FormatFile( "foo.py")

print(formatted_code)

# 'a == b\n'

print(encoding)

# 'utf-8'

print(changed)

# True

如果你添加in_place参数,它将把格式化后的代码写回文件中:

fromyapf.yapflib.yapf_api importFormatFile

print(FormatFile( "foo.py", in_place= True)[: 2])

# (None, 'utf-8')

print(open( "foo.py").read)

# a == b

我们的文章到此就结束啦,如果你喜欢今天的Python 实战教程,请持续关注我们!

有任何问题,可以在公众号后台回复:小助手,进入互助群询问。

原创不易,希望你能在下面点个赞和在看支持我继续创作,谢谢!

入门: 最全的零基础学Python的问题 | 零基础学了8个月的Python |实战项目 | 学Python就是这条捷径

干货:爬取豆瓣短评,电影《后来的我们》 | 38年NBA最佳球员分析 |从万众期待到口碑扑街!唐探3令人失望 | 笑看新倚天屠龙记 | 灯谜答题王 | 用Python做个海量小姐姐素描图 | 碟中谍这么火,我用机器学习做个迷你推荐系统电影

趣味:弹球游戏 | 九宫格 | 漂亮的花 | 两百行Python《天天酷跑》游戏!

AI:会做诗的机器人 | 给图片上色 | 预测收入 | 碟中谍这么火,我用机器学习做个迷你推荐系统电影

小工具: Pdf转Word,轻松搞定表格和水印! | 一键把html网页保存为pdf! |再见PDF提取收费! | 用90行代码打造最强PDF转换器,word、PPT、excel、markdown、html一键转换 | 制作一款钉钉低价机票提示器! |60行代码做了一个语音壁纸切换器天天看小姐姐! |



扫码加微信详细咨询太和智慧养老产品和平台服务!

微信