https://github.com/synodriver/aioaria2
An async/await wrapper around aria2-json-rpc with websocket support
https://github.com/synodriver/aioaria2
aria2 async asyncio python
Last synced: 11 months ago
JSON representation
An async/await wrapper around aria2-json-rpc with websocket support
- Host: GitHub
- URL: https://github.com/synodriver/aioaria2
- Owner: synodriver
- License: gpl-3.0
- Created: 2020-05-23T17:28:44.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-01T08:27:49.000Z (over 1 year ago)
- Last Synced: 2025-06-24T02:41:35.888Z (12 months ago)
- Topics: aria2, async, asyncio, python
- Language: Python
- Homepage:
- Size: 201 KB
- Stars: 34
- Watchers: 1
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.markdown
- License: LICENSE
Awesome Lists containing this project
README
# aioaria2
[](https://pypi.org/project/aioaria2/)
## Support async rpc call with aria2 and process management
## Usage:
### example
```python
import asyncio
from pprint import pprint
import aioaria2
async def main():
async with aioaria2.Aria2HttpClient("http://117.0.0.1:6800/jsonrpc",
token="token") as client:
pprint(await client.getVersion())
asyncio.run(main())
```
### The ip address should be replaced with your own
### See [aria2 manual](http://aria2.github.io/manual/en/html/) for more detail about client methods
```python
# exampe of http
import asyncio
from pprint import pprint
import aioaria2
import ujson
async def main():
async with aioaria2.Aria2HttpClient("http://127.0.0.1:6800/jsonrpc",
token="token",
loads=ujson.loads,
dumps=ujson.dumps) as client:
pprint(await client.addUri(["http://www.demo.com"])) # that would start downloading
asyncio.run(main())
```
```python
# exampe of websocket
import asyncio
from pprint import pprint
import aioaria2
import ujson
@aioaria2.run_sync
def on_download_complete(trigger, data):
print(f"downlaod complete {data}")
async def main():
client: aioaria2.Aria2WebsocketClient = await aioaria2.Aria2WebsocketClient.new("http://127.0.0.1:6800/jsonrpc",
token="token",
loads=ujson.loads,
dumps=ujson.dumps)
client.onDownloadComplete(on_download_complete)
pprint(await client.addUri(["http://www.demo.com"]))
loop = asyncio.get_event_loop()
loop.create_task(main())
loop.run_forever()
```
- Run that coroutine function and each method represent an aria2-rpc call. As for server, each instance represent an aria2 process.
```python
import aioaria2
import asyncio
async def main():
server = aioaria2.AsyncAria2Server(r"aria2c.exe",
r"--conf-path=aria2.conf", "--rpc-secret=admin", daemon=True)
await server.start()
await server.wait()
asyncio.run(main())
```
#### this start an aria2 process
[Aria2 Manual](http://aria2.github.io/manual/en/html/)
### todolist
- [x] async http
- [x] async websocket
- [x] async process management
- [x] unitest
This module is built on top of [aria2jsonrpc](https://xyne.archlinux.ca/projects/python3-aria2jsonrpc)
with async and websocket support.
### For windows users, you should
```
# for start async aria2 process
asyncio.set_event_loop_policy(asyncio.WindowsProactorEventLoopPolicy())
asyncio.set_event_loop(asyncio.ProactorEventLoop())
```
For python version greater than 3.8, asyncio uses ProactorEventLoop by default, so there is no need to modify
#### v1.2.0
new Aria2WebsocketTrigger class for websocket events, use on* methods to add callbacks
Like
```
@trigger.onDownloadStart
async def onDownloadStart(trigger, future):
print("下载开始{0}".format(future.result()))
```
#### v1.2.3
Now you can add multiple callbacks for one event ,must be coroutine function or an async callable, use ```aioaria2.run_sync``` to wrap a sync function
```
@trigger.onDownloadStart
async def callback1(trigger, future):
print("第一个回调{0}".format(future.result()))
@trigger.onDownloadStart
@run_sync
def callback2(trigger, future):
print("第二个回调{0}".format(future.result()))
```
#### v1.3.0
* Big changes for class```Aria2WebsocketTrigger```
* Callbacks now accept```dict```as second parameter instead of```asyncio.Future```
* methods of class```Aria2WebsocketTrigger``` now have same return value as ```Aria2HttpClient```
* ```id``` parameter now accept a callable as idfactory to generate uuid, otherwise default uuid factory is used.
```
@trigger.onDownloadStart
async def callback1(trigger, data:dict):
print("第一个回调{0}".format(data))
@trigger.onDownloadStart
@run_sync
def callback2(trigger, data:dict):
print("第二个回调{0}".format(data))
```
### v1.3.1
* custom json library with keyword arguments ```loads``` ```dumps```
### v1.3.2
* fix unclosed client_session when exception occurs during ws_connect
* alias for ```Aria2WebsocketTrigger```,named ```Aria2WebsocketClient```
### v1.3.3
* fix method problems in client
### v1.3.4rc1
* handle reconnect simply
* handle InvalidstateError while trying to ping aria2
### v1.3.4
* add async id factory support
* allow unregister callbacks in websocketclient
* add contextvars support in ```run_sync```
### v1.3.5rc1
* graceful shutdown
### v1.3.5rc2
* add parser for aria2 files
```python
from pprint import pprint
from aioaria2 import DHTFile
pprint(DHTFile.from_file2("dht.dat"))
```
### v1.3.5rc3
* add strong ref to pending tasks
### v1.3.6
* update latest aiohttp version