Як перелічити всі функції модуля Python?

У мене в моїй системі встановлений модуль python, і я хотів би мати можливість бачити, які функції / класи / методи доступні в ньому.

Я хочу викликати функцію doc на кожному. У рубіні я можу зробити щось на зразок ClassName.methods, щоб отримати список усіх методів, доступних для цього класу. Чи є щось подібне в python?

напр. щось на зразок:

from somemodule import foo
print foo.methods # or whatever is the correct method to call

inspectМодуль. Також дивіться pydocмодуль, help()функцію в інтерактивному перекладачі та інструмент pydocкомандного рядка, який створює документацію, яку ви шукаєте. Ви можете просто дати їм клас, на який ви хочете переглянути документацію. Вони також можуть генерувати, наприклад, вихід HTML та записувати його на диск.

Ви можете використовувати dir(module)для перегляду всіх доступних методів / атрибутів. Також перевірте PyDocs.

Після importредагування модуля ви можете просто зробити:

 help(modulename)

... Інтерактивно отримувати документи на всі функції відразу. Або ви можете використовувати:

 dir(modulename)

... Просто перелічити назви всіх функцій та змінних, визначених у модулі.

Приклад з Inspect:

from inspect import getmembers, isfunction
from my_project import my_module

functions_list = [o for o in getmembers(my_module) if isfunction(o[1])]

