五彩斑斓的 Black —— Python 代码格式化工具

# 格式化前
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-v22.10.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

pip install black[jupyter]

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

black {source_file_or_directory}

python -m black {source_file_or_directory}

black -S {source_file_or_directory}

$ which black
/usr/local/bin/black  # 可能的位置

$ where black
%LocalAppData%\Programs\Python\Python38\Scripts\black.exe  # 可能的位置

ext install ms-python.python

"python.formatting.blackArgs": [
        "--skip-string-normalization"
    ]

$ black --help
使用： black [OPTIONS] SRC ...

  零妥协的代码格式化工具。

选项：
  -c, --code TEXT                 将传入的代码作为字符串格式化。
  
  -l, --line-length INTEGER       每行允许的字符数。
                                  [默认值： 88]

  -t, --target-version            [py33|py34|py35|py36|py37|py38|py39|py310|py311]
                                  Black 的输出应该支持的 Python 版本
                                  [默认值：每个文件自动检测]

  --pyi                           不考虑文件扩展名，将所有输入文件格式化为 typing stubs
                                  （当使用来自标准输入的管道时很有用）。

  --ipynb                         不考虑文件扩展名，将所有输入文件格式化为 Jupyter
                                  Notebooks 风格（当使用来自标准输入的管道时很有用）。
  
  --python-cell-magics TEXT       When processing Jupyter Notebooks, add the
                                  given magic to the list of known python-
                                  magics (time, capture, pypy, python, prun,
                                  timeit, python3). Useful for formatting
                                  cells with custom python magics.
  
  -x, --skip-source-first-line    跳过源代码的第一行。
  
  -S, --skip-string-normalization 不要标准化字符串引号或前缀。
  
  -C, --skip-magic-trailing-comma 不要将尾随逗号作为分割行的理由。
  
  --preview                       启用可能在下一个主要版本中添加到Black的主要功能的
                                  潜在破坏性风格变化。
  
  --check                         不要写回文件，只返回状态。
                                  返回代码 0 意味着没有任何改变。
                                  返回代码 1 意味着有些文件将被重新格式化。
                                  返回代码 123 意味着存在 internal error 内部错误。
  
  --diff                          不要写回文件， 只是使用 stdout 标准输出显示
                                  每个文件的 diff 差异。
  
  --color / --no-color            显示彩色的 diff。 只有当使用了`--diff` 选项才生效。
  
  --fast / --safe                 如果给定了 --fast，则跳过 temporary sanity
                                  检查。 [默认值： --safe]
  
  --required-version TEXT         需要运行特定版本的 Black （用于在不同环境上得到同样的
                                  结果，比如使用一个 pyproject.toml 文件）。
  
  --include TEXT                  匹配递归搜索中应包含的文件和目录的正则表达式。
                                  空值意味着包含所有文件（无论文件名是什么）。
                                  对所有平台上的目录使用正斜杠（在 Windows 上亦是如此）。 
                                  首先匹配要排除的项，然后匹配包含项。
                                  [默认值： (\.pyi?|\.ipynb)$]
  
  --exclude TEXT                  匹配递归搜索中应排除的文件和目录的正则表达式。
                                  空值意味着不排除任何路径。 
                                  对所有平台上的目录使用正斜杠（在 Windows 亦是如此）。
                                  首先匹配要排除的项，然后匹配包含项。
                                  [默认值： /(\.direnv|\.eggs|\.git|\.h
                                  g|\.mypy_cache|\.nox|\.tox|\.venv|venv|\.svn
                                  |_build|buck-out|build|dist)/]
  
  --extend-exclude TEXT           类似 --exclude，但在排除的文件和目录之上
                                  添加了额外的文件和目录。（如果您只是想简单地添加到
                                  默认值，这会很有用）
  
  --force-exclude TEXT            类似 --exclude，但是与此正则表达式匹配的文件和目录
                                  将被排除，即使它们作为参数显式传递。
  
  --stdin-filename TEXT           通过 stdin 标准输入传递时的文件名。
                                  有助于确保 Black 在某些依赖使用 stdin 的编辑器上
                                  尊重 --force-exclude 选项。
  
  -W, --workers INTEGER RANGE     并行工作数量 [默认值：系统中的 CPU 数量] [x>=1]。
  
  -q, --quiet                     不向 stderr 输出非报错信息。
                                  错误信息仍然会被输出； 
                                  使用 2>/dev/null 关闭这些信息。
  
  -v, --verbose                   还向 stderr 输出文件未更改或因为排除模式被忽略的信息。
  
  --version                       显示版本并退出。
  
  --config FILE                   从 FILE 路径读取配置。
  
  -h, --help                      显示本帮助信息并退出。

