Pure Python asyncio connector to KDB
Project description
aiokdb
Python asyncio connector to KDB. Pure python, so does not depend on the k.h bindings or kdb shared objects, or numpy/pandas. Fully type hinted to comply with PEP-561. No non-core dependancies, and tested on Python 3.9 - 3.11.
Peer review & motivation
qPython is a widely used library for this task and it maps objects to Pandas Dataframes which might be more suitable for the majority of applications.
This library takes a different approach and aims to replicate using the KDB C-library functions, ie. being 100% explicit about KDB types. It was built working from the publically documented Serialization Examples and C API for kdb+ pages. Users might also need to be familiar with k.h.
A simple example:
from aiokdb.socket import khpu
# run ./q -p 12345 &
h = khpu("localhost", 12345, "kdb:pass")
result = h.k("2.0+3.0")
# if the remote returns a Q Exception, this gets raised, unless khpu(..., raise_krr=False)
assert result.aF() == 5.0
The result object is a K-like Python object (a KObj), having the usual signed integer type available as result.type. Accessors for the primitive types are prefixed with an a and check at runtime that the accessor is appropriate for the stored type (.aI(), .aJ(), .aH(), .aF() etc.). Atoms store their value to a bytes object irrespective of the type, and encode/decode on demand. Atomic values can be set with (.i(3), .j(12), .ss("hello")).
Arrays are implemented with subtypes that use Python's native arrays module for efficient array types. The MutableSequence arrays are returned using the usual array accessor functions .kI(), .kB(), .kS() etc.
Serialisation is handled by b9 which returns a python bytes, and d9 which takes a bytes and returns a K-object.
- Atoms are created by
ka,kb,ku,kg,kh,ki,kj,ke,kf,kc,ks,kt,kd,kz,ktj - Lists with
ktnandknk - Dictionaries with
xdand tables withxt.
Python manages garbage collection, none of the refcounting primitives exist, ie. k.r and functions r1, r0 and m9, setm are absent.
RPC
Client support using python asyncio is built into the package, and uses prompt_toolkit for line editing:
$ pip install aiokdb prompt_toolkit
$ ./q -p 12345 &
$ python -m aiokdb.cli --host localhost --port 12345
(eval) > ([s:7 6 0Nj]x:3?0Ng;y:2)
s| x y
-|---------------------------------------
7| 409031f3-b19c-6770-ee84-6e9369c98697 2
6| 52cb20d9-f12c-9963-2829-3c64d8d8cb14 2
| cddeceef-9ee9-3847-9172-3e3d7ab39b26 2
(eval) > \\
$
Tests
The unit tests in test/test_rpc.py will use a real KDB binary to test against (over RPC) if you set KDB_PYTEST_SERVICE to a URL of the form kdb://user:password@hostname:port, otherwise that test is skipped and they are self contained.
- Formatting with
ruff check . - Formatting with
ruff format . - imports
isort --check --profile black . - Check type annotations with
mypy --strict . - Run
pytest .in the root directory
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file aiokdb-0.1.1.tar.gz.
File metadata
- Download URL: aiokdb-0.1.1.tar.gz
- Upload date:
- Size: 26.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 54f673006c935346dce02fb0e75807833cc23bc4f3a0feb76cf63425a01a6698 |
|
| MD5 | 2166960b3044dc4cedd56f1e18068258 |
|
| BLAKE2b-256 | 6076c612a24ab459cc2fc52618ab693670c966425dc65121390923f17ce9ff2a |
File details
Details for the file aiokdb-0.1.1-py3-none-any.whl.
File metadata
- Download URL: aiokdb-0.1.1-py3-none-any.whl
- Upload date:
- Size: 19.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c86cdb69705b9991cde0ff4159921d8661a5e65b8effe4ab6ffdd26c1f28401c |
|
| MD5 | c1f27f08977ad26a34a4ac62b87e43ab |
|
| BLAKE2b-256 | 5ad5e4fcb49eb92c5451735d22cc9eb4285f35285319ca1d219e93f1f1b08e89 |
