Coverage for python/lsst/dax/apdb/factory.py: 15%
27 statements
« prev ^ index » next coverage.py v7.5.0, created at 2024-05-02 03:30 -0700
« prev ^ index » next coverage.py v7.5.0, created at 2024-05-02 03:30 -0700
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/>.
22from __future__ import annotations
24__all__ = ["apdb_type", "make_apdb"]
26from typing import TYPE_CHECKING
28if TYPE_CHECKING:
29 from .apdb import Apdb, ApdbConfig
30 from .apdbReplica import ApdbReplica
31 from .cassandra import ApdbCassandra
32 from .sql import ApdbSql
35def apdb_type(config: ApdbConfig) -> type[ApdbSql | ApdbCassandra]:
36 """Return Apdb type on Apdb configuration.
38 Parameters
39 ----------
40 config : `ApdbConfig`
41 Configuration object, sub-class of ApdbConfig.
43 Returns
44 -------
45 type : `type` [`Apdb`]
46 Subclass of `Apdb` class.
48 Raises
49 ------
50 TypeError
51 Raised if type of ``config`` does not match any known types.
52 """
53 from .cassandra import ApdbCassandra, ApdbCassandraConfig
54 from .sql import ApdbSql, ApdbSqlConfig
56 if type(config) is ApdbSqlConfig:
57 return ApdbSql
58 elif type(config) is ApdbCassandraConfig:
59 return ApdbCassandra
60 raise TypeError(f"Unknown type of config object: {type(config)}")
63def make_apdb(config: ApdbConfig) -> Apdb:
64 """Create Apdb instance based on Apdb configuration.
66 Parameters
67 ----------
68 config : `ApdbConfig`
69 Configuration object, sub-class of ApdbConfig.
71 Returns
72 -------
73 apdb : `Apdb`
74 Instance of a specific Apdb sub-class.
76 Raises
77 ------
78 TypeError
79 Raised if type of ``config`` does not match any known types.
80 """
81 from .cassandra import ApdbCassandra, ApdbCassandraConfig
82 from .sql import ApdbSql, ApdbSqlConfig
84 if type(config) is ApdbSqlConfig:
85 return ApdbSql(config)
86 elif type(config) is ApdbCassandraConfig:
87 return ApdbCassandra(config)
88 raise TypeError(f"Unknown type of config object: {type(config)}")
91def make_apdb_replica(config: ApdbConfig) -> ApdbReplica:
92 """Create ApdbReplica instance based on Apdb configuration.
94 Parameters
95 ----------
96 config : `ApdbConfig`
97 Configuration object, sub-class of ApdbConfig.
99 Returns
100 -------
101 apdb_replica : `ApdbReplica`
102 Instance of a specific ApdbReplica sub-class.
104 Raises
105 ------
106 TypeError
107 Raised if type of ``config`` does not match any known types.
108 """
109 from .cassandra import ApdbCassandra, ApdbCassandraConfig
110 from .sql import ApdbSql, ApdbSqlConfig
112 if type(config) is ApdbSqlConfig:
113 return ApdbSql(config).get_replica()
114 elif type(config) is ApdbCassandraConfig:
115 return ApdbCassandra(config).get_replica()
116 raise TypeError(f"Unknown type of config object: {type(config)}")