Skip to content

Model

Models.

ApiKey

Bases: Serializable

API key class.

Source code in teledetection/sdk/model.py 
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
class ApiKey(Serializable):
    """API key class."""

    access_key: str = Field(alias="access-key")
    secret_key: str = Field(alias="secret-key")

    @classmethod
    def from_env(cls):
        """Try to load from env."""
        env = Settings()
        if env.tld_access_key and env.tld_secret_key:
            return cls(
                access_key=env.tld_access_key,
                secret_key=env.tld_secret_key,
            )
        return None

    @classmethod
    def grab(cls):
        """Try to load an API key from env. or file."""
        return cls.from_env() or cls.from_config_dir()

from_env() classmethod

Try to load from env.

Source code in teledetection/sdk/model.py 
105
106
107
108
109
110
111
112
113
114
@classmethod
def from_env(cls):
    """Try to load from env."""
    env = Settings()
    if env.tld_access_key and env.tld_secret_key:
        return cls(
            access_key=env.tld_access_key,
            secret_key=env.tld_secret_key,
        )
    return None

grab() classmethod

Try to load an API key from env. or file.

Source code in teledetection/sdk/model.py 
116
117
118
119
@classmethod
def grab(cls):
    """Try to load an API key from env. or file."""
    return cls.from_env() or cls.from_config_dir()

DeviceGrantResponse

Bases: BaseModel

Device grant login response model.

Source code in teledetection/sdk/model.py 
90
91
92
93
94
95
96
class DeviceGrantResponse(BaseModel):  # pylint: disable = R0903
    """Device grant login response model."""

    verification_uri_complete: str
    device_code: str
    expires_in: int
    interval: int

JWT

Bases: Serializable

JWT model.

Source code in teledetection/sdk/model.py 
80
81
82
83
84
85
86
87
class JWT(Serializable):
    """JWT model."""

    access_token: str
    expires_in: int
    refresh_token: str
    refresh_expires_in: int
    token_type: str

Serializable

Bases: BaseModel

Base class for serializable pyantic models.

Source code in teledetection/sdk/model.py 
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
class Serializable(BaseModel):  # pylint: disable = R0903
    """Base class for serializable pyantic models."""

    model_config = ConfigDict(
        populate_by_name=True,
    )

    @classmethod
    def get_cfg_file_name(cls) -> str | None:
        """Get the config file name (without full path)."""
        name = f".{cls.__name__.lower()}"
        log.debug("Looking for config file for %s", name)
        cfg_pth = get_config_path()
        cfg_file = os.path.join(cfg_pth, name) if cfg_pth else None
        log.debug("Config file %sfound %s", "" if cfg_file else "not ", cfg_file or "")
        return cfg_file

    @classmethod
    def from_config_dir(cls):
        """Try to load from config directory."""
        cfg_file = cls.get_cfg_file_name()
        return cls.from_file(cfg_file) if cfg_file else None

    def to_config_dir(self):
        """Try to save to config files."""
        cfg_file = self.get_cfg_file_name()
        if cfg_file:
            self.to_file(cfg_file)

    @classmethod
    def from_dict(cls, dict: Dict):
        """Get the object from dict."""
        return cls(**dict)

    def to_dict(self) -> Dict[str, str]:
        """To dict."""
        return self.model_dump(by_alias=True)

    @classmethod
    def from_file(cls, file_path: str):
        """Load object from a file."""
        try:
            log.debug("Reading JSON file %s", file_path)
            with open(file_path, "r", encoding="utf-8") as file_handler:
                return cls(**json.load(file_handler))
        except (FileNotFoundError, IOError, json.decoder.JSONDecodeError) as err:
            log.debug("Cannot read object from config directory (%s).", err)

        return None

    def to_file(self, file_path: str):
        """Save the object to file."""
        try:
            log.debug("Writing JSON file %s", file_path)
            with open(file_path, "w", encoding="utf-8") as file_handler:
                json.dump(self.to_dict(), file_handler)
        except IOError as io_err:
            log.warning("Unable to save file %s (%s)", file_path, io_err)

    @classmethod
    def delete_from_config_dir(cls):
        """Delete the config file, if there."""
        cfg_file = cls.get_cfg_file_name()
        if cfg_file:
            os.remove(cfg_file)

delete_from_config_dir() classmethod

Delete the config file, if there.

Source code in teledetection/sdk/model.py 
72
73
74
75
76
77
@classmethod
def delete_from_config_dir(cls):
    """Delete the config file, if there."""
    cfg_file = cls.get_cfg_file_name()
    if cfg_file:
        os.remove(cfg_file)

from_config_dir() classmethod

Try to load from config directory.

Source code in teledetection/sdk/model.py 
30
31
32
33
34
@classmethod
def from_config_dir(cls):
    """Try to load from config directory."""
    cfg_file = cls.get_cfg_file_name()
    return cls.from_file(cfg_file) if cfg_file else None

from_dict(dict) classmethod

Get the object from dict.

Source code in teledetection/sdk/model.py 
42
43
44
45
@classmethod
def from_dict(cls, dict: Dict):
    """Get the object from dict."""
    return cls(**dict)

from_file(file_path) classmethod

Load object from a file.

Source code in teledetection/sdk/model.py 
51
52
53
54
55
56
57
58
59
60
61
@classmethod
def from_file(cls, file_path: str):
    """Load object from a file."""
    try:
        log.debug("Reading JSON file %s", file_path)
        with open(file_path, "r", encoding="utf-8") as file_handler:
            return cls(**json.load(file_handler))
    except (FileNotFoundError, IOError, json.decoder.JSONDecodeError) as err:
        log.debug("Cannot read object from config directory (%s).", err)

    return None

get_cfg_file_name() classmethod

Get the config file name (without full path).

Source code in teledetection/sdk/model.py 
20
21
22
23
24
25
26
27
28
@classmethod
def get_cfg_file_name(cls) -> str | None:
    """Get the config file name (without full path)."""
    name = f".{cls.__name__.lower()}"
    log.debug("Looking for config file for %s", name)
    cfg_pth = get_config_path()
    cfg_file = os.path.join(cfg_pth, name) if cfg_pth else None
    log.debug("Config file %sfound %s", "" if cfg_file else "not ", cfg_file or "")
    return cfg_file

to_config_dir()

Try to save to config files.

Source code in teledetection/sdk/model.py 
36
37
38
39
40
def to_config_dir(self):
    """Try to save to config files."""
    cfg_file = self.get_cfg_file_name()
    if cfg_file:
        self.to_file(cfg_file)

to_dict()

To dict.

Source code in teledetection/sdk/model.py 
47
48
49
def to_dict(self) -> Dict[str, str]:
    """To dict."""
    return self.model_dump(by_alias=True)

to_file(file_path)

Save the object to file.

Source code in teledetection/sdk/model.py 
63
64
65
66
67
68
69
70
def to_file(self, file_path: str):
    """Save the object to file."""
    try:
        log.debug("Writing JSON file %s", file_path)
        with open(file_path, "w", encoding="utf-8") as file_handler:
            json.dump(self.to_dict(), file_handler)
    except IOError as io_err:
        log.warning("Unable to save file %s (%s)", file_path, io_err)