Entrypoints in declarative config are now supported #2604

cansjt · 2021-03-09T08:52:04Z

The documentation still states it is not though.

Closes: #2603

Summary of changes

Removed inaccurate statement
Added an example of the now supported feature.

Closes

Pull Request Checklist

Changes have tests
News fragment added in changelog.d/.
(See documentation for details)

jaraco · 2021-03-14T15:03:54Z

docs/userguide/declarative_config.rst

 ``setup.cfg`` sections used by the ``pbr`` and ``d2to1`` packages.

 Namely: only metadata-related keys from ``metadata`` section are supported
- (except for ``description-file``); keys from ``files``, ``entry_points``
- and ``backwards_compat`` are not supported.


I think this comment is pertinent to the "compatibility with distutils2-like" sections. Is the entry_points as implemented by setuptools declarative config compatible with pbr and d2to1?

Perhaps better would be to just remove the considerations about pbr and d2to1 compatibility.

Sorry I saw your review the other day, but I have been pretty busy, and forgot to reply.

I do think the compatibility part is a bit confusing, especially because it is at the forefront of the page. I have been periodically coming to this page for years now, generally for a quick reminder of some syntax when in doubt, or to see if something previously unsupported got implemented. But only now, and because of your comment, do I realize this particular section was really about compatibility with other tools.

I don't know if it's just me, but when I come to setuptools' documentation, what I expect to find, before anything else, is documentation about setuptools, not other tools. So I am not sure that should be "front matter". Also, since the early days of the setuptools' support for declarative configuration, quite a bit of time has passed. Such matters were probably more of an issue then, than now (though I could be wrong on about that).

So maybe it is now time to revamp this section a bit ? I would keep the compatibility section about those other tools though, because it might still be relevant to some. But I would move it to the bottom of the page. Focus on setuptools' features first. A more comprehensive, independent, "migration" or "cross tool compatibility" section could prove useful, but I wouldn't feel competent enough to write it. I, for example, never used neither pbr nor d2to1.

I'd be glad to spend some time on this tomorrow, if you find that what I am suggesting makes any sense at all.

Your instincts align with mine. Yes, moving that compatibility information into a secondary section makes sense. I too am not particularly familiar with those concerns, so don't have much to add. Thanks for the consideration.

webknjaz · 2021-04-21T14:20:53Z

@cansjt could you rebase this PR to make the CI green? It's failing since pip switched their master branch to main which is already fixed on setuptools@main so rebasing will fix it.

webknjaz · 2021-04-21T14:25:07Z

docs/userguide/declarative_config.rst

+=========================== ========== ========== ===== ===
+feature setuptools distutils2 d2to1 pbr
+=========================== ========== ========== ===== ===
+[metadata] description-file N Y Y Y


I think it's

Suggested change

[metadata] description-file N Y Y Y

[metadata] description-file S Y Y Y

because in setuptools you can do long_description = file: README.rst, CHANGELOG.rst to achieve the same outcome.

webknjaz · 2021-04-21T14:27:35Z

docs/userguide/declarative_config.rst

+feature setuptools distutils2 d2to1 pbr
+=========================== ========== ========== ===== ===
+[metadata] description-file N Y Y Y
+[files] N Y Y Y


It's just in the [options] section:

Suggested change

[files] N Y Y Y

[files] S Y Y Y

changelog.d/2604.doc.rst

webknjaz · 2021-04-21T16:52:54Z

FTR the docs builds fail because Python 3.7 is used in those envs and the new update of sphinx-inline-tabs bumps their python_requires to 3.8. #2651 should fix that.

cansjt · 2021-05-08T08:21:26Z

docs/userguide/declarative_config.rst

-.. note::
- A version loaded using the ``file:`` directive must comply with PEP 440.
- It is easy to accidentally put something other than a valid version
- string in such a file, so validation is stricter in this case.


Moved this around because I find it was scattering into pieces informations about a single keyword and breaking the reading flow. Also, all those grey notes boxes aren't that pretty.

Also, all those grey notes boxes aren't that pretty.

Honestly I can't wait for the theme to be switched to furo.

cansjt · 2021-05-08T08:22:42Z

docs/userguide/declarative_config.rst

