Python模块如何编写与使用

Python虽无C/C++式的头文件，但可通过__all__控制模块公开接口、创建独立常量/配置模块、利用__init__.py聚合包级API、以及集中管理类型定义这四种实用方式，高效模拟“头文件”的核心价值——统一声明、清晰导出、集中维护和增强类型安全，让代码更健壮、可读性更强、协作更顺畅。

Python 没有传统意义上的“头文件”（如 C/C++ 中的 .h 文件），它不通过头文件声明函数、类或变量。但你可能想实现类似目的：比如统一管理常量、配置、类型定义、公共工具函数，或为模块提供清晰的公共接口。下面几种常见做法，能帮你达到“头文件”的效果：

1. 用 __all__ 控制模块公开接口

这是最接近“头文件声明作用”的方式——明确告诉使用者哪些名称是该模块推荐导出的。

在 mylib.py 中：

# mylib.py
PI = 3.14159
MAX_RETRY = 3
def helper_func(): ...
def _internal_helper(): ...  # 下划线开头，约定为私有
<p><strong>all</strong> = ['PI', 'MAX_RETRY', 'helper_func']  # 只有这些会被 from mylib import * 加载
</p>

这样别人执行 from mylib import * 时，不会意外导入 _internal_helper；IDE 和静态检查工具（如 mypy）也能据此推断公共 API。

2. 创建纯配置/常量模块（类似 C 的 constants.h）

新建一个 constants.py 或 config.py，只放不可变定义：

# constants.py
ENV = "production"
DB_TIMEOUT = 30
STATUS_OK = 0
STATUS_ERROR = 1
SUPPORTED_FORMATS = ("json", "xml", "yaml")

其他模块直接导入使用：from constants import DB_TIMEOUT, STATUS_OK。语义清晰，便于集中维护和类型提示。

3. 使用 __init__.py 聚合子模块接口（包级“头文件”）

对于较复杂的包（如 myproject/），可在其 __init__.py 中整理并导出关键内容：

# myproject/__init__.py
from .core import run, validate
from .models import User, Post
from .utils import format_date, retry
<h1>提供简洁入口</h1><p><strong>all</strong> = ["run", "validate", "User", "Post", "format_date", "retry"]
</p>

使用者只需 import myproject 或 from myproject import User, run，无需关心内部模块结构——这正是大型库（如 requests、numpy）常用的“门面模式”。

4. 类型定义集中管理（配合 type hints）

在 types.py 中定义常用类型别名或 TypedDict：

# types.py
from typing import TypedDict, List, Optional
<p>class UserInfo(TypedDict):
name: str
age: int
tags: List[str]</p><p>UserID = str
Timestamp = float
</p>

然后在业务模块中复用：from types import UserInfo, UserID。既提升可读性，也利于 mypy 检查。

Python 不需要头文件，但通过合理组织模块、善用 __all__、__init__.py 和专用常量/类型模块，完全可以实现更安全、更易维护、IDE 更友好的“接口声明”效果。

今天关于《Python模块如何编写与使用》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！