两个法宝函数-dir()和help()

两个法宝函数

dir() 函数

dir() 函数用于返回对象（如变量、函数、模块、类等）的所有属性和方法的列表，帮助你快速了解一个对象能做什么。

基本用法

1. 不带参数：返回当前作用域中定义的所有名称（变量、函数、导入的模块等）。

   import torch
   x = 10
   print(dir())  # 输出当前作用域中的名称，包括 'torch'、'x' 等
   

2. 带参数（对象 / 模块）：返回该对象的所有属性和方法。

   import torch
   # 查看 torch 模块的所有属性和方法
   print(dir(torch))  
   # 查看一个张量对象的属性和方法
   tensor = torch.tensor([1, 2, 3])
   print(dir(tensor))  # 输出 tensor 的方法，如 'add'、'mean'、'shape' 等
   

特点

• 返回结果是一个字符串列表，包含对象的属性名、方法名（不含参数）。
• 对于模块，会列出模块中定义的函数、类、变量等。
• 对于类实例，会列出实例的属性、类的方法以及继承的方法。
• 特殊方法（如 __init__、__add__）也会被包含，通常以双下划线 __ 开头和结尾。

help() 函数

help() 函数用于获取对象的详细帮助信息（文档字符串，即 docstring），包括功能说明、参数解释、使用示例等，比 dir() 更深入。

基本用法

1. 不带参数：进入交互式帮助模式，可输入对象名查看详细信息（按 q 退出）。

   help()  # 进入交互模式，输入 'torch' 或 'list' 查看帮助
   

2. 带参数（对象 / 模块 / 函数）：直接打印该对象的帮助文档

   import torch
   # 查看 torch 模块的帮助文档
   help(torch)  
   # 查看 torch.tensor 函数的帮助文档
   help(torch.tensor)  
   # 查看列表的 append 方法的帮助
   help(list.append)
   

特点

• 输出内容包括对象的功能描述、参数列表、返回值、示例（如果文档字符串中包含）。
• 对于函数，会显示参数的类型、默认值及说明。
• 对于模块，会列出模块的功能概述、包含的子模块和主要函数。