Est-il un standard moyen de la liste de noms de modules Python dans un paquet?

Est-il un moyen simple d'énumérer les noms de tous les modules dans un colis, sans l'aide de __all__?

Par exemple, compte tenu de ce package:

/testpkg
/testpkg/__init__.py
/testpkg/modulea.py
/testpkg/moduleb.py

Je me demandais si il existe une norme ou intégré dans la façon de faire quelque chose comme ceci:

>>> package_contents("testpkg")
['modulea', 'moduleb']

Le manuel d'approche serait de parcourir le module de chemins de recherche afin de trouver le paquet du répertoire. On pourrait alors la liste de tous les fichiers dans ce répertoire, filtre l'unique nommé py/pyc/pyo fichiers, bande les extensions, et le retour de cette liste. Mais cela semble être une bonne quantité de travail pour quelque chose, le module d'importation mécanisme est déjà en interne. Est-ce que la fonctionnalité exposés n'importe où?

InformationsquelleAutor DNS | 2009-01-28
  1. 18

    Peut-être que cela va faire ce que vous recherchez?

    import imp
import os
MODULE_EXTENSIONS = ('.py', '.pyc', '.pyo')

def package_contents(package_name):
    file, pathname, description = imp.find_module(package_name)
    if file:
        raise ImportError('Not a package: %r', package_name)
    # Use a set because some may be both source and compiled.
    return set([os.path.splitext(module)[0]
        for module in os.listdir(pathname)
        if module.endswith(MODULE_EXTENSIONS)])
    • Je voudrais ajouter " et le module != "init.py"' à la finale de "si", car init.py n'est pas vraiment partie du package. Et .pyo est un autre poste valide. A côté de cela, l'aide d'imp.find_module est vraiment une bonne idée; je pense que c'est la bonne réponse.
    • Je suis en désaccord -- vous pouvez importer init directement, alors pourquoi cas spécial il? C'est sûr qu'il n'est pas assez spécial pour briser les règles. 😉
    • Vous devriez probablement utiliser imp.get_suffixes() au lieu de votre liste.
    • Aussi, notez que cela ne fonctionne pas sur des sous-paquets comme xml.sax
    • Quel est le but de [os.path.splitext(module)[0]? Tout d'abord, le module n'est pas défini... voulez-vous dire 'package_name" ou "chemin" (dont près que je peux dire, sont toujours les mêmes), et puis pourquoi tranche de l'extension d'un nom de package? Y aurait-il un? Et d'ailleurs, pourquoi inclure le package à tous?
    • 1) le module est défini dans la compréhension de liste, 2) ils sont décapage de l'extension dans le nom du module, car cette méthode retourne les noms des modules à l'intérieur du paquet
    • C'est vraiment un mauvais chemin. Vous ne pouvez pas fiable dire qu'est ce qu'un module à partir de l'extension de nom de fichier.
    • Ne fonctionne pas en Jython trop si le Jython module est un tas de compilé .py$class fichiers dans un .fichier jar
    • Cette technique ne fonctionne que pour de simples paquets structuré sur le système de fichiers. Il ne fonctionnera pas pour les oeufs, zip roues, ou des modules où les modules sont chargés dynamiquement.

    InformationsquelleAutor cdleary
  2. 173

    À l'aide de python2.3 et au-dessus, vous pouvez également utiliser la pkgutil module:

    >>> import pkgutil
>>> [name for _, name, _ in pkgutil.iter_modules(['testpkg'])]
['modulea', 'moduleb']

    EDIT: Notez que le paramètre n'est pas une liste de modules, mais une liste de chemins d'accès, de sorte que vous pouvez faire quelque chose comme ceci:

    >>> import os.path, pkgutil
