Skip to content

Commit 7725ac5

Browse files
committed
Implement abstract method on ResourceHandle and add docstrings
1 parent d8d7736 commit 7725ac5

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

importlib_resources/abc.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,10 @@ def contents(self):
171171

172172

173173
class ResourceHandle(Traversable):
174+
"""
175+
Handle to a named resource in a ResourceReader.
176+
"""
177+
174178
def __init__(self, reader, name):
175179
self.reader = reader
176180
self.name = name
@@ -187,8 +191,15 @@ def open(self, mode='r', *args, **kwargs):
187191
stream = io.TextIOWrapper(*args, **kwargs)
188192
return stream
189193

194+
def joinpath(self, name):
195+
raise RuntimeError("Cannot traverse into a resource")
196+
190197

191198
class ResourceContainer(Traversable):
199+
"""
200+
Traversable container for a package's resources via its reader.
201+
"""
202+
192203
def __init__(self, reader: SimpleReader):
193204
self.reader = reader
194205

0 commit comments

Comments
 (0)