update doc and docstring

add more unittest

README.md

@@ -3,46 +3,30 @@
 
 ![](docs-static/Library.jpg)
 
-# Python project template
+#pyGitVersionHelper
 
-A nice template to start a blank python projet.
- 
-This template automate a lot of handy things and allow CI/CD automatic releases generation.
+a tiny library to help versioning management of git python project 
 
-It is also collectings data to feed Jenkins build.
-
-Checkout [Latest Documentation](https://chacha.ddns.net/mkdocs-web/chacha/pychachadummyproject/{{branch}}/latest/).
+Checkout [Latest Documentation](https://chacha.ddns.net/mkdocs-web/chacha/pygitversionhelper/{{branch}}/latest/).
 
 ## Features
-
-### Generic pipeline skeleton:
-    - Prepare
-    - GetCode
-    - BuildPackage
-    - Install
-    - CheckCode
-    - PlotMetrics
-    - RunUnitTests
-    - GenDOC
-    - PostRelease
+    - list tags
+    - get last tag 
+    - get last version
+    - get current version (bump)
+    - convert / switch from SemVer to PEP440 (both ways)
+    - automatic version format detection (SemVer by default)
     
-### CI/CD Environment
-    - Jenkins
-    - Gitea (with patch for dynamic Readme variables: https://chacha.ddns.net/gitea/chacha/GiteaMarkupVariable)
-    - Docker
-    - MkDocsWeb
-    
-### CI/CD Helper libs
-    - VirtualEnv
-    - Changelog generation based on commits
-    - copier
-    - pylint + pylint_json2html
-    - mypy
-    - unittest + xmlrunner + junitparser + junit2htmlreport
-    - mkdocs
+# Options:
+    - restrict to same branch
+    - both SemVer and PEP440 support
+    - custom output format
+    - configurable default bump type major, minor, patch or dev
+    - configurable default bump type: post, pre-patch, pre-minor, pre-major
+    - ignore non-version tag
+    - force version format
 
-### Python project
-    - Full .toml implementation
-    - .whl automatic generation
-    - dynamic versionning using git repository
-    - embedded unit-test
+# Process:
+    - CI/CD developpment: Gitea / Jenkins + few python libs
+    - Generated documentation through mkdocs
+    - CI/CD on Linux, manually tested in Windows environnement

docs-static/usage.md

@@ -1,16 +1,105 @@
 # Usage
 
-## Pulvinar dolor
-Donec dapibus est fermentum justo volutpat condimentum. Integer quis nunc neque. Donec dictum vehicula justo, in facilisis ex tincidunt in. 
-Vivamus sollicitudin sem dui, id mollis orci facilisis ut. Proin sed pulvinar dolor. Donec volutpat commodo urna imperdiet pulvinar. Fusce eget aliquam risus. 
-Vivamus viverra luctus ex, in finibus mi. Nullam elementum dapibus mollis. Ut suscipit volutpat ex, quis feugiat lacus consectetur eu. 
+## Installation
+From master repository:
 
-## Condimentum faucibus
-Quisque auctor egestas sem, luctus suscipit ex maximus vitae. Duis facilisis augue et condimentum faucibus. 
-Donec cursus, enim a sagittis egestas, lectus lorem eleifend libero, at tincidunt leo magna at libero. 
-Nunc eros velit, suscipit luctus tempor vel, finibus et est. Curabitur efficitur pretium pulvinar. 
-Donec urna lectus, vulputate quis turpis sed, placerat congue urna. Phasellus aliquet fermentum quam, non auctor elit porta nec. Morbi eu ligula at nisl ultricies condimentum vitae id ante. 
+    python -m pip install git+https://chacha.ddns.net/gitea/chacha/pygitversionhelper.git@master
 
-## Aliquam lacinia
-In volutpat lorem ex, et fringilla nibh faucibus quis. Mauris et arcu elementum, auctor dui vitae, egestas arcu. Duis sit amet aliquam quam. 
-Phasellus a odio turpis. Etiam tristique mi eu enim varius, eget facilisis est vestibulum. Aliquam lacinia nec purus sed luctus. Cras at laoreet erat. 
+From local .whl file:
+
+    python -m pip install pygitversionhelper-<VERSION>-py3-none-any.whl
+
+From public repository:
+
+    TBD
+
+## Import in your project
+Add this line on the top of your python script:
+
+    #from pygitversionhelper import gitversionhelper
+
+(optionnal)If you need to catch exception from this module:
+
+    #from pygitversionhelper import gitversionhelperException
+    
+## Basic API
+All the API commands are static and so it is not needed to create instantiate any object.
+
+They are all executed in the current active directory.
+
+One easy way to change directory:
+
+    import os
+    os.chdir("<YOUR DIRECTORY>")
+
+### sublib: repository 
+To check if a repository is dirty:
+
+    if gitversionhelper.repository.isDirty():
+        print("repository is dirty")
+
+### sublib: tag 
+List all tags (default to taggerdate order):
+
+    for tag in gitversionhelper.tag.getTags():
+        print(f"found tag: {tag}")
+        
+List all tags (using git refname order):
+
+    for tag in gitversionhelper.tag.getTags("v:refname"):
+        print(f"found tag: {tag}")
+
+Get the last tag:
+
+    print(f"most recent repository tag: {gitversionhelper.tag.getLastTag()}")
+    
+Get the last tag (only on same branch):
+
+    print(f"most recent repository tag: {gitversionhelper.tag.getLastTag(same_branch=True)}")
+
+
+Get the distance from HEAD to last tag:
+
+    print(f"number of commit since last tag: {gitversionhelper.tag.getDistanceFromTag()}")
+
+Get the distance from HEAD to last tag (only on same branch):
+
+    print(f"number of commit since last tag: {gitversionhelper.tag.getDistanceFromTag(same_branch=True)}")
+    
+### sublib: version 
+Get the last found version in the repository (return MetaVersion object):
+
+    print(f"most recent repository version: {gitversionhelper.tag.getLastVersion()}")
+    
+Get the last found version in the repository (return formated string):
+
+    print(f"most recent repository version: {gitversionhelper.tag.getLastVersion(formated_output=True)}")
+
+Others kwargs available to this function:
+    - version_std: string to force a version standard for rendering ("PEP440" or "SemVer")
+    - same_branch: boolean to force searching on same branch
+    - ignore_unknown_tags: boolean to allow unknown tag to be ignored
+
+Get the current version of the repository, including bumped one if the last one is not tagged (return MetaVersion object):
+
+    print(f"most recent repository version: {gitversionhelper.tag.getCurrentVersion()}")
+    
+kwargs available to this function:
+    - All same args as getLastVersion()
+    - bump_type: if version need to be pump, allow to configure next release update type: major, minor, patch, dev
+    - bump_dev_strategy: if bump_type is dev, allow to choose dev update strategy: post, pre-patch, pre-minor, pre-major
+
+A version object can also be manually formated:
+
+    _version = gitversionhelper.tag.getCurrentVersion()
+    _version.doFormatVersion()
+    #or
+    gitversionhelper.version.doFormatVersion(_version)
+
+kwargs available to those function:
+    - output_format: string to choose a rendering format ("Auto","PEP440" or "SemVer")
+
+##Limitations
+- MultiThreading and async behavior is not tested.
+- Multiple tag on the same commit is not supported.
+- Branch filter when searching for a version is only tested with -no-ff strategy

helpers/quality_check.py

@@ -61,7 +61,7 @@ class quality_check(helper_withresults_base):
                             '--ignore=_version.py',
                             '--reports=y',
                             '--score=yes',
-                            '--max-line-length=120',
+                            '--max-line-length=140',
                             'src.' + cls.pyproject['project']['name']], exit=False)
                 
             with open(cls.get_result_dir()/"report.json","w+", encoding='utf-8') as Outfile:

pyproject.toml

@@ -13,7 +13,7 @@ build-backend = "setuptools.build_meta"
 [tool.setuptools-git-versioning]
 enabled = true
 dev_template    = "{tag}.post{ccount}"
-#tag_filter      = "^\\d+\\.\\d+\\.\\d+$"
+tag_filter      = "^\\d+\\.\\d+\\.\\d+$"
 
 [project]
 name = "pygitversionhelper"

src/pygitversionhelper/__init__.py

@@ -19,4 +19,4 @@ except PackageNotFoundError: # pragma: no cover
     warnings.warn("can not read __version__, assuming local test context, setting it to ?.?.?")
     __version__ = "?.?.?"
 
-from .gitversionhelper import gitversionhelper
+from .gitversionhelper import gitversionhelper, gitversionhelperException

src/pygitversionhelper/gitversionhelper.py

@@ -1,244 +1,556 @@
+# pygitversionhelper (c) by chacha
+#
+# pygitversionhelper  is licensed under a
+# Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Unported License.
+#
+# You should have received a copy of the license along with this
+# work.  If not, see <https://creativecommons.org/licenses/by-nc-sa/4.0/>.
+
+"""
+This project try to help doing handy operations with git when 
+dealing with project versioning and tags on python project -
+at leat for project using PEP440 or SemVer standards.
+
+One requirement is to keep it compact and to not cover too much fancy features.
+This is the reason why it is one single file with nested classes.
+=> Design is on-purpose poorly expandable to keep the scope light.
+
+This library is maid for repository using tag as version.
+Support for non-version tags is optional and not well tested.
+
+This module is the main project file, containing all the code.
+
+Read the read me for more information.
+Check the unittest s for usage samples.
+
+Note:
+    Other Parameters are **kwargs
+"""
+
 from __future__ import annotations
 
 import os
 import subprocess
-from packaging.version import VERSION_PATTERN as packaging_VERSION_PATTERN
 import re
-from dataclasses import dataclass
 from copy import copy
+import logging
+
+from packaging.version import VERSION_PATTERN as packaging_VERSION_PATTERN
 
 def _exec(cmd: str, root: str | os.PathLike | None = None) -> list[str]:
-    try:
-        stdout = subprocess.check_output(cmd, shell=True, text=True, cwd=root)
-    except subprocess.CalledProcessError as e:
-        stdout = e.output
-    lines = stdout.splitlines()
+    """
+    helper function to handle system cmd execution
+    Args:
+        cmd: command line to be executed
+        root: root directory where the command need to be executed
+    Returns:
+        a list of command's return lines
+        
+    """
+    p = subprocess.run(cmd.split(), text=True, cwd=root, capture_output=True, check=False, timeout=2)
+    if re.search("not a git repository",p.stderr):
+        raise gitversionhelper.repository.notAGitRepository()
+    if re.search("fatal:",p.stderr):    #pragma: nocover
+        raise gitversionhelper.unknownGITFatalError(p.stderr)
+    if int(p.returncode) < 0:           #pragma: nocover
+        raise gitversionhelper.unknownGITError(p.stderr)
+    lines = p.stdout.splitlines()
     return [line.rstrip() for line in lines if line.rstrip()]
 
-class gitversionhelper:
-    class head:
+class gitversionhelperException(Exception):
+    """
+    general Module Exception
+    """
+
+class gitversionhelper: # pylint: disable=too-few-public-methods
+    """
+    main gitversionhelper class
+    """
+    class wrongArguments(gitversionhelperException):
+        """
+        wrong argument generic exception
+        """
+
+    class unknownGITError(gitversionhelperException):
+        """
+        unknown git error generic exception
+        """
+
+    class unknownGITFatalError(unknownGITError):
+        """
+        unknown fatal git error generic exception
+        """
+
+    class repository:
+        """
+        class containing methods focusing on repository
+        """
+        class repositoryException(gitversionhelperException):
+            """
+            generic repository exeption
+            """
+
+        class notAGitRepository(repositoryException):
+            """
+            not a git repository exception
+            """
+
+        class repositoryDirty(repositoryException):
+            """
+            dirty repository exception
+            """
+
         @classmethod
-        def isDirty(cls):
-            return True if _exec(f"git status --short") else False
-            
+        def isDirty(cls) -> bool:
+            """
+            check if the repository is in dirty state
+            Returns:
+                True if it is dirty
+            """
+            return bool(_exec("git status --short"))
+
     class tag:
+        """
+        class containing methods focusing on tags
+        """
         __OptDict = {"same_branch": "same_branch"}
-        @classmethod
-        def getTags(cls,sort:str = "version:refname"):
-            return _exec(f"git tag -l --sort={sort}")
+        __validGitTagSort=["","v:refname","-v:refname","taggerdate","committerdate","-taggerdate","-committerdate"]
+
+        class tagException(gitversionhelperException):
+            """
+            generic tag exception
+            """
+
+        class tagNotFound(tagException):
+            """
+            tag not found exception
+            """
+
+        class moreThanOneTag(tagException):
+            """
+            more than one tag exception
+            """
 
         @classmethod
-        def getLastTag(cls,**kwargs):
-            if ((cls.__OptDict["same_branch"] in kwargs) and (kwargs[cls.__OptDict["same_branch"]]==True)):
-                return _exec(f"git describe --tags --abbrev=0")[0]
-            else:    
-                tag = _exec("git rev-list --tags --max-count=1")
-                return _exec(f"git describe --tags {tag[0]}")[0]
+        def getTags(cls,sort:str = "taggerdate",**kwargs) -> list[str]:
+            """
+            retrieve all tags from a repository
+            Args:
+                sort: sorting constraints (git format)
+            Returns:
+                the tags list
+            """
+
+            if sort not in cls.__validGitTagSort:
+                raise gitversionhelper.wrongArguments("sort option not in allowed list")
+
+            if ((cls.__OptDict["same_branch"] in kwargs) and (kwargs[cls.__OptDict["same_branch"]] is True)):
+                currentBranch = _exec("git rev-parse --abbrev-ref HEAD")
+                return list(reversed(_exec(f"git tag --merged {currentBranch[0]} --sort={sort}")))
+            return list(reversed(_exec(f"git tag -l --sort={sort}")))
 
         @classmethod
-        def getDistanceFromLastTag(cls,tag=None,**kwargs):
-            if (tag == None):
+        def getLastTag(cls,**kwargs) -> str | None:
+            """
+            retrieve the last tag from a repository
+            Keyword Arguments:
+                same_branch(bool): force searching only in the same branch
+            Returns:
+                the tag
+            """
+            if ((cls.__OptDict["same_branch"] in kwargs) and (kwargs[cls.__OptDict["same_branch"]] is True)):
+                res = _exec("git describe --tags --first-parent --abbrev=0")
+            else:
+                res = _exec("git rev-list --tags --date-order --max-count=1")
+                if len(res)==1:
+                    res = _exec(f"git describe --tags {res[0]}")
+
+            if len(res)==0:
+                raise cls.tagNotFound("no tag found in commit history")
+            if len(res)!=1: #pragma: nocover
+                raise cls.moreThanOneTag("multiple tags on same commit is unsupported")
+            return res[0]
+
+        @classmethod
+        def getDistanceFromTag(cls,tag:str=None,**kwargs) -> int:
+            """
+            retrieve the distance between HEAD and tag in the repository
+            Arguments:
+                tag: reference tag, if None the most recent one will be used
+            Keyword Arguments:
+                same_branch(bool): force searching only in the same branch
+            Returns:
+                the tag
+            """
+            if tag is None:
                 tag = cls.getLastTag(**kwargs)
-            return _exec(f"git rev-list {tag}..HEAD --count")[0]
-        
+            return int(_exec(f"git rev-list {tag}..HEAD --count")[0])
+
     class version:
+        """
+        class containing methods focusing on versions
+        """
         __OptDict = {   "version_std":      "version_std",
                         "formated_output":  "formated_output",
-                        "output_format":    "output_format"}
-        DefaultInputFormat = "PEP440"
-        VersionStds    = { "SemVer" : { "regex" :               r"^(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"},
-                           "PEP440" : { "regex" :               packaging_VERSION_PATTERN }
+                        "output_format":    "output_format",
+                        "ignore_unknown_tags":  "ignore_unknown_tags"}
+        DefaultInputFormat = "Auto"
+        VersionStds    = { "SemVer" : { "regex" :               r"^(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)"\
+                                                                r"(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)"\
+                                                                r"(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?"\
+                                                                r"(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$",
+                                        "regex_preversion_num": r"(?:\.)(?P<num>(?:\d+(?!\w))+)",
+                                        "regex_build_num"     : r"(?:\.)(?P<num>(?:\d+(?!\w))+)"
+                                                                },
+                           "PEP440" : { "regex" :               packaging_VERSION_PATTERN,
+                           "Auto"   : None
+                           }
         }
-        
+        __versionReseted = False
+        class versionException(gitversionhelperException):
+            """
+            generic version exception
+            """
+
+        class noValidVersion(versionException):
+            """
+            no valid version found exception
+            """
+
+        class PreAndPostVersionUnsupported(versionException):
+            """
+            pre and post release can not be present at the same time
+            """
+
         class MetaVersion:
             """
             generic version object
             """
-            __OptDict                   = {   "bump_type":              "bump_type",
-                                             "bump_dev_strategy":      "bump_dev_strategy"}
+
+            __OptDict                   = {  "bump_type":            "bump_type",
+                                             "bump_dev_strategy":    "bump_dev_strategy",
+                                             "formated_output":      "formated_output"}
             DefaultBumpType             = "patch"
             BumpTypes                   = ["major","minor","patch","dev"]
             DefaultBumpDevStrategy      = "post"
-            BumpDevStrategys            = ["post","pre","force_post","force_pre"]
-            major: int      = 0
-            minor: int      = 1
-            patch: int      = 0
-            pre_count:int   = 0
-            post_count:int  = 0
-            raw:str         = "0.1.0"
-            
-            def __init__(self,major,minor,patch,pre_count,post_count,raw):
-                self.major,self.minor,self.patch,self.pre_count,self.post_count,self.raw = major,minor,patch,pre_count,post_count,raw
-                
+            BumpDevStrategys            = ["post","pre-patch","pre-minor","pre-major"]
+
+            version_std: str    = "None"
+            major: int          = 0
+            minor: int          = 1
+            patch: int          = 0
+            pre_count:int       = 0
+            post_count:int      = 0
+            raw:str             = "0.1.0"
+
+            def __init__(self,version_std,major=0,minor=1,patch=0,pre_count=0,post_count=0,raw="0.1.0"): #pylint: disable=R0913
+                self.version_std = version_std
+                self.major       = major
+                self.minor       = minor
+                self.patch       = patch
+                self.pre_count   = pre_count
+                self.post_count  = post_count
+                self.raw         = raw
+
             @classmethod
-            def _getBumpDevStrategy(cls,**kwargs):
+            def _getBumpDevStrategy(cls,**kwargs) -> str:
                 """
                 get selected bump_dev_strategy
+                Keyword Arguments:
+                    bump_dev_strategy(str): the given bump_dev_strategy (can be None)
+                Returns:
+                    Kwargs given bump_dev_strategy or the default one.
                 """
                 BumpDevStrategy = cls.DefaultBumpDevStrategy
-                if (cls.__OptDict["bump_dev_strategy"] in kwargs):
+                if cls.__OptDict["bump_dev_strategy"] in kwargs:
                     if kwargs[cls.__OptDict["bump_dev_strategy"]] in cls.BumpDevStrategys:
                         BumpDevStrategy = kwargs[cls.__OptDict["bump_dev_strategy"]]
                     else:
-                        raise RuntimeError(f"invalid {cls.__OptDict['bump_type']} requested")
+                        raise gitversionhelper.wrongArguments(f"invalid {cls.__OptDict['bump_type']} requested")
                 return BumpDevStrategy
-            
+
             @classmethod
-            def _getBumpType(cls,**kwargs):
+            def _getBumpType(cls,**kwargs) -> str:
                 """
                 get selected bump_type
+                Keyword Arguments:
+                    bump_type(str): the given bump_type (can be None)
+                Returns:
+                    Kwargs given bump_type or the default one.
                 """
                 BumpType = cls.DefaultBumpType
-                if (cls.__OptDict["bump_type"] in kwargs):
+                if cls.__OptDict["bump_type"] in kwargs:
                     if kwargs[cls.__OptDict["bump_type"]] in cls.BumpTypes:
                         BumpType = kwargs[cls.__OptDict["bump_type"]]
                     else:
-                        raise RuntimeError(f"invalid {cls.__OptDict['bump_type']} requested")
+                        raise gitversionhelper.wrongArguments(f"invalid {cls.__OptDict['bump_type']} requested")
                 return BumpType
-            
-            def bump(self,**kwargs):
+
+            def bump(self,amount:int=1,**kwargs) -> gitversionhelper.version.MetaVersion | str : # pylint: disable=R0912
+                """
+                bump the version to the next one
+                Keyword Arguments:
+                    bump_type(str): the given bump_type (can be None)
+                    bump_dev_strategy(str): the given bump_dev_strategy (can be None)
+                Returns:
+                    the bumped version
+                """
                 BumpType = self._getBumpType(**kwargs)
                 BumpDevStrategy=self._getBumpDevStrategy(**kwargs)
                 _v=copy(self)
+
                 if BumpType == "dev":
-                    if BumpDevStrategy=="post":
+                    if BumpDevStrategy == "post":
                         if _v.pre_count > 0:
-                            _v.pre_count = _v.pre_count + 1
+                            _v.pre_count = _v.pre_count + amount
                         else:
-                            _v.post_count = _v.post_count + 1
-                    elif BumpDevStrategy=="pre":
+                            _v.post_count = _v.post_count + amount
+                    #elif BumpDevStrategy in ["pre-patch","pre-minor","pre-major"]:
+                    else:
                         if _v.post_count > 0:
-                            _v.post_count = _v.post_count + 1
+                            _v.post_count = _v.post_count + amount
                         else:
-                            _v.pre_count = _v.pre_count + 1
-                    elif BumpDevStrategy=="force_post":
-                        pass
-                    elif BumpDevStrategy=="force_pre":
-                        pass
+                            if _v.pre_count == 0:
+                                if BumpDevStrategy == "pre-patch":
+                                    _v.patch = _v.patch + 1
+                                elif BumpDevStrategy == "pre-minor":
+                                    _v.minor = _v.minor + 1
+                                    _v.patch = 0
+                                #elif BumpDevStrategy == "pre-major":
+                                else:
+                                    _v.major = _v.major + 1
+                                    _v.minor = 0
+                                    _v.patch = 0
+                            _v.pre_count = _v.pre_count + amount
                 else:
                     if BumpType == "major":
-                        _v.major = _v.major + 1
+                        _v.major = _v.major + amount
                     elif BumpType == "minor":
-                        _v.minor = _v.minor + 1
-                    elif BumpType == "patch":
-                        _v.patch = _v.patch + 1
+                        _v.minor = _v.minor + amount
+                    #elif BumpType == "patch":
+                    else:
+                        _v.patch = _v.patch + amount
                     _v.pre_count=0
                     _v.post_count=0
-                
-                _v.raw="{major}.{minor}.{patch}".format(major=_v.major,minor=_v.minor,patch=_v.patch,revpattern="",revcount="")
+                _v.raw=_v.doFormatVersion(**kwargs)
+
+                if ((self.__OptDict["formated_output"] in kwargs) and (kwargs[self.__OptDict["formated_output"]] is True)):
+                    return _v.doFormatVersion(**kwargs)
                 return _v
-            
-            def doFormatVersion(self,**kwargs):
+
+            def doFormatVersion(self,**kwargs) -> str:
+                """
+                output a formated version string
+                Keyword Arguments:
+                    output_format: output format to render ("Auto" or "PEP440" or "SemVer")
+                Returns:
+                    formated version string
+                """
                 return gitversionhelper.version.doFormatVersion(self,**kwargs)
-            
+
         @classmethod
-        def _getVersionStd(cls,**kwargs):
+        def _getVersionStd(cls,**kwargs) -> str:
             """
             get selected version_std
+            Keyword Arguments:
+                version_std(str): the given version_std (can be None)
+            Returns:
+                Kwargs given version_std or the default one.
             """
             VersionStd = cls.DefaultInputFormat
-            if (cls.__OptDict["version_std"] in kwargs):
+            if cls.__OptDict["version_std"] in kwargs:
                 if kwargs[cls.__OptDict["version_std"]] in cls.VersionStds:
                     VersionStd = kwargs[cls.__OptDict["version_std"]]
                 else:
-                    raise RuntimeError(f"invalid {cls.__OptDict['version_std']} requested")
+                    raise gitversionhelper.wrongArguments(f"invalid {cls.__OptDict['version_std']} requested")
             return VersionStd
-            
+
         @classmethod
-        def getLastVersion(cls,**kwargs):
+        def getCurrentVersion(cls,**kwargs) -> MetaVersion | str :
             """
-            get last version from git tags
+            get the current version or bump depending of repository state
+            Keyword Arguments:
+                version_std(str): the given version_std (can be None)
+                same_branch(bool): force searching only in the same branch
+                formated_output(bool) : output a formated version string
+                bump_type(str): the given bump_type (can be None)
+                bump_dev_strategy(str): the given bump_dev_strategy (can be None)
+            Returns:
+                the last version
+            """
+            if gitversionhelper.repository.isDirty() is not False:
+                raise gitversionhelper.repository.repositoryDirty(  "The repository is dirty and a current version" \
+                                                                    " can not be generated.")
+            saved_kwargs = copy(kwargs)
+            if "formated_output" in kwargs:
+                del saved_kwargs["formated_output"]
+
+            _v = cls.getLastVersion(**saved_kwargs)
+
+            if not cls.__versionReseted:
+                amount  = gitversionhelper.tag.getDistanceFromTag(_v.raw,**kwargs)
+                _v = _v.bump(amount,**saved_kwargs)
+
+            if ((cls.__OptDict["formated_output"] in kwargs) and (kwargs[cls.__OptDict["formated_output"]] is True)):
+                return _v.doFormatVersion(**kwargs)
+            return _v
+
+        @classmethod
+        def _parseTag(cls,tag,**kwargs): # pylint: disable=R0914, R0912, R0915
+            """get the last version from tags
+            Arguments:
+                tag: the tag to be parsed
+            Keyword Arguments:
+                version_std(str): the given version_std (can be None)
+                ignore_unknown_tags(bool): skip tags with not decoded versions (default to False)
+            Returns:
+                the last version
             """
             VersionStd = cls._getVersionStd(**kwargs)
-            _r=re.compile(r"^\s*" + cls.VersionStds[VersionStd]["regex"] + r"\s*$", re.VERBOSE | re.IGNORECASE)
-            
-            lastTag = gitversionhelper.tag.getLastTag(**kwargs)
-            
-            _m = re.match(_r,lastTag)
-            if not _m:
-                raise RuntimeError("no valid version found in tags")
-            if VersionStd == "PEP440":
-                ver=_m.group("release").split(".")
-                ver += ["0"] * (3 - len(ver))
-                ver[0]=int(ver[0])
-                ver[1]=int(ver[1])
-                ver[2]=int(ver[2])
-                major, minor, patch = tuple(ver)
-                pre_count  = int(_m.group("pre_n")) if _m.group("pre_n") else 0
-                post_count = int(_m.group("post_n2")) if _m.group("post_n2") else 0
-            elif VersionStd == "SemVer":
-                major, minor, patch = int(_m.group("major")),int(_m.group("minor")),int(_m.group("patch")),(_m.group("prerelease") if _m.group("prerelease") else ""), ""
-                pre_count  = 0
-                post_count = 0
-                
-            _v = cls.MetaVersion(major, minor, patch,  pre_count,  post_count, lastTag)
-            
-            if ((cls.__OptDict["formated_output"] in kwargs) and (kwargs[cls.__OptDict["formated_output"]]==True)):
-                return cls.doFormatVersion(_v,**kwargs)
-            else:
-                return _v
-        
+            bAutoVersionStd = False
+            if VersionStd == "Auto":
+                bAutoVersionStd = True
+            bFound = False
+            if VersionStd == "SemVer" or (bAutoVersionStd is True) :
+                _r=re.compile(r"^\s*" + cls.VersionStds["SemVer"]["regex"] + r"\s*$",   re.VERBOSE | \
+                                                                                        re.IGNORECASE)
+                _m = re.match(_r,tag)
+                if not _m:
+                    pass
+                else:
+                    major, minor, patch =   int(_m.group("major")),\
+                                            int(_m.group("minor")),\
+                                            int(_m.group("patch"))
+
+                    pre_count = 0
+                    if _pre := _m.group("prerelease"):
+                        if (_match := re.search (cls.VersionStds["SemVer"]["regex_preversion_num"],_pre)) is not None:
+                            pre_count = int(_match.group("num"))
+                        else:
+                            pre_count = 1
+
+                    post_count = 0
+                    if _post := _m.group("buildmetadata"):
+                        if (_match := re.search (cls.VersionStds["SemVer"]["regex_build_num"],_post)) is not None:
+                            post_count = int(_match.group("num"))
+                        else:
+                            post_count = 1
+                    bFound = True
+                    VersionStd = "SemVer"
+
+            if VersionStd == "PEP440" or ( (bAutoVersionStd is True)  and (bFound is not True)):
+                _r=re.compile(r"^\s*" + cls.VersionStds["PEP440"]["regex"] + r"\s*$",   re.VERBOSE | \
+                                                                                        re.IGNORECASE)
+                _m = re.match(_r,tag)
+                if not _m:
+                    pass
+                else:
+                    ver=_m.group("release").split(".")
+                    ver += ["0"] * (3 - len(ver))
+                    ver[0]=int(ver[0])
+                    ver[1]=int(ver[1])
+                    ver[2]=int(ver[2])
+                    major, minor, patch = tuple(ver)
+                    pre_count  = int(_m.group("pre_n")) if _m.group("pre_n") else 0
+                    post_count = int(_m.group("post_n2")) if _m.group("post_n2") else 0
+                    bFound = True
+                    VersionStd = "PEP440"
+
+            if not bFound :
+                raise gitversionhelper.version.noValidVersion("no valid version found in tags")  
+    
+            if pre_count > 0 and post_count > 0:
+                raise cls.PreAndPostVersionUnsupported("can not parse a version with both pre" \
+                                                       " and post release number.")
+            return cls.MetaVersion(VersionStd, major, minor, patch, pre_count, post_count, tag)
+
         @classmethod
-        def doFormatVersion(cls,inputversion:MetaVersion,**kwargs):
+        def getLastVersion(cls,**kwargs) -> MetaVersion | str : # pylint: disable=R0914, R0912, R0915
+            """get the last version from tags
+            Keyword Arguments:
+                version_std(str): the given version_std (can be None)
+                same_branch(bool): force searching only in the same branch
+                formated_output(bool) : output a formated version string
+                ignore_unknown_tags(bool): skip tags with not decoded versions (default to False)
+            Returns:
+                the last version
             """
-            output a formated version
+            lastTag=cls.MetaVersion.raw
+            cls.__versionReseted = False
+            try:
+                lastTag = gitversionhelper.tag.getLastTag(**kwargs)
+            except gitversionhelper.tag.tagNotFound:
+                logging.warning('tag not found, reseting versionning')
+                cls.__versionReseted = True
+
+            _v=None
+            try:
+                _v=cls._parseTag(lastTag,**kwargs)
+            except gitversionhelper.version.noValidVersion as _ex:
+                if ((cls.__OptDict["ignore_unknown_tags"] in kwargs) and (kwargs[cls.__OptDict["ignore_unknown_tags"]] is True)):
+                    tags = gitversionhelper.tag.getTags(sort= "taggerdate",**kwargs)
+                    _v = None
+                    for _tag in tags:
+                        try:
+                            _v=cls._parseTag(_tag,**kwargs)
+                            break
+                        except gitversionhelper.version.noValidVersion:
+                            continue
+                if _v is None:
+                    raise gitversionhelper.version.noValidVersion() from _ex
+
+            if ((cls.__OptDict["formated_output"] in kwargs) and (kwargs[cls.__OptDict["formated_output"]] is True)):
+                return _v.doFormatVersion(**kwargs)
+            return _v
+
+        @classmethod
+        def doFormatVersion(cls,inputversion:MetaVersion,**kwargs) -> str:
             """
+            output a formated version string
+            Keyword Arguments:
+                output_format: output format to render ("Auto" or "PEP440" or "SemVer")
+            Args:
+                inputversion: version to be rendered
+            Returns:
+                formated version string
+            """
+
             VersionStd = cls._getVersionStd(**kwargs)
-            
+            if VersionStd=="Auto" :
+                VersionStd = inputversion.version_std
+
             OutputFormat = None
             revpattern=""
             revcount=""
             post_count = inputversion.post_count
             pre_count  = inputversion.pre_count
             patch      = inputversion.patch
-            if (cls.__OptDict["output_format"] in kwargs):
+
+            if cls.__OptDict["output_format"] in kwargs:
                 OutputFormat=kwargs[cls.__OptDict["output_format"]]
-            if OutputFormat == None:
+
+            if OutputFormat is None:
+                OutputFormat = "{major}.{minor}.{patch}{revpattern}{revcount}"
+                if post_count > 0 and pre_count > 0:
+                    raise gitversionhelper.version.PreAndPostVersionUnsupported("cannot output a version with both pre " \
+                                                                                "and post release number.")
                 if      VersionStd == "PEP440":
-                    OutputFormat = "{major}.{minor}.{patch}{revpattern}{revcount}"
                     if post_count > 0:
                         revpattern=".post"
                         revcount=f"{post_count}"
-                elif    VersionStd == "SemVer":
-                    OutputFormat = "{major}.{minor}.{patch}{revpattern}{revcount}"
-                    if post_count > 0:
-                        pre_count = pre_count + post_count
-                        post_count = 0
-                        patch = patch + 1
-                    if pre_count > 0:
-                        revpattern="-pre"
+                    elif pre_count > 0:
+                        revpattern=".pre"
                         revcount=f"{pre_count}"
-
-            return OutputFormat.format(major=inputversion.major,minor=inputversion.minor,patch=patch,revpattern=revpattern,revcount=revcount)
-
-        
-
-
-
-#print(gitversionhelper.head.isDirty())
-#print(gitversionhelper.tag.getTags())
-#print(gitversionhelper.tag.getLastTag())
-#print(gitversionhelper.tag.getLastTag(same_branch=True))
-#print(gitversionhelper.tag.getDistanceFromLastTag())
-#print(gitversionhelper.tag.getDistanceFromLastTag(same_branch=True))
-
-#print(gitversionhelper.version.getLastVersion())
-#print(gitversionhelper.version.getLastVersion(same_branch=True,version_std="PEP440"))
-#print(gitversionhelper.version.getLastVersion(same_branch=True,version_std="PEP440"))
-#print(gitversionhelper.version.getLastVersion(same_branch=False,version_std="PEP440"))
-#print(gitversionhelper.version.getLastVersion(same_branch=True,version_std="PEP440",formated_output=True))
-#print(gitversionhelper.version.getLastVersion(same_branch=True,version_std="PEP440",formated_output=True,output_format="v{major}.{minor}.{patch}"))
-#print(gitversionhelper.version.getLastVersion(same_branch=False,version_std="PEP440").bump())
-#print("")
-#print(gitversionhelper.version.getLastVersion(same_branch=False,version_std="PEP440").bump(bump_type="dev").doFormatVersion(version_std="SemVer"))
-#print(gitversionhelper.version.getLastVersion(same_branch=False,version_std="PEP440").bump(bump_type="patch").doFormatVersion(version_std="SemVer"))
-#print(gitversionhelper.version.getLastVersion(same_branch=False,version_std="PEP440").bump(bump_type="minor").doFormatVersion(version_std="SemVer"))
-#print(gitversionhelper.version.getLastVersion(same_branch=False,version_std="PEP440").bump(bump_type="major").doFormatVersion(version_std="SemVer"))
-#print("")
-#print(gitversionhelper.version.getLastVersion(same_branch=False,version_std="PEP440").bump(bump_type="dev").doFormatVersion(version_std="PEP440"))
-#print(gitversionhelper.version.getLastVersion(same_branch=False,version_std="PEP440").bump(bump_type="patch").doFormatVersion(version_std="PEP440"))
-#print(gitversionhelper.version.getLastVersion(same_branch=False,version_std="PEP440").bump(bump_type="minor").doFormatVersion(version_std="PEP440"))
-#print(gitversionhelper.version.getLastVersion(same_branch=False,version_std="PEP440").bump(bump_type="major").doFormatVersion(version_std="PEP440"))
-
-#from setuptools_git_versioning import version_from_git
-#print(str(version_from_git(tag_filter="^\d+\.\d+\.\d+$",dev_template = "{tag}.post{ccount}",sort_by="v:refname")),end ="")
+                #elif    VersionStd == "SemVer":
+                else:
+                    if post_count > 0:
+                        revpattern="+post"
+                        revcount=f".{post_count}"
+                    elif pre_count > 0:
+                        revpattern="-pre"
+                        revcount=f".{pre_count}"
+            return OutputFormat.format( major=inputversion.major, \
+                                        minor=inputversion.minor, \
+                                        patch=patch,              \
+                                        revpattern=revpattern,    \
+                                        revcount=revcount)