Coverage for python / lsst / dax / apdb / factory.py: 15%

1# This file is part of dax_apdb. 

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 program is free software: you can redistribute it and/or modify 

10# it under the terms of the GNU General Public License as published by 

11# the Free Software Foundation, either version 3 of the License, or 

12# (at your option) any later version. 

13# 

14# This program is distributed in the hope that it will be useful, 

15# but WITHOUT ANY WARRANTY; without even the implied warranty of 

16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

17# GNU General Public License for more details. 

18# 

19# You should have received a copy of the GNU General Public License 

20# along with this program. If not, see <http://www.gnu.org/licenses/>. 

21 

22from __future__ import annotations 

23 

24__all__ = ["config_type_for_name", "make_apdb"] 

25 

26from typing import TYPE_CHECKING 

27 

28if TYPE_CHECKING: 

29 from .apdb import Apdb 

30 from .apdbReplica import ApdbReplica 

31 from .config import ApdbConfig 

32 

33 

34def make_apdb(config: ApdbConfig) -> Apdb: 

35 """Create Apdb instance based on Apdb configuration. 

36 

37 Parameters 

38 ---------- 

39 config : `ApdbConfig` 

40 Configuration object, sub-class of ApdbConfig. 

41 

42 Returns 

43 ------- 

44 apdb : `Apdb` 

45 Instance of a specific Apdb sub-class. 

46 

47 Raises 

48 ------ 

49 TypeError 

50 Raised if type of ``config`` does not match any known types. 

51 """ 

52 from .cassandra import ApdbCassandra, ApdbCassandraConfig 

53 from .sql import ApdbSql, ApdbSqlConfig 

54 

55 if type(config) is ApdbSqlConfig: 

56 return ApdbSql(config) 

57 elif type(config) is ApdbCassandraConfig: 

58 return ApdbCassandra(config) 

59 raise TypeError(f"Unknown type of config object: {type(config)}") 

60 

61 

62def make_apdb_replica(config: ApdbConfig) -> ApdbReplica: 

63 """Create ApdbReplica instance based on Apdb configuration. 

64 

65 Parameters 

66 ---------- 

67 config : `ApdbConfig` 

68 Configuration object, sub-class of ApdbConfig. 

69 

70 Returns 

71 ------- 

72 apdb_replica : `ApdbReplica` 

73 Instance of a specific ApdbReplica sub-class. 

74 

75 Raises 

76 ------ 

77 TypeError 

78 Raised if type of ``config`` does not match any known types. 

79 """ 

80 from .cassandra import ApdbCassandra, ApdbCassandraConfig 

81 from .sql import ApdbSql, ApdbSqlConfig 

82 

83 if type(config) is ApdbSqlConfig: 

84 return ApdbSql(config).get_replica() 

85 elif type(config) is ApdbCassandraConfig: 

86 return ApdbCassandra(config).get_replica() 

87 raise TypeError(f"Unknown type of config object: {type(config)}") 

88 

89 

90def config_type_for_name(type_name: str) -> type[ApdbConfig]: 

91 """Return ApdbConfig class matching type name. 

92 

93 Parameters 

94 ---------- 

95 type_name : `str` 

96 Short type name of Apdb implementation, for now "sql" and "cassandra" 

97 are supported. 

98 

99 Returns 

100 ------- 

101 type : `type` [`ApdbConfig`] 

102 Subclass of `ApdbConfig` class. 

103 

104 Raises 

105 ------ 

106 TypeError 

107 Raised if ``type_name`` does not match any known types. 

108 """ 

109 if type_name == "sql": 

110 from .sql import ApdbSqlConfig 

111 

112 return ApdbSqlConfig 

113 elif type_name == "cassandra": 

114 from .cassandra import ApdbCassandraConfig 

115 

116 return ApdbCassandraConfig 

117 

118 raise TypeError(f"Unknown Apdb implementation type name: {type_name}")