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

Platform file name #1140

Open
alecandido opened this issue Jan 29, 2025 · 1 comment
Open

Platform file name #1140

alecandido opened this issue Jan 29, 2025 · 1 comment
Labels

Comments

@alecandido
Copy link
Member

Qibolab requires a platform folder to contain a platform.py file.

While this is a meaningful name, it is also pretty inconvenient, since clashing with the standard library.
https://docs.python.org/3/library/platform.html

Usually this is not a problem, since the import only happens at runtime through a dedicate path-based mechanism (cf. create_platform). However, it becomes an issue for any direct manipulation, e.g. creating the parameters from scratch, through the support introduced in #1123.

It may definitely be worth to favor a new name (e.g. create.py, or whatever else).


Breaking change

While imposing a new name would be a breaking change, we could immediately start transitioning allowing an extra name, just leaving the old name deprecation to the next breaking release.

@alecandido
Copy link
Member Author

@stavros11, I opened the issue without first discussing it. However, feel free to provide negative feedback as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant