refactor: Optimized the session object acquisition logic.

Author: amisadmin

.flake8

@@ -1,3 +1,4 @@
 [flake8]
 max-line-length = 130
-exclude = venv,.git,__pycache__,__init__.py,
+exclude = venv,.git,__pycache__,__init__.py,
+ignore = B008

README.md

@@ -66,9 +66,9 @@ from sqlmodel import SQLModel, Field
 
 class User(SQLModel, table=True):
     id: int = Field(default=None, primary_key=True, nullable=False)
-    username: str = Field(title='username', sa_column=Column(String(100), unique=True, index=True, nullable=False))
+    username: str = Field(title='username', max_length=30, unique=True, index=True, nullable=False)
     password: str = Field(default='', title='Password')
-    create_time: datetime = Field(default_factory=datetime.utcnow, title='Create Time')
+    create_time: datetime = Field(default_factory=datetime.now, title='Create Time')
 ```
 
 ## AsyncDatabase
@@ -85,55 +85,6 @@ db = AsyncDatabase.create('sqlite+aiosqlite:///amisadmin.db?check_same_thread=Fa
 
 ```
 
-### Shortcut functions
-
-```python
-from sqlalchemy import insert, select, update, delete
-
-
-async def fast_execute():
-    # update
-    stmt = update(User).where(User.id == 1).values({'username': 'new_user'})
-    result = await db.execute(stmt)
-
-    # select
-    stmt = select(User).where(User.id == 1)
-    user = await db.execute(stmt, on_close_pre=lambda r: r.scalar())
-
-    # insert
-    stmt = insert(User).values({'username': 'User-6', 'password': 'password-6'})
-    result = await db.execute(stmt)
-
-    # delete
-    stmt = delete(User).where(User.id == 6)
-    result = await db.execute(stmt)
-
-    # scalar
-    user = await db.scalar(select(User).where(User.id == 1))
-
-    # scalars_all
-    stmt = select(User)
-    result = await db.scalars_all(stmt)
-
-    # get
-    user = await db.get(User, 1)
-
-    # delete
-    user = User(id=1, name='test')
-    await db.delete(user)
-
-    # save(insert or update)
-    user = User(name='new_user')
-    await db.save(user)
-
-    # run_sync
-    await db.run_sync(Base.metadata.create_all, is_session=False)
-
-    # session_maker
-    async with db.session_maker() as session:
-        user = await session.get(User, 1)
-```
-
 ## Database
 
 ### Creation Connection
@@ -149,55 +100,6 @@ db = Database.create('sqlite:///amisadmin.db?check_same_thread=False')  # sqlite
 # db = Database.create('mssql+pyodbc://scott:tiger@mydsn') # SQL Server
 ```
 
-### Shortcut functions
-
-```python
-from sqlalchemy import insert, select, update, delete
-
-
-def fast_execute():
-    # update
-    stmt = update(User).where(User.id == 1).values({'username': 'new_user'})
-    result = db.execute(stmt)
-
-    # select
-    stmt = select(User).where(User.id == 1)
-    user = db.execute(stmt, on_close_pre=lambda r: r.scalar())
-
-    # insert
-    stmt = insert(User).values({'username': 'User-6', 'password': 'password-6'})
-    result = db.execute(stmt)
-
-    # delete
-    stmt = delete(User).where(User.id == 6)
-    result = db.execute(stmt)
-
-    # scalar
-    user = db.scalar(select(User).where(User.id == 1))
-
-    # scalars_all
-    stmt = select(User)
-    result = db.scalars_all(stmt)
-
-    # get
-    user = db.get(User, 1)
-
-    # delete
-    user = User(id=1, name='test')
-    db.delete(user)
-
-    # save(insert or update)
-    user = User(name='new_user')
-    db.save(user)
-
-    # run_sync
-    db.run_sync(Base.metadata.create_all, is_session=False)
-
-    # session_maker
-    with db.session_maker() as session:
-        user = session.get(User, 1)
-```
-
 ## AbcAsyncDatabase
 
 When you are developing a library of tools, your Python program may require a database connection.
@@ -209,7 +111,7 @@ You can use asynchronous shortcut functions with the `async_` prefix.
 `AsyncDatabase` and `Database` both inherit from `AbcAsyncDatabase` and both implement the usual `async_` prefixed asynchronous
 shortcut functions.
 
-For example: `async_execute`,`async_scalar`,`async_scalars_all`,`async_get`,`async_delete`,`async_run_sync`.
+For example: `async_execute`,`async_scalar`,`async_scalars`,`async_get`,`async_delete`,`async_run_sync`.
 
 Remark: The `async_` prefix in `Database` is implemented by executing the corresponding synchronous shortcut in the thread pool.
 
@@ -240,9 +142,9 @@ async def fast_execute(db: Union[AsyncDatabase, Database]):
     # scalar
     user = await db.async_scalar(select(User).where(User.id == 1))
 
-    # scalars_all
+    # scalars
     stmt = select(User)
-    result = await db.async_scalars_all(stmt)
+    result = await db.async_scalars(stmt)
 
     # get
     user = await db.async_get(User, 1)
@@ -251,10 +153,6 @@ async def fast_execute(db: Union[AsyncDatabase, Database]):
     user = User(id=1, name='test')
     await db.async_delete(user)
 
-    # save(insert or update)
-    user = User(name='new_user')
-    await db.async_save(user)
-
     # run_sync
     await db.async_run_sync(Base.metadata.create_all, is_session=False)
 
@@ -306,6 +204,24 @@ async def get_user(id: int):
 
 ```
 
