ai agent(智能体)开发 python基础2 包名、类名、变量名 方法名 命名规则

我们以 User 为例，展示 Python 中不同类别的命名规范：

---

1. 包（Package）

• 规则：全小写，短且无下划线（除非必须）。
• 示例：

  # 正确
  users            # 包名（存放用户相关模块）
  user_models      # 允许下划线，但尽量简短（若需明确语义）
  
  # 错误
  UserPackage      # 大写开头
  user-package     # 含连字符
  

---

2. 模块（Module）

• 规则：全小写，可用下划线分隔。
• 示例：

  # 正确
  user.py          # 模块名（用户基础功能）
  user_utils.py    # 用户工具模块
  
  # 错误
  UserModule.py    # 大写开头
  

---

3. 类（Class）

• 规则：驼峰式（首字母大写，无下划线）。
• 示例：

  class User:                  # 用户基类
      pass
  
  class UserManager:           # 用户管理类
      pass
  
  class HTTPUserClient:        # 含缩写的类名（HTTP全大写）
      pass
  
  # 错误
  class user_profile:          # 小写下划线
  

---

4. 函数（Function）与方法（Method）

• 规则：全小写，下划线分隔；私有方法以 _ 开头。
• 示例：

  def create_user(username):   # 函数：创建用户
      pass
  
  def get_user_info(user_id):  # 函数：获取用户信息
      pass
  
  class UserService:
      def _validate_user(self):  # 私有方法
          pass
  
  # 错误
  def GetUser():               # 驼峰式
  

---

5. 变量

• 规则：全小写，下划线分隔；保护/私有变量用 _ 或 __。
• 示例：

  user_name = "Alice"          # 普通变量
  current_user = load_user()   # 变量：当前用户
  
  class User:
      def __init__(self):
          self._protected_data = {}   # 保护变量（约定勿直接访问）
          self.__private_data = []     # 私有变量（触发 Name Mangling）
  
  # 错误
  UserName = "Bob"             # 大写开头
  

---

6. 常量

• 规则：全大写，下划线分隔。
• 示例：

  MAX_USER_COUNT = 1000        # 最大用户数
  DEFAULT_USER_ROLE = "guest"  # 默认用户角色
  
  # 错误
  maxUserCount = 1000          # 混合大小写
  

---

7. 其他示例

• 避免关键字冲突：

  # 错误
  class = "admin"          # 使用关键字
  def user(id): pass       # 参数名覆盖内置函数 `id()`
  
  # 正确
  user_class = "admin"     # 调整命名
  def get_user(uid): pass  # 参数名明确
  

• 特殊方法：

  class User:
      def __str__(self):   # 双下划线包裹的特殊方法
          return "User Object"
  

---

总结表格

类别	规范	User 示例
包	全小写，无下划线	users
模块	全小写，可加下划线	user.py, user_auth.py
类	驼峰式	User, UserProfile
函数/方法	小写+下划线	create_user()
变量	小写+下划线	user_id, current_user
常量	全大写+下划线	MAX_USER_AGE
保护成员	_ 开头	_user_session
私有成员	__ 开头	__password_hash

---

通过具体示例可以更直观地理解命名规范，确保代码风格统一且易读！