Python中的单下划线和双下划线使用规则

2024-09-07 17:44
文章标签 python 使用 规则 下划线

本文主要是介绍Python中的单下划线和双下划线使用规则,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

alt

引言

Python 遵循一些关键的命名规则,这些规则涉及到使用单个或双下划线。通过这些规则,你可以在应用程序接口(API)中区分可访问的和不可访问的标识符,编写适用于继承的稳健类,以及防止命名冲突等。

遵守这些规则,你的代码将显得更贴近 Python 的风格,并且在其他 Python 程序员看来更加统一。这项技能在你为其他开发者编写代码时尤为重要。

本文[1]将带你了解:

  • 基于使用下划线 (_) 的 Python 命名规则
  • 通过单个下划线标识符来区分可公开访问和不可公开访问的名称
  • 使用双下划线来利用 Python 类中的名称混淆特性
  • 探索 Python 中下划线的其他常见用途 为了从本教程中获得最大收益,你应该对 Python 的变量、常量、函数、模块有所了解,尤其是对类和面向对象编程有深入理解。

公共接口与命名规则

作为一名 Python 开发者,你经常需要与公共接口,也就是应用程序编程接口(API)打交道。API 是一种提供给程序内部或外部程序使用的服务接口。

比如,Python 的标准库中包含了许多提供服务的模块和包。要使用这些模块和包,你需要访问它们的公共部分,比如类、函数、变量、常量和模块。这些元素构成了模块或包的公共接口,你可以直接在你的代码中使用它们。

但是,许多包和模块定义了一些不打算被直接访问的对象,这些对象仅供它们自己内部使用,不属于公共接口。

在面向对象编程中,C++ 和 Java 等语言区分了公共和私有的方法与属性。在这些语言中,你可以这样使用类成员:

  • 公共:你可以在自己的代码或其他代码中使用它们。
  • 私有:你只能在定义它们的类或其子类中使用它们。

这些语言通过特定的关键字和语法来定义类中的公共和私有成员。一旦成员被声明为私有,它就不能在类外部被访问,因为语言限制了这种访问。因此,私有成员不属于类的公共接口,你无法访问它们。

与此不同,Python 并没有公共和私有成员的概念,也没有专门的关键字或语法来定义它们。因此,你可以访问 Python 类中的所有成员。

如果 Python 没有特定的语法来定义一个对象是否属于公共接口,那么如何告知用户他们是否可以在自己的代码中使用某个类、方法、函数、变量、常量或模块呢?

为了解决这个问题,Python 社区建立了一套公认的命名规则。你应该遵循这些规则,明确告诉其他开发者是否应该在他们的代码中直接使用你的变量、常量、函数、方法和模块。

请注意,这些命名规则并不限制对对象的访问,它们只是对使用你代码的其他开发者的一种提示。因此,Python 不使用“公共”和“私有”这样的术语,而是使用“公共”和“非公共”。

在 Python 中,如果一个名称以大小写字母开头,你应该认为它是公共的,属于代码的 API 部分。而如果一个名称以下划线 (_) 开头,你应该认为它是非公共的,不包含在代码的 API 中。

Python 社区还使用下划线字符 (_) 来遵循其他一些命名规则。PEP 8 对如何在命名中使用这个字符有如下说明:

alt

请注意,这些命名规则中仅有两条会触发 Python 的特定行为。当你在类中使用双下划线前缀时,会触发名称混淆机制。在关于名称混淆的章节中,你将更深入地了解这一行为。

此外,那些在 Python 数据模型中列出的、带有双下划线前后缀的名称,在特定情境下会触发内部行为。在 Python 中关于特殊方法名的章节中,你将更深入地了解这一主题。

注意:Python 特别对待单个下划线,但这种特殊待遇仅出现在 match … case 语句中。稍后你将对这一点有更深的理解。

单个前导下划线

正如你所知,Python 并没有专门的关键字和语法来定义对象的公共或私有属性。因此,Python 将对象定义为公共或非公共,并且不对它们的访问进行限制。

创建 Python 中的公共和非公共名称 公共名称构成了你代码的公共接口或 API。这些名称是用户用来访问你代码中不同功能和特性的。这些名称应该是具有描述性的、易于理解的,并且随着时间推移保持一致性:

>>> public = "This is a public name."
>>> public
'This is a public name.'

这里的“稳定”指的是,一旦某个名称被纳入了你代码的公共接口,它就应该长期保持不变。如果变更了这些名称,可能会导致用户的代码无法正常运行,尤其是在你更新了 API 之后。

在构建代码的公共接口时,你需要慎重选择哪些名称应该公开。并不是所有代码中的对象都需要公开。如果你将不应该由客户端代码使用的某个对象设置为公共名称,那么你就冒着被误用的风险。

相反,非公共名称用于支持代码的内部功能。这些名称属于代码的内部实现细节,而不是 API 的一部分。因此,用户不应该在他们的代码中使用这些非公共名称,因为随着时间的推移,这些名称可能会更改,或者在未来版本的代码中可能不再存在。

以下是一个非公共名称的示例:

>>> _non_public = "This is a non-public name."
>>> _non_public
'This is a non-public name.'

