Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renaming global directory #2604

Open
reicda opened this issue Sep 10, 2024 · 0 comments
Open

Renaming global directory #2604

reicda opened this issue Sep 10, 2024 · 0 comments
Labels
clean up low needs discussion python Pull requests that update Python code
Milestone

Comments

@reicda
Copy link

reicda commented Sep 10, 2024

At the moment we use global as the name for the directory containing the meta repository and data intended for further use in other modules.

'global' is one of the reserved keywords in python and thus must not be used in this case as it will lead to a syntax error. There are work-arounds but they will lead to errors by the linting tools we use (e.g. mypy) that need to be suppressed.

example:
>>> import global.example_module

work-around:
>>> sys.path.append("global")
>>> import example_module

work-around (suppressed linting):
>>> sys.path.append("global")
>>> import example_module # type: ignore # noqa

To tackle the problem at the root I suggest we rename the directory to something similar (e.g. universal, general, unbounded, planetary, comprehensive) and adjust all references.

@reicda reicda added clean up needs discussion python Pull requests that update Python code labels Sep 10, 2024
@reicda reicda added this to the 4.2 milestone Sep 10, 2024
@rrenkert rrenkert added the low label Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clean up low needs discussion python Pull requests that update Python code
Projects
None yet
Development

No branches or pull requests

3 participants