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

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

@@ -0,0 +1,62 @@
+name: "Publish Python distribution to PyPI"
+# Uses:
+# https://github.com/actions/checkout : v7.0.1 de0fac2e4500dabe0009e67214ff5f5447ce83dd
+# https://github.com/actions/download-artifact : v8.0.2 9000827ccba6bdab643e8b6fd33ac0654aef8333
+# https://github.com/actions/upload-artifact : v7.0.2 cf430e030ddbb5b0abf93d22962f4752f3646cd9
+# https://github.com/astral-sh/setup-uv : v10.3.2 07a047e608db84b3d8c06cd9a7c7dcc9c355c18e
+# https://github.com/pypa/gh-action-pypi-publish : v1.14.3 7245906fb61fa33a13554f9d5fb856fe61758086
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: "Build package"
+    runs-on: "ubuntu-latest"
+    outputs:
+      artifact-id: "${{ steps.upload-artifact.outputs.artifact-id }}"
+
+    steps:
+      - uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd"
+        with:
+          persist-credentials: false
+
+      - name: "Install the latest version of uv"
+        uses: "astral-sh/setup-uv@07a047e608db84b3d8c06cd9a7c7dcc9c355c18e"
+        with:
+          version: "latest"
+          enable-cache: true
+
+      - name: "Build the package"
+        run: "uvx nox --session build"
+
+      - name: "Store the distribution packages"
+        id: "upload-artifact"
+        uses: "actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9"
+        with:
+          path: "./dist"
+
+  publish-to-pypi:
+    name: "Publish Python Distribution to PyPI"
+    needs: ["build"]
+    runs-on: "ubuntu-latest"
+    environment:
+      name: "pypi"
+      url: "https://pypi.org/project/commented-configparser/"
+    permissions:
+      id-token: "write"
+
+    steps:
+      - name: "Download all the dists"
+        uses: "actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333   "
+        with:
+          artifact-ids: "${{ needs.build.outputs.artifact-id }}"
+          path: "./dist"
+          merge-multiple: true
+
+      - name: "Publish distribution to PyPI"
+        uses: "pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086"
+        with:
+          repository-url: "https://upload.pypi.org/legacy/"
+          verbose: true

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

@@ -0,0 +1,116 @@
+name: "python tests and coverage"
+# Uses:
+# https://github.com/actions/checkout : v7.0.1 de0fac2e4500dabe0009e67214ff5f5447ce83dd
+# https://github.com/actions/download-artifact : v8.0.2 9000827ccba6bdab643e8b6fd33ac0654aef8333
+# https://github.com/actions/upload-artifact : v7.0.2 cf430e030ddbb5b0abf93d22962f4752f3646cd9
+# https://github.com/astral-sh/setup-uv : v10.3.2 07a047e608db84b3d8c06cd9a7c7dcc9c355c18e
+
+
+on:
+  pull_request:
+  push:
+    branches:
+      - "main"
+
+jobs:
+  set-statics:
+    name: "Set static values"
+    runs-on: "ubuntu-slim"
+    outputs:
+      linux-version: "ubuntu-26.04"
+      uv-version: "0.13.4"
+
+    steps:
+      - name: "Set Statics"
+        run: echo ""
+
+  run-tests-and-coverage:
+    name: "Run nox for tests and coverage"
+    needs: "set-statics"
+    runs-on: "${{ matrix.os }}"
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - "${{ needs.set-statics.outputs.linux-version }}"
+          - "windows-latest"
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+          - "3.15"
+
+    steps:
+      - name: "Repo checkout"
+        uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd"
+
+      - name: "Install the latest version of uv"
+        uses: "astral-sh/setup-uv@07a047e608db84b3d8c06cd9a7c7dcc9c355c18e"
+        with:
+          version: "${{ needs.set-statics.outputs.uv-version }}"
+          python-version: "${{ matrix.python-version }}"
+          enable-cache: true
+
+      - name: "Run tests and coverage via nox"
+        run: "uvx nox --session test -- partial-coverage"
+
+      - name: "Save coverage artifact"
+        uses: "actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9"
+        with:
+          name: "coverage-artifact-${{ matrix.os}}-${{ matrix.python-version}}"
+          path: ".coverage.*"
+          retention-days: 1
+          include-hidden-files: true
+
+  coverage-compile:
+    name: "coverage compile"
+    needs: ["set-statics", "run-tests-and-coverage"]
+    runs-on: "${{ needs.set-statics.outputs.linux-version }}"
+    steps:
+      - name: "Repo checkout"
+        uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd"
+
+      - name: "Install the latest version of uv"
+        uses: "astral-sh/setup-uv@07a047e608db84b3d8c06cd9a7c7dcc9c355c18e"
+        with:
+          version: "${{ needs.set-statics.outputs.uv-version }}"
+          enable-cache: true
+
+      - name: "Download coverage artifacts"
+        uses: "actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333"
+        with:
+          pattern: "coverage-artifact-*"
+          merge-multiple: true
+
+      - name: "Compile coverage data"
+        run: "uvx nox --session combine"
+
+      - name: "Post summary to step summary"
+        run: |
+          export TOTAL=$(python -c "import json;print(json.load(open('coverage.json'))['totals']['percent_covered_display'])")
+          echo "COVERAGE-TOTAL=$TOTAL" >> $GITHUB_ENV
+
+  linters-and-formatters:
+    name: "linters and formatters"
+    needs: "set-statics"
+    runs-on: "${{ needs.set-statics.outputs.linux-version }}"
+    steps:
+      - name: "Repo checkout"
+        uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd"
+
+      - name: "Install the latest version of uv"
+        uses: "astral-sh/setup-uv@07a047e608db84b3d8c06cd9a7c7dcc9c355c18e"
+        with:
+          version: "${{ needs.set-statics.outputs.uv-version }}"
+          enable-cache: true
+
+      - name: "Run linters and formatters"
+        run: "uvx nox --session format lint"
+
+      - name: "Check for any unstaged changes"
+        run: |
+          if [ -n "$(git status --porcelain)" ]; then
+            echo "#### Format or Lint changes found. Please run 'uvx nox' locally and push the changes." >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi

