Python beste Möglichkeit, importierte Modulversion in Skripten zu dokumentieren

Question

Was ist der beste Weg oder PEP-Konvention, um die Versionen von importierten Modulen in einzelnen Python-Skripten zu dokumentieren? Manchmal muss ich ältere Skripte benutzen, die wegen Modulinkompatibilität nicht laufen (zum Beispiel wurde das Skript mit Pandas 0.15.0 und Matplotlib 1.3.0 geschrieben, und jetzt benutze ich Pandas 0.18.1 und Matplotlib 1.5.1). Es wäre zum Beispiel toll, wenn der erste Teil des Skripts Pandas (und anderen importierten Moduls) Version in Kommentar, wie enthalten würde:

"""my_script_version = '0.0.1' 
pandas_version = '0.15.0' 
matplotlib_version = '1.3.0' 
other_imported_module_version = 'x.y.z' 
""" 

Oder gibt es einen offiziellen Weg, dies zu tun? Etwas wie die Verwendung einiger Metadatas?

__version__ = '0.0.1' 
__date__ = '2016-06-06' 
__author__ = 'ragesz' 

__pandas_version__ = '0.15.0' 
__matplotlib_version__ = '1.3.0' 
__other_imported_module_version__ = 'x.y.z' 

Vielen Dank!

Answer 1

PEP 518 wurde kürzlich in Bezug auf Ihre Frage akzeptiert.

Abhängigkeiten hat in einer bestimmten Datei pyproject.toml

[build-system] 
# Minimum requirements for the build system to execute. 
requires = ["setuptools", "wheel"] # PEP 508 specifications. 

PEP 508 angeben Syntax für die Anforderungen gespeichert werden.

Answer 2

Der beste Weg, Informationen zu Ihrem Skript hinzuzufügen ist Whit Metadaten, zum Beispiel:

__version__="1.0.2" 
__appname__="name script" 
__author__="author" 
__description__="short description" 
__long_description__="long description for your script" 
__author_email__="author@gmail.com"