- in a dedicated subsection ``options.packages.find``. This subsection
- accepts the same keys as the ``setuptools.find_packages`` and the
- ``setuptools.find_namespace_packages`` function:
- ``where``, ``include``, and ``exclude``.


Same as above. Puts all informations about a particular keyword into one place.

changelog.d/2604.doc.rst

webknjaz · 2021-05-08T08:37:37Z

docs/userguide/declarative_config.rst

+============================== ================= ================= =============== =======================
 name str
-version attr:, file:, str 39.2.0 (1)
+version attr:, file:, str 39.2.0 :ref:`(1)<note-meta-1>`


Have you considered using footnotes? It should be easier to maintain them.
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#footnotes

Indeed it look better and would probably be easier to maintain. I am just wondering if some themes would move them all to the bottom of the page. That would leave an orphan notes paragraph behin.
But with the current one, they stay where they are defined.

The documentation still states it is not though. Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

henryiii · 2021-12-29T17:21:39Z

docs/userguide/declarative_config.rst

+extras_require section [#opt-2]_
 python_requires str
-entry_points file:, section
+entry_points file:, section 51.0.0


Why is this 51? I thought I've been using this for years, well before 51 was even released? I could have sworn it at least works on 44. There's nothing in the 51 release notes that mentions this either. See wntrblm/nox#553.

Was this supposed to be 41 instead? That sounds about right.

jaraco reviewed Mar 14, 2021

View reviewed changes

cansjt force-pushed the fix-inaccurate-entrypoint-doc branch 7 times, most recently from babe926 to 6ba2807 Compare March 28, 2021 09:45

webknjaz reviewed Apr 21, 2021

View reviewed changes

changelog.d/2604.doc.rst Outdated Show resolved Hide resolved

jaraco mentioned this pull request Apr 24, 2021

Bump Python @ RTD to accomodate sphinx-inline-tabs #2651

Closed

2 tasks

cansjt force-pushed the fix-inaccurate-entrypoint-doc branch 5 times, most recently from 20b1cff to f5ca09c Compare May 8, 2021 08:17

cansjt commented May 8, 2021

View reviewed changes

cansjt force-pushed the fix-inaccurate-entrypoint-doc branch from f5ca09c to fcd2e6d Compare May 8, 2021 08:27

webknjaz reviewed May 8, 2021

View reviewed changes

changelog.d/2604.doc.rst Show resolved Hide resolved

webknjaz reviewed May 8, 2021

View reviewed changes

changelog.d/2604.doc.rst Show resolved Hide resolved

webknjaz reviewed May 8, 2021

View reviewed changes

cansjt force-pushed the fix-inaccurate-entrypoint-doc branch from 4140483 to f051c1d Compare May 10, 2021 07:33

Entrypoints in declarative config are now supported

d339125

The documentation still states it is not though. Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

cansjt force-pushed the fix-inaccurate-entrypoint-doc branch from f051c1d to d339125 Compare May 29, 2021 06:52

jaraco merged commit c5e3614 into pypa:main May 29, 2021

henryiii reviewed Dec 29, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Entrypoints in declarative config are now supported #2604

Entrypoints in declarative config are now supported #2604

Uh oh!

cansjt commented Mar 9, 2021 •

edited

Loading

jaraco Mar 14, 2021

jaraco Mar 27, 2021

cansjt Mar 27, 2021

jaraco Mar 27, 2021

webknjaz commented Apr 21, 2021

webknjaz Apr 21, 2021

webknjaz Apr 21, 2021

Uh oh!

webknjaz commented Apr 21, 2021

cansjt May 8, 2021

webknjaz May 8, 2021

cansjt May 8, 2021

Uh oh!

Uh oh!

webknjaz May 8, 2021

cansjt May 10, 2021

henryiii Dec 29, 2021 •

edited

Loading

henryiii Dec 29, 2021

Labels

4 participants

	[metadata] description-file N Y Y Y
	[metadata] description-file S Y Y Y

Uh oh!

Entrypoints in declarative config are now supported #2604

Entrypoints in declarative config are now supported #2604

Uh oh!

Conversation

cansjt commented Mar 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of changes

Pull Request Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

webknjaz commented Apr 21, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Uh oh!

webknjaz commented Apr 21, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

henryiii Dec 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Labels

4 participants

cansjt commented Mar 9, 2021 •

edited

Loading

henryiii Dec 29, 2021 •

edited

Loading