revert to static readme file... :-/

score all /10

.project

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <projectDescription>
-	<name>gitversionhelper</name>
+	<name>pygitversionhelper</name>
 	<comment></comment>
 	<projects>
 	</projects>

Jenkinsfile

@@ -6,6 +6,14 @@
 // 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/>.
 
+import groovy.xml.XmlUtil
+import static javax.xml.xpath.XPathConstants.*
+import javax.xml.xpath.*
+import groovy.xml.DOMBuilder
+import groovy.xml.dom.DOMCategory
+import java.math.RoundingMode
+import java.math.BigDecimal
+
 // configurable settings:
 // use to send email if workflow problem
 def _MaintainerName		     = "CHACHA"
@@ -17,12 +25,19 @@ def _bPreRelease		     = false
 // toogle Draft flag on Gitea release system => If False, TAG is not created
 def _bDraft				     = false
 // release content / changelog management
-def _bAutoChangelog		     = false //Not supported yet
+def _bAutoChangelog		     = true //Not supported yet
 def _ReleaseContent_Title	 = "_CI/CD Automatic Release_"
+def bPushMasterOnPypi        = true
 // full rebuild toogle
 def _bFullRebuilt		     = true
 def _MkDocsWebURL            = "dabauto--mkdocs-web.dmz.chacha.home/mkdocs-web/"
 def _MkDocsWebCredentials    = "2c5b684e-3787-4b37-8aca-b3dd4a383fe2" 
