Python 基础之函数命名

几个问题

  • 使用描述性蛇形命名法(snake_case)
  • Python函数名应使用什么大小写格式?
  • 为什么函数名要具有描述性?
  • 方法的命名规范是什么?
  • 函数、变量和类的命名有何区别?

Python函数的命名有一些不可违背的硬性规则,还有一些虽不报错但影响代码Python风格的重要约定。恰当的命名能提升代码可读性、便于维护,还能减少错误。


使用描述性蛇形命名法(snake_case)

Python中,对象的标识符称为名称(names)。函数名通过def关键字定义。命名时可使用大小写字母、数字(不能开头)和下划线(_)。虽然Unicode字符也可用,但建议仅使用ASCII字符以保证通用性。

有效与无效名称示例

名称有效性说明
number有效
first_name有效
first name无效不能含空格
first_10_numbers有效
10_numbers无效不能以数字开头
_name有效
greeting!无效仅允许下划线作为标点
café有效但不推荐

根据PEP 8风格指南,函数名应使用小写字母+下划线分隔(蛇形命名法)。例如:calculate_total()优于total()


函数名应使用什么大小写格式?

不同编程语言偏好不同格式(如蛇形、驼峰)。Python函数推荐使用蛇形命名法(全小写+下划线分隔),例如:

find_winner()  
save()  

特殊前缀/后缀规则

  • 单前导下划线(如_internal()):表示内部使用,非强制私有。
  • 单后缀下划线(如import_()):避免与关键字冲突。
  • 双前导下划线(如__private()):触发名称改写(name mangling),用于类属性。

虽然蛇形命名是标准,但偶尔会见到驼峰式(如findWinner()),通常因历史遗留或跨语言习惯。除非维护旧代码库,否则应避免。


为什么函数名要具有描述性?

可读性是现代编程的核心原则。对比以下两段代码:

# 不清晰的命名  
def init(n):  return " ".join(f"{i[0]}." for i in n.split())  # 清晰的命名  
def get_initials(full_name):  return " ".join(f"{name[0]}." for name in full_name.split())  

后者通过函数名get_initials和参数名full_name直接表明用途,调用示例:

>>> get_initials("James Clerk Maxwell")  
"J. C. M."  

命名平衡

  • 避免过长(如find_number_of_vowels()可简化为find_num_vowels())。
  • 早期编程受限于硬件需简短命名,如今更强调可读性。

方法的命名规范是什么?

方法(类中的函数)命名规则与普通函数相同,但需注意:

  • 特殊方法(如__init__()):双下划线包裹,由Python调用。
  • 非公共方法:单前导下划线(如_verify_funds()),提示内部使用。

示例:银行账户类

class BankAccount:  def __init__(self, account_number, balance):  self.account_number = account_number  self.balance = balance  def _verify_funds(self, amount):  # 内部方法  return self.balance >= amount  def withdraw(self, amount):       # 公共接口  if self._verify_funds(amount):  self.balance -= amount  return True  return False  

函数、变量和类的命名有何区别?

  • 变量:蛇形命名(如selling_price),常量全大写(如TIME_LIMIT)。
  • :首字母大写的驼峰式(如BankAccount),但内置类型(如list)例外。
  • 异常类:驼峰式+后缀Error(如SyntaxError)。

1. 函数名应使用什么大小写格式?

  • 小写蛇形命名法(snake_case):单词全小写,用下划线连接
    例如:calculate_total(), get_user_data()
  • 为什么?:这是Python标准约定,与其他命名形式(如类名)形成明确区分。

2. 为什么函数名要具有描述性?

  • 提高可读性:描述性名称能直接表达函数的功能(如 validate_email()check() 更清晰)。
  • 减少注释依赖:好的函数名可以替代部分注释,让代码更自解释。
  • 便于维护:清晰的命名能帮助其他开发者(或未来的你)快速理解代码逻辑。

3. 方法的命名规范是什么?

  • 与函数相同:实例方法、类方法、静态方法均使用 小写蛇形命名法(snake_case)。
    例如:class User: def get_name(self): ...
  • 特殊情况
    • 魔术方法(双下划线包围):__init__, __str__
    • 私有方法(单下划线开头):_internal_logic()(仅约定,非强制私有)

