feat: Add refresh method

Author: amisadmin

sqlalchemy_database/_abc_async_database.py

@@ -22,7 +22,7 @@ async def to_thread(func: Callable[_P, _R], *args: _P.args, **kwargs: _P.kwargs)
 
 class AbcAsyncDatabase(metaclass=abc.ABCMeta):  # noqa: B024
     def __init__(self) -> None:
-        for func_name in ["execute", "scalar", "scalars_all", "get", "delete", "save", "run_sync"]:
+        for func_name in ["execute", "scalar", "scalars_all", "get", "delete", "save", "run_sync", "refresh"]:
             func = getattr(self, func_name)
             if not asyncio.iscoroutinefunction(func):
                 func = functools.partial(to_thread, func)

sqlalchemy_database/_abc_async_database.pyi

@@ -93,6 +93,9 @@ class AbcAsyncDatabase(metaclass=abc.ABCMeta):
         executor: Union[Session, Connection, AsyncSession, AsyncConnection, None] = None,
         **kwargs: _P.kwargs,
     ) -> Union[_T, _R]: ...
+    async def async_refresh(
+        self, instance, attribute_names=None, with_for_update=None, session: Optional[AsyncSession] = None
+    ): ...
     async def asgi_dispatch(self, request, call_next): ...
     def __call__(self) -> AsyncSessionContextVarManager:
         pass

sqlalchemy_database/database.py

@@ -427,6 +427,28 @@ def get_user(session:Session,id:int):
                 await executor.commit()
             return result
 
+    async def refresh(self, instance, attribute_names=None, with_for_update=None, session: Optional[AsyncSession] = None):
+        """
+        Refresh the attributes of the given instance from the database.
+        Args:
+            instance: The instance to be refreshed.
+            attribute_names: Optional list of attribute names to refresh.
+            with_for_update: optional boolean ``True`` indicating FOR UPDATE should be used,
+                or may be a dictionary containing flags to
+                indicate a more specific set of FOR UPDATE flags for the SELECT;
+                flags should match the parameters of :meth:`_query.Query.with_for_update`.
+                Supersedes the :paramref:`.Session.refresh.lockmode` parameter.
+            session: If not specified, an `AsyncSession` is created.
+        """
+        need_close = False
+        if session is None or not isinstance(session, AsyncSession):
+            session = self.session
+            if session is None:
+                need_close = True
+                session = self.session_maker()
+        async with ExecutorContextManager(session, need_close=need_close) as session:
+            await session.refresh(instance, attribute_names, with_for_update)
+
 
 class Database(AbcAsyncDatabase):
     """`sqlalchemy` synchronous database client"""
@@ -622,6 +644,16 @@ def run_sync(
                 executor.commit()
             return result
 
+    def refresh(self, instance, attribute_names=None, with_for_update=None, session: Optional[Session] = None):
+        need_close = False
+        if session is None or not isinstance(session, Session):
+            session = self.session
+            if session is None:
+                need_close = True
+                session = self.session_maker()
+        with ExecutorContextManager(session, need_close=need_close) as session:
+            session.refresh(instance, attribute_names=attribute_names, with_for_update=with_for_update)
+
 
 class ExecutorContextManager:
     """Actuator context manager, optionally closing the executor"""