fix(defaults): add non-capitalized default constants back and deprecated warning

relates #1446

Author: bearomorphism

commitizen/defaults.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import pathlib
+import warnings
 from collections import OrderedDict
 from collections.abc import Iterable, MutableMapping, Sequence
 from typing import Any, TypedDict
@@ -153,3 +154,31 @@ def get_tag_regexes(
         **{f"${k}": v for k, v in regexs.items()},
         **{f"${{{k}}}": v for k, v in regexs.items()},
     }
+
+
+def __getattr__(name: str) -> Any:
+    # PEP-562: deprecate module-level variable
+
+    # {"deprecated key": (value, "new key")}
+    deprecated_vars = {
+        "bump_pattern": (BUMP_PATTERN, "BUMP_PATTERN"),
+        "bump_map": (BUMP_MAP, "BUMP_MAP"),
+        "bump_map_major_version_zero": (
+            BUMP_MAP_MAJOR_VERSION_ZERO,
+            "BUMP_MAP_MAJOR_VERSION_ZERO",
+        ),
+        "bump_message": (BUMP_MESSAGE, "BUMP_MESSAGE"),
+        "change_type_order": (CHANGE_TYPE_ORDER, "CHANGE_TYPE_ORDER"),
+        "encoding": (ENCODING, "ENCODING"),
+        "name": (DEFAULT_SETTINGS["name"], "DEFAULT_SETTINGS['name']"),
+    }
+    if name not in deprecated_vars:
+        value, replacement = deprecated_vars[name]
+        warnings.warn(
+            f"{name} is deprecated and will be removed in a future version. "
+            f"Use {replacement} instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return value
+    raise AttributeError(f"{name} is not an attribute of {__name__}")

tests/test_defaults.py

@@ -0,0 +1,31 @@
+import pytest
+
+from commitizen import defaults
+
+
+def test_getattr_deprecated_vars():
+    # Test each deprecated variable
+    with pytest.warns(DeprecationWarning) as record:
+        assert defaults.bump_pattern == defaults.BUMP_PATTERN
+        assert defaults.bump_map == defaults.BUMP_MAP
+        assert (
+            defaults.bump_map_major_version_zero == defaults.BUMP_MAP_MAJOR_VERSION_ZERO
+        )
+        assert defaults.bump_message == defaults.BUMP_MESSAGE
+        assert defaults.change_type_order == defaults.CHANGE_TYPE_ORDER
+        assert defaults.encoding == defaults.ENCODING
+        assert defaults.name == defaults.DEFAULT_SETTINGS["name"]
+
+    # Verify warning messages
+    assert len(record) == 7
+    for warning in record:
+        assert "is deprecated and will be removed in a future version" in str(
+            warning.message
+        )
+
+
+def test_getattr_non_existent():
+    # Test non-existent attribute
+    with pytest.raises(AttributeError) as exc_info:
+        _ = defaults.non_existent_attribute
+    assert "is not an attribute of" in str(exc_info.value)