moleculeresolver.services.base
==============================

.. py:module:: moleculeresolver.services.base


Classes
-------

.. autoapisummary::

   moleculeresolver.services.base.ServiceSearchResult
   moleculeresolver.services.base.ServiceAdapter


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

.. py:class:: ServiceSearchResult

   Normalized single-service search result consumed by MoleculeResolver.


   .. py:attribute:: molecule
      :type:  moleculeresolver.molecule.Molecule


   .. py:attribute:: mode_used
      :type:  str


   .. py:attribute:: identifier_used
      :type:  str


   .. py:attribute:: additional_information
      :type:  Optional[str]


   .. py:attribute:: current_service
      :type:  str


   .. py:attribute:: synonyms
      :type:  list[str]


   .. py:attribute:: cas
      :type:  set[str]


.. py:class:: ServiceAdapter

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


   Contract for a resolver service adapter.


   .. py:attribute:: name
      :type:  str


   .. py:method:: resolve(resolver: moleculeresolver.moleculeresolver.MoleculeResolver, flattened_identifiers: list[str], flattened_modes: list[str], required_formula: Optional[str], required_charge: Optional[int], required_structure_type: Optional[str]) -> Optional[ServiceSearchResult]

      Resolve by trying each identifier/mode pair in order.



   .. py:method:: resolve_one(resolver: moleculeresolver.moleculeresolver.MoleculeResolver, identifier: str, mode: str, required_formula: Optional[str], required_charge: Optional[int], required_structure_type: Optional[str]) -> Optional[ServiceSearchResult]
      :abstractmethod:


      Resolve one identifier/mode pair for this adapter or return None.