Python的help()与dir()函数详解：探索代码的秘密武器

文章目录

**1. 引言**

**2. help() 函数**

**2.1 作用**

**2.2 使用方法**

**2.3 示例**

**(1) 查看内置函数的帮助**

**(2) 查看模块的帮助**

**(3) 查看自定义类的帮助**

**2.4 流程图**

**3. dir() 函数**

**3.1 作用**

**3.2 使用方法**

**3.3 示例**

**(1) 查看列表的所有方法**

**(2) 查看模块的属性和函数**

**(3) 查看自定义对象**

**3.4 过滤不需要的属性**

**3.5 流程图**

**4. help() 和 dir() 的区别**

**5. 总结**

**6. 参考**

1. 引言

在 Python 编程过程中，我们经常需要查看某个对象（如模块、类、函数等）的属性和方法，或者获取详细的帮助文档。Python 提供了两个内置函数 help() 和 dir()，它们可以帮助我们快速了解代码结构，提高开发效率。本文将详细介绍这两个函数的作用、使用方法、区别，并结合代码示例和流程图进行讲解。

---

2. help() 函数

2.1 作用

help() 函数用于获取 Python 对象的详细帮助文档，包括函数、模块、类等的说明、参数、返回值、示例等。它依赖于对象的 __doc__ 属性（即文档字符串）。

2.2 使用方法

help(object)

object 可以是模块、类、函数、方法等。

2.3 示例

(1) 查看内置函数的帮助

help(len)  # 查看 len() 函数的文档

输出：

Help on built-in function len in module builtins:

len(obj, /)
    Return the number of items in a container.

(2) 查看模块的帮助

import math
help(math)  # 查看 math 模块的文档

输出：

Help on module math:

NAME
    math

DESCRIPTION
    This module provides access to the mathematical functions
    defined by the C standard.

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

(3) 查看自定义类的帮助

class MyClass:
    """这是一个示例类"""
    def __init__(self):
        self.x = 10
    
    def foo(self):
        """这是一个示例方法"""
        return self.x

help(MyClass)  # 查看类的文档

输出：

Help on class MyClass in module __main__:

class MyClass(builtins.object)
 |  这是一个示例类
 |
 |  Methods defined here:
 |
 |  __init__(self)
 |      Initialize self.  See help(type(self)) for accurate signature.
 |
 |  foo(self)
 |      这是一个示例方法
 |
 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |  
 |  __dict__
 |      dictionary for instance variables (if defined)
 |  
 |  __weakref__
 |      list of weak references to the object (if defined)

2.4 流程图

graph TD
    A[调用 help(object)] --> B{对象是否有 __doc__ 属性?}
    B -->|是| C[返回格式化帮助文档]
    B -->|否| D[返回基本对象信息]

---

3. dir() 函数

3.1 作用

dir() 函数返回对象的所有属性和方法列表（包括内置方法），适用于模块、类、实例等。

3.2 使用方法

dir([object])

如果不传参数，返回当前作用域的变量和函数名。

如果传入对象，返回该对象的属性和方法。

3.3 示例

(1) 查看列表的所有方法

dir([])  # 查看列表的方法

输出：

['__add__', '__class__', '__contains__', 'append', 'clear', 'copy', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']

(2) 查看模块的属性和函数

import os
dir(os)  # 查看 os 模块的内容

输出：

['DirEntry', 'F_OK', 'O_APPEND', ..., 'path', 'pipe', 'popen', 'read', 'remove', ...]

(3) 查看自定义对象

class Dog:
    def __init__(self, name):
        self.name = name
    
    def bark(self):
        return "Woof!"

d = Dog("Buddy")
dir(d)  # 查看实例的属性和方法

输出：

['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', 'bark', 'name']

3.4 过滤不需要的属性

由于 dir() 返回的内容可能包含大量内置方法（如 __init__），我们可以用列表推导过滤：

# 只获取用户自定义的属性和方法
print([attr for attr in dir(d) if not attr.startswith('__')])

输出：

['bark', 'name']

3.5 流程图

graph TD
    A[调用 dir(object)] --> B{是否传入参数?}
    B -->|是| C[返回对象的属性和方法列表]
    B -->|否| D[返回当前作用域的变量和函数名]

---

4. help() 和 dir() 的区别

函数	返回内容	适用场景
help()	详细文档（依赖 __doc__）	学习如何使用某个功能
dir()	属性和方法的名称列表	探索对象结构，调试代码

典型工作流：

1. 先用 dir() 查看对象有哪些方法。
2. 再用 help() 查看某个方法的具体用法。

dir(str)          # 查看字符串的所有方法
help(str.split)   # 查看 split() 的详细用法

---

5. 总结

help()：获取详细文档，适合学习 API。

dir()：列出对象的所有属性和方法，适合探索代码结构。

两者结合使用，可以高效地理解和调试 Python 代码。

适用场景：

交互式环境（如 Python Shell、IPython、Jupyter Notebook）。

调试代码，快速查看对象的可用方法。

阅读第三方库，理解其功能。

---

6. 参考

Python 官方文档 – help()

Python 官方文档 – dir()

---

作者：北辰alk