pyHarm.Substructures.SubDataReader.ABCReader
============================================

.. py:module:: pyHarm.Substructures.SubDataReader.ABCReader

.. autoapi-nested-parse::

   "
   This module contains the abstract class defining the main interfaces and behaviors expected from a SubDataReader objects.
   The main purpose of such object is to modify and complete the input substructure data provided in the input file in order to adapt the syntax for Substructure object creation.



Classes
-------

.. autoapisummary::

   pyHarm.Substructures.SubDataReader.ABCReader.ABCReader


Module Contents
---------------

.. py:class:: ABCReader

   Bases: :py:obj:`abc.ABC`


   This is the abstract class ruling the reader class for substructure. The reader is responsible for reading, parsing and completing an input dictionary from a external file to comply with pyHarm.



   .. py:property:: factory_keyword
      :abstractmethod:


      Factory keyword to be used when instantiating a reader


   .. py:method:: data_complete(data: dict) -> dict
      :abstractmethod:


      Reads and completes the input dictionary from the file.