Crie structs similares de C em python de forma intutiva!
Instalação via PyPI:
pip3 install structer
Instalação via GitHub:
pip3 install git+https://github.com/d3cryptofc/structer.git
Te garanto que é mais fácil do que parece.
Crie seu modelo de struct usando structer.structfy(name, fields):
from structer import structfy, Char, Str, Field
Person = structfy('Person', [
Field('name', Str(15)),
Field('gender', Char())
])Notas:
structer.Stré um apelido curto parastructer.String.structer.Charé comostructer.String(1), porém especializado para isso.
Você pode criar uma instância passando os valores como argumento:
>>> p = Person(name='John', gender='M')
>>> p
Person(name(15)='John', gender(1)='M') -> 16Ou, talvez queira fazer as modificações de forma individual com a instância já criada:
>>> p = Person()
>>> p
Person(name(15)='', gender(1)='') -> 16
>>> p.name = 'John'
>>> p.gender = 'M'
>>> p
Person(name(15)='John', gender(1)='M') -> 16Você deve ter notado que a representação do objeto mostra o tamanho de cada campo e o tamanho total de todos os campos.
Para saber o tamanho total de sua instância, use a função len:
>>> len(p)
16Talvez queira saber o tamanho total do modelo de struct sem precisar criar uma instância, acesse o atributo __struct_size__ (tamanho dado em bytes):
>>> Person.__struct_size__
16Basta acessar o atributo __struct_binary__:
>>> p.__struct_binary__
b'John\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00M'Pronto! Agora você faz o que bem quiser com isso.
Se você nunca programou em C, pode inicialmente pensar que uma struct é similar a um dataclass, mas diferente de um dataclass, structs mapeiam os campos na memória, de forma que você tenha todos os dados colados um no outro porém delimitados por seus tamanhos.
Você pode imaginar que internamente o mapeamento é feito como:
# Your field sizes.
f_first_name = 10
f_gender = 1
f_age = 2
# Memory containing the data.
memory = 'John M23'
# Accessing data delimited by its field sizes.
memory[0:f_first_name] # 'John '
memory[f_first_name:f_first_name + f_gender] # 'M'
memory[f_first_name + f_gender:f_first_name + f_gender + f_age] # '23'Porém uma struct abstrai isso, de forma que o uso seja estupidamente simples:
person.first_name = 'John'
person.gender = 'M'
person.age = 23É importante dizer que o primeiro exemplo é bem grosseiro, structs utilizam bytes ao invés de string, permitindo que você economize um espaço absurdo.
Por exemplo, em idade do exemplo acima foi inserido '23' como string, o que consome 2 bytes na memória, porém poderiamos representar números de 0 a 255 (00 a FF) usando um único byte.
Ou melhor, imagine que você queira armazenar o número 18,000,000,000,000,000,000 (18 quintilhões) na memória, no entanto armazenar num arquivo de texto como uma string iria consumir 20 bytes, sendo que bastaria 8 bytes para representar o número.
O desperdício desses 12 bytes daria pra representar o próprio número duas vezes, tanto que isso em larga escala jogaria um enorme espaço de armazenamento no lixo, cerca de 60% de espaço poderia ser economizado, isso seria ir de 1TB para somente 400G.
Structs são como modelos para mapear o espaço na memória e organizar os dados, e, diferente de C (por ser compilado), em python cada instância que for criada vai consumir espaço na memória RAM, assim como qualquer outra instância de classe do Python.
O ponto não é usar structs pensando que será uma alternativa mais leve que dataclass tanto quanto uma struct de verdade (eu não faço milagres), o ponto está justamente no mapeamento de memória feita pela struct, ela organizará todos os dados em binário, e da forma como você definiu que ela organizasse, para que você possa acessar quando bem quiser, seja para:
- Economia de espaço em arquivo.
- Economia de banda na transmissão de dados.
- Desserializar dados oriundos de structs de verdade de um protocolo de rede.
- Criação de layouts binários em geral, até mesmo de um arquivo PNG.
Ou para qualquer outro caso onde também seja útil.