百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术资源 > 正文

Python代码格式化工具Black,自动快速帮你规范...

off999 2025-06-15 18:33 44 浏览 0 评论

Black是一个兼容PEP-8、零妥协的Python代码格式化工具。使用它,你将欣然同意放弃对手动格式化细节的控制。作为回报,Black将回馈你速度、准确性并使你免于pycodestyle(一种Python代码风格检查器,用于检查Python代码是否符合PEP-8规范)的困扰。你将节省时间和精力,专注于更重要的事情。

安装了Black之后,只要检测到不符合规范的代码风格,它便会自动帮你重新格式化。就是这么简单粗暴!

目前,该项目在GitHub上已经积累了27.8k的Star。

项目地址:https://github.com/psf/black

无论你在查看什么项目,Black风格的代码都是统一的。格式会在短时间内变得一目了然,这样你可以专注于内容。Black产生尽可能小的差异,使得代码审查速度更快。

如下为格式化之前的代码。

from seven_dwwarfs import Grumpy, Happy, Sleepy, Bashful, Sneezy, Dopey, Doc
x = {  'a':37,'b':42,

'c':927}

x = 123456789.123456789E123456789

if very_long_variable_name is not None and \
 very_long_variable_name.field > 0 or \
 very_long_variable_name.is_debug:
 z = 'hello '+'world'
else:
 world = 'world'
 a = 'hello {}'.format(world)
 f = rf'hello {world}'
if (this
and that): y = 'hello ''world'#FIXME: https://github.com/psf/black/issues/26
class Foo  (     object  ):
  def f    (self   ):
    return       37*-2
  def g(self, x,y=42):
      return y
def f  (   a: List[ int ]) :
  return      37-a[42-u :  y**3]
def very_important_function(template: str,*variables,file: os.PathLike,debug:bool=False,):
    """Applies `variables` to the `template` and writes to `file`."""
    with open(file, "w") as f:
     ...
# fmt: off
custom_formatting = [
    0,  1,  2,
    3,  4,  5,
    6,  7,  8,
]
# fmt: on
regular_formatting = [
    0,  1,  2,
    3,  4,  5,
    6,  7,  8,
]

如下为使用Black 22.3.0进行格式化后,可以看到代码变得清爽舒适了很多。

from seven_dwwarfs import Grumpy, Happy, Sleepy, Bashful, Sneezy, Dopey, Doc

x = {"a": 37, "b": 42, "c": 927}

x = 123456789.123456789e123456789

if (
    very_long_variable_name is not None
    and very_long_variable_name.field > 0
    or very_long_variable_name.is_debug
):
    z = "hello " + "world"
else:
    world = "world"
    a = "hello {}".format(world)
    f = rf"hello {world}"
if this and that:
    y = "hello " "world"  # FIXME: https://github.com/psf/black/issues/26


class Foo(object):
    def f(self):
        return 37 * -2

    def g(self, x, y=42):
        return y


def f(a: List[int]):
    return 37 - a[42 - u : y**3]


def very_important_function(
    template: str,
    *variables,
    file: os.PathLike,
    debug: bool = False,
):
    """Applies `variables` to the `template` and writes to `file`."""
    with open(file, "w") as f:
        ...


# fmt: off
custom_formatting = [
    0,  1,  2,
    3,  4,  5,
    6,  7,  8,
]
# fmt: on
regular_formatting = [
    0,
    1,
    2,
    3,
    4,
    5,
    6,
    7,
    8,
]

安装

你可以运行pip install black安装。Python版本需要3.6.2及以上。如果你想在Jupyter Notebooks中格式化代码,则可以通过运行pip install 'black[jupyter]'安装。

你也可以从GitHub中直接安装,具体命令如下。

pip install git+https://github.com/psf/black

使用

通过如下合理默认值立即开始。

black {source_file_or_directory}

当你无法作为脚本运行Black时,可以将它作为包运行。

python -m black {source_file_or_directory}

目前,Black已经成功地被很多大小项目使用。Black拥有齐全的测试套件、高效的并行测试以及作者自己的自动格式化和并行持续集成运行器。随着Black变得越来越稳定,未来不会再有大的格式变化了。风格上的变化很大程度上是对bug报告的小修小补以及支持新的Python语法。

此外,作为一个放缓处理速度的安全措施,Black将检查重新格式化后的代码是否依然生成与原始代码等效的有效AST。如果你有信心,尽情使用--fast

更多细节内容请参阅原项目。

相关推荐

姑娘视频在线观看中国电影(姑娘视频官网下载)

小马宝莉观看顺序如下:1、《小马宝莉第一季》2、《小马宝莉第二季》3、《小马宝莉第三季》4、《小马国女孩1》5、《小马宝莉第四季》6、《小马国女孩2》7、《小马宝莉第五季》8、《小马国女孩3》9、《小...

