Replace pkg_resources by importlib.resources #496

hynek · 2023-04-12T10:55:49Z

This trades our dependency on setuptools to a conditional one on the importlib-resources backport package.

Fixes #494

This trades our dependency on setuptools to a conditional one on the importlib-resources backport package. Fixes #494

codecov · 2023-04-12T10:59:03Z

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (70da86f) 99.84% compared to head (516a15d) 99.84%.

❗ Current head 516a15d differs from pull request most recent head f23c5ce. Consider uploading reports for the commit f23c5ce to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##            trunk     #496   +/-   ##
=======================================
  Coverage   99.84%   99.84%           
=======================================
  Files          13       13           
  Lines         631      634    +3     
  Branches      146      147    +1     
=======================================
+ Hits          630      633    +3     
  Partials        1        1

Impacted Files	Coverage Δ
src/towncrier/_settings/load.py	`100.00% <100.00%> (ø)`

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

src/towncrier/test/helpers.py

Co-authored-by: Thomas Grainger <tagrain@gmail.com>

change made

src/towncrier/_settings/load.py

hynek · 2023-04-13T05:11:27Z

I think I've addressed everything; CI will be breaking until someone reviews #497 (or fixes it otherwisely).

hynek · 2023-04-13T10:33:48Z

yay green CI

All done

