Tại sao pylint phản đối các tên biến ký tự đơn?

Tôi vẫn đang quen với các quy ước python và sử dụng pylintđể làm cho mã của mình trở nên khó hiểu hơn, nhưng tôi cảm thấy khó hiểu bởi thực tế là pylint không thích các tên biến ký tự đơn. Tôi có một vài vòng lặp như thế này:

for x in x_values:
   my_list.append(x)

và khi tôi chạy pylint, tôi nhận được Invalid name "x" for type variable (should match [a-z_][a-z0-9_]{2,30}- điều đó cho thấy rằng một tên biến hợp lệ phải dài từ 3 đến 31 ký tự, nhưng tôi đã xem qua các quy ước đặt tên PEP8 và tôi không thấy bất kỳ điều gì rõ ràng về các chữ cái thường , và tôi thấy rất nhiều ví dụ sử dụng chúng.

Có điều gì tôi đang thiếu trong PEP8 hay đây là tiêu chuẩn dành riêng cho pylint?

PyLint không chỉ kiểm tra các khuyến nghị PEP8. Nó cũng có các khuyến nghị riêng, một trong số đó là tên biến phải mang tính mô tả và không quá ngắn.

Bạn có thể sử dụng điều này để tránh những tên ngắn như vậy:

my_list.extend(x_values)

Hoặc tinh chỉnh cấu hình của PyLint để cho PyLint biết tên biến nào là tốt.

Chi tiết hơn một chút về những gì gurney alex lưu ý: bạn có thể yêu cầu PyLint đặt ngoại lệ cho các tên biến (bạn hồng hào) hoàn toàn rõ ràng mặc dù ít hơn ba ký tự. Tìm trong hoặc thêm vào tệp pylintrc của bạn , dưới [FORMAT]tiêu đề:

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

Ở đây pk (cho khóa chính), x và y là các tên biến mà tôi đã thêm.

Trong các ngôn ngữ được gõ mạnh, các biến tên 1 chữ cái có thể là ok-ish, vì bạn thường nhận được kiểu bên cạnh tên trong khai báo của biến hoặc trong nguyên mẫu hàm / phương thức:

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

Trong Python, bạn không nhận được thông tin này, vì vậy nếu bạn viết:

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

bạn hoàn toàn không để lại manh mối nào cho nhóm bảo trì về chức năng có thể hoạt động như thế nào và nó được gọi như thế nào và nó trả về gì. Vì vậy, trong Python, bạn có xu hướng sử dụng tên mô tả:

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

và bạn thậm chí còn thêm một chuỗi tài liệu giải thích những gì hoạt động và những loại được mong đợi.

Ngày nay, cũng có một tùy chọn để ghi đè regexp. Tức là nếu bạn muốn cho phép các ký tự đơn làm biến:

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

Vì vậy, pylintsẽ phù hợp với PEP8 và sẽ không đưa thêm vi phạm lên đầu. Ngoài ra, bạn có thể thêm nó vào .pylintrc.

Lý do sâu xa hơn là bạn có thể nhớ những gì bạn dự định a, b, c, x, y, và zcó nghĩa là khi bạn viết mã của bạn, nhưng khi người khác đọc nó, hoặc ngay cả khi bạn trở về với mã của bạn, mã trở nên nhiều hơn nữa có thể đọc được khi bạn cung cấp cho nó là một tên ngữ nghĩa. Chúng tôi không viết mọi thứ một lần trên bảng đen và sau đó xóa nó. Chúng tôi đang viết mã có thể tồn tại trong một thập kỷ hoặc hơn và được đọc rất nhiều lần.

Sử dụng tên ngữ nghĩa. Tên Semantic Tôi đã sử dụng đã như ratio, denominator, obj_generator, path, vv Nó có thể mất thêm một hoặc hai thứ hai để loại chúng ra, nhưng thời gian bạn tiết kiệm cố gắng tìm ra những gì bạn đã viết, ngay cả nửa tiếng đồng hồ kể từ đó là cũng có giá trị nó .