Was macht `python setup.py check` eigentlich?

Question

Was genau macht python setup.py check eigentlich?

Answer 1

Erster Halt, die distutils package documentation:

Der Prüfbefehl führt einige Tests auf den Meta-Daten eines Pakets. Beispielsweise wird überprüft, ob alle erforderlichen Metadaten als Argumente für die Funktion setup() bereitgestellt werden.

So testet es, ob Sie Ihre Metadaten korrekt ausgefüllt haben; Sehen Sie es als Qualitätskontrollschritt beim Erstellen eines Python-Pakets.

Als nächstes können wir überprüfen, ob die Befehlszeile jede Hilfe bietet:

$ python setup.py --help-commands | grep check 
    check    perform some checks on the package 
$ python setup.py check --help 
# ... 
Options for 'check' command: 
    --metadata (-m)   Verify meta-data 
    --restructuredtext (-r) Checks if long string meta-data syntax are 
          reStructuredText-compliant 
    --strict (-s)   Will exit with an error if a check fails 

So können wir für Metadaten überprüfen und die lange Beschreibung als reStructuredText validieren. Letzteres setzt voraus, dass Sie docutils installiert haben:

$ python setup.py check -rs 
running check 
error: The docutils package is needed. 

Wenn Sie sie installiert haben, und es gibt keine Probleme, das Skript gerade läuft und Ausfahrten ohne Nachrichten:

$ python setup.py check -r 
running check 

aber bei Bedarf Metadaten Vermissen Sie erhalten Warnmeldungen:

$ python setup.py check -r 
running check 
warning: check: missing required meta-data: url 

warning: check: missing meta-data: either (author and author_email) or (maintainer and maintainer_email) must be supplied 

, die einen Fehler wird, wenn Sie die -s Flagge gegeben haben:

$ python setup.py check -rs 
running check 
warning: check: missing required meta-data: url 

warning: check: missing meta-data: either (author and author_email) or (maintainer and maintainer_email) must be supplied 

error: Please correct your package. 

standardmäßig -m aktiviert ist, -r und -s deaktiviert sind.

Siehe auch command source code.