หลักการตั้งชื่อใน Python สำหรับชื่อตัวแปรและฟังก์ชั่นคืออะไร?

มาจากพื้นหลัง C # แบบแผนการตั้งชื่อตัวแปรและชื่อวิธีมักจะเป็น camelCase หรือ PascalCase:

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

ใน Python ฉันได้เห็นข้างต้น แต่ฉันก็เห็นการใช้ขีดล่าง:

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

มีรูปแบบการเข้ารหัสที่ดีกว่าและชัดเจนกว่าสำหรับ Python หรือไม่?

ดู Python PEP 8: ชื่อฟังก์ชั่นและตัวแปร :

ชื่อฟังก์ชั่นควรเป็นตัวพิมพ์เล็กโดยแยกคำด้วยเครื่องหมายขีดล่างเพื่อเพิ่มความสามารถในการอ่าน

ชื่อตัวแปรปฏิบัติตามแบบแผนเดียวกับชื่อฟังก์ชั่น

mixCaseได้รับอนุญาตเฉพาะในบริบทที่มีลักษณะที่แพร่หลายอยู่แล้ว (เช่นthreading.py ) เพื่อรักษาความเข้ากันได้ย้อนหลัง

คู่มือสไตล์ Google หลามมีการประชุมต่อไปนี้:

module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_CONSTANT_NAME, global_var_name, instance_var_name, ,function_parameter_namelocal_var_name

ควรใช้รูปแบบการตั้งชื่อที่คล้ายกันกับ CLASS_CONSTANT_NAME

David Goodger (ใน "รหัส Like Pythonista" ที่นี่ ) อธิบายคำแนะนำ PEP 8 ดังนี้:

• joined_lower สำหรับฟังก์ชั่นวิธีการแอตทริบิวต์ตัวแปร

• joined_lowerหรือALL_CAPSค่าคงที่

• StudlyCaps สำหรับชั้นเรียน

• camelCase เพียงเพื่อให้สอดคล้องกับอนุสัญญาที่มีอยู่ก่อน

ในฐานะที่เป็นแนวทางสไตล์สำหรับรหัสงูใหญ่ยอมรับ

ระเบียบการตั้งชื่อห้องสมุดของ Python ค่อนข้างยุ่งเหยิงดังนั้นเราจะไม่ทำให้เรื่องนี้สอดคล้องกันโดยสิ้นเชิง

โปรดทราบว่านี่หมายถึงไลบรารีมาตรฐานของ Python เท่านั้น หากพวกเขาไม่สามารถทำสิ่งที่สอดคล้องกันได้แสดงว่ามีความหวังมากที่จะมีระเบียบแบบแผนที่ยึดถือปฏิบัติกันมาสำหรับรหัส Python ทั้งหมดหรือไม่

จากนั้นและการสนทนาที่นี่ฉันจะอนุมานว่ามันไม่ใช่บาปที่น่ากลัวถ้าใครยังคงใช้การประชุมการตั้งชื่อของ Java หรือ C # (ชัดเจนและเป็นที่ยอมรับ) สำหรับตัวแปรและฟังก์ชั่นเมื่อข้ามไปยัง Python แน่นอนว่ามันเป็นการดีที่สุดที่จะปฏิบัติตามสไตล์ของ codebase / project / team ในขณะที่คู่มือสไตล์ Python ชี้ให้เห็นความมั่นคงภายในนั้นสำคัญที่สุด

^{อย่าลังเลที่จะยกเลิกฉันเป็นคนนอกรีต :-) เช่นเดียวกับ OP ฉันไม่ใช่ "Pythonista" แต่ยังไม่ได้}

มีPEP 8ตามคำตอบอื่น ๆ ที่แสดง แต่ PEP 8 เป็นเพียงแนวทางสำหรับห้องสมุดมาตรฐานและเป็นเพียงคำสอนของพระกิตติคุณเท่านั้น หนึ่งในความเบี่ยงเบนที่พบบ่อยที่สุดของ PEP 8 สำหรับโค้ดส่วนอื่นคือการตั้งชื่อตัวแปรโดยเฉพาะสำหรับวิธีการ ไม่มีลักษณะเด่นเดียวแม้ว่าการพิจารณาปริมาณของรหัสที่ใช้ mixCase หากมีการทำสำมะโนประชากรที่เข้มงวดหนึ่งอาจจะจบลงด้วยรุ่น PEP 8 กับ mixCase มีการเบี่ยงเบนอื่น ๆ เล็กน้อยจาก PEP 8 ที่ค่อนข้างเหมือนกัน

ดังที่กล่าวไว้ PEP 8 บอกว่าจะใช้lower_case_with_underscoresสำหรับตัวแปรวิธีการและฟังก์ชั่น

ฉันชอบใช้lower_case_with_underscoresสำหรับตัวแปรและmixedCaseสำหรับวิธีการและฟังก์ชั่นทำให้รหัสชัดเจนและอ่านง่ายขึ้น ดังนั้นการติดตามZen of Python "ชัดเจนดีกว่าโดยนัย" และ "จำนวนการอ่านได้"

เพิ่มเติมจากสิ่งที่ @JohnTESlade ตอบ คำแนะนำสไตล์หลามของ Google มีคำแนะนำที่ค่อนข้างประณีต