Python 开发者习惯用单个下划线前缀来标示对象为内部使用,而非公开暴露。

通常,只有当你想表明某个变量、类、方法、函数或模块仅供其所在的模块、类或包内部使用时,才使用单个下划线前缀。这只是一种约定俗成的命名习惯,并非 Python 强制的硬性规定。你总是能够访问到这些非公开的名称,除非它们被定义在无法访问的作用域内。

遵守这种命名习惯是编写和阅读 Python 代码时应该考虑的一个良好做法。

一般而言,那些在代码演进过程中可能会被修改的对象应该保持为非公开状态。所以,当你犹豫不决时,就给你的对象起个非公开的名称。如果你之后决定将某个原本非公开的对象纳入代码的 API,那么可以去掉这个下划线前缀。这种做法有助于你稳定 API,并防止破坏用户的代码。

如果你是在使用他人的代码,那么在对象名称中看到单个下划线前缀,就应该意识到这是一个避免在你自己代码中直接使用该对象的信号。

Reference
[1]

Source: https://realpython.com/python-double-underscore/

本文由 mdnice 多平台发布

这篇关于Python中的单下划线和双下划线使用规则的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1145723

相关文章

springboot security快速使用示例详解

《springbootsecurity快速使用示例详解》:本文主要介绍springbootsecurity快速使用示例,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝... 目录创www.chinasem.cn建spring boot项目生成脚手架配置依赖接口示例代码项目结构启用s

Python如何使用__slots__实现节省内存和性能优化

《Python如何使用__slots__实现节省内存和性能优化》你有想过,一个小小的__slots__能让你的Python类内存消耗直接减半吗,没错,今天咱们要聊的就是这个让人眼前一亮的技巧,感兴趣的... 目录背景:内存吃得满满的类__slots__:你的内存管理小助手举个大概的例子:看看效果如何?1.

Python+PyQt5实现多屏幕协同播放功能

《Python+PyQt5实现多屏幕协同播放功能》在现代会议展示、数字广告、展览展示等场景中,多屏幕协同播放已成为刚需,下面我们就来看看如何利用Python和PyQt5开发一套功能强大的跨屏播控系统吧... 目录一、项目概述:突破传统播放限制二、核心技术解析2.1 多屏管理机制2.2 播放引擎设计2.3 专

Python中随机休眠技术原理与应用详解

《Python中随机休眠技术原理与应用详解》在编程中,让程序暂停执行特定时间是常见需求,当需要引入不确定性时,随机休眠就成为关键技巧,下面我们就来看看Python中随机休眠技术的具体实现与应用吧... 目录引言一、实现原理与基础方法1.1 核心函数解析1.2 基础实现模板1.3 整数版实现二、典型应用场景2

Python实现无痛修改第三方库源码的方法详解

《Python实现无痛修改第三方库源码的方法详解》很多时候,我们下载的第三方库是不会有需求不满足的情况,但也有极少的情况,第三方库没有兼顾到需求,本文将介绍几个修改源码的操作,大家可以根据需求进行选择... 目录需求不符合模拟示例 1. 修改源文件2. 继承修改3. 猴子补丁4. 追踪局部变量需求不符合很

java中使用POI生成Excel并导出过程

《java中使用POI生成Excel并导出过程》:本文主要介绍java中使用POI生成Excel并导出过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录需求说明及实现方式需求完成通用代码版本1版本2结果展示type参数为atype参数为b总结注:本文章中代码均为

Spring Boot3虚拟线程的使用步骤详解

《SpringBoot3虚拟线程的使用步骤详解》虚拟线程是Java19中引入的一个新特性,旨在通过简化线程管理来提升应用程序的并发性能,:本文主要介绍SpringBoot3虚拟线程的使用步骤,... 目录问题根源分析解决方案验证验证实验实验1:未启用keep-alive实验2:启用keep-alive扩展建

python+opencv处理颜色之将目标颜色转换实例代码

《python+opencv处理颜色之将目标颜色转换实例代码》OpenCV是一个的跨平台计算机视觉库,可以运行在Linux、Windows和MacOS操作系统上,:本文主要介绍python+ope... 目录下面是代码+ 效果 + 解释转HSV: 关于颜色总是要转HSV的掩膜再标注总结 目标:将红色的部分滤

Python 中的异步与同步深度解析(实践记录)

《Python中的异步与同步深度解析(实践记录)》在Python编程世界里,异步和同步的概念是理解程序执行流程和性能优化的关键,这篇文章将带你深入了解它们的差异,以及阻塞和非阻塞的特性,同时通过实际... 目录python中的异步与同步:深度解析与实践异步与同步的定义异步同步阻塞与非阻塞的概念阻塞非阻塞同步

Python Dash框架在数据可视化仪表板中的应用与实践记录

《PythonDash框架在数据可视化仪表板中的应用与实践记录》Python的PlotlyDash库提供了一种简便且强大的方式来构建和展示互动式数据仪表板,本篇文章将深入探讨如何使用Dash设计一... 目录python Dash框架在数据可视化仪表板中的应用与实践1. 什么是Plotly Dash?1.1