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

Rename flake8-builtins options to remove the "builtins" prefix #15368

Open
2 tasks
dhruvmanila opened this issue Jan 9, 2025 · 3 comments
Open
2 tasks

Rename flake8-builtins options to remove the "builtins" prefix #15368

dhruvmanila opened this issue Jan 9, 2025 · 3 comments
Labels
configuration Related to settings and configuration help wanted Contributions especially welcome

Comments

@dhruvmanila
Copy link
Member

The "builtins" prefix for the flake8-builtins options is redundant and is inconsistent with other options like allowed-unused-imports or allowed-markup-calls.

Although we can tackle this in 0.9 release, I'd say we do the rename (maintaining backwards compatibility) after the 0.9 release and hard deprecate in 0.11.

@MichaReiser
Copy link
Member

Backward compat seems nice. We could change builtins-allowed-modules because the only rule using it is still in preview but it probably makes little sense to only add the backwards compatibility for one setting and not the other.

@MichaReiser
Copy link
Member

MichaReiser commented Jan 9, 2025

Considering that both settings have the builtins prefix I don't see this blocking the release (because we renamed A005)

@MichaReiser MichaReiser added the help wanted Contributions especially welcome label Jan 9, 2025
@AlexWaygood
Copy link
Member

Yeah, the backwards incompatibility issue was why I didn't rename the setting at the same time as the rule (but I also didn't think hard about it; thanks @dhruvmanila for bringing this up!).

I agree that we should probably change the name of all settings together (the builtins- prefix is redundant), and going through a deprecation period. Let's add the new names for the settings (and add a deprecation message for the old ones) in the next patch release after v0.9. We can then add a hard error on using the old names for the settings from v0.11.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
configuration Related to settings and configuration help wanted Contributions especially welcome
Projects
None yet
Development

No branches or pull requests

3 participants