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
|
#!/usr/bin/env python
#
# _abc.py
"""
Abstract Base Class for JSON and YAML serializers.
"""
#
# Copyright © 2020-2021 Dominic Davis-Foster <dominic@davis-foster.co.uk>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
# MA 02110-1301, USA.
#
# Based on Slumber <https://slumber.readthedocs.io>
# Copyright (c) 2011 Donald Stufft
# Licensed under the 2-clause BSD License
#
# stdlib
from abc import ABC, abstractmethod
from typing import Any, List, Mapping, MutableMapping
__all__ = ["Serializer"]
class Serializer(ABC):
"""
Base class for serializers.
.. versionchanged:: 0.6.0 Moved to :mod:`apeye.slumber_url.serializers`
"""
@property
@abstractmethod
def content_types(self) -> List[str]: # pragma: no cover
"""
List of supported content types.
"""
return NotImplemented
@property
@abstractmethod
def key(self) -> str: # pragma: no cover
"""
An identifier for the supported data type.
For example, a YAML serializer would set this to ``'yaml'``.
"""
return NotImplemented
def get_content_type(self) -> str:
"""
Returns the first value from :attr:`~.Serializer.content_types`.
"""
return self.content_types[0]
@abstractmethod
def loads(self, data: str) -> MutableMapping[str, Any]:
"""
Deserialize data using this :class:`~.Serializer`.
:param data:
"""
raise NotImplementedError()
@abstractmethod
def dumps(self, data: Mapping[str, Any]) -> str:
"""
Serialize data using this :class:`~.Serializer`.
:param data:
"""
raise NotImplementedError()
|
