Renamed all occurences of to

Author: ThomasSteinbach

.gitlab-ci.py

@@ -20,7 +20,7 @@
 
 if PredefinedVariables.CI_COMMIT_TAG:
     pipeline.add_children(
-        python.evaluate_git_tag_pep404_conformity(),
+        python.evaluate_git_tag_pep440_conformity(),
         python.twine_upload(),
     )
 

CHANGELOG.md

@@ -13,9 +13,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-* **BREAKING:** The signature of `gcip.addons.python.jobs.twine_upload() has changed. The parameters `twine_repository_url`,
+* **BREAKING:** The signature of `gcip.addons.python.jobs.twine_upload()` has changed. The parameters `twine_repository_url`,
   `twine_username_env_var` and `twine_username_env_var` substitute the parameters `repository_url`, `user` and `varname_password`.
   Check the API documentation for the new parameters.
+* **BREAKING:** Renamed all occurences of `pep404` to `pep440` as PEP 440 is the right specification number.
 
 ## [Template]
 

gcip/addons/python/jobs.py

@@ -89,17 +89,17 @@ def pytest() -> Job:
     )
 
 
-def evaluate_git_tag_pep404_conformity() -> Job:
+def evaluate_git_tag_pep440_conformity() -> Job:
     """
     Checks if the current pipelines `$CI_COMMIT_TAG` validates to a valid Python package version according to
     https://www.python.org/dev/peps/pep-0440
 
     This job already contains a rule to only run when a `$CI_COMMIT_TAG` is present (`rules.only_tags()`).
     """
     job = Job(
-        name="evaluate_git_tag_pep404_conformity",
+        name="evaluate_git_tag_pep440_conformity",
         namespace="test",
-        script="python3 -m gcip.tools.evaluate_git_tag_pep404_conformity",
+        script="python3 -m gcip.tools.evaluate_git_tag_pep440_conformity",
     )
     job.append_rules(rules.on_tags())
     job.set_image("thomass/gcip:0.3.0")

gcip/addons/python/sequences.py

@@ -44,7 +44,7 @@ def full_stack(
         python.isort(),
         python.flake8(),
         python.pytest(),
-        python.evaluate_git_tag_pep404_conformity(),
+        python.evaluate_git_tag_pep440_conformity(),
         python.bdist_wheel(),
     )
 

gcip/tools/evaluate_git_tag_pep440_conformity.py

@@ -0,0 +1,33 @@
+import os
+import re
+import sys
+
+__author__ = "Thomas Steinbach"
+__copyright__ = "Copyright 2020 DB Systel GmbH"
+__credits__ = ["Thomas Steinbach"]
+# SPDX-License-Identifier: Apache-2.0
+__license__ = 'Apache-2.0'
+__maintainer__ = 'Thomas Steinbach'
+__email__ = 'thomas.t.steinbach@deutschebahn.com'
+
+
+# https://www.python.org/dev/peps/pep-0440/#appendix-b-parsing-version-strings-with-regular-expressions
+def is_canonical(version: str) -> bool:
+    return re.match(
+        r'^([1-9][0-9]*!)?(0|[1-9][0-9]*)(\.(0|[1-9][0-9]*))*((a|b|rc)(0|[1-9][0-9]*))?(\.post(0|[1-9][0-9]*))?(\.dev(0|[1-9][0-9]*))?$',
+        version
+    ) is not None
+
+
+if __name__ == "__main__":
+    ci_commit_tag = os.getenv('CI_COMMIT_TAG')
+
+    if ci_commit_tag is None:
+        raise ValueError("Environment variable CI_COMMIT_TAG must be set.")
+
+    if is_canonical(ci_commit_tag):
+        sys.exit()
+
+    print(f"'{ci_commit_tag}' is not a valid Python package version.")
+    print('See https://www.python.org/dev/peps/pep-0440')
+    sys.exit(1)

setup.py

@@ -3,7 +3,7 @@
 import setuptools
 
 from gcip.tools import (
-    evaluate_git_tag_pep404_conformity as pep404,
+    evaluate_git_tag_pep440_conformity as pep440,
 )
 
 __author__ = "Thomas Steinbach"
@@ -17,7 +17,7 @@
 
 def get_version() -> str:
     ci_commit_tag = os.getenv("CI_COMMIT_TAG")
-    if ci_commit_tag is not None and pep404.is_canonical(ci_commit_tag):
+    if ci_commit_tag is not None and pep440.is_canonical(ci_commit_tag):
         return ci_commit_tag
 
     version_from_pipeline = os.getenv('GCIP_VERSION')

tests/unit/comparison_files/test_python_full_stack_test.yml

@@ -18,12 +18,12 @@ test-pytest:
   script:
   - pip3 install --upgrade -v -r requirements.txt
   - pytest
-test-evaluate-git-tag-pep404-conformity:
+test-evaluate-git-tag-pep440-conformity:
   image:
     name: thomass/gcip:0.3.0
   stage: test
   script:
-  - python3 -m gcip.tools.evaluate_git_tag_pep404_conformity
+  - python3 -m gcip.tools.evaluate_git_tag_pep440_conformity
   rules:
   - if: $CI_COMMIT_TAG
     when: on_success
@@ -60,9 +60,9 @@ deploy-twine-upload-dev:
   - pip3 install --upgrade twine
   - python3 -m twine upload --non-interactive --disable-progress-bar dist/*
   variables:
+    TWINE_USERNAME: $$ARTIFACTORY_DEV_USER
+    TWINE_PASSWORD: $$ARTIFACTORY_DEV_PASSWORD
     TWINE_REPOSITORY_URL: https://my.artifactory.net/pypi/dev-repository
-    TWINE_USERNAME: $ARTIFACTORY_DEV_USER
-    TWINE_PASSWORD: $ARTIFACTORY_DEV_PASSWORD
   rules:
   - if: $CI_COMMIT_TAG
     when: never
@@ -75,9 +75,9 @@ deploy-twine-upload-stable:
   - pip3 install --upgrade twine
   - python3 -m twine upload --non-interactive --disable-progress-bar dist/*
   variables:
+    TWINE_USERNAME: $$ARTIFACTORY_PROD_USER
+    TWINE_PASSWORD: $$ARTIFACTORY_PROD_PASSWORD
     TWINE_REPOSITORY_URL: https://my.artifactory.net/pypi/prod-repository
-    TWINE_USERNAME: $ARTIFACTORY_PROD_USER
-    TWINE_PASSWORD: $ARTIFACTORY_PROD_PASSWORD
   rules:
   - if: $CI_COMMIT_TAG
     when: on_success

tests/unit/comparison_files/test_python_full_stack_test_with_mypy.yml

@@ -18,12 +18,12 @@ test-pytest:
   script:
   - pip3 install --upgrade -v -r requirements.txt
   - pytest
-test-evaluate-git-tag-pep404-conformity:
+test-evaluate-git-tag-pep440-conformity:
   image:
     name: thomass/gcip:0.3.0
   stage: test
   script:
-  - python3 -m gcip.tools.evaluate_git_tag_pep404_conformity
+  - python3 -m gcip.tools.evaluate_git_tag_pep440_conformity
   rules:
   - if: $CI_COMMIT_TAG
     when: on_success
@@ -65,9 +65,9 @@ deploy-twine-upload-dev:
   - pip3 install --upgrade twine
   - python3 -m twine upload --non-interactive --disable-progress-bar dist/*
   variables:
+    TWINE_USERNAME: $$ARTIFACTORY_DEV_USER
+    TWINE_PASSWORD: $$ARTIFACTORY_DEV_PASSWORD
     TWINE_REPOSITORY_URL: https://my.artifactory.net/pypi/dev-repository
-    TWINE_USERNAME: $ARTIFACTORY_DEV_USER
-    TWINE_PASSWORD: $ARTIFACTORY_DEV_PASSWORD
   rules:
   - if: $CI_COMMIT_TAG
     when: never
@@ -80,9 +80,9 @@ deploy-twine-upload-stable:
   - pip3 install --upgrade twine
   - python3 -m twine upload --non-interactive --disable-progress-bar dist/*
   variables:
+    TWINE_USERNAME: $$ARTIFACTORY_PROD_USER
+    TWINE_PASSWORD: $$ARTIFACTORY_PROD_PASSWORD
     TWINE_REPOSITORY_URL: https://my.artifactory.net/pypi/prod-repository
-    TWINE_USERNAME: $ARTIFACTORY_PROD_USER
-    TWINE_PASSWORD: $ARTIFACTORY_PROD_PASSWORD
   rules:
   - if: $CI_COMMIT_TAG
     when: on_success