Coverage for python/lsst/daf/butler/tests/dict_convertible_model.py: 88%
14 statements
« prev ^ index » next coverage.py v7.5.0, created at 2024-05-03 02:48 -0700
« prev ^ index » next coverage.py v7.5.0, created at 2024-05-03 02:48 -0700
1# This file is part of daf_butler.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (http://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This software is dual licensed under the GNU General Public License and also
10# under a 3-clause BSD license. Recipients may choose which of these licenses
11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
12# respectively. If you choose the GPL option then the following text applies
13# (but note that there is still no warranty even if you opt for BSD instead):
14#
15# This program is free software: you can redistribute it and/or modify
16# it under the terms of the GNU General Public License as published by
17# the Free Software Foundation, either version 3 of the License, or
18# (at your option) any later version.
19#
20# This program is distributed in the hope that it will be useful,
21# but WITHOUT ANY WARRANTY; without even the implied warranty of
22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23# GNU General Public License for more details.
24#
25# You should have received a copy of the GNU General Public License
26# along with this program. If not, see <http://www.gnu.org/licenses/>.
28from __future__ import annotations
30__all__ = ()
32from collections.abc import Mapping
34from pydantic import BaseModel, Field
37class DictConvertibleModel(BaseModel):
38 """A Pydantic model to/from dict conversion in which the `dict`
39 representation is intentionally different from Pydantic's own `dict`
40 conversions.
41 """
43 content: dict[str, float | str] = Field(default_factory=dict)
44 """Content of the logical dict that this object converts to (`dict`).
45 """
47 extra: str = Field(default="")
48 """Extra content that is not included in the dict representation (`str`).
49 """
51 @classmethod
52 def from_dict(cls, content: Mapping[str, str], extra: str = "from_dict") -> DictConvertibleModel:
53 """Construct an instance from a `dict`.
55 Parameters
56 ----------
57 content : `~collections.abc.Mapping`
58 Content of the logical dict that this object converts to.
59 extra : `str`, optional
60 Extra content that is not included in the dict representation.
62 Returns
63 -------
64 model : `DictConvertibleModel`
65 New model.
66 """
67 return cls(content=dict(content), extra=extra)
69 def to_dict(self) -> dict[str, float | str]:
70 """Convert the model to a dictionary.
72 Returns
73 -------
74 content : `dict`
75 Copy of ``self.content``.
76 """
77 return self.content.copy()