freqsap.interfaces

Module defining abstract interfaces for protein and variant frequency APIs.

Classes

ProteinVariantAPI	Abstract base class for protein variant data sources.
VariantFrequencyAPI	Abstract base class for variant frequency data sources.

Module Contents

class freqsap.interfaces.ProteinVariantAPI

Bases: abc.ABC

Abstract base class for protein variant data sources.

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

abstractmethod get(accession: freqsap.accession.Accession) → freqsap.protein.Protein

Retrieve protein information for the given accession.

Parameters:

accession (Accession) – The protein accession identifier.

Returns:

The protein object with its variants.

Return type:

Protein

abstractmethod available() → bool

Check if the API service is currently available.

Returns:

True if the service is available, False otherwise.

Return type:

bool

class freqsap.interfaces.VariantFrequencyAPI

Bases: abc.ABC

Abstract base class for variant frequency data sources.

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

abstractmethod get(variation: freqsap.variation.Variation) → freqsap.report.ReferenceSNPReport

Retrieve frequency information for the given variation.

Parameters:

variation (Variation) – The genetic variation to query.

Returns:

A report containing frequency data for the variation.

Return type:

ReferenceSNPReport

abstractmethod available() → bool

Check if the API service is currently available.

Returns:

True if the service is available, False otherwise.

Return type:

bool