>>> import testpkg
>>> pkgpath = os.path.dirname(testpkg.__file__)
>>> print [name for _, name, _ in pkgutil.iter_modules([pkgpath])]
    • C'est inquiétant de sans-papiers, mais semble la plus correcte pour ce faire. Espérons que vous n'avez pas l'esprit, j'ai ajouté la note.
    • pkgutil il y a dans les python2.3 en fait. Aussi, tandis que pkgutil.iter_modules() ne fonctionnera pas de manière récursive, il y a un pkgutil.walk_packages() ainsi, qui est de manière récursive. Merci pour le pointeur vers ce paquet bien.
    • Pourquoi iter_modules ne fonctionne pas pour absolue à l'importation comme a.b.testpkg? Il me donne []
    • J'ai négligé de votre EDIT :(. Désolé. Il fonctionne après j'ai suivi le deuxième extrait.
    • En prenant l'OP littéralement, je ne vois pas pourquoi vous auriez besoin d'utiliser os.path.dirname, mais encore une fois, je pense que cela fonctionnera avec ou sans elle, car testpkg est un répertoire.
    • Je ne peux pas confirmer que pkgutil.walk_packages() se répète, il me donne le même résultat que pkgutil.iter_modules(), donc je pense que la réponse est incomplète.
    • Cette méthode ne parvient pas à trouver os.path comme un sous-module de os. Mais c'est peut-être un cas particulier?

    InformationsquelleAutor jp.
  3. 25
    import module
help(module)
    • Bien que l'aide ne liste contenu de l'emballage au bas de ce texte, la question est plus le long des lignes de comment faire ceci: f(package_name) => ["module1_name", "module2_name"]. Je suppose que j'ai pu analyser la chaîne de caractères retournée par l'aide, mais qui semble plus rond-point de la liste du répertoire.
    • imprime des trucs, il ne renvoie pas une chaîne de caractères.
    • Je suis d'accord c'est une façon détournée, mais il m'a envoyé en bas d'un trou de lapin pour voir comment help() œuvres. De toute façon, le haut- pydoc module peut aider à cracher de la chaîne help() pagine: import pydoc; pydoc.render_doc('mypackage').
    InformationsquelleAutor Triptych
  4. 6

    Ne sais pas si je suis donnant sur quelque chose, ou si les réponses sont tout simplement hors-daté mais;

    Comme l'a déclaré user815423426 cela fonctionne uniquement pour les objets vivants et les modules sont uniquement les modules qui ont été importés avant.

    Liste des modules dans un paquet semble vraiment facile à l'aide de inspecter:

    >>> import inspect, testpkg
>>> inspect.getmembers(testpkg, inspect.ismodule)
['modulea', 'moduleb']
    • J'ai mis importés = import__('myproj.mymod.mysubmod') m = inspecter.getmembers(i, inspecter.ismodule) mais importd chemin est ~/myproj/__init.py et m est une liste (mymod, '~/myproj/mymod/__init__.py')
    • Ne posez pas de questions dans les commentaires, surtout s'ils ne sont pas directement liées. Être un bon Samaritain: Utilisation imported = import importlib; importlib.import_module('myproj.mymod.mysubmod'). __import__ importations de haut niveau module, voir la documentation.
    • Hmm, c'est prometteur, mais il ne fonctionne pas pour moi. Quand je fais import inspect, mypackage et puis inspect.getmembers(my_package, inspect.ismodule) - je obtenir une liste vide, même si je n'ai certainement différents modules en elle.
    • Comme une question de fait, cela ne semble fonctionner si je import my_package.foo et pas seulement import mypackage, auquel cas il renvoie ensuite foo. Mais cela va à l'encontre du but
    • Par ailleurs, si vous lisez la documentation de inspect, il dit explicitement qu'il est une librairie d'inspecter objets en direct, qui est pourquoi il ne montre pas tout ce qui n'a pas encore été chargé.
    • Vous avez absolument raison 😉 on dirait que je a été vue sur quelque chose.
    • Oui @user815423426 ce code ne fonctionne pas.

    InformationsquelleAutor siebz0r
  5. 2

    C'est un appel récursif à la version qui fonctionne avec python 3.6 et ci-dessus:

    import importlib.util
