:py:mod:`alembic_pg_autogen.diff`
=================================

.. py:module:: alembic_pg_autogen.diff

.. autodoc2-docstring:: alembic_pg_autogen.diff
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`Action <alembic_pg_autogen.diff.Action>`
     - .. autodoc2-docstring:: alembic_pg_autogen.diff.Action
          :summary:
   * - :py:obj:`FunctionOp <alembic_pg_autogen.diff.FunctionOp>`
     - .. autodoc2-docstring:: alembic_pg_autogen.diff.FunctionOp
          :summary:
   * - :py:obj:`TriggerOp <alembic_pg_autogen.diff.TriggerOp>`
     - .. autodoc2-docstring:: alembic_pg_autogen.diff.TriggerOp
          :summary:
   * - :py:obj:`DiffResult <alembic_pg_autogen.diff.DiffResult>`
     - .. autodoc2-docstring:: alembic_pg_autogen.diff.DiffResult
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`diff <alembic_pg_autogen.diff.diff>`
     - .. autodoc2-docstring:: alembic_pg_autogen.diff.diff
          :summary:
   * - :py:obj:`_diff_items <alembic_pg_autogen.diff._diff_items>`
     - .. autodoc2-docstring:: alembic_pg_autogen.diff._diff_items
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`log <alembic_pg_autogen.diff.log>`
     - .. autodoc2-docstring:: alembic_pg_autogen.diff.log
          :summary:
   * - :py:obj:`_InfoT <alembic_pg_autogen.diff._InfoT>`
     - .. autodoc2-docstring:: alembic_pg_autogen.diff._InfoT
          :summary:
   * - :py:obj:`_OpT <alembic_pg_autogen.diff._OpT>`
     - .. autodoc2-docstring:: alembic_pg_autogen.diff._OpT
          :summary:

API
~~~

.. py:data:: log
   :canonical: alembic_pg_autogen.diff.log
   :value: 'getLogger(...)'

   .. autodoc2-docstring:: alembic_pg_autogen.diff.log

.. py:class:: Action(*args, **kwds)
   :canonical: alembic_pg_autogen.diff.Action

   Bases: :py:obj:`enum.Enum`

   .. autodoc2-docstring:: alembic_pg_autogen.diff.Action

   .. rubric:: Initialization

   .. autodoc2-docstring:: alembic_pg_autogen.diff.Action.__init__

   .. py:attribute:: CREATE
      :canonical: alembic_pg_autogen.diff.Action.CREATE
      :value: 'create'

      .. autodoc2-docstring:: alembic_pg_autogen.diff.Action.CREATE

   .. py:attribute:: REPLACE
      :canonical: alembic_pg_autogen.diff.Action.REPLACE
      :value: 'replace'

      .. autodoc2-docstring:: alembic_pg_autogen.diff.Action.REPLACE

   .. py:attribute:: DROP
      :canonical: alembic_pg_autogen.diff.Action.DROP
      :value: 'drop'

      .. autodoc2-docstring:: alembic_pg_autogen.diff.Action.DROP

.. py:class:: FunctionOp
   :canonical: alembic_pg_autogen.diff.FunctionOp

   Bases: :py:obj:`typing.NamedTuple`

   .. autodoc2-docstring:: alembic_pg_autogen.diff.FunctionOp

   .. py:attribute:: action
      :canonical: alembic_pg_autogen.diff.FunctionOp.action
      :type: alembic_pg_autogen.diff.Action
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.diff.FunctionOp.action

   .. py:attribute:: current
      :canonical: alembic_pg_autogen.diff.FunctionOp.current
      :type: alembic_pg_autogen.inspect.FunctionInfo | None
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.diff.FunctionOp.current

   .. py:attribute:: desired
      :canonical: alembic_pg_autogen.diff.FunctionOp.desired
      :type: alembic_pg_autogen.inspect.FunctionInfo | None
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.diff.FunctionOp.desired

.. py:class:: TriggerOp
   :canonical: alembic_pg_autogen.diff.TriggerOp

   Bases: :py:obj:`typing.NamedTuple`

   .. autodoc2-docstring:: alembic_pg_autogen.diff.TriggerOp

   .. py:attribute:: action
      :canonical: alembic_pg_autogen.diff.TriggerOp.action
      :type: alembic_pg_autogen.diff.Action
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.diff.TriggerOp.action

   .. py:attribute:: current
      :canonical: alembic_pg_autogen.diff.TriggerOp.current
      :type: alembic_pg_autogen.inspect.TriggerInfo | None
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.diff.TriggerOp.current

   .. py:attribute:: desired
      :canonical: alembic_pg_autogen.diff.TriggerOp.desired
      :type: alembic_pg_autogen.inspect.TriggerInfo | None
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.diff.TriggerOp.desired

.. py:class:: DiffResult
   :canonical: alembic_pg_autogen.diff.DiffResult

   Bases: :py:obj:`typing.NamedTuple`

   .. autodoc2-docstring:: alembic_pg_autogen.diff.DiffResult

   .. py:attribute:: function_ops
      :canonical: alembic_pg_autogen.diff.DiffResult.function_ops
      :type: collections.abc.Sequence[alembic_pg_autogen.diff.FunctionOp]
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.diff.DiffResult.function_ops

   .. py:attribute:: trigger_ops
      :canonical: alembic_pg_autogen.diff.DiffResult.trigger_ops
      :type: collections.abc.Sequence[alembic_pg_autogen.diff.TriggerOp]
      :value: None

      .. autodoc2-docstring:: alembic_pg_autogen.diff.DiffResult.trigger_ops

.. py:data:: _InfoT
   :canonical: alembic_pg_autogen.diff._InfoT
   :value: 'TypeVar(...)'

   .. autodoc2-docstring:: alembic_pg_autogen.diff._InfoT

.. py:data:: _OpT
   :canonical: alembic_pg_autogen.diff._OpT
   :value: 'TypeVar(...)'

   .. autodoc2-docstring:: alembic_pg_autogen.diff._OpT

.. py:function:: diff(current: alembic_pg_autogen.canonicalize.CanonicalState, desired: alembic_pg_autogen.canonicalize.CanonicalState) -> alembic_pg_autogen.diff.DiffResult
   :canonical: alembic_pg_autogen.diff.diff

   .. autodoc2-docstring:: alembic_pg_autogen.diff.diff

.. py:function:: _diff_items(current_items: collections.abc.Sequence[alembic_pg_autogen.diff._InfoT], desired_items: collections.abc.Sequence[alembic_pg_autogen.diff._InfoT], make_op: collections.abc.Callable[[alembic_pg_autogen.diff.Action, alembic_pg_autogen.diff._InfoT | None, alembic_pg_autogen.diff._InfoT | None], alembic_pg_autogen.diff._OpT]) -> list[alembic_pg_autogen.diff._OpT]
   :canonical: alembic_pg_autogen.diff._diff_items

   .. autodoc2-docstring:: alembic_pg_autogen.diff._diff_items