Bumps [towncrier](https://github.com/twisted/towncrier) from 22.8.0 to 23.6.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/twisted/towncrier/releases">towncrier's releases</a>.</em></p> <blockquote> <h2>Towncrier 23.6.0</h2> <h1>towncrier 23.6.0 (2023-06-06)</h1> <p>This is the last release to support Python 3.7.</p> <h2>Features</h2> <ul> <li> <p>Make <code>towncrier create</code> use the fragment counter rather than failing on existing fragment names.</p> <p>For example, if there is an existing fragment named <code>123.feature</code>, then <code>towncrier create 123.feature</code> will now create a fragment named <code>123.feature.1</code>. (<a href="https://redirect.github.com/twisted/towncrier/issues/475">#475</a>)</p> </li> <li> <p>Provide a default Markdown template if the configured filename ends with <code>.md</code>.</p> <p>The Markdown template uses the same rendered format as the default <em>reStructuredText</em> template, but with a Markdown syntax. (<a href="https://redirect.github.com/twisted/towncrier/issues/483">#483</a>)</p> </li> <li> <p>Towncrier no longer depends on setuptools & uses importlib.resources (or its backport) instead. (<a href="https://redirect.github.com/twisted/towncrier/issues/496">#496</a>)</p> </li> <li> <p>Added pre-commit hooks for checking and updating news in projects using pre-commit. (<a href="https://redirect.github.com/twisted/towncrier/issues/498">#498</a>)</p> </li> <li> <p>Calling <code>towncrier check</code> without an existing configuration, will just show only an error message.</p> <p>In previous versions, a traceback was generated instead of the error message. (<a href="https://redirect.github.com/twisted/towncrier/issues/501">#501</a>)</p> </li> </ul> <h2>Bugfixes</h2> <ul> <li> <p>Fix creating fragment in a section not adding random characters.</p> <p>For example, <code>towncrier create some_section/+.feature</code> should end up as a fragment named something like <code>news/some_section/+a4e22da1.feature</code>. (<a href="https://redirect.github.com/twisted/towncrier/issues/468">#468</a>)</p> </li> <li> <p>Fix the ReadTheDocs build for <code>towncrier</code> which was broken due to the python version in use being 3.8. Upgrade to 3.11. (<a href="https://redirect.github.com/twisted/towncrier/issues/509">#509</a>)</p> </li> </ul> <h2>Improved Documentation</h2> <ul> <li>Moved man page to correct section (<a href="https://redirect.github.com/twisted/towncrier/issues/470">#470</a>)</li> <li>Update link to Quick Start in configuration.html to point to Tutorial instead. (<a href="https://redirect.github.com/twisted/towncrier/issues/504">#504</a>)</li> <li>Add a note about the build command's <code>--version</code> requiring the command to be explicitly passed. (<a href="https://redirect.github.com/twisted/towncrier/issues/511">#511</a>)</li> <li>Fix typos in the Pre-Commit docs. (<a href="https://redirect.github.com/twisted/towncrier/issues/512">#512</a>)</li> </ul> <h2>Misc</h2> <ul> <li><a href="https://redirect.github.com/twisted/towncrier/issues/459">#459</a>, <a href="https://redirect.github.com/twisted/towncrier/issues/462">#462</a>, <a href="https://redirect.github.com/twisted/towncrier/issues/472">#472</a>, <a href="https://redirect.github.com/twisted/towncrier/issues/485">#485</a>, <a href="https://redirect.github.com/twisted/towncrier/issues/486">#486</a>, <a href="https://redirect.github.com/twisted/towncrier/issues/487">#487</a>, <a href="https://redirect.github.com/twisted/towncrier/issues/488">#488</a>, <a href="https://redirect.github.com/twisted/towncrier/issues/495">#495</a>, <a href="https://redirect.github.com/twisted/towncrier/issues/497">#497</a>, <a href="https://redirect.github.com/twisted/towncrier/issues/507">#507</a>, <a href="https://redirect.github.com/twisted/towncrier/issues/1117">#1117</a>, <a href="https://redirect.github.com/twisted/towncrier/issues/513">#513</a></li> </ul> <h2>Towncrier 23.6.0rc1</h2> <h1>towncrier 23.6.0rc1 (2023-06-05)</h1> <p>This is the last release to support Python 3.7.</p> <h2>Features</h2> <ul> <li>Make <code>towncrier create</code> use the fragment counter rather than failing on existing fragment names.</li> </ul>  </blockquote> <p>... (truncated)</p> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/twisted/towncrier/blob/trunk/NEWS.rst">towncrier's changelog</a>.</em></p> <blockquote> <h1>towncrier 23.6.0 (2023-06-06)</h1> <p>This is the last release to support Python 3.7.</p> <h2>Features</h2> <ul> <li> <p>Make <code>towncrier create</code> use the fragment counter rather than failing on existing fragment names.</p> <p>For example, if there is an existing fragment named <code>123.feature</code>, then <code>towncrier create 123.feature</code> will now create a fragment named <code>123.feature.1</code>. (<code>[#475](twisted/towncrier#475) <https://github.com/twisted/towncrier/issues/475></code>_)</p> </li> <li> <p>Provide a default Markdown template if the configured filename ends with <code>.md</code>.</p> <p>The Markdown template uses the same rendered format as the default <em>reStructuredText</em> template, but with a Markdown syntax. (<code>[#483](twisted/towncrier#483) <https://github.com/twisted/towncrier/issues/483></code>_)</p> </li> <li> <p>Towncrier no longer depends on setuptools & uses importlib.resources (or its backport) instead. (<code>[#496](twisted/towncrier#496) <https://github.com/twisted/towncrier/issues/496></code>_)</p> </li> <li> <p>Added pre-commit hooks for checking and updating news in projects using pre-commit. (<code>[#498](twisted/towncrier#498) <https://github.com/twisted/towncrier/issues/498></code>_)</p> </li> <li> <p>Calling <code>towncrier check</code> without an existing configuration, will just show only an error message.</p> <p>In previous versions, a traceback was generated instead of the error message. (<code>[#501](twisted/towncrier#501) <https://github.com/twisted/towncrier/issues/501></code>_)</p> </li> </ul> <h2>Bugfixes</h2> <ul> <li> <p>Fix creating fragment in a section not adding random characters.</p> <p>For example, <code>towncrier create some_section/+.feature</code> should end up as a fragment named something like <code>news/some_section/+a4e22da1.feature</code>. (<code>[#468](twisted/towncrier#468) <https://github.com/twisted/towncrier/issues/468></code>_)</p> </li> <li> <p>Fix the ReadTheDocs build for <code>towncrier</code> which was broken due to the python version in use being 3.8. Upgrade to 3.11. (<code>[#509](twisted/towncrier#509) <https://github.com/twisted/towncrier/issues/509></code>_)</p> </li> </ul> <h2>Improved Documentation</h2> <ul> <li>Moved man page to correct section (<code>[#470](twisted/towncrier#470) <https://github.com/twisted/towncrier/issues/470></code>_)</li> <li>Update link to Quick Start in configuration.html to point to Tutorial instead. (<code>[#504](twisted/towncrier#504) <https://github.com/twisted/towncrier/issues/504></code>_)</li> <li>Add a note about the build command's <code>--version</code> requiring the command to be explicitly passed. (<code>[#511](twisted/towncrier#511) <https://github.com/twisted/towncrier/issues/511></code>_)</li> <li>Fix typos in the Pre-Commit docs. (<code>[#512](twisted/towncrier#512) <https://github.com/twisted/towncrier/issues/512></code>_)</li> </ul> <h2>Misc</h2> <ul> <li><code>[#459](twisted/towncrier#459) <https://github.com/twisted/towncrier/issues/459></code><em>, <code>[#462](twisted/towncrier#462) <https://github.com/twisted/towncrier/issues/462></code></em>, <code>[#472](twisted/towncrier#472) <https://github.com/twisted/towncrier/issues/472></code><em>, <code>[#485](twisted/towncrier#485) <https://github.com/twisted/towncrier/issues/485></code></em>, <code>[#486](twisted/towncrier#486) <https://github.com/twisted/towncrier/issues/486></code><em>, <code>[#487](twisted/towncrier#487) <https://github.com/twisted/towncrier/issues/487></code></em>, <code>[#488](twisted/towncrier#488) <https://github.com/twisted/towncrier/issues/488></code><em>, <code>[#495](twisted/towncrier#495) <https://github.com/twisted/towncrier/issues/495></code></em>, <code>[#497](twisted/towncrier#497) <https://github.com/twisted/towncrier/issues/497></code><em>, <code>[#507](twisted/towncrier#507) <https://github.com/twisted/towncrier/issues/507></code></em>, <code>[#1117](https://github.com/twisted/towncrier/issues/1117) <https://github.com/twisted/towncrier/issues/1117></code><em>, <code>[#513](twisted/towncrier#513) <https://github.com/twisted/towncrier/issues/513></code></em></li> </ul> <p>towncrier 22.12.0 (2022-12-21)</p>  </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/twisted/towncrier/commit/22a5b015e6404900bfaed4d218cacbd09fc43916"><code>22a5b01</code></a> Update for final release.</li> <li><a href="https://github.com/twisted/towncrier/commit/0d9f08708a29a65050c907995e05180d5320fa6f"><code>0d9f087</code></a> Fix news file.</li> <li><a href="https://github.com/twisted/towncrier/commit/32d7034b82bef8b9f36b6aaec2e9c0de328de222"><code>32d7034</code></a> Remove deploy env requirement.</li> <li><a href="https://github.com/twisted/towncrier/commit/13e6d0c52e5dd63bf6fbf5434731dc4997ecfc82"><code>13e6d0c</code></a> Conditionally run the whole publish.</li> <li><a href="https://github.com/twisted/towncrier/commit/6b9b85a252cc10a40d024710777df48b53740b9a"><code>6b9b85a</code></a> Add dedicated environment.</li> <li><a href="https://github.com/twisted/towncrier/commit/3deaebd35a38bf89e1e0d92bf7822b3ffa61bda0"><code>3deaebd</code></a> Add a top title to the release notes.</li> <li><a href="https://github.com/twisted/towncrier/commit/a94f23c5e3e410bffd44cefbd961192d28fe76f1"><code>a94f23c</code></a> Fix NEWS.rst formatting.</li> <li><a href="https://github.com/twisted/towncrier/commit/3ba6cd1a1830d53266129770556c3d3ea593fcd6"><code>3ba6cd1</code></a> Include the release notes in the docs to make it easyier to review the RST fo...</li> <li><a href="https://github.com/twisted/towncrier/commit/1888debeb12afef9406ac997ad1f9e554423832c"><code>1888deb</code></a> Add info about 3.7.</li> <li><a href="https://github.com/twisted/towncrier/commit/b7a561cf5a85fce14e4abc1ea17d8d9ee59d2e60"><code>b7a561c</code></a> Update for release candidate.</li> <li>Additional commits viewable in <a href="https://github.com/twisted/towncrier/compare/22.8.0...23.6.0">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=towncrier&package-manager=pip&previous-version=22.8.0&new-version=23.6.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com> Co-authored-by: Sam Bull <git@sambull.org>

Replace pkg_resources by importlib.resources

51c67aa

This trades our dependency on setuptools to a conditional one on the importlib-resources backport package. Fixes #494

hynek requested a review from a team as a code owner April 12, 2023 10:55

Add news fragment

d1faac0

graingert previously requested changes Apr 12, 2023

View reviewed changes

src/towncrier/test/helpers.py Outdated Show resolved Hide resolved

Update src/towncrier/test/helpers.py

516a15d

Co-authored-by: Thomas Grainger <tagrain@gmail.com>

graingert reviewed Apr 12, 2023

View reviewed changes

src/towncrier/_settings/load.py Outdated Show resolved Hide resolved

Use as_file + ExitStack to support zips / wheels

5339562

graingert reviewed Apr 12, 2023

View reviewed changes

src/towncrier/_settings/load.py Outdated Show resolved Hide resolved

graingert previously requested changes Apr 12, 2023

View reviewed changes

src/towncrier/_settings/load.py Outdated Show resolved Hide resolved

Address @graingert's feedback

291f7af

Merge branch 'trunk' into drop-pkg-resources

8d27cdf

hynek requested a review from graingert April 14, 2023 13:09

glyph approved these changes Apr 23, 2023

View reviewed changes

Merge branch 'trunk' into drop-pkg-resources

f23c5ce

hynek enabled auto-merge (squash) April 24, 2023 00:20

hynek merged commit 5642c8e into trunk Apr 24, 2023

hynek deleted the drop-pkg-resources branch April 24, 2023 00:24

hynek mentioned this pull request Apr 27, 2023

Default markdown template #483

Merged

6 tasks

hynek mentioned this pull request Jun 17, 2023

Remove type-check dependency #523

Merged

imphil mentioned this pull request Jul 13, 2023

Update to Sphinx 6 cocotb/cocotb#3367

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace pkg_resources by importlib.resources #496

Replace pkg_resources by importlib.resources #496

hynek commented Apr 12, 2023

codecov bot commented Apr 12, 2023 •

edited

Loading

hynek commented Apr 13, 2023

hynek commented Apr 13, 2023

Replace pkg_resources by importlib.resources #496

Replace pkg_resources by importlib.resources #496

Conversation

hynek commented Apr 12, 2023

codecov bot commented Apr 12, 2023 • edited Loading

Codecov Report

hynek commented Apr 13, 2023

hynek commented Apr 13, 2023

codecov bot commented Apr 12, 2023 •

edited

Loading