Jaka jest konwencja nazewnictwa w Pythonie dla nazw zmiennych i funkcji?

Google Python Style Guide ma następującą konwencję:

Module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_CONSTANT_NAME, global_var_name, instance_var_name, function_parameter_name, local_var_name

Podobny schemat nazewnictwa powinien być stosowany do CLASS_CONSTANT_NAME

David Goodger (w" Code Like A Pythonist " tutaj) opisuje zalecenia PEP 8 w następujący sposób:

• joined_lower dla funkcji, metod, atrybuty, zmienne

• joined_lower lub ALL_CAPS dla stałe

• StudlyCaps dla klas

• camelCase tylko w celu dostosowania się do istniejące konwencje

Jak przyznaje Style Guide for Python Code ,

Konwencje nazewnictwa Pythona Biblioteka jest trochę bałagan, więc będziemy nigdy nie uzyskuj tego całkowicie spójnego

Zauważ, że odnosi się to tylko do standardowej biblioteki Pythona . Jeśli nie mogą uzyskaćtego spójnego, to prawie nie ma nadziei na posiadanie ogólnie przyjętej konwencji dlacałego kodu Pythona, prawda?

Z tego, a dyskusja tutaj, chciałbym wydedukuj, że jest to a nie straszny grzech, jeśli nadal używa się na przykład Javy lub C#(jasnych i dobrze ugruntowanych) konwencji nazewnictwa dla zmiennych i funkcji podczas przechodzenia do Pythona. Pamiętając, oczywiście, że najlepiej jest trzymać się tego, jaki jest dominujący styl dla bazy kodu / projektu/zespołu. Jak wskazuje Przewodnik po stylach Pythona, wewnętrzna spójność ma największe znaczenie.

^{możesz mnie odrzucić jako heretyka. :- ) Jak OP, nie jestem "Pythonista", jeszcze nie.}

Istnieje PEP 8 , Jak pokazują inne odpowiedzi, ale PEP 8 jest tylko przewodnikiem stylu dla standardowej biblioteki i jest w niej traktowany tylko jako Ewangelia. Jednym z najczęstszych odchyleń PEP 8 dla innych fragmentów kodu jest nazewnictwo zmiennych, szczególnie dla metod. Nie ma jednego dominującego stylu, chociaż biorąc pod uwagę objętość kodu, który używa mixedCase, jeśli ktoś miałby dokonać ścisłego spisu, prawdopodobnie skończyłby z wersją PEP 8 z mixedCase. Jest niewiele innych odchylenie od PEP 8, które jest tak samo powszechne.

Jak wspomniano, PEP 8 mówi, aby używać lower_case_with_underscores dla zmiennych, metod i funkcji.

Preferuję użycie lower_case_with_underscores dla zmiennych i mixedCase dla metod i funkcji sprawia, że kod jest bardziej wyraźny i czytelny. W Pythonie, Pythonie, Pythonie, Pythonie, Pythonie, Pythonie, Pythonie, Pythonie, Pythonie, Pythonie, Pythonie, Pythonie, Pythonie, Pythonie, Pythonie, Pythonie, Pythonie]}

Osobiście staram się używać CamelCase dla klas, metod mixedCase i funkcji. Zmienne są zazwyczaj oddzielone podkreśleniem (o ile pamiętam). W ten sposób mogę powiedzieć na pierwszy rzut oka, co dokładnie nazywam, a nie wszystko wygląda tak samo.

Większość ludzi Pythona woli podkreślenia, ale nawet ja używam Pythona od ponad 5 lat, nadal ich nie lubię. Dla mnie wyglądają brzydko, ale może to tylko Java w mojej głowie.

Po prostu wolę CamelCase, ponieważ lepiej pasuje do nazw klas, bardziej logiczne wydaje się mieć SomeClass.doSomething() niż SomeClass.do_something(). Jeśli rozejrzysz się w globalnym indeksie modułów w Pythonie, znajdziesz oba, co wynika z faktu, że jest to zbiór bibliotek z różnych źródła, które rosły w nadgodzinach, a nie coś, co zostało opracowane przez jedną firmę jak Sun z surowymi zasadami kodowania. Powiedziałbym, że najważniejsze jest to: używaj, co chcesz lepiej, to tylko kwestia osobistego gustu.

Jest o tym Artykuł: http://www.cs.kent.edu/ ~ jmaletic/papers / ICPC2010-CamelCaseUnderScoreClouds.pdf

TL;DR mówi, że snake_case jest bardziej czytelny niż camelCase. Dlatego współczesne języki używają (lub powinny używać) węża, gdzie tylko mogą.

Dalej do tego, co odpowiedział @ JohnTESlade. przewodnik po stylu Pythona Google ' a ma całkiem zgrabne zalecenia,

Nazwy, których należy unikać

• nazwy pojedynczych znaków z wyjątkiem liczników lub iteratorów
• myślniki ( - ) w dowolnej nazwie pakietu/modułu
• \__double_leading_and_trailing_underscore__ names (reserved by Python)

Konwencja Nazewnictwa

• "wewnętrzny" oznacza wewnętrzny moduł lub chroniony lub prywatny w ramach klasy.
• Prepending a pojedynczy podkreślnik ( _ ) ma pewne wsparcie dla ochrony zmiennych i funkcji modułu(nie dołączone do import * from). Prepending podwójnego podkreślenia ( _ _ ) do zmiennej lub metody instancji skutecznie służy do uczynienia zmiennej lub metody prywatną do jej klasy (użycie nazwy mangling).
• umieść powiązane klasy i funkcje najwyższego poziomu razem w module. W przeciwieństwie do Javy, nie ma potrzeby ograniczania się do jednej klasy na moduł.
• użyj CapWords dla nazw klas, ale lower_with_under.py dla modułu nazwiska. Chociaż istnieje wiele istniejących modułów o nazwie CapWords.py, jest to odradzane, ponieważ jest to mylące, gdy moduł ma nazwę pochodzącą od klasy. ("czekaj-czy ja napisałem import StringIO Czy from StringIO import StringIO?")

Wytyczne wynikające z zaleceń Guido

Styl kodowania jest zwykle częścią wewnętrznej polityki organizacji/standardów konwencji, ale myślę, że ogólnie, styl all_lower_case_underscore_separator (zwany także snake_case) jest najczęściej spotykany w Pythonie.

Zazwyczaj stosuje się konwencje używane w bibliotece standardowej języka.