Coverage for python/lsst/daf/butler/_butler_instance_options.py: 100%
10 statements
« prev ^ index » next coverage.py v7.4.4, created at 2024-04-19 03:43 -0700
« prev ^ index » next coverage.py v7.4.4, created at 2024-04-19 03:43 -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 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/>.
28__all__ = ("ButlerInstanceOptions",)
30import dataclasses
31from typing import Any
34@dataclasses.dataclass(frozen=True)
35class ButlerInstanceOptions:
36 """The parameters passed to `Butler.from_config` or the Butler convenience
37 constructor. These configure defaults and other settings for a Butler
38 instance. These settings are common to all Butler subclasses. See `Butler`
39 for the documentation of these properties.
40 """
42 collections: Any = None
43 run: str | None = None
44 writeable: bool | None = None
45 inferDefaults: bool = True
46 kwargs: dict[str, Any] = dataclasses.field(default_factory=dict)