"""
Contains base types.
.. class:: ParsedObject(abc.ABC)
"""
import abc
import logging
__all__ = ['ParsedObject']
logger = logging.getLogger(__name__)
[docs]class ParsedObject(abc.ABC):
"""
Implements base parsed object.
Means part of API json response that is structured by category and has inner fields.
Class gives convenient base for inheriting
and creating more concrete types,
so inherited classes parse more detailed information
and might be used in `composition` with the others.
Must be inherited since it is abstract.
For example, in response of dictionary API it might be:
- phonetics;
- meanings;
- definitions.
Considering that simple response might look like that (copied from https://dictionaryapi.dev/):
.. code-block:: JSON
:linenos:
[
{
"word": "hello",
"phonetics": [
{
"text": "/həˈloʊ/",
"audio": "https://lex-audio.useremarkable.com/mp3/hello_us_1_rr.mp3"
},
{
"text": "/hɛˈloʊ/",
"audio": "https://lex-audio.useremarkable.com/mp3/hello_us_2_rr.mp3"
}
],
"meanings": [
{
"partOfSpeech": "exclamation",
"definitions": [
{
"definition": "Used as a greeting or to begin a phone conversation.",
"example": "hello there, Katie!"
}
]
},
{
"partOfSpeech": "noun",
"definitions": [
{
"definition": "An utterance of “hello”; a greeting.",
"example": "she was getting polite nods and hellos from people",
"synonyms": [
"greeting",
"welcome",
"salutation",
"saluting",
"hailing",
"address",
"hello",
"hallo"
]
}
]
},
{
"partOfSpeech": "intransitive verb",
"definitions": [
{
"definition": "Say or shout “hello”; greet someone.",
"example": "I pressed the phone button and helloed"
}
]
}
]
}
]
"""
[docs] def __init__(self, data: dict) -> None:
"""
Init parsed object instance.
Get data presented in python :obj:`dict` and set it in instance (with ``_data`` param).
:param data: part of API json response
:type data: :obj:`dict`
"""
if not isinstance(data, dict):
self._data = {}
logger.debug(f'For {self.__class__.__name__} has been passed not `dict` data param.')
else:
self._data = data
@property
def data(self) -> dict:
"""
:return: Data of the parsed object
:rtype: :obj:`dict`
"""
return self._data
def __eq__(self, other: 'ParsedObject') -> bool:
if not isinstance(other, ParsedObject):
class_name = self.__class__.__name__
raise TypeError(f'{class_name} can not be compared with instance of the other type: {other!r}')
equality = self._data == other._data
return equality