【问题标题】:How to name a Python file that cosists only of a class definition?如何命名仅包含类定义的 Python 文件?
【发布时间】:2017-06-23 00:32:52
【问题描述】:

如果我有一个仅包含类定义的 Python 文件,我应该如何命名它?

例如,如果我有这个:

class Folder:
    """Represents a computer folder."""
    ...

,我应该将文件命名为 folder.py 还是 Folder.py?如果文件也有 (a) 函数定义会怎样?

【问题讨论】:

  • Python 与 java 不同——文件名无关紧要。将文件命名为您想要的任何名称。避免使用 Python 标准库中的模块名称。
  • @PaulCornelius Python 具有鼓励开发人员遵循的 PEP 建议。

标签: python python-3.x module naming-conventions naming


【解决方案1】:

Python 类遵循您在代码中显示的 CapWords 约定,然后根据 python 样式指南,packages and modules 应该全部小写。包是目录,模块是文件,所以在你的类案例中,你可以将它命名为folder.py

根据 Paul Cornelius 的评论,我想明确指出这些只是惯例。您不需要遵循它们,它们不会影响程序。虽然 python.org 文档要求 python 类使用CapWords 并且文件是小写的,甚至有一些关于使用下划线和其他命名约定的指示,这对于程序的运行不是必需的。

【讨论】:

  • 这是一种风格推荐,解释器不强制执行。
  • @Davy M 谢谢。如果班级名称包含两个或多个单词(例如ComputerFile),我该怎么办?我应该将文件命名为 computerfile 还是 computer_file?因为类名没有下划线。
  • 抱歉,直到现在才回复您。样式指南说“如果提高可读性,可以在模块名称中使用下划线”,尽管后来它不鼓励在包名称中使用下划线;所以你的类文件(模块)可以是computerfile或computer_file,但你觉得最好让它可读,但如果你有一个包含多个类的目录(包),那么所有小写不带下划线是首选,尽管你可以提出使用不同的名称,可能使用一个单词。 TL;DR:computer_file 是可以接受的,而且可能是最好的。
猜你喜欢
  • 2019-05-17
  • 1970-01-01
  • 1970-01-01
  • 2018-11-25
  • 1970-01-01
  • 2019-02-05
  • 1970-01-01
  • 2021-02-13
  • 1970-01-01
相关资源
最近更新 更多