Hướng dẫn python rules - quy tắc trăn
Thắng PythonThẩm lớp đề cập đến các không gian ở đầu một dòng mã. Show
Nội phân Chính showShow
Trong trường hợp trong các ngôn ngữ lập trình khác, sự thụt lề trong mã chỉ dành cho khả năng đọc, việc thụt vào python là rất quan trọng. Python sử dụng thụt lề để chỉ ra một khối mã. Python sẽ cho bạn một lỗi nếu bạn bỏ qua thụt lề: Số lượng không gian tùy thuộc vào bạn như một lập trình viên, nhưng nó phải có ít nhất một. Thí dụ nếu 5> 2: & nbsp; in ("năm lớn hơn hai!") & nbsp; Nếu 5> 2: & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; in ("Năm lớn hơn hai!") & nbsp; Hãy tự mình thử » Bạn phải sử dụng cùng một số khoảng trống trong cùng một khối mã, nếu không, Python sẽ cho bạn một lỗi: Thí dụnếu 5> 2: & nbsp; in ("năm lớn hơn hai!") & nbsp; Nếu 5> 2: & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; in ("Năm lớn hơn hai!") & nbsp; Hãy tự mình thử » Hãy tự mình thử »
Giới thiệuPython sẽ cho bạn một lỗi nếu bạn bỏ qua thụt lề: Số lượng không gian tùy thuộc vào bạn như một lập trình viên, nhưng nó phải có ít nhất một. Thí dụ nếu 5> 2: & nbsp; in ("năm lớn hơn hai!") & nbsp; Nếu 5> 2: & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; in ("Năm lớn hơn hai!") & nbsp; Một quán ngu si là tinh nghịch của tâm trí nhỏHãy tự mình thử » Bạn phải sử dụng cùng một số khoảng trống trong cùng một khối mã, nếu không, Python sẽ cho bạn một lỗi: Lỗi cú pháp: Nếu 5> 2: & nbsp; in ("năm lớn hơn hai!") & nbsp; & nbsp; & nbsp; & nbsp; & nbsp; In ("Năm lớn hơn hai!") Tác giả: Guido Van Rossum, Barry Warsaw, Nick Coghlan Tình trạng: Activetype: ProcessCreated: 05-Jul-2001post-History: 05-Jul-2001, 01-Aug-2013
Bố trí mãVết lõmSử dụng 4 không gian trên mỗi cấp độ thụt. Các dòng tiếp tục nên căn chỉnh các phần tử được bọc theo chiều dọc bằng cách sử dụng đường thẳng của Python, nối bên trong dấu ngoặc đơn, dấu ngoặc và niềng răng hoặc sử dụng thụt lề treo [1]. Khi sử dụng thụt lề treo sau đây nên được xem xét; Không nên có đối số trên dòng đầu tiên và nên sử dụng thụt thêm để phân biệt rõ ràng là một dòng tiếp tục: # Correct: # Aligned with opening delimiter. foo = long_function_name(var_one, var_two, var_three, var_four) # Add 4 spaces (an extra level of indentation) to distinguish arguments from the rest. def long_function_name( var_one, var_two, var_three, var_four): print(var_one) # Hanging indents should add a level. foo = long_function_name( var_one, var_two, var_three, var_four) # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one) Quy tắc 4 không gian là tùy chọn cho các dòng tiếp tục. Optional: # Hanging indents *may* be indented to other than 4 spaces. foo = long_function_name( var_one, var_two, var_three, var_four) Khi phần có điều kiện của ____ ____ 66-statement đủ dài để yêu cầu nó được viết trên nhiều dòng, điều đáng chú ý là sự kết hợp của một từ khóa hai ký tự (tức là with open('/path/to/some/file/you/want/to/read') as file_1, \ open('/path/to/some/file/being/written', 'w') as file_2: file_2.write(file_1.read())6), cộng với một không gian, cộng với dấu ngoặc đơn tạo ra một Thắng 4 không gian cho các dòng tiếp theo của điều kiện đa dòng. Điều này có thể tạo ra một cuộc xung đột trực quan với bộ mã được thụt vào lồng bên trong ____ ____ 66-statement, cũng sẽ tự nhiên được thụt vào 4 không gian. PEP này không có vị trí rõ ràng về cách (hoặc) để phân biệt trực quan các dòng có điều kiện như vậy với bộ lồng nhau bên trong ________ 66-statement. Các tùy chọn chấp nhận được trong tình huống này bao gồm, nhưng không giới hạn ở: # No extra indentation. if (this_is_one_thing and that_is_another_thing): do_something() # Add a comment, which will provide some distinction in editors # supporting syntax highlighting. if (this_is_one_thing and that_is_another_thing): # Since both conditions are true, we can frobnicate. do_something() # Add some extra indentation on the conditional continuation line. if (this_is_one_thing and that_is_another_thing): do_something() (Cũng xem các cuộc thảo luận về việc nên phá vỡ trước hay sau các nhà khai thác nhị phân bên dưới.) Đóng nẹp/giá đỡ/dấu ngoặc đơn trên các cấu trúc đa dòng có thể xếp theo ký tự không phải là màu đầu tiên của dòng danh sách cuối cùng, như trong: my_list = [ 1, 2, 3, 4, 5, 6, ] result = some_function_that_takes_arguments( 'a', 'b', 'c', 'd', 'e', 'f', ) Hoặc nó có thể được xếp hàng dưới ký tự đầu tiên của dòng bắt đầu cấu trúc đa dòng, như trong: my_list = [ 1, 2, 3, 4, 5, 6, ] result = some_function_that_takes_arguments( 'a', 'b', 'c', 'd', 'e', 'f', ) Tab hoặc không gian?Không gian là phương pháp thụt đầu tiên ưa thích. Các tab chỉ nên được sử dụng để duy trì sự phù hợp với mã đã được thụt vào với các tab. Python không hoàn toàn trộn lẫn các tab và không gian để thụt vào. Chiều dài đường tối đaGiới hạn tất cả các dòng ở mức tối đa 79 ký tự. Đối với các khối văn bản dài với các hạn chế cấu trúc ít hơn (tài liệu hoặc nhận xét), độ dài dòng phải được giới hạn ở 72 ký tự. Giới hạn chiều rộng cửa sổ Trình soạn thảo cần thiết cho phép có một số tệp mở cạnh nhau và hoạt động tốt khi sử dụng các công cụ đánh giá mã trình bày hai phiên bản trong các cột liền kề. Việc gói mặc định trong hầu hết các công cụ phá vỡ cấu trúc trực quan của mã, khiến nó khó hiểu hơn. Các giới hạn được chọn để tránh bọc trong các trình chỉnh sửa với chiều rộng cửa sổ được đặt thành 80, ngay cả khi công cụ đặt một glyph điểm trong cột cuối cùng khi các dòng gói. Một số công cụ dựa trên web có thể không cung cấp kết thúc dòng động. Một số đội thích mạnh mẽ một dòng dài hơn. Đối với mã được duy trì độc quyền hoặc chủ yếu bởi một nhóm có thể đạt được thỏa thuận về vấn đề này, có thể tăng giới hạn độ dài dòng lên tới 99 ký tự, với điều kiện là nhận xét và tài liệu vẫn được gói ở 72 ký tự. Thư viện tiêu chuẩn Python là bảo thủ và yêu cầu giới hạn các dòng cho 79 ký tự (và tài liệu/nhận xét đến 72). Cách ưa thích để gói các đường dài là bằng cách sử dụng sự tiếp tục dòng ngụ ý của Python, bên trong ngoặc đơn, ngoặc và thanh giằng. Các đường dài có thể được phá vỡ trên nhiều dòng bằng cách gói các biểu thức trong ngoặc đơn. Chúng nên được sử dụng theo sở thích để sử dụng dấu gạch chéo ngược để tiếp tục dòng. Backslashes vẫn có thể phù hợp đôi khi. Ví dụ, dài, nhiều ____ 70 không thể sử dụng tiếp tục ngầm trước Python 3.10, do đó, dấu gạch chéo ngược được chấp nhận cho trường hợp đó: with open('/path/to/some/file/you/want/to/read') as file_1, \ open('/path/to/some/file/being/written', 'w') as file_2: file_2.write(file_1.read()) . Một trường hợp khác là với các tuyên bố # Wrong: # operators sit far away from their operands income = (gross_wages + taxable_interest + (dividends - qualified_dividends) - ira_deduction - student_loan_interest)2. Hãy chắc chắn để thụt dòng dòng tiếp tục một cách thích hợp. Có nên phá vỡ dòng trước hoặc sau khi vận hành nhị phân?Trong nhiều thập kỷ, phong cách được đề xuất là phá vỡ sau khi các nhà khai thác nhị phân. Nhưng điều này có thể làm tổn thương khả năng đọc theo hai cách: các nhà khai thác có xu hướng nằm rải rác trên các cột khác nhau trên màn hình và mỗi toán tử được chuyển ra khỏi toán hạng của nó và vào dòng trước. Ở đây, mắt phải làm thêm để cho biết mục nào được thêm vào và cái nào được trừ: # Wrong: # operators sit far away from their operands income = (gross_wages + taxable_interest + (dividends - qualified_dividends) - ira_deduction - student_loan_interest) Để giải quyết vấn đề dễ đọc này, các nhà toán học và các nhà xuất bản của họ tuân theo quy ước ngược lại. Donald Knuth giải thích quy tắc truyền thống trong các máy tính và loạt sắp xếp của mình: Mặc dù các công thức trong một đoạn văn luôn bị phá vỡ sau các hoạt động và quan hệ nhị phân, các công thức hiển thị luôn bị phá vỡ trước khi hoạt động nhị phân [3]. Theo truyền thống từ toán học thường dẫn đến mã dễ đọc hơn: # Correct: # easy to match operators with operands income = (gross_wages + taxable_interest + (dividends - qualified_dividends) - ira_deduction - student_loan_interest) Trong mã Python, được phép phá vỡ trước hoặc sau một toán tử nhị phân, miễn là quy ước là nhất quán tại địa phương. Đối với phong cách mới Knuth Knuth được đề xuất. Các dòng trốngChức năng cấp cao nhất và định nghĩa lớp với hai dòng trống. Các định nghĩa phương pháp bên trong một lớp được bao quanh bởi một dòng trống duy nhất. Các dòng trống có thể được sử dụng (một cách tiết kiệm) để tách các nhóm chức năng liên quan. Các dòng trống có thể được bỏ qua giữa một loạt các lớp lót liên quan (ví dụ: một tập hợp các triển khai giả). Sử dụng các dòng trống trong các chức năng, một cách tiết kiệm, để chỉ ra các phần logic. Python chấp nhận ký tự thức ăn điều khiển-l (tức là ^l) là khoảng trắng; Nhiều công cụ coi các ký tự này là dấu phân cách trang, vì vậy bạn có thể sử dụng chúng để tách các trang liên quan đến tệp của mình. Lưu ý, một số trình chỉnh sửa và người xem mã dựa trên web có thể không nhận ra Control-L là nguồn cấp dữ liệu biểu mẫu và sẽ hiển thị một glyph khác ở vị trí của nó. Mã hóa tập tin nguồnMã trong phân phối Python cốt lõi phải luôn luôn sử dụng UTF-8 và không nên có khai báo mã hóa. Trong thư viện tiêu chuẩn, các mã hóa không phải UTF-8 chỉ nên được sử dụng cho mục đích thử nghiệm. Sử dụng các ký tự không phải ASCII một cách tiết kiệm, tốt nhất là chỉ để biểu thị địa điểm và tên người. Nếu sử dụng các ký tự không phải ASCII làm dữ liệu, hãy tránh các ký tự unicode ồn ào như z̯̯͡a̧͎̺l̡͓̫g̹̲o̡̼̘ và các dấu lệnh byte. Tất cả các định danh trong thư viện tiêu chuẩn Python phải sử dụng các định danh chỉ ASCII-ASCII và nên sử dụng các từ tiếng Anh ở bất cứ nơi nào khả thi (trong nhiều trường hợp, viết tắt và thuật ngữ kỹ thuật được sử dụng mà tiếng Anh). Các dự án nguồn mở với khán giả toàn cầu được khuyến khích áp dụng chính sách tương tự. Nhập khẩu
Tên Dunder cấp độ mô -đunMức độ mô -đun, Dunders Dunders (tức là tên có hai dấu gạch dưới và hai dấu gạch ngang), chẳng hạn như # Wrong: # operators sit far away from their operands income = (gross_wages + taxable_interest + (dividends - qualified_dividends) - ira_deduction - student_loan_interest)5, # Wrong: # operators sit far away from their operands income = (gross_wages + taxable_interest + (dividends - qualified_dividends) - ira_deduction - student_loan_interest)6, # Wrong: # operators sit far away from their operands income = (gross_wages + taxable_interest + (dividends - qualified_dividends) - ira_deduction - student_loan_interest)7, v.v. Python bắt buộc rằng các phiên bản tương lai phải xuất hiện trong mô-đun trước bất kỳ mã nào khác ngoại trừ DocStrings: # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)5 Trích dẫn chuỗiTrong Python, các chuỗi được trích xuất đơn và chuỗi được trích xuất kép là như nhau. PEP này không đưa ra khuyến nghị cho việc này. Chọn một quy tắc và bám vào nó. Tuy nhiên, khi một chuỗi chứa các ký tự trích dẫn đơn hoặc kép, hãy sử dụng chuỗi khác để tránh dấu gạch chéo ngược trong chuỗi. Nó cải thiện khả năng đọc. Đối với các chuỗi được trích dẫn ba, luôn sử dụng các ký tự trích dẫn kép để phù hợp với quy ước DocString trong PEP 257. Khoảng trắng trong biểu thức và câu lệnhThói xấuTránh khoảng trắng bên ngoài trong các tình huống sau:
Các khuyến nghị khác
Chắc chắn không phải:Khi nào nên sử dụng dấu phẩy kéo dài # No extra indentation. if (this_is_one_thing and that_is_another_thing): do_something() # Add a comment, which will provide some distinction in editors # supporting syntax highlighting. if (this_is_one_thing and that_is_another_thing): # Since both conditions are true, we can frobnicate. do_something() # Add some extra indentation on the conditional continuation line. if (this_is_one_thing and that_is_another_thing): do_something()8 # No extra indentation. if (this_is_one_thing and that_is_another_thing): do_something() # Add a comment, which will provide some distinction in editors # supporting syntax highlighting. if (this_is_one_thing and that_is_another_thing): # Since both conditions are true, we can frobnicate. do_something() # Add some extra indentation on the conditional continuation line. if (this_is_one_thing and that_is_another_thing): do_something()9 Dấu phẩy thường là tùy chọn, ngoại trừ chúng là bắt buộc khi tạo ra một yếu tố. Để rõ ràng, nên bao quanh các dấu ngoặc đơn sau (về mặt kỹ thuật): my_list = [ 1, 2, 3, 4, 5, 6, ] result = some_function_that_takes_arguments( 'a', 'b', 'c', 'd', 'e', 'f', )0 my_list = [ 1, 2, 3, 4, 5, 6, ] result = some_function_that_takes_arguments( 'a', 'b', 'c', 'd', 'e', 'f', )1 Khi dấu phẩy kéo dài, chúng thường hữu ích khi sử dụng hệ thống kiểm soát phiên bản, khi danh sách các giá trị, đối số hoặc các mục nhập được dự kiến sẽ được mở rộng theo thời gian. Mẫu là đặt mỗi giá trị (v.v.) trên một dòng, luôn luôn thêm dấu phẩy kéo dài và thêm dấu ngoặc đơn/giá đỡ/nẹp vào dòng tiếp theo. Tuy nhiên, không có ý nghĩa gì khi có dấu phẩy theo cùng một dòng với dấu phân cách đóng (ngoại trừ trong trường hợp trên của các bộ dữ liệu singleton):Đặt tên quy ước Các quy ước đặt tên của thư viện Python, có một chút lộn xộn, vì vậy chúng tôi sẽ không bao giờ có được sự nhất quán hoàn toàn này - tuy nhiên, đây là các tiêu chuẩn đặt tên hiện đang được khuyến nghị. Các mô -đun và gói mới (bao gồm các khung của bên thứ ba) nên được ghi vào các tiêu chuẩn này, nhưng trong đó một thư viện hiện tại có một phong cách khác, tính nhất quán nội bộ được ưu tiên.Nguyên tắc ghi đè Các tên có thể nhìn thấy cho người dùng là các phần công khai của API nên tuân theo các quy ước phản ánh việc sử dụng thay vì thực hiện.Mô tả: Kiểu đặt tên Có rất nhiều phong cách đặt tên khác nhau. Nó giúp có thể nhận ra phong cách đặt tên đang được sử dụng, độc lập với những gì chúng được sử dụng.
# Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)07 (xấu!) Thư viện X11 sử dụng X hàng đầu cho tất cả các chức năng công cộng của nó. Trong Python, phong cách này thường được coi là không cần thiết bởi vì tên thuộc tính và phương thức được đặt trước với một đối tượng và tên hàm được đặt trước với một tên mô -đun. Ngoài ra, các hình thức đặc biệt sau đây sử dụng dấu gạch dưới hàng đầu hoặc dấu vết được công nhận (chúng thường có thể được kết hợp với bất kỳ quy ước nào):
Quy định: Đặt tên quy ướcTên cần tránhKhông bao giờ sử dụng các ký tự ’Lát (chữ thường el),‘ O, (chữ hoa oh) hoặc ‘I, (mắt chữ hoa) làm tên biến ký tự đơn. Trong một số phông chữ, các ký tự này không thể phân biệt được với số một và không. Khi bị cám dỗ sử dụng ‘L, hãy sử dụng‘ L, thay vào đó. Khả năng tương thích ASCIICác định danh được sử dụng trong thư viện tiêu chuẩn phải tương thích ASCII như được mô tả trong phần chính sách của PEP 3131. Tên gói và tên mô -đunCác mô-đun nên có tên ngắn, toàn bộ. Dấu gạch dưới có thể được sử dụng trong tên mô -đun nếu nó cải thiện khả năng đọc. Các gói Python cũng nên có tên ngắn, toàn bộ, mặc dù việc sử dụng dấu gạch dưới không được khuyến khích. Khi một mô -đun mở rộng được viết bằng C hoặc C ++ có mô -đun Python đi kèm cung cấp giao diện cấp cao hơn (ví dụ: định hướng đối tượng hơn), mô -đun C/C ++ có dấu gạch dưới hàng đầu (ví dụ: # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)22). Tên lớpTên lớp thường nên sử dụng quy ước Capwords. Thay vào đó, quy ước đặt tên cho các chức năng có thể được sử dụng trong trường hợp giao diện được ghi lại và sử dụng chủ yếu là có thể gọi được. Lưu ý rằng có một quy ước riêng cho các tên tích hợp: hầu hết các tên được xây dựng là các từ đơn (hoặc hai từ chạy cùng nhau), với quy ước Capwords chỉ được sử dụng cho các tên ngoại lệ và hằng số tích hợp. Nhập tên biếnTên của các biến loại được giới thiệu trong PEP 484 thường sử dụng Capwords thích tên ngắn: # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)23, # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)24, # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)25. Nên thêm hậu tố # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)26 hoặc # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)27 vào các biến được sử dụng để khai báo hành vi đồng biến hoặc trái ngược tương ứng: my_list = [ 1, 2, 3, 4, 5, 6, ] result = some_function_that_takes_arguments( 'a', 'b', 'c', 'd', 'e', 'f', )3 Tên ngoại lệBởi vì các trường hợp ngoại lệ nên là các lớp, quy ước đặt tên lớp được áp dụng ở đây. Tuy nhiên, bạn nên sử dụng lỗi hậu tố lỗi trên tên ngoại lệ của bạn (nếu ngoại lệ thực sự là một lỗi). Tên biến toàn cầu(Hãy để hy vọng rằng các biến này chỉ được sử dụng trong một mô -đun.) Các quy ước giống như các biến cho các chức năng. Các mô-đun được thiết kế để sử dụng thông qua # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)13 nên sử dụng cơ chế # Wrong: # operators sit far away from their operands income = (gross_wages + taxable_interest + (dividends - qualified_dividends) - ira_deduction - student_loan_interest)5 để ngăn chặn xuất khẩu toàn cầu hoặc sử dụng quy ước cũ của tiền tố như vậy với một dấu gạch dưới (mà bạn có thể muốn làm để chỉ ra những thế giới này là mô-đun không công khai). Tên chức năng và tên biếnTên chức năng phải là chữ thường, với các từ được phân tách bằng dấu gạch dưới khi cần thiết để cải thiện khả năng đọc. Tên biến theo cùng một quy ước với tên chức năng. Mixedcase chỉ được phép trong các bối cảnh mà đó đã là kiểu phổ biến (ví dụ: Threading.py), để giữ lại khả năng tương thích ngược. Các đối số chức năng và phương thứcLuôn luôn sử dụng # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)30 cho đối số đầu tiên cho các phương thức thể hiện. Luôn luôn sử dụng # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)31 cho đối số đầu tiên cho các phương thức lớp. Nếu một đối số chức năng Tên tên xung đột với một từ khóa dành riêng, thì tốt hơn là nên nối một dấu gạch ngang duy nhất thay vì sử dụng viết tắt hoặc tham nhũng chính tả. Do đó # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)32 tốt hơn # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)33. (Có lẽ tốt hơn là tránh các cuộc đụng độ như vậy bằng cách sử dụng từ đồng nghĩa.) Tên phương thức và biến thể hiệnSử dụng các quy tắc đặt tên chức năng: chữ thường với các từ được phân tách bằng dấu gạch dưới khi cần thiết để cải thiện khả năng đọc. Sử dụng một dấu gạch dưới hàng đầu cho các phương thức và biến thể hiện không công khai. Để tránh các cuộc đụng độ tên với các lớp con, hãy sử dụng hai dấu gạch dưới hàng đầu để gọi tên Python tên quy tắc. Python mang các tên này với tên lớp: Nếu lớp foo có thuộc tính có tên # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)34, nó không thể được truy cập bởi # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)35. . Lưu ý: Có một số tranh cãi về việc sử dụng __names (xem bên dưới). 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ữ cái viết hoa với dấu gạch dưới tách các từ. Ví dụ bao gồm # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)37 và # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)38. Thiết kế cho thừa kếLuôn quyết định xem các phương thức và biến thể hiện của lớp (gọi chung là: thuộc tính của người Hồi giáo) nên được công khai hoặc không công khai. Nếu nghi ngờ, chọn không công khai; Nó dễ dàng hơn để công khai muộn hơn là làm cho một thuộc tính công khai không công khai. Các thuộc tính công khai là những thuộc tính mà bạn mong đợi các máy khách không liên quan trong lớp của bạn sẽ sử dụng, với cam kết của bạn để tránh những thay đổi không tương thích ngược. Các thuộc tính không công khai là những thuộc tính không được sử dụng bởi các bên thứ ba; Bạn không đảm bảo rằng các thuộc tính không công khai đã giành được sự thay đổi hoặc thậm chí bị xóa. Chúng tôi không sử dụng thuật ngữ riêng tư ở đây, vì không có thuộc tính nào thực sự riêng tư trong Python (không có số lượng công việc nói chung không cần thiết). Một loại thuộc tính khác là một phần của API phân lớp con (thường được gọi là bảo vệ trực tuyến trong các ngôn ngữ khác). Một số lớp được thiết kế để được kế thừa, để mở rộng hoặc sửa đổi các khía cạnh của hành vi lớp học. Khi thiết kế một lớp như vậy, hãy cẩn thận để đưa ra các quyết định rõ ràng về các thuộc tính nào là công khai, là một phần của API phân lớp và thực sự chỉ được sử dụng bởi lớp cơ sở của bạn. Với suy nghĩ này, đây là các hướng dẫn Pythonic:
Giao diện công khai và nội bộBất kỳ đảm bảo khả năng tương thích ngược chỉ áp dụng cho giao diện công cộng. Theo đó, điều quan trọng là người dùng có thể phân biệt rõ ràng giữa các giao diện công cộng và nội bộ. Các giao diện được ghi nhận được coi là công khai, trừ khi tài liệu tuyên bố rõ ràng chúng là giao diện tạm thời hoặc nội bộ được miễn trừ khỏi các đảm bảo khả năng tương thích ngược thông thường. Tất cả các giao diện không có giấy tờ nên được coi là nội bộ. Để hỗ trợ nội tâm tốt hơn, các mô -đun nên khai báo rõ ràng các tên trong API công khai của họ bằng thuộc tính # Wrong: # operators sit far away from their operands income = (gross_wages + taxable_interest + (dividends - qualified_dividends) - ira_deduction - student_loan_interest)5. Đặt # Wrong: # operators sit far away from their operands income = (gross_wages + taxable_interest + (dividends - qualified_dividends) - ira_deduction - student_loan_interest)5 thành một danh sách trống cho thấy mô -đun không có API công khai. Ngay cả với # Wrong: # operators sit far away from their operands income = (gross_wages + taxable_interest + (dividends - qualified_dividends) - ira_deduction - student_loan_interest)5 được thiết lập một cách thích hợp, các giao diện nội bộ (gói, mô -đun, lớp, chức năng, thuộc tính hoặc tên khác) vẫn nên được đặt trước với một dấu gạch dưới hàng đầu. Một giao diện cũng được coi là nội bộ nếu bất kỳ không gian tên nào (gói, mô -đun hoặc lớp) được coi là nội bộ. Tên nhập khẩu phải luôn được coi là một chi tiết thực hiện. Các mô -đun khác không được dựa vào quyền truy cập gián tiếp vào các tên đã nhập như vậy trừ khi chúng là một phần được ghi chép rõ ràng của API mô -đun có chứa API, chẳng hạn như # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)43 hoặc một gói # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)19 # Wrong: # Arguments on first line forbidden when not using vertical alignment. foo = long_function_name(var_one, var_two, var_three, var_four) # Further indentation required as indentation is not distinguishable. def long_function_name( var_one, var_two, var_three, var_four): print(var_one)19 hiển thị chức năng từ các mô hình con. Khuyến nghị lập trình
Chú thích chức năngVới sự chấp nhận của PEP 484, các quy tắc phong cách cho các chú thích chức năng đã thay đổi.
Chú thích biếnPEP 526 giới thiệu các chú thích thay đổi. Các đề xuất về kiểu cho chúng tương tự như các chú thích chức năng được mô tả ở trên:
Chú thích Người giới thiệuBản quyềnTài liệu này đã được đặt trong phạm vi công cộng. |