from pathlib import Path
import os
MODULE_EXTENSIONS = '.py'

def package_contents(package_name):
    spec = importlib.util.find_spec(package_name)
    if spec is None:
        return set()

    pathname = Path(spec.origin).parent
    ret = set()
    with os.scandir(pathname) as entries:
        for entry in entries:
            if entry.name.startswith('__'):
                continue
            current = '.'.join((package_name, entry.name.partition('.')[0]))
            if entry.is_file():
                if entry.name.endswith(MODULE_EXTENSIONS):
                    ret.add(current)
            elif entry.is_dir():
                ret.add(current)
                ret |= package_contents(current)


    return ret
    • Quel est l'avantage de l'utilisation de os.scandir comme un gestionnaire de contexte au lieu d'itérer sur le résultat directement des entrées?
    • Voir docs.python.org/3/library/os.html#os.scandir qui suggèrent de l'utiliser comme un gestionnaire de contexte pour s'assurer que close est appelé lorsque vous avez fini avec elle pour s'assurer que tous les détenus les ressources sont libérées.
    • cela ne marche pas pour re au lieu de cela il répertorie chaque paquet, mais ajoute re. à tous
    InformationsquelleAutor tacaswell
  6. 0

    Ce doit indiquer la liste des modules:

    help("modules")
    InformationsquelleAutor Ammon
  7. 0

    Si vous souhaitez afficher une inforamtion sur votre colis à l'extérieur du code python (à partir d'une invite de commande), vous pouvez utiliser pydoc pour elle.

    # get a full list of packages that you have installed on you machine
$ python -m pydoc modules

# get information about a specific package
$ python -m pydoc <your package>

    Vous aurez le même résultat que pydoc mais à l'intérieur de l'interprète à l'aide de

    >>> import <my package>
>>> help(<my package>)
    InformationsquelleAutor Vlad Bezden
  8. 0

    Basé sur cdleary l'exemple, voici une version récursive d'inscription chemin pour tous les submodules:

    import imp, os

def iter_submodules(package):
    file, pathname, description = imp.find_module(package)
    for dirpath, _, filenames in os.walk(pathname):
        for  filename in filenames:
            if os.path.splitext(filename)[1] == ".py":
                yield os.path.join(dirpath, filename)
    • Qu'est-ce que isc_datasources?
    • Oooops, codé en dur déchets, qui ne devraient pas y être. Thx pour noter, fixe.
    InformationsquelleAutor Vajk Hermecz
  9. -2

    print dir(module)

    • Qui liste le contenu d'un module qui a déjà été importé. Je suis à la recherche d'un moyen de lister le contenu d'un paquet qui n'a pas encore été importés, comme 'a partir de x import *" n'quand tous n'est pas spécifié.
    • de x import * d'abord, les importations du module, puis copie le tout pour le module en cours.
    • J'ai réalisé que 'partir de x import *" n'est pas en fait importer des sous-modules d'un paquet, en raison de la sensibilité des questions sur Windows. J'ai seulement compris que comme un exemple de ce que je voulais faire; j'ai édité, il est hors de question pour éviter toute confusion.
    • Qui répertorie tous les attributs d'un objet importé, pas une liste de sous-modules. Afin de ne pas répondre à la question.
    InformationsquelleAutor QueueHammer
  10. -2
    def package_contents(package_name):
  package = __import__(package_name)
  return [module_name for module_name in dir(package) if not module_name.startswith("__")]
    • Cela ne fonctionne que pour les modules, pas de paquets. Essayez-la sur Python logging paquet pour voir ce que je veux dire. La journalisation contient deux modules: gestionnaires et config. Votre code, vous obtiendrez une liste de 66 éléments, qui ne comprend pas ces deux noms.
    InformationsquelleAutor