Make Ruff an optional dependency to avoid upper bound restriction

[johnthagen]

Currently, ruff is listed as a hard dependency of openapi-python-client:

openapi-python-client/pyproject.toml

Line 17 in a73dfd4

"ruff>=0.2,<0.4",

But this means that if a user includes openapi-python-client as their own dev dependency (in order to lock its version with Poetry, for example), they can't upgrade to newer Ruff releases until openapi-python-client does. This is made worse if they need to pin to an older version of openapi-python-client due an incompatibility that arises (e.g., #926).

We need to pin our openapi-python-client rather than using pipx to install it (as recommended in the README), because we need all developers on the team to always get the correct version that we've tested, thus openapi-python-client's dependencies will influence our project's dependencies.

Could ruff be made an extras so that it's optional?

[johnthagen]

I see here why Ruff is a hard dependency: https://github.com/openapi-generators/openapi-python-client?tab=readme-ov-file#installation

Note the --include-deps option makes ruff available in your path so that openapi-python-client can use it to clean up the generated code.

It might be nice to make this optional? I do see the convenience, but for example, on our project we manage Ruff format ourselves as do perhaps others? And then if it were made optional the Ruff version wouldn't need to be restricted by openapi-python-client.

[johnthagen]

Another perhaps less radical open could be to simply remove the upper bound on ruff, but I do know you appreciate the control/testing that comes with upper bounds, which I can't fault.

[dbanty]

The trouble, as it always is with dependency management for this project, is that I never want a situation where the default/easiest case results in a poor experience. Ideally, the basic use-case (install as recommended with pipx, use default post_hooks) works great with the option to do more advanced things (for example, customize hooks, like by omitting default Ruff stuff).

If Ruff were an optional dependency, it wouldn't be installed unless someone specifically asked for it, which means I couldn't set it as the default post hook—so in order to get code that's not messy out of the generator you'd need a config file and to manually install Ruff. I don't know of any way to make a dependency optional but installed by default, so that people can opt out.

Removing the upper bound has the same problem, now by default if someone installs an older version of openapi-python-client after a breaking change to Ruff, they get an error message that probably makes no sense about deserializing the config 😞.

I do wonder if there's another way to ensure that a team is using the same version of openapi-python-client, let me start a separate thread for that, though, so this one can remain about how to manage Ruff.

[johnthagen]

So what a lot of projects do in this situation is to make the default recommended way to install the package include all extras, see uvicorn for example:

pip install 'uvicorn[standard]'

And even the FastAPI docs prescribe this.

Another popular package that does this is psycopg:

pip install "psycopg[binary]"

This could be a nice middle ground for openapi-python-client, so the README would simply state something like:

To install openapi-python-client with the standard set of features, run:

pip install openapi-python-client[standard]

That way, when users come to the project, they are always shown a good default experience with all of the tools you would like to support?

[dbanty]

Oh that's a good idea, and we could make it a breaking change so hopefully folks read the changelog and add the features as needed. Would also need to tweak the GitHub Action so that it adds the features automatically, but only for new enough versions of the generator 🤔.

[yyyxam]

Any updates on this? Just stumbled upon this issue myself. I had this project on 0.20.0 as a dependency while my project has the newest Ruff version, which caused a conflict. I updated to 0.21.5, but I shouldn't be forced to IMO