Python模块如何编写与使用
时间:2026-03-27 08:45:30 447浏览 收藏
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(): ... # 下划线开头,约定为私有all = ['PI', 'MAX_RETRY', 'helper_func'] # 只有这些会被 from mylib import * 加载
这样别人执行 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提供简洁入口
all = ["run", "validate", "User", "Post", "format_date", "retry"]
使用者只需 import myproject 或 from myproject import User, run,无需关心内部模块结构——这正是大型库(如 requests、numpy)常用的“门面模式”。
4. 类型定义集中管理(配合 type hints)
在 types.py 中定义常用类型别名或 TypedDict:
# types.py from typing import TypedDict, List, Optionalclass UserInfo(TypedDict): name: str age: int tags: List[str]
UserID = str Timestamp = float
然后在业务模块中复用:from types import UserInfo, UserID。既提升可读性,也利于 mypy 检查。
Python 不需要头文件,但通过合理组织模块、善用 __all__、__init__.py 和专用常量/类型模块,完全可以实现更安全、更易维护、IDE 更友好的“接口声明”效果。
今天关于《Python模块如何编写与使用》的内容介绍就到此结束,如果有什么疑问或者建议,可以在golang学习网公众号下多多回复交流;文中若有不正之处,也希望回复留言以告知!
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
496 收藏
-
219 收藏
-
210 收藏
-
268 收藏
-
330 收藏
-
文章 · python教程 | 5天前 | 并发 · python · 故障排查 · asyncio · 任务取消 · Python asyncio.create_task Python 任务取消 asyncio CancelledError Python 异步任务收尾490 收藏
-
196 收藏
-
495 收藏
-
文章 · python教程 | 1星期前 | 时间处理 · python · zoneinfo · 后端开发 · UTC · Python DateTime UTC 夏令时 zoneinfo fold469 收藏
-
文章 · python教程 | 1星期前 | 字符串 · 标准库 · 模板 · python · Python 3.14 · Template Python 3.14 t-string string.templatelib PEP 750121 收藏
-
343 收藏
-
文章 · python教程 | 1星期前 | 并发编程 · python · 多线程 · asyncio · 多进程 · queue.Queue Python并发 Python任务队列 asyncio.Queue multiprocessing.Queue165 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习