flask.json.tag.JSONTag

class documentation

class JSONTag:

Known subclasses: flask.json.tag.PassDict, flask.json.tag.PassList, flask.json.tag.TagBytes, flask.json.tag.TagDateTime, flask.json.tag.TagDict, flask.json.tag.TagMarkup, flask.json.tag.TagTuple, flask.json.tag.TagUUID

View In Hierarchy

Base class for defining type tags for TaggedJSONSerializer.

Method	`check`	Check if the given value should be tagged by this tag.
Method	`tag`	Convert the value to a valid JSON type and add the tag structure around it.
Method	`to_json`	Convert the Python object to an object that is a valid JSON type. The tag will be added later.
Method	`to_python`	Convert the JSON representation back to the correct type. The tag will already be removed.
Class Variable	`key`	Undocumented
Method	`__init__`	Create a tagger for the given serializer.
Class Variable	`__slots__`	Undocumented
Instance Variable	`serializer`	Undocumented

def check(self, value):

overridden in flask.json.tag.PassDict, flask.json.tag.PassList, flask.json.tag.TagBytes, flask.json.tag.TagDateTime, flask.json.tag.TagDict, flask.json.tag.TagMarkup, flask.json.tag.TagTuple, flask.json.tag.TagUUID

Check if the given value should be tagged by this tag.

Parameters
value:`t.Any`	Undocumented
Returns
`bool`	Undocumented

def tag(self, value):

Convert the value to a valid JSON type and add the tag structure around it.

Parameters
value:`t.Any`	Undocumented
Returns
`t.Any`	Undocumented

def to_json(self, value):

Convert the Python object to an object that is a valid JSON type. The tag will be added later.

Parameters
value:`t.Any`	Undocumented
Returns
`t.Any`	Undocumented

def to_python(self, value):

overridden in flask.json.tag.TagBytes, flask.json.tag.TagDateTime, flask.json.tag.TagDict, flask.json.tag.TagMarkup, flask.json.tag.TagTuple, flask.json.tag.TagUUID

Convert the JSON representation back to the correct type. The tag will already be removed.

Parameters
value:`t.Any`	Undocumented
Returns
`t.Any`	Undocumented

key: t.Optional[str] =

overridden in flask.json.tag.TagBytes, flask.json.tag.TagDateTime, flask.json.tag.TagDict, flask.json.tag.TagMarkup, flask.json.tag.TagTuple, flask.json.tag.TagUUID

Undocumented

def __init__(self, serializer):

Create a tagger for the given serializer.

Parameters
serializer:`TaggedJSONSerializer`	Undocumented

__slots__: tuple[str, ...] =

Undocumented

serializer =

Undocumented