Coverage for python/lsst/daf/butler/_utilities/locked_object.py: 65%
13 statements
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-30 02:53 -0700
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-30 02:53 -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/>.
28from collections.abc import Iterator
29from contextlib import contextmanager
30from threading import Lock
31from typing import Generic, TypeVar
33_T = TypeVar("_T")
36class LockedObject(Generic[_T]):
37 """Wraps an object to enforce that all accesses to the object are performed
38 while holding a mutex lock.
40 Parameters
41 ----------
42 obj : `object`
43 The object that will be returned from the ``access()`` method.
44 """
46 def __init__(self, obj: _T):
47 self._lock = Lock()
48 self._obj = obj
50 @contextmanager
51 def access(self) -> Iterator[_T]:
52 with self._lock:
53 yield self._obj