Click 8.5.0: omitted boolean flags incorrectly trigger conflicting_options validation

オープン
#112 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

@nicu1989 がすでに取り組んでいます。

2026年11月13日 から。

  • #113 @nicu1989 による — オープン

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
66/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
python
領域
cli

調査の方向性

The bug is in validate_option_dependencies() and PluggableCommandLineOption in the commoncode cliutils module, which decide whether an option counts as used. Run the reproduction script from the issue with click 8.5.0 and again with 8.4.2 to compare. Find how the check tells a supplied flag from a default, since click 8.5.0 seems to report omitted flags differently. Done when the script prints OK on click 8.5.0 and a regression test covers omitted boolean flags.

索引モデルが issue の本文から書いたものです。

説明

With commoncode 33.0.0 and click 8.5.0, validate_option_dependencies() incorrectly reports a conflict between mutually exclusive boolean flags when neither flag is supplied:

Error: The option --strip-root cannot be used together with the --full-root option(s) and --full-root is used. You can set only one of these options at a time.

This breaks scancode 32.4.1 with conflict between --strip-root and --full-root. The problem reproduces using commoncode alone as well.
Tested with Python 3.12. CommonCode 32.4.2 is also affected. The same checks pass with Click 8.4.2.

How to standalone reproduce the error:

  1. Create test.py:
import click
from commoncode import cliutils

@click.command()
@click.option(
    "--strip-root", is_flag=True,
    cls=cliutils.PluggableCommandLineOption,
    conflicting_options=["full_root"],
)
@click.option(
    "--full-root", is_flag=True,
    cls=cliutils.PluggableCommandLineOption,
    conflicting_options=["strip_root"],
)
@click.pass_context
def cli(ctx, strip_root, full_root):
    cliutils.validate_option_dependencies(ctx)
    click.echo("OK")

if __name__ == "__main__":
    cli()
  1. Use packages: python -m pip install commoncode==33.0.0 click==8.5.0
  2. Run: python test.py -> expected output: OK, actual: Error: The option --strip-root cannot be used together with the --full-root option(s) and --full-root is used. You can set only one of these options at a time.

With click 8.4.2 the out put is OK.

主要言語
Python
スター
4
フォーク
25
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

aboutcode-org/commoncode のほかの issue

aboutcode-org/commoncode の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。