Empêcher l'installation du paquet sur les anciennes versions de Python

Question

Que pouvons-nous mettre dans un fichier setup.py pour empêcher le pip de collecter et d'essayer d'installer un paquet en utilisant une version Python non supportée?

Par exemple magicstack est un projet répertorié avec le classificateur Trove:

Programming Language :: Python :: 3 :: Only 

donc je pense le comportement suivant si pip --version est lié à Python 2.7:

$ pip install magicstack 
Collecting magicstack 
    Could not find a version that satisfies the requirement magicstack (from versions:) 
No matching distribution found for magicstack 

Mais le comportement réel est que pip recueille une version, la télécharge, tente de l'installer et échoue. Il existe par exemple d'autres versions de Python3, par exemple curio, qui s'installent correctement - car le setup.py n'utilisait rien de particulier à Python 3 - mais il échouait au moment de l'importation lorsqu'une syntaxe Python 3 seulement était utilisée. Et je suis sûr qu'il y a des paquets qui installent OK, importent OK, et peut-être seulement échouer à l'exécution!

Quelle est la méthode correcte pour spécifier vos versions Python prises en charge d'une manière que pip va respecter? J'ai trouvé une solution de contournement, consistant à télécharger uniquement un fichier de roue, et à refuser de télécharger une distribution .tar.gz, mais je serais intéressé de connaître le correctif approprié.

---

Edit: Comment ne sait pas pip télécharger la distribution de roue si le Python/os/architecture ne correspond pas à? Utilise-t-il simplement le .whl filename convention ou y a-t-il quelque chose de plus sophistiqué que ce qui se passe dans les coulisses? Pouvons-nous en quelque sorte donner les métadonnées à une distribution source pour faire pip faire la bonne chose avec les téléchargements .tar.gz?

Answer 1

Il y a une façon correcte de le faire, mais malheureusement pip seulement commencé à le supporter dans la version 9.0.0 (publié 2016-11-02), et ainsi les utilisateurs avec des versions plus anciennes de pip continueront à télécharger des paquets willy-nilly quelle que soit la version de Python pour laquelle ils sont destinés.

Dans votre fichier setup.py, passez setup() un argument python_requires qui répertorie les versions de Python pris en charge de votre paquet en tant que PEP 440version specifier. Par exemple, si votre forfait est pour Python 3+ seulement, écrire:

setup(
    ... 
    python_requires='>=3', 
    ... 
) 

Si votre colis est pour Python 3.3 ans et plus, mais vous n'êtes pas prêt à engager à Python 4 support encore, écrire:

setup(
    ... 
    python_requires='~=3.3', 
    ... 
) 

Si votre colis est pour Python 2.6, 2.7 et toutes les versions de Python 3 à partir de 3,3, écrire:

setup(
    ... 
    python_requires='>=2.6, !=3.0.*, !=3.1.*, !=3.2.*, <4', 
    ... 
) 

Et ainsi de suite. Une fois cela fait, vous devrez mettre à jour votre version de setuptools à au moins 24.2.0 afin que l'argument python_requires soit traité; les versions antérieures l'ignoreront simplement avec un avertissement. Tous les sdists et les roues de votre projet construits après contiennent alors les métadonnées appropriées qui indiquent à PyPI de dire à quelles versions de Python elles sont destinées.

Answer 2

La distribution magicstack sur pypi est interrompue. Il échoue car la distribution source ne contient pas de package magicstack même si le setup.py de la distribution source indique qu'il devrait l'être.

Tant que pypi contient une distribution source (par exemple .tar.gz, .zip), pépin téléchargera que si elle ne peut pas trouver une distribution binaire correspondant (par exemple .egg, .whl) pour votre version de python/os/architecture. Vos options sont de télécharger uniquement les distributions binaires vers pypi (de préférence wheels), même si je ne sais même pas si les paquets pypi binaires sont autorisés. L'autre option est de vérifier le sys.version dans votre setup.py pour les versions compatibles et de lever une exception sinon.