Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion alembic/command.py
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,9 @@ def retrieve_migrations(rev, context):

if diffs:
raise util.AutogenerateDiffsDetected(
f"New upgrade operations detected: {diffs}"
f"New upgrade operations detected: {diffs}",
revision_context=revision_context,
diffs=diffs,
)
else:
config.print_stdout("No new upgrade operations detected.")
Expand Down
21 changes: 20 additions & 1 deletion alembic/util/exc.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,25 @@
from __future__ import annotations

from typing import Any
from typing import List
from typing import Tuple
from typing import TYPE_CHECKING

if TYPE_CHECKING:
from alembic.autogenerate import RevisionContext


class CommandError(Exception):
pass


class AutogenerateDiffsDetected(CommandError):
pass
def __init__(
self,
message: str,
revision_context: RevisionContext,
diffs: List[Tuple[Any, ...]],
) -> None:
super().__init__(message)
self.revision_context = revision_context
self.diffs = diffs
6 changes: 6 additions & 0 deletions docs/build/unreleased/issue1597.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. change::
:tags: check, autogenerate
:tickets: 1597

Add revision context to AutogenerateDiffsDetected so that command can be wrapped and diffs may be output in a different format.
Pull request courtesy of Louis-Amaury Chaib (@lachaib).