เหตุใดไพลินท์จึงตั้งชื่อตัวแปรอักขระเดี่ยว

ฉันยังคงคุ้นเคยกับอนุสัญญา python และใช้pylintเพื่อทำให้โค้ดของฉันเป็น pythonic มากขึ้น แต่ฉันงงงวยกับความจริงที่ว่าไพลินท์ไม่ชอบชื่อตัวแปรอักขระเดี่ยว ฉันมีสองสามลูปดังนี้:

for x in x_values:
   my_list.append(x)

และเมื่อฉันเรียกใช้pylintฉันได้รับInvalid name "x" for type variable (should match [a-z_][a-z0-9_]{2,30}- นั่นแสดงให้เห็นว่าชื่อตัวแปรที่ถูกต้องต้องมีความยาวระหว่าง 3 ถึง 31 อักขระ แต่ฉันได้ดูหลักเกณฑ์การตั้งชื่อ PEP8แล้วและฉันไม่เห็นอะไรที่ชัดเจนเกี่ยวกับตัวอักษรตัวพิมพ์เล็กตัวเดียว และฉันเห็นตัวอย่างมากมายที่ใช้มัน

มีบางอย่างที่ฉันขาดหายไปใน PEP8 หรือเป็นมาตรฐานเฉพาะสำหรับไพลินท์?

PyLint ไม่เพียง แต่ตรวจสอบคำแนะนำ PEP8 เท่านั้น นอกจากนี้ยังมีคำแนะนำของตัวเองซึ่งหนึ่งในนั้นคือชื่อตัวแปรควรเป็นคำอธิบายและไม่สั้นเกินไป

คุณสามารถใช้สิ่งนี้เพื่อหลีกเลี่ยงชื่อสั้น ๆ ดังกล่าว:

my_list.extend(x_values)

หรือปรับแต่งการกำหนดค่าของ PyLint เพื่อบอก PyLint ว่าชื่อตัวแปรใดดี

รายละเอียดเพิ่มเติมเล็กน้อยเกี่ยวกับสิ่งที่เกอร์นีย์อเล็กซ์กล่าวไว้: คุณสามารถบอกให้ PyLint สร้างข้อยกเว้นสำหรับชื่อตัวแปรซึ่ง (คุณพิ้งกี้สาบาน) มีความชัดเจนอย่างสมบูรณ์แม้ว่าจะมีอักขระน้อยกว่าสามตัว ค้นหาหรือเพิ่มในpylintrcของคุณไฟล์ใต้[FORMAT]ส่วนหัว:

# Good variable names which should always be accepted, separated by a comma
good-names=i,j,k,ex,Run,_,pk,x,y

ที่นี่ pk (สำหรับคีย์หลัก), x และ y คือชื่อตัวแปรที่ฉันเพิ่ม

ในภาษาที่พิมพ์มากตัวแปรชื่อตัวอักษร 1 ตัวสามารถเป็น ok-ish ได้เนื่องจากโดยทั่วไปคุณจะได้รับประเภทที่อยู่ถัดจากชื่อในการประกาศตัวแปรหรือในฟังก์ชัน / วิธีต้นแบบ:

bool check_modality(string a, Mode b, OptionList c) {
    ModalityChecker v = build_checker(a, b);
    return v.check_option(c);
}

ใน Python คุณจะไม่ได้รับข้อมูลนี้ดังนั้นหากคุณเขียน:

def check_modality(a, b, c):
    v = build_checker(a, b)
    return v.check_option(c)

คุณไม่ทิ้งร่องรอยใด ๆ ให้กับทีมซ่อมบำรุงเกี่ยวกับสิ่งที่ฟังก์ชันนี้สามารถทำได้และวิธีการเรียกใช้และสิ่งที่ส่งคืน ดังนั้นใน Python คุณมักจะใช้ชื่อที่สื่อความหมาย:

def check_modality(name, mode, option_list):
    checker = build_checker(name, mode)
    return checker.check_option(option_list)

และคุณยังเพิ่ม docstring เพื่ออธิบายว่าสิ่งนี้ทำอะไรและคาดหวังประเภทใด

ปัจจุบันยังมีตัวเลือกในการแทนที่ regexp กล่าวคือหากคุณต้องการอนุญาตให้อักขระเดี่ยวเป็นตัวแปร:

pylint --variable-rgx="[a-z0-9_]{1,30}$" <filename>

ดังนั้นpylintจะจับคู่ PEP8 และจะไม่นำการละเมิดเพิ่มเติมมาด้านบน .pylintrcนอกจากนี้คุณสามารถเพิ่มเข้าไป

เหตุผลลึกคือการที่คุณอาจจะจำสิ่งที่คุณตั้งใจa, b, c, x, yและzหมายถึงเมื่อคุณเขียนรหัสของคุณ แต่เมื่อคนอื่น ๆ อ่านมันหรือแม้กระทั่งเมื่อคุณกลับมาถึงรหัสของคุณรหัสกลายเป็นอ่านได้มากขึ้นเมื่อคุณได้ให้ มันเป็นชื่อทางความหมาย เราไม่ได้เขียนสิ่งต่างๆเพียงครั้งเดียวบนกระดานดำแล้วลบทิ้ง เรากำลังเขียนโค้ดที่อาจใช้เวลาประมาณหนึ่งทศวรรษหรือมากกว่านั้นและสามารถอ่านได้หลาย ๆ ครั้ง

ใช้ชื่อความหมาย ชื่อความหมายที่ผมเคยใช้ได้รับเช่นratio, denominator, obj_generator, pathฯลฯ มันอาจใช้เวลาสองพิเศษหรือสองพิมพ์พวกเขาออก แต่เวลาที่คุณประหยัดพยายามคิดสิ่งที่คุณเขียนถึงครึ่งชั่วโมงจากนั้นจะดีคุ้มค่า .