commented_configparser-3.1.1/.python-version

@@ -0,0 +1 @@
+3.11

commented_configparser-3.1.1/CONTRIBUTING.md

@@ -0,0 +1,115 @@
+# 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
+
+### [Install uv](https://docs.astral.sh/uv/getting-started/installation/)
+
+uv is required to use the provided noxfile sessions for developer setup,
+linting, and tests. Using nox is completely optional, all sessions can be
+manually recreated. These instructions will not cover those cases.
+
+## Nox Sessions
+
+### Developer Install
+
+```console
+uvx nox -s dev
+```
+
+### Validate uv.lock
+
+```console
+uvx nox -s lock
+```
+
+### Run tests and display coverage
+
+```console
+uvx nox -s test
+```
+
+Passing extra arguements to pytest:
+
+```console
+uvx nox -s test -- -vvv -x --full-trace
+```
+
+### Run linters
+
+```console
+uvx nox -s lint
+```
+
+### Run formatters
+
+```console
+uvx nox -s format
+```
+
+### Run all checks
+
+```console
+uvx nox
+```
+
+### Build dist
+
+```console
+uvx nox -s build
+```
+
+---
+
+## Updating dependencies
+
+Use the `uv` cli to add, update, and remove dependencies from the project.
+
+```console
+uv add [package name]
+
+uv remove [package name]
+
+uv lock --upgrade
+
+uv lock --upgrade-package [package name]
+```

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

@@ -1,46 +1,32 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: commented-configparser
-Version: 2.2.0
-Summary: Custom ConfigParser class that preserves comments in file when writing
+Version: 3.1.1
+Summary: A custom ConfigParser class that preserves comments and most formatting when writing loaded config out.
+Project-URL: homepage, https://github.com/Preocts/commented-configparser
 Author-email: Preocts <preocts@preocts.com>
 License-Expression: MIT
