Python中的下划线详解

2023-05-16

原文地址:https://dbader.org/blog/meaning-of-underscores-in-python

作者:Dan Bader

译者:首席IT民工


本文介绍了Python中单下划线和双下划线("dunder")的各种含义和命名约定,名称修饰(name mangling)的工作原理,以及它如何影响你自己的Python类。


单下划线和双下划线在Python变量和方法名称中都各有其含义。有一些含义仅仅是依照约定,视作是对程序员的提示 - 而有一些含义是由Python解释器严格实现。


如果你想知道“Python变量和方法名称中单下划线和双下划线的含义是什么?”,我会尽我所能在这里为你解答。


在本文中,我将讨论以下五种下划线规范和命名约定以及它们如何影响Python程序的行为:


  • 单前导下划线:_var

  • 单末尾下划线:var_

  • 双前导下划线:__var

  • 双前导和末尾下划线:__var__

  • 单下划线:_


在文章结尾处,你可以找到一个简短的“速查表”,总结了五种不同的下划线命名约定及其含义,以及一个简短的视频教程,可让你亲身体验它们的行为。


让我们马上开始!


1. 单前导下划线 _var

当涉及到变量和方法名称时,单个下划线前缀只有约定本身的含义。 这是对程序员的一个提示 - 意味着Python社区一致认为它应该是什么意思,但程序的行为不受影响。


下划线前缀的含义是向其他程序员表示:以单个下划线开头的变量或方法仅供内部使用。 该约定在PEP 8中有定义。


这不是Python强制规定的。 Python不像Java那样在“私有”和“公共”变量之间有很强的区别。 这就像有人提出了一个小小的下划线警告标志,说:

“嘿,这不是真的要成为类的公共接口的一部分。不去管它就好。“

看看下面的例子:

image.png


如果你实例化此类并尝试访问在__init__构造函数中定义的foo和_bar属性,会发生什么情况? 让我们来看看:

image.png


你会看到_bar中的单个下划线并没有阻止我们“进入”类并访问该变量的值。


这是因为Python中的单个下划线前缀仅仅是一个约定 - 至少在涉及变量和方法名的时候。


但是,前导下划线的确会影响从模块中导入名称的方式。 


假设你在一个名为my_module的模块中有以下代码:

image.png


现在,如果使用通配符导入从模块中导入所有名称,则Python不会导入带有前导下划线的名称(除非模块定义了覆盖此行为的__all__列表):

image.png


顺便说一下,应该避免通配符导入,因为它们使名称空间中存在哪些名称不清楚。 为了清楚起见,坚持常规导入更好。


与通配符导入不同,常规导入不受前导单个下划线命名约定的影响:

image.png


我知道这一点可能有点令人困惑。 如果您坚持PEP 8推荐,避免通配符导入,那么您真正需要记住的只有这个:

单个下划线是一个Python命名约定,表示这个名称是供内部使用的。 它通常不由Python解释器强制执行,仅仅作为对程序员的提示。

2. 单末尾下划线 var_

有时候,一个变量的最合适的名称已经被一个关键字所采用。 因此像class或def这样的名称不能用作Python中的变量名称。 在这种情况下,您可以附加一个下划线来解决命名冲突:

image.png


总之,单个末尾下划线(后缀)是一个约定,用来避免与Python关键字产生命名冲突。 PEP 8解释了这个约定。

3. 双前导下划线 __var

到目前为止,我们所涉及的所有命名模式的含义,来自于已达成共识的约定。 而对于以双下划线开头的Python类的属性(包括变量和方法),情况就有点不同了。


双下划线前缀会导致Python解释器重写属性名称,以避免子类中的命名冲突。


这也叫做名称修饰(name mangling) - 解释器更改变量的名称,以便在类被扩展的时候不容易产生冲突。


我知道这听起来很抽象。 因此,我拼凑了一个小小的代码示例来予以说明:

image.png


让我们用内置的dir()函数来看看这个对象的属性:

2018-04-13_204255.png


