Welcome to QuLab’s documentation!

Installation

We encourage installing QuLab via the pip tool (a python package manager):

$ python -m pip install QuLab

To install from the latest source, you need to clone the GitHub repository on your machine:

$ git clone https://github.com/feihoo87/QuLab.git

Then dependencies and QuLab can be installed in this way:

$ cd QuLab
$ python -m pip install -r requirements.txt
$ python -m pip install -e .

Usage

Running Tests

To run tests:

$ python -m pip install -r requirements-dev.txt
$ python -m pytest

Reporting Issues

Please report all issues on github.

License

MIT

QuLab API

The best place to start is the examples folder before diving into the API.

qulab package

The best place to start is the examples folder before diving into the API.

qulab.dht package

This package is developed base on [kademlia](https://github.com/bmuller/kademlia)

Kademlia is a Python implementation of the Kademlia protocol which utilizes the asyncio library.

qulab.math package

qulab.storage module

class qulab.storage.memstorage.ForgetfulStorage(ttl=604800)

Bases: qulab.storage.memstorage.IStorage

cull()

get(key, default=None)

Get given key. If not found, return default.

iter_older_than(seconds_old)

Return the an iterator over (key, value) tuples for items older than the given secondsOld.

class qulab.storage.memstorage.IStorage

Bases: abc.ABC

Local storage for this node. IStorage implementations of get must return the same type as put in by set

get(key, default=None)

Get given key. If not found, return default.

iter_older_than(seconds_old)

Return the an iterator over (key, value) tuples for items older than the given secondsOld.

qulab.exceptions module

exception qulab.exceptions.QuLabDHTMalformedMessage

Bases: qulab.exceptions.QuLabException

Message does not contain what is expected.

exception qulab.exceptions.QuLabException

Bases: Exception

Base exception.

exception qulab.exceptions.QuLabRPCError

Bases: qulab.exceptions.QuLabException

RPC base exception.

exception qulab.exceptions.QuLabRPCServerError

Bases: qulab.exceptions.QuLabRPCError

Server side error.

classmethod make(exce)

exception qulab.exceptions.QuLabRPCTimeout

Bases: qulab.exceptions.QuLabRPCError

Timeout.

qulab.log module

class qulab.log.BaseHandler

Bases: logging.Handler

emit(record)

Emit a log message.

send_bytes(bmsg)

serialize(record)

Serialize the record in binary format, and returns it ready for transmission across the socket.

class qulab.log.RedisHandler(conn, channel='log')

Bases: qulab.log.BaseHandler

Publish log by redis

send_bytes(bmsg)

class qulab.log.ZMQHandler(socket: zmq.sugar.socket.Socket)

Bases: qulab.log.BaseHandler

Publish log by zmq socket

send_bytes(bmsg)

qulab.log.level()

Get default log level

qulab.rpc module

class qulab.rpc.RPCClientMixin

Bases: qulab.rpc.RPCMixin

on_response(source, data)

Client side.

remoteCall(addr, methodNane, args=(), kw=None)

set_timeout(timeout=1)

class qulab.rpc.RPCMixin

Bases: abc.ABC

cancelPending(addr, msgID, cancelRemote)

Give up when request timeout and try to cancel remote task.

cancelRemoteTask(addr, msgID)

Try to cancel remote task.

cancelTask(msgID)

Cancel the task for msgID.

close()

createPending(addr, msgID, timeout=1, cancelRemote=True)

Create a future for request, wait response before timeout.

createTask(msgID, coro, timeout=0)

Create a new task for msgID.

handle(source, data)

Handle received data.

Should be called whenever received data from outside.

is_admin(source, data)

loop

Event loop.

on_cancel(source, data)

on_ping(source, data)

on_pong(source, data)

on_request(source, data)

Handle request.

Overwrite this method on server.

on_response(source, data)

Handle response.

Overwrite this method on client.

on_shutdown(source, data)

pending

ping(addr, timeout=1)

pong(addr)

request(address, msgID, msg)

response(address, msgID, msg)

sendto(data, address)

Send message to address.

shutdown(address)

start()

stop()

tasks

class qulab.rpc.RPCServerMixin

Bases: qulab.rpc.RPCMixin

executor

getRequestHandler(methodNane, source, msgID)

Get suitable handler for request.

You should implement this method yourself.

handle_request(source, msgID, method, *args, **kw)

Handle a request from source.

on_request(source, data)

Received a request from source.

class qulab.rpc.ZMQClient(addr, timeout=1, loop=None)

Bases: qulab.rpc.RPCClientMixin

loop

Event loop.

performMethod(methodNane, args, kw)

ping(timeout=1)

run()

sendto(data, addr)

Send message to address.

class qulab.rpc.ZMQRPCCallable(methodNane, owner)

Bases: object

class qulab.rpc.ZMQServer(loop=None)

Bases: qulab.rpc.RPCServerMixin

executor

getRequestHandler(methodNane, **kw)

Get suitable handler for request.

You should implement this method yourself.

loop

Event loop.

port

run()

sendto(data, address)

Send message to address.

set_module(mod)

set_socket(sock)

start()

stop()

qulab.serialize module

qulab.serialize.encode_excepion(e: Exception) → bytes

qulab.serialize.pack(obj: Any) → bytes

Serialize

qulab.serialize.packz(obj: Any) → bytes

Serialize and compress.

qulab.serialize.register(cls: type, encode: Callable[[cls], bytes] = <built-in function dumps>, decode: Callable[[bytes], cls] = <built-in function loads>) → None

Register a serializable type

Parameters

• cls – type

• encode – Callable translate an object of type cls into bytes default: pickle.dumps

• decode – Callable translate bytes to an object of type cls default: pickle.loads

qulab.serialize.unpack(buff: bytes) → Any

Unserialize

qulab.serialize.unpackz(buff: bytes) → Any

Decompress and unserialize.

qulab.utils module

qulab.utils.IEEE_488_2_BinBlock(datalist, dtype='int16', is_big_endian=True)

将一组数据打包成 IEEE 488.2 标准二进制块

Parameters

• datalist – 要打包的数字列表

• dtype – 数据类型

• endian – 字节序

Returns

binblock, header 二进制块, 以及其 ‘header’

qulab.utils.ShutdownBlocker(title='Python script')

qulab.utils.acceptArg(f, name, keyword=True)

Test if argument is acceptable by function.

Parameters

• f – callable function

• name – str argument name

qulab.utils.getHostIP

获取本机 ip 地址

qulab.utils.getHostIPv6

获取本机 ipv6 地址

qulab.utils.getHostMac

获取本机 mac 地址

qulab.utils.randomID()

Generate a random msg ID.

qulab.utils.retry(exception_to_check, tries=4, delay=0.5, backoff=2, logger=None)

Retry calling the decorated function using an exponential backoff. :param exception_to_check: the exception to check.

may be a tuple of exceptions to check

Parameters

• tries (int) – number of times to try (not retry) before giving up

• delay (float, int) – initial delay between retries in seconds

• backoff (int) – backoff multiplier e.g. value of 2 will double the delay each retry

• logger (logging.Logger) – logger to use. If None, print

Indices and tables

• Index

• Module Index

• Search Page