首页
技术小册
AIGC
面试刷题
技术文章
MAGENTO
云计算
视频课程
源码下载
PDF书籍
「涨薪秘籍」
登录
注册
第 1章 处理错误和寻求帮助
1.1 如何理解Python错误信息
1.1.1 检查回溯信息
1.1.2 搜索错误信息
1.2 借助linter 避免错误
1.3 如何寻求编程帮助
1.3.1 预先提供信息以避免反复补充
1.3.2 以实际问题的形式陈述问题
1.3.3 在合适的网站上提出你的问题
1.3.4 在标题中概述你的问题
1.3.5 说明代码的预期目的
1.3.6 包含完整的错误信息
1.3.7 分享全部代码
1.3.8 通过适当的格式化增强代码可读性
1.3.9 告诉帮忙者已经尝试过的方法
1.3.10 描述你的设置信息
第 2章 环境设置和命令行
2.1 文件系统
2.1.1 Python中的路径
2.1.2 主目录
2.1.3 当前工作目录
2.1.4 绝对路径和相对路径
2.2 程序和进程
2.3 命令行
2.3.1 打开终端窗口
2.3.2 使用命令行运行程序
2.3.3 使用命令行参数
2.3.4 在命令行中使用-c 运行Python代码
2.3.5 从命令行运行Python 程序
2.3.6 运行py.exe 程序
2.3.7 在Python 程序中运行命令
2.3.8 使用Tab 补全命令减少输入量
2.3.9 查看历史命令
2.3.10 使用常用命令
2.4 环境变量和PATH
2.4.1 查看环境变量
2.4.2 使用PATH 环境变量
2.4.3 更改命令行的PATH 环境变量
2.4.4 在Windows 上将文件夹永久添加到PATH
2.4.5 在macOS 和Linux 上将文件夹永久添加到PATH
2.5 不借助命令行运行Python 程序
2.5.1 在Windows 上运行Python程序
2.5.2 在macOS 上运行Python 程序
2.5.3 在Ubuntu Linux 上运行Python程序
第3章 使用Black 进行代码格式化
3.1 让程序员招人烦的错误做法
3.2 风格指南和PEP 8
3.3 水平间距
3.3.1 使用空格进行缩进
3.3.2 行内间距
3.4 垂直间距
3.4.1 垂直间距示例
3.4.2 垂直间距的最佳实践
3.5 Black:毫不妥协的代码格式化工具
3.5.1 安装Black
3.5.2 在命令行中运行Black
3.5.3 对部分代码禁用Black
当前位置:
首页>>
技术小册>>
Python编程轻松进阶(一)
小册名称:Python编程轻松进阶(一)
### 3.5.2 在命令行中运行Black 在Python编程的广阔天地里,代码风格的一致性和可读性对于维护大型项目至关重要。`Black`,作为一款广受欢迎的Python代码格式化工具,以其“不妥协”的格式化风格赢得了开发者的青睐。它自动将你的代码格式化为符合PEP 8(Python的官方编码风格指南)的样式,同时保持一定的个人偏好空间,但尽量减少这些空间以确保团队间代码风格的一致性。本章节将详细介绍如何在命令行中运行`Black`,包括安装、基本使用、高级配置以及集成到常见开发环境中。 #### 3.5.2.1 安装Black 要在命令行中使用`Black`,首先需要将其安装到你的Python环境中。这可以通过pip(Python的包管理工具)轻松完成。打开你的命令行界面(在Windows上可能是CMD、PowerShell或Git Bash,在macOS和Linux上通常是Terminal),然后输入以下命令: ```bash pip install black ``` 这条命令会从Python包索引(PyPI)下载并安装`Black`。安装完成后,你就可以在命令行中通过`black`命令来格式化你的Python代码了。 #### 3.5.2.2 基本使用 `Black`的基本使用非常简单直接。假设你有一个名为`example.py`的Python文件,想要格式化它,只需在命令行中切换到该文件所在的目录,然后运行: ```bash black example.py ``` `Black`会读取`example.py`文件,按照其预设的规则格式化代码,并将更改直接应用到原文件上。这意味着你的原始文件将被覆盖,因此建议在运行`Black`之前备份你的代码,尤其是当你不确定结果会如何时。 如果你想要格式化当前目录下的所有Python文件(不包括子目录中的文件),可以使用通配符`*`: ```bash black *.py ``` 对于包含多个子目录的大型项目,`Black`提供了递归格式化整个项目的选项。使用`-l`或`--line-length`参数可以指定每行代码的最大长度(默认为88个字符),但在此场景下,我们更关心的是如何递归地格式化项目: ```bash black . ``` 这个命令会在当前目录及其所有子目录中查找Python文件,并格式化它们。注意,`.`代表当前目录。 #### 3.5.2.3 高级配置 虽然`Black`的设计哲学是尽量减少配置选项,以保持其“不妥协”的格式化风格,但它仍然提供了一些基本的配置选项来满足特定需求。这些配置通常通过命令行参数或项目级别的配置文件(如`pyproject.toml`)来设置。 - **命令行参数**:除了之前提到的`-l`/`--line-length`用于设置行长度外,`Black`还支持其他参数,如`--check`(仅检查代码是否需要格式化,而不实际修改文件)、`--diff`(显示格式化前后的差异)等。 - **项目配置文件**:对于大型项目,将`Black`的配置保存在项目源代码中更为方便。`Black`支持在`pyproject.toml`文件中配置,这是Python项目的一个标准配置文件。例如: ```toml [tool.black] line-length = 100 include = '\.pyi?$' exclude = ''' /( \.git | \.hg | \.mypy_cache | __pycache__ | venv | _build | buck-out | \.eggs )/ ''' ``` 这个配置指定了行长度为100个字符,并定义了哪些文件应该被包含或排除在格式化之外。 #### 3.5.2.4 集成到开发环境 为了提高开发效率,将`Black`集成到你的开发环境中是一个好主意。大多数现代IDE(如PyCharm、VS Code等)和编辑器(如Sublime Text、Atom等)都支持通过插件或扩展来集成`Black`。 - **VS Code**:安装Python扩展后,可以在设置(settings.json)中配置`python.formatting.provider`为`black`,并启用`python.formatting.enable`来自动格式化保存的文件。 - **PyCharm**:虽然PyCharm内置了代码格式化功能,但你可以通过安装外部工具插件(如File Watchers)或使用外部命令来运行`Black`。 - **Git Hook**:另一个高级用法是将`Black`作为Git提交前的钩子(pre-commit hook),以确保每次提交到版本控制系统的代码都是格式良好的。这可以通过安装`pre-commit`框架并配置`.pre-commit-config.yaml`文件来实现。 #### 3.5.2.5 结论 `Black`作为一款强大的Python代码格式化工具,通过其简洁的命令行接口和灵活的配置选项,极大地简化了代码风格统一的工作。无论是在个人项目中保持代码整洁,还是在团队项目中确保代码风格的一致性,`Black`都是一个不可或缺的工具。通过本章节的介绍,你应该已经掌握了如何在命令行中安装、使用`Black`,以及如何将其集成到你的开发环境中。希望这能帮助你更高效地编写和维护Python代码。
上一篇:
3.5.1 安装Black
下一篇:
3.5.3 对部分代码禁用Black
该分类下的相关小册推荐:
Python合辑6-字典专题
Python合辑14-面向对象编程案例(下)
Python甚础Django与爬虫
Python高并发编程与实战
Python机器学习基础教程(下)
Python数据分析与挖掘实战(下)
Python合辑9-判断和循环
Python合辑12-面向对象
剑指Python(磨刀不误砍柴工)
Python编程轻松进阶(四)
Python3网络爬虫开发实战(上)
Python神经网络入门与实践