linting, docs, and reporting

Signed-off-by: Bryant Finney <[email protected]>

Author: bryant-finney

.gitlab-ci.yml

@@ -11,6 +11,7 @@ stages:
   - build
   - lint
   - test
+  - docs
   - deploy
 
 .dev image: &dev-image
@@ -53,6 +54,17 @@ include:
     project: poetry-tools/ci-cd
     ref: main
 
+  - file: poethepoet.yml
+    inputs:
+      <<: *dev-image
+      POETRY_VIRTUALENVS_CREATE: "false"
+      before-script: poetry install --only-root
+      poetry-install: "false"
+      stage: docs
+      task: docs
+    project: poetry-tools/ci-cd
+    ref: main
+
   - file: publish.yml
     inputs: *dev-image
     project: poetry-tools/ci-cd
@@ -87,9 +99,39 @@ include:
 
 ✔️ poetry check: *needs_docker-buildx-bake
 
-🪶 poe lint: *needs_docker-buildx-bake
-
-🪶 poe test: *needs_docker-buildx-bake
+🪶 poe lint:
+  <<: *needs_docker-buildx-bake
+
+  artifacts:
+    paths: [docs]
+    reports:
+      codequality: [docs/reports/pylint-gitlab.json]
+    untracked: true
+    when: always
+
+🪶 poe test:
+  <<: *needs_docker-buildx-bake
+
+  artifacts:
+    paths: [docs]
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: docs/reports/coverage.xml
+      junit: [docs/reports/pytest.xml]
+    untracked: true
+    when: always
+  coverage: '/Total coverage.*\s+(\d+(?:\.\d+)?)%/'
+
+🪶 poe docs:
+  artifacts:
+    untracked: true
+    when: on_success
+  needs:
+    - job: 🪶 poe lint
+      artifacts: true
+    - job: 🪶 poe test
+      artifacts: true
 
 🌐 poetry publish gitlab:
   needs: &poetry-publish-needs
@@ -101,6 +143,17 @@ include:
   rules:
     - if: $CI_COMMIT_REF_PROTECTED == "true"
 
+pages:
+  artifacts:
+    paths: [public]
+  needs:
+    - 🌐 poetry publish gitlab
+    - job: 🪶 poe docs
+      artifacts: true
+  rules: [if: $CI_COMMIT_REF_PROTECTED == "true"]
+  script: mv ./docs ./public
+  stage: deploy
+
 🌐 poetry publish testpypi:
   needs: *poetry-publish-needs
   rules: &only-protected-tags

.mdlrc

@@ -0,0 +1 @@
+rules "~MD013"

README.md

@@ -1,5 +1,13 @@
 # A Springy Little Configuration Reader
 
