PourPy.parser
=============

.. py:module:: PourPy.parser


Classes
-------

.. autoapisummary::

   PourPy.parser.Parser
   PourPy.parser.DefaultParser


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

.. py:class:: Parser

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


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: parse_reactions()
      :abstractmethod:



   .. py:method:: parse_species()
      :abstractmethod:



   .. py:method:: parse_elements()
      :abstractmethod:



.. py:class:: DefaultParser

   Bases: :py:obj:`Parser`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: parse_reactions(reactions: tuple)
      :staticmethod:


      Parses several reactions given as tuple

      :param reactions: reactions to be parsed, each entry of a tuple is a reaction string
      :type reactions: tuple

      :return : reactions as list, each entry is a dict containing reactants
      :rtype : list



   .. py:method:: parse_reaction(reaction: str)
      :staticmethod:


      Parse a reaction from its string representation

      :param reaction: reaction to be parsed
      :type reaction: str

      :return : reactants as dict
      :rtype : dict



   .. py:method:: parse_species(species: tuple, elements: dict)
      :staticmethod:



   .. py:method:: parse_specie(specie: str)
      :staticmethod:


      Parse a specie and its chemical props from its string representation

      :param specie: specie_name,state,dGf,dHf,Sm as string
      :type specie: str

      :return : name of the specie, properties as dictionary
      :rtype : tuple



   .. py:method:: parse_elements()
      :staticmethod: