How do I use 3rd party dependencies in a plugin I have a `BU Pants #plugins

How do I use 3rd party dependencies in a plugin? ...

rich-london-74860

04/26/2023, 5:50 PM

How do I use 3rd party dependencies in a plugin? I have a

BUILD

file setup for my plugin, with it’s own

resolve

and

pants_requirement

(following the documentation here), but whenever I try to run my plugin (or anything), I get a

ModuleNotFound

error. This does not seem to be a problem when running unit tests for that same plugin, which imports the 3rd party dependency.

curved-television-6568

04/26/2023, 5:54 PM

when you install your plugin with adding it to

pants.toml

in the

[GLOBAL].plugins

those 3rd party deps will be pulled in as usual, but when you run your plugin as a in-repo plugin you need to provide those deps manually as the plugin is not packaged and installed, so list those requirements in the

[GLOBAL].plugins

option should make them available to your plugin.

rich-london-74860

04/26/2023, 5:55 PM

Right, I found this, but this makes me very confused about the purpose of the plugins resolve. Is that only used for tests?

curved-television-6568

04/26/2023, 5:57 PM

that, and in case you have a

python_distribution

target to publish it that would be used to instruct pants what 3rdparty deps you have for it

curved-television-6568

04/26/2023, 5:59 PM

and possibly others I’m overlooking/not aware of

rich-london-74860

04/26/2023, 6:01 PM

Even if I have my 3rd-party dependencies in

[GLOBAL].plugins

do I need to include them as

python_requirements

dependencies for unit tests?

curved-television-6568

04/26/2023, 6:03 PM

yes, that installed by

[GLOBAL].plugins

will not be available in tests

curved-television-6568

04/26/2023, 6:04 PM

consider that you see two sides of your plugin at once. Both developing the plugin and consuming/using the plugin. And those two have different requirements/setups.

rich-london-74860

04/26/2023, 6:05 PM

If one of the 3rd-party dependencies installed via

[GLOBAL].plugins

includes an

entry_point

, is it possible to then invoke that

entry_point

via pants?

curved-television-6568

04/26/2023, 6:06 PM

no those are not exposed. it’s easy enough to add a

pex_binary

for that purpose.

curved-television-6568

04/26/2023, 6:08 PM

more context on that here https://github.com/pantsbuild/pants/pull/13257 (as I had the very same idea once)

rich-london-74860

04/28/2023, 4:53 PM

No, you’re definitely right that a

pex_binary

accomplishes what we need, thanks!

rich-london-74860

04/28/2023, 4:54 PM

consider that you see two sides of your plugin at once. Both developing the plugin and consuming/using the plugin. And those two have different requirements/setups.

I understand the reason… but it is still annoying 😒

✅ 1

rich-london-74860

05/03/2023, 1:51 PM

One follow-up question on this, there is a lockfile for 3rd-party dependencies used to develop the plugin, how does the

pants

know which version of the 3rd-party dependency to use for the one specified in

[GLOBAL].plugins

? I’m asking because I’ve been seeing a problem where pants gets stuck resolving plugins (the dependencies in

[GLOBAL].plugins

). If

pants

bootstraps from a virtual environment, are those dependencies installed into the virtual environment?

2 Views

Open in Slack

Previous Next