Inheritance diagram for lsst.dax.apdb.apdbConfigFreezer.ApdbConfigFreezer:
Public Member Functions | |
| __init__ (self, Iterable[str] field_names) | |
| str | to_json (self, ApdbConfig config) |
| _Config | update (self, _Config config, str json_str) |
Protected Attributes | |
| _field_names | |
Detailed Description
Class that handles freezing of the configuration parameters, this is
an implementation detail for use in Apdb subclasses.
Parameters
----------
field_names : `~collections.abc.Iterable` [`str`]
Names of configuration fields to be frozen.
Definition at line 35 of file apdbConfigFreezer.py.
Constructor & Destructor Documentation
◆ __init__()
| lsst.dax.apdb.apdbConfigFreezer.ApdbConfigFreezer.__init__ | ( | self, | |
| Iterable[str] | field_names ) |
Definition at line 45 of file apdbConfigFreezer.py.
45 def __init__(self, field_names: Iterable[str]):
46 self._field_names = list(field_names)
47
Member Function Documentation
◆ to_json()
| str lsst.dax.apdb.apdbConfigFreezer.ApdbConfigFreezer.to_json | ( | self, | |
| ApdbConfig | config ) |
Convert part of the configuration object to JSON string.
Parameters
----------
config : `ApdbConfig`
Configuration object.
Returns
-------
json_str : `str`
JSON representation of the frozen part of the config.
Definition at line 48 of file apdbConfigFreezer.py.
48 def to_json(self, config: ApdbConfig) -> str:
49 """Convert part of the configuration object to JSON string.
50
51 Parameters
52 ----------
53 config : `ApdbConfig`
54 Configuration object.
55
56 Returns
57 -------
58 json_str : `str`
59 JSON representation of the frozen part of the config.
60 """
61 config_dict = config.toDict()
62 json_dict = {name: config_dict[name] for name in self._field_names}
63 return json.dumps(json_dict)
64
◆ update()
| _Config lsst.dax.apdb.apdbConfigFreezer.ApdbConfigFreezer.update | ( | self, | |
| _Config | config, | ||
| str | json_str ) |
Update configuration field values from a JSON string.
Parameters
----------
config : `ApdbConfig`
Configuration object.
json_str : str
String containing JSON representation of configuration.
Returns
-------
updated : `ApdbConfig`
Copy of the ``config`` with some fields updated from JSON object.
Raises
------
TypeError
Raised if JSON string does not represent JSON object.
ValueError
Raised if JSON object contains key which is not present in
``field_names``.
Definition at line 65 of file apdbConfigFreezer.py.
65 def update(self, config: _Config, json_str: str) -> _Config:
66 """Update configuration field values from a JSON string.
67
68 Parameters
69 ----------
70 config : `ApdbConfig`
71 Configuration object.
72 json_str : str
73 String containing JSON representation of configuration.
74
75 Returns
76 -------
77 updated : `ApdbConfig`
78 Copy of the ``config`` with some fields updated from JSON object.
79
80 Raises
81 ------
82 TypeError
83 Raised if JSON string does not represent JSON object.
84 ValueError
85 Raised if JSON object contains key which is not present in
86 ``field_names``.
87 """
88 data = json.loads(json_str)
89 if not isinstance(data, dict):
90 raise TypeError(f"JSON string must be convertible to object: {json_str!r}")
91
92 new_config = type(config)(**config.toDict())
93 for key, value in data.items():
94 if key not in self._field_names:
95 raise ValueError(f"JSON object contains unknown key: {key}")
96 setattr(new_config, key, value)
97
98 return new_config
Member Data Documentation
◆ _field_names
|
protected |
Definition at line 46 of file apdbConfigFreezer.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/dax_apdb/g88963caddf+0cb8e002cc/python/lsst/dax/apdb/apdbConfigFreezer.py
