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

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

引言

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

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

本文将带你了解:

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

公共接口与命名规则

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

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

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

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

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

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

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

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

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

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

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

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

请注意,这些命名规则中仅有两条会触发 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,并防止破坏用户的代码。

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

相关文章
|
6月前
|
算法 Python
请解释Python中的关联规则挖掘以及如何使用Sklearn库实现它。
使用Python的mlxtend库,可以通过Apriori算法进行关联规则挖掘。首先导入TransactionEncoder和apriori等模块,然后准备数据集(如购买行为列表)。对数据集编码并转换后,应用Apriori算法找到频繁项集(设置最小支持度)。最后,生成关联规则并计算置信度(设定最小置信度阈值)。通过调整这些参数可以优化结果。
152 9
|
2月前
|
存储 索引 Python
Python小技巧:单下划线 ‘_‘
Python小技巧:单下划线 ‘_‘
|
3月前
|
数据可视化 算法 前端开发
基于python flask+pyecharts实现的中药数据可视化大屏,实现基于Apriori算法的药品功效关系的关联规则
本文介绍了一个基于Python Flask和Pyecharts实现的中药数据可视化大屏,该系统应用Apriori算法挖掘中药药材与功效之间的关联规则,为中医药学研究提供了数据支持和可视化分析工具。
122 2
|
3月前
|
存储 IDE 开发工具
Python中变量命名规则
【8月更文挑战第5天】
79 4
|
3月前
|
存储 Python
python变量命名规则
【8月更文挑战第4天】
68 5
|
4月前
|
程序员 Python
python中那些双下划线开头得函数和变量
python中那些双下划线开头得函数和变量
47 2
|
4月前
|
数据采集 机器学习/深度学习 算法
Python基于Apriori关联规则算法实现商品零售购物篮分析
Python基于Apriori关联规则算法实现商品零售购物篮分析
187 0
|
4月前
|
API 开发工具 git
`black`是一个不受约束的Python代码格式化工具。它自动将Python代码格式化为PEP 8样式,但具有一些额外的规则,旨在使代码更加一致和易读。
`black`是一个不受约束的Python代码格式化工具。它自动将Python代码格式化为PEP 8样式,但具有一些额外的规则,旨在使代码更加一致和易读。
|
5月前
|
Java 程序员 索引
我们一起学Python之——认识Python"规则"
我们一起学Python之——认识Python"规则"
|
6月前
|
存储 机器学习/深度学习 数据可视化
基于Python的数据分组技术:将数据按照1, 2, 3规则分为三个列表
基于Python的数据分组技术:将数据按照1, 2, 3规则分为三个列表
55 1