Python 函数命名的具体示例

news/2026/1/19 15:53:41/文章来源:https://www.cnblogs.com/aaammm/p/19502111

一、基础通用函数(最常用场景)

核心规则:全小写 + 下划线(snake_case) + 见名知意,名称要直接体现函数的“动作+对象”。

函数用途 错误命名(反面示例) 正确命名(正面示例) 代码示例
计算列表平均值 avg(lst)f1(l) calculate_list_average() ```python
def calculate_list_average(num_list):
"""计算数字列表的平均值"""
if not num_list:return 0
return sum(num_list) / len(num_list)
| 验证手机号格式          | `checkphone(p)`、`v(p)`    | `validate_phone_number()`  | ```python
def validate_phone_number(phone):"""验证手机号是否符合11位数字格式"""return len(phone) == 11 and phone.isdigit()
``` |
| 读取文本文件            | `readfile(f)`、`rf(path)`  | `read_text_file()`         | ```python
def read_text_file(file_path, encoding="utf-8"):"""读取文本文件内容并返回字符串"""with open(file_path, "r", encoding=encoding) as f:return f.read()
``` |
| 生成随机验证码          | `create_code(n)`、`gc()`   | `generate_verify_code()`   | ```python
import random
import stringdef generate_verify_code(length=6):"""生成指定长度的数字+字母随机验证码"""chars = string.digits + string.ascii_lettersreturn "".join(random.choice(chars) for _ in range(length))
``` |### 二、业务场景函数(贴近实际开发)
命名要结合业务逻辑,让非技术人员也能快速理解函数用途,避免抽象化。```python
# 学生管理系统相关函数
def get_student_info_by_id(student_id):"""根据学生ID查询学生信息"""# 模拟数据库查询逻辑students = {"001": {"name": "张三", "age": 20}, "002": {"name": "李四", "age": 19}}return students.get(student_id, None)def update_student_score(student_id, subject, new_score):"""更新指定学生的某科目成绩"""# 模拟更新逻辑print(f"更新学生{student_id}的{subject}成绩为{new_score}")return True# 电商订单相关函数
def calculate_order_total_price(order_items):"""计算订单商品总价(含单价*数量)"""total = 0for item in order_items:total += item["price"] * item["quantity"]return totaldef cancel_order_by_order_id(order_id, reason="用户主动取消"):"""根据订单ID取消订单,并记录取消原因"""print(f"订单{order_id}已取消,原因:{reason}")return True

三、私有函数(仅内部使用)

核心规则:单下划线开头 + 蛇形命名,提示外部代码不要直接调用。

# 工具类示例:私有函数用于内部辅助逻辑
class FileHandler:def __init__(self, file_path):self.file_path = file_path# 私有函数:清理文件中的空行(仅内部调用)def _remove_blank_lines(self, content):"""【内部函数】清理文本内容中的空行"""lines = [line.strip() for line in content.split("\n") if line.strip()]return "\n".join(lines)# 公开函数:读取并格式化文件内容def read_and_format_file(self):"""读取文件并清理空行后返回"""content = self.read_text_file(self.file_path)return self._remove_blank_lines(content)# 复用之前的基础函数(作为类方法)def read_text_file(self, file_path, encoding="utf-8"):with open(file_path, "r", encoding=encoding) as f:return f.read()

四、特殊场景:简短但清晰的函数名

如果函数逻辑极简单、上下文明确,可适当简化命名(但仍要避免无意义字符):

# 场景:简单的数值处理(上下文明确时)
def add(a, b):"""两数相加(简单逻辑可简化命名)"""return a + bdef is_empty(obj):"""判断对象是否为空(如列表、字符串)"""return not obj# ❌ 反面示例:即使简单也不能用无意义命名
def f(a, b):  # 无法判断是相加/相减/相乘return a + b

五、绝对要避免的命名坑

  1. 使用关键字/保留字def def(): pass(报错)、def class(): pass(报错);
  2. 大小写混用(非类名)def CalculateListAverage(): pass(违反snake_case);
  3. 用中文/特殊字符def 计算平均值(): pass(虽能运行,但不符合规范)、def cal-avg(): pass(含减号,直接报错);
  4. 过度缩写def clc_avg(): pass(clc=calculate,缩写不直观)。

总结

  1. Python函数命名核心是snake_case(小写+下划线),私有函数加单下划线开头;
  2. 命名要体现“动作+对象”,做到见名知意,避免无意义字符/过度缩写;
  3. 业务函数结合场景命名,让代码可读性最大化,新手优先参考“基础通用函数”的命名范式。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/1183766.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

小程序计算机毕设之基于微信小程序的考研学习系统开发与实现基于springboot+微信小程序的考研复习辅助平台(完整前后端代码+说明文档+LW,调试定制等)

博主介绍:✌️码农一枚 ,专注于大学生项目实战开发、讲解和毕业🚢文撰写修改等。全栈领域优质创作者,博客之星、掘金/华为云/阿里云/InfoQ等平台优质作者、专注于Java、小程序技术领域和毕业项目实战 ✌️技术范围:&am…

Chrome浏览器+Postman做接口测试

🍅 点击文末小卡片,免费获取软件测试全套资料,资料在手,涨薪更快如果把测试简单分为两类,那么就是客户端测试和服务端测试。客户端的测试包括UI测试,兼容性测试等,服务端测试包括接口测试。接口…

网安人必备!开源网络安全工具TOP 10从零基础入门到精通,收藏这一篇就够了!

网安人必备!开源网络安全工具TOP 10 一套精良的开源工具箱,是安全工程师对抗数字威胁的底气所在。 01 Nmap 核心定位 网络侦察与漏洞测绘的基石工具,被全球渗透测试团队称为“网络地图绘制仪”。 核心功能 • 隐蔽扫描技术:nm…

xstore 设置属性》

设置为可变商品 设置固定价格 regular prices

哪个品牌的斑马鱼养殖设备质量好,耐用性强 - 品牌推荐大师1

斑马鱼作为模式生物在生命科学、药物研发等领域的应用持续深化,推动养殖设备需求快速增长。据贝哲斯咨询《2025-2030年全球斑马鱼养殖系统市场研究报告》数据显示,2025年全球该设备市场规模已达12.8亿美元,年复合增…

【网络安全】Tomcat CVE-2020-1938 漏洞复现和利用过程_漏洞复现

一,漏洞描述 1-1 漏洞原理 Apache Tomcat文件包含漏洞(CNVD-2020-10487/CVE-2020-1938)。该漏洞是由于Tomcat AJP协议存在缺陷而导致,攻击者利用该漏洞可通过构造特定参数,读取服务器webapp下的任意文件。若目标服务器…

2026年阻燃晴氯纶纱定做厂家权威推荐榜单:阻燃晴天丝纱/阻燃晴氯纶26支/阻燃晴棉纱/竹纤维纱/天竹纤维纱源头厂家精选

阻燃晴氯纶纱作为一种兼具腈纶舒适性、氯纶阻燃性的特种纱线,在专业工装、防护服装、特种装饰及产业用布等领域的需求持续增长。随着全球工业安全标准的提升,市场对高性能、定制化阻燃纱线的要求也日趋严格。为了帮助…

Python标识符命名规范

一、必须遵守的语法规则(违反会直接报错) 标识符是用来给变量、函数、类、模块等命名的字符序列,必须符合以下硬性要求:字符组成:只能由字母(A-Z/a-z)、数字(0-9)、下划线(_) 组成,且不能以数字开头。 ✅ …

BEATOZ区块链专业企业与韩国头部旅游集团MODETOUR从签署MOU迈向网络验证节点合作

BEATOZ区块链专业企业与韩国头部旅游集团MODETOUR从签署MOU迈向网络验证节点合作——作为BEATOZ区块链,Web3.0开放平台的核心合作伙伴,发挥连接旅游、金融与技术的桥梁作用。BEATOZ区块链开发企业于19日宣布,韩国代表性综合旅游集团 MODETOUR…

MinerU如何验证提取质量?评估指标与人工校验结合

