Coverage for python/lsst/daf/butler/tests/dict_convertible_model.py: 88%

15 statements  

« prev     ^ index     » next       coverage.py v7.3.2, created at 2023-12-06 10:53 +0000

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/>. 

27 

28from __future__ import annotations 

29 

30__all__ = () 

31 

32from collections.abc import Mapping 

33 

34from lsst.daf.butler._compat import _BaseModelCompat 

35from pydantic import Field 

36 

37 

38class DictConvertibleModel(_BaseModelCompat): 

39 """A pydantic model to/from dict conversion in which the dict 

40 representation is intentionally different from pydantics' own dict 

41 conversions. 

42 """ 

43 

44 content: dict[str, str] = Field(default_factory=dict) 

45 """Content of the logical dict that this object converts to (`dict`). 

46 """ 

47 

48 extra: str = Field(default="") 

49 """Extra content that is not included in the dict representation (`str`). 

50 """ 

51 

52 @classmethod 

53 def from_dict(cls, content: Mapping[str, str], extra: str = "from_dict") -> DictConvertibleModel: 

54 """Construct an instance from a `dict`. 

55 

56 Parameters 

57 ---------- 

58 content : `~collections.abc.Mapping` 

59 Content of the logical dict that this object converts to. 

60 extra : `str`, optional 

61 Extra content that is not included in the dict representation 

62 

63 Returns 

64 ------- 

65 model : `DictConvertibleModel` 

66 New model. 

67 """ 

68 return cls(content=dict(content), extra=extra) 

69 

70 def to_dict(self) -> dict[str, str]: 

71 """Convert the model to a dictionary. 

72 

73 Returns 

74 ------- 

75 content : `dict` 

76 Copy of ``self.content``. 

77 """ 

78 return self.content.copy()