python / python/cpython

Defaults conditionally omitted from help message when using ArgumentDefaultsHelpFormatter

Abierto
#95,889 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

stdlib type-feature
Lenguaje dominante
Python
Estrellas
77.2k
Forks
36k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

Bug report

Using ArgumentDefaultsHelpFormatter as formatter_class of ArgumentParser doesn't always shows default even if the default for argument is set. It's expected to show default if provided.

Example:

    parser = ArgumentParser(formatter_class=ArgumentDefaultsHelpFormatter)
    parser.add_argument('foo', default=1)
    parser.add_argument('bar', nargs='*', default=1)
    parser.add_argument('baz', nargs='*', default=1, help='baz help')
    parser.add_argument('-a', default=1)
    parser.add_argument('-b', default=1, help='b_help')
    parser.print_help()

provides

positional arguments:
  foo
  bar
  baz         baz help (default: 1)

options:
  -h, --help  show this help message and exit
  -a A
  -b B        b_help (default: 1)

Though I see no reason to not show default for -a, foo and bar.
Making help argument mandatory to show default is necessary imho, but what is really strange is that it's enough for an option, but requires nargs for a positional argument.

Your environment

  • CPython versions tested on: 3.10.5
  • Operating system and architecture: Arch Linux x86_64 5.15.55-1-lts
Linked PRs
  • gh-112682

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Empieza reproduciendo el ejemplo de ArgumentParser proporcionado con ArgumentDefaultsHelpFormatter e inspecciona el comportamiento del formateador para los argumentos posicionales y opcionales. Comprueba el PR vinculado gh-112682 para ver el trabajo existente; terminado significa que la salida de ayuda muestra de forma coherente los valores predeterminados proporcionados en los casos indicados.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
cli
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.