feat(version): add MANUAL_VERSION, --next and --patch to version command, remove type alias

Author: bearomorphism

commitizen/bump.py

@@ -15,7 +15,7 @@
 ifTYPE_CHECKING:
 fromcollections.abcimportGenerator, Iterable
 
-fromcommitizen.version_schemesimportIncrement, Version
+fromcommitizen.version_schemesimportIncrement, VersionProtocol
 
 VERSION_TYPES= [None, PATCH, MINOR, MAJOR]
 
@@ -131,8 +131,8 @@ def _resolve_files_and_regexes(
 
 
 defcreate_commit_message(
-current_version: Version|str,
-new_version: Version|str,
+current_version: VersionProtocol|str,
+new_version: VersionProtocol|str,
 message_template: str|None=None,
 ) ->str:
 ifmessage_templateisNone:

commitizen/cli.py

@@ -20,6 +20,7 @@
 InvalidCommandArgumentError,
 NoCommandFoundError,
 )
+fromcommitizen.version_incrementimportVersionIncrement
 
 logger=logging.getLogger(__name__)
 
@@ -505,54 +506,79 @@ def __call__(
 {
 "name": ["version"],
 "description": (
-"get the version of the installed commitizen or the current project"
-" (default: installed commitizen)"
+"Shows version of Commitizen or the version of the current project. "
+"Combine with other options to simulate the version increment process and play with the selected version scheme. "
+"If no arguments are provided, just show the installed Commitizen version."
  ),
 "help": (
-"get the version of the installed commitizen or the current project"
-" (default: installed commitizen)"
+"Shows version of Commitizen or the version of the current project. "
+"Combine with other options to simulate the version increment process and play with the selected version scheme."
  ),
 "func": commands.Version,
 "arguments": [
 {
 "name": ["-r", "--report"],
-"help": "get system information for reporting bugs",
+"help": "Get system information for reporting bugs",
 "action": "store_true",
 "exclusive_group": "group1",
  },
 {
 "name": ["-p", "--project"],
-"help": "get the version of the current project",
+"help": "Get the version of the current project",
 "action": "store_true",
 "exclusive_group": "group1",
  },
 {
 "name": ["-c", "--commitizen"],
-"help": "get the version of the installed commitizen",
+"help": "Get the version of the installed commitizen",
 "action": "store_true",
 "exclusive_group": "group1",
  },
 {
 "name": ["-v", "--verbose"],
 "help": (
-"get the version of both the installed commitizen "
+"Get the version of both the installed commitizen "
 "and the current project"
  ),
 "action": "store_true",
 "exclusive_group": "group1",
  },
 {
 "name": ["--major"],
-"help": "get just the major version. Need to be used with --project or --verbose.",
+"help": "Output the major version only. Need to be used with MANUAL_VERSION, --project or --verbose.",
 "action": "store_true",
 "exclusive_group": "group2",
  },
 {
 "name": ["--minor"],
-"help": "get just the minor version. Need to be used with --project or --verbose.",
+"help": "Output the minor version only. Need to be used with MANUAL_VERSION, --project or --verbose.",
 "action": "store_true",
 "exclusive_group": "group2",
  },
+{
+"name": ["--patch"],
+"help": "Output the patch version only. Need to be used with MANUAL_VERSION, --project or --verbose.",
+"action": "store_true",
+"exclusive_group": "group2",
+ },
+{
+"name": ["--next"],
+"help": "Output the next version.",
+"type": str,
+"nargs": "?",
+"default": None,
+"const": "USE_GIT_COMMITS",
+"choices": ["USE_GIT_COMMITS"]
++ [str(increment) forincrementinVersionIncrement],
+"exclusive_group": "group2",
+ },
+{
+"name": "manual_version",
+"type": str,
+"nargs": "?",
+"help": "Use the version provided instead of the version from the project. Can be used to test the selected version scheme.",
+"metavar": "MANUAL_VERSION",
+ },
  ],
  },
  ],

commitizen/commands/init.py

@@ -13,7 +13,11 @@
 fromcommitizen.defaultsimportCONFIG_FILES, DEFAULT_SETTINGS
 fromcommitizen.exceptionsimportInitFailedError, NoAnswersError
 fromcommitizen.gitimportget_latest_tag_name, get_tag_names, smart_open
