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

{commented_configparser-2.2.0 → commented_configparser-3.0.0}/.github/workflows/pypi-publish.yml

@@ -1,9 +1,9 @@
 name: "Publish Python distribution to PyPI"
 # Uses:
-# https://github.com/actions/setup-python : 0b93645e9fea7318ecaed2b359559ac225c90a2b
+# https://github.com/actions/setup-python : a26af69be951a213d495a4c3e4e4022e16d87065
 # https://github.com/actions/checkout : 11bd71901bbe5b1630ceea73d27597364c9af683
-# https://github.com/actions/download-artifact : fa0a91b85d4f404e444e00e005971372dc801d16
-# https://github.com/actions/upload-artifact : 6f51ac03b9356f520e9adb1b1b7802705f340c2b
+# https://github.com/actions/download-artifact : d3f86a106a0bac45b974a628896c90dbdf5c8093
+# https://github.com/actions/upload-artifact : ea165f8d65b6e75b540449e92b4886f43607fa02
 # https://github.com/actions/pypa/gh-action-pypi-publish : 76f52bc884231f62b9a034ebfe128415bbaabdfc
 
 on:
@@ -12,8 +12,10 @@ on:
 
 jobs:
   build:
-    name: "Build distribution"
+    name: "Build package"
     runs-on: "ubuntu-latest"
+    outputs:
+      artifact-id: "${{ steps.upload-artifact.outputs.artifact-id }}"
 
     steps:
       - uses: "actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683"
@@ -21,36 +23,39 @@ jobs:
           persist-credentials: false
 
       - name: "Set up Python"
-        uses: "actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b"
+        uses: "actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065"
         with:
           python-version: "3.12"
 
       - name: "Build the package"
-        run: "python -m pip install nox; nox --session build"
+        run: "python -m pip install nox; nox -s build"
 
       - name: "Store the distribution packages"
-        uses: "actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b"
+        id: "upload-artifact"
+        uses: "actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02"
         with:
-          name: "python-package-distributions"
-          path: "dist/"
+          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"
+      url: "https://pypi.org/project/commented-configparser/"
     permissions:
       id-token: "write"
 
     steps:
       - name: "Download all the dists"
-        uses: "actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16"
+        uses: "actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093"
         with:
-          name: "python-package-distributions"
-          path: "dist/"
+          artifact-ids: "${{ needs.build.outputs.artifact-id }}"
+          path: "./dist"
+          merge-multiple: true
 
       - name: "Publish distribution to PyPI"
         uses: "pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc"
+        with:
+          repository-url: "https://upload.pypi.org/legacy/"
+          verbose: true

commented_configparser-3.0.0/.github/workflows/pypi-test-publish.yml

@@ -0,0 +1,62 @@
+name: "Publish Python distribution to PyPI Test"
+# Uses:
+# https://github.com/actions/setup-python : a26af69be951a213d495a4c3e4e4022e16d87065
+# https://github.com/actions/checkout : 11bd71901bbe5b1630ceea73d27597364c9af683
+# https://github.com/actions/download-artifact : d3f86a106a0bac45b974a628896c90dbdf5c8093
+# https://github.com/actions/upload-artifact : ea165f8d65b6e75b540449e92b4886f43607fa02
+# https://github.com/actions/pypa/gh-action-pypi-publish : 76f52bc884231f62b9a034ebfe128415bbaabdfc
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[a-z]+[0-9]+"
+
+jobs:
+  build:
+    name: "Build package"
+    runs-on: "ubuntu-latest"
+    outputs:
+      artifact-id: "${{ steps.upload-artifact.outputs.artifact-id }}"
+
+    steps:
+      - uses: "actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683"
+        with:
+          persist-credentials: false
+
+      - name: "Set up Python"
+        uses: "actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065"
+        with:
+          python-version: "3.12"
+
+      - name: "Build the package"
+        run: "python -m pip install nox; nox -s build"
+
+      - name: "Store the distribution packages"
+        id: "upload-artifact"
+        uses: "actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02"
+        with:
+          path: "./dist"
+
+  publish-to-pypi:
+    name: "Publish Python Distribution to PyPI"
+    needs: ["build"]
+    runs-on: "ubuntu-latest"
+    environment:
+      name: "testpypi"
+      url: "https://test.pypi.org/project/commented-configparser/"
+    permissions:
+      id-token: "write"
+
+    steps:
+      - name: "Download all the dists"
+        uses: "actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093"
+        with:
+          artifact-ids: "${{ needs.build.outputs.artifact-id }}"
+          path: "./dist"
+          merge-multiple: true
+
+      - name: "Publish distribution to PyPI"
+        uses: "pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc"
+        with:
+          repository-url: "https://test.pypi.org/legacy/"
+          verbose: true

