6 thực hành tốt nhất với Python để viết mã tốt hơn

Thực hành tốt nhất với Python 

1. Thực hành tốt nhất trong Python để nâng cao chất lượng mã

Viết mã dễ đọc và có tổ chức có thể tạo ra khác biệt và nâng cao triển vọng sự nghiệp của bạn. Dù với người mới, lập trình có thể trông như một quy trình máy móc và phức tạp, nhưng sự thật là lập trình là một nghệ thuật. 

Có nhiều mẹo bạn có thể áp dụng để nâng cao chất lượng mã trong Python. Dưới đây là danh sách một số điểm đáng chú ý nhất.

Quy tắc thụt đầu dòng nghiêm ngặt

Thụt đầu dòng là khoảng trắng ở đầu một dòng mã. Trong khi ở các ngôn ngữ khác, thụt đầu dòng chỉ nhằm tăng khả năng đọc, thì trong Python, thụt đầu dòng là bắt buộc. Python dùng thụt đầu dòng để mở một khối mã. Cụ thể, 4 khoảng trắng liên tiếp cho mỗi cấp thụt, như trong đoạn mã sau:

for number in [1,2,3,4]:
    if number % 2 == 0:
        print(number)
    else:
        continue

Độ dài dòng tối đa

PEP 8 khuyến nghị không dòng nào dài quá 79 ký tự. Điều này hợp lý vì dòng ngắn dễ đọc hơn. Ngoài ra, độ dài này cho phép bạn mở nhiều tệp cạnh nhau.

Dòng trống

Bao quanh các định nghĩa hàm và lớp ở cấp cao nhất bằng hai dòng trống. Định nghĩa phương thức bên trong một lớp được bao quanh bởi một dòng trống. Có thể dùng thêm dòng trống (tiết chế) để tách nhóm các hàm liên quan. Cuối cùng, hãy dùng dòng trống trong hàm (tiết chế) để biểu thị các phần logic. 

Dùng linter và công cụ định dạng tự động

Thành thạo mã cần thời gian. Chú ý mọi chi tiết khi lập trình có thể khó và tốn thời gian. May mắn là máy móc, đặc biệt là linter và formatter, có thể giúp đảm bảo chất lượng mã. 

Linter thực hiện phân tích tĩnh mã nguồn và kiểm tra sai lệch ngữ nghĩa. Formatter là công cụ tương tự, cố gắng cấu trúc lại khoảng trắng, độ dài dòng, vị trí đối số, v.v. để đảm bảo mã của bạn trông nhất quán giữa các tệp hoặc dự án. Python cung cấp cho bạn rất nhiều linter và formatter để lựa chọn.

Ghi nhớ các nguyên tắc

Dù một số quy tắc trên khá rõ ràng, lập trình thường là câu chuyện về gu và trực giác. Để trở thành một nghệ sĩ viết mã, bạn nên biết một số nguyên tắc nền tảng của Python. Một ví dụ điển hình là Zen of Python, được bàn riêng trong một bài viết khác.  

2. Thực hành tốt nhất về logging trong Python

Logging là cách theo dõi các sự kiện xảy ra khi phần mềm chạy. Đặc biệt khi ứng dụng lớn dần và phức tạp hơn, logging trở thành kỹ thuật trọng yếu cho phát triển, gỡ lỗi, vận hành và theo dõi hiệu năng.  

Mô-đun logging là một phần của Thư viện Chuẩn của Python từ phiên bản 2.3 để giải quyết các thực hành logging. Đây là gói ưu tiên của hầu hết lập trình viên Python khi nói về logging và được mô tả chi tiết trong PEP 282.

Về tinh thần, logging giống với hàm Print. Tuy nhiên, print thiếu nhiều thông tin có thể hữu ích cho lập trình viên. Logging có thể ghi lại dấu thời gian và số dòng nơi lỗi xảy ra. Nó cũng có thể ghi lỗi hoặc bất kỳ thông tin nào vào tệp, socket, v.v.

Để import mô-đun, bạn chỉ cần chạy đoạn mã sau:

import logging

Không phải mọi thông điệp log đều giống nhau. Thật vậy, mô-đun cung cấp một hệ cấp độ log theo mức độ nghiêm trọng của thông điệp. Cụ thể như sau:

