HOWTO · Python
檢查索引是否存在於 Python 列表中
本教程演示了使用列表範圍和 IndexError 異常檢查 Python 列表中是否存在索引
本頁內容
Python 列表採用從 0 開始的索引,因此第一個項目的索引是 0。若索引為非負數,請在存取前檢查 0 <= index < len(items)。如果目的是直接取得項目,請在該次存取周圍捕捉 IndexError。Python 也接受從列表尾端開始計算的索引,因此完整有效範圍是 -len(items) 到 len(items) - 1。
使用範圍檢查索引
當你需要在存取或更新列表前驗證索引時,可以使用範圍檢查。條件 0 <= index < len(items) 包含第一個索引,但不包含列表長度,因為 len(items) 是最後一個位置之後的索引。
執行以下範例。程式碼中的字串與輸出標籤維持英文,因此結果也會以英文顯示:
本節中的程式碼以及顯示的標籤或輸出仍為英文。
items = ["Apple", "Banana", "Pineapple"]
index = 1
if 0 <= index < len(items):
print(f"{items[index]} is at index {index}.")
else:
print(f"No item at index {index}.")
Banana is at index 1.
當預期索引為非負數且符合整數索引的形式時,這種檢查方式很清楚。比較只檢查數值是否落在範圍內,並不會確認該值能否作為有效的列表索引。例如,1.0 符合 0 <= index < len(items),但 items[1.0] 會引發 TypeError。因此,在把檢查結果為真視為存取一定可行之前,請另外驗證索引型別。這項檢查也不接受負索引,雖然 Python 列表存取支援負索引。如果呼叫端可能傳入負值,請使用下方可重複使用的輔助函式所採用的完整範圍,或依照應用程式的需求正規化索引。
索引超出列表範圍時,條件會傳回 False。以下範例使用同一個三項列表展示兩種結果;程式碼中的字串與輸出標籤維持英文:
items = ["Apple", "Banana", "Pineapple"]
for index in (1, 3):
if 0 <= index < len(items):
print(f"{index}: {items[index]}")
else:
print(f"{index}: no item")
1: Banana
3: no item
透過捕捉 IndexError 檢查索引
如果目的是取得項目,可以直接嘗試存取,並處理 IndexError。請讓 try 區塊保持精簡,確保處理程式只涵蓋可能引發這種索引錯誤的操作。其他錯誤,例如索引不是整數時引發的 TypeError,不會被這個處理程式隱藏。
程式碼中的字串與輸出標籤維持英文,因此結果也會以英文顯示。
本節中的程式碼以及顯示的標籤或輸出仍為英文。
items = ["Apple", "Banana", "Pineapple"]
index = 2
try:
item = items[index]
except IndexError:
print("No item at that index.")
else:
print(f"Found {item} at index {index}.")
Found Pineapple at index 2.
這種寫法會在同一個操作中檢查存取並取得值。如果程式的其他部分可能在檢查與使用之間變更列表,單獨的範圍檢查就無法保證之後的存取一定成功;若這種情況可能發生,請捕捉存取時的錯誤。
以下範例展示索引超過最後一個位置時的處理方式;程式碼中的字串與輸出標籤維持英文:
items = ["Apple", "Banana", "Pineapple"]
index = 3
try:
item = items[index]
except IndexError:
print(f"No item at index {index}.")
No item at index 3.
建立可重複使用的索引檢查
如果多處都需要相同的檢查,可以把完整的列表索引範圍放進輔助函式。若列表長度為 n,Python 接受從 -n 起、但不包含 n 的索引。
程式碼中的字串與輸出標籤維持英文,因此結果也會以英文顯示。
本節中的程式碼以及顯示的標籤或輸出仍為英文。
def index_exists(items, index):
return -len(items) <= index < len(items)
fruits = ["Apple", "Banana", "Pineapple"]
for index in (2, -1, 3, -4):
print(f"{index}: {index_exists(fruits, index)}")
2: True
-1: True
3: False
-4: False
這個輔助函式假設索引符合整數索引的形式,並且只檢查其範圍,其中也包含有效的負索引。像 1.0 這樣的浮點數可能通過比較,但 items[1.0] 仍會引發 TypeError;因此,在把 True 視為存取一定可行的證據之前,請另外驗證索引型別。檢查結果為真後,可使用 items[index] 取得項目。如果列表可能在檢查與存取之間變更,檢查結果就可能失效;此時請改用 try 區塊包住存取操作。
處理負索引與無效索引
負索引會從列表尾端往前計算:-1 代表最後一個項目,而 -len(items) 代表第一個項目。空列表沒有任何有效索引,因為其長度為零,在包含 -0、但不包含 0 的範圍內沒有整數。使用超出有效範圍的值存取列表時,會引發 IndexError。
索引也必須符合整數索引的形式。像 1.0 這樣的浮點數可能通過範圍比較,但不是有效的列表索引,存取時會引發 TypeError;字串也不是有效的列表索引。只捕捉 IndexError 無法處理這些型別不符的情況。如果函式會接收來自程式外部的資料,請在依賴範圍檢查之前另外驗證型別,或處理介面承諾接受的特定錯誤。不要任意把值轉成整數,除非你已確認截斷或解析符合呼叫端的意圖。
選擇合適的方法
如果你想在存取非負索引前先分支處理,請使用範圍檢查;如果介面包含負索引,則使用完整的負到正索引範圍。當存取本身就是要執行的操作,而且你想在沒有對應項目時作出處理,請使用 try/except IndexError。如果多處會重複使用相同的範圍檢查,可採用可重複使用的輔助函式;但它不會取得項目,也無法防止列表變更後的存取失敗。
IndexError 特別表示整數索引超出列表可用的位置。非整數索引會引發 TypeError,因此驗證不受信任的輸入時,請留意這項差異。這些方法能讓你依需求選擇預先檢查位置,或在實際存取時處理失敗。