Thông báo: Download 4 khóa học Python từ cơ bản đến nâng cao tại đây.
Sử dụng Enum aliases và @enum.unique trong Python
Trong lập trình Python, liệt kê (enumeration) là một cách tiện lợi để gán các tên có ý nghĩa cho các giá trị hằng số. Tuy nhiên, trong một số trường hợp, bạn có thể muốn sử dụng nhiều tên khác nhau cho cùng một giá trị, gọi là alias của thành viên liệt kê. Để đảm bảo tính nhất quán và duy trì sự độc đáo của các giá trị trong liệt kê, Python cung cấp công cụ decorator @enum.unique
. Trong bài viết này, bạn sẽ học cách sử dụng alias trong liệt kê cũng như cách áp dụng decorator @enum.unique
để đảm bảo rằng không có thành viên nào trùng lặp giá trị trong liệt kê.
Giới thiệu về alias trong liệt kê (enum aliases) bằng Python
Theo định nghĩa, giá trị của các thành viên trong liệt kê là duy nhất. Tuy nhiên, bạn có thể tạo ra nhiều tên thành viên khác nhau với cùng một giá trị.
Ví dụ, đoạn mã dưới đây định nghĩa một liệt kê Color
:
from enum import Enum class Color(Enum): RED = 1 CRIMSON = 1 SALMON = 1 GREEN = 2 BLUE = 3
Trong ví dụ này, liệt kê Color
có các thành viên RED
, CRIMSON
, và SALMON
cùng chia sẻ giá trị là 1.
Bài viết này được đăng tại [free tuts .net]
Khi bạn định nghĩa nhiều thành viên trong liệt kê với cùng một giá trị, Python không tạo ra các thành viên khác nhau mà sẽ coi những tên khác là alias của thành viên chính.
Trong ví dụ trên, RED
là thành viên chính, trong khi CRIMSON
và SALMON
là alias của thành viên RED
.
Các lệnh sau đây trả về giá trị True
vì CRIMSON
và SALMON
là alias của RED
:
print(Color.RED is Color.CRIMSON) print(Color.RED is Color.SALMON)
Kết quả:
True True
Khi bạn tìm kiếm thành viên theo giá trị, Python luôn trả về thành viên chính, không phải alias. Ví dụ:
print(Color(1))
Kết quả:
Color.RED
Khi duyệt qua các thành viên của một liệt kê có alias, bạn chỉ nhận được các thành viên chính, không bao gồm alias. Ví dụ:
for color in Color: print(color)
Kết quả chỉ trả về ba thành viên chính:
Color.RED Color.GREEN Color.BLUE
Để lấy tất cả các thành viên, bao gồm cả alias, bạn có thể sử dụng thuộc tính __members__
của lớp liệt kê. Ví dụ:
from enum import Enum from pprint import pprint class Color(Enum): RED = 1 CRIMSON = 1 SALMON = 1 GREEN = 2 BLUE = 3 pprint(Color.__members__)
Kết quả:
mappingproxy({'BLUE': <Color.BLUE: 3>, 'CRIMSON': <Color.RED: 1>, 'GREEN': <Color.GREEN: 2>, 'RED': <Color.RED: 1>, 'SALMON': <Color.RED: 1>})
Kết quả trên cho thấy rằng CRIMSON
và SALMON
tham chiếu đến cùng một đối tượng với RED
:
<Color.RED: 1>
Khi nào nên sử dụng alias trong liệt kê?
Alias trong liệt kê có thể hữu ích trong một số tình huống nhất định. Ví dụ, giả sử bạn phải xử lý API từ hai hệ thống khác nhau và mỗi hệ thống có mã trạng thái phản hồi khác nhau nhưng cùng mang ý nghĩa tương tự như bảng sau:
Hệ thống 1 | Hệ thống 2 | Ý nghĩa |
---|---|---|
REQUESTING | PENDING | Yêu cầu đang được xử lý |
OK | FULFILLED | Yêu cầu đã hoàn thành thành công |
NOT_OK | REJECTED | Yêu cầu bị từ chối |
Để chuẩn hóa mã trạng thái từ các hệ thống này, bạn có thể sử dụng alias trong liệt kê như sau:
Hệ thống của bạn | Hệ thống 1 | Hệ thống 2 | Ý nghĩa |
---|---|---|---|
IN_PROGRESS | REQUESTING | PENDING | Yêu cầu đang được xử lý |
SUCCESS | OK | FULFILLED | Yêu cầu đã hoàn thành thành công |
ERROR | NOT_OK | REJECTED | Yêu cầu bị từ chối |
Đoạn mã sau đây định nghĩa liệt kê ResponseStatus
với các alias:
from enum import Enum class ResponseStatus(Enum): # in progress IN_PROGRESS = 1 REQUESTING = 1 PENDING = 1 # success SUCCESS = 2 OK = 2 FULFILLED = 2 # error ERROR = 3 NOT_OK = 3 REJECTED = 3
Bạn có thể so sánh mã phản hồi từ hệ thống 1 để kiểm tra xem yêu cầu có thành công hay không:
code = 'OK' if ResponseStatus[code] is ResponseStatus.SUCCESS: print('Yêu cầu đã hoàn thành thành công')
Kết quả:
Yêu cầu đã hoàn thành thành công
Tương tự, bạn có thể kiểm tra mã phản hồi từ hệ thống 2:
code = 'FULFILLED' if ResponseStatus[code] is ResponseStatus.SUCCESS: print('Yêu cầu đã hoàn thành thành công')
Kết quả:
Yêu cầu đã hoàn thành thành công
Decorator @enum.unique trong Python
Để định nghĩa một liệt kê không có alias, bạn có thể cẩn thận sử dụng các giá trị duy nhất cho các thành viên. Ví dụ:
from enum import Enum class Day(Enum): MON = 'Monday' TUE = 'Tuesday' WED = 'Wednesday' THU = 'Thursday' FRI = 'Friday' SAT = 'Saturday' SUN = 'Sunday'
Tuy nhiên, bạn có thể vô tình sử dụng cùng một giá trị cho hai thành viên như sau:
class Day(Enum): MON = 'Monday' TUE = 'Monday' WED = 'Wednesday' THU = 'Thursday' FRI = 'Friday' SAT = 'Saturday' SUN = 'Sunday'
Trong ví dụ này, TUE
là alias của MON
, điều mà có thể bạn không mong muốn.
Để đảm bảo một liệt kê không có alias, bạn có thể sử dụng decorator @enum.unique
từ module enum
.
Khi bạn sử dụng @enum.unique
, Python sẽ ném ra một ngoại lệ nếu liệt kê chứa alias.
Ví dụ, đoạn mã sau sẽ gây ra lỗi ValueError
:
import enum from enum import Enum @enum.unique class Day(Enum): MON = 'Monday' TUE = 'Monday' WED = 'Wednesday' THU = 'Thursday' FRI = 'Friday' SAT = 'Saturday' SUN = 'Sunday'
Lỗi:
ValueError: duplicate values found in <enum 'Day'>: TUE -> MON
Kết bài
Khi một liệt kê có các thành viên khác nhau nhưng cùng một giá trị, thành viên đầu tiên sẽ được coi là thành viên chính, còn các thành viên sau sẽ là alias của nó. Điều này có thể hữu ích trong một số trường hợp, nhưng cũng có thể gây ra sự nhầm lẫn nếu không được kiểm soát chặt chẽ. Bằng cách sử dụng decorator @enum.unique
, bạn có thể đảm bảo rằng mỗi thành viên trong liệt kê có một giá trị duy nhất, giúp tránh các lỗi không mong muốn và đảm bảo tính rõ ràng, nhất quán trong mã nguồn.