commented-configparser 2.0.0__tar.gz → 2.2.0__tar.gz

commented_configparser-2.2.0/.github/workflows/pypi-publish.yml

@@ -0,0 +1,56 @@
+name: "Publish Python distribution to PyPI"
+# Uses:
+# https://github.com/actions/setup-python : 0b93645e9fea7318ecaed2b359559ac225c90a2b
+# https://github.com/actions/checkout : 11bd71901bbe5b1630ceea73d27597364c9af683
+# https://github.com/actions/download-artifact : fa0a91b85d4f404e444e00e005971372dc801d16
+# https://github.com/actions/upload-artifact : 6f51ac03b9356f520e9adb1b1b7802705f340c2b
+# https://github.com/actions/pypa/gh-action-pypi-publish : 76f52bc884231f62b9a034ebfe128415bbaabdfc
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: "Build distribution"
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - uses: "actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683"
+        with:
+          persist-credentials: false
+
+      - name: "Set up Python"
+        uses: "actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b"
+        with:
+          python-version: "3.12"
+
+      - name: "Build the package"
+        run: "python -m pip install nox; nox --session build"
+
+      - name: "Store the distribution packages"
+        uses: "actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b"
+        with:
+          name: "python-package-distributions"
+          path: "dist/"
+
+  publish-to-pypi:
+    name: "Publish Python Distribution to PyPI"
+    if: startsWith(github.ref, 'refs/tags/')
+    needs: ["build"]
+    runs-on: "ubuntu-latest"
+    environment:
+      name: "pypi"
+      url: "https://pypi.org/p/commented-configparser"
+    permissions:
+      id-token: "write"
+
+    steps:
+      - name: "Download all the dists"
+        uses: "actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16"
+        with:
+          name: "python-package-distributions"
+          path: "dist/"
+
+      - name: "Publish distribution to PyPI"
+        uses: "pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc"

commented_configparser-2.2.0/.github/workflows/python-tests.yml

@@ -0,0 +1,119 @@
+name: "python tests and coverage"
+# Uses:
+# https://github.com/actions/setup-python : 0b93645e9fea7318ecaed2b359559ac225c90a2b
+# https://github.com/actions/checkout : 11bd71901bbe5b1630ceea73d27597364c9af683
+# https://github.com/actions/download-artifact : fa0a91b85d4f404e444e00e005971372dc801d16
+# https://github.com/actions/upload-artifact : 6f51ac03b9356f520e9adb1b1b7802705f340c2b
+
+on:
+  pull_request:
+    branches:
+      - "main"
+  push:
+    branches:
+      - "main"
+
+jobs:
+  settings:
+    runs-on: "ubuntu-latest"
+    name: "Define workflow settings"
+    outputs:
+      default-python-version: "3.12"
+    steps:
+      - name: "Define settings"
+        run: ""
+
+  run-tests-and-coverage:
+    name: "Run pytest with coverage."
+    needs: ["settings"]
+    runs-on: "${{ matrix.os }}"
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - "windows-latest"
+          - "ubuntu-latest"
+        python-version:
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+
+    steps:
+      - name: "Repo checkout"
+        uses: "actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683"
+
+      - name: "Set up Python ${{ matrix.python-version }}"
+        uses: "actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b"
+        with:
+          python-version: "${{ matrix.python-version }}"
+          allow-prereleases: true
+
+      - name: "Install nox"
+        run: |
+          python -m pip install --upgrade nox
+
+      - name: "Run tests and coverage via nox"
+        run: |
+          nox --session test -- partial-coverage
+
+      - name: "Save coverage artifact"
+        uses: "actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b"
+        with:
+          name: "coverage-artifact-${{ matrix.os}}-${{ matrix.python-version}}"
+          path: ".coverage.*"
+          retention-days: 1
+          include-hidden-files: true
+
+  coverage-compile:
+    name: "Compile coverage reports."
+    needs: ["settings", "run-tests-and-coverage"]
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Repo checkout"
+        uses: "actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683"
+
+      - name: "Set up Python"
+        uses: "actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b"
+        with:
+          python-version: "${{ needs.settings.outputs.default-python-version }}"
+
+      - name: "Install nox"
+        run: |
+          python -m pip install --upgrade nox
+
+      - name: "Download coverage artifacts"
+        uses: "actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16"
+        with:
+          pattern: "coverage-artifact-*"
+          merge-multiple: true
+
+      - name: "Compile coverage data, print report"
+        run: |
+          nox --session coverage_combine
+          export TOTAL=$(python -c "import json;print(json.load(open('coverage.json'))['totals']['percent_covered_display'])")
+          echo "TOTAL=$TOTAL" >> $GITHUB_ENV
+          echo "### Total coverage: ${TOTAL}%" >> $GITHUB_STEP_SUMMARY
+
+  linting:
+    name: "Check linting and formatting requirements"
+    needs: ["settings"]
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Repo checkout"
+        uses: "actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683"
+
+      - name: "Set up Python"
+        uses: "actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b"
+        with:
+          python-version: "${{ needs.settings.outputs.default-python-version }}"
+
+      - name: "Install nox"
+        run: |
+          python -m pip install --upgrade nox
+
+      - name: "Run formatters and linters"
+        run: |
+          nox --session lint

