Explorando o Módulo Collections do Python

Introdução

Neste tutorial, exploraremos o módulo collections embutido do Python. O módulo collections é uma biblioteca poderosa que oferece uma variedade de tipos de dados de contêiner que estendem a funcionalidade dos contêineres embutidos do Python, como listas, tuplas e dicionários.

NamedTuple

Um namedtuple é uma subclasse de uma tupla, fornecendo campos nomeados para maior legibilidade e código autodocumentado. Vamos criar um namedtuple em named_tuple.py para representar um ponto em um espaço 2D:

## Import collections
from collections import namedtuple

## Define a namedtuple type Point with x and y properties
Point = namedtuple('Point', ['x', 'y'])

## Create a Poinit object
p = Point(1, 2)

## Retrieve the properties of point
print(p.x)
print(p.y)

Em seguida, execute o script no terminal:

python named_tuple.py

Saída:

1
2

Counter

Counter é uma subclasse de dict que conta as ocorrências de elementos em uma coleção. Vamos criar um objeto Counter em counter.py para contar as ocorrências de caracteres em uma string:

from collections import Counter

text = "hello, world!"
## Gets the number of occurrences of the elements in the collection and returns them as a dictionary
char_count = Counter(text)

print(char_count)

Em seguida, execute o script no terminal:

python counter.py

Saída:

Counter({'l': 3, 'o': 2, 'h': 1, 'e': 1, ',': 1, ' ': 1, 'w': 1, 'r': 1, 'd': 1, '!': 1})

OrderedDict

OrderedDict é uma subclasse de dict que mantém a ordem dos elementos conforme foram inseridos. Vamos criar um OrderedDict em ordered_dict.py e adicionar alguns pares chave-valor:

from collections import OrderedDict

## Initialdefining OrderedDict
od = OrderedDict()

## Insert in key-value pairs
od['a'] = 1
od['b'] = 2
od['c'] = 3

## Iterate over the key-value pairs and print out the contents
for key, value in od.items():
    print(key, value)

Em seguida, execute o script no terminal:

python ordered_dict.py

Saída:

a 1
b 2
c 3

DefaultDict

Defaultdict(int)

DefaultDict é uma subclasse de dict que fornece um valor padrão para uma chave inexistente. Vamos criar um DefaultDict com valores padrão 0 em default_dict1.py e contar as ocorrências de palavras em uma frase:

from collections import defaultdict

sentence = "the quick brown fox jumps over the lazy dog"
word_count1 = defaultdict(int)

for word in sentence.split():
    ## Count the occurrences of words
    word_count1[word] += 1

print(dict(word_count1))

Em seguida, execute o script no terminal:

python default_dict1.py

Saída:

{'the': 2, 'quick': 1, 'brown': 1, 'fox': 1, 'jumps': 1, 'over': 1, 'lazy': 1, 'dog': 1}

Se não usássemos DefaultDict, o código de apelo seria assim:

sentence = "the quick brown fox jumps over the lazy dog"
result = {}

for word in sentence.split():
    if word in result:
        result[word] += 1
    else:
        result[word] = 1

print(result)

Defaultdict(list)

Em seguida, vamos criar um DefaultDict com valores padrão [] em default_dict2.py e armazenar o número em cada letra:

from collections import defaultdict

data = [('a', 1), ('a', 1), ('a', 3), ('b', 1), ('b', 2), ('b', 3)]
word_count2 = defaultdict(list)

for (key,value) in data:
    ## Store the number in each letter
    word_count2[key].append(value)

print(dict(word_count2))

Em seguida, execute o script no terminal:

python default_dict2.py

Saída:

{'a': [1, 1, 3], 'b': [1, 2, 3]}

Se não usássemos DefaultDict, o código de apelo seria assim:

data = [('a', 1), ('a', 1), ('a', 3), ('b', 1), ('b', 2), ('b', 3)]
result = {}

for (key, value) in data:
    if key in result:
        result[key].append(value)
    else:
        result[key] = [value]

print(result)

Defaultdict(set)

Finalmente, vamos criar um DefaultDict com valores padrão set() em default_dict3.py e armazenar o número que não se repete em cada letra:

from collections import defaultdict

data = [('a', 1), ('a', 1), ('a', 3), ('b', 1), ('b', 2), ('b', 3)]
word_count3 = defaultdict(set)

for (key,value) in data:
    ## Stores the number that is not repeated in each letter
    word_count3[key].add(value)

print(dict(word_count3))

Em seguida, execute o script no terminal:

python default_dict3.py

Saída:

{'a': {1, 3}, 'b': {1, 2, 3}}

Se não usássemos DefaultDict, o código de apelo seria assim:

data = [('a', 1), ('a', 1), ('a', 3), ('b', 1), ('b', 2), ('b', 3)]
result = {}

for (key, value) in data:
    if key in result:
        result[key].add(value)
    else:
        result[key] = {value}

print(result)

Deque

Uma deque (fila de duas extremidades) é uma generalização de pilhas e filas que suporta operações rápidas de anexação e remoção (pop) O(1) de ambas as extremidades. Vamos criar uma deque em deque.py e realizar algumas operações:

from collections import deque

d = deque([1, 2, 3, 4, 5])

## Append to the right
d.append(6)
print("Append to the right:", d)

## Append to the left
d.appendleft(0)
print("Append to the left:", d)

## Pop from the right
right_element = d.pop()
print("The right element:", right_element)
print("Pop from the right:", d)

## Pop from the left
left_element = d.popleft()
print("The left element:", left_element)
print("Pop from the left:", d)

## Rotate the deque
d.rotate(2)
print("Rotate clockwise the deque:", d)

d.rotate(-2)
print("Rotate counterclockwise the deque:", d)

Em seguida, execute o script no terminal:

python deque.py

Saída:

Append to the right: deque([1, 2, 3, 4, 5, 6])
Append to the left: deque([0, 1, 2, 3, 4, 5, 6])
The right element: 6
Pop from the right: deque([0, 1, 2, 3, 4, 5])
The left element: 0
Pop from the left: deque([1, 2, 3, 4, 5])
Rotate clockwise the deque: deque([4, 5, 1, 2, 3])
Rotate counterclockwise the deque: deque([1, 2, 3, 4, 5])

Resumo

Neste tutorial, abordamos as principais classes fornecidas pelo módulo collections, incluindo namedtuple, Counter, OrderedDict, DefaultDict e deque. Essas classes podem ser úteis para várias tarefas e são ótimas adições ao seu conjunto de ferramentas Python.