chore(deps): fix the compatibility issue introduced by SQLAlchemy 2.0.38 (#989)

Signed-off-by: behnazh-w <[email protected]>

Author: behnazh-w

src/macaron/database/views.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2023 - 2023, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2023 - 2025, Oracle and/or its affiliates. All rights reserved.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
 
 # pylint: skip-file
@@ -16,7 +16,7 @@
 from sqlalchemy import Connection
 from sqlalchemy.ext import compiler
 from sqlalchemy.schema import BaseDDLElement, DDLElement, MetaData, SchemaItem, Table
-from sqlalchemy.sql import Select, TableClause, table
+from sqlalchemy.sql import Select
 
 
 class CreateView(DDLElement):
@@ -52,7 +52,32 @@ def view_exists(
     state: Any | None = None,
     **kw: Any,
 ) -> bool:
-    """View exists."""
+    """Check if a view exists in the database.
+
+    This function checks whether a view, defined by the `CreateView` or `DropView`
+    object, already exists in the database. It relies on the provided `bind` connection
+    to inspect the existing views in the database.
+
+    Parameters
+    ----------
+    ddl : BaseDDLElement
+        The DDL element that represents the creation or dropping of a view.
+    target : SchemaItem
+        The target schema item (not directly used in this check).
+    bind : Connection | None
+        The database connection used to inspect the database for existing views.
+    tables : list[Table] | None, optional
+        A list of tables (not directly used in this check).
+    state : Any | None, optional
+        The state of the object (not directly used in this check).
+    kw : Any
+        Additional keyword arguments passed to the function (not directly used).
+
+    Returns
+    -------
+    bool
+        Returns `True` if the view exists in the database, `False` otherwise.
+    """
     if isinstance(ddl, CreateView) or isinstance(ddl, DropView):
         assert isinstance(bind, Connection)
         return ddl.name in sa.inspect(bind).get_view_names()
@@ -67,19 +92,60 @@ def view_doesnt_exist(
     state: Any | None = None,
     **kw: Any,
 ) -> bool:
-    """Not view exists."""
+    """Check if a view does not exist in the database.
+
+    This function is the inverse of `view_exists`. It returns `True` if the view
+    defined by the `CreateView` or `DropView` object does not exist in the database.
+
+    Parameters
+    ----------
+    ddl : BaseDDLElement
+        The DDL element that represents the creation or dropping of a view.
+    target : SchemaItem
+        The target schema item (not directly used in this check).
+    bind : Connection | None
+        The database connection used to inspect the database for existing views.
+    tables : list[Table] | None, optional
+        A list of tables (not directly used in this check).
+    state : Any | None, optional
+        The state of the object (not directly used in this check).
+    kw : Any
+        Additional keyword arguments passed to the function (not directly used).
+
+    Returns
+    -------
+    bool
+        Returns `True` if the view does not exist in the database, `False` otherwise.
+    """
     return not view_exists(ddl, target, bind, **kw)
 
 
-def create_view(name: str, metadata: MetaData, selectable: Select[Any]) -> TableClause:
-    """Create a view."""
-    view = table(name)
-    view._columns._populate_separate_keys(col._make_proxy(view) for col in selectable.selected_columns)
+def create_view(name: str, metadata: MetaData, selectable: Select[Any]) -> None:
+    """Create and manage a view for an existing table, including its lifecycle.
 
+    This function allows you to define a SQL view based on an existing table, as well as
+    handle operations like creation and deletion.
+
+    For an example implementation, see this Wiki page:
+    https://github.com/sqlalchemy/sqlalchemy/wiki/Views
+
+
+    Parameters
+    ----------
+    name : str
+        The name of the view to be created.
+    metadata : MetaData
+        The MetaData object that contains the schema and is used to listen for
+        the `after_create` and `before_drop` events.
+    selectable : Select[Any]
+        A table that defines the content of the view.
+    """
+    # Create the view after all tables are created:.
     sqlalchemy.event.listen(
         metadata,
         "after_create",
         CreateView(name, selectable).execute_if(callable_=view_doesnt_exist),
     )
+
+    # Ensure the view is dropped before any tables in the database are dropped.
     sqlalchemy.event.listen(metadata, "before_drop", DropView(name).execute_if(callable_=view_exists))
-    return view