Skip to content

Commit 67abc60

Browse files
committed
Rename 'get' to 'files' and no longer solicit a resource.
1 parent e9c7e19 commit 67abc60

File tree

3 files changed

+23
-10
lines changed

3 files changed

+23
-10
lines changed

importlib_resources/_py2.py

+3-5
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,8 @@ def read_text(package, resource, encoding='utf-8', errors='strict'):
9393
return fp.read()
9494

9595

96-
def get(package, resource):
97-
resource = _normalize_path(resource)
98-
package = _get_package(package)
99-
return trees.from_package(package) / resource
96+
def files(package):
97+
return trees.from_package(_get_package(package))
10098

10199

102100
def path(package, resource):
@@ -108,7 +106,7 @@ def path(package, resource):
108106
raised if the file was deleted prior to the context manager
109107
exiting).
110108
"""
111-
path = get(package, resource)
109+
path = files(package).joinpath(_normalize_path(resource))
112110
if not path.is_file():
113111
raise FileNotFoundError(path)
114112
return trees.as_file(path)

importlib_resources/_py3.py

+3-5
Original file line numberDiff line numberDiff line change
@@ -131,13 +131,11 @@ def read_text(package: Package,
131131
return fp.read()
132132

133133

134-
def get(package: Package, resource: Resource) -> trees.Traversable:
134+
def files(package: Package) -> trees.Traversable:
135135
"""
136136
Get a Traversable resource from a package
137137
"""
138-
resource = _normalize_path(resource)
139-
package = _get_package(package)
140-
return trees.from_package(package) / resource
138+
return trees.from_package(_get_package(package))
141139

142140

143141
def path(
@@ -155,7 +153,7 @@ def path(
155153
return (
156154
_path_from_reader(reader, resource)
157155
if reader else
158-
trees.as_file(get(package, resource))
156+
trees.as_file(files(package).joinpath(_normalize_path(resource)))
159157
)
160158

161159

importlib_resources/trees.py

+17
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@
99

1010

1111
class Traversable(ABC):
12+
"""
13+
An object with a subset of pathlib.Path methods suitable for
14+
traversing directories and opening files.
15+
"""
16+
1217
@abc.abstractmethod
1318
def iterdir(self):
1419
"""
@@ -39,6 +44,18 @@ def is_file(self):
3944
Return True if self is a file
4045
"""
4146

47+
@abc.abstractmethod
48+
def joinpath(self, child):
49+
"""
50+
Return Traversable child in self
51+
"""
52+
53+
@abc.abstractmethod
54+
def __truediv__(self, child):
55+
"""
56+
Return Traversable child in self
57+
"""
58+
4259

4360
def from_package(package):
4461
"""Return a Traversable object for the given package"""

0 commit comments

Comments
 (0)