dev-cmd/update-python-resources: use user PATH

[cho-m]

• Have you followed the guidelines in our Contributing document?
• Have you checked to ensure there aren't other open Pull Requests for the same change?
• Have you added an explanation of what your changes do and why you'd like us to include them?
• Have you written new tests for your changes? Here's an example.
• Have you successfully run brew style with your changes locally?
• Have you successfully run brew typecheck with your changes locally?
• Have you successfully run brew tests with your changes locally?

---

This is mainly to make sure any extra commands are accessible when running brew update-python-resources. Currently brew bump-formula-pr sets the same PATH:

brew/Library/Homebrew/dev-cmd/bump-formula-pr.rb

Lines 99 to 101 in 977ac20

	# As this command is simplifying user-run commands then let's just use a
	# user path, too.
	ENV["PATH"] = PATH.new(ORIGINAL_PATHS).to_s

Particularly useful in combination with #16772 in order to make brew installed formulae accessible.

Can be reviewed independently from other PR.

---

One example is borgbackup which runs pkg-config to find libcrypto.

[carlocab]

Should we preserve the original value of PATH after the command completes?

[MikeMcQuaid]

Which commands, for example?

[cho-m]

Off the top of my head, I recall seeing pkg-config and msgfmt (from gettext). It is usually for Python packages still using setup.py that may end up running these commands.

EDIT: Alternatively, we could go with explicit list and do something like Superenv to only add those opt_bin dirs. I went with simpler option as we already are using this PATH in brew bump / brew bump-formula-pr.

[Bo98]

I get setup.py is a script, but why are things invoking tools on a basic metadata parse? Is it just bad scripts calling things outside of build steps?

Are the failures obvious?

Having at least a couple documented examples here might be good.

[MikeMcQuaid]

EDIT: Alternatively, we could go with explicit list and do something like Superenv to only add those opt_bin dirs. I went with simpler option as we already are using this PATH in brew bump / brew bump-formula-pr.

Yeh, I think this might be nicer.

[cho-m]

I get setup.py is a script, but why are things invoking tools on a basic metadata parse? Is it just bad scripts calling things outside of build steps?

Pretty much. One of the issues of having metadata and build commands in the same file as it can bleed over.

---

Are the failures obvious?

Usually. Though via brew the errors are hidden without --verbose.

❯ brew update-python-resources borgbackup
==> Retrieving PyPI dependencies for "borgbackup==1.2.7"...
Error: Unable to determine dependencies for "borgbackup==1.2.7" because of a failure when running
`/opt/homebrew/opt/[email protected]/libexec/bin/python -m pip install -q --disable-pip-version-check --dry-run --ignore-installed --report=/dev/stdout borgbackup==1.2.7`.
Please update the resources manually.

After verbose, the error at end is:

      OSError: pkg-config probably not installed: FileNotFoundError(2, 'No such file or directory')

---

Having at least a couple documented examples here might be good.

Sure, if I keep going down this route.

---

EDIT: Alternatively, we could go with explicit list and do something like Superenv to only add those opt_bin dirs. I went with simpler option as we already are using this PATH in brew bump / brew bump-formula-pr.

Yeh, I think this might be nicer.

When I have a chance, I'll explore this option further. Logic will most likely reside in utils/pypi.rb.

This should also help run brew bump which may allow us to autobump these (so any extra commands are done in CI environment rather than on user system).

[Bo98]

Cool, thanks for the example! borgbackup looks like it might improve with 1.4.0b1 but I recognise the need for a broader solution here.

[ZhongRuoyu]

Currently brew bump-formula-pr sets the same PATH

Not entirely related to this PR, but if brew bump-formula-pr is invoked by brew bump as a subprocess, the "original PATH" is just the parent brew bump process's sanitised PATH, not the user's.

This was not the case when the tweak was added in brew bump-formula-pr, but the behaviour was changed in #13593.

[cho-m]

Closing this. I will work on a different approach that is more restrictive with opt-in flag to reduce unwanted/unexpected commands run on user systems.