Coverage for python/lsst/daf/butler/core/_butlerUri/packageresource.py: 100%

Shortcuts on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

11 statements  

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/>. 

21 

22import pkg_resources 

23import logging 

24 

25__all__ = ('ButlerPackageResourceURI',) 

26 

27from ._butlerUri import ButlerURI 

28 

29log = logging.getLogger(__name__) 

30 

31 

32class ButlerPackageResourceURI(ButlerURI): 

33 """URI referring to a Python package resource. 

34 

35 These URIs look like: ``resource://lsst.daf.butler/configs/file.yaml`` 

36 where the network location is the Python package and the path is the 

37 resource name. 

38 """ 

39 

40 def exists(self) -> bool: 

41 """Check that the python resource exists.""" 

42 return pkg_resources.resource_exists(self.netloc, self.relativeToPathRoot) 

43 

44 def read(self, size: int = -1) -> bytes: 

45 """Read the contents of the resource.""" 

46 with pkg_resources.resource_stream(self.netloc, self.relativeToPathRoot) as fh: 

47 return fh.read(size)