fastapi-cli sys.path munging leads to obscure namespaced module import bugs

[bostrick]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched in the documentation/README.
• I already searched in Google "How to do X" and didn't find any information.
• I already read and followed all the tutorial in the docs/README and didn't find an answer.

Commit to Help

• I commit to help with one of those options 👆

Example Code

N/A

Description

This is a little involved... bear with me ;).

To avoid module naming collisions, I'm using a toplevel namespaced package majqa, of which "webapp" containing app.py is a submodule, as is a submodule named 'github'...

majqa
    utils
    store
    kubernetes     (module containing k8s logic...)
    github              (module containing github logic...)
    webapp           (module containing app = Fastapi(...) in app.py
    ...

When invoking fastapi run .../majqa/webapp to start the service, sys.path get's prefixed to include the majqa namespace module path, i think here...

fastapi-cli/src/fastapi_cli/discover.py

Line 125 in 9a47418

sys.path.insert(0, str(mod_data.extra_sys_path))

In subsequent code, I'm trying to import symbols from the PyGithub package....

from github import Github, Auth

However, due to the manipulated path...

(Pdb) print(sys.path)
['/opt/app-root/lib/python3.12/site-packages/majqa', '/opt/app-root/bin', '/usr/lib64/python312.zip',  ...]

... I'm accessing my majqa.github module, instead of PyGithub's github module.

I'm using workarounds to solve the problem, but am wondering is it reasonable to ask... If fastapi-cli feels the need to unconventionally manipulate sys.path to startup, can it restore it once it's done using it?

Thanks for any feedback!

Operating System

Linux

Operating System Details

Most recent Fedora

Python Version

Python 3.12.5

Additional Context

No response