mirror of https://github.com/python/cpython.git
gh-128519: Align the docstring of untokenize() to match the docs (#128521)
This commit is contained in:
parent
a62ba52f14
commit
aef52ca8b3
|
@ -318,16 +318,10 @@ def untokenize(iterable):
|
|||
with at least two elements, a token number and token value. If
|
||||
only two tokens are passed, the resulting output is poor.
|
||||
|
||||
Round-trip invariant for full input:
|
||||
Untokenized source will match input source exactly
|
||||
|
||||
Round-trip invariant for limited input:
|
||||
# Output bytes will tokenize back to the input
|
||||
t1 = [tok[:2] for tok in tokenize(f.readline)]
|
||||
newcode = untokenize(t1)
|
||||
readline = BytesIO(newcode).readline
|
||||
t2 = [tok[:2] for tok in tokenize(readline)]
|
||||
assert t1 == t2
|
||||
The result is guaranteed to tokenize back to match the input so
|
||||
that the conversion is lossless and round-trips are assured.
|
||||
The guarantee applies only to the token type and token string as
|
||||
the spacing between tokens (column positions) may change.
|
||||
"""
|
||||
ut = Untokenizer()
|
||||
out = ut.untokenize(iterable)
|
||||
|
|
Loading…
Reference in New Issue