介绍
这个问题涉及在解释语言中命名类的细微差别,以避免与本机数据结构(在这种情况下为Python)关联。
背景
我目前正在重构现有的基础架构。我们有一个类ComplexList,其命名使我固有地将其与可变的Python list关联。但是,其基本实现和用法更为复杂(如下所述)。
它实际上是什么:准不变的“主” dict映射到压缩二进制结构中的地址位置,包括用于了解位向量中标志的位位置的元数据。
类中是键的list映射回主控dict的键。这就是为什么它被称为ComplexList的原因:因为它作为输入使用键列表,可用于从主控dict检索项目。
通过将其主定义保存在受保护的方法dict中,可以使主_create_master_dict()映射成为准不变的。
每当将新条目添加到dict时,都使用此方法来重新生成主ComplexList,这意味着即使库用户手动操作了存储主dict的受保护变量,其更改最终也会被覆盖。
然后,我们使用继承来允许子类使用其自己的其他映射来扩展父级的_create_master_dict()。
因此,为什么我说“准不变”:当然,它并不是真正不变的,但是通过实现,就不应对其进行修改。
问题
为了避免与本机Python数据结构和方法相关联,此类的好名字是什么?
主意
我已经考虑过:ComplexMap,ComplexListToDict,遵循这些原则,但是,当然,map()还是原生Python方法,在类名中使用list和dict可能会更多。令人困惑。
我也考虑过像ComplexData这样完全抽象的东西,但这似乎有点晦涩难懂。
答案首选项
我不反对切换到上面提到的任何想法。我也可以保持现状!我完全有可能对此过度考虑。
期望的答案
该库一旦被采用,将被其他许多人使用。我正在寻找简洁明了的想法。这可能意味着答案与我的直觉不一致,因此欢迎您提供所有反馈!
参考文献
作为参考,我研究了PEP 8,Google Python style guide和许多其他StackOverflow文章,但是我并没有偶然发现一个问题,这些问题完全按照这些思路进行了讨论。
许多StackOverflow文章仅限于变量命名约定或在命名中避免使用匈牙利表示法。似乎没有太多文献讨论类命名的好方法。
我希望我的解释不会太冗长,并有助于阐明情况。任何想法和意见将不胜感激!
请您参考如下方法:
标准名称
这变得很主观,但是当集合/集合与标准集合接口有很大出入时,我更喜欢将名称改为复数。如果我们的Control集合具有非常不寻常的界面,而这些界面根本不像标准容器,那么我可以将其命名为Controls。
这样可以防止将其与标准库中任何现有接口相关联的诱惑/困惑,并且可以抵御狂热者,他们可能会试图使其符合标准接口,从而以某种成本和很少的方式对其进行泛化如此狭窄且经过充分测试的用例的好处。
标准名称=标准期望
一个实际的实现是,如果接口不符合与名称相关联的规范约定,那么它可能会减少混淆和诱惑,并引起开发人员更多注意,以检出实际接口,而不是通过简单地将其命名为首先避免使用此类标准名称的方法。我看到以相当标准的方式命名某些东西的主要好处是传达了它符合标准的期望。如果不能,那么也许有一些论点不太主观,无法直接避免使用标准名称,因为这实际上减损了将要首先“重载”标准名称的主要好处。不符合相关期望的案例。
实际上,这是我唯一能想到的好处,就是如果我根据接口和基础数据结构的性质(而不是ControlList)将其命名为ControlDict或ControlMap或Controls之类的东西,那么人们可能会很受诱惑提出这些类型的问题,说明为什么它不符合具有相似名称的标准接口(它的答案很简单,但我宁愿根本不提出这个问题)。
度量系统命名约定的全部要点是它们符合标准期望。当我们说某事物是七个“米”时,很明显会发生什么。尚不清楚我们是否重载了“米”的名称,在某些情况下,“米”有时可能表示“英尺”或“码”,而无需进一步澄清,并且如果我们重用了诸如“米”之类的名称,我们实际上会稀释并盘绕整个度量系统惯例在同一标准名称带有不同期望的不同情况下。
复数名称的争论(实用时)
因此,您可以探索或不探索名称的复数形式。实际上,我认为没有任何类,尤其是那些以UpperCamelCase约定命名的类,该类与标准有所不同,人们应该认为它的行为就像共享该名称子集的标准容器中的接口一样。我认为这很无聊。但是,当我们与开发人员合作时,他们的全部生计和信念基于对与错,并需要相信自己以激励自己去处理各种模糊的想法,因此,“讨论”并不总是“辩论”。
有时,您会遇到一些开发人员,他们看到List或Dict或Map或类似名称作为前缀或后缀,并希望它们与标准库中的接口和行为完全一致,并且可以绊倒人们,有时让他们长篇大论。我是一个很奇怪的开发人员,关心这样的“人为因素”和心理是好是坏(更关心的是广泛的人们倾向于对代码做出响应,而不是某种非人为的方式来编写代码。 ),并且我与众多开发人员(包括一些非常极端和有趣但又聪明又深奥的角色和困难人物)打交道,努力实现我喜欢的约定,有时强加给团队以尝试引起“小麻烦”。
因此,除非接口符合相同的要求,否则避免使用此类名称可能会有一些小的好处。我只是倾向于使用诸如Controls的复数名称,而不是ControlList或ControlSequence或ControlMap或类似此类的名称,因为它不需要标准的期望,因为它不需要太多的思考,也不会引起太大的关注。许多问题。我还必须承认,有时这些接口确实会遇到意外的设计更改(带有键/值对的类似地图的接口可能会变成类似序列的接口),而这种非常基本的多元化命名约定避免了继续重命名的诱惑。在那些接口和潜在的底层数据结构仍在进行中的次优情况下,类会招致不必要的代码更改。
面对这些次优场景,接口可能会随着底层实现的巨大变化而变化,这在我的行业(电影和游戏等的Visual FX)中是很常见的,因为昨天流行的数据结构和算法可能在过时了。考虑到行业在最先进的计算机图形技术方面变化的速度有多快,您必须非常幸运或使用非常高级的代码来避免此时需要更改接口。赞成甚至不传达底层数据结构的多元聚合约定,对于减少这种极端情况下极少需要的代码更改所产生的诱惑,特别有利。
我的首选样式是,当我们需要将Foo聚合到某些非标准(就接口设计而言)的集合/容器中时,它用作“主要聚合”,然后将其称为Foos。如果我需要一些辅助的,不太常用的容器,例如Foo到Bar的映射,那么考虑在可能的情况下仅使用标准容器,而无需创建新的类/类型。如果不是,那么我可能会调用不太常用的辅助容器,例如FooMap之类的东西,在这种情况下,除非不可行,否则我将尽可能地遵循标准的map / dictionary接口,这时我耸了耸肩,仍将其称为FooMap,并尝试解决文档中的任何歧义和混淆。我至少可以证明,偏爱这种风格并将其强加给开发人员,似乎引起了人们的注意,包括我曾经使用过的一些教条主义的类型(有趣的是,我曾与一些最多产的开发人员一起工作过)也是最教条的,这有助于避免惹恼他们)。显然,这很有趣,作为免责声明,我建议您在这里加些盐。
