sphinx.util.jsdump

module documentation

This module implements a simple JavaScript serializer. Uses the basestring encode function from simplejson by Bob Ippolito.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Constant ESCAPE​_ASCII Undocumented
Constant ESCAPE​_DICT Undocumented
Constant ESCAPED Undocumented
Variable reswords Undocumented
Function decode​_string Undocumented
Function dump Undocumented
Function dumps Undocumented
Function encode​_string Undocumented
Function load Undocumented
Function loads Loader that can read the JS subset the indexer produces.
Variable ​_int​_re Undocumented
Variable ​_name​_re Undocumented
Variable ​_nameonly​_re Undocumented
Variable ​_str​_re Undocumented
ESCAPE_ASCII =

Undocumented

Value
re.compile(r'([\\"]|[^ -~])')
ESCAPE_DICT: dict[str, str] =

Undocumented

Value
{'\\': '\\\\',
 '"': '\\"',
 '\x08': '\\b',
 '\f': '\\f',
 '''
''': '\\n',
 '\r': '\\r',
...
ESCAPED =

Undocumented

Value
re.compile(r'\\u.{4}|.')
reswords =

Undocumented

def decode_string(s):

Undocumented

Parameters
s:strUndocumented
Returns
strUndocumented
def dump(obj, f):

Undocumented

Parameters
obj:AnyUndocumented
f:IOUndocumented
def dumps(obj, key=False):

Undocumented

Parameters
obj:AnyUndocumented
key:boolUndocumented
Returns
strUndocumented
def encode_string(s):

Undocumented

Parameters
s:strUndocumented
Returns
strUndocumented
def load(f):

Undocumented

Parameters
f:IOUndocumented
Returns
AnyUndocumented
def loads(x):
Loader that can read the JS subset the indexer produces.
Parameters
x:strUndocumented
Returns
AnyUndocumented
_int_re =

Undocumented

_name_re =

Undocumented

_nameonly_re =

Undocumented

_str_re =

Undocumented