circuits 3.2.3 Documentation¶

Release:: 3.2.3
Date:: November 16, 2024

About¶

circuits is a Lightweight Event driven and Asynchronous Application Framework for the Python Programming Language with a strong Component Architecture.

circuits also includes a lightweight, high performance and scalable HTTP/WSGI compliant web server as well as various I/O and Networking components.

Got questions?

Ask a Question (Tag it: circuits-framework)

Examples¶

Hello¶

#!/usr/bin/env python

"""circuits Hello World"""

from circuits import Component, Event


class hello(Event):
    """hello Event"""


class App(Component):
    def hello(self):
        """Hello Event Handler"""
        print('Hello World!')

    def started(self, component):
        """
        Started Event Handler

        This is fired internally when your application starts up and can be used to
        trigger events that only occur once during startup.
        """
        self.fire(hello())  # Fire hello Event

        raise SystemExit(0)  # Terminate the Application


App().run()

Download Source Code: hello.py:

Echo Server¶

#!/usr/bin/env python

"""
Simple TCP Echo Server

This example shows how you can create a simple TCP Server (an Echo Service)
utilizing the builtin Socket Components that the circuits library ships with.
"""

from circuits import Debugger, handler
from circuits.net.sockets import TCPServer


class EchoServer(TCPServer):
    @handler('read')
    def on_read(self, sock, data):
        """
        Read Event Handler

        This is fired by the underlying Socket Component when there has been
        new data read from the connected client.

        ..note :: By simply returning, client/server socket components listen
                  to ValueChagned events (feedback) to determine if a handler
                  returned some data and fires a subsequent Write event with
                  the value returned.
        """
        return data


# Start and "run" the system.
# Bind to port 0.0.0.0:8000


app = EchoServer(('0.0.0.0', 8000))
Debugger().register(app)
app.run()

Download Source Code: echoserver.py:

Hello Web¶

#!/usr/bin/env python

from circuits.web import Controller, Server


class Root(Controller):
    def index(self):
        """
        Index Request Handler

        Controller(s) expose implicitly methods as request handlers.
        Request Handlers can still be customized by using the ``@expose``
        decorator. For example exposing as a different path.
        """
        return 'Hello World!'


app = Server(('0.0.0.0', 8000))
Root().register(app)
app.run()

Download Source Code: helloweb.py:

More examples…

Features¶

event driven
concurrency support
component architecture
asynchronous I/O components
no required external dependencies
full featured web framework (circuits.web)
coroutine based synchronization primitives

Requirements¶

circuits has no dependencies beyond the Python Standard Library.

Supported Platforms¶

Linux, FreeBSD, Mac OS X, Windows
Python 3.7, 3.8, 3.9, 3.10, 3.11, 3.12
pypy (the newer the better)

Installation¶

The simplest and recommended way to install circuits is with pip. You may install the latest stable release from PyPI with pip:

$ pip install circuits

If you do not have pip, you may use easy_install:

$ easy_install circuits

Alternatively, you may download the source package from the PyPi or the Downloads extract it and install using:

$ python setup.py install

Note

You can install the development version via pip install circuits==dev.

License¶

circuits is licensed under the MIT License.

Feedback¶

We welcome any questions or feedback about bugs and suggestions on how to improve circuits.

Let us know what you think about circuits. @pythoncircuits.

Do you have suggestions for improvement? Then please Create an Issue with details of what you would like to see. I’ll take a look at it and work with you to either incorporate the idea or find a better solution.

Community¶

There are also several places you can reach out to the circuits community:

Mailing List
#circuits IRC Channel on the Libera.Chat IRC Network
Ask a Question on Stackoverflow (Tag it: circuits-framework)

Disclaimer¶

Whilst I (James Mills) continue to contribute and maintain the circuits project I do not represent the interests or business of my employer Facebook Inc. The contributions I make are of my own free time and have no bearing or relevance to Facebook Inc.