讲师中心 微信公众号
AI工具推荐 视频效率加速

Python 模块级函数命名最佳实践

夏强大大_1472

夏强大大_1472

发布时间:2026-06-05 17:45:01

|

1054人浏览过

|

来源于php中文网

原创

Python 模块级函数命名最佳实践

本文总结 python 中模块级函数的命名规范,重点对比“带模块上下文”与“无模块上下文”两种命名策略,结合 pep 8 建议、可读性、可维护性及实际工程场景,给出清晰、可落地的命名指导。

本文总结 python 中模块级函数的命名规范,重点对比“带模块上下文”与“无模块上下文”两种命名策略,结合 pep 8 建议、可读性、可维护性及实际工程场景,给出清晰、可落地的命名指导。

在 Python 项目中,当多个模块(如 boat.py 和 car.py)提供语义相似的功能(如获取、创建、删除数据库对象)时,如何为模块级函数命名,直接影响代码的可读性、可维护性与协作效率。PEP 8 — Python 官方编码风格指南 — 虽未直接规定“函数是否应包含领域前缀”,但其核心原则——显式优于隐式、简单优于复杂、可读性至关重要——为决策提供了坚实依据。

✅ 推荐方案:模块名作为天然命名空间(import boat, car)

采用 import boat, import car 方式,并定义简洁动词型函数名(如 boat.get(), car.delete()),是更符合 Python 惯例的选择:

# boat.py
def get(id):
    return _fetch_from_db("boat", id)

def delete(id):
    return _delete_from_db("boat", id)

# car.py
def get(id):
    return _fetch_from_db("car", id)

def delete(id):
    return _delete_from_db("car", id)
# main.py
import boat
import car

boat.get(123)   # 清晰表明操作对象类型与来源
car.delete(456) # 无歧义,无需重复语义

✅ 优势:

  • 显式且自解释:调用点即体现领域上下文(boat.get 不可能被误认为操作用户或订单);
  • 避免命名冗余:get_boat 在 from boat import get_boat 场景下反而弱化了模块归属,且违反“函数名应描述行为而非主体”的直觉(get 本身已隐含“获取某物”,主体由模块承载);
  • 兼容大规模扩展:新增 plane.py 时,仅需 import plane,无需重命名所有函数;
  • 与标准库一致:如 json.loads()、pathlib.Path()、datetime.datetime.now() 均依赖模块/类作为逻辑命名空间,而非将类型嵌入函数名。

⚠️ 谨慎使用:前缀式命名(get_boat, delete_car)

该方式通常出现在 from module import * 或扁平化导入场景中:

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

python-flask-vue-creator
python-flask-vue-creator

创建 Flask + Vue.js 全栈项目,采用单端口架构、uv 依赖管理、结构化日志和生产级前端设计。当用户要求以下操作时触发:创建新的 Flask+Vue 项目、搭建 Web 应用、构建全栈 Python+Vue 应用、初始化 Flask Web 项目、设置单端口 Flask 前后端项目。触发词:新建项目、创建项目、搭建项目、Flask项目、Vue项目。

下载
# 不推荐:破坏模块边界,易引发冲突
from boat import get_boat, delete_boat
from car import get_car, delete_car

get_boat(123)  # 函数名变长,语义重心偏移(强调“boat”而非“get”)

⚠️ 风险:

  • 当模块功能增多(如 get_boat_by_owner, get_boat_by_status),前缀重复加剧,违背 DRY 原则;
  • 一旦需统一抽象(例如增加通用 get_by_type(type_name, id)),前缀成为重构障碍;
  • 违反 PEP 8 关于“imports should usually be on separate lines”和“avoid wildcard imports”的隐含精神——过度扁平化会削弱模块封装价值。

? 工程建议:平衡清晰性与便利性

  • 默认采用模块导入:import boat, import car,函数命名聚焦动作(get, create, update, delete);

  • 必要时使用别名提升可读性:

    import boat as boat_api
    import car as car_api
    
    boat_api.get(123)  # 显式标注用途,适合大型项目或 API 层
  • 共享逻辑请提取抽象层:若 boat 与 car 的 CRUD 行为高度一致,应优先考虑基类、协议(Protocol)或工具函数,而非复制函数命名模式:

    # common/db.py
    def get_by_model(model_name: str, id: int):
        return _fetch_from_db(model_name, id)
    
    # boat.py
    def get(id): return db.get_by_model("boat", id)

✅ 总结

模块是 Python 最自然、最受支持的命名空间。让模块名承载领域信息,让函数名专注表达行为——这是最 Pythonic、最可持续的模块级函数命名方式。 避免将类型名硬编码进函数标识符,除非有强约束(如必须单模块内多类型共存且无法拆分)。始终以 PEP 8 的“可读性”和“显式性”为标尺,而非短期导入便利。

热门AI工具

更多
创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

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

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

1871

2023.07.20

python能做什么
python能做什么

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

5084

2023.07.25

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

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

1809

2023.07.31

python教程
python教程

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

30577

2023.08.03

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

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

3627

2023.08.04

python eval
python eval

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

3647

2023.08.04

scratch和python区别
scratch和python区别

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

1243

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

616

2023.08.10

Docker Desktop怎么设置端口映射
Docker Desktop怎么设置端口映射

本专题聚焦Docker Desktop容器端口映射与访问配置,整理从创建容器、设置端口绑定到验证本地服务访问的操作流程。针对端口被占用、映射配置错误、容器服务无法访问等情况,也提供相应的检查方向,方便用户完成端口配置。

0

2026.11.03

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn