技術文章 » Python資料結構：一個被低估的Namedtuple(一)

Python資料結構：一個被低估的Namedtuple(一)

2020-10-19 21:00:46
欄目為大家介紹Python資料結構中的Namedtuple。

本文將討論python中namedtuple的重點用法。我們將由淺入深的介紹namedtuple的各概念。您將瞭解為什麼要使用它們，以及如何使用它們，從而是程式碼更簡潔。在學習本指南之後，你一定會喜歡上使用它。

學習目標

在本教學結束時，您應該能夠：

  • 瞭解為什麼以及何時使用它
  • 將常規元組和字典轉換為Namedtuple
  • 將Namedtuple轉化為字典或常規元組
  • 對Namedtuple列表進行排序
  • 瞭解Namedtuple和資料類(DataClass)之間的區別
  • 使用可選欄位建立Namedtuple
  • 將Namedtuple序列化為JSON
  • 新增檔案字串(docstring)

為什麼要使用namedtuple？

namedtuple是一個非常有趣（也被低估了）的資料結構。我們可以輕鬆找到嚴重依賴常規元組和字典來儲存資料的Python程式碼。我並不是說，這樣不好，只是有時候他們常常被濫用，且聽我慢慢道來。

假設你有一個將字串轉換為顏色的函數。顏色必須在4維空間RGBA中表示。

def convert_string_to_color(desc: str, alpha: float = 0.0):
    if desc == "green":        return 50, 205, 50, alpha    elif desc == "blue":        return 0, 0, 255, alpha    else:        return 0, 0, 0, alpha複製程式碼

然後，我們可以像這樣使用它：

r, g, b, a = convert_string_to_color(desc="blue", alpha=1.0)複製程式碼

好的，可以。但是我們這裡有幾個問題。第一個是，無法確保返回值的順序。也就是說，沒有什麼可以阻止其他開發者這樣呼叫

convert_string_to_color：
g, b, r, a = convert_string_to_color(desc="blue", alpha=1.0)複製程式碼

另外，我們可能不知道該函數返回4個值，可能會這樣呼叫該函數：

r, g, b = convert_string_to_color(desc="blue", alpha=1.0)複製程式碼

於是，因為返回值不夠，丟擲ValueError錯誤，呼叫失敗。

確實如此。但是，你可能會問，為什麼不使用字典呢？

Python的字典是一種非常通用的資料結構。它們是一種儲存多個值的簡便方法。但是，字典並非沒有缺點。由於其靈活性，字典很容易被濫用。讓 我們看看使用字典之後的例子。

def convert_string_to_color(desc: str, alpha: float = 0.0):
    if desc == "green":        return {"r": 50, "g": 205, "b": 50, "alpha": alpha}    elif desc == "blue":        return {"r": 0, "g": 0, "b": 255, "alpha": alpha}    else:        return {"r": 0, "g": 0, "b": 0, "alpha": alpha}複製程式碼

好的，我們現在可以像這樣使用它，期望只返回一個值：

color = convert_string_to_color(desc="blue", alpha=1.0)複製程式碼

