Différences entre distribute, distutils, setuptools et distutils2 ?

Question

La situation

J'essaie de porter une bibliothèque open-source vers Python 3. ( SymPy si quelqu'un se pose la question).

Donc, j'ai besoin d'exécuter 2to3 automatiquement lors de la construction pour Python 3. Pour ce faire, je dois utiliser distribute . Par conséquent, je dois porter le système actuel, qui (selon le doctest) est distutils .

Le problème

Malheureusement, je ne sais pas quelle est la différence entre ces modules distutils , distribute , setuptools . La documentation est très sommaire, car ils semblent tous être des dérivations les uns des autres, censés être compatibles dans la plupart des cas (mais en fait, pas tous) et ainsi de suite, et ainsi de suite.

La question

Quelqu'un pourrait-il expliquer les différences ? Que dois-je utiliser ? Quelle est la solution la plus moderne ? (En passant, j'apprécierais également un guide sur le portage vers le format Distribute mais cela dépasse un peu le cadre de la question )

Answer 1

En mars 2020, la plupart des autres réponses à cette question sont dépassées de plusieurs années. Lorsque vous trouvez des conseils sur les questions relatives à l'emballage des pythons, n'oubliez pas de regarder la date de publication et ne vous fiez pas à des informations périmées.

El Guide de l'utilisateur de Python Packaging vaut la peine d'être lu. Chaque page comporte une date de "dernière mise à jour", ce qui vous permet de vérifier l'actualité du manuel, qui est assez complet. Le fait qu'il soit hébergé sur un sous-domaine de python.org de la Python Software Foundation ne fait qu'ajouter du crédit à son contenu. Le site Résumés des projets est particulièrement pertinente ici.

Résumé des outils :

Voici un résumé du paysage de l'emballage Python :

Outils pris en charge :

