Pilint neden tek karakterli değişken isimlerine itiraz ediyor?

Hala python kurallarına alışmaya ve pylintkodumu daha pitonik yapmak için kullanmaya alışıyorum, ancak pilin tek karakterli değişken adlarını sevmemesi beni şaşırttı. Bunun gibi birkaç döngüm var:

for x in x_values:
   my_list.append(x)

ve çalıştırdığımda pylint, şunu alıyorum Invalid name "x" for type variable (should match [a-z_][a-z0-9_]{2,30}- bu geçerli bir değişken adının 3 ila 31 karakter uzunluğunda olması gerektiğini gösteriyor, ancak PEP8 adlandırma kurallarına baktım ve tek küçük harflerle ilgili açık bir şey görmüyorum ve bunları kullanan birçok örnek görüyorum.

PEP8'de eksik olduğum bir şey mi var yoksa bu pylint'e özgü bir standart mı?

PyLint yalnızca PEP8 önerilerini kontrol etmez. Ayrıca kendi önerileri de vardır, bunlardan biri değişken adının açıklayıcı olması ve çok kısa olmamasıdır.

Bu tür kısa isimlerden kaçınmak için bunu kullanabilirsiniz:

my_list.extend(x_values)

Veya PyLint'e hangi değişken adının iyi olduğunu söylemek için PyLint'in yapılandırmasını değiştirin.

Sedyenin Alex'in not ettiği şey hakkında biraz daha ayrıntı: PyLint'e değişken isimler için istisnalar yapmasını söyleyebilirsiniz, ki bu da (yemin edersiniz) üç karakterden az olmasına rağmen tamamen nettir. Başlığın altında pylintrc dosyanıza ekleyin veya ekleyin [FORMAT]:

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

Burada pk (birincil anahtar için), x ve y eklediğim değişken isimleridir.

Kesin yazılmış dillerde, 1 harfli isim değişkenleri ok-ish olabilir, çünkü genellikle değişkenin bildiriminde veya işlev / yöntem prototipinde adın yanındaki türü alırsınız:

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

Python'da, bu bilgiyi almazsınız, yani yazarsanız:

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

Bakım ekibine, işlevin ne yapabileceği, nasıl adlandırıldığı ve ne döndüğü konusunda hiçbir ipucu bırakmıyorsunuz. Yani Python'da açıklayıcı isimler kullanma eğilimindesiniz:

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

ve hatta malzemenin ne işe yaradığını ve hangi türlerin beklendiğini açıklayan bir belge dizesi eklersiniz.

Günümüzde regexp'i geçersiz kılma seçeneği de vardır. Örneğin, değişken olarak tek karakterlere izin vermek istiyorsanız:

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

Yani, pylintPEP8 ile eşleşecek ve üstüne ek ihlaller getirmeyecek. Ayrıca ekleyebilirsin .pylintrc.

Derin bir sebebi amaçladığınız hatırlamak olabilmesidir a, b, c, x, y, ve zkodunuzu yazarken anlamında, ama diğerleri, okuduktan sonra, ya da kod gel bile kodu verirken çok daha okunabilir hale gelir anlamsal bir isim. Kara tahtaya bir şeyler yazıp sonra onu silmiyoruz. On yıl veya daha uzun süre kalabilecek ve birçok kez okunabilecek bir kod yazıyoruz.

Anlamsal isimler kullanın. Ben kullandım Semantik isimler gibi olmuştur ratio, denominator, obj_generator, path, vb onları yazmak için bir saniye fazladan veya iki sürebilir, fakat zaman sonra bile yarım saat yazdıklarını anlamaya çalışırken kaydetme değer olduğunu .