Hướng dẫn convention in python
Coding Conventions: Thời còn là sinh viên mình cũng đã từng được nghe qua khái niệm này từ các tiền bối, mình hiểu nôm na nó là những quy tắc khi code và mình cũng không quá quan tâm đến nó vì lúc đó mình chỉ nghĩ đơn giản là: Project mình làm chỉ phục vụ cho việc qua môn nên là Show 1. Coding Conventions là gì?Như trên mình cũng đã chia sẻ.
2. Python và PEP 8
2.1. Naming conventions (quy tắc đặt tên)Khi những đứa
trẻ được sinh ra, một trong những thứ mà ba mẹ chúng quan tâm đầu tiên đến chính là đặt tên cho chúng. Và trong lập trình cũng vậy, từ những class, những function,... hay đến cả từng biến nhỏ chúng ta đều phải đặt tên. Và đặt tên làm sao để cho người khác nhìn vào có thể hiểu được mục đích của từng class, function đó là gì cũng là một quy tắc.
Trong
Mình cũng có một vài lưu ý khi đặt tên:
2.2. Identation (thụt lề, thụt dòng)Sự thụt lề, hoặc khoảng trắng đầu dòng cực quan trọng trong
2.3. Code Layout (giao diện code)Một giao diện code đẹp có vai trò rất quan trọng đối với khả năng đọc code của bạn. Chúng ta thêm khoảng trắng để cải thiện khả năng đọc code của bạn. Trong PEP 8, một dòng được đề xuất giới hạn bởi 79 kí tự. Blank lines (Dòng trống)Thêm các khoảng trắng hoặc dòng trống có thể cải thiện đáng kể khả năng đọc code của bạn. Code mà tập trung lại, 1 mạch từ đầu
tới cuối thì trông thật là kinh hoàng đúng không nào? Hoặc ngược lại, quá nhiều dòng trống trong code của bạn làm cho nó trông rất thưa thớt và người đọc có thể phải scroll nhiều hơn mức cần thiết. Dưới đây là 3 hướng dẫn chính về cách sử dụng Các function trong cùng một class cách nhau một dòng trống
Các class, function không cùng một class cách nhau hai dòng trống
Sử dụng các dòng trống bên trong các function để chia thành các blocks codeTrong một function, có thể cúng ta xử lý rất nhiều logic mà không thể tách ra thành các function riêng biệt, vì vậy chúng ta cần thêm một dòng trống để ngăn cách các đoạn code.
Tối đa hóa độ dài dòng và ngắt dòng
Tất nhiên, việc giữ các câu lệnh có 79 ký tự trở xuống không phải
lúc nào cũng có thể.
Hoặc có thể sử dụng dấu gạch chéo để ngắt dòng:
3. Install packageTrong phần trên, mình đã lấy một số ví dụ về các quy tắc được quy định trong
3.1. Chuẩn bịĐể kiểm tra các tool có
thật sự hoạt động thì trước tiên mình sẽ tạo 2 file
3.2. flake8
Và chúng ta thử kiểm tra xem 2 files trên chúng ta đã vi phạm những quy tắc gì nha:
Và việc của chúng ta giờ đây đơn giản hơn rồi. Hãy xem từng lỗi là gì và sửa lại chúng thôi. Trước khi sửa lại, chúng ta hãy thử xem lỗi đầu tiên chúng ta gặp phải là gì nhé. Đó là lỗi "ký tự trên 1 dòng đã vượt quá 79". Tùy vào từng dự án chúng ta có thể quy định cho một số lỗi tương tự như vậy trong file
Và chúng ta hãy cùng kiểm tra lại một lần nữa:
Như vậy, lỗi quá ký tự trên 1 dòng đã biến mất. Ngoài ra, các bạn cũng có thể tự định nghĩa lại một số quy tắc cho dự án của mình bằng cách tham khảo ở đây nhé. 3.3. isortTrong
Và
Tương tự như flake8, chúng ta cũng kiểm tra xem đang gặp lỗi import ra sao nhé?
Chúng ta thấy, ở file
và kiểm tra lại
Như vậy, lỗi import này đã được xử lý hoàn toàn gọn gàng. Lời kếtBài viết của mình hôm nay dừng lại ở đây thôi, cảm ơn các bạn đã đọc và ủng hộ mình. |