rapptz / asqlite Goto Github PK

View Code? Open in Web Editor NEW

112.0 6.0 16.0 25 KB

A simple async wrapper for sqlite3

License: MIT License

Python 100.00%

asqlite's Introduction

asqlite

A simple and easy to use async wrapper for sqlite3.

This is basically the same as sqlite3 except you use async with and await in front of most operations.

import asyncio
import asqlite

async def main():
    async with asqlite.connect('example.db') as conn:
        async with conn.cursor() as cursor:
            # Create table
            await cursor.execute('''CREATE TABLE stocks
                                    (date text, trans text, symbol text, qty real, price real)''')

            # Insert a row of data
            await cursor.execute("INSERT INTO stocks VALUES ('2006-01-05','BUY','RHAT',100,35.14)")

            # Save (commit) the changes
            await conn.commit()

asyncio.run(main())

Differences from `sqlite3`

This module differs from sqlite3 in a few ways:

Connections are created with journal_mode set to wal.
Connections have foreign keys enabled by default.
Implicit transactions are turned off
The row_factory is set to sqlite3.Row.

License

MIT

asqlite's People

Contributors

Stargazers

Watchers

Forkers

tylergibbs2 mathsman5133 ioistired thegamecracks cyberflamego axemalt rtk-rnjn timmypidashev seon82 achueves frostiiweeb sgtlaggy danrfq ninjaflesh fretgfr msagar

asqlite's Issues

A backup method for database connections

await db.backup(target)

Makes a backup of db to the target database.
target can be a Connection object.

Question

Does it have any differences when compared to aiosqlite?

Detecting or preventing running loop confusion

After a particular attempt at helping someone over in the discord.py server where I noticed what was essentially

# global scoped
conn = asyncio.run_until_complete(asqlite.connect(...))
client = ...

# lots of other stuff which references conn in definitions, but doesn't run yet

# other library's code creating a new event loop and running all the stuff defined above.
client.run(...)

Suffice to say, this caused an issue for the user.

Not sure what the most elegant solution here would be.

Obviously, requiring use as a context manager solves it, but that has some ergonomic changes that may be a non-starter for some people.

Could check the event loop vs the running loop, but this requires a threading lock if done from the thread side: (see the global threading lock where asyncio compares event loops across threads introduced as part of: python/cpython#86558), which would add a non-insignificant overhead.

Could also just document this as a misuse, favoring ergonomics and performance in this case.

async def main():
    async with asqlite.connect("test.sqlite3") as conn:
        async with conn.cursor() as cur:
            print((await cur.execute('SELECT * FROM stats')).fetchone())

asyncio.run(main())

# sqlite3.ProgrammingError: SQLite objects created in a thread
# can only be used in that same thread. The object was created
# in thread id 7764 and this is thread id 34968.

while this does:

async def main():
    async with asqlite.connect("test.sqlite3") as conn:
        async with conn.execute('SELECT * FROM stats') as cur:
            print(await cur.fetchone())

asyncio.run(main())

@thegamecracks suggested in the discord server:
asqlite.Cursor.execute() returns sqlite3.Cursor

typing imports don't match required python version

Current required Python in setup.py is 3.5.3+

AsyncContextManager was added in 3.5.4/3.6.2
Literal in 3.8