Hướng dẫn pep 8 cheat sheet pdf - pep 8 cheat sheet pdf

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

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.

Giới hạn độ dài dòng của bình luận và tài liệu là 72 ký tự.

Sử dụng các câu hoàn chỉnh, bắt đầu bằng một chữ cái viết hoa.

Đảm bảo cập nhật nhận xét nếu bạn thay đổi mã của mình.

Khả năng khối ý kiến ​​đến cùng cấp độ với mã họ mô tả.

Bắt đầu mỗi dòng với một # theo sau là một không gian duy nhất.

Các đoạn riêng biệt bằng một dòng chứa một #.

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

Viết ý kiến ​​nội tuyến trên cùng một dòng với câu lệnh mà họ đề cập đến.

Các bình luận nội tuyến riêng biệt bởi hai hoặc nhiều không gian từ tuyên bố.

Bắt đầu các bình luận nội tuyến với một # và một không gian duy nhất, như bình luận khối.

Don Tiết sử dụng chúng để giải thích điều hiển nhiên.

Nơi quan trọng nhất để tránh thêm khoảng trắng là ở cuối dòng. Điều này được gọi là khoảng trắng theo dõi

Ngay bên trong dấu ngoặc đơn, dấu ngoặc hoặc niềng răng:

Trước dấu phẩy, dấu chấm phẩy hoặc ruột kết:

Trước dấu ngoặc đơn mở ra danh sách đối số của một cuộc gọi chức năng:

Trước khung mở bắt đầu một chỉ mục hoặc lát cắt:

Giữa dấu phẩy kéo dài và dấu ngoặc đơn kết thúc:

Để sắp xếp các toán tử chuyển nhượng:

Ngay lập tức bên trong ngoặc, cũng như trước dấu phẩy và đại quý.

Don Tiết so sánh các giá trị Boolean với đúng hoặc sai bằng cách sử dụng toán tử tương đương.

Sử dụng thực tế là các chuỗi trống là giả mạo trong các câu lệnh.

Sử dụng không phải là không ... là trong các câu lệnh.

Don Tiết sử dụng nếu X: Khi bạn có nghĩa là nếu X không phải là không:

Sử dụng .StartSwith () và .endswith () thay vì cắt.

Các chức năng và lớp cấp cao nhất với hai dòng trống

Định nghĩa phương thức xung quanh bên trong các lớp với một dòng trống duy nhất.

Sử dụng các dòng trống một cách tiết kiệm các chức năng để hiển thị các bước rõ ràng.

Có hai kiểu thụt bạn có thể sử dụng.

Đầu tiên trong số này là căn chỉnh khối thụt lề với dấu phân cách mở:

Một phong cách thay thế của thụt sau khi phá vỡ dòng là một thụt lề treo. Đây là một thuật ngữ đánh máy có nghĩa là mỗi dòng nhưng đầu tiên trong một đoạn hoặc câu lệnh được thụt vào.

Surround Docstrings với ba trích dẫn kép ở hai bên, như trong "" "Đây là một tài liệu" "".

Viết chúng cho tất cả các mô -đun, chức năng, lớp học và phương thức công khai.

Đặt "" "kết thúc một tài liệu đa dòng trên một dòng:

Đối với các tài liệu một dòng, hãy giữ "" "trên cùng một dòng:

Bao quanh các toán tử nhị phân sau với một không gian ở hai bên:

Toán tử gán (=, +=, -=, và vv)

So sánh (==,! =,>, =,

Booleans (và, không, hoặc)

Khi = được sử dụng để gán giá trị mặc định cho đối số hàm, không bao quanh nó với khoảng trắng.

hàm def (default_parameter = 5):

y = x ** 2 + 5

z = (x+y) * (x-y)

Nếu x> 5 và x%2 == 0:

# Hãy coi đại tràng là người vận hành có mức độ ưu tiên thấp nhất

Danh sách [x+1: x+2]

Trong một lát cắt mở rộng, cả hai đại phân phải được bao quanh bởi cùng một lượng khoảng trắng

Danh sách [3: 4: 5]

Danh sách [x+1: x+2: x+3]]

Không gian bị bỏ qua nếu một tham số lát cắt bị bỏ qua

Danh sách [x+1: x+2:]

Nếu tuân thủ PEP 8 sẽ phá vỡ khả năng tương thích với phần mềm hiện có

Nếu mã xung quanh những gì bạn làm việc không phù hợp với PEP 8

Nếu mã cần giữ tương thích với các phiên bản Python cũ hơn