Patching of click in rich-click via litestar cli breaks Typer cli apps about litestar HOT 5 CLOSED

I agree that we shouldn't just monkey-patch things out of the box.

I'm curious however what your use case is that involves making use of the Litestar CLI and typer simultaneously?

from litestar.

I am not using LItestar CLI, other than my assumption that it is perhaps used for the litestar command itself. I typically use a mix of Typer, argparse, and sometimes Click for building out command line tools such as administrative utilities, backend processing, etc.

It is not so much that I am using them "simultaneously", i.e. Litestar would typically run in its own runtime environment from whatever utilities and processes I have. The issue is more that they share the same code. The ORM code is a particularly strong case in point, although I don't really expect that to be the only conflict. In my case however, it does seem that orm code is directly implicated: I ran into this issue trying to build a typer-based utility and traced the issue's source through interdependencies between Litestar itself and advanced-alchemy. Even if you are not using Litestar CLI directly, indirect imports will cause the patch to happen. At least I have found this to be the case when advanced-alchemy is being used. I have not yet tried to isolate this issue in a codebase that does not utilize advanced-alchemy.

from litestar.

Ok, looking back at the code I provided, and digging through my history of chasing this down, I see the point you are making. I do not have any examples of imports from Litestar proper that cause this problem other than the one above of directly importing litestar.cli. In this sense, I see your point about them being simultaneous.

However, if you install litestar[sqlalchemy] and make just about any import from advanced-alchemy, the issue will show itself. This happens due to a number of interdependent imports within advanced-alchemy that result in the cli module being loaded and the implicit patch executed.

So, yes, depending on your perspective, you might consider this to be more of an advanced-alchemy issue than a Litestar issue. I suppose it comes down to whether or not any other similar implicit imports might happen within Litestar per se, and/or whether general click interoperability is something you see as a priority.

Clarification: advanced-alchemy imports do not have to be direct to show this issue. E.g., the mcve shows an import via litestar.contrib

from litestar.

This issue has been closed in #3570. The change will be included in the upcoming patch release.

from litestar.

A fix for this issue has been released in v2.9.1

from litestar.