簡體   English   中英

命名類和在python中命名文件之間的關聯(約定?)

[英]Association between naming classes and naming their files in python (convention?)

在python(和其他一些語言)我學到了,類的名稱應該用小寫字母寫,除了第一個字母,它應該是大寫字母。 例:

class FooBar:
    ...

類應該放在一個文件中,名稱與類相同。 在這個例子中,它將是一個文件foobar.py 如果我想在某個地方導入類foo ,我必須這樣做:

from foobar import FooBar

這個慣例讓我有些困惑。 我的直覺告訴我,如果文件名表示一個類,那么它應該用大寫的第一個字母寫,就像FooBar.py一樣。 這在文件名中看起來並不漂亮。 也許有人可以告訴我這是什么標准慣例

我希望我的問題可以理解。 :-)

你提出的是標准慣例。

包和模塊名稱

模塊應具有簡短的全小寫名稱。 如果提高可讀性,則可以在模塊名稱中使用下划線。 Python包也應該有簡短的全小寫名稱,但不鼓勵使用下划線。

由於模塊名稱映射到文件名,並且某些文件系統不區分大小寫並截斷長名稱,因此選擇模塊名稱相當短很重要 - 這在Unix上不是問題,但它可能是將代碼傳輸到較舊的Mac或Windows版本或DOS時出現問題。

當用C或C ++編寫的擴展模塊具有提供更高級別(例如更多面向對象)的接口的Python模塊時,C / C ++模塊具有前導下划線(例如_socket )。

班級名稱

幾乎無一例外,類名使用CapWords約定。 內部使用的類別還有一個主要的下划線。

Python風格指南


見例如

from configparser import ConfigParser

(順便提一下,它是Python 2.x中的ConfigParser,但在3.x中改為小寫)。

PEP 8說:

模塊應具有簡短的全小寫名稱。 如果提高可讀性,則可以在模塊名稱中使用下划線。 Python包也應該有簡短的全小寫名稱,但不鼓勵使用下划線。

我還要注意,每個文件不一定只有一個類。 相反,您應該在相同的文件中包含相關的類。 (當然在某些情況下,對一個文件有一個類可以工作,但情況並非總是如此)

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM