back port from pychangelogfactory

.gitignore

@@ -41,3 +41,5 @@ docs
 helpers-results
 .coverage
 /.mypy_cache/
+.coverage
+.mypy_cache

.pydevproject

@@ -6,7 +6,6 @@
     <pydev_property name="org.python.pydev.PYTHON_PROJECT_VERSION">python interpreter</pydev_property>
         
     <pydev_pathproperty name="org.python.pydev.PROJECT_SOURCE_PATH">
-        <path>/${PROJECT_DIR_NAME}/src</path>
         <path>/${PROJECT_DIR_NAME}</path>
     </pydev_pathproperty>
     

Jenkinsfile

@@ -397,14 +397,23 @@ pipeline {
             }
             post {
                 always {      
-                    dir("gitrepo") {                              
-                    publishHTML([
-                                reportDir:              "helpers-results/quality_check",
-                                reportFiles:            "report.html",
-                                reportName:             "quality-report",
-                                allowMissing:           false,
-                                alwaysLinkToLastBuild:  true,
-                                keepAll:                true])    
+                    dir("gitrepo") {       
+                        publishCoverage adapters: [cobertura(mergeToOneReport: true, path: "helpers-results/types_check/cobertura.xml")]
+                        junit 'helpers-results/types_check/junit.xml'           
+                        publishHTML([
+                                    reportDir:              "helpers-results/quality_check",
+                                    reportFiles:            "report.html",
+                                    reportName:             "quality-report",
+                                    allowMissing:           false,
+                                    alwaysLinkToLastBuild:  true,
+                                    keepAll:                true])                 
+                        publishHTML([
+                                    reportDir:              "helpers-results/types_check",
+                                    reportFiles:            "index.html",
+                                    reportName:             "types_check",
+                                    allowMissing:           false,
+                                    alwaysLinkToLastBuild:  true,
+                                    keepAll:                true])    
                    }         
                 }
             }
@@ -481,12 +490,7 @@ pipeline {
                         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]

RUN_changelog.launch

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<launchConfiguration type="org.python.pydev.debug.regularLaunchConfigurationType">
+    <booleanAttribute key="org.eclipse.debug.core.ATTR_FORCE_SYSTEM_CONSOLE_ENCODING" value="false"/>
+    <listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
+        <listEntry value="/${project_name}/helpers"/>
+    </listAttribute>
+    <listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
+        <listEntry value="2"/>
+    </listAttribute>
+    <stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${project_loc}/helpers"/>
+    <stringAttribute key="org.eclipse.ui.externaltools.ATTR_OTHER_WORKING_DIRECTORY" value=""/>
+    <stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="--changelog-gen"/>
+    <stringAttribute key="org.python.pydev.debug.ATTR_INTERPRETER" value="__default"/>
+    <stringAttribute key="org.python.pydev.debug.ATTR_PROJECT" value="pygitversionhelper"/>
+    <stringAttribute key="process_factory_id" value="org.python.pydev.debug.processfactory.PyProcessFactory"/>
+</launchConfiguration>

RUN_complexity.launch

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<launchConfiguration type="org.python.pydev.debug.regularLaunchConfigurationType">
+    <booleanAttribute key="org.eclipse.debug.core.ATTR_FORCE_SYSTEM_CONSOLE_ENCODING" value="false"/>
+    <listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
+        <listEntry value="/${project_name}/helpers"/>
+    </listAttribute>
+    <listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
+        <listEntry value="2"/>
+    </listAttribute>
+    <stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:pychangelogfactory/helpers}"/>
+    <stringAttribute key="org.eclipse.ui.externaltools.ATTR_OTHER_WORKING_DIRECTORY" value=""/>
+    <stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="--complexity-check"/>
+    <stringAttribute key="org.python.pydev.debug.ATTR_INTERPRETER" value="__default"/>
+    <stringAttribute key="org.python.pydev.debug.ATTR_PROJECT" value="pygitversionhelper"/>
+    <stringAttribute key="process_factory_id" value="org.python.pydev.debug.processfactory.PyProcessFactory"/>
+</launchConfiguration>

RUN_mkdocs.launch

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<launchConfiguration type="org.python.pydev.debug.regularLaunchConfigurationType">
+    <booleanAttribute key="org.eclipse.debug.core.ATTR_FORCE_SYSTEM_CONSOLE_ENCODING" value="false"/>
+    <listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
+        <listEntry value="/${project_name}/helpers"/>
+    </listAttribute>
+    <listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
+        <listEntry value="2"/>
+    </listAttribute>
+    <mapAttribute key="org.eclipse.debug.core.environmentVariables">
+        <mapEntry key="PATH" value="C:\Program Files\GTK3-Runtime Win64\bin"/>
+    </mapAttribute>
+    <stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:pychangelogfactory/helpers}"/>
+    <stringAttribute key="org.eclipse.ui.externaltools.ATTR_OTHER_WORKING_DIRECTORY" value=""/>
+    <stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="--doc-gen --doc-gen-pdf"/>
+    <stringAttribute key="org.python.pydev.debug.ATTR_INTERPRETER" value="__default"/>
+    <stringAttribute key="org.python.pydev.debug.ATTR_PROJECT" value="pygitversionhelper"/>
+    <stringAttribute key="process_factory_id" value="org.python.pydev.debug.processfactory.PyProcessFactory"/>
+</launchConfiguration>

RUN_quality.launch

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<launchConfiguration type="org.python.pydev.debug.regularLaunchConfigurationType">
+    <booleanAttribute key="org.eclipse.debug.core.ATTR_FORCE_SYSTEM_CONSOLE_ENCODING" value="false"/>
+    <listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
+        <listEntry value="/${project_name}/helpers"/>
+    </listAttribute>
+    <listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
+        <listEntry value="2"/>
+    </listAttribute>
+    <stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:pychangelogfactory/helpers}"/>
+    <stringAttribute key="org.eclipse.ui.externaltools.ATTR_OTHER_WORKING_DIRECTORY" value=""/>
+    <stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="--type-check --quality-check"/>
+    <stringAttribute key="org.python.pydev.debug.ATTR_INTERPRETER" value="__default"/>
+    <stringAttribute key="org.python.pydev.debug.ATTR_PROJECT" value="pygitversionhelper"/>
+    <stringAttribute key="process_factory_id" value="org.python.pydev.debug.processfactory.PyProcessFactory"/>
+</launchConfiguration>

RUN_unittest.launch

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<launchConfiguration type="org.python.pydev.debug.regularLaunchConfigurationType">
+    <booleanAttribute key="org.eclipse.debug.core.ATTR_FORCE_SYSTEM_CONSOLE_ENCODING" value="false"/>
+    <listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
+        <listEntry value="/${project_name}/helpers"/>
+    </listAttribute>
+    <listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
+        <listEntry value="2"/>
+    </listAttribute>
+    <stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:pychangelogfactory/helpers}"/>
+    <stringAttribute key="org.eclipse.ui.externaltools.ATTR_OTHER_WORKING_DIRECTORY" value=""/>
+    <stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="--unit-test --coverage-check"/>
+    <stringAttribute key="org.python.pydev.debug.ATTR_INTERPRETER" value="__default"/>
+    <stringAttribute key="org.python.pydev.debug.ATTR_PROJECT" value="pygitversionhelper"/>
+    <stringAttribute key="process_factory_id" value="org.python.pydev.debug.processfactory.PyProcessFactory"/>
+</launchConfiguration>

helpers/doc_gen.py

@@ -72,9 +72,11 @@ class doc_gen(helper_withresults_base):
         # 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
         # manually process the configuration file.
-        mkdocsCfg = None
         with open(cls.project_rootdir_path / "mkdocs.yml", "r") as mkdocsCfgFile:
-            mkdocsCfg = yaml.load(mkdocsCfgFile, Loader=yaml.SafeLoader)
+            mkdocsCfg = yaml.load(mkdocsCfgFile, Loader=yaml.Loader)
+
+            if "plugins" in mkdocsCfg:
+                mkdocsCfg["plugins"] = [_ for _ in mkdocsCfg["plugins"] if (not isinstance(_, dict) or "with-pdf" not in _.keys())]
 
             if cls.enable_gen_pdf == True:
                 mkdocsCfg["plugins"].append(
@@ -83,19 +85,11 @@ class doc_gen(helper_withresults_base):
                             "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))
 

helpers/helper_base.py

@@ -57,10 +57,11 @@ class helper_base(ABC):
         return process.stdout
 
     @classmethod
-    def run_cmd(cls, cmdarray):
+    def run_cmd(cls, cmdarray, silent: bool = False):
         p = subprocess.run(cmdarray, capture_output=True)
-        print(p.stdout)
-        print(p.stderr)
+        if not silent:
+            print(p.stdout.decode())
+            print(p.stderr.decode())
         return p.stdout
 
 

helpers/quality_check.py

@@ -37,7 +37,7 @@ class quality_check(helper_withresults_base):
     def GetPylintMessageList(cls):
         Messagelist = dict()
         regex = r"^:([a-zA-Z-]+) \(([^\)]+)\)"
-        for line in cls.run_cmd([sys.executable, "-m", "pylint", "--list-msgs"]).splitlines():
+        for line in cls.run_cmd([sys.executable, "-m", "pylint", "--list-msgs"], True).splitlines():
             if res := re.search(regex, line.decode()):
                 Messagelist[res.group(1)] = res.group(2)
         cls.PylintMessageList = Messagelist
@@ -52,6 +52,7 @@ class quality_check(helper_withresults_base):
     @classmethod
     def do_job(cls):
         print("checking code quality ...")
+
         cls.GetPylintMessageList()
 
         RES_all = dict()

helpers/types_check.py

@@ -24,22 +24,18 @@ class types_check(helper_withresults_base):
         print("checking code typing ...")
         result = api.run(
             [  # project path
-                "-m",
-                "src." + str(cls.pyproject["project"]["name"]),
+                "-p",
+                "src.pychangelogfactory",
                 # analysis configuration
-                "--ignore-missing-imports",
-                "--strict-equality",
+                # "--show-traceback",
+                "--explicit-package-bases",
+                # "--strict-equality",
+                # "--check-untyped-defs",
                 # 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",
@@ -52,6 +48,9 @@ class types_check(helper_withresults_base):
         if result[0]:
             print("\nType checking report:\n")
             print(result[0])  # stdout
+            # converting the report using pylint_json2html (/!\ internal API, but as their is no leading '_' ...)
+            with open(cls.get_result_dir() / "raw_eport.txt", "w+", encoding="utf-8") as Outfile:
+                Outfile.write(result[0])
 
         if result[1]:
             print("\nError report:\n")

mkdocs.yml

@@ -1,92 +1,110 @@
-# 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/>.
-
 docs_dir: docs
 site_name: pygitversionhelper
 site_url: 'https://chacha.ddns.net/mkdocs-web/chacha/pygitversionhelper/latest/'
-site_description: pygitversionhelper
-site_author: ChaCha
+site_description: 'A simple simple git version helper in python.'
+site_author: prune
 repo_url: 'https://chacha.ddns.net/gitea/chacha/pygitversionhelper'
 use_directory_urls: false
-copyright: CC BY-NC-SA 4.0
+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
+  - navigation.footer
+  - toc.integrate
+  - navigation.top
+  - navigation.section
+  - content.code.annotate
+  - navigation.prune
+  - toc.follow
   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
-  - 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
+- search
+- markdownextradata
+- mermaid2
+- localsearch
+- mkdocstrings:
+    default_handler: python
+    handlers:
+      python:
+        options:
+          filters:
+          - '!^_[^_]'
+          inherited_members: true
+          show_if_no_docstring: true
+          show_signature_annotations: true
+          show_source: false
+          show_category_heading: true
+          group_by_category: true
+          docstring_section_style: spacy
+          show_root_full_path: false
+          merge_init_into_class: true
+          separate_signature: 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
-
+- def_list
+- tables
+- attr_list
+- abbr
+- pymdownx.blocks.admonition:
+    types:
+    - new
+    - settings
+    - note
+    - abstract
+    - info
+    - tip
+    - success
+    - question
+    - warning
+    - failure
+    - danger
+    - bug
+    - example
+    - quote
+- pymdownx.blocks.definition
+- pymdownx.blocks.details
+- pymdownx.blocks.tab
+- pymdownx.blocks.html
+- 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
+- pymdownx.superfences
+- pymdownx.emoji:
+    emoji_index: !!python/name:materialx.emoji.twemoji
+    emoji_generator: !!python/name:materialx.emoji.to_svg
 extra:
   branch: master
-  repository: pygitversionhelper
+  repository: pygitversionhelper

pyproject.toml

@@ -59,7 +59,7 @@ 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","pymdown-extensions>=9","mkdocs-markdownextradata-plugin","mkdocs-mermaid2-plugin"]
+doc-gen           = ["mkdocs>=1.4.0", "mkdocs-material>=8.5","mkdocs-pymdownx-material-extras", "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"