这给了我们一个包含对象属性的列表。 让我们来看看这个列表,并寻找我们的原始变量名称foo,_bar和__baz - 我保证你会注意到一些有趣的变化。

  • self.foo变量在属性列表中显示为未修改为foo。

  • self._bar的行为方式相同 - 它以_bar的形式显示在类上。 就像我之前说过的,在这种情况下,前导下划线仅仅是一个约定。 给程序员一个提示而已。

  • 然而,对于self.__baz而言,情况看起来有点不同。 当你在该列表中搜索__baz时,你会看不到有这个名字的变量。


是__baz出了什么情况吗?


如果你仔细观察,你会看到此对象上有一个名为_Test__baz的属性。 这就是Python解释器所做的名称修饰。 它这样做是为了防止变量在子类中被重写。


让我们创建另一个扩展Test类的类,并尝试重写构造函数中添加的现有属性:

image.png


现在,你认为foo,_bar和__baz的值会出现在这个ExtendedTest类的实例上吗? 我们来看一看:

image.png


等一下,当我们尝试查看t2 .__ baz的值时,为什么我们会得到AttributeError? 名称修饰被再次触发了! 事实证明,这个对象甚至没有__baz属性:

2018-04-13_204151.png


正如你可以看到__baz变成_ExtendedTest__baz以防止意外修改:

image.png


但原来的_Test__baz还在:

image.png


双下划线名称修饰对程序员是完全透明的。 看看下面的例子来证实这一点:

2018-04-13_204036.png


名称修饰是否也适用于方法名称? 是的,也适用。名称修饰会影响在一个类的上下文中,以两个下划线字符("dunders")开头的所有名称:

2018-04-13_204442.png


这是另一个也许令人惊讶的运用名称修饰的例子:

image.png


在这个例子中,我声明了一个名为_MangledGlobal__mangled的全局变量。然后我在名为MangledGlobal的类的上下文中访问变量。由于名称修饰,我能够在类的test()方法内,以__mangled来引用_MangledGlobal__mangled全局变量。

Python解释器自动将名称__mangled扩展为_MangledGlobal__mangled,因为它以两个下划线字符开头。这表明名称修饰不是专门与类属性关联的。它适用于在类上下文中使用的两个下划线字符开头的任何名称。

有很多要吸收的内容吧。

老实说,这些例子和解释不是从我脑子里蹦出来的。我作了一些研究和加工才弄出来。我一直使用Python,有很多年了,但是像这样的规则和特殊情况并不总是浮现在脑海里。

有时候程序员最重要的技能是“模式识别”,而且知道在哪里查阅信息。如果您在这一点上感到有点不知所措,请不要担心。慢慢来,试试这篇文章中的一些例子。

让这些概念完全沉浸下来,以便你能够理解名称修饰的总体思路,以及我向您展示的一些其他的行为。如果有一天你和它们不期而遇,你会知道在文档中按什么来查。

4. 双前导和双末尾下划线 _var_

也许令人惊讶的是,如果一个名字同时以双下划线开始和结束,则不会应用名称修饰。 由双下划线前缀和后缀包围的变量不会被Python解释器修改:

image.png


但是,Python保留了有双前导和双末尾下划线的名称,用于特殊用途。 这样的例子有,__init__对象构造函数,或__call__ --- 它使得一个对象可以被调用。


这些dunder方法通常被称为神奇方法 - 但Python社区中的许多人(包括我自己)都不喜欢这种方法。


最好避免在自己的程序中使用以双下划线(“dunders”)开头和结尾的名称,以避免与将来Python语言的变化产生冲突。


单下划线 _

按照习惯,有时候单个独立下划线是用作一个名字,来表示某个变量是临时的或无关紧要的。


例如,在下面的循环中,我们不需要访问正在运行的索引,我们可以使用“_”来表示它只是一个临时值:


image.png


你也可以在拆分(unpacking)表达式中将单个下划线用作“不关心的”变量,以忽略特定的值。 同样,这个含义只是“依照约定”,并不会在Python解释器中触发特殊的行为。 单个下划线仅仅是一个有效的变量名称,会有这个用途而已。


