Python 中变量和函数的命名约定是什么？

发布于 2024-07-06 16:29:12 字数 392 浏览 15 评论 0原文

来自 C# 背景的变量和方法的命名约定通常是驼峰命名法或帕斯卡命名法：

// C# example
string thisIsMyVariable = "a"
public void ThisIsMyMethod()

在 Python 中，我已经看到了上面的内容，但我也看到了使用 Snake_case：

# python example
this_is_my_variable = 'a'
def this_is_my_function():

Python 是否有更优选、更明确的编码风格？

原文

Coming from a C# background the naming convention for variables and methods are usually either camelCase or PascalCase:

// C# example
string thisIsMyVariable = "a"
public void ThisIsMyMethod()

In Python, I have seen the above but I have also seen snake_case being used:

# python example
this_is_my_variable = 'a'
def this_is_my_function():

Is there a more preferable, definitive coding style for Python?

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

谎言 2024-07-13 16:29:13

进一步了解@JohnTESlade 的回答。 Google 的 Python 风格指南有一些非常简洁的建议，

要避免的名称

单字符名称，除了
任何包/模块名称中的计数器或迭代器破折号（-）
__double_leading_and_trailing_underscore__名称（由Python保留）

命名约定

“内部”是指模块内部的或者类内受保护的或私有的。
前面添加一个下划线 (_) 对保护模块变量和函数有一定的支持（不包含在 import * from 中）。在实例变量或方法前面添加双下划线 (__) 可以有效地使该变量或方法对其类私有（使用名称修饰）。
将相关的类和顶级函数放在一个模块中。与 Java 不同，无需将自己限制为每个模块一个类。
使用 CapWords 作为类名称，使用 lower_with_under.py 作为模块名称。尽管有许多名为 CapWords.py 的现有模块，但现在不鼓励这样做，因为当模块碰巧以类命名时会造成混乱。（“等等——我写的是import StringIO还是from StringIO import StringIO？”）

源自Guido建议的指南

回复收藏 0 原文

忘年祭陌 2024-07-13 16:29:13

正如其他答案所示，有 PEP 8，但 PEP 8 只是标准库的样式指南，并且它仅被视为其中的福音。 PEP 8 对于其他代码片段最常见的偏差之一是变量命名，特别是方法的变量命名。尽管考虑到使用混合大小写的代码量，但不存在单一的主导风格，如果要进行严格的普查，最终可能会得到带有混合大小写的 PEP 8 版本。与 PEP 8 相比，几乎没有其他常见的偏差。

回复收藏 0 原文

北凤男飞 2024-07-13 16:29:13

大多数Python人更喜欢下划线，但即使我使用Python已有5年多了，我仍然不喜欢它们。它们对我来说只是看起来很丑，但也许这就是我脑子里的 Java。

我只是更喜欢 CamelCase，因为它更适合类的命名方式，使用 SomeClass.doSomething() 比使用 SomeClass.do_something() 感觉更符合逻辑。如果你环顾一下Python的全局模块索引，你会发现两者都有，这是因为它是来自各种来源的库的集合，随着时间的推移而增长，而不是由像Sun这样的公司开发的具有严格编码规则的东西。我想说的底线是：使用你更喜欢的任何东西，这只是个人品味的问题。

回复收藏 0 原文

暮色兮凉城 2024-07-13 16:29:13

就我个人而言，我尝试对类、混合大小写方法和函数使用驼峰命名法。变量通常用下划线分隔（当我记得时）。这样我就能一眼看出我到底在调用什么，而不是所有东西看起来都一样。

回复收藏 0 原文

雪花飘飘的天空 2024-07-13 16:29:13

有一篇关于此的论文： http://www.cs.kent .edu/~jmaletic/papers/ICPC2010-CamelCaseUnderScoreClouds.pdf

TL;DR 它说snake_case比camelCase更具可读性。这就是为什么现代语言尽可能使用（或应该使用）蛇。

回复收藏 0 原文

萌吟 2024-07-13 16:29:13

无论是在课堂上还是课堂外：

变量和函数都是小写，如下所示：

name = "John"

def display(name):
    print("John")

如果它们不止一个单词中，它们之间用下划线“_”分隔，如下所示：

first_name = "John"

def display_first_name(first_name):
    print(first_name)

并且，如果变量是常量，则它是大写，如下所示：

FIRST_NAME = "John"

Whether or not being in class or out of class:

A variable and function are lowercase as shown below:

name = "John"

def display(name):
    print("John")

And if they're more than one word, they're separated with underscore "_" as shown below:

first_name = "John"

def display_first_name(first_name):
    print(first_name)

And, if a variable is a constant, it's uppercase as shown below:

FIRST_NAME = "John"

回复收藏 0 原文

御弟哥哥 2024-07-13 16:29:13

编码风格通常是组织内部政策/约定标准的一部分，但我认为一般来说，all_lower_case_underscore_separator 风格（也称为 Snake_case）在 Python 中最常见。

回复收藏 0 原文

梦一生花开无言 2024-07-13 16:29:13

Lenin 告诉过……我也来自 Java/C# 世界。还有 SQL。
仔细审视自己，试图找到第一眼可以理解的复杂结构的例子，比如列表字典中的列表，其中一切都是对象。
对我来说 - 驼峰命名法或其变体应该成为任何语言的标准。对于复杂的句子应保留下划线。

回复收藏 0 原文

谁许谁一生繁华 2024-07-13 16:29:13

我个人在使用其他编程语言进行开发时使用 Java 的命名约定，因为它是一致且易于遵循的。这样我就不会一直为使用哪些约定而苦苦挣扎，而这不应该是我的项目中最困难的部分！

回复收藏 0 原文

安人多梦 2024-07-13 16:29:13

PEP 8 是指南，而不是法律。它是 Python 之上的一个选项，而不是官方语言的一部分。如果每个人都使用相同的风格，那么在大公司中这将是首选。

我家里所有的Python程序都可以完美地使用camelCaseNames，我不会改变这一点，除非人们可以证明我的代码运行速度较慢或有错误的行为。然而，在我的工作中，他们希望设计师遵循相同的规则，因此选择了带有一组附加规则的 PEP 8。这并不意味着他们使用 autopep8，有很多工具可以兼容 PEP8，但有一些小的变化，例如 black、flake8、autopep8。

改进代码以使其符合 PEP8 的工具主要基于意见管理。因此，如果人们使用“必须有”、“应该有”、“应有”等词语，则应将其替换为“可能有”。我会询问贵公司他们的偏好。

除了 PEP8，我还可以推荐 pylint 和 mypy，这些工具确实可以在代码中找到问题和阻碍。

回复收藏 0 原文

七月上 2024-07-13 16:29:13

通常，遵循语言标准库中使用的约定。

回复收藏 0 原文

女中豪杰 2024-07-13 16:29:12

请参阅 Python PEP 8：函数和变量名称：

函数名称应小写，单词之间用下划线分隔，以提高可读性。< /p>
变量名称遵循与函数名称相同的约定。
mixedCase 仅在已成为流行风格的上下文中才允许使用（例如 threading.py），以保留向后兼容性。

回复收藏 0 原文

几度春秋 2024-07-13 16:29:12

Google Python 样式指南具有以下约定：

模块名称、包名称、类名、方法名称、异常名称、function_name、GLOBAL_CONSTANT_NAME、global_var_name、instance_var_name、function_parameter_name、local_var_name >.

类似的命名方案应该应用于CLASS_CONSTANT_NAME