模块本地与对外导出的变量、函数是否存在对应的命名约定?
模块内变量/函数命名通用约定
不同编程语言社区有接近的命名规则区分内部/公开成员,以下是通用性最高的约定,以应用最广的Python社区PEP8规范为例:
对外导出的公开成员(供外部模块调用)
- 普通函数、普通变量:统一使用蛇形命名法(全小写+下划线分隔单词),示例中的
do_something()就符合该规范 - 固定不变的公开常量:使用全大写+下划线分隔,例如
MAX_REQUEST_SIZE = 1024 * 1024 - 如需明确限定导出范围,可以在模块顶部声明
__all__列表,仅将需要公开的成员名称加入列表即可,例如:__all__ = ["do_something", "MAX_REQUEST_SIZE"]
仅模块内部使用的私有成员
- 通用规则为在名称前加单下划线前缀,作为内部成员的标识,Python默认
from 模块名 import *导入时不会加载带单下划线前缀的成员 - 内部常量可以搭配全大写使用,你示例中的本地调试变量标准写法为
_DEBUG = True,既和公开常量做区分,也能直观识别是常量属性 - 内部普通函数/变量示例:
_local_temp_cache = {}、_calculate_inner_params()
内容的提问来源于stack exchange,提问作者Kal
相关产品推荐
相关产品推荐

