1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
|
# Copyright 2015 Google Inc. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import enum
import math
import re
from typing import (
Any,
Callable,
IO,
Iterable,
Mapping,
Optional,
Set,
Tuple,
Union,
)
import unicodedata
from json5.parser import Parser
# Used when encoding keys, below.
_reserved_word_re: Optional[re.Pattern] = None
class QuoteStyle(enum.Enum):
"""Controls how strings will be quoted during encoding.
By default, for compatibility with the `json` module and older versions of
`json5`, strings (not being used as keys and that are legal identifiers)
will always be double-quoted, and any double quotes in the string will be
escaped. This is `QuoteStyle.ALWAYS_DOUBLE`. If you pass
`QuoteStyle.ALWAYS_SINGLE`, then strings will always be single-quoted, and
any single quotes in the string will be escaped. If you pass
`QuoteStyle.PREFER_DOUBLE`, then the behavior is the same as ALWAYS_DOUBLE
and strings will be double-quoted *unless* the string contains more double
quotes than single quotes, in which case the string will be single-quoted
and single quotes will be escaped. If you pass `QuoteStyle.PREFER_SINGLE`,
then the behavior is the same as ALWAYS_SINGLE and strings will be
single-quoted *unless* the string contains more single quotes than double
quotes, in which case the string will be double-quoted and any double
quotes will be escaped.
*Note:* PREFER_DOUBLE and PREFER_SINGLE can impact performance, since in
order to know which encoding to use you have to iterate over the entire
string to count the number of single and double quotes. The codes guesses
at an encoding while doing so, but if it guess wrong, the entire string has
to be re-encoded, which will slow things down. If you are very concerned
about performance (a) you probably shouldn't be using this library in the
first place, because it just isn't very fast, and (b) you should use
ALWAYS_DOUBLE or ALWAYS_SINGLE, which won't have this issue.
"""
ALWAYS_DOUBLE = 'always_double'
ALWAYS_SINGLE = 'always_single'
PREFER_DOUBLE = 'prefer_double'
PREFER_SINGLE = 'prefer_single'
def load(
fp: IO,
*,
encoding: Optional[str] = None,
cls: Any = None,
object_hook: Optional[Callable[[Mapping[str, Any]], Any]] = None,
parse_float: Optional[Callable[[str], Any]] = None,
parse_int: Optional[Callable[[str], Any]] = None,
parse_constant: Optional[Callable[[str], Any]] = None,
strict: bool = True,
object_pairs_hook: Optional[
Callable[[Iterable[Tuple[str, Any]]], Any]
] = None,
allow_duplicate_keys: bool = True,
) -> Any:
"""Deserialize ``fp`` (a ``.read()``-supporting file-like object
containing a JSON document) to a Python object.
Supports almost the same arguments as ``json.load()`` except that:
- the `cls` keyword is ignored.
- an extra `allow_duplicate_keys` parameter supports checking for
duplicate keys in a object; by default, this is True for
compatibility with ``json.load()``, but if set to False and
the object contains duplicate keys, a ValueError will be raised.
"""
s = fp.read()
return loads(
s,
encoding=encoding,
cls=cls,
object_hook=object_hook,
parse_float=parse_float,
parse_int=parse_int,
parse_constant=parse_constant,
strict=strict,
object_pairs_hook=object_pairs_hook,
allow_duplicate_keys=allow_duplicate_keys,
)
def loads(
s: str,
*,
encoding: Optional[str] = None,
cls: Any = None,
object_hook: Optional[Callable[[Mapping[str, Any]], Any]] = None,
parse_float: Optional[Callable[[str], Any]] = None,
parse_int: Optional[Callable[[str], Any]] = None,
parse_constant: Optional[Callable[[str], Any]] = None,
strict: bool = True,
object_pairs_hook: Optional[
Callable[[Iterable[Tuple[str, Any]]], Any]
] = None,
allow_duplicate_keys: bool = True,
):
"""Deserialize ``s`` (a string containing a JSON5 document) to a Python
object.
Supports the same arguments as ``json.load()`` except that:
- the `cls` keyword is ignored.
- an extra `allow_duplicate_keys` parameter supports checking for
duplicate keys in a object; by default, this is True for
compatibility with ``json.load()``, but if set to False and
the object contains duplicate keys, a ValueError will be raised.
"""
assert cls is None, 'Custom decoders are not supported'
if isinstance(s, bytes):
encoding = encoding or 'utf-8'
s = s.decode(encoding)
if not s:
raise ValueError('Empty strings are not legal JSON5')
parser = Parser(s, '<string>')
ast, err, _ = parser.parse(global_vars={'_strict': strict})
if err:
raise ValueError(err)
def _fp_constant_parser(s):
return float(s.replace('Infinity', 'inf').replace('NaN', 'nan'))
if object_pairs_hook:
dictify = object_pairs_hook
elif object_hook:
def dictify(pairs):
return object_hook(dict(pairs))
else:
dictify = dict
if not allow_duplicate_keys:
_orig_dictify = dictify
def dictify(pairs): # pylint: disable=function-redefined
return _reject_duplicate_keys(pairs, _orig_dictify)
parse_float = parse_float or float
parse_int = parse_int or int
parse_constant = parse_constant or _fp_constant_parser
return _walk_ast(ast, dictify, parse_float, parse_int, parse_constant)
def _reject_duplicate_keys(pairs, dictify):
keys = set()
for key, _ in pairs:
if key in keys:
raise ValueError(f'Duplicate key "{key}" found in object')
keys.add(key)
return dictify(pairs)
def _walk_ast(
el,
dictify: Callable[[Iterable[Tuple[str, Any]]], Any],
parse_float,
parse_int,
parse_constant,
):
if el == 'None':
return None
if el == 'True':
return True
if el == 'False':
return False
ty, v = el
if ty == 'number':
if v.startswith('0x') or v.startswith('0X'):
return parse_int(v, base=16)
if '.' in v or 'e' in v or 'E' in v:
return parse_float(v)
if 'Infinity' in v or 'NaN' in v:
return parse_constant(v)
return parse_int(v)
if ty == 'string':
return v
if ty == 'object':
pairs = []
for key, val_expr in v:
val = _walk_ast(
val_expr, dictify, parse_float, parse_int, parse_constant
)
pairs.append((key, val))
return dictify(pairs)
if ty == 'array':
return [
_walk_ast(el, dictify, parse_float, parse_int, parse_constant)
for el in v
]
raise ValueError('unknown el: ' + el) # pragma: no cover
def dump(
obj: Any,
fp: IO,
*,
skipkeys: bool = False,
ensure_ascii: bool = True,
check_circular: bool = True,
allow_nan: bool = True,
cls: Optional['JSON5Encoder'] = None,
indent: Optional[Union[int, str]] = None,
separators: Optional[Tuple[str, str]] = None,
default: Optional[Callable[[Any], Any]] = None,
sort_keys: bool = False,
quote_keys: bool = False,
trailing_commas: bool = True,
allow_duplicate_keys: bool = True,
quote_style: QuoteStyle = QuoteStyle.ALWAYS_DOUBLE,
**kw,
):
"""Serialize ``obj`` to a JSON5-formatted stream to ``fp``,
a ``.write()``-supporting file-like object.
Supports the same arguments as ``dumps()``, below.
Calling ``dump(obj, fp, quote_keys=True, trailing_commas=False, \
allow_duplicate_keys=True)``
should produce exactly the same output as ``json.dump(obj, fp).``
"""
fp.write(
dumps(
obj=obj,
skipkeys=skipkeys,
ensure_ascii=ensure_ascii,
check_circular=check_circular,
allow_nan=allow_nan,
cls=cls,
indent=indent,
separators=separators,
default=default,
sort_keys=sort_keys,
quote_keys=quote_keys,
trailing_commas=trailing_commas,
allow_duplicate_keys=allow_duplicate_keys,
quote_style=quote_style,
**kw,
)
)
def dumps(
obj: Any,
*,
skipkeys: bool = False,
ensure_ascii: bool = True,
check_circular: bool = True,
allow_nan: bool = True,
cls: Optional['JSON5Encoder'] = None,
indent: Optional[Union[int, str]] = None,
separators: Optional[Tuple[str, str]] = None,
default: Optional[Callable[[Any], Any]] = None,
sort_keys: bool = False,
quote_keys: bool = False,
trailing_commas: bool = True,
allow_duplicate_keys: bool = True,
quote_style: QuoteStyle = QuoteStyle.ALWAYS_DOUBLE,
**kw,
):
"""Serialize ``obj`` to a JSON5-formatted string.
Supports the same arguments as ``json.dumps()``, except that:
- The ``encoding`` keyword is ignored; Unicode strings are always written.
- By default, object keys that are legal identifiers are not quoted; if you
pass ``quote_keys=True``, they will be.
- By default, if lists and objects span multiple lines of output (i.e.,
when ``indent`` >=0), the last item will have a trailing comma after it.
If you pass ``trailing_commas=False``, it will not.
- If you use a number, a boolean, or ``None`` as a key value in a dict, it
will be converted to the corresponding JSON string value, e.g. "1",
"true", or "null". By default, ``dump()`` will match the `json` modules
behavior and produce malformed JSON if you mix keys of different types
that have the same converted value; e.g., ``{1: "foo", "1": "bar"}``
produces '{"1": "foo", "1": "bar"}', an object with duplicated keys. If
you pass ``allow_duplicate_keys=False``, an exception will be raised
instead.
- If `quote_keys` is true, then keys of objects will be enclosed in quotes,
as in regular JSON. Otheriwse, keys will not be enclosed in quotes unless
they contain whitespace.
- If `trailing_commas` is false, then commas will not be inserted after the
final elements of objects and arrays, as in regular JSON. Otherwise,
such commas will be inserted.
- If `allow_duplicate_keys` is false, then only the last entry with a given
key will be written. Otherwise, all entries with the same key will be
written.
- `quote_style` controls how strings are encoded. See the documentation
for the `QuoteStyle` class, above, for how this is used.
*Note*: Strings that are being used as unquoted keys are not affected
by this parameter and remain unquoted.
*`quote_style` was added in version 0.10.0*.
Other keyword arguments are allowed and will be passed to the
encoder so custom encoders can get them, but otherwise they will
be ignored in an attempt to provide some amount of forward-compatibility.
*Note:* the standard JSON module explicitly calls `int.__repr(obj)__`
and `float.__repr(obj)__` to encode ints and floats, thereby bypassing
any custom representations you might have for objects that are subclasses
of ints and floats, and, for compatibility, JSON5 does the same thing.
To override this behavior, create a subclass of JSON5Encoder
that overrides `encode()` and handles your custom representation.
For example:
```
>>> import json5
... from typing import Any, Set
...
... class Hex(int):
... def __repr__(self):
... return hex(self)
...
... class CustomEncoder(json5.JSON5Encoder):
... def encode(
... self, obj: Any, seen: Set, level: int, *, as_key: bool
... ) -> str:
... if isinstance(obj, Hex):
... return repr(obj)
... return super().encode(obj, seen, level, as_key=as_key)
...
... print(json5.dumps([20, Hex(20)], cls=CustomEncoder))
...
[20, 0x14]
>>>
```
*Note:* calling ``dumps(obj, quote_keys=True, trailing_commas=False, \
allow_duplicate_keys=True)``
should produce exactly the same output as ``json.dumps(obj).``
"""
# TODO: Without these pragmas, mypy will complain with:
# error: Incompatible types in assignment (expression has type
# "JSON5Encoder | type[JSON5Encoder]", variable has type
# "JSON5Encoder | None") [assignment]
# error: "JSON5Encoder" not callable [operator]
# error: "None" not callable [misc]
# As best I can tell, I think these are bugs in mypy's type inference.
# I should either file bugs against mypy or find some way to not need
# these pragmas and the assert.
cls = cls or JSON5Encoder # type: ignore[assignment]
assert cls is not None
enc = cls(
skipkeys=skipkeys,
ensure_ascii=ensure_ascii,
check_circular=check_circular,
allow_nan=allow_nan,
indent=indent,
separators=separators,
default=default,
sort_keys=sort_keys,
quote_keys=quote_keys,
trailing_commas=trailing_commas,
allow_duplicate_keys=allow_duplicate_keys,
quote_style=quote_style,
**kw,
) # type: ignore[operator]
return enc.encode(obj, seen=set(), level=0, as_key=False)
class JSON5Encoder:
def __init__(
self,
*,
skipkeys: bool = False,
ensure_ascii: bool = True,
check_circular: bool = True,
allow_nan: bool = True,
indent: Optional[Union[int, str]] = None,
separators: Optional[Tuple[str, str]] = None,
default: Optional[Callable[[Any], Any]] = None,
sort_keys: bool = False,
quote_keys: bool = False,
trailing_commas: bool = True,
allow_duplicate_keys: bool = True,
quote_style: QuoteStyle = QuoteStyle.ALWAYS_DOUBLE,
**kw,
):
"""Provides a class that may be overridden to customize the behavior
of `dumps()`. The keyword args are the same as for that function.
*Added in version 0.10.0"""
# Ignore unrecognized keyword arguments in the hope of providing
# some level of backwards- and forwards-compatibility.
del kw
self.skipkeys = skipkeys
self.ensure_ascii = ensure_ascii
self.check_circular = check_circular
self.allow_nan = allow_nan
self.indent = indent
self.separators = separators
if separators is None:
separators = (', ', ': ') if indent is None else (',', ': ')
self.item_separator, self.kv_separator = separators
self.default_fn = default or _raise_type_error
self.sort_keys = sort_keys
self.quote_keys = quote_keys
self.trailing_commas = trailing_commas
self.allow_duplicate_keys = allow_duplicate_keys
self.quote_style = quote_style
def default(self, obj: Any) -> Any:
"""Provides a last-ditch option to encode a value that the encoder
doesn't otherwise recognize, by converting `obj` to a value that
*can* (and will) be serialized by the other methods in the class.
Note: this must not return a serialized value (i.e., string)
directly, as that'll result in a doubly-encoded value."""
return self.default_fn(obj)
def encode(
self,
obj: Any,
seen: Set,
level: int,
*,
as_key: bool,
) -> str:
"""Returns an JSON5-encoded version of an arbitrary object. This can
be used to provide customized serialization of objects. Overridden
methods of this class should handle their custom objects and then
fall back to super.encode() if they've been passed a normal object.
`seen` is used for duplicate object tracking when `check_circular`
is True.
`level` represents the current indentation level, which increases
by one for each recursive invocation of encode (i.e., whenever
we're encoding the values of a dict or a list).
May raise `TypeError` if the object is the wrong type to be
encoded (i.e., your custom routine can't handle it either), and
`ValueError` if there's something wrong with the value, e.g.
a float value of NaN when `allow_nan` is false.
If `as_key` is true, the return value should be a double-quoted string
representation of the object, unless obj is a string that can be an
identifier (and quote_keys is false and obj isn't a reserved word).
If the object should not be used as a key, `TypeError` should be
raised; that allows the base implementation to implement `skipkeys`
properly.
"""
seen = seen or set()
s = self._encode_basic_type(obj, as_key=as_key)
if s is not None:
return s
if as_key:
raise TypeError(f'Invalid key f{obj}')
return self._encode_non_basic_type(obj, seen, level)
def _encode_basic_type(self, obj: Any, *, as_key: bool) -> Optional[str]:
"""Returns None if the object is not a basic type."""
if isinstance(obj, str):
return self._encode_str(obj, as_key=as_key)
# Check for True/False before ints because True and False are
# also considered ints and so would be represented as 1 and 0
# if we did ints first.
if obj is True:
return '"true"' if as_key else 'true'
if obj is False:
return '"false"' if as_key else 'false'
if obj is None:
return '"null"' if as_key else 'null'
if isinstance(obj, int):
return self._encode_int(obj, as_key=as_key)
if isinstance(obj, float):
return self._encode_float(obj, as_key=as_key)
return None
def _encode_int(self, obj: int, *, as_key: bool) -> str:
s = int.__repr__(obj)
return f'"{s}"' if as_key else s
def _encode_float(self, obj: float, *, as_key: bool) -> str:
if obj == float('inf'):
allowed = self.allow_nan
s = 'Infinity'
elif obj == float('-inf'):
allowed = self.allow_nan
s = '-Infinity'
elif math.isnan(obj):
allowed = self.allow_nan
s = 'NaN'
else:
allowed = True
s = float.__repr__(obj)
if not allowed:
raise ValueError('Illegal JSON5 value: f{obj}')
return f'"{s}"' if as_key else s
def _encode_str(self, obj: str, *, as_key: bool) -> str:
if (
as_key
and self.is_identifier(obj)
and not self.quote_keys
and not self.is_reserved_word(obj)
):
return obj
return self._encode_quoted_str(obj, self.quote_style)
def _encode_quoted_str(self, obj: str, quote_style: QuoteStyle) -> str:
"""Returns a quoted string with a minimal number of escaped quotes."""
ret = []
double_quotes_seen = 0
single_quotes_seen = 0
sq = "'"
dq = '"'
for ch in obj:
if ch == dq:
# At first we will guess at which quotes to escape. If
# we guess wrong, we reencode the string below.
double_quotes_seen += 1
if quote_style in (
QuoteStyle.ALWAYS_DOUBLE,
QuoteStyle.PREFER_DOUBLE,
):
encoded_ch = self._escape_ch(dq)
else:
encoded_ch = dq
elif ch == sq:
single_quotes_seen += 1
if quote_style in (
QuoteStyle.ALWAYS_SINGLE,
QuoteStyle.PREFER_SINGLE,
):
encoded_ch = self._escape_ch(sq)
else:
encoded_ch = sq
elif ch == '\\':
encoded_ch = self._escape_ch(ch)
else:
o = ord(ch)
if o < 32:
encoded_ch = self._escape_ch(ch)
elif o < 128:
encoded_ch = ch
elif not self.ensure_ascii and ch not in ('\u2028', '\u2029'):
encoded_ch = ch
else:
encoded_ch = self._escape_ch(ch)
ret.append(encoded_ch)
# We may have guessed wrong and need to reencode the string.
if (
double_quotes_seen > single_quotes_seen
and quote_style == QuoteStyle.PREFER_DOUBLE
):
return self._encode_quoted_str(obj, QuoteStyle.ALWAYS_SINGLE)
if (
single_quotes_seen > double_quotes_seen
and quote_style == QuoteStyle.PREFER_SINGLE
):
return self._encode_quoted_str(obj, QuoteStyle.ALWAYS_DOUBLE)
if quote_style in (QuoteStyle.ALWAYS_DOUBLE, QuoteStyle.PREFER_DOUBLE):
return '"' + ''.join(ret) + '"'
return "'" + ''.join(ret) + "'"
def _escape_ch(self, ch: str) -> str:
"""Returns the backslash-escaped representation of the char."""
if ch == '\\':
return '\\\\'
if ch == "'":
return r'\''
if ch == '"':
return r'\"'
if ch == '\n':
return r'\n'
if ch == '\r':
return r'\r'
if ch == '\t':
return r'\t'
if ch == '\b':
return r'\b'
if ch == '\f':
return r'\f'
if ch == '\v':
return r'\v'
if ch == '\0':
return r'\0'
o = ord(ch)
if o < 65536:
return rf'\u{o:04x}'
val = o - 0x10000
high = 0xD800 + (val >> 10)
low = 0xDC00 + (val & 0x3FF)
return rf'\u{high:04x}\u{low:04x}'
def _encode_non_basic_type(self, obj, seen: Set, level: int) -> str:
# Basic types can't be recursive so we only check for circularity
# on non-basic types. If for some reason the caller was using a
# subclass of a basic type and wanted to check circularity on it,
# it'd have to do so directly in a subclass of JSON5Encoder.
if self.check_circular:
i = id(obj)
if i in seen:
raise ValueError('Circular reference detected.')
seen.add(i)
# Ideally we'd use collections.abc.Mapping and collections.abc.Sequence
# here, but for backwards-compatibility with potential old callers,
# we only check for the two attributes we need in each case.
if hasattr(obj, 'keys') and hasattr(obj, '__getitem__'):
s = self._encode_dict(obj, seen, level + 1)
elif hasattr(obj, '__getitem__') and hasattr(obj, '__iter__'):
s = self._encode_array(obj, seen, level + 1)
else:
s = self.encode(self.default(obj), seen, level + 1, as_key=False)
assert s is not None
if self.check_circular:
seen.remove(i)
return s
def _encode_dict(self, obj: Any, seen: set, level: int) -> str:
if not obj:
return '{}'
indent_str, end_str = self._spacers(level)
item_sep = self.item_separator + indent_str
kv_sep = self.kv_separator
if self.sort_keys:
keys = sorted(obj.keys())
else:
keys = obj.keys()
s = '{' + indent_str
first_key = True
new_keys = set()
for key in keys:
try:
key_str = self.encode(key, seen, level, as_key=True)
except TypeError:
if self.skipkeys:
continue
raise
if not self.allow_duplicate_keys:
if key_str in new_keys:
raise ValueError(f'duplicate key {repr(key)}')
new_keys.add(key_str)
if first_key:
first_key = False
else:
s += item_sep
val_str = self.encode(obj[key], seen, level, as_key=False)
s += key_str + kv_sep + val_str
s += end_str + '}'
return s
def _encode_array(self, obj: Any, seen: Set, level: int) -> str:
if not obj:
return '[]'
indent_str, end_str = self._spacers(level)
item_sep = self.item_separator + indent_str
return (
'['
+ indent_str
+ item_sep.join(
self.encode(el, seen, level, as_key=False) for el in obj
)
+ end_str
+ ']'
)
def _spacers(self, level: int) -> Tuple[str, str]:
if self.indent is not None:
end_str = ''
if self.trailing_commas:
end_str = ','
if isinstance(self.indent, int):
if self.indent > 0:
indent_str = '\n' + ' ' * self.indent * level
end_str += '\n' + ' ' * self.indent * (level - 1)
else:
indent_str = '\n'
end_str += '\n'
else:
indent_str = '\n' + self.indent * level
end_str += '\n' + self.indent * (level - 1)
else:
indent_str = ''
end_str = ''
return indent_str, end_str
def is_identifier(self, key: str) -> bool:
"""Returns whether the string could be used as a legal
EcmaScript/JavaScript identifier.
There should normally be no reason to override this, unless
the definition of identifiers change in later versions of the
JSON5 spec and this implementation hasn't been updated to handle
the changes yet."""
if (
not key
or not self._is_id_start(key[0])
and key[0] not in ('$', '_')
):
return False
for ch in key[1:]:
if not self._is_id_continue(ch) and ch not in ('$', '_'):
return False
return True
def _is_id_start(self, ch: str) -> bool:
return unicodedata.category(ch) in (
'Lu',
'Ll',
'Li',
'Lt',
'Lm',
'Lo',
'Nl',
)
def _is_id_continue(self, ch: str) -> bool:
return unicodedata.category(ch) in (
'Lu',
'Ll',
'Li',
'Lt',
'Lm',
'Lo',
'Nl',
'Nd',
'Mn',
'Mc',
'Pc',
)
def is_reserved_word(self, key: str) -> bool:
"""Returns whether the key is a reserved word.
There should normally be no need to override this, unless there
have been reserved words added in later versions of the JSON5
spec and this implementation has not yet been updated to handle
the changes yet."""
global _reserved_word_re
if _reserved_word_re is None:
# List taken from section 7.6.1 of ECMA-262, version 5.1.
# https://262.ecma-international.org/5.1/#sec-7.6.1.
# This includes currently reserved words, words reserved
# for future use (both as of 5.1), null, true, and false.
_reserved_word_re = re.compile(
'('
+ '|'.join(
[
'break',
'case',
'catch',
'class',
'const',
'continue',
'debugger',
'default',
'delete',
'do',
'else',
'enum',
'export',
'extends',
'false',
'finally',
'for',
'function',
'if',
'import',
'in',
'instanceof',
'new',
'null',
'return',
'super',
'switch',
'this',
'throw',
'true',
'try',
'typeof',
'var',
'void',
'while',
'with',
]
)
+ ')$'
)
return _reserved_word_re.match(key) is not None
def _raise_type_error(obj) -> Any:
raise TypeError(f'{repr(obj)} is not JSON5 serializable')
|