Skip to content

RegulatorAPI

Bases: AbstractRecordsOnlyAPI

A class to interact with the RegulatorAPI endpoint.

Source code in yeastdnnexplorer/interface/RegulatorAPI.py 
 9
10
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
class RegulatorAPI(AbstractRecordsOnlyAPI):
    """A class to interact with the RegulatorAPI endpoint."""

    def __init__(self, **kwargs):
        """
        Initialize the RegulatorAPI object.

        :param kwargs: parameters to pass to AbstractAPI via AbstractRecordsOnlyAPI.

        """
        valid_param_keys = kwargs.pop(
            "valid_param_keys",
            [
                "id",
                "regulator_locus_tag",
                "regulator_symbol",
                "under_development",
            ],
        )

        url = kwargs.pop("url", os.getenv("REGULATOR_URL", None))
        if not url:
            raise AttributeError(
                "url must be provided or the environmental variable ",
                "`REGULATOR_URL` must be set",
            )

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

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

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

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

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

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

__init__(**kwargs)

Initialize the RegulatorAPI object.

Parameters:

Name Type Description Default
kwargs

parameters to pass to AbstractAPI via AbstractRecordsOnlyAPI.

 {}
Source code in yeastdnnexplorer/interface/RegulatorAPI.py 
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
def __init__(self, **kwargs):
    """
    Initialize the RegulatorAPI object.

    :param kwargs: parameters to pass to AbstractAPI via AbstractRecordsOnlyAPI.

    """
    valid_param_keys = kwargs.pop(
        "valid_param_keys",
        [
            "id",
            "regulator_locus_tag",
            "regulator_symbol",
            "under_development",
        ],
    )

    url = kwargs.pop("url", os.getenv("REGULATOR_URL", None))
    if not url:
        raise AttributeError(
            "url must be provided or the environmental variable ",
            "`REGULATOR_URL` must be set",
        )

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