{commented_configparser-2.2.0 → commented_configparser-3.0.0}/.github/workflows/python-tests.yml

@@ -1,9 +1,9 @@
 name: "python tests and coverage"
 # Uses:
-# https://github.com/actions/setup-python : 0b93645e9fea7318ecaed2b359559ac225c90a2b
+# https://github.com/actions/setup-python : a26af69be951a213d495a4c3e4e4022e16d87065
 # https://github.com/actions/checkout : 11bd71901bbe5b1630ceea73d27597364c9af683
-# https://github.com/actions/download-artifact : fa0a91b85d4f404e444e00e005971372dc801d16
-# https://github.com/actions/upload-artifact : 6f51ac03b9356f520e9adb1b1b7802705f340c2b
+# https://github.com/actions/download-artifact : d3f86a106a0bac45b974a628896c90dbdf5c8093
+# https://github.com/actions/upload-artifact : ea165f8d65b6e75b540449e92b4886f43607fa02
 
 on:
   pull_request:
@@ -46,7 +46,7 @@ jobs:
         uses: "actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683"
 
       - name: "Set up Python ${{ matrix.python-version }}"
-        uses: "actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b"
+        uses: "actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065"
         with:
           python-version: "${{ matrix.python-version }}"
           allow-prereleases: true
@@ -60,7 +60,7 @@ jobs:
           nox --session test -- partial-coverage
 
       - name: "Save coverage artifact"
-        uses: "actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b"
+        uses: "actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02"
         with:
           name: "coverage-artifact-${{ matrix.os}}-${{ matrix.python-version}}"
           path: ".coverage.*"
@@ -76,7 +76,7 @@ jobs:
         uses: "actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683"
 
       - name: "Set up Python"
-        uses: "actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b"
+        uses: "actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065"
         with:
           python-version: "${{ needs.settings.outputs.default-python-version }}"
 
@@ -85,7 +85,7 @@ jobs:
           python -m pip install --upgrade nox
 
       - name: "Download coverage artifacts"
-        uses: "actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16"
+        uses: "actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093"
         with:
           pattern: "coverage-artifact-*"
           merge-multiple: true
@@ -106,7 +106,7 @@ jobs:
         uses: "actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683"
 
       - name: "Set up Python"
-        uses: "actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b"
+        uses: "actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065"
         with:
           python-version: "${{ needs.settings.outputs.default-python-version }}"
 

commented_configparser-3.0.0/.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+ci:
+  autoupdate_schedule: monthly
+exclude: ^.+\.ini$
+repos:
+  # Batch of helpful formatters and patterns
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v5.0.0"
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: mixed-line-ending

{commented_configparser-2.2.0 → commented_configparser-3.0.0}/CONTRIBUTING.md

