151 lines
4.9 KiB
Plaintext
151 lines
4.9 KiB
Plaintext
Metadata-Version: 2.4
|
|
Name: aiomysql
|
|
Version: 0.3.2
|
|
Summary: MySQL driver for asyncio.
|
|
Author-email: Nikolay Novik <nickolainovik@gmail.com>
|
|
License-Expression: MIT
|
|
Project-URL: homepage, https://github.com/aio-libs/aiomysql
|
|
Project-URL: source, https://github.com/aio-libs/aiomysql
|
|
Project-URL: download, https://pypi.python.org/pypi/aiomysql
|
|
Project-URL: changelog, https://github.com/aio-libs/aiomysql/blob/main/CHANGES.txt
|
|
Project-URL: documentation, https://aiomysql.readthedocs.io/
|
|
Project-URL: issues, https://github.com/aio-libs/aiomysql/issues
|
|
Project-URL: GitHub: CI, https://github.com/aio-libs/aiomysql/actions
|
|
Project-URL: GitHub: discussions, https://github.com/aio-libs/aiomysql/discussions
|
|
Keywords: mysql,mariadb,asyncio,aiomysql
|
|
Platform: POSIX
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Programming Language :: Python :: 3
|
|
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: Operating System :: POSIX
|
|
Classifier: Environment :: Web Environment
|
|
Classifier: Development Status :: 3 - Alpha
|
|
Classifier: Topic :: Database
|
|
Classifier: Topic :: Database :: Front-Ends
|
|
Classifier: Framework :: AsyncIO
|
|
Requires-Python: >=3.9
|
|
Description-Content-Type: text/x-rst
|
|
License-File: LICENSE
|
|
Requires-Dist: PyMySQL>=1.0
|
|
Provides-Extra: sa
|
|
Requires-Dist: sqlalchemy<1.4,>=1.3; extra == "sa"
|
|
Provides-Extra: rsa
|
|
Requires-Dist: PyMySQL[rsa]>=1.0; extra == "rsa"
|
|
Dynamic: license-file
|
|
|
|
aiomysql
|
|
========
|
|
.. image:: https://github.com/aio-libs/aiomysql/actions/workflows/ci-cd.yml/badge.svg?branch=main
|
|
:target: https://github.com/aio-libs/aiomysql/actions/workflows/ci-cd.yml
|
|
.. image:: https://codecov.io/gh/aio-libs/aiomysql/branch/main/graph/badge.svg
|
|
:target: https://codecov.io/gh/aio-libs/aiomysql
|
|
:alt: Code coverage
|
|
.. image:: https://badge.fury.io/py/aiomysql.svg
|
|
:target: https://badge.fury.io/py/aiomysql
|
|
:alt: Latest Version
|
|
.. image:: https://readthedocs.org/projects/aiomysql/badge/?version=latest
|
|
:target: https://aiomysql.readthedocs.io/
|
|
:alt: Documentation Status
|
|
.. image:: https://badges.gitter.im/Join%20Chat.svg
|
|
:target: https://gitter.im/aio-libs/Lobby
|
|
:alt: Chat on Gitter
|
|
|
|
**aiomysql** is a "driver" for accessing a `MySQL` database
|
|
from the asyncio_ (PEP-3156/tulip) framework. It depends on and reuses most
|
|
parts of PyMySQL_ . *aiomysql* tries to be like awesome aiopg_ library and
|
|
preserve same api, look and feel.
|
|
|
|
Internally **aiomysql** is copy of PyMySQL, underlying io calls switched
|
|
to async, basically ``yield from`` and ``asyncio.coroutine`` added in
|
|
proper places)). `sqlalchemy` support ported from aiopg_.
|
|
|
|
|
|
Documentation
|
|
-------------
|
|
https://aiomysql.readthedocs.io/
|
|
|
|
Basic Example
|
|
-------------
|
|
|
|
**aiomysql** based on PyMySQL_ , and provides same api, you just need
|
|
to use ``await conn.f()`` or ``yield from conn.f()`` instead of calling
|
|
``conn.f()`` for every method.
|
|
|
|
Properties are unchanged, so ``conn.prop`` is correct as well as
|
|
``conn.prop = val``.
|
|
|
|
.. code:: python
|
|
|
|
import asyncio
|
|
import aiomysql
|
|
|
|
|
|
async def test_example():
|
|
async with aiomysql.create_pool(host='127.0.0.1', port=3306,
|
|
user='root', password='',
|
|
db='mysql') as pool:
|
|
async with pool.acquire() as conn:
|
|
async with conn.cursor() as cur:
|
|
await cur.execute("SELECT 42;")
|
|
print(cur.description)
|
|
(r,) = await cur.fetchone()
|
|
assert r == 42
|
|
|
|
|
|
asyncio.run(test_example())
|
|
|
|
|
|
Example of SQLAlchemy optional integration
|
|
------------------------------------------
|
|
Sqlalchemy support has been ported from aiopg_ so api should be very familiar
|
|
for aiopg_ user.:
|
|
|
|
.. code:: python
|
|
|
|
import asyncio
|
|
import sqlalchemy as sa
|
|
|
|
from aiomysql.sa import create_engine
|
|
|
|
|
|
metadata = sa.MetaData()
|
|
|
|
tbl = sa.Table('tbl', metadata,
|
|
sa.Column('id', sa.Integer, primary_key=True),
|
|
sa.Column('val', sa.String(255)))
|
|
|
|
|
|
async def go():
|
|
engine = await create_engine(user='root', db='test_pymysql',
|
|
host='127.0.0.1', password='')
|
|
async with engine.acquire() as conn:
|
|
await conn.execute(tbl.insert().values(val='abc'))
|
|
await conn.execute(tbl.insert().values(val='xyz'))
|
|
|
|
async for row in conn.execute(tbl.select()):
|
|
print(row.id, row.val)
|
|
|
|
engine.close()
|
|
await engine.wait_closed()
|
|
|
|
|
|
asyncio.run(go())
|
|
|
|
|
|
Requirements
|
|
------------
|
|
|
|
* Python_ 3.9+
|
|
* PyMySQL_
|
|
|
|
|
|
.. _Python: https://www.python.org
|
|
.. _asyncio: http://docs.python.org/3.5/library/asyncio.html
|
|
.. _aiopg: https://github.com/aio-libs/aiopg
|
|
.. _PyMySQL: https://github.com/PyMySQL/PyMySQL
|
|
.. _Tornado-MySQL: https://github.com/PyMySQL/Tornado-MySQL
|