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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
From: Eli Schwartz <eschwartz93@gmail.com>
Date: Sun, 15 Sep 2024 21:25:34 -0400
Subject: migrate entrypoints handling to standard library importlib.metadata
We wrap a couple different versions of the stdlib interface, and fall
back to pkg_resources for compatibility with existing use cases on very
old versions of python.
For python 3.8 and on, we make sure to completely avoid external
dependencies, even backports.
Bug: https://github.com/PyFilesystem/pyfilesystem2/issues/577
Origin: upstream, https://github.com/PyFilesystem/pyfilesystem2/pull/589
---
fs/opener/registry.py | 38 +++++++++++++++++++-------
tests/test_opener.py | 74 ++++++++++++++++++++++++++++++++++++++++-----------
2 files changed, 87 insertions(+), 25 deletions(-)
diff --git a/fs/opener/registry.py b/fs/opener/registry.py
index 1954723..16f4041 100644
--- a/fs/opener/registry.py
+++ b/fs/opener/registry.py
@@ -8,7 +8,7 @@ import typing
import collections
import contextlib
-import pkg_resources
+import sys
from ..errors import ResourceReadOnly
from .base import Opener
@@ -21,6 +21,30 @@ if typing.TYPE_CHECKING:
from ..base import FS
+if sys.version_info >= (3, 8):
+ import importlib.metadata
+
+ if sys.version_info >= (3, 10):
+
+ def entrypoints(group, name=None):
+ ep = importlib.metadata.entry_points(group=group, name=name)
+ return tuple(n for n in ep)
+
+ else:
+
+ def entrypoints(group, name=None):
+ ep = importlib.metadata.entry_points()
+ if name:
+ return tuple(n for n in ep.get(group, ()) if n.name == name)
+ return ep.get(group, ())
+
+else:
+ import pkg_resources
+
+ def entrypoints(group, name=None):
+ return tuple(pkg_resources.iter_entry_points(group, name))
+
+
class Registry(object):
"""A registry for `Opener` instances."""
@@ -74,10 +98,7 @@ class Registry(object):
"""`list`: the list of supported protocols."""
_protocols = list(self._protocols)
if self.load_extern:
- _protocols.extend(
- entry_point.name
- for entry_point in pkg_resources.iter_entry_points("fs.opener")
- )
+ _protocols.extend(n.name for n in entrypoints("fs.opener"))
_protocols = list(collections.OrderedDict.fromkeys(_protocols))
return _protocols
@@ -101,10 +122,9 @@ class Registry(object):
"""
protocol = protocol or self.default_opener
- if self.load_extern:
- entry_point = next(
- pkg_resources.iter_entry_points("fs.opener", protocol), None
- )
+ ep = entrypoints("fs.opener", protocol)
+ if self.load_extern and ep:
+ entry_point = ep[0]
else:
entry_point = None
diff --git a/tests/test_opener.py b/tests/test_opener.py
index 910f578..f3bb2b6 100644
--- a/tests/test_opener.py
+++ b/tests/test_opener.py
@@ -3,7 +3,6 @@ from __future__ import unicode_literals
import sys
import os
-import pkg_resources
import shutil
import tempfile
import unittest
@@ -21,6 +20,11 @@ try:
except ImportError:
import mock
+if sys.version_info >= (3, 8):
+ import importlib.metadata
+else:
+ import pkg_resources
+
class TestParse(unittest.TestCase):
def test_registry_repr(self):
@@ -111,14 +115,25 @@ class TestRegistry(unittest.TestCase):
def test_registry_protocols(self):
# Check registry.protocols list the names of all available extension
- extensions = [
- pkg_resources.EntryPoint("proto1", "mod1"),
- pkg_resources.EntryPoint("proto2", "mod2"),
- ]
- m = mock.MagicMock(return_value=extensions)
- with mock.patch.object(
- sys.modules["pkg_resources"], "iter_entry_points", new=m
- ):
+ if sys.version_info >= (3, 8):
+ extensions = (
+ importlib.metadata.EntryPoint("proto1", "mod1", "fs.opener"),
+ importlib.metadata.EntryPoint("proto2", "mod2", "fs.opener"),
+ )
+ if sys.version_info >= (3, 10):
+ m = mock.MagicMock(return_value=extensions)
+ else:
+ m = mock.MagicMock(return_value={"fs.opener": extensions})
+ patch = mock.patch("importlib.metadata.entry_points", m)
+ else:
+ extensions = [
+ pkg_resources.EntryPoint("proto1", "mod1"),
+ pkg_resources.EntryPoint("proto2", "mod2"),
+ ]
+ m = mock.MagicMock(return_value=extensions)
+ patch = mock.patch("pkg_resources.iter_entry_points", m)
+
+ with patch:
self.assertIn("proto1", opener.registry.protocols)
self.assertIn("proto2", opener.registry.protocols)
@@ -129,11 +144,19 @@ class TestRegistry(unittest.TestCase):
def test_entry_point_load_error(self):
entry_point = mock.MagicMock()
+ entry_point.name = "test"
entry_point.load.side_effect = ValueError("some error")
- iter_entry_points = mock.MagicMock(return_value=iter([entry_point]))
-
- with mock.patch("pkg_resources.iter_entry_points", iter_entry_points):
+ if sys.version_info >= (3, 8):
+ if sys.version_info >= (3, 10):
+ entry_points = mock.MagicMock(return_value=tuple([entry_point]))
+ else:
+ entry_points = mock.MagicMock(return_value={"fs.opener": [entry_point]})
+ patch = mock.patch("importlib.metadata.entry_points", entry_points)
+ else:
+ iter_entry_points = mock.MagicMock(return_value=iter([entry_point]))
+ patch = mock.patch("pkg_resources.iter_entry_points", iter_entry_points)
+ with patch:
with self.assertRaises(errors.EntryPointError) as ctx:
opener.open_fs("test://")
self.assertEqual(
@@ -145,10 +168,19 @@ class TestRegistry(unittest.TestCase):
pass
entry_point = mock.MagicMock()
+ entry_point.name = "test"
entry_point.load = mock.MagicMock(return_value=NotAnOpener)
- iter_entry_points = mock.MagicMock(return_value=iter([entry_point]))
- with mock.patch("pkg_resources.iter_entry_points", iter_entry_points):
+ if sys.version_info >= (3, 8):
+ if sys.version_info >= (3, 10):
+ entry_points = mock.MagicMock(return_value=tuple([entry_point]))
+ else:
+ entry_points = mock.MagicMock(return_value={"fs.opener": [entry_point]})
+ patch = mock.patch("importlib.metadata.entry_points", entry_points)
+ else:
+ iter_entry_points = mock.MagicMock(return_value=iter([entry_point]))
+ patch = mock.patch("pkg_resources.iter_entry_points", iter_entry_points)
+ with patch:
with self.assertRaises(errors.EntryPointError) as ctx:
opener.open_fs("test://")
self.assertEqual("entry point did not return an opener", str(ctx.exception))
@@ -162,10 +194,20 @@ class TestRegistry(unittest.TestCase):
pass
entry_point = mock.MagicMock()
+ entry_point.name = "test"
entry_point.load = mock.MagicMock(return_value=BadOpener)
- iter_entry_points = mock.MagicMock(return_value=iter([entry_point]))
- with mock.patch("pkg_resources.iter_entry_points", iter_entry_points):
+ if sys.version_info >= (3, 8):
+ if sys.version_info >= (3, 10):
+ entry_points = mock.MagicMock(return_value=tuple([entry_point]))
+ else:
+ entry_points = mock.MagicMock(return_value={"fs.opener": [entry_point]})
+ patch = mock.patch("importlib.metadata.entry_points", entry_points)
+ else:
+ iter_entry_points = mock.MagicMock(return_value=iter([entry_point]))
+ patch = mock.patch("pkg_resources.iter_entry_points", iter_entry_points)
+
+ with patch:
with self.assertRaises(errors.EntryPointError) as ctx:
opener.open_fs("test://")
self.assertEqual(
|
