Đề xuất cải tiến PEP hoặc Python là một bản nháp hoặc tài liệu có mô tả về hướng dẫn viết mã Python, đây là cách thực hành tốt nhất để cải thiện tính nhất quán và khả năng đọc của mã Python. Tài liệu này chứa các tính năng như Kiểu và thiết kế của Python được sử dụng khi viết mã. Như chúng ta đã biết, Python có một định dạng hoặc thứ tự nghiêm ngặt để viết các tập lệnh, để nó giúp người khác dễ đọc mã; . Các nhà phát triển phải tuân theo các nguyên tắc này. Trong Python, chúng ta thấy thụt đầu dòng rất quan trọng để mã thực thi theo cú pháp
Chức năng của PEP8 trong Python
Nói chung, Pep8 là một công cụ mà bạn có thể kiểm tra các quy ước mã Python của mình với các quy ước trong tài liệu của Pep8. Hãy cho chúng tôi xem một vài tính năng của tài liệu Pep8
Bắt đầu khóa học phát triển phần mềm miễn phí của bạn
Phát triển web, ngôn ngữ lập trình, kiểm thử phần mềm và những thứ khác
Gói phát triển phần mềm tất cả trong một[hơn 600 khóa học, hơn 50 dự án]
Giá
Xem khóa học
600+ Khóa học trực tuyến. hơn 50 dự án. Hơn 3000 giờ. Giấy chứng nhận có thể kiểm chứng. Truy cập Trọn đời
4. 6 [82.649 xếp hạng]
1. thụt đầu dòng
Đây là một trong những tính năng quan trọng nhất để viết mã và đọc mã trong Python. Nó còn được gọi là quy tắc 4 dấu cách và quy tắc này không bắt buộc vì nó có thể bị ghi đè để tiếp tục dòng. Việc thụt lề cũng giúp biết mã nào thuộc về chức năng nào khi chúng ta sử dụng dấu ngoặc nhọn trong các ngôn ngữ lập trình khác trong Python;
Trong Pep8, quy tắc là sử dụng dấu cách thay cho tab, vì tên của quy tắc sử dụng 4 dấu cách liên tiếp để thụt lề. Nếu cả hai quy tắc này được sử dụng cùng một lúc thì điều này sẽ gây ra lỗi khiến trình thông dịch đưa ra cảnh báo
Thí dụMã số
n = 10
if n> 5:
print “n is greater”
đầu ra
Câu lệnh in theo sau dấu thụt đầu dòng trong chương trình trên vì câu lệnh “nếu” là đúng thì chỉ có câu lệnh in được thực thi. Nếu không duy trì thụt đầu dòng thích hợp, thì nó sẽ báo lỗi. Đầu ra của đoạn mã trên không có thụt đầu dòng sẽ là
Mã số
n = 10
if n> 5:
print "n is greater"
đầu ra
2. quy ước đặt tên
Có một vài quy tắc đặt tên trong mã hóa Python Pep8 để làm cho mã dễ đọc hơn và ít phức tạp hơn. Có nhiều thứ trong mã được đặt tên, chẳng hạn như nó có thể là biến, lớp, phương thức, gói, v.v. Cách tốt nhất luôn là chọn tên cho các biến hoặc hàm hoặc lớp hoặc gói có ý nghĩa hoặc chúng liên quan đến chính xác chức năng của mã bởi vì sử dụng một số tên ngẫu nhiên để khai báo sẽ dẫn đến sự mơ hồ hoặc rất khó khăn khi gỡ lỗi . Hãy để chúng tôi xem một số kiểu đặt tên được sử dụng khi viết mã
Đối với các biến, bạn có thể có một chữ cái hoặc từ hoặc bất kỳ số lượng từ nào được phân tách bằng dấu gạch dưới, nhưng tất cả các chữ cái này phải ở dạng chữ thường. Chúng ta có thể sử dụng tất cả các chữ cái viết thường để đặt tên cho các hàm hoặc phương thức, có thể là một từ hoặc bất kỳ số lượng từ nào được phân tách bằng dấu gạch dưới. Đối với hằng cũng tương tự như biến nhưng tất cả các chữ cái phải viết hoa. Đối với lớp, quy tắc đặt tên là bạn có thể sử dụng một từ hoặc nhiều từ, nhưng không có sự tách biệt giữa nhiều từ này và nó tuân theo cách viết hoa lạc đà như ClassName. Đối với các gói cũng tuân theo quy tắc đặt tên của lớp, nhưng thay vì viết hoa lạc đà, tất cả các chữ cái của tên gói phải được viết thường. Tất cả những điều này có thể được chứng minh trong đoạn mã dưới đây
Thí dụMã số
class ClassName: #Class naming rule
C = 1 #Constat naming rule
the_variable = 2020; # variable naming rule
print["The constant value is:", C]
def the_method[self]: # method naming rule
print["I'm inside class "]
def insideclass[self]:
print["The Variable: ",ClassName.the_variable]
self.the_method[]
n = ClassName[]
n.insideclass[]
đầu ra
3. Chuỗi tài liệu
Đây còn được gọi là chuỗi tài liệu có chuỗi tài liệu được đặt trong cả dấu ngoặc đơn và dấu ngoặc kép, được sử dụng để xác định chương trình hoặc bất kỳ chức năng hoặc phương thức cụ thể nào. Các quy tắc để áp dụng chuỗi tài liệu cho mã là
Đầu tiên, trích dẫn được sử dụng để ghi lại một khối mã được thực hiện trong ba trích dẫn, chẳng hạn như
“Đây là một chuỗi tài liệu””” và thứ hai là nơi nó có thể được sử dụng để viết chuỗi tài liệu cho tất cả các hàm, mô-đun công khai, lớp và phương thức. Lưu ý rằng các tài liệu không cần thiết cho các phương thức không công khai; . Ngoài ra, lưu ý rằng ba dấu ngoặc kép cuối xuất hiện trên cùng một dòng đối với chuỗi tài liệu một dòng, nhưng đối với nhiều dòng, bộ ba dấu ngoặc kép cuối xuất hiện ở vị trí kết thúc chuỗi tài liệu
Thí dụMã số
def addition:
a, b = 0
“““ This method is for addition”””
c = a + b
“““ This method is for addition and it is addition of two numbers.
This has a formula as shown above c = a+ b
And the addition of two numbers gives the result which is stored in c”””
return c
Một số quy tắc tài liệu Pep8 khác dành cho mã Python là
- Chúng tôi phải sử dụng mã hóa UTF-8 hoặc ASCII để mã hóa Python và đó cũng là mã hóa mặc định dành cho môi trường quốc tế
- Ngoài ra còn có một quy tắc về nơi sử dụng khoảng trắng. Khoảng cách chỉ nên được sử dụng xung quanh các toán tử và sau dấu phẩy, không được sử dụng bên trong dấu ngoặc hoặc trước dấu phẩy
- Không nên sử dụng các ký tự để nhận dạng vì chúng có thể dẫn đến nhầm lẫn, chẳng hạn như chữ “l” có thể được coi là chữ thường “l” [el] và chữ hoa “I” và chữ “O” viết hoa O [oh
Có nhiều tính năng tài liệu khác nhau của Pep8 để thiết kế và tạo kiểu mã Python
Sự kết luận
Pep8 là một trong những công cụ viết mã Python chính xác với các quy tắc và kiểu mã phù hợp. Tài liệu về các quy tắc này rất quan trọng đối với các nhà phát triển để viết mã dễ đọc hơn và ít phức tạp hơn đối với những người khác. Cần lưu ý một điểm, thông thường việc viết mã phù hợp với nhận xét và tài liệu phù hợp sẽ hữu ích vì mã chỉ được viết một lần nhưng nhiều người đọc chúng nhiều lần, vì vậy nhà phát triển cần viết mã sao cho dễ đọc và dễ hiểu đối với người khác. Chính vì vậy Pep8 sẽ giúp bạn làm điều này
Bài viết được đề xuất
Đây là hướng dẫn về Python PEP8. Ở đây chúng tôi thảo luận về Giới thiệu và hoạt động của python pep8 cùng với các ví dụ khác nhau và cách triển khai mã của nó. bạn cũng có thể xem các bài viết sau để tìm hiểu thêm –