Skip to content

docs(defaults): deprecate type Questions #1533

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 10, 2025
Merged

docs(defaults): deprecate type Questions #1533

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions commitizen/defaults.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@

from commitizen.question import CzQuestion

# Type
Questions = Iterable[MutableMapping[str, Any]] # TODO: deprecate this?


class CzSettings(TypedDict, total=False):
bump_pattern: str
Expand Down Expand Up @@ -161,6 +158,10 @@ def get_tag_regexes(
}


# Type
Questions = Iterable[MutableMapping[str, Any]] # TODO: remove this in v5


def __getattr__(name: str) -> Any:
# PEP-562: deprecate module-level variable

Expand All @@ -176,6 +177,7 @@ def __getattr__(name: str) -> Any:
"change_type_order": (CHANGE_TYPE_ORDER, "CHANGE_TYPE_ORDER"),
"encoding": (ENCODING, "ENCODING"),
"name": (DEFAULT_SETTINGS["name"], "DEFAULT_SETTINGS['name']"),
"Questions": (Questions, "Iterable[CzQuestion]"),
}
if name in deprecated_vars:
value, replacement = deprecated_vars[name]
Expand Down