mandos.model.pubchem_api

Complexity

Total Complexity

3

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	PubchemApi.fetch_data_from_cid()	0	4	1
A	PubchemApi.fetch_data()	0	2	1
A	PubchemApi.find_similar_compounds()	0	2	1

"""
PubChem querying API.
"""
from __future__ import annotations

import abc
import logging
from typing import Optional, Union, FrozenSet

from mandos.model import CompoundNotFoundError
from mandos.model.pubchem_support.pubchem_data import PubchemData

logger = logging.getLogger("mandos")


class PubchemCompoundLookupError(CompoundNotFoundError):

Empty class docstring

    """"""


class PubchemApi(metaclass=abc.ABCMeta):

Missing class docstring

    def fetch_data_from_cid(self, cid: int) -> Optional[PubchemData]:

Missing function or method docstring

        # separated from fetch_data to make it completely clear what an int value means
        # noinspection PyTypeChecker
        return self.fetch_data(cid)

    def fetch_data(self, inchikey: str) -> Optional[PubchemData]:

Missing function or method docstring

        raise NotImplementedError()

    def find_similar_compounds(self, inchi: Union[int, str], min_tc: float) -> FrozenSet[int]:

Missing function or method docstring

        raise NotImplementedError()


__all__ = ["PubchemApi", "PubchemCompoundLookupError"]