{commented_configparser-2.0.0 → commented_configparser-2.2.0}/.gitignore

@@ -1,6 +1,6 @@
 temp_*
 .env
-venv/
+.venv/
 *egg-info/
 .tox/
 .coverage

{commented_configparser-2.0.0 → commented_configparser-2.2.0}/.pre-commit-config.yaml

@@ -4,7 +4,7 @@ exclude: ^.+\.ini$
 repos:
   # Batch of helpful formatters and patterns
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: "v4.6.0"
+    rev: "v5.0.0"
     hooks:
       - id: check-json
       - id: check-toml
@@ -12,12 +12,10 @@ repos:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-docstring-first
-      - id: debug-statements
-      - id: mixed-line-ending
 
   # Adds a standard feel to import segments
   - repo: https://github.com/pycqa/isort
-    rev: 5.13.2
+    rev: 6.0.1
     hooks:
       - id: isort
         args:
@@ -29,22 +27,6 @@ repos:
 
   # Format code. No, I don't like everything black does either.
   - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 24.4.2
+    rev: 25.1.0
     hooks:
       - id: black
-
-  # Flake8 for linting, line-length adjusted to match Black default
-  - repo: https://github.com/PyCQA/flake8
-    rev: 7.1.0
-    hooks:
-      - id: flake8
-        additional_dependencies:
-          - flake8-builtins
-          - flake8-pep585
-          - pep8-naming
-
-  # Type enforcement for Python
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.11.1
-    hooks:
-      - id: mypy

commented_configparser-2.2.0/CONTRIBUTING.md

