Существует ли стандартный способ перечисления имен модулей Python в пакете?

StackOverflow https://stackoverflow.com/questions/487971

  •  20-08-2019
  •  | 
  •  

Вопрос

Есть ли простой способ перечислить имена всех модулей в пакете, без использования __all__?

Например, учитывая этот пакет:

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

Мне интересно, есть ли стандартный или встроенный способ сделать что-то подобное:

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

Ручной подход заключался бы в переборе путей поиска модуля, чтобы найти каталог пакета.Затем можно было бы перечислить все файлы в этом каталоге, отфильтровать файлы py / pyc / pyo с уникальными именами, удалить расширения и вернуть этот список.Но это кажется изрядным объемом работы для чего-то, что механизм импорта модуля уже выполняет внутренне.Доступна ли эта функциональность где-нибудь?

Это было полезно?

Решение

Может быть, это поможет сделать то, что вы ищете?

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)])

Другие советы

Используя python2.3 и выше, вы также могли бы использовать pkgutil модуль:

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

Редактировать: Обратите внимание, что параметр представляет собой не список модулей, а список путей, поэтому вы можете захотеть сделать что-то вроде этого:

>>> import os.path, pkgutil
>>> import testpkg
>>> pkgpath = os.path.dirname(testpkg.__file__)
>>> print [name for _, name, _ in pkgutil.iter_modules([pkgpath])]
import module
help(module)

Не знаю, то ли я что-то упускаю из виду, то ли ответы просто устарели, но;

Как указано пользователем 815423426, это работает только для живых объектов, а перечисленные модули - это только те модули, которые были импортированы ранее.

Перечисление модулей в пакете кажется действительно простым в использовании Осмотр:

>>> import inspect, testpkg
>>> inspect.getmembers(testpkg, inspect.ismodule)
['modulea', 'moduleb']

Это рекурсивная версия, которая работает с python 3.6 и выше:

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

Здесь должен быть список модулей:

help("modules")

Если вы хотите просмотреть информацию о вашем пакете вне кода python (из командной строки), вы можете использовать для этого pydoc.

# 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>

Вы получите тот же результат, что и pydoc, но внутри интерпретатора, используя справку

>>> import <my package>
>>> help(<my package>)

Основываясь на примере cdleary, вот рекурсивный путь к списку версий для всех подмодулей:

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)

каталог печати (модуль)

def package_contents(package_name):
  package = __import__(package_name)
  return [module_name for module_name in dir(package) if not module_name.startswith("__")]
Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top