Skip to content

CallingCardsBackgroundAPI

Bases: AbstractRecordsAndFilesAPI

Class to interact with the CallingCardsBackgroundAPI endpoint.

Source code in yeastdnnexplorer/interface/CallingCardsBackgroundAPI.py
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
class CallingCardsBackgroundAPI(AbstractRecordsAndFilesAPI):
    """Class to interact with the CallingCardsBackgroundAPI endpoint."""

    def __init__(self, **kwargs) -> None:
        """
        Initialize the CallingCardsBackgroundAPI object.

        :param kwargs: parameters to pass through AbstractRecordsAndFilesAPI to
            AbstractAPI.

        """
        valid_param_keys = kwargs.pop(
            "valid_param_keys",
            ["id", "name"],
        )

        url = kwargs.pop("url", os.getenv("CALLINGCARDSBACKGROUND_URL", None))

        super().__init__(url=url, valid_keys=valid_param_keys, **kwargs)

    def create(self, data: dict[str, Any], **kwargs) -> Any:
        raise NotImplementedError(
            "The CallingCardsBackgroundAPI does not support create."
        )

    def update(self, df: pd.DataFrame, **kwargs) -> Any:
        raise NotImplementedError(
            "The CallingCardsBackgroundAPI does not support update."
        )

    def delete(self, id: str, **kwargs) -> Any:
        raise NotImplementedError(
            "The CallingCardsBackgroundAPI does not support delete."
        )

    def submit(self, post_dict: dict[str, Any], **kwargs) -> Any:
        raise NotImplementedError(
            "The CallingCardsBackgroundAPI does not support submit."
        )

    def retrieve(
        self, group_task_id: str, timeout: int, polling_interval: int, **kwargs
    ) -> Any:
        raise NotImplementedError(
            "The CallingCardsBackgroundAPI does not support retrieve."
        )

__init__(**kwargs)

Initialize the CallingCardsBackgroundAPI object.

Parameters:

Name Type Description Default
kwargs

parameters to pass through AbstractRecordsAndFilesAPI to AbstractAPI.

{}
Source code in yeastdnnexplorer/interface/CallingCardsBackgroundAPI.py
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
def __init__(self, **kwargs) -> None:
    """
    Initialize the CallingCardsBackgroundAPI object.

    :param kwargs: parameters to pass through AbstractRecordsAndFilesAPI to
        AbstractAPI.

    """
    valid_param_keys = kwargs.pop(
        "valid_param_keys",
        ["id", "name"],
    )

    url = kwargs.pop("url", os.getenv("CALLINGCARDSBACKGROUND_URL", None))

    super().__init__(url=url, valid_keys=valid_param_keys, **kwargs)