gh-134150: Clarify distinction between JSON and Python objects #134154
There are no files selected for viewing
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 |
|---|---|---|
| @@ -18,12 +18,17 @@ is a lightweight data interchange format inspired by | ||
| `JavaScript <https://en.wikipedia.org/wiki/JavaScript>`_ object literal syntax | ||
| (although it is not a strict subset of JavaScript [#rfc-errata]_ ). | ||
|
|
||
| .. note:: | ||
| The term "object" in the context of JSON processing in Python can be | ||
| ambiguous. All values in Python are objects. In JSON, an object refers to | ||
| any data wrapped in curly braces, similar to a Python dictionary. | ||
|
|
||
| .. warning:: | ||
| Be cautious when parsing JSON data from untrusted sources. A malicious | ||
| JSON string may cause the decoder to consume considerable CPU and memory | ||
| resources. Limiting the size of data to be parsed is recommended. | ||
|
|
||
| This module exposes an API familiar to users of the standard library | ||
|
There was a problem hiding this comment. Again unrelated, please revert and do not make a mess of this pr. though it should be changed to There was a problem hiding this comment.
@StanFromIreland Please be aware that this is a first-time contributor. Let's try to be more constructive by pointing to the devguide. There was a problem hiding this comment. I think "This module" make a better sentence anyway. |
||
| :mod:`marshal` and :mod:`pickle` modules. | ||
|
|
||
| Encoding basic Python object hierarchies:: | ||
| @@ -60,7 +65,7 @@ Pretty printing:: | ||
| "6": 7 | ||
| } | ||
|
|
||
| Customizing JSON object encoding:: | ||
|
There was a problem hiding this comment. Again, I think this is a better word, and we don't want to make a separate PR for it, it would be too much churn. |
||
|
|
||
| >>> import json | ||
| >>> def custom_json(obj): | ||
| @@ -83,7 +88,7 @@ Decoding JSON:: | ||
| >>> json.load(io) | ||
| ['streaming API'] | ||
|
|
||
| Customizing JSON object decoding:: | ||
|
|
||
|
|
||
| >>> import json | ||
| >>> def as_complex(dct): | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Glossary link to Python object?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this case, I don't think a glossary link will help here. The reader in this case will know what a Python object is.