Jupyter Black 使用指南

Jupyter Black 使用指南

jupyter-blackBlack formatter for Jupyter Notebook项目地址:https://gitcode.com/gh_mirrors/ju/jupyter-black

一、项目目录结构及介绍

Jupyter Black 是一个旨在提升 Jupyter Notebook 代码风格的一键式格式化工具，基于广受欢迎的 Python 代码格式化库 black。以下是其基本的目录结构示例及其简介：

jupyter-black/
|-- README.md            # 项目说明文件，包含了快速入门指导和重要信息。
|-- setup.cfg             # 配置文件，用于指定Python版本要求和其他项目设置。
|-- jupyter_black.py     # 主要逻辑实现文件，提供了与 Jupyter 的集成功能。
|-- tests                 # 测试目录，存放项目的单元测试文件。
|-- requirements.txt      # 可能存在的依赖列表（本示例中未直接给出，但常见于开源项目）。
|-- LICENSE               # 许可证文件，指定了该项目遵循的 MIT 开源协议。

二、项目的启动文件介绍

在 Jupyter Black 中，没有传统意义上的“启动文件”，其核心功能通过安装后在 Jupyter 环境内调用的方式激活。安装完成后，通过 Python 命令行执行特定命令来加载扩展，而不是直接运行某个文件。不过，关键的启动逻辑主要包含在 jupyter_black.py 文件里，它负责载入扩展并应用到 Jupyter 笔记本上。

快速启动步骤

1. 创建并激活虚拟环境:

   python3 -m venv venv 
   source venv/bin/activate
   

2. 升级pip并安装所需依赖:

   python3 -m pip install --upgrade pip
   python3 -m pip install jupyter-black
   

3. 启动 Jupyter Notebook:

   python3 -m jupyter notebook
   

之后，在 Jupyter 内部通过导入和调用 jupyter_black.load() 方法来启用格式化功能。

三、项目的配置文件介绍

虽然项目本身直接使用的配置不多，大部分配置是通过调用 jupyter_black.load() 函数时传递参数进行的，比如行长度、日志级别等。这些配置选项可以直接在脚本中指定，或者通过更高级的 Jupyter 扩展管理方式进行设置。

标准配置方法

import jupyter_black
jupyter_black.load(
    lab=False,  # 是否适用于 Jupyter Lab，默认为False，即针对经典Notebook
    line_length=79,  # 设置最大行长度，默认继承black的设定
    verbosity="DEBUG",  # 设置输出详细程度
    target_version=black.TargetVersion.PY36,  # 指定目标Python版本（此行为示例，实际使用时根据需求）
)

请注意，真正的配置灵活性可能依赖于 black 库的配置以及该扩展如何允许用户自定义这些设置。对于更复杂的配置需求，可以探索 Jupyter 的配置系统或查看 jupyter_black 的最新文档是否有额外的配置方式提供。

jupyter-blackBlack formatter for Jupyter Notebook项目地址:https://gitcode.com/gh_mirrors/ju/jupyter-black