Konwencje nazewnictwa modułów w Pythonie

Mam moduł, którego celem jest zdefiniowanie klasy o nazwie „nib”. (i kilka klas pokrewnych). Jak powinienem wywołać sam moduł? "stalówka"? „nibmodule”? Coś jeszcze?

Tylko stalówka. Nazwij klasę Nib, używając dużej litery N. Aby uzyskać więcej informacji na temat konwencji nazewnictwa i inne porady dotyczące stylu, zobacz PEP 8 , przewodnik po stylach Pythona.

Nazwałbym to nib.py. I nazwałbym również stalówkę klasy.

W większym projekcie w Pythonie, nad którym pracuję, mamy wiele modułów definiujących w zasadzie jedną ważną klasę. Nazwy klas rozpoczynają się od dużej litery. Nazwy modułów są nazywane małymi literami jak klasy. Prowadzi to do importu, jak poniżej:

from nib import Nib
from foo import Foo
from spam.eggs import Eggs, FriedEggs

To trochę jak emulacja języka Java. Jedna klasa na plik. Ale z dodatkową elastycznością, zawsze możesz dodać kolejną klasę do pojedynczego pliku, jeśli ma to sens.

Wiem, że moje rozwiązanie nie jest zbyt popularne z pythonowego punktu widzenia, ale wolę stosować podejście Java, w którym jeden moduł -> jedna klasa, z modułem nazwanym jako klasa. Rozumiem powód stylu Pythona, ale nie przepadam za bardzo dużym plikiem zawierającym wiele klas. Trudno mi się przeglądać pomimo składania.

Innym powodem jest kontrola wersji: posiadanie dużego pliku oznacza, że ​​Twoje zmiany mają tendencję do koncentrowania się na tym pliku. Może to potencjalnie prowadzić do większej liczby konfliktów do rozwiązania. Tracisz również dodatkowe informacje dziennika, że ​​twoje zatwierdzenie modyfikuje określone pliki (a zatem obejmuje określone klasy). Zamiast tego zobaczysz modyfikację pliku modułu, z tylko komentarzem do zatwierdzenia, aby zrozumieć, jaka modyfikacja została dokonana.

Podsumowując, jeśli wolisz filozofię Pythona, przejrzyj sugestie innych postów. Jeśli zamiast tego wolisz filozofię podobną do Java, utwórz plik Nib.py zawierający klasę Nib.

stalówka jest w porządku. W razie wątpliwości zapoznaj się z przewodnikiem po stylu języka Python.

Od PEP 8 :

Nazwy pakietów i modułów Moduły powinny mieć krótkie nazwy składające się wyłącznie z małych liter. Podkreślenia mogą być używane w nazwie modułu, jeśli poprawia to czytelność. Pakiety Pythona powinny również mieć krótkie nazwy składające się wyłącznie z małych liter, chociaż odradza się używanie podkreślenia.

Ponieważ nazwy modułów są mapowane na nazwy plików, a niektóre systemy plików nie uwzględniają wielkości liter i skracają długie nazwy, ważne jest, aby nazwy modułów były dość krótkie - nie będzie to problem w systemie Unix, ale może to być problem, gdy kod jest transportowany do starszych wersji Mac, Windows lub DOS.

Gdy moduł rozszerzający napisany w C lub C ++ ma towarzyszący moduł Pythona, który zapewnia wyższy poziom (np. Bardziej zorientowany obiektowo) interfejs, moduł C / C ++ ma na początku podkreślenie (np. _Socket).

Od PEP-8: nazwy pakietów i modułów :

Moduły powinny mieć krótkie nazwy składające się wyłącznie z małych liter. Podkreślenia mogą być używane w nazwie modułu, jeśli poprawia to czytelność.

Pakiety Pythona powinny również mieć krótkie nazwy składające się wyłącznie z małych liter, chociaż odradza się stosowanie podkreślenia.

Gdy moduł rozszerzający napisany w C lub C ++ ma towarzyszący moduł Pythona, który zapewnia interfejs wyższego poziomu (np. Bardziej zorientowany obiektowo), moduł C / C ++ ma na początku podkreślenie (np. _Socket).

Moduł foo w Pythonie byłby odpowiednikiem pliku klasy Foo w Javie

lub

Moduł foobar w Pythonie byłby odpowiednikiem pliku klasy FooBar w Javie