MinerU如何验证提取质量?评估指标与人工校验结合 1. 引言:复杂文档提取的挑战与MinerU的定位 在当前AI驱动的内容处理场景中,PDF文档作为信息传递的主要载体之一,其结构复杂性(如多栏排版、嵌套表格、数学公式、图文…

2026年权威仪器设备校准/仪器外校/仪器校检/教学仪器校准/实验室通用仪器校准厂家实力推荐榜:CNAS认可实验室服务,专业第三方校准机构精选

面对市场上众多的校准服务供应商,如何选择一家真正可靠、技术过硬且服务规范的第三方校准机构,已成为工业制造、科学研究与教育教学等领域共同关注的核心问题。本文旨在通过客观分析与对比,为您在复杂的市场环境中提…

提升识别准确率的小技巧,万物识别实战经验分享

提升识别准确率的小技巧,万物识别实战经验分享 1. 引言:中文通用图像识别的现实挑战 在当前人工智能技术快速落地的背景下,图像识别已广泛应用于内容审核、智能安防、电商自动化和辅助决策等场景。然而,大多数开源视觉模型依赖英…

2026企业智能升级指南:从Deepseek知识库部署服务商到本地BI私有化方案商全解析 - 品牌2026

在数字化转型加速的2026年,越来越多的企业意识到,传统BI(商业智能)工具已难以满足复杂业务场景下的实时分析、多系统协同与数据安全需求。尤其对于金融、医疗、能源、零售等对数据敏感度高、合规要求严的行业,企业…

Vivado下载失败怎么办?网络与防火墙问题实战案例

Vivado下载失败?别急,先看这篇网络排障实战指南你是不是也遇到过这种情况:项目刚启动,急需安装Vivado进行FPGA开发,结果点击“Download”后进度条卡在10%、30%,甚至直接弹出“Network Error”或“SSL Hands…

2026年福建蚊香液跨境外贸公司推荐:蚊香外贸 /出口电蚊香 /电蚊香跨境出口/ 出口蚊香 /蚊香片跨境出口服务公司精选

在全球驱蚊产品市场中,跨境出口需求持续攀升,消费者对安全、高效、环保的驱蚊产品关注度日益提升。在此背景下,福建小神童日化用品有限公司凭借其多元化产品矩阵和全球化布局,成为行业备受瞩目的企业之一。公司深耕…

HY-MT1.5-7B部署进阶:如何实现高可用翻译服务

HY-MT1.5-7B部署进阶:如何实现高可用翻译服务 随着多语言交流需求的不断增长,高质量、低延迟的翻译服务已成为智能应用的核心能力之一。特别是在全球化业务拓展、跨语言内容生成和实时通信场景中,翻译模型的服务稳定性与响应效率直接影响用户…

救命神器!专科生毕业论文TOP9 AI论文平台测评

救命神器!专科生毕业论文TOP9 AI论文平台测评 专科生毕业论文写作的“救星”:2026年度AI平台测评揭秘 随着高校教育的不断深化,专科生在毕业论文写作过程中面临的挑战日益增多。从选题困难到资料查找,从结构搭建到格式规范&#x…

2026 年主数据管理哪家好?主流公司与优质系统精选推荐 - 品牌2026

数字化转型进入深水区,主数据作为企业核心资产,其标准化、一致性管理已成为打破数据孤岛、驱动智能决策的关键。据IDC调研,超70%中国大型企业已启动主数据治理项目,2026年主数据管理正从“可选配置”升级为“必选底…

Fun-ASR-MLT-Nano-2512语音取证:司法场景应用指南

Fun-ASR-MLT-Nano-2512语音取证:司法场景应用指南 1. 引言 1.1 业务背景与技术需求 在司法实践中,语音证据的采集与分析已成为案件侦办的重要环节。无论是审讯录音、电话监听,还是公共区域的音频记录,如何高效、准确地将语音内…

长治市襄垣平顺黎城壶关英语雅思培训辅导机构推荐,2026权威出国雅思课程中心学校口碑排行榜 - 苏木2025

在全球化留学趋势下,雅思考试已成为长治市襄垣、平顺、黎城、壶关四地学子通往海外名校的关键门槛,但本地雅思培训市场乱象丛生,考生普遍面临诸多困境:优质教育资源稀缺、选课迷茫难以甄别靠谱机构、提分技巧掌握不…