• NOTSET (0): Nghĩa là mọi thông điệp đều sẽ được ghi.
• Debug (10): Hữu ích để chẩn đoán vấn đề trong mã. 
• Info (20): Có thể dùng để xác nhận rằng không có lỗi trong mã. Một trường hợp dùng tốt ở mức info là theo dõi tiến độ huấn luyện mô hình machine learning. 
• Warning (30): Chỉ dấu cho một vấn đề có thể xảy ra trong tương lai. Ví dụ, cảnh báo có thể được đưa ra cho một mô-đun có thể bị ngừng hỗ trợ trong tương lai hoặc cảnh báo thiếu RAM. 
• Error (40): Lỗi nghiêm trọng trong mã; có thể là lỗi cú pháp, lỗi tràn bộ nhớ, hoặc exception. 
• Critical (50): Lỗi có thể khiến chương trình ngừng hoạt động hoặc thoát đột ngột.

import logging
logging.info('This message is just informative')
logging.debug('My missions is to provide information about debugging.')
logging.critical("A Critical Logging Message")

Nói như vậy, dưới đây là danh sách sáu thực hành tốt nhất để xử lý logging trong Python.  

Dùng log thay vì print

Chúng ta đã nói logs cung cấp thông tin tương tự như hàm print. Tuy nhiên, logs mạnh mẽ hơn nhiều và có thể cung cấp thông tin chi tiết hơn. 

Dùng hàm Print có thể hấp dẫn, nhất là khi bạn chưa quen với quy trình logging, nhưng logs luôn là lựa chọn an toàn hơn. Chúng phù hợp hơn cho việc mở rộng và xử lý các ứng dụng phức tạp. 

Có rất nhiều hướng dẫn và tài liệu trên web. Ví dụ, hướng dẫn logging này của DataCamp có thể là thứ bạn cần để bắt đầu.

Dùng mô-đun logging 

Đây là lựa chọn mặc định của hầu hết lập trình viên Python. Điều này có nghĩa mô-đun được bảo trì tốt và có cộng đồng lớn hỗ trợ, luôn có câu trả lời cho thắc mắc của bạn.

Chọn cấp độ logging một cách khôn ngoan

Mô-đun logging đi kèm sáu cấp độ thông điệp khác nhau. Mỗi cấp được thiết kế cho một mục đích cụ thể. Càng tuân thủ chúng, bạn và người dùng càng dễ hiểu điều gì đang diễn ra trong mã.

Ghi kèm dấu thời gian khi logging

Đây là tính năng quan trọng của logs mà print không có. Bên cạnh việc biết vấn đề xuất hiện ở đâu, điều quan trọng là biết khi nào nó xảy ra. Dấu thời gian là đồng minh lớn nhất của bạn trong những tình huống này. Hãy đảm bảo dùng định dạng chuẩn để ghi dấu thời gian, tức định dạng ISO-8601.

Dọn dẹp thùng log

Dùng các lớp RotatingFileHandler, như TimedRotatingFileHandler, thay vì FileHandler, để lưu trữ, nén hoặc xóa các tệp log cũ nhằm tránh vấn đề dung lượng bộ nhớ. Các lớp này sẽ dọn chỗ khi đạt ngưỡng kích thước hoặc điều kiện thời gian.

3. Thực hành tốt nhất về viết chú thích trong Python

Chú thích rất quan trọng để ghi chú cho những người đọc mã của chúng ta sau này. Dù khó xác định chính xác nên chú thích mã thế nào, vẫn có một số hướng dẫn chúng ta có thể theo: 

• Bất kỳ chú thích nào mâu thuẫn với mã còn tệ hơn không chú thích. Vì vậy, rất quan trọng phải cập nhật mã và chú thích để tránh tạo ra sự không nhất quán. 
• Chú thích phải là câu đầy đủ, viết hoa chữ cái đầu tiên. 
• Cố gắng viết chú thích bằng tiếng Anh. Dù mọi người tự do viết chú thích bằng ngôn ngữ họ cho là phù hợp, khuyến nghị là dùng tiếng Anh. 
• Đảm bảo chú thích của bạn rõ ràng và dễ hiểu với những người nói ngôn ngữ bạn đang sử dụng.

