Skip to content

academy.exchange.cloud.config

Cloud exchange configuration file parsing.

ExchangeAuthConfig pydantic-model

Bases: BaseModel

Exchange authentication configuration.

Attributes:

  • method (Optional[Literal['globus']]) –

    Authentication method.

  • kwargs (Dict[str, Any]) –

    Arbitrary keyword arguments to pass to the authenticator. The kwargs are excluded from the repr() of this class because they often contain secrets.

Config:

  • extra: forbid

Fields:

BackendConfig

Bases: Protocol

Config for backend of storing messages.

get_backend abstractmethod 

get_backend() -> MailboxBackend

Construct an instance of the backend from the config.

Source code in academy/exchange/cloud/config.py 
62
63
64
65
@abc.abstractmethod
def get_backend(self) -> MailboxBackend:
    """Construct an instance of the backend from the config."""
    ...

PythonBackendConfig pydantic-model

Bases: BaseModel

Config for using PythonBackend.

Config:

  • extra: forbid

Fields:

  • message_size_limit_kb (int)
  • kind (Literal['python'])

get_backend 

get_backend() -> MailboxBackend

Construct an instance of the backend from the config.

Source code in academy/exchange/cloud/config.py 
76
77
78
def get_backend(self) -> MailboxBackend:
    """Construct an instance of the backend from the config."""
    return PythonBackend()

RedisBackendConfig pydantic-model

Bases: BaseModel

Config for RedisBackend.

Attributes:

  • hostname (str) –

    Redis host

  • port (int) –

    Redis port

  • kwargs (Dict[str, Any]) –

    Any additional args to Redis

Config:

  • extra: forbid

Fields:

get_backend 

get_backend() -> MailboxBackend

Construct an instance of the backend from the config.

Source code in academy/exchange/cloud/config.py 
103
104
105
106
107
108
109
110
111
112
113
114
def get_backend(self) -> MailboxBackend:
    """Construct an instance of the backend from the config."""
    return RedisBackend(
        self.hostname,
        self.port,
        message_size_limit_kb=self.message_size_limit_kb,
        kwargs=self.kwargs,
        mailbox_expiration_s=int(self.mailbox_expiration_d * 24 * 2600),
        gravestone_expiration_s=int(
            self.gravestone_expiration_d * 24 * 3600,
        ),
    )

ExchangeServingConfig pydantic-model

Bases: BaseModel

Exchange serving configuration.

Attributes:

  • host (str) –

    Network interface the server binds to.

  • port (int) –

    Network port the server binds to.

  • certfile (Optional[str]) –

    Certificate file (PEM format) use to enable TLS.

  • keyfile (Optional[str]) –

    Private key file. If not specified, the key will be taken from the certfile.

  • auth (ExchangeAuthConfig) –

    Authentication configuration.

  • log_file (Optional[str]) –

    Location to write logs.

  • log_level (Union[int, str]) –

    Verbosity of logs.

Fields:

from_toml classmethod 

from_toml(filepath: str | Path) -> Self

Parse an TOML config file.

Example

Minimal config without SSL and without authentication.

exchange.toml
port = 8700


from academy_exchange.config import ExchangeServingConfig

config = ExchangeServingConfig.from_toml('exchange.toml')
Example

Serve with SSL and Globus Auth.

relay.toml
host = "0.0.0.0"
port = 8700
certfile = "/path/to/cert.pem"
keyfile = "/path/to/privkey.pem"

[auth]
method = "globus"

[auth.kwargs]
client_id = "..."
client_secret = "..."

Note

Omitted values will be set to their defaults (if they are an optional value with a default).

relay.toml
[serving]
certfile = "/path/to/cert.pem"


from academy_exchange.config import ExchangeServingConfig

config = ExchangeServingConfig.from_config('relay.toml')
assert config.certfile == '/path/to/cert.pem'
assert config.keyfile is None
Source code in academy/exchange/cloud/config.py 
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
@classmethod
def from_toml(cls, filepath: str | pathlib.Path) -> Self:
    """Parse an TOML config file.

    Example:
        Minimal config without SSL and without authentication.
        ```toml title="exchange.toml"
        port = 8700
        ```

        ```python
        from academy_exchange.config import ExchangeServingConfig

        config = ExchangeServingConfig.from_toml('exchange.toml')
        ```

    Example:
        Serve with SSL and Globus Auth.
        ```toml title="relay.toml"
        host = "0.0.0.0"
        port = 8700
        certfile = "/path/to/cert.pem"
        keyfile = "/path/to/privkey.pem"

        [auth]
        method = "globus"

        [auth.kwargs]
        client_id = "..."
        client_secret = "..."
        ```

    Note:
        Omitted values will be set to their defaults (if they are an
        optional value with a default).
        ```toml title="relay.toml"
        [serving]
        certfile = "/path/to/cert.pem"
        ```

        ```python
        from academy_exchange.config import ExchangeServingConfig

        config = ExchangeServingConfig.from_config('relay.toml')
        assert config.certfile == '/path/to/cert.pem'
        assert config.keyfile is None
        ```
    """
    with open(filepath, 'rb') as f:
        return load(cls, f)

load 

load(model: type[BaseModelT], fp: BinaryIO) -> BaseModelT

Parse TOML from a binary file to a data class.

Parameters:

  • model (type[BaseModelT]) –

    Config model type to parse TOML using.

  • fp (BinaryIO) –

    File-like bytes stream to read in.

Returns:

  • BaseModelT –

    Model initialized from TOML file.

Source code in academy/exchange/cloud/config.py 
195
196
197
198
199
200
201
202
203
204
205
def load(model: type[BaseModelT], fp: BinaryIO) -> BaseModelT:
    """Parse TOML from a binary file to a data class.

    Args:
        model: Config model type to parse TOML using.
        fp: File-like bytes stream to read in.

    Returns:
        Model initialized from TOML file.
    """
    return loads(model, fp.read().decode())

loads 

loads(model: type[BaseModelT], data: str) -> BaseModelT

Parse TOML string to data class.

Parameters:

  • model (type[BaseModelT]) –

    Config model type to parse TOML using.

  • data (str) –

    TOML string to parse.

Returns:

  • BaseModelT –

    Model initialized from TOML file.

Source code in academy/exchange/cloud/config.py 
208
209
210
211
212
213
214
215
216
217
218
219
def loads(model: type[BaseModelT], data: str) -> BaseModelT:
    """Parse TOML string to data class.

    Args:
        model: Config model type to parse TOML using.
        data: TOML string to parse.

    Returns:
        Model initialized from TOML file.
    """
    data_dict = tomllib.loads(data)
    return model.model_validate(data_dict)