Modul pickle je jedním z prostředků vyhrazených pro perzistentní ukládání pythoních dat. To znamená, že data jím uložená mohou být např. k dispozici mezi dvěma časově vzdálenými běhy programu (a to i jiného).

Umí zaserializovat (téměř libovolnou) pythonovskou strukturu pomocí příslušného pickle-protokolu a uložit ji jako binární objekt buď do proměnné nebo do souboru. A samozřejmě ji pak zase umí z proměnné/souboru načíst a rozserializovat zpátky do příslušné struktury.

Pickle-protokolu jsou dnes již čtyři verze:

• protokol 0 – původní human-readable textová verze; zpětně kompatibilní
• protokol 1 – původní binární serializace
• protokol 2 – od verze Python'u 2.3
• protokol 3 – od verze Python'u 3.0

Pokud výslovně neřeknete jinak, používá se jako výchozí hodnota příslušející vaší verzi Python'u, takže pro Python 3.x je to verze protokolu 3.

Modul pickle umí piklit a rozpiklovávat v zásadě do/z dvou různých míst – paměti nebo proudu (streamu):

• do/z paměti:
  • po = pickle.dumps(o) – zapiklí objekt o do proměnné po typu bytes()
  • o = pickle.loads(po) – rozpiklí bajt-objekt po do datové struktury o
Všimněte si koncového s u metod pro piklení přes paměť.
• do/z proudu:
  • pickle.dump(o, file) – zapiklí objekt o do binárního souboru file
  • o = pickle.load(file) – rozpiklí do objektu o zapiklenou strukturu v binárním souboru file

Zkusme zapiklit jednoduchý slovník, který obsahuje pouze data:

A teď si ho zase rozpikleme:

Vidíme, že na načtené datové struktuře jsou normálně k dispozici všechny její atributy.

Zaserializovat je možné následující typy:

• None, True, False
• celá, reálná a komplexní čísla
• řetězce (unicodové), bajtové řetězce a bajtová pole
• n-tice, seznamy, množiny a slovníky, pokud obsahují piklitelné typy
• funkce definované na globální úrovni modulu
• vestavěné funkce definované na globální úrovni modulu
• třídy definované na globální úrovni modulu
• instance tříd, jejichž atributy __dict__ a __setstate__() jsou piklitelné

Přitom:

• Pokus o zapiklení nepiklitelného objektu vyhodí výjimku PicklingError, blíže neurčený počet bajtů však mezitím už může být zapsán do otevřeného proudu. Podobně při pokusu o piklení velmi rekurzivních dat můžete narazit na hranice rekurze (výjimka RuntimeError).
• Piklení probíhá na úrovni plně kvalifikovaných jmen, nikoli příslušných zdrojových kódů. Tzn. že funkce a třídy (včetně uživatelem definovaných) jsou zapikleny pod svým jménem a jménem rodičovského modulu. Při odpiklení pak musí být příslušný modul a v něm příslušná funkce či třída k dispozici.
• Ze tříd jsou piklena pouze data instancí. To proto, aby byl zapiklený objekt použitelný i tehdy, pokud základní třídu nějak (rozumně) upravíme.

Když náš datový slovník doplníme o odkaz na funkci (tedy referenci), zapiklí se pouze tento odkaz..

..což znamená, že při odpiklovávání musí příslušná funkce existovat (i když bude dělat něco úplně jiného):

Druhou možností by bylo zapiklit funkci jako řetězec a při rozpiklování ji převést na funkční tvar pomocí eval(), ale...

Piklící formát není nijak zabezpečen proti nebezpečným datům =>

Nikdy neodpiklovávejte cizí data!

Odpiklená data jsou totiž převedena do bajtkódu a vzápětí vykonána (aby mohly být příslušné datové a programové struktury k dispozici), je tudíž velkým bezpečnostním rizikem bezhlavě odpiklovávat všechno, co se vám dostane pod ruku!

Musíte-li pracovat s (nejen cizími) zapiklenými daty, mohou se vám hodit následujícíc dvě věci:

• Úpravou Unpickler.find_class() můžete omezit, které globální funkce a třídy bude povoleno odpiklit.
• Nástroje v modulu pickletools (viz následující slajd) umožňují prozkoumat „vnitřnosti“ zapiklených dat bez nebezpečí spouštění vytvořeného bajtkódu.

Modul pickletools toho umí více (mimo jiné optimalizovat zapiklená data), ale na tomto místě se o něm zmiňujeme především proto, že umožňuje prozkoumat „assembler“ piklicího protokolu zkoumaného souboru, aniž by při tom jako pickle.load() (či loads()) získaný pythoní bajtkód rovnou i vykonal.

Programátor tak dostává do ruky nástroj, který mu umožňuje prozkoumat zapiklená data tak říkajíc „offline“, aniž by si jimi případně kompromitoval vlastní systém.

V programátorském rozhraní modulu jsou k dispozici následující metody:

• dis(pickle, out=None, memo=None, indentlevel=4, annotate=0) – vrací symbolickou disasemblaci (do operačních kódů piklicího protokolu) vstupního pickle-souboru;
• genops(pickle) – vrací iterátor přes jednotlivé operační kódy vstupního pickle-souboru;
• optimize(picklestring) – vrací optimalizovanou verzi vstupního pickle-řetězce. Zřejmě alespoň některá z verzí piklicího protokolu nezvládá přímo poskytnout optimalizovaný výstup a je možné odstranit přebytečné příkazy PUT.

Od verze Python'u 3.2 umožňuje modul pickletools i své přímé volání z příkazové řádky:

Dostupné přepínače jsou:

• -a, --annotate
  doplní každý operační kód popisem jeho funkce
• -o, --output=<file>
  jméno souboru pro zápis výstupu příkazu Zdá se, že modul má zatím při použití tohoto přepínače problémy s výstupem pro ne-ASCII kódovaná data a struktury.
• -l, --indentlevel=<num>
  počet mezer použitých při odsazování úrovní výstupu
• -m, --memo
  pro vícero překládaných objektů se pokusí udržet stejnou interní mapovací tabulku Tohle je asi zrovna užitečnější spíš z programového API než tady.
• -p, --preamble=<preamble>
  při výpisu výstupů pro vícero vstupních souborů doplní před každý jednotlivý výpis uvedený text (ve výchozím nastavení jméno zpracovávaného souboru)

Pro zajímavost zkusme ještě zapiklit slovník z předchozích slajdů, ale tentokrát v nejstarším ASCII-protokolu 0: