จะแสดงรายการฟังก์ชั่นทั้งหมดในโมดูล Python ได้อย่างไร

ฉันมีโมดูลหลามติดตั้งในระบบของฉันและฉันต้องการที่จะเห็นว่าฟังก์ชั่น / ชั้นเรียน / วิธีการที่มีอยู่ในมัน

ฉันต้องการเรียกใช้ฟังก์ชั่น doc กับแต่ละอัน ในทับทิมฉันสามารถทำสิ่งต่าง ๆ เช่น ClassName.methods เพื่อรับรายการของวิธีการทั้งหมดที่มีในชั้นเรียนนั้น มีอะไรที่คล้ายกันในหลาม?

เช่น. สิ่งที่ต้องการ:

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)

... เพื่อแสดงรายการชื่อของฟังก์ชั่นและตัวแปรทั้งหมดที่กำหนดไว้ในโมดูล

ตัวอย่างที่มีการตรวจสอบ:

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 ส่งคืนรายการของ tuples (object_name, object_type)

คุณสามารถแทนที่ isfunction ด้วยฟังก์ชั่น 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ความเสี่ยงในการใช้รหัส astray นำไปสู่ข้อขัดข้องช่วยให้ข้อความถูกพิมพ์ออกมากล่องโต้ตอบ GUI ปรากฏขึ้นและต่อ ๆ ไป

แต่ฉันใช้โมดูล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-tuples ในแบบฟอร์ม [(<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?จะแสดง docstring ของฟังก์ชั่น / วิธีการนั้น
• module.function_x??หรือmodule.SomeClass.method_xy??จะแสดงซอร์สโค้ดของฟังก์ชัน / เมธอด

สำหรับฟังก์ชั่นระดับโลก dir()เป็นคำสั่งที่จะใช้ (ดังที่กล่าวไว้ในคำตอบส่วนใหญ่เหล่านี้) อย่างไรก็ตามรายการนี้ทั้งฟังก์ชั่นสาธารณะและฟังก์ชั่นที่ไม่ใช่แบบสาธารณะด้วยกัน

ตัวอย่างการรัน:

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

ส่งคืนฟังก์ชัน / คลาสที่ชอบ:

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

บางอันไม่ได้มีไว้สำหรับการเขียนโปรแกรมทั่วไป (แต่โดยตัวโมดูลเองยกเว้นในกรณีของ DunderAliases เช่น__doc__, __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
- นำเข้า module_name
- ประเภท module_name, แท็บกด มันจะเปิดหน้าต่างเล็ก ๆ ที่มีรายการฟังก์ชั่นทั้งหมดในโมดูลหลาม
มันดูเรียบร้อยมาก

นี่คือรายการตัวอย่างฟังก์ชั่นทั้งหมดของโมดูล hashlib

(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

สิ่งนี้จะผนวกฟังก์ชั่นทั้งหมดที่กำหนดไว้ใน your_module ในรายการ

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