Nhận xét lớp python thực hành tốt nhất

thụt đầu dòng

Sử dụng 4 dấu cách cho mỗi mức thụt đầu dòng

Các dòng tiếp tục phải căn chỉnh các phần tử được bao bọc theo chiều dọc bằng cách sử dụng dòng ẩn của Python nối bên trong dấu ngoặc đơn, dấu ngoặc và dấu ngoặc nhọn hoặc sử dụng thụt lề treo [1]. Khi sử dụng thụt lề treo, cần xem xét những điều sau đây;

# 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 dấu cách là tùy chọn cho các dòng tiếp theo

Không bắt buộc

# 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 điều kiện của một câu lệnh

# Wrong:
# operators sit far away from their operands
income = (gross_wages +
          taxable_interest +
          (dividends - qualified_dividends) -
          ira_deduction -
          student_loan_interest)

# Wrong:
# operators sit far away from their operands
income = (gross_wages +
          taxable_interest +
          (dividends - qualified_dividends) -
          ira_deduction -
          student_loan_interest)

# Wrong:
# operators sit far away from their operands
income = (gross_wages +
          taxable_interest +
          (dividends - qualified_dividends) -
          ira_deduction -
          student_loan_interest)

# Wrong:
# operators sit far away from their operands
income = (gross_wages +
          taxable_interest +
          (dividends - qualified_dividends) -
          ira_deduction -
          student_loan_interest)

# 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 phần thảo luận về việc ngắt trước hay sau toán tử nhị phân bên dưới. )

Dấu ngoặc nhọn/dấu ngoặc vuông/dấu ngoặc đơn trên các cấu trúc nhiều dòng có thể xếp hàng dưới ký tự không phải khoảng trắng đầu tiên của dòng cuối cùng của danh sách, như trong

________số 8

hoặc nó có thể được xếp dưới ký tự đầu tiên của dòng bắt đầu cấu trúc nhiều 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 Spaces?

Khoảng trắng là phương pháp thụt đầu dòng ưa thích

Các tab chỉ nên được sử dụng để duy trì tính nhất quán với mã đã được thụt lề bằng các tab

Python không cho phép trộn các tab và dấu cách để thụt đầu dòng

Độ dài dòng tối đa

Giới hạn tất cả các dòng tối đa 79 ký tự

Đối với các khối văn bản dài có ít hạn chế về cấu trúc hơn (chuỗi tài liệu hoặc nhận xét), độ dài dòng nên được giới hạn ở 72 ký tự

Việc giới hạn độ rộng cửa sổ trình chỉnh sửa được yêu cầu giúp có thể mở nhiều tệp cạnh nhau và hoạt động tốt khi sử dụng các công cụ xem xét mã hiển thị hai phiên bản trong các cột liền kề

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ó trở nên khó hiểu hơn. Các giới hạn được chọn để tránh ngắt dòng trong trình chỉnh sửa có chiều rộng cửa sổ được đặt thành 80, ngay cả khi công cụ đặt một hình tượng đánh dấu trong cột cuối cùng khi ngắt dòng. Một số công cụ dựa trên web có thể hoàn toàn không cung cấp tính năng ngắt dòng động

Một số đội thực sự thích chiều dài 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, bạn có thể tăng giới hạn độ dài dòng lên tới 99 ký tự, miễn là các nhận xét và chuỗi tài liệu vẫn được gói gọn trong 72 ký tự

Thư viện chuẩn Python là bảo thủ và yêu cầu giới hạn dòng ở 79 ký tự (và tài liệu/nhận xét đến 72)

Cách ưu tiên để gói các dòng dài là sử dụng phần tiếp theo dòng ngụ ý của Python bên trong dấu ngoặc đơn, dấu ngoặc và dấu ngoặc nhọn. Các dòng dài có thể được chia thành 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 thay vì sử dụng dấu gạch chéo ngược để tiếp tục dòng

Đôi khi, dấu gạch chéo ngược vẫn có thể phù hợp. Ví dụ: câu lệ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)

# 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)

(Xem phần thảo luận trước về câu lệnh if nhiều dòng để biết thêm suy nghĩ về cách thụt lề của câu lệ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)

Một trường hợp khác như vậy là với câu lệ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)

Đảm bảo thụt lề dòng tiếp theo một cách thích hợp

