Coverage for python/lsst/dax/apdb/factory.py: 19%
19 statements
« prev ^ index » next coverage.py v7.4.4, created at 2024-04-06 04:04 -0700
« prev ^ index » next coverage.py v7.4.4, created at 2024-04-06 04:04 -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 .apdbCassandra import ApdbCassandra
31 from .apdbSql import ApdbSql
34def apdb_type(config: ApdbConfig) -> type[ApdbSql | ApdbCassandra]:
35 """Return Apdb type on Apdb configuration.
37 Parameters
38 ----------
39 config : `ApdbConfig`
40 Configuration object, sub-class of ApdbConfig.
42 Returns
43 -------
44 type : `type` [`Apdb`]
45 Subclass of `Apdb` class.
47 Raises
48 ------
49 TypeError
50 Raised if type of ``config`` does not match any known types.
51 """
52 from .apdbCassandra import ApdbCassandra, ApdbCassandraConfig
53 from .apdbSql import ApdbSql, ApdbSqlConfig
55 if type(config) is ApdbSqlConfig:
56 return ApdbSql
57 elif type(config) is ApdbCassandraConfig:
58 return ApdbCassandra
59 raise TypeError(f"Unknown type of config object: {type(config)}")
62def make_apdb(config: ApdbConfig) -> Apdb:
63 """Create Apdb instance based on Apdb configuration.
65 Parameters
66 ----------
67 config : `ApdbConfig`
68 Configuration object, sub-class of ApdbConfig.
70 Returns
71 -------
72 apdb : `Apdb`
73 Instance of a specific Apdb sub-class.
75 Raises
76 ------
77 TypeError
78 Raised if type of ``config`` does not match any known types.
79 """
80 from .apdbCassandra import ApdbCassandra, ApdbCassandraConfig
81 from .apdbSql import ApdbSql, ApdbSqlConfig
83 if type(config) is ApdbSqlConfig:
84 return ApdbSql(config)
85 elif type(config) is ApdbCassandraConfig:
86 return ApdbCassandra(config)
87 raise TypeError(f"Unknown type of config object: {type(config)}")