0

0

Python_func_Python模块与函数命名规范说明

幻夢星雲

幻夢星雲

发布时间:2026-01-09 15:33:24

|

727人浏览过

|

来源于php中文网

原创

Python函数名必须用小写字母加下划线(snake_case),模块名须全小写、无特殊字符且不与内置名冲突,避免双下划线非init文件。

python_func_python模块与函数命名规范说明

Python 函数名必须用小写字母加下划线

Python 官方 PEP 8 明确要求函数名使用 snake_case,即全小写、单词间用单个下划线连接。这不是风格偏好,而是影响可读性和工具兼容性的硬性约定。

常见错误包括:getUserName(驼峰)、GET_USER_NAME(大写常量风格)、get_user__name(双下划线)、get-user-name(短横线,语法错误)。

  • def calculate_total_price() ✅ 合理
  • def CalculateTotalPrice() ❌ 类名风格,易与 class 混淆
  • def _internal_helper() ✅ 单下划线前缀表示“受保护”,非公开
  • def __private_method() ⚠️ 双下划线触发 name mangling,仅限真正私有逻辑

模块名要简短、全小写、无特殊字符

模块文件名即导入名,直接影响 import 语句和 IDE 补全。它必须是合法的 Python 标识符,且不能含点号、中划线或空格——否则会直接报错 ImportError: invalid syntaxModuleNotFoundError

典型问题场景:把 my-api-client.py 当模块导入,结果写 import my-api-client 导致语法错误;或用 2024_utils.py 开头数字导致无法导入。

立即学习Python免费学习笔记(深入)”;

  • ✅ 正确命名:requests_cache.pyimport requests_cache
  • ✅ 正确命名:db_helpers.pyfrom db_helpers import connect
  • ❌ 错误命名:data-v2.py(含短横线,文件可存但无法 import)
  • ❌ 错误命名:1main.py(开头数字,标识符非法)

避免与内置函数或标准库模块重名

覆盖内置名(如 liststropen)会导致后续调用异常,且 IDE 往往不报错,排查困难。同理,自定义模块命名为 json.pyos.py 会屏蔽标准库,引发不可预知行为。

TemPolor
TemPolor

AI音乐生成器,一键创作免版税音乐

下载

例如:在项目根目录建了 json.py,再执行 import json,实际导入的是你本地那个空文件,而非标准库 json 模块,接着调用 json.loads(...) 就会抛 AttributeError

  • ⚠️ 高危重名:str.pydict.pytime.pymath.py
  • ✅ 安全替代:str_utils.pydict_tools.pytime_helpers.py
  • 检查是否冲突:运行 python -c "import json; print(json.__file__)" 看路径是否指向标准库

包内模块名不要用 __init__.py 以外的双下划线文件

Python 包机制依赖 __init__.py 触发识别,但其他以双下划线开头的模块(如 __main__.py__version__.py)虽语法合法,却容易被误认为特殊文件而被某些打包工具(如 setuptools)忽略,或在 pip install -e . 时未正确包含。

更隐蔽的问题是:IDE 和静态分析工具(如 mypy)可能跳过这些文件的类型检查,导致 bug 潜伏。

  • ✅ 推荐方式:version.py 存版本字符串,__init__.pyfrom .version import __version__
  • ✅ 推荐方式:cli.py 放命令行入口,通过 if __name__ == "__main__": 控制执行
  • ❌ 不推荐:__cli__.py__utils__.py —— 无实际收益,徒增混淆
def get_version() -> str:
    return "1.2.3"

version.py —— 清晰、可导入、可测试、无歧义

模块和函数命名看着简单,真正卡住人的往往是那些“能跑但不对”的边界情况:比如名字合法却遮蔽了内置函数,或者文件名合法却让 import 走错了路径。留心这些细节比记住规则更重要。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

741

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

634

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

756

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

617

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1259

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

577

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

705

2023.08.11

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

3

2026.01.09

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.9万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号