Nên ngắt dòng trước hay sau toán tử nhị phân?

Trong nhiều thập kỷ, phong cách được đề xuất là phá vỡ sau các toán tử nhị phân. Nhưng điều này có thể ảnh hưởng đến khả năng đọc theo hai cách. các toán tử 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 di chuyển ra khỏi toán hạng của nó và lên dòng trước đó. Ở đây, mắt phải làm việc nhiều hơn để biết mục nào được thêm và mục nào bị 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à 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 sê-ri Máy tính và Sắp chữ của mình. “Mặc dù các công thức trong một đoạn luôn ngắt sau các phép toán và quan hệ nhị phân, nhưng các công thức được hiển thị luôn ngắt trước các phép toán nhị phân” [3]

Theo truyền thống từ toán học thường dẫn đến mã dễ đọc 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)

Trong mã Python, được phép ngắt trước hoặc sau toán tử nhị phân, miễn là quy ước nhất quán cục bộ. Đối với mã mới, phong cách của Knuth được đề xuất

dòng trống

Bao quanh các định nghĩa lớp và chức năng cấp cao nhất với hai dòng trống

Các định nghĩa phương thức bên trong một lớp được bao quanh bởi một dòng trống

Các dòng trống bổ sung có thể được sử dụng (một cách tiết kiệm) để phân 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 dòng đơn có liên quan (e. g. một tập hợp các triển khai giả)

Sử dụng ít dòng trống trong các hàm để biểu thị các phần logic

Python chấp nhận điều khiển-L (i. e. ^L) biểu mẫu ký tự nguồn cấp dữ liệu dưới dạng khoảng trắng; . Lưu ý, một số trình chỉnh sửa và trình xem mã dựa trên web có thể không nhận ra control-L dưới dạng nguồn cấp dữ liệu biểu mẫu và sẽ hiển thị một ký tự khác ở vị trí của nó

Mã hóa tệp nguồn

Mã trong bản phân phối Python cốt lõi phải luôn sử dụng UTF-8 và không được có khai báo mã hóa

Trong thư viện chuẩn, 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 ít ký tự không phải ASCII, 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à dấu thứ tự byte

Tất cả các mã định danh trong thư viện chuẩn Python PHẢI sử dụng các mã định danh chỉ ASCII và NÊN sử dụng các từ tiếng Anh bất cứ khi nào khả thi (trong nhiều trường hợp, chữ viết tắt và thuật ngữ kỹ thuật được sử dụng không phải tiếng Anh)

Các dự án nguồn mở với đối tượng toàn cầu được khuyến khích áp dụng chính sách tương tự

nhập khẩu

• Nhập khẩu thường phải trên các dòng riêng biệ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)
  

  6

  # 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)
  

  0

  Mặc dù vậy cũng không sao khi nói điều này

  # 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)
  

  1

• Các mục nhập luôn được đặt ở đầu tệp, ngay sau bất kỳ nhận xét và chuỗi tài liệu nào của mô-đun cũng như trước các hằng số và toàn cầu của mô-đun

  Nhập khẩu nên được nhóm lại theo thứ tự sau

  1. Nhập thư viện tiêu chuẩn
  2. Nhập khẩu của bên thứ ba có liên quan
  3. Nhập ứng dụng cục bộ/thư viện cụ thể

  Bạn nên đặt một dòng trống giữa mỗi nhóm nhập khẩu

• Nhập tuyệt đối được khuyến nghị, vì chúng thường dễ đọc hơn và có xu hướng hoạt động tốt hơn (hoặc ít nhất là đưa ra thông báo lỗi tốt hơn) nếu hệ thống nhập được định cấu hình không chính xác (chẳng hạn như khi thư mục bên trong gói kết thúc vào ngày

  # 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)
  

  04)

  # 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)
  

  2

  Tuy nhiên, nhập khẩu tương đối rõ ràng là một giải pháp thay thế có thể chấp nhận được đối với nhập khẩu tuyệt đối, đặc biệt là khi xử lý các bố cục gói phức tạp khi sử dụng nhập khẩu tuyệt đối sẽ dài dòng không cần thiế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)
  

  3

  Mã thư viện chuẩn nên tránh bố cục gói phức tạp và luôn sử dụng nhập khẩu tuyệt đối

