syndirella.error
================

.. py:module:: syndirella.error

.. autoapi-nested-parse::

   error.py

   Possible errors when using syndirella.



Exceptions
----------

.. autoapisummary::

   syndirella.error.ChemicalErrorBase
   syndirella.error.MolError
   syndirella.error.SMARTSError
   syndirella.error.NoReactants
   syndirella.error.NoSynthesisRoute
   syndirella.error.ReactionError
   syndirella.error.ProductFormationError
   syndirella.error.ScaffoldPlacementError
   syndirella.error.PlacementError
   syndirella.error.NoScaffold
   syndirella.error.NoToHippo
   syndirella.error.APIQueryError


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

.. py:exception:: ChemicalErrorBase(message: str, inchi: str | None = None, smiles: str | None = None, mol: rdkit.Chem.Mol | None = None)

   Bases: :py:obj:`Exception`


   Common base class for all non-exit exceptions.


   .. py:attribute:: message


   .. py:attribute:: inchi
      :value: None



   .. py:attribute:: smiles
      :value: None



   .. py:attribute:: mol
      :value: None



.. py:exception:: MolError(route_uuid: str | None = None, message: str = 'Could not create a Chem.Mol object.', inchi: str | None = None, smiles: str | None = None, mol: rdkit.Chem.Mol | None = None)

   Bases: :py:obj:`ChemicalErrorBase`


   Common base class for all non-exit exceptions.


   .. py:attribute:: route_uuid
      :value: None



.. py:exception:: SMARTSError(route_uuid: str | None = None, message: str = 'An error occurred with SMARTS handling.', inchi: str | None = None, smiles: str | None = None, mol: rdkit.Chem.Mol | None = None)

   Bases: :py:obj:`ChemicalErrorBase`


   Common base class for all non-exit exceptions.


   .. py:attribute:: route_uuid
      :value: None



.. py:exception:: NoReactants(route_uuid: str | None = None, message: str = 'No reactants found for the reaction.', inchi: str | None = None, smiles: str | None = None, mol: rdkit.Chem.Mol | None = None)

   Bases: :py:obj:`ChemicalErrorBase`


   Common base class for all non-exit exceptions.


   .. py:attribute:: route_uuid
      :value: None



.. py:exception:: NoSynthesisRoute(message: str = 'No synthesis route could be found.', inchi: str | None = None, smiles: str | None = None, mol: rdkit.Chem.Mol | None = None)

   Bases: :py:obj:`ChemicalErrorBase`


   Common base class for all non-exit exceptions.


.. py:exception:: ReactionError(route_uuid: str, message: str = 'An error occurred during the reaction.', inchi: str | None = None, smiles: str | None = None, mol: rdkit.Chem.Mol | None = None)

   Bases: :py:obj:`ChemicalErrorBase`


   Common base class for all non-exit exceptions.


   .. py:attribute:: route_uuid


.. py:exception:: ProductFormationError(route_uuid: str, message: str = 'Failed to form the scaffold.', inchi: str | None = None, smiles: str | None = None, mol: rdkit.Chem.Mol | None = None)

   Bases: :py:obj:`ChemicalErrorBase`


   Common base class for all non-exit exceptions.


   .. py:attribute:: route_uuid


.. py:exception:: ScaffoldPlacementError(route_uuid: str | None = None, message: str = 'Scaffold could not be successfully placed.', inchi: str | None = None, smiles: str | None = None, mol: rdkit.Chem.Mol | None = None)

   Bases: :py:obj:`ChemicalErrorBase`


   Common base class for all non-exit exceptions.


   .. py:attribute:: route_uuid
      :value: None



.. py:exception:: PlacementError(route_uuid: str, message: str = 'Placement could not be successfully performed.', inchi: str | None = None, smiles: str | None = None, mol: rdkit.Chem.Mol | None = None)

   Bases: :py:obj:`ChemicalErrorBase`


   Common base class for all non-exit exceptions.


   .. py:attribute:: route_uuid


.. py:exception:: NoScaffold(route_uuid: str, message: str = 'No scaffold could be found.', inchi: str | None = None, smiles: str | None = None, mol: rdkit.Chem.Mol | None = None)

   Bases: :py:obj:`ChemicalErrorBase`


   Common base class for all non-exit exceptions.


   .. py:attribute:: route_uuid


.. py:exception:: NoToHippo(route_uuid: str, message: str = 'The to_hippo pickle file could not be successfully created.', inchi: str | None = None, smiles: str | None = None, mol: rdkit.Chem.Mol | None = None)

   Bases: :py:obj:`ChemicalErrorBase`


   Common base class for all non-exit exceptions.


   .. py:attribute:: route_uuid


.. py:exception:: APIQueryError(message: str = 'The API query did not successfully return critical information.', inchi: str | None = None, smiles: str | None = None, mol: rdkit.Chem.Mol | None = None, route_uuid: str | None = None)

   Bases: :py:obj:`ChemicalErrorBase`


   Common base class for all non-exit exceptions.


   .. py:attribute:: route_uuid
      :value: None