4. 函数、变量和类的命名区别

类型命名规范示例
函数小写蛇形(snake_case)process_data()
方法小写蛇形(snake_case)user.get_id()
变量小写蛇形(snake_case)max_count = 100
大驼峰(PascalCase)class DatabaseClient:
常量大写蛇形(SCREAMING_SNAKE_CASE)MAX_SIZE = 1024
  • 关键区别
    • 类名用大驼峰,其他(函数/方法/变量)用小写蛇形。
    • 常量通过全大写显式标识。

附:PEP 8命名原则

  • 一致性:项目内保持命名风格统一。
  • 避免歧义:如不要用l(小写L)、O(大写o)等易混淆字符。
  • 描述性 > 简洁calculate_monthly_revenue() 优于 calc_mrev()

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

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

相关文章

redis 命令大全整理

http://doc.redisfans.com/ 原网址 Redis 命令分类 Key(键) Key(键)命令 exists/del/keys/type/scanobject/move/dump/migratettl/pttl/persist/expireat/pexpireat/expire/pexpirerename/renamenxsort/randomkey/restoreexists 语法:exists key [key ...] 检查一个或多…

React中useDeferredValue与useTransition终极对比。

文章目录 前言一、核心差异对比二、代码示例对比1. useDeferredValue:延迟搜索结果更新2. useTransition:延迟路由切换 三、应用场景总结四、注意事项五、原理剖析1. 核心机制对比2. 关键差异3. 代码实现原理 总结 前言 在React的并发模式下&#xff0c…

高并发内存池|定长内存池的设计

二、定长内存池的设计 设计一个定长的内存池,这个内存池的定长在于,当剩余空间使用完毕后,总是开辟相同长度的新空间来使用。我们会使用到一个指针来切割划分大空间为小空间。大空间是内存池向系统申请的内存大小,而小空间是程序…

微信小程序 自定义图片分享-绘制数据图片以及信息文字