• distutils est toujours l'outil standard pour le packaging en Python. Il est inclus dans la bibliothèque standard (Python 2 et Python 3). Il est utile pour les distributions Python simples, mais manque de fonctionnalités. Il introduit le distutils Python qui peut être importé dans votre programme setup.py script.

  • _{<a href="https://docs.python.org/3/library/distutils.html" rel="noreferrer">Documents officiels </a>| <a href="https://packaging.python.org/key_projects/#distutils" rel="noreferrer"><code>distutils</code> section du Guide d'utilisation des paquets Python</a>}

• setuptools a été développé pour surmonter les limitations de Distutils, et n'est pas inclus dans la bibliothèque standard. Il introduit un utilitaire en ligne de commande appelé easy_install . Il a également introduit le setuptools Python qui peut être importé dans votre programme setup.py script, et les pkg_resources Paquet Python qui peut être importé dans votre code pour localiser les fichiers de données installés avec une distribution. L'un de ses inconvénients est qu'il modifie l'interface de l'application distutils paquet Python. Il devrait bien fonctionner avec pip . Il voit des sorties régulières.

  • _{<a href="https://setuptools.readthedocs.io/en/latest/" rel="noreferrer">Documents officiels </a>| <a href="https://pypi.python.org/pypi/setuptools" rel="noreferrer">Page Pypi </a>| <a href="https://github.com/pypa/setuptools" rel="noreferrer">Repo GitHub </a>| <a href="https://packaging.python.org/key_projects/#setuptools" rel="noreferrer"><code>setuptools</code> section du Guide d'utilisation des paquets Python</a>}

• scikit-build est un générateur de système de construction amélioré qui utilise en interne CMake pour construire des extensions Python compilées. Comme scikit-build n'est pas basé sur distutils, il n'a pas vraiment ses limitations. Lorsque ninja-build est présent, scikit-build peut compiler de grands projets plus de trois fois plus rapidement que les alternatives. Il devrait bien fonctionner avec pip .

  • _{<a href="http://scikit-build.readthedocs.io/en/latest/" rel="noreferrer">Documents officiels </a>| <a href="https://pypi.org/project/scikit-build/" rel="noreferrer">Page Pypi </a>| <a href="https://github.com/scikit-build/scikit-build" rel="noreferrer">Repo GitHub </a>| <a href="https://packaging.python.org/key_projects/#scikit-build" rel="noreferrer"><code>scikit-build</code> section du Guide de l'utilisateur du paquet Python</a>}

• distlib est une bibliothèque qui fournit des fonctionnalités utilisées par des outils de niveau supérieur tels que pip .

  • _{<a href="http://pythonhosted.org/distlib/" rel="noreferrer">Docs officiels </a>| <a href="https://pypi.org/project/distlib" rel="noreferrer">Page Pypi </a>| <a href="https://bitbucket.org/pypa/distlib" rel="noreferrer">Dépôt Bitbucket </a>| <a href="https://packaging.python.org/key_projects/#distlib" rel="noreferrer"><code>distlib</code> section du Guide d'utilisation des paquets Python</a>}

• packaging est également une bibliothèque qui fournit des fonctionnalités utilisées par des outils de plus haut niveau tels que pip y setuptools

  • _{<a href="https://packaging.pypa.io/" rel="noreferrer">Docs officiels </a>| <a href="https://pypi.org/project/packaging" rel="noreferrer">Page Pypi </a>| <a href="https://github.com/pypa/packaging" rel="noreferrer">Repo GitHub </a>| <a href="https://packaging.python.org/key_projects/#packaging" rel="noreferrer"><code>packaging</code> section du Guide de l'utilisateur du paquet Python</a>}

Outils obsolètes/abandonnés :

• distribute était une fourche de setuptools . Il partageait le même espace de noms, donc si vous aviez installé Distribute, import setuptools importerait en fait le paquet distribué avec Distribute. Distribute a été fusionné à nouveau dans Setuptools 0.7 Vous n'avez donc plus besoin d'utiliser Distribute. En fait, la version sur Pypi est juste une couche de compatibilité qui installe Setuptools.

• distutils2 était une tentative de prendre le meilleur de distutils , setuptools y distribute et est devenu l'outil standard inclus dans la bibliothèque standard de Python. L'idée était que distutils2 serait distribué pour les anciennes versions de Python, et que distutils2 serait renommé en packaging pour Python 3.3, qui l'inclurait dans sa bibliothèque standard. Ces plans ne se sont cependant pas déroulés comme prévu, et actuellement, distutils2 est un projet abandonné . La dernière version date de mars 2012, et sa page d'accueil Pypi a enfin été mise à jour pour refléter sa mort.

Autres :

Il y a d'autres outils, si vous êtes intéressés, lisez Résumés des projets dans le guide de l'utilisateur de Python Packaging. Je ne les énumérerai pas tous, pour ne pas répéter cette page, et pour que la réponse corresponde à la question, qui ne portait que sur distribute , distutils , setuptools y distutils2 .

Recommandation :

Si tout cela est nouveau pour vous, et que vous ne savez pas par où commencer, Je recommande d'apprendre setuptools ainsi que pip y virtualenv qui fonctionnent tous très bien ensemble.

Si vous cherchez à virtualenv vous pourriez être intéressé par cette question : Quelle est la différence entre venv , pyvenv , pyenv , virtualenv , virtualenvwrapper etc. . (Oui, je sais, je gémis avec vous).

Answer 2

Je suis un mainteneur de distutils et un contributeur de distutils2/packaging. J'ai fait un exposé sur le packaging Python à ConFoo 2011 et ces jours-ci j'écris une version étendue de celui-ci. Elle n'est pas encore publiée, alors voici des extraits qui devraient aider à définir les choses.

• Distutils est l'outil standard utilisé pour l'emballage. Il fonctionne plutôt bien pour des besoins simples, mais il est limité et pas trivial à étendre.

• Outils d'installation est un projet né du désir de combler les fonctionnalités manquantes de distutils et d'explorer de nouvelles directions. Dans certaines sous-communautés, c'est une de facto standard. Il utilise monkey-Parcheando et la magie qui est désapprouvée par les développeurs du noyau Python.

• Distribuer est un fork de Setuptools qui a été lancé par des développeurs estimant que son rythme de développement était trop lent et qu'il n'était pas possible de le faire évoluer. Son développement a été considérablement ralenti lorsque distutils2 a été démarré par le même groupe. 2013-Mise à jour d'août : distribute est fusionnée à nouveau dans setuptools et abandonnée.

• Distutils2 est une nouvelle bibliothèque distutils, démarrée comme un fork de la base de code distutils, avec de bonnes idées tirées des outils de configuration (dont certains ont été discutés en détail dans les PEP), et un installateur de base inspiré de pip. Le nom réel que vous utilisez pour importer Distutils2 est packaging dans la bibliothèque standard de Python 3.3+, ou distutils2 dans 2.4+ et 3.1-3.2. (Un backport sera bientôt disponible). Distutils2 n'a pas fait la sortie de Python 3.3, et il a été mis en attente.

Plus d'informations :

• Le sort des Distutils - Rapport détaillé du Pycon Summit + Packaging Sprint
• Une rapide différence entre Distutils et Distutils2

J'espère terminer mon guide bientôt, il contiendra plus d'informations sur les points forts et faibles de chaque bibliothèque et un guide de transition.

Answer 3

REMARQUE : Réponse dépréciée, Distribute est maintenant obsolète. Cette réponse n'est plus valable depuis que la Python Packaging Authority a été formée et a fait un gros travail de nettoyage.

---

Oui, vous l'avez. :-o Je pense qu'en ce moment le paquet préféré est Distribuer qui est un fork de setuptools, qui est une extension de distutils (le système d'empaquetage original). Setuptools n'étant pas maintenu, il a été bifurqué et renommé, mais lorsqu'il est installé, il utilise le nom de paquetage de setuptools ! Je pense que la plupart des développeurs Python utilisent maintenant Distribute, et je peux dire avec certitude que je le fais.

Answer 4

Je me rends compte que j'ai répondu à votre question secondaire sans aborder les hypothèses incontestées de votre problème initial :

J'essaie de porter une bibliothèque open-source (SymPy, si quelqu'un se pose la question) vers Python 3. Pour Pour ce faire, j'ai besoin d'exécuter 2to3 automatiquement lors de la construction pour Python 3.

Vous mai pas besoin de . D'autres stratégies sont décrites à l'adresse http://docs.python.org/dev/howto/pyporting

Pour ce faire, je dois utiliser la distribution,

Vous mai :) distutils supporte la conversion 2to3 à la construction pour le code (pas les docstrings), d'une manière différente de celle de distribute : http://docs.python.org/dev/howto/pyporting#during-installation

Answer 5

Ce sujet semble être encore en pleine évolution. En date du 31-10-2013, le "Python Packaging User Guide" (Guide de l'utilisateur de Python Packaging) Recommandations rapides définit "quel ensemble d'outils est actuellement recommandé". Il renvoie également à " L'avenir du packaging Python "