@@ -0,0 +1,120 @@
+# Contributing
+
+Before contributing, please either ask to claim an existing open issue or create
+a new issue to discuss your proposed changes with the owner(s) of this repo
+before making any changes.
+
+Any pull requests without a clearly defined issue being solved will be closed.
+
+### Bug reports
+
+Found a bug but do not have time or do not wish to contribute a fix? Please
+submit an issue for our awareness. Your feedback drives the continued
+development of the project!
+
+### Pull Request
+
+All pull requests must:
+
+- Pass all linting and formatting checks
+- Have tests that cover all branches of the added feature
+- If the PR is a bug fix there must be a test that duplicates the bug, proving
+  it is fixed
+
+### Code Style
+
+Follow the patterns seen in the code. Walk where others have walked.
+
+Be sure to run the expected formatters and linters prior to opening the PR.
+
+### Tests
+
+  - Smaller tests are easier to work with
+  - Mock at a minimum
+  - No test should be dependent on another
+  - No test should be dependent on secrets/tokens
+
+---
+
+# Local developer installation
+
+The following steps outline how to install this repo for local development.
+
+## Prerequisites
+
+### Clone repo
+
+```bash
+git clone https://github.com/Preocts/commented-configparser
+
+cd commented-configparser
+```
+
+### [Install nox](https://nox.thea.codes/en/stable/index.html)
+
+It is recommended to use a tool such as `pipx` or `uvx` to install nox. nox is
+needed to run the provided sessions for developer setup, linting, tests, and
+dependency management. It is optional, but these instructions will not cover
+manually steps outside of nox.
+
+
+## Nox Sessions
+
+### Developer Install
+
+This builds the `/.venv`, installs the editable
+package, and installs all dependency files.
+
+```bash
+nox -s dev
+```
+
+### Run tests with coverage
+
+```bash
+nox -s test
+```
+
+### Run formatters and linters
+
+```bash
+nox -s lint
+```
+
+### Build dist
+
+```bash
+nox -s build
+```
+
+---
+
+## Updating dependencies
+
+New dependencys can be added to the `requirements-*.txt` file. It is recommended
+to only use pins when specific versions or upgrades beyond a certain version are
+to be avoided. Otherwise, allow `pip-compile` to manage the pins in the
+generated `constraints.txt` file.
+
+Once updated following the steps below, the package can be installed if needed.
+
+### Update the generated files with changes
+
+```bash
+nox -s update-deps
+```
+
+### Upgrade all generated dependencies
+
+```bash
+nox -s upgrade-deps
+```
+
+---
+
+## [pre-commit](https://pre-commit.com)
+
+> A framework for managing and maintaining multi-language pre-commit hooks.
+
+This repo is setup with a `.pre-commit-config.yaml` with the expectation that
+any code submitted for review already passes all selected pre-commit checks.

{commented_configparser-2.0.0/src/commented_configparser.egg-info → commented_configparser-2.2.0}/PKG-INFO

@@ -1,52 +1,30 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: commented-configparser
-Version: 2.0.0
+Version: 2.2.0
 Summary: Custom ConfigParser class that preserves comments in file when writing
 Author-email: Preocts <preocts@preocts.com>
-License: MIT License
-        
-        Copyright (c) 2024 Preocts
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
+License-Expression: MIT
 Project-URL: homepage, https://github.com/Preocts/commented-configparser
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: Implementation :: CPython
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Provides-Extra: dev
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: black; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
 Requires-Dist: flake8; extra == "dev"
 Requires-Dist: flake8-builtins; extra == "dev"
 Requires-Dist: flake8-pep585; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-randomly; extra == "test"
 Requires-Dist: coverage; extra == "test"
-Requires-Dist: nox; extra == "test"
+Dynamic: license-file
 
