Redian新闻
>
谷歌开源!一个格式化 Python 代码的好帮手

谷歌开源!一个格式化 Python 代码的好帮手

公众号新闻

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

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

1.准备


开始之前,你要确保Python和pip已经成功安装在电脑上。

请选择以下任一种方式输入命令安装依赖
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')
class foo  ( object ):
  def f    (self ):
    return       37*-+2
  def g(self, x,y=42):
      return y
def f  ( a ) :
  return      37+-+a[42-x : y**3]

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

yapf -i 1.py

效果如下:

3.Yapf 作为模块使用


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

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

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

from yapf.yapflib.yapf_api import FormatCode

formatted_code, changed = FormatCode("f ( a = 1, b = 2 )")
print(formatted_code)
# 'f(a=1, b=2)\n'
print(changed)
# True

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

from yapf.yapflib.yapf_api import FormatCode

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

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

from yapf.yapflib.yapf_api import FormatFile 
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 参数,它将把格式化后的代码写回文件中:

from yapf.yapflib.yapf_api import FormatFile 
print(FormatFile("foo.py", in_place=True)[:2])
# (None, 'utf-8')

print(open("foo.py").read())
# a == b


- EOF -



推荐阅读  点击标题可跳转

0、极客专属:几十款程序员秒懂的卫衣

1、大厂都病了!

2、曾经对程序员最好的公司,倒下了

3、时隔 20 年,这个编程语言再次“称王”!


关注「程序员的那些事」加星标,不错过圈内事

点赞和在看就是最大的支持❤️

微信扫码关注该文公众号作者

戳这里提交新闻线索和高质量文章给我们。
相关阅读
import 一个“太极”库,让 Python 代码提速 100 倍!ChatGPT竟写出毁灭人类计划书,还给出相应Python代码,网友:AI正在指数级发展谷歌开源漏洞扫描工具OSV-Scanner硬核有奖问卷|你选择 JavaScript 还是 Python?下一个热门语言由你定义PyTorch 2.0正式版发布!一行代码提速2倍,100%向后兼容[摄影] 猛玛LARK M1 居家vlog必备拾音好帮手!年夜饭的好帮手!原切整木砧板、宰切一体菜刀,省力好用济南防疫办推翻了“活人不能被尿憋死”的古训ChatGPT发明「史莱姆语」,词汇语法规则全都有,还配了「史翻英」Python代码狂揽两千星,速度百倍提升,高性能Python编译器Codon开源7 Papers & Radios | 谷歌开源机器人领域transformer;DeepMind推出剧本写作AI谷歌开源安全的机器学习操作系统 KataOS我生活着ALL IN 液冷,又一数据中心绿色低碳发展的好帮手!对不起的人,对不起的事(二)武陵春:云淡清新绿意稠专业洗衣好帮手,除菌、除螨、去异味一瓶搞定行业入门|量化分析,一个工作语言是Python和Chinese的行业孩子的学习好帮手!从此远离环境干扰,学习更专注,记忆更高效!从小学用到成年向死而生,看看这一家是如何润到美国的接触开源,让我逃离了印度贫民窟,最终成为一名谷歌开发者专家家居生活好帮手!日化用品返场,快来囤货啦背书好帮手!矫正发音、磨耳朵、背书事半功倍,好用到飞!Artipie:可用于 Python 的开源仓库管理器 | Linux 中国字节版ChatGPT年中推出/ iPhone15Pro新增一色/ 谷歌开始共享工位…今日更多新鲜事在此谷歌开源部门裁员“大地震”:多名开源功臣粗暴被裁,61岁程序员被迫再求职爆料一个Python圈子里的小道消息...3月遇到它,我从不还价!养肝明目的好帮手,不愧是“春天第一豆”意想不到"6大清洁神物"!面包、美乃滋居然也是去污好帮手开源代码的著作权归属已死?图片迟迟加载不了、一片马赛克?谷歌开源模型优先显示图像受关注部分IRS代码 826、846、570 是什么?2022 年纳税记录中常用代码的含义摊牌了!这就是找遍了全网的五黑饼,软糯不粘牙,代餐好帮手从公有云方案转向谷歌开源Knative,网易云音乐的Severless演进实践
logo
联系我们隐私协议©2024 redian.news
Redian新闻
Redian.news刊载任何文章,不代表同意其说法或描述,仅为提供更多信息,也不构成任何建议。文章信息的合法性及真实性由其作者负责,与Redian.news及其运营公司无关。欢迎投稿,如发现稿件侵权,或作者不愿在本网发表文章,请版权拥有者通知本网处理。