Install specific requirement from `setup.cfg` for testing #1263

rmartin16 · 2023-05-06T21:54:25Z

Changes

Introduces a straightforward script to install requirements as defined in the project's metadata
By default, only non-extra requirements can be installed.
To install an extra requirement, the name of the extra much be specified in --extra

Notes

The motivation for this is the several places we install the entire project when we just need one package
I have spent a lot of time trying to understand the "best way" to install a subset of dependencies from a project
PyPA basically wants nothing to do with this...and for a lot of good reasons
- So, expecting something like pip install --only-dep=tox briefcase to ever be a thing seems very unlikely
tox has expressed interest in supporting something like this
The most useful tool I found to provide an API of sorts to extract the requirement was pip-tools
- While its for freezing requirements for deployments, it technically serves this purpose
- For instance: pip-compile --resolver=backtracking --extra dev -o - 2>/dev/null | grep '^tox='
- However, it's quite slow in this use-case

@freakboy3742, this is mostly to gauge interest after our quick messages about this. Let me know what you think. At the end of the day, there isn't that much time spent installing all of Briefcase...but when you just need coverage or tox, it seems like a little much. If this doesn't seem worth the squeeze, I'm fine moving on.

PR Checklist:

All new features have been tested
All new features have been documented
I have read the CONTRIBUTING.md file
I will abide by the code of conduct

freakboy3742

tl;dr - I like this as a general direction; my only comments are around bike-sheddy details.

Specifically - Do we anticipate an "env util" other than installing dev requirements? And - if we do end up with a need for another tool, would there be any reason that we need to cram it into this tool, rather than just adding a new one?

My suggestion - make this an install_requirement.py script at the top level of the project (with a bunch of docs at the top of the file describing exactly why it exists). There's no reason it needs to be hidden in the test folder; and a single purpose "install a requirement" script is easier to explain than a generic "environment utils" script.

If I were going to go down the path of "adding features that I'm not sure we have a use case for", I might tweak the command line interface so that invocation was python -m install_extra dev tox - i.e., install a specific requirement from the named section, possibly with python -m install_extra dev would install all the dev requirements without installing the package itself.

If we really want to go down the rabbit hole, it might be worth publishing this as a standalone package on PyPI. If we treat it the same way we treat pip and setuptools (i.e., a tool that is allowed to be unpinned because main is always stable and compatible). We can then add it as a simple requirement, then use it as install_extra dev tox. This same requirement exists on Toga, rubicon, etc... and I can imagine it being useful to others...

freakboy3742 · 2023-05-08T01:00:42Z

.github/workflows/ci.yml

-        # We don't actually want to install briefcase; we just
-        # want the dev extras so we have a known version of tox.
-        python -m pip install $(ls dist/briefcase-*.whl)[dev]
+        python tests/env_utils.py install-req tox


This will likely be opaque enough for first-time readers (or, lets be honest, me in 2 months :-) that it's worth retaining a comment so it's clear what this is doing.

rmartin16 · 2023-05-24T23:11:56Z

I've implemented the basic recommendations for this to remain as a relatively simple script.

However, as for usage such as python -m install_extra dev tox, based on my understanding, I think this would inherently necessitate installing a package with such an entry point defined...but that's mostly what we're trying to avoid. Admittedly, I don't have a rock solid understanding of entry points, so please let me know if you think I'm coming to the wrong conclusion.

Speaking of conclusions...I'm not really super enthused with a random script in the root of the project (although, the location isn't so much my hesitation as much as it's just a script that's divorced from everything else).

So, I'm considering this still to be an interim step towards a more formalized tool that would ideally be packaged and put on PyPI. Although, my hesitation there is I'm not particularly a packaging expert and I feel like there's a lot of holes and missing functionality given all the permutations of Python packaging. I'll do some more research, though, and see how this shakes out.

freakboy3742 · 2023-05-25T00:22:09Z

However, as for usage such as python -m install_extra dev tox, based on my understanding, I think this would inherently necessitate installing a package with such an entry point defined...but that's mostly what we're trying to avoid.

Running install_extra would require an entry point; python -m install_extra is effectively just python install_extra.py but allowing for install_extra to be a directory that contains a __main__.py.

Speaking of conclusions...I'm not really super enthused with a random script in the root of the project (although, the location isn't so much my hesitation as much as it's just a script that's divorced from everything else).

I can empathise; however, from my perspective, it's a key piece of project infrastructure that's relatively easy to explain, so I can live with it.

So, I'm considering this still to be an interim step towards a more formalized tool that would ideally be packaged and put on PyPI. Although, my hesitation there is I'm not particularly a packaging expert and I feel like there's a lot of holes and missing functionality given all the permutations of Python packaging. I'll do some more research, though, and see how this shakes out.

