pycos: Concurrent, Asynchronous, Distributed, Communicating Tasks with Python

Note

pycos is renamed from asyncoro project to better reflect its functionality and to avoid confusion with asyncore module. See asyncoro2pycos for details.

pycos is a Python framework for, concurrent, asynchronous, network, distributed programming and distributed computing, using generator functions, asynchronous completions and message passing. pycos can be used to create tasks with generator functions, similar to the way threads are created with functions with Python’s threading module. Programs developed with pycos have same logic and structure as programs with threads, except for a few syntactic changes - mostly using yield with asynchronous completions that give control to pycos’s scheduler, which interleaves executions of generators, similar to the way an operating system executes multiple processes.

Unlike threads, creating tasks with pycos is very efficient. Moreover, with pycos context switch occurs only when tasks use yield (typically with an asychronous call), so there is no need for locking and there is no overhead of unnecessary context switches.

Unlike with other asynchronous frameworks, programming with pycos is rather straight forward; Asynchronous Concurrenct Programming (pycos) describes 4 simple steps to convert programming with threads to programming with pycos.

pycos features include:

  • No callbacks or event loops! No need to lock critical sections either,
  • Efficient polling mechanisms epoll, kqueue, Windows I/O Completion Ports (IOCP) for high performance and scalability,
  • Asynchronous (non-blocking) sockets and pipes, for concurrent processing of I/O,
  • SSL for security,
  • Asynchronous locking primitives similar to Python threading module,
  • Asynchronous timers and timeouts,
  • Message passing for (local and remote) tasks to exchange messages one-to-one with Message Queue Pattern or through broadcasting channels with Publish-Subscribe Pattern,
  • Location transparency with naming and locating (local and remote) resources,
  • Monitoring and restarting of (local or remote) tasks, for fault detection and fault-tolerance,
  • Distributing computation components (code and data) to execute Distributed Communicating Tasks (dispycos), for wide range of use cases, covering SIMD, MISD, MIMD system architectures at the process level, and web interface to monitor cluster/application status/performance; in-memory processing, data streaming, real-time (live) analytics and Cloud Computing are supported as well,
  • Remote execution of tasks for distributed programming with Remote Task Invocation RTI (Remote Task Invocation) and message passing,
  • Hot-swapping of task functions, for dynamic system reconfiguration,
  • Thread pools with asynchronous task completions, for executing synchronous tasks, e.g., external library calls, such as reading standard input.

For reference purposes, pycos with Python 2.7 on Raspberry Pi Model B+ (compliment by James Philips of pyeq2 project) running the program:

import time
import pycos
def task_proc(task=None):
    yield task.suspend()

tasks = [pycos.Task(task_proc) for i in xrange(10000)]
time.sleep(5)  # wait for tasks to run (and suspend)
for task in tasks:
    task.resume()

for line in open('/proc/self/status'):
    if line.startswith('VmPeak'):
        print('VM Peak: %d MB' % (int(line.split()[1]) / 1024))
    elif line.startswith('VmHWM'):
        print('VM Max: %d MB' % (int(line.split()[1]) / 1024))
    elif line.startswith('VmStk'):
        print('VM Stack: %d MB' % (int(line.split()[1]) / 1024))

shows that running 10,000 tasks takes about 23 MB of memory (with about 10 MB taken by modules used in pycos). Memory and time scale linearly: For 100,000 tasks memory used is 116 MB, for 200,000 tasks it is 218 MB, for 300,000 tasks it is 315 MB.

pycos works with Python 2.7+ and Python 3.1+ and tested on Linux, Mac OS X and Windows; it may work on other platforms too. pycos works with PyPy as well.

Dependencies

pycos is implemented with standard modules in Python.

If psutil is available on nodes, node availability status (CPU, memory and disk) is sent in status messages, and shown in web browser so cluster/application performance can be monitored.

Under Windows efficient polling notifier I/O Completion Ports is supported if pywin32 is available; otherwise, inefficient ‘select’ notifier is used.

Node / Servers sends node availability status (availability of CPU as percent, memory in bytes and disk space in bytes) at pulse_interval frequency if psutil module is installed. This information may be useful to clients, for example, to analyze application performance, to filter nodes based on available resources etc.

For IPv6, netifaces module is required with OS X. netifaces module is strongly recommended with Linux and Windows as well (for both IPv4 and IPv6). For IPv6 with Windows, win_inet_pton module is required with Python 2.7 (but not required with Python 3).

Download/Installation

  • pycos package is available in Python Package Index (PyPI) so it can be installed with:

    python -m pip install pycos
    
  • Docker Container describes how to build Docker image and run pycos modules in containers.

  • pycos can also be downloaded from Sourceforge Files. ‘py2’ directory contains files to be used with Python 2.7+ and ‘py3’ contains files to be used with Python 3.1+. To use pycos without installing, rename ‘py2’ to ‘pycos’ (to use with Python 2.7+); it can then be used from parent directory of ‘pycos’.

Examples

Examples illustrating some of the features of pycos are installed in ‘examples’ directory under where pycos module is installed, which can be obtained with the program:

import os, pycos
print(os.path.join(os.path.dirname(pycos.__file__), 'examples'))

See README file in that directory for brief description of each of the files.

Citation

If you use pycos in academic/research work, please cite pycos as:

Giridhar Pemmasani, "pycos: Concurrent, Asynchronous, Distributed,
  Communicating Tasks with Python", http://pycos.sourceforge.io, 2017.

Contents

Indices and tables