+[![latest release](https://gitlab.com/bryant.finney/pyspry/-/badges/release.svg)](https://gitlab.com/bryant.finney/pyspry/-/releases)
+[![pipeline status](https://gitlab.com/bryant.finney/pyspry/badges/main/pipeline.svg)](https://gitlab.com/bryant.finney/pyspry/-/commits/main)
+[![coverage report](https://gitlab.com/bryant.finney/pyspry/badges/main/coverage.svg)](https://gitlab.com/bryant.finney/pyspry/-/commits/main)
+[![Maintainability](https://api.codeclimate.com/v1/badges/996a01b1ab2df27571d5/maintainability)](https://codeclimate.com/github/bryant-finney/pyspry/maintainability)
+[![pylint](docs/reports/pylint.svg)](https://)
+[![PyPI version](https://badge.fury.io/py/pyspry.svg)](https://badge.fury.io/py/pyspry)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
 Influenced by [Spring Boot's YAML configuration features](https://docs.spring.io/spring-boot/docs/1.1.0.M1/reference/html/boot-features-external-config.html#boot-features-external-config-yaml),
 this library reads system configuration settings from environment variables and YAML files.
 
@@ -18,12 +26,14 @@ configuration settings. These can be accessed through the `pyspry.settings` modu
 
 For example, consider the following `config.yml` file:
 
-    DATABASES:
-      default:
-        AUTOCOMMIT: true
-        NAME: db.sqlite3
-    DEBUG: true
-    DEFAULT_CHARSET: utf-8
+```yml
+DATABASES:
+  default:
+    AUTOCOMMIT: true
+    NAME: db.sqlite3
+DEBUG: true
+DEFAULT_CHARSET: utf-8
+```
 
 These configuration settings can be accessed as follows:
 
@@ -137,7 +147,7 @@ GLOBAL OPTIONS
   --version      Print the version and exit
   -v, --verbose  Increase command output (repeatable)
   -q, --quiet    Decrease command output (repeatable)
-  -d, --dry-run  Print the task contents but don't actaully run it
+  -d, --dry-run  Print the task contents but don't actually run it
   --root PATH    Specify where to find the pyproject.toml
   --ansi         Force enable ANSI output
   --no-ansi      Force disable ANSI output

poetry.lock

@@ -67,6 +67,7 @@ django = "^4.1"
 django-extensions = "^3.2"
 anybadge = "^1.14"
 pylint = "^2.17"
+pylint-gitlab = "^1.2.0"
 
 [tool.poetry.group.pre-commit.dependencies]
 # note: these must be synchronized with `.pre-commit-config.yaml`
@@ -208,6 +209,17 @@ cmd = """
     --color always
 """
 
+[[tool.poe.tasks.lint.sequence]]
+cmd = """pylint src"""
+
+[[tool.poe.tasks.lint.sequence]]
+shell = """
+  grep -oE 'Your code has been rated at [0-9.]+' docs/reports/pylint-report.txt |
+    rev | cut -d' ' -f1 | rev |
+    xargs -I{} anybadge --overwrite --label pylint --value {} \
+      --file=docs/reports/pylint.svg 7=red 8=orange 9=yellow 10=green
+"""
+
 [[tool.poe.tasks.lint.sequence]]
 shell = "safety check --continue-on-error --full-report"
 
@@ -344,7 +356,7 @@ function-naming-style = "snake_case"
 # style. If left empty, function names will be checked with the set naming style.
 # function-rgx =
 # Good variable names which should always be accepted, separated by a comma.
-good-names = ["e", "f", "i", "j", "k", "ex", "Run", "_"]
+good-names = ["e", "f", "i", "j", "k", "v", "ex", "Run", "_"]
 # Good variable names regexes, separated by a comma. If names match any regex,
 # they will always be accepted
 # good-names-rgxs =
@@ -427,7 +439,7 @@ min-public-methods = 2
 
 [tool.pylint.exceptions]
 # Exceptions that will emit a warning when caught.
-overgeneral-exceptions = ["BaseException", "Exception"]
+overgeneral-exceptions = ["builtins.BaseException", "builtins.Exception"]
 
 [tool.pylint.format]
 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
@@ -509,6 +521,7 @@ disable = [
   "useless-suppression",
   "deprecated-pragma",
   "use-symbolic-message-instead",
+  "too-few-public-methods",
 ]
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -557,9 +570,14 @@ evaluation = "max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refact
 # Set the output format. Available formats are text, parseable, colorized, json
 # and msvs (visual studio). You can also give a reporter class, e.g.
 # mypackage.mymodule.MyReporterClass.
-# output-format =
+output-format = """\
+  colorized,\
+  pylint_gitlab.GitlabCodeClimateReporter:docs/reports/pylint-gitlab.json,\
+  pylint_gitlab.GitlabPagesHtmlReporter:docs/reports/pylint-gitlab.html,\
+  text:docs/reports/pylint-report.txt\
+"""
 # Tells whether to display a full report or only the messages.
-# reports =
+reports = "y"
 # Activate the evaluation score.
 score = true
 

pyproject.toml

@@ -202,7 +202,7 @@ def __init__(self, config: dict[str, Any], environ: dict[str, str], prefix: str)
                 # the value must just be a simple string
                 parsed = value
 
-            if isinstance(parsed, list) or isinstance(parsed, dict):
+            if isinstance(parsed, (dict, list)):
                 env[key] = NestedDict(parsed)
             else:
                 env[key] = parsed
@@ -263,10 +263,10 @@ def __getattr_override(self, name: str) -> Any:
 
         try:
             attr_val = self.__config[attr_name]
-        except KeyError:
+        except KeyError as e:
             raise AttributeError(
                 f"'{self.__class__.__name__}' object has no attribute '{attr_name}'"
-            )
+            ) from e
 
         return (
             attr_val.serialize(strip_prefix=self.prefix)

src/pyspry/base.py

@@ -16,7 +16,9 @@
 from pyspry import settings as pyspry_settings
 from pyspry.base import Settings
 
-config_yaml = """
+# pylint: disable=redefined-outer-name
+
+CONFIG_YAML = """
     APP_NAME_ATTR_A: [1, 2, 3]
     APP_NAME_EXAMPLE_PARAM: a string!
     APP_NAME_ATTR_B_K: 0
@@ -38,7 +40,7 @@ def config() -> dict[str, Any]:
     Returns:
         dict[str, Any]: the dummy config for `NestedDict` objects
     """
-    config: dict[str, Any] = yaml.safe_load(config_yaml)
+    config: dict[str, Any] = yaml.safe_load(CONFIG_YAML)
     return config
 
 

src/pyspry/conftest.py

@@ -28,7 +28,7 @@ class NestedKeysView(KeysView[KT]):
         ... )
         >>> list(v)
         ['A0', 'A0_B00', 'A0_B00_C000', 'A0_B00_C001', 'A0_B01', 'A0_B01_C010', 'A0_B01_C011', 'A1', 'A1_B10', 'A1_B10_C100', 'A1_B10_C101', 'A1_B11', 'A1_B11_C110', 'A1_B11_C111']
-        """
+        """  # pylint: disable=line-too-long
 
         _mapping: Mapping[KT, Any]
         prefix: str
@@ -60,7 +60,7 @@ def __iter__(self) -> Iterator[str]:  # type: ignore[override]
 # TODO: drop after support for 3.8 is dropped
 else:  # pragma: no cover
     # stdlib
-    from collections.abc import KeysView, Mapping
+    from collections.abc import KeysView, Mapping  # pylint: disable=ungrouped-imports
 
     class NestedKeysView(KeysView):  # type: ignore[no-redef,type-arg]
         """Override `KeysView` to recurse through nesting.
@@ -73,7 +73,7 @@ class NestedKeysView(KeysView):  # type: ignore[no-redef,type-arg]
         ... )
         >>> list(v)
         ['A0', 'A0_B00', 'A0_B00_C000', 'A0_B00_C001', 'A0_B01', 'A0_B01_C010', 'A0_B01_C011', 'A1', 'A1_B10', 'A1_B10_C100', 'A1_B10_C101', 'A1_B11', 'A1_B11_C110', 'A1_B11_C111']
-        """
+        """  # pylint: disable=line-too-long
 
         _mapping: Mapping  # type: ignore[type-arg]
 
@@ -272,7 +272,7 @@ def __setitem__(self, name: str, value: Any) -> None:
     @classmethod
     def _ensure_structure(cls, data: dict[Any, Any]) -> None:
         for key, maybe_nested in list(data.items()):
-            if isinstance(maybe_nested, dict) or isinstance(maybe_nested, list):
+            if isinstance(maybe_nested, (dict, list)):
                 data[key] = NestedDict(maybe_nested)
 
     def get_first_match(self, nested_name: str) -> Any:

src/pyspry/nested_dict.py

@@ -2,4 +2,4 @@
 from __future__ import annotations
 
 # local
-from pyspry.conftest import config, config_path, config_yaml, settings  # noqa: F401
+from pyspry.conftest import CONFIG_YAML, config, config_path, settings  # noqa: F401