Tôi có nên thực sự sử dụng tất cả chữ hoa cho các hằng số của mình không?

Tôi là một lập trình viên Python chủ yếu sử dụng pylint cho mã nguồn. Tôi có thể loại bỏ tất cả các cảnh báo ngoại trừ một: Tên không hợp lệ cho hằng số. Thay đổi tên thành tất cả các mũ sửa nó, nhưng tôi thực sự phải làm điều đó? Nếu tôi làm điều đó, tôi thấy rằng mã của tôi trông xấu vì hầu hết các biến là không đổi (theo pylint).

Có lẽ bạn đang viết mã như thế này:

notes_director = argv[1]
chdir(notes_director)
files = glob('*.txt')
rand_file = choice(files)
with open(rand_file) as notes_file: 
    points = notes_file.readlines() 
    rand_point = choice(points)

Bạn nên di chuyển mã này vào một hàm:

def main():
    notes_director = argv[1]
    chdir(notes_director)
    files = glob('*.txt')
    rand_file = choice(files)
    with open(rand_file) as notes_file: 
        points = notes_file.readlines() 
        rand_point = choice(points)

# actually call the main function    
main()

Pylint giả định rằng mã thực sự làm việc sẽ nằm trong một hàm. Bởi vì bạn có mã này ở cấp cao nhất của mã thay vì bên trong một hàm, nó bị lẫn lộn.

Nói chung, đó là phong cách tốt hơn để làm việc bên trong một chức năng thay vì ở cấp cao nhất. Điều này cho phép bạn tổ chức tốt hơn những gì bạn đang làm và tạo điều kiện tái sử dụng nó. Bạn thực sự chỉ nên có mã thực hiện một thuật toán bên ngoài hàm trong một tập lệnh nhanh và bẩn.

Vâng. Theo quy tắc PEP8 trên các hằng số :

Các hằng số thường được xác định ở cấp độ mô-đun và được viết bằng tất cả các chữ in hoa có dấu gạch dưới tách các từ. Ví dụ bao gồm MAX_OVERFLOWvà TOTAL.

Phiên bản dài:

Trong cộng đồng Python (như trong nhiều cộng đồng khác) tồn tại các quy ước về cách viết mã. Điều này khác với mã làm việc : ngay cả khi bạn viết tất cả các chữ thường, mã của bạn vẫn hoạt động.

Nhưng có sự đồng thuận của cộng đồng (như tài liệu trong PEP8) được "thi hành" với các công cụ như pylint . Nếu bạn lập trình cho hạnh phúc của riêng bạn, bạn có thể bỏ qua những gợi ý mà pylint mang lại cho bạn. Nếu bạn muốn trao đổi cởi mở với cộng đồng, còn gọi là »ai đó ngoài tôi nên sử dụng mã của tôi«, bạn nên chuẩn bị mã theo PEP8.

Chuẩn mực cộng đồng PEP8 và Python là sử dụng ALL_CAPS_CONSTANTS. Đây là một đầu mối trực quan phổ biến, được sử dụng trong nhiều thập kỷ trong C, Java, Perl, PHP, Python, bash và các ngôn ngữ lập trình và môi trường shell khác. Nhưng theo cách nói trực tuyến hiện đại, TẤT CẢ CÁC TÍN HIỆU CAPS . Và la hét là thô lỗ.

Python là, tuy nhiên, không nhất quán về ALL_CAPS_CONSTANTS. JavaScript có thể có Math.PI, nhưng Python thì có math.pi. Không có hằng số dễ nhận biết hoặc lâu dài hơn π. Hoặc xem xét sys.version_info, phiên bản Python bạn đang chạy. Hằng số 100% trong suốt vòng đời của chương trình của bạn - nhiều hơn PORThoặc so với MAX_ITERATIONScác hằng số khác mà bạn xác định. Hay làm thế nào về sys.maxsize? Giá trị nguyên gốc tối đa của nền tảng của bạn là không đổi trong không chỉ một hoặc hai chương trình chạy mà còn cả tuổi thọ của phần cứng của bạn.

Nếu các hằng số này - bao gồm một số như π và e là hằng số cơ bản của vũ trụ, và sẽ không thay đổi trong suốt thời gian vĩnh cửu - nếu chúng có thể là chữ thường, thì ... các hằng số khác cũng vậy. Bạn có thể chọn.

Hãy nhớ rằng, PEP8 là một hướng dẫn phong cách. Một hướng dẫn, không phải là một luật. Một hướng dẫn thường được chống lại ngay cả bởi thư viện tiêu chuẩn của Python. Và trích dẫn một hướng dẫn cốt lõi khác về Python, PEP20 (còn gọi là "Zen của Python"):

• Đẹp thì tốt hơn xấu.
• Tính dễ đọc
• Thực tiễn đánh bại sự tinh khiết.

Trên một lưu ý thực tế, khi một chương trình YELLY_CONSTANTvà SHOUTY_PARAMETERbắt đầu ghi nhớ, sẽ giúp nhớ rằng các hằng số mũ thường không thực sự là lý tưởng Platonic bền vững , mà là các tham số của chương trình chạy. Không có gì thực sự liên tục về PORT, SITENAMEhoặc NUMRUNS, và họ không phải được quản lý như các chương trình toàn cầu độc lập. Ví dụ, chúng có thể được thả vào từ điển dưới dạng gói tham số chương trình có thể truy cập toàn cầu:

config = {
    'port': 80,
    'sitename': "Bubba's Blog",
    'numruns': 100,
}

Python cũng có một cơ sở tham số từ khóa tốt giúp giảm nhu cầu sử dụng APPARENTLY_ANGRY_GLOBAL_VARIABLES:

def process_data(sitename, port=80, numruns=100):
    ...

process_data("Bubba's Blog")

Trong thực tế, nhiều giá trị trong số này sẽ được (hoặc nên) được đọc từ các tệp cấu hình, biến môi trường hệ điều hành, đối số dòng lệnh hoặc các nguồn khác để đáp ứng nghịch đảo của nguyên tắc / mẫu điều khiển . Nhưng đó là một câu chuyện lớn hơn cho một ngày khác.

Vâng, nó khá phổ biến trong hầu hết các ngôn ngữ lập trình (ít nhất là những ngôn ngữ tôi sử dụng).

Bạn có thể tham khảo liên kết Google này để chia sẻ một phong cách chung giữa các nhà phát triển của cùng một nhóm.

Nên sử dụng

Type                  |Public          |Internal
Global/Class Constants|CAPS_WITH_UNDER |_CAPS_WITH_UNDER