python / python/mypy

[maintenance] Upgrade the use of `pip-tools` to leverage its modern features

Aperta
#17,718 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

feature
Lingua principale
Python
Stelle
20.6k
Fork
3.3k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

Feature

$sbj. pip-tools now supports config files (through .pip-tools.toml or pyproject.tomlhttps://pip-tools.readthedocs.io/en/stable/#configuration). It also supports extracting the build requirements (https://pip-tools.readthedocs.io/en/stable/#maximizing-reproducibility).

Pitch

I saw a couple of pip-tools-managed files in the repo but no documentation on invoking pip-compile or a wrapper script for updating the pins. Having a config file would help with keeping the settings consistent if somebody calls it w/o all the expected args. Here's a config example I tend to use: https://github.com/cherrypy/cheroot/blob/1ff20b1/.pip-tools.toml.

As for the build deps, using one of --build-deps-for [editable|sdist|wheel], --all-build-deps or --only-build-deps can help you get rid of https://github.com/python/mypy/blob/fe15ee6/build-requirements.txt#L1 and https://github.com/python/mypy/blob/fe15ee6/mypy-requirements.txt#L1-L2 which relies on people having to remember to keep things in sync across to copies of deps lists.

cc @hauntsaninja since you were the last to touch build-requirements.txt and @AlexWaygood as you wrote the following in your commit message last changing mypy-requirements.txt:

(Can't say I fully understand why we have to have
this pin in three places :)

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia leggendo la configurazione di pip-tools e i file build-requirements.txt e mypy-requirements.txt menzionati nell’issue, quindi confrontali con la documentazione di pip-tools sulla configurazione e sulle dipendenze di build. Individua come vengono attualmente mantenuti i pin delle dipendenze e come è documentata l’invocazione. Il lavoro è completato quando le impostazioni di pip-tools sono coerenti, gli elenchi di dipendenze duplicati sono ridotti e i comandi di aggiornamento sono documentati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
build-system, tooling
Tipo di issue
Refactoring
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.