Source code for tango_simlib.utilities.base_parser
#########################################################################################
# Copyright 2018 SKA South Africa (http://ska.ac.za/) #
# #
# BSD license - see LICENSE.txt for details #
#########################################################################################
from __future__ import absolute_import, division, print_function
from future import standard_library
standard_library.install_aliases() # noqa: E402
import abc
from builtins import object
from future.utils import with_metaclass
[docs]class Parser(with_metaclass(abc.ABCMeta, object)):
def __init__(self):
"""
Parser class handling a simulator description datafile.
Creating an instance of this class requires calling :meth:`parse`
afterwards to extract all the provided tango attributes, commands,
device property and device override class information from the specified
file. The formatted data is a dict structure and can be obtained using
:meth:`get_device_attribute_metadata`,
:meth:`get_device_command_metadata`,
:meth:`get_device_properties_metadata` and
:meth:`get_device_cmd_override_metadata`
"""
self.data_description_file_name = ""
self.device_class_name = ""
self._device_attributes = {}
self._device_commands = {}
self._device_properties = {}
[docs] @abc.abstractmethod
def parse(self, data_file):
pass