Có hai loại chú thích: chú thích khối và chú thích nội dòng. 

Chú thích khối giải thích phần mã theo sau nó. Thông thường, bạn thụt chú thích khối cùng mức với khối mã. Mỗi dòng của chú thích khối bắt đầu bằng # và một khoảng trắng, như sau:

# This is a block comment
print('Welcome to DataCamp!")

Mặt khác, chú thích nội dòng xuất hiện cùng hàng với mã. Chú thích nội dòng phải cách câu lệnh ít nhất hai khoảng trắng. Tương tự chú thích khối, chú thích nội dòng bắt đầu bằng dấu thăng (#) và theo sau là một khoảng trắng và một chuỗi văn bản. 

print ("Have you ever tried Python?") # This is an inline comment

4. Thực hành tốt nhất về docstring trong Python

Docstring là một chuỗi ký tự xuất hiện như câu lệnh đầu tiên trong định nghĩa mô-đun, hàm, lớp hoặc phương thức. Thông thường, bạn dùng chuỗi tài liệu để tự động tạo tài liệu cho mã. Do đó, docstring có thể được truy cập lúc chạy thông qua thuộc tính đặc biệt obj.__doc__ của đối tượng đó.

Để nhất quán, docstring luôn được đặt trong ba dấu ngoặc kép kép (""").

Có hai dạng docstring: một dòng và nhiều dòng. Docstring một dòng dành cho các trường hợp thực sự hiển nhiên. Chúng nên vừa trong một dòng. Ví dụ sau minh họa docstring một dòng trong hàm multiply():

def multiply(x, y):
    """ Return the product of two numbers """
    result = x * y
    return result

Ngược lại, docstring nhiều dòng có thể trải dài nhiều dòng. Docstring như vậy nên mô tả chức năng của script, cú pháp dòng lệnh, biến môi trường và các tệp. Thông điệp hướng dẫn có thể khá chi tiết và đủ để người dùng mới có thể dùng lệnh đúng cách.

def calculate_salary(hours, price=20):
    """ Return the salary according to the hours worked

    Arguments:
    hours: total hours investe
    price: price of each hours worked. Minimum price is 20 dollars
    """
    salary = hours * price
    return salary

Giải thích chi tiết hơn về docstring có thể tìm thấy trong PEP257.

5. Thực hành tốt nhất về tài liệu trong Python

Trong khi chú thích quan trọng để các lập trình viên khác bạn đang làm việc cùng hiểu mã của bạn, tài liệu được viết nhằm giúp cộng đồng người dùng tiềm năng học cách sử dụng phần mềm của bạn. Đây là bước quan trọng: dẫu phần mềm của bạn tốt đến đâu, nếu tài liệu không đủ tốt, hoặc tệ hơn là thiếu, mọi người sẽ không dùng nó. 

Việc bao gồm tệp README luôn là thực hành tốt, nhất là khi bạn làm dự án mới. Các tệp này thường là điểm vào chính cho người đọc mã của bạn và bao gồm thông tin chung cho cả người dùng và người bảo trì dự án. 

Dù súc tích, tệp README nên giải thích mục đích của dự án, URL nguồn chính của phần mềm và thông tin ghi công.

Tương tự, bạn luôn nên bao gồm tệp setup.py, đảm bảo phần mềm hoặc thư viện được đóng gói và phân phối bằng Distutils, tiêu chuẩn phân phối mô-đun Python.

Ngoài ra, nếu phần mềm của bạn cần các phụ thuộc hoặc gói khác để chạy, bạn nên bao gồm tệp requirements.txt mô tả các phụ thuộc cần thiết và phiên bản của chúng.

Cuối cùng, bạn có thể bổ sung bất kỳ thông tin nào khác mà bạn cho là phù hợp với người dùng tiềm năng. Ví dụ, việc cung cấp ví dụ về cách gói hoặc hàm của bạn hoạt động là một thực hành tốt. 

6. Thực hành tốt nhất về môi trường ảo Python 

Để đảm bảo trật tự và tính nhất quán trong các dự án dữ liệu của bạn, tạo một môi trường ảo cho mỗi dự án bạn bắt đầu là một thực hành tốt. 

Môi trường ảo, còn gọi là virtualenv, giúp tách biệt và cô lập các phiên bản Python và thư viện cần cho dự án của bạn cùng với các phiên bản pip liên quan. Điều này cho phép người dùng cuối cài đặt và quản lý bộ phần mềm và phiên bản riêng, độc lập với những gì hệ thống cung cấp. 

Để tạo virtualenv, trước tiên chúng ta cần cài gói cần thiết, gõ dòng lệnh sau trong terminal:

pip install virtualenv

Để tạo virtualenv mới, đoạn mã sau sẽ thực hiện. Chúng ta đặt tên virtualenv mới là “new_venv”

python3 -m venv /path/to/new/virtual/environment/new_venv

Quy ước đặt tên trong Python

Một trong những lỗi phổ biến nhất ở lập trình viên Python mới bắt đầu là đặt tên không đúng cho biến, lớp, hàm, v.v. Quy ước đặt tên là yếu tố then chốt để đảm bảo khả năng đọc của mã.

PEP 8 giải thích cách chuẩn để đặt tên các đối tượng trong Python. Theo hướng dẫn, các mô-đun và gói mới (gồm cả framework bên thứ ba) nên được viết theo các tiêu chuẩn này, nhưng tính nhất quán nội bộ được ưu tiên nếu một thư viện hiện có theo phong cách khác.

Bạn nên tránh dùng tên quá chung chung hoặc quá dài dòng. Ngoài ra, định danh dùng trong thư viện chuẩn phải tương thích ASCII, như mô tả trong PEP 3131.

# Bad naming:
data_structure, ríos_españa, dictionary_with_countries_and_capitals
# Good naming:
user_profile, stop_words, global_emissions_df

Dưới đây là danh sách quy ước đặt tên cho các đối tượng phổ biến nhất trong Python.

• Gói và mô-đun
• Tên gói và mô-đun nên viết thường toàn bộ
• Chỉ dùng dấu gạch dưới trong tên gói và mô-đun nếu giúp tăng khả năng đọc.
• Lớp
• Tên lớp nên theo quy ước UpperCaseCamelCase
• Tuy nhiên, các lớp dựng sẵn của Python thường là các từ viết thường
• Biến thể hiện, phương thức và hàm
• Tên biến thể hiện nên viết thường toàn bộ
• Dùng dấu gạch dưới để thêm từ mới cho các biến
• Biến thể hiện không công khai nên bắt đầu bằng một dấu gạch dưới
• Hằng số
• Tên hằng phải viết hoa toàn bộ
• Dùng dấu gạch dưới để thêm từ mới cho hằng

Kết luận

Nắm vững các thực hành tốt nhất trong Python là điều thiết yếu để viết mã sạch, hiệu quả và dễ bảo trì. Bằng cách tuân theo các hướng dẫn về chất lượng mã, logging, chú thích và tài liệu, đồng thời sử dụng các công cụ như môi trường ảo, bạn có thể đảm bảo dự án của mình dễ quản lý, dễ hợp tác và dễ mở rộng.

Khi bạn tiếp tục nâng cao kỹ năng Python, hãy cân nhắc khám phá thêm các tài nguyên học sâu hơn để đào sâu hiểu biết về Python và dải ứng dụng rộng lớn của nó. Nếu bạn đang tìm kiếm lộ trình có cấu trúc, hãy xem các tài nguyên sau:

• Học Python như thế nào: Hướng dẫn để trở thành chuyên gia – Hướng dẫn chuyên sâu này sẽ giúp bạn định hướng quá trình học, cung cấp mẹo và kỹ thuật để làm chủ Python.
• Giới thiệu về Python cho Developer – Hoàn hảo cho các developer muốn bắt đầu với Python, khóa học này bao phủ các khái niệm cốt lõi và tính năng của ngôn ngữ theo cách thực hành, trực quan.
• Giới thiệu về Khoa học Dữ liệu bằng Python – Khi bạn đã thoải mái với Python, hãy dấn sâu vào khoa học dữ liệu với khóa học thân thiện cho người mới bắt đầu này. Nó bao gồm các thư viện và kỹ thuật thiết yếu để làm việc với dữ liệu trong Python.