程序员一般要学多久(程序员的前景和未来)

1 培养兴趣兴趣是能够让人坚持下去的动力。多关心一些行业趣事,多想想盖茨。不是提倡天天做白日梦,但人要是没有了梦想,觉得有味道吗?可能像许多深圳本地农民一样,打打麻将,喝喝功夫茶,拜拜财神爷;每个月就...

cad制图软件电脑版(cad制图软件pc版)
cad制图软件电脑版(cad制图软件pc版)

1.浏览器打开CAD官网,选择菜单栏上的产品点击下方的autoCAD.2.点击下载免费试用版3.商业里点AutoCAD,点下一步。4.点击安装下面的下载即可。1、在搜索引擎中输入cad安装包并点击搜索,选择一款安装包进行下载。2、将下载的c...

2026-01-31 14:43 off999

一起学网校(一起学网校赵越老师个人资料)

一起学和一起学网校是同一个品牌的不同产品。一起学是一个在线教育平台,提供各种学习资源和课程,包括一对一辅导、视频课程等。而一起学网校是一起学平台下的一个子品牌,专注于提供在线学习班和课程,通过直播和互...

电视直播大全在线观看(电视直播大全_网络电视在线观看)

要观看CCTV直播,您可以按照以下几种方法进行操作:1.通过有线电视:如果您有有线电视服务,您可以直接打开电视机,转到CCTV频道,然后选择您想要观看的直播节目。2.通过卫星电视:如果您拥有卫星电...

免费的格式转换器软件(免费格式转换app推荐)

软件一:迅捷音频转换器一款专业的音频编辑工具,拥有音频剪切、音频提取、音频转换等多种功能,能够用多种分割方式进行音频剪切,而且支持批量操作,功能强大,操作简单,绝对是一款不容错过的软件。软件特色1、多...

pubg加速器(Pubg加速器)

现在加速吃鸡的游戏加速器是有专线路线的比较好,专线的稳定很多,不过目前是没有完全免费的加速软件,很多都可以先体验,注册就可以体验的,可以多去体验几款,对比一下。目前的加速器可以分为三个等级第一等级:全...

无限金币无限钻石版游戏大全下载

不能下载,奥特曼无限钻石无限金币是不能进行下载的。我们在进行奥特曼游戏的时候,无限钻石金币这种情况下是使用外挂进行达成的正版游戏,并没有公布这个功能,所以是无法进行下载的,我们还是要支持正版游戏。要下...

手游排行(手游排行榜第一名)
手游排行(手游排行榜第一名)

手机游戏排行榜前十的有:《王者荣耀》、《绝地求生:全军出击》、《荒野行动》、《剑侠》、《4D极速沙滩赛车》、《红色坦克4D》、《镇魔》、《坦克前线帝国》、《舰指太平洋》、《红警天启的狂怒》。1、《王者荣耀》《王者荣耀》已经出了几十位英雄,定...

2026-01-31 13:03 off999

windows11系统下载(windows11下载安装教程)

首先,确保你的电脑符合Windows11的系统要求。然后,前往微软官网下载Windows11安装助手,运行该助手并按照提示进行操作。如果你的设备已经运行Windows10,你可能可以通过Windows...

线上教育平台(安徽省免费线上教育平台)

疫情以来,最火的一个词大概就是线上教学了,那么它到底有什么优势呢1.开展方式便利化,受到的环境局限小。网课,也就是通过网络开展,无论你身处何地,即使是足不出户也能进行自我学习,不需要像实体课堂一样来回...

autocad免费版安装教程(autocad免费下载安装教程)

cad是一种专业的设计软件,可以用于制作二维和三维设计。首先,您需要找到合适的cad软件,例如AutoCAD或SolidWorks。然后,从官方网站或可信赖的渠道下载软件安装包。接着,运行安装包并按照...

图片识别在线(图片猜车识别在线)

步骤一:首先我们通过电脑然后打开迅捷PDF转换器。步骤二:在这个在线工具的导航栏“图片文字识别”下拉框中选择“图片文字识别”操作功能,工具将会跳转到待识别操作页面。步骤三:从这个页面中,我们可以在自定...

pp助手ios版免越狱(pp助手ios免费版)
  • pp助手ios版免越狱(pp助手ios免费版)
  • pp助手ios版免越狱(pp助手ios免费版)
  • pp助手ios版免越狱(pp助手ios免费版)
  • pp助手ios版免越狱(pp助手ios免费版)
vps远程桌面服务器(vps远程桌面软件)
  • vps远程桌面服务器(vps远程桌面软件)
  • vps远程桌面服务器(vps远程桌面软件)
  • vps远程桌面服务器(vps远程桌面软件)
  • vps远程桌面服务器(vps远程桌面软件)

取消回复欢迎 发表评论: