dbconform 0.2.2__tar.gz → 0.2.4__tar.gz

{dbconform-0.2.2/src/dbconform.egg-info → dbconform-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dbconform
-Version: 0.2.2
+Version: 0.2.4
 Summary: Synchronize database schema to models — document-driven project.
 Author: Brian L. Pond
 License: MIT

{dbconform-0.2.2 → dbconform-0.2.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "dbconform"
-version = "0.2.2"
+version = "0.2.4"
 description = "Synchronize database schema to models — document-driven project."
 readme = "README.md"
 license = { text = "MIT" }
@@ -61,7 +61,7 @@ where = ["src"]
 dbconform = "dbconform.cli:main"
 
 [tool.commitizen]
-version = "0.2.2"
+version = "0.2.4"
 version_scheme = "semver"
 commit = true
 tag = true

{dbconform-0.2.2 → dbconform-0.2.4}/src/dbconform/conform.py

@@ -498,7 +498,7 @@ class DbConform:
             )
             if isinstance(plan_or_error, ConformError):
                 return plan_or_error
-            plan = plan_or_error
+            plan: ConformPlan = plan_or_error
             if not commit_per_step and not conn.in_transaction():
                 conn.commit()
             apply_err = _apply_plan(

{dbconform-0.2.2 → dbconform-0.2.4}/src/dbconform/plan/builder.py

@@ -232,6 +232,13 @@ class ConformPlanBuilder:
                 alter_sql = self.dialect.alter_column_sql(name, old_col, new_col)
                 if alter_sql:
                     if self.dialect.would_shrink(old_col, new_col) and not self.allow_shrink_column:
+                        skipped_steps.append(
+                            SkippedStep(
+                                description=f"Alter column {new_col.name} on {name}",
+                                reason="Column shrink blocked: allow_shrink_column=False",
+                                table_name=name,
+                            )
+                        )
                         continue
                     steps.append(
                         AlterTableStep(

{dbconform-0.2.2 → dbconform-0.2.4}/src/dbconform/plan/steps.py

@@ -9,7 +9,8 @@ from __future__ import annotations
 
 from collections.abc import Iterator
 from dataclasses import dataclass, field
-from typing import Any
+from typing import Any, TextIO
+import sys
 
 from dbconform.internal.objects import (
     ColumnDef,
@@ -128,3 +129,42 @@ class ConformPlan:
     def statements(self) -> list[str]:
         """Return list of SQL statements (excludes RebuildTableStep; use apply executor)."""
         return [s.sql for s in self.steps if s.sql is not None and s.sql.strip()]
+
+    def summary(self) -> str:
+        """
+        Return a human-readable summary of the plan.
+
+        Includes counts of steps, extra_tables, and skipped_steps, plus brief details
+        for each section. See docs/requirements/01-functional.md (Plan and DDL order)
+        and 02-non-functional.md (Observability).
+        """
+        lines: list[str] = []
+        lines.append(
+            f"ConformPlan: {len(self.steps)} steps, "
+            f"{len(self.extra_tables)} extra tables, "
+            f"{len(self.skipped_steps)} skipped steps"
+        )
+        if self.steps:
+            lines.append("Steps:")
+            for step in self.steps:
+                lines.append(f"- {step.description}")
+        if self.extra_tables:
+            lines.append("Extra tables:")
+            for name in self.extra_tables:
+                lines.append(f"- {name}")
+        if self.skipped_steps:
+            lines.append("Skipped steps:")
+            for s in self.skipped_steps:
+                table = f" on {s.table_name}" if s.table_name is not None else ""
+                lines.append(f"- {s.description}{table} (reason: {s.reason})")
+        return "\n".join(lines)
+
+    def print_summary(self, file: TextIO | None = None) -> None:
+        """
+        Pretty-print the plan summary to a file-like object (stdout by default).
+
+        Convenience wrapper around summary() so callers can quickly inspect
+        planned steps, extra tables, and skipped steps.
+        """
+        target = file if file is not None else sys.stdout
+        target.write(self.summary() + "\n")

{dbconform-0.2.2 → dbconform-0.2.4/src/dbconform.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dbconform
-Version: 0.2.2
+Version: 0.2.4
 Summary: Synchronize database schema to models — document-driven project.
 Author: Brian L. Pond
 License: MIT