Python: conda environment.yml is a dependency declaration; a docs-site static-analysis FAIL should not outweigh the product's PASS

Aberta
  • Algo errado?
#281 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
55/100
Tipo de issue
Bug
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
anaconda, python
Domínio
documentation, tooling

Direção de pesquisa

The bug is in the dependency-management check and the documentation static-analysis check of project_validator, which the payload does not name by file. Start by grepping the Python sources for requirements.txt to find the dependency message, then reproduce with a repo that contains only environment.yml. Done when the message names the conda file and the docs sub-result WARNs instead of FAILing when the product check passes.

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

Descrição

handson-ml3 and PythonDataScienceHandbook declare their environment in environment.yml (conda) but the message pretends only requirements.txt exists ("declared in requirements.txt but not locked"). Every Sphinx/MkDocs Python project FAILs static-analysis "Documentation site: no static analyzer runs; Python: ruff check runs" — with the product passing, the docs sub-result should at most WARN, and the hint should name an rst/markdown linter.

Evidence from the corpus audit

ageron/handson-ml3, jakevdp/PythonDataScienceHandbook / dependency-management
  • kind: UNSUPPORTED
  • actual: handson-ml3 WARN: dependencies are declared in requirements.txt (Python packages) but not locked; PDSH WARN: ... declared in requirements.txt (Python packages) but not locked
  • expected: the conda environment should be named as a declaration (and judged: environment.yml pins are not a lock file either, but the message should not pretend only requirements.txt exists)
  • evidence: handson-ml3 environment.yml:1-4: name: homl3 / channels: / - conda-forge / dependencies:; environment.yml:26: - python=3.10 # your beloved programming language! :); PDSH environment.yml (117 bytes); grep -rn -i "conda\|environment.yml" project_validator --include=*.py → nothing
  • repro: a repo with environment.yml only
  • confidence: high (conda is the dominant dependency tool of the Jupyter/data-science ecosystem)

Found by the regression-corpus audit (235 real repositories, one or more per ecosystem profile; corpus and expected results in corpus/). Evidence is quoted from the audited checkouts at the commits pinned in corpus/projects.toml; <checkouts>/<owner>__<repo> is such a checkout.

🤖 Generated with Claude Code

https://claude.ai/code/session_01ByTXNqDWdM7HzezrFtEvQt

Linguagem predominante
Python
Estrelas
4
Forks
1
Merge médio
10h 41min
PRs com merge (30d)
79

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de cpp-best-practices/project_validator

Todas as issues de cpp-best-practices/project_validator

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

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