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 会屏蔽标准库,引发不可预知行为。

Chromox
Chromox

Chromox是一款领先的AI在线生成平台,专为喜欢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"
<h1>version.py —— 清晰、可导入、可测试、无歧义</h1>

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

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

457

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

547

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

335

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

pip安装使用方法
pip安装使用方法

安装步骤:1、确保Python已经正确安装在您的计算机上;2、下载“get-pip.py”脚本;3、按下Win + R键,然后输入cmd并按下Enter键来打开命令行窗口;4、在命令行窗口中,使用cd命令切换到“get-pip.py”所在的目录;5、执行安装命令;6、验证安装结果即可。大家可以访问本专题下的文章,了解pip安装使用方法的更多内容。

373

2023.10.09

更新pip版本
更新pip版本

更新pip版本方法有使用pip自身更新、使用操作系统自带的包管理工具、使用python包管理工具、手动安装最新版本。想了解更多相关的内容,请阅读专题下面的文章。

436

2024.12.20

pip设置清华源
pip设置清华源

设置方法:1、打开终端或命令提示符窗口;2、运行“touch ~/.pip/pip.conf”命令创建一个名为pip的配置文件;3、打开pip.conf文件,然后添加“[global];index-url = https://pypi.tuna.tsinghua.edu.cn/simple”内容,这将把pip的镜像源设置为清华大学的镜像源;4、保存并关闭文件即可。

803

2024.12.23

python升级pip
python升级pip

本专题整合了python升级pip相关教程,阅读下面的文章了解更多详细内容。

371

2025.07.23

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

37

2026.03.12

热门下载

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

精品课程

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

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 4.9万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

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

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