blob: 898bb0e9a4d01b1ffafa382d4a8c9d4b221c2db7 (
plain) (
blame)
1
2
3
4
5
6
7
8
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
54
55
|
---
file_format: mystnb
mystnb:
remove_code_source: true
execution_mode: 'force'
---
# Configuration
The configuration class is defined in [configuration.py](https://github.com/crocs-muni/sec-certs/tree/main/src/sec_certs/configuration.py). From CLI, you can load custom configuration yaml with `-c` or `--config` argument. From Python, you can replace the default configuration with
```python
from pathlib import Path
import sec_certs.configuration as config_module
config_module.config.load_from_yaml("/path/to/your/config.yaml")
# or just set the individual key
config_module.config.log_filepath = Path("/some/path/where/log/will/be/stored.txt")
```
The configuration yaml is a simple flat dictionary of keys and values. The configuration file can specify only *some* of the fields. For the content of unspecified fields, environment variable with `seccerts_` prefix (case insensitive) will be checked. If such variable is not set, default value will be used. Content in the yaml always beats the environment variable.
For instance, when user provides the following yaml
```yaml
log_filepath: my_own_log_file.txt
n_threads: 7
```
and sets `SECCERTS_MINIMAL_TOKEN_LENGTH=4` as environment variable, only these 3 keys will be loaded with `config.load_from_yaml()`, others will be untouched.
```{tip}
You can load settings even without providing yaml configuration. Simply set the corresponding environment variables or use `.env` file.
```
## Configuration keys, types, default values and descriptions
```{code-cell} python
from sec_certs.configuration import config, Configuration
from myst_nb import glue
from IPython.display import Markdown
import typing
type_hints = typing.get_type_hints(Configuration)
text = ""
for field, value in config.model_fields.items():
text += f"`{field}`\n\n"
text += f"- type: `{type_hints[field]}`\n"
text += f"- default: `{value.default}`\n"
text += f"- description: {value.description}\n"
env_var = "SECCERTS_" + field.upper()
text += f"- env name: `{env_var}`\n\n"
glue("text", Markdown(text))
```
|
