跳转到主要内容

用于Python在pre-commit中更新additional_dependencies的工具

项目描述

upadup!

upadup -- 用于在Pre-Commit中更新Python additional_dependencies的工具

为什么?

pre-commit 非常棒,pre-commit autoupdate 也同样棒。但是,不棒的是 pre-commit autoupdate 无法更新你的 additional_dependencies 列表。

upadup 是一个补充工具,它知道如何处理特定的常见情况。

用法

upadup 只会更新被固定到特定版本的 additional_dependencies 项,并且只为已知的python hooks及其依赖项。

只需 cd myrepo; upadup

upadup 还可以配置它所不知道的hooks的信息。更多内容请见下文。

配置加载和格式

如果你有想要 upadup 检查的非默认hooks,请将一个 .upadup.yaml 文件放入你的repo中,以配置要更新的hooks。

upadup 不需要任何参数,如果当前目录中存在 .upadup.yaml,则自动读取它。否则,它使用默认配置。

upadup 需要知道它要检查哪些hook repos,以及在这些repo中它要更新哪些依赖项。配置格式有意与你的pre-commit配置相呼应。指定一个repos列表,并在每个repo中指定要更新的hooks列表。hooks是 id(hook ID)和 additional_dependencies 的组合。

例如

# .upadup.yaml
repos:
  - repo: https://github.com/pycqa/flake8
    hooks:
      - id: flake8
        additional_dependencies:
          - flake8_bugbear

此配置将与以下pre-commit配置相匹配

# .pre-commit-config.yaml
repos:
  - repo: https://github.com/PyCQA/flake8
    rev: 5.0.4
    hooks:
      - id: flake8
        additional_dependencies:
          - 'flake8-bugbear==22.7.1'

请注意,对于仓库名和 additional_dependencies 的匹配不区分大小写,并且我们将 -_ 规范化为匹配,就像 pypi.org 所做的那样。但配置的整体结构旨在是一个镜像。

默认配置

以下配置是 upadup 的默认配置。请注意,缺失的依赖项将被忽略。

repos:
  - repo: https://github.com/pycqa/flake8
    hooks:
      - id: flake8
        additional_dependencies:
          - flake8-bandit
          - flake8-bugbear
          - flake8-builtins
          - flake8-comprehensions
          - flake8-docstrings
          - flake8-implicit-str-concat
          - flake8-logging-format
          - flake8-pyi
          - flake8-typing-as-t
          - flake8-typing-imports
  - repo: https://github.com/asottile/blacken-docs
    hooks:
      - id: blacken-docs
        additional_dependencies:
          - black

extends_default

除非另有说明,默认配置将合并到您的 .upadup.yaml 配置中,实际上是一个并集。

您可以通过将 extends_default: false 设置为来禁用此行为,如下所示

extends_default: false
repos:
  - repo: https://github.com/pycqa/flake8
    hooks:
      - id: flake8
        additional_dependencies:
          - flake8-bugbear

"upadup" 的含义

更新 Python 添加的依赖项,嗯... pre-commit!

不可接受的恶作剧,冒犯了耐心的城市象群

难以置信地有趣、出色、确定的更新程序

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源分发

upadup-0.0.8.tar.gz (309.9 kB 查看哈希值)

上传时间

构建分发

upadup-0.0.8-py3-none-any.whl (7.9 kB 查看哈希值)

上传时间 Python 3

支持者