在下面的代码示例中,我将汽车元组拆分为单独的变量,但我只对颜色和里程值感兴趣。 但是,为了使拆分表达式成功运行,我需要将包含在元组中的所有值分配给变量。 在这种情况下,“_”作为占位符变量可以派上用场:


image.png


除了用作临时变量之外,“_”是大多数Python REPL中的一个特殊变量,它表示由解释器评估的最近一个表达式的结果。


这样就很方便了,比如你可以在一个解释器会话中访问先前计算的结果,或者,你是在动态构建多个对象并与它们交互,无需事先给这些对象分配名字:


image.png

Python下划线命名模式 - 小结

以下是一个简短的小结或“速查表”,罗列了我在本文中谈到的五种Python下划线模式的含义:


模式举例含义
单前导下划线_var命名约定,仅供内部使用。 通常不会由Python解释器强制执行(通配符导入除外),只作为对程序员的提示。
单末尾下划线var_按约定使用以避免与Python关键字的命名冲突。
双前导下划线__var当在类上下文中使用时,触发”名称修饰“。 由Python解释器强制执行。
双前导和双末尾下划线__var__表示Python语言定义的特殊方法。 避免在你自己的属性中使用这种命名方案。
单下划线_有时用作临时或无意义变量的名称(“不关心”)。 也表示Python REPL中最近一个表达式的结果。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Python中的下划线详解 的相关文章