-[![Python 3.8 | 3.9 | 3.10 | 3.11 | 3.12 | 3.13](https://img.shields.io/badge/Python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org/downloads)
+[![Python 3.9 | 3.10 | 3.11 | 3.12 | 3.13 | 3.14](https://img.shields.io/badge/Python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue)](https://www.python.org/downloads)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 
@@ -55,6 +33,11 @@ Requires-Dist: nox; extra == "test"
 
 # commented-configparser
 
+- [Contributing Guide and Developer Setup Guide](./CONTRIBUTING.md)
+- [License: MIT](./LICENSE)
+
+---
+
 A custom ConfigParser class that preserves comments and option casing when writing loaded config out.
 
 This library gives you a custom class of the standard library's `configparser.ConfigParger` which will preserve the comments of a loaded config file when writing that file back out.

{commented_configparser-2.0.0 → commented_configparser-2.2.0}/README.md

@@ -1,4 +1,4 @@
-[![Python 3.8 | 3.9 | 3.10 | 3.11 | 3.12 | 3.13](https://img.shields.io/badge/Python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org/downloads)
+[![Python 3.9 | 3.10 | 3.11 | 3.12 | 3.13 | 3.14](https://img.shields.io/badge/Python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue)](https://www.python.org/downloads)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 
@@ -7,6 +7,11 @@
 
 # commented-configparser
 
+- [Contributing Guide and Developer Setup Guide](./CONTRIBUTING.md)
+- [License: MIT](./LICENSE)
+
+---
+
 A custom ConfigParser class that preserves comments and option casing when writing loaded config out.
 
 This library gives you a custom class of the standard library's `configparser.ConfigParger` which will preserve the comments of a loaded config file when writing that file back out.

commented_configparser-2.2.0/noxfile.py

@@ -0,0 +1,203 @@
+from __future__ import annotations
+
+import os
+import pathlib
+import shutil
+import sys
+from functools import partial
+
+import nox
+
+# Control factors for finding pieces of the module
+MODULE_NAME = "commentedconfigparser"
+TESTS_PATH = "tests"
+COVERAGE_FAIL_UNDER = 100
+VENV_PATH = "./.venv"
+LINT_PATH = "./src"
+REQUIREMENTS_PATH = "./requirements"
+
+# What we allowed to clean (delete)
+CLEANABLE_TARGETS = [
+    "./dist",
+    "./build",
+    "./.nox",
+    "./.coverage",
+    "./.coverage.*",
+    "./coverage.json",
+    "./**/.mypy_cache",
+    "./**/.pytest_cache",
+    "./**/__pycache__",
+    "./**/*.pyc",
+    "./**/*.pyo",
+]
+
+# Define the default sessions run when `nox` is called on the CLI
+nox.options.default_venv_backend = "virtualenv"
+nox.options.sessions = ["lint", "test"]
+
+
+@nox.session()
+def dev(session: nox.Session) -> None:
+    """Setup a development environment by creating the venv and installs dependencies."""
+    # Use the active environement if it exists, otherwise create a new one
+    venv_path = os.environ.get("VIRTUAL_ENV", VENV_PATH)
+
+    if sys.platform == "win32":
+        venv_path = f"{venv_path}/Scripts"
+        activate_command = f"{venv_path}/activate"
+    else:
+        venv_path = f"{venv_path}/bin"
+        activate_command = f"source {venv_path}/activate"
+
+    if not os.path.exists(VENV_PATH):
+        session.run("python", "-m", "venv", VENV_PATH, "--upgrade-deps")
+
+    python = partial(session.run, f"{venv_path}/python", "-m")
+    contraint = ("--constraint", f"{REQUIREMENTS_PATH}/constraints.txt")
+
+    for requirement_file in get_requirement_files():
+        python("pip", "install", "-r", requirement_file, *contraint, external=True)
+
+    python("pip", "install", "--editable", ".", *contraint, external=True)
+
+    python("pip", "install", "pre-commit", external=True)
+    session.run(f"{venv_path}/pre-commit", "install", external=True)
+
+    if not os.environ.get("VIRTUAL_ENV"):
+        session.log(f"\n\nRun '{activate_command}' to enter the virtual environment.\n")
+
+
+@nox.session(name="test")
+def run_tests_with_coverage(session: nox.Session) -> None:
+    """Run pytest with coverage, outputs console report and json."""
+    print_standard_logs(session)
+
+    contraint = ("--constraint", f"{REQUIREMENTS_PATH}/constraints.txt")
+
+    session.install(".[test]", *contraint)
+
+    coverage = partial(session.run, "python", "-m", "coverage")
+
+    coverage("erase")
+
+    if "partial-coverage" in session.posargs:
+        coverage("run", "--parallel-mode", "--module", "pytest", TESTS_PATH)
+    else:
+        coverage("run", "--module", "pytest", TESTS_PATH)
+        coverage("report", "--show-missing", f"--fail-under={COVERAGE_FAIL_UNDER}")
+        coverage("json")
+
+
+@nox.session()
+def coverage_combine(session: nox.Session) -> None:
+    """CI: Combine parallel-mode coverage files and produce reports."""
+    print_standard_logs(session)
+
+    contraint = ("--constraint", f"{REQUIREMENTS_PATH}/constraints.txt")
+
+    session.install("-r", f"{REQUIREMENTS_PATH}/requirements-test.txt", *contraint)
+
+    coverage = partial(session.run, "python", "-m", "coverage")
+    coverage("combine")
+    coverage("report", "--show-missing", f"--fail-under={COVERAGE_FAIL_UNDER}")
+    coverage("json")
+
+
+@nox.session(name="lint")
+def run_linters_and_formatters(session: nox.Session) -> None:
+    """Run code formatters, linters, and type checking against all files."""
+    print_standard_logs(session)
+
+    contraint = ("--constraint", f"{REQUIREMENTS_PATH}/constraints.txt")
+    session.install(".[dev]", *contraint)
+
+    python = partial(session.run, "python", "-m")
+
+    # Handle anything tool that applies corrections first.
+    python(
+        "isort",
+        "--verbose",
+        "--force-single-line-imports",
+        "--profile",
+        "black",
+        "--add-import",
+        "from __future__ import annotations",
+        LINT_PATH,
+    )
+    python("black", "--verbose", LINT_PATH)
+
+    # Linters: aka, things that yell but want you to fix things
+    python("flake8", "--show-source", "--verbose", LINT_PATH)
+    python("mypy", "--no-incremental", "--package", MODULE_NAME)
+
+
+@nox.session()
+def build(session: nox.Session) -> None:
+    """Build distribution files."""
+    print_standard_logs(session)
+
+    session.install("build")
+    session.run("python", "-m", "build")
+
+
+@nox.session(name="update-deps")
+def update_deps(session: nox.Session) -> None:
+    """Process requirement*.txt files, updating only additions/removals."""
+    print_standard_logs(session)
+
+    session.install("pip-tools")
+    session.run(
+        "pip-compile",
+        "--strip-extras",
+        "--no-annotate",
+        "--no-emit-index-url",
+        "--output-file",
+        f"{REQUIREMENTS_PATH}/constraints.txt",
+        *get_requirement_files(),
+    )
+
+
+@nox.session(name="upgrade-deps")
+def upgrade_deps(session: nox.Session) -> None:
+    """Process requirement*.txt files and upgrade all libraries as possible."""
+    print_standard_logs(session)
+
+    session.install("pip-tools")
+    session.run(
+        "pip-compile",
+        "--strip-extras",
+        "--no-annotate",
+        "--no-emit-index-url",
+        "--upgrade",
+        "--output-file",
+        f"{REQUIREMENTS_PATH}/constraints.txt",
+        *get_requirement_files(),
+    )
+
+
+@nox.session(python=False)
+def clean(_: nox.Session) -> None:
+    """Clean cache, .pyc, .pyo, and test/build artifact files from project."""
+    count = 0
+    for searchpath in CLEANABLE_TARGETS:
+        for filepath in pathlib.Path(".").glob(searchpath):
+            if filepath.is_dir():
+                shutil.rmtree(filepath)
+            else:
+                filepath.unlink()
+            count += 1
+
+    print(f"{count} files cleaned.")
+
+
+def print_standard_logs(session: nox.Session) -> None:
+    """Reusable output for monitoring environment factors."""
+    version = session.run("python", "--version", silent=True)
+    session.log(f"Running from: {session.bin}")
+    session.log(f"Running with: {version}")
+
+
+def get_requirement_files() -> list[pathlib.Path]:
+    """Get a list of requirement files matching "requirements*.txt"."""
+    glob = pathlib.Path(REQUIREMENTS_PATH).glob("requirements*.txt")
+    return [path for path in glob]