Tiêu chuẩn mã Python

Nhận xét tệp. Mỗi. py phải có nhận xét cấp cao ở trên cùng mô tả nội dung của tệp và phải bao gồm (các) tên của bạn và ngày tháng

Nhận xét chức năng. Mỗi chức năng nên có một bình luận mô tả

1. làm chức năng gì;
2. giá trị tham số của nó là gì
3. nó trả về (những) giá trị nào (nếu một hàm thường trả về một loại giá trị và một giá trị khác để biểu thị lỗi, nhận xét của bạn phải mô tả cả hai loại giá trị trả về này)

Lời khuyên của tôi về viết bình luận chức năng. viết bình luận của chức năng trước, sau đó viết mã chức năng. Đối với những hàm phức tạp, có comment liệt kê các bước của thuật toán, sẽ giúp ích cho bạn

Khi bình luận dính vào một phong cách cụ thể. Ví dụ

def approx_pi(n):

"""
  Function:  approx_pi 
  --------------------
  computes an approximation of pi using:
     pi/6 = 1/2 + (1/2 x 3/4) 1/5 (1/2)^3  + (1/2 x 3/4 x 5/6) 1/7 (1/2)^5 +
 
    n: number of terms in the series to sum
 
   returns: the approximate value of pi obtained by suming the first n terms
            in the above series
            returns zero on error (if n is non-positive)
""" 

   # note: approx_pi is likely complicated enough to have in-line comments
   #       describing parts of the code



def square_the_biggest(n1, n2):

"""
  Function: square_the_biggest
  ----------------------------
    Returns the square of the largest of its two input values
 
    n1: one real value 
    n2: the other real value
 
    returns: the square of the larger of n1 and n2 
""" 

Nhận xét nội tuyến rất quan trọng đối với các phần phức tạp trong mã của bạn, nhưng điều quan trọng là không được quá rắc rối ở đây; . Tránh bình luận những điều hiển nhiên. Sự lựa chọn của bạn về chức năng tốt và tên biến sẽ làm cho phần lớn mã của bạn có thể đọc được. Ví dụ: một nhận xét như sau là không cần thiết vì nó không thêm thông tin nào không rõ ràng từ chính mã C và nó có thể che khuất các nhận xét quan trọng thực sự trong mã của bạn

  # this is a bad in-line comment:
  x = x + 1   # increment the value of x 

Nhận xét lớp học. Mỗi Lớp nên có một nhận xét cấp cao mô tả những gì nó làm và mỗi hàm phương thức của nó phải có một nhận xét tương tự như nhận xét của các hàm thông thường

Các tiêu chuẩn mã hóa tôi. e. , hướng dẫn về phong cách cho Python được cung cấp bởi tài liệu có tên PEP8. PEP8 là Đề xuất cải tiến Python 8. Nó là một tài liệu cung cấp các quy ước mã hóa cho mã Python

Đây là hướng dẫn phong cách -

quy ước đặt tên

Sau đây là tiêu chuẩn đặt tên hiện được khuyến nghị

Tránh những tên này

Không bao giờ sử dụng các ký tự 'l' (chữ el viết thường), 'O' (chữ oh viết hoa) hoặc 'I' (chữ viết hoa eye) làm tên biến ký tự đơn

Tên gói và mô-đun

Các mô-đun nên có tên ngắn, toàn chữ thường. 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 phải có tên ngắn, viết thường, mặc dù việc sử dụng dấu gạch dưới không được khuyến khích

Tên Lớp

Tên lớp thường nên sử dụng quy ước CapWords. Quy ước đặt tên cho các chức năng có thể được sử dụng thay thế trong trường hợp giao diện được ghi lại và được sử dụng chủ yếu dưới dạng có thể gọi được

Tên ngoại lệ

Quy ước đặt tên lớp áp dụng ở đây. Tuy nhiên, bạn nên sử dụng hậu tố "Lỗi" trên tên ngoại lệ của mình

Tên hàm và biến

Tê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 tuân theo quy ước giống như tên hàm

Đối số hàm và phương thức

Luôn sử dụng self cho đối số đầu tiên của các phương thức thể hiện

Luôn sử dụng cls cho đối số đầu tiên cho các phương thức của lớp

Tên phương thức và biến thể hiện

Sử dụng quy tắc đặt tên hàm. 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

Chỉ sử dụng một dấu gạch dưới hàng đầu cho các phương thức không công khai và các biến thể hiện

Để tránh đụng độ tên với các lớp con, hãy sử dụng hai dấu gạch dưới ở đầu để gọi quy tắc xáo trộn tên của Python

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 với dấu gạch dưới ngăn cách các từ

thụt đầu dòng

Hướng dẫn đề xuất sử dụng 4 dấu cách cho mỗi cấp độ thụt đầu dòng

Tab hoặc dấu cá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ự

nhập khẩu

Câu lệnh nhập, giống như bất kỳ câu lệnh hoặc từ khóa nào khác trong Python nên được sử dụng và thêm vào mã đúng cách theo các phương pháp hay nhất. Hãy xem từng cái một –

Nhiều lần nhập

Nhiều lần nhập thường phải ở trên các dòng riêng biệt. Ví dụ -

import numpy
import pandas
import matplotlib

Luôn đứng đầu

Các mục nhập luôn được đặt ở đầu tệp i. e

• Sau bất kỳ nhận xét và tài liệu mô-đun nào
• Trước mô-đun toàn cầu và hằng số

Ví dụ -

Nhập mô-đun theo đơn đặt hàng

Một thực hành tốt là nhập các mô-đun theo thứ tự sau -

• Mô-đun thư viện tiêu chuẩn – e. g. sys, os, getopt, lại
• Mô-đun thư viện của bên thứ ba – e. g. ZODB, PIL. Hình ảnh, v.v.
• Các mô-đun được phát triển tại địa phương

nhập khẩu tuyệt đối

Nên nhập tuyệt đối vì chúng thường dễ đọc hơn và có xu hướng được thực hiện tốt hơn nếu hệ thống nhập được định cấu hình không chính xác. Ví dụ -

import mypkg.sibling
from mypkg import sibling
from mypkg.sibling import example

Nên tránh nhập ký tự đại diện (từnhập *)

Tránh nhập ký tự đại diện 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

Khoảng trắng trong biểu thức và câu lệnh

Tránh khoảng trắng không cần thiết như trong các tình huống sau -

Giữa dấu phẩy

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

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

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

Bình luận

• Nhận xét phải là câu hoàn chỉnh

• Từ đầu tiên phải được viết hoa, trừ khi đó là một định danh bắt đầu bằng một chữ cái viết thường

• Bình luận khối thường bao gồm một hoặc nhiều đoạn văn được xây dựng từ các câu hoàn chỉnh, với mỗi câu kết thúc bằng một dấu chấm

• Bạn nên sử dụng hai khoảng trắng sau khoảng thời gian kết thúc câu trong các nhận xét nhiều câu, ngoại trừ sau câu cuối cùng

  Các tiêu chuẩn mã hóa trong Python là gì?

  ‍Các tiêu chuẩn viết mã là tập hợp các quy tắc và nguyên tắc xác định phong cách lập trình, quy trình và phương pháp cho ngôn ngữ lập trình . Phải nói rằng python thân thiện với người mới bắt đầu và có cú pháp đơn giản hóa, nhấn mạnh vào ngôn ngữ tự nhiên.

  Một thực hành tốt để viết mã Python là gì?

  Sử dụng một dòng mã trên mỗi dòng . Cuối cùng, điều này có nghĩa là mọi phần của mã Python đều mạnh hơn và ngăn không cho viết mã không cần thiết.

  Các mã Python tốt nhất là gì?

  Đọc thêm .

  Một số linter phổ biến khác bao gồm. pycodestyle. mypy (trình kiểm tra kiểu tĩnh cho Python) isort (để sắp xếp nhập một cách nhất quán)

  Một trình định dạng tự động phổ biến khác là autopep8

  Làm cách nào để định dạng mã Python?

  Hoặc mở tệp của bạn trong trình chỉnh sửa và nhấn Ctrl+Alt+Shift+L hoặc trong cửa sổ Công cụ dự án, nhấp chuột phải vào tệp và chọn Mã định dạng lại.