Click 8.5.0: omitted boolean flags incorrectly trigger conflicting_options validation

Ouverte
#112 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

@nicu1989 y travaille déjà.

Depuis le 13/11/2026.

  • #113 par @nicu1989 — ouverte

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
66/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
Active
Stack technique
python
Domaine
cli

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
Python
Étoiles
4
Forks
25
Métriques de merge des PR
Aucune PR mergée en 30 j

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de aboutcode-org/commoncode

Toutes les issues de aboutcode-org/commoncode

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.