pyprojkit 0.3.0__tar.gz → 0.3.1__tar.gz

{pyprojkit-0.3.0 → pyprojkit-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyprojkit
-Version: 0.3.0
+Version: 0.3.1
 Summary: Development workflow toolkit for Python projects: pyproject.toml sync, doit tasks, nox sessions
 Author: mm21
 Author-email: mm21 <mm21.dev@gmail.com>

{pyprojkit-0.3.0 → pyprojkit-0.3.1}/pyproject.toml

@@ -27,7 +27,7 @@ license-files = ["LICENSE"]
 name = "pyprojkit"
 readme = "README.md"
 requires-python = ">=3.12,<3.15"  # managed by pyprojkit
-version = "0.3.0"
+version = "0.3.1"
 
 [project.optional-dependencies]
 all = [

{pyprojkit-0.3.0 → pyprojkit-0.3.1}/src/pyprojkit/config/base.py

@@ -27,13 +27,13 @@ class ConfigError(Exception):
 @dataclass(kw_only=True)
 class BaseToolConfig(ABC):
     """
-    Configuration for a tool which reads its settings from a table in
-    `pyproject.toml`, e.g. `[tool.black]`.
+    Configuration for a tool which reads its settings from a table in `pyproject.toml`,
+    e.g. `[tool.black]`.
 
-    Dataclass fields map to table entries; a field whose name differs from its
-    TOML key declares the key via `field(metadata={"toml": "some-key"})`.
-    Fields set to `None` are omitted. Values derived from project-wide config
-    (e.g. black's `target-version`) are contributed by `extra_toml()`.
+    Dataclass fields map to table entries; a field whose name differs from its TOML key
+    declares the key via `field(metadata={"toml": "some-key"})`. Fields set to `None`
+    are omitted. Values derived from project-wide config (e.g. black's `target-version`)
+    are contributed by `extra_toml()`.
     """
 
     table_path: ClassVar[str]

{pyprojkit-0.3.0 → pyprojkit-0.3.1}/src/pyprojkit/config/profiles.py

@@ -1,9 +1,9 @@
 """
 Profile registries: named factories for pre-canned configurations.
 
-A tools profile encompasses all tool categories; a formatting profile covers
-just the formatter chain. Third parties can register their own profiles and
-reuse them across projects:
+A tools profile encompasses all tool categories; a formatting profile covers just the
+formatter chain. Third parties can register their own profiles and reuse them across
+projects:
 
 ```python
 from pyprojkit import register_tools_profile

{pyprojkit-0.3.0 → pyprojkit-0.3.1}/src/pyprojkit/sync.py

@@ -5,16 +5,16 @@ Managed content:
 
 - `project.requires-python`
 - Python version classifiers (`Programming Language :: Python :: 3[.X]`);
-  other classifiers are left untouched
+  other classifiers are left untouched, as are comments in the list
 - One `[tool.X]` table per enabled tool (fully owned — any hand edits or
   comments inside are overwritten)
 - `[tool.pyprojkit].managed`: bookkeeping list of owned tables, enabling safe
   removal of tables for tools dropped from the configuration
 
-Everything else (dependencies, build-system, urls, unmanaged tool tables,
-etc.) is preserved. Output is normalized with toml-sort (as a library, using
-the same settings as the managed `[tool.tomlsort]` table), so a subsequent
-`toml-sort` run in the format task is a no-op.
+Everything else (dependencies, build-system, urls, unmanaged tool tables, etc.) is
+preserved. Output is normalized with toml-sort (as a library, using the same settings as
+the managed `[tool.tomlsort]` table), so a subsequent `toml-sort` run in the format task
+is a no-op.
 """
 
 from __future__ import annotations
@@ -22,11 +22,11 @@ from __future__ import annotations
 import difflib
 import re
 from pathlib import Path
-from typing import Any, cast
+from typing import Any
 
 import tomlkit
 from tomlkit import TOMLDocument
-from tomlkit.items import Table
+from tomlkit.items import Null, Table
 
 from .config.base import ConfigError
 from .config.project import ProjectConfig
@@ -140,22 +140,74 @@ def _update_classifiers(project: Table, config: ProjectConfig):
     """
     Replace python version classifiers with those derived from config, preserving all
     others; result is sorted, with managed entries marked by an inline comment.
+
+    Comments in the existing list are preserved: an inline comment stays with its entry,
+    and a standalone comment stays with the entry it precedes (or is emitted at the end
+    of the list if it precedes none).
     """
-    existing = cast(list[str], [str(c) for c in project.get("classifiers", [])])
-    kept = [c for c in existing if not _CLASSIFIER_RE.match(c)]
     managed = set(config.python.classifiers)
+    existing = project.get("classifiers", [])
+    kept = [str(c) for c in existing if not _CLASSIFIER_RE.match(str(c))]
+    leading, inline, trailing = _collect_classifier_comments(
+        existing, set(kept) | managed
+    )
 
     array = tomlkit.array()
     for entry in sorted(set(kept) | managed):
+        for comment in leading.get(entry, []):
+            array.add_line(comment=comment, indent="  ")
         array.add_line(
             entry,
             indent="  ",
-            comment=_MANAGED_COMMENT if entry in managed else None,
+            comment=_MANAGED_COMMENT if entry in managed else inline.get(entry),
         )
+    for comment in trailing:
+        array.add_line(comment=comment, indent="  ")
     array.add_line(indent="")
     project["classifiers"] = array
 
 
+def _collect_classifier_comments(
+    array: Any, surviving: set[str]
+) -> tuple[dict[str, list[str]], dict[str, str], list[str]]:
+    """
+    Extract comments from an existing classifiers array, anchored to the entries they
+    accompany. Comments attached to entries which don't survive the sync are carried
+    forward to the next surviving entry.
+    """
+    leading: dict[str, list[str]] = {}
+    inline: dict[str, str] = {}
+    pending: list[str] = []
+
+    for group in getattr(array, "_value", []):
+        comment = _comment_text(group)
+        if group.value is None or isinstance(group.value, Null):
+            # standalone comment line
+            if comment:
+                pending.append(comment)
+            continue
+
+        entry = str(group.value)
+        if entry in surviving:
+            if pending:
+                leading.setdefault(entry, []).extend(pending)
+                pending = []
+            if comment and comment != _MANAGED_COMMENT:
+                inline[entry] = comment
+        elif comment and comment != _MANAGED_COMMENT:
+            # entry is going away; keep its comment as a standalone one
+            pending.append(comment)
+
+    return leading, inline, pending
+
+
+def _comment_text(group: Any) -> str | None:
+    comment = getattr(group, "comment", None)
+    if comment is None:
+        return None
+    return comment.trivia.comment.lstrip("#").strip() or None
+
+
 def _get_managed_list(doc: TOMLDocument) -> list[str]:
     try:
         return list(doc["tool"]["pyprojkit"]["managed"])  # type: ignore[index]