1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
|
# (C) Copyright 2007-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
""" A resource protocol for package resources. """
# Standard library imports.
try:
from importlib.resources import files
except ImportError:
from importlib_resources import files
# Enthought library imports.
from traits.api import HasTraits, provides
# Local imports.
from .i_resource_protocol import IResourceProtocol
from .no_such_resource_error import NoSuchResourceError
@provides(IResourceProtocol)
class PackageResourceProtocol(HasTraits):
"""A resource protocol for package resources.
This protocol uses 'importlib.resources' to find and access resources.
An address for this protocol is a string in the form::
'package/resource'
e.g::
'acme.ui.workbench/preferences.ini'
"""
###########################################################################
# 'IResourceProtocol' interface.
###########################################################################
def file(self, address):
"""Return a readable file-like object for the specified address."""
package, *resource_path = address.split("/")
if not package or not resource_path:
raise NoSuchResourceError(address)
try:
f = files(package).joinpath(*resource_path).open("rb")
except (
ModuleNotFoundError,
TypeError, # TypeError is raised if package is a module
FileNotFoundError,
IsADirectoryError,
PermissionError,
):
raise NoSuchResourceError(address)
return f
|