Oh, thar absolutely be dragons in here for the general case :-) But we don't need to solve the general case ourselves.

freakboy3742 · 2023-05-25T23:53:23Z

install_requirement/__main__.py

Just confirming this change was deliberate - putting this in a directory isn't required for a single file module - a single hello.py can be invoked as python -m hello.

it was deliberate insofar as I was thinking it was necessary :) i didn't realize python -m would work like that. I'll revert it back in that case.

freakboy3742

A couple of questions/clarifications, but this mostly makes sense.

freakboy3742 · 2023-05-28T23:59:32Z

install_requirement.py

+        requirement
+        for requirement in project_requirements
+        if any(requirement.name.startswith(req) for req in requested_requirements)
+    ]


Is there a reason you're doing a startswith check, rather than a literal? This will be overenthusiastic for pytest/pytest-xdist case (install-req --extra dev pytest installs both pytest and pytest-xdist).

Right; that is the intended use-case since many testing dependencies tend to be named with a prefix that's an implied dependency. Or in the least, that's true for the pytest and coverage plugins we're using.

This type of functionality should probably be supported with a regex but I didn't want to add that complication.

Using a literal may be more expected and allows the behavior to be more explicit.

Yeah - this is relying on a very specific naming convention - while this may be valid for a lot of packages, there's not guarantee that it will always be true. I can also imagine a possible situation where we literally just want pytest and no plugins, so explicit will always be better than implicit.

freakboy3742 · 2023-05-29T00:12:15Z

.github/workflows/ci.yml

-        # We don't actually want to install briefcase; we just
-        # want the dev extras so we have a known version of tox.
-        python -m pip install $(ls dist/briefcase-*.whl)[dev]
+        python -m pip install --upgrade setuptools build wheel


I'm not 100% clear on why build and wheel need to be on this list. Is this purely defensive, or is there a specific need?

This script depends on build and wheel.

/me facepalms. Of course - missed the imports at the top of the script.

…requirements

…r the requirement

freakboy3742

Nice work - makes for a nice cleanup!

freakboy3742 reviewed May 8, 2023

View reviewed changes

rmartin16 force-pushed the find-reqs branch 5 times, most recently from 9bbabd5 to 5548a26 Compare May 24, 2023 23:00

rmartin16 force-pushed the find-reqs branch from 5548a26 to 5456993 Compare May 24, 2023 23:19

freakboy3742 reviewed May 25, 2023

View reviewed changes

rmartin16 force-pushed the find-reqs branch from 34be3c0 to 63bfd32 Compare May 26, 2023 00:10

rmartin16 marked this pull request as ready for review May 26, 2023 00:19

freakboy3742 requested changes May 29, 2023

View reviewed changes

rmartin16 added 5 commits May 29, 2023 14:04

Install specific requirements from setup.cfg for testing

f4ad7bc

Use proper pyproject.toml project APIs to access requirements

33de91a

Clear minimum requirements for a script to install arbitrary project …

23dd8f3

…requirements

Use install_requirement.py as a module

c2d8aa0

Require a literal match to project requirements and install extras fo…

d16c59d

…r the requirement

rmartin16 force-pushed the find-reqs branch from 1c54499 to d16c59d Compare May 29, 2023 18:04

rmartin16 requested a review from freakboy3742 May 29, 2023 19:20

freakboy3742 approved these changes May 29, 2023

View reviewed changes

freakboy3742 merged commit 241b2c1 into beeware:main May 29, 2023

rmartin16 deleted the find-reqs branch May 29, 2023 22:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Install specific requirement from `setup.cfg` for testing #1263

Install specific requirement from `setup.cfg` for testing #1263

rmartin16 commented May 6, 2023 •

edited

Loading

freakboy3742 left a comment

freakboy3742 May 8, 2023

rmartin16 commented May 24, 2023

freakboy3742 commented May 25, 2023

freakboy3742 May 25, 2023

rmartin16 May 26, 2023

freakboy3742 left a comment

freakboy3742 May 28, 2023

rmartin16 May 29, 2023

freakboy3742 May 29, 2023

freakboy3742 May 29, 2023

rmartin16 May 29, 2023

freakboy3742 May 29, 2023

freakboy3742 left a comment

Install specific requirement from setup.cfg for testing #1263

Install specific requirement from setup.cfg for testing #1263

Conversation

rmartin16 commented May 6, 2023 • edited Loading

Changes

Notes

PR Checklist:

freakboy3742 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rmartin16 commented May 24, 2023

freakboy3742 commented May 25, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

freakboy3742 left a comment

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

freakboy3742 left a comment

Choose a reason for hiding this comment

Install specific requirement from `setup.cfg` for testing #1263

Install specific requirement from `setup.cfg` for testing #1263

rmartin16 commented May 6, 2023 •

edited

Loading