如何查看Python模块中的方法？

在Python开发中，了解模块中包含的方法是高效编程的基础，无论是使用标准库、第三方库还是自定义模块，快速掌握其提供的功能接口能显著提升开发效率，以下将系统介绍多种查看Python模块方法的实用技巧，涵盖基础命令、工具辅助及代码实现等不同维度。

使用内置函数dir()快速查看方法列表

dir()是Python中最直接、最常用的模块方法查询工具，它以列表形式返回对象（包括模块）的所有属性和方法名，包括内置方法（以双下划线__开头和结尾）和公共方法。

基本用法：

import math
print(dir(math))

输出结果类似：

['__doc__', '__loader__', '__name__', '__package__', '__spec__', 'acos', 'acosh', 'asin', 'asinh', 'atan', 'atan2', 'atanh', 'ceil', 'comb', 'copysign', 'cos', 'cosh', 'degrees', 'dist', 'e', 'erf', 'erfc', 'exp', 'expm1', 'fabs', 'factorial', 'floor', 'fmod', 'frexp', 'fsum', 'gamma', 'gcd', 'hypot', 'inf', 'isclose', 'isfinite', 'isinf', 'isnan', 'isqrt', 'lcm', 'ldexp', 'lgamma', 'log', 'log10', 'log1p', 'log2', 'modf', 'nan', 'nextafter', 'perm', 'pi', 'pow', 'prod', 'radians', 'remainder', 'sin', 'sinh', 'sqrt', 'tan', 'tanh', 'tau', 'trunc', 'ulp']

注意事项：

• dir()返回的结果包含模块的所有属性，如常量（math.pi）、函数（math.sqrt）等，需通过命名规则区分（通常方法名为小写字母或下划线组合）。
• 若仅需公共方法（非内置方法），可通过列表推导式过滤：

  print([method for method in dir(math) if not method.startswith('__')])

通过help()获取方法的详细文档

dir()仅提供方法名，而help()能展示方法的完整文档字符串（docstring），包括功能描述、参数说明、返回值及示例，是理解方法用法的核心工具。

基本用法：

import math
help(math.sqrt)

输出结果类似：

sqrt(x, /)
    Return the square root of x.

查看模块整体文档：
直接对模块使用help()会进入交互式帮助界面，显示模块所有方法的详细说明：

help(math)

输入q可退出交互界面。

优点：

• 信息权威，直接读取模块内置文档。
• 适合深入学习不熟悉的方法。

利用__all__变量查看模块的公共API

许多模块会定义__all__变量，明确指定对外暴露的公共接口（即from module import 时导入的内容），通过__all__可快速筛选模块的核心方法，避免被内部方法干扰。

示例：

import random
print(random.__all__)

输出结果类似：

['Random', 'seed', 'random', 'uniform', 'randint', 'choice', 'sample', 'randrange', 'shuffle', 'normalvariate', 'lognormvariate', 'expovariate', 'vonmisesvariate', 'gammavariate', 'gauss', 'betavariate', 'paretovariate', 'weibullvariate', 'getstate', 'setstate', 'getrandbits', 'choices', 'SystemRandom']

注意事项：

• 并非所有模块都会定义__all__（如math模块未定义），此时该方法不适用。
• __all__仅包含开发者希望暴露的公共方法，可能遗漏部分可用功能。

结合inspect模块动态分析方法结构

inspect模块是Python的动态 introspection 工具，能提供更精细的方法信息，如方法类型（函数、类）、参数列表、源码路径等，适合需要深度分析模块结构的场景。

常用功能：

1. 获取模块中所有函数：

   import inspect
   import math
   functions = inspect.getmembers(math, inspect.isfunction)
   print(functions)

   输出为元组列表，每个元组包含函数名和函数对象，如：

   [('acos', <built-in function acos>), ('acosh', <built-in function acosh>), ...]

2. 查看方法的参数签名：

   import inspect
   sig = inspect.signature(math.sqrt)
   print(sig)  # 输出: (x, /)

   其中表示x为位置参数，不能通过关键字传参。

3. 获取方法的源码路径：

   print(inspect.getfile(math.sqrt))  # 输出: /usr/lib/python3.8/lib-dynload/math.cpython-38-x86_64-linux-gnu.so

   适合追踪模块的物理位置（对纯Python模块更有效，内置模块可能返回.so文件路径）。

   

借助IDE和编辑器的自动补全功能

现代开发工具（如PyCharm、VS Code、Jupyter Notebook）均提供强大的代码自动补全功能，输入模块名和后，会自动弹出方法列表，并显示方法的简要说明（来自docstring）。

VS Code示例：

1. 安装Python扩展后，输入import math并回车。
2. 输入math.后，自动弹出方法列表，选中方法（如sqrt）后，按Tab键自动补全，悬停在方法上可查看参数提示。

优点：

• 实时交互，无需手动执行命令。
• 结合代码上下文，提示更精准。

通过官方文档或第三方资源查询

对于标准库和主流第三方库（如NumPy、Pandas），官方文档是最权威的信息来源，通常包含方法详解、示例代码及注意事项。

示例：

• Python标准库文档：https://docs.python.org/3/library/
• 第三方库文档（如Pandas）：https://pandas.pydata.org/docs/

搜索技巧：
在搜索引擎中输入python 模块名 方法名（如python math sqrt），通常能直接定位到官方文档或高质量教程。

方法对比与适用场景归纳

为便于选择合适的查询方式，下表归纳了各方法的特点及适用场景：

相关问答FAQs

Q1：如果模块很大，方法很多，如何快速定位某个特定功能的方法？
A：可通过以下组合策略高效定位：

1. 关键词过滤：使用dir()获取所有方法名后，通过字符串匹配筛选，例如查找与“随机”相关的方法：

   import random
   random_methods = [method for method in dir(random) if 'random' in method.lower()]
   print(random_methods)  # 输出: ['random', 'SystemRandom']

2. IDE搜索功能：在PyCharm或VS Code中，按Ctrl+F（或Cmd+F）在模块文件中搜索关键词（如“random”），快速定位相关方法。
3. 官方文档索引：访问模块官方文档，使用页面内的搜索框（通常支持关键词高亮），直接跳转到相关方法说明。

Q2：为什么有些方法用dir()能看到，但调用时提示AttributeError？
A：这种情况通常由以下原因导致：

1. 方法需实例化后调用：若模块包含类，类的方法需通过实例调用，而非直接通过模块名调用。

   import datetime
   print(dir(datetime))  # 包含类名'datetime'
   datetime.now()  # 报错：AttributeError: 'module' object has no attribute 'now'
   # 正确方式：先实例化类或通过类调用
   datetime.datetime.now()  # 正确

2. 动态导入或条件定义：部分方法可能根据环境（如操作系统、Python版本）动态导入或定义，dir()显示的是所有可能的方法，但当前环境可能未加载，某些库在Windows和Linux上提供的方法不同。
3. 命名冲突或覆盖：若代码中重新定义了模块中的方法名，会导致原始方法被覆盖,此时需检查是否有同名变量或函数。