ชื่อที่ควรหลีกเลี่ยง

• ชื่อตัวละครเดียวยกเว้นตัวนับหรือตัววนซ้ำ
• ขีดกลาง (-) ในชื่อแพ็กเกจ / โมดูลใด ๆ
• \__double_leading_and_trailing_underscore__ names (สงวนไว้โดย Python)

อนุสัญญาการตั้งชื่อ

• "ภายใน" หมายถึงภายในของโมดูลหรือได้รับการป้องกันหรือเป็นส่วนตัวภายในชั้นเรียน
• การเพิ่มขีดล่างเดียว (_) มีการสนับสนุนบางอย่างสำหรับการปกป้องตัวแปรโมดูลและฟังก์ชั่น (ไม่รวมอยู่ในการนำเข้า * จาก) การเตรียมการขีดเส้นใต้คู่ (__) ให้กับตัวแปรหรือวิธีการทำหน้าที่อย่างมีประสิทธิภาพเพื่อทำให้ตัวแปรหรือวิธีการส่วนตัวกับคลาสของมัน (โดยใช้ชื่อ mangling)
• วางคลาสที่เกี่ยวข้องและฟังก์ชันระดับบนสุดไว้ด้วยกันในโมดูล แตกต่างจาก Java ไม่จำเป็นต้อง จำกัด ตัวเองเป็นหนึ่งคลาสต่อโมดูล
• ใช้CapWordsสำหรับชื่อคลาส แต่lower_with_under.pyสำหรับชื่อโมดูล แม้ว่าจะมีชื่อโมดูลที่มีอยู่มากมายCapWords.pyแต่ตอนนี้ก็ไม่ได้รับการสนับสนุนเนื่องจากมีความสับสนเมื่อโมดูลนั้นถูกตั้งชื่อหลังจากคลาส ("รอ - ฉันเขียนimport StringIOหรือยังfrom StringIO import StringIO?")

คำแนะนำที่ได้รับจากคำแนะนำของ Guido

คนงูใหญ่ส่วนใหญ่ชอบขีดล่าง แต่ถึงแม้ฉันจะใช้งูหลามมานานกว่า 5 ปีแล้ว แต่ฉันก็ยังไม่ชอบ พวกเขาดูน่าเกลียดสำหรับฉัน แต่บางทีนั่นอาจเป็นจาวาทั้งหมดในหัวของฉัน

ฉันก็เหมือน CamelCase ดีกว่าเพราะมันเหมาะกับที่ดีขึ้นด้วยวิธีการเรียนการตั้งชื่อมันให้ความรู้สึกตรรกะมากขึ้นที่จะมีมากกว่าSomeClass.doSomething() SomeClass.do_something()หากคุณมองไปรอบ ๆ ในดัชนีโมดูลส่วนกลางใน python คุณจะพบทั้งสองอย่างเนื่องจากความจริงที่ว่ามันเป็นคอลเลกชันของห้องสมุดจากแหล่งต่าง ๆ ที่เพิ่มขึ้นล่วงเวลาและไม่ใช่สิ่งที่ถูกพัฒนาโดย บริษัท เดียวเช่น Sun . ฉันจะบอกว่าบรรทัดล่างคือ: ใช้สิ่งที่คุณชอบดีกว่ามันเป็นเพียงคำถามของรสนิยมส่วนตัว

ส่วนตัวฉันพยายามใช้ CamelCase สำหรับคลาส, เมธอดและฟังก์ชัน mixCase ตัวแปรมักขีดเส้นใต้คั่นด้วย (เมื่อฉันจำได้) ด้วยวิธีนี้ฉันสามารถบอกได้ทันทีว่าฉันกำลังโทรอะไรมากกว่าทุกอย่างที่เหมือนกัน

มีบทความเกี่ยวกับเรื่องนี้: http://www.cs.kent.edu/~jmaletic/papers/ICPC2010-CamelCaseUnderScoreClouds.pdf

TL; DR มันบอกว่า snake_case นั้นอ่านได้ง่ายกว่า camelCase นั่นเป็นเหตุผลว่าทำไมภาษาสมัยใหม่จึงใช้งู (หรือควรใช้) งูทุกที่ที่ทำได้

สไตล์การเขียนโค้ดมักจะเป็นส่วนหนึ่งของมาตรฐานนโยบาย / การประชุมภายในขององค์กร แต่ฉันคิดว่าโดยทั่วไปแล้วสไตล์ all_lower_case_underscore_separator (หรือที่เรียกว่า snake_case) เป็นเรื่องที่พบได้บ่อยในงูใหญ่

ฉันใช้ระเบียบการตั้งชื่อของ Java เป็นการส่วนตัวเมื่อพัฒนาในภาษาการเขียนโปรแกรมอื่น ๆ เนื่องจากสอดคล้องและง่ายต่อการติดตาม ด้วยวิธีนี้ฉันไม่ได้ดิ้นรนอย่างต่อเนื่องเกี่ยวกับการประชุมที่จะใช้ซึ่งไม่ควรเป็นส่วนที่ยากที่สุดของโครงการของฉัน!

โดยทั่วไปคนหนึ่งปฏิบัติตามอนุสัญญาที่ใช้ในห้องสมุดมาตรฐานของภาษา