• Khi nhập một lớp từ một mô-đun chứa lớp, bạn thường đánh vần từ này

  # 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)
  

  4

  Nếu cách đánh vần này gây ra xung đột tên địa phương, thì hãy đánh vần chúng một cách rõ rà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)
  

  5

  và sử dụng “myclass. MyClass” và “foo. quán ba. lớp của bạn. Lớp của bạn"

• Nên tránh nhập ký tự đại diệ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)
  

  05), vì chúng làm cho không rõ tên nào có trong không gian tên, gây nhầm lẫn cho cả người đọc và nhiều công cụ tự động. Có một trường hợp sử dụng có thể bảo vệ được đối với nhập ký tự đại diện, đó là xuất bản lại giao diện nội bộ như một phần của API công khai (ví dụ: ghi đè triển khai Python thuần túy của giao diện bằng các định nghĩa từ mô-đun tăng tốc tùy chọn và chính xác định nghĩa nào sẽ được

  Khi xuất bản lại tên theo cách này, các nguyên tắc bên dưới về giao diện công khai và nội bộ vẫn được áp dụng

Tên Dunder cấp độ mô-đun

Cấp độ mô-đun “dunders” (i. e. tên có hai dấu gạch dưới ở đầu và hai ở cuối) 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)

# 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)

# 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)

# 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)

# 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)

Thói xấu

Tránh khoảng trắng không liên quan trong các trường hợp sau

• Ngay bên trong dấu ngoặc đơn, dấu ngoặc hoặc dấu ngoặc nhọ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)
  

  7

  # 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)
  

  8

• Giữa dấu phẩy ở cuối và dấu ngoặc đơn theo sau

  # 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)
  

  9

  # Hanging indents *may* be indented to other than 4 spaces.
  foo = long_function_name(
    var_one, var_two,
    var_three, var_four)
  

  0

• Ngay trước dấu phẩy, dấu chấm phẩy hoặc dấu hai chấm

  # Hanging indents *may* be indented to other than 4 spaces.
  foo = long_function_name(
    var_one, var_two,
    var_three, var_four)
  

  1

  # Hanging indents *may* be indented to other than 4 spaces.
  foo = long_function_name(
    var_one, var_two,
    var_three, var_four)
  

  2

• Tuy nhiên, trong một lát cắt, dấu hai chấm hoạt động giống như một toán tử nhị phân và phải có số lượng bằng nhau ở hai bên (coi nó là toán tử có mức ưu tiên thấp nhất). Trong một lát cắt mở rộng, cả hai dấu hai chấm phải có cùng khoảng cách được áp dụng. Ngoại lệ. khi một tham số lát bị bỏ qua, khoảng trắng sẽ bị bỏ qua

  # Hanging indents *may* be indented to other than 4 spaces.
  foo = long_function_name(
    var_one, var_two,
    var_three, var_four)
  

  3

  # Hanging indents *may* be indented to other than 4 spaces.
  foo = long_function_name(
    var_one, var_two,
    var_three, var_four)
  

  4

• Ngay trước dấu ngoặc mở bắt đầu danh sách đối số của lệnh gọi hàm

  # Hanging indents *may* be indented to other than 4 spaces.
  foo = long_function_name(
    var_one, var_two,
    var_three, var_four)
  

  5

  # Hanging indents *may* be indented to other than 4 spaces.
  foo = long_function_name(
    var_one, var_two,
    var_three, var_four)
  

  6

• Ngay trước dấu ngoặc đơn mở bắt đầu lập chỉ mục hoặc cắt

  # Hanging indents *may* be indented to other than 4 spaces.
  foo = long_function_name(
    var_one, var_two,
    var_three, var_four)
  

  7

  # Hanging indents *may* be indented to other than 4 spaces.
  foo = long_function_name(
    var_one, var_two,
    var_three, var_four)
  

  8

• Nhiều khoảng trống xung quanh một toán tử gán (hoặc khác) để căn chỉnh nó với một toán tử khác

  # Hanging indents *may* be indented to other than 4 spaces.
  foo = long_function_name(
    var_one, var_two,
    var_three, var_four)
  

  9

  # 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()
  

  0

Khuyến nghị khác

