Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32.3k
gh-93096: Update and documentpickle
CLI#131097
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes from10 commits
Commits
Show all changes
17 commits Select commitHold shift + click to select a range
f572b59
Add CLI docs for `pickle`
donBarbos923af7b
Correct ref preview
donBarbos5909db4
Update Doc/library/pickle.rst
donBarbos291f6bf
Add suggestions
donBarbos215afa9
Fix typo
donBarbos3b8efae
Update doc
donBarbos40a3265
Fix pickle parser
donBarbosc93b70f
Add feature
donBarboscefd8a4
Update Doc/library/pickle.rst
donBarbos4bc3253
Move cli section
donBarbos29d1360
Update Doc/library/pickle.rst
donBarbos3dd66f2
Update Lib/pickle.py
donBarbosff22e97
back sort_dicts=True
donBarbosdbedc68
pprint.pp(obj)
hugovk756ff98
Merge branch 'main' into issue-93096-pickle-cli-docs
donBarbos593fd7b
Revert using pp
donBarbos8f1af6e
Update Lib/pickle.py
donBarbosFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
2 changes: 1 addition & 1 deletionDoc/library/cmdline.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
24 changes: 24 additions & 0 deletionsDoc/library/pickle.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1210,6 +1210,30 @@ The following example reads the resulting pickled data. :: | ||
.. pickletools.optimize() or the gzip module). | ||
.. _pickle-cli: | ||
Command-line interface | ||
---------------------- | ||
The :mod:`pickle` module can be invoked as a script from the command line, | ||
it will display contents of the pickle files. 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, see | ||
:ref:`pickletools CLI usage <pickletools-cli>`. | ||
.. code-block:: bash | ||
python -m pickle pickle_file [pickle_file ...] | ||
The following option is accepted: | ||
.. program:: pickle | ||
.. option:: pickle_file | ||
A pickle file to read or ``-`` to indicate reading from standard input. | ||
donBarbos marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
.. seealso:: | ||
Module :mod:`copyreg` | ||
21 changes: 9 additions & 12 deletionsLib/pickle.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1909,20 +1909,17 @@ def _loads(s, /, *, fix_imports=True, encoding="ASCII", errors="strict", | ||
if __name__ == "__main__": | ||
import argparse | ||
import pprint | ||
parser = argparse.ArgumentParser( | ||
description='display contents of the pickle files') | ||
parser.add_argument( | ||
'pickle_file', | ||
nargs='+', help='the pickle file') | ||
args = parser.parse_args() | ||
for fn in args.pickle_file: | ||
if fn == '-': | ||
obj = load(sys.stdin.buffer) | ||
else: | ||
with open(fn, 'rb') as f: | ||
obj = load(f) | ||
pprint.pprint(obj) | ||
hugovk marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. |
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.