+## Get session object
+
+You can get the session object anywhere, but you need to manage the lifecycle of the session yourself. For example:
+
+- 1.In FastAPI, you can use middleware or dependencies to get the session object. In the routing function, the method called will
+  automatically get the session object in the context.
+
+- 2.In the local work unit, you can use the `with` statement to get the session object. In the `with` statement, the method called
+  will automatically get a new session object.
+
+```mermaid
+graph LR
+session[Get session] --> scopefunc{Read context var}
+scopefunc -->|None| gSession[Return the global default session]
+scopefunc -->|Not a Session object| sSession[Return the scoped session corresponding to the current context variable]
+scopefunc -->|Is a Session object| cSession[Return session in the current context variable]
+```
+
 ## More tutorial documentation
 
 ### [sqlalchemy](https://github.com/sqlalchemy/sqlalchemy)

README.zh.md

@@ -66,9 +66,9 @@ from sqlmodel import SQLModel, Field
 
 class User(SQLModel, table=True):
     id: int = Field(default=None, primary_key=True, nullable=False)
-    username: str = Field(title='username', sa_column=Column(String(100), unique=True, index=True, nullable=False))
+    username: str = Field(title='username', max_length=30, unique=True, index=True, nullable=False)
     password: str = Field(default='', title='Password')
-    create_time: datetime = Field(default_factory=datetime.utcnow, title='Create Time')
+    create_time: datetime = Field(default_factory=datetime.now, title='Create Time')
 ```
 
 ## AsyncDatabase
@@ -85,55 +85,6 @@ db = AsyncDatabase.create('sqlite+aiosqlite:///amisadmin.db?check_same_thread=Fa
 
 ```
 
-### 快捷函数
-
-```python
-from sqlalchemy import insert, select, update, delete
-
-
-async def fast_execute():
-    # update
-    stmt = update(User).where(User.id == 1).values({'username': 'new_user'})
-    result = await db.execute(stmt)
-
-    # select
-    stmt = select(User).where(User.id == 1)
-    user = await db.execute(stmt, on_close_pre=lambda r: r.scalar())
-
-    # insert
-    stmt = insert(User).values({'username': 'User-6', 'password': 'password-6'})
-    result = await db.execute(stmt)
-
-    # delete
-    stmt = delete(User).where(User.id == 6)
-    result = await db.execute(stmt)
-
-    # scalar
-    user = await db.scalar(select(User).where(User.id == 1))
-
-    # scalars_all
-    stmt = select(User)
-    result = await db.scalars_all(stmt)
-
-    # get
-    user = await db.get(User, 1)
-
-    # delete
-    user = User(id=1, name='test')
-    await db.delete(user)
-
-    # save(insert or update)
-    user = User(name='new_user')
-    await db.save(user)
-
-    # run_sync
-    await db.run_sync(Base.metadata.create_all, is_session=False)
-
-    # session_maker
-    async with db.session_maker() as session:
-        user = await session.get(User, 1)
-```
-
 ## Database
 
 ### 创建连接
@@ -149,54 +100,7 @@ db = Database.create('sqlite:///amisadmin.db?check_same_thread=False')  # sqlite
 # db = Database.create('mssql+pyodbc://scott:tiger@mydsn') # SQL Server
 ```
 
-### 快捷函数
-
-```python
-from sqlalchemy import insert, select, update, delete
-
-
-def fast_execute():
-    # update
-    stmt = update(User).where(User.id == 1).values({'username': 'new_user'})
-    result = db.execute(stmt)
-
-    # select
-    stmt = select(User).where(User.id == 1)
-    user = db.execute(stmt, on_close_pre=lambda r: r.scalar())
-
-    # insert
-    stmt = insert(User).values({'username': 'User-6', 'password': 'password-6'})
-    result = db.execute(stmt)
-
-    # delete
-    stmt = delete(User).where(User.id == 6)
-    result = db.execute(stmt)
-
-    # scalar
-    user = db.scalar(select(User).where(User.id == 1))
-
-    # scalars_all
-    stmt = select(User)
-    result = db.scalars_all(stmt)
-
-    # get
-    user = db.get(User, 1)
-
-    # delete
-    user = User(id=1, name='test')
-    db.delete(user)
-
-    # save(insert or update)
-    user = User(name='new_user')
-    db.save(user)
-
-    # run_sync
-    db.run_sync(Base.metadata.create_all, is_session=False)
-
-    # session_maker
-    with db.session_maker() as session:
-        user = session.get(User, 1)
-```
+###  
 
 ## AbcAsyncDatabase
 
@@ -206,7 +110,7 @@ def fast_execute():
 
 `AsyncDatabase`和`Database`都继承自`AbcAsyncDatabase`,并且都实现了常用的以`async_`为前缀的异步快捷函数.
 
-例如: `async_execute`,`async_scalar`,`async_scalars_all`,`async_get`,`async_delete`,`async_run_sync`.
+例如: `async_execute`,`async_scalar`,`async_scalars`,`async_get`,`async_delete`,`async_run_sync`.
 
 说明: `Database`中`async_`前缀异步快捷函数,是通过在线程池中执行对应的同步快捷函数实现的.
 
@@ -237,9 +141,9 @@ async def fast_execute(db: Union[AsyncDatabase, Database]):
     # scalar
     user = await db.async_scalar(select(User).where(User.id == 1))
 
-    # scalars_all
+    # scalars
     stmt = select(User)
-    result = await db.async_scalars_all(stmt)
+    result = await db.async_scalars(stmt)
 
     # get
     user = await db.async_get(User, 1)
@@ -248,10 +152,6 @@ async def fast_execute(db: Union[AsyncDatabase, Database]):
     user = User(id=1, name='test')
     await db.async_delete(user)
 
-    # save(insert or update)
-    user = User(name='new_user')
-    await db.async_save(user)
-
     # run_sync
     await db.async_run_sync(Base.metadata.create_all, is_session=False)
 
@@ -303,6 +203,22 @@ async def get_user(id: int):
 
 ```
 
+## 获取session对象
+
+你可以在任何地方获取session对象,但是你需要自己管理session的生命周期.例如: 
+
+- 1.在FastAPI中,你可以使用中间件,或者依赖来获取session对象.在路由函数中,调用的方法将自动获取上下文中的session对象.
+
+- 2.在局部工作单元中,你可以使用`with`语句来获取session对象.在`with`语句中,调用的方法将自动获取一个新的session对象.
+
+```mermaid
+graph LR
+session[Get session] --> scopefunc{Read context var}
+scopefunc -->|None| gSession[Return the global default session]
+scopefunc -->|Not a Session object| sSession[Return the scoped session corresponding to the current context variable]
+scopefunc -->|Is a Session object| cSession[Return session in the current context variable]
+```
+
 ## 更多教程文档
 
 ### [sqlalchemy](https://github.com/sqlalchemy/sqlalchemy)