• Tránh dấu khoảng trắng ở bất cứ đâu. Bởi vì nó thường vô hình nên có thể gây nhầm lẫn. e. g. dấu gạch chéo ngược theo sau là khoảng trắng và một dòng mới không được tính là điểm đánh dấu tiếp tục dòng. Một số trình soạn thảo không bảo quản nó và nhiều dự án (như bản thân CPython) có pre-commit hook từ chối nó
• Luôn bao quanh các toán tử nhị phân này bằng một khoảng trắng ở hai bên. bài tập (

  # 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)
  

  60), bài tập tăng cườ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)
  

  61,

  # 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)
  

  62, v.v. ), so sá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)
  

  63,

  # 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)
  

  64,

  # 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)
  

  65,

  # 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)
  

  66,

  # 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)
  

  67,

  # 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)
  

  68,

  # 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)
  

  69,

  # 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)
  

  00,

  # 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)
  

  01,

  # 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)
  

  02,

  # 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)
  

  03), Booleans (

  # 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)
  

  04,

  # 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)
  

  05,

  # 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)
  

  06)
• Nếu các toán tử có mức độ ưu tiên khác nhau được sử dụng, hãy xem xét thêm khoảng trắng xung quanh các toán tử có (các) mức độ ưu tiên thấp nhất. Sử dụng phán đoán của riêng bạ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()
  

  1

  # 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()
  

  2

• Chú thích chức năng nên sử dụng các quy tắc bình thường cho dấu hai chấm và luôn có khoảng trắng xung quanh mũi 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)
  

  07 nếu có. (Xem Chú thích chức năng bên dưới để biết thêm về chú thích chức năng. )

  # 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()
  

  3

  # 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()
  

  4

• Không sử dụng khoảng trắng xung quanh ký hiệu

  # 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)
  

  60 khi được sử dụng để biểu thị đối số từ khóa hoặc khi được sử dụng để biểu thị giá trị mặc định cho tham số chức năng không được chú thích

  # 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()
  

  5

  # 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()
  

  6

  Tuy nhiên, khi kết hợp một chú thích đối số với một giá trị mặc định, hãy sử dụng khoảng trắng xung quanh ký hiệu

  # 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)
  

  60

  # 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()
  

  7

  # 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

• Câu lệnh ghép (nhiều câu lệnh trên cùng một dòng) thường không được khuyến khích

  # 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

  đúng hơn là không

  my_list = [
      1, 2, 3,
      4, 5, 6,
      ]
  result = some_function_that_takes_arguments(
      'a', 'b', 'c',
      'd', 'e', 'f',
      )
  

  0

• Mặc dù đôi khi bạn có thể đặt if/for/while với phần thân nhỏ trên cùng một dòng, nhưng đừng bao giờ làm điều này đối với các câu có nhiều mệnh đề. Cũng tránh gấp những hàng dài như vậy

  đúng hơn là không

  my_list = [
      1, 2, 3,
      4, 5, 6,
      ]
  result = some_function_that_takes_arguments(
      'a', 'b', 'c',
      'd', 'e', 'f',
      )
  

  1

  Chắc chắn không phải

  my_list = [
      1, 2, 3,
      4, 5, 6,
      ]
  result = some_function_that_takes_arguments(
      'a', 'b', 'c',
      'd', 'e', 'f',
      )
  

  2

chặn bình luận

Chặn nhận xét thường áp dụng cho một số (hoặc tất cả) mã theo sau chúng và được thụt vào cùng cấp độ với mã đó. Mỗi dòng của một bình luận khối bắt đầu bằng mộ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)

Các đoạn bên trong một chú thích khối được phân tách bằng một dòng chứa mộ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)

Nhận xét nội tuyến

Sử dụng bình luận nội tuyến một cách tiết kiệm

Một bình luận nội tuyến là một bình luận trên cùng một dòng với một tuyên bố. Nhận xét nội tuyến phải được phân tách bằng ít nhất hai dấu cách từ câu lệnh. Họ nên bắt đầu bằng một dấu # và một dấu cách

Nhận xét nội tuyến là không cần thiết và trên thực tế gây mất tập trung nếu chúng nêu rõ ràng. Đừng làm điều này

my_list = [
    1, 2, 3,
    4, 5, 6,
    ]
result = some_function_that_takes_arguments(
    'a', 'b', 'c',
    'd', 'e', 'f',
    )

Nhưng đôi khi, điều này là hữu ích

my_list = [
    1, 2, 3,
    4, 5, 6,
    ]
