fix: Ensure app-dir is appended to path during autodiscovery.

[sykloid]

Pull Request Checklist

• New code has 100% test coverage
• (If applicable) The prose documentation has been updated to reflect the changes introduced by this PR
• (If applicable) The reference documentation has been updated to reflect the changes introduced by this PR

Description

• This PR fixes a bug which caused the --app-dir option to the litestar CLI to not be propagated during autodiscovery.

Close Issue(s)

• Fixes Bug: --app-dir option does not work/fails during autodiscovery. #2266

Notes

I am unclear what kind of tests should be written for this, since the existing test should capture it, yet I'm not sure why it doesn't.

[abdulhaq-e]

I wrote a test that I will push to your branch. I hope you don't mind.

Also, the env is resolved here:

litestar/litestar/cli/main.py

Line 53 in c36dba2

ctx.obj = lambda: LitestarEnv.from_env(app_path)

I don't know yet the exact conditions on which this line is invoked, but it is important as removing this line causes a lot of test failures. You may want to follow this further.

[abdulhaq-e]

I've added another test, however that test also passes without having to pass app_dir in

litestar/litestar/cli/main.py

Line 53 in c36dba2

ctx.obj = lambda: LitestarEnv.from_env(app_path)

@cofin

Is this line only used for testing?

litestar/litestar/cli/main.py

Line 52 in c36dba2

if ctx.obj is None: # env has not been loaded yet, so we can lazy load it

[abdulhaq-e]

I've added app_dir to the line mentioned in my comments just in case. Other than that, it's all good.

Congratulations on your first contribution to Litestar 👍

[cofin]

I feel like we need to override the path that's passed into the _autodiscover_app function on this one.

One way to do that would be to override the cwd:

        cwd = Path().cwd() if app_dir is None else Path(app_dir)
        cwd_str_path = str(cwd)
        if cwd_str_path not in sys.path:
            sys.path.append(cwd_str_path)

You would then remove the additional if conditional that was added.

[abdulhaq-e]

I feel like we need to override the path that's passed into the _autodiscover_app function on this one.

One way to do that would be to override the cwd:

        cwd = Path().cwd() if app_dir is None else Path(app_dir)
        cwd_str_path = str(cwd)
        if cwd_str_path not in sys.path:
            sys.path.append(cwd_str_path)

You would then remove the additional if conditional that was added.

I just tried it, lots of failures, all in test_core_commands.py, I think both directories need to be added to the path.

[cofin]

Nice work!

[cofin]

@all-contributors add @sykloid for bugs, code, and tests

[allcontributors]

@cofin

I've put up a pull request to add @sykloid! 🎉

[github-actions]

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/2277