Hướng dẫn pep8 cheat sheet - bảng gian lận pep8

Đặt tên quy ước

  • Đặt tên quy ước
  • Độ dài dòng tối đa và phá vỡ đường
  • Nhận dạng
  • Bình luận
  • Khối ý kiến
  • Ý kiến ​​nội tuyến
  • Khi nào nên tránh thêm khoảng trắng
  • Khuyến nghị lập trình
  • Bố cục mã
  • Vết lõm sau khi phá vỡ dòng
  • Thụt lề sau khi phá vỡ dòng 2
  • Đâu để đặt nẹp đóng cửa ở đâu
  • Chuỗi tài liệu
  • Khoảng trắng xung quanh các nhà khai thác nhị phân
  • Khi nào bỏ qua Pep 8

Không bao giờ sử dụng tên chữ L, O hoặc tôi vì chúng có thể bị nhầm lẫn với 1 và 0, tùy thuộc vào kiểu chữ

O = 2 # Điều này có thể trông giống như bạn đang cố gắng chỉ định lại 2 đến 0

Hàm số

chức năng, my_function

Biến đổi

x, var, my_varable

Lớp

Mô hình, MyClass

Phương pháp

class_method, phương pháp

Không thay đổi

Không đổi, my_constant, my_long_constant

Mô -đun

Module.py, my_module.py

Bưu kiện

Gói, MyPackage

Độ dài dòng tối đa và phá vỡ đường

PEP 8 suggests lines should be limited to 79 characters. This is because it allows you to have multiple files open next to one another, while also avoiding line wrapping.


Python will assume line continuation if code is contained within parentheses, brackets, or braces:
def function(arg_one, arg_two,
             arg_three, arg_four):
    return arg_one


If it is impossible to use implied continuation, then you can use backslashes to break lines instead:
from mypkg import example1, \
    example2, example3

# Recommended
total = (first_variable
         + second_variable
         - third_variable)

# Not Recommended
total = (first_variable +
         second_variable -
         third_variable)

Nhận dạng

Sử dụng 4 không gian liên tiếp để chỉ ra thụt lề.

Thích không gian hơn các tab.

Bình luận

Khối ý kiến

Ý kiến ​​nội tuyến

Khi nào nên tránh thêm khoảng trắng

Khuyến nghị lập trình

Bố cục mã

Vết lõm sau khi phá vỡ dòng

Thụt lề sau khi phá vỡ dòng 2

Đâu để đặt nẹp đóng cửa ở đâu

Chuỗi tài liệu

Khoảng trắng xung quanh các nhà khai thác nhị phân

Khi nào bỏ qua Pep 8

Khi nào nên tránh thêm khoảng trắng

Khuyến nghị lập trình

Bố cục mã

Vết lõm sau khi phá vỡ dòng

Thụt lề sau khi phá vỡ dòng 2

Đâu để đặt nẹp đóng cửa ở đâu

Chuỗi tài liệu

Khoảng trắng xung quanh các nhà khai thác nhị phân

Khi nào bỏ qua Pep 8

Khuyến nghị lập trình

Bố cục mã

Vết lõm sau khi phá vỡ dòng

Thụt lề sau khi phá vỡ dòng 2

Đâu để đặt nẹp đóng cửa ở đâu

Chuỗi tài liệu

Bố cục mã

Vết lõm sau khi phá vỡ dòng

Thụt lề sau khi phá vỡ dòng 2

Đâu để đặt nẹp đóng cửa ở đâu

Vết lõm sau khi phá vỡ dòng

Thụt lề sau khi phá vỡ dòng 2

Đâu để đặt nẹp đóng cửa ở đâu

Chuỗi tài liệu

Thụt lề sau khi phá vỡ dòng 2

def function(arg_one, arg_two,
             arg_three, arg_four):
    return arg_one


x = 5
if (x > 3 and
    x < 10):
    print(x)

x = 5
if (x > 3 and
    x < 10):
    # Both conditions satisfied
    print(x)

x = 5
if (x > 3 and
        x < 10):
    print(x)

# hanging indent
var = function(
    arg_one, arg_two,
    arg_three, arg_four)

Đâu để đặt nẹp đóng cửa ở đâu

PEP 8 provides two options for the position of the closing brace in implied line continuations:

1 - Line up the closing brace with the first non-whitespace character of the previous line:

list_of_numbers = [
    1, 2, 3,
    4, 5, 6,
    7, 8, 9
    ]

2 - Line up the closing brace with the first character of the line that starts the construct:
list_of_numbers = [
    1, 2, 3,
    4, 5, 6,
    7, 8, 9
]

Chuỗi tài liệu

Khoảng trắng xung quanh các nhà khai thác nhị phân

Khi nào bỏ qua Pep 8

Không bao giờ sử dụng tên chữ L, O hoặc tôi vì chúng có thể bị nhầm lẫn với 1 và 0, tùy thuộc vào kiểu chữ

O = 2 # Điều này có thể trông giống như bạn đang cố gắng chỉ định lại 2 đến 0

Khoảng trắng xung quanh các nhà khai thác nhị phân

Khi nào bỏ qua Pep 8

Không bao giờ sử dụng tên chữ L, O hoặc tôi vì chúng có thể bị nhầm lẫn với 1 và 0, tùy thuộc vào kiểu chữ

O = 2 # Điều này có thể trông giống như bạn đang cố gắng chỉ định lại 2 đến 0

Hàm số

chức năng, my_function

Biến đổi

x, var, my_varable

Lớp

Mô hình, MyClass

Phương pháp

class_method, phương pháp

Không thay đổi

Không đổi, my_constant, my_long_constant

Mô -đun

Module.py, my_module.py

Bưu kiện

Khi nào bỏ qua Pep 8

Không bao giờ sử dụng tên chữ L, O hoặc tôi vì chúng có thể bị nhầm lẫn với 1 và 0, tùy thuộc vào kiểu chữ

O = 2 # Điều này có thể trông giống như bạn đang cố gắng chỉ định lại 2 đến 0

Hàm số