一 、需求 从数据库中读取头像,姓名电话等信息,当分享给女朋友时,每个信息不一样 二、实现方案 1、先将数据库中需要的头像姓名信息读取出来加载到data 数据项中 data:{firstName:, // 姓名img:, // 头像shareImage:,// 存储临时图片 } 2…

从零开始理解Jetty:轻量级Java服务器的入门指南

目录 一、Jetty是什么?先看一个生活比喻 二、5分钟快速入门:搭建你的第一个Jetty服务 步骤1:Maven依赖配置 步骤2:编写简易Servlet(厨房厨师) 步骤3:组装服务器(餐厅开业准备&am…

深入浅出IIC协议 - 从总线原理到FPGA实战开发 -- 第一篇:I2C总线协议深度解剖

第一篇:I2C总线协议深度解剖 副标题 : 两根线如何征服千亿设备?详解硬件工程师必须掌握的通信奥义 1. 为什么I2C仍是嵌入式经典? 1.1 总线拓扑的哲学 拓扑对比图 SPI需4线N片选 vs I2C仅2线级联 UART点对点 vs I2C多主从架构 成本控制实…

MySQL 索引优化以及慢查询优化

在数据库性能优化中,索引优化和慢查询优化是两个关键环节。合理使用索引可以显著提高查询效率,而识别和优化慢查询则能提升整体数据库性能。本文将详细介绍MySQL索引优化和慢查询优化的方法和最佳实践。 一、MySQL 索引优化 1.1 索引的基本概念 索引是…

vue使用Pinia实现不同页面共享token

文章目录 一、概述二、使用步骤安装pinia在vue应用实例中使用pinia在src/stores/token.js中定义store在组件中使用store登录成功后,将token保存pinia中向后端API发起请求时,携带从pinia中获取的token 三、参考资料 一、概述 Pinia是Vue的专属状态管理库…

通俗版解释CPU、核心、进程、线程、协程的定义及关系

通俗版解释(比喻法) 1. CPU 和核心 CPU 一个工厂(负责干活的总部)。核心 工厂里的车间(比如工厂有4个车间,就能同时处理4个任务)。 2. 进程 进程 一家独立运营的公司(比如一家…

用 VS Code / PyCharm 编写你的第一个 Python 程序

用ChatGPT做软件测试 编写你的第一个 Python 程序——不只是“Hello, World”,而是构建认知、习惯与未来的起点 “第一行代码,是一个开发者认知世界的方式。” 编程的入门,不只是运行一个字符串输出,更是开始用计算机思维来理解、…

amd架构主机构建arm架构kkfileview

修改本机使用镜像仓库地址 vim /etc/docker/daemon.json {“experimental”: true, “registry-mirrors”: [ “https://docker.m.daocloud.io”, “https://docker.1panel.live”, “http://mirrors.ustc.edu.cn/”, “http://mirror.azure.cn/”, “https://docker.hpcloud.c…

[Linux] vim及gcc工具

目录 一、vim 1.vim的模式 2.vim的命令集 (1):命令模式 (2):底行模式 3.vim配置 二、gcc 1.gcc格式及选项 2.工作布置 三、自动化构建工具makefile 1.基本使用方法 2.配置文件解析 3.拓展 在linux操作系统的常用工具中,常用vim来进行程序的编写&#xff1b…

数据库3——视图及安全性

视图及安全性 学习内容学习感受 学习内容 一、实验目的与要求: 1、设计用户子模式 2、根据实际需要创建用户角色及用户,并授权 3、针对不同级别的用户定义不同的视图,以保证系统的安全性 二、实验内容: 1、 先创建四类用户角色&…

Oracle数据库如何进行冷备份和恢复

数据库的冷备份指的是数据库处于关闭或者MOUNT状态下的备份,备份文件包括数据文件、日志文件和控制文件。数据库冷备份所用的时间主要受数据库大小和磁盘I/O性能的影响。由于数据库需要关闭才能进行冷备份,所以这种备份技术并不适用724小时的系统。尽管冷…

SAP HCM 0008数据存储逻辑

0008信息类型:0008信息类型是存储员工基本薪酬的地方,因为很多企业都会都薪酬带宽,都会按岗定薪,所以在上线前为体现工资体系的标准化,都会在配置对应的薪酬关系,HCM叫间接评估,今天我们就分析下…

FPGA在光谱相机中的核心作用

FPGA(现场可编程门阵列)作为光谱相机的核心控制与加速单元,通过硬件级并行处理能力和动态可编程特性,实现高速、高精度的光谱数据采集与处理。以下是其具体作用分类: 一、高速光电信号处理 ‌实时光谱复原‌ 通过硬…

入门OpenTelemetry——部署OpenTelemetry

OpenTelemetry 部署模式 OpenTelemetry Collector 按部署方式分为 Agent 和Gateway 模式。 Agent 模式 在 Agent 模式下,OpenTelemetry 检测的应用程序将数据发送到与应用程序一起驻留的(收集器)代理。然后,该代理程序将接管并…

Windows 上安装下载并配置 Apache Maven

1. 下载 Maven 访问官网: 打开 Apache Maven 下载页面。 选择版本: 下载最新的 Binary zip archive(例如 apache-maven-3.9.9-bin.zip)。 注意:不要下载 -src 版本(那是源码包)。 2. 解压 Mave…

摩方 12 代 N200 迷你主机(Ubuntu 系统)WiFi 抓包环境配置教程

摩方12代N200迷你主机标配 Intel AX201无线网卡,支持 WiFi 6 协议(802.11ax)及蓝牙5.2。此网卡兼容主流抓包工具,但需注意: 驱动兼容性:Ubuntu 20.04及以上内核版本(5.4)默认支持AX2…

轻量、优雅、高扩展的事件驱动框架——Hibiscus-Signal

在现代企业级应用中,事件驱动架构(EDA)已成为解耦系统、提升扩展性的利器。今天给大家推荐一个非常优秀的国产轻量级事件驱动框架 —— Hibiscus Signal,它不仅天然整合 Spring Boot,还提供完整的事件生命周期支持&…