Define metadata in setup.cfg by nicoonoclaste · Pull Request #243 · duckinator/emanate

nicoonoclaste · 2021-04-10T13:14:46Z

Move version number to /version file, define __version__ based on package metadata
That file doesn't need to be included in the built package, but stays separate for Cirrus to pick up on.
Move author definition to setup.cfg
Drop setup-time dependencies
We aren't using attr: anymore in setup.cfg, so emanate needs not be importable at setup-time.

I'm much happier with this; there's presumably a bit of import-time overhead, but
it's worth the reduction in complexity.

Pull __version__ from the package's metadata directly

Closes #236

We are not using `attr:` anymore, so the `emanate` module does not need to be importable at setup time.

nicoonoclaste · 2021-04-10T13:17:24Z

@duckinator There might be complications when merging this, since it will match the changesInclude('version') condition in Cirrus; does the release task fail cleanly if a release with that number already exists?

nicoonoclaste · 2021-04-10T13:31:01Z

Oh, importlib.metadata was introduced in Python 3.8 >_>'
I added a conditional dependency on a polyfill (by the CPython maintainers, unlike the dataclasses mess)

nicoonoclaste · 2021-04-10T13:32:39Z

Oh FFS. Now it barfs up because of a dependency conflict with bork.

@duckinator, can we move away from specifying exact versions?

nicoonoclaste · 2021-04-10T13:42:37Z

@AstraLuma, I'd be interested in your opinion on this PR. 💜

nicoonoclaste · 2021-04-10T13:47:26Z

emanate/__init__.py

+    import importlib_metadata as metadata  # type: ignore
+
+# Set the module-level dunders suggested in PEP8
+__author__ = metadata.metadata('emanate').get('author')


Is there a way to pass metadata the current module, instead of hardcoding a name?

nicoonoclaste · 2021-04-10T14:05:05Z

Annoyingly, we presumably care about OpenSUSE (at least, @duckinator included it in versions.boop.ws) and even their current beta still ships Python 3.6 😭

duckinator · 2021-04-10T20:36:20Z

@nbraud I can't really give this a proper review because GitHub is incomprehensible on a 1366x768 display, but:

the release task should fail cleanly.
ok @ the importlib.metadata polyfill. this will make the zipapp Py3.8+ unless we make it unconditional, but i'm not terribly worried about that unless people actively ask for 3.7 support in the zipapp.
Bork is already moving away from pinning exact versions, and I am okay with doing the same for Emanate.
i don't care about OpenSUSE unless people are trying to use one of my projects on it.

nicoonoclaste · 2021-04-10T23:17:36Z

the release task should fail cleanly.

OK, then there should be no special handling needed for this PR (moving the version file).

ok @ the importlib.metadata polyfill. this will make the zipapp Py3.8+ unless we make it unconditional, but i'm not terribly worried about that unless people actively ask for 3.7 support in the zipapp.

Ayup. I'm not terribly-worried either about that polyfill.
Ideally, we could make the dependency conditional on something like python_version < '3.8' or building_as_zipapp but there seem to be no way to express that in the PEP 508 language.

Bork is already moving away from pinning exact versions, and I am okay with doing the same for Emanate.

OK. ~~Let's do another PR afterwards~~ I opened #244 to un-pin all our dependencies.

i don't care about OpenSUSE unless people are trying to use one of my projects on it.

Good to know. Given that I don't think we'd want to drop Py3.7 compatibility just yet, we need to deal with the polyfills anyway (and edge-cases like zipapps) so I guess we could keep Py3.6 compatibility so long as the dataclasses shim doesn't get in the way.

On the other hand, it's in my experience a problematic library (badly maintained, had bugs that had been fixed in the Python stdlib for years, ...) so I'd be happy not to have a dependency on it, even a conditional one.

nicoonoclaste · 2021-04-10T23:24:43Z

Modified to use the ~= version specifier, since that will (presumably) be what unpinned dependencies will use.

Pinning exact versions makes software that share dependencies essentially-impossible to install in the same environment. See #243. We use the “compatible version” operator, `~=`, to specify version constraints, essentially assuming that our dependencies follow SemVer.

