google / google/python-fire

Provide strict mode

Aberta
#226 2 comentários 13 reações 0 responsáveis Ver no GitHub
enhancement
Linguagem predominante
Python
Estrelas
28.2k
Forks
1.5k
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

You already mentioned to plan to add a strict mode to python-fire in https://github.com/google/python-fire/issues/221 and https://github.com/google/python-fire/issues/222. I would highly appreciate this, so I am opening a new issue for this.

The problem with CLI facing function is that MyPy cannot help here. The type of the input arguments depends on how python-fire (or other CLI parsers) parse the arguments. Thus type hinting cannot spot errors. I for myself had strings were I expected a number (e.g. by passing in "02" instead of "2") or lists where I expected strings (erroneous trailing comma "foobar,"). There is no way to catch this except for explicitly checking for it.

I am currently experimenting with [[https://pypi.org/project/dpcontracts/|dpcontracts]] and https://github.com/RussBaz/enforce to prevent CLI induced errors. However, strict mode would make things much easier here.

One requirement for me would be that I can enable strict mode from within the script. Having to pass `--strict`` all the time would not prevent errors due to wrong usage.

I would be very glad to see this comming.

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Comece lendo as issues relacionadas 221 e 222 e, em seguida, inspecione como Python Fire analisa argumentos CLI e expõe a configuração a partir de um script. Defina como o modo estrito deve validar os tipos dos argumentos, como ele é habilitado programaticamente e quais entradas incorretas devem ser rejeitadas.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
cli
Tipo de issue
Funcionalidade
Dificuldade
5/5
Tempo estimado
Mais de uma semana
Status de atividade
Estagnada
Clareza
Precisa de esclarecimento
Facilidade para iniciantes
25/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.