@@ -109,12 +109,3 @@ nox -s update-deps
 ```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.2.0 → commented_configparser-3.0.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: commented-configparser
-Version: 2.2.0
-Summary: Custom ConfigParser class that preserves comments in file when writing
+Version: 3.0.0
+Summary: A custom ConfigParser class that preserves comments and most formatting when writing loaded config out.
 Author-email: Preocts <preocts@preocts.com>
 License-Expression: MIT
 Project-URL: homepage, https://github.com/Preocts/commented-configparser
@@ -38,9 +38,12 @@ Dynamic: license-file
 
 ---
 
-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 +87,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 +110,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 +129,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.0.0}/README.md

@@ -12,9 +12,12 @@
 
 ---
 
-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 +61,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 +84,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 +103,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.0.0}/noxfile.py

@@ -16,6 +16,24 @@ VENV_PATH = "./.venv"
 LINT_PATH = "./src"
 REQUIREMENTS_PATH = "./requirements"
 
+LINTING_COMMANDS = (
+    (
+        "isort",
+        "--verbose",
+        "--force-single-line-imports",
+        "--profile",
+        "black",
+        "--add-import",
+        "from __future__ import annotations",
+        LINT_PATH,
+        TESTS_PATH,
+    ),
+    ("black", "--verbose", LINT_PATH, TESTS_PATH),
+    ("flake8", "--show-source", "--verbose", LINT_PATH, TESTS_PATH),
+    ("mypy", "--no-incremental", "--package", MODULE_NAME),
+    ("mypy", "--no-incremental", TESTS_PATH),
+)
+
 # What we allowed to clean (delete)
 CLEANABLE_TARGETS = [
     "./dist",
@@ -55,13 +73,7 @@ def dev(session: nox.Session) -> None:
     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)
+    python("pip", "install", "--editable", ".[dev,test]", *contraint, external=True)
 
     if not os.environ.get("VIRTUAL_ENV"):
         session.log(f"\n\nRun '{activate_command}' to enter the virtual environment.\n")
@@ -109,26 +121,12 @@ def run_linters_and_formatters(session: nox.Session) -> None:
     print_standard_logs(session)
 
     contraint = ("--constraint", f"{REQUIREMENTS_PATH}/constraints.txt")
-    session.install(".[dev]", *contraint)
+    session.install(".[dev,test]", *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)
+    for linter_command in LINTING_COMMANDS:
+        python(*linter_command)
 
 
 @nox.session()

{commented_configparser-2.2.0 → commented_configparser-3.0.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "commented-configparser"
 requires-python = ">=3.9"
-description = "Custom ConfigParser class that preserves comments in file when writing"
+description = "A custom ConfigParser class that preserves comments and most formatting when writing loaded config out."
 readme = "README.md"
 license = "MIT"
 authors = [

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

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: commented-configparser
-Version: 2.2.0
-Summary: Custom ConfigParser class that preserves comments in file when writing
+Version: 3.0.0
+Summary: A custom ConfigParser class that preserves comments and most formatting when writing loaded config out.
 Author-email: Preocts <preocts@preocts.com>
 License-Expression: MIT
 Project-URL: homepage, https://github.com/Preocts/commented-configparser
@@ -38,9 +38,12 @@ Dynamic: license-file
 
 ---
 
-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 +87,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 +110,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 +129,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.0.0}/src/commented_configparser.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ README.md
 noxfile.py
 pyproject.toml
 .github/workflows/pypi-publish.yml
+.github/workflows/pypi-test-publish.yml
 .github/workflows/python-tests.yml
 requirements/constraints.txt
 requirements/requirements-dev.txt
@@ -21,6 +22,8 @@ src/commentedconfigparser/__init__.py
 src/commentedconfigparser/commentedconfigparser.py
 src/commentedconfigparser/py.typed
 tests/commentedconfigparser_test.py
+tests/empty_comments_expected.ini
+tests/empty_comments_input.ini
 tests/header_expected.ini
 tests/header_input.ini
 tests/multi01_input.ini

{commented_configparser-2.2.0 → commented_configparser-3.0.0}/src/commentedconfigparser/commentedconfigparser.py

@@ -16,10 +16,11 @@ if TYPE_CHECKING:
 
 __all__ = ["CommentedConfigParser"]
 
-COMMENT_PATTERN = re.compile(r"^\s*[#|;]\s*(.+)$")
-COMMENT_OPTION_PATTERN = re.compile(r"^(\s*)?__comment_\d+\s?[=|:]\s?(.*)$")
-KEY_PATTERN = re.compile(r"^(.+?)\s?[=|:].*$")
-SECTION_PATTERN = re.compile(r"^\s*\[(.+)\]\s*$")
+_COMMENT_PATTERN = re.compile(r"^\s*[#|;]\s*(.*)$")
+_BLANK_LINE_PATTERN = re.compile(r"^\s*$")
+_COMMENT_OPTION_PATTERN = re.compile(r"^(\s*)?__comment_\d+\s?[=|:]\s?(.*)$")
+_KEY_PATTERN = re.compile(r"^(.+?)\s?[=|:].*$")
+_SECTION_PATTERN = re.compile(r"^\s*\[(.+)\]\s*$")
 
 
 class CommentedConfigParser(ConfigParser):
@@ -57,7 +58,15 @@ class CommentedConfigParser(ConfigParser):
 
     def read_file(self, f: Iterable[str], source: str | None = None) -> None:
         content = self._translate_comments([line for line in f])
-        return super().read_file(content.splitlines(), source)
+        self.__is_reading = True
+        super().read_file(content.splitlines(), source)
+        self.__is_reading = False
+
+    def optionxform(self, optionstr: str) -> str:
+        if hasattr(self, "_CommentedConfigParser__is_reading") and self.__is_reading:
+            return optionstr
+
+        return super().optionxform(optionstr)
 
     def write(
         self,
@@ -76,29 +85,34 @@ class CommentedConfigParser(ConfigParser):
 
         # To save the pain of mirroring ConfigParser's __init__ these two
         # attributes are created in the instance here, when needed.
-        if not hasattr(self, "_headers"):
-            self._headers: list[str] = []
+        if not hasattr(self, "_CommentedConfigParser__header_block"):
+            self.__header_block: list[str] = []
 
-        if not hasattr(self, "_commentprefix"):
-            self._commentprefix = 0
+        if not hasattr(self, "_CommentedConfigParser__file_index"):
+            self.__file_index = 0
 
         translated_lines = []
         for idx, line in enumerate(content):
-            if SECTION_PATTERN.match(line):
+            if _SECTION_PATTERN.match(line):
                 seen_section = True
 
             if not seen_section:
                 # Assume lines before a section are comments. If they are not
                 # the parent class will raise the needed exceptions for an
                 # invalid config format.
-                self._headers.append(line)
+                self.__header_block.append(line)
 
-            elif COMMENT_PATTERN.match(line):
+            elif _COMMENT_PATTERN.match(line):
                 # Translate the comment into an option for the section. These
                 # are handled by the parent and retain order of insertion.
-                line = f"__comment_{self._commentprefix}{idx}={line.lstrip()}"
+                line = f"__comment_{self.__file_index}{idx}={line.lstrip()}"
+
+            elif _BLANK_LINE_PATTERN.match(line):
+                # Blank lines cannot be stripped or the newline char will
+                # be lost which causes issues downstream.
+                line = f"__comment_{self.__file_index}{idx}={line}"
 
-            elif KEY_PATTERN.match(line) or SECTION_PATTERN.match(line):
+            elif _KEY_PATTERN.match(line) or _SECTION_PATTERN.match(line):
                 # Strip the left whitespace from sections and keys. This will
                 # leave only multiline values with leading whitespace preventing
                 # the saved output from incorrectly indenting after a comment
@@ -109,7 +123,7 @@ class CommentedConfigParser(ConfigParser):
 
         # If additional configuration files are loaded, comments may end up sharing
         # idx values which will clobber previously loaded comments.
-        self._commentprefix += 1
+        self.__file_index += 1
 
         return "".join(translated_lines)
 
@@ -117,11 +131,15 @@ class CommentedConfigParser(ConfigParser):
         """Restore comment options to comments."""
         # Apply the headers before parsing the config lines
         rendered = []
-        if hasattr(self, "_headers"):
-            rendered += self._headers
+        if hasattr(self, "_CommentedConfigParser__header_block"):
+            rendered += self.__header_block
 
         for line in content.splitlines():
-            comment_match = COMMENT_OPTION_PATTERN.match(line)
+            if not line:
+                # Skip the provided empty lines and use our own instead
+                continue
+
+            comment_match = _COMMENT_OPTION_PATTERN.match(line)
             if comment_match:
                 line = comment_match.group(2)
 

{commented_configparser-2.2.0 → commented_configparser-3.0.0}/tests/commentedconfigparser_test.py

@@ -20,10 +20,12 @@ from commentedconfigparser.commentedconfigparser import CommentedConfigParser
         ("  \tThis is a comment", False),
         ("", False),
         ("  \t", False),
+        ("#", True),
+        ("#\t", True),
     ),
 )
 def test_comment_pattern(line: str, expected: bool) -> None:
-    result = commentedconfigparser.COMMENT_PATTERN.match(line)
+    result = commentedconfigparser._COMMENT_PATTERN.match(line)
 
     assert bool(result) is expected
 
@@ -40,7 +42,7 @@ def test_comment_pattern(line: str, expected: bool) -> None:
     ),
 )
 def test_section_pattern(line: str, expected: bool) -> None:
-    result = commentedconfigparser.SECTION_PATTERN.match(line)
+    result = commentedconfigparser._SECTION_PATTERN.match(line)
 
     assert bool(result) is expected
 
@@ -61,7 +63,7 @@ def test_section_pattern(line: str, expected: bool) -> None:
 )
 def test_key_pattern(line: str, expected: str) -> None:
 
-    match = commentedconfigparser.KEY_PATTERN.match(line)
+    match = commentedconfigparser._KEY_PATTERN.match(line)
 
     assert match
     assert match.group(1) == expected
@@ -77,7 +79,7 @@ def test_key_pattern(line: str, expected: str) -> None:
 )
 def test_comment_option_pattern(line: str, expected: str) -> None:
 
-    match = commentedconfigparser.COMMENT_OPTION_PATTERN.match(line)
+    match = commentedconfigparser._COMMENT_OPTION_PATTERN.match(line)
 
     assert match
     assert match.group(2) == expected
@@ -126,7 +128,7 @@ def test_regression_read_dict_loads_normally() -> None:
 
 def test_regression_write_normally() -> None:
     cc = CommentedConfigParser()
-    expected = "[TEST]\ntest=pass\n\n"
+    expected = "[TEST]\ntest=pass\n"
     cc.read_string(expected)
     mock_file = StringIO()
 
@@ -137,7 +139,7 @@ def test_regression_write_normally() -> None:
 
 def test_write_with_no_comments() -> None:
     cc = CommentedConfigParser()
-    expected = "[TEST]\ntest=pass\n\n"
+    expected = "[TEST]\ntest=pass\n"
     cc.read_dict({"TEST": {"test": "pass"}})
     mock_file = StringIO()
 
@@ -149,6 +151,7 @@ def test_write_with_no_comments() -> None:
 @pytest.mark.parametrize(
     ("ini_in", "ini_expected"),
     (
+        (["empty_comments_input.ini"], "empty_comments_expected.ini"),
         (["header_input.ini"], "header_expected.ini"),
         (["pydocs_input.ini"], "pydocs_expected.ini"),
         (["regression_original_input.ini"], "regression_original_expected.ini"),
@@ -178,7 +181,7 @@ def test_issue_46_duplicating_sections(tmp_path: Path) -> None:
     # https://github.com/Preocts/commented-configparser/issues/46
     tmp_file = tmp_path / "issue46_test_file.ini"
     starting_config = "[example]\nfoo = 0\n"
-    expected = "[example]\nfoo = 9\n\n"
+    expected = "[example]\nfoo = 9\n"
     tmp_file.write_text(starting_config, "utf-8")
     cc = CommentedConfigParser()
     cc.read(tmp_file)

commented_configparser-3.0.0/tests/empty_comments_expected.ini

@@ -0,0 +1,17 @@
+# This has some headers
+#
+# These are comments that happen before any sections are defined
+
+[DEFAULT]
+foo = bar
+
+# Comment here
+#
+bar = foo
+;
+; Comment here too
+
+
+[BIZ]
+baz = bar
+

commented_configparser-3.0.0/tests/empty_comments_input.ini

@@ -0,0 +1,17 @@
+# This has some headers
+#
+# These are comments that happen before any sections are defined
+
+[DEFAULT]
+foo = bar
+
+# Comment here
+#
+bar = foo
+;
+; Comment here too
+
+
+[BIZ]
+baz=bar
+

{commented_configparser-2.2.0 → commented_configparser-3.0.0}/tests/header_expected.ini

@@ -8,4 +8,3 @@
 foo = bar
 # Comment here
 bar = foo
-

{commented_configparser-2.2.0 → commented_configparser-3.0.0}/tests/multi_expected.ini

@@ -8,4 +8,3 @@ foo = bar
 unique to multi02 = foo
 ; A nice little comment here from multi01
 unique to multi01 = foo
-

{commented_configparser-2.2.0 → commented_configparser-3.0.0}/tests/pydocs_expected.ini

@@ -12,7 +12,7 @@ values like this = 1000000
 or this = 3.14159265359
 are they treated as numbers? = no
 integers, floats and booleans are held as = strings
-can use the api to get converted values directly = true
+can use the API to get converted values directly = true
 
 [Multiline Values]
 chorus = I'm a lumberjack, and I'm okay
@@ -25,6 +25,7 @@ empty string value here =
 [You can use comments]
 # like this
 ; or this
+
 # By default only in an empty line.
 # Inline comments can be harmful because they prevent users
 # from using the delimiting characters as parts of values.
@@ -40,4 +41,3 @@ multiline_values = are
 	deeper than the first line
 	of a value
 # Did I mention we can indent comments, too?
-

{commented_configparser-2.2.0 → commented_configparser-3.0.0}/tests/regression_original_expected.ini

@@ -6,9 +6,10 @@ 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]
 foo = bar
 # Unique foo
@@ -17,5 +18,5 @@ multi-line =
 	value02
 	value03
 closing = 0
+caseVariant = 0
 # Trailing comment
-

{commented_configparser-2.2.0 → commented_configparser-3.0.0}/tests/regression_original_input.ini

@@ -18,4 +18,5 @@ multi-line=
 	value02
 	value03
 closing=0
+caseVariant=0
 # Trailing comment

commented_configparser-2.2.0/.pre-commit-config.yaml

@@ -1,32 +0,0 @@
-ci:
-  autoupdate_schedule: monthly
-exclude: ^.+\.ini$
-repos:
-  # Batch of helpful formatters and patterns
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: "v5.0.0"
-    hooks:
-      - id: check-json
-      - id: check-toml
-      - id: check-yaml
-      - id: trailing-whitespace
-      - id: end-of-file-fixer
-      - id: check-docstring-first
-
-  # Adds a standard feel to import segments
-  - repo: https://github.com/pycqa/isort
-    rev: 6.0.1
-    hooks:
-      - id: isort
-        args:
-          - "--force-single-line-imports"
-          - "--add-import"
-          - "from __future__ import annotations"
-          - "--profile"
-          - "black"
-
-  # Format code. No, I don't like everything black does either.
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 25.1.0
-    hooks:
-      - id: black