Skip to main content

KQML messaging classes in Python.

Project description

PyKQML

PyKQML is an implementation of KQML messaging in Python.

Installation

PyKQML can be installed as

pip install pykqml

Note that releases of PyKQML up to 0.5 work in Python 2 only, whereas releases above and including 1.0 work in Python 3 only.

To install for Python 2, use:

pip install pykqml==0.5

To install for Python 3 (or force an upgrade to a compatible version), use

pip install "pykqml>0.5"

Usage

PyKQML implements the following KQML classes, which allow constructing and manipulating KQML messages programmatically:

KQMLToken
KQMLString
KQMLQuotation
KQMLList
KQMLPerformative
KQMLReader
KQMLDispatcher
KQMLModule

You can import KQML classes as, for instance,

from kqml import KQMLList

You can create a new KQML messaging agent in the context of the TRIPS system as

from kqml import KQMLModule

class MyAgent(KQMLModule):
    name = "MyAgent" # This is the name of the agent to register with

    def __init__(self, **kwargs):
        # Call the parent class' constructor which sends a registration
        # message, setting the agent's name to be recognized by the
        # Facilitator.
        super(MyAgent, self).__init__(name=self.name, **kwargs)

        # Subscribe to REQUESTs of interest. The list will change
        # depending on the role of the agent
        for req in ('what-next', 'commit', 'evaluate'):
            self.subscribe_request(req)

        # Subscribe to TELLs of interest if needed. This list will change
        # depending on the role of the agent
        for tell in ('log-speechact', ):
            self.subscribe_tell(tell)

        # Now signal that the agent is ready to receive messages
        self.ready()

        # Finally, start the listener for incoming messages
        self.start()


    def receive_request(self, msg, content):
        # First, figure out what kind of request this is
        task = content.head().upper()
        # Here you typically decide what to do based on the
        # type of request.

        # Construct reply message's content
        reply_content = KQMLList()
        # Set whatever needs to be set in the reply content

        # Finally, wrap the content in a message and reply
        reply_msg = KQMLPerformative('reply')
        reply_msg.set('content', reply_content)
        self.reply(msg, reply_msg)

Testing

You can run all tests by running nosetests in the top level folder.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pykqml-1.3.tar.gz (15.3 kB view details)

Uploaded Source

Built Distribution

pykqml-1.3-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

Details for the file pykqml-1.3.tar.gz.

File metadata

  • Download URL: pykqml-1.3.tar.gz
  • Upload date:
  • Size: 15.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.7.7

File hashes

Hashes for pykqml-1.3.tar.gz
Algorithm Hash digest
SHA256 dd365413f6776dd55c87c1fb1756a49d39e22d087c6b92543713e51d120e3ea4
MD5 4b1b4a07bbb914308099d58387e3aaa7
BLAKE2b-256 3b4395ce856e12cf073a9bc7f2ee87ad532c4c0f95d7dd07aaba0ac9063c554d

See more details on using hashes here.

Provenance

File details

Details for the file pykqml-1.3-py3-none-any.whl.

File metadata

  • Download URL: pykqml-1.3-py3-none-any.whl
  • Upload date:
  • Size: 16.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.7.7

File hashes

Hashes for pykqml-1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 95cb17c731f9f3881f7163b9c678617c2d3ddf0bf74f2ed1985b04708873b609
MD5 0c9f0150ee860ae32acc1114d35c9725
BLAKE2b-256 22c616d2b35a8b60eb44c0fde61a419f789e2664fcc2d718d181adc480132d52

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page