docstring-format-checker 1.6.3__tar.gz → 1.8.0__tar.gz

{docstring_format_checker-1.6.3 → docstring_format_checker-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docstring-format-checker
-Version: 1.6.3
+Version: 1.8.0
 Summary: A CLI tool to check and validate Python docstring formatting and completeness
 Author: Chris Mahoney
 Author-email: Chris Mahoney <docstring-format-checker@data-science-extensions.com>

{docstring_format_checker-1.6.3 → docstring_format_checker-1.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "docstring-format-checker"
-version = "1.6.3"
+version = "1.8.0"
 description = "A CLI tool to check and validate Python docstring formatting and completeness"
 readme = "README.md"
 license = "MIT"
@@ -75,7 +75,7 @@ docs = [
     "pygithub==2.*",
 ]
 test = [
-    "mypy==1.*,!=1.17.*",
+    "ty==0.*",
     "parameterized==0.*",
     "pytest==8.*",
     "pytest-clarity==1.*",
@@ -154,10 +154,12 @@ disable = [
     "C0103",  # invalid-name
     "C0301",  # line-too-long
     "C0302",  # too-many-lines
+    "R0912",  # too-many-branches
     "R0913",  # too-many-arguments
     "R0914",  # too-many-locals
     "R0915",  # too-many-statements
     "R0917",  # too-many-positional-arguments
+    "R1702",  # too-many-nested-blocks
     "R1705",  # no-else-return
     "R1724",  # no-else-continue
     "W0107",  # unnecessary-pass
@@ -188,6 +190,7 @@ allow_undefined_sections = false
 require_docstrings = true
 check_private = true
 validate_param_types = true
+optional_style = "silent"  #<-- optional: "silent", "validate", or "strict"
 sections = [
     { order=1, name="summary",  type="free_text",          required=true,  admonition="note",     prefix="!!!" },
     { order=2, name="details",  type="free_text",          required=false, admonition="abstract", prefix="???+" },

{docstring_format_checker-1.6.3 → docstring_format_checker-1.8.0}/src/docstring_format_checker/cli.py

@@ -271,6 +271,7 @@ def _show_config_example_callback() -> None:
         [blue]require_docstrings = true[/blue]
         [blue]check_private = true[/blue]
         [blue]validate_param_types = true[/blue]
+        [blue]optional_style = "validate"[/blue]  [green]# "silent", "validate", or "strict"[/green]
         [blue]sections = [[/blue]
             [blue]{ order = 1, name = "summary",  type = "free_text",          required = true, admonition = "note", prefix = "!!!" },[/blue]
             [blue]{ order = 2, name = "details",  type = "free_text",          required = false, admonition = "abstract", prefix = "???+" },[/blue]
@@ -357,9 +358,6 @@ def _format_error_messages(error_message: str) -> str:
         (str):
             Formatted error message with each error prefixed with "- " and separated by ";\n"
     """
-    # Escape square brackets for Rich markup using Rich's escape function
-    error_message = escape(error_message)
-
     if "; " in error_message:
         # Split by semicolon and rejoin with proper formatting
         errors: list[str] = error_message.split("; ")

{docstring_format_checker-1.6.3 → docstring_format_checker-1.8.0}/src/docstring_format_checker/config.py

@@ -115,6 +115,7 @@ class GlobalConfig:
     require_docstrings: bool = True
     check_private: bool = False
     validate_param_types: bool = True
+    optional_style: Literal["silent", "validate", "strict"] = "validate"
 
 
 ## --------------------------------------------------------------------------- #
@@ -447,11 +448,20 @@ def _parse_global_config(tool_config: dict[str, Any]) -> GlobalConfig:
         (GlobalConfig):
             Parsed global configuration object.
     """
+    # Validate optional_style if provided
+    optional_style: str = tool_config.get("optional_style", "validate")
+    valid_styles: tuple[str, str, str] = ("silent", "validate", "strict")
+    if optional_style not in valid_styles:
+        raise InvalidConfigError(
+            f"Invalid optional_style: '{optional_style}'. Must be one of: {', '.join(valid_styles)}"
+        )
+
     return GlobalConfig(
         allow_undefined_sections=tool_config.get("allow_undefined_sections", False),
         require_docstrings=tool_config.get("require_docstrings", True),
         check_private=tool_config.get("check_private", False),
         validate_param_types=tool_config.get("validate_param_types", True),
+        optional_style=optional_style,  # type:ignore
     )