### 導航 - [索引](../genindex.xhtml "總目錄") - [模塊](../py-modindex.xhtml "Python 模塊索引") | - [下一頁](misc.xhtml "雜項服務") | - [上一頁](dis.xhtml "dis --- Python 字節碼反匯編器") | -  - [Python](https://www.python.org/) ? - zh\_CN 3.7.3 [文檔](../index.xhtml) ? - [Python 標準庫](index.xhtml) ? - [Python 語言服務](language.xhtml) ? - $('.inline-search').show(0); | # [`pickletools`](#module-pickletools "pickletools: Contains extensive comments about the pickle protocols and pickle-machine opcodes, as well as some useful functions.") --- Tools for pickle developers **Source code:** [Lib/pickletools.py](https://github.com/python/cpython/tree/3.7/Lib/pickletools.py) \[https://github.com/python/cpython/tree/3.7/Lib/pickletools.py\] - - - - - - This module contains various constants relating to the intimate details of the [`pickle`](pickle.xhtml#module-pickle "pickle: Convert Python objects to streams of bytes and back.") module, some lengthy comments about the implementation, and a few useful functions for analyzing pickled data. The contents of this module are useful for Python core developers who are working on the [`pickle`](pickle.xhtml#module-pickle "pickle: Convert Python objects to streams of bytes and back."); ordinary users of the [`pickle`](pickle.xhtml#module-pickle "pickle: Convert Python objects to streams of bytes and back.") module probably won't find the [`pickletools`](#module-pickletools "pickletools: Contains extensive comments about the pickle protocols and pickle-machine opcodes, as well as some useful functions.") module relevant. ## Command line usage 3\.2 新版功能. When invoked from the command line, `python -m pickletools` will disassemble the contents of one or more pickle files. Note that if you want to see the Python object stored in the pickle rather than the details of pickle format, you may want to use `-m pickle` instead. However, when the pickle file that you want to examine comes from an untrusted source, `-m pickletools` is a safer option because it does not execute pickle bytecode. For example, with a tuple `(1, 2)` pickled in file `x.pickle`: ``` $ python -m pickle x.pickle (1, 2) $ python -m pickletools x.pickle 0: \x80 PROTO 3 2: K BININT1 1 4: K BININT1 2 6: \x86 TUPLE2 7: q BINPUT 0 9: . STOP highest protocol among opcodes = 2 ``` ### Command line options `-a````, ``--annotate```Annotate each line with a short opcode description. `-o````, ``--output``=<file>`Name of a file where the output should be written. `-l````, ``--indentlevel``=<num>`The number of blanks by which to indent a new MARK level. `-m````, ``--memo```When multiple objects are disassembled, preserve memo between disassemblies. `-p````, ``--preamble``=<preamble>`When more than one pickle file are specified, print given preamble before each disassembly. ## Programmatic Interface `pickletools.``dis`(*pickle*, *out=None*, *memo=None*, *indentlevel=4*, *annotate=0*)Outputs a symbolic disassembly of the pickle to the file-like object *out*, defaulting to `sys.stdout`. *pickle* can be a string or a file-like object. *memo* can be a Python dictionary that will be used as the pickle's memo; it can be used to perform disassemblies across multiple pickles created by the same pickler. Successive levels, indicated by `MARK` opcodes in the stream, are indented by *indentlevel* spaces. If a nonzero value is given to *annotate*, each opcode in the output is annotated with a short description. The value of *annotate* is used as a hint for the column where annotation should start. 3\.2 新版功能: The *annotate* argument. `pickletools.``genops`(*pickle*)Provides an [iterator](../glossary.xhtml#term-iterator) over all of the opcodes in a pickle, returning a sequence of `(opcode, arg, pos)` triples. *opcode* is an instance of an `OpcodeInfo` class; *arg* is the decoded value, as a Python object, of the opcode's argument; *pos* is the position at which this opcode is located. *pickle* can be a string or a file-like object. `pickletools.``optimize`(*picklestring*)Returns a new equivalent pickle string after eliminating unused `PUT`opcodes. The optimized pickle is shorter, takes less transmission time, requires less storage space, and unpickles more efficiently. ### 導航 - [索引](../genindex.xhtml "總目錄") - [模塊](../py-modindex.xhtml "Python 模塊索引") | - [下一頁](misc.xhtml "雜項服務") | - [上一頁](dis.xhtml "dis --- Python 字節碼反匯編器") | -  - [Python](https://www.python.org/) ? - zh\_CN 3.7.3 [文檔](../index.xhtml) ? - [Python 標準庫](index.xhtml) ? - [Python 語言服務](language.xhtml) ? - $('.inline-search').show(0); | ? [版權所有](../copyright.xhtml) 2001-2019, Python Software Foundation. Python 軟件基金會是一個非盈利組織。 [請捐助。](https://www.python.org/psf/donations/) 最后更新于 5月 21, 2019. [發現了問題](../bugs.xhtml)？ 使用[Sphinx](http://sphinx.pocoo.org/)1.8.4 創建。