result = some_function_that_takes_arguments(
    'a', 'b', 'c',
    'd', 'e', 'f',
    )

Chuỗi tài liệu

Các quy ước để viết các chuỗi tài liệu tốt (a. k. a. “docstrings”) bất tử trong PEP 257

• Viết tài liệu cho tất cả các mô-đun, hàm, lớp và phương thức công khai. Các tài liệu không cần thiết cho các phương thức không công khai, nhưng bạn nên có một nhận xét mô tả chức năng của phương thức đó. Nhận xét này sẽ xuất hiện sau 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)
  

  12
• PEP 257 mô tả các quy ước chuỗi tài liệu tốt. Lưu ý rằng quan trọng nhấ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)
  

  13 kết thúc một chuỗi tài liệu nhiều dòng phải nằm trên một dòng của chính nó

  my_list = [
      1, 2, 3,
      4, 5, 6,
      ]
  result = some_function_that_takes_arguments(
      'a', 'b', 'c',
      'd', 'e', 'f',
      )
  

  9

• Đối với một chuỗi tài liệu lót, vui lòng giữ

  # 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 đóng trên cùng một dòng

  my_list = [
      1, 2, 3,
      4, 5, 6,
  ]
  result = some_function_that_takes_arguments(
      'a', 'b', 'c',
      'd', 'e', 'f',
  )
  

  0

Nguyên tắc ghi đè

Các tên hiển thị cho người dùng dưới dạng các phần công khai của API phải tuân theo các quy ước phản ánh cách sử dụng thay vì triển khai

mô tả. Phong cách đặt tên

Có rất nhiều cách đặt tên khác nhau. Nó giúp có thể nhận ra phong cách đặt tên nào đang được sử dụng, độc lập với những gì chúng được sử dụng cho

Các kiểu đặt tên sau đây thường được phân biệ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)
  

  15 (một chữ thườ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)
  

  16 (chữ in hoa đơ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)
  

  17

• # 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)
  

  18

• # 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)
  

  20

• # 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)
  

  21 (hoặc CapWords, hoặc CamelCase – được đặt tên như vậy vì hình dạng gập ghềnh của các chữ cái [4]). Điều này đôi khi còn được gọi là StudlyCaps

  Ghi chú. Khi sử dụng các từ viết tắt trong CapWords, hãy viết hoa tất cả các chữ cái của từ viết tắt. Do đó, HTTPServerError tốt hơn HttpServerError

• # 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 (khác với Từ viết hoa bởi ký tự chữ thường đầu tiê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 (xấu xí. )

Ngoài ra còn có kiểu sử dụng tiền tố ngắn duy nhất để nhóm các tên có liên quan lại với nhau. Điều này không được sử dụng nhiều trong Python, nhưng nó được đề cập cho đầy đủ. Ví dụ: hà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)

# 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)

# 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)

# 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)

Thư viện X11 sử dụng chữ X đứng đầu cho tất cả các chức năng công khai của nó. Trong Python, kiểu này thường được coi là không cần thiết vì tên thuộc tính và phương thức được thêm tiền tố vào đối tượng và tên hàm được thêm tiền tố vào tên mô-đun

Ngoài ra, các biểu mẫu đặc biệt sau sử dụng dấu gạch dưới ở đầu hoặc ở cuối được công nhận (những biểu mẫu này thường có thể được kết hợp với bất kỳ quy ước trường hợp nào)

• # 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)
  

  28. chỉ số “sử dụng nội bộ” yếu. e. g.

  # 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)
  

  29 không nhập các đối tượng có tên bắt đầu bằng dấu gạch dướ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)
  

  30. được sử dụng theo quy ước để tránh xung đột với từ khóa Python, e. g

  my_list = [
      1, 2, 3,
      4, 5, 6,
  ]
  result = some_function_that_takes_arguments(
      'a', 'b', 'c',
      'd', 'e', 'f',
  )
  

  1

• # 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. khi đặt tên cho một thuộc tính lớp, hãy gọi xáo trộn tên (bên trong lớp FooBar,

  # 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 trở thà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)
  

  33; xem bên dướ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)
  

  34. Các đối tượng hoặc thuộc tính "ma thuật" sống trong các không gian tên do người dùng kiểm soát. e. g.

  # 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,

  # 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)
  

  36 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)
  

  37. Đừng bao giờ phát minh ra những cái tên như vậy;

