Esiste un modo standard per elencare i nomi dei moduli Python in un pacchetto?
Domanda
Esiste un modo semplice per elencare i nomi di tutti i moduli in un pacchetto, senza usare __all__
?
Ad esempio, dato questo pacchetto:
/testpkg
/testpkg/__init__.py
/testpkg/modulea.py
/testpkg/moduleb.py
Mi chiedo se esiste un modo standard o integrato per fare qualcosa del genere:
>>> package_contents("testpkg")
['modulea', 'moduleb']
L'approccio manuale sarebbe quello di scorrere i percorsi di ricerca del modulo per trovare la directory del pacchetto. Si potrebbe quindi elencare tutti i file in quella directory, filtrare i file py / pyc / pyo dal nome univoco, eliminare le estensioni e restituire tale elenco. Ma questo sembra una buona dose di lavoro per qualcosa che il meccanismo di importazione del modulo sta già svolgendo internamente. Questa funzionalità è esposta da qualche parte?
Soluzione
Forse questo farà quello che stai cercando?
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)])
Altri suggerimenti
Utilizzando python2.3 e versioni successive , puoi anche utilizzare il modulo pkgutil
:
>>> import pkgutil
>>> [name for _, name, _ in pkgutil.iter_modules(['testpkg'])]
['modulea', 'moduleb']
EDIT: Nota che il parametro non è un elenco di moduli, ma un elenco di percorsi, quindi potresti voler fare qualcosa del genere:
>>> 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)
Non so se sto trascurando qualcosa o se le risposte sono appena superate ma;
Come affermato dall'utente815423426, questo funziona solo per oggetti live e i moduli elencati sono solo moduli che sono stati importati in precedenza.
Elencare i moduli in un pacchetto sembra davvero facile usando inspect :
>>> import inspect, testpkg
>>> inspect.getmembers(testpkg, inspect.ismodule)
['modulea', 'moduleb']
Questa è una versione ricorsiva che funziona con Python 3.6 e versioni successive:
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
Questo dovrebbe elencare i moduli:
help("modules")
Se desideri visualizzare un'informazione sul tuo pacchetto al di fuori del codice python (da un prompt dei comandi) puoi usare pydoc per esso.
# 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>
Avrai lo stesso risultato di pydoc ma all'interno dell'interprete con l'aiuto
>>> import <my package>
>>> help(<my package>)
Sulla base dell'esempio di cdleary, ecco un percorso di elenco delle versioni ricorsivo per tutti i sottomoduli:
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)
print dir (modulo)
def package_contents(package_name):
package = __import__(package_name)
return [module_name for module_name in dir(package) if not module_name.startswith("__")]