getmembers повертає список (корпоративні_імена, тип_об'єкта) кортежів.

Ви можете замінити функцію будь-якою з інших функцій isXXX в модулі перевірки.

import types
import yourmodule

print([getattr(yourmodule, a) for a in dir(yourmodule)
  if isinstance(getattr(yourmodule, a), types.FunctionType)])

Для повноти я хочу зазначити, що іноді вам може знадобитися проаналізувати код, а не імпортувати його. А importбуде виконувати вирази верхнього рівня, і це може бути проблемою.

Наприклад, я дозволяю користувачам вибирати функції вхідної точки для пакетів, виготовлених за допомогою zipapp . Використання importта inspectризик запуску коду збиття, що призводить до збоїв, довідкових повідомлень щодо друку, діалогових діалогових вікон графічного інтерфейсу тощо.

Натомість я використовую модуль ast для переліку всіх функцій верхнього рівня:

import ast
import sys

def top_level_functions(body):
    return (f for f in body if isinstance(f, ast.FunctionDef))

def parse_ast(filename):
    with open(filename, "rt") as file:
        return ast.parse(file.read(), filename=filename)

if __name__ == "__main__":
    for filename in sys.argv[1:]:
        print(filename)
        tree = parse_ast(filename)
        for func in top_level_functions(tree.body):
            print("  %s" % func.name)

Вкладаючи цей код list.pyі використовуючи себе як вхід, я отримую:

$ python list.py list.py
list.py
  top_level_functions
  parse_ast

Звичайно, навігація по AST часом може бути складною, навіть для відносно простої мови на зразок Python, оскільки AST досить низький. Але якщо у вас простий і зрозумілий кейс для використання, це одночасно і придатно, і безпечно.

Хоча недоліком є ​​те, що ви не можете виявити функції, що створюються під час виконання, наприклад foo = lambda x,y: x*y.

Щодо коду, який ви не бажаєте розбирати, я рекомендую підхід на основі AST @csl вище.

Для всього іншого модуль перевірки правильний:

import inspect

import <module_to_inspect> as module

functions = inspect.getmembers(module, inspect.isfunction)

Це дає список 2-кортежів у формі [(<name:str>, <value:function>), ...].

Проста відповідь, наведена вище, натякається на різні відповіді та коментарі, але не викликається прямо.

Це зробить трюк:

dir(module) 

Однак якщо вам стає прикро читати повернений список, просто використовуйте наступний цикл, щоб отримати одне ім’я на рядок.

for i in dir(module): print i

dir(module) - це стандартний спосіб використання сценарію або стандартного інтерпретатора, про що йдеться у більшості відповідей.

Однак, використовуючи інтерактивну оболонку пітона, як IPython, ви можете скористатися вкладкою для огляду всіх об'єктів, визначених у модулі. Це набагато зручніше, ніж використовувати скрипт і printподивитися, що визначено в модулі.

• module.<tab> покаже всі об'єкти, визначені в модулі (функції, класи тощо)
• module.ClassX.<tab> покаже вам методи та атрибути класу
• module.function_xy?або module.ClassX.method_xy?покаже вам докстринг цієї функції / методу
• module.function_x??або module.SomeClass.method_xy??покаже вам вихідний код функції / методу.

Для глобальних функцій dir() - це команда для використання (як згадується в більшості цих відповідей), однак тут перераховані як загальнодоступні, так і непублічні функції разом.

Наприклад, працює:

>>> import re
>>> dir(re)

Повертає функції / класи типу:

'__all__', '_MAXCACHE', '_alphanum_bytes', '_alphanum_str', '_pattern_type', '_pickle', '_subx'

Деякі з них, як правило, не призначені для загального використання в програмуванні (але самим модулем, за винятком випадку, наприклад __doc__, DunderAliases , __file__ect). З цієї причини, можливо, не буде корисно перелічити їх із загальнодоступними (саме так Python знає, що отримати при використанніfrom module import * ).

__all__може бути використаний для вирішення цієї проблеми, він повертає список усіх публічних функцій та класів у модулі (тих, які не починаються з підкреслення - _). Див. Чи може хтось пояснити __all__ в Python? для використання __all__.

Ось приклад:

>>> import re
>>> re.__all__
['match', 'fullmatch', 'search', 'sub', 'subn', 'split', 'findall', 'finditer', 'compile', 'purge', 'template', 'escape', 'error', 'A', 'I', 'L', 'M', 'S', 'X', 'U', 'ASCII', 'IGNORECASE', 'LOCALE', 'MULTILINE', 'DOTALL', 'VERBOSE', 'UNICODE']
>>>

Усі функції та класи з підкресленнями видалено, залишивши лише ті, які визначені як загальнодоступні, і тому їх можна використовувати через import * .

Зауважте, що __all__не завжди визначено. Якщо він не включений, тодіAttributeError підвищується.

Випадок цього відбувається з модулем ast:

>>> import ast
>>> ast.__all__
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: module 'ast' has no attribute '__all__'
>>>

Жоден із цих відповідей не буде працювати, якщо ви не можете імпортувати згаданий файл Python без помилок імпорту. Так було для мене, коли я перевіряв файл, який походить з великої бази коду з великою кількістю залежностей. Далі буде оброблено файл у вигляді тексту та пошук усіх назв методів, які починаються з "def", та друкування їх та їх рядкових номерів.

import re
pattern = re.compile("def (.*)\(")
for i, line in enumerate(open('Example.py')):
  for match in re.finditer(pattern, line):
    print '%s: %s' % (i+1, match.groups()[0])

Крім dir (модуля) або довідки (модуля), згаданих у попередніх відповідях, ви також можете спробувати:
- Відкрити ipython
- імпортувати ім'я_модуля
- ввести ім'я_модуля, натиснути вкладку. Це відкриє невелике вікно із переліком усіх функцій модуля python.
Це виглядає дуже акуратно.

Тут представлений фрагмент переліку всіх функцій модуля хешлібу

(C:\Program Files\Anaconda2) C:\Users\lenovo>ipython
Python 2.7.12 |Anaconda 4.2.0 (64-bit)| (default, Jun 29 2016, 11:07:13) [MSC v.1500 64 bit (AMD64)]
Type "copyright", "credits" or "license" for more information.

IPython 5.1.0 -- An enhanced Interactive Python.
?         -> Introduction and overview of IPython's features.
%quickref -> Quick reference.
help      -> Python's own help system.
object?   -> Details about 'object', use 'object??' for extra details.

In [1]: import hashlib

In [2]: hashlib.
             hashlib.algorithms            hashlib.new                   hashlib.sha256
             hashlib.algorithms_available  hashlib.pbkdf2_hmac           hashlib.sha384
             hashlib.algorithms_guaranteed hashlib.sha1                  hashlib.sha512
             hashlib.md5                   hashlib.sha224

Це додасть до списку всі функції, визначені у вашому_модулі.

result=[]
for i in dir(your_module):
    if type(getattr(your_module, i)).__name__ == "function":
        result.append(getattr(your_module, i))

Ви можете скористатися наступним методом, щоб отримати список всіх функцій вашого модуля з оболонки:

import module

module.*?

import sys
from inspect import getmembers, isfunction
fcn_list = [o[0] for o in getmembers(sys.modules[__name__], isfunction)]

r = globals()
sep = '\n'+100*'*'+'\n' # To make it clean to read.
for k in list(r.keys()):
    try:
        if str(type(r[k])).count('function'):
            print(sep+k + ' : \n' + str(r[k].__doc__))
    except Exception as e:
        print(e)

Вихід:

******************************************************************************************
GetNumberOfWordsInTextFile : 

    Calcule et retourne le nombre de mots d'un fichier texte
    :param path_: le chemin du fichier à analyser
    :return: le nombre de mots du fichier

******************************************************************************************

    write_in : 

        Ecrit les donnees (2nd arg) dans un fichier txt (path en 1st arg) en mode a,
        :param path_: le path du fichier texte
        :param data_: la liste des données à écrire ou un bloc texte directement
        :return: None


 ******************************************************************************************
    write_in_as_w : 

            Ecrit les donnees (2nd arg) dans un fichier txt (path en 1st arg) en mode w,
            :param path_: le path du fichier texte
            :param data_: la liste des données à écrire ou un bloc texte directement
            :return: None