comparison planemo/lib/python3.7/site-packages/importlib_metadata/docs/changelog.rst @ 1:56ad4e20f292 draft

"planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1"
author guerler
date Fri, 31 Jul 2020 00:32:28 -0400
parents
children
comparison
equal deleted inserted replaced
0:d30785e31577 1:56ad4e20f292
1 =========================
2 importlib_metadata NEWS
3 =========================
4
5 v1.7.0
6 ======
7
8 * ``PathNotFoundError`` now has a custom ``__str__``
9 mentioning "package metadata" being missing to help
10 guide users to the cause when the package is installed
11 but no metadata is present. Closes #124.
12
13 v1.6.1
14 ======
15
16 * Added ``Distribution._local()`` as a provisional
17 demonstration of how to load metadata for a local
18 package. Implicitly requires that
19 `pep517 <https://pypi.org/project/pep517>`_ is
20 installed. Ref #42.
21 * Ensure inputs to FastPath are Unicode. Closes #121.
22 * Tests now rely on ``importlib.resources.files`` (and
23 backport) instead of the older ``path`` function.
24 * Support any iterable from ``find_distributions``.
25 Closes #122.
26
27 v1.6.0
28 ======
29
30 * Added ``module`` and ``attr`` attributes to ``EntryPoint``
31
32 v1.5.2
33 ======
34
35 * Fix redundant entries from ``FastPath.zip_children``.
36 Closes #117.
37
38 v1.5.1
39 ======
40
41 * Improve reliability and consistency of compatibility
42 imports for contextlib and pathlib when running tests.
43 Closes #116.
44
45 v1.5.0
46 ======
47
48 * Additional performance optimizations in FastPath now
49 saves an additional 20% on a typical call.
50 * Correct for issue where PyOxidizer finder has no
51 ``__module__`` attribute. Closes #110.
52
53 v1.4.0
54 ======
55
56 * Through careful optimization, ``distribution()`` is
57 3-4x faster. Thanks to Antony Lee for the
58 contribution. Closes #95.
59
60 * When searching through ``sys.path``, if any error
61 occurs attempting to list a path entry, that entry
62 is skipped, making the system much more lenient
63 to errors. Closes #94.
64
65 v1.3.0
66 ======
67
68 * Improve custom finders documentation. Closes #105.
69
70 v1.2.0
71 ======
72
73 * Once again, drop support for Python 3.4. Ref #104.
74
75 v1.1.3
76 ======
77
78 * Restored support for Python 3.4 due to improper version
79 compatibility declarations in the v1.1.0 and v1.1.1
80 releases. Closes #104.
81
82 v1.1.2
83 ======
84
85 * Repaired project metadata to correctly declare the
86 ``python_requires`` directive. Closes #103.
87
88 v1.1.1
89 ======
90
91 * Fixed ``repr(EntryPoint)`` on PyPy 3 also. Closes #102.
92
93 v1.1.0
94 ======
95
96 * Dropped support for Python 3.4.
97 * EntryPoints are now pickleable. Closes #96.
98 * Fixed ``repr(EntryPoint)`` on PyPy 2. Closes #97.
99
100 v1.0.0
101 ======
102
103 * Project adopts semver for versioning.
104
105 * Removed compatibility shim introduced in 0.23.
106
107 * For better compatibility with the stdlib implementation and to
108 avoid the same distributions being discovered by the stdlib and
109 backport implementations, the backport now disables the
110 stdlib DistributionFinder during initialization (import time).
111 Closes #91 and closes #100.
112
113 0.23
114 ====
115 * Added a compatibility shim to prevent failures on beta releases
116 of Python before the signature changed to accept the
117 "context" parameter on find_distributions. This workaround
118 will have a limited lifespan, not to extend beyond release of
119 Python 3.8 final.
120
121 0.22
122 ====
123 * Renamed ``package`` parameter to ``distribution_name``
124 as `recommended <https://bugs.python.org/issue34632#msg349423>`_
125 in the following functions: ``distribution``, ``metadata``,
126 ``version``, ``files``, and ``requires``. This
127 backward-incompatible change is expected to have little impact
128 as these functions are assumed to be primarily used with
129 positional parameters.
130
131 0.21
132 ====
133 * ``importlib.metadata`` now exposes the ``DistributionFinder``
134 metaclass and references it in the docs for extending the
135 search algorithm.
136 * Add ``Distribution.at`` for constructing a Distribution object
137 from a known metadata directory on the file system. Closes #80.
138 * Distribution finders now receive a context object that
139 supplies ``.path`` and ``.name`` properties. This change
140 introduces a fundamental backward incompatibility for
141 any projects implementing a ``find_distributions`` method
142 on a ``MetaPathFinder``. This new layer of abstraction
143 allows this context to be supplied directly or constructed
144 on demand and opens the opportunity for a
145 ``find_distributions`` method to solicit additional
146 context from the caller. Closes #85.
147
148 0.20
149 ====
150 * Clarify in the docs that calls to ``.files`` could return
151 ``None`` when the metadata is not present. Closes #69.
152 * Return all requirements and not just the first for dist-info
153 packages. Closes #67.
154
155 0.19
156 ====
157 * Restrain over-eager egg metadata resolution.
158 * Add support for entry points with colons in the name. Closes #75.
159
160 0.18
161 ====
162 * Parse entry points case sensitively. Closes #68
163 * Add a version constraint on the backport configparser package. Closes #66
164
165 0.17
166 ====
167 * Fix a permission problem in the tests on Windows.
168
169 0.16
170 ====
171 * Don't crash if there exists an EGG-INFO directory on sys.path.
172
173 0.15
174 ====
175 * Fix documentation.
176
177 0.14
178 ====
179 * Removed ``local_distribution`` function from the API.
180 **This backward-incompatible change removes this
181 behavior summarily**. Projects should remove their
182 reliance on this behavior. A replacement behavior is
183 under review in the `pep517 project
184 <https://github.com/pypa/pep517>`_. Closes #42.
185
186 0.13
187 ====
188 * Update docstrings to match PEP 8. Closes #63.
189 * Merged modules into one module. Closes #62.
190
191 0.12
192 ====
193 * Add support for eggs. !65; Closes #19.
194
195 0.11
196 ====
197 * Support generic zip files (not just wheels). Closes #59
198 * Support zip files with multiple distributions in them. Closes #60
199 * Fully expose the public API in ``importlib_metadata.__all__``.
200
201 0.10
202 ====
203 * The ``Distribution`` ABC is now officially part of the public API.
204 Closes #37.
205 * Fixed support for older single file egg-info formats. Closes #43.
206 * Fixed a testing bug when ``$CWD`` has spaces in the path. Closes #50.
207 * Add Python 3.8 to the ``tox`` testing matrix.
208
209 0.9
210 ===
211 * Fixed issue where entry points without an attribute would raise an
212 Exception. Closes #40.
213 * Removed unused ``name`` parameter from ``entry_points()``. Closes #44.
214 * ``DistributionFinder`` classes must now be instantiated before
215 being placed on ``sys.meta_path``.
216
217 0.8
218 ===
219 * This library can now discover/enumerate all installed packages. **This
220 backward-incompatible change alters the protocol finders must
221 implement to support distribution package discovery.** Closes #24.
222 * The signature of ``find_distributions()`` on custom installer finders
223 should now accept two parameters, ``name`` and ``path`` and
224 these parameters must supply defaults.
225 * The ``entry_points()`` method no longer accepts a package name
226 but instead returns all entry points in a dictionary keyed by the
227 ``EntryPoint.group``. The ``resolve`` method has been removed. Instead,
228 call ``EntryPoint.load()``, which has the same semantics as
229 ``pkg_resources`` and ``entrypoints``. **This is a backward incompatible
230 change.**
231 * Metadata is now always returned as Unicode text regardless of
232 Python version. Closes #29.
233 * This library can now discover metadata for a 'local' package (found
234 in the current-working directory). Closes #27.
235 * Added ``files()`` function for resolving files from a distribution.
236 * Added a new ``requires()`` function, which returns the requirements
237 for a package suitable for parsing by
238 ``packaging.requirements.Requirement``. Closes #18.
239 * The top-level ``read_text()`` function has been removed. Use
240 ``PackagePath.read_text()`` on instances returned by the ``files()``
241 function. **This is a backward incompatible change.**
242 * Release dates are now automatically injected into the changelog
243 based on SCM tags.
244
245 0.7
246 ===
247 * Fixed issue where packages with dashes in their names would
248 not be discovered. Closes #21.
249 * Distribution lookup is now case-insensitive. Closes #20.
250 * Wheel distributions can no longer be discovered by their module
251 name. Like Path distributions, they must be indicated by their
252 distribution package name.
253
254 0.6
255 ===
256 * Removed ``importlib_metadata.distribution`` function. Now
257 the public interface is primarily the utility functions exposed
258 in ``importlib_metadata.__all__``. Closes #14.
259 * Added two new utility functions ``read_text`` and
260 ``metadata``.
261
262 0.5
263 ===
264 * Updated README and removed details about Distribution
265 class, now considered private. Closes #15.
266 * Added test suite support for Python 3.4+.
267 * Fixed SyntaxErrors on Python 3.4 and 3.5. !12
268 * Fixed errors on Windows joining Path elements. !15
269
270 0.4
271 ===
272 * Housekeeping.
273
274 0.3
275 ===
276 * Added usage documentation. Closes #8
277 * Add support for getting metadata from wheels on ``sys.path``. Closes #9
278
279 0.2
280 ===
281 * Added ``importlib_metadata.entry_points()``. Closes #1
282 * Added ``importlib_metadata.resolve()``. Closes #12
283 * Add support for Python 2.7. Closes #4
284
285 0.1
286 ===
287 * Initial release.
288
289
290 ..
291 Local Variables:
292 mode: change-log-mode
293 indent-tabs-mode: nil
294 sentence-end-double-space: t
295 fill-column: 78
296 coding: utf-8
297 End: