freqsap.interfaces
==================

.. py:module:: freqsap.interfaces

.. autoapi-nested-parse::

   Module defining abstract interfaces for protein and variant frequency APIs.



Classes
-------

.. autoapisummary::

   freqsap.interfaces.ProteinVariantAPI
   freqsap.interfaces.VariantFrequencyAPI


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

.. py:class:: ProteinVariantAPI

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


   Abstract base class for protein variant data sources.

   Defines the interface that all protein variant API implementations must follow.


   .. py:method:: get(accession: freqsap.accession.Accession) -> freqsap.protein.Protein
      :abstractmethod:


      Retrieve protein information for the given accession.

      :param accession: The protein accession identifier.
      :type accession: Accession

      :returns: The protein object with its variants.
      :rtype: Protein



   .. py:method:: available() -> bool
      :abstractmethod:


      Check if the API service is currently available.

      :returns: True if the service is available, False otherwise.
      :rtype: bool



.. py:class:: VariantFrequencyAPI

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


   Abstract base class for variant frequency data sources.

   Defines the interface that all variant frequency API implementations must follow.


   .. py:method:: get(variation: freqsap.variation.Variation) -> freqsap.report.ReferenceSNPReport
      :abstractmethod:


      Retrieve frequency information for the given variation.

      :param variation: The genetic variation to query.
      :type variation: Variation

      :returns: A report containing frequency data for the variation.
      :rtype: ReferenceSNPReport



   .. py:method:: available() -> bool
      :abstractmethod:


      Check if the API service is currently available.

      :returns: True if the service is available, False otherwise.
      :rtype: bool