duckinator · 2021-04-15T20:28:37Z

@nbraud This looks good to me — if you're happy with it, go ahead and merge it when you're ready.

nicoonoclaste · 2021-04-20T22:55:42Z

bors r=duckinator

243: Define metadata in setup.cfg r=duckinator a=nbraud - [x] Move version number to `/version` file, define `__version__` based on package metadata That file doesn't need to be included in the built package, but stays separate for Cirrus to pick up on. - [x] Move author definition to `setup.cfg` - [x] Drop setup-time dependencies We aren't using `attr:` anymore in `setup.cfg`, so `emanate` needs not be importable at setup-time. I'm much happier with this; there's presumably a bit of import-time overhead, but it's worth the reduction in complexity. Co-authored-by: nicoo <nicoo@mur.at>

nicoonoclaste · 2021-04-20T22:56:34Z

bors abort

bors · 2021-04-20T22:57:04Z

Canceled.

nicoonoclaste · 2021-04-20T22:57:20Z

Oops I had forgotten to push a commit >_>'

nicoonoclaste · 2021-04-20T22:57:52Z

bors r=duckinator

bors · 2021-04-20T23:02:32Z

Build succeeded:

CI success

Pinning exact versions makes software that share dependencies essentially-impossible to install in the same environment. See #243. We use the “compatible version” operator, `~=`, to specify version constraints, essentially assuming that our dependencies follow SemVer.

244: setup.cfg: Relax version constraints on all dependencies r=duckinator a=nbraud Pinning exact versions makes software that share dependencies essentially-impossible to install in the same environment. See #243 for an example of this kind of issue. We use the “compatible version” operator, `~=`, to specify version constraints, essentially assuming that our dependencies follow SemVer. Co-authored-by: nicoo <nicoo@mur.at>

nicoonoclaste added 3 commits April 10, 2021 15:02

Store version number in separate text file

ac25ff8

Pull __version__ from the package's metadata directly

Set author in setup.cfg

0e15d19

Closes #236

setup.cfg: Drop setup-time dependencies

802ee99

We are not using `attr:` anymore, so the `emanate` module does not need to be importable at setup time.

Use importlib.metadata backport prior to Python 3.8

e0b42ce

nicoonoclaste commented Apr 10, 2021

View reviewed changes

setup.cfg: Relax version constraint on importlib.metadata backport

a75b32b

nicoonoclaste force-pushed the metadata branch from e4009f2 to a75b32b Compare April 10, 2021 23:23

nicoonoclaste mentioned this pull request Apr 10, 2021

setup.cfg: Relax version constraints on all dependencies #244

Merged

emanate: Use __name__ instead of hardcoding the module's name

fc22735

bors bot merged commit 493ec26 into master Apr 20, 2021

bors bot deleted the metadata branch April 20, 2021 23:02

Uh oh!

Conversation

nicoonoclaste commented Apr 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nicoonoclaste commented Apr 10, 2021

Uh oh!

nicoonoclaste commented Apr 10, 2021

Uh oh!

nicoonoclaste commented Apr 10, 2021

Uh oh!

nicoonoclaste commented Apr 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nicoonoclaste Apr 10, 2021

Choose a reason for hiding this comment

Uh oh!

AstraLuma Apr 15, 2021

Choose a reason for hiding this comment

Uh oh!

nicoonoclaste commented Apr 10, 2021

Uh oh!

duckinator commented Apr 10, 2021

Uh oh!

nicoonoclaste commented Apr 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nicoonoclaste commented Apr 10, 2021

Uh oh!

duckinator commented Apr 15, 2021

Uh oh!

nicoonoclaste commented Apr 20, 2021

Uh oh!

nicoonoclaste commented Apr 20, 2021

Uh oh!

bors bot commented Apr 20, 2021

Uh oh!

nicoonoclaste commented Apr 20, 2021

Uh oh!

nicoonoclaste commented Apr 20, 2021

Uh oh!

bors bot commented Apr 20, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nicoonoclaste commented Apr 10, 2021 •

edited

Loading

nicoonoclaste commented Apr 10, 2021 •

edited

Loading

nicoonoclaste commented Apr 10, 2021 •

edited

Loading