kê đơn. quy ước đặt 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)

# 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)

# 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)

# 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)

# 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)

# 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)

my_list = [
    1, 2, 3,
    4, 5, 6,
]
result = some_function_that_takes_arguments(
    'a', 'b', 'c',
    'd', 'e', 'f',
)

# 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)

# 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)

# 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)

# 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)

# 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)

# 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)

# 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)

# 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)

# 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)

# 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)

# 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)

Giao diện công cộng và nội bộ

Mọi đảm bảo tương thích ngược chỉ áp dụng cho các 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 giao diện công cộng và nội bộ

Giao diện tài liệu đượ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 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ợ tốt hơn cho việc xem xét nội tâm, các mô-đun nên khai báo rõ ràng các tên trong API công khai của chúng bằng thuộc tí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)

# 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)

Ngay cả khi đặt _____106 một cách thích hợp, các giao diện bên trong (gói, mô-đun, lớp, hàm, thuộc tính hoặc tên khác) vẫn phải được thêm tiền tố bằng một dấu gạch dưới ở đầu

Một giao diện cũng được coi là nội bộ nếu bất kỳ không gian chứa tên nào (gói, mô-đun hoặc lớp) được coi là nội bộ

Tên đã nhập phải luôn được coi là chi tiết triển khai. 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 đó trừ khi chúng là một phần được ghi rõ ràng trong API của mô-đun chứa, chẳng hạn như mô-đun

# 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)

# 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)

Chú thích chức năng

Với việc chấp nhận PEP 484, các quy tắc kiểu cho chú thích chức năng đã thay đổi

• Chú thích chức năng nên sử dụng cú pháp PEP 484 (có một số đề xuất định dạng cho chú thích trong phần trước)
• Thử nghiệm với các kiểu chú thích đã được đề xuất trước đây trong PEP này không còn được khuyến khích nữa
• Tuy nhiên, bên ngoài stdlib, các thử nghiệm trong quy tắc của PEP 484 hiện được khuyến khích. Ví dụ: đánh dấu một thư viện hoặc ứng dụng lớn của bên thứ ba bằng các chú thích loại kiểu PEP 484, xem xét việc thêm các chú thích đó dễ dàng như thế nào và quan sát xem liệu sự hiện diện của chúng có làm tăng tính dễ hiểu của mã hay không
• Thư viện chuẩn Python nên thận trọng trong việc áp dụng các chú thích như vậy, nhưng việc sử dụng chúng được cho phép đối với mã mới và tái cấu trúc lớn
• Đối với mã muốn sử dụng các chú thích chức năng khác, bạn nên đặt một nhận xét có dạng

  # Wrong:
  # operators sit far away from their operands
  income = (gross_wages +
            taxable_interest +
            (dividends - qualified_dividends) -
            ira_deduction -
            student_loan_interest)
  

  4

  gần đầu tệp; . (Có thể tìm thấy nhiều cách chi tiết hơn để vô hiệu hóa khiếu nại từ trình kiểm tra loại trong PEP 484. )

• Giống như linters, bộ kiểm tra loại là công cụ tùy chọn, riêng biệt. Trình thông dịch Python theo mặc định không được đưa ra bất kỳ thông báo nào do kiểm tra kiểu và không được thay đổi hành vi của chúng dựa trên chú thích
• Người dùng không muốn sử dụng trình kiểm tra loại có thể bỏ qua chúng. Tuy nhiên, người dùng các gói thư viện của bên thứ ba có thể muốn chạy trình kiểm tra loại trên các gói đó. Với mục đích này, PEP 484 khuyến nghị sử dụng các tệp sơ khai. . pyi được đọc bởi trình kiểm tra loại theo sở thích của tệp tương ứng. tập tin py. Các tệp sơ khai có thể được phân phối cùng với thư viện hoặc riêng lẻ (với sự cho phép của tác giả thư viện) thông qua kho lưu trữ được đánh máy [5]

Chú thích biến

PEP 526 đã giới thiệu các chú thích biến. Các đề xuất kiểu cho chúng tương tự như các đề xuất về chú thích chức năng được mô tả ở trên

Cách tốt nhất để bình luận trong Python là gì?

Khi nào bạn nên bình luận bằng Python?

Cách nhanh nhất để nhận xét mã trong Python là gì?

Nhận xét tốt trong mã là gì?