- 新增图像生成接口,支持试用、积分和自定义API Key模式 - 实现生成图片结果异步上传至MinIO存储,带重试机制 - 优化积分预扣除和异常退还逻辑,保障用户积分准确 - 添加获取生成历史记录接口,支持时间范围和分页 - 提供本地字典配置接口,支持模型、比例、提示模板和尺寸 - 实现图片批量上传接口,支持S3兼容对象存储 feat(admin): 增加管理员角色管理与权限分配接口 - 实现角色列表查询、角色创建、更新及删除功能 - 增加权限列表查询接口 - 实现用户角色分配接口,便于统一管理用户权限 - 增加系统字典增删查改接口,支持分类过滤和排序 - 权限控制全面覆盖管理接口,保证安全访问 feat(auth): 完善用户登录注册及权限相关接口与页面 - 实现手机号验证码发送及校验功能,保障注册安全 - 支持手机号注册、登录及退出接口,集成日志记录 - 增加修改密码功能,验证原密码后更新 - 提供动态导航菜单接口,基于权限展示不同菜单 - 实现管理界面路由及日志、角色、字典管理页面访问权限控制 - 添加系统日志查询接口,支持关键词和等级筛选 feat(app): 初始化Flask应用并配置蓝图与数据库 - 创建应用程序工厂,加载配置,初始化数据库和Redis客户端 - 注册认证、API及管理员蓝图,整合路由 - 根路由渲染主页模板 - 应用上下文中自动创建数据库表,保证运行环境准备完毕 feat(database): 提供数据库创建与迁移支持脚本 - 新增数据库创建脚本,支持自动检测是否已存在 - 添加数据库表初始化脚本,支持创建和删除所有表 - 实现RBAC权限初始化,包含基础权限和角色创建 - 新增字段手动修复脚本,添加用户API Key和积分字段 - 强制迁移脚本支持清理连接和修复表结构,初始化默认数据及角色分配 feat(config): 新增系统配置参数 - 配置数据库、Redis、Session和MinIO相关参数 - 添加AI接口地址及试用Key配置 - 集成阿里云短信服务配置及开发模式相关参数 feat(extensions): 初始化数据库、Redis和MinIO客户端 - 创建全局SQLAlchemy数据库实例和Redis客户端 - 配置基于boto3的MinIO兼容S3客户端 chore(logs): 添加示例系统日志文件 - 记录用户请求、验证码发送成功与失败的日志信息
319 lines
10 KiB
Plaintext
319 lines
10 KiB
Plaintext
Metadata-Version: 2.3
|
|
Name: aiofiles
|
|
Version: 24.1.0
|
|
Summary: File support for asyncio.
|
|
Project-URL: Changelog, https://github.com/Tinche/aiofiles#history
|
|
Project-URL: Bug Tracker, https://github.com/Tinche/aiofiles/issues
|
|
Project-URL: repository, https://github.com/Tinche/aiofiles
|
|
Author-email: Tin Tvrtkovic <tinchester@gmail.com>
|
|
License: Apache-2.0
|
|
License-File: LICENSE
|
|
License-File: NOTICE
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: Framework :: AsyncIO
|
|
Classifier: License :: OSI Approved :: Apache Software License
|
|
Classifier: Operating System :: OS Independent
|
|
Classifier: Programming Language :: Python :: 3.8
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Classifier: Programming Language :: Python :: 3.11
|
|
Classifier: Programming Language :: Python :: 3.12
|
|
Classifier: Programming Language :: Python :: 3.13
|
|
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
|
Requires-Python: >=3.8
|
|
Description-Content-Type: text/markdown
|
|
|
|
# aiofiles: file support for asyncio
|
|
|
|
[](https://pypi.python.org/pypi/aiofiles)
|
|
[](https://github.com/Tinche/aiofiles/actions)
|
|
[](https://github.com/Tinche/aiofiles/actions/workflows/main.yml)
|
|
[](https://github.com/Tinche/aiofiles)
|
|
[](https://github.com/psf/black)
|
|
|
|
**aiofiles** is an Apache2 licensed library, written in Python, for handling local
|
|
disk files in asyncio applications.
|
|
|
|
Ordinary local file IO is blocking, and cannot easily and portably be made
|
|
asynchronous. This means doing file IO may interfere with asyncio applications,
|
|
which shouldn't block the executing thread. aiofiles helps with this by
|
|
introducing asynchronous versions of files that support delegating operations to
|
|
a separate thread pool.
|
|
|
|
```python
|
|
async with aiofiles.open('filename', mode='r') as f:
|
|
contents = await f.read()
|
|
print(contents)
|
|
'My file contents'
|
|
```
|
|
|
|
Asynchronous iteration is also supported.
|
|
|
|
```python
|
|
async with aiofiles.open('filename') as f:
|
|
async for line in f:
|
|
...
|
|
```
|
|
|
|
Asynchronous interface to tempfile module.
|
|
|
|
```python
|
|
async with aiofiles.tempfile.TemporaryFile('wb') as f:
|
|
await f.write(b'Hello, World!')
|
|
```
|
|
|
|
## Features
|
|
|
|
- a file API very similar to Python's standard, blocking API
|
|
- support for buffered and unbuffered binary files, and buffered text files
|
|
- support for `async`/`await` ([PEP 492](https://peps.python.org/pep-0492/)) constructs
|
|
- async interface to tempfile module
|
|
|
|
## Installation
|
|
|
|
To install aiofiles, simply:
|
|
|
|
```bash
|
|
$ pip install aiofiles
|
|
```
|
|
|
|
## Usage
|
|
|
|
Files are opened using the `aiofiles.open()` coroutine, which in addition to
|
|
mirroring the builtin `open` accepts optional `loop` and `executor`
|
|
arguments. If `loop` is absent, the default loop will be used, as per the
|
|
set asyncio policy. If `executor` is not specified, the default event loop
|
|
executor will be used.
|
|
|
|
In case of success, an asynchronous file object is returned with an
|
|
API identical to an ordinary file, except the following methods are coroutines
|
|
and delegate to an executor:
|
|
|
|
- `close`
|
|
- `flush`
|
|
- `isatty`
|
|
- `read`
|
|
- `readall`
|
|
- `read1`
|
|
- `readinto`
|
|
- `readline`
|
|
- `readlines`
|
|
- `seek`
|
|
- `seekable`
|
|
- `tell`
|
|
- `truncate`
|
|
- `writable`
|
|
- `write`
|
|
- `writelines`
|
|
|
|
In case of failure, one of the usual exceptions will be raised.
|
|
|
|
`aiofiles.stdin`, `aiofiles.stdout`, `aiofiles.stderr`,
|
|
`aiofiles.stdin_bytes`, `aiofiles.stdout_bytes`, and
|
|
`aiofiles.stderr_bytes` provide async access to `sys.stdin`,
|
|
`sys.stdout`, `sys.stderr`, and their corresponding `.buffer` properties.
|
|
|
|
The `aiofiles.os` module contains executor-enabled coroutine versions of
|
|
several useful `os` functions that deal with files:
|
|
|
|
- `stat`
|
|
- `statvfs`
|
|
- `sendfile`
|
|
- `rename`
|
|
- `renames`
|
|
- `replace`
|
|
- `remove`
|
|
- `unlink`
|
|
- `mkdir`
|
|
- `makedirs`
|
|
- `rmdir`
|
|
- `removedirs`
|
|
- `link`
|
|
- `symlink`
|
|
- `readlink`
|
|
- `listdir`
|
|
- `scandir`
|
|
- `access`
|
|
- `getcwd`
|
|
- `path.abspath`
|
|
- `path.exists`
|
|
- `path.isfile`
|
|
- `path.isdir`
|
|
- `path.islink`
|
|
- `path.ismount`
|
|
- `path.getsize`
|
|
- `path.getatime`
|
|
- `path.getctime`
|
|
- `path.samefile`
|
|
- `path.sameopenfile`
|
|
|
|
### Tempfile
|
|
|
|
**aiofiles.tempfile** implements the following interfaces:
|
|
|
|
- TemporaryFile
|
|
- NamedTemporaryFile
|
|
- SpooledTemporaryFile
|
|
- TemporaryDirectory
|
|
|
|
Results return wrapped with a context manager allowing use with async with and async for.
|
|
|
|
```python
|
|
async with aiofiles.tempfile.NamedTemporaryFile('wb+') as f:
|
|
await f.write(b'Line1\n Line2')
|
|
await f.seek(0)
|
|
async for line in f:
|
|
print(line)
|
|
|
|
async with aiofiles.tempfile.TemporaryDirectory() as d:
|
|
filename = os.path.join(d, "file.ext")
|
|
```
|
|
|
|
### Writing tests for aiofiles
|
|
|
|
Real file IO can be mocked by patching `aiofiles.threadpool.sync_open`
|
|
as desired. The return type also needs to be registered with the
|
|
`aiofiles.threadpool.wrap` dispatcher:
|
|
|
|
```python
|
|
aiofiles.threadpool.wrap.register(mock.MagicMock)(
|
|
lambda *args, **kwargs: aiofiles.threadpool.AsyncBufferedIOBase(*args, **kwargs)
|
|
)
|
|
|
|
async def test_stuff():
|
|
write_data = 'data'
|
|
read_file_chunks = [
|
|
b'file chunks 1',
|
|
b'file chunks 2',
|
|
b'file chunks 3',
|
|
b'',
|
|
]
|
|
file_chunks_iter = iter(read_file_chunks)
|
|
|
|
mock_file_stream = mock.MagicMock(
|
|
read=lambda *args, **kwargs: next(file_chunks_iter)
|
|
)
|
|
|
|
with mock.patch('aiofiles.threadpool.sync_open', return_value=mock_file_stream) as mock_open:
|
|
async with aiofiles.open('filename', 'w') as f:
|
|
await f.write(write_data)
|
|
assert f.read() == b'file chunks 1'
|
|
|
|
mock_file_stream.write.assert_called_once_with(write_data)
|
|
```
|
|
|
|
### History
|
|
|
|
#### 24.1.0 (2024-06-24)
|
|
|
|
- Import `os.link` conditionally to fix importing on android.
|
|
[#175](https://github.com/Tinche/aiofiles/issues/175)
|
|
- Remove spurious items from `aiofiles.os.__all__` when running on Windows.
|
|
- Switch to more modern async idioms: Remove types.coroutine and make AiofilesContextManager an awaitable instead a coroutine.
|
|
- Add `aiofiles.os.path.abspath` and `aiofiles.os.getcwd`.
|
|
[#174](https://github.com/Tinche/aiofiles/issues/181)
|
|
- _aiofiles_ is now tested on Python 3.13 too.
|
|
[#184](https://github.com/Tinche/aiofiles/pull/184)
|
|
- Dropped Python 3.7 support. If you require it, use version 23.2.1.
|
|
|
|
#### 23.2.1 (2023-08-09)
|
|
|
|
- Import `os.statvfs` conditionally to fix importing on non-UNIX systems.
|
|
[#171](https://github.com/Tinche/aiofiles/issues/171) [#172](https://github.com/Tinche/aiofiles/pull/172)
|
|
- aiofiles is now also tested on Windows.
|
|
|
|
#### 23.2.0 (2023-08-09)
|
|
|
|
- aiofiles is now tested on Python 3.12 too.
|
|
[#166](https://github.com/Tinche/aiofiles/issues/166) [#168](https://github.com/Tinche/aiofiles/pull/168)
|
|
- On Python 3.12, `aiofiles.tempfile.NamedTemporaryFile` now accepts a `delete_on_close` argument, just like the stdlib version.
|
|
- On Python 3.12, `aiofiles.tempfile.NamedTemporaryFile` no longer exposes a `delete` attribute, just like the stdlib version.
|
|
- Added `aiofiles.os.statvfs` and `aiofiles.os.path.ismount`.
|
|
[#162](https://github.com/Tinche/aiofiles/pull/162)
|
|
- Use [PDM](https://pdm.fming.dev/latest/) instead of Poetry.
|
|
[#169](https://github.com/Tinche/aiofiles/pull/169)
|
|
|
|
#### 23.1.0 (2023-02-09)
|
|
|
|
- Added `aiofiles.os.access`.
|
|
[#146](https://github.com/Tinche/aiofiles/pull/146)
|
|
- Removed `aiofiles.tempfile.temptypes.AsyncSpooledTemporaryFile.softspace`.
|
|
[#151](https://github.com/Tinche/aiofiles/pull/151)
|
|
- Added `aiofiles.stdin`, `aiofiles.stdin_bytes`, and other stdio streams.
|
|
[#154](https://github.com/Tinche/aiofiles/pull/154)
|
|
- Transition to `asyncio.get_running_loop` (vs `asyncio.get_event_loop`) internally.
|
|
|
|
#### 22.1.0 (2022-09-04)
|
|
|
|
- Added `aiofiles.os.path.islink`.
|
|
[#126](https://github.com/Tinche/aiofiles/pull/126)
|
|
- Added `aiofiles.os.readlink`.
|
|
[#125](https://github.com/Tinche/aiofiles/pull/125)
|
|
- Added `aiofiles.os.symlink`.
|
|
[#124](https://github.com/Tinche/aiofiles/pull/124)
|
|
- Added `aiofiles.os.unlink`.
|
|
[#123](https://github.com/Tinche/aiofiles/pull/123)
|
|
- Added `aiofiles.os.link`.
|
|
[#121](https://github.com/Tinche/aiofiles/pull/121)
|
|
- Added `aiofiles.os.renames`.
|
|
[#120](https://github.com/Tinche/aiofiles/pull/120)
|
|
- Added `aiofiles.os.{listdir, scandir}`.
|
|
[#143](https://github.com/Tinche/aiofiles/pull/143)
|
|
- Switched to CalVer.
|
|
- Dropped Python 3.6 support. If you require it, use version 0.8.0.
|
|
- aiofiles is now tested on Python 3.11.
|
|
|
|
#### 0.8.0 (2021-11-27)
|
|
|
|
- aiofiles is now tested on Python 3.10.
|
|
- Added `aiofiles.os.replace`.
|
|
[#107](https://github.com/Tinche/aiofiles/pull/107)
|
|
- Added `aiofiles.os.{makedirs, removedirs}`.
|
|
- Added `aiofiles.os.path.{exists, isfile, isdir, getsize, getatime, getctime, samefile, sameopenfile}`.
|
|
[#63](https://github.com/Tinche/aiofiles/pull/63)
|
|
- Added `suffix`, `prefix`, `dir` args to `aiofiles.tempfile.TemporaryDirectory`.
|
|
[#116](https://github.com/Tinche/aiofiles/pull/116)
|
|
|
|
#### 0.7.0 (2021-05-17)
|
|
|
|
- Added the `aiofiles.tempfile` module for async temporary files.
|
|
[#56](https://github.com/Tinche/aiofiles/pull/56)
|
|
- Switched to Poetry and GitHub actions.
|
|
- Dropped 3.5 support.
|
|
|
|
#### 0.6.0 (2020-10-27)
|
|
|
|
- `aiofiles` is now tested on ppc64le.
|
|
- Added `name` and `mode` properties to async file objects.
|
|
[#82](https://github.com/Tinche/aiofiles/pull/82)
|
|
- Fixed a DeprecationWarning internally.
|
|
[#75](https://github.com/Tinche/aiofiles/pull/75)
|
|
- Python 3.9 support and tests.
|
|
|
|
#### 0.5.0 (2020-04-12)
|
|
|
|
- Python 3.8 support. Code base modernization (using `async/await` instead of `asyncio.coroutine`/`yield from`).
|
|
- Added `aiofiles.os.remove`, `aiofiles.os.rename`, `aiofiles.os.mkdir`, `aiofiles.os.rmdir`.
|
|
[#62](https://github.com/Tinche/aiofiles/pull/62)
|
|
|
|
#### 0.4.0 (2018-08-11)
|
|
|
|
- Python 3.7 support.
|
|
- Removed Python 3.3/3.4 support. If you use these versions, stick to aiofiles 0.3.x.
|
|
|
|
#### 0.3.2 (2017-09-23)
|
|
|
|
- The LICENSE is now included in the sdist.
|
|
[#31](https://github.com/Tinche/aiofiles/pull/31)
|
|
|
|
#### 0.3.1 (2017-03-10)
|
|
|
|
- Introduced a changelog.
|
|
- `aiofiles.os.sendfile` will now work if the standard `os` module contains a `sendfile` function.
|
|
|
|
### Contributing
|
|
|
|
Contributions are very welcome. Tests can be run with `tox`, please ensure
|
|
the coverage at least stays the same before you submit a pull request.
|