topmark 0.6.0__tar.gz → 0.6.2__tar.gz

{topmark-0.6.0/src/topmark.egg-info → topmark-0.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: topmark
-Version: 0.6.0
+Version: 0.6.2
 Summary: A Python CLI to inspect, validate, and manage license and copyright headers.
 Author-email: Olivier Biot <olivier.biot@gmail.com>
 License-Expression: MIT
@@ -43,7 +43,7 @@ Requires-Dist: pymdown-extensions>=10.8; extra == "docs"
 Requires-Dist: mkdocs-gen-files<0.6,>=0.5; extra == "docs"
 Requires-Dist: ruff; extra == "docs"
 Provides-Extra: test
-Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest>=8.0; extra == "test"
 Requires-Dist: pytest-xdist; extra == "test"
 Provides-Extra: typing
 Requires-Dist: types-toml; extra == "typing"
@@ -289,7 +289,7 @@ topmark check --apply src/
 ```
 
 > For full details, options, examples, and exit codes, see the dedicated guide:
-> **[Adding & updating headers with `topmark`](docs/usage/commands/topmark.md)**
+> **[Adding & updating headers with `topmark`](docs/usage/commands/check.md)**
 
 ### Removing headers with `strip`
 

{topmark-0.6.0 → topmark-0.6.2}/README.md

@@ -238,7 +238,7 @@ topmark check --apply src/
 ```
 
 > For full details, options, examples, and exit codes, see the dedicated guide:
-> **[Adding & updating headers with `topmark`](docs/usage/commands/topmark.md)**
+> **[Adding & updating headers with `topmark`](docs/usage/commands/check.md)**
 
 ### Removing headers with `strip`
 

{topmark-0.6.0 → topmark-0.6.2}/pyproject.toml

@@ -10,7 +10,7 @@
 
 [project]
 name = "topmark"
-version = "0.6.0"
+version = "0.6.2"
 description = "A Python CLI to inspect, validate, and manage license and copyright headers."
 authors = [{ name = "Olivier Biot", email = "olivier.biot@gmail.com" }]
 license = "MIT"
@@ -95,7 +95,7 @@ docs = [
 ]
 test = [
   # Unit testing framework:
-  "pytest",
+  "pytest>=8.0",
   # Parallel test execution:
   "pytest-xdist",
 ]

{topmark-0.6.0 → topmark-0.6.2}/src/topmark/api/__init__.py

@@ -39,9 +39,9 @@ Notes:
 Configuration contract
 ----------------------
 - Public functions accept either a plain **mapping** (mirroring the TOML shape) or a frozen
-  `topmark.config.Config`. We normalize/merge internally and run the pipeline against an
+  [`topmark.config.Config`][]. We normalize/merge internally and run the pipeline against an
   **immutable snapshot**.
-- The internal `topmark.config.MutableConfig` builder is **not part of the public API**.
+- The internal [`topmark.config.MutableConfig`][] builder is **not part of the public API**.
   It exists to perform discovery/merging and then ``freeze()`` to a `Config` just before
   execution. This keeps runtime deterministic and avoids accidental mutation.
 - To "update config" programmatically, pass a mapping to the function call:
@@ -456,7 +456,7 @@ def check(
             to narrow discovery.
         add_only (bool): Only add missing headers; do not update existing ones.
         update_only (bool): Only update non-compliant headers; do not add new ones.
-        skip_compliant (bool) : Exclude already-compliant files from the returned view.
+        skip_compliant (bool): Exclude already-compliant files from the returned view.
         skip_unsupported (bool): Exclude unsupported files from the returned view.
 
     Returns:
@@ -617,7 +617,7 @@ def get_filetype_info(long: bool = False) -> list[FileTypeInfo]:
 
     Notes:
         For object-level access, prefer `FileTypeRegistry` from
-        `topmark.registry`. This function returns metadata (not the objects).
+        [`topmark.registry`][]. This function returns metadata (not the objects).
     """
     proc_reg = Registry.processors()
 
@@ -658,7 +658,7 @@ def get_processor_info(long: bool = False) -> list[ProcessorInfo]:
 
     Notes:
         For object-level access, prefer `HeaderProcessorRegistry` from
-        `topmark.registry`. This function returns metadata (not the objects).
+        [`topmark.registry`][]. This function returns metadata (not the objects).
     """
     # Ensure all processors are registered before listing (idempotent)
     Registry.ensure_processors_registered()

{topmark-0.6.0 → topmark-0.6.2}/src/topmark/cli/console_helpers.py

@@ -10,9 +10,9 @@
 
 """Utilities for obtaining a program-output console independent of Click.
 
-This module exposes `get_console_safely` which returns the project’s
-console for user-facing output when running under a Click context, and a
-no-dependency stdlib fallback (`StdConsole`) when no context is active
+This module exposes `get_console_safely` which returns the project’s console
+for user-facing output when running under a Click context, and a no-dependency
+stdlib fallback ([`topmark.cli.console_std.StdConsole`][]) when no context is active
 (e.g., when the API is invoked directly from tests).
 """
 
@@ -33,7 +33,7 @@ def get_console_safely() -> ConsoleLike:
 
     If an active Click context exists and a console instance is stored in
     ``ctx.obj["console"]``, that console is returned. Otherwise, a
-    [`topmark.cli.console_std.StdConsole`][topmark.cli.console_std.StdConsole] is returned to avoid
+    [`topmark.cli.console_std.StdConsole`][] is returned to avoid
     raising ``RuntimeError: There is no active click context`` when the
     library is used programmatically (e.g., via pytest).
     """

{topmark-0.6.0 → topmark-0.6.2}/src/topmark/cli_shared/utils.py

@@ -46,7 +46,7 @@ class OutputFormat(str, Enum):
 
     Notes:
         - Machine formats (``JSON`` and ``NDJSON``) must not include ANSI color or diffs.
-        - Use with [`EnumChoiceParam`][topmark.cli.cli_types.EnumChoiceParam] to parse ``--format``
+        - Use with [`topmark.cli.cli_types.EnumChoiceParam`][] to parse ``--format``
           from Click.
     """
 

{topmark-0.6.0 → topmark-0.6.2}/src/topmark/pipeline/processors/base.py

@@ -38,7 +38,7 @@ class HeaderProcessor:
     """Base class for header processors that handle specific file types.
 
     A *header processor* knows how to **find**, **render**, and **modify** TopMark
-    headers for one concrete [`topmark.filetypes.base.FileType`][topmark.filetypes.base.FileType].
+    headers for one concrete [`topmark.filetypes.base.FileType`][].
     The registry binds a processor instance to a file type at runtime (``proc.file_type = ft``),
     and TopMark uses that pairing during scanning and updates.
 
@@ -59,7 +59,7 @@ class HeaderProcessor:
 
     What this class does **not** do:
         - **Content‑based recognition.** Deciding *which* file type a path belongs
-          to is the role of [`topmark.filetypes.base.FileType`][topmark.filetypes.base.FileType] via
+          to is the role of [`topmark.filetypes.base.FileType`][] via
           `FileType.content_matcher`. The processor assumes it is already
           associated with the correct file type.
 

{topmark-0.6.0 → topmark-0.6.2}/src/topmark/registry/__init__.py

@@ -12,9 +12,9 @@
 
 This package exposes:
 
-* [`Registry`][topmark.registry.Registry] – the **stable, read-only facade** for integrators.
-* [`FileTypeRegistry`][topmark.registry.FileTypeRegistry] and
-  [`HeaderProcessorRegistry`][topmark.registry.HeaderProcessorRegistry] – advanced,
+* [`topmark.registry.Registry`][] – the **stable, read-only facade** for integrators.
+* [`topmark.registry.FileTypeRegistry`][] and
+  [`topmark.registry.HeaderProcessorRegistry`][] – advanced,
   low-level registries intended for plugins and tests (no semver stability guarantee).
 
 Most users should import from here:

{topmark-0.6.0 → topmark-0.6.2}/src/topmark/registry/filetypes.py

@@ -59,10 +59,10 @@ class FileTypeRegistry:
         Returns:
             tuple[str, ...]: Sorted file type names.
         """
-        from topmark.filetypes.instances import get_file_type_registry as _get
+        from topmark.filetypes.instances import get_file_type_registry as _get_ft
 
         with cls._lock:
-            return tuple(sorted(_get().keys()))
+            return tuple(sorted(_get_ft().keys()))
 
     @classmethod
     def supported_names(cls) -> tuple[str, ...]:
@@ -92,10 +92,10 @@ class FileTypeRegistry:
         Returns:
             FileType | None: The `FileType` object if found, else None.
         """
-        from topmark.filetypes.instances import get_file_type_registry as _get
+        from topmark.filetypes.instances import get_file_type_registry as _get_ft
 
         with cls._lock:
-            return _get().get(name)
+            return _get_ft().get(name)
 
     @classmethod
     def as_mapping(cls) -> Mapping[str, FileType]:
@@ -107,10 +107,10 @@ class FileTypeRegistry:
         Notes:
             The returned mapping is a `MappingProxyType` and must not be mutated.
         """
-        from topmark.filetypes.instances import get_file_type_registry as _get
+        from topmark.filetypes.instances import get_file_type_registry as _get_ft
 
         with cls._lock:
-            return MappingProxyType(_get())
+            return MappingProxyType(_get_ft())
 
     @classmethod
     def iter_meta(cls) -> Iterator[FileTypeMeta]:
@@ -119,10 +119,10 @@ class FileTypeRegistry:
         Yields:
             FileTypeMeta: Serializable metadata about each file type.
         """
-        from topmark.filetypes.instances import get_file_type_registry as _get
+        from topmark.filetypes.instances import get_file_type_registry as _get_ft
 
         with cls._lock:
-            for name, ft in _get().items():
+            for name, ft in _get_ft().items():
                 yield FileTypeMeta(
                     name=name,
                     description=getattr(ft, "description", "") or "",
@@ -191,8 +191,8 @@ class FileTypeRegistry:
             - Thread safe via RLock; process-global state; do not mutate in long-lived
               multi-tenant processes.
         """
-        from topmark.filetypes.instances import get_file_type_registry as _get
+        from topmark.filetypes.instances import get_file_type_registry as _get_ft
 
         with cls._lock:
-            reg: MutableMapping[str, FileType] = _get()
+            reg: MutableMapping[str, FileType] = _get_ft()
             return reg.pop(name, None) is not None

{topmark-0.6.0 → topmark-0.6.2}/src/topmark/registry/registry.py

@@ -15,11 +15,11 @@ This module exposes structured, read-only oriented registries plus optional
 mutation hooks. It is part of the public API and provides stable, serializable
 metadata views without exposing internal implementation details.
 
-The [`Registry`][topmark.registry.Registry] facade is the **stable public surface**
+The [`topmark.registry.Registry`][] facade is the **stable public surface**
 for read-only operations; the concrete registries remain available for advanced scenarios
 and tests but are not part of the semver stability promise.
 
-A FileType can be recognized (present in [`FileTypeRegistry`][topmark.registry.FileTypeRegistry])
+A FileType can be recognized (present in [`topmark.registry.FileTypeRegistry`][])
 but unsupported (no processor registered).
 
 Typical usage:
@@ -43,8 +43,8 @@ Typical usage:
 
 Warning:
     Mutations operate on global registries shared across the process. Use them
-    sparingly in production; in tests, wrap them in try/finally or a dedicated
-    context manager to ensure cleanup.
+    sparingly in production; in tests, wrap them in ``try``/``finally``
+    or a dedicated context manager to ensure cleanup.
 """
 
 from __future__ import annotations
@@ -81,7 +81,7 @@ def iter_bindings() -> Iterator[Binding]:
         Binding: A pair containing file type metadata and the optionally
         bound processor metadata (``None`` for unsupported types).
     """
-    proc = {m.name: m for m in HeaderProcessorRegistry.iter_meta()}
+    proc: dict[str, ProcessorMeta] = {m.name: m for m in HeaderProcessorRegistry.iter_meta()}
     for ft in FileTypeRegistry.iter_meta():
         yield Binding(filetype=ft, processor=proc.get(ft.name))
 

{topmark-0.6.0 → topmark-0.6.2/src/topmark.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: topmark
-Version: 0.6.0
+Version: 0.6.2
 Summary: A Python CLI to inspect, validate, and manage license and copyright headers.
 Author-email: Olivier Biot <olivier.biot@gmail.com>
 License-Expression: MIT
@@ -43,7 +43,7 @@ Requires-Dist: pymdown-extensions>=10.8; extra == "docs"
 Requires-Dist: mkdocs-gen-files<0.6,>=0.5; extra == "docs"
 Requires-Dist: ruff; extra == "docs"
 Provides-Extra: test
-Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest>=8.0; extra == "test"
 Requires-Dist: pytest-xdist; extra == "test"
 Provides-Extra: typing
 Requires-Dist: types-toml; extra == "typing"
@@ -289,7 +289,7 @@ topmark check --apply src/
 ```
 
 > For full details, options, examples, and exit codes, see the dedicated guide:
-> **[Adding & updating headers with `topmark`](docs/usage/commands/topmark.md)**
+> **[Adding & updating headers with `topmark`](docs/usage/commands/check.md)**
 
 ### Removing headers with `strip`
 

{topmark-0.6.0 → topmark-0.6.2}/src/topmark.egg-info/requires.txt

@@ -28,7 +28,7 @@ mkdocs-gen-files<0.6,>=0.5
 ruff
 
 [test]
-pytest
+pytest>=8.0
 pytest-xdist
 
 [typing]