-fromcommitizen.version_schemesimportKNOWN_SCHEMES, Version, get_version_scheme
+fromcommitizen.version_schemesimport (
+KNOWN_SCHEMES,
+VersionProtocol,
+get_version_scheme,
+)
 
 ifTYPE_CHECKING:
 fromcommitizen.configimport (
@@ -238,7 +242,7 @@ def _ask_version_scheme(self) -> str:
  ).unsafe_ask()
 returnscheme
 
-def_ask_major_version_zero(self, version: Version) ->bool:
+def_ask_major_version_zero(self, version: VersionProtocol) ->bool:
 """Ask for setting: major_version_zero"""
 ifversion.major>0:
 returnFalse
@@ -295,7 +299,7 @@ def _write_config_to_file(
 cz_name: str,
 version_provider: str,
 version_scheme: str,
-version: Version,
+version: VersionProtocol,
 tag_format: str,
 update_changelog_on_bump: bool,
 major_version_zero: bool,

commitizen/commands/version.py

@@ -2,21 +2,31 @@
 importsys
 fromtypingimportTypedDict
 
+frompackaging.versionimportInvalidVersion
+
 fromcommitizenimportout
 fromcommitizen.__version__import__version__
 fromcommitizen.configimportBaseConfig
 fromcommitizen.exceptionsimportNoVersionSpecifiedError, VersionSchemeUnknown
 fromcommitizen.providersimportget_provider
+fromcommitizen.version_incrementimportVersionIncrement
 fromcommitizen.version_schemesimportget_version_scheme
 
 
 classVersionArgs(TypedDict, total=False):
+manual_version: str|None
+next: str|None
+
+# Exclusive groups 1
 commitizen: bool
 report: bool
 project: bool
 verbose: bool
+
+# Exclusive groups 2
 major: bool
 minor: bool
+patch: bool
 
 
 classVersion:
@@ -41,24 +51,53 @@ def __call__(self) -> None:
 ifself.arguments.get("verbose"):
 out.write(f"Installed Commitizen Version: {__version__}")
 
-ifnotself.arguments.get("commitizen") and (
-self.arguments.get("project") orself.arguments.get("verbose")
+ifself.arguments.get("commitizen"):
+out.write(__version__)
+return
+
+if (
+self.arguments.get("project")
+orself.arguments.get("verbose")
+orself.arguments.get("next")
+orself.arguments.get("manual_version")
  ):
+version_str=self.arguments.get("manual_version")
+ifversion_strisNone:
+try:
+version_str=get_provider(self.config).get_version()
+exceptNoVersionSpecifiedError:
+out.error("No project information in this project.")
+return
 try:
-version=get_provider(self.config).get_version()
-exceptNoVersionSpecifiedError:
-out.error("No project information in this project.")
-return
-try:
-version_scheme=get_version_scheme(self.config.settings)(version)
+version_scheme=get_version_scheme(self.config.settings)
 exceptVersionSchemeUnknown:
 out.error("Unknown version scheme.")
 return
 
+try:
+version=version_scheme(version_str)
+exceptInvalidVersion:
+out.error(f"Invalid version: '{version_str}'")
+return
+
+ifnext_increment_str:=self.arguments.get("next"):
+ifnext_increment_str=="USE_GIT_COMMITS":
+# TODO: implement this
+raiseNotImplementedError("USE_GIT_COMMITS is not implemented")
+
+next_increment=VersionIncrement.safe_cast(next_increment_str)
+# TODO: modify the interface of bump to accept VersionIncrement
+version=version.bump(increment=str(next_increment)) # type: ignore[arg-type]
+
 ifself.arguments.get("major"):
-version=f"{version_scheme.major}"
-elifself.arguments.get("minor"):
-version=f"{version_scheme.minor}"
+out.write(version.major)
+return
+ifself.arguments.get("minor"):
+out.write(version.minor)
+return
+ifself.arguments.get("patch"):
+out.write(version.micro)
+return
 
 out.write(
 f"Project Version: {version}"
@@ -67,11 +106,12 @@ def __call__(self) -> None:
  )
 return
 
-ifself.arguments.get("major") orself.arguments.get("minor"):
-out.error(
-"Major or minor version can only be used with --project or --verbose."
- )
-return
+forargumentin ("major", "minor", "patch"):
+ifself.arguments.get(argument):
+out.error(
+f"{argument} can only be used with MANUAL_VERSION, --project or --verbose."
+ )
+return
 
 # If no arguments are provided, just show the installed commitizen version
 out.write(__version__)

commitizen/out.py

@@ -9,35 +9,35 @@
 sys.stdout.reconfigure(encoding="utf-8")
 
 
-defwrite(value: str, *args: object) ->None:
+defwrite(value: object, *args: object) ->None:
 """Intended to be used when value is multiline."""
 print(value, *args)
 
 
-defline(value: str, *args: object, **kwargs: Any) ->None:
+defline(value: object, *args: object, **kwargs: Any) ->None:
 """Wrapper in case I want to do something different later."""
 print(value, *args, **kwargs)
 
 
-deferror(value: str) ->None:
-message=colored(value, "red")
+deferror(value: object) ->None:
+message=colored(str(value), "red")
 line(message, file=sys.stderr)
 
 
-defsuccess(value: str) ->None:
-message=colored(value, "green")
+defsuccess(value: object) ->None:
+message=colored(str(value), "green")
 line(message)
 
 
-definfo(value: str) ->None:
-message=colored(value, "blue")
+definfo(value: object) ->None:
+message=colored(str(value), "blue")
 line(message)
 
 
-defdiagnostic(value: str) ->None:
+defdiagnostic(value: object) ->None:
 line(value, file=sys.stderr)
 
 
-defwarn(value: str) ->None:
-message=colored(value, "magenta")
+defwarn(value: object) ->None:
+message=colored(str(value), "magenta")
 line(message, file=sys.stderr)

commitizen/tags.py

@@ -14,17 +14,14 @@
 fromcommitizen.version_schemesimport (
 DEFAULT_SCHEME,
 InvalidVersion,
-Version,
-VersionScheme,
+VersionProtocol,
 get_version_scheme,
 )
 
 ifTYPE_CHECKING:
 importsys
 fromcollections.abcimportIterable, Sequence
 
-fromcommitizen.version_schemesimportVersionScheme
-
 # Self is Python 3.11+ but backported in typing-extensions
 ifsys.version_info< (3, 11):
 fromtyping_extensionsimportSelf
@@ -75,15 +72,15 @@ class TagRules:
  assert not rules.is_version_tag("warn1.0.0", warn=True) # Does warn
 
  assert rules.search_version("# My v1.0.0 version").version == "1.0.0"
- assert rules.extract_version("v1.0.0") == Version("1.0.0")
+ assert rules.extract_version("v1.0.0") == VersionProtocol("1.0.0")
  try:
  assert rules.extract_version("not-a-v1.0.0")
  except InvalidVersion:
  print("Does not match a tag format")
  ```
  """
 
-scheme: VersionScheme=DEFAULT_SCHEME
+scheme: type[VersionProtocol]=DEFAULT_SCHEME
 tag_format: str=DEFAULT_SETTINGS["tag_format"]
 legacy_tag_formats: Sequence[str] =field(default_factory=list)
 ignored_tag_formats: Sequence[str] =field(default_factory=list)
@@ -145,7 +142,7 @@ def get_version_tags(
 """Filter in version tags and warn on unexpected tags"""
 return [tagfortagintagsifself.is_version_tag(tag, warn)]
 
-defextract_version(self, tag: GitTag) ->Version:
+defextract_version(self, tag: GitTag) ->VersionProtocol:
 """
  Extract a version from the tag as defined in tag formats.
 
@@ -211,7 +208,7 @@ def search_version(self, text: str, last: bool = False) -> VersionTag | None:
 returnVersionTag(version, match.group(0))
 
 defnormalize_tag(
-self, version: Version|str, tag_format: str|None=None
+self, version: VersionProtocol|str, tag_format: str|None=None
  ) ->str:
 """
  The tag and the software version might be different.
@@ -241,7 +238,7 @@ def normalize_tag(
  )
 
 deffind_tag_for(
-self, tags: Iterable[GitTag], version: Version|str
+self, tags: Iterable[GitTag], version: VersionProtocol|str
  ) ->GitTag|None:
 """Find the first matching tag for a given version."""
 version=self.scheme(version) ifisinstance(version, str) elseversion