$ echo "print ( 'hello, world' )" | black -
print("hello, world")
reformatted -
All done! ✨ 

标签：格式化,Python,代码,--,Black,使用,black,五彩斑斓	

From： https://www.cnblogs.com/sinferwu/p/17082481.html
      
      




      
      

        
相关文章
        

          

 
Python 中global 关键字理解
Python中的global关键字，你了解吗？前言今天来了解下Python中的global关键字。Python变量的作用域实战案例演示之前，先要了解下Python的作用域.Python变量的作......
 
python 中给文件加锁——fcntl模块
如果没有fcntl模块则用sudopipinstallfcntl安装模块简单说明：打开文件，不存在则创建之f=open('./test','w')fcntl.flock(f,fcntl.LOCK_EX)这样就对文件t......
 
python实现区块链代码
如果你明白了原理其实挺简单的。加密算法是python自带的需要导入hashlibimporthashlibashashsha=hasher.sha256()sha.update('yourcontent')printsha.hexdigest()输......
 
Python-接口
fromabcimportABCMeta,abstractmethod#接口：若干抽象方法的集合classPaymet(metaclass=ABCMeta):#abstractmethodclass#抽象方法@abstractmeth......
 
Python中报“TypeError: 'int' object is not callable”错误的解决办法
当时就想用sum()函数求和发现之前 “sum” 这个关键字被当变量名定义过了，然后我试着把自己自定义的变量都给删除了，删除之后再次试了一下，发现可以了，果然是sum()函数被之......
 
三行Python代码,让你的数据处理脚本快别人4倍
Python是一门非常适合处理数据和自动化完成重复性工作的编程语言，我们在用数据训练机器学习模型之前，通常都需要对数据进行预处理，而Python就非常适合完成这项工作，比如需要重新......
 
Python迭代器,生成器,装饰器
迭代器通常来讲从一个对象中依次取出数据，这个过程叫做遍历，这个手段称为迭代(重复执行某一段代码块，并将每一次迭代得到的结果作为下一次迭代的初始值)。可迭代对象(iterable......
 
python生成随机数、随机字符串
importrandomimportstring#随机整数：printrandom.randint(1,50)#随机选取0到100间的偶数：printrandom.randrange(0,101,2)#随机浮点数：printrandom.random()printra......
 
并发编程-Python
目录01、理论多道技术null02、进程进程运行的三状态图同步和异步阻塞和非阻塞开启进程的两种方式进程对象的join方法进程之间数据相互隔离（默认情况下）进程对象及其他方法僵......
 
python 大图找小图
frompathlibimportPathimportnumpyimportcv2classImage:def__init__(self,image):self.image=cv2.imread(image,cv2.IMREAD_UNCHANGED)@propert......
 
           
          
        
      
    
    

      
赞助商
      




      
      
阅读排行
      

        

				 
Python3网络爬虫浓缩系列
		 
visual studio 2022离线安装包制作教程
		 
#yyds干货盘点# 前端歌谣的刷题之路-第一百三十七题-可伸缩属性
		 
Codeforces
		 
使用U盘制作启动盘并重装系统
		 
编写HelloWorld程序
		 
departments/components/add.vue
		 
1081. 度的数量
		 
js- day03- 将数据变成柱形图
		 
nginx使用
		 
leetcode 22 括号生成
		 
webrtc-streamer实现简单rtsp视频监控
		 
wordpress外贸独立站商城 如此简单
		 
函数练习错题
		 
利用TableAdapter更新数据库
         
        
      
    
  


  
 
    
网站主页关于我们联系我们网站地图 
    
本网站内容转载自其他媒体，侵权联系[admin##ips99.com]。 
    
Copyright © 2020-2023  IPS99  版权所有 IPS99