無需記住順序，但它至少有兩個缺點。第一個是我們必須跟蹤金鑰的名稱。如果我們將其更改{"r": 0, 「g」: 0, 「b」: 0, 「alpha」: alpha}為{」red": 0, 「green」: 0, 「blue」: 0, 「a」: alpha}，則在存取欄位時會得到KeyError返回，因為鍵r，g，b和alpha不再存在。

字典的第二個問題是它們不可雜湊。這意味著我們無法將它們儲存在set或其他字典中。假設我們要跟蹤特定影象有多少種顏色。如果我們使用collections.Counter計數，我們將得到TypeError: unhashable type: ‘dict’。

而且，字典是可變的，因此我們可以根據需要新增任意數量的新鍵。相信我，這是一些很難發現的令人討厭的錯誤點。

好的，很好。那麼現在怎麼辦？我可以用什麼代替呢？

namedtuple！對，就是它！

將我們的函數轉換為使用namedtuple：

from collections import namedtuple
...
Color = namedtuple("Color", "r g b alpha")
...def convert_string_to_color(desc: str, alpha: float = 0.0):
    if desc == "green":        return Color(r=50, g=205, b=50, alpha=alpha)    elif desc == "blue":        return Color(r=50, g=0, b=255, alpha=alpha)    else:        return Color(r=50, g=0, b=0, alpha=alpha)複製程式碼

與dict的情況一樣，我們可以將值分配給單個變數並根據需要使用。無需記住順序。而且，如果你使用的是諸如PyCharm和VSCode之類的IDE ，還可以自動提示補全。

color = convert_string_to_color(desc="blue", alpha=1.0)
...
has_alpha = color.alpha > 0.0...
is_black = color.r == 0 and color.g == 0 and color.b == 0複製程式碼

最重要的是namedtuple是不可變的。如果團隊中的另一位開發人員認為在執行時新增新欄位是個好主意，則該程式將報錯。

>>> blue = Color(r=0, g=0, b=255, alpha=1.0)>>> blue.e = 0---------------------------------------------------------------------------
AttributeError                            Traceback (most recent call last)
<ipython-input-13-8c7f9b29c633> in <module>
----> 1 blue.e = 0AttributeError: 'Color' object has no attribute 'e'複製程式碼

不僅如此，現在我們可以使用它Counter來跟蹤一個集合有多少種顏色。

>>> Counter([blue, blue])>>> Counter({Color(r=0, g=0, b=255, alpha=1.0): 2})複製程式碼

如何將常規元組或字典轉換為 namedtuple

現在我們瞭解了為什麼使用namedtuple，現在該學習如何將常規元組和字典轉換為namedtuple了。假設由於某種原因，你有包含彩色RGBA值的字典範例。如果要將其轉換為Color namedtuple，則可以按以下步驟進行：

>>> c = {"r": 50, "g": 205, "b": 50, "alpha": alpha}>>> Color(**c)>>> Color(r=50, g=205, b=50, alpha=0)複製程式碼

我們可以利用該**結構將包解壓縮dict為namedtuple。

如果我想從dict建立一個namedtupe，如何做？

沒問題，下面這樣做就可以了：

>>> c = {"r": 50, "g": 205, "b": 50, "alpha": alpha}>>> Color = namedtuple("Color", c)>>> Color(**c)
Color(r=50, g=205, b=50, alpha=0)複製程式碼

通過將dict範例傳遞給namedtuple工廠函數，它將為你建立欄位。然後，Color像上邊的例子一樣解壓字典c，建立新範例。

如何將 namedtuple 轉換為字典或常規元組

我們剛剛學習瞭如何將轉換namedtuple為dict。反過來呢？我們又如何將其轉換為字典範例？

實驗證明，namedtuple它帶有一種稱為的方法._asdict()。因此，轉換它就像呼叫方法一樣簡單。

>>> blue = Color(r=0, g=0, b=255, alpha=1.0)>>> blue._asdict()
{'r': 0, 'g': 0, 'b': 255, 'alpha': 1.0}複製程式碼

您可能想知道為什麼該方法以_開頭。這是與Python的常規規範不一致的一個地方。通常，_代表私有方法或屬性。但是，namedtuple為了避免命名衝突將它們新增到了公共方法中。除了_asdict，還有_replace，_fields和_field_defaults。您可以在這裡找到所有這些。

要將namedtupe轉換為常規元組，只需將其傳遞給tuple建構函式即可。

>>> tuple(Color(r=50, g=205, b=50, alpha=0.1))
(50, 205, 50, 0.1)複製程式碼

如何對namedtuples列表進行排序

另一個常見的用例是將多個namedtuple範例儲存在列表中，並根據某些條件對它們進行排序。例如，假設我們有一個顏色列表，我們需要按alpha強度對其進行排序。

幸運的是，Python允許使用非常Python化的方式來執行此操作。我們可以使用operator.attrgetter運運算元。根據檔案，attrgetter「返回從其運算元獲取attr的可呼叫物件」。簡單來說就是，我們可以通過該運運算元，來獲取傳遞給sorted函數排序的欄位。例：

from operator import attrgetter
...
colors = [
    Color(r=50, g=205, b=50, alpha=0.1),
    Color(r=50, g=205, b=50, alpha=0.5),
    Color(r=50, g=0, b=0, alpha=0.3)
]
...>>> sorted(colors, key=attrgetter("alpha"))
[Color(r=50, g=205, b=50, alpha=0.1),
 Color(r=50, g=0, b=0, alpha=0.3),
 Color(r=50, g=205, b=50, alpha=0.5)]複製程式碼

現在，顏色列表按alpha強度升序排列！

如何將namedtuples序列化為JSON

有時你可能需要將儲存namedtuple轉為JSON。Python的字典可以通過json模組轉換為JSON。那麼我們可以使用_asdict方法將元組轉換為字典，然後接下來就和字典一樣了。例如：

>>> blue = Color(r=0, g=0, b=255, alpha=1.0)>>> import json>>> json.dumps(blue._asdict())'{"r": 0, "g": 0, "b": 255, "alpha": 1.0}'複製程式碼

如何給namedtuple新增docstring

在Python中，我們可以使用純字串來記錄方法，類和模組。然後，此字串可作為名為的特殊屬性使用__doc__。話雖這麼說，我們如何向我們的Color namedtuple新增docstring的？

我們可以通過兩種方式做到這一點。第一個（比較麻煩）是使用包裝器擴充套件元組。這樣，我們便可以docstring在此包裝器中定義。例如，請考慮以下程式碼片段：

_Color = namedtuple("Color", "r g b alpha")

class Color(_Color):
    """A namedtuple that represents a color.
    It has 4 fields:
    r - red
    g - green
    b - blue
    alpha - the alpha channel
    """

>>> print(Color.__doc__)
A namedtuple that represents a color.
    It has 4 fields:
    r - red
    g - green
    b - blue
    alpha - the alpha channel
>>> help(Color)
Help on class Color in module __main__:

class Color(Color)
 |  Color(r, g, b, alpha)
 |  
 |  A namedtuple that represents a color.
 |  It has 4 fields:
 |  r - red
 |  g - green
 |  b - blue
 |  alpha - the alpha channel
 |  
 |  Method resolution order:
 |      Color
 |      Color
 |      builtins.tuple
 |      builtins.object
 |  
 |  Data descriptors defined here:
 |  
 |  __dict__
 |      dictionary for instance variables (if defined)複製程式碼

如上，通過繼承_Color元組，我們為namedtupe新增了一個__doc__屬性。

新增的第二種方法，直接設定__doc__屬性。這種方法不需要擴充套件元組。

>>> Color.__doc__ = """A namedtuple that represents a color.
    It has 4 fields:
    r - red
    g - green
    b - blue
    alpha - the alpha channel
    """複製程式碼

注意，這些方法僅適用於Python 3+。

限於篇幅，先到這下篇繼續。

相關免費學習推薦：（視訊）

以上就是Python資料結構：一個被低估的Namedtuple(一)的詳細內容，更多請關注TW511.COM其它相關文章！