-Project-URL: homepage, https://github.com/Preocts/commented-configparser
+License-File: LICENSE
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: Implementation :: CPython
-Requires-Python: >=3.9
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
-License-File: LICENSE
-Provides-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"
-Dynamic: license-file
-
-[![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)
 
-[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Preocts/commented-configparser/main.svg)](https://results.pre-commit.ci/latest/github/Preocts/commented-configparser/main)
+[![Python >=3.11](https://img.shields.io/badge/Python->=3.11-blue)](https://www.python.org/downloads)
+[![PyPI - Version](https://img.shields.io/pypi/v/commented-configparser)](https://pypi.org/project/commented-configparser)
 [![Python tests](https://github.com/Preocts/commented-configparser/actions/workflows/python-tests.yml/badge.svg?branch=main)](https://github.com/Preocts/commented-configparser/actions/workflows/python-tests.yml)
 
-# commented-configparser
-
-- [Contributing Guide and Developer Setup Guide](./CONTRIBUTING.md)
-- [License: MIT](./LICENSE)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Nox](https://img.shields.io/badge/%F0%9F%A6%8A-Nox-D85E00.svg)](https://github.com/wntrblm/nox)
 
----
+# commented-configparser
 
-A custom ConfigParser class that preserves comments and option casing when writing loaded config out.
+A custom ConfigParser class that preserves comments and most formatting 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.
+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.
 
 ---
 
@@ -84,7 +70,11 @@ with open("myconfig.ini", "w") as savefile:
 
 ## Results
 
-We favor the line spacing choices of the `ConfigParser` class so the input format may not be preserved completely. However, the comments will be preserved.
+There is the attempt to retain the original format. Known formats that will not
+be preserved:
+
+1. Indents will not be preserved outside of multi-line values
+2. Spacing around assignments will be normalized.
 
 ### Before
 
@@ -103,13 +93,12 @@ logging=true
 	; and many could be between things
 [NEW SECTION]
 # Another comment
-multi-line=
+multiLine=
 	value01
 	value02
 	value03
 closing=0
 # Trailing comment
-
 ```
 
 ### After
@@ -123,16 +112,16 @@ foo = bar
 trace = false
 logging = true
 ; This is a comment as well
+
 # so we need to track all of them
-; and many could be between things
 
+; and many could be between things
 [NEW SECTION]
 # Another comment
-multi-line =
+multiLine =
 	value01
 	value02
 	value03
 closing = 0
 # Trailing comment
-
 ```

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

@@ -1,20 +1,18 @@
-[![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)
-
-[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Preocts/commented-configparser/main.svg)](https://results.pre-commit.ci/latest/github/Preocts/commented-configparser/main)
+[![Python >=3.11](https://img.shields.io/badge/Python->=3.11-blue)](https://www.python.org/downloads)
+[![PyPI - Version](https://img.shields.io/pypi/v/commented-configparser)](https://pypi.org/project/commented-configparser)
 [![Python tests](https://github.com/Preocts/commented-configparser/actions/workflows/python-tests.yml/badge.svg?branch=main)](https://github.com/Preocts/commented-configparser/actions/workflows/python-tests.yml)
 
-# commented-configparser
-
-- [Contributing Guide and Developer Setup Guide](./CONTRIBUTING.md)
-- [License: MIT](./LICENSE)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Nox](https://img.shields.io/badge/%F0%9F%A6%8A-Nox-D85E00.svg)](https://github.com/wntrblm/nox)
 
----
+# commented-configparser
 
-A custom ConfigParser class that preserves comments and option casing when writing loaded config out.
+A custom ConfigParser class that preserves comments and most formatting 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.
+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.
 
 ---
 
@@ -58,7 +56,11 @@ with open("myconfig.ini", "w") as savefile:
 
 ## Results
 
-We favor the line spacing choices of the `ConfigParser` class so the input format may not be preserved completely. However, the comments will be preserved.
+There is the attempt to retain the original format. Known formats that will not
+be preserved:
+
+1. Indents will not be preserved outside of multi-line values
+2. Spacing around assignments will be normalized.
 
 ### Before
 
@@ -77,13 +79,12 @@ logging=true
 	; and many could be between things
 [NEW SECTION]
 # Another comment
-multi-line=
+multiLine=
 	value01
 	value02
 	value03
 closing=0
 # Trailing comment
-
 ```
 
 ### After
@@ -97,16 +98,16 @@ foo = bar
 trace = false
 logging = true
 ; This is a comment as well
+
 # so we need to track all of them
-; and many could be between things
 
+; and many could be between things
 [NEW SECTION]
 # Another comment
-multi-line =
+multiLine =
 	value01
 	value02
 	value03
 closing = 0
 # Trailing comment
-
 ```

commented_configparser-3.1.1/noxfile.py

@@ -0,0 +1,149 @@
+from __future__ import annotations
+
+import os
+import functools
+import pathlib
+import shutil
+
+import nox
+
+# Control factors for finding pieces of the module
+MODULE_NAME = "commentedconfigparser"
+LINT_PATH = "./src"
+TESTS_PATH = "./tests"
+
+_file_python_version = pathlib.Path(".python-version").read_text()
+_uv_python_version = os.getenv("UV_PYTHON", "")
+# Favor the UV_PYTHON environment variable as this should override the .python-version
+PYTHON_VERSION = _uv_python_version or _file_python_version
+
+# What we allowed to clean (delete)
+CLEANABLE_TARGETS = [
+    "./dist",
+    "./build",
+    "./.nox",
+    "./.coverage",
+    "./.coverage.*",
+    "./coverage.json",
+    "./htmlcov",
+    "./**/.mypy_cache",
+    "./**/.pytest_cache",
+    "./**/__pycache__",
+    "./**/*.pyc",
+    "./**/*.pyo",
+]
+
+# Define the default sessions run when `nox` is called on the CLI
+nox.options.default_venv_backend = "uv"
+nox.options.sessions = ["lock", "format", "lint", "test"]
+
+# All linters and formatters are run with `uv run --active`
+LINTERS: list[tuple[str, ...]] = [
+    ("flake8", "--show-source", LINT_PATH, TESTS_PATH),
+    ("mypy", "--pretty", "--package", MODULE_NAME),
+    ("mypy", "--pretty", TESTS_PATH),
+]
+FORMATTERS: list[tuple[str, ...]] = [
+    (
+        "isort",
+        "--force-single-line-imports",
+        "--profile",
+        "black",
+        "--add-import",
+        "from __future__ import annotations",
+        LINT_PATH,
+        TESTS_PATH,
+    ),
+    ("black", LINT_PATH, TESTS_PATH),
+]
+
+# Default args for all 'uv sync' and 'uv run' calls
+UV_ARGS = [
+    "--frozen",
+    "--quiet",
+    "--active",
+]
+
+
+@nox.session(name="dev", python=False)
+def create_dev_environment(session: nox.Session) -> None:
+    """Create a development environment."""
+    session.run_install("uv", "sync", "--frozen")
+
+
+@nox.session(name="test", python=PYTHON_VERSION)
+def run_tests_with_coverage(session: nox.Session) -> None:
+    """Run pytest in isolated environment, display coverage. Extra arguements passed to pytest."""
+    partial = "partial-coverage" in session.posargs
+
+    session.run_install("uv", "sync", *UV_ARGS)
+
+    coverage = functools.partial(session.run, "uv", "run", *UV_ARGS, "coverage")
+
+    coverage("erase")
+
+    if partial:
+        session.posargs.remove("partial-coverage")
+        coverage("run", "--parallel-mode", "--module", "pytest", *session.posargs)
+    else:
+        coverage("run", "--module", "pytest", *session.posargs)
+        coverage("report", "--show-missing")
+        coverage("html")
+
+
+@nox.session(name="combine", python=PYTHON_VERSION)
+def combine_coverage(session: nox.Session) -> None:
+    """Combine parallel-mode coverage files and produce reports."""
+    session.run_install("uv", "sync", *UV_ARGS)
+
+    coverage = functools.partial(session.run, "uv", "run", *UV_ARGS, "coverage")
+
+    coverage("combine")
+    coverage("report", "--show-missing")
+    coverage("html")
+    coverage("json")
+
+
+@nox.session(name="lint", python=PYTHON_VERSION)
+def run_linters(session: nox.Session) -> None:
+    """Run code linters, and type checking against all files."""
+    session.run_install("uv", "sync", "--group", "lint", *UV_ARGS)
+
+    for linter_args in LINTERS:
+        session.run("uv", "run", *UV_ARGS, *linter_args)
+
+
+@nox.session(name="format", python=PYTHON_VERSION)
+def run_formatters(session: nox.Session) -> None:
+    """Run code formatters against all files."""
+    session.run_install("uv", "sync", "--group", "format", *UV_ARGS)
+
+    for formatter_args in FORMATTERS:
+        session.run("uv", "run", *UV_ARGS, *formatter_args)
+
+
+@nox.session(name="build", python=False)
+def build_artifacts(session: nox.Session) -> None:
+    """Build a sdist and wheel."""
+    session.run("uv", "build")
+
+
+@nox.session(name="lock", python=False)
+def validate_lock_file(session: nox.Session) -> None:
+    """Ensure the uv.lock file exists and is aligned with dependencies."""
+    session.run("uv", "lock", "--check")
+
+
+@nox.session(name="clean", python=False)
+def clean_project_files(session: nox.Session) -> None:
+    """Clean cache, .pyc, .pyo, and 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
+
+    session.log(f"{count} files cleaned.")