內建型別¶
以下章節描述了直譯器中內建的標準型別。
主要內建型別為數字、序列、對映、class(類別)、實例和例外。
有些集合類別是 mutable(可變的)。那些用於原地 (in-place) 加入、移除或重新排列其成員且不回傳特定項的 method(方法),也只會回傳None
而非集合實例自己。
某些操作已被多種物件型別支援;特別是實務上所有物件都已經可以做相等性比較、真值檢測及被轉換為字串(使用repr()
函式或稍有差異的str()
函式),後者為當物件傳入print()
函式印出時在背後被呼叫的函式。
真值檢測¶
任何物件都可以進行檢測以判斷是否為真值,以便在if
或while
條件中使用,或是作為如下所述 boolean(布林)運算之運算元所用。
預設情況下,一個物件會被視為真值,除非它的 class 定義了會回傳False
的__bool__()
method 或是定義了會回傳零的__len__()
method。[1] 以下列出了大部分會被視為 false 的內建物件:
定義為 false 之常數:
None
與False
任何數值型別的零:
0
、0.0
、0j
、Decimal(0)
、Fraction(0,1)
空的序列和集合:
''
、()
、[]
、{}
、set()
、range(0)
除非另有特別說明,產生 boolean 結果的操作或內建函式都會回傳0
或False
作為假值、1
或True
作為真值。(重要例外: boolean 運算or
和and
回傳的是其中一個運算元。)
Boolean(布林)運算 ---and
,or
,not
¶
下方為 Boolean 運算,按優先順序排序:
運算 | 結果 | 註解 |
---|---|---|
| 假如x 為真,則x,否則y | (1) |
| 假如x 為假,則x,否則y | (2) |
| 假如x 為假,則 | (3) |
註解:
這是一個短路運算子,所以他只有在第一個引數為假時,才會對第二個引數求值。
這是一個短路運算子,所以他只有在第一個引數為真時,才會對第二個引數求值。
not
比非 Boolean 運算子有較低的優先權,因此nota==b
可直譯為not(a==b)
,而a==notb
會導致語法錯誤。
比較運算¶
在 Python 裡共有 8 種比較運算。他們的優先順序都相同(皆優先於 Boolean 運算)。比較運算可以任意的串連;例如,x<y<=z
等同於x<yandy<=z
,差異只在於前者的y 只有被求值一次(但在這兩個例子中,當x<y
為假時,z 皆不會被求值)。
這個表格統整所有比較運算:
運算 | 含義 |
---|---|
| 小於 |
| 小於等於 |
| 大於 |
| 大於等於 |
| 等於 |
| 不等於 |
| 物件識別性 |
| 否定的物件識別性 |
除了不同的數值型別外,不同型別的物件不能進行相等比較。運算子==
總有定義,但在某些物件型別(例如,class 物件)時,運算子會等同於is
。其他運算子<
、<=
、>
及>=
皆僅在有意義的部分有所定義;例如,當其中一個引數為複數時,將引發一個TypeError
的例外。
一個 class 的非相同實例通常會比較為不相等,除非 class 有定義__eq__()
method。
一個 class 的實例不可以與其他相同 class 的實例或其他物件型別進行排序,除非 class 定義足夠的 method ,包含__lt__()
、__le__()
、__gt__()
及__ge__()
(一般來說,使用__lt__()
及__eq__()
就可以滿足常規意義上的比較運算子)。
無法自定義is
與isnot
運算子的行為;這兩個運算子也可以運用在任意兩個物件且不會引發例外。
此外,擁有相同的語法優先序的in
及notin
兩種運算皆被可疊代物件或者有實作__contains__()
method 的型別所支援。
數值型別 ---int
、float
、complex
¶
數值型別共有三種:整數、浮點數 及複數。此外,Boolean 為整數中的一個子型別。整數有無限的精度。浮點數通常使用 C 裡面的double 實作。關於在你程式所運作的機器上之浮點數的精度及內部表示法可以在sys.float_info
進行查找。複數包含實數及虛數的部分,這兩部分各自是一個浮點數。若要從一個複數z 提取這兩部分,需使用z.real
及z.imag
。(標準函式庫包含額外的數值型別,像是fractions.Fraction
表示有理數,而decimal.Decimal
表示可由使用者制定精度的浮點數。)
數字是由字面數值或內建公式及運算子的結果所產生的。未經修飾的字面數值(含十六進位、八進位及二進位數值)會 yield 整數。包含小數點或指數符號的字面數值會 yield 浮點數。在數值後面加上'j'
或是'J'
會 yield 一個虛數(意即一個實數為 0 的複數)。你也可以將整數與浮點數相加以得到一個有實部與虛部的複數。
Python 完全支援混和運算:當一個二元運算子的運算元有不同數值型別時,「較窄」型別的運算元會被拓寬到另一個型別的運算元;在此處,整數窄於浮點數,浮點數又窄於複數。不同型別的數字間的比較等同於這些數字的精確值進行比較。[2]
建構函式:int()
、float()
及complex()
可以用來產生特定型別的數字。
所有數值型別(除複數外)皆支援以下的運算(有關運算的先後順序,詳見Operator precedence):
運算 | 結果 | 註解 | 完整文件 |
---|---|---|---|
| x 及y 的加總 | ||
| x 及y 的相減 | ||
| x 及y 的相乘 | ||
| x 及y 相除之商 | ||
| x 及y 的整數除法 | (1)(2) | |
|
| (2) | |
| x 的負數 | ||
| x 不變 | ||
| x 的絕對值或量 (magnitude) | ||
| 將x 轉為整數 | (3)(6) | |
| 將x 轉為浮點數 | (4)(6) | |
| 一個複數,其實部為re,虛部為im。im 預設為零。 | (6) | |
| 為複數c 的共軛複數 | ||
| 一對 | (2) | |
| x 的y 次方 | (5) | |
| x 的y 次方 | (5) |
註解:
也被稱為整數除法。對於型別為
int
的運算元來說,結果之型別會是int
。對於型別為float
的運算元來說,結果之型別會是float
。一般來說,結果會是一個整數,但其型別不一定會是int
。結果總是會往負無窮大的方向取整數值:1//2
為0
、(-1)//2
為-1
、1//(-2)
為-1
及(-1)//(-2)
為0
。不可用於複數。在適當情形下,可使用
abs()
轉換為浮點數。從
float
轉換為int
會導致截斷並排除小數部分。詳見math.floor()
及math.ceil()
以了解更多轉換方式。浮點數也接受帶有可選的前綴 "+" 及 "-" 的 "nan" 及 "inf" 字串,其分別代表非數字(NaN)及正負無窮。
Python 將
pow(0,0)
及0**0
定義為1
這是程式語言的普遍做法。字面數值接受包含數字
0
到9
或任何等效的 Unicode 字元(具有Nd
屬性的 code points(碼位))。請參閱Unicode 標準以了解具有
Nd
屬性的 code points 完整列表。
所有numbers.Real
型別(int
及float
)也適用下列運算:
運算 | 結果 |
---|---|
x 截斷為 | |
x 進位至小數點後第n 位,使用偶數捨入法。若省略n ,則預設為 0。 | |
小於等於x 的最大 | |
大於等於x 的最小 |
關於其他數值運算請詳見math
及cmath
modules(模組)。
整數型別的位元運算¶
位元運算只對整數有意義。位元運算的計算結果就如同對二的補數執行無窮多個符號位元。
二元位元運算的優先順序皆低於數字運算,但高於比較運算;一元運算~
與其他一元數值運算有一致的優先順序(+
及-
)。
這個表格列出所有位元運算並以優先順序由先至後排序。
運算 | 結果 | 註解 |
---|---|---|
| x 及y 的位元或 | (4) |
| x 及y 的位元邏輯互斥或 | (4) |
| x 及y 的位元與 | (4) |
| x 往左移動n 個位元 | (1)(2) |
| x 往右移動n 個位元 | (1)(3) |
| 反轉x 的位元 |
註解:
負數位移是不被允許並會引發
ValueError
的錯誤。向左移動n 個位元等同於乘以
pow(2,n)
。向右移動n 個位元等同於向下除法除以
pow(2,n)
。在有限的二的補數表示法中執行這些計算(一個有效位元寬度為
1+max(x.bit_length(),y.bit_length())
或以上)並至少有一個額外的符號擴展位元,便足以得到與無窮多個符號位元相同的結果。
整數型別的附加 methods¶
整數型別實作了numbers.Integral
抽象基底類別。此外,它提供了一些 methods:
- int.bit_length()¶
回傳以二進位表示一個整數所需要的位元數,不包括符號及首位的零:
>>>n=-37>>>bin(n)'-0b100101'>>>n.bit_length()6
更準確來說,若
x
非為零,則x.bit_length()
會得出滿足2**(k-1)<=abs(x)<2**k
的單一正整數k
。同樣地,當abs(x)
足夠小到能正確地取得捨入的對數,則k=1+int(log(abs(x),2))
。若x
為零,則x.bit_length()
會回傳0
。等同於:
defbit_length(self):s=bin(self)# binary representation: bin(-37) --> '-0b100101's=s.lstrip('-0b')# remove leading zeros and minus signreturnlen(s)# len('100101') --> 6
在 3.1 版被加入.
- int.bit_count()¶
回傳在絕對值表示的二進位中 1 的個數。這也被稱作母體計數。舉例來說:
>>>n=19>>>bin(n)'0b10011'>>>n.bit_count()3>>>(-n).bit_count()3
等同於:
defbit_count(self):returnbin(self).count("1")
在 3.10 版被加入.
- int.to_bytes(length=1,byteorder='big',*,signed=False)¶
回傳表示一個整數的一列位元組。
>>>(1024).to_bytes(2,byteorder='big')b'\x04\x00'>>>(1024).to_bytes(10,byteorder='big')b'\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00'>>>(-1024).to_bytes(10,byteorder='big',signed=True)b'\xff\xff\xff\xff\xff\xff\xff\xff\xfc\x00'>>>x=1000>>>x.to_bytes((x.bit_length()+7)//8,byteorder='little')b'\xe8\x03'
此整數會使用length 位元組表示,並且預設為 1。如果該整數無法用給定的位元組數來表示,則會引發
OverflowError
。byteorder 引數決定了用來表示整數的位元組順序並且預設為
"big"
。如果 byteorder 是"big"
,最重要的位元組位於位元組陣列的開頭。如果 byteorder 是"little"
,最重要的位元組位於位元組陣列的結尾。signed 引數決定是否使用二的補數來表示整數。如果signed 是
False
並且給定了一個負整數,則會引發OverflowError
。signed 的預設值是False
。預設值可以方便地將一個整數轉換為單一位元組物件:
>>>(65).to_bytes()b'A'
然而,使用預設引數時,不要嘗試轉換大於 255 的值,否則你將會得到一個
OverflowError
。等同於:
defto_bytes(n,length=1,byteorder='big',signed=False):ifbyteorder=='little':order=range(length)elifbyteorder=='big':order=reversed(range(length))else:raiseValueError("byteorder must be either 'little' or 'big'")returnbytes((n>>i*8)&0xffforiinorder)
在 3.2 版被加入.
在 3.11 版的變更:為
length
和byteorder
添加了預設引數值。
- classmethodint.from_bytes(bytes,byteorder='big',*,signed=False)¶
回傳由給定的位元組陣列表示的整數。
>>>int.from_bytes(b'\x00\x10',byteorder='big')16>>>int.from_bytes(b'\x00\x10',byteorder='little')4096>>>int.from_bytes(b'\xfc\x00',byteorder='big',signed=True)-1024>>>int.from_bytes(b'\xfc\x00',byteorder='big',signed=False)64512>>>int.from_bytes([255,0,0],byteorder='big')16711680
引數bytes 必須是一個類位元組物件或是一個產生位元組的可疊代物件。
byteorder 引數決定了用來表示整數的位元組順序並且預設為
"big"
。如果byteorder 是"big"
,最重要的位元組位於位元組陣列的開頭。如果byteorder 是"little"
,最重要的位元組位於位元組陣列的結尾。若要請求主機系統的本機位元組順序,請使用sys.byteorder
作為位元組順序值。signed 引數指示是否使用二的補數來表示整數。
等同於:
deffrom_bytes(bytes,byteorder='big',signed=False):ifbyteorder=='little':little_ordered=list(bytes)elifbyteorder=='big':little_ordered=list(reversed(bytes))else:raiseValueError("byteorder must be either 'little' or 'big'")n=sum(b<<i*8fori,binenumerate(little_ordered))ifsignedandlittle_orderedand(little_ordered[-1]&0x80):n-=1<<8*len(little_ordered)returnn
在 3.2 版被加入.
在 3.11 版的變更:為
byteorder
添加了預設引數值。
- int.as_integer_ratio()¶
回傳一對整數,其比率等於原始整數並且有一個正分母。整數(整個數值)的整數比率總是整數作為分子,並且
1
作為分母。在 3.8 版被加入.
- int.is_integer()¶
回傳
True
。為了與float.is_integer()
的鴨子型別相容而存在。在 3.12 版被加入.
浮點數的附加 methods¶
浮點數型別實作了numbers.Real
抽象基底類別。浮點數也有下列附加 methods。
- float.as_integer_ratio()¶
回傳一對整數,其比率完全等於原始浮點數。比率是在最低條件下並且有一個正分母。在無窮大時引發
OverflowError
,在 NaN 時引發ValueError
。
- float.is_integer()¶
如果浮點數實例是有限的並且具有整數值,則回傳
True
,否則回傳False
:>>>(-2.0).is_integer()True>>>(3.2).is_integer()False
兩個 methods 皆支援十六進位字串之間的轉換。由於 Python 的浮點數內部以二進位數值儲存,將浮點數轉換為或從十進位 字串通常涉及一個小的四捨五入誤差。相反地,十六進位字串允許精確表示和指定浮點數。這在除錯和數值工作中可能會有用。
- float.hex()¶
回傳浮點數的十六進位字串表示。對於有限浮點數,此表示方式總是包含一個前導
0x
及一個尾部p
和指數。
- classmethodfloat.fromhex(s)¶
Class method 回傳由十六進位字串s 表示的浮點數。字串s 可能有前導及尾部的空白。
請注意float.hex()
是一個實例 method,而float.fromhex()
是一個 class method。
一個十六進位字串的形式如下:
[sign]['0x']integer['.'fraction]['p'exponent]
其中可選的sign
可以是+
或-
,integer
和fraction
是十六進位數字的字串,而exponent
是一個十進位整數並且有一個可選的前導符號。大小寫不重要,並且整數或小數部分至少有一個十六進位數字。這個語法與 C99 標準的第 6.4.4.2 節指定的語法相似,也與 Java 1.5 以後的語法相似。特別是float.hex()
的輸出可用作 C 或 Java 程式碼中的十六進位浮點數文字,並且 C 的%a
格式字元或 Java 的Double.toHexString
產生的十六進位字串可被float.fromhex()
接受。
請注意指數是以十進位而非十六進位寫入,並且它給出了乘以係數的 2 的次方。例如,十六進位字串0x3.a7p10
表示浮點數(3+10./16+7./16**2)*2.0**10
,或3740.0
:
>>>float.fromhex('0x3.a7p10')3740.0
對3740.0
應用反向轉換會給出一個不同的十六進位字串,它表示相同的數字:
>>>float.hex(3740.0)'0x1.d380000000000p+11'
數值型別的雜湊¶
對於數字x
和y
,可能是不同型別,當x==y
時,hash(x)==hash(y)
是一個要求( 詳見__hash__()
method 的文件以獲得更多細節)。為了實作的便利性和效率跨越各種數值型別(包括int
、float
、decimal.Decimal
和fractions.Fraction
)Python 的數值型別的雜湊是基於一個數學函式,它對於任何有理數都是定義的,因此適用於所有int
和fractions.Fraction
的實例,以及所有有限的float
和decimal.Decimal
的實例。基本上,這個函式是由簡化的 modulo(模數)P
給出的一個固定的質數P
。P
的值作為sys.hash_info
的modulus
屬性提供給 Python。
目前在具有 32 位元 C longs 的機器上所使用的質數是P=2**31-1
,而在具有 64 位元 C longs 的機器上為P=2**61-1
。
以下是詳細的規則:
如果
x=m/n
是一個非負的有理數,並且n
不可被P
整除,則將hash(x)
定義為m*invmod(n,P)%P
。其中invmod(n,P)
為n
對模數P
的倒數。如果
x=m/n
是一個非負的有理數,並且n
可被P
整除(但m
不行),則n
沒有 inverse modulo(模倒數)P
,並且不適用於上述規則;在這種情況下,將hash(x)
定義為常數值sys.hash_info.inf
。如果
x=m/n
是一個負的有理數,則將hash(x)
定義為-hash(-x)
。如果結果的雜湊是-1
,則將其替換為-2
。特定值
sys.hash_info.inf
和-sys.hash_info.inf
(分別)被用作正無窮大或負無窮大的雜湊值。對於一個
complex
值z
,實部和虛部的雜湊值藉由hash(z.real)+sys.hash_info.imag*hash(z.imag)
的計算進行組合,對2**sys.hash_info.width
取模數使其介於range(-2**(sys.hash_info.width-1),2**(sys.hash_info.width-1))
。同樣地,如果結果是-1
,則將其替換為-2
。
為了闡明上述規則,這裡有一些 Python 程式碼範例,等同於內建的雜湊,用於計算有理數、float
或complex
的雜湊:
importsys,mathdefhash_fraction(m,n):"""Compute the hash of a rational number m / n. Assumes m and n are integers, with n positive. Equivalent to hash(fractions.Fraction(m, n)). """P=sys.hash_info.modulus# Remove common factors of P. (Unnecessary if m and n already coprime.)whilem%P==n%P==0:m,n=m//P,n//Pifn%P==0:hash_value=sys.hash_info.infelse:# Fermat's Little Theorem: pow(n, P-1, P) is 1, so# pow(n, P-2, P) gives the inverse of n modulo P.hash_value=(abs(m)%P)*pow(n,P-2,P)%Pifm<0:hash_value=-hash_valueifhash_value==-1:hash_value=-2returnhash_valuedefhash_float(x):"""Compute the hash of a float x."""ifmath.isnan(x):returnobject.__hash__(x)elifmath.isinf(x):returnsys.hash_info.infifx>0else-sys.hash_info.infelse:returnhash_fraction(*x.as_integer_ratio())defhash_complex(z):"""Compute the hash of a complex number z."""hash_value=hash_float(z.real)+sys.hash_info.imag*hash_float(z.imag)# do a signed reduction modulo 2**sys.hash_info.widthM=2**(sys.hash_info.width-1)hash_value=(hash_value&(M-1))-(hash_value&M)ifhash_value==-1:hash_value=-2returnhash_value
Boolean 型別 -bool
¶
Boolean 值代表 truth values(真值)。bool
型別有兩個常數實例:True
和False
。
內建函式bool()
將任何值轉換為 boolean 值,如果該值可以被直譯為一個 truth value(真值)(見上面的真值檢測章節)。
對於邏輯運算,使用boolean 運算子and
、or
和not
。當將位元運算子&
、|
、^
應用於兩個 boolean 值時,它們會回傳一個等同於邏輯運算 "and"、"or"、"xor" 的 boolean 值。然而,應該優先使用邏輯運算子and
、or
和!=
而不是&
、|
和^
。
在 3.12 版之後被棄用:位元反轉運算子~
的使用已被棄用並且將在 Python 3.16 中引發錯誤。
bool
是int
的子類別(見數值型別 --- int、float、complex)。在許多數值情境中,False
和True
分別像整數 0 和 1 一樣。然而,不鼓勵依賴這一點;請使用int()
進行顯式轉換。
疊代器型別¶
Python 支援對容器的疊代概念。這是實作兩種不同的 methods;這些方法被用於允許使用者自定義的 classes 以支援疊代。序列則總是支援這些疊代 methods,在下方有更詳細的描述。
需要為容器物件定義一個 method 來提供可疊代物件支援:
- container.__iter__()¶
回傳一個疊代器物件。該物件需要支援下述的疊代器協定。如果一個容器支援不同型別的疊代,則可以提供額外的 methods 來專門請求這些疊代型別的疊代器。(支援多種形式疊代的物件的一個例子是支援廣度優先和深度優先遍歷的樹結構。)此 method 對應 Python/C API 中 Python 物件的型別結構的
tp_iter
插槽。
疊代器物件本身需要支援下列兩個 methods,他們一起形成了疊代器協定:
- iterator.__iter__()¶
回傳疊代器物件本身。這是為了允許容器和疊代器都可以與
for
和in
在陳述式中使用。此 method 對應於 Python/C API 中 Python 物件的型別結構的tp_iter
插槽。
- iterator.__next__()¶
從疊代器回傳下一個項目。如果沒有更多項目,則引發
StopIteration
例外。此 method 對應於 Python/C API 中Python 物件的型別結構的tp_iternext
插槽。
Python 定義了幾個疊代器物件來支援對一般和特定序列型別、字典和其他更專門的形式的疊代。這些特定型別除了實作疊代器協定外並不重要。
一旦疊代器的__next__()
method 引發StopIteration
,則它必須在後續呼叫中繼續這樣做。不遵守此屬性的實作被認為是有問題的。
Generator Types¶
Python'sgenerators provide a convenient way to implement the iteratorprotocol. If a container object's__iter__()
method is implemented as agenerator, it will automatically return an iterator object (technically, agenerator object) supplying the__iter__()
and__next__()
methods.More information about generators can be found inthe documentation forthe yield expression.
Sequence Types ---list
,tuple
,range
¶
There are three basic sequence types: lists, tuples, and range objects.Additional sequence types tailored for processing ofbinary data andtext strings aredescribed in dedicated sections.
Common Sequence Operations¶
The operations in the following table are supported by most sequence types,both mutable and immutable. Thecollections.abc.Sequence
ABC isprovided to make it easier to correctly implement these operations oncustom sequence types.
This table lists the sequence operations sorted in ascending priority. In thetable,s andt are sequences of the same type,n,i,j andk areintegers andx is an arbitrary object that meets any type and valuerestrictions imposed bys.
Thein
andnotin
operations have the same priorities as thecomparison operations. The+
(concatenation) and*
(repetition)operations have the same priority as the corresponding numeric operations.[3]
運算 | 結果 | 註解 |
---|---|---|
| 如果s 的一個項目等於x 則為 | (1) |
| 如果s 的一個項目等於x 則為 | (1) |
| s 和t 的串接 | (6)(7) |
| 等同於將s 加到自己n 次 | (2)(7) |
| s 的第i 項,起始為 0 | (3) |
| slice ofs fromi toj | (3)(4) |
| slice ofs fromi tojwith stepk | (3)(5) |
| s 的長度 | |
| s 中最小的項目 | |
| s 中最大的項目 | |
| index of the first occurrenceofx ins (at or afterindexi and before indexj) | (8) |
| s 中x 的總出現次數 |
Sequences of the same type also support comparisons. In particular, tuplesand lists are compared lexicographically by comparing corresponding elements.This means that to compare equal, every element must compare equal and thetwo sequences must be of the same type and have the same length. (For fulldetails seeComparisons in the language reference.)
Forward and reversed iterators over mutable sequences access values using anindex. That index will continue to march forward (or backward) even if theunderlying sequence is mutated. The iterator terminates only when anIndexError
or aStopIteration
is encountered (or when the indexdrops below zero).
註解:
While the
in
andnotin
operations are used only for simplecontainment testing in the general case, some specialised sequences(such asstr
,bytes
andbytearray
) also usethem for subsequence testing:>>>"gg"in"eggs"True
Values ofn less than
0
are treated as0
(which yields an emptysequence of the same type ass). Note that items in the sequencesare not copied; they are referenced multiple times. This often hauntsnew Python programmers; consider:>>>lists=[[]]*3>>>lists[[], [], []]>>>lists[0].append(3)>>>lists[[3], [3], [3]]
What has happened is that
[[]]
is a one-element list containing an emptylist, so all three elements of[[]]*3
are references to this single emptylist. Modifying any of the elements oflists
modifies this single list.You can create a list of different lists this way:>>>lists=[[]foriinrange(3)]>>>lists[0].append(3)>>>lists[1].append(5)>>>lists[2].append(7)>>>lists[[3], [5], [7]]
Further explanation is available in the FAQ entry如何建立多維度串列?.
Ifi orj is negative, the index is relative to the end of sequences:
len(s)+i
orlen(s)+j
is substituted. But note that-0
isstill0
.The slice ofs fromi toj is defined as the sequence of items with indexk such that
i<=k<j
. Ifi orj is greater thanlen(s)
, uselen(s)
. Ifi is omitted orNone
, use0
. Ifj is omitted orNone
, uselen(s)
. Ifi is greater than or equal toj, the slice isempty.The slice ofs fromi toj with stepk is defined as the sequence ofitems with index
x=i+n*k
such that0<=n<(j-i)/k
. In other words,the indices arei
,i+k
,i+2*k
,i+3*k
and so on, stopping whenj is reached (but never includingj). Whenk is positive,i andj are reduced tolen(s)
if they are greater.Whenk is negative,i andj are reduced tolen(s)-1
ifthey are greater. Ifi orj are omitted orNone
, they become"end" values (which end depends on the sign ofk). Note,k cannot be zero.Ifk isNone
, it is treated like1
.Concatenating immutable sequences always results in a new object. Thismeans that building up a sequence by repeated concatenation will have aquadratic runtime cost in the total sequence length. To get a linearruntime cost, you must switch to one of the alternatives below:
if concatenating
str
objects, you can build a list and usestr.join()
at the end or else write to anio.StringIO
instance and retrieve its value when completeif concatenating
bytes
objects, you can similarly usebytes.join()
orio.BytesIO
, or you can do in-placeconcatenation with abytearray
object.bytearray
objects are mutable and have an efficient overallocation mechanismfor other types, investigate the relevant class documentation
Some sequence types (such as
range
) only support item sequencesthat follow specific patterns, and hence don't support sequenceconcatenation or repetition.index
raisesValueError
whenx is not found ins.Not all implementations support passing the additional argumentsi andj.These arguments allow efficient searching of subsections of the sequence. Passingthe extra arguments is roughly equivalent to usings[i:j].index(x)
, onlywithout copying any data and with the returned index being relative tothe start of the sequence rather than the start of the slice.
Immutable Sequence Types¶
The only operation that immutable sequence types generally implement that isnot also implemented by mutable sequence types is support for thehash()
built-in.
This support allows immutable sequences, such astuple
instances, tobe used asdict
keys and stored inset
andfrozenset
instances.
Attempting to hash an immutable sequence that contains unhashable values willresult inTypeError
.
Mutable Sequence Types¶
The operations in the following table are defined on mutable sequence types.Thecollections.abc.MutableSequence
ABC is provided to make iteasier to correctly implement these operations on custom sequence types.
In the tables is an instance of a mutable sequence type,t is anyiterable object andx is an arbitrary object that meets any typeand value restrictions imposed bys (for example,bytearray
onlyaccepts integers that meet the value restriction0<=x<=255
).
運算 | 結果 | 註解 |
---|---|---|
| itemi ofs is replaced byx | |
| slice ofs fromi tojis replaced by the contents ofthe iterablet | |
| same as | |
| the elements of | (1) |
| removes the elements of | |
| appendsx to the end of thesequence (same as | |
| removes all items froms(same as | (5) |
| creates a shallow copy ofs(same as | (5) |
| extendss with thecontents oft (for themost part the same as | |
| updatess with its contentsrepeatedn times | (6) |
| insertsx intos at theindex given byi(same as | |
| retrieves the item ati andalso removes it froms | (2) |
| removes the first item froms where | (3) |
| reverses the items ofs inplace | (4) |
註解:
Ifk is not equal to
1
,t must have the same length as the slice it is replacing.The optional argumenti defaults to
-1
, so that by default the lastitem is removed and returned.remove()
raisesValueError
whenx is not found ins.The
reverse()
method modifies the sequence in place for economy ofspace when reversing a large sequence. To remind users that it operates byside effect, it does not return the reversed sequence.clear()
andcopy()
are included for consistency with theinterfaces of mutable containers that don't support slicing operations(such asdict
andset
).copy()
is not part of thecollections.abc.MutableSequence
ABC, but most concretemutable sequence classes provide it.在 3.3 版被加入:
clear()
andcopy()
methods.The valuen is an integer, or an object implementing
__index__()
. Zero and negative values ofn clearthe sequence. Items in the sequence are not copied; they are referencedmultiple times, as explained fors*n
underCommon Sequence Operations.
List(串列)¶
Lists are mutable sequences, typically used to store collections ofhomogeneous items (where the precise degree of similarity will vary byapplication).
- classlist([iterable])¶
Lists may be constructed in several ways:
Using a pair of square brackets to denote the empty list:
[]
Using square brackets, separating items with commas:
[a]
,[a,b,c]
Using a list comprehension:
[xforxiniterable]
Using the type constructor:
list()
orlist(iterable)
The constructor builds a list whose items are the same and in the sameorder asiterable's items.iterable may be either a sequence, acontainer that supports iteration, or an iterator object. Ifiterableis already a list, a copy is made and returned, similar to
iterable[:]
.For example,list('abc')
returns['a','b','c']
andlist((1,2,3))
returns[1,2,3]
.If no argument is given, the constructor creates a new empty list,[]
.Many other operations also produce lists, including the
sorted()
built-in.Lists implement all of thecommon andmutable sequence operations. Lists also provide thefollowing additional method:
- sort(*,key=None,reverse=False)¶
This method sorts the list in place, using only
<
comparisonsbetween items. Exceptions are not suppressed - if any comparison operationsfail, the entire sort operation will fail (and the list will likely be leftin a partially modified state).sort()
accepts two arguments that can only be passed by keyword(keyword-only arguments):key specifies a function of one argument that is used to extract acomparison key from each list element (for example,
key=str.lower
).The key corresponding to each item in the list is calculated once andthen used for the entire sorting process. The default value ofNone
means that list items are sorted directly without calculating a separatekey value.The
functools.cmp_to_key()
utility is available to convert a 2.xstylecmp function to akey function.reverse is a boolean value. If set to
True
, then the list elementsare sorted as if each comparison were reversed.This method modifies the sequence in place for economy of space whensorting a large sequence. To remind users that it operates by sideeffect, it does not return the sorted sequence (use
sorted()
toexplicitly request a new sorted list instance).The
sort()
method is guaranteed to be stable. A sort is stable if itguarantees not to change the relative order of elements that compare equal--- this is helpful for sorting in multiple passes (for example, sort bydepartment, then by salary grade).For sorting examples and a brief sorting tutorial, see排序技法.
CPython 實作細節: While a list is being sorted, the effect of attempting to mutate, or eveninspect, the list is undefined. The C implementation of Python makes thelist appear empty for the duration, and raises
ValueError
if it candetect that the list has been mutated during a sort.
Tuples¶
Tuples are immutable sequences, typically used to store collections ofheterogeneous data (such as the 2-tuples produced by theenumerate()
built-in). Tuples are also used for cases where an immutable sequence ofhomogeneous data is needed (such as allowing storage in aset
ordict
instance).
- classtuple([iterable])¶
Tuples may be constructed in a number of ways:
Using a pair of parentheses to denote the empty tuple:
()
Using a trailing comma for a singleton tuple:
a,
or(a,)
Separating items with commas:
a,b,c
or(a,b,c)
Using the
tuple()
built-in:tuple()
ortuple(iterable)
The constructor builds a tuple whose items are the same and in the sameorder asiterable's items.iterable may be either a sequence, acontainer that supports iteration, or an iterator object. Ifiterableis already a tuple, it is returned unchanged. For example,
tuple('abc')
returns('a','b','c')
andtuple([1,2,3])
returns(1,2,3)
.If no argument is given, the constructor creates a new empty tuple,()
.Note that it is actually the comma which makes a tuple, not the parentheses.The parentheses are optional, except in the empty tuple case, orwhen they are needed to avoid syntactic ambiguity. For example,
f(a,b,c)
is a function call with three arguments, whilef((a,b,c))
is a function call with a 3-tuple as the sole argument.Tuples implement all of thecommon sequenceoperations.
For heterogeneous collections of data where access by name is clearer thanaccess by index,collections.namedtuple()
may be a more appropriatechoice than a simple tuple object.
Ranges¶
Therange
type represents an immutable sequence of numbers and iscommonly used for looping a specific number of times infor
loops.
- classrange(stop)¶
- classrange(start,stop[,step])
The arguments to the range constructor must be integers (either built-in
int
or any object that implements the__index__()
specialmethod). If thestep argument is omitted, it defaults to1
.If thestart argument is omitted, it defaults to0
.Ifstep is zero,ValueError
is raised.For a positivestep, the contents of a range
r
are determined by theformular[i]=start+step*i
wherei>=0
andr[i]<stop
.For a negativestep, the contents of the range are still determined bythe formula
r[i]=start+step*i
, but the constraints arei>=0
andr[i]>stop
.A range object will be empty if
r[0]
does not meet the valueconstraint. Ranges do support negative indices, but these are interpretedas indexing from the end of the sequence determined by the positiveindices.Ranges containing absolute values larger than
sys.maxsize
arepermitted but some features (such aslen()
) may raiseOverflowError
.Range examples:
>>>list(range(10))[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]>>>list(range(1,11))[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]>>>list(range(0,30,5))[0, 5, 10, 15, 20, 25]>>>list(range(0,10,3))[0, 3, 6, 9]>>>list(range(0,-10,-1))[0, -1, -2, -3, -4, -5, -6, -7, -8, -9]>>>list(range(0))[]>>>list(range(1,0))[]
Ranges implement all of thecommon sequence operationsexcept concatenation and repetition (due to the fact that range objects canonly represent sequences that follow a strict pattern and repetition andconcatenation will usually violate that pattern).
- start¶
The value of thestart parameter (or
0
if the parameter wasnot supplied)
- stop¶
The value of thestop parameter
- step¶
The value of thestep parameter (or
1
if the parameter wasnot supplied)
The advantage of therange
type over a regularlist
ortuple
is that arange
object will always take the same(small) amount of memory, no matter the size of the range it represents (as itonly stores thestart
,stop
andstep
values, calculating individualitems and subranges as needed).
Range objects implement thecollections.abc.Sequence
ABC, and providefeatures such as containment tests, element index lookup, slicing andsupport for negative indices (seeSequence Types --- list, tuple, range):
>>>r=range(0,20,2)>>>rrange(0, 20, 2)>>>11inrFalse>>>10inrTrue>>>r.index(10)5>>>r[5]10>>>r[:5]range(0, 10, 2)>>>r[-1]18
Testing range objects for equality with==
and!=
comparesthem as sequences. That is, two range objects are considered equal ifthey represent the same sequence of values. (Note that two rangeobjects that compare equal might have differentstart
,stop
andstep
attributes, for examplerange(0)==range(2,1,3)
orrange(0,3,2)==range(0,4,2)
.)
在 3.2 版的變更:Implement the Sequence ABC.Support slicing and negative indices.Testint
objects for membership in constant time instead ofiterating through all items.
在 3.3 版的變更:Define '==' and '!=' to compare range objects based on thesequence of values they define (instead of comparing based onobject identity).
也參考
Thelinspace recipeshows how to implement a lazy version of range suitable for floating-pointapplications.
Text Sequence Type ---str
¶
Textual data in Python is handled withstr
objects, orstrings.Strings are immutablesequences of Unicode code points. String literals arewritten in a variety of ways:
Single quotes:
'allowsembedded"double"quotes'
Double quotes:
"allowsembedded'single'quotes"
Triple quoted:
'''Threesinglequotes'''
,"""Threedoublequotes"""
Triple quoted strings may span multiple lines - all associated whitespace willbe included in the string literal.
String literals that are part of a single expression and have only whitespacebetween them will be implicitly converted to a single string literal. Thatis,("spam""eggs")=="spameggs"
.
SeeString and Bytes literals for more about the various forms of string literal,including supportedescape sequences, and ther
("raw") prefix thatdisables most escape sequence processing.
Strings may also be created from other objects using thestr
constructor.
Since there is no separate "character" type, indexing a string producesstrings of length 1. That is, for a non-empty strings,s[0]==s[0:1]
.
There is also no mutable string type, butstr.join()
orio.StringIO
can be used to efficiently construct strings frommultiple fragments.
在 3.3 版的變更:For backwards compatibility with the Python 2 series, theu
prefix isonce again permitted on string literals. It has no effect on the meaningof string literals and cannot be combined with ther
prefix.
- classstr(object='')¶
- classstr(object=b'',encoding='utf-8',errors='strict')
Return astring version ofobject. Ifobject is notprovided, returns the empty string. Otherwise, the behavior of
str()
depends on whetherencoding orerrors is given, as follows.If neitherencoding norerrors is given,
str(object)
returnstype(object).__str__(object)
,which is the "informal" or nicelyprintable string representation ofobject. For string objects, this isthe string itself. Ifobject does not have a__str__()
method, thenstr()
falls back to returningrepr(object)
.If at least one ofencoding orerrors is given,object should be abytes-like object (e.g.
bytes
orbytearray
). Inthis case, ifobject is abytes
(orbytearray
) object,thenstr(bytes,encoding,errors)
is equivalent tobytes.decode(encoding,errors)
. Otherwise, the bytesobject underlying the buffer object is obtained before callingbytes.decode()
. SeeBinary Sequence Types --- bytes, bytearray, memoryview and緩衝協定 (Buffer Protocol) for information on buffer objects.Passing a
bytes
object tostr()
without theencodingorerrors arguments falls under the first case of returning the informalstring representation (see also the-b
command-line option toPython). For example:>>>str(b'Zoot!')"b'Zoot!'"
For more information on the
str
class and its methods, seeText Sequence Type --- str and theString Methods section below. To outputformatted strings, see thef-string(f 字串) and格式化文字語法sections. In addition, see the文本處理 (Text Processing) 服務 section.
String Methods¶
Strings implement all of thecommon sequenceoperations, along with the additional methods described below.
Strings also support two styles of string formatting, one providing a largedegree of flexibility and customization (seestr.format()
,格式化文字語法 and自訂字串格式) and the other based on Cprintf
style formatting that handles a narrower range of types and isslightly harder to use correctly, but is often faster for the cases it canhandle (printf-style String Formatting).
The文本處理 (Text Processing) 服務 section of the standard library covers a number ofother modules that provide various text related utilities (including regularexpression support in there
module).
- str.capitalize()¶
Return a copy of the string with its first character capitalized and therest lowercased.
在 3.8 版的變更:The first character is now put into titlecase rather than uppercase.This means that characters like digraphs will only have their firstletter capitalized, instead of the full character.
- str.casefold()¶
Return a casefolded copy of the string. Casefolded strings may be used forcaseless matching.
Casefolding is similar to lowercasing but more aggressive because it isintended to remove all case distinctions in a string. For example, the Germanlowercase letter
'ß'
is equivalent to"ss"
. Since it is alreadylowercase,lower()
would do nothing to'ß'
;casefold()
converts it to"ss"
.The casefolding algorithm isdescribed in section 3.13 'Default Case Folding' of the Unicode Standard.
在 3.3 版被加入.
- str.center(width[,fillchar])¶
Return centered in a string of lengthwidth. Padding is done using thespecifiedfillchar (default is an ASCII space). The original string isreturned ifwidth is less than or equal to
len(s)
.
- str.count(sub[,start[,end]])¶
Return the number of non-overlapping occurrences of substringsub in therange [start,end]. Optional argumentsstart andend areinterpreted as in slice notation.
Ifsub is empty, returns the number of empty strings between characterswhich is the length of the string plus one.
- str.encode(encoding='utf-8',errors='strict')¶
Return the string encoded to
bytes
.encoding defaults to
'utf-8'
;seeStandard Encodings for possible values.errors controls how encoding errors are handled.If
'strict'
(the default), aUnicodeError
exception is raised.Other possible values are'ignore'
,'replace'
,'xmlcharrefreplace'
,'backslashreplace'
and anyother name registered viacodecs.register_error()
.SeeError Handlers for details.For performance reasons, the value oferrors is not checked for validityunless an encoding error actually occurs,Python 開發模式 is enabledor adebug build is used.
在 3.1 版的變更:新增關鍵字引數的支援。
在 3.9 版的變更:The value of theerrors argument is now checked inPython 開發模式 andindebug mode.
- str.endswith(suffix[,start[,end]])¶
Return
True
if the string ends with the specifiedsuffix, otherwise returnFalse
.suffix can also be a tuple of suffixes to look for. With optionalstart, test beginning at that position. With optionalend, stop comparingat that position.
- str.expandtabs(tabsize=8)¶
Return a copy of the string where all tab characters are replaced by one ormore spaces, depending on the current column and the given tab size. Tabpositions occur everytabsize characters (default is 8, giving tabpositions at columns 0, 8, 16 and so on). To expand the string, the currentcolumn is set to zero and the string is examined character by character. Ifthe character is a tab (
\t
), one or more space characters are insertedin the result until the current column is equal to the next tab position.(The tab character itself is not copied.) If the character is a newline(\n
) or return (\r
), it is copied and the current column is reset tozero. Any other character is copied unchanged and the current column isincremented by one regardless of how the character is represented whenprinted.>>>'01\t012\t0123\t01234'.expandtabs()'01 012 0123 01234'>>>'01\t012\t0123\t01234'.expandtabs(4)'01 012 0123 01234'
- str.find(sub[,start[,end]])¶
Return the lowest index in the string where substringsub is found withinthe slice
s[start:end]
. Optional argumentsstart andend areinterpreted as in slice notation. Return-1
ifsub is not found.
- str.format(*args,**kwargs)¶
Perform a string formatting operation. The string on which this method iscalled can contain literal text or replacement fields delimited by braces
{}
. Each replacement field contains either the numeric index of apositional argument, or the name of a keyword argument. Returns a copy ofthe string where each replacement field is replaced with the string value ofthe corresponding argument.>>>"The sum of 1 + 2 is{0}".format(1+2)'The sum of 1 + 2 is 3'
See格式化文字語法 for a description of the various formatting optionsthat can be specified in format strings.
備註
When formatting a number (
int
,float
,complex
,decimal.Decimal
and subclasses) with then
type(ex:'{:n}'.format(1234)
), the function temporarily sets theLC_CTYPE
locale to theLC_NUMERIC
locale to decodedecimal_point
andthousands_sep
fields oflocaleconv()
ifthey are non-ASCII or longer than 1 byte, and theLC_NUMERIC
locale isdifferent than theLC_CTYPE
locale. This temporary change affectsother threads.在 3.7 版的變更:When formatting a number with the
n
type, the function setstemporarily theLC_CTYPE
locale to theLC_NUMERIC
locale in somecases.
- str.format_map(mapping,/)¶
Similar to
str.format(**mapping)
, except thatmapping
isused directly and not copied to adict
. This is usefulif for examplemapping
is a dict subclass:>>>classDefault(dict):...def__missing__(self,key):...returnkey...>>>'{name} was born in{country}'.format_map(Default(name='Guido'))'Guido was born in country'
在 3.2 版被加入.
- str.index(sub[,start[,end]])¶
Like
find()
, but raiseValueError
when the substring isnot found.
- str.isalnum()¶
Return
True
if all characters in the string are alphanumeric and there is atleast one character,False
otherwise. A characterc
is alphanumeric if oneof the following returnsTrue
:c.isalpha()
,c.isdecimal()
,c.isdigit()
, orc.isnumeric()
.
- str.isalpha()¶
Return
True
if all characters in the string are alphabetic and there is at leastone character,False
otherwise. Alphabetic characters are those characters definedin the Unicode character database as "Letter", i.e., those with general categoryproperty being one of "Lm", "Lt", "Lu", "Ll", or "Lo". Note that this is differentfrom theAlphabetic property defined in the section 4.10 'Letters, Alphabetic, andIdeographic' of the Unicode Standard.
- str.isascii()¶
Return
True
if the string is empty or all characters in the string are ASCII,False
otherwise.ASCII characters have code points in the range U+0000-U+007F.在 3.7 版被加入.
- str.isdecimal()¶
Return
True
if all characters in the string are decimalcharacters and there is at least one character,False
otherwise. Decimal characters are those that can be used to formnumbers in base 10, e.g. U+0660, ARABIC-INDIC DIGITZERO. Formally a decimal character is a character in the UnicodeGeneral Category "Nd".
- str.isdigit()¶
Return
True
if all characters in the string are digits and there is at least onecharacter,False
otherwise. Digits include decimal characters and digits that needspecial handling, such as the compatibility superscript digits.This covers digits which cannot be used to form numbers in base 10,like the Kharosthi numbers. Formally, a digit is a character that has theproperty value Numeric_Type=Digit or Numeric_Type=Decimal.
- str.isidentifier()¶
Return
True
if the string is a valid identifier according to the languagedefinition, sectionIdentifiers and keywords.keyword.iskeyword()
can be used to test whether strings
is a reservedidentifier, such asdef
andclass
.範例:
>>>fromkeywordimportiskeyword>>>'hello'.isidentifier(),iskeyword('hello')(True, False)>>>'def'.isidentifier(),iskeyword('def')(True, True)
- str.islower()¶
Return
True
if all cased characters[4] in the string are lowercase andthere is at least one cased character,False
otherwise.
- str.isnumeric()¶
Return
True
if all characters in the string are numericcharacters, and there is at least one character,False
otherwise. Numeric characters include digit characters, and all charactersthat have the Unicode numeric value property, e.g. U+2155,VULGAR FRACTION ONE FIFTH. Formally, numeric characters are those with the propertyvalue Numeric_Type=Digit, Numeric_Type=Decimal or Numeric_Type=Numeric.
- str.isprintable()¶
Return
True
if all characters in the string are printable,False
if itcontains at least one non-printable character.Here "printable" means the character is suitable for
repr()
to use inits output; "non-printable" means thatrepr()
on built-in types willhex-escape the character. It has no bearing on the handling of stringswritten tosys.stdout
orsys.stderr
.The printable characters are those which in the Unicode character database(see
unicodedata
) have a general category in group Letter, Mark,Number, Punctuation, or Symbol (L, M, N, P, or S); plus the ASCII space 0x20.Nonprintable characters are those in group Separator or Other (Z or C),except the ASCII space.
- str.isspace()¶
Return
True
if there are only whitespace characters in the string and there isat least one character,False
otherwise.A character iswhitespace if in the Unicode character database(see
unicodedata
), either its general category isZs
("Separator, space"), or its bidirectional class is one ofWS
,B
, orS
.
- str.istitle()¶
Return
True
if the string is a titlecased string and there is at least onecharacter, for example uppercase characters may only follow uncased charactersand lowercase characters only cased ones. ReturnFalse
otherwise.
- str.isupper()¶
Return
True
if all cased characters[4] in the string are uppercase andthere is at least one cased character,False
otherwise.>>>'BANANA'.isupper()True>>>'banana'.isupper()False>>>'baNana'.isupper()False>>>' '.isupper()False
- str.join(iterable)¶
Return a string which is the concatenation of the strings initerable.A
TypeError
will be raised if there are any non-string values initerable, includingbytes
objects. The separator betweenelements is the string providing this method.
- str.ljust(width[,fillchar])¶
Return the string left justified in a string of lengthwidth. Padding isdone using the specifiedfillchar (default is an ASCII space). Theoriginal string is returned ifwidth is less than or equal to
len(s)
.
- str.lower()¶
Return a copy of the string with all the cased characters[4] converted tolowercase.
The lowercasing algorithm used isdescribed in section 3.13 'Default Case Folding' of the Unicode Standard.
- str.lstrip([chars])¶
Return a copy of the string with leading characters removed. Thecharsargument is a string specifying the set of characters to be removed. If omittedor
None
, thechars argument defaults to removing whitespace. Thecharsargument is not a prefix; rather, all combinations of its values are stripped:>>>' spacious '.lstrip()'spacious '>>>'www.example.com'.lstrip('cmowz.')'example.com'
See
str.removeprefix()
for a method that will remove a single prefixstring rather than all of a set of characters. For example:>>>'Arthur: three!'.lstrip('Arthur: ')'ee!'>>>'Arthur: three!'.removeprefix('Arthur: ')'three!'
- staticstr.maketrans(x[,y[,z]])¶
This static method returns a translation table usable for
str.translate()
.If there is only one argument, it must be a dictionary mapping Unicodeordinals (integers) or characters (strings of length 1) to Unicode ordinals,strings (of arbitrary lengths) or
None
. Character keys will then beconverted to ordinals.If there are two arguments, they must be strings of equal length, and in theresulting dictionary, each character in x will be mapped to the character atthe same position in y. If there is a third argument, it must be a string,whose characters will be mapped to
None
in the result.
- str.partition(sep)¶
Split the string at the first occurrence ofsep, and return a 3-tuplecontaining the part before the separator, the separator itself, and the partafter the separator. If the separator is not found, return a 3-tuple containingthe string itself, followed by two empty strings.
- str.removeprefix(prefix,/)¶
If the string starts with theprefix string, return
string[len(prefix):]
. Otherwise, return a copy of the originalstring:>>>'TestHook'.removeprefix('Test')'Hook'>>>'BaseTestCase'.removeprefix('Test')'BaseTestCase'
在 3.9 版被加入.
- str.removesuffix(suffix,/)¶
If the string ends with thesuffix string and thatsuffix is not empty,return
string[:-len(suffix)]
. Otherwise, return a copy of theoriginal string:>>>'MiscTests'.removesuffix('Tests')'Misc'>>>'TmpDirMixin'.removesuffix('Tests')'TmpDirMixin'
在 3.9 版被加入.
- str.replace(old,new,count=-1)¶
Return a copy of the string with all occurrences of substringold replaced bynew. Ifcount is given, only the firstcount occurrences are replaced.Ifcount is not specified or
-1
, then all occurrences are replaced.在 3.13 版的變更:count 現在作為關鍵字引數被支援。
- str.rfind(sub[,start[,end]])¶
Return the highest index in the string where substringsub is found, suchthatsub is contained within
s[start:end]
. Optional argumentsstartandend are interpreted as in slice notation. Return-1
on failure.
- str.rindex(sub[,start[,end]])¶
Like
rfind()
but raisesValueError
when the substringsub is notfound.
- str.rjust(width[,fillchar])¶
Return the string right justified in a string of lengthwidth. Padding isdone using the specifiedfillchar (default is an ASCII space). Theoriginal string is returned ifwidth is less than or equal to
len(s)
.
- str.rpartition(sep)¶
Split the string at the last occurrence ofsep, and return a 3-tuplecontaining the part before the separator, the separator itself, and the partafter the separator. If the separator is not found, return a 3-tuple containingtwo empty strings, followed by the string itself.
- str.rsplit(sep=None,maxsplit=-1)¶
Return a list of the words in the string, usingsep as the delimiter string.Ifmaxsplit is given, at mostmaxsplit splits are done, therightmostones. Ifsep is not specified or
None
, any whitespace string is aseparator. Except for splitting from the right,rsplit()
behaves likesplit()
which is described in detail below.
- str.rstrip([chars])¶
Return a copy of the string with trailing characters removed. Thecharsargument is a string specifying the set of characters to be removed. If omittedor
None
, thechars argument defaults to removing whitespace. Thecharsargument is not a suffix; rather, all combinations of its values are stripped:>>>' spacious '.rstrip()' spacious'>>>'mississippi'.rstrip('ipz')'mississ'
See
str.removesuffix()
for a method that will remove a single suffixstring rather than all of a set of characters. For example:>>>'Monty Python'.rstrip(' Python')'M'>>>'Monty Python'.removesuffix(' Python')'Monty'
- str.split(sep=None,maxsplit=-1)¶
Return a list of the words in the string, usingsep as the delimiterstring. Ifmaxsplit is given, at mostmaxsplit splits are done (thus,the list will have at most
maxsplit+1
elements). Ifmaxsplit is notspecified or-1
, then there is no limit on the number of splits(all possible splits are made).Ifsep is given, consecutive delimiters are not grouped together and aredeemed to delimit empty strings (for example,
'1,,2'.split(',')
returns['1','','2']
). Thesep argument may consist of multiple charactersas a single delimiter (to split with multiple delimiters, usere.split()
). Splitting an empty string with a specified separatorreturns['']
.舉例來說:
>>>'1,2,3'.split(',')['1', '2', '3']>>>'1,2,3'.split(',',maxsplit=1)['1', '2,3']>>>'1,2,,3,'.split(',')['1', '2', '', '3', '']>>>'1<>2<>3<4'.split('<>')['1', '2', '3<4']
Ifsep is not specified or is
None
, a different splitting algorithm isapplied: runs of consecutive whitespace are regarded as a single separator,and the result will contain no empty strings at the start or end if thestring has leading or trailing whitespace. Consequently, splitting an emptystring or a string consisting of just whitespace with aNone
separatorreturns[]
.舉例來說:
>>>'1 2 3'.split()['1', '2', '3']>>>'1 2 3'.split(maxsplit=1)['1', '2 3']>>>' 1 2 3 '.split()['1', '2', '3']
Ifsep is not specified or is
None
andmaxsplit is0
, onlyleading runs of consecutive whitespace are considered.舉例來說:
>>>"".split(None,0)[]>>>" ".split(None,0)[]>>>" foo ".split(maxsplit=0)['foo ']
- str.splitlines(keepends=False)¶
Return a list of the lines in the string, breaking at line boundaries. Linebreaks are not included in the resulting list unlesskeepends is given andtrue.
This method splits on the following line boundaries. In particular, theboundaries are a superset ofuniversal newlines.
Representation
描述
\n
Line Feed
\r
Carriage Return
\r\n
Carriage Return + Line Feed
\v
或\x0b
Line Tabulation
\f
或\x0c
Form Feed
\x1c
File Separator
\x1d
Group Separator
\x1e
Record Separator
\x85
Next Line (C1 Control Code)
\u2028
Line Separator
\u2029
Paragraph Separator
在 3.2 版的變更:
\v
and\f
added to list of line boundaries.舉例來說:
>>>'ab c\n\nde fg\rkl\r\n'.splitlines()['ab c', '', 'de fg', 'kl']>>>'ab c\n\nde fg\rkl\r\n'.splitlines(keepends=True)['ab c\n', '\n', 'de fg\r', 'kl\r\n']
Unlike
split()
when a delimiter stringsep is given, thismethod returns an empty list for the empty string, and a terminal linebreak does not result in an extra line:>>>"".splitlines()[]>>>"One line\n".splitlines()['One line']
For comparison,
split('\n')
gives:>>>''.split('\n')['']>>>'Two lines\n'.split('\n')['Two lines', '']
- str.startswith(prefix[,start[,end]])¶
Return
True
if string starts with theprefix, otherwise returnFalse
.prefix can also be a tuple of prefixes to look for. With optionalstart,test string beginning at that position. With optionalend, stop comparingstring at that position.
- str.strip([chars])¶
Return a copy of the string with the leading and trailing characters removed.Thechars argument is a string specifying the set of characters to be removed.If omitted or
None
, thechars argument defaults to removing whitespace.Thechars argument is not a prefix or suffix; rather, all combinations of itsvalues are stripped:>>>' spacious '.strip()'spacious'>>>'www.example.com'.strip('cmowz.')'example'
The outermost leading and trailingchars argument values are strippedfrom the string. Characters are removed from the leading end untilreaching a string character that is not contained in the set ofcharacters inchars. A similar action takes place on the trailing end.For example:
>>>comment_string='#....... Section 3.2.1 Issue #32 .......'>>>comment_string.strip('.#! ')'Section 3.2.1 Issue #32'
- str.swapcase()¶
Return a copy of the string with uppercase characters converted to lowercase andvice versa. Note that it is not necessarily true that
s.swapcase().swapcase()==s
.
- str.title()¶
Return a titlecased version of the string where words start with an uppercasecharacter and the remaining characters are lowercase.
舉例來說:
>>>'Hello world'.title()'Hello World'
The algorithm uses a simple language-independent definition of a word asgroups of consecutive letters. The definition works in many contexts butit means that apostrophes in contractions and possessives form wordboundaries, which may not be the desired result:
>>>"they're bill's friends from the UK".title()"They'Re Bill'S Friends From The Uk"
The
string.capwords()
function does not have this problem, as itsplits words on spaces only.Alternatively, a workaround for apostrophes can be constructed using regularexpressions:
>>>importre>>>deftitlecase(s):...returnre.sub(r"[A-Za-z]+('[A-Za-z]+)?",...lambdamo:mo.group(0).capitalize(),...s)...>>>titlecase("they're bill's friends.")"They're Bill's Friends."
- str.translate(table)¶
Return a copy of the string in which each character has been mapped throughthe given translation table. The table must be an object that implementsindexing via
__getitem__()
, typically amapping orsequence. When indexed by a Unicode ordinal (an integer), thetable object can do any of the following: return a Unicode ordinal or astring, to map the character to one or more other characters; returnNone
, to delete the character from the return string; or raise aLookupError
exception, to map the character to itself.You can use
str.maketrans()
to create a translation map fromcharacter-to-character mappings in different formats.See also the
codecs
module for a more flexible approach to customcharacter mappings.
- str.upper()¶
Return a copy of the string with all the cased characters[4] converted touppercase. Note that
s.upper().isupper()
might beFalse
ifs
contains uncased characters or if the Unicode category of the resultingcharacter(s) is not "Lu" (Letter, uppercase), but e.g. "Lt" (Letter,titlecase).The uppercasing algorithm used isdescribed in section 3.13 'Default Case Folding' of the Unicode Standard.
- str.zfill(width)¶
Return a copy of the string left filled with ASCII
'0'
digits tomake a string of lengthwidth. A leading sign prefix ('+'
/'-'
)is handled by inserting the paddingafter the sign character ratherthan before. The original string is returned ifwidth is less thanor equal tolen(s)
.舉例來說:
>>>"42".zfill(5)'00042'>>>"-42".zfill(5)'-0042'
Formatted String Literals (f-strings)¶
在 3.6 版被加入.
在 3.8 版的變更:Added the debugging operator (=
)
在 3.12 版的變更:Many restrictions on expressions within f-strings have been removed.Notably, nested strings, comments, and backslashes are now permitted.
Anf-string (formally aformatted string literal) isa string literal that is prefixed withf
orF
.This type of string literal allows embedding arbitrary Python expressionswithinreplacement fields, which are delimited by curly brackets ({}
).These expressions are evaluated at runtime, similarly tostr.format()
,and are converted into regularstr
objects.For example:
>>>who='nobody'>>>nationality='Spanish'>>>f'{who.title()} expects the{nationality} Inquisition!''Nobody expects the Spanish Inquisition!'
It is also possible to use a multi line f-string:
>>>f'''This is a string...on two lines''''This is a string\non two lines'
A single opening curly bracket,'{'
, marks areplacement field thatcan contain any Python expression:
>>>nationality='Spanish'>>>f'The{nationality} Inquisition!''The Spanish Inquisition!'
To include a literal{
or}
, use a double bracket:
>>>x=42>>>f'{{x}} is{x}''{x} is 42'
Functions can also be used, andformat specifiers:
>>>frommathimportsqrt>>>f'√2\N{ALMOST EQUAL TO}{sqrt(2):.5f}''√2 ≈ 1.41421'
Any non-string expression is converted usingstr()
, by default:
>>>fromfractionsimportFraction>>>f'{Fraction(1,3)}''1/3'
To use an explicit conversion, use the!
(exclamation mark) operator,followed by any of the valid formats, which are:
Conversion | 含義 |
---|---|
| |
| |
|
舉例來說:
>>>fromfractionsimportFraction>>>f'{Fraction(1,3)!s}''1/3'>>>f'{Fraction(1,3)!r}''Fraction(1, 3)'>>>question='¿Dónde está el Presidente?'>>>print(f'{question!a}')'\xbfD\xf3nde est\xe1 el Presidente?'
While debugging it may be helpful to see both the expression and its value,by using the equals sign (=
) after the expression.This preserves spaces within the brackets, and can be used with a converter.By default, the debugging operator uses therepr()
(!r
) conversion.For example:
>>>fromfractionsimportFraction>>>calculation=Fraction(1,3)>>>f'{calculation=}''calculation=Fraction(1, 3)'>>>f'{calculation= }''calculation = Fraction(1, 3)'>>>f'{calculation= !s}''calculation = 1/3'
Once the output has been evaluated, it can be formatted using aformat specifier following a colon (':'
).After the expression has been evaluated, and possibly converted to a string,the__format__()
method of the result is called with the format specifier,or the empty string if no format specifier is given.The formatted result is then used as the final value for the replacement field.For example:
>>>fromfractionsimportFraction>>>f'{Fraction(1,7):.6f}''0.142857'>>>f'{Fraction(1,7):_^+10}''___+1/7___'
printf
-style String Formatting¶
備註
The formatting operations described here exhibit a variety of quirks thatlead to a number of common errors (such as failing to display tuples anddictionaries correctly). Using the newerformatted string literals, thestr.format()
interface, ortemplate strings may help avoid these errors. Each of thesealternatives provides their own trade-offs and benefits of simplicity,flexibility, and/or extensibility.
String objects have one unique built-in operation: the%
operator (modulo).This is also known as the stringformatting orinterpolation operator.Givenformat%values
(whereformat is a string),%
conversionspecifications informat are replaced with zero or more elements ofvalues.The effect is similar to using thesprintf()
function in the C language.For example:
>>>print('%s has%d quote types.'%('Python',2))Python has 2 quote types.
Ifformat requires a single argument,values may be a single non-tupleobject.[5] Otherwise,values must be a tuple with exactly the number ofitems specified by the format string, or a single mapping object (for example, adictionary).
A conversion specifier contains two or more characters and has the followingcomponents, which must occur in this order:
The
'%'
character, which marks the start of the specifier.Mapping key (optional), consisting of a parenthesised sequence of characters(for example,
(somename)
).Conversion flags (optional), which affect the result of some conversiontypes.
Minimum field width (optional). If specified as an
'*'
(asterisk), theactual width is read from the next element of the tuple invalues, and theobject to convert comes after the minimum field width and optional precision.Precision (optional), given as a
'.'
(dot) followed by the precision. Ifspecified as'*'
(an asterisk), the actual precision is read from the nextelement of the tuple invalues, and the value to convert comes after theprecision.Length modifier (optional).
Conversion type.
When the right argument is a dictionary (or other mapping type), then theformats in the stringmust include a parenthesised mapping key into thatdictionary inserted immediately after the'%'
character. The mapping keyselects the value to be formatted from the mapping. For example:
>>>print('%(language)s has%(number)03d quote types.'%...{'language':"Python","number":2})Python has 002 quote types.
In this case no*
specifiers may occur in a format (since they require asequential parameter list).
The conversion flag characters are:
Flag | 含義 |
---|---|
| The value conversion will use the "alternate form" (where definedbelow). |
| The conversion will be zero padded for numeric values. |
| The converted value is left adjusted (overrides the |
| (a space) A blank should be left before a positive number (or emptystring) produced by a signed conversion. |
| A sign character ( |
A length modifier (h
,l
, orL
) may be present, but is ignored as itis not necessary for Python -- so e.g.%ld
is identical to%d
.
The conversion types are:
Conversion | 含義 | 註解 |
---|---|---|
| Signed integer decimal. | |
| Signed integer decimal. | |
| Signed octal value. | (1) |
| Obsolete type -- it is identical to | (6) |
| Signed hexadecimal (lowercase). | (2) |
| Signed hexadecimal (uppercase). | (2) |
| Floating-point exponential format (lowercase). | (3) |
| Floating-point exponential format (uppercase). | (3) |
| Floating-point decimal format. | (3) |
| Floating-point decimal format. | (3) |
| Floating-point format. Uses lowercase exponentialformat if exponent is less than -4 or not less thanprecision, decimal format otherwise. | (4) |
| Floating-point format. Uses uppercase exponentialformat if exponent is less than -4 or not less thanprecision, decimal format otherwise. | (4) |
| Single character (accepts integer or singlecharacter string). | |
| String (converts any Python object using | (5) |
| String (converts any Python object using | (5) |
| String (converts any Python object using | (5) |
| No argument is converted, results in a |
註解:
The alternate form causes a leading octal specifier (
'0o'
) to beinserted before the first digit.The alternate form causes a leading
'0x'
or'0X'
(depending on whetherthe'x'
or'X'
format was used) to be inserted before the first digit.The alternate form causes the result to always contain a decimal point, even ifno digits follow it.
The precision determines the number of digits after the decimal point anddefaults to 6.
The alternate form causes the result to always contain a decimal point, andtrailing zeroes are not removed as they would otherwise be.
The precision determines the number of significant digits before and after thedecimal point and defaults to 6.
If precision is
N
, the output is truncated toN
characters.參閱PEP 237。
Since Python strings have an explicit length,%s
conversions do not assumethat'\0'
is the end of the string.
在 3.1 版的變更:%f
conversions for numbers whose absolute value is over 1e50 are nolonger replaced by%g
conversions.
Binary Sequence Types ---bytes
,bytearray
,memoryview
¶
The core built-in types for manipulating binary data arebytes
andbytearray
. They are supported bymemoryview
which usesthebuffer protocol to access the memory of otherbinary objects without needing to make a copy.
Thearray
module supports efficient storage of basic data types like32-bit integers and IEEE754 double-precision floating values.
Bytes Objects¶
Bytes objects are immutable sequences of single bytes. Since many majorbinary protocols are based on the ASCII text encoding, bytes objects offerseveral methods that are only valid when working with ASCII compatibledata and are closely related to string objects in a variety of other ways.
- classbytes([source[,encoding[,errors]]])¶
Firstly, the syntax for bytes literals is largely the same as that for stringliterals, except that a
b
prefix is added:Single quotes:
b'stillallowsembedded"double"quotes'
Double quotes:
b"stillallowsembedded'single'quotes"
Triple quoted:
b'''3singlequotes'''
,b"""3doublequotes"""
Only ASCII characters are permitted in bytes literals (regardless of thedeclared source code encoding). Any binary values over 127 must be enteredinto bytes literals using the appropriate escape sequence.
As with string literals, bytes literals may also use a
r
prefix to disableprocessing of escape sequences. SeeString and Bytes literals for more about the variousforms of bytes literal, including supported escape sequences.While bytes literals and representations are based on ASCII text, bytesobjects actually behave like immutable sequences of integers, with eachvalue in the sequence restricted such that
0<=x<256
(attempts toviolate this restriction will triggerValueError
). This is donedeliberately to emphasise that while many binary formats include ASCII basedelements and can be usefully manipulated with some text-oriented algorithms,this is not generally the case for arbitrary binary data (blindly applyingtext processing algorithms to binary data formats that are not ASCIIcompatible will usually lead to data corruption).In addition to the literal forms, bytes objects can be created in a number ofother ways:
A zero-filled bytes object of a specified length:
bytes(10)
From an iterable of integers:
bytes(range(20))
Copying existing binary data via the buffer protocol:
bytes(obj)
另見內建的bytes。
Since 2 hexadecimal digits correspond precisely to a single byte, hexadecimalnumbers are a commonly used format for describing binary data. Accordingly,the bytes type has an additional class method to read data in that format:
- classmethodfromhex(string)¶
This
bytes
class method returns a bytes object, decoding thegiven string object. The string must contain two hexadecimal digits perbyte, with ASCII whitespace being ignored.>>>bytes.fromhex('2Ef0 F1f2 ')b'.\xf0\xf1\xf2'
在 3.7 版的變更:
bytes.fromhex()
now skips all ASCII whitespace in the string,not just spaces.
A reverse conversion function exists to transform a bytes object into itshexadecimal representation.
- hex([sep[,bytes_per_sep]])¶
Return a string object containing two hexadecimal digits for eachbyte in the instance.
>>>b'\xf0\xf1\xf2'.hex()'f0f1f2'
If you want to make the hex string easier to read, you can specify asingle character separatorsep parameter to include in the output.By default, this separator will be included between each byte.A second optionalbytes_per_sep parameter controls the spacing.Positive values calculate the separator position from the right,negative values from the left.
>>>value=b'\xf0\xf1\xf2'>>>value.hex('-')'f0-f1-f2'>>>value.hex('_',2)'f0_f1f2'>>>b'UUDDLRLRAB'.hex(' ',-4)'55554444 4c524c52 4142'
在 3.5 版被加入.
在 3.8 版的變更:
bytes.hex()
now supports optionalsep andbytes_per_sepparameters to insert separators between bytes in the hex output.
Since bytes objects are sequences of integers (akin to a tuple), for a bytesobjectb,b[0]
will be an integer, whileb[0:1]
will be a bytesobject of length 1. (This contrasts with text strings, where both indexingand slicing will produce a string of length 1)
The representation of bytes objects uses the literal format (b'...'
)since it is often more useful than e.g.bytes([46,46,46])
. You canalways convert a bytes object into a list of integers usinglist(b)
.
Bytearray 物件¶
bytearray
objects are a mutable counterpart tobytes
objects.
- classbytearray([source[,encoding[,errors]]])¶
There is no dedicated literal syntax for bytearray objects, insteadthey are always created by calling the constructor:
建立一個空的實例:
bytearray()
Creating a zero-filled instance with a given length:
bytearray(10)
From an iterable of integers:
bytearray(range(20))
Copying existing binary data via the buffer protocol:
bytearray(b'Hi!')
As bytearray objects are mutable, they support themutable sequence operations in addition to thecommon bytes and bytearray operations described inBytes 和 Bytearray 的操作.
另見內建的bytearray。
Since 2 hexadecimal digits correspond precisely to a single byte, hexadecimalnumbers are a commonly used format for describing binary data. Accordingly,the bytearray type has an additional class method to read data in that format:
- classmethodfromhex(string)¶
This
bytearray
class method returns bytearray object, decodingthe given string object. The string must contain two hexadecimal digitsper byte, with ASCII whitespace being ignored.>>>bytearray.fromhex('2Ef0 F1f2 ')bytearray(b'.\xf0\xf1\xf2')
在 3.7 版的變更:
bytearray.fromhex()
now skips all ASCII whitespace in the string,not just spaces.
A reverse conversion function exists to transform a bytearray object into itshexadecimal representation.
- hex([sep[,bytes_per_sep]])¶
Return a string object containing two hexadecimal digits for eachbyte in the instance.
>>>bytearray(b'\xf0\xf1\xf2').hex()'f0f1f2'
在 3.5 版被加入.
在 3.8 版的變更:Similar to
bytes.hex()
,bytearray.hex()
now supportsoptionalsep andbytes_per_sep parameters to insert separatorsbetween bytes in the hex output.
Since bytearray objects are sequences of integers (akin to a list), for abytearray objectb,b[0]
will be an integer, whileb[0:1]
will bea bytearray object of length 1. (This contrasts with text strings, whereboth indexing and slicing will produce a string of length 1)
The representation of bytearray objects uses the bytes literal format(bytearray(b'...')
) since it is often more useful than e.g.bytearray([46,46,46])
. You can always convert a bytearray object intoa list of integers usinglist(b)
.
Bytes 和 Bytearray 的操作¶
Both bytes and bytearray objects support thecommonsequence operations. They interoperate not just with operands of the sametype, but with anybytes-like object. Due to this flexibility, they can befreely mixed in operations without causing errors. However, the return typeof the result may depend on the order of operands.
備註
The methods on bytes and bytearray objects don't accept strings as theirarguments, just as the methods on strings don't accept bytes as theirarguments. For example, you have to write:
a="abc"b=a.replace("a","f")
和:
a=b"abc"b=a.replace(b"a",b"f")
Some bytes and bytearray operations assume the use of ASCII compatiblebinary formats, and hence should be avoided when working with arbitrarybinary data. These restrictions are covered below.
備註
Using these ASCII based operations to manipulate binary data that is notstored in an ASCII based format may lead to data corruption.
The following methods on bytes and bytearray objects can be used witharbitrary binary data.
- bytes.count(sub[,start[,end]])¶
- bytearray.count(sub[,start[,end]])¶
Return the number of non-overlapping occurrences of subsequencesub inthe range [start,end]. Optional argumentsstart andend areinterpreted as in slice notation.
The subsequence to search for may be anybytes-like object or aninteger in the range 0 to 255.
Ifsub is empty, returns the number of empty slices between characterswhich is the length of the bytes object plus one.
在 3.3 版的變更:Also accept an integer in the range 0 to 255 as the subsequence.
- bytes.removeprefix(prefix,/)¶
- bytearray.removeprefix(prefix,/)¶
If the binary data starts with theprefix string, return
bytes[len(prefix):]
. Otherwise, return a copy of the originalbinary data:>>>b'TestHook'.removeprefix(b'Test')b'Hook'>>>b'BaseTestCase'.removeprefix(b'Test')b'BaseTestCase'
prefix 可以是任何的bytes-like object。
備註
The bytearray version of this method doesnot operate in place -it always produces a new object, even if no changes were made.
在 3.9 版被加入.
- bytes.removesuffix(suffix,/)¶
- bytearray.removesuffix(suffix,/)¶
If the binary data ends with thesuffix string and thatsuffix isnot empty, return
bytes[:-len(suffix)]
. Otherwise, return a copy ofthe original binary data:>>>b'MiscTests'.removesuffix(b'Tests')b'Misc'>>>b'TmpDirMixin'.removesuffix(b'Tests')b'TmpDirMixin'
Thesuffix may be anybytes-like object.
備註
The bytearray version of this method doesnot operate in place -it always produces a new object, even if no changes were made.
在 3.9 版被加入.
- bytes.decode(encoding='utf-8',errors='strict')¶
- bytearray.decode(encoding='utf-8',errors='strict')¶
Return the bytes decoded to a
str
.encoding defaults to
'utf-8'
;seeStandard Encodings for possible values.errors controls how decoding errors are handled.If
'strict'
(the default), aUnicodeError
exception is raised.Other possible values are'ignore'
,'replace'
,and any other name registered viacodecs.register_error()
.SeeError Handlers for details.For performance reasons, the value oferrors is not checked for validityunless a decoding error actually occurs,Python 開發模式 is enabled or adebug build is used.
備註
Passing theencoding argument to
str
allows decoding anybytes-like object directly, without needing to make a temporarybytes
orbytearray
object.在 3.1 版的變更:新增關鍵字引數的支援。
在 3.9 版的變更:The value of theerrors argument is now checked inPython 開發模式 andindebug mode.
- bytes.endswith(suffix[,start[,end]])¶
- bytearray.endswith(suffix[,start[,end]])¶
Return
True
if the binary data ends with the specifiedsuffix,otherwise returnFalse
.suffix can also be a tuple of suffixes tolook for. With optionalstart, test beginning at that position. Withoptionalend, stop comparing at that position.The suffix(es) to search for may be anybytes-like object.
- bytes.find(sub[,start[,end]])¶
- bytearray.find(sub[,start[,end]])¶
Return the lowest index in the data where the subsequencesub is found,such thatsub is contained in the slice
s[start:end]
. Optionalargumentsstart andend are interpreted as in slice notation. Return-1
ifsub is not found.The subsequence to search for may be anybytes-like object or aninteger in the range 0 to 255.
備註
The
find()
method should be used only if you need to know theposition ofsub. To check ifsub is a substring or not, use thein
operator:>>>b'Py'inb'Python'True
在 3.3 版的變更:Also accept an integer in the range 0 to 255 as the subsequence.
- bytes.index(sub[,start[,end]])¶
- bytearray.index(sub[,start[,end]])¶
Like
find()
, but raiseValueError
when thesubsequence is not found.The subsequence to search for may be anybytes-like object or aninteger in the range 0 to 255.
在 3.3 版的變更:Also accept an integer in the range 0 to 255 as the subsequence.
- bytes.join(iterable)¶
- bytearray.join(iterable)¶
Return a bytes or bytearray object which is the concatenation of thebinary data sequences initerable. A
TypeError
will be raisedif there are any values initerable that are notbytes-likeobjects, includingstr
objects. Theseparator between elements is the contents of the bytes orbytearray object providing this method.
- staticbytes.maketrans(from,to)¶
- staticbytearray.maketrans(from,to)¶
This static method returns a translation table usable for
bytes.translate()
that will map each character infrom into thecharacter at the same position into;from andto must both bebytes-like objects and have the same length.在 3.1 版被加入.
- bytes.partition(sep)¶
- bytearray.partition(sep)¶
Split the sequence at the first occurrence ofsep, and return a 3-tuplecontaining the part before the separator, the separator itself or itsbytearray copy, and the part after the separator.If the separator is not found, return a 3-tuplecontaining a copy of the original sequence, followed by two empty bytes orbytearray objects.
The separator to search for may be anybytes-like object.
- bytes.replace(old,new[,count])¶
- bytearray.replace(old,new[,count])¶
Return a copy of the sequence with all occurrences of subsequenceoldreplaced bynew. If the optional argumentcount is given, only thefirstcount occurrences are replaced.
The subsequence to search for and its replacement may be anybytes-like object.
備註
The bytearray version of this method doesnot operate in place - italways produces a new object, even if no changes were made.
- bytes.rfind(sub[,start[,end]])¶
- bytearray.rfind(sub[,start[,end]])¶
Return the highest index in the sequence where the subsequencesub isfound, such thatsub is contained within
s[start:end]
. Optionalargumentsstart andend are interpreted as in slice notation. Return-1
on failure.The subsequence to search for may be anybytes-like object or aninteger in the range 0 to 255.
在 3.3 版的變更:Also accept an integer in the range 0 to 255 as the subsequence.
- bytes.rindex(sub[,start[,end]])¶
- bytearray.rindex(sub[,start[,end]])¶
Like
rfind()
but raisesValueError
when thesubsequencesub is not found.The subsequence to search for may be anybytes-like object or aninteger in the range 0 to 255.
在 3.3 版的變更:Also accept an integer in the range 0 to 255 as the subsequence.
- bytes.rpartition(sep)¶
- bytearray.rpartition(sep)¶
Split the sequence at the last occurrence ofsep, and return a 3-tuplecontaining the part before the separator, the separator itself or itsbytearray copy, and the part after the separator.If the separator is not found, return a 3-tuplecontaining two empty bytes or bytearray objects, followed by a copy of theoriginal sequence.
The separator to search for may be anybytes-like object.
- bytes.startswith(prefix[,start[,end]])¶
- bytearray.startswith(prefix[,start[,end]])¶
Return
True
if the binary data starts with the specifiedprefix,otherwise returnFalse
.prefix can also be a tuple of prefixes tolook for. With optionalstart, test beginning at that position. Withoptionalend, stop comparing at that position.The prefix(es) to search for may be anybytes-like object.
- bytes.translate(table,/,delete=b'')¶
- bytearray.translate(table,/,delete=b'')¶
Return a copy of the bytes or bytearray object where all bytes occurring inthe optional argumentdelete are removed, and the remaining bytes havebeen mapped through the given translation table, which must be a bytesobject of length 256.
You can use the
bytes.maketrans()
method to create a translationtable.Set thetable argument to
None
for translations that only deletecharacters:>>>b'read this short text'.translate(None,b'aeiou')b'rd ths shrt txt'
在 3.6 版的變更:支援delete 關鍵字引數。
The following methods on bytes and bytearray objects have default behavioursthat assume the use of ASCII compatible binary formats, but can still be usedwith arbitrary binary data by passing appropriate arguments. Note that all ofthe bytearray methods in this section donot operate in place, and insteadproduce new objects.
- bytes.center(width[,fillbyte])¶
- bytearray.center(width[,fillbyte])¶
Return a copy of the object centered in a sequence of lengthwidth.Padding is done using the specifiedfillbyte (default is an ASCIIspace). For
bytes
objects, the original sequence is returned ifwidth is less than or equal tolen(s)
.備註
The bytearray version of this method doesnot operate in place -it always produces a new object, even if no changes were made.
- bytes.ljust(width[,fillbyte])¶
- bytearray.ljust(width[,fillbyte])¶
Return a copy of the object left justified in a sequence of lengthwidth.Padding is done using the specifiedfillbyte (default is an ASCIIspace). For
bytes
objects, the original sequence is returned ifwidth is less than or equal tolen(s)
.備註
The bytearray version of this method doesnot operate in place -it always produces a new object, even if no changes were made.
- bytes.lstrip([chars])¶
- bytearray.lstrip([chars])¶
Return a copy of the sequence with specified leading bytes removed. Thechars argument is a binary sequence specifying the set of byte values tobe removed - the name refers to the fact this method is usually used withASCII characters. If omitted or
None
, thechars argument defaultsto removing ASCII whitespace. Thechars argument is not a prefix;rather, all combinations of its values are stripped:>>>b' spacious '.lstrip()b'spacious '>>>b'www.example.com'.lstrip(b'cmowz.')b'example.com'
The binary sequence of byte values to remove may be anybytes-like object. See
removeprefix()
for a methodthat will remove a single prefix string rather than all of a set ofcharacters. For example:>>>b'Arthur: three!'.lstrip(b'Arthur: ')b'ee!'>>>b'Arthur: three!'.removeprefix(b'Arthur: ')b'three!'
備註
The bytearray version of this method doesnot operate in place -it always produces a new object, even if no changes were made.
- bytes.rjust(width[,fillbyte])¶
- bytearray.rjust(width[,fillbyte])¶
Return a copy of the object right justified in a sequence of lengthwidth.Padding is done using the specifiedfillbyte (default is an ASCIIspace). For
bytes
objects, the original sequence is returned ifwidth is less than or equal tolen(s)
.備註
The bytearray version of this method doesnot operate in place -it always produces a new object, even if no changes were made.
- bytes.rsplit(sep=None,maxsplit=-1)¶
- bytearray.rsplit(sep=None,maxsplit=-1)¶
Split the binary sequence into subsequences of the same type, usingsepas the delimiter string. Ifmaxsplit is given, at mostmaxsplit splitsare done, therightmost ones. Ifsep is not specified or
None
,any subsequence consisting solely of ASCII whitespace is a separator.Except for splitting from the right,rsplit()
behaves likesplit()
which is described in detail below.
- bytes.rstrip([chars])¶
- bytearray.rstrip([chars])¶
Return a copy of the sequence with specified trailing bytes removed. Thechars argument is a binary sequence specifying the set of byte values tobe removed - the name refers to the fact this method is usually used withASCII characters. If omitted or
None
, thechars argument defaults toremoving ASCII whitespace. Thechars argument is not a suffix; rather,all combinations of its values are stripped:>>>b' spacious '.rstrip()b' spacious'>>>b'mississippi'.rstrip(b'ipz')b'mississ'
The binary sequence of byte values to remove may be anybytes-like object. See
removesuffix()
for a methodthat will remove a single suffix string rather than all of a set ofcharacters. For example:>>>b'Monty Python'.rstrip(b' Python')b'M'>>>b'Monty Python'.removesuffix(b' Python')b'Monty'
備註
The bytearray version of this method doesnot operate in place -it always produces a new object, even if no changes were made.
- bytes.split(sep=None,maxsplit=-1)¶
- bytearray.split(sep=None,maxsplit=-1)¶
Split the binary sequence into subsequences of the same type, usingsepas the delimiter string. Ifmaxsplit is given and non-negative, at mostmaxsplit splits are done (thus, the list will have at most
maxsplit+1
elements). Ifmaxsplit is not specified or is-1
, then there is nolimit on the number of splits (all possible splits are made).Ifsep is given, consecutive delimiters are not grouped together and aredeemed to delimit empty subsequences (for example,
b'1,,2'.split(b',')
returns[b'1',b'',b'2']
). Thesep argument may consist of amultibyte sequence as a single delimiter. Splitting an empty sequence witha specified separator returns[b'']
or[bytearray(b'')]
dependingon the type of object being split. Thesep argument may be anybytes-like object.舉例來說:
>>>b'1,2,3'.split(b',')[b'1', b'2', b'3']>>>b'1,2,3'.split(b',',maxsplit=1)[b'1', b'2,3']>>>b'1,2,,3,'.split(b',')[b'1', b'2', b'', b'3', b'']>>>b'1<>2<>3<4'.split(b'<>')[b'1', b'2', b'3<4']
Ifsep is not specified or is
None
, a different splitting algorithmis applied: runs of consecutive ASCII whitespace are regarded as a singleseparator, and the result will contain no empty strings at the start orend if the sequence has leading or trailing whitespace. Consequently,splitting an empty sequence or a sequence consisting solely of ASCIIwhitespace without a specified separator returns[]
.舉例來說:
>>>b'1 2 3'.split()[b'1', b'2', b'3']>>>b'1 2 3'.split(maxsplit=1)[b'1', b'2 3']>>>b' 1 2 3 '.split()[b'1', b'2', b'3']
- bytes.strip([chars])¶
- bytearray.strip([chars])¶
Return a copy of the sequence with specified leading and trailing bytesremoved. Thechars argument is a binary sequence specifying the set ofbyte values to be removed - the name refers to the fact this method isusually used with ASCII characters. If omitted or
None
, thecharsargument defaults to removing ASCII whitespace. Thechars argument isnot a prefix or suffix; rather, all combinations of its values arestripped:>>>b' spacious '.strip()b'spacious'>>>b'www.example.com'.strip(b'cmowz.')b'example'
The binary sequence of byte values to remove may be anybytes-like object.
備註
The bytearray version of this method doesnot operate in place -it always produces a new object, even if no changes were made.
The following methods on bytes and bytearray objects assume the use of ASCIIcompatible binary formats and should not be applied to arbitrary binary data.Note that all of the bytearray methods in this section donot operate inplace, and instead produce new objects.
- bytes.capitalize()¶
- bytearray.capitalize()¶
Return a copy of the sequence with each byte interpreted as an ASCIIcharacter, and the first byte capitalized and the rest lowercased.Non-ASCII byte values are passed through unchanged.
備註
The bytearray version of this method doesnot operate in place - italways produces a new object, even if no changes were made.
- bytes.expandtabs(tabsize=8)¶
- bytearray.expandtabs(tabsize=8)¶
Return a copy of the sequence where all ASCII tab characters are replacedby one or more ASCII spaces, depending on the current column and the giventab size. Tab positions occur everytabsize bytes (default is 8,giving tab positions at columns 0, 8, 16 and so on). To expand thesequence, the current column is set to zero and the sequence is examinedbyte by byte. If the byte is an ASCII tab character (
b'\t'
), one ormore space characters are inserted in the result until the current columnis equal to the next tab position. (The tab character itself is notcopied.) If the current byte is an ASCII newline (b'\n'
) orcarriage return (b'\r'
), it is copied and the current column is resetto zero. Any other byte value is copied unchanged and the current columnis incremented by one regardless of how the byte value is represented whenprinted:>>>b'01\t012\t0123\t01234'.expandtabs()b'01 012 0123 01234'>>>b'01\t012\t0123\t01234'.expandtabs(4)b'01 012 0123 01234'
備註
The bytearray version of this method doesnot operate in place - italways produces a new object, even if no changes were made.
- bytes.isalnum()¶
- bytearray.isalnum()¶
Return
True
if all bytes in the sequence are alphabetical ASCII charactersor ASCII decimal digits and the sequence is not empty,False
otherwise.Alphabetic ASCII characters are those byte values in the sequenceb'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
. ASCII decimaldigits are those byte values in the sequenceb'0123456789'
.舉例來說:
>>>b'ABCabc1'.isalnum()True>>>b'ABC abc1'.isalnum()False
- bytes.isalpha()¶
- bytearray.isalpha()¶
Return
True
if all bytes in the sequence are alphabetic ASCII charactersand the sequence is not empty,False
otherwise. Alphabetic ASCIIcharacters are those byte values in the sequenceb'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
.舉例來說:
>>>b'ABCabc'.isalpha()True>>>b'ABCabc1'.isalpha()False
- bytes.isascii()¶
- bytearray.isascii()¶
Return
True
if the sequence is empty or all bytes in the sequence are ASCII,False
otherwise.ASCII bytes are in the range 0-0x7F.在 3.7 版被加入.
- bytes.isdigit()¶
- bytearray.isdigit()¶
Return
True
if all bytes in the sequence are ASCII decimal digitsand the sequence is not empty,False
otherwise. ASCII decimal digits arethose byte values in the sequenceb'0123456789'
.舉例來說:
>>>b'1234'.isdigit()True>>>b'1.23'.isdigit()False
- bytes.islower()¶
- bytearray.islower()¶
Return
True
if there is at least one lowercase ASCII characterin the sequence and no uppercase ASCII characters,False
otherwise.舉例來說:
>>>b'hello world'.islower()True>>>b'Hello world'.islower()False
Lowercase ASCII characters are those byte values in the sequence
b'abcdefghijklmnopqrstuvwxyz'
. Uppercase ASCII charactersare those byte values in the sequenceb'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
.
- bytes.isspace()¶
- bytearray.isspace()¶
Return
True
if all bytes in the sequence are ASCII whitespace and thesequence is not empty,False
otherwise. ASCII whitespace characters arethose byte values in the sequenceb'\t\n\r\x0b\f'
(space, tab, newline,carriage return, vertical tab, form feed).
- bytes.istitle()¶
- bytearray.istitle()¶
Return
True
if the sequence is ASCII titlecase and the sequence is notempty,False
otherwise. Seebytes.title()
for more details on thedefinition of "titlecase".舉例來說:
>>>b'Hello World'.istitle()True>>>b'Hello world'.istitle()False
- bytes.isupper()¶
- bytearray.isupper()¶
Return
True
if there is at least one uppercase alphabetic ASCII characterin the sequence and no lowercase ASCII characters,False
otherwise.舉例來說:
>>>b'HELLO WORLD'.isupper()True>>>b'Hello world'.isupper()False
Lowercase ASCII characters are those byte values in the sequence
b'abcdefghijklmnopqrstuvwxyz'
. Uppercase ASCII charactersare those byte values in the sequenceb'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
.
- bytes.lower()¶
- bytearray.lower()¶
Return a copy of the sequence with all the uppercase ASCII charactersconverted to their corresponding lowercase counterpart.
舉例來說:
>>>b'Hello World'.lower()b'hello world'
Lowercase ASCII characters are those byte values in the sequence
b'abcdefghijklmnopqrstuvwxyz'
. Uppercase ASCII charactersare those byte values in the sequenceb'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
.備註
The bytearray version of this method doesnot operate in place - italways produces a new object, even if no changes were made.
- bytes.splitlines(keepends=False)¶
- bytearray.splitlines(keepends=False)¶
Return a list of the lines in the binary sequence, breaking at ASCIIline boundaries. This method uses theuniversal newlines approachto splitting lines. Line breaks are not included in the resulting listunlesskeepends is given and true.
舉例來說:
>>>b'ab c\n\nde fg\rkl\r\n'.splitlines()[b'ab c', b'', b'de fg', b'kl']>>>b'ab c\n\nde fg\rkl\r\n'.splitlines(keepends=True)[b'ab c\n', b'\n', b'de fg\r', b'kl\r\n']
Unlike
split()
when a delimiter stringsep is given, thismethod returns an empty list for the empty string, and a terminal linebreak does not result in an extra line:>>>b"".split(b'\n'),b"Two lines\n".split(b'\n')([b''], [b'Two lines', b''])>>>b"".splitlines(),b"One line\n".splitlines()([], [b'One line'])
- bytes.swapcase()¶
- bytearray.swapcase()¶
Return a copy of the sequence with all the lowercase ASCII charactersconverted to their corresponding uppercase counterpart and vice-versa.
舉例來說:
>>>b'Hello World'.swapcase()b'hELLO wORLD'
Lowercase ASCII characters are those byte values in the sequence
b'abcdefghijklmnopqrstuvwxyz'
. Uppercase ASCII charactersare those byte values in the sequenceb'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
.Unlike
str.swapcase()
, it is always the case thatbin.swapcase().swapcase()==bin
for the binary versions. Caseconversions are symmetrical in ASCII, even though that is not generallytrue for arbitrary Unicode code points.備註
The bytearray version of this method doesnot operate in place - italways produces a new object, even if no changes were made.
- bytes.title()¶
- bytearray.title()¶
Return a titlecased version of the binary sequence where words start withan uppercase ASCII character and the remaining characters are lowercase.Uncased byte values are left unmodified.
舉例來說:
>>>b'Hello world'.title()b'Hello World'
Lowercase ASCII characters are those byte values in the sequence
b'abcdefghijklmnopqrstuvwxyz'
. Uppercase ASCII charactersare those byte values in the sequenceb'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
.All other byte values are uncased.The algorithm uses a simple language-independent definition of a word asgroups of consecutive letters. The definition works in many contexts butit means that apostrophes in contractions and possessives form wordboundaries, which may not be the desired result:
>>>b"they're bill's friends from the UK".title()b"They'Re Bill'S Friends From The Uk"
A workaround for apostrophes can be constructed using regular expressions:
>>>importre>>>deftitlecase(s):...returnre.sub(rb"[A-Za-z]+('[A-Za-z]+)?",...lambdamo:mo.group(0)[0:1].upper()+...mo.group(0)[1:].lower(),...s)...>>>titlecase(b"they're bill's friends.")b"They're Bill's Friends."
備註
The bytearray version of this method doesnot operate in place - italways produces a new object, even if no changes were made.
- bytes.upper()¶
- bytearray.upper()¶
Return a copy of the sequence with all the lowercase ASCII charactersconverted to their corresponding uppercase counterpart.
舉例來說:
>>>b'Hello World'.upper()b'HELLO WORLD'
Lowercase ASCII characters are those byte values in the sequence
b'abcdefghijklmnopqrstuvwxyz'
. Uppercase ASCII charactersare those byte values in the sequenceb'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
.備註
The bytearray version of this method doesnot operate in place - italways produces a new object, even if no changes were made.
- bytes.zfill(width)¶
- bytearray.zfill(width)¶
Return a copy of the sequence left filled with ASCII
b'0'
digits tomake a sequence of lengthwidth. A leading sign prefix (b'+'
/b'-'
) is handled by inserting the paddingafter the sign characterrather than before. Forbytes
objects, the original sequence isreturned ifwidth is less than or equal tolen(seq)
.舉例來說:
>>>b"42".zfill(5)b'00042'>>>b"-42".zfill(5)b'-0042'
備註
The bytearray version of this method doesnot operate in place - italways produces a new object, even if no changes were made.
printf
-style Bytes Formatting¶
備註
The formatting operations described here exhibit a variety of quirks thatlead to a number of common errors (such as failing to display tuples anddictionaries correctly). If the value being printed may be a tuple ordictionary, wrap it in a tuple.
Bytes objects (bytes
/bytearray
) have one unique built-in operation:the%
operator (modulo).This is also known as the bytesformatting orinterpolation operator.Givenformat%values
(whereformat is a bytes object),%
conversionspecifications informat are replaced with zero or more elements ofvalues.The effect is similar to using thesprintf()
in the C language.
Ifformat requires a single argument,values may be a single non-tupleobject.[5] Otherwise,values must be a tuple with exactly the number ofitems specified by the format bytes object, or a single mapping object (forexample, a dictionary).
A conversion specifier contains two or more characters and has the followingcomponents, which must occur in this order:
The
'%'
character, which marks the start of the specifier.Mapping key (optional), consisting of a parenthesised sequence of characters(for example,
(somename)
).Conversion flags (optional), which affect the result of some conversiontypes.
Minimum field width (optional). If specified as an
'*'
(asterisk), theactual width is read from the next element of the tuple invalues, and theobject to convert comes after the minimum field width and optional precision.Precision (optional), given as a
'.'
(dot) followed by the precision. Ifspecified as'*'
(an asterisk), the actual precision is read from the nextelement of the tuple invalues, and the value to convert comes after theprecision.Length modifier (optional).
Conversion type.
When the right argument is a dictionary (or other mapping type), then theformats in the bytes objectmust include a parenthesised mapping key into thatdictionary inserted immediately after the'%'
character. The mapping keyselects the value to be formatted from the mapping. For example:
>>>print(b'%(language)s has%(number)03d quote types.'%...{b'language':b"Python",b"number":2})b'Python has 002 quote types.'
In this case no*
specifiers may occur in a format (since they require asequential parameter list).
The conversion flag characters are:
Flag | 含義 |
---|---|
| The value conversion will use the "alternate form" (where definedbelow). |
| The conversion will be zero padded for numeric values. |
| The converted value is left adjusted (overrides the |
| (a space) A blank should be left before a positive number (or emptystring) produced by a signed conversion. |
| A sign character ( |
A length modifier (h
,l
, orL
) may be present, but is ignored as itis not necessary for Python -- so e.g.%ld
is identical to%d
.
The conversion types are:
Conversion | 含義 | 註解 |
---|---|---|
| Signed integer decimal. | |
| Signed integer decimal. | |
| Signed octal value. | (1) |
| Obsolete type -- it is identical to | (8) |
| Signed hexadecimal (lowercase). | (2) |
| Signed hexadecimal (uppercase). | (2) |
| Floating-point exponential format (lowercase). | (3) |
| Floating-point exponential format (uppercase). | (3) |
| Floating-point decimal format. | (3) |
| Floating-point decimal format. | (3) |
| Floating-point format. Uses lowercase exponentialformat if exponent is less than -4 or not less thanprecision, decimal format otherwise. | (4) |
| Floating-point format. Uses uppercase exponentialformat if exponent is less than -4 or not less thanprecision, decimal format otherwise. | (4) |
| Single byte (accepts integer or singlebyte objects). | |
| Bytes (any object that follows thebuffer protocol or has | (5) |
|
| (6) |
| Bytes (converts any Python object using | (5) |
|
| (7) |
| No argument is converted, results in a |
註解:
The alternate form causes a leading octal specifier (
'0o'
) to beinserted before the first digit.The alternate form causes a leading
'0x'
or'0X'
(depending on whetherthe'x'
or'X'
format was used) to be inserted before the first digit.The alternate form causes the result to always contain a decimal point, even ifno digits follow it.
The precision determines the number of digits after the decimal point anddefaults to 6.
The alternate form causes the result to always contain a decimal point, andtrailing zeroes are not removed as they would otherwise be.
The precision determines the number of significant digits before and after thedecimal point and defaults to 6.
If precision is
N
, the output is truncated toN
characters.b'%s'
已被棄用,但在 3.x 系列中不會被移除。b'%r'
已被棄用,但在 3.x 系列中不會被移除。參閱PEP 237。
備註
The bytearray version of this method doesnot operate in place - italways produces a new object, even if no changes were made.
也參考
PEP 461 - Adding % formatting to bytes and bytearray
在 3.5 版被加入.
Memory Views¶
memoryview
objects allow Python code to access the internal dataof an object that supports thebuffer protocol withoutcopying.
- classmemoryview(object)¶
Create a
memoryview
that referencesobject.object mustsupport the buffer protocol. Built-in objects that support the bufferprotocol includebytes
andbytearray
.A
memoryview
has the notion of anelement, which is theatomic memory unit handled by the originatingobject. For many simpletypes such asbytes
andbytearray
, an element is a singlebyte, but other types such asarray.array
may have bigger elements.len(view)
is equal to the length oftolist
, whichis the nested list representation of the view. Ifview.ndim=1
,this is equal to the number of elements in the view.在 3.12 版的變更:If
view.ndim==0
,len(view)
now raisesTypeError
instead of returning 1.The
itemsize
attribute will give you the number ofbytes in a single element.A
memoryview
supports slicing and indexing to expose its data.One-dimensional slicing will result in a subview:>>>v=memoryview(b'abcefg')>>>v[1]98>>>v[-1]103>>>v[1:4]<memory at 0x7f3ddc9f4350>>>>bytes(v[1:4])b'bce'
If
format
is one of the native format specifiersfrom thestruct
module, indexing with an integer or a tuple ofintegers is also supported and returns a singleelement withthe correct type. One-dimensional memoryviews can be indexedwith an integer or a one-integer tuple. Multi-dimensional memoryviewscan be indexed with tuples of exactlyndim integers wherendim isthe number of dimensions. Zero-dimensional memoryviews can be indexedwith the empty tuple.Here is an example with a non-byte format:
>>>importarray>>>a=array.array('l',[-11111111,22222222,-33333333,44444444])>>>m=memoryview(a)>>>m[0]-11111111>>>m[-1]44444444>>>m[::2].tolist()[-11111111, -33333333]
If the underlying object is writable, the memoryview supportsone-dimensional slice assignment. Resizing is not allowed:
>>>data=bytearray(b'abcefg')>>>v=memoryview(data)>>>v.readonlyFalse>>>v[0]=ord(b'z')>>>databytearray(b'zbcefg')>>>v[1:4]=b'123'>>>databytearray(b'z123fg')>>>v[2:3]=b'spam'Traceback (most recent call last): File"<stdin>", line1, in<module>ValueError:memoryview assignment: lvalue and rvalue have different structures>>>v[2:6]=b'spam'>>>databytearray(b'z1spam')
One-dimensional memoryviews ofhashable (read-only) types with formats'B', 'b' or 'c' are also hashable. The hash is defined as
hash(m)==hash(m.tobytes())
:>>>v=memoryview(b'abcefg')>>>hash(v)==hash(b'abcefg')True>>>hash(v[2:4])==hash(b'ce')True>>>hash(v[::-2])==hash(b'abcefg'[::-2])True
在 3.3 版的變更:One-dimensional memoryviews can now be sliced.One-dimensional memoryviews with formats 'B', 'b' or 'c' are nowhashable.
在 3.4 版的變更:memoryview is now registered automatically with
collections.abc.Sequence
在 3.5 版的變更:memoryviews can now be indexed with tuple of integers.
memoryview
有幾個方法:- __eq__(exporter)¶
A memoryview and aPEP 3118 exporter are equal if their shapes areequivalent and if all corresponding values are equal when the operands'respective format codes are interpreted using
struct
syntax.For the subset of
struct
format strings currently supported bytolist()
,v
andw
are equal ifv.tolist()==w.tolist()
:>>>importarray>>>a=array.array('I',[1,2,3,4,5])>>>b=array.array('d',[1.0,2.0,3.0,4.0,5.0])>>>c=array.array('b',[5,3,1])>>>x=memoryview(a)>>>y=memoryview(b)>>>x==a==y==bTrue>>>x.tolist()==a.tolist()==y.tolist()==b.tolist()True>>>z=y[::-2]>>>z==cTrue>>>z.tolist()==c.tolist()True
If either format string is not supported by the
struct
module,then the objects will always compare as unequal (even if the formatstrings and buffer contents are identical):>>>fromctypesimportBigEndianStructure,c_long>>>classBEPoint(BigEndianStructure):..._fields_=[("x",c_long),("y",c_long)]...>>>point=BEPoint(100,200)>>>a=memoryview(point)>>>b=memoryview(point)>>>a==pointFalse>>>a==bFalse
Note that, as with floating-point numbers,
visw
doesnot implyv==w
for memoryview objects.在 3.3 版的變更:Previous versions compared the raw memory disregarding the item formatand the logical array structure.
- tobytes(order='C')¶
Return the data in the buffer as a bytestring. This is equivalent tocalling the
bytes
constructor on the memoryview.>>>m=memoryview(b"abc")>>>m.tobytes()b'abc'>>>bytes(m)b'abc'
For non-contiguous arrays the result is equal to the flattened listrepresentation with all elements converted to bytes.
tobytes()
supports all format strings, including those that are not instruct
module syntax.在 3.8 版被加入:order can be {'C', 'F', 'A'}. Whenorder is 'C' or 'F', the dataof the original array is converted to C or Fortran order. For contiguousviews, 'A' returns an exact copy of the physical memory. In particular,in-memory Fortran order is preserved. For non-contiguous views, thedata is converted to C first.order=None is the same asorder='C'.
- hex([sep[,bytes_per_sep]])¶
Return a string object containing two hexadecimal digits for eachbyte in the buffer.
>>>m=memoryview(b"abc")>>>m.hex()'616263'
在 3.5 版被加入.
在 3.8 版的變更:Similar to
bytes.hex()
,memoryview.hex()
now supportsoptionalsep andbytes_per_sep parameters to insert separatorsbetween bytes in the hex output.
- tolist()¶
Return the data in the buffer as a list of elements.
>>>memoryview(b'abc').tolist()[97, 98, 99]>>>importarray>>>a=array.array('d',[1.1,2.2,3.3])>>>m=memoryview(a)>>>m.tolist()[1.1, 2.2, 3.3]
- toreadonly()¶
Return a readonly version of the memoryview object. The originalmemoryview object is unchanged.
>>>m=memoryview(bytearray(b'abc'))>>>mm=m.toreadonly()>>>mm.tolist()[97, 98, 99]>>>mm[0]=42Traceback (most recent call last): File"<stdin>", line1, in<module>TypeError:cannot modify read-only memory>>>m[0]=43>>>mm.tolist()[43, 98, 99]
在 3.8 版被加入.
- release()¶
Release the underlying buffer exposed by the memoryview object. Manyobjects take special actions when a view is held on them (for example,a
bytearray
would temporarily forbid resizing); therefore,calling release() is handy to remove these restrictions (and free anydangling resources) as soon as possible.After this method has been called, any further operation on the viewraises a
ValueError
(exceptrelease()
itself which canbe called multiple times):>>>m=memoryview(b'abc')>>>m.release()>>>m[0]Traceback (most recent call last): File"<stdin>", line1, in<module>ValueError:operation forbidden on released memoryview object
The context management protocol can be used for a similar effect,using the
with
statement:>>>withmemoryview(b'abc')asm:...m[0]...97>>>m[0]Traceback (most recent call last): File"<stdin>", line1, in<module>ValueError:operation forbidden on released memoryview object
在 3.2 版被加入.
- cast(format[,shape])¶
Cast a memoryview to a new format or shape.shape defaults to
[byte_length//new_itemsize]
, which means that the result viewwill be one-dimensional. The return value is a new memoryview, butthe buffer itself is not copied. Supported casts are 1D -> C-contiguousand C-contiguous -> 1D.The destination format is restricted to a single element native format in
struct
syntax. One of the formats must be a byte format('B', 'b' or 'c'). The byte length of the result must be the sameas the original length.Note that all byte lengths may depend on the operating system.Cast 1D/long to 1D/unsigned bytes:
>>>importarray>>>a=array.array('l',[1,2,3])>>>x=memoryview(a)>>>x.format'l'>>>x.itemsize8>>>len(x)3>>>x.nbytes24>>>y=x.cast('B')>>>y.format'B'>>>y.itemsize1>>>len(y)24>>>y.nbytes24
Cast 1D/unsigned bytes to 1D/char:
>>>b=bytearray(b'zyz')>>>x=memoryview(b)>>>x[0]=b'a'Traceback (most recent call last):...TypeError:memoryview: invalid type for format 'B'>>>y=x.cast('c')>>>y[0]=b'a'>>>bbytearray(b'ayz')
Cast 1D/bytes to 3D/ints to 1D/signed char:
>>>importstruct>>>buf=struct.pack("i"*12,*list(range(12)))>>>x=memoryview(buf)>>>y=x.cast('i',shape=[2,2,3])>>>y.tolist()[[[0, 1, 2], [3, 4, 5]], [[6, 7, 8], [9, 10, 11]]]>>>y.format'i'>>>y.itemsize4>>>len(y)2>>>y.nbytes48>>>z=y.cast('b')>>>z.format'b'>>>z.itemsize1>>>len(z)48>>>z.nbytes48
Cast 1D/unsigned long to 2D/unsigned long:
>>>buf=struct.pack("L"*6,*list(range(6)))>>>x=memoryview(buf)>>>y=x.cast('L',shape=[2,3])>>>len(y)2>>>y.nbytes48>>>y.tolist()[[0, 1, 2], [3, 4, 5]]
在 3.3 版被加入.
在 3.5 版的變更:The source format is no longer restricted when casting to a byte view.
There are also several readonly attributes available:
- obj¶
The underlying object of the memoryview:
>>>b=bytearray(b'xyz')>>>m=memoryview(b)>>>m.objisbTrue
在 3.3 版被加入.
- nbytes¶
nbytes==product(shape)*itemsize==len(m.tobytes())
. This isthe amount of space in bytes that the array would use in a contiguousrepresentation. It is not necessarily equal tolen(m)
:>>>importarray>>>a=array.array('i',[1,2,3,4,5])>>>m=memoryview(a)>>>len(m)5>>>m.nbytes20>>>y=m[::2]>>>len(y)3>>>y.nbytes12>>>len(y.tobytes())12
Multi-dimensional arrays:
>>>importstruct>>>buf=struct.pack("d"*12,*[1.5*xforxinrange(12)])>>>x=memoryview(buf)>>>y=x.cast('d',shape=[3,4])>>>y.tolist()[[0.0, 1.5, 3.0, 4.5], [6.0, 7.5, 9.0, 10.5], [12.0, 13.5, 15.0, 16.5]]>>>len(y)3>>>y.nbytes96
在 3.3 版被加入.
- readonly¶
A bool indicating whether the memory is read only.
- format¶
A string containing the format (in
struct
module style) for eachelement in the view. A memoryview can be created from exporters witharbitrary format strings, but some methods (e.g.tolist()
) arerestricted to native single element formats.在 3.3 版的變更:format
'B'
is now handled according to the struct module syntax.This means thatmemoryview(b'abc')[0]==b'abc'[0]==97
.
- itemsize¶
The size in bytes of each element of the memoryview:
>>>importarray,struct>>>m=memoryview(array.array('H',[32000,32001,32002]))>>>m.itemsize2>>>m[0]32000>>>struct.calcsize('H')==m.itemsizeTrue
- ndim¶
An integer indicating how many dimensions of a multi-dimensional array thememory represents.
- shape¶
A tuple of integers the length of
ndim
giving the shape of thememory as an N-dimensional array.在 3.3 版的變更:An empty tuple instead of
None
when ndim = 0.
- strides¶
A tuple of integers the length of
ndim
giving the size in bytes toaccess each element for each dimension of the array.在 3.3 版的變更:An empty tuple instead of
None
when ndim = 0.
- suboffsets¶
Used internally for PIL-style arrays. The value is informational only.
- c_contiguous¶
A bool indicating whether the memory is C-contiguous.
在 3.3 版被加入.
- f_contiguous¶
A bool indicating whether the memory is Fortrancontiguous.
在 3.3 版被加入.
- contiguous¶
A bool indicating whether the memory iscontiguous.
在 3.3 版被加入.
Set Types ---set
,frozenset
¶
Aset object is an unordered collection of distincthashable objects.Common uses include membership testing, removing duplicates from a sequence, andcomputing mathematical operations such as intersection, union, difference, andsymmetric difference.(For other containers see the built-indict
,list
,andtuple
classes, and thecollections
module.)
Like other collections, sets supportxinset
,len(set)
, andforxinset
. Being an unordered collection, sets do not record element position ororder of insertion. Accordingly, sets do not support indexing, slicing, orother sequence-like behavior.
There are currently two built-in set types,set
andfrozenset
.Theset
type is mutable --- the contents can be changed using methodslikeadd()
andremove()
. Since it is mutable, it has nohash value and cannot be used as either a dictionary key or as an element ofanother set. Thefrozenset
type is immutable andhashable ---its contents cannot be altered after it is created; it can therefore be used asa dictionary key or as an element of another set.
Non-empty sets (not frozensets) can be created by placing a comma-separated listof elements within braces, for example:{'jack','sjoerd'}
, in addition to theset
constructor.
The constructors for both classes work the same:
- classset([iterable])¶
- classfrozenset([iterable])¶
Return a new set or frozenset object whose elements are taken fromiterable. The elements of a set must behashable. Torepresent sets of sets, the inner sets must be
frozenset
objects. Ifiterable is not specified, a new empty set isreturned.Sets can be created by several means:
Use a comma-separated list of elements within braces:
{'jack','sjoerd'}
Use a set comprehension:
{cforcin'abracadabra'ifcnotin'abc'}
Use the type constructor:
set()
,set('foobar')
,set(['a','b','foo'])
Instances of
set
andfrozenset
provide the followingoperations:- len(s)
Return the number of elements in sets (cardinality ofs).
- xins
Testx for membership ins.
- xnotins
Testx for non-membership ins.
- isdisjoint(other)¶
Return
True
if the set has no elements in common withother. Sets aredisjoint if and only if their intersection is the empty set.
- issubset(other)¶
- set<=other
Test whether every element in the set is inother.
- set<other
Test whether the set is a proper subset ofother, that is,
set<=otherandset!=other
.
- issuperset(other)¶
- set>=other
Test whether every element inother is in the set.
- set>other
Test whether the set is a proper superset ofother, that is,
set>=otherandset!=other
.
- union(*others)¶
- set|other|...
Return a new set with elements from the set and all others.
- intersection(*others)¶
- set&other&...
Return a new set with elements common to the set and all others.
- difference(*others)¶
- set-other-...
Return a new set with elements in the set that are not in the others.
- symmetric_difference(other)¶
- set^other
Return a new set with elements in either the set orother but not both.
- copy()¶
Return a shallow copy of the set.
Note, the non-operator versions of
union()
,intersection()
,difference()
,symmetric_difference()
,issubset()
, andissuperset()
methods will accept any iterable as an argument. Incontrast, their operator based counterparts require their arguments to besets. This precludes error-prone constructions likeset('abc')&'cbs'
in favor of the more readableset('abc').intersection('cbs')
.Both
set
andfrozenset
support set to set comparisons. Twosets are equal if and only if every element of each set is contained in theother (each is a subset of the other). A set is less than another set if andonly if the first set is a proper subset of the second set (is a subset, butis not equal). A set is greater than another set if and only if the first setis a proper superset of the second set (is a superset, but is not equal).Instances of
set
are compared to instances offrozenset
based on their members. For example,set('abc')==frozenset('abc')
returnsTrue
and so doesset('abc')inset([frozenset('abc')])
.The subset and equality comparisons do not generalize to a total orderingfunction. For example, any two nonempty disjoint sets are not equal and are notsubsets of each other, soall of the following return
False
:a<b
,a==b
, ora>b
.Since sets only define partial ordering (subset relationships), the output ofthe
list.sort()
method is undefined for lists of sets.Set elements, like dictionary keys, must behashable.
Binary operations that mix
set
instances withfrozenset
return the type of the first operand. For example:frozenset('ab')|set('bc')
returns an instance offrozenset
.The following table lists operations available for
set
that do notapply to immutable instances offrozenset
:- update(*others)¶
- set|=other|...
Update the set, adding elements from all others.
- intersection_update(*others)¶
- set&=other&...
Update the set, keeping only elements found in it and all others.
- difference_update(*others)¶
- set-=other|...
Update the set, removing elements found in others.
- symmetric_difference_update(other)¶
- set^=other
Update the set, keeping only elements found in either set, but not in both.
- add(elem)¶
將元素elem 加入集合。
- discard(elem)¶
如果elem 存在於集合中則將其移除。
- clear()¶
從集合中移除所有元素。
Note, the non-operator versions of the
update()
,intersection_update()
,difference_update()
, andsymmetric_difference_update()
methods will accept any iterable as anargument.Note, theelem argument to the
__contains__()
,remove()
, anddiscard()
methods may be a set. To support searching for an equivalentfrozenset, a temporary one is created fromelem.
Mapping Types ---dict
¶
Amapping object mapshashable values to arbitrary objects.Mappings are mutable objects. There is currently only one standard mappingtype, thedictionary. (For other containers see the built-inlist
,set
, andtuple
classes, and thecollections
module.)
A dictionary's keys arealmost arbitrary values. Values that are nothashable, that is, values containing lists, dictionaries or othermutable types (that are compared by value rather than by object identity) maynot be used as keys.Values that compare equal (such as1
,1.0
, andTrue
)can be used interchangeably to index the same dictionary entry.
- classdict(**kwargs)¶
- classdict(mapping,**kwargs)
- classdict(iterable,**kwargs)
Return a new dictionary initialized from an optional positional argumentand a possibly empty set of keyword arguments.
字典可以用數種方式建立:
Use a comma-separated list of
key:value
pairs within braces:{'jack':4098,'sjoerd':4127}
or{4098:'jack',4127:'sjoerd'}
Use a dict comprehension:
{}
,{x:x**2forxinrange(10)}
Use the type constructor:
dict()
,dict([('foo',100),('bar',200)])
,dict(foo=100,bar=200)
If no positional argument is given, an empty dictionary is created.If a positional argument is given and it defines a
keys()
method, adictionary is created by calling__getitem__()
on the argument witheach returned key from the method. Otherwise, the positional argument must be aniterable object. Each item in the iterable must itself be an iterablewith exactly two elements. The first element of each item becomes a key in thenew dictionary, and the second element the corresponding value. If a key occursmore than once, the last value for that key becomes the corresponding value inthe new dictionary.If keyword arguments are given, the keyword arguments and their values areadded to the dictionary created from the positional argument. If a keybeing added is already present, the value from the keyword argumentreplaces the value from the positional argument.
Providing keyword arguments as in the first example only works for keys thatare valid Python identifiers. Otherwise, any valid keys can be used.
Dictionaries compare equal if and only if they have the same
(key,value)
pairs (regardless of ordering). Order comparisons ('<', '<=', '>=', '>') raiseTypeError
. To illustrate dictionary creation and equality,the following examples all return a dictionary equal to{"one":1,"two":2,"three":3}
:>>>a=dict(one=1,two=2,three=3)>>>b={'one':1,'two':2,'three':3}>>>c=dict(zip(['one','two','three'],[1,2,3]))>>>d=dict([('two',2),('one',1),('three',3)])>>>e=dict({'three':3,'one':1,'two':2})>>>f=dict({'one':1,'three':3},two=2)>>>a==b==c==d==e==fTrue
Providing keyword arguments as in the first example only works for keys thatare valid Python identifiers. Otherwise, any valid keys can be used.
Dictionaries preserve insertion order. Note that updating a key does notaffect the order. Keys added after deletion are inserted at the end.
>>>d={"one":1,"two":2,"three":3,"four":4}>>>d{'one': 1, 'two': 2, 'three': 3, 'four': 4}>>>list(d)['one', 'two', 'three', 'four']>>>list(d.values())[1, 2, 3, 4]>>>d["one"]=42>>>d{'one': 42, 'two': 2, 'three': 3, 'four': 4}>>>deld["two"]>>>d["two"]=None>>>d{'one': 42, 'three': 3, 'four': 4, 'two': None}
在 3.7 版的變更:Dictionary order is guaranteed to be insertion order. This behavior wasan implementation detail of CPython from 3.6.
These are the operations that dictionaries support (and therefore, custommapping types should support too):
- list(d)
Return a list of all the keys used in the dictionaryd.
- len(d)
Return the number of items in the dictionaryd.
- d[key]
Return the item ofd with keykey. Raises a
KeyError
ifkey isnot in the map.If a subclass of dict defines a method
__missing__()
andkeyis not present, thed[key]
operation calls that method with the keykeyas argument. Thed[key]
operation then returns or raises whatever isreturned or raised by the__missing__(key)
call.No other operations or methods invoke__missing__()
. If__missing__()
is not defined,KeyError
is raised.__missing__()
must be a method; it cannot be an instance variable:>>>classCounter(dict):...def__missing__(self,key):...return0...>>>c=Counter()>>>c['red']0>>>c['red']+=1>>>c['red']1
The example above shows part of the implementation of
collections.Counter
. A different__missing__
method is usedbycollections.defaultdict
.
- d[key]=value
將
d[key]
設為value。
- deld[key]
從d 中移除
d[key]
。若key 不在對映中則引發KeyError
。
- keyind
若d 有鍵key 則回傳
True
,否則回傳False
。
- keynotind
等價於
notkeyind
。
- iter(d)
Return an iterator over the keys of the dictionary. This is a shortcutfor
iter(d.keys())
.
- clear()¶
從字典中移除所有項目。
- copy()¶
Return a shallow copy of the dictionary.
- classmethodfromkeys(iterable,value=None,/)¶
Create a new dictionary with keys fromiterable and values set tovalue.
fromkeys()
is a class method that returns a new dictionary.valuedefaults toNone
. All of the values refer to just a single instance,so it generally doesn't make sense forvalue to be a mutable objectsuch as an empty list. To get distinct values, use adictcomprehension instead.
- get(key,default=None,/)¶
Return the value forkey ifkey is in the dictionary, elsedefault.Ifdefault is not given, it defaults to
None
, so that this methodnever raises aKeyError
.
- items()¶
Return a new view of the dictionary's items (
(key,value)
pairs).See thedocumentation of view objects.
- keys()¶
Return a new view of the dictionary's keys. See thedocumentationof view objects.
- pop(key[,default])¶
Ifkey is in the dictionary, remove it and return its value, else returndefault. Ifdefault is not given andkey is not in the dictionary,a
KeyError
is raised.
- popitem()¶
Remove and return a
(key,value)
pair from the dictionary.Pairs are returned inLIFO order.popitem()
is useful to destructively iterate over a dictionary, asoften used in set algorithms. If the dictionary is empty, callingpopitem()
raises aKeyError
.在 3.7 版的變更:LIFO order is now guaranteed. In prior versions,
popitem()
wouldreturn an arbitrary key/value pair.
- reversed(d)
Return a reverse iterator over the keys of the dictionary. This is ashortcut for
reversed(d.keys())
.在 3.8 版被加入.
- setdefault(key,default=None,/)¶
Ifkey is in the dictionary, return its value. If not, insertkeywith a value ofdefault and returndefault.default defaults to
None
.
- update([other])¶
Update the dictionary with the key/value pairs fromother, overwritingexisting keys. Return
None
.update()
accepts either another object with akeys()
method (inwhich case__getitem__()
is called with every key returned fromthe method) or an iterable of key/value pairs (as tuples or other iterablesof length two). If keyword arguments are specified, the dictionary is thenupdated with those key/value pairs:d.update(red=1,blue=2)
.
- values()¶
Return a new view of the dictionary's values. See thedocumentation of view objects.
An equality comparison between one
dict.values()
view and anotherwill always returnFalse
. This also applies when comparingdict.values()
to itself:>>>d={'a':1}>>>d.values()==d.values()False
- d|other
Create a new dictionary with the merged keys and values ofd andother, which must both be dictionaries. The values ofother takepriority whend andother share keys.
在 3.9 版被加入.
- d|=other
Update the dictionaryd with keys and values fromother, which may beeither amapping or aniterable of key/value pairs. Thevalues ofother take priority whend andother share keys.
在 3.9 版被加入.
Dictionaries and dictionary views are reversible.
>>>d={"one":1,"two":2,"three":3,"four":4}>>>d{'one': 1, 'two': 2, 'three': 3, 'four': 4}>>>list(reversed(d))['four', 'three', 'two', 'one']>>>list(reversed(d.values()))[4, 3, 2, 1]>>>list(reversed(d.items()))[('four', 4), ('three', 3), ('two', 2), ('one', 1)]
在 3.8 版的變更:Dictionaries are now reversible.
也參考
types.MappingProxyType
can be used to create a read-only viewof adict
.
字典視圖物件¶
The objects returned bydict.keys()
,dict.values()
anddict.items()
areview objects. They provide a dynamic view on thedictionary's entries, which means that when the dictionary changes, the viewreflects these changes.
Dictionary views can be iterated over to yield their respective data, andsupport membership tests:
- len(dictview)
Return the number of entries in the dictionary.
- iter(dictview)
Return an iterator over the keys, values or items (represented as tuples of
(key,value)
) in the dictionary.Keys and values are iterated over in insertion order.This allows the creation of
(value,key)
pairsusingzip()
:pairs=zip(d.values(),d.keys())
. Another way tocreate the same list ispairs=[(v,k)for(k,v)ind.items()]
.Iterating views while adding or deleting entries in the dictionary may raisea
RuntimeError
or fail to iterate over all entries.在 3.7 版的變更:Dictionary order is guaranteed to be insertion order.
- xindictview
Return
True
ifx is in the underlying dictionary's keys, values oritems (in the latter case,x should be a(key,value)
tuple).
- reversed(dictview)
Return a reverse iterator over the keys, values or items of the dictionary.The view will be iterated in reverse order of the insertion.
在 3.8 版的變更:Dictionary views are now reversible.
- dictview.mapping
Return a
types.MappingProxyType
that wraps the originaldictionary to which the view refers.在 3.10 版被加入.
Keys views are set-like since their entries are unique andhashable.Items views also have set-like operations since the (key, value) pairsare unique and the keys are hashable.If all values in an items view are hashable as well,then the items view can interoperate with other sets.(Values views are not treated as set-likesince the entries are generally not unique.) For set-like views, all of theoperations defined for the abstract base classcollections.abc.Set
areavailable (for example,==
,<
, or^
). While using set operators,set-like views accept any iterable as the other operand,unlike sets which only accept sets as the input.
An example of dictionary view usage:
>>>dishes={'eggs':2,'sausage':1,'bacon':1,'spam':500}>>>keys=dishes.keys()>>>values=dishes.values()>>># iteration>>>n=0>>>forvalinvalues:...n+=val...>>>print(n)504>>># keys and values are iterated over in the same order (insertion order)>>>list(keys)['eggs', 'sausage', 'bacon', 'spam']>>>list(values)[2, 1, 1, 500]>>># view objects are dynamic and reflect dict changes>>>deldishes['eggs']>>>deldishes['sausage']>>>list(keys)['bacon', 'spam']>>># set operations>>>keys&{'eggs','bacon','salad'}{'bacon'}>>>keys^{'sausage','juice'}=={'juice','sausage','bacon','spam'}True>>>keys|['juice','juice','juice']=={'bacon','spam','juice'}True>>># get back a read-only proxy for the original dictionary>>>values.mappingmappingproxy({'bacon': 1, 'spam': 500})>>>values.mapping['spam']500
情境管理器型別¶
Python 的with
陳述式支援了由情境管理器定義之 runtime 情境的概念,要使用兩個方法來實作,該方法讓使用者定義類別能夠去定義 runtime 情境,且該情境在執行陳述式主體 (statement body) 之前進入、在陳述式結束時退出:
- contextmanager.__enter__()¶
輸入 runtime 情境並回傳此物件或者與 runtime 情境相關的另一個物件。此方法回傳的值有被綁定到使用此情境管理器的
with
陳述式的as
子句中的識別字。一個會回傳自己的情境管理器範例是file object。檔案物件從 __enter__() 回傳自己,以允許將
open()
用作with
陳述式中的情境運算式。一個會回傳相關物件的情境管理器範例是由
decimal.localcontext()
回傳的管理器。這些管理器將有效的十進位情境設定為原始十進位情境的副本,然後回傳該副本。這允許對with
陳述式主體中的目前十進位情境進行更改,而不會影響with
陳述式外部的程式碼。
- contextmanager.__exit__(exc_type,exc_val,exc_tb)¶
退出 runtime 情境並回傳布林旗標以表示是否應抑制曾發生的任何例外。如果在執行
with
陳述式主體時發生例外,則引數包含例外型別、值和回溯 (traceback) 資訊。否則,所有三個引數都是None
。從此方法回傳 true 值將導致
with
陳述式抑制例外並繼續執行緊接著with
陳述式之後的陳述式。否則,該例外將在該方法執行完畢後繼續傳播 (propagate)。執行此方法期間發生的例外會取代with
陳述式主體中發生的任何例外。傳入的例外不應明確重新引發 - 取而代之的是,此方法應回傳 false 值以指示該方法已成功完成且不希望抑制引發的例外。這讓情境管理程式碼能輕鬆檢測
__exit__()
方法是否曾實際失敗過。
Python 定義了多個情境管理器來支援簡單的執行緒同步、檔案或其他物件的提示關閉以及對有效十進位算術情境的更簡單操作。除了情境管理協定的實作之外,不會對特定型別進行特殊處理。更多範例請參閱contextlib
模組。
Python 的generator 和contextlib.contextmanager
裝飾器提供了一種便捷的方法來實作這些協定。如果產生器函式以contextlib.contextmanager
裝飾器裝飾,它將回傳一個有實作出需要的__enter__()
和__exit__()
方法的情境管理器,而不是由未裝飾產生器函式產生的疊代器。
請注意,Python/C API 中 Python 物件的型別結構中的任何方法都沒有特定的槽。想要定義這些方法的擴充型別必須將它們作為普通的 Python 可存取方法提供。與設定 runtime 情境的開銷相比,單一類別字典查找的開銷可以忽略不計。
型別註釋的型別 ---泛型別名 (Generic Alias)、聯合 (Union)¶
泛型別名型別¶
GenericAlias
物件通常是透過下標 (subscripting) 一個類別來建立的。它們最常與容器類別 一起使用,像是list
或dict
。例如list[int]
是一個GenericAlias
物件,它是透過使用引數int
來下標list
類別而建立的。GenericAlias
物件主要會與型別註釋 一起使用。
備註
通常只有當類別有實作特殊方法__class_getitem__()
時才可以去下標該類別。
將一個GenericAlias
物件用作generic type 的代理,實作參數化泛型 (parameterized generics)。
對於一個容器類別,提供給該類別的下標引數可以代表物件所包含元素的型別。例如set[bytes]
可以用於型別註釋來表示一個set
,其中所有元素的型別都是bytes
。
對於定義__class_getitem__()
但不是容器的類別,提供給該類別的下標引數通常會指示物件上有定義的一個或多個方法的回傳型別。例如正規表示式
可以用於str
和bytes
資料型別:
如果
x=re.search('foo','foo')
,x
將會是一個re.Match 物件,其中x.group(0)
和x[0]
的回傳值都是str
型別。我們就可以用GenericAlias
re.Match[str]
在型別註釋中表示這種物件。如果
y=re.search(b'bar',b'bar')
(注意bytes
的b
),y
也會是re.Match
的實例,但y.group(0)
和y[0]
的回傳值的型別都是bytes
。在型別註釋中,我們將用re.Match[bytes]
來表示各種re.Match 物件。
GenericAlias
物件是types.GenericAlias
類別的實例,也可以用來直接建立GenericAlias
物件。
- T[X,Y,...]
建立一個
GenericAlias
來表示一個型別T
,其以型別X、Y 等(取決於所使用的T
)來參數化。例如,一個函式需要一個包含float
元素的list
:defaverage(values:list[float])->float:returnsum(values)/len(values)
對映物件的另一個範例,使用
dict
,它是一個泛型型別,需要兩個型別參數,分別表示鍵型別和值型別。在此範例中,函式需要一個dict
,其帶有str
型別的鍵和int
型別的值:defsend_post_request(url:str,body:dict[str,int])->None:...
內建函式isinstance()
和issubclass()
不接受GenericAlias
型別作為第二個引數:
>>>isinstance([1,2],list[str])Traceback (most recent call last): File"<stdin>", line1, in<module>TypeError:isinstance() argument 2 cannot be a parameterized generic
Python runtime 不強制執行型別註釋。這也擴展到泛型型別及其型別參數。當從GenericAlias
建立容器物件時,不會檢查容器中元素的型別。例如,不鼓勵使用以下程式碼,但 runtime 不會出現錯誤:
>>>t=list[str]>>>t([1,2,3])[1, 2, 3]
此外,參數化泛型在物件建立期間會擦除 (erase) 型別參數:
>>>t=list[str]>>>type(t)<class 'types.GenericAlias'>>>>l=t()>>>type(l)<class 'list'>
>>>repr(list[int])'list[int]'>>>str(list[int])'list[int]'
為防止像是dict[str][str]
的錯誤出現,泛型容器的__getitem__()
方法會在這種情況下引發例外:
>>>dict[str][str]Traceback (most recent call last):...TypeError:dict[str] is not a generic class
然而當使用型別變數 (type variable) 時,此類運算式是有效的。索引的元素數量必須與GenericAlias
物件的__args__
中的型別變數項目一樣多:
>>>fromtypingimportTypeVar>>>Y=TypeVar('Y')>>>dict[str,Y][int]dict[str, int]
標準泛型類別¶
以下標準函式庫類別有支援參數化泛型。此列表並非詳盡無遺。
GenericAlias
物件的特殊屬性¶
所有參數化泛型都有實作特殊的唯讀屬性。
- genericalias.__origin__¶
此屬性指向非參數化泛型類別:
>>>list[int].__origin__<class 'list'>
- genericalias.__args__¶
此屬性是傳遞給泛型類別之原始
__class_getitem__()
的泛型型別tuple
(長度可以為 1):>>>dict[str,list[int]].__args__(<class 'str'>, list[int])
- genericalias.__parameters__¶
此屬性是個會被延遲計算 (lazily computed) 的元組(可能為空),包含了在
__args__
中找得到的不重複型別變數:>>>fromtypingimportTypeVar>>>T=TypeVar('T')>>>list[T].__parameters__(~T,)
備註
具有
typing.ParamSpec
參數的一個GenericAlias
物件在替換後可能沒有正確的__parameters__
,因為typing.ParamSpec
主要用於靜態型別檢查。
- genericalias.__unpacked__¶
如果別名已使用
*
運算子解包 (unpack) 則為 true 的布林值(請參閱TypeVarTuple
)。在 3.11 版被加入.
也參考
- PEP 484 - 型別提示
引入 Python 的型別註釋框架。
- PEP 585 - 標準集合 (Standard Collections) 中的型別提示泛型
引入原生參數化標準函式庫類別的能力,前提是它們有實作特殊的類別方法
__class_getitem__()
。- 泛型、使用者定義泛型和
typing.Generic
有關如何實作可以在 runtime 參數化並能被靜態型別檢查器理解的泛型類別的文件。
在 3.9 版被加入.
聯合型別 (Union Type)¶
一個聯合物件可以保存多個型別物件 (type object)之|
(位元 or)運算的值。這些型別主要用於型別註釋 (type annotation)。與typing.Union
相比,聯合型別運算式可以讓型別提示語法更清晰簡潔。
- X|Y|...
定義一個包含X、Y 等型別的聯合物件。
X|Y
表示 X 或 Y。它相當於typing.Union[X,Y]
。舉例來說,下列函式需要一個型別為int
或float
的引數:defsquare(number:int|float)->int|float:returnnumber**2
備註
不能在 runtime 使用
|
運算元 (operand) 來定義有一個以上的成員為向前參照 (forward reference) 的聯合。例如int|"Foo"
,其中"Foo"
是對未定義類別的參照,將在 runtime 失敗。對於包含向前參照的聯合,請將整個運算式以字串呈現,例如"int|Foo"
。
- union_object==other
聯合物件可以與其他聯合物件一起進行相等性測試。細節如下:
聯合的聯合會被扁平化:
(int|str)|float==int|str|float
冗餘型別會被刪除:
int|str|int==int|str
比較聯合時,順序會被忽略:
int|str==str|int
它與
typing.Union
相容:int|str==typing.Union[int,str]
可選型別可以表示為與
None
的聯合:str|None==typing.Optional[str]
- isinstance(obj,union_object)
- issubclass(obj,union_object)
聯合物件也支援
isinstance()
和issubclass()
的呼叫:>>>isinstance("",int|str)True
然而聯合物件中的參數化泛型則無法被檢查:
>>>isinstance(1,int|list[int])# short-circuit evaluationTrue>>>isinstance([1],int|list[int])Traceback (most recent call last):...TypeError:isinstance() argument 2 cannot be a parameterized generic
構成聯合物件的對使用者公開型別 (user-exposed type) 可以透過types.UnionType
存取並用於isinstance()
檢查。物件不能以型別來實例化:
>>>importtypes>>>isinstance(int|str,types.UnionType)True>>>types.UnionType()Traceback (most recent call last): File"<stdin>", line1, in<module>TypeError:cannot create 'types.UnionType' instances
備註
新增了型別物件的__or__()
方法來支援X|Y
語法。如果元類別有實作__or__()
,則 Union 可以覆寫 (override) 它:
>>>classM(type):...def__or__(self,other):...return"Hello"...>>>classC(metaclass=M):...pass...>>>C|int'Hello'>>>int|Cint | C
也參考
PEP 604 -- PEP 提出X|Y
語法和聯合型別。
在 3.10 版被加入.
其他內建型別¶
The interpreter supports several other kinds of objects. Most of these supportonly one or two operations.
模組¶
The only special operation on a module is attribute access:m.name
, wherem is a module andname accesses a name defined inm's symbol table.Module attributes can be assigned to. (Note that theimport
statement is not, strictly speaking, an operation on a module object;importfoo
does not require a module object namedfoo to exist, rather it requiresan (external)definition for a module namedfoo somewhere.)
A special attribute of every module is__dict__
. This is thedictionary containing the module's symbol table. Modifying this dictionary willactually change the module's symbol table, but direct assignment to the__dict__
attribute is not possible (you can writem.__dict__['a']=1
, which definesm.a
to be1
, but you can't writem.__dict__={}
). Modifying__dict__
directly isnot recommended.
Modules built into the interpreter are written like this:<module'sys'(built-in)>
. If loaded from a file, they are written as<module'os'from'/usr/local/lib/pythonX.Y/os.pyc'>
.
類別與類別實例¶
函式¶
Function objects are created by function definitions. The only operation on afunction object is to call it:func(argument-list)
.
There are really two flavors of function objects: built-in functions anduser-defined functions. Both support the same operation (to call the function),but the implementation is different, hence the different object types.
更多資訊請見函式定義。
方法¶
Methods are functions that are called using the attribute notation. There aretwo flavors:built-in methods (such asappend()
on lists) andclass instance method.Built-in methods are described with the types that support them.
If you access a method (a function defined in a class namespace) through aninstance, you get a special object: abound method (also calledinstance method) object. When called, it will addtheself
argumentto the argument list. Bound methods have two special read-only attributes:m.__self__
is the object on which the methodoperates, andm.__func__
isthe function implementing the method. Callingm(arg-1,arg-2,...,arg-n)
is completely equivalent to callingm.__func__(m.__self__,arg-1,arg-2,...,arg-n)
.
Likefunction objects, bound method objects supportgetting arbitraryattributes. However, since method attributes are actually stored on theunderlying function object (method.__func__
), setting method attributes onbound methods is disallowed. Attempting to set an attribute on a methodresults in anAttributeError
being raised. In order to set a methodattribute, you need to explicitly set it on the underlying function object:
>>>classC:...defmethod(self):...pass...>>>c=C()>>>c.method.whoami='my name is method'# 不得設定於方法Traceback (most recent call last): File"<stdin>", line1, in<module>AttributeError:'method' object has no attribute 'whoami'>>>c.method.__func__.whoami='my name is method'>>>c.method.whoami'my name is method'
更多資訊請見實例方法。
程式碼物件¶
Code objects are used by the implementation to represent "pseudo-compiled"executable Python code such as a function body. They differ from functionobjects because they don't contain a reference to their global executionenvironment. Code objects are returned by the built-incompile()
functionand can be extracted from function objects through their__code__
attribute. See also thecode
module.
存取__code__
會引發一個附帶引數obj
與"__code__"
的稽核事件object.__getattr__
。
A code object can be executed or evaluated by passing it (instead of a sourcestring) to theexec()
oreval()
built-in functions.
更多資訊請見標準型別階層。
Type Objects¶
Type objects represent the various object types. An object's type is accessedby the built-in functiontype()
. There are no special operations ontypes. The standard moduletypes
defines names for all standard built-intypes.
Types are written like this:<class'int'>
.
Null 物件¶
This object is returned by functions that don't explicitly return a value. Itsupports no special operations. There is exactly one null object, namedNone
(a built-in name).type(None)()
produces the same singleton.
它被寫為None
。
Ellipsis 物件¶
This object is commonly used by slicing (seeSlicings). It supports nospecial operations. There is exactly one ellipsis object, namedEllipsis
(a built-in name).type(Ellipsis)()
produces theEllipsis
singleton.
它被寫為Ellipsis
或...
。
NotImplemented 物件¶
This object is returned from comparisons and binary operations when they areasked to operate on types they don't support. SeeComparisons for moreinformation. There is exactly oneNotImplemented
object.type(NotImplemented)()
produces the singleton instance.
It is written asNotImplemented
.
內部物件¶
See標準型別階層 for this information. It describesstack frame objects,traceback objects, and slice objects.
特殊屬性¶
The implementation adds a few special read-only attributes to several objecttypes, where they are relevant. Some of these are not reported by thedir()
built-in function.
- definition.__name__¶
The name of the class, function, method, descriptor, orgenerator instance.
- definition.__qualname__¶
Thequalified name of the class, function, method, descriptor,or generator instance.
在 3.3 版被加入.
- definition.__module__¶
The name of the module in which a class or function was defined.
- definition.__doc__¶
The documentation string of a class or function, or
None
if undefined.
- definition.__type_params__¶
Thetype parameters of generic classes, functions,andtype aliases. For classes and functions thatare not generic, this will be an empty tuple.
在 3.12 版被加入.
Integer string conversion length limitation¶
CPython has a global limit for converting betweenint
andstr
to mitigate denial of service attacks. This limitonly applies to decimal orother non-power-of-two number bases. Hexadecimal, octal, and binary conversionsare unlimited. The limit can be configured.
Theint
type in CPython is an arbitrary length number stored in binaryform (commonly known as a "bignum"). There exists no algorithm that can converta string to a binary integer or a binary integer to a string in linear time,unless the base is a power of 2. Even the best known algorithms for base 10have sub-quadratic complexity. Converting a large value such asint('1'*500_000)
can take over a second on a fast CPU.
Limiting conversion size offers a practical way to avoidCVE 2020-10735.
The limit is applied to the number of digit characters in the input or outputstring when a non-linear conversion algorithm would be involved. Underscoresand the sign are not counted towards the limit.
When an operation would exceed the limit, aValueError
is raised:
>>>importsys>>>sys.set_int_max_str_digits(4300)# Illustrative, this is the default.>>>_=int('2'*5432)Traceback (most recent call last):...ValueError:Exceeds the limit (4300 digits) for integer string conversion: value has 5432 digits; use sys.set_int_max_str_digits() to increase the limit>>>i=int('2'*4300)>>>len(str(i))4300>>>i_squared=i*i>>>len(str(i_squared))Traceback (most recent call last):...ValueError:Exceeds the limit (4300 digits) for integer string conversion; use sys.set_int_max_str_digits() to increase the limit>>>len(hex(i_squared))7144>>>assertint(hex(i_squared),base=16)==i*i# Hexadecimal is unlimited.
The default limit is 4300 digits as provided insys.int_info.default_max_str_digits
.The lowest limit that can be configured is 640 digits as provided insys.int_info.str_digits_check_threshold
.
Verification:
>>>importsys>>>assertsys.int_info.default_max_str_digits==4300,sys.int_info>>>assertsys.int_info.str_digits_check_threshold==640,sys.int_info>>>msg=int('578966293710682886880994035146873798396722250538762761564'...'9252925514383915483333812743580549779436104706260696366600'...'571186405732').to_bytes(53,'big')...
在 3.11 版被加入.
受影響的 API¶
The limitation only applies to potentially slow conversions betweenint
andstr
orbytes
:
int(string)
以預設的 10 為底。int(string,base)
for all bases that are not a power of 2.str(integer)
。repr(integer)
。any other string conversion to base 10, for example
f"{integer}"
,"{}".format(integer)
, orb"%d"%integer
.
The limitations do not apply to functions with a linear algorithm:
int(string,base)
with base 2, 4, 8, 16, or 32.格式規格 (Format Specification) 迷你語言 for hex, octal, and binary numbers.
設定限制¶
Before Python starts up you can use an environment variable or an interpretercommand line flag to configure the limit:
PYTHONINTMAXSTRDIGITS
, e.g.PYTHONINTMAXSTRDIGITS=640python3
to set the limit to 640 orPYTHONINTMAXSTRDIGITS=0python3
to disable the limitation.-Xint_max_str_digits
,例如python3-Xint_max_str_digits=640
sys.flags.int_max_str_digits
contains the value ofPYTHONINTMAXSTRDIGITS
or-Xint_max_str_digits
.If both the env var and the-X
option are set, the-X
option takesprecedence. A value of-1 indicates that both were unset, thus a value ofsys.int_info.default_max_str_digits
was used during initialization.
From code, you can inspect the current limit and set a new one using thesesys
APIs:
sys.get_int_max_str_digits()
andsys.set_int_max_str_digits()
area getter and setter for the interpreter-wide limit. Subinterpreters havetheir own limit.
Information about the default and minimum can be found insys.int_info
:
sys.int_info.default_max_str_digits
is the compiled-indefault limit.sys.int_info.str_digits_check_threshold
is the lowestaccepted value for the limit (other than 0 which disables it).
在 3.11 版被加入.
警示
Setting a low limitcan lead to problems. While rare, code exists thatcontains integer constants in decimal in their source that exceed theminimum threshold. A consequence of setting the limit is that Python sourcecode containing decimal integer literals longer than the limit willencounter an error during parsing, usually at startup time or import time oreven at installation time - anytime an up to date.pyc
does not alreadyexist for the code. A workaround for source that contains such largeconstants is to convert them to0x
hexadecimal form as it has no limit.
Test your application thoroughly if you use a low limit. Ensure your testsrun with the limit set early via the environment or flag so that it appliesduring startup and even during any installation step that may invoke Pythonto precompile.py
sources to.pyc
files.
建議的配置¶
The defaultsys.int_info.default_max_str_digits
is expected to bereasonable for most applications. If your application requires a differentlimit, set it from your main entry point using Python version agnostic code asthese APIs were added in security patch releases in versions before 3.12.
範例:
>>>importsys>>>ifhasattr(sys,"set_int_max_str_digits"):...upper_bound=68000...lower_bound=4004...current_limit=sys.get_int_max_str_digits()...ifcurrent_limit==0orcurrent_limit>upper_bound:...sys.set_int_max_str_digits(upper_bound)...elifcurrent_limit<lower_bound:...sys.set_int_max_str_digits(lower_bound)
If you need to disable it entirely, set it to0
.
註腳
[1]Additional information on these special methods may be found in the PythonReference Manual (Basic customization).
[2]As a consequence, the list[1,2]
is considered equal to[1.0,2.0]
, andsimilarly for tuples.
They must have since the parser can't tell the type of the operands.
[4](1,2,3,4)Cased characters are those with general category property being one of"Lu" (Letter, uppercase), "Ll" (Letter, lowercase), or "Lt" (Letter, titlecase).
[5](1,2)To format only a tuple you should therefore provide a singleton tuple whose onlyelement is the tuple to be formatted.