Coverage for python/lsst/daf/butler/registry/_config.py: 51%
35 statements
« prev ^ index » next coverage.py v6.4.1, created at 2022-06-23 02:27 -0700
« prev ^ index » next coverage.py v6.4.1, created at 2022-06-23 02:27 -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 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__ = ("RegistryConfig",)
26from typing import TYPE_CHECKING, Optional, Type
28from lsst.utils import doImportType
30from ..core import ConfigSubset
31from ..core.repoRelocation import replaceRoot
32from .connectionString import ConnectionStringFactory
33from .interfaces import Database
35if TYPE_CHECKING: 35 ↛ 36line 35 didn't jump to line 36, because the condition on line 35 was never true
36 import sqlalchemy
37 from lsst.resources import ResourcePathExpression
40class RegistryConfig(ConfigSubset):
41 component = "registry"
42 requiredKeys = ("db",)
43 defaultConfigFile = "registry.yaml"
45 def getDialect(self) -> str:
46 """Parses the `db` key of the config and returns the database dialect.
48 Returns
49 -------
50 dialect : `str`
51 Dialect found in the connection string.
52 """
53 conStr = ConnectionStringFactory.fromConfig(self)
54 return conStr.get_backend_name()
56 def getDatabaseClass(self) -> Type[Database]:
57 """Returns the `Database` class targeted by configuration values.
59 The appropriate class is determined by parsing the `db` key to extract
60 the dialect, and then looking that up under the `engines` key of the
61 registry config.
62 """
63 dialect = self.getDialect()
64 if dialect not in self["engines"]:
65 raise ValueError(f"Connection string dialect has no known aliases. Received: {dialect}")
66 databaseClassName = self["engines", dialect]
67 databaseClass = doImportType(databaseClassName)
68 if not issubclass(databaseClass, Database):
69 raise TypeError(f"Imported database class {databaseClassName} is not a Database")
70 return databaseClass
72 def makeDefaultDatabaseUri(self, root: str) -> Optional[str]:
73 """Return a default 'db' URI for the registry configured here that is
74 appropriate for a new empty repository with the given root.
76 Parameters
77 ----------
78 root : `str`
79 Filesystem path to the root of the data repository.
81 Returns
82 -------
83 uri : `str`
84 URI usable as the 'db' string in a `RegistryConfig`.
85 """
86 DatabaseClass = self.getDatabaseClass()
87 return DatabaseClass.makeDefaultUri(root)
89 def replaceRoot(self, root: Optional[ResourcePathExpression]) -> None:
90 """Replace any occurrences of `BUTLER_ROOT_TAG` in the connection
91 with the given root directory.
93 Parameters
94 ----------
95 root : `lsst.resources.ResourcePathExpression`, or `None`
96 String to substitute for `BUTLER_ROOT_TAG`. Passing `None` here is
97 allowed only as a convenient way to raise an exception
98 (`ValueError`).
100 Raises
101 ------
102 ValueError
103 Raised if ``root`` is not set but a value is required.
104 """
105 self["db"] = replaceRoot(self["db"], root)
107 @property
108 def connectionString(self) -> sqlalchemy.engine.url.URL:
109 """Return the connection string to the underlying database
110 (`sqlalchemy.engine.url.URL`).
111 """
112 return ConnectionStringFactory.fromConfig(self)