随机推荐

  • 揭晓3类AI无法取代的工作,高学历竟没有优势!

    整理 朱珂欣 出品 CSDN程序人生 xff08 ID xff1a coder life xff09 上周 xff0c IBM 就打响 AI 取代潮 的第一枪 xff0c CEO Arvind Krishna 在接受彭博社采访时表示 xff
  • 嵌入式Linux书籍清单

    原文链接 xff1a 重磅推荐 嵌入式Linux书籍清单 Linux入门C语言数据结构ARM裸机Linux驱动Linux应用Shell脚本Makefile Linux入门 作为嵌入式开发人员 xff0c 我们没有必要把精力放到使用哪个Lin
  • STM32串口之环形队列接收数据

    原文链接 xff1a STM32串口之环形队列接收数据 码代码的应该学数据结构都学过队列 环形队列是队列的一种特殊形式 xff0c 应用挺广泛的 因为有太多文章关于这方面的内容 xff0c 理论知识可以看别人的 xff0c 下面写得挺好的
  • Ubuntu18下xsens IMU的驱动安装及使用imu_utils标定

    最近在做xsens IMU的标定工作 xff0c 网上资源很多很杂 xff0c 打算按自己的操作过程 细节及遇到的问题记录一下 xff0c 里面有参考的博文都附了链接 主体可参考此博文 xff1a VIO 中 IMU 的标定流程 1 3 i
  • 常见 Promise 面试问题

    前端面试过程中 xff0c 基本都会问到 Promise xff0c 如果你足够幸运 xff0c 面试官问的比较浅 xff0c 仅仅问 Promise 的使用方式 xff0c 那么恭喜你 事实上 xff0c 大多数人并没有那么幸运 所以 x
  • k8s1.18高可用集群安装-超详细中文官方文档

    前言 这篇文章会带领大家去安装k8s1 18的高可用集群 xff0c 如果你是初学小白 xff0c 只要跟着做 xff0c 也能保证100 完成安装 xff0c 下面开始我们的安装之旅吧 xff0c 内容较多 xff0c 都是干货 心灵鸡汤
  • Kubernetes中部署MySQL高可用集群

    MySql简介 MySQL是一个关系型数据库管理系统 xff0c 由瑞典MySQL AB 公司开发 xff0c 属于 Oracle 旗下产品 MySQL 是最流行的关系型数据库管理系统之一 xff0c 在 WEB 应用方面 xff0c My
  • openstack安装和使用

    前言 本篇文章会介绍openstack的安装 openstack各组件的配置和功能 还会演示openstack云主机的创建流程 xff0c 整篇文章花费一天时间完成 xff0c 万字长文 xff0c 需要的可以关注 xff0c 相互学习 x
  • 通过helm部署gitlab服务

    微信公众号搜索DevOps和k8s全栈技术 xff0c 即可关注我的公众号 xff0c 也可通过扫描文章最后的二维码关注 xff0c 每天都会分享技术文章供大家参考阅读 xff0c 拥抱开源 xff0c 同大家共同进步 xff01 标题错了
  • k8s部署Zipkin搭配Kafka+ElasticSearch实现链路追踪

    微信公众号搜索DevOps和k8s全栈技术 xff0c 即可关注我的公众号 xff0c 也可通过扫描文章最后的二维码关注 xff0c 每天都会分享技术文章供大家参考阅读 xff0c 拥抱开源 xff0c 同大家共同进步 xff01 xff0
  • 全了!2020年互联网大厂的薪资和职级一览!(阿里巴巴、腾讯、百度、字节跳动、华为、京东、美团、滴滴、小米 9 家)...

    以 BAT 为代表的互联网大厂 xff0c 一直是求职者眼中的香饽饽 xff0c 大厂经历 在国内就业环境中无异于一块金子招牌 对于企业和HR来说 xff0c 大厂的职级规则也是整个行业的标杆 xff0c 从中小微企业到大型企业 xff0c
  • 降本增效!英特尔降薪裁员,网友:省钱发股息?

    整理 朱珂欣 出品 CSDN程序人生 xff08 ID xff1a coder life xff09 当硅谷的寒风吹过 xff0c 大家都难逃 窘境 近日 xff0c 据外媒 siliconangle 报道 xff0c 英特尔正计划裁员中
  • K8s 超详细总结!

    一个目标 xff1a 容器操作 xff1b 两地三中心 xff1b 四层服务发现 xff1b 五种Pod共享资源 xff1b 六个CNI常用插件 xff1b 七层负载均衡 xff1b 八种隔离维度 xff1b 九个网络模型原则 xff1b
  • Kubernetes 1.21正式发布 | 主要变化解读

    我们很高兴地宣布 Kubernetes 1 21 的发布 xff0c 这是我们 2021 年的第一个版本 xff01 这个版本包含 51 个增强功能 xff1a 13 个增强功能升级为稳定版 xff0c 16 个增强功能升级为 beta 版
  • k8s之DNS服务器搭建

    一 导读 在使用k8s部署springboot 43 redis简单应用这篇文章中 xff0c spring boot连接redis是直接使用的IP连接 xff0c 那么可不可以直接使用服务名称进行连接呢 xff1f 答案是可以的 xff0
  • linux系统常用命令大全

    点击上方 34 DevOps和k8s全栈技术 34 关注公众号 Linux 是一个广泛使用的操作系统 xff0c 被用于服务器 嵌入式系统和个人电脑等领域 在 Linux 中 xff0c 命令行是一个非常重要的工具 xff0c 它可以让用户
  • 从容器到k8s,演变过程和具体案例分享

    点击上方 34 DevOps和k8s全栈技术 34 关注公众号 Kubernetes xff08 k8s xff09 是一种开源的容器编排平台 xff0c 它能够管理和自动化容器化的应用程序的部署 扩展和运行 Kubernetes 可以与
  • kubernetes集群降级|k8s1.24+版本降级到1.23

    点击上方 34 DevOps和k8s全栈技术 34 关注公众号 在CentOS系统上进行Kubernetes版本降级需要谨慎操作 xff0c 因为降级可能会导致集群出现不稳定的情况 在进行版本降级之前 xff0c 建议先备份Kubernet
  • K8S使用手册

    概念理解 Pod概念 Pod是Kubernetes中一个抽象化概念 xff0c 由一个或多个容器组合在一起得共享资源 这些资源包括 xff1a 1 共享存储 xff0c 如 Volumes 卷 2 网络 xff0c 唯一的集群IP地址 3
  • Python中的下划线详解

    原文地址 xff1a https dbader org blog meaning of underscores in python 作者 xff1a Dan Bader 译者 xff1a 首席IT民工 本文介绍了Python中单下划线和双下