Python中Literal 類型的具體使用
更新時間：2025年11月02日 10:44:46 作者：言之。
Python的Literal類型用于精確指定變量或參數(shù)必須等于特定的字面量值,允許精確指定變量或函數(shù)參數(shù)必須等于特定的字面量值,下面就來具體介紹一下如何使用,感興趣的可以了解一下
概述
Literal 類型是 Python 類型提示系統(tǒng)中的一個特殊形式，用于定義字面量類型（也稱為值類型）。它允許開發(fā)者指定一個變量或函數(shù)參數(shù)必須等于特定的字面量值（或幾個可能的值之一）。
Literal 類型為 Python 的類型系統(tǒng)提供了更精細的控制能力，特別是在需要精確指定允許的特定值時非常有用。
導入
from typing import Literal
基本用法
1. 單個字面量值
def always_true() -> Literal[True]:
return True
def open_read_only(file: str) -> str:
# 返回值只能是特定的字符串字面量
return "success"
def process_status(code: Literal[200, 404, 500]) -> str:
if code == 200:
return "OK"
elif code == 404:
return "Not Found"
else:
return "Server Error"
2. 多個字面量值
# 定義文件模式類型
FileMode = Literal['r', 'rb', 'w', 'wb', 'a', 'ab']
def open_file(filepath: str, mode: FileMode) -> str:
# 實現(xiàn)文件打開邏輯
return f"File {filepath} opened with mode {mode}"
# 正確的用法
open_file("data.txt", "r") # 通過類型檢查
open_file("data.bin", "rb") # 通過類型檢查
# 錯誤的用法（類型檢查器會報錯）
open_file("data.txt", "read") # 錯誤：'read' 不是有效的字面量
- 在pycharm中能直接提醒
3. 布爾值和數(shù)字字面量
# 布爾值字面量
def toggle_switch(state: Literal[True, False]) -> Literal[True, False]:
return not state
# 數(shù)字字面量
Direction = Literal[0, 90, 180, 270]
def rotate_sprite(angle: Direction) -> None:
print(f"Rotating to {angle} degrees")
# 混合類型字面量
ResponseType = Literal["success", "error", 200, 404]
高級用法
1. 與聯(lián)合類型結(jié)合使用
from typing import Union, Literal # 更靈活的類型定義 StatusCode = Union[Literal[200], Literal[404], Literal[500]] ApiResponse = Union[dict, Literal["timeout"], Literal["error"]]
2. 枚舉的替代方案
# 使用 Literal 代替簡單的枚舉
Color = Literal["red", "green", "blue", "yellow"]
def set_traffic_light(color: Color) -> None:
if color == "red":
print("Stop")
elif color == "green":
print("Go")
elif color == "yellow":
print("Caution")
# 類型檢查會捕獲拼寫錯誤
set_traffic_light("red") # 正確
set_traffic_light("reed") # 類型檢查錯誤
3. 在類和方法中使用
from typing import Literal, ClassVar
class DatabaseConnection:
# 類常量使用 Literal 類型
SUPPORTED_VERSIONS: ClassVar[Literal["1.0", "2.0", "3.0"]] = ["1.0", "2.0", "3.0"]
def __init__(self, version: Literal["1.0", "2.0", "3.0"]):
self.version = version
@classmethod
def get_status(cls) -> Literal["connected", "disconnected", "error"]:
return "connected"
實際應用場景
1. API 響應處理
from typing import Literal, TypedDict
class ApiResponse(TypedDict):
status: Literal["success", "error"]
data: dict
message: str
def handle_response(response: ApiResponse) -> None:
if response["status"] == "success":
process_data(response["data"])
else:
log_error(response["message"])
2. 配置驗證
from typing import Literal, TypedDict
class AppConfig(TypedDict):
environment: Literal["development", "staging", "production"]
log_level: Literal["DEBUG", "INFO", "WARNING", "ERROR"]
database: Literal["mysql", "postgresql", "sqlite"]
def validate_config(config: AppConfig) -> bool:
# 配置驗證邏輯
return True
3. 狀態(tài)機實現(xiàn)
from typing import Literal
OrderState = Literal["pending", "confirmed", "shipped", "delivered", "cancelled"]
class Order:
def __init__(self):
self.state: OrderState = "pending"
def transition(self, new_state: OrderState) -> None:
# 狀態(tài)轉(zhuǎn)換邏輯
valid_transitions = {
"pending": ["confirmed", "cancelled"],
"confirmed": ["shipped", "cancelled"],
"shipped": ["delivered"],
}
if new_state in valid_transitions.get(self.state, []):
self.state = new_state
else:
raise ValueError(f"Invalid transition from {self.state} to {new_state}")
限制和注意事項
- 不可子類化:
Literal[...]不能被繼承 - 運行時限制: 在運行時，
Literal接受任意值作為參數(shù)，但類型檢查器可能會施加限制 - 哈希性要求: 字面量參數(shù)應該是可哈希的
- 類型檢查器支持: 不同的類型檢查器（如 mypy、pyright）可能對
Literal有不同的支持程度
最佳實踐
- 使用有意義的字面量: 選擇能夠清晰表達意圖的字面量值
- 避免過度使用: 只在確實需要限制為特定值時使用
Literal - 與枚舉比較: 對于固定的值集合，考慮使用
Enum是否更合適 - 文檔化: 為使用
Literal的復雜類型添加適當?shù)奈臋n
示例總結(jié)
from typing import Literal, Union
# 各種使用場景的完整示例
HttpMethod = Literal["GET", "POST", "PUT", "DELETE", "PATCH"]
StatusCode = Literal[200, 201, 400, 401, 403, 404, 500]
ApiResponse = Union[dict, list, Literal["error", "timeout", "unauthorized"]]
def make_api_request(
method: HttpMethod,
endpoint: str,
expected_status: StatusCode = 200
) -> ApiResponse:
"""
發(fā)起 API 請求
Args:
method: HTTP 方法，必須是預定義的字面量值
endpoint: API 端點
expected_status: 期望的 HTTP 狀態(tài)碼
Returns:
API 響應數(shù)據(jù)或錯誤字面量
"""
# 實現(xiàn)請求邏輯
if method == "GET":
return {"data": "sample response"}
else:
return "error"
Literal 類型為 Python 的類型系統(tǒng)提供了更精細的控制能力，特別是在需要精確指定允許的特定值時非常有用。
到此這篇關于Python中Literal 類型的具體使用的文章就介紹到這了,更多相關Python Literal類型內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要介紹了Python SQLAlchemy庫的使用方法，幫助大家更好的利用python處理數(shù)據(jù)庫，感興趣的朋友可以了解下2020-10-10
loguru 是一個 Python 簡易且強大的第三方日志記錄庫,該庫旨在通過添加一系列有用的功能來解決標準記錄器的注意事項,從而減少 Python 日志記錄的痛苦,感興趣的可以了解一下2025-10-10
這篇文章主要介紹了python 實現(xiàn)壓縮和解壓縮的示例，幫助大家更好的利用python處理文件，感興趣的朋友可以了解下2020-09-09
今天小編就為大家分享一篇關于Python中asyncio與aiohttp入門教程，小編覺得內(nèi)容挺不錯的，現(xiàn)在分享給大家，具有很好的參考價值，需要的朋友一起跟隨小編來看看吧2018-10-10
Python中關于元組 集合 字符串 函數(shù) 異常處理的全面詳解
本篇文章介紹了我在學習python過程中對元組、集合、字符串、函數(shù)、異常處理的總結(jié)，通讀本篇對大家的學習或工作具有一定的價值，需要的朋友可以參考下2021-10-10
這篇文章主要介紹了如何利用python實現(xiàn)Simhash算法，文章基于python的相關資料展開Simhash算法的詳細介紹，具有一定的參考價值，感興趣的小伙伴可以參考一下2022-06-06
Python中torch.load()加載模型以及其map_location參數(shù)詳解
torch.load()作用用來加載torch.save()保存的模型文件,下面這篇文章主要給大家介紹了關于Python中torch.load()加載模型以及其map_location參數(shù)的相關資料,需要的朋友可以參考下2022-09-09
這篇文章主要介紹了Python3.5面向?qū)ο笈c繼承,結(jié)合圖文與實例形式詳細分析了Python3.5面向?qū)ο笈c繼承的相關概念、原理、實現(xiàn)方法及操作注意事項,需要的朋友可以參考下2019-04-04
Scrapy是一個為了爬取網(wǎng)站數(shù)據(jù)提取結(jié)構(gòu)性數(shù)據(jù)而編寫的應用框架。這篇文章主要介紹了Python安裝scrapy的正確姿勢,非常不錯，具有一定的參考借鑒價值，需要的朋友可以參考下2018-06-06
這篇文章主要介紹了pygame實現(xiàn)俄羅斯方塊游戲基礎的第3篇，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-10-10