+def _PypiCredentials         = "Pypi"
+
+
+def badge_coverage          = addEmbeddableBadgeConfiguration(id: "coverage",   subject: "coverage")
+def badge_maintainability   = addEmbeddableBadgeConfiguration(id: "maintainability", subject: "maintainability")
+def badge_quality           = addEmbeddableBadgeConfiguration(id: "quality",    subject: "quality score")
 
 // commands Helper: /!\ Made for GITEA /!\
 String determineRepoUserName() {
@@ -59,6 +74,46 @@ String ExtractBaseVersion(inVersion) {
     return matcher[0][1]
 }
 
+int GetCoverageValue(String CoverageFilePath,String XPath)
+{ 
+  //File file = new File(CoverageFilePath)
+  //coverageReportRaw = file.getText('UTF-8')
+  coverageReportRaw = readFile(CoverageFilePath)
+  coverageReport = DOMBuilder.parse(new StringReader(coverageReportRaw), false, false)
+  coverageReportRoot = coverageReport.documentElement
+  
+  def xpath = XPathFactory.newInstance().newXPath()
+  res = xpath.evaluate(XPath,coverageReportRoot,NUMBER)
+  return res
+}
+
+String getColorScale(BigDecimal value)
+{
+  if( value >9)         { return "Goldenrod"}
+  else if( value >6)    { return "seagreen"}
+  else if( value >4)    { return "orange"}
+  else if( value >2)    { return "darkred"}
+  else                  { return "dimgrey"}
+}
+
+String getColorScale_reversed(BigDecimal value)
+{
+  if( value >9)         { return "dimgrey"}
+  else if( value >6)    { return "darkred"}
+  else if( value >4)    { return "orange"}
+  else if( value >2)    { return "seagreen"}
+  else                  { return "Goldenrod"}
+}
+
+int GetCoverageValue_lines_valid(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@lines-valid") }
+int GetCoverageValue_lines_covered(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@lines-covered") }
+int GetCoverageValue_line_rate(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@line-rate") }
+int GetCoverageValue_branches_valid(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@branches-valid") }
+int GetCoverageValue_branches_covered(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@branches-covered") }
+int GetCoverageValue_branch_rate(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@branch-rate") }
+int GetCoverageValue_complexity(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@complexity") }
+
+
 pipeline {
 	
 	// for Docker based build (preferable)
@@ -94,12 +149,12 @@ pipeline {
 		PY_PROJECT_VERSION                = "__NOTSET__"
         PY_PROJECT_VERSION_STRIPPED       = "__NOTSET__"
 	}
-
+    
 	stages {
-	
+	   
 		stage("Prepare") {
 			steps {
-				script{
+				script {
 					if (_bFullRebuilt) {
 						// start by cleaning the workspace (not using cleanWs() because we want to keep the directory itself)
 						// => this is needed to fetch it again with custom options 
@@ -108,8 +163,7 @@ pipeline {
 					else {
 						sh("find ~/. -name . ! -path './TEST_ENV/*' ! -path './BUILD_ENV/*'  -o -prune -exec rm -rf -- {} +")
 					}
-                    if(_GIT_BRANCH!="master")
-                    {
+                    if(_GIT_BRANCH!="master") {
                         _bPreRelease = true
                     }
 				}
@@ -120,51 +174,114 @@ pipeline {
 				echo("_GITEA_BASE_URL: . . . . . . . . $_GITEA_BASE_URL")
                 echo("GIT_COMMIT:. . . . . . . . . . . $GIT_COMMIT  ")
 				echo("_PROJECT_USER_NAME:. . . . . . . $_PROJECT_USER_NAME")
-				echo("_GITEA_PROJECT_NAME: . . . . . . $_PROJECT_NAME")
+				echo("_PROJECT_NAME: . . . . . . . . . $_PROJECT_NAME")
 				echo("_MaintainerEmail:. . . . . . . . $_MaintainerEmail") 
 				echo("_MaintainerName:. . . . . . . .  $_MaintainerName") 
-
+                
 				sh("virtualenv --pip=embed --setuptools=embed --wheel=embed --no-periodic-update --activators bash,python BUILD_ENV")
 				sh("virtualenv --pip=embed --setuptools=embed --wheel=embed --no-periodic-update --activators bash,python TEST_ENV")
+                sh("virtualenv --pip=embed --setuptools=embed --wheel=embed --no-periodic-update --activators bash,python TOOLS_ENV")
 				
-				sh(". ~/BUILD_ENV/bin/activate && pip install --upgrade setuptools build pip copier jinja2-slug toml \"setuptools-git-versioning<2\"")
-				
-
+				sh(". ~/BUILD_ENV/bin/activate && pip install --upgrade setuptools build pip copier jinja2-slug toml")
 				
+                sh(". ~/TOOLS_ENV/bin/activate && pip install simple_rest_client requests twine")
+                
+                script {
+                    if(_PROJECT_NAME!="pygitversionhelper") {
+                        sh(". ~/TOOLS_ENV/bin/activate && pip install pygitversionhelper")
+                    }
+                    else
+                    {   
+                        //TODO: need to install pygitversionhelper deps from a better way...
+                        sh(". ~/TOOLS_ENV/bin/activate && pip install packaging")
+                    }
+                }
+                sh("git config --global user.email $_MaintainerEmail")
+                sh("git config --global user.name  $_MaintainerName")	
+                sh("git config --global init.defaultBranch master")
+                
 			}
 		}
-
+        
 		stage("GetCode") {
 			steps {
 				dir("gitrepo") {
-					// manually checkout the repository, with All branches and tags
+					// manually checkout the repository, with All branches and tags 
 					// => because we might need them for version and changelog computing
                     checkout([ $class: "GitSCM", 
                                branches: [[name: GIT_BRANCH]], 
                                extensions: [[$class: "CloneOption", noTags: false, shallow: false, depth: 0, reference: '']], 
                                userRemoteConfigs: [[credentialsId: _SCMCredentials, url: GIT_URL]]])
-                    script{
-                        if(_GIT_BRANCH=="master")
-                        {
-                            if(sh(returnStdout:  true, script: "git tag --points-at HEAD").trim().isEmpty())
-                            {
-                                error("master push/merge must have an explicit tag release number")
+                    script {
+
+                        withCredentials([usernamePassword(credentialsId: _SCMCredentials, passwordVariable: 'GIT_PASSWORD', usernameVariable: 'GIT_USERNAME')]) {
+                            sh("git remote set-url origin https://${GIT_USERNAME}:${GIT_PASSWORD}@chacha.ddns.net/gitea/${_PROJECT_USER_NAME}/${_PROJECT_NAME}.git")
+                        }
+                                      
+                        if(_GIT_BRANCH=="master") {
+                            if(sh(returnStdout:  true, script: "git tag --points-at HEAD").trim().isEmpty()) {
+
+                                BUMPED_VERSION = sh(script:  """#!/bin/sh -
+                                                                 |. ~/TOOLS_ENV/bin/activate
+                                                                 |exec python - << '__EOWRAPPER__'
+                                                                 |
+                                                                 |import re
+                                                                 |
+                                                                 |try:
+                                                                 |    from pygitversionhelper import gitversionhelper
+                                                                 |except ImportError:
+                                                                 |    from src.pygitversionhelper import gitversionhelper
+                                                                 |
+                                                                 |lastcommit=gitversionhelper.commit.getLast(same_branch=True)
+                                                                 |msg=gitversionhelper.commit.getMessage(lastcommit)
+                                                                 |
+                                                                 |_match=re.search(r"\\s*(?:#)?\\s*(?<=new-tag:)(?:\\s*)(?P<TAG>\\S*)",msg)
+                                                                 |print(_match.group("TAG"),end="")
+                                                                 |
+                                                                 |__EOWRAPPER__
+                                                              """.stripMargin(),
+                                                               returnStdout: true).trim()
+
+                                if(BUMPED_VERSION.isEmpty()) {
+                                    echo "master push/merge must have an explicit tag release number, stopping pipeline"
+                                    currentBuild.getRawBuild().getExecutor().doStop()
+                                }
+                                else {
+                                    echo "new-tag requested in commit message: $BUMPED_VERSION"
+
+                                    sh("git tag $BUMPED_VERSION")
+                                    sh("git push origin --tags")
+                                }
                             }
                         }
-                    
-                        // using git to get the latest tag on this branch 
-                        def latestTag = sh(returnStdout:  true, script: "git tag --sort=-creatordate | head -n 1").trim()
+                                               
+                        latestTag = sh(script:   """#!/bin/sh -
+                                                     |. ~/TOOLS_ENV/bin/activate
+                                                     |exec python - << '__EOWRAPPER__'
+                                                     |
+                                                     |try:
+                                                     |    from pygitversionhelper import gitversionhelper
+                                                     |except ImportError:
+                                                     |    from src.pygitversionhelper import gitversionhelper
+                                                     |
+                                                     |print(gitversionhelper.tag.getLastTag(same_branch=True),end ="")
+                                                     |
+                                                     |__EOWRAPPER__
+                                                  """.stripMargin(),
+                                       returnStdout: true)
                         echo("latestTag:. . . . . . . . . . . . $latestTag  ")
                         
-                        // using setuptools_git_versioning to get the generated version number based on Git tags and logs
-                        // TODO: read dev_template from toml
+                        // get current (or bumped) version number from git history
                         PY_PROJECT_VERSION = sh(script:   """#!/bin/sh -
-                                                             |. ~/BUILD_ENV/bin/activate
+                                                             |. ~/TOOLS_ENV/bin/activate
                                                              |exec python - << '__EOWRAPPER__'
                                                              |
-                                                             |from setuptools_git_versioning import version_from_git
+                                                             |try:
+                                                             |    from pygitversionhelper import gitversionhelper
+                                                             |except ImportError:
+                                                             |    from src.pygitversionhelper import gitversionhelper
                                                              |
-                                                             |print(str(version_from_git(tag_filter="^\\d+\\.\\d+\\.\\d+\$",dev_template = "{tag}.post{ccount}")),end ="")
+                                                             |print(gitversionhelper.version.getCurrentVersion(formated_output=True,version_std="PEP440",bump_type="dev",bump_dev_strategy="post"),end ="")
                                                              |
                                                              |__EOWRAPPER__
                                                           """.stripMargin(),
@@ -172,13 +289,16 @@ pipeline {
                         echo("PY_PROJECT_VERSION: . . . . . . . . . $PY_PROJECT_VERSION")
                         PY_PROJECT_VERSION_STRIPPED=ExtractBaseVersion(PY_PROJECT_VERSION)
                         
+                        // Manually pushing a new tag with version string guessed by gitversionhelper 
+                        // because setuptools-git-versioning / setuptools_scm cant fing tag on other branches, so will guess a wrong version without this tag.
+                        if(latestTag!=PY_PROJECT_VERSION) {
+                            sh("git tag $PY_PROJECT_VERSION")
+                            sh("git push origin --tags")
+                        }
+                        
                         // specific handling to test the template itself 
                         // => little hacky... creating a new git repo with a commit/tag corresponding to HEAD of the official one
-                        if(_PROJECT_NAME=="pyChaChaDummyProject")  //specific case to test the template itself
-                        {
-							sh("git config --global user.email $_MaintainerEmail")
-							sh("git config --global user.name  $_MaintainerName")
-
+                        if(_PROJECT_NAME=="pyChaChaDummyProject") { //specific case to test the template itself
 							sh("rm -Rf ~/_gitrepo  || true")
 							
                             sh(script:    """#!/bin/sh -
@@ -239,7 +359,7 @@ pipeline {
 			steps {
 				// no need for a build-env: setuptools is already creating one
 				dir("gitrepo") {
-					script{
+					script {
 						// actually doing the package build
 						sh(". ~/BUILD_ENV/bin/activate && python -m build .")
 					}
@@ -255,7 +375,7 @@ pipeline {
 						def wheelPath = findFiles(glob: "**/dist/*.whl")[0]
 						echo "wheel artifact path: $wheelPath"
 						// install the package, with *test* optionnal packages, as user
-						sh(". ~/TEST_ENV/bin/activate && pip install --find-links dist/ ${PY_PROJECT_NAME} .[test,coverage-check,quality-check,type-check,doc-gen]")
+						sh(". ~/TEST_ENV/bin/activate && pip install --find-links dist/ ${PY_PROJECT_NAME} .[test,coverage-check,quality-check,type-check,doc-gen,complexity-check]")
 					}
 				}
 			}
@@ -265,19 +385,27 @@ pipeline {
             steps {
                 dir("gitrepo") {
                     sh(". ~/TEST_ENV/bin/activate && python -m helpers --type-check --quality-check")
+                    script {
+                        def jsonObj = readJSON file: "helpers-results/quality_check/metrics.json"
+                        quality_score = new BigDecimal(jsonObj["GlobalScore"])
+                        sz_quality_score = quality_score.setScale(2, RoundingMode.HALF_EVEN).toString()
+                        badge_quality.setStatus(sz_quality_score)
+                        badge_quality.setColor(getColorScale(quality_score))
+                    }
+                    sh(". ~/TEST_ENV/bin/activate && python -m helpers --complexity-check")
                 }
             }
             post {
-                    always {      
-                        dir("gitrepo") {                              
-                        publishHTML([
-                                    reportDir:              "helpers-results/quality_check",
-                                    reportFiles:            "report.html",
-                                    reportName:             "quality-report",
-                                    allowMissing:           false,
-                                    alwaysLinkToLastBuild:  true,
-                                    keepAll:                true])    
-                       }         
+                always {      
+                    dir("gitrepo") {                              
+                    publishHTML([
+                                reportDir:              "helpers-results/quality_check",
+                                reportFiles:            "report.html",
+                                reportName:             "quality-report",
+                                allowMissing:           false,
+                                alwaysLinkToLastBuild:  true,
+                                keepAll:                true])    
+                   }         
                 }
             }
         }
@@ -319,6 +447,14 @@ pipeline {
                         style: 'stackedArea',
                         keepRecords: true,
                         numBuilds: ''])
+                        
+                 plot([ csvFileName: 'plot-4ceb9ee2-ca78-11ed-afa1-0242ac120002.csv',
+                        csvSeries: [[ file: 'gitrepo/helpers-results/complexity_check/MI.csv', inclusionFlag: 'INCLUDE_BY_STRING',exclusionValues: 'MeanMaintainability', url: '']],
+                        group: 'metrics',
+                        title: 'maintainability',
+                        style: 'stackedArea',
+                        keepRecords: true,
+                        numBuilds: ''])
             }
         }
         
@@ -331,6 +467,36 @@ pipeline {
                         println unit_test_full_name__html
                         unit_test_full_name__xml=findFiles(glob:  "helpers-results/unit_test_full/*.xml")[0].getName()
                         println unit_test_full_name__xml
+                        
+                        coverage_report_path = "helpers-results/unit_test_coverage/test_coverage.xml"
+                        println GetCoverageValue_lines_valid(coverage_report_path)
+                        println GetCoverageValue_lines_covered(coverage_report_path)
+                        println GetCoverageValue_line_rate(coverage_report_path)
+                        println GetCoverageValue_branches_valid(coverage_report_path)
+                        println GetCoverageValue_branches_covered(coverage_report_path)
+                        println GetCoverageValue_branch_rate(coverage_report_path)
+                        println GetCoverageValue_complexity(coverage_report_path)
+                        
+                        full_rate = new BigDecimal( 10*(GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 )
+                        sz_full_rate = full_rate.setScale(2, RoundingMode.HALF_EVEN).toString()
+                        badge_coverage.setStatus(sz_full_rate)
+                        badge_coverage.setColor(getColorScale(full_rate))
+                        
+                        //complexity = new BigDecimal( 10*GetCoverageValue_complexity(coverage_report_path))
+                        //sz_complexity = complexity.setScale(2, RoundingMode.HALF_EVEN).toString()
+                        //badge_complexity.setStatus(sz_complexity)
+                        //badge_quality.setColor(getColorScale_reversed(complexity))
+                        
+                        //badge_maintainability
+                        records = readCSV file: 'helpers-results/complexity_check/MI.csv'
+                        maintainability = records[1][1]
+                        badge_maintainability.setStatus(maintainability)
+                        
+                        if     ( maintainability == 'D')  { badge_maintainability.setColor(  "dimgrey")}
+                        else if( maintainability == 'C')  { badge_maintainability.setColor(  "darkred")}
+                        else if( maintainability == 'B')  { badge_maintainability.setColor(  "orange")}
+                        else if( maintainability == 'A')  { badge_maintainability.setColor(  "seagreen")}
+                        else if( maintainability == 'A+') { badge_maintainability.setColor(  "Goldenrod")} 
                     }
                 }
 			}
@@ -387,20 +553,27 @@ pipeline {
 				def GITEA_LOGIN_TOKEN=credentials("GiteaCHACHAPush")
 			}
 			steps {
-				sh("python3 -m pip install simple_rest_client requests")
 				dir("gitrepo") {
 					script {
 						def CurrentDateTime=java.time.LocalDateTime.now()
-						withCredentials([string( credentialsId: _MkDocsWebCredentials,variable: 'MKDOCSTOKEN' )]) 
-						{
-						sh(script: 	"""#!/usr/bin/env python3
-										|from simple_rest_client.api import API
-										|from simple_rest_client.resource import Resource
+						withCredentials([string( credentialsId: _MkDocsWebCredentials,variable: 'MKDOCSTOKEN' )]) {
+                        sh(script:   """#!/bin/sh -
+                                        |. ~/TOOLS_ENV/bin/activate
+                                        |exec python - << '__EOWRAPPER__'
+                                        |
 										|import json
 										|import glob
 										|import requests
 										|import shutil
 										|
+                                        |from simple_rest_client.api import API
+                                        |from simple_rest_client.resource import Resource
+                                        |
+                                        |try:
+                                        |    from pygitversionhelper import gitversionhelper
+                                        |except ImportError:
+                                        |    from src.pygitversionhelper import gitversionhelper
+										|
 										|from urllib.parse import urljoin
 										|
 										|class GiteaRepoCommits(Resource):
@@ -477,9 +650,18 @@ pipeline {
                                         |response=requests.post("http://${_MkDocsWebURL}/API.php?REQ=pushDoc",data=reqData,files=files)
                                         |if response.status_code != 200:
                                         |   raise RuntimeError(f"Wrong server response: {response.status_code}")
-                                        | 
-									""".stripMargin())
+                                        |
+                                        |__EOWRAPPER__
+									 """.stripMargin())
 									}
+                       if((_GIT_BRANCH=="master") && (bPushMasterOnPypi)) {
+                           withCredentials([usernamePassword( credentialsId: _PypiCredentials, passwordVariable: 'PYPI_PASSWORD', usernameVariable: 'PYPI_USERNAME')]) {
+                            sh(script:   """#!/bin/sh -
+                                            |. ~/TOOLS_ENV/bin/activate
+                                            |exec twine upload -u ${PYPI_USERNAME} -p ${PYPI_PASSWORD} --non-interactive --disable-progress-bar dist/*
+                                         """.stripMargin())
+						    }
+					    }
 					}
 				}
 			}

README.md

@@ -1,5 +1,10 @@
+![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=status&status=active&color=seagreen)
+![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=doc&status=MkDocs&color=blue)
 ![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=jenkins-unittest&job={{repository}}-{{branch}})
-![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=licence&status=CC%20BY-NC-SA%204.0&color=blue)
+![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=coverage)
+![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=maintainability)
+![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=quality)
+![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=licence&status=CC%20BY-NC-SA%204.0&color=teal)
 
 ![](docs-static/Library.jpg)
 
@@ -9,8 +14,7 @@ _A tiny library to help versioning management of git python projects_
 
 Because a good developer is a lazy developer and version management in CI/CD can be very time consuming.
 
-
-Checkout [Latest Documentation](https://chacha.ddns.net/mkdocs-web/chacha/pygitversionhelper/{{branch}}/latest/).
+Checkout [Latest Documentation](https://chacha.ddns.net/mkdocs-web/chacha/{{repository}}/{{branch}}/latest/).
 
 ## Features
     - list tags
@@ -19,13 +23,14 @@ Checkout [Latest Documentation](https://chacha.ddns.net/mkdocs-web/chacha/pygitv
     - get current version (bumped)
     - convert / switch from SemVer to PEP440 (both ways)
     - automatic version format detection (SemVer by default)
-    
+    - get commit message history
+
 ## 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
+    - configurable default bump type: major, minor, patch or dev
+    - configurable default bump strategy: post, pre-patch, pre-minor, pre-major
     - ignore non-version tag
     - force version format
 

docs-static/usage.md

@@ -2,17 +2,20 @@
 
 ## Installation
 
-From master repository:
+From pypi repository (prefered):
+
+    python -m pip install pygitversionhelper
+    
+From downloaded .whl file:
+
+    python -m pip install pygitversionhelper-<VERSION>-py3-none-any.whl
+    
+From master git repository:
 
     python -m pip install git+https://chacha.ddns.net/gitea/chacha/pygitversionhelper.git@master
 
-From local .whl file:
 
-    python -m pip install pygitversionhelper-<VERSION>-py3-none-any.whl
 
-From public repository:
-
-    TBD
 
 ## Import in your project
 
@@ -75,25 +78,39 @@ Get the distance from HEAD to last tag [only on same branch]:
 
 Get the last found version in the repository [return MetaVersion object]:
 
-    print(f"most recent repository version: {gitversionhelper.tag.getLastVersion()}")
+    print(f"most recent repository version: {gitversionhelper.version.getLastVersion()}")
     
 Get the last found version in the repository [return formated string]:
 
-    print(f"most recent repository version: {gitversionhelper.tag.getLastVersion(formated_output=True)}")
+    print(f"most recent repository version: {gitversionhelper.version.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
+
+* 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, automatically bump it if the last one is not tagged [returns MetaVersion object]:
 
-    print(f"most recent repository version: {gitversionhelper.tag.getCurrentVersion()}")
+    print(f"current repository version: {gitversionhelper.version.getCurrentVersion()}")
+
+Or with formated output:
+
+    print(f"current repository version: {gitversionhelper.version.getCurrentVersion(formated_output=True)}")
     
+Typical usage in CI/CD env:
+    
+    bumped_version = gitversionhelper.version.getCurrentVersion(    formated_output=True,       \
+                                                                    version_std="PEP440",       \
+                                                                    bump_type="dev",            \
+                                                                    bump_dev_strategy="post")
+    print(f"current repository version: {bumped_version}")
+
 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
+
+* 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:
 
@@ -108,6 +125,7 @@ kwargs available to those function:
 ## Limitations
 
 There is unfortunately some technical limitation :
-- 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
+
+* 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/__main__.py

@@ -16,89 +16,101 @@ import os
 import logging
 import sys
 
-if __package__=="helpers":
+if __package__ == "helpers":
     # when calling the module from: > python -m helpers
-    from .types_check   import    types_check
-    from .quality_check import  quality_check
-    from .unit_test     import      unit_test
-    from .doc_gen       import        doc_gen
-    from .changelog_gen import  changelog_gen
-else:  
+    from .types_check import types_check
+    from .quality_check import quality_check
+    from .unit_test import unit_test
+    from .doc_gen import doc_gen
+    from .changelog_gen import changelog_gen
+    from .complexity_check import complexity_check
+else:
     # when calling the __main__.py file (from IDE)
-    from helpers.types_check import    types_check
-    from helpers.quality_check import  quality_check
-    from helpers.unit_test import      unit_test
-    from helpers.doc_gen import        doc_gen
-    from helpers.changelog_gen import  changelog_gen
-    
+    from helpers.types_check import types_check
+    from helpers.quality_check import quality_check
+    from helpers.unit_test import unit_test
+    from helpers.doc_gen import doc_gen
+    from helpers.changelog_gen import changelog_gen
+    from helpers.complexity_check import complexity_check
+
 logging.getLogger().setLevel(logging.INFO)
 
 if __name__ == "__main__":
-    project_rootdir_path=Path(__file__).parent.parent.absolute()
+    project_rootdir_path = Path(__file__).parent.parent.absolute()
 
     with open(project_rootdir_path / "pyproject.toml", mode="rb") as fp:
         pyproject = tomli.load(fp)
-    
-    parser = argparse.ArgumentParser(   prog        = 'continuous-integration-helper',
-                                        description = 'A tiny set of scripts to help continous integration on python')
-    
-    parser.add_argument('-tc',  '--type-check',     dest='typecheck',       action='store_true',    help='enable static typing check') 
-    
-    parser.add_argument('-ut',  '--unit-test',      dest='unittest',        action='store_true',    help='enable unit-test')    
-    parser.add_argument('-cc',  '--coverage-check', dest='coveragecheck',   action='store_true',    help='enable unit-test coverage check (requires unit-test)')         
 
-    parser.add_argument('-qc',  '--quality-check',  dest='qualitycheck',    action='store_true',    help='enable code quality check') 
-    
-    parser.add_argument('-dg',  '--doc-gen',        dest='docgen',          action='store_true',    help='enable documentation generation using MkDoc') 
-    parser.add_argument('-pdf', '--doc-gen-pdf',    dest='docgenpdf',       action='store_true',    help='enable pdf documentation export (requires doc-gen)') 
-    
-    parser.add_argument('-clg', '--changelog-gen',  dest='changeloggen',    action='store_true',    help='enable changelog generation')   
-    
+    parser = argparse.ArgumentParser(
+        prog="continuous-integration-helper", description="A tiny set of scripts to help continous integration on python"
+    )
+
+    parser.add_argument("-tc", "--type-check", dest="typecheck", action="store_true", help="enable static typing check")
+
+    parser.add_argument("-ut", "--unit-test", dest="unittest", action="store_true", help="enable unit-test")
+    parser.add_argument(
+        "-cc", "--coverage-check", dest="coveragecheck", action="store_true", help="enable unit-test coverage check (requires unit-test)"
+    )
+
+    parser.add_argument("-qc", "--quality-check", dest="qualitycheck", action="store_true", help="enable code quality check")
+
+    parser.add_argument("-dg", "--doc-gen", dest="docgen", action="store_true", help="enable documentation generation using MkDoc")
+    parser.add_argument(
+        "-pdf", "--doc-gen-pdf", dest="docgenpdf", action="store_true", help="enable pdf documentation export (requires doc-gen)"
+    )
+
+    parser.add_argument("-clg", "--changelog-gen", dest="changeloggen", action="store_true", help="enable changelog generation")
+
+    parser.add_argument("-cpc", "--complexity-check", dest="complexitycheck", action="store_true", help="enable complexity check")
+
     args = parser.parse_args()
-    
+
     ##################################
     # Dev / Debug forced toogles
     #
-    #--------------------------------
+    # --------------------------------
     #
-    #args.typecheck      = True
-    #args.qualitycheck   = True
-    #args.unittest       = True
-    #args.coveragecheck  = True
-    #args.docgen         = True
-    #args.docgenpdf      = True
-    #args.changeloggen   = True
-    
+    # args.typecheck      = True
+    # args.qualitycheck   = True
+    # args.unittest       = True
+    # args.coveragecheck  = True
+    # args.docgen         = True
+    # args.docgenpdf      = True
+    # args.changeloggen   = True
+    # args.complexitycheck = True
+
     helpers = []
-    if  args.typecheck == True:
+    if args.typecheck == True:
         helpers.append(types_check)
-        
-    if  args.unittest == True:
+
+    if args.unittest == True:
         helpers.append(unit_test)
-    
-    if  args.coveragecheck == True:
+
+    if args.coveragecheck == True:
         if args.unittest == True:
             unit_test.enable_coverage_check = True
         else:
             raise RuntimeError("unit-test is required to enable coverage-check")
-    
-    if  args.qualitycheck == True:
+
+    if args.qualitycheck == True:
         helpers.append(quality_check)
-        
-    if  args.docgen == True:
+
+    if args.docgen == True:
         helpers.append(doc_gen)
-    
-    if args.docgenpdf==True:
+
+    if args.docgenpdf == True:
         if args.docgen == True:
             doc_gen.enable_gen_pdf = True
         else:
             raise RuntimeError("doc-gen is required to enable doc-gen-pdf")
-        
-    if  args.changeloggen == True:
+
+    if args.changeloggen == True:
         helpers.append(changelog_gen)
-    
+
+    if args.complexitycheck == True:
+        helpers.append(complexity_check)
+
     for helper in helpers:
-        helper.set_context(project_rootdir_path,pyproject)
+        helper.set_context(project_rootdir_path, pyproject)
         helper.reset_result_dir()
         helper.do_job()
-        

helpers/changelog_gen.py

@@ -9,16 +9,15 @@
 from __future__ import annotations
 from typing import TYPE_CHECKING
 
-#from pathlib import Path
-#import os
-#import datetime
+# from pathlib import Path
+# import os
+# import datetime
 
 
 from .helper_base import helper_base
 
 
-class changelog_gen(helper_base): 
-    
-    @classmethod  
-    def do_job(cls): 
-        pass
+class changelog_gen(helper_base):
+    @classmethod
+    def do_job(cls):
+        pass

helpers/complexity_check.py

@@ -0,0 +1,70 @@
+# pyChaChaDummyProject (c) by chacha
+#
+# pyChaChaDummyProject 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/>.
+
+from __future__ import annotations
+from typing import TYPE_CHECKING
+
+# from pathlib import Path
+# import os
+import statistics
+import csv
+from json import loads as JSON_LOADS
+from radon.complexity import cc_rank, SCORE
+from radon.cli import Config
+from radon.cli.harvest import CCHarvester, HCHarvester, MIHarvester
+
+from .helper_base import helper_withresults_base
+from pprint import pprint
+
+
+class complexity_check(helper_withresults_base):
+    @classmethod
+    def do_job(cls):
+        config = Config(
+            exclude="__init__\.py",
+            ignore=None,
+            order=SCORE,
+            show_closures=False,
+            no_assert=True,
+            min="A",
+            max="F",
+            multi=False,
+        )
+
+        h = MIHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config).as_json()
+        res = JSON_LOADS(h)
+
+        with open(cls.get_result_dir() / "MI.json", "w", newline="") as oFile:
+            oFile.write(h)
+
+        mean = statistics.mean(_["mi"] for _ in res.values())
+
+        if mean >= 65:
+            rank = "A+"
+        elif mean >= 20:
+            rank = "A"
+        elif mean >= 10:
+            rank = "B"
+        else:
+            rank = "C"
+
+        RES_MI = {"MeanMaintainability": mean, "MaintainabilityIndex": rank}
+        with open(cls.get_result_dir() / "MI.csv", "w", newline="") as oFile:
+            writer = csv.DictWriter(oFile, fieldnames=RES_MI.keys())
+            writer.writeheader()
+            writer.writerow(RES_MI)
+
+        config = Config(exclude=None, ignore=None, order=SCORE, show_closures=False, no_assert=True, min="A", max="F", multi=False)
+        h = CCHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config).as_json()
+        with open(cls.get_result_dir() / "CC.json", "w", newline="") as oFile:
+            oFile.write(h)
+
+        config = Config(exclude=None, ignore=None, order=SCORE, show_closures=False, no_assert=True, min="A", max="F", by_function=None)
+        h = HCHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config).as_json()
+        with open(cls.get_result_dir() / "HC.json", "w", newline="") as oFile:
+            oFile.write(h)

helpers/doc_gen.py

@@ -17,6 +17,7 @@ from pathlib import Path
 from distutils.dir_util import copy_tree
 
 import yaml
+
 try:
     from yaml import CLoader as Loader, CDumper as Dumper
 except ImportError:
@@ -24,35 +25,34 @@ except ImportError:
 
 from .helper_base import helper_withresults_base
 
-class doc_gen(helper_withresults_base): 
+
+class doc_gen(helper_withresults_base):
     enable_gen_pdf: bool = False
-    
-    @classmethod  
-    def do_job(cls): 
-        print(cls.project_rootdir_path)
-        print()
-        
+
+    @classmethod
+    def do_job(cls):
+
         # create doc root dir
-        doc_path = cls.project_rootdir_path/"docs"
+        doc_path = cls.project_rootdir_path / "docs"
         cls._reset_dir(doc_path)
-        
-        site_path = cls.get_result_dir()/"site"
+
+        site_path = cls.get_result_dir() / "site"
         cls._reset_dir(site_path)
-        
+
         # copy files from main project dir
-        shutil.copyfile(str(cls.project_rootdir_path/"README.md"),str(doc_path/"README.md"))
-        shutil.copyfile(str(cls.project_rootdir_path/"LICENSE.md"),str(doc_path/"LICENSE.md"))
-        
+        shutil.copyfile(str(cls.project_rootdir_path / "README.md"), str(doc_path / "README.md"))
+        shutil.copyfile(str(cls.project_rootdir_path / "LICENSE.md"), str(doc_path / "LICENSE.md"))
+
         # copy files from static-doc dir
-        copy_tree(str(cls.project_rootdir_path/"docs-static"),str(doc_path))
-        
+        copy_tree(str(cls.project_rootdir_path / "docs-static"), str(doc_path))
+
         # generating API doc + nav from python docstrings
         reference_path = doc_path / "reference"
         cls._reset_dir(reference_path)
-        
+
         for path in sorted((cls.project_rootdir_path / "src").rglob("*.py")):
-            module_path = path.relative_to(cls.project_rootdir_path/ "src").with_suffix("")
-            doc_path = path.relative_to(cls.project_rootdir_path/ "src").with_suffix(".md") 
+            module_path = path.relative_to(cls.project_rootdir_path / "src").with_suffix("")
+            doc_path = path.relative_to(cls.project_rootdir_path / "src").with_suffix(".md")
             full_doc_path = Path(reference_path, doc_path)
 
             parts = list(module_path.parts)
@@ -61,43 +61,44 @@ class doc_gen(helper_withresults_base):
                 parts = parts[:-1]
             elif parts[-1] == "__main__":
                 continue
-            
+
             cls._reset_dir(os.path.dirname(full_doc_path))
             with open(full_doc_path, "w+") as fd:
-                identifier = "src."+".".join(parts)
+                identifier = "src." + ".".join(parts)
                 print("::: " + identifier, file=fd)
-  
-            
-        cmdopts = [f"{sys.executable}","-m","mkdocs","-v","build","--site-dir",str(site_path),"--clean"]
-  
+
+        cmdopts = [f"{sys.executable}", "-m", "mkdocs", "-v", "build", "--site-dir", str(site_path), "--clean"]
+
         # little hack here, to enable / disable pdf generation using own class config
-        # => reason is mkdocs seems to try loading the plugin even if we disable it, so we need to 
+        # => reason is mkdocs seems to try loading the plugin even if we disable it, so we need to
         # manually process the configuration file.
-        mkdocsCfg=None
-        with open(cls.project_rootdir_path / "mkdocs.yml",'r') as mkdocsCfgFile:
+        mkdocsCfg = None
+        with open(cls.project_rootdir_path / "mkdocs.yml", "r") as mkdocsCfgFile:
             mkdocsCfg = yaml.load(mkdocsCfgFile, Loader=yaml.SafeLoader)
-            
-            if cls.enable_gen_pdf==True:
-                mkdocsCfg['plugins'].append({   'with-pdf':{
-                                                    'cover_subtitle':   'User Manual',
-                                                    'cover_logo':       str(cls.project_rootdir_path / 'docs-static' / 'Library.jpg'),
-                                                    'verbose':          False,
-                                                    'media_type':       'print',
-                                                    'exclude_pages':    ['LICENSE'],
-                                                    'output_path':      str(site_path / 'pdf' / 'manual.pdf')  
-                                            }})
+
+            if cls.enable_gen_pdf == True:
+                mkdocsCfg["plugins"].append(
+                    {
+                        "with-pdf": {
+                            "cover_subtitle": "User Manual",
+                            "cover_logo": str(cls.project_rootdir_path / "docs-static" / "Library.jpg"),
+                            "verbose": False,
+                            "media_type": "print",
+                            "exclude_pages": ["LICENSE"],
+                            "output_path": str(site_path / "pdf" / "manual.pdf"),
+                        }
+                    }
+                )
             else:
-                for subelem in mkdocsCfg['plugins']:
-                    if isinstance(subelem,dict) :
-                        if 'with-pdf' in subelem.keys():  
-                            mkdocsCfg['plugins'].remove(subelem)
-                            break          
-            
-        with open(cls.project_rootdir_path / "mkdocs.yml",'w') as mkdocsCfgFile:
-            mkdocsCfgFile.write(yaml.dump(mkdocsCfg, Dumper=Dumper,default_flow_style=False, sort_keys=False))
-            
-        
-        res=cls.run_cmd(cmdopts)
+                for subelem in mkdocsCfg["plugins"]:
+                    if isinstance(subelem, dict):
+                        if "with-pdf" in subelem.keys():
+                            mkdocsCfg["plugins"].remove(subelem)
+                            break
+
+        with open(cls.project_rootdir_path / "mkdocs.yml", "w") as mkdocsCfgFile:
+            mkdocsCfgFile.write(yaml.dump(mkdocsCfg, Dumper=Dumper, default_flow_style=False, sort_keys=False))
+
+        res = cls.run_cmd(cmdopts)
         print(res.decode())
-        print(' !! done')
-        
+        print(" !! done")

helpers/helper_base.py

@@ -9,64 +9,66 @@
 from __future__ import annotations
 from typing import TYPE_CHECKING
 
-from abc import ABC,abstractmethod
+from abc import ABC, abstractmethod
 import os
 from pathlib import Path
 import subprocess
 
 if TYPE_CHECKING:  # Only imports the below statements during type checking
-    from typing     import Union
+    from typing import Union
+
 
 class helper_base(ABC):
-    project_rootdir_path: Union[Path,None]  = None
-    pyproject: Union[dict,None]             = None
-    current_dir: Union[Path,None]           = None
-       
-    @classmethod 
-    def set_context(cls,project_rootdir_path:Path, pyproject:dict):
-        cls.project_rootdir_path    = project_rootdir_path
-        cls.pyproject               = pyproject
-        cls.current_dir             = Path(__file__).parent.absolute()
-        
-    @classmethod    
+    project_rootdir_path: Union[Path, None] = None
+    pyproject: Union[dict, None] = None
+    current_dir: Union[Path, None] = None
+
+    @classmethod
+    def set_context(cls, project_rootdir_path: Path, pyproject: dict):
+        cls.project_rootdir_path = project_rootdir_path
+        cls.pyproject = pyproject
+        cls.current_dir = Path(__file__).parent.absolute()
+
+    @classmethod
     def get_result_dir(cls):
         return None
- 
-    @staticmethod  
-    def _reset_dir(dirpath:Path):  
+
+    @staticmethod
+    def _reset_dir(dirpath: Path):
         dirpath = Path(dirpath)
         if not os.path.exists(dirpath):
             os.makedirs(dirpath)
-        [f.unlink() for f in Path(dirpath).glob("*") if f.is_file()] 
-    
-    @classmethod    
+        [f.unlink() for f in Path(dirpath).glob("*") if f.is_file()]
+
+    @classmethod
     def reset_result_dir(cls):
         result_dir = cls.get_result_dir()
         if result_dir != None:
             cls._reset_dir(result_dir)
-    
-    @classmethod 
+
+    @classmethod
     @abstractmethod
-    def do_job(cls):  
+    def do_job(cls):
         raise NotImplementedError()
 
-    @classmethod  
+    @classmethod
     def run_cmd_(cls, cmdarray):
         process = subprocess.run(cmdarray, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True, check=True)
         return process.stdout
-    
-    @classmethod  
+
+    @classmethod
     def run_cmd(cls, cmdarray):
         p = subprocess.run(cmdarray, capture_output=True)
         print(p.stdout)
         print(p.stderr)
         return p.stdout
-    
+
+
 class helper_withresults_base(helper_base):
-    helper_results_dir: Union[Path,None] = None
-        
-    @classmethod    
+    helper_results_dir: Union[Path, None] = None
+
+    @classmethod
     def get_result_dir(cls):
-        if cls.helper_results_dir==None:
-            cls.helper_results_dir=cls.__name__
-        return Path(__file__).parent.parent.absolute() / "helpers-results" / cls.helper_results_dir
+        if cls.helper_results_dir == None:
+            cls.helper_results_dir = cls.__name__
+        return Path(__file__).parent.parent.absolute() / "helpers-results" / cls.helper_results_dir

helpers/quality_check.py

@@ -25,197 +25,222 @@ import pylint_json2html
 
 from .helper_base import helper_withresults_base
 
+
 class PyLintMetricNotFound(Warning):
     pass
 
-class quality_check(helper_withresults_base): 
-    PylintMessageList=dict()
-    
-    @classmethod  
+
+class quality_check(helper_withresults_base):
+    PylintMessageList = dict()
+
+    @classmethod
     def GetPylintMessageList(cls):
-        Messagelist=dict()
-        regex = r"^:([a-zA-Z-]+) \(([^\)]+)\)"  
-        for line in cls.run_cmd([sys.executable,"-m","pylint","--list-msgs"]).splitlines():
-            if res:=re.search(regex,line.decode()):
-                Messagelist[res.group(1)]=res.group(2)
+        Messagelist = dict()
+        regex = r"^:([a-zA-Z-]+) \(([^\)]+)\)"
+        for line in cls.run_cmd([sys.executable, "-m", "pylint", "--list-msgs"]).splitlines():
+            if res := re.search(regex, line.decode()):
+                Messagelist[res.group(1)] = res.group(2)
         cls.PylintMessageList = Messagelist
 
     @staticmethod
-    def TryExtractPYReportMetric(line: str,tag: str):
-        regex=f"^(?:\|{tag}\s*\|)(\d+)(?=\s*|)"
-        if res:=re.search(regex,line):
+    def TryExtractPYReportMetric(line: str, tag: str):
+        regex = f"^(?:\|{tag}\s*\|)(\d+)(?=\s*|)"
+        if res := re.search(regex, line):
             return float(res.group(1))
         raise PyLintMetricNotFound()
 
-    @classmethod  
-    def do_job(cls):  
+    @classmethod
+    def do_job(cls):
         print("checking code quality ...")
         cls.GetPylintMessageList()
-        
-        RES_all=dict()
+
+        RES_all = dict()
         with StringIO() as StdOutput:
-            JsonContent=""
+            JsonContent = ""
             with redirect_stdout(StdOutput):
-                pylint_Run(['--output-format=json,parseable',
-                            '--disable=invalid-name',
-                            '--ignore=_version.py',
-                            '--reports=y',
-                            '--score=yes',
-                            '--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:
+                pylint_Run(
+                    [
+                        "--load-plugins=pylint.extensions.mccabe",
+                        "--output-format=json,parseable",
+                        "--disable=invalid-name",
+                        "--ignore=_version.py",
+                        "--reports=y",
+                        "--score=yes",
+                        "--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:
                 # hacky way of exctracting json + having overall score...
                 class TScanState(Enum):
-                    TEXT_REPORT                 = 1
-                    JSON_REPORT                 = 2
-                    OTHER_REPORT_START          = 3
-                    OTHER_REPORT_STATISTICS     = 4
-                    OTHER_REPORT_METRICS        = 5
-                    OTHER_REPORT_DUPLICATION    = 6
-                    OTHER_REPORT_MESSAGES_CAT   = 7
-                    OTHER_REPORT_MESSAGES       = 8
-                    OTHER_REPORT_END            = 99
-                    
-                RES_all['Statistics']           = dict()
-                RES_all['RawMetrics']           = dict()
-                RES_all['RawMetricsPercent']    = dict()
-                RES_all['Duplication']          = dict()
-                RES_all['MessagesCat']          = dict()
-                RES_all['Messages']             = dict()
-                RES_all['GlobalScore']          = -999
-                RES_all['NbAnalysedStatments']  = -999
-                RES_all['NbAnalysedLines']      = -999
-                
+                    TEXT_REPORT = 1
+                    JSON_REPORT = 2
+                    OTHER_REPORT_START = 3
+                    OTHER_REPORT_STATISTICS = 4
+                    OTHER_REPORT_METRICS = 5
+                    OTHER_REPORT_DUPLICATION = 6
+                    OTHER_REPORT_MESSAGES_CAT = 7
+                    OTHER_REPORT_MESSAGES = 8
+                    OTHER_REPORT_END = 99
+
+                RES_all["Statistics"] = dict()
+                RES_all["RawMetrics"] = dict()
+                RES_all["RawMetricsPercent"] = dict()
+                RES_all["Duplication"] = dict()
+                RES_all["MessagesCat"] = dict()
+                RES_all["Messages"] = dict()
+                RES_all["GlobalScore"] = -999
+                RES_all["NbAnalysedStatments"] = -999
+                RES_all["NbAnalysedLines"] = -999
+
                 ScanState = TScanState.TEXT_REPORT
-                for line in StdOutput.getvalue().split('\n'):     
-                    print(line)                   
-                    if      ScanState == TScanState.TEXT_REPORT:
+                for line in StdOutput.getvalue().split("\n"):
+                    print(line)
+                    if ScanState == TScanState.TEXT_REPORT:
                         # ignoring this part, we need json
-                        if line=='[':
-                            JsonContent+=line
+                        if line == "[":
+                            JsonContent += line
                             ScanState = TScanState.JSON_REPORT
-                        elif line=='[]':
-                            JsonContent+=line
+                        elif line == "[]":
+                            JsonContent += line
                             ScanState = TScanState.OTHER_REPORT_START
-                            
-                    elif    ScanState == TScanState.JSON_REPORT:
-                        JsonContent+=line
-                        if line==']':
+
+                    elif ScanState == TScanState.JSON_REPORT:
+                        JsonContent += line
+                        if line == "]":
                             ScanState = TScanState.OTHER_REPORT_START
-                            
-                    elif    ScanState == TScanState.OTHER_REPORT_START:
-                        if res:=re.search(r"^(\d+)(?= statements analysed.)",line):
-                            RES_all['NbAnalysedStatments'] = float(res.group(1))
+
+                    elif ScanState == TScanState.OTHER_REPORT_START:
+                        if res := re.search(r"^(\d+)(?= statements analysed.)", line):
+                            RES_all["NbAnalysedStatments"] = float(res.group(1))
                         if line == "Statistics by type":
                             ScanState = TScanState.OTHER_REPORT_STATISTICS
-                            
-                    elif    ScanState == TScanState.OTHER_REPORT_STATISTICS:
-                        if res:=re.search(r"^(\d+)(?= lines have been analyzed)",line):
-                            RES_all['NbAnalysedLines' ]= float(res.group(1))
+
+                    elif ScanState == TScanState.OTHER_REPORT_STATISTICS:
+                        if res := re.search(r"^(\d+)(?= lines have been analyzed)", line):
+                            RES_all["NbAnalysedLines"] = float(res.group(1))
                         elif line == "Raw metrics":
                             ScanState = TScanState.OTHER_REPORT_METRICS
                         else:
-                            with suppress(PyLintMetricNotFound): RES_all['Statistics']['module']      = cls.TryExtractPYReportMetric(line,"module")
-                            with suppress(PyLintMetricNotFound): RES_all['Statistics']['class']       = cls.TryExtractPYReportMetric(line,"class")
-                            with suppress(PyLintMetricNotFound): RES_all['Statistics']['method']      = cls.TryExtractPYReportMetric(line,"method")
-                            with suppress(PyLintMetricNotFound): RES_all['Statistics']['function']    = cls.TryExtractPYReportMetric(line,"function")
-                        
-                    elif    ScanState == TScanState.OTHER_REPORT_METRICS:
+                            with suppress(PyLintMetricNotFound):
+                                RES_all["Statistics"]["module"] = cls.TryExtractPYReportMetric(line, "module")
+                            with suppress(PyLintMetricNotFound):
+                                RES_all["Statistics"]["class"] = cls.TryExtractPYReportMetric(line, "class")
+                            with suppress(PyLintMetricNotFound):
+                                RES_all["Statistics"]["method"] = cls.TryExtractPYReportMetric(line, "method")
+                            with suppress(PyLintMetricNotFound):
+                                RES_all["Statistics"]["function"] = cls.TryExtractPYReportMetric(line, "function")
+
+                    elif ScanState == TScanState.OTHER_REPORT_METRICS:
                         if line == "Duplication":
-                            RES_all['RawMetricsPercent']['code']        =  RES_all['RawMetrics']['code']        / RES_all['NbAnalysedLines' ]
-                            RES_all['RawMetricsPercent']['docstring']   =  RES_all['RawMetrics']['docstring']   / RES_all['NbAnalysedLines' ]
-                            RES_all['RawMetricsPercent']['comment']     =  RES_all['RawMetrics']['comment']     / RES_all['NbAnalysedLines' ]
-                            RES_all['RawMetricsPercent']['empty']       =  RES_all['RawMetrics']['empty']       / RES_all['NbAnalysedLines' ]
+                            RES_all["RawMetricsPercent"]["code"] = RES_all["RawMetrics"]["code"] / RES_all["NbAnalysedLines"]
+                            RES_all["RawMetricsPercent"]["docstring"] = RES_all["RawMetrics"]["docstring"] / RES_all["NbAnalysedLines"]
+                            RES_all["RawMetricsPercent"]["comment"] = RES_all["RawMetrics"]["comment"] / RES_all["NbAnalysedLines"]
+                            RES_all["RawMetricsPercent"]["empty"] = RES_all["RawMetrics"]["empty"] / RES_all["NbAnalysedLines"]
                             ScanState = TScanState.OTHER_REPORT_DUPLICATION
                         else:
-                            with suppress(PyLintMetricNotFound): RES_all['RawMetrics']['code']         = cls.TryExtractPYReportMetric(line,"code")
-                            with suppress(PyLintMetricNotFound): RES_all['RawMetrics']['docstring']    = cls.TryExtractPYReportMetric(line,"docstring")
-                            with suppress(PyLintMetricNotFound): RES_all['RawMetrics']['comment']      = cls.TryExtractPYReportMetric(line,"comment")
-                            with suppress(PyLintMetricNotFound): RES_all['RawMetrics']['empty']        = cls.TryExtractPYReportMetric(line,"empty")    
-                            
-                    elif    ScanState == TScanState.OTHER_REPORT_DUPLICATION:
+                            with suppress(PyLintMetricNotFound):
+                                RES_all["RawMetrics"]["code"] = cls.TryExtractPYReportMetric(line, "code")
+                            with suppress(PyLintMetricNotFound):
+                                RES_all["RawMetrics"]["docstring"] = cls.TryExtractPYReportMetric(line, "docstring")
+                            with suppress(PyLintMetricNotFound):
+                                RES_all["RawMetrics"]["comment"] = cls.TryExtractPYReportMetric(line, "comment")
+                            with suppress(PyLintMetricNotFound):
+                                RES_all["RawMetrics"]["empty"] = cls.TryExtractPYReportMetric(line, "empty")
+
+                    elif ScanState == TScanState.OTHER_REPORT_DUPLICATION:
                         if line == "Messages by category":
                             ScanState = TScanState.OTHER_REPORT_MESSAGES_CAT
                         else:
-                            with suppress(PyLintMetricNotFound): RES_all['Duplication']['NbDupLines']               = cls.TryExtractPYReportMetric(line,"nb duplicated lines")
-                            with suppress(PyLintMetricNotFound): RES_all['Duplication']['PersentDuplicatedLines']   = cls.TryExtractPYReportMetric(line,"percent duplicated lines")
-                            
-                    elif    ScanState == TScanState.OTHER_REPORT_MESSAGES_CAT:
+                            with suppress(PyLintMetricNotFound):
+                                RES_all["Duplication"]["NbDupLines"] = cls.TryExtractPYReportMetric(line, "nb duplicated lines")
+                            with suppress(PyLintMetricNotFound):
+                                RES_all["Duplication"]["PersentDuplicatedLines"] = cls.TryExtractPYReportMetric(
+                                    line, "percent duplicated lines"
+                                )
+
+                    elif ScanState == TScanState.OTHER_REPORT_MESSAGES_CAT:
                         if line == "Messages":
                             ScanState = TScanState.OTHER_REPORT_MESSAGES
                         else:
-                            with suppress(PyLintMetricNotFound): RES_all['MessagesCat']['Convention']              = cls.TryExtractPYReportMetric(line,"convention")
-                            with suppress(PyLintMetricNotFound): RES_all['MessagesCat']['Refactor']                = cls.TryExtractPYReportMetric(line,"refactor")
-                            with suppress(PyLintMetricNotFound): RES_all['MessagesCat']['Warning']                 = cls.TryExtractPYReportMetric(line,"warning")
-                            with suppress(PyLintMetricNotFound): RES_all['MessagesCat']['Error']                   = cls.TryExtractPYReportMetric(line,"error")
-                            
-                    elif    ScanState == TScanState.OTHER_REPORT_MESSAGES:
+                            with suppress(PyLintMetricNotFound):
+                                RES_all["MessagesCat"]["Convention"] = cls.TryExtractPYReportMetric(line, "convention")
+                            with suppress(PyLintMetricNotFound):
+                                RES_all["MessagesCat"]["Refactor"] = cls.TryExtractPYReportMetric(line, "refactor")
+                            with suppress(PyLintMetricNotFound):
+                                RES_all["MessagesCat"]["Warning"] = cls.TryExtractPYReportMetric(line, "warning")
+                            with suppress(PyLintMetricNotFound):
+                                RES_all["MessagesCat"]["Error"] = cls.TryExtractPYReportMetric(line, "error")
+
+                    elif ScanState == TScanState.OTHER_REPORT_MESSAGES:
                         # approx match because the number of '-' depend on screen width..
                         if line.startswith("--------"):
                             ScanState = TScanState.OTHER_REPORT_END
                         else:
                             for PylintMessage in cls.PylintMessageList.keys():
-                                with suppress(PyLintMetricNotFound): RES_all['Messages'][PylintMessage]            = cls.TryExtractPYReportMetric(line,PylintMessage)
-                            
-                    elif    ScanState == TScanState.OTHER_REPORT_END:
-                        if res:=re.search(r"(?<=Your code has been rated at )(\d+(?:\.\d+)?)/10",line):
-                            RES_all['GlobalScore']=float(res.group(1))
-                            print(RES_all['GlobalScore'])
+                                with suppress(PyLintMetricNotFound):
+                                    RES_all["Messages"][PylintMessage] = cls.TryExtractPYReportMetric(line, PylintMessage)
+
+                    elif ScanState == TScanState.OTHER_REPORT_END:
+                        if res := re.search(r"(?<=Your code has been rated at )(\d+(?:\.\d+)?)/10", line):
+                            RES_all["GlobalScore"] = float(res.group(1))
+                            print(RES_all["GlobalScore"])
                     else:
                         raise RuntimeError("Invalid ScanState")
                 Outfile.write(JsonContent)
-                
-        with open(cls.get_result_dir()/"metrics.json", 'w') as json_file:  
+
+        with open(cls.get_result_dir() / "metrics.json", "w") as json_file:
             json.dump(RES_all, json_file)
-  
-        # exporting all Data in one csv, unused atm because jenkins seems not able to select columns from csv an keep displaying all...  
+
+        # exporting all Data in one csv, unused atm because jenkins seems not able to select columns from csv an keep displaying all...
         # => to export a working full csv we need to a 'flat' dict (no more nested dict)
         RES_all_trim = copy.deepcopy(RES_all)
         del RES_all_trim["Messages"]
-        flat_RES_all=pandas.json_normalize(RES_all_trim, sep='_').to_dict(orient='records')[0]
-                  
-        with open(cls.get_result_dir()/"metrics.csv", 'w', newline='') as csv_file:  
-            writer = csv.DictWriter(csv_file,fieldnames=flat_RES_all.keys())
+        flat_RES_all = pandas.json_normalize(RES_all_trim, sep="_").to_dict(orient="records")[0]
+
+        with open(cls.get_result_dir() / "metrics.csv", "w", newline="") as csv_file:
+            writer = csv.DictWriter(csv_file, fieldnames=flat_RES_all.keys())
             writer.writeheader()
             writer.writerow(flat_RES_all)
-            
+
         # splited csv exports for jenkins plots: RawMetricsPercent
         RES_all_percent = RES_all["RawMetricsPercent"]
-        with open(cls.get_result_dir()/"metrics_rawpercent.csv", 'w', newline='') as csv_file:  
-            writer = csv.DictWriter(csv_file,fieldnames=RES_all_percent.keys())
+        with open(cls.get_result_dir() / "metrics_rawpercent.csv", "w", newline="") as csv_file:
+            writer = csv.DictWriter(csv_file, fieldnames=RES_all_percent.keys())
             writer.writeheader()
             writer.writerow(RES_all_percent)
 
         # splited csv exports for jenkins plots: Statistics + Duplication + NbAnalysedStatments + NbAnalysedLines
         RES_all_stats = copy.deepcopy(RES_all["Statistics"])
-        RES_all_stats["NbDupLines"]             = RES_all['Duplication']['NbDupLines']
-        RES_all_stats["PersentDuplicatedLines"] = RES_all['Duplication']['PersentDuplicatedLines'] 
-        RES_all_stats["NbAnalysedStatments"]    = RES_all['NbAnalysedStatments' ]
-        RES_all_stats["NbAnalysedLines"]        = RES_all['NbAnalysedLines' ]
-        with open(cls.get_result_dir()/"metrics_Statistics.csv", 'w', newline='') as csv_file:  
-            writer = csv.DictWriter(csv_file,fieldnames=RES_all_stats.keys())
+        RES_all_stats["NbDupLines"] = RES_all["Duplication"]["NbDupLines"]
+        RES_all_stats["PersentDuplicatedLines"] = RES_all["Duplication"]["PersentDuplicatedLines"]
+        RES_all_stats["NbAnalysedStatments"] = RES_all["NbAnalysedStatments"]
+        RES_all_stats["NbAnalysedLines"] = RES_all["NbAnalysedLines"]
+        with open(cls.get_result_dir() / "metrics_Statistics.csv", "w", newline="") as csv_file:
+            writer = csv.DictWriter(csv_file, fieldnames=RES_all_stats.keys())
             writer.writeheader()
             writer.writerow(RES_all_stats)
-            
+
         # splited csv exports for jenkins plots: Statistics + Duplication
-        RES_all_MessagesCat = RES_all['MessagesCat']
-        with open(cls.get_result_dir()/"metrics_MessagesCat.csv", 'w', newline='') as csv_file:  
-            writer = csv.DictWriter(csv_file,fieldnames=RES_all_MessagesCat.keys())
+        RES_all_MessagesCat = RES_all["MessagesCat"]
+        with open(cls.get_result_dir() / "metrics_MessagesCat.csv", "w", newline="") as csv_file:
+            writer = csv.DictWriter(csv_file, fieldnames=RES_all_MessagesCat.keys())
             writer.writeheader()
             writer.writerow(RES_all_MessagesCat)
-            
+
         # splited csv exports for jenkins plots: GlobalScore
-        RES_GlobalScore = {'GlobalScore': RES_all['GlobalScore']}
-        with open(cls.get_result_dir()/"metrics_GlobalScore.csv", 'w', newline='') as csv_file:  
-            writer = csv.DictWriter(csv_file,fieldnames=RES_GlobalScore.keys())
+        RES_GlobalScore = {"GlobalScore": RES_all["GlobalScore"]}
+        with open(cls.get_result_dir() / "metrics_GlobalScore.csv", "w", newline="") as csv_file:
+            writer = csv.DictWriter(csv_file, fieldnames=RES_GlobalScore.keys())
             writer.writeheader()
             writer.writerow(RES_GlobalScore)
-              
+
         # converting the report using pylint_json2html (/!\ internal API, but as their is no leading '_' ...)
-        with open(cls.get_result_dir()/"report.html","w+", encoding='utf-8') as Outfile:
+        with open(cls.get_result_dir() / "report.html", "w+", encoding="utf-8") as Outfile:
             raw_data = json.loads(JsonContent)
-            report=pylint_json2html.Report( raw_data)
+            report = pylint_json2html.Report(raw_data)
             Outfile.write(report.render())
-                
+
         print("Done")

helpers/types_check.py

@@ -16,36 +16,46 @@ from mypy import api
 from .helper_base import helper_withresults_base
 
 
-class types_check(helper_withresults_base): 
+class types_check(helper_withresults_base):
     JUnitReportName = "junit.xml"
-    
-    @classmethod  
-    def do_job(cls):  
+
+    @classmethod
+    def do_job(cls):
         print("checking code typing ...")
-        result = api.run([      # project path
-                                "-m",
-                                "src." + str(cls.pyproject['project']['name']),
-                                # analysis configuration
-                                "--ignore-missing-imports",
-                                "--strict-equality",
-                                # reports generation
-                                "--cobertura-xml-report",   str(cls.get_result_dir()),
-                                "--html-report",            str(cls.get_result_dir()),
-                                "--linecount-report",       str(cls.get_result_dir()),
-                                "--linecoverage-report",    str(cls.get_result_dir()),
-                                "--lineprecision-report",   str(cls.get_result_dir()),
-                                "--txt-report",             str(cls.get_result_dir()),
-                                "--xml-report",             str(cls.get_result_dir()),
-                                "--junit-xml",              str(cls.get_result_dir()) + "/" + cls.JUnitReportName
-                                ])
-        
+        result = api.run(
+            [  # project path
+                "-m",
+                "src." + str(cls.pyproject["project"]["name"]),
+                # analysis configuration
+                "--ignore-missing-imports",
+                "--strict-equality",
+                # reports generation
+                "--cobertura-xml-report",
+                str(cls.get_result_dir()),
+                "--html-report",
+                str(cls.get_result_dir()),
+                "--linecount-report",
+                str(cls.get_result_dir()),
+                "--linecoverage-report",
+                str(cls.get_result_dir()),
+                "--lineprecision-report",
+                str(cls.get_result_dir()),
+                "--txt-report",
+                str(cls.get_result_dir()),
+                "--xml-report",
+                str(cls.get_result_dir()),
+                "--junit-xml",
+                str(cls.get_result_dir()) + "/" + cls.JUnitReportName,
+            ]
+        )
+
         if result[0]:
-            print('\nType checking report:\n')
+            print("\nType checking report:\n")
             print(result[0])  # stdout
-        
+
         if result[1]:
-            print('\nError report:\n')
+            print("\nError report:\n")
             print(result[1])  # stderr
-        
-        print('\nExit status:', result[2])
-        print("Done")
+
+        print("\nExit status:", result[2])
+        print("Done")

helpers/unit_test.py

@@ -21,34 +21,36 @@ from junit2htmlreport import parser as junit2html_parser
 from .helper_base import helper_withresults_base
 
 
-class unit_test(helper_withresults_base): 
-    enable_coverage_check:  bool = False
-    enable_xml_export:      bool = True
+class unit_test(helper_withresults_base):
+    enable_coverage_check: bool = False
+    enable_xml_export: bool = True
     enable_full_xml_export: bool = True
-    FullReportName: str         = "full_report"
-    CoverageReportName: str     = "test_coverage"
-    
-    @classmethod  
-    def do_job(cls): 
-        if cls.enable_coverage_check==True:
+    FullReportName: str = "full_report"
+    CoverageReportName: str = "test_coverage"
+
+    @classmethod
+    def do_job(cls):
+        if cls.enable_coverage_check == True:
             import coverage
-        
+
         # preparing unittest framework
         test_loader = unittest.TestLoader()
-        
+
         if cls.enable_coverage_check == True:
-            #we start coverage now because module files discovery is part of the coverage measurement
-            CoverageReportPath = Path(str(cls.get_result_dir())+"_coverage")
+            # we start coverage now because module files discovery is part of the coverage measurement
+            CoverageReportPath = Path(str(cls.get_result_dir()) + "_coverage")
             cls._reset_dir(CoverageReportPath)
-            cov = coverage.Coverage(cover_pylib=False,branch=True,source_pkgs=["src."+cls.pyproject['project']['name']])
+            cov = coverage.Coverage(cover_pylib=False, branch=True, source_pkgs=["src." + cls.pyproject["project"]["name"]])
             cov.start()
-        
-        package_tests = test_loader.discover(start_dir=str(cls.project_rootdir_path / "test"),top_level_dir=str(cls.project_rootdir_path / "test"))
+
+        package_tests = test_loader.discover(
+            start_dir=str(cls.project_rootdir_path / "test"), top_level_dir=str(cls.project_rootdir_path / "test")
+        )
         if cls.enable_xml_export:
             testRunner = xmlrunner.XMLTestRunner(output=str(str(cls.get_result_dir())))
         else:
             testRunner = unittest.TextTestRunner()
-             
+
         # running the test
         testRunner.run(package_tests)
 
@@ -57,23 +59,23 @@ class unit_test(helper_withresults_base):
             cov.stop()
             cov.save()
             cov.html_report(directory=str(CoverageReportPath))
-            cov.xml_report(outfile=(CoverageReportPath/f"{cls.CoverageReportName}.xml"))
-              
+            cov.xml_report(outfile=(CoverageReportPath / f"{cls.CoverageReportName}.xml"))
+
         # computing results (Only if xml available)
         if cls.enable_full_xml_export == True:
             print("Full reports generation...")
-            FullReportPath = Path(str(cls.get_result_dir())+"_full")
+            FullReportPath = Path(str(cls.get_result_dir()) + "_full")
             cls._reset_dir(FullReportPath)
-            
+
             FullJUnitReport = JUnitXml()
-            for fname in [fname for fname in os.listdir(cls.get_result_dir()) if fname.endswith('.xml')]:
-                FullJUnitReport+=JUnitXml.fromfile(str(cls.get_result_dir() / fname))
-                
+            for fname in [fname for fname in os.listdir(cls.get_result_dir()) if fname.endswith(".xml")]:
+                FullJUnitReport += JUnitXml.fromfile(str(cls.get_result_dir() / fname))
+
             current_datetime = datetime.datetime.utcnow().strftime("%Y%m%dT%H%M%SZ")
             full_report_base_name = f'{cls.pyproject["project"]["name"]}-{cls.FullReportName}-{current_datetime}'
-            FullJUnitReport.write(str(FullReportPath / f'{full_report_base_name}.xml'))
-            report = junit2html_parser.Junit(FullReportPath/ f'{full_report_base_name}.xml')
+            FullJUnitReport.write(str(FullReportPath / f"{full_report_base_name}.xml"))
+            report = junit2html_parser.Junit(FullReportPath / f"{full_report_base_name}.xml")
             html = report.html()
-            with open(FullReportPath/ f'{full_report_base_name}.html', "wb") as outfile:
-                outfile.write(html.encode('utf-8'))
-            print("Done")
+            with open(FullReportPath / f"{full_report_base_name}.html", "wb") as outfile:
+                outfile.write(html.encode("utf-8"))
+            print("Done")

mkdocs.yml

@@ -6,57 +6,87 @@
 # 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/>.
 
-
 docs_dir: docs
 site_name: pygitversionhelper
-site_url: https://chacha.ddns.net/mkdocs-web/chacha/pygitversionhelper/latest/
+site_url: 'https://chacha.ddns.net/mkdocs-web/chacha/pygitversionhelper/latest/'
 site_description: pygitversionhelper
-site_author: chacha
-repo_url: https://chacha.ddns.net/gitea/chacha/pygitversionhelper
+site_author: ChaCha
+repo_url: 'https://chacha.ddns.net/gitea/chacha/pygitversionhelper'
 use_directory_urls: false
+copyright: CC BY-NC-SA 4.0
 theme:
   name: material
   features:
-  - navigation.instant
-  - navigation.tracking
-  - navigation.tabs
-  - navigation.tabs.sticky
-  - toc.integrate
-  - navigation.top
+    - navigation.instant
+    - navigation.tracking
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - toc.integrate
+    - navigation.top
   palette:
-  - media: '(prefers-color-scheme: dark)'
-    scheme: slate
-    toggle:
-      icon: material/brightness-4
-      name: Switch to system preference
-  - media: (prefers-color-scheme)
-    toggle:
-      icon: material/brightness-auto
-      name: Switch to light mode
-  - media: '(prefers-color-scheme: light)'
-    scheme: default
-    toggle:
-      icon: material/brightness-7
-      name: Switch to dark mode
+    - media: '(prefers-color-scheme: dark)'
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+    - media: (prefers-color-scheme)
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    - media: '(prefers-color-scheme: light)'
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
 plugins:
-- search
-- localsearch
-- autorefs
-- mkdocstrings:
-    default_handler: python
-    handlers:
-      python:
-        selection:
-          filters:
-          - '!^_(?!_init__)'
-          inherited_members: true
-        rendering:
-          show_root_heading: false
-          show_root_toc_entry: false
-          show_root_full_path: false
-          show_if_no_docstring: true
-          show_signature_annotations: true
-          show_source: false
-          heading_level: 2
-          group_by_category: true
-          show_category_heading: true
+  - search
+  - markdownextradata
+  - mermaid2
+  - localsearch
+  - autorefs
+  - mkdocstrings:
+      default_handler: python
+      handlers:
+        python:
+          selection:
+            filters:
+              - '!^_(?!_init__)'
+            inherited_members: true
+          rendering:
+            show_root_heading: false
+            show_root_toc_entry: false
+            show_root_full_path: false
+            show_if_no_docstring: true
+            show_signature_annotations: true
+            show_source: false
+            heading_level: 2
+            group_by_category: true
+            show_category_heading: true
+markdown_extensions:
+  - def_list
+  - tables
+  - attr_list
+  - abbr
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.progressbar
+  - pymdownx.smartsymbols
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+  - footnotes
+
+extra:
+  branch: master
+  repository: pygitversionhelper

pyproject.toml

@@ -7,18 +7,15 @@
 # work.  If not, see <https://creativecommons.org/licenses/by-nc-sa/4.0/>.
 
 [build-system]
-requires = ["setuptools>=63", "wheel", "setuptools-git-versioning<2"]
+requires = ["setuptools>=63", "wheel", "setuptools_scm"]
 build-backend = "setuptools.build_meta"
 
-[tool.setuptools-git-versioning]
-enabled = true
-dev_template    = "{tag}.post{ccount}"
-tag_filter      = "^\\d+\\.\\d+\\.\\d+$"
+[tool.setuptools_scm]
+version_scheme= "post-release"
 
 [project]
 name = "pygitversionhelper"
 description = "pygitversionhelper"
-readme = "README.md"
 requires-python = ">=3.9"
 keywords = ["chacha","chacha","template","pygitversionhelper"]
 license = { file = "LICENSE.md" }
@@ -36,6 +33,7 @@ classifiers = [
 ]
 dependencies = [
     'importlib-metadata; python_version<"3.9"',
+    'packaging'
 ]
 dynamic = ["version"]
 
@@ -49,21 +47,18 @@ where = ["src"]
 [tool.setuptools.package-data]
 "pygitversionhelper.data" = ["*.*"]
 
-#[tool.setuptools_scm]
-#write_to        = "src/pygitversionhelper/_version.py"
-#version_scheme  = "python-simplified-semver"
-
 [project.urls]
-Homepage        = "https://chacha.ddns.net/gitea/chacha/pygitversionhelper"
-Documentation   = "https://chacha.ddns.net/gitea/chacha/pygitversionhelper/wiki"
+Homepage        = "https://chacha.ddns.net/gitea/chacha/pygitversionhelper/"
+Documentation   = "https://chacha.ddns.net/mkdocs-web/chacha/pygitversionhelper/master/latest/"
 Tracker         = "https://chacha.ddns.net/gitea/chacha/pygitversionhelper/issues"
 
 [project.optional-dependencies]
 test              = ["junitparser>=2.8","junit2html>=30.1","xmlrunner>=1.7","mypy>=0.99" ]
 coverage-check    = ["coverage>=7.0"]
+complexity-check  = ["radon>=5.1"]
 quality-check     = ["pylint>=2.15","pylint-json2html>=0.4","pandas>=1.5"]
 type-check        = ["mypy[reports]>=0.99" ]
-doc-gen           = ["mkdocs>=1.4.0", "mkdocs-material>=8.5", "mkdocs-localsearch>=0.9.0", "mkdocstrings[python]>=0.19", "mkdocs-with-pdf>=0.9.3","pyyaml>=6.0"]
+doc-gen           = ["mkdocs>=1.4.0", "mkdocs-material>=8.5", "mkdocs-localsearch>=0.9.0", "mkdocstrings[python]>=0.19", "mkdocs-with-pdf>=0.9.3","pyyaml>=6.0","pymdown-extensions>=9","mkdocs-markdownextradata-plugin","mkdocs-mermaid2-plugin"]
 
 #[project.scripts]
 #my-script = "my_package.module:function"

src/pygitversionhelper/__init__.py

@@ -14,8 +14,9 @@ from importlib.metadata import version, PackageNotFoundError
 
 try:  # pragma: no cover
     __version__ = version("pygitversionhelper")
-except PackageNotFoundError: # pragma: no cover
+except PackageNotFoundError:  # pragma: no cover
     import warnings
+
     warnings.warn("can not read __version__, assuming local test context, setting it to ?.?.?")
     __version__ = "?.?.?"
 

src/pygitversionhelper/gitversionhelper.py

@@ -36,7 +36,8 @@ import logging
 
 from packaging.version import VERSION_PATTERN as packaging_VERSION_PATTERN
 
-def _exec(cmd: str, root: str | os.PathLike | None = None, raw:bool = False) -> list[str]:
+
+def _exec(cmd: str, root: str | os.PathLike | None = None, raw: bool = False) -> list[str]:
     """
     helper function to handle system cmd execution
     Args:
@@ -44,14 +45,22 @@ def _exec(cmd: str, root: str | os.PathLike | None = None, raw:bool = False) ->
         root: root directory where the command need to be executed
     Returns:
         a list of command's return lines
-        
+
     """
-    p = subprocess.run(cmd, text=True, cwd=root, capture_output=True, check=False, timeout=2,shell=True)
-    if re.search("not a git repository",p.stderr):
+    p = subprocess.run(
+        cmd,
+        text=True,
+        cwd=root,
+        capture_output=True,
+        check=False,
+        timeout=2,
+        shell=True,
+    )
+    if re.search("not a git repository", p.stderr):
         raise gitversionhelper.repository.notAGitRepository()
-    if re.search("fatal:",p.stderr):    #pragma: nocover
+    if re.search("fatal:", p.stderr):
         raise gitversionhelper.unknownGITFatalError(p.stderr)
-    if int(p.returncode) < 0:           #pragma: nocover
+    if int(p.returncode) < 0:
         raise gitversionhelper.unknownGITError(p.stderr)
 
     if raw:
@@ -59,15 +68,18 @@ def _exec(cmd: str, root: str | os.PathLike | None = None, raw:bool = False) ->
     lines = p.stdout.splitlines()
     return [line.rstrip() for line in lines if line.rstrip()]
 
+
 class gitversionhelperException(Exception):
     """
     general Module Exception
     """
 
-class gitversionhelper: # pylint: disable=too-few-public-methods
+
+class gitversionhelper:  # pylint: disable=too-few-public-methods
     """
     main gitversionhelper class
     """
+
     class wrongArguments(gitversionhelperException):
         """
         wrong argument generic exception
@@ -87,6 +99,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
         """
         class containing methods focusing on repository
         """
+
         class repositoryException(gitversionhelperException):
             """
             generic repository exeption
@@ -110,12 +123,13 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
                 True if it is dirty
             """
             return bool(_exec("git status --short"))
+
     class commit:
         """
         class containing methods focusing on commits
         """
-        __OptDict = {"same_branch": "same_branch",
-                     "merged_output":"merged_output"}
+
+        __OptDict = {"same_branch": "same_branch", "merged_output": "merged_output"}
 
         class commitException(gitversionhelperException):
             """
@@ -128,50 +142,54 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
             """
 
         @classmethod
-        def getMessagesSinceTag(cls,tag:str,**kwargs) -> str:
+        def getMessagesSinceTag(cls, tag: str, **kwargs) -> str:
             """
             retrieve a commits message history from repository
-            from LastCommit to the given tag
+            from Latest commit to the given tag
             Keyword Arguments:
                 merged_output: output one single merged string
                 same_branch(bool): force searching only in the same branch
             Returns:
                 the commit message
             """
-            current_commit_id=cls.getLast(**kwargs)
-            tag_commit_id=cls.getFromTag(tag,**kwargs)
+            current_commit_id = cls.getLast(**kwargs)
+            tag_commit_id = cls.getFromTag(tag)
 
-            if ((cls.__OptDict["same_branch"] in kwargs) and (kwargs[cls.__OptDict["same_branch"]] is True)):
+            if (cls.__OptDict["same_branch"] in kwargs) and (kwargs[cls.__OptDict["same_branch"]] is True):
                 commits = _exec(f"git rev-list --first-parent --ancestry-path {tag_commit_id}..{current_commit_id}")
             else:
                 commits = _exec(f"git rev-list --ancestry-path {tag_commit_id}..{current_commit_id}")
-            result=[]
+            result = []
             for commit in commits:
-                result.append(cls.getMessage(commit,**kwargs))
+                result.append(cls.getMessage(commit))
 
-            if ((cls.__OptDict["merged_output"] in kwargs) and (kwargs[cls.__OptDict["merged_output"]] is True)):
+            if (cls.__OptDict["merged_output"] in kwargs) and (kwargs[cls.__OptDict["merged_output"]] is True):
                 print("JOIN")
                 return os.linesep.join(result)
             return result
 
         @classmethod
-        def getMessage(cls, hash:str) -> str:
+        def getMessage(cls, commit_hash: str) -> str:
             """
             retrieve a commit message from repository
             Args:
-                hash: id of the commit
+                commit_hash: id of the commit
             Returns:
                 the commit message
             """
             try:
-                res=_exec(f"git log -z --pretty=tformat:%B%-C() -n 1 {hash}",None,True).rstrip('\x00')
+                res = _exec(
+                    f'git log -z --pretty="tformat:%B%-C()" -n 1 {commit_hash}',
+                    None,
+                    True,
+                ).rstrip("\x00")
             except gitversionhelper.unknownGITFatalError as _e:
                 raise cls.commitNotFound("no commit found in commit history") from _e
 
-            return res.replace('\r\n','\n').replace('\n','\r\n')
+            return res.replace("\r\n", "\n").replace("\n", "\r\n")
 
         @classmethod
-        def getFromTag(cls,tag:str) -> str:
+        def getFromTag(cls, tag: str) -> str:
             """
             retrieve a commit from repository associated to a tag
             Args:
@@ -180,15 +198,15 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
                 the commit Id
             """
             try:
-                res=_exec(f"git rev-list -n 1 {tag}")
+                res = _exec(f"git rev-list -n 1 {tag}")
             except gitversionhelper.unknownGITFatalError as _e:
                 raise cls.commitNotFound("no commit found in commit history") from _e
-            if len(res)==0:
+            if len(res) == 0:
                 raise cls.commitNotFound("no commit found in commit history")
             return res[0]
 
         @classmethod
-        def getLast(cls,**kwargs) -> str:
+        def getLast(cls, **kwargs) -> str:
             """
             retrieve last commit from repository
             Keyword Arguments:
@@ -196,15 +214,15 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
             Returns:
                 the commit Id
             """
-            if ((cls.__OptDict["same_branch"] in kwargs) and (kwargs[cls.__OptDict["same_branch"]] is True)):
+            if (cls.__OptDict["same_branch"] in kwargs) and (kwargs[cls.__OptDict["same_branch"]] is True):
                 try:
                     res = _exec("git rev-parse HEAD")
                 except gitversionhelper.unknownGITFatalError as _e:
                     raise cls.commitNotFound("no commit found in commit history") from _e
             else:
-                res = _exec("git for-each-ref --sort=-committerdate refs/heads/ --count 1 --format=%(objectname)")
+                res = _exec('git for-each-ref --sort=-committerdate refs/heads/ --count 1 --format="%(objectname)"')
 
-            if len(res)==0:
+            if len(res) == 0:
                 raise cls.commitNotFound("no commit found in commit history")
             return res[0]
 
@@ -212,8 +230,17 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
         """
         class containing methods focusing on tags
         """
+
         __OptDict = {"same_branch": "same_branch"}
-        __validGitTagSort=["","v:refname","-v:refname","taggerdate","committerdate","-taggerdate","-committerdate"]
+        __validGitTagSort = [
+            "",
+            "v:refname",
+            "-v:refname",
+            "taggerdate",
+            "committerdate",
+            "-taggerdate",
+            "-committerdate",
+        ]
 
         class tagException(gitversionhelperException):
             """
@@ -231,7 +258,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
             """
 
         @classmethod
-        def getTags(cls,sort:str = "taggerdate",**kwargs) -> list[str|None]:
+        def getTags(cls, sort: str = "taggerdate", **kwargs) -> list[str | None]:
             """
             retrieve all tags from a repository
             Args:
@@ -243,37 +270,37 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
             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)):
+            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 getLastTag(cls,**kwargs) -> str | None:
+        def getLastTag(cls, **kwargs) -> str | None:
             """
-            retrieve the last tag from a repository
+            retrieve the Latest 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)):
+            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:
+                if len(res) == 1:
                     res = _exec(f"git describe --tags {res[0]}")
 
-            if len(res)==0:
+            if len(res) == 0:
                 raise cls.tagNotFound("no tag found in commit history")
-            if len(res)!=1: #pragma: nocover
+            if len(res) != 1:
                 raise cls.moreThanOneTag("multiple tags on same commit is unsupported")
             return res[0]
 
         @classmethod
-        def getDistanceFromTag(cls,tag:str=None,**kwargs) -> int:
+        def getDistanceFromTag(cls, tag: str = None, **kwargs) -> int:
             """
-            retrieve the distance between HEAD and tag in the repository
+            retrieve the distance between Latest commit and tag in the repository
             Arguments:
                 tag: reference tag, if None the most recent one will be used
             Keyword Arguments:
@@ -289,23 +316,27 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
         """
         class containing methods focusing on versions
         """
-        __OptDict = {   "version_std":      "version_std",
-                        "formated_output":  "formated_output",
-                        "output_format":    "output_format",
-                        "ignore_unknown_tags":  "ignore_unknown_tags"}
+
+        __OptDict = {
+            "version_std": "version_std",
+            "formated_output": "formated_output",
+            "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
-                           }
+        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
@@ -326,33 +357,44 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
             generic version object
             """
 
-            __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-patch","pre-minor","pre-major"]
+            __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-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"
+            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
+            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
+                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) -> str:
+            def _getBumpDevStrategy(cls, **kwargs) -> str:
                 """
                 get selected bump_dev_strategy
                 Keyword Arguments:
@@ -369,7 +411,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
                 return BumpDevStrategy
 
             @classmethod
-            def _getBumpType(cls,**kwargs) -> str:
+            def _getBumpType(cls, **kwargs) -> str:
                 """
                 get selected bump_type
                 Keyword Arguments:
@@ -385,7 +427,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
                         raise gitversionhelper.wrongArguments(f"invalid {cls.__OptDict['bump_type']} requested")
                 return BumpType
 
-            def bump(self,amount:int=1,**kwargs) -> gitversionhelper.version.MetaVersion | str : # pylint: disable=R0912
+            def bump(self, amount: int = 1, **kwargs) -> gitversionhelper.version.MetaVersion | str:  # pylint: disable=R0912
                 """
                 bump the version to the next one
                 Keyword Arguments:
@@ -395,8 +437,8 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
                     the bumped version
                 """
                 BumpType = self._getBumpType(**kwargs)
-                BumpDevStrategy=self._getBumpDevStrategy(**kwargs)
-                _v=copy(self)
+                BumpDevStrategy = self._getBumpDevStrategy(**kwargs)
+                _v = copy(self)
 
                 if BumpType == "dev":
                     if BumpDevStrategy == "post":
@@ -404,7 +446,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
                             _v.pre_count = _v.pre_count + amount
                         else:
                             _v.post_count = _v.post_count + amount
-                    #elif BumpDevStrategy in ["pre-patch","pre-minor","pre-major"]:
+                    # elif BumpDevStrategy in ["pre-patch","pre-minor","pre-major"]:
                     else:
                         if _v.post_count > 0:
                             _v.post_count = _v.post_count + amount
@@ -415,7 +457,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
                                 elif BumpDevStrategy == "pre-minor":
                                     _v.minor = _v.minor + 1
                                     _v.patch = 0
-                                #elif BumpDevStrategy == "pre-major":
+                                # elif BumpDevStrategy == "pre-major":
                                 else:
                                     _v.major = _v.major + 1
                                     _v.minor = 0
@@ -426,18 +468,18 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
                         _v.major = _v.major + amount
                     elif BumpType == "minor":
                         _v.minor = _v.minor + amount
-                    #elif BumpType == "patch":
+                    # elif BumpType == "patch":
                     else:
                         _v.patch = _v.patch + amount
-                    _v.pre_count=0
-                    _v.post_count=0
-                _v.raw=_v.doFormatVersion(**kwargs)
+                    _v.pre_count = 0
+                    _v.post_count = 0
+                _v.raw = _v.doFormatVersion(**kwargs)
 
-                if ((self.__OptDict["formated_output"] in kwargs) and (kwargs[self.__OptDict["formated_output"]] is True)):
+                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) -> str:
+            def doFormatVersion(self, **kwargs) -> str:
                 """
                 output a formated version string
                 Keyword Arguments:
@@ -445,10 +487,10 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
                 Returns:
                     formated version string
                 """
-                return gitversionhelper.version.doFormatVersion(self,**kwargs)
+                return gitversionhelper.version.doFormatVersion(self, **kwargs)
 
         @classmethod
-        def _getVersionStd(cls,**kwargs) -> str:
+        def _getVersionStd(cls, **kwargs) -> str:
             """
             get selected version_std
             Keyword Arguments:
@@ -465,7 +507,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
             return VersionStd
 
         @classmethod
-        def getCurrentVersion(cls,**kwargs) -> MetaVersion | str :
+        def getCurrentVersion(cls, **kwargs) -> MetaVersion | str:
             """
             get the current version or bump depending of repository state
             Keyword Arguments:
@@ -478,8 +520,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
                 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.")
+                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"]
@@ -487,15 +528,23 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
             _v = cls.getLastVersion(**saved_kwargs)
 
             if not cls.__versionReseted:
-                amount  = gitversionhelper.tag.getDistanceFromTag(_v.raw,**kwargs)
-                _v = _v.bump(amount,**saved_kwargs)
+                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)):
+            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
+        def getCurrentFormatedVersion(cls, **kwargs) -> str:
+            """
+            Same as getCurrentVersion() with formated_output kwarg activated
+            """
+            kwargs["formated_output"] = True
+            return cls.getCurrentVersion(**kwargs)
+
+        @classmethod
+        def _parseTag(cls, tag, **kwargs):  # pylint: disable=R0914, R0912, R0915
             """get the last version from tags
             Arguments:
                 tag: the tag to be parsed
@@ -510,61 +559,66 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
             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 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"))
+                    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:
+                        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:
+                        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 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 = _m.group("release").split(".")
                     ver += ["0"] * (3 - len(ver))
-                    ver[0]=int(ver[0])
-                    ver[1]=int(ver[1])
-                    ver[2]=int(ver[2])
+                    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
+                    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 :
+            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.")
+                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 getLastVersion(cls,**kwargs) -> MetaVersion | str : # pylint: disable=R0914, R0912, R0915
+        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)
@@ -574,36 +628,36 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
             Returns:
                 the last version
             """
-            lastTag=cls.MetaVersion.raw
+            lastTag = cls.MetaVersion.raw
             cls.__versionReseted = False
             try:
                 lastTag = gitversionhelper.tag.getLastTag(**kwargs)
             except gitversionhelper.tag.tagNotFound:
-                logging.warning('tag not found, reseting versionning')
+                logging.warning("tag not found, reseting versionning")
                 cls.__versionReseted = True
 
-            _v=None
+            _v = None
             try:
-                _v=cls._parseTag(lastTag,**kwargs)
+                _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)
+                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)
+                            _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)):
+            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:
+        def doFormatVersion(cls, inputversion: MetaVersion, **kwargs) -> str:
             """
             output a formated version string
             Keyword Arguments:
@@ -615,41 +669,44 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
             """
 
             VersionStd = cls._getVersionStd(**kwargs)
-            if VersionStd=="Auto" :
+            if VersionStd == "Auto":
                 VersionStd = inputversion.version_std
 
             OutputFormat = None
-            revpattern=""
-            revcount=""
+            revpattern = ""
+            revcount = ""
             post_count = inputversion.post_count
-            pre_count  = inputversion.pre_count
-            patch      = inputversion.patch
+            pre_count = inputversion.pre_count
+            patch = inputversion.patch
 
             if cls.__OptDict["output_format"] in kwargs:
-                OutputFormat=kwargs[cls.__OptDict["output_format"]]
+                OutputFormat = kwargs[cls.__OptDict["output_format"]]
 
             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":
+                    raise gitversionhelper.version.PreAndPostVersionUnsupported(
+                        "cannot output a version with both pre and post release number."
+                    )
+                if VersionStd == "PEP440":
                     if post_count > 0:
-                        revpattern=".post"
-                        revcount=f"{post_count}"
+                        revpattern = ".post"
+                        revcount = f"{post_count}"
                     elif pre_count > 0:
-                        revpattern=".pre"
-                        revcount=f"{pre_count}"
-                #elif    VersionStd == "SemVer":
+                        revpattern = ".pre"
+                        revcount = f"{pre_count}"
+                # elif    VersionStd == "SemVer":
                 else:
                     if post_count > 0:
-                        revpattern="+post"
-                        revcount=f".{post_count}"
+                        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)
+                        revpattern = "-pre"
+                        revcount = f".{pre_count}"
+            return OutputFormat.format(
+                major=inputversion.major,
+                minor=inputversion.minor,
+                patch=patch,
+                revpattern=revpattern,
+                revcount=revcount,
+            )

test/__init__.py

@@ -4,4 +4,4 @@
 # 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/>.
+# work.  If not, see <https://creativecommons.org/licenses/by-nc-sa/4.0/>.