circuits-2.1.0/0000755000014400001440000000000012113366740013073 5ustar prologicuserscircuits-2.1.0/circuits.egg-info/0000755000014400001440000000000012113366740016412 5ustar prologicuserscircuits-2.1.0/circuits.egg-info/entry_points.txt0000644000014400001440000000010512113366737021712 0ustar prologicusers [console_scripts] circuits.web = circuits.web.main:main circuits-2.1.0/circuits.egg-info/PKG-INFO0000644000014400001440000001674712113366737017534 0ustar prologicusersMetadata-Version: 1.0 Name: circuits Version: 2.1.0 Summary: Asynchronous Component based Event Application Framework Home-page: http://bitbucket.org/prologic/circuits/ Author: James Mills Author-email: James Mills, prologic at shortcircuit dot net dot au License: MIT Download-URL: http://bitbucket.org/prologic/circuits/downloads/ Description: .. _Python Programming Language: http://www.python.org/ .. _#circuits IRC Channel: http://webchat.freenode.net/?randomnick=1&channels=circuits&uio=d4 .. _FreeNode IRC Network: http://freenode.net .. _Python Standard Library: http://docs.python.org/library/ .. _Website: https://bitbucket.org/prologic/circuits/ .. _PyPi Page: http://pypi.python.org/pypi/circuits .. _Read the Docs: http://circuits.readthedocs.org/ .. _MIT License: http://www.opensource.org/licenses/mit-license.php .. _Create an Issue: https://bitbucket.org/prologic/circuits/issue/new .. _Mailing List: http://groups.google.com/group/circuits-users .. _Downloads page: https://bitbucket.org/prologic/circuits/downloads Overview -------- 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. To take full advantage of circuits and its architecture, circuits encourages you to design your application in terms of loosely coupled components. Circuits has a very powerful message passing system that enables components to interact with each other via events. Applications written this way tend to be more maintainable, easier to develop and scale to complex systems. circuits' **Loosely Coupled** **Component Architecture** allows for a high level of **Reuse** and **Scalability**. Simpler components can be combined together to form Complex Components and provide higher level functionality and abstraction. Much of the circuits component library is designed and built this way. - **Documentation**: http://packages.python.org/circuits or `Read the Docs`_. - **Project website**: https://bitbucket.org/prologic/circuits/ - **PyPI page**: http://pypi.python.org/pypi/circuits 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 - Python 2.6, 2.7, 3.2, 3.3 - pypy 2.0 **Windows**: We acknowledge that Windows exists and make reasonable efforts to maintain compatibility. Unfortunately we cannot guarantee support at this time. **NB**: We are working toward getting Windows supported. 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 Page`_ or the `Downloads page`_ on the `Website`_; extract it and install using:: > python setup.py install 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 is also a small community of circuits enthusiasts that you may find on the `#circuits IRC Channel`_ on the `FreeNode IRC Network`_ and the `Mailing List`_. .. raw:: html Release Notes - circuits-2.1.0 () ------------------------------------------ This release adds the following new features to circuits: - Python 3 support. - Windows support. - PyPy support. - IPv6 support. - Better WSGI support. - Fully documented examples. - Component Interface querying. And many bug fixes! Keywords: event framework distributed concurrent component asynchronous Platform: POSIX Classifier: Development Status :: 5 - Production/Stable Classifier: Environment :: Console Classifier: Environment :: No Input/Output (Daemon) Classifier: Environment :: Other Environment Classifier: Environment :: Plugins Classifier: Environment :: Web Environment Classifier: Intended Audience :: Developers Classifier: Intended Audience :: Information Technology Classifier: Intended Audience :: Science/Research Classifier: Intended Audience :: System Administrators Classifier: Intended Audience :: Telecommunications Industry Classifier: License :: OSI Approved :: MIT License Classifier: Natural Language :: English Classifier: Operating System :: POSIX :: BSD Classifier: Operating System :: POSIX :: Linux Classifier: Operating System :: MacOS :: MacOS X Classifier: Operating System :: Microsoft :: Windows Classifier: Programming Language :: Python :: 2.6 Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3.1 Classifier: Programming Language :: Python :: 3.2 Classifier: Programming Language :: Python :: 3.3 Classifier: Programming Language :: Python :: Implementation :: CPython Classifier: Programming Language :: Python :: Implementation :: PyPy Classifier: Topic :: Adaptive Technologies Classifier: Topic :: Communications :: Chat :: Internet Relay Chat Classifier: Topic :: Communications :: Email :: Mail Transport Agents Classifier: Topic :: Database Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Server Classifier: Topic :: Software Development :: Libraries :: Application Frameworks Classifier: Topic :: Software Development :: Libraries :: Python Modules Classifier: Topic :: System :: Clustering Classifier: Topic :: System :: Distributed Computing circuits-2.1.0/circuits.egg-info/dependency_links.txt0000644000014400001440000000000112113366737022466 0ustar prologicusers circuits-2.1.0/circuits.egg-info/SOURCES.txt0000644000014400001440000006672612113366740020317 0ustar prologicusers.coveragerc .hgchurn .hgignore .hgtags CHANGES.rst LICENSE MANIFEST.in Makefile README.rst RELEASE.rst setup.cfg setup.py tox.ini circuits/__init__.py circuits/six.py circuits.egg-info/PKG-INFO circuits.egg-info/SOURCES.txt circuits.egg-info/dependency_links.txt circuits.egg-info/entry_points.txt circuits.egg-info/not-zip-safe circuits.egg-info/top_level.txt circuits/app/__init__.py circuits/app/config.py circuits/app/daemon.py circuits/app/env.py circuits/app/log.py circuits/app/startup.py circuits/core/__init__.py circuits/core/bridge.py circuits/core/components.py circuits/core/debugger.py circuits/core/events.py circuits/core/handlers.py circuits/core/helpers.py circuits/core/loader.py circuits/core/manager.py circuits/core/pollers.py circuits/core/timers.py circuits/core/utils.py circuits/core/values.py circuits/core/workers.py circuits/io/__init__.py circuits/io/events.py circuits/io/file.py circuits/io/notify.py circuits/io/process.py circuits/io/serial.py circuits/net/__init__.py circuits/net/sockets.py circuits/net/protocols/__init__.py circuits/net/protocols/http.py circuits/net/protocols/irc.py circuits/net/protocols/line.py circuits/net/protocols/websocket.py circuits/node/__init__.py circuits/node/client.py circuits/node/events.py circuits/node/node.py circuits/node/server.py circuits/node/utils.py circuits/tools/__init__.py circuits/web/__init__.py circuits/web/_httpauth.py circuits/web/client.py circuits/web/constants.py circuits/web/controllers.py circuits/web/errors.py circuits/web/events.py circuits/web/exceptions.py circuits/web/headers.py circuits/web/http.py circuits/web/loggers.py circuits/web/main.py circuits/web/servers.py circuits/web/sessions.py circuits/web/tools.py circuits/web/utils.py circuits/web/websocket.py circuits/web/wrappers.py circuits/web/wsgi.py circuits/web/apps/__init__.py circuits/web/apps/memorymonitor/__init__.py circuits/web/apps/memorymonitor/reftree.py circuits/web/apps/memorymonitor/htdocs/graphs.html circuits/web/apps/memorymonitor/htdocs/main.css circuits/web/apps/memorymonitor/htdocs/trace.html circuits/web/apps/memorymonitor/htdocs/tree.html circuits/web/apps/webconsole/__init__.py circuits/web/apps/webconsole/htdocs/index.html circuits/web/dispatchers/__init__.py circuits/web/dispatchers/dispatcher.py circuits/web/dispatchers/jsonrpc.py circuits/web/dispatchers/static.py circuits/web/dispatchers/virtualhosts.py circuits/web/dispatchers/websockets.py circuits/web/dispatchers/xmlrpc.py docs/Makefile docs/check_docs.py docs/circuits-docs.xml docs/make.bat docs/build/doctrees/changes.doctree docs/build/doctrees/contributors.doctree docs/build/doctrees/environment.pickle docs/build/doctrees/faq.doctree docs/build/doctrees/glossary.doctree docs/build/doctrees/index.doctree docs/build/doctrees/pypitest.doctree docs/build/doctrees/todo.doctree docs/build/doctrees/users.doctree docs/build/doctrees/api/circuits_app.doctree docs/build/doctrees/api/circuits_app_config.doctree docs/build/doctrees/api/circuits_app_daemon.doctree docs/build/doctrees/api/circuits_app_env.doctree docs/build/doctrees/api/circuits_app_log.doctree docs/build/doctrees/api/circuits_core.doctree docs/build/doctrees/api/circuits_core_components.doctree docs/build/doctrees/api/circuits_core_debugger.doctree docs/build/doctrees/api/circuits_core_events.doctree docs/build/doctrees/api/circuits_core_handlers.doctree docs/build/doctrees/api/circuits_core_loader.doctree docs/build/doctrees/api/circuits_core_manager.doctree docs/build/doctrees/api/circuits_core_pollers.doctree docs/build/doctrees/api/circuits_core_timers.doctree docs/build/doctrees/api/circuits_core_utils.doctree docs/build/doctrees/api/circuits_core_values.doctree docs/build/doctrees/api/circuits_core_workers.doctree docs/build/doctrees/api/circuits_io.doctree docs/build/doctrees/api/circuits_io_events.doctree docs/build/doctrees/api/circuits_io_file.doctree docs/build/doctrees/api/circuits_io_notify.doctree docs/build/doctrees/api/circuits_io_serial.doctree docs/build/doctrees/api/circuits_net.doctree docs/build/doctrees/api/circuits_net_protocols.doctree docs/build/doctrees/api/circuits_net_protocols_http.doctree docs/build/doctrees/api/circuits_net_protocols_irc.doctree docs/build/doctrees/api/circuits_net_protocols_line.doctree docs/build/doctrees/api/circuits_net_sockets.doctree docs/build/doctrees/api/circuits_node.doctree docs/build/doctrees/api/circuits_node_client.doctree docs/build/doctrees/api/circuits_node_events.doctree docs/build/doctrees/api/circuits_node_node.doctree docs/build/doctrees/api/circuits_node_server.doctree docs/build/doctrees/api/circuits_node_utils.doctree docs/build/doctrees/api/circuits_tools.doctree docs/build/doctrees/api/circuits_web.doctree docs/build/doctrees/api/circuits_web_client.doctree docs/build/doctrees/api/circuits_web_constants.doctree docs/build/doctrees/api/circuits_web_controllers.doctree docs/build/doctrees/api/circuits_web_dispatchers_dispatcher.doctree docs/build/doctrees/api/circuits_web_dispatchers_jsonrpc.doctree docs/build/doctrees/api/circuits_web_dispatchers_static.doctree docs/build/doctrees/api/circuits_web_dispatchers_virtualhosts.doctree docs/build/doctrees/api/circuits_web_dispatchers_websockets.doctree docs/build/doctrees/api/circuits_web_dispatchers_xmlrpc.doctree docs/build/doctrees/api/circuits_web_errors.doctree docs/build/doctrees/api/circuits_web_events.doctree docs/build/doctrees/api/circuits_web_exceptions.doctree docs/build/doctrees/api/circuits_web_headers.doctree docs/build/doctrees/api/circuits_web_http.doctree docs/build/doctrees/api/circuits_web_loggers.doctree docs/build/doctrees/api/circuits_web_main.doctree docs/build/doctrees/api/circuits_web_servers.doctree docs/build/doctrees/api/circuits_web_sessions.doctree docs/build/doctrees/api/circuits_web_tools.doctree docs/build/doctrees/api/circuits_web_utils.doctree docs/build/doctrees/api/circuits_web_websocket.doctree docs/build/doctrees/api/circuits_web_wrappers.doctree docs/build/doctrees/api/circuits_web_wsgi.doctree docs/build/doctrees/api/index.doctree docs/build/doctrees/dev/contributing.doctree docs/build/doctrees/dev/index.doctree docs/build/doctrees/dev/introduction.doctree docs/build/doctrees/dev/processes.doctree docs/build/doctrees/howtos/index.doctree docs/build/doctrees/howtos/simple_server.doctree docs/build/doctrees/man/components.doctree docs/build/doctrees/man/debugging.doctree docs/build/doctrees/man/events.doctree docs/build/doctrees/man/handlers.doctree docs/build/doctrees/man/index.doctree docs/build/doctrees/man/manager.doctree docs/build/doctrees/man/tools.doctree docs/build/doctrees/man/values.doctree docs/build/doctrees/start/downloading.doctree docs/build/doctrees/start/index.doctree docs/build/doctrees/start/installing.doctree docs/build/doctrees/start/quick.doctree docs/build/doctrees/start/requirements.doctree docs/build/doctrees/tutorial/index.doctree docs/build/doctrees/web/basics.doctree docs/build/doctrees/web/gettingstarted.doctree docs/build/doctrees/web/index.doctree docs/build/doctrees/web/introduction.doctree docs/build/html/.buildinfo docs/build/html/changes.html docs/build/html/contributors.html docs/build/html/faq.html docs/build/html/genindex.html docs/build/html/glossary.html docs/build/html/index.html docs/build/html/objects.inv docs/build/html/py-modindex.html docs/build/html/pypitest.html docs/build/html/search.html docs/build/html/searchindex.js docs/build/html/todo.html docs/build/html/users.html docs/build/html/_downloads/001.py docs/build/html/_downloads/002.py docs/build/html/_downloads/003.py docs/build/html/_downloads/004.py docs/build/html/_downloads/005.py docs/build/html/_downloads/006.py docs/build/html/_downloads/007.py docs/build/html/_downloads/008.py docs/build/html/_downloads/009.py docs/build/html/_downloads/handler_annotation.py docs/build/html/_downloads/handler_returns.py docs/build/html/_downloads/simple_server.py docs/build/html/_images/graphviz-fa9bbccfbcc0c44bc0636e85a3c610dc406600cf.png docs/build/html/_images/graphviz-fa9bbccfbcc0c44bc0636e85a3c610dc406600cf.png.map docs/build/html/_images/web.png docs/build/html/_sources/changes.txt docs/build/html/_sources/contributors.txt docs/build/html/_sources/faq.txt docs/build/html/_sources/glossary.txt docs/build/html/_sources/index.txt docs/build/html/_sources/pypitest.txt docs/build/html/_sources/todo.txt docs/build/html/_sources/users.txt docs/build/html/_sources/api/circuits_app.txt docs/build/html/_sources/api/circuits_app_config.txt docs/build/html/_sources/api/circuits_app_daemon.txt docs/build/html/_sources/api/circuits_app_env.txt docs/build/html/_sources/api/circuits_app_log.txt docs/build/html/_sources/api/circuits_core.txt docs/build/html/_sources/api/circuits_core_components.txt docs/build/html/_sources/api/circuits_core_debugger.txt docs/build/html/_sources/api/circuits_core_events.txt docs/build/html/_sources/api/circuits_core_handlers.txt docs/build/html/_sources/api/circuits_core_loader.txt docs/build/html/_sources/api/circuits_core_manager.txt docs/build/html/_sources/api/circuits_core_pollers.txt docs/build/html/_sources/api/circuits_core_timers.txt docs/build/html/_sources/api/circuits_core_utils.txt docs/build/html/_sources/api/circuits_core_values.txt docs/build/html/_sources/api/circuits_core_workers.txt docs/build/html/_sources/api/circuits_io.txt docs/build/html/_sources/api/circuits_io_events.txt docs/build/html/_sources/api/circuits_io_file.txt docs/build/html/_sources/api/circuits_io_notify.txt docs/build/html/_sources/api/circuits_io_serial.txt docs/build/html/_sources/api/circuits_net.txt docs/build/html/_sources/api/circuits_net_protocols.txt docs/build/html/_sources/api/circuits_net_protocols_http.txt docs/build/html/_sources/api/circuits_net_protocols_irc.txt docs/build/html/_sources/api/circuits_net_protocols_line.txt docs/build/html/_sources/api/circuits_net_sockets.txt docs/build/html/_sources/api/circuits_node.txt docs/build/html/_sources/api/circuits_node_client.txt docs/build/html/_sources/api/circuits_node_events.txt docs/build/html/_sources/api/circuits_node_node.txt docs/build/html/_sources/api/circuits_node_server.txt docs/build/html/_sources/api/circuits_node_utils.txt docs/build/html/_sources/api/circuits_tools.txt docs/build/html/_sources/api/circuits_web.txt docs/build/html/_sources/api/circuits_web_client.txt docs/build/html/_sources/api/circuits_web_constants.txt docs/build/html/_sources/api/circuits_web_controllers.txt docs/build/html/_sources/api/circuits_web_dispatchers_dispatcher.txt docs/build/html/_sources/api/circuits_web_dispatchers_jsonrpc.txt docs/build/html/_sources/api/circuits_web_dispatchers_static.txt docs/build/html/_sources/api/circuits_web_dispatchers_virtualhosts.txt docs/build/html/_sources/api/circuits_web_dispatchers_websockets.txt docs/build/html/_sources/api/circuits_web_dispatchers_xmlrpc.txt docs/build/html/_sources/api/circuits_web_errors.txt docs/build/html/_sources/api/circuits_web_events.txt docs/build/html/_sources/api/circuits_web_exceptions.txt docs/build/html/_sources/api/circuits_web_headers.txt docs/build/html/_sources/api/circuits_web_http.txt docs/build/html/_sources/api/circuits_web_loggers.txt docs/build/html/_sources/api/circuits_web_main.txt docs/build/html/_sources/api/circuits_web_servers.txt docs/build/html/_sources/api/circuits_web_sessions.txt docs/build/html/_sources/api/circuits_web_tools.txt docs/build/html/_sources/api/circuits_web_utils.txt docs/build/html/_sources/api/circuits_web_websocket.txt docs/build/html/_sources/api/circuits_web_wrappers.txt docs/build/html/_sources/api/circuits_web_wsgi.txt docs/build/html/_sources/api/index.txt docs/build/html/_sources/dev/contributing.txt docs/build/html/_sources/dev/index.txt docs/build/html/_sources/dev/introduction.txt docs/build/html/_sources/dev/processes.txt docs/build/html/_sources/howtos/index.txt docs/build/html/_sources/howtos/simple_server.txt docs/build/html/_sources/man/components.txt docs/build/html/_sources/man/debugging.txt docs/build/html/_sources/man/events.txt docs/build/html/_sources/man/handlers.txt docs/build/html/_sources/man/index.txt docs/build/html/_sources/man/manager.txt docs/build/html/_sources/man/tools.txt docs/build/html/_sources/man/values.txt docs/build/html/_sources/start/downloading.txt docs/build/html/_sources/start/index.txt docs/build/html/_sources/start/installing.txt docs/build/html/_sources/start/quick.txt docs/build/html/_sources/start/requirements.txt docs/build/html/_sources/tutorial/index.txt docs/build/html/_sources/web/basics.txt docs/build/html/_sources/web/gettingstarted.txt docs/build/html/_sources/web/index.txt docs/build/html/_sources/web/introduction.txt docs/build/html/_static/ajax-loader.gif docs/build/html/_static/basic.css docs/build/html/_static/comment-bright.png docs/build/html/_static/comment-close.png docs/build/html/_static/comment.png docs/build/html/_static/default.css docs/build/html/_static/djangodocs.css docs/build/html/_static/docicons-behindscenes.png docs/build/html/_static/docicons-note.png docs/build/html/_static/docicons-philosophy.png docs/build/html/_static/doctools.js docs/build/html/_static/down-pressed.png docs/build/html/_static/down.png docs/build/html/_static/file.png docs/build/html/_static/homepage.css docs/build/html/_static/jquery.js docs/build/html/_static/logo.png docs/build/html/_static/minus.png docs/build/html/_static/plus.png docs/build/html/_static/pygments.css docs/build/html/_static/reset-fonts-grids.css docs/build/html/_static/searchtools.js docs/build/html/_static/tracsphinx.css docs/build/html/_static/underscore.js docs/build/html/_static/up-pressed.png docs/build/html/_static/up.png docs/build/html/_static/websupport.js docs/build/html/api/circuits_app.html docs/build/html/api/circuits_app_config.html docs/build/html/api/circuits_app_daemon.html docs/build/html/api/circuits_app_env.html docs/build/html/api/circuits_app_log.html docs/build/html/api/circuits_core.html docs/build/html/api/circuits_core_components.html docs/build/html/api/circuits_core_debugger.html docs/build/html/api/circuits_core_events.html docs/build/html/api/circuits_core_handlers.html docs/build/html/api/circuits_core_loader.html docs/build/html/api/circuits_core_manager.html docs/build/html/api/circuits_core_pollers.html docs/build/html/api/circuits_core_timers.html docs/build/html/api/circuits_core_utils.html docs/build/html/api/circuits_core_values.html docs/build/html/api/circuits_core_workers.html docs/build/html/api/circuits_io.html docs/build/html/api/circuits_io_events.html docs/build/html/api/circuits_io_file.html docs/build/html/api/circuits_io_notify.html docs/build/html/api/circuits_io_serial.html docs/build/html/api/circuits_net.html docs/build/html/api/circuits_net_protocols.html docs/build/html/api/circuits_net_protocols_http.html docs/build/html/api/circuits_net_protocols_irc.html docs/build/html/api/circuits_net_protocols_line.html docs/build/html/api/circuits_net_sockets.html docs/build/html/api/circuits_node.html docs/build/html/api/circuits_node_client.html docs/build/html/api/circuits_node_events.html docs/build/html/api/circuits_node_node.html docs/build/html/api/circuits_node_server.html docs/build/html/api/circuits_node_utils.html docs/build/html/api/circuits_tools.html docs/build/html/api/circuits_web.html docs/build/html/api/circuits_web_client.html docs/build/html/api/circuits_web_constants.html docs/build/html/api/circuits_web_controllers.html docs/build/html/api/circuits_web_dispatchers_dispatcher.html docs/build/html/api/circuits_web_dispatchers_jsonrpc.html docs/build/html/api/circuits_web_dispatchers_static.html docs/build/html/api/circuits_web_dispatchers_virtualhosts.html docs/build/html/api/circuits_web_dispatchers_websockets.html docs/build/html/api/circuits_web_dispatchers_xmlrpc.html docs/build/html/api/circuits_web_errors.html docs/build/html/api/circuits_web_events.html docs/build/html/api/circuits_web_exceptions.html docs/build/html/api/circuits_web_headers.html docs/build/html/api/circuits_web_http.html docs/build/html/api/circuits_web_loggers.html docs/build/html/api/circuits_web_main.html docs/build/html/api/circuits_web_servers.html docs/build/html/api/circuits_web_sessions.html docs/build/html/api/circuits_web_tools.html docs/build/html/api/circuits_web_utils.html docs/build/html/api/circuits_web_websocket.html docs/build/html/api/circuits_web_wrappers.html docs/build/html/api/circuits_web_wsgi.html docs/build/html/api/index.html docs/build/html/dev/contributing.html docs/build/html/dev/index.html docs/build/html/dev/introduction.html docs/build/html/dev/processes.html docs/build/html/howtos/index.html docs/build/html/howtos/simple_server.html docs/build/html/man/components.html docs/build/html/man/debugging.html docs/build/html/man/events.html docs/build/html/man/handlers.html docs/build/html/man/index.html docs/build/html/man/manager.html docs/build/html/man/tools.html docs/build/html/man/values.html docs/build/html/start/downloading.html docs/build/html/start/index.html docs/build/html/start/installing.html docs/build/html/start/quick.html docs/build/html/start/requirements.html docs/build/html/tutorial/index.html docs/build/html/web/basics.html docs/build/html/web/gettingstarted.html docs/build/html/web/index.html docs/build/html/web/introduction.html docs/source/changes.rst docs/source/conf.py docs/source/contributors.rst docs/source/faq.rst docs/source/glossary.rst docs/source/index.rst docs/source/pypitest.rst docs/source/requirements.txt docs/source/todo.rst docs/source/users.rst docs/source/_static/logo.png docs/source/_static/tracsphinx.css docs/source/_themes/om/genindex.html docs/source/_themes/om/layout.html docs/source/_themes/om/modindex.html docs/source/_themes/om/search.html docs/source/_themes/om/theme.conf docs/source/_themes/om/static/default.css docs/source/_themes/om/static/djangodocs.css docs/source/_themes/om/static/docicons-behindscenes.png docs/source/_themes/om/static/docicons-note.png docs/source/_themes/om/static/docicons-philosophy.png docs/source/_themes/om/static/homepage.css docs/source/_themes/om/static/reset-fonts-grids.css docs/source/api/circuits_app.rst docs/source/api/circuits_app_config.rst docs/source/api/circuits_app_daemon.rst docs/source/api/circuits_app_env.rst docs/source/api/circuits_app_log.rst docs/source/api/circuits_core.rst docs/source/api/circuits_core_components.rst docs/source/api/circuits_core_debugger.rst docs/source/api/circuits_core_events.rst docs/source/api/circuits_core_handlers.rst docs/source/api/circuits_core_loader.rst docs/source/api/circuits_core_manager.rst docs/source/api/circuits_core_pollers.rst docs/source/api/circuits_core_timers.rst docs/source/api/circuits_core_utils.rst docs/source/api/circuits_core_values.rst docs/source/api/circuits_core_workers.rst docs/source/api/circuits_io.rst docs/source/api/circuits_io_events.rst docs/source/api/circuits_io_file.rst docs/source/api/circuits_io_notify.rst docs/source/api/circuits_io_serial.rst docs/source/api/circuits_net.rst docs/source/api/circuits_net_protocols.rst docs/source/api/circuits_net_protocols_http.rst docs/source/api/circuits_net_protocols_irc.rst docs/source/api/circuits_net_protocols_line.rst docs/source/api/circuits_net_sockets.rst docs/source/api/circuits_node.rst docs/source/api/circuits_node_client.rst docs/source/api/circuits_node_events.rst docs/source/api/circuits_node_node.rst docs/source/api/circuits_node_server.rst docs/source/api/circuits_node_utils.rst docs/source/api/circuits_tools.rst docs/source/api/circuits_web.rst docs/source/api/circuits_web_client.rst docs/source/api/circuits_web_constants.rst docs/source/api/circuits_web_controllers.rst docs/source/api/circuits_web_dispatchers_dispatcher.rst docs/source/api/circuits_web_dispatchers_jsonrpc.rst docs/source/api/circuits_web_dispatchers_static.rst docs/source/api/circuits_web_dispatchers_virtualhosts.rst docs/source/api/circuits_web_dispatchers_websockets.rst docs/source/api/circuits_web_dispatchers_xmlrpc.rst docs/source/api/circuits_web_errors.rst docs/source/api/circuits_web_events.rst docs/source/api/circuits_web_exceptions.rst docs/source/api/circuits_web_headers.rst docs/source/api/circuits_web_http.rst docs/source/api/circuits_web_loggers.rst docs/source/api/circuits_web_main.rst docs/source/api/circuits_web_servers.rst docs/source/api/circuits_web_sessions.rst docs/source/api/circuits_web_tools.rst docs/source/api/circuits_web_utils.rst docs/source/api/circuits_web_websocket.rst docs/source/api/circuits_web_wrappers.rst docs/source/api/circuits_web_wsgi.rst docs/source/api/index.rst docs/source/dev/contributing.rst docs/source/dev/index.rst docs/source/dev/introduction.rst docs/source/dev/processes.rst docs/source/howtos/index.rst docs/source/howtos/simple_server.py docs/source/howtos/simple_server.rst docs/source/images/web.png docs/source/man/components.rst docs/source/man/debugging.rst docs/source/man/events.rst docs/source/man/handlers.rst docs/source/man/index.rst docs/source/man/manager.rst docs/source/man/tools.rst docs/source/man/values.rst docs/source/man/examples/handler_annotation.py docs/source/man/examples/handler_returns.py docs/source/start/downloading.rst docs/source/start/index.rst docs/source/start/installing.rst docs/source/start/quick.rst docs/source/start/requirements.rst docs/source/tutorial/001.py docs/source/tutorial/002.py docs/source/tutorial/003.py docs/source/tutorial/004.py docs/source/tutorial/005.py docs/source/tutorial/006.py docs/source/tutorial/007.py docs/source/tutorial/008.py docs/source/tutorial/009.py docs/source/tutorial/index.rst docs/source/web/basics.rst docs/source/web/gettingstarted.rst docs/source/web/index.rst docs/source/web/introduction.rst examples/99bottles.py examples/cat.py examples/chatserver.py examples/circ.py examples/dirwatch.py examples/echoserver.py examples/hello.py examples/hello_bridge.py examples/ircbot.py examples/ircclient.py examples/portforward.py examples/tail.py examples/telnet.py examples/test_memory_leaks.py examples/test_worker.py examples/timers.py examples/primitives/call.py examples/primitives/fire.py examples/primitives/wait.py examples/web/acldemo.py examples/web/authdemo.py examples/web/basecontrollers.py examples/web/baseservers.py examples/web/ca-chain.pem examples/web/cert.pem examples/web/controllers.py examples/web/counter.py examples/web/counter.txt examples/web/fileupload.py examples/web/filtering.py examples/web/forms.py examples/web/httpauth.py examples/web/jsoncontroller.py examples/web/jsonrpc.py examples/web/jsonserializer.py examples/web/jsontool.py examples/web/makotemplates.py examples/web/server-cert.pem examples/web/server-key.pem examples/web/sessions.py examples/web/shadowauth.py examples/web/singleclickandrun.py examples/web/ssl-forward-cert.py examples/web/sslserver.py examples/web/virtualhosts.py examples/web/websocket.html examples/web/websockets.py examples/web/wiki.zip examples/web/wsgi.py examples/web/wsgiapp.py examples/web/xmlrpc.py examples/web/static/css/base.css examples/web/static/img/rss.gif examples/web/static/img/valid-xhtml10.png examples/web/static/img/vcss.gif examples/web/terminal/terminal.py examples/web/terminal/static/favicon.ico examples/web/terminal/static/index.xhtml examples/web/terminal/static/css/base.css examples/web/terminal/static/js/jquery.js examples/web/terminal/static/js/jquery.terminal.js examples/web/terminal/static/js/main.js examples/web/tpl/base.html examples/web/tpl/index.html examples/web/wiki/wiki.py examples/web/wiki/defaultpages/BulletList examples/web/wiki/defaultpages/CheatSheet examples/web/wiki/defaultpages/DefinitionList examples/web/wiki/defaultpages/FrontPage examples/web/wiki/defaultpages/HeadingsPage examples/web/wiki/defaultpages/HorizontalLine examples/web/wiki/defaultpages/Indented examples/web/wiki/defaultpages/Macros examples/web/wiki/defaultpages/MixedList examples/web/wiki/defaultpages/NoLineBreak examples/web/wiki/defaultpages/NumberedList examples/web/wiki/defaultpages/RenderedPre examples/web/wiki/defaultpages/RenderedTable examples/web/wiki/defaultpages/SandBox examples/web/wiki/defaultpages/SiteMenu examples/web/wiki/macros/__init__.py examples/web/wiki/macros/html.py examples/web/wiki/macros/include.py examples/web/wiki/macros/utils.py examples/web/wiki/macros/wiki.py examples/web/wiki/static/Image.jpg examples/web/wiki/static/favicon.ico examples/web/wiki/static/css/pygments.css examples/web/wiki/static/css/screen.css examples/web/wiki/static/images/header_bg.png examples/web/wiki/tpl/edit.html examples/web/wiki/tpl/view.html man/circuits.bench.1 man/circuits.web.1 scripts/circuits.bench scripts/circuits.web tests/__init__.py tests/conftest.py tests/main.py tests/app/__init__.py tests/app/app.py tests/app/test_config.py tests/app/test_daemon.py tests/app/test_env.py tests/app/test_logger.py tests/core/__init__.py tests/core/app.py tests/core/signalapp.py tests/core/test_bridge.py tests/core/test_call_wait.py tests/core/test_channel_selection.py tests/core/test_complete.py tests/core/test_component_repr.py tests/core/test_component_setup.py tests/core/test_component_targeting.py tests/core/test_core.py tests/core/test_debugger.py tests/core/test_dynamic_handlers.py tests/core/test_errors.py tests/core/test_event.py tests/core/test_feedback.py tests/core/test_filter_order.py tests/core/test_filters.py tests/core/test_generate_events.py tests/core/test_generator_value.py tests/core/test_globals.py tests/core/test_imports.py tests/core/test_inheritence.py tests/core/test_interface_query.py tests/core/test_loader.py tests/core/test_manager_repr.py tests/core/test_priority.py tests/core/test_signals.py tests/core/test_singleton.py tests/core/test_timers.py tests/core/test_utils.py tests/core/test_value.py tests/core/test_worker_process.py tests/core/test_worker_thread.py tests/io/__init__.py tests/io/test_file.py tests/io/test_notify.py tests/io/test_process.py tests/net/__init__.py tests/net/client.py tests/net/server.py tests/net/test_client.py tests/net/test_pipe.py tests/net/test_poller_reuse.py tests/net/test_tcp.py tests/net/test_udp.py tests/net/test_unix.py tests/net/protocols/__init__.py tests/net/protocols/test_irc.py tests/net/protocols/test_line.py tests/node/test_node.py tests/node/test_utils.py tests/tools/__init__.py tests/tools/test_tools.py tests/web/__init__.py tests/web/cert.pem tests/web/conftest.py tests/web/helpers.py tests/web/jsonrpclib.py tests/web/multipartform.py tests/web/test_100_continue.py tests/web/test_basicauth.py tests/web/test_client.py tests/web/test_conn.py tests/web/test_cookies.py tests/web/test_core.py tests/web/test_digestauth.py tests/web/test_dispatcher.py tests/web/test_dispatcher2.py tests/web/test_dispatcher3.py tests/web/test_disps.py tests/web/test_encodings.py tests/web/test_exceptions.py tests/web/test_expires.py tests/web/test_expose.py tests/web/test_generator.py tests/web/test_gzip.py tests/web/test_headers.py tests/web/test_http.py tests/web/test_json.py tests/web/test_jsonrpc.py tests/web/test_large_post.py tests/web/test_logger.py tests/web/test_multipartformdata.py tests/web/test_null_response.py tests/web/test_request_failure.py tests/web/test_serve_download.py tests/web/test_serve_file.py tests/web/test_servers.py tests/web/test_sessions.py tests/web/test_static.py tests/web/test_unicode.py tests/web/test_utils.py tests/web/test_value.py tests/web/test_vpath_args.py tests/web/test_websockets.py tests/web/test_wsgi_application.py tests/web/test_wsgi_application_generator.py tests/web/test_wsgi_application_yield.py tests/web/test_wsgi_gateway.py tests/web/test_wsgi_gateway_errors.py tests/web/test_wsgi_gateway_generator.py tests/web/test_wsgi_gateway_multiple_apps.py tests/web/test_wsgi_gateway_null_response.py tests/web/test_wsgi_gateway_write.py tests/web/test_wsgi_gateway_yield.py tests/web/test_xmlrpc.py tests/web/test_yield.py tests/web/websocket.py tests/web/static/#foobar.txt tests/web/static/helloworld.txt tests/web/static/test.css tests/web/static/unicode.txt tools/mkpkgscircuits-2.1.0/circuits.egg-info/top_level.txt0000644000014400001440000000001712113366737021150 0ustar prologicuserscircuits tests circuits-2.1.0/circuits.egg-info/not-zip-safe0000644000014400001440000000000112113365112020630 0ustar prologicusers circuits-2.1.0/man/0000755000014400001440000000000012113366740013646 5ustar prologicuserscircuits-2.1.0/man/circuits.bench.10000644000014400001440000000274612072034467016646 0ustar prologicusers.TH circuits.bench 1 "Jun 2011" "circuits 2.0.2" "User Commands" .SH NAME circuits.bench \- simple benchmaking of the circuits library .SH SYNOPSIS .B circuits.bench [\fIoptions\fR] .SH DESCRIPTION circuits.bench does some simple benchmaking of the circuits library. .SH OPTIONS .TP \fB-b\fR \fIaddress:[port]\fR Bind to address:[port] (UDP) to test remote events. Default address is 0.0.0.0. .TP \fB-c\fR \fIinteger\fR Set concurrency level to \fIinteger\fR. Default is 1. .TP \fB-d\fR Enable debug mode. .TP \fB-e\fR \fInumber\fR Stop after specified \fInumber\fR of events. Default is 0. .TP \fB-f\fR \fInumber\fR \fInumber\fR of dummy events to fill queue with. Default is 0. .TP \fB-l\fR Listen on 0.0.0.0:8000 (UDP) to test remote events. .TP \fB-m\fR \fImode\fR Set operation mode. \fImode\fR can be \fIlatency\fR, \fIspeed\fR or \fIsync\fR. Default \fImode\fR is \fIspeed\fR. .TP \fB-o\fR \fIformat\fR Specify output format. For example \fIformat\fR can be:"cicuits.bench: events:%s, speed:%s, time:%s" .TP \fB-p\fR Enable execution profiling support. .TP \fB-q\fR Suppress output. .TP \fB-s\fR Enable psyco (circuits on speed!) if it is available. .TP \fB-t\fR \fIseconds\fR Stop after specified elapsed \fIseconds\fR. .TP \fB-w\fR Wait for remote nodes to connect. .TP \fB--version\fR Output version information and exit. .SH AUTHOR James Mills .PP This manual page was written by Daniele Tricoli , for the Debian project (but may be used by others). circuits-2.1.0/man/circuits.web.10000644000014400001440000000234012072034467016332 0ustar prologicusers.TH circuits.web 1 "Jun 2011" "circuits 2.0.2" "User Commands" .SH NAME circuits.web \- Web Server and testing tool .SH SYNOPSIS .B circuits.web [\fIoptions\fR] [\fIdocroot\fR] .SH DESCRIPTION circuits.web is a component based, event-driven light weight and high performance HTTP/WSGI framework. circuits.web applications are stand-alone applications with a high performance, multi-process web server with great concurrent scalability with full support for WSGI and deployment with other web servers. .SH OPTIONS .TP \fB-b\fR \fIaddress:[port]\fR Bind to address:[port]. Default address is 0.0.0.0:8000. .TP \fB-d\fR Enable debug mode. .TP \fB-j\fR Use python JIT (psyco) if it is available. .TP \fB-m\fR \fInumber\fR Specify \fInumber\fR of processes to start (multiprocessing). .TP \fB-p\fR Enable execution profiling support. .TP \fB-s\fR \fIserver\fR Specify server to use. .TP \fB-t\fR \fItype\fR Specify type of poller to use. \fItype\fR can be \fIepoll\fR, \fIpoll\fR or \fIselect\fR. Default \fItype\fR is \fIselect\fR. .TP \fB-v\fR Enable WSGI validation mode. .SH AUTHOR James Mills .PP This manual page was written by Daniele Tricoli , for the Debian project (but may be used by others). circuits-2.1.0/docs/0000755000014400001440000000000012113366740014023 5ustar prologicuserscircuits-2.1.0/docs/circuits-docs.xml0000644000014400001440000000043012113343751017312 0ustar prologicuserscircuits-2.1.0/docs/check_docs.py0000644000014400001440000000132412113343751016457 0ustar prologicusers#!/usr/bin/env python from subprocess import Popen, PIPE, STDOUT def test_linkcheck(tmpdir): doctrees = tmpdir.join("doctrees") htmldir = tmpdir.join("html") p = Popen([ "sphinx-build", "-W", "-blinkcheck", "-d", str(doctrees), "source", str(htmldir) ], stdout=PIPE, stderr=STDOUT) stdout, _ = p.communicate() if not p.wait() == 0: print(stdout) def test_build_docs(tmpdir): doctrees = tmpdir.join("doctrees") htmldir = tmpdir.join("html") p = Popen([ "sphinx-build", "-W", "-bhtml", "-d", str(doctrees), "source", str(htmldir) ], stdout=PIPE, stderr=STDOUT) stdout, _ = p.communicate() if not p.wait() == 0: print(stdout) circuits-2.1.0/docs/Makefile0000644000014400001440000000607612072034467015476 0ustar prologicusers# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " changes to make an overview of all changed/added/deprecated items" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: -rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/circuits.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/circuits.qhc" latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ "run these through (pdf)latex." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." circuits-2.1.0/docs/build/0000755000014400001440000000000012113366740015122 5ustar prologicuserscircuits-2.1.0/docs/build/html/0000755000014400001440000000000012113366740016066 5ustar prologicuserscircuits-2.1.0/docs/build/html/api/0000755000014400001440000000000012113366740016637 5ustar prologicuserscircuits-2.1.0/docs/build/html/api/circuits_web_dispatchers_websockets.html0000644000014400001440000003030312113366677027041 0ustar prologicusers circuits.web.dispatchers.websockets – WebSockets — circuits 2.1.0 documentation

circuits.web.dispatchers.websockets – WebSockets

Events

Components

class circuits.web.dispatchers.websockets.WebSockets(path=None, wschannel='ws', *args, **kwargs)

Bases: circuits.core.components.BaseComponent

This class implements an RFC 6455 compliant WebSockets dispatcher that handles the WebSockets handshake and upgrades the connection.

The dispatcher listens on its channel for Request events and tries to match them with a given path. Upon a match, the request is checked for the proper Opening Handshake information. If successful, the dispatcher confirms the establishment of the connection to the client. Any subsequent data from the client is handled as a WebSocket data frame, decoded and fired as a Read event on the wschannel passed to the constructor. The data from Write events on that channel is encoded as data frames and forwarded to the client.

Firing a Close event on the wschannel closes the connection in an orderly fashion (i.e. as specified by the WebSocket protocol).

Parameters:
  • path – the path to handle. Requests that start with this path are considered to be WebSocket Opening Handshakes.
  • wschannel – the channel on which Read events from the client will be delivered and where Write events to the client will be sent to.

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_core_values.html0000644000014400001440000002474612113366674023764 0ustar prologicusers circuits.core.values – Value — circuits 2.1.0 documentation

circuits.core.values – Value

This defines the Value object used by components and events.

Classes

class circuits.core.values.Value(event=None, manager=None)

Bases: object

Create a new future Value Object

Creates a new future Value Object which is used by Event Objects and the Manager to store the result(s) of an Event Handler’s exeuction of some Event in the system.

Parameters:
  • event (Event instance) – The Event this Value is associated with.
  • manager (A Manager/Component instance.) – The Manager/Component used to trigger notifications.
Variables:
  • result – True if this value has been changed.
  • errors – True if while setting this value an exception occured.
  • notify – True or an event name to notify of changes to this value

This is a Future/Promise implementation.

Components

none

Events

none

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_node_server.html0000644000014400001440000002174112113366676023762 0ustar prologicusers circuits.node.server – Server — circuits 2.1.0 documentation

circuits.node.server – Server

Server

...

Events

none

Components

class circuits.node.server.Server(bind, channel='node')

Bases: circuits.core.components.BaseComponent

Server

...

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_core_handlers.html0000644000014400001440000003505112113366674024254 0ustar prologicusers circuits.core.handlers – Handlers — circuits 2.1.0 documentation

circuits.core.handlers – Handlers

This module define the @handler decorator/function and the HandlesType type.

Classes

class circuits.core.handlers.HandlerMetaClass(name, bases, ns)

Bases: type

Components

none

Events

none

Functions

circuits.core.handlers.handler(*names, **kwargs)

Creates an Event Handler

This decorator can be applied to methods of classes derived from circuits.core.components.BaseComponent. It marks the method as a handler for the events passed as arguments to the @handler decorator. The events are specified by their name.

The decorated method’s arguments must match the arguments passed to the circuits.core.events.Event on creation. Optionally, the method may have an additional first argument named event. If declared, the event object that caused the handler to be invoked is assigned to it.

By default, the handler is invoked by the component’s root Manager for events that are propagated on the channel determined by the BaseComponent’s channel attribute. This may be overridden by specifying a different channel as a keyword parameter of the decorator (channel=...).

Keyword argument priority influences the order in which handlers for a specific event are invoked. The higher the priority, the earlier the handler is executed.

A handler may also be specified as a filter by adding the keyword argument filter=True to the decorator. If such a handler returns a value different from None, no more handlers are invoked for the handled event. Filtering handlers are invoked before normal handlers with the same priority (but after any handlers with higher priority).

If you want to override a handler defined in a base class of your component, you must specify override=True, else your method becomes an additional handler for the event.

Return value

Normally, the results returned by the handlers for an event are simply collected in the circuits.core.events.Event‘s value attribute. As a special case, a handler may return a types.GeneratorType. This signals to the dispatcher that the handler isn’t ready to deliver a result yet. Rather, it has interrupted it’s execution with a yield None statement, thus preserving its current execution state.

The dispatcher saves the returned generator object as a task. All tasks are reexamined (i.e. their next() method is invoked) when the pending events have been executed.

This feature avoids an unnecessarily complicated chaining of event handlers. Imagine a handler A that needs the results from firing an event E in order to complete. Then without this feature, the final action of A would be to fire event E, and another handler for an event SuccessE would be required to complete handler A’s operation, now having the result from invoking E available (actually it’s even a bit more complicated).

Using this “suspend” feature, the handler simply fires event E and then yields None until e.g. it finds a result in E’s value attribute. For the simplest scenario, there even is a utility method circuits.core.manager.Manager.callEvent() that combines firing and waiting.

circuits.core.handlers.reprhandler(handler)
« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_websocket.html0000644000014400001440000003161112113366700024253 0ustar prologicusers circuits.web.websocket – WebSocket Client — circuits 2.1.0 documentation

circuits.web.websocket – WebSocket Client

Events

Components

class circuits.web.websocket.WebSocketClient(url, channel='wsclient', wschannel='ws', headers={})

Bases: circuits.core.components.BaseComponent

An RFC 6455 compliant WebSocket client component. Upon receiving a circuits.web.client.Connect event, the component tries to establish the connection to the server in a two stage process. First, a circuits.net.sockets.Connect event is sent to a child TCPClient. When the TCP connection has been established, the HTTP request for opening the WebSocket is sent to the server. A failure in this setup process is signaled by a NotConnected event.

When the server accepts the request, the WebSocket connection is established and can be used very much like an ordinary socket by handling Read events on and sending Write events to the channel specified as the wschannel parameter of the constructor. Firing a Close event on that channel closes the connection in an orderly fashion (i.e. as specified by the WebSocket protocol).

Parameters:
  • url – the URL to connect to.
  • channel – the channel used by this component
  • wschannel – the channel used for the actual WebSocket communication (read, write, close events)
  • headers – additional headers to be passed with the WebSocket setup HTTP request
channel = 'wsclient'
close()
connected

Functions

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_client.html0000644000014400001440000002747712113366676023576 0ustar prologicusers circuits.web.client – Client — circuits 2.1.0 documentation

circuits.web.client – Client

Events

class circuits.web.client.Request(method, path, body=None, headers={})

Bases: circuits.core.events.Event

Request Event

This Event is used to initiate a new request.

Parameters:
  • method (str) – HTTP Method (PUT, GET, POST, DELETE)
  • path (str) – Path to resource

Components

class circuits.web.client.Client(url, channel='client')

Bases: circuits.core.components.BaseComponent

channel = 'client'
write(data)
close()
connect(host=None, port=None, secure=None)
request(method, path, body=None, headers={})
connected
response

Functions

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_events.html0000644000014400001440000006025212113366677023611 0ustar prologicusers circuits.web.events – Events — circuits 2.1.0 documentation

circuits.web.events – Events

Events

class circuits.web.events.WebEvent(*args, **kwargs)

Bases: circuits.core.events.Event

WebEvents have both their success and failure attributes set to True. So event processing generates the derived events ...Success or ...Failure events.

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.web.events.Request(*args, **kwargs)

Bases: circuits.web.events.WebEvent

Request(WebEvent) -> Request WebEvent

args: request, response

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
classmethod create(name, *args, **kwargs)

All classes derived dynamically from Request are LiteralEvents.

class circuits.web.events.Response(*args, **kwargs)

Bases: circuits.web.events.WebEvent

Response(WebEvent) -> Response WebEvent

args: request, response

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.web.events.Stream(*args, **kwargs)

Bases: circuits.web.events.WebEvent

Stream(WebEvent) -> Stream WebEvent

args: request, response

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.

Components

none

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_core_workers.html0000644000014400001440000002747512113366674024163 0ustar prologicusers circuits.core.workers – Workers — circuits 2.1.0 documentation

circuits.core.workers – Workers

Workers

Worker components used to perform “work” in independent threads or processes. Worker(s) are typically used by a Pool (circuits.core.pools) to create a pool of workers. Worker(s) are not registered with a Manager or another Component - instead they are managed by the Pool. If a Worker is used independently it should not be registered as it causes its main event handler _on_task to execute in the other thread blocking it.

Classes

none

Components

class circuits.core.workers.Worker(*args, **kwargs)

Bases: circuits.core.components.BaseComponent

A thread/process Worker Component

This Component creates a Worker (either a thread or process) which when given a Task, will execute the given function in the task in the background in its thread/process.

Parameters:process (bool) – True to start this Worker as a process (Thread otherwise)

initializes x; see x.__class__.__doc__ for signature

Events

class circuits.core.workers.Task(f, *args, **kwargs)

Bases: circuits.core.events.Event

Task Event

This Event is used to initiate a new task to be performed by a Worker or a Pool of Worker(s).

Parameters:
  • f (function) – The function to be executed.
  • args (tuple) – Arguments to pass to the function
  • kwargs (dict) – Keyword Arguments to pass to the function

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_utils.html0000644000014400001440000003073612113366700023434 0ustar prologicusers circuits.web.utils – Utilities — circuits 2.1.0 documentation

circuits.web.utils – Utilities

Utilities

This module implements utility functions.

Events

none

Components

none

Functions

circuits.web.utils.compress(body, compress_level)

Compress ‘body’ at the given compress_level.

circuits.web.utils.dictform(form)
circuits.web.utils.get_ranges(headervalue, content_length)

Return a list of (start, stop) indices from a Range header, or None.

Each (start, stop) tuple will be composed of two ints, which are suitable for use in a slicing operation. That is, the header “Range: bytes=3-6”, if applied against a Python string, is requesting resource[3:7]. This function will return the list [(3, 7)].

If this function returns an empty list, you should return HTTP 416.

circuits.web.utils.parse_body(request, response, params)
circuits.web.utils.parse_qs(query_string) → dict

Build a params dictionary from a query_string. If keep_blank_values is True (the default), keep values that are blank.

circuits.web.utils.url(request, path='', qs='', script_name=None, base=None, relative=None)

Create an absolute URL for the given path.

If ‘path’ starts with a slash (‘/’), this will return
  • (base + script_name + path + qs).
If it does not start with a slash, this returns
  • (base + script_name [+ request.path] + path + qs).

If script_name is None, request will be used to find a script_name, if available.

If base is None, request.base will be used (if available).

Finally, note that this function can be used to obtain an absolute URL for the current request path (minus the querystring) by passing no args. If you call url(qs=request.qs), you should get the original browser URL (assuming no internal redirections).

If relative is False the output will be an absolute URL (including the scheme, host, vhost, and script_name). If True, the output will instead be a URL that is relative to the current request path, perhaps including ‘..’ atoms. If relative is the string ‘server’, the output will instead be a URL that is relative to the server root; i.e., it will start with a slash.

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_app.html0000644000014400001440000002061012113366672022215 0ustar prologicusers circuits.app – Application Support — circuits 2.1.0 documentation

circuits.app – Application Support

Application Components

Contains various components useful for application development and tasks common to applications.

copyright:CopyRight (C) 2004-2012 by James Mills
license:MIT (See: LICENSE)
« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_io_notify.html0000644000014400001440000011470712113366675023452 0ustar prologicusers circuits.io.notify – File System Notification — circuits 2.1.0 documentation

circuits.io.notify – File System Notification

Events

class circuits.io.notify.Accessed(*args, **kwargs)

Bases: circuits.core.events.Event

Accessed Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.io.notify.Closed(*args, **kwargs)

Bases: circuits.core.events.Event

Closed Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.io.notify.Created(*args, **kwargs)

Bases: circuits.core.events.Event

Created Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.io.notify.Deleted(*args, **kwargs)

Bases: circuits.core.events.Event

Deleted Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.io.notify.Modified(*args, **kwargs)

Bases: circuits.core.events.Event

Modified Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.io.notify.Moved(*args, **kwargs)

Bases: circuits.core.events.Event

Moved Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.io.notify.Opened(*args, **kwargs)

Bases: circuits.core.events.Event

Opened Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.io.notify.Unmounted(*args, **kwargs)

Bases: circuits.core.events.Event

Unmounted Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.

Components

class circuits.io.notify.Notify(channel='notify')

Bases: circuits.core.components.Component

Functions

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_net_protocols_irc.html0000644000014400001440000002521112113366675025171 0ustar prologicusers circuits.net.protocols.irc – IRC Protocol — circuits 2.1.0 documentation

circuits.net.protocols.irc – IRC Protocol

Events

class circuits.net.protocols.irc.RAW(*args, **kwargs)

Bases: circuits.net.protocols.irc.Command

RAW command

Components

class circuits.net.protocols.irc.IRC(*args, **kwargs)

Bases: circuits.core.components.Component

IRC Protocol Component

Creates a new IRC Component instance that implements the IRC Protocol. Incoming messages are handled by the “read” Event Handler, parsed and processed with appropriate Events created and exposed to the rest of te system to listen to and handle.

@note: This Component must be used in conjunction with a Component that
exposes Read Events on a “read” Channel.
line(line)

Line Event Handler

Process a line of text and generate the appropiate event. This must not be overridden by sub-classes, if it is, this must be explitetly called by the sub-class. Other Components may however listen to this event and process custom IRC events.

Functions

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_net_protocols_http.html0000644000014400001440000004075112113366675025401 0ustar prologicusers circuits.net.protocols.http – HTTP Protocol — circuits 2.1.0 documentation

circuits.net.protocols.http – HTTP Protocol

Events

class circuits.net.protocols.http.Request(*args, **kwargs)

Bases: circuits.core.events.Event

Request Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.net.protocols.http.Response(*args, **kwargs)

Bases: circuits.core.events.Event

Response Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.

Components

class circuits.net.protocols.http.HTTP(encoding='utf-8', channel='web')

Bases: circuits.core.components.BaseComponent

Functions

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_io_serial.html0000644000014400001440000002200212113366675023403 0ustar prologicusers circuits.io.serial – Serial I/O — circuits 2.1.0 documentation

circuits.io.serial – Serial I/O

Events

none

Components

class circuits.io.serial.Serial(port, baudrate=115200, bufsize=4096, timeout=0.20000000000000001, channel='serial')

Bases: circuits.core.components.Component

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_tools.html0000644000014400001440000002035612113366676022610 0ustar prologicusers circuits.tools – Development Tools — circuits 2.1.0 documentation

circuits.tools – Development Tools

Often you will end up needing to do some debugging or inspection of your system. The circuits.tools package provides a set of development tools for debugging, inspection and analysis.

circuits.tools.graph(x, name=None)

Display a directed graph of the Component structure of x

Parameters:
  • x (Component or Manager) – A Component or Manager to graph
  • name (str) – A name for the graph (defaults to x’s name)

@return: A directed graph representing x’s Component sturcture. @rtype: str

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_dispatchers_virtualhosts.html0000644000014400001440000002571012113366677027445 0ustar prologicusers circuits.web.dispatchers.virtualhosts – Virtual Hosts — circuits 2.1.0 documentation

circuits.web.dispatchers.virtualhosts – Virtual Hosts

VirtualHost

This module implements a virtual host dispatcher that sends requests for configured virtual hosts to different dispatchers.

Events

none

Components

class circuits.web.dispatchers.virtualhosts.VirtualHosts(domains)

Bases: circuits.core.components.BaseComponent

Forward to anotehr Dispatcher based on the Host header.

This can be useful when running multiple sites within one server. It allows several domains to point to different parts of a single website structure. For example: - http://www.domain.example -> / - http://www.domain2.example -> /domain2 - http://www.domain2.example:443 -> /secure

Parameters:domains (dict) – a dict of {host header value: virtual prefix} pairs.

The incoming “Host” request header is looked up in this dict, and, if a match is found, the corresponding “virtual prefix” value will be prepended to the URL path before passing the request onto the next dispatcher.

Note that you often need separate entries for “example.com” and “www.example.com”. In addition, “Host” headers may contain the port number.

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_core_pollers.html0000644000014400001440000002743112113366674024137 0ustar prologicusers circuits.core.pollers – I/O Pollers — circuits 2.1.0 documentation

circuits.core.pollers – I/O Pollers

Poller Components for asynchronous file and socket I/O.

This module contains Poller components that enable polling of file or socket descriptors for read/write events. Pollers: - Select - Poll - EPoll

Classes

none

Components

class circuits.core.pollers.BasePoller(timeout=0.01, channel=None)

Bases: circuits.core.components.BaseComponent

class circuits.core.pollers.Select(timeout=0.01, channel='select')

Bases: circuits.core.pollers.BasePoller

Select(...) -> new Select Poller Component

Creates a new Select Poller Component that uses the select poller implementation. This poller is not recommended but is available for legacy reasons as most systems implement select-based polling for backwards compatibility.

class circuits.core.pollers.Poll(timeout=0.01, channel='poll')

Bases: circuits.core.pollers.BasePoller

Poll(...) -> new Poll Poller Component

Creates a new Poll Poller Component that uses the poll poller implementation.

class circuits.core.pollers.EPoll(timeout=0.01, channel='epoll')

Bases: circuits.core.pollers.BasePoller

EPoll(...) -> new EPoll Poller Component

Creates a new EPoll Poller Component that uses the epoll poller implementation.

Events

none

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_core_timers.html0000644000014400001440000002547112113366674023764 0ustar prologicusers circuits.core.timers – Timers — circuits 2.1.0 documentation

circuits.core.timers – Timers

Timer component to facilitate timed events.

Classes

none

Components

class circuits.core.timers.Timer(interval, event, *channels, **kwargs)

Bases: circuits.core.components.BaseComponent

A timer is a component that fires an event once after a certain delay or periodically at a regular interval.

Parameters:
  • interval (datetime or float number) – the delay or interval to wait for until the event is fired. If interval is specified as datetime, the interval is recalculated as the time span from now to the given datetime.
  • event (Event) – the event to fire.

If the optional keyword argument persist is set to True, the event will be fired repeatedly. Else the timer fires the event once and then unregisters itself.

reset()

Reset the timer, i.e. clear the amount of time already waited for.

Events

none

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_core.html0000644000014400001440000002155512113366673022377 0ustar prologicusers circuits.core – Core Functionality — circuits 2.1.0 documentation
circuits-2.1.0/docs/build/html/api/circuits_net_protocols.html0000644000014400001440000002036612113366675024342 0ustar prologicusers circuits.net.protocols – Networking Protocols — circuits 2.1.0 documentation

circuits.net.protocols – Networking Protocols

Networking Protocols

This package contains components that implement various networking protocols.

« previous | up | next »
circuits-2.1.0/docs/build/html/api/index.html0000644000014400001440000002030412113366700020627 0ustar prologicusers API Reference — circuits 2.1.0 documentation
circuits-2.1.0/docs/build/html/api/circuits_web_dispatchers_jsonrpc.html0000644000014400001440000003235512113366677026357 0ustar prologicusers circuits.web.dispatchers.jsonrpc – JSON-RPC — circuits 2.1.0 documentation

circuits.web.dispatchers.jsonrpc – JSON-RPC

JSON RPC

This module implements a JSON RPC dispatcher that translates incoming RPC calls over JSON into RPC events.

Events

class circuits.web.dispatchers.jsonrpc.RPC(*args, **kwargs)

Bases: circuits.core.events.Event

RPC Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.

Components

class circuits.web.dispatchers.jsonrpc.JSONRPC(path=None, encoding='utf-8', rpc_channel='*')

Bases: circuits.core.components.BaseComponent

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_core_debugger.html0000644000014400001440000002427612113366673024246 0ustar prologicusers circuits.core.debugger – Debugger — circuits 2.1.0 documentation

circuits.core.debugger – Debugger

Debugger component used to debug each event in a system by printing each event to sys.stderr or to a Logger Component instance.

Classes

none

Components

class circuits.core.debugger.Debugger(errors=True, events=True, file=None, logger=None, prefix=None, trim=None, **kwargs)

Bases: circuits.core.components.BaseComponent

Create a new Debugger Component

Creates a new Debugger Component that filters all events in the system printing each event to sys.stderr or a Logger Component.

Variables:
  • IgnoreEvents – list of events (str) to ignore
  • IgnoreChannels – list of channels (str) to ignore
  • enabled – Enabled/Disabled flag
Parameters:

log – Logger Component instance or None (default)

initializes x; see x.__class__.__doc__ for signature

Events

none

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_net.html0000644000014400001440000002142512113366675022233 0ustar prologicusers circuits.net – Networking — circuits 2.1.0 documentation

circuits.net – Networking

Networking Components

This package contains components that implement network sockets and protocols for implementing client and server network applications.

copyright:CopyRight (C) 2004-2012 by James Mills
license:MIT (See: LICENSE)
« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_app_config.html0000644000014400001440000004003012113366672023540 0ustar prologicusers circuits.app.config – Application Config — circuits 2.1.0 documentation

circuits.app.config – Application Config

Events

class circuits.app.config.Load(*args, **kwargs)

Bases: circuits.app.config.ConfigEvent

Load Config Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.app.config.Save(*args, **kwargs)

Bases: circuits.app.config.ConfigEvent

Save Config Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.

Components

class circuits.app.config.Config(filename, defaults=None, channel='config')

Bases: circuits.core.components.BaseComponent

Functions

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_constants.html0000644000014400001440000001707512113366676024325 0ustar prologicusers circuits.web.constants – Global Constants — circuits 2.1.0 documentation

circuits.web.constants – Global Constants

Global Constants

This module implements required shared global constants.

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_net_sockets.html0000644000014400001440000007232012113366676023767 0ustar prologicusers circuits.net.sockets – Socket Components — circuits 2.1.0 documentation

circuits.net.sockets – Socket Components

Events

class circuits.net.sockets.Connect(*args, **kwargs)

Bases: circuits.core.events.Event

Connect Event

This Event is sent when a new client connection has arrived on a server. This event is also used for client’s to initiate a new connection to a remote host.

Note

This event is used for both Client and Server Components.

Parameters:
  • args (tuple) – Client: (host, port) Server: (sock, host, port)
  • kwargs (dict) – Client: (ssl)
class circuits.net.sockets.Connected(host, port)

Bases: circuits.core.events.Event

Connected Event

This Event is sent when a client has successfully connected.

@note: This event is for Client Components.

Parameters:
  • host – The hostname connected to.
  • port – The port connected to
class circuits.net.sockets.Close(*args)

Bases: circuits.core.events.Event

Close Event

This Event is used to notify a client, client connection or server that we want to close.

@note: This event is never sent, it is used to close. @note: This event is used for both Client and Server Components.

Parameters:args – Client: () Server: (sock)
class circuits.net.sockets.Closed

Bases: circuits.core.events.Event

Closed Event

This Event is sent when a server has closed its listening socket.

@note: This event is for Server components.

class circuits.net.sockets.Read(*args)

Bases: circuits.core.events.Event

Read Event

This Event is sent when a client or server connection has read any data.

@note: This event is used for both Client and Server Components.

Parameters:args – Client: (data) Server: (sock, data)
class circuits.net.sockets.Write(*args)

Bases: circuits.core.events.Event

Write Event

This Event is used to notify a client, client connection or server that we have data to be written.

@note: This event is never sent, it is used to send data. @note: This event is used for both Client and Server Components.

Parameters:args – Client: (data) Server: (sock, data)
class circuits.net.sockets.SocketError(*args)

Bases: circuits.core.events.Event

SocketError Event

This Event is sent when a client or server connection has an error.

@note: This event is used for both Client and Server Components.

Parameters:args – Client: (error) Server: (sock, error)
class circuits.net.sockets.Disconnect(*args)

Bases: circuits.core.events.Event

Disconnect Event

This Event is sent when a client connection has closed on a server. This event is also used for client’s to disconnect from a remote host.

@note: This event is used for both Client and Server Components.

Parameters:args – Client: () Server: (sock)
class circuits.net.sockets.Disconnected

Bases: circuits.core.events.Event

Disconnected Event

This Event is sent when a client has disconnected

@note: This event is for Client Components.

Components

class circuits.net.sockets.Client(bind=None, bufsize=4096, channel='client')

Bases: circuits.core.components.BaseComponent

channel = 'client'
parse_bind_parameter(bind_parameter)
connected
close()
write(data)
class circuits.net.sockets.TCPClient(bind=None, bufsize=4096, channel='client')

Bases: circuits.net.sockets.Client

socket_family = 2
connect(host, port, secure=False, **kwargs)
circuits.net.sockets.UDPClient

alias of UDPServer

class circuits.net.sockets.UNIXClient(bind=None, bufsize=4096, channel='client')

Bases: circuits.net.sockets.Client

ready(component)
connect(path, secure=False, **kwargs)
class circuits.net.sockets.Server(bind, secure=False, backlog=5000, bufsize=4096, channel='server', **kwargs)

Bases: circuits.core.components.BaseComponent

channel = 'server'
parse_bind_parameter(bind_parameter)
connected
host
port
close(sock=None)
write(sock, data)
class circuits.net.sockets.TCPServer(bind, secure=False, backlog=5000, bufsize=4096, channel='server', **kwargs)

Bases: circuits.net.sockets.Server

socket_family = 2
parse_bind_parameter(bind_parameter)
class circuits.net.sockets.UDPServer(bind, secure=False, backlog=5000, bufsize=4096, channel='server', **kwargs)

Bases: circuits.net.sockets.Server

socket_family = 2
close()
write(address, data)
broadcast(data, port)
class circuits.net.sockets.UNIXServer(bind, secure=False, backlog=5000, bufsize=4096, channel='server', **kwargs)

Bases: circuits.net.sockets.Server

Functions

circuits.net.sockets.Pipe(*channels, **kwargs)

Create a new full duplex Pipe

Returns a pair of UNIXClient instances connected on either side of the pipe.

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_wrappers.html0000644000014400001440000003154112113366700024132 0ustar prologicusers circuits.web.wrappers – Request/Response Objects — circuits 2.1.0 documentation

circuits.web.wrappers – Request/Response Objects

Events

none

Classes

class circuits.web.wrappers.Body

Bases: object

Response Body

class circuits.web.wrappers.Host(ip, port, name=None)

Bases: object

An internet address.

name should be the client’s host name. If not available (because no DNS lookup is performed), the IP address should be used instead.

class circuits.web.wrappers.Request(sock, method, scheme, path, protocol, qs)

Bases: object

Creates a new Request object to hold information about a request.

Parameters:
  • sock (socket.socket) – The socket object of the request.
  • method (str) – The requsted method.
  • scheme (str) – The requsted scheme.
  • path (str) – The requsted path.
  • protocol (str) – The requsted protocol.
  • qs (str) – The query string of the request.

initializes x; see x.__class__.__doc__ for signature

server = None

@cvar: A reference to the underlying server

class circuits.web.wrappers.Response(request, encoding='utf-8', code=None, message=None)

Bases: object

Response(sock, request) -> new Response object

A Response object that holds the response to send back to the client. This ensure that the correct data is sent in the correct order.

initializes x; see x.__class__.__doc__ for signature

Components

none

Functions

circuits.web.wrappers.file_generator(input, chunkSize=4096)
« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_core_utils.html0000644000014400001440000002531112113366674023612 0ustar prologicusers circuits.core.utils – Utilities — circuits 2.1.0 documentation

circuits.core.utils – Utilities

Utils

This module defines utilities used by circuits.

Classes

none

Components

none

Events

none

Functions

circuits.core.utils.findchannel(root, channel, all=False)
circuits.core.utils.findcmp(root, component, all=False)
circuits.core.utils.findroot(component)
circuits.core.utils.findtype(root, component, all=False)
circuits.core.utils.flatten(root, visited=None)
circuits.core.utils.safeimport(name)
« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_tools.html0000644000014400001440000004241112113366700023425 0ustar prologicusers circuits.web.tools – Tools — circuits 2.1.0 documentation

circuits.web.tools – Tools

Tools

This module implements tools used throughout circuits.web. These tools can also be used within Controlelrs and request handlers.

Events

none

Components

none

Functions

circuits.web.tools.basic_auth(request, response, realm, users, encrypt=None)

Perform Basic Authentication

If auth fails, returns an Unauthorized error with a basic authentication header.

Parameters:
  • realm (str) – The authentication realm.
  • users (dict or callable) – A dict of the form: {username: password} or a callable returning a dict.
  • encrypt (callable) – Callable used to encrypt the password returned from the user-agent. if None it defaults to a md5 encryption.
circuits.web.tools.check_auth(request, response, realm, users, encrypt=None)

Check Authentication

If an authorization header contains credentials, return True, else False.

Parameters:
  • realm (str) – The authentication realm.
  • users (dict or callable) – A dict of the form: {username: password} or a callable returning a dict.
  • encrypt (callable) – Callable used to encrypt the password returned from the user-agent. if None it defaults to a md5 encryption.
circuits.web.tools.digest_auth(request, response, realm, users)

Perform Digest Authentication

If auth fails, raise 401 with a digest authentication header.

Parameters:
  • realm (str) – The authentication realm.
  • users (dict or callable) – A dict of the form: {username: password} or a callable returning a dict.
circuits.web.tools.expires(request, response, secs=0, force=False)

Tool for influencing cache mechanisms using the ‘Expires’ header.

‘secs’ must be either an int or a datetime.timedelta, and indicates the number of seconds between response.time and when the response should expire. The ‘Expires’ header will be set to (response.time + secs).

If ‘secs’ is zero, the ‘Expires’ header is set one year in the past, and the following “cache prevention” headers are also set: - ‘Pragma’: ‘no-cache’ - ‘Cache-Control’: ‘no-cache, must-revalidate’

If ‘force’ is False (the default), the following headers are checked: ‘Etag’, ‘Last-Modified’, ‘Age’, ‘Expires’. If any are already present, none of the above response headers are set.

circuits.web.tools.gzip(response, level=4, mime_types=['text/html', 'text/plain'])

Try to gzip the response body if Content-Type in mime_types.

response.headers[‘Content-Type’] must be set to one of the values in the mime_types arg before calling this function.

No compression is performed if any of the following hold:
  • The client sends no Accept-Encoding request header
  • No ‘gzip’ or ‘x-gzip’ is present in the Accept-Encoding header
  • No ‘gzip’ or ‘x-gzip’ with a qvalue > 0 is present
  • The ‘identity’ value is given with a qvalue > 0.
circuits.web.tools.serve_download(request, response, path, name=None)

Serve ‘path’ as an application/x-download attachment.

circuits.web.tools.serve_file(request, response, path, type=None, disposition=None, name=None)

Set status, headers, and body in order to serve the given file.

The Content-Type header will be set to the type arg, if provided. If not provided, the Content-Type will be guessed by the file extension of the ‘path’ argument.

If disposition is not None, the Content-Disposition header will be set to “<disposition>; filename=<name>”. If name is None, it will be set to the basename of path. If disposition is None, no Content-Disposition header will be written.

circuits.web.tools.validate_etags(request, response, autotags=False)

Validate the current ETag against If-Match, If-None-Match headers.

If autotags is True, an ETag response-header value will be provided from an MD5 hash of the response body (unless some other code has already provided an ETag header). If False (the default), the ETag will not be automatic.

WARNING: the autotags feature is not designed for URL’s which allow methods other than GET. For example, if a POST to the same URL returns no content, the automatic ETag will be incorrect, breaking a fundamental use for entity tags in a possibly destructive fashion. Likewise, if you raise 304 Not Modified, the response body will be empty, the ETag hash will be incorrect, and your application will break. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.24

circuits.web.tools.validate_since(request, response)

Validate the current Last-Modified against If-Modified-Since headers.

If no code has set the Last-Modified response header, then no validation will be performed.

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_dispatchers_xmlrpc.html0000644000014400001440000003222512113366677026202 0ustar prologicusers circuits.web.dispatchers.xmlrpc – XML-RPC — circuits 2.1.0 documentation

circuits.web.dispatchers.xmlrpc – XML-RPC

XML RPC

This module implements a XML RPC dispatcher that translates incoming RPC calls over XML into RPC events.

Events

class circuits.web.dispatchers.xmlrpc.RPC(*args, **kwargs)

Bases: circuits.core.events.Event

RPC Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.

Components

class circuits.web.dispatchers.xmlrpc.XMLRPC(path=None, encoding='utf-8', rpc_channel='*')

Bases: circuits.core.components.BaseComponent

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_io_file.html0000644000014400001440000002170212113366675023051 0ustar prologicusers circuits.io.file – File I/O — circuits 2.1.0 documentation

circuits.io.file – File I/O

Events

none

Components

class circuits.io.file.File(*args, **kwargs)

Bases: circuits.core.components.Component

initializes x; see x.__class__.__doc__ for signature

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_node.html0000644000014400001440000002022412113366676022367 0ustar prologicusers circuits.node – Node — circuits 2.1.0 documentation
« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_dispatchers_static.html0000644000014400001440000002316212113366677026164 0ustar prologicusers circuits.web.dispatchers.static – Static — circuits 2.1.0 documentation

circuits.web.dispatchers.static – Static

Static

This modStatic implements a Static dispatcher used to serve up static resources and an optional apache-style directory listing.

Events

none

Components

class circuits.web.dispatchers.static.Static(path=None, docroot=None, defaults=('index.html', 'index.xhtml'), dirlisting=False)

Bases: circuits.core.components.BaseComponent

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_main.html0000644000014400001440000001743712113366700023223 0ustar prologicusers circuits.web.main – circuits.web — circuits 2.1.0 documentation

circuits.web.main – circuits.web

Main

circutis.web Web Server and Testing Tool.

Shipped application with static and directory index support suitable for quickly serving up simple web pages.

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_headers.html0000644000014400001440000004250712113366700023706 0ustar prologicusers circuits.web.headers – Headers — circuits 2.1.0 documentation

circuits.web.headers – Headers

Headers Support

This module implements support for parsing and handling headers.

Events

none

Classes

class circuits.web.headers.Headers(headers=[])

Bases: dict

Manage a collection of HTTP response headers

has_key(name)

Return true if the message contains the header.

get_all(name)

Return a list of all the values for the named field.

These will be sorted in the order they appeared in the original header list or were added to this instance, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list. If no fields exist with the given name, returns an empty list.

get(name, default=None)

Get the first header value for ‘name’, or return ‘default’

keys()

Return a list of all the header field names.

These will be sorted in the order they appeared in the original header list, or were added to this instance, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list.

values()

Return a list of all header values.

These will be sorted in the order they appeared in the original header list, or were added to this instance, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list.

items()

Get all the header fields and values.

These will be sorted in the order they were in the original header list, or were added to this instance, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list.

setdefault(name, value)

Return first matching header value for ‘name’, or ‘value’

If there is no header named ‘name’, add a new header with name ‘name’ and value ‘value’.

add_header(_name, _value, **_params)

Extended header setting.

_name is the header field to add. keyword arguments can be used to set additional parameters for the header field, with underscores converted to dashes. Normally the parameter will be added as key=”value” unless value is None, in which case only the key will be added.

Example:

h.add_header(‘content-disposition’, ‘attachment’, filename=’bud.gif’)

Note that unlike the corresponding ‘email.Message’ method, this does not handle ‘(charset, language, value)’ tuples: all values must be strings or None.

elements(key)

Return a list of HeaderElements for the given header (or None).

class circuits.web.headers.HeaderElement(value, params=None)

Bases: object

An element (with parameters) from an HTTP header’s element list.

static parse(elementstr)

Transform ‘token;key=val’ to (‘token’, {‘key’: ‘val’}).

classmethod from_str(elementstr)

Construct an instance from a string of the form ‘token;key=val’.

class circuits.web.headers.AcceptElement(value, params=None)

Bases: circuits.web.headers.HeaderElement

An element (with parameters) from an Accept* header’s element list.

AcceptElement objects are comparable; the more-preferred object will be “less than” the less-preferred object. They are also therefore sortable; if you sort a list of AcceptElement objects, they will be listed in priority order; the most preferred value will be first. Yes, it should have been the other way around, but it’s too late to fix now.

qvalue

The qvalue, or priority, of this value.

Components

none

Functions

circuits.web.headers.header_elements(fieldname, fieldvalue)

Return a HeaderElement list from a comma-separated header str.

circuits.web.headers.parse_headers(data)
« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_exceptions.html0000644000014400001440000006170312113366677024470 0ustar prologicusers circuits.web.exceptions – Exceptions — circuits 2.1.0 documentation

circuits.web.exceptions – Exceptions

Exceptions

This module implements a set of standard HTTP Errors as Python Exceptions.

Note: This code is mostly borrowed from werkzeug and adapted for circuits.web

Exceptions

exception circuits.web.exceptions.HTTPException(description=None, traceback=None)

Bases: exceptions.Exception

Baseclass for all HTTP exceptions. This exception can be called by WSGI applications to render a default error page or you can catch the subclasses of it independently and render nicer error messages.

exception circuits.web.exceptions.BadGateway(description=None, traceback=None)

Bases: circuits.web.exceptions.HTTPException

502 Bad Gateway

If you do proxying in your application you should return this status code if you received an invalid response from the upstream server it accessed in attempting to fulfill the request.

exception circuits.web.exceptions.BadRequest(description=None, traceback=None)

Bases: circuits.web.exceptions.HTTPException

400 Bad Request

Raise if the browser sends something to the application the application or server cannot handle.

exception circuits.web.exceptions.Forbidden(description=None, traceback=None)

Bases: circuits.web.exceptions.HTTPException

403 Forbidden

Raise if the user doesn’t have the permission for the requested resource but was authenticated.

exception circuits.web.exceptions.Gone(description=None, traceback=None)

Bases: circuits.web.exceptions.HTTPException

410 Gone

Raise if a resource existed previously and went away without new location.

exception circuits.web.exceptions.InternalServerError(description=None, traceback=None)

Bases: circuits.web.exceptions.HTTPException

500 Internal Server Error

Raise if an internal server error occurred. This is a good fallback if an unknown error occurred in the dispatcher.

exception circuits.web.exceptions.LengthRequired(description=None, traceback=None)

Bases: circuits.web.exceptions.HTTPException

411 Length Required

Raise if the browser submitted data but no Content-Length header which is required for the kind of processing the server does.

exception circuits.web.exceptions.MethodNotAllowed(method, description=None)

Bases: circuits.web.exceptions.HTTPException

405 Method Not Allowed

Raise if the server used a method the resource does not handle. For example POST if the resource is view only. Especially useful for REST.

The first argument for this exception should be a list of allowed methods. Strictly speaking the response would be invalid if you don’t provide valid methods in the header which you can do with that list.

exception circuits.web.exceptions.NotAcceptable(description=None, traceback=None)

Bases: circuits.web.exceptions.HTTPException

406 Not Acceptable

Raise if the server can’t return any content conforming to the Accept headers of the client.

exception circuits.web.exceptions.NotFound(description=None, traceback=None)

Bases: circuits.web.exceptions.HTTPException

404 Not Found

Raise if a resource does not exist and never existed.

exception circuits.web.exceptions.NotImplemented(description=None, traceback=None)

Bases: circuits.web.exceptions.HTTPException

501 Not Implemented

Raise if the application does not support the action requested by the browser.

exception circuits.web.exceptions.PreconditionFailed(description=None, traceback=None)

Bases: circuits.web.exceptions.HTTPException

412 Precondition Failed

Status code used in combination with If-Match, If-None-Match, or If-Unmodified-Since.

exception circuits.web.exceptions.Redirect(urls, status=None)

Bases: circuits.web.exceptions.HTTPException

exception circuits.web.exceptions.RequestEntityTooLarge(description=None, traceback=None)

Bases: circuits.web.exceptions.HTTPException

413 Request Entity Too Large

The status code one should return if the data submitted exceeded a given limit.

exception circuits.web.exceptions.RequestTimeout(description=None, traceback=None)

Bases: circuits.web.exceptions.HTTPException

408 Request Timeout

Raise to signalize a timeout.

exception circuits.web.exceptions.RequestURITooLarge(description=None, traceback=None)

Bases: circuits.web.exceptions.HTTPException

414 Request URI Too Large

Like 413 but for too long URLs.

exception circuits.web.exceptions.ServiceUnavailable(description=None, traceback=None)

Bases: circuits.web.exceptions.HTTPException

503 Service Unavailable

Status code you should return if a service is temporarily unavailable.

exception circuits.web.exceptions.Unauthorized(description=None, traceback=None)

Bases: circuits.web.exceptions.HTTPException

401 Unauthorized

Raise if the user is not authorized. Also used if you want to use HTTP basic auth.

exception circuits.web.exceptions.UnicodeError(description=None, traceback=None)

Bases: circuits.web.exceptions.HTTPException

raised by the request functions if they were unable to decode the incoming data properly.

exception circuits.web.exceptions.UnsupportedMediaType(description=None, traceback=None)

Bases: circuits.web.exceptions.HTTPException

415 Unsupported Media Type

The status code returned if the server is unable to handle the media type the client transmitted.

Events

none

Components

none

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web.html0000644000014400001440000002740712113366676022231 0ustar prologicusers circuits.web – Web Framework — circuits 2.1.0 documentation
circuits-2.1.0/docs/build/html/api/circuits_web_loggers.html0000644000014400001440000002276112113366700023735 0ustar prologicusers circuits.web.loggers – Loggers — circuits 2.1.0 documentation

circuits.web.loggers – Loggers

Logger Component

This module implements Logger Components.

Events

none

Components

class circuits.web.loggers.Logger(file=None, logger=None, **kwargs)

Bases: circuits.core.components.BaseComponent

Functions

circuits.web.loggers.formattime()
« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_app_env.html0000644000014400001440000004056212113366673023076 0ustar prologicusers circuits.app.env – Application Environment — circuits 2.1.0 documentation

circuits.app.env – Application Environment

Events

class circuits.app.env.Create(*args, **kwargs)

Bases: circuits.app.env.EnvironmentEvent

Create Environment Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.app.env.Load(*args, **kwargs)

Bases: circuits.app.env.EnvironmentEvent

Load Environment Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.

Components

class circuits.app.env.Environment(path, envname, channel='env')

Bases: circuits.core.components.BaseComponent

Base Environment Component

Creates a new environment component that by default only holds configuration and logger components.

This component can be extended to provide more complex system and application environments.

Functions

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_app_daemon.html0000644000014400001440000004371012113366673023547 0ustar prologicusers circuits.app.daemon – Application Daemon — circuits 2.1.0 documentation

circuits.app.daemon – Application Daemon

Events

class circuits.app.daemon.Daemonize(*args, **kwargs)

Bases: circuits.core.events.Event

Daemonize Event

This event can be fired to notify the Daemon Component to begin the “daemonization” process. This event is (by default) used automatically by the Daemon Component in its “started” Event Handler (This behavior can be overridden).

Arguments: None

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.app.daemon.WritePID(*args, **kwargs)

Bases: circuits.core.events.Event

“WritePID Event

This event can be fired to notify the Daemon Component that is should retrive the current process’s id (pid) and write it out to the configured path in the Daemon Component. This event (by default) is used automatically by the Daemon Component after the Daemonize.

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.

Components

class circuits.app.daemon.Daemon(pidfile, path='/', stdin=None, stdout=None, stderr=None, channel='daemon')

Bases: circuits.core.components.BaseComponent

Daemon Component

Parameters:
  • pidfile (str or unicode) – .pid filename
  • stdin (str or unicode) – filename to log stdin
  • stdout (str or unicode) – filename to log stdout
  • stderr (str or unicode) – filename to log stderr

Functions

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_sessions.html0000644000014400001440000002252212113366700024134 0ustar prologicusers circuits.web.sessions – Sessions — circuits 2.1.0 documentation

circuits.web.sessions – Sessions

Session Components

This module implements Session Components that can be used to store and access persistent information.

Events

none

Components

class circuits.web.sessions.Sessions(name='circuits.session', *args, **kwargs)

Bases: circuits.core.components.Component

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_core_manager.html0000644000014400001440000005767212113366674024103 0ustar prologicusers circuits.core.manager – Manager — circuits 2.1.0 documentation

circuits.core.manager – Manager

This module defines the Manager class.

Classes

class circuits.core.manager.Manager(*args, **kwargs)

Bases: object

The manager class has two roles. As a base class for component implementation, it provides methods for event and handler management. The method fireEvent() appends a new event at the end of the event queue for later execution. waitEvent() suspends the execution of a handler until all handlers for a given event have been invoked. callEvent() combines the last two methods in a single method.

The methods addHandler() and removeHandler() allow handlers for events to be added and removed dynamically. (The more common way to register a handler is to use the handler() decorator or derive the class from Component.)

In its second role, the Manager takes the role of the event executor. Every component hierarchy has a root component that maintains a queue of events. Firing an event effectively means appending it to the event queue maintained by the root manager. The flush() method removes all pending events from the queue and, for each event, invokes all the handlers. Usually, flush() is indirectly invoked by run().

The manager optionally provides information about the execution of events as automatically generated events. If an Event has its success attribute set to True, the manager fires a Success event if all handlers have been executed without error. Note that this event will be enqueued (and dispatched) immediately after the events that have been fired by the event’s handlers. So the success event indicates both the successful invocation of all handlers for the event and the processing of the immediate follow-up events fired by those handlers.

Sometimes it is not sufficient to know that an event and its immediate follow-up events have been processed. Rather, it is important to know when all state changes triggered by an event, directly or indirectly, have been performed. This also includes the processing of events that have been fired when invoking the handlers for the follow-up events and the processing of events that have again been fired by those handlers and so on. The completion of the processing of an event and all its direct or indirect follow-up events may be indicated by a Complete event. This event is generated by the manager if Event has its complete attribute set to True.

Apart from the event queue, the root manager also maintains a list of tasks, actually Python generators, that are updated when the event queue has been flushed.

initializes x; see x.__class__.__doc__ for signature

name

Return the name of this Component/Manager

running

Return the running state of this Component/Manager

pid

Return the process id of this Component/Manager

fireEvent(event, *channels)

Fire an event into the system.

Parameters:
  • event – The event that is to be fired.
  • channels – The channels that this event is delivered on. If no channels are specified, the event is delivered to the channels found in the event’s channel attribute. If this attribute is not set, the event is delivered to the firing component’s channel. And eventually, when set neither, the event is delivered on all channels (“*”).
fire(event, *channels)

Fire an event into the system.

Parameters:
  • event – The event that is to be fired.
  • channels – The channels that this event is delivered on. If no channels are specified, the event is delivered to the channels found in the event’s channel attribute. If this attribute is not set, the event is delivered to the firing component’s channel. And eventually, when set neither, the event is delivered on all channels (“*”).
callEvent(event, *channels)

Fire the given event to the specified channels and suspend execution until it has been dispatched. This method may only be invoked as argument to a yield on the top execution level of a handler (e.g. “yield self.callEvent(event)”). It effectively creates and returns a generator that will be invoked by the main loop until the event has been dispatched (see circuits.core.handlers.handler()).

call(event, *channels)

Fire the given event to the specified channels and suspend execution until it has been dispatched. This method may only be invoked as argument to a yield on the top execution level of a handler (e.g. “yield self.callEvent(event)”). It effectively creates and returns a generator that will be invoked by the main loop until the event has been dispatched (see circuits.core.handlers.handler()).

flushEvents()

Flush all Events in the Event Queue. If called on a manager that is not the root of an object hierarchy, the invocation is delegated to the root manager.

flush()

Flush all Events in the Event Queue. If called on a manager that is not the root of an object hierarchy, the invocation is delegated to the root manager.

start(process=False, link=None)

Start a new thread or process that invokes this manager’s run() method. The invocation of this method returns immediately after the task or process has been started.

stop()

Stop this manager. Invoking this method causes an invocation of run() to return.

tick(timeout=-1)

Execute all possible actions once. Process all registered tasks and flush the event queue. If the application is running fire a GenerateEvents to get new events from sources.

This method is usually invoked from run(). It may also be used to build an application specific main loop.

Parameters:timeout (float, measuring seconds) – the maximum waiting time spent in this method. If negative, the method may block until at least one action has been taken.
run(socket=None)

Run this manager. The method fires the Started event and then continuously calls tick().

The method returns when the manager’s stop() method is invoked.

If invoked by a programs main thread, a signal handler for the INT and TERM signals is installed. This handler fires the corresponding Signal events and then calls stop() for the manager.

Components

none

Events

none

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_io_events.html0000644000014400001440000011327012113366675023440 0ustar prologicusers circuits.io.events – I/O Events — circuits 2.1.0 documentation

circuits.io.events – I/O Events

Events

class circuits.io.events.Close(*args, **kwargs)

Bases: circuits.core.events.Event

Close Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.io.events.Closed(*args, **kwargs)

Bases: circuits.core.events.Event

Closed Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.io.events.EOF(*args, **kwargs)

Bases: circuits.core.events.Event

EOF Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.io.events.Error(*args, **kwargs)

Bases: circuits.core.events.Event

Error Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.io.events.Opened(*args, **kwargs)

Bases: circuits.core.events.Event

Opened Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.io.events.Read(*args, **kwargs)

Bases: circuits.core.events.Event

Read Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.io.events.Seek(*args, **kwargs)

Bases: circuits.core.events.Event

Seek Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.io.events.Write(*args, **kwargs)

Bases: circuits.core.events.Event

Write Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.

Components

none

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_node_node.html0000644000014400001440000002164512113366676023404 0ustar prologicusers circuits.node.node – Node — circuits 2.1.0 documentation

circuits.node.node – Node

Node

...

Events

none

Components

class circuits.node.node.Node(bind=None, channel='node')

Bases: circuits.core.components.BaseComponent

Node

...

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_core_loader.html0000644000014400001440000002315112113366674023720 0ustar prologicusers circuits.core.loader – Loader — circuits 2.1.0 documentation

circuits.core.loader – Loader

This module implements a generic Loader suitable for dynamically loading components from other modules. This supports loading from local paths, eggs and zip archives. Both setuptools and distribute are fully supported.

Classes

none

Components

class circuits.core.loader.Loader(auto_register=True, init_args=None, init_kwargs=None, paths=None, channel='loader')

Bases: circuits.core.components.BaseComponent

Create a new Loader Component

Creates a new Loader Component that enables dynamic loading of components from modules either in local paths, eggs or zip archives.

initializes x; see x.__class__.__doc__ for signature

Events

none

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_net_protocols_line.html0000644000014400001440000003676312113366675025361 0ustar prologicusers circuits.net.protocols.line – Line Protocol — circuits 2.1.0 documentation

circuits.net.protocols.line – Line Protocol

Events

class circuits.net.protocols.line.Line(*args, **kwargs)

Bases: circuits.core.events.Event

Line Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.

Components

class circuits.net.protocols.line.LP(*args, **kwargs)

Bases: circuits.core.components.BaseComponent

Line Protocol

Implements the Line Protocol.

Incoming data is split into lines with a splitter function. For each line of data processed a Line Event is created. Any unfinished lines are appended into an internal buffer.

A custom line splitter function can be passed to customize how data is split into lines. This function must accept two arguments, the data to process and any left over data from a previous invocation of the splitter function. The function must also return a tiple of two items, a list of lines and any left over data.

Parameters:splitter (function) – a line splitter function

This Component operates in two modes. In normal operation it’s expected to be used in conjunction with components that expose a Read Event on a “read” channel with only one argument (data). Some builtin components that expose such events are: - circuits.net.sockets.TCPClient - circuits.io.File

The second mode of operation works with circuits.net.sockets.Server components such as TCPServer, UNIXServer, etc. It’s expected that two arguments exist in the Read Event, sock and data. The following two arguments can be passed to affect how unfinished data is stored and retrieved for such components:

Parameters:getBuffer (function) – function to retrieve the buffer for a client sock

This function must accept one argument (sock,) the client socket whoose buffer is to be retrieved.

Parameters:updateBuffer (function) – function to update the buffer for a client sock

This function must accept two arguments (sock, buffer,) the client socket and the left over buffer to be updated.

@note: This Component must be used in conjunction with a Component that
exposes Read events on a “read” Channel.

initializes x; see x.__class__.__doc__ for signature

Functions

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_app_log.html0000644000014400001440000003043212113366673023062 0ustar prologicusers circuits.app.log – Application Logging — circuits 2.1.0 documentation

circuits.app.log – Application Logging

Events

class circuits.app.log.Log(*args, **kwargs)

Bases: circuits.core.events.Event

Log Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.

Components

class circuits.app.log.Logger(filename, name, type, level, channel='logger')

Bases: circuits.core.components.BaseComponent

Functions

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_http.html0000644000014400001440000003764112113366700023255 0ustar prologicusers circuits.web.http – HTTP Protocol — circuits 2.1.0 documentation

circuits.web.http – HTTP Protocol

Hyper Text Transfer Protocol

This module implements the server side Hyper Text Transfer Protocol or commonly known as HTTP.

Components

class circuits.web.http.HTTP(encoding='utf-8', channel='web')

Bases: circuits.core.components.BaseComponent

HTTP Protocol Component

Implements the HTTP server protocol and parses and processes incoming HTTP messages, creating and sending an appropriate response.

The component handles Read events on its channel and collects the associated data until a complete HTTP request has been received. It parses the request’s content and puts it in a Request object and creates a corresponding Response object. Then it emits a Request event with these objects as arguments.

The component defines several handlers that send a response back to the client.

_on_response(response)

Response Event Handler

Parameters:response (Response) – the Response object created when the HTTP request was initially received.

This handler builds an HTTP response data stream from the information contained in the response object and sends it to the client (firing Write events).

_on_read(sock, data)

Read Event Handler

Process any incoming data appending it to an internal buffer. Split the buffer by the standard HTTP delimiter CRLF and create Raw Event per line. Any unfinished lines of text, leave in the buffer.

_on_httperror(event, request, response, code, **kwargs)

Default HTTP Error Handler

Default Error Handler that by default just fires a Response event with the response as argument. The response is normally modified by a HTTPError instance or a subclass thereof.

_on_request_success(e, value)

Handler for the RequestSuccess event that is automatically generated after all handlers for a Request event have been invoked successfully.

Parameters:
  • e – the successfully handled Request event (having as attributes the associated Request and Response objects).
  • value – the value(s) returned by the invoked handler(s).

This handler converts the value(s) returned by the (successfully invoked) handlers for the initial Request event to a body and assigns it to the Response object’s body attribute. It then fires a Response event with the Response object as argument.

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_node_utils.html0000644000014400001440000002312212113366676023607 0ustar prologicusers circuits.node.utils – Node Utilities — circuits 2.1.0 documentation

circuits.node.utils – Node Utilities

Utils

...

Events

none

Components

none

Functions

circuits.node.utils.dump_event(e, id)
circuits.node.utils.dump_value(v)
circuits.node.utils.load_event(s)
circuits.node.utils.load_value(v)
« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_core_components.html0000644000014400001440000004563512113366673024651 0ustar prologicusers circuits.core.components – Components — circuits 2.1.0 documentation

circuits.core.components – Components

This module defines the BaseComponent and its subclass Component.

Classes

class circuits.core.components.BaseComponent(*args, **kwargs)

Bases: circuits.core.manager.Manager

This is the base class for all components in a circuits based application. Components can (and should, except for root components) be registered with a parent component.

BaseComponents can declare methods as event handlers using the handler decoration (see circuits.core.handlers.handler()). The handlers are invoked for matching events from the component’s channel (specified as the component’s channel attribute).

BaseComponents inherit from circuits.core.manager.Manager. This provides components with the circuits.core.manager.Manager.fireEvent() method that can be used to fire events as the result of some computation.

Apart from the fireEvent() method, the Manager nature is important for root components that are started or run.

Variables:channel – a component can be associated with a specific channel by setting this attribute. This should either be done by specifying a class attribute channel in the derived class or by passing a keyword parameter channel=”...” to __init__. If specified, the component’s handlers receive events on the specified channel only, and events fired by the component will be sent on the specified channel (this behavior may be overridden, see Event, fireEvent() and handler()). By default, the channel attribute is set to “*”, meaning that events are fired on all channels and received from all channels.

initializes x; see x.__class__.__doc__ for signature

register(parent)

Inserts this component in the component tree as a child of the given parent node.

Parameters:parent (Manager) – the parent component after registration has completed.

This method fires a Registered event to inform other components in the tree about the new member.

unregister()

Removes this component from the component tree.

Removing a component from the component tree is a two stage process. First, the component is marked as to be removed, which prevents it from receiving further events, and a PrepareUnregister event is fired. This allows other components to e.g. release references to the component to be removed before it is actually removed from the component tree.

After the processing of the PrepareUnregister event has completed, the component is removed from the tree and an Unregistered event is fired.

classmethod handlers()

Returns a list of all event handlers for this Component

classmethod handles(*names)

Returns True if all names are event handlers of this Component

class circuits.core.components.Component(*args, **kwargs)

Bases: circuits.core.components.BaseComponent

If you use Component instead of BaseComponent as base class for your own component class, then all methods that are not marked as private (i.e: start with an underscore) are automatically decorated as handlers.

The methods are invoked for all events from the component’s channel where the event’s name matches the method’s name.

Components

none

Events

class circuits.core.components.PrepareUnregister(*args, **kwargs)

Bases: circuits.core.events.Event

This event is fired when a component is about to be unregistered from the component tree. Unregistering a component actually detaches the complete subtree that the unregistered component is the root of. Components that need to know if they are removed from the main tree (e.g. because they maintain relationships to other components in the tree) handle this event, check if the component being unregistered is one of their ancestors and act accordingly.

Parameters:component – the component that will be unregistered
in_subtree(component)

Convenience method that checks if the given component is in the subtree that is about to be detached.

class circuits.core.components.SingletonError

Bases: exceptions.Exception

Raised if a Component with the singleton class attribute is True.

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_controllers.html0000644000014400001440000002462312113366676024654 0ustar prologicusers circuits.web.controllers – Controllers — circuits 2.1.0 documentation

circuits.web.controllers – Controllers

Controllers

This module implements ...

Events

none

Components

class circuits.web.controllers.Controller(*args, **kwargs)

Bases: circuits.web.controllers.BaseController

initializes x; see x.__class__.__doc__ for signature

class circuits.web.controllers.JSONController(*args, **kwargs)

Bases: circuits.web.controllers.BaseController

initializes x; see x.__class__.__doc__ for signature

Functions

circuits.web.controllers.expose(*channels, **config)
circuits.web.controllers.exposeJSON(*channels, **config)
« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_core_events.html0000644000014400001440000006063112113366673023761 0ustar prologicusers circuits.core.events – Events — circuits 2.1.0 documentation

circuits.core.events – Events

This module defines the basic Event class and common events.

Classes

class circuits.core.events.Event(*args, **kwargs)

Bases: circuits.core.events.BaseEvent

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.

Components

none

Events

class circuits.core.events.Error(type, value, traceback, handler=None)

Bases: circuits.core.events.Event

Error Event

This Event is sent for any exceptions that occur during the execution of an Event Handler that is not SystemExit or KeyboardInterrupt.

Parameters:
  • type (type) – type of exception
  • value (exceptions.TypeError) – exception object
  • traceback (traceback) – traceback of exception
  • kwargs (dict) – (Optional) Additional Information
class circuits.core.events.Failure(*args, **kwargs)

Bases: circuits.core.events.DerivedEvent

Failure Event

This Event is sent when an error has occurred with the execution of an Event Handlers.

Parameters:event (Event) – The event that failed
class circuits.core.events.Registered(component, manager)

Bases: circuits.core.events.Event

Registered Event

This Event is sent when a Component has registered with another Component or Manager. This Event is only sent iif the Component or Manager being registered with is not itself.

Parameters:
  • component (Component) – The Component being registered
  • manager (Component or Manager) – The Component or Manager being registered with
class circuits.core.events.Signal(signal, stack)

Bases: circuits.core.events.Event

Signal Event

This Event is sent when a Component receives a signal.

Parameters:
  • signal – The signal number received.
  • stack – The interrupted stack frame.
class circuits.core.events.Started(component)

Bases: circuits.core.events.Event

Started Event

This Event is sent when a Component has started running.

Parameters:component (Component or Manager) – The component that was started
class circuits.core.events.Stopped(component)

Bases: circuits.core.events.Event

Stopped Event

This Event is sent when a Component has stopped running.

Parameters:component (Component or Manager) – The component that has stopped
class circuits.core.events.Success(*args, **kwargs)

Bases: circuits.core.events.DerivedEvent

Success Event

This Event is sent when all handlers (for a particular event) have been executed successfully, see Manager.

Parameters:event (Event) – The event that has completed.
class circuits.core.events.Unregister(component=None)

Bases: circuits.core.events.Event

Unregister Event

This Event ask for a Component to unregister from its Component or Manager.

class circuits.core.events.Unregistered(component, manager)

Bases: circuits.core.events.Event

Unregistered Event

This Event is sent when a Component has been unregistered from its Component or Manager.

class circuits.core.events.GenerateEvents(lock, max_wait)

Bases: circuits.core.events.Event

Generate events event

This event is sent by the circuits core. All components that generate timed events or events from external sources (e.g. data becoming available) should fire any pending events in their “generate_events” handler. The handler must either be a filter (preventing other handler from being called in the same iteration) or must invoke reduce_time_left() with parameter 0.

Parameters:max_wait – maximum time available for generating events.

Components that actually consume time waiting for events to be generated, thus suspending normal execution, must provide a method resume that interrupts waiting for events.

time_left

The time left for generating events. A value less than 0 indicates unlimited time. You should have only one component in your system (usually a poller component) that spends up to “time left” until it generates an event.

reduce_time_left(time_left)

Update the time left for generating events. This is typically used by event generators that currently don’t want to generate an event but know that they will within a certain time. By reducing the time left, they make sure that they are reinvoked when the time for generating the event has come (at the latest).

This method can only be used to reduce the time left. If the parameter is larger than the current value of time left, it is ignored.

If the time left is reduced to 0 and the event is currently being handled, the handler’s resume method is invoked.

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_errors.html0000644000014400001440000003076212113366677023624 0ustar prologicusers circuits.web.errors – Errors — circuits 2.1.0 documentation

circuits.web.errors – Errors

Errors

This module implements a set of standard HTTP Errors.

Components

none

Events

class circuits.web.errors.HTTPError(request, response, code=None, **kwargs)

Bases: circuits.core.events.Event

An event for signaling an HTTP error

The constructor creates a new instance and modifies the response argument to reflect the error.

class circuits.web.errors.Forbidden(request, response, code=None, **kwargs)

Bases: circuits.web.errors.HTTPError

An event for signaling the HTTP Forbidden error

The constructor creates a new instance and modifies the response argument to reflect the error.

class circuits.web.errors.NotFound(request, response, code=None, **kwargs)

Bases: circuits.web.errors.HTTPError

An event for signaling the HTTP Not Fouond error

The constructor creates a new instance and modifies the response argument to reflect the error.

class circuits.web.errors.Redirect(request, response, urls, code=None)

Bases: circuits.web.errors.HTTPError

An event for signaling the HTTP Redirect response

The constructor creates a new instance and modifies the response argument to reflect a redirect response to the given url.

class circuits.web.errors.Unauthorized(request, response, code=None, **kwargs)

Bases: circuits.web.errors.HTTPError

An event for signaling the HTTP Unauthorized error

The constructor creates a new instance and modifies the response argument to reflect the error.

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_wsgi.html0000644000014400001440000002467412113366700023251 0ustar prologicusers circuits.web.wsgi – WSGI Support — circuits 2.1.0 documentation

circuits.web.wsgi – WSGI Support

WSGI Components

This module implements WSGI Components.

Events

none

Components

class circuits.web.wsgi.Application(*args, **kwargs)

Bases: circuits.core.components.BaseComponent

initializes x; see x.__class__.__doc__ for signature

class circuits.web.wsgi.Gateway(*args, **kwargs)

Bases: circuits.core.components.BaseComponent

initializes x; see x.__class__.__doc__ for signature

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_io.html0000644000014400001440000002016112113366674022047 0ustar prologicusers circuits.io – I/O Support — circuits 2.1.0 documentation

circuits.io – I/O Support

I/O Support

This package contains various I/O Components. Provided are a a generic File Component, StdIn, StdOut and StdErr components. Instances of StdIn, StdOUt and StdErr are also created by importing this package.

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_servers.html0000644000014400001440000002746612113366700023773 0ustar prologicusers circuits.web.servers – Servers — circuits 2.1.0 documentation

circuits.web.servers – Servers

Web Servers

This module implements the several Web Server components.

Events

none

Components

class circuits.web.servers.BaseServer(bind, encoding='utf-8', secure=False, certfile=None, channel='web')

Bases: circuits.core.components.BaseComponent

Create a Base Web Server

Create a Base Web Server (HTTP) bound to the IP Address / Port or UNIX Socket specified by the ‘bind’ parameter.

Variables:server – Reference to underlying Server Component
Parameters:bind (Instance of int, list, tuple or str) – IP Address / Port or UNIX Socket to bind to.

The ‘bind’ parameter is quite flexible with what valid values it accepts.

If an int is passed, a TCPServer will be created. The Server will be bound to the Port given by the ‘bind’ argument and the bound interface will default (normally to “0.0.0.0”).

If a list or tuple is passed, a TCPServer will be created. The Server will be bound to the Port given by the 2nd item in the ‘bind’ argument and the bound interface will be the 1st item.

If a str is passed and it contains the ‘:’ character, this is assumed to be a request to bind to an IP Address / Port. A TCpServer will thus be created and the IP Address and Port will be determined by splitting the string given by the ‘bind’ argument.

Otherwise if a str is passed and it does not contain the ‘:’ character, a file path is assumed and a UNIXServer is created and bound to the file given by the ‘bind’ argument.

class circuits.web.servers.Server(bind, **kwargs)

Bases: circuits.web.servers.BaseServer

Create a Web Server

Create a Web Server (HTTP) complete with the default Dispatcher to parse requests and posted form data dispatching to appropriate Controller(s).

See: circuits.web.servers.BaseServer

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_node_client.html0000644000014400001440000002157512113366676023737 0ustar prologicusers circuits.node.client – Client — circuits 2.1.0 documentation

circuits.node.client – Client

Client

...

Events

none

Components

class circuits.node.client.Client(host, port, channel='node')

Bases: circuits.core.components.BaseComponent

Client

...

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_node_events.html0000644000014400001440000003113712113366676023760 0ustar prologicusers circuits.node.events – Events — circuits 2.1.0 documentation

circuits.node.events – Events

Events

...

Events

class circuits.node.events.Packet(*args, **kwargs)

Bases: circuits.core.events.Event

Packet Event

An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.

Variables:
  • channels –

    an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

    When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

  • value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
  • success – if this optional attribute is set to True, an associated event EventSuccess (original name with “Success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
  • success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
  • complete – if this optional attribute is set to True, an associated event EventComplete (original name with “Complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
  • success_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
class circuits.node.events.Remote(event, node, channel=None)

Bases: circuits.core.events.Event

Remote Event

...

Components

none

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/api/circuits_web_dispatchers_dispatcher.html0000644000014400001440000002253612113366676027026 0ustar prologicusers circuits.web.dispatchers.dispatcher – Default Dispatcher — circuits 2.1.0 documentation

circuits.web.dispatchers.dispatcher – Default Dispatcher

Events

none

Components

class circuits.web.dispatchers.dispatcher.Dispatcher(**kwargs)

Bases: circuits.core.components.BaseComponent

Functions

none

« previous | up | next »
circuits-2.1.0/docs/build/html/dev/0000755000014400001440000000000012113366740016644 5ustar prologicuserscircuits-2.1.0/docs/build/html/dev/processes.html0000644000014400001440000002403012113366702021535 0ustar prologicusers Development Processes — circuits 2.1.0 documentation

Development Processes

We document all our internal development processes here so you know exactly how we work and what to expect. If you find any issues or problems please let us know!

Software Development Life Cycle (SDLC)

We employ the use of the SCRUM Agile Process and use Pivotal Tracker to track our stories, bugs, chores and releases. If you wish to contribute to circuits, please famiilarize yourself with SCRUM and Pivotal Tracker.

Bug Reports

Feature Requests

Writing new Code

  • Write your code.

  • Use flake8 to ensure code quality.

  • Run the tests:

    $ tox

  • Ensure any new or modified code does not break existing unit tests.

  • Updated any relevant docstrings or documentatino.

Running the Tests

To run the tests you will need the following installed:

All of these can be instaleld via easy_isntall or pip.

Please also ensure that you you have all supported versions of Python that circuits supports installed in your local environment.

To run the tests:

$ tox
« previous | up | next »
circuits-2.1.0/docs/build/html/dev/index.html0000644000014400001440000002046012113366701020640 0ustar prologicusers Developer Docs — circuits 2.1.0 documentation

Developer Docs

So, you’d like to contribute to circuits in some way? Got a bug report? Having problems running the examples? Having problems getting circuits working in your environment/platform?

Excellent. Here’s what you need to know.

« previous | up | next »
circuits-2.1.0/docs/build/html/dev/introduction.html0000644000014400001440000001701312113366701022252 0ustar prologicusers Development Introduction — circuits 2.1.0 documentation

Development Introduction

Here’s how we do things in circuits...

Standards

We use the following coding standard:

Tools

We use the following tools to develop circuits and share code:

« previous | up | next »
circuits-2.1.0/docs/build/html/dev/contributing.html0000644000014400001440000002204212113366701022236 0ustar prologicusers Contributing to circuits — circuits 2.1.0 documentation

Contributing to circuits

Here’s how you can contribute to circuits

Share your story

One of the best ways you can contribute to circuits is by using circuits. Share with us your story of how you’ve used circuits to solve a problem or create a new software solution using the circuits framework and library of components. See our Users Page.

Submitting Bug Reports

We welcome all bug reports. We do however prefer bug reports in a clear and concise form with repeatable steps. One of the best ways you can report a bug to us is by writing a unit test (//similar to the ones in our tests//) so that we can verify the bug, fix it and commit the fix along with the test.

To submit a bug report, please use:
http://bitbucket.org/prologic/circuits/issues

Writing new tests

We’re not perfect, and we’re still writing more tests to ensure quality code. If you’d like to help, please Fork circuits-dev, write more tests that cover more of our code base and submit a Pull Request. Many Thanks!

Adding New Features

If you’d like to see a new feature added to circutis, then we’d like to hear about it~ We would like to see some discussion around any new features as well as valid use-cases. To start the discussions off, please either:

« previous | up | next »
circuits-2.1.0/docs/build/html/man/0000755000014400001440000000000012113366740016641 5ustar prologicuserscircuits-2.1.0/docs/build/html/man/tools.html0000644000014400001440000001346312113366702020674 0ustar prologicusers Tools — circuits 2.1.0 documentation

Tools

« previous | up | next »
circuits-2.1.0/docs/build/html/man/events.html0000644000014400001440000004124712113366702021041 0ustar prologicusers Events — circuits 2.1.0 documentation

Events

Basic usage

Events are objects that are fired by the circuits framework implicitly (like the Started event used in the tutorial) or explicitly by components while handling some other event. Once fired, events are dispatched to the components that are interested in these events, i.e. that have registered themselves as handlers for these events.

Events are usually fired on one or more channels, allowing components to gather in “interest groups”. This is especially useful if you want to reuse basic components such as a TCP server. A TCP server component fires a Read event for every package of data that it receives. If we hadn’t the channels, it would be very difficult to separate the data from two different TCP connections. But using the channels, we can put one TCP server and all components interested in its events on one channel, and another TCP server and the components interested in this other TCP server’s events on another channel. Components are associated with a channel by setting their channel attribute (see API description for Component).

Besides having a name, events carry additional arbitrary information. This information is passed as arguments or keyword arguments to the constructor. It is then delivered to the handler function that must have exactly the same number of arguments and keyword arguments. Of course, as is usual in Python, you can also pass additional information by setting attributes of the event object, though this usage pattern is discouraged for events.

Events as result collectors

Apart from delivering information to handlers, event objects may also collect information. If a handler returns something that is not None, it is stored in the event’s value attribute. If a second (or any subsequent) handler invocation also returns a value, the values are stored as a list. Note that the value attribute is of type Value and you must access its property value to access the data stored (collected_information = event.value.value).

The collected information can be accessed by handlers in order to find out about any return values from the previously invoked handlers. More useful though, is the possibility to access the information after all handlers have been invoked. After all handlers have run successfully (i.e. no handler has thrown an error) circuits may generate an event that indicates the successful handling. This event has the name of the event just handled with “Success” appended. So if the event is called Identify then the success event is called IdentifySuccess. Success events aren’t delivered by default. If you want successful handling to be indicated for an event, you have to set the optional attribute success of this event to True.

The handler for a success event must be defined with two arguments. When invoked, the first argument is the event just having been handled successfully and the second argument is (as a convenience) what has been collected in event.value.value (note that the first argument may not be called event, for an explanation of this restriction as well as for an explanation why the method is called identify_success see the section on handlers).

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
#!/usr/bin/env python

from circuits import Component, Event
from circuits.core.debugger import Debugger

class Identify(Event):
    """Identify Event"""
    success = True

class Pound(Component):

    def __init__(self):
        super(Pound, self).__init__()

        Debugger().register(self)
        Bob().register(self)
        Fred().register(self)

    def started(self, *args):
        self.fire(Identify())
        
    def identify_success(self, evt, result):
        if not isinstance(result, list):
            result = [result]
        print "In pound:"
        for name in result:
            print name

class Dog(Component):

    def identify(self):
        return self.__class__.__name__

class Bob(Dog):
    """Bob"""

class Fred(Dog):
    """Fred"""

Pound().run()

Download handler_returns.py

Advanced usage

Sometimes it may be necessary to take some action when all state changes triggered by an event are in effect. In this case it is not sufficient to wait for the completion of all handlers for this particular event. Rather, we also have to wait until all events that have been fired by those handlers have been processed (and again wait for the events fired by those events’ handlers, and so on). To support this scenario, circuits can fire a Complete event. The usage is similar to the previously described success event. Details can be found in the API description of circuits.core.events.Event.

« previous | up | next »
circuits-2.1.0/docs/build/html/man/index.html0000644000014400001440000001545212113366702020643 0ustar prologicusers The circuits Framework — circuits 2.1.0 documentation
« previous | up | next »
circuits-2.1.0/docs/build/html/man/components.html0000644000014400001440000002211212113366702021710 0ustar prologicusers Components — circuits 2.1.0 documentation

Components

The architectural concept of circuits is to encapsulate system functionality into discrete manageable and reusable units, called Components, that interact by sending and handling events that flow throughout the system.

Technically, a circuits Component is a Python class that inherits (directly or indirectly) from BaseComponent.

Components can be sub-classed like any other normal Python class, however components can also be composed of other components and it is natural to do so. These are called Complex Components. An example of a Complex Component within the circuits library is the circuits.web.servers.Server Component which is comprised of:

Note that there is no class or other technical means to mark a component as a complex component. Rather, all component instances in a circuits based application belong to some component tree (there may be several), with Complex Components being a subtree within that structure.

A Component is attached to the tree by registering with the parent and detached by un-registering itself (methods register() and unregister() of BaseComponent).

« previous | up | next »
circuits-2.1.0/docs/build/html/man/values.html0000644000014400001440000001350212113366702021025 0ustar prologicusers Values — circuits 2.1.0 documentation

Values

« previous | up | next »
circuits-2.1.0/docs/build/html/man/debugging.html0000644000014400001440000001344712113366702021471 0ustar prologicusers Debugging — circuits 2.1.0 documentation

Debugging

« previous | up | next »
circuits-2.1.0/docs/build/html/man/handlers.html0000644000014400001440000003316712113366702021337 0ustar prologicusers Handlers — circuits 2.1.0 documentation

Handlers

Explicit Event Handlers

Event Handlers are methods of components that are invoked when a matching event is dispatched. These can be declared explicitly on a BaseComponent or Component or by using the handler() decorator.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
#!/usr/bin/env python

from circuits.core.debugger import Debugger
from circuits.core.components import BaseComponent
from circuits.core.handlers import handler

class MyComponent(BaseComponent):

    def __init__(self):
        super(MyComponent, self).__init__()

        Debugger().register(self)

    @handler("started", channel="*")
    def _on_started(self, component):
        print "Start event detected"

MyComponent().run()

Download handler_annotation.py

The handler decorator on line 14 turned the method _on_started into an event handler for the event Started. Event names used to define handlers are the uncameled class names of the event. An event with a class name MySpecialEvent becomes “my_special_event” when referred to in a handler definition.

When defining explicit event handlers in this way, it’s convention to use the following pattern:

@handler("foo")
def _on_foo(self, ...):
   ...

This makes reading code clear and concise and obvious to the reader that the method is not part of the class’s public API (leading underscore as per Python convention) and that it is invoked for events of type SomeEvent.

The optional keyword argument “channel” can be used to attach the handler to a different channel than the component’s channel (as specified by the component’s channel attribute).

Handler methods must be declared with arguments and keyword arguments that match the arguments passed to the event upon its creation. Looking at the API for Started you’ll find that the component that has been started is passed as an argument to its constructor. Therefore, our handler method must declare one argument (Line 15).

The @handler(...) decorator accepts other keyword arguments that influence the behavior of the event handler and its invocation. Details can be found in the API description of handler().

Implicit Event Handlers

To make things easier for the developer when creating many event handlers and thus save on some typing, the Component can be used and subclassed instead which provides an implicit mechanism for creating event handlers.

Basically every method in the component is automatically and implicitly marked as an event handler with @handler(<name)) where <name>> is the name of each method applied.

The only exceptions are:

  • Methods are start with an underscore _.
  • Methods already marked explicitly with the @handler(...) decorator.

Note

You can specify that a method not be an event handler by marking it with @handler(False).

« previous | up | next »
circuits-2.1.0/docs/build/html/man/manager.html0000644000014400001440000001360112113366702021140 0ustar prologicusers Manager — circuits 2.1.0 documentation

Manager

« previous | up | next »
circuits-2.1.0/docs/build/html/web/0000755000014400001440000000000012113366740016643 5ustar prologicuserscircuits-2.1.0/docs/build/html/web/gettingstarted.html0000644000014400001440000002245512113366703022570 0ustar prologicusers Getting Started — circuits 2.1.0 documentation

Getting Started

Just like any application or system built with circuits, a circuits.web application follows the standard Component based design and structure whereby functionality is encapsulated in components. circuits.web itself is designed and built in this fashion. For example a circuits.web Server’s structure looks like this:

../_images/web.png

To illustrate the basic steps, we will demonstrate developing your classical “Hello World!” applications in a web-based way with circuits.web

To get started, we first import the necessary components:

from circutis.web import Server, Controller

Next we define our first Controller with a single Request Handler defined as our index. We simply return “Hello World!” as the response for our Request Handler.

class Root(Controller):

   def index(self):
      return "Hello World!"

This completes our simple web application which will respond with “Hello World!” when anyone accesses it.

Admittedly this is a stupidly simple web application! But circuits.web is very powerful and plays nice with other tools.

Now we need to run the application:

(Server(8000) + Root()).run()

That’s it! Navigate to: http://127.0.0.1:8000/ and see the result.

Here’s the complete code:

1
2
3
4
5
6
7
8
from circuits.web import Server, Controller

class Root(Controller):

   def index(self):
      return "Hello World!"

(Server(8000) + Root()).run()

Have fun!

« previous | up | next »
circuits-2.1.0/docs/build/html/web/index.html0000644000014400001440000001425012113366703020641 0ustar prologicusers The circuits.web Framework — circuits 2.1.0 documentation

The circuits.web Framework

« previous | up | next »
circuits-2.1.0/docs/build/html/web/basics.html0000644000014400001440000002615412113366703021004 0ustar prologicusers The Basics — circuits 2.1.0 documentation

The Basics

circuits.web is not a full stack web framework, rather it is more closely aligned with CherryPy and offers enough functionality to make quickly developing web applications easy and as flexible as possible. circuits.web does not provide features such as:

  • builtin Templating
  • builtin Database or ORM tools
  • etc

The functionality that circutis.web does provide ensures that circuits.web is fully HTTP/1.1 and WSGI/1.0 compliant and offers all the essential tools you need to build your web application or website.

A Stand Alone Server

A stand alone server consist of the components shown in section Getting Started. The process of handling an HTTP request starts with the TCPServer receiving a chunk of bytes. It emits those bytes as a Read event on the channel shared by the Server, HTTP, TCPServer and Dispatcher components (“web” by default).

The Read events are handled by the HTTP component. It collects the chunks until a complete HTTP request has been received. The request is then emitted as a Request event with an instance of classes Request and Response each as arguments. To complete the client’s request, a Response event must be fired. This is usually done by the HTTP component itself upon the receipt of a RequestSuccess event (automatically generated after all handlers for the Request event have been invoked successfully). In case of a problem, the Request event’s handlers should fire or return a HTTPError which is instead converted by the HTTP component to a Response event.

HTTP’s handler for the Response event retrieves the response information from the event and encodes it as required by HTTP (the protocol). It then fires one or more Write events which are handled by the TCPServer (and the response is thus sent to the client). More details can be found in circuits.web.http – HTTP Protocol.

A commonly used component for handling Request events is a dispatcher. [To be continued]

« previous | up | next »
circuits-2.1.0/docs/build/html/web/introduction.html0000644000014400001440000003010112113366703022244 0ustar prologicusers Introduction — circuits 2.1.0 documentation

Introduction

circuits.web is a set of components for building high performance HTTP/1.1 and WSGI/1.0 compliant web applications. These components make it easy to rapidly develop rich, scalable web applications with minimal effort.

circuits.web borrows from

  • CherryPy
  • BaseHTTPServer (Python std. lib)
  • wsgiref (Python std. lib)

Overview

The circuits.web namespace contains the following exported components and events for convenience:

Events

Event Description
Request The Request Event
Response The Response Event
Stream The Stream Event

Servers

Server Description
BaseServer The Base Server (no Dispatcher)
Server The full Server + Dispatcher

Error Events

Error Description
HTTPError A generic HTTP Error Event
Forbidden A Forbidden (403) Event
NotFound A Not Found (404) Event
Redirect A Redirect (30x) Event

Dispatchers

Dispatcher Description
Static A Static File Dispatcher
Dispatcher The Default Dispatcher
VirtualHosts Virtual Hosts Dispatcher
XMLRPC XML-RPC Dispatcher
JSONRPC JSON-RPC Dispatcher

Other Components

Component Description
Logger Default Logger
Controller Request Handler Mapper
Sessions Default Sessions Handler

To start working with circuits.web one normally only needs to import from circuits.web, for example:

1
2
3
4
5
6
7
8
9
from circuits import Component
from circuits.web import BaseServer

class Root(Component):

    def request(self, request, response):
        return "Hello World!"

(BaseServer(8000) + Root()).run()

For further information regarding any of circuits.web’s components, events or other modules and functions refer to the API Documentation.

« previous | up | next »
circuits-2.1.0/docs/build/html/pypitest.html0000644000014400001440000003167312113366702020645 0ustar prologicusers PyPi Test Page - Tentative Release — circuits 2.1.0 documentation

PyPi Test Page - Tentative Release

Overview

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.

To take full advantage of circuits and its architecture, circuits encourages you to design your application in terms of loosely coupled components. Circuits has a very powerful message passing system that enables components to interact with each other via events. Applications written this way tend to be more maintainable, easier to develop and scale to complex systems.

circuits’ Loosely Coupled Component Architecture allows for a high level of Reuse and Scalability. Simpler components can be combined together to form Complex Components and provide higher level functionality and abstraction. Much of the circuits component library is designed and built this way.

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

Supported Platforms

  • Linux, FreeBSD, Mac OS X
  • Python 2.6, 2.7, 3.2, 3.3
  • pypy 2.0
Windows: We acknowledge that Windows exists and make reasonable efforts
to maintain compatibility. Unfortunately we cannot guarantee support at this time.

NB: We are working toward getting Windows supported.

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 Page or the Downloads page on the Website; extract it and install using:

> python setup.py install

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 is also a small community of circuits enthusiasts that you may find on the #circuits IRC Channel on the FreeNode IRC Network and the Mailing List.

Release Notes - circuits-2.1.0 (<release>)

This release adds the following new features to circuits:

  • Python 3 support.
  • Windows support.
  • PyPy support.
  • IPv6 support.
  • Better WSGI support.
  • Fully documented examples.
  • Component Interface querying.

And many bug fixes!

« previous | up | next »
circuits-2.1.0/docs/build/html/contributors.html0000644000014400001440000001455212113366701021515 0ustar prologicusers Contributors — circuits 2.1.0 documentation

Contributors

circuits was originally designed, written and primarily maintained by James Mills (http://prologic.shortcircuit.net.au/).

The following users and developers have contributed to circuits:

  • Alessio Deiana
  • Dariusz Suchojad
  • Tim Miller
  • Holger Krekel
  • Justin Giorgi
  • Edwin Marshall
  • Alex Mayfield
  • Toni Alatalo
  • Michael Lipp

Anyone not listed here (apologies as this list is taken directly from Mercurial’s churn command and output). We appreciate any and all contributions to circuits.

« previous | up | next »
circuits-2.1.0/docs/build/html/start/0000755000014400001440000000000012113366740017223 5ustar prologicuserscircuits-2.1.0/docs/build/html/start/quick.html0000644000014400001440000001563512113366703021236 0ustar prologicusers Quick Start Guide — circuits 2.1.0 documentation

Quick Start Guide

The easiest way to download and install circuits is to use the pip command:

$ pip install circuits

Now that you have successfully downloaded and installed circuits, let’s test that circuits is properly installed and working.

First, let’s check the installed version:

>>> import circuits
>>> print circuits.__version__
2.1.0

Try some of the examples in the examples/ directory shipped with the distribution or check out some Applications using circuits

Have fun :)

« previous | up | next »
circuits-2.1.0/docs/build/html/start/downloading.html0000644000014400001440000001647712113366703022434 0ustar prologicusers Downloading — circuits 2.1.0 documentation

Downloading

Latest Stable Release

The latest stable releases can be downloaded from the Downloads page (specifically the Tags tab).

Latest Development Source Code

We use Mercurial for source control and code sharing.

The latest development branch can be cloned using the following command:

$ hg clone https://bitbucket.org/prologic/circuits/

For further instructions on how to use Mercurial, please refer to the Mercurial Book.

« previous | up | next »
circuits-2.1.0/docs/build/html/start/index.html0000644000014400001440000001604112113366703021221 0ustar prologicusers Getting Started — circuits 2.1.0 documentation
circuits-2.1.0/docs/build/html/start/installing.html0000644000014400001440000001775612113366703022274 0ustar prologicusers Installing — circuits 2.1.0 documentation

Installing

Installing from a Source Package

If you have downloaded a source archive, this applies to you.

$ python setup.py install

For other installation options see:

$ python setup.py --help install

Installing from the Development Repository

If you have cloned the source code repository, this applies to you.

If you have cloned the development repository, it is recommended that you use setuptools and use the following command:

$ python setup.py develop

This will allow you to regularly update your copy of the circuits development repository by simply performing the following in the circuits working directory:

$ hg pull -u

Note

You do not need to reinstall if you have installed with setuptools via the circuits repository and used setuptools to install in “develop” mode.

« previous | up | next »
circuits-2.1.0/docs/build/html/start/requirements.html0000644000014400001440000002001112113366703022625 0ustar prologicusers Requirements and Dependencies — circuits 2.1.0 documentation

Requirements and Dependencies

Supported Platforms:
 Linux, FreeBSD, Mac OS X, Windows
Supported Python Versions:
 2.6, 2.7, 3.2, 3.3
Supported pypy Versions:
 2.0

Other Optional Dependencies

These dependencies are not strictly required and only add additional features.

« previous | up | next »
circuits-2.1.0/docs/build/html/faq.html0000644000014400001440000002024112113366702017520 0ustar prologicusers Frequently Asked Questions — circuits 2.1.0 documentation

Frequently Asked Questions

General

... What is circuits?
circuits is an event-driven framework with a high focus on Component architectures making your life as a software developer much easier. circuits allows you to write maintainable and scalable systems easily
... Can I write networking applications with circuits?
Yes absolutely. circuits comes with socket I/O components for tcp, udp and unix sockets with asynchronous polling implementations for select, poll, epoll and kqueue.
... Can I integrate circuits with a GUI library?
This is entirely possible. You will have to hook into the GUI’s main loop.
... What are the core concepts in circuits?
Components and Events. Components are maintainable reusable units of behavior that communicate with other components via a powerful message passing system.
... How would you compare circuits to Twisted?
Others have said that circuits is very elegant in terms of it’s usage. circuits’ component architecture allows you to define clear interfaces between components while maintaining a high level of scalability and maintainability.
... Can Components communicate with other processes?
Yes. circuits implements currently component bridging and nodes
... What platforms does circuits support?
circuits currently supports Linux, FreeBSD, OSX and Windows and is currently continually tested against Linux and Windows against Python versions 2.6, 2.7, 3.1 and 3.2
... Can circuits be used for concurrent or distributed programming?
Yes. We also have plans to build more distributed components into circuits making distributing computing with circuits very trivial.

Got more questions?

« previous | up | next »
circuits-2.1.0/docs/build/html/_downloads/0000755000014400001440000000000012113366740020217 5ustar prologicuserscircuits-2.1.0/docs/build/html/_downloads/handler_annotation.py0000644000014400001440000000066212072034467024446 0ustar prologicusers#!/usr/bin/env python from circuits.core.debugger import Debugger from circuits.core.components import BaseComponent from circuits.core.handlers import handler class MyComponent(BaseComponent): def __init__(self): super(MyComponent, self).__init__() Debugger().register(self) @handler("started", channel="*") def _on_started(self, component): print "Start event detected" MyComponent().run() circuits-2.1.0/docs/build/html/_downloads/handler_returns.py0000644000014400001440000000142012072034467023767 0ustar prologicusers#!/usr/bin/env python from circuits import Component, Event from circuits.core.debugger import Debugger class Identify(Event): """Identify Event""" success = True class Pound(Component): def __init__(self): super(Pound, self).__init__() Debugger().register(self) Bob().register(self) Fred().register(self) def started(self, *args): self.fire(Identify()) def identify_success(self, evt, result): if not isinstance(result, list): result = [result] print "In pound:" for name in result: print name class Dog(Component): def identify(self): return self.__class__.__name__ class Bob(Dog): """Bob""" class Fred(Dog): """Fred""" Pound().run() circuits-2.1.0/docs/build/html/_downloads/simple_server.py0000644000014400001440000000115312072034467023452 0ustar prologicusers#!/usr/bin/env python from circuits import Component from circuits.net.sockets import TCPServer, Write class Server(Component): def __init__(self, host, port=8000): super(Server, self).__init__() self._clients = [] TCPServer((host, port)).register(self) def connect(self, sock, host, port): self._clients.append(sock) def disconnect(self, sock): self._clients.remove(sock) def read(self, sock, data): for client in self._clients: if not client == sock: self.fire(Write(client, data.strip())) Server("localhost").run() circuits-2.1.0/docs/build/html/_downloads/001.py0000644000014400001440000000011112072034467021064 0ustar prologicusers#!/usr/bin/env python from circuits import Component Component().run() circuits-2.1.0/docs/build/html/_downloads/002.py0000644000014400001440000000020112072034467021065 0ustar prologicusers#!/usr/bin/env python from circuits import Component class MyComponent(Component): """My Component""" MyComponent().run() circuits-2.1.0/docs/build/html/_downloads/003.py0000644000014400001440000000024712072034467021100 0ustar prologicusers#!/usr/bin/env python from circuits import Component class MyComponent(Component): def started(self, *args): print("Hello World!") MyComponent().run() circuits-2.1.0/docs/build/html/_downloads/004.py0000644000014400001440000000037412072034467021102 0ustar prologicusers#!/usr/bin/env python from circuits import Component class Bob(Component): def started(self, *args): print("Hello I'm Bob!") class Fred(Component): def started(self, *args): print("Hello I'm Fred!") (Bob() + Fred()).run() circuits-2.1.0/docs/build/html/_downloads/005.py0000644000014400001440000000077612072034467021111 0ustar prologicusers#!/usr/bin/env python from circuits import Component from circuits.tools import graph class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) def started(self, *args): print(graph(self.root)) class Bob(Component): def started(self, *args): print("Hello I'm Bob!") class Fred(Component): def started(self, *args): print("Hello I'm Fred!") Pound().run() circuits-2.1.0/docs/build/html/_downloads/006.py0000644000014400001440000000076512072034467021110 0ustar prologicusers#!/usr/bin/env python from circuits import Component, Event class Woof(Event): """Woof Event""" class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) def started(self, *args): self.fire(Woof()) class Dog(Component): def woof(self): print("Woof! I'm %s!" % self.name) class Bob(Dog): """Bob""" class Fred(Dog): """Fred""" Pound().run() circuits-2.1.0/docs/build/html/_downloads/007.py0000644000014400001440000000105212072034467021077 0ustar prologicusers#!/usr/bin/env python from circuits import Component, Event class Woof(Event): """Woof Event""" class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) def started(self, *args): self.fire(Woof(), self.bob) class Dog(Component): def woof(self): print("Woof! I'm %s!" % self.name) class Bob(Dog): """Bob""" channel = "bob" class Fred(Dog): """Fred""" channel = "fred" Pound().run() circuits-2.1.0/docs/build/html/_downloads/008.py0000644000014400001440000000103312072034467021077 0ustar prologicusers#!/usr/bin/env python from circuits import Component, Event class Bark(Event): """Bark Event""" class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) class Dog(Component): def started(self, *args): self.fire(Bark()) def bark(self): print("Woof! I'm %s!" % self.name) class Bob(Dog): """Bob""" channel = "bob" class Fred(Dog): """Fred""" channel = "fred" Pound().run() circuits-2.1.0/docs/build/html/_downloads/009.py0000644000014400001440000000102612072034467021102 0ustar prologicusers#!/usr/bin/env python from circuits import Component, Event class Bark(Event): """Bark Event""" class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) class Dog(Component): def started(self, *args): self.fire(Bark()) def bark(self): print("Woof! I'm %s!" % name) class Bob(Dog): """Bob""" channel = "bob" class Fred(Dog): """Fred""" channel = "fred" Pound().run() circuits-2.1.0/docs/build/html/.buildinfo0000644000014400001440000000024612113366704020044 0ustar prologicusers# Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. config: tags: circuits-2.1.0/docs/build/html/index.html0000644000014400001440000003016212113366702020063 0ustar prologicusers circuits 2.1.0 Documentation — circuits 2.1.0 documentation

circuits 2.1.0 Documentation

Release:2.1.0
Date:February 27, 2013

Overview

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.

To take full advantage of circuits and its architecture, circuits encourages you to design your application in terms of loosely coupled components. Circuits has a very powerful message passing system that enables components to interact with each other via events. Applications written this way tend to be more maintainable, easier to develop and scale to complex systems.

circuits’ Loosely Coupled Component Architecture allows for a high level of Reuse and Scalability. Simpler components can be combined together to form Complex Components and provide higher level functionality and abstraction. Much of the circuits component library is designed and built this way.

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

Supported Platforms

  • Linux, FreeBSD, Mac OS X
  • Python 2.6, 2.7, 3.2, 3.3
  • pypy 2.0
Windows: We acknowledge that Windows exists and make reasonable efforts
to maintain compatibility. Unfortunately we cannot guarantee support at this time.

NB: We are working toward getting Windows supported.

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 Page or the Downloads page on the Website; extract it and install using:

> python setup.py install

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.

up | next »
circuits-2.1.0/docs/build/html/_images/0000755000014400001440000000000012113366740017472 5ustar prologicuserscircuits-2.1.0/docs/build/html/_images/web.png0000644000014400001440000010364012072034467020763 0ustar prologicusersPNG  IHDRņbKGD IDATxwXT6{IW(t(DEKQO1%Qk99Q_$Xc1j""HQ#" RTPfX3#]=󻮹vyfc1B!9B!F#!BiB!Y \ zA   ]ee%jkk Ѐ0hjjա(**JBި`$DBEEE())Aii)JJJ |>"***PUU&TUU]]]6W^04418M!xt4!ANN>}B ??EEE(**G^^ɂKSUU***Ԅ"tttuuuAYY'|eee5ZZZכq%IeII PQQ!UVWW7(n_}󥖭CCC011 ,,,`aaKKFBCs@BBv؁SN [nùE!Bٳի1c >>r ]%K`޽Rnܸ6m" Tx{{ʕ+o!//C Aaa!&M[[[$''ܹsXj曷Z~{t͛}}}\p\G"aȐ̖/_΄B!qc3yyy`H$bϟg$΍7;0H{Z?`nݒ>--%&&c[Xp!BCCo߾xMMMc4O>Xx1/^ … qe޽WC(bӦMM.ƊEӧc۶mv{aҥRiu7 q >|>\k-Ngiilذ/^eM"k,i"LMMu6{%p---7n QVVd\v ]ut]‡  HJJK:bݍyրÆ C\\]۷^\044رc%8 5qXZZb„ */{GѣG 8ujkkq%i:Chh(Ν;-C!2&Y"3sHlҥŅiii1yyy<<V\;wrBڄa$2E[[111сk#+Ē%K0{l|رcב!ͨ`$27o̙`s6~:pl޼JPHd [DEEڵk4h{rb6lTL2Xƨ`$2- 1c>S]zgx9VZ[[[DEE᧟~B[^H͛7۷//_9s4{K=B:CFFكXnBBBu4BiT0.'##qQx<̙3˖-FzHg~@tt4l2|:!+*IUVVbϞ=HOOcccn*11aaa8~8|81estq)))8~8C!88s΅5!QHZDEE8}4*++c"00nnn DZTQQDFF… B߾}iӦɉ누ҩ`$VMM .]#** 000#0fR!)) •+WP__///bرpvv:&!p Fc<~ĥKP^^cccxzzbذa򂫫+J:Xqq1q5!11հD`` mmmBLHB)))v횤h˃*ggg8;;ޞ.҅HNNFrr2nݺCNN񁷷7annu\BIT0rrrpU#99)))PTT ''' 0!eHuu5222;wH Ĝ9xxx@SSԄ5PHHcxTTJJ !tYT0F|>At*,,,`ii ȞϟyyyǏ,dggӧD^z8TBigT0N둓ldgg#++ 999x1Z055.`ooBOOсyW.PRR"y(**B~~> >ϟK>077%$-,,`ee^zquҳ(pBNNlt|}}=󑟟<{ /_FDD! QTTB6 mmmIMMMBEEPTTopmauuuhL{IIdjԀ磮eee +**BOO055JKKQYY+V 00ƒBBlN"''޽{wިիq̜9?CK4;@ 'O  QVV@*z.& Q^^ _cǓ`Ǐ O?fO>A||< _Xңѧ!c޼y>}:OD:. \]]q-̚5 3gĜ9sE!=&\zgFuu5~G;\GΝ; @EEưaøD!= 0ҎB!>3T,q!55QWWu,B1v#̘1w]d IZ  ѣGѯ_?#BHG=GX !!!HJJH$+~g#BHG#!oÜ9s0|$$$`\lmm%K>@pppS$h4!o(113gDii)BCC1~x#Hј;w.q:!B:0F1|򂅅RRRXP@@RSS |g \"nz i̝;ꫯ.-C݋?8rD!}JϟpU|'T,ʘ? 9u$Bӎ|G?~<ƌ[naȐ!\"M8p 0|̝;gϦ;B[]҄4#==3fÇ{n̙3H "##CMM G'ב!KFBO? HJJb DJJ 0|p|D\". FB^SZZӧcXl^}r!###ouV!;;Xҥ.iB^q5̚5 B@@בH;JMM̙3ݻ3f:!t HH-[DJJ ݐ#1{l̚5 s̡b!xyyy={6cX;w ,*9ooo#B̢Fң>}NNN(((@||#Xcƌ'OE! FmTUUaɒ%2e M7oXPTTW_}+W ;;8rױ!SPH4 2ǏGDD555cnoٳ1w\L:ϟ?:!t(*I?www!99'O:wŋHHH=Μ9u,B0T0.ŋ4iV\O?077:AF4wŢEE!.MdN}}=.ٳgC^^Ga:)!߰d"44ً}***B0rJDEE5:N(bÆ 9r$<< {zjRBțF"SN8S|>455%?~3g"%%| ,YULBuA\&&&8|0 1Ǐ:t(Q !UȌLxPTT?Oɸ07nܠbȴy!-- _|:ڵ .\(((`٨8-!zL!C:Cdd$O??7|C}.1ݻwc͚5033Cff&D';Q IDAT"dVXoÔ2*L ? P(&''###,XC aBB\BBQ[[+U0/Q:Bi&;v/U,/ϖ~9X$]c 7nP(lP,/{g͚ 2"+`$JOO… s]]BCCڵkJ!͢]ҤpuuQWW9-i i_=©Sm0'x<\|\$)T0v!%%%^E$@Fkn4yɫ444UUU@II mچ*<  Ѐ/F#F޾|||PQQ>2TVVJڈ:TTTX 555(++Kh*++CCCCVCCCZZZ֖.n;}}}p98T0Ree%<;;YYYx $Eaaa!>}*URŌ~Ŏ69RT^^2ɇϥpyaaaB011 ajj sssXZZzh IWW^^<~(((ӧOQXX(i+CCF==F mmϤJJJ|1՟ 011!333FFFm!!1"33ْ0''x䉤WVV%z CCC۔C555(,,D^^~?ğ>}|`T!iee.< PFKׇCN *털X/=UQQ,,,$Eѯ_?pUp%%%@zz:222 ##Cr‡:,--aaa!)^illL'[t#}C\ ,wEѯ_?Ɔveu>jѷo_/t$d`D{._.yܿ`ii ggg888 NNNC8QSSwJCUUnnn<<<лwo#w 1ddd !!AHIIP(X\ 8% ʒvÇD'WWW"CdgP( (//%o&OO&/Cx7n )) uuu033СC1bƆ]H$­[8ܸqPWW1tPxxx\%U*++\~ x)OOO9~~~mh;!S ŋx"bccQ^^b[[[9$]^uu5n߾x\~'={KKK5 9r$Wt ::()) &i!//uTBMnnxvn޼ :tt \uuuADD"### 5j)))x׬...0a0h cvZ~Cdd$rssahh(9r$,--IH|yw444w}Izv/kkkqE8qOFYY{aԨQt`BXȸ8DFFɓx1  ёQQQ8q~w|x{{cĉ5j} sΡ~~~2e {=sV0&&&b޽8y$ム L'OBPRR;PTTT ((K.ڤG޽{,Zvćt>|'Oϟ:t7*|>vڅ{SLҥK jjj={H[AAA26??[nŁӧOҥKm0B"Oؿ?rrrkϏh;am w}/YAAA[!0ooocteǎƆ)((0/:q9s&cCe'ב(--eׯǧ}wXHmH$bgϞe#Gd/:&Z]0>}0FH=TTTYm@YF67{Q^^.5.\옲2SUUelͬ] sssc֭c_||r,=$%%Ç\Gb"HERWWܹUUUqKJsg=ى'ĉ1STTdӓm۶x())1+++b/fLII)))1 6~xsNV__),}6[n;v,366nz6AV|}}cgϞ=:Z%]YY˗#44f֭[ann= ,TUU!77(((#~߿555.\z-Z+WSU֭[ǃ"|}}\t pvvF\\[_wř3gPTTZVGիݻwcΜ9ܹsq5ڵkIlܸM65qFcڴiD޽1j( y&tuuQ\\,Zܼy055ERR ???TTT`̘1233%쬫B&hƍشi1`6nI maG ǪU 1cptUUݝӧOwJ67G@lx<sttdto'06ƍb }Woǧ]^PSS1֬Y=RĄ۳۷owCK{'Ndm3nݺܪenݺ`֭c1Y\\\iE";|aLKKc1MYm ;Rii)5kgC&?KKK0`Ho~竫c[la ]M77ndlXjڲ2qF6tP%[|y2^2СCSRRb b~i ܹsY^ 6lKHHh:~8eZZZLEE9;;itZ٤In h_x1cƼvEaaaLEEY֙ʴ;Ё3lΜ9.C\شR=1Ƙ*suumsxOFGG7{l_'NMۇڄbmvY˳( j&9Νcjjj,==4.{f}iq>fff֠A#/Zt?` 7ȵsNRÛ%QFI5F{AիWK ߾};6m$ H"HAwZѬMiGO]]O^G?7َ: vb{fkײA5jk/,,,I-S> a۽{7KJJbM.ߓ/IIIR3226o޼[w[iTjִo]ի]sO#FZӸ5|ܼU;`Rß={噯o˨`جY7W=x<ѣVehP1lĉa&L`jX򕔔XYYYY^石&Xii)_!x,&&SRRjpVlGW.300`u3MMM믿v::Ks텊J[L333Iuѣfjj*"WYY}&''')`TTTr{2>>/6mbXddd-ޤ`lM/l{WPVV:e>W[[X,[Q=JPP<WWW̜9Çի0}}}iiiR###(..F}}d\~~~3&&&VVVRw)-- KHH&v` BKKKjXcg:lӦMJJJ9c1y!Ǝ yyyCMMMjnGW???DEE>uǣδlFnnZQQ}%KgP|8wnܸD矈šC)y{ +++aǎ #GLۙjMkm{]---xzz… 4iqHWzYXXԵZ K}\6mD"Q$=z`:::,88}'ވr4%//z_k8{j666LGG>dfffLMMɋXvtF^凅199D{nG1ܹS2=ߓbk׮eؕ+Wc/{ȮZ.ۃilm{&UL:M< {400&=zԖKx1Zu2lڴ ľ}`ll/~m]NiiԷ쯾 HKKï;v`ƍۼ=:::xEk\\\^#..UjlEUUU=z<{ O;|;Go߾|kkkYN=¡C.] 3f;&S<#AKZ&mÇѿc.AGrCw+LR6uY9" 777dff";;wnTSStXXX4'`(((@DD\[-ۇW͛7m۶fnqj14h! 333x{{KM' bme}ݻw!ip 7ݮ۶mÞ={Yf8_`[icD"|R>sD"L>]2Rǚ5k͡ _xb0[kXxqz勥7X>c | |>L"5.++ 1n8Y ??V}`)۷cΝ N1qD(**‰'i R7nK0d\vMrM6aƍDPPjkkggg rرk֬?aĄ #22Rjnsjlܺum6ƍ!ʐk׮={vߔ7b=z4,--!T899!..---C6z҅yۼu;V~!p֭%-6m4#66SZ}ր}ƍqzϟzN'''wwwBOOeee|2ܹ\zU#ޓ>   !;!Ǝ+v7i^ɶ2@iӦ!)) III2}S";qLQQC/ўҒM4>|kNoF سgd)zlHHH9sPVV3gãS_SSOCIIS3BZvY,Z8{,츎DϨ?ׯGTT/P[[!x9^% IDAT.] ///XYY!99ӋE;ݻwoŠApر.;Ço>TTTtdFBzL^صk"##smpF+Wqܾ}FFF7=!!4s;{tWlkƦñcǠ9s`ҥ0`@{g$D8wك(#$$/ZtU|8y$ttt0|ښht+8rۇ 2K,ٳbҮ޸`+))o>҂*sPUU___aƌ:"ڭ`|U]]._p:u /^1j(ɱMUNzgϞ!&&шD^^Sv:jkk'O~Cqq1#G***\$S1!::111P(ȑ#1yd{:&A:`|P(Dll,.\/"55>|tpp ioՈCtt4 UUU 6 0almm qh@II @@@\\\ //uTB:Ǐ#yww|TU_2d&uM鴐PB * PPuEE]׵+ ,@BI!$gR&;͐IHB;IO&3w}s{9Μ9f¼y\ o=aUee%EVV233@[[LMMȵj <LTUUb1Xq2.T*aN=;;[[[$RS7xzzٙ}ϣ\UUPTT~AAA Epp0~ 3mR"΢[RAhvnnnpuuk JKK!QXXTP(;4h___HR6r""h eff";;hkkp;Ȧ4ƚPVV Qs+,,Daa!ܼ^3wskO0ƈK{% P^^ny{{{8::NNNpvv3[[[ƆDMMMAuu5*** Q^^rr/++*yf+a...˻`hꈢ"spttGGGSS?ذAP(zB.R(//Gee%JJJ C*B*rwwwF?vQVV% \"+QQQX%lll`gg$:9annݬ`ee5BPhllBB@]]P]]*Uk}bKy'irtt3#U}}=W/99z8vN";#`ii sssrM]P(Ԅp2zB:ajj34899daz%VQYY3.ihh:)Dj&fH$000`jj  @/,,,t\g+hSSSV;tDFT*477CTBTmmm\2Y;ַM;uttdst2zOTZIO؈nש$- ˀ&~6119uY{{; Zh* n( 䰩 uuuݾoM=׹ŋe˖!44T+wttdfqD:<<5lCC:::ʸ---]*rh[uժysNJ,C$qP(Қjaatnaeuttti]kllD]]Wg#4IXKK Z[[ֆ.~hhh@ss3LMMZ-;xzdZrxfff\= HyѴv7qF$&&b͚5x܇Oa` (sN\Rg0wށ\.}i&`ӦMx aF)aѲsNw}>YnX|9222i&ۡVaF02 Ì׮]Crr2VXw(J,c¼yvZ?'O;41X0 3JpwwɓeP8;;?GJJ %K ''fc #0(@D)zqAc|Ň~hpaFaQ`Ν Ahh(ߡ )###[X~=^{5aϞ=|0 KaF6ڵk v sss p"66W\;4X0 3ǣ˗/;IRܹΝCkk+Ə+WFaf۹s'LC8w~'$&&" jAdю% 0#Xcc#?OGwK.Ezz:' KaF={@Raҥ|#;;/&>|0ߡ1` #0? ..666|)))pssÜ9s0w\\vw,adr9?>^طoN8 alofTc #0O? ,;aiڴix" ٳM͌j,ad~,Y"P-CCC<&ſo1̐a #0/D3wNNfΜ|8<ߡ1̐` #0ccƌ|2oŋ!+V% 0#JŽ;zjj~03'N$ॗ^B]]ߡ1̠`5 0s!rYPFŋ#==߰}v>J;4P,adaoߎ)SLJPFccclذXz56n܈0673afq~w<|2H$lݺǜ9sd102 Ì ;w ^Cd2vލxdff"((/ k,adA<033;QoΜ9HII;v̰FaҥKHKKc]􈑑֭[ץɓ'a% 0#_ DGG s72 KaF:X~=ߡ0=dؿ?<72 KaF_UV qqq#3afSϰfH$azIWƈֿK,ad~w';472z% 0֭[@Ca<72z% 0ٳgqilڴP_~ Zwh(Faa_ٳg={!** SL12fڿq?~<ƀ QVVף"\p˖-㖫Ƙ1cuVBe `L:O=~',\t5<󈏏ŋC&3q`ngӦM60 s'lllP[[  PTđ2KGDDDPXjOQ1 W]1p,011!*Fh7^~/cII mXp!xNX8J^K?FZ+KK. mۆbvۿqܲJfBII _2KGu7[$N '''"b̴# B{xGyg7>f_̚5 ^3227 R<ގsa͚5`cnQdѢE s8E0Jx뭷wH0Rv;͚f~ /F F|ܹzlCCT:hhh222 ɰ{.IX,H$1`eeSSSK1 3Zz(J477CP{VMMM:Osy  ٳcccH$^M͌^| rsso{AZ[6mBV444J]lkkCSSS[[[ko``[XX033%smڝFKK P^^ TUUUUU hhh@KKB3X!aaa[[[Ύkoo[[[NNN=2RT\.Gee%jkkQWWZjvp 5HĕSX DkkkX[[okk 899Ɔ5BnKO cʕގJ\.Gqq1ni hhhRDccc[hIX 333666:ﻸ C>a CNN544䒲[3ng`nnKKKG/H```J6m(Mi[ZZ K2[YYjB/ ?Q3*++QXX" (//Gee%*++^#M45 H$\K)7Gvfbb5EN/ٱcǠP(0e_^kkkΉv644hmpqq# gggxxx:ce[KK .^t"%%iii\- AD]6СC>}:@.#77yyyGyy9JKKQVVƕ-:0[[[XYYuiDʓ!b]Ύi΢uR91U(P*Gss3[wLD"\\\WWW8;;񁷷mg #"#%%FVVrrrPUUf 777A*pww3jjjU܌IP^^J\dzK2Zk׮!++ ׯ_GFF ###xzzj%6T*V@g(**B~~>knpE~~~뮻0_ڸt.qÖB-y...6#//yyy\+lnn.rrr ###d2 ((3f̰ٷr9ŋhiiD"Axx8BCCP#v .Tdׯ_G[[HDGGcl0(QZZdv偈 H%&>>>h~Cff&222A[[D"  ,"Bff&D@TAAAZLpp0{D@nn.ҴlT*a„ 0a888v,aA}}==Gȑ#ͅ(DGGÃPGvܹsHHHsPXXP &`֬Y3g&L##6S*HJJٳgƍ044L&Cxx8tٙT*dggk%wI&aҤI]ww#ZFJJ ?'N̙3Ǝ%';QI«Iⓒpujx{{cԩŌ3w,aLV#118|0!3g"&&j MkC밲Œ30k,̛7R0^P(̙3tJ%H3F0VK.qgnaoo(`ԩ7nܨYYY8|0??pwwGll,L & ((}z.]… pI9s 1k,^& Zٳg?cϞ=())A@@0k,L6JJJpa>|GEMM &LKbٲe;Dx?jaaaI WWWCeZիWq$$$(,, f͚8̞=[/ZZZƅ w^ݻpttDll,\d2d@{{;℄ttt`ԩ{p!k +W}v/;v,.]Kח;сSNo\qaŊXjըG/---8xs` IDAT vލ#G^^^3g0c ztQPPx:t'N@}}=BBB0w\{ｈ;!GD8}4~۷ =܃{&L`QFf:t*;/C=4J ~'|HJJBpp0VZKQJLttt̙3矱sN477cɒ%x1uTV"RÇ㧟~¾}ڊӧF\\k`DRܹs޽{q5xyyaw;v;({Xh|||AGGΞ=~ ?r9O5k`ɒ%}Fzgʊb1=CtbXss3ر W_}EJFK.ѣ>J͘1K;4fIMM͛7/WQee%ߡ ZM;͚5 Ņ^z%~:ߡ1zFRсhٲedbbBVVVn:m脱z)DF}UWW#ccc?%w{$J~)rCcFK.s=G666dbbB=]p; !?>8pT*ߡ1@uu5 LFl2JJJȄ6nH$J>VbPQQ_LLL͍vwHJcc#%{{{ wX(L| 7i|kj; BZj3LuttЮ]hfΜIW\F\¸grss#[[[jZII =cdhhHgϦCkJ>Srrr" zשsyZx1ФIԩS|ԣD$###z'رckݺutƍ>c$uuud200zhDcaΙ3g($$b1}'|O^^^$hƍxf\pf̘Ah޼yTPPwHZhڵdhhHӦM˗/3Bjھ};9;;}zH333ߟѣ| smmm׿Yug? cZjՈn@&M;cҤIˣGRPPYYYю;xE#++֖~GR|4"{$ȈЖ-[W3ϐ= ѣ$HhҤItu $Ji͚57dq TAQQQüfhhxÇ5EEED&{{{ڽ{7P~~>=M;ޡNT=p-Z|||H$P($z)77Wk#}W|nv˴!)) _|ߏ˗/.ڷo;hCiyBu]w@ZhBBBdرc=+CrrrrGyf|ts'z$8/))!KKKz(hٲev5(h%%%$;!w1211~Zo􈍍%@@O\GGw(Zb1;ϯ۵kM:,--I$Qxx8}:ߗiPkk+ӧvj@sܟ'& 7oeddeHDTYY9---G?l7[XWWs:nWRui֗ŷJJ=6r_ 'OɐNw_~}}=Yfqĉ ҦMhڴi::'}Yv˖-ubd``]'@SO/L , HthZ^y.%%%9-\?ӦMhBBBOi'T:jjzhzӲaccC= ^ @6l@/"ڰaCu=)+wZ~PPPm۶׿{!v7n?mmm3gΤM6Qll,999Q``^&DDׯ_'SSSڻwo7$FrxKO/}p y,1|ZjaQ_w@*ا~JhڵZ>>~-Ktg|Օy۾Koz3(<<PJJ8tuBל"{vMss3Y[[w}kC!55 )--PXv-0ڶm]|ں]>>>?vttO(!!A5~}]O_@z133o8plB -ZhٲeJ?@۶m#Ok=OPyW)44tP7) ӛ]+|$\[P%nNIwWS/>M}N̙C=wCPP(~Pka{Wh޼yd``@~~~Zύ!@迢M<_gdgguڷٳ_.]"hP(V\m˗ӢEc=w:555њ5kАKDD"M6.T,X@fff]F ݜDW뀮_ӗr'_R*TWWG رc:_~zS&сn255%//.#'OLFFF]ܸq^'999.]4hػw/ B^Gfi۾t}ٳ zVV[g ~K: a׮]C{{;BBBS\\7|S1;;;֖{ի󃝝ֲdHOOײotomuEd2xyyz۷oGO>ŋQSSZ=W^^mp||1蒒0qD׿/ԩS8y$;C,.\ lݺ˺4n빓YOVcllRx0}.߶mmۆ\p7nwߍ_~K,Gnn.Ν @Zϧ׷K=bgg___ddd]-#!!cǎm\|z9¤IpٳCMBnnnx'kq#oW>3BoiرcЀh?C{GN8AhA.oAh̘1ZEFF\=Y pBSLM\=imm%kkkDT[[sHMDB?ew m۶a ^yyyKL-&&Fk]~o}]O_JoOd2I$^-[QQAbBCCu>Kdjj%nWgF&;3hhĉ]ݪo}u-S. fv'/Ο?a¨/K>pttĖ-[P\\o| ?,,,P__uuuu˲CD>000ٳg5H$5كZXD2o6̐5Tccc\TTTٙ0 OwǏʝ%<<^>m8*++vypS\_[011֭[ FVVBvv6,|Gtހo`ܸqAaaaӛu8T3g ::0]\\;%`8HuމDDDڵkwu=})+-immEff&<<ۯӢ=4/kFsjF4kF[Nk9(?{/-\PEE@n/B9nm!yzz8 Ņ Shh^4呡aF w$HhΝ|͛Ls/2/c l2W.Stߌ.VOڴis  =cyyy$J{=PSg:P`8iŊ1c͛};}qUOINw^>M}ؗuGRL&{O[{PRRBz1R/?//ۛT*܊ӧOךgyo,O5Kosך5k7/L/&Xs7|o65}?===^gy\]]izQVXe?&{{{*..;-kFFFҺuW_~ 9g#Q5=k&OL.{zz[V[~lB|rzº|O<ꫴa;v, ÃPddVnGTr9s&4}truu MoNC2H,SffoFkH}իrppzL_{s80MnJkQZпo"9?O$ I*ҟg_P_U(zj%;{z_jK?~ '''CbF~ K._|՟s4ɓֆ1 /v܉?Oذa!n}}=&MH#Gzȶ0?~ ,SO={ݠ @]v:G1̝ڶm-[M6dp1H$;?#!1ijjO<|/R;`eeC&L@rrna:۶mΝ|n Y{ ٳg/|Ìmmm㏓@ >pxB6l \̓addggfΜI"ok,H+V @@N Ȟg} כ!tE7nYYYriɑ#G͍ ####;wn쇚J^{ iѢEwH(w^!:~x_7"F?D?34443m޼Ԕ6nH|5'|BbbbO?e-3^ TJ4|;ITWWoM$hʕtȑaUWWG_~%pyϯ: 0j?V\I&&&deeEO=3DiϞ=GJ[laG@VѣG&kkkK?ZpL  -[Pnn.ߡ /)**T*^{ a8tZr%bŴrJ:yngN_555oW_!##cƌҥKtR3:::pI/ؽ{70w\!xmmm8|0vڅ{ ;w.0n8`!P(p1СCχ~w} ;!o=1n8,Z .DHH1C 'No} QQQXf ~XYY 6G]¨AD8{,~())Ahh(-[{000;LZ[[q)޽wFuu5&NKbٲeJ|8j8x >,c3gN oood@{{;._'O8s j5s"<<0y9޷o݋B`ѢE?> `8v݋x( DEEa…Xx1|}}u6a쌈D gٳ1c vA=EDHKKÇqhkkĉl2{,ISG||<?F899!** 'OFtt4Ǝ Pw ABBΝ;ӧOŋhii'iӦ JH{b߾}r LLLX"""aN8ǏڵkD1c.\ qa 8|0>SN !!!Add$&NN_DTʕ+8PTHIIsﵴbƍØ1cpؘ~+Wd\t 044Dpp0bbb0i$L4Cee%N<%YYY077ĉL0|tсk׮!11p`dd̘1ӦMCTTLLLx%ֆ=zgΜARR`oo(DEEa̘1 3(Bjj*K.ATј2e fΜeXQQΞ=$''#%%   Dxx8p]w?iiiAVVpU.A,**HRc̘1ĉaaas#OYY;g… o;%IDATz*T*\]]1aDDD 44AAA`]Rq5\rt`ee#22SLALL LMMKLr$$$ !!{{{!,, !!! L&%QRdee!-- )))HMMիW ccc3QQQ`-!//Ou*%%%%%HǐMQ\\dff"33DQQj5B!d2Ǝ˵3666|?*HLLDRR "."00dJl`?477#77HOOGzz:^T* ,,K#""秷,aHMMEjjVptt|}} LL888hoo\.GQQldgg#'' %ݡ E@@tKL(JX,<==usvv듪*TVV(((@QQQXX2tttlmmoooV~Bבk׮!-- (--Bxzz>>>񁷷74j QRR|"//999ͅ\.pEpp0 D%DV#??K䨠dE"\]] Tݷ=`gg[[[bUWqP]]*TTTEEE(++Cqq1***VL&;;;3RjGQQ PXXbq˛sqNNNpvv=`cckkkH$X[[s%@RZVWWZԠ娨\.\.GeeceeT OOOxyyq=<< @\򓗗\~II 4郱1gggre666_>hnnFuu5jjjP]]eV^^rTTTp311PwN}||FDk0򠭭 (--Eqq1JJJƍ\Raff[[[ b055%! a``DzsMMMZ;v ---hhhB@ss3 vmb8:: pqq;ܸe?R3ZrC.ƍ(--Eee%***P^^ݯӹ+++.466b1D",,,  !H`ll 333@ MEWy\;\___[[-҂V444hmmĖ. B...pttkg'''ں_332)Jp Tyy9P^^R;֙%DjʋD"H$)`bbsss7Vnm0j;Zhii777---\x:pvv \]] 777899A*yX@KXMMV]MBW__&477PTPThllZ_CCVzk!444䦭055X,`jj XXXpSsiggN1#ֹ+JJT* P*hnnkؙD"&H$BXXXpswnܷX,JRŮF뾦j%tJK6omn:itn$ D"\맮ёKaaaaKaaaa`aaCKPIENDB`circuits-2.1.0/docs/build/html/_images/graphviz-fa9bbccfbcc0c44bc0636e85a3c610dc406600cf.png.map0000644000014400001440000000003512113365276030573 0ustar prologicusers circuits-2.1.0/docs/build/html/_images/graphviz-fa9bbccfbcc0c44bc0636e85a3c610dc406600cf.png0000644000014400001440000002533212113365276030026 0ustar prologicusersPNG  IHDR xZbKGD IDATxyTS׾ǿ$L *ʨPu3]S'k]z_뽭jlU-hU&(~\EINY39{[`0ǵaY0`0|0LFRDee%J%4  uTUUA~DJ&0ӰPEEEd())Gc}`Ĉ:t(FѣGcԨQ{ipVō7p\~׮]Cnn.`РA>|8twC>Ӷ(++Ý;wp]ܹsu***`kk#88&Lܣaa+d( 88cƌ]oq5ݔJoooK@dd$ǵ3 #Rp9̙3x1HDDDˋkFAZZ/BRfBTT`eeŵn 3 P(X$$$={6&MaÆq-[QWW+W !!111Ά'Ν(L8<{0"D|78~8`ԩ̙3ѫW/233K.ҥK1h uit'O`ǎصk0vX,[ ,D"Z^'//;ww}DDD`ժU7o+}tbtҺuH$Q^Oeffr- ~7ox>>8qΟ?L9gΜZõk=rppok9 QUUEK,!+++ӟD\K2[اOQXXɓ'7n!C0b{ԩSkA.믿6"44}ABBz͵$ ̙۷ r~~\Kbp̕+W0m4l޼6lZYLￏݻw###}1cHIIApp0r̆ooFPPi8q4߼<[YY=34ڋglZa4 ݻgH6 JN5VV;>GkyA>mJmkk{h|3 D6^z7%mCK ՚! DkqF \mF7 A.4nEl{SмYjMstHRehӈT*ELL Rz xZk:رcGA(b/o,iWun: =.B!C7G}dX!PHDm ynٮǡ:ZFHHgű4ztI$ ;lݺjiѳ=#J񼫍͵Vk KW_UUU/bVx~{ywży󐒒bßzҴNkmj5ζ,0}ڵ fCe6WOjX|9?L2kI  "]8x ?p-`%߱޽{l2̚5 ۶m;"p#** ;wDll,3V`%?M6!22{쁋 גF&11K,@ 1n8%-.^<1vBcc#ײFWƔ)S f~=RIk׮%>Oty%1 D]]}$JՕǵ$ܹsMF_faۛhӦMlxL={ Ir-e۷/ʕ+\˲HXCh'v>+Vѿ1ݻwѣUvZۗky 3.oCii)"##ul0ܑ`޽رcl2'b1,f@ٳسgܹs1g6, HOOG\\bccqM`x0tPu+iR3g &&OFuu5^|EL2;v,B!2-2\p8{,d2 (̝;cǎe fFIII8s qc„ @HHXY pu/HJJ­[`ccqaҤI9s&#`aBJKKqy$&&… ða1c`R.)))۷q5\~ׯ_GII K/!""Ǐ-r{48Ǹ~v***`ee///a󃟟̵lhPXX|ܹswݻw믿VVV|dd=z|>_gDprroggkkg ^[.j[ogP*\.GUUJ%JKKQYY~xzz{6cf݄Caɒ%عs'B!?~2]]] Zg򨭭Z $෡ E"sf+>}?^ wwwa (..ƨQ/Z3f N8aahZL4 %%%HMMH$ZdDFF/ի0 ;._Ca@XX>lذ\aVҰ`_|֬Yõ1s0ӰP #06Fa |rX[[cfm={`طor]_̙38x13c _WFvv6r]UO,4;7r-Cc„ h4|2lll4,R 0gϞO߿@?ɵF'\׃Yjo>4 8p W_!..k9NJž={b $$$t!#z-;v oU ѣGc͚5غu+r JBpp0pX[[s-'4Z!99kIΝ;e02+=8tP2 >|8>slݺIII\a +i1ǎW^ZXp!zni)2 Xp!oεP(#!!p00C\zvvv\K2:׮]Chh(3rm4̐͛7֭[8rH0 Ɩ-[yf\rk96`% 3ܹs6mv܉+Vp-Ǥf̘LffDii)0i$߿k9PVV7=r-'fBcc#^}U8::v϶pvvƁ;vp-4̄O>8|p1<<6m;＃۷os- V=1.]'O?ڵkchZDFF όfSYY@9qqq(,,D@@Ν;wr-;z1ZEtgj<<<{nڵ Zwip_x8p M fo+W"//k9 gcܸqظq#>5;v, +0j=駟X_z X_|rz4zWFEE8 CO۷/ɓ'ӣa% o>,]'OČ3cq,_'ODFF<<<#aaB1zhضmr,=}ERR+q3 QWWc/^dy]֭[ {ｇ\q6 "??GeEF> q8XIÀd2xyy=7?..QQQ8t,X`zaݔҥKy&2J8;;sJdĉ6mu>|+V7`a`B,[ O~WD"| @th44a>|8p-[rem6""ھ}; @Æ X]ښ'@@QQQdooO+5[n%PHSL!+++y[YYѣG`q ]YѠqqq 7aaaptt矩x<"`aJ%~g466>3ׯ_?~u_| BCCQYY։@YHHHFiqYCC?~P| s<~#Fƍjj[Gܹs@akĦ G!++T5'Nݻw]Ν33.hjIc%K@.ϔ-+WDZZ|}}[]#>>ބʺ?4HJJ Je{B"X]&007oĆ Z,544 &&U 3.kMӧ#;;gBZ[nErr2[,uTVVQ 3.rq~ D"۷Ͻ0Ǐݻw <޿P(dU¾=oȑ#uy<"""w^sg?W_œ'OtaY$ rrPպnP(u`kk # J!JuZgaʕWqP'''HRH$nχŕ4>Dqq1=z\*ųT*E^ 777߷z /4h2 Ñ#G믣 EQQJJJPXX g>24b{\]]777 A5RܸqBvv6u`kk; Mq~t%&wrrP(.m'''5556Kuu4UTT(,,DAAN@ A0l0AAA}n0ոy&ӑ\ǐ!CWWWxxxW^ASޑJ )u'fJ RBЕZ}0|p/qq̛7!kkk3ݻ(//ǃ^x ?~<ƌ@&81 VW")) ϟ˗V1d@ Y 337nM騫È#DFFёkfO}}=.]ɸr T*t$ ]TT #-- iiix0cرLΝC||O$ɌQ*tQZhIRqQtt4rqBEEEGGӄ ښhܹ7PII ̆b?={6ۓ5,4iFVVVN{졊 cxe˖H$";;;Zh%&&r-h4W^ylllH$ҥKT[[˵iRTT)SPRRAD1E&oMBɓ\K0UUUyfDNQ(m6ruu%HD~aKs2 ZM7ne3gtIC?rssYYYQddE4&766Ү]O>$Ji֭RPT??$Jٙv:l4brtt__\D._;;wZNd2:u*xliiirrroc=n~ ]_} IDATMVipڳwG cym/_qaoòQM< nnn(++C]]Qt?}@:`M:{ۣ?ÔiB^z-^zh7^|ԕso5Hkasdjk1J-e1ˌ3wp]1h#33S7i-^Kk:lӏygʶFdffeϙ?<==qi kZeDKl`{ ==f2ZYfAV4Z9j~ im^knG"o={uuu9ss˞3 ŋc߾}Ff*Q̙!!!F3f`Ϟ=Fa.:նg كٳgO>/|!,ݿ֍x+oibtT>鷶]WtBA&$%%B!ݼyh1=v흿,h["==A_u˖-c'zqN{fӞ;kd8o6G7xƌcq6hO/"HHf擡ihh6?Ah5ZCҢEGZy}OxWik6Ύ~j[70h^!xwlmC1c6iҥf,mFuI$_b0a oŋdooʕ+m׮M5eč7.0?9::󒱈#kkkڰa,˂h4~z zWرcdkkK .dŚ!v"@@˖-b=q`H\.iӦ赍ݻ7F~К5kʊ>#HMM%2d]tk9V_LJ<==쩫9jEɡѣG=_br Sǭ0EEEyZwjjjt&M>JKK;}^> >O'N&eeezj4uT*,,ZRڵR) 4<VK ///rrr{v*N?IMMxxbzAgbA]]}$JՕve1%"Zt)x< %8N>MhT\\鴺9B>>>dkkKo&eggw%IF3yzzmڴˣ~s۷i֬Y^|E:|0 ؈i̘1̙Cwry3ih޼yl.LRb1mذ ˗iӓnJ=ZVѣGuV >O ,W,}jBhСuV***2dnJӤI㑋 }TYYɵ4 w%TJf̘AG!Jŵ4CRѡCh$W^{ujT0TnݢS߾}ښNJ]KuGT*I"@ 9sPll,s-$j:z(͙3I$zWѣ 1i r:|0-Z$ B3g;v̨S:Xhhhӧq9sUUUx1gL2F2yׂ\SXXD3fɓ!Lˤќ{.$FBPPF@+zh p-ܸq7n@jj****`oo & <<3fLC1Z%;;)))HNNFrr2#;;iii7V ///&.86ܻw--- UUUW7 0nnnɊ(**BAAp= ++ yyy1zh5 B${ HKK{B+**D"+<<A}}=@(<DwcH$D"A>}www]IXޚ 5  =44 F``0:3 !x8IENDB`circuits-2.1.0/docs/build/html/_static/0000755000014400001440000000000012113366740017514 5ustar prologicuserscircuits-2.1.0/docs/build/html/_static/plus.png0000644000014400001440000000030712062603403021176 0ustar prologicusersPNG  IHDR &q pHYs  tIME 1l9tEXtComment̖RIDATcz(BpipPc |IENDB`circuits-2.1.0/docs/build/html/_static/basic.css0000644000014400001440000002041712113366704021313 0ustar prologicusers/* * basic.css * ~~~~~~~~~ * * Sphinx stylesheet -- basic theme. * * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ /* -- main layout ----------------------------------------------------------- */ div.clearer { clear: both; } /* -- relbar ---------------------------------------------------------------- */ div.related { width: 100%; font-size: 90%; } div.related h3 { display: none; } div.related ul { margin: 0; padding: 0 0 0 10px; list-style: none; } div.related li { display: inline; } div.related li.right { float: right; margin-right: 5px; } /* -- sidebar --------------------------------------------------------------- */ div.sphinxsidebarwrapper { padding: 10px 5px 0 10px; } div.sphinxsidebar { float: left; width: 230px; margin-left: -100%; font-size: 90%; } div.sphinxsidebar ul { list-style: none; } div.sphinxsidebar ul ul, div.sphinxsidebar ul.want-points { margin-left: 20px; list-style: square; } div.sphinxsidebar ul ul { margin-top: 0; margin-bottom: 0; } div.sphinxsidebar form { margin-top: 10px; } div.sphinxsidebar input { border: 1px solid #98dbcc; font-family: sans-serif; font-size: 1em; } div.sphinxsidebar #searchbox input[type="text"] { width: 170px; } div.sphinxsidebar #searchbox input[type="submit"] { width: 30px; } img { border: 0; } /* -- search page ----------------------------------------------------------- */ ul.search { margin: 10px 0 0 20px; padding: 0; } ul.search li { padding: 5px 0 5px 20px; background-image: url(file.png); background-repeat: no-repeat; background-position: 0 7px; } ul.search li a { font-weight: bold; } ul.search li div.context { color: #888; margin: 2px 0 0 30px; text-align: left; } ul.keywordmatches li.goodmatch a { font-weight: bold; } /* -- index page ------------------------------------------------------------ */ table.contentstable { width: 90%; } table.contentstable p.biglink { line-height: 150%; } a.biglink { font-size: 1.3em; } span.linkdescr { font-style: italic; padding-top: 5px; font-size: 90%; } /* -- general index --------------------------------------------------------- */ table.indextable { width: 100%; } table.indextable td { text-align: left; vertical-align: top; } table.indextable dl, table.indextable dd { margin-top: 0; margin-bottom: 0; } table.indextable tr.pcap { height: 10px; } table.indextable tr.cap { margin-top: 10px; background-color: #f2f2f2; } img.toggler { margin-right: 3px; margin-top: 3px; cursor: pointer; } div.modindex-jumpbox { border-top: 1px solid #ddd; border-bottom: 1px solid #ddd; margin: 1em 0 1em 0; padding: 0.4em; } div.genindex-jumpbox { border-top: 1px solid #ddd; border-bottom: 1px solid #ddd; margin: 1em 0 1em 0; padding: 0.4em; } /* -- general body styles --------------------------------------------------- */ a.headerlink { visibility: hidden; } h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, h4:hover > a.headerlink, h5:hover > a.headerlink, h6:hover > a.headerlink, dt:hover > a.headerlink { visibility: visible; } div.body p.caption { text-align: inherit; } div.body td { text-align: left; } .field-list ul { padding-left: 1em; } .first { margin-top: 0 !important; } p.rubric { margin-top: 30px; font-weight: bold; } img.align-left, .figure.align-left, object.align-left { clear: left; float: left; margin-right: 1em; } img.align-right, .figure.align-right, object.align-right { clear: right; float: right; margin-left: 1em; } img.align-center, .figure.align-center, object.align-center { display: block; margin-left: auto; margin-right: auto; } .align-left { text-align: left; } .align-center { text-align: center; } .align-right { text-align: right; } /* -- sidebars -------------------------------------------------------------- */ div.sidebar { margin: 0 0 0.5em 1em; border: 1px solid #ddb; padding: 7px 7px 0 7px; background-color: #ffe; width: 40%; float: right; } p.sidebar-title { font-weight: bold; } /* -- topics ---------------------------------------------------------------- */ div.topic { border: 1px solid #ccc; padding: 7px 7px 0 7px; margin: 10px 0 10px 0; } p.topic-title { font-size: 1.1em; font-weight: bold; margin-top: 10px; } /* -- admonitions ----------------------------------------------------------- */ div.admonition { margin-top: 10px; margin-bottom: 10px; padding: 7px; } div.admonition dt { font-weight: bold; } div.admonition dl { margin-bottom: 0; } p.admonition-title { margin: 0px 10px 5px 0px; font-weight: bold; } div.body p.centered { text-align: center; margin-top: 25px; } /* -- tables ---------------------------------------------------------------- */ table.docutils { border: 0; border-collapse: collapse; } table.docutils td, table.docutils th { padding: 1px 8px 1px 5px; border-top: 0; border-left: 0; border-right: 0; border-bottom: 1px solid #aaa; } table.field-list td, table.field-list th { border: 0 !important; } table.footnote td, table.footnote th { border: 0 !important; } th { text-align: left; padding-right: 5px; } table.citation { border-left: solid 1px gray; margin-left: 1px; } table.citation td { border-bottom: none; } /* -- other body styles ----------------------------------------------------- */ ol.arabic { list-style: decimal; } ol.loweralpha { list-style: lower-alpha; } ol.upperalpha { list-style: upper-alpha; } ol.lowerroman { list-style: lower-roman; } ol.upperroman { list-style: upper-roman; } dl { margin-bottom: 15px; } dd p { margin-top: 0px; } dd ul, dd table { margin-bottom: 10px; } dd { margin-top: 3px; margin-bottom: 10px; margin-left: 30px; } dt:target, .highlighted { background-color: #fbe54e; } dl.glossary dt { font-weight: bold; font-size: 1.1em; } .field-list ul { margin: 0; padding-left: 1em; } .field-list p { margin: 0; } .refcount { color: #060; } .optional { font-size: 1.3em; } .versionmodified { font-style: italic; } .system-message { background-color: #fda; padding: 5px; border: 3px solid red; } .footnote:target { background-color: #ffa; } .line-block { display: block; margin-top: 1em; margin-bottom: 1em; } .line-block .line-block { margin-top: 0; margin-bottom: 0; margin-left: 1.5em; } .guilabel, .menuselection { font-family: sans-serif; } .accelerator { text-decoration: underline; } .classifier { font-style: oblique; } abbr, acronym { border-bottom: dotted 1px; cursor: help; } /* -- code displays --------------------------------------------------------- */ pre { overflow: auto; overflow-y: hidden; /* fixes display issues on Chrome browsers */ } td.linenos pre { padding: 5px 0px; border: 0; background-color: transparent; color: #aaa; } table.highlighttable { margin-left: 0.5em; } table.highlighttable td { padding: 0 0.5em 0 0.5em; } tt.descname { background-color: transparent; font-weight: bold; font-size: 1.2em; } tt.descclassname { background-color: transparent; } tt.xref, a tt { background-color: transparent; font-weight: bold; } h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { background-color: transparent; } .viewcode-link { float: right; } .viewcode-back { float: right; font-family: sans-serif; } div.viewcode-block:target { margin: -1px -10px; padding: 0 10px; } /* -- math display ---------------------------------------------------------- */ img.math { vertical-align: middle; } div.body div.math p { text-align: center; } span.eqno { float: right; } /* -- printout stylesheet --------------------------------------------------- */ @media print { div.document, div.documentwrapper, div.bodywrapper { margin: 0 !important; width: 100%; } div.sphinxsidebar, div.related, div.footer, #top-link { display: none; } }circuits-2.1.0/docs/build/html/_static/ajax-loader.gif0000644000014400001440000000124112062603403022361 0ustar prologicusersGIF89aU|NU|l!Created with ajaxload.info! ! NETSCAPE2.0,30Ikc:Nf E1º.`q-[9ݦ9 JkH! ,4N!  DqBQT`1 `LE[|ua C%$*! ,62#+AȐ̔V/cNIBap ̳ƨ+Y2d! ,3b%+2V_ ! 1DaFbR]=08,Ȥr9L! ,2r'+JdL &v`\bThYB)@<&,ȤR! ,3 9tڞ0!.BW1  sa50 m)J! ,2 ٜU]qp`a4AF0` @1Α! ,20IeBԜ) q10ʰPaVڥ ub[;circuits-2.1.0/docs/build/html/_static/reset-fonts-grids.css0000644000014400001440000001262212072034467023612 0ustar prologicusers/* Copyright (c) 2008, Yahoo! Inc. All rights reserved. Code licensed under the BSD License: http://developer.yahoo.net/yui/license.txt version: 2.5.1 */ html{color:#000;background:#FFF;}body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,textarea,p,blockquote,th,td{margin:0;padding:0;}table{border-collapse:collapse;border-spacing:0;}fieldset,img{border:0;}address,caption,cite,code,dfn,em,strong,th,var{font-style:normal;font-weight:normal;}li{list-style:none;}caption,th{text-align:left;}h1,h2,h3,h4,h5,h6{font-size:100%;font-weight:normal;}q:before,q:after{content:'';}abbr,acronym {border:0;font-variant:normal;}sup {vertical-align:text-top;}sub {vertical-align:text-bottom;}input,textarea,select{font-family:inherit;font-size:inherit;font-weight:inherit;}input,textarea,select{*font-size:100%;}legend{color:#000;}body {font:13px/1.231 arial,helvetica,clean,sans-serif;*font-size:small;*font:x-small;}table {font-size:inherit;font:100%;}pre,code,kbd,samp,tt{font-family:monospace;*font-size:108%;line-height:100%;} body{text-align:center;}#ft{clear:both;}#doc,#doc2,#doc3,#doc4,.yui-t1,.yui-t2,.yui-t3,.yui-t4,.yui-t5,.yui-t6,.yui-t7{margin:auto;text-align:left;width:57.69em;*width:56.25em;min-width:750px;}#doc2{width:73.076em;*width:71.25em;}#doc3{margin:auto 10px;width:auto;}#doc4{width:74.923em;*width:73.05em;}.yui-b{position:relative;}.yui-b{_position:static;}#yui-main .yui-b{position:static;}#yui-main{width:100%;}.yui-t1 #yui-main,.yui-t2 #yui-main,.yui-t3 #yui-main{float:right;margin-left:-25em;}.yui-t4 #yui-main,.yui-t5 #yui-main,.yui-t6 #yui-main{float:left;margin-right:-25em;}.yui-t1 .yui-b{float:left;width:12.30769em;*width:12.00em;}.yui-t1 #yui-main .yui-b{margin-left:13.30769em;*margin-left:13.05em;}.yui-t2 .yui-b{float:left;width:13.8461em;*width:13.50em;}.yui-t2 #yui-main .yui-b{margin-left:14.8461em;*margin-left:14.55em;}.yui-t3 .yui-b{float:left;width:23.0769em;*width:22.50em;}.yui-t3 #yui-main .yui-b{margin-left:24.0769em;*margin-left:23.62em;}.yui-t4 .yui-b{float:right;width:13.8456em;*width:13.50em;}.yui-t4 #yui-main .yui-b{margin-right:14.8456em;*margin-right:14.55em;}.yui-t5 .yui-b{float:right;width:18.4615em;*width:18.00em;}.yui-t5 #yui-main .yui-b{margin-right:19.4615em;*margin-right:19.125em;}.yui-t6 .yui-b{float:right;width:23.0769em;*width:22.50em;}.yui-t6 #yui-main .yui-b{margin-right:24.0769em;*margin-right:23.62em;}.yui-t7 #yui-main .yui-b{display:block;margin:0 0 1em 0;}#yui-main .yui-b{float:none;width:auto;}.yui-gb .yui-u,.yui-g .yui-gb .yui-u,.yui-gb .yui-g,.yui-gb .yui-gb,.yui-gb .yui-gc,.yui-gb .yui-gd,.yui-gb .yui-ge,.yui-gb .yui-gf,.yui-gc .yui-u,.yui-gc .yui-g,.yui-gd .yui-u{float:left;}.yui-g .yui-u,.yui-g .yui-g,.yui-g .yui-gb,.yui-g .yui-gc,.yui-g .yui-gd,.yui-g .yui-ge,.yui-g .yui-gf,.yui-gc .yui-u,.yui-gd .yui-g,.yui-g .yui-gc .yui-u,.yui-ge .yui-u,.yui-ge .yui-g,.yui-gf .yui-g,.yui-gf .yui-u{float:right;}.yui-g div.first,.yui-gb div.first,.yui-gc div.first,.yui-gd div.first,.yui-ge div.first,.yui-gf div.first,.yui-g .yui-gc div.first,.yui-g .yui-ge div.first,.yui-gc div.first div.first{float:left;}.yui-g .yui-u,.yui-g .yui-g,.yui-g .yui-gb,.yui-g .yui-gc,.yui-g .yui-gd,.yui-g .yui-ge,.yui-g .yui-gf{width:49.1%;}.yui-gb .yui-u,.yui-g .yui-gb .yui-u,.yui-gb .yui-g,.yui-gb .yui-gb,.yui-gb .yui-gc,.yui-gb .yui-gd,.yui-gb .yui-ge,.yui-gb .yui-gf,.yui-gc .yui-u,.yui-gc .yui-g,.yui-gd .yui-u{width:32%;margin-left:1.99%;}.yui-gb .yui-u{*margin-left:1.9%;*width:31.9%;}.yui-gc div.first,.yui-gd .yui-u{width:66%;}.yui-gd div.first{width:32%;}.yui-ge div.first,.yui-gf .yui-u{width:74.2%;}.yui-ge .yui-u,.yui-gf div.first{width:24%;}.yui-g .yui-gb div.first,.yui-gb div.first,.yui-gc div.first,.yui-gd div.first{margin-left:0;}.yui-g .yui-g .yui-u,.yui-gb .yui-g .yui-u,.yui-gc .yui-g .yui-u,.yui-gd .yui-g .yui-u,.yui-ge .yui-g .yui-u,.yui-gf .yui-g .yui-u{width:49%;*width:48.1%;*margin-left:0;}.yui-g .yui-gb div.first,.yui-gb .yui-gb div.first{*margin-right:0;*width:32%;_width:31.7%;}.yui-g .yui-gc div.first,.yui-gd .yui-g{width:66%;}.yui-gb .yui-g div.first{*margin-right:4%;_margin-right:1.3%;}.yui-gb .yui-gc div.first,.yui-gb .yui-gd div.first{*margin-right:0;}.yui-gb .yui-gb .yui-u,.yui-gb .yui-gc .yui-u{*margin-left:1.8%;_margin-left:4%;}.yui-g .yui-gb .yui-u{_margin-left:1.0%;}.yui-gb .yui-gd .yui-u{*width:66%;_width:61.2%;}.yui-gb .yui-gd div.first{*width:31%;_width:29.5%;}.yui-g .yui-gc .yui-u,.yui-gb .yui-gc .yui-u{width:32%;_float:right;margin-right:0;_margin-left:0;}.yui-gb .yui-gc div.first{width:66%;*float:left;*margin-left:0;}.yui-gb .yui-ge .yui-u,.yui-gb .yui-gf .yui-u{margin:0;}.yui-gb .yui-gb .yui-u{_margin-left:.7%;}.yui-gb .yui-g div.first,.yui-gb .yui-gb div.first{*margin-left:0;}.yui-gc .yui-g .yui-u,.yui-gd .yui-g .yui-u{*width:48.1%;*margin-left:0;}s .yui-gb .yui-gd div.first{width:32%;}.yui-g .yui-gd div.first{_width:29.9%;}.yui-ge .yui-g{width:24%;}.yui-gf .yui-g{width:74.2%;}.yui-gb .yui-ge div.yui-u,.yui-gb .yui-gf div.yui-u{float:right;}.yui-gb .yui-ge div.first,.yui-gb .yui-gf div.first{float:left;}.yui-gb .yui-ge .yui-u,.yui-gb .yui-gf div.first{*width:24%;_width:20%;}.yui-gb .yui-ge div.first,.yui-gb .yui-gf .yui-u{*width:73.5%;_width:65.5%;}.yui-ge div.first .yui-gd .yui-u{width:65%;}.yui-ge div.first .yui-gd div.first{width:32%;}#bd:after,.yui-g:after,.yui-gb:after,.yui-gc:after,.yui-gd:after,.yui-ge:after,.yui-gf:after{content:".";display:block;height:0;clear:both;visibility:hidden;}#bd,.yui-g,.yui-gb,.yui-gc,.yui-gd,.yui-ge,.yui-gf{zoom:1;}circuits-2.1.0/docs/build/html/_static/default.css0000644000014400001440000000013312072034467021651 0ustar prologicusers@import url(reset-fonts-grids.css); @import url(djangodocs.css); @import url(homepage.css);circuits-2.1.0/docs/build/html/_static/down.png0000644000014400001440000000055312062603403021165 0ustar prologicusersPNG  IHDRasRGBbKGDC pHYs B(xtIME"U{IDAT8ҡNCAJ, ++@4>/U^,~T&3M^^^PM6ٹs*RJa)eG*W<"F Fg78G>q OIp:sAj5GنyD^+yU:p_%G@D|aOs(yM,"msx:.b@D|`Vٟ۲иeKſ/G!IENDB`circuits-2.1.0/docs/build/html/_static/tracsphinx.css0000644000014400001440000000531712072034467022421 0ustar prologicusers/* Trac specific styling */ @import url("sphinxdoc.css"); /* Structure */ div.footer { background-color: #4b4d4d; text-align: center; } div.bodywrapper { border-right: none; } /* Sidebar */ div.sphinxsidebarwrapper { -moz-box-shadow: 2px 2px 7px 0 grey; -webkit-box-shadow: 2px 2px 7px 0 grey; box-shadow: 2px 2px 7px 0 grey; padding: 0 0 1px .4em; } div.sphinxsidebar h3 a, div.sphinxsidebar h4 a { color: #b00; } div.sphinxsidebar h3, div.sphinxsidebar h4 { padding: 0; color: black; } div.sphinxsidebar h3, div.sphinxsidebar h4 { background: none; border: none; border-bottom: 1px solid #ddd; } div.sphinxsidebar input { border: 1px solid #d7d7d7; } p.searchtip { font-size: 90%; color: #999; } /* Navigation */ div.related ul li a { color: #b00 } div.related ul li a:hover { color: #b00; } /* Content */ body { font: normal 13px Verdana,Arial,'Bitstream Vera Sans',Helvetica,sans-serif; background-color: #4b4d4d; border: none; border-top: 1px solid #aaa; } h1, h2, h3, h4 { font-family: Arial,Verdana,'Bitstream Vera Sans',Helvetica,sans-serif; font-weight: bold; letter-spacing: -0.018em; page-break-after: avoid; } h1 { color: #555 } h2 { border-bottom: 1px solid #ddd } div.body a { text-decoration: none } a, a tt { color: #b00 } a:visited, a:visited tt { color: #800 } :link:hover, :visited:hover, a:link:hover tt, a:visited:hover tt { background-color: #eee; color: #555; } a.headerlink, a.headerlink:hover { color: #d7d7d7 !important; font-size: .8em; font-weight: normal; vertical-align: text-top; margin: 0; padding: .5em; } a.headerlink:hover { background: none; } div.body h1 a, div.body h2 a, div.body h3 a, div.body h4 a, div.body h5 a, div.body h6 a { color: #d7d7d7 !important; } dl.class { -moz-box-shadow: 1px 1px 6px 0 #888; -webkit-box-shadow: 1px 1px 6px 0 #888; box-shadow: 1px 1px 6px 0 #888; padding: .5em; } dl.function { margin-bottom: 24px; } dl.class > dt, dl.function > dt { border-bottom: 1px solid #ddd; } th.field-name { white-space: nowrap; font-size: 90%; color: #555; } td.field-body > ul { list-style-type: square; } td.field-body > ul > li > strong { font-weight: normal; font-style: italic; } /* Admonitions */ div.admonition p.admonition-title, div.warning p.admonition-title { background: none; color: #555; border: none; } div.admonition { background: none; border: none; border-left: 2px solid #acc; } div.warning { background: none; border: none; border-left: 3px solid #c33; } /* Search */ dl:target, dt:target, .highlighted { background-color: #ffa } circuits-2.1.0/docs/build/html/_static/homepage.css0000644000014400001440000000157312072034467022023 0ustar prologicusers#index p.rubric { font-size:150%; font-weight:normal; margin-bottom:.2em; color:#487858; } #index div.section dt { font-weight: normal; } #index #s-getting-help { float: right; width: 35em; background: #E1ECE2; padding: 1em; margin: 2em 0 2em 2em; } #index #s-getting-help h2 { margin: 0; } #index #s-django-documentation div.section div.section h3 { margin: 0; } #index #s-django-documentation div.section div.section { background: #E1ECE2; padding: 1em; margin: 2em 0 2em 40.3em; } #index #s-django-documentation div.section div.section a.reference { white-space: nowrap; } #index #s-using-django dl, #index #s-add-on-contrib-applications dl, #index #s-solving-specific-problems dl, #index #s-reference dl { float: left; width: 41em; } #index #s-add-on-contrib-applications, #index #s-solving-specific-problems, #index #s-reference, #index #s-and-all-the-rest { clear: left; }circuits-2.1.0/docs/build/html/_static/websupport.js0000644000014400001440000006123612062603403022265 0ustar prologicusers/* * websupport.js * ~~~~~~~~~~~~~ * * sphinx.websupport utilties for all documentation. * * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ (function($) { $.fn.autogrow = function() { return this.each(function() { var textarea = this; $.fn.autogrow.resize(textarea); $(textarea) .focus(function() { textarea.interval = setInterval(function() { $.fn.autogrow.resize(textarea); }, 500); }) .blur(function() { clearInterval(textarea.interval); }); }); }; $.fn.autogrow.resize = function(textarea) { var lineHeight = parseInt($(textarea).css('line-height'), 10); var lines = textarea.value.split('\n'); var columns = textarea.cols; var lineCount = 0; $.each(lines, function() { lineCount += Math.ceil(this.length / columns) || 1; }); var height = lineHeight * (lineCount + 1); $(textarea).css('height', height); }; })(jQuery); (function($) { var comp, by; function init() { initEvents(); initComparator(); } function initEvents() { $('a.comment-close').live("click", function(event) { event.preventDefault(); hide($(this).attr('id').substring(2)); }); $('a.vote').live("click", function(event) { event.preventDefault(); handleVote($(this)); }); $('a.reply').live("click", function(event) { event.preventDefault(); openReply($(this).attr('id').substring(2)); }); $('a.close-reply').live("click", function(event) { event.preventDefault(); closeReply($(this).attr('id').substring(2)); }); $('a.sort-option').live("click", function(event) { event.preventDefault(); handleReSort($(this)); }); $('a.show-proposal').live("click", function(event) { event.preventDefault(); showProposal($(this).attr('id').substring(2)); }); $('a.hide-proposal').live("click", function(event) { event.preventDefault(); hideProposal($(this).attr('id').substring(2)); }); $('a.show-propose-change').live("click", function(event) { event.preventDefault(); showProposeChange($(this).attr('id').substring(2)); }); $('a.hide-propose-change').live("click", function(event) { event.preventDefault(); hideProposeChange($(this).attr('id').substring(2)); }); $('a.accept-comment').live("click", function(event) { event.preventDefault(); acceptComment($(this).attr('id').substring(2)); }); $('a.delete-comment').live("click", function(event) { event.preventDefault(); deleteComment($(this).attr('id').substring(2)); }); $('a.comment-markup').live("click", function(event) { event.preventDefault(); toggleCommentMarkupBox($(this).attr('id').substring(2)); }); } /** * Set comp, which is a comparator function used for sorting and * inserting comments into the list. */ function setComparator() { // If the first three letters are "asc", sort in ascending order // and remove the prefix. if (by.substring(0,3) == 'asc') { var i = by.substring(3); comp = function(a, b) { return a[i] - b[i]; }; } else { // Otherwise sort in descending order. comp = function(a, b) { return b[by] - a[by]; }; } // Reset link styles and format the selected sort option. $('a.sel').attr('href', '#').removeClass('sel'); $('a.by' + by).removeAttr('href').addClass('sel'); } /** * Create a comp function. If the user has preferences stored in * the sortBy cookie, use those, otherwise use the default. */ function initComparator() { by = 'rating'; // Default to sort by rating. // If the sortBy cookie is set, use that instead. if (document.cookie.length > 0) { var start = document.cookie.indexOf('sortBy='); if (start != -1) { start = start + 7; var end = document.cookie.indexOf(";", start); if (end == -1) { end = document.cookie.length; by = unescape(document.cookie.substring(start, end)); } } } setComparator(); } /** * Show a comment div. */ function show(id) { $('#ao' + id).hide(); $('#ah' + id).show(); var context = $.extend({id: id}, opts); var popup = $(renderTemplate(popupTemplate, context)).hide(); popup.find('textarea[name="proposal"]').hide(); popup.find('a.by' + by).addClass('sel'); var form = popup.find('#cf' + id); form.submit(function(event) { event.preventDefault(); addComment(form); }); $('#s' + id).after(popup); popup.slideDown('fast', function() { getComments(id); }); } /** * Hide a comment div. */ function hide(id) { $('#ah' + id).hide(); $('#ao' + id).show(); var div = $('#sc' + id); div.slideUp('fast', function() { div.remove(); }); } /** * Perform an ajax request to get comments for a node * and insert the comments into the comments tree. */ function getComments(id) { $.ajax({ type: 'GET', url: opts.getCommentsURL, data: {node: id}, success: function(data, textStatus, request) { var ul = $('#cl' + id); var speed = 100; $('#cf' + id) .find('textarea[name="proposal"]') .data('source', data.source); if (data.comments.length === 0) { ul.html('
  • No comments yet.
    • '); ul.data('empty', true); } else { // If there are comments, sort them and put them in the list. var comments = sortComments(data.comments); speed = data.comments.length * 100; appendComments(comments, ul); ul.data('empty', false); } $('#cn' + id).slideUp(speed + 200); ul.slideDown(speed); }, error: function(request, textStatus, error) { showError('Oops, there was a problem retrieving the comments.'); }, dataType: 'json' }); } /** * Add a comment via ajax and insert the comment into the comment tree. */ function addComment(form) { var node_id = form.find('input[name="node"]').val(); var parent_id = form.find('input[name="parent"]').val(); var text = form.find('textarea[name="comment"]').val(); var proposal = form.find('textarea[name="proposal"]').val(); if (text == '') { showError('Please enter a comment.'); return; } // Disable the form that is being submitted. form.find('textarea,input').attr('disabled', 'disabled'); // Send the comment to the server. $.ajax({ type: "POST", url: opts.addCommentURL, dataType: 'json', data: { node: node_id, parent: parent_id, text: text, proposal: proposal }, success: function(data, textStatus, error) { // Reset the form. if (node_id) { hideProposeChange(node_id); } form.find('textarea') .val('') .add(form.find('input')) .removeAttr('disabled'); var ul = $('#cl' + (node_id || parent_id)); if (ul.data('empty')) { $(ul).empty(); ul.data('empty', false); } insertComment(data.comment); var ao = $('#ao' + node_id); ao.find('img').attr({'src': opts.commentBrightImage}); if (node_id) { // if this was a "root" comment, remove the commenting box // (the user can get it back by reopening the comment popup) $('#ca' + node_id).slideUp(); } }, error: function(request, textStatus, error) { form.find('textarea,input').removeAttr('disabled'); showError('Oops, there was a problem adding the comment.'); } }); } /** * Recursively append comments to the main comment list and children * lists, creating the comment tree. */ function appendComments(comments, ul) { $.each(comments, function() { var div = createCommentDiv(this); ul.append($(document.createElement('li')).html(div)); appendComments(this.children, div.find('ul.comment-children')); // To avoid stagnating data, don't store the comments children in data. this.children = null; div.data('comment', this); }); } /** * After adding a new comment, it must be inserted in the correct * location in the comment tree. */ function insertComment(comment) { var div = createCommentDiv(comment); // To avoid stagnating data, don't store the comments children in data. comment.children = null; div.data('comment', comment); var ul = $('#cl' + (comment.node || comment.parent)); var siblings = getChildren(ul); var li = $(document.createElement('li')); li.hide(); // Determine where in the parents children list to insert this comment. for(i=0; i < siblings.length; i++) { if (comp(comment, siblings[i]) <= 0) { $('#cd' + siblings[i].id) .parent() .before(li.html(div)); li.slideDown('fast'); return; } } // If we get here, this comment rates lower than all the others, // or it is the only comment in the list. ul.append(li.html(div)); li.slideDown('fast'); } function acceptComment(id) { $.ajax({ type: 'POST', url: opts.acceptCommentURL, data: {id: id}, success: function(data, textStatus, request) { $('#cm' + id).fadeOut('fast'); $('#cd' + id).removeClass('moderate'); }, error: function(request, textStatus, error) { showError('Oops, there was a problem accepting the comment.'); } }); } function deleteComment(id) { $.ajax({ type: 'POST', url: opts.deleteCommentURL, data: {id: id}, success: function(data, textStatus, request) { var div = $('#cd' + id); if (data == 'delete') { // Moderator mode: remove the comment and all children immediately div.slideUp('fast', function() { div.remove(); }); return; } // User mode: only mark the comment as deleted div .find('span.user-id:first') .text('[deleted]').end() .find('div.comment-text:first') .text('[deleted]').end() .find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id + ', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id) .remove(); var comment = div.data('comment'); comment.username = '[deleted]'; comment.text = '[deleted]'; div.data('comment', comment); }, error: function(request, textStatus, error) { showError('Oops, there was a problem deleting the comment.'); } }); } function showProposal(id) { $('#sp' + id).hide(); $('#hp' + id).show(); $('#pr' + id).slideDown('fast'); } function hideProposal(id) { $('#hp' + id).hide(); $('#sp' + id).show(); $('#pr' + id).slideUp('fast'); } function showProposeChange(id) { $('#pc' + id).hide(); $('#hc' + id).show(); var textarea = $('#pt' + id); textarea.val(textarea.data('source')); $.fn.autogrow.resize(textarea[0]); textarea.slideDown('fast'); } function hideProposeChange(id) { $('#hc' + id).hide(); $('#pc' + id).show(); var textarea = $('#pt' + id); textarea.val('').removeAttr('disabled'); textarea.slideUp('fast'); } function toggleCommentMarkupBox(id) { $('#mb' + id).toggle(); } /** Handle when the user clicks on a sort by link. */ function handleReSort(link) { var classes = link.attr('class').split(/\s+/); for (var i=0; iThank you! Your comment will show up ' + 'once it is has been approved by a moderator.'); } // Prettify the comment rating. comment.pretty_rating = comment.rating + ' point' + (comment.rating == 1 ? '' : 's'); // Make a class (for displaying not yet moderated comments differently) comment.css_class = comment.displayed ? '' : ' moderate'; // Create a div for this comment. var context = $.extend({}, opts, comment); var div = $(renderTemplate(commentTemplate, context)); // If the user has voted on this comment, highlight the correct arrow. if (comment.vote) { var direction = (comment.vote == 1) ? 'u' : 'd'; div.find('#' + direction + 'v' + comment.id).hide(); div.find('#' + direction + 'u' + comment.id).show(); } if (opts.moderator || comment.text != '[deleted]') { div.find('a.reply').show(); if (comment.proposal_diff) div.find('#sp' + comment.id).show(); if (opts.moderator && !comment.displayed) div.find('#cm' + comment.id).show(); if (opts.moderator || (opts.username == comment.username)) div.find('#dc' + comment.id).show(); } return div; } /** * A simple template renderer. Placeholders such as <%id%> are replaced * by context['id'] with items being escaped. Placeholders such as <#id#> * are not escaped. */ function renderTemplate(template, context) { var esc = $(document.createElement('div')); function handle(ph, escape) { var cur = context; $.each(ph.split('.'), function() { cur = cur[this]; }); return escape ? esc.text(cur || "").html() : cur; } return template.replace(/<([%#])([\w\.]*)\1>/g, function() { return handle(arguments[2], arguments[1] == '%' ? true : false); }); } /** Flash an error message briefly. */ function showError(message) { $(document.createElement('div')).attr({'class': 'popup-error'}) .append($(document.createElement('div')) .attr({'class': 'error-message'}).text(message)) .appendTo('body') .fadeIn("slow") .delay(2000) .fadeOut("slow"); } /** Add a link the user uses to open the comments popup. */ $.fn.comment = function() { return this.each(function() { var id = $(this).attr('id').substring(1); var count = COMMENT_METADATA[id]; var title = count + ' comment' + (count == 1 ? '' : 's'); var image = count > 0 ? opts.commentBrightImage : opts.commentImage; var addcls = count == 0 ? ' nocomment' : ''; $(this) .append( $(document.createElement('a')).attr({ href: '#', 'class': 'sphinx-comment-open' + addcls, id: 'ao' + id }) .append($(document.createElement('img')).attr({ src: image, alt: 'comment', title: title })) .click(function(event) { event.preventDefault(); show($(this).attr('id').substring(2)); }) ) .append( $(document.createElement('a')).attr({ href: '#', 'class': 'sphinx-comment-close hidden', id: 'ah' + id }) .append($(document.createElement('img')).attr({ src: opts.closeCommentImage, alt: 'close', title: 'close' })) .click(function(event) { event.preventDefault(); hide($(this).attr('id').substring(2)); }) ); }); }; var opts = { processVoteURL: '/_process_vote', addCommentURL: '/_add_comment', getCommentsURL: '/_get_comments', acceptCommentURL: '/_accept_comment', deleteCommentURL: '/_delete_comment', commentImage: '/static/_static/comment.png', closeCommentImage: '/static/_static/comment-close.png', loadingImage: '/static/_static/ajax-loader.gif', commentBrightImage: '/static/_static/comment-bright.png', upArrow: '/static/_static/up.png', downArrow: '/static/_static/down.png', upArrowPressed: '/static/_static/up-pressed.png', downArrowPressed: '/static/_static/down-pressed.png', voting: false, moderator: false }; if (typeof COMMENT_OPTIONS != "undefined") { opts = jQuery.extend(opts, COMMENT_OPTIONS); } var popupTemplate = '\
    \

    \ Sort by:\ best rated\ newest\ oldest\

    \
    Comments
    \
    \ loading comments...
    \
      \
      \

      Add a comment\ (markup):

      \
      \ reStructured text markup: *emph*, **strong**, \ ``code``, \ code blocks: :: and an indented block after blank line
      \
      \ \

      \ \ Propose a change ▹\ \ \ Propose a change ▿\ \

      \ \ \ \ \
      \
      \
      '; var commentTemplate = '\
      \
      \
      \ \ \ \ \ \ \
      \
      \ \ \ \ \ \ \
      \
      \
      \

      \ <%username%>\ <%pretty_rating%>\ <%time.delta%>\

      \
      <#text#>
      \

      \ \ reply ▿\ proposal ▹\ proposal ▿\ \ \

      \ 
      \
<#proposal_diff#>\
      \
        \
        \
        \
        \ '; var replyTemplate = '\
      • \
        \
        \ \ \ \ \ \
        \
        \
        • '; $(document).ready(function() { init(); }); })(jQuery); $(document).ready(function() { // add comment anchors for all paragraphs that are commentable $('.sphinx-has-comment').comment(); // highlight search words in search results $("div.context").each(function() { var params = $.getQueryParameters(); var terms = (params.q) ? params.q[0].split(/\s+/) : []; var result = $(this); $.each(terms, function() { result.highlightText(this.toLowerCase(), 'highlighted'); }); }); // directly open comment window if requested var anchor = document.location.hash; if (anchor.substring(0, 9) == '#comment-') { $('#ao' + anchor.substring(9)).click(); document.location.hash = '#s' + anchor.substring(9); } }); circuits-2.1.0/docs/build/html/_static/pygments.css0000644000014400001440000000714312113366704022101 0ustar prologicusers.highlight .hll { background-color: #ffffcc } .highlight { background: #ffffff; } .highlight .c { color: #999988; font-style: italic } /* Comment */ .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ .highlight .k { font-weight: bold } /* Keyword */ .highlight .o { font-weight: bold } /* Operator */ .highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */ .highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */ .highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */ .highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */ .highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ .highlight .gr { color: #aa0000 } /* Generic.Error */ .highlight .gh { color: #999999 } /* Generic.Heading */ .highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ .highlight .go { color: #888888 } /* Generic.Output */ .highlight .gp { color: #555555 } /* Generic.Prompt */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #aaaaaa } /* Generic.Subheading */ .highlight .gt { color: #aa0000 } /* Generic.Traceback */ .highlight .kc { font-weight: bold } /* Keyword.Constant */ .highlight .kd { font-weight: bold } /* Keyword.Declaration */ .highlight .kn { font-weight: bold } /* Keyword.Namespace */ .highlight .kp { font-weight: bold } /* Keyword.Pseudo */ .highlight .kr { font-weight: bold } /* Keyword.Reserved */ .highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */ .highlight .m { color: #009999 } /* Literal.Number */ .highlight .s { color: #bb8844 } /* Literal.String */ .highlight .na { color: #008080 } /* Name.Attribute */ .highlight .nb { color: #999999 } /* Name.Builtin */ .highlight .nc { color: #445588; font-weight: bold } /* Name.Class */ .highlight .no { color: #008080 } /* Name.Constant */ .highlight .ni { color: #800080 } /* Name.Entity */ .highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */ .highlight .nf { color: #990000; font-weight: bold } /* Name.Function */ .highlight .nn { color: #555555 } /* Name.Namespace */ .highlight .nt { color: #000080 } /* Name.Tag */ .highlight .nv { color: #008080 } /* Name.Variable */ .highlight .ow { font-weight: bold } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mf { color: #009999 } /* Literal.Number.Float */ .highlight .mh { color: #009999 } /* Literal.Number.Hex */ .highlight .mi { color: #009999 } /* Literal.Number.Integer */ .highlight .mo { color: #009999 } /* Literal.Number.Oct */ .highlight .sb { color: #bb8844 } /* Literal.String.Backtick */ .highlight .sc { color: #bb8844 } /* Literal.String.Char */ .highlight .sd { color: #bb8844 } /* Literal.String.Doc */ .highlight .s2 { color: #bb8844 } /* Literal.String.Double */ .highlight .se { color: #bb8844 } /* Literal.String.Escape */ .highlight .sh { color: #bb8844 } /* Literal.String.Heredoc */ .highlight .si { color: #bb8844 } /* Literal.String.Interpol */ .highlight .sx { color: #bb8844 } /* Literal.String.Other */ .highlight .sr { color: #808000 } /* Literal.String.Regex */ .highlight .s1 { color: #bb8844 } /* Literal.String.Single */ .highlight .ss { color: #bb8844 } /* Literal.String.Symbol */ .highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */ .highlight .vc { color: #008080 } /* Name.Variable.Class */ .highlight .vg { color: #008080 } /* Name.Variable.Global */ .highlight .vi { color: #008080 } /* Name.Variable.Instance */ .highlight .il { color: #009999 } /* Literal.Number.Integer.Long */circuits-2.1.0/docs/build/html/_static/comment-close.png0000644000014400001440000000677212062603403022774 0ustar prologicusersPNG  IHDRa OiCCPPhotoshop ICC profilexڝSgTS=BKKoR RB&*! J!QEEȠQ, !{kּ> H3Q5 B.@ $pd!s#~<<+"x M0B\t8K@zB@F&S`cbP-`'{[! eDh;VEX0fK9-0IWfH  0Q){`##xFW<+*x<$9E[-qWW.(I+6aa@.y24x6_-"bbϫp@t~,/;m%h^ uf@Wp~<5j>{-]cK'Xto(hw?G%fIq^D$.Tʳ?D*A, `6B$BB dr`)B(Ͱ*`/@4Qhp.U=pa( Aa!ڈbX#!H$ ɈQ"K5H1RT UH=r9\F;2G1Q= C7F dt1r=6Ыhڏ>C03l0.B8, c˱" VcϱwE 6wB aAHXLXNH $4 7 Q'"K&b21XH,#/{C7$C2'ITFnR#,4H#dk9, +ȅ3![ b@qS(RjJ4e2AURݨT5ZBRQ4u9̓IKhhitݕNWGw Ljg(gwLӋT071oUX**| J&*/Tު UUT^S}FU3S ԖUPSSg;goT?~YYLOCQ_ cx,!k u5&|v*=9C3J3WRf?qtN (~))4L1e\kXHQG6EYAJ'\'GgSSݧ M=:.kDwn^Loy}/TmG X $ <5qo</QC]@Caaᄑ.ȽJtq]zۯ6iܟ4)Y3sCQ? 0k߬~OCOg#/c/Wװwa>>r><72Y_7ȷOo_C#dz%gA[z|!?:eAAA!h쐭!ΑiP~aa~ 'W?pX15wCsDDDޛg1O9-J5*>.j<74?.fYXXIlK9.*6nl {/]py.,:@LN8A*%w% yg"/6шC\*NH*Mz쑼5y$3,幄'L Lݛ:v m2=:1qB!Mggfvˬen/kY- BTZ(*geWf͉9+̳ې7ᒶKW-X潬j9(xoʿܔĹdff-[n ڴ VE/(ۻCɾUUMfeI?m]Nmq#׹=TR+Gw- 6 U#pDy  :v{vg/jBFS[b[O>zG499?rCd&ˮ/~јѡ򗓿m|x31^VwwO| (hSЧc3-bKGD pHYs  tIME!,IDAT8e_Hu?}s3y˕U2MvQ֊FE.łĊbE$DDZF5b@Q":2{n.s<_ y?mwV@tR`}Z _# _=_@ w^R%6gC-έ(K>| ${}~y3;j>;3~ZYV[eM&Uٺ3?)VA a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, h4:hover > a.headerlink, h5:hover > a.headerlink, h6:hover > a.headerlink, dt:hover > a.headerlink { visibility: visible; } /*** index ***/ table.indextable td { text-align: left; vertical-align: top;} table.indextable dl, table.indextable dd { margin-top: 0; margin-bottom: 0; } table.indextable tr.pcap { height: 10px; } table.indextable tr.cap { margin-top: 10px; background-color: #f2f2f2;} /*** page-specific overrides ***/ div#contents ul { margin-bottom: 0;} div#contents ul li { margin-bottom: 0;} div#contents ul ul li { margin-top: 0.3em;} /*** IE hacks ***/ * pre { width: 100%; } circuits-2.1.0/docs/build/html/_static/jquery.js0000644000014400001440000021475612062603403021401 0ustar prologicusers/*! * jQuery JavaScript Library v1.4.2 * http://jquery.com/ * * Copyright 2010, John Resig * Dual licensed under the MIT or GPL Version 2 licenses. * http://jquery.org/license * * Includes Sizzle.js * http://sizzlejs.com/ * Copyright 2010, The Dojo Foundation * Released under the MIT, BSD, and GPL Licenses. * * Date: Sat Feb 13 22:33:48 2010 -0500 */ (function(A,w){function ma(){if(!c.isReady){try{s.documentElement.doScroll("left")}catch(a){setTimeout(ma,1);return}c.ready()}}function Qa(a,b){b.src?c.ajax({url:b.src,async:false,dataType:"script"}):c.globalEval(b.text||b.textContent||b.innerHTML||"");b.parentNode&&b.parentNode.removeChild(b)}function X(a,b,d,f,e,j){var i=a.length;if(typeof b==="object"){for(var o in b)X(a,o,b[o],f,e,d);return a}if(d!==w){f=!j&&f&&c.isFunction(d);for(o=0;o)[^>]*$|^#([\w-]+)$/,Ua=/^.[^:#\[\.,]*$/,Va=/\S/, Wa=/^(\s|\u00A0)+|(\s|\u00A0)+$/g,Xa=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,P=navigator.userAgent,xa=false,Q=[],L,$=Object.prototype.toString,aa=Object.prototype.hasOwnProperty,ba=Array.prototype.push,R=Array.prototype.slice,ya=Array.prototype.indexOf;c.fn=c.prototype={init:function(a,b){var d,f;if(!a)return this;if(a.nodeType){this.context=this[0]=a;this.length=1;return this}if(a==="body"&&!b){this.context=s;this[0]=s.body;this.selector="body";this.length=1;return this}if(typeof a==="string")if((d=Ta.exec(a))&& (d[1]||!b))if(d[1]){f=b?b.ownerDocument||b:s;if(a=Xa.exec(a))if(c.isPlainObject(b)){a=[s.createElement(a[1])];c.fn.attr.call(a,b,true)}else a=[f.createElement(a[1])];else{a=sa([d[1]],[f]);a=(a.cacheable?a.fragment.cloneNode(true):a.fragment).childNodes}return c.merge(this,a)}else{if(b=s.getElementById(d[2])){if(b.id!==d[2])return T.find(a);this.length=1;this[0]=b}this.context=s;this.selector=a;return this}else if(!b&&/^\w+$/.test(a)){this.selector=a;this.context=s;a=s.getElementsByTagName(a);return c.merge(this, a)}else return!b||b.jquery?(b||T).find(a):c(b).find(a);else if(c.isFunction(a))return T.ready(a);if(a.selector!==w){this.selector=a.selector;this.context=a.context}return c.makeArray(a,this)},selector:"",jquery:"1.4.2",length:0,size:function(){return this.length},toArray:function(){return R.call(this,0)},get:function(a){return a==null?this.toArray():a<0?this.slice(a)[0]:this[a]},pushStack:function(a,b,d){var f=c();c.isArray(a)?ba.apply(f,a):c.merge(f,a);f.prevObject=this;f.context=this.context;if(b=== "find")f.selector=this.selector+(this.selector?" ":"")+d;else if(b)f.selector=this.selector+"."+b+"("+d+")";return f},each:function(a,b){return c.each(this,a,b)},ready:function(a){c.bindReady();if(c.isReady)a.call(s,c);else Q&&Q.push(a);return this},eq:function(a){return a===-1?this.slice(a):this.slice(a,+a+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(R.apply(this,arguments),"slice",R.call(arguments).join(","))},map:function(a){return this.pushStack(c.map(this, function(b,d){return a.call(b,d,b)}))},end:function(){return this.prevObject||c(null)},push:ba,sort:[].sort,splice:[].splice};c.fn.init.prototype=c.fn;c.extend=c.fn.extend=function(){var a=arguments[0]||{},b=1,d=arguments.length,f=false,e,j,i,o;if(typeof a==="boolean"){f=a;a=arguments[1]||{};b=2}if(typeof a!=="object"&&!c.isFunction(a))a={};if(d===b){a=this;--b}for(;b
        a"; var e=d.getElementsByTagName("*"),j=d.getElementsByTagName("a")[0];if(!(!e||!e.length||!j)){c.support={leadingWhitespace:d.firstChild.nodeType===3,tbody:!d.getElementsByTagName("tbody").length,htmlSerialize:!!d.getElementsByTagName("link").length,style:/red/.test(j.getAttribute("style")),hrefNormalized:j.getAttribute("href")==="/a",opacity:/^0.55$/.test(j.style.opacity),cssFloat:!!j.style.cssFloat,checkOn:d.getElementsByTagName("input")[0].value==="on",optSelected:s.createElement("select").appendChild(s.createElement("option")).selected, parentNode:d.removeChild(d.appendChild(s.createElement("div"))).parentNode===null,deleteExpando:true,checkClone:false,scriptEval:false,noCloneEvent:true,boxModel:null};b.type="text/javascript";try{b.appendChild(s.createTextNode("window."+f+"=1;"))}catch(i){}a.insertBefore(b,a.firstChild);if(A[f]){c.support.scriptEval=true;delete A[f]}try{delete b.test}catch(o){c.support.deleteExpando=false}a.removeChild(b);if(d.attachEvent&&d.fireEvent){d.attachEvent("onclick",function k(){c.support.noCloneEvent= false;d.detachEvent("onclick",k)});d.cloneNode(true).fireEvent("onclick")}d=s.createElement("div");d.innerHTML="";a=s.createDocumentFragment();a.appendChild(d.firstChild);c.support.checkClone=a.cloneNode(true).cloneNode(true).lastChild.checked;c(function(){var k=s.createElement("div");k.style.width=k.style.paddingLeft="1px";s.body.appendChild(k);c.boxModel=c.support.boxModel=k.offsetWidth===2;s.body.removeChild(k).style.display="none"});a=function(k){var n= s.createElement("div");k="on"+k;var r=k in n;if(!r){n.setAttribute(k,"return;");r=typeof n[k]==="function"}return r};c.support.submitBubbles=a("submit");c.support.changeBubbles=a("change");a=b=d=e=j=null}})();c.props={"for":"htmlFor","class":"className",readonly:"readOnly",maxlength:"maxLength",cellspacing:"cellSpacing",rowspan:"rowSpan",colspan:"colSpan",tabindex:"tabIndex",usemap:"useMap",frameborder:"frameBorder"};var G="jQuery"+J(),Ya=0,za={};c.extend({cache:{},expando:G,noData:{embed:true,object:true, applet:true},data:function(a,b,d){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var f=a[G],e=c.cache;if(!f&&typeof b==="string"&&d===w)return null;f||(f=++Ya);if(typeof b==="object"){a[G]=f;e[f]=c.extend(true,{},b)}else if(!e[f]){a[G]=f;e[f]={}}a=e[f];if(d!==w)a[b]=d;return typeof b==="string"?a[b]:a}},removeData:function(a,b){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var d=a[G],f=c.cache,e=f[d];if(b){if(e){delete e[b];c.isEmptyObject(e)&&c.removeData(a)}}else{if(c.support.deleteExpando)delete a[c.expando]; else a.removeAttribute&&a.removeAttribute(c.expando);delete f[d]}}}});c.fn.extend({data:function(a,b){if(typeof a==="undefined"&&this.length)return c.data(this[0]);else if(typeof a==="object")return this.each(function(){c.data(this,a)});var d=a.split(".");d[1]=d[1]?"."+d[1]:"";if(b===w){var f=this.triggerHandler("getData"+d[1]+"!",[d[0]]);if(f===w&&this.length)f=c.data(this[0],a);return f===w&&d[1]?this.data(d[0]):f}else return this.trigger("setData"+d[1]+"!",[d[0],b]).each(function(){c.data(this, a,b)})},removeData:function(a){return this.each(function(){c.removeData(this,a)})}});c.extend({queue:function(a,b,d){if(a){b=(b||"fx")+"queue";var f=c.data(a,b);if(!d)return f||[];if(!f||c.isArray(d))f=c.data(a,b,c.makeArray(d));else f.push(d);return f}},dequeue:function(a,b){b=b||"fx";var d=c.queue(a,b),f=d.shift();if(f==="inprogress")f=d.shift();if(f){b==="fx"&&d.unshift("inprogress");f.call(a,function(){c.dequeue(a,b)})}}});c.fn.extend({queue:function(a,b){if(typeof a!=="string"){b=a;a="fx"}if(b=== w)return c.queue(this[0],a);return this.each(function(){var d=c.queue(this,a,b);a==="fx"&&d[0]!=="inprogress"&&c.dequeue(this,a)})},dequeue:function(a){return this.each(function(){c.dequeue(this,a)})},delay:function(a,b){a=c.fx?c.fx.speeds[a]||a:a;b=b||"fx";return this.queue(b,function(){var d=this;setTimeout(function(){c.dequeue(d,b)},a)})},clearQueue:function(a){return this.queue(a||"fx",[])}});var Aa=/[\n\t]/g,ca=/\s+/,Za=/\r/g,$a=/href|src|style/,ab=/(button|input)/i,bb=/(button|input|object|select|textarea)/i, cb=/^(a|area)$/i,Ba=/radio|checkbox/;c.fn.extend({attr:function(a,b){return X(this,a,b,true,c.attr)},removeAttr:function(a){return this.each(function(){c.attr(this,a,"");this.nodeType===1&&this.removeAttribute(a)})},addClass:function(a){if(c.isFunction(a))return this.each(function(n){var r=c(this);r.addClass(a.call(this,n,r.attr("class")))});if(a&&typeof a==="string")for(var b=(a||"").split(ca),d=0,f=this.length;d-1)return true;return false},val:function(a){if(a===w){var b=this[0];if(b){if(c.nodeName(b,"option"))return(b.attributes.value||{}).specified?b.value:b.text;if(c.nodeName(b,"select")){var d=b.selectedIndex,f=[],e=b.options;b=b.type==="select-one";if(d<0)return null;var j=b?d:0;for(d=b?d+1:e.length;j=0;else if(c.nodeName(this,"select")){var u=c.makeArray(r);c("option",this).each(function(){this.selected= c.inArray(c(this).val(),u)>=0});if(!u.length)this.selectedIndex=-1}else this.value=r}})}});c.extend({attrFn:{val:true,css:true,html:true,text:true,data:true,width:true,height:true,offset:true},attr:function(a,b,d,f){if(!a||a.nodeType===3||a.nodeType===8)return w;if(f&&b in c.attrFn)return c(a)[b](d);f=a.nodeType!==1||!c.isXMLDoc(a);var e=d!==w;b=f&&c.props[b]||b;if(a.nodeType===1){var j=$a.test(b);if(b in a&&f&&!j){if(e){b==="type"&&ab.test(a.nodeName)&&a.parentNode&&c.error("type property can't be changed"); a[b]=d}if(c.nodeName(a,"form")&&a.getAttributeNode(b))return a.getAttributeNode(b).nodeValue;if(b==="tabIndex")return(b=a.getAttributeNode("tabIndex"))&&b.specified?b.value:bb.test(a.nodeName)||cb.test(a.nodeName)&&a.href?0:w;return a[b]}if(!c.support.style&&f&&b==="style"){if(e)a.style.cssText=""+d;return a.style.cssText}e&&a.setAttribute(b,""+d);a=!c.support.hrefNormalized&&f&&j?a.getAttribute(b,2):a.getAttribute(b);return a===null?w:a}return c.style(a,b,d)}});var O=/\.(.*)$/,db=function(a){return a.replace(/[^\w\s\.\|`]/g, function(b){return"\\"+b})};c.event={add:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){if(a.setInterval&&a!==A&&!a.frameElement)a=A;var e,j;if(d.handler){e=d;d=e.handler}if(!d.guid)d.guid=c.guid++;if(j=c.data(a)){var i=j.events=j.events||{},o=j.handle;if(!o)j.handle=o=function(){return typeof c!=="undefined"&&!c.event.triggered?c.event.handle.apply(o.elem,arguments):w};o.elem=a;b=b.split(" ");for(var k,n=0,r;k=b[n++];){j=e?c.extend({},e):{handler:d,data:f};if(k.indexOf(".")>-1){r=k.split("."); k=r.shift();j.namespace=r.slice(0).sort().join(".")}else{r=[];j.namespace=""}j.type=k;j.guid=d.guid;var u=i[k],z=c.event.special[k]||{};if(!u){u=i[k]=[];if(!z.setup||z.setup.call(a,f,r,o)===false)if(a.addEventListener)a.addEventListener(k,o,false);else a.attachEvent&&a.attachEvent("on"+k,o)}if(z.add){z.add.call(a,j);if(!j.handler.guid)j.handler.guid=d.guid}u.push(j);c.event.global[k]=true}a=null}}},global:{},remove:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){var e,j=0,i,o,k,n,r,u,z=c.data(a), C=z&&z.events;if(z&&C){if(b&&b.type){d=b.handler;b=b.type}if(!b||typeof b==="string"&&b.charAt(0)==="."){b=b||"";for(e in C)c.event.remove(a,e+b)}else{for(b=b.split(" ");e=b[j++];){n=e;i=e.indexOf(".")<0;o=[];if(!i){o=e.split(".");e=o.shift();k=new RegExp("(^|\\.)"+c.map(o.slice(0).sort(),db).join("\\.(?:.*\\.)?")+"(\\.|$)")}if(r=C[e])if(d){n=c.event.special[e]||{};for(B=f||0;B=0){a.type= e=e.slice(0,-1);a.exclusive=true}if(!d){a.stopPropagation();c.event.global[e]&&c.each(c.cache,function(){this.events&&this.events[e]&&c.event.trigger(a,b,this.handle.elem)})}if(!d||d.nodeType===3||d.nodeType===8)return w;a.result=w;a.target=d;b=c.makeArray(b);b.unshift(a)}a.currentTarget=d;(f=c.data(d,"handle"))&&f.apply(d,b);f=d.parentNode||d.ownerDocument;try{if(!(d&&d.nodeName&&c.noData[d.nodeName.toLowerCase()]))if(d["on"+e]&&d["on"+e].apply(d,b)===false)a.result=false}catch(j){}if(!a.isPropagationStopped()&& f)c.event.trigger(a,b,f,true);else if(!a.isDefaultPrevented()){f=a.target;var i,o=c.nodeName(f,"a")&&e==="click",k=c.event.special[e]||{};if((!k._default||k._default.call(d,a)===false)&&!o&&!(f&&f.nodeName&&c.noData[f.nodeName.toLowerCase()])){try{if(f[e]){if(i=f["on"+e])f["on"+e]=null;c.event.triggered=true;f[e]()}}catch(n){}if(i)f["on"+e]=i;c.event.triggered=false}}},handle:function(a){var b,d,f,e;a=arguments[0]=c.event.fix(a||A.event);a.currentTarget=this;b=a.type.indexOf(".")<0&&!a.exclusive; if(!b){d=a.type.split(".");a.type=d.shift();f=new RegExp("(^|\\.)"+d.slice(0).sort().join("\\.(?:.*\\.)?")+"(\\.|$)")}e=c.data(this,"events");d=e[a.type];if(e&&d){d=d.slice(0);e=0;for(var j=d.length;e-1?c.map(a.options,function(f){return f.selected}).join("-"):"";else if(a.nodeName.toLowerCase()==="select")d=a.selectedIndex;return d},fa=function(a,b){var d=a.target,f,e;if(!(!da.test(d.nodeName)||d.readOnly)){f=c.data(d,"_change_data");e=Fa(d);if(a.type!=="focusout"||d.type!=="radio")c.data(d,"_change_data", e);if(!(f===w||e===f))if(f!=null||e){a.type="change";return c.event.trigger(a,b,d)}}};c.event.special.change={filters:{focusout:fa,click:function(a){var b=a.target,d=b.type;if(d==="radio"||d==="checkbox"||b.nodeName.toLowerCase()==="select")return fa.call(this,a)},keydown:function(a){var b=a.target,d=b.type;if(a.keyCode===13&&b.nodeName.toLowerCase()!=="textarea"||a.keyCode===32&&(d==="checkbox"||d==="radio")||d==="select-multiple")return fa.call(this,a)},beforeactivate:function(a){a=a.target;c.data(a, "_change_data",Fa(a))}},setup:function(){if(this.type==="file")return false;for(var a in ea)c.event.add(this,a+".specialChange",ea[a]);return da.test(this.nodeName)},teardown:function(){c.event.remove(this,".specialChange");return da.test(this.nodeName)}};ea=c.event.special.change.filters}s.addEventListener&&c.each({focus:"focusin",blur:"focusout"},function(a,b){function d(f){f=c.event.fix(f);f.type=b;return c.event.handle.call(this,f)}c.event.special[b]={setup:function(){this.addEventListener(a, d,true)},teardown:function(){this.removeEventListener(a,d,true)}}});c.each(["bind","one"],function(a,b){c.fn[b]=function(d,f,e){if(typeof d==="object"){for(var j in d)this[b](j,f,d[j],e);return this}if(c.isFunction(f)){e=f;f=w}var i=b==="one"?c.proxy(e,function(k){c(this).unbind(k,i);return e.apply(this,arguments)}):e;if(d==="unload"&&b!=="one")this.one(d,f,e);else{j=0;for(var o=this.length;j0){y=t;break}}t=t[g]}m[q]=y}}}var f=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^[\]]*\]|['"][^'"]*['"]|[^[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g, e=0,j=Object.prototype.toString,i=false,o=true;[0,0].sort(function(){o=false;return 0});var k=function(g,h,l,m){l=l||[];var q=h=h||s;if(h.nodeType!==1&&h.nodeType!==9)return[];if(!g||typeof g!=="string")return l;for(var p=[],v,t,y,S,H=true,M=x(h),I=g;(f.exec(""),v=f.exec(I))!==null;){I=v[3];p.push(v[1]);if(v[2]){S=v[3];break}}if(p.length>1&&r.exec(g))if(p.length===2&&n.relative[p[0]])t=ga(p[0]+p[1],h);else for(t=n.relative[p[0]]?[h]:k(p.shift(),h);p.length;){g=p.shift();if(n.relative[g])g+=p.shift(); t=ga(g,t)}else{if(!m&&p.length>1&&h.nodeType===9&&!M&&n.match.ID.test(p[0])&&!n.match.ID.test(p[p.length-1])){v=k.find(p.shift(),h,M);h=v.expr?k.filter(v.expr,v.set)[0]:v.set[0]}if(h){v=m?{expr:p.pop(),set:z(m)}:k.find(p.pop(),p.length===1&&(p[0]==="~"||p[0]==="+")&&h.parentNode?h.parentNode:h,M);t=v.expr?k.filter(v.expr,v.set):v.set;if(p.length>0)y=z(t);else H=false;for(;p.length;){var D=p.pop();v=D;if(n.relative[D])v=p.pop();else D="";if(v==null)v=h;n.relative[D](y,v,M)}}else y=[]}y||(y=t);y||k.error(D|| g);if(j.call(y)==="[object Array]")if(H)if(h&&h.nodeType===1)for(g=0;y[g]!=null;g++){if(y[g]&&(y[g]===true||y[g].nodeType===1&&E(h,y[g])))l.push(t[g])}else for(g=0;y[g]!=null;g++)y[g]&&y[g].nodeType===1&&l.push(t[g]);else l.push.apply(l,y);else z(y,l);if(S){k(S,q,l,m);k.uniqueSort(l)}return l};k.uniqueSort=function(g){if(B){i=o;g.sort(B);if(i)for(var h=1;h":function(g,h){var l=typeof h==="string";if(l&&!/\W/.test(h)){h=h.toLowerCase();for(var m=0,q=g.length;m=0))l||m.push(v);else if(l)h[p]=false;return false},ID:function(g){return g[1].replace(/\\/g,"")},TAG:function(g){return g[1].toLowerCase()}, CHILD:function(g){if(g[1]==="nth"){var h=/(-?)(\d*)n((?:\+|-)?\d*)/.exec(g[2]==="even"&&"2n"||g[2]==="odd"&&"2n+1"||!/\D/.test(g[2])&&"0n+"+g[2]||g[2]);g[2]=h[1]+(h[2]||1)-0;g[3]=h[3]-0}g[0]=e++;return g},ATTR:function(g,h,l,m,q,p){h=g[1].replace(/\\/g,"");if(!p&&n.attrMap[h])g[1]=n.attrMap[h];if(g[2]==="~=")g[4]=" "+g[4]+" ";return g},PSEUDO:function(g,h,l,m,q){if(g[1]==="not")if((f.exec(g[3])||"").length>1||/^\w/.test(g[3]))g[3]=k(g[3],null,null,h);else{g=k.filter(g[3],h,l,true^q);l||m.push.apply(m, g);return false}else if(n.match.POS.test(g[0])||n.match.CHILD.test(g[0]))return true;return g},POS:function(g){g.unshift(true);return g}},filters:{enabled:function(g){return g.disabled===false&&g.type!=="hidden"},disabled:function(g){return g.disabled===true},checked:function(g){return g.checked===true},selected:function(g){return g.selected===true},parent:function(g){return!!g.firstChild},empty:function(g){return!g.firstChild},has:function(g,h,l){return!!k(l[3],g).length},header:function(g){return/h\d/i.test(g.nodeName)}, text:function(g){return"text"===g.type},radio:function(g){return"radio"===g.type},checkbox:function(g){return"checkbox"===g.type},file:function(g){return"file"===g.type},password:function(g){return"password"===g.type},submit:function(g){return"submit"===g.type},image:function(g){return"image"===g.type},reset:function(g){return"reset"===g.type},button:function(g){return"button"===g.type||g.nodeName.toLowerCase()==="button"},input:function(g){return/input|select|textarea|button/i.test(g.nodeName)}}, setFilters:{first:function(g,h){return h===0},last:function(g,h,l,m){return h===m.length-1},even:function(g,h){return h%2===0},odd:function(g,h){return h%2===1},lt:function(g,h,l){return hl[3]-0},nth:function(g,h,l){return l[3]-0===h},eq:function(g,h,l){return l[3]-0===h}},filter:{PSEUDO:function(g,h,l,m){var q=h[1],p=n.filters[q];if(p)return p(g,l,h,m);else if(q==="contains")return(g.textContent||g.innerText||a([g])||"").indexOf(h[3])>=0;else if(q==="not"){h= h[3];l=0;for(m=h.length;l=0}},ID:function(g,h){return g.nodeType===1&&g.getAttribute("id")===h},TAG:function(g,h){return h==="*"&&g.nodeType===1||g.nodeName.toLowerCase()===h},CLASS:function(g,h){return(" "+(g.className||g.getAttribute("class"))+" ").indexOf(h)>-1},ATTR:function(g,h){var l=h[1];g=n.attrHandle[l]?n.attrHandle[l](g):g[l]!=null?g[l]:g.getAttribute(l);l=g+"";var m=h[2];h=h[4];return g==null?m==="!=":m=== "="?l===h:m==="*="?l.indexOf(h)>=0:m==="~="?(" "+l+" ").indexOf(h)>=0:!h?l&&g!==false:m==="!="?l!==h:m==="^="?l.indexOf(h)===0:m==="$="?l.substr(l.length-h.length)===h:m==="|="?l===h||l.substr(0,h.length+1)===h+"-":false},POS:function(g,h,l,m){var q=n.setFilters[h[2]];if(q)return q(g,l,h,m)}}},r=n.match.POS;for(var u in n.match){n.match[u]=new RegExp(n.match[u].source+/(?![^\[]*\])(?![^\(]*\))/.source);n.leftMatch[u]=new RegExp(/(^(?:.|\r|\n)*?)/.source+n.match[u].source.replace(/\\(\d+)/g,function(g, h){return"\\"+(h-0+1)}))}var z=function(g,h){g=Array.prototype.slice.call(g,0);if(h){h.push.apply(h,g);return h}return g};try{Array.prototype.slice.call(s.documentElement.childNodes,0)}catch(C){z=function(g,h){h=h||[];if(j.call(g)==="[object Array]")Array.prototype.push.apply(h,g);else if(typeof g.length==="number")for(var l=0,m=g.length;l";var l=s.documentElement;l.insertBefore(g,l.firstChild);if(s.getElementById(h)){n.find.ID=function(m,q,p){if(typeof q.getElementById!=="undefined"&&!p)return(q=q.getElementById(m[1]))?q.id===m[1]||typeof q.getAttributeNode!=="undefined"&& q.getAttributeNode("id").nodeValue===m[1]?[q]:w:[]};n.filter.ID=function(m,q){var p=typeof m.getAttributeNode!=="undefined"&&m.getAttributeNode("id");return m.nodeType===1&&p&&p.nodeValue===q}}l.removeChild(g);l=g=null})();(function(){var g=s.createElement("div");g.appendChild(s.createComment(""));if(g.getElementsByTagName("*").length>0)n.find.TAG=function(h,l){l=l.getElementsByTagName(h[1]);if(h[1]==="*"){h=[];for(var m=0;l[m];m++)l[m].nodeType===1&&h.push(l[m]);l=h}return l};g.innerHTML=""; if(g.firstChild&&typeof g.firstChild.getAttribute!=="undefined"&&g.firstChild.getAttribute("href")!=="#")n.attrHandle.href=function(h){return h.getAttribute("href",2)};g=null})();s.querySelectorAll&&function(){var g=k,h=s.createElement("div");h.innerHTML="

        ";if(!(h.querySelectorAll&&h.querySelectorAll(".TEST").length===0)){k=function(m,q,p,v){q=q||s;if(!v&&q.nodeType===9&&!x(q))try{return z(q.querySelectorAll(m),p)}catch(t){}return g(m,q,p,v)};for(var l in g)k[l]=g[l];h=null}}(); (function(){var g=s.createElement("div");g.innerHTML="
        ";if(!(!g.getElementsByClassName||g.getElementsByClassName("e").length===0)){g.lastChild.className="e";if(g.getElementsByClassName("e").length!==1){n.order.splice(1,0,"CLASS");n.find.CLASS=function(h,l,m){if(typeof l.getElementsByClassName!=="undefined"&&!m)return l.getElementsByClassName(h[1])};g=null}}})();var E=s.compareDocumentPosition?function(g,h){return!!(g.compareDocumentPosition(h)&16)}: function(g,h){return g!==h&&(g.contains?g.contains(h):true)},x=function(g){return(g=(g?g.ownerDocument||g:0).documentElement)?g.nodeName!=="HTML":false},ga=function(g,h){var l=[],m="",q;for(h=h.nodeType?[h]:h;q=n.match.PSEUDO.exec(g);){m+=q[0];g=g.replace(n.match.PSEUDO,"")}g=n.relative[g]?g+"*":g;q=0;for(var p=h.length;q=0===d})};c.fn.extend({find:function(a){for(var b=this.pushStack("","find",a),d=0,f=0,e=this.length;f0)for(var j=d;j0},closest:function(a,b){if(c.isArray(a)){var d=[],f=this[0],e,j= {},i;if(f&&a.length){e=0;for(var o=a.length;e-1:c(f).is(e)){d.push({selector:i,elem:f});delete j[i]}}f=f.parentNode}}return d}var k=c.expr.match.POS.test(a)?c(a,b||this.context):null;return this.map(function(n,r){for(;r&&r.ownerDocument&&r!==b;){if(k?k.index(r)>-1:c(r).is(a))return r;r=r.parentNode}return null})},index:function(a){if(!a||typeof a=== "string")return c.inArray(this[0],a?c(a):this.parent().children());return c.inArray(a.jquery?a[0]:a,this)},add:function(a,b){a=typeof a==="string"?c(a,b||this.context):c.makeArray(a);b=c.merge(this.get(),a);return this.pushStack(qa(a[0])||qa(b[0])?b:c.unique(b))},andSelf:function(){return this.add(this.prevObject)}});c.each({parent:function(a){return(a=a.parentNode)&&a.nodeType!==11?a:null},parents:function(a){return c.dir(a,"parentNode")},parentsUntil:function(a,b,d){return c.dir(a,"parentNode", d)},next:function(a){return c.nth(a,2,"nextSibling")},prev:function(a){return c.nth(a,2,"previousSibling")},nextAll:function(a){return c.dir(a,"nextSibling")},prevAll:function(a){return c.dir(a,"previousSibling")},nextUntil:function(a,b,d){return c.dir(a,"nextSibling",d)},prevUntil:function(a,b,d){return c.dir(a,"previousSibling",d)},siblings:function(a){return c.sibling(a.parentNode.firstChild,a)},children:function(a){return c.sibling(a.firstChild)},contents:function(a){return c.nodeName(a,"iframe")? a.contentDocument||a.contentWindow.document:c.makeArray(a.childNodes)}},function(a,b){c.fn[a]=function(d,f){var e=c.map(this,b,d);eb.test(a)||(f=d);if(f&&typeof f==="string")e=c.filter(f,e);e=this.length>1?c.unique(e):e;if((this.length>1||gb.test(f))&&fb.test(a))e=e.reverse();return this.pushStack(e,a,R.call(arguments).join(","))}});c.extend({filter:function(a,b,d){if(d)a=":not("+a+")";return c.find.matches(a,b)},dir:function(a,b,d){var f=[];for(a=a[b];a&&a.nodeType!==9&&(d===w||a.nodeType!==1||!c(a).is(d));){a.nodeType=== 1&&f.push(a);a=a[b]}return f},nth:function(a,b,d){b=b||1;for(var f=0;a;a=a[d])if(a.nodeType===1&&++f===b)break;return a},sibling:function(a,b){for(var d=[];a;a=a.nextSibling)a.nodeType===1&&a!==b&&d.push(a);return d}});var Ja=/ jQuery\d+="(?:\d+|null)"/g,V=/^\s+/,Ka=/(<([\w:]+)[^>]*?)\/>/g,hb=/^(?:area|br|col|embed|hr|img|input|link|meta|param)$/i,La=/<([\w:]+)/,ib=/"},F={option:[1,""],legend:[1,"
        ","
        "],thead:[1,"","
        "],tr:[2,"","
        "],td:[3,"","
        "],col:[2,"","
        "],area:[1,"",""],_default:[0,"",""]};F.optgroup=F.option;F.tbody=F.tfoot=F.colgroup=F.caption=F.thead;F.th=F.td;if(!c.support.htmlSerialize)F._default=[1,"div
        ","
        "];c.fn.extend({text:function(a){if(c.isFunction(a))return this.each(function(b){var d= c(this);d.text(a.call(this,b,d.text()))});if(typeof a!=="object"&&a!==w)return this.empty().append((this[0]&&this[0].ownerDocument||s).createTextNode(a));return c.text(this)},wrapAll:function(a){if(c.isFunction(a))return this.each(function(d){c(this).wrapAll(a.call(this,d))});if(this[0]){var b=c(a,this[0].ownerDocument).eq(0).clone(true);this[0].parentNode&&b.insertBefore(this[0]);b.map(function(){for(var d=this;d.firstChild&&d.firstChild.nodeType===1;)d=d.firstChild;return d}).append(this)}return this}, wrapInner:function(a){if(c.isFunction(a))return this.each(function(b){c(this).wrapInner(a.call(this,b))});return this.each(function(){var b=c(this),d=b.contents();d.length?d.wrapAll(a):b.append(a)})},wrap:function(a){return this.each(function(){c(this).wrapAll(a)})},unwrap:function(){return this.parent().each(function(){c.nodeName(this,"body")||c(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.appendChild(a)})}, prepend:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b,this)});else if(arguments.length){var a=c(arguments[0]);a.push.apply(a,this.toArray());return this.pushStack(a,"before",arguments)}},after:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b, this.nextSibling)});else if(arguments.length){var a=this.pushStack(this,"after",arguments);a.push.apply(a,c(arguments[0]).toArray());return a}},remove:function(a,b){for(var d=0,f;(f=this[d])!=null;d++)if(!a||c.filter(a,[f]).length){if(!b&&f.nodeType===1){c.cleanData(f.getElementsByTagName("*"));c.cleanData([f])}f.parentNode&&f.parentNode.removeChild(f)}return this},empty:function(){for(var a=0,b;(b=this[a])!=null;a++)for(b.nodeType===1&&c.cleanData(b.getElementsByTagName("*"));b.firstChild;)b.removeChild(b.firstChild); return this},clone:function(a){var b=this.map(function(){if(!c.support.noCloneEvent&&!c.isXMLDoc(this)){var d=this.outerHTML,f=this.ownerDocument;if(!d){d=f.createElement("div");d.appendChild(this.cloneNode(true));d=d.innerHTML}return c.clean([d.replace(Ja,"").replace(/=([^="'>\s]+\/)>/g,'="$1">').replace(V,"")],f)[0]}else return this.cloneNode(true)});if(a===true){ra(this,b);ra(this.find("*"),b.find("*"))}return b},html:function(a){if(a===w)return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(Ja, ""):null;else if(typeof a==="string"&&!ta.test(a)&&(c.support.leadingWhitespace||!V.test(a))&&!F[(La.exec(a)||["",""])[1].toLowerCase()]){a=a.replace(Ka,Ma);try{for(var b=0,d=this.length;b0||e.cacheable||this.length>1?k.cloneNode(true):k)}o.length&&c.each(o,Qa)}return this}});c.fragments={};c.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){c.fn[a]=function(d){var f=[];d=c(d);var e=this.length===1&&this[0].parentNode;if(e&&e.nodeType===11&&e.childNodes.length===1&&d.length===1){d[b](this[0]); return this}else{e=0;for(var j=d.length;e0?this.clone(true):this).get();c.fn[b].apply(c(d[e]),i);f=f.concat(i)}return this.pushStack(f,a,d.selector)}}});c.extend({clean:function(a,b,d,f){b=b||s;if(typeof b.createElement==="undefined")b=b.ownerDocument||b[0]&&b[0].ownerDocument||s;for(var e=[],j=0,i;(i=a[j])!=null;j++){if(typeof i==="number")i+="";if(i){if(typeof i==="string"&&!jb.test(i))i=b.createTextNode(i);else if(typeof i==="string"){i=i.replace(Ka,Ma);var o=(La.exec(i)||["", ""])[1].toLowerCase(),k=F[o]||F._default,n=k[0],r=b.createElement("div");for(r.innerHTML=k[1]+i+k[2];n--;)r=r.lastChild;if(!c.support.tbody){n=ib.test(i);o=o==="table"&&!n?r.firstChild&&r.firstChild.childNodes:k[1]===""&&!n?r.childNodes:[];for(k=o.length-1;k>=0;--k)c.nodeName(o[k],"tbody")&&!o[k].childNodes.length&&o[k].parentNode.removeChild(o[k])}!c.support.leadingWhitespace&&V.test(i)&&r.insertBefore(b.createTextNode(V.exec(i)[0]),r.firstChild);i=r.childNodes}if(i.nodeType)e.push(i);else e= c.merge(e,i)}}if(d)for(j=0;e[j];j++)if(f&&c.nodeName(e[j],"script")&&(!e[j].type||e[j].type.toLowerCase()==="text/javascript"))f.push(e[j].parentNode?e[j].parentNode.removeChild(e[j]):e[j]);else{e[j].nodeType===1&&e.splice.apply(e,[j+1,0].concat(c.makeArray(e[j].getElementsByTagName("script"))));d.appendChild(e[j])}return e},cleanData:function(a){for(var b,d,f=c.cache,e=c.event.special,j=c.support.deleteExpando,i=0,o;(o=a[i])!=null;i++)if(d=o[c.expando]){b=f[d];if(b.events)for(var k in b.events)e[k]? c.event.remove(o,k):Ca(o,k,b.handle);if(j)delete o[c.expando];else o.removeAttribute&&o.removeAttribute(c.expando);delete f[d]}}});var kb=/z-?index|font-?weight|opacity|zoom|line-?height/i,Na=/alpha\([^)]*\)/,Oa=/opacity=([^)]*)/,ha=/float/i,ia=/-([a-z])/ig,lb=/([A-Z])/g,mb=/^-?\d+(?:px)?$/i,nb=/^-?\d/,ob={position:"absolute",visibility:"hidden",display:"block"},pb=["Left","Right"],qb=["Top","Bottom"],rb=s.defaultView&&s.defaultView.getComputedStyle,Pa=c.support.cssFloat?"cssFloat":"styleFloat",ja= function(a,b){return b.toUpperCase()};c.fn.css=function(a,b){return X(this,a,b,true,function(d,f,e){if(e===w)return c.curCSS(d,f);if(typeof e==="number"&&!kb.test(f))e+="px";c.style(d,f,e)})};c.extend({style:function(a,b,d){if(!a||a.nodeType===3||a.nodeType===8)return w;if((b==="width"||b==="height")&&parseFloat(d)<0)d=w;var f=a.style||a,e=d!==w;if(!c.support.opacity&&b==="opacity"){if(e){f.zoom=1;b=parseInt(d,10)+""==="NaN"?"":"alpha(opacity="+d*100+")";a=f.filter||c.curCSS(a,"filter")||"";f.filter= Na.test(a)?a.replace(Na,b):b}return f.filter&&f.filter.indexOf("opacity=")>=0?parseFloat(Oa.exec(f.filter)[1])/100+"":""}if(ha.test(b))b=Pa;b=b.replace(ia,ja);if(e)f[b]=d;return f[b]},css:function(a,b,d,f){if(b==="width"||b==="height"){var e,j=b==="width"?pb:qb;function i(){e=b==="width"?a.offsetWidth:a.offsetHeight;f!=="border"&&c.each(j,function(){f||(e-=parseFloat(c.curCSS(a,"padding"+this,true))||0);if(f==="margin")e+=parseFloat(c.curCSS(a,"margin"+this,true))||0;else e-=parseFloat(c.curCSS(a, "border"+this+"Width",true))||0})}a.offsetWidth!==0?i():c.swap(a,ob,i);return Math.max(0,Math.round(e))}return c.curCSS(a,b,d)},curCSS:function(a,b,d){var f,e=a.style;if(!c.support.opacity&&b==="opacity"&&a.currentStyle){f=Oa.test(a.currentStyle.filter||"")?parseFloat(RegExp.$1)/100+"":"";return f===""?"1":f}if(ha.test(b))b=Pa;if(!d&&e&&e[b])f=e[b];else if(rb){if(ha.test(b))b="float";b=b.replace(lb,"-$1").toLowerCase();e=a.ownerDocument.defaultView;if(!e)return null;if(a=e.getComputedStyle(a,null))f= a.getPropertyValue(b);if(b==="opacity"&&f==="")f="1"}else if(a.currentStyle){d=b.replace(ia,ja);f=a.currentStyle[b]||a.currentStyle[d];if(!mb.test(f)&&nb.test(f)){b=e.left;var j=a.runtimeStyle.left;a.runtimeStyle.left=a.currentStyle.left;e.left=d==="fontSize"?"1em":f||0;f=e.pixelLeft+"px";e.left=b;a.runtimeStyle.left=j}}return f},swap:function(a,b,d){var f={};for(var e in b){f[e]=a.style[e];a.style[e]=b[e]}d.call(a);for(e in b)a.style[e]=f[e]}});if(c.expr&&c.expr.filters){c.expr.filters.hidden=function(a){var b= a.offsetWidth,d=a.offsetHeight,f=a.nodeName.toLowerCase()==="tr";return b===0&&d===0&&!f?true:b>0&&d>0&&!f?false:c.curCSS(a,"display")==="none"};c.expr.filters.visible=function(a){return!c.expr.filters.hidden(a)}}var sb=J(),tb=//gi,ub=/select|textarea/i,vb=/color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week/i,N=/=\?(&|$)/,ka=/\?/,wb=/(\?|&)_=.*?(&|$)/,xb=/^(\w+:)?\/\/([^\/?#]+)/,yb=/%20/g,zb=c.fn.load;c.fn.extend({load:function(a,b,d){if(typeof a!== "string")return zb.call(this,a);else if(!this.length)return this;var f=a.indexOf(" ");if(f>=0){var e=a.slice(f,a.length);a=a.slice(0,f)}f="GET";if(b)if(c.isFunction(b)){d=b;b=null}else if(typeof b==="object"){b=c.param(b,c.ajaxSettings.traditional);f="POST"}var j=this;c.ajax({url:a,type:f,dataType:"html",data:b,complete:function(i,o){if(o==="success"||o==="notmodified")j.html(e?c("
        ").append(i.responseText.replace(tb,"")).find(e):i.responseText);d&&j.each(d,[i.responseText,o,i])}});return this}, serialize:function(){return c.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?c.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||ub.test(this.nodeName)||vb.test(this.type))}).map(function(a,b){a=c(this).val();return a==null?null:c.isArray(a)?c.map(a,function(d){return{name:b.name,value:d}}):{name:b.name,value:a}}).get()}});c.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "), function(a,b){c.fn[b]=function(d){return this.bind(b,d)}});c.extend({get:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b=null}return c.ajax({type:"GET",url:a,data:b,success:d,dataType:f})},getScript:function(a,b){return c.get(a,null,b,"script")},getJSON:function(a,b,d){return c.get(a,b,d,"json")},post:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b={}}return c.ajax({type:"POST",url:a,data:b,success:d,dataType:f})},ajaxSetup:function(a){c.extend(c.ajaxSettings,a)},ajaxSettings:{url:location.href, global:true,type:"GET",contentType:"application/x-www-form-urlencoded",processData:true,async:true,xhr:A.XMLHttpRequest&&(A.location.protocol!=="file:"||!A.ActiveXObject)?function(){return new A.XMLHttpRequest}:function(){try{return new A.ActiveXObject("Microsoft.XMLHTTP")}catch(a){}},accepts:{xml:"application/xml, text/xml",html:"text/html",script:"text/javascript, application/javascript",json:"application/json, text/javascript",text:"text/plain",_default:"*/*"}},lastModified:{},etag:{},ajax:function(a){function b(){e.success&& e.success.call(k,o,i,x);e.global&&f("ajaxSuccess",[x,e])}function d(){e.complete&&e.complete.call(k,x,i);e.global&&f("ajaxComplete",[x,e]);e.global&&!--c.active&&c.event.trigger("ajaxStop")}function f(q,p){(e.context?c(e.context):c.event).trigger(q,p)}var e=c.extend(true,{},c.ajaxSettings,a),j,i,o,k=a&&a.context||e,n=e.type.toUpperCase();if(e.data&&e.processData&&typeof e.data!=="string")e.data=c.param(e.data,e.traditional);if(e.dataType==="jsonp"){if(n==="GET")N.test(e.url)||(e.url+=(ka.test(e.url)? "&":"?")+(e.jsonp||"callback")+"=?");else if(!e.data||!N.test(e.data))e.data=(e.data?e.data+"&":"")+(e.jsonp||"callback")+"=?";e.dataType="json"}if(e.dataType==="json"&&(e.data&&N.test(e.data)||N.test(e.url))){j=e.jsonpCallback||"jsonp"+sb++;if(e.data)e.data=(e.data+"").replace(N,"="+j+"$1");e.url=e.url.replace(N,"="+j+"$1");e.dataType="script";A[j]=A[j]||function(q){o=q;b();d();A[j]=w;try{delete A[j]}catch(p){}z&&z.removeChild(C)}}if(e.dataType==="script"&&e.cache===null)e.cache=false;if(e.cache=== false&&n==="GET"){var r=J(),u=e.url.replace(wb,"$1_="+r+"$2");e.url=u+(u===e.url?(ka.test(e.url)?"&":"?")+"_="+r:"")}if(e.data&&n==="GET")e.url+=(ka.test(e.url)?"&":"?")+e.data;e.global&&!c.active++&&c.event.trigger("ajaxStart");r=(r=xb.exec(e.url))&&(r[1]&&r[1]!==location.protocol||r[2]!==location.host);if(e.dataType==="script"&&n==="GET"&&r){var z=s.getElementsByTagName("head")[0]||s.documentElement,C=s.createElement("script");C.src=e.url;if(e.scriptCharset)C.charset=e.scriptCharset;if(!j){var B= false;C.onload=C.onreadystatechange=function(){if(!B&&(!this.readyState||this.readyState==="loaded"||this.readyState==="complete")){B=true;b();d();C.onload=C.onreadystatechange=null;z&&C.parentNode&&z.removeChild(C)}}}z.insertBefore(C,z.firstChild);return w}var E=false,x=e.xhr();if(x){e.username?x.open(n,e.url,e.async,e.username,e.password):x.open(n,e.url,e.async);try{if(e.data||a&&a.contentType)x.setRequestHeader("Content-Type",e.contentType);if(e.ifModified){c.lastModified[e.url]&&x.setRequestHeader("If-Modified-Since", c.lastModified[e.url]);c.etag[e.url]&&x.setRequestHeader("If-None-Match",c.etag[e.url])}r||x.setRequestHeader("X-Requested-With","XMLHttpRequest");x.setRequestHeader("Accept",e.dataType&&e.accepts[e.dataType]?e.accepts[e.dataType]+", */*":e.accepts._default)}catch(ga){}if(e.beforeSend&&e.beforeSend.call(k,x,e)===false){e.global&&!--c.active&&c.event.trigger("ajaxStop");x.abort();return false}e.global&&f("ajaxSend",[x,e]);var g=x.onreadystatechange=function(q){if(!x||x.readyState===0||q==="abort"){E|| d();E=true;if(x)x.onreadystatechange=c.noop}else if(!E&&x&&(x.readyState===4||q==="timeout")){E=true;x.onreadystatechange=c.noop;i=q==="timeout"?"timeout":!c.httpSuccess(x)?"error":e.ifModified&&c.httpNotModified(x,e.url)?"notmodified":"success";var p;if(i==="success")try{o=c.httpData(x,e.dataType,e)}catch(v){i="parsererror";p=v}if(i==="success"||i==="notmodified")j||b();else c.handleError(e,x,i,p);d();q==="timeout"&&x.abort();if(e.async)x=null}};try{var h=x.abort;x.abort=function(){x&&h.call(x); g("abort")}}catch(l){}e.async&&e.timeout>0&&setTimeout(function(){x&&!E&&g("timeout")},e.timeout);try{x.send(n==="POST"||n==="PUT"||n==="DELETE"?e.data:null)}catch(m){c.handleError(e,x,null,m);d()}e.async||g();return x}},handleError:function(a,b,d,f){if(a.error)a.error.call(a.context||a,b,d,f);if(a.global)(a.context?c(a.context):c.event).trigger("ajaxError",[b,a,f])},active:0,httpSuccess:function(a){try{return!a.status&&location.protocol==="file:"||a.status>=200&&a.status<300||a.status===304||a.status=== 1223||a.status===0}catch(b){}return false},httpNotModified:function(a,b){var d=a.getResponseHeader("Last-Modified"),f=a.getResponseHeader("Etag");if(d)c.lastModified[b]=d;if(f)c.etag[b]=f;return a.status===304||a.status===0},httpData:function(a,b,d){var f=a.getResponseHeader("content-type")||"",e=b==="xml"||!b&&f.indexOf("xml")>=0;a=e?a.responseXML:a.responseText;e&&a.documentElement.nodeName==="parsererror"&&c.error("parsererror");if(d&&d.dataFilter)a=d.dataFilter(a,b);if(typeof a==="string")if(b=== "json"||!b&&f.indexOf("json")>=0)a=c.parseJSON(a);else if(b==="script"||!b&&f.indexOf("javascript")>=0)c.globalEval(a);return a},param:function(a,b){function d(i,o){if(c.isArray(o))c.each(o,function(k,n){b||/\[\]$/.test(i)?f(i,n):d(i+"["+(typeof n==="object"||c.isArray(n)?k:"")+"]",n)});else!b&&o!=null&&typeof o==="object"?c.each(o,function(k,n){d(i+"["+k+"]",n)}):f(i,o)}function f(i,o){o=c.isFunction(o)?o():o;e[e.length]=encodeURIComponent(i)+"="+encodeURIComponent(o)}var e=[];if(b===w)b=c.ajaxSettings.traditional; if(c.isArray(a)||a.jquery)c.each(a,function(){f(this.name,this.value)});else for(var j in a)d(j,a[j]);return e.join("&").replace(yb,"+")}});var la={},Ab=/toggle|show|hide/,Bb=/^([+-]=)?([\d+-.]+)(.*)$/,W,va=[["height","marginTop","marginBottom","paddingTop","paddingBottom"],["width","marginLeft","marginRight","paddingLeft","paddingRight"],["opacity"]];c.fn.extend({show:function(a,b){if(a||a===0)return this.animate(K("show",3),a,b);else{a=0;for(b=this.length;a").appendTo("body");f=e.css("display");if(f==="none")f="block";e.remove();la[d]=f}c.data(this[a],"olddisplay",f)}}a=0;for(b=this.length;a=0;f--)if(d[f].elem===this){b&&d[f](true);d.splice(f,1)}});b||this.dequeue();return this}});c.each({slideDown:K("show",1),slideUp:K("hide",1),slideToggle:K("toggle",1),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"}},function(a,b){c.fn[a]=function(d,f){return this.animate(b,d,f)}});c.extend({speed:function(a,b,d){var f=a&&typeof a==="object"?a:{complete:d||!d&&b||c.isFunction(a)&&a,duration:a,easing:d&&b||b&&!c.isFunction(b)&&b};f.duration=c.fx.off?0:typeof f.duration=== "number"?f.duration:c.fx.speeds[f.duration]||c.fx.speeds._default;f.old=f.complete;f.complete=function(){f.queue!==false&&c(this).dequeue();c.isFunction(f.old)&&f.old.call(this)};return f},easing:{linear:function(a,b,d,f){return d+f*a},swing:function(a,b,d,f){return(-Math.cos(a*Math.PI)/2+0.5)*f+d}},timers:[],fx:function(a,b,d){this.options=b;this.elem=a;this.prop=d;if(!b.orig)b.orig={}}});c.fx.prototype={update:function(){this.options.step&&this.options.step.call(this.elem,this.now,this);(c.fx.step[this.prop]|| c.fx.step._default)(this);if((this.prop==="height"||this.prop==="width")&&this.elem.style)this.elem.style.display="block"},cur:function(a){if(this.elem[this.prop]!=null&&(!this.elem.style||this.elem.style[this.prop]==null))return this.elem[this.prop];return(a=parseFloat(c.css(this.elem,this.prop,a)))&&a>-10000?a:parseFloat(c.curCSS(this.elem,this.prop))||0},custom:function(a,b,d){function f(j){return e.step(j)}this.startTime=J();this.start=a;this.end=b;this.unit=d||this.unit||"px";this.now=this.start; this.pos=this.state=0;var e=this;f.elem=this.elem;if(f()&&c.timers.push(f)&&!W)W=setInterval(c.fx.tick,13)},show:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.show=true;this.custom(this.prop==="width"||this.prop==="height"?1:0,this.cur());c(this.elem).show()},hide:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.hide=true;this.custom(this.cur(),0)},step:function(a){var b=J(),d=true;if(a||b>=this.options.duration+this.startTime){this.now= this.end;this.pos=this.state=1;this.update();this.options.curAnim[this.prop]=true;for(var f in this.options.curAnim)if(this.options.curAnim[f]!==true)d=false;if(d){if(this.options.display!=null){this.elem.style.overflow=this.options.overflow;a=c.data(this.elem,"olddisplay");this.elem.style.display=a?a:this.options.display;if(c.css(this.elem,"display")==="none")this.elem.style.display="block"}this.options.hide&&c(this.elem).hide();if(this.options.hide||this.options.show)for(var e in this.options.curAnim)c.style(this.elem, e,this.options.orig[e]);this.options.complete.call(this.elem)}return false}else{e=b-this.startTime;this.state=e/this.options.duration;a=this.options.easing||(c.easing.swing?"swing":"linear");this.pos=c.easing[this.options.specialEasing&&this.options.specialEasing[this.prop]||a](this.state,e,0,1,this.options.duration);this.now=this.start+(this.end-this.start)*this.pos;this.update()}return true}};c.extend(c.fx,{tick:function(){for(var a=c.timers,b=0;b
        "; a.insertBefore(b,a.firstChild);d=b.firstChild;f=d.firstChild;e=d.nextSibling.firstChild.firstChild;this.doesNotAddBorder=f.offsetTop!==5;this.doesAddBorderForTableAndCells=e.offsetTop===5;f.style.position="fixed";f.style.top="20px";this.supportsFixedPosition=f.offsetTop===20||f.offsetTop===15;f.style.position=f.style.top="";d.style.overflow="hidden";d.style.position="relative";this.subtractsBorderForOverflowNotVisible=f.offsetTop===-5;this.doesNotIncludeMarginInBodyOffset=a.offsetTop!==j;a.removeChild(b); c.offset.initialize=c.noop},bodyOffset:function(a){var b=a.offsetTop,d=a.offsetLeft;c.offset.initialize();if(c.offset.doesNotIncludeMarginInBodyOffset){b+=parseFloat(c.curCSS(a,"marginTop",true))||0;d+=parseFloat(c.curCSS(a,"marginLeft",true))||0}return{top:b,left:d}},setOffset:function(a,b,d){if(/static/.test(c.curCSS(a,"position")))a.style.position="relative";var f=c(a),e=f.offset(),j=parseInt(c.curCSS(a,"top",true),10)||0,i=parseInt(c.curCSS(a,"left",true),10)||0;if(c.isFunction(b))b=b.call(a, d,e);d={top:b.top-e.top+j,left:b.left-e.left+i};"using"in b?b.using.call(a,d):f.css(d)}};c.fn.extend({position:function(){if(!this[0])return null;var a=this[0],b=this.offsetParent(),d=this.offset(),f=/^body|html$/i.test(b[0].nodeName)?{top:0,left:0}:b.offset();d.top-=parseFloat(c.curCSS(a,"marginTop",true))||0;d.left-=parseFloat(c.curCSS(a,"marginLeft",true))||0;f.top+=parseFloat(c.curCSS(b[0],"borderTopWidth",true))||0;f.left+=parseFloat(c.curCSS(b[0],"borderLeftWidth",true))||0;return{top:d.top- f.top,left:d.left-f.left}},offsetParent:function(){return this.map(function(){for(var a=this.offsetParent||s.body;a&&!/^body|html$/i.test(a.nodeName)&&c.css(a,"position")==="static";)a=a.offsetParent;return a})}});c.each(["Left","Top"],function(a,b){var d="scroll"+b;c.fn[d]=function(f){var e=this[0],j;if(!e)return null;if(f!==w)return this.each(function(){if(j=wa(this))j.scrollTo(!a?f:c(j).scrollLeft(),a?f:c(j).scrollTop());else this[d]=f});else return(j=wa(e))?"pageXOffset"in j?j[a?"pageYOffset": "pageXOffset"]:c.support.boxModel&&j.document.documentElement[d]||j.document.body[d]:e[d]}});c.each(["Height","Width"],function(a,b){var d=b.toLowerCase();c.fn["inner"+b]=function(){return this[0]?c.css(this[0],d,false,"padding"):null};c.fn["outer"+b]=function(f){return this[0]?c.css(this[0],d,false,f?"margin":"border"):null};c.fn[d]=function(f){var e=this[0];if(!e)return f==null?null:this;if(c.isFunction(f))return this.each(function(j){var i=c(this);i[d](f.call(this,j,i[d]()))});return"scrollTo"in e&&e.document?e.document.compatMode==="CSS1Compat"&&e.document.documentElement["client"+b]||e.document.body["client"+b]:e.nodeType===9?Math.max(e.documentElement["client"+b],e.body["scroll"+b],e.documentElement["scroll"+b],e.body["offset"+b],e.documentElement["offset"+b]):f===w?c.css(e,d):this.css(d,typeof f==="string"?f:f+"px")}});A.jQuery=A.$=c})(window); circuits-2.1.0/docs/build/html/_static/minus.png0000644000014400001440000000030712062603403021346 0ustar prologicusersPNG  IHDR &q pHYs  tIME <8tEXtComment̖RIDATc= 0 && !jQuery(node.parentNode).hasClass(className)) { var span = document.createElement("span"); span.className = className; span.appendChild(document.createTextNode(val.substr(pos, text.length))); node.parentNode.insertBefore(span, node.parentNode.insertBefore( document.createTextNode(val.substr(pos + text.length)), node.nextSibling)); node.nodeValue = val.substr(0, pos); } } else if (!jQuery(node).is("button, select, textarea")) { jQuery.each(node.childNodes, function() { highlight(this); }); } } return this.each(function() { highlight(this); }); }; /** * Small JavaScript module for the documentation. */ var Documentation = { init : function() { this.fixFirefoxAnchorBug(); this.highlightSearchWords(); this.initIndexTable(); }, /** * i18n support */ TRANSLATIONS : {}, PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, LOCALE : 'unknown', // gettext and ngettext don't access this so that the functions // can safely bound to a different name (_ = Documentation.gettext) gettext : function(string) { var translated = Documentation.TRANSLATIONS[string]; if (typeof translated == 'undefined') return string; return (typeof translated == 'string') ? translated : translated[0]; }, ngettext : function(singular, plural, n) { var translated = Documentation.TRANSLATIONS[singular]; if (typeof translated == 'undefined') return (n == 1) ? singular : plural; return translated[Documentation.PLURALEXPR(n)]; }, addTranslations : function(catalog) { for (var key in catalog.messages) this.TRANSLATIONS[key] = catalog.messages[key]; this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); this.LOCALE = catalog.locale; }, /** * add context elements like header anchor links */ addContextElements : function() { $('div[id] > :header:first').each(function() { $('\u00B6'). attr('href', '#' + this.id). attr('title', _('Permalink to this headline')). appendTo(this); }); $('dt[id]').each(function() { $('\u00B6'). attr('href', '#' + this.id). attr('title', _('Permalink to this definition')). appendTo(this); }); }, /** * workaround a firefox stupidity */ fixFirefoxAnchorBug : function() { if (document.location.hash && $.browser.mozilla) window.setTimeout(function() { document.location.href += ''; }, 10); }, /** * highlight the search words provided in the url in the text */ highlightSearchWords : function() { var params = $.getQueryParameters(); var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; if (terms.length) { var body = $('div.body'); window.setTimeout(function() { $.each(terms, function() { body.highlightText(this.toLowerCase(), 'highlighted'); }); }, 10); $('

        ' + _('Hide Search Matches') + '

        ') .appendTo($('#searchbox')); } }, /** * init the domain index toggle buttons */ initIndexTable : function() { var togglers = $('img.toggler').click(function() { var src = $(this).attr('src'); var idnum = $(this).attr('id').substr(7); $('tr.cg-' + idnum).toggle(); if (src.substr(-9) == 'minus.png') $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); else $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); }).css('display', ''); if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { togglers.click(); } }, /** * helper function to hide the search marks again */ hideSearchWords : function() { $('#searchbox .highlight-link').fadeOut(300); $('span.highlighted').removeClass('highlighted'); }, /** * make the url absolute */ makeURL : function(relativeURL) { return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; }, /** * get the current relative url */ getCurrentURL : function() { var path = document.location.pathname; var parts = path.split(/\//); $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { if (this == '..') parts.pop(); }); var url = parts.join('/'); return path.substring(url.lastIndexOf('/') + 1, path.length - 1); } }; // quick alias for translations _ = Documentation.gettext; $(document).ready(function() { Documentation.init(); }); circuits-2.1.0/docs/build/html/_static/docicons-philosophy.png0000644000014400001440000000276312072034467024231 0ustar prologicusersPNG  IHDR//E pHYs  IDATX ͙]h\Em+&SU5P֢*RPm_!M&<*>P1 }Ҫ$ښn&!) ~wO2;;w{99̙lXYYo=_"5Yͼ 88\yّ?n_s3{d3MOVMO/4ǟ޲eLu[ߌACD* |SC҅ÎwєξD[TG;2"O񞻾DdmE}UQLLr™SD*Pd6|wS ܍Orq t*\XXc;^I DٕwDP../@X-/ZjHnLzG"9ރͺ +@vuǁVFR)9&c}ބ?L:=11AϜzYeH'])(A K(qb *1e{{{XdDIbaQttt(J1\uȨe'@7**jllp(I1JԪ=44433c!^Ua#a*0SBs||\%"#R%  )'!)P$MOO#O!P6xu1ܐfAiX 8&&( "y薀rty$![e3dreض.( )e(u|!fREta)}gX$A+/ X@HTU2(>P%a~FD!@ DԘ>Ն|'H!B! C70[]ܟ!8ORc3V[9?GOp|7V7>9Gù }(n\x^GTӸҨ߽iE]4U=Uu[~: ڰԖ08;DqUf" E(ຄEĔП[­#S YmsqGfVb۾TM[Œ-4@ ph?56z(3iP0mA H].8:5u((hrIțs[btP%ĩ^/VtϰkKpOVǟaŞa?G}bfIENDB`circuits-2.1.0/docs/build/html/_static/up-pressed.png0000644000014400001440000000056412062603403022307 0ustar prologicusersPNG  IHDRasRGBbKGDC pHYs B(xtIME ,ZeIDAT8͓jA*WKk-,By@- و/`cXYh!6jf GrOlXvvfk2!p!GOOԲ &zf 6|M~%`]* ΛM]K ZĆ1Er%ȶcm1`)- EYm4%7YTk-Qa"NWAo-yeq,) Ypt\hqmszG]Nar߶s^l vh\2%0EeRvIENDB`circuits-2.1.0/docs/build/html/_static/up.png0000644000014400001440000000055312062603403020642 0ustar prologicusersPNG  IHDRasRGBbKGDC pHYs B(xtIME!.<̓EIDAT8͓NABP\EG{%<|xc  cr6@t;b$;3&)h1!﫳Hzz@=)p 3۵e2/ߴ ( %^ND^ }3H1DoǪISFұ?, G`{v^X[b]&HC3{:sO& ?,[eL#IENDB`circuits-2.1.0/docs/build/html/_static/searchtools.js0000644000014400001440000003725312113366704022412 0ustar prologicusers/* * searchtools.js_t * ~~~~~~~~~~~~~~~~ * * Sphinx JavaScript utilties for the full-text search. * * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ /** * helper function to return a node containing the * search summary for a given text. keywords is a list * of stemmed words, hlwords is the list of normal, unstemmed * words. the first one is used to find the occurance, the * latter for highlighting it. */ jQuery.makeSearchSummary = function(text, keywords, hlwords) { var textLower = text.toLowerCase(); var start = 0; $.each(keywords, function() { var i = textLower.indexOf(this.toLowerCase()); if (i > -1) start = i; }); start = Math.max(start - 120, 0); var excerpt = ((start > 0) ? '...' : '') + $.trim(text.substr(start, 240)) + ((start + 240 - text.length) ? '...' : ''); var rv = $('
        ').text(excerpt); $.each(hlwords, function() { rv = rv.highlightText(this, 'highlighted'); }); return rv; } /** * Porter Stemmer */ var Stemmer = function() { var step2list = { ational: 'ate', tional: 'tion', enci: 'ence', anci: 'ance', izer: 'ize', bli: 'ble', alli: 'al', entli: 'ent', eli: 'e', ousli: 'ous', ization: 'ize', ation: 'ate', ator: 'ate', alism: 'al', iveness: 'ive', fulness: 'ful', ousness: 'ous', aliti: 'al', iviti: 'ive', biliti: 'ble', logi: 'log' }; var step3list = { icate: 'ic', ative: '', alize: 'al', iciti: 'ic', ical: 'ic', ful: '', ness: '' }; var c = "[^aeiou]"; // consonant var v = "[aeiouy]"; // vowel var C = c + "[^aeiouy]*"; // consonant sequence var V = v + "[aeiou]*"; // vowel sequence var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 var s_v = "^(" + C + ")?" + v; // vowel in stem this.stemWord = function (w) { var stem; var suffix; var firstch; var origword = w; if (w.length < 3) return w; var re; var re2; var re3; var re4; firstch = w.substr(0,1); if (firstch == "y") w = firstch.toUpperCase() + w.substr(1); // Step 1a re = /^(.+?)(ss|i)es$/; re2 = /^(.+?)([^s])s$/; if (re.test(w)) w = w.replace(re,"$1$2"); else if (re2.test(w)) w = w.replace(re2,"$1$2"); // Step 1b re = /^(.+?)eed$/; re2 = /^(.+?)(ed|ing)$/; if (re.test(w)) { var fp = re.exec(w); re = new RegExp(mgr0); if (re.test(fp[1])) { re = /.$/; w = w.replace(re,""); } } else if (re2.test(w)) { var fp = re2.exec(w); stem = fp[1]; re2 = new RegExp(s_v); if (re2.test(stem)) { w = stem; re2 = /(at|bl|iz)$/; re3 = new RegExp("([^aeiouylsz])\\1$"); re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); if (re2.test(w)) w = w + "e"; else if (re3.test(w)) { re = /.$/; w = w.replace(re,""); } else if (re4.test(w)) w = w + "e"; } } // Step 1c re = /^(.+?)y$/; if (re.test(w)) { var fp = re.exec(w); stem = fp[1]; re = new RegExp(s_v); if (re.test(stem)) w = stem + "i"; } // Step 2 re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; if (re.test(w)) { var fp = re.exec(w); stem = fp[1]; suffix = fp[2]; re = new RegExp(mgr0); if (re.test(stem)) w = stem + step2list[suffix]; } // Step 3 re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; if (re.test(w)) { var fp = re.exec(w); stem = fp[1]; suffix = fp[2]; re = new RegExp(mgr0); if (re.test(stem)) w = stem + step3list[suffix]; } // Step 4 re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; re2 = /^(.+?)(s|t)(ion)$/; if (re.test(w)) { var fp = re.exec(w); stem = fp[1]; re = new RegExp(mgr1); if (re.test(stem)) w = stem; } else if (re2.test(w)) { var fp = re2.exec(w); stem = fp[1] + fp[2]; re2 = new RegExp(mgr1); if (re2.test(stem)) w = stem; } // Step 5 re = /^(.+?)e$/; if (re.test(w)) { var fp = re.exec(w); stem = fp[1]; re = new RegExp(mgr1); re2 = new RegExp(meq1); re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) w = stem; } re = /ll$/; re2 = new RegExp(mgr1); if (re.test(w) && re2.test(w)) { re = /.$/; w = w.replace(re,""); } // and turn initial Y back to y if (firstch == "y") w = firstch.toLowerCase() + w.substr(1); return w; } } /** * Search Module */ var Search = { _index : null, _queued_query : null, _pulse_status : -1, init : function() { var params = $.getQueryParameters(); if (params.q) { var query = params.q[0]; $('input[name="q"]')[0].value = query; this.performSearch(query); } }, loadIndex : function(url) { $.ajax({type: "GET", url: url, data: null, success: null, dataType: "script", cache: true}); }, setIndex : function(index) { var q; this._index = index; if ((q = this._queued_query) !== null) { this._queued_query = null; Search.query(q); } }, hasIndex : function() { return this._index !== null; }, deferQuery : function(query) { this._queued_query = query; }, stopPulse : function() { this._pulse_status = 0; }, startPulse : function() { if (this._pulse_status >= 0) return; function pulse() { Search._pulse_status = (Search._pulse_status + 1) % 4; var dotString = ''; for (var i = 0; i < Search._pulse_status; i++) dotString += '.'; Search.dots.text(dotString); if (Search._pulse_status > -1) window.setTimeout(pulse, 500); }; pulse(); }, /** * perform a search for something */ performSearch : function(query) { // create the required interface elements this.out = $('#search-results'); this.title = $('

        ' + _('Searching') + '

        ').appendTo(this.out); this.dots = $('').appendTo(this.title); this.status = $('

        ').appendTo(this.out); this.output = $('
          ').appendTo(this.out); $('#search-progress').text(_('Preparing search...')); this.startPulse(); // index already loaded, the browser was quick! if (this.hasIndex()) this.query(query); else this.deferQuery(query); }, query : function(query) { var stopwords = ["and","then","into","it","as","are","in","if","for","no","there","their","was","is","be","to","that","but","they","not","such","with","by","a","on","these","of","will","this","near","the","or","at"]; // Stem the searchterms and add them to the correct list var stemmer = new Stemmer(); var searchterms = []; var excluded = []; var hlterms = []; var tmp = query.split(/\s+/); var objectterms = []; for (var i = 0; i < tmp.length; i++) { if (tmp[i] != "") { objectterms.push(tmp[i].toLowerCase()); } if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) || tmp[i] == "") { // skip this "word" continue; } // stem the word var word = stemmer.stemWord(tmp[i]).toLowerCase(); // select the correct list if (word[0] == '-') { var toAppend = excluded; word = word.substr(1); } else { var toAppend = searchterms; hlterms.push(tmp[i].toLowerCase()); } // only add if not already in the list if (!$.contains(toAppend, word)) toAppend.push(word); }; var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" ")); // console.debug('SEARCH: searching for:'); // console.info('required: ', searchterms); // console.info('excluded: ', excluded); // prepare search var filenames = this._index.filenames; var titles = this._index.titles; var terms = this._index.terms; var fileMap = {}; var files = null; // different result priorities var importantResults = []; var objectResults = []; var regularResults = []; var unimportantResults = []; $('#search-progress').empty(); // lookup as object for (var i = 0; i < objectterms.length; i++) { var others = [].concat(objectterms.slice(0,i), objectterms.slice(i+1, objectterms.length)) var results = this.performObjectSearch(objectterms[i], others); // Assume first word is most likely to be the object, // other words more likely to be in description. // Therefore put matches for earlier words first. // (Results are eventually used in reverse order). objectResults = results[0].concat(objectResults); importantResults = results[1].concat(importantResults); unimportantResults = results[2].concat(unimportantResults); } // perform the search on the required terms for (var i = 0; i < searchterms.length; i++) { var word = searchterms[i]; // no match but word was a required one if ((files = terms[word]) == null) break; if (files.length == undefined) { files = [files]; } // create the mapping for (var j = 0; j < files.length; j++) { var file = files[j]; if (file in fileMap) fileMap[file].push(word); else fileMap[file] = [word]; } } // now check if the files don't contain excluded terms for (var file in fileMap) { var valid = true; // check if all requirements are matched if (fileMap[file].length != searchterms.length) continue; // ensure that none of the excluded terms is in the // search result. for (var i = 0; i < excluded.length; i++) { if (terms[excluded[i]] == file || $.contains(terms[excluded[i]] || [], file)) { valid = false; break; } } // if we have still a valid result we can add it // to the result list if (valid) regularResults.push([filenames[file], titles[file], '', null]); } // delete unused variables in order to not waste // memory until list is retrieved completely delete filenames, titles, terms; // now sort the regular results descending by title regularResults.sort(function(a, b) { var left = a[1].toLowerCase(); var right = b[1].toLowerCase(); return (left > right) ? -1 : ((left < right) ? 1 : 0); }); // combine all results var results = unimportantResults.concat(regularResults) .concat(objectResults).concat(importantResults); // print the results var resultCount = results.length; function displayNextItem() { // results left, load the summary and display it if (results.length) { var item = results.pop(); var listItem = $('
        • '); if (DOCUMENTATION_OPTIONS.FILE_SUFFIX == '') { // dirhtml builder var dirname = item[0] + '/'; if (dirname.match(/\/index\/$/)) { dirname = dirname.substring(0, dirname.length-6); } else if (dirname == 'index/') { dirname = ''; } listItem.append($('').attr('href', DOCUMENTATION_OPTIONS.URL_ROOT + dirname + highlightstring + item[2]).html(item[1])); } else { // normal html builders listItem.append($('').attr('href', item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX + highlightstring + item[2]).html(item[1])); } if (item[3]) { listItem.append($(' (' + item[3] + ')')); Search.output.append(listItem); listItem.slideDown(5, function() { displayNextItem(); }); } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) { $.get(DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[0] + '.txt', function(data) { if (data != '') { listItem.append($.makeSearchSummary(data, searchterms, hlterms)); Search.output.append(listItem); } listItem.slideDown(5, function() { displayNextItem(); }); }, "text"); } else { // no source available, just display title Search.output.append(listItem); listItem.slideDown(5, function() { displayNextItem(); }); } } // search finished, update title and status message else { Search.stopPulse(); Search.title.text(_('Search Results')); if (!resultCount) Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.')); else Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount)); Search.status.fadeIn(500); } } displayNextItem(); }, performObjectSearch : function(object, otherterms) { var filenames = this._index.filenames; var objects = this._index.objects; var objnames = this._index.objnames; var titles = this._index.titles; var importantResults = []; var objectResults = []; var unimportantResults = []; for (var prefix in objects) { for (var name in objects[prefix]) { var fullname = (prefix ? prefix + '.' : '') + name; if (fullname.toLowerCase().indexOf(object) > -1) { var match = objects[prefix][name]; var objname = objnames[match[1]][2]; var title = titles[match[0]]; // If more than one term searched for, we require other words to be // found in the name/title/description if (otherterms.length > 0) { var haystack = (prefix + ' ' + name + ' ' + objname + ' ' + title).toLowerCase(); var allfound = true; for (var i = 0; i < otherterms.length; i++) { if (haystack.indexOf(otherterms[i]) == -1) { allfound = false; break; } } if (!allfound) { continue; } } var descr = objname + _(', in ') + title; anchor = match[3]; if (anchor == '') anchor = fullname; else if (anchor == '-') anchor = objnames[match[1]][1] + '-' + fullname; result = [filenames[match[0]], fullname, '#'+anchor, descr]; switch (match[2]) { case 1: objectResults.push(result); break; case 0: importantResults.push(result); break; case 2: unimportantResults.push(result); break; } } } } // sort results descending objectResults.sort(function(a, b) { return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); }); importantResults.sort(function(a, b) { return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); }); unimportantResults.sort(function(a, b) { return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); }); return [importantResults, objectResults, unimportantResults] } } $(document).ready(function() { Search.init(); });circuits-2.1.0/docs/build/html/_static/comment-bright.png0000644000014400001440000000665412062603403023145 0ustar prologicusersPNG  IHDRa OiCCPPhotoshop ICC profilexڝSgTS=BKKoR RB&*! J!QEEȠQ, !{kּ> H3Q5 B.@ $pd!s#~<<+"x M0B\t8K@zB@F&S`cbP-`'{[! eDh;VEX0fK9-0IWfH  0Q){`##xFW<+*x<$9E[-qWW.(I+6aa@.y24x6_-"bbϫp@t~,/;m%h^ uf@Wp~<5j>{-]cK'Xto(hw?G%fIq^D$.Tʳ?D*A, `6B$BB dr`)B(Ͱ*`/@4Qhp.U=pa( Aa!ڈbX#!H$ ɈQ"K5H1RT UH=r9\F;2G1Q= C7F dt1r=6Ыhڏ>C03l0.B8, c˱" VcϱwE 6wB aAHXLXNH $4 7 Q'"K&b21XH,#/{C7$C2'ITFnR#,4H#dk9, +ȅ3![ b@qS(RjJ4e2AURݨT5ZBRQ4u9̓IKhhitݕNWGw Ljg(gwLӋT071oUX**| J&*/Tު UUT^S}FU3S ԖUPSSg;goT?~YYLOCQ_ cx,!k u5&|v*=9C3J3WRf?qtN (~))4L1e\kXHQG6EYAJ'\'GgSSݧ M=:.kDwn^Loy}/TmG X $ <5qo</QC]@Caaᄑ.ȽJtq]zۯ6iܟ4)Y3sCQ? 0k߬~OCOg#/c/Wװwa>>r><72Y_7ȷOo_C#dz%gA[z|!?:eAAA!h쐭!ΑiP~aa~ 'W?pX15wCsDDDޛg1O9-J5*>.j<74?.fYXXIlK9.*6nl {/]py.,:@LN8A*%w% yg"/6шC\*NH*Mz쑼5y$3,幄'L Lݛ:v m2=:1qB!Mggfvˬen/kY- BTZ(*geWf͉9+̳ې7ᒶKW-X潬j9(xoʿܔĹdff-[n ڴ VE/(ۻCɾUUMfeI?m]Nmq#׹=TR+Gw- 6 U#pDy  :v{vg/jBFS[b[O>zG499?rCd&ˮ/~јѡ򗓿m|x31^VwwO| (hSЧc3-bKGD pHYs  tIME 6 B\<IDAT8˅Kh]es1mA`jh[-E(FEaA!bIȐ*BX"؁4)NURZ!Mhjssm؋^-\gg ]o|Ҭ[346>zd ]#8Oݺt{5uIXN!I=@Vf=v1}e>;fvnvxaHrʪJF`D¹WZ]S%S)WAb |0K=So7D~\~q-˟\aMZ,S'*} F`Nnz674U H3Q5 B.@ $pd!s#~<<+"x M0B\t8K@zB@F&S`cbP-`'{[! eDh;VEX0fK9-0IWfH  0Q){`##xFW<+*x<$9E[-qWW.(I+6aa@.y24x6_-"bbϫp@t~,/;m%h^ uf@Wp~<5j>{-]cK'Xto(hw?G%fIq^D$.Tʳ?D*A, `6B$BB dr`)B(Ͱ*`/@4Qhp.U=pa( Aa!ڈbX#!H$ ɈQ"K5H1RT UH=r9\F;2G1Q= C7F dt1r=6Ыhڏ>C03l0.B8, c˱" VcϱwE 6wB aAHXLXNH $4 7 Q'"K&b21XH,#/{C7$C2'ITFnR#,4H#dk9, +ȅ3![ b@qS(RjJ4e2AURݨT5ZBRQ4u9̓IKhhitݕNWGw Ljg(gwLӋT071oUX**| J&*/Tު UUT^S}FU3S ԖUPSSg;goT?~YYLOCQ_ cx,!k u5&|v*=9C3J3WRf?qtN (~))4L1e\kXHQG6EYAJ'\'GgSSݧ M=:.kDwn^Loy}/TmG X $ <5qo</QC]@Caaᄑ.ȽJtq]zۯ6iܟ4)Y3sCQ? 0k߬~OCOg#/c/Wװwa>>r><72Y_7ȷOo_C#dz%gA[z|!?:eAAA!h쐭!ΑiP~aa~ 'W?pX15wCsDDDޛg1O9-J5*>.j<74?.fYXXIlK9.*6nl {/]py.,:@LN8A*%w% yg"/6шC\*NH*Mz쑼5y$3,幄'L Lݛ:v m2=:1qB!Mggfvˬen/kY- BTZ(*geWf͉9+̳ې7ᒶKW-X潬j9(xoʿܔĹdff-[n ڴ VE/(ۻCɾUUMfeI?m]Nmq#׹=TR+Gw- 6 U#pDy  :v{vg/jBFS[b[O>zG499?rCd&ˮ/~јѡ򗓿m|x31^VwwO| (hSЧc3-bKGD pHYs  tIME 1;VIDAT8ukU?sg4h`G1 RQܸp%Bn"bЍXJ .4V iZ##T;m!4bP~7r>ιbwc;m;oӍAΆ ζZ^/|s{;yR=9(rtVoG1w#_ө{*E&!(LVuoᲵ‘D PG4 :&~*ݳreu: S-,U^E&JY[P!RB ŖޞʖR@_ȐdBfNvHf"2T]R j'B1ddAak/DIJD D2H&L`&L $Ex,6|~_\P $MH`I=@Z||ttvgcЕWTZ'3rje"ܵx9W> mb|byfFRx{w%DZC$wdցHmWnta(M<~;9]C/_;Տ#}o`zSڷ_>:;x컓?yݩ|}~wam-/7=0S5RP"*֯ IENDB`circuits-2.1.0/docs/build/html/_static/underscore.js0000644000014400001440000002057612062603403022226 0ustar prologicusers// Underscore.js 0.5.5 // (c) 2009 Jeremy Ashkenas, DocumentCloud Inc. // Underscore is freely distributable under the terms of the MIT license. // Portions of Underscore are inspired by or borrowed from Prototype.js, // Oliver Steele's Functional, and John Resig's Micro-Templating. // For all details and documentation: // http://documentcloud.github.com/underscore/ (function(){var j=this,n=j._,i=function(a){this._wrapped=a},m=typeof StopIteration!=="undefined"?StopIteration:"__break__",b=j._=function(a){return new i(a)};if(typeof exports!=="undefined")exports._=b;var k=Array.prototype.slice,o=Array.prototype.unshift,p=Object.prototype.toString,q=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;b.VERSION="0.5.5";b.each=function(a,c,d){try{if(a.forEach)a.forEach(c,d);else if(b.isArray(a)||b.isArguments(a))for(var e=0,f=a.length;e=e.computed&&(e={value:f,computed:g})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);var e={computed:Infinity};b.each(a,function(f,g,h){g=c?c.call(d,f,g,h):f;gf?1:0}),"value")};b.sortedIndex=function(a,c,d){d=d||b.identity;for(var e=0,f=a.length;e>1;d(a[g])=0})})};b.zip=function(){for(var a=b.toArray(arguments),c=b.max(b.pluck(a,"length")),d=new Array(c),e=0;e0?f-c:c-f)>=0)return e;e[g++]=f}};b.bind=function(a,c){var d=b.rest(arguments,2);return function(){return a.apply(c||j,d.concat(b.toArray(arguments)))}};b.bindAll=function(a){var c=b.rest(arguments);if(c.length==0)c=b.functions(a);b.each(c,function(d){a[d]=b.bind(a[d],a)}); return a};b.delay=function(a,c){var d=b.rest(arguments,2);return setTimeout(function(){return a.apply(a,d)},c)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(b.rest(arguments)))};b.wrap=function(a,c){return function(){var d=[a].concat(b.toArray(arguments));return c.apply(c,d)}};b.compose=function(){var a=b.toArray(arguments);return function(){for(var c=b.toArray(arguments),d=a.length-1;d>=0;d--)c=[a[d].apply(this,c)];return c[0]}};b.keys=function(a){if(b.isArray(a))return b.range(0,a.length); var c=[];for(var d in a)q.call(a,d)&&c.push(d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=function(a){return b.select(b.keys(a),function(c){return b.isFunction(a[c])}).sort()};b.extend=function(a,c){for(var d in c)a[d]=c[d];return a};b.clone=function(a){if(b.isArray(a))return a.slice(0);return b.extend({},a)};b.tap=function(a,c){c(a);return a};b.isEqual=function(a,c){if(a===c)return true;var d=typeof a;if(d!=typeof c)return false;if(a==c)return true;if(!a&&c||a&&!c)return false; if(a.isEqual)return a.isEqual(c);if(b.isDate(a)&&b.isDate(c))return a.getTime()===c.getTime();if(b.isNaN(a)&&b.isNaN(c))return true;if(b.isRegExp(a)&&b.isRegExp(c))return a.source===c.source&&a.global===c.global&&a.ignoreCase===c.ignoreCase&&a.multiline===c.multiline;if(d!=="object")return false;if(a.length&&a.length!==c.length)return false;d=b.keys(a);var e=b.keys(c);if(d.length!=e.length)return false;for(var f in a)if(!b.isEqual(a[f],c[f]))return false;return true};b.isEmpty=function(a){return b.keys(a).length== 0};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=function(a){return!!(a&&a.concat&&a.unshift)};b.isArguments=function(a){return a&&b.isNumber(a.length)&&!b.isArray(a)&&!r.call(a,"length")};b.isFunction=function(a){return!!(a&&a.constructor&&a.call&&a.apply)};b.isString=function(a){return!!(a===""||a&&a.charCodeAt&&a.substr)};b.isNumber=function(a){return p.call(a)==="[object Number]"};b.isDate=function(a){return!!(a&&a.getTimezoneOffset&&a.setUTCFullYear)};b.isRegExp=function(a){return!!(a&& a.test&&a.exec&&(a.ignoreCase||a.ignoreCase===false))};b.isNaN=function(a){return b.isNumber(a)&&isNaN(a)};b.isNull=function(a){return a===null};b.isUndefined=function(a){return typeof a=="undefined"};b.noConflict=function(){j._=n;return this};b.identity=function(a){return a};b.breakLoop=function(){throw m;};var s=0;b.uniqueId=function(a){var c=s++;return a?a+c:c};b.template=function(a,c){a=new Function("obj","var p=[],print=function(){p.push.apply(p,arguments);};with(obj){p.push('"+a.replace(/[\r\t\n]/g, " ").replace(/'(?=[^%]*%>)/g,"\t").split("'").join("\\'").split("\t").join("'").replace(/<%=(.+?)%>/g,"',$1,'").split("<%").join("');").split("%>").join("p.push('")+"');}return p.join('');");return c?a(c):a};b.forEach=b.each;b.foldl=b.inject=b.reduce;b.foldr=b.reduceRight;b.filter=b.select;b.every=b.all;b.some=b.any;b.head=b.first;b.tail=b.rest;b.methods=b.functions;var l=function(a,c){return c?b(a).chain():a};b.each(b.functions(b),function(a){var c=b[a];i.prototype[a]=function(){var d=b.toArray(arguments); o.call(d,this._wrapped);return l(c.apply(b,d),this._chain)}});b.each(["pop","push","reverse","shift","sort","splice","unshift"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){c.apply(this._wrapped,arguments);return l(this._wrapped,this._chain)}});b.each(["concat","join","slice"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){return l(c.apply(this._wrapped,arguments),this._chain)}});i.prototype.chain=function(){this._chain=true;return this};i.prototype.value=function(){return this._wrapped}})(); circuits-2.1.0/docs/build/html/_static/docicons-behindscenes.png0000644000014400001440000000433512072034467024462 0ustar prologicusersPNG  IHDR//E pHYs  IDATX ͙kLWYY q>ƂXeSX[Q؆jMiZ4&M%Fjm54>P)Z*"X< *͞0̂m'pswFӧOr<]ZOԨ܅0 p,Gsй;U 3)"ut+膼> MYvp)l2ʥKjo(f Kcxj@>VG+JG0@`~D,bW}TfE_tE;% 8"&΋`1Vtlƍųт/-+'CesqS´`wY\t[P˯dGM@Pԉ.|SMg+\)o$wXl0]µX22$]KV"EZǰ)Qrʱ`,J1A`89I:C8KjuQ|sok`C  ÌƇ]OSu%8`Odeeڽ[YٓI;] t *Ko*haedo'䭨ȡSqGu;KH}uȸ) ɑjժB5vD:0_,Wf4IU^@aJ h#e`Ez sPV2a kCȡ岧tˆ4{O&1]鄹+ǐ^Q Y Ohҽn#edCY ^YAK[lYzuhhh{/$$LFzUC?L .5>(󫪂/+k.4w>~ghs_ &(mly)R!??2ܬٛ.RKw3;6qu`يW#Φ򑑦 ztw#Esl$[OT u*q I 'd})6-M<;Lq5=$)Lܬ{ !'$9DR:8|uGҨ;VJwGG/-kg*gGT#ZEH[R&zA|Y*b|҉{q3m!l!Ey, d̚5kM/ݯ8Շ%YqH JYa-/uC/.ţ=87.pt? ѓXԶoSJjAT*uF8JMIcIj$jwn(PAe o(;ؼR@# 'R"M} Qd4C *AO@Wa{72O)͆`IJhdϏKZ3].ҺG!hQ8"eFs#|0 h܅0 pTҗIENDB`circuits-2.1.0/docs/build/html/howtos/0000755000014400001440000000000012113366740017411 5ustar prologicuserscircuits-2.1.0/docs/build/html/howtos/simple_server.html0000644000014400001440000004560012113366702023161 0ustar prologicusers How To: Build a Simple Server — circuits 2.1.0 documentation

          How To: Build a Simple Server

          Overview

          In this guide we’re going to walk through the steps required to build a simple chat server. Users will connect using a standard telnet client and start chatting with other users that are connected.

          Prerequisites

          Components Used

          Events Used

          Step 1 - Setting up

          Let’s start off by importing the components and events we’ll need.

          #!/usr/bin/env python

from circuits import Component
from circuits.net.sockets import TCPServer, Write

          Step 2 - Building the Server

          Next let’s define our Server Component with a simple event handler that broadcasts all incoming messages to every connected client. We’ll keep a list of clients connected to our server in self._clients.

          We need to define three event handlers.

          1. An event handler to update our list of connected clients when a new client connects.
          2. An event handler to update our list of connected clients when a client has disconnected.
          3. An event handler to handle messages from connected clients and broadcast them to every other connected client.
          class Server(Component):

    def __init__(self, host, port=8000):
        super(Server, self).__init__()

        self._clients = []

        TCPServer((host, port)).register(self)

    def connect(self, sock, host, port):
        self._clients.append(sock)

    def disconnect(self, sock):
        self._clients.remove(sock)

    def read(self, sock, data):
        for client in self._clients:
            if not client == sock:
                self.fire(Write(client, data.strip()))

          Let’s walk through this in details:

          1. Create a new Component called Server
          2. Define its initialization arguments as (host, port=8000)
          3. Call the super constructor of the underlying Component (This is important as all components need to be initialized properly)
          4. Register a TCPServer Component and configure it.
          5. Create Event Handlers for:
            • Dealing with new connecting clients.
            • Dealing with clients whom have disconnected.
            • Dealing with messages from connected clients.

          Step 3 - Running the Server

          The last step is simply to create an instance of the Server Component and run it (making sure to configure it with a host and port).

          Server("localhost").run()

          That’s it!

          Using a standard telnet client try connecting to localhost on port 8000. Try connecting a second client and watch what happens in the 2nd client when you type text into the 1st.

          Enjoy!

          Source Code

           1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
          #!/usr/bin/env python

from circuits import Component
from circuits.net.sockets import TCPServer, Write

class Server(Component):

    def __init__(self, host, port=8000):
        super(Server, self).__init__()

        self._clients = []

        TCPServer((host, port)).register(self)

    def connect(self, sock, host, port):
        self._clients.append(sock)

    def disconnect(self, sock):
        self._clients.remove(sock)

    def read(self, sock, data):
        for client in self._clients:
            if not client == sock:
                self.fire(Write(client, data.strip()))

Server("localhost").run()

          Download simple_server.py

          « previous | up | next »
          circuits-2.1.0/docs/build/html/howtos/index.html0000644000014400001440000001374712113366702021420 0ustar prologicusers HowTos — circuits 2.1.0 documentation
          « previous | up | next »
          circuits-2.1.0/docs/build/html/todo.html0000644000014400001440000001301112113366703017714 0ustar prologicusers Documentation TODO — circuits 2.1.0 documentation

          Documentation TODO

          « previous | up
          circuits-2.1.0/docs/build/html/_sources/0000755000014400001440000000000012113366740017710 5ustar prologicuserscircuits-2.1.0/docs/build/html/_sources/api/0000755000014400001440000000000012113366740020461 5ustar prologicuserscircuits-2.1.0/docs/build/html/_sources/api/circuits_web_dispatchers_websockets.txt0000644000014400001440000000043212113343751030522 0ustar prologicusers:mod:`circuits.web.dispatchers.websockets` -- WebSockets ========================================================= .. automodule :: circuits.web.dispatchers.websockets Events ------ Components ---------- .. autoclass :: WebSockets :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_web_websocket.txt0000644000014400001440000000041212113343751025744 0ustar prologicusers:mod:`circuits.web.websocket` -- WebSocket Client ================================================= .. module :: circuits.web.websocket Events ------ Components ---------- .. autoclass :: WebSocketClient :members: :undoc-members: Functions --------- circuits-2.1.0/docs/build/html/_sources/api/circuits_io_serial.txt0000644000014400001440000000034612072034467025102 0ustar prologicusers:mod:`circuits.io.serial` -- Serial I/O ======================================= .. module :: circuits.io.serial Events ------ **none** Components ---------- .. autoclass :: Serial :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_io_file.txt0000644000014400001440000000033212072034467024535 0ustar prologicusers:mod:`circuits.io.file` -- File I/O =================================== .. module :: circuits.io.file Events ------ **none** Components ---------- .. autoclass :: File :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_node_node.txt0000644000014400001440000000033612072034467025065 0ustar prologicusers:mod:`circuits.node.node` -- Node ================================= .. automodule :: circuits.node.node Events ------ **none** Components ---------- .. autoclass :: Node :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_core_loader.txt0000644000014400001440000000040512072034467025406 0ustar prologicusers:mod:`circuits.core.loader` -- Loader ===================================== .. automodule :: circuits.core.loader Classes ------- **none** Components ---------- .. autoclass :: Loader :members: Events ------ **none** Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_web_servers.txt0000644000014400001440000000042412072034467025457 0ustar prologicusers:mod:`circuits.web.servers` -- Servers ====================================== .. automodule :: circuits.web.servers Events ------ **none** Components ---------- .. autoclass :: BaseServer :members: .. autoclass :: Server :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_web_events.txt0000644000014400001440000000056412072034467025277 0ustar prologicusers.. _circuits_web_events: :mod:`circuits.web.events` -- Events ==================================== .. automodule :: circuits.web.events Events ------ .. autoclass :: WebEvent :members: .. autoclass :: Request :members: .. autoclass :: Response :members: .. autoclass :: Stream :members: Components ---------- **none** Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_net_protocols_http.txt0000644000014400001440000000062312072034467027063 0ustar prologicusers:mod:`circuits.net.protocols.http` -- HTTP Protocol =================================================== .. module :: circuits.net.protocols.http Events ------ .. autoclass :: circuits.net.protocols.http.Request :members: .. autoclass :: circuits.net.protocols.http.Response :members: Components ---------- .. autoclass :: circuits.net.protocols.http.HTTP :members: Functions --------- circuits-2.1.0/docs/build/html/_sources/api/circuits_app_config.txt0000644000014400001440000000055012072034467025236 0ustar prologicusers:mod:`circuits.app.config` -- Application Config ================================================ .. module :: circuits.app.config Events ------ .. autoclass :: circuits.app.config.Load :members: .. autoclass :: circuits.app.config.Save :members: Components ---------- .. autoclass :: circuits.app.config.Config :members: Functions --------- circuits-2.1.0/docs/build/html/_sources/api/circuits_web_loggers.txt0000644000014400001440000000040112072034467025423 0ustar prologicusers:mod:`circuits.web.loggers` -- Loggers ====================================== .. automodule :: circuits.web.loggers Events ------ **none** Components ---------- .. autoclass :: Logger :members: Functions --------- .. autofunction :: formattime circuits-2.1.0/docs/build/html/_sources/api/circuits_app_daemon.txt0000644000014400001440000000056112072034467025236 0ustar prologicusers:mod:`circuits.app.daemon` -- Application Daemon ================================================ .. module :: circuits.app.daemon Events ------ .. autoclass :: circuits.app.daemon.Daemonize :members: .. autoclass :: circuits.app.daemon.WritePID :members: Components ---------- .. autoclass :: circuits.app.daemon.Daemon :members: Functions --------- circuits-2.1.0/docs/build/html/_sources/api/circuits_web_dispatchers_virtualhosts.txt0000644000014400001440000000046112072034467031127 0ustar prologicusers:mod:`circuits.web.dispatchers.virtualhosts` -- Virtual Hosts ============================================================= .. automodule :: circuits.web.dispatchers.virtualhosts Events ------ **none** Components ---------- .. autoclass :: VirtualHosts :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_core_timers.txt0000644000014400001440000000040512072034467025443 0ustar prologicusers:mod:`circuits.core.timers` -- Timers ===================================== .. automodule :: circuits.core.timers Classes ------- **none** Components ---------- .. autoclass :: Timer :members: Events ------ **none** Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_core.txt0000644000014400001440000000067012113343751024057 0ustar prologicusers:mod:`circuits.core` -- Core Functionality ========================================== .. automodule :: circuits.core .. toctree:: :maxdepth: 1 :glob: circuits_core_components circuits_core_events circuits_core_handlers circuits_core_manager circuits_core_values circuits_core_pollers circuits_core_timers circuits_core_loader circuits_core_utils circuits_core_workers circuits_core_debugger circuits-2.1.0/docs/build/html/_sources/api/circuits_core_debugger.txt0000644000014400001440000000042212072034467025723 0ustar prologicusers:mod:`circuits.core.debugger` -- Debugger ========================================= .. automodule :: circuits.core.debugger Classes ------- **none** Components ---------- .. autoclass :: Debugger :members: Events ------ **none** Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_io_events.txt0000644000014400001440000000073712072034467025133 0ustar prologicusers:mod:`circuits.io.events` -- I/O Events ======================================= .. module :: circuits.io.events Events ------ .. autoclass :: Close :members: .. autoclass :: Closed :members: .. autoclass :: EOF :members: .. autoclass :: Error :members: .. autoclass :: Opened :members: .. autoclass :: Read :members: .. autoclass :: Seek :members: .. autoclass :: Write :members: Components ---------- **none** Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_web_dispatchers_static.txt0000644000014400001440000000041312072034467027644 0ustar prologicusers:mod:`circuits.web.dispatchers.static` -- Static ================================================ .. automodule :: circuits.web.dispatchers.static Events ------ **none** Components ---------- .. autoclass :: Static :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_web_sessions.txt0000644000014400001440000000036312072034467025636 0ustar prologicusers:mod:`circuits.web.sessions` -- Sessions ======================================== .. automodule :: circuits.web.sessions Events ------ **none** Components ---------- .. autoclass :: Sessions :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_web_constants.txt0000644000014400001440000000021612072034467026001 0ustar prologicusers:mod:`circuits.web.constants` -- Global Constants ================================================= .. automodule :: circuits.web.constants circuits-2.1.0/docs/build/html/_sources/api/circuits_web_controllers.txt0000644000014400001440000000054012072034467026333 0ustar prologicusers:mod:`circuits.web.controllers` -- Controllers ============================================== .. automodule :: circuits.web.controllers Events ------ **none** Components ---------- .. autoclass :: Controller :members: .. autoclass :: JSONController :members: Functions --------- .. autofunction :: expose .. autofunction :: exposeJSON circuits-2.1.0/docs/build/html/_sources/api/circuits_core_events.txt0000644000014400001440000000102012113343751025431 0ustar prologicusers:mod:`circuits.core.events` -- Events ===================================== .. automodule :: circuits.core.events Classes ------- .. autoclass :: Event :members: Components ---------- **none** Events ------ .. autoclass :: Error .. autoclass :: Failure .. autoclass :: Registered .. autoclass :: Signal .. autoclass :: Started .. autoclass :: Stopped .. autoclass :: Success .. autoclass :: Unregister .. autoclass :: Unregistered .. autoclass :: GenerateEvents :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_web_wsgi.txt0000644000014400001440000000043012072034467024734 0ustar prologicusers:mod:`circuits.web.wsgi` -- WSGI Support ======================================== .. automodule :: circuits.web.wsgi Events ------ **none** Components ---------- .. autoclass :: Application :members: .. autoclass :: Gateway :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_node_server.txt0000644000014400001440000000035212072034467025444 0ustar prologicusers:mod:`circuits.node.server` -- Server ===================================== .. automodule :: circuits.node.server Events ------ **none** Components ---------- .. autoclass :: Server :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_net_protocols.txt0000644000014400001440000000033412072034467026023 0ustar prologicusers:mod:`circuits.net.protocols` -- Networking Protocols ===================================================== .. automodule :: circuits.net.protocols .. toctree:: :maxdepth: 1 :glob: circuits_net_protocols* circuits-2.1.0/docs/build/html/_sources/api/index.txt0000644000014400001440000000030212072034467022326 0ustar prologicusers============= API Reference ============= .. toctree:: :maxdepth: 1 circuits_core circuits_io circuits_net circuits_node circuits_tools circuits_web circuits_app circuits-2.1.0/docs/build/html/_sources/api/circuits_net.txt0000644000014400001440000000024012072034467023713 0ustar prologicusers:mod:`circuits.net` -- Networking ================================= .. automodule :: circuits.net .. toctree:: :maxdepth: 1 :glob: circuits_net* circuits-2.1.0/docs/build/html/_sources/api/circuits_net_sockets.txt0000644000014400001440000000207312113343751025447 0ustar prologicusers:mod:`circuits.net.sockets` -- Socket Components ================================================ .. module :: circuits.net.sockets Events ------ .. autoclass :: Connect .. autoclass :: Connected .. autoclass :: Close .. autoclass :: Closed .. autoclass :: Read .. autoclass :: Write .. autoclass :: SocketError .. autoclass :: Disconnect .. autoclass :: Disconnected Components ---------- .. autoclass :: Client :members: :undoc-members: .. autoclass :: circuits.net.sockets.TCPClient :members: :undoc-members: .. autoclass :: circuits.net.sockets.UDPClient :members: :undoc-members: .. autoclass :: circuits.net.sockets.UNIXClient :members: :undoc-members: .. autoclass :: circuits.net.sockets.Server :members: :undoc-members: .. autoclass :: circuits.net.sockets.TCPServer :members: :undoc-members: .. autoclass :: circuits.net.sockets.UDPServer :members: :undoc-members: .. autoclass :: circuits.net.sockets.UNIXServer :members: :undoc-members: Functions --------- .. autofunction :: circuits.net.sockets.Pipe circuits-2.1.0/docs/build/html/_sources/api/circuits_web_headers.txt0000644000014400001440000000063412072034467025404 0ustar prologicusers:mod:`circuits.web.headers` -- Headers ====================================== .. automodule :: circuits.web.headers Events ------ **none** Classes ------- .. autoclass :: Headers :members: .. autoclass :: HeaderElement :members: .. autoclass :: AcceptElement :members: Components ---------- **none** Functions --------- .. autofunction :: header_elements .. autofunction :: parse_headers circuits-2.1.0/docs/build/html/_sources/api/circuits_app_env.txt0000644000014400001440000000054712072034467024567 0ustar prologicusers:mod:`circuits.app.env` -- Application Environment ================================================== .. module :: circuits.app.env Events ------ .. autoclass :: circuits.app.env.Create :members: .. autoclass :: circuits.app.env.Load :members: Components ---------- .. autoclass :: circuits.app.env.Environment :members: Functions --------- circuits-2.1.0/docs/build/html/_sources/api/circuits_app_log.txt0000644000014400001440000000044312072034467024553 0ustar prologicusers:mod:`circuits.app.log` -- Application Logging ============================================== .. module :: circuits.app.log Events ------ .. autoclass :: circuits.app.log.Log :members: Components ---------- .. autoclass :: circuits.app.log.Logger :members: Functions --------- circuits-2.1.0/docs/build/html/_sources/api/circuits_node_client.txt0000644000014400001440000000035212072034467025414 0ustar prologicusers:mod:`circuits.node.client` -- Client ===================================== .. automodule :: circuits.node.client Events ------ **none** Components ---------- .. autoclass :: Client :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_io_notify.txt0000644000014400001440000000104112072034467025124 0ustar prologicusers:mod:`circuits.io.notify` -- File System Notification ===================================================== .. module :: circuits.io.notify Events ------ .. autoclass :: Accessed :members: .. autoclass :: Closed :members: .. autoclass :: Created :members: .. autoclass :: Deleted :members: .. autoclass :: Modified :members: .. autoclass :: Moved :members: .. autoclass :: Opened :members: .. autoclass :: Unmounted :members: Components ---------- .. autoclass :: Notify :members: Functions --------- circuits-2.1.0/docs/build/html/_sources/api/circuits_core_pollers.txt0000644000014400001440000000060312072034467025620 0ustar prologicusers:mod:`circuits.core.pollers` -- I/O Pollers =========================================== .. automodule :: circuits.core.pollers Classes ------- **none** Components ---------- .. autoclass :: BasePoller :members: .. autoclass :: Select :members: .. autoclass :: Poll :members: .. autoclass :: EPoll :members: Events ------ **none** Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_web_dispatchers_jsonrpc.txt0000644000014400001440000000045012072034467030034 0ustar prologicusers:mod:`circuits.web.dispatchers.jsonrpc` -- JSON-RPC =================================================== .. automodule :: circuits.web.dispatchers.jsonrpc Events ------ .. autoclass :: RPC :members: Components ---------- .. autoclass :: JSONRPC :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_core_utils.txt0000644000014400001440000000062012072034467025277 0ustar prologicusers:mod:`circuits.core.utils` -- Utilities ======================================= .. automodule :: circuits.core.utils Classes ------- **none** Components ---------- **none** Events ------ **none** Functions --------- .. autofunction :: findchannel .. autofunction :: findcmp .. autofunction :: findroot .. autofunction :: findtype .. autofunction :: flatten .. autofunction :: safeimport circuits-2.1.0/docs/build/html/_sources/api/circuits_node.txt0000644000014400001440000000023012072034467024051 0ustar prologicusers:mod:`circuits.node` -- Node ============================ .. automodule :: circuits.node .. toctree:: :maxdepth: 1 :glob: circuits_node* circuits-2.1.0/docs/build/html/_sources/api/circuits_core_workers.txt0000644000014400001440000000044312072034467025636 0ustar prologicusers:mod:`circuits.core.workers` -- Workers ======================================= .. automodule :: circuits.core.workers Classes ------- **none** Components ---------- .. autoclass :: Worker :members: Events ------ .. autoclass :: Task :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_web_utils.txt0000644000014400001440000000055412072034467025132 0ustar prologicusers:mod:`circuits.web.utils` -- Utilities ====================================== .. automodule :: circuits.web.utils Events ------ **none** Components ---------- **none** Functions --------- .. autofunction :: compress .. autofunction :: dictform .. autofunction :: get_ranges .. autofunction :: parse_body .. autofunction :: parse_qs .. autofunction :: url circuits-2.1.0/docs/build/html/_sources/api/circuits_net_protocols_irc.txt0000644000014400001440000000050412072034467026657 0ustar prologicusers:mod:`circuits.net.protocols.irc` -- IRC Protocol ================================================= .. module :: circuits.net.protocols.irc Events ------ .. autoclass :: circuits.net.protocols.irc.RAW :members: Components ---------- .. autoclass :: circuits.net.protocols.irc.IRC :members: Functions --------- circuits-2.1.0/docs/build/html/_sources/api/circuits_web_exceptions.txt0000644000014400001440000000165212072034467026153 0ustar prologicusers:mod:`circuits.web.exceptions` -- Exceptions ============================================ .. automodule :: circuits.web.exceptions Exceptions ---------- .. autoexception :: HTTPException .. autoexception :: BadGateway .. autoexception :: BadRequest .. autoexception :: Forbidden .. autoexception :: Gone .. autoexception :: InternalServerError .. autoexception :: LengthRequired .. autoexception :: MethodNotAllowed .. autoexception :: NotAcceptable .. autoexception :: NotFound .. autoexception :: NotImplemented .. autoexception :: PreconditionFailed .. autoexception :: Redirect .. autoexception :: RequestEntityTooLarge .. autoexception :: RequestTimeout .. autoexception :: RequestURITooLarge .. autoexception :: ServiceUnavailable .. autoexception :: Unauthorized .. autoexception :: UnicodeError .. autoexception :: UnsupportedMediaType Events ------ **none** Components ---------- **none** Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_core_manager.txt0000644000014400001440000000041412072034467025552 0ustar prologicusers:mod:`circuits.core.manager` -- Manager ======================================= .. automodule :: circuits.core.manager Classes ------- .. autoclass :: Manager :members: Components ---------- **none** Events ------ **none** Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_web_http.txt0000644000014400001440000000053112072034467024744 0ustar prologicusers.. _circuits_web_http: :mod:`circuits.web.http` -- HTTP Protocol ========================================= .. automodule :: circuits.web.http Components ---------- .. autoclass :: HTTP :members: :private-members: Events ------ See :class:`circuits.web.events.Request` in :ref:`circuits_web_events`. Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_node_utils.txt0000644000014400001440000000051312072034467025275 0ustar prologicusers:mod:`circuits.node.utils` -- Node Utilities ============================================ .. automodule :: circuits.node.utils Events ------ **none** Components ---------- **none** Functions --------- .. autofunction :: dump_event .. autofunction :: dump_value .. autofunction :: load_event .. autofunction :: load_value circuits-2.1.0/docs/build/html/_sources/api/circuits_core_components.txt0000644000014400001440000000063612072034467026333 0ustar prologicusers:mod:`circuits.core.components` -- Components ============================================= .. automodule :: circuits.core.components Classes ------- .. autoclass :: BaseComponent :members: .. autoclass :: Component :members: Components ---------- **none** Events ------ .. autoclass :: PrepareUnregister :members: .. autoclass :: SingletonError :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_io.txt0000644000014400001440000000023612072034467023541 0ustar prologicusers:mod:`circuits.io` -- I/O Support ================================= .. automodule :: circuits.io .. toctree:: :maxdepth: 1 :glob: circuits_io* circuits-2.1.0/docs/build/html/_sources/api/circuits_core_values.txt0000644000014400001440000000037012072034467025440 0ustar prologicusers:mod:`circuits.core.values` -- Value ==================================== .. automodule :: circuits.core.values Classes ------- .. autoclass :: Value Components ---------- **none** Events ------ **none** Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_app.txt0000644000014400001440000000026212072034467023711 0ustar prologicusers:mod:`circuits.app` -- Application Support ========================================== .. automodule :: circuits.app .. toctree:: :maxdepth: 1 :glob: circuits_app* circuits-2.1.0/docs/build/html/_sources/api/circuits_tools.txt0000644000014400001440000000051012113343751024260 0ustar prologicusers:mod:`circuits.tools` -- Development Tools ========================================== .. module :: circuits.tools Often you will end up needing to do some debugging or inspection of your system. The `circuits.tools` package provides a set of development tools for debugging, inspection and analysis. .. autofunction :: graph circuits-2.1.0/docs/build/html/_sources/api/circuits_web_main.txt0000644000014400001440000000034512072034467024714 0ustar prologicusers:mod:`circuits.web.main` -- circuits.web ======================================== .. automodule :: circuits.web.main Shipped application with static and directory index support suitable for quickly serving up simple web pages. circuits-2.1.0/docs/build/html/_sources/api/circuits_web.txt0000644000014400001440000000024712072034467023711 0ustar prologicusers:mod:`circuits.web` -- Web Framework ==================================== .. automodule :: circuits.web .. toctree:: :maxdepth: 1 :glob: circuits_web_* circuits-2.1.0/docs/build/html/_sources/api/circuits_net_protocols_line.txt0000644000014400001440000000042312072034467027031 0ustar prologicusers:mod:`circuits.net.protocols.line` -- Line Protocol =================================================== .. module :: circuits.net.protocols.line Events ------ .. autoclass :: Line :members: Components ---------- .. autoclass :: LP :members: Functions --------- circuits-2.1.0/docs/build/html/_sources/api/circuits_web_errors.txt0000644000014400001440000000061312072034467025302 0ustar prologicusers:mod:`circuits.web.errors` -- Errors ==================================== .. automodule :: circuits.web.errors Components ---------- **none** Events ------ .. autoclass :: HTTPError :members: .. autoclass :: Forbidden :members: .. autoclass :: NotFound :members: .. autoclass :: Redirect :members: .. autoclass :: Unauthorized :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_node_events.txt0000644000014400001440000000041712072034467025444 0ustar prologicusers:mod:`circuits.node.events` -- Events ===================================== .. automodule :: circuits.node.events Events ------ .. autoclass :: Packet :members: .. autoclass :: Remote :members: Components ---------- **none** Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_core_handlers.txt0000644000014400001440000000051312113343751025733 0ustar prologicusers:mod:`circuits.core.handlers` -- Handlers ========================================= .. automodule :: circuits.core.handlers Classes ------- .. autoclass :: HandlerMetaClass :members: Components ---------- **none** Events ------ **none** Functions --------- .. autofunction :: handler .. autofunction :: reprhandler circuits-2.1.0/docs/build/html/_sources/api/circuits_web_client.txt0000644000014400001440000000041212072034467025241 0ustar prologicusers:mod:`circuits.web.client` -- Client ==================================== .. module :: circuits.web.client Events ------ .. autoclass :: Request :members: Components ---------- .. autoclass :: Client :members: :undoc-members: Functions --------- circuits-2.1.0/docs/build/html/_sources/api/circuits_web_wrappers.txt0000644000014400001440000000066012072034467025633 0ustar prologicusers:mod:`circuits.web.wrappers` -- Request/Response Objects ======================================================== .. module :: circuits.web.wrappers Events ------ **none** Classes ------- .. autoclass :: Body :members: .. autoclass :: Host :members: .. autoclass :: Request :members: .. autoclass :: Response :members: Components ---------- **none** Functions --------- .. autofunction :: file_generator circuits-2.1.0/docs/build/html/_sources/api/circuits_web_tools.txt0000644000014400001440000000072112072034467025126 0ustar prologicusers:mod:`circuits.web.tools` -- Tools ================================== .. automodule :: circuits.web.tools Events ------ **none** Components ---------- **none** Functions --------- .. autofunction :: basic_auth .. autofunction :: check_auth .. autofunction :: digest_auth .. autofunction :: expires .. autofunction :: gzip .. autofunction :: serve_download .. autofunction :: serve_file .. autofunction :: validate_etags .. autofunction :: validate_since circuits-2.1.0/docs/build/html/_sources/api/circuits_web_dispatchers_xmlrpc.txt0000644000014400001440000000044512072034467027667 0ustar prologicusers:mod:`circuits.web.dispatchers.xmlrpc` -- XML-RPC ================================================= .. automodule :: circuits.web.dispatchers.xmlrpc Events ------ .. autoclass :: RPC :members: Components ---------- .. autoclass :: XMLRPC :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/api/circuits_web_dispatchers_dispatcher.txt0000644000014400001440000000045412072034467030510 0ustar prologicusers:mod:`circuits.web.dispatchers.dispatcher` -- Default Dispatcher ================================================================ .. module :: circuits.web.dispatchers.dispatcher Events ------ **none** Components ---------- .. autoclass :: Dispatcher :members: Functions --------- **none** circuits-2.1.0/docs/build/html/_sources/dev/0000755000014400001440000000000012113366740020466 5ustar prologicuserscircuits-2.1.0/docs/build/html/_sources/dev/contributing.txt0000644000014400001440000000315112113343751023733 0ustar prologicusersContributing to circuits ======================== Here's how you can contribute to circuits Share your story ---------------- One of the best ways you can contribute to circuits is by using circuits. Share with us your story of how you've used circuits to solve a problem or create a new software solution using the circuits framework and library of components. See our :doc:`Users Page `. Submitting Bug Reports ---------------------- We welcome all bug reports. We do however prefer bug reports in a clear and concise form with repeatable steps. One of the best ways you can report a bug to us is by writing a unit test (//similar to the ones in our tests//) so that we can verify the bug, fix it and commit the fix along with the test. To submit a bug report, please use: http://bitbucket.org/prologic/circuits/issues Writing new tests ----------------- We're not perfect, and we're still writing more tests to ensure quality code. If you'd like to help, please `Fork circuits-dev `_, write more tests that cover more of our code base and submit a `Pull Request `_. Many Thanks! Adding New Features ------------------- If you'd like to see a new feature added to circutis, then we'd like to hear about it~ We would like to see some discussion around any new features as well as valid use-cases. To start the discussions off, please either: - `Chat to us on #circuits on the FreeNode IRC Network `_ or - `Submit a NEW Issue `_ circuits-2.1.0/docs/build/html/_sources/dev/introduction.txt0000644000014400001440000000131212113343751023742 0ustar prologicusersDevelopment Introduction ======================== Here's how we do things in circuits... Standards --------- We use the following coding standard: - `pep8 `_ Tools ----- We use the following tools to develop circuits and share code: - **Code Sharing:** `Mercurial `_ - **Code Hosting and Bug Reporting:** `BitBucket `_ - **Project Management:** `Pivotal Tracker `_ - **Documentation Hosting:** `Read the Docs `_ - **Package Hosting:** `Python Package Index (PyPi) `_ circuits-2.1.0/docs/build/html/_sources/dev/index.txt0000644000014400001440000000051312113343751022332 0ustar prologicusersDeveloper Docs ============== So, you'd like to contribute to circuits in some way? Got a bug report? Having problems running the examples? Having problems getting circuits working in your environment/platform? Excellent. Here's what you need to know. .. toctree:: :maxdepth: 2 introduction contributing processes circuits-2.1.0/docs/build/html/_sources/dev/processes.txt0000644000014400001440000000356312113343751023241 0ustar prologicusers.. _Pivotal Tracker: http://pivotaltracker.com/projects/695621 Development Processes ===================== We document all our internal development processes here so you know exactly how we work and what to expect. If you find any issues or problems please let us know! Software Development Life Cycle (SDLC) -------------------------------------- We employ the use of the `SCRUM Agile Process `_ and use `Pivotal Tracker`_ to track our stories, bugs, chores and releases. If you wish to contribute to circuits, please famiilarize yourself with SCRUM and Pivotal Tracker. Bug Reports ----------- - New Bug Reports are submitted via: http://bitbucket.org/prologic/circuits/issues - Confirmation and Discussion of all New Bug Reports. - Once confirmed, a new Bug is raised in `Pivotal Tracker`_ into the IceBox. Feature Requests ---------------- - New Feature Requests are submitted via: http://bitbucket.org/prologic/circuits/issues - Confirmation and Discussion of all New Feature Requests. - Once confirmed, a new Feature is raised in `Pivotal Tracker`_ into the IceBox. Writing new Code ---------------- - Write your code. - Use `flake8 `_ to ensure code quality. - Run the tests:: $ tox - Ensure any new or modified code does not break existing unit tests. - Updated any relevant docstrings or documentatino. Running the Tests ----------------- To run the tests you will need the following installed: - `tox `_ instaleld as well as - `pytest-cov `_ - `pytest `_ All of these can be instaleld via ``easy_isntall`` or ``pip``. Please also ensure that you you have all supported versions of Python that circuits supports installed in your local environment. To run the tests:: $ tox circuits-2.1.0/docs/build/html/_sources/man/0000755000014400001440000000000012113366740020463 5ustar prologicuserscircuits-2.1.0/docs/build/html/_sources/man/tools.txt0000644000014400001440000000005512113343751022361 0ustar prologicusersTools ===== .. todo:: Write about this ... circuits-2.1.0/docs/build/html/_sources/man/values.txt0000644000014400001440000000005612113343751022521 0ustar prologicusersValues ====== .. todo:: Write about this... circuits-2.1.0/docs/build/html/_sources/man/manager.txt0000644000014400001440000000006012113343751022627 0ustar prologicusersManager ======= .. todo:: Write about this... circuits-2.1.0/docs/build/html/_sources/man/index.txt0000644000014400001440000000031612113343751022330 0ustar prologicusers====================== The circuits Framework ====================== .. toctree:: :maxdepth: 2 components events handlers .. toctree:: :hidden: values debugging tools manager circuits-2.1.0/docs/build/html/_sources/man/debugging.txt0000644000014400001440000000006512113343751023155 0ustar prologicusersDebugging ========= .. todo:: Write about this ... circuits-2.1.0/docs/build/html/_sources/man/components.txt0000644000014400001440000000264612072034467023423 0ustar prologicusersComponents ========== The architectural concept of circuits is to encapsulate system functionality into discrete manageable and reusable units, called *Components*, that interact by sending and handling events that flow throughout the system. Technically, a circuits *Component* is a Python class that inherits (directly or indirectly) from :class:`~circuits.core.components.BaseComponent`. Components can be sub-classed like any other normal Python class, however components can also be composed of other components and it is natural to do so. These are called *Complex Components*. An example of a Complex Component within the circuits library is the :class:`circuits.web.servers.Server` Component which is comprised of: - :class:`circuits.net.sockets.TCPServer` - :class:`circuits.web.servers.BaseServer` - :class:`circuits.web.http.HTTP` - :class:`circuits.web.dispatchers.dispatcher.Dispatcher` Note that there is no class or other technical means to mark a component as a complex component. Rather, all component instances in a circuits based application belong to some component tree (there may be several), with Complex Components being a subtree within that structure. A Component is attached to the tree by registering with the parent and detached by un-registering itself (methods :meth:`~circuits.core.components.BaseComponent.register` and :meth:`~circuits.core.components.BaseComponent.unregister` of ``BaseComponent``).circuits-2.1.0/docs/build/html/_sources/man/handlers.txt0000644000014400001440000000530012113343751023017 0ustar prologicusersHandlers ======== Explicit Event Handlers ----------------------- Event Handlers are methods of components that are invoked when a matching event is dispatched. These can be declared explicitly on a :class:`~circuits.core.components.BaseComponent` or :class:`~circuits.core.components.Component` or by using the :func:`~circuits.core.handlers.handler` decorator. .. literalinclude:: examples/handler_annotation.py :language: python :linenos: :download:`Download handler_annotation.py ` The handler decorator on line 14 turned the method ``_on_started`` into an event handler for the event ``Started``. Event names used to define handlers are the uncameled class names of the event. An event with a class name ``MySpecialEvent`` becomes "``my_special_event``" when referred to in a handler definition. When defining explicit event handlers in this way, it's convention to use the following pattern:: @handler("foo") def _on_foo(self, ...): ... This makes reading code clear and concise and obvious to the reader that the method is not part of the class's public API (*leading underscore as per Python convention*) and that it is invoked for events of type ``SomeEvent``. The optional keyword argument "``channel``" can be used to attach the handler to a different channel than the component's channel (*as specified by the component's channel attribute*). Handler methods must be declared with arguments and keyword arguments that match the arguments passed to the event upon its creation. Looking at the API for :class:`~circuits.core.events.Started` you'll find that the component that has been started is passed as an argument to its constructor. Therefore, our handler method must declare one argument (*Line 15*). The ``@handler(...)`` decorator accepts other keyword arguments that influence the behavior of the event handler and its invocation. Details can be found in the API description of :func:`~circuits.core.handlers.handler`. Implicit Event Handlers ----------------------- To make things easier for the developer when creating many event handlers and thus save on some typing, the :class:`~circuits.core.components.Component` can be used and subclassed instead which provides an implicit mechanism for creating event handlers. Basically every method in the component is automatically and implicitly marked as an event handler with ``@handler(>`` is the name of each method applied. The only exceptions are: - Methods are start with an underscore ``_``. - Methods already marked explicitly with the ``@handler(...)`` decorator. .. note:: You can specify that a method not be an event handler by marking it with ``@handler(False)``. circuits-2.1.0/docs/build/html/_sources/man/events.txt0000644000014400001440000001006212072034467022531 0ustar prologicusersEvents ====== Basic usage ----------- Events are objects that are fired by the circuits framework implicitly (like the :class:`~circuits.core.events.Started` event used in the tutorial) or explicitly by components while handling some other event. Once fired, events are dispatched to the components that are interested in these events, i.e. that have registered themselves as handlers for these events. Events are usually fired on one or more channels, allowing components to gather in "interest groups". This is especially useful if you want to reuse basic components such as a TCP server. A TCP server component fires a ``Read`` event for every package of data that it receives. If we hadn't the channels, it would be very difficult to separate the data from two different TCP connections. But using the channels, we can put one TCP server and all components interested in its events on one channel, and another TCP server and the components interested in this other TCP server's events on another channel. Components are associated with a channel by setting their ``channel`` attribute (see API description for :class:`~.components.Component`). Besides having a name, events carry additional arbitrary information. This information is passed as arguments or keyword arguments to the constructor. It is then delivered to the handler function that must have exactly the same number of arguments and keyword arguments. Of course, as is usual in Python, you can also pass additional information by setting attributes of the event object, though this usage pattern is discouraged for events. Events as result collectors --------------------------- Apart from delivering information to handlers, event objects may also collect information. If a handler returns something that is not ``None``, it is stored in the event's ``value`` attribute. If a second (or any subsequent) handler invocation also returns a value, the values are stored as a list. Note that the value attribute is of type :class:`~.values.Value` and you must access its property ``value`` to access the data stored (``collected_information = event.value.value``). The collected information can be accessed by handlers in order to find out about any return values from the previously invoked handlers. More useful though, is the possibility to access the information after all handlers have been invoked. After all handlers have run successfully (i.e. no handler has thrown an error) circuits may generate an event that indicates the successful handling. This event has the name of the event just handled with "Success" appended. So if the event is called ``Identify`` then the success event is called ``IdentifySuccess``. Success events aren't delivered by default. If you want successful handling to be indicated for an event, you have to set the optional attribute ``success`` of this event to ``True``. The handler for a success event must be defined with two arguments. When invoked, the first argument is the event just having been handled successfully and the second argument is (as a convenience) what has been collected in ``event.value.value`` (note that the first argument may not be called ``event``, for an explanation of this restriction as well as for an explanation why the method is called ``identify_success`` see the section on handlers). .. literalinclude:: examples/handler_returns.py :language: python :linenos: :download:`Download handler_returns.py ` Advanced usage -------------- Sometimes it may be necessary to take some action when all state changes triggered by an event are in effect. In this case it is not sufficient to wait for the completion of all handlers for this particular event. Rather, we also have to wait until all events that have been fired by those handlers have been processed (and again wait for the events fired by those events' handlers, and so on). To support this scenario, circuits can fire a ``Complete`` event. The usage is similar to the previously described success event. Details can be found in the API description of :class:`circuits.core.events.Event`. circuits-2.1.0/docs/build/html/_sources/web/0000755000014400001440000000000012113366740020465 5ustar prologicuserscircuits-2.1.0/docs/build/html/_sources/web/introduction.txt0000644000014400001440000000727012072034467023757 0ustar prologicusersIntroduction ============ circuits.web is a set of components for building high performance HTTP/1.1 and WSGI/1.0 compliant web applications. These components make it easy to rapidly develop rich, scalable web applications with minimal effort. circuits.web borrows from * `CherryPy `_ * BaseHTTPServer (*Python std. lib*) * wsgiref (*Python std. lib*) Overview -------- The ``circuits.web`` namespace contains the following exported components and events for convenience: Events ~~~~~~ +---------------+-----------------------------------+ | Event | Description | +===============+===================================+ | Request | The Request Event | +---------------+-----------------------------------+ | Response | The Response Event | +---------------+-----------------------------------+ | Stream | The Stream Event | +---------------+-----------------------------------+ Servers ~~~~~~~ +---------------+-----------------------------------+ | Server | Description | +===============+===================================+ | BaseServer | The Base Server (no Dispatcher) | +---------------+-----------------------------------+ | Server | The **full** Server + Dispatcher | +---------------+-----------------------------------+ Error Events ~~~~~~~~~~~~ +---------------+-----------------------------------+ | Error | Description | +===============+===================================+ | HTTPError | A generic HTTP Error Event | +---------------+-----------------------------------+ | Forbidden | A Forbidden (403) Event | +---------------+-----------------------------------+ | NotFound | A Not Found (404) Event | +---------------+-----------------------------------+ | Redirect | A Redirect (30x) Event | +---------------+-----------------------------------+ Dispatchers ~~~~~~~~~~~ +---------------+-----------------------------------+ | Dispatcher | Description | +===============+===================================+ | Static | A Static File Dispatcher | +---------------+-----------------------------------+ | Dispatcher | The Default Dispatcher | +---------------+-----------------------------------+ | VirtualHosts | Virtual Hosts Dispatcher | +---------------+-----------------------------------+ | XMLRPC | XML-RPC Dispatcher | +---------------+-----------------------------------+ | JSONRPC | JSON-RPC Dispatcher | +---------------+-----------------------------------+ Other Components ~~~~~~~~~~~~~~~~ +---------------+-----------------------------------+ | Component | Description | +===============+===================================+ | Logger | Default Logger | +---------------+-----------------------------------+ | Controller | Request Handler Mapper | +---------------+-----------------------------------+ | Sessions | Default Sessions Handler | +---------------+-----------------------------------+ To start working with circuits.web one normally only needs to import from circuits.web, for example: .. code-block:: python :linenos: from circuits import Component from circuits.web import BaseServer class Root(Component): def request(self, request, response): return "Hello World!" (BaseServer(8000) + Root()).run() For further information regarding any of circuits.web's components, events or other modules and functions refer to the API Documentation. circuits-2.1.0/docs/build/html/_sources/web/index.txt0000644000014400001440000000023412113343751022331 0ustar prologicusers========================== The circuits.web Framework ========================== .. toctree:: :maxdepth: 1 introduction gettingstarted basics circuits-2.1.0/docs/build/html/_sources/web/basics.txt0000644000014400001440000000447212072034467022503 0ustar prologicusersThe Basics ========== circuits.web is not a **full stack** web framework, rather it is more closely aligned with `CherryPy `_ and offers enough functionality to make quickly developing web applications easy and as flexible as possible. circuits.web does not provide features such as: * builtin Templating * builtin Database or ORM tools * **etc** The functionality that circutis.web *does* provide ensures that circuits.web is fully HTTP/1.1 and WSGI/1.0 compliant and offers all the essential tools you need to build your web application or website. A Stand Alone Server -------------------- A stand alone server consist of the components shown in section :ref:`web_getting_started`. The process of handling an HTTP request starts with the :class:`~circuits.net.sockets.TCPServer` receiving a chunk of bytes. It emits those bytes as a :class:`~circuits.net.sockets.Read` event on the channel shared by the Server, HTTP, TCPServer and Dispatcher components ("web" by default). The Read events are handled by the :class:`~circuits.web.http.HTTP` component. It collects the chunks until a complete HTTP request has been received. The request is then emitted as a :class:`~circuits.web.events.Request` event with an instance of classes :class:`~circuits.web.wrappers.Request` and :class:`~circuits.web.wrappers.Response` each as arguments. To complete the client's request, a :class:`~circuits.web.events.Response` event must be fired. This is usually done by the HTTP component itself upon the receipt of a ``RequestSuccess`` event (automatically generated after all handlers for the ``Request`` event have been invoked successfully). In case of a problem, the ``Request`` event's handlers should fire or return a :class:`~circuits.web.errors.HTTPError` which is instead converted by the HTTP component to a ``Response`` event. HTTP's handler for the :class:`~circuits.web.events.Response` event retrieves the response information from the event and encodes it as required by HTTP (the protocol). It then fires one or more :class:`~circuits.net.sockets.Write` events which are handled by the TCPServer (and the response is thus sent to the client). More details can be found in :ref:`circuits_web_http`. A commonly used component for handling :class:`~circuits.web.events.Request` events is a dispatcher. [To be continued]circuits-2.1.0/docs/build/html/_sources/web/gettingstarted.txt0000644000014400001440000000312412072034467024260 0ustar prologicusers.. _web_getting_started: Getting Started =============== Just like any application or system built with circuits, a circuits.web application follows the standard Component based design and structure whereby functionality is encapsulated in components. circuits.web itself is designed and built in this fashion. For example a circuits.web Server's structure looks like this: .. image:: ../images/web.png To illustrate the basic steps, we will demonstrate developing your classical "Hello World!" applications in a web-based way with circuits.web To get started, we first import the necessary components: .. code-block:: python from circutis.web import Server, Controller Next we define our first Controller with a single Request Handler defined as our index. We simply return "Hello World!" as the response for our Request Handler. .. code-block:: python class Root(Controller): def index(self): return "Hello World!" This completes our simple web application which will respond with "Hello World!" when anyone accesses it. *Admittedly this is a stupidly simple web application! But circuits.web is very powerful and plays nice with other tools.* Now we need to run the application: .. code-block:: python (Server(8000) + Root()).run() That's it! Navigate to: http://127.0.0.1:8000/ and see the result. Here's the complete code: .. code-block:: python :linenos: from circuits.web import Server, Controller class Root(Controller): def index(self): return "Hello World!" (Server(8000) + Root()).run() Have fun! circuits-2.1.0/docs/build/html/_sources/pypitest.txt0000644000014400001440000000020712072034467022333 0ustar prologicusersPyPi Test Page - Tentative Release ================================== .. include:: ../../README.rst .. include:: ../../RELEASE.rst circuits-2.1.0/docs/build/html/_sources/start/0000755000014400001440000000000012113366740021045 5ustar prologicuserscircuits-2.1.0/docs/build/html/_sources/start/quick.txt0000644000014400001440000000120112113343751022711 0ustar prologicusers.. _pip: http://pypi.python.org/pypi/pip Quick Start Guide ================= The easiest way to download and install circuits is to use the `pip`_ command: .. code-block:: sh $ pip install circuits Now that you have successfully downloaded and installed circuits, let's test that circuits is properly installed and working. First, let's check the installed version: .. code-block:: python >>> import circuits >>> print circuits.__version__ 2.1.0 Try some of the examples in the examples/ directory shipped with the distribution or check out some :doc:`Applications using circuits <../users>` Have fun :) circuits-2.1.0/docs/build/html/_sources/start/downloading.txt0000644000014400001440000000124412113343751024111 0ustar prologicusersDownloading =========== Latest Stable Release --------------------- The latest stable releases can be downloaded from the `Downloads `_ page (*specifically the Tags tab*). Latest Development Source Code ------------------------------ We use `Mercurial `_ for source control and code sharing. The latest development branch can be cloned using the following command: .. code-block:: sh $ hg clone https://bitbucket.org/prologic/circuits/ For further instructions on how to use Mercurial, please refer to the `Mercurial Book `_. circuits-2.1.0/docs/build/html/_sources/start/requirements.txt0000644000014400001440000000140312113343751024324 0ustar prologicusers.. _Python Standard Library: http://docs.python.org/library/ Requirements and Dependencies ============================= - circuits has no **required** dependencies beyond the `Python Standard Library`_. - Python: >= 2.6 or pypy >= 2.0 :Supported Platforms: Linux, FreeBSD, Mac OS X, Windows :Supported Python Versions: 2.6, 2.7, 3.2, 3.3 :Supported pypy Versions: 2.0 Other Optional Dependencies --------------------------- These dependencies are not strictly required and only add additional features. - `pydot `_ -- For rendering component graphs of an application. - `pyinotify `_ -- For asynchronous file system event notifications and the :mod:`circuits.io.notify` module. circuits-2.1.0/docs/build/html/_sources/start/index.txt0000644000014400001440000000016512072034467022721 0ustar prologicusersGetting Started =============== .. toctree:: :maxdepth: 2 quick downloading installing requirements circuits-2.1.0/docs/build/html/_sources/start/installing.txt0000644000014400001440000000173412113343751023754 0ustar prologicusersInstalling ========== Installing from a Source Package -------------------------------- *If you have downloaded a source archive, this applies to you.* .. code-block:: sh $ python setup.py install For other installation options see: .. code-block:: sh $ python setup.py --help install Installing from the Development Repository ------------------------------------------ *If you have cloned the source code repository, this applies to you.* If you have cloned the development repository, it is recommended that you use setuptools and use the following command: .. code-block:: sh $ python setup.py develop This will allow you to regularly update your copy of the circuits development repository by simply performing the following in the circuits working directory: .. code-block:: sh $ hg pull -u .. note:: You do not need to reinstall if you have installed with setuptools via the circuits repository and used setuptools to install in "develop" mode. circuits-2.1.0/docs/build/html/_sources/contributors.txt0000644000014400001440000000101512072034467023205 0ustar prologicusersContributors ============ circuits was originally designed, written and primarily maintained by James Mills (http://prologic.shortcircuit.net.au/). The following users and developers have contributed to circuits: - Alessio Deiana - Dariusz Suchojad - Tim Miller - Holger Krekel - Justin Giorgi - Edwin Marshall - Alex Mayfield - Toni Alatalo - Michael Lipp Anyone not listed here (*apologies as this list is taken directly from Mercurial's churn command and output*). We appreciate any and all contributions to circuits. circuits-2.1.0/docs/build/html/_sources/faq.txt0000644000014400001440000000373512113343751021225 0ustar prologicusers.. _#circuits IRC Channel: http://webchat.freenode.net/?randomnick=1&channels=circuits&uio=d4 .. _Mailing List: http://groups.google.com/group/circuits-users .. faq: Frequently Asked Questions ========================== .. general: General ------- ... What is circuits? circuits is an event-driven framework with a high focus on Component architectures making your life as a software developer much easier. circuits allows you to write maintainable and scalable systems easily ... Can I write networking applications with circuits? Yes absolutely. circuits comes with socket I/O components for tcp, udp and unix sockets with asynchronous polling implementations for select, poll, epoll and kqueue. ... Can I integrate circuits with a GUI library? This is entirely possible. You will have to hook into the GUI's main loop. ... What are the core concepts in circuits? Components and Events. Components are maintainable reusable units of behavior that communicate with other components via a powerful message passing system. ... How would you compare circuits to Twisted? Others have said that circuits is very elegant in terms of it's usage. circuits' component architecture allows you to define clear interfaces between components while maintaining a high level of scalability and maintainability. ... Can Components communicate with other processes? Yes. circuits implements currently component bridging and nodes ... What platforms does circuits support? circuits currently supports Linux, FreeBSD, OSX and Windows and is currently continually tested against Linux and Windows against Python versions 2.6, 2.7, 3.1 and 3.2 ... Can circuits be used for concurrent or distributed programming? Yes. We also have plans to build more distributed components into circuits making distributing computing with circuits very trivial. Got more questions? * Send an email to our `Mailing List`_. * Talk to us online on the `#circuits IRC Channel`_ circuits-2.1.0/docs/build/html/_sources/glossary.txt0000644000014400001440000000021112072034467022310 0ustar prologicusers======== Glossary ======== .. glossary:: :sorted: VCS Version Control System, what you use for versioning your source code circuits-2.1.0/docs/build/html/_sources/howtos/0000755000014400001440000000000012113366740021233 5ustar prologicuserscircuits-2.1.0/docs/build/html/_sources/howtos/index.txt0000644000014400001440000000010512072034467023101 0ustar prologicusers====== HowTos ====== .. toctree:: :maxdepth: 1 simple_server circuits-2.1.0/docs/build/html/_sources/howtos/simple_server.txt0000644000014400001440000000612012072034467024654 0ustar prologicusersHow To: Build a Simple Server ============================= Overview -------- In this guide we're going to walk through the steps required to build a simple chat server. Users will connect using a standard telnet client and start chatting with other users that are connected. Prerequisites ^^^^^^^^^^^^^ - `Python `_ - `circuits `_ Components Used """"""""""""""" - :py:class:`~circuits.core.components.Component` - :py:class:`~circuits.net.sockets.TCPServer` Events Used """"""""""" - :py:class:`~circuits.net.sockets.Write` Step 1 - Setting up ------------------- Let's start off by importing the components and events we'll need. .. code-block:: python #!/usr/bin/env python from circuits import Component from circuits.net.sockets import TCPServer, Write Step 2 - Building the Server ---------------------------- Next let's define our ``Server`` Component with a simple event handler that broadcasts all incoming messages to every connected client. We'll keep a list of clients connected to our server in ``self._clients``. We need to define three event handlers. #. An event handler to update our list of connected clients when a new client connects. #. An event handler to update our list of connected clients when a client has disconnected. #. An event handler to handle messages from connected clients and broadcast them to every other connected client. .. code-block:: python class Server(Component): def __init__(self, host, port=8000): super(Server, self).__init__() self._clients = [] TCPServer((host, port)).register(self) def connect(self, sock, host, port): self._clients.append(sock) def disconnect(self, sock): self._clients.remove(sock) def read(self, sock, data): for client in self._clients: if not client == sock: self.fire(Write(client, data.strip())) Let's walk through this in details: 1. Create a new Component called ``Server`` 2. Define its initialization arguments as ``(host, port=8000)`` 3. Call the super constructor of the underlying Component (*This is important as all components need to be initialized properly*) 4. Register a ``TCPServer`` Component and configure it. 5. Create Event Handlers for: - Dealing with new connecting clients. - Dealing with clients whom have disconnected. - Dealing with messages from connected clients. Step 3 - Running the Server --------------------------- The last step is simply to create an instance of the ``Server`` Component and run it (*making sure to configure it with a host and port*). .. code-block:: python Server("localhost").run() That's it! Using a standard telnet client try connecting to localhost on port 8000. Try connecting a second client and watch what happens in the 2nd client when you type text into the 1st. Enjoy! Source Code ----------- .. literalinclude:: simple_server.py :language: python :linenos: :download:`Download simple_server.py ` circuits-2.1.0/docs/build/html/_sources/index.txt0000644000014400001440000000124012113343751021552 0ustar prologicusers================================ circuits |version| Documentation ================================ :Release: |release| :Date: |today| .. include:: ../../README.rst Contents ======== .. toctree:: :maxdepth: 1 start/index tutorial/index man/index web/index howtos/index api/index dev/index changes users contributors faq .. toctree:: :hidden: glossary users .. ifconfig:: devel .. toctree:: :hidden: pypitest todo Indices and tables ================== * :ref:`Index ` * :ref:`modindex` * :ref:`search` * :doc:`glossary` .. ifconfig:: devel * :doc:`pypitest` * :doc:`todo` circuits-2.1.0/docs/build/html/_sources/todo.txt0000644000014400001440000000006612113343751021415 0ustar prologicusersDocumentation TODO ================== .. todolist:: circuits-2.1.0/docs/build/html/_sources/tutorial/0000755000014400001440000000000012113366740021553 5ustar prologicuserscircuits-2.1.0/docs/build/html/_sources/tutorial/index.txt0000644000014400001440000002547012113343751023430 0ustar prologicusers.. _Python Programming Language: http://www.python.org/ Tutorial ======== Overview -------- Welcome to the circuits tutorial. This 5-minute tutorial will guide you through the basic concepts of circuits. The goal is to introduce new concepts incrementally with walk-through examples that you can try out! By the time you've finished, you should have a good basic understanding of circuits, how it feels and where to go from there. The Component ------------- First up, let's show how you can use the ``Component`` and run it in a very simple application. .. literalinclude:: 001.py :language: python :linenos: :download:`Download 001.py <001.py>` Okay so that's pretty boring as it doesn't do very much! But that's okay... Read on! Let's try to create our own custom Component called ``MyComponent``. .. literalinclude:: 002.py :language: python :linenos: :download:`Download 002.py <002.py>` Okay, so this still isn't very useful! But at least we can create components with the behavior we want. Let's move on to something more interesting... Event Handlers -------------- Let's now extend our little example to say "Hello World!" when its started. .. literalinclude:: 003.py :language: python :linenos: :download:`Download 003.py <003.py>` Here we've created a simple **Event Handler** that listens for events on the "started" channel. Methods defined in a Component are converted into Event Handlers. Running this we get:: Hello World! Alright! We have something slightly more useful! Whoohoo it says hello! .. note:: Press ^C (*CTRL + C*) to exit. Registering Components ---------------------- So now that we've learned how to use a Component, create a custom Component and create simple Event Handlers, let's try something a bit more complex by creating a complex component made up of two simpler ones. Let's create two components: - ``Bob`` - ``Fred`` .. literalinclude:: 004.py :language: python :linenos: :download:`Download 004.py <004.py>` Notice the way we register the two components ``Bob`` and ``Fred`` together ? Don't worry if this doesn't make sense right now. Think of it as putting two components together and plugging them into a circuits board. Running this example produces the following result:: Hello I'm Bob! Hello I'm Fred! Cool! We have two components that each do something and print a simple message on the screen! Complex Components ------------------ Now, what if we wanted to create a Complex Component? Let's say we wanted to create a new Component made up of two other smaller components? We can do this by simply registering components to a Complex Component during initialization. .. literalinclude:: 005.py :language: python :linenos: :download:`Download 005.py <005.py>` So now ``Pound`` is a Component that consists of two other components registered to it: ``Bob`` and ``Fred`` The output of this is identical to the previous:: * * * Hello I'm Bob! Hello I'm Fred! The only difference is that ``Bob`` and ``Fred`` are now part of a more Complex Component called ``Pound``. This can be illustrated by the following diagram: .. graphviz:: digraph G { "Pound-1344" -> "Bob-9b0c"; "Pound-1344" -> "Fred-e98a"; } .. note:: The extra lines in the above output are an ASCII representation of the above graph (*produced by pydot + graphviz*). Cool :-) Component Inheritance --------------------- Since circuits is a framework written for the `Python Programming Language`_ it naturally inherits properties of Object Orientated Programming (OOP) -- such as inheriaence. So let's take our ``Bob`` and ``Fred`` components and create a Base Component called ``Dog`` and modify our two dogs (``Bob`` and ``Fred``) to subclass this. .. literalinclude:: 006.py :language: python :linenos: :download:`Download 006.py <006.py>` Now let's try to run this and see what happens:: Woof! I'm Bob! Woof! I'm Fred! So both dogs barked! Hmmm Component Channels ------------------ What if we only want one of our dogs to bark? How do we do this without causing the other one to bark as well? Easy! Use a separate ``channel`` like so: .. literalinclude:: 007.py :language: python :linenos: :download:`Download 007.py <007.py>` .. note:: Events can be fired with either the ``.fire(...)`` or ``.fireEvent(...)`` method. If you run this, you'll get:: Woof! I'm Bob! Event Objects ------------- So far in our tutorial we have been defining an Event Handler for a builtin Event called ``Started`` (*which incidentally gets fired on a channel called "started"*). What if we wanted to define our own Event Handlers and our own Events? You've already seen how easy it is to create a new Event Handler by simply defining a normal Python method on a Component. Defining your own Events helps with documentation and testing and makes things a little easier. Example:: class MyEvent(Event): """MyEvent""" So here's our example where we'll define a new Event called ``Bark`` and make our ``Dog`` fire a ``Bark`` event when our application starts up. .. literalinclude:: 008.py :language: python :linenos: :download:`Download 008.py <008.py>` If you run this, you'll get:: Woof! I'm Bob! Woof! I'm Fred! The Debugger ------------ Lastly... Asynchronous programming has many advantages but can be a little harder to write and follow. A silently caught exception in an Event Handler, or an Event that never gets fired, or any number of other weird things can cause your application to fail and leave you scratching your head. Fortunately circuits comes with a ``Debugger`` Component to help you keep track of what's going on in your application, and allows you to tell what your application is doing. Let's say that we defined out ``bark`` Event Handler in our ``Dog`` Component as follows:: def bark(self): print("Woof! I'm %s!" % name) Now clearly there is no such variable as ``name`` in the local scope. For reference here's the entire example... .. literalinclude:: 009.py :language: python :linenos: :download:`Download 009.py <009.py>` If you run this, you'll get: That's right! You get nothing! Why? Well in circuits any error or exception that occurs in a running application is automatically caught and dealt with in a way that lets your application "keep on going". Crashing is unwanted behavior in a system so we expect to be able to recover from horrible situations. SO what do we do? Well that's easy. circuits comes with a ``Debugger`` that lets you log all events as well as all errors so you can quickly and easily discover which Event is causing a problem and which Event Handler to look at. If you change Line 34 of our example... From: .. literalinclude:: 009.py :language: python :lines: 34 To: .. code-block:: python from circuits import Debugger (Pound() + Debugger()).run() Then run this, you'll get the following:: , ] {}> , ] {}> , ] {}> , None] {}> , NameError("global name 'name' is not defined",), [' File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent\n retval = handler(*eargs, **ekwargs)\n', ' File "source/tutorial/009.py", line 22, in bark\n print("Woof! I\'m %s!" % name)\n'], >] {}> ERROR (): global name 'name' is not defined File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent retval = handler(*eargs, **ekwargs) File "source/tutorial/009.py", line 22, in bark print("Woof! I'm %s!" % name) , NameError("global name 'name' is not defined",), [' File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent\n retval = handler(*eargs, **ekwargs)\n', ' File "source/tutorial/009.py", line 22, in bark\n print("Woof! I\'m %s!" % name)\n'], >] {}> ERROR (): global name 'name' is not defined File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent retval = handler(*eargs, **ekwargs) File "source/tutorial/009.py", line 22, in bark print("Woof! I'm %s!" % name) ^C] {}> ] {}> ] {}> You'll notice whereas there was no output before there is now a pretty detailed output with the ``Debugger`` added to the application. Looking through the output, we find that the application does indeed start correctly, but when we fire our ``Bark`` Event it coughs up two exceptions, one for each of our dogs (``Bob`` and ``Fred``). From the error we can tell where the error is and roughly where to look in the code. .. note:: You'll notice many other events that are displayed in the above output. These are all default events that circuits has builtin which your application can respond to. Each builtin Event has a special meaning with relation to the state of the application at that point. See: :py:mod:`circuits.core.events` for detailed documentation regarding these events. The correct code for the ``bark`` Event Handler should be:: def bark(self): print("Woof! I'm %s!" % self.name) Running again with our correction results in the expected output:: Woof! I'm Bob! Woof! I'm Fred! That's it folks! Hopefully this gives you a feel of what circuits is all about and an easy tutorial on some of the basic concepts. As you're no doubt itching to get started on your next circuits project, here's some recommended reading: - :doc:`../faq` - :doc:`../howtos/index` - :doc:`../api/index` circuits-2.1.0/docs/build/html/_sources/users.txt0000644000014400001440000000175412072034467021623 0ustar prologicusersUsers ===== Applications written in circuits -------------------------------- - `SahrisWiki `_ a Wiki / CMS / Blogging Engine. - `kdb `_ a pluggable IRC Bot Framework. Applications integrating circuits --------------------------------- - `realXtend `) Next generation virtual worlds viewer; Naali, for Python components. Worked on by Toni Alatalo and Petri Aura at `Playsign ` in collaboration with other realXtend developers. - `PriceWaterHouseCoopers `) `TAMS `_ Report Generator written by James Mills and Michael Anton. - `Mangahelpers `_ Profiler for checking our webpages generation times, SQL and cache queries times, project page on Other Users ----------- - `MIT Media Lab, `_ Uses circuits for several internal prototypes circuits-2.1.0/docs/build/html/_sources/changes.txt0000644000014400001440000002526512113343751022070 0ustar prologicusers:tocdepth: 2 .. _changes: ChangeLog ========= .. include:: ../../CHANGES.rst circuits-2.0.1 20121124 ----------------------- - Fixed ``tests/web/test_main.py`` which was badly written. - Fixed a regression test testing the Debugger component circuits-2.0.0 20121122 (cheetah) --------------------------------- - Fixed circuits.web entry point - Fixed `tools.reprhandler()` for compatibility with Python-3.3 - Added ``*channels`` support to waitEvent - Added example of using .call - Fixed logic around firing the Daemonize event when registering this component during run-time and after start-up - Fixed use of reprhandler - Fixed listening channel for exceptions/errors. - Fixed channels for Log event. - Fixed config loading. Fire a Ready event when the Environment is completely ready. - Added .items(...) method to Config component. - Added BaseEvent, LiteralEvent, DerivedEvent to the core and circuits name-spaces - Fixed IRC protocol - Added has_option to Config component - Avoid error if user un-registers a component twice. - Fixed base_url for WebConsole - Fixed bug with sending Response for a Expect: 100-continue (Closes issue #32) - Added a new circuits.web test that ensures that large posts > 1024 bytes work - Updated conf so that doc can be built even if circuits isn't installed - Updated reference of guide to howtos - Updated man headers so that they weren't all "Components" - Fixed all web dispatcher tests - Fixed XMLRPC dispatcher. Must have a higher priority than the "default" dispatcher in order to coexist with it. - Fixed unit test for failure response from web *component* (component's handler must have higher priority than default dispatcher if default dispatcher exists). - Added failure test for web *controller*. - Fixed JSON dispatcher. Must have a higher priority than the "default" dispatcher in order to coexist with it. - Fixed vpath traversal. vpath created in reverse ("test_args/1/2/3" became "3/2/1/test_args"). - Fixed evaluation of the Complete event: exclude events fired by other threads during event processing from the set of events to be tracked. - Don't call tick on components that are waiting to be unregistered. - Using new PrepareUnregister event to reliably remove sockets from poller. - Fixes for PrepareUnregister and added test case. - Added event that informs components about going to be removed from the tree. - Fixed client request generation (MUST include Host header). - Fixed channel naming in web.Client to allow several clients (i.e. connections to web sites) to coexist in an application. - Prevented uncameling of event names that represent web requests. Handlers can now use the last path segment unmodified as handled event's name. - Fixed the new dispatcher with new tests - Fixed bug in complete event generation. - Added optional event signaling the completion of an event and everything that has been caused by it. - Added the possibility to redirect the success events to other channels. - Updated documentation to reflect the new "handler suspend" feature. - Replaced web dispatcher with simpler version - Added support for x = yield self.callEvent(...) - Made test_main more reliable - Removed old BaseManager from playing with GreenletManager. Fixed test_manager_repr - Fixed the exceptions being thrown for test_eval, but the test still fails - Added a new failing test - evaluation of promised values - Removed superfluous .value in test_longwait - Added support for alllowing future handlers to have a "special" event parameter just like ordinary handlers. - Fixed test_success - Fixed test_removeHandler - Added support for firing Done() and Success() after all done executing. - Fixed callEvent - Added 2 failing tests for yield - Implemented promises which we detect for in circuits.web in cases where an event handler yields. Also only fire _success events after an event is well and truly finished (in the case of yielding event handlers) - Fixed a bug with value not being set - Fixed Issue #26 - Added capability of waiting for a specific event name on a specific channel. - Fixed bug guarding against tasks already removed. - Implemented Component.init() support whereby one can define an alternative init() without needing to remember to call super(...) - Fixed Python 3 compatibility with Unicode strings - Added 99bottles as an example of concurrency. See: http://wiki.python.org/moin/Concurrency/99Bottles - Removed old-style channel targeting - Fixed and tested UDP forwarding - Simplified udpclient example - Implemented new version of port forwarded. TCP tested. - Fixed Read events for UDPServer by setting .notify to True. - Restructured the only How To Guide - Building a Simple Server - Renamed _get_request_handler to just find_handler - Removed channels attribute from WebEvents (fix for issue #29). - Added Eclipse configuration files. - Fixed uses of deprecated syntax in app.config - Modified the defaults for channels. Set channels to event.channels, otherwise self.channel defaulting to * - Fixed uses of deprecated syntax in env - Fixed a bug with the Redirect event/error in circuits.web where it didn't handle Unicode strings - fixed the web dispatcher - Fixed test_poller_reuse test by using the now findtype() utility function - fixed and adds tests for the web dispatcher - Moved parseBody out into circuits.web.utils. Other code cleanup - Added a test for a bug with the dispatcher mehere found. - Removed itercmp() function. Added findtype() findchannel() and used better variable names. findcmp is an alias of findtype. - Implemented optional singleton support for components - Removed the circuits.web `routes` dispatcher as there are no tests for this and Routes dispatcher is broken - re implement at a later stage - Removal of End feedback event - Fixed web/test_value.py - Fixed web futures test - Simplified and fixed a lot of issues the circuits.bench - Fixed circuits.web's exceptions tests and handling of exceptions. - Fixed a potential bug with ``circuits.web.wsgi.Application``. - Modified Manager to only assign a handler return value if it is not None. - Fixed ``*_success`` and ``*_failure`` events fire on ``*event.channels`` so they go to the right place as expected. Fixed Issue #21 - Removed event equality test and related tests. Seems rather useless and inconsistently used - Fixed test_gzip circuits.web test. We no longer have a Started event feedback so have to use a filter - Fixed a corner case where one might be trying to compare an event object with a non-event object - Fixed the event handling for circuits.web WebSockets Component by separating out the WebSockets handling from the HTTP handling (WebSocketsMediator). - Fixed use of Value notification in circuits.web for requests. - Fixed a bunch of examples and tests using deprecated features. - Fixed the notify io driver and removed Debugger() from test_notify. - Added man pages for circuits.bench, circuits.sniff and circuits.web - Wrapped UNIX-specific calls in try/except - Tidied up examples and removed unused imports - removed use of coverage module in daemon test - removed use of coverage module in signals test - updated .push calls to .fire calls - Fixed some deprecations warnings - Added support for multiple webserver with different channels + tests for it - Added support for silently ignoring errors when writing to stderr from debugger - Added requirements.txt file containing requirements for building docs on readthedocs.org - Added link to Read the Docs for circuits - Updated doc message for success event - Fixed interrupt handler to allow ^C to be used to quit sample keyecho app - Removed deprecated modules and functions that were deprecated 1.6 - Deleted old style event success/failure notifiers - Fixed handling of components being added/removed when looking for ticks - Fixed bug with ``net.Server`` .host and .port attributes. - Deprecated ``__tick__``. Event handlers can now be specified as **tick** functions. - Fixed handler priority inheritance to make sure we get the results in the right harder - Fixed missing import of sys in circuits.io circuits-1.6 (oceans) - 20110626 -------------------------------- - Added Python 3 support - 80% Code Coverage - Added optional greenlet support adding two new primitives. ``.waitEvent(...)`` and ``.callEvent(...)``. - Added an example WebSockets server using circuits.web - Added support for specifying a ``Poll`` instance to use when using the ``@future`` decorator to create "future" event handlers. - Added ``add_section``, ``has_section`` and ``set`` methods to ``app.config.Config`` Component. - Added support for running test suite with distutils ``python setup.py test``. - Added a ``_on_signal`` event handler on the ``BaseEnvironment`` Component so that environments can be reloaded by listening to ``SIGHUP`` signals. - Added support for using absolute paths in ``app.env.Environment``. - Added support in circuits.web ``HTTP`` protocol to limit the no. of header fragments. This prevents OOM exploits. - Added a ticks limit to waitEvent - Added deprecation warnings for .push .add and .remove methods - NEW ``Loader`` Component in ``circuits.core`` for simple plugin support. - NEW ``app.env`` and ``app.config`` modules including a new ``app.startup`` modules integrating a common startup for applications. - NEW ``KQueue`` poller - Fixed :bbissue:`17` - Renamed ``circuits.web.main`` module to ``circuits.web.__main__`` so that ``python -m circuits.web`` just works. - Fixed ``Server.host`` and ``Server.port`` properties in ``circuits.net.sockets``. - Fixed :bbissue:`10` - Fixed ``app.Daemon`` Component to correctly open the stderr file. - Fixed triggering of ``Success`` events. - Fixed duplicate broadcast handler in ``UDPServer`` - Fixed duplicate ``Disconnect`` event from being triggered twice on ``Client`` socket components. - Removed dynamic timeout code from ``Select`` poller. - Fixed a bug in the circuits.web ``HTTP`` protocol where headers were not being buffered per client. - Fixes a missing Event ``Closed()`` not being triggered for ``UDPServer``. - Make underlying ``UDPServer`` socket reusable by setting ``SO_REUSEADDR`` - Fixes Server socket being discarded twice on close + disconnect - Socket.write now expects bytes (bytes for python3 and str for python2) - Better handling of encoding in HTTP Component (allow non utf-8 encoding) - Always encode HTTP headers in utf-8 - Fixes error after getting socket.ERRCONNREFUSED - Allows TCPClient to bind to a specific port - Improved docs - Handles closing of UDPServer socket when no client is connected - Adds an un-register handler for components - Allows utils.kill to work from a different thread - Fixes bug when handling "*" in channels and targets - Fixes a bug that could occur when un-registering components - Fixes for CPU usage problems when using circuits with no I/O pollers and using a Timer for timed events circuits-2.1.0/docs/build/html/tutorial/0000755000014400001440000000000012113366740017731 5ustar prologicuserscircuits-2.1.0/docs/build/html/tutorial/index.html0000644000014400001440000013313412113366703021732 0ustar prologicusers Tutorial — circuits 2.1.0 documentation

          Tutorial

          Overview

          Welcome to the circuits tutorial. This 5-minute tutorial will guide you through the basic concepts of circuits. The goal is to introduce new concepts incrementally with walk-through examples that you can try out! By the time you’ve finished, you should have a good basic understanding of circuits, how it feels and where to go from there.

          The Component

          First up, let’s show how you can use the Component and run it in a very simple application.

          1
2
3
4
5
          #!/usr/bin/env python

from circuits import Component

Component().run()

          Download 001.py

          Okay so that’s pretty boring as it doesn’t do very much! But that’s okay... Read on!

          Let’s try to create our own custom Component called MyComponent.

          1
2
3
4
5
6
7
8
          #!/usr/bin/env python

from circuits import Component

class MyComponent(Component):
    """My Component"""

MyComponent().run()

          Download 002.py

          Okay, so this still isn’t very useful! But at least we can create components with the behavior we want.

          Let’s move on to something more interesting...

          Event Handlers

          Let’s now extend our little example to say “Hello World!” when its started.

           1
 2
 3
 4
 5
 6
 7
 8
 9
10
          #!/usr/bin/env python

from circuits import Component

class MyComponent(Component):

    def started(self, *args):
        print("Hello World!")

MyComponent().run()

          Download 003.py

          Here we’ve created a simple Event Handler that listens for events on the “started” channel. Methods defined in a Component are converted into Event Handlers.

          Running this we get:

          Hello World!

          Alright! We have something slightly more useful! Whoohoo it says hello!

          Note

          Press ^C (CTRL + C) to exit.

          Registering Components

          So now that we’ve learned how to use a Component, create a custom Component and create simple Event Handlers, let’s try something a bit more complex by creating a complex component made up of two simpler ones.

          Let’s create two components:

          • Bob
          • Fred
           1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
          #!/usr/bin/env python

from circuits import Component

class Bob(Component):

    def started(self, *args):
        print("Hello I'm Bob!")

class Fred(Component):

    def started(self, *args):
        print("Hello I'm Fred!")

(Bob() + Fred()).run()

          Download 004.py

          Notice the way we register the two components Bob and Fred together ? Don’t worry if this doesn’t make sense right now. Think of it as putting two components together and plugging them into a circuits board.

          Running this example produces the following result:

          Hello I'm Bob!
Hello I'm Fred!

          Cool! We have two components that each do something and print a simple message on the screen!

          Complex Components

          Now, what if we wanted to create a Complex Component? Let’s say we wanted to create a new Component made up of two other smaller components?

          We can do this by simply registering components to a Complex Component during initialization.

           1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
          #!/usr/bin/env python

from circuits import Component
from circuits.tools import graph

class Pound(Component):

    def __init__(self):
        super(Pound, self).__init__()

        self.bob = Bob().register(self)
        self.fred = Fred().register(self)

    def started(self, *args):
        print(graph(self.root))

class Bob(Component):

    def started(self, *args):
        print("Hello I'm Bob!")

class Fred(Component):

    def started(self, *args):
        print("Hello I'm Fred!")

Pound().run()

          Download 005.py

          So now Pound is a Component that consists of two other components registered to it: Bob and Fred

          The output of this is identical to the previous:

          * <Pound/* 3391:MainThread (queued=0, channels=1, handlers=3) [R]>
 * <Bob/* 3391:MainThread (queued=0, channels=1, handlers=1) [S]>
 * <Fred/* 3391:MainThread (queued=0, channels=1, handlers=1) [S]>
Hello I'm Bob!
Hello I'm Fred!

          The only difference is that Bob and Fred are now part of a more Complex Component called Pound. This can be illustrated by the following diagram:

          digraph G { "Pound-1344" -> "Bob-9b0c"; "Pound-1344" -> "Fred-e98a"; }

          Note

          The extra lines in the above output are an ASCII representation of the above graph (produced by pydot + graphviz).

          Cool :-)

          Component Inheritance

          Since circuits is a framework written for the Python Programming Language it naturally inherits properties of Object Orientated Programming (OOP) – such as inheriaence.

          So let’s take our Bob and Fred components and create a Base Component called Dog and modify our two dogs (Bob and Fred) to subclass this.

           1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
          #!/usr/bin/env python

from circuits import Component, Event


class Woof(Event):
    """Woof Event"""


class Pound(Component):

    def __init__(self):
        super(Pound, self).__init__()

        self.bob = Bob().register(self)
        self.fred = Fred().register(self)

    def started(self, *args):
        self.fire(Woof())


class Dog(Component):

    def woof(self):
        print("Woof! I'm %s!" % self.name)


class Bob(Dog):
    """Bob"""


class Fred(Dog):
    """Fred"""

Pound().run()

          Download 006.py

          Now let’s try to run this and see what happens:

          Woof! I'm Bob!
Woof! I'm Fred!

          So both dogs barked! Hmmm

          Component Channels

          What if we only want one of our dogs to bark? How do we do this without causing the other one to bark as well?

          Easy! Use a separate channel like so:

           1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
          #!/usr/bin/env python

from circuits import Component, Event


class Woof(Event):
    """Woof Event"""


class Pound(Component):

    def __init__(self):
        super(Pound, self).__init__()

        self.bob = Bob().register(self)
        self.fred = Fred().register(self)

    def started(self, *args):
        self.fire(Woof(), self.bob)


class Dog(Component):

    def woof(self):
        print("Woof! I'm %s!" % self.name)


class Bob(Dog):
    """Bob"""

    channel = "bob"


class Fred(Dog):
    """Fred"""

    channel = "fred"

Pound().run()

          Download 007.py

          Note

          Events can be fired with either the .fire(...) or .fireEvent(...) method.

          If you run this, you’ll get:

          Woof! I'm Bob!

          Event Objects

          So far in our tutorial we have been defining an Event Handler for a builtin Event called Started (which incidentally gets fired on a channel called “started”). What if we wanted to define our own Event Handlers and our own Events? You’ve already seen how easy it is to create a new Event Handler by simply defining a normal Python method on a Component.

          Defining your own Events helps with documentation and testing and makes things a little easier.

          Example:

          class MyEvent(Event):
   """MyEvent"""

          So here’s our example where we’ll define a new Event called Bark and make our Dog fire a Bark event when our application starts up.

           1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
          #!/usr/bin/env python

from circuits import Component, Event

class Bark(Event):
    """Bark Event"""

class Pound(Component):

    def __init__(self):
        super(Pound, self).__init__()

        self.bob = Bob().register(self)
        self.fred = Fred().register(self)

class Dog(Component):

    def started(self, *args):
        self.fire(Bark())

    def bark(self):
        print("Woof! I'm %s!" % self.name)

class Bob(Dog):
    """Bob"""

    channel = "bob"

class Fred(Dog):
    """Fred"""

    channel = "fred"

Pound().run()

          Download 008.py

          If you run this, you’ll get:

          Woof! I'm Bob!
Woof! I'm Fred!

          The Debugger

          Lastly...

          Asynchronous programming has many advantages but can be a little harder to write and follow. A silently caught exception in an Event Handler, or an Event that never gets fired, or any number of other weird things can cause your application to fail and leave you scratching your head.

          Fortunately circuits comes with a Debugger Component to help you keep track of what’s going on in your application, and allows you to tell what your application is doing.

          Let’s say that we defined out bark Event Handler in our Dog Component as follows:

          def bark(self):
   print("Woof! I'm %s!" % name)

          Now clearly there is no such variable as name in the local scope.

          For reference here’s the entire example...

           1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
          #!/usr/bin/env python

from circuits import Component, Event

class Bark(Event):
    """Bark Event"""

class Pound(Component):

    def __init__(self):
        super(Pound, self).__init__()

        self.bob = Bob().register(self)
        self.fred = Fred().register(self)

class Dog(Component):

    def started(self, *args):
        self.fire(Bark())

    def bark(self):
        print("Woof! I'm %s!" % name)

class Bob(Dog):
    """Bob"""

    channel = "bob"

class Fred(Dog):
    """Fred"""

    channel = "fred"

Pound().run()

          Download 009.py

          If you run this, you’ll get:

          That’s right! You get nothing! Why? Well in circuits any error or exception that occurs in a running application is automatically caught and dealt with in a way that lets your application “keep on going”. Crashing is unwanted behavior in a system so we expect to be able to recover from horrible situations.

          SO what do we do? Well that’s easy. circuits comes with a Debugger that lets you log all events as well as all errors so you can quickly and easily discover which Event is causing a problem and which Event Handler to look at.

          If you change Line 34 of our example...

          From:

          Pound().run()

          To:

          from circuits import Debugger

(Pound() + Debugger()).run()

          Then run this, you’ll get the following:

          <Registered[bob:registered] [<Bob/bob 3191:MainThread (queued=0, channels=2, handlers=2) [S]>, <Pound/* 3191:MainThread (queued=0, channels=5, handlers=5) [R]>] {}>
<Registered[fred:registered] [<Fred/fred 3191:MainThread (queued=0, channels=2, handlers=2) [S]>, <Pound/* 3191:MainThread (queued=0, channels=5, handlers=5) [R]>] {}>
<Registered[*:registered] [<Debugger/* 3191:MainThread (queued=0, channels=1, handlers=1) [S]>, <Pound/* 3191:MainThread (queued=0, channels=5, handlers=5) [R]>] {}>
<Started[*:started] [<Pound/* 3191:MainThread (queued=0, channels=5, handlers=5) [R]>, None] {}>
<Bark[bob:bark] [] {}>
<Bark[fred:bark] [] {}>
<Error[*:exception] [<type 'exceptions.NameError'>, NameError("global name 'name' is not defined",), ['  File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent\n    retval = handler(*eargs, **ekwargs)\n', '  File "source/tutorial/009.py", line 22, in bark\n    print("Woof! I\'m %s!" % name)\n'], <bound method ?.bark of <Bob/bob 3191:MainThread (queued=0, channels=2, handlers=2) [S]>>] {}>
ERROR <listener on ('bark',) {target='bob', priority=0.0}> (<type 'exceptions.NameError'>): global name 'name' is not defined
  File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent
 retval = handler(*eargs, **ekwargs)
  File "source/tutorial/009.py", line 22, in bark
    print("Woof! I'm %s!" % name)

<Error[*:exception] [<type 'exceptions.NameError'>, NameError("global name 'name' is not defined",), ['  File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent\n    retval = handler(*eargs, **ekwargs)\n', '  File "source/tutorial/009.py", line 22, in bark\n    print("Woof! I\'m %s!" % name)\n'], <bound method ?.bark of <Fred/fred 3191:MainThread (queued=0, channels=2, handlers=2) [S]>>] {}>
ERROR <listener on ('bark',) {target='fred', priority=0.0}> (<type 'exceptions.NameError'>): global name 'name' is not defined
  File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent
    retval = handler(*eargs, **ekwargs)
  File "source/tutorial/009.py", line 22, in bark
    print("Woof! I'm %s!" % name)

^C<Signal[*:signal] [2, <frame object at 0x808e8ec>] {}>
<Stopped[*:stopped] [<Pound/* 3191:MainThread (queued=0, channels=5, handlers=5) [S]>] {}>
<Stopped[*:stopped] [<Pound/* 3191:MainThread (queued=0, channels=5, handlers=5) [S]>] {}>

          You’ll notice whereas there was no output before there is now a pretty detailed output with the Debugger added to the application. Looking through the output, we find that the application does indeed start correctly, but when we fire our Bark Event it coughs up two exceptions, one for each of our dogs (Bob and Fred).

          From the error we can tell where the error is and roughly where to look in the code.

          Note

          You’ll notice many other events that are displayed in the above output. These are all default events that circuits has builtin which your application can respond to. Each builtin Event has a special meaning with relation to the state of the application at that point.

          See: circuits.core.events for detailed documentation regarding these events.

          The correct code for the bark Event Handler should be:

          def bark(self):
    print("Woof! I'm %s!" % self.name)

          Running again with our correction results in the expected output:

          Woof! I'm Bob!
Woof! I'm Fred!

          That’s it folks!

          Hopefully this gives you a feel of what circuits is all about and an easy tutorial on some of the basic concepts. As you’re no doubt itching to get started on your next circuits project, here’s some recommended reading:

          « previous | up | next »
          circuits-2.1.0/docs/build/html/objects.inv0000644000014400001440000000731412113366704020242 0ustar prologicusers# Sphinx inventory version 2 # Project: circuits # Version: 2.1.0 # The remainder of this file is compressed using zlib. xڭ]Ks6ϯpjDx˞䦂IHƚ  R@7 X[ ~|hdxq8Uc/O/-mI^hۧFt iqRUũK %"<ԏ觜dI_vrٌIjoååv,S24~߫56MyWћ'=ߞ/E%*?!TJF!i1~"%7o///~5_:%9\O3:"W^LkeդJSA$5"W)7PƮ{<Ŗ6Al :׉6Iͦ:ɴ輇VgﴉΟZmV3bxp,~t|k::To?\:X:nPxB.w,d'GV~$BD#Fsz6hR27aOD\v{&h먯gNNjIU{6ޟmY ؋Vl J6~Nv` 1B2QIS2nxa7劰fpR r5+=;K ُپGQܰ1c`bX'hk;m"잙Y=8v ĥ>7p1256N-i9yC4F#˩h$$EgY&d](ljQw`a7TܚȻ.jY⢰nplMaL{0(1]ƅnb%$JƋH@Ǵ?gz *ɡe<40q/2:"A(2rpZ6}i>RhsձG2N"Ha`P@in``D7X1 ʣ}VVdŎSϾ/fC֊Ɗ'/- ~q랷ҭ_7ڶ8` =`NmL>/p,z[U|;^ *ns_I)vᐓ7koJ5&ǦZm;76ӀIt㿣/h576̛S:Z)GlZ8rc1a"d :l+usKzPz $uj~Z~yjoUK!aʓYxɶ"&) ZԲ ^bDbgHLKukdќEuT޶@ ӡ _~1F\N^Gu3šn.5RJ ㅉ5 =]Mk@amqIX ZhZ!Y< 6+}]H!eDe:vI:b3El o;mv;ZZ6$WUPhI)0ϨŌ 5+Tm;("3hzq]yݔ%J?Ez?GZBЌA F8E\O)/ V> m/LLf`禕Kߒ3S#Mim;G"Btn@"w{$:{tkl&:!1_8˩4/l/mr {!,5qh wy nt vk-\:XO}ܰYyPnnƽ7J!Hi|«B1 kRrliYe g}]2؋MgWN]јcnUմ6y* quNcgPU-o\X71`&3q{]dӐ N`WuLeAk횚۳CgF9 pRC_L яJ*+>?ʷcircuits-2.1.0/docs/build/html/searchindex.js0000644000014400001440000015253612113366704020735 0ustar prologicusersSearch.setIndex({objects:{"circuits.web.headers":{HeaderElement:[63,1,1,""],Headers:[63,1,1,""],header_elements:[63,4,1,""],parse_headers:[63,4,1,""],AcceptElement:[63,1,1,""]},"circuits.core.debugger":{Debugger:[17,1,1,""]},"circuits.net.sockets.UDPServer":{write:[68,2,1,""],close:[68,2,1,""],broadcast:[68,2,1,""],socket_family:[68,3,1,""]},"circuits.web.websocket":{WebSocketClient:[51,1,1,""]},"circuits.core.components.PrepareUnregister":{in_subtree:[48,2,1,""]},"circuits.web.exceptions":{Redirect:[84,5,1,""],NotFound:[84,5,1,""],RequestURITooLarge:[84,5,1,""],HTTPException:[84,5,1,""],Unauthorized:[84,5,1,""],Gone:[84,5,1,""],LengthRequired:[84,5,1,""],RequestTimeout:[84,5,1,""],PreconditionFailed:[84,5,1,""],RequestEntityTooLarge:[84,5,1,""],NotAcceptable:[84,5,1,""],ServiceUnavailable:[84,5,1,""],BadRequest:[84,5,1,""],InternalServerError:[84,5,1,""],UnicodeError:[84,5,1,""],UnsupportedMediaType:[84,5,1,""],BadGateway:[84,5,1,""],Forbidden:[84,5,1,""],MethodNotAllowed:[84,5,1,""],NotImplemented:[84,5,1,""]},"circuits.app.config":{Load:[89,1,1,""],Save:[89,1,1,""],Config:[89,1,1,""]},"circuits.io.notify":{Unmounted:[61,1,1,""],Created:[61,1,1,""],Deleted:[61,1,1,""],Moved:[61,1,1,""],Modified:[61,1,1,""],Notify:[61,1,1,""],Closed:[61,1,1,""],Accessed:[61,1,1,""],Opened:[61,1,1,""]},"circuits.web.errors":{Redirect:[44,1,1,""],NotFound:[44,1,1,""],Forbidden:[44,1,1,""],HTTPError:[44,1,1,""],Unauthorized:[44,1,1,""]},"circuits.core.values":{Value:[36,1,1,""]},"circuits.app":{daemon:[29,0,1,""],config:[89,0,1,""],log:[5,0,1,""],env:[79,0,1,""]},"circuits.net.sockets.TCPClient":{connect:[68,2,1,""],socket_family:[68,3,1,""]},"circuits.core.events.GenerateEvents":{reduce_time_left:[69,2,1,""],time_left:[69,3,1,""]},"circuits.web.headers.AcceptElement":{qvalue:[63,3,1,""]},"circuits.node.client":{Client:[77,1,1,""]},"circuits.app.log":{Logger:[5,1,1,""],Log:[5,1,1,""]},"circuits.node.node":{Node:[15,1,1,""]},"circuits.core.components":{SingletonError:[48,1,1,""],Component:[48,1,1,""],BaseComponent:[48,1,1,""],PrepareUnregister:[48,1,1,""]},"circuits.web.headers.HeaderElement":{parse:[63,6,1,""],from_str:[63,7,1,""]},"circuits.web.websocket.WebSocketClient":{close:[51,2,1,""],connected:[51,3,1,""],channel:[51,3,1,""]},"circuits.net.protocols":{line:[16,0,1,""],irc:[4,0,1,""],http:[45,0,1,""]},"circuits.node.server":{Server:[25,1,1,""]},"circuits.web.http.HTTP":{"_on_httperror":[24,2,1,""],"_on_request_success":[24,2,1,""],"_on_response":[24,2,1,""],"_on_read":[24,2,1,""]},"circuits.node.events":{Remote:[35,1,1,""],Packet:[35,1,1,""]},"circuits.web.dispatchers.virtualhosts":{VirtualHosts:[3,1,1,""]},"circuits.web.dispatchers":{jsonrpc:[59,0,1,""],xmlrpc:[66,0,1,""],virtualhosts:[3,0,1,""],"static":[14,0,1,""],dispatcher:[26,0,1,""],websockets:[67,0,1,""]},"circuits.web.controllers":{JSONController:[81,1,1,""],exposeJSON:[81,4,1,""],expose:[81,4,1,""],Controller:[81,1,1,""]},"circuits.core.components.BaseComponent":{unregister:[48,2,1,""],handles:[48,7,1,""],register:[48,2,1,""],handlers:[48,7,1,""]},"circuits.web.tools":{expires:[90,4,1,""],basic_auth:[90,4,1,""],validate_etags:[90,4,1,""],serve_download:[90,4,1,""],serve_file:[90,4,1,""],validate_since:[90,4,1,""],gzip:[90,4,1,""],digest_auth:[90,4,1,""],check_auth:[90,4,1,""]},"circuits.web.dispatchers.static":{Static:[14,1,1,""]},"circuits.core.events":{Unregistered:[69,1,1,""],Registered:[69,1,1,""],Success:[69,1,1,""],Started:[69,1,1,""],Signal:[69,1,1,""],Unregister:[69,1,1,""],GenerateEvents:[69,1,1,""],Failure:[69,1,1,""],Stopped:[69,1,1,""],Error:[69,1,1,""],Event:[69,1,1,""]},"circuits.web.wrappers.Request":{server:[41,3,1,""]},"circuits.web.client":{Client:[49,1,1,""],Request:[49,1,1,""]},"circuits.net.protocols.irc.IRC":{line:[4,2,1,""]},"circuits.node.utils":{load_value:[56,4,1,""],dump_event:[56,4,1,""],dump_value:[56,4,1,""],load_event:[56,4,1,""]},"circuits.io.serial":{Serial:[83,1,1,""]},"circuits.web.http":{HTTP:[24,1,1,""]},"circuits.app.env":{Environment:[79,1,1,""],Load:[79,1,1,""],Create:[79,1,1,""]},"circuits.core.manager":{Manager:[32,1,1,""]},"circuits.net.sockets.TCPServer":{parse_bind_parameter:[68,2,1,""],socket_family:[68,3,1,""]},"circuits.web.events":{Stream:[54,1,1,""],Request:[54,1,1,""],Response:[54,1,1,""],WebEvent:[54,1,1,""]},"circuits.net":{sockets:[68,0,1,""],protocols:[10,0,1,""]},"circuits.app.daemon":{WritePID:[29,1,1,""],Daemon:[29,1,1,""],Daemonize:[29,1,1,""]},"circuits.core.utils":{findcmp:[30,4,1,""],findchannel:[30,4,1,""],safeimport:[30,4,1,""],findroot:[30,4,1,""],findtype:[30,4,1,""],flatten:[30,4,1,""]},"circuits.io.file":{File:[80,1,1,""]},"circuits.web.headers.Headers":{elements:[63,2,1,""],setdefault:[63,2,1,""],get_all:[63,2,1,""],keys:[63,2,1,""],items:[63,2,1,""],get:[63,2,1,""],add_header:[63,2,1,""],has_key:[63,2,1,""],values:[63,2,1,""]},"circuits.web.events.Request":{create:[54,7,1,""]},"circuits.io.events":{EOF:[19,1,1,""],Read:[19,1,1,""],Write:[19,1,1,""],Closed:[19,1,1,""],Error:[19,1,1,""],Close:[19,1,1,""],Seek:[19,1,1,""],Opened:[19,1,1,""]},"circuits.web.dispatchers.dispatcher":{Dispatcher:[26,1,1,""]},"circuits.net.sockets":{SocketError:[68,1,1,""],TCPClient:[68,1,1,""],Disconnect:[68,1,1,""],UDPClient:[68,3,1,""],UNIXClient:[68,1,1,""],Read:[68,1,1,""],TCPServer:[68,1,1,""],Server:[68,1,1,""],Write:[68,1,1,""],Pipe:[68,4,1,""],Client:[68,1,1,""],Connected:[68,1,1,""],Connect:[68,1,1,""],Closed:[68,1,1,""],UDPServer:[68,1,1,""],Close:[68,1,1,""],UNIXServer:[68,1,1,""],Disconnected:[68,1,1,""]},"circuits.core.timers":{Timer:[40,1,1,""]},"circuits.core.timers.Timer":{reset:[40,2,1,""]},"circuits.net.protocols.http":{Request:[45,1,1,""],HTTP:[45,1,1,""],Response:[45,1,1,""]},"circuits.core.pollers":{Poll:[8,1,1,""],EPoll:[8,1,1,""],Select:[8,1,1,""],BasePoller:[8,1,1,""]},"circuits.core.loader":{Loader:[23,1,1,""]},"circuits.web.wrappers":{Body:[41,1,1,""],Host:[41,1,1,""],Request:[41,1,1,""],Response:[41,1,1,""],file_generator:[41,4,1,""]},"circuits.node":{node:[15,0,1,""],utils:[56,0,1,""],client:[77,0,1,""],events:[35,0,1,""],server:[25,0,1,""]},"circuits.web.sessions":{Sessions:[39,1,1,""]},"circuits.web.loggers":{Logger:[1,1,1,""],formattime:[1,4,1,""]},"circuits.core":{workers:[50,0,1,""],"debugger":[17,0,1,""],handlers:[22,0,1,""],utils:[30,0,1,""],loader:[23,0,1,""],manager:[32,0,1,""],values:[36,0,1,""],components:[48,0,1,""],timers:[40,0,1,""],pollers:[8,0,1,""],events:[69,0,1,""]},"circuits.web.utils":{parse_qs:[55,4,1,""],compress:[55,4,1,""],parse_body:[55,4,1,""],url:[55,4,1,""],dictform:[55,4,1,""],get_ranges:[55,4,1,""]},"circuits.web.servers":{BaseServer:[70,1,1,""],Server:[70,1,1,""]},"circuits.net.sockets.Server":{write:[68,2,1,""],host:[68,3,1,""],connected:[68,3,1,""],close:[68,2,1,""],parse_bind_parameter:[68,2,1,""],port:[68,3,1,""],channel:[68,3,1,""]},circuits:{node:[58,0,1,""],core:[18,0,1,""],web:[87,0,1,""],app:[21,0,1,""],io:[7,0,1,""],net:[91,0,1,""],tools:[53,0,1,""]},"circuits.net.sockets.Client":{write:[68,2,1,""],close:[68,2,1,""],connected:[68,3,1,""],channel:[68,3,1,""],parse_bind_parameter:[68,2,1,""]},"circuits.net.protocols.irc":{RAW:[4,1,1,""],IRC:[4,1,1,""]},"circuits.net.sockets.UNIXClient":{ready:[68,2,1,""],connect:[68,2,1,""]},"circuits.io":{serial:[83,0,1,""],events:[19,0,1,""],file:[80,0,1,""],notify:[61,0,1,""]},"circuits.core.manager.Manager":{callEvent:[32,2,1,""],run:[32,2,1,""],name:[32,3,1,""],fire:[32,2,1,""],pid:[32,3,1,""],stop:[32,2,1,""],start:[32,2,1,""],running:[32,3,1,""],call:[32,2,1,""],flush:[32,2,1,""],flushEvents:[32,2,1,""],tick:[32,2,1,""],fireEvent:[32,2,1,""]},"circuits.web.wsgi":{Application:[72,1,1,""],Gateway:[72,1,1,""]},"circuits.tools":{graph:[53,4,1,""]},"circuits.web.dispatchers.jsonrpc":{RPC:[59,1,1,""],JSONRPC:[59,1,1,""]},"circuits.web.client.Client":{request:[49,2,1,""],write:[49,2,1,""],connected:[49,3,1,""],connect:[49,2,1,""],close:[49,2,1,""],response:[49,3,1,""],channel:[49,3,1,""]},"circuits.web.dispatchers.websockets":{WebSockets:[67,1,1,""]},"circuits.web":{wrappers:[41,0,1,""],loggers:[1,0,1,""],wsgi:[72,0,1,""],errors:[44,0,1,""],websocket:[51,0,1,""],sessions:[39,0,1,""],utils:[55,0,1,""],servers:[70,0,1,""],controllers:[81,0,1,""],headers:[63,0,1,""],client:[49,0,1,""],exceptions:[84,0,1,""],http:[24,0,1,""],main:[46,0,1,""],tools:[90,0,1,""],events:[54,0,1,""],constants:[88,0,1,""]},"circuits.core.handlers":{HandlerMetaClass:[22,1,1,""],handler:[22,4,1,""],reprhandler:[22,4,1,""]},"circuits.web.dispatchers.xmlrpc":{RPC:[66,1,1,""],XMLRPC:[66,1,1,""]},"circuits.net.protocols.line":{Line:[16,1,1,""],LP:[16,1,1,""]},"circuits.core.workers":{Task:[50,1,1,""],Worker:[50,1,1,""]}},terms:{content_length:55,abvious:52,prefix:[3,17],sleep:52,artbritrari:52,kqueue:[12,52],typeerror:[52,69],sorri:52,under:[37,13,52],everi:[5,74,54,61,69,89,19,47,29,45,66,79,78,59,32,16,35],mime_typ:90,upstream:84,affect:16,configev:89,"__nonzero__":52,ooop:52,readthedoc:52,miller:75,direct:[53,32],preconditionfail:84,enjoi:47,second:[90,32,16,74,47],follow:[90,42,28,75,2,13,76,11,78,32,65,16,60],panda:52,even:[22,52],hide:52,tipl:16,neg:32,weren:52,petri:86,"new":[0,4,79,32,60,36,38,8,63,41,42,84,13,44,47,48,68,17,49,50,23,52],net:[68,37,86,75,85,82,91,13,51,47,4,45,10,52,16],tcpclient:[68,51,52,16],widget:[37,13],subtre:[85,48],behavior:[5,42,54,61,69,12,19,29,45,48,89,79,78,59,52,16,35,66],never:[68,42,52,84],here:[42,38,0,75,2,65,52,60],debugg:[17,18,42,74,78,52],path:[68,67,55,49,70,3,79,29,14,66,41,23,59,90,52],interpret:52,datetim:[40,90],sturctur:53,time_left:69,brought:52,unix:[70,12,52],"_on_foo":78,txt:52,unit:[52,12,38,60,85],describ:74,would:[37,74,38,12,13,22,84,52],call:[90,42,74,55,69,85,4,66,84,59,32,52,47],typo:52,recommend:[28,8,42,13,37],type:[74,54,29,79,78,59,35,5,37,61,16,66,84,42,13,45,89,90,47,69,19,22,52],until:[27,69,40,74,22,24,32],init_arg:23,notif:[36,61,52,7,20],notic:42,warn:[90,52],test_process:52,moin:52,hold:[5,54,61,69,89,19,29,45,66,41,79,59,90,16,35],must:[5,27,54,61,69,79,19,74,89,29,4,22,66,45,63,78,59,90,52,16,35],accid:52,restor:52,setup:[28,51,13,52,37],work:[42,28,0,50,37,13,76,73,52,16,60,86],rework:52,root:[42,55,2,76,30,22,32,52,48],overrid:[5,54,61,69,89,19,29,22,66,45,79,59,16,35],give:42,synchron:[37,13],indic:[37,74,55,69,90,32],liter:[53,54,55,1,56,3,79,67,77,29,30,45,58,59,32,35,5,80,61,39,81,40,7,91,8,63,66,41,10,72,36,84,44,83,87,14,88,46,89,90,15,16,48,69,68,17,18,49,50,70,19,4,21,51,22,23,24,25,26],unavail:84,want:[68,42,74,69,22,84],end:[53,32,52],coroutin:[37,13,52],ordinari:[51,52],length:[52,84],classifi:52,how:[37,38,42,11,65,12,13,47,64,52,16,60],fireev:[42,32,48],env:[42,74,21,79,78,52,47],cheetah:52,ancestor:48,config:[89,52,81,21],updat:[28,69,47,32,52,16,60],timedelta:90,after:[27,40,74,29,22,24,52,32,48],lab:86,diagram:42,badli:52,wrong:52,demonstr:[2,52],attempt:84,classmethod:[63,54,48],credenti:90,exclud:52,perform:[37,28,50,13,76,41,32,52,90],maintain:[37,75,12,13,32,48],environ:[79,52,0,60,21],incorpor:[37,13],order:[74,22,63,41,90,52],origin:[5,54,55,69,75,79,19,63,29,45,66,89,61,59,52,16,35],sslserver:52,feedback:[37,13,52],over:[59,52,16,66],failur:[51,54,52,69],findchannel:[30,52],appar:52,dictform:55,flexibl:[70,27],digest:90,connec:52,fix:[38,63,13,52],"__class__":[17,74,80,81,50,41,23,32,72,16,48],inadvert:52,better:[37,13,52],"__handleev":42,persist:[40,39],easier:[78,37,12,13,42],them:[42,52,47,67],basemanag:52,thei:[69,50,63,84,52,48],proce:52,"break":[90,60],promis:[36,52],interrupt:[22,52,69],alex:75,changelog:[37,52],timeout:[8,83,52,32,84],each:[17,27,55,37,42,13,78,32,16],debug:[31,17,52,53],went:84,famiilar:60,side:[68,24],mean:[42,32,48,85],resum:[52,69],forgot:52,extract:[37,13],network:[37,38,82,12,13,91,10,52],content:[37,63,84,24,52,90],rewrit:52,adapt:[52,84],reader:78,got:[12,0],navig:2,situat:42,standard:[37,0,2,13,20,44,84,24,65,47],resums:52,findroot:30,md5:90,reconfigur:52,workaround:52,traceback:[69,84],filter:[17,22,52,69],unabl:84,regress:52,onto:3,writepid:29,rang:[55,52],render:[20,84],independ:[84,50],thereof:24,restrict:74,hook:12,instruct:11,alreadi:[40,42,78,52,90],wrapper:[87,52,41],payload:52,badrequest:84,tox:[52,60],top:32,sometim:[32,52,74],mercuri:[11,65,75],too:[63,52,84],listen:[68,42,4,52,67],namespac:76,tool:[42,27,0,53,2,65,87,82,46,9,90,52],setuptool:[28,23],technic:85,target:[42,52],keyword:[5,74,54,61,69,50,40,79,19,89,29,22,48,45,63,78,59,16,35,66],provid:[37,27,69,53,13,7,84,79,78,32,52,90,48],tree:[85,52,48],zero:90,project:[37,86,13,65,42],minut:42,fashion:[2,67,51,90],websocket:[87,67,51,52],add_head:63,raw:[4,24],increment:[42,52],"__main__":52,seen:42,seem:52,churn:75,seek:19,minu:55,realm:90,transmit:84,simplifi:52,though:74,usernam:90,object:[74,54,42,29,79,59,32,35,5,61,63,66,41,36,87,45,89,16,69,19,22,24,52],deleg:32,regular:40,bind_paramet:68,orderli:[67,51],don:[42,52,69,84],doc:[37,52,13,0,65],flow:85,dog:[42,74],doe:[42,27,55,12,70,63,84,60],mayfield:75,declar:[5,54,61,69,89,19,29,22,48,45,79,78,59,16,35,66],changeset:52,has_kei:[63,52],bomb:52,mostli:[52,84],random:52,syntax:52,identifi:74,chnage:52,absolut:[55,12,52],configur:[3,79,52,47,29],apach:14,latenc:52,rich:76,ptest:52,fallbackgener:52,test_main:52,environmentev:79,likewis:90,stop:[42,32,52,69,55],report:[65,38,0,60,86],updatebuff:16,recalcul:40,earg:42,"public":78,twice:52,requestsuccess:[24,27],respond:[2,42],test_filenam:52,result:[5,36,74,54,43,69,42,2,79,19,89,29,22,48,45,61,59,52,16,35,66],respons:[27,54,55,49,84,2,44,76,87,45,41,63,24,52,90],fail:[42,90,52,69,84],themselv:[74,52],best:38,said:12,hopefulli:[42,52],databas:27,py32:52,test_fil:52,simplest:[37,22,13],awai:84,irc:[37,38,86,12,13,4,91,10,52],attribut:[5,45,74,54,61,69,89,19,29,22,48,32,79,78,59,24,52,16,35,66],accord:52,extend:[42,63,79],extens:90,expos:[4,52,16,81],cov:[52,60],howev:[85,4,38],against:[55,90,12,52],logic:52,com:[3,86],deiana:75,toni:[86,75],"_on_request_success":24,loader:[18,52,23],guid:[42,73,52,47,57],assum:[55,52,70],speak:84,question:[37,12,13,42],jsoncontrol:81,three:47,been:[27,54,42,74,29,79,78,59,32,35,5,61,63,66,36,45,89,16,69,19,51,22,24,52],much:[37,42,12,13,51,52],interest:[42,74],basic:[42,27,43,69,2,74,62,84,78,90],"__doc__":[17,80,81,50,41,23,32,72,16,48],vpath:52,quickli:[42,27,46],life:[12,0,60],"_sock":52,xxx:52,worker:[18,52,50],telnet:47,ani:[68,37,74,38,69,75,42,2,13,76,67,85,90,22,84,63,24,52,16,60],child:[51,48],"catch":84,emploi:60,ugli:52,ident:[42,90],servic:84,properti:[42,74,52],calcul:52,suffici:[32,74],systemexit:[52,69],kwarg:[54,1,29,4,79,59,32,35,5,80,61,39,81,40,66,72,67,44,45,89,16,48,68,17,69,50,70,19,22,24,52,26],conf:52,sever:[85,86,3,70,24,52],jame:[91,86,75,21],receiv:[27,69,74,51,84,24,52,48],suggest:[37,13],make:[37,27,69,42,12,13,76,78,52,47],complex:[37,85,79,13,42],split:[70,24,16],complet:[27,54,2,74,70,79,59,32,35,5,61,66,45,89,16,48,69,29,19,22,24,52],test_tcp_reconnect:52,hang:52,action:[32,22,74,84],rais:[90,52,60,48,84],giorgi:75,scenario:[74,22],thu:[27,69,70,22,78,52],in_subtre:48,inherit:[42,52,48,85],ocean:52,client:[68,67,27,87,49,90,84,16,77,51,91,41,58,24,52,47],wherebi:[2,52],thi:[27,54,28,1,42,2,3,75,79,74,67,29,4,45,59,78,55,32,35,5,37,61,39,81,91,7,47,8,63,66,41,10,72,36,84,12,13,44,14,88,89,90,16,48,69,68,18,49,50,70,19,30,51,22,23,24,52],gzip:90,everyth:52,inheria:42,left:[52,16,69],lengthrequir:84,protocol:[90,67,27,51,91,87,4,45,41,24,10,52,16],just:[2,24,52,74],webconsol:52,yet:22,languag:[37,63,13,42],previous:[74,84],get_rang:55,easi:[42,27,76],had:52,keep_blank_valu:55,test_logg:52,board:42,els:[40,90,22,52],save:[78,22,89],test_tcp_connect_closed_port:52,applic:[27,42,2,76,29,79,32,5,37,82,84,72,85,86,12,13,46,89,90,48,20,21,91,73,52],preserv:22,disposit:[90,63],background:50,shadow:52,test_ev:52,apart:[32,74,48],measur:[32,52],daemon:[29,52,21],specif:[11,32,22,52,48],deprec:52,arbitrari:74,html:[90,14],underli:[70,52,47,41],www:[3,90,13,86,37],right:[42,52],old:52,deal:47,interv:[40,52],intern:[55,86,84,24,52,16,60],flatten:30,validate_sinc:90,indirect:32,successfulli:[5,68,27,54,61,69,89,19,74,29,45,66,79,59,24,73,16,35],cooper:52,bottom:52,subclass:[42,84,78,24,52,48],track:[42,52,60],tracker:[65,60],condit:52,foo:78,fieldstorag:52,localhost:[52,47],core:[74,54,1,42,3,67,77,29,4,45,79,78,59,32,35,5,80,61,39,40,8,83,66,72,36,12,44,14,89,15,16,48,69,68,17,18,49,50,70,52,19,30,82,51,22,23,24,25,26],naali:86,insecur:52,anotehr:3,repositori:[28,57],post:[70,90,52,49,84],"super":[78,42,74,52,47],plug:42,prepareunregist:[52,48],slightli:[42,52],unfortun:[37,13],commit:[52,38],marshal:75,"30x":76,basenam:90,"float":[40,32],encod:[67,27,70,45,66,41,59,24,52,90],bound:[42,70],werkzeug:84,bufsiz:[68,83],wrap:52,accordingli:48,wai:[37,38,0,42,2,13,63,78,32,73,52],support:[37,74,87,20,82,72,12,13,7,21,58,63,46,84,23,52,60],transform:63,"_process":52,"class":[53,27,54,55,1,42,2,3,79,74,67,77,29,4,45,58,78,59,32,83,35,5,85,80,61,39,81,40,91,56,7,47,8,63,66,41,10,72,36,84,44,76,87,14,88,46,89,90,15,16,48,69,68,17,18,49,50,70,52,19,30,21,51,22,23,24,25,26],avail:[55,69,8,22,41,52],gif:63,setdefault:[63,52],fork:[52,38],head:42,form:[37,38,13,70,63,55,90,52],offer:27,forc:90,some:[36,42,74,38,0,53,85,78,90,73,52,16,48],hear:38,methodnotallow:84,"true":[74,54,55,29,79,59,32,35,5,61,40,63,66,36,45,89,90,16,48,17,69,50,19,22,23,52],freenod:[37,38,13],reset:[40,52],maximum:[32,69],tell:42,dump_valu:56,fundament:90,emit:[24,27],trim:17,featur:[37,27,38,0,13,20,22,90,52,60],classic:2,parse_head:63,"abstract":[37,13],reexamin:22,exist:[37,13,63,84,52,16,60],ship:[73,46],bore:42,concurr:[37,12,13,52],pipe:[68,52],encrypt:90,excel:0,refactor:52,tim:75,role:32,test:[42,38,0,12,13,46,73,52,60],"1ee04d5fb657":52,unlimit:69,node:[56,82,25,12,77,35,58,15,52,48],relat:[42,52],stringio:52,flushev:32,urllib2:52,consid:[67,52],sql:86,bitbucket:[37,38,11,13,65,60],longer:52,ignor:[17,52,69],time:[37,69,42,40,13,32,52,90,86],push:52,backward:8,osx:[12,52],concept:[42,12,52,85],chain:22,skip:52,consum:69,component_inst:52,mill:[91,86,75,21],regsit:52,graph:[42,20,53],x00:52,query_str:55,isinst:74,sourc:[42,28,69,37,11,13,57,71,32,47],string:[55,63,52,41,70],"_fire":52,revalid:90,handlestyp:22,cool:42,level:[5,37,12,13,32,90],did:52,gui:12,iter:[52,69],item:[70,63,52,16],unsupport:84,greenlet:52,quick:[73,57],prevent:[90,52,69,48],"_handler_channel":52,port:[68,49,3,77,70,83,41,52,47],appear:63,current:[55,69,12,29,22,90],domain2:3,ascii:[42,52],enthusiast:[37,13],deriv:[54,32,22,48],gener:[27,54,69,12,7,74,76,4,22,23,24,52,32,86],unauthor:[90,44,84],sahriswiki:86,address:[68,70,52,41],along:38,wait:[74,69,40,22,32,52],bot:86,"_success":52,inotifi:52,bob:[42,74],commonli:[24,27],semant:52,regardless:52,extra:[42,52],modul:[55,1,3,76,70,30,59,32,37,39,81,8,63,66,84,72,44,88,90,48,69,20,22,23,24,52],prefer:[63,38],"1st":[70,47],instal:[37,28,13,57,32,73,52,60],memori:52,visit:30,mangahelp:86,handler:[27,54,42,2,74,29,4,79,78,59,32,35,5,61,16,66,36,43,76,45,89,90,47,48,18,69,50,19,22,24,52],scope:42,eventsuccess:[5,54,61,69,89,19,29,45,66,79,59,16,35],oom:52,enhanc:52,prototyp:86,effort:[37,13,76],easiest:73,pyinotifi:[52,20],focu:12,descriptor:8,can:[27,55,85,3,74,29,79,78,60,37,38,39,63,84,42,11,12,13,90,16,48,69,51,22,52],purpos:52,encapsul:[2,85],stream:[24,54,52,76],fragment:52,playsign:86,agent:90,nastri:52,occur:[36,42,52,69,84],alwai:[63,52],multipl:[3,52],charset:63,fieldvalu:63,write:[68,42,27,38,0,67,12,19,51,29,8,24,52,47,60,49],anyon:[2,75],xhtml:14,product:52,clone:[11,28],"_get_request_handl":52,mac:[37,13,20],mai:[74,54,3,29,4,79,59,32,35,5,37,61,63,66,85,13,45,89,16,48,69,19,22,52],underscor:[78,63,48],data:[68,67,74,49,84,47,70,63,41,24,52,16,69],man:52,load_valu:56,stdin:[29,7],explicit:[78,43],produc:[42,52],inform:[27,54,74,29,79,59,32,35,5,61,39,66,41,67,76,45,89,16,48,69,19,24,52],"switch":52,combin:[37,32,22,13,84],callabl:[90,52],talk:12,notaccept:84,graphviz:42,rpc_channel:[59,66],still:[42,38,52],mainli:52,dynam:[32,54,52,23],entiti:[90,84],conjunct:[4,16],disconnect:[68,52,47],thank:38,concis:[78,38],duplex:[68,52],sec14:90,platform:[37,0,12,13,20,52],window:[37,52,12,13,20],load_ev:56,mail:[37,12,13],main:[50,12,87,46,32,52,48],non:52,initi:[54,29,79,59,32,35,5,80,61,81,16,66,41,72,42,45,89,47,48,49,68,17,69,50,19,23,24],verifi:38,now:[42,2,40,22,63,73,52],discuss:[38,60],introduct:[62,65,0,76],term:[37,32,12,13],name:[53,74,54,42,29,30,79,78,59,32,35,5,61,39,63,66,41,36,45,89,90,16,48,69,19,22,52],serviceunavail:84,didn:52,revert:52,separ:[3,74,63,52,42],domain:3,wsclient:51,agil:60,replac:[5,54,61,69,89,19,29,45,66,79,59,52,16,35],receipt:27,continu:[27,12,52,32],contributor:[37,75],alessio:75,year:90,happen:[42,52,47],shown:27,space:52,prefectli:52,safeimport:30,profil:86,internet:41,correct:[42,41],unixcli:68,orm:27,org:[37,38,86,11,13,90,52,60],"byte":[55,27,52],cough:42,reusabl:[85,12,52],keyecho:52,befor:[5,42,54,61,69,3,89,19,29,22,48,45,79,59,90,52,16,35,66],waiter:52,waitev:[32,52],recov:42,thing:[78,42,52,65],place:52,think:[37,13,52,42],frequent:[37,12,42],first:[42,74,2,51,22,84,63,73,52,48],oper:[22,55,16],suspend:[32,22,52,69],reimplement:52,directli:[85,32,75],carri:74,onc:[40,32,74,60],yourself:60,fast:52,open:[52,51,19,67,61],given:[67,55,50,40,44,70,63,84,32,52,90,48],silent:[42,52],convent:78,caught:42,conveni:[74,52,76,48],friend:52,especi:[74,84],copi:28,specifi:[54,70,79,78,59,32,35,5,61,40,66,67,45,89,16,48,69,29,19,51,22,52],broadcast:[68,52,47],inconsis:52,packet:35,pragma:90,than:[78,90,63,52,69],serv:[90,14,46],were:[63,52,84],browser:[55,84],pre:[53,54,55,1,56,3,79,67,77,29,30,45,58,59,32,35,5,80,61,39,81,40,7,91,8,63,66,41,10,72,36,84,44,83,87,14,88,46,89,90,15,16,48,69,68,17,18,49,50,70,19,4,21,51,22,23,24,25,26],basecontrol:81,sai:[42,52],nicer:84,argument:[27,54,74,70,79,78,59,32,35,5,61,40,16,63,66,84,44,45,89,90,47,69,50,29,19,22,24],dash:63,deliv:[5,67,74,54,61,69,89,19,29,22,66,45,79,59,32,52,16,35],test_disp:52,check_auth:90,engin:86,note:[68,42,74,28,85,3,13,4,63,84,78,55,32,52,16],denomin:52,take:[37,32,13,74,42],noth:[42,52],channel:[27,54,67,74,77,29,30,79,78,59,32,35,5,37,61,81,40,8,83,66,42,12,13,45,89,15,16,48,69,68,17,49,70,52,19,4,51,22,23,24,25],explitetli:4,begin:29,sure:[52,47,69],normal:[5,42,85,54,61,69,70,79,19,76,89,29,22,66,45,63,59,24,16,35],buffer:[24,52,16],test_bridg:52,compress:[90,55],pair:[68,3],renam:52,later:[32,52],boundari:52,handler_return:74,show:[42,52],analyit:52,permiss:84,corner:52,unfinish:[24,16],xml:[87,52,66,76],onli:[42,69,20,76,63,84,79,78,32,52,16,48],explicitli:[78,74,52],written:[68,37,86,75,42,13,90,52],woof:42,dict:[68,55,69,50,3,63,90],test_unixserv:52,icebox:60,sighup:52,variou:[37,10,13,7,21],get:[37,27,55,0,42,2,13,57,62,63,32,52,90,49],repr:52,secondari:52,ssl:[68,52],cannot:[37,13,52,84],ignorechannel:17,requir:[37,27,13,20,57,22,88,84,52,47],truli:52,mapper:76,consist:[42,27],pydot:[42,20],borrow:[76,84],yield:[32,22,52],where:[78,42,52,48,67],wiki:[52,86],errconnrefus:52,alllow:52,detect:[78,52],enough:27,between:[90,12,52],"import":[42,74,2,7,76,78,32,73,52,47,48],sortabl:63,parent:[85,52,48],screen:42,cycl:[0,60],auto_regist:23,come:[42,12,69],tutori:[37,74,42],aura:86,improv:[37,13,52],overview:[76,37,13,47,42],period:40,dispatch:[27,54,85,3,74,70,45,79,78,59,32,35,5,61,66,84,67,76,87,14,89,16,69,29,19,22,52,26],exploit:52,itercmp:52,typic:[69,50],poll:[8,12,52],clarif:52,coupl:[37,13],mark:[78,85,22,52,48],those:[27,32,74],"case":[27,38,74,22,63,52],superflu:52,rtype:53,invok:[5,45,27,54,61,69,89,19,74,29,22,48,32,79,78,59,24,16,35,66],invoc:[78,32,16,74],advantag:[37,13,42],stdout:[29,52,7],reduce_time_left:69,worri:42,destin:[5,54,61,69,89,19,29,45,66,79,59,16,35],"return":[53,27,54,55,2,74,29,79,59,32,35,5,61,63,66,84,76,45,89,90,16,48,68,69,19,22,24,52],eventcomplet:[5,54,61,69,89,19,29,45,66,79,59,16,35],"__init__":[78,42,74,47,48],develop:[37,27,82,28,0,75,53,2,65,12,13,76,57,21,11,78,52,60,86],author:[90,84],media:[86,84],edwin:75,same:[5,74,54,61,69,89,19,29,22,66,45,79,59,90,52,16,35],check:[67,86,90,73,52,48],binari:52,inconsist:52,document:[42,65,37,52,13,76,34,60],flake8:[52,60],finish:[42,52],webserv:52,driver:52,driven:[37,12,13],capabl:52,mani:[78,38,13,42],extern:[37,13,69],appropri:[70,4,24],ekwarg:42,pep8:65,without:[42,32,22,52,84],roughli:42,execut:[32,22,52,69,50],when:[74,54,2,3,29,79,78,59,32,35,5,61,16,66,42,45,89,90,47,48,68,69,50,19,51,22,24,52],rest:[4,52,84],kill:52,speed:52,except:[36,42,69,87,84,78,52,48],param:[63,55],blog:86,around:[52,63,38],read:[68,37,27,65,42,13,19,8,67,47,4,78,51,24,52,16,74],rfc2616:90,acceptel:63,world:[2,42,52,76,86],server:[27,55,2,3,74,70,58,37,16,64,84,85,41,13,76,87,46,47,68,25,51,91,24,52],either:[68,37,38,69,50,42,13,23,90,52,48],output:[42,52,75,55],inter:[52,58],manag:[36,42,18,69,50,53,65,22,85,63,32,33,52,48],fulfil:84,unixserv:[68,70,16],handshak:67,parse_q:55,slice:55,confirm:[67,60],definit:[78,52],generateev:[32,52,69],exit:42,complic:22,refer:[37,82,42,11,76,70,41,78,52,48],power:[2,37,12,13],inspect:[53,52],broken:52,found:[27,3,74,76,84,78,32,52],"__name__":74,earlier:22,src:[37,13],stand:27,act:[52,48],other:[74,28,85,2,76,57,4,78,37,63,42,86,12,13,90,47,48,69,50,20,23,52],cvar:41,effici:52,exposejson:81,urwid:52,find_handl:52,unregist:[40,85,52,69,48],shortcircuit:75,strip:47,pivot:[65,60],your:[37,27,28,0,42,2,12,13,71,22,60,84,38,90,53,48,69],log:[5,17,42,21,29,52],aren:[74,52],getbuff:16,start:[37,27,38,69,50,42,2,74,57,67,29,62,78,76,55,32,73,52,47,48],compliant:[37,27,67,13,76,87,51],interfac:[52,12,13,70],lot:52,ipv6:[52,13],strictli:[20,84],findtyp:[30,52],hei:52,tupl:[5,68,54,55,69,50,70,79,19,63,29,45,66,89,61,59,16,35],regard:[42,76],reinvok:69,faster:52,serve_fil:[90,52],pull:[38,28],possibl:[27,12,74,90,52,32],"default":[53,27,54,55,74,29,45,79,59,35,5,61,63,66,84,42,76,87,14,89,90,16,48,17,69,70,19,22,24,52,26],"_dispatch":52,basepol:8,connect:[68,67,74,49,51,52,47],formattim:1,gone:84,creat:[54,55,29,4,79,78,59,32,35,5,37,38,7,16,8,66,41,42,13,44,45,89,61,47,68,17,69,50,70,19,22,23,24,36,52],certain:[40,69],watcher:52,file:[17,80,61,1,42,20,7,70,8,76,90,52,16],gethandl:52,fill:52,incorrect:[90,52],again:[42,32,52,74],googl:52,collector:[74,43],tcpserver:[68,85,27,47,70,16],event:[27,54,55,1,42,3,79,74,67,77,29,4,45,58,78,59,32,83,35,5,37,85,80,61,39,81,40,56,7,47,50,8,63,66,41,72,36,43,84,12,13,44,76,87,14,89,90,15,16,48,69,68,17,18,49,30,70,52,19,20,51,22,23,24,25,26],field:63,cleanup:52,you:[53,27,28,0,3,74,78,55,60,37,38,63,84,42,12,13,90,47,48,69,71,22,73,52],architectur:[37,12,13,85],sequenc:52,docstr:[52,60],unsupportedmediatyp:84,pool:[52,50],reduc:[52,69],directori:[52,73,14,28,46],descript:[78,74,76,84],potenti:52,alright:42,has_opt:52,cpu:52,represent:[42,52],all:[27,54,75,85,74,29,30,79,59,32,60,5,38,16,63,35,84,66,42,45,89,61,47,48,17,69,19,22,24,52],illustr:[2,42],forbidden:[44,84,76],bytearrai:52,test_arg:52,children:52,hmmm:42,script_nam:55,init:52,program:[37,42,12,13,32,52],scratch:42,introduc:42,baseserv:[70,76,85],parsebodi:52,elementstr:63,fals:[68,55,70,30,14,78,32,52,90],faq:52,util:[18,55,56,87,30,22,58,52],mechan:[78,90],fall:52,veri:[37,74,42,2,12,13,51,52],splitter:16,list:[74,54,55,75,29,79,59,32,35,5,37,61,16,63,66,84,12,13,14,89,47,48,17,69,70,19,45,52],stderr:[17,52,7,29],small:[37,13,52],valuechang:52,krekel:75,unmark:52,past:90,"_tick":52,uuid4:52,design:[2,37,90,13,75],pass:[74,54,55,3,29,79,78,59,35,5,37,61,66,67,12,13,45,89,16,48,69,50,70,19,51,22,52],further:[11,76,48],what:[37,74,0,42,71,12,13,70,52,47,60],sub:[85,4],section:[27,74],abl:42,delet:[61,63,52,49],version:[71,12,20,73,52,60],add_sect:52,method:[42,74,49,84,85,22,41,78,63,32,52,90,48,69],full:[68,37,27,13,76,87,52],hash:90,unmodifi:[52,84],depend:[37,52,13,20,57],strong:[37,13],modifi:[42,61,44,24,52,90,60],valu:[74,54,55,3,70,79,59,35,5,61,6,63,66,36,45,89,90,16,18,69,29,19,22,24,52],search:37,amount:40,codebas:52,via:[37,28,12,13,52,60],primit:[37,13,52],friendli:52,filenam:[5,29,63,89,90,52],establish:[67,51,52],select:[8,12,52],ctrl:42,regist:[42,74,69,50,85,78,32,52,47,48],two:[42,74,55,51,32,52,16,48],coverag:52,taken:[32,75],minor:52,more:[27,54,74,29,79,59,32,35,5,37,38,63,66,42,12,13,45,89,61,16,69,19,22,52],flag:17,broke:52,particular:[74,69],known:24,suchojad:75,cach:[90,52,86],none:[53,74,54,55,1,56,3,67,77,29,30,59,32,35,36,80,39,81,40,8,63,66,41,72,42,84,44,83,14,89,90,15,48,69,68,17,49,50,70,52,19,22,23,24,25,26],dep:52,dev:38,"__tick__":52,learn:42,identifysuccess:74,def:[42,74,2,76,78,47],traverse_children_handl:52,registr:[52,48],share:[27,38,0,11,88,65],basic_auth:90,accept:[70,51,63,84,78,90,52,16],huge:52,cours:74,goal:42,secur:[68,3,52,49,70],rather:[85,27,74,22,32,52],anoth:[74,22,52,69,50],test_manager_repr:52,simpl:[42,2,64,52,47,46],isn:[42,22,52],resourc:[55,14,52,49,84],pricewaterhousecoop:86,reflect:[52,44],init_kwarg:23,okai:42,associ:[5,36,74,54,61,69,89,19,29,45,48,79,59,24,16,35,66],caus:[42,32,22,52,50],test_secure_serv:52,egg:23,prepare_unregister_complet:52,help:[38,28,42],mainthread:42,through:[42,52,47],hierarchi:[32,52],developet:52,paramet:[53,54,67,3,29,79,59,32,35,5,61,40,63,66,41,36,45,89,90,16,48,69,68,17,49,50,70,19,51,22,24,52],style:[14,52],late:63,"_param":63,pend:[32,22,69],rapidli:76,might:52,epol:[8,12],good:[42,84],headerel:63,"98d0056ef18a":52,framework:[37,18,38,86,42,82,12,13,27,74,87,62,43],"_valu":63,detach:[85,48],from_str:63,eventu:[5,54,61,69,89,19,29,45,66,79,59,32,16,35],unlik:63,authent:[90,84],easili:[42,12],token:63,compris:85,fulli:[27,13,23],unicod:[29,52],idea:[37,13,52],test_longwait:52,expect:[42,52,16,60],stabl:[11,37,13,57],beyond:[37,13,20],todo:34,orient:42,socket_famili:68,"try":[42,90,73,52,47],safeti:52,serve_download:90,etag:90,"_client":47,sdlc:[0,60],print:[17,74,42,78,73,52],proxi:84,advanc:[74,43],differ:[42,74,3,22,78,52],reason:[37,8,13,52],base:[54,55,1,42,2,3,76,67,77,29,4,45,79,59,32,35,5,37,85,80,38,39,81,40,8,63,66,41,72,36,84,13,44,83,14,89,61,15,16,48,69,68,17,49,50,70,52,19,51,22,23,24,25,26],fieldnam:63,ask:[37,12,69,42],thrown:[74,52],thread:[32,52,50],perhap:55,circuit:[53,27,54,28,0,1,42,2,3,75,79,74,67,77,29,4,45,58,78,55,32,72,35,86,5,37,85,80,38,39,81,40,91,56,7,47,50,8,63,60,41,10,59,66,36,43,84,65,11,12,13,44,76,87,14,88,46,89,61,90,15,16,48,69,68,17,18,62,49,30,70,52,83,19,20,21,82,51,22,23,24,73,25,26],assign:[24,22,52],singleton:[52,48],certfil:70,notifi:[36,68,61,7,20,29,52],obviou:78,feel:42,number:[42,74,69,40,3,90,52],done:[27,52,48],construct:63,blank:55,horribl:42,miss:52,digest_auth:90,guess:90,script:[37,13],interact:[37,13,85],least:[42,32],stori:[38,0,60],statement:22,scheme:[55,41],store:[36,74,16,39],option:[74,54,28,57,29,45,79,78,59,32,35,5,61,40,66,14,89,16,69,19,20,22,52],relationship:48,processtask:52,part:[78,3,18,52,42],pars:[70,4,63,24],fred:[42,74],std:[52,76],notfound:[44,84,76],kind:84,test_tcp_bind:52,remot:[68,35],remov:[32,52,47,48],bride:52,reus:[37,74,13],str:[53,49,17,70,29,63,41,90,52],toward:[37,13],randomli:52,comput:[12,48],unboundlocalerror:52,packag:[37,18,28,53,13,7,57,91,10,65,74],expir:[90,52],"null":52,imagin:22,built:[2,37,13,52],lib:[52,76],documentatino:60,self:[42,74,2,76,78,32,52,47],also:[68,37,74,90,85,12,13,7,22,84,63,32,52,16,60],derivedev:[52,69],append:[5,74,54,61,69,89,79,19,47,29,45,66,32,63,59,24,16,35],fouond:44,success_channel:[5,54,61,69,89,19,29,45,66,79,59,16,35],distribut:[58,73,12,23],my_special_ev:78,previou:[42,52,16],most:[8,63],plai:[2,52],plan:12,clear:[40,78,12,38],cover:[52,38],"_on_respons":24,"2nd":[70,47],clean:52,usual:[5,27,54,61,69,89,19,74,29,45,66,79,59,32,16,35],baseclass:84,wsgi:[37,27,72,13,76,87,84,52],hyper:24,session:[87,39,76],find:[37,74,55,42,13,22,78,52,60],copyright:[91,21],solut:[37,38,13],queu:42,templat:27,reinstal:28,unus:52,express:52,rfc:[67,51,52],common:[32,52,69,21],set:[53,74,54,76,29,79,59,32,35,5,61,40,16,63,66,84,36,44,45,89,90,47,48,69,19,52],startup:52,see:[74,28,2,70,32,37,80,38,81,41,72,42,13,90,16,48,17,69,50,21,91,23,24,52],sec:90,arg:[74,54,55,67,29,4,79,59,32,35,5,80,61,39,81,66,72,42,45,89,90,16,48,68,69,50,19],close:[68,67,27,61,49,19,51,52],bark:42,ohloh:[37,13],qvalu:[90,63],jenkin:52,test_gzip:52,bridg:[12,52],httperror:[76,24,27,44],altern:[5,37,54,61,69,13,89,19,29,45,66,79,59,52,16,35],signatur:[17,80,81,50,41,23,32,72,16,48],appreci:75,javascript:[37,13],incident:42,test_notifi:52,solv:38,both:[68,42,54,23,32,52],last:[90,32,52,47],delimit:24,alon:27,forgotten:52,load:[79,52,89,23],simpli:[2,42,22,28,47],point:[3,52,42],header:[55,49,3,87,51,63,84,90,52],littl:42,linux:[37,12,13,20],throughout:[85,90],ignoreev:17,due:52,empti:[55,90,63,52],sinc:[42,90,84],whom:47,compnoent:52,wschannel:[67,51],fire:[27,54,67,74,29,79,59,32,35,5,61,40,16,66,42,45,89,47,48,69,19,51,22,24,52],unnecessarili:22,understand:42,look:[42,37,2,3,13,78,52],accidentla:52,circuti:[2,52,27,38,46],"while":[36,74,12,52],abov:[42,90],error:[36,17,74,68,69,90,42,19,44,76,87,84,24,52,32],fun:[2,73],dump_ev:56,fixtur:52,loos:[37,13],loop:[32,12,52],prolog:[37,38,75,42,11,13,60],propag:22,pound:[42,74],readi:[68,22,52],test_component_target:52,itself:[5,85,27,54,61,69,2,40,19,29,45,66,89,79,59,16,35],rid:52,addhandl:[32,52],queue:[32,52],decor:[78,32,22,52,48],unmount:61,decot:52,minim:76,belong:[85,52],pytest:[52,60],decod:[67,84],pwc:86,handler_annot:78,conflict:52,higher:[37,22,13,52],itch:42,optim:52,wherea:42,user:[37,38,86,75,84,90,52,47],baseenviron:52,stack:[87,27,69],travers:52,task:[32,22,52,50,21],discourag:74,eleg:12,autotag:90,entri:[3,52],spent:32,pickl:52,spend:69,propos:52,explan:74,chore:[52,60],collabor:86,meher:52,poller:[8,52,18,69],dirlist:14,tick:[32,52],input:[52,41],subsequ:[67,74],useless:52,bin:[78,42,74,47],ece3ee5472ef:52,bit:[42,22,52],httpexcept:84,lost:52,docutil:[53,54,55,1,56,3,79,67,77,29,30,45,58,59,32,35,5,80,61,39,81,40,7,91,8,63,66,41,10,72,36,84,44,83,87,14,88,46,89,90,15,16,48,69,68,17,18,49,50,70,19,4,21,51,22,23,24,25,26],signal:[42,69,44,51,22,84,32,52],manifest:52,collect:[63,24,22,27,74],admittedli:2,test_debugg:52,often:[3,53],acknowledg:[37,13],creation:[78,22,52],textiowrapp:52,back:[24,52,41],global:[87,42,52,88],lipp:75,sampl:52,resutl:52,compress_level:55,scale:[37,13],chunksiz:41,per:[78,24,52],pyver:52,internalservererror:84,larg:[52,84],myevent:42,slash:55,reproduc:52,requestentitytoolarg:84,run:[42,74,0,2,3,76,60,78,32,52,47,48,69],do_handshak:52,simple_serv:47,myspecialev:78,step:[2,38,47],crlf:24,prerequisit:47,shine:52,jsonrpc:[87,59,76],unicodeerror:84,coexist:52,internalserv:52,block:[32,50],precondit:84,primarili:75,needs_resum:52,within:[3,90,69,85],"_on_httperror":24,ensur:[52,27,38,60,41],mke:52,span:[53,54,55,1,56,3,79,67,77,29,30,45,58,59,32,35,5,80,61,39,81,40,7,91,8,63,66,41,10,72,36,84,44,83,87,14,88,46,89,90,15,16,48,69,68,17,18,49,50,70,19,4,21,51,22,23,24,25,26],sock:[68,24,16,41,47],submit:[38,0,60,84],custom:[42,4,52,16],includ:[37,32,13,52,55],suit:52,forward:[3,52,67],properli:[73,52,47,84],repeatedli:40,"_on_start":78,link:[32,52],translat:[59,66],newer:52,atom:55,line:[42,4,91,78,24,10,52,16],utf:[70,45,66,41,59,24,52],max_wait:69,value_chang:52,callev:[32,22,52],similar:[74,38],constant:[87,88],curs:52,"_on_task":50,doesn:[42,52,84],repres:[53,52],incomplet:52,destruct:90,chat:[52,38,47],guarante:[37,13],pythoncircuit:[37,13],udpclient:[68,52],invalid:[52,84],nice:2,websocketcli:51,scrum:60,virtualhost:[87,3,76],far:42,hello:[2,42,52,76],oop:[42,52],pluggabl:86,code:[90,42,38,0,84,2,65,44,57,11,71,41,78,28,24,52,47,60],queri:[13,86,41],documetn:52,privat:[52,48],base_url:52,send:[54,3,29,79,59,35,5,61,66,84,85,41,12,45,89,90,16,68,69,19,51,24,52],becam:52,sens:[42,52],sent:[5,67,27,54,61,69,68,89,19,29,51,45,48,41,79,59,16,35,66],"99bottl":52,implicitli:[78,74],relev:60,tri:[67,51],michael:[86,75],unquot:52,race:52,dealt:42,evt:74,pleas:[11,37,38,13,60],smaller:42,fortun:42,natur:[42,48,85],uniqu:52,download:[42,74,28,37,11,13,57,78,90,73,52,47],odd:52,folk:42,compat:[37,8,13,52],index:[37,2,65,14,46,52],compar:[63,12,52],anton:86,access:[2,74,61,39,84],experiment:52,uncamel:[5,54,61,69,89,19,29,45,66,79,78,59,52,16,35],wait_for:52,bodi:[55,49,41,90,52,24],let:[37,42,13,73,47,60],becom:[78,22,69],implicit:[78,43],convert:[42,24,63,27],pretti:42,holger:75,larger:69,"_name":63,resurrect:52,conftest:52,chang:[36,42,32,52,74],envnam:79,appli:[78,55,22,28],app:[5,82,89,21,29,79,52],gatewai:[72,52,84],api:[37,74,42,82,76,78,52],docroot:14,from:[27,54,28,75,67,2,74,57,78,55,32,37,85,40,16,63,84,42,11,13,76,90,47,48,68,69,22,23,24,52],zip:23,commun:[37,51,12,13,52],upgrad:67,next:[42,86,2,3,22,52,47],websit:[3,27,13,86,37],requesturitoolarg:84,doubt:42,usr:[78,42,74,47],simpler:[37,13,52,42],has_sect:52,sort:63,appropi:4,benchmark:52,iif:69,socket:[68,85,12,51,16,70,8,91,41,32,52,47],retriev:[27,52,16],scalabl:[37,12,13,76],alia:[68,52],"__process":52,executor:32,control:[71,81,70,2,76,87,11,90,52],realxtend:86,process:[27,54,0,50,84,12,51,74,29,4,60,32,58,24,52,16,48],lock:[52,69],controlelr:90,high:[37,12,13,52,76],tag:[11,90,52],tab:[11,52],onlin:12,tam:86,serial:[83,7],delai:40,six:52,instead:[27,55,50,41,78,52,48],clength:52,overridden:[5,54,61,69,89,19,29,4,22,48,45,79,59,16,35,66],findcmp:[30,52],watch:47,requst:41,essenti:[18,27],bind:[68,52,15,25,70],correspond:[3,24,63,32],element:63,issu:[37,38,13,52,60],junitxml:52,alatalo:[86,75],allow:[37,74,28,42,3,12,13,84,32,52,90,48],fallback:[52,84],retval:42,move:[42,52,61],whilst:52,comma:63,bunch:52,perfect:38,threadpool:52,webev:[54,52],therefor:[5,54,61,69,79,19,29,45,66,89,63,78,59,52,16,35],lastli:42,crash:42,handl:[67,27,69,85,51,74,4,22,84,63,24,52,47,48],auto:52,auth:[90,84],facilit:40,project_thin_badg:[37,13],multiprocess:52,anyth:52,"_on_read":24,nameerror:42,februari:37,mode:[52,28,16],querystr:55,dariusz:75,bump:52,requesttimeout:84,"static":[14,76,87,63,46,52],our:[42,38,86,2,12,78,47,60],patch:52,special:[42,22,52],out:[29,74,73,52,42],variabl:[5,17,54,61,69,42,70,89,19,29,45,48,79,59,36,52,16,35,66],reload:52,influenc:[78,90,22],bad:[52,84],suitabl:[55,46,23],rel:55,clarifi:52,umbrella:52,insid:52,test_nod:52,dictionari:55,releas:[37,11,13,57,60,52,48],unwant:42,could:52,put:[42,24,52,49,74],timer:[40,18,52],keep:[42,55,47],test_removehandl:52,generate_ev:[52,69],softwar:[12,38,0,60],max_ev:52,qualiti:[38,60],echo:52,date:37,whoos:16,"0dev":[],prioriti:[42,22,52,63],"long":84,unknown:[52,84],licens:[37,91,13,21],system:[36,17,85,61,69,20,37,2,42,12,13,8,7,71,4,79,53,32,52],messag:[54,29,4,79,59,35,5,37,61,16,63,66,41,42,84,12,13,45,89,47,69,19,24,52],attach:[78,85,90,63],termin:52,"final":[55,22,52],udp:[12,52],someev:78,listn:52,enqueu:32,rst:[],exactli:[74,52,60],notconnect:51,structur:[2,3,85,52,53],charact:70,headervalu:55,singletonerror:48,rate:52,viewer:86,py2:52,py3:52,clearli:42,have:[27,54,28,0,75,2,74,29,79,59,32,60,5,37,61,16,63,35,84,66,42,12,13,45,89,47,68,69,19,22,24,73,52],tabl:37,need:[53,27,28,0,2,3,76,22,60,52,47,48],turn:78,tidi:52,rout:52,builtin:[42,27,16],discret:85,which:[36,42,27,55,50,67,2,85,22,84,78,63,90,52,48],basecompon:[1,85,3,77,29,45,79,78,59,5,40,8,66,72,67,14,89,15,16,48,68,17,49,50,70,25,51,22,23,24,52,26],mit:[37,91,13,86,21],singl:[2,3,32,52],analysi:53,unless:[90,63],freebsd:[37,12,13,20],discov:42,stupidli:2,websocketsmedi:52,segment:52,why:[42,74],url:[55,49,3,44,51,84,90,52],gather:74,request:[67,27,54,38,0,84,2,3,44,76,87,70,51,45,41,55,24,52,90,60,49],uri:84,inde:42,pidfil:29,determin:[70,22],someth:[42,74,52,84],text:[37,13,47,4,90,24],identify_success:74,baseev:[52,69],trivial:12,anywai:52,redirect:[55,52,44,84,76],locat:[52,84],launchpad:86,hadn:74,should:[27,54,55,29,79,59,35,5,61,63,66,84,42,41,45,89,90,16,48,69,50,19,52],restructur:52,test_poller_reus:52,local:[42,52,60,23],meant:52,contribut:[75,38,0,60],pypi:[37,52,13,20,65],regularli:28,notimpl:84,increas:52,handler_channel:52,enabl:[17,8,13,37,23],whoohoo:42,integr:[12,52,86],contain:[18,91,3,7,21,87,70,8,63,76,24,10,52,90],view:84,conform:84,legaci:8,frame:[42,69,67],apolog:75,"0x808e8ec":42,temporarili:84,multipart:52,greenletmanag:52,"7be64d8b6f7c":52,becaus:[52,48,41],"70677b69bf05":52,statu:[90,84],correctli:[42,52],pattern:[78,74],test_process_pool:52,tend:[37,13],state:[42,32,22,52,74],weird:[42,52],neither:32,email:[63,12],stati:52,tent:13,kei:63,entir:[42,12],unnot:52,group:74,eclips:52,addit:[74,69,3,20,51,22,63,52],handlermetaclass:22,revers:52,sniff:52,plugin:52,equal:52,wsgiref:76,etc:[27,52,16],instanc:[27,54,85,29,4,79,59,35,5,61,7,16,63,66,36,44,45,89,47,68,17,69,70,19,24,52],comment:52,badgatewai:84,arriv:68,walk:[42,47],rpc:[87,59,52,66,76],modstat:14,quit:[70,52],compos:[85,55],compon:[53,27,54,55,1,42,2,3,74,67,77,29,4,45,79,78,59,32,83,35,86,5,37,85,80,38,39,81,40,91,56,7,47,50,8,63,66,41,10,72,36,43,84,12,13,44,76,14,89,61,90,15,16,48,69,68,17,18,49,30,70,52,19,20,21,51,22,23,24,25,26],json:[87,59,52,76],besid:74,udpserv:[68,52],immedi:32,assert:52,togeth:[37,13,42],present:[90,52],multi:52,plain:90,align:27,harder:[42,52],defin:[74,54,42,2,29,30,79,78,59,32,35,5,61,16,66,36,12,45,89,47,48,69,19,22,24,52],glossari:[71,37],parse_bodi:55,apply_async:52,site:[3,52],archiv:[52,28,23],cherrypi:[27,76],lightweight:[37,13],incom:[3,47,4,66,84,59,24,16],so_reuseaddr:52,reviv:52,parse_bind_paramet:68,welcom:[37,38,13,42],easy_isntal:60,member:48,python:[37,74,28,86,42,65,12,13,20,76,85,84,78,55,32,52,47,60],test_valu:52,"__version__":73,difficult:74,http:[27,55,75,2,3,76,70,60,37,38,63,84,10,85,86,11,13,44,87,45,90,49,51,91,24,52],hostnam:68,upon:[78,67,27,52,51],effect:[32,52,74],retriv:29,build:[27,55,12,76,47,64,24,52,32],distutil:52,off:[38,47],keyboardinterrupt:[52,69],well:[37,74,38,42,13,52,60],exampl:[42,0,85,2,3,13,76,63,84,90,73,52],command:[11,4,73,28,75],latest:[11,37,13,69,57],less:[63,69],obtain:55,tcp:[51,12,52,74],"_on_sign":52,prepend:3,web:[27,54,55,1,85,2,3,76,70,59,37,39,81,82,62,63,66,41,72,67,84,13,44,87,14,88,46,90,49,51,45,24,52,26],baudrat:83,validate_etag:90,bench:52,add:[52,63,13,20],valid:[70,90,38,84],lookup:41,logger:[5,17,1,76,87,79,52],match:[5,67,54,61,69,84,3,79,19,89,29,22,48,45,63,78,59,90,16,35,66],branch:[11,52],xmlrpc:[87,52,66,76],webpag:86,generatortyp:22,howto:[37,52,64,42],piec:52,know:[37,0,13,48,32,60,69],press:42,redesign:52,password:90,recurs:[5,54,61,69,89,19,29,45,66,79,59,52,16,35],python3:52,python2:52,insert:[63,48],like:[37,74,38,0,42,2,13,85,51,84,52],success:[5,67,74,54,61,69,89,19,29,22,66,45,79,59,32,52,16,35],basehttpserv:76,necessari:[2,74,52],async:52,page:[37,38,86,11,13,46,84,52],backlog:68,exceed:84,drop:52,mycompon:[78,42],kdb:86,collected_inform:74,"export":76,flush:32,proper:[67,52],home:42,librari:[37,38,85,12,13,20,87,52],win32:52,est:52,lead:78,leak:52,avoid:[22,52],leav:[42,24],duplic:[63,52],"_failur":52,encourag:[37,13],investig:52,usag:[52,74,12,43],file_gener:41,vhost:55,host:[68,87,55,49,65,3,76,77,41,52,47],remvo:52,test_logger_error:52,stage:[51,52,48],about:[37,74,38,42,13,41,32,52,48],actual:[5,54,61,69,89,19,29,51,22,48,45,79,59,32,16,35,66],justin:75,ressurect:52,constructor:[5,67,74,54,61,69,89,19,44,47,29,51,45,66,79,78,59,16,35],discard:52,disabl:17,own:[42,48],reprhandl:[22,52],easy_instal:[37,13],automat:[5,42,27,54,61,69,90,89,19,29,45,48,32,79,78,59,24,16,35,66],guard:52,get_al:63,nuke:52,val:63,transfer:24,trigger:[36,32,52,74],chunk:[27,52],"function":[27,54,55,1,56,2,3,74,67,77,29,4,45,79,59,32,83,35,5,37,85,80,61,39,81,40,8,63,66,41,72,36,84,13,44,76,14,89,90,15,16,48,69,68,17,18,49,50,70,52,19,30,82,51,22,23,24,25,26],bug:[37,38,0,65,13,52,60],bud:63,instaleld:60,succe:52,made:[42,52],whether:52,wish:60,displai:[42,53],asynchron:[37,42,12,13,20,8],limit:[52,84],otherwis:[70,52,50],problem:[42,27,38,0,52,60],removehandl:[32,52],socketerror:68,evalu:52,"int":[70,32,55,90],dure:[42,52,69],pid:[29,32,52],twist:12,implement:[55,1,3,70,4,59,32,36,39,81,8,63,66,84,10,72,67,12,44,14,88,90,16,91,23,24,52],ini:52,pip:[37,73,13,60],quot:52,detail:[37,27,42,13,74,78,47],virtual:[87,3,76,86],book:11,bool:50,futur:[36,52],rememb:52,junk:52,repeat:38,header_el:63,eof:[52,19],exeuct:36,reliabl:52,indirectli:[85,32],test_success:52,literalev:[54,52]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:function","5":"py:exception","6":"py:staticmethod","7":"py:classmethod"},titles:["Developer Docs","circuits.web.loggers – Loggers","Getting Started","circuits.web.dispatchers.virtualhosts – Virtual Hosts","circuits.net.protocols.irc – IRC Protocol","circuits.app.log – Application Logging","Values","circuits.io – I/O Support","circuits.core.pollers – I/O Pollers","Tools","circuits.net.protocols – Networking Protocols","Downloading","Frequently Asked Questions","PyPi Test Page - Tentative Release","circuits.web.dispatchers.static – Static","circuits.node.node – Node","circuits.net.protocols.line – Line Protocol","circuits.core.debugger – Debugger","circuits.core – Core Functionality","circuits.io.events – I/O Events","Requirements and Dependencies","circuits.app – Application Support","circuits.core.handlers – Handlers","circuits.core.loader – Loader","circuits.web.http – HTTP Protocol","circuits.node.server – Server","circuits.web.dispatchers.dispatcher – Default Dispatcher","The Basics","Installing","circuits.app.daemon – Application Daemon","circuits.core.utils – Utilities","Debugging","circuits.core.manager – Manager","Manager","Documentation TODO","circuits.node.events – Events","circuits.core.values – Value","circuits 2.1.0 Documentation","Contributing to circuits","circuits.web.sessions – Sessions","circuits.core.timers – Timers","circuits.web.wrappers – Request/Response Objects","Tutorial","The circuits Framework","circuits.web.errors – Errors","circuits.net.protocols.http – HTTP Protocol","circuits.web.main – circuits.web","How To: Build a Simple Server","circuits.core.components – Components","circuits.web.client – Client","circuits.core.workers – Workers","circuits.web.websocket – WebSocket Client","ChangeLog","circuits.tools – Development Tools","circuits.web.events – Events","circuits.web.utils – Utilities","circuits.node.utils – Node Utilities","Getting Started","circuits.node – Node","circuits.web.dispatchers.jsonrpc – JSON-RPC","Development Processes","circuits.io.notify – File System Notification","The circuits.web Framework","circuits.web.headers – Headers","HowTos","Development Introduction","circuits.web.dispatchers.xmlrpc – XML-RPC","circuits.web.dispatchers.websockets – WebSockets","circuits.net.sockets – Socket Components","circuits.core.events – Events","circuits.web.servers – Servers","Glossary","circuits.web.wsgi – WSGI Support","Quick Start Guide","Events","Contributors","Introduction","circuits.node.client – Client","Handlers","circuits.app.env – Application Environment","circuits.io.file – File I/O","circuits.web.controllers – Controllers","API Reference","circuits.io.serial – Serial I/O","circuits.web.exceptions – Exceptions","Components","Users","circuits.web – Web Framework","circuits.web.constants – Global Constants","circuits.app.config – Application Config","circuits.web.tools – Tools","circuits.net – Networking"],objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","function","Python function"],"5":["py","exception","Python exception"],"6":["py","staticmethod","Python static method"],"7":["py","classmethod","Python class method"]},filenames:["dev/index","api/circuits_web_loggers","web/gettingstarted","api/circuits_web_dispatchers_virtualhosts","api/circuits_net_protocols_irc","api/circuits_app_log","man/values","api/circuits_io","api/circuits_core_pollers","man/tools","api/circuits_net_protocols","start/downloading","faq","pypitest","api/circuits_web_dispatchers_static","api/circuits_node_node","api/circuits_net_protocols_line","api/circuits_core_debugger","api/circuits_core","api/circuits_io_events","start/requirements","api/circuits_app","api/circuits_core_handlers","api/circuits_core_loader","api/circuits_web_http","api/circuits_node_server","api/circuits_web_dispatchers_dispatcher","web/basics","start/installing","api/circuits_app_daemon","api/circuits_core_utils","man/debugging","api/circuits_core_manager","man/manager","todo","api/circuits_node_events","api/circuits_core_values","index","dev/contributing","api/circuits_web_sessions","api/circuits_core_timers","api/circuits_web_wrappers","tutorial/index","man/index","api/circuits_web_errors","api/circuits_net_protocols_http","api/circuits_web_main","howtos/simple_server","api/circuits_core_components","api/circuits_web_client","api/circuits_core_workers","api/circuits_web_websocket","changes","api/circuits_tools","api/circuits_web_events","api/circuits_web_utils","api/circuits_node_utils","start/index","api/circuits_node","api/circuits_web_dispatchers_jsonrpc","dev/processes","api/circuits_io_notify","web/index","api/circuits_web_headers","howtos/index","dev/introduction","api/circuits_web_dispatchers_xmlrpc","api/circuits_web_dispatchers_websockets","api/circuits_net_sockets","api/circuits_core_events","api/circuits_web_servers","glossary","api/circuits_web_wsgi","start/quick","man/events","contributors","web/introduction","api/circuits_node_client","man/handlers","api/circuits_app_env","api/circuits_io_file","api/circuits_web_controllers","api/index","api/circuits_io_serial","api/circuits_web_exceptions","man/components","users","api/circuits_web","api/circuits_web_constants","api/circuits_app_config","api/circuits_web_tools","api/circuits_net"]})circuits-2.1.0/docs/build/html/search.html0000644000014400001440000001125112113366704020221 0ustar prologicusers Search — circuits 2.1.0 documentation
          up
          circuits-2.1.0/docs/build/html/py-modindex.html0000644000014400001440000004521012113366704021213 0ustar prologicusers Python Module Index — circuits 2.1.0 documentation

          Python Module Index

          c
           
          c
          circuits
              circuits.app
              circuits.app.config
              circuits.app.daemon
              circuits.app.env
              circuits.app.log
              circuits.core
              circuits.core.components
              circuits.core.debugger
              circuits.core.events
              circuits.core.handlers
              circuits.core.loader
              circuits.core.manager
              circuits.core.pollers
              circuits.core.timers
              circuits.core.utils
              circuits.core.values
              circuits.core.workers
              circuits.io
              circuits.io.events
              circuits.io.file
              circuits.io.notify
              circuits.io.serial
              circuits.net
              circuits.net.protocols
              circuits.net.protocols.http
              circuits.net.protocols.irc
              circuits.net.protocols.line
              circuits.net.sockets
              circuits.node
              circuits.node.client
              circuits.node.events
              circuits.node.node
              circuits.node.server
              circuits.node.utils
              circuits.tools
              circuits.web
              circuits.web.client
              circuits.web.constants
              circuits.web.controllers
              circuits.web.dispatchers.dispatcher
              circuits.web.dispatchers.jsonrpc
              circuits.web.dispatchers.static
              circuits.web.dispatchers.virtualhosts
              circuits.web.dispatchers.websockets
              circuits.web.dispatchers.xmlrpc
              circuits.web.errors
              circuits.web.events
              circuits.web.exceptions
              circuits.web.headers
              circuits.web.http
              circuits.web.loggers
              circuits.web.main
              circuits.web.servers
              circuits.web.sessions
              circuits.web.tools
              circuits.web.utils
              circuits.web.websocket
              circuits.web.wrappers
              circuits.web.wsgi
          up
          circuits-2.1.0/docs/build/html/users.html0000644000014400001440000001765212113366703020127 0ustar prologicusers Users — circuits 2.1.0 documentation

          Users

          Applications written in circuits

          • SahrisWiki a Wiki / CMS / Blogging Engine.
          • kdb a pluggable IRC Bot Framework.

          Applications integrating circuits

          • realXtend <http://realxtend.org/>) Next generation virtual worlds viewer; Naali, for Python components. Worked on by Toni Alatalo and Petri Aura at Playsign <http://www.playsign.net/> in collaboration with other realXtend developers.
          • PriceWaterHouseCoopers <http://www.pwc.com/>) TAMS Report Generator written by James Mills and Michael Anton.
          • Mangahelpers Profiler for checking our webpages generation times, SQL and cache queries times, project page on <https://launchpad.net/website-profiler>

          Other Users

          « previous | up | next »
          circuits-2.1.0/docs/build/html/genindex.html0000644000014400001440000015013712113366703020563 0ustar prologicusers Index — circuits 2.1.0 documentation

          Index

          _ | A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X

          _

          _on_httperror() (circuits.web.http.HTTP method)
          _on_read() (circuits.web.http.HTTP method)
          _on_request_success() (circuits.web.http.HTTP method)
          _on_response() (circuits.web.http.HTTP method)

          A

          AcceptElement (class in circuits.web.headers)
          Accessed (class in circuits.io.notify)
          add_header() (circuits.web.headers.Headers method)
          Application (class in circuits.web.wsgi)

          B

          BadGateway
          BadRequest
          BaseComponent (class in circuits.core.components)
          BasePoller (class in circuits.core.pollers)
          BaseServer (class in circuits.web.servers)
          basic_auth() (in module circuits.web.tools)
          Body (class in circuits.web.wrappers)
          broadcast() (circuits.net.sockets.UDPServer method)

          C

          call() (circuits.core.manager.Manager method)
          callEvent() (circuits.core.manager.Manager method)
          channel (circuits.net.sockets.Client attribute)
          (circuits.net.sockets.Server attribute)
          (circuits.web.client.Client attribute)
          (circuits.web.websocket.WebSocketClient attribute)
          check_auth() (in module circuits.web.tools)
          circuits.app (module)
          circuits.app.config (module)
          circuits.app.daemon (module)
          circuits.app.env (module)
          circuits.app.log (module)
          circuits.core (module)
          circuits.core.components (module)
          circuits.core.debugger (module)
          circuits.core.events (module)
          circuits.core.handlers (module)
          circuits.core.loader (module)
          circuits.core.manager (module)
          circuits.core.pollers (module)
          circuits.core.timers (module)
          circuits.core.utils (module)
          circuits.core.values (module)
          circuits.core.workers (module)
          circuits.io (module)
          circuits.io.events (module)
          circuits.io.file (module)
          circuits.io.notify (module)
          circuits.io.serial (module)
          circuits.net (module)
          circuits.net.protocols (module)
          circuits.net.protocols.http (module)
          circuits.net.protocols.irc (module)
          circuits.net.protocols.line (module)
          circuits.net.sockets (module)
          circuits.node (module)
          circuits.node.client (module)
          circuits.node.events (module)
          circuits.node.node (module)
          circuits.node.server (module)
          circuits.node.utils (module)
          circuits.tools (module)
          circuits.web (module)
          circuits.web.client (module)
          circuits.web.constants (module)
          circuits.web.controllers (module)
          circuits.web.dispatchers.dispatcher (module)
          circuits.web.dispatchers.jsonrpc (module)
          circuits.web.dispatchers.static (module)
          circuits.web.dispatchers.virtualhosts (module)
          circuits.web.dispatchers.websockets (module)
          circuits.web.dispatchers.xmlrpc (module)
          circuits.web.errors (module)
          circuits.web.events (module)
          circuits.web.exceptions (module)
          circuits.web.headers (module)
          circuits.web.http (module)
          circuits.web.loggers (module)
          circuits.web.main (module)
          circuits.web.servers (module)
          circuits.web.sessions (module)
          circuits.web.tools (module)
          circuits.web.utils (module)
          circuits.web.websocket (module)
          circuits.web.wrappers (module)
          circuits.web.wsgi (module)
          Client (class in circuits.net.sockets)
          (class in circuits.node.client)
          (class in circuits.web.client)
          Close (class in circuits.io.events)
          (class in circuits.net.sockets)
          close() (circuits.net.sockets.Client method)
          (circuits.net.sockets.Server method)
          (circuits.net.sockets.UDPServer method)
          (circuits.web.client.Client method)
          (circuits.web.websocket.WebSocketClient method)
          Closed (class in circuits.io.events)
          (class in circuits.io.notify)
          (class in circuits.net.sockets)
          Component (class in circuits.core.components)
          compress() (in module circuits.web.utils)
          Config (class in circuits.app.config)
          Connect (class in circuits.net.sockets)
          connect() (circuits.net.sockets.TCPClient method)
          (circuits.net.sockets.UNIXClient method)
          (circuits.web.client.Client method)
          connected (circuits.net.sockets.Client attribute)
          (circuits.net.sockets.Server attribute)
          (circuits.web.client.Client attribute)
          (circuits.web.websocket.WebSocketClient attribute)
          Connected (class in circuits.net.sockets)
          Controller (class in circuits.web.controllers)
          Create (class in circuits.app.env)
          create() (circuits.web.events.Request class method)
          Created (class in circuits.io.notify)

          D

          Daemon (class in circuits.app.daemon)
          Daemonize (class in circuits.app.daemon)
          Debugger (class in circuits.core.debugger)
          Deleted (class in circuits.io.notify)
          dictform() (in module circuits.web.utils)
          digest_auth() (in module circuits.web.tools)
          Disconnect (class in circuits.net.sockets)
          Disconnected (class in circuits.net.sockets)
          Dispatcher (class in circuits.web.dispatchers.dispatcher)
          dump_event() (in module circuits.node.utils)
          dump_value() (in module circuits.node.utils)

          E

          elements() (circuits.web.headers.Headers method)
          Environment (class in circuits.app.env)
          EOF (class in circuits.io.events)
          EPoll (class in circuits.core.pollers)
          Error (class in circuits.core.events)
          (class in circuits.io.events)
          Event (class in circuits.core.events)
          expires() (in module circuits.web.tools)
          expose() (in module circuits.web.controllers)
          exposeJSON() (in module circuits.web.controllers)

          F

          Failure (class in circuits.core.events)
          File (class in circuits.io.file)
          file_generator() (in module circuits.web.wrappers)
          findchannel() (in module circuits.core.utils)
          findcmp() (in module circuits.core.utils)
          findroot() (in module circuits.core.utils)
          findtype() (in module circuits.core.utils)
          fire() (circuits.core.manager.Manager method)
          fireEvent() (circuits.core.manager.Manager method)
          flatten() (in module circuits.core.utils)
          flush() (circuits.core.manager.Manager method)
          flushEvents() (circuits.core.manager.Manager method)
          Forbidden
          (class in circuits.web.errors)
          formattime() (in module circuits.web.loggers)
          from_str() (circuits.web.headers.HeaderElement class method)

          G

          Gateway (class in circuits.web.wsgi)
          GenerateEvents (class in circuits.core.events)
          get() (circuits.web.headers.Headers method)
          get_all() (circuits.web.headers.Headers method)
          get_ranges() (in module circuits.web.utils)
          Gone
          graph() (in module circuits.tools)
          gzip() (in module circuits.web.tools)

          H

          handler() (in module circuits.core.handlers)
          HandlerMetaClass (class in circuits.core.handlers)
          handlers() (circuits.core.components.BaseComponent class method)
          handles() (circuits.core.components.BaseComponent class method)
          has_key() (circuits.web.headers.Headers method)
          header_elements() (in module circuits.web.headers)
          HeaderElement (class in circuits.web.headers)
          Headers (class in circuits.web.headers)
          host (circuits.net.sockets.Server attribute)
          Host (class in circuits.web.wrappers)
          HTTP (class in circuits.net.protocols.http)
          (class in circuits.web.http)
          HTTPError (class in circuits.web.errors)
          HTTPException

          I

          in_subtree() (circuits.core.components.PrepareUnregister method)
          InternalServerError
          IRC (class in circuits.net.protocols.irc)
          items() (circuits.web.headers.Headers method)

          J

          JSONController (class in circuits.web.controllers)
          JSONRPC (class in circuits.web.dispatchers.jsonrpc)

          K

          keys() (circuits.web.headers.Headers method)

          L

          LengthRequired
          Line (class in circuits.net.protocols.line)
          line() (circuits.net.protocols.irc.IRC method)
          Load (class in circuits.app.config)
          (class in circuits.app.env)
          load_event() (in module circuits.node.utils)
          load_value() (in module circuits.node.utils)
          Loader (class in circuits.core.loader)
          Log (class in circuits.app.log)
          Logger (class in circuits.app.log)
          (class in circuits.web.loggers)
          LP (class in circuits.net.protocols.line)

          M

          Manager (class in circuits.core.manager)
          MethodNotAllowed
          Modified (class in circuits.io.notify)
          Moved (class in circuits.io.notify)

          N

          name (circuits.core.manager.Manager attribute)
          Node (class in circuits.node.node)
          NotAcceptable
          NotFound
          (class in circuits.web.errors)
          Notify (class in circuits.io.notify)
          NotImplemented

          O

          Opened (class in circuits.io.events)
          (class in circuits.io.notify)

          P

          Packet (class in circuits.node.events)
          parse() (circuits.web.headers.HeaderElement static method)
          parse_bind_parameter() (circuits.net.sockets.Client method)
          (circuits.net.sockets.Server method)
          (circuits.net.sockets.TCPServer method)
          parse_body() (in module circuits.web.utils)
          parse_headers() (in module circuits.web.headers)
          parse_qs() (in module circuits.web.utils)
          pid (circuits.core.manager.Manager attribute)
          Pipe() (in module circuits.net.sockets)
          Poll (class in circuits.core.pollers)
          port (circuits.net.sockets.Server attribute)
          PreconditionFailed
          PrepareUnregister (class in circuits.core.components)

          Q

          qvalue (circuits.web.headers.AcceptElement attribute)

          R

          RAW (class in circuits.net.protocols.irc)
          Read (class in circuits.io.events)
          (class in circuits.net.sockets)
          ready() (circuits.net.sockets.UNIXClient method)
          Redirect
          (class in circuits.web.errors)
          reduce_time_left() (circuits.core.events.GenerateEvents method)
          register() (circuits.core.components.BaseComponent method)
          Registered (class in circuits.core.events)
          Remote (class in circuits.node.events)
          reprhandler() (in module circuits.core.handlers)
          Request (class in circuits.net.protocols.http)
          (class in circuits.web.client)
          (class in circuits.web.events)
          (class in circuits.web.wrappers)
          request() (circuits.web.client.Client method)
          RequestEntityTooLarge
          RequestTimeout
          RequestURITooLarge
          reset() (circuits.core.timers.Timer method)
          response (circuits.web.client.Client attribute)
          Response (class in circuits.net.protocols.http)
          (class in circuits.web.events)
          (class in circuits.web.wrappers)
          RPC (class in circuits.web.dispatchers.jsonrpc)
          (class in circuits.web.dispatchers.xmlrpc)
          run() (circuits.core.manager.Manager method)
          running (circuits.core.manager.Manager attribute)

          S

          safeimport() (in module circuits.core.utils)
          Save (class in circuits.app.config)
          Seek (class in circuits.io.events)
          Select (class in circuits.core.pollers)
          Serial (class in circuits.io.serial)
          serve_download() (in module circuits.web.tools)
          serve_file() (in module circuits.web.tools)
          server (circuits.web.wrappers.Request attribute)
          Server (class in circuits.net.sockets)
          (class in circuits.node.server)
          (class in circuits.web.servers)
          ServiceUnavailable
          Sessions (class in circuits.web.sessions)
          setdefault() (circuits.web.headers.Headers method)
          Signal (class in circuits.core.events)
          SingletonError (class in circuits.core.components)
          socket_family (circuits.net.sockets.TCPClient attribute)
          (circuits.net.sockets.TCPServer attribute)
          (circuits.net.sockets.UDPServer attribute)
          SocketError (class in circuits.net.sockets)
          start() (circuits.core.manager.Manager method)
          Started (class in circuits.core.events)
          Static (class in circuits.web.dispatchers.static)
          stop() (circuits.core.manager.Manager method)
          Stopped (class in circuits.core.events)
          Stream (class in circuits.web.events)
          Success (class in circuits.core.events)

          T

          Task (class in circuits.core.workers)
          TCPClient (class in circuits.net.sockets)
          TCPServer (class in circuits.net.sockets)
          tick() (circuits.core.manager.Manager method)
          time_left (circuits.core.events.GenerateEvents attribute)
          Timer (class in circuits.core.timers)

          U

          UDPClient (in module circuits.net.sockets)
          UDPServer (class in circuits.net.sockets)
          Unauthorized
          (class in circuits.web.errors)
          UnicodeError
          UNIXClient (class in circuits.net.sockets)
          UNIXServer (class in circuits.net.sockets)
          Unmounted (class in circuits.io.notify)
          Unregister (class in circuits.core.events)
          unregister() (circuits.core.components.BaseComponent method)
          Unregistered (class in circuits.core.events)
          UnsupportedMediaType
          url() (in module circuits.web.utils)

          V

          validate_etags() (in module circuits.web.tools)
          validate_since() (in module circuits.web.tools)
          Value (class in circuits.core.values)
          values() (circuits.web.headers.Headers method)
          VCS
          VirtualHosts (class in circuits.web.dispatchers.virtualhosts)

          W

          WebEvent (class in circuits.web.events)
          WebSocketClient (class in circuits.web.websocket)
          WebSockets (class in circuits.web.dispatchers.websockets)
          Worker (class in circuits.core.workers)
          Write (class in circuits.io.events)
          (class in circuits.net.sockets)
          write() (circuits.net.sockets.Client method)
          (circuits.net.sockets.Server method)
          (circuits.net.sockets.UDPServer method)
          (circuits.web.client.Client method)
          WritePID (class in circuits.app.daemon)

          X

          XMLRPC (class in circuits.web.dispatchers.xmlrpc)
          up
          circuits-2.1.0/docs/build/html/changes.html0000644000014400001440000015372212113366701020373 0ustar prologicusers ChangeLog — circuits 2.1.0 documentation

          ChangeLog

          circuits-2.1.0 20130224 (<release>)

          Features

          • Added IPv6 Support [#39987887]
          • Document and Comment all Examples [#40112459]
          • Update WebSockets dispatcher in circuits.web [40064247]
          • Component Event Handlers Property [#41573841]
          • Component targeting performance [#41644031]
          • Multi-App WSGI Gateway [#40071339]
          • More efficient timer implementation [#43700669]

          Bugs

          • Fix the broken links in the Users page [#40063597]
          • circuits.tools.inspect shows incorrect ticks [#41650961]
          • Race Condition with call/wait primitives [#41643711]
          • RESTful Dispatcher [#41643773]
          • Fix Component instance targeting [#41644025]
          • Worker Processes [#41643831]
          • Make examples/web/sslserver.py work again [42007509]
          • Value instance in body [43287263]

          Chores

          • Import shadowing in manager.py [#41644023]
          • Run the codebase through flake8 [#41651093]
          • URL Quoting Unit Test [#41882655]
          • SSL Unit Test [#42849393]
          • Python 3.x Support [43027337]
          • Fill out FAQ in Docs [#43389199]
          • Write Developer Docs [#43389193]

          Other Changes

          A list of other changes we forgot to track :)

          • Fixed latency timing for circuits.bench on win32

          • Updated the URL for ReadTheDocs

          • Updated the Getting Started / Downloading documentation to say something about the Tags tab for downloading archives.

          • Removed unused import in circuits.app.env

          • Added some documentation about how HTTP requests are handled.

          • Removed unused code

          • A simple chat server implementation (Examples)

          • Fixed a bug with Manager.processTasks and Error event firing. handler was not being set correctly

          • Fixes wrong variable names in sockets.py

          • Fixed an UnboundLocalError bug

          • Expect the original method to be passed as input to Manager.removeHandler Manager.addHandler now returns a reference to the original method.

          • Guard against a None _sock or non-existent _sock object.

          • Allow a custom host, port and secure option to be passed to the connect event handler of circuits.web.client.Client

          • Redesigned tests/web/conftest.py with newer pytest APIs using @pytest.fixture(...)

          • Experimental new Watcher/Manager fixtures

          • Docs for Fallback generator

          • Removing the concept of _ticks, @tick and friends

          • Fixes timers

          • Reimplemented circuits.io.File as per circuits.net.sockets

          • Re-implemented Notify Component and fixed test

          • Reworked Notifier Component to be more async friendly

          • Fixed a bug with the repr of Manager and thus Components with non-str channels. eg: (1, 1)

          • Added a unit test for generate_events handler

          • Fixed terminal example demonstrating Streaming with circuits.web

          • Fixed index page for terminal web example

          • Added an Open event to File

          • Fixed a bug with the static dispatcher for circuits.web whereby the path was not being unquoted

          • Fixed a bug with the static circuits.web dispatcher whereby directory listing did not quote urls

          • Added simple examples demonstrating circuits’ primitives

          • Added example of .fire(...) primitive

          • Restructured circuits.io and implemented circuits.io.Process with unit test

          • Added Hello World example

          • Made components started in process mode not link by default. Have to explicitly set the kwarg link=component_instance.

          • Fixed raising of SystemExit or KeyboardInterrupt.

          • Modified the way caching works with the Static dispatcher

          • Brought back the circuits.core.bridge.Bridge. With it better inter-process communications via high-speed full duplex pipes using circuits.net.sockets.Pipe (UNIX Only), a much simpler API.

            In addition, a change to the way Value Notification works. .notify of an event instance can either be True or a channel to send the ValueChanged event to.

          • Added timers examples resurrected from old circuits

          • Global handlers and component targeting Global handlers would be ignored when using component targeting.

            This patch considers them. To do this, we have added an extra property to managers.

            You can use traverse_children_handlers to increase performance when you have a huge number of components. Put the components that are only meant to be used with component targeting under a single component. The hierarchy looks like this:

            Root -> Umbrella Component -> Component 1, Component 2, Component 3, ...
     -> Debugger()
     -> etc

          • Set Umbrella Component traverse_children_handlers to false to prevent traversing the huge number of children components.

          • Fixed Connection header interpretation.

          • Updated documentation for WebSocket.

          • Removed pool - covered by worker

          • Fixed dispatchers return value.

          • Firing Connect event when a web socket connection is established to make behavior look even more like ordinary sockets.

          • Nuked @future decorator due to pickling problems for processes.

          • Allow coroutine-style tasks to terminate the system via raise of SystemExit or KeyboardInterrupt

          • Dropping events unnoticed when waiting is definitely a bad idea. Fixed.

          • Clarification on implementing a GenerateEvents handler.

          • Optimized GenerateEvents handling.

          • Optimized management of FallbackGenerator.

          • Fixed a problem with events being out of sequence when _fire is called recursively. The fix exposes a problem with conftest.Waiter (events getting lost because they are produced too fast, therefore queue is increased). Reducing production rate will be in next commit.

          • Small fix for new event queue handling.

          • Fixed problem with handler cache update and concurrent event handling/structure changes. This happens e.g. in unit tests when the app is started and the test program adds or removes components concurrently.

          • Optimized/clarified GenerateEvents implementation.

          • One more concurrency problem fixed.

          • Fixed generate events handler.

          • Fixed bug with handler cache being always invalidated. Avoid stop() acting as concurrent thread on _dispatcher()

          • Fixed payload length calculation in web sockets protocol.

          • Some very small - but measurable - performance improvements. Checking them in mainly because now no one else needs to think about whether they have an effect.

          • Fixed IPv6 socket tests for OSX and badly configured IPv6 networks

          • Fixed ready handler for test_node

          • Re-added an old revived example of an IRC Client integrating the urwid curses library for the interface

          • Added an example of using yield to perform cooperative multi-tasking inside a request event handler

          • Uses echo for test_process

          • Fixes process stdout/stderr handling Process was not waiting for all output from a process to have been processed and resulted sometimes some of the process output being lost while stopping.

          • Added a fall back error handler, so problems aren’t discarded silently any more.

          • Fixed a TypeError being raised in the request handler for WebSockets dispatcher

          • Prevent the underlying TCPClient connect handler from inadvertently being triggered by connect events being fired to the web client

          • Added tox configuration file. Just run: tox

          • Configure tox to output junitxml

          • Fixed the logic of path -> wsgi dispatching in Gateway

          • Fixed an awful bug with wrappers.Response whereby a default Content-Type was always set regardless and didn’t allow anything else to set this.

          • Fixed test_disps so it doesn’t use an existing port that’s in use.

          • Added a missing piece of WSGI 1.0 functionality for wsgi.Gateway. The write() callable

          • Rewrite test_filer unit test. Ensured EOF event is not triggered for files opened in a or + modes.

          • Added simple examples demonstrating circuits’ primitives

          • Added example of .fire(...) primitive

          • Restructured circuits.io and implemented circuits.io.Process with unit test

          • Forgot to add test_process unit test

          • Added Hello World example

          • Fixed event handler for generate_events

          • Implemented multiprocessing support with communication via full duplex pipes. Fixed worker processes and added unit test

          • Made components started in process mode not link by default. Have to explicitly set the kwarg link=True

          • Fixed process pools and added unit test

          • Fixed name of method for handling inotify events - conflicting with ._process of Manager/Component

          • Renamed ._process to .__process so as to not conflict with Worker

          • Fixed raising of SystemExit or KeyboardInterrupt

          • Trying to fix sending/receiving of events and their values

          • Fixed IPv6 address evaluation.

          • WebSockets reimplemented as specified by RFC 6455.

          • Modified the way caching works with the Statis dispatcher and serve_file(...) function. Set Last-Modified instead of a large Expires header.

          • Marked as a Missing Feature - still being worked on.

          • Brought back the circuits.core.bridge.Bridge. With it better inter-process communications via high-speed full duplex pipes using circuits.net.sockets.Pipe (UNIX Only), a much simpler API.

            In addition, a chnage to the way Value Notification works. .notify of an event instance can either be True or a channel to send the ValueChanged event to.

          • Causes errors. Wrong thing to do here.

          • Use uuid4 for worker channels.

          • Removed left over debugging code

          • Added capability of components started in proces mode to link to artbritrary managers other than themselves (if link=True)

          • Added unit test for testing a component in process mode linked with another parent system separately

          • Added timers examples ressurected from old circuits

          • Thread safety for watcher

          • Reverts test_component_targeting.py

          • Fixed Connection header interpretation.

          • Updated documentation for WebSocket.

          • Changed the way process linking works by not starting the parent in thread mode.

          • Fixes watcher test fixture

          • Implemented .handlers() and re-implemented .handles(). [Delivers #41573841]

          • Removed superfluous bridge test

          • Fixed usage of .start starting Workers in process mode

          • Better internal variable name

          • Start worked either when the system starts or we are regsitered to an already started system

          • Implemented .handlers() correctly

          • Set unique channels for the Pipe and Bridge when briding processes

          • Removed. Going to reimplement all this

          • Don’t cause a nastry fork bomb!

          • Marked test_process_pool as skipping XXX: Broken Functionality

          • Fixed sleeping when nothing to do adding needs_resume logic to the pollers

          • Proposed new Worker Component – wrapping multiprocessing.Process

          • Accidentla commit

          • Trying to re-implement Pool...

          • Marked some tests as broken

          • Added support for both Process and Thread in Worker component with same API.

          • Reverted changes to the task handler for Worker

          • Removed .resume()

          • Fixed some brokeness in future

          • Trying to make @future work with Worker in process mode

          • Lock bench

          • Switches worker to apply_async

          • Allow the poller to sleep when tasks are running

          • Use ThreadPool for worker threads

          • Cleaned up Worker

          • benchmark only branch

          • Removed pool - covered by worker

          • Workaround for Threadpool bug started from secondary threads

          • Fixed dispatchers return value.

          • Firing Connect event when a web socket connection is established to make behavior look even more like ordinary sockets.

          • Restored 2.0.1 GenerateEvents handling with minor enhancements to get things working again.

          • Nuked @future decotator due to pickling problems for processes.

          • Unmarked test as failing. Test now passes prefectly

          • Allow coroutine-style tasks to terminate the system via raise of SystemExit or KeyboardINterrupt

          • Fixed SSL support for circuits.web [Delivers #42007509]

          • Dropping events unnoticed when waiting is definitely a bad idea. Fixed.

          • Clarification on implementing a GenerateEvents handler.

          • Added missing import (timed wait with FallBackGenerator cannot have worked for some time).

          • Optimized GenerateEvents handling.

          • Backed out of changeset 3413:98d0056ef18a

          • Optimized management of FallbackGenerator.

          • Fixed a problem with events being out of sequence when _fire is called recursively. The fix exposes a problem with conftest.Waiter (events getting lost because they are produced too fast, therefore queue is increased). Reducing production rate will be in next commit.

          • Small fix for new event queue handling.

          • Fixed problem with handler cache update and concurrent event handling/structure changes. This happens e.g. in unit tests when the app is started and the test program adds or removes components concurrently.

          • Optimized/clarified GenerateEvents implementation.

          • One more concurrency problem fixed.

          • Fixed generate events handler.

          • Fixed bug with handler cache being always invalidated. Avoid stop() acting as concurrent thread on _dispatcher().

          • Added unit test for url quoting of static files for the static circuits.web dispatcher. [Delivers #41882655]

          • Added unit test for secure circutis.web server. [Delivers #42849393]

          • Fixed creation/registration/location of poller upon startup or registration

          • Skip test_secure_server if ssl is not available

          • Fixed payload length calculation in web sockets protocol.

          • Some very small - but measurable - performance improvements. Checking them in mainly because now no one else needs to think about whether they have an effect.

          • Fixed conflicting attribute.

          • Added new .pid property to Manager fixing tests.core.test_bridge - Broken by 70677b69bf05

          • Fixed ipv6 socket tests for OSX and badly configured IPv6 networks

          • Ugly fix for this test

          • Fixed ready handler for test_node

          • For some reason removing max_events in the Watcher fixture for esting purposes fixes some tests on OSX

          • Small sample to hopefully test for memory leaks :)

          • Improved .handlers() to recursively return handlers of it’s subclasses whilst filtering out private handlers (_.*)

          • Use BaseComponent for convenience for non-handler methods

          • Return a list of all handlers except handlers listneing to private events

          • Left over print - oops :)

          • Moved to examples/

          • Re-added an old revived example of an IRC Client integrating the urwid curses library for the interface

          • Improved comment.

          • Added multi-add support for Gateway web compnoent [Delivers #40071339]

          • Fixed Python 3 compatibility for retrieving the .resumse() method. Fixes Issue #35

          • Removed unused StringIO import

          • A bunch of Python 3.1 compatibility fixes (mostly import fixes)

          • Added an example of using yield to perform cooperative multi-tasking inside a request event handler

          • Uses echo for test_process

          • Fixes process stdout/stderr handling Process was not waiting for all output from a process to have been processed and resulted sometimes some of the process output being lost while stopping.

          • A bunch more Python 3 fixes. Using the six module here.

          • Added a fall back error handler, so problems aren’t discarded silently any more.

          • Ooops accidently committed this

          • Fixed some Python 3 import issues

          • More Python 3 fixes

          • Fixed Python 3 issue with iterators

          • Use range for Python 3 compatibility

          • Fixed assertions for Python 3 compat

          • Accidently commited a test with Debugger

          • Fixed value_changed handler to check correctly for binary types (Python 3 fixes)

          • Python 3 fixes for string type checks

          • Refactored for Python 3

          • More Python 3 fixes. Marked the rest as Broken on Python 3

          • Fixed broken web tests for Python 3 by wrapping the request body in a TextIOWrapper for FieldStorage

          • Fixed XML and JSON RPC Dispatchers for Python 3

          • Replace .has_key() with in for Python 3 compatibility

          • Fixed a TypeError being raised in the request handler for websockets dispatcher

          • Prevent the underlying TCPClient connect handler from inadvertently being triggered by connec events being fired to the web client

          • Unmarked as skipping. No longer broken on Python 3

          • Finished cleaning up my code base.

          • Removed some debugging junk I had forgotten to get rid of.

          • Fixed File for Python 3 support adding optional encoding support

          • Fixed Process for Python 3

          • Ooops :/

          • Fixed test_logger_Error for Python 3

          • Fixed Bridge for Python 3

          • Fixed Node for Python 3

          • Added pytest.PYVER and Marked test_secure_server web test as Broken on Python 3.2 (needs fixing)

          • Marked a bunch of 3.2 and 3.3 specific tests that are broken with these versions (needs looking into)

          • Removed Broken on Python 3 marked - these tests now pass on 3.1 3.2 and 3.3

          • Fixed SSL Sockets for Python 3.2/3.3 (Should do_handshake() be executed in a thread?)

          • Added tox configuration file. Just run: run

          • Configure tox to output junitxml

          • Fixed tox configuration

          • Assuming localhost was incorrect. Sorry Mark :/

          • Fixed test_logger for pypy

          • Backed out changeset 7be64d8b6f7c

          • Reconfigured tox settings

          • Hopefully fixed tox.ini to detect jenkins

          • Fixed tox.ini to work on jenkins (can’t seem to auto detect jenkins :/)

          • Added tox config for checking documetnation

          • Changed the output filename of xml resutls for docs env (tox)

          • Added pytest-cov as a dep to the docs env (tox)

          • Configured coverage to output xml output

          • Removed ptest-cov dep from docs env (tox)

          • Trying to fix the randomly failing test_node test.

          • Ooops broke wait_for - fixed hopefully

          • Backed out changeset 795712654602

          • Backed out changeset 1ee04d5fb657

          • Added ignore for generated junitxml output files

          • Hopefully an improved unit test for node using the manager and watcher fixtures.

          • Updated with supported version of Python

          • Fixed the logic of path -> wsgi dispatching in Gateway

          • Fixed an awful bug with wrappers.Response whereby a default Content-Type was always set regardless and didn’t allow anything else to set this.

          • Fixed test_disps so it doesn’t use an existing port that’s in use.

          • Added a missing piece of WSGI 1.0 functionality for wsgi.Gateway – The write() callable

          • Write bytes in this test

          • Correctly handle unicode (I think)

          • Fixed a bug with null responses from WSGI Applications hosted by wsgi.Gateway. Empty class did not implement __nonzero__ for Python 2.x [Delivers #43287263]

          • Remvoed pyinotify dep from tox config so Windows tests can run

          • Skip test_unixserver for Windows

          • Skip this test on Windows

          • Skip these tests on Windows

          • Skip this test on Windows

          • Fixed test_tcp_bind for Windows

          • Updated docs and re-added FAQ from old wiki (updated slightly) [Delivers #43389199]

          • Fixed bottom of FAQ

          • Updated Change Log [#42945315]

          • Updated Release Notes [#42945315]

          • Fixed list of new changes for 2.1.0 release notes

          • Updated Developet Docs

          • Bumped version to 2.1.0

          • More resource efficient timer implementation [Delivers #43700669].

          • Fixed a problem with cLength being unknown if self.body == False.

          • Test fails on shining panda py32 only. May be a race condition (wait_for using same loop interval as timer interval). Checking in for testing.

          • Fixed problem with “Content-Length: 0” header not being generated for empty responses.

          • Backed out of changeset 3575:ece3ee5472ef, makes CI hang for unknown reason.

          • Hopefully finally fixed problems with timer test on CI platform.

          • Updated pypi classifier for circuits

          • Fixed random problems with opening SSL socket.

          • Fixed concurrence problem (doing reset() in event loop and calling unregister() concurrently).

          • Modified test a bit to find out what happens in CI environment (problem not reproducible in local py32).

          • Calling headers.setdefault twice for the same name doesn’t make sense.

          • Adapted test case to previous fix.

          • Fixed problem with “Content-Length: 0” header not being generated for empty responses.

          • Fixed insecure usage of class variable.

          • Reverted to old timer implementation. Cannot find bug in new version that only occurs in CI/py32 environment (cannot be reproduced locally).

          • Make sure that check runs faster than timer increments.

          • Added missing Content-Length header (must be present according to RFC 2616).

          • Provide a more informative representation.

          • Fixed a docstring typo

          • Just re-raise the exception here rather than hide it with an InternalServer exception

          • Potential failing test for [#43885227]

          • Fixed problem with receiving incomplete header data (first chunk doesn’t already include empty line that separates headers and body).

          • Fixed problem with header not being detected if a chunk ends exactly after rn of last header line and next chunk starts with empty line (rn) before body.

          • Fixes inconsisent semantic behavior in channel selection.

          • Fixed expression for _handler_channel in Manager.getHandlers(...)

          • Fixed (and simplified) handler_channel evaluation.

          • Fixed channel representation for cases where channel is a component.

          • Adapted prepare_unregister_complete handling to fixed semantics for using managers as channels.

          • Notifications are to be signaled to the given manager. Now that using managers as channels works properly, it showed that hey never were.

          • Value change notifications are fired using Value’s manager as channel, so mke sure to listen on that.

          • Value’s notifications are fired on its manager component – by default the component that fired the event the value belongs to. Moved handler to proper place (is better place anyway).

          • Encoding is necessary for this to succeed on py3.2 (urllib2 there doesn’t accept body of type str).

          • Added missing files to manifest. [Delivers #44650895] (Closes Issue #36)

          • Fixing encoding problems.

          • Fixing py2/py3 problem by using bytearray as abviously the only common denominator.

          • multipart/form-data is binary. Boundaries are ASCII, but data between boundaries may be anything (depending on part’s header)

          • Trying to fix unicode issues

          • Marked test_node as Broken on Windows - Pickling Error with thread.lock

          • Trying to fix broken unit test on Windows

          • Setup docs with Google Analyitics

          • Marked test_tcp_connect_closed_port(...) as Broken on Windows – Need to fix this; this test is a bit weird :/

          • Marked test_tcp_reconnect(...) test as Broken on Windows

          • Updated state of test_tcp_reconnect(...) test on Windows – Apparently only Broken on Windows on Python 3.2 (odd)

          • Fixed TypeError

          • Marked as Broken on pypy – For some reason we’re getting x00 (null bytes) in the stream when using the Python std lib logger.

          • Marked tests.core.test_debugger.test_filename(...) as Broken on pypy – Need to investigate this

          • Updated support platforms to include pypy

          circuits-2.0.1 20121124

          • Fixed tests/web/test_main.py which was badly written.
          • Fixed a regression test testing the Debugger component

          circuits-2.0.0 20121122 (cheetah)

          • Fixed circuits.web entry point
          • Fixed tools.reprhandler() for compatibility with Python-3.3
          • Added *channels support to waitEvent
          • Added example of using .call
          • Fixed logic around firing the Daemonize event when registering this component during run-time and after start-up
          • Fixed use of reprhandler
          • Fixed listening channel for exceptions/errors.
          • Fixed channels for Log event.
          • Fixed config loading. Fire a Ready event when the Environment is completely ready.
          • Added .items(...) method to Config component.
          • Added BaseEvent, LiteralEvent, DerivedEvent to the core and circuits name-spaces
          • Fixed IRC protocol
          • Added has_option to Config component
          • Avoid error if user un-registers a component twice.
          • Fixed base_url for WebConsole
          • Fixed bug with sending Response for a Expect: 100-continue (Closes issue #32)
          • Added a new circuits.web test that ensures that large posts > 1024 bytes work
          • Updated conf so that doc can be built even if circuits isn’t installed
          • Updated reference of guide to howtos
          • Updated man headers so that they weren’t all “Components”
          • Fixed all web dispatcher tests
          • Fixed XMLRPC dispatcher. Must have a higher priority than the “default” dispatcher in order to coexist with it.
          • Fixed unit test for failure response from web component (component’s handler must have higher priority than default dispatcher if default dispatcher exists).
          • Added failure test for web controller.
          • Fixed JSON dispatcher. Must have a higher priority than the “default” dispatcher in order to coexist with it.
          • Fixed vpath traversal. vpath created in reverse (“test_args/1/2/3” became “3/2/1/test_args”).
          • Fixed evaluation of the Complete event: exclude events fired by other threads during event processing from the set of events to be tracked.
          • Don’t call tick on components that are waiting to be unregistered.
          • Using new PrepareUnregister event to reliably remove sockets from poller.
          • Fixes for PrepareUnregister and added test case.
          • Added event that informs components about going to be removed from the tree.
          • Fixed client request generation (MUST include Host header).
          • Fixed channel naming in web.Client to allow several clients (i.e. connections to web sites) to coexist in an application.
          • Prevented uncameling of event names that represent web requests. Handlers can now use the last path segment unmodified as handled event’s name.
          • Fixed the new dispatcher with new tests
          • Fixed bug in complete event generation.
          • Added optional event signaling the completion of an event and everything that has been caused by it.
          • Added the possibility to redirect the success events to other channels.
          • Updated documentation to reflect the new “handler suspend” feature.
          • Replaced web dispatcher with simpler version
          • Added support for x = yield self.callEvent(...)
          • Made test_main more reliable
          • Removed old BaseManager from playing with GreenletManager. Fixed test_manager_repr
          • Fixed the exceptions being thrown for test_eval, but the test still fails
          • Added a new failing test - evaluation of promised values
          • Removed superfluous .value in test_longwait
          • Added support for alllowing future handlers to have a “special” event parameter just like ordinary handlers.
          • Fixed test_success
          • Fixed test_removeHandler
          • Added support for firing Done() and Success() after all done executing.
          • Fixed callEvent
          • Added 2 failing tests for yield
          • Implemented promises which we detect for in circuits.web in cases where an event handler yields. Also only fire _success events after an event is well and truly finished (in the case of yielding event handlers)
          • Fixed a bug with value not being set
          • Fixed Issue #26
          • Added capability of waiting for a specific event name on a specific channel.
          • Fixed bug guarding against tasks already removed.
          • Implemented Component.init() support whereby one can define an alternative init() without needing to remember to call super(...)
          • Fixed Python 3 compatibility with Unicode strings
          • Added 99bottles as an example of concurrency. See: http://wiki.python.org/moin/Concurrency/99Bottles
          • Removed old-style channel targeting
          • Fixed and tested UDP forwarding
          • Simplified udpclient example
          • Implemented new version of port forwarded. TCP tested.
          • Fixed Read events for UDPServer by setting .notify to True.
          • Restructured the only How To Guide - Building a Simple Server
          • Renamed _get_request_handler to just find_handler
          • Removed channels attribute from WebEvents (fix for issue #29).
          • Added Eclipse configuration files.
          • Fixed uses of deprecated syntax in app.config
          • Modified the defaults for channels. Set channels to event.channels, otherwise self.channel defaulting to *
          • Fixed uses of deprecated syntax in env
          • Fixed a bug with the Redirect event/error in circuits.web where it didn’t handle Unicode strings
          • fixed the web dispatcher
          • Fixed test_poller_reuse test by using the now findtype() utility function
          • fixed and adds tests for the web dispatcher
          • Moved parseBody out into circuits.web.utils. Other code cleanup
          • Added a test for a bug with the dispatcher mehere found.
          • Removed itercmp() function. Added findtype() findchannel() and used better variable names. findcmp is an alias of findtype.
          • Implemented optional singleton support for components
          • Removed the circuits.web routes dispatcher as there are no tests for this and Routes dispatcher is broken - re implement at a later stage
          • Removal of End feedback event
          • Fixed web/test_value.py
          • Fixed web futures test
          • Simplified and fixed a lot of issues the circuits.bench
          • Fixed circuits.web’s exceptions tests and handling of exceptions.
          • Fixed a potential bug with circuits.web.wsgi.Application.
          • Modified Manager to only assign a handler return value if it is not None.
          • Fixed *_success and *_failure events fire on *event.channels so they go to the right place as expected. Fixed Issue #21
          • Removed event equality test and related tests. Seems rather useless and inconsistently used
          • Fixed test_gzip circuits.web test. We no longer have a Started event feedback so have to use a filter
          • Fixed a corner case where one might be trying to compare an event object with a non-event object
          • Fixed the event handling for circuits.web WebSockets Component by separating out the WebSockets handling from the HTTP handling (WebSocketsMediator).
          • Fixed use of Value notification in circuits.web for requests.
          • Fixed a bunch of examples and tests using deprecated features.
          • Fixed the notify io driver and removed Debugger() from test_notify.
          • Added man pages for circuits.bench, circuits.sniff and circuits.web
          • Wrapped UNIX-specific calls in try/except
          • Tidied up examples and removed unused imports
          • removed use of coverage module in daemon test
          • removed use of coverage module in signals test
          • updated .push calls to .fire calls
          • Fixed some deprecations warnings
          • Added support for multiple webserver with different channels + tests for it
          • Added support for silently ignoring errors when writing to stderr from debugger
          • Added requirements.txt file containing requirements for building docs on readthedocs.org
          • Added link to Read the Docs for circuits
          • Updated doc message for success event
          • Fixed interrupt handler to allow ^C to be used to quit sample keyecho app
          • Removed deprecated modules and functions that were deprecated 1.6
          • Deleted old style event success/failure notifiers
          • Fixed handling of components being added/removed when looking for ticks
          • Fixed bug with net.Server .host and .port attributes.
          • Deprecated __tick__. Event handlers can now be specified as tick functions.
          • Fixed handler priority inheritance to make sure we get the results in the right harder
          • Fixed missing import of sys in circuits.io

          circuits-1.6 (oceans) - 20110626

          • Added Python 3 support
          • 80% Code Coverage
          • Added optional greenlet support adding two new primitives. .waitEvent(...) and .callEvent(...).
          • Added an example WebSockets server using circuits.web
          • Added support for specifying a Poll instance to use when using the @future decorator to create “future” event handlers.
          • Added add_section, has_section and set methods to app.config.Config Component.
          • Added support for running test suite with distutils python setup.py test.
          • Added a _on_signal event handler on the BaseEnvironment Component so that environments can be reloaded by listening to SIGHUP signals.
          • Added support for using absolute paths in app.env.Environment.
          • Added support in circuits.web HTTP protocol to limit the no. of header fragments. This prevents OOM exploits.
          • Added a ticks limit to waitEvent
          • Added deprecation warnings for .push .add and .remove methods
          • NEW Loader Component in circuits.core for simple plugin support.
          • NEW app.env and app.config modules including a new app.startup modules integrating a common startup for applications.
          • NEW KQueue poller
          • Fixed issue 17
          • Renamed circuits.web.main module to circuits.web.__main__ so that python -m circuits.web just works.
          • Fixed Server.host and Server.port properties in circuits.net.sockets.
          • Fixed issue 10
          • Fixed app.Daemon Component to correctly open the stderr file.
          • Fixed triggering of Success events.
          • Fixed duplicate broadcast handler in UDPServer
          • Fixed duplicate Disconnect event from being triggered twice on Client socket components.
          • Removed dynamic timeout code from Select poller.
          • Fixed a bug in the circuits.web HTTP protocol where headers were not being buffered per client.
          • Fixes a missing Event Closed() not being triggered for UDPServer.
          • Make underlying UDPServer socket reusable by setting SO_REUSEADDR
          • Fixes Server socket being discarded twice on close + disconnect
          • Socket.write now expects bytes (bytes for python3 and str for python2)
          • Better handling of encoding in HTTP Component (allow non utf-8 encoding)
          • Always encode HTTP headers in utf-8
          • Fixes error after getting socket.ERRCONNREFUSED
          • Allows TCPClient to bind to a specific port
          • Improved docs
          • Handles closing of UDPServer socket when no client is connected
          • Adds an un-register handler for components
          • Allows utils.kill to work from a different thread
          • Fixes bug when handling “*” in channels and targets
          • Fixes a bug that could occur when un-registering components
          • Fixes for CPU usage problems when using circuits with no I/O pollers and using a Timer for timed events
          « previous | up | next »
          circuits-2.1.0/docs/build/html/glossary.html0000644000014400001440000001344412113366702020623 0ustar prologicusers Glossary — circuits 2.1.0 documentation

          Glossary

          VCS
          Version Control System, what you use for versioning your source code
          « previous | up | next »
          circuits-2.1.0/docs/build/doctrees/0000755000014400001440000000000012113366740016732 5ustar prologicuserscircuits-2.1.0/docs/build/doctrees/api/0000755000014400001440000000000012113366740017503 5ustar prologicuserscircuits-2.1.0/docs/build/doctrees/api/circuits_web_wsgi.doctree0000644000014400001440000002627412113366667024610 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(Xcircuits.web.wsgi.ApplicationqX functionsqNX!circuits.web.wsgi -- wsgi supportqNX componentsq NXcircuits.web.wsgi.Gatewayq Xeventsq NuUsubstitution_defsq }q Uparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hhhU functionsqhUcircuits-web-wsgi-wsgi-supportqh U componentsqh h h UeventsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceq cdocutils.nodes reprunicode q!XB/home/prologic/work/circuits/docs/source/api/circuits_web_wsgi.rstq"q#}q$bUtagnameq%Usectionq&U attributesq'}q((Udupnamesq)]q*Uclassesq+]q,Ubackrefsq-]q.Uidsq/]q0(Xmodule-circuits.web.wsgiq1heUnamesq2]q3hauUlineq4KUdocumentq5hh]q6(cdocutils.nodes title q7)q8}q9(hX(:mod:`circuits.web.wsgi` -- WSGI Supportq:hhh h#h%Utitleq;h'}q<(h)]q=h+]q>h-]q?h/]q@h2]qAuh4Kh5hh]qB(csphinx.addnodes pending_xref qC)qD}qE(hX:mod:`circuits.web.wsgi`qFhh8h h#h%U pending_xrefqGh'}qH(UreftypeqIXmodqJUrefwarnqKU reftargetqLXcircuits.web.wsgiqMU refdomainqNXpyqOh/]qPh-]qQU refexplicitqRh)]qSh+]qTh2]qUUrefdocqVUapi/circuits_web_wsgiqWUpy:classqXNU py:moduleqYNuh4Kh]qZcdocutils.nodes literal q[)q\}q](hhFh'}q^(h)]q_h+]q`(UxrefqahOXpy-modqbeh-]qch/]qdh2]qeuhhDh]qfcdocutils.nodes Text qgXcircuits.web.wsgiqhqi}qj(hUhh\ubah%UliteralqkubaubhgX -- WSGI Supportqlqm}qn(hX -- WSGI Supportqohh8ubeubcsphinx.addnodes index qp)qq}qr(hUhhh U qsh%Uindexqth'}qu(h/]qvh-]qwh)]qxh+]qyh2]qzUentriesq{]q|(Usingleq}Xcircuits.web.wsgi (module)Xmodule-circuits.web.wsgiUtq~auh4Kh5hh]qubcdocutils.nodes paragraph q)q}q(hXWSGI Componentsqhhh XP/home/prologic/work/circuits/circuits/web/wsgi.py:docstring of circuits.web.wsgiqh%U paragraphqh'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgXWSGI Componentsqq}q(hhhhubaubh)q}q(hX'This module implements WSGI Components.qhhh hh%hh'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgX'This module implements WSGI Components.qq}q(hhhhubaubh)q}q(hUhhh h#h%h&h'}q(h)]qh+]qh-]qh/]qhah2]qh auh4Kh5hh]q(h7)q}q(hXEventsqhhh h#h%h;h'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgXEventsqq}q(hhhhubaubh)q}q(hX**none**qhhh h#h%hh'}q(h)]qh+]qh-]qh/]qh2]quh4K h5hh]qcdocutils.nodes strong q)q}q(hhh'}q(h)]qh+]qh-]qh/]qh2]quhhh]qhgXnoneqDžq}q(hUhhubah%Ustrongqubaubeubh)q}q(hUhhh h#h%h&h'}q(h)]qh+]qh-]qh/]qhah2]qh auh4Kh5hh]q(h7)q}q(hX Componentsqhhh h#h%h;h'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgX Componentsqޅq}q(hhhhubaubhp)q}q(hUhhh X\/home/prologic/work/circuits/circuits/web/wsgi.py:docstring of circuits.web.wsgi.Applicationqh%hth'}q(h/]qh-]qh)]qh+]qh2]qUentriesq]q(h}X(Application (class in circuits.web.wsgi)hUtqauh4Nh5hh]qubcsphinx.addnodes desc q)q}q(hUhhh hh%Udescqh'}q(UnoindexqUdomainqXpyqh/]qh-]qh)]qh+]qh2]qUobjtypeqXclassqUdesctypeqhuh4Nh5hh]q(csphinx.addnodes desc_signature q)r}r(hXApplication(*args, **kwargs)rhhh U rh%Udesc_signaturerh'}r(h/]rhaUmodulerh!Xcircuits.web.wsgirr }r bh-]r h)]r h+]r h2]rhaUfullnamerX ApplicationrUclassrUUfirstruh4Nh5hh]r(csphinx.addnodes desc_annotation r)r}r(hXclass rhjh jh%Udesc_annotationrh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXclass r r!}r"(hUhjubaubcsphinx.addnodes desc_addname r#)r$}r%(hXcircuits.web.wsgi.r&hjh jh%U desc_addnamer'h'}r((h)]r)h+]r*h-]r+h/]r,h2]r-uh4Nh5hh]r.hgXcircuits.web.wsgi.r/r0}r1(hUhj$ubaubcsphinx.addnodes desc_name r2)r3}r4(hjhjh jh%U desc_namer5h'}r6(h)]r7h+]r8h-]r9h/]r:h2]r;uh4Nh5hh]r<hgX Applicationr=r>}r?(hUhj3ubaubcsphinx.addnodes desc_parameterlist r@)rA}rB(hUhjh jh%Udesc_parameterlistrCh'}rD(h)]rEh+]rFh-]rGh/]rHh2]rIuh4Nh5hh]rJ(csphinx.addnodes desc_parameter rK)rL}rM(hX*argsrNh'}rO(h)]rPh+]rQh-]rRh/]rSh2]rTuhjAh]rUhgX*argsrVrW}rX(hUhjLubah%Udesc_parameterrYubjK)rZ}r[(hX**kwargsr\h'}r](h)]r^h+]r_h-]r`h/]rah2]rbuhjAh]rchgX**kwargsrdre}rf(hUhjZubah%jYubeubeubcsphinx.addnodes desc_content rg)rh}ri(hUhhh jh%U desc_contentrjh'}rk(h)]rlh+]rmh-]rnh/]roh2]rpuh4Nh5hh]rq(h)rr}rs(hX6Bases: :class:`circuits.core.components.BaseComponent`rthjhh U ruh%hh'}rv(h)]rwh+]rxh-]ryh/]rzh2]r{uh4Kh5hh]r|(hgXBases: r}r~}r(hXBases: rhjrubhC)r}r(hX/:class:`circuits.core.components.BaseComponent`rhjrh h#h%hGh'}r(UreftyperXclassrhKhLX&circuits.core.components.BaseComponentrU refdomainrXpyrh/]rh-]rU refexplicitrh)]rh+]rh2]rhVhWhXjhYXcircuits.web.wsgiruh4Kh]rh[)r}r(hjh'}r(h)]rh+]r(hajXpy-classreh-]rh/]rh2]ruhjh]rhgX&circuits.core.components.BaseComponentrr}r(hUhjubah%hkubaubeubh)r}r(hX4initializes x; see x.__class__.__doc__ for signaturerhjhh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgX4initializes x; see x.__class__.__doc__ for signaturerr}r(hjhjubaubeubeubhp)r}r(hUhhh XX/home/prologic/work/circuits/circuits/web/wsgi.py:docstring of circuits.web.wsgi.Gatewayrh%hth'}r(h/]rh-]rh)]rh+]rh2]rUentriesr]r(h}X$Gateway (class in circuits.web.wsgi)h Utrauh4Nh5hh]rubh)r}r(hUhhh jh%hh'}r(hhXpyrh/]rh-]rh)]rh+]rh2]rhXclassrhjuh4Nh5hh]r(h)r}r(hXGateway(*args, **kwargs)rhjh jh%jh'}r(h/]rh ajh!Xcircuits.web.wsgirr}rbh-]rh)]rh+]rh2]rh ajXGatewayrjUjuh4Nh5hh]r(j)r}r(hXclass rhjh jh%jh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXclass rr}r(hUhjubaubj#)r}r(hXcircuits.web.wsgi.rhjh jh%j'h'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXcircuits.web.wsgi.rr}r(hUhjubaubj2)r}r(hjhjh jh%j5h'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXGatewayrr}r(hUhjubaubj@)r}r(hUhjh jh%jCh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]r(jK)r}r(hX*argsrh'}r(h)]rh+]rh-]rh/]rh2]r uhjh]r hgX*argsr r }r (hUhjubah%jYubjK)r}r(hX**kwargsrh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgX**kwargsrr}r(hUhjubah%jYubeubeubjg)r}r(hUhjh jh%jjh'}r(h)]rh+]rh-]r h/]r!h2]r"uh4Nh5hh]r#(h)r$}r%(hX6Bases: :class:`circuits.core.components.BaseComponent`r&hjh juh%hh'}r'(h)]r(h+]r)h-]r*h/]r+h2]r,uh4Kh5hh]r-(hgXBases: r.r/}r0(hXBases: r1hj$ubhC)r2}r3(hX/:class:`circuits.core.components.BaseComponent`r4hj$h h#h%hGh'}r5(Ureftyper6Xclassr7hKhLX&circuits.core.components.BaseComponentr8U refdomainr9Xpyr:h/]r;h-]r<U refexplicitr=h)]r>h+]r?h2]r@hVhWhXjhYjuh4Kh]rAh[)rB}rC(hj4h'}rD(h)]rEh+]rF(haj:Xpy-classrGeh-]rHh/]rIh2]rJuhj2h]rKhgX&circuits.core.components.BaseComponentrLrM}rN(hUhjBubah%hkubaubeubh)rO}rP(hX4initializes x; see x.__class__.__doc__ for signaturerQhjh jh%hh'}rR(h)]rSh+]rTh-]rUh/]rVh2]rWuh4Kh5hh]rXhgX4initializes x; see x.__class__.__doc__ for signaturerYrZ}r[(hjQhjOubaubeubeubeubh)r\}r](hUhhh h#h%h&h'}r^(h)]r_h+]r`h-]rah/]rbhah2]rchauh4Kh5hh]rd(h7)re}rf(hX Functionsrghj\h h#h%h;h'}rh(h)]rih+]rjh-]rkh/]rlh2]rmuh4Kh5hh]rnhgX Functionsrorp}rq(hjghjeubaubh)rr}rs(hX**none**rthj\h h#h%hh'}ru(h)]rvh+]rwh-]rxh/]ryh2]rzuh4Kh5hh]r{h)r|}r}(hjth'}r~(h)]rh+]rh-]rh/]rh2]ruhjrh]rhgXnonerr}r(hUhj|ubah%hubaubeubeubahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh5hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh;NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUB/home/prologic/work/circuits/docs/source/api/circuits_web_wsgi.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hjhj\h1cdocutils.nodes target r)r}r(hUhhh hsh%Utargetrh'}r(h)]rh/]rh1ah-]rUismodrh+]rh2]ruh4Kh5hh]rubhhhhh jhhuUsubstitution_namesr}rh%h5h'}r(h)]rh/]rh-]rUsourcerh#h+]rh2]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_node_events.doctree0000644000014400001440000005463012113366662025303 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(Xcircuits.node.events.PacketqX functionsqNXcircuits.node.events -- eventsqNX componentsq NXcircuits.node.events.Remoteq Xeventsq NuUsubstitution_defsq }q Uparse_messagesq]qcdocutils.nodes system_message q)q}q(U rawsourceqUUparentqcsphinx.addnodes desc_content q)q}q(hUhcsphinx.addnodes desc q)q}q(hUhcdocutils.nodes section q)q}q(hUhh)q}q(hUhhUsourceq cdocutils.nodes reprunicode q!XE/home/prologic/work/circuits/docs/source/api/circuits_node_events.rstq"q#}q$bUtagnameq%Usectionq&U attributesq'}q((Udupnamesq)]q*Uclassesq+]q,Ubackrefsq-]q.Uidsq/]q0(Xmodule-circuits.node.eventsq1Ucircuits-node-events-eventsq2eUnamesq3]q4hauUlineq5KUdocumentq6hUchildrenq7]q8(cdocutils.nodes title q9)q:}q;(hX%:mod:`circuits.node.events` -- Eventsq(h)]q?h+]q@h-]qAh/]qBh3]qCuh5Kh6hh7]qD(csphinx.addnodes pending_xref qE)qF}qG(hX:mod:`circuits.node.events`qHhh:h h#h%U pending_xrefqIh'}qJ(UreftypeqKXmodqLUrefwarnqMU reftargetqNXcircuits.node.eventsqOU refdomainqPXpyqQh/]qRh-]qSU refexplicitqTh)]qUh+]qVh3]qWUrefdocqXUapi/circuits_node_eventsqYUpy:classqZNU py:moduleq[Nuh5Kh7]q\cdocutils.nodes literal q])q^}q_(hhHh'}q`(h)]qah+]qb(UxrefqchQXpy-modqdeh-]qeh/]qfh3]qguhhFh7]qhcdocutils.nodes Text qiXcircuits.node.eventsqjqk}ql(hUhh^ubah%UliteralqmubaubhiX -- Eventsqnqo}qp(hX -- Eventsqqhh:ubeubcsphinx.addnodes index qr)qs}qt(hUhhh U quh%Uindexqvh'}qw(h/]qxh-]qyh)]qzh+]q{h3]q|Uentriesq}]q~(UsingleqXcircuits.node.events (module)Xmodule-circuits.node.eventsUtqauh5Kh6hh7]qubcdocutils.nodes paragraph q)q}q(hXEventsqhhh XV/home/prologic/work/circuits/circuits/node/events.py:docstring of circuits.node.eventsqh%U paragraphqh'}q(h)]qh+]qh-]qh/]qh3]quh5Kh6hh7]qhiXEventsqq}q(hhhhubaubh)q}q(hX...qhhh hh%hh'}q(h)]qh+]qh-]qh/]qh3]quh5Kh6hh7]qhiX...qq}q(hhhhubaubhh)q}q(hUhhh h#h%h&h'}q(h)]qh+]qh-]qh/]qU componentsqah3]qh auh5Kh6hh7]q(h9)q}q(hX Componentsqhhh h#h%h=h'}q(h)]qh+]qh-]qh/]qh3]quh5Kh6hh7]qhiX Componentsqq}q(hhhhubaubh)q}q(hX**none**qhhh h#h%hh'}q(h)]qh+]qh-]qh/]qh3]quh5Kh6hh7]qcdocutils.nodes strong q)q}q(hhh'}q(h)]qh+]qh-]qh/]qh3]quhhh7]qhiXnoneqʅq}q(hUhhubah%Ustrongqubaubeubh)q}q(hUhhh h#h%h&h'}q(h)]qh+]qh-]qh/]qU functionsqah3]qhauh5Kh6hh7]q(h9)q}q(hX Functionsqhhh h#h%h=h'}q(h)]qh+]qh-]qh/]qh3]quh5Kh6hh7]qhiX Functionsq⅁q}q(hhhhubaubh)q}q(hX**none**qhhh h#h%hh'}q(h)]qh+]qh-]qh/]qh3]quh5Kh6hh7]qh)q}q(hhh'}q(h)]qh+]qh-]qh/]qh3]quhhh7]qhiXnoneqq}q(hUhhubah%hubaubeubeubh h#h%h&h'}q(h)]qh+]qh-]qh/]qUeventsrah3]rh auh5Kh6hh7]r(h9)r}r(hXEventsrhhh h#h%h=h'}r(h)]rh+]rh-]r h/]r h3]r uh5Kh6hh7]r hiXEventsr r}r(hjhjubaubhr)r}r(hUhhh Nh%hvh'}r(h/]rh-]rh)]rh+]rh3]rUentriesr]r(hX&Packet (class in circuits.node.events)hUtrauh5Nh6hh7]rubh)r}r(hUhhh Nh%Udescrh'}r(Unoindexr Udomainr!Xpyr"h/]r#h-]r$h)]r%h+]r&h3]r'Uobjtyper(Xclassr)Udesctyper*j)uh5Nh6hh7]r+(csphinx.addnodes desc_signature r,)r-}r.(hXPacket(*args, **kwargs)r/hjh U r0h%Udesc_signaturer1h'}r2(h/]r3haUmoduler4h!Xcircuits.node.eventsr5r6}r7bh-]r8h)]r9h+]r:h3]r;haUfullnamer<XPacketr=Uclassr>UUfirstr?uh5Nh6hh7]r@(csphinx.addnodes desc_annotation rA)rB}rC(hXclass rDhj-h j0h%Udesc_annotationrEh'}rF(h)]rGh+]rHh-]rIh/]rJh3]rKuh5Nh6hh7]rLhiXclass rMrN}rO(hUhjBubaubcsphinx.addnodes desc_addname rP)rQ}rR(hXcircuits.node.events.rShj-h j0h%U desc_addnamerTh'}rU(h)]rVh+]rWh-]rXh/]rYh3]rZuh5Nh6hh7]r[hiXcircuits.node.events.r\r]}r^(hUhjQubaubcsphinx.addnodes desc_name r_)r`}ra(hj=hj-h j0h%U desc_namerbh'}rc(h)]rdh+]reh-]rfh/]rgh3]rhuh5Nh6hh7]rihiXPacketrjrk}rl(hUhj`ubaubcsphinx.addnodes desc_parameterlist rm)rn}ro(hUhj-h j0h%Udesc_parameterlistrph'}rq(h)]rrh+]rsh-]rth/]ruh3]rvuh5Nh6hh7]rw(csphinx.addnodes desc_parameter rx)ry}rz(hX*argsr{h'}r|(h)]r}h+]r~h-]rh/]rh3]ruhjnh7]rhiX*argsrr}r(hUhjyubah%Udesc_parameterrubjx)r}r(hX**kwargsrh'}r(h)]rh+]rh-]rh/]rh3]ruhjnh7]rhiX**kwargsrr}r(hUhjubah%jubeubeubh)r}r(hUhjh j0h%U desc_contentrh'}r(h)]rh+]rh-]rh/]rh3]ruh5Nh6hh7]r(h)r}r(hX*Bases: :class:`circuits.core.events.Event`rhjh U rh%hh'}r(h)]rh+]rh-]rh/]rh3]ruh5Kh6hh7]r(hiXBases: rr}r(hXBases: rhjubhE)r}r(hX#:class:`circuits.core.events.Event`rhjh h#h%hIh'}r(UreftyperXclassrhMhNXcircuits.core.events.EventrU refdomainrXpyrh/]rh-]rU refexplicitrh)]rh+]rh3]rhXhYhZj=h[Xcircuits.node.eventsruh5Kh7]rh])r}r(hjh'}r(h)]rh+]r(hcjXpy-classreh-]rh/]rh3]ruhjh7]rhiXcircuits.core.events.Eventrr}r(hUhjubah%hmubaubeubh)r}r(hX Packet Eventrhjh X]/home/prologic/work/circuits/circuits/node/events.py:docstring of circuits.node.events.Packetrh%hh'}r(h)]rh+]rh-]rh/]rh3]ruh5Kh6hh7]rhiX Packet Eventrr}r(hjhjubaubh)r}r(hXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rhjh jh%hh'}r(h)]rh+]rh-]rh/]rh3]ruh5Kh6hh7]rhiXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rr}r(hjhjubaubh)r}r(hXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rhjh jh%hh'}r(h)]rh+]rh-]rh/]rh3]ruh5Kh6hh7]rhiXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rr}r(hjhjubaubh)r}r(hXEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rhjh jh%hh'}r(h)]rh+]rh-]rh/]rh3]ruh5K h6hh7]r(hiXEvery event has a rr}r(hXEvery event has a rhjubhE)r}r(hX :attr:`name`rhjh h#h%hIh'}r(UreftyperXattrrhMhNXnamerU refdomainrXpyr h/]r h-]r U refexplicitr h)]r h+]rh3]rhXhYhZj=h[juh5Kh7]rh])r}r(hjh'}r(h)]rh+]r(hcj Xpy-attrreh-]rh/]rh3]ruhjh7]rhiXnamerr}r(hUhjubah%hmubaubhiX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r (hX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.r!hjubeubcdocutils.nodes field_list r")r#}r$(hUhjh Nh%U field_listr%h'}r&(h)]r'h+]r(h-]r)h/]r*h3]r+uh5Nh6hh7]r,cdocutils.nodes field r-)r.}r/(hUh'}r0(h)]r1h+]r2h-]r3h/]r4h3]r5uhj#h7]r6(cdocutils.nodes field_name r7)r8}r9(hUh'}r:(h)]r;h+]r<h-]r=h/]r>h3]r?uhj.h7]r@hiX VariablesrArB}rC(hUhj8ubah%U field_namerDubcdocutils.nodes field_body rE)rF}rG(hUh'}rH(h)]rIh+]rJh-]rKh/]rLh3]rMuhj.h7]rNcdocutils.nodes bullet_list rO)rP}rQ(hUh'}rR(h)]rSh+]rTh-]rUh/]rVh3]rWuhjFh7]rX(cdocutils.nodes list_item rY)rZ}r[(hUh'}r\(h)]r]h+]r^h-]r_h/]r`h3]rauhjPh7]rbh)rc}rd(hUh'}re(h)]rfh+]rgh-]rhh/]rih3]rjuhjZh7]rk(hE)rl}rm(hUh'}rn(UreftyperoUobjrpU reftargetrqXchannelsrrU refdomainrsj"h/]rth-]ruU refexplicitrvh)]rwh+]rxh3]ryuhjch7]rzh)r{}r|(hjrh'}r}(h)]r~h+]rh-]rh/]rh3]ruhjlh7]rhiXchannelsrr}r(hUhj{ubah%hubah%hIubhiX -- rr}r(hUhjcubh)r}r(hXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rhjch jh%hh'}r(h)]rh+]rh-]rh/]rh3]ruh5Kh7]rhiXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rr}r(hjhjubaubh)r}r(hXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rhjch jh%hh'}r(h)]rh+]rh-]rh/]rh3]ruh5Kh7]rhiXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rr}r(hjhjubaubeh%hubah%U list_itemrubjY)r}r(hUh'}r(h)]rh+]rh-]rh/]rh3]ruhjPh7]rh)r}r(hUh'}r(h)]rh+]rh-]rh/]rh3]ruhjh7]r(hE)r}r(hUh'}r(UreftyperjpU reftargetrXvaluerU refdomainrj"h/]rh-]rU refexplicitrh)]rh+]rh3]ruhjh7]rh)r}r(hjh'}r(h)]rh+]rh-]rh/]rh3]ruhjh7]rhiXvaluerr}r(hUhjubah%hubah%hIubhiX -- rr}r(hUhjubhiX this is a rr}r(hX this is a rhjubhE)r}r(hX#:class:`circuits.core.values.Value`rhjh Nh%hIh'}r(UreftyperXclassrhMhNXcircuits.core.values.ValuerU refdomainrXpyrh/]rh-]rU refexplicitrh)]rh+]rh3]rhXhYhZj=h[juh5Nh7]rh])r}r(hjh'}r(h)]rh+]r(hcjXpy-classreh-]rh/]rh3]ruhjh7]rhiXcircuits.core.values.Valuerr}r(hUhjubah%hmubaubhiXN object that holds the results returned by the handlers invoked for the event.rr}r(hXN object that holds the results returned by the handlers invoked for the event.rhjubeh%hubah%jubjY)r}r(hUh'}r(h)]rh+]rh-]rh/]rh3]ruhjPh7]rh)r}r(hUh'}r(h)]rh+]rh-]rh/]rh3]r uhjh7]r (hE)r }r (hUh'}r (UreftyperjpU reftargetrXsuccessrU refdomainrj"h/]rh-]rU refexplicitrh)]rh+]rh3]ruhjh7]rh)r}r(hjh'}r(h)]rh+]rh-]rh/]rh3]r uhj h7]r!hiXsuccessr"r#}r$(hUhjubah%hubah%hIubhiX -- r%r&}r'(hUhjubhiX%if this optional attribute is set to r(r)}r*(hX%if this optional attribute is set to r+hjubh])r,}r-(hX``True``r.h'}r/(h)]r0h+]r1h-]r2h/]r3h3]r4uhjh7]r5hiXTruer6r7}r8(hUhj,ubah%hmubhiX, an associated event r9r:}r;(hX, an associated event r<hjubh])r=}r>(hX``EventSuccess``r?h'}r@(h)]rAh+]rBh-]rCh/]rDh3]rEuhjh7]rFhiX EventSuccessrGrH}rI(hUhj=ubah%hmubhiX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rJrK}rL(hX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rMhjubeh%hubah%jubjY)rN}rO(hUh'}rP(h)]rQh+]rRh-]rSh/]rTh3]rUuhjPh7]rVh)rW}rX(hUh'}rY(h)]rZh+]r[h-]r\h/]r]h3]r^uhjNh7]r_(hE)r`}ra(hUh'}rb(UreftypercjpU reftargetrdXsuccess_channelsreU refdomainrfj"h/]rgh-]rhU refexplicitrih)]rjh+]rkh3]rluhjWh7]rmh)rn}ro(hjeh'}rp(h)]rqh+]rrh-]rsh/]rth3]ruuhj`h7]rvhiXsuccess_channelsrwrx}ry(hUhjnubah%hubah%hIubhiX -- rzr{}r|(hUhjWubhiXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r}r~}r(hXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rhjWubeh%hubah%jubjY)r}r(hUh'}r(h)]rh+]rh-]rh/]rh3]ruhjPh7]rh)r}r(hUh'}r(h)]rh+]rh-]rh/]rh3]ruhjh7]r(hE)r}r(hUh'}r(UreftyperjpU reftargetrXcompleterU refdomainrj"h/]rh-]rU refexplicitrh)]rh+]rh3]ruhjh7]rh)r}r(hjh'}r(h)]rh+]rh-]rh/]rh3]ruhjh7]rhiXcompleterr}r(hUhjubah%hubah%hIubhiX -- rr}r(hUhjubhiX%if this optional attribute is set to rr}r(hX%if this optional attribute is set to rhjubh])r}r(hX``True``rh'}r(h)]rh+]rh-]rh/]rh3]ruhjh7]rhiXTruerr}r(hUhjubah%hmubhiX, an associated event rr}r(hX, an associated event rhjubh])r}r(hX``EventComplete``rh'}r(h)]rh+]rh-]rh/]rh3]ruhjh7]rhiX EventCompleterr}r(hUhjubah%hmubhiX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rr}r(hX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rhjubeh%hubah%jubjY)r}r(hUh'}r(h)]rh+]rh-]rh/]rh3]ruhjPh7]rh)r}r(hUh'}r(h)]rh+]rh-]rh/]rh3]ruhjh7]r(hE)r}r(hUh'}r(UreftyperjpU reftargetrXsuccess_channelsrU refdomainrj"h/]rh-]rU refexplicitrh)]rh+]rh3]ruhjh7]rh)r}r(hjh'}r(h)]rh+]rh-]rh/]rh3]ruhjh7]rhiXsuccess_channelsrr}r(hUhjubah%hubah%hIubhiX -- rr}r(hUhjubhiXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(hXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rhjubeh%hubah%jubeh%U bullet_listr ubah%U field_bodyr ubeh%Ufieldr ubaubeubeubhr)r }r (hUhhh X]/home/prologic/work/circuits/circuits/node/events.py:docstring of circuits.node.events.Remoterh%hvh'}r(h/]rh-]rh)]rh+]rh3]rUentriesr]r(hX&Remote (class in circuits.node.events)h Utrauh5Nh6hh7]rubheubh jh%jh'}r(j j!Xpyrh/]rh-]rh)]rh+]rh3]rj(Xclassr j*j uh5Nh6hh7]r!(j,)r"}r#(hX!Remote(event, node, channel=None)r$hhh j0h%j1h'}r%(h/]r&h aj4h!Xcircuits.node.eventsr'r(}r)bh-]r*h)]r+h+]r,h3]r-h aj<XRemoter.j>Uj?uh5Nh6hh7]r/(jA)r0}r1(hXclass r2hj"h j0h%jEh'}r3(h)]r4h+]r5h-]r6h/]r7h3]r8uh5Nh6hh7]r9hiXclass r:r;}r<(hUhj0ubaubjP)r=}r>(hXcircuits.node.events.r?hj"h j0h%jTh'}r@(h)]rAh+]rBh-]rCh/]rDh3]rEuh5Nh6hh7]rFhiXcircuits.node.events.rGrH}rI(hUhj=ubaubj_)rJ}rK(hj.hj"h j0h%jbh'}rL(h)]rMh+]rNh-]rOh/]rPh3]rQuh5Nh6hh7]rRhiXRemoterSrT}rU(hUhjJubaubjm)rV}rW(hUhj"h j0h%jph'}rX(h)]rYh+]rZh-]r[h/]r\h3]r]uh5Nh6hh7]r^(jx)r_}r`(hXeventrah'}rb(h)]rch+]rdh-]reh/]rfh3]rguhjVh7]rhhiXeventrirj}rk(hUhj_ubah%jubjx)rl}rm(hXnodernh'}ro(h)]rph+]rqh-]rrh/]rsh3]rtuhjVh7]ruhiXnodervrw}rx(hUhjlubah%jubjx)ry}rz(hX channel=Noner{h'}r|(h)]r}h+]r~h-]rh/]rh3]ruhjVh7]rhiX channel=Nonerr}r(hUhjyubah%jubeubeubheubh j0h%jh'}r(h)]rh+]rh-]rh/]rh3]ruh5Nh6hh7]r(h)r}r(hX*Bases: :class:`circuits.core.events.Event`rhhh jh%hh'}r(h)]rh+]rh-]rh/]rh3]ruh5Kh6hh7]r(hiXBases: rr}r(hXBases: rhjubhE)r}r(hX#:class:`circuits.core.events.Event`rhjh h#h%hIh'}r(UreftyperXclassrhMhNXcircuits.core.events.EventrU refdomainrXpyrh/]rh-]rU refexplicitrh)]rh+]rh3]rhXhYhZj.h[juh5Kh7]rh])r}r(hjh'}r(h)]rh+]r(hcjXpy-classreh-]rh/]rh3]ruhjh7]rhiXcircuits.core.events.Eventrr}r(hUhjubah%hmubaubeubh)r}r(hX Remote Eventrhhh jh%hh'}r(h)]rh+]rh-]rh/]rh3]ruh5Kh6hh7]rhiX Remote Eventrr}r(hjhjubaubh)r}r(hX...rhhh jh%hh'}r(h)]rh+]rh-]rh/]rh3]ruh5Kh6hh7]rhiX...rr}r(hjhjubaubeubh jh%Usystem_messagerh'}r(h)]rUlevelrKh/]rh-]rUsourcerjh+]rh3]rUlinerKUtyperUINFOruh5Kh6hh7]rh)r}r(hUh'}r(h)]rh+]rh-]rh/]rh3]ruhhh7]rhiXeUnexpected possible title overline or transition. Treating it as ordinary text because it's so short.rr}r(hUhjubah%hubaubaUcurrent_sourcerNU decorationrNUautofootnote_startrKUnameidsr}r(hhhhhh2h hh h h juh7]rhahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh6hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr (cdocutils.frontend Values r or }r (Ufootnote_backlinksr KUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh=NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetr Uoutput_encoding_error_handlerr!Ustrictr"U sectnum_xformr#KUdump_transformsr$NU docinfo_xformr%KUwarning_streamr&NUpep_file_url_templater'Upep-%04dr(Uexit_status_levelr)KUconfigr*NUstrict_visitorr+NUcloak_email_addressesr,Utrim_footnote_reference_spacer-Uenvr.NUdump_pseudo_xmlr/NUexpose_internalsr0NUsectsubtitle_xformr1U source_linkr2NUrfc_referencesr3NUoutput_encodingr4Uutf-8r5U source_urlr6NUinput_encodingr7U utf-8-sigr8U_disable_configr9NU id_prefixr:UU tab_widthr;KUerror_encodingr<U ISO-8859-1r=U_sourcer>UE/home/prologic/work/circuits/docs/source/api/circuits_node_events.rstr?Ugettext_compactr@U generatorrANUdump_internalsrBNU smart_quotesrCU pep_base_urlrDUhttp://www.python.org/dev/peps/rEUsyntax_highlightrFUlongrGUinput_encoding_error_handlerrHj"Uauto_id_prefixrIUidrJUdoctitle_xformrKUstrip_elements_with_classesrLNU _config_filesrM]rNUfile_insertion_enabledrOKU raw_enabledrPKU dump_settingsrQNubUsymbol_footnote_startrRKUidsrS}rT(hj-hhh1cdocutils.nodes target rU)rV}rW(hUhhh huh%UtargetrXh'}rY(h)]rZh/]r[h1ah-]r\Uismodr]h+]r^h3]r_uh5Kh6hh7]r`ubh2hhhh j"jhuUsubstitution_namesra}rbh%h6h'}rc(h)]rdh/]reh-]rfUsourcergh#h+]rhh3]riuU footnotesrj]rkUrefidsrl}rmub.circuits-2.1.0/docs/build/doctrees/api/circuits_core_components.doctree0000644000014400001440000012263012113366654026164 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X1circuits.core.components.BaseComponent.unregisterqX componentsqNX*circuits.core.components.PrepareUnregisterqX/circuits.core.components.BaseComponent.registerq X&circuits.core.components -- componentsq NX.circuits.core.components.BaseComponent.handlesq X functionsq NX&circuits.core.components.BaseComponentq XclassesqNX/circuits.core.components.BaseComponent.handlersqX"circuits.core.components.ComponentqX5circuits.core.components.PrepareUnregister.in_subtreeqXeventsqNX'circuits.core.components.SingletonErrorquUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hhhU componentsqhhh h h U#circuits-core-components-componentsqh h h U functionsqh h hUclassesq hhhhhhhUeventsq!hhuUchildrenq"]q#cdocutils.nodes section q$)q%}q&(U rawsourceq'UUparentq(hUsourceq)cdocutils.nodes reprunicode q*XI/home/prologic/work/circuits/docs/source/api/circuits_core_components.rstq+q,}q-bUtagnameq.Usectionq/U attributesq0}q1(Udupnamesq2]q3Uclassesq4]q5Ubackrefsq6]q7Uidsq8]q9(Xmodule-circuits.core.componentsq:heUnamesq;]qhh"]q?(cdocutils.nodes title q@)qA}qB(h'X-:mod:`circuits.core.components` -- ComponentsqCh(h%h)h,h.UtitleqDh0}qE(h2]qFh4]qGh6]qHh8]qIh;]qJuh=Kh>hh"]qK(csphinx.addnodes pending_xref qL)qM}qN(h'X:mod:`circuits.core.components`qOh(hAh)h,h.U pending_xrefqPh0}qQ(UreftypeqRXmodqSUrefwarnqTU reftargetqUXcircuits.core.componentsqVU refdomainqWXpyqXh8]qYh6]qZU refexplicitq[h2]q\h4]q]h;]q^Urefdocq_Uapi/circuits_core_componentsq`Upy:classqaNU py:moduleqbNuh=Kh"]qccdocutils.nodes literal qd)qe}qf(h'hOh0}qg(h2]qhh4]qi(UxrefqjhXXpy-modqkeh6]qlh8]qmh;]qnuh(hMh"]qocdocutils.nodes Text qpXcircuits.core.componentsqqqr}qs(h'Uh(heubah.UliteralqtubaubhpX -- Componentsquqv}qw(h'X -- Componentsqxh(hAubeubcsphinx.addnodes index qy)qz}q{(h'Uh(h%h)U q|h.Uindexq}h0}q~(h8]qh6]qh2]qh4]qh;]qUentriesq]q(UsingleqX!circuits.core.components (module)Xmodule-circuits.core.componentsUtqauh=Kh>hh"]qubcdocutils.nodes paragraph q)q}q(h'XAThis module defines the BaseComponent and its subclass Component.qh(h%h)X^/home/prologic/work/circuits/circuits/core/components.py:docstring of circuits.core.componentsqh.U paragraphqh0}q(h2]qh4]qh6]qh8]qh;]quh=Kh>hh"]qhpXAThis module defines the BaseComponent and its subclass Component.qq}q(h'hh(hubaubh$)q}q(h'Uh(h%h)h,h.h/h0}q(h2]qh4]qh6]qh8]qh ah;]qhauh=Kh>hh"]q(h@)q}q(h'XClassesqh(hh)h,h.hDh0}q(h2]qh4]qh6]qh8]qh;]quh=Kh>hh"]qhpXClassesqq}q(h'hh(hubaubhy)q}q(h'Uh(hh)Nh.h}h0}q(h8]qh6]qh2]qh4]qh;]qUentriesq]q(hX1BaseComponent (class in circuits.core.components)h Utqauh=Nh>hh"]qubcsphinx.addnodes desc q)q}q(h'Uh(hh)Nh.Udescqh0}q(UnoindexqUdomainqXpyqh8]qh6]qh2]qh4]qh;]qUobjtypeqXclassqUdesctypeqhuh=Nh>hh"]q(csphinx.addnodes desc_signature q)q}q(h'XBaseComponent(*args, **kwargs)qh(hh)U qh.Udesc_signatureqh0}q(h8]qh aUmoduleqh*Xcircuits.core.componentsqՅq}qbh6]qh2]qh4]qh;]qh aUfullnameqX BaseComponentqUclassqUUfirstq߉uh=Nh>hh"]q(csphinx.addnodes desc_annotation q)q}q(h'Xclass qh(hh)hh.Udesc_annotationqh0}q(h2]qh4]qh6]qh8]qh;]quh=Nh>hh"]qhpXclass q텁q}q(h'Uh(hubaubcsphinx.addnodes desc_addname q)q}q(h'Xcircuits.core.components.qh(hh)hh.U desc_addnameqh0}q(h2]qh4]qh6]qh8]qh;]quh=Nh>hh"]qhpXcircuits.core.components.qq}q(h'Uh(hubaubcsphinx.addnodes desc_name q)r}r(h'hh(hh)hh.U desc_namerh0}r(h2]rh4]rh6]rh8]rh;]ruh=Nh>hh"]r hpX BaseComponentr r }r (h'Uh(jubaubcsphinx.addnodes desc_parameterlist r )r}r(h'Uh(hh)hh.Udesc_parameterlistrh0}r(h2]rh4]rh6]rh8]rh;]ruh=Nh>hh"]r(csphinx.addnodes desc_parameter r)r}r(h'X*argsrh0}r(h2]rh4]rh6]rh8]r h;]r!uh(jh"]r"hpX*argsr#r$}r%(h'Uh(jubah.Udesc_parameterr&ubj)r'}r((h'X**kwargsr)h0}r*(h2]r+h4]r,h6]r-h8]r.h;]r/uh(jh"]r0hpX**kwargsr1r2}r3(h'Uh(j'ubah.j&ubeubeubcsphinx.addnodes desc_content r4)r5}r6(h'Uh(hh)hh.U desc_contentr7h0}r8(h2]r9h4]r:h6]r;h8]r<h;]r=uh=Nh>hh"]r>(h)r?}r@(h'X-Bases: :class:`circuits.core.manager.Manager`rAh(j5h)U rBh.hh0}rC(h2]rDh4]rEh6]rFh8]rGh;]rHuh=Kh>hh"]rI(hpXBases: rJrK}rL(h'XBases: rMh(j?ubhL)rN}rO(h'X&:class:`circuits.core.manager.Manager`rPh(j?h)h,h.hPh0}rQ(UreftyperRXclassrShThUXcircuits.core.manager.ManagerrTU refdomainrUXpyrVh8]rWh6]rXU refexplicitrYh2]rZh4]r[h;]r\h_h`hahhbXcircuits.core.componentsr]uh=Kh"]r^hd)r_}r`(h'jPh0}ra(h2]rbh4]rc(hjjVXpy-classrdeh6]reh8]rfh;]rguh(jNh"]rhhpXcircuits.core.manager.Managerrirj}rk(h'Uh(j_ubah.htubaubeubh)rl}rm(h'XThis is the base class for all components in a circuits based application. Components can (and should, except for root components) be registered with a parent component.rnh(j5h)Xl/home/prologic/work/circuits/circuits/core/components.py:docstring of circuits.core.components.BaseComponentroh.hh0}rp(h2]rqh4]rrh6]rsh8]rth;]ruuh=Kh>hh"]rvhpXThis is the base class for all components in a circuits based application. Components can (and should, except for root components) be registered with a parent component.rwrx}ry(h'jnh(jlubaubh)rz}r{(h'XBaseComponents can declare methods as event handlers using the handler decoration (see :func:`circuits.core.handlers.handler`). The handlers are invoked for matching events from the component's channel (specified as the component's ``channel`` attribute).r|h(j5h)joh.hh0}r}(h2]r~h4]rh6]rh8]rh;]ruh=Kh>hh"]r(hpXWBaseComponents can declare methods as event handlers using the handler decoration (see rr}r(h'XWBaseComponents can declare methods as event handlers using the handler decoration (see rh(jzubhL)r}r(h'X&:func:`circuits.core.handlers.handler`rh(jzh)h,h.hPh0}r(UreftyperXfuncrhThUXcircuits.core.handlers.handlerrU refdomainrXpyrh8]rh6]rU refexplicitrh2]rh4]rh;]rh_h`hahhbj]uh=K h"]rhd)r}r(h'jh0}r(h2]rh4]r(hjjXpy-funcreh6]rh8]rh;]ruh(jh"]rhpX circuits.core.handlers.handler()rr}r(h'Uh(jubah.htubaubhpXk). The handlers are invoked for matching events from the component's channel (specified as the component's rr}r(h'Xk). The handlers are invoked for matching events from the component's channel (specified as the component's rh(jzubhd)r}r(h'X ``channel``rh0}r(h2]rh4]rh6]rh8]rh;]ruh(jzh"]rhpXchannelrr}r(h'Uh(jubah.htubhpX attribute).rr}r(h'X attribute).rh(jzubeubh)r}r(h'XBaseComponents inherit from :class:`circuits.core.manager.Manager`. This provides components with the :func:`circuits.core.manager.Manager.fireEvent` method that can be used to fire events as the result of some computation.rh(j5h)joh.hh0}r(h2]rh4]rh6]rh8]rh;]ruh=K h>hh"]r(hpXBaseComponents inherit from rr}r(h'XBaseComponents inherit from rh(jubhL)r}r(h'X&:class:`circuits.core.manager.Manager`rh(jh)h,h.hPh0}r(UreftyperXclassrhThUXcircuits.core.manager.ManagerrU refdomainrXpyrh8]rh6]rU refexplicitrh2]rh4]rh;]rh_h`hahhbj]uh=Kh"]rhd)r}r(h'jh0}r(h2]rh4]r(hjjXpy-classreh6]rh8]rh;]ruh(jh"]rhpXcircuits.core.manager.Managerrr}r(h'Uh(jubah.htubaubhpX$. This provides components with the rr}r(h'X$. This provides components with the rh(jubhL)r}r(h'X/:func:`circuits.core.manager.Manager.fireEvent`rh(jh)h,h.hPh0}r(UreftyperXfuncrhThUX'circuits.core.manager.Manager.fireEventrU refdomainrXpyrh8]rh6]rU refexplicitrh2]rh4]rh;]rh_h`hahhbj]uh=Kh"]rhd)r}r(h'jh0}r(h2]rh4]r(hjjXpy-funcreh6]rh8]rh;]ruh(jh"]rhpX)circuits.core.manager.Manager.fireEvent()rr}r(h'Uh(jubah.htubaubhpXJ method that can be used to fire events as the result of some computation.rr}r(h'XJ method that can be used to fire events as the result of some computation.r h(jubeubh)r }r (h'XsApart from the ``fireEvent()`` method, the Manager nature is important for root components that are started or run.r h(j5h)joh.hh0}r (h2]rh4]rh6]rh8]rh;]ruh=Kh>hh"]r(hpXApart from the rr}r(h'XApart from the rh(j ubhd)r}r(h'X``fireEvent()``rh0}r(h2]rh4]rh6]rh8]rh;]r uh(j h"]r!hpX fireEvent()r"r#}r$(h'Uh(jubah.htubhpXU method, the Manager nature is important for root components that are started or run.r%r&}r'(h'XU method, the Manager nature is important for root components that are started or run.r(h(j ubeubcdocutils.nodes field_list r))r*}r+(h'Uh(j5h)Nh.U field_listr,h0}r-(h2]r.h4]r/h6]r0h8]r1h;]r2uh=Nh>hh"]r3cdocutils.nodes field r4)r5}r6(h'Uh0}r7(h2]r8h4]r9h6]r:h8]r;h;]r<uh(j*h"]r=(cdocutils.nodes field_name r>)r?}r@(h'Uh0}rA(h2]rBh4]rCh6]rDh8]rEh;]rFuh(j5h"]rGhpX VariablesrHrI}rJ(h'Uh(j?ubah.U field_namerKubcdocutils.nodes field_body rL)rM}rN(h'Uh0}rO(h2]rPh4]rQh6]rRh8]rSh;]rTuh(j5h"]rUh)rV}rW(h'Uh0}rX(h2]rYh4]rZh6]r[h8]r\h;]r]uh(jMh"]r^(hL)r_}r`(h'Uh0}ra(UreftyperbUobjrcU reftargetrdXchannelreU refdomainrfhh8]rgh6]rhU refexplicitrih2]rjh4]rkh;]rluh(jVh"]rmcdocutils.nodes strong rn)ro}rp(h'jeh0}rq(h2]rrh4]rsh6]rth8]ruh;]rvuh(j_h"]rwhpXchannelrxry}rz(h'Uh(joubah.Ustrongr{ubah.hPubhpX -- r|r}}r~(h'Uh(jVubhpXa component can be associated with a specific channel by setting this attribute. This should either be done by specifying a class attribute rr}r(h'Xa component can be associated with a specific channel by setting this attribute. This should either be done by specifying a class attribute rh(jVubcdocutils.nodes emphasis r)r}r(h'X *channel*rh0}r(h2]rh4]rh6]rh8]rh;]ruh(jVh"]rhpXchannelrr}r(h'Uh(jubah.UemphasisrubhpX8 in the derived class or by passing a keyword parameter rr}r(h'X8 in the derived class or by passing a keyword parameter rh(jVubj)r}r(h'X*channel="..."*rh0}r(h2]rh4]rh6]rh8]rh;]ruh(jVh"]rhpX channel="..."rr}r(h'Uh(jubah.jubhpX to rr}r(h'X to rh(jVubj)r}r(h'X *__init__*rh0}r(h2]rh4]rh6]rh8]rh;]ruh(jVh"]rhpX__init__rr}r(h'Uh(jubah.jubhpX. If specified, the component's handlers receive events on the specified channel only, and events fired by the component will be sent on the specified channel (this behavior may be overridden, see rr}r(h'X. If specified, the component's handlers receive events on the specified channel only, and events fired by the component will be sent on the specified channel (this behavior may be overridden, see rh(jVubhL)r}r(h'X$:class:`~circuits.core.events.Event`rh(jVh)h,h.hPh0}r(UreftyperXclassrhThUXcircuits.core.events.EventrU refdomainrXpyrh8]rh6]rU refexplicitrh2]rh4]rh;]rh_h`hahhbj]uh=Kh"]rhd)r}r(h'jh0}r(h2]rh4]r(hjjXpy-classreh6]rh8]rh;]ruh(jh"]rhpXEventrr}r(h'Uh(jubah.htubaubhpX, rr}r(h'X, rh(jVubhL)r}r(h'X:meth:`~.fireEvent`rh(jVh)h,h.hPh0}r(UreftyperXmethrU refspecificrhThUX fireEventrU refdomainrXpyrh8]rh6]rU refexplicitrh2]rh4]rh;]rh_h`hahhbj]uh=Kh"]rhd)r}r(h'jh0}r(h2]rh4]r(hjjXpy-methreh6]rh8]rh;]ruh(jh"]rhpX fireEvent()rr}r(h'Uh(jubah.htubaubhpX and rr}r(h'X and rh(jVubhL)r}r(h'X':func:`~circuits.core.handlers.handler`rh(jVh)h,h.hPh0}r(UreftyperXfuncrhThUXcircuits.core.handlers.handlerrU refdomainrXpyrh8]rh6]rU refexplicitrh2]rh4]rh;]r h_h`hahhbj]uh=Kh"]r hd)r }r (h'jh0}r (h2]rh4]r(hjjXpy-funcreh6]rh8]rh;]ruh(jh"]rhpX handler()rr}r(h'Uh(j ubah.htubaubhpX). By default, the channel attribute is set to "*", meaning that events are fired on all channels and received from all channels.rr}r(h'X). By default, the channel attribute is set to "*", meaning that events are fired on all channels and received from all channels.rh(jVubeh.hubah.U field_bodyrubeh.Ufieldrubaubh)r}r(h'X4initializes x; see x.__class__.__doc__ for signaturer h(j5h)joh.hh0}r!(h2]r"h4]r#h6]r$h8]r%h;]r&uh=Kh>hh"]r'hpX4initializes x; see x.__class__.__doc__ for signaturer(r)}r*(h'j h(jubaubhy)r+}r,(h'Uh(j5h)Xu/home/prologic/work/circuits/circuits/core/components.py:docstring of circuits.core.components.BaseComponent.registerr-h.h}h0}r.(h8]r/h6]r0h2]r1h4]r2h;]r3Uentriesr4]r5(hX:register() (circuits.core.components.BaseComponent method)h Utr6auh=Nh>hh"]r7ubh)r8}r9(h'Uh(j5h)j-h.hh0}r:(hhXpyr;h8]r<h6]r=h2]r>h4]r?h;]r@hXmethodrAhjAuh=Nh>hh"]rB(h)rC}rD(h'XBaseComponent.register(parent)rEh(j8h)hh.hh0}rF(h8]rGh ahh*Xcircuits.core.componentsrHrI}rJbh6]rKh2]rLh4]rMh;]rNh ahXBaseComponent.registerrOhhh߉uh=Nh>hh"]rP(h)rQ}rR(h'XregisterrSh(jCh)hh.jh0}rT(h2]rUh4]rVh6]rWh8]rXh;]rYuh=Nh>hh"]rZhpXregisterr[r\}r](h'Uh(jQubaubj )r^}r_(h'Uh(jCh)hh.jh0}r`(h2]rah4]rbh6]rch8]rdh;]reuh=Nh>hh"]rfj)rg}rh(h'Xparentrih0}rj(h2]rkh4]rlh6]rmh8]rnh;]rouh(j^h"]rphpXparentrqrr}rs(h'Uh(jgubah.j&ubaubeubj4)rt}ru(h'Uh(j8h)hh.j7h0}rv(h2]rwh4]rxh6]ryh8]rzh;]r{uh=Nh>hh"]r|(h)r}}r~(h'XSInserts this component in the component tree as a child of the given *parent* node.rh(jth)j-h.hh0}r(h2]rh4]rh6]rh8]rh;]ruh=Kh>hh"]r(hpXEInserts this component in the component tree as a child of the given rr}r(h'XEInserts this component in the component tree as a child of the given rh(j}ubj)r}r(h'X*parent*rh0}r(h2]rh4]rh6]rh8]rh;]ruh(j}h"]rhpXparentrr}r(h'Uh(jubah.jubhpX node.rr}r(h'X node.rh(j}ubeubj))r}r(h'Uh(jth)j-h.j,h0}r(h2]rh4]rh6]rh8]rh;]ruh=Nh>hh"]rj4)r}r(h'Uh0}r(h2]rh4]rh6]rh8]rh;]ruh(jh"]r(j>)r}r(h'Uh0}r(h2]rh4]rh6]rh8]rh;]ruh(jh"]rhpX Parametersrr}r(h'Uh(jubah.jKubjL)r}r(h'Uh0}r(h2]rh4]rh6]rh8]rh;]ruh(jh"]rh)r}r(h'Uh0}r(h2]rh4]rh6]rh8]rh;]ruh(jh"]r(jn)r}r(h'Xparentrh0}r(h2]rh4]rh6]rh8]rh;]ruh(jh"]rhpXparentrr}r(h'Uh(jubah.j{ubhpX (rr}r(h'Uh(jubhL)r}r(h'X:class:`~.manager.Manager`rh(jh)Nh.hPh0}r(UreftyperXclassrjhThUXmanager.ManagerrU refdomainrXpyrh8]rh6]rU refexplicitrh2]rh4]rh;]rh_h`hahhbj]uh=Nh"]rhd)r}r(h'jh0}r(h2]rh4]r(hjjXpy-classreh6]rh8]rh;]ruh(jh"]rhpXManagerrr}r(h'Uh(jubah.htubaubhpX)r}r(h'Uh(jubhpX -- rr}r(h'Uh(jubhpX6the parent component after registration has completed.rr}r(h'X6the parent component after registration has completed.rh(jubeh.hubah.jubeh.jubaubh)r}r(h'XsThis method fires a :class:`~.events.Registered` event to inform other components in the tree about the new member.rh(jth)j-h.hh0}r(h2]rh4]rh6]rh8]r h;]r uh=Kh>hh"]r (hpXThis method fires a r r }r(h'XThis method fires a rh(jubhL)r}r(h'X:class:`~.events.Registered`rh(jh)Nh.hPh0}r(UreftyperXclassrjhThUXevents.RegisteredrU refdomainrXpyrh8]rh6]rU refexplicitrh2]rh4]rh;]rh_h`hahhbj]uh=Nh"]rhd)r }r!(h'jh0}r"(h2]r#h4]r$(hjjXpy-classr%eh6]r&h8]r'h;]r(uh(jh"]r)hpX Registeredr*r+}r,(h'Uh(j ubah.htubaubhpXC event to inform other components in the tree about the new member.r-r.}r/(h'XC event to inform other components in the tree about the new member.r0h(jubeubeubeubhy)r1}r2(h'Uh(j5h)Xw/home/prologic/work/circuits/circuits/core/components.py:docstring of circuits.core.components.BaseComponent.unregisterr3h.h}h0}r4(h8]r5h6]r6h2]r7h4]r8h;]r9Uentriesr:]r;(hX<unregister() (circuits.core.components.BaseComponent method)hUtr<auh=Nh>hh"]r=ubh)r>}r?(h'Uh(j5h)j3h.hh0}r@(hhXpyrAh8]rBh6]rCh2]rDh4]rEh;]rFhXmethodrGhjGuh=Nh>hh"]rH(h)rI}rJ(h'XBaseComponent.unregister()rKh(j>h)hh.hh0}rL(h8]rMhahh*Xcircuits.core.componentsrNrO}rPbh6]rQh2]rRh4]rSh;]rThahXBaseComponent.unregisterrUhhh߉uh=Nh>hh"]rV(h)rW}rX(h'X unregisterrYh(jIh)hh.jh0}rZ(h2]r[h4]r\h6]r]h8]r^h;]r_uh=Nh>hh"]r`hpX unregisterrarb}rc(h'Uh(jWubaubj )rd}re(h'Uh(jIh)hh.jh0}rf(h2]rgh4]rhh6]rih8]rjh;]rkuh=Nh>hh"]rlubeubj4)rm}rn(h'Uh(j>h)hh.j7h0}ro(h2]rph4]rqh6]rrh8]rsh;]rtuh=Nh>hh"]ru(h)rv}rw(h'X/Removes this component from the component tree.rxh(jmh)j3h.hh0}ry(h2]rzh4]r{h6]r|h8]r}h;]r~uh=Kh>hh"]rhpX/Removes this component from the component tree.rr}r(h'jxh(jvubaubh)r}r(h'XrRemoving a component from the component tree is a two stage process. First, the component is marked as to be removed, which prevents it from receiving further events, and a :class:`~.components.PrepareUnregister` event is fired. This allows other components to e.g. release references to the component to be removed before it is actually removed from the component tree.rh(jmh)j3h.hh0}r(h2]rh4]rh6]rh8]rh;]ruh=Kh>hh"]r(hpXRemoving a component from the component tree is a two stage process. First, the component is marked as to be removed, which prevents it from receiving further events, and a rr}r(h'XRemoving a component from the component tree is a two stage process. First, the component is marked as to be removed, which prevents it from receiving further events, and a rh(jubhL)r}r(h'X':class:`~.components.PrepareUnregister`rh(jh)Nh.hPh0}r(UreftyperXclassrjhThUXcomponents.PrepareUnregisterrU refdomainrXpyrh8]rh6]rU refexplicitrh2]rh4]rh;]rh_h`hahhbj]uh=Nh"]rhd)r}r(h'jh0}r(h2]rh4]r(hjjXpy-classreh6]rh8]rh;]ruh(jh"]rhpXPrepareUnregisterrr}r(h'Uh(jubah.htubaubhpX event is fired. This allows other components to e.g. release references to the component to be removed before it is actually removed from the component tree.rr}r(h'X event is fired. This allows other components to e.g. release references to the component to be removed before it is actually removed from the component tree.rh(jubeubh)r}r(h'XAfter the processing of the ``PrepareUnregister`` event has completed, the component is removed from the tree and an :class:`~.events.Unregistered` event is fired.rh(jmh)j3h.hh0}r(h2]rh4]rh6]rh8]rh;]ruh=K h>hh"]r(hpXAfter the processing of the rr}r(h'XAfter the processing of the rh(jubhd)r}r(h'X``PrepareUnregister``rh0}r(h2]rh4]rh6]rh8]rh;]ruh(jh"]rhpXPrepareUnregisterrr}r(h'Uh(jubah.htubhpXD event has completed, the component is removed from the tree and an rr}r(h'XD event has completed, the component is removed from the tree and an rh(jubhL)r}r(h'X:class:`~.events.Unregistered`rh(jh)Nh.hPh0}r(UreftyperXclassrjhThUXevents.UnregisteredrU refdomainrXpyrh8]rh6]rU refexplicitrh2]rh4]rh;]rh_h`hahhbj]uh=Nh"]rhd)r}r(h'jh0}r(h2]rh4]r(hjjXpy-classreh6]rh8]rh;]ruh(jh"]rhpX Unregisteredrr}r(h'Uh(jubah.htubaubhpX event is fired.rr}r(h'X event is fired.rh(jubeubeubeubhy)r}r(h'Uh(j5h)Xu/home/prologic/work/circuits/circuits/core/components.py:docstring of circuits.core.components.BaseComponent.handlersrh.h}h0}r(h8]rh6]rh2]rh4]rh;]rUentriesr]r(hX@handlers() (circuits.core.components.BaseComponent class method)hUtrauh=Nh>hh"]rubh)r}r(h'Uh(j5h)jh.hh0}r(hhXpyrh8]rh6]rh2]rh4]rh;]rhX classmethodrhjuh=Nh>hh"]r (h)r }r (h'XBaseComponent.handlers()r h(jh)hh.hh0}r (h8]rhahh*Xcircuits.core.componentsrr}rbh6]rh2]rh4]rh;]rhahXBaseComponent.handlersrhhh߉uh=Nh>hh"]r(h)r}r(h'U classmethod rh(j h)hh.hh0}r(h2]rh4]rh6]rh8]rh;]r uh=Nh>hh"]r!hpX classmethod r"r#}r$(h'Uh(jubaubh)r%}r&(h'Xhandlersr'h(j h)hh.jh0}r((h2]r)h4]r*h6]r+h8]r,h;]r-uh=Nh>hh"]r.hpXhandlersr/r0}r1(h'Uh(j%ubaubj )r2}r3(h'Uh(j h)hh.jh0}r4(h2]r5h4]r6h6]r7h8]r8h;]r9uh=Nh>hh"]r:ubeubj4)r;}r<(h'Uh(jh)hh.j7h0}r=(h2]r>h4]r?h6]r@h8]rAh;]rBuh=Nh>hh"]rCh)rD}rE(h'X7Returns a list of all event handlers for this ComponentrFh(j;h)jh.hh0}rG(h2]rHh4]rIh6]rJh8]rKh;]rLuh=Kh>hh"]rMhpX7Returns a list of all event handlers for this ComponentrNrO}rP(h'jFh(jDubaubaubeubhy)rQ}rR(h'Uh(j5h)Xt/home/prologic/work/circuits/circuits/core/components.py:docstring of circuits.core.components.BaseComponent.handlesrSh.h}h0}rT(h8]rUh6]rVh2]rWh4]rXh;]rYUentriesrZ]r[(hX?handles() (circuits.core.components.BaseComponent class method)h Utr\auh=Nh>hh"]r]ubh)r^}r_(h'Uh(j5h)jSh.hh0}r`(hhXpyrah8]rbh6]rch2]rdh4]reh;]rfhX classmethodrghjguh=Nh>hh"]rh(h)ri}rj(h'XBaseComponent.handles(*names)rkh(j^h)hh.hh0}rl(h8]rmh ahh*Xcircuits.core.componentsrnro}rpbh6]rqh2]rrh4]rsh;]rth ahXBaseComponent.handlesruhhh߉uh=Nh>hh"]rv(h)rw}rx(h'jh(jih)hh.hh0}ry(h2]rzh4]r{h6]r|h8]r}h;]r~uh=Nh>hh"]rhpX classmethod rr}r(h'Uh(jwubaubh)r}r(h'Xhandlesrh(jih)hh.jh0}r(h2]rh4]rh6]rh8]rh;]ruh=Nh>hh"]rhpXhandlesrr}r(h'Uh(jubaubj )r}r(h'Uh(jih)hh.jh0}r(h2]rh4]rh6]rh8]rh;]ruh=Nh>hh"]rj)r}r(h'X*namesrh0}r(h2]rh4]rh6]rh8]rh;]ruh(jh"]rhpX*namesrr}r(h'Uh(jubah.j&ubaubeubj4)r}r(h'Uh(j^h)hh.j7h0}r(h2]rh4]rh6]rh8]rh;]ruh=Nh>hh"]rh)r}r(h'X>Returns True if all names are event handlers of this Componentrh(jh)jSh.hh0}r(h2]rh4]rh6]rh8]rh;]ruh=Kh>hh"]rhpX>Returns True if all names are event handlers of this Componentrr}r(h'jh(jubaubaubeubeubeubhy)r}r(h'Uh(hh)Xh/home/prologic/work/circuits/circuits/core/components.py:docstring of circuits.core.components.Componentrh.h}h0}r(h8]rh6]rh2]rh4]rh;]rUentriesr]r(hX-Component (class in circuits.core.components)hUtrauh=Nh>hh"]rubh)r}r(h'Uh(hh)jh.hh0}r(hhXpyrh8]rh6]rh2]rh4]rh;]rhXclassrhjuh=Nh>hh"]r(h)r}r(h'XComponent(*args, **kwargs)rh(jh)hh.hh0}r(h8]rhahh*Xcircuits.core.componentsrr}rbh6]rh2]rh4]rh;]rhahX ComponentrhUh߉uh=Nh>hh"]r(h)r}r(h'Xclass rh(jh)hh.hh0}r(h2]rh4]rh6]rh8]rh;]ruh=Nh>hh"]rhpXclass rr}r(h'Uh(jubaubh)r}r(h'Xcircuits.core.components.rh(jh)hh.hh0}r(h2]rh4]rh6]rh8]rh;]ruh=Nh>hh"]rhpXcircuits.core.components.rr}r(h'Uh(jubaubh)r}r(h'jh(jh)hh.jh0}r(h2]rh4]rh6]rh8]rh;]ruh=Nh>hh"]rhpX Componentrr}r(h'Uh(jubaubj )r}r (h'Uh(jh)hh.jh0}r (h2]r h4]r h6]r h8]rh;]ruh=Nh>hh"]r(j)r}r(h'X*argsrh0}r(h2]rh4]rh6]rh8]rh;]ruh(jh"]rhpX*argsrr}r(h'Uh(jubah.j&ubj)r}r(h'X**kwargsr h0}r!(h2]r"h4]r#h6]r$h8]r%h;]r&uh(jh"]r'hpX**kwargsr(r)}r*(h'Uh(jubah.j&ubeubeubj4)r+}r,(h'Uh(jh)hh.j7h0}r-(h2]r.h4]r/h6]r0h8]r1h;]r2uh=Nh>hh"]r3(h)r4}r5(h'X6Bases: :class:`circuits.core.components.BaseComponent`r6h(j+h)jBh.hh0}r7(h2]r8h4]r9h6]r:h8]r;h;]r<uh=Kh>hh"]r=(hpXBases: r>r?}r@(h'XBases: rAh(j4ubhL)rB}rC(h'X/:class:`circuits.core.components.BaseComponent`rDh(j4h)h,h.hPh0}rE(UreftyperFXclassrGhThUX&circuits.core.components.BaseComponentrHU refdomainrIXpyrJh8]rKh6]rLU refexplicitrMh2]rNh4]rOh;]rPh_h`hajhbj]uh=Kh"]rQhd)rR}rS(h'jDh0}rT(h2]rUh4]rV(hjjJXpy-classrWeh6]rXh8]rYh;]rZuh(jBh"]r[hpX&circuits.core.components.BaseComponentr\r]}r^(h'Uh(jRubah.htubaubeubh)r_}r`(h'XIf you use Component instead of BaseComponent as base class for your own component class, then all methods that are not marked as private (i.e: start with an underscore) are automatically decorated as handlers.rah(j+h)jh.hh0}rb(h2]rch4]rdh6]reh8]rfh;]rguh=Kh>hh"]rhhpXIf you use Component instead of BaseComponent as base class for your own component class, then all methods that are not marked as private (i.e: start with an underscore) are automatically decorated as handlers.rirj}rk(h'jah(j_ubaubh)rl}rm(h'XuThe methods are invoked for all events from the component's channel where the event's name matches the method's name.rnh(j+h)jh.hh0}ro(h2]rph4]rqh6]rrh8]rsh;]rtuh=Kh>hh"]ruhpXuThe methods are invoked for all events from the component's channel where the event's name matches the method's name.rvrw}rx(h'jnh(jlubaubeubeubeubh$)ry}rz(h'Uh(h%h)h,h.h/h0}r{(h2]r|h4]r}h6]r~h8]rhah;]rhauh=Kh>hh"]r(h@)r}r(h'X Componentsrh(jyh)h,h.hDh0}r(h2]rh4]rh6]rh8]rh;]ruh=Kh>hh"]rhpX Componentsrr}r(h'jh(jubaubh)r}r(h'X**none**rh(jyh)h,h.hh0}r(h2]rh4]rh6]rh8]rh;]ruh=Kh>hh"]rjn)r}r(h'jh0}r(h2]rh4]rh6]rh8]rh;]ruh(jh"]rhpXnonerr}r(h'Uh(jubah.j{ubaubeubh$)r}r(h'Uh(h%h)h,h.h/h0}r(h2]rh4]rh6]rh8]rh!ah;]rhauh=Kh>hh"]r(h@)r}r(h'XEventsrh(jh)h,h.hDh0}r(h2]rh4]rh6]rh8]rh;]ruh=Kh>hh"]rhpXEventsrr}r(h'jh(jubaubhy)r}r(h'Uh(jh)Nh.h}h0}r(h8]rh6]rh2]rh4]rh;]rUentriesr]r(hX5PrepareUnregister (class in circuits.core.components)hUtrauh=Nh>hh"]rubh)r}r(h'Uh(jh)Nh.hh0}r(hhXpyrh8]rh6]rh2]rh4]rh;]rhXclassrhjuh=Nh>hh"]r(h)r}r(h'X"PrepareUnregister(*args, **kwargs)rh(jh)hh.hh0}r(h8]rhahh*Xcircuits.core.componentsrr}rbh6]rh2]rh4]rh;]rhahXPrepareUnregisterrhUh߉uh=Nh>hh"]r(h)r}r(h'Xclass rh(jh)hh.hh0}r(h2]rh4]rh6]rh8]rh;]ruh=Nh>hh"]rhpXclass rr}r(h'Uh(jubaubh)r}r(h'Xcircuits.core.components.rh(jh)hh.hh0}r(h2]rh4]rh6]rh8]rh;]ruh=Nh>hh"]rhpXcircuits.core.components.rr}r(h'Uh(jubaubh)r}r(h'jh(jh)hh.jh0}r(h2]rh4]rh6]rh8]rh;]ruh=Nh>hh"]rhpXPrepareUnregisterrr}r(h'Uh(jubaubj )r}r(h'Uh(jh)hh.jh0}r(h2]r h4]r h6]r h8]r h;]r uh=Nh>hh"]r(j)r}r(h'X*argsrh0}r(h2]rh4]rh6]rh8]rh;]ruh(jh"]rhpX*argsrr}r(h'Uh(jubah.j&ubj)r}r(h'X**kwargsrh0}r(h2]r h4]r!h6]r"h8]r#h;]r$uh(jh"]r%hpX**kwargsr&r'}r((h'Uh(jubah.j&ubeubeubj4)r)}r*(h'Uh(jh)hh.j7h0}r+(h2]r,h4]r-h6]r.h8]r/h;]r0uh=Nh>hh"]r1(h)r2}r3(h'X*Bases: :class:`circuits.core.events.Event`r4h(j)h)jBh.hh0}r5(h2]r6h4]r7h6]r8h8]r9h;]r:uh=Kh>hh"]r;(hpXBases: r<r=}r>(h'XBases: r?h(j2ubhL)r@}rA(h'X#:class:`circuits.core.events.Event`rBh(j2h)h,h.hPh0}rC(UreftyperDXclassrEhThUXcircuits.core.events.EventrFU refdomainrGXpyrHh8]rIh6]rJU refexplicitrKh2]rLh4]rMh;]rNh_h`hajhbj]uh=Kh"]rOhd)rP}rQ(h'jBh0}rR(h2]rSh4]rT(hjjHXpy-classrUeh6]rVh8]rWh;]rXuh(j@h"]rYhpXcircuits.core.events.EventrZr[}r\(h'Uh(jPubah.htubaubeubh)r]}r^(h'XThis event is fired when a component is about to be unregistered from the component tree. Unregistering a component actually detaches the complete subtree that the unregistered component is the root of. Components that need to know if they are removed from the main tree (e.g. because they maintain relationships to other components in the tree) handle this event, check if the component being unregistered is one of their ancestors and act accordingly.r_h(j)h)Xp/home/prologic/work/circuits/circuits/core/components.py:docstring of circuits.core.components.PrepareUnregisterr`h.hh0}ra(h2]rbh4]rch6]rdh8]reh;]rfuh=Kh>hh"]rghpXThis event is fired when a component is about to be unregistered from the component tree. Unregistering a component actually detaches the complete subtree that the unregistered component is the root of. Components that need to know if they are removed from the main tree (e.g. because they maintain relationships to other components in the tree) handle this event, check if the component being unregistered is one of their ancestors and act accordingly.rhri}rj(h'j_h(j]ubaubj))rk}rl(h'Uh(j)h)Nh.j,h0}rm(h2]rnh4]roh6]rph8]rqh;]rruh=Nh>hh"]rsj4)rt}ru(h'Uh0}rv(h2]rwh4]rxh6]ryh8]rzh;]r{uh(jkh"]r|(j>)r}}r~(h'Uh0}r(h2]rh4]rh6]rh8]rh;]ruh(jth"]rhpX Parametersrr}r(h'Uh(j}ubah.jKubjL)r}r(h'Uh0}r(h2]rh4]rh6]rh8]rh;]ruh(jth"]rh)r}r(h'Uh0}r(h2]rh4]rh6]rh8]rh;]ruh(jh"]r(jn)r}r(h'X componentrh0}r(h2]rh4]rh6]rh8]rh;]ruh(jh"]rhpX componentrr}r(h'Uh(jubah.j{ubhpX -- rr}r(h'Uh(jubhpX'the component that will be unregisteredrr}r(h'X'the component that will be unregisteredrh(jubeh.hubah.jubeh.jubaubhy)r}r(h'Uh(j)h)X{/home/prologic/work/circuits/circuits/core/components.py:docstring of circuits.core.components.PrepareUnregister.in_subtreerh.h}h0}r(h8]rh6]rh2]rh4]rh;]rUentriesr]r(hX@in_subtree() (circuits.core.components.PrepareUnregister method)hUtrauh=Nh>hh"]rubh)r}r(h'Uh(j)h)jh.hh0}r(hhXpyrh8]rh6]rh2]rh4]rh;]rhXmethodrhjuh=Nh>hh"]r(h)r}r(h'X'PrepareUnregister.in_subtree(component)rh(jh)hh.hh0}r(h8]rhahh*Xcircuits.core.componentsrr}rbh6]rh2]rh4]rh;]rhahXPrepareUnregister.in_subtreerhjh߉uh=Nh>hh"]r(h)r}r(h'X in_subtreerh(jh)hh.jh0}r(h2]rh4]rh6]rh8]rh;]ruh=Nh>hh"]rhpX in_subtreerr}r(h'Uh(jubaubj )r}r(h'Uh(jh)hh.jh0}r(h2]rh4]rh6]rh8]rh;]ruh=Nh>hh"]rj)r}r(h'X componentrh0}r(h2]rh4]rh6]rh8]rh;]ruh(jh"]rhpX componentrr}r(h'Uh(jubah.j&ubaubeubj4)r}r(h'Uh(jh)hh.j7h0}r(h2]rh4]rh6]rh8]rh;]ruh=Nh>hh"]rh)r}r(h'XgConvenience method that checks if the given *component* is in the subtree that is about to be detached.rh(jh)jh.hh0}r(h2]rh4]rh6]rh8]rh;]r uh=Kh>hh"]r (hpX,Convenience method that checks if the given r r }r (h'X,Convenience method that checks if the given rh(jubj)r}r(h'X *component*rh0}r(h2]rh4]rh6]rh8]rh;]ruh(jh"]rhpX componentrr}r(h'Uh(jubah.jubhpX0 is in the subtree that is about to be detached.rr}r(h'X0 is in the subtree that is about to be detached.rh(jubeubaubeubeubeubhy)r }r!(h'Uh(jh)Xm/home/prologic/work/circuits/circuits/core/components.py:docstring of circuits.core.components.SingletonErrorr"h.h}h0}r#(h8]r$h6]r%h2]r&h4]r'h;]r(Uentriesr)]r*(hX2SingletonError (class in circuits.core.components)hUtr+auh=Nh>hh"]r,ubh)r-}r.(h'Uh(jh)j"h.hh0}r/(hhXpyr0h8]r1h6]r2h2]r3h4]r4h;]r5hXclassr6hj6uh=Nh>hh"]r7(h)r8}r9(h'XSingletonErrorr:h(j-h)hh.hh0}r;(h8]r<hahh*Xcircuits.core.componentsr=r>}r?bh6]r@h2]rAh4]rBh;]rChahj:hUh߉uh=Nh>hh"]rD(h)rE}rF(h'Xclass rGh(j8h)hh.hh0}rH(h2]rIh4]rJh6]rKh8]rLh;]rMuh=Nh>hh"]rNhpXclass rOrP}rQ(h'Uh(jEubaubh)rR}rS(h'Xcircuits.core.components.rTh(j8h)hh.hh0}rU(h2]rVh4]rWh6]rXh8]rYh;]rZuh=Nh>hh"]r[hpXcircuits.core.components.r\r]}r^(h'Uh(jRubaubh)r_}r`(h'j:h(j8h)hh.jh0}ra(h2]rbh4]rch6]rdh8]reh;]rfuh=Nh>hh"]rghpXSingletonErrorrhri}rj(h'Uh(j_ubaubeubj4)rk}rl(h'Uh(j-h)hh.j7h0}rm(h2]rnh4]roh6]rph8]rqh;]rruh=Nh>hh"]rs(h)rt}ru(h'X$Bases: :class:`exceptions.Exception`rvh(jkh)jBh.hh0}rw(h2]rxh4]ryh6]rzh8]r{h;]r|uh=Kh>hh"]r}(hpXBases: r~r}r(h'XBases: rh(jtubhL)r}r(h'X:class:`exceptions.Exception`rh(jth)h,h.hPh0}r(UreftyperXclassrhThUXexceptions.ExceptionrU refdomainrXpyrh8]rh6]rU refexplicitrh2]rh4]rh;]rh_h`haj:hbj]uh=Kh"]rhd)r}r(h'jh0}r(h2]rh4]r(hjjXpy-classreh6]rh8]rh;]ruh(jh"]rhpXexceptions.Exceptionrr}r(h'Uh(jubah.htubaubeubh)r}r(h'XCRaised if a Component with the `singleton` class attribute is True.rh(jkh)j"h.hh0}r(h2]rh4]rh6]rh8]rh;]ruh=Kh>hh"]r(hpXRaised if a Component with the rr}r(h'XRaised if a Component with the rh(jubcdocutils.nodes title_reference r)r}r(h'X `singleton`rh0}r(h2]rh4]rh6]rh8]rh;]ruh(jh"]rhpX singletonrr}r(h'Uh(jubah.Utitle_referencerubhpX class attribute is True.rr}r(h'X class attribute is True.rh(jubeubeubeubeubh$)r}r(h'Uh(h%h)h,h.h/h0}r(h2]rh4]rh6]rh8]rhah;]rh auh=K!h>hh"]r(h@)r}r(h'X Functionsrh(jh)h,h.hDh0}r(h2]rh4]rh6]rh8]rh;]ruh=K!h>hh"]rhpX Functionsrr}r(h'jh(jubaubh)r}r(h'X**none**rh(jh)h,h.hh0}r(h2]rh4]rh6]rh8]rh;]ruh=K#h>hh"]rjn)r}r(h'jh0}r(h2]rh4]rh6]rh8]rh;]ruh(jh"]rhpXnonerr}r(h'Uh(jubah.j{ubaubeubeubah'UU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh>hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr }r Uindirect_targetsr ]r Usettingsr (cdocutils.frontend Values r or }r (Ufootnote_backlinksr KUrecord_dependenciesr NU rfc_base_urlr Uhttp://tools.ietf.org/html/r U tracebackr Upep_referencesr NUstrip_commentsr NU toc_backlinksr Uentryr U language_coder Uenr U datestampr NU report_levelr KU _destinationr NU halt_levelr KU strip_classesr NhDNUerror_encoding_error_handlerr Ubackslashreplacer Udebugr NUembed_stylesheetr Uoutput_encoding_error_handlerr Ustrictr U sectnum_xformr KUdump_transformsr NU docinfo_xformr KUwarning_streamr! NUpep_file_url_templater" Upep-%04dr# Uexit_status_levelr$ KUconfigr% NUstrict_visitorr& NUcloak_email_addressesr' Utrim_footnote_reference_spacer( Uenvr) NUdump_pseudo_xmlr* NUexpose_internalsr+ NUsectsubtitle_xformr, U source_linkr- NUrfc_referencesr. NUoutput_encodingr/ Uutf-8r0 U source_urlr1 NUinput_encodingr2 U utf-8-sigr3 U_disable_configr4 NU id_prefixr5 UU tab_widthr6 KUerror_encodingr7 U ISO-8859-1r8 U_sourcer9 UI/home/prologic/work/circuits/docs/source/api/circuits_core_components.rstr: Ugettext_compactr; U generatorr< NUdump_internalsr= NU smart_quotesr> U pep_base_urlr? Uhttp://www.python.org/dev/peps/r@ Usyntax_highlightrA UlongrB Uinput_encoding_error_handlerrC j Uauto_id_prefixrD UidrE Udoctitle_xformrF Ustrip_elements_with_classesrG NU _config_filesrH ]rI Ufile_insertion_enabledrJ KU raw_enabledrK KU dump_settingsrL NubUsymbol_footnote_startrM KUidsrN }rO (hjIh:cdocutils.nodes target rP )rQ }rR (h'Uh(h%h)h|h.UtargetrS h0}rT (h2]rU h8]rV h:ah6]rW UismodrX h4]rY h;]rZ uh=Kh>hh"]r[ ubh!jh jCh jihjh hhjh hhj hjhjhjyhh%hj8uUsubstitution_namesr\ }r] h.h>h0}r^ (h2]r_ h8]r` h6]ra Usourcerb h,h4]rc h;]rd uU footnotesre ]rf Urefidsrg }rh ub.circuits-2.1.0/docs/build/doctrees/api/circuits_io.doctree0000644000014400001440000001125412113366657023400 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qXcircuits.io -- i/o supportqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhUcircuits-io-i-o-supportqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX</home/prologic/work/circuits/docs/source/api/circuits_io.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q((Xmodule-circuits.ioq)heUnamesq*]q+hauUlineq,KUdocumentq-hh]q.(cdocutils.nodes title q/)q0}q1(hX!:mod:`circuits.io` -- I/O Supportq2hhhhhUtitleq3h}q4(h!]q5h#]q6h%]q7h']q8h*]q9uh,Kh-hh]q:(csphinx.addnodes pending_xref q;)q<}q=(hX:mod:`circuits.io`q>hh0hhhU pending_xrefq?h}q@(UreftypeqAXmodqBUrefwarnqCU reftargetqDX circuits.ioqEU refdomainqFXpyqGh']qHh%]qIU refexplicitqJh!]qKh#]qLh*]qMUrefdocqNUapi/circuits_ioqOUpy:classqPNU py:moduleqQNuh,Kh]qRcdocutils.nodes literal qS)qT}qU(hh>h}qV(h!]qWh#]qX(UxrefqYhGXpy-modqZeh%]q[h']q\h*]q]uhhqkhUindexqlh}qm(h']qnh%]qoh!]qph#]qqh*]qrUentriesqs]qt(UsinglequXcircuits.io (module)Xmodule-circuits.ioUtqvauh,Kh-hh]qwubcdocutils.nodes paragraph qx)qy}qz(hX I/O Supportq{hhhXM/home/prologic/work/circuits/circuits/io/__init__.py:docstring of circuits.ioq|hU paragraphq}h}q~(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_X I/O Supportqq}q(hh{hhyubaubhx)q}q(hXThis package contains various I/O Components. Provided are a a generic File Component, StdIn, StdOut and StdErr components. Instances of StdIn, StdOUt and StdErr are also created by importing this package.qhhhh|hh}h}q(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_XThis package contains various I/O Components. Provided are a a generic File Component, StdIn, StdOut and StdErr components. Instances of StdIn, StdOUt and StdErr are also created by importing this package.qq}q(hhhhubaubcdocutils.nodes compound q)q}q(hUhhhhhUcompoundqh}q(h!]qh#]qUtoctree-wrapperqah%]qh']qh*]quh,Nh-hh]qcsphinx.addnodes toctree q)q}q(hUhhhhhUtoctreeqh}q(UnumberedqKhhOU titlesonlyqUglobqh']qh%]qh!]qh#]qh*]qUentriesq]q(NUapi/circuits_io_eventsqqNUapi/circuits_io_fileqqNUapi/circuits_io_notifyqqNUapi/circuits_io_serialqqeUhiddenqU includefilesq]q(hhhheUmaxdepthqKuh,Kh]qubaubeubahUU transformerqNU footnote_refsq}qUrefnamesq}qUsymbol_footnotesq]qUautofootnote_refsq]qUsymbol_footnote_refsq]qU citationsq]qh-hU current_lineqNUtransform_messagesq]qUreporterqNUid_startqKU autofootnotesq]qU citation_refsq}qUindirect_targetsq]qUsettingsq(cdocutils.frontend Values qoq}q(Ufootnote_backlinksqKUrecord_dependenciesqNU rfc_base_urlqUhttp://tools.ietf.org/html/qU tracebackq݈Upep_referencesqNUstrip_commentsqNU toc_backlinksqUentryqU language_codeqUenqU datestampqNU report_levelqKU _destinationqNU halt_levelqKU strip_classesqNh3NUerror_encoding_error_handlerqUbackslashreplaceqUdebugqNUembed_stylesheetqUoutput_encoding_error_handlerqUstrictqU sectnum_xformqKUdump_transformsqNU docinfo_xformqKUwarning_streamqNUpep_file_url_templateqUpep-%04dqUexit_status_levelqKUconfigqNUstrict_visitorqNUcloak_email_addressesqUtrim_footnote_reference_spaceqUenvqNUdump_pseudo_xmlqNUexpose_internalsqNUsectsubtitle_xformqU source_linkqNUrfc_referencesqNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1r U_sourcer Uhh0hhhU pending_xrefq?h}q@(UreftypeqAXmodqBUrefwarnqCU reftargetqDX circuits.webqEU refdomainqFXpyqGh']qHh%]qIU refexplicitqJh!]qKh#]qLh*]qMUrefdocqNUapi/circuits_webqOUpy:classqPNU py:moduleqQNuh,Kh]qRcdocutils.nodes literal qS)qT}qU(hh>h}qV(h!]qWh#]qX(UxrefqYhGXpy-modqZeh%]q[h']q\h*]q]uhhqkhUindexqlh}qm(h']qnh%]qoh!]qph#]qqh*]qrUentriesqs]qt(UsinglequXcircuits.web (module)Xmodule-circuits.webUtqvauh,Kh-hh]qwubcdocutils.nodes paragraph qx)qy}qz(hXCircuits Library - Webq{hhhXO/home/prologic/work/circuits/circuits/web/__init__.py:docstring of circuits.webq|hU paragraphq}h}q~(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_XCircuits Library - Webqq}q(hh{hhyubaubhx)q}q(hXYcircuits.web contains the circuits full stack web server that is HTTP and WSGI compliant.qhhhh|hh}h}q(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_XYcircuits.web contains the circuits full stack web server that is HTTP and WSGI compliant.qq}q(hhhhubaubcdocutils.nodes compound q)q}q(hUhhhhhUcompoundqh}q(h!]qh#]qUtoctree-wrapperqah%]qh']qh*]quh,Nh-hh]qcsphinx.addnodes toctree q)q}q(hUhhhhhUtoctreeqh}q(UnumberedqKhhOU titlesonlyqUglobqh']qh%]qh!]qh#]qh*]qUentriesq]q(NUapi/circuits_web_clientqqNUapi/circuits_web_constantsqqNUapi/circuits_web_controllersqqNU'api/circuits_web_dispatchers_dispatcherqqNU$api/circuits_web_dispatchers_jsonrpcqqNU#api/circuits_web_dispatchers_staticqqNU)api/circuits_web_dispatchers_virtualhostsqqNU'api/circuits_web_dispatchers_websocketsqqNU#api/circuits_web_dispatchers_xmlrpcqqNUapi/circuits_web_errorsq†qNUapi/circuits_web_eventsqĆqNUapi/circuits_web_exceptionsqƆqNUapi/circuits_web_headersqȆqNUapi/circuits_web_httpqʆqNUapi/circuits_web_loggersq̆qNUapi/circuits_web_mainqΆqNUapi/circuits_web_serversqІqNUapi/circuits_web_sessionsq҆qNUapi/circuits_web_toolsqԆqNUapi/circuits_web_utilsqֆqNUapi/circuits_web_websocketq؆qNUapi/circuits_web_wrappersqچqNUapi/circuits_web_wsgiq܆qeUhiddenqމU includefilesq]q(hhhhhhhhhhhhhhhhhhhhhhheUmaxdepthqKuh,Kh]qubaubeubahUU transformerqNU footnote_refsq}qUrefnamesq}qUsymbol_footnotesq]qUautofootnote_refsq]qUsymbol_footnote_refsq]qU citationsq]qh-hU current_lineqNUtransform_messagesq]qUreporterqNUid_startqKU autofootnotesq]qU citation_refsq}qUindirect_targetsq]qUsettingsq(cdocutils.frontend Values qoq}q(Ufootnote_backlinksqKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenr U datestampr NU report_levelr KU _destinationr NU halt_levelr KU strip_classesrNh3NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvr NUdump_pseudo_xmlr!NUexpose_internalsr"NUsectsubtitle_xformr#U source_linkr$NUrfc_referencesr%NUoutput_encodingr&Uutf-8r'U source_urlr(NUinput_encodingr)U utf-8-sigr*U_disable_configr+NU id_prefixr,UU tab_widthr-KUerror_encodingr.U ISO-8859-1r/U_sourcer0U=/home/prologic/work/circuits/docs/source/api/circuits_web.rstr1Ugettext_compactr2U generatorr3NUdump_internalsr4NU smart_quotesr5U pep_base_urlr6Uhttp://www.python.org/dev/peps/r7Usyntax_highlightr8Ulongr9Uinput_encoding_error_handlerr:jUauto_id_prefixr;Uidr<Udoctitle_xformr=Ustrip_elements_with_classesr>NU _config_filesr?]r@Ufile_insertion_enabledrAKU raw_enabledrBKU dump_settingsrCNubUsymbol_footnote_startrDKUidsrE}rF(hhh)cdocutils.nodes target rG)rH}rI(hUhhhhkhUtargetrJh}rK(h!]rLh']rMh)ah%]rNUismodrOh#]rPh*]rQuh,Kh-hh]rRubuUsubstitution_namesrS}rThh-h}rU(h!]rVh']rWh%]rXUsourcerYhh#]rZh*]r[uU footnotesr\]r]Urefidsr^}r_ub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_loggers.doctree0000644000014400001440000002241512113366665025270 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNXcircuits.web.loggers.formattimeqXcircuits.web.loggers -- loggersqNX componentsq NXeventsq NXcircuits.web.loggers.Loggerq uUsubstitution_defsq }q Uparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhhhUcircuits-web-loggers-loggersqh U componentsqh Ueventsqh h uUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceq cdocutils.nodes reprunicode q!XE/home/prologic/work/circuits/docs/source/api/circuits_web_loggers.rstq"q#}q$bUtagnameq%Usectionq&U attributesq'}q((Udupnamesq)]q*Uclassesq+]q,Ubackrefsq-]q.Uidsq/]q0(Xmodule-circuits.web.loggersq1heUnamesq2]q3hauUlineq4KUdocumentq5hh]q6(cdocutils.nodes title q7)q8}q9(hX&:mod:`circuits.web.loggers` -- Loggersq:hhh h#h%Utitleq;h'}q<(h)]q=h+]q>h-]q?h/]q@h2]qAuh4Kh5hh]qB(csphinx.addnodes pending_xref qC)qD}qE(hX:mod:`circuits.web.loggers`qFhh8h h#h%U pending_xrefqGh'}qH(UreftypeqIXmodqJUrefwarnqKU reftargetqLXcircuits.web.loggersqMU refdomainqNXpyqOh/]qPh-]qQU refexplicitqRh)]qSh+]qTh2]qUUrefdocqVUapi/circuits_web_loggersqWUpy:classqXNU py:moduleqYNuh4Kh]qZcdocutils.nodes literal q[)q\}q](hhFh'}q^(h)]q_h+]q`(UxrefqahOXpy-modqbeh-]qch/]qdh2]qeuhhDh]qfcdocutils.nodes Text qgXcircuits.web.loggersqhqi}qj(hUhh\ubah%UliteralqkubaubhgX -- Loggersqlqm}qn(hX -- Loggersqohh8ubeubcsphinx.addnodes index qp)qq}qr(hUhhh U qsh%Uindexqth'}qu(h/]qvh-]qwh)]qxh+]qyh2]qzUentriesq{]q|(Usingleq}Xcircuits.web.loggers (module)Xmodule-circuits.web.loggersUtq~auh4Kh5hh]qubcdocutils.nodes paragraph q)q}q(hXLogger Componentqhhh XV/home/prologic/work/circuits/circuits/web/loggers.py:docstring of circuits.web.loggersqh%U paragraphqh'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgXLogger Componentqq}q(hhhhubaubh)q}q(hX)This module implements Logger Components.qhhh hh%hh'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgX)This module implements Logger Components.qq}q(hhhhubaubh)q}q(hUhhh h#h%h&h'}q(h)]qh+]qh-]qh/]qhah2]qh auh4Kh5hh]q(h7)q}q(hXEventsqhhh h#h%h;h'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgXEventsqq}q(hhhhubaubh)q}q(hX**none**qhhh h#h%hh'}q(h)]qh+]qh-]qh/]qh2]quh4K h5hh]qcdocutils.nodes strong q)q}q(hhh'}q(h)]qh+]qh-]qh/]qh2]quhhh]qhgXnoneqDžq}q(hUhhubah%Ustrongqubaubeubh)q}q(hUhhh h#h%h&h'}q(h)]qh+]qh-]qh/]qhah2]qh auh4Kh5hh]q(h7)q}q(hX Componentsqhhh h#h%h;h'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgX Componentsqޅq}q(hhhhubaubhp)q}q(hUhhh U qh%hth'}q(h/]qh-]qh)]qh+]qh2]qUentriesq]q(h}X&Logger (class in circuits.web.loggers)h Utqauh4Nh5hh]qubcsphinx.addnodes desc q)q}q(hUhhh hh%Udescqh'}q(UnoindexqUdomainqXpyqh/]qh-]qh)]qh+]qh2]qUobjtypeqXclassqUdesctypeqhuh4Nh5hh]q(csphinx.addnodes desc_signature q)r}r(hX(Logger(file=None, logger=None, **kwargs)rhhh U rh%Udesc_signaturerh'}r(h/]rh aUmodulerh!Xcircuits.web.loggersrr }r bh-]r h)]r h+]r h2]rh aUfullnamerXLoggerrUclassrUUfirstruh4Nh5hh]r(csphinx.addnodes desc_annotation r)r}r(hXclass rhjh jh%Udesc_annotationrh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXclass r r!}r"(hUhjubaubcsphinx.addnodes desc_addname r#)r$}r%(hXcircuits.web.loggers.r&hjh jh%U desc_addnamer'h'}r((h)]r)h+]r*h-]r+h/]r,h2]r-uh4Nh5hh]r.hgXcircuits.web.loggers.r/r0}r1(hUhj$ubaubcsphinx.addnodes desc_name r2)r3}r4(hjhjh jh%U desc_namer5h'}r6(h)]r7h+]r8h-]r9h/]r:h2]r;uh4Nh5hh]r<hgXLoggerr=r>}r?(hUhj3ubaubcsphinx.addnodes desc_parameterlist r@)rA}rB(hUhjh jh%Udesc_parameterlistrCh'}rD(h)]rEh+]rFh-]rGh/]rHh2]rIuh4Nh5hh]rJ(csphinx.addnodes desc_parameter rK)rL}rM(hX file=NonerNh'}rO(h)]rPh+]rQh-]rRh/]rSh2]rTuhjAh]rUhgX file=NonerVrW}rX(hUhjLubah%Udesc_parameterrYubjK)rZ}r[(hX logger=Noner\h'}r](h)]r^h+]r_h-]r`h/]rah2]rbuhjAh]rchgX logger=Nonerdre}rf(hUhjZubah%jYubjK)rg}rh(hX**kwargsrih'}rj(h)]rkh+]rlh-]rmh/]rnh2]rouhjAh]rphgX**kwargsrqrr}rs(hUhjgubah%jYubeubeubcsphinx.addnodes desc_content rt)ru}rv(hUhhh jh%U desc_contentrwh'}rx(h)]ryh+]rzh-]r{h/]r|h2]r}uh4Nh5hh]r~h)r}r(hX6Bases: :class:`circuits.core.components.BaseComponent`rhjuh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]r(hgXBases: rr}r(hXBases: rhjubhC)r}r(hX/:class:`circuits.core.components.BaseComponent`rhjh h#h%hGh'}r(UreftyperXclassrhKhLX&circuits.core.components.BaseComponentrU refdomainrXpyrh/]rh-]rU refexplicitrh)]rh+]rh2]rhVhWhXjhYXcircuits.web.loggersruh4Kh]rh[)r}r(hjh'}r(h)]rh+]r(hajXpy-classreh-]rh/]rh2]ruhjh]rhgX&circuits.core.components.BaseComponentrr}r(hUhjubah%hkubaubeubaubeubeubh)r}r(hUhhh h#h%h&h'}r(h)]rh+]rh-]rh/]rhah2]rhauh4Kh5hh]r(h7)r}r(hX Functionsrhjh h#h%h;h'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgX Functionsrr}r(hjhjubaubhp)r}r(hUhjh Nh%hth'}r(h/]rh-]rh)]rh+]rh2]rUentriesr]r(h}X-formattime() (in module circuits.web.loggers)hUtrauh4Nh5hh]rubh)r}r(hUhjh Nh%hh'}r(hhXpyrh/]rh-]rh)]rh+]rh2]rhXfunctionrhjuh4Nh5hh]r(h)r}r(hX formattime()rhjh jh%jh'}r(h/]rhajh!Xcircuits.web.loggersrr}rbh-]rh)]rh+]rh2]rhajX formattimerjUjuh4Nh5hh]r(j#)r}r(hXcircuits.web.loggers.rhjh jh%j'h'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXcircuits.web.loggers.rr}r(hUhjubaubj2)r}r(hjhjh jh%j5h'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgX formattimerr}r(hUhjubaubj@)r}r(hUhjh jh%jCh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rubeubjt)r}r (hUhjh jh%jwh'}r (h)]r h+]r h-]r h/]rh2]ruh4Nh5hh]rubeubeubeubahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh5hU current_linerNUtransform_messagesr]r Ureporterr!NUid_startr"KU autofootnotesr#]r$U citation_refsr%}r&Uindirect_targetsr']r(Usettingsr)(cdocutils.frontend Values r*or+}r,(Ufootnote_backlinksr-KUrecord_dependenciesr.NU rfc_base_urlr/Uhttp://tools.ietf.org/html/r0U tracebackr1Upep_referencesr2NUstrip_commentsr3NU toc_backlinksr4Uentryr5U language_coder6Uenr7U datestampr8NU report_levelr9KU _destinationr:NU halt_levelr;KU strip_classesr<Nh;NUerror_encoding_error_handlerr=Ubackslashreplacer>Udebugr?NUembed_stylesheetr@Uoutput_encoding_error_handlerrAUstrictrBU sectnum_xformrCKUdump_transformsrDNU docinfo_xformrEKUwarning_streamrFNUpep_file_url_templaterGUpep-%04drHUexit_status_levelrIKUconfigrJNUstrict_visitorrKNUcloak_email_addressesrLUtrim_footnote_reference_spacerMUenvrNNUdump_pseudo_xmlrONUexpose_internalsrPNUsectsubtitle_xformrQU source_linkrRNUrfc_referencesrSNUoutput_encodingrTUutf-8rUU source_urlrVNUinput_encodingrWU utf-8-sigrXU_disable_configrYNU id_prefixrZUU tab_widthr[KUerror_encodingr\U ISO-8859-1r]U_sourcer^UE/home/prologic/work/circuits/docs/source/api/circuits_web_loggers.rstr_Ugettext_compactr`U generatorraNUdump_internalsrbNU smart_quotesrcU pep_base_urlrdUhttp://www.python.org/dev/peps/reUsyntax_highlightrfUlongrgUinput_encoding_error_handlerrhjBUauto_id_prefixriUidrjUdoctitle_xformrkUstrip_elements_with_classesrlNU _config_filesrm]rnUfile_insertion_enabledroKU raw_enabledrpKU dump_settingsrqNubUsymbol_footnote_startrrKUidsrs}rt(hjh1cdocutils.nodes target ru)rv}rw(hUhhh hsh%Utargetrxh'}ry(h)]rzh/]r{h1ah-]r|Uismodr}h+]r~h2]ruh4Kh5hh]rubhjhhhhhhh juUsubstitution_namesr}rh%h5h'}r(h)]rh/]rh-]rUsourcerh#h+]rh2]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_core_events.doctree0000644000014400001440000021255012113366655025305 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(Xcircuits.core.events.UnregisterqXcircuits.core.events.SuccessqXcircuits.core.events.FailureqXcircuits.core.events.Signalq X-circuits.core.events.GenerateEvents.time_leftq X!circuits.core.events.Unregisteredq X4circuits.core.events.GenerateEvents.reduce_time_leftq X functionsq NXcircuits.core.events.ErrorqXcircuits.core.events.StartedqXcircuits.core.events.StoppedqXclassesqNX componentsqNX#circuits.core.events.GenerateEventsqXcircuits.core.events.EventqXcircuits.core.events.RegisteredqXcircuits.core.events -- eventsqNXeventsqNuUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q (hhhhhhh h h h h h h h h U functionsq!hhhhhhhUclassesq"hU componentsq#hhhhhhhUcircuits-core-events-eventsq$hUeventsq%uUchildrenq&]q'cdocutils.nodes section q()q)}q*(U rawsourceq+UUparentq,hUsourceq-cdocutils.nodes reprunicode q.XE/home/prologic/work/circuits/docs/source/api/circuits_core_events.rstq/q0}q1bUtagnameq2Usectionq3U attributesq4}q5(Udupnamesq6]q7Uclassesq8]q9Ubackrefsq:]q;Uidsq<]q=(Xmodule-circuits.core.eventsq>h$eUnamesq?]q@hauUlineqAKUdocumentqBhh&]qC(cdocutils.nodes title qD)qE}qF(h+X%:mod:`circuits.core.events` -- EventsqGh,h)h-h0h2UtitleqHh4}qI(h6]qJh8]qKh:]qLh<]qMh?]qNuhAKhBhh&]qO(csphinx.addnodes pending_xref qP)qQ}qR(h+X:mod:`circuits.core.events`qSh,hEh-h0h2U pending_xrefqTh4}qU(UreftypeqVXmodqWUrefwarnqXU reftargetqYXcircuits.core.eventsqZU refdomainq[Xpyq\h<]q]h:]q^U refexplicitq_h6]q`h8]qah?]qbUrefdocqcUapi/circuits_core_eventsqdUpy:classqeNU py:moduleqfNuhAKh&]qgcdocutils.nodes literal qh)qi}qj(h+hSh4}qk(h6]qlh8]qm(Uxrefqnh\Xpy-modqoeh:]qph<]qqh?]qruh,hQh&]qscdocutils.nodes Text qtXcircuits.core.eventsquqv}qw(h+Uh,hiubah2UliteralqxubaubhtX -- Eventsqyqz}q{(h+X -- Eventsq|h,hEubeubcsphinx.addnodes index q})q~}q(h+Uh,h)h-U qh2Uindexqh4}q(h<]qh:]qh6]qh8]qh?]qUentriesq]q(UsingleqXcircuits.core.events (module)Xmodule-circuits.core.eventsUtqauhAKhBhh&]qubcdocutils.nodes paragraph q)q}q(h+X<This module defines the basic Event class and common events.qh,h)h-XV/home/prologic/work/circuits/circuits/core/events.py:docstring of circuits.core.eventsqh2U paragraphqh4}q(h6]qh8]qh:]qh<]qh?]quhAKhBhh&]qhtX<This module defines the basic Event class and common events.qq}q(h+hh,hubaubh()q}q(h+Uh,h)h-h0h2h3h4}q(h6]qh8]qh:]qh<]qh"ah?]qhauhAKhBhh&]q(hD)q}q(h+XClassesqh,hh-h0h2hHh4}q(h6]qh8]qh:]qh<]qh?]quhAKhBhh&]qhtXClassesqq}q(h+hh,hubaubh})q}q(h+Uh,hh-Nh2hh4}q(h<]qh:]qh6]qh8]qh?]qUentriesq]q(hX%Event (class in circuits.core.events)hUtqauhANhBhh&]qubcsphinx.addnodes desc q)q}q(h+Uh,hh-Nh2Udescqh4}q(UnoindexqĉUdomainqXpyqh<]qh:]qh6]qh8]qh?]qUobjtypeqXclassqUdesctypeqhuhANhBhh&]q(csphinx.addnodes desc_signature q)q}q(h+XEvent(*args, **kwargs)qh,hh-U qh2Udesc_signatureqh4}q(h<]qhaUmoduleqh.Xcircuits.core.eventsqمq}qbh:]qh6]qh8]qh?]qhaUfullnameqXEventqUclassqUUfirstquhANhBhh&]q(csphinx.addnodes desc_annotation q)q}q(h+Xclass qh,hh-hh2Udesc_annotationqh4}q(h6]qh8]qh:]qh<]qh?]quhANhBhh&]qhtXclass qq}q(h+Uh,hubaubcsphinx.addnodes desc_addname q)q}q(h+Xcircuits.core.events.qh,hh-hh2U desc_addnameqh4}q(h6]qh8]qh:]qh<]qh?]quhANhBhh&]qhtXcircuits.core.events.rr}r(h+Uh,hubaubcsphinx.addnodes desc_name r)r}r(h+hh,hh-hh2U desc_namerh4}r(h6]rh8]r h:]r h<]r h?]r uhANhBhh&]r htXEventrr}r(h+Uh,jubaubcsphinx.addnodes desc_parameterlist r)r}r(h+Uh,hh-hh2Udesc_parameterlistrh4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]r(csphinx.addnodes desc_parameter r)r}r(h+X*argsrh4}r (h6]r!h8]r"h:]r#h<]r$h?]r%uh,jh&]r&htX*argsr'r(}r)(h+Uh,jubah2Udesc_parameterr*ubj)r+}r,(h+X**kwargsr-h4}r.(h6]r/h8]r0h:]r1h<]r2h?]r3uh,jh&]r4htX**kwargsr5r6}r7(h+Uh,j+ubah2j*ubeubeubcsphinx.addnodes desc_content r8)r9}r:(h+Uh,hh-hh2U desc_contentr;h4}r<(h6]r=h8]r>h:]r?h<]r@h?]rAuhANhBhh&]rB(h)rC}rD(h+X.Bases: :class:`circuits.core.events.BaseEvent`rEh,j9h-U rFh2hh4}rG(h6]rHh8]rIh:]rJh<]rKh?]rLuhAKhBhh&]rM(htXBases: rNrO}rP(h+XBases: rQh,jCubhP)rR}rS(h+X':class:`circuits.core.events.BaseEvent`rTh,jCh-h0h2hTh4}rU(UreftyperVXclassrWhXhYXcircuits.core.events.BaseEventrXU refdomainrYXpyrZh<]r[h:]r\U refexplicitr]h6]r^h8]r_h?]r`hchdhehhfXcircuits.core.eventsrauhAKh&]rbhh)rc}rd(h+jTh4}re(h6]rfh8]rg(hnjZXpy-classrheh:]rih<]rjh?]rkuh,jRh&]rlhtXcircuits.core.events.BaseEventrmrn}ro(h+Uh,jcubah2hxubaubeubh)rp}rq(h+XAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rrh,j9h-X\/home/prologic/work/circuits/circuits/core/events.py:docstring of circuits.core.events.Eventrsh2hh4}rt(h6]ruh8]rvh:]rwh<]rxh?]ryuhAKhBhh&]rzhtXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.r{r|}r}(h+jrh,jpubaubh)r~}r(h+XAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rh,j9h-jsh2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAKhBhh&]rhtXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rr}r(h+jh,j~ubaubh)r}r(h+XEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh,j9h-jsh2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAK hBhh&]r(htXEvery event has a rr}r(h+XEvery event has a rh,jubhP)r}r(h+X :attr:`name`rh,jh-h0h2hTh4}r(UreftyperXattrrhXhYXnamerU refdomainrXpyrh<]rh:]rU refexplicitrh6]rh8]rh?]rhchdhehhfjauhAKh&]rhh)r}r(h+jh4}r(h6]rh8]r(hnjXpy-attrreh:]rh<]rh?]ruh,jh&]rhtXnamerr}r(h+Uh,jubah2hxubaubhtX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(h+X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh,jubeubcdocutils.nodes field_list r)r}r(h+Uh,j9h-Nh2U field_listrh4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]rcdocutils.nodes field r)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]r(cdocutils.nodes field_name r)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtX Variablesrr}r(h+Uh,jubah2U field_namerubcdocutils.nodes field_body r)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rcdocutils.nodes bullet_list r)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]r(cdocutils.nodes list_item r)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rh)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]r(hP)r}r(h+Uh4}r(UreftyperUobjrU reftargetr Xchannelsr U refdomainr hh<]r h:]r U refexplicitrh6]rh8]rh?]ruh,jh&]rcdocutils.nodes strong r)r}r(h+j h4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtXchannelsrr}r(h+Uh,jubah2Ustrongr ubah2hTubhtX -- r!r"}r#(h+Uh,jubh)r$}r%(h+Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r&h,jh-jsh2hh4}r'(h6]r(h8]r)h:]r*h<]r+h?]r,uhAKh&]r-htXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r.r/}r0(h+j&h,j$ubaubh)r1}r2(h+XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r3h,jh-jsh2hh4}r4(h6]r5h8]r6h:]r7h<]r8h?]r9uhAKh&]r:htXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r;r<}r=(h+j3h,j1ubaubeh2hubah2U list_itemr>ubj)r?}r@(h+Uh4}rA(h6]rBh8]rCh:]rDh<]rEh?]rFuh,jh&]rGh)rH}rI(h+Uh4}rJ(h6]rKh8]rLh:]rMh<]rNh?]rOuh,j?h&]rP(hP)rQ}rR(h+Uh4}rS(UreftyperTjU reftargetrUXvaluerVU refdomainrWhh<]rXh:]rYU refexplicitrZh6]r[h8]r\h?]r]uh,jHh&]r^j)r_}r`(h+jVh4}ra(h6]rbh8]rch:]rdh<]reh?]rfuh,jQh&]rghtXvaluerhri}rj(h+Uh,j_ubah2j ubah2hTubhtX -- rkrl}rm(h+Uh,jHubhtX this is a rnro}rp(h+X this is a rqh,jHubhP)rr}rs(h+X#:class:`circuits.core.values.Value`rth,jHh-h0h2hTh4}ru(UreftypervXclassrwhXhYXcircuits.core.values.ValuerxU refdomainryXpyrzh<]r{h:]r|U refexplicitr}h6]r~h8]rh?]rhchdhehhfjauhAKh&]rhh)r}r(h+jth4}r(h6]rh8]r(hnjzXpy-classreh:]rh<]rh?]ruh,jrh&]rhtXcircuits.core.values.Valuerr}r(h+Uh,jubah2hxubaubhtXN object that holds the results returned by the handlers invoked for the event.rr}r(h+XN object that holds the results returned by the handlers invoked for the event.rh,jHubeh2hubah2j>ubj)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rh)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]r(hP)r}r(h+Uh4}r(UreftyperjU reftargetrXsuccessrU refdomainrhh<]rh:]rU refexplicitrh6]rh8]rh?]ruh,jh&]rj)r}r(h+jh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtXsuccessrr}r(h+Uh,jubah2j ubah2hTubhtX -- rr}r(h+Uh,jubhtX%if this optional attribute is set to rr}r(h+X%if this optional attribute is set to rh,jubhh)r}r(h+X``True``rh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtXTruerr}r(h+Uh,jubah2hxubhtX, an associated event rr}r(h+X, an associated event rh,jubhh)r}r(h+X``EventSuccess``rh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtX EventSuccessrr}r(h+Uh,jubah2hxubhtX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(h+X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh,jubeh2hubah2j>ubj)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rh)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]r(hP)r}r(h+Uh4}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrhh<]rh:]rU refexplicitrh6]rh8]rh?]ruh,jh&]rj)r}r (h+jh4}r (h6]r h8]r h:]r h<]rh?]ruh,jh&]rhtXsuccess_channelsrr}r(h+Uh,jubah2j ubah2hTubhtX -- rr}r(h+Uh,jubhtXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h+Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh,jubeh2hubah2j>ubj)r}r(h+Uh4}r(h6]rh8]rh:]r h<]r!h?]r"uh,jh&]r#h)r$}r%(h+Uh4}r&(h6]r'h8]r(h:]r)h<]r*h?]r+uh,jh&]r,(hP)r-}r.(h+Uh4}r/(Ureftyper0jU reftargetr1Xcompleter2U refdomainr3hh<]r4h:]r5U refexplicitr6h6]r7h8]r8h?]r9uh,j$h&]r:j)r;}r<(h+j2h4}r=(h6]r>h8]r?h:]r@h<]rAh?]rBuh,j-h&]rChtXcompleterDrE}rF(h+Uh,j;ubah2j ubah2hTubhtX -- rGrH}rI(h+Uh,j$ubhtX%if this optional attribute is set to rJrK}rL(h+X%if this optional attribute is set to rMh,j$ubhh)rN}rO(h+X``True``rPh4}rQ(h6]rRh8]rSh:]rTh<]rUh?]rVuh,j$h&]rWhtXTruerXrY}rZ(h+Uh,jNubah2hxubhtX, an associated event r[r\}r](h+X, an associated event r^h,j$ubhh)r_}r`(h+X``EventComplete``rah4}rb(h6]rch8]rdh:]reh<]rfh?]rguh,j$h&]rhhtX EventCompleterirj}rk(h+Uh,j_ubah2hxubhtX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rlrm}rn(h+X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.roh,j$ubeh2hubah2j>ubj)rp}rq(h+Uh4}rr(h6]rsh8]rth:]ruh<]rvh?]rwuh,jh&]rxh)ry}rz(h+Uh4}r{(h6]r|h8]r}h:]r~h<]rh?]ruh,jph&]r(hP)r}r(h+Uh4}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrhh<]rh:]rU refexplicitrh6]rh8]rh?]ruh,jyh&]rj)r}r(h+jh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtXsuccess_channelsrr}r(h+Uh,jubah2j ubah2hTubhtX -- rr}r(h+Uh,jyubhtXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h+Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh,jyubeh2hubah2j>ubeh2U bullet_listrubah2U field_bodyrubeh2Ufieldrubaubeubeubeubh()r}r(h+Uh,h)h-h0h2h3h4}r(h6]rh8]rh:]rh<]rh#ah?]rhauhAKhBhh&]r(hD)r}r(h+X Componentsrh,jh-h0h2hHh4}r(h6]rh8]rh:]rh<]rh?]ruhAKhBhh&]rhtX Componentsrr}r(h+jh,jubaubh)r}r(h+X**none**rh,jh-h0h2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAKhBhh&]rj)r}r(h+jh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtXnonerr}r(h+Uh,jubah2j ubaubeubh()r}r(h+Uh,h)h-h0h2h3h4}r(h6]rh8]rh:]rh<]rh%ah?]rhauhAKhBhh&]r(hD)r}r(h+XEventsrh,jh-h0h2hHh4}r(h6]rh8]rh:]rh<]rh?]ruhAKhBhh&]rhtXEventsrr}r(h+jh,jubaubh})r}r(h+Uh,jh-Nh2hh4}r(h<]rh:]rh6]rh8]rh?]rUentriesr]r(hX%Error (class in circuits.core.events)hUtrauhANhBhh&]rubh)r}r(h+Uh,jh-Nh2hh4}r(hĉhXpyrh<]rh:]rh6]rh8]rh?]rhXclassrhjuhANhBhh&]r(h)r}r(h+X+Error(type, value, traceback, handler=None)rh,jh-hh2hh4}r(h<]rhahh.Xcircuits.core.eventsrr}rbh:]rh6]rh8]r h?]r hahXErrorr hUhuhANhBhh&]r (h)r }r(h+Xclass rh,jh-hh2hh4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]rhtXclass rr}r(h+Uh,j ubaubh)r}r(h+Xcircuits.core.events.rh,jh-hh2hh4}r(h6]rh8]rh:]r h<]r!h?]r"uhANhBhh&]r#htXcircuits.core.events.r$r%}r&(h+Uh,jubaubj)r'}r((h+j h,jh-hh2jh4}r)(h6]r*h8]r+h:]r,h<]r-h?]r.uhANhBhh&]r/htXErrorr0r1}r2(h+Uh,j'ubaubj)r3}r4(h+Uh,jh-hh2jh4}r5(h6]r6h8]r7h:]r8h<]r9h?]r:uhANhBhh&]r;(j)r<}r=(h+Xtyper>h4}r?(h6]r@h8]rAh:]rBh<]rCh?]rDuh,j3h&]rEhtXtyperFrG}rH(h+Uh,j<ubah2j*ubj)rI}rJ(h+XvaluerKh4}rL(h6]rMh8]rNh:]rOh<]rPh?]rQuh,j3h&]rRhtXvaluerSrT}rU(h+Uh,jIubah2j*ubj)rV}rW(h+X tracebackrXh4}rY(h6]rZh8]r[h:]r\h<]r]h?]r^uh,j3h&]r_htX tracebackr`ra}rb(h+Uh,jVubah2j*ubj)rc}rd(h+X handler=Nonereh4}rf(h6]rgh8]rhh:]rih<]rjh?]rkuh,j3h&]rlhtX handler=Nonermrn}ro(h+Uh,jcubah2j*ubeubeubj8)rp}rq(h+Uh,jh-hh2j;h4}rr(h6]rsh8]rth:]ruh<]rvh?]rwuhANhBhh&]rx(h)ry}rz(h+X*Bases: :class:`circuits.core.events.Event`r{h,jph-jFh2hh4}r|(h6]r}h8]r~h:]rh<]rh?]ruhAKhBhh&]r(htXBases: rr}r(h+XBases: rh,jyubhP)r}r(h+X#:class:`circuits.core.events.Event`rh,jyh-h0h2hTh4}r(UreftyperXclassrhXhYXcircuits.core.events.EventrU refdomainrXpyrh<]rh:]rU refexplicitrh6]rh8]rh?]rhchdhej hfjauhAKh&]rhh)r}r(h+jh4}r(h6]rh8]r(hnjXpy-classreh:]rh<]rh?]ruh,jh&]rhtXcircuits.core.events.Eventrr}r(h+Uh,jubah2hxubaubeubh)r}r(h+X Error Eventrh,jph-X\/home/prologic/work/circuits/circuits/core/events.py:docstring of circuits.core.events.Errorrh2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAKhBhh&]rhtX Error Eventrr}r(h+jh,jubaubh)r}r(h+XThis Event is sent for any exceptions that occur during the execution of an Event Handler that is not SystemExit or KeyboardInterrupt.rh,jph-jh2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAKhBhh&]rhtXThis Event is sent for any exceptions that occur during the execution of an Event Handler that is not SystemExit or KeyboardInterrupt.rr}r(h+jh,jubaubj)r}r(h+Uh,jph-Nh2jh4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]rj)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]r(j)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtX Parametersrr}r(h+Uh,jubah2jubj)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rj)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]r(j)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rh)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]r(j)r}r(h+Xtyperh4}r(h6]rh8]rh:]rh<]rh?]r uh,jh&]r htXtyper r }r (h+Uh,jubah2j ubhtX (rr}r(h+Uh,jubhP)r}r(h+Uh4}r(UreftyperjU reftargetrXtyperU refdomainrjh<]rh:]rU refexplicitrh6]rh8]rh?]ruh,jh&]rcdocutils.nodes emphasis r)r }r!(h+jh4}r"(h6]r#h8]r$h:]r%h<]r&h?]r'uh,jh&]r(htXtyper)r*}r+(h+Uh,j ubah2Uemphasisr,ubah2hTubhtX)r-}r.(h+Uh,jubhtX -- r/r0}r1(h+Uh,jubhtXtype of exceptionr2r3}r4(h+Xtype of exceptionr5h,jubeh2hubah2j>ubj)r6}r7(h+Uh4}r8(h6]r9h8]r:h:]r;h<]r<h?]r=uh,jh&]r>h)r?}r@(h+Uh4}rA(h6]rBh8]rCh:]rDh<]rEh?]rFuh,j6h&]rG(j)rH}rI(h+XvaluerJh4}rK(h6]rLh8]rMh:]rNh<]rOh?]rPuh,j?h&]rQhtXvaluerRrS}rT(h+Uh,jHubah2j ubhtX (rUrV}rW(h+Uh,j?ubhP)rX}rY(h+Uh4}rZ(Ureftyper[jU reftargetr\Xexceptions.TypeErrorr]U refdomainr^jh<]r_h:]r`U refexplicitrah6]rbh8]rch?]rduh,j?h&]rej)rf}rg(h+j]h4}rh(h6]rih8]rjh:]rkh<]rlh?]rmuh,jXh&]rnhtXexceptions.TypeErrorrorp}rq(h+Uh,jfubah2j,ubah2hTubhtX)rr}rs(h+Uh,j?ubhtX -- rtru}rv(h+Uh,j?ubhtXexception objectrwrx}ry(h+Xexception objectrzh,j?ubeh2hubah2j>ubj)r{}r|(h+Uh4}r}(h6]r~h8]rh:]rh<]rh?]ruh,jh&]rh)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,j{h&]r(j)r}r(h+X tracebackrh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtX tracebackrr}r(h+Uh,jubah2j ubhtX (rr}r(h+Uh,jubhP)r}r(h+Uh4}r(UreftyperjU reftargetrX tracebackrU refdomainrjh<]rh:]rU refexplicitrh6]rh8]rh?]ruh,jh&]rj)r}r(h+jh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtX tracebackrr}r(h+Uh,jubah2j,ubah2hTubhtX)r}r(h+Uh,jubhtX -- rr}r(h+Uh,jubhtXtraceback of exceptionrr}r(h+Xtraceback of exceptionrh,jubeh2hubah2j>ubj)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rh)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]r(j)r}r(h+Xkwargsrh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtXkwargsrr}r(h+Uh,jubah2j ubhtX (rr}r(h+Uh,jubhP)r}r(h+Uh4}r(UreftyperjU reftargetrXdictrU refdomainrjh<]rh:]rU refexplicitrh6]rh8]rh?]ruh,jh&]rj)r}r(h+jh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtXdictrr}r(h+Uh,jubah2j,ubah2hTubhtX)r}r(h+Uh,jubhtX -- rr}r(h+Uh,jubhtX!(Optional) Additional Informationrr}r(h+X!(Optional) Additional Informationrh,jubeh2hubah2j>ubeh2jubah2jubeh2jubaubeubeubh})r}r(h+Uh,jh-Nh2hh4}r(h<]rh:]r h6]r h8]r h?]r Uentriesr ]r(hX'Failure (class in circuits.core.events)hUtrauhANhBhh&]rubh)r}r(h+Uh,jh-Nh2hh4}r(hĉhXpyrh<]rh:]rh6]rh8]rh?]rhXclassrhjuhANhBhh&]r(h)r}r(h+XFailure(*args, **kwargs)rh,jh-hh2hh4}r(h<]r hahh.Xcircuits.core.eventsr!r"}r#bh:]r$h6]r%h8]r&h?]r'hahXFailurer(hUhuhANhBhh&]r)(h)r*}r+(h+Xclass r,h,jh-hh2hh4}r-(h6]r.h8]r/h:]r0h<]r1h?]r2uhANhBhh&]r3htXclass r4r5}r6(h+Uh,j*ubaubh)r7}r8(h+Xcircuits.core.events.r9h,jh-hh2hh4}r:(h6]r;h8]r<h:]r=h<]r>h?]r?uhANhBhh&]r@htXcircuits.core.events.rArB}rC(h+Uh,j7ubaubj)rD}rE(h+j(h,jh-hh2jh4}rF(h6]rGh8]rHh:]rIh<]rJh?]rKuhANhBhh&]rLhtXFailurerMrN}rO(h+Uh,jDubaubj)rP}rQ(h+Uh,jh-hh2jh4}rR(h6]rSh8]rTh:]rUh<]rVh?]rWuhANhBhh&]rX(j)rY}rZ(h+X*argsr[h4}r\(h6]r]h8]r^h:]r_h<]r`h?]rauh,jPh&]rbhtX*argsrcrd}re(h+Uh,jYubah2j*ubj)rf}rg(h+X**kwargsrhh4}ri(h6]rjh8]rkh:]rlh<]rmh?]rnuh,jPh&]rohtX**kwargsrprq}rr(h+Uh,jfubah2j*ubeubeubj8)rs}rt(h+Uh,jh-hh2j;h4}ru(h6]rvh8]rwh:]rxh<]ryh?]rzuhANhBhh&]r{(h)r|}r}(h+X1Bases: :class:`circuits.core.events.DerivedEvent`r~h,jsh-jFh2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAKhBhh&]r(htXBases: rr}r(h+XBases: rh,j|ubhP)r}r(h+X*:class:`circuits.core.events.DerivedEvent`rh,j|h-h0h2hTh4}r(UreftyperXclassrhXhYX!circuits.core.events.DerivedEventrU refdomainrXpyrh<]rh:]rU refexplicitrh6]rh8]rh?]rhchdhej(hfjauhAKh&]rhh)r}r(h+jh4}r(h6]rh8]r(hnjXpy-classreh:]rh<]rh?]ruh,jh&]rhtX!circuits.core.events.DerivedEventrr}r(h+Uh,jubah2hxubaubeubh)r}r(h+X Failure Eventrh,jsh-X^/home/prologic/work/circuits/circuits/core/events.py:docstring of circuits.core.events.Failurerh2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAKhBhh&]rhtX Failure Eventrr}r(h+jh,jubaubh)r}r(h+XVThis Event is sent when an error has occurred with the execution of an Event Handlers.rh,jsh-jh2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAKhBhh&]rhtXVThis Event is sent when an error has occurred with the execution of an Event Handlers.rr}r(h+jh,jubaubj)r}r(h+Uh,jsh-Nh2jh4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]rj)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]r(j)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtX Parametersrr}r(h+Uh,jubah2jubj)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rh)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]r(j)r}r(h+Xeventrh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtXeventrr}r(h+Uh,jubah2j ubhtX (rr}r(h+Uh,jubhP)r}r(h+Uh4}r(UreftyperjU reftargetrXEventrU refdomainrjh<]r h:]r U refexplicitr h6]r h8]r h?]ruh,jh&]rj)r}r(h+jh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtXEventrr}r(h+Uh,jubah2j,ubah2hTubhtX)r}r(h+Uh,jubhtX -- rr}r (h+Uh,jubhtXThe event that failedr!r"}r#(h+XThe event that failedr$h,jubeh2hubah2jubeh2jubaubeubeubh})r%}r&(h+Uh,jh-Nh2hh4}r'(h<]r(h:]r)h6]r*h8]r+h?]r,Uentriesr-]r.(hX*Registered (class in circuits.core.events)hUtr/auhANhBhh&]r0ubh)r1}r2(h+Uh,jh-Nh2hh4}r3(hĉhXpyr4h<]r5h:]r6h6]r7h8]r8h?]r9hXclassr:hj:uhANhBhh&]r;(h)r<}r=(h+XRegistered(component, manager)r>h,j1h-hh2hh4}r?(h<]r@hahh.Xcircuits.core.eventsrArB}rCbh:]rDh6]rEh8]rFh?]rGhahX RegisteredrHhUhuhANhBhh&]rI(h)rJ}rK(h+Xclass rLh,j<h-hh2hh4}rM(h6]rNh8]rOh:]rPh<]rQh?]rRuhANhBhh&]rShtXclass rTrU}rV(h+Uh,jJubaubh)rW}rX(h+Xcircuits.core.events.rYh,j<h-hh2hh4}rZ(h6]r[h8]r\h:]r]h<]r^h?]r_uhANhBhh&]r`htXcircuits.core.events.rarb}rc(h+Uh,jWubaubj)rd}re(h+jHh,j<h-hh2jh4}rf(h6]rgh8]rhh:]rih<]rjh?]rkuhANhBhh&]rlhtX Registeredrmrn}ro(h+Uh,jdubaubj)rp}rq(h+Uh,j<h-hh2jh4}rr(h6]rsh8]rth:]ruh<]rvh?]rwuhANhBhh&]rx(j)ry}rz(h+X componentr{h4}r|(h6]r}h8]r~h:]rh<]rh?]ruh,jph&]rhtX componentrr}r(h+Uh,jyubah2j*ubj)r}r(h+Xmanagerrh4}r(h6]rh8]rh:]rh<]rh?]ruh,jph&]rhtXmanagerrr}r(h+Uh,jubah2j*ubeubeubj8)r}r(h+Uh,j1h-hh2j;h4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]r(h)r}r(h+X*Bases: :class:`circuits.core.events.Event`rh,jh-jFh2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAKhBhh&]r(htXBases: rr}r(h+XBases: rh,jubhP)r}r(h+X#:class:`circuits.core.events.Event`rh,jh-h0h2hTh4}r(UreftyperXclassrhXhYXcircuits.core.events.EventrU refdomainrXpyrh<]rh:]rU refexplicitrh6]rh8]rh?]rhchdhejHhfjauhAKh&]rhh)r}r(h+jh4}r(h6]rh8]r(hnjXpy-classreh:]rh<]rh?]ruh,jh&]rhtXcircuits.core.events.Eventrr}r(h+Uh,jubah2hxubaubeubh)r}r(h+XRegistered Eventrh,jh-Xa/home/prologic/work/circuits/circuits/core/events.py:docstring of circuits.core.events.Registeredrh2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAKhBhh&]rhtXRegistered Eventrr}r(h+jh,jubaubh)r}r(h+XThis Event is sent when a Component has registered with another Component or Manager. This Event is only sent iif the Component or Manager being registered with is not itself.rh,jh-jh2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAKhBhh&]rhtXThis Event is sent when a Component has registered with another Component or Manager. This Event is only sent iif the Component or Manager being registered with is not itself.rr}r(h+jh,jubaubj)r}r(h+Uh,jh-Nh2jh4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]rj)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]r(j)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtX Parametersrr}r(h+Uh,jubah2jubj)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rj)r }r (h+Uh4}r (h6]r h8]r h:]rh<]rh?]ruh,jh&]r(j)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,j h&]rh)r}r(h+Uh4}r(h6]rh8]rh:]r h<]r!h?]r"uh,jh&]r#(j)r$}r%(h+X componentr&h4}r'(h6]r(h8]r)h:]r*h<]r+h?]r,uh,jh&]r-htX componentr.r/}r0(h+Uh,j$ubah2j ubhtX (r1r2}r3(h+Uh,jubhP)r4}r5(h+Uh4}r6(Ureftyper7jU reftargetr8X Componentr9U refdomainr:j4h<]r;h:]r<U refexplicitr=h6]r>h8]r?h?]r@uh,jh&]rAj)rB}rC(h+j9h4}rD(h6]rEh8]rFh:]rGh<]rHh?]rIuh,j4h&]rJhtX ComponentrKrL}rM(h+Uh,jBubah2j,ubah2hTubhtX)rN}rO(h+Uh,jubhtX -- rPrQ}rR(h+Uh,jubhtXThe Component being registeredrSrT}rU(h+XThe Component being registeredrVh,jubeh2hubah2j>ubj)rW}rX(h+Uh4}rY(h6]rZh8]r[h:]r\h<]r]h?]r^uh,j h&]r_h)r`}ra(h+Uh4}rb(h6]rch8]rdh:]reh<]rfh?]rguh,jWh&]rh(j)ri}rj(h+Xmanagerrkh4}rl(h6]rmh8]rnh:]roh<]rph?]rquh,j`h&]rrhtXmanagerrsrt}ru(h+Uh,jiubah2j ubhtX (rvrw}rx(h+Uh,j`ubhP)ry}rz(h+Uh4}r{(Ureftyper|jU reftargetr}XComponent or Managerr~U refdomainrj4h<]rh:]rU refexplicitrh6]rh8]rh?]ruh,j`h&]rj)r}r(h+j~h4}r(h6]rh8]rh:]rh<]rh?]ruh,jyh&]rhtXComponent or Managerrr}r(h+Uh,jubah2j,ubah2hTubhtX)r}r(h+Uh,j`ubhtX -- rr}r(h+Uh,j`ubhtX.The Component or Manager being registered withrr}r(h+X.The Component or Manager being registered withrh,j`ubeh2hubah2j>ubeh2jubah2jubeh2jubaubeubeubh})r}r(h+Uh,jh-Nh2hh4}r(h<]rh:]rh6]rh8]rh?]rUentriesr]r(hX&Signal (class in circuits.core.events)h UtrauhANhBhh&]rubh)r}r(h+Uh,jh-Nh2hh4}r(hĉhXpyrh<]rh:]rh6]rh8]rh?]rhXclassrhjuhANhBhh&]r(h)r}r(h+XSignal(signal, stack)rh,jh-hh2hh4}r(h<]rh ahh.Xcircuits.core.eventsrr}rbh:]rh6]rh8]rh?]rh ahXSignalrhUhuhANhBhh&]r(h)r}r(h+Xclass rh,jh-hh2hh4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]rhtXclass rr}r(h+Uh,jubaubh)r}r(h+Xcircuits.core.events.rh,jh-hh2hh4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]rhtXcircuits.core.events.rr}r(h+Uh,jubaubj)r}r(h+jh,jh-hh2jh4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]rhtXSignalrr}r(h+Uh,jubaubj)r}r(h+Uh,jh-hh2jh4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]r(j)r}r(h+Xsignalrh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtXsignalrr}r(h+Uh,jubah2j*ubj)r}r(h+Xstackrh4}r (h6]r h8]r h:]r h<]r h?]r uh,jh&]r htXstackr r }r (h+Uh,jubah2j*ubeubeubj8)r }r (h+Uh,jh-hh2j;h4}r (h6]r h8]r h:]r h<]r h?]r uhANhBhh&]r (h)r }r (h+X*Bases: :class:`circuits.core.events.Event`r h,j h-jFh2hh4}r (h6]r h8]r h:]r h<]r h?]r uhAKhBhh&]r (htXBases: r r }r (h+XBases: r h,j ubhP)r! }r" (h+X#:class:`circuits.core.events.Event`r# h,j h-h0h2hTh4}r$ (Ureftyper% Xclassr& hXhYXcircuits.core.events.Eventr' U refdomainr( Xpyr) h<]r* h:]r+ U refexplicitr, h6]r- h8]r. h?]r/ hchdhejhfjauhAKh&]r0 hh)r1 }r2 (h+j# h4}r3 (h6]r4 h8]r5 (hnj) Xpy-classr6 eh:]r7 h<]r8 h?]r9 uh,j! h&]r: htXcircuits.core.events.Eventr; r< }r= (h+Uh,j1 ubah2hxubaubeubh)r> }r? (h+X Signal Eventr@ h,j h-X]/home/prologic/work/circuits/circuits/core/events.py:docstring of circuits.core.events.SignalrA h2hh4}rB (h6]rC h8]rD h:]rE h<]rF h?]rG uhAKhBhh&]rH htX Signal EventrI rJ }rK (h+j@ h,j> ubaubh)rL }rM (h+X6This Event is sent when a Component receives a signal.rN h,j h-jA h2hh4}rO (h6]rP h8]rQ h:]rR h<]rS h?]rT uhAKhBhh&]rU htX6This Event is sent when a Component receives a signal.rV rW }rX (h+jN h,jL ubaubj)rY }rZ (h+Uh,j h-Nh2jh4}r[ (h6]r\ h8]r] h:]r^ h<]r_ h?]r` uhANhBhh&]ra j)rb }rc (h+Uh4}rd (h6]re h8]rf h:]rg h<]rh h?]ri uh,jY h&]rj (j)rk }rl (h+Uh4}rm (h6]rn h8]ro h:]rp h<]rq h?]rr uh,jb h&]rs htX Parametersrt ru }rv (h+Uh,jk ubah2jubj)rw }rx (h+Uh4}ry (h6]rz h8]r{ h:]r| h<]r} h?]r~ uh,jb h&]r j)r }r (h+Uh4}r (h6]r h8]r h:]r h<]r h?]r uh,jw h&]r (j)r }r (h+Uh4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r h)r }r (h+Uh4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r (j)r }r (h+Xsignalr h4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r htXsignalr r }r (h+Uh,j ubah2j ubhtX -- r r }r (h+Uh,j ubhtXThe signal number received.r r }r (h+XThe signal number received.r h,j ubeh2hubah2j>ubj)r }r (h+Uh4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r h)r }r (h+Uh4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r (j)r }r (h+Xstackr h4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r htXstackr r }r (h+Uh,j ubah2j ubhtX -- r r }r (h+Uh,j ubhtXThe interrupted stack frame.r r }r (h+XThe interrupted stack frame.r h,j ubeh2hubah2j>ubeh2jubah2jubeh2jubaubeubeubh})r }r (h+Uh,jh-Nh2hh4}r (h<]r h:]r h6]r h8]r h?]r Uentriesr ]r (hX'Started (class in circuits.core.events)hUtr auhANhBhh&]r ubh)r }r (h+Uh,jh-Nh2hh4}r (hĉhXpyr h<]r h:]r h6]r h8]r h?]r hXclassr hj uhANhBhh&]r (h)r }r (h+XStarted(component)r h,j h-hh2hh4}r (h<]r hahh.Xcircuits.core.eventsr r }r bh:]r h6]r h8]r h?]r hahXStartedr hUhuhANhBhh&]r (h)r }r (h+Xclass r h,j h-hh2hh4}r (h6]r h8]r h:]r h<]r h?]r uhANhBhh&]r htXclass r r }r (h+Uh,j ubaubh)r }r (h+Xcircuits.core.events.r h,j h-hh2hh4}r (h6]r h8]r h:]r h<]r h?]r uhANhBhh&]r htXcircuits.core.events.r r }r (h+Uh,j ubaubj)r }r (h+j h,j h-hh2jh4}r (h6]r h8]r h:]r h<]r h?]r uhANhBhh&]r htXStartedr r }r (h+Uh,j ubaubj)r }r! (h+Uh,j h-hh2jh4}r" (h6]r# h8]r$ h:]r% h<]r& h?]r' uhANhBhh&]r( j)r) }r* (h+X componentr+ h4}r, (h6]r- h8]r. h:]r/ h<]r0 h?]r1 uh,j h&]r2 htX componentr3 r4 }r5 (h+Uh,j) ubah2j*ubaubeubj8)r6 }r7 (h+Uh,j h-hh2j;h4}r8 (h6]r9 h8]r: h:]r; h<]r< h?]r= uhANhBhh&]r> (h)r? }r@ (h+X*Bases: :class:`circuits.core.events.Event`rA h,j6 h-jFh2hh4}rB (h6]rC h8]rD h:]rE h<]rF h?]rG uhAKhBhh&]rH (htXBases: rI rJ }rK (h+XBases: rL h,j? ubhP)rM }rN (h+X#:class:`circuits.core.events.Event`rO h,j? h-h0h2hTh4}rP (UreftyperQ XclassrR hXhYXcircuits.core.events.EventrS U refdomainrT XpyrU h<]rV h:]rW U refexplicitrX h6]rY h8]rZ h?]r[ hchdhej hfjauhAKh&]r\ hh)r] }r^ (h+jO h4}r_ (h6]r` h8]ra (hnjU Xpy-classrb eh:]rc h<]rd h?]re uh,jM h&]rf htXcircuits.core.events.Eventrg rh }ri (h+Uh,j] ubah2hxubaubeubh)rj }rk (h+X Started Eventrl h,j6 h-X^/home/prologic/work/circuits/circuits/core/events.py:docstring of circuits.core.events.Startedrm h2hh4}rn (h6]ro h8]rp h:]rq h<]rr h?]rs uhAKhBhh&]rt htX Started Eventru rv }rw (h+jl h,jj ubaubh)rx }ry (h+X8This Event is sent when a Component has started running.rz h,j6 h-jm h2hh4}r{ (h6]r| h8]r} h:]r~ h<]r h?]r uhAKhBhh&]r htX8This Event is sent when a Component has started running.r r }r (h+jz h,jx ubaubj)r }r (h+Uh,j6 h-Nh2jh4}r (h6]r h8]r h:]r h<]r h?]r uhANhBhh&]r j)r }r (h+Uh4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r (j)r }r (h+Uh4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r htX Parametersr r }r (h+Uh,j ubah2jubj)r }r (h+Uh4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r h)r }r (h+Uh4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r (j)r }r (h+X componentr h4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r htX componentr r }r (h+Uh,j ubah2j ubhtX (r r }r (h+Uh,j ubhP)r }r (h+Uh4}r (Ureftyper jU reftargetr XComponent or Managerr U refdomainr j h<]r h:]r U refexplicitr h6]r h8]r h?]r uh,j h&]r j)r }r (h+j h4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r htXComponent or Managerr r }r (h+Uh,j ubah2j,ubah2hTubhtX)r }r (h+Uh,j ubhtX -- r r }r (h+Uh,j ubhtXThe component that was startedr r }r (h+XThe component that was startedr h,j ubeh2hubah2jubeh2jubaubeubeubh})r }r (h+Uh,jh-Nh2hh4}r (h<]r h:]r h6]r h8]r h?]r Uentriesr ]r (hX'Stopped (class in circuits.core.events)hUtr auhANhBhh&]r ubh)r }r (h+Uh,jh-Nh2hh4}r (hĉhXpyr h<]r h:]r h6]r h8]r h?]r hXclassr hj uhANhBhh&]r (h)r }r (h+XStopped(component)r h,j h-hh2hh4}r (h<]r hahh.Xcircuits.core.eventsr r }r bh:]r h6]r h8]r h?]r hahXStoppedr hUhuhANhBhh&]r (h)r }r (h+Xclass r h,j h-hh2hh4}r (h6]r h8]r h:]r h<]r h?]r uhANhBhh&]r htXclass r r }r (h+Uh,j ubaubh)r }r (h+Xcircuits.core.events.r h,j h-hh2hh4}r (h6]r h8]r h:]r h<]r! h?]r" uhANhBhh&]r# htXcircuits.core.events.r$ r% }r& (h+Uh,j ubaubj)r' }r( (h+j h,j h-hh2jh4}r) (h6]r* h8]r+ h:]r, h<]r- h?]r. uhANhBhh&]r/ htXStoppedr0 r1 }r2 (h+Uh,j' ubaubj)r3 }r4 (h+Uh,j h-hh2jh4}r5 (h6]r6 h8]r7 h:]r8 h<]r9 h?]r: uhANhBhh&]r; j)r< }r= (h+X componentr> h4}r? (h6]r@ h8]rA h:]rB h<]rC h?]rD uh,j3 h&]rE htX componentrF rG }rH (h+Uh,j< ubah2j*ubaubeubj8)rI }rJ (h+Uh,j h-hh2j;h4}rK (h6]rL h8]rM h:]rN h<]rO h?]rP uhANhBhh&]rQ (h)rR }rS (h+X*Bases: :class:`circuits.core.events.Event`rT h,jI h-jFh2hh4}rU (h6]rV h8]rW h:]rX h<]rY h?]rZ uhAKhBhh&]r[ (htXBases: r\ r] }r^ (h+XBases: r_ h,jR ubhP)r` }ra (h+X#:class:`circuits.core.events.Event`rb h,jR h-h0h2hTh4}rc (Ureftyperd Xclassre hXhYXcircuits.core.events.Eventrf U refdomainrg Xpyrh h<]ri h:]rj U refexplicitrk h6]rl h8]rm h?]rn hchdhej hfjauhAKh&]ro hh)rp }rq (h+jb h4}rr (h6]rs h8]rt (hnjh Xpy-classru eh:]rv h<]rw h?]rx uh,j` h&]ry htXcircuits.core.events.Eventrz r{ }r| (h+Uh,jp ubah2hxubaubeubh)r} }r~ (h+X Stopped Eventr h,jI h-X^/home/prologic/work/circuits/circuits/core/events.py:docstring of circuits.core.events.Stoppedr h2hh4}r (h6]r h8]r h:]r h<]r h?]r uhAKhBhh&]r htX Stopped Eventr r }r (h+j h,j} ubaubh)r }r (h+X8This Event is sent when a Component has stopped running.r h,jI h-j h2hh4}r (h6]r h8]r h:]r h<]r h?]r uhAKhBhh&]r htX8This Event is sent when a Component has stopped running.r r }r (h+j h,j ubaubj)r }r (h+Uh,jI h-Nh2jh4}r (h6]r h8]r h:]r h<]r h?]r uhANhBhh&]r j)r }r (h+Uh4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r (j)r }r (h+Uh4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r htX Parametersr r }r (h+Uh,j ubah2jubj)r }r (h+Uh4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r h)r }r (h+Uh4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r (j)r }r (h+X componentr h4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r htX componentr r }r (h+Uh,j ubah2j ubhtX (r r }r (h+Uh,j ubhP)r }r (h+Uh4}r (Ureftyper jU reftargetr XComponent or Managerr U refdomainr j h<]r h:]r U refexplicitr h6]r h8]r h?]r uh,j h&]r j)r }r (h+j h4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r htXComponent or Managerr r }r (h+Uh,j ubah2j,ubah2hTubhtX)r }r (h+Uh,j ubhtX -- r r }r (h+Uh,j ubhtXThe component that has stoppedr r }r (h+XThe component that has stoppedr h,j ubeh2hubah2jubeh2jubaubeubeubh})r }r (h+Uh,jh-Nh2hh4}r (h<]r h:]r h6]r h8]r h?]r Uentriesr ]r (hX'Success (class in circuits.core.events)hUtr auhANhBhh&]r ubh)r }r (h+Uh,jh-Nh2hh4}r (hĉhXpyr h<]r h:]r h6]r h8]r h?]r hXclassr hj uhANhBhh&]r (h)r }r (h+XSuccess(*args, **kwargs)r h,j h-hh2hh4}r (h<]r hahh.Xcircuits.core.eventsr r }r bh:]r h6]r h8]r h?]r hahXSuccessr hUhuhANhBhh&]r (h)r }r! (h+Xclass r" h,j h-hh2hh4}r# (h6]r$ h8]r% h:]r& h<]r' h?]r( uhANhBhh&]r) htXclass r* r+ }r, (h+Uh,j ubaubh)r- }r. (h+Xcircuits.core.events.r/ h,j h-hh2hh4}r0 (h6]r1 h8]r2 h:]r3 h<]r4 h?]r5 uhANhBhh&]r6 htXcircuits.core.events.r7 r8 }r9 (h+Uh,j- ubaubj)r: }r; (h+j h,j h-hh2jh4}r< (h6]r= h8]r> h:]r? h<]r@ h?]rA uhANhBhh&]rB htXSuccessrC rD }rE (h+Uh,j: ubaubj)rF }rG (h+Uh,j h-hh2jh4}rH (h6]rI h8]rJ h:]rK h<]rL h?]rM uhANhBhh&]rN (j)rO }rP (h+X*argsrQ h4}rR (h6]rS h8]rT h:]rU h<]rV h?]rW uh,jF h&]rX htX*argsrY rZ }r[ (h+Uh,jO ubah2j*ubj)r\ }r] (h+X**kwargsr^ h4}r_ (h6]r` h8]ra h:]rb h<]rc h?]rd uh,jF h&]re htX**kwargsrf rg }rh (h+Uh,j\ ubah2j*ubeubeubj8)ri }rj (h+Uh,j h-hh2j;h4}rk (h6]rl h8]rm h:]rn h<]ro h?]rp uhANhBhh&]rq (h)rr }rs (h+X1Bases: :class:`circuits.core.events.DerivedEvent`rt h,ji h-jFh2hh4}ru (h6]rv h8]rw h:]rx h<]ry h?]rz uhAKhBhh&]r{ (htXBases: r| r} }r~ (h+XBases: r h,jr ubhP)r }r (h+X*:class:`circuits.core.events.DerivedEvent`r h,jr h-h0h2hTh4}r (Ureftyper Xclassr hXhYX!circuits.core.events.DerivedEventr U refdomainr Xpyr h<]r h:]r U refexplicitr h6]r h8]r h?]r hchdhej hfjauhAKh&]r hh)r }r (h+j h4}r (h6]r h8]r (hnj Xpy-classr eh:]r h<]r h?]r uh,j h&]r htX!circuits.core.events.DerivedEventr r }r (h+Uh,j ubah2hxubaubeubh)r }r (h+X Success Eventr h,ji h-X^/home/prologic/work/circuits/circuits/core/events.py:docstring of circuits.core.events.Successr h2hh4}r (h6]r h8]r h:]r h<]r h?]r uhAKhBhh&]r htX Success Eventr r }r (h+j h,j ubaubh)r }r (h+X~This Event is sent when all handlers (for a particular event) have been executed successfully, see :class:`~.manager.Manager`.r h,ji h-j h2hh4}r (h6]r h8]r h:]r h<]r h?]r uhAKhBhh&]r (htXcThis Event is sent when all handlers (for a particular event) have been executed successfully, see r r }r (h+XcThis Event is sent when all handlers (for a particular event) have been executed successfully, see r h,j ubhP)r }r (h+X:class:`~.manager.Manager`r h,j h-h0h2hTh4}r (Ureftyper Xclassr U refspecificr hXhYXmanager.Managerr U refdomainr Xpyr h<]r h:]r U refexplicitr h6]r h8]r h?]r hchdhej hfjauhAK h&]r hh)r }r (h+j h4}r (h6]r h8]r (hnj Xpy-classr eh:]r h<]r h?]r uh,j h&]r htXManagerr r }r (h+Uh,j ubah2hxubaubhtX.r }r (h+X.h,j ubeubj)r }r (h+Uh,ji h-Nh2jh4}r (h6]r h8]r h:]r h<]r h?]r uhANhBhh&]r j)r }r (h+Uh4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r (j)r }r (h+Uh4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r htX Parametersr r }r (h+Uh,j ubah2jubj)r }r (h+Uh4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r h)r }r (h+Uh4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r (j)r }r (h+Xeventr h4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r htXeventr r }r (h+Uh,j ubah2j ubhtX (r r }r (h+Uh,j ubhP)r }r (h+Uh4}r (Ureftyper jU reftargetr XEventr U refdomainr j h<]r h:]r! U refexplicitr" h6]r# h8]r$ h?]r% uh,j h&]r& j)r' }r( (h+j h4}r) (h6]r* h8]r+ h:]r, h<]r- h?]r. uh,j h&]r/ htXEventr0 r1 }r2 (h+Uh,j' ubah2j,ubah2hTubhtX)r3 }r4 (h+Uh,j ubhtX -- r5 r6 }r7 (h+Uh,j ubhtXThe event that has completed.r8 r9 }r: (h+XThe event that has completed.r; h,j ubeh2hubah2jubeh2jubaubeubeubh})r< }r= (h+Uh,jh-Xa/home/prologic/work/circuits/circuits/core/events.py:docstring of circuits.core.events.Unregisterr> h2hh4}r? (h<]r@ h:]rA h6]rB h8]rC h?]rD UentriesrE ]rF (hX*Unregister (class in circuits.core.events)hUtrG auhANhBhh&]rH ubh)rI }rJ (h+Uh,jh-j> h2hh4}rK (hĉhXpyrL h<]rM h:]rN h6]rO h8]rP h?]rQ hXclassrR hjR uhANhBhh&]rS (h)rT }rU (h+XUnregister(component=None)rV h,jI h-hh2hh4}rW (h<]rX hahh.Xcircuits.core.eventsrY rZ }r[ bh:]r\ h6]r] h8]r^ h?]r_ hahX Unregisterr` hUhuhANhBhh&]ra (h)rb }rc (h+Xclass rd h,jT h-hh2hh4}re (h6]rf h8]rg h:]rh h<]ri h?]rj uhANhBhh&]rk htXclass rl rm }rn (h+Uh,jb ubaubh)ro }rp (h+Xcircuits.core.events.rq h,jT h-hh2hh4}rr (h6]rs h8]rt h:]ru h<]rv h?]rw uhANhBhh&]rx htXcircuits.core.events.ry rz }r{ (h+Uh,jo ubaubj)r| }r} (h+j` h,jT h-hh2jh4}r~ (h6]r h8]r h:]r h<]r h?]r uhANhBhh&]r htX Unregisterr r }r (h+Uh,j| ubaubj)r }r (h+Uh,jT h-hh2jh4}r (h6]r h8]r h:]r h<]r h?]r uhANhBhh&]r j)r }r (h+Xcomponent=Noner h4}r (h6]r h8]r h:]r h<]r h?]r uh,j h&]r htXcomponent=Noner r }r (h+Uh,j ubah2j*ubaubeubj8)r }r (h+Uh,jI h-hh2j;h4}r (h6]r h8]r h:]r h<]r h?]r uhANhBhh&]r (h)r }r (h+X*Bases: :class:`circuits.core.events.Event`r h,j h-jFh2hh4}r (h6]r h8]r h:]r h<]r h?]r uhAKhBhh&]r (htXBases: r r }r (h+XBases: r h,j ubhP)r }r (h+X#:class:`circuits.core.events.Event`r h,j h-h0h2hTh4}r (Ureftyper Xclassr hXhYXcircuits.core.events.Eventr U refdomainr Xpyr h<]r h:]r U refexplicitr h6]r h8]r h?]r hchdhej` hfjauhAKh&]r hh)r }r (h+j h4}r (h6]r h8]r (hnj Xpy-classr eh:]r h<]r h?]r uh,j h&]r htXcircuits.core.events.Eventr r }r (h+Uh,j ubah2hxubaubeubh)r }r (h+XUnregister Eventr h,j h-j> h2hh4}r (h6]r h8]r h:]r h<]r h?]r uhAKhBhh&]r htXUnregister Eventr r }r (h+j h,j ubaubh)r }r (h+XKThis Event ask for a Component to unregister from its Component or Manager.r h,j h-j> h2hh4}r (h6]r h8]r h:]r h<]r h?]r uhAKhBhh&]r htXKThis Event ask for a Component to unregister from its Component or Manager.r r }r (h+j h,j ubaubeubeubh})r }r (h+Uh,jh-Xc/home/prologic/work/circuits/circuits/core/events.py:docstring of circuits.core.events.Unregisteredr h2hh4}r (h<]r h:]r h6]r h8]r h?]r Uentriesr ]r (hX,Unregistered (class in circuits.core.events)h Utr auhANhBhh&]r ubh)r }r (h+Uh,jh-j h2hh4}r (hĉhXpyr h<]r h:]r h6]r h8]rh?]rhXclassrhjuhANhBhh&]r(h)r}r(h+X Unregistered(component, manager)rh,j h-hh2hh4}r(h<]rh ahh.Xcircuits.core.eventsr r }r bh:]r h6]r h8]rh?]rh ahX UnregisteredrhUhuhANhBhh&]r(h)r}r(h+Xclass rh,jh-hh2hh4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]rhtXclass rr}r(h+Uh,jubaubh)r}r (h+Xcircuits.core.events.r!h,jh-hh2hh4}r"(h6]r#h8]r$h:]r%h<]r&h?]r'uhANhBhh&]r(htXcircuits.core.events.r)r*}r+(h+Uh,jubaubj)r,}r-(h+jh,jh-hh2jh4}r.(h6]r/h8]r0h:]r1h<]r2h?]r3uhANhBhh&]r4htX Unregisteredr5r6}r7(h+Uh,j,ubaubj)r8}r9(h+Uh,jh-hh2jh4}r:(h6]r;h8]r<h:]r=h<]r>h?]r?uhANhBhh&]r@(j)rA}rB(h+X componentrCh4}rD(h6]rEh8]rFh:]rGh<]rHh?]rIuh,j8h&]rJhtX componentrKrL}rM(h+Uh,jAubah2j*ubj)rN}rO(h+XmanagerrPh4}rQ(h6]rRh8]rSh:]rTh<]rUh?]rVuh,j8h&]rWhtXmanagerrXrY}rZ(h+Uh,jNubah2j*ubeubeubj8)r[}r\(h+Uh,j h-hh2j;h4}r](h6]r^h8]r_h:]r`h<]rah?]rbuhANhBhh&]rc(h)rd}re(h+X*Bases: :class:`circuits.core.events.Event`rfh,j[h-jFh2hh4}rg(h6]rhh8]rih:]rjh<]rkh?]rluhAKhBhh&]rm(htXBases: rnro}rp(h+XBases: rqh,jdubhP)rr}rs(h+X#:class:`circuits.core.events.Event`rth,jdh-h0h2hTh4}ru(UreftypervXclassrwhXhYXcircuits.core.events.EventrxU refdomainryXpyrzh<]r{h:]r|U refexplicitr}h6]r~h8]rh?]rhchdhejhfjauhAKh&]rhh)r}r(h+jth4}r(h6]rh8]r(hnjzXpy-classreh:]rh<]rh?]ruh,jrh&]rhtXcircuits.core.events.Eventrr}r(h+Uh,jubah2hxubaubeubh)r}r(h+XUnregistered Eventrh,j[h-j h2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAKhBhh&]rhtXUnregistered Eventrr}r(h+jh,jubaubh)r}r(h+XXThis Event is sent when a Component has been unregistered from its Component or Manager.rh,j[h-j h2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAKhBhh&]rhtXXThis Event is sent when a Component has been unregistered from its Component or Manager.rr}r(h+jh,jubaubeubeubh})r}r(h+Uh,jh-Nh2hh4}r(h<]rh:]rh6]rh8]rh?]rUentriesr]r(hX.GenerateEvents (class in circuits.core.events)hUtrauhANhBhh&]rubh)r}r(h+Uh,jh-Nh2hh4}r(hĉhXpyrh<]rh:]rh6]rh8]rh?]rhXclassrhjuhANhBhh&]r(h)r}r(h+XGenerateEvents(lock, max_wait)rh,jh-hh2hh4}r(h<]rhahh.Xcircuits.core.eventsrr}rbh:]rh6]rh8]rh?]rhahXGenerateEventsrhUhuhANhBhh&]r(h)r}r(h+Xclass rh,jh-hh2hh4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]rhtXclass rr}r(h+Uh,jubaubh)r}r(h+Xcircuits.core.events.rh,jh-hh2hh4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]rhtXcircuits.core.events.rr}r(h+Uh,jubaubj)r}r(h+jh,jh-hh2jh4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]rhtXGenerateEventsrr}r(h+Uh,jubaubj)r}r(h+Uh,jh-hh2jh4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]r(j)r}r(h+Xlockrh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtXlockrr}r (h+Uh,jubah2j*ubj)r }r (h+Xmax_waitr h4}r (h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtXmax_waitrr}r(h+Uh,j ubah2j*ubeubeubj8)r}r(h+Uh,jh-hh2j;h4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]r(h)r }r!(h+X*Bases: :class:`circuits.core.events.Event`r"h,jh-jFh2hh4}r#(h6]r$h8]r%h:]r&h<]r'h?]r(uhAKhBhh&]r)(htXBases: r*r+}r,(h+XBases: r-h,j ubhP)r.}r/(h+X#:class:`circuits.core.events.Event`r0h,j h-h0h2hTh4}r1(Ureftyper2Xclassr3hXhYXcircuits.core.events.Eventr4U refdomainr5Xpyr6h<]r7h:]r8U refexplicitr9h6]r:h8]r;h?]r<hchdhejhfjauhAKh&]r=hh)r>}r?(h+j0h4}r@(h6]rAh8]rB(hnj6Xpy-classrCeh:]rDh<]rEh?]rFuh,j.h&]rGhtXcircuits.core.events.EventrHrI}rJ(h+Uh,j>ubah2hxubaubeubh)rK}rL(h+XGenerate events eventrMh,jh-Xe/home/prologic/work/circuits/circuits/core/events.py:docstring of circuits.core.events.GenerateEventsrNh2hh4}rO(h6]rPh8]rQh:]rRh<]rSh?]rTuhAKhBhh&]rUhtXGenerate events eventrVrW}rX(h+jMh,jKubaubh)rY}rZ(h+XwThis event is sent by the circuits core. All components that generate timed events or events from external sources (e.g. data becoming available) should fire any pending events in their "generate_events" handler. The handler must either be a filter (preventing other handler from being called in the same iteration) or must invoke :meth:`~.reduce_time_left` with parameter 0.r[h,jh-jNh2hh4}r\(h6]r]h8]r^h:]r_h<]r`h?]rauhAKhBhh&]rb(htXKThis event is sent by the circuits core. All components that generate timed events or events from external sources (e.g. data becoming available) should fire any pending events in their "generate_events" handler. The handler must either be a filter (preventing other handler from being called in the same iteration) or must invoke rcrd}re(h+XKThis event is sent by the circuits core. All components that generate timed events or events from external sources (e.g. data becoming available) should fire any pending events in their "generate_events" handler. The handler must either be a filter (preventing other handler from being called in the same iteration) or must invoke rfh,jYubhP)rg}rh(h+X:meth:`~.reduce_time_left`rih,jYh-h0h2hTh4}rj(UreftyperkXmethrlj hXhYXreduce_time_leftrmU refdomainrnXpyroh<]rph:]rqU refexplicitrrh6]rsh8]rth?]ruhchdhejhfjauhAK h&]rvhh)rw}rx(h+jih4}ry(h6]rzh8]r{(hnjoXpy-methr|eh:]r}h<]r~h?]ruh,jgh&]rhtXreduce_time_left()rr}r(h+Uh,jwubah2hxubaubhtX with parameter 0.rr}r(h+X with parameter 0.rh,jYubeubj)r}r(h+Uh,jh-Nh2jh4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]rj)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]r(j)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtX Parametersrr}r(h+Uh,jubah2jubj)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rh)r}r(h+Uh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]r(j)r}r(h+Xmax_waitrh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtXmax_waitrr}r(h+Uh,jubah2j ubhtX -- rr}r(h+Uh,jubhtX-maximum time available for generating events.rr}r(h+X-maximum time available for generating events.rh,jubeh2hubah2jubeh2jubaubh)r}r(h+XComponents that actually consume time waiting for events to be generated, thus suspending normal execution, must provide a method ``resume`` that interrupts waiting for events.rh,jh-jNh2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAK hBhh&]r(htXComponents that actually consume time waiting for events to be generated, thus suspending normal execution, must provide a method rr}r(h+XComponents that actually consume time waiting for events to be generated, thus suspending normal execution, must provide a method rh,jubhh)r}r(h+X ``resume``rh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtXresumerr}r(h+Uh,jubah2hxubhtX$ that interrupts waiting for events.rr}r(h+X$ that interrupts waiting for events.rh,jubeubh})r}r(h+Uh,jh-Xo/home/prologic/work/circuits/circuits/core/events.py:docstring of circuits.core.events.GenerateEvents.time_leftrh2hh4}r(h<]rh:]rh6]rh8]rh?]rUentriesr]r(hX9time_left (circuits.core.events.GenerateEvents attribute)h UtrauhANhBhh&]rubh)r}r(h+Uh,jh-jh2hh4}r(hĉhXpyrh<]rh:]rh6]rh8]rh?]rhX attributerhjuhANhBhh&]r(h)r}r(h+XGenerateEvents.time_leftrh,jh-hh2hh4}r(h<]rh ahh.Xcircuits.core.eventsrr }r bh:]r h6]r h8]r h?]rh ahXGenerateEvents.time_leftrhjhuhANhBhh&]rj)r}r(h+X time_leftrh,jh-hh2jh4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]rhtX time_leftrr}r(h+Uh,jubaubaubj8)r}r(h+Uh,jh-hh2j;h4}r (h6]r!h8]r"h:]r#h<]r$h?]r%uhANhBhh&]r&h)r'}r((h+XThe time left for generating events. A value less than 0 indicates unlimited time. You should have only one component in your system (usually a poller component) that spends up to "time left" until it generates an event.r)h,jh-jh2hh4}r*(h6]r+h8]r,h:]r-h<]r.h?]r/uhAKhBhh&]r0htXThe time left for generating events. A value less than 0 indicates unlimited time. You should have only one component in your system (usually a poller component) that spends up to "time left" until it generates an event.r1r2}r3(h+j)h,j'ubaubaubeubh})r4}r5(h+Uh,jh-Xv/home/prologic/work/circuits/circuits/core/events.py:docstring of circuits.core.events.GenerateEvents.reduce_time_leftr6h2hh4}r7(h<]r8h:]r9h6]r:h8]r;h?]r<Uentriesr=]r>(hX?reduce_time_left() (circuits.core.events.GenerateEvents method)h Utr?auhANhBhh&]r@ubh)rA}rB(h+Uh,jh-j6h2hh4}rC(hĉhXpyrDh<]rEh:]rFh6]rGh8]rHh?]rIhXmethodrJhjJuhANhBhh&]rK(h)rL}rM(h+X*GenerateEvents.reduce_time_left(time_left)rNh,jAh-hh2hh4}rO(h<]rPh ahh.Xcircuits.core.eventsrQrR}rSbh:]rTh6]rUh8]rVh?]rWh ahXGenerateEvents.reduce_time_leftrXhjhuhANhBhh&]rY(j)rZ}r[(h+Xreduce_time_leftr\h,jLh-hh2jh4}r](h6]r^h8]r_h:]r`h<]rah?]rbuhANhBhh&]rchtXreduce_time_leftrdre}rf(h+Uh,jZubaubj)rg}rh(h+Uh,jLh-hh2jh4}ri(h6]rjh8]rkh:]rlh<]rmh?]rnuhANhBhh&]roj)rp}rq(h+X time_leftrrh4}rs(h6]rth8]ruh:]rvh<]rwh?]rxuh,jgh&]ryhtX time_leftrzr{}r|(h+Uh,jpubah2j*ubaubeubj8)r}}r~(h+Uh,jAh-hh2j;h4}r(h6]rh8]rh:]rh<]rh?]ruhANhBhh&]r(h)r}r(h+X7Update the time left for generating events. This is typically used by event generators that currently don't want to generate an event but know that they will within a certain time. By reducing the time left, they make sure that they are reinvoked when the time for generating the event has come (at the latest).rh,j}h-j6h2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAKhBhh&]rhtX7Update the time left for generating events. This is typically used by event generators that currently don't want to generate an event but know that they will within a certain time. By reducing the time left, they make sure that they are reinvoked when the time for generating the event has come (at the latest).rr}r(h+jh,jubaubh)r}r(h+XThis method can only be used to reduce the time left. If the parameter is larger than the current value of time left, it is ignored.rh,j}h-j6h2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAKhBhh&]rhtXThis method can only be used to reduce the time left. If the parameter is larger than the current value of time left, it is ignored.rr}r(h+jh,jubaubh)r}r(h+XtIf the time left is reduced to 0 and the event is currently being handled, the handler's *resume* method is invoked.rh,j}h-j6h2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAK hBhh&]r(htXYIf the time left is reduced to 0 and the event is currently being handled, the handler's rr}r(h+XYIf the time left is reduced to 0 and the event is currently being handled, the handler's rh,jubj)r}r(h+X*resume*rh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtXresumerr}r(h+Uh,jubah2j,ubhtX method is invoked.rr}r(h+X method is invoked.rh,jubeubeubeubeubeubeubh()r}r(h+Uh,h)h-h0h2h3h4}r(h6]rh8]rh:]rh<]rh!ah?]rh auhAK%hBhh&]r(hD)r}r(h+X Functionsrh,jh-h0h2hHh4}r(h6]rh8]rh:]rh<]rh?]ruhAK%hBhh&]rhtX Functionsrr}r(h+jh,jubaubh)r}r(h+X**none**rh,jh-h0h2hh4}r(h6]rh8]rh:]rh<]rh?]ruhAK'hBhh&]rj)r}r(h+jh4}r(h6]rh8]rh:]rh<]rh?]ruh,jh&]rhtXnonerr}r(h+Uh,jubah2j ubaubeubeubah+UU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rhBhU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlr Uhttp://tools.ietf.org/html/r U tracebackr Upep_referencesr NUstrip_commentsr NU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNhHNUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamr NUpep_file_url_templater!Upep-%04dr"Uexit_status_levelr#KUconfigr$NUstrict_visitorr%NUcloak_email_addressesr&Utrim_footnote_reference_spacer'Uenvr(NUdump_pseudo_xmlr)NUexpose_internalsr*NUsectsubtitle_xformr+U source_linkr,NUrfc_referencesr-NUoutput_encodingr.Uutf-8r/U source_urlr0NUinput_encodingr1U utf-8-sigr2U_disable_configr3NU id_prefixr4UU tab_widthr5KUerror_encodingr6U ISO-8859-1r7U_sourcer8UE/home/prologic/work/circuits/docs/source/api/circuits_core_events.rstr9Ugettext_compactr:U generatorr;NUdump_internalsr<NU smart_quotesr=U pep_base_urlr>Uhttp://www.python.org/dev/peps/r?Usyntax_highlightr@UlongrAUinput_encoding_error_handlerrBjUauto_id_prefixrCUidrDUdoctitle_xformrEUstrip_elements_with_classesrFNU _config_filesrG]rHUfile_insertion_enabledrIKU raw_enabledrJKU dump_settingsrKNubUsymbol_footnote_startrLKUidsrM}rN(hjT h$h)hjh jh jhj h jLh!jh>cdocutils.nodes target rO)rP}rQ(h+Uh,h)h-hh2UtargetrRh4}rS(h6]rTh<]rUh>ah:]rVUismodrWh8]rXh?]rYuhAKhBhh&]rZubhj hj h"hhjh#jhjhhhj<h jh%juUsubstitution_namesr[}r\h2hBh4}r](h6]r^h<]r_h:]r`Usourcerah0h8]rbh?]rcuU footnotesrd]reUrefidsrf}rgub.circuits-2.1.0/docs/build/doctrees/api/circuits_core_debugger.doctree0000644000014400001440000003441212113366654025563 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNXcircuits.core.debugger.DebuggerqX"circuits.core.debugger -- debuggerqNXclassesq NX componentsq NXeventsq NuUsubstitution_defsq }q Uparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhhhUcircuits-core-debugger-debuggerqh Uclassesqh U componentsqh UeventsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentq hUsourceq!cdocutils.nodes reprunicode q"XG/home/prologic/work/circuits/docs/source/api/circuits_core_debugger.rstq#q$}q%bUtagnameq&Usectionq'U attributesq(}q)(Udupnamesq*]q+Uclassesq,]q-Ubackrefsq.]q/Uidsq0]q1(Xmodule-circuits.core.debuggerq2heUnamesq3]q4hauUlineq5KUdocumentq6hh]q7(cdocutils.nodes title q8)q9}q:(hX):mod:`circuits.core.debugger` -- Debuggerq;h hh!h$h&Utitleqh,]q?h.]q@h0]qAh3]qBuh5Kh6hh]qC(csphinx.addnodes pending_xref qD)qE}qF(hX:mod:`circuits.core.debugger`qGh h9h!h$h&U pending_xrefqHh(}qI(UreftypeqJXmodqKUrefwarnqLU reftargetqMXcircuits.core.debuggerqNU refdomainqOXpyqPh0]qQh.]qRU refexplicitqSh*]qTh,]qUh3]qVUrefdocqWUapi/circuits_core_debuggerqXUpy:classqYNU py:moduleqZNuh5Kh]q[cdocutils.nodes literal q\)q]}q^(hhGh(}q_(h*]q`h,]qa(UxrefqbhPXpy-modqceh.]qdh0]qeh3]qfuh hEh]qgcdocutils.nodes Text qhXcircuits.core.debuggerqiqj}qk(hUh h]ubah&UliteralqlubaubhhX -- Debuggerqmqn}qo(hX -- Debuggerqph h9ubeubcsphinx.addnodes index qq)qr}qs(hUh hh!U qth&Uindexquh(}qv(h0]qwh.]qxh*]qyh,]qzh3]q{Uentriesq|]q}(Usingleq~Xcircuits.core.debugger (module)Xmodule-circuits.core.debuggerUtqauh5Kh6hh]qubcdocutils.nodes paragraph q)q}q(hXDebugger component used to debug each event in a system by printing each event to sys.stderr or to a Logger Component instance.qh hh!XZ/home/prologic/work/circuits/circuits/core/debugger.py:docstring of circuits.core.debuggerqh&U paragraphqh(}q(h*]qh,]qh.]qh0]qh3]quh5Kh6hh]qhhXDebugger component used to debug each event in a system by printing each event to sys.stderr or to a Logger Component instance.qq}q(hhh hubaubh)q}q(hUh hh!h$h&h'h(}q(h*]qh,]qh.]qh0]qhah3]qh auh5Kh6hh]q(h8)q}q(hXClassesqh hh!h$h&hqh&Udesc_signatureqh(}q(h0]qhaUmoduleqh"Xcircuits.core.debuggerqq}qbh.]qh*]rh,]rh3]rhaUfullnamerXDebuggerrUclassrUUfirstruh5Nh6hh]r(csphinx.addnodes desc_annotation r)r }r (hXclass r h hh!hh&Udesc_annotationr h(}r (h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rhhXclass rr}r(hUh j ubaubcsphinx.addnodes desc_addname r)r}r(hXcircuits.core.debugger.rh hh!hh&U desc_addnamerh(}r(h*]rh,]rh.]rh0]r h3]r!uh5Nh6hh]r"hhXcircuits.core.debugger.r#r$}r%(hUh jubaubcsphinx.addnodes desc_name r&)r'}r((hjh hh!hh&U desc_namer)h(}r*(h*]r+h,]r,h.]r-h0]r.h3]r/uh5Nh6hh]r0hhXDebuggerr1r2}r3(hUh j'ubaubcsphinx.addnodes desc_parameterlist r4)r5}r6(hUh hh!hh&Udesc_parameterlistr7h(}r8(h*]r9h,]r:h.]r;h0]r<h3]r=uh5Nh6hh]r>(csphinx.addnodes desc_parameter r?)r@}rA(hX errors=TruerBh(}rC(h*]rDh,]rEh.]rFh0]rGh3]rHuh j5h]rIhhX errors=TruerJrK}rL(hUh j@ubah&Udesc_parameterrMubj?)rN}rO(hX events=TruerPh(}rQ(h*]rRh,]rSh.]rTh0]rUh3]rVuh j5h]rWhhX events=TruerXrY}rZ(hUh jNubah&jMubj?)r[}r\(hX file=Noner]h(}r^(h*]r_h,]r`h.]rah0]rbh3]rcuh j5h]rdhhX file=Nonererf}rg(hUh j[ubah&jMubj?)rh}ri(hX logger=Nonerjh(}rk(h*]rlh,]rmh.]rnh0]roh3]rpuh j5h]rqhhX logger=Nonerrrs}rt(hUh jhubah&jMubj?)ru}rv(hX prefix=Nonerwh(}rx(h*]ryh,]rzh.]r{h0]r|h3]r}uh j5h]r~hhX prefix=Nonerr}r(hUh juubah&jMubj?)r}r(hX trim=Nonerh(}r(h*]rh,]rh.]rh0]rh3]ruh j5h]rhhX trim=Nonerr}r(hUh jubah&jMubj?)r}r(hX**kwargsrh(}r(h*]rh,]rh.]rh0]rh3]ruh j5h]rhhX**kwargsrr}r(hUh jubah&jMubeubeubcsphinx.addnodes desc_content r)r}r(hUh hh!hh&U desc_contentrh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]r(h)r}r(hX6Bases: :class:`circuits.core.components.BaseComponent`rh jh!U rh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]r(hhXBases: rr}r(hXBases: rh jubhD)r}r(hX/:class:`circuits.core.components.BaseComponent`rh jh!h$h&hHh(}r(UreftyperXclassrhLhMX&circuits.core.components.BaseComponentrU refdomainrXpyrh0]rh.]rU refexplicitrh*]rh,]rh3]rhWhXhYjhZXcircuits.core.debuggerruh5Kh]rh\)r}r(hjh(}r(h*]rh,]r(hbjXpy-classreh.]rh0]rh3]ruh jh]rhhX&circuits.core.components.BaseComponentrr}r(hUh jubah&hlubaubeubh)r}r(hXCreate a new Debugger Componentrh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]rhhXCreate a new Debugger Componentrr}r(hjh jubaubh)r}r(hXCreates a new Debugger Component that filters all events in the system printing each event to sys.stderr or a Logger Component.rh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]rhhXCreates a new Debugger Component that filters all events in the system printing each event to sys.stderr or a Logger Component.rr}r(hjh jubaubcdocutils.nodes field_list r)r}r(hUh jh!hh&U field_listrh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]r(cdocutils.nodes field r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(cdocutils.nodes field_name r)r}r(hUh(}r(h*]rh,]rh.]r h0]r h3]r uh jh]r hhX Variablesr r}r(hUh jubah&U field_namerubcdocutils.nodes field_body r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rcdocutils.nodes bullet_list r)r}r(hUh(}r(h*]rh,]r h.]r!h0]r"h3]r#uh jh]r$(cdocutils.nodes list_item r%)r&}r'(hUh(}r((h*]r)h,]r*h.]r+h0]r,h3]r-uh jh]r.h)r/}r0(hUh(}r1(h*]r2h,]r3h.]r4h0]r5h3]r6uh j&h]r7(hD)r8}r9(hUh(}r:(Ureftyper;Uobjr<U reftargetr=X IgnoreEventsr>U refdomainr?hh0]r@h.]rAU refexplicitrBh*]rCh,]rDh3]rEuh j/h]rFh)rG}rH(hj>h(}rI(h*]rJh,]rKh.]rLh0]rMh3]rNuh j8h]rOhhX IgnoreEventsrPrQ}rR(hUh jGubah&hubah&hHubhhX -- rSrT}rU(hUh j/ubhhXlist of events (str) to ignorerVrW}rX(hXlist of events (str) to ignorerYh j/ubeh&hubah&U list_itemrZubj%)r[}r\(hUh(}r](h*]r^h,]r_h.]r`h0]rah3]rbuh jh]rch)rd}re(hUh(}rf(h*]rgh,]rhh.]rih0]rjh3]rkuh j[h]rl(hD)rm}rn(hUh(}ro(Ureftyperpj<U reftargetrqXIgnoreChannelsrrU refdomainrshh0]rth.]ruU refexplicitrvh*]rwh,]rxh3]ryuh jdh]rzh)r{}r|(hjrh(}r}(h*]r~h,]rh.]rh0]rh3]ruh jmh]rhhXIgnoreChannelsrr}r(hUh j{ubah&hubah&hHubhhX -- rr}r(hUh jdubhhX list of channels (str) to ignorerr}r(hX list of channels (str) to ignorerh jdubeh&hubah&jZubj%)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rh)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(Ureftyperj<U reftargetrXenabledrU refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rh)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXenabledrr}r(hUh jubah&hubah&hHubhhX -- rr}r(hUh jubhhXEnabled/Disabled flagrr}r(hXEnabled/Disabled flagrh jubeh&hubah&jZubeh&U bullet_listrubah&U field_bodyrubeh&Ufieldrubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(j)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX Parametersrr}r(hUh jubah&jubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rh)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(h)r}r(hXlogrh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXlogrr}r(hUh jubah&hubhhX -- rr}r(hUh jubhhX#Logger Component instance or None (rr}r(hX#Logger Component instance or None (rh jubcdocutils.nodes emphasis r)r}r(hX *default*rh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r hhXdefaultr r }r (hUh jubah&Uemphasisr ubhhX)r}r(hX)h jubeh&hubah&jubeh&jubeubh)r}r(hX4initializes x; see x.__class__.__doc__ for signaturerh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5K h6hh]rhhX4initializes x; see x.__class__.__doc__ for signaturerr}r(hjh jubaubeubeubeubh)r}r(hUh hh!h$h&h'h(}r(h*]r h,]r!h.]r"h0]r#hah3]r$h auh5Kh6hh]r%(h8)r&}r'(hXEventsr(h jh!h$h&h(hj5h(}r?(h*]r@h,]rAh.]rBh0]rCh3]rDuh j3h]rEhhXnonerFrG}rH(hUh j=ubah&hubaubeubh)rI}rJ(hUh hh!h$h&h'h(}rK(h*]rLh,]rMh.]rNh0]rOhah3]rPhauh5Kh6hh]rQ(h8)rR}rS(hX FunctionsrTh jIh!h$h&h]q?Uidsq@]qA(Xmodule-circuits.web.headersqBh'eUnamesqC]qDhauUlineqEKUdocumentqFhh*]qG(cdocutils.nodes title qH)qI}qJ(h/X&:mod:`circuits.web.headers` -- HeadersqKh0h-h1h4h6UtitleqLh8}qM(h:]qNh<]qOh>]qPh@]qQhC]qRuhEKhFhh*]qS(csphinx.addnodes pending_xref qT)qU}qV(h/X:mod:`circuits.web.headers`qWh0hIh1h4h6U pending_xrefqXh8}qY(UreftypeqZXmodq[Urefwarnq\U reftargetq]Xcircuits.web.headersq^U refdomainq_Xpyq`h@]qah>]qbU refexplicitqch:]qdh<]qehC]qfUrefdocqgUapi/circuits_web_headersqhUpy:classqiNU py:moduleqjNuhEKh*]qkcdocutils.nodes literal ql)qm}qn(h/hWh8}qo(h:]qph<]qq(Uxrefqrh`Xpy-modqseh>]qth@]quhC]qvuh0hUh*]qwcdocutils.nodes Text qxXcircuits.web.headersqyqz}q{(h/Uh0hmubah6Uliteralq|ubaubhxX -- Headersq}q~}q(h/X -- Headersqh0hIubeubcsphinx.addnodes index q)q}q(h/Uh0h-h1U qh6Uindexqh8}q(h@]qh>]qh:]qh<]qhC]qUentriesq]q(UsingleqXcircuits.web.headers (module)Xmodule-circuits.web.headersUtqauhEKhFhh*]qubcdocutils.nodes paragraph q)q}q(h/XHeaders Supportqh0h-h1XV/home/prologic/work/circuits/circuits/web/headers.py:docstring of circuits.web.headersqh6U paragraphqh8}q(h:]qh<]qh>]qh@]qhC]quhEKhFhh*]qhxXHeaders Supportqq}q(h/hh0hubaubh)q}q(h/X@This module implements support for parsing and handling headers.qh0h-h1hh6hh8}q(h:]qh<]qh>]qh@]qhC]quhEKhFhh*]qhxX@This module implements support for parsing and handling headers.qq}q(h/hh0hubaubh,)q}q(h/Uh0h-h1h4h6h7h8}q(h:]qh<]qh>]qh@]qh&ahC]qhauhEKhFhh*]q(hH)q}q(h/XEventsqh0hh1h4h6hLh8}q(h:]qh<]qh>]qh@]qhC]quhEKhFhh*]qhxXEventsqq}q(h/hh0hubaubh)q}q(h/X**none**qh0hh1h4h6hh8}q(h:]qh<]qh>]qh@]qhC]quhEK hFhh*]qcdocutils.nodes strong q)q}q(h/hh8}q(h:]qh<]qh>]qh@]qhC]quh0hh*]qhxXnoneq؅q}q(h/Uh0hubah6Ustrongqubaubeubh,)q}q(h/Uh0h-h1h4h6h7h8}q(h:]qh<]qh>]qh@]qh(ahC]qhauhEKhFhh*]q(hH)q}q(h/XClassesqh0hh1h4h6hLh8}q(h:]qh<]qh>]qh@]qhC]quhEKhFhh*]qhxXClassesqq}q(h/hh0hubaubh)q}q(h/Uh0hh1Nh6hh8}q(h@]qh>]qh:]qh<]qhC]qUentriesq]q(hX'Headers (class in circuits.web.headers)hUtqauhENhFhh*]qubcsphinx.addnodes desc q)q}r(h/Uh0hh1Nh6Udescrh8}r(UnoindexrUdomainrXpyrh@]rh>]rh:]rh<]r hC]r Uobjtyper Xclassr Udesctyper j uhENhFhh*]r(csphinx.addnodes desc_signature r)r}r(h/XHeaders(headers=[])rh0hh1U rh6Udesc_signaturerh8}r(h@]rhaUmodulerh2Xcircuits.web.headersrr}rbh>]rh:]rh<]rhC]rhaUfullnamerXHeadersr Uclassr!UUfirstr"uhENhFhh*]r#(csphinx.addnodes desc_annotation r$)r%}r&(h/Xclass r'h0jh1jh6Udesc_annotationr(h8}r)(h:]r*h<]r+h>]r,h@]r-hC]r.uhENhFhh*]r/hxXclass r0r1}r2(h/Uh0j%ubaubcsphinx.addnodes desc_addname r3)r4}r5(h/Xcircuits.web.headers.r6h0jh1jh6U desc_addnamer7h8}r8(h:]r9h<]r:h>]r;h@]r<hC]r=uhENhFhh*]r>hxXcircuits.web.headers.r?r@}rA(h/Uh0j4ubaubcsphinx.addnodes desc_name rB)rC}rD(h/j h0jh1jh6U desc_namerEh8}rF(h:]rGh<]rHh>]rIh@]rJhC]rKuhENhFhh*]rLhxXHeadersrMrN}rO(h/Uh0jCubaubcsphinx.addnodes desc_parameterlist rP)rQ}rR(h/Uh0jh1jh6Udesc_parameterlistrSh8}rT(h:]rUh<]rVh>]rWh@]rXhC]rYuhENhFhh*]rZ(csphinx.addnodes desc_parameter r[)r\}r](h/Xheaders=r^h8}r_(h:]r`h<]rah>]rbh@]rchC]rduh0jQh*]rehxXheaders=rfrg}rh(h/Uh0j\ubah6Udesc_parameterriubcsphinx.addnodes desc_optional rj)rk}rl(h/Uh8}rm(h:]rnh<]roh>]rph@]rqhC]rruh0jQh*]rsh6U desc_optionalrtubeubeubcsphinx.addnodes desc_content ru)rv}rw(h/Uh0hh1jh6U desc_contentrxh8}ry(h:]rzh<]r{h>]r|h@]r}hC]r~uhENhFhh*]r(h)r}r(h/XBases: :class:`dict`rh0jvh1U rh6hh8}r(h:]rh<]rh>]rh@]rhC]ruhEKhFhh*]r(hxXBases: rr}r(h/XBases: rh0jubhT)r}r(h/X :class:`dict`rh0jh1h4h6hXh8}r(UreftyperXclassrh\h]XdictrU refdomainrXpyrh@]rh>]rU refexplicitrh:]rh<]rhC]rhghhhij hjXcircuits.web.headersruhEKh*]rhl)r}r(h/jh8}r(h:]rh<]r(hrjXpy-classreh>]rh@]rhC]ruh0jh*]rhxXdictrr}r(h/Uh0jubah6h|ubaubeubh)r}r(h/X,Manage a collection of HTTP response headersrh0jvh1X^/home/prologic/work/circuits/circuits/web/headers.py:docstring of circuits.web.headers.Headersrh6hh8}r(h:]rh<]rh>]rh@]rhC]ruhEKhFhh*]rhxX,Manage a collection of HTTP response headersrr}r(h/jh0jubaubh)r}r(h/Uh0jvh1Xf/home/prologic/work/circuits/circuits/web/headers.py:docstring of circuits.web.headers.Headers.has_keyrh6hh8}r(h@]rh>]rh:]rh<]rhC]rUentriesr]r(hX/has_key() (circuits.web.headers.Headers method)hUtrauhENhFhh*]rubh)r}r(h/Uh0jvh1jh6jh8}r(jjXpyrh@]rh>]rh:]rh<]rhC]rj Xmethodrj juhENhFhh*]r(j)r}r(h/XHeaders.has_key(name)rh0jh1jh6jh8}r(h@]rhajh2Xcircuits.web.headersrr}rbh>]rh:]rh<]rhC]rhajXHeaders.has_keyrj!j j"uhENhFhh*]r(jB)r}r(h/Xhas_keyrh0jh1jh6jEh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rhxXhas_keyrr}r(h/Uh0jubaubjP)r}r(h/Uh0jh1jh6jSh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rj[)r}r(h/Xnamerh8}r(h:]rh<]rh>]rh@]rhC]ruh0jh*]rhxXnamerr}r(h/Uh0jubah6jiubaubeubju)r}r(h/Uh0jh1jh6jxh8}r(h:]rh<]rh>]r h@]r hC]r uhENhFhh*]r h)r }r(h/X/Return true if the message contains the header.rh0jh1jh6hh8}r(h:]rh<]rh>]rh@]rhC]ruhEKhFhh*]rhxX/Return true if the message contains the header.rr}r(h/jh0j ubaubaubeubh)r}r(h/Uh0jvh1Xf/home/prologic/work/circuits/circuits/web/headers.py:docstring of circuits.web.headers.Headers.get_allrh6hh8}r(h@]rh>]rh:]r h<]r!hC]r"Uentriesr#]r$(hX/get_all() (circuits.web.headers.Headers method)hUtr%auhENhFhh*]r&ubh)r'}r((h/Uh0jvh1jh6jh8}r)(jjXpyr*h@]r+h>]r,h:]r-h<]r.hC]r/j Xmethodr0j j0uhENhFhh*]r1(j)r2}r3(h/XHeaders.get_all(name)r4h0j'h1jh6jh8}r5(h@]r6hajh2Xcircuits.web.headersr7r8}r9bh>]r:h:]r;h<]r<hC]r=hajXHeaders.get_allr>j!j j"uhENhFhh*]r?(jB)r@}rA(h/Xget_allrBh0j2h1jh6jEh8}rC(h:]rDh<]rEh>]rFh@]rGhC]rHuhENhFhh*]rIhxXget_allrJrK}rL(h/Uh0j@ubaubjP)rM}rN(h/Uh0j2h1jh6jSh8}rO(h:]rPh<]rQh>]rRh@]rShC]rTuhENhFhh*]rUj[)rV}rW(h/XnamerXh8}rY(h:]rZh<]r[h>]r\h@]r]hC]r^uh0jMh*]r_hxXnamer`ra}rb(h/Uh0jVubah6jiubaubeubju)rc}rd(h/Uh0j'h1jh6jxh8}re(h:]rfh<]rgh>]rhh@]rihC]rjuhENhFhh*]rk(h)rl}rm(h/X4Return a list of all the values for the named field.rnh0jch1jh6hh8}ro(h:]rph<]rqh>]rrh@]rshC]rtuhEKhFhh*]ruhxX4Return a list of all the values for the named field.rvrw}rx(h/jnh0jlubaubh)ry}rz(h/XThese will be sorted in the order they appeared in the original header list or were added to this instance, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list. If no fields exist with the given name, returns an empty list.r{h0jch1jh6hh8}r|(h:]r}h<]r~h>]rh@]rhC]ruhEKhFhh*]rhxXThese will be sorted in the order they appeared in the original header list or were added to this instance, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list. If no fields exist with the given name, returns an empty list.rr}r(h/j{h0jyubaubeubeubh)r}r(h/Uh0jvh1Xb/home/prologic/work/circuits/circuits/web/headers.py:docstring of circuits.web.headers.Headers.getrh6hh8}r(h@]rh>]rh:]rh<]rhC]rUentriesr]r(hX+get() (circuits.web.headers.Headers method)h UtrauhENhFhh*]rubh)r}r(h/Uh0jvh1jh6jh8}r(jjXpyrh@]rh>]rh:]rh<]rhC]rj Xmethodrj juhENhFhh*]r(j)r}r(h/XHeaders.get(name, default=None)rh0jh1jh6jh8}r(h@]rh ajh2Xcircuits.web.headersrr}rbh>]rh:]rh<]rhC]rh ajX Headers.getrj!j j"uhENhFhh*]r(jB)r}r(h/Xgetrh0jh1jh6jEh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rhxXgetrr}r(h/Uh0jubaubjP)r}r(h/Uh0jh1jh6jSh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]r(j[)r}r(h/Xnamerh8}r(h:]rh<]rh>]rh@]rhC]ruh0jh*]rhxXnamerr}r(h/Uh0jubah6jiubj[)r}r(h/X default=Nonerh8}r(h:]rh<]rh>]rh@]rhC]ruh0jh*]rhxX default=Nonerr}r(h/Uh0jubah6jiubeubeubju)r}r(h/Uh0jh1jh6jxh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rh)r}r(h/X:Get the first header value for 'name', or return 'default'rh0jh1jh6hh8}r(h:]rh<]rh>]rh@]rhC]ruhEKhFhh*]rhxX:Get the first header value for 'name', or return 'default'rr}r(h/jh0jubaubaubeubh)r}r(h/Uh0jvh1Xc/home/prologic/work/circuits/circuits/web/headers.py:docstring of circuits.web.headers.Headers.keysrh6hh8}r(h@]rh>]rh:]rh<]rhC]rUentriesr]r(hX,keys() (circuits.web.headers.Headers method)h UtrauhENhFhh*]rubh)r}r(h/Uh0jvh1jh6jh8}r(jjXpyrh@]rh>]rh:]rh<]rhC]rj Xmethodrj juhENhFhh*]r (j)r }r (h/XHeaders.keys()r h0jh1jh6jh8}r (h@]rh ajh2Xcircuits.web.headersrr}rbh>]rh:]rh<]rhC]rh ajX Headers.keysrj!j j"uhENhFhh*]r(jB)r}r(h/Xkeysrh0j h1jh6jEh8}r(h:]rh<]rh>]rh@]rhC]r uhENhFhh*]r!hxXkeysr"r#}r$(h/Uh0jubaubjP)r%}r&(h/Uh0j h1jh6jSh8}r'(h:]r(h<]r)h>]r*h@]r+hC]r,uhENhFhh*]r-ubeubju)r.}r/(h/Uh0jh1jh6jxh8}r0(h:]r1h<]r2h>]r3h@]r4hC]r5uhENhFhh*]r6(h)r7}r8(h/X,Return a list of all the header field names.r9h0j.h1jh6hh8}r:(h:]r;h<]r<h>]r=h@]r>hC]r?uhEKhFhh*]r@hxX,Return a list of all the header field names.rArB}rC(h/j9h0j7ubaubh)rD}rE(h/XThese will be sorted in the order they appeared in the original header list, or were added to this instance, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list.rFh0j.h1jh6hh8}rG(h:]rHh<]rIh>]rJh@]rKhC]rLuhEKhFhh*]rMhxXThese will be sorted in the order they appeared in the original header list, or were added to this instance, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list.rNrO}rP(h/jFh0jDubaubeubeubh)rQ}rR(h/Uh0jvh1Xe/home/prologic/work/circuits/circuits/web/headers.py:docstring of circuits.web.headers.Headers.valuesrSh6hh8}rT(h@]rUh>]rVh:]rWh<]rXhC]rYUentriesrZ]r[(hX.values() (circuits.web.headers.Headers method)h Utr\auhENhFhh*]r]ubh)r^}r_(h/Uh0jvh1jSh6jh8}r`(jjXpyrah@]rbh>]rch:]rdh<]rehC]rfj Xmethodrgj jguhENhFhh*]rh(j)ri}rj(h/XHeaders.values()rkh0j^h1jh6jh8}rl(h@]rmh ajh2Xcircuits.web.headersrnro}rpbh>]rqh:]rrh<]rshC]rth ajXHeaders.valuesruj!j j"uhENhFhh*]rv(jB)rw}rx(h/Xvaluesryh0jih1jh6jEh8}rz(h:]r{h<]r|h>]r}h@]r~hC]ruhENhFhh*]rhxXvaluesrr}r(h/Uh0jwubaubjP)r}r(h/Uh0jih1jh6jSh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rubeubju)r}r(h/Uh0j^h1jh6jxh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]r(h)r}r(h/X#Return a list of all header values.rh0jh1jSh6hh8}r(h:]rh<]rh>]rh@]rhC]ruhEKhFhh*]rhxX#Return a list of all header values.rr}r(h/jh0jubaubh)r}r(h/XThese will be sorted in the order they appeared in the original header list, or were added to this instance, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list.rh0jh1jSh6hh8}r(h:]rh<]rh>]rh@]rhC]ruhEKhFhh*]rhxXThese will be sorted in the order they appeared in the original header list, or were added to this instance, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list.rr}r(h/jh0jubaubeubeubh)r}r(h/Uh0jvh1Xd/home/prologic/work/circuits/circuits/web/headers.py:docstring of circuits.web.headers.Headers.itemsrh6hh8}r(h@]rh>]rh:]rh<]rhC]rUentriesr]r(hX-items() (circuits.web.headers.Headers method)hUtrauhENhFhh*]rubh)r}r(h/Uh0jvh1jh6jh8}r(jjXpyrh@]rh>]rh:]rh<]rhC]rj Xmethodrj juhENhFhh*]r(j)r}r(h/XHeaders.items()rh0jh1jh6jh8}r(h@]rhajh2Xcircuits.web.headersrr}rbh>]rh:]rh<]rhC]rhajX Headers.itemsrj!j j"uhENhFhh*]r(jB)r}r(h/Xitemsrh0jh1jh6jEh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rhxXitemsrr}r(h/Uh0jubaubjP)r}r(h/Uh0jh1jh6jSh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rubeubju)r}r(h/Uh0jh1jh6jxh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]r(h)r}r(h/X%Get all the header fields and values.rh0jh1jh6hh8}r(h:]rh<]rh>]rh@]rhC]ruhEKhFhh*]rhxX%Get all the header fields and values.rr}r(h/jh0jubaubh)r}r(h/XThese will be sorted in the order they were in the original header list, or were added to this instance, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list.rh0jh1jh6hh8}r(h:]rh<]rh>]rh@]r hC]r uhEKhFhh*]r hxXThese will be sorted in the order they were in the original header list, or were added to this instance, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list.r r }r(h/jh0jubaubeubeubh)r}r(h/Uh0jvh1Xi/home/prologic/work/circuits/circuits/web/headers.py:docstring of circuits.web.headers.Headers.setdefaultrh6hh8}r(h@]rh>]rh:]rh<]rhC]rUentriesr]r(hX2setdefault() (circuits.web.headers.Headers method)hUtrauhENhFhh*]rubh)r}r(h/Uh0jvh1jh6jh8}r(jjXpyrh@]r h>]r!h:]r"h<]r#hC]r$j Xmethodr%j j%uhENhFhh*]r&(j)r'}r((h/XHeaders.setdefault(name, value)r)h0jh1jh6jh8}r*(h@]r+hajh2Xcircuits.web.headersr,r-}r.bh>]r/h:]r0h<]r1hC]r2hajXHeaders.setdefaultr3j!j j"uhENhFhh*]r4(jB)r5}r6(h/X setdefaultr7h0j'h1jh6jEh8}r8(h:]r9h<]r:h>]r;h@]r<hC]r=uhENhFhh*]r>hxX setdefaultr?r@}rA(h/Uh0j5ubaubjP)rB}rC(h/Uh0j'h1jh6jSh8}rD(h:]rEh<]rFh>]rGh@]rHhC]rIuhENhFhh*]rJ(j[)rK}rL(h/XnamerMh8}rN(h:]rOh<]rPh>]rQh@]rRhC]rSuh0jBh*]rThxXnamerUrV}rW(h/Uh0jKubah6jiubj[)rX}rY(h/XvaluerZh8}r[(h:]r\h<]r]h>]r^h@]r_hC]r`uh0jBh*]rahxXvaluerbrc}rd(h/Uh0jXubah6jiubeubeubju)re}rf(h/Uh0jh1jh6jxh8}rg(h:]rhh<]rih>]rjh@]rkhC]rluhENhFhh*]rm(h)rn}ro(h/X9Return first matching header value for 'name', or 'value'rph0jeh1jh6hh8}rq(h:]rrh<]rsh>]rth@]ruhC]rvuhEKhFhh*]rwhxX9Return first matching header value for 'name', or 'value'rxry}rz(h/jph0jnubaubh)r{}r|(h/XXIf there is no header named 'name', add a new header with name 'name' and value 'value'.r}h0jeh1jh6hh8}r~(h:]rh<]rh>]rh@]rhC]ruhEKhFhh*]rhxXXIf there is no header named 'name', add a new header with name 'name' and value 'value'.rr}r(h/j}h0j{ubaubeubeubh)r}r(h/Uh0jvh1Xi/home/prologic/work/circuits/circuits/web/headers.py:docstring of circuits.web.headers.Headers.add_headerrh6hh8}r(h@]rh>]rh:]rh<]rhC]rUentriesr]r(hX2add_header() (circuits.web.headers.Headers method)hUtrauhENhFhh*]rubh)r}r(h/Uh0jvh1jh6jh8}r(jjXpyrh@]rh>]rh:]rh<]rhC]rj Xmethodrj juhENhFhh*]r(j)r}r(h/X,Headers.add_header(_name, _value, **_params)rh0jh1jh6jh8}r(h@]rhajh2Xcircuits.web.headersrr}rbh>]rh:]rh<]rhC]rhajXHeaders.add_headerrj!j j"uhENhFhh*]r(jB)r}r(h/X add_headerrh0jh1jh6jEh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rhxX add_headerrr}r(h/Uh0jubaubjP)r}r(h/Uh0jh1jh6jSh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]r(j[)r}r(h/X_namerh8}r(h:]rh<]rh>]rh@]rhC]ruh0jh*]rhxX_namerr}r(h/Uh0jubah6jiubj[)r}r(h/X_valuerh8}r(h:]rh<]rh>]rh@]rhC]ruh0jh*]rhxX_valuerr}r(h/Uh0jubah6jiubj[)r}r(h/X **_paramsrh8}r(h:]rh<]rh>]rh@]rhC]ruh0jh*]rhxX **_paramsrr}r(h/Uh0jubah6jiubeubeubju)r}r(h/Uh0jh1jh6jxh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]r(h)r}r(h/XExtended header setting.rh0jh1jh6hh8}r(h:]rh<]rh>]rh@]rhC]ruhEKhFhh*]rhxXExtended header setting.rr}r(h/jh0jubaubh)r}r(h/X _name is the header field to add. keyword arguments can be used to set additional parameters for the header field, with underscores converted to dashes. Normally the parameter will be added as key="value" unless value is None, in which case only the key will be added.rh0jh1jh6hh8}r(h:]rh<]rh>]rh@]rhC]r uhEKhFhh*]r hxX _name is the header field to add. keyword arguments can be used to set additional parameters for the header field, with underscores converted to dashes. Normally the parameter will be added as key="value" unless value is None, in which case only the key will be added.r r }r (h/jh0jubaubh)r}r(h/XExample:rh0jh1jh6hh8}r(h:]rh<]rh>]rh@]rhC]ruhEKhFhh*]rhxXExample:rr}r(h/jh0jubaubh)r}r(h/XEh.add_header('content-disposition', 'attachment', filename='bud.gif')rh0jh1jh6hh8}r(h:]rh<]r h>]r!h@]r"hC]r#uhEK hFhh*]r$hxXEh.add_header('content-disposition', 'attachment', filename='bud.gif')r%r&}r'(h/jh0jubaubh)r(}r)(h/XNote that unlike the corresponding 'email.Message' method, this does *not* handle '(charset, language, value)' tuples: all values must be strings or None.r*h0jh1jh6hh8}r+(h:]r,h<]r-h>]r.h@]r/hC]r0uhEK hFhh*]r1(hxXENote that unlike the corresponding 'email.Message' method, this does r2r3}r4(h/XENote that unlike the corresponding 'email.Message' method, this does r5h0j(ubcdocutils.nodes emphasis r6)r7}r8(h/X*not*r9h8}r:(h:]r;h<]r<h>]r=h@]r>hC]r?uh0j(h*]r@hxXnotrArB}rC(h/Uh0j7ubah6UemphasisrDubhxXP handle '(charset, language, value)' tuples: all values must be strings or None.rErF}rG(h/XP handle '(charset, language, value)' tuples: all values must be strings or None.rHh0j(ubeubeubeubh)rI}rJ(h/Uh0jvh1Xg/home/prologic/work/circuits/circuits/web/headers.py:docstring of circuits.web.headers.Headers.elementsrKh6hh8}rL(h@]rMh>]rNh:]rOh<]rPhC]rQUentriesrR]rS(hX0elements() (circuits.web.headers.Headers method)hUtrTauhENhFhh*]rUubh)rV}rW(h/Uh0jvh1jKh6jh8}rX(jjXpyrYh@]rZh>]r[h:]r\h<]r]hC]r^j Xmethodr_j j_uhENhFhh*]r`(j)ra}rb(h/XHeaders.elements(key)rch0jVh1jh6jh8}rd(h@]rehajh2Xcircuits.web.headersrfrg}rhbh>]rih:]rjh<]rkhC]rlhajXHeaders.elementsrmj!j j"uhENhFhh*]rn(jB)ro}rp(h/Xelementsrqh0jah1jh6jEh8}rr(h:]rsh<]rth>]ruh@]rvhC]rwuhENhFhh*]rxhxXelementsryrz}r{(h/Uh0joubaubjP)r|}r}(h/Uh0jah1jh6jSh8}r~(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rj[)r}r(h/Xkeyrh8}r(h:]rh<]rh>]rh@]rhC]ruh0j|h*]rhxXkeyrr}r(h/Uh0jubah6jiubaubeubju)r}r(h/Uh0jVh1jh6jxh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rh)r}r(h/X?Return a list of HeaderElements for the given header (or None).rh0jh1jKh6hh8}r(h:]rh<]rh>]rh@]rhC]ruhEKhFhh*]rhxX?Return a list of HeaderElements for the given header (or None).rr}r(h/jh0jubaubaubeubeubeubh)r}r(h/Uh0hh1Nh6hh8}r(h@]rh>]rh:]rh<]rhC]rUentriesr]r(hX-HeaderElement (class in circuits.web.headers)h UtrauhENhFhh*]rubh)r}r(h/Uh0hh1Nh6jh8}r(jjXpyrh@]rh>]rh:]rh<]rhC]rj Xclassrj juhENhFhh*]r(j)r}r(h/X!HeaderElement(value, params=None)rh0jh1jh6jh8}r(h@]rh ajh2Xcircuits.web.headersrr}rbh>]rh:]rh<]rhC]rh ajX HeaderElementrj!Uj"uhENhFhh*]r(j$)r}r(h/Xclass rh0jh1jh6j(h8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rhxXclass rr}r(h/Uh0jubaubj3)r}r(h/Xcircuits.web.headers.rh0jh1jh6j7h8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rhxXcircuits.web.headers.rr}r(h/Uh0jubaubjB)r}r(h/jh0jh1jh6jEh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rhxX HeaderElementrr}r(h/Uh0jubaubjP)r}r(h/Uh0jh1jh6jSh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]r(j[)r}r(h/Xvaluerh8}r(h:]rh<]rh>]rh@]rhC]ruh0jh*]rhxXvaluerr}r(h/Uh0jubah6jiubj[)r }r (h/X params=Noner h8}r (h:]r h<]rh>]rh@]rhC]ruh0jh*]rhxX params=Nonerr}r(h/Uh0j ubah6jiubeubeubju)r}r(h/Uh0jh1jh6jxh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]r(h)r}r (h/XBases: :class:`object`r!h0jh1jh6hh8}r"(h:]r#h<]r$h>]r%h@]r&hC]r'uhEKhFhh*]r((hxXBases: r)r*}r+(h/XBases: r,h0jubhT)r-}r.(h/X:class:`object`r/h0jh1h4h6hXh8}r0(Ureftyper1Xclassr2h\h]Xobjectr3U refdomainr4Xpyr5h@]r6h>]r7U refexplicitr8h:]r9h<]r:hC]r;hghhhijhjjuhEKh*]r<hl)r=}r>(h/j/h8}r?(h:]r@h<]rA(hrj5Xpy-classrBeh>]rCh@]rDhC]rEuh0j-h*]rFhxXobjectrGrH}rI(h/Uh0j=ubah6h|ubaubeubh)rJ}rK(h/X@An element (with parameters) from an HTTP header's element list.rLh0jh1Xd/home/prologic/work/circuits/circuits/web/headers.py:docstring of circuits.web.headers.HeaderElementrMh6hh8}rN(h:]rOh<]rPh>]rQh@]rRhC]rSuhEKhFhh*]rThxX@An element (with parameters) from an HTTP header's element list.rUrV}rW(h/jLh0jJubaubh)rX}rY(h/Uh0jh1Xj/home/prologic/work/circuits/circuits/web/headers.py:docstring of circuits.web.headers.HeaderElement.parserZh6hh8}r[(h@]r\h>]r]h:]r^h<]r_hC]r`Uentriesra]rb(hX:parse() (circuits.web.headers.HeaderElement static method)hUtrcauhENhFhh*]rdubh)re}rf(h/Uh0jh1jZh6jh8}rg(jjXpyrhh@]rih>]rjh:]rkh<]rlhC]rmj X staticmethodrnj jnuhENhFhh*]ro(j)rp}rq(h/XHeaderElement.parse(elementstr)rrh0jeh1jh6jh8}rs(h@]rthajh2Xcircuits.web.headersrurv}rwbh>]rxh:]ryh<]rzhC]r{hajXHeaderElement.parser|j!jj"uhENhFhh*]r}(j$)r~}r(h/Ustatic rh0jph1jh6j(h8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rhxXstatic rr}r(h/Uh0j~ubaubjB)r}r(h/Xparserh0jph1jh6jEh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rhxXparserr}r(h/Uh0jubaubjP)r}r(h/Uh0jph1jh6jSh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rj[)r}r(h/X elementstrrh8}r(h:]rh<]rh>]rh@]rhC]ruh0jh*]rhxX elementstrrr}r(h/Uh0jubah6jiubaubeubju)r}r(h/Uh0jeh1jh6jxh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rh)r}r(h/X7Transform 'token;key=val' to ('token', {'key': 'val'}).rh0jh1jZh6hh8}r(h:]rh<]rh>]rh@]rhC]ruhEKhFhh*]rhxX7Transform 'token;key=val' to ('token', {'key': 'val'}).rr}r(h/jh0jubaubaubeubh)r}r(h/Uh0jh1Xm/home/prologic/work/circuits/circuits/web/headers.py:docstring of circuits.web.headers.HeaderElement.from_strrh6hh8}r(h@]rh>]rh:]rh<]rhC]rUentriesr]r(hX<from_str() (circuits.web.headers.HeaderElement class method)hUtrauhENhFhh*]rubh)r}r(h/Uh0jh1jh6jh8}r(jjXpyrh@]rh>]rh:]rh<]rhC]rj X classmethodrj juhENhFhh*]r(j)r}r(h/X"HeaderElement.from_str(elementstr)rh0jh1jh6jh8}r(h@]rhajh2Xcircuits.web.headersrr}rbh>]rh:]rh<]rhC]rhajXHeaderElement.from_strrj!jj"uhENhFhh*]r(j$)r}r(h/U classmethod rh0jh1jh6j(h8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rhxX classmethod rr}r(h/Uh0jubaubjB)r}r(h/Xfrom_strrh0jh1jh6jEh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rhxXfrom_strrr}r(h/Uh0jubaubjP)r}r(h/Uh0jh1jh6jSh8}r(h:]rh<]rh>]r h@]r hC]r uhENhFhh*]r j[)r }r(h/X elementstrrh8}r(h:]rh<]rh>]rh@]rhC]ruh0jh*]rhxX elementstrrr}r(h/Uh0j ubah6jiubaubeubju)r}r(h/Uh0jh1jh6jxh8}r(h:]rh<]rh>]rh@]r hC]r!uhENhFhh*]r"h)r#}r$(h/X@Construct an instance from a string of the form 'token;key=val'.r%h0jh1jh6hh8}r&(h:]r'h<]r(h>]r)h@]r*hC]r+uhEKhFhh*]r,hxX@Construct an instance from a string of the form 'token;key=val'.r-r.}r/(h/j%h0j#ubaubaubeubeubeubh)r0}r1(h/Uh0hh1Nh6hh8}r2(h@]r3h>]r4h:]r5h<]r6hC]r7Uentriesr8]r9(hX-AcceptElement (class in circuits.web.headers)h Utr:auhENhFhh*]r;ubh)r<}r=(h/Uh0hh1Nh6jh8}r>(jjXpyr?h@]r@h>]rAh:]rBh<]rChC]rDj XclassrEj jEuhENhFhh*]rF(j)rG}rH(h/X!AcceptElement(value, params=None)rIh0j<h1jh6jh8}rJ(h@]rKh ajh2Xcircuits.web.headersrLrM}rNbh>]rOh:]rPh<]rQhC]rRh ajX AcceptElementrSj!Uj"uhENhFhh*]rT(j$)rU}rV(h/Xclass rWh0jGh1jh6j(h8}rX(h:]rYh<]rZh>]r[h@]r\hC]r]uhENhFhh*]r^hxXclass r_r`}ra(h/Uh0jUubaubj3)rb}rc(h/Xcircuits.web.headers.rdh0jGh1jh6j7h8}re(h:]rfh<]rgh>]rhh@]rihC]rjuhENhFhh*]rkhxXcircuits.web.headers.rlrm}rn(h/Uh0jbubaubjB)ro}rp(h/jSh0jGh1jh6jEh8}rq(h:]rrh<]rsh>]rth@]ruhC]rvuhENhFhh*]rwhxX AcceptElementrxry}rz(h/Uh0joubaubjP)r{}r|(h/Uh0jGh1jh6jSh8}r}(h:]r~h<]rh>]rh@]rhC]ruhENhFhh*]r(j[)r}r(h/Xvaluerh8}r(h:]rh<]rh>]rh@]rhC]ruh0j{h*]rhxXvaluerr}r(h/Uh0jubah6jiubj[)r}r(h/X params=Nonerh8}r(h:]rh<]rh>]rh@]rhC]ruh0j{h*]rhxX params=Nonerr}r(h/Uh0jubah6jiubeubeubju)r}r(h/Uh0j<h1jh6jxh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]r(h)r}r(h/X2Bases: :class:`circuits.web.headers.HeaderElement`rh0jh1jh6hh8}r(h:]rh<]rh>]rh@]rhC]ruhEKhFhh*]r(hxXBases: rr}r(h/XBases: rh0jubhT)r}r(h/X+:class:`circuits.web.headers.HeaderElement`rh0jh1h4h6hXh8}r(UreftyperXclassrh\h]X"circuits.web.headers.HeaderElementrU refdomainrXpyrh@]rh>]rU refexplicitrh:]rh<]rhC]rhghhhijShjjuhEKh*]rhl)r}r(h/jh8}r(h:]rh<]r(hrjXpy-classreh>]rh@]rhC]ruh0jh*]rhxX"circuits.web.headers.HeaderElementrr}r(h/Uh0jubah6h|ubaubeubh)r}r(h/XCAn element (with parameters) from an Accept* header's element list.rh0jh1Xd/home/prologic/work/circuits/circuits/web/headers.py:docstring of circuits.web.headers.AcceptElementrh6hh8}r(h:]rh<]rh>]rh@]rhC]ruhEKhFhh*]rhxXCAn element (with parameters) from an Accept* header's element list.rr}r(h/jh0jubaubh)r}r(h/XYAcceptElement objects are comparable; the more-preferred object will be "less than" the less-preferred object. They are also therefore sortable; if you sort a list of AcceptElement objects, they will be listed in priority order; the most preferred value will be first. Yes, it should have been the other way around, but it's too late to fix now.rh0jh1jh6hh8}r(h:]rh<]rh>]rh@]rhC]ruhEKhFhh*]rhxXYAcceptElement objects are comparable; the more-preferred object will be "less than" the less-preferred object. They are also therefore sortable; if you sort a list of AcceptElement objects, they will be listed in priority order; the most preferred value will be first. Yes, it should have been the other way around, but it's too late to fix now.rr}r(h/jh0jubaubh)r}r(h/Uh0jh1Xk/home/prologic/work/circuits/circuits/web/headers.py:docstring of circuits.web.headers.AcceptElement.qvaluerh6hh8}r(h@]rh>]rh:]rh<]rhC]rUentriesr]r(hX5qvalue (circuits.web.headers.AcceptElement attribute)hUtrauhENhFhh*]rubh)r}r(h/Uh0jh1jh6jh8}r(jjXpyrh@]rh>]rh:]rh<]rhC]rj X attributerj juhENhFhh*]r(j)r}r(h/XAcceptElement.qvaluerh0jh1jh6jh8}r(h@]r hajh2Xcircuits.web.headersr r }r bh>]r h:]rh<]rhC]rhajXAcceptElement.qvaluerj!jSj"uhENhFhh*]rjB)r}r(h/Xqvaluerh0jh1jh6jEh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rhxXqvaluerr}r(h/Uh0jubaubaubju)r }r!(h/Uh0jh1jh6jxh8}r"(h:]r#h<]r$h>]r%h@]r&hC]r'uhENhFhh*]r(h)r)}r*(h/X'The qvalue, or priority, of this value.r+h0j h1jh6hh8}r,(h:]r-h<]r.h>]r/h@]r0hC]r1uhEKhFhh*]r2hxX'The qvalue, or priority, of this value.r3r4}r5(h/j+h0j)ubaubaubeubeubeubeubh,)r6}r7(h/Uh0h-h1h4h6h7h8}r8(h:]r9h<]r:h>]r;h@]r<h)ahC]r=hauhEKhFhh*]r>(hH)r?}r@(h/X ComponentsrAh0j6h1h4h6hLh8}rB(h:]rCh<]rDh>]rEh@]rFhC]rGuhEKhFhh*]rHhxX ComponentsrIrJ}rK(h/jAh0j?ubaubh)rL}rM(h/X**none**rNh0j6h1h4h6hh8}rO(h:]rPh<]rQh>]rRh@]rShC]rTuhEKhFhh*]rUh)rV}rW(h/jNh8}rX(h:]rYh<]rZh>]r[h@]r\hC]r]uh0jLh*]r^hxXnoner_r`}ra(h/Uh0jVubah6hubaubeubh,)rb}rc(h/Uh0h-h1h4h6h7h8}rd(h:]reh<]rfh>]rgh@]rhh%ahC]rihauhEK!hFhh*]rj(hH)rk}rl(h/X Functionsrmh0jbh1h4h6hLh8}rn(h:]roh<]rph>]rqh@]rrhC]rsuhEK!hFhh*]rthxX Functionsrurv}rw(h/jmh0jkubaubh)rx}ry(h/Uh0jbh1Xf/home/prologic/work/circuits/circuits/web/headers.py:docstring of circuits.web.headers.header_elementsrzh6hh8}r{(h@]r|h>]r}h:]r~h<]rhC]rUentriesr]r(hX2header_elements() (in module circuits.web.headers)hUtrauhENhFhh*]rubh)r}r(h/Uh0jbh1jzh6jh8}r(jjXpyrh@]rh>]rh:]rh<]rhC]rj Xfunctionrj juhENhFhh*]r(j)r}r(h/X&header_elements(fieldname, fieldvalue)rh0jh1jh6jh8}r(h@]rhajh2Xcircuits.web.headersrr}rbh>]rh:]rh<]rhC]rhajXheader_elementsrj!Uj"uhENhFhh*]r(j3)r}r(h/Xcircuits.web.headers.rh0jh1jh6j7h8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rhxXcircuits.web.headers.rr}r(h/Uh0jubaubjB)r}r(h/jh0jh1jh6jEh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rhxXheader_elementsrr}r(h/Uh0jubaubjP)r}r(h/Uh0jh1jh6jSh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]r(j[)r}r(h/X fieldnamerh8}r(h:]rh<]rh>]rh@]rhC]ruh0jh*]rhxX fieldnamerr}r(h/Uh0jubah6jiubj[)r}r(h/X fieldvaluerh8}r(h:]rh<]rh>]rh@]rhC]ruh0jh*]rhxX fieldvaluerr}r(h/Uh0jubah6jiubeubeubju)r}r(h/Uh0jh1jh6jxh8}r(h:]rh<]rh>]rh@]rhC]ruhENhFhh*]rh)r}r(h/X>Return a HeaderElement list from a comma-separated header str.rh0jh1jzh6hh8}r(h:]rh<]rh>]rh@]rhC]ruhEKhFhh*]rhxX>Return a HeaderElement list from a comma-separated header str.rr}r(h/jh0jubaubaubeubh)r}r(h/Uh0jbh1Nh6hh8}r(h@]rh>]rh:]rh<]rhC]rUentriesr]r(hX0parse_headers() (in module circuits.web.headers)hUtrauhENhFhh*]rubh)r}r(h/Uh0jbh1Nh6jh8}r(jjXpyrh@]r h>]r h:]r h<]r hC]r j Xfunctionr j j uhENhFhh*]r (j)r }r (h/Xparse_headers(data)r h0jh1jh6jh8}r (h@]r hajh2Xcircuits.web.headersr r }r bh>]r h:]r h<]r hC]r hajX parse_headersr j!Uj"uhENhFhh*]r (j3)r }r (h/Xcircuits.web.headers.r h0j h1jh6j7h8}r (h:]r h<]r h>]r h@]r hC]r uhENhFhh*]r hxXcircuits.web.headers.r r }r! (h/Uh0j ubaubjB)r" }r# (h/j h0j h1jh6jEh8}r$ (h:]r% h<]r& h>]r' h@]r( hC]r) uhENhFhh*]r* hxX parse_headersr+ r, }r- (h/Uh0j" ubaubjP)r. }r/ (h/Uh0j h1jh6jSh8}r0 (h:]r1 h<]r2 h>]r3 h@]r4 hC]r5 uhENhFhh*]r6 j[)r7 }r8 (h/Xdatar9 h8}r: (h:]r; h<]r< h>]r= h@]r> hC]r? uh0j. h*]r@ hxXdatarA rB }rC (h/Uh0j7 ubah6jiubaubeubju)rD }rE (h/Uh0jh1jh6jxh8}rF (h:]rG h<]rH h>]rI h@]rJ hC]rK uhENhFhh*]rL ubeubeubeubah/UU transformerrM NU footnote_refsrN }rO UrefnamesrP }rQ Usymbol_footnotesrR ]rS Uautofootnote_refsrT ]rU Usymbol_footnote_refsrV ]rW U citationsrX ]rY hFhU current_linerZ NUtransform_messagesr[ ]r\ Ureporterr] NUid_startr^ KU autofootnotesr_ ]r` U citation_refsra }rb Uindirect_targetsrc ]rd Usettingsre (cdocutils.frontend Values rf org }rh (Ufootnote_backlinksri KUrecord_dependenciesrj NU rfc_base_urlrk Uhttp://tools.ietf.org/html/rl U tracebackrm Upep_referencesrn NUstrip_commentsro NU toc_backlinksrp Uentryrq U language_coderr Uenrs U datestamprt NU report_levelru KU _destinationrv NU halt_levelrw KU strip_classesrx NhLNUerror_encoding_error_handlerry Ubackslashreplacerz Udebugr{ NUembed_stylesheetr| Uoutput_encoding_error_handlerr} Ustrictr~ U sectnum_xformr KUdump_transformsr NU docinfo_xformr KUwarning_streamr NUpep_file_url_templater Upep-%04dr Uexit_status_levelr KUconfigr NUstrict_visitorr NUcloak_email_addressesr Utrim_footnote_reference_spacer Uenvr NUdump_pseudo_xmlr NUexpose_internalsr NUsectsubtitle_xformr U source_linkr NUrfc_referencesr NUoutput_encodingr Uutf-8r U source_urlr NUinput_encodingr U utf-8-sigr U_disable_configr NU id_prefixr UU tab_widthr KUerror_encodingr U ISO-8859-1r U_sourcer UE/home/prologic/work/circuits/docs/source/api/circuits_web_headers.rstr Ugettext_compactr U generatorr NUdump_internalsr NU smart_quotesr U pep_base_urlr Uhttp://www.python.org/dev/peps/r Usyntax_highlightr Ulongr Uinput_encoding_error_handlerr j~ Uauto_id_prefixr Uidr Udoctitle_xformr Ustrip_elements_with_classesr NU _config_filesr ]r Ufile_insertion_enabledr KU raw_enabledr KU dump_settingsr NubUsymbol_footnote_startr KUidsr }r (hjhj2hjh jh jih jGh j h jh%jbhjhjhjh&hhBcdocutils.nodes target r )r }r (h/Uh0h-h1hh6Utargetr h8}r (h:]r h@]r hBah>]r Uismodr h<]r hC]r uhEKhFhh*]r ubhjh'h-hj'hjphjahj h(hh)j6hjuUsubstitution_namesr }r h6hFh8}r (h:]r h@]r h>]r Usourcer h4h<]r hC]r uU footnotesr ]r Urefidsr }r ub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_exceptions.doctree0000644000014400001440000022372212113366665026013 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X+circuits.web.exceptions.InternalServerErrorqX$circuits.web.exceptions.UnauthorizedqX*circuits.web.exceptions.PreconditionFailedqX-circuits.web.exceptions.RequestEntityTooLargeq X&circuits.web.exceptions.LengthRequiredq X functionsq NX*circuits.web.exceptions.RequestURITooLargeq X*circuits.web.exceptions.ServiceUnavailableq X$circuits.web.exceptions.UnicodeErrorqX%circuits.web.exceptions.NotAcceptableqXeventsqNX!circuits.web.exceptions.ForbiddenqX componentsqNX&circuits.web.exceptions.RequestTimeoutqX"circuits.web.exceptions.BadGatewayqX%circuits.web.exceptions.HTTPExceptionqX,circuits.web.exceptions.UnsupportedMediaTypeqX&circuits.web.exceptions.NotImplementedqXcircuits.web.exceptions.GoneqX"circuits.web.exceptions.BadRequestqX%circuits.web.exceptions -- exceptionsqNX(circuits.web.exceptions.MethodNotAllowedqX circuits.web.exceptions.RedirectqX exceptionsqNX circuits.web.exceptions.NotFoundquUsubstitution_defsq}q Uparse_messagesq!]q"Ucurrent_sourceq#NU decorationq$NUautofootnote_startq%KUnameidsq&}q'(hhhhhhh h h h h U functionsq(h h h h hhhhhUeventsq)hhhU componentsq*hhhhhhhhhhhhhhhU"circuits-web-exceptions-exceptionsq+hhhhhU exceptionsq,hhuUchildrenq-]q.cdocutils.nodes section q/)q0}q1(U rawsourceq2UUparentq3hUsourceq4cdocutils.nodes reprunicode q5XH/home/prologic/work/circuits/docs/source/api/circuits_web_exceptions.rstq6q7}q8bUtagnameq9Usectionq:U attributesq;}q<(Udupnamesq=]q>Uclassesq?]q@UbackrefsqA]qBUidsqC]qD(Xmodule-circuits.web.exceptionsqEh+eUnamesqF]qGhauUlineqHKUdocumentqIhh-]qJ(cdocutils.nodes title qK)qL}qM(h2X,:mod:`circuits.web.exceptions` -- ExceptionsqNh3h0h4h7h9UtitleqOh;}qP(h=]qQh?]qRhA]qShC]qThF]qUuhHKhIhh-]qV(csphinx.addnodes pending_xref qW)qX}qY(h2X:mod:`circuits.web.exceptions`qZh3hLh4h7h9U pending_xrefq[h;}q\(Ureftypeq]Xmodq^Urefwarnq_U reftargetq`Xcircuits.web.exceptionsqaU refdomainqbXpyqchC]qdhA]qeU refexplicitqfh=]qgh?]qhhF]qiUrefdocqjUapi/circuits_web_exceptionsqkUpy:classqlNU py:moduleqmNuhHKh-]qncdocutils.nodes literal qo)qp}qq(h2hZh;}qr(h=]qsh?]qt(UxrefquhcXpy-modqvehA]qwhC]qxhF]qyuh3hXh-]qzcdocutils.nodes Text q{Xcircuits.web.exceptionsq|q}}q~(h2Uh3hpubah9Uliteralqubaubh{X -- Exceptionsqq}q(h2X -- Exceptionsqh3hLubeubcsphinx.addnodes index q)q}q(h2Uh3h0h4U qh9Uindexqh;}q(hC]qhA]qh=]qh?]qhF]qUentriesq]q(UsingleqX circuits.web.exceptions (module)Xmodule-circuits.web.exceptionsUtqauhHKhIhh-]qubcdocutils.nodes paragraph q)q}q(h2X Exceptionsqh3h0h4X\/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptionsqh9U paragraphqh;}q(h=]qh?]qhA]qhC]qhF]quhHKhIhh-]qh{X Exceptionsqq}q(h2hh3hubaubh)q}q(h2XJThis module implements a set of standard HTTP Errors as Python Exceptions.qh3h0h4hh9hh;}q(h=]qh?]qhA]qhC]qhF]quhHKhIhh-]qh{XJThis module implements a set of standard HTTP Errors as Python Exceptions.qq}q(h2hh3hubaubh)q}q(h2XMNote: This code is mostly borrowed from werkzeug and adapted for circuits.webqh3h0h4hh9hh;}q(h=]qh?]qhA]qhC]qhF]quhHKhIhh-]qh{XMNote: This code is mostly borrowed from werkzeug and adapted for circuits.webqq}q(h2hh3hubaubh/)q}q(h2Uh3h0h4h7h9h:h;}q(h=]qh?]qhA]qhC]qh,ahF]qhauhHKhIhh-]q(hK)q}q(h2X Exceptionsqh3hh4h7h9hOh;}q(h=]qh?]qhA]qhC]qhF]quhHKhIhh-]qh{X Exceptionsqхq}q(h2hh3hubaubh)q}q(h2Uh3hh4Xj/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.HTTPExceptionqh9hh;}q(hC]qhA]qh=]qh?]qhF]qUentriesq]q(hX HTTPExceptionqhUtqauhHNhIhh-]qubcsphinx.addnodes desc q)q}q(h2Uh3hh4hh9Udescqh;}q(UnoindexqUdomainqXpyqhC]qhA]qh=]qh?]qhF]qUobjtypeqX exceptionqUdesctypeqhuhHNhIhh-]q(csphinx.addnodes desc_signature q)q}q(h2X/HTTPException(description=None, traceback=None)qh3hh4U qh9Udesc_signatureqh;}q(hC]qhaUmoduleqh5Xcircuits.web.exceptionsqq}qbhA]qh=]rh?]rhF]rhaUfullnamerhUclassrUUfirstruhHNhIhh-]r(csphinx.addnodes desc_annotation r)r}r (h2X exception r h3hh4hh9Udesc_annotationr h;}r (h=]r h?]rhA]rhC]rhF]ruhHNhIhh-]rh{X exception rr}r(h2Uh3jubaubcsphinx.addnodes desc_addname r)r}r(h2Xcircuits.web.exceptions.rh3hh4hh9U desc_addnamerh;}r(h=]rh?]rhA]rhC]rhF]r uhHNhIhh-]r!h{Xcircuits.web.exceptions.r"r#}r$(h2Uh3jubaubcsphinx.addnodes desc_name r%)r&}r'(h2hh3hh4hh9U desc_namer(h;}r)(h=]r*h?]r+hA]r,hC]r-hF]r.uhHNhIhh-]r/h{X HTTPExceptionr0r1}r2(h2Uh3j&ubaubcsphinx.addnodes desc_parameterlist r3)r4}r5(h2Uh3hh4hh9Udesc_parameterlistr6h;}r7(h=]r8h?]r9hA]r:hC]r;hF]r<uhHNhIhh-]r=(csphinx.addnodes desc_parameter r>)r?}r@(h2Xdescription=NonerAh;}rB(h=]rCh?]rDhA]rEhC]rFhF]rGuh3j4h-]rHh{Xdescription=NonerIrJ}rK(h2Uh3j?ubah9Udesc_parameterrLubj>)rM}rN(h2Xtraceback=NonerOh;}rP(h=]rQh?]rRhA]rShC]rThF]rUuh3j4h-]rVh{Xtraceback=NonerWrX}rY(h2Uh3jMubah9jLubeubeubcsphinx.addnodes desc_content rZ)r[}r\(h2Uh3hh4hh9U desc_contentr]h;}r^(h=]r_h?]r`hA]rahC]rbhF]rcuhHNhIhh-]rd(h)re}rf(h2X$Bases: :class:`exceptions.Exception`rgh3j[h4U rhh9hh;}ri(h=]rjh?]rkhA]rlhC]rmhF]rnuhHKhIhh-]ro(h{XBases: rprq}rr(h2XBases: rsh3jeubhW)rt}ru(h2X:class:`exceptions.Exception`rvh3jeh4h7h9h[h;}rw(UreftyperxXclassryh_h`Xexceptions.ExceptionrzU refdomainr{Xpyr|hC]r}hA]r~U refexplicitrh=]rh?]rhF]rhjhkhlhhmXcircuits.web.exceptionsruhHKh-]rho)r}r(h2jvh;}r(h=]rh?]r(huj|Xpy-classrehA]rhC]rhF]ruh3jth-]rh{Xexceptions.Exceptionrr}r(h2Uh3jubah9hubaubeubh)r}r(h2XBaseclass for all HTTP exceptions. This exception can be called by WSGI applications to render a default error page or you can catch the subclasses of it independently and render nicer error messages.rh3j[h4hh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]rh{XBaseclass for all HTTP exceptions. This exception can be called by WSGI applications to render a default error page or you can catch the subclasses of it independently and render nicer error messages.rr}r(h2jh3jubaubeubeubh)r}r(h2Uh3hh4Xg/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.BadGatewayrh9hh;}r(hC]rhA]rh=]rh?]rhF]rUentriesr]r(hX BadGatewayrhUtrauhHNhIhh-]rubh)r}r(h2Uh3hh4jh9hh;}r(hhXpyrhC]rhA]rh=]rh?]rhF]rhX exceptionrhjuhHNhIhh-]r(h)r}r(h2X,BadGateway(description=None, traceback=None)rh3jh4hh9hh;}r(hC]rhahh5Xcircuits.web.exceptionsrr}rbhA]rh=]rh?]rhF]rhajjjUjuhHNhIhh-]r(j)r}r(h2X exception rh3jh4hh9j h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{X exception rr}r(h2Uh3jubaubj)r}r(h2Xcircuits.web.exceptions.rh3jh4hh9jh;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{Xcircuits.web.exceptions.rr}r(h2Uh3jubaubj%)r}r(h2jh3jh4hh9j(h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{X BadGatewayrr}r(h2Uh3jubaubj3)r}r(h2Uh3jh4hh9j6h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]r(j>)r}r(h2Xdescription=Nonerh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{Xdescription=Nonerr}r(h2Uh3jubah9jLubj>)r}r(h2Xtraceback=Nonerh;}r(h=]rh?]rhA]rhC]rhF]r uh3jh-]r h{Xtraceback=Noner r }r (h2Uh3jubah9jLubeubeubjZ)r}r(h2Uh3jh4hh9j]h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]r(h)r}r(h2X5Bases: :class:`circuits.web.exceptions.HTTPException`rh3jh4jhh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]r (h{XBases: r!r"}r#(h2XBases: r$h3jubhW)r%}r&(h2X.:class:`circuits.web.exceptions.HTTPException`r'h3jh4h7h9h[h;}r((Ureftyper)Xclassr*h_h`X%circuits.web.exceptions.HTTPExceptionr+U refdomainr,Xpyr-hC]r.hA]r/U refexplicitr0h=]r1h?]r2hF]r3hjhkhljhmjuhHKh-]r4ho)r5}r6(h2j'h;}r7(h=]r8h?]r9(huj-Xpy-classr:ehA]r;hC]r<hF]r=uh3j%h-]r>h{X%circuits.web.exceptions.HTTPExceptionr?r@}rA(h2Uh3j5ubah9hubaubeubh)rB}rC(h2X*502* `Bad Gateway`rDh3jh4jh9hh;}rE(h=]rFh?]rGhA]rHhC]rIhF]rJuhHKhIhh-]rK(cdocutils.nodes emphasis rL)rM}rN(h2X*502*rOh;}rP(h=]rQh?]rRhA]rShC]rThF]rUuh3jBh-]rVh{X502rWrX}rY(h2Uh3jMubah9UemphasisrZubh{X r[}r\(h2X h3jBubcdocutils.nodes title_reference r])r^}r_(h2X `Bad Gateway`r`h;}ra(h=]rbh?]rchA]rdhC]rehF]rfuh3jBh-]rgh{X Bad Gatewayrhri}rj(h2Uh3j^ubah9Utitle_referencerkubeubh)rl}rm(h2XIf you do proxying in your application you should return this status code if you received an invalid response from the upstream server it accessed in attempting to fulfill the request.rnh3jh4jh9hh;}ro(h=]rph?]rqhA]rrhC]rshF]rtuhHKhIhh-]ruh{XIf you do proxying in your application you should return this status code if you received an invalid response from the upstream server it accessed in attempting to fulfill the request.rvrw}rx(h2jnh3jlubaubeubeubh)ry}rz(h2Uh3hh4Xg/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.BadRequestr{h9hh;}r|(hC]r}hA]r~h=]rh?]rhF]rUentriesr]r(hX BadRequestrhUtrauhHNhIhh-]rubh)r}r(h2Uh3hh4j{h9hh;}r(hhXpyrhC]rhA]rh=]rh?]rhF]rhX exceptionrhjuhHNhIhh-]r(h)r}r(h2X,BadRequest(description=None, traceback=None)rh3jh4hh9hh;}r(hC]rhahh5Xcircuits.web.exceptionsrr}rbhA]rh=]rh?]rhF]rhajjjUjuhHNhIhh-]r(j)r}r(h2X exception rh3jh4hh9j h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{X exception rr}r(h2Uh3jubaubj)r}r(h2Xcircuits.web.exceptions.rh3jh4hh9jh;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{Xcircuits.web.exceptions.rr}r(h2Uh3jubaubj%)r}r(h2jh3jh4hh9j(h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{X BadRequestrr}r(h2Uh3jubaubj3)r}r(h2Uh3jh4hh9j6h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]r(j>)r}r(h2Xdescription=Nonerh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{Xdescription=Nonerr}r(h2Uh3jubah9jLubj>)r}r(h2Xtraceback=Nonerh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{Xtraceback=Nonerr}r(h2Uh3jubah9jLubeubeubjZ)r}r(h2Uh3jh4hh9j]h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]r(h)r}r(h2X5Bases: :class:`circuits.web.exceptions.HTTPException`rh3jh4jhh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]r(h{XBases: rr}r(h2XBases: rh3jubhW)r}r(h2X.:class:`circuits.web.exceptions.HTTPException`rh3jh4h7h9h[h;}r(UreftyperXclassrh_h`X%circuits.web.exceptions.HTTPExceptionrU refdomainrXpyrhC]rhA]r U refexplicitr h=]r h?]r hF]r hjhkhljhmjuhHKh-]rho)r}r(h2jh;}r(h=]rh?]r(hujXpy-classrehA]rhC]rhF]ruh3jh-]rh{X%circuits.web.exceptions.HTTPExceptionrr}r(h2Uh3jubah9hubaubeubh)r}r(h2X*400* `Bad Request`rh3jh4j{h9hh;}r(h=]r h?]r!hA]r"hC]r#hF]r$uhHKhIhh-]r%(jL)r&}r'(h2X*400*r(h;}r)(h=]r*h?]r+hA]r,hC]r-hF]r.uh3jh-]r/h{X400r0r1}r2(h2Uh3j&ubah9jZubh{X r3}r4(h2X h3jubj])r5}r6(h2X `Bad Request`r7h;}r8(h=]r9h?]r:hA]r;hC]r<hF]r=uh3jh-]r>h{X Bad Requestr?r@}rA(h2Uh3j5ubah9jkubeubh)rB}rC(h2X`Raise if the browser sends something to the application the application or server cannot handle.rDh3jh4j{h9hh;}rE(h=]rFh?]rGhA]rHhC]rIhF]rJuhHKhIhh-]rKh{X`Raise if the browser sends something to the application the application or server cannot handle.rLrM}rN(h2jDh3jBubaubeubeubh)rO}rP(h2Uh3hh4Xf/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.ForbiddenrQh9hh;}rR(hC]rShA]rTh=]rUh?]rVhF]rWUentriesrX]rY(hX ForbiddenrZhUtr[auhHNhIhh-]r\ubh)r]}r^(h2Uh3hh4jQh9hh;}r_(hhXpyr`hC]rahA]rbh=]rch?]rdhF]rehX exceptionrfhjfuhHNhIhh-]rg(h)rh}ri(h2X+Forbidden(description=None, traceback=None)rjh3j]h4hh9hh;}rk(hC]rlhahh5Xcircuits.web.exceptionsrmrn}robhA]rph=]rqh?]rrhF]rshajjZjUjuhHNhIhh-]rt(j)ru}rv(h2X exception rwh3jhh4hh9j h;}rx(h=]ryh?]rzhA]r{hC]r|hF]r}uhHNhIhh-]r~h{X exception rr}r(h2Uh3juubaubj)r}r(h2Xcircuits.web.exceptions.rh3jhh4hh9jh;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{Xcircuits.web.exceptions.rr}r(h2Uh3jubaubj%)r}r(h2jZh3jhh4hh9j(h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{X Forbiddenrr}r(h2Uh3jubaubj3)r}r(h2Uh3jhh4hh9j6h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]r(j>)r}r(h2Xdescription=Nonerh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{Xdescription=Nonerr}r(h2Uh3jubah9jLubj>)r}r(h2Xtraceback=Nonerh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{Xtraceback=Nonerr}r(h2Uh3jubah9jLubeubeubjZ)r}r(h2Uh3j]h4hh9j]h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]r(h)r}r(h2X5Bases: :class:`circuits.web.exceptions.HTTPException`rh3jh4jhh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]r(h{XBases: rr}r(h2XBases: rh3jubhW)r}r(h2X.:class:`circuits.web.exceptions.HTTPException`rh3jh4h7h9h[h;}r(UreftyperXclassrh_h`X%circuits.web.exceptions.HTTPExceptionrU refdomainrXpyrhC]rhA]rU refexplicitrh=]rh?]rhF]rhjhkhljZhmjuhHKh-]rho)r}r(h2jh;}r(h=]rh?]r(hujXpy-classrehA]rhC]rhF]ruh3jh-]rh{X%circuits.web.exceptions.HTTPExceptionrr}r(h2Uh3jubah9hubaubeubh)r}r(h2X*403* `Forbidden`rh3jh4jQh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]r(jL)r}r(h2X*403*rh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{X403rr}r(h2Uh3jubah9jZubh{X r }r (h2X h3jubj])r }r (h2X `Forbidden`r h;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{X Forbiddenrr}r(h2Uh3j ubah9jkubeubh)r}r(h2X_Raise if the user doesn't have the permission for the requested resource but was authenticated.rh3jh4jQh9hh;}r(h=]rh?]rhA]rhC]rhF]r uhHKhIhh-]r!h{X_Raise if the user doesn't have the permission for the requested resource but was authenticated.r"r#}r$(h2jh3jubaubeubeubh)r%}r&(h2Uh3hh4Xa/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.Goner'h9hh;}r((hC]r)hA]r*h=]r+h?]r,hF]r-Uentriesr.]r/(hXGoner0hUtr1auhHNhIhh-]r2ubh)r3}r4(h2Uh3hh4j'h9hh;}r5(hhXpyr6hC]r7hA]r8h=]r9h?]r:hF]r;hX exceptionr<hj<uhHNhIhh-]r=(h)r>}r?(h2X&Gone(description=None, traceback=None)r@h3j3h4hh9hh;}rA(hC]rBhahh5Xcircuits.web.exceptionsrCrD}rEbhA]rFh=]rGh?]rHhF]rIhajj0jUjuhHNhIhh-]rJ(j)rK}rL(h2X exception rMh3j>h4hh9j h;}rN(h=]rOh?]rPhA]rQhC]rRhF]rSuhHNhIhh-]rTh{X exception rUrV}rW(h2Uh3jKubaubj)rX}rY(h2Xcircuits.web.exceptions.rZh3j>h4hh9jh;}r[(h=]r\h?]r]hA]r^hC]r_hF]r`uhHNhIhh-]rah{Xcircuits.web.exceptions.rbrc}rd(h2Uh3jXubaubj%)re}rf(h2j0h3j>h4hh9j(h;}rg(h=]rhh?]rihA]rjhC]rkhF]rluhHNhIhh-]rmh{XGonernro}rp(h2Uh3jeubaubj3)rq}rr(h2Uh3j>h4hh9j6h;}rs(h=]rth?]ruhA]rvhC]rwhF]rxuhHNhIhh-]ry(j>)rz}r{(h2Xdescription=Noner|h;}r}(h=]r~h?]rhA]rhC]rhF]ruh3jqh-]rh{Xdescription=Nonerr}r(h2Uh3jzubah9jLubj>)r}r(h2Xtraceback=Nonerh;}r(h=]rh?]rhA]rhC]rhF]ruh3jqh-]rh{Xtraceback=Nonerr}r(h2Uh3jubah9jLubeubeubjZ)r}r(h2Uh3j3h4hh9j]h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]r(h)r}r(h2X5Bases: :class:`circuits.web.exceptions.HTTPException`rh3jh4jhh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]r(h{XBases: rr}r(h2XBases: rh3jubhW)r}r(h2X.:class:`circuits.web.exceptions.HTTPException`rh3jh4h7h9h[h;}r(UreftyperXclassrh_h`X%circuits.web.exceptions.HTTPExceptionrU refdomainrXpyrhC]rhA]rU refexplicitrh=]rh?]rhF]rhjhkhlj0hmjuhHKh-]rho)r}r(h2jh;}r(h=]rh?]r(hujXpy-classrehA]rhC]rhF]ruh3jh-]rh{X%circuits.web.exceptions.HTTPExceptionrr}r(h2Uh3jubah9hubaubeubh)r}r(h2X *410* `Gone`rh3jh4j'h9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]r(jL)r}r(h2X*410*rh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{X410rr}r(h2Uh3jubah9jZubh{X r}r(h2X h3jubj])r}r(h2X`Gone`rh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{XGonerr}r(h2Uh3jubah9jkubeubh)r}r(h2XJRaise if a resource existed previously and went away without new location.rh3jh4j'h9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]rh{XJRaise if a resource existed previously and went away without new location.rr}r(h2jh3jubaubeubeubh)r}r(h2Uh3hh4Xp/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.InternalServerErrorrh9hh;}r(hC]rhA]rh=]rh?]rhF]rUentriesr]r(hXInternalServerErrorrhUtrauhHNhIhh-]rubh)r }r (h2Uh3hh4jh9hh;}r (hhXpyr hC]r hA]rh=]rh?]rhF]rhX exceptionrhjuhHNhIhh-]r(h)r}r(h2X5InternalServerError(description=None, traceback=None)rh3j h4hh9hh;}r(hC]rhahh5Xcircuits.web.exceptionsrr}rbhA]rh=]rh?]rhF]rhajjjUjuhHNhIhh-]r (j)r!}r"(h2X exception r#h3jh4hh9j h;}r$(h=]r%h?]r&hA]r'hC]r(hF]r)uhHNhIhh-]r*h{X exception r+r,}r-(h2Uh3j!ubaubj)r.}r/(h2Xcircuits.web.exceptions.r0h3jh4hh9jh;}r1(h=]r2h?]r3hA]r4hC]r5hF]r6uhHNhIhh-]r7h{Xcircuits.web.exceptions.r8r9}r:(h2Uh3j.ubaubj%)r;}r<(h2jh3jh4hh9j(h;}r=(h=]r>h?]r?hA]r@hC]rAhF]rBuhHNhIhh-]rCh{XInternalServerErrorrDrE}rF(h2Uh3j;ubaubj3)rG}rH(h2Uh3jh4hh9j6h;}rI(h=]rJh?]rKhA]rLhC]rMhF]rNuhHNhIhh-]rO(j>)rP}rQ(h2Xdescription=NonerRh;}rS(h=]rTh?]rUhA]rVhC]rWhF]rXuh3jGh-]rYh{Xdescription=NonerZr[}r\(h2Uh3jPubah9jLubj>)r]}r^(h2Xtraceback=Noner_h;}r`(h=]rah?]rbhA]rchC]rdhF]reuh3jGh-]rfh{Xtraceback=Nonergrh}ri(h2Uh3j]ubah9jLubeubeubjZ)rj}rk(h2Uh3j h4hh9j]h;}rl(h=]rmh?]rnhA]rohC]rphF]rquhHNhIhh-]rr(h)rs}rt(h2X5Bases: :class:`circuits.web.exceptions.HTTPException`ruh3jjh4jhh9hh;}rv(h=]rwh?]rxhA]ryhC]rzhF]r{uhHKhIhh-]r|(h{XBases: r}r~}r(h2XBases: rh3jsubhW)r}r(h2X.:class:`circuits.web.exceptions.HTTPException`rh3jsh4h7h9h[h;}r(UreftyperXclassrh_h`X%circuits.web.exceptions.HTTPExceptionrU refdomainrXpyrhC]rhA]rU refexplicitrh=]rh?]rhF]rhjhkhljhmjuhHKh-]rho)r}r(h2jh;}r(h=]rh?]r(hujXpy-classrehA]rhC]rhF]ruh3jh-]rh{X%circuits.web.exceptions.HTTPExceptionrr}r(h2Uh3jubah9hubaubeubh)r}r(h2X*500* `Internal Server Error`rh3jjh4jh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]r(jL)r}r(h2X*500*rh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{X500rr}r(h2Uh3jubah9jZubh{X r}r(h2X h3jubj])r}r(h2X`Internal Server Error`rh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{XInternal Server Errorrr}r(h2Uh3jubah9jkubeubh)r}r(h2XtRaise if an internal server error occurred. This is a good fallback if an unknown error occurred in the dispatcher.rh3jjh4jh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]rh{XtRaise if an internal server error occurred. This is a good fallback if an unknown error occurred in the dispatcher.rr}r(h2jh3jubaubeubeubh)r}r(h2Uh3hh4Xk/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.LengthRequiredrh9hh;}r(hC]rhA]rh=]rh?]rhF]rUentriesr]r(hXLengthRequiredrh UtrauhHNhIhh-]rubh)r}r(h2Uh3hh4jh9hh;}r(hhXpyrhC]rhA]rh=]rh?]rhF]rhX exceptionrhjuhHNhIhh-]r(h)r}r(h2X0LengthRequired(description=None, traceback=None)rh3jh4hh9hh;}r(hC]rh ahh5Xcircuits.web.exceptionsrr}rbhA]rh=]rh?]rhF]rh ajjjUjuhHNhIhh-]r(j)r}r(h2X exception rh3jh4hh9j h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{X exception rr}r(h2Uh3jubaubj)r}r(h2Xcircuits.web.exceptions.rh3jh4hh9jh;}r(h=]rh?]r hA]r hC]r hF]r uhHNhIhh-]r h{Xcircuits.web.exceptions.rr}r(h2Uh3jubaubj%)r}r(h2jh3jh4hh9j(h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{XLengthRequiredrr}r(h2Uh3jubaubj3)r}r(h2Uh3jh4hh9j6h;}r(h=]r h?]r!hA]r"hC]r#hF]r$uhHNhIhh-]r%(j>)r&}r'(h2Xdescription=Noner(h;}r)(h=]r*h?]r+hA]r,hC]r-hF]r.uh3jh-]r/h{Xdescription=Noner0r1}r2(h2Uh3j&ubah9jLubj>)r3}r4(h2Xtraceback=Noner5h;}r6(h=]r7h?]r8hA]r9hC]r:hF]r;uh3jh-]r<h{Xtraceback=Noner=r>}r?(h2Uh3j3ubah9jLubeubeubjZ)r@}rA(h2Uh3jh4hh9j]h;}rB(h=]rCh?]rDhA]rEhC]rFhF]rGuhHNhIhh-]rH(h)rI}rJ(h2X5Bases: :class:`circuits.web.exceptions.HTTPException`rKh3j@h4jhh9hh;}rL(h=]rMh?]rNhA]rOhC]rPhF]rQuhHKhIhh-]rR(h{XBases: rSrT}rU(h2XBases: rVh3jIubhW)rW}rX(h2X.:class:`circuits.web.exceptions.HTTPException`rYh3jIh4h7h9h[h;}rZ(Ureftyper[Xclassr\h_h`X%circuits.web.exceptions.HTTPExceptionr]U refdomainr^Xpyr_hC]r`hA]raU refexplicitrbh=]rch?]rdhF]rehjhkhljhmjuhHKh-]rfho)rg}rh(h2jYh;}ri(h=]rjh?]rk(huj_Xpy-classrlehA]rmhC]rnhF]rouh3jWh-]rph{X%circuits.web.exceptions.HTTPExceptionrqrr}rs(h2Uh3jgubah9hubaubeubh)rt}ru(h2X*411* `Length Required`rvh3j@h4jh9hh;}rw(h=]rxh?]ryhA]rzhC]r{hF]r|uhHKhIhh-]r}(jL)r~}r(h2X*411*rh;}r(h=]rh?]rhA]rhC]rhF]ruh3jth-]rh{X411rr}r(h2Uh3j~ubah9jZubh{X r}r(h2X h3jtubj])r}r(h2X`Length Required`rh;}r(h=]rh?]rhA]rhC]rhF]ruh3jth-]rh{XLength Requiredrr}r(h2Uh3jubah9jkubeubh)r}r(h2XRaise if the browser submitted data but no ``Content-Length`` header which is required for the kind of processing the server does.rh3j@h4jh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]r(h{X+Raise if the browser submitted data but no rr}r(h2X+Raise if the browser submitted data but no rh3jubho)r}r(h2X``Content-Length``rh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{XContent-Lengthrr}r(h2Uh3jubah9hubh{XE header which is required for the kind of processing the server does.rr}r(h2XE header which is required for the kind of processing the server does.rh3jubeubeubeubh)r}r(h2Uh3hh4Xm/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.MethodNotAllowedrh9hh;}r(hC]rhA]rh=]rh?]rhF]rUentriesr]r(hXMethodNotAllowedrhUtrauhHNhIhh-]rubh)r}r(h2Uh3hh4jh9hh;}r(hhXpyrhC]rhA]rh=]rh?]rhF]rhX exceptionrhjuhHNhIhh-]r(h)r}r(h2X*MethodNotAllowed(method, description=None)rh3jh4hh9hh;}r(hC]rhahh5Xcircuits.web.exceptionsrr}rbhA]rh=]rh?]rhF]rhajjjUjuhHNhIhh-]r(j)r}r(h2X exception rh3jh4hh9j h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{X exception rr}r(h2Uh3jubaubj)r}r(h2Xcircuits.web.exceptions.rh3jh4hh9jh;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{Xcircuits.web.exceptions.rr}r(h2Uh3jubaubj%)r}r(h2jh3jh4hh9j(h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{XMethodNotAllowedrr}r(h2Uh3jubaubj3)r}r(h2Uh3jh4hh9j6h;}r(h=]rh?]r hA]r hC]r hF]r uhHNhIhh-]r (j>)r}r(h2Xmethodrh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{Xmethodrr}r(h2Uh3jubah9jLubj>)r}r(h2Xdescription=Nonerh;}r(h=]rh?]r hA]r!hC]r"hF]r#uh3jh-]r$h{Xdescription=Noner%r&}r'(h2Uh3jubah9jLubeubeubjZ)r(}r)(h2Uh3jh4hh9j]h;}r*(h=]r+h?]r,hA]r-hC]r.hF]r/uhHNhIhh-]r0(h)r1}r2(h2X5Bases: :class:`circuits.web.exceptions.HTTPException`r3h3j(h4jhh9hh;}r4(h=]r5h?]r6hA]r7hC]r8hF]r9uhHKhIhh-]r:(h{XBases: r;r<}r=(h2XBases: r>h3j1ubhW)r?}r@(h2X.:class:`circuits.web.exceptions.HTTPException`rAh3j1h4h7h9h[h;}rB(UreftyperCXclassrDh_h`X%circuits.web.exceptions.HTTPExceptionrEU refdomainrFXpyrGhC]rHhA]rIU refexplicitrJh=]rKh?]rLhF]rMhjhkhljhmjuhHKh-]rNho)rO}rP(h2jAh;}rQ(h=]rRh?]rS(hujGXpy-classrTehA]rUhC]rVhF]rWuh3j?h-]rXh{X%circuits.web.exceptions.HTTPExceptionrYrZ}r[(h2Uh3jOubah9hubaubeubh)r\}r](h2X*405* `Method Not Allowed`r^h3j(h4jh9hh;}r_(h=]r`h?]rahA]rbhC]rchF]rduhHKhIhh-]re(jL)rf}rg(h2X*405*rhh;}ri(h=]rjh?]rkhA]rlhC]rmhF]rnuh3j\h-]roh{X405rprq}rr(h2Uh3jfubah9jZubh{X rs}rt(h2X h3j\ubj])ru}rv(h2X`Method Not Allowed`rwh;}rx(h=]ryh?]rzhA]r{hC]r|hF]r}uh3j\h-]r~h{XMethod Not Allowedrr}r(h2Uh3juubah9jkubeubh)r}r(h2XRaise if the server used a method the resource does not handle. For example `POST` if the resource is view only. Especially useful for REST.rh3j(h4jh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]r(h{XMRaise if the server used a method the resource does not handle. For example rr}r(h2XMRaise if the server used a method the resource does not handle. For example rh3jubj])r}r(h2X`POST`rh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{XPOSTrr}r(h2Uh3jubah9jkubh{X; if the resource is view only. Especially useful for REST.rr}r(h2X; if the resource is view only. Especially useful for REST.rh3jubeubh)r}r(h2XThe first argument for this exception should be a list of allowed methods. Strictly speaking the response would be invalid if you don't provide valid methods in the header which you can do with that list.rh3j(h4jh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]rh{XThe first argument for this exception should be a list of allowed methods. Strictly speaking the response would be invalid if you don't provide valid methods in the header which you can do with that list.rr}r(h2jh3jubaubeubeubh)r}r(h2Uh3hh4Xj/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.NotAcceptablerh9hh;}r(hC]rhA]rh=]rh?]rhF]rUentriesr]r(hX NotAcceptablerhUtrauhHNhIhh-]rubh)r}r(h2Uh3hh4jh9hh;}r(hhXpyrhC]rhA]rh=]rh?]rhF]rhX exceptionrhjuhHNhIhh-]r(h)r}r(h2X/NotAcceptable(description=None, traceback=None)rh3jh4hh9hh;}r(hC]rhahh5Xcircuits.web.exceptionsrr}rbhA]rh=]rh?]rhF]rhajjjUjuhHNhIhh-]r(j)r}r(h2X exception rh3jh4hh9j h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{X exception rr}r(h2Uh3jubaubj)r}r(h2Xcircuits.web.exceptions.rh3jh4hh9jh;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{Xcircuits.web.exceptions.rr}r(h2Uh3jubaubj%)r}r(h2jh3jh4hh9j(h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{X NotAcceptablerr}r(h2Uh3jubaubj3)r}r(h2Uh3jh4hh9j6h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]r(j>)r}r(h2Xdescription=Nonerh;}r(h=]rh?]rhA]r hC]r hF]r uh3jh-]r h{Xdescription=Noner r}r(h2Uh3jubah9jLubj>)r}r(h2Xtraceback=Nonerh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{Xtraceback=Nonerr}r(h2Uh3jubah9jLubeubeubjZ)r}r(h2Uh3jh4hh9j]h;}r(h=]r h?]r!hA]r"hC]r#hF]r$uhHNhIhh-]r%(h)r&}r'(h2X5Bases: :class:`circuits.web.exceptions.HTTPException`r(h3jh4jhh9hh;}r)(h=]r*h?]r+hA]r,hC]r-hF]r.uhHKhIhh-]r/(h{XBases: r0r1}r2(h2XBases: r3h3j&ubhW)r4}r5(h2X.:class:`circuits.web.exceptions.HTTPException`r6h3j&h4h7h9h[h;}r7(Ureftyper8Xclassr9h_h`X%circuits.web.exceptions.HTTPExceptionr:U refdomainr;Xpyr<hC]r=hA]r>U refexplicitr?h=]r@h?]rAhF]rBhjhkhljhmjuhHKh-]rCho)rD}rE(h2j6h;}rF(h=]rGh?]rH(huj<Xpy-classrIehA]rJhC]rKhF]rLuh3j4h-]rMh{X%circuits.web.exceptions.HTTPExceptionrNrO}rP(h2Uh3jDubah9hubaubeubh)rQ}rR(h2X*406* `Not Acceptable`rSh3jh4jh9hh;}rT(h=]rUh?]rVhA]rWhC]rXhF]rYuhHKhIhh-]rZ(jL)r[}r\(h2X*406*r]h;}r^(h=]r_h?]r`hA]rahC]rbhF]rcuh3jQh-]rdh{X406rerf}rg(h2Uh3j[ubah9jZubh{X rh}ri(h2X h3jQubj])rj}rk(h2X`Not Acceptable`rlh;}rm(h=]rnh?]rohA]rphC]rqhF]rruh3jQh-]rsh{XNot Acceptablertru}rv(h2Uh3jjubah9jkubeubh)rw}rx(h2X^Raise if the server can't return any content conforming to the `Accept` headers of the client.ryh3jh4jh9hh;}rz(h=]r{h?]r|hA]r}hC]r~hF]ruhHKhIhh-]r(h{X?Raise if the server can't return any content conforming to the rr}r(h2X?Raise if the server can't return any content conforming to the rh3jwubj])r}r(h2X`Accept`rh;}r(h=]rh?]rhA]rhC]rhF]ruh3jwh-]rh{XAcceptrr}r(h2Uh3jubah9jkubh{X headers of the client.rr}r(h2X headers of the client.rh3jwubeubeubeubh)r}r(h2Uh3hh4Xe/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.NotFoundrh9hh;}r(hC]rhA]rh=]rh?]rhF]rUentriesr]r(hXNotFoundrhUtrauhHNhIhh-]rubh)r}r(h2Uh3hh4jh9hh;}r(hhXpyrhC]rhA]rh=]rh?]rhF]rhX exceptionrhjuhHNhIhh-]r(h)r}r(h2X*NotFound(description=None, traceback=None)rh3jh4hh9hh;}r(hC]rhahh5Xcircuits.web.exceptionsrr}rbhA]rh=]rh?]rhF]rhajjjUjuhHNhIhh-]r(j)r}r(h2X exception rh3jh4hh9j h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{X exception rr}r(h2Uh3jubaubj)r}r(h2Xcircuits.web.exceptions.rh3jh4hh9jh;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{Xcircuits.web.exceptions.rr}r(h2Uh3jubaubj%)r}r(h2jh3jh4hh9j(h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{XNotFoundrr}r(h2Uh3jubaubj3)r}r(h2Uh3jh4hh9j6h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]r(j>)r}r(h2Xdescription=Nonerh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{Xdescription=Nonerr}r(h2Uh3jubah9jLubj>)r}r(h2Xtraceback=Nonerh;}r(h=]rh?]rhA]rhC]rhF]r uh3jh-]r h{Xtraceback=Noner r }r (h2Uh3jubah9jLubeubeubjZ)r }r (h2Uh3jh4hh9j]h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r (h)r }r (h2X5Bases: :class:`circuits.web.exceptions.HTTPException`r h3j h4jhh9hh;}r (h=]r h?]r hA]r hC]r hF]r uhHKhIhh-]r (h{XBases: r r }r (h2XBases: r h3j ubhW)r }r (h2X.:class:`circuits.web.exceptions.HTTPException`r h3j h4h7h9h[h;}r (Ureftyper Xclassr! h_h`X%circuits.web.exceptions.HTTPExceptionr" U refdomainr# Xpyr$ hC]r% hA]r& U refexplicitr' h=]r( h?]r) hF]r* hjhkhljhmjuhHKh-]r+ ho)r, }r- (h2j h;}r. (h=]r/ h?]r0 (huj$ Xpy-classr1 ehA]r2 hC]r3 hF]r4 uh3j h-]r5 h{X%circuits.web.exceptions.HTTPExceptionr6 r7 }r8 (h2Uh3j, ubah9hubaubeubh)r9 }r: (h2X*404* `Not Found`r; h3j h4jh9hh;}r< (h=]r= h?]r> hA]r? hC]r@ hF]rA uhHKhIhh-]rB (jL)rC }rD (h2X*404*rE h;}rF (h=]rG h?]rH hA]rI hC]rJ hF]rK uh3j9 h-]rL h{X404rM rN }rO (h2Uh3jC ubah9jZubh{X rP }rQ (h2X h3j9 ubj])rR }rS (h2X `Not Found`rT h;}rU (h=]rV h?]rW hA]rX hC]rY hF]rZ uh3j9 h-]r[ h{X Not Foundr\ r] }r^ (h2Uh3jR ubah9jkubeubh)r_ }r` (h2X5Raise if a resource does not exist and never existed.ra h3j h4jh9hh;}rb (h=]rc h?]rd hA]re hC]rf hF]rg uhHKhIhh-]rh h{X5Raise if a resource does not exist and never existed.ri rj }rk (h2ja h3j_ ubaubeubeubh)rl }rm (h2Uh3hh4Xk/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.NotImplementedrn h9hh;}ro (hC]rp hA]rq h=]rr h?]rs hF]rt Uentriesru ]rv (hXNotImplementedrw hUtrx auhHNhIhh-]ry ubh)rz }r{ (h2Uh3hh4jn h9hh;}r| (hhXpyr} hC]r~ hA]r h=]r h?]r hF]r hX exceptionr hj uhHNhIhh-]r (h)r }r (h2X0NotImplemented(description=None, traceback=None)r h3jz h4hh9hh;}r (hC]r hahh5Xcircuits.web.exceptionsr r }r bhA]r h=]r h?]r hF]r hajjw jUjuhHNhIhh-]r (j)r }r (h2X exception r h3j h4hh9j h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r h{X exception r r }r (h2Uh3j ubaubj)r }r (h2Xcircuits.web.exceptions.r h3j h4hh9jh;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r h{Xcircuits.web.exceptions.r r }r (h2Uh3j ubaubj%)r }r (h2jw h3j h4hh9j(h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r h{XNotImplementedr r }r (h2Uh3j ubaubj3)r }r (h2Uh3j h4hh9j6h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r (j>)r }r (h2Xdescription=Noner h;}r (h=]r h?]r hA]r hC]r hF]r uh3j h-]r h{Xdescription=Noner r }r (h2Uh3j ubah9jLubj>)r }r (h2Xtraceback=Noner h;}r (h=]r h?]r hA]r hC]r hF]r uh3j h-]r h{Xtraceback=Noner r }r (h2Uh3j ubah9jLubeubeubjZ)r }r (h2Uh3jz h4hh9j]h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r (h)r }r (h2X5Bases: :class:`circuits.web.exceptions.HTTPException`r h3j h4jhh9hh;}r (h=]r h?]r hA]r hC]r hF]r uhHKhIhh-]r (h{XBases: r r }r (h2XBases: r h3j ubhW)r }r (h2X.:class:`circuits.web.exceptions.HTTPException`r h3j h4h7h9h[h;}r (Ureftyper Xclassr h_h`X%circuits.web.exceptions.HTTPExceptionr U refdomainr Xpyr hC]r hA]r U refexplicitr h=]r h?]r hF]r hjhkhljw hmjuhHKh-]r ho)r }r (h2j h;}r (h=]r h?]r (huj Xpy-classr ehA]r hC]r hF]r uh3j h-]r h{X%circuits.web.exceptions.HTTPExceptionr r }r (h2Uh3j ubah9hubaubeubh)r }r (h2X*501* `Not Implemented`r h3j h4jn h9hh;}r (h=]r h?]r hA]r hC]r hF]r uhHKhIhh-]r (jL)r }r (h2X*501*r h;}r (h=]r h?]r hA]r hC]r hF]r! uh3j h-]r" h{X501r# r$ }r% (h2Uh3j ubah9jZubh{X r& }r' (h2X h3j ubj])r( }r) (h2X`Not Implemented`r* h;}r+ (h=]r, h?]r- hA]r. hC]r/ hF]r0 uh3j h-]r1 h{XNot Implementedr2 r3 }r4 (h2Uh3j( ubah9jkubeubh)r5 }r6 (h2XNRaise if the application does not support the action requested by the browser.r7 h3j h4jn h9hh;}r8 (h=]r9 h?]r: hA]r; hC]r< hF]r= uhHKhIhh-]r> h{XNRaise if the application does not support the action requested by the browser.r? r@ }rA (h2j7 h3j5 ubaubeubeubh)rB }rC (h2Uh3hh4Xo/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.PreconditionFailedrD h9hh;}rE (hC]rF hA]rG h=]rH h?]rI hF]rJ UentriesrK ]rL (hXPreconditionFailedrM hUtrN auhHNhIhh-]rO ubh)rP }rQ (h2Uh3hh4jD h9hh;}rR (hhXpyrS hC]rT hA]rU h=]rV h?]rW hF]rX hX exceptionrY hjY uhHNhIhh-]rZ (h)r[ }r\ (h2X4PreconditionFailed(description=None, traceback=None)r] h3jP h4hh9hh;}r^ (hC]r_ hahh5Xcircuits.web.exceptionsr` ra }rb bhA]rc h=]rd h?]re hF]rf hajjM jUjuhHNhIhh-]rg (j)rh }ri (h2X exception rj h3j[ h4hh9j h;}rk (h=]rl h?]rm hA]rn hC]ro hF]rp uhHNhIhh-]rq h{X exception rr rs }rt (h2Uh3jh ubaubj)ru }rv (h2Xcircuits.web.exceptions.rw h3j[ h4hh9jh;}rx (h=]ry h?]rz hA]r{ hC]r| hF]r} uhHNhIhh-]r~ h{Xcircuits.web.exceptions.r r }r (h2Uh3ju ubaubj%)r }r (h2jM h3j[ h4hh9j(h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r h{XPreconditionFailedr r }r (h2Uh3j ubaubj3)r }r (h2Uh3j[ h4hh9j6h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r (j>)r }r (h2Xdescription=Noner h;}r (h=]r h?]r hA]r hC]r hF]r uh3j h-]r h{Xdescription=Noner r }r (h2Uh3j ubah9jLubj>)r }r (h2Xtraceback=Noner h;}r (h=]r h?]r hA]r hC]r hF]r uh3j h-]r h{Xtraceback=Noner r }r (h2Uh3j ubah9jLubeubeubjZ)r }r (h2Uh3jP h4hh9j]h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r (h)r }r (h2X5Bases: :class:`circuits.web.exceptions.HTTPException`r h3j h4jhh9hh;}r (h=]r h?]r hA]r hC]r hF]r uhHKhIhh-]r (h{XBases: r r }r (h2XBases: r h3j ubhW)r }r (h2X.:class:`circuits.web.exceptions.HTTPException`r h3j h4h7h9h[h;}r (Ureftyper Xclassr h_h`X%circuits.web.exceptions.HTTPExceptionr U refdomainr Xpyr hC]r hA]r U refexplicitr h=]r h?]r hF]r hjhkhljM hmjuhHKh-]r ho)r }r (h2j h;}r (h=]r h?]r (huj Xpy-classr ehA]r hC]r hF]r uh3j h-]r h{X%circuits.web.exceptions.HTTPExceptionr r }r (h2Uh3j ubah9hubaubeubh)r }r (h2X*412* `Precondition Failed`r h3j h4jD h9hh;}r (h=]r h?]r hA]r hC]r hF]r uhHKhIhh-]r (jL)r }r (h2X*412*r h;}r (h=]r h?]r hA]r hC]r hF]r uh3j h-]r h{X412r r }r (h2Uh3j ubah9jZubh{X r }r (h2X h3j ubj])r }r (h2X`Precondition Failed`r h;}r (h=]r h?]r hA]r hC]r hF]r uh3j h-]r h{XPrecondition Failedr r }r (h2Uh3j ubah9jkubeubh)r }r (h2XaStatus code used in combination with ``If-Match``, ``If-None-Match``, or ``If-Unmodified-Since``.r h3j h4jD h9hh;}r (h=]r h?]r hA]r hC]r hF]r uhHKhIhh-]r (h{X%Status code used in combination with r r }r (h2X%Status code used in combination with r h3j ubho)r }r (h2X ``If-Match``r h;}r (h=]r h?]r hA]r hC]r hF]r! uh3j h-]r" h{XIf-Matchr# r$ }r% (h2Uh3j ubah9hubh{X, r& r' }r( (h2X, r) h3j ubho)r* }r+ (h2X``If-None-Match``r, h;}r- (h=]r. h?]r/ hA]r0 hC]r1 hF]r2 uh3j h-]r3 h{X If-None-Matchr4 r5 }r6 (h2Uh3j* ubah9hubh{X, or r7 r8 }r9 (h2X, or r: h3j ubho)r; }r< (h2X``If-Unmodified-Since``r= h;}r> (h=]r? h?]r@ hA]rA hC]rB hF]rC uh3j h-]rD h{XIf-Unmodified-SincerE rF }rG (h2Uh3j; ubah9hubh{X.rH }rI (h2X.h3j ubeubeubeubh)rJ }rK (h2Uh3hh4jhh9hh;}rL (hC]rM hA]rN h=]rO h?]rP hF]rQ UentriesrR ]rS (hXRedirectrT hUtrU auhHNhIhh-]rV ubh)rW }rX (h2Uh3hh4jhh9hh;}rY (hhXpyrZ hC]r[ hA]r\ h=]r] h?]r^ hF]r_ hX exceptionr` hj` uhHNhIhh-]ra (h)rb }rc (h2XRedirect(urls, status=None)rd h3jW h4hh9hh;}re (hC]rf hahh5Xcircuits.web.exceptionsrg rh }ri bhA]rj h=]rk h?]rl hF]rm hajjT jUjuhHNhIhh-]rn (j)ro }rp (h2X exception rq h3jb h4hh9j h;}rr (h=]rs h?]rt hA]ru hC]rv hF]rw uhHNhIhh-]rx h{X exception ry rz }r{ (h2Uh3jo ubaubj)r| }r} (h2Xcircuits.web.exceptions.r~ h3jb h4hh9jh;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r h{Xcircuits.web.exceptions.r r }r (h2Uh3j| ubaubj%)r }r (h2jT h3jb h4hh9j(h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r h{XRedirectr r }r (h2Uh3j ubaubj3)r }r (h2Uh3jb h4hh9j6h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r (j>)r }r (h2Xurlsr h;}r (h=]r h?]r hA]r hC]r hF]r uh3j h-]r h{Xurlsr r }r (h2Uh3j ubah9jLubj>)r }r (h2X status=Noner h;}r (h=]r h?]r hA]r hC]r hF]r uh3j h-]r h{X status=Noner r }r (h2Uh3j ubah9jLubeubeubjZ)r }r (h2Uh3jW h4hh9j]h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r h)r }r (h2X5Bases: :class:`circuits.web.exceptions.HTTPException`r h3j h4jhh9hh;}r (h=]r h?]r hA]r hC]r hF]r uhHKhIhh-]r (h{XBases: r r }r (h2XBases: r h3j ubhW)r }r (h2X.:class:`circuits.web.exceptions.HTTPException`r h3j h4h7h9h[h;}r (Ureftyper Xclassr h_h`X%circuits.web.exceptions.HTTPExceptionr U refdomainr Xpyr hC]r hA]r U refexplicitr h=]r h?]r hF]r hjhkhljT hmjuhHKh-]r ho)r }r (h2j h;}r (h=]r h?]r (huj Xpy-classr ehA]r hC]r hF]r uh3j h-]r h{X%circuits.web.exceptions.HTTPExceptionr r }r (h2Uh3j ubah9hubaubeubaubeubh)r }r (h2Uh3hh4Xr/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.RequestEntityTooLarger h9hh;}r (hC]r hA]r h=]r h?]r hF]r Uentriesr ]r (hXRequestEntityTooLarger h Utr auhHNhIhh-]r ubh)r }r (h2Uh3hh4j h9hh;}r (hhXpyr hC]r hA]r h=]r h?]r hF]r hX exceptionr hj uhHNhIhh-]r (h)r }r (h2X7RequestEntityTooLarge(description=None, traceback=None)r h3j h4hh9hh;}r (hC]r h ahh5Xcircuits.web.exceptionsr r }r bhA]r h=]r h?]r hF]r h ajj jUjuhHNhIhh-]r (j)r }r (h2X exception r h3j h4hh9j h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r h{X exception r r }r (h2Uh3j ubaubj)r }r (h2Xcircuits.web.exceptions.r! h3j h4hh9jh;}r" (h=]r# h?]r$ hA]r% hC]r& hF]r' uhHNhIhh-]r( h{Xcircuits.web.exceptions.r) r* }r+ (h2Uh3j ubaubj%)r, }r- (h2j h3j h4hh9j(h;}r. (h=]r/ h?]r0 hA]r1 hC]r2 hF]r3 uhHNhIhh-]r4 h{XRequestEntityTooLarger5 r6 }r7 (h2Uh3j, ubaubj3)r8 }r9 (h2Uh3j h4hh9j6h;}r: (h=]r; h?]r< hA]r= hC]r> hF]r? uhHNhIhh-]r@ (j>)rA }rB (h2Xdescription=NonerC h;}rD (h=]rE h?]rF hA]rG hC]rH hF]rI uh3j8 h-]rJ h{Xdescription=NonerK rL }rM (h2Uh3jA ubah9jLubj>)rN }rO (h2Xtraceback=NonerP h;}rQ (h=]rR h?]rS hA]rT hC]rU hF]rV uh3j8 h-]rW h{Xtraceback=NonerX rY }rZ (h2Uh3jN ubah9jLubeubeubjZ)r[ }r\ (h2Uh3j h4hh9j]h;}r] (h=]r^ h?]r_ hA]r` hC]ra hF]rb uhHNhIhh-]rc (h)rd }re (h2X5Bases: :class:`circuits.web.exceptions.HTTPException`rf h3j[ h4jhh9hh;}rg (h=]rh h?]ri hA]rj hC]rk hF]rl uhHKhIhh-]rm (h{XBases: rn ro }rp (h2XBases: rq h3jd ubhW)rr }rs (h2X.:class:`circuits.web.exceptions.HTTPException`rt h3jd h4h7h9h[h;}ru (Ureftyperv Xclassrw h_h`X%circuits.web.exceptions.HTTPExceptionrx U refdomainry Xpyrz hC]r{ hA]r| U refexplicitr} h=]r~ h?]r hF]r hjhkhlj hmjuhHKh-]r ho)r }r (h2jt h;}r (h=]r h?]r (hujz Xpy-classr ehA]r hC]r hF]r uh3jr h-]r h{X%circuits.web.exceptions.HTTPExceptionr r }r (h2Uh3j ubah9hubaubeubh)r }r (h2X *413* `Request Entity Too Large`r h3j[ h4j h9hh;}r (h=]r h?]r hA]r hC]r hF]r uhHKhIhh-]r (jL)r }r (h2X*413*r h;}r (h=]r h?]r hA]r hC]r hF]r uh3j h-]r h{X413r r }r (h2Uh3j ubah9jZubh{X r }r (h2X h3j ubj])r }r (h2X`Request Entity Too Large`r h;}r (h=]r h?]r hA]r hC]r hF]r uh3j h-]r h{XRequest Entity Too Larger r }r (h2Uh3j ubah9jkubeubh)r }r (h2XOThe status code one should return if the data submitted exceeded a given limit.r h3j[ h4j h9hh;}r (h=]r h?]r hA]r hC]r hF]r uhHKhIhh-]r h{XOThe status code one should return if the data submitted exceeded a given limit.r r }r (h2j h3j ubaubeubeubh)r }r (h2Uh3hh4Xk/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.RequestTimeoutr h9hh;}r (hC]r hA]r h=]r h?]r hF]r Uentriesr ]r (hXRequestTimeoutr hUtr auhHNhIhh-]r ubh)r }r (h2Uh3hh4j h9hh;}r (hhXpyr hC]r hA]r h=]r h?]r hF]r hX exceptionr hj uhHNhIhh-]r (h)r }r (h2X0RequestTimeout(description=None, traceback=None)r h3j h4hh9hh;}r (hC]r hahh5Xcircuits.web.exceptionsr r }r bhA]r h=]r h?]r hF]r hajj jUjuhHNhIhh-]r (j)r }r (h2X exception r h3j h4hh9j h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r h{X exception r r }r (h2Uh3j ubaubj)r }r (h2Xcircuits.web.exceptions.r h3j h4hh9jh;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r h{Xcircuits.web.exceptions.r r }r (h2Uh3j ubaubj%)r }r (h2j h3j h4hh9j(h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r h{XRequestTimeoutr r }r (h2Uh3j ubaubj3)r }r (h2Uh3j h4hh9j6h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r (j>)r }r (h2Xdescription=Noner h;}r (h=]r h?]r hA]r hC]r hF]r uh3j h-]r h{Xdescription=Noner! r" }r# (h2Uh3j ubah9jLubj>)r$ }r% (h2Xtraceback=Noner& h;}r' (h=]r( h?]r) hA]r* hC]r+ hF]r, uh3j h-]r- h{Xtraceback=Noner. r/ }r0 (h2Uh3j$ ubah9jLubeubeubjZ)r1 }r2 (h2Uh3j h4hh9j]h;}r3 (h=]r4 h?]r5 hA]r6 hC]r7 hF]r8 uhHNhIhh-]r9 (h)r: }r; (h2X5Bases: :class:`circuits.web.exceptions.HTTPException`r< h3j1 h4jhh9hh;}r= (h=]r> h?]r? hA]r@ hC]rA hF]rB uhHKhIhh-]rC (h{XBases: rD rE }rF (h2XBases: rG h3j: ubhW)rH }rI (h2X.:class:`circuits.web.exceptions.HTTPException`rJ h3j: h4h7h9h[h;}rK (UreftyperL XclassrM h_h`X%circuits.web.exceptions.HTTPExceptionrN U refdomainrO XpyrP hC]rQ hA]rR U refexplicitrS h=]rT h?]rU hF]rV hjhkhlj hmjuhHKh-]rW ho)rX }rY (h2jJ h;}rZ (h=]r[ h?]r\ (hujP Xpy-classr] ehA]r^ hC]r_ hF]r` uh3jH h-]ra h{X%circuits.web.exceptions.HTTPExceptionrb rc }rd (h2Uh3jX ubah9hubaubeubh)re }rf (h2X*408* `Request Timeout`rg h3j1 h4j h9hh;}rh (h=]ri h?]rj hA]rk hC]rl hF]rm uhHKhIhh-]rn (jL)ro }rp (h2X*408*rq h;}rr (h=]rs h?]rt hA]ru hC]rv hF]rw uh3je h-]rx h{X408ry rz }r{ (h2Uh3jo ubah9jZubh{X r| }r} (h2X h3je ubj])r~ }r (h2X`Request Timeout`r h;}r (h=]r h?]r hA]r hC]r hF]r uh3je h-]r h{XRequest Timeoutr r }r (h2Uh3j~ ubah9jkubeubh)r }r (h2XRaise to signalize a timeout.r h3j1 h4j h9hh;}r (h=]r h?]r hA]r hC]r hF]r uhHKhIhh-]r h{XRaise to signalize a timeout.r r }r (h2j h3j ubaubeubeubh)r }r (h2Uh3hh4Xo/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.RequestURITooLarger h9hh;}r (hC]r hA]r h=]r h?]r hF]r Uentriesr ]r (hXRequestURITooLarger h Utr auhHNhIhh-]r ubh)r }r (h2Uh3hh4j h9hh;}r (hhXpyr hC]r hA]r h=]r h?]r hF]r hX exceptionr hj uhHNhIhh-]r (h)r }r (h2X4RequestURITooLarge(description=None, traceback=None)r h3j h4hh9hh;}r (hC]r h ahh5Xcircuits.web.exceptionsr r }r bhA]r h=]r h?]r hF]r h ajj jUjuhHNhIhh-]r (j)r }r (h2X exception r h3j h4hh9j h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r h{X exception r r }r (h2Uh3j ubaubj)r }r (h2Xcircuits.web.exceptions.r h3j h4hh9jh;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r h{Xcircuits.web.exceptions.r r }r (h2Uh3j ubaubj%)r }r (h2j h3j h4hh9j(h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r h{XRequestURITooLarger r }r (h2Uh3j ubaubj3)r }r (h2Uh3j h4hh9j6h;}r (h=]r h?]r hA]r hC]r hF]r uhHNhIhh-]r (j>)r }r (h2Xdescription=Noner h;}r (h=]r h?]r hA]r hC]r hF]r uh3j h-]r h{Xdescription=Noner r }r (h2Uh3j ubah9jLubj>)r }r (h2Xtraceback=Noner h;}r (h=]r h?]r hA]rhC]rhF]ruh3j h-]rh{Xtraceback=Nonerr}r(h2Uh3j ubah9jLubeubeubjZ)r}r(h2Uh3j h4hh9j]h;}r (h=]r h?]r hA]r hC]r hF]ruhHNhIhh-]r(h)r}r(h2X5Bases: :class:`circuits.web.exceptions.HTTPException`rh3jh4jhh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]r(h{XBases: rr}r(h2XBases: rh3jubhW)r}r(h2X.:class:`circuits.web.exceptions.HTTPException`r h3jh4h7h9h[h;}r!(Ureftyper"Xclassr#h_h`X%circuits.web.exceptions.HTTPExceptionr$U refdomainr%Xpyr&hC]r'hA]r(U refexplicitr)h=]r*h?]r+hF]r,hjhkhlj hmjuhHKh-]r-ho)r.}r/(h2j h;}r0(h=]r1h?]r2(huj&Xpy-classr3ehA]r4hC]r5hF]r6uh3jh-]r7h{X%circuits.web.exceptions.HTTPExceptionr8r9}r:(h2Uh3j.ubah9hubaubeubh)r;}r<(h2X*414* `Request URI Too Large`r=h3jh4j h9hh;}r>(h=]r?h?]r@hA]rAhC]rBhF]rCuhHKhIhh-]rD(jL)rE}rF(h2X*414*rGh;}rH(h=]rIh?]rJhA]rKhC]rLhF]rMuh3j;h-]rNh{X414rOrP}rQ(h2Uh3jEubah9jZubh{X rR}rS(h2X h3j;ubj])rT}rU(h2X`Request URI Too Large`rVh;}rW(h=]rXh?]rYhA]rZhC]r[hF]r\uh3j;h-]r]h{XRequest URI Too Larger^r_}r`(h2Uh3jTubah9jkubeubh)ra}rb(h2X!Like *413* but for too long URLs.rch3jh4j h9hh;}rd(h=]reh?]rfhA]rghC]rhhF]riuhHKhIhh-]rj(h{XLike rkrl}rm(h2XLike rnh3jaubjL)ro}rp(h2X*413*rqh;}rr(h=]rsh?]rthA]ruhC]rvhF]rwuh3jah-]rxh{X413ryrz}r{(h2Uh3joubah9jZubh{X but for too long URLs.r|r}}r~(h2X but for too long URLs.rh3jaubeubeubeubh)r}r(h2Uh3hh4Xo/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.ServiceUnavailablerh9hh;}r(hC]rhA]rh=]rh?]rhF]rUentriesr]r(hXServiceUnavailablerh UtrauhHNhIhh-]rubh)r}r(h2Uh3hh4jh9hh;}r(hhXpyrhC]rhA]rh=]rh?]rhF]rhX exceptionrhjuhHNhIhh-]r(h)r}r(h2X4ServiceUnavailable(description=None, traceback=None)rh3jh4hh9hh;}r(hC]rh ahh5Xcircuits.web.exceptionsrr}rbhA]rh=]rh?]rhF]rh ajjjUjuhHNhIhh-]r(j)r}r(h2X exception rh3jh4hh9j h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{X exception rr}r(h2Uh3jubaubj)r}r(h2Xcircuits.web.exceptions.rh3jh4hh9jh;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{Xcircuits.web.exceptions.rr}r(h2Uh3jubaubj%)r}r(h2jh3jh4hh9j(h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{XServiceUnavailablerr}r(h2Uh3jubaubj3)r}r(h2Uh3jh4hh9j6h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]r(j>)r}r(h2Xdescription=Nonerh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{Xdescription=Nonerr}r(h2Uh3jubah9jLubj>)r}r(h2Xtraceback=Nonerh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{Xtraceback=Nonerr}r(h2Uh3jubah9jLubeubeubjZ)r}r(h2Uh3jh4hh9j]h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]r(h)r}r(h2X5Bases: :class:`circuits.web.exceptions.HTTPException`rh3jh4jhh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]r(h{XBases: rr}r(h2XBases: rh3jubhW)r}r(h2X.:class:`circuits.web.exceptions.HTTPException`rh3jh4h7h9h[h;}r (Ureftyper Xclassr h_h`X%circuits.web.exceptions.HTTPExceptionr U refdomainr XpyrhC]rhA]rU refexplicitrh=]rh?]rhF]rhjhkhljhmjuhHKh-]rho)r}r(h2jh;}r(h=]rh?]r(hujXpy-classrehA]rhC]rhF]ruh3jh-]rh{X%circuits.web.exceptions.HTTPExceptionr r!}r"(h2Uh3jubah9hubaubeubh)r#}r$(h2X*503* `Service Unavailable`r%h3jh4jh9hh;}r&(h=]r'h?]r(hA]r)hC]r*hF]r+uhHKhIhh-]r,(jL)r-}r.(h2X*503*r/h;}r0(h=]r1h?]r2hA]r3hC]r4hF]r5uh3j#h-]r6h{X503r7r8}r9(h2Uh3j-ubah9jZubh{X r:}r;(h2X h3j#ubj])r<}r=(h2X`Service Unavailable`r>h;}r?(h=]r@h?]rAhA]rBhC]rChF]rDuh3j#h-]rEh{XService UnavailablerFrG}rH(h2Uh3j<ubah9jkubeubh)rI}rJ(h2XFStatus code you should return if a service is temporarily unavailable.rKh3jh4jh9hh;}rL(h=]rMh?]rNhA]rOhC]rPhF]rQuhHKhIhh-]rRh{XFStatus code you should return if a service is temporarily unavailable.rSrT}rU(h2jKh3jIubaubeubeubh)rV}rW(h2Uh3hh4Xi/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.UnauthorizedrXh9hh;}rY(hC]rZhA]r[h=]r\h?]r]hF]r^Uentriesr_]r`(hX UnauthorizedrahUtrbauhHNhIhh-]rcubh)rd}re(h2Uh3hh4jXh9hh;}rf(hhXpyrghC]rhhA]rih=]rjh?]rkhF]rlhX exceptionrmhjmuhHNhIhh-]rn(h)ro}rp(h2X.Unauthorized(description=None, traceback=None)rqh3jdh4hh9hh;}rr(hC]rshahh5Xcircuits.web.exceptionsrtru}rvbhA]rwh=]rxh?]ryhF]rzhajjajUjuhHNhIhh-]r{(j)r|}r}(h2X exception r~h3joh4hh9j h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{X exception rr}r(h2Uh3j|ubaubj)r}r(h2Xcircuits.web.exceptions.rh3joh4hh9jh;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{Xcircuits.web.exceptions.rr}r(h2Uh3jubaubj%)r}r(h2jah3joh4hh9j(h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{X Unauthorizedrr}r(h2Uh3jubaubj3)r}r(h2Uh3joh4hh9j6h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]r(j>)r}r(h2Xdescription=Nonerh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{Xdescription=Nonerr}r(h2Uh3jubah9jLubj>)r}r(h2Xtraceback=Nonerh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{Xtraceback=Nonerr}r(h2Uh3jubah9jLubeubeubjZ)r}r(h2Uh3jdh4hh9j]h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]r(h)r}r(h2X5Bases: :class:`circuits.web.exceptions.HTTPException`rh3jh4jhh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]r(h{XBases: rr}r(h2XBases: rh3jubhW)r}r(h2X.:class:`circuits.web.exceptions.HTTPException`rh3jh4h7h9h[h;}r(UreftyperXclassrh_h`X%circuits.web.exceptions.HTTPExceptionrU refdomainrXpyrhC]rhA]rU refexplicitrh=]rh?]rhF]rhjhkhljahmjuhHKh-]rho)r}r(h2jh;}r(h=]rh?]r(hujXpy-classrehA]rhC]rhF]ruh3jh-]rh{X%circuits.web.exceptions.HTTPExceptionrr}r(h2Uh3jubah9hubaubeubh)r}r(h2X*401* `Unauthorized`rh3jh4jXh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]r(jL)r}r(h2X*401*rh;}r(h=]rh?]rhA]r hC]r hF]r uh3jh-]r h{X401r r}r(h2Uh3jubah9jZubh{X r}r(h2X h3jubj])r}r(h2X`Unauthorized`rh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{X Unauthorizedrr}r(h2Uh3jubah9jkubeubh)r}r (h2XSRaise if the user is not authorized. Also used if you want to use HTTP basic auth.r!h3jh4jXh9hh;}r"(h=]r#h?]r$hA]r%hC]r&hF]r'uhHKhIhh-]r(h{XSRaise if the user is not authorized. Also used if you want to use HTTP basic auth.r)r*}r+(h2j!h3jubaubeubeubh)r,}r-(h2Uh3hh4Xi/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.UnicodeErrorr.h9hh;}r/(hC]r0hA]r1h=]r2h?]r3hF]r4Uentriesr5]r6(hX UnicodeErrorr7hUtr8auhHNhIhh-]r9ubh)r:}r;(h2Uh3hh4j.h9hh;}r<(hhXpyr=hC]r>hA]r?h=]r@h?]rAhF]rBhX exceptionrChjCuhHNhIhh-]rD(h)rE}rF(h2X.UnicodeError(description=None, traceback=None)rGh3j:h4hh9hh;}rH(hC]rIhahh5Xcircuits.web.exceptionsrJrK}rLbhA]rMh=]rNh?]rOhF]rPhajj7jUjuhHNhIhh-]rQ(j)rR}rS(h2X exception rTh3jEh4hh9j h;}rU(h=]rVh?]rWhA]rXhC]rYhF]rZuhHNhIhh-]r[h{X exception r\r]}r^(h2Uh3jRubaubj)r_}r`(h2Xcircuits.web.exceptions.rah3jEh4hh9jh;}rb(h=]rch?]rdhA]rehC]rfhF]rguhHNhIhh-]rhh{Xcircuits.web.exceptions.rirj}rk(h2Uh3j_ubaubj%)rl}rm(h2j7h3jEh4hh9j(h;}rn(h=]roh?]rphA]rqhC]rrhF]rsuhHNhIhh-]rth{X UnicodeErrorrurv}rw(h2Uh3jlubaubj3)rx}ry(h2Uh3jEh4hh9j6h;}rz(h=]r{h?]r|hA]r}hC]r~hF]ruhHNhIhh-]r(j>)r}r(h2Xdescription=Nonerh;}r(h=]rh?]rhA]rhC]rhF]ruh3jxh-]rh{Xdescription=Nonerr}r(h2Uh3jubah9jLubj>)r}r(h2Xtraceback=Nonerh;}r(h=]rh?]rhA]rhC]rhF]ruh3jxh-]rh{Xtraceback=Nonerr}r(h2Uh3jubah9jLubeubeubjZ)r}r(h2Uh3j:h4hh9j]h;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]r(h)r}r(h2X5Bases: :class:`circuits.web.exceptions.HTTPException`rh3jh4jhh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]r(h{XBases: rr}r(h2XBases: rh3jubhW)r}r(h2X.:class:`circuits.web.exceptions.HTTPException`rh3jh4h7h9h[h;}r(UreftyperXclassrh_h`X%circuits.web.exceptions.HTTPExceptionrU refdomainrXpyrhC]rhA]rU refexplicitrh=]rh?]rhF]rhjhkhlj7hmjuhHKh-]rho)r}r(h2jh;}r(h=]rh?]r(hujXpy-classrehA]rhC]rhF]ruh3jh-]rh{X%circuits.web.exceptions.HTTPExceptionrr}r(h2Uh3jubah9hubaubeubh)r}r(h2XYraised by the request functions if they were unable to decode the incoming data properly.rh3jh4j.h9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]rh{XYraised by the request functions if they were unable to decode the incoming data properly.rr}r(h2jh3jubaubeubeubh)r}r(h2Uh3hh4Xq/home/prologic/work/circuits/circuits/web/exceptions.py:docstring of circuits.web.exceptions.UnsupportedMediaTyperh9hh;}r(hC]rhA]rh=]rh?]rhF]rUentriesr]r(hXUnsupportedMediaTyperhUtrauhHNhIhh-]rubh)r}r(h2Uh3hh4jh9hh;}r(hhXpyrhC]rhA]rh=]rh?]rhF]rhX exceptionrhjuhHNhIhh-]r(h)r}r(h2X6UnsupportedMediaType(description=None, traceback=None)rh3jh4hh9hh;}r(hC]rhahh5Xcircuits.web.exceptionsrr}rbhA]rh=]rh?]rhF]rhajjjUjuhHNhIhh-]r(j)r}r(h2X exception rh3jh4hh9j h;}r(h=]rh?]rhA]rhC]r hF]r uhHNhIhh-]r h{X exception r r }r(h2Uh3jubaubj)r}r(h2Xcircuits.web.exceptions.rh3jh4hh9jh;}r(h=]rh?]rhA]rhC]rhF]ruhHNhIhh-]rh{Xcircuits.web.exceptions.rr}r(h2Uh3jubaubj%)r}r(h2jh3jh4hh9j(h;}r(h=]rh?]r hA]r!hC]r"hF]r#uhHNhIhh-]r$h{XUnsupportedMediaTyper%r&}r'(h2Uh3jubaubj3)r(}r)(h2Uh3jh4hh9j6h;}r*(h=]r+h?]r,hA]r-hC]r.hF]r/uhHNhIhh-]r0(j>)r1}r2(h2Xdescription=Noner3h;}r4(h=]r5h?]r6hA]r7hC]r8hF]r9uh3j(h-]r:h{Xdescription=Noner;r<}r=(h2Uh3j1ubah9jLubj>)r>}r?(h2Xtraceback=Noner@h;}rA(h=]rBh?]rChA]rDhC]rEhF]rFuh3j(h-]rGh{Xtraceback=NonerHrI}rJ(h2Uh3j>ubah9jLubeubeubjZ)rK}rL(h2Uh3jh4hh9j]h;}rM(h=]rNh?]rOhA]rPhC]rQhF]rRuhHNhIhh-]rS(h)rT}rU(h2X5Bases: :class:`circuits.web.exceptions.HTTPException`rVh3jKh4jhh9hh;}rW(h=]rXh?]rYhA]rZhC]r[hF]r\uhHKhIhh-]r](h{XBases: r^r_}r`(h2XBases: rah3jTubhW)rb}rc(h2X.:class:`circuits.web.exceptions.HTTPException`rdh3jTh4h7h9h[h;}re(UreftyperfXclassrgh_h`X%circuits.web.exceptions.HTTPExceptionrhU refdomainriXpyrjhC]rkhA]rlU refexplicitrmh=]rnh?]rohF]rphjhkhljhmjuhHKh-]rqho)rr}rs(h2jdh;}rt(h=]ruh?]rv(hujjXpy-classrwehA]rxhC]ryhF]rzuh3jbh-]r{h{X%circuits.web.exceptions.HTTPExceptionr|r}}r~(h2Uh3jrubah9hubaubeubh)r}r(h2X*415* `Unsupported Media Type`rh3jKh4jh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]r(jL)r}r(h2X*415*rh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{X415rr}r(h2Uh3jubah9jZubh{X r}r(h2X h3jubj])r}r(h2X`Unsupported Media Type`rh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{XUnsupported Media Typerr}r(h2Uh3jubah9jkubeubh)r}r(h2XaThe status code returned if the server is unable to handle the media type the client transmitted.rh3jKh4jh9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHKhIhh-]rh{XaThe status code returned if the server is unable to handle the media type the client transmitted.rr}r(h2jh3jubaubeubeubeubh/)r}r(h2Uh3h0h4h7h9h:h;}r(h=]rh?]rhA]rhC]rh)ahF]rhauhHK hIhh-]r(hK)r}r(h2XEventsrh3jh4h7h9hOh;}r(h=]rh?]rhA]rhC]rhF]ruhHK hIhh-]rh{XEventsrr}r(h2jh3jubaubh)r}r(h2X**none**rh3jh4h7h9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHK"hIhh-]rcdocutils.nodes strong r)r}r(h2jh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{Xnonerr}r(h2Uh3jubah9Ustrongrubaubeubh/)r}r(h2Uh3h0h4h7h9h:h;}r(h=]rh?]rhA]rhC]rh*ahF]rhauhHK%hIhh-]r(hK)r}r(h2X Componentsrh3jh4h7h9hOh;}r(h=]rh?]rhA]rhC]rhF]ruhHK%hIhh-]rh{X Componentsrr}r(h2jh3jubaubh)r}r(h2X**none**rh3jh4h7h9hh;}r(h=]rh?]rhA]rhC]rhF]ruhHK'hIhh-]rj)r}r(h2jh;}r(h=]rh?]rhA]rhC]rhF]ruh3jh-]rh{Xnoner r }r (h2Uh3jubah9jubaubeubh/)r }r (h2Uh3h0h4h7h9h:h;}r(h=]rh?]rhA]rhC]rh(ahF]rh auhHK*hIhh-]r(hK)r}r(h2X Functionsrh3j h4h7h9hOh;}r(h=]rh?]rhA]rhC]rhF]ruhHK*hIhh-]rh{X Functionsrr }r!(h2jh3jubaubh)r"}r#(h2X**none**r$h3j h4h7h9hh;}r%(h=]r&h?]r'hA]r(hC]r)hF]r*uhHK,hIhh-]r+j)r,}r-(h2j$h;}r.(h=]r/h?]r0hA]r1hC]r2hF]r3uh3j"h-]r4h{Xnoner5r6}r7(h2Uh3j,ubah9jubaubeubeubah2UU transformerr8NU footnote_refsr9}r:Urefnamesr;}r<Usymbol_footnotesr=]r>Uautofootnote_refsr?]r@Usymbol_footnote_refsrA]rBU citationsrC]rDhIhU current_linerENUtransform_messagesrF]rGUreporterrHNUid_startrIKU autofootnotesrJ]rKU citation_refsrL}rMUindirect_targetsrN]rOUsettingsrP(cdocutils.frontend Values rQorR}rS(Ufootnote_backlinksrTKUrecord_dependenciesrUNU rfc_base_urlrVUhttp://tools.ietf.org/html/rWU tracebackrXUpep_referencesrYNUstrip_commentsrZNU toc_backlinksr[Uentryr\U language_coder]Uenr^U datestampr_NU report_levelr`KU _destinationraNU halt_levelrbKU strip_classesrcNhONUerror_encoding_error_handlerrdUbackslashreplacereUdebugrfNUembed_stylesheetrgUoutput_encoding_error_handlerrhUstrictriU sectnum_xformrjKUdump_transformsrkNU docinfo_xformrlKUwarning_streamrmNUpep_file_url_templaternUpep-%04droUexit_status_levelrpKUconfigrqNUstrict_visitorrrNUcloak_email_addressesrsUtrim_footnote_reference_spacertUenvruNUdump_pseudo_xmlrvNUexpose_internalsrwNUsectsubtitle_xformrxU source_linkryNUrfc_referencesrzNUoutput_encodingr{Uutf-8r|U source_urlr}NUinput_encodingr~U utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUH/home/prologic/work/circuits/docs/source/api/circuits_web_exceptions.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjiUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hjhjohj[ h j h jhEcdocutils.nodes target r)r}r(h2Uh3h0h4hh9Utargetrh;}r(h=]rhC]rhEahA]rUismodrh?]rhF]ruhHKhIhh-]rubh(j h j h jhjEhjh)jhjhh*jhj hjhhhjhj hj>hjhjh+h0hjb h,hhjuUsubstitution_namesr}rh9hIh;}r(h=]rhC]rhA]rUsourcerh7h?]rhF]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_dispatchers_websockets.doctree0000644000014400001440000004007612113366664030372 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X.circuits.web.dispatchers.websockets.WebSocketsqX functionsqNX1circuits.web.dispatchers.websockets -- websocketsqNX componentsq NXeventsq NuUsubstitution_defsq }q Uparse_messagesq ]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hhhU functionsqhU.circuits-web-dispatchers-websockets-websocketsqh U componentsqh UeventsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode q XT/home/prologic/work/circuits/docs/source/api/circuits_web_dispatchers_websockets.rstq!q"}q#bUtagnameq$Usectionq%U attributesq&}q'(Udupnamesq(]q)Uclassesq*]q+Ubackrefsq,]q-Uidsq.]q/(X*module-circuits.web.dispatchers.websocketsq0heUnamesq1]q2hauUlineq3KUdocumentq4hh]q5(cdocutils.nodes title q6)q7}q8(hX8:mod:`circuits.web.dispatchers.websockets` -- WebSocketsq9hhhh"h$Utitleq:h&}q;(h(]qh.]q?h1]q@uh3Kh4hh]qA(csphinx.addnodes pending_xref qB)qC}qD(hX*:mod:`circuits.web.dispatchers.websockets`qEhh7hh"h$U pending_xrefqFh&}qG(UreftypeqHXmodqIUrefwarnqJU reftargetqKX#circuits.web.dispatchers.websocketsqLU refdomainqMXpyqNh.]qOh,]qPU refexplicitqQh(]qRh*]qSh1]qTUrefdocqUU'api/circuits_web_dispatchers_websocketsqVUpy:classqWNU py:moduleqXNuh3Kh]qYcdocutils.nodes literal qZ)q[}q\(hhEh&}q](h(]q^h*]q_(Uxrefq`hNXpy-modqaeh,]qbh.]qch1]qduhhCh]qecdocutils.nodes Text qfX#circuits.web.dispatchers.websocketsqgqh}qi(hUhh[ubah$UliteralqjubaubhfX -- WebSocketsqkql}qm(hX -- WebSocketsqnhh7ubeubcsphinx.addnodes index qo)qp}qq(hUhhhU qrh$Uindexqsh&}qt(h.]quh,]qvh(]qwh*]qxh1]qyUentriesqz]q{(Usingleq|X,circuits.web.dispatchers.websockets (module)X*module-circuits.web.dispatchers.websocketsUtq}auh3Kh4hh]q~ubh)q}q(hUhhhh"h$h%h&}q(h(]qh*]qh,]qh.]qhah1]qh auh3Kh4hh]qh6)q}q(hXEventsqhhhh"h$h:h&}q(h(]qh*]qh,]qh.]qh1]quh3Kh4hh]qhfXEventsqq}q(hhhhubaubaubh)q}q(hUhhhh"h$h%h&}q(h(]qh*]qh,]qh.]qhah1]qh auh3K h4hh]q(h6)q}q(hX Componentsqhhhh"h$h:h&}q(h(]qh*]qh,]qh.]qh1]quh3K h4hh]qhfX Componentsqq}q(hhhhubaubho)q}q(hUhhhNh$hsh&}q(h.]qh,]qh(]qh*]qh1]qUentriesq]q(h|X9WebSockets (class in circuits.web.dispatchers.websockets)hUtqauh3Nh4hh]qubcsphinx.addnodes desc q)q}q(hUhhhNh$Udescqh&}q(UnoindexqUdomainqXpyqh.]qh,]qh(]qh*]qh1]qUobjtypeqXclassqUdesctypeqhuh3Nh4hh]q(csphinx.addnodes desc_signature q)q}q(hX6WebSockets(path=None, wschannel='ws', *args, **kwargs)qhhhU qh$Udesc_signatureqh&}q(h.]qhaUmoduleqh X#circuits.web.dispatchers.websocketsqхq}qbh,]qh(]qh*]qh1]qhaUfullnameqX WebSocketsqUclassqUUfirstqۉuh3Nh4hh]q(csphinx.addnodes desc_annotation q)q}q(hXclass qhhhhh$Udesc_annotationqh&}q(h(]qh*]qh,]qh.]qh1]quh3Nh4hh]qhfXclass q酁q}q(hUhhubaubcsphinx.addnodes desc_addname q)q}q(hX$circuits.web.dispatchers.websockets.qhhhhh$U desc_addnameqh&}q(h(]qh*]qh,]qh.]qh1]quh3Nh4hh]qhfX$circuits.web.dispatchers.websockets.qq}q(hUhhubaubcsphinx.addnodes desc_name q)q}q(hhhhhhh$U desc_nameqh&}q(h(]rh*]rh,]rh.]rh1]ruh3Nh4hh]rhfX WebSocketsrr}r(hUhhubaubcsphinx.addnodes desc_parameterlist r )r }r (hUhhhhh$Udesc_parameterlistr h&}r (h(]rh*]rh,]rh.]rh1]ruh3Nh4hh]r(csphinx.addnodes desc_parameter r)r}r(hX path=Nonerh&}r(h(]rh*]rh,]rh.]rh1]ruhj h]rhfX path=Nonerr }r!(hUhjubah$Udesc_parameterr"ubj)r#}r$(hXwschannel='ws'r%h&}r&(h(]r'h*]r(h,]r)h.]r*h1]r+uhj h]r,hfXwschannel='ws'r-r.}r/(hUhj#ubah$j"ubj)r0}r1(hX*argsr2h&}r3(h(]r4h*]r5h,]r6h.]r7h1]r8uhj h]r9hfX*argsr:r;}r<(hUhj0ubah$j"ubj)r=}r>(hX**kwargsr?h&}r@(h(]rAh*]rBh,]rCh.]rDh1]rEuhj h]rFhfX**kwargsrGrH}rI(hUhj=ubah$j"ubeubeubcsphinx.addnodes desc_content rJ)rK}rL(hUhhhhh$U desc_contentrMh&}rN(h(]rOh*]rPh,]rQh.]rRh1]rSuh3Nh4hh]rT(cdocutils.nodes paragraph rU)rV}rW(hX6Bases: :class:`circuits.core.components.BaseComponent`rXhjKhU rYh$U paragraphrZh&}r[(h(]r\h*]r]h,]r^h.]r_h1]r`uh3Kh4hh]ra(hfXBases: rbrc}rd(hXBases: rehjVubhB)rf}rg(hX/:class:`circuits.core.components.BaseComponent`rhhjVhh"h$hFh&}ri(UreftyperjXclassrkhJhKX&circuits.core.components.BaseComponentrlU refdomainrmXpyrnh.]roh,]rpU refexplicitrqh(]rrh*]rsh1]rthUhVhWhhXX#circuits.web.dispatchers.websocketsruuh3Kh]rvhZ)rw}rx(hjhh&}ry(h(]rzh*]r{(h`jnXpy-classr|eh,]r}h.]r~h1]ruhjfh]rhfX&circuits.core.components.BaseComponentrr}r(hUhjwubah$hjubaubeubjU)r}r(hXThis class implements an RFC 6455 compliant WebSockets dispatcher that handles the WebSockets handshake and upgrades the connection.rhjKhX/home/prologic/work/circuits/circuits/web/dispatchers/websockets.py:docstring of circuits.web.dispatchers.websockets.WebSocketsrh$jZh&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]rhfXThis class implements an RFC 6455 compliant WebSockets dispatcher that handles the WebSockets handshake and upgrades the connection.rr}r(hjhjubaubjU)r}r(hXKThe dispatcher listens on its channel for :class:`~.web.events.Request` events and tries to match them with a given path. Upon a match, the request is checked for the proper Opening Handshake information. If successful, the dispatcher confirms the establishment of the connection to the client. Any subsequent data from the client is handled as a WebSocket data frame, decoded and fired as a :class:`~.sockets.Read` event on the ``wschannel`` passed to the constructor. The data from :class:`~.sockets.Write` events on that channel is encoded as data frames and forwarded to the client.rhjKhjh$jZh&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]r(hfX*The dispatcher listens on its channel for rr}r(hX*The dispatcher listens on its channel for rhjubhB)r}r(hX:class:`~.web.events.Request`rhjhh"h$hFh&}r(UreftyperXclassrU refspecificrhJhKXweb.events.RequestrU refdomainrXpyrh.]rh,]rU refexplicitrh(]rh*]rh1]rhUhVhWhhXjuuh3K h]rhZ)r}r(hjh&}r(h(]rh*]r(h`jXpy-classreh,]rh.]rh1]ruhjh]rhfXRequestrr}r(hUhjubah$hjubaubhfXA events and tries to match them with a given path. Upon a match, the request is checked for the proper Opening Handshake information. If successful, the dispatcher confirms the establishment of the connection to the client. Any subsequent data from the client is handled as a WebSocket data frame, decoded and fired as a rr}r(hXA events and tries to match them with a given path. Upon a match, the request is checked for the proper Opening Handshake information. If successful, the dispatcher confirms the establishment of the connection to the client. Any subsequent data from the client is handled as a WebSocket data frame, decoded and fired as a rhjubhB)r}r(hX:class:`~.sockets.Read`rhjhh"h$hFh&}r(UreftyperXclassrjhJhKX sockets.ReadrU refdomainrXpyrh.]rh,]rU refexplicitrh(]rh*]rh1]rhUhVhWhhXjuuh3K h]rhZ)r}r(hjh&}r(h(]rh*]r(h`jXpy-classreh,]rh.]rh1]ruhjh]rhfXReadrr}r(hUhjubah$hjubaubhfX event on the rr}r(hX event on the rhjubhZ)r}r(hX ``wschannel``rh&}r(h(]rh*]rh,]rh.]rh1]ruhjh]rhfX wschannelrr}r(hUhjubah$hjubhfX* passed to the constructor. The data from rr}r(hX* passed to the constructor. The data from rhjubhB)r}r(hX:class:`~.sockets.Write`rhjhh"h$hFh&}r(UreftyperXclassrjhJhKX sockets.WriterU refdomainrXpyrh.]rh,]rU refexplicitrh(]rh*]rh1]rhUhVhWhhXjuuh3K h]rhZ)r}r(hjh&}r(h(]rh*]r(h`jXpy-classr eh,]r h.]r h1]r uhjh]r hfXWriterr}r(hUhjubah$hjubaubhfXO events on that channel is encoded as data frames and forwarded to the client.rr}r(hXO events on that channel is encoded as data frames and forwarded to the client.rhjubeubjU)r}r(hXFiring a :class:`~.sockets.Close` event on the ``wschannel`` closes the connection in an orderly fashion (i.e. as specified by the WebSocket protocol).rhjKhjh$jZh&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]r(hfX Firing a rr }r!(hX Firing a r"hjubhB)r#}r$(hX:class:`~.sockets.Close`r%hjhh"h$hFh&}r&(Ureftyper'Xclassr(jhJhKX sockets.Closer)U refdomainr*Xpyr+h.]r,h,]r-U refexplicitr.h(]r/h*]r0h1]r1hUhVhWhhXjuuh3Kh]r2hZ)r3}r4(hj%h&}r5(h(]r6h*]r7(h`j+Xpy-classr8eh,]r9h.]r:h1]r;uhj#h]r<hfXCloser=r>}r?(hUhj3ubah$hjubaubhfX event on the r@rA}rB(hX event on the rChjubhZ)rD}rE(hX ``wschannel``rFh&}rG(h(]rHh*]rIh,]rJh.]rKh1]rLuhjh]rMhfX wschannelrNrO}rP(hUhjDubah$hjubhfX[ closes the connection in an orderly fashion (i.e. as specified by the WebSocket protocol).rQrR}rS(hX[ closes the connection in an orderly fashion (i.e. as specified by the WebSocket protocol).rThjubeubcdocutils.nodes field_list rU)rV}rW(hUhjKhNh$U field_listrXh&}rY(h(]rZh*]r[h,]r\h.]r]h1]r^uh3Nh4hh]r_cdocutils.nodes field r`)ra}rb(hUh&}rc(h(]rdh*]reh,]rfh.]rgh1]rhuhjVh]ri(cdocutils.nodes field_name rj)rk}rl(hUh&}rm(h(]rnh*]roh,]rph.]rqh1]rruhjah]rshfX Parametersrtru}rv(hUhjkubah$U field_namerwubcdocutils.nodes field_body rx)ry}rz(hUh&}r{(h(]r|h*]r}h,]r~h.]rh1]ruhjah]rcdocutils.nodes bullet_list r)r}r(hUh&}r(h(]rh*]rh,]rh.]rh1]ruhjyh]r(cdocutils.nodes list_item r)r}r(hUh&}r(h(]rh*]rh,]rh.]rh1]ruhjh]rjU)r}r(hUh&}r(h(]rh*]rh,]rh.]rh1]ruhjh]r(cdocutils.nodes strong r)r}r(hXpathrh&}r(h(]rh*]rh,]rh.]rh1]ruhjh]rhfXpathrr}r(hUhjubah$UstrongrubhfX -- rr}r(hUhjubhfXithe path to handle. Requests that start with this path are considered to be WebSocket Opening Handshakes.rr}r(hXithe path to handle. Requests that start with this path are considered to be WebSocket Opening Handshakes.rhjubeh$jZubah$U list_itemrubj)r}r(hUh&}r(h(]rh*]rh,]rh.]rh1]ruhjh]rjU)r}r(hUh&}r(h(]rh*]rh,]rh.]rh1]ruhjh]r(j)r}r(hX wschannelrh&}r(h(]rh*]rh,]rh.]rh1]ruhjh]rhfX wschannelrr}r(hUhjubah$jubhfX -- rr}r(hUhjubhfXthe channel on which rr}r(hXthe channel on which rhjubhB)r}r(hX:class:`~.sockets.Read`rhjhNh$hFh&}r(UreftyperXclassrjhJhKX sockets.ReadrU refdomainrXpyrh.]rh,]rU refexplicitrh(]rh*]rh1]rhUhVhWhhXjuuh3Nh]rhZ)r}r(hjh&}r(h(]rh*]r(h`jXpy-classreh,]rh.]rh1]ruhjh]rhfXReadrr}r(hUhjubah$hjubaubhfX4 events from the client will be delivered and where rr}r(hX4 events from the client will be delivered and where rhjubhB)r}r(hX:class:`~.sockets.Write`rhjhNh$hFh&}r(UreftyperXclassrjhJhKX sockets.WriterU refdomainrXpyrh.]rh,]rU refexplicitrh(]r h*]r h1]r hUhVhWhhXjuuh3Nh]r hZ)r }r(hjh&}r(h(]rh*]r(h`jXpy-classreh,]rh.]rh1]ruhjh]rhfXWriterr}r(hUhj ubah$hjubaubhfX& events to the client will be sent to.rr}r(hX& events to the client will be sent to.rhjubeh$jZubah$jubeh$U bullet_listrubah$U field_bodyrubeh$Ufieldr ubaubeubeubeubh)r!}r"(hUhhhh"h$h%h&}r#(h(]r$h*]r%h,]r&h.]r'hah1]r(hauh3Kh4hh]r)(h6)r*}r+(hX Functionsr,hj!hh"h$h:h&}r-(h(]r.h*]r/h,]r0h.]r1h1]r2uh3Kh4hh]r3hfX Functionsr4r5}r6(hj,hj*ubaubjU)r7}r8(hX**none**r9hj!hh"h$jZh&}r:(h(]r;h*]r<h,]r=h.]r>h1]r?uh3Kh4hh]r@j)rA}rB(hj9h&}rC(h(]rDh*]rEh,]rFh.]rGh1]rHuhj7h]rIhfXnonerJrK}rL(hUhjAubah$jubaubeubeubahUU transformerrMNU footnote_refsrN}rOUrefnamesrP}rQUsymbol_footnotesrR]rSUautofootnote_refsrT]rUUsymbol_footnote_refsrV]rWU citationsrX]rYh4hU current_linerZNUtransform_messagesr[]r\Ureporterr]NUid_startr^KU autofootnotesr_]r`U citation_refsra}rbUindirect_targetsrc]rdUsettingsre(cdocutils.frontend Values rforg}rh(Ufootnote_backlinksriKUrecord_dependenciesrjNU rfc_base_urlrkUhttp://tools.ietf.org/html/rlU tracebackrmUpep_referencesrnNUstrip_commentsroNU toc_backlinksrpUentryrqU language_coderrUenrsU datestamprtNU report_levelruKU _destinationrvNU halt_levelrwKU strip_classesrxNh:NUerror_encoding_error_handlerryUbackslashreplacerzUdebugr{NUembed_stylesheetr|Uoutput_encoding_error_handlerr}Ustrictr~U sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUT/home/prologic/work/circuits/docs/source/api/circuits_web_dispatchers_websockets.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrj~Uauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hhhj!hhh0cdocutils.nodes target r)r}r(hUhhhhrh$Utargetrh&}r(h(]rh.]rh0ah,]rUismodrh*]rh1]ruh3Kh4hh]rubhhhhuUsubstitution_namesr}rh$h4h&}r(h(]rh.]rh,]rUsourcerh"h*]rh1]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_node.doctree0000644000014400001440000001062612113366662023714 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qXcircuits.node -- nodeqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhUcircuits-node-nodeqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX>/home/prologic/work/circuits/docs/source/api/circuits_node.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q((Xmodule-circuits.nodeq)heUnamesq*]q+hauUlineq,KUdocumentq-hh]q.(cdocutils.nodes title q/)q0}q1(hX:mod:`circuits.node` -- Nodeq2hhhhhUtitleq3h}q4(h!]q5h#]q6h%]q7h']q8h*]q9uh,Kh-hh]q:(csphinx.addnodes pending_xref q;)q<}q=(hX:mod:`circuits.node`q>hh0hhhU pending_xrefq?h}q@(UreftypeqAXmodqBUrefwarnqCU reftargetqDX circuits.nodeqEU refdomainqFXpyqGh']qHh%]qIU refexplicitqJh!]qKh#]qLh*]qMUrefdocqNUapi/circuits_nodeqOUpy:classqPNU py:moduleqQNuh,Kh]qRcdocutils.nodes literal qS)qT}qU(hh>h}qV(h!]qWh#]qX(UxrefqYhGXpy-modqZeh%]q[h']q\h*]q]uhhqkhUindexqlh}qm(h']qnh%]qoh!]qph#]qqh*]qrUentriesqs]qt(UsinglequXcircuits.node (module)Xmodule-circuits.nodeUtqvauh,Kh-hh]qwubcdocutils.nodes paragraph qx)qy}qz(hXNodeq{hhhXQ/home/prologic/work/circuits/circuits/node/__init__.py:docstring of circuits.nodeq|hU paragraphq}h}q~(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_XNodeqq}q(hh{hhyubaubhx)q}q(hX5Distributed and Inter-Processing support for circuitsqhhhh|hh}h}q(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_X5Distributed and Inter-Processing support for circuitsqq}q(hhhhubaubcdocutils.nodes compound q)q}q(hUhhhhhUcompoundqh}q(h!]qh#]qUtoctree-wrapperqah%]qh']qh*]quh,Nh-hh]qcsphinx.addnodes toctree q)q}q(hUhhhhhUtoctreeqh}q(UnumberedqKhhOU titlesonlyqUglobqh']qh%]qh!]qh#]qh*]qUentriesq]q(NUapi/circuits_node_clientqqNUapi/circuits_node_eventsqqNUapi/circuits_node_nodeqqNUapi/circuits_node_serverqqNUapi/circuits_node_utilsqqeUhiddenqU includefilesq]q(hhhhheUmaxdepthqKuh,Kh]qubaubeubahUU transformerqNU footnote_refsq}qUrefnamesq}qUsymbol_footnotesq]qUautofootnote_refsq]qUsymbol_footnote_refsq]qU citationsq]qh-hU current_lineqNUtransform_messagesq]qUreporterqNUid_startqKU autofootnotesq]qU citation_refsq}qUindirect_targetsq]qUsettingsq(cdocutils.frontend Values qoq}q(Ufootnote_backlinksqKUrecord_dependenciesqNU rfc_base_urlqUhttp://tools.ietf.org/html/qU tracebackq߈Upep_referencesqNUstrip_commentsqNU toc_backlinksqUentryqU language_codeqUenqU datestampqNU report_levelqKU _destinationqNU halt_levelqKU strip_classesqNh3NUerror_encoding_error_handlerqUbackslashreplaceqUdebugqNUembed_stylesheetqUoutput_encoding_error_handlerqUstrictqU sectnum_xformqKUdump_transformsqNU docinfo_xformqKUwarning_streamqNUpep_file_url_templateqUpep-%04dqUexit_status_levelqKUconfigqNUstrict_visitorqNUcloak_email_addressesqUtrim_footnote_reference_spaceqUenvqNUdump_pseudo_xmlqNUexpose_internalsqNUsectsubtitle_xformqU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthr KUerror_encodingr U ISO-8859-1r U_sourcer U>/home/prologic/work/circuits/docs/source/api/circuits_node.rstr Ugettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrhUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startr KUidsr!}r"(hhh)cdocutils.nodes target r#)r$}r%(hUhhhhkhUtargetr&h}r'(h!]r(h']r)h)ah%]r*Uismodr+h#]r,h*]r-uh,Kh-hh]r.ubuUsubstitution_namesr/}r0hh-h}r1(h!]r2h']r3h%]r4Usourcer5hh#]r6h*]r7uU footnotesr8]r9Urefidsr:}r;ub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_client.doctree0000644000014400001440000005124112113366663025101 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X circuits.web.client.Client.closeqXcircuits.web.client -- clientqNX functionsqNX"circuits.web.client.Client.requestq X"circuits.web.client.Client.channelq X"circuits.web.client.Client.connectq Xcircuits.web.client.Requestq Xcircuits.web.client.Clientq X$circuits.web.client.Client.connectedqX componentsqNX circuits.web.client.Client.writeqX#circuits.web.client.Client.responseqXeventsqNuUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hhhUcircuits-web-client-clientqhU functionsqh h h h h h h h h h hhhU componentsqhhhhhUeventsquUchildrenq ]q!cdocutils.nodes section q")q#}q$(U rawsourceq%UUparentq&hUsourceq'cdocutils.nodes reprunicode q(XD/home/prologic/work/circuits/docs/source/api/circuits_web_client.rstq)q*}q+bUtagnameq,Usectionq-U attributesq.}q/(Udupnamesq0]q1Uclassesq2]q3Ubackrefsq4]q5Uidsq6]q7(Xmodule-circuits.web.clientq8heUnamesq9]q:hauUlineq;KUdocumentq)q?}q@(h%X$:mod:`circuits.web.client` -- ClientqAh&h#h'h*h,UtitleqBh.}qC(h0]qDh2]qEh4]qFh6]qGh9]qHuh;Kh)q}q(h%XEventsqh&hh'h*h,hBh.}q(h0]qh2]qh4]qh6]qh9]quh;Khqh,Udesc_signatureqh.}q(h6]qh aUmoduleqh(Xcircuits.web.clientq…q}qbh4]qh0]qh2]qh9]qh aUfullnameqXRequestqUclassqUUfirstq̉uh;Nhh.}r?(h0]r@h2]rAh4]rBh6]rCh9]rDuh;NhrJh,U paragraphrKh.}rL(h0]rMh2]rNh4]rOh6]rPh9]rQuh;Khh0]r?h2]r@h9]rAuh&jh ]rBj)rC}rD(h%j:h.}rE(h0]rFh2]rGh4]rHh6]rIh9]rJuh&j5h ]rKhnXstrrLrM}rN(h%Uh&jCubah,jubah,hNubhnX)rO}rP(h%Uh&jubhnX -- rQrR}rS(h%Uh&jubhnXPath to resourcerTrU}rV(h%XPath to resourcerWh&jubeh,jKubah,jubeh,U bullet_listrXubah,U field_bodyrYubeh,UfieldrZubaubeubeubeubh")r[}r\(h%Uh&h#h'h*h,h-h.}r](h0]r^h2]r_h4]r`h6]rahah9]rbhauh;Kh)rd}re(h%X Componentsrfh&j[h'h*h,hBh.}rg(h0]rhh2]rih4]rjh6]rkh9]rluh;Khh.}r(h0]rh2]rh4]rh6]rh9]ruh;Nhr-h,hh.}r.(h6]r/h ahh(Xcircuits.web.clientr0r1}r2bh4]r3h0]r4h2]r5h9]r6h ahXClient.channelr7hjh̉uh;Nhh4]r?h6]r@h9]rAuh;Nhh.}rU(h0]rVh2]rWh4]rXh6]rYh9]rZuh;Nhh.}r(h0]rh2]rh4]rh6]rh9]ruh;Nhh.}r(h0]rh2]rh4]rh6]rh9]ruh;Nhh4]r?h6]r@h9]rAuh&j#h ]rBhnX port=NonerCrD}rE(h%Uh&j9ubah,jubj)rF}rG(h%X secure=NonerHh.}rI(h0]rJh2]rKh4]rLh6]rMh9]rNuh&j#h ]rOhnX secure=NonerPrQ}rR(h%Uh&jFubah,jubeubeubj;)rS}rT(h%Uh&jh'hh,j>h.}rU(h0]rVh2]rWh4]rXh6]rYh9]rZuh;Nhh.}r(h0]rh2]rh4]rh6]rh9]ruh;Nhh.}r(h0]r h2]r h4]r h6]r h9]r uh;Nhr?}r@(h%Uh&j4ubaubaubj;)rA}rB(h%Uh&jh'hh,j>h.}rC(h0]rDh2]rEh4]rFh6]rGh9]rHuh;Nh)rS}rT(h%X FunctionsrUh&jJh'h*h,hBh.}rV(h0]rWh2]rXh4]rYh6]rZh9]r[uh;Khh,]q?h.]q@h0]qAh3]qBuh5Kh6hh]qC(csphinx.addnodes pending_xref qD)qE}qF(hX:mod:`circuits.app.daemon`qGh h9h!h$h&U pending_xrefqHh(}qI(UreftypeqJXmodqKUrefwarnqLU reftargetqMXcircuits.app.daemonqNU refdomainqOXpyqPh0]qQh.]qRU refexplicitqSh*]qTh,]qUh3]qVUrefdocqWUapi/circuits_app_daemonqXUpy:classqYNU py:moduleqZNuh5Kh]q[cdocutils.nodes literal q\)q]}q^(hhGh(}q_(h*]q`h,]qa(UxrefqbhPXpy-modqceh.]qdh0]qeh3]qfuh hEh]qgcdocutils.nodes Text qhXcircuits.app.daemonqiqj}qk(hUh h]ubah&UliteralqlubaubhhX -- Application Daemonqmqn}qo(hX -- Application Daemonqph h9ubeubcsphinx.addnodes index qq)qr}qs(hUh hh!h$h&Uindexqth(}qu(h0]qvh.]qwh*]qxh,]qyh3]qzUentriesq{]q|(Usingleq}Xcircuits.app.daemon (module)Xmodule-circuits.app.daemonUtq~auh5Kh6hh]qubh)q}q(hUh hh!h$h&h'h(}q(h*]qh,]qh.]qh0]qhah3]qh auh5Kh6hh]q(h8)q}q(hXEventsqh hh!h$h&hqh&Udesc_signatureqh(}q(h0]qhaUmoduleqh"Xcircuits.app.daemonqq}qbh.]qh*]qh,]qh3]qhaUfullnameqX DaemonizeqUclassqUUfirstqƉuh5Nh6hh]q(csphinx.addnodes desc_annotation q)q}q(hXclass qh hh!hh&Udesc_annotationqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]qhhXclass qԅq}q(hUh hubaubcsphinx.addnodes desc_addname q)q}q(hXcircuits.app.daemon.qh hh!hh&U desc_addnameqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]qhhXcircuits.app.daemon.qㅁq}q(hUh hubaubcsphinx.addnodes desc_name q)q}q(hhh hh!hh&U desc_nameqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]qhhX Daemonizeqq}q(hUh hubaubcsphinx.addnodes desc_parameterlist q)q}q(hUh hh!hh&Udesc_parameterlistqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]q(csphinx.addnodes desc_parameter q)r}r(hX*argsrh(}r(h*]rh,]rh.]rh0]rh3]ruh hh]r hhX*argsr r }r (hUh jubah&Udesc_parameterr ubh)r}r(hX**kwargsrh(}r(h*]rh,]rh.]rh0]rh3]ruh hh]rhhX**kwargsrr}r(hUh jubah&j ubeubeubcsphinx.addnodes desc_content r)r}r(hUh hh!hh&U desc_contentrh(}r(h*]r h,]r!h.]r"h0]r#h3]r$uh5Nh6hh]r%(cdocutils.nodes paragraph r&)r'}r((hX*Bases: :class:`circuits.core.events.Event`r)h jh!U r*h&U paragraphr+h(}r,(h*]r-h,]r.h.]r/h0]r0h3]r1uh5Kh6hh]r2(hhXBases: r3r4}r5(hXBases: r6h j'ubhD)r7}r8(hX#:class:`circuits.core.events.Event`r9h j'h!h$h&hHh(}r:(Ureftyper;Xclassr<hLhMXcircuits.core.events.Eventr=U refdomainr>Xpyr?h0]r@h.]rAU refexplicitrBh*]rCh,]rDh3]rEhWhXhYhhZXcircuits.app.daemonrFuh5Kh]rGh\)rH}rI(hj9h(}rJ(h*]rKh,]rL(hbj?Xpy-classrMeh.]rNh0]rOh3]rPuh j7h]rQhhXcircuits.core.events.EventrRrS}rT(hUh jHubah&hlubaubeubj&)rU}rV(hXDaemonize EventrWh jh!X^/home/prologic/work/circuits/circuits/app/daemon.py:docstring of circuits.app.daemon.DaemonizerXh&j+h(}rY(h*]rZh,]r[h.]r\h0]r]h3]r^uh5Kh6hh]r_hhXDaemonize Eventr`ra}rb(hjWh jUubaubj&)rc}rd(hXThis event can be fired to notify the `Daemon` Component to begin the "daemonization" process. This event is (*by default*) used automatically by the `Daemon` Component in its "started" Event Handler (*This behavior can be overridden*).reh jh!jXh&j+h(}rf(h*]rgh,]rhh.]rih0]rjh3]rkuh5Kh6hh]rl(hhX&This event can be fired to notify the rmrn}ro(hX&This event can be fired to notify the rph jcubcdocutils.nodes title_reference rq)rr}rs(hX`Daemon`rth(}ru(h*]rvh,]rwh.]rxh0]ryh3]rzuh jch]r{hhXDaemonr|r}}r~(hUh jrubah&Utitle_referencerubhhX@ Component to begin the "daemonization" process. This event is (rr}r(hX@ Component to begin the "daemonization" process. This event is (rh jcubcdocutils.nodes emphasis r)r}r(hX *by default*rh(}r(h*]rh,]rh.]rh0]rh3]ruh jch]rhhX by defaultrr}r(hUh jubah&UemphasisrubhhX) used automatically by the rr}r(hX) used automatically by the rh jcubjq)r}r(hX`Daemon`rh(}r(h*]rh,]rh.]rh0]rh3]ruh jch]rhhXDaemonrr}r(hUh jubah&jubhhX+ Component in its "started" Event Handler (rr}r(hX+ Component in its "started" Event Handler (rh jcubj)r}r(hX!*This behavior can be overridden*rh(}r(h*]rh,]rh.]rh0]rh3]ruh jch]rhhXThis behavior can be overriddenrr}r(hUh jubah&jubhhX).rr}r(hX).rh jcubeubj&)r}r(hXArguments: *None*rh jh!jXh&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]r(hhX Arguments: rr}r(hX Arguments: rh jubj)r}r(hX*None*rh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXNonerr}r(hUh jubah&jubeubj&)r}r(hXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rh jh!jXh&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5K h6hh]rhhXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rr}r(hjh jubaubj&)r}r(hXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rh jh!jXh&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]rhhXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rr}r(hjh jubaubj&)r}r(hXEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh jh!jXh&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]r(hhXEvery event has a rr}r(hXEvery event has a rh jubhD)r}r(hX :attr:`name`rh jh!h$h&hHh(}r(UreftyperXattrrhLhMXnamerU refdomainrXpyrh0]rh.]rU refexplicitrh*]rh,]r h3]r hWhXhYhhZjFuh5Kh]r h\)r }r (hjh(}r(h*]rh,]r(hbjXpy-attrreh.]rh0]rh3]ruh jh]rhhXnamerr}r(hUh j ubah&hlubaubhhX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(hX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh jubeubcdocutils.nodes field_list r)r}r(hUh jh!Nh&U field_listr h(}r!(h*]r"h,]r#h.]r$h0]r%h3]r&uh5Nh6hh]r'cdocutils.nodes field r()r)}r*(hUh(}r+(h*]r,h,]r-h.]r.h0]r/h3]r0uh jh]r1(cdocutils.nodes field_name r2)r3}r4(hUh(}r5(h*]r6h,]r7h.]r8h0]r9h3]r:uh j)h]r;hhX Variablesr<r=}r>(hUh j3ubah&U field_namer?ubcdocutils.nodes field_body r@)rA}rB(hUh(}rC(h*]rDh,]rEh.]rFh0]rGh3]rHuh j)h]rIcdocutils.nodes bullet_list rJ)rK}rL(hUh(}rM(h*]rNh,]rOh.]rPh0]rQh3]rRuh jAh]rS(cdocutils.nodes list_item rT)rU}rV(hUh(}rW(h*]rXh,]rYh.]rZh0]r[h3]r\uh jKh]r]j&)r^}r_(hUh(}r`(h*]rah,]rbh.]rch0]rdh3]reuh jUh]rf(hD)rg}rh(hUh(}ri(UreftyperjUobjrkU reftargetrlXchannelsrmU refdomainrnhh0]roh.]rpU refexplicitrqh*]rrh,]rsh3]rtuh j^h]rucdocutils.nodes strong rv)rw}rx(hjmh(}ry(h*]rzh,]r{h.]r|h0]r}h3]r~uh jgh]rhhXchannelsrr}r(hUh jwubah&Ustrongrubah&hHubhhX -- rr}r(hUh j^ubj&)r}r(hXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rh j^h!jXh&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh]rhhXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rr}r(hjh jubaubj&)r}r(hXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rh j^h!jXh&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh]rhhXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rr}r(hjh jubaubeh&j+ubah&U list_itemrubjT)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jKh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjkU reftargetrXvaluerU refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rjv)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXvaluerr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhX this is a rr}r(hX this is a rh jubhD)r}r(hX#:class:`circuits.core.values.Value`rh jh!Nh&hHh(}r(UreftyperXclassrhLhMXcircuits.core.values.ValuerU refdomainrXpyrh0]rh.]rU refexplicitrh*]rh,]rh3]rhWhXhYhhZjFuh5Nh]rh\)r}r(hjh(}r(h*]rh,]r(hbjXpy-classreh.]rh0]rh3]ruh jh]rhhXcircuits.core.values.Valuerr}r(hUh jubah&hlubaubhhXN object that holds the results returned by the handlers invoked for the event.rr}r(hXN object that holds the results returned by the handlers invoked for the event.rh jubeh&j+ubah&jubjT)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jKh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r (hUh(}r (Ureftyper jkU reftargetr Xsuccessr U refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rjv)r}r(hj h(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXsuccessrr }r!(hUh jubah&jubah&hHubhhX -- r"r#}r$(hUh jubhhX%if this optional attribute is set to r%r&}r'(hX%if this optional attribute is set to r(h jubh\)r)}r*(hX``True``r+h(}r,(h*]r-h,]r.h.]r/h0]r0h3]r1uh jh]r2hhXTruer3r4}r5(hUh j)ubah&hlubhhX, an associated event r6r7}r8(hX, an associated event r9h jubh\)r:}r;(hX``EventSuccess``r<h(}r=(h*]r>h,]r?h.]r@h0]rAh3]rBuh jh]rChhX EventSuccessrDrE}rF(hUh j:ubah&hlubhhX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rGrH}rI(hX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rJh jubeh&j+ubah&jubjT)rK}rL(hUh(}rM(h*]rNh,]rOh.]rPh0]rQh3]rRuh jKh]rSj&)rT}rU(hUh(}rV(h*]rWh,]rXh.]rYh0]rZh3]r[uh jKh]r\(hD)r]}r^(hUh(}r_(Ureftyper`jkU reftargetraXsuccess_channelsrbU refdomainrchh0]rdh.]reU refexplicitrfh*]rgh,]rhh3]riuh jTh]rjjv)rk}rl(hjbh(}rm(h*]rnh,]roh.]rph0]rqh3]rruh j]h]rshhXsuccess_channelsrtru}rv(hUh jkubah&jubah&hHubhhX -- rwrx}ry(hUh jTubhhXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rzr{}r|(hXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r}h jTubeh&j+ubah&jubjT)r~}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jKh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh j~h]r(hD)r}r(hUh(}r(UreftyperjkU reftargetrXcompleterU refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rjv)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXcompleterr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhX%if this optional attribute is set to rr}r(hX%if this optional attribute is set to rh jubh\)r}r(hX``True``rh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXTruerr}r(hUh jubah&hlubhhX, an associated event rr}r(hX, an associated event rh jubh\)r}r(hX``EventComplete``rh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX EventCompleterr}r(hUh jubah&hlubhhX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rr}r(hX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rh jubeh&j+ubah&jubjT)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jKh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjkU reftargetrXsuccess_channelsrU refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rjv)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXsuccess_channelsrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(hXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh jubeh&j+ubah&jubeh&U bullet_listrubah&U field_bodyrubeh&Ufieldrubaubeubeubhq)r }r (hUh hh!Nh&hth(}r (h0]r h.]r h*]rh,]rh3]rUentriesr]r(h}X'WritePID (class in circuits.app.daemon)h Utrauh5Nh6hh]rubh)r}r(hUh hh!Nh&hh(}r(hhXpyrh0]rh.]rh*]rh,]rh3]rhXclassrhjuh5Nh6hh]r(h)r }r!(hXWritePID(*args, **kwargs)r"h jh!hh&hh(}r#(h0]r$h ahh"Xcircuits.app.daemonr%r&}r'bh.]r(h*]r)h,]r*h3]r+h ahXWritePIDr,hUhƉuh5Nh6hh]r-(h)r.}r/(hXclass r0h j h!hh&hh(}r1(h*]r2h,]r3h.]r4h0]r5h3]r6uh5Nh6hh]r7hhXclass r8r9}r:(hUh j.ubaubh)r;}r<(hXcircuits.app.daemon.r=h j h!hh&hh(}r>(h*]r?h,]r@h.]rAh0]rBh3]rCuh5Nh6hh]rDhhXcircuits.app.daemon.rErF}rG(hUh j;ubaubh)rH}rI(hj,h j h!hh&hh(}rJ(h*]rKh,]rLh.]rMh0]rNh3]rOuh5Nh6hh]rPhhXWritePIDrQrR}rS(hUh jHubaubh)rT}rU(hUh j h!hh&hh(}rV(h*]rWh,]rXh.]rYh0]rZh3]r[uh5Nh6hh]r\(h)r]}r^(hX*argsr_h(}r`(h*]rah,]rbh.]rch0]rdh3]reuh jTh]rfhhX*argsrgrh}ri(hUh j]ubah&j ubh)rj}rk(hX**kwargsrlh(}rm(h*]rnh,]roh.]rph0]rqh3]rruh jTh]rshhX**kwargsrtru}rv(hUh jjubah&j ubeubeubj)rw}rx(hUh jh!hh&jh(}ry(h*]rzh,]r{h.]r|h0]r}h3]r~uh5Nh6hh]r(j&)r}r(hX*Bases: :class:`circuits.core.events.Event`rh jwh!j*h&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]r(hhXBases: rr}r(hXBases: rh jubhD)r}r(hX#:class:`circuits.core.events.Event`rh jh!h$h&hHh(}r(UreftyperXclassrhLhMXcircuits.core.events.EventrU refdomainrXpyrh0]rh.]rU refexplicitrh*]rh,]rh3]rhWhXhYj,hZjFuh5Kh]rh\)r}r(hjh(}r(h*]rh,]r(hbjXpy-classreh.]rh0]rh3]ruh jh]rhhXcircuits.core.events.Eventrr}r(hUh jubah&hlubaubeubj&)r}r(hX"WritePID Eventrh jwh!X]/home/prologic/work/circuits/circuits/app/daemon.py:docstring of circuits.app.daemon.WritePIDrh&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]rhhX"WritePID Eventrr}r(hjh jubaubj&)r}r(hXThis event can be fired to notify the `Daemon` Component that is should retrive the current process's id (pid) and write it out to the configured path in the `Daemon` Component. This event (*by default*) is used automatically by the `Daemon` Component after the :class:`Daemonize`.rh jwh!jh&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]r(hhX&This event can be fired to notify the rr}r(hX&This event can be fired to notify the rh jubjq)r}r(hX`Daemon`rh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXDaemonrr}r(hUh jubah&jubhhXp Component that is should retrive the current process's id (pid) and write it out to the configured path in the rr}r(hXp Component that is should retrive the current process's id (pid) and write it out to the configured path in the rh jubjq)r}r(hX`Daemon`rh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXDaemonrr}r(hUh jubah&jubhhX Component. This event (rr}r(hX Component. This event (rh jubj)r}r(hX *by default*rh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX by defaultrr}r(hUh jubah&jubhhX) is used automatically by the rr}r(hX) is used automatically by the rh jubjq)r}r(hX`Daemon`rh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXDaemonrr}r(hUh jubah&jubhhX Component after the rr}r (hX Component after the r h jubhD)r }r (hX:class:`Daemonize`r h jh!h$h&hHh(}r(UreftyperXclassrhLhMX DaemonizerU refdomainrXpyrh0]rh.]rU refexplicitrh*]rh,]rh3]rhWhXhYj,hZjFuh5K h]rh\)r}r(hj h(}r(h*]rh,]r(hbjXpy-classr eh.]r!h0]r"h3]r#uh j h]r$hhX Daemonizer%r&}r'(hUh jubah&hlubaubhhX.r(}r)(hX.h jubeubj&)r*}r+(hXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.r,h jwh!jh&j+h(}r-(h*]r.h,]r/h.]r0h0]r1h3]r2uh5K h6hh]r3hhXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.r4r5}r6(hj,h j*ubaubj&)r7}r8(hXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.r9h jwh!jh&j+h(}r:(h*]r;h,]r<h.]r=h0]r>h3]r?uh5K h6hh]r@hhXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rArB}rC(hj9h j7ubaubj&)rD}rE(hXEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rFh jwh!jh&j+h(}rG(h*]rHh,]rIh.]rJh0]rKh3]rLuh5Kh6hh]rM(hhXEvery event has a rNrO}rP(hXEvery event has a rQh jDubhD)rR}rS(hX :attr:`name`rTh jDh!h$h&hHh(}rU(UreftyperVXattrrWhLhMXnamerXU refdomainrYXpyrZh0]r[h.]r\U refexplicitr]h*]r^h,]r_h3]r`hWhXhYj,hZjFuh5Kh]rah\)rb}rc(hjTh(}rd(h*]reh,]rf(hbjZXpy-attrrgeh.]rhh0]rih3]rjuh jRh]rkhhXnamerlrm}rn(hUh jbubah&hlubaubhhX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rorp}rq(hX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rrh jDubeubj)rs}rt(hUh jwh!Nh&j h(}ru(h*]rvh,]rwh.]rxh0]ryh3]rzuh5Nh6hh]r{j()r|}r}(hUh(}r~(h*]rh,]rh.]rh0]rh3]ruh jsh]r(j2)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh j|h]rhhX Variablesrr}r(hUh jubah&j?ubj@)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh j|h]rjJ)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(jT)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjkU reftargetrXchannelsrU refdomainrjh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rjv)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXchannelsrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubj&)r}r(hXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rh jh!jh&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh]rhhXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rr}r(hjh jubaubj&)r}r(hXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rh jh!jh&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh]rhhXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rr}r(hjh jubaubeh&j+ubah&jubjT)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjkU reftargetrXvaluerU refdomainrjh0]rh.]rU refexplicitrh*]rh,]r h3]r uh jh]r jv)r }r (hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXvaluerr}r(hUh j ubah&jubah&hHubhhX -- rr}r(hUh jubhhX this is a rr}r(hX this is a rh jubhD)r}r (hX#:class:`circuits.core.values.Value`r!h jh!Nh&hHh(}r"(Ureftyper#Xclassr$hLhMXcircuits.core.values.Valuer%U refdomainr&Xpyr'h0]r(h.]r)U refexplicitr*h*]r+h,]r,h3]r-hWhXhYj,hZjFuh5Nh]r.h\)r/}r0(hj!h(}r1(h*]r2h,]r3(hbj'Xpy-classr4eh.]r5h0]r6h3]r7uh jh]r8hhXcircuits.core.values.Valuer9r:}r;(hUh j/ubah&hlubaubhhXN object that holds the results returned by the handlers invoked for the event.r<r=}r>(hXN object that holds the results returned by the handlers invoked for the event.r?h jubeh&j+ubah&jubjT)r@}rA(hUh(}rB(h*]rCh,]rDh.]rEh0]rFh3]rGuh jh]rHj&)rI}rJ(hUh(}rK(h*]rLh,]rMh.]rNh0]rOh3]rPuh j@h]rQ(hD)rR}rS(hUh(}rT(UreftyperUjkU reftargetrVXsuccessrWU refdomainrXjh0]rYh.]rZU refexplicitr[h*]r\h,]r]h3]r^uh jIh]r_jv)r`}ra(hjWh(}rb(h*]rch,]rdh.]reh0]rfh3]rguh jRh]rhhhXsuccessrirj}rk(hUh j`ubah&jubah&hHubhhX -- rlrm}rn(hUh jIubhhX%if this optional attribute is set to rorp}rq(hX%if this optional attribute is set to rrh jIubh\)rs}rt(hX``True``ruh(}rv(h*]rwh,]rxh.]ryh0]rzh3]r{uh jIh]r|hhXTruer}r~}r(hUh jsubah&hlubhhX, an associated event rr}r(hX, an associated event rh jIubh\)r}r(hX``EventSuccess``rh(}r(h*]rh,]rh.]rh0]rh3]ruh jIh]rhhX EventSuccessrr}r(hUh jubah&hlubhhX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(hX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh jIubeh&j+ubah&jubjT)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjkU reftargetrXsuccess_channelsrU refdomainrjh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rjv)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXsuccess_channelsrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(hXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh jubeh&j+ubah&jubjT)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjkU reftargetrXcompleterU refdomainrjh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rjv)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXcompleterr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhX%if this optional attribute is set to rr}r(hX%if this optional attribute is set to rh jubh\)r}r(hX``True``rh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXTruerr}r(hUh jubah&hlubhhX, an associated event rr }r (hX, an associated event r h jubh\)r }r (hX``EventComplete``rh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX EventCompleterr}r(hUh j ubah&hlubhhX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rr}r(hX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rh jubeh&j+ubah&jubjT)r}r(hUh(}r(h*]r h,]r!h.]r"h0]r#h3]r$uh jh]r%j&)r&}r'(hUh(}r((h*]r)h,]r*h.]r+h0]r,h3]r-uh jh]r.(hD)r/}r0(hUh(}r1(Ureftyper2jkU reftargetr3Xsuccess_channelsr4U refdomainr5jh0]r6h.]r7U refexplicitr8h*]r9h,]r:h3]r;uh j&h]r<jv)r=}r>(hj4h(}r?(h*]r@h,]rAh.]rBh0]rCh3]rDuh j/h]rEhhXsuccess_channelsrFrG}rH(hUh j=ubah&jubah&hHubhhX -- rIrJ}rK(hUh j&ubhhXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rLrM}rN(hXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rOh j&ubeh&j+ubah&jubeh&jubah&jubeh&jubaubeubeubeubh)rP}rQ(hUh hh!h$h&h'h(}rR(h*]rSh,]rTh.]rUh0]rVhah3]rWh auh5Kh6hh]rX(h8)rY}rZ(hX Componentsr[h jPh!h$h&hh jh!X[/home/prologic/work/circuits/circuits/app/daemon.py:docstring of circuits.app.daemon.Daemonr?h&j+h(}r@(h*]rAh,]rBh.]rCh0]rDh3]rEuh5Kh6hh]rFhhXDaemon ComponentrGrH}rI(hj>h j<ubaubj)rJ}rK(hUh jh!Nh&j h(}rL(h*]rMh,]rNh.]rOh0]rPh3]rQuh5Nh6hh]rRj()rS}rT(hUh(}rU(h*]rVh,]rWh.]rXh0]rYh3]rZuh jJh]r[(j2)r\}r](hUh(}r^(h*]r_h,]r`h.]rah0]rbh3]rcuh jSh]rdhhX Parametersrerf}rg(hUh j\ubah&j?ubj@)rh}ri(hUh(}rj(h*]rkh,]rlh.]rmh0]rnh3]rouh jSh]rpjJ)rq}rr(hUh(}rs(h*]rth,]ruh.]rvh0]rwh3]rxuh jhh]ry(jT)rz}r{(hUh(}r|(h*]r}h,]r~h.]rh0]rh3]ruh jqh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jzh]r(jv)r}r(hXpidfilerh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXpidfilerr}r(hUh jubah&jubhhX (rr}r(hUh jubhD)r}r(hUh(}r(UreftyperjkU reftargetrXstr or unicoderU refdomainrjuh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXstr or unicoderr}r(hUh jubah&jubah&hHubhhX)r}r(hUh jubhhX -- rr}r(hUh jubhhX .pid filenamerr}r(hX .pid filenamerh jubeh&j+ubah&jubjT)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jqh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(jv)r}r(hXstdinrh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXstdinrr}r(hUh jubah&jubhhX (rr}r(hUh jubhD)r}r(hUh(}r(UreftyperjkU reftargetrXstr or unicoderU refdomainrjuh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXstr or unicoderr}r(hUh jubah&jubah&hHubhhX)r}r(hUh jubhhX -- rr}r(hUh jubhhXfilename to log stdinr r }r (hXfilename to log stdinr h jubeh&j+ubah&jubjT)r }r (hUh(}r (h*]r h,]r h.]r h0]r h3]r uh jqh]r j&)r }r (hUh(}r (h*]r h,]r h.]r h0]r h3]r uh j h]r (jv)r }r (hXstdoutr h(}r (h*]r h,]r h.]r h0]r h3]r uh j h]r hhXstdoutr r! }r" (hUh j ubah&jubhhX (r# r$ }r% (hUh j ubhD)r& }r' (hUh(}r( (Ureftyper) jkU reftargetr* Xstr or unicoder+ U refdomainr, juh0]r- h.]r. U refexplicitr/ h*]r0 h,]r1 h3]r2 uh j h]r3 j)r4 }r5 (hj+ h(}r6 (h*]r7 h,]r8 h.]r9 h0]r: h3]r; uh j& h]r< hhXstr or unicoder= r> }r? (hUh j4 ubah&jubah&hHubhhX)r@ }rA (hUh j ubhhX -- rB rC }rD (hUh j ubhhXfilename to log stdoutrE rF }rG (hXfilename to log stdoutrH h j ubeh&j+ubah&jubjT)rI }rJ (hUh(}rK (h*]rL h,]rM h.]rN h0]rO h3]rP uh jqh]rQ j&)rR }rS (hUh(}rT (h*]rU h,]rV h.]rW h0]rX h3]rY uh jI h]rZ (jv)r[ }r\ (hXstderrr] h(}r^ (h*]r_ h,]r` h.]ra h0]rb h3]rc uh jR h]rd hhXstderrre rf }rg (hUh j[ ubah&jubhhX (rh ri }rj (hUh jR ubhD)rk }rl (hUh(}rm (Ureftypern jkU reftargetro Xstr or unicoderp U refdomainrq juh0]rr h.]rs U refexplicitrt h*]ru h,]rv h3]rw uh jR h]rx j)ry }rz (hjp h(}r{ (h*]r| h,]r} h.]r~ h0]r h3]r uh jk h]r hhXstr or unicoder r }r (hUh jy ubah&jubah&hHubhhX)r }r (hUh jR ubhhX -- r r }r (hUh jR ubhhXfilename to log stderrr r }r (hXfilename to log stderrr h jR ubeh&j+ubah&jubeh&jubah&jubeh&jubaubeubeubeubh)r }r (hUh hh!h$h&h'h(}r (h*]r h,]r h.]r h0]r hah3]r hauh5Kh6hh]r h8)r }r (hX Functionsr h j h!h$h&hh*}q?(h,]q@h.]qAh0]qBh2]qCh5]qDuh7Kh8hh]qE(csphinx.addnodes pending_xref qF)qG}qH(h!X:mod:`circuits.core.handlers`qIh"h;h#h&h(U pending_xrefqJh*}qK(UreftypeqLXmodqMUrefwarnqNU reftargetqOXcircuits.core.handlersqPU refdomainqQXpyqRh2]qSh0]qTU refexplicitqUh,]qVh.]qWh5]qXUrefdocqYUapi/circuits_core_handlersqZUpy:classq[NU py:moduleq\Nuh7Kh]q]cdocutils.nodes literal q^)q_}q`(h!hIh*}qa(h,]qbh.]qc(UxrefqdhRXpy-modqeeh0]qfh2]qgh5]qhuh"hGh]qicdocutils.nodes Text qjXcircuits.core.handlersqkql}qm(h!Uh"h_ubah(UliteralqnubaubhjX -- Handlersqoqp}qq(h!X -- Handlersqrh"h;ubeubcsphinx.addnodes index qs)qt}qu(h!Uh"hh#U qvh(Uindexqwh*}qx(h2]qyh0]qzh,]q{h.]q|h5]q}Uentriesq~]q(UsingleqXcircuits.core.handlers (module)Xmodule-circuits.core.handlersUtqauh7Kh8hh]qubcdocutils.nodes paragraph q)q}q(h!XLThis module define the @handler decorator/function and the HandlesType type.qh"hh#XZ/home/prologic/work/circuits/circuits/core/handlers.py:docstring of circuits.core.handlersqh(U paragraphqh*}q(h,]qh.]qh0]qh2]qh5]quh7Kh8hh]qhjXLThis module define the @handler decorator/function and the HandlesType type.qq}q(h!hh"hubaubh)q}q(h!Uh"hh#h&h(h)h*}q(h,]qh.]qh0]qh2]qhah5]qh auh7Kh8hh]q(h:)q}q(h!XClassesqh"hh#h&h(h>h*}q(h,]qh.]qh0]qh2]qh5]quh7Kh8hh]qhjXClassesqq}q(h!hh"hubaubhs)q}q(h!Uh"hh#U qh(hwh*}q(h2]qh0]qh,]qh.]qh5]qUentriesq]q(hX2HandlerMetaClass (class in circuits.core.handlers)hUtqauh7Nh8hh]qubcsphinx.addnodes desc q)q}q(h!Uh"hh#hh(Udescqh*}q(UnoindexqUdomainqXpyqh2]qh0]qh,]qh.]qh5]qUobjtypeqXclassqUdesctypeqhuh7Nh8hh]q(csphinx.addnodes desc_signature q)q}q(h!X!HandlerMetaClass(name, bases, ns)qh"hh#U qh(Udesc_signatureqh*}q(h2]qhaUmoduleqh$Xcircuits.core.handlersqЅq}qbh0]qh,]qh.]qh5]qhaUfullnameqXHandlerMetaClassqUclassqUUfirstqډuh7Nh8hh]q(csphinx.addnodes desc_annotation q)q}q(h!Xclass qh"hh#hh(Udesc_annotationqh*}q(h,]qh.]qh0]qh2]qh5]quh7Nh8hh]qhjXclass q腁q}q(h!Uh"hubaubcsphinx.addnodes desc_addname q)q}q(h!Xcircuits.core.handlers.qh"hh#hh(U desc_addnameqh*}q(h,]qh.]qh0]qh2]qh5]quh7Nh8hh]qhjXcircuits.core.handlers.qq}q(h!Uh"hubaubcsphinx.addnodes desc_name q)q}q(h!hh"hh#hh(U desc_nameqh*}q(h,]qh.]rh0]rh2]rh5]ruh7Nh8hh]rhjXHandlerMetaClassrr}r(h!Uh"hubaubcsphinx.addnodes desc_parameterlist r)r }r (h!Uh"hh#hh(Udesc_parameterlistr h*}r (h,]r h.]rh0]rh2]rh5]ruh7Nh8hh]r(csphinx.addnodes desc_parameter r)r}r(h!Xnamerh*}r(h,]rh.]rh0]rh2]rh5]ruh"j h]rhjXnamerr}r (h!Uh"jubah(Udesc_parameterr!ubj)r"}r#(h!Xbasesr$h*}r%(h,]r&h.]r'h0]r(h2]r)h5]r*uh"j h]r+hjXbasesr,r-}r.(h!Uh"j"ubah(j!ubj)r/}r0(h!Xnsr1h*}r2(h,]r3h.]r4h0]r5h2]r6h5]r7uh"j h]r8hjXnsr9r:}r;(h!Uh"j/ubah(j!ubeubeubcsphinx.addnodes desc_content r<)r=}r>(h!Uh"hh#hh(U desc_contentr?h*}r@(h,]rAh.]rBh0]rCh2]rDh5]rEuh7Nh8hh]rFh)rG}rH(h!XBases: :class:`type`rIh"j=h#hh(hh*}rJ(h,]rKh.]rLh0]rMh2]rNh5]rOuh7Kh8hh]rP(hjXBases: rQrR}rS(h!XBases: rTh"jGubhF)rU}rV(h!X :class:`type`rWh"jGh#h&h(hJh*}rX(UreftyperYXclassrZhNhOXtyper[U refdomainr\Xpyr]h2]r^h0]r_U refexplicitr`h,]rah.]rbh5]rchYhZh[hh\Xcircuits.core.handlersrduh7Kh]reh^)rf}rg(h!jWh*}rh(h,]rih.]rj(hdj]Xpy-classrkeh0]rlh2]rmh5]rnuh"jUh]rohjXtyperprq}rr(h!Uh"jfubah(hnubaubeubaubeubeubh)rs}rt(h!Uh"hh#h&h(h)h*}ru(h,]rvh.]rwh0]rxh2]ryhah5]rzh auh7Kh8hh]r{(h:)r|}r}(h!X Componentsr~h"jsh#h&h(h>h*}r(h,]rh.]rh0]rh2]rh5]ruh7Kh8hh]rhjX Componentsrr}r(h!j~h"j|ubaubh)r}r(h!X**none**rh"jsh#h&h(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7Kh8hh]rcdocutils.nodes strong r)r}r(h!jh*}r(h,]rh.]rh0]rh2]rh5]ruh"jh]rhjXnonerr}r(h!Uh"jubah(Ustrongrubaubeubh)r}r(h!Uh"hh#h&h(h)h*}r(h,]rh.]rh0]rh2]rhah5]rh auh7Kh8hh]r(h:)r}r(h!XEventsrh"jh#h&h(h>h*}r(h,]rh.]rh0]rh2]rh5]ruh7Kh8hh]rhjXEventsrr}r(h!jh"jubaubh)r}r(h!X**none**rh"jh#h&h(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7Kh8hh]rj)r}r(h!jh*}r(h,]rh.]rh0]rh2]rh5]ruh"jh]rhjXnonerr}r(h!Uh"jubah(jubaubeubh)r}r(h!Uh"hh#h&h(h)h*}r(h,]rh.]rh0]rh2]rhah5]rhauh7Kh8hh]r(h:)r}r(h!X Functionsrh"jh#h&h(h>h*}r(h,]rh.]rh0]rh2]rh5]ruh7Kh8hh]rhjX Functionsrr}r(h!jh"jubaubhs)r}r(h!Uh"jh#Xb/home/prologic/work/circuits/circuits/core/handlers.py:docstring of circuits.core.handlers.handlerrh(hwh*}r(h2]rh0]rh,]rh.]rh5]rUentriesr]r(hX,handler() (in module circuits.core.handlers)hUtrauh7Nh8hh]rubh)r}r(h!Uh"jh#jh(hh*}r(hhXpyrh2]rh0]rh,]rh.]rh5]rhXfunctionrhjuh7Nh8hh]r(h)r}r(h!Xhandler(*names, **kwargs)rh"jh#hh(hh*}r(h2]rhahh$Xcircuits.core.handlersrr}rbh0]rh,]rh.]rh5]rhahXhandlerrhUhډuh7Nh8hh]r(h)r }r (h!Xcircuits.core.handlers.r h"jh#hh(hh*}r (h,]r h.]rh0]rh2]rh5]ruh7Nh8hh]rhjXcircuits.core.handlers.rr}r(h!Uh"j ubaubh)r}r(h!jh"jh#hh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7Nh8hh]rhjXhandlerrr }r!(h!Uh"jubaubj)r"}r#(h!Uh"jh#hh(j h*}r$(h,]r%h.]r&h0]r'h2]r(h5]r)uh7Nh8hh]r*(j)r+}r,(h!X*namesr-h*}r.(h,]r/h.]r0h0]r1h2]r2h5]r3uh"j"h]r4hjX*namesr5r6}r7(h!Uh"j+ubah(j!ubj)r8}r9(h!X**kwargsr:h*}r;(h,]r<h.]r=h0]r>h2]r?h5]r@uh"j"h]rAhjX**kwargsrBrC}rD(h!Uh"j8ubah(j!ubeubeubj<)rE}rF(h!Uh"jh#hh(j?h*}rG(h,]rHh.]rIh0]rJh2]rKh5]rLuh7Nh8hh]rM(h)rN}rO(h!XCreates an Event HandlerrPh"jEh#jh(hh*}rQ(h,]rRh.]rSh0]rTh2]rUh5]rVuh7Kh8hh]rWhjXCreates an Event HandlerrXrY}rZ(h!jPh"jNubaubh)r[}r\(h!XThis decorator can be applied to methods of classes derived from :class:`circuits.core.components.BaseComponent`. It marks the method as a handler for the events passed as arguments to the ``@handler`` decorator. The events are specified by their name.r]h"jEh#jh(hh*}r^(h,]r_h.]r`h0]rah2]rbh5]rcuh7Kh8hh]rd(hjXAThis decorator can be applied to methods of classes derived from rerf}rg(h!XAThis decorator can be applied to methods of classes derived from rhh"j[ubhF)ri}rj(h!X/:class:`circuits.core.components.BaseComponent`rkh"j[h#h&h(hJh*}rl(UreftypermXclassrnhNhOX&circuits.core.components.BaseComponentroU refdomainrpXpyrqh2]rrh0]rsU refexplicitrth,]ruh.]rvh5]rwhYhZh[Nh\jduh7Kh]rxh^)ry}rz(h!jkh*}r{(h,]r|h.]r}(hdjqXpy-classr~eh0]rh2]rh5]ruh"jih]rhjX&circuits.core.components.BaseComponentrr}r(h!Uh"jyubah(hnubaubhjXM. It marks the method as a handler for the events passed as arguments to the rr}r(h!XM. It marks the method as a handler for the events passed as arguments to the rh"j[ubh^)r}r(h!X ``@handler``rh*}r(h,]rh.]rh0]rh2]rh5]ruh"j[h]rhjX@handlerrr}r(h!Uh"jubah(hnubhjX3 decorator. The events are specified by their name.rr}r(h!X3 decorator. The events are specified by their name.rh"j[ubeubh)r}r(h!XThe decorated method's arguments must match the arguments passed to the :class:`circuits.core.events.Event` on creation. Optionally, the method may have an additional first argument named *event*. If declared, the event object that caused the handler to be invoked is assigned to it.rh"jEh#jh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7Kh8hh]r(hjXHThe decorated method's arguments must match the arguments passed to the rr}r(h!XHThe decorated method's arguments must match the arguments passed to the rh"jubhF)r}r(h!X#:class:`circuits.core.events.Event`rh"jh#h&h(hJh*}r(UreftyperXclassrhNhOXcircuits.core.events.EventrU refdomainrXpyrh2]rh0]rU refexplicitrh,]rh.]rh5]rhYhZh[Nh\jduh7K h]rh^)r}r(h!jh*}r(h,]rh.]r(hdjXpy-classreh0]rh2]rh5]ruh"jh]rhjXcircuits.core.events.Eventrr}r(h!Uh"jubah(hnubaubhjXQ on creation. Optionally, the method may have an additional first argument named rr}r(h!XQ on creation. Optionally, the method may have an additional first argument named rh"jubcdocutils.nodes emphasis r)r}r(h!X*event*rh*}r(h,]rh.]rh0]rh2]rh5]ruh"jh]rhjXeventrr}r(h!Uh"jubah(UemphasisrubhjXX. If declared, the event object that caused the handler to be invoked is assigned to it.rr}r(h!XX. If declared, the event object that caused the handler to be invoked is assigned to it.rh"jubeubh)r}r(h!X.By default, the handler is invoked by the component's root :class:`~.manager.Manager` for events that are propagated on the channel determined by the BaseComponent's *channel* attribute. This may be overridden by specifying a different channel as a keyword parameter of the decorator (``channel=...``).rh"jEh#jh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7K h8hh]r(hjX;By default, the handler is invoked by the component's root rr}r(h!X;By default, the handler is invoked by the component's root rh"jubhF)r}r(h!X:class:`~.manager.Manager`rh"jh#h&h(hJh*}r(UreftyperXclassrU refspecificrhNhOXmanager.ManagerrU refdomainrXpyrh2]rh0]rU refexplicitrh,]rh.]rh5]rhYhZh[Nh\jduh7Kh]rh^)r}r(h!jh*}r(h,]rh.]r(hdjXpy-classreh0]rh2]rh5]ruh"jh]rhjXManagerrr}r(h!Uh"jubah(hnubaubhjXQ for events that are propagated on the channel determined by the BaseComponent's r r }r (h!XQ for events that are propagated on the channel determined by the BaseComponent's r h"jubj)r }r(h!X *channel*rh*}r(h,]rh.]rh0]rh2]rh5]ruh"jh]rhjXchannelrr}r(h!Uh"j ubah(jubhjXn attribute. This may be overridden by specifying a different channel as a keyword parameter of the decorator (rr}r(h!Xn attribute. This may be overridden by specifying a different channel as a keyword parameter of the decorator (rh"jubh^)r}r(h!X``channel=...``r h*}r!(h,]r"h.]r#h0]r$h2]r%h5]r&uh"jh]r'hjX channel=...r(r)}r*(h!Uh"jubah(hnubhjX).r+r,}r-(h!X).r.h"jubeubh)r/}r0(h!XKeyword argument ``priority`` influences the order in which handlers for a specific event are invoked. The higher the priority, the earlier the handler is executed.r1h"jEh#jh(hh*}r2(h,]r3h.]r4h0]r5h2]r6h5]r7uh7Kh8hh]r8(hjXKeyword argument r9r:}r;(h!XKeyword argument r<h"j/ubh^)r=}r>(h!X ``priority``r?h*}r@(h,]rAh.]rBh0]rCh2]rDh5]rEuh"j/h]rFhjXpriorityrGrH}rI(h!Uh"j=ubah(hnubhjX influences the order in which handlers for a specific event are invoked. The higher the priority, the earlier the handler is executed.rJrK}rL(h!X influences the order in which handlers for a specific event are invoked. The higher the priority, the earlier the handler is executed.rMh"j/ubeubh)rN}rO(h!XWA handler may also be specified as a filter by adding the keyword argument ``filter=True`` to the decorator. If such a handler returns a value different from ``None``, no more handlers are invoked for the handled event. Filtering handlers are invoked before normal handlers with the same priority (but after any handlers with higher priority).rPh"jEh#jh(hh*}rQ(h,]rRh.]rSh0]rTh2]rUh5]rVuh7Kh8hh]rW(hjXKA handler may also be specified as a filter by adding the keyword argument rXrY}rZ(h!XKA handler may also be specified as a filter by adding the keyword argument r[h"jNubh^)r\}r](h!X``filter=True``r^h*}r_(h,]r`h.]rah0]rbh2]rch5]rduh"jNh]rehjX filter=Truerfrg}rh(h!Uh"j\ubah(hnubhjXD to the decorator. If such a handler returns a value different from rirj}rk(h!XD to the decorator. If such a handler returns a value different from rlh"jNubh^)rm}rn(h!X``None``roh*}rp(h,]rqh.]rrh0]rsh2]rth5]ruuh"jNh]rvhjXNonerwrx}ry(h!Uh"jmubah(hnubhjX, no more handlers are invoked for the handled event. Filtering handlers are invoked before normal handlers with the same priority (but after any handlers with higher priority).rzr{}r|(h!X, no more handlers are invoked for the handled event. Filtering handlers are invoked before normal handlers with the same priority (but after any handlers with higher priority).r}h"jNubeubh)r~}r(h!XIf you want to override a handler defined in a base class of your component, you must specify ``override=True``, else your method becomes an additional handler for the event.rh"jEh#jh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7Kh8hh]r(hjX^If you want to override a handler defined in a base class of your component, you must specify rr}r(h!X^If you want to override a handler defined in a base class of your component, you must specify rh"j~ubh^)r}r(h!X``override=True``rh*}r(h,]rh.]rh0]rh2]rh5]ruh"j~h]rhjX override=Truerr}r(h!Uh"jubah(hnubhjX?, else your method becomes an additional handler for the event.rr}r(h!X?, else your method becomes an additional handler for the event.rh"j~ubeubh)r}r(h!X**Return value**rh"jEh#jh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7K"h8hh]rj)r}r(h!jh*}r(h,]rh.]rh0]rh2]rh5]ruh"jh]rhjX Return valuerr}r(h!Uh"jubah(jubaubh)r}r(h!XNormally, the results returned by the handlers for an event are simply collected in the :class:`circuits.core.events.Event`'s :attr:`value` attribute. As a special case, a handler may return a :class:`types.GeneratorType`. This signals to the dispatcher that the handler isn't ready to deliver a result yet. Rather, it has interrupted it's execution with a ``yield None`` statement, thus preserving its current execution state.rh"jEh#jh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7K$h8hh]r(hjXXNormally, the results returned by the handlers for an event are simply collected in the rr}r(h!XXNormally, the results returned by the handlers for an event are simply collected in the rh"jubhF)r}r(h!X#:class:`circuits.core.events.Event`rh"jh#Nh(hJh*}r(UreftyperXclassrhNhOXcircuits.core.events.EventrU refdomainrXpyrh2]rh0]rU refexplicitrh,]rh.]rh5]rhYhZh[Nh\jduh7Nh]rh^)r}r(h!jh*}r(h,]rh.]r(hdjXpy-classreh0]rh2]rh5]ruh"jh]rhjXcircuits.core.events.Eventrr}r(h!Uh"jubah(hnubaubhjX's rr}r(h!X's rh"jubhF)r}r(h!X :attr:`value`rh"jh#Nh(hJh*}r(UreftyperXattrrhNhOXvaluerU refdomainrXpyrh2]rh0]rU refexplicitrh,]rh.]rh5]rhYhZh[Nh\jduh7Nh]rh^)r}r(h!jh*}r(h,]rh.]r(hdjXpy-attrreh0]rh2]rh5]ruh"jh]rhjXvaluerr}r(h!Uh"jubah(hnubaubhjX6 attribute. As a special case, a handler may return a rr}r(h!X6 attribute. As a special case, a handler may return a rh"jubhF)r}r(h!X:class:`types.GeneratorType`rh"jh#Nh(hJh*}r(UreftyperXclassrhNhOXtypes.GeneratorTyper U refdomainr Xpyr h2]r h0]r U refexplicitrh,]rh.]rh5]rhYhZh[Nh\jduh7Nh]rh^)r}r(h!jh*}r(h,]rh.]r(hdj Xpy-classreh0]rh2]rh5]ruh"jh]rhjXtypes.GeneratorTyperr}r(h!Uh"jubah(hnubaubhjX. This signals to the dispatcher that the handler isn't ready to deliver a result yet. Rather, it has interrupted it's execution with a r r!}r"(h!X. This signals to the dispatcher that the handler isn't ready to deliver a result yet. Rather, it has interrupted it's execution with a r#h"jubh^)r$}r%(h!X``yield None``r&h*}r'(h,]r(h.]r)h0]r*h2]r+h5]r,uh"jh]r-hjX yield Noner.r/}r0(h!Uh"j$ubah(hnubhjX8 statement, thus preserving its current execution state.r1r2}r3(h!X8 statement, thus preserving its current execution state.r4h"jubeubh)r5}r6(h!XThe dispatcher saves the returned generator object as a task. All tasks are reexamined (i.e. their :meth:`next()` method is invoked) when the pending events have been executed.r7h"jEh#jh(hh*}r8(h,]r9h.]r:h0]r;h2]r<h5]r=uh7K,h8hh]r>(hjXcThe dispatcher saves the returned generator object as a task. All tasks are reexamined (i.e. their r?r@}rA(h!XcThe dispatcher saves the returned generator object as a task. All tasks are reexamined (i.e. their rBh"j5ubhF)rC}rD(h!X:meth:`next()`rEh"j5h#Nh(hJh*}rF(UreftyperGXmethrHhNhOXnextrIU refdomainrJXpyrKh2]rLh0]rMU refexplicitrNh,]rOh.]rPh5]rQhYhZh[Nh\jduh7Nh]rRh^)rS}rT(h!jEh*}rU(h,]rVh.]rW(hdjKXpy-methrXeh0]rYh2]rZh5]r[uh"jCh]r\hjXnext()r]r^}r_(h!Uh"jSubah(hnubaubhjX? method is invoked) when the pending events have been executed.r`ra}rb(h!X? method is invoked) when the pending events have been executed.rch"j5ubeubh)rd}re(h!XThis feature avoids an unnecessarily complicated chaining of event handlers. Imagine a handler A that needs the results from firing an event E in order to complete. Then without this feature, the final action of A would be to fire event E, and another handler for an event ``SuccessE`` would be required to complete handler A's operation, now having the result from invoking E available (actually it's even a bit more complicated).rfh"jEh#jh(hh*}rg(h,]rhh.]rih0]rjh2]rkh5]rluh7K0h8hh]rm(hjXThis feature avoids an unnecessarily complicated chaining of event handlers. Imagine a handler A that needs the results from firing an event E in order to complete. Then without this feature, the final action of A would be to fire event E, and another handler for an event rnro}rp(h!XThis feature avoids an unnecessarily complicated chaining of event handlers. Imagine a handler A that needs the results from firing an event E in order to complete. Then without this feature, the final action of A would be to fire event E, and another handler for an event rqh"jdubh^)rr}rs(h!X ``SuccessE``rth*}ru(h,]rvh.]rwh0]rxh2]ryh5]rzuh"jdh]r{hjXSuccessEr|r}}r~(h!Uh"jrubah(hnubhjX would be required to complete handler A's operation, now having the result from invoking E available (actually it's even a bit more complicated).rr}r(h!X would be required to complete handler A's operation, now having the result from invoking E available (actually it's even a bit more complicated).rh"jdubeubh)r}r(h!X Using this "suspend" feature, the handler simply fires event E and then yields ``None`` until e.g. it finds a result in E's :attr:`value` attribute. For the simplest scenario, there even is a utility method :meth:`circuits.core.manager.Manager.callEvent` that combines firing and waiting.rh"jEh#jh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7K8h8hh]r(hjXOUsing this "suspend" feature, the handler simply fires event E and then yields rr}r(h!XOUsing this "suspend" feature, the handler simply fires event E and then yields rh"jubh^)r}r(h!X``None``rh*}r(h,]rh.]rh0]rh2]rh5]ruh"jh]rhjXNonerr}r(h!Uh"jubah(hnubhjX% until e.g. it finds a result in E's rr}r(h!X% until e.g. it finds a result in E's rh"jubhF)r}r(h!X :attr:`value`rh"jh#Nh(hJh*}r(UreftyperXattrrhNhOXvaluerU refdomainrXpyrh2]rh0]rU refexplicitrh,]rh.]rh5]rhYhZh[Nh\jduh7Nh]rh^)r}r(h!jh*}r(h,]rh.]r(hdjXpy-attrreh0]rh2]rh5]ruh"jh]rhjXvaluerr}r(h!Uh"jubah(hnubaubhjXF attribute. For the simplest scenario, there even is a utility method rr}r(h!XF attribute. For the simplest scenario, there even is a utility method rh"jubhF)r}r(h!X/:meth:`circuits.core.manager.Manager.callEvent`rh"jh#Nh(hJh*}r(UreftyperXmethrhNhOX'circuits.core.manager.Manager.callEventrU refdomainrXpyrh2]rh0]rU refexplicitrh,]rh.]rh5]rhYhZh[Nh\jduh7Nh]rh^)r}r(h!jh*}r(h,]rh.]r(hdjXpy-methreh0]rh2]rh5]ruh"jh]rhjX)circuits.core.manager.Manager.callEvent()rr}r(h!Uh"jubah(hnubaubhjX" that combines firing and waiting.rr}r(h!X" that combines firing and waiting.rh"jubeubeubeubhs)r}r(h!Uh"jh#Nh(hwh*}r(h2]rh0]rh,]rh.]rh5]rUentriesr]r(hX0reprhandler() (in module circuits.core.handlers)h Utrauh7Nh8hh]rubh)r}r(h!Uh"jh#Nh(hh*}r(hhXpyrh2]rh0]rh,]rh.]rh5]rhXfunctionrhjuh7Nh8hh]r(h)r}r(h!Xreprhandler(handler)rh"jh#hh(hh*}r(h2]rh ahh$Xcircuits.core.handlersrr}rbh0]rh,]rh.]rh5]rh ahX reprhandlerrhUhډuh7Nh8hh]r(h)r }r (h!Xcircuits.core.handlers.r h"jh#hh(hh*}r (h,]r h.]rh0]rh2]rh5]ruh7Nh8hh]rhjXcircuits.core.handlers.rr}r(h!Uh"j ubaubh)r}r(h!jh"jh#hh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7Nh8hh]rhjX reprhandlerrr }r!(h!Uh"jubaubj)r"}r#(h!Uh"jh#hh(j h*}r$(h,]r%h.]r&h0]r'h2]r(h5]r)uh7Nh8hh]r*j)r+}r,(h!Xhandlerr-h*}r.(h,]r/h.]r0h0]r1h2]r2h5]r3uh"j"h]r4hjXhandlerr5r6}r7(h!Uh"j+ubah(j!ubaubeubj<)r8}r9(h!Uh"jh#hh(j?h*}r:(h,]r;h.]r<h0]r=h2]r>h5]r?uh7Nh8hh]r@ubeubeubeubah!UU transformerrANU footnote_refsrB}rCUrefnamesrD}rEUsymbol_footnotesrF]rGUautofootnote_refsrH]rIUsymbol_footnote_refsrJ]rKU citationsrL]rMh8hU current_linerNNUtransform_messagesrO]rPUreporterrQNUid_startrRKU autofootnotesrS]rTU citation_refsrU}rVUindirect_targetsrW]rXUsettingsrY(cdocutils.frontend Values rZor[}r\(Ufootnote_backlinksr]KUrecord_dependenciesr^NU rfc_base_urlr_Uhttp://tools.ietf.org/html/r`U tracebackraUpep_referencesrbNUstrip_commentsrcNU toc_backlinksrdUentryreU language_coderfUenrgU datestamprhNU report_levelriKU _destinationrjNU halt_levelrkKU strip_classesrlNh>NUerror_encoding_error_handlerrmUbackslashreplacernUdebugroNUembed_stylesheetrpUoutput_encoding_error_handlerrqUstrictrrU sectnum_xformrsKUdump_transformsrtNU docinfo_xformruKUwarning_streamrvNUpep_file_url_templaterwUpep-%04drxUexit_status_levelryKUconfigrzNUstrict_visitorr{NUcloak_email_addressesr|Utrim_footnote_reference_spacer}Uenvr~NUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUG/home/prologic/work/circuits/docs/source/api/circuits_core_handlers.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjrUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hjhjhhhhhjshhh4cdocutils.nodes target r)r}r(h!Uh"hh#hvh(Utargetrh*}r(h,]rh2]rh4ah0]rUismodrh.]rh5]ruh7Kh8hh]rubhjh juUsubstitution_namesr}rh(h8h*}r(h,]rh2]rh0]rUsourcerh&h.]rh5]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_core_pollers.doctree0000644000014400001440000004463412113366656025470 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(XclassesqNX functionsqNXcircuits.core.pollers.EPollqX circuits.core.pollers.BasePollerq X componentsq NX$circuits.core.pollers -- i/o pollersq NXcircuits.core.pollers.Selectq Xcircuits.core.pollers.Pollq XeventsqNuUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hUclassesqhU functionsqhhh h h U componentsqh U!circuits-core-pollers-i-o-pollersqh h h h hUeventsquUchildrenq]qcdocutils.nodes section q)q }q!(U rawsourceq"UUparentq#hUsourceq$cdocutils.nodes reprunicode q%XF/home/prologic/work/circuits/docs/source/api/circuits_core_pollers.rstq&q'}q(bUtagnameq)Usectionq*U attributesq+}q,(Udupnamesq-]q.Uclassesq/]q0Ubackrefsq1]q2Uidsq3]q4(Xmodule-circuits.core.pollersq5heUnamesq6]q7h auUlineq8KUdocumentq9hh]q:(cdocutils.nodes title q;)q<}q=(h"X+:mod:`circuits.core.pollers` -- I/O Pollersq>h#h h$h'h)Utitleq?h+}q@(h-]qAh/]qBh1]qCh3]qDh6]qEuh8Kh9hh]qF(csphinx.addnodes pending_xref qG)qH}qI(h"X:mod:`circuits.core.pollers`qJh#hqwh)Uindexqxh+}qy(h3]qzh1]q{h-]q|h/]q}h6]q~Uentriesq]q(UsingleqXcircuits.core.pollers (module)Xmodule-circuits.core.pollersUtqauh8Kh9hh]qubcdocutils.nodes paragraph q)q}q(h"X7Poller Components for asynchronous file and socket I/O.qh#h h$XX/home/prologic/work/circuits/circuits/core/pollers.py:docstring of circuits.core.pollersqh)U paragraphqh+}q(h-]qh/]qh1]qh3]qh6]quh8Kh9hh]qhkX7Poller Components for asynchronous file and socket I/O.qq}q(h"hh#hubaubh)q}q(h"XThis module contains Poller components that enable polling of file or socket descriptors for read/write events. Pollers: - Select - Poll - EPollqh#h h$hh)hh+}q(h-]qh/]qh1]qh3]qh6]quh8Kh9hh]qhkXThis module contains Poller components that enable polling of file or socket descriptors for read/write events. Pollers: - Select - Poll - EPollqq}q(h"hh#hubaubh)q}q(h"Uh#h h$h'h)h*h+}q(h-]qh/]qh1]qh3]qhah6]qhauh8Kh9hh]q(h;)q}q(h"XClassesqh#hh$h'h)h?h+}q(h-]qh/]qh1]qh3]qh6]quh8Kh9hh]qhkXClassesqq}q(h"hh#hubaubh)q}q(h"X**none**qh#hh$h'h)hh+}q(h-]qh/]qh1]qh3]qh6]quh8K h9hh]qcdocutils.nodes strong q)q}q(h"hh+}q(h-]qh/]qh1]qh3]qh6]quh#hh]qhkXnoneq˅q}q(h"Uh#hubah)Ustrongqubaubeubh)q}q(h"Uh#h h$h'h)h*h+}q(h-]qh/]qh1]qh3]qhah6]qh auh8Kh9hh]q(h;)q}q(h"X Componentsqh#hh$h'h)h?h+}q(h-]qh/]qh1]qh3]qh6]quh8Kh9hh]qhkX Componentsq⅁q}q(h"hh#hubaubht)q}q(h"Uh#hh$U qh)hxh+}q(h3]qh1]qh-]qh/]qh6]qUentriesq]q(hX+BasePoller (class in circuits.core.pollers)h Utqauh8Nh9hh]qubcsphinx.addnodes desc q)q}q(h"Uh#hh$hh)Udescqh+}q(UnoindexqUdomainqXpyqh3]qh1]qh-]qh/]qh6]qUobjtypeqXclassrUdesctyperjuh8Nh9hh]r(csphinx.addnodes desc_signature r)r}r(h"X&BasePoller(timeout=0.01, channel=None)rh#hh$U rh)Udesc_signaturerh+}r (h3]r h aUmoduler h%Xcircuits.core.pollersr r }rbh1]rh-]rh/]rh6]rh aUfullnamerX BasePollerrUclassrUUfirstruh8Nh9hh]r(csphinx.addnodes desc_annotation r)r}r(h"Xclass rh#jh$jh)Udesc_annotationrh+}r(h-]rh/]rh1]r h3]r!h6]r"uh8Nh9hh]r#hkXclass r$r%}r&(h"Uh#jubaubcsphinx.addnodes desc_addname r')r(}r)(h"Xcircuits.core.pollers.r*h#jh$jh)U desc_addnamer+h+}r,(h-]r-h/]r.h1]r/h3]r0h6]r1uh8Nh9hh]r2hkXcircuits.core.pollers.r3r4}r5(h"Uh#j(ubaubcsphinx.addnodes desc_name r6)r7}r8(h"jh#jh$jh)U desc_namer9h+}r:(h-]r;h/]r<h1]r=h3]r>h6]r?uh8Nh9hh]r@hkX BasePollerrArB}rC(h"Uh#j7ubaubcsphinx.addnodes desc_parameterlist rD)rE}rF(h"Uh#jh$jh)Udesc_parameterlistrGh+}rH(h-]rIh/]rJh1]rKh3]rLh6]rMuh8Nh9hh]rN(csphinx.addnodes desc_parameter rO)rP}rQ(h"X timeout=0.01rRh+}rS(h-]rTh/]rUh1]rVh3]rWh6]rXuh#jEh]rYhkX timeout=0.01rZr[}r\(h"Uh#jPubah)Udesc_parameterr]ubjO)r^}r_(h"X channel=Noner`h+}ra(h-]rbh/]rch1]rdh3]reh6]rfuh#jEh]rghkX channel=Nonerhri}rj(h"Uh#j^ubah)j]ubeubeubcsphinx.addnodes desc_content rk)rl}rm(h"Uh#hh$jh)U desc_contentrnh+}ro(h-]rph/]rqh1]rrh3]rsh6]rtuh8Nh9hh]ruh)rv}rw(h"X6Bases: :class:`circuits.core.components.BaseComponent`rxh#jlh$hh)hh+}ry(h-]rzh/]r{h1]r|h3]r}h6]r~uh8Kh9hh]r(hkXBases: rr}r(h"XBases: rh#jvubhG)r}r(h"X/:class:`circuits.core.components.BaseComponent`rh#jvh$h'h)hKh+}r(UreftyperXclassrhOhPX&circuits.core.components.BaseComponentrU refdomainrXpyrh3]rh1]rU refexplicitrh-]rh/]rh6]rhZh[h\jh]Xcircuits.core.pollersruh8Kh]rh_)r}r(h"jh+}r(h-]rh/]r(hejXpy-classreh1]rh3]rh6]ruh#jh]rhkX&circuits.core.components.BaseComponentrr}r(h"Uh#jubah)houbaubeubaubeubht)r}r(h"Uh#hh$X_/home/prologic/work/circuits/circuits/core/pollers.py:docstring of circuits.core.pollers.Selectrh)hxh+}r(h3]rh1]rh-]rh/]rh6]rUentriesr]r(hX'Select (class in circuits.core.pollers)h Utrauh8Nh9hh]rubh)r}r(h"Uh#hh$jh)hh+}r(hhXpyrh3]rh1]rh-]rh/]rh6]rhXclassrjjuh8Nh9hh]r(j)r}r(h"X&Select(timeout=0.01, channel='select')rh#jh$jh)jh+}r(h3]rh aj h%Xcircuits.core.pollersrr}rbh1]rh-]rh/]rh6]rh ajXSelectrjUjuh8Nh9hh]r(j)r}r(h"Xclass rh#jh$jh)jh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]rhkXclass rr}r(h"Uh#jubaubj')r}r(h"Xcircuits.core.pollers.rh#jh$jh)j+h+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]rhkXcircuits.core.pollers.rr}r(h"Uh#jubaubj6)r}r(h"jh#jh$jh)j9h+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]rhkXSelectrr}r(h"Uh#jubaubjD)r}r(h"Uh#jh$jh)jGh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]r(jO)r}r(h"X timeout=0.01rh+}r(h-]rh/]rh1]rh3]rh6]ruh#jh]rhkX timeout=0.01rr}r(h"Uh#jubah)j]ubjO)r}r(h"Xchannel='select'rh+}r(h-]rh/]r h1]r h3]r h6]r uh#jh]r hkXchannel='select'rr}r(h"Uh#jubah)j]ubeubeubjk)r}r(h"Uh#jh$jh)jnh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]r(h)r}r(h"X0Bases: :class:`circuits.core.pollers.BasePoller`rh#jh$hh)hh+}r(h-]rh/]rh1]r h3]r!h6]r"uh8Kh9hh]r#(hkXBases: r$r%}r&(h"XBases: r'h#jubhG)r(}r)(h"X):class:`circuits.core.pollers.BasePoller`r*h#jh$h'h)hKh+}r+(Ureftyper,Xclassr-hOhPX circuits.core.pollers.BasePollerr.U refdomainr/Xpyr0h3]r1h1]r2U refexplicitr3h-]r4h/]r5h6]r6hZh[h\jh]juh8Kh]r7h_)r8}r9(h"j*h+}r:(h-]r;h/]r<(hej0Xpy-classr=eh1]r>h3]r?h6]r@uh#j(h]rAhkX circuits.core.pollers.BasePollerrBrC}rD(h"Uh#j8ubah)houbaubeubh)rE}rF(h"X*Select(...) -> new Select Poller ComponentrGh#jh$jh)hh+}rH(h-]rIh/]rJh1]rKh3]rLh6]rMuh8Kh9hh]rNhkX*Select(...) -> new Select Poller ComponentrOrP}rQ(h"jGh#jEubaubh)rR}rS(h"XCreates a new Select Poller Component that uses the select poller implementation. This poller is not recommended but is available for legacy reasons as most systems implement select-based polling for backwards compatibility.rTh#jh$jh)hh+}rU(h-]rVh/]rWh1]rXh3]rYh6]rZuh8Kh9hh]r[hkXCreates a new Select Poller Component that uses the select poller implementation. This poller is not recommended but is available for legacy reasons as most systems implement select-based polling for backwards compatibility.r\r]}r^(h"jTh#jRubaubeubeubht)r_}r`(h"Uh#hh$X]/home/prologic/work/circuits/circuits/core/pollers.py:docstring of circuits.core.pollers.Pollrah)hxh+}rb(h3]rch1]rdh-]reh/]rfh6]rgUentriesrh]ri(hX%Poll (class in circuits.core.pollers)h Utrjauh8Nh9hh]rkubh)rl}rm(h"Uh#hh$jah)hh+}rn(hhXpyroh3]rph1]rqh-]rrh/]rsh6]rthXclassrujjuuh8Nh9hh]rv(j)rw}rx(h"X"Poll(timeout=0.01, channel='poll')ryh#jlh$jh)jh+}rz(h3]r{h aj h%Xcircuits.core.pollersr|r}}r~bh1]rh-]rh/]rh6]rh ajXPollrjUjuh8Nh9hh]r(j)r}r(h"Xclass rh#jwh$jh)jh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]rhkXclass rr}r(h"Uh#jubaubj')r}r(h"Xcircuits.core.pollers.rh#jwh$jh)j+h+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]rhkXcircuits.core.pollers.rr}r(h"Uh#jubaubj6)r}r(h"jh#jwh$jh)j9h+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]rhkXPollrr}r(h"Uh#jubaubjD)r}r(h"Uh#jwh$jh)jGh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]r(jO)r}r(h"X timeout=0.01rh+}r(h-]rh/]rh1]rh3]rh6]ruh#jh]rhkX timeout=0.01rr}r(h"Uh#jubah)j]ubjO)r}r(h"Xchannel='poll'rh+}r(h-]rh/]rh1]rh3]rh6]ruh#jh]rhkXchannel='poll'rr}r(h"Uh#jubah)j]ubeubeubjk)r}r(h"Uh#jlh$jh)jnh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]r(h)r}r(h"X0Bases: :class:`circuits.core.pollers.BasePoller`rh#jh$hh)hh+}r(h-]rh/]rh1]rh3]rh6]ruh8Kh9hh]r(hkXBases: rr}r(h"XBases: rh#jubhG)r}r(h"X):class:`circuits.core.pollers.BasePoller`rh#jh$h'h)hKh+}r(UreftyperXclassrhOhPX circuits.core.pollers.BasePollerrU refdomainrXpyrh3]rh1]rU refexplicitrh-]rh/]rh6]rhZh[h\jh]juh8Kh]rh_)r}r(h"jh+}r(h-]rh/]r(hejXpy-classreh1]rh3]rh6]ruh#jh]rhkX circuits.core.pollers.BasePollerrr}r(h"Uh#jubah)houbaubeubh)r}r(h"X&Poll(...) -> new Poll Poller Componentrh#jh$jah)hh+}r(h-]rh/]rh1]rh3]r h6]r uh8Kh9hh]r hkX&Poll(...) -> new Poll Poller Componentr r }r(h"jh#jubaubh)r}r(h"XMCreates a new Poll Poller Component that uses the poll poller implementation.rh#jh$jah)hh+}r(h-]rh/]rh1]rh3]rh6]ruh8Kh9hh]rhkXMCreates a new Poll Poller Component that uses the poll poller implementation.rr}r(h"jh#jubaubeubeubht)r}r(h"Uh#hh$X^/home/prologic/work/circuits/circuits/core/pollers.py:docstring of circuits.core.pollers.EPollrh)hxh+}r(h3]r h1]r!h-]r"h/]r#h6]r$Uentriesr%]r&(hX&EPoll (class in circuits.core.pollers)hUtr'auh8Nh9hh]r(ubh)r)}r*(h"Uh#hh$jh)hh+}r+(hhXpyr,h3]r-h1]r.h-]r/h/]r0h6]r1hXclassr2jj2uh8Nh9hh]r3(j)r4}r5(h"X$EPoll(timeout=0.01, channel='epoll')r6h#j)h$jh)jh+}r7(h3]r8haj h%Xcircuits.core.pollersr9r:}r;bh1]r<h-]r=h/]r>h6]r?hajXEPollr@jUjuh8Nh9hh]rA(j)rB}rC(h"Xclass rDh#j4h$jh)jh+}rE(h-]rFh/]rGh1]rHh3]rIh6]rJuh8Nh9hh]rKhkXclass rLrM}rN(h"Uh#jBubaubj')rO}rP(h"Xcircuits.core.pollers.rQh#j4h$jh)j+h+}rR(h-]rSh/]rTh1]rUh3]rVh6]rWuh8Nh9hh]rXhkXcircuits.core.pollers.rYrZ}r[(h"Uh#jOubaubj6)r\}r](h"j@h#j4h$jh)j9h+}r^(h-]r_h/]r`h1]rah3]rbh6]rcuh8Nh9hh]rdhkXEPollrerf}rg(h"Uh#j\ubaubjD)rh}ri(h"Uh#j4h$jh)jGh+}rj(h-]rkh/]rlh1]rmh3]rnh6]rouh8Nh9hh]rp(jO)rq}rr(h"X timeout=0.01rsh+}rt(h-]ruh/]rvh1]rwh3]rxh6]ryuh#jhh]rzhkX timeout=0.01r{r|}r}(h"Uh#jqubah)j]ubjO)r~}r(h"Xchannel='epoll'rh+}r(h-]rh/]rh1]rh3]rh6]ruh#jhh]rhkXchannel='epoll'rr}r(h"Uh#j~ubah)j]ubeubeubjk)r}r(h"Uh#j)h$jh)jnh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]r(h)r}r(h"X0Bases: :class:`circuits.core.pollers.BasePoller`rh#jh$hh)hh+}r(h-]rh/]rh1]rh3]rh6]ruh8Kh9hh]r(hkXBases: rr}r(h"XBases: rh#jubhG)r}r(h"X):class:`circuits.core.pollers.BasePoller`rh#jh$h'h)hKh+}r(UreftyperXclassrhOhPX circuits.core.pollers.BasePollerrU refdomainrXpyrh3]rh1]rU refexplicitrh-]rh/]rh6]rhZh[h\j@h]juh8Kh]rh_)r}r(h"jh+}r(h-]rh/]r(hejXpy-classreh1]rh3]rh6]ruh#jh]rhkX circuits.core.pollers.BasePollerrr}r(h"Uh#jubah)houbaubeubh)r}r(h"X(EPoll(...) -> new EPoll Poller Componentrh#jh$jh)hh+}r(h-]rh/]rh1]rh3]rh6]ruh8Kh9hh]rhkX(EPoll(...) -> new EPoll Poller Componentrr}r(h"jh#jubaubh)r}r(h"XOCreates a new EPoll Poller Component that uses the epoll poller implementation.rh#jh$jh)hh+}r(h-]rh/]rh1]rh3]rh6]ruh8Kh9hh]rhkXOCreates a new EPoll Poller Component that uses the epoll poller implementation.rr}r(h"jh#jubaubeubeubeubh)r}r(h"Uh#h h$h'h)h*h+}r(h-]rh/]rh1]rh3]rhah6]rhauh8Kh9hh]r(h;)r}r(h"XEventsrh#jh$h'h)h?h+}r(h-]rh/]rh1]rh3]rh6]ruh8Kh9hh]rhkXEventsrr}r(h"jh#jubaubh)r}r(h"X**none**rh#jh$h'h)hh+}r(h-]rh/]rh1]rh3]rh6]ruh8K h9hh]rh)r}r(h"jh+}r(h-]rh/]rh1]rh3]rh6]ruh#jh]rhkXnonerr}r(h"Uh#jubah)hubaubeubh)r}r(h"Uh#h h$h'h)h*h+}r(h-]rh/]r h1]r h3]r hah6]r hauh8K$h9hh]r (h;)r}r(h"X Functionsrh#jh$h'h)h?h+}r(h-]rh/]rh1]rh3]rh6]ruh8K$h9hh]rhkX Functionsrr}r(h"jh#jubaubh)r}r(h"X**none**rh#jh$h'h)hh+}r(h-]rh/]r h1]r!h3]r"h6]r#uh8K&h9hh]r$h)r%}r&(h"jh+}r'(h-]r(h/]r)h1]r*h3]r+h6]r,uh#jh]r-hkXnoner.r/}r0(h"Uh#j%ubah)hubaubeubeubah"UU transformerr1NU footnote_refsr2}r3Urefnamesr4}r5Usymbol_footnotesr6]r7Uautofootnote_refsr8]r9Usymbol_footnote_refsr:]r;U citationsr<]r=h9hU current_liner>NUtransform_messagesr?]r@UreporterrANUid_startrBKU autofootnotesrC]rDU citation_refsrE}rFUindirect_targetsrG]rHUsettingsrI(cdocutils.frontend Values rJorK}rL(Ufootnote_backlinksrMKUrecord_dependenciesrNNU rfc_base_urlrOUhttp://tools.ietf.org/html/rPU tracebackrQUpep_referencesrRNUstrip_commentsrSNU toc_backlinksrTUentryrUU language_coderVUenrWU datestamprXNU report_levelrYKU _destinationrZNU halt_levelr[KU strip_classesr\Nh?NUerror_encoding_error_handlerr]Ubackslashreplacer^Udebugr_NUembed_stylesheetr`Uoutput_encoding_error_handlerraUstrictrbU sectnum_xformrcKUdump_transformsrdNU docinfo_xformreKUwarning_streamrfNUpep_file_url_templatergUpep-%04drhUexit_status_levelriKUconfigrjNUstrict_visitorrkNUcloak_email_addressesrlUtrim_footnote_reference_spacermUenvrnNUdump_pseudo_xmlroNUexpose_internalsrpNUsectsubtitle_xformrqU source_linkrrNUrfc_referencesrsNUoutput_encodingrtUutf-8ruU source_urlrvNUinput_encodingrwU utf-8-sigrxU_disable_configryNU id_prefixrzUU tab_widthr{KUerror_encodingr|U ISO-8859-1r}U_sourcer~UF/home/prologic/work/circuits/docs/source/api/circuits_core_pollers.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjbUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hjh jwh5cdocutils.nodes target r)r}r(h"Uh#h h$hwh)Utargetrh+}r(h-]rh3]rh5ah1]rUismodrh/]rh6]ruh8Kh9hh]rubh jhhhhhj4h jhh hjuUsubstitution_namesr}rh)h9h+}r(h-]rh3]rh1]rUsourcerh'h/]rh6]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_events.doctree0000644000014400001440000017566312113366664025147 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(Xcircuits.web.events.ResponseqX functionsqNXcircuits.web.events -- eventsqNXcircuits_web_eventsq X"circuits.web.events.Request.createq Xcircuits.web.events.Requestq X componentsq NXcircuits.web.events.Streamq Xcircuits.web.events.WebEventqXeventsqNuUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hhhU functionsqhUcircuits-web-events-eventsqh Ucircuits-web-eventsqh h h h h U componentsqh h hhhUeventsquUchildrenq]q(cdocutils.nodes target q )q!}q"(U rawsourceq#X.. _circuits_web_events:q$Uparentq%hUsourceq&cdocutils.nodes reprunicode q'XD/home/prologic/work/circuits/docs/source/api/circuits_web_events.rstq(q)}q*bUtagnameq+Utargetq,U attributesq-}q.(Uidsq/]q0Ubackrefsq1]q2Udupnamesq3]q4Uclassesq5]q6Unamesq7]q8Urefidq9huUlineq:KUdocumentq;hh]q}q?(h#Uh%hh&h)Uexpect_referenced_by_nameq@}qAh h!sh+UsectionqBh-}qC(h3]qDh5]qEh1]qFh/]qG(Xmodule-circuits.web.eventsqHhheh7]qI(hh euh:Kh;hUexpect_referenced_by_idqJ}qKhh!sh]qL(cdocutils.nodes title qM)qN}qO(h#X$:mod:`circuits.web.events` -- EventsqPh%h>h&h)h+UtitleqQh-}qR(h3]qSh5]qTh1]qUh/]qVh7]qWuh:Kh;hh]qX(csphinx.addnodes pending_xref qY)qZ}q[(h#X:mod:`circuits.web.events`q\h%hNh&h)h+U pending_xrefq]h-}q^(Ureftypeq_Xmodq`UrefwarnqaU reftargetqbXcircuits.web.eventsqcU refdomainqdXpyqeh/]qfh1]qgU refexplicitqhh3]qih5]qjh7]qkUrefdocqlUapi/circuits_web_eventsqmUpy:classqnNU py:moduleqoNuh:Kh]qpcdocutils.nodes literal qq)qr}qs(h#h\h-}qt(h3]quh5]qv(UxrefqwheXpy-modqxeh1]qyh/]qzh7]q{uh%hZh]q|cdocutils.nodes Text q}Xcircuits.web.eventsq~q}q(h#Uh%hrubah+Uliteralqubaubh}X -- Eventsqq}q(h#X -- Eventsqh%hNubeubcsphinx.addnodes index q)q}q(h#Uh%h>h&U qh+Uindexqh-}q(h/]qh1]qh3]qh5]qh7]qUentriesq]q(UsingleqXcircuits.web.events (module)Xmodule-circuits.web.eventsUtqauh:Kh;hh]qubh=)q}q(h#Uh%h>h&h)h+hBh-}q(h3]qh5]qh1]qh/]qhah7]qhauh:K h;hh]q(hM)q}q(h#XEventsqh%hh&h)h+hQh-}q(h3]qh5]qh1]qh/]qh7]quh:K h;hh]qh}XEventsqq}q(h#hh%hubaubh)q}q(h#Uh%hh&Nh+hh-}q(h/]qh1]qh3]qh5]qh7]qUentriesq]q(hX'WebEvent (class in circuits.web.events)hUtqauh:Nh;hh]qubcsphinx.addnodes desc q)q}q(h#Uh%hh&Nh+Udescqh-}q(UnoindexqUdomainqXpyqh/]qh1]qh3]qh5]qh7]qUobjtypeqXclassqUdesctypeqhuh:Nh;hh]q(csphinx.addnodes desc_signature q)q}q(h#XWebEvent(*args, **kwargs)qh%hh&U qh+Udesc_signatureqh-}q(h/]qhaUmoduleqh'Xcircuits.web.eventsq҅q}qbh1]qh3]qh5]qh7]qhaUfullnameqXWebEventqUclassqUUfirstq܉uh:Nh;hh]q(csphinx.addnodes desc_annotation q)q}q(h#Xclass qh%hh&hh+Udesc_annotationqh-}q(h3]qh5]qh1]qh/]qh7]quh:Nh;hh]qh}Xclass qꅁq}q(h#Uh%hubaubcsphinx.addnodes desc_addname q)q}q(h#Xcircuits.web.events.qh%hh&hh+U desc_addnameqh-}q(h3]qh5]qh1]qh/]qh7]quh:Nh;hh]qh}Xcircuits.web.events.qq}q(h#Uh%hubaubcsphinx.addnodes desc_name q)q}q(h#hh%hh&hh+U desc_nameqh-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]rh}XWebEventrr}r (h#Uh%hubaubcsphinx.addnodes desc_parameterlist r )r }r (h#Uh%hh&hh+Udesc_parameterlistr h-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]r(csphinx.addnodes desc_parameter r)r}r(h#X*argsrh-}r(h3]rh5]rh1]rh/]rh7]ruh%j h]rh}X*argsr r!}r"(h#Uh%jubah+Udesc_parameterr#ubj)r$}r%(h#X**kwargsr&h-}r'(h3]r(h5]r)h1]r*h/]r+h7]r,uh%j h]r-h}X**kwargsr.r/}r0(h#Uh%j$ubah+j#ubeubeubcsphinx.addnodes desc_content r1)r2}r3(h#Uh%hh&hh+U desc_contentr4h-}r5(h3]r6h5]r7h1]r8h/]r9h7]r:uh:Nh;hh]r;(cdocutils.nodes paragraph r<)r=}r>(h#X*Bases: :class:`circuits.core.events.Event`r?h%j2h&U r@h+U paragraphrAh-}rB(h3]rCh5]rDh1]rEh/]rFh7]rGuh:Kh;hh]rH(h}XBases: rIrJ}rK(h#XBases: rLh%j=ubhY)rM}rN(h#X#:class:`circuits.core.events.Event`rOh%j=h&h)h+h]h-}rP(UreftyperQXclassrRhahbXcircuits.core.events.EventrSU refdomainrTXpyrUh/]rVh1]rWU refexplicitrXh3]rYh5]rZh7]r[hlhmhnhhoXcircuits.web.eventsr\uh:Kh]r]hq)r^}r_(h#jOh-}r`(h3]rah5]rb(hwjUXpy-classrceh1]rdh/]reh7]rfuh%jMh]rgh}Xcircuits.core.events.Eventrhri}rj(h#Uh%j^ubah+hubaubeubj<)rk}rl(h#XWebEvents have both their ``success`` and ``failure`` attributes set to True. So event processing generates the derived events ``...Success`` or ``...Failure`` events.rmh%j2h&X]/home/prologic/work/circuits/circuits/web/events.py:docstring of circuits.web.events.WebEventrnh+jAh-}ro(h3]rph5]rqh1]rrh/]rsh7]rtuh:Kh;hh]ru(h}XWebEvents have both their rvrw}rx(h#XWebEvents have both their ryh%jkubhq)rz}r{(h#X ``success``r|h-}r}(h3]r~h5]rh1]rh/]rh7]ruh%jkh]rh}Xsuccessrr}r(h#Uh%jzubah+hubh}X and rr}r(h#X and rh%jkubhq)r}r(h#X ``failure``rh-}r(h3]rh5]rh1]rh/]rh7]ruh%jkh]rh}Xfailurerr}r(h#Uh%jubah+hubh}XJ attributes set to True. So event processing generates the derived events rr}r(h#XJ attributes set to True. So event processing generates the derived events rh%jkubhq)r}r(h#X``...Success``rh-}r(h3]rh5]rh1]rh/]rh7]ruh%jkh]rh}X ...Successrr}r(h#Uh%jubah+hubh}X or rr}r(h#X or rh%jkubhq)r}r(h#X``...Failure``rh-}r(h3]rh5]rh1]rh/]rh7]ruh%jkh]rh}X ...Failurerr}r(h#Uh%jubah+hubh}X events.rr}r(h#X events.rh%jkubeubj<)r}r(h#XAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rh%j2h&jnh+jAh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh;hh]rh}XAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rr}r(h#jh%jubaubj<)r}r(h#XAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rh%j2h&jnh+jAh-}r(h3]rh5]rh1]rh/]rh7]ruh:K h;hh]rh}XAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rr}r(h#jh%jubaubj<)r}r(h#XEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh%j2h&jnh+jAh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh;hh]r(h}XEvery event has a rr}r(h#XEvery event has a rh%jubhY)r}r(h#X :attr:`name`rh%jh&h)h+h]h-}r(UreftyperXattrrhahbXnamerU refdomainrXpyrh/]rh1]rU refexplicitrh3]rh5]rh7]rhlhmhnhhoj\uh:Kh]rhq)r}r(h#jh-}r(h3]rh5]r(hwjXpy-attrreh1]rh/]rh7]ruh%jh]rh}Xnamerr}r(h#Uh%jubah+hubaubh}X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(h#X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh%jubeubcdocutils.nodes field_list r)r}r (h#Uh%j2h&Nh+U field_listr h-}r (h3]r h5]r h1]rh/]rh7]ruh:Nh;hh]rcdocutils.nodes field r)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]r(cdocutils.nodes field_name r)r}r(h#Uh-}r(h3]r h5]r!h1]r"h/]r#h7]r$uh%jh]r%h}X Variablesr&r'}r((h#Uh%jubah+U field_namer)ubcdocutils.nodes field_body r*)r+}r,(h#Uh-}r-(h3]r.h5]r/h1]r0h/]r1h7]r2uh%jh]r3cdocutils.nodes bullet_list r4)r5}r6(h#Uh-}r7(h3]r8h5]r9h1]r:h/]r;h7]r<uh%j+h]r=(cdocutils.nodes list_item r>)r?}r@(h#Uh-}rA(h3]rBh5]rCh1]rDh/]rEh7]rFuh%j5h]rGj<)rH}rI(h#Uh-}rJ(h3]rKh5]rLh1]rMh/]rNh7]rOuh%j?h]rP(hY)rQ}rR(h#Uh-}rS(UreftyperTUobjrUU reftargetrVXchannelsrWU refdomainrXhh/]rYh1]rZU refexplicitr[h3]r\h5]r]h7]r^uh%jHh]r_cdocutils.nodes strong r`)ra}rb(h#jWh-}rc(h3]rdh5]reh1]rfh/]rgh7]rhuh%jQh]rih}Xchannelsrjrk}rl(h#Uh%jaubah+Ustrongrmubah+h]ubh}X -- rnro}rp(h#Uh%jHubj<)rq}rr(h#Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rsh%jHh&jnh+jAh-}rt(h3]ruh5]rvh1]rwh/]rxh7]ryuh:Kh]rzh}Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r{r|}r}(h#jsh%jqubaubj<)r~}r(h#XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rh%jHh&jnh+jAh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh]rh}XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rr}r(h#jh%j~ubaubeh+jAubah+U list_itemrubj>)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%j5h]rj<)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]r(hY)r}r(h#Uh-}r(UreftyperjUU reftargetrXvaluerU refdomainrhh/]rh1]rU refexplicitrh3]rh5]rh7]ruh%jh]rj`)r}r(h#jh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}Xvaluerr}r(h#Uh%jubah+jmubah+h]ubh}X -- rr}r(h#Uh%jubh}X this is a rr}r(h#X this is a rh%jubhY)r}r(h#X#:class:`circuits.core.values.Value`rh%jh&Nh+h]h-}r(UreftyperXclassrhahbXcircuits.core.values.ValuerU refdomainrXpyrh/]rh1]rU refexplicitrh3]rh5]rh7]rhlhmhnhhoj\uh:Nh]rhq)r}r(h#jh-}r(h3]rh5]r(hwjXpy-classreh1]rh/]rh7]ruh%jh]rh}Xcircuits.core.values.Valuerr}r(h#Uh%jubah+hubaubh}XN object that holds the results returned by the handlers invoked for the event.rr}r(h#XN object that holds the results returned by the handlers invoked for the event.rh%jubeh+jAubah+jubj>)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%j5h]rj<)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]r(hY)r}r(h#Uh-}r(UreftyperjUU reftargetrXsuccessrU refdomainrhh/]rh1]rU refexplicitrh3]rh5]rh7]ruh%jh]rj`)r}r(h#jh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}Xsuccessr r }r (h#Uh%jubah+jmubah+h]ubh}X -- r r }r(h#Uh%jubh}X%if this optional attribute is set to rr}r(h#X%if this optional attribute is set to rh%jubhq)r}r(h#X``True``rh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}XTruerr}r(h#Uh%jubah+hubh}X, an associated event r r!}r"(h#X, an associated event r#h%jubhq)r$}r%(h#X``EventSuccess``r&h-}r'(h3]r(h5]r)h1]r*h/]r+h7]r,uh%jh]r-h}X EventSuccessr.r/}r0(h#Uh%j$ubah+hubh}X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.r1r2}r3(h#X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.r4h%jubeh+jAubah+jubj>)r5}r6(h#Uh-}r7(h3]r8h5]r9h1]r:h/]r;h7]r<uh%j5h]r=j<)r>}r?(h#Uh-}r@(h3]rAh5]rBh1]rCh/]rDh7]rEuh%j5h]rF(hY)rG}rH(h#Uh-}rI(UreftyperJjUU reftargetrKXsuccess_channelsrLU refdomainrMhh/]rNh1]rOU refexplicitrPh3]rQh5]rRh7]rSuh%j>h]rTj`)rU}rV(h#jLh-}rW(h3]rXh5]rYh1]rZh/]r[h7]r\uh%jGh]r]h}Xsuccess_channelsr^r_}r`(h#Uh%jUubah+jmubah+h]ubh}X -- rarb}rc(h#Uh%j>ubh}Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rdre}rf(h#Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rgh%j>ubeh+jAubah+jubj>)rh}ri(h#Uh-}rj(h3]rkh5]rlh1]rmh/]rnh7]rouh%j5h]rpj<)rq}rr(h#Uh-}rs(h3]rth5]ruh1]rvh/]rwh7]rxuh%jhh]ry(hY)rz}r{(h#Uh-}r|(Ureftyper}jUU reftargetr~XcompleterU refdomainrhh/]rh1]rU refexplicitrh3]rh5]rh7]ruh%jqh]rj`)r}r(h#jh-}r(h3]rh5]rh1]rh/]rh7]ruh%jzh]rh}Xcompleterr}r(h#Uh%jubah+jmubah+h]ubh}X -- rr}r(h#Uh%jqubh}X%if this optional attribute is set to rr}r(h#X%if this optional attribute is set to rh%jqubhq)r}r(h#X``True``rh-}r(h3]rh5]rh1]rh/]rh7]ruh%jqh]rh}XTruerr}r(h#Uh%jubah+hubh}X, an associated event rr}r(h#X, an associated event rh%jqubhq)r}r(h#X``EventComplete``rh-}r(h3]rh5]rh1]rh/]rh7]ruh%jqh]rh}X EventCompleterr}r(h#Uh%jubah+hubh}X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rr}r(h#X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rh%jqubeh+jAubah+jubj>)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%j5h]rj<)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]r(hY)r}r(h#Uh-}r(UreftyperjUU reftargetrXsuccess_channelsrU refdomainrhh/]rh1]rU refexplicitrh3]rh5]rh7]ruh%jh]rj`)r}r(h#jh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}Xsuccess_channelsrr}r(h#Uh%jubah+jmubah+h]ubh}X -- rr}r(h#Uh%jubh}Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h#Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh%jubeh+jAubah+jubeh+U bullet_listrubah+U field_bodyrubeh+Ufieldrubaubeubeubh)r}r(h#Uh%hh&Nh+hh-}r(h/]rh1]rh3]rh5]rh7]rUentriesr]r(hX&Request (class in circuits.web.events)h Utrauh:Nh;hh]rubh)r}r(h#Uh%hh&Nh+hh-}r(hhXpyrh/]rh1]rh3]rh5]rh7]rhXclassrhjuh:Nh;hh]r (h)r }r (h#XRequest(*args, **kwargs)r h%jh&hh+hh-}r (h/]rh ahh'Xcircuits.web.eventsrr}rbh1]rh3]rh5]rh7]rh ahXRequestrhUh܉uh:Nh;hh]r(h)r}r(h#Xclass rh%j h&hh+hh-}r(h3]rh5]rh1]rh/]rh7]r uh:Nh;hh]r!h}Xclass r"r#}r$(h#Uh%jubaubh)r%}r&(h#Xcircuits.web.events.r'h%j h&hh+hh-}r((h3]r)h5]r*h1]r+h/]r,h7]r-uh:Nh;hh]r.h}Xcircuits.web.events.r/r0}r1(h#Uh%j%ubaubh)r2}r3(h#jh%j h&hh+hh-}r4(h3]r5h5]r6h1]r7h/]r8h7]r9uh:Nh;hh]r:h}XRequestr;r<}r=(h#Uh%j2ubaubj )r>}r?(h#Uh%j h&hh+j h-}r@(h3]rAh5]rBh1]rCh/]rDh7]rEuh:Nh;hh]rF(j)rG}rH(h#X*argsrIh-}rJ(h3]rKh5]rLh1]rMh/]rNh7]rOuh%j>h]rPh}X*argsrQrR}rS(h#Uh%jGubah+j#ubj)rT}rU(h#X**kwargsrVh-}rW(h3]rXh5]rYh1]rZh/]r[h7]r\uh%j>h]r]h}X**kwargsr^r_}r`(h#Uh%jTubah+j#ubeubeubj1)ra}rb(h#Uh%jh&hh+j4h-}rc(h3]rdh5]reh1]rfh/]rgh7]rhuh:Nh;hh]ri(j<)rj}rk(h#X,Bases: :class:`circuits.web.events.WebEvent`rlh%jah&j@h+jAh-}rm(h3]rnh5]roh1]rph/]rqh7]rruh:Kh;hh]rs(h}XBases: rtru}rv(h#XBases: rwh%jjubhY)rx}ry(h#X%:class:`circuits.web.events.WebEvent`rzh%jjh&h)h+h]h-}r{(Ureftyper|Xclassr}hahbXcircuits.web.events.WebEventr~U refdomainrXpyrh/]rh1]rU refexplicitrh3]rh5]rh7]rhlhmhnjhoj\uh:Kh]rhq)r}r(h#jzh-}r(h3]rh5]r(hwjXpy-classreh1]rh/]rh7]ruh%jxh]rh}Xcircuits.web.events.WebEventrr}r(h#Uh%jubah+hubaubeubj<)r}r(h#X%Request(WebEvent) -> Request WebEventrh%jah&X\/home/prologic/work/circuits/circuits/web/events.py:docstring of circuits.web.events.Requestrh+jAh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh;hh]rh}X%Request(WebEvent) -> Request WebEventrr}r(h#jh%jubaubj<)r}r(h#Xargs: request, responserh%jah&jh+jAh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh;hh]rh}Xargs: request, responserr}r(h#jh%jubaubj<)r}r(h#XAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rh%jah&jh+jAh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh;hh]rh}XAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rr}r(h#jh%jubaubj<)r}r(h#XAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rh%jah&jh+jAh-}r(h3]rh5]rh1]rh/]rh7]ruh:K h;hh]rh}XAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rr}r(h#jh%jubaubj<)r}r(h#XEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh%jah&jh+jAh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh;hh]r(h}XEvery event has a rr}r(h#XEvery event has a rh%jubhY)r}r(h#X :attr:`name`rh%jh&h)h+h]h-}r(UreftyperXattrrhahbXnamerU refdomainrXpyrh/]rh1]rU refexplicitrh3]rh5]rh7]rhlhmhnjhoj\uh:Kh]rhq)r}r(h#jh-}r(h3]rh5]r(hwjXpy-attrreh1]rh/]rh7]ruh%jh]rh}Xnamerr}r(h#Uh%jubah+hubaubh}X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(h#X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh%jubeubj)r}r(h#Uh%jah&Nh+j h-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]rj)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]r uh%jh]r (j)r }r (h#Uh-}r (h3]rh5]rh1]rh/]rh7]ruh%jh]rh}X Variablesrr}r(h#Uh%j ubah+j)ubj*)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rj4)r }r!(h#Uh-}r"(h3]r#h5]r$h1]r%h/]r&h7]r'uh%jh]r((j>)r)}r*(h#Uh-}r+(h3]r,h5]r-h1]r.h/]r/h7]r0uh%j h]r1j<)r2}r3(h#Uh-}r4(h3]r5h5]r6h1]r7h/]r8h7]r9uh%j)h]r:(hY)r;}r<(h#Uh-}r=(Ureftyper>jUU reftargetr?Xchannelsr@U refdomainrAjh/]rBh1]rCU refexplicitrDh3]rEh5]rFh7]rGuh%j2h]rHj`)rI}rJ(h#j@h-}rK(h3]rLh5]rMh1]rNh/]rOh7]rPuh%j;h]rQh}XchannelsrRrS}rT(h#Uh%jIubah+jmubah+h]ubh}X -- rUrV}rW(h#Uh%j2ubj<)rX}rY(h#Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rZh%j2h&jh+jAh-}r[(h3]r\h5]r]h1]r^h/]r_h7]r`uh:Kh]rah}Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rbrc}rd(h#jZh%jXubaubj<)re}rf(h#XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rgh%j2h&jh+jAh-}rh(h3]rih5]rjh1]rkh/]rlh7]rmuh:Kh]rnh}XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rorp}rq(h#jgh%jeubaubeh+jAubah+jubj>)rr}rs(h#Uh-}rt(h3]ruh5]rvh1]rwh/]rxh7]ryuh%j h]rzj<)r{}r|(h#Uh-}r}(h3]r~h5]rh1]rh/]rh7]ruh%jrh]r(hY)r}r(h#Uh-}r(UreftyperjUU reftargetrXvaluerU refdomainrjh/]rh1]rU refexplicitrh3]rh5]rh7]ruh%j{h]rj`)r}r(h#jh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}Xvaluerr}r(h#Uh%jubah+jmubah+h]ubh}X -- rr}r(h#Uh%j{ubh}X this is a rr}r(h#X this is a rh%j{ubhY)r}r(h#X#:class:`circuits.core.values.Value`rh%j{h&Nh+h]h-}r(UreftyperXclassrhahbXcircuits.core.values.ValuerU refdomainrXpyrh/]rh1]rU refexplicitrh3]rh5]rh7]rhlhmhnjhoj\uh:Nh]rhq)r}r(h#jh-}r(h3]rh5]r(hwjXpy-classreh1]rh/]rh7]ruh%jh]rh}Xcircuits.core.values.Valuerr}r(h#Uh%jubah+hubaubh}XN object that holds the results returned by the handlers invoked for the event.rr}r(h#XN object that holds the results returned by the handlers invoked for the event.rh%j{ubeh+jAubah+jubj>)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%j h]rj<)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]r(hY)r}r(h#Uh-}r(UreftyperjUU reftargetrXsuccessrU refdomainrjh/]rh1]rU refexplicitrh3]rh5]rh7]ruh%jh]rj`)r}r(h#jh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}Xsuccessrr}r(h#Uh%jubah+jmubah+h]ubh}X -- rr}r(h#Uh%jubh}X%if this optional attribute is set to rr}r(h#X%if this optional attribute is set to rh%jubhq)r}r(h#X``True``rh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}XTruerr}r(h#Uh%jubah+hubh}X, an associated event rr}r(h#X, an associated event r h%jubhq)r }r (h#X``EventSuccess``r h-}r (h3]rh5]rh1]rh/]rh7]ruh%jh]rh}X EventSuccessrr}r(h#Uh%j ubah+hubh}X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(h#X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh%jubeh+jAubah+jubj>)r}r(h#Uh-}r(h3]rh5]rh1]r h/]r!h7]r"uh%j h]r#j<)r$}r%(h#Uh-}r&(h3]r'h5]r(h1]r)h/]r*h7]r+uh%jh]r,(hY)r-}r.(h#Uh-}r/(Ureftyper0jUU reftargetr1Xsuccess_channelsr2U refdomainr3jh/]r4h1]r5U refexplicitr6h3]r7h5]r8h7]r9uh%j$h]r:j`)r;}r<(h#j2h-}r=(h3]r>h5]r?h1]r@h/]rAh7]rBuh%j-h]rCh}Xsuccess_channelsrDrE}rF(h#Uh%j;ubah+jmubah+h]ubh}X -- rGrH}rI(h#Uh%j$ubh}Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rJrK}rL(h#Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rMh%j$ubeh+jAubah+jubj>)rN}rO(h#Uh-}rP(h3]rQh5]rRh1]rSh/]rTh7]rUuh%j h]rVj<)rW}rX(h#Uh-}rY(h3]rZh5]r[h1]r\h/]r]h7]r^uh%jNh]r_(hY)r`}ra(h#Uh-}rb(UreftypercjUU reftargetrdXcompletereU refdomainrfjh/]rgh1]rhU refexplicitrih3]rjh5]rkh7]rluh%jWh]rmj`)rn}ro(h#jeh-}rp(h3]rqh5]rrh1]rsh/]rth7]ruuh%j`h]rvh}Xcompleterwrx}ry(h#Uh%jnubah+jmubah+h]ubh}X -- rzr{}r|(h#Uh%jWubh}X%if this optional attribute is set to r}r~}r(h#X%if this optional attribute is set to rh%jWubhq)r}r(h#X``True``rh-}r(h3]rh5]rh1]rh/]rh7]ruh%jWh]rh}XTruerr}r(h#Uh%jubah+hubh}X, an associated event rr}r(h#X, an associated event rh%jWubhq)r}r(h#X``EventComplete``rh-}r(h3]rh5]rh1]rh/]rh7]ruh%jWh]rh}X EventCompleterr}r(h#Uh%jubah+hubh}X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rr}r(h#X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rh%jWubeh+jAubah+jubj>)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%j h]rj<)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]r(hY)r}r(h#Uh-}r(UreftyperjUU reftargetrXsuccess_channelsrU refdomainrjh/]rh1]rU refexplicitrh3]rh5]rh7]ruh%jh]rj`)r}r(h#jh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}Xsuccess_channelsrr}r(h#Uh%jubah+jmubah+h]ubh}X -- rr}r(h#Uh%jubh}Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h#Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh%jubeh+jAubah+jubeh+jubah+jubeh+jubaubh)r}r(h#Uh%jah&Xc/home/prologic/work/circuits/circuits/web/events.py:docstring of circuits.web.events.Request.createrh+hh-}r(h/]rh1]rh3]rh5]rh7]rUentriesr]r(hX3create() (circuits.web.events.Request class method)h Utrauh:Nh;hh]rubh)r}r(h#Uh%jah&jh+hh-}r(hhXpyrh/]rh1]rh3]rh5]rh7]rhX classmethodrhjuh:Nh;hh]r(h)r}r(h#X%Request.create(name, *args, **kwargs)rh%jh&hh+hh-}r(h/]rh ahh'Xcircuits.web.eventsrr}rbh1]rh3]rh5]rh7]rh ahXRequest.createrhjh܉uh:Nh;hh]r(h)r}r(h#U classmethod rh%jh&hh+hh-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]rh}X classmethod rr}r(h#Uh%jubaubh)r }r (h#Xcreater h%jh&hh+hh-}r (h3]r h5]rh1]rh/]rh7]ruh:Nh;hh]rh}Xcreaterr}r(h#Uh%j ubaubj )r}r(h#Uh%jh&hh+j h-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]r(j)r}r (h#Xnamer!h-}r"(h3]r#h5]r$h1]r%h/]r&h7]r'uh%jh]r(h}Xnamer)r*}r+(h#Uh%jubah+j#ubj)r,}r-(h#X*argsr.h-}r/(h3]r0h5]r1h1]r2h/]r3h7]r4uh%jh]r5h}X*argsr6r7}r8(h#Uh%j,ubah+j#ubj)r9}r:(h#X**kwargsr;h-}r<(h3]r=h5]r>h1]r?h/]r@h7]rAuh%jh]rBh}X**kwargsrCrD}rE(h#Uh%j9ubah+j#ubeubeubj1)rF}rG(h#Uh%jh&hh+j4h-}rH(h3]rIh5]rJh1]rKh/]rLh7]rMuh:Nh;hh]rNj<)rO}rP(h#X?All classes derived dynamically from Request are LiteralEvents.rQh%jFh&jh+jAh-}rR(h3]rSh5]rTh1]rUh/]rVh7]rWuh:Kh;hh]rXh}X?All classes derived dynamically from Request are LiteralEvents.rYrZ}r[(h#jQh%jOubaubaubeubeubeubh)r\}r](h#Uh%hh&Nh+hh-}r^(h/]r_h1]r`h3]rah5]rbh7]rcUentriesrd]re(hX'Response (class in circuits.web.events)hUtrfauh:Nh;hh]rgubh)rh}ri(h#Uh%hh&Nh+hh-}rj(hhXpyrkh/]rlh1]rmh3]rnh5]roh7]rphXclassrqhjquh:Nh;hh]rr(h)rs}rt(h#XResponse(*args, **kwargs)ruh%jhh&hh+hh-}rv(h/]rwhahh'Xcircuits.web.eventsrxry}rzbh1]r{h3]r|h5]r}h7]r~hahXResponserhUh܉uh:Nh;hh]r(h)r}r(h#Xclass rh%jsh&hh+hh-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]rh}Xclass rr}r(h#Uh%jubaubh)r}r(h#Xcircuits.web.events.rh%jsh&hh+hh-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]rh}Xcircuits.web.events.rr}r(h#Uh%jubaubh)r}r(h#jh%jsh&hh+hh-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]rh}XResponserr}r(h#Uh%jubaubj )r}r(h#Uh%jsh&hh+j h-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]r(j)r}r(h#X*argsrh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}X*argsrr}r(h#Uh%jubah+j#ubj)r}r(h#X**kwargsrh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}X**kwargsrr}r(h#Uh%jubah+j#ubeubeubj1)r}r(h#Uh%jhh&hh+j4h-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]r(j<)r}r(h#X,Bases: :class:`circuits.web.events.WebEvent`rh%jh&j@h+jAh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh;hh]r(h}XBases: rr}r(h#XBases: rh%jubhY)r}r(h#X%:class:`circuits.web.events.WebEvent`rh%jh&h)h+h]h-}r(UreftyperXclassrhahbXcircuits.web.events.WebEventrU refdomainrXpyrh/]rh1]rU refexplicitrh3]rh5]rh7]rhlhmhnjhoj\uh:Kh]rhq)r}r(h#jh-}r(h3]rh5]r(hwjXpy-classreh1]rh/]rh7]ruh%jh]rh}Xcircuits.web.events.WebEventrr}r(h#Uh%jubah+hubaubeubj<)r}r(h#X'Response(WebEvent) -> Response WebEventrh%jh&X]/home/prologic/work/circuits/circuits/web/events.py:docstring of circuits.web.events.Responserh+jAh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh;hh]rh}X'Response(WebEvent) -> Response WebEventr r }r (h#jh%jubaubj<)r }r (h#Xargs: request, responserh%jh&jh+jAh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh;hh]rh}Xargs: request, responserr}r(h#jh%j ubaubj<)r}r(h#XAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rh%jh&jh+jAh-}r(h3]rh5]rh1]rh/]r h7]r!uh:Kh;hh]r"h}XAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.r#r$}r%(h#jh%jubaubj<)r&}r'(h#XAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.r(h%jh&jh+jAh-}r)(h3]r*h5]r+h1]r,h/]r-h7]r.uh:K h;hh]r/h}XAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.r0r1}r2(h#j(h%j&ubaubj<)r3}r4(h#XEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.r5h%jh&jh+jAh-}r6(h3]r7h5]r8h1]r9h/]r:h7]r;uh:Kh;hh]r<(h}XEvery event has a r=r>}r?(h#XEvery event has a r@h%j3ubhY)rA}rB(h#X :attr:`name`rCh%j3h&h)h+h]h-}rD(UreftyperEXattrrFhahbXnamerGU refdomainrHXpyrIh/]rJh1]rKU refexplicitrLh3]rMh5]rNh7]rOhlhmhnjhoj\uh:Kh]rPhq)rQ}rR(h#jCh-}rS(h3]rTh5]rU(hwjIXpy-attrrVeh1]rWh/]rXh7]rYuh%jAh]rZh}Xnamer[r\}r](h#Uh%jQubah+hubaubh}X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.r^r_}r`(h#X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rah%j3ubeubj)rb}rc(h#Uh%jh&Nh+j h-}rd(h3]reh5]rfh1]rgh/]rhh7]riuh:Nh;hh]rjj)rk}rl(h#Uh-}rm(h3]rnh5]roh1]rph/]rqh7]rruh%jbh]rs(j)rt}ru(h#Uh-}rv(h3]rwh5]rxh1]ryh/]rzh7]r{uh%jkh]r|h}X Variablesr}r~}r(h#Uh%jtubah+j)ubj*)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jkh]rj4)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]r(j>)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rj<)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]r(hY)r}r(h#Uh-}r(UreftyperjUU reftargetrXchannelsrU refdomainrjkh/]rh1]rU refexplicitrh3]rh5]rh7]ruh%jh]rj`)r}r(h#jh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}Xchannelsrr}r(h#Uh%jubah+jmubah+h]ubh}X -- rr}r(h#Uh%jubj<)r}r(h#Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rh%jh&jh+jAh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh]rh}Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rr}r(h#jh%jubaubj<)r}r(h#XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rh%jh&jh+jAh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh]rh}XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rr}r(h#jh%jubaubeh+jAubah+jubj>)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rj<)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]r(hY)r}r(h#Uh-}r(UreftyperjUU reftargetrXvaluerU refdomainrjkh/]rh1]rU refexplicitrh3]rh5]rh7]ruh%jh]rj`)r}r(h#jh-}r(h3]rh5]rh1]r h/]r h7]r uh%jh]r h}Xvaluer r }r (h#Uh%jubah+jmubah+h]ubh}X -- r r }r (h#Uh%jubh}X this is a r r }r (h#X this is a r h%jubhY)r }r (h#X#:class:`circuits.core.values.Value`r h%jh&Nh+h]h-}r (Ureftyper Xclassr hahbXcircuits.core.values.Valuer U refdomainr Xpyr h/]r h1]r U refexplicitr h3]r h5]r h7]r hlhmhnjhoj\uh:Nh]r hq)r }r (h#j h-}r (h3]r! h5]r" (hwj Xpy-classr# eh1]r$ h/]r% h7]r& uh%j h]r' h}Xcircuits.core.values.Valuer( r) }r* (h#Uh%j ubah+hubaubh}XN object that holds the results returned by the handlers invoked for the event.r+ r, }r- (h#XN object that holds the results returned by the handlers invoked for the event.r. h%jubeh+jAubah+jubj>)r/ }r0 (h#Uh-}r1 (h3]r2 h5]r3 h1]r4 h/]r5 h7]r6 uh%jh]r7 j<)r8 }r9 (h#Uh-}r: (h3]r; h5]r< h1]r= h/]r> h7]r? uh%j/ h]r@ (hY)rA }rB (h#Uh-}rC (UreftyperD jUU reftargetrE XsuccessrF U refdomainrG jkh/]rH h1]rI U refexplicitrJ h3]rK h5]rL h7]rM uh%j8 h]rN j`)rO }rP (h#jF h-}rQ (h3]rR h5]rS h1]rT h/]rU h7]rV uh%jA h]rW h}XsuccessrX rY }rZ (h#Uh%jO ubah+jmubah+h]ubh}X -- r[ r\ }r] (h#Uh%j8 ubh}X%if this optional attribute is set to r^ r_ }r` (h#X%if this optional attribute is set to ra h%j8 ubhq)rb }rc (h#X``True``rd h-}re (h3]rf h5]rg h1]rh h/]ri h7]rj uh%j8 h]rk h}XTruerl rm }rn (h#Uh%jb ubah+hubh}X, an associated event ro rp }rq (h#X, an associated event rr h%j8 ubhq)rs }rt (h#X``EventSuccess``ru h-}rv (h3]rw h5]rx h1]ry h/]rz h7]r{ uh%j8 h]r| h}X EventSuccessr} r~ }r (h#Uh%js ubah+hubh}X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.r r }r (h#X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.r h%j8 ubeh+jAubah+jubj>)r }r (h#Uh-}r (h3]r h5]r h1]r h/]r h7]r uh%jh]r j<)r }r (h#Uh-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r (hY)r }r (h#Uh-}r (Ureftyper jUU reftargetr Xsuccess_channelsr U refdomainr jkh/]r h1]r U refexplicitr h3]r h5]r h7]r uh%j h]r j`)r }r (h#j h-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r h}Xsuccess_channelsr r }r (h#Uh%j ubah+jmubah+h]ubh}X -- r r }r (h#Uh%j ubh}Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r r }r (h#Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r h%j ubeh+jAubah+jubj>)r }r (h#Uh-}r (h3]r h5]r h1]r h/]r h7]r uh%jh]r j<)r }r (h#Uh-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r (hY)r }r (h#Uh-}r (Ureftyper jUU reftargetr Xcompleter U refdomainr jkh/]r h1]r U refexplicitr h3]r h5]r h7]r uh%j h]r j`)r }r (h#j h-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r h}Xcompleter r }r (h#Uh%j ubah+jmubah+h]ubh}X -- r r }r (h#Uh%j ubh}X%if this optional attribute is set to r r }r (h#X%if this optional attribute is set to r h%j ubhq)r }r (h#X``True``r h-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r h}XTruer r }r (h#Uh%j ubah+hubh}X, an associated event r r }r (h#X, an associated event r h%j ubhq)r }r (h#X``EventComplete``r h-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r h}X EventCompleter r }r (h#Uh%j ubah+hubh}X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r r }r (h#X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r h%j ubeh+jAubah+jubj>)r }r (h#Uh-}r (h3]r h5]r h1]r h/]r h7]r uh%jh]r j<)r }r (h#Uh-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r (hY)r }r (h#Uh-}r (Ureftyper! jUU reftargetr" Xsuccess_channelsr# U refdomainr$ jkh/]r% h1]r& U refexplicitr' h3]r( h5]r) h7]r* uh%j h]r+ j`)r, }r- (h#j# h-}r. (h3]r/ h5]r0 h1]r1 h/]r2 h7]r3 uh%j h]r4 h}Xsuccess_channelsr5 r6 }r7 (h#Uh%j, ubah+jmubah+h]ubh}X -- r8 r9 }r: (h#Uh%j ubh}Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r; r< }r= (h#Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r> h%j ubeh+jAubah+jubeh+jubah+jubeh+jubaubeubeubh)r? }r@ (h#Uh%hh&Nh+hh-}rA (h/]rB h1]rC h3]rD h5]rE h7]rF UentriesrG ]rH (hX%Stream (class in circuits.web.events)h UtrI auh:Nh;hh]rJ ubh)rK }rL (h#Uh%hh&Nh+hh-}rM (hhXpyrN h/]rO h1]rP h3]rQ h5]rR h7]rS hXclassrT hjT uh:Nh;hh]rU (h)rV }rW (h#XStream(*args, **kwargs)rX h%jK h&hh+hh-}rY (h/]rZ h ahh'Xcircuits.web.eventsr[ r\ }r] bh1]r^ h3]r_ h5]r` h7]ra h ahXStreamrb hUh܉uh:Nh;hh]rc (h)rd }re (h#Xclass rf h%jV h&hh+hh-}rg (h3]rh h5]ri h1]rj h/]rk h7]rl uh:Nh;hh]rm h}Xclass rn ro }rp (h#Uh%jd ubaubh)rq }rr (h#Xcircuits.web.events.rs h%jV h&hh+hh-}rt (h3]ru h5]rv h1]rw h/]rx h7]ry uh:Nh;hh]rz h}Xcircuits.web.events.r{ r| }r} (h#Uh%jq ubaubh)r~ }r (h#jb h%jV h&hh+hh-}r (h3]r h5]r h1]r h/]r h7]r uh:Nh;hh]r h}XStreamr r }r (h#Uh%j~ ubaubj )r }r (h#Uh%jV h&hh+j h-}r (h3]r h5]r h1]r h/]r h7]r uh:Nh;hh]r (j)r }r (h#X*argsr h-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r h}X*argsr r }r (h#Uh%j ubah+j#ubj)r }r (h#X**kwargsr h-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r h}X**kwargsr r }r (h#Uh%j ubah+j#ubeubeubj1)r }r (h#Uh%jK h&hh+j4h-}r (h3]r h5]r h1]r h/]r h7]r uh:Nh;hh]r (j<)r }r (h#X,Bases: :class:`circuits.web.events.WebEvent`r h%j h&j@h+jAh-}r (h3]r h5]r h1]r h/]r h7]r uh:Kh;hh]r (h}XBases: r r }r (h#XBases: r h%j ubhY)r }r (h#X%:class:`circuits.web.events.WebEvent`r h%j h&h)h+h]h-}r (Ureftyper Xclassr hahbXcircuits.web.events.WebEventr U refdomainr Xpyr h/]r h1]r U refexplicitr h3]r h5]r h7]r hlhmhnjb hoj\uh:Kh]r hq)r }r (h#j h-}r (h3]r h5]r (hwj Xpy-classr eh1]r h/]r h7]r uh%j h]r h}Xcircuits.web.events.WebEventr r }r (h#Uh%j ubah+hubaubeubj<)r }r (h#X#Stream(WebEvent) -> Stream WebEventr h%j h&X[/home/prologic/work/circuits/circuits/web/events.py:docstring of circuits.web.events.Streamr h+jAh-}r (h3]r h5]r h1]r h/]r h7]r uh:Kh;hh]r h}X#Stream(WebEvent) -> Stream WebEventr r }r (h#j h%j ubaubj<)r }r (h#Xargs: request, responser h%j h&j h+jAh-}r (h3]r h5]r h1]r h/]r h7]r uh:Kh;hh]r h}Xargs: request, responser r }r (h#j h%j ubaubj<)r }r (h#XAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.r h%j h&j h+jAh-}r (h3]r h5]r h1]r h/]r h7]r uh:Kh;hh]r h}XAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.r r }r (h#j h%j ubaubj<)r }r (h#XAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.r h%j h&j h+jAh-}r (h3]r h5]r h1]r h/]r h7]r uh:K h;hh]r h}XAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.r r }r (h#j h%j ubaubj<)r }r (h#XEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.r h%j h&j h+jAh-}r (h3]r h5]r h1]r h/]r h7]r uh:Kh;hh]r (h}XEvery event has a r r! }r" (h#XEvery event has a r# h%j ubhY)r$ }r% (h#X :attr:`name`r& h%j h&h)h+h]h-}r' (Ureftyper( Xattrr) hahbXnamer* U refdomainr+ Xpyr, h/]r- h1]r. U refexplicitr/ h3]r0 h5]r1 h7]r2 hlhmhnjb hoj\uh:Kh]r3 hq)r4 }r5 (h#j& h-}r6 (h3]r7 h5]r8 (hwj, Xpy-attrr9 eh1]r: h/]r; h7]r< uh%j$ h]r= h}Xnamer> r? }r@ (h#Uh%j4 ubah+hubaubh}X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rA rB }rC (h#X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rD h%j ubeubj)rE }rF (h#Uh%j h&Nh+j h-}rG (h3]rH h5]rI h1]rJ h/]rK h7]rL uh:Nh;hh]rM j)rN }rO (h#Uh-}rP (h3]rQ h5]rR h1]rS h/]rT h7]rU uh%jE h]rV (j)rW }rX (h#Uh-}rY (h3]rZ h5]r[ h1]r\ h/]r] h7]r^ uh%jN h]r_ h}X Variablesr` ra }rb (h#Uh%jW ubah+j)ubj*)rc }rd (h#Uh-}re (h3]rf h5]rg h1]rh h/]ri h7]rj uh%jN h]rk j4)rl }rm (h#Uh-}rn (h3]ro h5]rp h1]rq h/]rr h7]rs uh%jc h]rt (j>)ru }rv (h#Uh-}rw (h3]rx h5]ry h1]rz h/]r{ h7]r| uh%jl h]r} j<)r~ }r (h#Uh-}r (h3]r h5]r h1]r h/]r h7]r uh%ju h]r (hY)r }r (h#Uh-}r (Ureftyper jUU reftargetr Xchannelsr U refdomainr jN h/]r h1]r U refexplicitr h3]r h5]r h7]r uh%j~ h]r j`)r }r (h#j h-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r h}Xchannelsr r }r (h#Uh%j ubah+jmubah+h]ubh}X -- r r }r (h#Uh%j~ ubj<)r }r (h#Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r h%j~ h&j h+jAh-}r (h3]r h5]r h1]r h/]r h7]r uh:Kh]r h}Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r r }r (h#j h%j ubaubj<)r }r (h#XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r h%j~ h&j h+jAh-}r (h3]r h5]r h1]r h/]r h7]r uh:Kh]r h}XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r r }r (h#j h%j ubaubeh+jAubah+jubj>)r }r (h#Uh-}r (h3]r h5]r h1]r h/]r h7]r uh%jl h]r j<)r }r (h#Uh-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r (hY)r }r (h#Uh-}r (Ureftyper jUU reftargetr Xvaluer U refdomainr jN h/]r h1]r U refexplicitr h3]r h5]r h7]r uh%j h]r j`)r }r (h#j h-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r h}Xvaluer r }r (h#Uh%j ubah+jmubah+h]ubh}X -- r r }r (h#Uh%j ubh}X this is a r r }r (h#X this is a r h%j ubhY)r }r (h#X#:class:`circuits.core.values.Value`r h%j h&Nh+h]h-}r (Ureftyper Xclassr hahbXcircuits.core.values.Valuer U refdomainr Xpyr h/]r h1]r U refexplicitr h3]r h5]r h7]r hlhmhnjb hoj\uh:Nh]r hq)r }r (h#j h-}r (h3]r h5]r (hwj Xpy-classr eh1]r h/]r h7]r uh%j h]r h}Xcircuits.core.values.Valuer r }r (h#Uh%j ubah+hubaubh}XN object that holds the results returned by the handlers invoked for the event.r r }r (h#XN object that holds the results returned by the handlers invoked for the event.r h%j ubeh+jAubah+jubj>)r }r (h#Uh-}r (h3]r h5]r h1]r h/]r h7]r uh%jl h]r j<)r }r (h#Uh-}r (h3]r h5]r h1]r h/]r! h7]r" uh%j h]r# (hY)r$ }r% (h#Uh-}r& (Ureftyper' jUU reftargetr( Xsuccessr) U refdomainr* jN h/]r+ h1]r, U refexplicitr- h3]r. h5]r/ h7]r0 uh%j h]r1 j`)r2 }r3 (h#j) h-}r4 (h3]r5 h5]r6 h1]r7 h/]r8 h7]r9 uh%j$ h]r: h}Xsuccessr; r< }r= (h#Uh%j2 ubah+jmubah+h]ubh}X -- r> r? }r@ (h#Uh%j ubh}X%if this optional attribute is set to rA rB }rC (h#X%if this optional attribute is set to rD h%j ubhq)rE }rF (h#X``True``rG h-}rH (h3]rI h5]rJ h1]rK h/]rL h7]rM uh%j h]rN h}XTruerO rP }rQ (h#Uh%jE ubah+hubh}X, an associated event rR rS }rT (h#X, an associated event rU h%j ubhq)rV }rW (h#X``EventSuccess``rX h-}rY (h3]rZ h5]r[ h1]r\ h/]r] h7]r^ uh%j h]r_ h}X EventSuccessr` ra }rb (h#Uh%jV ubah+hubh}X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rc rd }re (h#X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rf h%j ubeh+jAubah+jubj>)rg }rh (h#Uh-}ri (h3]rj h5]rk h1]rl h/]rm h7]rn uh%jl h]ro j<)rp }rq (h#Uh-}rr (h3]rs h5]rt h1]ru h/]rv h7]rw uh%jg h]rx (hY)ry }rz (h#Uh-}r{ (Ureftyper| jUU reftargetr} Xsuccess_channelsr~ U refdomainr jN h/]r h1]r U refexplicitr h3]r h5]r h7]r uh%jp h]r j`)r }r (h#j~ h-}r (h3]r h5]r h1]r h/]r h7]r uh%jy h]r h}Xsuccess_channelsr r }r (h#Uh%j ubah+jmubah+h]ubh}X -- r r }r (h#Uh%jp ubh}Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r r }r (h#Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r h%jp ubeh+jAubah+jubj>)r }r (h#Uh-}r (h3]r h5]r h1]r h/]r h7]r uh%jl h]r j<)r }r (h#Uh-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r (hY)r }r (h#Uh-}r (Ureftyper jUU reftargetr Xcompleter U refdomainr jN h/]r h1]r U refexplicitr h3]r h5]r h7]r uh%j h]r j`)r }r (h#j h-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r h}Xcompleter r }r (h#Uh%j ubah+jmubah+h]ubh}X -- r r }r (h#Uh%j ubh}X%if this optional attribute is set to r r }r (h#X%if this optional attribute is set to r h%j ubhq)r }r (h#X``True``r h-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r h}XTruer r }r (h#Uh%j ubah+hubh}X, an associated event r r }r (h#X, an associated event r h%j ubhq)r }r (h#X``EventComplete``r h-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r h}X EventCompleter r }r (h#Uh%j ubah+hubh}X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r r }r (h#X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r h%j ubeh+jAubah+jubj>)r }r (h#Uh-}r (h3]r h5]r h1]r h/]r h7]r uh%jl h]r j<)r }r (h#Uh-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r (hY)r }r (h#Uh-}r (Ureftyper jUU reftargetr Xsuccess_channelsr U refdomainr jN h/]r h1]r U refexplicitr h3]r h5]r h7]r uh%j h]r j`)r }r (h#j h-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r h}Xsuccess_channelsr r }r (h#Uh%j ubah+jmubah+h]ubh}X -- r r }r (h#Uh%j ubh}Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r r }r (h#Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r! h%j ubeh+jAubah+jubeh+jubah+jubeh+jubaubeubeubeubh=)r" }r# (h#Uh%h>h&h)h+hBh-}r$ (h3]r% h5]r& h1]r' h/]r( hah7]r) h auh:Kh;hh]r* (hM)r+ }r, (h#X Componentsr- h%j" h&h)h+hQh-}r. (h3]r/ h5]r0 h1]r1 h/]r2 h7]r3 uh:Kh;hh]r4 h}X Componentsr5 r6 }r7 (h#j- h%j+ ubaubj<)r8 }r9 (h#X**none**r: h%j" h&h)h+jAh-}r; (h3]r< h5]r= h1]r> h/]r? h7]r@ uh:Kh;hh]rA j`)rB }rC (h#j: h-}rD (h3]rE h5]rF h1]rG h/]rH h7]rI uh%j8 h]rJ h}XnonerK rL }rM (h#Uh%jB ubah+jmubaubeubh=)rN }rO (h#Uh%h>h&h)h+hBh-}rP (h3]rQ h5]rR h1]rS h/]rT hah7]rU hauh:Kh;hh]rV (hM)rW }rX (h#X FunctionsrY h%jN h&h)h+hQh-}rZ (h3]r[ h5]r\ h1]r] h/]r^ h7]r_ uh:Kh;hh]r` h}X Functionsra rb }rc (h#jY h%jW ubaubj<)rd }re (h#X**none**rf h%jN h&h)h+jAh-}rg (h3]rh h5]ri h1]rj h/]rk h7]rl uh:K!h;hh]rm j`)rn }ro (h#jf h-}rp (h3]rq h5]rr h1]rs h/]rt h7]ru uh%jd h]rv h}Xnonerw rx }ry (h#Uh%jn ubah+jmubaubeubeubeh#UU transformerrz NU footnote_refsr{ }r| Urefnamesr} }r~ Usymbol_footnotesr ]r Uautofootnote_refsr ]r Usymbol_footnote_refsr ]r U citationsr ]r h;hU current_liner NUtransform_messagesr ]r cdocutils.nodes system_message r )r }r (h#Uh-}r (h3]r Ulevelr Kh/]r h1]r Usourcer h)h5]r h7]r Uliner KUtyper UINFOr uh]r j<)r }r (h#Uh-}r (h3]r h5]r h1]r h/]r h7]r uh%j h]r h}X9Hyperlink target "circuits-web-events" is not referenced.r r }r (h#Uh%j ubah+jAubah+Usystem_messager ubaUreporterr NUid_startr KU autofootnotesr ]r U citation_refsr }r Uindirect_targetsr ]r Usettingsr (cdocutils.frontend Values r or }r (Ufootnote_backlinksr KUrecord_dependenciesr NU rfc_base_urlr Uhttp://tools.ietf.org/html/r U tracebackr Upep_referencesr NUstrip_commentsr NU toc_backlinksr Uentryr U language_coder Uenr U datestampr NU report_levelr KU _destinationr NU halt_levelr KU strip_classesr NhQNUerror_encoding_error_handlerr Ubackslashreplacer Udebugr NUembed_stylesheetr Uoutput_encoding_error_handlerr Ustrictr U sectnum_xformr KUdump_transformsr NU docinfo_xformr KUwarning_streamr NUpep_file_url_templater Upep-%04dr Uexit_status_levelr KUconfigr NUstrict_visitorr NUcloak_email_addressesr Utrim_footnote_reference_spacer Uenvr NUdump_pseudo_xmlr NUexpose_internalsr NUsectsubtitle_xformr U source_linkr NUrfc_referencesr NUoutput_encodingr Uutf-8r U source_urlr NUinput_encodingr U utf-8-sigr U_disable_configr NU id_prefixr UU tab_widthr KUerror_encodingr U ISO-8859-1r U_sourcer UD/home/prologic/work/circuits/docs/source/api/circuits_web_events.rstr Ugettext_compactr U generatorr NUdump_internalsr NU smart_quotesr U pep_base_urlr Uhttp://www.python.org/dev/peps/r Usyntax_highlightr Ulongr Uinput_encoding_error_handlerr j Uauto_id_prefixr Uidr Udoctitle_xformr Ustrip_elements_with_classesr NU _config_filesr ]r Ufile_insertion_enabledr KU raw_enabledr KU dump_settingsr NubUsymbol_footnote_startr KUidsr }r (hjshjN h jV hHh )r }r (h#Uh%h>h&hh+h,h-}r (h3]r h/]r hHah1]r Uismodrh5]rh7]ruh:Kh;hh]rubh jh j hj" hh>hh>hhhhuUsubstitution_namesr}rh+h;h-}r(h3]rh/]rh1]r Usourcer h)h5]r h7]r uU footnotesr ]rUrefidsr}rh]rh!asub.circuits-2.1.0/docs/build/doctrees/api/circuits_net_protocols_line.doctree0000644000014400001440000007373112113366661026675 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X circuits.net.protocols.line.LineqXcircuits.net.protocols.line.LPqX,circuits.net.protocols.line -- line protocolqNX componentsq NXeventsq NX functionsq NuUsubstitution_defsq }q Uparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hhhhhU)circuits-net-protocols-line-line-protocolqh U componentsqh Ueventsqh U functionsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceq cdocutils.nodes reprunicode q!XL/home/prologic/work/circuits/docs/source/api/circuits_net_protocols_line.rstq"q#}q$bUtagnameq%Usectionq&U attributesq'}q((Udupnamesq)]q*Uclassesq+]q,Ubackrefsq-]q.Uidsq/]q0(X"module-circuits.net.protocols.lineq1heUnamesq2]q3hauUlineq4KUdocumentq5hh]q6(cdocutils.nodes title q7)q8}q9(hX3:mod:`circuits.net.protocols.line` -- Line Protocolq:hhh h#h%Utitleq;h'}q<(h)]q=h+]q>h-]q?h/]q@h2]qAuh4Kh5hh]qB(csphinx.addnodes pending_xref qC)qD}qE(hX":mod:`circuits.net.protocols.line`qFhh8h h#h%U pending_xrefqGh'}qH(UreftypeqIXmodqJUrefwarnqKU reftargetqLXcircuits.net.protocols.lineqMU refdomainqNXpyqOh/]qPh-]qQU refexplicitqRh)]qSh+]qTh2]qUUrefdocqVUapi/circuits_net_protocols_lineqWUpy:classqXNU py:moduleqYNuh4Kh]qZcdocutils.nodes literal q[)q\}q](hhFh'}q^(h)]q_h+]q`(UxrefqahOXpy-modqbeh-]qch/]qdh2]qeuhhDh]qfcdocutils.nodes Text qgXcircuits.net.protocols.lineqhqi}qj(hUhh\ubah%UliteralqkubaubhgX -- Line Protocolqlqm}qn(hX -- Line Protocolqohh8ubeubcsphinx.addnodes index qp)qq}qr(hUhhh h#h%Uindexqsh'}qt(h/]quh-]qvh)]qwh+]qxh2]qyUentriesqz]q{(Usingleq|X$circuits.net.protocols.line (module)X"module-circuits.net.protocols.lineUtq}auh4Kh5hh]q~ubh)q}q(hUhhh h#h%h&h'}q(h)]qh+]qh-]qh/]qhah2]qh auh4Kh5hh]q(h7)q}q(hXEventsqhhh h#h%h;h'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgXEventsqq}q(hhhhubaubhp)q}q(hUhhh Nh%hsh'}q(h/]qh-]qh)]qh+]qh2]qUentriesq]q(h|X+Line (class in circuits.net.protocols.line)hUtqauh4Nh5hh]qubcsphinx.addnodes desc q)q}q(hUhhh Nh%Udescqh'}q(UnoindexqUdomainqXpyqh/]qh-]qh)]qh+]qh2]qUobjtypeqXclassqUdesctypeqhuh4Nh5hh]q(csphinx.addnodes desc_signature q)q}q(hXLine(*args, **kwargs)qhhh U qh%Udesc_signatureqh'}q(h/]qhaUmoduleqh!Xcircuits.net.protocols.lineqq}qbh-]qh)]qh+]qh2]qhaUfullnameqXLineqUclassqUUfirstqʼnuh4Nh5hh]q(csphinx.addnodes desc_annotation q)q}q(hXclass qhhh hh%Udesc_annotationqh'}q(h)]qh+]qh-]qh/]qh2]quh4Nh5hh]qhgXclass qӅq}q(hUhhubaubcsphinx.addnodes desc_addname q)q}q(hXcircuits.net.protocols.line.qhhh hh%U desc_addnameqh'}q(h)]qh+]qh-]qh/]qh2]quh4Nh5hh]qhgXcircuits.net.protocols.line.q⅁q}q(hUhhubaubcsphinx.addnodes desc_name q)q}q(hhhhh hh%U desc_nameqh'}q(h)]qh+]qh-]qh/]qh2]quh4Nh5hh]qhgXLineqq}q(hUhhubaubcsphinx.addnodes desc_parameterlist q)q}q(hUhhh hh%Udesc_parameterlistqh'}q(h)]qh+]qh-]qh/]qh2]quh4Nh5hh]q(csphinx.addnodes desc_parameter q)q}r(hX*argsrh'}r(h)]rh+]rh-]rh/]rh2]ruhhh]rhgX*argsr r }r (hUhhubah%Udesc_parameterr ubh)r }r(hX**kwargsrh'}r(h)]rh+]rh-]rh/]rh2]ruhhh]rhgX**kwargsrr}r(hUhj ubah%j ubeubeubcsphinx.addnodes desc_content r)r}r(hUhhh hh%U desc_contentrh'}r(h)]rh+]r h-]r!h/]r"h2]r#uh4Nh5hh]r$(cdocutils.nodes paragraph r%)r&}r'(hX*Bases: :class:`circuits.core.events.Event`r(hjh U r)h%U paragraphr*h'}r+(h)]r,h+]r-h-]r.h/]r/h2]r0uh4Kh5hh]r1(hgXBases: r2r3}r4(hXBases: r5hj&ubhC)r6}r7(hX#:class:`circuits.core.events.Event`r8hj&h h#h%hGh'}r9(Ureftyper:Xclassr;hKhLXcircuits.core.events.Eventr<U refdomainr=Xpyr>h/]r?h-]r@U refexplicitrAh)]rBh+]rCh2]rDhVhWhXhhYXcircuits.net.protocols.linerEuh4Kh]rFh[)rG}rH(hj8h'}rI(h)]rJh+]rK(haj>Xpy-classrLeh-]rMh/]rNh2]rOuhj6h]rPhgXcircuits.core.events.EventrQrR}rS(hUhjGubah%hkubaubeubj%)rT}rU(hX Line EventrVhjh Xi/home/prologic/work/circuits/circuits/net/protocols/line.py:docstring of circuits.net.protocols.line.LinerWh%j*h'}rX(h)]rYh+]rZh-]r[h/]r\h2]r]uh4Kh5hh]r^hgX Line Eventr_r`}ra(hjVhjTubaubj%)rb}rc(hXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rdhjh jWh%j*h'}re(h)]rfh+]rgh-]rhh/]rih2]rjuh4Kh5hh]rkhgXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rlrm}rn(hjdhjbubaubj%)ro}rp(hXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rqhjh jWh%j*h'}rr(h)]rsh+]rth-]ruh/]rvh2]rwuh4Kh5hh]rxhgXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.ryrz}r{(hjqhjoubaubj%)r|}r}(hXEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.r~hjh jWh%j*h'}r(h)]rh+]rh-]rh/]rh2]ruh4K h5hh]r(hgXEvery event has a rr}r(hXEvery event has a rhj|ubhC)r}r(hX :attr:`name`rhj|h h#h%hGh'}r(UreftyperXattrrhKhLXnamerU refdomainrXpyrh/]rh-]rU refexplicitrh)]rh+]rh2]rhVhWhXhhYjEuh4Kh]rh[)r}r(hjh'}r(h)]rh+]r(hajXpy-attrreh-]rh/]rh2]ruhjh]rhgXnamerr}r(hUhjubah%hkubaubhgX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(hX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rhj|ubeubcdocutils.nodes field_list r)r}r(hUhjh Nh%U field_listrh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rcdocutils.nodes field r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(cdocutils.nodes field_name r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgX Variablesrr}r(hUhjubah%U field_namerubcdocutils.nodes field_body r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rcdocutils.nodes bullet_list r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(cdocutils.nodes list_item r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rj%)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(hC)r}r(hUh'}r(UreftyperUobjrU reftargetrXchannelsrU refdomainrhh/]rh-]rU refexplicitrh)]rh+]rh2]ruhjh]rcdocutils.nodes strong r)r}r(hjh'}r(h)]rh+]r h-]r h/]r h2]r uhjh]r hgXchannelsrr}r(hUhjubah%Ustrongrubah%hGubhgX -- rr}r(hUhjubj%)r}r(hXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rhjh jWh%j*h'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh]rhgXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rr }r!(hjhjubaubj%)r"}r#(hXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r$hjh jWh%j*h'}r%(h)]r&h+]r'h-]r(h/]r)h2]r*uh4Kh]r+hgXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r,r-}r.(hj$hj"ubaubeh%j*ubah%U list_itemr/ubj)r0}r1(hUh'}r2(h)]r3h+]r4h-]r5h/]r6h2]r7uhjh]r8j%)r9}r:(hUh'}r;(h)]r<h+]r=h-]r>h/]r?h2]r@uhj0h]rA(hC)rB}rC(hUh'}rD(UreftyperEjU reftargetrFXvaluerGU refdomainrHhh/]rIh-]rJU refexplicitrKh)]rLh+]rMh2]rNuhj9h]rOj)rP}rQ(hjGh'}rR(h)]rSh+]rTh-]rUh/]rVh2]rWuhjBh]rXhgXvaluerYrZ}r[(hUhjPubah%jubah%hGubhgX -- r\r]}r^(hUhj9ubhgX this is a r_r`}ra(hX this is a rbhj9ubhC)rc}rd(hX#:class:`circuits.core.values.Value`rehj9h Nh%hGh'}rf(UreftypergXclassrhhKhLXcircuits.core.values.ValueriU refdomainrjXpyrkh/]rlh-]rmU refexplicitrnh)]roh+]rph2]rqhVhWhXhhYjEuh4Nh]rrh[)rs}rt(hjeh'}ru(h)]rvh+]rw(hajkXpy-classrxeh-]ryh/]rzh2]r{uhjch]r|hgXcircuits.core.values.Valuer}r~}r(hUhjsubah%hkubaubhgXN object that holds the results returned by the handlers invoked for the event.rr}r(hXN object that holds the results returned by the handlers invoked for the event.rhj9ubeh%j*ubah%j/ubj)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rj%)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(hC)r}r(hUh'}r(UreftyperjU reftargetrXsuccessrU refdomainrhh/]rh-]rU refexplicitrh)]rh+]rh2]ruhjh]rj)r}r(hjh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXsuccessrr}r(hUhjubah%jubah%hGubhgX -- rr}r(hUhjubhgX%if this optional attribute is set to rr}r(hX%if this optional attribute is set to rhjubh[)r}r(hX``True``rh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXTruerr}r(hUhjubah%hkubhgX, an associated event rr}r(hX, an associated event rhjubh[)r}r(hX``EventSuccess``rh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgX EventSuccessrr}r(hUhjubah%hkubhgX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(hX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rhjubeh%j*ubah%j/ubj)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rj%)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(hC)r}r(hUh'}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrhh/]rh-]rU refexplicitrh)]rh+]rh2]ruhjh]rj)r}r(hjh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXsuccess_channelsrr}r(hUhjubah%jubah%hGubhgX -- rr}r(hUhjubhgXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr }r (hXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r hjubeh%j*ubah%j/ubj)r }r (hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rj%)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhj h]r(hC)r}r(hUh'}r (Ureftyper!jU reftargetr"Xcompleter#U refdomainr$hh/]r%h-]r&U refexplicitr'h)]r(h+]r)h2]r*uhjh]r+j)r,}r-(hj#h'}r.(h)]r/h+]r0h-]r1h/]r2h2]r3uhjh]r4hgXcompleter5r6}r7(hUhj,ubah%jubah%hGubhgX -- r8r9}r:(hUhjubhgX%if this optional attribute is set to r;r<}r=(hX%if this optional attribute is set to r>hjubh[)r?}r@(hX``True``rAh'}rB(h)]rCh+]rDh-]rEh/]rFh2]rGuhjh]rHhgXTruerIrJ}rK(hUhj?ubah%hkubhgX, an associated event rLrM}rN(hX, an associated event rOhjubh[)rP}rQ(hX``EventComplete``rRh'}rS(h)]rTh+]rUh-]rVh/]rWh2]rXuhjh]rYhgX EventCompleterZr[}r\(hUhjPubah%hkubhgX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r]r^}r_(hX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r`hjubeh%j*ubah%j/ubj)ra}rb(hUh'}rc(h)]rdh+]reh-]rfh/]rgh2]rhuhjh]rij%)rj}rk(hUh'}rl(h)]rmh+]rnh-]roh/]rph2]rquhjah]rr(hC)rs}rt(hUh'}ru(UreftypervjU reftargetrwXsuccess_channelsrxU refdomainryhh/]rzh-]r{U refexplicitr|h)]r}h+]r~h2]ruhjjh]rj)r}r(hjxh'}r(h)]rh+]rh-]rh/]rh2]ruhjsh]rhgXsuccess_channelsrr}r(hUhjubah%jubah%hGubhgX -- rr}r(hUhjjubhgXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(hXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rhjjubeh%j*ubah%j/ubeh%U bullet_listrubah%U field_bodyrubeh%Ufieldrubaubeubeubeubh)r}r(hUhhh h#h%h&h'}r(h)]rh+]rh-]rh/]rhah2]rh auh4K h5hh]r(h7)r}r(hX Componentsrhjh h#h%h;h'}r(h)]rh+]rh-]rh/]rh2]ruh4K h5hh]rhgX Componentsrr}r(hjhjubaubhp)r}r(hUhjh Xg/home/prologic/work/circuits/circuits/net/protocols/line.py:docstring of circuits.net.protocols.line.LPrh%hsh'}r(h/]rh-]rh)]rh+]rh2]rUentriesr]r(h|X)LP (class in circuits.net.protocols.line)hUtrauh4Nh5hh]rubh)r}r(hUhjh jh%hh'}r(hhXpyrh/]rh-]rh)]rh+]rh2]rhXclassrhjuh4Nh5hh]r(h)r}r(hXLP(*args, **kwargs)rhjh hh%hh'}r(h/]rhahh!Xcircuits.net.protocols.linerr}rbh-]rh)]rh+]rh2]rhahXLPrhUhʼnuh4Nh5hh]r(h)r}r(hXclass rhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXclass rr}r(hUhjubaubh)r}r(hXcircuits.net.protocols.line.rhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXcircuits.net.protocols.line.rr}r(hUhjubaubh)r}r(hjhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXLPrr}r(hUhjubaubh)r}r(hUhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]r(h)r}r(hX*argsrh'}r(h)]rh+]rh-]rh/]r h2]r uhjh]r hgX*argsr r }r(hUhjubah%j ubh)r}r(hX**kwargsrh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgX**kwargsrr}r(hUhjubah%j ubeubeubj)r}r(hUhjh hh%jh'}r(h)]rh+]r h-]r!h/]r"h2]r#uh4Nh5hh]r$(j%)r%}r&(hX6Bases: :class:`circuits.core.components.BaseComponent`r'hjh j)h%j*h'}r((h)]r)h+]r*h-]r+h/]r,h2]r-uh4Kh5hh]r.(hgXBases: r/r0}r1(hXBases: r2hj%ubhC)r3}r4(hX/:class:`circuits.core.components.BaseComponent`r5hj%h h#h%hGh'}r6(Ureftyper7Xclassr8hKhLX&circuits.core.components.BaseComponentr9U refdomainr:Xpyr;h/]r<h-]r=U refexplicitr>h)]r?h+]r@h2]rAhVhWhXjhYjEuh4Kh]rBh[)rC}rD(hj5h'}rE(h)]rFh+]rG(haj;Xpy-classrHeh-]rIh/]rJh2]rKuhj3h]rLhgX&circuits.core.components.BaseComponentrMrN}rO(hUhjCubah%hkubaubeubj%)rP}rQ(hX Line ProtocolrRhjh jh%j*h'}rS(h)]rTh+]rUh-]rVh/]rWh2]rXuh4Kh5hh]rYhgX Line ProtocolrZr[}r\(hjRhjPubaubj%)r]}r^(hXImplements the Line Protocol.r_hjh jh%j*h'}r`(h)]rah+]rbh-]rch/]rdh2]reuh4Kh5hh]rfhgXImplements the Line Protocol.rgrh}ri(hj_hj]ubaubj%)rj}rk(hXIncoming data is split into lines with a splitter function. For each line of data processed a Line Event is created. Any unfinished lines are appended into an internal buffer.rlhjh jh%j*h'}rm(h)]rnh+]roh-]rph/]rqh2]rruh4Kh5hh]rshgXIncoming data is split into lines with a splitter function. For each line of data processed a Line Event is created. Any unfinished lines are appended into an internal buffer.rtru}rv(hjlhjjubaubj%)rw}rx(hX=A custom line splitter function can be passed to customize how data is split into lines. This function must accept two arguments, the data to process and any left over data from a previous invocation of the splitter function. The function must also return a tiple of two items, a list of lines and any left over data.ryhjh jh%j*h'}rz(h)]r{h+]r|h-]r}h/]r~h2]ruh4K h5hh]rhgX=A custom line splitter function can be passed to customize how data is split into lines. This function must accept two arguments, the data to process and any left over data from a previous invocation of the splitter function. The function must also return a tiple of two items, a list of lines and any left over data.rr}r(hjyhjwubaubj)r}r(hUhjh jh%jh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rj)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(j)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgX Parametersrr}r(hUhjubah%jubj)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rj%)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(j)r}r(hXsplitterrh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXsplitterrr}r(hUhjubah%jubhgX (rr}r(hUhjubhC)r}r(hUh'}r(UreftyperjU reftargetrXfunctionrU refdomainrjh/]rh-]rU refexplicitrh)]rh+]rh2]ruhjh]rcdocutils.nodes emphasis r)r}r(hjh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXfunctionrr}r(hUhjubah%Uemphasisrubah%hGubhgX)r}r(hUhjubhgX -- rr}r(hUhjubhgXa line splitter functionrr}r(hXa line splitter functionrhjubeh%j*ubah%jubeh%jubaubj%)r}r(hX&This Component operates in two modes. In normal operation it's expected to be used in conjunction with components that expose a Read Event on a "read" channel with only one argument (data). Some builtin components that expose such events are: - circuits.net.sockets.TCPClient - circuits.io.Filerhjh jh%j*h'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgX&This Component operates in two modes. In normal operation it's expected to be used in conjunction with components that expose a Read Event on a "read" channel with only one argument (data). Some builtin components that expose such events are: - circuits.net.sockets.TCPClient - circuits.io.Filerr}r(hjhjubaubj%)r}r(hX0The second mode of operation works with circuits.net.sockets.Server components such as TCPServer, UNIXServer, etc. It's expected that two arguments exist in the Read Event, sock and data. The following two arguments can be passed to affect how unfinished data is stored and retrieved for such components:rhjh jh%j*h'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgX0The second mode of operation works with circuits.net.sockets.Server components such as TCPServer, UNIXServer, etc. It's expected that two arguments exist in the Read Event, sock and data. The following two arguments can be passed to affect how unfinished data is stored and retrieved for such components:rr}r(hjhjubaubj)r}r(hUhjh jh%jh'}r(h)]rh+]rh-]rh/]r h2]r uh4Nh5hh]r j)r }r (hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(j)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhj h]rhgX Parametersrr}r (hUhjubah%jubj)r!}r"(hUh'}r#(h)]r$h+]r%h-]r&h/]r'h2]r(uhj h]r)j%)r*}r+(hUh'}r,(h)]r-h+]r.h-]r/h/]r0h2]r1uhj!h]r2(j)r3}r4(hX getBufferr5h'}r6(h)]r7h+]r8h-]r9h/]r:h2]r;uhj*h]r<hgX getBufferr=r>}r?(hUhj3ubah%jubhgX (r@rA}rB(hUhj*ubhC)rC}rD(hUh'}rE(UreftyperFjU reftargetrGXfunctionrHU refdomainrIjh/]rJh-]rKU refexplicitrLh)]rMh+]rNh2]rOuhj*h]rPj)rQ}rR(hjHh'}rS(h)]rTh+]rUh-]rVh/]rWh2]rXuhjCh]rYhgXfunctionrZr[}r\(hUhjQubah%jubah%hGubhgX)r]}r^(hUhj*ubhgX -- r_r`}ra(hUhj*ubhgX1function to retrieve the buffer for a client sockrbrc}rd(hX1function to retrieve the buffer for a client sockrehj*ubeh%j*ubah%jubeh%jubaubj%)rf}rg(hXbThis function must accept one argument (sock,) the client socket whoose buffer is to be retrieved.rhhjh jh%j*h'}ri(h)]rjh+]rkh-]rlh/]rmh2]rnuh4K"h5hh]rohgXbThis function must accept one argument (sock,) the client socket whoose buffer is to be retrieved.rprq}rr(hjhhjfubaubj)rs}rt(hUhjh jh%jh'}ru(h)]rvh+]rwh-]rxh/]ryh2]rzuh4Nh5hh]r{j)r|}r}(hUh'}r~(h)]rh+]rh-]rh/]rh2]ruhjsh]r(j)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhj|h]rhgX Parametersrr}r(hUhjubah%jubj)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhj|h]rj%)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(j)r}r(hX updateBufferrh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgX updateBufferrr}r(hUhjubah%jubhgX (rr}r(hUhjubhC)r}r(hUh'}r(UreftyperjU reftargetrXfunctionrU refdomainrjh/]rh-]rU refexplicitrh)]rh+]rh2]ruhjh]rj)r}r(hjh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXfunctionrr}r(hUhjubah%jubah%hGubhgX)r}r(hUhjubhgX -- rr}r(hUhjubhgX/function to update the buffer for a client sockrr}r(hX/function to update the buffer for a client sockrhjubeh%j*ubah%jubeh%jubaubj%)r}r(hXqThis function must accept two arguments (sock, buffer,) the client socket and the left over buffer to be updated.rhjh jh%j*h'}r(h)]rh+]rh-]rh/]rh2]ruh4K(h5hh]rhgXqThis function must accept two arguments (sock, buffer,) the client socket and the left over buffer to be updated.rr}r(hjhjubaubcdocutils.nodes definition_list r)r}r(hUhjh jh%Udefinition_listrh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rcdocutils.nodes definition_list_item r)r}r(hXq@note: This Component must be used in conjunction with a Component that exposes Read events on a "read" Channel. rhjh jh%Udefinition_list_itemrh'}r(h)]rh+]rh-]rh/]rh2]ruh4K,h]r(cdocutils.nodes term r)r}r(hXG@note: This Component must be used in conjunction with a Component thatrhjh jh%Utermrh'}r(h)]rh+]rh-]rh/]rh2]ruh4K,h]rhgXG@note: This Component must be used in conjunction with a Component thatrr}r(hXG@note: This Component must be used in conjunction with a Component thatr hjubaubcdocutils.nodes definition r )r }r (hUh'}r (h)]rh+]rh-]rh/]rh2]ruhjh]rj%)r}r(hX(exposes Read events on a "read" Channel.rhj h jh%j*h'}r(h)]rh+]rh-]rh/]rh2]ruh4K,h]rhgX(exposes Read events on a "read" Channel.rr}r (hjhjubaubah%U definitionr!ubeubaubj%)r"}r#(hX4initializes x; see x.__class__.__doc__ for signaturer$hjh jh%j*h'}r%(h)]r&h+]r'h-]r(h/]r)h2]r*uh4K.h5hh]r+hgX4initializes x; see x.__class__.__doc__ for signaturer,r-}r.(hj$hj"ubaubeubeubeubh)r/}r0(hUhhh h#h%h&h'}r1(h)]r2h+]r3h-]r4h/]r5hah2]r6h auh4Kh5hh]r7h7)r8}r9(hX Functionsr:hj/h h#h%h;h'}r;(h)]r<h+]r=h-]r>h/]r?h2]r@uh4Kh5hh]rAhgX FunctionsrBrC}rD(hj:hj8ubaubaubeubahUU transformerrENU footnote_refsrF}rGUrefnamesrH}rIUsymbol_footnotesrJ]rKUautofootnote_refsrL]rMUsymbol_footnote_refsrN]rOU citationsrP]rQh5hU current_linerRNUtransform_messagesrS]rTUreporterrUNUid_startrVKU autofootnotesrW]rXU citation_refsrY}rZUindirect_targetsr[]r\Usettingsr](cdocutils.frontend Values r^or_}r`(Ufootnote_backlinksraKUrecord_dependenciesrbNU rfc_base_urlrcUhttp://tools.ietf.org/html/rdU tracebackreUpep_referencesrfNUstrip_commentsrgNU toc_backlinksrhUentryriU language_coderjUenrkU datestamprlNU report_levelrmKU _destinationrnNU halt_levelroKU strip_classesrpNh;NUerror_encoding_error_handlerrqUbackslashreplacerrUdebugrsNUembed_stylesheetrtUoutput_encoding_error_handlerruUstrictrvU sectnum_xformrwKUdump_transformsrxNU docinfo_xformryKUwarning_streamrzNUpep_file_url_templater{Upep-%04dr|Uexit_status_levelr}KUconfigr~NUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUL/home/prologic/work/circuits/docs/source/api/circuits_net_protocols_line.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjvUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hhhjhj/hhhjh1cdocutils.nodes target r)r}r(hUhhh h#h%Utargetrh'}r(h)]rh/]rh1ah-]rUismodrh+]rh2]ruh4Kh5hh]rubhhuUsubstitution_namesr}rh%h5h'}r(h)]rh/]rh-]rUsourcerh#h+]rh2]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_node_server.doctree0000644000014400001440000002165712113366662025310 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNXcircuits.node.server -- serverqNXeventsqNX componentsq NXcircuits.node.server.Serverq uUsubstitution_defsq }q Uparse_messagesq ]qcdocutils.nodes system_message q)q}q(U rawsourceqUUparentqcsphinx.addnodes desc_content q)q}q(hUhcsphinx.addnodes desc q)q}q(hUhcdocutils.nodes section q)q}q(hUhh)q}q(hUhhUsourceqcdocutils.nodes reprunicode q XE/home/prologic/work/circuits/docs/source/api/circuits_node_server.rstq!q"}q#bUtagnameq$Usectionq%U attributesq&}q'(Udupnamesq(]q)Uclassesq*]q+Ubackrefsq,]q-Uidsq.]q/(Xmodule-circuits.node.serverq0Ucircuits-node-server-serverq1eUnamesq2]q3hauUlineq4KUdocumentq5hUchildrenq6]q7(cdocutils.nodes title q8)q9}q:(hX%:mod:`circuits.node.server` -- Serverq;hhhh"h$Utitleqh*]q?h,]q@h.]qAh2]qBuh4Kh5hh6]qC(csphinx.addnodes pending_xref qD)qE}qF(hX:mod:`circuits.node.server`qGhh9hh"h$U pending_xrefqHh&}qI(UreftypeqJXmodqKUrefwarnqLU reftargetqMXcircuits.node.serverqNU refdomainqOXpyqPh.]qQh,]qRU refexplicitqSh(]qTh*]qUh2]qVUrefdocqWUapi/circuits_node_serverqXUpy:classqYNU py:moduleqZNuh4Kh6]q[cdocutils.nodes literal q\)q]}q^(hhGh&}q_(h(]q`h*]qa(UxrefqbhPXpy-modqceh,]qdh.]qeh2]qfuhhEh6]qgcdocutils.nodes Text qhXcircuits.node.serverqiqj}qk(hUhh]ubah$UliteralqlubaubhhX -- Serverqmqn}qo(hX -- Serverqphh9ubeubcsphinx.addnodes index qq)qr}qs(hUhhhU qth$Uindexquh&}qv(h.]qwh,]qxh(]qyh*]qzh2]q{Uentriesq|]q}(Usingleq~Xcircuits.node.server (module)Xmodule-circuits.node.serverUtqauh4Kh5hh6]qubcdocutils.nodes paragraph q)q}q(hXServerqhhhXV/home/prologic/work/circuits/circuits/node/server.py:docstring of circuits.node.serverqh$U paragraphqh&}q(h(]qh*]qh,]qh.]qh2]quh4Kh5hh6]qhhXServerqq}q(hhhhubaubh)q}q(hX...qhhhhh$hh&}q(h(]qh*]qh,]qh.]qh2]quh4Kh5hh6]qhhX...qq}q(hhhhubaubh)q}q(hUhhhh"h$h%h&}q(h(]qh*]qh,]qh.]qUeventsqah2]qhauh4Kh5hh6]q(h8)q}q(hXEventsqhhhh"h$hr.h$Udesc_signaturer/h&}r0(h.]r1h aUmoduler2h Xcircuits.node.serverr3r4}r5bh,]r6h(]r7h*]r8h2]r9h aUfullnamer:XServerr;Uclassr<UUfirstr=uh4Nh5hh6]r>(csphinx.addnodes desc_annotation r?)r@}rA(hXclass rBhj+hj.h$Udesc_annotationrCh&}rD(h(]rEh*]rFh,]rGh.]rHh2]rIuh4Nh5hh6]rJhhXclass rKrL}rM(hUhj@ubaubcsphinx.addnodes desc_addname rN)rO}rP(hXcircuits.node.server.rQhj+hj.h$U desc_addnamerRh&}rS(h(]rTh*]rUh,]rVh.]rWh2]rXuh4Nh5hh6]rYhhXcircuits.node.server.rZr[}r\(hUhjOubaubcsphinx.addnodes desc_name r])r^}r_(hj;hj+hj.h$U desc_namer`h&}ra(h(]rbh*]rch,]rdh.]reh2]rfuh4Nh5hh6]rghhXServerrhri}rj(hUhj^ubaubcsphinx.addnodes desc_parameterlist rk)rl}rm(hUhj+hj.h$Udesc_parameterlistrnh&}ro(h(]rph*]rqh,]rrh.]rsh2]rtuh4Nh5hh6]ru(csphinx.addnodes desc_parameter rv)rw}rx(hXbindryh&}rz(h(]r{h*]r|h,]r}h.]r~h2]ruhjlh6]rhhXbindrr}r(hUhjwubah$Udesc_parameterrubjv)r}r(hXchannel='node'rh&}r(h(]rh*]rh,]rh.]rh2]ruhjlh6]rhhXchannel='node'rr}r(hUhjubah$jubeubeubheubhj.h$U desc_contentrh&}r(h(]rh*]rh,]rh.]rh2]ruh4Nh5hh6]r(h)r}r(hX6Bases: :class:`circuits.core.components.BaseComponent`rhhhU rh$hh&}r(h(]rh*]rh,]rh.]rh2]ruh4Kh5hh6]r(hhXBases: rr}r(hXBases: rhjubhD)r}r(hX/:class:`circuits.core.components.BaseComponent`rhjhh"h$hHh&}r(UreftyperXclassrhLhMX&circuits.core.components.BaseComponentrU refdomainrXpyrh.]rh,]rU refexplicitrh(]rh*]rh2]rhWhXhYj;hZXcircuits.node.serverruh4Kh6]rh\)r}r(hjh&}r(h(]rh*]r(hbjXpy-classreh,]rh.]rh2]ruhjh6]rhhX&circuits.core.components.BaseComponentrr}r(hUhjubah$hlubaubeubh)r}r(hXServerrhhhjh$hh&}r(h(]rh*]rh,]rh.]rh2]ruh4Kh5hh6]rhhXServerrr}r(hjhjubaubh)r}r(hX...rhhhjh$hh&}r(h(]rh*]rh,]rh.]rh2]ruh4Kh5hh6]rhhX...rr}r(hjhjubaubeubhjh$Usystem_messagerh&}r(h(]rUlevelrKh.]rh,]rUsourcerjh*]rh2]rUlinerKUtyperUINFOruh4Kh5hh6]rh)r}r(hUh&}r(h(]rh*]rh,]rh.]rh2]ruhhh6]rhhXeUnexpected possible title overline or transition. Treating it as ordinary text because it's so short.rr}r(hUhjubah$hubaubaUcurrent_sourcerNU decorationrNUautofootnote_startrKUnameidsr}r(hhhh1hhh hh h uh6]rhahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr ]r U citationsr ]r h5hU current_liner NUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackr Upep_referencesr!NUstrip_commentsr"NU toc_backlinksr#Uentryr$U language_coder%Uenr&U datestampr'NU report_levelr(KU _destinationr)NU halt_levelr*KU strip_classesr+NhNUexpose_internalsr?NUsectsubtitle_xformr@U source_linkrANUrfc_referencesrBNUoutput_encodingrCUutf-8rDU source_urlrENUinput_encodingrFU utf-8-sigrGU_disable_configrHNU id_prefixrIUU tab_widthrJKUerror_encodingrKU ISO-8859-1rLU_sourcerMUE/home/prologic/work/circuits/docs/source/api/circuits_node_server.rstrNUgettext_compactrOU generatorrPNUdump_internalsrQNU smart_quotesrRU pep_base_urlrSUhttp://www.python.org/dev/peps/rTUsyntax_highlightrUUlongrVUinput_encoding_error_handlerrWj1Uauto_id_prefixrXUidrYUdoctitle_xformrZUstrip_elements_with_classesr[NU _config_filesr\]r]Ufile_insertion_enabledr^KU raw_enabledr_KU dump_settingsr`NubUsymbol_footnote_startraKUidsrb}rc(hhh1hh j+hhh0cdocutils.nodes target rd)re}rf(hUhhhhth$Utargetrgh&}rh(h(]rih.]rjh0ah,]rkUismodrlh*]rmh2]rnuh4Kh5hh6]roubhhuUsubstitution_namesrp}rqh$h5h&}rr(h(]rsh.]rth,]ruUsourcervh"h*]rwh2]rxuU footnotesry]rzUrefidsr{}r|ub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_servers.doctree0000644000014400001440000004303112113366666025315 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNXcircuits.web.servers.BaseServerqX componentsqNXcircuits.web.servers -- serversq NXcircuits.web.servers.Serverq Xeventsq NuUsubstitution_defsq }q Uparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhhhU componentsqh Ucircuits-web-servers-serversqh h h UeventsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceq cdocutils.nodes reprunicode q!XE/home/prologic/work/circuits/docs/source/api/circuits_web_servers.rstq"q#}q$bUtagnameq%Usectionq&U attributesq'}q((Udupnamesq)]q*Uclassesq+]q,Ubackrefsq-]q.Uidsq/]q0(Xmodule-circuits.web.serversq1heUnamesq2]q3h auUlineq4KUdocumentq5hh]q6(cdocutils.nodes title q7)q8}q9(hX&:mod:`circuits.web.servers` -- Serversq:hhh h#h%Utitleq;h'}q<(h)]q=h+]q>h-]q?h/]q@h2]qAuh4Kh5hh]qB(csphinx.addnodes pending_xref qC)qD}qE(hX:mod:`circuits.web.servers`qFhh8h h#h%U pending_xrefqGh'}qH(UreftypeqIXmodqJUrefwarnqKU reftargetqLXcircuits.web.serversqMU refdomainqNXpyqOh/]qPh-]qQU refexplicitqRh)]qSh+]qTh2]qUUrefdocqVUapi/circuits_web_serversqWUpy:classqXNU py:moduleqYNuh4Kh]qZcdocutils.nodes literal q[)q\}q](hhFh'}q^(h)]q_h+]q`(UxrefqahOXpy-modqbeh-]qch/]qdh2]qeuhhDh]qfcdocutils.nodes Text qgXcircuits.web.serversqhqi}qj(hUhh\ubah%UliteralqkubaubhgX -- Serversqlqm}qn(hX -- Serversqohh8ubeubcsphinx.addnodes index qp)qq}qr(hUhhh U qsh%Uindexqth'}qu(h/]qvh-]qwh)]qxh+]qyh2]qzUentriesq{]q|(Usingleq}Xcircuits.web.servers (module)Xmodule-circuits.web.serversUtq~auh4Kh5hh]qubcdocutils.nodes paragraph q)q}q(hX Web Serversqhhh XV/home/prologic/work/circuits/circuits/web/servers.py:docstring of circuits.web.serversqh%U paragraphqh'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgX Web Serversqq}q(hhhhubaubh)q}q(hX9This module implements the several Web Server components.qhhh hh%hh'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgX9This module implements the several Web Server components.qq}q(hhhhubaubh)q}q(hUhhh h#h%h&h'}q(h)]qh+]qh-]qh/]qhah2]qh auh4Kh5hh]q(h7)q}q(hXEventsqhhh h#h%h;h'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgXEventsqq}q(hhhhubaubh)q}q(hX**none**qhhh h#h%hh'}q(h)]qh+]qh-]qh/]qh2]quh4K h5hh]qcdocutils.nodes strong q)q}q(hhh'}q(h)]qh+]qh-]qh/]qh2]quhhh]qhgXnoneqDžq}q(hUhhubah%Ustrongqubaubeubh)q}q(hUhhh h#h%h&h'}q(h)]qh+]qh-]qh/]qhah2]qhauh4Kh5hh]q(h7)q}q(hX Componentsqhhh h#h%h;h'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgX Componentsqޅq}q(hhhhubaubhp)q}q(hUhhh Xa/home/prologic/work/circuits/circuits/web/servers.py:docstring of circuits.web.servers.BaseServerqh%hth'}q(h/]qh-]qh)]qh+]qh2]qUentriesq]q(h}X*BaseServer (class in circuits.web.servers)hUtqauh4Nh5hh]qubcsphinx.addnodes desc q)q}q(hUhhh hh%Udescqh'}q(UnoindexqUdomainqXpyqh/]qh-]qh)]qh+]qh2]qUobjtypeqXclassqUdesctypeqhuh4Nh5hh]q(csphinx.addnodes desc_signature q)r}r(hXNBaseServer(bind, encoding='utf-8', secure=False, certfile=None, channel='web')rhhh U rh%Udesc_signaturerh'}r(h/]rhaUmodulerh!Xcircuits.web.serversrr }r bh-]r h)]r h+]r h2]rhaUfullnamerX BaseServerrUclassrUUfirstruh4Nh5hh]r(csphinx.addnodes desc_annotation r)r}r(hXclass rhjh jh%Udesc_annotationrh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXclass r r!}r"(hUhjubaubcsphinx.addnodes desc_addname r#)r$}r%(hXcircuits.web.servers.r&hjh jh%U desc_addnamer'h'}r((h)]r)h+]r*h-]r+h/]r,h2]r-uh4Nh5hh]r.hgXcircuits.web.servers.r/r0}r1(hUhj$ubaubcsphinx.addnodes desc_name r2)r3}r4(hjhjh jh%U desc_namer5h'}r6(h)]r7h+]r8h-]r9h/]r:h2]r;uh4Nh5hh]r<hgX BaseServerr=r>}r?(hUhj3ubaubcsphinx.addnodes desc_parameterlist r@)rA}rB(hUhjh jh%Udesc_parameterlistrCh'}rD(h)]rEh+]rFh-]rGh/]rHh2]rIuh4Nh5hh]rJ(csphinx.addnodes desc_parameter rK)rL}rM(hXbindrNh'}rO(h)]rPh+]rQh-]rRh/]rSh2]rTuhjAh]rUhgXbindrVrW}rX(hUhjLubah%Udesc_parameterrYubjK)rZ}r[(hXencoding='utf-8'r\h'}r](h)]r^h+]r_h-]r`h/]rah2]rbuhjAh]rchgXencoding='utf-8'rdre}rf(hUhjZubah%jYubjK)rg}rh(hX secure=Falserih'}rj(h)]rkh+]rlh-]rmh/]rnh2]rouhjAh]rphgX secure=Falserqrr}rs(hUhjgubah%jYubjK)rt}ru(hX certfile=Nonervh'}rw(h)]rxh+]ryh-]rzh/]r{h2]r|uhjAh]r}hgX certfile=Noner~r}r(hUhjtubah%jYubjK)r}r(hX channel='web'rh'}r(h)]rh+]rh-]rh/]rh2]ruhjAh]rhgX channel='web'rr}r(hUhjubah%jYubeubeubcsphinx.addnodes desc_content r)r}r(hUhhh jh%U desc_contentrh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]r(h)r}r(hX6Bases: :class:`circuits.core.components.BaseComponent`rhjh U rh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]r(hgXBases: rr}r(hXBases: rhjubhC)r}r(hX/:class:`circuits.core.components.BaseComponent`rhjh h#h%hGh'}r(UreftyperXclassrhKhLX&circuits.core.components.BaseComponentrU refdomainrXpyrh/]rh-]rU refexplicitrh)]rh+]rh2]rhVhWhXjhYXcircuits.web.serversruh4Kh]rh[)r}r(hjh'}r(h)]rh+]r(hajXpy-classreh-]rh/]rh2]ruhjh]rhgX&circuits.core.components.BaseComponentrr}r(hUhjubah%hkubaubeubh)r}r(hXCreate a Base Web Serverrhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgXCreate a Base Web Serverrr}r(hjhjubaubh)r}r(hXpCreate a Base Web Server (HTTP) bound to the IP Address / Port or UNIX Socket specified by the 'bind' parameter.rhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgXpCreate a Base Web Server (HTTP) bound to the IP Address / Port or UNIX Socket specified by the 'bind' parameter.rr}r(hjhjubaubcdocutils.nodes field_list r)r}r(hUhjh hh%U field_listrh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]r(cdocutils.nodes field r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(cdocutils.nodes field_name r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgX Variablesrr}r(hUhjubah%U field_namerubcdocutils.nodes field_body r)r}r(hUh'}r(h)]rh+]rh-]r h/]r h2]r uhjh]r h)r }r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(hC)r}r(hUh'}r(UreftyperUobjrU reftargetrXserverrU refdomainrhh/]rh-]rU refexplicitr h)]r!h+]r"h2]r#uhj h]r$h)r%}r&(hjh'}r'(h)]r(h+]r)h-]r*h/]r+h2]r,uhjh]r-hgXserverr.r/}r0(hUhj%ubah%hubah%hGubhgX -- r1r2}r3(hUhj ubhgX(Reference to underlying Server Componentr4r5}r6(hX(Reference to underlying Server Componentr7hj ubeh%hubah%U field_bodyr8ubeh%Ufieldr9ubj)r:}r;(hUh'}r<(h)]r=h+]r>h-]r?h/]r@h2]rAuhjh]rB(j)rC}rD(hUh'}rE(h)]rFh+]rGh-]rHh/]rIh2]rJuhj:h]rKhgX ParametersrLrM}rN(hUhjCubah%jubj)rO}rP(hUh'}rQ(h)]rRh+]rSh-]rTh/]rUh2]rVuhj:h]rWh)rX}rY(hUh'}rZ(h)]r[h+]r\h-]r]h/]r^h2]r_uhjOh]r`(h)ra}rb(hXbindrch'}rd(h)]reh+]rfh-]rgh/]rhh2]riuhjXh]rjhgXbindrkrl}rm(hUhjaubah%hubhgX (rnro}rp(hUhjXubhC)rq}rr(hUh'}rs(UreftypertjU reftargetruX#Instance of int, list, tuple or strrvU refdomainrwhh/]rxh-]ryU refexplicitrzh)]r{h+]r|h2]r}uhjXh]r~cdocutils.nodes emphasis r)r}r(hjvh'}r(h)]rh+]rh-]rh/]rh2]ruhjqh]rhgX#Instance of int, list, tuple or strrr}r(hUhjubah%Uemphasisrubah%hGubhgX)r}r(hUhjXubhgX -- rr}r(hUhjXubhgX,IP Address / Port or UNIX Socket to bind to.rr}r(hX,IP Address / Port or UNIX Socket to bind to.rhjXubeh%hubah%j8ubeh%j9ubeubh)r}r(hXIThe 'bind' parameter is quite flexible with what valid values it accepts.rhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4K h5hh]rhgXIThe 'bind' parameter is quite flexible with what valid values it accepts.rr}r(hjhjubaubh)r}r(hXIf an int is passed, a TCPServer will be created. The Server will be bound to the Port given by the 'bind' argument and the bound interface will default (normally to "0.0.0.0").rhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4K h5hh]rhgXIf an int is passed, a TCPServer will be created. The Server will be bound to the Port given by the 'bind' argument and the bound interface will default (normally to "0.0.0.0").rr}r(hjhjubaubh)r}r(hXIf a list or tuple is passed, a TCPServer will be created. The Server will be bound to the Port given by the 2nd item in the 'bind' argument and the bound interface will be the 1st item.rhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgXIf a list or tuple is passed, a TCPServer will be created. The Server will be bound to the Port given by the 2nd item in the 'bind' argument and the bound interface will be the 1st item.rr}r(hjhjubaubh)r}r(hXIf a str is passed and it contains the ':' character, this is assumed to be a request to bind to an IP Address / Port. A TCpServer will thus be created and the IP Address and Port will be determined by splitting the string given by the 'bind' argument.rhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgXIf a str is passed and it contains the ':' character, this is assumed to be a request to bind to an IP Address / Port. A TCpServer will thus be created and the IP Address and Port will be determined by splitting the string given by the 'bind' argument.rr}r(hjhjubaubh)r}r(hXOtherwise if a str is passed and it does not contain the ':' character, a file path is assumed and a UNIXServer is created and bound to the file given by the 'bind' argument.rhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgXOtherwise if a str is passed and it does not contain the ':' character, a file path is assumed and a UNIXServer is created and bound to the file given by the 'bind' argument.rr}r(hjhjubaubeubeubhp)r}r(hUhhh X]/home/prologic/work/circuits/circuits/web/servers.py:docstring of circuits.web.servers.Serverrh%hth'}r(h/]rh-]rh)]rh+]rh2]rUentriesr]r(h}X&Server (class in circuits.web.servers)h Utrauh4Nh5hh]rubh)r}r(hUhhh jh%hh'}r(hhXpyrh/]rh-]rh)]rh+]rh2]rhXclassrhjuh4Nh5hh]r(h)r}r(hXServer(bind, **kwargs)rhjh jh%jh'}r(h/]rh ajh!Xcircuits.web.serversrr}rbh-]rh)]rh+]rh2]rh ajXServerrjUjuh4Nh5hh]r(j)r}r(hXclass rhjh jh%jh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXclass rr}r (hUhjubaubj#)r }r (hXcircuits.web.servers.r hjh jh%j'h'}r (h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXcircuits.web.servers.rr}r(hUhj ubaubj2)r}r(hjhjh jh%j5h'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXServerr r!}r"(hUhjubaubj@)r#}r$(hUhjh jh%jCh'}r%(h)]r&h+]r'h-]r(h/]r)h2]r*uh4Nh5hh]r+(jK)r,}r-(hXbindr.h'}r/(h)]r0h+]r1h-]r2h/]r3h2]r4uhj#h]r5hgXbindr6r7}r8(hUhj,ubah%jYubjK)r9}r:(hX**kwargsr;h'}r<(h)]r=h+]r>h-]r?h/]r@h2]rAuhj#h]rBhgX**kwargsrCrD}rE(hUhj9ubah%jYubeubeubj)rF}rG(hUhjh jh%jh'}rH(h)]rIh+]rJh-]rKh/]rLh2]rMuh4Nh5hh]rN(h)rO}rP(hX/Bases: :class:`circuits.web.servers.BaseServer`rQhjFh jh%hh'}rR(h)]rSh+]rTh-]rUh/]rVh2]rWuh4Kh5hh]rX(hgXBases: rYrZ}r[(hXBases: r\hjOubhC)r]}r^(hX(:class:`circuits.web.servers.BaseServer`r_hjOh h#h%hGh'}r`(UreftyperaXclassrbhKhLXcircuits.web.servers.BaseServerrcU refdomainrdXpyreh/]rfh-]rgU refexplicitrhh)]rih+]rjh2]rkhVhWhXjhYjuh4Kh]rlh[)rm}rn(hj_h'}ro(h)]rph+]rq(hajeXpy-classrreh-]rsh/]rth2]ruuhj]h]rvhgXcircuits.web.servers.BaseServerrwrx}ry(hUhjmubah%hkubaubeubh)rz}r{(hXCreate a Web Serverr|hjFh jh%hh'}r}(h)]r~h+]rh-]rh/]rh2]ruh4Kh5hh]rhgXCreate a Web Serverrr}r(hj|hjzubaubh)r}r(hXCreate a Web Server (HTTP) complete with the default Dispatcher to parse requests and posted form data dispatching to appropriate Controller(s).rhjFh jh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgXCreate a Web Server (HTTP) complete with the default Dispatcher to parse requests and posted form data dispatching to appropriate Controller(s).rr}r(hjhjubaubh)r}r(hX$See: circuits.web.servers.BaseServerrhjFh jh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgX$See: circuits.web.servers.BaseServerrr}r(hjhjubaubeubeubeubh)r}r(hUhhh h#h%h&h'}r(h)]rh+]rh-]rh/]rhah2]rhauh4Kh5hh]r(h7)r}r(hX Functionsrhjh h#h%h;h'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgX Functionsrr}r(hjhjubaubh)r}r(hX**none**rhjh h#h%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rh)r}r(hjh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXnonerr}r(hUhjubah%hubaubeubeubahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh5hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh;NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacer Uenvr NUdump_pseudo_xmlr NUexpose_internalsr NUsectsubtitle_xformr U source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUE/home/prologic/work/circuits/docs/source/api/circuits_web_servers.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlr Uhttp://www.python.org/dev/peps/r!Usyntax_highlightr"Ulongr#Uinput_encoding_error_handlerr$jUauto_id_prefixr%Uidr&Udoctitle_xformr'Ustrip_elements_with_classesr(NU _config_filesr)]r*Ufile_insertion_enabledr+KU raw_enabledr,KU dump_settingsr-NubUsymbol_footnote_startr.KUidsr/}r0(hhhjhjh1cdocutils.nodes target r1)r2}r3(hUhhh hsh%Utargetr4h'}r5(h)]r6h/]r7h1ah-]r8Uismodr9h+]r:h2]r;uh4Kh5hh]r<ubhhh jhhuUsubstitution_namesr=}r>h%h5h'}r?(h)]r@h/]rAh-]rBUsourcerCh#h+]rDh2]rEuU footnotesrF]rGUrefidsrH}rIub.circuits-2.1.0/docs/build/doctrees/api/circuits_node_utils.doctree0000644000014400001440000002603712113366662025137 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNXcircuits.node.utils.load_valueqXcircuits.node.utils.dump_eventqX componentsq NXcircuits.node.utils.load_eventq Xcircuits.node.utils.dump_valueq X%circuits.node.utils -- node utilitiesq NXeventsq NuUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhhhhh U componentsqh h h h h U"circuits-node-utils-node-utilitiesqh UeventsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceq UUparentq!hUsourceq"cdocutils.nodes reprunicode q#XD/home/prologic/work/circuits/docs/source/api/circuits_node_utils.rstq$q%}q&bUtagnameq'Usectionq(U attributesq)}q*(Udupnamesq+]q,Uclassesq-]q.Ubackrefsq/]q0Uidsq1]q2(Xmodule-circuits.node.utilsq3heUnamesq4]q5h auUlineq6KUdocumentq7hh]q8(cdocutils.nodes title q9)q:}q;(h X,:mod:`circuits.node.utils` -- Node Utilitiesq(h+]q?h-]q@h/]qAh1]qBh4]qCuh6Kh7hh]qD(csphinx.addnodes pending_xref qE)qF}qG(h X:mod:`circuits.node.utils`qHh!h:h"h%h'U pending_xrefqIh)}qJ(UreftypeqKXmodqLUrefwarnqMU reftargetqNXcircuits.node.utilsqOU refdomainqPXpyqQh1]qRh/]qSU refexplicitqTh+]qUh-]qVh4]qWUrefdocqXUapi/circuits_node_utilsqYUpy:classqZNU py:moduleq[Nuh6Kh]q\cdocutils.nodes literal q])q^}q_(h hHh)}q`(h+]qah-]qb(UxrefqchQXpy-modqdeh/]qeh1]qfh4]qguh!hFh]qhcdocutils.nodes Text qiXcircuits.node.utilsqjqk}ql(h Uh!h^ubah'UliteralqmubaubhiX -- Node Utilitiesqnqo}qp(h X -- Node Utilitiesqqh!h:ubeubcsphinx.addnodes index qr)qs}qt(h Uh!hh"U quh'Uindexqvh)}qw(h1]qxh/]qyh+]qzh-]q{h4]q|Uentriesq}]q~(UsingleqXcircuits.node.utils (module)Xmodule-circuits.node.utilsUtqauh6Kh7hh]qubcdocutils.nodes paragraph q)q}q(h XUtilsqh!hh"XT/home/prologic/work/circuits/circuits/node/utils.py:docstring of circuits.node.utilsqh'U paragraphqh)}q(h+]qh-]qh/]qh1]qh4]quh6Kh7hh]qhiXUtilsqq}q(h hh!hubaubh)q}q(h X...qh!hh"hh'hh)}q(h+]qh-]qh/]qh1]qh4]quh6Kh7hh]qhiX...qq}q(h hh!hubaubh)q}q(h Uh!hh"h%h'h(h)}q(h+]qh-]qh/]qh1]qhah4]qh auh6Kh7hh]q(h9)q}q(h XEventsqh!hh"h%h'h=h)}q(h+]qh-]qh/]qh1]qh4]quh6Kh7hh]qhiXEventsqq}q(h hh!hubaubh)q}q(h X**none**qh!hh"h%h'hh)}q(h+]qh-]qh/]qh1]qh4]quh6K h7hh]qcdocutils.nodes strong q)q}q(h hh)}q(h+]qh-]qh/]qh1]qh4]quh!hh]qhiXnoneqɅq}q(h Uh!hubah'Ustrongqubaubeubh)q}q(h Uh!hh"h%h'h(h)}q(h+]qh-]qh/]qh1]qhah4]qh auh6Kh7hh]q(h9)q}q(h X Componentsqh!hh"h%h'h=h)}q(h+]qh-]qh/]qh1]qh4]quh6Kh7hh]qhiX Componentsqq}q(h hh!hubaubh)q}q(h X**none**qh!hh"h%h'hh)}q(h+]qh-]qh/]qh1]qh4]quh6Kh7hh]qh)q}q(h hh)}q(h+]qh-]qh/]qh1]qh4]quh!hh]qhiXnoneqq}q(h Uh!hubah'hubaubeubh)q}q(h Uh!hh"h%h'h(h)}q(h+]qh-]qh/]qh1]qhah4]rhauh6Kh7hh]r(h9)r}r(h X Functionsrh!hh"h%h'h=h)}r(h+]rh-]rh/]rh1]r h4]r uh6Kh7hh]r hiX Functionsr r }r(h jh!jubaubhr)r}r(h Uh!hh"Nh'hvh)}r(h1]rh/]rh+]rh-]rh4]rUentriesr]r(hX,dump_event() (in module circuits.node.utils)hUtrauh6Nh7hh]rubcsphinx.addnodes desc r)r}r(h Uh!hh"Nh'Udescrh)}r(Unoindexr Udomainr!Xpyr"h1]r#h/]r$h+]r%h-]r&h4]r'Uobjtyper(Xfunctionr)Udesctyper*j)uh6Nh7hh]r+(csphinx.addnodes desc_signature r,)r-}r.(h Xdump_event(e, id)r/h!jh"U r0h'Udesc_signaturer1h)}r2(h1]r3haUmoduler4h#Xcircuits.node.utilsr5r6}r7bh/]r8h+]r9h-]r:h4]r;haUfullnamer<X dump_eventr=Uclassr>UUfirstr?uh6Nh7hh]r@(csphinx.addnodes desc_addname rA)rB}rC(h Xcircuits.node.utils.rDh!j-h"j0h'U desc_addnamerEh)}rF(h+]rGh-]rHh/]rIh1]rJh4]rKuh6Nh7hh]rLhiXcircuits.node.utils.rMrN}rO(h Uh!jBubaubcsphinx.addnodes desc_name rP)rQ}rR(h j=h!j-h"j0h'U desc_namerSh)}rT(h+]rUh-]rVh/]rWh1]rXh4]rYuh6Nh7hh]rZhiX dump_eventr[r\}r](h Uh!jQubaubcsphinx.addnodes desc_parameterlist r^)r_}r`(h Uh!j-h"j0h'Udesc_parameterlistrah)}rb(h+]rch-]rdh/]reh1]rfh4]rguh6Nh7hh]rh(csphinx.addnodes desc_parameter ri)rj}rk(h Xeh)}rl(h+]rmh-]rnh/]roh1]rph4]rquh!j_h]rrhiXers}rt(h Uh!jjubah'Udesc_parameterruubji)rv}rw(h Xidrxh)}ry(h+]rzh-]r{h/]r|h1]r}h4]r~uh!j_h]rhiXidrr}r(h Uh!jvubah'juubeubeubcsphinx.addnodes desc_content r)r}r(h Uh!jh"j0h'U desc_contentrh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rubeubhr)r}r(h Uh!hh"Nh'hvh)}r(h1]rh/]rh+]rh-]rh4]rUentriesr]r(hX,dump_value() (in module circuits.node.utils)h Utrauh6Nh7hh]rubj)r}r(h Uh!hh"Nh'jh)}r(j j!Xpyrh1]rh/]rh+]rh-]rh4]rj(Xfunctionrj*juh6Nh7hh]r(j,)r}r(h X dump_value(v)rh!jh"j0h'j1h)}r(h1]rh aj4h#Xcircuits.node.utilsrr}rbh/]rh+]rh-]rh4]rh aj<X dump_valuerj>Uj?uh6Nh7hh]r(jA)r}r(h Xcircuits.node.utils.rh!jh"j0h'jEh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiXcircuits.node.utils.rr}r(h Uh!jubaubjP)r}r(h jh!jh"j0h'jSh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiX dump_valuerr}r(h Uh!jubaubj^)r}r(h Uh!jh"j0h'jah)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rji)r}r(h Xvh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiXvr}r(h Uh!jubah'juubaubeubj)r}r(h Uh!jh"j0h'jh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rubeubhr)r}r(h Uh!hh"Nh'hvh)}r(h1]rh/]rh+]rh-]rh4]rUentriesr]r(hX,load_event() (in module circuits.node.utils)h Utrauh6Nh7hh]rubj)r}r(h Uh!hh"Nh'jh)}r(j j!Xpyrh1]rh/]rh+]rh-]rh4]rj(Xfunctionrj*juh6Nh7hh]r(j,)r}r(h X load_event(s)rh!jh"j0h'j1h)}r(h1]rh aj4h#Xcircuits.node.utilsrr}rbh/]rh+]r h-]r h4]r h aj<X load_eventr j>Uj?uh6Nh7hh]r (jA)r}r(h Xcircuits.node.utils.rh!jh"j0h'jEh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiXcircuits.node.utils.rr}r(h Uh!jubaubjP)r}r(h j h!jh"j0h'jSh)}r(h+]rh-]rh/]r h1]r!h4]r"uh6Nh7hh]r#hiX load_eventr$r%}r&(h Uh!jubaubj^)r'}r((h Uh!jh"j0h'jah)}r)(h+]r*h-]r+h/]r,h1]r-h4]r.uh6Nh7hh]r/ji)r0}r1(h Xsh)}r2(h+]r3h-]r4h/]r5h1]r6h4]r7uh!j'h]r8hiXsr9}r:(h Uh!j0ubah'juubaubeubj)r;}r<(h Uh!jh"j0h'jh)}r=(h+]r>h-]r?h/]r@h1]rAh4]rBuh6Nh7hh]rCubeubhr)rD}rE(h Uh!hh"Nh'hvh)}rF(h1]rGh/]rHh+]rIh-]rJh4]rKUentriesrL]rM(hX,load_value() (in module circuits.node.utils)hUtrNauh6Nh7hh]rOubj)rP}rQ(h Uh!hh"Nh'jh)}rR(j j!XpyrSh1]rTh/]rUh+]rVh-]rWh4]rXj(XfunctionrYj*jYuh6Nh7hh]rZ(j,)r[}r\(h X load_value(v)r]h!jPh"j0h'j1h)}r^(h1]r_haj4h#Xcircuits.node.utilsr`ra}rbbh/]rch+]rdh-]reh4]rfhaj<X load_valuergj>Uj?uh6Nh7hh]rh(jA)ri}rj(h Xcircuits.node.utils.rkh!j[h"j0h'jEh)}rl(h+]rmh-]rnh/]roh1]rph4]rquh6Nh7hh]rrhiXcircuits.node.utils.rsrt}ru(h Uh!jiubaubjP)rv}rw(h jgh!j[h"j0h'jSh)}rx(h+]ryh-]rzh/]r{h1]r|h4]r}uh6Nh7hh]r~hiX load_valuerr}r(h Uh!jvubaubj^)r}r(h Uh!j[h"j0h'jah)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rji)r}r(h Xvh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiXvr}r(h Uh!jubah'juubaubeubj)r}r(h Uh!jPh"j0h'jh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rubeubeubeubah UU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh7hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh=NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUD/home/prologic/work/circuits/docs/source/api/circuits_node_utils.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hhhj[h3cdocutils.nodes target r)r}r(h Uh!hh"huh'Utargetrh)}r(h+]rh1]r h3ah/]r Uismodr h-]r h4]r uh6Kh7hh]rubhj-hhh jh jhhhhuUsubstitution_namesr}rh'h7h)}r(h+]rh1]rh/]rUsourcerh%h-]rh4]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_dispatchers_xmlrpc.doctree0000644000014400001440000005346612113366664027535 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNX&circuits.web.dispatchers.xmlrpc.XMLRPCqX componentsqNX*circuits.web.dispatchers.xmlrpc -- xml-rpcq NX#circuits.web.dispatchers.xmlrpc.RPCq Xeventsq NuUsubstitution_defsq }q Uparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhhhU componentsqh U'circuits-web-dispatchers-xmlrpc-xml-rpcqh h h UeventsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceq cdocutils.nodes reprunicode q!XP/home/prologic/work/circuits/docs/source/api/circuits_web_dispatchers_xmlrpc.rstq"q#}q$bUtagnameq%Usectionq&U attributesq'}q((Udupnamesq)]q*Uclassesq+]q,Ubackrefsq-]q.Uidsq/]q0(X&module-circuits.web.dispatchers.xmlrpcq1heUnamesq2]q3h auUlineq4KUdocumentq5hh]q6(cdocutils.nodes title q7)q8}q9(hX1:mod:`circuits.web.dispatchers.xmlrpc` -- XML-RPCq:hhh h#h%Utitleq;h'}q<(h)]q=h+]q>h-]q?h/]q@h2]qAuh4Kh5hh]qB(csphinx.addnodes pending_xref qC)qD}qE(hX&:mod:`circuits.web.dispatchers.xmlrpc`qFhh8h h#h%U pending_xrefqGh'}qH(UreftypeqIXmodqJUrefwarnqKU reftargetqLXcircuits.web.dispatchers.xmlrpcqMU refdomainqNXpyqOh/]qPh-]qQU refexplicitqRh)]qSh+]qTh2]qUUrefdocqVU#api/circuits_web_dispatchers_xmlrpcqWUpy:classqXNU py:moduleqYNuh4Kh]qZcdocutils.nodes literal q[)q\}q](hhFh'}q^(h)]q_h+]q`(UxrefqahOXpy-modqbeh-]qch/]qdh2]qeuhhDh]qfcdocutils.nodes Text qgXcircuits.web.dispatchers.xmlrpcqhqi}qj(hUhh\ubah%UliteralqkubaubhgX -- XML-RPCqlqm}qn(hX -- XML-RPCqohh8ubeubcsphinx.addnodes index qp)qq}qr(hUhhh U qsh%Uindexqth'}qu(h/]qvh-]qwh)]qxh+]qyh2]qzUentriesq{]q|(Usingleq}X(circuits.web.dispatchers.xmlrpc (module)X&module-circuits.web.dispatchers.xmlrpcUtq~auh4Kh5hh]qubcdocutils.nodes paragraph q)q}q(hXXML RPCqhhh Xl/home/prologic/work/circuits/circuits/web/dispatchers/xmlrpc.py:docstring of circuits.web.dispatchers.xmlrpcqh%U paragraphqh'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgXXML RPCqq}q(hhhhubaubh)q}q(hXhThis module implements a XML RPC dispatcher that translates incoming RPC calls over XML into RPC events.qhhh hh%hh'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgXhThis module implements a XML RPC dispatcher that translates incoming RPC calls over XML into RPC events.qq}q(hhhhubaubh)q}q(hUhhh h#h%h&h'}q(h)]qh+]qh-]qh/]qhah2]qh auh4Kh5hh]q(h7)q}q(hXEventsqhhh h#h%h;h'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgXEventsqq}q(hhhhubaubhp)q}q(hUhhh Nh%hth'}q(h/]qh-]qh)]qh+]qh2]qUentriesq]q(h}X.RPC (class in circuits.web.dispatchers.xmlrpc)h Utqauh4Nh5hh]qubcsphinx.addnodes desc q)q}q(hUhhh Nh%Udescqh'}q(UnoindexqĉUdomainqXpyqh/]qh-]qh)]qh+]qh2]qUobjtypeqXclassqUdesctypeqhuh4Nh5hh]q(csphinx.addnodes desc_signature q)q}q(hXRPC(*args, **kwargs)qhhh U qh%Udesc_signatureqh'}q(h/]qh aUmoduleqh!Xcircuits.web.dispatchers.xmlrpcqمq}qbh-]qh)]qh+]qh2]qh aUfullnameqXRPCqUclassqUUfirstquh4Nh5hh]q(csphinx.addnodes desc_annotation q)q}q(hXclass qhhh hh%Udesc_annotationqh'}q(h)]qh+]qh-]qh/]qh2]quh4Nh5hh]qhgXclass qq}q(hUhhubaubcsphinx.addnodes desc_addname q)q}q(hX circuits.web.dispatchers.xmlrpc.qhhh hh%U desc_addnameqh'}q(h)]qh+]qh-]qh/]qh2]quh4Nh5hh]qhgX circuits.web.dispatchers.xmlrpc.rr}r(hUhhubaubcsphinx.addnodes desc_name r)r}r(hhhhh hh%U desc_namerh'}r(h)]rh+]r h-]r h/]r h2]r uh4Nh5hh]r hgXRPCrr}r(hUhjubaubcsphinx.addnodes desc_parameterlist r)r}r(hUhhh hh%Udesc_parameterlistrh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]r(csphinx.addnodes desc_parameter r)r}r(hX*argsrh'}r (h)]r!h+]r"h-]r#h/]r$h2]r%uhjh]r&hgX*argsr'r(}r)(hUhjubah%Udesc_parameterr*ubj)r+}r,(hX**kwargsr-h'}r.(h)]r/h+]r0h-]r1h/]r2h2]r3uhjh]r4hgX**kwargsr5r6}r7(hUhj+ubah%j*ubeubeubcsphinx.addnodes desc_content r8)r9}r:(hUhhh hh%U desc_contentr;h'}r<(h)]r=h+]r>h-]r?h/]r@h2]rAuh4Nh5hh]rB(h)rC}rD(hX*Bases: :class:`circuits.core.events.Event`rEhj9h U rFh%hh'}rG(h)]rHh+]rIh-]rJh/]rKh2]rLuh4Kh5hh]rM(hgXBases: rNrO}rP(hXBases: rQhjCubhC)rR}rS(hX#:class:`circuits.core.events.Event`rThjCh h#h%hGh'}rU(UreftyperVXclassrWhKhLXcircuits.core.events.EventrXU refdomainrYXpyrZh/]r[h-]r\U refexplicitr]h)]r^h+]r_h2]r`hVhWhXhhYXcircuits.web.dispatchers.xmlrpcrauh4Kh]rbh[)rc}rd(hjTh'}re(h)]rfh+]rg(hajZXpy-classrheh-]rih/]rjh2]rkuhjRh]rlhgXcircuits.core.events.Eventrmrn}ro(hUhjcubah%hkubaubeubh)rp}rq(hX RPC Eventrrhj9h Xp/home/prologic/work/circuits/circuits/web/dispatchers/xmlrpc.py:docstring of circuits.web.dispatchers.xmlrpc.RPCrsh%hh'}rt(h)]ruh+]rvh-]rwh/]rxh2]ryuh4Kh5hh]rzhgX RPC Eventr{r|}r}(hjrhjpubaubh)r~}r(hXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rhj9h jsh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rr}r(hjhj~ubaubh)r}r(hXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rhj9h jsh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rr}r(hjhjubaubh)r}r(hXEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rhj9h jsh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4K h5hh]r(hgXEvery event has a rr}r(hXEvery event has a rhjubhC)r}r(hX :attr:`name`rhjh h#h%hGh'}r(UreftyperXattrrhKhLXnamerU refdomainrXpyrh/]rh-]rU refexplicitrh)]rh+]rh2]rhVhWhXhhYjauh4Kh]rh[)r}r(hjh'}r(h)]rh+]r(hajXpy-attrreh-]rh/]rh2]ruhjh]rhgXnamerr}r(hUhjubah%hkubaubhgX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(hX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rhjubeubcdocutils.nodes field_list r)r}r(hUhj9h Nh%U field_listrh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rcdocutils.nodes field r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(cdocutils.nodes field_name r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgX Variablesrr}r(hUhjubah%U field_namerubcdocutils.nodes field_body r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rcdocutils.nodes bullet_list r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(cdocutils.nodes list_item r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rh)r}r (hUh'}r (h)]r h+]r h-]r h/]rh2]ruhjh]r(hC)r}r(hUh'}r(UreftyperUobjrU reftargetrXchannelsrU refdomainrhh/]rh-]rU refexplicitrh)]rh+]rh2]ruhjh]rcdocutils.nodes strong r )r!}r"(hjh'}r#(h)]r$h+]r%h-]r&h/]r'h2]r(uhjh]r)hgXchannelsr*r+}r,(hUhj!ubah%Ustrongr-ubah%hGubhgX -- r.r/}r0(hUhjubh)r1}r2(hXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r3hjh jsh%hh'}r4(h)]r5h+]r6h-]r7h/]r8h2]r9uh4Kh]r:hgXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r;r<}r=(hj3hj1ubaubh)r>}r?(hXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r@hjh jsh%hh'}rA(h)]rBh+]rCh-]rDh/]rEh2]rFuh4Kh]rGhgXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rHrI}rJ(hj@hj>ubaubeh%hubah%U list_itemrKubj)rL}rM(hUh'}rN(h)]rOh+]rPh-]rQh/]rRh2]rSuhjh]rTh)rU}rV(hUh'}rW(h)]rXh+]rYh-]rZh/]r[h2]r\uhjLh]r](hC)r^}r_(hUh'}r`(UreftyperajU reftargetrbXvaluercU refdomainrdhh/]reh-]rfU refexplicitrgh)]rhh+]rih2]rjuhjUh]rkj )rl}rm(hjch'}rn(h)]roh+]rph-]rqh/]rrh2]rsuhj^h]rthgXvaluerurv}rw(hUhjlubah%j-ubah%hGubhgX -- rxry}rz(hUhjUubhgX this is a r{r|}r}(hX this is a r~hjUubhC)r}r(hX#:class:`circuits.core.values.Value`rhjUh Nh%hGh'}r(UreftyperXclassrhKhLXcircuits.core.values.ValuerU refdomainrXpyrh/]rh-]rU refexplicitrh)]rh+]rh2]rhVhWhXhhYjauh4Nh]rh[)r}r(hjh'}r(h)]rh+]r(hajXpy-classreh-]rh/]rh2]ruhjh]rhgXcircuits.core.values.Valuerr}r(hUhjubah%hkubaubhgXN object that holds the results returned by the handlers invoked for the event.rr}r(hXN object that holds the results returned by the handlers invoked for the event.rhjUubeh%hubah%jKubj)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rh)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(hC)r}r(hUh'}r(UreftyperjU reftargetrXsuccessrU refdomainrhh/]rh-]rU refexplicitrh)]rh+]rh2]ruhjh]rj )r}r(hjh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXsuccessrr}r(hUhjubah%j-ubah%hGubhgX -- rr}r(hUhjubhgX%if this optional attribute is set to rr}r(hX%if this optional attribute is set to rhjubh[)r}r(hX``True``rh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXTruerr}r(hUhjubah%hkubhgX, an associated event rr}r(hX, an associated event rhjubh[)r}r(hX``EventSuccess``rh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgX EventSuccessrr}r(hUhjubah%hkubhgX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(hX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rhjubeh%hubah%jKubj)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rh)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(hC)r}r(hUh'}r (Ureftyper jU reftargetr Xsuccess_channelsr U refdomainr hh/]rh-]rU refexplicitrh)]rh+]rh2]ruhjh]rj )r}r(hj h'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXsuccess_channelsrr}r (hUhjubah%j-ubah%hGubhgX -- r!r"}r#(hUhjubhgXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r$r%}r&(hXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r'hjubeh%hubah%jKubj)r(}r)(hUh'}r*(h)]r+h+]r,h-]r-h/]r.h2]r/uhjh]r0h)r1}r2(hUh'}r3(h)]r4h+]r5h-]r6h/]r7h2]r8uhj(h]r9(hC)r:}r;(hUh'}r<(Ureftyper=jU reftargetr>Xcompleter?U refdomainr@hh/]rAh-]rBU refexplicitrCh)]rDh+]rEh2]rFuhj1h]rGj )rH}rI(hj?h'}rJ(h)]rKh+]rLh-]rMh/]rNh2]rOuhj:h]rPhgXcompleterQrR}rS(hUhjHubah%j-ubah%hGubhgX -- rTrU}rV(hUhj1ubhgX%if this optional attribute is set to rWrX}rY(hX%if this optional attribute is set to rZhj1ubh[)r[}r\(hX``True``r]h'}r^(h)]r_h+]r`h-]rah/]rbh2]rcuhj1h]rdhgXTruererf}rg(hUhj[ubah%hkubhgX, an associated event rhri}rj(hX, an associated event rkhj1ubh[)rl}rm(hX``EventComplete``rnh'}ro(h)]rph+]rqh-]rrh/]rsh2]rtuhj1h]ruhgX EventCompletervrw}rx(hUhjlubah%hkubhgX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.ryrz}r{(hX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r|hj1ubeh%hubah%jKubj)r}}r~(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rh)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhj}h]r(hC)r}r(hUh'}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrhh/]rh-]rU refexplicitrh)]rh+]rh2]ruhjh]rj )r}r(hjh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXsuccess_channelsrr}r(hUhjubah%j-ubah%hGubhgX -- rr}r(hUhjubhgXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(hXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rhjubeh%hubah%jKubeh%U bullet_listrubah%U field_bodyrubeh%Ufieldrubaubeubeubeubh)r}r(hUhhh h#h%h&h'}r(h)]rh+]rh-]rh/]rhah2]rhauh4Kh5hh]r(h7)r}r(hX Componentsrhjh h#h%h;h'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgX Componentsrr}r(hjhjubaubhp)r}r(hUhjh jFh%hth'}r(h/]rh-]rh)]rh+]rh2]rUentriesr]r(h}X1XMLRPC (class in circuits.web.dispatchers.xmlrpc)hUtrauh4Nh5hh]rubh)r}r(hUhjh jFh%hh'}r(hĉhXpyrh/]rh-]rh)]rh+]rh2]rhXclassrhjuh4Nh5hh]r(h)r}r(hX4XMLRPC(path=None, encoding='utf-8', rpc_channel='*')rhjh hh%hh'}r(h/]rhahh!Xcircuits.web.dispatchers.xmlrpcrr}rbh-]rh)]rh+]rh2]rhahXXMLRPCrhUhuh4Nh5hh]r(h)r}r(hXclass rhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXclass rr}r(hUhjubaubh)r}r(hX circuits.web.dispatchers.xmlrpc.rhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgX circuits.web.dispatchers.xmlrpc.rr}r(hUhjubaubj)r}r (hjhjh hh%jh'}r (h)]r h+]r h-]r h/]rh2]ruh4Nh5hh]rhgXXMLRPCrr}r(hUhjubaubj)r}r(hUhjh hh%jh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]r(j)r}r(hX path=Nonerh'}r (h)]r!h+]r"h-]r#h/]r$h2]r%uhjh]r&hgX path=Noner'r(}r)(hUhjubah%j*ubj)r*}r+(hXencoding='utf-8'r,h'}r-(h)]r.h+]r/h-]r0h/]r1h2]r2uhjh]r3hgXencoding='utf-8'r4r5}r6(hUhj*ubah%j*ubj)r7}r8(hXrpc_channel='*'r9h'}r:(h)]r;h+]r<h-]r=h/]r>h2]r?uhjh]r@hgXrpc_channel='*'rArB}rC(hUhj7ubah%j*ubeubeubj8)rD}rE(hUhjh hh%j;h'}rF(h)]rGh+]rHh-]rIh/]rJh2]rKuh4Nh5hh]rLh)rM}rN(hX6Bases: :class:`circuits.core.components.BaseComponent`rOhjDh jFh%hh'}rP(h)]rQh+]rRh-]rSh/]rTh2]rUuh4Kh5hh]rV(hgXBases: rWrX}rY(hXBases: rZhjMubhC)r[}r\(hX/:class:`circuits.core.components.BaseComponent`r]hjMh h#h%hGh'}r^(Ureftyper_Xclassr`hKhLX&circuits.core.components.BaseComponentraU refdomainrbXpyrch/]rdh-]reU refexplicitrfh)]rgh+]rhh2]rihVhWhXjhYjauh4Kh]rjh[)rk}rl(hj]h'}rm(h)]rnh+]ro(hajcXpy-classrpeh-]rqh/]rrh2]rsuhj[h]rthgX&circuits.core.components.BaseComponentrurv}rw(hUhjkubah%hkubaubeubaubeubeubh)rx}ry(hUhhh h#h%h&h'}rz(h)]r{h+]r|h-]r}h/]r~hah2]rhauh4Kh5hh]r(h7)r}r(hX Functionsrhjxh h#h%h;h'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgX Functionsrr}r(hjhjubaubh)r}r(hX**none**rhjxh h#h%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rj )r}r(hjh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXnonerr}r(hUhjubah%j-ubaubeubeubahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh5hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh;NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUP/home/prologic/work/circuits/docs/source/api/circuits_web_dispatchers_xmlrpc.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hjxh1cdocutils.nodes target r)r }r (hUhhh hsh%Utargetr h'}r (h)]r h/]rh1ah-]rUismodrh+]rh2]ruh4Kh5hh]rubhjhjhhh hhhuUsubstitution_namesr}rh%h5h'}r(h)]rh/]rh-]rUsourcerh#h+]rh2]ruU footnotesr]rUrefidsr}r ub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_utils.doctree0000644000014400001440000005500612113366667024772 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(Xcircuits.web.utils.parse_bodyqX functionsqNXcircuits.web.utils -- utilitiesqNXcircuits.web.utils.urlq Xcircuits.web.utils.parse_qsq Xcircuits.web.utils.dictformq X componentsq NXcircuits.web.utils.get_rangesq Xcircuits.web.utils.compressqXeventsqNuUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hhhU functionsqhUcircuits-web-utils-utilitiesqh h h h h h h U componentsqh h hhhUeventsquUchildrenq]qcdocutils.nodes section q)q }q!(U rawsourceq"UUparentq#hUsourceq$cdocutils.nodes reprunicode q%XC/home/prologic/work/circuits/docs/source/api/circuits_web_utils.rstq&q'}q(bUtagnameq)Usectionq*U attributesq+}q,(Udupnamesq-]q.Uclassesq/]q0Ubackrefsq1]q2Uidsq3]q4(Xmodule-circuits.web.utilsq5heUnamesq6]q7hauUlineq8KUdocumentq9hh]q:(cdocutils.nodes title q;)q<}q=(h"X&:mod:`circuits.web.utils` -- Utilitiesq>h#h h$h'h)Utitleq?h+}q@(h-]qAh/]qBh1]qCh3]qDh6]qEuh8Kh9hh]qF(csphinx.addnodes pending_xref qG)qH}qI(h"X:mod:`circuits.web.utils`qJh#hqwh)Uindexqxh+}qy(h3]qzh1]q{h-]q|h/]q}h6]q~Uentriesq]q(UsingleqXcircuits.web.utils (module)Xmodule-circuits.web.utilsUtqauh8Kh9hh]qubcdocutils.nodes paragraph q)q}q(h"X Utilitiesqh#h h$XR/home/prologic/work/circuits/circuits/web/utils.py:docstring of circuits.web.utilsqh)U paragraphqh+}q(h-]qh/]qh1]qh3]qh6]quh8Kh9hh]qhkX Utilitiesqq}q(h"hh#hubaubh)q}q(h"X)This module implements utility functions.qh#h h$hh)hh+}q(h-]qh/]qh1]qh3]qh6]quh8Kh9hh]qhkX)This module implements utility functions.qq}q(h"hh#hubaubh)q}q(h"Uh#h h$h'h)h*h+}q(h-]qh/]qh1]qh3]qhah6]qhauh8Kh9hh]q(h;)q}q(h"XEventsqh#hh$h'h)h?h+}q(h-]qh/]qh1]qh3]qh6]quh8Kh9hh]qhkXEventsqq}q(h"hh#hubaubh)q}q(h"X**none**qh#hh$h'h)hh+}q(h-]qh/]qh1]qh3]qh6]quh8K h9hh]qcdocutils.nodes strong q)q}q(h"hh+}q(h-]qh/]qh1]qh3]qh6]quh#hh]qhkXnoneq˅q}q(h"Uh#hubah)Ustrongqubaubeubh)q}q(h"Uh#h h$h'h)h*h+}q(h-]qh/]qh1]qh3]qhah6]qh auh8K h9hh]q(h;)q}q(h"X Componentsqh#hh$h'h)h?h+}q(h-]qh/]qh1]qh3]qh6]quh8K h9hh]qhkX Componentsq⅁q}q(h"hh#hubaubh)q}q(h"X**none**qh#hh$h'h)hh+}q(h-]qh/]qh1]qh3]qh6]quh8Kh9hh]qh)q}q(h"hh+}q(h-]qh/]qh1]qh3]qh6]quh#hh]qhkXnoneqq}q(h"Uh#hubah)hubaubeubh)q}q(h"Uh#h h$h'h)h*h+}q(h-]qh/]qh1]rh3]rhah6]rhauh8Kh9hh]r(h;)r}r(h"X Functionsrh#hh$h'h)h?h+}r(h-]rh/]r h1]r h3]r h6]r uh8Kh9hh]r hkX Functionsrr}r(h"jh#jubaubht)r}r(h"Uh#hh$X[/home/prologic/work/circuits/circuits/web/utils.py:docstring of circuits.web.utils.compressrh)hxh+}r(h3]rh1]rh-]rh/]rh6]rUentriesr]r(hX)compress() (in module circuits.web.utils)hUtrauh8Nh9hh]rubcsphinx.addnodes desc r)r}r (h"Uh#hh$jh)Udescr!h+}r"(Unoindexr#Udomainr$Xpyr%h3]r&h1]r'h-]r(h/]r)h6]r*Uobjtyper+Xfunctionr,Udesctyper-j,uh8Nh9hh]r.(csphinx.addnodes desc_signature r/)r0}r1(h"Xcompress(body, compress_level)r2h#jh$U r3h)Udesc_signaturer4h+}r5(h3]r6haUmoduler7h%Xcircuits.web.utilsr8r9}r:bh1]r;h-]r<h/]r=h6]r>haUfullnamer?Xcompressr@UclassrAUUfirstrBuh8Nh9hh]rC(csphinx.addnodes desc_addname rD)rE}rF(h"Xcircuits.web.utils.rGh#j0h$j3h)U desc_addnamerHh+}rI(h-]rJh/]rKh1]rLh3]rMh6]rNuh8Nh9hh]rOhkXcircuits.web.utils.rPrQ}rR(h"Uh#jEubaubcsphinx.addnodes desc_name rS)rT}rU(h"j@h#j0h$j3h)U desc_namerVh+}rW(h-]rXh/]rYh1]rZh3]r[h6]r\uh8Nh9hh]r]hkXcompressr^r_}r`(h"Uh#jTubaubcsphinx.addnodes desc_parameterlist ra)rb}rc(h"Uh#j0h$j3h)Udesc_parameterlistrdh+}re(h-]rfh/]rgh1]rhh3]rih6]rjuh8Nh9hh]rk(csphinx.addnodes desc_parameter rl)rm}rn(h"Xbodyroh+}rp(h-]rqh/]rrh1]rsh3]rth6]ruuh#jbh]rvhkXbodyrwrx}ry(h"Uh#jmubah)Udesc_parameterrzubjl)r{}r|(h"Xcompress_levelr}h+}r~(h-]rh/]rh1]rh3]rh6]ruh#jbh]rhkXcompress_levelrr}r(h"Uh#j{ubah)jzubeubeubcsphinx.addnodes desc_content r)r}r(h"Uh#jh$j3h)U desc_contentrh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]rh)r}r(h"X,Compress 'body' at the given compress_level.rh#jh$jh)hh+}r(h-]rh/]rh1]rh3]rh6]ruh8Kh9hh]rhkX,Compress 'body' at the given compress_level.rr}r(h"jh#jubaubaubeubht)r}r(h"Uh#hh$Nh)hxh+}r(h3]rh1]rh-]rh/]rh6]rUentriesr]r(hX)dictform() (in module circuits.web.utils)h Utrauh8Nh9hh]rubj)r}r(h"Uh#hh$Nh)j!h+}r(j#j$Xpyrh3]rh1]rh-]rh/]rh6]rj+Xfunctionrj-juh8Nh9hh]r(j/)r}r(h"Xdictform(form)rh#jh$j3h)j4h+}r(h3]rh aj7h%Xcircuits.web.utilsrr}rbh1]rh-]rh/]rh6]rh aj?XdictformrjAUjBuh8Nh9hh]r(jD)r}r(h"Xcircuits.web.utils.rh#jh$j3h)jHh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]rhkXcircuits.web.utils.rr}r(h"Uh#jubaubjS)r}r(h"jh#jh$j3h)jVh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]rhkXdictformrr}r(h"Uh#jubaubja)r}r(h"Uh#jh$j3h)jdh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]rjl)r}r(h"Xformrh+}r(h-]rh/]rh1]rh3]rh6]ruh#jh]rhkXformrr}r(h"Uh#jubah)jzubaubeubj)r}r(h"Uh#jh$j3h)jh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]rubeubht)r}r(h"Uh#hh$X]/home/prologic/work/circuits/circuits/web/utils.py:docstring of circuits.web.utils.get_rangesrh)hxh+}r(h3]rh1]rh-]rh/]rh6]rUentriesr]r(hX+get_ranges() (in module circuits.web.utils)h Utrauh8Nh9hh]r ubj)r }r (h"Uh#hh$jh)j!h+}r (j#j$Xpyr h3]rh1]rh-]rh/]rh6]rj+Xfunctionrj-juh8Nh9hh]r(j/)r}r(h"X'get_ranges(headervalue, content_length)rh#j h$j3h)j4h+}r(h3]rh aj7h%Xcircuits.web.utilsrr}rbh1]rh-]rh/]rh6]r h aj?X get_rangesr!jAUjBuh8Nh9hh]r"(jD)r#}r$(h"Xcircuits.web.utils.r%h#jh$j3h)jHh+}r&(h-]r'h/]r(h1]r)h3]r*h6]r+uh8Nh9hh]r,hkXcircuits.web.utils.r-r.}r/(h"Uh#j#ubaubjS)r0}r1(h"j!h#jh$j3h)jVh+}r2(h-]r3h/]r4h1]r5h3]r6h6]r7uh8Nh9hh]r8hkX get_rangesr9r:}r;(h"Uh#j0ubaubja)r<}r=(h"Uh#jh$j3h)jdh+}r>(h-]r?h/]r@h1]rAh3]rBh6]rCuh8Nh9hh]rD(jl)rE}rF(h"X headervaluerGh+}rH(h-]rIh/]rJh1]rKh3]rLh6]rMuh#j<h]rNhkX headervaluerOrP}rQ(h"Uh#jEubah)jzubjl)rR}rS(h"Xcontent_lengthrTh+}rU(h-]rVh/]rWh1]rXh3]rYh6]rZuh#j<h]r[hkXcontent_lengthr\r]}r^(h"Uh#jRubah)jzubeubeubj)r_}r`(h"Uh#j h$j3h)jh+}ra(h-]rbh/]rch1]rdh3]reh6]rfuh8Nh9hh]rg(h)rh}ri(h"XDReturn a list of (start, stop) indices from a Range header, or None.rjh#j_h$jh)hh+}rk(h-]rlh/]rmh1]rnh3]roh6]rpuh8Kh9hh]rqhkXDReturn a list of (start, stop) indices from a Range header, or None.rrrs}rt(h"jjh#jhubaubh)ru}rv(h"XEach (start, stop) tuple will be composed of two ints, which are suitable for use in a slicing operation. That is, the header "Range: bytes=3-6", if applied against a Python string, is requesting resource[3:7]. This function will return the list [(3, 7)].rwh#j_h$jh)hh+}rx(h-]ryh/]rzh1]r{h3]r|h6]r}uh8Kh9hh]r~hkXEach (start, stop) tuple will be composed of two ints, which are suitable for use in a slicing operation. That is, the header "Range: bytes=3-6", if applied against a Python string, is requesting resource[3:7]. This function will return the list [(3, 7)].rr}r(h"jwh#juubaubh)r}r(h"XCIf this function returns an empty list, you should return HTTP 416.rh#j_h$jh)hh+}r(h-]rh/]rh1]rh3]rh6]ruh8Kh9hh]rhkXCIf this function returns an empty list, you should return HTTP 416.rr}r(h"jh#jubaubeubeubht)r}r(h"Uh#hh$Nh)hxh+}r(h3]rh1]rh-]rh/]rh6]rUentriesr]r(hX+parse_body() (in module circuits.web.utils)hUtrauh8Nh9hh]rubj)r}r(h"Uh#hh$Nh)j!h+}r(j#j$Xpyrh3]rh1]rh-]rh/]rh6]rj+Xfunctionrj-juh8Nh9hh]r(j/)r}r(h"X%parse_body(request, response, params)rh#jh$j3h)j4h+}r(h3]rhaj7h%Xcircuits.web.utilsrr}rbh1]rh-]rh/]rh6]rhaj?X parse_bodyrjAUjBuh8Nh9hh]r(jD)r}r(h"Xcircuits.web.utils.rh#jh$j3h)jHh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]rhkXcircuits.web.utils.rr}r(h"Uh#jubaubjS)r}r(h"jh#jh$j3h)jVh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]rhkX parse_bodyrr}r(h"Uh#jubaubja)r}r(h"Uh#jh$j3h)jdh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]r(jl)r}r(h"Xrequestrh+}r(h-]rh/]rh1]rh3]rh6]ruh#jh]rhkXrequestrr}r(h"Uh#jubah)jzubjl)r}r(h"Xresponserh+}r(h-]rh/]rh1]rh3]rh6]ruh#jh]rhkXresponserr}r(h"Uh#jubah)jzubjl)r}r(h"Xparamsrh+}r(h-]rh/]rh1]rh3]rh6]ruh#jh]rhkXparamsrr}r(h"Uh#jubah)jzubeubeubj)r}r(h"Uh#jh$j3h)jh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]rubeubht)r}r(h"Uh#hh$X[/home/prologic/work/circuits/circuits/web/utils.py:docstring of circuits.web.utils.parse_qsrh)hxh+}r (h3]r h1]r h-]r h/]r h6]rUentriesr]r(hX)parse_qs() (in module circuits.web.utils)h Utrauh8Nh9hh]rubj)r}r(h"Uh#hh$jh)j!h+}r(j#j$Xpyrh3]rh1]rh-]rh/]rh6]rj+Xfunctionrj-juh8Nh9hh]r(j/)r}r(h"Xparse_qs(query_string) -> dictr h#jh$j3h)j4h+}r!(h3]r"h aj7h%Xcircuits.web.utilsr#r$}r%bh1]r&h-]r'h/]r(h6]r)h aj?Xparse_qsr*jAUjBuh8Nh9hh]r+(jD)r,}r-(h"Xcircuits.web.utils.r.h#jh$j3h)jHh+}r/(h-]r0h/]r1h1]r2h3]r3h6]r4uh8Nh9hh]r5hkXcircuits.web.utils.r6r7}r8(h"Uh#j,ubaubjS)r9}r:(h"j*h#jh$j3h)jVh+}r;(h-]r<h/]r=h1]r>h3]r?h6]r@uh8Nh9hh]rAhkXparse_qsrBrC}rD(h"Uh#j9ubaubja)rE}rF(h"Uh#jh$j3h)jdh+}rG(h-]rHh/]rIh1]rJh3]rKh6]rLuh8Nh9hh]rMjl)rN}rO(h"X query_stringrPh+}rQ(h-]rRh/]rSh1]rTh3]rUh6]rVuh#jEh]rWhkX query_stringrXrY}rZ(h"Uh#jNubah)jzubaubcsphinx.addnodes desc_returns r[)r\}r](h"Xdictr^h#jh$j3h)U desc_returnsr_h+}r`(h-]rah/]rbh1]rch3]rdh6]reuh8Nh9hh]rfhkXdictrgrh}ri(h"Uh#j\ubaubeubj)rj}rk(h"Uh#jh$j3h)jh+}rl(h-]rmh/]rnh1]roh3]rph6]rquh8Nh9hh]rrh)rs}rt(h"XvBuild a params dictionary from a query_string. If keep_blank_values is True (the default), keep values that are blank.ruh#jjh$jh)hh+}rv(h-]rwh/]rxh1]ryh3]rzh6]r{uh8Kh9hh]r|hkXvBuild a params dictionary from a query_string. If keep_blank_values is True (the default), keep values that are blank.r}r~}r(h"juh#jsubaubaubeubht)r}r(h"Uh#hh$XV/home/prologic/work/circuits/circuits/web/utils.py:docstring of circuits.web.utils.urlrh)hxh+}r(h3]rh1]rh-]rh/]rh6]rUentriesr]r(hX$url() (in module circuits.web.utils)h Utrauh8Nh9hh]rubj)r}r(h"Uh#hh$jh)j!h+}r(j#j$Xpyrh3]rh1]rh-]rh/]rh6]rj+Xfunctionrj-juh8Nh9hh]r(j/)r}r(h"XHurl(request, path='', qs='', script_name=None, base=None, relative=None)rh#jh$j3h)j4h+}r(h3]rh aj7h%Xcircuits.web.utilsrr}rbh1]rh-]rh/]rh6]rh aj?XurlrjAUjBuh8Nh9hh]r(jD)r}r(h"Xcircuits.web.utils.rh#jh$j3h)jHh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]rhkXcircuits.web.utils.rr}r(h"Uh#jubaubjS)r}r(h"jh#jh$j3h)jVh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]rhkXurlrr}r(h"Uh#jubaubja)r}r(h"Uh#jh$j3h)jdh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]r(jl)r}r(h"Xrequestrh+}r(h-]rh/]rh1]rh3]rh6]ruh#jh]rhkXrequestrr}r(h"Uh#jubah)jzubjl)r}r(h"Xpath=''rh+}r(h-]rh/]rh1]rh3]rh6]ruh#jh]rhkXpath=''rr}r(h"Uh#jubah)jzubjl)r}r(h"Xqs=''rh+}r(h-]rh/]rh1]rh3]rh6]ruh#jh]rhkXqs=''rr}r(h"Uh#jubah)jzubjl)r}r(h"Xscript_name=Nonerh+}r(h-]rh/]rh1]rh3]rh6]ruh#jh]rhkXscript_name=Nonerr}r(h"Uh#jubah)jzubjl)r}r(h"X base=Nonerh+}r(h-]rh/]rh1]rh3]rh6]ruh#jh]rhkX base=Nonerr}r(h"Uh#jubah)jzubjl)r }r (h"X relative=Noner h+}r (h-]r h/]rh1]rh3]rh6]ruh#jh]rhkX relative=Nonerr}r(h"Uh#j ubah)jzubeubeubj)r}r(h"Uh#jh$j3h)jh+}r(h-]rh/]rh1]rh3]rh6]ruh8Nh9hh]r(h)r}r (h"X*Create an absolute URL for the given path.r!h#jh$jh)hh+}r"(h-]r#h/]r$h1]r%h3]r&h6]r'uh8Kh9hh]r(hkX*Create an absolute URL for the given path.r)r*}r+(h"j!h#jubaubcdocutils.nodes definition_list r,)r-}r.(h"Uh#jh$Nh)Udefinition_listr/h+}r0(h-]r1h/]r2h1]r3h3]r4h6]r5uh8Nh9hh]r6(cdocutils.nodes definition_list_item r7)r8}r9(h"XYIf 'path' starts with a slash ('/'), this will return - (base + script_name + path + qs).r:h#j-h$jh)Udefinition_list_itemr;h+}r<(h-]r=h/]r>h1]r?h3]r@h6]rAuh8Kh]rB(cdocutils.nodes term rC)rD}rE(h"X5If 'path' starts with a slash ('/'), this will returnrFh#j8h$jh)UtermrGh+}rH(h-]rIh/]rJh1]rKh3]rLh6]rMuh8Kh]rNhkX5If 'path' starts with a slash ('/'), this will returnrOrP}rQ(h"X5If 'path' starts with a slash ('/'), this will returnrRh#jDubaubcdocutils.nodes definition rS)rT}rU(h"Uh+}rV(h-]rWh/]rXh1]rYh3]rZh6]r[uh#j8h]r\cdocutils.nodes bullet_list r])r^}r_(h"Uh+}r`(UbulletraX-h3]rbh1]rch-]rdh/]reh6]rfuh#jTh]rgcdocutils.nodes list_item rh)ri}rj(h"X!(base + script_name + path + qs).rkh+}rl(h-]rmh/]rnh1]roh3]rph6]rquh#j^h]rrh)rs}rt(h"jkh#jih$jh)hh+}ru(h-]rvh/]rwh1]rxh3]ryh6]rzuh8Kh]r{hkX!(base + script_name + path + qs).r|r}}r~(h"jkh#jsubaubah)U list_itemrubah)U bullet_listrubah)U definitionrubeubj7)r}r(h"XeIf it does not start with a slash, this returns - (base + script_name [+ request.path] + path + qs). rh#j-h$jh)j;h+}r(h-]rh/]rh1]rh3]rh6]ruh8Kh9hh]r(jC)r}r(h"X/If it does not start with a slash, this returnsrh#jh$jh)jGh+}r(h-]rh/]rh1]rh3]rh6]ruh8Kh]rhkX/If it does not start with a slash, this returnsrr}r(h"X/If it does not start with a slash, this returnsrh#jubaubjS)r}r(h"Uh+}r(h-]rh/]rh1]rh3]rh6]ruh#jh]rj])r}r(h"Uh+}r(jaX-h3]rh1]rh-]rh/]rh6]ruh#jh]rjh)r}r(h"X3(base + script_name [+ request.path] + path + qs). rh+}r(h-]rh/]rh1]rh3]rh6]ruh#jh]rh)r}r(h"X2(base + script_name [+ request.path] + path + qs).rh#jh$jh)hh+}r(h-]rh/]rh1]rh3]rh6]ruh8Kh]rhkX2(base + script_name [+ request.path] + path + qs).rr}r(h"jh#jubaubah)jubah)jubah)jubeubeubh)r}r(h"XQIf script_name is None, request will be used to find a script_name, if available.rh#jh$jh)hh+}r(h-]rh/]rh1]rh3]rh6]ruh8Kh9hh]rhkXQIf script_name is None, request will be used to find a script_name, if available.rr}r(h"jh#jubaubh)r}r(h"X:If base is None, request.base will be used (if available).rh#jh$jh)hh+}r(h-]rh/]rh1]rh3]rh6]ruh8K h9hh]rhkX:If base is None, request.base will be used (if available).rr}r(h"jh#jubaubh)r}r(h"XFinally, note that this function can be used to obtain an absolute URL for the current request path (minus the querystring) by passing no args. If you call url(qs=request.qs), you should get the original browser URL (assuming no internal redirections).rh#jh$jh)hh+}r(h-]rh/]rh1]rh3]rh6]ruh8K h9hh]rhkXFinally, note that this function can be used to obtain an absolute URL for the current request path (minus the querystring) by passing no args. If you call url(qs=request.qs), you should get the original browser URL (assuming no internal redirections).rr}r(h"jh#jubaubh)r}r(h"XoIf relative is False the output will be an absolute URL (including the scheme, host, vhost, and script_name). If True, the output will instead be a URL that is relative to the current request path, perhaps including '..' atoms. If relative is the string 'server', the output will instead be a URL that is relative to the server root; i.e., it will start with a slash.rh#jh$jh)hh+}r(h-]rh/]rh1]rh3]rh6]ruh8Kh9hh]rhkXoIf relative is False the output will be an absolute URL (including the scheme, host, vhost, and script_name). If True, the output will instead be a URL that is relative to the current request path, perhaps including '..' atoms. If relative is the string 'server', the output will instead be a URL that is relative to the server root; i.e., it will start with a slash.rr}r(h"jh#jubaubeubeubeubeubah"UU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh9hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr ]r U citation_refsr }r Uindirect_targetsr ]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationr NU halt_levelr!KU strip_classesr"Nh?NUerror_encoding_error_handlerr#Ubackslashreplacer$Udebugr%NUembed_stylesheetr&Uoutput_encoding_error_handlerr'Ustrictr(U sectnum_xformr)KUdump_transformsr*NU docinfo_xformr+KUwarning_streamr,NUpep_file_url_templater-Upep-%04dr.Uexit_status_levelr/KUconfigr0NUstrict_visitorr1NUcloak_email_addressesr2Utrim_footnote_reference_spacer3Uenvr4NUdump_pseudo_xmlr5NUexpose_internalsr6NUsectsubtitle_xformr7U source_linkr8NUrfc_referencesr9NUoutput_encodingr:Uutf-8r;U source_urlr<NUinput_encodingr=U utf-8-sigr>U_disable_configr?NU id_prefixr@UU tab_widthrAKUerror_encodingrBU ISO-8859-1rCU_sourcerDUC/home/prologic/work/circuits/docs/source/api/circuits_web_utils.rstrEUgettext_compactrFU generatorrGNUdump_internalsrHNU smart_quotesrIU pep_base_urlrJUhttp://www.python.org/dev/peps/rKUsyntax_highlightrLUlongrMUinput_encoding_error_handlerrNj(Uauto_id_prefixrOUidrPUdoctitle_xformrQUstrip_elements_with_classesrRNU _config_filesrS]rTUfile_insertion_enabledrUKU raw_enabledrVKU dump_settingsrWNubUsymbol_footnote_startrXKUidsrY}rZ(hjhhh jhh h jh jhhh jh5cdocutils.nodes target r[)r\}r](h"Uh#h h$hwh)Utargetr^h+}r_(h-]r`h3]rah5ah1]rbUismodrch/]rdh6]reuh8Kh9hh]rfubhj0hhuUsubstitution_namesrg}rhh)h9h+}ri(h-]rjh3]rkh1]rlUsourcermh'h/]rnh6]rouU footnotesrp]rqUrefidsrr}rsub.circuits-2.1.0/docs/build/doctrees/api/circuits_net_protocols.doctree0000644000014400001440000001117312113366660025655 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qX.circuits.net.protocols -- networking protocolsqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhU+circuits-net-protocols-networking-protocolsqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qXG/home/prologic/work/circuits/docs/source/api/circuits_net_protocols.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q((Xmodule-circuits.net.protocolsq)heUnamesq*]q+hauUlineq,KUdocumentq-hh]q.(cdocutils.nodes title q/)q0}q1(hX5:mod:`circuits.net.protocols` -- Networking Protocolsq2hhhhhUtitleq3h}q4(h!]q5h#]q6h%]q7h']q8h*]q9uh,Kh-hh]q:(csphinx.addnodes pending_xref q;)q<}q=(hX:mod:`circuits.net.protocols`q>hh0hhhU pending_xrefq?h}q@(UreftypeqAXmodqBUrefwarnqCU reftargetqDXcircuits.net.protocolsqEU refdomainqFXpyqGh']qHh%]qIU refexplicitqJh!]qKh#]qLh*]qMUrefdocqNUapi/circuits_net_protocolsqOUpy:classqPNU py:moduleqQNuh,Kh]qRcdocutils.nodes literal qS)qT}qU(hh>h}qV(h!]qWh#]qX(UxrefqYhGXpy-modqZeh%]q[h']q\h*]q]uhhqkhUindexqlh}qm(h']qnh%]qoh!]qph#]qqh*]qrUentriesqs]qt(UsinglequXcircuits.net.protocols (module)Xmodule-circuits.net.protocolsUtqvauh,Kh-hh]qwubcdocutils.nodes paragraph qx)qy}qz(hXNetworking Protocolsq{hhhXc/home/prologic/work/circuits/circuits/net/protocols/__init__.py:docstring of circuits.net.protocolsq|hU paragraphq}h}q~(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_XNetworking Protocolsqq}q(hh{hhyubaubhx)q}q(hXMThis package contains components that implement various networking protocols.qhhhh|hh}h}q(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_XMThis package contains components that implement various networking protocols.qq}q(hhhhubaubcdocutils.nodes compound q)q}q(hUhhhhhUcompoundqh}q(h!]qh#]qUtoctree-wrapperqah%]qh']qh*]quh,Nh-hh]qcsphinx.addnodes toctree q)q}q(hUhhhhhUtoctreeqh}q(UnumberedqKhhOU titlesonlyqUglobqh']qh%]qh!]qh#]qh*]qUentriesq]q(NUapi/circuits_net_protocols_httpqqNUapi/circuits_net_protocols_ircqqNUapi/circuits_net_protocols_lineqqeUhiddenqU includefilesq]q(hhheUmaxdepthqKuh,Kh]qubaubeubahUU transformerqNU footnote_refsq}qUrefnamesq}qUsymbol_footnotesq]qUautofootnote_refsq]qUsymbol_footnote_refsq]qU citationsq]qh-hU current_lineqNUtransform_messagesq]qUreporterqNUid_startqKU autofootnotesq]qU citation_refsq}qUindirect_targetsq]qUsettingsq(cdocutils.frontend Values qoq}q(Ufootnote_backlinksqKUrecord_dependenciesqNU rfc_base_urlqUhttp://tools.ietf.org/html/qU tracebackqۈUpep_referencesqNUstrip_commentsqNU toc_backlinksqUentryqU language_codeqUenqU datestampqNU report_levelqKU _destinationqNU halt_levelqKU strip_classesqNh3NUerror_encoding_error_handlerqUbackslashreplaceqUdebugqNUembed_stylesheetqUoutput_encoding_error_handlerqUstrictqU sectnum_xformqKUdump_transformsqNU docinfo_xformqKUwarning_streamqNUpep_file_url_templateqUpep-%04dqUexit_status_levelqKUconfigqNUstrict_visitorqNUcloak_email_addressesqUtrim_footnote_reference_spaceqUenvqNUdump_pseudo_xmlqNUexpose_internalsqNUsectsubtitle_xformqU source_linkqNUrfc_referencesqNUoutput_encodingqUutf-8qU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUG/home/prologic/work/circuits/docs/source/api/circuits_net_protocols.rstr Ugettext_compactr U generatorr NUdump_internalsr NU smart_quotesr U pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrhUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hhh)cdocutils.nodes target r)r }r!(hUhhhhkhUtargetr"h}r#(h!]r$h']r%h)ah%]r&Uismodr'h#]r(h*]r)uh,Kh-hh]r*ubuUsubstitution_namesr+}r,hh-h}r-(h!]r.h']r/h%]r0Usourcer1hh#]r2h*]r3uU footnotesr4]r5Urefidsr6}r7ub.circuits-2.1.0/docs/build/doctrees/api/circuits_core_values.doctree0000644000014400001440000003523012113366657025300 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNXcircuits.core.values -- valueqNXclassesqNX componentsq NXcircuits.core.values.Valueq Xeventsq NuUsubstitution_defsq }q Uparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhUcircuits-core-values-valueqhUclassesqh U componentsqh h h UeventsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentq hUsourceq!cdocutils.nodes reprunicode q"XE/home/prologic/work/circuits/docs/source/api/circuits_core_values.rstq#q$}q%bUtagnameq&Usectionq'U attributesq(}q)(Udupnamesq*]q+Uclassesq,]q-Ubackrefsq.]q/Uidsq0]q1(Xmodule-circuits.core.valuesq2heUnamesq3]q4hauUlineq5KUdocumentq6hh]q7(cdocutils.nodes title q8)q9}q:(hX$:mod:`circuits.core.values` -- Valueq;h hh!h$h&Utitleqh,]q?h.]q@h0]qAh3]qBuh5Kh6hh]qC(csphinx.addnodes pending_xref qD)qE}qF(hX:mod:`circuits.core.values`qGh h9h!h$h&U pending_xrefqHh(}qI(UreftypeqJXmodqKUrefwarnqLU reftargetqMXcircuits.core.valuesqNU refdomainqOXpyqPh0]qQh.]qRU refexplicitqSh*]qTh,]qUh3]qVUrefdocqWUapi/circuits_core_valuesqXUpy:classqYNU py:moduleqZNuh5Kh]q[cdocutils.nodes literal q\)q]}q^(hhGh(}q_(h*]q`h,]qa(UxrefqbhPXpy-modqceh.]qdh0]qeh3]qfuh hEh]qgcdocutils.nodes Text qhXcircuits.core.valuesqiqj}qk(hUh h]ubah&UliteralqlubaubhhX -- Valueqmqn}qo(hX -- Valueqph h9ubeubcsphinx.addnodes index qq)qr}qs(hUh hh!U qth&Uindexquh(}qv(h0]qwh.]qxh*]qyh,]qzh3]q{Uentriesq|]q}(Usingleq~Xcircuits.core.values (module)Xmodule-circuits.core.valuesUtqauh5Kh6hh]qubcdocutils.nodes paragraph q)q}q(hX<This defines the Value object used by components and events.qh hh!XV/home/prologic/work/circuits/circuits/core/values.py:docstring of circuits.core.valuesqh&U paragraphqh(}q(h*]qh,]qh.]qh0]qh3]quh5Kh6hh]qhhX<This defines the Value object used by components and events.qq}q(hhh hubaubh)q}q(hUh hh!h$h&h'h(}q(h*]qh,]qh.]qh0]qhah3]qhauh5Kh6hh]q(h8)q}q(hXClassesqh hh!h$h&hqh&Udesc_signatureqh(}q(h0]qh aUmoduleqh"Xcircuits.core.valuesq΅q}qbh.]qh*]qh,]qh3]qh aUfullnameqXValueqUclassqUUfirstq؉uh5Nh6hh]q(csphinx.addnodes desc_annotation q)q}q(hXclass qh hh!hh&Udesc_annotationqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]qhhXclass q慁q}q(hUh hubaubcsphinx.addnodes desc_addname q)q}q(hXcircuits.core.values.qh hh!hh&U desc_addnameqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]qhhXcircuits.core.values.qq}q(hUh hubaubcsphinx.addnodes desc_name q)q}q(hhh hh!hh&U desc_nameqh(}q(h*]qh,]qh.]qh0]rh3]ruh5Nh6hh]rhhXValuerr}r(hUh hubaubcsphinx.addnodes desc_parameterlist r)r}r(hUh hh!hh&Udesc_parameterlistr h(}r (h*]r h,]r h.]r h0]rh3]ruh5Nh6hh]r(csphinx.addnodes desc_parameter r)r}r(hX event=Nonerh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX event=Nonerr}r(hUh jubah&Udesc_parameterrubj)r }r!(hX manager=Noner"h(}r#(h*]r$h,]r%h.]r&h0]r'h3]r(uh jh]r)hhX manager=Noner*r+}r,(hUh j ubah&jubeubeubcsphinx.addnodes desc_content r-)r.}r/(hUh hh!hh&U desc_contentr0h(}r1(h*]r2h,]r3h.]r4h0]r5h3]r6uh5Nh6hh]r7(h)r8}r9(hXBases: :class:`object`r:h j.h!U r;h&hh(}r<(h*]r=h,]r>h.]r?h0]r@h3]rAuh5Kh6hh]rB(hhXBases: rCrD}rE(hXBases: rFh j8ubhD)rG}rH(hX:class:`object`rIh j8h!h$h&hHh(}rJ(UreftyperKXclassrLhLhMXobjectrMU refdomainrNXpyrOh0]rPh.]rQU refexplicitrRh*]rSh,]rTh3]rUhWhXhYhhZXcircuits.core.valuesrVuh5Kh]rWh\)rX}rY(hjIh(}rZ(h*]r[h,]r\(hbjOXpy-classr]eh.]r^h0]r_h3]r`uh jGh]rahhXobjectrbrc}rd(hUh jXubah&hlubaubeubh)re}rf(hX Create a new future Value Objectrgh j.h!hh&hh(}rh(h*]rih,]rjh.]rkh0]rlh3]rmuh5Kh6hh]rnhhX Create a new future Value Objectrorp}rq(hjgh jeubaubh)rr}rs(hXCreates a new future Value Object which is used by Event Objects and the Manager to store the result(s) of an Event Handler's exeuction of some Event in the system.rth j.h!hh&hh(}ru(h*]rvh,]rwh.]rxh0]ryh3]rzuh5Kh6hh]r{hhXCreates a new future Value Object which is used by Event Objects and the Manager to store the result(s) of an Event Handler's exeuction of some Event in the system.r|r}}r~(hjth jrubaubcdocutils.nodes field_list r)r}r(hUh j.h!hh&U field_listrh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]r(cdocutils.nodes field r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(cdocutils.nodes field_name r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX Parametersrr}r(hUh jubah&U field_namerubcdocutils.nodes field_body r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rcdocutils.nodes bullet_list r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(cdocutils.nodes list_item r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rh)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(cdocutils.nodes strong r)r}r(hXeventrh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXeventrr}r(hUh jubah&UstrongrubhhX (rr}r(hUh jubhD)r}r(hUh(}r(UreftyperUobjrU reftargetrXEvent instancerU refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rcdocutils.nodes emphasis r)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXEvent instancerr}r(hUh jubah&Uemphasisrubah&hHubhhX)r}r(hUh jubhhX -- rr}r(hUh jubhhX(The Event this Value is associated with.rr}r(hX(The Event this Value is associated with.rh jubeh&hubah&U list_itemrubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]r uh jh]r h)r }r (hUh(}r (h*]rh,]rh.]rh0]rh3]ruh jh]r(j)r}r(hXmanagerrh(}r(h*]rh,]rh.]rh0]rh3]ruh j h]rhhXmanagerrr}r (hUh jubah&jubhhX (r!r"}r#(hUh j ubhD)r$}r%(hUh(}r&(Ureftyper'jU reftargetr(XA Manager/Component instance.r)U refdomainr*hh0]r+h.]r,U refexplicitr-h*]r.h,]r/h3]r0uh j h]r1j)r2}r3(hj)h(}r4(h*]r5h,]r6h.]r7h0]r8h3]r9uh j$h]r:hhXA Manager/Component instance.r;r<}r=(hUh j2ubah&jubah&hHubhhX)r>}r?(hUh j ubhhX -- r@rA}rB(hUh j ubhhX4The Manager/Component used to trigger notifications.rCrD}rE(hX4The Manager/Component used to trigger notifications.rFh j ubeh&hubah&jubeh&U bullet_listrGubah&U field_bodyrHubeh&UfieldrIubj)rJ}rK(hUh(}rL(h*]rMh,]rNh.]rOh0]rPh3]rQuh jh]rR(j)rS}rT(hUh(}rU(h*]rVh,]rWh.]rXh0]rYh3]rZuh jJh]r[hhX Variablesr\r]}r^(hUh jSubah&jubj)r_}r`(hUh(}ra(h*]rbh,]rch.]rdh0]reh3]rfuh jJh]rgj)rh}ri(hUh(}rj(h*]rkh,]rlh.]rmh0]rnh3]rouh j_h]rp(j)rq}rr(hUh(}rs(h*]rth,]ruh.]rvh0]rwh3]rxuh jhh]ryh)rz}r{(hUh(}r|(h*]r}h,]r~h.]rh0]rh3]ruh jqh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXresultrU refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jzh]rj)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXresultrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jzubhhX$True if this value has been changed.rr}r(hX$True if this value has been changed.rh jzubeh&hubah&jubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jhh]rh)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXerrorsrU refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXerrorsrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhX6True if while setting this value an exception occured.rr}r(hX6True if while setting this value an exception occured.rh jubeh&hubah&jubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jhh]rh)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXnotifyrU refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXnotifyrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhX9True or an event name to notify of changes to this valuerr}r(hX9True or an event name to notify of changes to this valuer h jubeh&hubah&jubeh&jGubah&jHubeh&jIubeubh)r }r (hX(This is a Future/Promise implementation.r h j.h!hh&hh(}r (h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]rhhX(This is a Future/Promise implementation.rr}r(hj h j ubaubeubeubeubh)r}r(hUh hh!h$h&h'h(}r(h*]rh,]rh.]rh0]rhah3]rh auh5Kh6hh]r(h8)r }r!(hX Componentsr"h jh!h$h&huh j-h]r?hhXnoner@rA}rB(hUh j7ubah&jubaubeubh)rC}rD(hUh hh!h$h&h'h(}rE(h*]rFh,]rGh.]rHh0]rIhah3]rJh auh5Kh6hh]rK(h8)rL}rM(hXEventsrNh jCh!h$h&hh,]q?h.]q@h0]qAh3]qBuh5Kh6hh]qC(csphinx.addnodes pending_xref qD)qE}qF(hX:mod:`circuits.app.config`qGh h9h!h$h&U pending_xrefqHh(}qI(UreftypeqJXmodqKUrefwarnqLU reftargetqMXcircuits.app.configqNU refdomainqOXpyqPh0]qQh.]qRU refexplicitqSh*]qTh,]qUh3]qVUrefdocqWUapi/circuits_app_configqXUpy:classqYNU py:moduleqZNuh5Kh]q[cdocutils.nodes literal q\)q]}q^(hhGh(}q_(h*]q`h,]qa(UxrefqbhPXpy-modqceh.]qdh0]qeh3]qfuh hEh]qgcdocutils.nodes Text qhXcircuits.app.configqiqj}qk(hUh h]ubah&UliteralqlubaubhhX -- Application Configqmqn}qo(hX -- Application Configqph h9ubeubcsphinx.addnodes index qq)qr}qs(hUh hh!h$h&Uindexqth(}qu(h0]qvh.]qwh*]qxh,]qyh3]qzUentriesq{]q|(Usingleq}Xcircuits.app.config (module)Xmodule-circuits.app.configUtq~auh5Kh6hh]qubh)q}q(hUh hh!h$h&h'h(}q(h*]qh,]qh.]qh0]qhah3]qh auh5Kh6hh]q(h8)q}q(hXEventsqh hh!h$h&hqh&Udesc_signatureqh(}q(h0]qhaUmoduleqh"Xcircuits.app.configqq}qbh.]qh*]qh,]qh3]qhaUfullnameqXLoadqUclassqUUfirstqƉuh5Nh6hh]q(csphinx.addnodes desc_annotation q)q}q(hXclass qh hh!hh&Udesc_annotationqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]qhhXclass qԅq}q(hUh hubaubcsphinx.addnodes desc_addname q)q}q(hXcircuits.app.config.qh hh!hh&U desc_addnameqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]qhhXcircuits.app.config.qㅁq}q(hUh hubaubcsphinx.addnodes desc_name q)q}q(hhh hh!hh&U desc_nameqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]qhhXLoadqq}q(hUh hubaubcsphinx.addnodes desc_parameterlist q)q}q(hUh hh!hh&Udesc_parameterlistqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]q(csphinx.addnodes desc_parameter q)r}r(hX*argsrh(}r(h*]rh,]rh.]rh0]rh3]ruh hh]r hhX*argsr r }r (hUh jubah&Udesc_parameterr ubh)r}r(hX**kwargsrh(}r(h*]rh,]rh.]rh0]rh3]ruh hh]rhhX**kwargsrr}r(hUh jubah&j ubeubeubcsphinx.addnodes desc_content r)r}r(hUh hh!hh&U desc_contentrh(}r(h*]r h,]r!h.]r"h0]r#h3]r$uh5Nh6hh]r%(cdocutils.nodes paragraph r&)r'}r((hX/Bases: :class:`circuits.app.config.ConfigEvent`r)h jh!U r*h&U paragraphr+h(}r,(h*]r-h,]r.h.]r/h0]r0h3]r1uh5Kh6hh]r2(hhXBases: r3r4}r5(hXBases: r6h j'ubhD)r7}r8(hX(:class:`circuits.app.config.ConfigEvent`r9h j'h!h$h&hHh(}r:(Ureftyper;Xclassr<hLhMXcircuits.app.config.ConfigEventr=U refdomainr>Xpyr?h0]r@h.]rAU refexplicitrBh*]rCh,]rDh3]rEhWhXhYhhZXcircuits.app.configrFuh5Kh]rGh\)rH}rI(hj9h(}rJ(h*]rKh,]rL(hbj?Xpy-classrMeh.]rNh0]rOh3]rPuh j7h]rQhhXcircuits.app.config.ConfigEventrRrS}rT(hUh jHubah&hlubaubeubj&)rU}rV(hXLoad Config EventrWh jh!XY/home/prologic/work/circuits/circuits/app/config.py:docstring of circuits.app.config.LoadrXh&j+h(}rY(h*]rZh,]r[h.]r\h0]r]h3]r^uh5Kh6hh]r_hhXLoad Config Eventr`ra}rb(hjWh jUubaubj&)rc}rd(hXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.reh jh!jXh&j+h(}rf(h*]rgh,]rhh.]rih0]rjh3]rkuh5Kh6hh]rlhhXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rmrn}ro(hjeh jcubaubj&)rp}rq(hXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rrh jh!jXh&j+h(}rs(h*]rth,]ruh.]rvh0]rwh3]rxuh5Kh6hh]ryhhXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rzr{}r|(hjrh jpubaubj&)r}}r~(hXEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh jh!jXh&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5K h6hh]r(hhXEvery event has a rr}r(hXEvery event has a rh j}ubhD)r}r(hX :attr:`name`rh j}h!h$h&hHh(}r(UreftyperXattrrhLhMXnamerU refdomainrXpyrh0]rh.]rU refexplicitrh*]rh,]rh3]rhWhXhYhhZjFuh5Kh]rh\)r}r(hjh(}r(h*]rh,]r(hbjXpy-attrreh.]rh0]rh3]ruh jh]rhhXnamerr}r(hUh jubah&hlubaubhhX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(hX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh j}ubeubcdocutils.nodes field_list r)r}r(hUh jh!Nh&U field_listrh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rcdocutils.nodes field r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(cdocutils.nodes field_name r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX Variablesrr}r(hUh jubah&U field_namerubcdocutils.nodes field_body r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rcdocutils.nodes bullet_list r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(cdocutils.nodes list_item r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperUobjrU reftargetrXchannelsrU refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rcdocutils.nodes strong r)r}r(hjh(}r(h*]r h,]r h.]r h0]r h3]r uh jh]rhhXchannelsrr}r(hUh jubah&Ustrongrubah&hHubhhX -- rr}r(hUh jubj&)r}r(hXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rh jh!jXh&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh]rhhXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r r!}r"(hjh jubaubj&)r#}r$(hXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r%h jh!jXh&j+h(}r&(h*]r'h,]r(h.]r)h0]r*h3]r+uh5Kh]r,hhXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r-r.}r/(hj%h j#ubaubeh&j+ubah&U list_itemr0ubj)r1}r2(hUh(}r3(h*]r4h,]r5h.]r6h0]r7h3]r8uh jh]r9j&)r:}r;(hUh(}r<(h*]r=h,]r>h.]r?h0]r@h3]rAuh j1h]rB(hD)rC}rD(hUh(}rE(UreftyperFjU reftargetrGXvaluerHU refdomainrIhh0]rJh.]rKU refexplicitrLh*]rMh,]rNh3]rOuh j:h]rPj)rQ}rR(hjHh(}rS(h*]rTh,]rUh.]rVh0]rWh3]rXuh jCh]rYhhXvaluerZr[}r\(hUh jQubah&jubah&hHubhhX -- r]r^}r_(hUh j:ubhhX this is a r`ra}rb(hX this is a rch j:ubhD)rd}re(hX#:class:`circuits.core.values.Value`rfh j:h!Nh&hHh(}rg(UreftyperhXclassrihLhMXcircuits.core.values.ValuerjU refdomainrkXpyrlh0]rmh.]rnU refexplicitroh*]rph,]rqh3]rrhWhXhYhhZjFuh5Nh]rsh\)rt}ru(hjfh(}rv(h*]rwh,]rx(hbjlXpy-classryeh.]rzh0]r{h3]r|uh jdh]r}hhXcircuits.core.values.Valuer~r}r(hUh jtubah&hlubaubhhXN object that holds the results returned by the handlers invoked for the event.rr}r(hXN object that holds the results returned by the handlers invoked for the event.rh j:ubeh&j+ubah&j0ubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXsuccessrU refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXsuccessrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhX%if this optional attribute is set to rr}r(hX%if this optional attribute is set to rh jubh\)r}r(hX``True``rh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXTruerr}r(hUh jubah&hlubhhX, an associated event rr}r(hX, an associated event rh jubh\)r}r(hX``EventSuccess``rh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX EventSuccessrr}r(hUh jubah&hlubhhX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(hX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh jubeh&j+ubah&j0ubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXsuccess_channelsrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r r }r (hXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r h jubeh&j+ubah&j0ubj)r }r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh j h]r(hD)r}r (hUh(}r!(Ureftyper"jU reftargetr#Xcompleter$U refdomainr%hh0]r&h.]r'U refexplicitr(h*]r)h,]r*h3]r+uh jh]r,j)r-}r.(hj$h(}r/(h*]r0h,]r1h.]r2h0]r3h3]r4uh jh]r5hhXcompleter6r7}r8(hUh j-ubah&jubah&hHubhhX -- r9r:}r;(hUh jubhhX%if this optional attribute is set to r<r=}r>(hX%if this optional attribute is set to r?h jubh\)r@}rA(hX``True``rBh(}rC(h*]rDh,]rEh.]rFh0]rGh3]rHuh jh]rIhhXTruerJrK}rL(hUh j@ubah&hlubhhX, an associated event rMrN}rO(hX, an associated event rPh jubh\)rQ}rR(hX``EventComplete``rSh(}rT(h*]rUh,]rVh.]rWh0]rXh3]rYuh jh]rZhhX EventCompleter[r\}r](hUh jQubah&hlubhhX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r^r_}r`(hX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rah jubeh&j+ubah&j0ubj)rb}rc(hUh(}rd(h*]reh,]rfh.]rgh0]rhh3]riuh jh]rjj&)rk}rl(hUh(}rm(h*]rnh,]roh.]rph0]rqh3]rruh jbh]rs(hD)rt}ru(hUh(}rv(UreftyperwjU reftargetrxXsuccess_channelsryU refdomainrzhh0]r{h.]r|U refexplicitr}h*]r~h,]rh3]ruh jkh]rj)r}r(hjyh(}r(h*]rh,]rh.]rh0]rh3]ruh jth]rhhXsuccess_channelsrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jkubhhXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(hXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh jkubeh&j+ubah&j0ubeh&U bullet_listrubah&U field_bodyrubeh&Ufieldrubaubeubeubhq)r}r(hUh hh!Nh&hth(}r(h0]rh.]rh*]rh,]rh3]rUentriesr]r(h}X#Save (class in circuits.app.config)h Utrauh5Nh6hh]rubh)r}r(hUh hh!Nh&hh(}r(hhXpyrh0]rh.]rh*]rh,]rh3]rhXclassrhjuh5Nh6hh]r(h)r}r(hXSave(*args, **kwargs)rh jh!hh&hh(}r(h0]rh ahh"Xcircuits.app.configrr}rbh.]rh*]rh,]rh3]rh ahXSaverhUhƉuh5Nh6hh]r(h)r}r(hXclass rh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rhhXclass rr}r(hUh jubaubh)r}r(hXcircuits.app.config.rh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rhhXcircuits.app.config.rr}r(hUh jubaubh)r}r(hjh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rhhXSaverr}r(hUh jubaubh)r}r(hUh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]r(h)r}r(hX*argsrh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX*argsrr}r(hUh jubah&j ubh)r}r(hX**kwargsrh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX**kwargsrr}r(hUh jubah&j ubeubeubj)r}r(hUh jh!hh&jh(}r(h*]r h,]r h.]r h0]r h3]r uh5Nh6hh]r(j&)r}r(hX/Bases: :class:`circuits.app.config.ConfigEvent`rh jh!j*h&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]r(hhXBases: rr}r(hXBases: rh jubhD)r}r(hX(:class:`circuits.app.config.ConfigEvent`rh jh!h$h&hHh(}r (Ureftyper!Xclassr"hLhMXcircuits.app.config.ConfigEventr#U refdomainr$Xpyr%h0]r&h.]r'U refexplicitr(h*]r)h,]r*h3]r+hWhXhYjhZjFuh5Kh]r,h\)r-}r.(hjh(}r/(h*]r0h,]r1(hbj%Xpy-classr2eh.]r3h0]r4h3]r5uh jh]r6hhXcircuits.app.config.ConfigEventr7r8}r9(hUh j-ubah&hlubaubeubj&)r:}r;(hXSave Config Eventr<h jh!XY/home/prologic/work/circuits/circuits/app/config.py:docstring of circuits.app.config.Saver=h&j+h(}r>(h*]r?h,]r@h.]rAh0]rBh3]rCuh5Kh6hh]rDhhXSave Config EventrErF}rG(hj<h j:ubaubj&)rH}rI(hXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rJh jh!j=h&j+h(}rK(h*]rLh,]rMh.]rNh0]rOh3]rPuh5Kh6hh]rQhhXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rRrS}rT(hjJh jHubaubj&)rU}rV(hXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rWh jh!j=h&j+h(}rX(h*]rYh,]rZh.]r[h0]r\h3]r]uh5Kh6hh]r^hhXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.r_r`}ra(hjWh jUubaubj&)rb}rc(hXEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rdh jh!j=h&j+h(}re(h*]rfh,]rgh.]rhh0]rih3]rjuh5K h6hh]rk(hhXEvery event has a rlrm}rn(hXEvery event has a roh jbubhD)rp}rq(hX :attr:`name`rrh jbh!h$h&hHh(}rs(UreftypertXattrruhLhMXnamervU refdomainrwXpyrxh0]ryh.]rzU refexplicitr{h*]r|h,]r}h3]r~hWhXhYjhZjFuh5Kh]rh\)r}r(hjrh(}r(h*]rh,]r(hbjxXpy-attrreh.]rh0]rh3]ruh jph]rhhXnamerr}r(hUh jubah&hlubaubhhX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(hX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh jbubeubj)r}r(hUh jh!Nh&jh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(j)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX Variablesrr}r(hUh jubah&jubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(j)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXchannelsrU refdomainrjh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXchannelsrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubj&)r}r(hXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rh jh!j=h&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh]rhhXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rr}r(hjh jubaubj&)r}r(hXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rh jh!j=h&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh]rhhXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rr}r (hjh jubaubeh&j+ubah&j0ubj)r }r (hUh(}r (h*]r h,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh j h]r(hD)r}r(hUh(}r(UreftyperjU reftargetr Xvaluer!U refdomainr"jh0]r#h.]r$U refexplicitr%h*]r&h,]r'h3]r(uh jh]r)j)r*}r+(hj!h(}r,(h*]r-h,]r.h.]r/h0]r0h3]r1uh jh]r2hhXvaluer3r4}r5(hUh j*ubah&jubah&hHubhhX -- r6r7}r8(hUh jubhhX this is a r9r:}r;(hX this is a r<h jubhD)r=}r>(hX#:class:`circuits.core.values.Value`r?h jh!Nh&hHh(}r@(UreftyperAXclassrBhLhMXcircuits.core.values.ValuerCU refdomainrDXpyrEh0]rFh.]rGU refexplicitrHh*]rIh,]rJh3]rKhWhXhYjhZjFuh5Nh]rLh\)rM}rN(hj?h(}rO(h*]rPh,]rQ(hbjEXpy-classrReh.]rSh0]rTh3]rUuh j=h]rVhhXcircuits.core.values.ValuerWrX}rY(hUh jMubah&hlubaubhhXN object that holds the results returned by the handlers invoked for the event.rZr[}r\(hXN object that holds the results returned by the handlers invoked for the event.r]h jubeh&j+ubah&j0ubj)r^}r_(hUh(}r`(h*]rah,]rbh.]rch0]rdh3]reuh jh]rfj&)rg}rh(hUh(}ri(h*]rjh,]rkh.]rlh0]rmh3]rnuh j^h]ro(hD)rp}rq(hUh(}rr(UreftypersjU reftargetrtXsuccessruU refdomainrvjh0]rwh.]rxU refexplicitryh*]rzh,]r{h3]r|uh jgh]r}j)r~}r(hjuh(}r(h*]rh,]rh.]rh0]rh3]ruh jph]rhhXsuccessrr}r(hUh j~ubah&jubah&hHubhhX -- rr}r(hUh jgubhhX%if this optional attribute is set to rr}r(hX%if this optional attribute is set to rh jgubh\)r}r(hX``True``rh(}r(h*]rh,]rh.]rh0]rh3]ruh jgh]rhhXTruerr}r(hUh jubah&hlubhhX, an associated event rr}r(hX, an associated event rh jgubh\)r}r(hX``EventSuccess``rh(}r(h*]rh,]rh.]rh0]rh3]ruh jgh]rhhX EventSuccessrr}r(hUh jubah&hlubhhX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(hX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh jgubeh&j+ubah&j0ubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrjh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXsuccess_channelsrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(hXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh jubeh&j+ubah&j0ubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXcompleterU refdomainrjh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]r h,]r h.]r h0]r h3]r uh jh]rhhXcompleterr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhX%if this optional attribute is set to rr}r(hX%if this optional attribute is set to rh jubh\)r}r(hX``True``rh(}r(h*]rh,]rh.]rh0]r h3]r!uh jh]r"hhXTruer#r$}r%(hUh jubah&hlubhhX, an associated event r&r'}r((hX, an associated event r)h jubh\)r*}r+(hX``EventComplete``r,h(}r-(h*]r.h,]r/h.]r0h0]r1h3]r2uh jh]r3hhX EventCompleter4r5}r6(hUh j*ubah&hlubhhX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r7r8}r9(hX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r:h jubeh&j+ubah&j0ubj)r;}r<(hUh(}r=(h*]r>h,]r?h.]r@h0]rAh3]rBuh jh]rCj&)rD}rE(hUh(}rF(h*]rGh,]rHh.]rIh0]rJh3]rKuh j;h]rL(hD)rM}rN(hUh(}rO(UreftyperPjU reftargetrQXsuccess_channelsrRU refdomainrSjh0]rTh.]rUU refexplicitrVh*]rWh,]rXh3]rYuh jDh]rZj)r[}r\(hjRh(}r](h*]r^h,]r_h.]r`h0]rah3]rbuh jMh]rchhXsuccess_channelsrdre}rf(hUh j[ubah&jubah&hHubhhX -- rgrh}ri(hUh jDubhhXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rjrk}rl(hXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rmh jDubeh&j+ubah&j0ubeh&jubah&jubeh&jubaubeubeubeubh)rn}ro(hUh hh!h$h&h'h(}rp(h*]rqh,]rrh.]rsh0]rthah3]ruh auh5Kh6hh]rv(h8)rw}rx(hX Componentsryh jnh!h$h&hh j3h!h$h&hh j<ubaubaubeubahUU transformerrINU footnote_refsrJ}rKUrefnamesrL}rMUsymbol_footnotesrN]rOUautofootnote_refsrP]rQUsymbol_footnote_refsrR]rSU citationsrT]rUh6hU current_linerVNUtransform_messagesrW]rXUreporterrYNUid_startrZKU autofootnotesr[]r\U citation_refsr]}r^Uindirect_targetsr_]r`Usettingsra(cdocutils.frontend Values rborc}rd(Ufootnote_backlinksreKUrecord_dependenciesrfNU rfc_base_urlrgUhttp://tools.ietf.org/html/rhU tracebackriUpep_referencesrjNUstrip_commentsrkNU toc_backlinksrlUentryrmU language_codernUenroU datestamprpNU report_levelrqKU _destinationrrNU halt_levelrsKU strip_classesrtNhh,]q?h.]q@h0]qAh3]qBuh5Kh6hh]qC(csphinx.addnodes pending_xref qD)qE}qF(hX!:mod:`circuits.net.protocols.irc`qGh h9h!h$h&U pending_xrefqHh(}qI(UreftypeqJXmodqKUrefwarnqLU reftargetqMXcircuits.net.protocols.ircqNU refdomainqOXpyqPh0]qQh.]qRU refexplicitqSh*]qTh,]qUh3]qVUrefdocqWUapi/circuits_net_protocols_ircqXUpy:classqYNU py:moduleqZNuh5Kh]q[cdocutils.nodes literal q\)q]}q^(hhGh(}q_(h*]q`h,]qa(UxrefqbhPXpy-modqceh.]qdh0]qeh3]qfuh hEh]qgcdocutils.nodes Text qhXcircuits.net.protocols.ircqiqj}qk(hUh h]ubah&UliteralqlubaubhhX -- IRC Protocolqmqn}qo(hX -- IRC Protocolqph h9ubeubcsphinx.addnodes index qq)qr}qs(hUh hh!h$h&Uindexqth(}qu(h0]qvh.]qwh*]qxh,]qyh3]qzUentriesq{]q|(Usingleq}X#circuits.net.protocols.irc (module)X!module-circuits.net.protocols.ircUtq~auh5Kh6hh]qubh)q}q(hUh hh!h$h&h'h(}q(h*]qh,]qh.]qh0]qhah3]qh auh5Kh6hh]q(h8)q}q(hXEventsqh hh!h$h&hqh&Udesc_signatureqh(}q(h0]qhaUmoduleqh"Xcircuits.net.protocols.ircqq}qbh.]qh*]qh,]qh3]qhaUfullnameqXRAWqUclassqUUfirstqljuh5Nh6hh]q(csphinx.addnodes desc_annotation q)q}q(hXclass qh hh!hh&Udesc_annotationqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]qhhXclass qՅq}q(hUh hubaubcsphinx.addnodes desc_addname q)q}q(hXcircuits.net.protocols.irc.qh hh!hh&U desc_addnameqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]qhhXcircuits.net.protocols.irc.q䅁q}q(hUh hubaubcsphinx.addnodes desc_name q)q}q(hhh hh!hh&U desc_nameqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]qhhXRAWqq}q(hUh hubaubcsphinx.addnodes desc_parameterlist q)q}q(hUh hh!hh&Udesc_parameterlistqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]q(csphinx.addnodes desc_parameter r)r}r(hX*argsrh(}r(h*]rh,]rh.]rh0]rh3]r uh hh]r hhX*argsr r }r (hUh jubah&Udesc_parameterrubj)r}r(hX**kwargsrh(}r(h*]rh,]rh.]rh0]rh3]ruh hh]rhhX**kwargsrr}r(hUh jubah&jubeubeubcsphinx.addnodes desc_content r)r}r(hUh hh!hh&U desc_contentrh(}r (h*]r!h,]r"h.]r#h0]r$h3]r%uh5Nh6hh]r&(cdocutils.nodes paragraph r')r(}r)(hX2Bases: :class:`circuits.net.protocols.irc.Command`r*h jh!U r+h&U paragraphr,h(}r-(h*]r.h,]r/h.]r0h0]r1h3]r2uh5Kh6hh]r3(hhXBases: r4r5}r6(hXBases: r7h j(ubhD)r8}r9(hX+:class:`circuits.net.protocols.irc.Command`r:h j(h!h$h&hHh(}r;(Ureftyper<Xclassr=hLhMX"circuits.net.protocols.irc.Commandr>U refdomainr?Xpyr@h0]rAh.]rBU refexplicitrCh*]rDh,]rEh3]rFhWhXhYhhZXcircuits.net.protocols.ircrGuh5Kh]rHh\)rI}rJ(hj:h(}rK(h*]rLh,]rM(hbj@Xpy-classrNeh.]rOh0]rPh3]rQuh j8h]rRhhX"circuits.net.protocols.irc.CommandrSrT}rU(hUh jIubah&hlubaubeubj')rV}rW(hX RAW commandrXh jh!hh&j,h(}rY(h*]rZh,]r[h.]r\h0]r]h3]r^uh5Kh6hh]r_hhX RAW commandr`ra}rb(hjXh jVubaubeubeubeubh)rc}rd(hUh hh!h$h&h'h(}re(h*]rfh,]rgh.]rhh0]rihah3]rjh auh5K h6hh]rk(h8)rl}rm(hX Componentsrnh jch!h$h&hr9h&Udefinition_listr:h(}r;(h*]r<h,]r=h.]r>h0]r?h3]r@uh5Nh6hh]rAcdocutils.nodes definition_list_item rB)rC}rD(hXr@note: This Component must be used in conjunction with a Component that exposes Read Events on a "read" Channel. rEh j7h!jh&Udefinition_list_itemrFh(}rG(h*]rHh,]rIh.]rJh0]rKh3]rLuh5K h]rM(cdocutils.nodes term rN)rO}rP(hXG@note: This Component must be used in conjunction with a Component thatrQh jCh!jh&UtermrRh(}rS(h*]rTh,]rUh.]rVh0]rWh3]rXuh5K h]rYhhXG@note: This Component must be used in conjunction with a Component thatrZr[}r\(hXG@note: This Component must be used in conjunction with a Component thatr]h jOubaubcdocutils.nodes definition r^)r_}r`(hUh(}ra(h*]rbh,]rch.]rdh0]reh3]rfuh jCh]rgj')rh}ri(hX(exposes Read Events on a "read" Channel.rjh j_h!jh&j,h(}rk(h*]rlh,]rmh.]rnh0]roh3]rpuh5K h]rqhhX(exposes Read Events on a "read" Channel.rrrs}rt(hjjh jhubaubah&U definitionruubeubaubhq)rv}rw(hUh jh!Xk/home/prologic/work/circuits/circuits/net/protocols/irc.py:docstring of circuits.net.protocols.irc.IRC.linerxh&hth(}ry(h0]rzh.]r{h*]r|h,]r}h3]r~Uentriesr]r(h}X.line() (circuits.net.protocols.irc.IRC method)h Utrauh5Nh6hh]rubh)r}r(hUh jh!jxh&hh(}r(hhXpyrh0]rh.]rh*]rh,]rh3]rhXmethodrhjuh5Nh6hh]r(h)r}r(hXIRC.line(line)rh jh!hh&hh(}r(h0]rh ahh"Xcircuits.net.protocols.ircrr}rbh.]rh*]rh,]rh3]rh ahXIRC.linerhjhljuh5Nh6hh]r(h)r}r(hXlinerh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rhhXlinerr}r(hUh jubaubh)r}r(hUh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rj)r}r(hXlinerh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXlinerr}r(hUh jubah&jubaubeubj)r}r(hUh jh!hh&jh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]r(j')r}r(hXLine Event Handlerrh jh!jxh&j,h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]rhhXLine Event Handlerrr}r(hjh jubaubj')r}r(hXProcess a line of text and generate the appropiate event. This must not be overridden by sub-classes, if it is, this must be explitetly called by the sub-class. Other Components may however listen to this event and process custom IRC events.rh jh!jxh&j,h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]rhhXProcess a line of text and generate the appropiate event. This must not be overridden by sub-classes, if it is, this must be explitetly called by the sub-class. Other Components may however listen to this event and process custom IRC events.rr}r(hjh jubaubeubeubeubeubeubh)r}r(hUh hh!h$h&h'h(}r(h*]rh,]rh.]rh0]rhah3]rhauh5Kh6hh]rh8)r}r(hX Functionsrh jh!h$h&hU utf-8-sigr?U_disable_configr@NU id_prefixrAUU tab_widthrBKUerror_encodingrCU ISO-8859-1rDU_sourcerEUK/home/prologic/work/circuits/docs/source/api/circuits_net_protocols_irc.rstrFUgettext_compactrGU generatorrHNUdump_internalsrINU smart_quotesrJU pep_base_urlrKUhttp://www.python.org/dev/peps/rLUsyntax_highlightrMUlongrNUinput_encoding_error_handlerrOj)Uauto_id_prefixrPUidrQUdoctitle_xformrRUstrip_elements_with_classesrSNU _config_filesrT]rUUfile_insertion_enabledrVKU raw_enabledrWKU dump_settingsrXNubUsymbol_footnote_startrYKUidsrZ}r[(hhhhh2cdocutils.nodes target r\)r]}r^(hUh hh!h$h&Utargetr_h(}r`(h*]rah0]rbh2ah.]rcUismodrdh,]reh3]rfuh5Kh6hh]rgubhjh jhjch jhhuUsubstitution_namesrh}rih&h6h(}rj(h*]rkh0]rlh.]rmUsourcernh$h,]roh3]rpuU footnotesrq]rrUrefidsrs}rtub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_errors.doctree0000644000014400001440000006045112113366664025143 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNX componentsqNXcircuits.web.errors.RedirectqXcircuits.web.errors.Forbiddenq Xcircuits.web.errors.NotFoundq X circuits.web.errors.Unauthorizedq Xcircuits.web.errors.HTTPErrorq Xcircuits.web.errors -- errorsq NXeventsqNuUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhU componentsqhhh h h h h h h h h Ucircuits-web-errors-errorsqhUeventsquUchildrenq]qcdocutils.nodes section q)q}q (U rawsourceq!UUparentq"hUsourceq#cdocutils.nodes reprunicode q$XD/home/prologic/work/circuits/docs/source/api/circuits_web_errors.rstq%q&}q'bUtagnameq(Usectionq)U attributesq*}q+(Udupnamesq,]q-Uclassesq.]q/Ubackrefsq0]q1Uidsq2]q3(Xmodule-circuits.web.errorsq4heUnamesq5]q6h auUlineq7KUdocumentq8hh]q9(cdocutils.nodes title q:)q;}q<(h!X$:mod:`circuits.web.errors` -- Errorsq=h"hh#h&h(Utitleq>h*}q?(h,]q@h.]qAh0]qBh2]qCh5]qDuh7Kh8hh]qE(csphinx.addnodes pending_xref qF)qG}qH(h!X:mod:`circuits.web.errors`qIh"h;h#h&h(U pending_xrefqJh*}qK(UreftypeqLXmodqMUrefwarnqNU reftargetqOXcircuits.web.errorsqPU refdomainqQXpyqRh2]qSh0]qTU refexplicitqUh,]qVh.]qWh5]qXUrefdocqYUapi/circuits_web_errorsqZUpy:classq[NU py:moduleq\Nuh7Kh]q]cdocutils.nodes literal q^)q_}q`(h!hIh*}qa(h,]qbh.]qc(UxrefqdhRXpy-modqeeh0]qfh2]qgh5]qhuh"hGh]qicdocutils.nodes Text qjXcircuits.web.errorsqkql}qm(h!Uh"h_ubah(UliteralqnubaubhjX -- Errorsqoqp}qq(h!X -- Errorsqrh"h;ubeubcsphinx.addnodes index qs)qt}qu(h!Uh"hh#U qvh(Uindexqwh*}qx(h2]qyh0]qzh,]q{h.]q|h5]q}Uentriesq~]q(UsingleqXcircuits.web.errors (module)Xmodule-circuits.web.errorsUtqauh7Kh8hh]qubcdocutils.nodes paragraph q)q}q(h!XErrorsqh"hh#XT/home/prologic/work/circuits/circuits/web/errors.py:docstring of circuits.web.errorsqh(U paragraphqh*}q(h,]qh.]qh0]qh2]qh5]quh7Kh8hh]qhjXErrorsqq}q(h!hh"hubaubh)q}q(h!X5This module implements a set of standard HTTP Errors.qh"hh#hh(hh*}q(h,]qh.]qh0]qh2]qh5]quh7Kh8hh]qhjX5This module implements a set of standard HTTP Errors.qq}q(h!hh"hubaubh)q}q(h!Uh"hh#h&h(h)h*}q(h,]qh.]qh0]qh2]qhah5]qhauh7Kh8hh]q(h:)q}q(h!X Componentsqh"hh#h&h(h>h*}q(h,]qh.]qh0]qh2]qh5]quh7Kh8hh]qhjX Componentsqq}q(h!hh"hubaubh)q}q(h!X**none**qh"hh#h&h(hh*}q(h,]qh.]qh0]qh2]qh5]quh7K h8hh]qcdocutils.nodes strong q)q}q(h!hh*}q(h,]qh.]qh0]qh2]qh5]quh"hh]qhjXnoneqʅq}q(h!Uh"hubah(Ustrongqubaubeubh)q}q(h!Uh"hh#h&h(h)h*}q(h,]qh.]qh0]qh2]qhah5]qhauh7Kh8hh]q(h:)q}q(h!XEventsqh"hh#h&h(h>h*}q(h,]qh.]qh0]qh2]qh5]quh7Kh8hh]qhjXEventsqᅁq}q(h!hh"hubaubhs)q}q(h!Uh"hh#X^/home/prologic/work/circuits/circuits/web/errors.py:docstring of circuits.web.errors.HTTPErrorqh(hwh*}q(h2]qh0]qh,]qh.]qh5]qUentriesq]q(hX(HTTPError (class in circuits.web.errors)h Utqauh7Nh8hh]qubcsphinx.addnodes desc q)q}q(h!Uh"hh#hh(Udescqh*}q(UnoindexqUdomainqXpyqh2]qh0]qh,]qh.]qh5]qUobjtypeqXclassqUdesctyperhuh7Nh8hh]r(csphinx.addnodes desc_signature r)r}r(h!X1HTTPError(request, response, code=None, **kwargs)rh"hh#U rh(Udesc_signaturerh*}r(h2]r h aUmoduler h$Xcircuits.web.errorsr r }r bh0]rh,]rh.]rh5]rh aUfullnamerX HTTPErrorrUclassrUUfirstruh7Nh8hh]r(csphinx.addnodes desc_annotation r)r}r(h!Xclass rh"jh#jh(Udesc_annotationrh*}r(h,]rh.]rh0]rh2]r h5]r!uh7Nh8hh]r"hjXclass r#r$}r%(h!Uh"jubaubcsphinx.addnodes desc_addname r&)r'}r((h!Xcircuits.web.errors.r)h"jh#jh(U desc_addnamer*h*}r+(h,]r,h.]r-h0]r.h2]r/h5]r0uh7Nh8hh]r1hjXcircuits.web.errors.r2r3}r4(h!Uh"j'ubaubcsphinx.addnodes desc_name r5)r6}r7(h!jh"jh#jh(U desc_namer8h*}r9(h,]r:h.]r;h0]r<h2]r=h5]r>uh7Nh8hh]r?hjX HTTPErrorr@rA}rB(h!Uh"j6ubaubcsphinx.addnodes desc_parameterlist rC)rD}rE(h!Uh"jh#jh(Udesc_parameterlistrFh*}rG(h,]rHh.]rIh0]rJh2]rKh5]rLuh7Nh8hh]rM(csphinx.addnodes desc_parameter rN)rO}rP(h!XrequestrQh*}rR(h,]rSh.]rTh0]rUh2]rVh5]rWuh"jDh]rXhjXrequestrYrZ}r[(h!Uh"jOubah(Udesc_parameterr\ubjN)r]}r^(h!Xresponser_h*}r`(h,]rah.]rbh0]rch2]rdh5]reuh"jDh]rfhjXresponsergrh}ri(h!Uh"j]ubah(j\ubjN)rj}rk(h!X code=Nonerlh*}rm(h,]rnh.]roh0]rph2]rqh5]rruh"jDh]rshjX code=Nonertru}rv(h!Uh"jjubah(j\ubjN)rw}rx(h!X**kwargsryh*}rz(h,]r{h.]r|h0]r}h2]r~h5]ruh"jDh]rhjX**kwargsrr}r(h!Uh"jwubah(j\ubeubeubcsphinx.addnodes desc_content r)r}r(h!Uh"hh#jh(U desc_contentrh*}r(h,]rh.]rh0]rh2]rh5]ruh7Nh8hh]r(h)r}r(h!X*Bases: :class:`circuits.core.events.Event`rh"jh#U rh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7Kh8hh]r(hjXBases: rr}r(h!XBases: rh"jubhF)r}r(h!X#:class:`circuits.core.events.Event`rh"jh#h&h(hJh*}r(UreftyperXclassrhNhOXcircuits.core.events.EventrU refdomainrXpyrh2]rh0]rU refexplicitrh,]rh.]rh5]rhYhZh[jh\Xcircuits.web.errorsruh7Kh]rh^)r}r(h!jh*}r(h,]rh.]r(hdjXpy-classreh0]rh2]rh5]ruh"jh]rhjXcircuits.core.events.Eventrr}r(h!Uh"jubah(hnubaubeubh)r}r(h!X$An event for signaling an HTTP errorrh"jh#hh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7Kh8hh]rhjX$An event for signaling an HTTP errorrr}r(h!jh"jubaubh)r}r(h!XaThe constructor creates a new instance and modifies the *response* argument to reflect the error.rh"jh#hh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7Kh8hh]r(hjX8The constructor creates a new instance and modifies the rr}r(h!X8The constructor creates a new instance and modifies the rh"jubcdocutils.nodes emphasis r)r}r(h!X *response*rh*}r(h,]rh.]rh0]rh2]rh5]ruh"jh]rhjXresponserr}r(h!Uh"jubah(UemphasisrubhjX argument to reflect the error.rr}r(h!X argument to reflect the error.rh"jubeubeubeubhs)r}r(h!Uh"hh#X^/home/prologic/work/circuits/circuits/web/errors.py:docstring of circuits.web.errors.Forbiddenrh(hwh*}r(h2]rh0]rh,]rh.]rh5]rUentriesr]r(hX(Forbidden (class in circuits.web.errors)h Utrauh7Nh8hh]rubh)r}r(h!Uh"hh#jh(hh*}r(hhXpyrh2]rh0]rh,]rh.]rh5]rhXclassrjjuh7Nh8hh]r(j)r}r(h!X1Forbidden(request, response, code=None, **kwargs)rh"jh#jh(jh*}r(h2]rh aj h$Xcircuits.web.errorsrr}r bh0]r h,]r h.]r h5]r h ajX ForbiddenrjUjuh7Nh8hh]r(j)r}r(h!Xclass rh"jh#jh(jh*}r(h,]rh.]rh0]rh2]rh5]ruh7Nh8hh]rhjXclass rr}r(h!Uh"jubaubj&)r}r(h!Xcircuits.web.errors.rh"jh#jh(j*h*}r (h,]r!h.]r"h0]r#h2]r$h5]r%uh7Nh8hh]r&hjXcircuits.web.errors.r'r(}r)(h!Uh"jubaubj5)r*}r+(h!jh"jh#jh(j8h*}r,(h,]r-h.]r.h0]r/h2]r0h5]r1uh7Nh8hh]r2hjX Forbiddenr3r4}r5(h!Uh"j*ubaubjC)r6}r7(h!Uh"jh#jh(jFh*}r8(h,]r9h.]r:h0]r;h2]r<h5]r=uh7Nh8hh]r>(jN)r?}r@(h!XrequestrAh*}rB(h,]rCh.]rDh0]rEh2]rFh5]rGuh"j6h]rHhjXrequestrIrJ}rK(h!Uh"j?ubah(j\ubjN)rL}rM(h!XresponserNh*}rO(h,]rPh.]rQh0]rRh2]rSh5]rTuh"j6h]rUhjXresponserVrW}rX(h!Uh"jLubah(j\ubjN)rY}rZ(h!X code=Noner[h*}r\(h,]r]h.]r^h0]r_h2]r`h5]rauh"j6h]rbhjX code=Nonercrd}re(h!Uh"jYubah(j\ubjN)rf}rg(h!X**kwargsrhh*}ri(h,]rjh.]rkh0]rlh2]rmh5]rnuh"j6h]rohjX**kwargsrprq}rr(h!Uh"jfubah(j\ubeubeubj)rs}rt(h!Uh"jh#jh(jh*}ru(h,]rvh.]rwh0]rxh2]ryh5]rzuh7Nh8hh]r{(h)r|}r}(h!X-Bases: :class:`circuits.web.errors.HTTPError`r~h"jsh#jh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7Kh8hh]r(hjXBases: rr}r(h!XBases: rh"j|ubhF)r}r(h!X&:class:`circuits.web.errors.HTTPError`rh"j|h#h&h(hJh*}r(UreftyperXclassrhNhOXcircuits.web.errors.HTTPErrorrU refdomainrXpyrh2]rh0]rU refexplicitrh,]rh.]rh5]rhYhZh[jh\juh7Kh]rh^)r}r(h!jh*}r(h,]rh.]r(hdjXpy-classreh0]rh2]rh5]ruh"jh]rhjXcircuits.web.errors.HTTPErrorrr}r(h!Uh"jubah(hnubaubeubh)r}r(h!X/An event for signaling the HTTP Forbidden errorrh"jsh#jh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7Kh8hh]rhjX/An event for signaling the HTTP Forbidden errorrr}r(h!jh"jubaubh)r}r(h!XaThe constructor creates a new instance and modifies the *response* argument to reflect the error.rh"jsh#jh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7Kh8hh]r(hjX8The constructor creates a new instance and modifies the rr}r(h!X8The constructor creates a new instance and modifies the rh"jubj)r}r(h!X *response*rh*}r(h,]rh.]rh0]rh2]rh5]ruh"jh]rhjXresponserr}r(h!Uh"jubah(jubhjX argument to reflect the error.rr}r(h!X argument to reflect the error.rh"jubeubeubeubhs)r}r(h!Uh"hh#X]/home/prologic/work/circuits/circuits/web/errors.py:docstring of circuits.web.errors.NotFoundrh(hwh*}r(h2]rh0]rh,]rh.]rh5]rUentriesr]r(hX'NotFound (class in circuits.web.errors)h Utrauh7Nh8hh]rubh)r}r(h!Uh"hh#jh(hh*}r(hhXpyrh2]rh0]rh,]rh.]rh5]rhXclassrjjuh7Nh8hh]r(j)r}r(h!X0NotFound(request, response, code=None, **kwargs)rh"jh#jh(jh*}r(h2]rh aj h$Xcircuits.web.errorsrr}rbh0]rh,]rh.]rh5]rh ajXNotFoundrjUjuh7Nh8hh]r(j)r}r(h!Xclass rh"jh#jh(jh*}r(h,]rh.]rh0]rh2]rh5]ruh7Nh8hh]rhjXclass rr}r(h!Uh"jubaubj&)r}r(h!Xcircuits.web.errors.rh"jh#jh(j*h*}r (h,]r h.]r h0]r h2]r h5]ruh7Nh8hh]rhjXcircuits.web.errors.rr}r(h!Uh"jubaubj5)r}r(h!jh"jh#jh(j8h*}r(h,]rh.]rh0]rh2]rh5]ruh7Nh8hh]rhjXNotFoundrr}r(h!Uh"jubaubjC)r}r (h!Uh"jh#jh(jFh*}r!(h,]r"h.]r#h0]r$h2]r%h5]r&uh7Nh8hh]r'(jN)r(}r)(h!Xrequestr*h*}r+(h,]r,h.]r-h0]r.h2]r/h5]r0uh"jh]r1hjXrequestr2r3}r4(h!Uh"j(ubah(j\ubjN)r5}r6(h!Xresponser7h*}r8(h,]r9h.]r:h0]r;h2]r<h5]r=uh"jh]r>hjXresponser?r@}rA(h!Uh"j5ubah(j\ubjN)rB}rC(h!X code=NonerDh*}rE(h,]rFh.]rGh0]rHh2]rIh5]rJuh"jh]rKhjX code=NonerLrM}rN(h!Uh"jBubah(j\ubjN)rO}rP(h!X**kwargsrQh*}rR(h,]rSh.]rTh0]rUh2]rVh5]rWuh"jh]rXhjX**kwargsrYrZ}r[(h!Uh"jOubah(j\ubeubeubj)r\}r](h!Uh"jh#jh(jh*}r^(h,]r_h.]r`h0]rah2]rbh5]rcuh7Nh8hh]rd(h)re}rf(h!X-Bases: :class:`circuits.web.errors.HTTPError`rgh"j\h#jh(hh*}rh(h,]rih.]rjh0]rkh2]rlh5]rmuh7Kh8hh]rn(hjXBases: rorp}rq(h!XBases: rrh"jeubhF)rs}rt(h!X&:class:`circuits.web.errors.HTTPError`ruh"jeh#h&h(hJh*}rv(UreftyperwXclassrxhNhOXcircuits.web.errors.HTTPErrorryU refdomainrzXpyr{h2]r|h0]r}U refexplicitr~h,]rh.]rh5]rhYhZh[jh\juh7Kh]rh^)r}r(h!juh*}r(h,]rh.]r(hdj{Xpy-classreh0]rh2]rh5]ruh"jsh]rhjXcircuits.web.errors.HTTPErrorrr}r(h!Uh"jubah(hnubaubeubh)r}r(h!X0An event for signaling the HTTP Not Fouond errorrh"j\h#jh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7Kh8hh]rhjX0An event for signaling the HTTP Not Fouond errorrr}r(h!jh"jubaubh)r}r(h!XaThe constructor creates a new instance and modifies the *response* argument to reflect the error.rh"j\h#jh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7Kh8hh]r(hjX8The constructor creates a new instance and modifies the rr}r(h!X8The constructor creates a new instance and modifies the rh"jubj)r}r(h!X *response*rh*}r(h,]rh.]rh0]rh2]rh5]ruh"jh]rhjXresponserr}r(h!Uh"jubah(jubhjX argument to reflect the error.rr}r(h!X argument to reflect the error.rh"jubeubeubeubhs)r}r(h!Uh"hh#X]/home/prologic/work/circuits/circuits/web/errors.py:docstring of circuits.web.errors.Redirectrh(hwh*}r(h2]rh0]rh,]rh.]rh5]rUentriesr]r(hX'Redirect (class in circuits.web.errors)hUtrauh7Nh8hh]rubh)r}r(h!Uh"hh#jh(hh*}r(hhXpyrh2]rh0]rh,]rh.]rh5]rhXclassrjjuh7Nh8hh]r(j)r}r(h!X,Redirect(request, response, urls, code=None)rh"jh#jh(jh*}r(h2]rhaj h$Xcircuits.web.errorsrr}rbh0]rh,]rh.]rh5]rhajXRedirectrjUjuh7Nh8hh]r(j)r}r(h!Xclass rh"jh#jh(jh*}r(h,]rh.]rh0]rh2]rh5]ruh7Nh8hh]rhjXclass rr}r(h!Uh"jubaubj&)r}r(h!Xcircuits.web.errors.rh"jh#jh(j*h*}r(h,]rh.]rh0]rh2]rh5]ruh7Nh8hh]rhjXcircuits.web.errors.rr}r(h!Uh"jubaubj5)r}r(h!jh"jh#jh(j8h*}r(h,]rh.]rh0]rh2]rh5]ruh7Nh8hh]rhjXRedirectrr}r(h!Uh"jubaubjC)r}r (h!Uh"jh#jh(jFh*}r (h,]r h.]r h0]r h2]rh5]ruh7Nh8hh]r(jN)r}r(h!Xrequestrh*}r(h,]rh.]rh0]rh2]rh5]ruh"jh]rhjXrequestrr}r(h!Uh"jubah(j\ubjN)r}r(h!Xresponser h*}r!(h,]r"h.]r#h0]r$h2]r%h5]r&uh"jh]r'hjXresponser(r)}r*(h!Uh"jubah(j\ubjN)r+}r,(h!Xurlsr-h*}r.(h,]r/h.]r0h0]r1h2]r2h5]r3uh"jh]r4hjXurlsr5r6}r7(h!Uh"j+ubah(j\ubjN)r8}r9(h!X code=Noner:h*}r;(h,]r<h.]r=h0]r>h2]r?h5]r@uh"jh]rAhjX code=NonerBrC}rD(h!Uh"j8ubah(j\ubeubeubj)rE}rF(h!Uh"jh#jh(jh*}rG(h,]rHh.]rIh0]rJh2]rKh5]rLuh7Nh8hh]rM(h)rN}rO(h!X-Bases: :class:`circuits.web.errors.HTTPError`rPh"jEh#jh(hh*}rQ(h,]rRh.]rSh0]rTh2]rUh5]rVuh7Kh8hh]rW(hjXBases: rXrY}rZ(h!XBases: r[h"jNubhF)r\}r](h!X&:class:`circuits.web.errors.HTTPError`r^h"jNh#h&h(hJh*}r_(Ureftyper`XclassrahNhOXcircuits.web.errors.HTTPErrorrbU refdomainrcXpyrdh2]reh0]rfU refexplicitrgh,]rhh.]rih5]rjhYhZh[jh\juh7Kh]rkh^)rl}rm(h!j^h*}rn(h,]roh.]rp(hdjdXpy-classrqeh0]rrh2]rsh5]rtuh"j\h]ruhjXcircuits.web.errors.HTTPErrorrvrw}rx(h!Uh"jlubah(hnubaubeubh)ry}rz(h!X1An event for signaling the HTTP Redirect responser{h"jEh#jh(hh*}r|(h,]r}h.]r~h0]rh2]rh5]ruh7Kh8hh]rhjX1An event for signaling the HTTP Redirect responserr}r(h!j{h"jyubaubh)r}r(h!X~The constructor creates a new instance and modifies the *response* argument to reflect a redirect response to the given *url*.rh"jEh#jh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7Kh8hh]r(hjX8The constructor creates a new instance and modifies the rr}r(h!X8The constructor creates a new instance and modifies the rh"jubj)r}r(h!X *response*rh*}r(h,]rh.]rh0]rh2]rh5]ruh"jh]rhjXresponserr}r(h!Uh"jubah(jubhjX6 argument to reflect a redirect response to the given rr}r(h!X6 argument to reflect a redirect response to the given rh"jubj)r}r(h!X*url*rh*}r(h,]rh.]rh0]rh2]rh5]ruh"jh]rhjXurlrr}r(h!Uh"jubah(jubhjX.r}r(h!X.h"jubeubeubeubhs)r}r(h!Uh"hh#Xa/home/prologic/work/circuits/circuits/web/errors.py:docstring of circuits.web.errors.Unauthorizedrh(hwh*}r(h2]rh0]rh,]rh.]rh5]rUentriesr]r(hX+Unauthorized (class in circuits.web.errors)h Utrauh7Nh8hh]rubh)r}r(h!Uh"hh#jh(hh*}r(hhXpyrh2]rh0]rh,]rh.]rh5]rhXclassrjjuh7Nh8hh]r(j)r}r(h!X4Unauthorized(request, response, code=None, **kwargs)rh"jh#jh(jh*}r(h2]rh aj h$Xcircuits.web.errorsrr}rbh0]rh,]rh.]rh5]rh ajX UnauthorizedrjUjuh7Nh8hh]r(j)r}r(h!Xclass rh"jh#jh(jh*}r(h,]rh.]rh0]rh2]rh5]ruh7Nh8hh]rhjXclass rr}r(h!Uh"jubaubj&)r}r(h!Xcircuits.web.errors.rh"jh#jh(j*h*}r(h,]rh.]rh0]rh2]rh5]ruh7Nh8hh]rhjXcircuits.web.errors.rr}r(h!Uh"jubaubj5)r}r(h!jh"jh#jh(j8h*}r(h,]rh.]rh0]rh2]rh5]ruh7Nh8hh]rhjX Unauthorizedrr}r(h!Uh"jubaubjC)r}r(h!Uh"jh#jh(jFh*}r(h,]rh.]rh0]rh2]rh5]ruh7Nh8hh]r(jN)r }r (h!Xrequestr h*}r (h,]r h.]rh0]rh2]rh5]ruh"jh]rhjXrequestrr}r(h!Uh"j ubah(j\ubjN)r}r(h!Xresponserh*}r(h,]rh.]rh0]rh2]rh5]ruh"jh]rhjXresponser r!}r"(h!Uh"jubah(j\ubjN)r#}r$(h!X code=Noner%h*}r&(h,]r'h.]r(h0]r)h2]r*h5]r+uh"jh]r,hjX code=Noner-r.}r/(h!Uh"j#ubah(j\ubjN)r0}r1(h!X**kwargsr2h*}r3(h,]r4h.]r5h0]r6h2]r7h5]r8uh"jh]r9hjX**kwargsr:r;}r<(h!Uh"j0ubah(j\ubeubeubj)r=}r>(h!Uh"jh#jh(jh*}r?(h,]r@h.]rAh0]rBh2]rCh5]rDuh7Nh8hh]rE(h)rF}rG(h!X-Bases: :class:`circuits.web.errors.HTTPError`rHh"j=h#jh(hh*}rI(h,]rJh.]rKh0]rLh2]rMh5]rNuh7Kh8hh]rO(hjXBases: rPrQ}rR(h!XBases: rSh"jFubhF)rT}rU(h!X&:class:`circuits.web.errors.HTTPError`rVh"jFh#h&h(hJh*}rW(UreftyperXXclassrYhNhOXcircuits.web.errors.HTTPErrorrZU refdomainr[Xpyr\h2]r]h0]r^U refexplicitr_h,]r`h.]rah5]rbhYhZh[jh\juh7Kh]rch^)rd}re(h!jVh*}rf(h,]rgh.]rh(hdj\Xpy-classrieh0]rjh2]rkh5]rluh"jTh]rmhjXcircuits.web.errors.HTTPErrorrnro}rp(h!Uh"jdubah(hnubaubeubh)rq}rr(h!X2An event for signaling the HTTP Unauthorized errorrsh"j=h#jh(hh*}rt(h,]ruh.]rvh0]rwh2]rxh5]ryuh7Kh8hh]rzhjX2An event for signaling the HTTP Unauthorized errorr{r|}r}(h!jsh"jqubaubh)r~}r(h!XaThe constructor creates a new instance and modifies the *response* argument to reflect the error.rh"j=h#jh(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7Kh8hh]r(hjX8The constructor creates a new instance and modifies the rr}r(h!X8The constructor creates a new instance and modifies the rh"j~ubj)r}r(h!X *response*rh*}r(h,]rh.]rh0]rh2]rh5]ruh"j~h]rhjXresponserr}r(h!Uh"jubah(jubhjX argument to reflect the error.rr}r(h!X argument to reflect the error.rh"j~ubeubeubeubeubh)r}r(h!Uh"hh#h&h(h)h*}r(h,]rh.]rh0]rh2]rhah5]rhauh7K!h8hh]r(h:)r}r(h!X Functionsrh"jh#h&h(h>h*}r(h,]rh.]rh0]rh2]rh5]ruh7K!h8hh]rhjX Functionsrr}r(h!jh"jubaubh)r}r(h!X**none**rh"jh#h&h(hh*}r(h,]rh.]rh0]rh2]rh5]ruh7K#h8hh]rh)r}r(h!jh*}r(h,]rh.]rh0]rh2]rh5]ruh"jh]rhjXnonerr}r(h!Uh"jubah(hubaubeubeubah!UU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh8hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh>NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformr U source_linkr NUrfc_referencesr NUoutput_encodingr Uutf-8r U source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUD/home/prologic/work/circuits/docs/source/api/circuits_web_errors.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerr jUauto_id_prefixr!Uidr"Udoctitle_xformr#Ustrip_elements_with_classesr$NU _config_filesr%]r&Ufile_insertion_enabledr'KU raw_enabledr(KU dump_settingsr)NubUsymbol_footnote_startr*KUidsr+}r,(hjhhhjh jh4cdocutils.nodes target r-)r.}r/(h!Uh"hh#hvh(Utargetr0h*}r1(h,]r2h2]r3h4ah0]r4Uismodr5h.]r6h5]r7uh7Kh8hh]r8ubh jh jh jhhhhuUsubstitution_namesr9}r:h(h8h*}r;(h,]r<h2]r=h0]r>Usourcer?h&h.]r@h5]rAuU footnotesrB]rCUrefidsrD}rEub.circuits-2.1.0/docs/build/doctrees/api/circuits_core_loader.doctree0000644000014400001440000002467312113366655025256 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNXcircuits.core.loader -- loaderqNXcircuits.core.loader.LoaderqXclassesq NX componentsq NXeventsq NuUsubstitution_defsq }q Uparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhUcircuits-core-loader-loaderqhhh Uclassesqh U componentsqh UeventsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentq hUsourceq!cdocutils.nodes reprunicode q"XE/home/prologic/work/circuits/docs/source/api/circuits_core_loader.rstq#q$}q%bUtagnameq&Usectionq'U attributesq(}q)(Udupnamesq*]q+Uclassesq,]q-Ubackrefsq.]q/Uidsq0]q1(Xmodule-circuits.core.loaderq2heUnamesq3]q4hauUlineq5KUdocumentq6hh]q7(cdocutils.nodes title q8)q9}q:(hX%:mod:`circuits.core.loader` -- Loaderq;h hh!h$h&Utitleqh,]q?h.]q@h0]qAh3]qBuh5Kh6hh]qC(csphinx.addnodes pending_xref qD)qE}qF(hX:mod:`circuits.core.loader`qGh h9h!h$h&U pending_xrefqHh(}qI(UreftypeqJXmodqKUrefwarnqLU reftargetqMXcircuits.core.loaderqNU refdomainqOXpyqPh0]qQh.]qRU refexplicitqSh*]qTh,]qUh3]qVUrefdocqWUapi/circuits_core_loaderqXUpy:classqYNU py:moduleqZNuh5Kh]q[cdocutils.nodes literal q\)q]}q^(hhGh(}q_(h*]q`h,]qa(UxrefqbhPXpy-modqceh.]qdh0]qeh3]qfuh hEh]qgcdocutils.nodes Text qhXcircuits.core.loaderqiqj}qk(hUh h]ubah&UliteralqlubaubhhX -- Loaderqmqn}qo(hX -- Loaderqph h9ubeubcsphinx.addnodes index qq)qr}qs(hUh hh!U qth&Uindexquh(}qv(h0]qwh.]qxh*]qyh,]qzh3]q{Uentriesq|]q}(Usingleq~Xcircuits.core.loader (module)Xmodule-circuits.core.loaderUtqauh5Kh6hh]qubcdocutils.nodes paragraph q)q}q(hXThis module implements a generic Loader suitable for dynamically loading components from other modules. This supports loading from local paths, eggs and zip archives. Both setuptools and distribute are fully supported.qh hh!XV/home/prologic/work/circuits/circuits/core/loader.py:docstring of circuits.core.loaderqh&U paragraphqh(}q(h*]qh,]qh.]qh0]qh3]quh5Kh6hh]qhhXThis module implements a generic Loader suitable for dynamically loading components from other modules. This supports loading from local paths, eggs and zip archives. Both setuptools and distribute are fully supported.qq}q(hhh hubaubh)q}q(hUh hh!h$h&h'h(}q(h*]qh,]qh.]qh0]qhah3]qh auh5Kh6hh]q(h8)q}q(hXClassesqh hh!h$h&hqh&Udesc_signatureqh(}q(h0]qhaUmoduleqh"Xcircuits.core.loaderqq}qbh.]qh*]rh,]rh3]rhaUfullnamerXLoaderrUclassrUUfirstruh5Nh6hh]r(csphinx.addnodes desc_annotation r)r }r (hXclass r h hh!hh&Udesc_annotationr h(}r (h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rhhXclass rr}r(hUh j ubaubcsphinx.addnodes desc_addname r)r}r(hXcircuits.core.loader.rh hh!hh&U desc_addnamerh(}r(h*]rh,]rh.]rh0]r h3]r!uh5Nh6hh]r"hhXcircuits.core.loader.r#r$}r%(hUh jubaubcsphinx.addnodes desc_name r&)r'}r((hjh hh!hh&U desc_namer)h(}r*(h*]r+h,]r,h.]r-h0]r.h3]r/uh5Nh6hh]r0hhXLoaderr1r2}r3(hUh j'ubaubcsphinx.addnodes desc_parameterlist r4)r5}r6(hUh hh!hh&Udesc_parameterlistr7h(}r8(h*]r9h,]r:h.]r;h0]r<h3]r=uh5Nh6hh]r>(csphinx.addnodes desc_parameter r?)r@}rA(hXauto_register=TruerBh(}rC(h*]rDh,]rEh.]rFh0]rGh3]rHuh j5h]rIhhXauto_register=TruerJrK}rL(hUh j@ubah&Udesc_parameterrMubj?)rN}rO(hXinit_args=NonerPh(}rQ(h*]rRh,]rSh.]rTh0]rUh3]rVuh j5h]rWhhXinit_args=NonerXrY}rZ(hUh jNubah&jMubj?)r[}r\(hXinit_kwargs=Noner]h(}r^(h*]r_h,]r`h.]rah0]rbh3]rcuh j5h]rdhhXinit_kwargs=Nonererf}rg(hUh j[ubah&jMubj?)rh}ri(hX paths=Nonerjh(}rk(h*]rlh,]rmh.]rnh0]roh3]rpuh j5h]rqhhX paths=Nonerrrs}rt(hUh jhubah&jMubj?)ru}rv(hXchannel='loader'rwh(}rx(h*]ryh,]rzh.]r{h0]r|h3]r}uh j5h]r~hhXchannel='loader'rr}r(hUh juubah&jMubeubeubcsphinx.addnodes desc_content r)r}r(hUh hh!hh&U desc_contentrh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]r(h)r}r(hX6Bases: :class:`circuits.core.components.BaseComponent`rh jh!U rh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]r(hhXBases: rr}r(hXBases: rh jubhD)r}r(hX/:class:`circuits.core.components.BaseComponent`rh jh!h$h&hHh(}r(UreftyperXclassrhLhMX&circuits.core.components.BaseComponentrU refdomainrXpyrh0]rh.]rU refexplicitrh*]rh,]rh3]rhWhXhYjhZXcircuits.core.loaderruh5Kh]rh\)r}r(hjh(}r(h*]rh,]r(hbjXpy-classreh.]rh0]rh3]ruh jh]rhhX&circuits.core.components.BaseComponentrr}r(hUh jubah&hlubaubeubh)r}r(hXCreate a new Loader Componentrh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]rhhXCreate a new Loader Componentrr}r(hjh jubaubh)r}r(hXCreates a new Loader Component that enables dynamic loading of components from modules either in local paths, eggs or zip archives.rh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]rhhXCreates a new Loader Component that enables dynamic loading of components from modules either in local paths, eggs or zip archives.rr}r(hjh jubaubh)r}r(hX4initializes x; see x.__class__.__doc__ for signaturerh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]rhhX4initializes x; see x.__class__.__doc__ for signaturerr}r(hjh jubaubeubeubeubh)r}r(hUh hh!h$h&h'h(}r(h*]rh,]rh.]rh0]rhah3]rh auh5Kh6hh]r(h8)r}r(hXEventsrh jh!h$h&h]r?Uautofootnote_refsr@]rAUsymbol_footnote_refsrB]rCU citationsrD]rEh6hU current_linerFNUtransform_messagesrG]rHUreporterrINUid_startrJKU autofootnotesrK]rLU citation_refsrM}rNUindirect_targetsrO]rPUsettingsrQ(cdocutils.frontend Values rRorS}rT(Ufootnote_backlinksrUKUrecord_dependenciesrVNU rfc_base_urlrWUhttp://tools.ietf.org/html/rXU tracebackrYUpep_referencesrZNUstrip_commentsr[NU toc_backlinksr\Uentryr]U language_coder^Uenr_U datestampr`NU report_levelraKU _destinationrbNU halt_levelrcKU strip_classesrdNhh0h0h1h1uUchildrenq?]q@cdocutils.nodes section qA)qB}qC(U rawsourceqDUUparentqEhUsourceqFcdocutils.nodes reprunicode qGXE/home/prologic/work/circuits/docs/source/api/circuits_net_sockets.rstqHqI}qJbUtagnameqKUsectionqLU attributesqM}qN(UdupnamesqO]qPUclassesqQ]qRUbackrefsqS]qTUidsqU]qV(Xmodule-circuits.net.socketsqWh=eUnamesqX]qYh+auUlineqZKUdocumentq[hh?]q\(cdocutils.nodes title q])q^}q_(hDX0:mod:`circuits.net.sockets` -- Socket Componentsq`hEhBhFhIhKUtitleqahM}qb(hO]qchQ]qdhS]qehU]qfhX]qguhZKh[hh?]qh(csphinx.addnodes pending_xref qi)qj}qk(hDX:mod:`circuits.net.sockets`qlhEh^hFhIhKU pending_xrefqmhM}qn(UreftypeqoXmodqpUrefwarnqqU reftargetqrXcircuits.net.socketsqsU refdomainqtXpyquhU]qvhS]qwU refexplicitqxhO]qyhQ]qzhX]q{Urefdocq|Uapi/circuits_net_socketsq}Upy:classq~NU py:moduleqNuhZKh?]qcdocutils.nodes literal q)q}q(hDhlhM}q(hO]qhQ]q(UxrefqhuXpy-modqehS]qhU]qhX]quhEhjh?]qcdocutils.nodes Text qXcircuits.net.socketsqq}q(hDUhEhubahKUliteralqubaubhX -- Socket Componentsqq}q(hDX -- Socket ComponentsqhEh^ubeubcsphinx.addnodes index q)q}q(hDUhEhBhFhIhKUindexqhM}q(hU]qhS]qhO]qhQ]qhX]qUentriesq]q(UsingleqXcircuits.net.sockets (module)Xmodule-circuits.net.socketsUtqauhZKh[hh?]qubhA)q}q(hDUhEhBhFhIhKhLhM}q(hO]qhQ]qhS]qhU]qhqhKUdesc_signatureqhM}q(hU]qhaUmoduleqhGXcircuits.net.socketsqᅁq}qbhS]qhO]qhQ]qhX]qhaUfullnameqXConnectqUclassqUUfirstquhZNh[hh?]q(csphinx.addnodes desc_annotation q)q}q(hDXclass qhEhhFhhKUdesc_annotationqhM}q(hO]qhQ]qhS]qhU]qhX]quhZNh[hh?]qhXclass qq}q(hDUhEhubaubcsphinx.addnodes desc_addname q)q}q(hDXcircuits.net.sockets.qhEhhFhhKU desc_addnamerhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXcircuits.net.sockets.rr }r (hDUhEhubaubcsphinx.addnodes desc_name r )r }r (hDhhEhhFhhKU desc_namerhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXConnectrr}r(hDUhEj ubaubcsphinx.addnodes desc_parameterlist r)r}r(hDUhEhhFhhKUdesc_parameterlistrhM}r(hO]rhQ]rhS]r hU]r!hX]r"uhZNh[hh?]r#(csphinx.addnodes desc_parameter r$)r%}r&(hDX*argsr'hM}r((hO]r)hQ]r*hS]r+hU]r,hX]r-uhEjh?]r.hX*argsr/r0}r1(hDUhEj%ubahKUdesc_parameterr2ubj$)r3}r4(hDX**kwargsr5hM}r6(hO]r7hQ]r8hS]r9hU]r:hX]r;uhEjh?]r<hX**kwargsr=r>}r?(hDUhEj3ubahKj2ubeubeubcsphinx.addnodes desc_content r@)rA}rB(hDUhEhhFhhKU desc_contentrChM}rD(hO]rEhQ]rFhS]rGhU]rHhX]rIuhZNh[hh?]rJ(cdocutils.nodes paragraph rK)rL}rM(hDX*Bases: :class:`circuits.core.events.Event`rNhEjAhFU rOhKU paragraphrPhM}rQ(hO]rRhQ]rShS]rThU]rUhX]rVuhZKh[hh?]rW(hXBases: rXrY}rZ(hDXBases: r[hEjLubhi)r\}r](hDX#:class:`circuits.core.events.Event`r^hEjLhFhIhKhmhM}r_(Ureftyper`XclassrahqhrXcircuits.core.events.EventrbU refdomainrcXpyrdhU]rehS]rfU refexplicitrghO]rhhQ]rihX]rjh|h}h~hhXcircuits.net.socketsrkuhZKh?]rlh)rm}rn(hDj^hM}ro(hO]rphQ]rq(hjdXpy-classrrehS]rshU]rthX]ruuhEj\h?]rvhXcircuits.core.events.Eventrwrx}ry(hDUhEjmubahKhubaubeubjK)rz}r{(hDX Connect Eventr|hEjAhFX^/home/prologic/work/circuits/circuits/net/sockets.py:docstring of circuits.net.sockets.Connectr}hKjPhM}r~(hO]rhQ]rhS]rhU]rhX]ruhZKh[hh?]rhX Connect Eventrr}r(hDj|hEjzubaubjK)r}r(hDXThis Event is sent when a new client connection has arrived on a server. This event is also used for client's to initiate a new connection to a remote host.rhEjAhFj}hKjPhM}r(hO]rhQ]rhS]rhU]rhX]ruhZKh[hh?]rhXThis Event is sent when a new client connection has arrived on a server. This event is also used for client's to initiate a new connection to a remote host.rr}r(hDjhEjubaubcdocutils.nodes note r)r}r(hDX9This event is used for both Client and Server Components.rhEjAhFj}hKUnoterhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rjK)r}r(hDjhEjhFj}hKjPhM}r(hO]rhQ]rhS]rhU]rhX]ruhZK h?]rhX9This event is used for both Client and Server Components.rr}r(hDjhEjubaubaubcdocutils.nodes field_list r)r}r(hDUhEjAhFNhKU field_listrhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rcdocutils.nodes field r)r}r(hDUhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]r(cdocutils.nodes field_name r)r}r(hDUhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhX Parametersrr}r(hDUhEjubahKU field_namerubcdocutils.nodes field_body r)r}r(hDUhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rcdocutils.nodes bullet_list r)r}r(hDUhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]r(cdocutils.nodes list_item r)r}r(hDUhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rjK)r}r(hDUhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]r(cdocutils.nodes strong r)r}r(hDXargsrhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhXargsrr}r(hDUhEjubahKUstrongrubhX (rr}r(hDUhEjubhi)r }r (hDUhM}r (Ureftyper Uobjr U reftargetrXtuplerU refdomainrhhU]rhS]rU refexplicitrhO]rhQ]rhX]ruhEjh?]rcdocutils.nodes emphasis r)r}r(hDjhM}r(hO]rhQ]rhS]rhU]rhX]r uhEj h?]r!hXtupler"r#}r$(hDUhEjubahKUemphasisr%ubahKhmubhX)r&}r'(hDUhEjubhX -- r(r)}r*(hDUhEjubhX/Client: (host, port) Server: (sock, host, port)r+r,}r-(hDX/Client: (host, port) Server: (sock, host, port)r.hEjubehKjPubahKU list_itemr/ubj)r0}r1(hDUhM}r2(hO]r3hQ]r4hS]r5hU]r6hX]r7uhEjh?]r8jK)r9}r:(hDUhM}r;(hO]r<hQ]r=hS]r>hU]r?hX]r@uhEj0h?]rA(j)rB}rC(hDXkwargsrDhM}rE(hO]rFhQ]rGhS]rHhU]rIhX]rJuhEj9h?]rKhXkwargsrLrM}rN(hDUhEjBubahKjubhX (rOrP}rQ(hDUhEj9ubhi)rR}rS(hDUhM}rT(UreftyperUj U reftargetrVXdictrWU refdomainrXhhU]rYhS]rZU refexplicitr[hO]r\hQ]r]hX]r^uhEj9h?]r_j)r`}ra(hDjWhM}rb(hO]rchQ]rdhS]rehU]rfhX]rguhEjRh?]rhhXdictrirj}rk(hDUhEj`ubahKj%ubahKhmubhX)rl}rm(hDUhEj9ubhX -- rnro}rp(hDUhEj9ubhX Client: (ssl)rqrr}rs(hDX Client: (ssl)rthEj9ubehKjPubahKj/ubehKU bullet_listruubahKU field_bodyrvubehKUfieldrwubaubeubeubh)rx}ry(hDUhEhhFNhKhhM}rz(hU]r{hS]r|hO]r}hQ]r~hX]rUentriesr]r(hX)Connected (class in circuits.net.sockets)hUtrauhZNh[hh?]rubh)r}r(hDUhEhhFNhKhhM}r(h̉hXpyrhU]rhS]rhO]rhQ]rhX]rhXclassrhjuhZNh[hh?]r(h)r}r(hDXConnected(host, port)rhEjhFhhKhhM}r(hU]rhahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rhahX ConnectedrhUhuhZNh[hh?]r(h)r}r(hDXclass rhEjhFhhKhhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXclass rr}r(hDUhEjubaubh)r}r(hDXcircuits.net.sockets.rhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXcircuits.net.sockets.rr}r(hDUhEjubaubj )r}r(hDjhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhX Connectedrr}r(hDUhEjubaubj)r}r(hDUhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]r(j$)r}r(hDXhostrhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhXhostrr}r(hDUhEjubahKj2ubj$)r}r(hDXportrhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhXportrr}r(hDUhEjubahKj2ubeubeubj@)r}r(hDUhEjhFhhKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]r(jK)r}r(hDX*Bases: :class:`circuits.core.events.Event`rhEjhFjOhKjPhM}r(hO]rhQ]rhS]rhU]rhX]ruhZKh[hh?]r(hXBases: rr}r(hDXBases: rhEjubhi)r}r(hDX#:class:`circuits.core.events.Event`rhEjhFhIhKhmhM}r(UreftyperXclassrhqhrXcircuits.core.events.EventrU refdomainrXpyrhU]rhS]rU refexplicitrhO]r hQ]r hX]r h|h}h~jhjkuhZKh?]r h)r }r(hDjhM}r(hO]rhQ]r(hjXpy-classrehS]rhU]rhX]ruhEjh?]rhXcircuits.core.events.Eventrr}r(hDUhEj ubahKhubaubeubjK)r}r(hDXConnected EventrhEjhFX`/home/prologic/work/circuits/circuits/net/sockets.py:docstring of circuits.net.sockets.ConnectedrhKjPhM}r(hO]rhQ]r hS]r!hU]r"hX]r#uhZKh[hh?]r$hXConnected Eventr%r&}r'(hDjhEjubaubjK)r(}r)(hDX<This Event is sent when a client has successfully connected.r*hEjhFjhKjPhM}r+(hO]r,hQ]r-hS]r.hU]r/hX]r0uhZKh[hh?]r1hX<This Event is sent when a client has successfully connected.r2r3}r4(hDj*hEj(ubaubjK)r5}r6(hDX+@note: This event is for Client Components.r7hEjhFjhKjPhM}r8(hO]r9hQ]r:hS]r;hU]r<hX]r=uhZKh[hh?]r>hX+@note: This event is for Client Components.r?r@}rA(hDj7hEj5ubaubj)rB}rC(hDUhEjhFNhKjhM}rD(hO]rEhQ]rFhS]rGhU]rHhX]rIuhZNh[hh?]rJj)rK}rL(hDUhM}rM(hO]rNhQ]rOhS]rPhU]rQhX]rRuhEjBh?]rS(j)rT}rU(hDUhM}rV(hO]rWhQ]rXhS]rYhU]rZhX]r[uhEjKh?]r\hX Parametersr]r^}r_(hDUhEjTubahKjubj)r`}ra(hDUhM}rb(hO]rchQ]rdhS]rehU]rfhX]rguhEjKh?]rhj)ri}rj(hDUhM}rk(hO]rlhQ]rmhS]rnhU]rohX]rpuhEj`h?]rq(j)rr}rs(hDUhM}rt(hO]ruhQ]rvhS]rwhU]rxhX]ryuhEjih?]rzjK)r{}r|(hDUhM}r}(hO]r~hQ]rhS]rhU]rhX]ruhEjrh?]r(j)r}r(hDXhostrhM}r(hO]rhQ]rhS]rhU]rhX]ruhEj{h?]rhXhostrr}r(hDUhEjubahKjubhX -- rr}r(hDUhEj{ubhXThe hostname connected to.rr}r(hDXThe hostname connected to.rhEj{ubehKjPubahKj/ubj)r}r(hDUhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjih?]rjK)r}r(hDUhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]r(j)r}r(hDXportrhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhXportrr}r(hDUhEjubahKjubhX -- rr}r(hDUhEjubhXThe port connected torr}r(hDXThe port connected torhEjubehKjPubahKj/ubehKjuubahKjvubehKjwubaubeubeubh)r}r(hDUhEhhFNhKhhM}r(hU]rhS]rhO]rhQ]rhX]rUentriesr]r(hX%Close (class in circuits.net.sockets)h'UtrauhZNh[hh?]rubh)r}r(hDUhEhhFNhKhhM}r(h̉hXpyrhU]rhS]rhO]rhQ]rhX]rhXclassrhjuhZNh[hh?]r(h)r}r(hDX Close(*args)rhEjhFhhKhhM}r(hU]rh'ahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rh'ahXCloserhUhuhZNh[hh?]r(h)r}r(hDXclass rhEjhFhhKhhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXclass rr}r(hDUhEjubaubh)r}r(hDXcircuits.net.sockets.rhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXcircuits.net.sockets.rr}r(hDUhEjubaubj )r}r(hDjhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXCloserr}r(hDUhEjubaubj)r }r (hDUhEjhFhhKjhM}r (hO]r hQ]r hS]rhU]rhX]ruhZNh[hh?]rj$)r}r(hDX*argsrhM}r(hO]rhQ]rhS]rhU]rhX]ruhEj h?]rhX*argsrr}r(hDUhEjubahKj2ubaubeubj@)r}r (hDUhEjhFhhKjChM}r!(hO]r"hQ]r#hS]r$hU]r%hX]r&uhZNh[hh?]r'(jK)r(}r)(hDX*Bases: :class:`circuits.core.events.Event`r*hEjhFjOhKjPhM}r+(hO]r,hQ]r-hS]r.hU]r/hX]r0uhZKh[hh?]r1(hXBases: r2r3}r4(hDXBases: r5hEj(ubhi)r6}r7(hDX#:class:`circuits.core.events.Event`r8hEj(hFhIhKhmhM}r9(Ureftyper:Xclassr;hqhrXcircuits.core.events.Eventr<U refdomainr=Xpyr>hU]r?hS]r@U refexplicitrAhO]rBhQ]rChX]rDh|h}h~jhjkuhZKh?]rEh)rF}rG(hDj8hM}rH(hO]rIhQ]rJ(hj>Xpy-classrKehS]rLhU]rMhX]rNuhEj6h?]rOhXcircuits.core.events.EventrPrQ}rR(hDUhEjFubahKhubaubeubjK)rS}rT(hDX Close EventrUhEjhFX\/home/prologic/work/circuits/circuits/net/sockets.py:docstring of circuits.net.sockets.CloserVhKjPhM}rW(hO]rXhQ]rYhS]rZhU]r[hX]r\uhZKh[hh?]r]hX Close Eventr^r_}r`(hDjUhEjSubaubjK)ra}rb(hDXYThis Event is used to notify a client, client connection or server that we want to close.rchEjhFjVhKjPhM}rd(hO]rehQ]rfhS]rghU]rhhX]riuhZKh[hh?]rjhXYThis Event is used to notify a client, client connection or server that we want to close.rkrl}rm(hDjchEjaubaubjK)rn}ro(hDXv@note: This event is never sent, it is used to close. @note: This event is used for both Client and Server Components.rphEjhFjVhKjPhM}rq(hO]rrhQ]rshS]rthU]ruhX]rvuhZKh[hh?]rwhXv@note: This event is never sent, it is used to close. @note: This event is used for both Client and Server Components.rxry}rz(hDjphEjnubaubj)r{}r|(hDUhEjhFNhKjhM}r}(hO]r~hQ]rhS]rhU]rhX]ruhZNh[hh?]rj)r}r(hDUhM}r(hO]rhQ]rhS]rhU]rhX]ruhEj{h?]r(j)r}r(hDUhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhX Parametersrr}r(hDUhEjubahKjubj)r}r(hDUhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rjK)r}r(hDUhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]r(j)r}r(hDXargsrhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhXargsrr}r(hDUhEjubahKjubhX -- rr}r(hDUhEjubhXClient: () Server: (sock)rr}r(hDXClient: () Server: (sock)rhEjubehKjPubahKjvubehKjwubaubeubeubh)r}r(hDUhEhhFX]/home/prologic/work/circuits/circuits/net/sockets.py:docstring of circuits.net.sockets.ClosedrhKhhM}r(hU]rhS]rhO]rhQ]rhX]rUentriesr]r(hX&Closed (class in circuits.net.sockets)h%UtrauhZNh[hh?]rubh)r}r(hDUhEhhFjhKhhM}r(h̉hXpyrhU]rhS]rhO]rhQ]rhX]rhXclassrhjuhZNh[hh?]r(h)r}r(hDXClosed()rhEjhFhhKhhM}r(hU]rh%ahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rh%ahXClosedrhUhuhZNh[hh?]r(h)r}r(hDXclass rhEjhFhhKhhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXclass rr}r(hDUhEjubaubh)r}r(hDXcircuits.net.sockets.rhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXcircuits.net.sockets.rr}r(hDUhEjubaubj )r}r(hDjhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXClosedrr }r (hDUhEjubaubeubj@)r }r (hDUhEjhFhhKjChM}r (hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]r(jK)r}r(hDX*Bases: :class:`circuits.core.events.Event`rhEj hFjOhKjPhM}r(hO]rhQ]rhS]rhU]rhX]ruhZKh[hh?]r(hXBases: rr}r (hDXBases: r!hEjubhi)r"}r#(hDX#:class:`circuits.core.events.Event`r$hEjhFhIhKhmhM}r%(Ureftyper&Xclassr'hqhrXcircuits.core.events.Eventr(U refdomainr)Xpyr*hU]r+hS]r,U refexplicitr-hO]r.hQ]r/hX]r0h|h}h~jhjkuhZKh?]r1h)r2}r3(hDj$hM}r4(hO]r5hQ]r6(hj*Xpy-classr7ehS]r8hU]r9hX]r:uhEj"h?]r;hXcircuits.core.events.Eventr<r=}r>(hDUhEj2ubahKhubaubeubjK)r?}r@(hDX Closed EventrAhEj hFjhKjPhM}rB(hO]rChQ]rDhS]rEhU]rFhX]rGuhZKh[hh?]rHhX Closed EventrIrJ}rK(hDjAhEj?ubaubjK)rL}rM(hDXAThis Event is sent when a server has closed its listening socket.rNhEj hFjhKjPhM}rO(hO]rPhQ]rQhS]rRhU]rShX]rTuhZKh[hh?]rUhXAThis Event is sent when a server has closed its listening socket.rVrW}rX(hDjNhEjLubaubjK)rY}rZ(hDX+@note: This event is for Server components.r[hEj hFjhKjPhM}r\(hO]r]hQ]r^hS]r_hU]r`hX]rauhZKh[hh?]rbhX+@note: This event is for Server components.rcrd}re(hDj[hEjYubaubeubeubh)rf}rg(hDUhEhhFNhKhhM}rh(hU]rihS]rjhO]rkhQ]rlhX]rmUentriesrn]ro(hX$Read (class in circuits.net.sockets)hUtrpauhZNh[hh?]rqubh)rr}rs(hDUhEhhFNhKhhM}rt(h̉hXpyruhU]rvhS]rwhO]rxhQ]ryhX]rzhXclassr{hj{uhZNh[hh?]r|(h)r}}r~(hDX Read(*args)rhEjrhFhhKhhM}r(hU]rhahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rhahXReadrhUhuhZNh[hh?]r(h)r}r(hDXclass rhEj}hFhhKhhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXclass rr}r(hDUhEjubaubh)r}r(hDXcircuits.net.sockets.rhEj}hFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXcircuits.net.sockets.rr}r(hDUhEjubaubj )r}r(hDjhEj}hFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXReadrr}r(hDUhEjubaubj)r}r(hDUhEj}hFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rj$)r}r(hDX*argsrhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhX*argsrr}r(hDUhEjubahKj2ubaubeubj@)r}r(hDUhEjrhFhhKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]r(jK)r}r(hDX*Bases: :class:`circuits.core.events.Event`rhEjhFjOhKjPhM}r(hO]rhQ]rhS]rhU]rhX]ruhZKh[hh?]r(hXBases: rr}r(hDXBases: rhEjubhi)r}r(hDX#:class:`circuits.core.events.Event`rhEjhFhIhKhmhM}r(UreftyperXclassrhqhrXcircuits.core.events.EventrU refdomainrXpyrhU]rhS]rU refexplicitrhO]rhQ]rhX]rh|h}h~jhjkuhZKh?]rh)r}r(hDjhM}r(hO]rhQ]r(hjXpy-classrehS]rhU]rhX]ruhEjh?]rhXcircuits.core.events.Eventrr}r(hDUhEjubahKhubaubeubjK)r}r(hDX Read EventrhEjhFX[/home/prologic/work/circuits/circuits/net/sockets.py:docstring of circuits.net.sockets.ReadrhKjPhM}r(hO]rhQ]rhS]rhU]rhX]ruhZKh[hh?]rhX Read Eventrr}r(hDjhEjubaubjK)r }r (hDXHThis Event is sent when a client or server connection has read any data.r hEjhFjhKjPhM}r (hO]r hQ]rhS]rhU]rhX]ruhZKh[hh?]rhXHThis Event is sent when a client or server connection has read any data.rr}r(hDj hEj ubaubjK)r}r(hDX@@note: This event is used for both Client and Server Components.rhEjhFjhKjPhM}r(hO]rhQ]rhS]rhU]rhX]ruhZKh[hh?]rhX@@note: This event is used for both Client and Server Components.r r!}r"(hDjhEjubaubj)r#}r$(hDUhEjhFNhKjhM}r%(hO]r&hQ]r'hS]r(hU]r)hX]r*uhZNh[hh?]r+j)r,}r-(hDUhM}r.(hO]r/hQ]r0hS]r1hU]r2hX]r3uhEj#h?]r4(j)r5}r6(hDUhM}r7(hO]r8hQ]r9hS]r:hU]r;hX]r<uhEj,h?]r=hX Parametersr>r?}r@(hDUhEj5ubahKjubj)rA}rB(hDUhM}rC(hO]rDhQ]rEhS]rFhU]rGhX]rHuhEj,h?]rIjK)rJ}rK(hDUhM}rL(hO]rMhQ]rNhS]rOhU]rPhX]rQuhEjAh?]rR(j)rS}rT(hDXargsrUhM}rV(hO]rWhQ]rXhS]rYhU]rZhX]r[uhEjJh?]r\hXargsr]r^}r_(hDUhEjSubahKjubhX -- r`ra}rb(hDUhEjJubhX#Client: (data) Server: (sock, data)rcrd}re(hDX#Client: (data) Server: (sock, data)rfhEjJubehKjPubahKjvubehKjwubaubeubeubh)rg}rh(hDUhEhhFNhKhhM}ri(hU]rjhS]rkhO]rlhQ]rmhX]rnUentriesro]rp(hX%Write (class in circuits.net.sockets)h UtrqauhZNh[hh?]rrubh)rs}rt(hDUhEhhFNhKhhM}ru(h̉hXpyrvhU]rwhS]rxhO]ryhQ]rzhX]r{hXclassr|hj|uhZNh[hh?]r}(h)r~}r(hDX Write(*args)rhEjshFhhKhhM}r(hU]rh ahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rh ahXWriterhUhuhZNh[hh?]r(h)r}r(hDXclass rhEj~hFhhKhhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXclass rr}r(hDUhEjubaubh)r}r(hDXcircuits.net.sockets.rhEj~hFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXcircuits.net.sockets.rr}r(hDUhEjubaubj )r}r(hDjhEj~hFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXWriterr}r(hDUhEjubaubj)r}r(hDUhEj~hFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rj$)r}r(hDX*argsrhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhX*argsrr}r(hDUhEjubahKj2ubaubeubj@)r}r(hDUhEjshFhhKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]r(jK)r}r(hDX*Bases: :class:`circuits.core.events.Event`rhEjhFjOhKjPhM}r(hO]rhQ]rhS]rhU]rhX]ruhZKh[hh?]r(hXBases: rr}r(hDXBases: rhEjubhi)r}r(hDX#:class:`circuits.core.events.Event`rhEjhFhIhKhmhM}r(UreftyperXclassrhqhrXcircuits.core.events.EventrU refdomainrXpyrhU]rhS]rU refexplicitrhO]rhQ]rhX]rh|h}h~jhjkuhZKh?]rh)r}r(hDjhM}r(hO]rhQ]r(hjXpy-classrehS]rhU]rhX]ruhEjh?]rhXcircuits.core.events.Eventrr}r(hDUhEjubahKhubaubeubjK)r}r(hDX Write EventrhEjhFX\/home/prologic/work/circuits/circuits/net/sockets.py:docstring of circuits.net.sockets.WriterhKjPhM}r(hO]rhQ]rhS]rhU]rhX]ruhZKh[hh?]rhX Write Eventrr}r (hDjhEjubaubjK)r }r (hDXcThis Event is used to notify a client, client connection or server that we have data to be written.r hEjhFjhKjPhM}r (hO]rhQ]rhS]rhU]rhX]ruhZKh[hh?]rhXcThis Event is used to notify a client, client connection or server that we have data to be written.rr}r(hDj hEj ubaubjK)r}r(hDXz@note: This event is never sent, it is used to send data. @note: This event is used for both Client and Server Components.rhEjhFjhKjPhM}r(hO]rhQ]rhS]rhU]rhX]ruhZKh[hh?]r hXz@note: This event is never sent, it is used to send data. @note: This event is used for both Client and Server Components.r!r"}r#(hDjhEjubaubj)r$}r%(hDUhEjhFNhKjhM}r&(hO]r'hQ]r(hS]r)hU]r*hX]r+uhZNh[hh?]r,j)r-}r.(hDUhM}r/(hO]r0hQ]r1hS]r2hU]r3hX]r4uhEj$h?]r5(j)r6}r7(hDUhM}r8(hO]r9hQ]r:hS]r;hU]r<hX]r=uhEj-h?]r>hX Parametersr?r@}rA(hDUhEj6ubahKjubj)rB}rC(hDUhM}rD(hO]rEhQ]rFhS]rGhU]rHhX]rIuhEj-h?]rJjK)rK}rL(hDUhM}rM(hO]rNhQ]rOhS]rPhU]rQhX]rRuhEjBh?]rS(j)rT}rU(hDXargsrVhM}rW(hO]rXhQ]rYhS]rZhU]r[hX]r\uhEjKh?]r]hXargsr^r_}r`(hDUhEjTubahKjubhX -- rarb}rc(hDUhEjKubhX#Client: (data) Server: (sock, data)rdre}rf(hDX#Client: (data) Server: (sock, data)rghEjKubehKjPubahKjvubehKjwubaubeubeubh)rh}ri(hDUhEhhFNhKhhM}rj(hU]rkhS]rlhO]rmhQ]rnhX]roUentriesrp]rq(hX+SocketError (class in circuits.net.sockets)h!UtrrauhZNh[hh?]rsubh)rt}ru(hDUhEhhFNhKhhM}rv(h̉hXpyrwhU]rxhS]ryhO]rzhQ]r{hX]r|hXclassr}hj}uhZNh[hh?]r~(h)r}r(hDXSocketError(*args)rhEjthFhhKhhM}r(hU]rh!ahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rh!ahX SocketErrorrhUhuhZNh[hh?]r(h)r}r(hDXclass rhEjhFhhKhhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXclass rr}r(hDUhEjubaubh)r}r(hDXcircuits.net.sockets.rhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXcircuits.net.sockets.rr}r(hDUhEjubaubj )r}r(hDjhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhX SocketErrorrr}r(hDUhEjubaubj)r}r(hDUhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rj$)r}r(hDX*argsrhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhX*argsrr}r(hDUhEjubahKj2ubaubeubj@)r}r(hDUhEjthFhhKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]r(jK)r}r(hDX*Bases: :class:`circuits.core.events.Event`rhEjhFjOhKjPhM}r(hO]rhQ]rhS]rhU]rhX]ruhZKh[hh?]r(hXBases: rr}r(hDXBases: rhEjubhi)r}r(hDX#:class:`circuits.core.events.Event`rhEjhFhIhKhmhM}r(UreftyperXclassrhqhrXcircuits.core.events.EventrU refdomainrXpyrhU]rhS]rU refexplicitrhO]rhQ]rhX]rh|h}h~jhjkuhZKh?]rh)r}r(hDjhM}r(hO]rhQ]r(hjXpy-classrehS]rhU]rhX]ruhEjh?]rhXcircuits.core.events.Eventrr}r(hDUhEjubahKhubaubeubjK)r}r(hDXSocketError EventrhEjhFXb/home/prologic/work/circuits/circuits/net/sockets.py:docstring of circuits.net.sockets.SocketErrorrhKjPhM}r(hO]rhQ]rhS]rhU]rhX]ruhZKh[hh?]rhXSocketError Eventrr }r (hDjhEjubaubjK)r }r (hDXCThis Event is sent when a client or server connection has an error.r hEjhFjhKjPhM}r(hO]rhQ]rhS]rhU]rhX]ruhZKh[hh?]rhXCThis Event is sent when a client or server connection has an error.rr}r(hDj hEj ubaubjK)r}r(hDX@@note: This event is used for both Client and Server Components.rhEjhFjhKjPhM}r(hO]rhQ]rhS]rhU]rhX]r uhZKh[hh?]r!hX@@note: This event is used for both Client and Server Components.r"r#}r$(hDjhEjubaubj)r%}r&(hDUhEjhFNhKjhM}r'(hO]r(hQ]r)hS]r*hU]r+hX]r,uhZNh[hh?]r-j)r.}r/(hDUhM}r0(hO]r1hQ]r2hS]r3hU]r4hX]r5uhEj%h?]r6(j)r7}r8(hDUhM}r9(hO]r:hQ]r;hS]r<hU]r=hX]r>uhEj.h?]r?hX Parametersr@rA}rB(hDUhEj7ubahKjubj)rC}rD(hDUhM}rE(hO]rFhQ]rGhS]rHhU]rIhX]rJuhEj.h?]rKjK)rL}rM(hDUhM}rN(hO]rOhQ]rPhS]rQhU]rRhX]rSuhEjCh?]rT(j)rU}rV(hDXargsrWhM}rX(hO]rYhQ]rZhS]r[hU]r\hX]r]uhEjLh?]r^hXargsr_r`}ra(hDUhEjUubahKjubhX -- rbrc}rd(hDUhEjLubhX%Client: (error) Server: (sock, error)rerf}rg(hDX%Client: (error) Server: (sock, error)rhhEjLubehKjPubahKjvubehKjwubaubeubeubh)ri}rj(hDUhEhhFNhKhhM}rk(hU]rlhS]rmhO]rnhQ]rohX]rpUentriesrq]rr(hX*Disconnect (class in circuits.net.sockets)hUtrsauhZNh[hh?]rtubh)ru}rv(hDUhEhhFNhKhhM}rw(h̉hXpyrxhU]ryhS]rzhO]r{hQ]r|hX]r}hXclassr~hj~uhZNh[hh?]r(h)r}r(hDXDisconnect(*args)rhEjuhFhhKhhM}r(hU]rhahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rhahX DisconnectrhUhuhZNh[hh?]r(h)r}r(hDXclass rhEjhFhhKhhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXclass rr}r(hDUhEjubaubh)r}r(hDXcircuits.net.sockets.rhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXcircuits.net.sockets.rr}r(hDUhEjubaubj )r}r(hDjhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhX Disconnectrr}r(hDUhEjubaubj)r}r(hDUhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rj$)r}r(hDX*argsrhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhX*argsrr}r(hDUhEjubahKj2ubaubeubj@)r}r(hDUhEjuhFhhKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]r(jK)r}r(hDX*Bases: :class:`circuits.core.events.Event`rhEjhFjOhKjPhM}r(hO]rhQ]rhS]rhU]rhX]ruhZKh[hh?]r(hXBases: rr}r(hDXBases: rhEjubhi)r}r(hDX#:class:`circuits.core.events.Event`rhEjhFhIhKhmhM}r(UreftyperXclassrhqhrXcircuits.core.events.EventrU refdomainrXpyrhU]rhS]rU refexplicitrhO]rhQ]rhX]rh|h}h~jhjkuhZKh?]rh)r}r(hDjhM}r(hO]rhQ]r(hjXpy-classrehS]rhU]rhX]ruhEjh?]rhXcircuits.core.events.Eventrr}r(hDUhEjubahKhubaubeubjK)r}r(hDXDisconnect Eventr hEjhFXa/home/prologic/work/circuits/circuits/net/sockets.py:docstring of circuits.net.sockets.Disconnectr hKjPhM}r (hO]r hQ]r hS]r hU]r hX]r uhZKh[hh?]r hXDisconnect Eventr r }r (hDj hEjubaubjK)r }r (hDXThis Event is sent when a client connection has closed on a server. This event is also used for client's to disconnect from a remote host.r hEjhFj hKjPhM}r (hO]r hQ]r hS]r hU]r hX]r uhZKh[hh?]r hXThis Event is sent when a client connection has closed on a server. This event is also used for client's to disconnect from a remote host.r r }r (hDj hEj ubaubjK)r }r (hDX@@note: This event is used for both Client and Server Components.r hEjhFj hKjPhM}r (hO]r hQ]r hS]r hU]r hX]r! uhZKh[hh?]r" hX@@note: This event is used for both Client and Server Components.r# r$ }r% (hDj hEj ubaubj)r& }r' (hDUhEjhFNhKjhM}r( (hO]r) hQ]r* hS]r+ hU]r, hX]r- uhZNh[hh?]r. j)r/ }r0 (hDUhM}r1 (hO]r2 hQ]r3 hS]r4 hU]r5 hX]r6 uhEj& h?]r7 (j)r8 }r9 (hDUhM}r: (hO]r; hQ]r< hS]r= hU]r> hX]r? uhEj/ h?]r@ hX ParametersrA rB }rC (hDUhEj8 ubahKjubj)rD }rE (hDUhM}rF (hO]rG hQ]rH hS]rI hU]rJ hX]rK uhEj/ h?]rL jK)rM }rN (hDUhM}rO (hO]rP hQ]rQ hS]rR hU]rS hX]rT uhEjD h?]rU (j)rV }rW (hDXargsrX hM}rY (hO]rZ hQ]r[ hS]r\ hU]r] hX]r^ uhEjM h?]r_ hXargsr` ra }rb (hDUhEjV ubahKjubhX -- rc rd }re (hDUhEjM ubhXClient: () Server: (sock)rf rg }rh (hDXClient: () Server: (sock)ri hEjM ubehKjPubahKjvubehKjwubaubeubeubh)rj }rk (hDUhEhhFXc/home/prologic/work/circuits/circuits/net/sockets.py:docstring of circuits.net.sockets.Disconnectedrl hKhhM}rm (hU]rn hS]ro hO]rp hQ]rq hX]rr Uentriesrs ]rt (hX,Disconnected (class in circuits.net.sockets)h Utru auhZNh[hh?]rv ubh)rw }rx (hDUhEhhFjl hKhhM}ry (h̉hXpyrz hU]r{ hS]r| hO]r} hQ]r~ hX]r hXclassr hj uhZNh[hh?]r (h)r }r (hDXDisconnected()r hEjw hFhhKhhM}r (hU]r h ahhGXcircuits.net.socketsr r }r bhS]r hO]r hQ]r hX]r h ahX Disconnectedr hUhuhZNh[hh?]r (h)r }r (hDXclass r hEj hFhhKhhM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r hXclass r r }r (hDUhEj ubaubh)r }r (hDXcircuits.net.sockets.r hEj hFhhKjhM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r hXcircuits.net.sockets.r r }r (hDUhEj ubaubj )r }r (hDj hEj hFhhKjhM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r hX Disconnectedr r }r (hDUhEj ubaubeubj@)r }r (hDUhEjw hFhhKjChM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r (jK)r }r (hDX*Bases: :class:`circuits.core.events.Event`r hEj hFjOhKjPhM}r (hO]r hQ]r hS]r hU]r hX]r uhZKh[hh?]r (hXBases: r r }r (hDXBases: r hEj ubhi)r }r (hDX#:class:`circuits.core.events.Event`r hEj hFhIhKhmhM}r (Ureftyper Xclassr hqhrXcircuits.core.events.Eventr U refdomainr Xpyr hU]r hS]r U refexplicitr hO]r hQ]r hX]r h|h}h~j hjkuhZKh?]r h)r }r (hDj hM}r (hO]r hQ]r (hj Xpy-classr ehS]r hU]r hX]r uhEj h?]r hXcircuits.core.events.Eventr r }r (hDUhEj ubahKhubaubeubjK)r }r (hDXDisconnected Eventr hEj hFjl hKjPhM}r (hO]r hQ]r hS]r hU]r hX]r uhZKh[hh?]r hXDisconnected Eventr r }r (hDj hEj ubaubjK)r }r (hDX1This Event is sent when a client has disconnectedr hEj hFjl hKjPhM}r (hO]r hQ]r hS]r hU]r hX]r uhZKh[hh?]r hX1This Event is sent when a client has disconnectedr r }r (hDj hEj ubaubjK)r }r (hDX+@note: This event is for Client Components.r hEj hFjl hKjPhM}r (hO]r hQ]r hS]r hU]r hX]r uhZKh[hh?]r hX+@note: This event is for Client Components.r r }r (hDj hEj ubaubeubeubeubhA)r }r (hDUhEhBhFhIhKhLhM}r (hO]r hQ]r hS]r hU]r h>ahX]r h/auhZKh[hh?]r (h])r }r (hDX Componentsr hEj hFhIhKhahM}r (hO]r hQ]r hS]r hU]r! hX]r" uhZKh[hh?]r# hX Componentsr$ r% }r& (hDj hEj ubaubh)r' }r( (hDUhEj hFNhKhhM}r) (hU]r* hS]r+ hO]r, hQ]r- hX]r. Uentriesr/ ]r0 (hX&Client (class in circuits.net.sockets)h*Utr1 auhZNh[hh?]r2 ubh)r3 }r4 (hDUhEj hFNhKhhM}r5 (h̉hXpyr6 hU]r7 hS]r8 hO]r9 hQ]r: hX]r; hXclassr< hj< uhZNh[hh?]r= (h)r> }r? (hDX1Client(bind=None, bufsize=4096, channel='client')r@ hEj3 hFhhKhhM}rA (hU]rB h*ahhGXcircuits.net.socketsrC rD }rE bhS]rF hO]rG hQ]rH hX]rI h*ahXClientrJ hUhuhZNh[hh?]rK (h)rL }rM (hDXclass rN hEj> hFhhKhhM}rO (hO]rP hQ]rQ hS]rR hU]rS hX]rT uhZNh[hh?]rU hXclass rV rW }rX (hDUhEjL ubaubh)rY }rZ (hDXcircuits.net.sockets.r[ hEj> hFhhKjhM}r\ (hO]r] hQ]r^ hS]r_ hU]r` hX]ra uhZNh[hh?]rb hXcircuits.net.sockets.rc rd }re (hDUhEjY ubaubj )rf }rg (hDjJ hEj> hFhhKjhM}rh (hO]ri hQ]rj hS]rk hU]rl hX]rm uhZNh[hh?]rn hXClientro rp }rq (hDUhEjf ubaubj)rr }rs (hDUhEj> hFhhKjhM}rt (hO]ru hQ]rv hS]rw hU]rx hX]ry uhZNh[hh?]rz (j$)r{ }r| (hDX bind=Noner} hM}r~ (hO]r hQ]r hS]r hU]r hX]r uhEjr h?]r hX bind=Noner r }r (hDUhEj{ ubahKj2ubj$)r }r (hDX bufsize=4096r hM}r (hO]r hQ]r hS]r hU]r hX]r uhEjr h?]r hX bufsize=4096r r }r (hDUhEj ubahKj2ubj$)r }r (hDXchannel='client'r hM}r (hO]r hQ]r hS]r hU]r hX]r uhEjr h?]r hXchannel='client'r r }r (hDUhEj ubahKj2ubeubeubj@)r }r (hDUhEj3 hFhhKjChM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r (jK)r }r (hDX6Bases: :class:`circuits.core.components.BaseComponent`r hEj hFjOhKjPhM}r (hO]r hQ]r hS]r hU]r hX]r uhZKh[hh?]r (hXBases: r r }r (hDXBases: r hEj ubhi)r }r (hDX/:class:`circuits.core.components.BaseComponent`r hEj hFhIhKhmhM}r (Ureftyper Xclassr hqhrX&circuits.core.components.BaseComponentr U refdomainr Xpyr hU]r hS]r U refexplicitr hO]r hQ]r hX]r h|h}h~jJ hjkuhZKh?]r h)r }r (hDj hM}r (hO]r hQ]r (hj Xpy-classr ehS]r hU]r hX]r uhEj h?]r hX&circuits.core.components.BaseComponentr r }r (hDUhEj ubahKhubaubeubh)r }r (hDUhEj hFNhKhhM}r (hU]r hS]r hO]r hQ]r hX]r Uentriesr ]r (hX/channel (circuits.net.sockets.Client attribute)h Utr auhZNh[hh?]r ubh)r }r (hDUhEj hFNhKhhM}r (h̉hXpyr hU]r hS]r hO]r hQ]r hX]r hX attributer hj uhZNh[hh?]r (h)r }r (hDXClient.channelr hEj hFU r hKhhM}r (hU]r h ahhGXcircuits.net.socketsr r }r bhS]r hO]r hQ]r hX]r h ahXClient.channelr hjJ huhZNh[hh?]r (j )r }r (hDXchannelr hEj hFj hKjhM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r hXchannelr r }r (hDUhEj ubaubh)r }r (hDX = 'client'r hEj hFj hKhhM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r hX = 'client'r r }r (hDUhEj ubaubeubj@)r }r (hDUhEj hFj hKjChM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r ubeubh)r }r (hDUhEj hFNhKhhM}r! (hU]r" hS]r# hO]r$ hQ]r% hX]r& Uentriesr' ]r( (hX;parse_bind_parameter() (circuits.net.sockets.Client method)h(Utr) auhZNh[hh?]r* ubh)r+ }r, (hDUhEj hFNhKhhM}r- (h̉hXpyr. hU]r/ hS]r0 hO]r1 hQ]r2 hX]r3 hXmethodr4 hj4 uhZNh[hh?]r5 (h)r6 }r7 (hDX+Client.parse_bind_parameter(bind_parameter)r8 hEj+ hFhhKhhM}r9 (hU]r: h(ahhGXcircuits.net.socketsr; r< }r= bhS]r> hO]r? hQ]r@ hX]rA h(ahXClient.parse_bind_parameterrB hjJ huhZNh[hh?]rC (j )rD }rE (hDXparse_bind_parameterrF hEj6 hFhhKjhM}rG (hO]rH hQ]rI hS]rJ hU]rK hX]rL uhZNh[hh?]rM hXparse_bind_parameterrN rO }rP (hDUhEjD ubaubj)rQ }rR (hDUhEj6 hFhhKjhM}rS (hO]rT hQ]rU hS]rV hU]rW hX]rX uhZNh[hh?]rY j$)rZ }r[ (hDXbind_parameterr\ hM}r] (hO]r^ hQ]r_ hS]r` hU]ra hX]rb uhEjQ h?]rc hXbind_parameterrd re }rf (hDUhEjZ ubahKj2ubaubeubj@)rg }rh (hDUhEj+ hFhhKjChM}ri (hO]rj hQ]rk hS]rl hU]rm hX]rn uhZNh[hh?]ro ubeubh)rp }rq (hDUhEj hFNhKhhM}rr (hU]rs hS]rt hO]ru hQ]rv hX]rw Uentriesrx ]ry (hX1connected (circuits.net.sockets.Client attribute)h.Utrz auhZNh[hh?]r{ ubh)r| }r} (hDUhEj hFNhKhhM}r~ (h̉hXpyr hU]r hS]r hO]r hQ]r hX]r hX attributer hj uhZNh[hh?]r (h)r }r (hDXClient.connectedr hEj| hFhhKhhM}r (hU]r h.ahhGXcircuits.net.socketsr r }r bhS]r hO]r hQ]r hX]r h.ahXClient.connectedr hjJ huhZNh[hh?]r j )r }r (hDX connectedr hEj hFhhKjhM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r hX connectedr r }r (hDUhEj ubaubaubj@)r }r (hDUhEj| hFhhKjChM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r ubeubh)r }r (hDUhEj hFNhKhhM}r (hU]r hS]r hO]r hQ]r hX]r Uentriesr ]r (hX,close() (circuits.net.sockets.Client method)hUtr auhZNh[hh?]r ubh)r }r (hDUhEj hFNhKhhM}r (h̉hXpyr hU]r hS]r hO]r hQ]r hX]r hXmethodr hj uhZNh[hh?]r (h)r }r (hDXClient.close()r hEj hFhhKhhM}r (hU]r hahhGXcircuits.net.socketsr r }r bhS]r hO]r hQ]r hX]r hahX Client.closer hjJ huhZNh[hh?]r (j )r }r (hDXcloser hEj hFhhKjhM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r hXcloser r }r (hDUhEj ubaubj)r }r (hDUhEj hFhhKjhM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r ubeubj@)r }r (hDUhEj hFhhKjChM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r ubeubh)r }r (hDUhEj hFNhKhhM}r (hU]r hS]r hO]r hQ]r hX]r Uentriesr ]r (hX,write() (circuits.net.sockets.Client method)h#Utr auhZNh[hh?]r ubh)r }r (hDUhEj hFNhKhhM}r (h̉hXpyr hU]r hS]r hO]r hQ]r hX]r hXmethodr hj uhZNh[hh?]r (h)r }r (hDXClient.write(data)r hEj hFhhKhhM}r (hU]r h#ahhGXcircuits.net.socketsr r }r bhS]r hO]r hQ]r hX]r h#ahX Client.writer hjJ huhZNh[hh?]r (j )r }r (hDXwriter hEj hFhhKjhM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r hXwriter r }r (hDUhEj ubaubj)r! }r" (hDUhEj hFhhKjhM}r# (hO]r$ hQ]r% hS]r& hU]r' hX]r( uhZNh[hh?]r) j$)r* }r+ (hDXdatar, hM}r- (hO]r. hQ]r/ hS]r0 hU]r1 hX]r2 uhEj! h?]r3 hXdatar4 r5 }r6 (hDUhEj* ubahKj2ubaubeubj@)r7 }r8 (hDUhEj hFhhKjChM}r9 (hO]r: hQ]r; hS]r< hU]r= hX]r> uhZNh[hh?]r? ubeubeubeubh)r@ }rA (hDUhEj hFNhKhhM}rB (hU]rC hS]rD hO]rE hQ]rF hX]rG UentriesrH ]rI (hX)TCPClient (class in circuits.net.sockets)hUtrJ auhZNh[hh?]rK ubh)rL }rM (hDUhEj hFNhKhhM}rN (h̉hXpyrO hU]rP hS]rQ hO]rR hQ]rS hX]rT hXclassrU hjU uhZNh[hh?]rV (h)rW }rX (hDX4TCPClient(bind=None, bufsize=4096, channel='client')rY hEjL hFhhKhhM}rZ (hU]r[ hahhGXcircuits.net.socketsr\ r] }r^ bhS]r_ hO]r` hQ]ra hX]rb hahX TCPClientrc hUhuhZNh[hh?]rd (h)re }rf (hDXclass rg hEjW hFhhKhhM}rh (hO]ri hQ]rj hS]rk hU]rl hX]rm uhZNh[hh?]rn hXclass ro rp }rq (hDUhEje ubaubh)rr }rs (hDXcircuits.net.sockets.rt hEjW hFhhKjhM}ru (hO]rv hQ]rw hS]rx hU]ry hX]rz uhZNh[hh?]r{ hXcircuits.net.sockets.r| r} }r~ (hDUhEjr ubaubj )r }r (hDjc hEjW hFhhKjhM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r hX TCPClientr r }r (hDUhEj ubaubj)r }r (hDUhEjW hFhhKjhM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r (j$)r }r (hDX bind=Noner hM}r (hO]r hQ]r hS]r hU]r hX]r uhEj h?]r hX bind=Noner r }r (hDUhEj ubahKj2ubj$)r }r (hDX bufsize=4096r hM}r (hO]r hQ]r hS]r hU]r hX]r uhEj h?]r hX bufsize=4096r r }r (hDUhEj ubahKj2ubj$)r }r (hDXchannel='client'r hM}r (hO]r hQ]r hS]r hU]r hX]r uhEj h?]r hXchannel='client'r r }r (hDUhEj ubahKj2ubeubeubj@)r }r (hDUhEjL hFhhKjChM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r (jK)r }r (hDX+Bases: :class:`circuits.net.sockets.Client`r hEj hFjOhKjPhM}r (hO]r hQ]r hS]r hU]r hX]r uhZKh[hh?]r (hXBases: r r }r (hDXBases: r hEj ubhi)r }r (hDX$:class:`circuits.net.sockets.Client`r hEj hFhIhKhmhM}r (Ureftyper Xclassr hqhrXcircuits.net.sockets.Clientr U refdomainr Xpyr hU]r hS]r U refexplicitr hO]r hQ]r hX]r h|h}h~jc hjkuhZKh?]r h)r }r (hDj hM}r (hO]r hQ]r (hj Xpy-classr ehS]r hU]r hX]r uhEj h?]r hXcircuits.net.sockets.Clientr r }r (hDUhEj ubahKhubaubeubh)r }r (hDUhEj hFNhKhhM}r (hU]r hS]r hO]r hQ]r hX]r Uentriesr ]r (hX8socket_family (circuits.net.sockets.TCPClient attribute)hUtr auhZNh[hh?]r ubh)r }r (hDUhEj hFNhKhhM}r (h̉hXpyr hU]r hS]r hO]r hQ]r hX]r hX attributer hj uhZNh[hh?]r (h)r }r (hDXTCPClient.socket_familyr hEj hFj hKhhM}r (hU]r hahhGXcircuits.net.socketsr r }r bhS]r hO]r hQ]r hX]r hahXTCPClient.socket_familyr hjc huhZNh[hh?]r (j )r }r (hDX socket_familyr hEj hFj hKjhM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r hX socket_familyr r }r (hDUhEj ubaubh)r! }r" (hDX = 2r# hEj hFj hKhhM}r$ (hO]r% hQ]r& hS]r' hU]r( hX]r) uhZNh[hh?]r* hX = 2r+ r, }r- (hDUhEj! ubaubeubj@)r. }r/ (hDUhEj hFj hKjChM}r0 (hO]r1 hQ]r2 hS]r3 hU]r4 hX]r5 uhZNh[hh?]r6 ubeubh)r7 }r8 (hDUhEj hFNhKhhM}r9 (hU]r: hS]r; hO]r< hQ]r= hX]r> Uentriesr? ]r@ (hX1connect() (circuits.net.sockets.TCPClient method)hUtrA auhZNh[hh?]rB ubh)rC }rD (hDUhEj hFNhKhhM}rE (h̉hXpyrF hU]rG hS]rH hO]rI hQ]rJ hX]rK hXmethodrL hjL uhZNh[hh?]rM (h)rN }rO (hDX5TCPClient.connect(host, port, secure=False, **kwargs)rP hEjC hFhhKhhM}rQ (hU]rR hahhGXcircuits.net.socketsrS rT }rU bhS]rV hO]rW hQ]rX hX]rY hahXTCPClient.connectrZ hjc huhZNh[hh?]r[ (j )r\ }r] (hDXconnectr^ hEjN hFhhKjhM}r_ (hO]r` hQ]ra hS]rb hU]rc hX]rd uhZNh[hh?]re hXconnectrf rg }rh (hDUhEj\ ubaubj)ri }rj (hDUhEjN hFhhKjhM}rk (hO]rl hQ]rm hS]rn hU]ro hX]rp uhZNh[hh?]rq (j$)rr }rs (hDXhostrt hM}ru (hO]rv hQ]rw hS]rx hU]ry hX]rz uhEji h?]r{ hXhostr| r} }r~ (hDUhEjr ubahKj2ubj$)r }r (hDXportr hM}r (hO]r hQ]r hS]r hU]r hX]r uhEji h?]r hXportr r }r (hDUhEj ubahKj2ubj$)r }r (hDX secure=Falser hM}r (hO]r hQ]r hS]r hU]r hX]r uhEji h?]r hX secure=Falser r }r (hDUhEj ubahKj2ubj$)r }r (hDX**kwargsr hM}r (hO]r hQ]r hS]r hU]r hX]r uhEji h?]r hX**kwargsr r }r (hDUhEj ubahKj2ubeubeubj@)r }r (hDUhEjC hFhhKjChM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r ubeubeubeubh)r }r (hDUhEj hFUhKhhM}r (hU]r hS]r hO]r hQ]r hX]r Uentriesr ]r (hX*UDPClient (in module circuits.net.sockets)h0Utr auhZNh[hh?]r ubh)r }r (hDUhEj hFUhKhhM}r (h̉hXpyr hU]r hS]r hO]r hQ]r hX]r hX attributer hj uhZNh[hh?]r (h)r }r (hDX UDPClientr hEj hFhhKhhM}r (hU]r h0ahhGXcircuits.net.socketsr r }r bhS]r hO]r hQ]r hX]r h0ahj hUhuhZNh[hh?]r (h)r }r (hDXcircuits.net.sockets.r hEj hFhhKjhM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r hXcircuits.net.sockets.r r }r (hDUhEj ubaubj )r }r (hDj hEj hFhhKjhM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r hX UDPClientr r }r (hDUhEj ubaubeubj@)r }r (hDUhEj hFhhKjChM}r (hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]r jK)r }r (hDXalias of :class:`UDPServer`r hEj hFUhKjPhM}r (hO]r hQ]r hS]r hU]r hX]r uhZKh[hh?]r (hX alias of r r}r(hDX alias of rhEj ubhi)r}r(hDX:class:`UDPServer`rhEj hFhIhKhmhM}r(UreftyperXclassrhqhrX UDPServerr U refdomainr Xpyr hU]r hS]r U refexplicitrhO]rhQ]rhX]rh|h}h~NhjkuhZKh?]rh)r}r(hDjhM}r(hO]rhQ]r(hj Xpy-classrehS]rhU]rhX]ruhEjh?]rhX UDPServerrr}r(hDUhEjubahKhubaubeubaubeubh)r }r!(hDUhEj hFNhKhhM}r"(hU]r#hS]r$hO]r%hQ]r&hX]r'Uentriesr(]r)(hX*UNIXClient (class in circuits.net.sockets)h&Utr*auhZNh[hh?]r+ubh)r,}r-(hDUhEj hFNhKhhM}r.(h̉hXpyr/hU]r0hS]r1hO]r2hQ]r3hX]r4hXclassr5hj5uhZNh[hh?]r6(h)r7}r8(hDX5UNIXClient(bind=None, bufsize=4096, channel='client')r9hEj,hFhhKhhM}r:(hU]r;h&ahhGXcircuits.net.socketsr<r=}r>bhS]r?hO]r@hQ]rAhX]rBh&ahX UNIXClientrChUhuhZNh[hh?]rD(h)rE}rF(hDXclass rGhEj7hFhhKhhM}rH(hO]rIhQ]rJhS]rKhU]rLhX]rMuhZNh[hh?]rNhXclass rOrP}rQ(hDUhEjEubaubh)rR}rS(hDXcircuits.net.sockets.rThEj7hFhhKjhM}rU(hO]rVhQ]rWhS]rXhU]rYhX]rZuhZNh[hh?]r[hXcircuits.net.sockets.r\r]}r^(hDUhEjRubaubj )r_}r`(hDjChEj7hFhhKjhM}ra(hO]rbhQ]rchS]rdhU]rehX]rfuhZNh[hh?]rghX UNIXClientrhri}rj(hDUhEj_ubaubj)rk}rl(hDUhEj7hFhhKjhM}rm(hO]rnhQ]rohS]rphU]rqhX]rruhZNh[hh?]rs(j$)rt}ru(hDX bind=NonervhM}rw(hO]rxhQ]ryhS]rzhU]r{hX]r|uhEjkh?]r}hX bind=Noner~r}r(hDUhEjtubahKj2ubj$)r}r(hDX bufsize=4096rhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjkh?]rhX bufsize=4096rr}r(hDUhEjubahKj2ubj$)r}r(hDXchannel='client'rhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjkh?]rhXchannel='client'rr}r(hDUhEjubahKj2ubeubeubj@)r}r(hDUhEj,hFhhKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]r(jK)r}r(hDX+Bases: :class:`circuits.net.sockets.Client`rhEjhFjOhKjPhM}r(hO]rhQ]rhS]rhU]rhX]ruhZKh[hh?]r(hXBases: rr}r(hDXBases: rhEjubhi)r}r(hDX$:class:`circuits.net.sockets.Client`rhEjhFhIhKhmhM}r(UreftyperXclassrhqhrXcircuits.net.sockets.ClientrU refdomainrXpyrhU]rhS]rU refexplicitrhO]rhQ]rhX]rh|h}h~jChjkuhZKh?]rh)r}r(hDjhM}r(hO]rhQ]r(hjXpy-classrehS]rhU]rhX]ruhEjh?]rhXcircuits.net.sockets.Clientrr}r(hDUhEjubahKhubaubeubh)r}r(hDUhEjhFNhKhhM}r(hU]rhS]rhO]rhQ]rhX]rUentriesr]r(hX0ready() (circuits.net.sockets.UNIXClient method)hUtrauhZNh[hh?]rubh)r}r(hDUhEjhFNhKhhM}r(h̉hXpyrhU]rhS]rhO]rhQ]rhX]rhXmethodrhjuhZNh[hh?]r(h)r}r(hDXUNIXClient.ready(component)rhEjhFhhKhhM}r(hU]rhahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rhahXUNIXClient.readyrhjChuhZNh[hh?]r(j )r}r(hDXreadyrhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXreadyrr}r(hDUhEjubaubj)r}r(hDUhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]r j$)r }r (hDX componentr hM}r (hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhX componentrr}r(hDUhEj ubahKj2ubaubeubj@)r}r(hDUhEjhFhhKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rubeubh)r }r!(hDUhEjhFNhKhhM}r"(hU]r#hS]r$hO]r%hQ]r&hX]r'Uentriesr(]r)(hX2connect() (circuits.net.sockets.UNIXClient method)hUtr*auhZNh[hh?]r+ubh)r,}r-(hDUhEjhFNhKhhM}r.(h̉hXpyr/hU]r0hS]r1hO]r2hQ]r3hX]r4hXmethodr5hj5uhZNh[hh?]r6(h)r7}r8(hDX0UNIXClient.connect(path, secure=False, **kwargs)r9hEj,hFhhKhhM}r:(hU]r;hahhGXcircuits.net.socketsr<r=}r>bhS]r?hO]r@hQ]rAhX]rBhahXUNIXClient.connectrChjChuhZNh[hh?]rD(j )rE}rF(hDXconnectrGhEj7hFhhKjhM}rH(hO]rIhQ]rJhS]rKhU]rLhX]rMuhZNh[hh?]rNhXconnectrOrP}rQ(hDUhEjEubaubj)rR}rS(hDUhEj7hFhhKjhM}rT(hO]rUhQ]rVhS]rWhU]rXhX]rYuhZNh[hh?]rZ(j$)r[}r\(hDXpathr]hM}r^(hO]r_hQ]r`hS]rahU]rbhX]rcuhEjRh?]rdhXpathrerf}rg(hDUhEj[ubahKj2ubj$)rh}ri(hDX secure=FalserjhM}rk(hO]rlhQ]rmhS]rnhU]rohX]rpuhEjRh?]rqhX secure=Falserrrs}rt(hDUhEjhubahKj2ubj$)ru}rv(hDX**kwargsrwhM}rx(hO]ryhQ]rzhS]r{hU]r|hX]r}uhEjRh?]r~hX**kwargsrr}r(hDUhEjuubahKj2ubeubeubj@)r}r(hDUhEj,hFhhKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rubeubeubeubh)r}r(hDUhEj hFNhKhhM}r(hU]rhS]rhO]rhQ]rhX]rUentriesr]r(hX&Server (class in circuits.net.sockets)h UtrauhZNh[hh?]rubh)r}r(hDUhEj hFNhKhhM}r(h̉hXpyrhU]rhS]rhO]rhQ]rhX]rhXclassrhjuhZNh[hh?]r(h)r}r(hDXRServer(bind, secure=False, backlog=5000, bufsize=4096, channel='server', **kwargs)rhEjhFhhKhhM}r(hU]rh ahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rh ahXServerrhUhuhZNh[hh?]r(h)r}r(hDXclass rhEjhFhhKhhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXclass rr}r(hDUhEjubaubh)r}r(hDXcircuits.net.sockets.rhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXcircuits.net.sockets.rr}r(hDUhEjubaubj )r}r(hDjhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXServerrr}r(hDUhEjubaubj)r}r(hDUhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]r(j$)r}r(hDXbindrhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhXbindrr}r(hDUhEjubahKj2ubj$)r}r(hDX secure=FalserhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhX secure=Falserr}r(hDUhEjubahKj2ubj$)r}r(hDX backlog=5000rhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhX backlog=5000rr}r(hDUhEjubahKj2ubj$)r}r(hDX bufsize=4096rhM}r (hO]r hQ]r hS]r hU]r hX]ruhEjh?]rhX bufsize=4096rr}r(hDUhEjubahKj2ubj$)r}r(hDXchannel='server'rhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhXchannel='server'rr}r(hDUhEjubahKj2ubj$)r }r!(hDX**kwargsr"hM}r#(hO]r$hQ]r%hS]r&hU]r'hX]r(uhEjh?]r)hX**kwargsr*r+}r,(hDUhEj ubahKj2ubeubeubj@)r-}r.(hDUhEjhFhhKjChM}r/(hO]r0hQ]r1hS]r2hU]r3hX]r4uhZNh[hh?]r5(jK)r6}r7(hDX6Bases: :class:`circuits.core.components.BaseComponent`r8hEj-hFjOhKjPhM}r9(hO]r:hQ]r;hS]r<hU]r=hX]r>uhZKh[hh?]r?(hXBases: r@rA}rB(hDXBases: rChEj6ubhi)rD}rE(hDX/:class:`circuits.core.components.BaseComponent`rFhEj6hFhIhKhmhM}rG(UreftyperHXclassrIhqhrX&circuits.core.components.BaseComponentrJU refdomainrKXpyrLhU]rMhS]rNU refexplicitrOhO]rPhQ]rQhX]rRh|h}h~jhjkuhZKh?]rSh)rT}rU(hDjFhM}rV(hO]rWhQ]rX(hjLXpy-classrYehS]rZhU]r[hX]r\uhEjDh?]r]hX&circuits.core.components.BaseComponentr^r_}r`(hDUhEjTubahKhubaubeubh)ra}rb(hDUhEj-hFNhKhhM}rc(hU]rdhS]rehO]rfhQ]rghX]rhUentriesri]rj(hX/channel (circuits.net.sockets.Server attribute)hUtrkauhZNh[hh?]rlubh)rm}rn(hDUhEj-hFNhKhhM}ro(h̉hXpyrphU]rqhS]rrhO]rshQ]rthX]ruhX attributervhjvuhZNh[hh?]rw(h)rx}ry(hDXServer.channelrzhEjmhFj hKhhM}r{(hU]r|hahhGXcircuits.net.socketsr}r~}rbhS]rhO]rhQ]rhX]rhahXServer.channelrhjhuhZNh[hh?]r(j )r}r(hDXchannelrhEjxhFj hKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXchannelrr}r(hDUhEjubaubh)r}r(hDX = 'server'rhEjxhFj hKhhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhX = 'server'rr}r(hDUhEjubaubeubj@)r}r(hDUhEjmhFj hKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rubeubh)r}r(hDUhEj-hFNhKhhM}r(hU]rhS]rhO]rhQ]rhX]rUentriesr]r(hX;parse_bind_parameter() (circuits.net.sockets.Server method)hUtrauhZNh[hh?]rubh)r}r(hDUhEj-hFNhKhhM}r(h̉hXpyrhU]rhS]rhO]rhQ]rhX]rhXmethodrhjuhZNh[hh?]r(h)r}r(hDX+Server.parse_bind_parameter(bind_parameter)rhEjhFhhKhhM}r(hU]rhahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rhahXServer.parse_bind_parameterrhjhuhZNh[hh?]r(j )r}r(hDXparse_bind_parameterrhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXparse_bind_parameterrr}r(hDUhEjubaubj)r}r(hDUhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rj$)r}r(hDXbind_parameterrhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhXbind_parameterrr}r(hDUhEjubahKj2ubaubeubj@)r}r(hDUhEjhFhhKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rubeubh)r}r(hDUhEj-hFNhKhhM}r(hU]rhS]rhO]rhQ]rhX]rUentriesr]r(hX1connected (circuits.net.sockets.Server attribute)hUtrauhZNh[hh?]rubh)r}r(hDUhEj-hFNhKhhM}r(h̉hXpyr hU]r hS]r hO]r hQ]r hX]rhX attributerhjuhZNh[hh?]r(h)r}r(hDXServer.connectedrhEjhFhhKhhM}r(hU]rhahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rhahXServer.connectedrhjhuhZNh[hh?]rj )r}r (hDX connectedr!hEjhFhhKjhM}r"(hO]r#hQ]r$hS]r%hU]r&hX]r'uhZNh[hh?]r(hX connectedr)r*}r+(hDUhEjubaubaubj@)r,}r-(hDUhEjhFhhKjChM}r.(hO]r/hQ]r0hS]r1hU]r2hX]r3uhZNh[hh?]r4ubeubh)r5}r6(hDUhEj-hFNhKhhM}r7(hU]r8hS]r9hO]r:hQ]r;hX]r<Uentriesr=]r>(hX,host (circuits.net.sockets.Server attribute)h Utr?auhZNh[hh?]r@ubh)rA}rB(hDUhEj-hFNhKhhM}rC(h̉hXpyrDhU]rEhS]rFhO]rGhQ]rHhX]rIhX attributerJhjJuhZNh[hh?]rK(h)rL}rM(hDX Server.hostrNhEjAhFhhKhhM}rO(hU]rPh ahhGXcircuits.net.socketsrQrR}rSbhS]rThO]rUhQ]rVhX]rWh ahX Server.hostrXhjhuhZNh[hh?]rYj )rZ}r[(hDXhostr\hEjLhFhhKjhM}r](hO]r^hQ]r_hS]r`hU]rahX]rbuhZNh[hh?]rchXhostrdre}rf(hDUhEjZubaubaubj@)rg}rh(hDUhEjAhFhhKjChM}ri(hO]rjhQ]rkhS]rlhU]rmhX]rnuhZNh[hh?]roubeubh)rp}rq(hDUhEj-hFNhKhhM}rr(hU]rshS]rthO]ruhQ]rvhX]rwUentriesrx]ry(hX,port (circuits.net.sockets.Server attribute)h,UtrzauhZNh[hh?]r{ubh)r|}r}(hDUhEj-hFNhKhhM}r~(h̉hXpyrhU]rhS]rhO]rhQ]rhX]rhX attributerhjuhZNh[hh?]r(h)r}r(hDX Server.portrhEj|hFhhKhhM}r(hU]rh,ahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rh,ahX Server.portrhjhuhZNh[hh?]rj )r}r(hDXportrhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXportrr}r(hDUhEjubaubaubj@)r}r(hDUhEj|hFhhKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rubeubh)r}r(hDUhEj-hFNhKhhM}r(hU]rhS]rhO]rhQ]rhX]rUentriesr]r(hX,close() (circuits.net.sockets.Server method)hUtrauhZNh[hh?]rubh)r}r(hDUhEj-hFNhKhhM}r(h̉hXpyrhU]rhS]rhO]rhQ]rhX]rhXmethodrhjuhZNh[hh?]r(h)r}r(hDXServer.close(sock=None)rhEjhFhhKhhM}r(hU]rhahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rhahX Server.closerhjhuhZNh[hh?]r(j )r}r(hDXcloserhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXcloserr}r(hDUhEjubaubj)r}r(hDUhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rj$)r}r(hDX sock=NonerhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhX sock=Nonerr}r(hDUhEjubahKj2ubaubeubj@)r}r(hDUhEjhFhhKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rubeubh)r}r(hDUhEj-hFNhKhhM}r(hU]rhS]rhO]rhQ]rhX]rUentriesr]r(hX,write() (circuits.net.sockets.Server method)hUtrauhZNh[hh?]rubh)r}r (hDUhEj-hFNhKhhM}r (h̉hXpyr hU]r hS]r hO]rhQ]rhX]rhXmethodrhjuhZNh[hh?]r(h)r}r(hDXServer.write(sock, data)rhEjhFhhKhhM}r(hU]rhahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rhahX Server.writerhjhuhZNh[hh?]r (j )r!}r"(hDXwriter#hEjhFhhKjhM}r$(hO]r%hQ]r&hS]r'hU]r(hX]r)uhZNh[hh?]r*hXwriter+r,}r-(hDUhEj!ubaubj)r.}r/(hDUhEjhFhhKjhM}r0(hO]r1hQ]r2hS]r3hU]r4hX]r5uhZNh[hh?]r6(j$)r7}r8(hDXsockr9hM}r:(hO]r;hQ]r<hS]r=hU]r>hX]r?uhEj.h?]r@hXsockrArB}rC(hDUhEj7ubahKj2ubj$)rD}rE(hDXdatarFhM}rG(hO]rHhQ]rIhS]rJhU]rKhX]rLuhEj.h?]rMhXdatarNrO}rP(hDUhEjDubahKj2ubeubeubj@)rQ}rR(hDUhEjhFhhKjChM}rS(hO]rThQ]rUhS]rVhU]rWhX]rXuhZNh[hh?]rYubeubeubeubh)rZ}r[(hDUhEj hFNhKhhM}r\(hU]r]hS]r^hO]r_hQ]r`hX]raUentriesrb]rc(hX)TCPServer (class in circuits.net.sockets)hUtrdauhZNh[hh?]reubh)rf}rg(hDUhEj hFNhKhhM}rh(h̉hXpyrihU]rjhS]rkhO]rlhQ]rmhX]rnhXclassrohjouhZNh[hh?]rp(h)rq}rr(hDXUTCPServer(bind, secure=False, backlog=5000, bufsize=4096, channel='server', **kwargs)rshEjfhFhhKhhM}rt(hU]ruhahhGXcircuits.net.socketsrvrw}rxbhS]ryhO]rzhQ]r{hX]r|hahX TCPServerr}hUhuhZNh[hh?]r~(h)r}r(hDXclass rhEjqhFhhKhhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXclass rr}r(hDUhEjubaubh)r}r(hDXcircuits.net.sockets.rhEjqhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXcircuits.net.sockets.rr}r(hDUhEjubaubj )r}r(hDj}hEjqhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhX TCPServerrr}r(hDUhEjubaubj)r}r(hDUhEjqhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]r(j$)r}r(hDXbindrhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhXbindrr}r(hDUhEjubahKj2ubj$)r}r(hDX secure=FalserhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhX secure=Falserr}r(hDUhEjubahKj2ubj$)r}r(hDX backlog=5000rhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhX backlog=5000rr}r(hDUhEjubahKj2ubj$)r}r(hDX bufsize=4096rhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhX bufsize=4096rr}r(hDUhEjubahKj2ubj$)r}r(hDXchannel='server'rhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhXchannel='server'rr}r(hDUhEjubahKj2ubj$)r}r(hDX**kwargsrhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhX**kwargsrr}r(hDUhEjubahKj2ubeubeubj@)r}r(hDUhEjfhFhhKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]r(jK)r}r(hDX+Bases: :class:`circuits.net.sockets.Server`rhEjhFjOhKjPhM}r(hO]r hQ]r hS]r hU]r hX]r uhZKh[hh?]r(hXBases: rr}r(hDXBases: rhEjubhi)r}r(hDX$:class:`circuits.net.sockets.Server`rhEjhFhIhKhmhM}r(UreftyperXclassrhqhrXcircuits.net.sockets.ServerrU refdomainrXpyrhU]rhS]rU refexplicitrhO]rhQ]r hX]r!h|h}h~j}hjkuhZKh?]r"h)r#}r$(hDjhM}r%(hO]r&hQ]r'(hjXpy-classr(ehS]r)hU]r*hX]r+uhEjh?]r,hXcircuits.net.sockets.Serverr-r.}r/(hDUhEj#ubahKhubaubeubh)r0}r1(hDUhEjhFNhKhhM}r2(hU]r3hS]r4hO]r5hQ]r6hX]r7Uentriesr8]r9(hX8socket_family (circuits.net.sockets.TCPServer attribute)h1Utr:auhZNh[hh?]r;ubh)r<}r=(hDUhEjhFNhKhhM}r>(h̉hXpyr?hU]r@hS]rAhO]rBhQ]rChX]rDhX attributerEhjEuhZNh[hh?]rF(h)rG}rH(hDXTCPServer.socket_familyrIhEj<hFj hKhhM}rJ(hU]rKh1ahhGXcircuits.net.socketsrLrM}rNbhS]rOhO]rPhQ]rQhX]rRh1ahXTCPServer.socket_familyrShj}huhZNh[hh?]rT(j )rU}rV(hDX socket_familyrWhEjGhFj hKjhM}rX(hO]rYhQ]rZhS]r[hU]r\hX]r]uhZNh[hh?]r^hX socket_familyr_r`}ra(hDUhEjUubaubh)rb}rc(hDX = 2rdhEjGhFj hKhhM}re(hO]rfhQ]rghS]rhhU]rihX]rjuhZNh[hh?]rkhX = 2rlrm}rn(hDUhEjbubaubeubj@)ro}rp(hDUhEj<hFj hKjChM}rq(hO]rrhQ]rshS]rthU]ruhX]rvuhZNh[hh?]rwubeubh)rx}ry(hDUhEjhFNhKhhM}rz(hU]r{hS]r|hO]r}hQ]r~hX]rUentriesr]r(hX>parse_bind_parameter() (circuits.net.sockets.TCPServer method)hUtrauhZNh[hh?]rubh)r}r(hDUhEjhFNhKhhM}r(h̉hXpyrhU]rhS]rhO]rhQ]rhX]rhXmethodrhjuhZNh[hh?]r(h)r}r(hDX.TCPServer.parse_bind_parameter(bind_parameter)rhEjhFhhKhhM}r(hU]rhahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rhahXTCPServer.parse_bind_parameterrhj}huhZNh[hh?]r(j )r}r(hDXparse_bind_parameterrhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXparse_bind_parameterrr}r(hDUhEjubaubj)r}r(hDUhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rj$)r}r(hDXbind_parameterrhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhXbind_parameterrr}r(hDUhEjubahKj2ubaubeubj@)r}r(hDUhEjhFhhKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rubeubeubeubh)r}r(hDUhEj hFNhKhhM}r(hU]rhS]rhO]rhQ]rhX]rUentriesr]r(hX)UDPServer (class in circuits.net.sockets)h-UtrauhZNh[hh?]rubh)r}r(hDUhEj hFNhKhhM}r(h̉hXpyrhU]rhS]rhO]rhQ]rhX]rhXclassrhjuhZNh[hh?]r(h)r}r(hDXUUDPServer(bind, secure=False, backlog=5000, bufsize=4096, channel='server', **kwargs)rhEjhFhhKhhM}r(hU]rh-ahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rh-ahX UDPServerrhUhuhZNh[hh?]r(h)r}r(hDXclass rhEjhFhhKhhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXclass rr}r(hDUhEjubaubh)r}r(hDXcircuits.net.sockets.rhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXcircuits.net.sockets.rr}r(hDUhEjubaubj )r}r (hDjhEjhFhhKjhM}r (hO]r hQ]r hS]r hU]rhX]ruhZNh[hh?]rhX UDPServerrr}r(hDUhEjubaubj)r}r(hDUhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]r(j$)r}r(hDXbindrhM}r (hO]r!hQ]r"hS]r#hU]r$hX]r%uhEjh?]r&hXbindr'r(}r)(hDUhEjubahKj2ubj$)r*}r+(hDX secure=Falser,hM}r-(hO]r.hQ]r/hS]r0hU]r1hX]r2uhEjh?]r3hX secure=Falser4r5}r6(hDUhEj*ubahKj2ubj$)r7}r8(hDX backlog=5000r9hM}r:(hO]r;hQ]r<hS]r=hU]r>hX]r?uhEjh?]r@hX backlog=5000rArB}rC(hDUhEj7ubahKj2ubj$)rD}rE(hDX bufsize=4096rFhM}rG(hO]rHhQ]rIhS]rJhU]rKhX]rLuhEjh?]rMhX bufsize=4096rNrO}rP(hDUhEjDubahKj2ubj$)rQ}rR(hDXchannel='server'rShM}rT(hO]rUhQ]rVhS]rWhU]rXhX]rYuhEjh?]rZhXchannel='server'r[r\}r](hDUhEjQubahKj2ubj$)r^}r_(hDX**kwargsr`hM}ra(hO]rbhQ]rchS]rdhU]rehX]rfuhEjh?]rghX**kwargsrhri}rj(hDUhEj^ubahKj2ubeubeubj@)rk}rl(hDUhEjhFhhKjChM}rm(hO]rnhQ]rohS]rphU]rqhX]rruhZNh[hh?]rs(jK)rt}ru(hDX+Bases: :class:`circuits.net.sockets.Server`rvhEjkhFjOhKjPhM}rw(hO]rxhQ]ryhS]rzhU]r{hX]r|uhZKh[hh?]r}(hXBases: r~r}r(hDXBases: rhEjtubhi)r}r(hDX$:class:`circuits.net.sockets.Server`rhEjthFhIhKhmhM}r(UreftyperXclassrhqhrXcircuits.net.sockets.ServerrU refdomainrXpyrhU]rhS]rU refexplicitrhO]rhQ]rhX]rh|h}h~jhjkuhZKh?]rh)r}r(hDjhM}r(hO]rhQ]r(hjXpy-classrehS]rhU]rhX]ruhEjh?]rhXcircuits.net.sockets.Serverrr}r(hDUhEjubahKhubaubeubh)r}r(hDUhEjkhFNhKhhM}r(hU]rhS]rhO]rhQ]rhX]rUentriesr]r(hX8socket_family (circuits.net.sockets.UDPServer attribute)h UtrauhZNh[hh?]rubh)r}r(hDUhEjkhFNhKhhM}r(h̉hXpyrhU]rhS]rhO]rhQ]rhX]rhX attributerhjuhZNh[hh?]r(h)r}r(hDXUDPServer.socket_familyrhEjhFj hKhhM}r(hU]rh ahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rh ahXUDPServer.socket_familyrhjhuhZNh[hh?]r(j )r}r(hDX socket_familyrhEjhFj hKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhX socket_familyrr}r(hDUhEjubaubh)r}r(hDX = 2rhEjhFj hKhhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhX = 2rr}r(hDUhEjubaubeubj@)r}r(hDUhEjhFj hKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rubeubh)r}r(hDUhEjkhFNhKhhM}r(hU]rhS]rhO]rhQ]rhX]rUentriesr]r(hX/close() (circuits.net.sockets.UDPServer method)h)UtrauhZNh[hh?]rubh)r}r(hDUhEjkhFNhKhhM}r(h̉hXpyrhU]rhS]rhO]rhQ]rhX]rhXmethodrhjuhZNh[hh?]r(h)r}r(hDXUDPServer.close()rhEjhFhhKhhM}r(hU]rh)ahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]r h)ahXUDPServer.closer hjhuhZNh[hh?]r (j )r }r (hDXcloserhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXcloserr}r(hDUhEj ubaubj)r}r(hDUhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]r uhZNh[hh?]r!ubeubj@)r"}r#(hDUhEjhFhhKjChM}r$(hO]r%hQ]r&hS]r'hU]r(hX]r)uhZNh[hh?]r*ubeubh)r+}r,(hDUhEjkhFNhKhhM}r-(hU]r.hS]r/hO]r0hQ]r1hX]r2Uentriesr3]r4(hX/write() (circuits.net.sockets.UDPServer method)hUtr5auhZNh[hh?]r6ubh)r7}r8(hDUhEjkhFNhKhhM}r9(h̉hXpyr:hU]r;hS]r<hO]r=hQ]r>hX]r?hXmethodr@hj@uhZNh[hh?]rA(h)rB}rC(hDXUDPServer.write(address, data)rDhEj7hFhhKhhM}rE(hU]rFhahhGXcircuits.net.socketsrGrH}rIbhS]rJhO]rKhQ]rLhX]rMhahXUDPServer.writerNhjhuhZNh[hh?]rO(j )rP}rQ(hDXwriterRhEjBhFhhKjhM}rS(hO]rThQ]rUhS]rVhU]rWhX]rXuhZNh[hh?]rYhXwriterZr[}r\(hDUhEjPubaubj)r]}r^(hDUhEjBhFhhKjhM}r_(hO]r`hQ]rahS]rbhU]rchX]rduhZNh[hh?]re(j$)rf}rg(hDXaddressrhhM}ri(hO]rjhQ]rkhS]rlhU]rmhX]rnuhEj]h?]rohXaddressrprq}rr(hDUhEjfubahKj2ubj$)rs}rt(hDXdataruhM}rv(hO]rwhQ]rxhS]ryhU]rzhX]r{uhEj]h?]r|hXdatar}r~}r(hDUhEjsubahKj2ubeubeubj@)r}r(hDUhEj7hFhhKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rubeubh)r}r(hDUhEjkhFNhKhhM}r(hU]rhS]rhO]rhQ]rhX]rUentriesr]r(hX3broadcast() (circuits.net.sockets.UDPServer method)hUtrauhZNh[hh?]rubh)r}r(hDUhEjkhFNhKhhM}r(h̉hXpyrhU]rhS]rhO]rhQ]rhX]rhXmethodrhjuhZNh[hh?]r(h)r}r(hDXUDPServer.broadcast(data, port)rhEjhFhhKhhM}r(hU]rhahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rhahXUDPServer.broadcastrhjhuhZNh[hh?]r(j )r}r(hDX broadcastrhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhX broadcastrr}r(hDUhEjubaubj)r}r(hDUhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]r(j$)r}r(hDXdatarhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhXdatarr}r(hDUhEjubahKj2ubj$)r}r(hDXportrhM}r(hO]rhQ]rhS]rhU]rhX]ruhEjh?]rhXportrr}r(hDUhEjubahKj2ubeubeubj@)r}r(hDUhEjhFhhKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rubeubeubeubh)r}r(hDUhEj hFjOhKhhM}r(hU]rhS]rhO]rhQ]rhX]rUentriesr]r(hX*UNIXServer (class in circuits.net.sockets)h"UtrauhZNh[hh?]rubh)r}r(hDUhEj hFjOhKhhM}r(h̉hXpyrhU]rhS]rhO]rhQ]rhX]rhXclassrhjuhZNh[hh?]r(h)r}r(hDXVUNIXServer(bind, secure=False, backlog=5000, bufsize=4096, channel='server', **kwargs)rhEjhFhhKhhM}r(hU]rh"ahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]r h"ahX UNIXServerr hUhuhZNh[hh?]r (h)r }r (hDXclass rhEjhFhhKhhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXclass rr}r(hDUhEj ubaubh)r}r(hDXcircuits.net.sockets.rhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]r hX]r!uhZNh[hh?]r"hXcircuits.net.sockets.r#r$}r%(hDUhEjubaubj )r&}r'(hDj hEjhFhhKjhM}r((hO]r)hQ]r*hS]r+hU]r,hX]r-uhZNh[hh?]r.hX UNIXServerr/r0}r1(hDUhEj&ubaubj)r2}r3(hDUhEjhFhhKjhM}r4(hO]r5hQ]r6hS]r7hU]r8hX]r9uhZNh[hh?]r:(j$)r;}r<(hDXbindr=hM}r>(hO]r?hQ]r@hS]rAhU]rBhX]rCuhEj2h?]rDhXbindrErF}rG(hDUhEj;ubahKj2ubj$)rH}rI(hDX secure=FalserJhM}rK(hO]rLhQ]rMhS]rNhU]rOhX]rPuhEj2h?]rQhX secure=FalserRrS}rT(hDUhEjHubahKj2ubj$)rU}rV(hDX backlog=5000rWhM}rX(hO]rYhQ]rZhS]r[hU]r\hX]r]uhEj2h?]r^hX backlog=5000r_r`}ra(hDUhEjUubahKj2ubj$)rb}rc(hDX bufsize=4096rdhM}re(hO]rfhQ]rghS]rhhU]rihX]rjuhEj2h?]rkhX bufsize=4096rlrm}rn(hDUhEjbubahKj2ubj$)ro}rp(hDXchannel='server'rqhM}rr(hO]rshQ]rthS]ruhU]rvhX]rwuhEj2h?]rxhXchannel='server'ryrz}r{(hDUhEjoubahKj2ubj$)r|}r}(hDX**kwargsr~hM}r(hO]rhQ]rhS]rhU]rhX]ruhEj2h?]rhX**kwargsrr}r(hDUhEj|ubahKj2ubeubeubj@)r}r(hDUhEjhFhhKjChM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rjK)r}r(hDX+Bases: :class:`circuits.net.sockets.Server`rhEjhFjOhKjPhM}r(hO]rhQ]rhS]rhU]rhX]ruhZKh[hh?]r(hXBases: rr}r(hDXBases: rhEjubhi)r}r(hDX$:class:`circuits.net.sockets.Server`rhEjhFhIhKhmhM}r(UreftyperXclassrhqhrXcircuits.net.sockets.ServerrU refdomainrXpyrhU]rhS]rU refexplicitrhO]rhQ]rhX]rh|h}h~j hjkuhZKh?]rh)r}r(hDjhM}r(hO]rhQ]r(hjXpy-classrehS]rhU]rhX]ruhEjh?]rhXcircuits.net.sockets.Serverrr}r(hDUhEjubahKhubaubeubaubeubeubhA)r}r(hDUhEhBhFhIhKhLhM}r(hO]rhQ]rhS]rhU]rh;ahX]rhauhZK>h[hh?]r(h])r}r(hDX FunctionsrhEjhFhIhKhahM}r(hO]rhQ]rhS]rhU]rhX]ruhZK>h[hh?]rhX Functionsrr}r(hDjhEjubaubh)r}r(hDUhEjhFX[/home/prologic/work/circuits/circuits/net/sockets.py:docstring of circuits.net.sockets.PiperhKhhM}r(hU]rhS]rhO]rhQ]rhX]rUentriesr]r(hX'Pipe() (in module circuits.net.sockets)h$UtrauhZNh[hh?]rubh)r}r(hDUhEjhFjhKhhM}r(h̉hXpyrhU]rhS]rhO]rhQ]rhX]rhXfunctionrhjuhZNh[hh?]r(h)r}r(hDXPipe(*channels, **kwargs)rhEjhFhhKhhM}r(hU]rh$ahhGXcircuits.net.socketsrr}rbhS]rhO]rhQ]rhX]rh$ahXPiperhUhuhZNh[hh?]r(h)r}r(hDXcircuits.net.sockets.rhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]rhXcircuits.net.sockets.rr}r(hDUhEjubaubj )r}r(hDjhEjhFhhKjhM}r(hO]r hQ]r hS]r hU]r hX]r uhZNh[hh?]rhXPiperr}r(hDUhEjubaubj)r}r(hDUhEjhFhhKjhM}r(hO]rhQ]rhS]rhU]rhX]ruhZNh[hh?]r(j$)r}r(hDX *channelsrhM}r(hO]rhQ]r hS]r!hU]r"hX]r#uhEjh?]r$hX *channelsr%r&}r'(hDUhEjubahKj2ubj$)r(}r)(hDX**kwargsr*hM}r+(hO]r,hQ]r-hS]r.hU]r/hX]r0uhEjh?]r1hX**kwargsr2r3}r4(hDUhEj(ubahKj2ubeubeubj@)r5}r6(hDUhEjhFhhKjChM}r7(hO]r8hQ]r9hS]r:hU]r;hX]r<uhZNh[hh?]r=(jK)r>}r?(hDXCreate a new full duplex Piper@hEj5hFjhKjPhM}rA(hO]rBhQ]rChS]rDhU]rEhX]rFuhZKh[hh?]rGhXCreate a new full duplex PiperHrI}rJ(hDj@hEj>ubaubjK)rK}rL(hDXLReturns a pair of UNIXClient instances connected on either side of the pipe.rMhEj5hFjhKjPhM}rN(hO]rOhQ]rPhS]rQhU]rRhX]rSuhZKh[hh?]rThXLReturns a pair of UNIXClient instances connected on either side of the pipe.rUrV}rW(hDjMhEjKubaubeubeubeubeubahDUU transformerrXNU footnote_refsrY}rZUrefnamesr[}r\Usymbol_footnotesr]]r^Uautofootnote_refsr_]r`Usymbol_footnote_refsra]rbU citationsrc]rdh[hU current_linereNUtransform_messagesrf]rgUreporterrhNUid_startriKU autofootnotesrj]rkU citation_refsrl}rmUindirect_targetsrn]roUsettingsrp(cdocutils.frontend Values rqorr}rs(Ufootnote_backlinksrtKUrecord_dependenciesruNU rfc_base_urlrvUhttp://tools.ietf.org/html/rwU tracebackrxUpep_referencesryNUstrip_commentsrzNU toc_backlinksr{Uentryr|U language_coder}Uenr~U datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNhaNUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUE/home/prologic/work/circuits/docs/source/api/circuits_net_sockets.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hjhjW hjh j~h j hjh jh jLhjhjhjhjhj h;jhjN hjBhj7hjhjxhj}hhhjh h&j7h,jh-jh.j h>j h0j h1jGh=hBuUsubstitution_namesr}rhKh[hM}r(hO]rhU]rhS]rUsourcerhIhQ]rhX]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_io_file.doctree0000644000014400001440000001757412113366657024412 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNXcircuits.io.file.FileqXcircuits.io.file -- file i/oqNX componentsq NXeventsq NuUsubstitution_defsq }q Uparse_messagesq ]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhhhUcircuits-io-file-file-i-oqh U componentsqh UeventsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode q XA/home/prologic/work/circuits/docs/source/api/circuits_io_file.rstq!q"}q#bUtagnameq$Usectionq%U attributesq&}q'(Udupnamesq(]q)Uclassesq*]q+Ubackrefsq,]q-Uidsq.]q/(Xmodule-circuits.io.fileq0heUnamesq1]q2hauUlineq3KUdocumentq4hh]q5(cdocutils.nodes title q6)q7}q8(hX#:mod:`circuits.io.file` -- File I/Oq9hhhh"h$Utitleq:h&}q;(h(]qh.]q?h1]q@uh3Kh4hh]qA(csphinx.addnodes pending_xref qB)qC}qD(hX:mod:`circuits.io.file`qEhh7hh"h$U pending_xrefqFh&}qG(UreftypeqHXmodqIUrefwarnqJU reftargetqKXcircuits.io.fileqLU refdomainqMXpyqNh.]qOh,]qPU refexplicitqQh(]qRh*]qSh1]qTUrefdocqUUapi/circuits_io_fileqVUpy:classqWNU py:moduleqXNuh3Kh]qYcdocutils.nodes literal qZ)q[}q\(hhEh&}q](h(]q^h*]q_(Uxrefq`hNXpy-modqaeh,]qbh.]qch1]qduhhCh]qecdocutils.nodes Text qfXcircuits.io.fileqgqh}qi(hUhh[ubah$UliteralqjubaubhfX -- File I/Oqkql}qm(hX -- File I/Oqnhh7ubeubcsphinx.addnodes index qo)qp}qq(hUhhhh"h$Uindexqrh&}qs(h.]qth,]quh(]qvh*]qwh1]qxUentriesqy]qz(Usingleq{Xcircuits.io.file (module)Xmodule-circuits.io.fileUtq|auh3Kh4hh]q}ubh)q~}q(hUhhhh"h$h%h&}q(h(]qh*]qh,]qh.]qhah1]qh auh3Kh4hh]q(h6)q}q(hXEventsqhh~hh"h$h:h&}q(h(]qh*]qh,]qh.]qh1]quh3Kh4hh]qhfXEventsqq}q(hhhhubaubcdocutils.nodes paragraph q)q}q(hX**none**qhh~hh"h$U paragraphqh&}q(h(]qh*]qh,]qh.]qh1]quh3K h4hh]qcdocutils.nodes strong q)q}q(hhh&}q(h(]qh*]qh,]qh.]qh1]quhhh]qhfXnoneqq}q(hUhhubah$Ustrongqubaubeubh)q}q(hUhhhh"h$h%h&}q(h(]qh*]qh,]qh.]qhah1]qh auh3K h4hh]q(h6)q}q(hX Componentsqhhhh"h$h:h&}q(h(]qh*]qh,]qh.]qh1]quh3K h4hh]qhfX Componentsqq}q(hhhhubaubho)q}q(hUhhhXS/home/prologic/work/circuits/circuits/io/file.py:docstring of circuits.io.file.Fileqh$hrh&}q(h.]qh,]qh(]qh*]qh1]qUentriesq]q(h{X File (class in circuits.io.file)hUtqauh3Nh4hh]qubcsphinx.addnodes desc q)q}q(hUhhhhh$Udescqh&}q(Unoindexq։UdomainqXpyqh.]qh,]qh(]qh*]qh1]qUobjtypeqXclassqUdesctypeqhuh3Nh4hh]q(csphinx.addnodes desc_signature q)q}q(hXFile(*args, **kwargs)qhhhU qh$Udesc_signatureqh&}q(h.]qhaUmoduleqh Xcircuits.io.fileq녁q}qbh,]qh(]qh*]qh1]qhaUfullnameqXFileqUclassqUUfirstquh3Nh4hh]q(csphinx.addnodes desc_annotation q)q}q(hXclass qhhhhh$Udesc_annotationqh&}q(h(]qh*]qh,]qh.]rh1]ruh3Nh4hh]rhfXclass rr}r(hUhhubaubcsphinx.addnodes desc_addname r)r}r(hXcircuits.io.file.r hhhhh$U desc_addnamer h&}r (h(]r h*]r h,]rh.]rh1]ruh3Nh4hh]rhfXcircuits.io.file.rr}r(hUhjubaubcsphinx.addnodes desc_name r)r}r(hhhhhhh$U desc_namerh&}r(h(]rh*]rh,]rh.]rh1]ruh3Nh4hh]rhfXFiler r!}r"(hUhjubaubcsphinx.addnodes desc_parameterlist r#)r$}r%(hUhhhhh$Udesc_parameterlistr&h&}r'(h(]r(h*]r)h,]r*h.]r+h1]r,uh3Nh4hh]r-(csphinx.addnodes desc_parameter r.)r/}r0(hX*argsr1h&}r2(h(]r3h*]r4h,]r5h.]r6h1]r7uhj$h]r8hfX*argsr9r:}r;(hUhj/ubah$Udesc_parameterr<ubj.)r=}r>(hX**kwargsr?h&}r@(h(]rAh*]rBh,]rCh.]rDh1]rEuhj$h]rFhfX**kwargsrGrH}rI(hUhj=ubah$j<ubeubeubcsphinx.addnodes desc_content rJ)rK}rL(hUhhhhh$U desc_contentrMh&}rN(h(]rOh*]rPh,]rQh.]rRh1]rSuh3Nh4hh]rT(h)rU}rV(hX2Bases: :class:`circuits.core.components.Component`rWhjKhU rXh$hh&}rY(h(]rZh*]r[h,]r\h.]r]h1]r^uh3Kh4hh]r_(hfXBases: r`ra}rb(hXBases: rchjUubhB)rd}re(hX+:class:`circuits.core.components.Component`rfhjUhh"h$hFh&}rg(UreftyperhXclassrihJhKX"circuits.core.components.ComponentrjU refdomainrkXpyrlh.]rmh,]rnU refexplicitroh(]rph*]rqh1]rrhUhVhWhhXXcircuits.io.filersuh3Kh]rthZ)ru}rv(hjfh&}rw(h(]rxh*]ry(h`jlXpy-classrzeh,]r{h.]r|h1]r}uhjdh]r~hfX"circuits.core.components.Componentrr}r(hUhjuubah$hjubaubeubh)r}r(hX4initializes x; see x.__class__.__doc__ for signaturerhjKhhh$hh&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]rhfX4initializes x; see x.__class__.__doc__ for signaturerr}r(hjhjubaubeubeubeubh)r}r(hUhhhh"h$h%h&}r(h(]rh*]rh,]rh.]rhah1]rhauh3Kh4hh]r(h6)r}r(hX Functionsrhjhh"h$h:h&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]rhfX Functionsrr}r(hjhjubaubh)r}r(hX**none**rhjhh"h$hh&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]rh)r}r(hjh&}r(h(]rh*]rh,]rh.]rh1]ruhjh]rhfXnonerr}r(hUhjubah$hubaubeubeubahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh4hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh:NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUA/home/prologic/work/circuits/docs/source/api/circuits_io_file.rstr Ugettext_compactr U generatorr NUdump_internalsr NU smart_quotesr U pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hhhjh0cdocutils.nodes target r)r }r!(hUhhhh"h$Utargetr"h&}r#(h(]r$h.]r%h0ah,]r&Uismodr'h*]r(h1]r)uh3Kh4hh]r*ubhhhhhh~uUsubstitution_namesr+}r,h$h4h&}r-(h(]r.h.]r/h,]r0Usourcer1h"h*]r2h1]r3uU footnotesr4]r5Urefidsr6}r7ub.circuits-2.1.0/docs/build/doctrees/api/circuits_io_events.doctree0000644000014400001440000033537212113366657024776 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(Xcircuits.io.events.SeekqXcircuits.io.events.EOFqX functionsqNXcircuits.io.events.Closeq Xcircuits.io.events.Errorq Xcircuits.io.events.Closedq X circuits.io.events -- i/o eventsq NXcircuits.io.events.Readq X componentsqNXcircuits.io.events.WriteqXcircuits.io.events.OpenedqXeventsqNuUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hhhhhU functionsqh h h h h h h Ucircuits-io-events-i-o-eventsqh h hU componentsqhhhhhUeventsquUchildrenq]q cdocutils.nodes section q!)q"}q#(U rawsourceq$UUparentq%hUsourceq&cdocutils.nodes reprunicode q'XC/home/prologic/work/circuits/docs/source/api/circuits_io_events.rstq(q)}q*bUtagnameq+Usectionq,U attributesq-}q.(Udupnamesq/]q0Uclassesq1]q2Ubackrefsq3]q4Uidsq5]q6(Xmodule-circuits.io.eventsq7heUnamesq8]q9h auUlineq:KUdocumentq;hh]q<(cdocutils.nodes title q=)q>}q?(h$X':mod:`circuits.io.events` -- I/O Eventsq@h%h"h&h)h+UtitleqAh-}qB(h/]qCh1]qDh3]qEh5]qFh8]qGuh:Kh;hh]qH(csphinx.addnodes pending_xref qI)qJ}qK(h$X:mod:`circuits.io.events`qLh%h>h&h)h+U pending_xrefqMh-}qN(UreftypeqOXmodqPUrefwarnqQU reftargetqRXcircuits.io.eventsqSU refdomainqTXpyqUh5]qVh3]qWU refexplicitqXh/]qYh1]qZh8]q[Urefdocq\Uapi/circuits_io_eventsq]Upy:classq^NU py:moduleq_Nuh:Kh]q`cdocutils.nodes literal qa)qb}qc(h$hLh-}qd(h/]qeh1]qf(UxrefqghUXpy-modqheh3]qih5]qjh8]qkuh%hJh]qlcdocutils.nodes Text qmXcircuits.io.eventsqnqo}qp(h$Uh%hbubah+UliteralqqubaubhmX -- I/O Eventsqrqs}qt(h$X -- I/O Eventsquh%h>ubeubcsphinx.addnodes index qv)qw}qx(h$Uh%h"h&h)h+Uindexqyh-}qz(h5]q{h3]q|h/]q}h1]q~h8]qUentriesq]q(UsingleqXcircuits.io.events (module)Xmodule-circuits.io.eventsUtqauh:Kh;hh]qubh!)q}q(h$Uh%h"h&h)h+h,h-}q(h/]qh1]qh3]qh5]qhah8]qhauh:Kh;hh]q(h=)q}q(h$XEventsqh%hh&h)h+hAh-}q(h/]qh1]qh3]qh5]qh8]quh:Kh;hh]qhmXEventsqq}q(h$hh%hubaubhv)q}q(h$Uh%hh&Nh+hyh-}q(h5]qh3]qh/]qh1]qh8]qUentriesq]q(hX#Close (class in circuits.io.events)h Utqauh:Nh;hh]qubcsphinx.addnodes desc q)q}q(h$Uh%hh&Nh+Udescqh-}q(UnoindexqUdomainqXpyqh5]qh3]qh/]qh1]qh8]qUobjtypeqXclassqUdesctypeqhuh:Nh;hh]q(csphinx.addnodes desc_signature q)q}q(h$XClose(*args, **kwargs)qh%hh&U qh+Udesc_signatureqh-}q(h5]qh aUmoduleqh'Xcircuits.io.eventsqq}qbh3]qh/]qh1]qh8]qh aUfullnameqXCloseqUclassqUUfirstqˉuh:Nh;hh]q(csphinx.addnodes desc_annotation q)q}q(h$Xclass qh%hh&hh+Udesc_annotationqh-}q(h/]qh1]qh3]qh5]qh8]quh:Nh;hh]qhmXclass qمq}q(h$Uh%hubaubcsphinx.addnodes desc_addname q)q}q(h$Xcircuits.io.events.qh%hh&hh+U desc_addnameqh-}q(h/]qh1]qh3]qh5]qh8]quh:Nh;hh]qhmXcircuits.io.events.q腁q}q(h$Uh%hubaubcsphinx.addnodes desc_name q)q}q(h$hh%hh&hh+U desc_nameqh-}q(h/]qh1]qh3]qh5]qh8]quh:Nh;hh]qhmXCloseqq}q(h$Uh%hubaubcsphinx.addnodes desc_parameterlist q)q}q(h$Uh%hh&hh+Udesc_parameterlistqh-}q(h/]qh1]qh3]rh5]rh8]ruh:Nh;hh]r(csphinx.addnodes desc_parameter r)r}r(h$X*argsrh-}r(h/]r h1]r h3]r h5]r h8]r uh%hh]rhmX*argsrr}r(h$Uh%jubah+Udesc_parameterrubj)r}r(h$X**kwargsrh-}r(h/]rh1]rh3]rh5]rh8]ruh%hh]rhmX**kwargsrr}r(h$Uh%jubah+jubeubeubcsphinx.addnodes desc_content r )r!}r"(h$Uh%hh&hh+U desc_contentr#h-}r$(h/]r%h1]r&h3]r'h5]r(h8]r)uh:Nh;hh]r*(cdocutils.nodes paragraph r+)r,}r-(h$X*Bases: :class:`circuits.core.events.Event`r.h%j!h&U r/h+U paragraphr0h-}r1(h/]r2h1]r3h3]r4h5]r5h8]r6uh:Kh;hh]r7(hmXBases: r8r9}r:(h$XBases: r;h%j,ubhI)r<}r=(h$X#:class:`circuits.core.events.Event`r>h%j,h&h)h+hMh-}r?(Ureftyper@XclassrAhQhRXcircuits.core.events.EventrBU refdomainrCXpyrDh5]rEh3]rFU refexplicitrGh/]rHh1]rIh8]rJh\h]h^hh_Xcircuits.io.eventsrKuh:Kh]rLha)rM}rN(h$j>h-}rO(h/]rPh1]rQ(hgjDXpy-classrReh3]rSh5]rTh8]rUuh%j<h]rVhmXcircuits.core.events.EventrWrX}rY(h$Uh%jMubah+hqubaubeubj+)rZ}r[(h$X Close Eventr\h%j!h&XX/home/prologic/work/circuits/circuits/io/events.py:docstring of circuits.io.events.Closer]h+j0h-}r^(h/]r_h1]r`h3]rah5]rbh8]rcuh:Kh;hh]rdhmX Close Eventrerf}rg(h$j\h%jZubaubj+)rh}ri(h$XAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rjh%j!h&j]h+j0h-}rk(h/]rlh1]rmh3]rnh5]roh8]rpuh:Kh;hh]rqhmXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rrrs}rt(h$jjh%jhubaubj+)ru}rv(h$XAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rwh%j!h&j]h+j0h-}rx(h/]ryh1]rzh3]r{h5]r|h8]r}uh:Kh;hh]r~hmXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rr}r(h$jwh%juubaubj+)r}r(h$XEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh%j!h&j]h+j0h-}r(h/]rh1]rh3]rh5]rh8]ruh:K h;hh]r(hmXEvery event has a rr}r(h$XEvery event has a rh%jubhI)r}r(h$X :attr:`name`rh%jh&h)h+hMh-}r(UreftyperXattrrhQhRXnamerU refdomainrXpyrh5]rh3]rU refexplicitrh/]rh1]rh8]rh\h]h^hh_jKuh:Kh]rha)r}r(h$jh-}r(h/]rh1]r(hgjXpy-attrreh3]rh5]rh8]ruh%jh]rhmXnamerr}r(h$Uh%jubah+hqubaubhmX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(h$X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh%jubeubcdocutils.nodes field_list r)r}r(h$Uh%j!h&Nh+U field_listrh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rcdocutils.nodes field r)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(cdocutils.nodes field_name r)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX Variablesrr}r(h$Uh%jubah+U field_namerubcdocutils.nodes field_body r)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rcdocutils.nodes bullet_list r)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(cdocutils.nodes list_item r)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperUobjrU reftargetrXchannelsrU refdomainrhh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]r cdocutils.nodes strong r )r }r (h$jh-}r (h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXchannelsrr}r(h$Uh%j ubah+Ustrongrubah+hMubhmX -- rr}r(h$Uh%jubj+)r}r(h$Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rh%jh&j]h+j0h-}r(h/]rh1]r h3]r!h5]r"h8]r#uh:Kh]r$hmXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r%r&}r'(h$jh%jubaubj+)r(}r)(h$XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r*h%jh&j]h+j0h-}r+(h/]r,h1]r-h3]r.h5]r/h8]r0uh:Kh]r1hmXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r2r3}r4(h$j*h%j(ubaubeh+j0ubah+U list_itemr5ubj)r6}r7(h$Uh-}r8(h/]r9h1]r:h3]r;h5]r<h8]r=uh%jh]r>j+)r?}r@(h$Uh-}rA(h/]rBh1]rCh3]rDh5]rEh8]rFuh%j6h]rG(hI)rH}rI(h$Uh-}rJ(UreftyperKjU reftargetrLXvaluerMU refdomainrNhh5]rOh3]rPU refexplicitrQh/]rRh1]rSh8]rTuh%j?h]rUj )rV}rW(h$jMh-}rX(h/]rYh1]rZh3]r[h5]r\h8]r]uh%jHh]r^hmXvaluer_r`}ra(h$Uh%jVubah+jubah+hMubhmX -- rbrc}rd(h$Uh%j?ubhmX this is a rerf}rg(h$X this is a rhh%j?ubhI)ri}rj(h$X#:class:`circuits.core.values.Value`rkh%j?h&h)h+hMh-}rl(UreftypermXclassrnhQhRXcircuits.core.values.ValueroU refdomainrpXpyrqh5]rrh3]rsU refexplicitrth/]ruh1]rvh8]rwh\h]h^hh_jKuh:K!h]rxha)ry}rz(h$jkh-}r{(h/]r|h1]r}(hgjqXpy-classr~eh3]rh5]rh8]ruh%jih]rhmXcircuits.core.values.Valuerr}r(h$Uh%jyubah+hqubaubhmXN object that holds the results returned by the handlers invoked for the event.rr}r(h$XN object that holds the results returned by the handlers invoked for the event.rh%j?ubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXsuccessrU refdomainrhh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXsuccessrr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jubhmX%if this optional attribute is set to rr}r(h$X%if this optional attribute is set to rh%jubha)r}r(h$X``True``rh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXTruerr}r(h$Uh%jubah+hqubhmX, an associated event rr}r(h$X, an associated event rh%jubha)r}r(h$X``EventSuccess``rh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX EventSuccessrr}r(h$Uh%jubah+hqubhmX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(h$X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh%jubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrhh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXsuccess_channelsrr }r (h$Uh%jubah+jubah+hMubhmX -- r r }r (h$Uh%jubhmXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h$Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh%jubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]r h5]r!h8]r"uh%jh]r#(hI)r$}r%(h$Uh-}r&(Ureftyper'jU reftargetr(Xcompleter)U refdomainr*hh5]r+h3]r,U refexplicitr-h/]r.h1]r/h8]r0uh%jh]r1j )r2}r3(h$j)h-}r4(h/]r5h1]r6h3]r7h5]r8h8]r9uh%j$h]r:hmXcompleter;r<}r=(h$Uh%j2ubah+jubah+hMubhmX -- r>r?}r@(h$Uh%jubhmX%if this optional attribute is set to rArB}rC(h$X%if this optional attribute is set to rDh%jubha)rE}rF(h$X``True``rGh-}rH(h/]rIh1]rJh3]rKh5]rLh8]rMuh%jh]rNhmXTruerOrP}rQ(h$Uh%jEubah+hqubhmX, an associated event rRrS}rT(h$X, an associated event rUh%jubha)rV}rW(h$X``EventComplete``rXh-}rY(h/]rZh1]r[h3]r\h5]r]h8]r^uh%jh]r_hmX EventCompleter`ra}rb(h$Uh%jVubah+hqubhmX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rcrd}re(h$X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rfh%jubeh+j0ubah+j5ubj)rg}rh(h$Uh-}ri(h/]rjh1]rkh3]rlh5]rmh8]rnuh%jh]roj+)rp}rq(h$Uh-}rr(h/]rsh1]rth3]ruh5]rvh8]rwuh%jgh]rx(hI)ry}rz(h$Uh-}r{(Ureftyper|jU reftargetr}Xsuccess_channelsr~U refdomainrhh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jph]rj )r}r(h$j~h-}r(h/]rh1]rh3]rh5]rh8]ruh%jyh]rhmXsuccess_channelsrr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jpubhmXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h$Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh%jpubeh+j0ubah+j5ubeh+U bullet_listrubah+U field_bodyrubeh+Ufieldrubaubeubeubhv)r}r(h$Uh%hh&Nh+hyh-}r(h5]rh3]rh/]rh1]rh8]rUentriesr]r(hX$Closed (class in circuits.io.events)h Utrauh:Nh;hh]rubh)r}r(h$Uh%hh&Nh+hh-}r(hhXpyrh5]rh3]rh/]rh1]rh8]rhXclassrhjuh:Nh;hh]r(h)r}r(h$XClosed(*args, **kwargs)rh%jh&hh+hh-}r(h5]rh ahh'Xcircuits.io.eventsrr}rbh3]rh/]rh1]rh8]rh ahXClosedrhUhˉuh:Nh;hh]r(h)r}r(h$Xclass rh%jh&hh+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXclass rr}r(h$Uh%jubaubh)r}r(h$Xcircuits.io.events.rh%jh&hh+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXcircuits.io.events.rr}r(h$Uh%jubaubh)r}r(h$jh%jh&hh+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXClosedrr}r(h$Uh%jubaubh)r}r(h$Uh%jh&hh+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]r(j)r}r(h$X*argsrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX*argsrr}r(h$Uh%jubah+jubj)r}r(h$X**kwargsrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX**kwargsrr }r (h$Uh%jubah+jubeubeubj )r }r (h$Uh%jh&hh+j#h-}r (h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]r(j+)r}r(h$X*Bases: :class:`circuits.core.events.Event`rh%j h&j/h+j0h-}r(h/]rh1]rh3]rh5]rh8]ruh:Kh;hh]r(hmXBases: rr}r (h$XBases: r!h%jubhI)r"}r#(h$X#:class:`circuits.core.events.Event`r$h%jh&h)h+hMh-}r%(Ureftyper&Xclassr'hQhRXcircuits.core.events.Eventr(U refdomainr)Xpyr*h5]r+h3]r,U refexplicitr-h/]r.h1]r/h8]r0h\h]h^jh_jKuh:Kh]r1ha)r2}r3(h$j$h-}r4(h/]r5h1]r6(hgj*Xpy-classr7eh3]r8h5]r9h8]r:uh%j"h]r;hmXcircuits.core.events.Eventr<r=}r>(h$Uh%j2ubah+hqubaubeubj+)r?}r@(h$X Closed EventrAh%j h&XY/home/prologic/work/circuits/circuits/io/events.py:docstring of circuits.io.events.ClosedrBh+j0h-}rC(h/]rDh1]rEh3]rFh5]rGh8]rHuh:Kh;hh]rIhmX Closed EventrJrK}rL(h$jAh%j?ubaubj+)rM}rN(h$XAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rOh%j h&jBh+j0h-}rP(h/]rQh1]rRh3]rSh5]rTh8]rUuh:Kh;hh]rVhmXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rWrX}rY(h$jOh%jMubaubj+)rZ}r[(h$XAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.r\h%j h&jBh+j0h-}r](h/]r^h1]r_h3]r`h5]rah8]rbuh:Kh;hh]rchmXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rdre}rf(h$j\h%jZubaubj+)rg}rh(h$XEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rih%j h&jBh+j0h-}rj(h/]rkh1]rlh3]rmh5]rnh8]rouh:K h;hh]rp(hmXEvery event has a rqrr}rs(h$XEvery event has a rth%jgubhI)ru}rv(h$X :attr:`name`rwh%jgh&h)h+hMh-}rx(UreftyperyXattrrzhQhRXnamer{U refdomainr|Xpyr}h5]r~h3]rU refexplicitrh/]rh1]rh8]rh\h]h^jh_jKuh:Kh]rha)r}r(h$jwh-}r(h/]rh1]r(hgj}Xpy-attrreh3]rh5]rh8]ruh%juh]rhmXnamerr}r(h$Uh%jubah+hqubaubhmX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(h$X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh%jgubeubj)r}r(h$Uh%j h&Nh+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX Variablesrr}r(h$Uh%jubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXchannelsrU refdomainrjh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXchannelsrr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jubj+)r}r(h$Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rh%jh&jBh+j0h-}r(h/]rh1]rh3]rh5]rh8]ruh:Kh]rhmXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rr}r(h$jh%jubaubj+)r}r(h$XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rh%jh&jBh+j0h-}r(h/]rh1]rh3]rh5]r h8]r uh:Kh]r hmXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r r }r(h$jh%jubaubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r (hI)r!}r"(h$Uh-}r#(Ureftyper$jU reftargetr%Xvaluer&U refdomainr'jh5]r(h3]r)U refexplicitr*h/]r+h1]r,h8]r-uh%jh]r.j )r/}r0(h$j&h-}r1(h/]r2h1]r3h3]r4h5]r5h8]r6uh%j!h]r7hmXvaluer8r9}r:(h$Uh%j/ubah+jubah+hMubhmX -- r;r<}r=(h$Uh%jubhmX this is a r>r?}r@(h$X this is a rAh%jubhI)rB}rC(h$X#:class:`circuits.core.values.Value`rDh%jh&h)h+hMh-}rE(UreftyperFXclassrGhQhRXcircuits.core.values.ValuerHU refdomainrIXpyrJh5]rKh3]rLU refexplicitrMh/]rNh1]rOh8]rPh\h]h^jh_jKuh:K!h]rQha)rR}rS(h$jDh-}rT(h/]rUh1]rV(hgjJXpy-classrWeh3]rXh5]rYh8]rZuh%jBh]r[hmXcircuits.core.values.Valuer\r]}r^(h$Uh%jRubah+hqubaubhmXN object that holds the results returned by the handlers invoked for the event.r_r`}ra(h$XN object that holds the results returned by the handlers invoked for the event.rbh%jubeh+j0ubah+j5ubj)rc}rd(h$Uh-}re(h/]rfh1]rgh3]rhh5]rih8]rjuh%jh]rkj+)rl}rm(h$Uh-}rn(h/]roh1]rph3]rqh5]rrh8]rsuh%jch]rt(hI)ru}rv(h$Uh-}rw(UreftyperxjU reftargetryXsuccessrzU refdomainr{jh5]r|h3]r}U refexplicitr~h/]rh1]rh8]ruh%jlh]rj )r}r(h$jzh-}r(h/]rh1]rh3]rh5]rh8]ruh%juh]rhmXsuccessrr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jlubhmX%if this optional attribute is set to rr}r(h$X%if this optional attribute is set to rh%jlubha)r}r(h$X``True``rh-}r(h/]rh1]rh3]rh5]rh8]ruh%jlh]rhmXTruerr}r(h$Uh%jubah+hqubhmX, an associated event rr}r(h$X, an associated event rh%jlubha)r}r(h$X``EventSuccess``rh-}r(h/]rh1]rh3]rh5]rh8]ruh%jlh]rhmX EventSuccessrr}r(h$Uh%jubah+hqubhmX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(h$X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh%jlubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrjh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXsuccess_channelsrr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jubhmXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h$Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh%jubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXcompleterU refdomainrjh5]rh3]rU refexplicitrh/]rh1]rh8]r uh%jh]r j )r }r (h$jh-}r (h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXcompleterr}r(h$Uh%j ubah+jubah+hMubhmX -- rr}r(h$Uh%jubhmX%if this optional attribute is set to rr}r(h$X%if this optional attribute is set to rh%jubha)r}r(h$X``True``r h-}r!(h/]r"h1]r#h3]r$h5]r%h8]r&uh%jh]r'hmXTruer(r)}r*(h$Uh%jubah+hqubhmX, an associated event r+r,}r-(h$X, an associated event r.h%jubha)r/}r0(h$X``EventComplete``r1h-}r2(h/]r3h1]r4h3]r5h5]r6h8]r7uh%jh]r8hmX EventCompleter9r:}r;(h$Uh%j/ubah+hqubhmX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r<r=}r>(h$X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r?h%jubeh+j0ubah+j5ubj)r@}rA(h$Uh-}rB(h/]rCh1]rDh3]rEh5]rFh8]rGuh%jh]rHj+)rI}rJ(h$Uh-}rK(h/]rLh1]rMh3]rNh5]rOh8]rPuh%j@h]rQ(hI)rR}rS(h$Uh-}rT(UreftyperUjU reftargetrVXsuccess_channelsrWU refdomainrXjh5]rYh3]rZU refexplicitr[h/]r\h1]r]h8]r^uh%jIh]r_j )r`}ra(h$jWh-}rb(h/]rch1]rdh3]reh5]rfh8]rguh%jRh]rhhmXsuccess_channelsrirj}rk(h$Uh%j`ubah+jubah+hMubhmX -- rlrm}rn(h$Uh%jIubhmXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rorp}rq(h$Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rrh%jIubeh+j0ubah+j5ubeh+jubah+jubeh+jubaubeubeubhv)rs}rt(h$Uh%hh&Nh+hyh-}ru(h5]rvh3]rwh/]rxh1]ryh8]rzUentriesr{]r|(hX!EOF (class in circuits.io.events)hUtr}auh:Nh;hh]r~ubh)r}r(h$Uh%hh&Nh+hh-}r(hhXpyrh5]rh3]rh/]rh1]rh8]rhXclassrhjuh:Nh;hh]r(h)r}r(h$XEOF(*args, **kwargs)rh%jh&hh+hh-}r(h5]rhahh'Xcircuits.io.eventsrr}rbh3]rh/]rh1]rh8]rhahXEOFrhUhˉuh:Nh;hh]r(h)r}r(h$Xclass rh%jh&hh+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXclass rr}r(h$Uh%jubaubh)r}r(h$Xcircuits.io.events.rh%jh&hh+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXcircuits.io.events.rr}r(h$Uh%jubaubh)r}r(h$jh%jh&hh+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXEOFrr}r(h$Uh%jubaubh)r}r(h$Uh%jh&hh+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]r(j)r}r(h$X*argsrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX*argsrr}r(h$Uh%jubah+jubj)r}r(h$X**kwargsrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX**kwargsrr}r(h$Uh%jubah+jubeubeubj )r}r(h$Uh%jh&hh+j#h-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]r(j+)r}r(h$X*Bases: :class:`circuits.core.events.Event`rh%jh&j/h+j0h-}r(h/]rh1]rh3]rh5]rh8]ruh:Kh;hh]r(hmXBases: rr}r(h$XBases: rh%jubhI)r}r(h$X#:class:`circuits.core.events.Event`rh%jh&h)h+hMh-}r(UreftyperXclassrhQhRXcircuits.core.events.EventrU refdomainrXpyrh5]rh3]rU refexplicitrh/]rh1]rh8]rh\h]h^jh_jKuh:Kh]rha)r}r (h$jh-}r (h/]r h1]r (hgjXpy-classr eh3]rh5]rh8]ruh%jh]rhmXcircuits.core.events.Eventrr}r(h$Uh%jubah+hqubaubeubj+)r}r(h$X EOF Eventrh%jh&XV/home/prologic/work/circuits/circuits/io/events.py:docstring of circuits.io.events.EOFrh+j0h-}r(h/]rh1]rh3]rh5]rh8]ruh:Kh;hh]rhmX EOF Eventr r!}r"(h$jh%jubaubj+)r#}r$(h$XAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.r%h%jh&jh+j0h-}r&(h/]r'h1]r(h3]r)h5]r*h8]r+uh:Kh;hh]r,hmXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.r-r.}r/(h$j%h%j#ubaubj+)r0}r1(h$XAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.r2h%jh&jh+j0h-}r3(h/]r4h1]r5h3]r6h5]r7h8]r8uh:Kh;hh]r9hmXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.r:r;}r<(h$j2h%j0ubaubj+)r=}r>(h$XEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.r?h%jh&jh+j0h-}r@(h/]rAh1]rBh3]rCh5]rDh8]rEuh:K h;hh]rF(hmXEvery event has a rGrH}rI(h$XEvery event has a rJh%j=ubhI)rK}rL(h$X :attr:`name`rMh%j=h&h)h+hMh-}rN(UreftyperOXattrrPhQhRXnamerQU refdomainrRXpyrSh5]rTh3]rUU refexplicitrVh/]rWh1]rXh8]rYh\h]h^jh_jKuh:Kh]rZha)r[}r\(h$jMh-}r](h/]r^h1]r_(hgjSXpy-attrr`eh3]rah5]rbh8]rcuh%jKh]rdhmXnamererf}rg(h$Uh%j[ubah+hqubaubhmX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rhri}rj(h$X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rkh%j=ubeubj)rl}rm(h$Uh%jh&Nh+jh-}rn(h/]roh1]rph3]rqh5]rrh8]rsuh:Nh;hh]rtj)ru}rv(h$Uh-}rw(h/]rxh1]ryh3]rzh5]r{h8]r|uh%jlh]r}(j)r~}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%juh]rhmX Variablesrr}r(h$Uh%j~ubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%juh]rj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXchannelsrU refdomainrjh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXchannelsrr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jubj+)r}r(h$Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rh%jh&jh+j0h-}r(h/]rh1]rh3]rh5]rh8]ruh:Kh]rhmXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rr}r(h$jh%jubaubj+)r}r(h$XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rh%jh&jh+j0h-}r(h/]rh1]rh3]rh5]rh8]ruh:Kh]rhmXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rr}r(h$jh%jubaubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXvaluerU refdomainrjh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj )r}r(h$jh-}r(h/]rh1]r h3]r h5]r h8]r uh%jh]r hmXvaluerr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jubhmX this is a rr}r(h$X this is a rh%jubhI)r}r(h$X#:class:`circuits.core.values.Value`rh%jh&h)h+hMh-}r(UreftyperXclassrhQhRXcircuits.core.values.ValuerU refdomainrXpyr h5]r!h3]r"U refexplicitr#h/]r$h1]r%h8]r&h\h]h^jh_jKuh:K!h]r'ha)r(}r)(h$jh-}r*(h/]r+h1]r,(hgj Xpy-classr-eh3]r.h5]r/h8]r0uh%jh]r1hmXcircuits.core.values.Valuer2r3}r4(h$Uh%j(ubah+hqubaubhmXN object that holds the results returned by the handlers invoked for the event.r5r6}r7(h$XN object that holds the results returned by the handlers invoked for the event.r8h%jubeh+j0ubah+j5ubj)r9}r:(h$Uh-}r;(h/]r<h1]r=h3]r>h5]r?h8]r@uh%jh]rAj+)rB}rC(h$Uh-}rD(h/]rEh1]rFh3]rGh5]rHh8]rIuh%j9h]rJ(hI)rK}rL(h$Uh-}rM(UreftyperNjU reftargetrOXsuccessrPU refdomainrQjh5]rRh3]rSU refexplicitrTh/]rUh1]rVh8]rWuh%jBh]rXj )rY}rZ(h$jPh-}r[(h/]r\h1]r]h3]r^h5]r_h8]r`uh%jKh]rahmXsuccessrbrc}rd(h$Uh%jYubah+jubah+hMubhmX -- rerf}rg(h$Uh%jBubhmX%if this optional attribute is set to rhri}rj(h$X%if this optional attribute is set to rkh%jBubha)rl}rm(h$X``True``rnh-}ro(h/]rph1]rqh3]rrh5]rsh8]rtuh%jBh]ruhmXTruervrw}rx(h$Uh%jlubah+hqubhmX, an associated event ryrz}r{(h$X, an associated event r|h%jBubha)r}}r~(h$X``EventSuccess``rh-}r(h/]rh1]rh3]rh5]rh8]ruh%jBh]rhmX EventSuccessrr}r(h$Uh%j}ubah+hqubhmX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(h$X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh%jBubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrjh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXsuccess_channelsrr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jubhmXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h$Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh%jubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXcompleterU refdomainrjh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXcompleterr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jubhmX%if this optional attribute is set to rr}r(h$X%if this optional attribute is set to rh%jubha)r}r(h$X``True``rh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXTruerr}r (h$Uh%jubah+hqubhmX, an associated event r r }r (h$X, an associated event r h%jubha)r }r (h$X``EventComplete``r h-}r (h/]r h1]r h3]r h5]r h8]r uh%jh]r hmX EventCompleter r }r (h$Uh%j ubah+hqubhmX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r r }r (h$X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r h%jubeh+j0ubah+j5ubj)r }r (h$Uh-}r (h/]r h1]r h3]r h5]r h8]r uh%jh]r j+)r }r (h$Uh-}r! (h/]r" h1]r# h3]r$ h5]r% h8]r& uh%j h]r' (hI)r( }r) (h$Uh-}r* (Ureftyper+ jU reftargetr, Xsuccess_channelsr- U refdomainr. jh5]r/ h3]r0 U refexplicitr1 h/]r2 h1]r3 h8]r4 uh%j h]r5 j )r6 }r7 (h$j- h-}r8 (h/]r9 h1]r: h3]r; h5]r< h8]r= uh%j( h]r> hmXsuccess_channelsr? r@ }rA (h$Uh%j6 ubah+jubah+hMubhmX -- rB rC }rD (h$Uh%j ubhmXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rE rF }rG (h$Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rH h%j ubeh+j0ubah+j5ubeh+jubah+jubeh+jubaubeubeubhv)rI }rJ (h$Uh%hh&Nh+hyh-}rK (h5]rL h3]rM h/]rN h1]rO h8]rP UentriesrQ ]rR (hX#Error (class in circuits.io.events)h UtrS auh:Nh;hh]rT ubh)rU }rV (h$Uh%hh&Nh+hh-}rW (hhXpyrX h5]rY h3]rZ h/]r[ h1]r\ h8]r] hXclassr^ hj^ uh:Nh;hh]r_ (h)r` }ra (h$XError(*args, **kwargs)rb h%jU h&hh+hh-}rc (h5]rd h ahh'Xcircuits.io.eventsre rf }rg bh3]rh h/]ri h1]rj h8]rk h ahXErrorrl hUhˉuh:Nh;hh]rm (h)rn }ro (h$Xclass rp h%j` h&hh+hh-}rq (h/]rr h1]rs h3]rt h5]ru h8]rv uh:Nh;hh]rw hmXclass rx ry }rz (h$Uh%jn ubaubh)r{ }r| (h$Xcircuits.io.events.r} h%j` h&hh+hh-}r~ (h/]r h1]r h3]r h5]r h8]r uh:Nh;hh]r hmXcircuits.io.events.r r }r (h$Uh%j{ ubaubh)r }r (h$jl h%j` h&hh+hh-}r (h/]r h1]r h3]r h5]r h8]r uh:Nh;hh]r hmXErrorr r }r (h$Uh%j ubaubh)r }r (h$Uh%j` h&hh+hh-}r (h/]r h1]r h3]r h5]r h8]r uh:Nh;hh]r (j)r }r (h$X*argsr h-}r (h/]r h1]r h3]r h5]r h8]r uh%j h]r hmX*argsr r }r (h$Uh%j ubah+jubj)r }r (h$X**kwargsr h-}r (h/]r h1]r h3]r h5]r h8]r uh%j h]r hmX**kwargsr r }r (h$Uh%j ubah+jubeubeubj )r }r (h$Uh%jU h&hh+j#h-}r (h/]r h1]r h3]r h5]r h8]r uh:Nh;hh]r (j+)r }r (h$X*Bases: :class:`circuits.core.events.Event`r h%j h&j/h+j0h-}r (h/]r h1]r h3]r h5]r h8]r uh:Kh;hh]r (hmXBases: r r }r (h$XBases: r h%j ubhI)r }r (h$X#:class:`circuits.core.events.Event`r h%j h&h)h+hMh-}r (Ureftyper Xclassr hQhRXcircuits.core.events.Eventr U refdomainr Xpyr h5]r h3]r U refexplicitr h/]r h1]r h8]r h\h]h^jl h_jKuh:Kh]r ha)r }r (h$j h-}r (h/]r h1]r (hgj Xpy-classr eh3]r h5]r h8]r uh%j h]r hmXcircuits.core.events.Eventr r }r (h$Uh%j ubah+hqubaubeubj+)r }r (h$X Error Eventr h%j h&XX/home/prologic/work/circuits/circuits/io/events.py:docstring of circuits.io.events.Errorr h+j0h-}r (h/]r h1]r h3]r h5]r h8]r uh:Kh;hh]r hmX Error Eventr r }r (h$j h%j ubaubj+)r }r (h$XAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.r h%j h&j h+j0h-}r (h/]r h1]r h3]r h5]r h8]r uh:Kh;hh]r hmXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.r r }r (h$j h%j ubaubj+)r }r (h$XAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.r h%j h&j h+j0h-}r (h/]r h1]r h3]r h5]r h8]r uh:Kh;hh]r hmXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.r r }r (h$j h%j ubaubj+)r }r (h$XEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.r h%j h&j h+j0h-}r (h/]r h1]r h3]r h5]r h8]r uh:K h;hh]r (hmXEvery event has a r r }r (h$XEvery event has a r h%j ubhI)r! }r" (h$X :attr:`name`r# h%j h&h)h+hMh-}r$ (Ureftyper% Xattrr& hQhRXnamer' U refdomainr( Xpyr) h5]r* h3]r+ U refexplicitr, h/]r- h1]r. h8]r/ h\h]h^jl h_jKuh:Kh]r0 ha)r1 }r2 (h$j# h-}r3 (h/]r4 h1]r5 (hgj) Xpy-attrr6 eh3]r7 h5]r8 h8]r9 uh%j! h]r: hmXnamer; r< }r= (h$Uh%j1 ubah+hqubaubhmX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.r> r? }r@ (h$X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rA h%j ubeubj)rB }rC (h$Uh%j h&Nh+jh-}rD (h/]rE h1]rF h3]rG h5]rH h8]rI uh:Nh;hh]rJ j)rK }rL (h$Uh-}rM (h/]rN h1]rO h3]rP h5]rQ h8]rR uh%jB h]rS (j)rT }rU (h$Uh-}rV (h/]rW h1]rX h3]rY h5]rZ h8]r[ uh%jK h]r\ hmX Variablesr] r^ }r_ (h$Uh%jT ubah+jubj)r` }ra (h$Uh-}rb (h/]rc h1]rd h3]re h5]rf h8]rg uh%jK h]rh j)ri }rj (h$Uh-}rk (h/]rl h1]rm h3]rn h5]ro h8]rp uh%j` h]rq (j)rr }rs (h$Uh-}rt (h/]ru h1]rv h3]rw h5]rx h8]ry uh%ji h]rz j+)r{ }r| (h$Uh-}r} (h/]r~ h1]r h3]r h5]r h8]r uh%jr h]r (hI)r }r (h$Uh-}r (Ureftyper jU reftargetr Xchannelsr U refdomainr jX h5]r h3]r U refexplicitr h/]r h1]r h8]r uh%j{ h]r j )r }r (h$j h-}r (h/]r h1]r h3]r h5]r h8]r uh%j h]r hmXchannelsr r }r (h$Uh%j ubah+jubah+hMubhmX -- r r }r (h$Uh%j{ ubj+)r }r (h$Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r h%j{ h&j h+j0h-}r (h/]r h1]r h3]r h5]r h8]r uh:Kh]r hmXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r r }r (h$j h%j ubaubj+)r }r (h$XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r h%j{ h&j h+j0h-}r (h/]r h1]r h3]r h5]r h8]r uh:Kh]r hmXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r r }r (h$j h%j ubaubeh+j0ubah+j5ubj)r }r (h$Uh-}r (h/]r h1]r h3]r h5]r h8]r uh%ji h]r j+)r }r (h$Uh-}r (h/]r h1]r h3]r h5]r h8]r uh%j h]r (hI)r }r (h$Uh-}r (Ureftyper jU reftargetr Xvaluer U refdomainr jX h5]r h3]r U refexplicitr h/]r h1]r h8]r uh%j h]r j )r }r (h$j h-}r (h/]r h1]r h3]r h5]r h8]r uh%j h]r hmXvaluer r }r (h$Uh%j ubah+jubah+hMubhmX -- r r }r (h$Uh%j ubhmX this is a r r }r (h$X this is a r h%j ubhI)r }r (h$X#:class:`circuits.core.values.Value`r h%j h&h)h+hMh-}r (Ureftyper Xclassr hQhRXcircuits.core.values.Valuer U refdomainr Xpyr h5]r h3]r U refexplicitr h/]r h1]r h8]r h\h]h^jl h_jKuh:K!h]r ha)r }r (h$j h-}r (h/]r h1]r (hgj Xpy-classr eh3]r h5]r h8]r uh%j h]r hmXcircuits.core.values.Valuer r }r (h$Uh%j ubah+hqubaubhmXN object that holds the results returned by the handlers invoked for the event.r r }r (h$XN object that holds the results returned by the handlers invoked for the event.r h%j ubeh+j0ubah+j5ubj)r }r (h$Uh-}r (h/]r h1]r h3]r h5]r h8]r uh%ji h]r j+)r }r (h$Uh-}r (h/]r h1]r h3]r h5]r h8]r uh%j h]r (hI)r! }r" (h$Uh-}r# (Ureftyper$ jU reftargetr% Xsuccessr& U refdomainr' jX h5]r( h3]r) U refexplicitr* h/]r+ h1]r, h8]r- uh%j h]r. j )r/ }r0 (h$j& h-}r1 (h/]r2 h1]r3 h3]r4 h5]r5 h8]r6 uh%j! h]r7 hmXsuccessr8 r9 }r: (h$Uh%j/ ubah+jubah+hMubhmX -- r; r< }r= (h$Uh%j ubhmX%if this optional attribute is set to r> r? }r@ (h$X%if this optional attribute is set to rA h%j ubha)rB }rC (h$X``True``rD h-}rE (h/]rF h1]rG h3]rH h5]rI h8]rJ uh%j h]rK hmXTruerL rM }rN (h$Uh%jB ubah+hqubhmX, an associated event rO rP }rQ (h$X, an associated event rR h%j ubha)rS }rT (h$X``EventSuccess``rU h-}rV (h/]rW h1]rX h3]rY h5]rZ h8]r[ uh%j h]r\ hmX EventSuccessr] r^ }r_ (h$Uh%jS ubah+hqubhmX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.r` ra }rb (h$X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rc h%j ubeh+j0ubah+j5ubj)rd }re (h$Uh-}rf (h/]rg h1]rh h3]ri h5]rj h8]rk uh%ji h]rl j+)rm }rn (h$Uh-}ro (h/]rp h1]rq h3]rr h5]rs h8]rt uh%jd h]ru (hI)rv }rw (h$Uh-}rx (Ureftypery jU reftargetrz Xsuccess_channelsr{ U refdomainr| jX h5]r} h3]r~ U refexplicitr h/]r h1]r h8]r uh%jm h]r j )r }r (h$j{ h-}r (h/]r h1]r h3]r h5]r h8]r uh%jv h]r hmXsuccess_channelsr r }r (h$Uh%j ubah+jubah+hMubhmX -- r r }r (h$Uh%jm ubhmXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r r }r (h$Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r h%jm ubeh+j0ubah+j5ubj)r }r (h$Uh-}r (h/]r h1]r h3]r h5]r h8]r uh%ji h]r j+)r }r (h$Uh-}r (h/]r h1]r h3]r h5]r h8]r uh%j h]r (hI)r }r (h$Uh-}r (Ureftyper jU reftargetr Xcompleter U refdomainr jX h5]r h3]r U refexplicitr h/]r h1]r h8]r uh%j h]r j )r }r (h$j h-}r (h/]r h1]r h3]r h5]r h8]r uh%j h]r hmXcompleter r }r (h$Uh%j ubah+jubah+hMubhmX -- r r }r (h$Uh%j ubhmX%if this optional attribute is set to r r }r (h$X%if this optional attribute is set to r h%j ubha)r }r (h$X``True``r h-}r (h/]r h1]r h3]r h5]r h8]r uh%j h]r hmXTruer r }r (h$Uh%j ubah+hqubhmX, an associated event r r }r (h$X, an associated event r h%j ubha)r }r (h$X``EventComplete``r h-}r (h/]r h1]r h3]r h5]r h8]r uh%j h]r hmX EventCompleter r }r (h$Uh%j ubah+hqubhmX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r r }r (h$X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r h%j ubeh+j0ubah+j5ubj)r }r (h$Uh-}r (h/]r h1]r h3]r h5]r h8]r uh%ji h]r j+)r }r (h$Uh-}r (h/]r h1]r h3]r h5]r h8]r uh%j h]r (hI)r }r (h$Uh-}r (Ureftyper jU reftargetr Xsuccess_channelsr U refdomainr jX h5]r h3]r U refexplicitr h/]r h1]r h8]r uh%j h]r j )r }r (h$j h-}r (h/]r h1]r h3]r h5]r h8]r uh%j h]r hmXsuccess_channelsr r }r (h$Uh%j ubah+jubah+hMubhmX -- r r }r (h$Uh%j ubhmXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r r }r (h$Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r h%j ubeh+j0ubah+j5ubeh+jubah+jubeh+jubaubeubeubhv)r }r (h$Uh%hh&Nh+hyh-}r! (h5]r" h3]r# h/]r$ h1]r% h8]r& Uentriesr' ]r( (hX$Opened (class in circuits.io.events)hUtr) auh:Nh;hh]r* ubh)r+ }r, (h$Uh%hh&Nh+hh-}r- (hhXpyr. h5]r/ h3]r0 h/]r1 h1]r2 h8]r3 hXclassr4 hj4 uh:Nh;hh]r5 (h)r6 }r7 (h$XOpened(*args, **kwargs)r8 h%j+ h&hh+hh-}r9 (h5]r: hahh'Xcircuits.io.eventsr; r< }r= bh3]r> h/]r? h1]r@ h8]rA hahXOpenedrB hUhˉuh:Nh;hh]rC (h)rD }rE (h$Xclass rF h%j6 h&hh+hh-}rG (h/]rH h1]rI h3]rJ h5]rK h8]rL uh:Nh;hh]rM hmXclass rN rO }rP (h$Uh%jD ubaubh)rQ }rR (h$Xcircuits.io.events.rS h%j6 h&hh+hh-}rT (h/]rU h1]rV h3]rW h5]rX h8]rY uh:Nh;hh]rZ hmXcircuits.io.events.r[ r\ }r] (h$Uh%jQ ubaubh)r^ }r_ (h$jB h%j6 h&hh+hh-}r` (h/]ra h1]rb h3]rc h5]rd h8]re uh:Nh;hh]rf hmXOpenedrg rh }ri (h$Uh%j^ ubaubh)rj }rk (h$Uh%j6 h&hh+hh-}rl (h/]rm h1]rn h3]ro h5]rp h8]rq uh:Nh;hh]rr (j)rs }rt (h$X*argsru h-}rv (h/]rw h1]rx h3]ry h5]rz h8]r{ uh%jj h]r| hmX*argsr} r~ }r (h$Uh%js ubah+jubj)r }r (h$X**kwargsr h-}r (h/]r h1]r h3]r h5]r h8]r uh%jj h]r hmX**kwargsr r }r (h$Uh%j ubah+jubeubeubj )r }r (h$Uh%j+ h&hh+j#h-}r (h/]r h1]r h3]r h5]r h8]r uh:Nh;hh]r (j+)r }r (h$X*Bases: :class:`circuits.core.events.Event`r h%j h&j/h+j0h-}r (h/]r h1]r h3]r h5]r h8]r uh:Kh;hh]r (hmXBases: r r }r (h$XBases: r h%j ubhI)r }r (h$X#:class:`circuits.core.events.Event`r h%j h&h)h+hMh-}r (Ureftyper Xclassr hQhRXcircuits.core.events.Eventr U refdomainr Xpyr h5]r h3]r U refexplicitr h/]r h1]r h8]r h\h]h^jB h_jKuh:Kh]r ha)r }r (h$j h-}r (h/]r h1]r (hgj Xpy-classr eh3]r h5]r h8]r uh%j h]r hmXcircuits.core.events.Eventr r }r (h$Uh%j ubah+hqubaubeubj+)r }r (h$X Opened Eventr h%j h&XY/home/prologic/work/circuits/circuits/io/events.py:docstring of circuits.io.events.Openedr h+j0h-}r (h/]r h1]r h3]r h5]r h8]r uh:Kh;hh]r hmX Opened Eventr r }r (h$j h%j ubaubj+)r }r (h$XAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.r h%j h&j h+j0h-}r (h/]r h1]r h3]r h5]r h8]r uh:Kh;hh]r hmXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.r r }r (h$j h%j ubaubj+)r }r (h$XAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.r h%j h&j h+j0h-}r (h/]r h1]r h3]r h5]r h8]r uh:Kh;hh]r hmXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.r r }r (h$j h%j ubaubj+)r }r (h$XEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.r h%j h&j h+j0h-}r (h/]r h1]r h3]r h5]r h8]r uh:K h;hh]r (hmXEvery event has a r r }r (h$XEvery event has a r h%j ubhI)r }r (h$X :attr:`name`r h%j h&h)h+hMh-}r (Ureftyper Xattrr hQhRXnamer U refdomainr Xpyr h5]r h3]r U refexplicitr h/]r h1]r h8]r h\h]h^jB h_jKuh:Kh]r ha)r }r (h$j h-}r (h/]r h1]r (hgj Xpy-attrr eh3]r h5]r h8]r uh%j h]r hmXnamer r }r (h$Uh%j ubah+hqubaubhmX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.r r }r (h$X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.r h%j ubeubj)r }r (h$Uh%j h&Nh+jh-}r (h/]r h1]r h3]r h5]r h8]r uh:Nh;hh]r j)r! }r" (h$Uh-}r# (h/]r$ h1]r% h3]r& h5]r' h8]r( uh%j h]r) (j)r* }r+ (h$Uh-}r, (h/]r- h1]r. h3]r/ h5]r0 h8]r1 uh%j! h]r2 hmX Variablesr3 r4 }r5 (h$Uh%j* ubah+jubj)r6 }r7 (h$Uh-}r8 (h/]r9 h1]r: h3]r; h5]r< h8]r= uh%j! h]r> j)r? }r@ (h$Uh-}rA (h/]rB h1]rC h3]rD h5]rE h8]rF uh%j6 h]rG (j)rH }rI (h$Uh-}rJ (h/]rK h1]rL h3]rM h5]rN h8]rO uh%j? h]rP j+)rQ }rR (h$Uh-}rS (h/]rT h1]rU h3]rV h5]rW h8]rX uh%jH h]rY (hI)rZ }r[ (h$Uh-}r\ (Ureftyper] jU reftargetr^ Xchannelsr_ U refdomainr` j. h5]ra h3]rb U refexplicitrc h/]rd h1]re h8]rf uh%jQ h]rg j )rh }ri (h$j_ h-}rj (h/]rk h1]rl h3]rm h5]rn h8]ro uh%jZ h]rp hmXchannelsrq rr }rs (h$Uh%jh ubah+jubah+hMubhmX -- rt ru }rv (h$Uh%jQ ubj+)rw }rx (h$Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.ry h%jQ h&j h+j0h-}rz (h/]r{ h1]r| h3]r} h5]r~ h8]r uh:Kh]r hmXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r r }r (h$jy h%jw ubaubj+)r }r (h$XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r h%jQ h&j h+j0h-}r (h/]r h1]r h3]r h5]r h8]r uh:Kh]r hmXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r r }r (h$j h%j ubaubeh+j0ubah+j5ubj)r }r (h$Uh-}r (h/]r h1]r h3]r h5]r h8]r uh%j? h]r j+)r }r (h$Uh-}r (h/]r h1]r h3]r h5]r h8]r uh%j h]r (hI)r }r (h$Uh-}r (Ureftyper jU reftargetr Xvaluer U refdomainr j. h5]r h3]r U refexplicitr h/]r h1]r h8]r uh%j h]r j )r }r (h$j h-}r (h/]r h1]r h3]r h5]r h8]r uh%j h]r hmXvaluer r }r (h$Uh%j ubah+jubah+hMubhmX -- r r }r (h$Uh%j ubhmX this is a r r }r (h$X this is a r h%j ubhI)r }r (h$X#:class:`circuits.core.values.Value`r h%j h&h)h+hMh-}r (Ureftyper Xclassr hQhRXcircuits.core.values.Valuer U refdomainr Xpyr h5]r h3]r U refexplicitr h/]r h1]r h8]r h\h]h^jB h_jKuh:K!h]r ha)r }r (h$j h-}r (h/]r h1]r (hgj Xpy-classr eh3]r h5]r h8]r uh%j h]r hmXcircuits.core.values.Valuer r }r (h$Uh%j ubah+hqubaubhmXN object that holds the results returned by the handlers invoked for the event.r r }r (h$XN object that holds the results returned by the handlers invoked for the event.r h%j ubeh+j0ubah+j5ubj)r }r (h$Uh-}r (h/]r h1]r h3]r h5]r h8]r uh%j? h]r j+)r }r (h$Uh-}r (h/]r h1]r h3]r h5]r h8]r uh%j h]r (hI)r }r (h$Uh-}r (Ureftyper jU reftargetr Xsuccessr U refdomainr j. h5]r h3]r U refexplicitrh/]rh1]rh8]ruh%j h]rj )r}r(h$j h-}r(h/]rh1]r h3]r h5]r h8]r uh%j h]r hmXsuccessrr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%j ubhmX%if this optional attribute is set to rr}r(h$X%if this optional attribute is set to rh%j ubha)r}r(h$X``True``rh-}r(h/]rh1]rh3]rh5]rh8]r uh%j h]r!hmXTruer"r#}r$(h$Uh%jubah+hqubhmX, an associated event r%r&}r'(h$X, an associated event r(h%j ubha)r)}r*(h$X``EventSuccess``r+h-}r,(h/]r-h1]r.h3]r/h5]r0h8]r1uh%j h]r2hmX EventSuccessr3r4}r5(h$Uh%j)ubah+hqubhmX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.r6r7}r8(h$X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.r9h%j ubeh+j0ubah+j5ubj)r:}r;(h$Uh-}r<(h/]r=h1]r>h3]r?h5]r@h8]rAuh%j? h]rBj+)rC}rD(h$Uh-}rE(h/]rFh1]rGh3]rHh5]rIh8]rJuh%j:h]rK(hI)rL}rM(h$Uh-}rN(UreftyperOjU reftargetrPXsuccess_channelsrQU refdomainrRj. h5]rSh3]rTU refexplicitrUh/]rVh1]rWh8]rXuh%jCh]rYj )rZ}r[(h$jQh-}r\(h/]r]h1]r^h3]r_h5]r`h8]rauh%jLh]rbhmXsuccess_channelsrcrd}re(h$Uh%jZubah+jubah+hMubhmX -- rfrg}rh(h$Uh%jCubhmXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rirj}rk(h$Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rlh%jCubeh+j0ubah+j5ubj)rm}rn(h$Uh-}ro(h/]rph1]rqh3]rrh5]rsh8]rtuh%j? h]ruj+)rv}rw(h$Uh-}rx(h/]ryh1]rzh3]r{h5]r|h8]r}uh%jmh]r~(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXcompleterU refdomainrj. h5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jvh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXcompleterr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jvubhmX%if this optional attribute is set to rr}r(h$X%if this optional attribute is set to rh%jvubha)r}r(h$X``True``rh-}r(h/]rh1]rh3]rh5]rh8]ruh%jvh]rhmXTruerr}r(h$Uh%jubah+hqubhmX, an associated event rr}r(h$X, an associated event rh%jvubha)r}r(h$X``EventComplete``rh-}r(h/]rh1]rh3]rh5]rh8]ruh%jvh]rhmX EventCompleterr}r(h$Uh%jubah+hqubhmX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rr}r(h$X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rh%jvubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%j? h]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrj. h5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXsuccess_channelsrr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jubhmXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h$Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh%jubeh+j0ubah+j5ubeh+jubah+jubeh+jubaubeubeubhv)r}r(h$Uh%hh&Nh+hyh-}r(h5]rh3]rh/]rh1]rh8]rUentriesr]r(hX"Read (class in circuits.io.events)h Utrauh:Nh;hh]rubh)r}r(h$Uh%hh&Nh+hh-}r(hhXpyrh5]rh3]rh/]rh1]rh8]r hXclassr hj uh:Nh;hh]r (h)r }r (h$XRead(*args, **kwargs)rh%jh&hh+hh-}r(h5]rh ahh'Xcircuits.io.eventsrr}rbh3]rh/]rh1]rh8]rh ahXReadrhUhˉuh:Nh;hh]r(h)r}r(h$Xclass rh%j h&hh+hh-}r(h/]rh1]rh3]r h5]r!h8]r"uh:Nh;hh]r#hmXclass r$r%}r&(h$Uh%jubaubh)r'}r((h$Xcircuits.io.events.r)h%j h&hh+hh-}r*(h/]r+h1]r,h3]r-h5]r.h8]r/uh:Nh;hh]r0hmXcircuits.io.events.r1r2}r3(h$Uh%j'ubaubh)r4}r5(h$jh%j h&hh+hh-}r6(h/]r7h1]r8h3]r9h5]r:h8]r;uh:Nh;hh]r<hmXReadr=r>}r?(h$Uh%j4ubaubh)r@}rA(h$Uh%j h&hh+hh-}rB(h/]rCh1]rDh3]rEh5]rFh8]rGuh:Nh;hh]rH(j)rI}rJ(h$X*argsrKh-}rL(h/]rMh1]rNh3]rOh5]rPh8]rQuh%j@h]rRhmX*argsrSrT}rU(h$Uh%jIubah+jubj)rV}rW(h$X**kwargsrXh-}rY(h/]rZh1]r[h3]r\h5]r]h8]r^uh%j@h]r_hmX**kwargsr`ra}rb(h$Uh%jVubah+jubeubeubj )rc}rd(h$Uh%jh&hh+j#h-}re(h/]rfh1]rgh3]rhh5]rih8]rjuh:Nh;hh]rk(j+)rl}rm(h$X*Bases: :class:`circuits.core.events.Event`rnh%jch&j/h+j0h-}ro(h/]rph1]rqh3]rrh5]rsh8]rtuh:Kh;hh]ru(hmXBases: rvrw}rx(h$XBases: ryh%jlubhI)rz}r{(h$X#:class:`circuits.core.events.Event`r|h%jlh&h)h+hMh-}r}(Ureftyper~XclassrhQhRXcircuits.core.events.EventrU refdomainrXpyrh5]rh3]rU refexplicitrh/]rh1]rh8]rh\h]h^jh_jKuh:Kh]rha)r}r(h$j|h-}r(h/]rh1]r(hgjXpy-classreh3]rh5]rh8]ruh%jzh]rhmXcircuits.core.events.Eventrr}r(h$Uh%jubah+hqubaubeubj+)r}r(h$X Read Eventrh%jch&XW/home/prologic/work/circuits/circuits/io/events.py:docstring of circuits.io.events.Readrh+j0h-}r(h/]rh1]rh3]rh5]rh8]ruh:Kh;hh]rhmX Read Eventrr}r(h$jh%jubaubj+)r}r(h$XAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rh%jch&jh+j0h-}r(h/]rh1]rh3]rh5]rh8]ruh:Kh;hh]rhmXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rr}r(h$jh%jubaubj+)r}r(h$XAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rh%jch&jh+j0h-}r(h/]rh1]rh3]rh5]rh8]ruh:Kh;hh]rhmXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rr}r(h$jh%jubaubj+)r}r(h$XEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh%jch&jh+j0h-}r(h/]rh1]rh3]rh5]rh8]ruh:K h;hh]r(hmXEvery event has a rr}r(h$XEvery event has a rh%jubhI)r}r(h$X :attr:`name`rh%jh&h)h+hMh-}r(UreftyperXattrrhQhRXnamerU refdomainrXpyrh5]rh3]rU refexplicitrh/]rh1]rh8]rh\h]h^jh_jKuh:Kh]rha)r}r(h$jh-}r(h/]rh1]r(hgjXpy-attrreh3]rh5]rh8]ruh%jh]rhmXnamerr}r(h$Uh%jubah+hqubaubhmX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(h$X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh%jubeubj)r}r(h$Uh%jch&Nh+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX Variablesr r }r (h$Uh%jubah+jubj)r }r (h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%j h]r(j)r}r(h$Uh-}r (h/]r!h1]r"h3]r#h5]r$h8]r%uh%jh]r&j+)r'}r((h$Uh-}r)(h/]r*h1]r+h3]r,h5]r-h8]r.uh%jh]r/(hI)r0}r1(h$Uh-}r2(Ureftyper3jU reftargetr4Xchannelsr5U refdomainr6jh5]r7h3]r8U refexplicitr9h/]r:h1]r;h8]r<uh%j'h]r=j )r>}r?(h$j5h-}r@(h/]rAh1]rBh3]rCh5]rDh8]rEuh%j0h]rFhmXchannelsrGrH}rI(h$Uh%j>ubah+jubah+hMubhmX -- rJrK}rL(h$Uh%j'ubj+)rM}rN(h$Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rOh%j'h&jh+j0h-}rP(h/]rQh1]rRh3]rSh5]rTh8]rUuh:Kh]rVhmXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rWrX}rY(h$jOh%jMubaubj+)rZ}r[(h$XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r\h%j'h&jh+j0h-}r](h/]r^h1]r_h3]r`h5]rah8]rbuh:Kh]rchmXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rdre}rf(h$j\h%jZubaubeh+j0ubah+j5ubj)rg}rh(h$Uh-}ri(h/]rjh1]rkh3]rlh5]rmh8]rnuh%jh]roj+)rp}rq(h$Uh-}rr(h/]rsh1]rth3]ruh5]rvh8]rwuh%jgh]rx(hI)ry}rz(h$Uh-}r{(Ureftyper|jU reftargetr}Xvaluer~U refdomainrjh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jph]rj )r}r(h$j~h-}r(h/]rh1]rh3]rh5]rh8]ruh%jyh]rhmXvaluerr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jpubhmX this is a rr}r(h$X this is a rh%jpubhI)r}r(h$X#:class:`circuits.core.values.Value`rh%jph&h)h+hMh-}r(UreftyperXclassrhQhRXcircuits.core.values.ValuerU refdomainrXpyrh5]rh3]rU refexplicitrh/]rh1]rh8]rh\h]h^jh_jKuh:K!h]rha)r}r(h$jh-}r(h/]rh1]r(hgjXpy-classreh3]rh5]rh8]ruh%jh]rhmXcircuits.core.values.Valuerr}r(h$Uh%jubah+hqubaubhmXN object that holds the results returned by the handlers invoked for the event.rr}r(h$XN object that holds the results returned by the handlers invoked for the event.rh%jpubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXsuccessrU refdomainrjh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXsuccessrr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jubhmX%if this optional attribute is set to rr}r(h$X%if this optional attribute is set to rh%jubha)r}r(h$X``True``rh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXTruerr}r(h$Uh%jubah+hqubhmX, an associated event rr}r(h$X, an associated event rh%jubha)r}r(h$X``EventSuccess``rh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX EventSuccessr r }r (h$Uh%jubah+hqubhmX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.r r }r(h$X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh%jubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]r uh%jh]r!(hI)r"}r#(h$Uh-}r$(Ureftyper%jU reftargetr&Xsuccess_channelsr'U refdomainr(jh5]r)h3]r*U refexplicitr+h/]r,h1]r-h8]r.uh%jh]r/j )r0}r1(h$j'h-}r2(h/]r3h1]r4h3]r5h5]r6h8]r7uh%j"h]r8hmXsuccess_channelsr9r:}r;(h$Uh%j0ubah+jubah+hMubhmX -- r<r=}r>(h$Uh%jubhmXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r?r@}rA(h$Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rBh%jubeh+j0ubah+j5ubj)rC}rD(h$Uh-}rE(h/]rFh1]rGh3]rHh5]rIh8]rJuh%jh]rKj+)rL}rM(h$Uh-}rN(h/]rOh1]rPh3]rQh5]rRh8]rSuh%jCh]rT(hI)rU}rV(h$Uh-}rW(UreftyperXjU reftargetrYXcompleterZU refdomainr[jh5]r\h3]r]U refexplicitr^h/]r_h1]r`h8]rauh%jLh]rbj )rc}rd(h$jZh-}re(h/]rfh1]rgh3]rhh5]rih8]rjuh%jUh]rkhmXcompleterlrm}rn(h$Uh%jcubah+jubah+hMubhmX -- rorp}rq(h$Uh%jLubhmX%if this optional attribute is set to rrrs}rt(h$X%if this optional attribute is set to ruh%jLubha)rv}rw(h$X``True``rxh-}ry(h/]rzh1]r{h3]r|h5]r}h8]r~uh%jLh]rhmXTruerr}r(h$Uh%jvubah+hqubhmX, an associated event rr}r(h$X, an associated event rh%jLubha)r}r(h$X``EventComplete``rh-}r(h/]rh1]rh3]rh5]rh8]ruh%jLh]rhmX EventCompleterr}r(h$Uh%jubah+hqubhmX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rr}r(h$X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rh%jLubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrjh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXsuccess_channelsrr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jubhmXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h$Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh%jubeh+j0ubah+j5ubeh+jubah+jubeh+jubaubeubeubhv)r}r(h$Uh%hh&Nh+hyh-}r(h5]rh3]rh/]rh1]rh8]rUentriesr]r(hX"Seek (class in circuits.io.events)hUtrauh:Nh;hh]rubh)r}r(h$Uh%hh&Nh+hh-}r(hhXpyrh5]rh3]rh/]rh1]rh8]rhXclassrhjuh:Nh;hh]r(h)r}r(h$XSeek(*args, **kwargs)rh%jh&hh+hh-}r(h5]rhahh'Xcircuits.io.eventsrr}rbh3]rh/]rh1]rh8]rhahXSeekrhUhˉuh:Nh;hh]r(h)r}r(h$Xclass rh%jh&hh+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXclass rr}r(h$Uh%jubaubh)r}r(h$Xcircuits.io.events.rh%jh&hh+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXcircuits.io.events.rr}r (h$Uh%jubaubh)r }r (h$jh%jh&hh+hh-}r (h/]r h1]rh3]rh5]rh8]ruh:Nh;hh]rhmXSeekrr}r(h$Uh%j ubaubh)r}r(h$Uh%jh&hh+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]r(j)r}r (h$X*argsr!h-}r"(h/]r#h1]r$h3]r%h5]r&h8]r'uh%jh]r(hmX*argsr)r*}r+(h$Uh%jubah+jubj)r,}r-(h$X**kwargsr.h-}r/(h/]r0h1]r1h3]r2h5]r3h8]r4uh%jh]r5hmX**kwargsr6r7}r8(h$Uh%j,ubah+jubeubeubj )r9}r:(h$Uh%jh&hh+j#h-}r;(h/]r<h1]r=h3]r>h5]r?h8]r@uh:Nh;hh]rA(j+)rB}rC(h$X*Bases: :class:`circuits.core.events.Event`rDh%j9h&j/h+j0h-}rE(h/]rFh1]rGh3]rHh5]rIh8]rJuh:Kh;hh]rK(hmXBases: rLrM}rN(h$XBases: rOh%jBubhI)rP}rQ(h$X#:class:`circuits.core.events.Event`rRh%jBh&h)h+hMh-}rS(UreftyperTXclassrUhQhRXcircuits.core.events.EventrVU refdomainrWXpyrXh5]rYh3]rZU refexplicitr[h/]r\h1]r]h8]r^h\h]h^jh_jKuh:Kh]r_ha)r`}ra(h$jRh-}rb(h/]rch1]rd(hgjXXpy-classreeh3]rfh5]rgh8]rhuh%jPh]rihmXcircuits.core.events.Eventrjrk}rl(h$Uh%j`ubah+hqubaubeubj+)rm}rn(h$X Seek Eventroh%j9h&XW/home/prologic/work/circuits/circuits/io/events.py:docstring of circuits.io.events.Seekrph+j0h-}rq(h/]rrh1]rsh3]rth5]ruh8]rvuh:Kh;hh]rwhmX Seek Eventrxry}rz(h$joh%jmubaubj+)r{}r|(h$XAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.r}h%j9h&jph+j0h-}r~(h/]rh1]rh3]rh5]rh8]ruh:Kh;hh]rhmXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rr}r(h$j}h%j{ubaubj+)r}r(h$XAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rh%j9h&jph+j0h-}r(h/]rh1]rh3]rh5]rh8]ruh:Kh;hh]rhmXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rr}r(h$jh%jubaubj+)r}r(h$XEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh%j9h&jph+j0h-}r(h/]rh1]rh3]rh5]rh8]ruh:K h;hh]r(hmXEvery event has a rr}r(h$XEvery event has a rh%jubhI)r}r(h$X :attr:`name`rh%jh&h)h+hMh-}r(UreftyperXattrrhQhRXnamerU refdomainrXpyrh5]rh3]rU refexplicitrh/]rh1]rh8]rh\h]h^jh_jKuh:Kh]rha)r}r(h$jh-}r(h/]rh1]r(hgjXpy-attrreh3]rh5]rh8]ruh%jh]rhmXnamerr}r(h$Uh%jubah+hqubaubhmX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(h$X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh%jubeubj)r}r(h$Uh%j9h&Nh+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX Variablesrr}r(h$Uh%jubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(Ureftyper jU reftargetr Xchannelsr U refdomainr jh5]r h3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj )r}r(h$j h-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXchannelsrr}r(h$Uh%jubah+jubah+hMubhmX -- r r!}r"(h$Uh%jubj+)r#}r$(h$Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r%h%jh&jph+j0h-}r&(h/]r'h1]r(h3]r)h5]r*h8]r+uh:Kh]r,hmXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r-r.}r/(h$j%h%j#ubaubj+)r0}r1(h$XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r2h%jh&jph+j0h-}r3(h/]r4h1]r5h3]r6h5]r7h8]r8uh:Kh]r9hmXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r:r;}r<(h$j2h%j0ubaubeh+j0ubah+j5ubj)r=}r>(h$Uh-}r?(h/]r@h1]rAh3]rBh5]rCh8]rDuh%jh]rEj+)rF}rG(h$Uh-}rH(h/]rIh1]rJh3]rKh5]rLh8]rMuh%j=h]rN(hI)rO}rP(h$Uh-}rQ(UreftyperRjU reftargetrSXvaluerTU refdomainrUjh5]rVh3]rWU refexplicitrXh/]rYh1]rZh8]r[uh%jFh]r\j )r]}r^(h$jTh-}r_(h/]r`h1]rah3]rbh5]rch8]rduh%jOh]rehmXvaluerfrg}rh(h$Uh%j]ubah+jubah+hMubhmX -- rirj}rk(h$Uh%jFubhmX this is a rlrm}rn(h$X this is a roh%jFubhI)rp}rq(h$X#:class:`circuits.core.values.Value`rrh%jFh&h)h+hMh-}rs(UreftypertXclassruhQhRXcircuits.core.values.ValuervU refdomainrwXpyrxh5]ryh3]rzU refexplicitr{h/]r|h1]r}h8]r~h\h]h^jh_jKuh:K!h]rha)r}r(h$jrh-}r(h/]rh1]r(hgjxXpy-classreh3]rh5]rh8]ruh%jph]rhmXcircuits.core.values.Valuerr}r(h$Uh%jubah+hqubaubhmXN object that holds the results returned by the handlers invoked for the event.rr}r(h$XN object that holds the results returned by the handlers invoked for the event.rh%jFubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXsuccessrU refdomainrjh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXsuccessrr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jubhmX%if this optional attribute is set to rr}r(h$X%if this optional attribute is set to rh%jubha)r}r(h$X``True``rh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXTruerr}r(h$Uh%jubah+hqubhmX, an associated event rr}r(h$X, an associated event rh%jubha)r}r(h$X``EventSuccess``rh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX EventSuccessrr}r(h$Uh%jubah+hqubhmX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(h$X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh%jubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrjh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj )r}r(h$jh-}r(h/]r h1]r h3]r h5]r h8]r uh%jh]rhmXsuccess_channelsrr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jubhmXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h$Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh%jubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]r uh%jh]r!j+)r"}r#(h$Uh-}r$(h/]r%h1]r&h3]r'h5]r(h8]r)uh%jh]r*(hI)r+}r,(h$Uh-}r-(Ureftyper.jU reftargetr/Xcompleter0U refdomainr1jh5]r2h3]r3U refexplicitr4h/]r5h1]r6h8]r7uh%j"h]r8j )r9}r:(h$j0h-}r;(h/]r<h1]r=h3]r>h5]r?h8]r@uh%j+h]rAhmXcompleterBrC}rD(h$Uh%j9ubah+jubah+hMubhmX -- rErF}rG(h$Uh%j"ubhmX%if this optional attribute is set to rHrI}rJ(h$X%if this optional attribute is set to rKh%j"ubha)rL}rM(h$X``True``rNh-}rO(h/]rPh1]rQh3]rRh5]rSh8]rTuh%j"h]rUhmXTruerVrW}rX(h$Uh%jLubah+hqubhmX, an associated event rYrZ}r[(h$X, an associated event r\h%j"ubha)r]}r^(h$X``EventComplete``r_h-}r`(h/]rah1]rbh3]rch5]rdh8]reuh%j"h]rfhmX EventCompletergrh}ri(h$Uh%j]ubah+hqubhmX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rjrk}rl(h$X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rmh%j"ubeh+j0ubah+j5ubj)rn}ro(h$Uh-}rp(h/]rqh1]rrh3]rsh5]rth8]ruuh%jh]rvj+)rw}rx(h$Uh-}ry(h/]rzh1]r{h3]r|h5]r}h8]r~uh%jnh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrjh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jwh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXsuccess_channelsrr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jwubhmXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h$Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh%jwubeh+j0ubah+j5ubeh+jubah+jubeh+jubaubeubeubhv)r}r(h$Uh%hh&Nh+hyh-}r(h5]rh3]rh/]rh1]rh8]rUentriesr]r(hX#Write (class in circuits.io.events)hUtrauh:Nh;hh]rubh)r}r(h$Uh%hh&Nh+hh-}r(hhXpyrh5]rh3]rh/]rh1]rh8]rhXclassrhjuh:Nh;hh]r(h)r}r(h$XWrite(*args, **kwargs)rh%jh&hh+hh-}r(h5]rhahh'Xcircuits.io.eventsrr}rbh3]rh/]rh1]rh8]rhahXWriterhUhˉuh:Nh;hh]r(h)r}r(h$Xclass rh%jh&hh+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXclass rr}r(h$Uh%jubaubh)r}r(h$Xcircuits.io.events.rh%jh&hh+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXcircuits.io.events.rr}r(h$Uh%jubaubh)r}r(h$jh%jh&hh+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXWriterr}r(h$Uh%jubaubh)r}r(h$Uh%jh&hh+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]r(j)r}r(h$X*argsrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX*argsrr}r(h$Uh%jubah+jubj)r}r(h$X**kwargsrh-}r(h/]rh1]rh3]rh5]r h8]r uh%jh]r hmX**kwargsr r }r(h$Uh%jubah+jubeubeubj )r}r(h$Uh%jh&hh+j#h-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]r(j+)r}r(h$X*Bases: :class:`circuits.core.events.Event`rh%jh&j/h+j0h-}r(h/]rh1]rh3]rh5]rh8]r uh:Kh;hh]r!(hmXBases: r"r#}r$(h$XBases: r%h%jubhI)r&}r'(h$X#:class:`circuits.core.events.Event`r(h%jh&h)h+hMh-}r)(Ureftyper*Xclassr+hQhRXcircuits.core.events.Eventr,U refdomainr-Xpyr.h5]r/h3]r0U refexplicitr1h/]r2h1]r3h8]r4h\h]h^jh_jKuh:Kh]r5ha)r6}r7(h$j(h-}r8(h/]r9h1]r:(hgj.Xpy-classr;eh3]r<h5]r=h8]r>uh%j&h]r?hmXcircuits.core.events.Eventr@rA}rB(h$Uh%j6ubah+hqubaubeubj+)rC}rD(h$X Write EventrEh%jh&XX/home/prologic/work/circuits/circuits/io/events.py:docstring of circuits.io.events.WriterFh+j0h-}rG(h/]rHh1]rIh3]rJh5]rKh8]rLuh:Kh;hh]rMhmX Write EventrNrO}rP(h$jEh%jCubaubj+)rQ}rR(h$XAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rSh%jh&jFh+j0h-}rT(h/]rUh1]rVh3]rWh5]rXh8]rYuh:Kh;hh]rZhmXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.r[r\}r](h$jSh%jQubaubj+)r^}r_(h$XAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.r`h%jh&jFh+j0h-}ra(h/]rbh1]rch3]rdh5]reh8]rfuh:Kh;hh]rghmXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rhri}rj(h$j`h%j^ubaubj+)rk}rl(h$XEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rmh%jh&jFh+j0h-}rn(h/]roh1]rph3]rqh5]rrh8]rsuh:K h;hh]rt(hmXEvery event has a rurv}rw(h$XEvery event has a rxh%jkubhI)ry}rz(h$X :attr:`name`r{h%jkh&h)h+hMh-}r|(Ureftyper}Xattrr~hQhRXnamerU refdomainrXpyrh5]rh3]rU refexplicitrh/]rh1]rh8]rh\h]h^jh_jKuh:Kh]rha)r}r(h$j{h-}r(h/]rh1]r(hgjXpy-attrreh3]rh5]rh8]ruh%jyh]rhmXnamerr}r(h$Uh%jubah+hqubaubhmX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(h$X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh%jkubeubj)r}r(h$Uh%jh&Nh+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX Variablesrr}r(h$Uh%jubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXchannelsrU refdomainrjh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXchannelsrr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jubj+)r}r(h$Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rh%jh&jFh+j0h-}r(h/]rh1]rh3]rh5]rh8]ruh:Kh]rhmXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rr}r(h$jh%jubaubj+)r}r(h$XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rh%jh&jFh+j0h-}r (h/]r h1]r h3]r h5]r h8]ruh:Kh]rhmXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rr}r(h$jh%jubaubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]r h3]r!h5]r"h8]r#uh%jh]r$(hI)r%}r&(h$Uh-}r'(Ureftyper(jU reftargetr)Xvaluer*U refdomainr+jh5]r,h3]r-U refexplicitr.h/]r/h1]r0h8]r1uh%jh]r2j )r3}r4(h$j*h-}r5(h/]r6h1]r7h3]r8h5]r9h8]r:uh%j%h]r;hmXvaluer<r=}r>(h$Uh%j3ubah+jubah+hMubhmX -- r?r@}rA(h$Uh%jubhmX this is a rBrC}rD(h$X this is a rEh%jubhI)rF}rG(h$X#:class:`circuits.core.values.Value`rHh%jh&h)h+hMh-}rI(UreftyperJXclassrKhQhRXcircuits.core.values.ValuerLU refdomainrMXpyrNh5]rOh3]rPU refexplicitrQh/]rRh1]rSh8]rTh\h]h^jh_jKuh:K!h]rUha)rV}rW(h$jHh-}rX(h/]rYh1]rZ(hgjNXpy-classr[eh3]r\h5]r]h8]r^uh%jFh]r_hmXcircuits.core.values.Valuer`ra}rb(h$Uh%jVubah+hqubaubhmXN object that holds the results returned by the handlers invoked for the event.rcrd}re(h$XN object that holds the results returned by the handlers invoked for the event.rfh%jubeh+j0ubah+j5ubj)rg}rh(h$Uh-}ri(h/]rjh1]rkh3]rlh5]rmh8]rnuh%jh]roj+)rp}rq(h$Uh-}rr(h/]rsh1]rth3]ruh5]rvh8]rwuh%jgh]rx(hI)ry}rz(h$Uh-}r{(Ureftyper|jU reftargetr}Xsuccessr~U refdomainrjh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jph]rj )r}r(h$j~h-}r(h/]rh1]rh3]rh5]rh8]ruh%jyh]rhmXsuccessrr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jpubhmX%if this optional attribute is set to rr}r(h$X%if this optional attribute is set to rh%jpubha)r}r(h$X``True``rh-}r(h/]rh1]rh3]rh5]rh8]ruh%jph]rhmXTruerr}r(h$Uh%jubah+hqubhmX, an associated event rr}r(h$X, an associated event rh%jpubha)r}r(h$X``EventSuccess``rh-}r(h/]rh1]rh3]rh5]rh8]ruh%jph]rhmX EventSuccessrr}r(h$Uh%jubah+hqubhmX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(h$X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh%jpubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrjh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXsuccess_channelsrr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jubhmXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h$Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh%jubeh+j0ubah+j5ubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rj+)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(hI)r}r(h$Uh-}r(UreftyperjU reftargetrXcompleterU refdomainrjh5]rh3]r U refexplicitr h/]r h1]r h8]r uh%jh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXcompleterr}r(h$Uh%jubah+jubah+hMubhmX -- rr}r(h$Uh%jubhmX%if this optional attribute is set to rr}r (h$X%if this optional attribute is set to r!h%jubha)r"}r#(h$X``True``r$h-}r%(h/]r&h1]r'h3]r(h5]r)h8]r*uh%jh]r+hmXTruer,r-}r.(h$Uh%j"ubah+hqubhmX, an associated event r/r0}r1(h$X, an associated event r2h%jubha)r3}r4(h$X``EventComplete``r5h-}r6(h/]r7h1]r8h3]r9h5]r:h8]r;uh%jh]r<hmX EventCompleter=r>}r?(h$Uh%j3ubah+hqubhmX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r@rA}rB(h$X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rCh%jubeh+j0ubah+j5ubj)rD}rE(h$Uh-}rF(h/]rGh1]rHh3]rIh5]rJh8]rKuh%jh]rLj+)rM}rN(h$Uh-}rO(h/]rPh1]rQh3]rRh5]rSh8]rTuh%jDh]rU(hI)rV}rW(h$Uh-}rX(UreftyperYjU reftargetrZXsuccess_channelsr[U refdomainr\jh5]r]h3]r^U refexplicitr_h/]r`h1]rah8]rbuh%jMh]rcj )rd}re(h$j[h-}rf(h/]rgh1]rhh3]rih5]rjh8]rkuh%jVh]rlhmXsuccess_channelsrmrn}ro(h$Uh%jdubah+jubah+hMubhmX -- rprq}rr(h$Uh%jMubhmXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rsrt}ru(h$Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rvh%jMubeh+j0ubah+j5ubeh+jubah+jubeh+jubaubeubeubeubh!)rw}rx(h$Uh%h"h&h)h+h,h-}ry(h/]rzh1]r{h3]r|h5]r}hah8]r~hauh:K#h;hh]r(h=)r}r(h$X Componentsrh%jwh&h)h+hAh-}r(h/]rh1]rh3]rh5]rh8]ruh:K#h;hh]rhmX Componentsrr}r(h$jh%jubaubj+)r}r(h$X**none**rh%jwh&h)h+j0h-}r(h/]rh1]rh3]rh5]rh8]ruh:K%h;hh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXnonerr}r(h$Uh%jubah+jubaubeubh!)r}r(h$Uh%h"h&h)h+h,h-}r(h/]rh1]rh3]rh5]rhah8]rhauh:K(h;hh]r(h=)r}r(h$X Functionsrh%jh&h)h+hAh-}r(h/]rh1]rh3]rh5]rh8]ruh:K(h;hh]rhmX Functionsrr}r(h$jh%jubaubj+)r}r(h$X**none**rh%jh&h)h+j0h-}r(h/]rh1]rh3]rh5]rh8]ruh:K*h;hh]rj )r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXnonerr}r(h$Uh%jubah+jubaubeubeubah$UU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh;hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNhANUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorr NUcloak_email_addressesr Utrim_footnote_reference_spacer Uenvr NUdump_pseudo_xmlr NUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUC/home/prologic/work/circuits/docs/source/api/circuits_io_events.rstrUgettext_compactrU generatorrNUdump_internalsr NU smart_quotesr!U pep_base_urlr"Uhttp://www.python.org/dev/peps/r#Usyntax_highlightr$Ulongr%Uinput_encoding_error_handlerr&jUauto_id_prefixr'Uidr(Udoctitle_xformr)Ustrip_elements_with_classesr*NU _config_filesr+]r,Ufile_insertion_enabledr-KU raw_enabledr.KU dump_settingsr/NubUsymbol_footnote_startr0KUidsr1}r2(hjhjhjh hh7cdocutils.nodes target r3)r4}r5(h$Uh%h"h&h)h+Utargetr6h-}r7(h/]r8h5]r9h7ah3]r:Uismodr;h1]r<h8]r=uh:Kh;hh]r>ubhh"h j` h jh j hjwhjhj6 hhuUsubstitution_namesr?}r@h+h;h-}rA(h/]rBh5]rCh3]rDUsourcerEh)h1]rFh8]rGuU footnotesrH]rIUrefidsrJ}rKub.circuits-2.1.0/docs/build/doctrees/api/circuits_core_manager.doctree0000644000014400001440000016740312113366656025422 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X"circuits.core.manager.Manager.nameqX functionsqNX circuits.core.manager -- managerqNX'circuits.core.manager.Manager.callEventq X'circuits.core.manager.Manager.fireEventq X!circuits.core.manager.Manager.pidq X#circuits.core.manager.Manager.startq X"circuits.core.manager.Manager.callq Xcircuits.core.manager.ManagerqXeventsqNX%circuits.core.manager.Manager.runningqXclassesqNX"circuits.core.manager.Manager.fireqX"circuits.core.manager.Manager.stopqX"circuits.core.manager.Manager.tickqX componentsqNX#circuits.core.manager.Manager.flushqX)circuits.core.manager.Manager.flushEventsqX!circuits.core.manager.Manager.runquUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq }q!(hhhU functionsq"hUcircuits-core-manager-managerq#h h h h h h h h h h hhhUeventsq$hhhUclassesq%hhhhhhhU componentsq&hhhhhhuUchildrenq']q(cdocutils.nodes section q))q*}q+(U rawsourceq,UUparentq-hUsourceq.cdocutils.nodes reprunicode q/XF/home/prologic/work/circuits/docs/source/api/circuits_core_manager.rstq0q1}q2bUtagnameq3Usectionq4U attributesq5}q6(Udupnamesq7]q8Uclassesq9]q:Ubackrefsq;]q(Xmodule-circuits.core.managerq?h#eUnamesq@]qAhauUlineqBKUdocumentqChh']qD(cdocutils.nodes title qE)qF}qG(h,X':mod:`circuits.core.manager` -- ManagerqHh-h*h.h1h3UtitleqIh5}qJ(h7]qKh9]qLh;]qMh=]qNh@]qOuhBKhChh']qP(csphinx.addnodes pending_xref qQ)qR}qS(h,X:mod:`circuits.core.manager`qTh-hFh.h1h3U pending_xrefqUh5}qV(UreftypeqWXmodqXUrefwarnqYU reftargetqZXcircuits.core.managerq[U refdomainq\Xpyq]h=]q^h;]q_U refexplicitq`h7]qah9]qbh@]qcUrefdocqdUapi/circuits_core_managerqeUpy:classqfNU py:moduleqgNuhBKh']qhcdocutils.nodes literal qi)qj}qk(h,hTh5}ql(h7]qmh9]qn(Uxrefqoh]Xpy-modqpeh;]qqh=]qrh@]qsuh-hRh']qtcdocutils.nodes Text quXcircuits.core.managerqvqw}qx(h,Uh-hjubah3UliteralqyubaubhuX -- Managerqzq{}q|(h,X -- Managerq}h-hFubeubcsphinx.addnodes index q~)q}q(h,Uh-h*h.U qh3Uindexqh5}q(h=]qh;]qh7]qh9]qh@]qUentriesq]q(UsingleqXcircuits.core.manager (module)Xmodule-circuits.core.managerUtqauhBKhChh']qubcdocutils.nodes paragraph q)q}q(h,X&This module defines the Manager class.qh-h*h.XX/home/prologic/work/circuits/circuits/core/manager.py:docstring of circuits.core.managerqh3U paragraphqh5}q(h7]qh9]qh;]qh=]qh@]quhBKhChh']qhuX&This module defines the Manager class.qq}q(h,hh-hubaubh))q}q(h,Uh-h*h.h1h3h4h5}q(h7]qh9]qh;]qh=]qh%ah@]qhauhBKhChh']q(hE)q}q(h,XClassesqh-hh.h1h3hIh5}q(h7]qh9]qh;]qh=]qh@]quhBKhChh']qhuXClassesqq}q(h,hh-hubaubh~)q}q(h,Uh-hh.Nh3hh5}q(h=]qh;]qh7]qh9]qh@]qUentriesq]q(hX(Manager (class in circuits.core.manager)hUtqauhBNhChh']qubcsphinx.addnodes desc q)q}q(h,Uh-hh.Nh3Udescqh5}q(UnoindexqʼnUdomainqXpyqh=]qh;]qh7]qh9]qh@]qUobjtypeqXclassqUdesctypeqhuhBNhChh']q(csphinx.addnodes desc_signature q)q}q(h,XManager(*args, **kwargs)qh-hh.U qh3Udesc_signatureqh5}q(h=]qhaUmoduleqh/Xcircuits.core.managerqڅq}qbh;]qh7]qh9]qh@]qhaUfullnameqXManagerqUclassqUUfirstquhBNhChh']q(csphinx.addnodes desc_annotation q)q}q(h,Xclass qh-hh.hh3Udesc_annotationqh5}q(h7]qh9]qh;]qh=]qh@]quhBNhChh']qhuXclass qq}q(h,Uh-hubaubcsphinx.addnodes desc_addname q)q}q(h,Xcircuits.core.manager.qh-hh.hh3U desc_addnameqh5}q(h7]qh9]qh;]qh=]qh@]quhBNhChh']rhuXcircuits.core.manager.rr}r(h,Uh-hubaubcsphinx.addnodes desc_name r)r}r(h,hh-hh.hh3U desc_namerh5}r(h7]r h9]r h;]r h=]r h@]r uhBNhChh']rhuXManagerrr}r(h,Uh-jubaubcsphinx.addnodes desc_parameterlist r)r}r(h,Uh-hh.hh3Udesc_parameterlistrh5}r(h7]rh9]rh;]rh=]rh@]ruhBNhChh']r(csphinx.addnodes desc_parameter r)r}r(h,X*argsr h5}r!(h7]r"h9]r#h;]r$h=]r%h@]r&uh-jh']r'huX*argsr(r)}r*(h,Uh-jubah3Udesc_parameterr+ubj)r,}r-(h,X**kwargsr.h5}r/(h7]r0h9]r1h;]r2h=]r3h@]r4uh-jh']r5huX**kwargsr6r7}r8(h,Uh-j,ubah3j+ubeubeubcsphinx.addnodes desc_content r9)r:}r;(h,Uh-hh.hh3U desc_contentr<h5}r=(h7]r>h9]r?h;]r@h=]rAh@]rBuhBNhChh']rC(h)rD}rE(h,XBases: :class:`object`rFh-j:h.U rGh3hh5}rH(h7]rIh9]rJh;]rKh=]rLh@]rMuhBKhChh']rN(huXBases: rOrP}rQ(h,XBases: rRh-jDubhQ)rS}rT(h,X:class:`object`rUh-jDh.h1h3hUh5}rV(UreftyperWXclassrXhYhZXobjectrYU refdomainrZXpyr[h=]r\h;]r]U refexplicitr^h7]r_h9]r`h@]rahdhehfhhgXcircuits.core.managerrbuhBKh']rchi)rd}re(h,jUh5}rf(h7]rgh9]rh(hoj[Xpy-classrieh;]rjh=]rkh@]rluh-jSh']rmhuXobjectrnro}rp(h,Uh-jdubah3hyubaubeubh)rq}rr(h,XThe manager class has two roles. As a base class for component implementation, it provides methods for event and handler management. The method :meth:`.fireEvent` appends a new event at the end of the event queue for later execution. :meth:`.waitEvent` suspends the execution of a handler until all handlers for a given event have been invoked. :meth:`.callEvent` combines the last two methods in a single method.rsh-j:h.X`/home/prologic/work/circuits/circuits/core/manager.py:docstring of circuits.core.manager.Managerrth3hh5}ru(h7]rvh9]rwh;]rxh=]ryh@]rzuhBKhChh']r{(huXThe manager class has two roles. As a base class for component implementation, it provides methods for event and handler management. The method r|r}}r~(h,XThe manager class has two roles. As a base class for component implementation, it provides methods for event and handler management. The method rh-jqubhQ)r}r(h,X:meth:`.fireEvent`rh-jqh.h1h3hUh5}r(UreftyperXmethrU refspecificrhYhZX fireEventrU refdomainrXpyrh=]rh;]rU refexplicitrh7]rh9]rh@]rhdhehfhhgjbuhBKh']rhi)r}r(h,jh5}r(h7]rh9]r(hojXpy-methreh;]rh=]rh@]ruh-jh']rhuX fireEvent()rr}r(h,Uh-jubah3hyubaubhuXH appends a new event at the end of the event queue for later execution. rr}r(h,XH appends a new event at the end of the event queue for later execution. rh-jqubhQ)r}r(h,X:meth:`.waitEvent`rh-jqh.h1h3hUh5}r(UreftyperXmethrjhYhZX waitEventrU refdomainrXpyrh=]rh;]rU refexplicitrh7]rh9]rh@]rhdhehfhhgjbuhBKh']rhi)r}r(h,jh5}r(h7]rh9]r(hojXpy-methreh;]rh=]rh@]ruh-jh']rhuX waitEvent()rr}r(h,Uh-jubah3hyubaubhuX] suspends the execution of a handler until all handlers for a given event have been invoked. rr}r(h,X] suspends the execution of a handler until all handlers for a given event have been invoked. rh-jqubhQ)r}r(h,X:meth:`.callEvent`rh-jqh.h1h3hUh5}r(UreftyperXmethrjhYhZX callEventrU refdomainrXpyrh=]rh;]rU refexplicitrh7]rh9]rh@]rhdhehfhhgjbuhBKh']rhi)r}r(h,jh5}r(h7]rh9]r(hojXpy-methreh;]rh=]rh@]ruh-jh']rhuX callEvent()rr}r(h,Uh-jubah3hyubaubhuX2 combines the last two methods in a single method.rr}r(h,X2 combines the last two methods in a single method.rh-jqubeubh)r}r(h,XThe methods :meth:`.addHandler` and :meth:`.removeHandler` allow handlers for events to be added and removed dynamically. (The more common way to register a handler is to use the :func:`~.handlers.handler` decorator or derive the class from :class:`~.components.Component`.)rh-j:h.jth3hh5}r(h7]rh9]rh;]rh=]rh@]ruhBKhChh']r(huX The methods rr}r(h,X The methods rh-jubhQ)r}r(h,X:meth:`.addHandler`rh-jh.h1h3hUh5}r(UreftyperXmethrjhYhZX addHandlerrU refdomainrXpyrh=]rh;]rU refexplicitrh7]rh9]rh@]rhdhehfhhgjbuhBKh']rhi)r}r(h,jh5}r(h7]rh9]r(hojXpy-methreh;]rh=]r h@]r uh-jh']r huX addHandler()r r }r(h,Uh-jubah3hyubaubhuX and rr}r(h,X and rh-jubhQ)r}r(h,X:meth:`.removeHandler`rh-jh.h1h3hUh5}r(UreftyperXmethrjhYhZX removeHandlerrU refdomainrXpyrh=]rh;]rU refexplicitrh7]rh9]r h@]r!hdhehfhhgjbuhBKh']r"hi)r#}r$(h,jh5}r%(h7]r&h9]r'(hojXpy-methr(eh;]r)h=]r*h@]r+uh-jh']r,huXremoveHandler()r-r.}r/(h,Uh-j#ubah3hyubaubhuXy allow handlers for events to be added and removed dynamically. (The more common way to register a handler is to use the r0r1}r2(h,Xy allow handlers for events to be added and removed dynamically. (The more common way to register a handler is to use the r3h-jubhQ)r4}r5(h,X:func:`~.handlers.handler`r6h-jh.h1h3hUh5}r7(Ureftyper8Xfuncr9jhYhZXhandlers.handlerr:U refdomainr;Xpyr<h=]r=h;]r>U refexplicitr?h7]r@h9]rAh@]rBhdhehfhhgjbuhBKh']rChi)rD}rE(h,j6h5}rF(h7]rGh9]rH(hoj<Xpy-funcrIeh;]rJh=]rKh@]rLuh-j4h']rMhuX handler()rNrO}rP(h,Uh-jDubah3hyubaubhuX$ decorator or derive the class from rQrR}rS(h,X$ decorator or derive the class from rTh-jubhQ)rU}rV(h,X:class:`~.components.Component`rWh-jh.h1h3hUh5}rX(UreftyperYXclassrZjhYhZXcomponents.Componentr[U refdomainr\Xpyr]h=]r^h;]r_U refexplicitr`h7]rah9]rbh@]rchdhehfhhgjbuhBKh']rdhi)re}rf(h,jWh5}rg(h7]rhh9]ri(hoj]Xpy-classrjeh;]rkh=]rlh@]rmuh-jUh']rnhuX Componentrorp}rq(h,Uh-jeubah3hyubaubhuX.)rrrs}rt(h,X.)ruh-jubeubh)rv}rw(h,XIn its second role, the :class:`.Manager` takes the role of the event executor. Every component hierarchy has a root component that maintains a queue of events. Firing an event effectively means appending it to the event queue maintained by the root manager. The :meth:`.flush` method removes all pending events from the queue and, for each event, invokes all the handlers. Usually, :meth:`.flush` is indirectly invoked by :meth:`run`.rxh-j:h.jth3hh5}ry(h7]rzh9]r{h;]r|h=]r}h@]r~uhBK hChh']r(huXIn its second role, the rr}r(h,XIn its second role, the rh-jvubhQ)r}r(h,X:class:`.Manager`rh-jvh.h1h3hUh5}r(UreftyperXclassrjhYhZXManagerrU refdomainrXpyrh=]rh;]rU refexplicitrh7]rh9]rh@]rhdhehfhhgjbuhBKh']rhi)r}r(h,jh5}r(h7]rh9]r(hojXpy-classreh;]rh=]rh@]ruh-jh']rhuXManagerrr}r(h,Uh-jubah3hyubaubhuX takes the role of the event executor. Every component hierarchy has a root component that maintains a queue of events. Firing an event effectively means appending it to the event queue maintained by the root manager. The rr}r(h,X takes the role of the event executor. Every component hierarchy has a root component that maintains a queue of events. Firing an event effectively means appending it to the event queue maintained by the root manager. The rh-jvubhQ)r}r(h,X:meth:`.flush`rh-jvh.h1h3hUh5}r(UreftyperXmethrjhYhZXflushrU refdomainrXpyrh=]rh;]rU refexplicitrh7]rh9]rh@]rhdhehfhhgjbuhBKh']rhi)r}r(h,jh5}r(h7]rh9]r(hojXpy-methreh;]rh=]rh@]ruh-jh']rhuXflush()rr}r(h,Uh-jubah3hyubaubhuXj method removes all pending events from the queue and, for each event, invokes all the handlers. Usually, rr}r(h,Xj method removes all pending events from the queue and, for each event, invokes all the handlers. Usually, rh-jvubhQ)r}r(h,X:meth:`.flush`rh-jvh.h1h3hUh5}r(UreftyperXmethrjhYhZXflushrU refdomainrXpyrh=]rh;]rU refexplicitrh7]rh9]rh@]rhdhehfhhgjbuhBKh']rhi)r}r(h,jh5}r(h7]rh9]r(hojXpy-methreh;]rh=]rh@]ruh-jh']rhuXflush()rr}r(h,Uh-jubah3hyubaubhuX is indirectly invoked by rr}r(h,X is indirectly invoked by rh-jvubhQ)r}r(h,X :meth:`run`rh-jvh.h1h3hUh5}r(UreftyperXmethrhYhZXrunrU refdomainrXpyrh=]rh;]rU refexplicitrh7]rh9]rh@]rhdhehfhhgjbuhBKh']rhi)r}r(h,jh5}r(h7]rh9]r(hojXpy-methreh;]rh=]rh@]ruh-jh']rhuXrun()rr}r(h,Uh-jubah3hyubaubhuX.r}r(h,X.h-jvubeubh)r}r(h,XKThe manager optionally provides information about the execution of events as automatically generated events. If an :class:`~.events.Event` has its :attr:`success` attribute set to True, the manager fires a :class:`~.events.Success` event if all handlers have been executed without error. Note that this event will be enqueued (and dispatched) immediately after the events that have been fired by the event's handlers. So the success event indicates both the successful invocation of all handlers for the event and the processing of the immediate follow-up events fired by those handlers.rh-j:h.jth3hh5}r (h7]r h9]r h;]r h=]r h@]ruhBKhChh']r(huXsThe manager optionally provides information about the execution of events as automatically generated events. If an rr}r(h,XsThe manager optionally provides information about the execution of events as automatically generated events. If an rh-jubhQ)r}r(h,X:class:`~.events.Event`rh-jh.h1h3hUh5}r(UreftyperXclassrjhYhZX events.EventrU refdomainrXpyrh=]rh;]rU refexplicitrh7]r h9]r!h@]r"hdhehfhhgjbuhBKh']r#hi)r$}r%(h,jh5}r&(h7]r'h9]r((hojXpy-classr)eh;]r*h=]r+h@]r,uh-jh']r-huXEventr.r/}r0(h,Uh-j$ubah3hyubaubhuX has its r1r2}r3(h,X has its r4h-jubhQ)r5}r6(h,X:attr:`success`r7h-jh.h1h3hUh5}r8(Ureftyper9Xattrr:hYhZXsuccessr;U refdomainr<Xpyr=h=]r>h;]r?U refexplicitr@h7]rAh9]rBh@]rChdhehfhhgjbuhBKh']rDhi)rE}rF(h,j7h5}rG(h7]rHh9]rI(hoj=Xpy-attrrJeh;]rKh=]rLh@]rMuh-j5h']rNhuXsuccessrOrP}rQ(h,Uh-jEubah3hyubaubhuX, attribute set to True, the manager fires a rRrS}rT(h,X, attribute set to True, the manager fires a rUh-jubhQ)rV}rW(h,X:class:`~.events.Success`rXh-jh.h1h3hUh5}rY(UreftyperZXclassr[jhYhZXevents.Successr\U refdomainr]Xpyr^h=]r_h;]r`U refexplicitrah7]rbh9]rch@]rdhdhehfhhgjbuhBKh']rehi)rf}rg(h,jXh5}rh(h7]rih9]rj(hoj^Xpy-classrkeh;]rlh=]rmh@]rnuh-jVh']rohuXSuccessrprq}rr(h,Uh-jfubah3hyubaubhuXd event if all handlers have been executed without error. Note that this event will be enqueued (and dispatched) immediately after the events that have been fired by the event's handlers. So the success event indicates both the successful invocation of all handlers for the event and the processing of the immediate follow-up events fired by those handlers.rsrt}ru(h,Xd event if all handlers have been executed without error. Note that this event will be enqueued (and dispatched) immediately after the events that have been fired by the event's handlers. So the success event indicates both the successful invocation of all handlers for the event and the processing of the immediate follow-up events fired by those handlers.rvh-jubeubh)rw}rx(h,XSometimes it is not sufficient to know that an event and its immediate follow-up events have been processed. Rather, it is important to know when all state changes triggered by an event, directly or indirectly, have been performed. This also includes the processing of events that have been fired when invoking the handlers for the follow-up events and the processing of events that have again been fired by those handlers and so on. The completion of the processing of an event and all its direct or indirect follow-up events may be indicated by a :class:`~.events.Complete` event. This event is generated by the manager if :class:`~.events.Event` has its :attr:`complete` attribute set to True.ryh-j:h.jth3hh5}rz(h7]r{h9]r|h;]r}h=]r~h@]ruhBKhChh']r(huX%Sometimes it is not sufficient to know that an event and its immediate follow-up events have been processed. Rather, it is important to know when all state changes triggered by an event, directly or indirectly, have been performed. This also includes the processing of events that have been fired when invoking the handlers for the follow-up events and the processing of events that have again been fired by those handlers and so on. The completion of the processing of an event and all its direct or indirect follow-up events may be indicated by a rr}r(h,X%Sometimes it is not sufficient to know that an event and its immediate follow-up events have been processed. Rather, it is important to know when all state changes triggered by an event, directly or indirectly, have been performed. This also includes the processing of events that have been fired when invoking the handlers for the follow-up events and the processing of events that have again been fired by those handlers and so on. The completion of the processing of an event and all its direct or indirect follow-up events may be indicated by a rh-jwubhQ)r}r(h,X:class:`~.events.Complete`rh-jwh.Nh3hUh5}r(UreftyperXclassrjhYhZXevents.CompleterU refdomainrXpyrh=]rh;]rU refexplicitrh7]rh9]rh@]rhdhehfhhgjbuhBNh']rhi)r}r(h,jh5}r(h7]rh9]r(hojXpy-classreh;]rh=]rh@]ruh-jh']rhuXCompleterr}r(h,Uh-jubah3hyubaubhuX2 event. This event is generated by the manager if rr}r(h,X2 event. This event is generated by the manager if rh-jwubhQ)r}r(h,X:class:`~.events.Event`rh-jwh.Nh3hUh5}r(UreftyperXclassrjhYhZX events.EventrU refdomainrXpyrh=]rh;]rU refexplicitrh7]rh9]rh@]rhdhehfhhgjbuhBNh']rhi)r}r(h,jh5}r(h7]rh9]r(hojXpy-classreh;]rh=]rh@]ruh-jh']rhuXEventrr}r(h,Uh-jubah3hyubaubhuX has its rr}r(h,X has its rh-jwubhQ)r}r(h,X:attr:`complete`rh-jwh.Nh3hUh5}r(UreftyperXattrrhYhZXcompleterU refdomainrXpyrh=]rh;]rU refexplicitrh7]rh9]rh@]rhdhehfhhgjbuhBNh']rhi)r}r(h,jh5}r(h7]rh9]r(hojXpy-attrreh;]rh=]rh@]ruh-jh']rhuXcompleterr}r(h,Uh-jubah3hyubaubhuX attribute set to True.rr}r(h,X attribute set to True.rh-jwubeubh)r}r(h,XApart from the event queue, the root manager also maintains a list of tasks, actually Python generators, that are updated when the event queue has been flushed.rh-j:h.jth3hh5}r(h7]rh9]rh;]rh=]rh@]ruhBK+hChh']rhuXApart from the event queue, the root manager also maintains a list of tasks, actually Python generators, that are updated when the event queue has been flushed.rr}r(h,jh-jubaubh)r}r(h,X4initializes x; see x.__class__.__doc__ for signaturerh-j:h.jth3hh5}r(h7]rh9]rh;]rh=]rh@]ruhBK/hChh']rhuX4initializes x; see x.__class__.__doc__ for signaturerr}r(h,jh-jubaubh~)r}r(h,Uh-j:h.Xe/home/prologic/work/circuits/circuits/core/manager.py:docstring of circuits.core.manager.Manager.namerh3hh5}r(h=]rh;]rh7]rh9]r h@]r Uentriesr ]r (hX.name (circuits.core.manager.Manager attribute)hUtr auhBNhChh']rubh)r}r(h,Uh-j:h.jh3hh5}r(hʼnhXpyrh=]rh;]rh7]rh9]rh@]rhX attributerhjuhBNhChh']r(h)r}r(h,X Manager.namerh-jh.hh3hh5}r(h=]rhahh/Xcircuits.core.managerrr }r!bh;]r"h7]r#h9]r$h@]r%hahX Manager.namer&hhhuhBNhChh']r'j)r(}r)(h,Xnamer*h-jh.hh3jh5}r+(h7]r,h9]r-h;]r.h=]r/h@]r0uhBNhChh']r1huXnamer2r3}r4(h,Uh-j(ubaubaubj9)r5}r6(h,Uh-jh.hh3j<h5}r7(h7]r8h9]r9h;]r:h=]r;h@]r<uhBNhChh']r=h)r>}r?(h,X)Return the name of this Component/Managerr@h-j5h.jh3hh5}rA(h7]rBh9]rCh;]rDh=]rEh@]rFuhBKhChh']rGhuX)Return the name of this Component/ManagerrHrI}rJ(h,j@h-j>ubaubaubeubh~)rK}rL(h,Uh-j:h.Xh/home/prologic/work/circuits/circuits/core/manager.py:docstring of circuits.core.manager.Manager.runningrMh3hh5}rN(h=]rOh;]rPh7]rQh9]rRh@]rSUentriesrT]rU(hX1running (circuits.core.manager.Manager attribute)hUtrVauhBNhChh']rWubh)rX}rY(h,Uh-j:h.jMh3hh5}rZ(hʼnhXpyr[h=]r\h;]r]h7]r^h9]r_h@]r`hX attributerahjauhBNhChh']rb(h)rc}rd(h,XManager.runningreh-jXh.hh3hh5}rf(h=]rghahh/Xcircuits.core.managerrhri}rjbh;]rkh7]rlh9]rmh@]rnhahXManager.runningrohhhuhBNhChh']rpj)rq}rr(h,Xrunningrsh-jch.hh3jh5}rt(h7]ruh9]rvh;]rwh=]rxh@]ryuhBNhChh']rzhuXrunningr{r|}r}(h,Uh-jqubaubaubj9)r~}r(h,Uh-jXh.hh3j<h5}r(h7]rh9]rh;]rh=]rh@]ruhBNhChh']rh)r}r(h,X2Return the running state of this Component/Managerrh-j~h.jMh3hh5}r(h7]rh9]rh;]rh=]rh@]ruhBKhChh']rhuX2Return the running state of this Component/Managerrr}r(h,jh-jubaubaubeubh~)r}r(h,Uh-j:h.Xd/home/prologic/work/circuits/circuits/core/manager.py:docstring of circuits.core.manager.Manager.pidrh3hh5}r(h=]rh;]rh7]rh9]rh@]rUentriesr]r(hX-pid (circuits.core.manager.Manager attribute)h UtrauhBNhChh']rubh)r}r(h,Uh-j:h.jh3hh5}r(hʼnhXpyrh=]rh;]rh7]rh9]rh@]rhX attributerhjuhBNhChh']r(h)r}r(h,X Manager.pidrh-jh.hh3hh5}r(h=]rh ahh/Xcircuits.core.managerrr}rbh;]rh7]rh9]rh@]rh ahX Manager.pidrhhhuhBNhChh']rj)r}r(h,Xpidrh-jh.hh3jh5}r(h7]rh9]rh;]rh=]rh@]ruhBNhChh']rhuXpidrr}r(h,Uh-jubaubaubj9)r}r(h,Uh-jh.hh3j<h5}r(h7]rh9]rh;]rh=]rh@]ruhBNhChh']rh)r}r(h,X/Return the process id of this Component/Managerrh-jh.jh3hh5}r(h7]rh9]rh;]rh=]rh@]ruhBKhChh']rhuX/Return the process id of this Component/Managerrr}r(h,jh-jubaubaubeubh~)r}r(h,Uh-j:h.Nh3hh5}r(h=]rh;]rh7]rh9]rh@]rUentriesr]r(hX2fireEvent() (circuits.core.manager.Manager method)h UtrauhBNhChh']rubh)r}r(h,Uh-j:h.Nh3hh5}r(hʼnhXpyrh=]rh;]rh7]rh9]rh@]rhXmethodrhjuhBNhChh']r(h)r}r(h,X#Manager.fireEvent(event, *channels)rh-jh.hh3hh5}r(h=]rh ahh/Xcircuits.core.managerrr}rbh;]rh7]rh9]rh@]rh ahXManager.fireEventrhhhuhBNhChh']r(j)r}r(h,X fireEventrh-jh.hh3jh5}r(h7]rh9]rh;]rh=]r h@]r uhBNhChh']r huX fireEventr r }r(h,Uh-jubaubj)r}r(h,Uh-jh.hh3jh5}r(h7]rh9]rh;]rh=]rh@]ruhBNhChh']r(j)r}r(h,Xeventrh5}r(h7]rh9]rh;]rh=]rh@]r uh-jh']r!huXeventr"r#}r$(h,Uh-jubah3j+ubj)r%}r&(h,X *channelsr'h5}r((h7]r)h9]r*h;]r+h=]r,h@]r-uh-jh']r.huX *channelsr/r0}r1(h,Uh-j%ubah3j+ubeubeubj9)r2}r3(h,Uh-jh.hh3j<h5}r4(h7]r5h9]r6h;]r7h=]r8h@]r9uhBNhChh']r:(h)r;}r<(h,XFire an event into the system.r=h-j2h.Xj/home/prologic/work/circuits/circuits/core/manager.py:docstring of circuits.core.manager.Manager.fireEventr>h3hh5}r?(h7]r@h9]rAh;]rBh=]rCh@]rDuhBKhChh']rEhuXFire an event into the system.rFrG}rH(h,j=h-j;ubaubcdocutils.nodes field_list rI)rJ}rK(h,Uh-j2h.Nh3U field_listrLh5}rM(h7]rNh9]rOh;]rPh=]rQh@]rRuhBNhChh']rScdocutils.nodes field rT)rU}rV(h,Uh5}rW(h7]rXh9]rYh;]rZh=]r[h@]r\uh-jJh']r](cdocutils.nodes field_name r^)r_}r`(h,Uh5}ra(h7]rbh9]rch;]rdh=]reh@]rfuh-jUh']rghuX Parametersrhri}rj(h,Uh-j_ubah3U field_namerkubcdocutils.nodes field_body rl)rm}rn(h,Uh5}ro(h7]rph9]rqh;]rrh=]rsh@]rtuh-jUh']rucdocutils.nodes bullet_list rv)rw}rx(h,Uh5}ry(h7]rzh9]r{h;]r|h=]r}h@]r~uh-jmh']r(cdocutils.nodes list_item r)r}r(h,Uh5}r(h7]rh9]rh;]rh=]rh@]ruh-jwh']rh)r}r(h,Uh5}r(h7]rh9]rh;]rh=]rh@]ruh-jh']r(cdocutils.nodes strong r)r}r(h,Xeventrh5}r(h7]rh9]rh;]rh=]rh@]ruh-jh']rhuXeventrr}r(h,Uh-jubah3UstrongrubhuX -- rr}r(h,Uh-jubhuXThe event that is to be fired.rr}r(h,XThe event that is to be fired.rh-jubeh3hubah3U list_itemrubj)r}r(h,Uh5}r(h7]rh9]rh;]rh=]rh@]ruh-jwh']rh)r}r(h,Uh5}r(h7]rh9]rh;]rh=]rh@]ruh-jh']r(j)r}r(h,Xchannelsrh5}r(h7]rh9]rh;]rh=]rh@]ruh-jh']rhuXchannelsrr}r(h,Uh-jubah3jubhuX -- rr}r(h,Uh-jubhuXThe channels that this event is delivered on. If no channels are specified, the event is delivered to the channels found in the event's rr}r(h,XThe channels that this event is delivered on. If no channels are specified, the event is delivered to the channels found in the event's rh-jubhQ)r}r(h,X:attr:`channel`rh-jh.Nh3hUh5}r(UreftyperXattrrhYhZXchannelrU refdomainrXpyrh=]rh;]rU refexplicitrh7]rh9]rh@]rhdhehfhhgjbuhBNh']rhi)r}r(h,jh5}r(h7]rh9]r(hojXpy-attrreh;]rh=]rh@]ruh-jh']rhuXchannelrr}r(h,Uh-jubah3hyubaubhuX attribute. If this attribute is not set, the event is delivered to the firing component's channel. And eventually, when set neither, the event is delivered on all channels ("*").rr}r(h,X attribute. If this attribute is not set, the event is delivered to the firing component's channel. And eventually, when set neither, the event is delivered on all channels ("*").rh-jubeh3hubah3jubeh3U bullet_listrubah3U field_bodyrubeh3Ufieldrubaubeubeubh~)r}r(h,Uh-j:h.Nh3hh5}r(h=]rh;]rh7]rh9]rh@]rUentriesr]r(hX-fire() (circuits.core.manager.Manager method)hUtrauhBNhChh']rubh)r}r(h,Uh-j:h.Nh3hh5}r(hʼnhXpyrh=]rh;]rh7]rh9]rh@]rhXmethodr hj uhBNhChh']r (h)r }r (h,XManager.fire(event, *channels)r h-jh.hh3hh5}r(h=]rhahh/Xcircuits.core.managerrr}rbh;]rh7]rh9]rh@]rhahX Manager.firerhhhuhBNhChh']r(j)r}r(h,Xfirerh-j h.hh3jh5}r(h7]rh9]rh;]rh=]r h@]r!uhBNhChh']r"huXfirer#r$}r%(h,Uh-jubaubj)r&}r'(h,Uh-j h.hh3jh5}r((h7]r)h9]r*h;]r+h=]r,h@]r-uhBNhChh']r.(j)r/}r0(h,Xeventr1h5}r2(h7]r3h9]r4h;]r5h=]r6h@]r7uh-j&h']r8huXeventr9r:}r;(h,Uh-j/ubah3j+ubj)r<}r=(h,X *channelsr>h5}r?(h7]r@h9]rAh;]rBh=]rCh@]rDuh-j&h']rEhuX *channelsrFrG}rH(h,Uh-j<ubah3j+ubeubeubj9)rI}rJ(h,Uh-jh.hh3j<h5}rK(h7]rLh9]rMh;]rNh=]rOh@]rPuhBNhChh']rQ(h)rR}rS(h,XFire an event into the system.rTh-jIh.Xe/home/prologic/work/circuits/circuits/core/manager.py:docstring of circuits.core.manager.Manager.firerUh3hh5}rV(h7]rWh9]rXh;]rYh=]rZh@]r[uhBKhChh']r\huXFire an event into the system.r]r^}r_(h,jTh-jRubaubjI)r`}ra(h,Uh-jIh.Nh3jLh5}rb(h7]rch9]rdh;]reh=]rfh@]rguhBNhChh']rhjT)ri}rj(h,Uh5}rk(h7]rlh9]rmh;]rnh=]roh@]rpuh-j`h']rq(j^)rr}rs(h,Uh5}rt(h7]ruh9]rvh;]rwh=]rxh@]ryuh-jih']rzhuX Parametersr{r|}r}(h,Uh-jrubah3jkubjl)r~}r(h,Uh5}r(h7]rh9]rh;]rh=]rh@]ruh-jih']rjv)r}r(h,Uh5}r(h7]rh9]rh;]rh=]rh@]ruh-j~h']r(j)r}r(h,Uh5}r(h7]rh9]rh;]rh=]rh@]ruh-jh']rh)r}r(h,Uh5}r(h7]rh9]rh;]rh=]rh@]ruh-jh']r(j)r}r(h,Xeventrh5}r(h7]rh9]rh;]rh=]rh@]ruh-jh']rhuXeventrr}r(h,Uh-jubah3jubhuX -- rr}r(h,Uh-jubhuXThe event that is to be fired.rr}r(h,XThe event that is to be fired.rh-jubeh3hubah3jubj)r}r(h,Uh5}r(h7]rh9]rh;]rh=]rh@]ruh-jh']rh)r}r(h,Uh5}r(h7]rh9]rh;]rh=]rh@]ruh-jh']r(j)r}r(h,Xchannelsrh5}r(h7]rh9]rh;]rh=]rh@]ruh-jh']rhuXchannelsrr}r(h,Uh-jubah3jubhuX -- rr}r(h,Uh-jubhuXThe channels that this event is delivered on. If no channels are specified, the event is delivered to the channels found in the event's rr}r(h,XThe channels that this event is delivered on. If no channels are specified, the event is delivered to the channels found in the event's rh-jubhQ)r}r(h,X:attr:`channel`rh-jh.Nh3hUh5}r(UreftyperXattrrhYhZXchannelrU refdomainrXpyrh=]rh;]rU refexplicitrh7]rh9]rh@]rhdhehfhhgjbuhBNh']rhi)r}r(h,jh5}r(h7]rh9]r(hojXpy-attrreh;]rh=]rh@]ruh-jh']rhuXchannelrr}r(h,Uh-jubah3hyubaubhuX attribute. If this attribute is not set, the event is delivered to the firing component's channel. And eventually, when set neither, the event is delivered on all channels ("*").rr}r(h,X attribute. If this attribute is not set, the event is delivered to the firing component's channel. And eventually, when set neither, the event is delivered on all channels ("*").rh-jubeh3hubah3jubeh3jubah3jubeh3jubaubeubeubh~)r}r(h,Uh-j:h.Xj/home/prologic/work/circuits/circuits/core/manager.py:docstring of circuits.core.manager.Manager.callEventrh3hh5}r(h=]rh;]rh7]rh9]rh@]rUentriesr]r(hX2callEvent() (circuits.core.manager.Manager method)h UtrauhBNhChh']r ubh)r }r (h,Uh-j:h.jh3hh5}r (hʼnhXpyr h=]rh;]rh7]rh9]rh@]rhXmethodrhjuhBNhChh']r(h)r}r(h,X#Manager.callEvent(event, *channels)rh-j h.hh3hh5}r(h=]rh ahh/Xcircuits.core.managerrr}rbh;]rh7]rh9]rh@]r h ahXManager.callEventr!hhhuhBNhChh']r"(j)r#}r$(h,X callEventr%h-jh.hh3jh5}r&(h7]r'h9]r(h;]r)h=]r*h@]r+uhBNhChh']r,huX callEventr-r.}r/(h,Uh-j#ubaubj)r0}r1(h,Uh-jh.hh3jh5}r2(h7]r3h9]r4h;]r5h=]r6h@]r7uhBNhChh']r8(j)r9}r:(h,Xeventr;h5}r<(h7]r=h9]r>h;]r?h=]r@h@]rAuh-j0h']rBhuXeventrCrD}rE(h,Uh-j9ubah3j+ubj)rF}rG(h,X *channelsrHh5}rI(h7]rJh9]rKh;]rLh=]rMh@]rNuh-j0h']rOhuX *channelsrPrQ}rR(h,Uh-jFubah3j+ubeubeubj9)rS}rT(h,Uh-j h.hh3j<h5}rU(h7]rVh9]rWh;]rXh=]rYh@]rZuhBNhChh']r[h)r\}r](h,XFire the given event to the specified channels and suspend execution until it has been dispatched. This method may only be invoked as argument to a ``yield`` on the top execution level of a handler (e.g. "``yield self.callEvent(event)``"). It effectively creates and returns a generator that will be invoked by the main loop until the event has been dispatched (see :func:`circuits.core.handlers.handler`).r^h-jSh.jh3hh5}r_(h7]r`h9]rah;]rbh=]rch@]rduhBKhChh']re(huXFire the given event to the specified channels and suspend execution until it has been dispatched. This method may only be invoked as argument to a rfrg}rh(h,XFire the given event to the specified channels and suspend execution until it has been dispatched. This method may only be invoked as argument to a rih-j\ubhi)rj}rk(h,X ``yield``rlh5}rm(h7]rnh9]roh;]rph=]rqh@]rruh-j\h']rshuXyieldrtru}rv(h,Uh-jjubah3hyubhuX0 on the top execution level of a handler (e.g. "rwrx}ry(h,X0 on the top execution level of a handler (e.g. "rzh-j\ubhi)r{}r|(h,X``yield self.callEvent(event)``r}h5}r~(h7]rh9]rh;]rh=]rh@]ruh-j\h']rhuXyield self.callEvent(event)rr}r(h,Uh-j{ubah3hyubhuX"). It effectively creates and returns a generator that will be invoked by the main loop until the event has been dispatched (see rr}r(h,X"). It effectively creates and returns a generator that will be invoked by the main loop until the event has been dispatched (see rh-j\ubhQ)r}r(h,X&:func:`circuits.core.handlers.handler`rh-j\h.Nh3hUh5}r(UreftyperXfuncrhYhZXcircuits.core.handlers.handlerrU refdomainrXpyrh=]rh;]rU refexplicitrh7]rh9]rh@]rhdhehfhhgjbuhBNh']rhi)r}r(h,jh5}r(h7]rh9]r(hojXpy-funcreh;]rh=]rh@]ruh-jh']rhuX circuits.core.handlers.handler()rr}r(h,Uh-jubah3hyubaubhuX).rr}r(h,X).rh-j\ubeubaubeubh~)r}r(h,Uh-j:h.Xe/home/prologic/work/circuits/circuits/core/manager.py:docstring of circuits.core.manager.Manager.callrh3hh5}r(h=]rh;]rh7]rh9]rh@]rUentriesr]r(hX-call() (circuits.core.manager.Manager method)h UtrauhBNhChh']rubh)r}r(h,Uh-j:h.jh3hh5}r(hʼnhXpyrh=]rh;]rh7]rh9]rh@]rhXmethodrhjuhBNhChh']r(h)r}r(h,XManager.call(event, *channels)rh-jh.hh3hh5}r(h=]rh ahh/Xcircuits.core.managerrr}rbh;]rh7]rh9]rh@]rh ahX Manager.callrhhhuhBNhChh']r(j)r}r(h,Xcallrh-jh.hh3jh5}r(h7]rh9]rh;]rh=]rh@]ruhBNhChh']rhuXcallrr}r(h,Uh-jubaubj)r}r(h,Uh-jh.hh3jh5}r(h7]rh9]rh;]rh=]rh@]ruhBNhChh']r(j)r}r(h,Xeventrh5}r(h7]rh9]rh;]rh=]rh@]ruh-jh']rhuXeventrr}r(h,Uh-jubah3j+ubj)r}r(h,X *channelsrh5}r(h7]rh9]rh;]rh=]rh@]ruh-jh']rhuX *channelsrr}r(h,Uh-jubah3j+ubeubeubj9)r}r(h,Uh-jh.hh3j<h5}r(h7]rh9]rh;]rh=]r h@]r uhBNhChh']r h)r }r (h,XFire the given event to the specified channels and suspend execution until it has been dispatched. This method may only be invoked as argument to a ``yield`` on the top execution level of a handler (e.g. "``yield self.callEvent(event)``"). It effectively creates and returns a generator that will be invoked by the main loop until the event has been dispatched (see :func:`circuits.core.handlers.handler`).rh-jh.jh3hh5}r(h7]rh9]rh;]rh=]rh@]ruhBKhChh']r(huXFire the given event to the specified channels and suspend execution until it has been dispatched. This method may only be invoked as argument to a rr}r(h,XFire the given event to the specified channels and suspend execution until it has been dispatched. This method may only be invoked as argument to a rh-j ubhi)r}r(h,X ``yield``rh5}r(h7]rh9]rh;]r h=]r!h@]r"uh-j h']r#huXyieldr$r%}r&(h,Uh-jubah3hyubhuX0 on the top execution level of a handler (e.g. "r'r(}r)(h,X0 on the top execution level of a handler (e.g. "r*h-j ubhi)r+}r,(h,X``yield self.callEvent(event)``r-h5}r.(h7]r/h9]r0h;]r1h=]r2h@]r3uh-j h']r4huXyield self.callEvent(event)r5r6}r7(h,Uh-j+ubah3hyubhuX"). It effectively creates and returns a generator that will be invoked by the main loop until the event has been dispatched (see r8r9}r:(h,X"). It effectively creates and returns a generator that will be invoked by the main loop until the event has been dispatched (see r;h-j ubhQ)r<}r=(h,X&:func:`circuits.core.handlers.handler`r>h-j h.Nh3hUh5}r?(Ureftyper@XfuncrAhYhZXcircuits.core.handlers.handlerrBU refdomainrCXpyrDh=]rEh;]rFU refexplicitrGh7]rHh9]rIh@]rJhdhehfhhgjbuhBNh']rKhi)rL}rM(h,j>h5}rN(h7]rOh9]rP(hojDXpy-funcrQeh;]rRh=]rSh@]rTuh-j<h']rUhuX circuits.core.handlers.handler()rVrW}rX(h,Uh-jLubah3hyubaubhuX).rYrZ}r[(h,X).r\h-j ubeubaubeubh~)r]}r^(h,Uh-j:h.Xl/home/prologic/work/circuits/circuits/core/manager.py:docstring of circuits.core.manager.Manager.flushEventsr_h3hh5}r`(h=]rah;]rbh7]rch9]rdh@]reUentriesrf]rg(hX4flushEvents() (circuits.core.manager.Manager method)hUtrhauhBNhChh']riubh)rj}rk(h,Uh-j:h.j_h3hh5}rl(hʼnhXpyrmh=]rnh;]roh7]rph9]rqh@]rrhXmethodrshjsuhBNhChh']rt(h)ru}rv(h,XManager.flushEvents()rwh-jjh.hh3hh5}rx(h=]ryhahh/Xcircuits.core.managerrzr{}r|bh;]r}h7]r~h9]rh@]rhahXManager.flushEventsrhhhuhBNhChh']r(j)r}r(h,X flushEventsrh-juh.hh3jh5}r(h7]rh9]rh;]rh=]rh@]ruhBNhChh']rhuX flushEventsrr}r(h,Uh-jubaubj)r}r(h,Uh-juh.hh3jh5}r(h7]rh9]rh;]rh=]rh@]ruhBNhChh']rubeubj9)r}r(h,Uh-jjh.hh3j<h5}r(h7]rh9]rh;]rh=]rh@]ruhBNhChh']rh)r}r(h,XFlush all Events in the Event Queue. If called on a manager that is not the root of an object hierarchy, the invocation is delegated to the root manager.rh-jh.j_h3hh5}r(h7]rh9]rh;]rh=]rh@]ruhBKhChh']rhuXFlush all Events in the Event Queue. If called on a manager that is not the root of an object hierarchy, the invocation is delegated to the root manager.rr}r(h,jh-jubaubaubeubh~)r}r(h,Uh-j:h.Xf/home/prologic/work/circuits/circuits/core/manager.py:docstring of circuits.core.manager.Manager.flushrh3hh5}r(h=]rh;]rh7]rh9]rh@]rUentriesr]r(hX.flush() (circuits.core.manager.Manager method)hUtrauhBNhChh']rubh)r}r(h,Uh-j:h.jh3hh5}r(hʼnhXpyrh=]rh;]rh7]rh9]rh@]rhXmethodrhjuhBNhChh']r(h)r}r(h,XManager.flush()rh-jh.hh3hh5}r(h=]rhahh/Xcircuits.core.managerrr}rbh;]rh7]rh9]rh@]rhahX Manager.flushrhhhuhBNhChh']r(j)r}r(h,Xflushrh-jh.hh3jh5}r(h7]rh9]rh;]rh=]rh@]ruhBNhChh']rhuXflushrr}r(h,Uh-jubaubj)r}r(h,Uh-jh.hh3jh5}r(h7]rh9]rh;]rh=]rh@]ruhBNhChh']rubeubj9)r}r(h,Uh-jh.hh3j<h5}r(h7]rh9]rh;]rh=]rh@]ruhBNhChh']rh)r}r(h,XFlush all Events in the Event Queue. If called on a manager that is not the root of an object hierarchy, the invocation is delegated to the root manager.rh-jh.jh3hh5}r(h7]rh9]rh;]rh=]rh@]ruhBKhChh']rhuXFlush all Events in the Event Queue. If called on a manager that is not the root of an object hierarchy, the invocation is delegated to the root manager.rr}r (h,jh-jubaubaubeubh~)r }r (h,Uh-j:h.Xf/home/prologic/work/circuits/circuits/core/manager.py:docstring of circuits.core.manager.Manager.startr h3hh5}r (h=]r h;]r h7]r h9]r h@]r Uentriesr ]r (hX.start() (circuits.core.manager.Manager method)h Utr auhBNhChh']r ubh)r }r (h,Uh-j:h.j h3hh5}r (hʼnhXpyr h=]r h;]r h7]r h9]r h@]r hXmethodr hj uhBNhChh']r (h)r }r (h,X'Manager.start(process=False, link=None)r h-j h.hh3hh5}r (h=]r h ahh/Xcircuits.core.managerr r }r bh;]r! h7]r" h9]r# h@]r$ h ahX Manager.startr% hhhuhBNhChh']r& (j)r' }r( (h,Xstartr) h-j h.hh3jh5}r* (h7]r+ h9]r, h;]r- h=]r. h@]r/ uhBNhChh']r0 huXstartr1 r2 }r3 (h,Uh-j' ubaubj)r4 }r5 (h,Uh-j h.hh3jh5}r6 (h7]r7 h9]r8 h;]r9 h=]r: h@]r; uhBNhChh']r< (j)r= }r> (h,X process=Falser? h5}r@ (h7]rA h9]rB h;]rC h=]rD h@]rE uh-j4 h']rF huX process=FalserG rH }rI (h,Uh-j= ubah3j+ubj)rJ }rK (h,X link=NonerL h5}rM (h7]rN h9]rO h;]rP h=]rQ h@]rR uh-j4 h']rS huX link=NonerT rU }rV (h,Uh-jJ ubah3j+ubeubeubj9)rW }rX (h,Uh-j h.hh3j<h5}rY (h7]rZ h9]r[ h;]r\ h=]r] h@]r^ uhBNhChh']r_ h)r` }ra (h,XStart a new thread or process that invokes this manager's ``run()`` method. The invocation of this method returns immediately after the task or process has been started.rb h-jW h.j h3hh5}rc (h7]rd h9]re h;]rf h=]rg h@]rh uhBKhChh']ri (huX:Start a new thread or process that invokes this manager's rj rk }rl (h,X:Start a new thread or process that invokes this manager's rm h-j` ubhi)rn }ro (h,X ``run()``rp h5}rq (h7]rr h9]rs h;]rt h=]ru h@]rv uh-j` h']rw huXrun()rx ry }rz (h,Uh-jn ubah3hyubhuXf method. The invocation of this method returns immediately after the task or process has been started.r{ r| }r} (h,Xf method. The invocation of this method returns immediately after the task or process has been started.r~ h-j` ubeubaubeubh~)r }r (h,Uh-j:h.Xe/home/prologic/work/circuits/circuits/core/manager.py:docstring of circuits.core.manager.Manager.stopr h3hh5}r (h=]r h;]r h7]r h9]r h@]r Uentriesr ]r (hX-stop() (circuits.core.manager.Manager method)hUtr auhBNhChh']r ubh)r }r (h,Uh-j:h.j h3hh5}r (hʼnhXpyr h=]r h;]r h7]r h9]r h@]r hXmethodr hj uhBNhChh']r (h)r }r (h,XManager.stop()r h-j h.hh3hh5}r (h=]r hahh/Xcircuits.core.managerr r }r bh;]r h7]r h9]r h@]r hahX Manager.stopr hhhuhBNhChh']r (j)r }r (h,Xstopr h-j h.hh3jh5}r (h7]r h9]r h;]r h=]r h@]r uhBNhChh']r huXstopr r }r (h,Uh-j ubaubj)r }r (h,Uh-j h.hh3jh5}r (h7]r h9]r h;]r h=]r h@]r uhBNhChh']r ubeubj9)r }r (h,Uh-j h.hh3j<h5}r (h7]r h9]r h;]r h=]r h@]r uhBNhChh']r h)r }r (h,XTStop this manager. Invoking this method causes an invocation of ``run()`` to return.r h-j h.j h3hh5}r (h7]r h9]r h;]r h=]r h@]r uhBKhChh']r (huX@Stop this manager. Invoking this method causes an invocation of r r }r (h,X@Stop this manager. Invoking this method causes an invocation of r h-j ubhi)r }r (h,X ``run()``r h5}r (h7]r h9]r h;]r h=]r h@]r uh-j h']r huXrun()r r }r (h,Uh-j ubah3hyubhuX to return.r r }r (h,X to return.r h-j ubeubaubeubh~)r }r (h,Uh-j:h.Nh3hh5}r (h=]r h;]r h7]r h9]r h@]r Uentriesr ]r (hX-tick() (circuits.core.manager.Manager method)hUtr auhBNhChh']r ubh)r }r (h,Uh-j:h.Nh3hh5}r (hʼnhXpyr h=]r h;]r h7]r h9]r h@]r hXmethodr hj uhBNhChh']r (h)r }r (h,XManager.tick(timeout=-1)r h-j h.hh3hh5}r (h=]r hahh/Xcircuits.core.managerr r }r bh;]r h7]r h9]r h@]r hahX Manager.tickr hhhuhBNhChh']r (j)r }r (h,Xtickr h-j h.hh3jh5}r (h7]r h9]r h;]r h=]r h@]r uhBNhChh']r huXtickr r }r (h,Uh-j ubaubj)r }r (h,Uh-j h.hh3jh5}r (h7]r h9]r h;]r h=]r h@]r uhBNhChh']r j)r }r (h,X timeout=-1r h5}r! (h7]r" h9]r# h;]r$ h=]r% h@]r& uh-j h']r' huX timeout=-1r( r) }r* (h,Uh-j ubah3j+ubaubeubj9)r+ }r, (h,Uh-j h.hh3j<h5}r- (h7]r. h9]r/ h;]r0 h=]r1 h@]r2 uhBNhChh']r3 (h)r4 }r5 (h,XExecute all possible actions once. Process all registered tasks and flush the event queue. If the application is running fire a GenerateEvents to get new events from sources.r6 h-j+ h.Xe/home/prologic/work/circuits/circuits/core/manager.py:docstring of circuits.core.manager.Manager.tickr7 h3hh5}r8 (h7]r9 h9]r: h;]r; h=]r< h@]r= uhBKhChh']r> huXExecute all possible actions once. Process all registered tasks and flush the event queue. If the application is running fire a GenerateEvents to get new events from sources.r? r@ }rA (h,j6 h-j4 ubaubh)rB }rC (h,XrThis method is usually invoked from :meth:`~.run`. It may also be used to build an application specific main loop.rD h-j+ h.j7 h3hh5}rE (h7]rF h9]rG h;]rH h=]rI h@]rJ uhBKhChh']rK (huX$This method is usually invoked from rL rM }rN (h,X$This method is usually invoked from rO h-jB ubhQ)rP }rQ (h,X :meth:`~.run`rR h-jB h.Nh3hUh5}rS (UreftyperT XmethrU jhYhZXrunrV U refdomainrW XpyrX h=]rY h;]rZ U refexplicitr[ h7]r\ h9]r] h@]r^ hdhehfhhgjbuhBNh']r_ hi)r` }ra (h,jR h5}rb (h7]rc h9]rd (hojX Xpy-methre eh;]rf h=]rg h@]rh uh-jP h']ri huXrun()rj rk }rl (h,Uh-j` ubah3hyubaubhuXA. It may also be used to build an application specific main loop.rm rn }ro (h,XA. It may also be used to build an application specific main loop.rp h-jB ubeubjI)rq }rr (h,Uh-j+ h.Nh3jLh5}rs (h7]rt h9]ru h;]rv h=]rw h@]rx uhBNhChh']ry jT)rz }r{ (h,Uh5}r| (h7]r} h9]r~ h;]r h=]r h@]r uh-jq h']r (j^)r }r (h,Uh5}r (h7]r h9]r h;]r h=]r h@]r uh-jz h']r huX Parametersr r }r (h,Uh-j ubah3jkubjl)r }r (h,Uh5}r (h7]r h9]r h;]r h=]r h@]r uh-jz h']r h)r }r (h,Uh5}r (h7]r h9]r h;]r h=]r h@]r uh-j h']r (j)r }r (h,Xtimeoutr h5}r (h7]r h9]r h;]r h=]r h@]r uh-j h']r huXtimeoutr r }r (h,Uh-j ubah3jubhuX (r r }r (h,Uh-j ubhQ)r }r (h,Uh5}r (Ureftyper Uobjr U reftargetr Xfloat, measuring secondsr U refdomainr j h=]r h;]r U refexplicitr h7]r h9]r h@]r uh-j h']r cdocutils.nodes emphasis r )r }r (h,j h5}r (h7]r h9]r h;]r h=]r h@]r uh-j h']r huXfloat, measuring secondsr r }r (h,Uh-j ubah3Uemphasisr ubah3hUubhuX)r }r (h,Uh-j ubhuX -- r r }r (h,Uh-j ubhuXzthe maximum waiting time spent in this method. If negative, the method may block until at least one action has been taken.r r }r (h,Xzthe maximum waiting time spent in this method. If negative, the method may block until at least one action has been taken.r h-j ubeh3hubah3jubeh3jubaubeubeubh~)r }r (h,Uh-j:h.Xd/home/prologic/work/circuits/circuits/core/manager.py:docstring of circuits.core.manager.Manager.runr h3hh5}r (h=]r h;]r h7]r h9]r h@]r Uentriesr ]r (hX,run() (circuits.core.manager.Manager method)hUtr auhBNhChh']r ubh)r }r (h,Uh-j:h.j h3hh5}r (hʼnhXpyr h=]r h;]r h7]r h9]r h@]r hXmethodr hj uhBNhChh']r (h)r }r (h,XManager.run(socket=None)r h-j h.hh3hh5}r (h=]r hahh/Xcircuits.core.managerr r }r bh;]r h7]r h9]r h@]r hahX Manager.runr hhhuhBNhChh']r (j)r }r (h,Xrunr h-j h.hh3jh5}r (h7]r h9]r h;]r h=]r h@]r uhBNhChh']r huXrunr r }r (h,Uh-j ubaubj)r }r (h,Uh-j h.hh3jh5}r (h7]r h9]r h;]r h=]r h@]r uhBNhChh']r j)r }r (h,X socket=Noner h5}r (h7]r h9]r h;]r h=]r h@]r uh-j h']r huX socket=Noner r }r (h,Uh-j ubah3j+ubaubeubj9)r }r! (h,Uh-j h.hh3j<h5}r" (h7]r# h9]r$ h;]r% h=]r& h@]r' uhBNhChh']r( (h)r) }r* (h,XrRun this manager. The method fires the :class:`~.events.Started` event and then continuously calls :meth:`~.tick`.r+ h-j h.j h3hh5}r, (h7]r- h9]r. h;]r/ h=]r0 h@]r1 uhBKhChh']r2 (huX'Run this manager. The method fires the r3 r4 }r5 (h,X'Run this manager. The method fires the r6 h-j) ubhQ)r7 }r8 (h,X:class:`~.events.Started`r9 h-j) h.Nh3hUh5}r: (Ureftyper; Xclassr< jhYhZXevents.Startedr= U refdomainr> Xpyr? h=]r@ h;]rA U refexplicitrB h7]rC h9]rD h@]rE hdhehfhhgjbuhBNh']rF hi)rG }rH (h,j9 h5}rI (h7]rJ h9]rK (hoj? Xpy-classrL eh;]rM h=]rN h@]rO uh-j7 h']rP huXStartedrQ rR }rS (h,Uh-jG ubah3hyubaubhuX# event and then continuously calls rT rU }rV (h,X# event and then continuously calls rW h-j) ubhQ)rX }rY (h,X:meth:`~.tick`rZ h-j) h.Nh3hUh5}r[ (Ureftyper\ Xmethr] jhYhZXtickr^ U refdomainr_ Xpyr` h=]ra h;]rb U refexplicitrc h7]rd h9]re h@]rf hdhehfhhgjbuhBNh']rg hi)rh }ri (h,jZ h5}rj (h7]rk h9]rl (hoj` Xpy-methrm eh;]rn h=]ro h@]rp uh-jX h']rq huXtick()rr rs }rt (h,Uh-jh ubah3hyubaubhuX.ru }rv (h,X.h-j) ubeubh)rw }rx (h,XGThe method returns when the manager's :meth:`~.stop` method is invoked.ry h-j h.j h3hh5}rz (h7]r{ h9]r| h;]r} h=]r~ h@]r uhBKhChh']r (huX&The method returns when the manager's r r }r (h,X&The method returns when the manager's r h-jw ubhQ)r }r (h,X:meth:`~.stop`r h-jw h.Nh3hUh5}r (Ureftyper Xmethr jhYhZXstopr U refdomainr Xpyr h=]r h;]r U refexplicitr h7]r h9]r h@]r hdhehfhhgjbuhBNh']r hi)r }r (h,j h5}r (h7]r h9]r (hoj Xpy-methr eh;]r h=]r h@]r uh-j h']r huXstop()r r }r (h,Uh-j ubah3hyubaubhuX method is invoked.r r }r (h,X method is invoked.r h-jw ubeubh)r }r (h,XIf invoked by a programs main thread, a signal handler for the ``INT`` and ``TERM`` signals is installed. This handler fires the corresponding :class:`~.events.Signal` events and then calls :meth:`~.stop` for the manager.r h-j h.j h3hh5}r (h7]r h9]r h;]r h=]r h@]r uhBKhChh']r (huX?If invoked by a programs main thread, a signal handler for the r r }r (h,X?If invoked by a programs main thread, a signal handler for the r h-j ubhi)r }r (h,X``INT``r h5}r (h7]r h9]r h;]r h=]r h@]r uh-j h']r huXINTr r }r (h,Uh-j ubah3hyubhuX and r r }r (h,X and r h-j ubhi)r }r (h,X``TERM``r h5}r (h7]r h9]r h;]r h=]r h@]r uh-j h']r huXTERMr r }r (h,Uh-j ubah3hyubhuX< signals is installed. This handler fires the corresponding r r }r (h,X< signals is installed. This handler fires the corresponding r h-j ubhQ)r }r (h,X:class:`~.events.Signal`r h-j h.Nh3hUh5}r (Ureftyper Xclassr jhYhZX events.Signalr U refdomainr Xpyr h=]r h;]r U refexplicitr h7]r h9]r h@]r hdhehfhhgjbuhBNh']r hi)r }r (h,j h5}r (h7]r h9]r (hoj Xpy-classr eh;]r h=]r h@]r uh-j h']r huXSignalr r }r (h,Uh-j ubah3hyubaubhuX events and then calls r r }r (h,X events and then calls r h-j ubhQ)r }r (h,X:meth:`~.stop`r h-j h.Nh3hUh5}r (Ureftyper Xmethr jhYhZXstopr U refdomainr Xpyr h=]r h;]r U refexplicitr h7]r h9]r h@]r hdhehfhhgjbuhBNh']r hi)r }r (h,j h5}r (h7]r h9]r (hoj Xpy-methr eh;]r h=]r h@]r uh-j h']r huXstop()r r }r (h,Uh-j ubah3hyubaubhuX for the manager.r r }r (h,X for the manager.r h-j ubeubeubeubeubeubeubh))r }r (h,Uh-h*h.h1h3h4h5}r (h7]r h9]r h;]r h=]r h&ah@]r hauhBKhChh']r (hE)r! }r" (h,X Componentsr# h-j h.h1h3hIh5}r$ (h7]r% h9]r& h;]r' h=]r( h@]r) uhBKhChh']r* huX Componentsr+ r, }r- (h,j# h-j! ubaubh)r. }r/ (h,X**none**r0 h-j h.h1h3hh5}r1 (h7]r2 h9]r3 h;]r4 h=]r5 h@]r6 uhBKhChh']r7 j)r8 }r9 (h,j0 h5}r: (h7]r; h9]r< h;]r= h=]r> h@]r? uh-j. h']r@ huXnonerA rB }rC (h,Uh-j8 ubah3jubaubeubh))rD }rE (h,Uh-h*h.h1h3h4h5}rF (h7]rG h9]rH h;]rI h=]rJ h$ah@]rK hauhBKhChh']rL (hE)rM }rN (h,XEventsrO h-jD h.h1h3hIh5}rP (h7]rQ h9]rR h;]rS h=]rT h@]rU uhBKhChh']rV huXEventsrW rX }rY (h,jO h-jM ubaubh)rZ }r[ (h,X**none**r\ h-jD h.h1h3hh5}r] (h7]r^ h9]r_ h;]r` h=]ra h@]rb uhBKhChh']rc j)rd }re (h,j\ h5}rf (h7]rg h9]rh h;]ri h=]rj h@]rk uh-jZ h']rl huXnonerm rn }ro (h,Uh-jd ubah3jubaubeubh))rp }rq (h,Uh-h*h.h1h3h4h5}rr (h7]rs h9]rt h;]ru h=]rv h"ah@]rw hauhBKhChh']rx (hE)ry }rz (h,X Functionsr{ h-jp h.h1h3hIh5}r| (h7]r} h9]r~ h;]r h=]r h@]r uhBKhChh']r huX Functionsr r }r (h,j{ h-jy ubaubh)r }r (h,X**none**r h-jp h.h1h3hh5}r (h7]r h9]r h;]r h=]r h@]r uhBKhChh']r j)r }r (h,j h5}r (h7]r h9]r h;]r h=]r h@]r uh-j h']r huXnoner r }r (h,Uh-j ubah3jubaubeubeubah,UU transformerr NU footnote_refsr }r Urefnamesr }r Usymbol_footnotesr ]r Uautofootnote_refsr ]r Usymbol_footnote_refsr ]r U citationsr ]r hChU current_liner NUtransform_messagesr ]r Ureporterr NUid_startr KU autofootnotesr ]r U citation_refsr }r Uindirect_targetsr ]r Usettingsr (cdocutils.frontend Values r or }r (Ufootnote_backlinksr KUrecord_dependenciesr NU rfc_base_urlr Uhttp://tools.ietf.org/html/r U tracebackr Upep_referencesr NUstrip_commentsr NU toc_backlinksr Uentryr U language_coder Uenr U datestampr NU report_levelr KU _destinationr NU halt_levelr KU strip_classesr NhINUerror_encoding_error_handlerr Ubackslashreplacer Udebugr NUembed_stylesheetr Uoutput_encoding_error_handlerr Ustrictr U sectnum_xformr KUdump_transformsr NU docinfo_xformr KUwarning_streamr NUpep_file_url_templater Upep-%04dr Uexit_status_levelr KUconfigr NUstrict_visitorr NUcloak_email_addressesr Utrim_footnote_reference_spacer Uenvr NUdump_pseudo_xmlr NUexpose_internalsr NUsectsubtitle_xformr U source_linkr NUrfc_referencesr NUoutput_encodingr Uutf-8r U source_urlr NUinput_encodingr U utf-8-sigr U_disable_configr NU id_prefixr UU tab_widthr KUerror_encodingr U ISO-8859-1r U_sourcer UF/home/prologic/work/circuits/docs/source/api/circuits_core_manager.rstr Ugettext_compactr U generatorr NUdump_internalsr NU smart_quotesr U pep_base_urlr Uhttp://www.python.org/dev/peps/r Usyntax_highlightr Ulongr Uinput_encoding_error_handlerr j Uauto_id_prefixr Uidr Udoctitle_xformr Ustrip_elements_with_classesr NU _config_filesr ]r Ufile_insertion_enabledr KU raw_enabledr KU dump_settingsr NubUsymbol_footnote_startr KUidsr }r (hjh"jp h jh jhjch jh j h jh?cdocutils.nodes target r )r }r (h,Uh-h*h.hh3Utargetr h5}r (h7]r h=]r h?ah;]r Uismodr h9]r h@]r uhBKhChh']r ubhhh$jD h#h*h%hhj hj hj h&j hjhjuhj uUsubstitution_namesr }r h3hCh5}r (h7]r h=]r h;]r Usourcer h1h9]r h@]r uU footnotesr ]r Urefidsr }r ub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_tools.doctree0000644000014400001440000013016712113366666024773 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(Xcircuits.web.tools.gzipqX functionsqNX!circuits.web.tools.validate_etagsqXcircuits.web.tools -- toolsq NX!circuits.web.tools.serve_downloadq Xcircuits.web.tools.serve_fileq X!circuits.web.tools.validate_sinceq X componentsq NXcircuits.web.tools.basic_authqXcircuits.web.tools.digest_authqXcircuits.web.tools.expiresqXeventsqNXcircuits.web.tools.check_authquUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hhhU functionsqhhh Ucircuits-web-tools-toolsqh h h h h h h U componentsqhhhhhhhUeventsqhhuUchildrenq ]q!cdocutils.nodes section q")q#}q$(U rawsourceq%UUparentq&hUsourceq'cdocutils.nodes reprunicode q(XC/home/prologic/work/circuits/docs/source/api/circuits_web_tools.rstq)q*}q+bUtagnameq,Usectionq-U attributesq.}q/(Udupnamesq0]q1Uclassesq2]q3Ubackrefsq4]q5Uidsq6]q7(Xmodule-circuits.web.toolsq8heUnamesq9]q:h auUlineq;KUdocumentq)q?}q@(h%X":mod:`circuits.web.tools` -- ToolsqAh&h#h'h*h,UtitleqBh.}qC(h0]qDh2]qEh4]qFh6]qGh9]qHuh;Khqzh,Uindexq{h.}q|(h6]q}h4]q~h0]qh2]qh9]qUentriesq]q(UsingleqXcircuits.web.tools (module)Xmodule-circuits.web.toolsUtqauh;Kh)q}q(h%XEventsqh&hh'h*h,hBh.}q(h0]qh2]qh4]qh6]qh9]quh;Kh)q}q(h%X Componentsqh&hh'h*h,hBh.}q(h0]qh2]qh4]qh6]qh9]quh;Kh)r}r(h%X Functionsr h&hh'h*h,hBh.}r (h0]r h2]r h4]r h6]rh9]ruh;Khr5h,Udesc_signaturer6h.}r7(h6]r8haUmoduler9h(Xcircuits.web.toolsr:r;}r<bh4]r=h0]r>h2]r?h9]r@haUfullnamerAX basic_authrBUclassrCUUfirstrDuh;Nhuh&jh ]r?cdocutils.nodes emphasis r@)rA}rB(h%j7h.}rC(h0]rDh2]rEh4]rFh6]rGh9]rHuh&j1h ]rIhnXstrrJrK}rL(h%Uh&jAubah,UemphasisrMubah,hNubhnX)rN}rO(h%Uh&jubhnX -- rPrQ}rR(h%Uh&jubhnXThe authentication realm.rSrT}rU(h%XThe authentication realm.rVh&jubeh,hubah,U list_itemrWubj)rX}rY(h%Uh.}rZ(h0]r[h2]r\h4]r]h6]r^h9]r_uh&jh ]r`h)ra}rb(h%Uh.}rc(h0]rdh2]reh4]rfh6]rgh9]rhuh&jXh ]ri(h)rj}rk(h%Xusersrlh.}rm(h0]rnh2]roh4]rph6]rqh9]rruh&jah ]rshnXusersrtru}rv(h%Uh&jjubah,hubhnX (rwrx}ry(h%Uh&jaubhJ)rz}r{(h%Uh.}r|(Ureftyper}j5U reftargetr~Xdict or callablerU refdomainrj'h6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jah ]rj@)r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jzh ]rhnXdict or callablerr}r(h%Uh&jubah,jMubah,hNubhnX)r}r(h%Uh&jaubhnX -- rr}r(h%Uh&jaubhnXHA dict of the form: {username: password} or a callable returning a dict.rr}r(h%XHA dict of the form: {username: password} or a callable returning a dict.rh&jaubeh,hubah,jWubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rh)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]r(h)r}r(h%Xencryptrh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXencryptrr}r(h%Uh&jubah,hubhnX (rr}r(h%Uh&jubhJ)r}r(h%Uh.}r(Ureftyperj5U reftargetrXcallablerU refdomainrj'h6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jh ]rj@)r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXcallablerr}r(h%Uh&jubah,jMubah,hNubhnX)r}r(h%Uh&jubhnX -- rr}r(h%Uh&jubhnXlCallable used to encrypt the password returned from the user-agent. if None it defaults to a md5 encryption.rr}r(h%XlCallable used to encrypt the password returned from the user-agent. if None it defaults to a md5 encryption.rh&jubeh,hubah,jWubeh,U bullet_listrubah,U field_bodyrubeh,Ufieldrubaubeubeubhw)r}r(h%Uh&hh'Nh,h{h.}r(h6]rh4]rh0]rh2]rh9]rUentriesr]r(hX+check_auth() (in module circuits.web.tools)hUtrauh;Nhh4]r?h6]r@h9]rAuh&j#h ]rBhnXresponserCrD}rE(h%Uh&j9ubah,j|ubjn)rF}rG(h%XrealmrHh.}rI(h0]rJh2]rKh4]rLh6]rMh9]rNuh&j#h ]rOhnXrealmrPrQ}rR(h%Uh&jFubah,j|ubjn)rS}rT(h%XusersrUh.}rV(h0]rWh2]rXh4]rYh6]rZh9]r[uh&j#h ]r\hnXusersr]r^}r_(h%Uh&jSubah,j|ubjn)r`}ra(h%X encrypt=Nonerbh.}rc(h0]rdh2]reh4]rfh6]rgh9]rhuh&j#h ]rihnX encrypt=Nonerjrk}rl(h%Uh&j`ubah,j|ubeubeubj)rm}rn(h%Uh&jh'j5h,jh.}ro(h0]rph2]rqh4]rrh6]rsh9]rtuh;NhhnXdict or callabler?r@}rA(h%Uh&j6ubah,jMubah,hNubhnX)rB}rC(h%Uh&jubhnX -- rDrE}rF(h%Uh&jubhnXHA dict of the form: {username: password} or a callable returning a dict.rGrH}rI(h%XHA dict of the form: {username: password} or a callable returning a dict.rJh&jubeh,hubah,jWubj)rK}rL(h%Uh.}rM(h0]rNh2]rOh4]rPh6]rQh9]rRuh&jh ]rSh)rT}rU(h%Uh.}rV(h0]rWh2]rXh4]rYh6]rZh9]r[uh&jKh ]r\(h)r]}r^(h%Xencryptr_h.}r`(h0]rah2]rbh4]rch6]rdh9]reuh&jTh ]rfhnXencryptrgrh}ri(h%Uh&j]ubah,hubhnX (rjrk}rl(h%Uh&jTubhJ)rm}rn(h%Uh.}ro(Ureftyperpj5U reftargetrqXcallablerrU refdomainrsjh6]rth4]ruU refexplicitrvh0]rwh2]rxh9]ryuh&jTh ]rzj@)r{}r|(h%jrh.}r}(h0]r~h2]rh4]rh6]rh9]ruh&jmh ]rhnXcallablerr}r(h%Uh&j{ubah,jMubah,hNubhnX)r}r(h%Uh&jTubhnX -- rr}r(h%Uh&jTubhnXlCallable used to encrypt the password returned from the user-agent. if None it defaults to a md5 encryption.rr}r(h%XlCallable used to encrypt the password returned from the user-agent. if None it defaults to a md5 encryption.rh&jTubeh,hubah,jWubeh,jubah,jubeh,jubaubeubeubhw)r}r(h%Uh&hh'Nh,h{h.}r(h6]rh4]rh0]rh2]rh9]rUentriesr]r(hX,digest_auth() (in module circuits.web.tools)hUtrauh;Nhh9]r?uh&j/h ]r@(j)rA}rB(h%Uh.}rC(h0]rDh2]rEh4]rFh6]rGh9]rHuh&j8h ]rIhnX ParametersrJrK}rL(h%Uh&jAubah,jubj)rM}rN(h%Uh.}rO(h0]rPh2]rQh4]rRh6]rSh9]rTuh&j8h ]rUj)rV}rW(h%Uh.}rX(h0]rYh2]rZh4]r[h6]r\h9]r]uh&jMh ]r^(j)r_}r`(h%Uh.}ra(h0]rbh2]rch4]rdh6]reh9]rfuh&jVh ]rgh)rh}ri(h%Uh.}rj(h0]rkh2]rlh4]rmh6]rnh9]rouh&j_h ]rp(h)rq}rr(h%Xrealmrsh.}rt(h0]ruh2]rvh4]rwh6]rxh9]ryuh&jhh ]rzhnXrealmr{r|}r}(h%Uh&jqubah,hubhnX (r~r}r(h%Uh&jhubhJ)r}r(h%Uh.}r(Ureftyperj5U reftargetrXstrrU refdomainrjh6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jhh ]rj@)r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXstrrr}r(h%Uh&jubah,jMubah,hNubhnX)r}r(h%Uh&jhubhnX -- rr}r(h%Uh&jhubhnXThe authentication realm.rr}r(h%XThe authentication realm.rh&jhubeh,hubah,jWubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jVh ]rh)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]r(h)r}r(h%Xusersrh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXusersrr}r(h%Uh&jubah,hubhnX (rr}r(h%Uh&jubhJ)r}r(h%Uh.}r(Ureftyperj5U reftargetrXdict or callablerU refdomainrjh6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jh ]rj@)r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXdict or callablerr}r(h%Uh&jubah,jMubah,hNubhnX)r}r(h%Uh&jubhnX -- rr}r(h%Uh&jubhnXHA dict of the form: {username: password} or a callable returning a dict.rr}r(h%XHA dict of the form: {username: password} or a callable returning a dict.rh&jubeh,hubah,jWubeh,jubah,jubeh,jubaubeubeubhw)r}r(h%Uh&hh'XZ/home/prologic/work/circuits/circuits/web/tools.py:docstring of circuits.web.tools.expiresrh,h{h.}r(h6]rh4]rh0]rh2]rh9]rUentriesr]r(hX(expires() (in module circuits.web.tools)hUtrauh;Nh}r?(h%Xresponser@h.}rA(h0]rBh2]rCh4]rDh6]rEh9]rFuh&j(h ]rGhnXresponserHrI}rJ(h%Uh&j>ubah,j|ubjn)rK}rL(h%Xsecs=0rMh.}rN(h0]rOh2]rPh4]rQh6]rRh9]rSuh&j(h ]rThnXsecs=0rUrV}rW(h%Uh&jKubah,j|ubjn)rX}rY(h%X force=FalserZh.}r[(h0]r\h2]r]h4]r^h6]r_h9]r`uh&j(h ]rahnX force=Falserbrc}rd(h%Uh&jXubah,j|ubeubeubj)re}rf(h%Uh&jh'j5h,jh.}rg(h0]rhh2]rih4]rjh6]rkh9]rluh;Nh 0 is present * The 'identity' value is given with a qvalue > 0.r(h&jh'jh,Udefinition_list_itemr)h.}r*(h0]r+h2]r,h4]r-h6]r.h9]r/uh;K h ]r0(cdocutils.nodes term r1)r2}r3(h%X9No compression is performed if any of the following hold:r4h&j&h'jh,Utermr5h.}r6(h0]r7h2]r8h4]r9h6]r:h9]r;uh;K h ]r<hnX9No compression is performed if any of the following hold:r=r>}r?(h%X9No compression is performed if any of the following hold:r@h&j2ubaubcdocutils.nodes definition rA)rB}rC(h%Uh.}rD(h0]rEh2]rFh4]rGh6]rHh9]rIuh&j&h ]rJj)rK}rL(h%Uh.}rM(UbulletrNX*h6]rOh4]rPh0]rQh2]rRh9]rSuh&jBh ]rT(j)rU}rV(h%X2The client sends no Accept-Encoding request headerrWh.}rX(h0]rYh2]rZh4]r[h6]r\h9]r]uh&jKh ]r^h)r_}r`(h%jWh&jUh'jh,hh.}ra(h0]rbh2]rch4]rdh6]reh9]rfuh;Kh ]rghnX2The client sends no Accept-Encoding request headerrhri}rj(h%jWh&j_ubaubah,jWubj)rk}rl(h%X>No 'gzip' or 'x-gzip' is present in the Accept-Encoding headerrmh.}rn(h0]roh2]rph4]rqh6]rrh9]rsuh&jKh ]rth)ru}rv(h%jmh&jkh'jh,hh.}rw(h0]rxh2]ryh4]rzh6]r{h9]r|uh;Kh ]r}hnX>No 'gzip' or 'x-gzip' is present in the Accept-Encoding headerr~r}r(h%jmh&juubaubah,jWubj)r}r(h%X2No 'gzip' or 'x-gzip' with a qvalue > 0 is presentrh.}r(h0]rh2]rh4]rh6]rh9]ruh&jKh ]rh)r}r(h%jh&jh'jh,hh.}r(h0]rh2]rh4]rh6]rh9]ruh;K h ]rhnX2No 'gzip' or 'x-gzip' with a qvalue > 0 is presentrr}r(h%jh&jubaubah,jWubj)r}r(h%X0The 'identity' value is given with a qvalue > 0.rh.}r(h0]rh2]rh4]rh6]rh9]ruh&jKh ]rh)r}r(h%jh&jh'jh,hh.}r(h0]rh2]rh4]rh6]rh9]ruh;K h ]rhnX0The 'identity' value is given with a qvalue > 0.rr}r(h%jh&jubaubah,jWubeh,jubah,U definitionrubeubaubeubeubhw)r}r(h%Uh&hh'Xa/home/prologic/work/circuits/circuits/web/tools.py:docstring of circuits.web.tools.serve_downloadrh,h{h.}r(h6]rh4]rh0]rh2]rh9]rUentriesr]r(hX/serve_download() (in module circuits.web.tools)h Utrauh;Nh}r?(h%j5h&j3ubaubaubeubhw)r@}rA(h%Uh&hh'X]/home/prologic/work/circuits/circuits/web/tools.py:docstring of circuits.web.tools.serve_filerBh,h{h.}rC(h6]rDh4]rEh0]rFh2]rGh9]rHUentriesrI]rJ(hX+serve_file() (in module circuits.web.tools)h UtrKauh;Nh; filename=". If name is None, it will be set to the basename of path. If disposition is None, no Content-Disposition header will be written.rh&jh'jBh,hh.}r(h0]rh2]rh4]rh6]r h9]r uh;Kh; filename=". If name is None, it will be set to the basename of path. If disposition is None, no Content-Disposition header will be written.r r }r (h%jh&jubaubeubeubhw)r }r (h%Uh&hh'Xa/home/prologic/work/circuits/circuits/web/tools.py:docstring of circuits.web.tools.validate_etagsr h,h{h.}r (h6]r h4]r h0]r h2]r h9]r Uentriesr ]r (hX/validate_etags() (in module circuits.web.tools)hUtr auh;Nh h6]r? h9]r@ uh;Nh Urefnamesr? }r@ Usymbol_footnotesrA ]rB Uautofootnote_refsrC ]rD Usymbol_footnote_refsrE ]rF U citationsrG ]rH h/home/prologic/work/circuits/docs/source/api/circuits_core.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q((Xmodule-circuits.coreq)heUnamesq*]q+hauUlineq,KUdocumentq-hh]q.(cdocutils.nodes title q/)q0}q1(hX*:mod:`circuits.core` -- Core Functionalityq2hhhhhUtitleq3h}q4(h!]q5h#]q6h%]q7h']q8h*]q9uh,Kh-hh]q:(csphinx.addnodes pending_xref q;)q<}q=(hX:mod:`circuits.core`q>hh0hhhU pending_xrefq?h}q@(UreftypeqAXmodqBUrefwarnqCU reftargetqDX circuits.coreqEU refdomainqFXpyqGh']qHh%]qIU refexplicitqJh!]qKh#]qLh*]qMUrefdocqNUapi/circuits_coreqOUpy:classqPNU py:moduleqQNuh,Kh]qRcdocutils.nodes literal qS)qT}qU(hh>h}qV(h!]qWh#]qX(UxrefqYhGXpy-modqZeh%]q[h']q\h*]q]uhhqkhUindexqlh}qm(h']qnh%]qoh!]qph#]qqh*]qrUentriesqs]qt(UsinglequXcircuits.core (module)Xmodule-circuits.coreUtqvauh,Kh-hh]qwubcdocutils.nodes paragraph qx)qy}qz(hXCoreq{hhhXQ/home/prologic/work/circuits/circuits/core/__init__.py:docstring of circuits.coreq|hU paragraphq}h}q~(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_XCoreqq}q(hh{hhyubaubhx)q}q(hXIThis package contains the essential core parts of the circuits framework.qhhhh|hh}h}q(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_XIThis package contains the essential core parts of the circuits framework.qq}q(hhhhubaubcdocutils.nodes compound q)q}q(hUhhhhhUcompoundqh}q(h!]qh#]qUtoctree-wrapperqah%]qh']qh*]quh,Nh-hh]qcsphinx.addnodes toctree q)q}q(hUhhhhhUtoctreeqh}q(UnumberedqKhhOU titlesonlyqUglobqh']qh%]qh!]qh#]qh*]qUentriesq]q(NUapi/circuits_core_componentsqqNUapi/circuits_core_eventsqqNUapi/circuits_core_handlersqqNUapi/circuits_core_managerqqNUapi/circuits_core_valuesqqNUapi/circuits_core_pollersqqNUapi/circuits_core_timersqqNUapi/circuits_core_loaderqqNUapi/circuits_core_utilsqqNUapi/circuits_core_workersq†qNUapi/circuits_core_debuggerqĆqeUhiddenqƉU includefilesq]q(hhhhhhhhhhheUmaxdepthqKuh,Kh]qubaubeubahUU transformerqNU footnote_refsq}qUrefnamesq}qUsymbol_footnotesq]qUautofootnote_refsq]qUsymbol_footnote_refsq]qU citationsq]qh-hU current_lineqNUtransform_messagesq]qUreporterqNUid_startqKU autofootnotesq]qU citation_refsq}qUindirect_targetsq]qUsettingsq(cdocutils.frontend Values qoq}q(Ufootnote_backlinksqKUrecord_dependenciesqNU rfc_base_urlqUhttp://tools.ietf.org/html/qU tracebackqUpep_referencesqNUstrip_commentsqNU toc_backlinksqUentryqU language_codeqUenqU datestampqNU report_levelqKU _destinationqNU halt_levelqKU strip_classesqNh3NUerror_encoding_error_handlerqUbackslashreplaceqUdebugqNUembed_stylesheetqUoutput_encoding_error_handlerqUstrictqU sectnum_xformqKUdump_transformsqNU docinfo_xformqKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlr NUexpose_internalsr NUsectsubtitle_xformr U source_linkr NUrfc_referencesr NUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerU>/home/prologic/work/circuits/docs/source/api/circuits_core.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightr Ulongr!Uinput_encoding_error_handlerr"hUauto_id_prefixr#Uidr$Udoctitle_xformr%Ustrip_elements_with_classesr&NU _config_filesr']r(Ufile_insertion_enabledr)KU raw_enabledr*KU dump_settingsr+NubUsymbol_footnote_startr,KUidsr-}r.(h)cdocutils.nodes target r/)r0}r1(hUhhhhkhUtargetr2h}r3(h!]r4h']r5h)ah%]r6Uismodr7h#]r8h*]r9uh,Kh-hh]r:ubhhuUsubstitution_namesr;}r<hh-h}r=(h!]r>h']r?h%]r@UsourcerAhh#]rBh*]rCuU footnotesrD]rEUrefidsrF}rGub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_main.doctree0000644000014400001440000001031412113366666024546 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qX!circuits.web.main -- circuits.webqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhUcircuits-web-main-circuits-webqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qXB/home/prologic/work/circuits/docs/source/api/circuits_web_main.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q((Xmodule-circuits.web.mainq)heUnamesq*]q+hauUlineq,KUdocumentq-hh]q.(cdocutils.nodes title q/)q0}q1(hX(:mod:`circuits.web.main` -- circuits.webq2hhhhhUtitleq3h}q4(h!]q5h#]q6h%]q7h']q8h*]q9uh,Kh-hh]q:(csphinx.addnodes pending_xref q;)q<}q=(hX:mod:`circuits.web.main`q>hh0hhhU pending_xrefq?h}q@(UreftypeqAXmodqBUrefwarnqCU reftargetqDXcircuits.web.mainqEU refdomainqFXpyqGh']qHh%]qIU refexplicitqJh!]qKh#]qLh*]qMUrefdocqNUapi/circuits_web_mainqOUpy:classqPNU py:moduleqQNuh,Kh]qRcdocutils.nodes literal qS)qT}qU(hh>h}qV(h!]qWh#]qX(UxrefqYhGXpy-modqZeh%]q[h']q\h*]q]uhhqkhUindexqlh}qm(h']qnh%]qoh!]qph#]qqh*]qrUentriesqs]qt(UsinglequXcircuits.web.main (module)Xmodule-circuits.web.mainUtqvauh,Kh-hh]qwubcdocutils.nodes paragraph qx)qy}qz(hXMainq{hhhXP/home/prologic/work/circuits/circuits/web/main.py:docstring of circuits.web.mainq|hU paragraphq}h}q~(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_XMainqq}q(hh{hhyubaubhx)q}q(hX)circutis.web Web Server and Testing Tool.qhhhh|hh}h}q(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_X)circutis.web Web Server and Testing Tool.qq}q(hhhhubaubhx)q}q(hXmShipped application with static and directory index support suitable for quickly serving up simple web pages.qhhhhhh}h}q(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_XmShipped application with static and directory index support suitable for quickly serving up simple web pages.qq}q(hhhhubaubeubahUU transformerqNU footnote_refsq}qUrefnamesq}qUsymbol_footnotesq]qUautofootnote_refsq]qUsymbol_footnote_refsq]qU citationsq]qh-hU current_lineqNUtransform_messagesq]qUreporterqNUid_startqKU autofootnotesq]qU citation_refsq}qUindirect_targetsq]qUsettingsq(cdocutils.frontend Values qoq}q(Ufootnote_backlinksqKUrecord_dependenciesqNU rfc_base_urlqUhttp://tools.ietf.org/html/qU tracebackqˆUpep_referencesqNUstrip_commentsqNU toc_backlinksqUentryqU language_codeqUenqU datestampqNU report_levelqKU _destinationqNU halt_levelqKU strip_classesqNh3NUerror_encoding_error_handlerqUbackslashreplaceqUdebugqNUembed_stylesheetqщUoutput_encoding_error_handlerqUstrictqU sectnum_xformqKUdump_transformsqNU docinfo_xformqKUwarning_streamqNUpep_file_url_templateqUpep-%04dqUexit_status_levelqKUconfigqNUstrict_visitorqNUcloak_email_addressesq݈Utrim_footnote_reference_spaceqމUenvqNUdump_pseudo_xmlqNUexpose_internalsqNUsectsubtitle_xformqU source_linkqNUrfc_referencesqNUoutput_encodingqUutf-8qU source_urlqNUinput_encodingqU utf-8-sigqU_disable_configqNU id_prefixqUU tab_widthqKUerror_encodingqU ISO-8859-1qU_sourceqUB/home/prologic/work/circuits/docs/source/api/circuits_web_main.rstqUgettext_compactqU generatorqNUdump_internalsqNU smart_quotesqU pep_base_urlqUhttp://www.python.org/dev/peps/qUsyntax_highlightqUlongqUinput_encoding_error_handlerqhUauto_id_prefixqUidqUdoctitle_xformqUstrip_elements_with_classesqNU _config_filesq]qUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hhh)cdocutils.nodes target r)r}r(hUhhhhkhUtargetr h}r (h!]r h']r h)ah%]r Uismodrh#]rh*]ruh,Kh-hh]rubuUsubstitution_namesr}rhh-h}r(h!]rh']rh%]rUsourcerhh#]rh*]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_constants.doctree0000644000014400001440000000776112113366663025647 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qX*circuits.web.constants -- global constantsqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhU'circuits-web-constants-global-constantsqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qXG/home/prologic/work/circuits/docs/source/api/circuits_web_constants.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q((Xmodule-circuits.web.constantsq)heUnamesq*]q+hauUlineq,KUdocumentq-hh]q.(cdocutils.nodes title q/)q0}q1(hX1:mod:`circuits.web.constants` -- Global Constantsq2hhhhhUtitleq3h}q4(h!]q5h#]q6h%]q7h']q8h*]q9uh,Kh-hh]q:(csphinx.addnodes pending_xref q;)q<}q=(hX:mod:`circuits.web.constants`q>hh0hhhU pending_xrefq?h}q@(UreftypeqAXmodqBUrefwarnqCU reftargetqDXcircuits.web.constantsqEU refdomainqFXpyqGh']qHh%]qIU refexplicitqJh!]qKh#]qLh*]qMUrefdocqNUapi/circuits_web_constantsqOUpy:classqPNU py:moduleqQNuh,Kh]qRcdocutils.nodes literal qS)qT}qU(hh>h}qV(h!]qWh#]qX(UxrefqYhGXpy-modqZeh%]q[h']q\h*]q]uhhqkhUindexqlh}qm(h']qnh%]qoh!]qph#]qqh*]qrUentriesqs]qt(UsinglequXcircuits.web.constants (module)Xmodule-circuits.web.constantsUtqvauh,Kh-hh]qwubcdocutils.nodes paragraph qx)qy}qz(hXGlobal Constantsq{hhhXZ/home/prologic/work/circuits/circuits/web/constants.py:docstring of circuits.web.constantsq|hU paragraphq}h}q~(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_XGlobal Constantsqq}q(hh{hhyubaubhx)q}q(hX8This module implements required shared global constants.qhhhh|hh}h}q(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_X8This module implements required shared global constants.qq}q(hhhhubaubeubahUU transformerqNU footnote_refsq}qUrefnamesq}qUsymbol_footnotesq]qUautofootnote_refsq]qUsymbol_footnote_refsq]qU citationsq]qh-hU current_lineqNUtransform_messagesq]qUreporterqNUid_startqKU autofootnotesq]qU citation_refsq}qUindirect_targetsq]qUsettingsq(cdocutils.frontend Values qoq}q(Ufootnote_backlinksqKUrecord_dependenciesqNU rfc_base_urlqUhttp://tools.ietf.org/html/qU tracebackqUpep_referencesqNUstrip_commentsqNU toc_backlinksqUentryqU language_codeqUenqU datestampqNU report_levelqKU _destinationqNU halt_levelqKU strip_classesqNh3NUerror_encoding_error_handlerqUbackslashreplaceqUdebugqNUembed_stylesheetqĉUoutput_encoding_error_handlerqUstrictqU sectnum_xformqKUdump_transformsqNU docinfo_xformqKUwarning_streamqNUpep_file_url_templateqUpep-%04dqUexit_status_levelqKUconfigqNUstrict_visitorqNUcloak_email_addressesqЈUtrim_footnote_reference_spaceqщUenvqNUdump_pseudo_xmlqNUexpose_internalsqNUsectsubtitle_xformqՉU source_linkqNUrfc_referencesqNUoutput_encodingqUutf-8qU source_urlqNUinput_encodingqU utf-8-sigqU_disable_configqNU id_prefixqUU tab_widthqKUerror_encodingqU ISO-8859-1qU_sourceqUG/home/prologic/work/circuits/docs/source/api/circuits_web_constants.rstqUgettext_compactqU generatorqNUdump_internalsqNU smart_quotesqU pep_base_urlqUhttp://www.python.org/dev/peps/qUsyntax_highlightqUlongqUinput_encoding_error_handlerqhUauto_id_prefixqUidqUdoctitle_xformqUstrip_elements_with_classesqNU _config_filesq]qUfile_insertion_enabledqKU raw_enabledqKU dump_settingsqNubUsymbol_footnote_startqKUidsq}q(hhh)cdocutils.nodes target q)q}q(hUhhhhkhUtargetqh}q(h!]qh']qh)ah%]rUismodrh#]rh*]ruh,Kh-hh]rubuUsubstitution_namesr}rhh-h}r(h!]rh']r h%]r Usourcer hh#]r h*]r uU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_dispatchers_dispatcher.doctree0000644000014400001440000001746112113366663030350 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X9circuits.web.dispatchers.dispatcher -- default dispatcherqNX.circuits.web.dispatchers.dispatcher.DispatcherqX functionsqNXeventsq NX componentsq NuUsubstitution_defsq }q Uparse_messagesq ]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU6circuits-web-dispatchers-dispatcher-default-dispatcherqhhhU functionsqh Ueventsqh U componentsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode q XT/home/prologic/work/circuits/docs/source/api/circuits_web_dispatchers_dispatcher.rstq!q"}q#bUtagnameq$Usectionq%U attributesq&}q'(Udupnamesq(]q)Uclassesq*]q+Ubackrefsq,]q-Uidsq.]q/(X*module-circuits.web.dispatchers.dispatcherq0heUnamesq1]q2hauUlineq3KUdocumentq4hh]q5(cdocutils.nodes title q6)q7}q8(hX@:mod:`circuits.web.dispatchers.dispatcher` -- Default Dispatcherq9hhhh"h$Utitleq:h&}q;(h(]qh.]q?h1]q@uh3Kh4hh]qA(csphinx.addnodes pending_xref qB)qC}qD(hX*:mod:`circuits.web.dispatchers.dispatcher`qEhh7hh"h$U pending_xrefqFh&}qG(UreftypeqHXmodqIUrefwarnqJU reftargetqKX#circuits.web.dispatchers.dispatcherqLU refdomainqMXpyqNh.]qOh,]qPU refexplicitqQh(]qRh*]qSh1]qTUrefdocqUU'api/circuits_web_dispatchers_dispatcherqVUpy:classqWNU py:moduleqXNuh3Kh]qYcdocutils.nodes literal qZ)q[}q\(hhEh&}q](h(]q^h*]q_(Uxrefq`hNXpy-modqaeh,]qbh.]qch1]qduhhCh]qecdocutils.nodes Text qfX#circuits.web.dispatchers.dispatcherqgqh}qi(hUhh[ubah$UliteralqjubaubhfX -- Default Dispatcherqkql}qm(hX -- Default Dispatcherqnhh7ubeubcsphinx.addnodes index qo)qp}qq(hUhhhh"h$Uindexqrh&}qs(h.]qth,]quh(]qvh*]qwh1]qxUentriesqy]qz(Usingleq{X,circuits.web.dispatchers.dispatcher (module)X*module-circuits.web.dispatchers.dispatcherUtq|auh3Kh4hh]q}ubh)q~}q(hUhhhh"h$h%h&}q(h(]qh*]qh,]qh.]qhah1]qh auh3Kh4hh]q(h6)q}q(hXEventsqhh~hh"h$h:h&}q(h(]qh*]qh,]qh.]qh1]quh3Kh4hh]qhfXEventsqq}q(hhhhubaubcdocutils.nodes paragraph q)q}q(hX**none**qhh~hh"h$U paragraphqh&}q(h(]qh*]qh,]qh.]qh1]quh3K h4hh]qcdocutils.nodes strong q)q}q(hhh&}q(h(]qh*]qh,]qh.]qh1]quhhh]qhfXnoneqq}q(hUhhubah$Ustrongqubaubeubh)q}q(hUhhhh"h$h%h&}q(h(]qh*]qh,]qh.]qhah1]qh auh3K h4hh]q(h6)q}q(hX Componentsqhhhh"h$h:h&}q(h(]qh*]qh,]qh.]qh1]quh3K h4hh]qhfX Componentsqq}q(hhhhubaubho)q}q(hUhhhU qh$hrh&}q(h.]qh,]qh(]qh*]qh1]qUentriesq]q(h{X9Dispatcher (class in circuits.web.dispatchers.dispatcher)hUtqauh3Nh4hh]qubcsphinx.addnodes desc q)q}q(hUhhhhh$Udescqh&}q(Unoindexq։UdomainqXpyqh.]qh,]qh(]qh*]qh1]qUobjtypeqXclassqUdesctypeqhuh3Nh4hh]q(csphinx.addnodes desc_signature q)q}q(hXDispatcher(**kwargs)qhhhU qh$Udesc_signatureqh&}q(h.]qhaUmoduleqh X#circuits.web.dispatchers.dispatcherq녁q}qbh,]qh(]qh*]qh1]qhaUfullnameqX DispatcherqUclassqUUfirstquh3Nh4hh]q(csphinx.addnodes desc_annotation q)q}q(hXclass qhhhhh$Udesc_annotationqh&}q(h(]qh*]qh,]qh.]rh1]ruh3Nh4hh]rhfXclass rr}r(hUhhubaubcsphinx.addnodes desc_addname r)r}r(hX$circuits.web.dispatchers.dispatcher.r hhhhh$U desc_addnamer h&}r (h(]r h*]r h,]rh.]rh1]ruh3Nh4hh]rhfX$circuits.web.dispatchers.dispatcher.rr}r(hUhjubaubcsphinx.addnodes desc_name r)r}r(hhhhhhh$U desc_namerh&}r(h(]rh*]rh,]rh.]rh1]ruh3Nh4hh]rhfX Dispatcherr r!}r"(hUhjubaubcsphinx.addnodes desc_parameterlist r#)r$}r%(hUhhhhh$Udesc_parameterlistr&h&}r'(h(]r(h*]r)h,]r*h.]r+h1]r,uh3Nh4hh]r-csphinx.addnodes desc_parameter r.)r/}r0(hX**kwargsr1h&}r2(h(]r3h*]r4h,]r5h.]r6h1]r7uhj$h]r8hfX**kwargsr9r:}r;(hUhj/ubah$Udesc_parameterr<ubaubeubcsphinx.addnodes desc_content r=)r>}r?(hUhhhhh$U desc_contentr@h&}rA(h(]rBh*]rCh,]rDh.]rEh1]rFuh3Nh4hh]rGh)rH}rI(hX6Bases: :class:`circuits.core.components.BaseComponent`rJhj>hhh$hh&}rK(h(]rLh*]rMh,]rNh.]rOh1]rPuh3Kh4hh]rQ(hfXBases: rRrS}rT(hXBases: rUhjHubhB)rV}rW(hX/:class:`circuits.core.components.BaseComponent`rXhjHhh"h$hFh&}rY(UreftyperZXclassr[hJhKX&circuits.core.components.BaseComponentr\U refdomainr]Xpyr^h.]r_h,]r`U refexplicitrah(]rbh*]rch1]rdhUhVhWhhXX#circuits.web.dispatchers.dispatcherreuh3Kh]rfhZ)rg}rh(hjXh&}ri(h(]rjh*]rk(h`j^Xpy-classrleh,]rmh.]rnh1]rouhjVh]rphfX&circuits.core.components.BaseComponentrqrr}rs(hUhjgubah$hjubaubeubaubeubeubh)rt}ru(hUhhhh"h$h%h&}rv(h(]rwh*]rxh,]ryh.]rzhah1]r{hauh3Kh4hh]r|(h6)r}}r~(hX Functionsrhjthh"h$h:h&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]rhfX Functionsrr}r(hjhj}ubaubh)r}r(hX**none**rhjthh"h$hh&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]rh)r}r(hjh&}r(h(]rh*]rh,]rh.]rh1]ruhjh]rhfXnonerr}r(hUhjubah$hubaubeubeubahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh4hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh:NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUT/home/prologic/work/circuits/docs/source/api/circuits_web_dispatchers_dispatcher.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hjth0cdocutils.nodes target r)r}r(hUhhhh"h$Utargetrh&}r(h(]r h.]r h0ah,]r Uismodr h*]r h1]ruh3Kh4hh]rubhhhhhhhh~uUsubstitution_namesr}rh$h4h&}r(h(]rh.]rh,]rUsourcerh"h*]rh1]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_app_log.doctree0000644000014400001440000005166112113366654024415 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNXcircuits.app.log.LoggerqXeventsqNX componentsq NXcircuits.app.log.Logq X'circuits.app.log -- application loggingq NuUsubstitution_defsq }q Uparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhhhUeventsqh U componentsqh h h U$circuits-app-log-application-loggingquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceq cdocutils.nodes reprunicode q!XA/home/prologic/work/circuits/docs/source/api/circuits_app_log.rstq"q#}q$bUtagnameq%Usectionq&U attributesq'}q((Udupnamesq)]q*Uclassesq+]q,Ubackrefsq-]q.Uidsq/]q0(Xmodule-circuits.app.logq1heUnamesq2]q3h auUlineq4KUdocumentq5hh]q6(cdocutils.nodes title q7)q8}q9(hX.:mod:`circuits.app.log` -- Application Loggingq:hhh h#h%Utitleq;h'}q<(h)]q=h+]q>h-]q?h/]q@h2]qAuh4Kh5hh]qB(csphinx.addnodes pending_xref qC)qD}qE(hX:mod:`circuits.app.log`qFhh8h h#h%U pending_xrefqGh'}qH(UreftypeqIXmodqJUrefwarnqKU reftargetqLXcircuits.app.logqMU refdomainqNXpyqOh/]qPh-]qQU refexplicitqRh)]qSh+]qTh2]qUUrefdocqVUapi/circuits_app_logqWUpy:classqXNU py:moduleqYNuh4Kh]qZcdocutils.nodes literal q[)q\}q](hhFh'}q^(h)]q_h+]q`(UxrefqahOXpy-modqbeh-]qch/]qdh2]qeuhhDh]qfcdocutils.nodes Text qgXcircuits.app.logqhqi}qj(hUhh\ubah%UliteralqkubaubhgX -- Application Loggingqlqm}qn(hX -- Application Loggingqohh8ubeubcsphinx.addnodes index qp)qq}qr(hUhhh h#h%Uindexqsh'}qt(h/]quh-]qvh)]qwh+]qxh2]qyUentriesqz]q{(Usingleq|Xcircuits.app.log (module)Xmodule-circuits.app.logUtq}auh4Kh5hh]q~ubh)q}q(hUhhh h#h%h&h'}q(h)]qh+]qh-]qh/]qhah2]qhauh4Kh5hh]q(h7)q}q(hXEventsqhhh h#h%h;h'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgXEventsqq}q(hhhhubaubhp)q}q(hUhhh Nh%hsh'}q(h/]qh-]qh)]qh+]qh2]qUentriesq]q(h|XLog (class in circuits.app.log)h Utqauh4Nh5hh]qubcsphinx.addnodes desc q)q}q(hUhhh Nh%Udescqh'}q(UnoindexqUdomainqXpyqh/]qh-]qh)]qh+]qh2]qUobjtypeqXclassqUdesctypeqhuh4Nh5hh]q(csphinx.addnodes desc_signature q)q}q(hXLog(*args, **kwargs)qhhh U qh%Udesc_signatureqh'}q(h/]qh aUmoduleqh!Xcircuits.app.logqq}qbh-]qh)]qh+]qh2]qh aUfullnameqXLogqUclassqUUfirstqʼnuh4Nh5hh]q(csphinx.addnodes desc_annotation q)q}q(hXclass qhhh hh%Udesc_annotationqh'}q(h)]qh+]qh-]qh/]qh2]quh4Nh5hh]qhgXclass qӅq}q(hUhhubaubcsphinx.addnodes desc_addname q)q}q(hXcircuits.app.log.qhhh hh%U desc_addnameqh'}q(h)]qh+]qh-]qh/]qh2]quh4Nh5hh]qhgXcircuits.app.log.q⅁q}q(hUhhubaubcsphinx.addnodes desc_name q)q}q(hhhhh hh%U desc_nameqh'}q(h)]qh+]qh-]qh/]qh2]quh4Nh5hh]qhgXLogqq}q(hUhhubaubcsphinx.addnodes desc_parameterlist q)q}q(hUhhh hh%Udesc_parameterlistqh'}q(h)]qh+]qh-]qh/]qh2]quh4Nh5hh]q(csphinx.addnodes desc_parameter q)q}r(hX*argsrh'}r(h)]rh+]rh-]rh/]rh2]ruhhh]rhgX*argsr r }r (hUhhubah%Udesc_parameterr ubh)r }r(hX**kwargsrh'}r(h)]rh+]rh-]rh/]rh2]ruhhh]rhgX**kwargsrr}r(hUhj ubah%j ubeubeubcsphinx.addnodes desc_content r)r}r(hUhhh hh%U desc_contentrh'}r(h)]rh+]r h-]r!h/]r"h2]r#uh4Nh5hh]r$(cdocutils.nodes paragraph r%)r&}r'(hX*Bases: :class:`circuits.core.events.Event`r(hjh U r)h%U paragraphr*h'}r+(h)]r,h+]r-h-]r.h/]r/h2]r0uh4Kh5hh]r1(hgXBases: r2r3}r4(hXBases: r5hj&ubhC)r6}r7(hX#:class:`circuits.core.events.Event`r8hj&h h#h%hGh'}r9(Ureftyper:Xclassr;hKhLXcircuits.core.events.Eventr<U refdomainr=Xpyr>h/]r?h-]r@U refexplicitrAh)]rBh+]rCh2]rDhVhWhXhhYXcircuits.app.logrEuh4Kh]rFh[)rG}rH(hj8h'}rI(h)]rJh+]rK(haj>Xpy-classrLeh-]rMh/]rNh2]rOuhj6h]rPhgXcircuits.core.events.EventrQrR}rS(hUhjGubah%hkubaubeubj%)rT}rU(hX Log EventrVhjh XR/home/prologic/work/circuits/circuits/app/log.py:docstring of circuits.app.log.LogrWh%j*h'}rX(h)]rYh+]rZh-]r[h/]r\h2]r]uh4Kh5hh]r^hgX Log Eventr_r`}ra(hjVhjTubaubj%)rb}rc(hXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rdhjh jWh%j*h'}re(h)]rfh+]rgh-]rhh/]rih2]rjuh4Kh5hh]rkhgXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rlrm}rn(hjdhjbubaubj%)ro}rp(hXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rqhjh jWh%j*h'}rr(h)]rsh+]rth-]ruh/]rvh2]rwuh4Kh5hh]rxhgXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.ryrz}r{(hjqhjoubaubj%)r|}r}(hXEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.r~hjh jWh%j*h'}r(h)]rh+]rh-]rh/]rh2]ruh4K h5hh]r(hgXEvery event has a rr}r(hXEvery event has a rhj|ubhC)r}r(hX :attr:`name`rhj|h h#h%hGh'}r(UreftyperXattrrhKhLXnamerU refdomainrXpyrh/]rh-]rU refexplicitrh)]rh+]rh2]rhVhWhXhhYjEuh4Kh]rh[)r}r(hjh'}r(h)]rh+]r(hajXpy-attrreh-]rh/]rh2]ruhjh]rhgXnamerr}r(hUhjubah%hkubaubhgX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(hX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rhj|ubeubcdocutils.nodes field_list r)r}r(hUhjh Nh%U field_listrh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rcdocutils.nodes field r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(cdocutils.nodes field_name r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgX Variablesrr}r(hUhjubah%U field_namerubcdocutils.nodes field_body r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rcdocutils.nodes bullet_list r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(cdocutils.nodes list_item r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rj%)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(hC)r}r(hUh'}r(UreftyperUobjrU reftargetrXchannelsrU refdomainrhh/]rh-]rU refexplicitrh)]rh+]rh2]ruhjh]rcdocutils.nodes strong r)r}r(hjh'}r(h)]rh+]r h-]r h/]r h2]r uhjh]r hgXchannelsrr}r(hUhjubah%Ustrongrubah%hGubhgX -- rr}r(hUhjubj%)r}r(hXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rhjh jWh%j*h'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh]rhgXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rr }r!(hjhjubaubj%)r"}r#(hXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r$hjh jWh%j*h'}r%(h)]r&h+]r'h-]r(h/]r)h2]r*uh4Kh]r+hgXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r,r-}r.(hj$hj"ubaubeh%j*ubah%U list_itemr/ubj)r0}r1(hUh'}r2(h)]r3h+]r4h-]r5h/]r6h2]r7uhjh]r8j%)r9}r:(hUh'}r;(h)]r<h+]r=h-]r>h/]r?h2]r@uhj0h]rA(hC)rB}rC(hUh'}rD(UreftyperEjU reftargetrFXvaluerGU refdomainrHhh/]rIh-]rJU refexplicitrKh)]rLh+]rMh2]rNuhj9h]rOj)rP}rQ(hjGh'}rR(h)]rSh+]rTh-]rUh/]rVh2]rWuhjBh]rXhgXvaluerYrZ}r[(hUhjPubah%jubah%hGubhgX -- r\r]}r^(hUhj9ubhgX this is a r_r`}ra(hX this is a rbhj9ubhC)rc}rd(hX#:class:`circuits.core.values.Value`rehj9h Nh%hGh'}rf(UreftypergXclassrhhKhLXcircuits.core.values.ValueriU refdomainrjXpyrkh/]rlh-]rmU refexplicitrnh)]roh+]rph2]rqhVhWhXhhYjEuh4Nh]rrh[)rs}rt(hjeh'}ru(h)]rvh+]rw(hajkXpy-classrxeh-]ryh/]rzh2]r{uhjch]r|hgXcircuits.core.values.Valuer}r~}r(hUhjsubah%hkubaubhgXN object that holds the results returned by the handlers invoked for the event.rr}r(hXN object that holds the results returned by the handlers invoked for the event.rhj9ubeh%j*ubah%j/ubj)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rj%)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(hC)r}r(hUh'}r(UreftyperjU reftargetrXsuccessrU refdomainrhh/]rh-]rU refexplicitrh)]rh+]rh2]ruhjh]rj)r}r(hjh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXsuccessrr}r(hUhjubah%jubah%hGubhgX -- rr}r(hUhjubhgX%if this optional attribute is set to rr}r(hX%if this optional attribute is set to rhjubh[)r}r(hX``True``rh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXTruerr}r(hUhjubah%hkubhgX, an associated event rr}r(hX, an associated event rhjubh[)r}r(hX``EventSuccess``rh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgX EventSuccessrr}r(hUhjubah%hkubhgX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(hX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rhjubeh%j*ubah%j/ubj)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rj%)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(hC)r}r(hUh'}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrhh/]rh-]rU refexplicitrh)]rh+]rh2]ruhjh]rj)r}r(hjh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXsuccess_channelsrr}r(hUhjubah%jubah%hGubhgX -- rr}r(hUhjubhgXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr }r (hXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r hjubeh%j*ubah%j/ubj)r }r (hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rj%)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhj h]r(hC)r}r(hUh'}r (Ureftyper!jU reftargetr"Xcompleter#U refdomainr$hh/]r%h-]r&U refexplicitr'h)]r(h+]r)h2]r*uhjh]r+j)r,}r-(hj#h'}r.(h)]r/h+]r0h-]r1h/]r2h2]r3uhjh]r4hgXcompleter5r6}r7(hUhj,ubah%jubah%hGubhgX -- r8r9}r:(hUhjubhgX%if this optional attribute is set to r;r<}r=(hX%if this optional attribute is set to r>hjubh[)r?}r@(hX``True``rAh'}rB(h)]rCh+]rDh-]rEh/]rFh2]rGuhjh]rHhgXTruerIrJ}rK(hUhj?ubah%hkubhgX, an associated event rLrM}rN(hX, an associated event rOhjubh[)rP}rQ(hX``EventComplete``rRh'}rS(h)]rTh+]rUh-]rVh/]rWh2]rXuhjh]rYhgX EventCompleterZr[}r\(hUhjPubah%hkubhgX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r]r^}r_(hX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r`hjubeh%j*ubah%j/ubj)ra}rb(hUh'}rc(h)]rdh+]reh-]rfh/]rgh2]rhuhjh]rij%)rj}rk(hUh'}rl(h)]rmh+]rnh-]roh/]rph2]rquhjah]rr(hC)rs}rt(hUh'}ru(UreftypervjU reftargetrwXsuccess_channelsrxU refdomainryhh/]rzh-]r{U refexplicitr|h)]r}h+]r~h2]ruhjjh]rj)r}r(hjxh'}r(h)]rh+]rh-]rh/]rh2]ruhjsh]rhgXsuccess_channelsrr}r(hUhjubah%jubah%hGubhgX -- rr}r(hUhjjubhgXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(hXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rhjjubeh%j*ubah%j/ubeh%U bullet_listrubah%U field_bodyrubeh%Ufieldrubaubeubeubeubh)r}r(hUhhh h#h%h&h'}r(h)]rh+]rh-]rh/]rhah2]rh auh4K h5hh]r(h7)r}r(hX Componentsrhjh h#h%h;h'}r(h)]rh+]rh-]rh/]rh2]ruh4K h5hh]rhgX Componentsrr}r(hjhjubaubhp)r}r(hUhjh j)h%hsh'}r(h/]rh-]rh)]rh+]rh2]rUentriesr]r(h|X"Logger (class in circuits.app.log)hUtrauh4Nh5hh]rubh)r}r(hUhjh j)h%hh'}r(hhXpyrh/]rh-]rh)]rh+]rh2]rhXclassrhjuh4Nh5hh]r(h)r}r(hX5Logger(filename, name, type, level, channel='logger')rhjh hh%hh'}r(h/]rhahh!Xcircuits.app.logrr}rbh-]rh)]rh+]rh2]rhahXLoggerrhUhʼnuh4Nh5hh]r(h)r}r(hXclass rhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXclass rr}r(hUhjubaubh)r}r(hXcircuits.app.log.rhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXcircuits.app.log.rr}r(hUhjubaubh)r}r(hjhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXLoggerrr}r(hUhjubaubh)r}r(hUhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]r(h)r}r(hXfilenamerh'}r(h)]rh+]rh-]rh/]rh2]r uhjh]r hgXfilenamer r }r (hUhjubah%j ubh)r}r(hXnamerh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXnamerr}r(hUhjubah%j ubh)r}r(hXtyperh'}r(h)]rh+]r h-]r!h/]r"h2]r#uhjh]r$hgXtyper%r&}r'(hUhjubah%j ubh)r(}r)(hXlevelr*h'}r+(h)]r,h+]r-h-]r.h/]r/h2]r0uhjh]r1hgXlevelr2r3}r4(hUhj(ubah%j ubh)r5}r6(hXchannel='logger'r7h'}r8(h)]r9h+]r:h-]r;h/]r<h2]r=uhjh]r>hgXchannel='logger'r?r@}rA(hUhj5ubah%j ubeubeubj)rB}rC(hUhjh hh%jh'}rD(h)]rEh+]rFh-]rGh/]rHh2]rIuh4Nh5hh]rJj%)rK}rL(hX6Bases: :class:`circuits.core.components.BaseComponent`rMhjBh j)h%j*h'}rN(h)]rOh+]rPh-]rQh/]rRh2]rSuh4Kh5hh]rT(hgXBases: rUrV}rW(hXBases: rXhjKubhC)rY}rZ(hX/:class:`circuits.core.components.BaseComponent`r[hjKh h#h%hGh'}r\(Ureftyper]Xclassr^hKhLX&circuits.core.components.BaseComponentr_U refdomainr`Xpyrah/]rbh-]rcU refexplicitrdh)]reh+]rfh2]rghVhWhXjhYjEuh4Kh]rhh[)ri}rj(hj[h'}rk(h)]rlh+]rm(hajaXpy-classrneh-]roh/]rph2]rquhjYh]rrhgX&circuits.core.components.BaseComponentrsrt}ru(hUhjiubah%hkubaubeubaubeubeubh)rv}rw(hUhhh h#h%h&h'}rx(h)]ryh+]rzh-]r{h/]r|hah2]r}hauh4Kh5hh]r~h7)r}r(hX Functionsrhjvh h#h%h;h'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgX Functionsrr}r(hjhjubaubaubeubahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh5hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh;NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUA/home/prologic/work/circuits/docs/source/api/circuits_app_log.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hjvhhhjh1cdocutils.nodes target r)r}r(hUhhh h#h%Utargetrh'}r(h)]rh/]rh1ah-]rUismodrh+]rh2]ruh4Kh5hh]rubhjh hhhuUsubstitution_namesr}rh%h5h'}r(h)]rh/]rh-]rUsourcerh#h+]rh2]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_wrappers.doctree0000644000014400001440000006527612113366667025507 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X$circuits.web.wrappers.Request.serverqXcircuits.web.wrappers.ResponseqXcircuits.web.wrappers.HostqX1circuits.web.wrappers -- request/response objectsq NX componentsq NX$circuits.web.wrappers.file_generatorq X functionsq NXclassesq NXcircuits.web.wrappers.BodyqXeventsqNXcircuits.web.wrappers.RequestquUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hhhhhhh U.circuits-web-wrappers-request-response-objectsqh U componentsqh h h U functionsqh UclassesqhhhUeventsqhhuUchildrenq]q cdocutils.nodes section q!)q"}q#(U rawsourceq$UUparentq%hUsourceq&cdocutils.nodes reprunicode q'XF/home/prologic/work/circuits/docs/source/api/circuits_web_wrappers.rstq(q)}q*bUtagnameq+Usectionq,U attributesq-}q.(Udupnamesq/]q0Uclassesq1]q2Ubackrefsq3]q4Uidsq5]q6(Xmodule-circuits.web.wrappersq7heUnamesq8]q9h auUlineq:KUdocumentq;hh]q<(cdocutils.nodes title q=)q>}q?(h$X8:mod:`circuits.web.wrappers` -- Request/Response Objectsq@h%h"h&h)h+UtitleqAh-}qB(h/]qCh1]qDh3]qEh5]qFh8]qGuh:Kh;hh]qH(csphinx.addnodes pending_xref qI)qJ}qK(h$X:mod:`circuits.web.wrappers`qLh%h>h&h)h+U pending_xrefqMh-}qN(UreftypeqOXmodqPUrefwarnqQU reftargetqRXcircuits.web.wrappersqSU refdomainqTXpyqUh5]qVh3]qWU refexplicitqXh/]qYh1]qZh8]q[Urefdocq\Uapi/circuits_web_wrappersq]Upy:classq^NU py:moduleq_Nuh:Kh]q`cdocutils.nodes literal qa)qb}qc(h$hLh-}qd(h/]qeh1]qf(UxrefqghUXpy-modqheh3]qih5]qjh8]qkuh%hJh]qlcdocutils.nodes Text qmXcircuits.web.wrappersqnqo}qp(h$Uh%hbubah+UliteralqqubaubhmX -- Request/Response Objectsqrqs}qt(h$X -- Request/Response Objectsquh%h>ubeubcsphinx.addnodes index qv)qw}qx(h$Uh%h"h&h)h+Uindexqyh-}qz(h5]q{h3]q|h/]q}h1]q~h8]qUentriesq]q(UsingleqXcircuits.web.wrappers (module)Xmodule-circuits.web.wrappersUtqauh:Kh;hh]qubh!)q}q(h$Uh%h"h&h)h+h,h-}q(h/]qh1]qh3]qh5]qhah8]qhauh:Kh;hh]q(h=)q}q(h$XEventsqh%hh&h)h+hAh-}q(h/]qh1]qh3]qh5]qh8]quh:Kh;hh]qhmXEventsqq}q(h$hh%hubaubcdocutils.nodes paragraph q)q}q(h$X**none**qh%hh&h)h+U paragraphqh-}q(h/]qh1]qh3]qh5]qh8]quh:K h;hh]qcdocutils.nodes strong q)q}q(h$hh-}q(h/]qh1]qh3]qh5]qh8]quh%hh]qhmXnoneqq}q(h$Uh%hubah+Ustrongqubaubeubh!)q}q(h$Uh%h"h&h)h+h,h-}q(h/]qh1]qh3]qh5]qhah8]qh auh:Kh;hh]q(h=)q}q(h$XClassesqh%hh&h)h+hAh-}q(h/]qh1]qh3]qh5]qh8]quh:Kh;hh]qhmXClassesqȅq}q(h$hh%hubaubhv)q}q(h$Uh%hh&X]/home/prologic/work/circuits/circuits/web/wrappers.py:docstring of circuits.web.wrappers.Bodyqh+hyh-}q(h5]qh3]qh/]qh1]qh8]qUentriesq]q(hX%Body (class in circuits.web.wrappers)hUtqauh:Nh;hh]qubcsphinx.addnodes desc q)q}q(h$Uh%hh&hh+Udescqh-}q(Unoindexq݉UdomainqXpyqh5]qh3]qh/]qh1]qh8]qUobjtypeqXclassqUdesctypeqhuh:Nh;hh]q(csphinx.addnodes desc_signature q)q}q(h$XBodyqh%hh&U qh+Udesc_signatureqh-}q(h5]qhaUmoduleqh'Xcircuits.web.wrappersqq}qbh3]qh/]qh1]qh8]qhaUfullnameqhUclassqUUfirstquh:Nh;hh]q(csphinx.addnodes desc_annotation q)q}q(h$Xclass rh%hh&hh+Udesc_annotationrh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXclass r r }r (h$Uh%hubaubcsphinx.addnodes desc_addname r )r }r(h$Xcircuits.web.wrappers.rh%hh&hh+U desc_addnamerh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXcircuits.web.wrappers.rr}r(h$Uh%j ubaubcsphinx.addnodes desc_name r)r}r(h$hh%hh&hh+U desc_namerh-}r(h/]r h1]r!h3]r"h5]r#h8]r$uh:Nh;hh]r%hmXBodyr&r'}r((h$Uh%jubaubeubcsphinx.addnodes desc_content r))r*}r+(h$Uh%hh&hh+U desc_contentr,h-}r-(h/]r.h1]r/h3]r0h5]r1h8]r2uh:Nh;hh]r3(h)r4}r5(h$XBases: :class:`object`r6h%j*h&U r7h+hh-}r8(h/]r9h1]r:h3]r;h5]r<h8]r=uh:Kh;hh]r>(hmXBases: r?r@}rA(h$XBases: rBh%j4ubhI)rC}rD(h$X:class:`object`rEh%j4h&h)h+hMh-}rF(UreftyperGXclassrHhQhRXobjectrIU refdomainrJXpyrKh5]rLh3]rMU refexplicitrNh/]rOh1]rPh8]rQh\h]h^hh_Xcircuits.web.wrappersrRuh:Kh]rSha)rT}rU(h$jEh-}rV(h/]rWh1]rX(hgjKXpy-classrYeh3]rZh5]r[h8]r\uh%jCh]r]hmXobjectr^r_}r`(h$Uh%jTubah+hqubaubeubh)ra}rb(h$X Response Bodyrch%j*h&hh+hh-}rd(h/]reh1]rfh3]rgh5]rhh8]riuh:Kh;hh]rjhmX Response Bodyrkrl}rm(h$jch%jaubaubeubeubhv)rn}ro(h$Uh%hh&X]/home/prologic/work/circuits/circuits/web/wrappers.py:docstring of circuits.web.wrappers.Hostrph+hyh-}rq(h5]rrh3]rsh/]rth1]ruh8]rvUentriesrw]rx(hX%Host (class in circuits.web.wrappers)hUtryauh:Nh;hh]rzubh)r{}r|(h$Uh%hh&jph+hh-}r}(h݉hXpyr~h5]rh3]rh/]rh1]rh8]rhXclassrhjuh:Nh;hh]r(h)r}r(h$XHost(ip, port, name=None)rh%j{h&hh+hh-}r(h5]rhahh'Xcircuits.web.wrappersrr}rbh3]rh/]rh1]rh8]rhahXHostrhUhuh:Nh;hh]r(h)r}r(h$Xclass rh%jh&hh+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXclass rr}r(h$Uh%jubaubj )r}r(h$Xcircuits.web.wrappers.rh%jh&hh+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXcircuits.web.wrappers.rr}r(h$Uh%jubaubj)r}r(h$jh%jh&hh+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXHostrr}r(h$Uh%jubaubcsphinx.addnodes desc_parameterlist r)r}r(h$Uh%jh&hh+Udesc_parameterlistrh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]r(csphinx.addnodes desc_parameter r)r}r(h$Xiprh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXiprr}r(h$Uh%jubah+Udesc_parameterrubj)r}r(h$Xportrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXportrr}r(h$Uh%jubah+jubj)r}r(h$X name=Nonerh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX name=Nonerr}r(h$Uh%jubah+jubeubeubj))r}r(h$Uh%j{h&hh+j,h-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]r(h)r}r(h$XBases: :class:`object`rh%jh&j7h+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Kh;hh]r(hmXBases: rr}r(h$XBases: rh%jubhI)r}r(h$X:class:`object`rh%jh&h)h+hMh-}r(Ureftyper Xclassr hQhRXobjectr U refdomainr Xpyr h5]rh3]rU refexplicitrh/]rh1]rh8]rh\h]h^jh_jRuh:Kh]rha)r}r(h$jh-}r(h/]rh1]r(hgj Xpy-classreh3]rh5]rh8]ruh%jh]rhmXobjectrr }r!(h$Uh%jubah+hqubaubeubh)r"}r#(h$XAn internet address.r$h%jh&jph+hh-}r%(h/]r&h1]r'h3]r(h5]r)h8]r*uh:Kh;hh]r+hmXAn internet address.r,r-}r.(h$j$h%j"ubaubh)r/}r0(h$Xname should be the client's host name. If not available (because no DNS lookup is performed), the IP address should be used instead.r1h%jh&jph+hh-}r2(h/]r3h1]r4h3]r5h5]r6h8]r7uh:Kh;hh]r8hmXname should be the client's host name. If not available (because no DNS lookup is performed), the IP address should be used instead.r9r:}r;(h$j1h%j/ubaubeubeubhv)r<}r=(h$Uh%hh&Nh+hyh-}r>(h5]r?h3]r@h/]rAh1]rBh8]rCUentriesrD]rE(hX(Request (class in circuits.web.wrappers)hUtrFauh:Nh;hh]rGubh)rH}rI(h$Uh%hh&Nh+hh-}rJ(h݉hXpyrKh5]rLh3]rMh/]rNh1]rOh8]rPhXclassrQhjQuh:Nh;hh]rR(h)rS}rT(h$X1Request(sock, method, scheme, path, protocol, qs)rUh%jHh&hh+hh-}rV(h5]rWhahh'Xcircuits.web.wrappersrXrY}rZbh3]r[h/]r\h1]r]h8]r^hahXRequestr_hUhuh:Nh;hh]r`(h)ra}rb(h$Xclass rch%jSh&hh+jh-}rd(h/]reh1]rfh3]rgh5]rhh8]riuh:Nh;hh]rjhmXclass rkrl}rm(h$Uh%jaubaubj )rn}ro(h$Xcircuits.web.wrappers.rph%jSh&hh+jh-}rq(h/]rrh1]rsh3]rth5]ruh8]rvuh:Nh;hh]rwhmXcircuits.web.wrappers.rxry}rz(h$Uh%jnubaubj)r{}r|(h$j_h%jSh&hh+jh-}r}(h/]r~h1]rh3]rh5]rh8]ruh:Nh;hh]rhmXRequestrr}r(h$Uh%j{ubaubj)r}r(h$Uh%jSh&hh+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]r(j)r}r(h$Xsockrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXsockrr}r(h$Uh%jubah+jubj)r}r(h$Xmethodrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXmethodrr}r(h$Uh%jubah+jubj)r}r(h$Xschemerh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXschemerr}r(h$Uh%jubah+jubj)r}r(h$Xpathrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXpathrr}r(h$Uh%jubah+jubj)r}r(h$Xprotocolrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXprotocolrr}r(h$Uh%jubah+jubj)r}r(h$Xqsrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXqsrr}r(h$Uh%jubah+jubeubeubj))r}r(h$Uh%jHh&hh+j,h-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]r(h)r}r(h$XBases: :class:`object`rh%jh&j7h+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Kh;hh]r(hmXBases: rr}r(h$XBases: rh%jubhI)r}r(h$X:class:`object`rh%jh&h)h+hMh-}r(UreftyperXclassrhQhRXobjectrU refdomainrXpyrh5]rh3]rU refexplicitrh/]rh1]rh8]rh\h]h^j_h_jRuh:Kh]rha)r}r(h$jh-}r(h/]rh1]r (hgjXpy-classr eh3]r h5]r h8]r uh%jh]rhmXobjectrr}r(h$Uh%jubah+hqubaubeubh)r}r(h$XACreates a new Request object to hold information about a request.rh%jh&X`/home/prologic/work/circuits/circuits/web/wrappers.py:docstring of circuits.web.wrappers.Requestrh+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Kh;hh]rhmXACreates a new Request object to hold information about a request.rr}r(h$jh%jubaubcdocutils.nodes field_list r )r!}r"(h$Uh%jh&Nh+U field_listr#h-}r$(h/]r%h1]r&h3]r'h5]r(h8]r)uh:Nh;hh]r*cdocutils.nodes field r+)r,}r-(h$Uh-}r.(h/]r/h1]r0h3]r1h5]r2h8]r3uh%j!h]r4(cdocutils.nodes field_name r5)r6}r7(h$Uh-}r8(h/]r9h1]r:h3]r;h5]r<h8]r=uh%j,h]r>hmX Parametersr?r@}rA(h$Uh%j6ubah+U field_namerBubcdocutils.nodes field_body rC)rD}rE(h$Uh-}rF(h/]rGh1]rHh3]rIh5]rJh8]rKuh%j,h]rLcdocutils.nodes bullet_list rM)rN}rO(h$Uh-}rP(h/]rQh1]rRh3]rSh5]rTh8]rUuh%jDh]rV(cdocutils.nodes list_item rW)rX}rY(h$Uh-}rZ(h/]r[h1]r\h3]r]h5]r^h8]r_uh%jNh]r`h)ra}rb(h$Uh-}rc(h/]rdh1]reh3]rfh5]rgh8]rhuh%jXh]ri(h)rj}rk(h$Xsockrlh-}rm(h/]rnh1]roh3]rph5]rqh8]rruh%jah]rshmXsockrtru}rv(h$Uh%jjubah+hubhmX (rwrx}ry(h$Uh%jaubhI)rz}r{(h$Uh-}r|(Ureftyper}Uobjr~U reftargetrX socket.socketrU refdomainrjKh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jah]rcdocutils.nodes emphasis r)r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jzh]rhmX socket.socketrr}r(h$Uh%jubah+Uemphasisrubah+hMubhmX)r}r(h$Uh%jaubhmX -- rr}r(h$Uh%jaubhmX!The socket object of the request.rr}r(h$X!The socket object of the request.rh%jaubeh+hubah+U list_itemrubjW)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jNh]rh)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(h)r}r(h$Xmethodrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXmethodrr}r(h$Uh%jubah+hubhmX (rr}r(h$Uh%jubhI)r}r(h$Uh-}r(Ureftyperj~U reftargetrXstrrU refdomainrjKh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj)r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXstrrr}r(h$Uh%jubah+jubah+hMubhmX)r}r(h$Uh%jubhmX -- rr}r(h$Uh%jubhmXThe requsted method.rr}r(h$XThe requsted method.rh%jubeh+hubah+jubjW)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jNh]rh)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(h)r}r(h$Xschemerh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXschemerr}r(h$Uh%jubah+hubhmX (rr}r(h$Uh%jubhI)r}r (h$Uh-}r (Ureftyper j~U reftargetr Xstrr U refdomainrjKh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj)r}r(h$j h-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXstrrr }r!(h$Uh%jubah+jubah+hMubhmX)r"}r#(h$Uh%jubhmX -- r$r%}r&(h$Uh%jubhmXThe requsted scheme.r'r(}r)(h$XThe requsted scheme.r*h%jubeh+hubah+jubjW)r+}r,(h$Uh-}r-(h/]r.h1]r/h3]r0h5]r1h8]r2uh%jNh]r3h)r4}r5(h$Uh-}r6(h/]r7h1]r8h3]r9h5]r:h8]r;uh%j+h]r<(h)r=}r>(h$Xpathr?h-}r@(h/]rAh1]rBh3]rCh5]rDh8]rEuh%j4h]rFhmXpathrGrH}rI(h$Uh%j=ubah+hubhmX (rJrK}rL(h$Uh%j4ubhI)rM}rN(h$Uh-}rO(UreftyperPj~U reftargetrQXstrrRU refdomainrSjKh5]rTh3]rUU refexplicitrVh/]rWh1]rXh8]rYuh%j4h]rZj)r[}r\(h$jRh-}r](h/]r^h1]r_h3]r`h5]rah8]rbuh%jMh]rchmXstrrdre}rf(h$Uh%j[ubah+jubah+hMubhmX)rg}rh(h$Uh%j4ubhmX -- rirj}rk(h$Uh%j4ubhmXThe requsted path.rlrm}rn(h$XThe requsted path.roh%j4ubeh+hubah+jubjW)rp}rq(h$Uh-}rr(h/]rsh1]rth3]ruh5]rvh8]rwuh%jNh]rxh)ry}rz(h$Uh-}r{(h/]r|h1]r}h3]r~h5]rh8]ruh%jph]r(h)r}r(h$Xprotocolrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jyh]rhmXprotocolrr}r(h$Uh%jubah+hubhmX (rr}r(h$Uh%jyubhI)r}r(h$Uh-}r(Ureftyperj~U reftargetrXstrrU refdomainrjKh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jyh]rj)r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXstrrr}r(h$Uh%jubah+jubah+hMubhmX)r}r(h$Uh%jyubhmX -- rr}r(h$Uh%jyubhmXThe requsted protocol.rr}r(h$XThe requsted protocol.rh%jyubeh+hubah+jubjW)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jNh]rh)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]r(h)r}r(h$Xqsrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXqsrr}r(h$Uh%jubah+hubhmX (rr}r(h$Uh%jubhI)r}r(h$Uh-}r(Ureftyperj~U reftargetrXstrrU refdomainrjKh5]rh3]rU refexplicitrh/]rh1]rh8]ruh%jh]rj)r}r(h$jh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXstrrr}r(h$Uh%jubah+jubah+hMubhmX)r}r(h$Uh%jubhmX -- rr}r(h$Uh%jubhmX The query string of the request.rr}r(h$X The query string of the request.rh%jubeh+hubah+jubeh+U bullet_listrubah+U field_bodyrubeh+Ufieldrubaubh)r}r(h$X4initializes x; see x.__class__.__doc__ for signaturerh%jh&jh+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Kh;hh]rhmX4initializes x; see x.__class__.__doc__ for signaturerr}r (h$jh%jubaubhv)r }r (h$Uh%jh&Xg/home/prologic/work/circuits/circuits/web/wrappers.py:docstring of circuits.web.wrappers.Request.serverr h+hyh-}r (h5]rh3]rh/]rh1]rh8]rUentriesr]r(hX0server (circuits.web.wrappers.Request attribute)hUtrauh:Nh;hh]rubh)r}r(h$Uh%jh&j h+hh-}r(h݉hXpyrh5]rh3]rh/]rh1]rh8]rhX attributer hj uh:Nh;hh]r!(h)r"}r#(h$XRequest.serverr$h%jh&U r%h+hh-}r&(h5]r'hahh'Xcircuits.web.wrappersr(r)}r*bh3]r+h/]r,h1]r-h8]r.hahXRequest.serverr/hj_huh:Nh;hh]r0(j)r1}r2(h$Xserverr3h%j"h&j%h+jh-}r4(h/]r5h1]r6h3]r7h5]r8h8]r9uh:Nh;hh]r:hmXserverr;r<}r=(h$Uh%j1ubaubh)r>}r?(h$X = Noner@h%j"h&j%h+jh-}rA(h/]rBh1]rCh3]rDh5]rEh8]rFuh:Nh;hh]rGhmX = NonerHrI}rJ(h$Uh%j>ubaubeubj))rK}rL(h$Uh%jh&j%h+j,h-}rM(h/]rNh1]rOh3]rPh5]rQh8]rRuh:Nh;hh]rSh)rT}rU(h$X+@cvar: A reference to the underlying serverrVh%jKh&j h+hh-}rW(h/]rXh1]rYh3]rZh5]r[h8]r\uh:Kh;hh]r]hmX+@cvar: A reference to the underlying serverr^r_}r`(h$jVh%jTubaubaubeubeubeubhv)ra}rb(h$Uh%hh&Xa/home/prologic/work/circuits/circuits/web/wrappers.py:docstring of circuits.web.wrappers.Responserch+hyh-}rd(h5]reh3]rfh/]rgh1]rhh8]riUentriesrj]rk(hX)Response (class in circuits.web.wrappers)hUtrlauh:Nh;hh]rmubh)rn}ro(h$Uh%hh&jch+hh-}rp(h݉hXpyrqh5]rrh3]rsh/]rth1]ruh8]rvhXclassrwhjwuh:Nh;hh]rx(h)ry}rz(h$X<Response(request, encoding='utf-8', code=None, message=None)r{h%jnh&hh+hh-}r|(h5]r}hahh'Xcircuits.web.wrappersr~r}rbh3]rh/]rh1]rh8]rhahXResponserhUhuh:Nh;hh]r(h)r}r(h$Xclass rh%jyh&hh+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXclass rr}r(h$Uh%jubaubj )r}r(h$Xcircuits.web.wrappers.rh%jyh&hh+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXcircuits.web.wrappers.rr}r(h$Uh%jubaubj)r}r(h$jh%jyh&hh+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXResponserr}r(h$Uh%jubaubj)r}r(h$Uh%jyh&hh+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]r(j)r}r(h$Xrequestrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXrequestrr}r(h$Uh%jubah+jubj)r}r(h$Xencoding='utf-8'rh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXencoding='utf-8'rr}r(h$Uh%jubah+jubj)r}r(h$X code=Nonerh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX code=Nonerr}r(h$Uh%jubah+jubj)r}r(h$X message=Nonerh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX message=Nonerr}r(h$Uh%jubah+jubeubeubj))r}r(h$Uh%jnh&hh+j,h-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]r(h)r}r(h$XBases: :class:`object`rh%jh&j7h+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Kh;hh]r(hmXBases: rr}r(h$XBases: rh%jubhI)r}r(h$X:class:`object`rh%jh&h)h+hMh-}r(UreftyperXclassrhQhRXobjectrU refdomainrXpyr h5]r h3]r U refexplicitr h/]r h1]rh8]rh\h]h^jh_jRuh:Kh]rha)r}r(h$jh-}r(h/]rh1]r(hgj Xpy-classreh3]rh5]rh8]ruh%jh]rhmXobjectrr}r(h$Uh%jubah+hqubaubeubh)r}r(h$X.Response(sock, request) -> new Response objectr h%jh&jch+hh-}r!(h/]r"h1]r#h3]r$h5]r%h8]r&uh:Kh;hh]r'hmX.Response(sock, request) -> new Response objectr(r)}r*(h$j h%jubaubh)r+}r,(h$XA Response object that holds the response to send back to the client. This ensure that the correct data is sent in the correct order.r-h%jh&jch+hh-}r.(h/]r/h1]r0h3]r1h5]r2h8]r3uh:Kh;hh]r4hmXA Response object that holds the response to send back to the client. This ensure that the correct data is sent in the correct order.r5r6}r7(h$j-h%j+ubaubh)r8}r9(h$X4initializes x; see x.__class__.__doc__ for signaturer:h%jh&jch+hh-}r;(h/]r<h1]r=h3]r>h5]r?h8]r@uh:Kh;hh]rAhmX4initializes x; see x.__class__.__doc__ for signaturerBrC}rD(h$j:h%j8ubaubeubeubeubh!)rE}rF(h$Uh%h"h&h)h+h,h-}rG(h/]rHh1]rIh3]rJh5]rKhah8]rLh auh:Kh;hh]rM(h=)rN}rO(h$X ComponentsrPh%jEh&h)h+hAh-}rQ(h/]rRh1]rSh3]rTh5]rUh8]rVuh:Kh;hh]rWhmX ComponentsrXrY}rZ(h$jPh%jNubaubh)r[}r\(h$X**none**r]h%jEh&h)h+hh-}r^(h/]r_h1]r`h3]rah5]rbh8]rcuh:K h;hh]rdh)re}rf(h$j]h-}rg(h/]rhh1]rih3]rjh5]rkh8]rluh%j[h]rmhmXnonernro}rp(h$Uh%jeubah+hubaubeubh!)rq}rr(h$Uh%h"h&h)h+h,h-}rs(h/]rth1]ruh3]rvh5]rwhah8]rxh auh:K$h;hh]ry(h=)rz}r{(h$X Functionsr|h%jqh&h)h+hAh-}r}(h/]r~h1]rh3]rh5]rh8]ruh:K$h;hh]rhmX Functionsrr}r(h$j|h%jzubaubhv)r}r(h$Uh%jqh&Nh+hyh-}r(h5]rh3]rh/]rh1]rh8]rUentriesr]r(hX2file_generator() (in module circuits.web.wrappers)h Utrauh:Nh;hh]rubh)r}r(h$Uh%jqh&Nh+hh-}r(h݉hXpyrh5]rh3]rh/]rh1]rh8]rhXfunctionrhjuh:Nh;hh]r(h)r}r(h$X%file_generator(input, chunkSize=4096)rh%jh&hh+hh-}r(h5]rh ahh'Xcircuits.web.wrappersrr}rbh3]rh/]rh1]rh8]rh ahXfile_generatorrhUhuh:Nh;hh]r(j )r}r(h$Xcircuits.web.wrappers.rh%jh&hh+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXcircuits.web.wrappers.rr}r(h$Uh%jubaubj)r}r(h$jh%jh&hh+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXfile_generatorrr}r(h$Uh%jubaubj)r}r(h$Uh%jh&hh+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]r(j)r}r(h$Xinputrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXinputrr}r(h$Uh%jubah+jubj)r}r(h$XchunkSize=4096rh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXchunkSize=4096rr}r(h$Uh%jubah+jubeubeubj))r}r(h$Uh%jh&hh+j,h-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rubeubeubeubah$UU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh;hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr (cdocutils.frontend Values r or }r (Ufootnote_backlinksr KUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNhANUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetr Uoutput_encoding_error_handlerr!Ustrictr"U sectnum_xformr#KUdump_transformsr$NU docinfo_xformr%KUwarning_streamr&NUpep_file_url_templater'Upep-%04dr(Uexit_status_levelr)KUconfigr*NUstrict_visitorr+NUcloak_email_addressesr,Utrim_footnote_reference_spacer-Uenvr.NUdump_pseudo_xmlr/NUexpose_internalsr0NUsectsubtitle_xformr1U source_linkr2NUrfc_referencesr3NUoutput_encodingr4Uutf-8r5U source_urlr6NUinput_encodingr7U utf-8-sigr8U_disable_configr9NU id_prefixr:UU tab_widthr;KUerror_encodingr<U ISO-8859-1r=U_sourcer>UF/home/prologic/work/circuits/docs/source/api/circuits_web_wrappers.rstr?Ugettext_compactr@U generatorrANUdump_internalsrBNU smart_quotesrCU pep_base_urlrDUhttp://www.python.org/dev/peps/rEUsyntax_highlightrFUlongrGUinput_encoding_error_handlerrHj"Uauto_id_prefixrIUidrJUdoctitle_xformrKUstrip_elements_with_classesrLNU _config_filesrM]rNUfile_insertion_enabledrOKU raw_enabledrPKU dump_settingsrQNubUsymbol_footnote_startrRKUidsrS}rT(hj"hjyhjhjEh jhjqh7cdocutils.nodes target rU)rV}rW(h$Uh%h"h&h)h+UtargetrXh-}rY(h/]rZh5]r[h7ah3]r\Uismodr]h1]r^h8]r_uh:Kh;hh]r`ubhhhhhhhjShh"uUsubstitution_namesra}rbh+h;h-}rc(h/]rdh5]reh3]rfUsourcergh)h1]rhh8]riuU footnotesrj]rkUrefidsrl}rmub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_dispatchers_virtualhosts.doctree0000644000014400001440000003215312113366663030764 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X2circuits.web.dispatchers.virtualhosts.VirtualHostsqX6circuits.web.dispatchers.virtualhosts -- virtual hostsqNXeventsqNX componentsq NX functionsq NuUsubstitution_defsq }q Uparse_messagesq ]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hhhU3circuits-web-dispatchers-virtualhosts-virtual-hostsqhUeventsqh U componentsqh U functionsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode q XV/home/prologic/work/circuits/docs/source/api/circuits_web_dispatchers_virtualhosts.rstq!q"}q#bUtagnameq$Usectionq%U attributesq&}q'(Udupnamesq(]q)Uclassesq*]q+Ubackrefsq,]q-Uidsq.]q/(X,module-circuits.web.dispatchers.virtualhostsq0heUnamesq1]q2hauUlineq3KUdocumentq4hh]q5(cdocutils.nodes title q6)q7}q8(hX=:mod:`circuits.web.dispatchers.virtualhosts` -- Virtual Hostsq9hhhh"h$Utitleq:h&}q;(h(]qh.]q?h1]q@uh3Kh4hh]qA(csphinx.addnodes pending_xref qB)qC}qD(hX,:mod:`circuits.web.dispatchers.virtualhosts`qEhh7hh"h$U pending_xrefqFh&}qG(UreftypeqHXmodqIUrefwarnqJU reftargetqKX%circuits.web.dispatchers.virtualhostsqLU refdomainqMXpyqNh.]qOh,]qPU refexplicitqQh(]qRh*]qSh1]qTUrefdocqUU)api/circuits_web_dispatchers_virtualhostsqVUpy:classqWNU py:moduleqXNuh3Kh]qYcdocutils.nodes literal qZ)q[}q\(hhEh&}q](h(]q^h*]q_(Uxrefq`hNXpy-modqaeh,]qbh.]qch1]qduhhCh]qecdocutils.nodes Text qfX%circuits.web.dispatchers.virtualhostsqgqh}qi(hUhh[ubah$UliteralqjubaubhfX -- Virtual Hostsqkql}qm(hX -- Virtual Hostsqnhh7ubeubcsphinx.addnodes index qo)qp}qq(hUhhhU qrh$Uindexqsh&}qt(h.]quh,]qvh(]qwh*]qxh1]qyUentriesqz]q{(Usingleq|X.circuits.web.dispatchers.virtualhosts (module)X,module-circuits.web.dispatchers.virtualhostsUtq}auh3Kh4hh]q~ubcdocutils.nodes paragraph q)q}q(hX VirtualHostqhhhXx/home/prologic/work/circuits/circuits/web/dispatchers/virtualhosts.py:docstring of circuits.web.dispatchers.virtualhostsqh$U paragraphqh&}q(h(]qh*]qh,]qh.]qh1]quh3Kh4hh]qhfX VirtualHostqq}q(hhhhubaubh)q}q(hX{This module implements a virtual host dispatcher that sends requests for configured virtual hosts to different dispatchers.qhhhhh$hh&}q(h(]qh*]qh,]qh.]qh1]quh3Kh4hh]qhfX{This module implements a virtual host dispatcher that sends requests for configured virtual hosts to different dispatchers.qq}q(hhhhubaubh)q}q(hUhhhh"h$h%h&}q(h(]qh*]qh,]qh.]qhah1]qhauh3Kh4hh]q(h6)q}q(hXEventsqhhhh"h$h:h&}q(h(]qh*]qh,]qh.]qh1]quh3Kh4hh]qhfXEventsqq}q(hhhhubaubh)q}q(hX**none**qhhhh"h$hh&}q(h(]qh*]qh,]qh.]qh1]quh3K h4hh]qcdocutils.nodes strong q)q}q(hhh&}q(h(]qh*]qh,]qh.]qh1]quhhh]qhfXnoneqƅq}q(hUhhubah$Ustrongqubaubeubh)q}q(hUhhhh"h$h%h&}q(h(]qh*]qh,]qh.]qhah1]qh auh3Kh4hh]q(h6)q}q(hX Componentsqhhhh"h$h:h&}q(h(]qh*]qh,]qh.]qh1]quh3Kh4hh]qhfX Componentsq݅q}q(hhhhubaubho)q}q(hUhhhX/home/prologic/work/circuits/circuits/web/dispatchers/virtualhosts.py:docstring of circuits.web.dispatchers.virtualhosts.VirtualHostsqh$hsh&}q(h.]qh,]qh(]qh*]qh1]qUentriesq]q(h|X=VirtualHosts (class in circuits.web.dispatchers.virtualhosts)hUtqauh3Nh4hh]qubcsphinx.addnodes desc q)q}q(hUhhhhh$Udescqh&}q(UnoindexqUdomainqXpyqh.]qh,]qh(]qh*]qh1]qUobjtypeqXclassqUdesctypeqhuh3Nh4hh]q(csphinx.addnodes desc_signature q)q}r(hXVirtualHosts(domains)rhhhU rh$Udesc_signaturerh&}r(h.]rhaUmodulerh X%circuits.web.dispatchers.virtualhostsrr}r bh,]r h(]r h*]r h1]r haUfullnamerX VirtualHostsrUclassrUUfirstruh3Nh4hh]r(csphinx.addnodes desc_annotation r)r}r(hXclass rhhhjh$Udesc_annotationrh&}r(h(]rh*]rh,]rh.]rh1]ruh3Nh4hh]rhfXclass rr }r!(hUhjubaubcsphinx.addnodes desc_addname r")r#}r$(hX&circuits.web.dispatchers.virtualhosts.r%hhhjh$U desc_addnamer&h&}r'(h(]r(h*]r)h,]r*h.]r+h1]r,uh3Nh4hh]r-hfX&circuits.web.dispatchers.virtualhosts.r.r/}r0(hUhj#ubaubcsphinx.addnodes desc_name r1)r2}r3(hjhhhjh$U desc_namer4h&}r5(h(]r6h*]r7h,]r8h.]r9h1]r:uh3Nh4hh]r;hfX VirtualHostsr<r=}r>(hUhj2ubaubcsphinx.addnodes desc_parameterlist r?)r@}rA(hUhhhjh$Udesc_parameterlistrBh&}rC(h(]rDh*]rEh,]rFh.]rGh1]rHuh3Nh4hh]rIcsphinx.addnodes desc_parameter rJ)rK}rL(hXdomainsrMh&}rN(h(]rOh*]rPh,]rQh.]rRh1]rSuhj@h]rThfXdomainsrUrV}rW(hUhjKubah$Udesc_parameterrXubaubeubcsphinx.addnodes desc_content rY)rZ}r[(hUhhhjh$U desc_contentr\h&}r](h(]r^h*]r_h,]r`h.]rah1]rbuh3Nh4hh]rc(h)rd}re(hX6Bases: :class:`circuits.core.components.BaseComponent`rfhjZhU rgh$hh&}rh(h(]rih*]rjh,]rkh.]rlh1]rmuh3Kh4hh]rn(hfXBases: rorp}rq(hXBases: rrhjdubhB)rs}rt(hX/:class:`circuits.core.components.BaseComponent`ruhjdhh"h$hFh&}rv(UreftyperwXclassrxhJhKX&circuits.core.components.BaseComponentryU refdomainrzXpyr{h.]r|h,]r}U refexplicitr~h(]rh*]rh1]rhUhVhWjhXX%circuits.web.dispatchers.virtualhostsruh3Kh]rhZ)r}r(hjuh&}r(h(]rh*]r(h`j{Xpy-classreh,]rh.]rh1]ruhjsh]rhfX&circuits.core.components.BaseComponentrr}r(hUhjubah$hjubaubeubh)r}r(hX7Forward to anotehr Dispatcher based on the Host header.rhjZhhh$hh&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]rhfX7Forward to anotehr Dispatcher based on the Host header.rr}r(hjhjubaubh)r}r(hX"This can be useful when running multiple sites within one server. It allows several domains to point to different parts of a single website structure. For example: - http://www.domain.example -> / - http://www.domain2.example -> /domain2 - http://www.domain2.example:443 -> /securerhjZhhh$hh&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]r(hfXThis can be useful when running multiple sites within one server. It allows several domains to point to different parts of a single website structure. For example: - rr}r(hXThis can be useful when running multiple sites within one server. It allows several domains to point to different parts of a single website structure. For example: - rhjubcdocutils.nodes reference r)r}r(hXhttp://www.domain.examplerh&}r(UrefurirXhttp://www.domain.examplerh.]rh,]rh(]rh*]rh1]ruhjh]rhfXhttp://www.domain.examplerr}r(hUhjubah$U referencerubhfX -> / - rr}r(hX -> / - rhjubj)r}r(hXhttp://www.domain2.examplerh&}r(UrefurirXhttp://www.domain2.examplerh.]rh,]rh(]rh*]rh1]ruhjh]rhfXhttp://www.domain2.examplerr}r(hUhjubah$jubhfX -> /domain2 - rr}r(hX -> /domain2 - rhjubj)r}r(hXhttp://www.domain2.example:443rh&}r(UrefurirXhttp://www.domain2.example:443rh.]rh,]rh(]rh*]rh1]ruhjh]rhfXhttp://www.domain2.example:443rr}r(hUhjubah$jubhfX -> /securerr}r(hX -> /securerhjubeubcdocutils.nodes field_list r)r}r(hUhjZhhh$U field_listrh&}r(h(]rh*]rh,]rh.]rh1]ruh3Nh4hh]rcdocutils.nodes field r)r}r(hUh&}r(h(]rh*]rh,]rh.]rh1]ruhjh]r(cdocutils.nodes field_name r)r}r(hUh&}r(h(]rh*]rh,]rh.]rh1]ruhjh]rhfX Parametersrr}r(hUhjubah$U field_namer ubcdocutils.nodes field_body r )r }r (hUh&}r (h(]rh*]rh,]rh.]rh1]ruhjh]rh)r}r(hUh&}r(h(]rh*]rh,]rh.]rh1]ruhj h]r(h)r}r(hXdomainsrh&}r (h(]r!h*]r"h,]r#h.]r$h1]r%uhjh]r&hfXdomainsr'r(}r)(hUhjubah$hubhfX (r*r+}r,(hUhjubhB)r-}r.(hUh&}r/(Ureftyper0Uobjr1U reftargetr2Xdictr3U refdomainr4hh.]r5h,]r6U refexplicitr7h(]r8h*]r9h1]r:uhjh]r;cdocutils.nodes emphasis r<)r=}r>(hj3h&}r?(h(]r@h*]rAh,]rBh.]rCh1]rDuhj-h]rEhfXdictrFrG}rH(hUhj=ubah$UemphasisrIubah$hFubhfX)rJ}rK(hUhjubhfX -- rLrM}rN(hUhjubhfX4a dict of {host header value: virtual prefix} pairs.rOrP}rQ(hX4a dict of {host header value: virtual prefix} pairs.rRhjubeh$hubah$U field_bodyrSubeh$UfieldrTubaubh)rU}rV(hXThe incoming "Host" request header is looked up in this dict, and, if a match is found, the corresponding "virtual prefix" value will be prepended to the URL path before passing the request onto the next dispatcher.rWhjZhhh$hh&}rX(h(]rYh*]rZh,]r[h.]r\h1]r]uh3K h4hh]r^hfXThe incoming "Host" request header is looked up in this dict, and, if a match is found, the corresponding "virtual prefix" value will be prepended to the URL path before passing the request onto the next dispatcher.r_r`}ra(hjWhjUubaubh)rb}rc(hXNote that you often need separate entries for "example.com" and "www.example.com". In addition, "Host" headers may contain the port number.rdhjZhhh$hh&}re(h(]rfh*]rgh,]rhh.]rih1]rjuh3Kh4hh]rkhfXNote that you often need separate entries for "example.com" and "www.example.com". In addition, "Host" headers may contain the port number.rlrm}rn(hjdhjbubaubeubeubeubh)ro}rp(hUhhhh"h$h%h&}rq(h(]rrh*]rsh,]rth.]ruhah1]rvh auh3Kh4hh]rw(h6)rx}ry(hX Functionsrzhjohh"h$h:h&}r{(h(]r|h*]r}h,]r~h.]rh1]ruh3Kh4hh]rhfX Functionsrr}r(hjzhjxubaubh)r}r(hX**none**rhjohh"h$hh&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]rh)r}r(hjh&}r(h(]rh*]rh,]rh.]rh1]ruhjh]rhfXnonerr}r(hUhjubah$hubaubeubeubahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh4hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh:NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUV/home/prologic/work/circuits/docs/source/api/circuits_web_dispatchers_virtualhosts.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hjohhhhhhh0cdocutils.nodes target r)r}r(hUhhhhrh$Utargetrh&}r(h(]rh.]rh0ah,]rUismodrh*]rh1]r uh3Kh4hh]r ubhhuUsubstitution_namesr }r h$h4h&}r (h(]rh.]rh,]rUsourcerh"h*]rh1]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_core_workers.doctree0000644000014400001440000004577412113366657025513 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNX circuits.core.workers -- workersqNXcircuits.core.workers.WorkerqXclassesq NX componentsq NXcircuits.core.workers.Taskq Xeventsq NuUsubstitution_defsq }qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhUcircuits-core-workers-workersqhhh Uclassesqh U componentsqh h h UeventsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceq UUparentq!hUsourceq"cdocutils.nodes reprunicode q#XF/home/prologic/work/circuits/docs/source/api/circuits_core_workers.rstq$q%}q&bUtagnameq'Usectionq(U attributesq)}q*(Udupnamesq+]q,Uclassesq-]q.Ubackrefsq/]q0Uidsq1]q2(Xmodule-circuits.core.workersq3heUnamesq4]q5hauUlineq6KUdocumentq7hh]q8(cdocutils.nodes title q9)q:}q;(h X':mod:`circuits.core.workers` -- Workersq(h+]q?h-]q@h/]qAh1]qBh4]qCuh6Kh7hh]qD(csphinx.addnodes pending_xref qE)qF}qG(h X:mod:`circuits.core.workers`qHh!h:h"h%h'U pending_xrefqIh)}qJ(UreftypeqKXmodqLUrefwarnqMU reftargetqNXcircuits.core.workersqOU refdomainqPXpyqQh1]qRh/]qSU refexplicitqTh+]qUh-]qVh4]qWUrefdocqXUapi/circuits_core_workersqYUpy:classqZNU py:moduleq[Nuh6Kh]q\cdocutils.nodes literal q])q^}q_(h hHh)}q`(h+]qah-]qb(UxrefqchQXpy-modqdeh/]qeh1]qfh4]qguh!hFh]qhcdocutils.nodes Text qiXcircuits.core.workersqjqk}ql(h Uh!h^ubah'UliteralqmubaubhiX -- Workersqnqo}qp(h X -- Workersqqh!h:ubeubcsphinx.addnodes index qr)qs}qt(h Uh!hh"U quh'Uindexqvh)}qw(h1]qxh/]qyh+]qzh-]q{h4]q|Uentriesq}]q~(UsingleqXcircuits.core.workers (module)Xmodule-circuits.core.workersUtqauh6Kh7hh]qubcdocutils.nodes paragraph q)q}q(h XWorkersqh!hh"XX/home/prologic/work/circuits/circuits/core/workers.py:docstring of circuits.core.workersqh'U paragraphqh)}q(h+]qh-]qh/]qh1]qh4]quh6Kh7hh]qhiXWorkersqq}q(h hh!hubaubh)q}q(h XWorker components used to perform "work" in independent threads or processes. Worker(s) are typically used by a Pool (circuits.core.pools) to create a pool of workers. Worker(s) are not registered with a Manager or another Component - instead they are managed by the Pool. If a Worker is used independently it should not be registered as it causes its main event handler ``_on_task`` to execute in the other thread blocking it.qh!hh"hh'hh)}q(h+]qh-]qh/]qh1]qh4]quh6Kh7hh]q(hiXsWorker components used to perform "work" in independent threads or processes. Worker(s) are typically used by a Pool (circuits.core.pools) to create a pool of workers. Worker(s) are not registered with a Manager or another Component - instead they are managed by the Pool. If a Worker is used independently it should not be registered as it causes its main event handler qq}q(h XsWorker components used to perform "work" in independent threads or processes. Worker(s) are typically used by a Pool (circuits.core.pools) to create a pool of workers. Worker(s) are not registered with a Manager or another Component - instead they are managed by the Pool. If a Worker is used independently it should not be registered as it causes its main event handler qh!hubh])q}q(h X ``_on_task``qh)}q(h+]qh-]qh/]qh1]qh4]quh!hh]qhiX_on_taskqq}q(h Uh!hubah'hmubhiX, to execute in the other thread blocking it.qq}q(h X, to execute in the other thread blocking it.qh!hubeubh)q}q(h Uh!hh"h%h'h(h)}q(h+]qh-]qh/]qh1]qhah4]qh auh6Kh7hh]q(h9)q}q(h XClassesqh!hh"h%h'h=h)}q(h+]qh-]qh/]qh1]qh4]quh6Kh7hh]qhiXClassesqąq}q(h hh!hubaubh)q}q(h X**none**qh!hh"h%h'hh)}q(h+]qh-]qh/]qh1]qh4]quh6K h7hh]qcdocutils.nodes strong q)q}q(h hh)}q(h+]qh-]qh/]qh1]qh4]quh!hh]qhiXnoneqۅq}q(h Uh!hubah'Ustrongqubaubeubh)q}q(h Uh!hh"h%h'h(h)}q(h+]qh-]qh/]qh1]qhah4]qh auh6K h7hh]q(h9)q}q(h X Componentsqh!hh"h%h'h=h)}q(h+]qh-]qh/]qh1]qh4]quh6K h7hh]qhiX Componentsqq}q(h hh!hubaubhr)q}q(h Uh!hh"X_/home/prologic/work/circuits/circuits/core/workers.py:docstring of circuits.core.workers.Workerqh'hvh)}q(h1]qh/]qh+]qh-]qh4]qUentriesq]q(hX'Worker (class in circuits.core.workers)hUtrauh6Nh7hh]rubcsphinx.addnodes desc r)r}r(h Uh!hh"hh'Udescrh)}r(UnoindexrUdomainrXpyr h1]r h/]r h+]r h-]r h4]rUobjtyperXclassrUdesctyperjuh6Nh7hh]r(csphinx.addnodes desc_signature r)r}r(h XWorker(*args, **kwargs)rh!jh"U rh'Udesc_signaturerh)}r(h1]rhaUmodulerh#Xcircuits.core.workersrr}rbh/]rh+]r h-]r!h4]r"haUfullnamer#XWorkerr$Uclassr%UUfirstr&uh6Nh7hh]r'(csphinx.addnodes desc_annotation r()r)}r*(h Xclass r+h!jh"jh'Udesc_annotationr,h)}r-(h+]r.h-]r/h/]r0h1]r1h4]r2uh6Nh7hh]r3hiXclass r4r5}r6(h Uh!j)ubaubcsphinx.addnodes desc_addname r7)r8}r9(h Xcircuits.core.workers.r:h!jh"jh'U desc_addnamer;h)}r<(h+]r=h-]r>h/]r?h1]r@h4]rAuh6Nh7hh]rBhiXcircuits.core.workers.rCrD}rE(h Uh!j8ubaubcsphinx.addnodes desc_name rF)rG}rH(h j$h!jh"jh'U desc_namerIh)}rJ(h+]rKh-]rLh/]rMh1]rNh4]rOuh6Nh7hh]rPhiXWorkerrQrR}rS(h Uh!jGubaubcsphinx.addnodes desc_parameterlist rT)rU}rV(h Uh!jh"jh'Udesc_parameterlistrWh)}rX(h+]rYh-]rZh/]r[h1]r\h4]r]uh6Nh7hh]r^(csphinx.addnodes desc_parameter r_)r`}ra(h X*argsrbh)}rc(h+]rdh-]reh/]rfh1]rgh4]rhuh!jUh]rihiX*argsrjrk}rl(h Uh!j`ubah'Udesc_parameterrmubj_)rn}ro(h X**kwargsrph)}rq(h+]rrh-]rsh/]rth1]ruh4]rvuh!jUh]rwhiX**kwargsrxry}rz(h Uh!jnubah'jmubeubeubcsphinx.addnodes desc_content r{)r|}r}(h Uh!jh"jh'U desc_contentr~h)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]r(h)r}r(h X6Bases: :class:`circuits.core.components.BaseComponent`rh!j|h"U rh'hh)}r(h+]rh-]rh/]rh1]rh4]ruh6Kh7hh]r(hiXBases: rr}r(h XBases: rh!jubhE)r}r(h X/:class:`circuits.core.components.BaseComponent`rh!jh"h%h'hIh)}r(UreftyperXclassrhMhNX&circuits.core.components.BaseComponentrU refdomainrXpyrh1]rh/]rU refexplicitrh+]rh-]rh4]rhXhYhZj$h[Xcircuits.core.workersruh6Kh]rh])r}r(h jh)}r(h+]rh-]r(hcjXpy-classreh/]rh1]rh4]ruh!jh]rhiX&circuits.core.components.BaseComponentrr}r(h Uh!jubah'hmubaubeubh)r}r(h X!A thread/process Worker Componentrh!j|h"hh'hh)}r(h+]rh-]rh/]rh1]rh4]ruh6Kh7hh]rhiX!A thread/process Worker Componentrr}r(h jh!jubaubh)r}r(h XThis Component creates a Worker (either a thread or process) which when given a ``Task``, will execute the given function in the task in the background in its thread/process.rh!j|h"hh'hh)}r(h+]rh-]rh/]rh1]rh4]ruh6Kh7hh]r(hiXPThis Component creates a Worker (either a thread or process) which when given a rr}r(h XPThis Component creates a Worker (either a thread or process) which when given a rh!jubh])r}r(h X``Task``rh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiXTaskrr}r(h Uh!jubah'hmubhiXV, will execute the given function in the task in the background in its thread/process.rr}r(h XV, will execute the given function in the task in the background in its thread/process.rh!jubeubcdocutils.nodes field_list r)r}r(h Uh!j|h"hh'U field_listrh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rcdocutils.nodes field r)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]r(cdocutils.nodes field_name r)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiX Parametersrr}r(h Uh!jubah'U field_namerubcdocutils.nodes field_body r)r}r(h Uh)}r(h+]rh-]rh/]rh1]r h4]r uh!jh]r h)r }r (h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]r(h)r}r(h Xprocessrh)}r(h+]rh-]rh/]rh1]rh4]ruh!j h]rhiXprocessrr }r!(h Uh!jubah'hubhiX (r"r#}r$(h Uh!j ubhE)r%}r&(h Uh)}r'(Ureftyper(Uobjr)U reftargetr*Xboolr+U refdomainr,j h1]r-h/]r.U refexplicitr/h+]r0h-]r1h4]r2uh!j h]r3cdocutils.nodes emphasis r4)r5}r6(h j+h)}r7(h+]r8h-]r9h/]r:h1]r;h4]r<uh!j%h]r=hiXboolr>r?}r@(h Uh!j5ubah'UemphasisrAubah'hIubhiX)rB}rC(h Uh!j ubhiX -- rDrE}rF(h Uh!j ubhiX9True to start this Worker as a process (Thread otherwise)rGrH}rI(h X9True to start this Worker as a process (Thread otherwise)rJh!j ubeh'hubah'U field_bodyrKubeh'UfieldrLubaubh)rM}rN(h X4initializes x; see x.__class__.__doc__ for signaturerOh!j|h"hh'hh)}rP(h+]rQh-]rRh/]rSh1]rTh4]rUuh6K h7hh]rVhiX4initializes x; see x.__class__.__doc__ for signaturerWrX}rY(h jOh!jMubaubeubeubeubh)rZ}r[(h Uh!hh"h%h'h(h)}r\(h+]r]h-]r^h/]r_h1]r`hah4]rah auh6Kh7hh]rb(h9)rc}rd(h XEventsreh!jZh"h%h'h=h)}rf(h+]rgh-]rhh/]rih1]rjh4]rkuh6Kh7hh]rlhiXEventsrmrn}ro(h jeh!jcubaubhr)rp}rq(h Uh!jZh"Nh'hvh)}rr(h1]rsh/]rth+]ruh-]rvh4]rwUentriesrx]ry(hX%Task (class in circuits.core.workers)h Utrzauh6Nh7hh]r{ubj)r|}r}(h Uh!jZh"Nh'jh)}r~(jjXpyrh1]rh/]rh+]rh-]rh4]rjXclassrjjuh6Nh7hh]r(j)r}r(h XTask(f, *args, **kwargs)rh!j|h"jh'jh)}r(h1]rh ajh#Xcircuits.core.workersrr}rbh/]rh+]rh-]rh4]rh aj#XTaskrj%Uj&uh6Nh7hh]r(j()r}r(h Xclass rh!jh"jh'j,h)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiXclass rr}r(h Uh!jubaubj7)r}r(h Xcircuits.core.workers.rh!jh"jh'j;h)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiXcircuits.core.workers.rr}r(h Uh!jubaubjF)r}r(h jh!jh"jh'jIh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiXTaskrr}r(h Uh!jubaubjT)r}r(h Uh!jh"jh'jWh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]r(j_)r}r(h Xfh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiXfr}r(h Uh!jubah'jmubj_)r}r(h X*argsrh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiX*argsrr}r(h Uh!jubah'jmubj_)r}r(h X**kwargsrh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiX**kwargsrr}r(h Uh!jubah'jmubeubeubj{)r}r(h Uh!j|h"jh'j~h)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]r(h)r}r(h X*Bases: :class:`circuits.core.events.Event`rh!jh"jh'hh)}r(h+]rh-]rh/]rh1]rh4]ruh6Kh7hh]r(hiXBases: rr}r(h XBases: rh!jubhE)r}r(h X#:class:`circuits.core.events.Event`rh!jh"h%h'hIh)}r(UreftyperXclassrhMhNXcircuits.core.events.EventrU refdomainrXpyrh1]r h/]r U refexplicitr h+]r h-]r h4]rhXhYhZjh[juh6Kh]rh])r}r(h jh)}r(h+]rh-]r(hcjXpy-classreh/]rh1]rh4]ruh!jh]rhiXcircuits.core.events.Eventrr}r(h Uh!jubah'hmubaubeubh)r}r(h X Task Eventrh!jh"X]/home/prologic/work/circuits/circuits/core/workers.py:docstring of circuits.core.workers.Taskr h'hh)}r!(h+]r"h-]r#h/]r$h1]r%h4]r&uh6Kh7hh]r'hiX Task Eventr(r)}r*(h jh!jubaubh)r+}r,(h X]This Event is used to initiate a new task to be performed by a Worker or a Pool of Worker(s).r-h!jh"j h'hh)}r.(h+]r/h-]r0h/]r1h1]r2h4]r3uh6Kh7hh]r4hiX]This Event is used to initiate a new task to be performed by a Worker or a Pool of Worker(s).r5r6}r7(h j-h!j+ubaubj)r8}r9(h Uh!jh"Nh'jh)}r:(h+]r;h-]r<h/]r=h1]r>h4]r?uh6Nh7hh]r@j)rA}rB(h Uh)}rC(h+]rDh-]rEh/]rFh1]rGh4]rHuh!j8h]rI(j)rJ}rK(h Uh)}rL(h+]rMh-]rNh/]rOh1]rPh4]rQuh!jAh]rRhiX ParametersrSrT}rU(h Uh!jJubah'jubj)rV}rW(h Uh)}rX(h+]rYh-]rZh/]r[h1]r\h4]r]uh!jAh]r^cdocutils.nodes bullet_list r_)r`}ra(h Uh)}rb(h+]rch-]rdh/]reh1]rfh4]rguh!jVh]rh(cdocutils.nodes list_item ri)rj}rk(h Uh)}rl(h+]rmh-]rnh/]roh1]rph4]rquh!j`h]rrh)rs}rt(h Uh)}ru(h+]rvh-]rwh/]rxh1]ryh4]rzuh!jjh]r{(h)r|}r}(h Xfh)}r~(h+]rh-]rh/]rh1]rh4]ruh!jsh]rhiXfr}r(h Uh!j|ubah'hubhiX (rr}r(h Uh!jsubhE)r}r(h Uh)}r(Ureftyperj)U reftargetrXfunctionrU refdomainrjh1]rh/]rU refexplicitrh+]rh-]rh4]ruh!jsh]rj4)r}r(h jh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiXfunctionrr}r(h Uh!jubah'jAubah'hIubhiX)r}r(h Uh!jsubhiX -- rr}r(h Uh!jsubhiXThe function to be executed.rr}r(h XThe function to be executed.rh!jsubeh'hubah'U list_itemrubji)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!j`h]rh)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]r(h)r}r(h Xargsrh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiXargsrr}r(h Uh!jubah'hubhiX (rr}r(h Uh!jubhE)r}r(h Uh)}r(Ureftyperj)U reftargetrXtuplerU refdomainrjh1]rh/]rU refexplicitrh+]rh-]rh4]ruh!jh]rj4)r}r(h jh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiXtuplerr}r(h Uh!jubah'jAubah'hIubhiX)r}r(h Uh!jubhiX -- rr}r(h Uh!jubhiX!Arguments to pass to the functionrr}r(h X!Arguments to pass to the functionrh!jubeh'hubah'jubji)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!j`h]rh)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]r(h)r}r(h Xkwargsrh)}r(h+]r h-]r h/]r h1]r h4]r uh!jh]rhiXkwargsrr}r(h Uh!jubah'hubhiX (rr}r(h Uh!jubhE)r}r(h Uh)}r(Ureftyperj)U reftargetrXdictrU refdomainrjh1]rh/]rU refexplicitrh+]rh-]r h4]r!uh!jh]r"j4)r#}r$(h jh)}r%(h+]r&h-]r'h/]r(h1]r)h4]r*uh!jh]r+hiXdictr,r-}r.(h Uh!j#ubah'jAubah'hIubhiX)r/}r0(h Uh!jubhiX -- r1r2}r3(h Uh!jubhiX)Keyword Arguments to pass to the functionr4r5}r6(h X)Keyword Arguments to pass to the functionr7h!jubeh'hubah'jubeh'U bullet_listr8ubah'jKubeh'jLubaubeubeubeubh)r9}r:(h Uh!hh"h%h'h(h)}r;(h+]r<h-]r=h/]r>h1]r?hah4]r@hauh6Kh7hh]rA(h9)rB}rC(h X FunctionsrDh!j9h"h%h'h=h)}rE(h+]rFh-]rGh/]rHh1]rIh4]rJuh6Kh7hh]rKhiX FunctionsrLrM}rN(h jDh!jBubaubh)rO}rP(h X**none**rQh!j9h"h%h'hh)}rR(h+]rSh-]rTh/]rUh1]rVh4]rWuh6Kh7hh]rXh)rY}rZ(h jQh)}r[(h+]r\h-]r]h/]r^h1]r_h4]r`uh!jOh]rahiXnonerbrc}rd(h Uh!jYubah'hubaubeubeubah UU transformerreNU footnote_refsrf}rgUrefnamesrh}riUsymbol_footnotesrj]rkUautofootnote_refsrl]rmUsymbol_footnote_refsrn]roU citationsrp]rqh7hU current_linerrNUtransform_messagesrs]rtUreporterruNUid_startrvKU autofootnotesrw]rxU citation_refsry}rzUindirect_targetsr{]r|Usettingsr}(cdocutils.frontend Values r~or}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh=NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUF/home/prologic/work/circuits/docs/source/api/circuits_core_workers.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hj9h3cdocutils.nodes target r)r}r(h Uh!hh"huh'Utargetrh)}r(h+]rh1]rh3ah/]rUismodrh-]rh4]ruh6Kh7hh]rubhhhjhhhhh jhjZuUsubstitution_namesr}rh'h7h)}r(h+]rh1]rh/]rUsourcerh%h-]rh4]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_core_timers.doctree0000644000014400001440000003515612113366656025312 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNXcircuits.core.timers.TimerqXclassesqNX componentsq NX circuits.core.timers.Timer.resetq Xeventsq NXcircuits.core.timers -- timersq NuUsubstitution_defsq }qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhhhUclassesqh U componentsqh h h Ueventsqh Ucircuits-core-timers-timersquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceq UUparentq!hUsourceq"cdocutils.nodes reprunicode q#XE/home/prologic/work/circuits/docs/source/api/circuits_core_timers.rstq$q%}q&bUtagnameq'Usectionq(U attributesq)}q*(Udupnamesq+]q,Uclassesq-]q.Ubackrefsq/]q0Uidsq1]q2(Xmodule-circuits.core.timersq3heUnamesq4]q5h auUlineq6KUdocumentq7hh]q8(cdocutils.nodes title q9)q:}q;(h X%:mod:`circuits.core.timers` -- Timersq(h+]q?h-]q@h/]qAh1]qBh4]qCuh6Kh7hh]qD(csphinx.addnodes pending_xref qE)qF}qG(h X:mod:`circuits.core.timers`qHh!h:h"h%h'U pending_xrefqIh)}qJ(UreftypeqKXmodqLUrefwarnqMU reftargetqNXcircuits.core.timersqOU refdomainqPXpyqQh1]qRh/]qSU refexplicitqTh+]qUh-]qVh4]qWUrefdocqXUapi/circuits_core_timersqYUpy:classqZNU py:moduleq[Nuh6Kh]q\cdocutils.nodes literal q])q^}q_(h hHh)}q`(h+]qah-]qb(UxrefqchQXpy-modqdeh/]qeh1]qfh4]qguh!hFh]qhcdocutils.nodes Text qiXcircuits.core.timersqjqk}ql(h Uh!h^ubah'UliteralqmubaubhiX -- Timersqnqo}qp(h X -- Timersqqh!h:ubeubcsphinx.addnodes index qr)qs}qt(h Uh!hh"U quh'Uindexqvh)}qw(h1]qxh/]qyh+]qzh-]q{h4]q|Uentriesq}]q~(UsingleqXcircuits.core.timers (module)Xmodule-circuits.core.timersUtqauh6Kh7hh]qubcdocutils.nodes paragraph q)q}q(h X+Timer component to facilitate timed events.qh!hh"XV/home/prologic/work/circuits/circuits/core/timers.py:docstring of circuits.core.timersqh'U paragraphqh)}q(h+]qh-]qh/]qh1]qh4]quh6Kh7hh]qhiX+Timer component to facilitate timed events.qq}q(h hh!hubaubh)q}q(h Uh!hh"h%h'h(h)}q(h+]qh-]qh/]qh1]qhah4]qhauh6Kh7hh]q(h9)q}q(h XClassesqh!hh"h%h'h=h)}q(h+]qh-]qh/]qh1]qh4]quh6Kh7hh]qhiXClassesqq}q(h hh!hubaubh)q}q(h X**none**qh!hh"h%h'hh)}q(h+]qh-]qh/]qh1]qh4]quh6K h7hh]qcdocutils.nodes strong q)q}q(h hh)}q(h+]qh-]qh/]qh1]qh4]quh!hh]qhiXnoneqq}q(h Uh!hubah'Ustrongqubaubeubh)q}q(h Uh!hh"h%h'h(h)}q(h+]qh-]qh/]qh1]qhah4]qh auh6Kh7hh]q(h9)q}q(h X Componentsqh!hh"h%h'h=h)}q(h+]qh-]qh/]qh1]qh4]quh6Kh7hh]qhiX ComponentsqӅq}q(h hh!hubaubhr)q}q(h Uh!hh"Nh'hvh)}q(h1]qh/]qh+]qh-]qh4]qUentriesq]q(hX%Timer (class in circuits.core.timers)hUtqauh6Nh7hh]qubcsphinx.addnodes desc q)q}q(h Uh!hh"Nh'Udescqh)}q(UnoindexqUdomainqXpyqh1]qh/]qh+]qh-]qh4]qUobjtypeqXclassqUdesctypeqhuh6Nh7hh]q(csphinx.addnodes desc_signature q)q}q(h X+Timer(interval, event, *channels, **kwargs)qh!hh"U qh'Udesc_signatureqh)}q(h1]qhaUmoduleqh#Xcircuits.core.timersqq}qbh/]qh+]rh-]rh4]rhaUfullnamerXTimerrUclassrUUfirstruh6Nh7hh]r(csphinx.addnodes desc_annotation r)r }r (h Xclass r h!hh"hh'Udesc_annotationr h)}r (h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiXclass rr}r(h Uh!j ubaubcsphinx.addnodes desc_addname r)r}r(h Xcircuits.core.timers.rh!hh"hh'U desc_addnamerh)}r(h+]rh-]rh/]rh1]r h4]r!uh6Nh7hh]r"hiXcircuits.core.timers.r#r$}r%(h Uh!jubaubcsphinx.addnodes desc_name r&)r'}r((h jh!hh"hh'U desc_namer)h)}r*(h+]r+h-]r,h/]r-h1]r.h4]r/uh6Nh7hh]r0hiXTimerr1r2}r3(h Uh!j'ubaubcsphinx.addnodes desc_parameterlist r4)r5}r6(h Uh!hh"hh'Udesc_parameterlistr7h)}r8(h+]r9h-]r:h/]r;h1]r<h4]r=uh6Nh7hh]r>(csphinx.addnodes desc_parameter r?)r@}rA(h XintervalrBh)}rC(h+]rDh-]rEh/]rFh1]rGh4]rHuh!j5h]rIhiXintervalrJrK}rL(h Uh!j@ubah'Udesc_parameterrMubj?)rN}rO(h XeventrPh)}rQ(h+]rRh-]rSh/]rTh1]rUh4]rVuh!j5h]rWhiXeventrXrY}rZ(h Uh!jNubah'jMubj?)r[}r\(h X *channelsr]h)}r^(h+]r_h-]r`h/]rah1]rbh4]rcuh!j5h]rdhiX *channelsrerf}rg(h Uh!j[ubah'jMubj?)rh}ri(h X**kwargsrjh)}rk(h+]rlh-]rmh/]rnh1]roh4]rpuh!j5h]rqhiX**kwargsrrrs}rt(h Uh!jhubah'jMubeubeubcsphinx.addnodes desc_content ru)rv}rw(h Uh!hh"hh'U desc_contentrxh)}ry(h+]rzh-]r{h/]r|h1]r}h4]r~uh6Nh7hh]r(h)r}r(h X6Bases: :class:`circuits.core.components.BaseComponent`rh!jvh"U rh'hh)}r(h+]rh-]rh/]rh1]rh4]ruh6Kh7hh]r(hiXBases: rr}r(h XBases: rh!jubhE)r}r(h X/:class:`circuits.core.components.BaseComponent`rh!jh"h%h'hIh)}r(UreftyperXclassrhMhNX&circuits.core.components.BaseComponentrU refdomainrXpyrh1]rh/]rU refexplicitrh+]rh-]rh4]rhXhYhZjh[Xcircuits.core.timersruh6Kh]rh])r}r(h jh)}r(h+]rh-]r(hcjXpy-classreh/]rh1]rh4]ruh!jh]rhiX&circuits.core.components.BaseComponentrr}r(h Uh!jubah'hmubaubeubh)r}r(h XlA timer is a component that fires an event once after a certain delay or periodically at a regular interval.rh!jvh"X\/home/prologic/work/circuits/circuits/core/timers.py:docstring of circuits.core.timers.Timerrh'hh)}r(h+]rh-]rh/]rh1]rh4]ruh6Kh7hh]rhiXlA timer is a component that fires an event once after a certain delay or periodically at a regular interval.rr}r(h jh!jubaubcdocutils.nodes field_list r)r}r(h Uh!jvh"Nh'U field_listrh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rcdocutils.nodes field r)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]r(cdocutils.nodes field_name r)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiX Parametersrr}r(h Uh!jubah'U field_namerubcdocutils.nodes field_body r)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rcdocutils.nodes bullet_list r)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]r(cdocutils.nodes list_item r)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rh)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]r(h)r}r(h Xintervalrh)}r(h+]r h-]r h/]r h1]r h4]r uh!jh]rhiXintervalrr}r(h Uh!jubah'hubhiX (rr}r(h Uh!jubhE)r}r(h Uh)}r(UreftyperUobjrU reftargetrXdatetime or float numberrU refdomainrhh1]rh/]rU refexplicitrh+]r h-]r!h4]r"uh!jh]r#cdocutils.nodes emphasis r$)r%}r&(h jh)}r'(h+]r(h-]r)h/]r*h1]r+h4]r,uh!jh]r-hiXdatetime or float numberr.r/}r0(h Uh!j%ubah'Uemphasisr1ubah'hIubhiX)r2}r3(h Uh!jubhiX -- r4r5}r6(h Uh!jubhiXthe delay or interval to wait for until the event is fired. If interval is specified as datetime, the interval is recalculated as the time span from now to the given datetime.r7r8}r9(h Xthe delay or interval to wait for until the event is fired. If interval is specified as datetime, the interval is recalculated as the time span from now to the given datetime.r:h!jubeh'hubah'U list_itemr;ubj)r<}r=(h Uh)}r>(h+]r?h-]r@h/]rAh1]rBh4]rCuh!jh]rDh)rE}rF(h Uh)}rG(h+]rHh-]rIh/]rJh1]rKh4]rLuh!j<h]rM(h)rN}rO(h XeventrPh)}rQ(h+]rRh-]rSh/]rTh1]rUh4]rVuh!jEh]rWhiXeventrXrY}rZ(h Uh!jNubah'hubhiX (r[r\}r](h Uh!jEubhE)r^}r_(h X:class:`~.events.Event`r`h!jEh"h%h'hIh)}ra(UreftyperbXclassrcU refspecificrdhMhNX events.EventreU refdomainrfXpyrgh1]rhh/]riU refexplicitrjh+]rkh-]rlh4]rmhXhYhZjh[juh6Kh]rnh])ro}rp(h j`h)}rq(h+]rrh-]rs(hcjgXpy-classrteh/]ruh1]rvh4]rwuh!j^h]rxhiXEventryrz}r{(h Uh!joubah'hmubaubhiX)r|}r}(h Uh!jEubhiX -- r~r}r(h Uh!jEubhiXthe event to fire.rr}r(h Xthe event to fire.rh!jEubeh'hubah'j;ubeh'U bullet_listrubah'U field_bodyrubeh'Ufieldrubaubh)r}r(h XIf the optional keyword argument *persist* is set to ``True``, the event will be fired repeatedly. Else the timer fires the event once and then unregisters itself.rh!jvh"jh'hh)}r(h+]rh-]rh/]rh1]rh4]ruh6K h7hh]r(hiX!If the optional keyword argument rr}r(h X!If the optional keyword argument rh!jubj$)r}r(h X *persist*rh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiXpersistrr}r(h Uh!jubah'j1ubhiX is set to rr}r(h X is set to rh!jubh])r}r(h X``True``rh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiXTruerr}r(h Uh!jubah'hmubhiXf, the event will be fired repeatedly. Else the timer fires the event once and then unregisters itself.rr}r(h Xf, the event will be fired repeatedly. Else the timer fires the event once and then unregisters itself.rh!jubeubhr)r}r(h Uh!jvh"Xb/home/prologic/work/circuits/circuits/core/timers.py:docstring of circuits.core.timers.Timer.resetrh'hvh)}r(h1]rh/]rh+]rh-]rh4]rUentriesr]r(hX+reset() (circuits.core.timers.Timer method)h Utrauh6Nh7hh]rubh)r}r(h Uh!jvh"jh'hh)}r(hhXpyrh1]rh/]rh+]rh-]rh4]rhXmethodrhjuh6Nh7hh]r(h)r}r(h X Timer.reset()rh!jh"hh'hh)}r(h1]rh ahh#Xcircuits.core.timersrr}rbh/]rh+]rh-]rh4]rh ajX Timer.resetrjjjuh6Nh7hh]r(j&)r}r(h Xresetrh!jh"hh'j)h)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiXresetrr}r(h Uh!jubaubj4)r}r(h Uh!jh"hh'j7h)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rubeubju)r}r(h Uh!jh"hh'jxh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rh)r}r(h XBReset the timer, i.e. clear the amount of time already waited for.rh!jh"jh'hh)}r(h+]rh-]rh/]rh1]rh4]ruh6Kh7hh]rhiXBReset the timer, i.e. clear the amount of time already waited for.rr}r (h jh!jubaubaubeubeubeubeubh)r }r (h Uh!hh"h%h'h(h)}r (h+]r h-]rh/]rh1]rhah4]rh auh6Kh7hh]r(h9)r}r(h XEventsrh!j h"h%h'h=h)}r(h+]rh-]rh/]rh1]rh4]ruh6Kh7hh]rhiXEventsrr}r(h jh!jubaubh)r }r!(h X**none**r"h!j h"h%h'hh)}r#(h+]r$h-]r%h/]r&h1]r'h4]r(uh6Kh7hh]r)h)r*}r+(h j"h)}r,(h+]r-h-]r.h/]r/h1]r0h4]r1uh!j h]r2hiXnoner3r4}r5(h Uh!j*ubah'hubaubeubh)r6}r7(h Uh!hh"h%h'h(h)}r8(h+]r9h-]r:h/]r;h1]r<hah4]r=hauh6Kh7hh]r>(h9)r?}r@(h X FunctionsrAh!j6h"h%h'h=h)}rB(h+]rCh-]rDh/]rEh1]rFh4]rGuh6Kh7hh]rHhiX FunctionsrIrJ}rK(h jAh!j?ubaubh)rL}rM(h X**none**rNh!j6h"h%h'hh)}rO(h+]rPh-]rQh/]rRh1]rSh4]rTuh6Kh7hh]rUh)rV}rW(h jNh)}rX(h+]rYh-]rZh/]r[h1]r\h4]r]uh!jLh]r^hiXnoner_r`}ra(h Uh!jVubah'hubaubeubeubah UU transformerrbNU footnote_refsrc}rdUrefnamesre}rfUsymbol_footnotesrg]rhUautofootnote_refsri]rjUsymbol_footnote_refsrk]rlU citationsrm]rnh7hU current_lineroNUtransform_messagesrp]rqUreporterrrNUid_startrsKU autofootnotesrt]ruU citation_refsrv}rwUindirect_targetsrx]ryUsettingsrz(cdocutils.frontend Values r{or|}r}(Ufootnote_backlinksr~KUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh=NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUE/home/prologic/work/circuits/docs/source/api/circuits_core_timers.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hj6h3cdocutils.nodes target r)r}r(h Uh!hh"huh'Utargetrh)}r(h+]rh1]rh3ah/]rUismodrh-]rh4]ruh6Kh7hh]rubhj hhhhhhh jhhuUsubstitution_namesr}rh'h7h)}r(h+]rh1]rh/]rUsourcerh%h-]rh4]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_dispatchers_static.doctree0000644000014400001440000002215712113366663027507 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X&circuits.web.dispatchers.static.StaticqX functionsqNX)circuits.web.dispatchers.static -- staticqNX componentsq NXeventsq NuUsubstitution_defsq }q Uparse_messagesq ]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hhhU functionsqhU&circuits-web-dispatchers-static-staticqh U componentsqh UeventsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode q XP/home/prologic/work/circuits/docs/source/api/circuits_web_dispatchers_static.rstq!q"}q#bUtagnameq$Usectionq%U attributesq&}q'(Udupnamesq(]q)Uclassesq*]q+Ubackrefsq,]q-Uidsq.]q/(X&module-circuits.web.dispatchers.staticq0heUnamesq1]q2hauUlineq3KUdocumentq4hh]q5(cdocutils.nodes title q6)q7}q8(hX0:mod:`circuits.web.dispatchers.static` -- Staticq9hhhh"h$Utitleq:h&}q;(h(]qh.]q?h1]q@uh3Kh4hh]qA(csphinx.addnodes pending_xref qB)qC}qD(hX&:mod:`circuits.web.dispatchers.static`qEhh7hh"h$U pending_xrefqFh&}qG(UreftypeqHXmodqIUrefwarnqJU reftargetqKXcircuits.web.dispatchers.staticqLU refdomainqMXpyqNh.]qOh,]qPU refexplicitqQh(]qRh*]qSh1]qTUrefdocqUU#api/circuits_web_dispatchers_staticqVUpy:classqWNU py:moduleqXNuh3Kh]qYcdocutils.nodes literal qZ)q[}q\(hhEh&}q](h(]q^h*]q_(Uxrefq`hNXpy-modqaeh,]qbh.]qch1]qduhhCh]qecdocutils.nodes Text qfXcircuits.web.dispatchers.staticqgqh}qi(hUhh[ubah$UliteralqjubaubhfX -- Staticqkql}qm(hX -- Staticqnhh7ubeubcsphinx.addnodes index qo)qp}qq(hUhhhU qrh$Uindexqsh&}qt(h.]quh,]qvh(]qwh*]qxh1]qyUentriesqz]q{(Usingleq|X(circuits.web.dispatchers.static (module)X&module-circuits.web.dispatchers.staticUtq}auh3Kh4hh]q~ubcdocutils.nodes paragraph q)q}q(hXStaticqhhhXl/home/prologic/work/circuits/circuits/web/dispatchers/static.py:docstring of circuits.web.dispatchers.staticqh$U paragraphqh&}q(h(]qh*]qh,]qh.]qh1]quh3Kh4hh]qhfXStaticqq}q(hhhhubaubh)q}q(hXThis modStatic implements a Static dispatcher used to serve up static resources and an optional apache-style directory listing.qhhhhh$hh&}q(h(]qh*]qh,]qh.]qh1]quh3Kh4hh]qhfXThis modStatic implements a Static dispatcher used to serve up static resources and an optional apache-style directory listing.qq}q(hhhhubaubh)q}q(hUhhhh"h$h%h&}q(h(]qh*]qh,]qh.]qhah1]qh auh3Kh4hh]q(h6)q}q(hXEventsqhhhh"h$h:h&}q(h(]qh*]qh,]qh.]qh1]quh3Kh4hh]qhfXEventsqq}q(hhhhubaubh)q}q(hX**none**qhhhh"h$hh&}q(h(]qh*]qh,]qh.]qh1]quh3K h4hh]qcdocutils.nodes strong q)q}q(hhh&}q(h(]qh*]qh,]qh.]qh1]quhhh]qhfXnoneqƅq}q(hUhhubah$Ustrongqubaubeubh)q}q(hUhhhh"h$h%h&}q(h(]qh*]qh,]qh.]qhah1]qh auh3Kh4hh]q(h6)q}q(hX Componentsqhhhh"h$h:h&}q(h(]qh*]qh,]qh.]qh1]quh3Kh4hh]qhfX Componentsq݅q}q(hhhhubaubho)q}q(hUhhhU qh$hsh&}q(h.]qh,]qh(]qh*]qh1]qUentriesq]q(h|X1Static (class in circuits.web.dispatchers.static)hUtqauh3Nh4hh]qubcsphinx.addnodes desc q)q}q(hUhhhhh$Udescqh&}q(UnoindexqUdomainqXpyqh.]qh,]qh(]qh*]qh1]qUobjtypeqXclassqUdesctypeqhuh3Nh4hh]q(csphinx.addnodes desc_signature q)q}r(hXYStatic(path=None, docroot=None, defaults=('index.html', 'index.xhtml'), dirlisting=False)rhhhU rh$Udesc_signaturerh&}r(h.]rhaUmodulerh Xcircuits.web.dispatchers.staticrr}r bh,]r h(]r h*]r h1]r haUfullnamerXStaticrUclassrUUfirstruh3Nh4hh]r(csphinx.addnodes desc_annotation r)r}r(hXclass rhhhjh$Udesc_annotationrh&}r(h(]rh*]rh,]rh.]rh1]ruh3Nh4hh]rhfXclass rr }r!(hUhjubaubcsphinx.addnodes desc_addname r")r#}r$(hX circuits.web.dispatchers.static.r%hhhjh$U desc_addnamer&h&}r'(h(]r(h*]r)h,]r*h.]r+h1]r,uh3Nh4hh]r-hfX circuits.web.dispatchers.static.r.r/}r0(hUhj#ubaubcsphinx.addnodes desc_name r1)r2}r3(hjhhhjh$U desc_namer4h&}r5(h(]r6h*]r7h,]r8h.]r9h1]r:uh3Nh4hh]r;hfXStaticr<r=}r>(hUhj2ubaubcsphinx.addnodes desc_parameterlist r?)r@}rA(hUhhhjh$Udesc_parameterlistrBh&}rC(h(]rDh*]rEh,]rFh.]rGh1]rHuh3Nh4hh]rI(csphinx.addnodes desc_parameter rJ)rK}rL(hX path=NonerMh&}rN(h(]rOh*]rPh,]rQh.]rRh1]rSuhj@h]rThfX path=NonerUrV}rW(hUhjKubah$Udesc_parameterrXubjJ)rY}rZ(hX docroot=Noner[h&}r\(h(]r]h*]r^h,]r_h.]r`h1]rauhj@h]rbhfX docroot=Nonercrd}re(hUhjYubah$jXubjJ)rf}rg(hXdefaults=('index.html'rhh&}ri(h(]rjh*]rkh,]rlh.]rmh1]rnuhj@h]rohfXdefaults=('index.html'rprq}rr(hUhjfubah$jXubjJ)rs}rt(hX'index.xhtml')ruh&}rv(h(]rwh*]rxh,]ryh.]rzh1]r{uhj@h]r|hfX'index.xhtml')r}r~}r(hUhjsubah$jXubjJ)r}r(hXdirlisting=Falserh&}r(h(]rh*]rh,]rh.]rh1]ruhj@h]rhfXdirlisting=Falserr}r(hUhjubah$jXubeubeubcsphinx.addnodes desc_content r)r}r(hUhhhjh$U desc_contentrh&}r(h(]rh*]rh,]rh.]rh1]ruh3Nh4hh]rh)r}r(hX6Bases: :class:`circuits.core.components.BaseComponent`rhjhhh$hh&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]r(hfXBases: rr}r(hXBases: rhjubhB)r}r(hX/:class:`circuits.core.components.BaseComponent`rhjhh"h$hFh&}r(UreftyperXclassrhJhKX&circuits.core.components.BaseComponentrU refdomainrXpyrh.]rh,]rU refexplicitrh(]rh*]rh1]rhUhVhWjhXXcircuits.web.dispatchers.staticruh3Kh]rhZ)r}r(hjh&}r(h(]rh*]r(h`jXpy-classreh,]rh.]rh1]ruhjh]rhfX&circuits.core.components.BaseComponentrr}r(hUhjubah$hjubaubeubaubeubeubh)r}r(hUhhhh"h$h%h&}r(h(]rh*]rh,]rh.]rhah1]rhauh3Kh4hh]r(h6)r}r(hX Functionsrhjhh"h$h:h&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]rhfX Functionsrr}r(hjhjubaubh)r}r(hX**none**rhjhh"h$hh&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]rh)r}r(hjh&}r(h(]rh*]rh,]rh.]rh1]ruhjh]rhfXnonerr}r(hUhjubah$hubaubeubeubahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh4hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values r or }r (Ufootnote_backlinksr KUrecord_dependenciesr NU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh:NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerr Ustrictr!U sectnum_xformr"KUdump_transformsr#NU docinfo_xformr$KUwarning_streamr%NUpep_file_url_templater&Upep-%04dr'Uexit_status_levelr(KUconfigr)NUstrict_visitorr*NUcloak_email_addressesr+Utrim_footnote_reference_spacer,Uenvr-NUdump_pseudo_xmlr.NUexpose_internalsr/NUsectsubtitle_xformr0U source_linkr1NUrfc_referencesr2NUoutput_encodingr3Uutf-8r4U source_urlr5NUinput_encodingr6U utf-8-sigr7U_disable_configr8NU id_prefixr9UU tab_widthr:KUerror_encodingr;U ISO-8859-1r<U_sourcer=UP/home/prologic/work/circuits/docs/source/api/circuits_web_dispatchers_static.rstr>Ugettext_compactr?U generatorr@NUdump_internalsrANU smart_quotesrBU pep_base_urlrCUhttp://www.python.org/dev/peps/rDUsyntax_highlightrEUlongrFUinput_encoding_error_handlerrGj!Uauto_id_prefixrHUidrIUdoctitle_xformrJUstrip_elements_with_classesrKNU _config_filesrL]rMUfile_insertion_enabledrNKU raw_enabledrOKU dump_settingsrPNubUsymbol_footnote_startrQKUidsrR}rS(hjhhhhhhhhh0cdocutils.nodes target rT)rU}rV(hUhhhhrh$UtargetrWh&}rX(h(]rYh.]rZh0ah,]r[Uismodr\h*]r]h1]r^uh3Kh4hh]r_ubuUsubstitution_namesr`}rah$h4h&}rb(h(]rch.]rdh,]reUsourcerfh"h*]rgh1]rhuU footnotesri]rjUrefidsrk}rlub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_sessions.doctree0000644000014400001440000002077412113366666025503 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X!circuits.web.sessions -- sessionsqNX functionsqNXcircuits.web.sessions.SessionsqXeventsq NX componentsq NuUsubstitution_defsq }q Uparse_messagesq ]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hUcircuits-web-sessions-sessionsqhU functionsqhhh Ueventsqh U componentsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode q XF/home/prologic/work/circuits/docs/source/api/circuits_web_sessions.rstq!q"}q#bUtagnameq$Usectionq%U attributesq&}q'(Udupnamesq(]q)Uclassesq*]q+Ubackrefsq,]q-Uidsq.]q/(Xmodule-circuits.web.sessionsq0heUnamesq1]q2hauUlineq3KUdocumentq4hh]q5(cdocutils.nodes title q6)q7}q8(hX(:mod:`circuits.web.sessions` -- Sessionsq9hhhh"h$Utitleq:h&}q;(h(]qh.]q?h1]q@uh3Kh4hh]qA(csphinx.addnodes pending_xref qB)qC}qD(hX:mod:`circuits.web.sessions`qEhh7hh"h$U pending_xrefqFh&}qG(UreftypeqHXmodqIUrefwarnqJU reftargetqKXcircuits.web.sessionsqLU refdomainqMXpyqNh.]qOh,]qPU refexplicitqQh(]qRh*]qSh1]qTUrefdocqUUapi/circuits_web_sessionsqVUpy:classqWNU py:moduleqXNuh3Kh]qYcdocutils.nodes literal qZ)q[}q\(hhEh&}q](h(]q^h*]q_(Uxrefq`hNXpy-modqaeh,]qbh.]qch1]qduhhCh]qecdocutils.nodes Text qfXcircuits.web.sessionsqgqh}qi(hUhh[ubah$UliteralqjubaubhfX -- Sessionsqkql}qm(hX -- Sessionsqnhh7ubeubcsphinx.addnodes index qo)qp}qq(hUhhhU qrh$Uindexqsh&}qt(h.]quh,]qvh(]qwh*]qxh1]qyUentriesqz]q{(Usingleq|Xcircuits.web.sessions (module)Xmodule-circuits.web.sessionsUtq}auh3Kh4hh]q~ubcdocutils.nodes paragraph q)q}q(hXSession ComponentsqhhhXX/home/prologic/work/circuits/circuits/web/sessions.py:docstring of circuits.web.sessionsqh$U paragraphqh&}q(h(]qh*]qh,]qh.]qh1]quh3Kh4hh]qhfXSession Componentsqq}q(hhhhubaubh)q}q(hXfThis module implements Session Components that can be used to store and access persistent information.qhhhhh$hh&}q(h(]qh*]qh,]qh.]qh1]quh3Kh4hh]qhfXfThis module implements Session Components that can be used to store and access persistent information.qq}q(hhhhubaubh)q}q(hUhhhh"h$h%h&}q(h(]qh*]qh,]qh.]qhah1]qh auh3Kh4hh]q(h6)q}q(hXEventsqhhhh"h$h:h&}q(h(]qh*]qh,]qh.]qh1]quh3Kh4hh]qhfXEventsqq}q(hhhhubaubh)q}q(hX**none**qhhhh"h$hh&}q(h(]qh*]qh,]qh.]qh1]quh3K h4hh]qcdocutils.nodes strong q)q}q(hhh&}q(h(]qh*]qh,]qh.]qh1]quhhh]qhfXnoneqƅq}q(hUhhubah$Ustrongqubaubeubh)q}q(hUhhhh"h$h%h&}q(h(]qh*]qh,]qh.]qhah1]qh auh3Kh4hh]q(h6)q}q(hX Componentsqhhhh"h$h:h&}q(h(]qh*]qh,]qh.]qh1]quh3Kh4hh]qhfX Componentsq݅q}q(hhhhubaubho)q}q(hUhhhU qh$hsh&}q(h.]qh,]qh(]qh*]qh1]qUentriesq]q(h|X)Sessions (class in circuits.web.sessions)hUtqauh3Nh4hh]qubcsphinx.addnodes desc q)q}q(hUhhhhh$Udescqh&}q(UnoindexqUdomainqXpyqh.]qh,]qh(]qh*]qh1]qUobjtypeqXclassqUdesctypeqhuh3Nh4hh]q(csphinx.addnodes desc_signature q)q}r(hX2Sessions(name='circuits.session', *args, **kwargs)rhhhU rh$Udesc_signaturerh&}r(h.]rhaUmodulerh Xcircuits.web.sessionsrr}r bh,]r h(]r h*]r h1]r haUfullnamerXSessionsrUclassrUUfirstruh3Nh4hh]r(csphinx.addnodes desc_annotation r)r}r(hXclass rhhhjh$Udesc_annotationrh&}r(h(]rh*]rh,]rh.]rh1]ruh3Nh4hh]rhfXclass rr }r!(hUhjubaubcsphinx.addnodes desc_addname r")r#}r$(hXcircuits.web.sessions.r%hhhjh$U desc_addnamer&h&}r'(h(]r(h*]r)h,]r*h.]r+h1]r,uh3Nh4hh]r-hfXcircuits.web.sessions.r.r/}r0(hUhj#ubaubcsphinx.addnodes desc_name r1)r2}r3(hjhhhjh$U desc_namer4h&}r5(h(]r6h*]r7h,]r8h.]r9h1]r:uh3Nh4hh]r;hfXSessionsr<r=}r>(hUhj2ubaubcsphinx.addnodes desc_parameterlist r?)r@}rA(hUhhhjh$Udesc_parameterlistrBh&}rC(h(]rDh*]rEh,]rFh.]rGh1]rHuh3Nh4hh]rI(csphinx.addnodes desc_parameter rJ)rK}rL(hXname='circuits.session'rMh&}rN(h(]rOh*]rPh,]rQh.]rRh1]rSuhj@h]rThfXname='circuits.session'rUrV}rW(hUhjKubah$Udesc_parameterrXubjJ)rY}rZ(hX*argsr[h&}r\(h(]r]h*]r^h,]r_h.]r`h1]rauhj@h]rbhfX*argsrcrd}re(hUhjYubah$jXubjJ)rf}rg(hX**kwargsrhh&}ri(h(]rjh*]rkh,]rlh.]rmh1]rnuhj@h]rohfX**kwargsrprq}rr(hUhjfubah$jXubeubeubcsphinx.addnodes desc_content rs)rt}ru(hUhhhjh$U desc_contentrvh&}rw(h(]rxh*]ryh,]rzh.]r{h1]r|uh3Nh4hh]r}h)r~}r(hX2Bases: :class:`circuits.core.components.Component`rhjthhh$hh&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]r(hfXBases: rr}r(hXBases: rhj~ubhB)r}r(hX+:class:`circuits.core.components.Component`rhj~hh"h$hFh&}r(UreftyperXclassrhJhKX"circuits.core.components.ComponentrU refdomainrXpyrh.]rh,]rU refexplicitrh(]rh*]rh1]rhUhVhWjhXXcircuits.web.sessionsruh3Kh]rhZ)r}r(hjh&}r(h(]rh*]r(h`jXpy-classreh,]rh.]rh1]ruhjh]rhfX"circuits.core.components.Componentrr}r(hUhjubah$hjubaubeubaubeubeubh)r}r(hUhhhh"h$h%h&}r(h(]rh*]rh,]rh.]rhah1]rhauh3Kh4hh]r(h6)r}r(hX Functionsrhjhh"h$h:h&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]rhfX Functionsrr}r(hjhjubaubh)r}r(hX**none**rhjhh"h$hh&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]rh)r}r(hjh&}r(h(]rh*]rh,]rh.]rh1]ruhjh]rhfXnonerr}r(hUhjubah$hubaubeubeubahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh4hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh:NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsr NU docinfo_xformr KUwarning_streamr NUpep_file_url_templater Upep-%04dr Uexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthr KUerror_encodingr!U ISO-8859-1r"U_sourcer#UF/home/prologic/work/circuits/docs/source/api/circuits_web_sessions.rstr$Ugettext_compactr%U generatorr&NUdump_internalsr'NU smart_quotesr(U pep_base_urlr)Uhttp://www.python.org/dev/peps/r*Usyntax_highlightr+Ulongr,Uinput_encoding_error_handlerr-jUauto_id_prefixr.Uidr/Udoctitle_xformr0Ustrip_elements_with_classesr1NU _config_filesr2]r3Ufile_insertion_enabledr4KU raw_enabledr5KU dump_settingsr6NubUsymbol_footnote_startr7KUidsr8}r9(hjhhh0cdocutils.nodes target r:)r;}r<(hUhhhhrh$Utargetr=h&}r>(h(]r?h.]r@h0ah,]rAUismodrBh*]rCh1]rDuh3Kh4hh]rEubhhhhhhuUsubstitution_namesrF}rGh$h4h&}rH(h(]rIh.]rJh,]rKUsourcerLh"h*]rMh1]rNuU footnotesrO]rPUrefidsrQ}rRub.circuits-2.1.0/docs/build/doctrees/api/circuits_node_node.doctree0000644000014400001440000002156412113366662024724 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(Xcircuits.node.node.NodeqX functionsqNXcircuits.node.node -- nodeqNXeventsq NX componentsq NuUsubstitution_defsq }q Uparse_messagesq ]qcdocutils.nodes system_message q)q}q(U rawsourceqUUparentqcsphinx.addnodes desc_content q)q}q(hUhcsphinx.addnodes desc q)q}q(hUhcdocutils.nodes section q)q}q(hUhh)q}q(hUhhUsourceqcdocutils.nodes reprunicode q XC/home/prologic/work/circuits/docs/source/api/circuits_node_node.rstq!q"}q#bUtagnameq$Usectionq%U attributesq&}q'(Udupnamesq(]q)Uclassesq*]q+Ubackrefsq,]q-Uidsq.]q/(Xmodule-circuits.node.nodeq0Ucircuits-node-node-nodeq1eUnamesq2]q3hauUlineq4KUdocumentq5hUchildrenq6]q7(cdocutils.nodes title q8)q9}q:(hX!:mod:`circuits.node.node` -- Nodeq;hhhh"h$Utitleqh*]q?h,]q@h.]qAh2]qBuh4Kh5hh6]qC(csphinx.addnodes pending_xref qD)qE}qF(hX:mod:`circuits.node.node`qGhh9hh"h$U pending_xrefqHh&}qI(UreftypeqJXmodqKUrefwarnqLU reftargetqMXcircuits.node.nodeqNU refdomainqOXpyqPh.]qQh,]qRU refexplicitqSh(]qTh*]qUh2]qVUrefdocqWUapi/circuits_node_nodeqXUpy:classqYNU py:moduleqZNuh4Kh6]q[cdocutils.nodes literal q\)q]}q^(hhGh&}q_(h(]q`h*]qa(UxrefqbhPXpy-modqceh,]qdh.]qeh2]qfuhhEh6]qgcdocutils.nodes Text qhXcircuits.node.nodeqiqj}qk(hUhh]ubah$UliteralqlubaubhhX -- Nodeqmqn}qo(hX -- Nodeqphh9ubeubcsphinx.addnodes index qq)qr}qs(hUhhhU qth$Uindexquh&}qv(h.]qwh,]qxh(]qyh*]qzh2]q{Uentriesq|]q}(Usingleq~Xcircuits.node.node (module)Xmodule-circuits.node.nodeUtqauh4Kh5hh6]qubcdocutils.nodes paragraph q)q}q(hXNodeqhhhXR/home/prologic/work/circuits/circuits/node/node.py:docstring of circuits.node.nodeqh$U paragraphqh&}q(h(]qh*]qh,]qh.]qh2]quh4Kh5hh6]qhhXNodeqq}q(hhhhubaubh)q}q(hX...qhhhhh$hh&}q(h(]qh*]qh,]qh.]qh2]quh4Kh5hh6]qhhX...qq}q(hhhhubaubh)q}q(hUhhhh"h$h%h&}q(h(]qh*]qh,]qh.]qUeventsqah2]qh auh4Kh5hh6]q(h8)q}q(hXEventsqhhhh"h$hr.h$Udesc_signaturer/h&}r0(h.]r1haUmoduler2h Xcircuits.node.noder3r4}r5bh,]r6h(]r7h*]r8h2]r9haUfullnamer:XNoder;Uclassr<UUfirstr=uh4Nh5hh6]r>(csphinx.addnodes desc_annotation r?)r@}rA(hXclass rBhj+hj.h$Udesc_annotationrCh&}rD(h(]rEh*]rFh,]rGh.]rHh2]rIuh4Nh5hh6]rJhhXclass rKrL}rM(hUhj@ubaubcsphinx.addnodes desc_addname rN)rO}rP(hXcircuits.node.node.rQhj+hj.h$U desc_addnamerRh&}rS(h(]rTh*]rUh,]rVh.]rWh2]rXuh4Nh5hh6]rYhhXcircuits.node.node.rZr[}r\(hUhjOubaubcsphinx.addnodes desc_name r])r^}r_(hj;hj+hj.h$U desc_namer`h&}ra(h(]rbh*]rch,]rdh.]reh2]rfuh4Nh5hh6]rghhXNoderhri}rj(hUhj^ubaubcsphinx.addnodes desc_parameterlist rk)rl}rm(hUhj+hj.h$Udesc_parameterlistrnh&}ro(h(]rph*]rqh,]rrh.]rsh2]rtuh4Nh5hh6]ru(csphinx.addnodes desc_parameter rv)rw}rx(hX bind=Noneryh&}rz(h(]r{h*]r|h,]r}h.]r~h2]ruhjlh6]rhhX bind=Nonerr}r(hUhjwubah$Udesc_parameterrubjv)r}r(hXchannel='node'rh&}r(h(]rh*]rh,]rh.]rh2]ruhjlh6]rhhXchannel='node'rr}r(hUhjubah$jubeubeubheubhj.h$U desc_contentrh&}r(h(]rh*]rh,]rh.]rh2]ruh4Nh5hh6]r(h)r}r(hX6Bases: :class:`circuits.core.components.BaseComponent`rhhhU rh$hh&}r(h(]rh*]rh,]rh.]rh2]ruh4Kh5hh6]r(hhXBases: rr}r(hXBases: rhjubhD)r}r(hX/:class:`circuits.core.components.BaseComponent`rhjhh"h$hHh&}r(UreftyperXclassrhLhMX&circuits.core.components.BaseComponentrU refdomainrXpyrh.]rh,]rU refexplicitrh(]rh*]rh2]rhWhXhYj;hZXcircuits.node.noderuh4Kh6]rh\)r}r(hjh&}r(h(]rh*]r(hbjXpy-classreh,]rh.]rh2]ruhjh6]rhhX&circuits.core.components.BaseComponentrr}r(hUhjubah$hlubaubeubh)r}r(hXNoderhhhjh$hh&}r(h(]rh*]rh,]rh.]rh2]ruh4Kh5hh6]rhhXNoderr}r(hjhjubaubh)r}r(hX...rhhhjh$hh&}r(h(]rh*]rh,]rh.]rh2]ruh4Kh5hh6]rhhX...rr}r(hjhjubaubeubhjh$Usystem_messagerh&}r(h(]rUlevelrKh.]rh,]rUsourcerjh*]rh2]rUlinerKUtyperUINFOruh4Kh5hh6]rh)r}r(hUh&}r(h(]rh*]rh,]rh.]rh2]ruhhh6]rhhXeUnexpected possible title overline or transition. Treating it as ordinary text because it's so short.rr}r(hUhjubah$hubaubaUcurrent_sourcerNU decorationrNUautofootnote_startrKUnameidsr}r(hhhhhh1h hh huh6]rhahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr ]r U citationsr ]r h5hU current_liner NUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackr Upep_referencesr!NUstrip_commentsr"NU toc_backlinksr#Uentryr$U language_coder%Uenr&U datestampr'NU report_levelr(KU _destinationr)NU halt_levelr*KU strip_classesr+NhNUexpose_internalsr?NUsectsubtitle_xformr@U source_linkrANUrfc_referencesrBNUoutput_encodingrCUutf-8rDU source_urlrENUinput_encodingrFU utf-8-sigrGU_disable_configrHNU id_prefixrIUU tab_widthrJKUerror_encodingrKU ISO-8859-1rLU_sourcerMUC/home/prologic/work/circuits/docs/source/api/circuits_node_node.rstrNUgettext_compactrOU generatorrPNUdump_internalsrQNU smart_quotesrRU pep_base_urlrSUhttp://www.python.org/dev/peps/rTUsyntax_highlightrUUlongrVUinput_encoding_error_handlerrWj1Uauto_id_prefixrXUidrYUdoctitle_xformrZUstrip_elements_with_classesr[NU _config_filesr\]r]Ufile_insertion_enabledr^KU raw_enabledr_KU dump_settingsr`NubUsymbol_footnote_startraKUidsrb}rc(hhh1hh0cdocutils.nodes target rd)re}rf(hUhhhhth$Utargetrgh&}rh(h(]rih.]rjh0ah,]rkUismodrlh*]rmh2]rnuh4Kh5hh6]roubhhhj+hhuUsubstitution_namesrp}rqh$h5h&}rr(h(]rsh.]rth,]ruUsourcervh"h*]rwh2]rxuU footnotesry]rzUrefidsr{}r|ub.circuits-2.1.0/docs/build/doctrees/api/circuits_net_protocols_http.doctree0000644000014400001440000010374212113366660026720 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNX$circuits.net.protocols.http.ResponseqX#circuits.net.protocols.http.RequestqX circuits.net.protocols.http.HTTPq X componentsq NXeventsq NX,circuits.net.protocols.http -- http protocolq NuUsubstitution_defsq }qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhhhhh h h U componentsqh Ueventsqh U)circuits-net-protocols-http-http-protocolquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentq hUsourceq!cdocutils.nodes reprunicode q"XL/home/prologic/work/circuits/docs/source/api/circuits_net_protocols_http.rstq#q$}q%bUtagnameq&Usectionq'U attributesq(}q)(Udupnamesq*]q+Uclassesq,]q-Ubackrefsq.]q/Uidsq0]q1(X"module-circuits.net.protocols.httpq2heUnamesq3]q4h auUlineq5KUdocumentq6hh]q7(cdocutils.nodes title q8)q9}q:(hX3:mod:`circuits.net.protocols.http` -- HTTP Protocolq;h hh!h$h&Utitleqh,]q?h.]q@h0]qAh3]qBuh5Kh6hh]qC(csphinx.addnodes pending_xref qD)qE}qF(hX":mod:`circuits.net.protocols.http`qGh h9h!h$h&U pending_xrefqHh(}qI(UreftypeqJXmodqKUrefwarnqLU reftargetqMXcircuits.net.protocols.httpqNU refdomainqOXpyqPh0]qQh.]qRU refexplicitqSh*]qTh,]qUh3]qVUrefdocqWUapi/circuits_net_protocols_httpqXUpy:classqYNU py:moduleqZNuh5Kh]q[cdocutils.nodes literal q\)q]}q^(hhGh(}q_(h*]q`h,]qa(UxrefqbhPXpy-modqceh.]qdh0]qeh3]qfuh hEh]qgcdocutils.nodes Text qhXcircuits.net.protocols.httpqiqj}qk(hUh h]ubah&UliteralqlubaubhhX -- HTTP Protocolqmqn}qo(hX -- HTTP Protocolqph h9ubeubcsphinx.addnodes index qq)qr}qs(hUh hh!h$h&Uindexqth(}qu(h0]qvh.]qwh*]qxh,]qyh3]qzUentriesq{]q|(Usingleq}X$circuits.net.protocols.http (module)X"module-circuits.net.protocols.httpUtq~auh5Kh6hh]qubh)q}q(hUh hh!h$h&h'h(}q(h*]qh,]qh.]qh0]qhah3]qh auh5Kh6hh]q(h8)q}q(hXEventsqh hh!h$h&hqh&Udesc_signatureqh(}q(h0]qhaUmoduleqh"Xcircuits.net.protocols.httpqq}qbh.]qh*]qh,]qh3]qhaUfullnameqXRequestqUclassqUUfirstqƉuh5Nh6hh]q(csphinx.addnodes desc_annotation q)q}q(hXclass qh hh!hh&Udesc_annotationqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]qhhXclass qԅq}q(hUh hubaubcsphinx.addnodes desc_addname q)q}q(hXcircuits.net.protocols.http.qh hh!hh&U desc_addnameqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]qhhXcircuits.net.protocols.http.qㅁq}q(hUh hubaubcsphinx.addnodes desc_name q)q}q(hhh hh!hh&U desc_nameqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]qhhXRequestqq}q(hUh hubaubcsphinx.addnodes desc_parameterlist q)q}q(hUh hh!hh&Udesc_parameterlistqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]q(csphinx.addnodes desc_parameter q)r}r(hX*argsrh(}r(h*]rh,]rh.]rh0]rh3]ruh hh]r hhX*argsr r }r (hUh jubah&Udesc_parameterr ubh)r}r(hX**kwargsrh(}r(h*]rh,]rh.]rh0]rh3]ruh hh]rhhX**kwargsrr}r(hUh jubah&j ubeubeubcsphinx.addnodes desc_content r)r}r(hUh hh!hh&U desc_contentrh(}r(h*]r h,]r!h.]r"h0]r#h3]r$uh5Nh6hh]r%(cdocutils.nodes paragraph r&)r'}r((hX*Bases: :class:`circuits.core.events.Event`r)h jh!U r*h&U paragraphr+h(}r,(h*]r-h,]r.h.]r/h0]r0h3]r1uh5Kh6hh]r2(hhXBases: r3r4}r5(hXBases: r6h j'ubhD)r7}r8(hX#:class:`circuits.core.events.Event`r9h j'h!h$h&hHh(}r:(Ureftyper;Xclassr<hLhMXcircuits.core.events.Eventr=U refdomainr>Xpyr?h0]r@h.]rAU refexplicitrBh*]rCh,]rDh3]rEhWhXhYhhZXcircuits.net.protocols.httprFuh5Kh]rGh\)rH}rI(hj9h(}rJ(h*]rKh,]rL(hbj?Xpy-classrMeh.]rNh0]rOh3]rPuh j7h]rQhhXcircuits.core.events.EventrRrS}rT(hUh jHubah&hlubaubeubj&)rU}rV(hX Request EventrWh jh!Xl/home/prologic/work/circuits/circuits/net/protocols/http.py:docstring of circuits.net.protocols.http.RequestrXh&j+h(}rY(h*]rZh,]r[h.]r\h0]r]h3]r^uh5Kh6hh]r_hhX Request Eventr`ra}rb(hjWh jUubaubj&)rc}rd(hXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.reh jh!jXh&j+h(}rf(h*]rgh,]rhh.]rih0]rjh3]rkuh5Kh6hh]rlhhXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rmrn}ro(hjeh jcubaubj&)rp}rq(hXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rrh jh!jXh&j+h(}rs(h*]rth,]ruh.]rvh0]rwh3]rxuh5Kh6hh]ryhhXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rzr{}r|(hjrh jpubaubj&)r}}r~(hXEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh jh!jXh&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5K h6hh]r(hhXEvery event has a rr}r(hXEvery event has a rh j}ubhD)r}r(hX :attr:`name`rh j}h!h$h&hHh(}r(UreftyperXattrrhLhMXnamerU refdomainrXpyrh0]rh.]rU refexplicitrh*]rh,]rh3]rhWhXhYhhZjFuh5Kh]rh\)r}r(hjh(}r(h*]rh,]r(hbjXpy-attrreh.]rh0]rh3]ruh jh]rhhXnamerr}r(hUh jubah&hlubaubhhX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(hX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh j}ubeubcdocutils.nodes field_list r)r}r(hUh jh!Nh&U field_listrh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rcdocutils.nodes field r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(cdocutils.nodes field_name r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX Variablesrr}r(hUh jubah&U field_namerubcdocutils.nodes field_body r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rcdocutils.nodes bullet_list r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(cdocutils.nodes list_item r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperUobjrU reftargetrXchannelsrU refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rcdocutils.nodes strong r)r}r(hjh(}r(h*]r h,]r h.]r h0]r h3]r uh jh]rhhXchannelsrr}r(hUh jubah&Ustrongrubah&hHubhhX -- rr}r(hUh jubj&)r}r(hXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rh jh!jXh&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh]rhhXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r r!}r"(hjh jubaubj&)r#}r$(hXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r%h jh!jXh&j+h(}r&(h*]r'h,]r(h.]r)h0]r*h3]r+uh5Kh]r,hhXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r-r.}r/(hj%h j#ubaubeh&j+ubah&U list_itemr0ubj)r1}r2(hUh(}r3(h*]r4h,]r5h.]r6h0]r7h3]r8uh jh]r9j&)r:}r;(hUh(}r<(h*]r=h,]r>h.]r?h0]r@h3]rAuh j1h]rB(hD)rC}rD(hUh(}rE(UreftyperFjU reftargetrGXvaluerHU refdomainrIhh0]rJh.]rKU refexplicitrLh*]rMh,]rNh3]rOuh j:h]rPj)rQ}rR(hjHh(}rS(h*]rTh,]rUh.]rVh0]rWh3]rXuh jCh]rYhhXvaluerZr[}r\(hUh jQubah&jubah&hHubhhX -- r]r^}r_(hUh j:ubhhX this is a r`ra}rb(hX this is a rch j:ubhD)rd}re(hX#:class:`circuits.core.values.Value`rfh j:h!Nh&hHh(}rg(UreftyperhXclassrihLhMXcircuits.core.values.ValuerjU refdomainrkXpyrlh0]rmh.]rnU refexplicitroh*]rph,]rqh3]rrhWhXhYhhZjFuh5Nh]rsh\)rt}ru(hjfh(}rv(h*]rwh,]rx(hbjlXpy-classryeh.]rzh0]r{h3]r|uh jdh]r}hhXcircuits.core.values.Valuer~r}r(hUh jtubah&hlubaubhhXN object that holds the results returned by the handlers invoked for the event.rr}r(hXN object that holds the results returned by the handlers invoked for the event.rh j:ubeh&j+ubah&j0ubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXsuccessrU refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXsuccessrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhX%if this optional attribute is set to rr}r(hX%if this optional attribute is set to rh jubh\)r}r(hX``True``rh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXTruerr}r(hUh jubah&hlubhhX, an associated event rr}r(hX, an associated event rh jubh\)r}r(hX``EventSuccess``rh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX EventSuccessrr}r(hUh jubah&hlubhhX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(hX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh jubeh&j+ubah&j0ubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXsuccess_channelsrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r r }r (hXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r h jubeh&j+ubah&j0ubj)r }r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh j h]r(hD)r}r (hUh(}r!(Ureftyper"jU reftargetr#Xcompleter$U refdomainr%hh0]r&h.]r'U refexplicitr(h*]r)h,]r*h3]r+uh jh]r,j)r-}r.(hj$h(}r/(h*]r0h,]r1h.]r2h0]r3h3]r4uh jh]r5hhXcompleter6r7}r8(hUh j-ubah&jubah&hHubhhX -- r9r:}r;(hUh jubhhX%if this optional attribute is set to r<r=}r>(hX%if this optional attribute is set to r?h jubh\)r@}rA(hX``True``rBh(}rC(h*]rDh,]rEh.]rFh0]rGh3]rHuh jh]rIhhXTruerJrK}rL(hUh j@ubah&hlubhhX, an associated event rMrN}rO(hX, an associated event rPh jubh\)rQ}rR(hX``EventComplete``rSh(}rT(h*]rUh,]rVh.]rWh0]rXh3]rYuh jh]rZhhX EventCompleter[r\}r](hUh jQubah&hlubhhX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r^r_}r`(hX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rah jubeh&j+ubah&j0ubj)rb}rc(hUh(}rd(h*]reh,]rfh.]rgh0]rhh3]riuh jh]rjj&)rk}rl(hUh(}rm(h*]rnh,]roh.]rph0]rqh3]rruh jbh]rs(hD)rt}ru(hUh(}rv(UreftyperwjU reftargetrxXsuccess_channelsryU refdomainrzhh0]r{h.]r|U refexplicitr}h*]r~h,]rh3]ruh jkh]rj)r}r(hjyh(}r(h*]rh,]rh.]rh0]rh3]ruh jth]rhhXsuccess_channelsrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jkubhhXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(hXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh jkubeh&j+ubah&j0ubeh&U bullet_listrubah&U field_bodyrubeh&Ufieldrubaubeubeubhq)r}r(hUh hh!Nh&hth(}r(h0]rh.]rh*]rh,]rh3]rUentriesr]r(h}X/Response (class in circuits.net.protocols.http)hUtrauh5Nh6hh]rubh)r}r(hUh hh!Nh&hh(}r(hhXpyrh0]rh.]rh*]rh,]rh3]rhXclassrhjuh5Nh6hh]r(h)r}r(hXResponse(*args, **kwargs)rh jh!hh&hh(}r(h0]rhahh"Xcircuits.net.protocols.httprr}rbh.]rh*]rh,]rh3]rhahXResponserhUhƉuh5Nh6hh]r(h)r}r(hXclass rh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rhhXclass rr}r(hUh jubaubh)r}r(hXcircuits.net.protocols.http.rh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rhhXcircuits.net.protocols.http.rr}r(hUh jubaubh)r}r(hjh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rhhXResponserr}r(hUh jubaubh)r}r(hUh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]r(h)r}r(hX*argsrh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX*argsrr}r(hUh jubah&j ubh)r}r(hX**kwargsrh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX**kwargsrr}r(hUh jubah&j ubeubeubj)r}r(hUh jh!hh&jh(}r(h*]r h,]r h.]r h0]r h3]r uh5Nh6hh]r(j&)r}r(hX*Bases: :class:`circuits.core.events.Event`rh jh!j*h&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]r(hhXBases: rr}r(hXBases: rh jubhD)r}r(hX#:class:`circuits.core.events.Event`rh jh!h$h&hHh(}r (Ureftyper!Xclassr"hLhMXcircuits.core.events.Eventr#U refdomainr$Xpyr%h0]r&h.]r'U refexplicitr(h*]r)h,]r*h3]r+hWhXhYjhZjFuh5Kh]r,h\)r-}r.(hjh(}r/(h*]r0h,]r1(hbj%Xpy-classr2eh.]r3h0]r4h3]r5uh jh]r6hhXcircuits.core.events.Eventr7r8}r9(hUh j-ubah&hlubaubeubj&)r:}r;(hXResponse Eventr<h jh!Xm/home/prologic/work/circuits/circuits/net/protocols/http.py:docstring of circuits.net.protocols.http.Responser=h&j+h(}r>(h*]r?h,]r@h.]rAh0]rBh3]rCuh5Kh6hh]rDhhXResponse EventrErF}rG(hj<h j:ubaubj&)rH}rI(hXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rJh jh!j=h&j+h(}rK(h*]rLh,]rMh.]rNh0]rOh3]rPuh5Kh6hh]rQhhXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rRrS}rT(hjJh jHubaubj&)rU}rV(hXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rWh jh!j=h&j+h(}rX(h*]rYh,]rZh.]r[h0]r\h3]r]uh5Kh6hh]r^hhXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.r_r`}ra(hjWh jUubaubj&)rb}rc(hXEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rdh jh!j=h&j+h(}re(h*]rfh,]rgh.]rhh0]rih3]rjuh5K h6hh]rk(hhXEvery event has a rlrm}rn(hXEvery event has a roh jbubhD)rp}rq(hX :attr:`name`rrh jbh!h$h&hHh(}rs(UreftypertXattrruhLhMXnamervU refdomainrwXpyrxh0]ryh.]rzU refexplicitr{h*]r|h,]r}h3]r~hWhXhYjhZjFuh5Kh]rh\)r}r(hjrh(}r(h*]rh,]r(hbjxXpy-attrreh.]rh0]rh3]ruh jph]rhhXnamerr}r(hUh jubah&hlubaubhhX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(hX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh jbubeubj)r}r(hUh jh!Nh&jh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(j)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX Variablesrr}r(hUh jubah&jubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(j)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXchannelsrU refdomainrjh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXchannelsrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubj&)r}r(hXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rh jh!j=h&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh]rhhXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rr}r(hjh jubaubj&)r}r(hXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rh jh!j=h&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh]rhhXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rr}r (hjh jubaubeh&j+ubah&j0ubj)r }r (hUh(}r (h*]r h,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh j h]r(hD)r}r(hUh(}r(UreftyperjU reftargetr Xvaluer!U refdomainr"jh0]r#h.]r$U refexplicitr%h*]r&h,]r'h3]r(uh jh]r)j)r*}r+(hj!h(}r,(h*]r-h,]r.h.]r/h0]r0h3]r1uh jh]r2hhXvaluer3r4}r5(hUh j*ubah&jubah&hHubhhX -- r6r7}r8(hUh jubhhX this is a r9r:}r;(hX this is a r<h jubhD)r=}r>(hX#:class:`circuits.core.values.Value`r?h jh!Nh&hHh(}r@(UreftyperAXclassrBhLhMXcircuits.core.values.ValuerCU refdomainrDXpyrEh0]rFh.]rGU refexplicitrHh*]rIh,]rJh3]rKhWhXhYjhZjFuh5Nh]rLh\)rM}rN(hj?h(}rO(h*]rPh,]rQ(hbjEXpy-classrReh.]rSh0]rTh3]rUuh j=h]rVhhXcircuits.core.values.ValuerWrX}rY(hUh jMubah&hlubaubhhXN object that holds the results returned by the handlers invoked for the event.rZr[}r\(hXN object that holds the results returned by the handlers invoked for the event.r]h jubeh&j+ubah&j0ubj)r^}r_(hUh(}r`(h*]rah,]rbh.]rch0]rdh3]reuh jh]rfj&)rg}rh(hUh(}ri(h*]rjh,]rkh.]rlh0]rmh3]rnuh j^h]ro(hD)rp}rq(hUh(}rr(UreftypersjU reftargetrtXsuccessruU refdomainrvjh0]rwh.]rxU refexplicitryh*]rzh,]r{h3]r|uh jgh]r}j)r~}r(hjuh(}r(h*]rh,]rh.]rh0]rh3]ruh jph]rhhXsuccessrr}r(hUh j~ubah&jubah&hHubhhX -- rr}r(hUh jgubhhX%if this optional attribute is set to rr}r(hX%if this optional attribute is set to rh jgubh\)r}r(hX``True``rh(}r(h*]rh,]rh.]rh0]rh3]ruh jgh]rhhXTruerr}r(hUh jubah&hlubhhX, an associated event rr}r(hX, an associated event rh jgubh\)r}r(hX``EventSuccess``rh(}r(h*]rh,]rh.]rh0]rh3]ruh jgh]rhhX EventSuccessrr}r(hUh jubah&hlubhhX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(hX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh jgubeh&j+ubah&j0ubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrjh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXsuccess_channelsrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(hXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh jubeh&j+ubah&j0ubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXcompleterU refdomainrjh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]r h,]r h.]r h0]r h3]r uh jh]rhhXcompleterr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhX%if this optional attribute is set to rr}r(hX%if this optional attribute is set to rh jubh\)r}r(hX``True``rh(}r(h*]rh,]rh.]rh0]r h3]r!uh jh]r"hhXTruer#r$}r%(hUh jubah&hlubhhX, an associated event r&r'}r((hX, an associated event r)h jubh\)r*}r+(hX``EventComplete``r,h(}r-(h*]r.h,]r/h.]r0h0]r1h3]r2uh jh]r3hhX EventCompleter4r5}r6(hUh j*ubah&hlubhhX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r7r8}r9(hX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r:h jubeh&j+ubah&j0ubj)r;}r<(hUh(}r=(h*]r>h,]r?h.]r@h0]rAh3]rBuh jh]rCj&)rD}rE(hUh(}rF(h*]rGh,]rHh.]rIh0]rJh3]rKuh j;h]rL(hD)rM}rN(hUh(}rO(UreftyperPjU reftargetrQXsuccess_channelsrRU refdomainrSjh0]rTh.]rUU refexplicitrVh*]rWh,]rXh3]rYuh jDh]rZj)r[}r\(hjRh(}r](h*]r^h,]r_h.]r`h0]rah3]rbuh jMh]rchhXsuccess_channelsrdre}rf(hUh j[ubah&jubah&hHubhhX -- rgrh}ri(hUh jDubhhXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rjrk}rl(hXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rmh jDubeh&j+ubah&j0ubeh&jubah&jubeh&jubaubeubeubeubh)rn}ro(hUh hh!h$h&h'h(}rp(h*]rqh,]rrh.]rsh0]rthah3]ruh auh5Kh6hh]rv(h8)rw}rx(hX Componentsryh jnh!h$h&hUrefnamesr?}r@Usymbol_footnotesrA]rBUautofootnote_refsrC]rDUsymbol_footnote_refsrE]rFU citationsrG]rHh6hU current_linerINUtransform_messagesrJ]rKUreporterrLNUid_startrMKU autofootnotesrN]rOU citation_refsrP}rQUindirect_targetsrR]rSUsettingsrT(cdocutils.frontend Values rUorV}rW(Ufootnote_backlinksrXKUrecord_dependenciesrYNU rfc_base_urlrZUhttp://tools.ietf.org/html/r[U tracebackr\Upep_referencesr]NUstrip_commentsr^NU toc_backlinksr_Uentryr`U language_coderaUenrbU datestamprcNU report_levelrdKU _destinationreNU halt_levelrfKU strip_classesrgNh(h+]q?h-]q@h/]qAh1]qBh4]qCuh6Kh7hh]qD(csphinx.addnodes pending_xref qE)qF}qG(h X:mod:`circuits.web.controllers`qHh!h:h"h%h'U pending_xrefqIh)}qJ(UreftypeqKXmodqLUrefwarnqMU reftargetqNXcircuits.web.controllersqOU refdomainqPXpyqQh1]qRh/]qSU refexplicitqTh+]qUh-]qVh4]qWUrefdocqXUapi/circuits_web_controllersqYUpy:classqZNU py:moduleq[Nuh6Kh]q\cdocutils.nodes literal q])q^}q_(h hHh)}q`(h+]qah-]qb(UxrefqchQXpy-modqdeh/]qeh1]qfh4]qguh!hFh]qhcdocutils.nodes Text qiXcircuits.web.controllersqjqk}ql(h Uh!h^ubah'UliteralqmubaubhiX -- Controllersqnqo}qp(h X -- Controllersqqh!h:ubeubcsphinx.addnodes index qr)qs}qt(h Uh!hh"U quh'Uindexqvh)}qw(h1]qxh/]qyh+]qzh-]q{h4]q|Uentriesq}]q~(UsingleqX!circuits.web.controllers (module)Xmodule-circuits.web.controllersUtqauh6Kh7hh]qubcdocutils.nodes paragraph q)q}q(h X Controllersqh!hh"X^/home/prologic/work/circuits/circuits/web/controllers.py:docstring of circuits.web.controllersqh'U paragraphqh)}q(h+]qh-]qh/]qh1]qh4]quh6Kh7hh]qhiX Controllersqq}q(h hh!hubaubh)q}q(h XThis module implements ...qh!hh"hh'hh)}q(h+]qh-]qh/]qh1]qh4]quh6Kh7hh]qhiXThis module implements ...qq}q(h hh!hubaubh)q}q(h Uh!hh"h%h'h(h)}q(h+]qh-]qh/]qh1]qhah4]qh auh6Kh7hh]q(h9)q}q(h XEventsqh!hh"h%h'h=h)}q(h+]qh-]qh/]qh1]qh4]quh6Kh7hh]qhiXEventsqq}q(h hh!hubaubh)q}q(h X**none**qh!hh"h%h'hh)}q(h+]qh-]qh/]qh1]qh4]quh6K h7hh]qcdocutils.nodes strong q)q}q(h hh)}q(h+]qh-]qh/]qh1]qh4]quh!hh]qhiXnoneqɅq}q(h Uh!hubah'Ustrongqubaubeubh)q}q(h Uh!hh"h%h'h(h)}q(h+]qh-]qh/]qh1]qhah4]qhauh6Kh7hh]q(h9)q}q(h X Componentsqh!hh"h%h'h=h)}q(h+]qh-]qh/]qh1]qh4]quh6Kh7hh]qhiX Componentsqq}q(h hh!hubaubhr)q}q(h Uh!hh"Xi/home/prologic/work/circuits/circuits/web/controllers.py:docstring of circuits.web.controllers.Controllerqh'hvh)}q(h1]qh/]qh+]qh-]qh4]qUentriesq]q(hX.Controller (class in circuits.web.controllers)h Utqauh6Nh7hh]qubcsphinx.addnodes desc q)q}q(h Uh!hh"hh'Udescqh)}q(UnoindexqUdomainqXpyqh1]qh/]qh+]qh-]qh4]qUobjtypeqXclassqUdesctypeqhuh6Nh7hh]r(csphinx.addnodes desc_signature r)r}r(h XController(*args, **kwargs)rh!hh"U rh'Udesc_signaturerh)}r(h1]rh aUmoduler h#Xcircuits.web.controllersr r }r bh/]r h+]rh-]rh4]rh aUfullnamerX ControllerrUclassrUUfirstruh6Nh7hh]r(csphinx.addnodes desc_annotation r)r}r(h Xclass rh!jh"jh'Udesc_annotationrh)}r(h+]rh-]rh/]rh1]rh4]r uh6Nh7hh]r!hiXclass r"r#}r$(h Uh!jubaubcsphinx.addnodes desc_addname r%)r&}r'(h Xcircuits.web.controllers.r(h!jh"jh'U desc_addnamer)h)}r*(h+]r+h-]r,h/]r-h1]r.h4]r/uh6Nh7hh]r0hiXcircuits.web.controllers.r1r2}r3(h Uh!j&ubaubcsphinx.addnodes desc_name r4)r5}r6(h jh!jh"jh'U desc_namer7h)}r8(h+]r9h-]r:h/]r;h1]r<h4]r=uh6Nh7hh]r>hiX Controllerr?r@}rA(h Uh!j5ubaubcsphinx.addnodes desc_parameterlist rB)rC}rD(h Uh!jh"jh'Udesc_parameterlistrEh)}rF(h+]rGh-]rHh/]rIh1]rJh4]rKuh6Nh7hh]rL(csphinx.addnodes desc_parameter rM)rN}rO(h X*argsrPh)}rQ(h+]rRh-]rSh/]rTh1]rUh4]rVuh!jCh]rWhiX*argsrXrY}rZ(h Uh!jNubah'Udesc_parameterr[ubjM)r\}r](h X**kwargsr^h)}r_(h+]r`h-]rah/]rbh1]rch4]rduh!jCh]rehiX**kwargsrfrg}rh(h Uh!j\ubah'j[ubeubeubcsphinx.addnodes desc_content ri)rj}rk(h Uh!hh"jh'U desc_contentrlh)}rm(h+]rnh-]roh/]rph1]rqh4]rruh6Nh7hh]rs(h)rt}ru(h X7Bases: :class:`circuits.web.controllers.BaseController`rvh!jjh"U rwh'hh)}rx(h+]ryh-]rzh/]r{h1]r|h4]r}uh6Kh7hh]r~(hiXBases: rr}r(h XBases: rh!jtubhE)r}r(h X0:class:`circuits.web.controllers.BaseController`rh!jth"h%h'hIh)}r(UreftyperXclassrhMhNX'circuits.web.controllers.BaseControllerrU refdomainrXpyrh1]rh/]rU refexplicitrh+]rh-]rh4]rhXhYhZjh[Xcircuits.web.controllersruh6Kh]rh])r}r(h jh)}r(h+]rh-]r(hcjXpy-classreh/]rh1]rh4]ruh!jh]rhiX'circuits.web.controllers.BaseControllerrr}r(h Uh!jubah'hmubaubeubh)r}r(h X4initializes x; see x.__class__.__doc__ for signaturerh!jjh"hh'hh)}r(h+]rh-]rh/]rh1]rh4]ruh6Kh7hh]rhiX4initializes x; see x.__class__.__doc__ for signaturerr}r(h jh!jubaubeubeubhr)r}r(h Uh!hh"Xm/home/prologic/work/circuits/circuits/web/controllers.py:docstring of circuits.web.controllers.JSONControllerrh'hvh)}r(h1]rh/]rh+]rh-]rh4]rUentriesr]r(hX2JSONController (class in circuits.web.controllers)hUtrauh6Nh7hh]rubh)r}r(h Uh!hh"jh'hh)}r(hhXpyrh1]rh/]rh+]rh-]rh4]rhXclassrhjuh6Nh7hh]r(j)r}r(h XJSONController(*args, **kwargs)rh!jh"jh'jh)}r(h1]rhaj h#Xcircuits.web.controllersrr}rbh/]rh+]rh-]rh4]rhajXJSONControllerrjUjuh6Nh7hh]r(j)r}r(h Xclass rh!jh"jh'jh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiXclass rr}r(h Uh!jubaubj%)r}r(h Xcircuits.web.controllers.rh!jh"jh'j)h)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiXcircuits.web.controllers.rr}r(h Uh!jubaubj4)r}r(h jh!jh"jh'j7h)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiXJSONControllerrr}r(h Uh!jubaubjB)r}r(h Uh!jh"jh'jEh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]r(jM)r}r(h X*argsrh)}r(h+]rh-]rh/]r h1]r h4]r uh!jh]r hiX*argsr r}r(h Uh!jubah'j[ubjM)r}r(h X**kwargsrh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiX**kwargsrr}r(h Uh!jubah'j[ubeubeubji)r}r(h Uh!jh"jh'jlh)}r(h+]r h-]r!h/]r"h1]r#h4]r$uh6Nh7hh]r%(h)r&}r'(h X7Bases: :class:`circuits.web.controllers.BaseController`r(h!jh"jwh'hh)}r)(h+]r*h-]r+h/]r,h1]r-h4]r.uh6Kh7hh]r/(hiXBases: r0r1}r2(h XBases: r3h!j&ubhE)r4}r5(h X0:class:`circuits.web.controllers.BaseController`r6h!j&h"h%h'hIh)}r7(Ureftyper8Xclassr9hMhNX'circuits.web.controllers.BaseControllerr:U refdomainr;Xpyr<h1]r=h/]r>U refexplicitr?h+]r@h-]rAh4]rBhXhYhZjh[juh6Kh]rCh])rD}rE(h j6h)}rF(h+]rGh-]rH(hcj<Xpy-classrIeh/]rJh1]rKh4]rLuh!j4h]rMhiX'circuits.web.controllers.BaseControllerrNrO}rP(h Uh!jDubah'hmubaubeubh)rQ}rR(h X4initializes x; see x.__class__.__doc__ for signaturerSh!jh"jh'hh)}rT(h+]rUh-]rVh/]rWh1]rXh4]rYuh6Kh7hh]rZhiX4initializes x; see x.__class__.__doc__ for signaturer[r\}r](h jSh!jQubaubeubeubeubh)r^}r_(h Uh!hh"h%h'h(h)}r`(h+]rah-]rbh/]rch1]rdhah4]rehauh6Kh7hh]rf(h9)rg}rh(h X Functionsrih!j^h"h%h'h=h)}rj(h+]rkh-]rlh/]rmh1]rnh4]rouh6Kh7hh]rphiX Functionsrqrr}rs(h jih!jgubaubhr)rt}ru(h Uh!j^h"Nh'hvh)}rv(h1]rwh/]rxh+]ryh-]rzh4]r{Uentriesr|]r}(hX-expose() (in module circuits.web.controllers)h Utr~auh6Nh7hh]rubh)r}r(h Uh!j^h"Nh'hh)}r(hhXpyrh1]rh/]rh+]rh-]rh4]rhXfunctionrhjuh6Nh7hh]r(j)r}r(h Xexpose(*channels, **config)rh!jh"jh'jh)}r(h1]rh aj h#Xcircuits.web.controllersrr}rbh/]rh+]rh-]rh4]rh ajXexposerjUjuh6Nh7hh]r(j%)r}r(h Xcircuits.web.controllers.rh!jh"jh'j)h)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiXcircuits.web.controllers.rr}r(h Uh!jubaubj4)r}r(h jh!jh"jh'j7h)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiXexposerr}r(h Uh!jubaubjB)r}r(h Uh!jh"jh'jEh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]r(jM)r}r(h X *channelsrh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiX *channelsrr}r(h Uh!jubah'j[ubjM)r}r(h X**configrh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiX**configrr}r(h Uh!jubah'j[ubeubeubji)r}r(h Uh!jh"jh'jlh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rubeubhr)r}r(h Uh!j^h"Nh'hvh)}r(h1]rh/]rh+]rh-]rh4]rUentriesr]r(hX1exposeJSON() (in module circuits.web.controllers)h Utrauh6Nh7hh]rubh)r}r(h Uh!j^h"Nh'hh)}r(hhXpyrh1]rh/]rh+]rh-]rh4]rhXfunctionrhjuh6Nh7hh]r(j)r}r(h XexposeJSON(*channels, **config)rh!jh"jh'jh)}r(h1]rh aj h#Xcircuits.web.controllersrr}rbh/]rh+]rh-]rh4]rh ajX exposeJSONrjUjuh6Nh7hh]r(j%)r}r(h Xcircuits.web.controllers.rh!jh"jh'j)h)}r(h+]rh-]rh/]r h1]r h4]r uh6Nh7hh]r hiXcircuits.web.controllers.r r}r(h Uh!jubaubj4)r}r(h jh!jh"jh'j7h)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiX exposeJSONrr}r(h Uh!jubaubjB)r}r(h Uh!jh"jh'jEh)}r(h+]rh-]r h/]r!h1]r"h4]r#uh6Nh7hh]r$(jM)r%}r&(h X *channelsr'h)}r((h+]r)h-]r*h/]r+h1]r,h4]r-uh!jh]r.hiX *channelsr/r0}r1(h Uh!j%ubah'j[ubjM)r2}r3(h X**configr4h)}r5(h+]r6h-]r7h/]r8h1]r9h4]r:uh!jh]r;hiX**configr<r=}r>(h Uh!j2ubah'j[ubeubeubji)r?}r@(h Uh!jh"jh'jlh)}rA(h+]rBh-]rCh/]rDh1]rEh4]rFuh6Nh7hh]rGubeubeubeubah UU transformerrHNU footnote_refsrI}rJUrefnamesrK}rLUsymbol_footnotesrM]rNUautofootnote_refsrO]rPUsymbol_footnote_refsrQ]rRU citationsrS]rTh7hU current_linerUNUtransform_messagesrV]rWUreporterrXNUid_startrYKU autofootnotesrZ]r[U citation_refsr\}r]Uindirect_targetsr^]r_Usettingsr`(cdocutils.frontend Values raorb}rc(Ufootnote_backlinksrdKUrecord_dependenciesreNU rfc_base_urlrfUhttp://tools.ietf.org/html/rgU tracebackrhUpep_referencesriNUstrip_commentsrjNU toc_backlinksrkUentryrlU language_codermUenrnU datestamproNU report_levelrpKU _destinationrqNU halt_levelrrKU strip_classesrsNh=NUerror_encoding_error_handlerrtUbackslashreplaceruUdebugrvNUembed_stylesheetrwUoutput_encoding_error_handlerrxUstrictryU sectnum_xformrzKUdump_transformsr{NU docinfo_xformr|KUwarning_streamr}NUpep_file_url_templater~Upep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUI/home/prologic/work/circuits/docs/source/api/circuits_web_controllers.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjyUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hjhj^hhh3cdocutils.nodes target r)r}r(h Uh!hh"huh'Utargetrh)}r(h+]rh1]rh3ah/]rUismodrh-]rh4]ruh6Kh7hh]rubh jh jhhhhh juUsubstitution_namesr}rh'h7h)}r(h+]rh1]rh/]rUsourcerh%h-]rh4]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_dispatchers_jsonrpc.doctree0000644000014400001440000005354112113366663027677 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNX,circuits.web.dispatchers.jsonrpc -- json-rpcqNX(circuits.web.dispatchers.jsonrpc.JSONRPCqX componentsq NX$circuits.web.dispatchers.jsonrpc.RPCq Xeventsq NuUsubstitution_defsq }q Uparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhU)circuits-web-dispatchers-jsonrpc-json-rpcqhhh U componentsqh h h UeventsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceq cdocutils.nodes reprunicode q!XQ/home/prologic/work/circuits/docs/source/api/circuits_web_dispatchers_jsonrpc.rstq"q#}q$bUtagnameq%Usectionq&U attributesq'}q((Udupnamesq)]q*Uclassesq+]q,Ubackrefsq-]q.Uidsq/]q0(X'module-circuits.web.dispatchers.jsonrpcq1heUnamesq2]q3hauUlineq4KUdocumentq5hh]q6(cdocutils.nodes title q7)q8}q9(hX3:mod:`circuits.web.dispatchers.jsonrpc` -- JSON-RPCq:hhh h#h%Utitleq;h'}q<(h)]q=h+]q>h-]q?h/]q@h2]qAuh4Kh5hh]qB(csphinx.addnodes pending_xref qC)qD}qE(hX':mod:`circuits.web.dispatchers.jsonrpc`qFhh8h h#h%U pending_xrefqGh'}qH(UreftypeqIXmodqJUrefwarnqKU reftargetqLX circuits.web.dispatchers.jsonrpcqMU refdomainqNXpyqOh/]qPh-]qQU refexplicitqRh)]qSh+]qTh2]qUUrefdocqVU$api/circuits_web_dispatchers_jsonrpcqWUpy:classqXNU py:moduleqYNuh4Kh]qZcdocutils.nodes literal q[)q\}q](hhFh'}q^(h)]q_h+]q`(UxrefqahOXpy-modqbeh-]qch/]qdh2]qeuhhDh]qfcdocutils.nodes Text qgX circuits.web.dispatchers.jsonrpcqhqi}qj(hUhh\ubah%UliteralqkubaubhgX -- JSON-RPCqlqm}qn(hX -- JSON-RPCqohh8ubeubcsphinx.addnodes index qp)qq}qr(hUhhh U qsh%Uindexqth'}qu(h/]qvh-]qwh)]qxh+]qyh2]qzUentriesq{]q|(Usingleq}X)circuits.web.dispatchers.jsonrpc (module)X'module-circuits.web.dispatchers.jsonrpcUtq~auh4Kh5hh]qubcdocutils.nodes paragraph q)q}q(hXJSON RPCqhhh Xn/home/prologic/work/circuits/circuits/web/dispatchers/jsonrpc.py:docstring of circuits.web.dispatchers.jsonrpcqh%U paragraphqh'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgXJSON RPCqq}q(hhhhubaubh)q}q(hXjThis module implements a JSON RPC dispatcher that translates incoming RPC calls over JSON into RPC events.qhhh hh%hh'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgXjThis module implements a JSON RPC dispatcher that translates incoming RPC calls over JSON into RPC events.qq}q(hhhhubaubh)q}q(hUhhh h#h%h&h'}q(h)]qh+]qh-]qh/]qhah2]qh auh4Kh5hh]q(h7)q}q(hXEventsqhhh h#h%h;h'}q(h)]qh+]qh-]qh/]qh2]quh4Kh5hh]qhgXEventsqq}q(hhhhubaubhp)q}q(hUhhh Nh%hth'}q(h/]qh-]qh)]qh+]qh2]qUentriesq]q(h}X/RPC (class in circuits.web.dispatchers.jsonrpc)h Utqauh4Nh5hh]qubcsphinx.addnodes desc q)q}q(hUhhh Nh%Udescqh'}q(UnoindexqĉUdomainqXpyqh/]qh-]qh)]qh+]qh2]qUobjtypeqXclassqUdesctypeqhuh4Nh5hh]q(csphinx.addnodes desc_signature q)q}q(hXRPC(*args, **kwargs)qhhh U qh%Udesc_signatureqh'}q(h/]qh aUmoduleqh!X circuits.web.dispatchers.jsonrpcqمq}qbh-]qh)]qh+]qh2]qh aUfullnameqXRPCqUclassqUUfirstquh4Nh5hh]q(csphinx.addnodes desc_annotation q)q}q(hXclass qhhh hh%Udesc_annotationqh'}q(h)]qh+]qh-]qh/]qh2]quh4Nh5hh]qhgXclass qq}q(hUhhubaubcsphinx.addnodes desc_addname q)q}q(hX!circuits.web.dispatchers.jsonrpc.qhhh hh%U desc_addnameqh'}q(h)]qh+]qh-]qh/]qh2]quh4Nh5hh]qhgX!circuits.web.dispatchers.jsonrpc.rr}r(hUhhubaubcsphinx.addnodes desc_name r)r}r(hhhhh hh%U desc_namerh'}r(h)]rh+]r h-]r h/]r h2]r uh4Nh5hh]r hgXRPCrr}r(hUhjubaubcsphinx.addnodes desc_parameterlist r)r}r(hUhhh hh%Udesc_parameterlistrh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]r(csphinx.addnodes desc_parameter r)r}r(hX*argsrh'}r (h)]r!h+]r"h-]r#h/]r$h2]r%uhjh]r&hgX*argsr'r(}r)(hUhjubah%Udesc_parameterr*ubj)r+}r,(hX**kwargsr-h'}r.(h)]r/h+]r0h-]r1h/]r2h2]r3uhjh]r4hgX**kwargsr5r6}r7(hUhj+ubah%j*ubeubeubcsphinx.addnodes desc_content r8)r9}r:(hUhhh hh%U desc_contentr;h'}r<(h)]r=h+]r>h-]r?h/]r@h2]rAuh4Nh5hh]rB(h)rC}rD(hX*Bases: :class:`circuits.core.events.Event`rEhj9h U rFh%hh'}rG(h)]rHh+]rIh-]rJh/]rKh2]rLuh4Kh5hh]rM(hgXBases: rNrO}rP(hXBases: rQhjCubhC)rR}rS(hX#:class:`circuits.core.events.Event`rThjCh h#h%hGh'}rU(UreftyperVXclassrWhKhLXcircuits.core.events.EventrXU refdomainrYXpyrZh/]r[h-]r\U refexplicitr]h)]r^h+]r_h2]r`hVhWhXhhYX circuits.web.dispatchers.jsonrpcrauh4Kh]rbh[)rc}rd(hjTh'}re(h)]rfh+]rg(hajZXpy-classrheh-]rih/]rjh2]rkuhjRh]rlhgXcircuits.core.events.Eventrmrn}ro(hUhjcubah%hkubaubeubh)rp}rq(hX RPC Eventrrhj9h Xr/home/prologic/work/circuits/circuits/web/dispatchers/jsonrpc.py:docstring of circuits.web.dispatchers.jsonrpc.RPCrsh%hh'}rt(h)]ruh+]rvh-]rwh/]rxh2]ryuh4Kh5hh]rzhgX RPC Eventr{r|}r}(hjrhjpubaubh)r~}r(hXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rhj9h jsh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rr}r(hjhj~ubaubh)r}r(hXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rhj9h jsh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rr}r(hjhjubaubh)r}r(hXEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rhj9h jsh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4K h5hh]r(hgXEvery event has a rr}r(hXEvery event has a rhjubhC)r}r(hX :attr:`name`rhjh h#h%hGh'}r(UreftyperXattrrhKhLXnamerU refdomainrXpyrh/]rh-]rU refexplicitrh)]rh+]rh2]rhVhWhXhhYjauh4Kh]rh[)r}r(hjh'}r(h)]rh+]r(hajXpy-attrreh-]rh/]rh2]ruhjh]rhgXnamerr}r(hUhjubah%hkubaubhgX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(hX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rhjubeubcdocutils.nodes field_list r)r}r(hUhj9h Nh%U field_listrh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rcdocutils.nodes field r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(cdocutils.nodes field_name r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgX Variablesrr}r(hUhjubah%U field_namerubcdocutils.nodes field_body r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rcdocutils.nodes bullet_list r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(cdocutils.nodes list_item r)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rh)r}r (hUh'}r (h)]r h+]r h-]r h/]rh2]ruhjh]r(hC)r}r(hUh'}r(UreftyperUobjrU reftargetrXchannelsrU refdomainrhh/]rh-]rU refexplicitrh)]rh+]rh2]ruhjh]rcdocutils.nodes strong r )r!}r"(hjh'}r#(h)]r$h+]r%h-]r&h/]r'h2]r(uhjh]r)hgXchannelsr*r+}r,(hUhj!ubah%Ustrongr-ubah%hGubhgX -- r.r/}r0(hUhjubh)r1}r2(hXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r3hjh jsh%hh'}r4(h)]r5h+]r6h-]r7h/]r8h2]r9uh4Kh]r:hgXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r;r<}r=(hj3hj1ubaubh)r>}r?(hXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r@hjh jsh%hh'}rA(h)]rBh+]rCh-]rDh/]rEh2]rFuh4Kh]rGhgXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rHrI}rJ(hj@hj>ubaubeh%hubah%U list_itemrKubj)rL}rM(hUh'}rN(h)]rOh+]rPh-]rQh/]rRh2]rSuhjh]rTh)rU}rV(hUh'}rW(h)]rXh+]rYh-]rZh/]r[h2]r\uhjLh]r](hC)r^}r_(hUh'}r`(UreftyperajU reftargetrbXvaluercU refdomainrdhh/]reh-]rfU refexplicitrgh)]rhh+]rih2]rjuhjUh]rkj )rl}rm(hjch'}rn(h)]roh+]rph-]rqh/]rrh2]rsuhj^h]rthgXvaluerurv}rw(hUhjlubah%j-ubah%hGubhgX -- rxry}rz(hUhjUubhgX this is a r{r|}r}(hX this is a r~hjUubhC)r}r(hX#:class:`circuits.core.values.Value`rhjUh Nh%hGh'}r(UreftyperXclassrhKhLXcircuits.core.values.ValuerU refdomainrXpyrh/]rh-]rU refexplicitrh)]rh+]rh2]rhVhWhXhhYjauh4Nh]rh[)r}r(hjh'}r(h)]rh+]r(hajXpy-classreh-]rh/]rh2]ruhjh]rhgXcircuits.core.values.Valuerr}r(hUhjubah%hkubaubhgXN object that holds the results returned by the handlers invoked for the event.rr}r(hXN object that holds the results returned by the handlers invoked for the event.rhjUubeh%hubah%jKubj)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rh)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(hC)r}r(hUh'}r(UreftyperjU reftargetrXsuccessrU refdomainrhh/]rh-]rU refexplicitrh)]rh+]rh2]ruhjh]rj )r}r(hjh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXsuccessrr}r(hUhjubah%j-ubah%hGubhgX -- rr}r(hUhjubhgX%if this optional attribute is set to rr}r(hX%if this optional attribute is set to rhjubh[)r}r(hX``True``rh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXTruerr}r(hUhjubah%hkubhgX, an associated event rr}r(hX, an associated event rhjubh[)r}r(hX``EventSuccess``rh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgX EventSuccessrr}r(hUhjubah%hkubhgX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(hX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rhjubeh%hubah%jKubj)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rh)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]r(hC)r}r(hUh'}r (Ureftyper jU reftargetr Xsuccess_channelsr U refdomainr hh/]rh-]rU refexplicitrh)]rh+]rh2]ruhjh]rj )r}r(hj h'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXsuccess_channelsrr}r (hUhjubah%j-ubah%hGubhgX -- r!r"}r#(hUhjubhgXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r$r%}r&(hXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r'hjubeh%hubah%jKubj)r(}r)(hUh'}r*(h)]r+h+]r,h-]r-h/]r.h2]r/uhjh]r0h)r1}r2(hUh'}r3(h)]r4h+]r5h-]r6h/]r7h2]r8uhj(h]r9(hC)r:}r;(hUh'}r<(Ureftyper=jU reftargetr>Xcompleter?U refdomainr@hh/]rAh-]rBU refexplicitrCh)]rDh+]rEh2]rFuhj1h]rGj )rH}rI(hj?h'}rJ(h)]rKh+]rLh-]rMh/]rNh2]rOuhj:h]rPhgXcompleterQrR}rS(hUhjHubah%j-ubah%hGubhgX -- rTrU}rV(hUhj1ubhgX%if this optional attribute is set to rWrX}rY(hX%if this optional attribute is set to rZhj1ubh[)r[}r\(hX``True``r]h'}r^(h)]r_h+]r`h-]rah/]rbh2]rcuhj1h]rdhgXTruererf}rg(hUhj[ubah%hkubhgX, an associated event rhri}rj(hX, an associated event rkhj1ubh[)rl}rm(hX``EventComplete``rnh'}ro(h)]rph+]rqh-]rrh/]rsh2]rtuhj1h]ruhgX EventCompletervrw}rx(hUhjlubah%hkubhgX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.ryrz}r{(hX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r|hj1ubeh%hubah%jKubj)r}}r~(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rh)r}r(hUh'}r(h)]rh+]rh-]rh/]rh2]ruhj}h]r(hC)r}r(hUh'}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrhh/]rh-]rU refexplicitrh)]rh+]rh2]ruhjh]rj )r}r(hjh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXsuccess_channelsrr}r(hUhjubah%j-ubah%hGubhgX -- rr}r(hUhjubhgXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(hXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rhjubeh%hubah%jKubeh%U bullet_listrubah%U field_bodyrubeh%Ufieldrubaubeubeubeubh)r}r(hUhhh h#h%h&h'}r(h)]rh+]rh-]rh/]rhah2]rh auh4K h5hh]r(h7)r}r(hX Componentsrhjh h#h%h;h'}r(h)]rh+]rh-]rh/]rh2]ruh4K h5hh]rhgX Componentsrr}r(hjhjubaubhp)r}r(hUhjh jFh%hth'}r(h/]rh-]rh)]rh+]rh2]rUentriesr]r(h}X3JSONRPC (class in circuits.web.dispatchers.jsonrpc)hUtrauh4Nh5hh]rubh)r}r(hUhjh jFh%hh'}r(hĉhXpyrh/]rh-]rh)]rh+]rh2]rhXclassrhjuh4Nh5hh]r(h)r}r(hX5JSONRPC(path=None, encoding='utf-8', rpc_channel='*')rhjh hh%hh'}r(h/]rhahh!X circuits.web.dispatchers.jsonrpcrr}rbh-]rh)]rh+]rh2]rhahXJSONRPCrhUhuh4Nh5hh]r(h)r}r(hXclass rhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgXclass rr}r(hUhjubaubh)r}r(hX!circuits.web.dispatchers.jsonrpc.rhjh hh%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]rhgX!circuits.web.dispatchers.jsonrpc.rr}r(hUhjubaubj)r}r (hjhjh hh%jh'}r (h)]r h+]r h-]r h/]rh2]ruh4Nh5hh]rhgXJSONRPCrr}r(hUhjubaubj)r}r(hUhjh hh%jh'}r(h)]rh+]rh-]rh/]rh2]ruh4Nh5hh]r(j)r}r(hX path=Nonerh'}r (h)]r!h+]r"h-]r#h/]r$h2]r%uhjh]r&hgX path=Noner'r(}r)(hUhjubah%j*ubj)r*}r+(hXencoding='utf-8'r,h'}r-(h)]r.h+]r/h-]r0h/]r1h2]r2uhjh]r3hgXencoding='utf-8'r4r5}r6(hUhj*ubah%j*ubj)r7}r8(hXrpc_channel='*'r9h'}r:(h)]r;h+]r<h-]r=h/]r>h2]r?uhjh]r@hgXrpc_channel='*'rArB}rC(hUhj7ubah%j*ubeubeubj8)rD}rE(hUhjh hh%j;h'}rF(h)]rGh+]rHh-]rIh/]rJh2]rKuh4Nh5hh]rLh)rM}rN(hX6Bases: :class:`circuits.core.components.BaseComponent`rOhjDh jFh%hh'}rP(h)]rQh+]rRh-]rSh/]rTh2]rUuh4Kh5hh]rV(hgXBases: rWrX}rY(hXBases: rZhjMubhC)r[}r\(hX/:class:`circuits.core.components.BaseComponent`r]hjMh h#h%hGh'}r^(Ureftyper_Xclassr`hKhLX&circuits.core.components.BaseComponentraU refdomainrbXpyrch/]rdh-]reU refexplicitrfh)]rgh+]rhh2]rihVhWhXjhYjauh4Kh]rjh[)rk}rl(hj]h'}rm(h)]rnh+]ro(hajcXpy-classrpeh-]rqh/]rrh2]rsuhj[h]rthgX&circuits.core.components.BaseComponentrurv}rw(hUhjkubah%hkubaubeubaubeubeubh)rx}ry(hUhhh h#h%h&h'}rz(h)]r{h+]r|h-]r}h/]r~hah2]rhauh4Kh5hh]r(h7)r}r(hX Functionsrhjxh h#h%h;h'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rhgX Functionsrr}r(hjhjubaubh)r}r(hX**none**rhjxh h#h%hh'}r(h)]rh+]rh-]rh/]rh2]ruh4Kh5hh]rj )r}r(hjh'}r(h)]rh+]rh-]rh/]rh2]ruhjh]rhgXnonerr}r(hUhjubah%j-ubaubeubeubahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh5hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh;NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUQ/home/prologic/work/circuits/docs/source/api/circuits_web_dispatchers_jsonrpc.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hhhjxhjhjh1cdocutils.nodes target r)r }r (hUhhh hsh%Utargetr h'}r (h)]r h/]rh1ah-]rUismodrh+]rh2]ruh4Kh5hh]rubh hhhuUsubstitution_namesr}rh%h5h'}r(h)]rh/]rh-]rUsourcerh#h+]rh2]ruU footnotesr]rUrefidsr}r ub.circuits-2.1.0/docs/build/doctrees/api/circuits_core_utils.doctree0000644000014400001440000003670512113366656025150 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNXcircuits.core.utils.safeimportqXcircuits.core.utils.findcmpqXcircuits.core.utils.findtypeq Xcircuits.core.utils.flattenq Xcircuits.core.utils.findchannelq Xclassesq NXcircuits.core.utils.findrootq X componentsqNX circuits.core.utils -- utilitiesqNXeventsqNuUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhhhhh h h h h h h Uclassesqh h hU componentsqhUcircuits-core-utils-utilitiesqhUeventsquUchildrenq]q cdocutils.nodes section q!)q"}q#(U rawsourceq$UUparentq%hUsourceq&cdocutils.nodes reprunicode q'XD/home/prologic/work/circuits/docs/source/api/circuits_core_utils.rstq(q)}q*bUtagnameq+Usectionq,U attributesq-}q.(Udupnamesq/]q0Uclassesq1]q2Ubackrefsq3]q4Uidsq5]q6(Xmodule-circuits.core.utilsq7heUnamesq8]q9hauUlineq:KUdocumentq;hh]q<(cdocutils.nodes title q=)q>}q?(h$X':mod:`circuits.core.utils` -- Utilitiesq@h%h"h&h)h+UtitleqAh-}qB(h/]qCh1]qDh3]qEh5]qFh8]qGuh:Kh;hh]qH(csphinx.addnodes pending_xref qI)qJ}qK(h$X:mod:`circuits.core.utils`qLh%h>h&h)h+U pending_xrefqMh-}qN(UreftypeqOXmodqPUrefwarnqQU reftargetqRXcircuits.core.utilsqSU refdomainqTXpyqUh5]qVh3]qWU refexplicitqXh/]qYh1]qZh8]q[Urefdocq\Uapi/circuits_core_utilsq]Upy:classq^NU py:moduleq_Nuh:Kh]q`cdocutils.nodes literal qa)qb}qc(h$hLh-}qd(h/]qeh1]qf(UxrefqghUXpy-modqheh3]qih5]qjh8]qkuh%hJh]qlcdocutils.nodes Text qmXcircuits.core.utilsqnqo}qp(h$Uh%hbubah+UliteralqqubaubhmX -- Utilitiesqrqs}qt(h$X -- Utilitiesquh%h>ubeubcsphinx.addnodes index qv)qw}qx(h$Uh%h"h&U qyh+Uindexqzh-}q{(h5]q|h3]q}h/]q~h1]qh8]qUentriesq]q(UsingleqXcircuits.core.utils (module)Xmodule-circuits.core.utilsUtqauh:Kh;hh]qubcdocutils.nodes paragraph q)q}q(h$XUtilsqh%h"h&XT/home/prologic/work/circuits/circuits/core/utils.py:docstring of circuits.core.utilsqh+U paragraphqh-}q(h/]qh1]qh3]qh5]qh8]quh:Kh;hh]qhmXUtilsqq}q(h$hh%hubaubh)q}q(h$X/This module defines utilities used by circuits.qh%h"h&hh+hh-}q(h/]qh1]qh3]qh5]qh8]quh:Kh;hh]qhmX/This module defines utilities used by circuits.qq}q(h$hh%hubaubh!)q}q(h$Uh%h"h&h)h+h,h-}q(h/]qh1]qh3]qh5]qhah8]qh auh:Kh;hh]q(h=)q}q(h$XClassesqh%hh&h)h+hAh-}q(h/]qh1]qh3]qh5]qh8]quh:Kh;hh]qhmXClassesqq}q(h$hh%hubaubh)q}q(h$X**none**qh%hh&h)h+hh-}q(h/]qh1]qh3]qh5]qh8]quh:K h;hh]qcdocutils.nodes strong q)q}q(h$hh-}q(h/]qh1]qh3]qh5]qh8]quh%hh]qhmXnoneqͅq}q(h$Uh%hubah+Ustrongqubaubeubh!)q}q(h$Uh%h"h&h)h+h,h-}q(h/]qh1]qh3]qh5]qhah8]qhauh:Kh;hh]q(h=)q}q(h$X Componentsqh%hh&h)h+hAh-}q(h/]qh1]qh3]qh5]qh8]quh:Kh;hh]qhmX Componentsq䅁q}q(h$hh%hubaubh)q}q(h$X**none**qh%hh&h)h+hh-}q(h/]qh1]qh3]qh5]qh8]quh:Kh;hh]qh)q}q(h$hh-}q(h/]qh1]qh3]qh5]qh8]quh%hh]qhmXnoneqq}q(h$Uh%hubah+hubaubeubh!)q}q(h$Uh%h"h&h)h+h,h-}q(h/]rh1]rh3]rh5]rhah8]rhauh:Kh;hh]r(h=)r}r(h$XEventsrh%hh&h)h+hAh-}r (h/]r h1]r h3]r h5]r h8]ruh:Kh;hh]rhmXEventsrr}r(h$jh%jubaubh)r}r(h$X**none**rh%hh&h)h+hh-}r(h/]rh1]rh3]rh5]rh8]ruh:Kh;hh]rh)r}r(h$jh-}r(h/]r h1]r!h3]r"h5]r#h8]r$uh%jh]r%hmXnoner&r'}r((h$Uh%jubah+hubaubeubh!)r)}r*(h$Uh%h"h&h)h+h,h-}r+(h/]r,h1]r-h3]r.h5]r/hah8]r0hauh:Kh;hh]r1(h=)r2}r3(h$X Functionsr4h%j)h&h)h+hAh-}r5(h/]r6h1]r7h3]r8h5]r9h8]r:uh:Kh;hh]r;hmX Functionsr<r=}r>(h$j4h%j2ubaubhv)r?}r@(h$Uh%j)h&Nh+hzh-}rA(h5]rBh3]rCh/]rDh1]rEh8]rFUentriesrG]rH(hX-findchannel() (in module circuits.core.utils)h UtrIauh:Nh;hh]rJubcsphinx.addnodes desc rK)rL}rM(h$Uh%j)h&Nh+UdescrNh-}rO(UnoindexrPUdomainrQXpyrRh5]rSh3]rTh/]rUh1]rVh8]rWUobjtyperXXfunctionrYUdesctyperZjYuh:Nh;hh]r[(csphinx.addnodes desc_signature r\)r]}r^(h$X%findchannel(root, channel, all=False)r_h%jLh&U r`h+Udesc_signaturerah-}rb(h5]rch aUmodulerdh'Xcircuits.core.utilsrerf}rgbh3]rhh/]rih1]rjh8]rkh aUfullnamerlX findchannelrmUclassrnUUfirstrouh:Nh;hh]rp(csphinx.addnodes desc_addname rq)rr}rs(h$Xcircuits.core.utils.rth%j]h&j`h+U desc_addnameruh-}rv(h/]rwh1]rxh3]ryh5]rzh8]r{uh:Nh;hh]r|hmXcircuits.core.utils.r}r~}r(h$Uh%jrubaubcsphinx.addnodes desc_name r)r}r(h$jmh%j]h&j`h+U desc_namerh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmX findchannelrr}r(h$Uh%jubaubcsphinx.addnodes desc_parameterlist r)r}r(h$Uh%j]h&j`h+Udesc_parameterlistrh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]r(csphinx.addnodes desc_parameter r)r}r(h$Xrootrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXrootrr}r(h$Uh%jubah+Udesc_parameterrubj)r}r(h$Xchannelrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXchannelrr}r(h$Uh%jubah+jubj)r}r(h$X all=Falserh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX all=Falserr}r(h$Uh%jubah+jubeubeubcsphinx.addnodes desc_content r)r}r(h$Uh%jLh&j`h+U desc_contentrh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rubeubhv)r}r(h$Uh%j)h&Nh+hzh-}r(h5]rh3]rh/]rh1]rh8]rUentriesr]r(hX)findcmp() (in module circuits.core.utils)hUtrauh:Nh;hh]rubjK)r}r(h$Uh%j)h&Nh+jNh-}r(jPjQXpyrh5]rh3]rh/]rh1]rh8]rjXXfunctionrjZjuh:Nh;hh]r(j\)r}r(h$X#findcmp(root, component, all=False)rh%jh&j`h+jah-}r(h5]rhajdh'Xcircuits.core.utilsrr}rbh3]rh/]rh1]rh8]rhajlXfindcmprjnUjouh:Nh;hh]r(jq)r}r(h$Xcircuits.core.utils.rh%jh&j`h+juh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXcircuits.core.utils.rr}r(h$Uh%jubaubj)r}r(h$jh%jh&j`h+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXfindcmprr }r (h$Uh%jubaubj)r }r (h$Uh%jh&j`h+jh-}r (h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]r(j)r}r(h$Xrootrh-}r(h/]rh1]rh3]rh5]rh8]ruh%j h]rhmXrootrr}r (h$Uh%jubah+jubj)r!}r"(h$X componentr#h-}r$(h/]r%h1]r&h3]r'h5]r(h8]r)uh%j h]r*hmX componentr+r,}r-(h$Uh%j!ubah+jubj)r.}r/(h$X all=Falser0h-}r1(h/]r2h1]r3h3]r4h5]r5h8]r6uh%j h]r7hmX all=Falser8r9}r:(h$Uh%j.ubah+jubeubeubj)r;}r<(h$Uh%jh&j`h+jh-}r=(h/]r>h1]r?h3]r@h5]rAh8]rBuh:Nh;hh]rCubeubhv)rD}rE(h$Uh%j)h&Nh+hzh-}rF(h5]rGh3]rHh/]rIh1]rJh8]rKUentriesrL]rM(hX*findroot() (in module circuits.core.utils)h UtrNauh:Nh;hh]rOubjK)rP}rQ(h$Uh%j)h&Nh+jNh-}rR(jPjQXpyrSh5]rTh3]rUh/]rVh1]rWh8]rXjXXfunctionrYjZjYuh:Nh;hh]rZ(j\)r[}r\(h$Xfindroot(component)r]h%jPh&j`h+jah-}r^(h5]r_h ajdh'Xcircuits.core.utilsr`ra}rbbh3]rch/]rdh1]reh8]rfh ajlXfindrootrgjnUjouh:Nh;hh]rh(jq)ri}rj(h$Xcircuits.core.utils.rkh%j[h&j`h+juh-}rl(h/]rmh1]rnh3]roh5]rph8]rquh:Nh;hh]rrhmXcircuits.core.utils.rsrt}ru(h$Uh%jiubaubj)rv}rw(h$jgh%j[h&j`h+jh-}rx(h/]ryh1]rzh3]r{h5]r|h8]r}uh:Nh;hh]r~hmXfindrootrr}r(h$Uh%jvubaubj)r}r(h$Uh%j[h&j`h+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rj)r}r(h$X componentrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX componentrr}r(h$Uh%jubah+jubaubeubj)r}r(h$Uh%jPh&j`h+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rubeubhv)r}r(h$Uh%j)h&Nh+hzh-}r(h5]rh3]rh/]rh1]rh8]rUentriesr]r(hX*findtype() (in module circuits.core.utils)h Utrauh:Nh;hh]rubjK)r}r(h$Uh%j)h&Nh+jNh-}r(jPjQXpyrh5]rh3]rh/]rh1]rh8]rjXXfunctionrjZjuh:Nh;hh]r(j\)r}r(h$X$findtype(root, component, all=False)rh%jh&j`h+jah-}r(h5]rh ajdh'Xcircuits.core.utilsrr}rbh3]rh/]rh1]rh8]rh ajlXfindtyperjnUjouh:Nh;hh]r(jq)r}r(h$Xcircuits.core.utils.rh%jh&j`h+juh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXcircuits.core.utils.rr}r(h$Uh%jubaubj)r}r(h$jh%jh&j`h+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXfindtyperr}r(h$Uh%jubaubj)r}r(h$Uh%jh&j`h+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]r(j)r}r(h$Xrootrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXrootrr}r(h$Uh%jubah+jubj)r}r(h$X componentrh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmX componentrr}r(h$Uh%jubah+jubj)r}r(h$X all=Falserh-}r(h/]rh1]rh3]rh5]r h8]r uh%jh]r hmX all=Falser r }r(h$Uh%jubah+jubeubeubj)r}r(h$Uh%jh&j`h+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rubeubhv)r}r(h$Uh%j)h&Nh+hzh-}r(h5]rh3]rh/]rh1]rh8]rUentriesr ]r!(hX)flatten() (in module circuits.core.utils)h Utr"auh:Nh;hh]r#ubjK)r$}r%(h$Uh%j)h&Nh+jNh-}r&(jPjQXpyr'h5]r(h3]r)h/]r*h1]r+h8]r,jXXfunctionr-jZj-uh:Nh;hh]r.(j\)r/}r0(h$Xflatten(root, visited=None)r1h%j$h&j`h+jah-}r2(h5]r3h ajdh'Xcircuits.core.utilsr4r5}r6bh3]r7h/]r8h1]r9h8]r:h ajlXflattenr;jnUjouh:Nh;hh]r<(jq)r=}r>(h$Xcircuits.core.utils.r?h%j/h&j`h+juh-}r@(h/]rAh1]rBh3]rCh5]rDh8]rEuh:Nh;hh]rFhmXcircuits.core.utils.rGrH}rI(h$Uh%j=ubaubj)rJ}rK(h$j;h%j/h&j`h+jh-}rL(h/]rMh1]rNh3]rOh5]rPh8]rQuh:Nh;hh]rRhmXflattenrSrT}rU(h$Uh%jJubaubj)rV}rW(h$Uh%j/h&j`h+jh-}rX(h/]rYh1]rZh3]r[h5]r\h8]r]uh:Nh;hh]r^(j)r_}r`(h$Xrootrah-}rb(h/]rch1]rdh3]reh5]rfh8]rguh%jVh]rhhmXrootrirj}rk(h$Uh%j_ubah+jubj)rl}rm(h$X visited=Nonernh-}ro(h/]rph1]rqh3]rrh5]rsh8]rtuh%jVh]ruhmX visited=Nonervrw}rx(h$Uh%jlubah+jubeubeubj)ry}rz(h$Uh%j$h&j`h+jh-}r{(h/]r|h1]r}h3]r~h5]rh8]ruh:Nh;hh]rubeubhv)r}r(h$Uh%j)h&Nh+hzh-}r(h5]rh3]rh/]rh1]rh8]rUentriesr]r(hX,safeimport() (in module circuits.core.utils)hUtrauh:Nh;hh]rubjK)r}r(h$Uh%j)h&Nh+jNh-}r(jPjQXpyrh5]rh3]rh/]rh1]rh8]rjXXfunctionrjZjuh:Nh;hh]r(j\)r}r(h$Xsafeimport(name)rh%jh&j`h+jah-}r(h5]rhajdh'Xcircuits.core.utilsrr}rbh3]rh/]rh1]rh8]rhajlX safeimportrjnUjouh:Nh;hh]r(jq)r}r(h$Xcircuits.core.utils.rh%jh&j`h+juh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmXcircuits.core.utils.rr}r(h$Uh%jubaubj)r}r(h$jh%jh&j`h+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rhmX safeimportrr}r(h$Uh%jubaubj)r}r(h$Uh%jh&j`h+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rj)r}r(h$Xnamerh-}r(h/]rh1]rh3]rh5]rh8]ruh%jh]rhmXnamerr}r(h$Uh%jubah+jubaubeubj)r}r(h$Uh%jh&j`h+jh-}r(h/]rh1]rh3]rh5]rh8]ruh:Nh;hh]rubeubeubeubah$UU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh;hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelr KU strip_classesr NhANUerror_encoding_error_handlerr Ubackslashreplacer Udebugr NUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkr NUrfc_referencesr!NUoutput_encodingr"Uutf-8r#U source_urlr$NUinput_encodingr%U utf-8-sigr&U_disable_configr'NU id_prefixr(UU tab_widthr)KUerror_encodingr*U ISO-8859-1r+U_sourcer,UD/home/prologic/work/circuits/docs/source/api/circuits_core_utils.rstr-Ugettext_compactr.U generatorr/NUdump_internalsr0NU smart_quotesr1U pep_base_urlr2Uhttp://www.python.org/dev/peps/r3Usyntax_highlightr4Ulongr5Uinput_encoding_error_handlerr6jUauto_id_prefixr7Uidr8Udoctitle_xformr9Ustrip_elements_with_classesr:NU _config_filesr;]r<Ufile_insertion_enabledr=KU raw_enabledr>KU dump_settingsr?NubUsymbol_footnote_startr@KUidsrA}rB(hj)hjh7cdocutils.nodes target rC)rD}rE(h$Uh%h"h&hyh+UtargetrFh-}rG(h/]rHh5]rIh7ah3]rJUismodrKh1]rLh8]rMuh:Kh;hh]rNubhjh jh j/h j]hhh j[hhhh"hhuUsubstitution_namesrO}rPh+h;h-}rQ(h/]rRh5]rSh3]rTUsourcerUh)h1]rVh8]rWuU footnotesrX]rYUrefidsrZ}r[ub.circuits-2.1.0/docs/build/doctrees/api/circuits_app_env.doctree0000644000014400001440000010562112113366654024420 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNXcircuits.app.env.EnvironmentqXcircuits.app.env.CreateqXcircuits.app.env.Loadq X+circuits.app.env -- application environmentq NX componentsq NXeventsq NuUsubstitution_defsq }qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhhhhh h h U(circuits-app-env-application-environmentqh U componentsqh UeventsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentq hUsourceq!cdocutils.nodes reprunicode q"XA/home/prologic/work/circuits/docs/source/api/circuits_app_env.rstq#q$}q%bUtagnameq&Usectionq'U attributesq(}q)(Udupnamesq*]q+Uclassesq,]q-Ubackrefsq.]q/Uidsq0]q1(Xmodule-circuits.app.envq2heUnamesq3]q4h auUlineq5KUdocumentq6hh]q7(cdocutils.nodes title q8)q9}q:(hX2:mod:`circuits.app.env` -- Application Environmentq;h hh!h$h&Utitleqh,]q?h.]q@h0]qAh3]qBuh5Kh6hh]qC(csphinx.addnodes pending_xref qD)qE}qF(hX:mod:`circuits.app.env`qGh h9h!h$h&U pending_xrefqHh(}qI(UreftypeqJXmodqKUrefwarnqLU reftargetqMXcircuits.app.envqNU refdomainqOXpyqPh0]qQh.]qRU refexplicitqSh*]qTh,]qUh3]qVUrefdocqWUapi/circuits_app_envqXUpy:classqYNU py:moduleqZNuh5Kh]q[cdocutils.nodes literal q\)q]}q^(hhGh(}q_(h*]q`h,]qa(UxrefqbhPXpy-modqceh.]qdh0]qeh3]qfuh hEh]qgcdocutils.nodes Text qhXcircuits.app.envqiqj}qk(hUh h]ubah&UliteralqlubaubhhX -- Application Environmentqmqn}qo(hX -- Application Environmentqph h9ubeubcsphinx.addnodes index qq)qr}qs(hUh hh!h$h&Uindexqth(}qu(h0]qvh.]qwh*]qxh,]qyh3]qzUentriesq{]q|(Usingleq}Xcircuits.app.env (module)Xmodule-circuits.app.envUtq~auh5Kh6hh]qubh)q}q(hUh hh!h$h&h'h(}q(h*]qh,]qh.]qh0]qhah3]qh auh5Kh6hh]q(h8)q}q(hXEventsqh hh!h$h&hqh&Udesc_signatureqh(}q(h0]qhaUmoduleqh"Xcircuits.app.envqq}qbh.]qh*]qh,]qh3]qhaUfullnameqXCreateqUclassqUUfirstqƉuh5Nh6hh]q(csphinx.addnodes desc_annotation q)q}q(hXclass qh hh!hh&Udesc_annotationqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]qhhXclass qԅq}q(hUh hubaubcsphinx.addnodes desc_addname q)q}q(hXcircuits.app.env.qh hh!hh&U desc_addnameqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]qhhXcircuits.app.env.qㅁq}q(hUh hubaubcsphinx.addnodes desc_name q)q}q(hhh hh!hh&U desc_nameqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]qhhXCreateqq}q(hUh hubaubcsphinx.addnodes desc_parameterlist q)q}q(hUh hh!hh&Udesc_parameterlistqh(}q(h*]qh,]qh.]qh0]qh3]quh5Nh6hh]q(csphinx.addnodes desc_parameter q)r}r(hX*argsrh(}r(h*]rh,]rh.]rh0]rh3]ruh hh]r hhX*argsr r }r (hUh jubah&Udesc_parameterr ubh)r}r(hX**kwargsrh(}r(h*]rh,]rh.]rh0]rh3]ruh hh]rhhX**kwargsrr}r(hUh jubah&j ubeubeubcsphinx.addnodes desc_content r)r}r(hUh hh!hh&U desc_contentrh(}r(h*]r h,]r!h.]r"h0]r#h3]r$uh5Nh6hh]r%(cdocutils.nodes paragraph r&)r'}r((hX1Bases: :class:`circuits.app.env.EnvironmentEvent`r)h jh!U r*h&U paragraphr+h(}r,(h*]r-h,]r.h.]r/h0]r0h3]r1uh5Kh6hh]r2(hhXBases: r3r4}r5(hXBases: r6h j'ubhD)r7}r8(hX*:class:`circuits.app.env.EnvironmentEvent`r9h j'h!h$h&hHh(}r:(Ureftyper;Xclassr<hLhMX!circuits.app.env.EnvironmentEventr=U refdomainr>Xpyr?h0]r@h.]rAU refexplicitrBh*]rCh,]rDh3]rEhWhXhYhhZXcircuits.app.envrFuh5Kh]rGh\)rH}rI(hj9h(}rJ(h*]rKh,]rL(hbj?Xpy-classrMeh.]rNh0]rOh3]rPuh j7h]rQhhX!circuits.app.env.EnvironmentEventrRrS}rT(hUh jHubah&hlubaubeubj&)rU}rV(hXCreate Environment EventrWh jh!XU/home/prologic/work/circuits/circuits/app/env.py:docstring of circuits.app.env.CreaterXh&j+h(}rY(h*]rZh,]r[h.]r\h0]r]h3]r^uh5Kh6hh]r_hhXCreate Environment Eventr`ra}rb(hjWh jUubaubj&)rc}rd(hXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.reh jh!jXh&j+h(}rf(h*]rgh,]rhh.]rih0]rjh3]rkuh5Kh6hh]rlhhXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rmrn}ro(hjeh jcubaubj&)rp}rq(hXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rrh jh!jXh&j+h(}rs(h*]rth,]ruh.]rvh0]rwh3]rxuh5Kh6hh]ryhhXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rzr{}r|(hjrh jpubaubj&)r}}r~(hXEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh jh!jXh&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5K h6hh]r(hhXEvery event has a rr}r(hXEvery event has a rh j}ubhD)r}r(hX :attr:`name`rh j}h!h$h&hHh(}r(UreftyperXattrrhLhMXnamerU refdomainrXpyrh0]rh.]rU refexplicitrh*]rh,]rh3]rhWhXhYhhZjFuh5Kh]rh\)r}r(hjh(}r(h*]rh,]r(hbjXpy-attrreh.]rh0]rh3]ruh jh]rhhXnamerr}r(hUh jubah&hlubaubhhX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(hX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh j}ubeubcdocutils.nodes field_list r)r}r(hUh jh!Nh&U field_listrh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rcdocutils.nodes field r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(cdocutils.nodes field_name r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX Variablesrr}r(hUh jubah&U field_namerubcdocutils.nodes field_body r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rcdocutils.nodes bullet_list r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(cdocutils.nodes list_item r)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperUobjrU reftargetrXchannelsrU refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rcdocutils.nodes strong r)r}r(hjh(}r(h*]r h,]r h.]r h0]r h3]r uh jh]rhhXchannelsrr}r(hUh jubah&Ustrongrubah&hHubhhX -- rr}r(hUh jubj&)r}r(hXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rh jh!jXh&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh]rhhXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r r!}r"(hjh jubaubj&)r#}r$(hXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r%h jh!jXh&j+h(}r&(h*]r'h,]r(h.]r)h0]r*h3]r+uh5Kh]r,hhXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r-r.}r/(hj%h j#ubaubeh&j+ubah&U list_itemr0ubj)r1}r2(hUh(}r3(h*]r4h,]r5h.]r6h0]r7h3]r8uh jh]r9j&)r:}r;(hUh(}r<(h*]r=h,]r>h.]r?h0]r@h3]rAuh j1h]rB(hD)rC}rD(hUh(}rE(UreftyperFjU reftargetrGXvaluerHU refdomainrIhh0]rJh.]rKU refexplicitrLh*]rMh,]rNh3]rOuh j:h]rPj)rQ}rR(hjHh(}rS(h*]rTh,]rUh.]rVh0]rWh3]rXuh jCh]rYhhXvaluerZr[}r\(hUh jQubah&jubah&hHubhhX -- r]r^}r_(hUh j:ubhhX this is a r`ra}rb(hX this is a rch j:ubhD)rd}re(hX#:class:`circuits.core.values.Value`rfh j:h!Nh&hHh(}rg(UreftyperhXclassrihLhMXcircuits.core.values.ValuerjU refdomainrkXpyrlh0]rmh.]rnU refexplicitroh*]rph,]rqh3]rrhWhXhYhhZjFuh5Nh]rsh\)rt}ru(hjfh(}rv(h*]rwh,]rx(hbjlXpy-classryeh.]rzh0]r{h3]r|uh jdh]r}hhXcircuits.core.values.Valuer~r}r(hUh jtubah&hlubaubhhXN object that holds the results returned by the handlers invoked for the event.rr}r(hXN object that holds the results returned by the handlers invoked for the event.rh j:ubeh&j+ubah&j0ubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXsuccessrU refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXsuccessrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhX%if this optional attribute is set to rr}r(hX%if this optional attribute is set to rh jubh\)r}r(hX``True``rh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXTruerr}r(hUh jubah&hlubhhX, an associated event rr}r(hX, an associated event rh jubh\)r}r(hX``EventSuccess``rh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX EventSuccessrr}r(hUh jubah&hlubhhX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(hX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh jubeh&j+ubah&j0ubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrhh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXsuccess_channelsrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r r }r (hXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r h jubeh&j+ubah&j0ubj)r }r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh j h]r(hD)r}r (hUh(}r!(Ureftyper"jU reftargetr#Xcompleter$U refdomainr%hh0]r&h.]r'U refexplicitr(h*]r)h,]r*h3]r+uh jh]r,j)r-}r.(hj$h(}r/(h*]r0h,]r1h.]r2h0]r3h3]r4uh jh]r5hhXcompleter6r7}r8(hUh j-ubah&jubah&hHubhhX -- r9r:}r;(hUh jubhhX%if this optional attribute is set to r<r=}r>(hX%if this optional attribute is set to r?h jubh\)r@}rA(hX``True``rBh(}rC(h*]rDh,]rEh.]rFh0]rGh3]rHuh jh]rIhhXTruerJrK}rL(hUh j@ubah&hlubhhX, an associated event rMrN}rO(hX, an associated event rPh jubh\)rQ}rR(hX``EventComplete``rSh(}rT(h*]rUh,]rVh.]rWh0]rXh3]rYuh jh]rZhhX EventCompleter[r\}r](hUh jQubah&hlubhhX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r^r_}r`(hX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rah jubeh&j+ubah&j0ubj)rb}rc(hUh(}rd(h*]reh,]rfh.]rgh0]rhh3]riuh jh]rjj&)rk}rl(hUh(}rm(h*]rnh,]roh.]rph0]rqh3]rruh jbh]rs(hD)rt}ru(hUh(}rv(UreftyperwjU reftargetrxXsuccess_channelsryU refdomainrzhh0]r{h.]r|U refexplicitr}h*]r~h,]rh3]ruh jkh]rj)r}r(hjyh(}r(h*]rh,]rh.]rh0]rh3]ruh jth]rhhXsuccess_channelsrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jkubhhXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(hXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh jkubeh&j+ubah&j0ubeh&U bullet_listrubah&U field_bodyrubeh&Ufieldrubaubeubeubhq)r}r(hUh hh!Nh&hth(}r(h0]rh.]rh*]rh,]rh3]rUentriesr]r(h}X Load (class in circuits.app.env)h Utrauh5Nh6hh]rubh)r}r(hUh hh!Nh&hh(}r(hhXpyrh0]rh.]rh*]rh,]rh3]rhXclassrhjuh5Nh6hh]r(h)r}r(hXLoad(*args, **kwargs)rh jh!hh&hh(}r(h0]rh ahh"Xcircuits.app.envrr}rbh.]rh*]rh,]rh3]rh ahXLoadrhUhƉuh5Nh6hh]r(h)r}r(hXclass rh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rhhXclass rr}r(hUh jubaubh)r}r(hXcircuits.app.env.rh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rhhXcircuits.app.env.rr}r(hUh jubaubh)r}r(hjh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rhhXLoadrr}r(hUh jubaubh)r}r(hUh jh!hh&hh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]r(h)r}r(hX*argsrh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX*argsrr}r(hUh jubah&j ubh)r}r(hX**kwargsrh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX**kwargsrr}r(hUh jubah&j ubeubeubj)r}r(hUh jh!hh&jh(}r(h*]r h,]r h.]r h0]r h3]r uh5Nh6hh]r(j&)r}r(hX1Bases: :class:`circuits.app.env.EnvironmentEvent`rh jh!j*h&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh6hh]r(hhXBases: rr}r(hXBases: rh jubhD)r}r(hX*:class:`circuits.app.env.EnvironmentEvent`rh jh!h$h&hHh(}r (Ureftyper!Xclassr"hLhMX!circuits.app.env.EnvironmentEventr#U refdomainr$Xpyr%h0]r&h.]r'U refexplicitr(h*]r)h,]r*h3]r+hWhXhYjhZjFuh5Kh]r,h\)r-}r.(hjh(}r/(h*]r0h,]r1(hbj%Xpy-classr2eh.]r3h0]r4h3]r5uh jh]r6hhX!circuits.app.env.EnvironmentEventr7r8}r9(hUh j-ubah&hlubaubeubj&)r:}r;(hXLoad Environment Eventr<h jh!XS/home/prologic/work/circuits/circuits/app/env.py:docstring of circuits.app.env.Loadr=h&j+h(}r>(h*]r?h,]r@h.]rAh0]rBh3]rCuh5Kh6hh]rDhhXLoad Environment EventrErF}rG(hj<h j:ubaubj&)rH}rI(hXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rJh jh!j=h&j+h(}rK(h*]rLh,]rMh.]rNh0]rOh3]rPuh5Kh6hh]rQhhXAn Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.rRrS}rT(hjJh jHubaubj&)rU}rV(hXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.rWh jh!j=h&j+h(}rX(h*]rYh,]rZh.]r[h0]r\h3]r]uh5Kh6hh]r^hhXAll normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.r_r`}ra(hjWh jUubaubj&)rb}rc(hXEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rdh jh!j=h&j+h(}re(h*]rfh,]rgh.]rhh0]rih3]rjuh5K h6hh]rk(hhXEvery event has a rlrm}rn(hXEvery event has a roh jbubhD)rp}rq(hX :attr:`name`rrh jbh!h$h&hHh(}rs(UreftypertXattrruhLhMXnamervU refdomainrwXpyrxh0]ryh.]rzU refexplicitr{h*]r|h,]r}h3]r~hWhXhYjhZjFuh5Kh]rh\)r}r(hjrh(}r(h*]rh,]r(hbjxXpy-attrreh.]rh0]rh3]ruh jph]rhhXnamerr}r(hUh jubah&hlubaubhhX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rr}r(hX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rh jbubeubj)r}r(hUh jh!Nh&jh(}r(h*]rh,]rh.]rh0]rh3]ruh5Nh6hh]rj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(j)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhX Variablesrr}r(hUh jubah&jubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(j)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXchannelsrU refdomainrjh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXchannelsrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubj&)r}r(hXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rh jh!j=h&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh]rhhXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rr}r(hjh jubaubj&)r}r(hXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rh jh!j=h&j+h(}r(h*]rh,]rh.]rh0]rh3]ruh5Kh]rhhXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rr}r (hjh jubaubeh&j+ubah&j0ubj)r }r (hUh(}r (h*]r h,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh j h]r(hD)r}r(hUh(}r(UreftyperjU reftargetr Xvaluer!U refdomainr"jh0]r#h.]r$U refexplicitr%h*]r&h,]r'h3]r(uh jh]r)j)r*}r+(hj!h(}r,(h*]r-h,]r.h.]r/h0]r0h3]r1uh jh]r2hhXvaluer3r4}r5(hUh j*ubah&jubah&hHubhhX -- r6r7}r8(hUh jubhhX this is a r9r:}r;(hX this is a r<h jubhD)r=}r>(hX#:class:`circuits.core.values.Value`r?h jh!Nh&hHh(}r@(UreftyperAXclassrBhLhMXcircuits.core.values.ValuerCU refdomainrDXpyrEh0]rFh.]rGU refexplicitrHh*]rIh,]rJh3]rKhWhXhYjhZjFuh5Nh]rLh\)rM}rN(hj?h(}rO(h*]rPh,]rQ(hbjEXpy-classrReh.]rSh0]rTh3]rUuh j=h]rVhhXcircuits.core.values.ValuerWrX}rY(hUh jMubah&hlubaubhhXN object that holds the results returned by the handlers invoked for the event.rZr[}r\(hXN object that holds the results returned by the handlers invoked for the event.r]h jubeh&j+ubah&j0ubj)r^}r_(hUh(}r`(h*]rah,]rbh.]rch0]rdh3]reuh jh]rfj&)rg}rh(hUh(}ri(h*]rjh,]rkh.]rlh0]rmh3]rnuh j^h]ro(hD)rp}rq(hUh(}rr(UreftypersjU reftargetrtXsuccessruU refdomainrvjh0]rwh.]rxU refexplicitryh*]rzh,]r{h3]r|uh jgh]r}j)r~}r(hjuh(}r(h*]rh,]rh.]rh0]rh3]ruh jph]rhhXsuccessrr}r(hUh j~ubah&jubah&hHubhhX -- rr}r(hUh jgubhhX%if this optional attribute is set to rr}r(hX%if this optional attribute is set to rh jgubh\)r}r(hX``True``rh(}r(h*]rh,]rh.]rh0]rh3]ruh jgh]rhhXTruerr}r(hUh jubah&hlubhhX, an associated event rr}r(hX, an associated event rh jgubh\)r}r(hX``EventSuccess``rh(}r(h*]rh,]rh.]rh0]rh3]ruh jgh]rhhX EventSuccessrr}r(hUh jubah&hlubhhX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(hX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh jgubeh&j+ubah&j0ubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrjh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rhhXsuccess_channelsrr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(hXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh jubeh&j+ubah&j0ubj)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]rj&)r}r(hUh(}r(h*]rh,]rh.]rh0]rh3]ruh jh]r(hD)r}r(hUh(}r(UreftyperjU reftargetrXcompleterU refdomainrjh0]rh.]rU refexplicitrh*]rh,]rh3]ruh jh]rj)r}r(hjh(}r(h*]r h,]r h.]r h0]r h3]r uh jh]rhhXcompleterr}r(hUh jubah&jubah&hHubhhX -- rr}r(hUh jubhhX%if this optional attribute is set to rr}r(hX%if this optional attribute is set to rh jubh\)r}r(hX``True``rh(}r(h*]rh,]rh.]rh0]r h3]r!uh jh]r"hhXTruer#r$}r%(hUh jubah&hlubhhX, an associated event r&r'}r((hX, an associated event r)h jubh\)r*}r+(hX``EventComplete``r,h(}r-(h*]r.h,]r/h.]r0h0]r1h3]r2uh jh]r3hhX EventCompleter4r5}r6(hUh j*ubah&hlubhhX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r7r8}r9(hX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r:h jubeh&j+ubah&j0ubj)r;}r<(hUh(}r=(h*]r>h,]r?h.]r@h0]rAh3]rBuh jh]rCj&)rD}rE(hUh(}rF(h*]rGh,]rHh.]rIh0]rJh3]rKuh j;h]rL(hD)rM}rN(hUh(}rO(UreftyperPjU reftargetrQXsuccess_channelsrRU refdomainrSjh0]rTh.]rUU refexplicitrVh*]rWh,]rXh3]rYuh jDh]rZj)r[}r\(hjRh(}r](h*]r^h,]r_h.]r`h0]rah3]rbuh jMh]rchhXsuccess_channelsrdre}rf(hUh j[ubah&jubah&hHubhhX -- rgrh}ri(hUh jDubhhXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rjrk}rl(hXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rmh jDubeh&j+ubah&j0ubeh&jubah&jubeh&jubaubeubeubeubh)rn}ro(hUh hh!h$h&h'h(}rp(h*]rqh,]rrh.]rsh0]rthah3]ruh auh5Kh6hh]rv(h8)rw}rx(hX Componentsryh jnh!h$h&hr?}r@(hj6h j4ubaubj&)rA}rB(hXcCreates a new environment component that by default only holds configuration and logger components.rCh jh!jh&j+h(}rD(h*]rEh,]rFh.]rGh0]rHh3]rIuh5Kh6hh]rJhhXcCreates a new environment component that by default only holds configuration and logger components.rKrL}rM(hjCh jAubaubj&)rN}rO(hX[This component can be extended to provide more complex system and application environments.rPh jh!jh&j+h(}rQ(h*]rRh,]rSh.]rTh0]rUh3]rVuh5Kh6hh]rWhhX[This component can be extended to provide more complex system and application environments.rXrY}rZ(hjPh jNubaubeubeubeubh)r[}r\(hUh hh!h$h&h'h(}r](h*]r^h,]r_h.]r`h0]rahah3]rbhauh5Kh6hh]rch8)rd}re(hX Functionsrfh j[h!h$h&h)q?}q@(hUhhhhhUcompoundqAh}qB(h!]qCh#]qDUtoctree-wrapperqEah%]qFh']qGh)]qHuh+Nh,hh]qIcsphinx.addnodes toctree qJ)qK}qL(hUhh?hhhUtoctreeqMh}qN(UnumberedqOKhU api/indexqPU titlesonlyqQUglobqRh']qSh%]qTh!]qUh#]qVh)]qWUentriesqX]qY(NXapi/circuits_coreqZq[NXapi/circuits_ioq\q]NXapi/circuits_netq^q_NXapi/circuits_nodeq`qaNXapi/circuits_toolsqbqcNXapi/circuits_webqdqeNXapi/circuits_appqfqgeUhiddenqhU includefilesqi]qj(hZh\h^h`hbhdhfeUmaxdepthqkKuh+Kh]qlubaubeubahUU transformerqmNU footnote_refsqn}qoUrefnamesqp}qqUsymbol_footnotesqr]qsUautofootnote_refsqt]quUsymbol_footnote_refsqv]qwU citationsqx]qyh,hU current_lineqzNUtransform_messagesq{]q|Ureporterq}NUid_startq~KU autofootnotesq]qU citation_refsq}qUindirect_targetsq]qUsettingsq(cdocutils.frontend Values qoq}q(Ufootnote_backlinksqKUrecord_dependenciesqNU rfc_base_urlqUhttp://tools.ietf.org/html/qU tracebackqUpep_referencesqNUstrip_commentsqNU toc_backlinksqUentryqU language_codeqUenqU datestampqNU report_levelqKU _destinationqNU halt_levelqKU strip_classesqNh2NUerror_encoding_error_handlerqUbackslashreplaceqUdebugqNUembed_stylesheetqUoutput_encoding_error_handlerqUstrictqU sectnum_xformqKUdump_transformsqNU docinfo_xformqKUwarning_streamqNUpep_file_url_templateqUpep-%04dqUexit_status_levelqKUconfigqNUstrict_visitorqNUcloak_email_addressesqUtrim_footnote_reference_spaceqUenvqNUdump_pseudo_xmlqNUexpose_internalsqNUsectsubtitle_xformqU source_linkqNUrfc_referencesqNUoutput_encodingqUutf-8qU source_urlqNUinput_encodingqU utf-8-sigqU_disable_configqNU id_prefixqUU tab_widthqKUerror_encodingqU ISO-8859-1qU_sourceqU6/home/prologic/work/circuits/docs/source/api/index.rstqUgettext_compactqU generatorqNUdump_internalsqNU smart_quotesqU pep_base_urlqUhttp://www.python.org/dev/peps/qUsyntax_highlightqUlongqUinput_encoding_error_handlerqhUauto_id_prefixqUidqUdoctitle_xformqljUstrip_elements_with_classesqNU _config_filesq]qUfile_insertion_enabledqKU raw_enabledqKU dump_settingsqNubUsymbol_footnote_startqKUidsq}qhhsUsubstitution_namesq}qhh,h}q(h!]qh']qh%]qUsourceqhh#]qh)]quU footnotesq]qUrefidsq}qub.circuits-2.1.0/docs/build/doctrees/api/circuits_tools.doctree0000644000014400001440000002250012113366662024121 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X#circuits.tools -- development toolsqNXcircuits.tools.graphquUsubstitution_defsq}q Uparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startqKUnameidsq}q(hU circuits-tools-development-toolsqhhuUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX?/home/prologic/work/circuits/docs/source/api/circuits_tools.rstqq}qbUtagnameqUsectionqU attributesq }q!(Udupnamesq"]q#Uclassesq$]q%Ubackrefsq&]q'Uidsq(]q)(Xmodule-circuits.toolsq*heUnamesq+]q,hauUlineq-KUdocumentq.hh]q/(cdocutils.nodes title q0)q1}q2(hX*:mod:`circuits.tools` -- Development Toolsq3hhhhhUtitleq4h }q5(h"]q6h$]q7h&]q8h(]q9h+]q:uh-Kh.hh]q;(csphinx.addnodes pending_xref q<)q=}q>(hX:mod:`circuits.tools`q?hh1hhhU pending_xrefq@h }qA(UreftypeqBXmodqCUrefwarnqDU reftargetqEXcircuits.toolsqFU refdomainqGXpyqHh(]qIh&]qJU refexplicitqKh"]qLh$]qMh+]qNUrefdocqOUapi/circuits_toolsqPUpy:classqQNU py:moduleqRNuh-Kh]qScdocutils.nodes literal qT)qU}qV(hh?h }qW(h"]qXh$]qY(UxrefqZhHXpy-modq[eh&]q\h(]q]h+]q^uhh=h]q_cdocutils.nodes Text q`Xcircuits.toolsqaqb}qc(hUhhUubahUliteralqdubaubh`X -- Development Toolsqeqf}qg(hX -- Development Toolsqhhh1ubeubcsphinx.addnodes index qi)qj}qk(hUhhhhhUindexqlh }qm(h(]qnh&]qoh"]qph$]qqh+]qrUentriesqs]qt(UsinglequXcircuits.tools (module)Xmodule-circuits.toolsUtqvauh-Kh.hh]qwubcdocutils.nodes paragraph qx)qy}qz(hXOften you will end up needing to do some debugging or inspection of your system. The `circuits.tools` package provides a set of development tools for debugging, inspection and analysis.q{hhhhhU paragraphq|h }q}(h"]q~h$]qh&]qh(]qh+]quh-Kh.hh]q(h`XUOften you will end up needing to do some debugging or inspection of your system. The qq}q(hXUOften you will end up needing to do some debugging or inspection of your system. The qhhyubcdocutils.nodes title_reference q)q}q(hX`circuits.tools`qh }q(h"]qh$]qh&]qh(]qh+]quhhyh]qh`Xcircuits.toolsqq}q(hUhhubahUtitle_referencequbh`XT package provides a set of development tools for debugging, inspection and analysis.qq}q(hXT package provides a set of development tools for debugging, inspection and analysis.qhhyubeubhi)q}q(hUhhhXY/home/prologic/work/circuits/circuits/tools/__init__.py:docstring of circuits.tools.graphqhhlh }q(h(]qh&]qh"]qh$]qh+]qUentriesq]q(huX"graph() (in module circuits.tools)hUtqauh-Nh.hh]qubcsphinx.addnodes desc q)q}q(hUhhhhhUdescqh }q(UnoindexqUdomainqXpyqh(]qh&]qh"]qh$]qh+]qUobjtypeqXfunctionqUdesctypeqhuh-Nh.hh]q(csphinx.addnodes desc_signature q)q}q(hXgraph(x, name=None)qhhhU qhUdesc_signatureqh }q(h(]qhaUmoduleqhXcircuits.toolsq…q}qbh&]qh"]qh$]qh+]qhaUfullnameqXgraphqUclassqUUfirstq̉uh-Nh.hh]q(csphinx.addnodes desc_addname q)q}q(hXcircuits.tools.qhhhhhU desc_addnameqh }q(h"]qh$]qh&]qh(]qh+]quh-Nh.hh]qh`Xcircuits.tools.qڅq}q(hUhhubaubcsphinx.addnodes desc_name q)q}q(hhhhhhhU desc_nameqh }q(h"]qh$]qh&]qh(]qh+]quh-Nh.hh]qh`Xgraphq腁q}q(hUhhubaubcsphinx.addnodes desc_parameterlist q)q}q(hUhhhhhUdesc_parameterlistqh }q(h"]qh$]qh&]qh(]qh+]quh-Nh.hh]q(csphinx.addnodes desc_parameter q)q}q(hXxh }q(h"]qh$]qh&]qh(]qh+]quhhh]qh`Xxr}r(hUhhubahUdesc_parameterrubh)r}r(hX name=Nonerh }r(h"]rh$]rh&]r h(]r h+]r uhhh]r h`X name=Noner r}r(hUhjubahjubeubeubcsphinx.addnodes desc_content r)r}r(hUhhhhhU desc_contentrh }r(h"]rh$]rh&]rh(]rh+]ruh-Nh.hh]r(hx)r}r(hX8Display a directed graph of the Component structure of xrhjhhhh|h }r(h"]rh$]r h&]r!h(]r"h+]r#uh-Kh.hh]r$h`X8Display a directed graph of the Component structure of xr%r&}r'(hjhjubaubcdocutils.nodes field_list r()r)}r*(hUhjhhhU field_listr+h }r,(h"]r-h$]r.h&]r/h(]r0h+]r1uh-Nh.hh]r2cdocutils.nodes field r3)r4}r5(hUh }r6(h"]r7h$]r8h&]r9h(]r:h+]r;uhj)h]r<(cdocutils.nodes field_name r=)r>}r?(hUh }r@(h"]rAh$]rBh&]rCh(]rDh+]rEuhj4h]rFh`X ParametersrGrH}rI(hUhj>ubahU field_namerJubcdocutils.nodes field_body rK)rL}rM(hUh }rN(h"]rOh$]rPh&]rQh(]rRh+]rSuhj4h]rTcdocutils.nodes bullet_list rU)rV}rW(hUh }rX(h"]rYh$]rZh&]r[h(]r\h+]r]uhjLh]r^(cdocutils.nodes list_item r_)r`}ra(hUh }rb(h"]rch$]rdh&]reh(]rfh+]rguhjVh]rhhx)ri}rj(hUh }rk(h"]rlh$]rmh&]rnh(]roh+]rpuhj`h]rq(cdocutils.nodes strong rr)rs}rt(hXxh }ru(h"]rvh$]rwh&]rxh(]ryh+]rzuhjih]r{h`Xxr|}r}(hUhjsubahUstrongr~ubh`X (rr}r(hUhjiubh<)r}r(hUh }r(UreftyperUobjrU reftargetrXComponent or ManagerrU refdomainrhh(]rh&]rU refexplicitrh"]rh$]rh+]ruhjih]rcdocutils.nodes emphasis r)r}r(hjh }r(h"]rh$]rh&]rh(]rh+]ruhjh]rh`XComponent or Managerrr}r(hUhjubahUemphasisrubahh@ubh`X)r}r(hUhjiubh`X -- rr}r(hUhjiubh`XA Component or Manager to graphrr}r(hXA Component or Manager to graphrhjiubehh|ubahU list_itemrubj_)r}r(hUh }r(h"]rh$]rh&]rh(]rh+]ruhjVh]rhx)r}r(hUh }r(h"]rh$]rh&]rh(]rh+]ruhjh]r(jr)r}r(hXnamerh }r(h"]rh$]rh&]rh(]rh+]ruhjh]rh`Xnamerr}r(hUhjubahj~ubh`X (rr}r(hUhjubh<)r}r(hUh }r(UreftyperjU reftargetrXstrrU refdomainrhh(]rh&]rU refexplicitrh"]rh$]rh+]ruhjh]rj)r}r(hjh }r(h"]rh$]rh&]rh(]rh+]ruhjh]rh`Xstrrr}r(hUhjubahjubahh@ubh`X)r}r(hUhjubh`X -- rr}r(hUhjubh`X+A name for the graph (defaults to x's name)rr}r(hX+A name for the graph (defaults to x's name)rhjubehh|ubahjubehU bullet_listrubahU field_bodyrubehUfieldrubaubhx)r}r(hXL@return: A directed graph representing x's Component sturcture. @rtype: strrhjhhhh|h }r(h"]rh$]rh&]rh(]rh+]ruh-K h.hh]rh`XL@return: A directed graph representing x's Component sturcture. @rtype: strrr}r(hjhjubaubeubeubeubahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr ]r h.hU current_liner NUtransform_messagesr ]r UreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsr NU toc_backlinksr!Uentryr"U language_coder#Uenr$U datestampr%NU report_levelr&KU _destinationr'NU halt_levelr(KU strip_classesr)Nh4NUerror_encoding_error_handlerr*Ubackslashreplacer+Udebugr,NUembed_stylesheetr-Uoutput_encoding_error_handlerr.Ustrictr/U sectnum_xformr0KUdump_transformsr1NU docinfo_xformr2KUwarning_streamr3NUpep_file_url_templater4Upep-%04dr5Uexit_status_levelr6KUconfigr7NUstrict_visitorr8NUcloak_email_addressesr9Utrim_footnote_reference_spacer:Uenvr;NUdump_pseudo_xmlr<NUexpose_internalsr=NUsectsubtitle_xformr>U source_linkr?NUrfc_referencesr@NUoutput_encodingrAUutf-8rBU source_urlrCNUinput_encodingrDU utf-8-sigrEU_disable_configrFNU id_prefixrGUU tab_widthrHKUerror_encodingrIU ISO-8859-1rJU_sourcerKU?/home/prologic/work/circuits/docs/source/api/circuits_tools.rstrLUgettext_compactrMU generatorrNNUdump_internalsrONU smart_quotesrPU pep_base_urlrQUhttp://www.python.org/dev/peps/rRUsyntax_highlightrSUlongrTUinput_encoding_error_handlerrUj/Uauto_id_prefixrVUidrWUdoctitle_xformrXUstrip_elements_with_classesrYNU _config_filesrZ]r[Ufile_insertion_enabledr\KU raw_enabledr]KU dump_settingsr^NubUsymbol_footnote_startr_KUidsr`}ra(hhh*cdocutils.nodes target rb)rc}rd(hUhhhhhUtargetreh }rf(h"]rgh(]rhh*ah&]riUismodrjh$]rkh+]rluh-Kh.hh]rmubhhuUsubstitution_namesrn}rohh.h }rp(h"]rqh(]rrh&]rsUsourcerthh$]ruh+]rvuU footnotesrw]rxUrefidsry}rzub.circuits-2.1.0/docs/build/doctrees/api/circuits_io_notify.doctree0000644000014400001440000034111312113366660024762 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNXcircuits.io.notify.MovedqX componentsqNXcircuits.io.notify.Accessedq Xcircuits.io.notify.Closedq Xcircuits.io.notify.Notifyq Xeventsq NXcircuits.io.notify.Deletedq Xcircuits.io.notify.UnmountedqXcircuits.io.notify.CreatedqXcircuits.io.notify.ModifiedqXcircuits.io.notify.OpenedqX.circuits.io.notify -- file system notificationqNuUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhhhU componentsqh h h h h h h Ueventsqh h hhhhhhhhhU+circuits-io-notify-file-system-notificationquUchildrenq ]q!cdocutils.nodes section q")q#}q$(U rawsourceq%UUparentq&hUsourceq'cdocutils.nodes reprunicode q(XC/home/prologic/work/circuits/docs/source/api/circuits_io_notify.rstq)q*}q+bUtagnameq,Usectionq-U attributesq.}q/(Udupnamesq0]q1Uclassesq2]q3Ubackrefsq4]q5Uidsq6]q7(Xmodule-circuits.io.notifyq8heUnamesq9]q:hauUlineq;KUdocumentq)q?}q@(h%X5:mod:`circuits.io.notify` -- File System NotificationqAh&h#h'h*h,UtitleqBh.}qC(h0]qDh2]qEh4]qFh6]qGh9]qHuh;Kh)q}q(h%XEventsqh&hh'h*h,hBh.}q(h0]qh2]qh4]qh6]qh9]quh;Khqh,Udesc_signatureqh.}q(h6]qh aUmoduleqh(Xcircuits.io.notifyq…q}qbh4]qh0]qh2]qh9]qh aUfullnameqXAccessedqUclassqUUfirstq̉uh;Nhr0h,U paragraphr1h.}r2(h0]r3h2]r4h4]r5h6]r6h9]r7uh;Kh(h%X#:class:`circuits.core.events.Event`r?h&j-h'h*h,hNh.}r@(UreftyperAXclassrBhRhSXcircuits.core.events.EventrCU refdomainrDXpyrEh6]rFh4]rGU refexplicitrHh0]rIh2]rJh9]rKh]h^h_hh`Xcircuits.io.notifyrLuh;Kh ]rMhb)rN}rO(h%j?h.}rP(h0]rQh2]rR(hhjEXpy-classrSeh4]rTh6]rUh9]rVuh&j=h ]rWhnXcircuits.core.events.EventrXrY}rZ(h%Uh&jNubah,hrubaubeubj,)r[}r\(h%XAccessed Eventr]h&j"h'X[/home/prologic/work/circuits/circuits/io/notify.py:docstring of circuits.io.notify.Accessedr^h,j1h.}r_(h0]r`h2]rah4]rbh6]rch9]rduh;Khuh&jh ]r?j,)r@}rA(h%Uh.}rB(h0]rCh2]rDh4]rEh6]rFh9]rGuh&j7h ]rH(hJ)rI}rJ(h%Uh.}rK(UreftyperLjU reftargetrMXvaluerNU refdomainrOhh6]rPh4]rQU refexplicitrRh0]rSh2]rTh9]rUuh&j@h ]rVj )rW}rX(h%jNh.}rY(h0]rZh2]r[h4]r\h6]r]h9]r^uh&jIh ]r_hnXvaluer`ra}rb(h%Uh&jWubah,jubah,hNubhnX -- rcrd}re(h%Uh&j@ubhnX this is a rfrg}rh(h%X this is a rih&j@ubhJ)rj}rk(h%X#:class:`circuits.core.values.Value`rlh&j@h'h*h,hNh.}rm(UreftypernXclassrohRhSXcircuits.core.values.ValuerpU refdomainrqXpyrrh6]rsh4]rtU refexplicitruh0]rvh2]rwh9]rxh]h^h_hh`jLuh;K!h ]ryhb)rz}r{(h%jlh.}r|(h0]r}h2]r~(hhjrXpy-classreh4]rh6]rh9]ruh&jjh ]rhnXcircuits.core.values.Valuerr}r(h%Uh&jzubah,hrubaubhnXN object that holds the results returned by the handlers invoked for the event.rr}r(h%XN object that holds the results returned by the handlers invoked for the event.rh&j@ubeh,j1ubah,j6ubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rj,)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]r(hJ)r}r(h%Uh.}r(UreftyperjU reftargetrXsuccessrU refdomainrhh6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jh ]rj )r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXsuccessrr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&jubhnX%if this optional attribute is set to rr}r(h%X%if this optional attribute is set to rh&jubhb)r}r(h%X``True``rh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXTruerr}r(h%Uh&jubah,hrubhnX, an associated event rr}r(h%X, an associated event rh&jubhb)r}r(h%X``EventSuccess``rh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnX EventSuccessrr}r(h%Uh&jubah,hrubhnX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(h%X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh&jubeh,j1ubah,j6ubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rj,)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]r(hJ)r}r(h%Uh.}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrhh6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jh ]rj )r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXsuccess_channelsr r }r (h%Uh&jubah,jubah,hNubhnX -- r r }r(h%Uh&jubhnXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h%Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh&jubeh,j1ubah,j6ubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rj,)r}r(h%Uh.}r(h0]rh2]r h4]r!h6]r"h9]r#uh&jh ]r$(hJ)r%}r&(h%Uh.}r'(Ureftyper(jU reftargetr)Xcompleter*U refdomainr+hh6]r,h4]r-U refexplicitr.h0]r/h2]r0h9]r1uh&jh ]r2j )r3}r4(h%j*h.}r5(h0]r6h2]r7h4]r8h6]r9h9]r:uh&j%h ]r;hnXcompleter<r=}r>(h%Uh&j3ubah,jubah,hNubhnX -- r?r@}rA(h%Uh&jubhnX%if this optional attribute is set to rBrC}rD(h%X%if this optional attribute is set to rEh&jubhb)rF}rG(h%X``True``rHh.}rI(h0]rJh2]rKh4]rLh6]rMh9]rNuh&jh ]rOhnXTruerPrQ}rR(h%Uh&jFubah,hrubhnX, an associated event rSrT}rU(h%X, an associated event rVh&jubhb)rW}rX(h%X``EventComplete``rYh.}rZ(h0]r[h2]r\h4]r]h6]r^h9]r_uh&jh ]r`hnX EventCompleterarb}rc(h%Uh&jWubah,hrubhnX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rdre}rf(h%X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rgh&jubeh,j1ubah,j6ubj)rh}ri(h%Uh.}rj(h0]rkh2]rlh4]rmh6]rnh9]rouh&jh ]rpj,)rq}rr(h%Uh.}rs(h0]rth2]ruh4]rvh6]rwh9]rxuh&jhh ]ry(hJ)rz}r{(h%Uh.}r|(Ureftyper}jU reftargetr~Xsuccess_channelsrU refdomainrhh6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jqh ]rj )r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jzh ]rhnXsuccess_channelsrr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&jqubhnXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h%Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh&jqubeh,j1ubah,j6ubeh,U bullet_listrubah,U field_bodyrubeh,Ufieldrubaubeubeubhw)r}r(h%Uh&hh'Nh,hzh.}r(h6]rh4]rh0]rh2]rh9]rUentriesr]r(hX$Closed (class in circuits.io.notify)h Utrauh;Nh}r?(h%Uh&j3ubah,hrubaubeubj,)r@}rA(h%X Closed EventrBh&j h'XY/home/prologic/work/circuits/circuits/io/notify.py:docstring of circuits.io.notify.ClosedrCh,j1h.}rD(h0]rEh2]rFh4]rGh6]rHh9]rIuh;Kh(h%Uh&jubhnX this is a r?r@}rA(h%X this is a rBh&jubhJ)rC}rD(h%X#:class:`circuits.core.values.Value`rEh&jh'h*h,hNh.}rF(UreftyperGXclassrHhRhSXcircuits.core.values.ValuerIU refdomainrJXpyrKh6]rLh4]rMU refexplicitrNh0]rOh2]rPh9]rQh]h^h_jh`jLuh;K!h ]rRhb)rS}rT(h%jEh.}rU(h0]rVh2]rW(hhjKXpy-classrXeh4]rYh6]rZh9]r[uh&jCh ]r\hnXcircuits.core.values.Valuer]r^}r_(h%Uh&jSubah,hrubaubhnXN object that holds the results returned by the handlers invoked for the event.r`ra}rb(h%XN object that holds the results returned by the handlers invoked for the event.rch&jubeh,j1ubah,j6ubj)rd}re(h%Uh.}rf(h0]rgh2]rhh4]rih6]rjh9]rkuh&jh ]rlj,)rm}rn(h%Uh.}ro(h0]rph2]rqh4]rrh6]rsh9]rtuh&jdh ]ru(hJ)rv}rw(h%Uh.}rx(UreftyperyjU reftargetrzXsuccessr{U refdomainr|jh6]r}h4]r~U refexplicitrh0]rh2]rh9]ruh&jmh ]rj )r}r(h%j{h.}r(h0]rh2]rh4]rh6]rh9]ruh&jvh ]rhnXsuccessrr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&jmubhnX%if this optional attribute is set to rr}r(h%X%if this optional attribute is set to rh&jmubhb)r}r(h%X``True``rh.}r(h0]rh2]rh4]rh6]rh9]ruh&jmh ]rhnXTruerr}r(h%Uh&jubah,hrubhnX, an associated event rr}r(h%X, an associated event rh&jmubhb)r}r(h%X``EventSuccess``rh.}r(h0]rh2]rh4]rh6]rh9]ruh&jmh ]rhnX EventSuccessrr}r(h%Uh&jubah,hrubhnX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(h%X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh&jmubeh,j1ubah,j6ubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rj,)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]r(hJ)r}r(h%Uh.}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrjh6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jh ]rj )r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXsuccess_channelsrr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&jubhnXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h%Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh&jubeh,j1ubah,j6ubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rj,)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]r(hJ)r}r(h%Uh.}r(UreftyperjU reftargetrXcompleterU refdomainrjh6]rh4]rU refexplicitrh0]rh2]r h9]r uh&jh ]r j )r }r (h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXcompleterr}r(h%Uh&j ubah,jubah,hNubhnX -- rr}r(h%Uh&jubhnX%if this optional attribute is set to rr}r(h%X%if this optional attribute is set to rh&jubhb)r}r (h%X``True``r!h.}r"(h0]r#h2]r$h4]r%h6]r&h9]r'uh&jh ]r(hnXTruer)r*}r+(h%Uh&jubah,hrubhnX, an associated event r,r-}r.(h%X, an associated event r/h&jubhb)r0}r1(h%X``EventComplete``r2h.}r3(h0]r4h2]r5h4]r6h6]r7h9]r8uh&jh ]r9hnX EventCompleter:r;}r<(h%Uh&j0ubah,hrubhnX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r=r>}r?(h%X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r@h&jubeh,j1ubah,j6ubj)rA}rB(h%Uh.}rC(h0]rDh2]rEh4]rFh6]rGh9]rHuh&jh ]rIj,)rJ}rK(h%Uh.}rL(h0]rMh2]rNh4]rOh6]rPh9]rQuh&jAh ]rR(hJ)rS}rT(h%Uh.}rU(UreftyperVjU reftargetrWXsuccess_channelsrXU refdomainrYjh6]rZh4]r[U refexplicitr\h0]r]h2]r^h9]r_uh&jJh ]r`j )ra}rb(h%jXh.}rc(h0]rdh2]reh4]rfh6]rgh9]rhuh&jSh ]rihnXsuccess_channelsrjrk}rl(h%Uh&jaubah,jubah,hNubhnX -- rmrn}ro(h%Uh&jJubhnXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rprq}rr(h%Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rsh&jJubeh,j1ubah,j6ubeh,jubah,jubeh,jubaubeubeubhw)rt}ru(h%Uh&hh'Nh,hzh.}rv(h6]rwh4]rxh0]ryh2]rzh9]r{Uentriesr|]r}(hX%Created (class in circuits.io.notify)hUtr~auh;Nh}r?(h%XEvery event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.r@h&jh'jh,j1h.}rA(h0]rBh2]rCh4]rDh6]rEh9]rFuh;K hubhJ)rL}rM(h%X :attr:`name`rNh&j>h'h*h,hNh.}rO(UreftyperPXattrrQhRhSXnamerRU refdomainrSXpyrTh6]rUh4]rVU refexplicitrWh0]rXh2]rYh9]rZh]h^h_jh`jLuh;Kh ]r[hb)r\}r](h%jNh.}r^(h0]r_h2]r`(hhjTXpy-attrraeh4]rbh6]rch9]rduh&jLh ]rehnXnamerfrg}rh(h%Uh&j\ubah,hrubaubhnX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rirj}rk(h%X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rlh&j>ubeubj)rm}rn(h%Uh&jh'Nh,jh.}ro(h0]rph2]rqh4]rrh6]rsh9]rtuh;Nhh4]r?h6]r@h9]rAuh&jh ]rBj,)rC}rD(h%Uh.}rE(h0]rFh2]rGh4]rHh6]rIh9]rJuh&j:h ]rK(hJ)rL}rM(h%Uh.}rN(UreftyperOjU reftargetrPXsuccessrQU refdomainrRjh6]rSh4]rTU refexplicitrUh0]rVh2]rWh9]rXuh&jCh ]rYj )rZ}r[(h%jQh.}r\(h0]r]h2]r^h4]r_h6]r`h9]rauh&jLh ]rbhnXsuccessrcrd}re(h%Uh&jZubah,jubah,hNubhnX -- rfrg}rh(h%Uh&jCubhnX%if this optional attribute is set to rirj}rk(h%X%if this optional attribute is set to rlh&jCubhb)rm}rn(h%X``True``roh.}rp(h0]rqh2]rrh4]rsh6]rth9]ruuh&jCh ]rvhnXTruerwrx}ry(h%Uh&jmubah,hrubhnX, an associated event rzr{}r|(h%X, an associated event r}h&jCubhb)r~}r(h%X``EventSuccess``rh.}r(h0]rh2]rh4]rh6]rh9]ruh&jCh ]rhnX EventSuccessrr}r(h%Uh&j~ubah,hrubhnX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(h%X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh&jCubeh,j1ubah,j6ubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rj,)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]r(hJ)r}r(h%Uh.}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrjh6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jh ]rj )r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXsuccess_channelsrr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&jubhnXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h%Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh&jubeh,j1ubah,j6ubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rj,)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]r(hJ)r}r(h%Uh.}r(UreftyperjU reftargetrXcompleterU refdomainrjh6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jh ]rj )r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXcompleterr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&jubhnX%if this optional attribute is set to rr}r(h%X%if this optional attribute is set to rh&jubhb)r}r(h%X``True``rh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXTruerr }r (h%Uh&jubah,hrubhnX, an associated event r r }r (h%X, an associated event r h&jubhb)r }r (h%X``EventComplete``r h.}r (h0]r h2]r h4]r h6]r h9]r uh&jh ]r hnX EventCompleter r }r (h%Uh&j ubah,hrubhnX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r r }r (h%X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r h&jubeh,j1ubah,j6ubj)r }r (h%Uh.}r (h0]r h2]r h4]r h6]r h9]r uh&jh ]r j,)r }r! (h%Uh.}r" (h0]r# h2]r$ h4]r% h6]r& h9]r' uh&j h ]r( (hJ)r) }r* (h%Uh.}r+ (Ureftyper, jU reftargetr- Xsuccess_channelsr. U refdomainr/ jh6]r0 h4]r1 U refexplicitr2 h0]r3 h2]r4 h9]r5 uh&j h ]r6 j )r7 }r8 (h%j. h.}r9 (h0]r: h2]r; h4]r< h6]r= h9]r> uh&j) h ]r? hnXsuccess_channelsr@ rA }rB (h%Uh&j7 ubah,jubah,hNubhnX -- rC rD }rE (h%Uh&j ubhnXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rF rG }rH (h%Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rI h&j ubeh,j1ubah,j6ubeh,jubah,jubeh,jubaubeubeubhw)rJ }rK (h%Uh&hh'Nh,hzh.}rL (h6]rM h4]rN h0]rO h2]rP h9]rQ UentriesrR ]rS (hX%Deleted (class in circuits.io.notify)h UtrT auh;Nh (h%Uh&j2 ubah,hrubaubhnX attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.r? r@ }rA (h%X attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event.rB h&j ubeubj)rC }rD (h%Uh&j h'Nh,jh.}rE (h0]rF h2]rG h4]rH h6]rI h9]rJ uh;Nh (h%Uh&j ubhnX%if this optional attribute is set to r? r@ }rA (h%X%if this optional attribute is set to rB h&j ubhb)rC }rD (h%X``True``rE h.}rF (h0]rG h2]rH h4]rI h6]rJ h9]rK uh&j h ]rL hnXTruerM rN }rO (h%Uh&jC ubah,hrubhnX, an associated event rP rQ }rR (h%X, an associated event rS h&j ubhb)rT }rU (h%X``EventSuccess``rV h.}rW (h0]rX h2]rY h4]rZ h6]r[ h9]r\ uh&j h ]r] hnX EventSuccessr^ r_ }r` (h%Uh&jT ubah,hrubhnX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.ra rb }rc (h%X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rd h&j ubeh,j1ubah,j6ubj)re }rf (h%Uh.}rg (h0]rh h2]ri h4]rj h6]rk h9]rl uh&jj h ]rm j,)rn }ro (h%Uh.}rp (h0]rq h2]rr h4]rs h6]rt h9]ru uh&je h ]rv (hJ)rw }rx (h%Uh.}ry (Ureftyperz jU reftargetr{ Xsuccess_channelsr| U refdomainr} jY h6]r~ h4]r U refexplicitr h0]r h2]r h9]r uh&jn h ]r j )r }r (h%j| h.}r (h0]r h2]r h4]r h6]r h9]r uh&jw h ]r hnXsuccess_channelsr r }r (h%Uh&j ubah,jubah,hNubhnX -- r r }r (h%Uh&jn ubhnXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r r }r (h%Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r h&jn ubeh,j1ubah,j6ubj)r }r (h%Uh.}r (h0]r h2]r h4]r h6]r h9]r uh&jj h ]r j,)r }r (h%Uh.}r (h0]r h2]r h4]r h6]r h9]r uh&j h ]r (hJ)r }r (h%Uh.}r (Ureftyper jU reftargetr Xcompleter U refdomainr jY h6]r h4]r U refexplicitr h0]r h2]r h9]r uh&j h ]r j )r }r (h%j h.}r (h0]r h2]r h4]r h6]r h9]r uh&j h ]r hnXcompleter r }r (h%Uh&j ubah,jubah,hNubhnX -- r r }r (h%Uh&j ubhnX%if this optional attribute is set to r r }r (h%X%if this optional attribute is set to r h&j ubhb)r }r (h%X``True``r h.}r (h0]r h2]r h4]r h6]r h9]r uh&j h ]r hnXTruer r }r (h%Uh&j ubah,hrubhnX, an associated event r r }r (h%X, an associated event r h&j ubhb)r }r (h%X``EventComplete``r h.}r (h0]r h2]r h4]r h6]r h9]r uh&j h ]r hnX EventCompleter r }r (h%Uh&j ubah,hrubhnX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r r }r (h%X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.r h&j ubeh,j1ubah,j6ubj)r }r (h%Uh.}r (h0]r h2]r h4]r h6]r h9]r uh&jj h ]r j,)r }r (h%Uh.}r (h0]r h2]r h4]r h6]r h9]r uh&j h ]r (hJ)r }r (h%Uh.}r (Ureftyper jU reftargetr Xsuccess_channelsr U refdomainr jY h6]r h4]r U refexplicitr h0]r h2]r h9]r uh&j h ]r j )r }r (h%j h.}r (h0]r h2]r h4]r h6]r h9]r uh&j h ]r hnXsuccess_channelsr r }r (h%Uh&j ubah,jubah,hNubhnX -- r r }r (h%Uh&j ubhnXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r r }r (h%Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r h&j ubeh,j1ubah,j6ubeh,jubah,jubeh,jubaubeubeubhw)r }r! (h%Uh&hh'Nh,hzh.}r" (h6]r# h4]r$ h0]r% h2]r& h9]r' Uentriesr( ]r) (hX&Modified (class in circuits.io.notify)hUtr* auh;Nh bh4]r? h0]r@ h2]rA h9]rB hahXModifiedrC hUh̉uh;Nh uh&j" h ]r? j)r@ }rA (h%Uh.}rB (h0]rC h2]rD h4]rE h6]rF h9]rG uh&j7 h ]rH (j)rI }rJ (h%Uh.}rK (h0]rL h2]rM h4]rN h6]rO h9]rP uh&j@ h ]rQ j,)rR }rS (h%Uh.}rT (h0]rU h2]rV h4]rW h6]rX h9]rY uh&jI h ]rZ (hJ)r[ }r\ (h%Uh.}r] (Ureftyper^ jU reftargetr_ Xchannelsr` U refdomainra j/ h6]rb h4]rc U refexplicitrd h0]re h2]rf h9]rg uh&jR h ]rh j )ri }rj (h%j` h.}rk (h0]rl h2]rm h4]rn h6]ro h9]rp uh&j[ h ]rq hnXchannelsrr rs }rt (h%Uh&ji ubah,jubah,hNubhnX -- ru rv }rw (h%Uh&jR ubj,)rx }ry (h%Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rz h&jR h'j h,j1h.}r{ (h0]r| h2]r} h4]r~ h6]r h9]r uh;Kh ]r hnXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.r r }r (h%jz h&jx ubaubj,)r }r (h%XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r h&jR h'j h,j1h.}r (h0]r h2]r h4]r h6]r h9]r uh;Kh ]r hnXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r r }r (h%j h&j ubaubeh,j1ubah,j6ubj)r }r (h%Uh.}r (h0]r h2]r h4]r h6]r h9]r uh&j@ h ]r j,)r }r (h%Uh.}r (h0]r h2]r h4]r h6]r h9]r uh&j h ]r (hJ)r }r (h%Uh.}r (Ureftyper jU reftargetr Xvaluer U refdomainr j/ h6]r h4]r U refexplicitr h0]r h2]r h9]r uh&j h ]r j )r }r (h%j h.}r (h0]r h2]r h4]r h6]r h9]r uh&j h ]r hnXvaluer r }r (h%Uh&j ubah,jubah,hNubhnX -- r r }r (h%Uh&j ubhnX this is a r r }r (h%X this is a r h&j ubhJ)r }r (h%X#:class:`circuits.core.values.Value`r h&j h'h*h,hNh.}r (Ureftyper Xclassr hRhSXcircuits.core.values.Valuer U refdomainr Xpyr h6]r h4]r U refexplicitr h0]r h2]r h9]r h]h^h_jC h`jLuh;K!h ]r hb)r }r (h%j h.}r (h0]r h2]r (hhj Xpy-classr eh4]r h6]r h9]r uh&j h ]r hnXcircuits.core.values.Valuer r }r (h%Uh&j ubah,hrubaubhnXN object that holds the results returned by the handlers invoked for the event.r r }r (h%XN object that holds the results returned by the handlers invoked for the event.r h&j ubeh,j1ubah,j6ubj)r }r (h%Uh.}r (h0]r h2]r h4]r h6]r h9]r uh&j@ h ]r j,)r }r (h%Uh.}r (h0]r h2]r h4]r h6]r h9]r uh&j h ]r (hJ)r }r (h%Uh.}r (Ureftyper jU reftargetr Xsuccessr U refdomainr j/ h6]r h4]rU refexplicitrh0]rh2]rh9]ruh&j h ]rj )r}r(h%j h.}r(h0]r h2]r h4]r h6]r h9]r uh&j h ]rhnXsuccessrr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&j ubhnX%if this optional attribute is set to rr}r(h%X%if this optional attribute is set to rh&j ubhb)r}r(h%X``True``rh.}r(h0]rh2]rh4]rh6]r h9]r!uh&j h ]r"hnXTruer#r$}r%(h%Uh&jubah,hrubhnX, an associated event r&r'}r((h%X, an associated event r)h&j ubhb)r*}r+(h%X``EventSuccess``r,h.}r-(h0]r.h2]r/h4]r0h6]r1h9]r2uh&j h ]r3hnX EventSuccessr4r5}r6(h%Uh&j*ubah,hrubhnX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.r7r8}r9(h%X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.r:h&j ubeh,j1ubah,j6ubj)r;}r<(h%Uh.}r=(h0]r>h2]r?h4]r@h6]rAh9]rBuh&j@ h ]rCj,)rD}rE(h%Uh.}rF(h0]rGh2]rHh4]rIh6]rJh9]rKuh&j;h ]rL(hJ)rM}rN(h%Uh.}rO(UreftyperPjU reftargetrQXsuccess_channelsrRU refdomainrSj/ h6]rTh4]rUU refexplicitrVh0]rWh2]rXh9]rYuh&jDh ]rZj )r[}r\(h%jRh.}r](h0]r^h2]r_h4]r`h6]rah9]rbuh&jMh ]rchnXsuccess_channelsrdre}rf(h%Uh&j[ubah,jubah,hNubhnX -- rgrh}ri(h%Uh&jDubhnXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rjrk}rl(h%Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rmh&jDubeh,j1ubah,j6ubj)rn}ro(h%Uh.}rp(h0]rqh2]rrh4]rsh6]rth9]ruuh&j@ h ]rvj,)rw}rx(h%Uh.}ry(h0]rzh2]r{h4]r|h6]r}h9]r~uh&jnh ]r(hJ)r}r(h%Uh.}r(UreftyperjU reftargetrXcompleterU refdomainrj/ h6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jwh ]rj )r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXcompleterr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&jwubhnX%if this optional attribute is set to rr}r(h%X%if this optional attribute is set to rh&jwubhb)r}r(h%X``True``rh.}r(h0]rh2]rh4]rh6]rh9]ruh&jwh ]rhnXTruerr}r(h%Uh&jubah,hrubhnX, an associated event rr}r(h%X, an associated event rh&jwubhb)r}r(h%X``EventComplete``rh.}r(h0]rh2]rh4]rh6]rh9]ruh&jwh ]rhnX EventCompleterr}r(h%Uh&jubah,hrubhnX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rr}r(h%X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rh&jwubeh,j1ubah,j6ubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&j@ h ]rj,)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]r(hJ)r}r(h%Uh.}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrj/ h6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jh ]rj )r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXsuccess_channelsrr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&jubhnXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h%Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh&jubeh,j1ubah,j6ubeh,jubah,jubeh,jubaubeubeubhw)r}r(h%Uh&hh'Nh,hzh.}r(h6]rh4]rh0]rh2]rh9]rUentriesr]r(hX#Moved (class in circuits.io.notify)hUtrauh;Nhr?}r@(h%Uh&j5ubaubh)rA}rB(h%Uh&j h'hh,hh.}rC(h0]rDh2]rEh4]rFh6]rGh9]rHuh;Nhj )r?}r@(h%j6h.}rA(h0]rBh2]rCh4]rDh6]rEh9]rFuh&j1h ]rGhnXchannelsrHrI}rJ(h%Uh&j?ubah,jubah,hNubhnX -- rKrL}rM(h%Uh&j(ubj,)rN}rO(h%Xan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rPh&j(h'jh,j1h.}rQ(h0]rRh2]rSh4]rTh6]rUh9]rVuh;Kh ]rWhnXan optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel.rXrY}rZ(h%jPh&jNubaubj,)r[}r\(h%XWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.r]h&j(h'jh,j1h.}r^(h0]r_h2]r`h4]rah6]rbh9]rcuh;Kh ]rdhnXWhen an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.rerf}rg(h%j]h&j[ubaubeh,j1ubah,j6ubj)rh}ri(h%Uh.}rj(h0]rkh2]rlh4]rmh6]rnh9]rouh&jh ]rpj,)rq}rr(h%Uh.}rs(h0]rth2]ruh4]rvh6]rwh9]rxuh&jhh ]ry(hJ)rz}r{(h%Uh.}r|(Ureftyper}jU reftargetr~XvaluerU refdomainrjh6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jqh ]rj )r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jzh ]rhnXvaluerr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&jqubhnX this is a rr}r(h%X this is a rh&jqubhJ)r}r(h%X#:class:`circuits.core.values.Value`rh&jqh'h*h,hNh.}r(UreftyperXclassrhRhSXcircuits.core.values.ValuerU refdomainrXpyrh6]rh4]rU refexplicitrh0]rh2]rh9]rh]h^h_jh`jLuh;K!h ]rhb)r}r(h%jh.}r(h0]rh2]r(hhjXpy-classreh4]rh6]rh9]ruh&jh ]rhnXcircuits.core.values.Valuerr}r(h%Uh&jubah,hrubaubhnXN object that holds the results returned by the handlers invoked for the event.rr}r(h%XN object that holds the results returned by the handlers invoked for the event.rh&jqubeh,j1ubah,j6ubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rj,)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]r(hJ)r}r(h%Uh.}r(UreftyperjU reftargetrXsuccessrU refdomainrjh6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jh ]rj )r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXsuccessrr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&jubhnX%if this optional attribute is set to rr}r(h%X%if this optional attribute is set to rh&jubhb)r}r(h%X``True``rh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXTruerr}r(h%Uh&jubah,hrubhnX, an associated event rr}r(h%X, an associated event rh&jubhb)r}r(h%X``EventSuccess``rh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]r hnX EventSuccessr r }r (h%Uh&jubah,hrubhnX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.r r}r(h%X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh&jubeh,j1ubah,j6ubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rj,)r}r(h%Uh.}r(h0]rh2]rh4]rh6]r h9]r!uh&jh ]r"(hJ)r#}r$(h%Uh.}r%(Ureftyper&jU reftargetr'Xsuccess_channelsr(U refdomainr)jh6]r*h4]r+U refexplicitr,h0]r-h2]r.h9]r/uh&jh ]r0j )r1}r2(h%j(h.}r3(h0]r4h2]r5h4]r6h6]r7h9]r8uh&j#h ]r9hnXsuccess_channelsr:r;}r<(h%Uh&j1ubah,jubah,hNubhnX -- r=r>}r?(h%Uh&jubhnXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.r@rA}rB(h%Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rCh&jubeh,j1ubah,j6ubj)rD}rE(h%Uh.}rF(h0]rGh2]rHh4]rIh6]rJh9]rKuh&jh ]rLj,)rM}rN(h%Uh.}rO(h0]rPh2]rQh4]rRh6]rSh9]rTuh&jDh ]rU(hJ)rV}rW(h%Uh.}rX(UreftyperYjU reftargetrZXcompleter[U refdomainr\jh6]r]h4]r^U refexplicitr_h0]r`h2]rah9]rbuh&jMh ]rcj )rd}re(h%j[h.}rf(h0]rgh2]rhh4]rih6]rjh9]rkuh&jVh ]rlhnXcompletermrn}ro(h%Uh&jdubah,jubah,hNubhnX -- rprq}rr(h%Uh&jMubhnX%if this optional attribute is set to rsrt}ru(h%X%if this optional attribute is set to rvh&jMubhb)rw}rx(h%X``True``ryh.}rz(h0]r{h2]r|h4]r}h6]r~h9]ruh&jMh ]rhnXTruerr}r(h%Uh&jwubah,hrubhnX, an associated event rr}r(h%X, an associated event rh&jMubhb)r}r(h%X``EventComplete``rh.}r(h0]rh2]rh4]rh6]rh9]ruh&jMh ]rhnX EventCompleterr}r(h%Uh&jubah,hrubhnX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rr}r(h%X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rh&jMubeh,j1ubah,j6ubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rj,)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]r(hJ)r}r(h%Uh.}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrjh6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jh ]rj )r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXsuccess_channelsrr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&jubhnXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h%Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh&jubeh,j1ubah,j6ubeh,jubah,jubeh,jubaubeubeubhw)r}r(h%Uh&hh'Nh,hzh.}r(h6]rh4]rh0]rh2]rh9]rUentriesr]r(hX$Opened (class in circuits.io.notify)hUtrauh;Nhh4]r?h6]r@h9]rAuh;Nh}r?(h%Uh.}r@(h0]rAh2]rBh4]rCh6]rDh9]rEuh&jh ]rFj,)rG}rH(h%Uh.}rI(h0]rJh2]rKh4]rLh6]rMh9]rNuh&j>h ]rO(hJ)rP}rQ(h%Uh.}rR(UreftyperSjU reftargetrTXvaluerUU refdomainrVjh6]rWh4]rXU refexplicitrYh0]rZh2]r[h9]r\uh&jGh ]r]j )r^}r_(h%jUh.}r`(h0]rah2]rbh4]rch6]rdh9]reuh&jPh ]rfhnXvaluergrh}ri(h%Uh&j^ubah,jubah,hNubhnX -- rjrk}rl(h%Uh&jGubhnX this is a rmrn}ro(h%X this is a rph&jGubhJ)rq}rr(h%X#:class:`circuits.core.values.Value`rsh&jGh'h*h,hNh.}rt(UreftyperuXclassrvhRhSXcircuits.core.values.ValuerwU refdomainrxXpyryh6]rzh4]r{U refexplicitr|h0]r}h2]r~h9]rh]h^h_jh`jLuh;K!h ]rhb)r}r(h%jsh.}r(h0]rh2]r(hhjyXpy-classreh4]rh6]rh9]ruh&jqh ]rhnXcircuits.core.values.Valuerr}r(h%Uh&jubah,hrubaubhnXN object that holds the results returned by the handlers invoked for the event.rr}r(h%XN object that holds the results returned by the handlers invoked for the event.rh&jGubeh,j1ubah,j6ubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rj,)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]r(hJ)r}r(h%Uh.}r(UreftyperjU reftargetrXsuccessrU refdomainrjh6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jh ]rj )r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXsuccessrr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&jubhnX%if this optional attribute is set to rr}r(h%X%if this optional attribute is set to rh&jubhb)r}r(h%X``True``rh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXTruerr}r(h%Uh&jubah,hrubhnX, an associated event rr}r(h%X, an associated event rh&jubhb)r}r(h%X``EventSuccess``rh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnX EventSuccessrr}r(h%Uh&jubah,hrubhnX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(h%X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh&jubeh,j1ubah,j6ubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rj,)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]r(hJ)r}r(h%Uh.}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrjh6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jh ]rj )r}r(h%jh.}r (h0]r h2]r h4]r h6]r h9]ruh&jh ]rhnXsuccess_channelsrr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&jubhnXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h%Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh&jubeh,j1ubah,j6ubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]r h9]r!uh&jh ]r"j,)r#}r$(h%Uh.}r%(h0]r&h2]r'h4]r(h6]r)h9]r*uh&jh ]r+(hJ)r,}r-(h%Uh.}r.(Ureftyper/jU reftargetr0Xcompleter1U refdomainr2jh6]r3h4]r4U refexplicitr5h0]r6h2]r7h9]r8uh&j#h ]r9j )r:}r;(h%j1h.}r<(h0]r=h2]r>h4]r?h6]r@h9]rAuh&j,h ]rBhnXcompleterCrD}rE(h%Uh&j:ubah,jubah,hNubhnX -- rFrG}rH(h%Uh&j#ubhnX%if this optional attribute is set to rIrJ}rK(h%X%if this optional attribute is set to rLh&j#ubhb)rM}rN(h%X``True``rOh.}rP(h0]rQh2]rRh4]rSh6]rTh9]rUuh&j#h ]rVhnXTruerWrX}rY(h%Uh&jMubah,hrubhnX, an associated event rZr[}r\(h%X, an associated event r]h&j#ubhb)r^}r_(h%X``EventComplete``r`h.}ra(h0]rbh2]rch4]rdh6]reh9]rfuh&j#h ]rghnX EventCompleterhri}rj(h%Uh&j^ubah,hrubhnX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rkrl}rm(h%X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rnh&j#ubeh,j1ubah,j6ubj)ro}rp(h%Uh.}rq(h0]rrh2]rsh4]rth6]ruh9]rvuh&jh ]rwj,)rx}ry(h%Uh.}rz(h0]r{h2]r|h4]r}h6]r~h9]ruh&joh ]r(hJ)r}r(h%Uh.}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrjh6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jxh ]rj )r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXsuccess_channelsrr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&jxubhnXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h%Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh&jxubeh,j1ubah,j6ubeh,jubah,jubeh,jubaubeubeubhw)r}r(h%Uh&hh'Nh,hzh.}r(h6]rh4]rh0]rh2]rh9]rUentriesr]r(hX'Unmounted (class in circuits.io.notify)hUtrauh;Nhh9]r?uh&j'h ]r@hnXcircuits.core.events.EventrArB}rC(h%Uh&j7ubah,hrubaubeubj,)rD}rE(h%XUnmounted EventrFh&jh'X\/home/prologic/work/circuits/circuits/io/notify.py:docstring of circuits.io.notify.UnmountedrGh,j1h.}rH(h0]rIh2]rJh4]rKh6]rLh9]rMuh;Kh}r?(h%Uh&j4ubah,jubah,hNubhnX -- r@rA}rB(h%Uh&jubhnX this is a rCrD}rE(h%X this is a rFh&jubhJ)rG}rH(h%X#:class:`circuits.core.values.Value`rIh&jh'h*h,hNh.}rJ(UreftyperKXclassrLhRhSXcircuits.core.values.ValuerMU refdomainrNXpyrOh6]rPh4]rQU refexplicitrRh0]rSh2]rTh9]rUh]h^h_jh`jLuh;K!h ]rVhb)rW}rX(h%jIh.}rY(h0]rZh2]r[(hhjOXpy-classr\eh4]r]h6]r^h9]r_uh&jGh ]r`hnXcircuits.core.values.Valuerarb}rc(h%Uh&jWubah,hrubaubhnXN object that holds the results returned by the handlers invoked for the event.rdre}rf(h%XN object that holds the results returned by the handlers invoked for the event.rgh&jubeh,j1ubah,j6ubj)rh}ri(h%Uh.}rj(h0]rkh2]rlh4]rmh6]rnh9]rouh&jh ]rpj,)rq}rr(h%Uh.}rs(h0]rth2]ruh4]rvh6]rwh9]rxuh&jhh ]ry(hJ)rz}r{(h%Uh.}r|(Ureftyper}jU reftargetr~XsuccessrU refdomainrjh6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jqh ]rj )r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jzh ]rhnXsuccessrr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&jqubhnX%if this optional attribute is set to rr}r(h%X%if this optional attribute is set to rh&jqubhb)r}r(h%X``True``rh.}r(h0]rh2]rh4]rh6]rh9]ruh&jqh ]rhnXTruerr}r(h%Uh&jubah,hrubhnX, an associated event rr}r(h%X, an associated event rh&jqubhb)r}r(h%X``EventSuccess``rh.}r(h0]rh2]rh4]rh6]rh9]ruh&jqh ]rhnX EventSuccessrr}r(h%Uh&jubah,hrubhnX (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rr}r(h%X (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully.rh&jqubeh,j1ubah,j6ubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rj,)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]r(hJ)r}r(h%Uh.}r(UreftyperjU reftargetrXsuccess_channelsrU refdomainrjh6]rh4]rU refexplicitrh0]rh2]rh9]ruh&jh ]rj )r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXsuccess_channelsrr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&jubhnXthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rr}r(h%Xthe success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rh&jubeh,j1ubah,j6ubj)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rj,)r}r(h%Uh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]r(hJ)r}r(h%Uh.}r(UreftyperjU reftargetrXcompleterU refdomainrjh6]r h4]r U refexplicitr h0]r h2]r h9]ruh&jh ]rj )r}r(h%jh.}r(h0]rh2]rh4]rh6]rh9]ruh&jh ]rhnXcompleterr}r(h%Uh&jubah,jubah,hNubhnX -- rr}r(h%Uh&jubhnX%if this optional attribute is set to rr }r!(h%X%if this optional attribute is set to r"h&jubhb)r#}r$(h%X``True``r%h.}r&(h0]r'h2]r(h4]r)h6]r*h9]r+uh&jh ]r,hnXTruer-r.}r/(h%Uh&j#ubah,hrubhnX, an associated event r0r1}r2(h%X, an associated event r3h&jubhb)r4}r5(h%X``EventComplete``r6h.}r7(h0]r8h2]r9h4]r:h6]r;h9]r<uh&jh ]r=hnX EventCompleter>r?}r@(h%Uh&j4ubah,hrubhnX (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rArB}rC(h%X (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.rDh&jubeh,j1ubah,j6ubj)rE}rF(h%Uh.}rG(h0]rHh2]rIh4]rJh6]rKh9]rLuh&jh ]rMj,)rN}rO(h%Uh.}rP(h0]rQh2]rRh4]rSh6]rTh9]rUuh&jEh ]rV(hJ)rW}rX(h%Uh.}rY(UreftyperZjU reftargetr[Xsuccess_channelsr\U refdomainr]jh6]r^h4]r_U refexplicitr`h0]rah2]rbh9]rcuh&jNh ]rdj )re}rf(h%j\h.}rg(h0]rhh2]rih4]rjh6]rkh9]rluh&jWh ]rmhnXsuccess_channelsrnro}rp(h%Uh&jeubah,jubah,hNubhnX -- rqrr}rs(h%Uh&jNubhnXthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rtru}rv(h%Xthe complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.rwh&jNubeh,j1ubah,j6ubeh,jubah,jubeh,jubaubeubeubeubh")rx}ry(h%Uh&h#h'h*h,h-h.}rz(h0]r{h2]r|h4]r}h6]r~hah9]rhauh;K$h)r}r(h%X Componentsrh&jxh'h*h,hBh.}r(h0]rh2]rh4]rh6]rh9]ruh;K$h)r,}r-(h%X Functionsr.h&j#h'h*h,hBh.}r/(h0]r0h2]r1h4]r2h6]r3h9]r4uh;K+h]r?Uautofootnote_refsr@]rAUsymbol_footnote_refsrB]rCU citationsrD]rEhhh0hhhU pending_xrefq?h}q@(UreftypeqAXmodqBUrefwarnqCU reftargetqDX circuits.appqEU refdomainqFXpyqGh']qHh%]qIU refexplicitqJh!]qKh#]qLh*]qMUrefdocqNUapi/circuits_appqOUpy:classqPNU py:moduleqQNuh,Kh]qRcdocutils.nodes literal qS)qT}qU(hh>h}qV(h!]qWh#]qX(UxrefqYhGXpy-modqZeh%]q[h']q\h*]q]uhhqkhUindexqlh}qm(h']qnh%]qoh!]qph#]qqh*]qrUentriesqs]qt(UsinglequXcircuits.app (module)Xmodule-circuits.appUtqvauh,Kh-hh]qwubcdocutils.nodes paragraph qx)qy}qz(hXApplication Componentsq{hhhXO/home/prologic/work/circuits/circuits/app/__init__.py:docstring of circuits.appq|hU paragraphq}h}q~(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_XApplication Componentsqq}q(hh{hhyubaubhx)q}q(hX`Contains various components useful for application development and tasks common to applications.qhhhh|hh}h}q(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_X`Contains various components useful for application development and tasks common to applications.qq}q(hhhhubaubcdocutils.nodes field_list q)q}q(hUhhhh|hU field_listqh}q(h!]qh#]qh%]qh']qh*]quh,Kh-hh]q(cdocutils.nodes field q)q}q(hUhhhh|hUfieldqh}q(h!]qh#]qh%]qh']qh*]quh,Kh-hh]q(cdocutils.nodes field_name q)q}q(hX copyrightqh}q(h!]qh#]qh%]qh']qh*]quhhh]qh_X copyrightqq}q(hhhhubahU field_namequbcdocutils.nodes field_body q)q}q(hX&CopyRight (C) 2004-2012 by James Millsqh}q(h!]qh#]qh%]qh']qh*]quhhh]qhx)q}q(hhhhhh|hh}h}q(h!]qh#]qh%]qh']qh*]quh,Kh]qh_X&CopyRight (C) 2004-2012 by James Millsq΅q}q(hhhhubaubahU field_bodyqubeubh)q}q(hUhhhh|hhh}q(h!]qh#]qh%]qh']qh*]quh,Kh-hh]q(h)q}q(hXlicenseqh}q(h!]qh#]qh%]qh']qh*]quhhh]qh_Xlicenseq允q}q(hhhhubahhubh)q}q(hXMIT (See: LICENSE) qh}q(h!]qh#]qh%]qh']qh*]quhhh]qhx)q}q(hXMIT (See: LICENSE)qhhhh|hh}h}q(h!]qh#]qh%]qh']qh*]quh,Kh]qh_XMIT (See: LICENSE)qq}q(hhhhubaubahhubeubeubcdocutils.nodes compound q)r}r(hUhhhhhUcompoundrh}r(h!]rh#]rUtoctree-wrapperrah%]rh']rh*]r uh,Nh-hh]r csphinx.addnodes toctree r )r }r (hUhjhhhUtoctreerh}r(UnumberedrKhhOU titlesonlyrUglobrh']rh%]rh!]rh#]rh*]rUentriesr]r(NUapi/circuits_app_configrrNUapi/circuits_app_daemonrrNUapi/circuits_app_envrrNUapi/circuits_app_logr r!eUhiddenr"U includefilesr#]r$(jjjj eUmaxdepthr%Kuh,Kh]r&ubaubeubahUU transformerr'NU footnote_refsr(}r)Urefnamesr*}r+Usymbol_footnotesr,]r-Uautofootnote_refsr.]r/Usymbol_footnote_refsr0]r1U citationsr2]r3h-hU current_liner4NUtransform_messagesr5]r6Ureporterr7NUid_startr8KU autofootnotesr9]r:U citation_refsr;}r<Uindirect_targetsr=]r>Usettingsr?(cdocutils.frontend Values r@orA}rB(Ufootnote_backlinksrCKUrecord_dependenciesrDNU rfc_base_urlrEUhttp://tools.ietf.org/html/rFU tracebackrGUpep_referencesrHNUstrip_commentsrINU toc_backlinksrJUentryrKU language_coderLUenrMU datestamprNNU report_levelrOKU _destinationrPNU halt_levelrQKU strip_classesrRNh3NUerror_encoding_error_handlerrSUbackslashreplacerTUdebugrUNUembed_stylesheetrVUoutput_encoding_error_handlerrWUstrictrXU sectnum_xformrYKUdump_transformsrZNU docinfo_xformr[KUwarning_streamr\NUpep_file_url_templater]Upep-%04dr^Uexit_status_levelr_KUconfigr`NUstrict_visitorraNUcloak_email_addressesrbUtrim_footnote_reference_spacercUenvrdNUdump_pseudo_xmlreNUexpose_internalsrfNUsectsubtitle_xformrgU source_linkrhNUrfc_referencesriNUoutput_encodingrjUutf-8rkU source_urlrlNUinput_encodingrmU utf-8-sigrnU_disable_configroNU id_prefixrpUU tab_widthrqKUerror_encodingrrU ISO-8859-1rsU_sourcertU=/home/prologic/work/circuits/docs/source/api/circuits_app.rstruUgettext_compactrvU generatorrwNUdump_internalsrxNU smart_quotesryU pep_base_urlrzUhttp://www.python.org/dev/peps/r{Usyntax_highlightr|Ulongr}Uinput_encoding_error_handlerr~jXUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(h)cdocutils.nodes target r)r}r(hUhhhhkhUtargetrh}r(h!]rh']rh)ah%]rUismodrh#]rh*]ruh,Kh-hh]rubhhuUsubstitution_namesr}rhh-h}r(h!]rh']rh%]rUsourcerhh#]rh*]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_net.doctree0000644000014400001440000001376512113366660023562 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qXcircuits.net -- networkingqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhUcircuits-net-networkingqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX=/home/prologic/work/circuits/docs/source/api/circuits_net.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q((Xmodule-circuits.netq)heUnamesq*]q+hauUlineq,KUdocumentq-hh]q.(cdocutils.nodes title q/)q0}q1(hX!:mod:`circuits.net` -- Networkingq2hhhhhUtitleq3h}q4(h!]q5h#]q6h%]q7h']q8h*]q9uh,Kh-hh]q:(csphinx.addnodes pending_xref q;)q<}q=(hX:mod:`circuits.net`q>hh0hhhU pending_xrefq?h}q@(UreftypeqAXmodqBUrefwarnqCU reftargetqDX circuits.netqEU refdomainqFXpyqGh']qHh%]qIU refexplicitqJh!]qKh#]qLh*]qMUrefdocqNUapi/circuits_netqOUpy:classqPNU py:moduleqQNuh,Kh]qRcdocutils.nodes literal qS)qT}qU(hh>h}qV(h!]qWh#]qX(UxrefqYhGXpy-modqZeh%]q[h']q\h*]q]uhhqkhUindexqlh}qm(h']qnh%]qoh!]qph#]qqh*]qrUentriesqs]qt(UsinglequXcircuits.net (module)Xmodule-circuits.netUtqvauh,Kh-hh]qwubcdocutils.nodes paragraph qx)qy}qz(hXNetworking Componentsq{hhhXO/home/prologic/work/circuits/circuits/net/__init__.py:docstring of circuits.netq|hU paragraphq}h}q~(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_XNetworking Componentsqq}q(hh{hhyubaubhx)q}q(hXThis package contains components that implement network sockets and protocols for implementing client and server network applications.qhhhh|hh}h}q(h!]qh#]qh%]qh']qh*]quh,Kh-hh]qh_XThis package contains components that implement network sockets and protocols for implementing client and server network applications.qq}q(hhhhubaubcdocutils.nodes field_list q)q}q(hUhhhh|hU field_listqh}q(h!]qh#]qh%]qh']qh*]quh,Kh-hh]q(cdocutils.nodes field q)q}q(hUhhhh|hUfieldqh}q(h!]qh#]qh%]qh']qh*]quh,Kh-hh]q(cdocutils.nodes field_name q)q}q(hX copyrightqh}q(h!]qh#]qh%]qh']qh*]quhhh]qh_X copyrightqq}q(hhhhubahU field_namequbcdocutils.nodes field_body q)q}q(hX&CopyRight (C) 2004-2012 by James Millsqh}q(h!]qh#]qh%]qh']qh*]quhhh]qhx)q}q(hhhhhh|hh}h}q(h!]qh#]qh%]qh']qh*]quh,Kh]qh_X&CopyRight (C) 2004-2012 by James Millsq΅q}q(hhhhubaubahU field_bodyqubeubh)q}q(hUhhhh|hhh}q(h!]qh#]qh%]qh']qh*]quh,Kh-hh]q(h)q}q(hXlicenseqh}q(h!]qh#]qh%]qh']qh*]quhhh]qh_Xlicenseq允q}q(hhhhubahhubh)q}q(hXMIT (See: LICENSE) qh}q(h!]qh#]qh%]qh']qh*]quhhh]qhx)q}q(hXMIT (See: LICENSE)qhhhh|hh}h}q(h!]qh#]qh%]qh']qh*]quh,Kh]qh_XMIT (See: LICENSE)qq}q(hhhhubaubahhubeubeubcdocutils.nodes compound q)r}r(hUhhhhhUcompoundrh}r(h!]rh#]rUtoctree-wrapperrah%]rh']rh*]r uh,Nh-hh]r csphinx.addnodes toctree r )r }r (hUhjhhhUtoctreerh}r(UnumberedrKhhOU titlesonlyrUglobrh']rh%]rh!]rh#]rh*]rUentriesr]r(NUapi/circuits_net_protocolsrrNUapi/circuits_net_protocols_httprrNUapi/circuits_net_protocols_ircrrNUapi/circuits_net_protocols_liner r!NUapi/circuits_net_socketsr"r#eUhiddenr$U includefilesr%]r&(jjjj j"eUmaxdepthr'Kuh,Kh]r(ubaubeubahUU transformerr)NU footnote_refsr*}r+Urefnamesr,}r-Usymbol_footnotesr.]r/Uautofootnote_refsr0]r1Usymbol_footnote_refsr2]r3U citationsr4]r5h-hU current_liner6NUtransform_messagesr7]r8Ureporterr9NUid_startr:KU autofootnotesr;]r<U citation_refsr=}r>Uindirect_targetsr?]r@UsettingsrA(cdocutils.frontend Values rBorC}rD(Ufootnote_backlinksrEKUrecord_dependenciesrFNU rfc_base_urlrGUhttp://tools.ietf.org/html/rHU tracebackrIUpep_referencesrJNUstrip_commentsrKNU toc_backlinksrLUentryrMU language_coderNUenrOU datestamprPNU report_levelrQKU _destinationrRNU halt_levelrSKU strip_classesrTNh3NUerror_encoding_error_handlerrUUbackslashreplacerVUdebugrWNUembed_stylesheetrXUoutput_encoding_error_handlerrYUstrictrZU sectnum_xformr[KUdump_transformsr\NU docinfo_xformr]KUwarning_streamr^NUpep_file_url_templater_Upep-%04dr`Uexit_status_levelraKUconfigrbNUstrict_visitorrcNUcloak_email_addressesrdUtrim_footnote_reference_spacereUenvrfNUdump_pseudo_xmlrgNUexpose_internalsrhNUsectsubtitle_xformriU source_linkrjNUrfc_referencesrkNUoutput_encodingrlUutf-8rmU source_urlrnNUinput_encodingroU utf-8-sigrpU_disable_configrqNU id_prefixrrUU tab_widthrsKUerror_encodingrtU ISO-8859-1ruU_sourcervU=/home/prologic/work/circuits/docs/source/api/circuits_net.rstrwUgettext_compactrxU generatorryNUdump_internalsrzNU smart_quotesr{U pep_base_urlr|Uhttp://www.python.org/dev/peps/r}Usyntax_highlightr~UlongrUinput_encoding_error_handlerrjZUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(h)cdocutils.nodes target r)r}r(hUhhhhkhUtargetrh}r(h!]rh']rh)ah%]rUismodrh#]rh*]ruh,Kh-hh]rubhhuUsubstitution_namesr}rhh-h}r(h!]rh']rh%]rUsourcerhh#]rh*]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_io_serial.doctree0000644000014400001440000002030612113366660024727 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNXcircuits.io.serial.SerialqX circuits.io.serial -- serial i/oqNX componentsq NXeventsq NuUsubstitution_defsq }q Uparse_messagesq ]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhhhUcircuits-io-serial-serial-i-oqh U componentsqh UeventsquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode q XC/home/prologic/work/circuits/docs/source/api/circuits_io_serial.rstq!q"}q#bUtagnameq$Usectionq%U attributesq&}q'(Udupnamesq(]q)Uclassesq*]q+Ubackrefsq,]q-Uidsq.]q/(Xmodule-circuits.io.serialq0heUnamesq1]q2hauUlineq3KUdocumentq4hh]q5(cdocutils.nodes title q6)q7}q8(hX':mod:`circuits.io.serial` -- Serial I/Oq9hhhh"h$Utitleq:h&}q;(h(]qh.]q?h1]q@uh3Kh4hh]qA(csphinx.addnodes pending_xref qB)qC}qD(hX:mod:`circuits.io.serial`qEhh7hh"h$U pending_xrefqFh&}qG(UreftypeqHXmodqIUrefwarnqJU reftargetqKXcircuits.io.serialqLU refdomainqMXpyqNh.]qOh,]qPU refexplicitqQh(]qRh*]qSh1]qTUrefdocqUUapi/circuits_io_serialqVUpy:classqWNU py:moduleqXNuh3Kh]qYcdocutils.nodes literal qZ)q[}q\(hhEh&}q](h(]q^h*]q_(Uxrefq`hNXpy-modqaeh,]qbh.]qch1]qduhhCh]qecdocutils.nodes Text qfXcircuits.io.serialqgqh}qi(hUhh[ubah$UliteralqjubaubhfX -- Serial I/Oqkql}qm(hX -- Serial I/Oqnhh7ubeubcsphinx.addnodes index qo)qp}qq(hUhhhh"h$Uindexqrh&}qs(h.]qth,]quh(]qvh*]qwh1]qxUentriesqy]qz(Usingleq{Xcircuits.io.serial (module)Xmodule-circuits.io.serialUtq|auh3Kh4hh]q}ubh)q~}q(hUhhhh"h$h%h&}q(h(]qh*]qh,]qh.]qhah1]qh auh3Kh4hh]q(h6)q}q(hXEventsqhh~hh"h$h:h&}q(h(]qh*]qh,]qh.]qh1]quh3Kh4hh]qhfXEventsqq}q(hhhhubaubcdocutils.nodes paragraph q)q}q(hX**none**qhh~hh"h$U paragraphqh&}q(h(]qh*]qh,]qh.]qh1]quh3K h4hh]qcdocutils.nodes strong q)q}q(hhh&}q(h(]qh*]qh,]qh.]qh1]quhhh]qhfXnoneqq}q(hUhhubah$Ustrongqubaubeubh)q}q(hUhhhh"h$h%h&}q(h(]qh*]qh,]qh.]qhah1]qh auh3K h4hh]q(h6)q}q(hX Componentsqhhhh"h$h:h&}q(h(]qh*]qh,]qh.]qh1]quh3K h4hh]qhfX Componentsqq}q(hhhhubaubho)q}q(hUhhhU qh$hrh&}q(h.]qh,]qh(]qh*]qh1]qUentriesq]q(h{X$Serial (class in circuits.io.serial)hUtqauh3Nh4hh]qubcsphinx.addnodes desc q)q}q(hUhhhhh$Udescqh&}q(Unoindexq։UdomainqXpyqh.]qh,]qh(]qh*]qh1]qUobjtypeqXclassqUdesctypeqhuh3Nh4hh]q(csphinx.addnodes desc_signature q)q}q(hXZSerial(port, baudrate=115200, bufsize=4096, timeout=0.20000000000000001, channel='serial')qhhhU qh$Udesc_signatureqh&}q(h.]qhaUmoduleqh Xcircuits.io.serialq녁q}qbh,]qh(]qh*]qh1]qhaUfullnameqXSerialqUclassqUUfirstquh3Nh4hh]q(csphinx.addnodes desc_annotation q)q}q(hXclass qhhhhh$Udesc_annotationqh&}q(h(]qh*]qh,]qh.]rh1]ruh3Nh4hh]rhfXclass rr}r(hUhhubaubcsphinx.addnodes desc_addname r)r}r(hXcircuits.io.serial.r hhhhh$U desc_addnamer h&}r (h(]r h*]r h,]rh.]rh1]ruh3Nh4hh]rhfXcircuits.io.serial.rr}r(hUhjubaubcsphinx.addnodes desc_name r)r}r(hhhhhhh$U desc_namerh&}r(h(]rh*]rh,]rh.]rh1]ruh3Nh4hh]rhfXSerialr r!}r"(hUhjubaubcsphinx.addnodes desc_parameterlist r#)r$}r%(hUhhhhh$Udesc_parameterlistr&h&}r'(h(]r(h*]r)h,]r*h.]r+h1]r,uh3Nh4hh]r-(csphinx.addnodes desc_parameter r.)r/}r0(hXportr1h&}r2(h(]r3h*]r4h,]r5h.]r6h1]r7uhj$h]r8hfXportr9r:}r;(hUhj/ubah$Udesc_parameterr<ubj.)r=}r>(hXbaudrate=115200r?h&}r@(h(]rAh*]rBh,]rCh.]rDh1]rEuhj$h]rFhfXbaudrate=115200rGrH}rI(hUhj=ubah$j<ubj.)rJ}rK(hX bufsize=4096rLh&}rM(h(]rNh*]rOh,]rPh.]rQh1]rRuhj$h]rShfX bufsize=4096rTrU}rV(hUhjJubah$j<ubj.)rW}rX(hXtimeout=0.20000000000000001rYh&}rZ(h(]r[h*]r\h,]r]h.]r^h1]r_uhj$h]r`hfXtimeout=0.20000000000000001rarb}rc(hUhjWubah$j<ubj.)rd}re(hXchannel='serial'rfh&}rg(h(]rhh*]rih,]rjh.]rkh1]rluhj$h]rmhfXchannel='serial'rnro}rp(hUhjdubah$j<ubeubeubcsphinx.addnodes desc_content rq)rr}rs(hUhhhhh$U desc_contentrth&}ru(h(]rvh*]rwh,]rxh.]ryh1]rzuh3Nh4hh]r{h)r|}r}(hX2Bases: :class:`circuits.core.components.Component`r~hjrhhh$hh&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]r(hfXBases: rr}r(hXBases: rhj|ubhB)r}r(hX+:class:`circuits.core.components.Component`rhj|hh"h$hFh&}r(UreftyperXclassrhJhKX"circuits.core.components.ComponentrU refdomainrXpyrh.]rh,]rU refexplicitrh(]rh*]rh1]rhUhVhWhhXXcircuits.io.serialruh3Kh]rhZ)r}r(hjh&}r(h(]rh*]r(h`jXpy-classreh,]rh.]rh1]ruhjh]rhfX"circuits.core.components.Componentrr}r(hUhjubah$hjubaubeubaubeubeubh)r}r(hUhhhh"h$h%h&}r(h(]rh*]rh,]rh.]rhah1]rhauh3Kh4hh]r(h6)r}r(hX Functionsrhjhh"h$h:h&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]rhfX Functionsrr}r(hjhjubaubh)r}r(hX**none**rhjhh"h$hh&}r(h(]rh*]rh,]rh.]rh1]ruh3Kh4hh]rh)r}r(hjh&}r(h(]rh*]rh,]rh.]rh1]ruhjh]rhfXnonerr}r(hUhjubah$hubaubeubeubahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh4hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh:NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamr NUpep_file_url_templater Upep-%04dr Uexit_status_levelr KUconfigr NUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1r U_sourcer!UC/home/prologic/work/circuits/docs/source/api/circuits_io_serial.rstr"Ugettext_compactr#U generatorr$NUdump_internalsr%NU smart_quotesr&U pep_base_urlr'Uhttp://www.python.org/dev/peps/r(Usyntax_highlightr)Ulongr*Uinput_encoding_error_handlerr+jUauto_id_prefixr,Uidr-Udoctitle_xformr.Ustrip_elements_with_classesr/NU _config_filesr0]r1Ufile_insertion_enabledr2KU raw_enabledr3KU dump_settingsr4NubUsymbol_footnote_startr5KUidsr6}r7(hjhhhhhhh0cdocutils.nodes target r8)r9}r:(hUhhhh"h$Utargetr;h&}r<(h(]r=h.]r>h0ah,]r?Uismodr@h*]rAh1]rBuh3Kh4hh]rCubhh~uUsubstitution_namesrD}rEh$h4h&}rF(h(]rGh.]rHh,]rIUsourcerJh"h*]rKh1]rLuU footnotesrM]rNUrefidsrO}rPub.circuits-2.1.0/docs/build/doctrees/api/circuits_node_client.doctree0000644000014400001440000002211612113366662025247 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNXcircuits.node.client -- clientqNXeventsqNX componentsq NXcircuits.node.client.Clientq uUsubstitution_defsq }q Uparse_messagesq ]qcdocutils.nodes system_message q)q}q(U rawsourceqUUparentqcsphinx.addnodes desc_content q)q}q(hUhcsphinx.addnodes desc q)q}q(hUhcdocutils.nodes section q)q}q(hUhh)q}q(hUhhUsourceqcdocutils.nodes reprunicode q XE/home/prologic/work/circuits/docs/source/api/circuits_node_client.rstq!q"}q#bUtagnameq$Usectionq%U attributesq&}q'(Udupnamesq(]q)Uclassesq*]q+Ubackrefsq,]q-Uidsq.]q/(Xmodule-circuits.node.clientq0Ucircuits-node-client-clientq1eUnamesq2]q3hauUlineq4KUdocumentq5hUchildrenq6]q7(cdocutils.nodes title q8)q9}q:(hX%:mod:`circuits.node.client` -- Clientq;hhhh"h$Utitleqh*]q?h,]q@h.]qAh2]qBuh4Kh5hh6]qC(csphinx.addnodes pending_xref qD)qE}qF(hX:mod:`circuits.node.client`qGhh9hh"h$U pending_xrefqHh&}qI(UreftypeqJXmodqKUrefwarnqLU reftargetqMXcircuits.node.clientqNU refdomainqOXpyqPh.]qQh,]qRU refexplicitqSh(]qTh*]qUh2]qVUrefdocqWUapi/circuits_node_clientqXUpy:classqYNU py:moduleqZNuh4Kh6]q[cdocutils.nodes literal q\)q]}q^(hhGh&}q_(h(]q`h*]qa(UxrefqbhPXpy-modqceh,]qdh.]qeh2]qfuhhEh6]qgcdocutils.nodes Text qhXcircuits.node.clientqiqj}qk(hUhh]ubah$UliteralqlubaubhhX -- Clientqmqn}qo(hX -- Clientqphh9ubeubcsphinx.addnodes index qq)qr}qs(hUhhhU qth$Uindexquh&}qv(h.]qwh,]qxh(]qyh*]qzh2]q{Uentriesq|]q}(Usingleq~Xcircuits.node.client (module)Xmodule-circuits.node.clientUtqauh4Kh5hh6]qubcdocutils.nodes paragraph q)q}q(hXClientqhhhXV/home/prologic/work/circuits/circuits/node/client.py:docstring of circuits.node.clientqh$U paragraphqh&}q(h(]qh*]qh,]qh.]qh2]quh4Kh5hh6]qhhXClientqq}q(hhhhubaubh)q}q(hX...qhhhhh$hh&}q(h(]qh*]qh,]qh.]qh2]quh4Kh5hh6]qhhX...qq}q(hhhhubaubh)q}q(hUhhhh"h$h%h&}q(h(]qh*]qh,]qh.]qUeventsqah2]qhauh4Kh5hh6]q(h8)q}q(hXEventsqhhhh"h$hr.h$Udesc_signaturer/h&}r0(h.]r1h aUmoduler2h Xcircuits.node.clientr3r4}r5bh,]r6h(]r7h*]r8h2]r9h aUfullnamer:XClientr;Uclassr<UUfirstr=uh4Nh5hh6]r>(csphinx.addnodes desc_annotation r?)r@}rA(hXclass rBhj+hj.h$Udesc_annotationrCh&}rD(h(]rEh*]rFh,]rGh.]rHh2]rIuh4Nh5hh6]rJhhXclass rKrL}rM(hUhj@ubaubcsphinx.addnodes desc_addname rN)rO}rP(hXcircuits.node.client.rQhj+hj.h$U desc_addnamerRh&}rS(h(]rTh*]rUh,]rVh.]rWh2]rXuh4Nh5hh6]rYhhXcircuits.node.client.rZr[}r\(hUhjOubaubcsphinx.addnodes desc_name r])r^}r_(hj;hj+hj.h$U desc_namer`h&}ra(h(]rbh*]rch,]rdh.]reh2]rfuh4Nh5hh6]rghhXClientrhri}rj(hUhj^ubaubcsphinx.addnodes desc_parameterlist rk)rl}rm(hUhj+hj.h$Udesc_parameterlistrnh&}ro(h(]rph*]rqh,]rrh.]rsh2]rtuh4Nh5hh6]ru(csphinx.addnodes desc_parameter rv)rw}rx(hXhostryh&}rz(h(]r{h*]r|h,]r}h.]r~h2]ruhjlh6]rhhXhostrr}r(hUhjwubah$Udesc_parameterrubjv)r}r(hXportrh&}r(h(]rh*]rh,]rh.]rh2]ruhjlh6]rhhXportrr}r(hUhjubah$jubjv)r}r(hXchannel='node'rh&}r(h(]rh*]rh,]rh.]rh2]ruhjlh6]rhhXchannel='node'rr}r(hUhjubah$jubeubeubheubhj.h$U desc_contentrh&}r(h(]rh*]rh,]rh.]rh2]ruh4Nh5hh6]r(h)r}r(hX6Bases: :class:`circuits.core.components.BaseComponent`rhhhU rh$hh&}r(h(]rh*]rh,]rh.]rh2]ruh4Kh5hh6]r(hhXBases: rr}r(hXBases: rhjubhD)r}r(hX/:class:`circuits.core.components.BaseComponent`rhjhh"h$hHh&}r(UreftyperXclassrhLhMX&circuits.core.components.BaseComponentrU refdomainrXpyrh.]rh,]rU refexplicitrh(]rh*]rh2]rhWhXhYj;hZXcircuits.node.clientruh4Kh6]rh\)r}r(hjh&}r(h(]rh*]r(hbjXpy-classreh,]rh.]rh2]ruhjh6]rhhX&circuits.core.components.BaseComponentrr}r(hUhjubah$hlubaubeubh)r}r(hXClientrhhhjh$hh&}r(h(]rh*]rh,]rh.]rh2]ruh4Kh5hh6]rhhXClientrr}r(hjhjubaubh)r}r(hX...rhhhjh$hh&}r(h(]rh*]rh,]rh.]rh2]ruh4Kh5hh6]rhhX...rr}r(hjhjubaubeubhjh$Usystem_messagerh&}r(h(]rUlevelrKh.]rh,]rUsourcerjh*]rh2]rUlinerKUtyperUINFOruh4Kh5hh6]rh)r}r(hUh&}r(h(]rh*]rh,]rh.]rh2]ruhhh6]rhhXeUnexpected possible title overline or transition. Treating it as ordinary text because it's so short.rr}r(hUhjubah$hubaubaUcurrent_sourcerNU decorationrNUautofootnote_startr KUnameidsr }r (hhhh1hhh hh h uh6]r hahUU transformerr NU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh5hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]r U citation_refsr!}r"Uindirect_targetsr#]r$Usettingsr%(cdocutils.frontend Values r&or'}r((Ufootnote_backlinksr)KUrecord_dependenciesr*NU rfc_base_urlr+Uhttp://tools.ietf.org/html/r,U tracebackr-Upep_referencesr.NUstrip_commentsr/NU toc_backlinksr0Uentryr1U language_coder2Uenr3U datestampr4NU report_levelr5KU _destinationr6NU halt_levelr7KU strip_classesr8NhU sectnum_xformr?KUdump_transformsr@NU docinfo_xformrAKUwarning_streamrBNUpep_file_url_templaterCUpep-%04drDUexit_status_levelrEKUconfigrFNUstrict_visitorrGNUcloak_email_addressesrHUtrim_footnote_reference_spacerIUenvrJNUdump_pseudo_xmlrKNUexpose_internalsrLNUsectsubtitle_xformrMU source_linkrNNUrfc_referencesrONUoutput_encodingrPUutf-8rQU source_urlrRNUinput_encodingrSU utf-8-sigrTU_disable_configrUNU id_prefixrVUU tab_widthrWKUerror_encodingrXU ISO-8859-1rYU_sourcerZUE/home/prologic/work/circuits/docs/source/api/circuits_node_client.rstr[Ugettext_compactr\U generatorr]NUdump_internalsr^NU smart_quotesr_U pep_base_urlr`Uhttp://www.python.org/dev/peps/raUsyntax_highlightrbUlongrcUinput_encoding_error_handlerrdj>Uauto_id_prefixreUidrfUdoctitle_xformrgUstrip_elements_with_classesrhNU _config_filesri]rjUfile_insertion_enabledrkKU raw_enabledrlKU dump_settingsrmNubUsymbol_footnote_startrnKUidsro}rp(hhh1hhhh0cdocutils.nodes target rq)rr}rs(hUhhhhth$Utargetrth&}ru(h(]rvh.]rwh0ah,]rxUismodryh*]rzh2]r{uh4Kh5hh6]r|ubhhh j+uUsubstitution_namesr}}r~h$h5h&}r(h(]rh.]rh,]rUsourcerh"h*]rh2]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_websocket.doctree0000644000014400001440000004752212113366667025624 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X functionsqNX&circuits.web.websocket.WebSocketClientqX*circuits.web.websocket -- websocket clientqNX.circuits.web.websocket.WebSocketClient.channelq X0circuits.web.websocket.WebSocketClient.connectedq X componentsq NXeventsq NX,circuits.web.websocket.WebSocketClient.closeq uUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU functionsqhhhU'circuits-web-websocket-websocket-clientqh h h h h U componentsqh Ueventsqh h uUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceq UUparentq!hUsourceq"cdocutils.nodes reprunicode q#XG/home/prologic/work/circuits/docs/source/api/circuits_web_websocket.rstq$q%}q&bUtagnameq'Usectionq(U attributesq)}q*(Udupnamesq+]q,Uclassesq-]q.Ubackrefsq/]q0Uidsq1]q2(Xmodule-circuits.web.websocketq3heUnamesq4]q5hauUlineq6KUdocumentq7hh]q8(cdocutils.nodes title q9)q:}q;(h X1:mod:`circuits.web.websocket` -- WebSocket Clientq(h+]q?h-]q@h/]qAh1]qBh4]qCuh6Kh7hh]qD(csphinx.addnodes pending_xref qE)qF}qG(h X:mod:`circuits.web.websocket`qHh!h:h"h%h'U pending_xrefqIh)}qJ(UreftypeqKXmodqLUrefwarnqMU reftargetqNXcircuits.web.websocketqOU refdomainqPXpyqQh1]qRh/]qSU refexplicitqTh+]qUh-]qVh4]qWUrefdocqXUapi/circuits_web_websocketqYUpy:classqZNU py:moduleq[Nuh6Kh]q\cdocutils.nodes literal q])q^}q_(h hHh)}q`(h+]qah-]qb(UxrefqchQXpy-modqdeh/]qeh1]qfh4]qguh!hFh]qhcdocutils.nodes Text qiXcircuits.web.websocketqjqk}ql(h Uh!h^ubah'UliteralqmubaubhiX -- WebSocket Clientqnqo}qp(h X -- WebSocket Clientqqh!h:ubeubcsphinx.addnodes index qr)qs}qt(h Uh!hh"h%h'Uindexquh)}qv(h1]qwh/]qxh+]qyh-]qzh4]q{Uentriesq|]q}(Usingleq~Xcircuits.web.websocket (module)Xmodule-circuits.web.websocketUtqauh6Kh7hh]qubh)q}q(h Uh!hh"h%h'h(h)}q(h+]qh-]qh/]qh1]qhah4]qh auh6Kh7hh]qh9)q}q(h XEventsqh!hh"h%h'h=h)}q(h+]qh-]qh/]qh1]qh4]quh6Kh7hh]qhiXEventsqq}q(h hh!hubaubaubh)q}q(h Uh!hh"h%h'h(h)}q(h+]qh-]qh/]qh1]qhah4]qh auh6K h7hh]q(h9)q}q(h X Componentsqh!hh"h%h'h=h)}q(h+]qh-]qh/]qh1]qh4]quh6K h7hh]qhiX Componentsqq}q(h hh!hubaubhr)q}q(h Uh!hh"Nh'huh)}q(h1]qh/]qh+]qh-]qh4]qUentriesq]q(h~X1WebSocketClient (class in circuits.web.websocket)hUtqauh6Nh7hh]qubcsphinx.addnodes desc q)q}q(h Uh!hh"Nh'Udescqh)}q(UnoindexqUdomainqXpyqh1]qh/]qh+]qh-]qh4]qUobjtypeqXclassqUdesctypeqhuh6Nh7hh]q(csphinx.addnodes desc_signature q)q}q(h XDWebSocketClient(url, channel='wsclient', wschannel='ws', headers={})qh!hh"U qh'Udesc_signatureqh)}q(h1]qhaUmoduleqh#Xcircuits.web.websocketqӅq}qbh/]qh+]qh-]qh4]qhaUfullnameqXWebSocketClientqUclassqUUfirstq݉uh6Nh7hh]q(csphinx.addnodes desc_annotation q)q}q(h Xclass qh!hh"hh'Udesc_annotationqh)}q(h+]qh-]qh/]qh1]qh4]quh6Nh7hh]qhiXclass q녁q}q(h Uh!hubaubcsphinx.addnodes desc_addname q)q}q(h Xcircuits.web.websocket.qh!hh"hh'U desc_addnameqh)}q(h+]qh-]qh/]qh1]qh4]quh6Nh7hh]qhiXcircuits.web.websocket.qq}q(h Uh!hubaubcsphinx.addnodes desc_name q)q}q(h hh!hh"hh'U desc_namerh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiXWebSocketClientrr }r (h Uh!hubaubcsphinx.addnodes desc_parameterlist r )r }r (h Uh!hh"hh'Udesc_parameterlistrh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]r(csphinx.addnodes desc_parameter r)r}r(h Xurlrh)}r(h+]rh-]rh/]rh1]rh4]ruh!j h]r hiXurlr!r"}r#(h Uh!jubah'Udesc_parameterr$ubj)r%}r&(h Xchannel='wsclient'r'h)}r((h+]r)h-]r*h/]r+h1]r,h4]r-uh!j h]r.hiXchannel='wsclient'r/r0}r1(h Uh!j%ubah'j$ubj)r2}r3(h Xwschannel='ws'r4h)}r5(h+]r6h-]r7h/]r8h1]r9h4]r:uh!j h]r;hiXwschannel='ws'r<r=}r>(h Uh!j2ubah'j$ubj)r?}r@(h X headers={}rAh)}rB(h+]rCh-]rDh/]rEh1]rFh4]rGuh!j h]rHhiX headers={}rIrJ}rK(h Uh!j?ubah'j$ubeubeubcsphinx.addnodes desc_content rL)rM}rN(h Uh!hh"hh'U desc_contentrOh)}rP(h+]rQh-]rRh/]rSh1]rTh4]rUuh6Nh7hh]rV(cdocutils.nodes paragraph rW)rX}rY(h X6Bases: :class:`circuits.core.components.BaseComponent`rZh!jMh"U r[h'U paragraphr\h)}r](h+]r^h-]r_h/]r`h1]rah4]rbuh6Kh7hh]rc(hiXBases: rdre}rf(h XBases: rgh!jXubhE)rh}ri(h X/:class:`circuits.core.components.BaseComponent`rjh!jXh"h%h'hIh)}rk(UreftyperlXclassrmhMhNX&circuits.core.components.BaseComponentrnU refdomainroXpyrph1]rqh/]rrU refexplicitrsh+]rth-]ruh4]rvhXhYhZhh[Xcircuits.web.websocketrwuh6Kh]rxh])ry}rz(h jjh)}r{(h+]r|h-]r}(hcjpXpy-classr~eh/]rh1]rh4]ruh!jhh]rhiX&circuits.core.components.BaseComponentrr}r(h Uh!jyubah'hmubaubeubjW)r}r(h XAn RFC 6455 compliant WebSocket client component. Upon receiving a :class:`circuits.web.client.Connect` event, the component tries to establish the connection to the server in a two stage process. First, a :class:`circuits.net.sockets.Connect` event is sent to a child :class:`~.sockets.TCPClient`. When the TCP connection has been established, the HTTP request for opening the WebSocket is sent to the server. A failure in this setup process is signaled by a :class:`~.client.NotConnected` event.rh!jMh"Xj/home/prologic/work/circuits/circuits/web/websocket.py:docstring of circuits.web.websocket.WebSocketClientrh'j\h)}r(h+]rh-]rh/]rh1]rh4]ruh6Kh7hh]r(hiXDAn RFC 6455 compliant WebSocket client component. Upon receiving a rr}r(h XDAn RFC 6455 compliant WebSocket client component. Upon receiving a rh!jubhE)r}r(h X$:class:`circuits.web.client.Connect`rh!jh"h%h'hIh)}r(UreftyperXclassrhMhNXcircuits.web.client.ConnectrU refdomainrXpyrh1]rh/]rU refexplicitrh+]rh-]rh4]rhXhYhZhh[jwuh6Kh]rh])r}r(h jh)}r(h+]rh-]r(hcjXpy-classreh/]rh1]rh4]ruh!jh]rhiXcircuits.web.client.Connectrr}r(h Uh!jubah'hmubaubhiXi event, the component tries to establish the connection to the server in a two stage process. First, a rr}r(h Xi event, the component tries to establish the connection to the server in a two stage process. First, a rh!jubhE)r}r(h X%:class:`circuits.net.sockets.Connect`rh!jh"h%h'hIh)}r(UreftyperXclassrhMhNXcircuits.net.sockets.ConnectrU refdomainrXpyrh1]rh/]rU refexplicitrh+]rh-]rh4]rhXhYhZhh[jwuh6Kh]rh])r}r(h jh)}r(h+]rh-]r(hcjXpy-classreh/]rh1]rh4]ruh!jh]rhiXcircuits.net.sockets.Connectrr}r(h Uh!jubah'hmubaubhiX event is sent to a child rr}r(h X event is sent to a child rh!jubhE)r}r(h X:class:`~.sockets.TCPClient`rh!jh"h%h'hIh)}r(UreftyperXclassrU refspecificrhMhNXsockets.TCPClientrU refdomainrXpyrh1]rh/]rU refexplicitrh+]rh-]rh4]rhXhYhZhh[jwuh6Kh]rh])r}r(h jh)}r(h+]rh-]r(hcjXpy-classreh/]rh1]rh4]ruh!jh]rhiX TCPClientrr}r(h Uh!jubah'hmubaubhiX. When the TCP connection has been established, the HTTP request for opening the WebSocket is sent to the server. A failure in this setup process is signaled by a rr}r(h X. When the TCP connection has been established, the HTTP request for opening the WebSocket is sent to the server. A failure in this setup process is signaled by a rh!jubhE)r}r(h X:class:`~.client.NotConnected`rh!jh"h%h'hIh)}r(UreftyperXclassrjhMhNXclient.NotConnectedrU refdomainrXpyrh1]rh/]rU refexplicitrh+]rh-]rh4]rhXhYhZhh[jwuh6Kh]rh])r }r (h jh)}r (h+]r h-]r (hcjXpy-classreh/]rh1]rh4]ruh!jh]rhiX NotConnectedrr}r(h Uh!j ubah'hmubaubhiX event.rr}r(h X event.rh!jubeubjW)r}r(h XWhen the server accepts the request, the WebSocket connection is established and can be used very much like an ordinary socket by handling :class:`~.sockets.Read` events on and sending :class:`~.sockets.Write` events to the channel specified as the ``wschannel`` parameter of the constructor. Firing a :class:`~.sockets.Close` event on that channel closes the connection in an orderly fashion (i.e. as specified by the WebSocket protocol).rh!jMh"jh'j\h)}r(h+]rh-]rh/]r h1]r!h4]r"uh6K h7hh]r#(hiXWhen the server accepts the request, the WebSocket connection is established and can be used very much like an ordinary socket by handling r$r%}r&(h XWhen the server accepts the request, the WebSocket connection is established and can be used very much like an ordinary socket by handling r'h!jubhE)r(}r)(h X:class:`~.sockets.Read`r*h!jh"h%h'hIh)}r+(Ureftyper,Xclassr-jhMhNX sockets.Readr.U refdomainr/Xpyr0h1]r1h/]r2U refexplicitr3h+]r4h-]r5h4]r6hXhYhZhh[jwuh6Kh]r7h])r8}r9(h j*h)}r:(h+]r;h-]r<(hcj0Xpy-classr=eh/]r>h1]r?h4]r@uh!j(h]rAhiXReadrBrC}rD(h Uh!j8ubah'hmubaubhiX events on and sending rErF}rG(h X events on and sending rHh!jubhE)rI}rJ(h X:class:`~.sockets.Write`rKh!jh"h%h'hIh)}rL(UreftyperMXclassrNjhMhNX sockets.WriterOU refdomainrPXpyrQh1]rRh/]rSU refexplicitrTh+]rUh-]rVh4]rWhXhYhZhh[jwuh6Kh]rXh])rY}rZ(h jKh)}r[(h+]r\h-]r](hcjQXpy-classr^eh/]r_h1]r`h4]rauh!jIh]rbhiXWritercrd}re(h Uh!jYubah'hmubaubhiX( events to the channel specified as the rfrg}rh(h X( events to the channel specified as the rih!jubh])rj}rk(h X ``wschannel``rlh)}rm(h+]rnh-]roh/]rph1]rqh4]rruh!jh]rshiX wschannelrtru}rv(h Uh!jjubah'hmubhiX( parameter of the constructor. Firing a rwrx}ry(h X( parameter of the constructor. Firing a rzh!jubhE)r{}r|(h X:class:`~.sockets.Close`r}h!jh"h%h'hIh)}r~(UreftyperXclassrjhMhNX sockets.CloserU refdomainrXpyrh1]rh/]rU refexplicitrh+]rh-]rh4]rhXhYhZhh[jwuh6Kh]rh])r}r(h j}h)}r(h+]rh-]r(hcjXpy-classreh/]rh1]rh4]ruh!j{h]rhiXCloserr}r(h Uh!jubah'hmubaubhiXq event on that channel closes the connection in an orderly fashion (i.e. as specified by the WebSocket protocol).rr}r(h Xq event on that channel closes the connection in an orderly fashion (i.e. as specified by the WebSocket protocol).rh!jubeubcdocutils.nodes field_list r)r}r(h Uh!jMh"Nh'U field_listrh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rcdocutils.nodes field r)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]r(cdocutils.nodes field_name r)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiX Parametersrr}r(h Uh!jubah'U field_namerubcdocutils.nodes field_body r)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rcdocutils.nodes bullet_list r)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]r(cdocutils.nodes list_item r)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rjW)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]r(cdocutils.nodes strong r)r}r(h Xurlrh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiXurlrr}r(h Uh!jubah'UstrongrubhiX -- rr}r(h Uh!jubhiXthe URL to connect to.rr}r(h Xthe URL to connect to.rh!jubeh'j\ubah'U list_itemrubj)r}r(h Uh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rjW)r}r(h Uh)}r(h+]r h-]r h/]r h1]r h4]r uh!jh]r(j)r}r(h Xchannelrh)}r(h+]rh-]rh/]rh1]rh4]ruh!jh]rhiXchannelrr}r(h Uh!jubah'jubhiX -- rr}r(h Uh!jubhiX"the channel used by this componentrr }r!(h X"the channel used by this componentr"h!jubeh'j\ubah'jubj)r#}r$(h Uh)}r%(h+]r&h-]r'h/]r(h1]r)h4]r*uh!jh]r+jW)r,}r-(h Uh)}r.(h+]r/h-]r0h/]r1h1]r2h4]r3uh!j#h]r4(j)r5}r6(h X wschannelr7h)}r8(h+]r9h-]r:h/]r;h1]r<h4]r=uh!j,h]r>hiX wschannelr?r@}rA(h Uh!j5ubah'jubhiX -- rBrC}rD(h Uh!j,ubhiXSthe channel used for the actual WebSocket communication (read, write, close events)rErF}rG(h XSthe channel used for the actual WebSocket communication (read, write, close events)rHh!j,ubeh'j\ubah'jubj)rI}rJ(h Uh)}rK(h+]rLh-]rMh/]rNh1]rOh4]rPuh!jh]rQjW)rR}rS(h Uh)}rT(h+]rUh-]rVh/]rWh1]rXh4]rYuh!jIh]rZ(j)r[}r\(h Xheadersr]h)}r^(h+]r_h-]r`h/]rah1]rbh4]rcuh!jRh]rdhiXheadersrerf}rg(h Uh!j[ubah'jubhiX -- rhri}rj(h Uh!jRubhiXEadditional headers to be passed with the WebSocket setup HTTP requestrkrl}rm(h XEadditional headers to be passed with the WebSocket setup HTTP requestrnh!jRubeh'j\ubah'jubeh'U bullet_listroubah'U field_bodyrpubeh'Ufieldrqubaubhr)rr}rs(h Uh!jMh"Nh'huh)}rt(h1]ruh/]rvh+]rwh-]rxh4]ryUentriesrz]r{(h~X:channel (circuits.web.websocket.WebSocketClient attribute)h Utr|auh6Nh7hh]r}ubh)r~}r(h Uh!jMh"Nh'hh)}r(hhXpyrh1]rh/]rh+]rh-]rh4]rhX attributerhjuh6Nh7hh]r(h)r}r(h XWebSocketClient.channelrh!j~h"U rh'hh)}r(h1]rh ahh#Xcircuits.web.websocketrr}rbh/]rh+]rh-]rh4]rh ahXWebSocketClient.channelrhhh݉uh6Nh7hh]r(h)r}r(h Xchannelrh!jh"jh'jh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiXchannelrr}r(h Uh!jubaubh)r}r(h X = 'wsclient'rh!jh"jh'hh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiX = 'wsclient'rr}r(h Uh!jubaubeubjL)r}r(h Uh!j~h"jh'jOh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rubeubhr)r}r(h Uh!jMh"Nh'huh)}r(h1]rh/]rh+]rh-]rh4]rUentriesr]r(h~X7close() (circuits.web.websocket.WebSocketClient method)h Utrauh6Nh7hh]rubh)r}r(h Uh!jMh"Nh'hh)}r(hhXpyrh1]rh/]rh+]rh-]rh4]rhXmethodrhjuh6Nh7hh]r(h)r}r(h XWebSocketClient.close()rh!jh"hh'hh)}r(h1]rh ahh#Xcircuits.web.websocketrr}rbh/]rh+]rh-]rh4]rh ahXWebSocketClient.closerhhh݉uh6Nh7hh]r(h)r}r(h Xcloserh!jh"hh'jh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rhiXcloserr}r(h Uh!jubaubj )r}r(h Uh!jh"hh'jh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rubeubjL)r}r(h Uh!jh"hh'jOh)}r(h+]rh-]rh/]rh1]rh4]ruh6Nh7hh]rubeubhr)r}r(h Uh!jMh"Nh'huh)}r(h1]rh/]rh+]rh-]rh4]rUentriesr]r(h~X<connected (circuits.web.websocket.WebSocketClient attribute)h Utr auh6Nh7hh]r ubh)r }r (h Uh!jMh"Nh'hh)}r (hhXpyrh1]rh/]rh+]rh-]rh4]rhX attributerhjuh6Nh7hh]r(h)r}r(h XWebSocketClient.connectedrh!j h"hh'hh)}r(h1]rh ahh#Xcircuits.web.websocketrr}rbh/]rh+]rh-]r h4]r!h ahXWebSocketClient.connectedr"hhh݉uh6Nh7hh]r#h)r$}r%(h X connectedr&h!jh"hh'jh)}r'(h+]r(h-]r)h/]r*h1]r+h4]r,uh6Nh7hh]r-hiX connectedr.r/}r0(h Uh!j$ubaubaubjL)r1}r2(h Uh!j h"hh'jOh)}r3(h+]r4h-]r5h/]r6h1]r7h4]r8uh6Nh7hh]r9ubeubeubeubeubh)r:}r;(h Uh!hh"h%h'h(h)}r<(h+]r=h-]r>h/]r?h1]r@hah4]rAhauh6Kh7hh]rBh9)rC}rD(h X FunctionsrEh!j:h"h%h'h=h)}rF(h+]rGh-]rHh/]rIh1]rJh4]rKuh6Kh7hh]rLhiX FunctionsrMrN}rO(h jEh!jCubaubaubeubah UU transformerrPNU footnote_refsrQ}rRUrefnamesrS}rTUsymbol_footnotesrU]rVUautofootnote_refsrW]rXUsymbol_footnote_refsrY]rZU citationsr[]r\h7hU current_liner]NUtransform_messagesr^]r_Ureporterr`NUid_startraKU autofootnotesrb]rcU citation_refsrd}reUindirect_targetsrf]rgUsettingsrh(cdocutils.frontend Values riorj}rk(Ufootnote_backlinksrlKUrecord_dependenciesrmNU rfc_base_urlrnUhttp://tools.ietf.org/html/roU tracebackrpUpep_referencesrqNUstrip_commentsrrNU toc_backlinksrsUentryrtU language_coderuUenrvU datestamprwNU report_levelrxKU _destinationryNU halt_levelrzKU strip_classesr{Nh=NUerror_encoding_error_handlerr|Ubackslashreplacer}Udebugr~NUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUG/home/prologic/work/circuits/docs/source/api/circuits_web_websocket.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hj:hhh jh jhhh3cdocutils.nodes target r)r}r(h Uh!hh"h%h'Utargetrh)}r(h+]rh1]rh3ah/]rUismodrh-]rh4]ruh6Kh7hh]rubhhhhh juUsubstitution_namesr}rh'h7h)}r(h+]rh1]rh/]rUsourcerh%h-]rh4]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/api/circuits_web_http.doctree0000644000014400001440000010001212113366665024573 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X*circuits.web.http.HTTP._on_request_successqX"circuits.web.http -- http protocolqNXcircuits.web.http.HTTPqX#circuits.web.http.HTTP._on_responseq X functionsq NXcircuits.web.http.HTTP._on_readq Xcircuits_web_httpq X$circuits.web.http.HTTP._on_httperrorq X componentsqNXeventsqNuUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hhhUcircuits-web-http-http-protocolqhhh h h U functionsqh h h Ucircuits-web-httpqh h hU componentsqhUeventsquUchildrenq]q(cdocutils.nodes target q )q!}q"(U rawsourceq#X.. _circuits_web_http:q$Uparentq%hUsourceq&cdocutils.nodes reprunicode q'XB/home/prologic/work/circuits/docs/source/api/circuits_web_http.rstq(q)}q*bUtagnameq+Utargetq,U attributesq-}q.(Uidsq/]q0Ubackrefsq1]q2Udupnamesq3]q4Uclassesq5]q6Unamesq7]q8Urefidq9huUlineq:KUdocumentq;hh]q}q?(h#Uh%hh&h)Uexpect_referenced_by_nameq@}qAh h!sh+UsectionqBh-}qC(h3]qDh5]qEh1]qFh/]qG(Xmodule-circuits.web.httpqHhheh7]qI(hh euh:Kh;hUexpect_referenced_by_idqJ}qKhh!sh]qL(cdocutils.nodes title qM)qN}qO(h#X):mod:`circuits.web.http` -- HTTP ProtocolqPh%h>h&h)h+UtitleqQh-}qR(h3]qSh5]qTh1]qUh/]qVh7]qWuh:Kh;hh]qX(csphinx.addnodes pending_xref qY)qZ}q[(h#X:mod:`circuits.web.http`q\h%hNh&h)h+U pending_xrefq]h-}q^(Ureftypeq_Xmodq`UrefwarnqaU reftargetqbXcircuits.web.httpqcU refdomainqdXpyqeh/]qfh1]qgU refexplicitqhh3]qih5]qjh7]qkUrefdocqlUapi/circuits_web_httpqmUpy:classqnNU py:moduleqoNuh:Kh]qpcdocutils.nodes literal qq)qr}qs(h#h\h-}qt(h3]quh5]qv(UxrefqwheXpy-modqxeh1]qyh/]qzh7]q{uh%hZh]q|cdocutils.nodes Text q}Xcircuits.web.httpq~q}q(h#Uh%hrubah+Uliteralqubaubh}X -- HTTP Protocolqq}q(h#X -- HTTP Protocolqh%hNubeubcsphinx.addnodes index q)q}q(h#Uh%h>h&U qh+Uindexqh-}q(h/]qh1]qh3]qh5]qh7]qUentriesq]q(UsingleqXcircuits.web.http (module)Xmodule-circuits.web.httpUtqauh:Kh;hh]qubcdocutils.nodes paragraph q)q}q(h#XHyper Text Transfer Protocolqh%h>h&XP/home/prologic/work/circuits/circuits/web/http.py:docstring of circuits.web.httpqh+U paragraphqh-}q(h3]qh5]qh1]qh/]qh7]quh:Kh;hh]qh}XHyper Text Transfer Protocolqq}q(h#hh%hubaubh)q}q(h#X^This module implements the server side Hyper Text Transfer Protocol or commonly known as HTTP.qh%h>h&hh+hh-}q(h3]qh5]qh1]qh/]qh7]quh:Kh;hh]qh}X^This module implements the server side Hyper Text Transfer Protocol or commonly known as HTTP.qq}q(h#hh%hubaubh=)q}q(h#Uh%h>h&h)h+hBh-}q(h3]qh5]qh1]qh/]qhah7]qhauh:K h;hh]q(hM)q}q(h#X Componentsqh%hh&h)h+hQh-}q(h3]qh5]qh1]qh/]qh7]quh:K h;hh]qh}X Componentsqƅq}q(h#hh%hubaubh)q}q(h#Uh%hh&Nh+hh-}q(h/]qh1]qh3]qh5]qh7]qUentriesq]q(hX!HTTP (class in circuits.web.http)hUtqauh:Nh;hh]qubcsphinx.addnodes desc q)q}q(h#Uh%hh&Nh+Udescqh-}q(UnoindexqډUdomainqXpyqh/]qh1]qh3]qh5]qh7]qUobjtypeqXclassqUdesctypeqhuh:Nh;hh]q(csphinx.addnodes desc_signature q)q}q(h#X%HTTP(encoding='utf-8', channel='web')qh%hh&U qh+Udesc_signatureqh-}q(h/]qhaUmoduleqh'Xcircuits.web.httpqq}qbh1]qh3]qh5]qh7]qhaUfullnameqXHTTPqUclassqUUfirstquh:Nh;hh]q(csphinx.addnodes desc_annotation q)q}q(h#Xclass qh%hh&hh+Udesc_annotationqh-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]rh}Xclass rr}r (h#Uh%hubaubcsphinx.addnodes desc_addname r )r }r (h#Xcircuits.web.http.r h%hh&hh+U desc_addnamerh-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]rh}Xcircuits.web.http.rr}r(h#Uh%j ubaubcsphinx.addnodes desc_name r)r}r(h#hh%hh&hh+U desc_namerh-}r(h3]rh5]rh1]r h/]r!h7]r"uh:Nh;hh]r#h}XHTTPr$r%}r&(h#Uh%jubaubcsphinx.addnodes desc_parameterlist r')r(}r)(h#Uh%hh&hh+Udesc_parameterlistr*h-}r+(h3]r,h5]r-h1]r.h/]r/h7]r0uh:Nh;hh]r1(csphinx.addnodes desc_parameter r2)r3}r4(h#Xencoding='utf-8'r5h-}r6(h3]r7h5]r8h1]r9h/]r:h7]r;uh%j(h]r<h}Xencoding='utf-8'r=r>}r?(h#Uh%j3ubah+Udesc_parameterr@ubj2)rA}rB(h#X channel='web'rCh-}rD(h3]rEh5]rFh1]rGh/]rHh7]rIuh%j(h]rJh}X channel='web'rKrL}rM(h#Uh%jAubah+j@ubeubeubcsphinx.addnodes desc_content rN)rO}rP(h#Uh%hh&hh+U desc_contentrQh-}rR(h3]rSh5]rTh1]rUh/]rVh7]rWuh:Nh;hh]rX(h)rY}rZ(h#X6Bases: :class:`circuits.core.components.BaseComponent`r[h%jOh&U r\h+hh-}r](h3]r^h5]r_h1]r`h/]rah7]rbuh:Kh;hh]rc(h}XBases: rdre}rf(h#XBases: rgh%jYubhY)rh}ri(h#X/:class:`circuits.core.components.BaseComponent`rjh%jYh&h)h+h]h-}rk(UreftyperlXclassrmhahbX&circuits.core.components.BaseComponentrnU refdomainroXpyrph/]rqh1]rrU refexplicitrsh3]rth5]ruh7]rvhlhmhnhhoXcircuits.web.httprwuh:Kh]rxhq)ry}rz(h#jjh-}r{(h3]r|h5]r}(hwjpXpy-classr~eh1]rh/]rh7]ruh%jhh]rh}X&circuits.core.components.BaseComponentrr}r(h#Uh%jyubah+hubaubeubh)r}r(h#XHTTP Protocol Componentrh%jOh&XU/home/prologic/work/circuits/circuits/web/http.py:docstring of circuits.web.http.HTTPrh+hh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh;hh]rh}XHTTP Protocol Componentrr}r(h#jh%jubaubh)r}r(h#XImplements the HTTP server protocol and parses and processes incoming HTTP messages, creating and sending an appropriate response.rh%jOh&jh+hh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh;hh]rh}XImplements the HTTP server protocol and parses and processes incoming HTTP messages, creating and sending an appropriate response.rr}r(h#jh%jubaubh)r}r(h#XThe component handles :class:`~circuits.net.sockets.Read` events on its channel and collects the associated data until a complete HTTP request has been received. It parses the request's content and puts it in a :class:`~circuits.web.wrappers.Request` object and creates a corresponding :class:`~circuits.web.wrappers.Response` object. Then it emits a :class:`~circuits.web.events.Request` event with these objects as arguments.rh%jOh&jh+hh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh;hh]r(h}XThe component handles rr}r(h#XThe component handles rh%jubhY)r}r(h#X#:class:`~circuits.net.sockets.Read`rh%jh&h)h+h]h-}r(UreftyperXclassrhahbXcircuits.net.sockets.ReadrU refdomainrXpyrh/]rh1]rU refexplicitrh3]rh5]rh7]rhlhmhnhhojwuh:K h]rhq)r}r(h#jh-}r(h3]rh5]r(hwjXpy-classreh1]rh/]rh7]ruh%jh]rh}XReadrr}r(h#Uh%jubah+hubaubh}X events on its channel and collects the associated data until a complete HTTP request has been received. It parses the request's content and puts it in a rr}r(h#X events on its channel and collects the associated data until a complete HTTP request has been received. It parses the request's content and puts it in a rh%jubhY)r}r(h#X':class:`~circuits.web.wrappers.Request`rh%jh&h)h+h]h-}r(UreftyperXclassrhahbXcircuits.web.wrappers.RequestrU refdomainrXpyrh/]rh1]rU refexplicitrh3]rh5]rh7]rhlhmhnhhojwuh:K h]rhq)r}r(h#jh-}r(h3]rh5]r(hwjXpy-classreh1]rh/]rh7]ruh%jh]rh}XRequestrr}r(h#Uh%jubah+hubaubh}X$ object and creates a corresponding rr}r(h#X$ object and creates a corresponding rh%jubhY)r}r(h#X(:class:`~circuits.web.wrappers.Response`rh%jh&h)h+h]h-}r(UreftyperXclassrhahbXcircuits.web.wrappers.ResponserU refdomainrXpyrh/]rh1]rU refexplicitrh3]rh5]rh7]rhlhmhnhhojwuh:K h]rhq)r}r(h#jh-}r(h3]rh5]r(hwjXpy-classreh1]rh/]rh7]r uh%jh]r h}XResponser r }r (h#Uh%jubah+hubaubh}X object. Then it emits a rr}r(h#X object. Then it emits a rh%jubhY)r}r(h#X%:class:`~circuits.web.events.Request`rh%jh&h)h+h]h-}r(UreftyperXclassrhahbXcircuits.web.events.RequestrU refdomainrXpyrh/]rh1]rU refexplicitrh3]rh5]rh7]r hlhmhnhhojwuh:K h]r!hq)r"}r#(h#jh-}r$(h3]r%h5]r&(hwjXpy-classr'eh1]r(h/]r)h7]r*uh%jh]r+h}XRequestr,r-}r.(h#Uh%j"ubah+hubaubh}X' event with these objects as arguments.r/r0}r1(h#X' event with these objects as arguments.r2h%jubeubh)r3}r4(h#XOThe component defines several handlers that send a response back to the client.r5h%jOh&jh+hh-}r6(h3]r7h5]r8h1]r9h/]r:h7]r;uh:Kh;hh]r<h}XOThe component defines several handlers that send a response back to the client.r=r>}r?(h#j5h%j3ubaubh)r@}rA(h#Uh%jOh&Xb/home/prologic/work/circuits/circuits/web/http.py:docstring of circuits.web.http.HTTP._on_responserBh+hh-}rC(h/]rDh1]rEh3]rFh5]rGh7]rHUentriesrI]rJ(hX._on_response() (circuits.web.http.HTTP method)h UtrKauh:Nh;hh]rLubh)rM}rN(h#Uh%jOh&jBh+hh-}rO(hډhXpyrPh/]rQh1]rRh3]rSh5]rTh7]rUhXmethodrVhjVuh:Nh;hh]rW(h)rX}rY(h#XHTTP._on_response(response)rZh%jMh&hh+hh-}r[(h/]r\h ahh'Xcircuits.web.httpr]r^}r_bh1]r`h3]rah5]rbh7]rch ahXHTTP._on_responserdhhhuh:Nh;hh]re(j)rf}rg(h#X _on_responserhh%jXh&hh+jh-}ri(h3]rjh5]rkh1]rlh/]rmh7]rnuh:Nh;hh]roh}X _on_responserprq}rr(h#Uh%jfubaubj')rs}rt(h#Uh%jXh&hh+j*h-}ru(h3]rvh5]rwh1]rxh/]ryh7]rzuh:Nh;hh]r{j2)r|}r}(h#Xresponser~h-}r(h3]rh5]rh1]rh/]rh7]ruh%jsh]rh}Xresponserr}r(h#Uh%j|ubah+j@ubaubeubjN)r}r(h#Uh%jMh&hh+jQh-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]r(h)r}r(h#X``Response`` Event Handlerrh%jh&jBh+hh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh;hh]r(hq)r}r(h#X ``Response``rh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}XResponserr}r(h#Uh%jubah+hubh}X Event Handlerrr}r(h#X Event Handlerrh%jubeubcdocutils.nodes field_list r)r}r(h#Uh%jh&jBh+U field_listrh-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]rcdocutils.nodes field r)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]r(cdocutils.nodes field_name r)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}X Parametersrr}r(h#Uh%jubah+U field_namerubcdocutils.nodes field_body r)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]r(cdocutils.nodes strong r)r}r(h#Xresponserh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}Xresponserr}r(h#Uh%jubah+Ustrongrubh}X (rr}r(h#Uh%jubhY)r}r(h#X(:class:`~circuits.web.wrappers.Response`rh%jh&Nh+h]h-}r(UreftyperXclassrhahbXcircuits.web.wrappers.ResponserU refdomainrXpyrh/]rh1]rU refexplicitrh3]rh5]rh7]rhlhmhnhhojwuh:Nh]rhq)r}r(h#jh-}r(h3]rh5]r (hwjXpy-classr eh1]r h/]r h7]r uh%jh]rh}XResponserr}r(h#Uh%jubah+hubaubh}X)r}r(h#Uh%jubh}X -- rr}r(h#Uh%jubh}Xthe rr}r(h#Xthe rh%jubhq)r}r(h#X ``Response``rh-}r(h3]rh5]r h1]r!h/]r"h7]r#uh%jh]r$h}XResponser%r&}r'(h#Uh%jubah+hubh}X= object created when the HTTP request was initially received.r(r)}r*(h#X= object created when the HTTP request was initially received.r+h%jubeh+hubah+U field_bodyr,ubeh+Ufieldr-ubaubh)r.}r/(h#XThis handler builds an HTTP response data stream from the information contained in the *response* object and sends it to the client (firing ``Write`` events).r0h%jh&jBh+hh-}r1(h3]r2h5]r3h1]r4h/]r5h7]r6uh:Kh;hh]r7(h}XWThis handler builds an HTTP response data stream from the information contained in the r8r9}r:(h#XWThis handler builds an HTTP response data stream from the information contained in the r;h%j.ubcdocutils.nodes emphasis r<)r=}r>(h#X *response*r?h-}r@(h3]rAh5]rBh1]rCh/]rDh7]rEuh%j.h]rFh}XresponserGrH}rI(h#Uh%j=ubah+UemphasisrJubh}X+ object and sends it to the client (firing rKrL}rM(h#X+ object and sends it to the client (firing rNh%j.ubhq)rO}rP(h#X ``Write``rQh-}rR(h3]rSh5]rTh1]rUh/]rVh7]rWuh%j.h]rXh}XWriterYrZ}r[(h#Uh%jOubah+hubh}X events).r\r]}r^(h#X events).r_h%j.ubeubeubeubh)r`}ra(h#Uh%jOh&X^/home/prologic/work/circuits/circuits/web/http.py:docstring of circuits.web.http.HTTP._on_readrbh+hh-}rc(h/]rdh1]reh3]rfh5]rgh7]rhUentriesri]rj(hX*_on_read() (circuits.web.http.HTTP method)h Utrkauh:Nh;hh]rlubh)rm}rn(h#Uh%jOh&jbh+hh-}ro(hډhXpyrph/]rqh1]rrh3]rsh5]rth7]ruhXmethodrvhjvuh:Nh;hh]rw(h)rx}ry(h#XHTTP._on_read(sock, data)rzh%jmh&hh+hh-}r{(h/]r|h ahh'Xcircuits.web.httpr}r~}rbh1]rh3]rh5]rh7]rh ahX HTTP._on_readrhhhuh:Nh;hh]r(j)r}r(h#X_on_readrh%jxh&hh+jh-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]rh}X_on_readrr}r(h#Uh%jubaubj')r}r(h#Uh%jxh&hh+j*h-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]r(j2)r}r(h#Xsockrh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}Xsockrr}r(h#Uh%jubah+j@ubj2)r}r(h#Xdatarh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}Xdatarr}r(h#Uh%jubah+j@ubeubeubjN)r}r(h#Uh%jmh&hh+jQh-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]r(h)r}r(h#XRead Event Handlerrh%jh&jbh+hh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh;hh]rh}XRead Event Handlerrr}r(h#jh%jubaubh)r}r(h#XProcess any incoming data appending it to an internal buffer. Split the buffer by the standard HTTP delimiter CRLF and create Raw Event per line. Any unfinished lines of text, leave in the buffer.rh%jh&jbh+hh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh;hh]rh}XProcess any incoming data appending it to an internal buffer. Split the buffer by the standard HTTP delimiter CRLF and create Raw Event per line. Any unfinished lines of text, leave in the buffer.rr}r(h#jh%jubaubeubeubh)r}r(h#Uh%jOh&Xc/home/prologic/work/circuits/circuits/web/http.py:docstring of circuits.web.http.HTTP._on_httperrorrh+hh-}r(h/]rh1]rh3]rh5]rh7]rUentriesr]r(hX/_on_httperror() (circuits.web.http.HTTP method)h Utrauh:Nh;hh]rubh)r}r(h#Uh%jOh&jh+hh-}r(hډhXpyrh/]rh1]rh3]rh5]rh7]rhXmethodrhjuh:Nh;hh]r(h)r}r(h#X<HTTP._on_httperror(event, request, response, code, **kwargs)rh%jh&hh+hh-}r(h/]rh ahh'Xcircuits.web.httprr}rbh1]rh3]rh5]rh7]rh ahXHTTP._on_httperrorrhhhuh:Nh;hh]r(j)r}r(h#X _on_httperrorrh%jh&hh+jh-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]rh}X _on_httperrorr r }r (h#Uh%jubaubj')r }r (h#Uh%jh&hh+j*h-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]r(j2)r}r(h#Xeventrh-}r(h3]rh5]rh1]rh/]rh7]ruh%j h]rh}Xeventrr }r!(h#Uh%jubah+j@ubj2)r"}r#(h#Xrequestr$h-}r%(h3]r&h5]r'h1]r(h/]r)h7]r*uh%j h]r+h}Xrequestr,r-}r.(h#Uh%j"ubah+j@ubj2)r/}r0(h#Xresponser1h-}r2(h3]r3h5]r4h1]r5h/]r6h7]r7uh%j h]r8h}Xresponser9r:}r;(h#Uh%j/ubah+j@ubj2)r<}r=(h#Xcoder>h-}r?(h3]r@h5]rAh1]rBh/]rCh7]rDuh%j h]rEh}XcoderFrG}rH(h#Uh%j<ubah+j@ubj2)rI}rJ(h#X**kwargsrKh-}rL(h3]rMh5]rNh1]rOh/]rPh7]rQuh%j h]rRh}X**kwargsrSrT}rU(h#Uh%jIubah+j@ubeubeubjN)rV}rW(h#Uh%jh&hh+jQh-}rX(h3]rYh5]rZh1]r[h/]r\h7]r]uh:Nh;hh]r^(h)r_}r`(h#XDefault HTTP Error Handlerrah%jVh&jh+hh-}rb(h3]rch5]rdh1]reh/]rfh7]rguh:Kh;hh]rhh}XDefault HTTP Error Handlerrirj}rk(h#jah%j_ubaubh)rl}rm(h#XDefault Error Handler that by default just fires a ``Response`` event with the *response* as argument. The *response* is normally modified by a :class:`~circuits.web.errors.HTTPError` instance or a subclass thereof.rnh%jVh&jh+hh-}ro(h3]rph5]rqh1]rrh/]rsh7]rtuh:Kh;hh]ru(h}X3Default Error Handler that by default just fires a rvrw}rx(h#X3Default Error Handler that by default just fires a ryh%jlubhq)rz}r{(h#X ``Response``r|h-}r}(h3]r~h5]rh1]rh/]rh7]ruh%jlh]rh}XResponserr}r(h#Uh%jzubah+hubh}X event with the rr}r(h#X event with the rh%jlubj<)r}r(h#X *response*rh-}r(h3]rh5]rh1]rh/]rh7]ruh%jlh]rh}Xresponserr}r(h#Uh%jubah+jJubh}X as argument. The rr}r(h#X as argument. The rh%jlubj<)r}r(h#X *response*rh-}r(h3]rh5]rh1]rh/]rh7]ruh%jlh]rh}Xresponserr}r(h#Uh%jubah+jJubh}X is normally modified by a rr}r(h#X is normally modified by a rh%jlubhY)r}r(h#X':class:`~circuits.web.errors.HTTPError`rh%jlh&Nh+h]h-}r(UreftyperXclassrhahbXcircuits.web.errors.HTTPErrorrU refdomainrXpyrh/]rh1]rU refexplicitrh3]rh5]rh7]rhlhmhnhhojwuh:Nh]rhq)r}r(h#jh-}r(h3]rh5]r(hwjXpy-classreh1]rh/]rh7]ruh%jh]rh}X HTTPErrorrr}r(h#Uh%jubah+hubaubh}X instance or a subclass thereof.rr}r(h#X instance or a subclass thereof.rh%jlubeubeubeubh)r}r(h#Uh%jOh&Xi/home/prologic/work/circuits/circuits/web/http.py:docstring of circuits.web.http.HTTP._on_request_successrh+hh-}r(h/]rh1]rh3]rh5]rh7]rUentriesr]r(hX5_on_request_success() (circuits.web.http.HTTP method)hUtrauh:Nh;hh]rubh)r}r(h#Uh%jOh&jh+hh-}r(hډhXpyrh/]rh1]rh3]rh5]rh7]rhXmethodrhjuh:Nh;hh]r(h)r}r(h#X"HTTP._on_request_success(e, value)rh%jh&hh+hh-}r(h/]rhahh'Xcircuits.web.httprr}rbh1]rh3]rh5]rh7]rhahXHTTP._on_request_successrhhhuh:Nh;hh]r(j)r}r(h#X_on_request_successrh%jh&hh+jh-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]rh}X_on_request_successrr}r(h#Uh%jubaubj')r}r(h#Uh%jh&hh+j*h-}r(h3]rh5]rh1]rh/]rh7]ruh:Nh;hh]r (j2)r }r (h#Xeh-}r (h3]r h5]rh1]rh/]rh7]ruh%jh]rh}Xer}r(h#Uh%j ubah+j@ubj2)r}r(h#Xvaluerh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}Xvaluerr }r!(h#Uh%jubah+j@ubeubeubjN)r"}r#(h#Uh%jh&hh+jQh-}r$(h3]r%h5]r&h1]r'h/]r(h7]r)uh:Nh;hh]r*(h)r+}r,(h#XHandler for the ``RequestSuccess`` event that is automatically generated after all handlers for a :class:`~circuits.web.events.Request` event have been invoked successfully.r-h%j"h&jh+hh-}r.(h3]r/h5]r0h1]r1h/]r2h7]r3uh:Kh;hh]r4(h}XHandler for the r5r6}r7(h#XHandler for the r8h%j+ubhq)r9}r:(h#X``RequestSuccess``r;h-}r<(h3]r=h5]r>h1]r?h/]r@h7]rAuh%j+h]rBh}XRequestSuccessrCrD}rE(h#Uh%j9ubah+hubh}X@ event that is automatically generated after all handlers for a rFrG}rH(h#X@ event that is automatically generated after all handlers for a rIh%j+ubhY)rJ}rK(h#X%:class:`~circuits.web.events.Request`rLh%j+h&Nh+h]h-}rM(UreftyperNXclassrOhahbXcircuits.web.events.RequestrPU refdomainrQXpyrRh/]rSh1]rTU refexplicitrUh3]rVh5]rWh7]rXhlhmhnhhojwuh:Nh]rYhq)rZ}r[(h#jLh-}r\(h3]r]h5]r^(hwjRXpy-classr_eh1]r`h/]rah7]rbuh%jJh]rch}XRequestrdre}rf(h#Uh%jZubah+hubaubh}X& event have been invoked successfully.rgrh}ri(h#X& event have been invoked successfully.rjh%j+ubeubj)rk}rl(h#Uh%j"h&jh+jh-}rm(h3]rnh5]roh1]rph/]rqh7]rruh:Nh;hh]rsj)rt}ru(h#Uh-}rv(h3]rwh5]rxh1]ryh/]rzh7]r{uh%jkh]r|(j)r}}r~(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jth]rh}X Parametersrr}r(h#Uh%j}ubah+jubj)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jth]rcdocutils.nodes bullet_list r)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]r(cdocutils.nodes list_item r)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]r(j)r}r(h#Xeh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}Xer}r(h#Uh%jubah+jubh}X -- rr}r(h#Uh%jubh}Xthe successfully handled rr}r(h#Xthe successfully handled rh%jubhq)r}r(h#X ``Request``rh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh}XRequestrr}r(h#Uh%jubah+hubh}X, event (having as attributes the associated rr}r(h#X, event (having as attributes the associated rh%jubhY)r}r(h#X':class:`~circuits.web.wrappers.Request`rh%jh&Nh+h]h-}r(UreftyperXclassrhahbXcircuits.web.wrappers.RequestrU refdomainrXpyrh/]rh1]rU refexplicitrh3]rh5]rh7]rhlhmhnhhojwuh:Nh]rhq)r}r(h#jh-}r(h3]rh5]r(hwjXpy-classreh1]rh/]rh7]ruh%jh]rh}XRequestrr}r(h#Uh%jubah+hubaubh}X and rr}r(h#X and rh%jubhY)r}r(h#X(:class:`~circuits.web.wrappers.Response`rh%jh&Nh+h]h-}r(UreftyperXclassrhahbXcircuits.web.wrappers.ResponserU refdomainrXpyrh/]rh1]rU refexplicitrh3]rh5]rh7]rhlhmhnhhojwuh:Nh]rhq)r}r(h#jh-}r(h3]rh5]r(hwjXpy-classreh1]r h/]r h7]r uh%jh]r h}XResponser r}r(h#Uh%jubah+hubaubh}X objects).rr}r(h#X objects).rh%jubeh+hubah+U list_itemrubj)r}r(h#Uh-}r(h3]rh5]rh1]rh/]rh7]ruh%jh]rh)r}r(h#Uh-}r (h3]r!h5]r"h1]r#h/]r$h7]r%uh%jh]r&(j)r'}r((h#Xvaluer)h-}r*(h3]r+h5]r,h1]r-h/]r.h7]r/uh%jh]r0h}Xvaluer1r2}r3(h#Uh%j'ubah+jubh}X -- r4r5}r6(h#Uh%jubh}X0the value(s) returned by the invoked handler(s).r7r8}r9(h#X0the value(s) returned by the invoked handler(s).r:h%jubeh+hubah+jubeh+U bullet_listr;ubah+j,ubeh+j-ubaubh)r<}r=(h#X%This handler converts the value(s) returned by the (successfully invoked) handlers for the initial ``Request`` event to a body and assigns it to the ``Response`` object's ``body`` attribute. It then fires a :class:`~circuits.web.events.Response` event with the ``Response`` object as argument.r>h%j"h&jh+hh-}r?(h3]r@h5]rAh1]rBh/]rCh7]rDuh:K h;hh]rE(h}XcThis handler converts the value(s) returned by the (successfully invoked) handlers for the initial rFrG}rH(h#XcThis handler converts the value(s) returned by the (successfully invoked) handlers for the initial rIh%j<ubhq)rJ}rK(h#X ``Request``rLh-}rM(h3]rNh5]rOh1]rPh/]rQh7]rRuh%j<h]rSh}XRequestrTrU}rV(h#Uh%jJubah+hubh}X' event to a body and assigns it to the rWrX}rY(h#X' event to a body and assigns it to the rZh%j<ubhq)r[}r\(h#X ``Response``r]h-}r^(h3]r_h5]r`h1]rah/]rbh7]rcuh%j<h]rdh}XResponsererf}rg(h#Uh%j[ubah+hubh}X object's rhri}rj(h#X object's rkh%j<ubhq)rl}rm(h#X``body``rnh-}ro(h3]rph5]rqh1]rrh/]rsh7]rtuh%j<h]ruh}Xbodyrvrw}rx(h#Uh%jlubah+hubh}X attribute. It then fires a ryrz}r{(h#X attribute. It then fires a r|h%j<ubhY)r}}r~(h#X&:class:`~circuits.web.events.Response`rh%j<h&Nh+h]h-}r(UreftyperXclassrhahbXcircuits.web.events.ResponserU refdomainrXpyrh/]rh1]rU refexplicitrh3]rh5]rh7]rhlhmhnhhojwuh:Nh]rhq)r}r(h#jh-}r(h3]rh5]r(hwjXpy-classreh1]rh/]rh7]ruh%j}h]rh}XResponserr}r(h#Uh%jubah+hubaubh}X event with the rr}r(h#X event with the rh%j<ubhq)r}r(h#X ``Response``rh-}r(h3]rh5]rh1]rh/]rh7]ruh%j<h]rh}XResponserr}r(h#Uh%jubah+hubh}X object as argument.rr}r(h#X object as argument.rh%j<ubeubeubeubeubeubeubh=)r}r(h#Uh%h>h&h)h+hBh-}r(h3]rh5]rh1]rh/]rhah7]rhauh:Kh;hh]r(hM)r}r(h#XEventsrh%jh&h)h+hQh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh;hh]rh}XEventsrr}r(h#jh%jubaubh)r}r(h#XGSee :class:`circuits.web.events.Request` in :ref:`circuits_web_events`.rh%jh&h)h+hh-}r(h3]rh5]rh1]rh/]rh7]ruh:Kh;hh]r(h}XSee rr}r(h#XSee rh%jubhY)r}r(h#X$:class:`circuits.web.events.Request`rh%jh&h)h+h]h-}r(UreftyperXclassrhahbXcircuits.web.events.RequestrU refdomainrXpyrh/]rh1]rU refexplicitrh3]rh5]rh7]rhlhmhnNhojwuh:Kh]rhq)r}r(h#jh-}r(h3]rh5]r(hwjXpy-classreh1]rh/]rh7]ruh%jh]rh}Xcircuits.web.events.Requestrr}r(h#Uh%jubah+hubaubh}X in rr}r(h#X in rh%jubhY)r}r(h#X:ref:`circuits_web_events`rh%jh&h)h+h]h-}r(UreftyperXrefrhahbXcircuits_web_eventsrU refdomainrXstdrh/]rh1]rU refexplicitrh3]rh5]rh7]rhlhmuh:Kh]rj<)r}r(h#jh-}r(h3]rh5]r(hwjXstd-refr eh1]r h/]r h7]r uh%jh]r h}Xcircuits_web_eventsrr}r(h#Uh%jubah+jJubaubh}X.r}r(h#X.h%jubeubeubh=)r}r(h#Uh%h>h&h)h+hBh-}r(h3]rh5]rh1]rh/]rhah7]rh auh:Kh;hh]r(hM)r}r(h#X Functionsrh%jh&h)h+hQh-}r(h3]r h5]r!h1]r"h/]r#h7]r$uh:Kh;hh]r%h}X Functionsr&r'}r((h#jh%jubaubh)r)}r*(h#X**none**r+h%jh&h)h+hh-}r,(h3]r-h5]r.h1]r/h/]r0h7]r1uh:Kh;hh]r2j)r3}r4(h#j+h-}r5(h3]r6h5]r7h1]r8h/]r9h7]r:uh%j)h]r;h}Xnoner<r=}r>(h#Uh%j3ubah+jubaubeubeubeh#UU transformerr?NU footnote_refsr@}rAUrefnamesrB}rCUsymbol_footnotesrD]rEUautofootnote_refsrF]rGUsymbol_footnote_refsrH]rIU citationsrJ]rKh;hU current_linerLNUtransform_messagesrM]rNcdocutils.nodes system_message rO)rP}rQ(h#Uh-}rR(h3]rSUlevelrTKh/]rUh1]rVUsourcerWh)h5]rXh7]rYUlinerZKUtyper[UINFOr\uh]r]h)r^}r_(h#Uh-}r`(h3]rah5]rbh1]rch/]rdh7]reuh%jPh]rfh}X7Hyperlink target "circuits-web-http" is not referenced.rgrh}ri(h#Uh%j^ubah+hubah+Usystem_messagerjubaUreporterrkNUid_startrlKU autofootnotesrm]rnU citation_refsro}rpUindirect_targetsrq]rrUsettingsrs(cdocutils.frontend Values rtoru}rv(Ufootnote_backlinksrwKUrecord_dependenciesrxNU rfc_base_urlryUhttp://tools.ietf.org/html/rzU tracebackr{Upep_referencesr|NUstrip_commentsr}NU toc_backlinksr~UentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNhQNUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUB/home/prologic/work/circuits/docs/source/api/circuits_web_http.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hjhHh )r}r(h#Uh%h>h&hh+h,h-}r(h3]rh/]rhHah1]rUismodrh5]rh7]ruh:Kh;hh]rubhhh jXhjh jxhh>h jhh>hhhjuUsubstitution_namesr}rh+h;h-}r(h3]rh/]rh1]rUsourcerh)h5]rh7]ruU footnotesr]rUrefidsr}rh]rh!asub.circuits-2.1.0/docs/build/doctrees/dev/0000755000014400001440000000000012113366740017510 5ustar prologicuserscircuits-2.1.0/docs/build/doctrees/dev/contributing.doctree0000644000014400001440000003020112113366670023564 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(Xadding new featuresqNX3chat to us on #circuits on the freenode irc networkqXsubmitting bug reportsqNXsubmit a new issueq Xshare your storyq NXwriting new testsq NX pull requestq Xcontributing to circuitsq NXfork circuits-devquUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hUadding-new-featuresqhU2chat-to-us-on-circuits-on-the-freenode-irc-networkqhUsubmitting-bug-reportsqh Usubmit-a-new-issueqh Ushare-your-storyqh Uwriting-new-testsqh U pull-requestqh Ucontributing-to-circuitsqhUfork-circuits-devq uUchildrenq!]q"cdocutils.nodes section q#)q$}q%(U rawsourceq&UUparentq'hUsourceq(cdocutils.nodes reprunicode q)X=/home/prologic/work/circuits/docs/source/dev/contributing.rstq*q+}q,bUtagnameq-Usectionq.U attributesq/}q0(Udupnamesq1]q2Uclassesq3]q4Ubackrefsq5]q6Uidsq7]q8haUnamesq9]q:h auUlineq;KUdocumentq)q?}q@(h&XContributing to circuitsqAh'h$h(h+h-UtitleqBh/}qC(h1]qDh3]qEh5]qFh7]qGh9]qHuh;Kh)qf}qg(h&XShare your storyqhh'h]h(h+h-hBh/}qi(h1]qjh3]qkh5]qlh7]qmh9]qnuh;Kh`.quh'h]h(h+h-hRh/}qv(h1]qwh3]qxh5]qyh7]qzh9]q{uh;K h`qh'hsh(h+h-U pending_xrefqh/}q(UreftypeqXdocqUrefwarnqU reftargetqX/usersqU refdomainqUh7]qh5]qU refexplicitqh1]qh3]qh9]qUrefdocqUdev/contributingquh;K h!]qcdocutils.nodes literal q)q}q(h&hh/}q(h1]qh3]q(Uxrefqheh5]qh7]qh9]quh'hh!]qhJX Users Pageqq}q(h&Uh'hubah-UliteralqubaubhJX.q}q(h&X.h'hsubeubeubh#)q}q(h&Uh'h$h(h+h-h.h/}q(h1]qh3]qh5]qh7]qhah9]qhauh;Kh)q}q(h&XSubmitting Bug Reportsqh'hh(h+h-hBh/}q(h1]qh3]qh5]qh7]qh9]quh;Kh)r}r (h&XWriting new testsr!h'jh(h+h-hBh/}r"(h1]r#h3]r$h5]r%h7]r&h9]r'uh;Kh`_, write more tests that cover more of our code base and submit a `Pull Request `_. Many Thanks!r.h'jh(h+h-hRh/}r/(h1]r0h3]r1h5]r2h7]r3h9]r4uh;K"h`_r<h/}r=(Unamer>XFork circuits-devr?Urefurir@X0https://bitbucket.org/prologic/circuits-dev/forkrAh7]rBh5]rCh1]rDh3]rEh9]rFuh'j,h!]rGhJXFork circuits-devrHrI}rJ(h&Uh'j:ubah-jubcdocutils.nodes target rK)rL}rM(h&X3 rNU referencedrOKh'j,h-UtargetrPh/}rQ(UrefurirRjAh7]rSh ah5]rTh1]rUh3]rVh9]rWhauh!]rXubhJXA, write more tests that cover more of our code base and submit a rYrZ}r[(h&XA, write more tests that cover more of our code base and submit a r\h'j,ubj)r]}r^(h&XN`Pull Request `_r_h/}r`(UnameraX Pull Requestrbj@X<https://bitbucket.org/prologic/circuits-dev/pull-request/newrch7]rdh5]reh1]rfh3]rgh9]rhuh'j,h!]rihJX Pull Requestrjrk}rl(h&Uh'j]ubah-jubjK)rm}rn(h&X? rojOKh'j,h-jPh/}rp(Urefurirqjch7]rrhah5]rsh1]rth3]ruh9]rvh auh!]rwubhJX. Many Thanks!rxry}rz(h&X. Many Thanks!r{h'j,ubeubeubh#)r|}r}(h&Uh'h$h(h+h-h.h/}r~(h1]rh3]rh5]rh7]rhah9]rhauh;K(h)r}r(h&XAdding New Featuresrh'j|h(h+h-hBh/}r(h1]rh3]rh5]rh7]rh9]ruh;K(h`_ or rh'jh(h+h-U list_itemrh/}r(h1]rh3]rh5]rh7]rh9]ruh;Nh`_rh'jh(h+h-hRh/}r(h1]rh3]rh5]rh7]rh9]ruh;K/h!]r(j)r}r(h&jh/}r(UnamerX3Chat to us on #circuits on the FreeNode IRC Networkrj@Xhttp://freenode.orgrh7]rh5]rh1]rh3]rh9]ruh'jh!]rhJX3Chat to us on #circuits on the FreeNode IRC Networkrr}r(h&Uh'jubah-jubjK)r}r(h&X rjOKh'jh-jPh/}r(Urefurirjh7]rhah5]rh1]rh3]rh9]rhauh!]rubeubhN)r}r(h&Xorrh'jh(h+h-hRh/}r(h1]rh3]rh5]rh7]rh9]ruh;K1h!]rhJXorrr}r(h&jh'jubaubeubj)r}r(h&XE`Submit a NEW Issue `_rh'jh(h+h-jh/}r(h1]rh3]rh5]rh7]rh9]ruh;Nhr jOKh'jh-jPh/}r (Urefurirjh7]rhah5]rh1]rh3]rh9]rh auh!]rubeubaubeubeubeubah&UU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr ]r!hNU halt_levelr?KU strip_classesr@NhBNUerror_encoding_error_handlerrAUbackslashreplacerBUdebugrCNUembed_stylesheetrDUoutput_encoding_error_handlerrEUstrictrFU sectnum_xformrGKUdump_transformsrHNU docinfo_xformrIKUwarning_streamrJNUpep_file_url_templaterKUpep-%04drLUexit_status_levelrMKUconfigrNNUstrict_visitorrONUcloak_email_addressesrPUtrim_footnote_reference_spacerQUenvrRNUdump_pseudo_xmlrSNUexpose_internalsrTNUsectsubtitle_xformrUU source_linkrVNUrfc_referencesrWNUoutput_encodingrXUutf-8rYU source_urlrZNUinput_encodingr[U utf-8-sigr\U_disable_configr]NU id_prefixr^UU tab_widthr_KUerror_encodingr`U ISO-8859-1raU_sourcerbU=/home/prologic/work/circuits/docs/source/dev/contributing.rstrcUgettext_compactrdU generatorreNUdump_internalsrfNU smart_quotesrgU pep_base_urlrhUhttp://www.python.org/dev/peps/riUsyntax_highlightrjUlongrkUinput_encoding_error_handlerrljFUauto_id_prefixrmUidrnUdoctitle_xformroUstrip_elements_with_classesrpNU _config_filesrq]rrUfile_insertion_enabledrsKU raw_enabledrtKU dump_settingsruNubUsymbol_footnote_startrvKUidsrw}rx(hh]hhhjhjhj h jLhh$hjmhj|uUsubstitution_namesry}rzh-h)q?}q@(h&XDevelopment IntroductionqAh'h$h(h+h-UtitleqBh/}qC(h1]qDh3]qEh5]qFh7]qGh9]qHuh;Kh)qf}qg(h&X Standardsqhh'h]h(h+h-hBh/}qi(h1]qjh3]qkh5]qlh7]qmh9]qnuh;K h`_ qh'hh(h+h-U list_itemqh/}q(h1]qh3]qh5]qh7]qh9]quh;Nh`_qh'hh(h+h-hRh/}q(h1]qh3]qh5]qh7]qh9]quh;K h!]q(cdocutils.nodes reference q)q}q(h&hh/}q(UnameqXpep8qUrefuriqX(http://www.python.org/dev/peps/pep-0008/qh7]qh5]qh1]qh3]qh9]quh'hh!]qhJXpep8qq}q(h&Uh'hubah-U referencequbcdocutils.nodes target q)q}q(h&X+ qU referencedqKh'hh-Utargetqh/}q(Urefuriqhh7]qhah5]qh1]qh3]qh9]qh auh!]qubeubaubaubeubh#)q}q(h&Uh'h$h(h+h-h.h/}q(h1]qh3]qh5]qh7]qh ah9]qhauh;Kh)q}q(h&XToolsqh'hh(h+h-hBh/}q(h1]qh3]qh5]qh7]qh9]quh;KhWe use the following tools to develop circuits and share code:qh'hh(h+h-hRh/}q(h1]qh3]qh5]qh7]qh9]quh;KhWe use the following tools to develop circuits and share code:q⅁q}q(h&hh'hubaubh)q}q(h&Uh'hh(h+h-hh/}q(hX-h7]qh5]qh1]qh3]qh9]quh;Kh**Code Sharing:** `Mercurial `_qh'hh(h+h-hh/}q(h1]qh3]qh5]qh7]qh9]quh;Nh**Code Sharing:** `Mercurial `_qh'hh(h+h-hRh/}q(h1]qh3]qh5]qh7]qh9]ruh;Kh!]r(cdocutils.nodes strong r)r}r(h&X**Code Sharing:**rh/}r(h1]rh3]rh5]r h7]r h9]r uh'hh!]r hJX Code Sharing:r r}r(h&Uh'jubah-UstrongrubhJX r}r(h&X h'hubh)r}r(h&X,`Mercurial `_rh/}r(UnamerX MercurialrhXhttp://mercurial.selenic.com/rh7]rh5]rh1]rh3]rh9]ruh'hh!]rhJX Mercurialr r!}r"(h&Uh'jubah-hubh)r#}r$(h&X r%hKh'hh-hh/}r&(Urefurir'jh7]r(hah5]r)h1]r*h3]r+h9]r,h auh!]r-ubeubaubh)r.}r/(h&XY**Code Hosting and Bug Reporting:** `BitBucket `_r0h'hh(h+h-hh/}r1(h1]r2h3]r3h5]r4h7]r5h9]r6uh;Nh`_r:h'j.h(h+h-hRh/}r;(h1]r<h3]r=h5]r>h7]r?h9]r@uh;Kh!]rA(j)rB}rC(h&X#**Code Hosting and Bug Reporting:**rDh/}rE(h1]rFh3]rGh5]rHh7]rIh9]rJuh'j8h!]rKhJXCode Hosting and Bug Reporting:rLrM}rN(h&Uh'jBubah-jubhJX rO}rP(h&X h'j8ubh)rQ}rR(h&X5`BitBucket `_rSh/}rT(UnamerUX BitBucketrVhX&http://bitbucket.org/prologic/circuitsrWh7]rXh5]rYh1]rZh3]r[h9]r\uh'j8h!]r]hJX BitBucketr^r_}r`(h&Uh'jQubah-hubh)ra}rb(h&X) rchKh'j8h-hh/}rd(UrefurirejWh7]rfhah5]rgh1]rhh3]rih9]rjhauh!]rkubeubaubh)rl}rm(h&XV**Project Management:** `Pivotal Tracker `_rnh'hh(h+h-hh/}ro(h1]rph3]rqh5]rrh7]rsh9]rtuh;Nh`_rxh'jlh(h+h-hRh/}ry(h1]rzh3]r{h5]r|h7]r}h9]r~uh;Kh!]r(j)r}r(h&X**Project Management:**rh/}r(h1]rh3]rh5]rh7]rh9]ruh'jvh!]rhJXProject Management:rr}r(h&Uh'jubah-jubhJX r}r(h&X h'jvubh)r}r(h&X>`Pivotal Tracker `_rh/}r(UnamerXPivotal TrackerrhX)http://pivotaltracker.com/projects/695621rh7]rh5]rh1]rh3]rh9]ruh'jvh!]rhJXPivotal Trackerrr}r(h&Uh'jubah-hubh)r}r(h&X, rhKh'jvh-hh/}r(Urefurirjh7]rhah5]rh1]rh3]rh9]rhauh!]rubeubaubh)r}r(h&XM**Documentation Hosting:** `Read the Docs `_rh'hh(h+h-hh/}r(h1]rh3]rh5]rh7]rh9]ruh;Nh`_rh'jh(h+h-hRh/}r(h1]rh3]rh5]rh7]rh9]ruh;Kh!]r(j)r}r(h&X**Documentation Hosting:**rh/}r(h1]rh3]rh5]rh7]rh9]ruh'jh!]rhJXDocumentation Hosting:rr}r(h&Uh'jubah-jubhJX r}r(h&X h'jubh)r}r(h&X2`Read the Docs `_rh/}r(UnamerX Read the DocsrhXhttp://circuits.readthedocs.orgrh7]rh5]rh1]rh3]rh9]ruh'jh!]rhJX Read the Docsrr}r(h&Uh'jubah-hubh)r}r(h&X" rhKh'jh-hh/}r(Urefurirjh7]rhah5]rh1]rh3]rh9]rhauh!]rubeubaubh)r}r(h&XZ**Package Hosting:** `Python Package Index (PyPi) `_rh'hh(h+h-hh/}r(h1]rh3]rh5]rh7]rh9]ruh;Nh`_rh'jh(h+h-hRh/}r(h1]rh3]rh5]rh7]rh9]ruh;Kh!]r(j)r}r(h&X**Package Hosting:**rh/}r(h1]rh3]rh5]rh7]rh9]ruh'jh!]rhJXPackage Hosting:rr}r(h&Uh'jubah-jubhJX r }r (h&X h'jubh)r }r (h&XE`Python Package Index (PyPi) `_r h/}r(UnamerXPython Package Index (PyPi)rhX$http://pypi.python.org/pypi/circuitsrh7]rh5]rh1]rh3]rh9]ruh'jh!]rhJXPython Package Index (PyPi)rr}r(h&Uh'j ubah-hubh)r}r(h&X' rhKh'jh-hh/}r(Urefurirjh7]r hah5]r!h1]r"h3]r#h9]r$h auh!]r%ubeubaubeubeubeubah&UU transformerr&NU footnote_refsr'}r(Urefnamesr)}r*Usymbol_footnotesr+]r,Uautofootnote_refsr-]r.Usymbol_footnote_refsr/]r0U citationsr1]r2h(cdocutils.frontend Values r?or@}rA(Ufootnote_backlinksrBKUrecord_dependenciesrCNU rfc_base_urlrDUhttp://tools.ietf.org/html/rEU tracebackrFUpep_referencesrGNUstrip_commentsrHNU toc_backlinksrIUentryrJU language_coderKUenrLU datestamprMNU report_levelrNKU _destinationrONU halt_levelrPKU strip_classesrQNhBNUerror_encoding_error_handlerrRUbackslashreplacerSUdebugrTNUembed_stylesheetrUUoutput_encoding_error_handlerrVUstrictrWU sectnum_xformrXKUdump_transformsrYNU docinfo_xformrZKUwarning_streamr[NUpep_file_url_templater\Upep-%04dr]Uexit_status_levelr^KUconfigr_NUstrict_visitorr`NUcloak_email_addressesraUtrim_footnote_reference_spacerbUenvrcNUdump_pseudo_xmlrdNUexpose_internalsreNUsectsubtitle_xformrfU source_linkrgNUrfc_referencesrhNUoutput_encodingriUutf-8rjU source_urlrkNUinput_encodingrlU utf-8-sigrmU_disable_configrnNU id_prefixroUU tab_widthrpKUerror_encodingrqU ISO-8859-1rrU_sourcersU=/home/prologic/work/circuits/docs/source/dev/introduction.rstrtUgettext_compactruU generatorrvNUdump_internalsrwNU smart_quotesrxU pep_base_urlryUhttp://www.python.org/dev/peps/rzUsyntax_highlightr{Ulongr|Uinput_encoding_error_handlerr}jWUauto_id_prefixr~UidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hjahh$hj#hjhh]hhhjh hhjuUsubstitution_namesr}rh-h.. _Pivotal Tracker: http://pivotaltracker.com/projects/695621q-U referencedq.KUparentq/hUsourceq0cdocutils.nodes reprunicode q1X:/home/prologic/work/circuits/docs/source/dev/processes.rstq2q3}q4bUtagnameq5Utargetq6U attributesq7}q8(Urefuriq9X)http://pivotaltracker.com/projects/695621q:Uidsq;]qUdupnamesq?]q@UclassesqA]qBUnamesqC]qDhauUlineqEKUdocumentqFhh']qGubcdocutils.nodes section qH)qI}qJ(h,Uh/hh0h3h5UsectionqKh7}qL(h?]qMhA]qNh=]qOh;]qPh ahC]qQh auhEKhFhh']qR(cdocutils.nodes title qS)qT}qU(h,XDevelopment ProcessesqVh/hIh0h3h5UtitleqWh7}qX(h?]qYhA]qZh=]q[h;]q\hC]q]uhEKhFhh']q^cdocutils.nodes Text q_XDevelopment Processesq`qa}qb(h,hVh/hTubaubcdocutils.nodes paragraph qc)qd}qe(h,XWe document all our internal development processes here so you know exactly how we work and what to expect. If you find any issues or problems please let us know!qfh/hIh0h3h5U paragraphqgh7}qh(h?]qihA]qjh=]qkh;]qlhC]qmuhEKhFhh']qnh_XWe document all our internal development processes here so you know exactly how we work and what to expect. If you find any issues or problems please let us know!qoqp}qq(h,hfh/hdubaubhH)qr}qs(h,Uh/hIh0h3h5hKh7}qt(h?]quhA]qvh=]qwh;]qxh%ahC]qyhauhEK hFhh']qz(hS)q{}q|(h,X&Software Development Life Cycle (SDLC)q}h/hrh0h3h5hWh7}q~(h?]qhA]qh=]qh;]qhC]quhEK hFhh']qh_X&Software Development Life Cycle (SDLC)qq}q(h,h}h/h{ubaubhc)q}q(h,XWe employ the use of the `SCRUM Agile Process `_ and use `Pivotal Tracker`_ to track our stories, bugs, chores and releases. If you wish to contribute to circuits, please famiilarize yourself with SCRUM and Pivotal Tracker.qh/hrh0h3h5hgh7}q(h?]qhA]qh=]qh;]qhC]quhEKhFhh']q(h_XWe employ the use of the qq}q(h,XWe employ the use of the qh/hubcdocutils.nodes reference q)q}q(h,XI`SCRUM Agile Process `_qh7}q(UnameqXSCRUM Agile Processqh9X0http://en.wikipedia.org/wiki/Scrum_(development)qh;]qh=]qh?]qhA]qhC]quh/hh']qh_XSCRUM Agile Processqq}q(h,Uh/hubah5U referencequbh))q}q(h,X3 qh.Kh/hh5h6h7}q(Urefuriqhh;]qh!ah=]qh?]qhA]qhC]qh auh']qubh_X and use qq}q(h,X and use qh/hubh)q}q(h,X`Pivotal Tracker`_qUresolvedqKh/hh5hh7}q(UnameqXPivotal Trackerqh9h:h;]qh=]qh?]qhA]qhC]quh']qh_XPivotal Trackerqąq}q(h,Uh/hubaubh_X to track our stories, bugs, chores and releases. If you wish to contribute to circuits, please famiilarize yourself with SCRUM and Pivotal Tracker.qDžq}q(h,X to track our stories, bugs, chores and releases. If you wish to contribute to circuits, please famiilarize yourself with SCRUM and Pivotal Tracker.qh/hubeubeubhH)q}q(h,Uh/hIh0h3h5hKh7}q(h?]qhA]qh=]qh;]qhahC]qhauhEKhFhh']q(hS)q}q(h,X Bug Reportsqh/hh0h3h5hWh7}q(h?]qhA]qh=]qh;]qhC]quhEKhFhh']qh_X Bug Reportsqޅq}q(h,hh/hubaubcdocutils.nodes bullet_list q)q}q(h,Uh/hh0h3h5U bullet_listqh7}q(UbulletqX-h;]qh=]qh?]qhA]qhC]quhEKhFhh']q(cdocutils.nodes list_item q)q}q(h,XPNew Bug Reports are submitted via: http://bitbucket.org/prologic/circuits/issuesqh/hh0h3h5U list_itemqh7}q(h?]qhA]qh=]qh;]qhC]quhENhFhh']qhc)q}q(h,XPNew Bug Reports are submitted via: http://bitbucket.org/prologic/circuits/issuesqh/hh0h3h5hgh7}q(h?]qhA]qh=]qh;]rhC]ruhEKh']r(h_X#New Bug Reports are submitted via: rr}r(h,X#New Bug Reports are submitted via: rh/hubh)r}r(h,X-http://bitbucket.org/prologic/circuits/issuesr h7}r (Urefurir X-http://bitbucket.org/prologic/circuits/issuesr h;]r h=]rh?]rhA]rhC]ruh/hh']rh_X-http://bitbucket.org/prologic/circuits/issuesrr}r(h,Uh/jubah5hubeubaubh)r}r(h,X3Confirmation and Discussion of all New Bug Reports.rh/hh0h3h5hh7}r(h?]rhA]rh=]rh;]rhC]ruhENhFhh']rhc)r }r!(h,jh/jh0h3h5hgh7}r"(h?]r#hA]r$h=]r%h;]r&hC]r'uhEKh']r(h_X3Confirmation and Discussion of all New Bug Reports.r)r*}r+(h,jh/j ubaubaubh)r,}r-(h,XLOnce confirmed, a new Bug is raised in `Pivotal Tracker`_ into the IceBox. r.h/hh0h3h5hh7}r/(h?]r0hA]r1h=]r2h;]r3hC]r4uhENhFhh']r5hc)r6}r7(h,XJOnce confirmed, a new Bug is raised in `Pivotal Tracker`_ into the IceBox.r8h/j,h0h3h5hgh7}r9(h?]r:hA]r;h=]r<h;]r=hC]r>uhEKh']r?(h_X'Once confirmed, a new Bug is raised in r@rA}rB(h,X'Once confirmed, a new Bug is raised in rCh/j6ubh)rD}rE(h,X`Pivotal Tracker`_rFhKh/j6h5hh7}rG(UnamerHXPivotal TrackerrIh9h:h;]rJh=]rKh?]rLhA]rMhC]rNuh']rOh_XPivotal TrackerrPrQ}rR(h,Uh/jDubaubh_X into the IceBox.rSrT}rU(h,X into the IceBox.rVh/j6ubeubaubeubeubhH)rW}rX(h,Uh/hIh0h3h5hKh7}rY(h?]rZhA]r[h=]r\h;]r]h#ahC]r^hauhEK hFhh']r_(hS)r`}ra(h,XFeature Requestsrbh/jWh0h3h5hWh7}rc(h?]rdhA]reh=]rfh;]rghC]rhuhEK hFhh']rih_XFeature Requestsrjrk}rl(h,jbh/j`ubaubh)rm}rn(h,Uh/jWh0h3h5hh7}ro(hX-h;]rph=]rqh?]rrhA]rshC]rtuhEK#hFhh']ru(h)rv}rw(h,XUNew Feature Requests are submitted via: http://bitbucket.org/prologic/circuits/issuesrxh/jmh0h3h5hh7}ry(h?]rzhA]r{h=]r|h;]r}hC]r~uhENhFhh']rhc)r}r(h,XUNew Feature Requests are submitted via: http://bitbucket.org/prologic/circuits/issuesrh/jvh0h3h5hgh7}r(h?]rhA]rh=]rh;]rhC]ruhEK#h']r(h_X(New Feature Requests are submitted via: rr}r(h,X(New Feature Requests are submitted via: rh/jubh)r}r(h,X-http://bitbucket.org/prologic/circuits/issuesrh7}r(UrefurirX-http://bitbucket.org/prologic/circuits/issuesrh;]rh=]rh?]rhA]rhC]ruh/jh']rh_X-http://bitbucket.org/prologic/circuits/issuesrr}r(h,Uh/jubah5hubeubaubh)r}r(h,X8Confirmation and Discussion of all New Feature Requests.rh/jmh0h3h5hh7}r(h?]rhA]rh=]rh;]rhC]ruhENhFhh']rhc)r}r(h,jh/jh0h3h5hgh7}r(h?]rhA]rh=]rh;]rhC]ruhEK%h']rh_X8Confirmation and Discussion of all New Feature Requests.rr}r(h,jh/jubaubaubh)r}r(h,XPOnce confirmed, a new Feature is raised in `Pivotal Tracker`_ into the IceBox. rh/jmh0h3h5hh7}r(h?]rhA]rh=]rh;]rhC]ruhENhFhh']rhc)r}r(h,XNOnce confirmed, a new Feature is raised in `Pivotal Tracker`_ into the IceBox.rh/jh0h3h5hgh7}r(h?]rhA]rh=]rh;]rhC]ruhEK&h']r(h_X+Once confirmed, a new Feature is raised in rr}r(h,X+Once confirmed, a new Feature is raised in rh/jubh)r}r(h,X`Pivotal Tracker`_rhKh/jh5hh7}r(UnamerXPivotal Trackerrh9h:h;]rh=]rh?]rhA]rhC]ruh']rh_XPivotal Trackerrr}r(h,Uh/jubaubh_X into the IceBox.rr}r(h,X into the IceBox.rh/jubeubaubeubeubhH)r}r(h,Uh/hIh0h3h5hKh7}r(h?]rhA]rh=]rh;]rh$ahC]rhauhEK*hFhh']r(hS)r}r(h,XWriting new Coderh/jh0h3h5hWh7}r(h?]rhA]rh=]rh;]rhC]ruhEK*hFhh']rh_XWriting new Coderr}r(h,jh/jubaubh)r}r(h,Uh/jh0h3h5hh7}r(hX-h;]rh=]rh?]rhA]rhC]ruhEK-hFhh']r(h)r}r(h,XWrite your code.rh/jh0h3h5hh7}r(h?]rhA]rh=]rh;]rhC]ruhENhFhh']rhc)r}r(h,jh/jh0h3h5hgh7}r (h?]r hA]r h=]r h;]r hC]ruhEK-h']rh_XWrite your code.rr}r(h,jh/jubaubaubh)r}r(h,XJUse `flake8 `_ to ensure code quality.rh/jh0h3h5hh7}r(h?]rhA]rh=]rh;]rhC]ruhENhFhh']rhc)r}r(h,jh/jh0h3h5hgh7}r(h?]r hA]r!h=]r"h;]r#hC]r$uhEK.h']r%(h_XUse r&r'}r((h,XUse r)h/jubh)r*}r+(h,X.`flake8 `_r,h7}r-(Unamer.Xflake8r/h9X"http://pypi.python.org/pypi/flake8r0h;]r1h=]r2h?]r3hA]r4hC]r5uh/jh']r6h_Xflake8r7r8}r9(h,Uh/j*ubah5hubh))r:}r;(h,X% r<h.Kh/jh5h6h7}r=(Urefurir>j0h;]r?h&ah=]r@h?]rAhA]rBhC]rChauh']rDubh_X to ensure code quality.rErF}rG(h,X to ensure code quality.rHh/jubeubaubh)rI}rJ(h,XRun the tests:: $ tox rKh/jh0h3h5hh7}rL(h?]rMhA]rNh=]rOh;]rPhC]rQuhENhFhh']rR(hc)rS}rT(h,XRun the tests::rUh/jIh0h3h5hgh7}rV(h?]rWhA]rXh=]rYh;]rZhC]r[uhEK/h']r\h_XRun the tests:r]r^}r_(h,XRun the tests:r`h/jSubaubcdocutils.nodes literal_block ra)rb}rc(h,X$ toxrdh/jIh0h3h5U literal_blockreh7}rf(U xml:spacergUpreserverhh;]rih=]rjh?]rkhA]rlhC]rmuhEK1h']rnh_X$ toxrorp}rq(h,Uh/jbubaubeubh)rr}rs(h,XCEnsure any new or modified code does not break existing unit tests.rth/jh0h3h5hh7}ru(h?]rvhA]rwh=]rxh;]ryhC]rzuhENhFhh']r{hc)r|}r}(h,jth/jrh0h3h5hgh7}r~(h?]rhA]rh=]rh;]rhC]ruhEK3h']rh_XCEnsure any new or modified code does not break existing unit tests.rr}r(h,jth/j|ubaubaubh)r}r(h,X3Updated any relevant docstrings or documentatino. rh/jh0h3h5hh7}r(h?]rhA]rh=]rh;]rhC]ruhENhFhh']rhc)r}r(h,X1Updated any relevant docstrings or documentatino.rh/jh0h3h5hgh7}r(h?]rhA]rh=]rh;]rhC]ruhEK4h']rh_X1Updated any relevant docstrings or documentatino.rr}r(h,jh/jubaubaubeubeubhH)r}r(h,Uh/hIh0h3h5hKh7}r(h?]rhA]rh=]rh;]rhahC]rh auhEK8hFhh']r(hS)r}r(h,XRunning the Testsrh/jh0h3h5hWh7}r(h?]rhA]rh=]rh;]rhC]ruhEK8hFhh']rh_XRunning the Testsrr}r(h,jh/jubaubhc)r}r(h,X7To run the tests you will need the following installed:rh/jh0h3h5hgh7}r(h?]rhA]rh=]rh;]rhC]ruhEK;hFhh']rh_X7To run the tests you will need the following installed:rr}r(h,jh/jubaubh)r}r(h,Uh/jh0h3h5hh7}r(hX-h;]rh=]rh?]rhA]rhC]ruhEK=hFhh']r(h)r}r(h,X7`tox `_ instaleld as well asrh/jh0h3h5hh7}r(h?]rhA]rh=]rh;]rhC]ruhENhFhh']rhc)r}r(h,jh/jh0h3h5hgh7}r(h?]rhA]rh=]rh;]rhC]ruhEK=h']r(h)r}r(h,X"`tox `_rh7}r(UnamerXtoxrh9Xhttp://codespeak.net/tox/rh;]rh=]rh?]rhA]rhC]ruh/jh']rh_Xtoxrr}r(h,Uh/jubah5hubh))r}r(h,X rh.Kh/jh5h6h7}r(Urefurirjh;]rhah=]rh?]rhA]rhC]rhauh']rubh_X instaleld as well asrr}r(h,X instaleld as well asrh/jubeubaubh)r}r(h,X6`pytest-cov `_rh/jh0h3h5hh7}r(h?]rhA]rh=]rh;]rhC]ruhENhFhh']rhc)r}r(h,jh/jh0h3h5hgh7}r (h?]r hA]r h=]r h;]r hC]ruhEK>h']r(h)r}r(h,jh7}r(UnamerX pytest-covrh9X&http://pypi.python.org/pypi/pytest-covrh;]rh=]rh?]rhA]rhC]ruh/jh']rh_X pytest-covrr}r(h,Uh/jubah5hubh))r}r (h,X) r!h.Kh/jh5h6h7}r"(Urefurir#jh;]r$hah=]r%h?]r&hA]r'hC]r(h auh']r)ubeubaubh)r*}r+(h,X&`pytest `_ r,h/jh0h3h5hh7}r-(h?]r.hA]r/h=]r0h;]r1hC]r2uhENhFhh']r3hc)r4}r5(h,X%`pytest `_r6h/j*h0h3h5hgh7}r7(h?]r8hA]r9h=]r:h;]r;hC]r<uhEK?h']r=(h)r>}r?(h,j6h7}r@(UnamerAXpytestrBh9Xhttp://pytest.org/latest/rCh;]rDh=]rEh?]rFhA]rGhC]rHuh/j4h']rIh_XpytestrJrK}rL(h,Uh/j>ubah5hubh))rM}rN(h,X rOh.Kh/j4h5h6h7}rP(UrefurirQjCh;]rRh"ah=]rSh?]rThA]rUhC]rVh auh']rWubeubaubeubhc)rX}rY(h,X>All of these can be instaleld via ``easy_isntall`` or ``pip``.rZh/jh0h3h5hgh7}r[(h?]r\hA]r]h=]r^h;]r_hC]r`uhEKAhFhh']ra(h_X"All of these can be instaleld via rbrc}rd(h,X"All of these can be instaleld via reh/jXubcdocutils.nodes literal rf)rg}rh(h,X``easy_isntall``rih7}rj(h?]rkhA]rlh=]rmh;]rnhC]rouh/jXh']rph_X easy_isntallrqrr}rs(h,Uh/jgubah5Uliteralrtubh_X or rurv}rw(h,X or rxh/jXubjf)ry}rz(h,X``pip``r{h7}r|(h?]r}hA]r~h=]rh;]rhC]ruh/jXh']rh_Xpiprr}r(h,Uh/jyubah5jtubh_X.r}r(h,X.h/jXubeubhc)r}r(h,XPlease also ensure that you you have all supported versions of Python that circuits supports installed in your local environment.rh/jh0h3h5hgh7}r(h?]rhA]rh=]rh;]rhC]ruhEKChFhh']rh_XPlease also ensure that you you have all supported versions of Python that circuits supports installed in your local environment.rr}r(h,jh/jubaubhc)r}r(h,XTo run the tests::rh/jh0h3h5hgh7}r(h?]rhA]rh=]rh;]rhC]ruhEKFhFhh']rh_XTo run the tests:rr}r(h,XTo run the tests:rh/jubaubja)r}r(h,X$ toxrh/jh0h3h5jeh7}r(jgjhh;]rh=]rh?]rhA]rhC]ruhEKHhFhh']rh_X$ toxrr}r(h,Uh/jubaubeubeubeh,UU transformerrNU footnote_refsr}rUrefnamesr}rXpivotal trackerr]r(hjDjesUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rhFhU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNhWNUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerU:/home/prologic/work/circuits/docs/source/dev/processes.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerr jUauto_id_prefixr Uidr Udoctitle_xformr Ustrip_elements_with_classesr NU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hjh hIh!hh$jhjh#jWh%hrhhhjh"jMh&j:hh*uUsubstitution_namesr}rh5hFh7}r(h?]rh;]rh=]rUsourcerh3hA]rhC]ruU footnotesr]r Urefidsr!}r"ub.circuits-2.1.0/docs/build/doctrees/dev/index.doctree0000644000014400001440000000706512113366670022200 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qXdeveloper docsqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhUdeveloper-docsqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX6/home/prologic/work/circuits/docs/source/dev/index.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q(haUnamesq)]q*hauUlineq+KUdocumentq,hh]q-(cdocutils.nodes title q.)q/}q0(hXDeveloper Docsq1hhhhhUtitleq2h}q3(h!]q4h#]q5h%]q6h']q7h)]q8uh+Kh,hh]q9cdocutils.nodes Text q:XDeveloper Docsq;q<}q=(hh1hh/ubaubcdocutils.nodes paragraph q>)q?}q@(hXSo, you'd like to contribute to circuits in some way? Got a bug report? Having problems running the examples? Having problems getting circuits working in your environment/platform?qAhhhhhU paragraphqBh}qC(h!]qDh#]qEh%]qFh']qGh)]qHuh+Kh,hh]qIh:XSo, you'd like to contribute to circuits in some way? Got a bug report? Having problems running the examples? Having problems getting circuits working in your environment/platform?qJqK}qL(hhAhh?ubaubh>)qM}qN(hX)Excellent. Here's what you need to know.qOhhhhhhBh}qP(h!]qQh#]qRh%]qSh']qTh)]qUuh+Kh,hh]qVh:X)Excellent. Here's what you need to know.qWqX}qY(hhOhhMubaubcdocutils.nodes compound qZ)q[}q\(hUhhhhhUcompoundq]h}q^(h!]q_h#]q`Utoctree-wrapperqaah%]qbh']qch)]qduh+Nh,hh]qecsphinx.addnodes toctree qf)qg}qh(hUhh[hhhUtoctreeqih}qj(UnumberedqkKhU dev/indexqlU titlesonlyqmUglobqnh']qoh%]qph!]qqh#]qrh)]qsUentriesqt]qu(NXdev/introductionqvqwNXdev/contributingqxqyNX dev/processesqzq{eUhiddenq|U includefilesq}]q~(hvhxhzeUmaxdepthqKuh+K h]qubaubeubahUU transformerqNU footnote_refsq}qUrefnamesq}qUsymbol_footnotesq]qUautofootnote_refsq]qUsymbol_footnote_refsq]qU citationsq]qh,hU current_lineqNUtransform_messagesq]qUreporterqNUid_startqKU autofootnotesq]qU citation_refsq}qUindirect_targetsq]qUsettingsq(cdocutils.frontend Values qoq}q(Ufootnote_backlinksqKUrecord_dependenciesqNU rfc_base_urlqUhttp://tools.ietf.org/html/qU tracebackqUpep_referencesqNUstrip_commentsqNU toc_backlinksqUentryqU language_codeqUenqU datestampqNU report_levelqKU _destinationqNU halt_levelqKU strip_classesqNh2NUerror_encoding_error_handlerqUbackslashreplaceqUdebugqNUembed_stylesheetqUoutput_encoding_error_handlerqUstrictqU sectnum_xformqKUdump_transformsqNU docinfo_xformqKUwarning_streamqNUpep_file_url_templateqUpep-%04dqUexit_status_levelqKUconfigqNUstrict_visitorqNUcloak_email_addressesqUtrim_footnote_reference_spaceqUenvqNUdump_pseudo_xmlqNUexpose_internalsqNUsectsubtitle_xformqU source_linkqNUrfc_referencesqNUoutput_encodingqUutf-8qU source_urlqNUinput_encodingqU utf-8-sigqU_disable_configqNU id_prefixqUU tab_widthqKUerror_encodingqU ISO-8859-1qU_sourceqU6/home/prologic/work/circuits/docs/source/dev/index.rstqUgettext_compactqЈU generatorqNUdump_internalsqNU smart_quotesqӉU pep_base_urlqUhttp://www.python.org/dev/peps/qUsyntax_highlightqUlongqUinput_encoding_error_handlerqhUauto_id_prefixqUidqUdoctitle_xformqۉUstrip_elements_with_classesqNU _config_filesq]qUfile_insertion_enabledqKU raw_enabledqKU dump_settingsqNubUsymbol_footnote_startqKUidsq}qhhsUsubstitution_namesq}qhh,h}q(h!]qh']qh%]qUsourceqhh#]qh)]quU footnotesq]qUrefidsq}qub.circuits-2.1.0/docs/build/doctrees/man/0000755000014400001440000000000012113366740017505 5ustar prologicuserscircuits-2.1.0/docs/build/doctrees/man/events.doctree0000644000014400001440000005366112113366671022376 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(Xevents as result collectorsqNX basic usageqNXeventsqNXadvanced usageq NuUsubstitution_defsq }q Uparse_messagesq ]q Ucurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hUevents-as-result-collectorsqhU basic-usageqhUeventsqh Uadvanced-usagequUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX7/home/prologic/work/circuits/docs/source/man/events.rstq q!}q"bUtagnameq#Usectionq$U attributesq%}q&(Udupnamesq']q(Uclassesq)]q*Ubackrefsq+]q,Uidsq-]q.haUnamesq/]q0hauUlineq1KUdocumentq2hh]q3(cdocutils.nodes title q4)q5}q6(hXEventsq7hhhh!h#Utitleq8h%}q9(h']q:h)]q;h+]quh1Kh2hh]q?cdocutils.nodes Text q@XEventsqAqB}qC(hh7hh5ubaubh)qD}qE(hUhhhh!h#h$h%}qF(h']qGh)]qHh+]qIh-]qJhah/]qKhauh1Kh2hh]qL(h4)qM}qN(hX Basic usageqOhhDhh!h#h8h%}qP(h']qQh)]qRh+]qSh-]qTh/]qUuh1Kh2hh]qVh@X Basic usageqWqX}qY(hhOhhMubaubcdocutils.nodes paragraph qZ)q[}q\(hXlEvents are objects that are fired by the circuits framework implicitly (like the :class:`~circuits.core.events.Started` event used in the tutorial) or explicitly by components while handling some other event. Once fired, events are dispatched to the components that are interested in these events, i.e. that have registered themselves as handlers for these events.q]hhDhh!h#U paragraphq^h%}q_(h']q`h)]qah+]qbh-]qch/]qduh1Kh2hh]qe(h@XQEvents are objects that are fired by the circuits framework implicitly (like the qfqg}qh(hXQEvents are objects that are fired by the circuits framework implicitly (like the qihh[ubcsphinx.addnodes pending_xref qj)qk}ql(hX&:class:`~circuits.core.events.Started`qmhh[hh!h#U pending_xrefqnh%}qo(UreftypeqpXclassqqUrefwarnqrU reftargetqsXcircuits.core.events.StartedqtU refdomainquXpyqvh-]qwh+]qxU refexplicitqyh']qzh)]q{h/]q|Urefdocq}U man/eventsq~Upy:classqNU py:moduleqNuh1Kh]qcdocutils.nodes literal q)q}q(hhmh%}q(h']qh)]q(UxrefqhvXpy-classqeh+]qh-]qh/]quhhkh]qh@XStartedqq}q(hUhhubah#Uliteralqubaubh@X event used in the tutorial) or explicitly by components while handling some other event. Once fired, events are dispatched to the components that are interested in these events, i.e. that have registered themselves as handlers for these events.qq}q(hX event used in the tutorial) or explicitly by components while handling some other event. Once fired, events are dispatched to the components that are interested in these events, i.e. that have registered themselves as handlers for these events.qhh[ubeubhZ)q}q(hXEvents are usually fired on one or more channels, allowing components to gather in "interest groups". This is especially useful if you want to reuse basic components such as a TCP server. A TCP server component fires a ``Read`` event for every package of data that it receives. If we hadn't the channels, it would be very difficult to separate the data from two different TCP connections. But using the channels, we can put one TCP server and all components interested in its events on one channel, and another TCP server and the components interested in this other TCP server's events on another channel. Components are associated with a channel by setting their ``channel`` attribute (see API description for :class:`~.components.Component`).qhhDhh!h#h^h%}q(h']qh)]qh+]qh-]qh/]quh1K h2hh]q(h@XEvents are usually fired on one or more channels, allowing components to gather in "interest groups". This is especially useful if you want to reuse basic components such as a TCP server. A TCP server component fires a qq}q(hXEvents are usually fired on one or more channels, allowing components to gather in "interest groups". This is especially useful if you want to reuse basic components such as a TCP server. A TCP server component fires a qhhubh)q}q(hX``Read``qh%}q(h']qh)]qh+]qh-]qh/]quhhh]qh@XReadqq}q(hUhhubah#hubh@X event for every package of data that it receives. If we hadn't the channels, it would be very difficult to separate the data from two different TCP connections. But using the channels, we can put one TCP server and all components interested in its events on one channel, and another TCP server and the components interested in this other TCP server's events on another channel. Components are associated with a channel by setting their qq}q(hX event for every package of data that it receives. If we hadn't the channels, it would be very difficult to separate the data from two different TCP connections. But using the channels, we can put one TCP server and all components interested in its events on one channel, and another TCP server and the components interested in this other TCP server's events on another channel. Components are associated with a channel by setting their qhhubh)q}q(hX ``channel``qh%}q(h']qh)]qh+]qh-]qh/]quhhh]qh@Xchannelqq}q(hUhhubah#hubh@X$ attribute (see API description for q…q}q(hX$ attribute (see API description for qhhubhj)q}q(hX:class:`~.components.Component`qhhhh!h#hnh%}q(UreftypeqXclassqU refspecificq̈hrhsXcomponents.ComponentqU refdomainqXpyqh-]qh+]qU refexplicitq҉h']qh)]qh/]qh}h~hNhNuh1K h]qh)q}q(hhh%}q(h']qh)]q(hhXpy-classqeh+]qh-]qh/]quhhh]qh@X Componentqᅁq}q(hUhhubah#hubaubh@X).q䅁q}q(hX).qhhubeubhZ)q}q(hXBesides having a name, events carry additional arbitrary information. This information is passed as arguments or keyword arguments to the constructor. It is then delivered to the handler function that must have exactly the same number of arguments and keyword arguments. Of course, as is usual in Python, you can also pass additional information by setting attributes of the event object, though this usage pattern is discouraged for events.qhhDhh!h#h^h%}q(h']qh)]qh+]qh-]qh/]quh1Kh2hh]qh@XBesides having a name, events carry additional arbitrary information. This information is passed as arguments or keyword arguments to the constructor. It is then delivered to the handler function that must have exactly the same number of arguments and keyword arguments. Of course, as is usual in Python, you can also pass additional information by setting attributes of the event object, though this usage pattern is discouraged for events.qq}q(hhhhubaubeubh)q}q(hUhhhh!h#h$h%}q(h']qh)]qh+]qh-]qhah/]qhauh1K"h2hh]q(h4)q}q(hXEvents as result collectorsrhhhh!h#h8h%}r(h']rh)]rh+]rh-]rh/]ruh1K"h2hh]rh@XEvents as result collectorsrr }r (hjhhubaubhZ)r }r (hXApart from delivering information to handlers, event objects may also collect information. If a handler returns something that is not ``None``, it is stored in the event's ``value`` attribute. If a second (or any subsequent) handler invocation also returns a value, the values are stored as a list. Note that the value attribute is of type :class:`~.values.Value` and you must access its property ``value`` to access the data stored (``collected_information = event.value.value``).r hhhh!h#h^h%}r(h']rh)]rh+]rh-]rh/]ruh1K$h2hh]r(h@XApart from delivering information to handlers, event objects may also collect information. If a handler returns something that is not rr}r(hXApart from delivering information to handlers, event objects may also collect information. If a handler returns something that is not rhj ubh)r}r(hX``None``rh%}r(h']rh)]rh+]rh-]r h/]r!uhj h]r"h@XNoner#r$}r%(hUhjubah#hubh@X, it is stored in the event's r&r'}r((hX, it is stored in the event's r)hj ubh)r*}r+(hX ``value``r,h%}r-(h']r.h)]r/h+]r0h-]r1h/]r2uhj h]r3h@Xvaluer4r5}r6(hUhj*ubah#hubh@X attribute. If a second (or any subsequent) handler invocation also returns a value, the values are stored as a list. Note that the value attribute is of type r7r8}r9(hX attribute. If a second (or any subsequent) handler invocation also returns a value, the values are stored as a list. Note that the value attribute is of type r:hj ubhj)r;}r<(hX:class:`~.values.Value`r=hj hh!h#hnh%}r>(Ureftyper?Xclassr@ḧhrhsX values.ValuerAU refdomainrBXpyrCh-]rDh+]rEU refexplicitrFh']rGh)]rHh/]rIh}h~hNhNuh1K$h]rJh)rK}rL(hj=h%}rM(h']rNh)]rO(hjCXpy-classrPeh+]rQh-]rRh/]rSuhj;h]rTh@XValuerUrV}rW(hUhjKubah#hubaubh@X" and you must access its property rXrY}rZ(hX" and you must access its property r[hj ubh)r\}r](hX ``value``r^h%}r_(h']r`h)]rah+]rbh-]rch/]rduhj h]reh@Xvaluerfrg}rh(hUhj\ubah#hubh@X to access the data stored (rirj}rk(hX to access the data stored (rlhj ubh)rm}rn(hX-``collected_information = event.value.value``roh%}rp(h']rqh)]rrh+]rsh-]rth/]ruuhj h]rvh@X)collected_information = event.value.valuerwrx}ry(hUhjmubah#hubh@X).rzr{}r|(hX).r}hj ubeubhZ)r~}r(hXThe collected information can be accessed by handlers in order to find out about any return values from the previously invoked handlers. More useful though, is the possibility to access the information after all handlers have been invoked. After all handlers have run successfully (i.e. no handler has thrown an error) circuits may generate an event that indicates the successful handling. This event has the name of the event just handled with "Success" appended. So if the event is called ``Identify`` then the success event is called ``IdentifySuccess``. Success events aren't delivered by default. If you want successful handling to be indicated for an event, you have to set the optional attribute ``success`` of this event to ``True``.rhhhh!h#h^h%}r(h']rh)]rh+]rh-]rh/]ruh1K,h2hh]r(h@XThe collected information can be accessed by handlers in order to find out about any return values from the previously invoked handlers. More useful though, is the possibility to access the information after all handlers have been invoked. After all handlers have run successfully (i.e. no handler has thrown an error) circuits may generate an event that indicates the successful handling. This event has the name of the event just handled with "Success" appended. So if the event is called rr}r(hXThe collected information can be accessed by handlers in order to find out about any return values from the previously invoked handlers. More useful though, is the possibility to access the information after all handlers have been invoked. After all handlers have run successfully (i.e. no handler has thrown an error) circuits may generate an event that indicates the successful handling. This event has the name of the event just handled with "Success" appended. So if the event is called rhj~ubh)r}r(hX ``Identify``rh%}r(h']rh)]rh+]rh-]rh/]ruhj~h]rh@XIdentifyrr}r(hUhjubah#hubh@X" then the success event is called rr}r(hX" then the success event is called rhj~ubh)r}r(hX``IdentifySuccess``rh%}r(h']rh)]rh+]rh-]rh/]ruhj~h]rh@XIdentifySuccessrr}r(hUhjubah#hubh@X. Success events aren't delivered by default. If you want successful handling to be indicated for an event, you have to set the optional attribute rr}r(hX. Success events aren't delivered by default. If you want successful handling to be indicated for an event, you have to set the optional attribute rhj~ubh)r}r(hX ``success``rh%}r(h']rh)]rh+]rh-]rh/]ruhj~h]rh@Xsuccessrr}r(hUhjubah#hubh@X of this event to rr}r(hX of this event to rhj~ubh)r}r(hX``True``rh%}r(h']rh)]rh+]rh-]rh/]ruhj~h]rh@XTruerr}r(hUhjubah#hubh@X.r}r(hX.hj~ubeubhZ)r}r(hXThe handler for a success event must be defined with two arguments. When invoked, the first argument is the event just having been handled successfully and the second argument is (as a convenience) what has been collected in ``event.value.value`` (note that the first argument may not be called ``event``, for an explanation of this restriction as well as for an explanation why the method is called ``identify_success`` see the section on handlers).rhhhh!h#h^h%}r(h']rh)]rh+]rh-]rh/]ruh1K8h2hh]r(h@XThe handler for a success event must be defined with two arguments. When invoked, the first argument is the event just having been handled successfully and the second argument is (as a convenience) what has been collected in rr}r(hXThe handler for a success event must be defined with two arguments. When invoked, the first argument is the event just having been handled successfully and the second argument is (as a convenience) what has been collected in rhjubh)r}r(hX``event.value.value``rh%}r(h']rh)]rh+]rh-]rh/]ruhjh]rh@Xevent.value.valuerr}r(hUhjubah#hubh@X1 (note that the first argument may not be called rr}r(hX1 (note that the first argument may not be called rhjubh)r}r(hX ``event``rh%}r(h']rh)]rh+]rh-]rh/]ruhjh]rh@Xeventrr}r(hUhjubah#hubh@X`, for an explanation of this restriction as well as for an explanation why the method is called rr}r(hX`, for an explanation of this restriction as well as for an explanation why the method is called rhjubh)r}r(hX``identify_success``rh%}r(h']rh)]rh+]rh-]rh/]ruhjh]rh@Xidentify_successrr }r (hUhjubah#hubh@X see the section on handlers).r r }r (hX see the section on handlers).rhjubeubcdocutils.nodes literal_block r)r}r(hX#!/usr/bin/env python from circuits import Component, Event from circuits.core.debugger import Debugger class Identify(Event): """Identify Event""" success = True class Pound(Component): def __init__(self): super(Pound, self).__init__() Debugger().register(self) Bob().register(self) Fred().register(self) def started(self, *args): self.fire(Identify()) def identify_success(self, evt, result): if not isinstance(result, list): result = [result] print "In pound:" for name in result: print name class Dog(Component): def identify(self): return self.__class__.__name__ class Bob(Dog): """Bob""" class Fred(Dog): """Fred""" Pound().run() rhhhh!h#U literal_blockrh%}r(UlinenosrUlanguagerhXpythonrr}rbh']rU xml:spacerUpreserverh-]rh+]rUsourcerXH/home/prologic/work/circuits/docs/source/man/examples/handler_returns.pyr h)]r!h/]r"uh1K@h2hh]r#h@X#!/usr/bin/env python from circuits import Component, Event from circuits.core.debugger import Debugger class Identify(Event): """Identify Event""" success = True class Pound(Component): def __init__(self): super(Pound, self).__init__() Debugger().register(self) Bob().register(self) Fred().register(self) def started(self, *args): self.fire(Identify()) def identify_success(self, evt, result): if not isinstance(result, list): result = [result] print "In pound:" for name in result: print name class Dog(Component): def identify(self): return self.__class__.__name__ class Bob(Dog): """Bob""" class Fred(Dog): """Fred""" Pound().run() r$r%}r&(hUhjubaubhZ)r'}r((hXE:download:`Download handler_returns.py `r)hhhh!h#h^h%}r*(h']r+h)]r,h+]r-h-]r.h/]r/uh1KDh2hh]r0csphinx.addnodes download_reference r1)r2}r3(hj)hj'hh!h#Udownload_referencer4h%}r5(Ureftyper6Xdownloadr7hrhsXexamples/handler_returns.pyr8U refdomainr9Uh-]r:h+]r;U refexplicitr<h']r=h)]r>h/]r?h}h~Ufilenamer@Xhandler_returns.pyrAuh1KDh]rBh)rC}rD(hj)h%}rE(h']rFh)]rG(hj7eh+]rHh-]rIh/]rJuhj2h]rKh@XDownload handler_returns.pyrLrM}rN(hUhjCubah#hubaubaubeubh)rO}rP(hUhhhh!h#h$h%}rQ(h']rRh)]rSh+]rTh-]rUhah/]rVh auh1KHh2hh]rW(h4)rX}rY(hXAdvanced usagerZhjOhh!h#h8h%}r[(h']r\h)]r]h+]r^h-]r_h/]r`uh1KHh2hh]rah@XAdvanced usagerbrc}rd(hjZhjXubaubhZ)re}rf(hX`Sometimes it may be necessary to take some action when all state changes triggered by an event are in effect. In this case it is not sufficient to wait for the completion of all handlers for this particular event. Rather, we also have to wait until all events that have been fired by those handlers have been processed (and again wait for the events fired by those events' handlers, and so on). To support this scenario, circuits can fire a ``Complete`` event. The usage is similar to the previously described success event. Details can be found in the API description of :class:`circuits.core.events.Event`.rghjOhh!h#h^h%}rh(h']rih)]rjh+]rkh-]rlh/]rmuh1KJh2hh]rn(h@XSometimes it may be necessary to take some action when all state changes triggered by an event are in effect. In this case it is not sufficient to wait for the completion of all handlers for this particular event. Rather, we also have to wait until all events that have been fired by those handlers have been processed (and again wait for the events fired by those events' handlers, and so on). To support this scenario, circuits can fire a rorp}rq(hXSometimes it may be necessary to take some action when all state changes triggered by an event are in effect. In this case it is not sufficient to wait for the completion of all handlers for this particular event. Rather, we also have to wait until all events that have been fired by those handlers have been processed (and again wait for the events fired by those events' handlers, and so on). To support this scenario, circuits can fire a rrhjeubh)rs}rt(hX ``Complete``ruh%}rv(h']rwh)]rxh+]ryh-]rzh/]r{uhjeh]r|h@XCompleter}r~}r(hUhjsubah#hubh@Xw event. The usage is similar to the previously described success event. Details can be found in the API description of rr}r(hXw event. The usage is similar to the previously described success event. Details can be found in the API description of rhjeubhj)r}r(hX#:class:`circuits.core.events.Event`rhjehh!h#hnh%}r(UreftyperXclassrhrhsXcircuits.core.events.EventrU refdomainrXpyrh-]rh+]rU refexplicitrh']rh)]rh/]rh}h~hNhNuh1KJh]rh)r}r(hjh%}r(h']rh)]r(hjXpy-classreh+]rh-]rh/]ruhjh]rh@Xcircuits.core.events.Eventrr}r(hUhjubah#hubaubh@X.r}r(hX.hjeubeubeubeubahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh2hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh8NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerU7/home/prologic/work/circuits/docs/source/man/events.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hhhhhjOhhDuUsubstitution_namesr}rh#h2h%}r (h']r h-]r h+]r Usourcer h!h)]rh/]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/man/manager.doctree0000644000014400001440000000651212113366671022475 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qXmanagerqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhUmanagerqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX8/home/prologic/work/circuits/docs/source/man/manager.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q(haUnamesq)]q*hauUlineq+KUdocumentq,hh]q-(cdocutils.nodes title q.)q/}q0(hXManagerq1hhhhhUtitleq2h}q3(h!]q4h#]q5h%]q6h']q7h)]q8uh+Kh,hh]q9cdocutils.nodes Text q:XManagerq;q<}q=(hh1hh/ubaubcdocutils.nodes target q>)q?}q@(hUhhhhhUtargetqAh}qB(h']qCh%]qDh!]qEh#]qFh)]qGUrefidqHUindex-0qIuh+Nh,hh]qJubcsphinx.ext.todo todo_node qK)qL}qM(hXWrite about this...qNhhhhUexpect_referenced_by_nameqO}qPhU todo_nodeqQh}qR(h!]qSh#]qTUadmonition-todoqUah%]qVh']qWhIah)]qXuh+Kh,hUexpect_referenced_by_idqY}qZhIh?sh]q[(h.)q\}q](hXTodoq^h}q_(h!]q`h#]qah%]qbh']qch)]qduhhLh]qeh:XTodoqfqg}qh(hh^hh\ubahh2ubcdocutils.nodes paragraph qi)qj}qk(hhNhhLhhhU paragraphqlh}qm(h!]qnh#]qoh%]qph']qqh)]qruh+Kh]qsh:XWrite about this...qtqu}qv(hhNhhjubaubeubeubahUU transformerqwNU footnote_refsqx}qyUrefnamesqz}q{Usymbol_footnotesq|]q}Uautofootnote_refsq~]qUsymbol_footnote_refsq]qU citationsq]qh,hU current_lineqNUtransform_messagesq]qcdocutils.nodes system_message q)q}q(hUh}q(h!]qUlevelqKh']qh%]qUsourceqhh#]qh)]qUtypeqUINFOquh]qhi)q}q(hUh}q(h!]qh#]qh%]qh']qh)]quhhh]qh:X-Hyperlink target "index-0" is not referenced.qq}q(hUhhubahhlubahUsystem_messagequbaUreporterqNUid_startqKU autofootnotesq]qU citation_refsq}qUindirect_targetsq]qUsettingsq(cdocutils.frontend Values qoq}q(Ufootnote_backlinksqKUrecord_dependenciesqNU rfc_base_urlqUhttp://tools.ietf.org/html/qU tracebackqUpep_referencesqNUstrip_commentsqNU toc_backlinksqUentryqU language_codeqUenqU datestampqNU report_levelqKU _destinationqNU halt_levelqKU strip_classesqNh2NUerror_encoding_error_handlerqUbackslashreplaceqUdebugqNUembed_stylesheetqUoutput_encoding_error_handlerqUstrictqU sectnum_xformqKUdump_transformsqNU docinfo_xformqKUwarning_streamqNUpep_file_url_templateqUpep-%04dqUexit_status_levelqKUconfigqNUstrict_visitorqNUcloak_email_addressesq͈Utrim_footnote_reference_spaceqΉUenvqNUdump_pseudo_xmlqNUexpose_internalsqNUsectsubtitle_xformq҉U source_linkqNUrfc_referencesqNUoutput_encodingqUutf-8qU source_urlqNUinput_encodingqU utf-8-sigqU_disable_configqNU id_prefixqUU tab_widthqKUerror_encodingqU ISO-8859-1qU_sourceqU8/home/prologic/work/circuits/docs/source/man/manager.rstqUgettext_compactqU generatorqNUdump_internalsqNU smart_quotesqU pep_base_urlqUhttp://www.python.org/dev/peps/qUsyntax_highlightqUlongqUinput_encoding_error_handlerqhUauto_id_prefixqUidqUdoctitle_xformqUstrip_elements_with_classesqNU _config_filesq]qUfile_insertion_enabledqKU raw_enabledqKU dump_settingsqNubUsymbol_footnote_startqKUidsq}q(hhhIhLuUsubstitution_namesq}qhh,h}q(h!]qh']qh%]qUsourceqhh#]qh)]quU footnotesq]rUrefidsr}rhI]rh?asub.circuits-2.1.0/docs/build/doctrees/man/values.doctree0000644000014400001440000000650412113366671022363 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qXvaluesqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhUvaluesqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX7/home/prologic/work/circuits/docs/source/man/values.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q(haUnamesq)]q*hauUlineq+KUdocumentq,hh]q-(cdocutils.nodes title q.)q/}q0(hXValuesq1hhhhhUtitleq2h}q3(h!]q4h#]q5h%]q6h']q7h)]q8uh+Kh,hh]q9cdocutils.nodes Text q:XValuesq;q<}q=(hh1hh/ubaubcdocutils.nodes target q>)q?}q@(hUhhhhhUtargetqAh}qB(h']qCh%]qDh!]qEh#]qFh)]qGUrefidqHUindex-0qIuh+Nh,hh]qJubcsphinx.ext.todo todo_node qK)qL}qM(hXWrite about this...qNhhhhUexpect_referenced_by_nameqO}qPhU todo_nodeqQh}qR(h!]qSh#]qTUadmonition-todoqUah%]qVh']qWhIah)]qXuh+Kh,hUexpect_referenced_by_idqY}qZhIh?sh]q[(h.)q\}q](hXTodoq^h}q_(h!]q`h#]qah%]qbh']qch)]qduhhLh]qeh:XTodoqfqg}qh(hh^hh\ubahh2ubcdocutils.nodes paragraph qi)qj}qk(hhNhhLhhhU paragraphqlh}qm(h!]qnh#]qoh%]qph']qqh)]qruh+Kh]qsh:XWrite about this...qtqu}qv(hhNhhjubaubeubeubahUU transformerqwNU footnote_refsqx}qyUrefnamesqz}q{Usymbol_footnotesq|]q}Uautofootnote_refsq~]qUsymbol_footnote_refsq]qU citationsq]qh,hU current_lineqNUtransform_messagesq]qcdocutils.nodes system_message q)q}q(hUh}q(h!]qUlevelqKh']qh%]qUsourceqhh#]qh)]qUtypeqUINFOquh]qhi)q}q(hUh}q(h!]qh#]qh%]qh']qh)]quhhh]qh:X-Hyperlink target "index-0" is not referenced.qq}q(hUhhubahhlubahUsystem_messagequbaUreporterqNUid_startqKU autofootnotesq]qU citation_refsq}qUindirect_targetsq]qUsettingsq(cdocutils.frontend Values qoq}q(Ufootnote_backlinksqKUrecord_dependenciesqNU rfc_base_urlqUhttp://tools.ietf.org/html/qU tracebackqUpep_referencesqNUstrip_commentsqNU toc_backlinksqUentryqU language_codeqUenqU datestampqNU report_levelqKU _destinationqNU halt_levelqKU strip_classesqNh2NUerror_encoding_error_handlerqUbackslashreplaceqUdebugqNUembed_stylesheetqUoutput_encoding_error_handlerqUstrictqU sectnum_xformqKUdump_transformsqNU docinfo_xformqKUwarning_streamqNUpep_file_url_templateqUpep-%04dqUexit_status_levelqKUconfigqNUstrict_visitorqNUcloak_email_addressesq͈Utrim_footnote_reference_spaceqΉUenvqNUdump_pseudo_xmlqNUexpose_internalsqNUsectsubtitle_xformq҉U source_linkqNUrfc_referencesqNUoutput_encodingqUutf-8qU source_urlqNUinput_encodingqU utf-8-sigqU_disable_configqNU id_prefixqUU tab_widthqKUerror_encodingqU ISO-8859-1qU_sourceqU7/home/prologic/work/circuits/docs/source/man/values.rstqUgettext_compactqU generatorqNUdump_internalsqNU smart_quotesqU pep_base_urlqUhttp://www.python.org/dev/peps/qUsyntax_highlightqUlongqUinput_encoding_error_handlerqhUauto_id_prefixqUidqUdoctitle_xformqUstrip_elements_with_classesqNU _config_filesq]qUfile_insertion_enabledqKU raw_enabledqKU dump_settingsqNubUsymbol_footnote_startqKUidsq}q(hIhLhhuUsubstitution_namesq}qhh,h}q(h!]qh']qh%]qUsourceqhh#]qh)]quU footnotesq]rUrefidsr}rhI]rh?asub.circuits-2.1.0/docs/build/doctrees/man/debugging.doctree0000644000014400001440000000653012113366671023016 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qX debuggingqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhU debuggingqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX:/home/prologic/work/circuits/docs/source/man/debugging.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q(haUnamesq)]q*hauUlineq+KUdocumentq,hh]q-(cdocutils.nodes title q.)q/}q0(hX Debuggingq1hhhhhUtitleq2h}q3(h!]q4h#]q5h%]q6h']q7h)]q8uh+Kh,hh]q9cdocutils.nodes Text q:X Debuggingq;q<}q=(hh1hh/ubaubcdocutils.nodes target q>)q?}q@(hUhhhhhUtargetqAh}qB(h']qCh%]qDh!]qEh#]qFh)]qGUrefidqHUindex-0qIuh+Nh,hh]qJubcsphinx.ext.todo todo_node qK)qL}qM(hXWrite about this ...qNhhhhUexpect_referenced_by_nameqO}qPhU todo_nodeqQh}qR(h!]qSh#]qTUadmonition-todoqUah%]qVh']qWhIah)]qXuh+Kh,hUexpect_referenced_by_idqY}qZhIh?sh]q[(h.)q\}q](hXTodoq^h}q_(h!]q`h#]qah%]qbh']qch)]qduhhLh]qeh:XTodoqfqg}qh(hh^hh\ubahh2ubcdocutils.nodes paragraph qi)qj}qk(hhNhhLhhhU paragraphqlh}qm(h!]qnh#]qoh%]qph']qqh)]qruh+Kh]qsh:XWrite about this ...qtqu}qv(hhNhhjubaubeubeubahUU transformerqwNU footnote_refsqx}qyUrefnamesqz}q{Usymbol_footnotesq|]q}Uautofootnote_refsq~]qUsymbol_footnote_refsq]qU citationsq]qh,hU current_lineqNUtransform_messagesq]qcdocutils.nodes system_message q)q}q(hUh}q(h!]qUlevelqKh']qh%]qUsourceqhh#]qh)]qUtypeqUINFOquh]qhi)q}q(hUh}q(h!]qh#]qh%]qh']qh)]quhhh]qh:X-Hyperlink target "index-0" is not referenced.qq}q(hUhhubahhlubahUsystem_messagequbaUreporterqNUid_startqKU autofootnotesq]qU citation_refsq}qUindirect_targetsq]qUsettingsq(cdocutils.frontend Values qoq}q(Ufootnote_backlinksqKUrecord_dependenciesqNU rfc_base_urlqUhttp://tools.ietf.org/html/qU tracebackqUpep_referencesqNUstrip_commentsqNU toc_backlinksqUentryqU language_codeqUenqU datestampqNU report_levelqKU _destinationqNU halt_levelqKU strip_classesqNh2NUerror_encoding_error_handlerqUbackslashreplaceqUdebugqNUembed_stylesheetqUoutput_encoding_error_handlerqUstrictqU sectnum_xformqKUdump_transformsqNU docinfo_xformqKUwarning_streamqNUpep_file_url_templateqUpep-%04dqUexit_status_levelqKUconfigqNUstrict_visitorqNUcloak_email_addressesq͈Utrim_footnote_reference_spaceqΉUenvqNUdump_pseudo_xmlqNUexpose_internalsqNUsectsubtitle_xformq҉U source_linkqNUrfc_referencesqNUoutput_encodingqUutf-8qU source_urlqNUinput_encodingqU utf-8-sigqU_disable_configqNU id_prefixqUU tab_widthqKUerror_encodingqU ISO-8859-1qU_sourceqU:/home/prologic/work/circuits/docs/source/man/debugging.rstqUgettext_compactqU generatorqNUdump_internalsqNU smart_quotesqU pep_base_urlqUhttp://www.python.org/dev/peps/qUsyntax_highlightqUlongqUinput_encoding_error_handlerqhUauto_id_prefixqUidqUdoctitle_xformqUstrip_elements_with_classesqNU _config_filesq]qUfile_insertion_enabledqKU raw_enabledqKU dump_settingsqNubUsymbol_footnote_startqKUidsq}q(hhhIhLuUsubstitution_namesq}qhh,h}q(h!]qh']qh%]qUsourceqhh#]qh)]quU footnotesq]rUrefidsr}rhI]rh?asub.circuits-2.1.0/docs/build/doctrees/man/tools.doctree0000644000014400001440000000650012113366671022220 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qXtoolsqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhUtoolsqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX6/home/prologic/work/circuits/docs/source/man/tools.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q(haUnamesq)]q*hauUlineq+KUdocumentq,hh]q-(cdocutils.nodes title q.)q/}q0(hXToolsq1hhhhhUtitleq2h}q3(h!]q4h#]q5h%]q6h']q7h)]q8uh+Kh,hh]q9cdocutils.nodes Text q:XToolsq;q<}q=(hh1hh/ubaubcdocutils.nodes target q>)q?}q@(hUhhhhhUtargetqAh}qB(h']qCh%]qDh!]qEh#]qFh)]qGUrefidqHUindex-0qIuh+Nh,hh]qJubcsphinx.ext.todo todo_node qK)qL}qM(hXWrite about this ...qNhhhhUexpect_referenced_by_nameqO}qPhU todo_nodeqQh}qR(h!]qSh#]qTUadmonition-todoqUah%]qVh']qWhIah)]qXuh+Kh,hUexpect_referenced_by_idqY}qZhIh?sh]q[(h.)q\}q](hXTodoq^h}q_(h!]q`h#]qah%]qbh']qch)]qduhhLh]qeh:XTodoqfqg}qh(hh^hh\ubahh2ubcdocutils.nodes paragraph qi)qj}qk(hhNhhLhhhU paragraphqlh}qm(h!]qnh#]qoh%]qph']qqh)]qruh+Kh]qsh:XWrite about this ...qtqu}qv(hhNhhjubaubeubeubahUU transformerqwNU footnote_refsqx}qyUrefnamesqz}q{Usymbol_footnotesq|]q}Uautofootnote_refsq~]qUsymbol_footnote_refsq]qU citationsq]qh,hU current_lineqNUtransform_messagesq]qcdocutils.nodes system_message q)q}q(hUh}q(h!]qUlevelqKh']qh%]qUsourceqhh#]qh)]qUtypeqUINFOquh]qhi)q}q(hUh}q(h!]qh#]qh%]qh']qh)]quhhh]qh:X-Hyperlink target "index-0" is not referenced.qq}q(hUhhubahhlubahUsystem_messagequbaUreporterqNUid_startqKU autofootnotesq]qU citation_refsq}qUindirect_targetsq]qUsettingsq(cdocutils.frontend Values qoq}q(Ufootnote_backlinksqKUrecord_dependenciesqNU rfc_base_urlqUhttp://tools.ietf.org/html/qU tracebackqUpep_referencesqNUstrip_commentsqNU toc_backlinksqUentryqU language_codeqUenqU datestampqNU report_levelqKU _destinationqNU halt_levelqKU strip_classesqNh2NUerror_encoding_error_handlerqUbackslashreplaceqUdebugqNUembed_stylesheetqUoutput_encoding_error_handlerqUstrictqU sectnum_xformqKUdump_transformsqNU docinfo_xformqKUwarning_streamqNUpep_file_url_templateqUpep-%04dqUexit_status_levelqKUconfigqNUstrict_visitorqNUcloak_email_addressesq͈Utrim_footnote_reference_spaceqΉUenvqNUdump_pseudo_xmlqNUexpose_internalsqNUsectsubtitle_xformq҉U source_linkqNUrfc_referencesqNUoutput_encodingqUutf-8qU source_urlqNUinput_encodingqU utf-8-sigqU_disable_configqNU id_prefixqUU tab_widthqKUerror_encodingqU ISO-8859-1qU_sourceqU6/home/prologic/work/circuits/docs/source/man/tools.rstqUgettext_compactqU generatorqNUdump_internalsqNU smart_quotesqU pep_base_urlqUhttp://www.python.org/dev/peps/qUsyntax_highlightqUlongqUinput_encoding_error_handlerqhUauto_id_prefixqUidqUdoctitle_xformqUstrip_elements_with_classesqNU _config_filesq]qUfile_insertion_enabledqKU raw_enabledqKU dump_settingsqNubUsymbol_footnote_startqKUidsq}q(hIhLhhuUsubstitution_namesq}qhh,h}q(h!]qh']qh%]qUsourceqhh#]qh)]quU footnotesq]rUrefidsr}rhI]rh?asub.circuits-2.1.0/docs/build/doctrees/man/components.doctree0000644000014400001440000002743212113366671023254 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qX componentsqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhU componentsqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX;/home/prologic/work/circuits/docs/source/man/components.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q(haUnamesq)]q*hauUlineq+KUdocumentq,hh]q-(cdocutils.nodes title q.)q/}q0(hX Componentsq1hhhhhUtitleq2h}q3(h!]q4h#]q5h%]q6h']q7h)]q8uh+Kh,hh]q9cdocutils.nodes Text q:X Componentsq;q<}q=(hh1hh/ubaubcdocutils.nodes paragraph q>)q?}q@(hXThe architectural concept of circuits is to encapsulate system functionality into discrete manageable and reusable units, called *Components*, that interact by sending and handling events that flow throughout the system.qAhhhhhU paragraphqBh}qC(h!]qDh#]qEh%]qFh']qGh)]qHuh+Kh,hh]qI(h:XThe architectural concept of circuits is to encapsulate system functionality into discrete manageable and reusable units, called qJqK}qL(hXThe architectural concept of circuits is to encapsulate system functionality into discrete manageable and reusable units, called qMhh?ubcdocutils.nodes emphasis qN)qO}qP(hX *Components*qQh}qR(h!]qSh#]qTh%]qUh']qVh)]qWuhh?h]qXh:X ComponentsqYqZ}q[(hUhhOubahUemphasisq\ubh:XO, that interact by sending and handling events that flow throughout the system.q]q^}q_(hXO, that interact by sending and handling events that flow throughout the system.q`hh?ubeubh>)qa}qb(hXTechnically, a circuits *Component* is a Python class that inherits (directly or indirectly) from :class:`~circuits.core.components.BaseComponent`.qchhhhhhBh}qd(h!]qeh#]qfh%]qgh']qhh)]qiuh+Kh,hh]qj(h:XTechnically, a circuits qkql}qm(hXTechnically, a circuits qnhhaubhN)qo}qp(hX *Component*qqh}qr(h!]qsh#]qth%]quh']qvh)]qwuhhah]qxh:X Componentqyqz}q{(hUhhoubahh\ubh:X? is a Python class that inherits (directly or indirectly) from q|q}}q~(hX? is a Python class that inherits (directly or indirectly) from qhhaubcsphinx.addnodes pending_xref q)q}q(hX0:class:`~circuits.core.components.BaseComponent`qhhahhhU pending_xrefqh}q(UreftypeqXclassqUrefwarnqU reftargetqX&circuits.core.components.BaseComponentqU refdomainqXpyqh']qh%]qU refexplicitqh!]qh#]qh)]qUrefdocqUman/componentsqUpy:classqNU py:moduleqNuh+Kh]qcdocutils.nodes literal q)q}q(hhh}q(h!]qh#]q(UxrefqhXpy-classqeh%]qh']qh)]quhhh]qh:X BaseComponentqq}q(hUhhubahUliteralqubaubh:X.q}q(hX.hhaubeubh>)q}q(hXKComponents can be sub-classed like any other normal Python class, however components can also be composed of other components and it is natural to do so. These are called *Complex Components*. An example of a Complex Component within the circuits library is the :class:`circuits.web.servers.Server` Component which is comprised of:qhhhhhhBh}q(h!]qh#]qh%]qh']qh)]quh+K h,hh]q(h:XComponents can be sub-classed like any other normal Python class, however components can also be composed of other components and it is natural to do so. These are called qq}q(hXComponents can be sub-classed like any other normal Python class, however components can also be composed of other components and it is natural to do so. These are called qhhubhN)q}q(hX*Complex Components*qh}q(h!]qh#]qh%]qh']qh)]quhhh]qh:XComplex Componentsq…q}q(hUhhubahh\ubh:XG. An example of a Complex Component within the circuits library is the qŅq}q(hXG. An example of a Complex Component within the circuits library is the qhhubh)q}q(hX$:class:`circuits.web.servers.Server`qhhhhhhh}q(UreftypeqXclassqhhXcircuits.web.servers.ServerqU refdomainqXpyqh']qh%]qU refexplicitqԉh!]qh#]qh)]qhhhNhNuh+K h]qh)q}q(hhh}q(h!]qh#]q(hhXpy-classqeh%]qh']qh)]quhhh]qh:Xcircuits.web.servers.Serverqㅁq}q(hUhhubahhubaubh:X! Component which is comprised of:q慁q}q(hX! Component which is comprised of:qhhubeubcdocutils.nodes bullet_list q)q}q(hUhhhhhU bullet_listqh}q(UbulletqX-h']qh%]qh!]qh#]qh)]quh+Kh,hh]q(cdocutils.nodes list_item q)q}q(hX':class:`circuits.net.sockets.TCPServer`qhhhhhU list_itemqh}q(h!]qh#]qh%]qh']qh)]ruh+Nh,hh]rh>)r}r(hhhhhhhhBh}r(h!]rh#]rh%]rh']rh)]r uh+Kh]r h)r }r (hhhjhhhhh}r (UreftyperXclassrhhXcircuits.net.sockets.TCPServerrU refdomainrXpyrh']rh%]rU refexplicitrh!]rh#]rh)]rhhhNhNuh+Kh]rh)r}r(hhh}r(h!]rh#]r(hjXpy-classreh%]r h']r!h)]r"uhj h]r#h:Xcircuits.net.sockets.TCPServerr$r%}r&(hUhjubahhubaubaubaubh)r'}r((hX(:class:`circuits.web.servers.BaseServer`r)hhhhhhh}r*(h!]r+h#]r,h%]r-h']r.h)]r/uh+Nh,hh]r0h>)r1}r2(hj)hj'hhhhBh}r3(h!]r4h#]r5h%]r6h']r7h)]r8uh+Kh]r9h)r:}r;(hj)hj1hhhhh}r<(Ureftyper=Xclassr>hhXcircuits.web.servers.BaseServerr?U refdomainr@XpyrAh']rBh%]rCU refexplicitrDh!]rEh#]rFh)]rGhhhNhNuh+Kh]rHh)rI}rJ(hj)h}rK(h!]rLh#]rM(hjAXpy-classrNeh%]rOh']rPh)]rQuhj:h]rRh:Xcircuits.web.servers.BaseServerrSrT}rU(hUhjIubahhubaubaubaubh)rV}rW(hX:class:`circuits.web.http.HTTP`rXhhhhhhh}rY(h!]rZh#]r[h%]r\h']r]h)]r^uh+Nh,hh]r_h>)r`}ra(hjXhjVhhhhBh}rb(h!]rch#]rdh%]reh']rfh)]rguh+Kh]rhh)ri}rj(hjXhj`hhhhh}rk(UreftyperlXclassrmhhXcircuits.web.http.HTTPrnU refdomainroXpyrph']rqh%]rrU refexplicitrsh!]rth#]ruh)]rvhhhNhNuh+Kh]rwh)rx}ry(hjXh}rz(h!]r{h#]r|(hjpXpy-classr}eh%]r~h']rh)]ruhjih]rh:Xcircuits.web.http.HTTPrr}r(hUhjxubahhubaubaubaubh)r}r(hX8:class:`circuits.web.dispatchers.dispatcher.Dispatcher` rhhhhhhh}r(h!]rh#]rh%]rh']rh)]ruh+Nh,hh]rh>)r}r(hX7:class:`circuits.web.dispatchers.dispatcher.Dispatcher`rhjhhhhBh}r(h!]rh#]rh%]rh']rh)]ruh+Kh]rh)r}r(hjhjhhhhh}r(UreftyperXclassrhhX.circuits.web.dispatchers.dispatcher.DispatcherrU refdomainrXpyrh']rh%]rU refexplicitrh!]rh#]rh)]rhhhNhNuh+Kh]rh)r}r(hjh}r(h!]rh#]r(hjXpy-classreh%]rh']rh)]ruhjh]rh:X.circuits.web.dispatchers.dispatcher.Dispatcherrr}r(hUhjubahhubaubaubaubeubh>)r}r(hXNote that there is no class or other technical means to mark a component as a complex component. Rather, all component instances in a circuits based application belong to some component tree (there may be several), with Complex Components being a subtree within that structure.rhhhhhhBh}r(h!]rh#]rh%]rh']rh)]ruh+Kh,hh]rh:XNote that there is no class or other technical means to mark a component as a complex component. Rather, all component instances in a circuits based application belong to some component tree (there may be several), with Complex Components being a subtree within that structure.rr}r(hjhjubaubh>)r}r(hXA Component is attached to the tree by registering with the parent and detached by un-registering itself (methods :meth:`~circuits.core.components.BaseComponent.register` and :meth:`~circuits.core.components.BaseComponent.unregister` of ``BaseComponent``).rhhhhhhBh}r(h!]rh#]rh%]rh']rh)]ruh+Kh,hh]r(h:XrA Component is attached to the tree by registering with the parent and detached by un-registering itself (methods rr}r(hXrA Component is attached to the tree by registering with the parent and detached by un-registering itself (methods rhjubh)r}r(hX8:meth:`~circuits.core.components.BaseComponent.register`rhjhhhhh}r(UreftyperXmethrhhX/circuits.core.components.BaseComponent.registerrU refdomainrXpyrh']rh%]rU refexplicitrh!]rh#]rh)]rhhhNhNuh+Kh]rh)r}r(hjh}r(h!]rh#]r(hjXpy-methreh%]rh']rh)]ruhjh]rh:X register()rr}r(hUhjubahhubaubh:X and rr}r(hX and rhjubh)r}r(hX::meth:`~circuits.core.components.BaseComponent.unregister`rhjhhhhh}r(UreftyperXmethrhhX1circuits.core.components.BaseComponent.unregisterrU refdomainrXpyrh']rh%]rU refexplicitrh!]rh#]rh)]rhhhNhNuh+Kh]rh)r}r(hjh}r(h!]rh#]r(hjXpy-methreh%]rh']rh)]r uhjh]r h:X unregister()r r }r (hUhjubahhubaubh:X of rr}r(hX of rhjubh)r}r(hX``BaseComponent``rh}r(h!]rh#]rh%]rh']rh)]ruhjh]rh:X BaseComponentrr}r(hUhjubahhubh:X).rr }r!(hX).r"hjubeubeubahUU transformerr#NU footnote_refsr$}r%Urefnamesr&}r'Usymbol_footnotesr(]r)Uautofootnote_refsr*]r+Usymbol_footnote_refsr,]r-U citationsr.]r/h,hU current_liner0NUtransform_messagesr1]r2Ureporterr3NUid_startr4KU autofootnotesr5]r6U citation_refsr7}r8Uindirect_targetsr9]r:Usettingsr;(cdocutils.frontend Values r<or=}r>(Ufootnote_backlinksr?KUrecord_dependenciesr@NU rfc_base_urlrAUhttp://tools.ietf.org/html/rBU tracebackrCUpep_referencesrDNUstrip_commentsrENU toc_backlinksrFUentryrGU language_coderHUenrIU datestamprJNU report_levelrKKU _destinationrLNU halt_levelrMKU strip_classesrNNh2NUerror_encoding_error_handlerrOUbackslashreplacerPUdebugrQNUembed_stylesheetrRUoutput_encoding_error_handlerrSUstrictrTU sectnum_xformrUKUdump_transformsrVNU docinfo_xformrWKUwarning_streamrXNUpep_file_url_templaterYUpep-%04drZUexit_status_levelr[KUconfigr\NUstrict_visitorr]NUcloak_email_addressesr^Utrim_footnote_reference_spacer_Uenvr`NUdump_pseudo_xmlraNUexpose_internalsrbNUsectsubtitle_xformrcU source_linkrdNUrfc_referencesreNUoutput_encodingrfUutf-8rgU source_urlrhNUinput_encodingriU utf-8-sigrjU_disable_configrkNU id_prefixrlUU tab_widthrmKUerror_encodingrnU ISO-8859-1roU_sourcerpU;/home/prologic/work/circuits/docs/source/man/components.rstrqUgettext_compactrrU generatorrsNUdump_internalsrtNU smart_quotesruU pep_base_urlrvUhttp://www.python.org/dev/peps/rwUsyntax_highlightrxUlongryUinput_encoding_error_handlerrzjTUauto_id_prefixr{Uidr|Udoctitle_xformr}Ustrip_elements_with_classesr~NU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}rhhsUsubstitution_namesr}rhh,h}r(h!]rh']rh%]rUsourcerhh#]rh)]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/man/handlers.doctree0000644000014400001440000004771512113366671022675 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(Ximplicit event handlersqNXexplicit event handlersqNXhandlersqNuUsubstitution_defsq }q Uparse_messagesq ]q Ucurrent_sourceq NU decorationqNUautofootnote_startqKUnameidsq}q(hUimplicit-event-handlersqhUexplicit-event-handlersqhUhandlersquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX9/home/prologic/work/circuits/docs/source/man/handlers.rstqq}q bUtagnameq!Usectionq"U attributesq#}q$(Udupnamesq%]q&Uclassesq']q(Ubackrefsq)]q*Uidsq+]q,haUnamesq-]q.hauUlineq/KUdocumentq0hh]q1(cdocutils.nodes title q2)q3}q4(hXHandlersq5hhhhh!Utitleq6h#}q7(h%]q8h']q9h)]q:h+]q;h-]qXHandlersq?q@}qA(hh5hh3ubaubh)qB}qC(hUhhhhh!h"h#}qD(h%]qEh']qFh)]qGh+]qHhah-]qIhauh/Kh0hh]qJ(h2)qK}qL(hXExplicit Event HandlersqMhhBhhh!h6h#}qN(h%]qOh']qPh)]qQh+]qRh-]qSuh/Kh0hh]qTh>XExplicit Event HandlersqUqV}qW(hhMhhKubaubcdocutils.nodes paragraph qX)qY}qZ(hX(Event Handlers are methods of components that are invoked when a matching event is dispatched. These can be declared explicitly on a :class:`~circuits.core.components.BaseComponent` or :class:`~circuits.core.components.Component` or by using the :func:`~circuits.core.handlers.handler` decorator.q[hhBhhh!U paragraphq\h#}q](h%]q^h']q_h)]q`h+]qah-]qbuh/K h0hh]qc(h>XEvent Handlers are methods of components that are invoked when a matching event is dispatched. These can be declared explicitly on a qdqe}qf(hXEvent Handlers are methods of components that are invoked when a matching event is dispatched. These can be declared explicitly on a qghhYubcsphinx.addnodes pending_xref qh)qi}qj(hX0:class:`~circuits.core.components.BaseComponent`qkhhYhhh!U pending_xrefqlh#}qm(UreftypeqnXclassqoUrefwarnqpU reftargetqqX&circuits.core.components.BaseComponentqrU refdomainqsXpyqth+]quh)]qvU refexplicitqwh%]qxh']qyh-]qzUrefdocq{U man/handlersq|Upy:classq}NU py:moduleq~Nuh/K h]qcdocutils.nodes literal q)q}q(hhkh#}q(h%]qh']q(UxrefqhtXpy-classqeh)]qh+]qh-]quhhih]qh>X BaseComponentqq}q(hUhhubah!Uliteralqubaubh>X or qq}q(hX or qhhYubhh)q}q(hX,:class:`~circuits.core.components.Component`qhhYhhh!hlh#}q(UreftypeqXclassqhphqX"circuits.core.components.ComponentqU refdomainqXpyqh+]qh)]qU refexplicitqh%]qh']qh-]qh{h|h}Nh~Nuh/K h]qh)q}q(hhh#}q(h%]qh']q(hhXpy-classqeh)]qh+]qh-]quhhh]qh>X Componentqq}q(hUhhubah!hubaubh>X or by using the qq}q(hX or by using the qhhYubhh)q}q(hX':func:`~circuits.core.handlers.handler`qhhYhhh!hlh#}q(UreftypeqXfuncqhphqXcircuits.core.handlers.handlerqU refdomainqXpyqh+]qh)]qU refexplicitqh%]qh']qh-]qh{h|h}Nh~Nuh/K h]qh)q}q(hhh#}q(h%]qh']q(hhXpy-funcqeh)]qh+]qh-]quhhh]qh>X handler()qυq}q(hUhhubah!hubaubh>X decorator.q҅q}q(hX decorator.qhhYubeubcdocutils.nodes literal_block q)q}q(hX#!/usr/bin/env python from circuits.core.debugger import Debugger from circuits.core.components import BaseComponent from circuits.core.handlers import handler class MyComponent(BaseComponent): def __init__(self): super(MyComponent, self).__init__() Debugger().register(self) @handler("started", channel="*") def _on_started(self, component): print "Start event detected" MyComponent().run() qhhBhhh!U literal_blockqh#}q(Ulinenosq܈UlanguageqhXpythonqޅq}qbh%]qU xml:spaceqUpreserveqh+]qh)]qUsourceqXK/home/prologic/work/circuits/docs/source/man/examples/handler_annotation.pyqh']qh-]quh/Kh0hh]qh>X#!/usr/bin/env python from circuits.core.debugger import Debugger from circuits.core.components import BaseComponent from circuits.core.handlers import handler class MyComponent(BaseComponent): def __init__(self): super(MyComponent, self).__init__() Debugger().register(self) @handler("started", channel="*") def _on_started(self, component): print "Start event detected" MyComponent().run() q녁q}q(hUhhubaubhX)q}q(hXK:download:`Download handler_annotation.py `qhhBhhh!h\h#}q(h%]qh']qh)]qh+]qh-]quh/Kh0hh]qcsphinx.addnodes download_reference q)q}q(hhhhhhh!Udownload_referenceqh#}q(UreftypeqXdownloadqhphqXexamples/handler_annotation.pyqU refdomainrUh+]rh)]rU refexplicitrh%]rh']rh-]rh{h|UfilenamerXhandler_annotation.pyruh/Kh]r h)r }r (hhh#}r (h%]r h']r(hheh)]rh+]rh-]ruhhh]rh>XDownload handler_annotation.pyrr}r(hUhj ubah!hubaubaubhX)r}r(hX:The handler decorator on line 14 turned the method ``_on_started`` into an event handler for the event ``Started``. Event names used to define handlers are the uncameled class names of the event. An event with a class name ``MySpecialEvent`` becomes "``my_special_event``" when referred to in a handler definition.rhhBhhh!h\h#}r(h%]rh']rh)]rh+]rh-]ruh/Kh0hh]r(h>X3The handler decorator on line 14 turned the method r r!}r"(hX3The handler decorator on line 14 turned the method r#hjubh)r$}r%(hX``_on_started``r&h#}r'(h%]r(h']r)h)]r*h+]r+h-]r,uhjh]r-h>X _on_startedr.r/}r0(hUhj$ubah!hubh>X% into an event handler for the event r1r2}r3(hX% into an event handler for the event r4hjubh)r5}r6(hX ``Started``r7h#}r8(h%]r9h']r:h)]r;h+]r<h-]r=uhjh]r>h>XStartedr?r@}rA(hUhj5ubah!hubh>Xm. Event names used to define handlers are the uncameled class names of the event. An event with a class name rBrC}rD(hXm. Event names used to define handlers are the uncameled class names of the event. An event with a class name rEhjubh)rF}rG(hX``MySpecialEvent``rHh#}rI(h%]rJh']rKh)]rLh+]rMh-]rNuhjh]rOh>XMySpecialEventrPrQ}rR(hUhjFubah!hubh>X becomes "rSrT}rU(hX becomes "rVhjubh)rW}rX(hX``my_special_event``rYh#}rZ(h%]r[h']r\h)]r]h+]r^h-]r_uhjh]r`h>Xmy_special_eventrarb}rc(hUhjWubah!hubh>X+" when referred to in a handler definition.rdre}rf(hX+" when referred to in a handler definition.rghjubeubhX)rh}ri(hXaWhen defining explicit event handlers in this way, it's convention to use the following pattern::rjhhBhhh!h\h#}rk(h%]rlh']rmh)]rnh+]roh-]rpuh/Kh0hh]rqh>X`When defining explicit event handlers in this way, it's convention to use the following pattern:rrrs}rt(hX`When defining explicit event handlers in this way, it's convention to use the following pattern:ruhjhubaubh)rv}rw(hX.@handler("foo") def _on_foo(self, ...): ...rxhhBhhh!hh#}ry(hhh+]rzh)]r{h%]r|h']r}h-]r~uh/Kh0hh]rh>X.@handler("foo") def _on_foo(self, ...): ...rr}r(hUhjvubaubhX)r}r(hXThis makes reading code clear and concise and obvious to the reader that the method is not part of the class's public API (*leading underscore as per Python convention*) and that it is invoked for events of type ``SomeEvent``.rhhBhhh!h\h#}r(h%]rh']rh)]rh+]rh-]ruh/K"h0hh]r(h>X{This makes reading code clear and concise and obvious to the reader that the method is not part of the class's public API (rr}r(hX{This makes reading code clear and concise and obvious to the reader that the method is not part of the class's public API (rhjubcdocutils.nodes emphasis r)r}r(hX-*leading underscore as per Python convention*rh#}r(h%]rh']rh)]rh+]rh-]ruhjh]rh>X+leading underscore as per Python conventionrr}r(hUhjubah!Uemphasisrubh>X,) and that it is invoked for events of type rr}r(hX,) and that it is invoked for events of type rhjubh)r}r(hX ``SomeEvent``rh#}r(h%]rh']rh)]rh+]rh-]ruhjh]rh>X SomeEventrr}r(hUhjubah!hubh>X.r}r(hX.hjubeubhX)r}r(hXThe optional keyword argument "``channel``" can be used to attach the handler to a different channel than the component's channel (*as specified by the component's channel attribute*).rhhBhhh!h\h#}r(h%]rh']rh)]rh+]rh-]ruh/K'h0hh]r(h>XThe optional keyword argument "rr}r(hXThe optional keyword argument "rhjubh)r}r(hX ``channel``rh#}r(h%]rh']rh)]rh+]rh-]ruhjh]rh>Xchannelrr}r(hUhjubah!hubh>XY" can be used to attach the handler to a different channel than the component's channel (rr}r(hXY" can be used to attach the handler to a different channel than the component's channel (rhjubj)r}r(hX3*as specified by the component's channel attribute*rh#}r(h%]rh']rh)]rh+]rh-]ruhjh]rh>X1as specified by the component's channel attributerr}r(hUhjubah!jubh>X).rr}r(hX).rhjubeubhX)r}r(hXjHandler methods must be declared with arguments and keyword arguments that match the arguments passed to the event upon its creation. Looking at the API for :class:`~circuits.core.events.Started` you'll find that the component that has been started is passed as an argument to its constructor. Therefore, our handler method must declare one argument (*Line 15*).rhhBhhh!h\h#}r(h%]rh']rh)]rh+]rh-]ruh/K+h0hh]r(h>XHandler methods must be declared with arguments and keyword arguments that match the arguments passed to the event upon its creation. Looking at the API for rr}r(hXHandler methods must be declared with arguments and keyword arguments that match the arguments passed to the event upon its creation. Looking at the API for rhjubhh)r}r(hX&:class:`~circuits.core.events.Started`rhjhhh!hlh#}r(UreftyperXclassrhphqXcircuits.core.events.StartedrU refdomainrXpyrh+]rh)]rU refexplicitrh%]rh']rh-]rh{h|h}Nh~Nuh/K+h]rh)r}r(hjh#}r(h%]rh']r(hjXpy-classreh)]rh+]rh-]r uhjh]r h>XStartedr r }r (hUhjubah!hubaubh>X you'll find that the component that has been started is passed as an argument to its constructor. Therefore, our handler method must declare one argument (rr}r(hX you'll find that the component that has been started is passed as an argument to its constructor. Therefore, our handler method must declare one argument (rhjubj)r}r(hX *Line 15*rh#}r(h%]rh']rh)]rh+]rh-]ruhjh]rh>XLine 15rr}r(hUhjubah!jubh>X).rr }r!(hX).r"hjubeubhX)r#}r$(hXThe ``@handler(...)`` decorator accepts other keyword arguments that influence the behavior of the event handler and its invocation. Details can be found in the API description of :func:`~circuits.core.handlers.handler`.r%hhBhhh!h\h#}r&(h%]r'h']r(h)]r)h+]r*h-]r+uh/K1h0hh]r,(h>XThe r-r.}r/(hXThe r0hj#ubh)r1}r2(hX``@handler(...)``r3h#}r4(h%]r5h']r6h)]r7h+]r8h-]r9uhj#h]r:h>X @handler(...)r;r<}r=(hUhj1ubah!hubh>X decorator accepts other keyword arguments that influence the behavior of the event handler and its invocation. Details can be found in the API description of r>r?}r@(hX decorator accepts other keyword arguments that influence the behavior of the event handler and its invocation. Details can be found in the API description of rAhj#ubhh)rB}rC(hX':func:`~circuits.core.handlers.handler`rDhj#hhh!hlh#}rE(UreftyperFXfuncrGhphqXcircuits.core.handlers.handlerrHU refdomainrIXpyrJh+]rKh)]rLU refexplicitrMh%]rNh']rOh-]rPh{h|h}Nh~Nuh/K1h]rQh)rR}rS(hjDh#}rT(h%]rUh']rV(hjJXpy-funcrWeh)]rXh+]rYh-]rZuhjBh]r[h>X handler()r\r]}r^(hUhjRubah!hubaubh>X.r_}r`(hX.hj#ubeubeubh)ra}rb(hUhhhhh!h"h#}rc(h%]rdh']reh)]rfh+]rghah-]rhhauh/K7h0hh]ri(h2)rj}rk(hXImplicit Event Handlersrlhjahhh!h6h#}rm(h%]rnh']roh)]rph+]rqh-]rruh/K7h0hh]rsh>XImplicit Event Handlersrtru}rv(hjlhjjubaubhX)rw}rx(hXTo make things easier for the developer when creating many event handlers and thus save on some typing, the :class:`~circuits.core.components.Component` can be used and subclassed instead which provides an implicit mechanism for creating event handlers.ryhjahhh!h\h#}rz(h%]r{h']r|h)]r}h+]r~h-]ruh/K:h0hh]r(h>XlTo make things easier for the developer when creating many event handlers and thus save on some typing, the rr}r(hXlTo make things easier for the developer when creating many event handlers and thus save on some typing, the rhjwubhh)r}r(hX,:class:`~circuits.core.components.Component`rhjwhhh!hlh#}r(UreftyperXclassrhphqX"circuits.core.components.ComponentrU refdomainrXpyrh+]rh)]rU refexplicitrh%]rh']rh-]rh{h|h}Nh~Nuh/K:h]rh)r}r(hjh#}r(h%]rh']r(hjXpy-classreh)]rh+]rh-]ruhjh]rh>X Componentrr}r(hUhjubah!hubaubh>Xe can be used and subclassed instead which provides an implicit mechanism for creating event handlers.rr}r(hXe can be used and subclassed instead which provides an implicit mechanism for creating event handlers.rhjwubeubhX)r}r(hXBasically every method in the component is automatically and implicitly marked as an event handler with ``@handler(>`` is the name of each method applied.rhjahhh!h\h#}r(h%]rh']rh)]rh+]rh-]ruh/K?h0hh]r(h>XhBasically every method in the component is automatically and implicitly marked as an event handler with rr}r(hXhBasically every method in the component is automatically and implicitly marked as an event handler with rhjubh)r}r(hX``@handler(X@handler(X where rr}r(hX where rhjubh)r}r(hX ``>``rh#}r(h%]rh']rh)]rh+]rh-]ruhjh]rh>X>rr}r(hUhjubah!hubh>X$ is the name of each method applied.rr}r(hX$ is the name of each method applied.rhjubeubhX)r}r(hXThe only exceptions are:rhjahhh!h\h#}r(h%]rh']rh)]rh+]rh-]ruh/KCh0hh]rh>XThe only exceptions are:rr}r(hjhjubaubcdocutils.nodes bullet_list r)r}r(hUhjahhh!U bullet_listrh#}r(UbulletrX-h+]rh)]rh%]rh']rh-]ruh/KEh0hh]r(cdocutils.nodes list_item r)r}r(hX+Methods are start with an underscore ``_``.rhjhhh!U list_itemrh#}r(h%]rh']rh)]rh+]rh-]ruh/Nh0hh]rhX)r}r(hjhjhhh!h\h#}r(h%]rh']rh)]rh+]rh-]ruh/KEh]r(h>X%Methods are start with an underscore rr}r(hX%Methods are start with an underscore rhjubh)r}r (hX``_``r h#}r (h%]r h']r h)]rh+]rh-]ruhjh]rh>X_r}r(hUhjubah!hubh>X.r}r(hX.hjubeubaubj)r}r(hXHMethods already marked explicitly with the ``@handler(...)`` decorator. rhjhhh!jh#}r(h%]rh']rh)]rh+]rh-]ruh/Nh0hh]rhX)r }r!(hXGMethods already marked explicitly with the ``@handler(...)`` decorator.r"hjhhh!h\h#}r#(h%]r$h']r%h)]r&h+]r'h-]r(uh/KFh]r)(h>X+Methods already marked explicitly with the r*r+}r,(hX+Methods already marked explicitly with the r-hj ubh)r.}r/(hX``@handler(...)``r0h#}r1(h%]r2h']r3h)]r4h+]r5h-]r6uhj h]r7h>X @handler(...)r8r9}r:(hUhj.ubah!hubh>X decorator.r;r<}r=(hX decorator.r>hj ubeubaubeubcdocutils.nodes note r?)r@}rA(hX]You can specify that a method not be an event handler by marking it with ``@handler(False)``.rBhjahhh!UnoterCh#}rD(h%]rEh']rFh)]rGh+]rHh-]rIuh/Nh0hh]rJhX)rK}rL(hX]You can specify that a method not be an event handler by marking it with ``@handler(False)``.rMhj@hhh!h\h#}rN(h%]rOh']rPh)]rQh+]rRh-]rSuh/KIh]rT(h>XIYou can specify that a method not be an event handler by marking it with rUrV}rW(hXIYou can specify that a method not be an event handler by marking it with rXhjKubh)rY}rZ(hX``@handler(False)``r[h#}r\(h%]r]h']r^h)]r_h+]r`h-]rauhjKh]rbh>X@handler(False)rcrd}re(hUhjYubah!hubh>X.rf}rg(hX.hjKubeubaubeubeubahUU transformerrhNU footnote_refsri}rjUrefnamesrk}rlUsymbol_footnotesrm]rnUautofootnote_refsro]rpUsymbol_footnote_refsrq]rrU citationsrs]rth0hU current_lineruNUtransform_messagesrv]rwUreporterrxNUid_startryKU autofootnotesrz]r{U citation_refsr|}r}Uindirect_targetsr~]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh6NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerU9/home/prologic/work/circuits/docs/source/man/handlers.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hjahhBhhuUsubstitution_namesr}rh!h0h#}r(h%]rh+]rh)]rUsourcerhh']rh-]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/man/index.doctree0000644000014400001440000000625712113366671022200 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qXthe circuits frameworkqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhUthe-circuits-frameworkqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX6/home/prologic/work/circuits/docs/source/man/index.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q(haUnamesq)]q*hauUlineq+KUdocumentq,hh]q-(cdocutils.nodes title q.)q/}q0(hXThe circuits Frameworkq1hhhhhUtitleq2h}q3(h!]q4h#]q5h%]q6h']q7h)]q8uh+Kh,hh]q9cdocutils.nodes Text q:XThe circuits Frameworkq;q<}q=(hh1hh/ubaubcdocutils.nodes compound q>)q?}q@(hUhhhhhUcompoundqAh}qB(h!]qCh#]qDUtoctree-wrapperqEah%]qFh']qGh)]qHuh+Nh,hh]qIcsphinx.addnodes toctree qJ)qK}qL(hUhh?hhhUtoctreeqMh}qN(UnumberedqOKhU man/indexqPU titlesonlyqQUglobqRh']qSh%]qTh!]qUh#]qVh)]qWUentriesqX]qY(NXman/componentsqZq[NX man/eventsq\q]NX man/handlersq^q_eUhiddenq`U includefilesqa]qb(hZh\h^eUmaxdepthqcKuh+Kh]qdubaubh>)qe}qf(hUhhhhhhAh}qg(h!]qhh#]qihEah%]qjh']qkh)]qluh+Nh,hh]qmhJ)qn}qo(hUhhehhhhMh}qp(hOKhhPhQhRh']qqh%]qrh!]qsh#]qth)]quhX]qv(NX man/valuesqwqxNX man/debuggingqyqzNX man/toolsq{q|NX man/managerq}q~eh`ha]q(hwhyh{h}ehcJuh+K h]qubaubeubahUU transformerqNU footnote_refsq}qUrefnamesq}qUsymbol_footnotesq]qUautofootnote_refsq]qUsymbol_footnote_refsq]qU citationsq]qh,hU current_lineqNUtransform_messagesq]qUreporterqNUid_startqKU autofootnotesq]qU citation_refsq}qUindirect_targetsq]qUsettingsq(cdocutils.frontend Values qoq}q(Ufootnote_backlinksqKUrecord_dependenciesqNU rfc_base_urlqUhttp://tools.ietf.org/html/qU tracebackqUpep_referencesqNUstrip_commentsqNU toc_backlinksqUentryqU language_codeqUenqU datestampqNU report_levelqKU _destinationqNU halt_levelqKU strip_classesqNh2NUerror_encoding_error_handlerqUbackslashreplaceqUdebugqNUembed_stylesheetqUoutput_encoding_error_handlerqUstrictqU sectnum_xformqKUdump_transformsqNU docinfo_xformqKUwarning_streamqNUpep_file_url_templateqUpep-%04dqUexit_status_levelqKUconfigqNUstrict_visitorqNUcloak_email_addressesqUtrim_footnote_reference_spaceqUenvqNUdump_pseudo_xmlqNUexpose_internalsqNUsectsubtitle_xformqU source_linkqNUrfc_referencesqNUoutput_encodingqUutf-8qU source_urlqNUinput_encodingqU utf-8-sigqU_disable_configqNU id_prefixqUU tab_widthqKUerror_encodingqU ISO-8859-1qU_sourceqU6/home/prologic/work/circuits/docs/source/man/index.rstqUgettext_compactqЈU generatorqNUdump_internalsqNU smart_quotesqӉU pep_base_urlqUhttp://www.python.org/dev/peps/qUsyntax_highlightqUlongqUinput_encoding_error_handlerqhUauto_id_prefixqUidqUdoctitle_xformqۉUstrip_elements_with_classesqNU _config_filesq]qUfile_insertion_enabledqKU raw_enabledqKU dump_settingsqNubUsymbol_footnote_startqKUidsq}qhhsUsubstitution_namesq}qhh,h}q(h!]qh']qh%]qUsourceqhh#]qh)]quU footnotesq]qUrefidsq}qub.circuits-2.1.0/docs/build/doctrees/web/0000755000014400001440000000000012113366740017507 5ustar prologicuserscircuits-2.1.0/docs/build/doctrees/web/introduction.doctree0000644000014400001440000006512312113366672023612 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X error eventsqNXcherrypyqX introductionqNXoverviewq NX dispatchersq NXserversq NXother componentsq NXeventsq NuUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU error-eventsqhUcherrypyqhU introductionqh Uoverviewqh U dispatchersqh Userversqh Uother-componentsqh UeventsquUchildrenq]q cdocutils.nodes section q!)q"}q#(U rawsourceq$UUparentq%hUsourceq&cdocutils.nodes reprunicode q'X=/home/prologic/work/circuits/docs/source/web/introduction.rstq(q)}q*bUtagnameq+Usectionq,U attributesq-}q.(Udupnamesq/]q0Uclassesq1]q2Ubackrefsq3]q4Uidsq5]q6haUnamesq7]q8hauUlineq9KUdocumentq:hh]q;(cdocutils.nodes title q<)q=}q>(h$X Introductionq?h%h"h&h)h+Utitleq@h-}qA(h/]qBh1]qCh3]qDh5]qEh7]qFuh9Kh:hh]qGcdocutils.nodes Text qHX IntroductionqIqJ}qK(h$h?h%h=ubaubcdocutils.nodes paragraph qL)qM}qN(h$Xcircuits.web is a set of components for building high performance HTTP/1.1 and WSGI/1.0 compliant web applications. These components make it easy to rapidly develop rich, scalable web applications with minimal effort.qOh%h"h&h)h+U paragraphqPh-}qQ(h/]qRh1]qSh3]qTh5]qUh7]qVuh9Kh:hh]qWhHXcircuits.web is a set of components for building high performance HTTP/1.1 and WSGI/1.0 compliant web applications. These components make it easy to rapidly develop rich, scalable web applications with minimal effort.qXqY}qZ(h$hOh%hMubaubhL)q[}q\(h$Xcircuits.web borrows fromq]h%h"h&h)h+hPh-}q^(h/]q_h1]q`h3]qah5]qbh7]qcuh9Kh:hh]qdhHXcircuits.web borrows fromqeqf}qg(h$h]h%h[ubaubcdocutils.nodes bullet_list qh)qi}qj(h$Uh%h"h&h)h+U bullet_listqkh-}ql(UbulletqmX*h5]qnh3]qoh/]qph1]qqh7]qruh9K h:hh]qs(cdocutils.nodes list_item qt)qu}qv(h$X%`CherryPy `_qwh%hih&h)h+U list_itemqxh-}qy(h/]qzh1]q{h3]q|h5]q}h7]q~uh9Nh:hh]qhL)q}q(h$hwh%huh&h)h+hPh-}q(h/]qh1]qh3]qh5]qh7]quh9K h]q(cdocutils.nodes reference q)q}q(h$hwh-}q(UnameqXCherryPyqUrefuriqXhttp://www.cherrypy.orgqh5]qh3]qh/]qh1]qh7]quh%hh]qhHXCherryPyqq}q(h$Uh%hubah+U referencequbcdocutils.nodes target q)q}q(h$X qU referencedqKh%hh+Utargetqh-}q(Urefuriqhh5]qhah3]qh/]qh1]qh7]qhauh]qubeubaubht)q}q(h$X"BaseHTTPServer (*Python std. lib*)qh%hih&h)h+hxh-}q(h/]qh1]qh3]qh5]qh7]quh9Nh:hh]qhL)q}q(h$hh%hh&h)h+hPh-}q(h/]qh1]qh3]qh5]qh7]quh9K h]q(hHXBaseHTTPServer (qq}q(h$XBaseHTTPServer (qh%hubcdocutils.nodes emphasis q)q}q(h$X*Python std. lib*qh-}q(h/]qh1]qh3]qh5]qh7]quh%hh]qhHXPython std. libq˅q}q(h$Uh%hubah+UemphasisqubhHX)q}q(h$X)h%hubeubaubht)q}q(h$Xwsgiref (*Python std. lib*) qh%hih&h)h+hxh-}q(h/]qh1]qh3]qh5]qh7]quh9Nh:hh]qhL)q}q(h$Xwsgiref (*Python std. lib*)qh%hh&h)h+hPh-}q(h/]qh1]qh3]qh5]qh7]quh9K h]q(hHX wsgiref (q允q}q(h$X wsgiref (qh%hubh)q}q(h$X*Python std. lib*qh-}q(h/]qh1]qh3]qh5]qh7]quh%hh]qhHXPython std. libqq}q(h$Uh%hubah+hubhHX)q}q(h$X)h%hubeubaubeubh!)q}q(h$Uh%h"h&h)h+h,h-}q(h/]qh1]qh3]qh5]qhah7]qh auh9Kh:hh]r(h<)r}r(h$XOverviewrh%hh&h)h+h@h-}r(h/]rh1]rh3]rh5]rh7]r uh9Kh:hh]r hHXOverviewr r }r (h$jh%jubaubhL)r}r(h$XeThe ``circuits.web`` namespace contains the following exported components and events for convenience:rh%hh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9Kh:hh]r(hHXThe rr}r(h$XThe rh%jubcdocutils.nodes literal r)r}r(h$X``circuits.web``rh-}r (h/]r!h1]r"h3]r#h5]r$h7]r%uh%jh]r&hHX circuits.webr'r(}r)(h$Uh%jubah+Uliteralr*ubhHXQ namespace contains the following exported components and events for convenience:r+r,}r-(h$XQ namespace contains the following exported components and events for convenience:r.h%jubeubh!)r/}r0(h$Uh%hh&h)h+h,h-}r1(h/]r2h1]r3h3]r4h5]r5hah7]r6h auh9Kh:hh]r7(h<)r8}r9(h$XEventsr:h%j/h&h)h+h@h-}r;(h/]r<h1]r=h3]r>h5]r?h7]r@uh9Kh:hh]rAhHXEventsrBrC}rD(h$j:h%j8ubaubcdocutils.nodes table rE)rF}rG(h$Uh%j/h&h)h+UtablerHh-}rI(h/]rJh1]rKh3]rLh5]rMh7]rNuh9Nh:hh]rOcdocutils.nodes tgroup rP)rQ}rR(h$Uh-}rS(h5]rTh3]rUh/]rVh1]rWh7]rXUcolsrYKuh%jFh]rZ(cdocutils.nodes colspec r[)r\}r](h$Uh-}r^(h5]r_h3]r`h/]rah1]rbh7]rcUcolwidthrdKuh%jQh]reh+Ucolspecrfubj[)rg}rh(h$Uh-}ri(h5]rjh3]rkh/]rlh1]rmh7]rnUcolwidthroK#uh%jQh]rph+jfubcdocutils.nodes thead rq)rr}rs(h$Uh-}rt(h/]ruh1]rvh3]rwh5]rxh7]ryuh%jQh]rzcdocutils.nodes row r{)r|}r}(h$Uh-}r~(h/]rh1]rh3]rh5]rh7]ruh%jrh]r(cdocutils.nodes entry r)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%j|h]rhL)r}r(h$XEventrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9Kh]rhHXEventrr}r(h$jh%jubaubah+Uentryrubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%j|h]rhL)r}r(h$X Descriptionrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9Kh]rhHX Descriptionrr}r(h$jh%jubaubah+jubeh+Urowrubah+Utheadrubcdocutils.nodes tbody r)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jQh]r(j{)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$XRequestrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9Kh]rhHXRequestrr}r(h$jh%jubaubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$XThe Request Eventrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9Kh]rhHXThe Request Eventrr}r(h$jh%jubaubah+jubeh+jubj{)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$XResponserh%jh&h)h+hPh-}r (h/]r h1]r h3]r h5]r h7]ruh9Kh]rhHXResponserr}r(h$jh%jubaubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$XThe Response Eventrh%jh&h)h+hPh-}r(h/]r h1]r!h3]r"h5]r#h7]r$uh9Kh]r%hHXThe Response Eventr&r'}r((h$jh%jubaubah+jubeh+jubj{)r)}r*(h$Uh-}r+(h/]r,h1]r-h3]r.h5]r/h7]r0uh%jh]r1(j)r2}r3(h$Uh-}r4(h/]r5h1]r6h3]r7h5]r8h7]r9uh%j)h]r:hL)r;}r<(h$XStreamr=h%j2h&h)h+hPh-}r>(h/]r?h1]r@h3]rAh5]rBh7]rCuh9Kh]rDhHXStreamrErF}rG(h$j=h%j;ubaubah+jubj)rH}rI(h$Uh-}rJ(h/]rKh1]rLh3]rMh5]rNh7]rOuh%j)h]rPhL)rQ}rR(h$XThe Stream EventrSh%jHh&h)h+hPh-}rT(h/]rUh1]rVh3]rWh5]rXh7]rYuh9Kh]rZhHXThe Stream Eventr[r\}r](h$jSh%jQubaubah+jubeh+jubeh+Utbodyr^ubeh+Utgroupr_ubaubeubh!)r`}ra(h$Uh%hh&h)h+h,h-}rb(h/]rch1]rdh3]reh5]rfhah7]rgh auh9K"h:hh]rh(h<)ri}rj(h$XServersrkh%j`h&h)h+h@h-}rl(h/]rmh1]rnh3]roh5]rph7]rquh9K"h:hh]rrhHXServersrsrt}ru(h$jkh%jiubaubjE)rv}rw(h$Uh%j`h&h)h+jHh-}rx(h/]ryh1]rzh3]r{h5]r|h7]r}uh9Nh:hh]r~jP)r}r(h$Uh-}r(h5]rh3]rh/]rh1]rh7]rUcolsrKuh%jvh]r(j[)r}r(h$Uh-}r(h5]rh3]rh/]rh1]rh7]rUcolwidthrKuh%jh]rh+jfubj[)r}r(h$Uh-}r(h5]rh3]rh/]rh1]rh7]rUcolwidthrK#uh%jh]rh+jfubjq)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rj{)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$XServerrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9K%h]rhHXServerrr}r(h$jh%jubaubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$X Descriptionrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9K%h]rhHX Descriptionrr}r(h$jh%jubaubah+jubeh+jubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]r(j{)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$X BaseServerrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9K'h]rhHX BaseServerrr}r(h$jh%jubaubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]r h7]r uh%jh]r hL)r }r (h$XThe Base Server (no Dispatcher)rh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9K'h]rhHXThe Base Server (no Dispatcher)rr}r(h$jh%j ubaubah+jubeh+jubj{)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]r uh%jh]r!(j)r"}r#(h$Uh-}r$(h/]r%h1]r&h3]r'h5]r(h7]r)uh%jh]r*hL)r+}r,(h$XServerr-h%j"h&h)h+hPh-}r.(h/]r/h1]r0h3]r1h5]r2h7]r3uh9K)h]r4hHXServerr5r6}r7(h$j-h%j+ubaubah+jubj)r8}r9(h$Uh-}r:(h/]r;h1]r<h3]r=h5]r>h7]r?uh%jh]r@hL)rA}rB(h$X The **full** Server + DispatcherrCh%j8h&h)h+hPh-}rD(h/]rEh1]rFh3]rGh5]rHh7]rIuh9K)h]rJ(hHXThe rKrL}rM(h$XThe rNh%jAubcdocutils.nodes strong rO)rP}rQ(h$X**full**rRh-}rS(h/]rTh1]rUh3]rVh5]rWh7]rXuh%jAh]rYhHXfullrZr[}r\(h$Uh%jPubah+Ustrongr]ubhHX Server + Dispatcherr^r_}r`(h$X Server + Dispatcherrah%jAubeubah+jubeh+jubeh+j^ubeh+j_ubaubeubh!)rb}rc(h$Uh%hh&h)h+h,h-}rd(h/]reh1]rfh3]rgh5]rhhah7]rihauh9K-h:hh]rj(h<)rk}rl(h$X Error Eventsrmh%jbh&h)h+h@h-}rn(h/]roh1]rph3]rqh5]rrh7]rsuh9K-h:hh]rthHX Error Eventsrurv}rw(h$jmh%jkubaubjE)rx}ry(h$Uh%jbh&h)h+jHh-}rz(h/]r{h1]r|h3]r}h5]r~h7]ruh9Nh:hh]rjP)r}r(h$Uh-}r(h5]rh3]rh/]rh1]rh7]rUcolsrKuh%jxh]r(j[)r}r(h$Uh-}r(h5]rh3]rh/]rh1]rh7]rUcolwidthrKuh%jh]rh+jfubj[)r}r(h$Uh-}r(h5]rh3]rh/]rh1]rh7]rUcolwidthrK#uh%jh]rh+jfubjq)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rj{)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$XErrorrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9K0h]rhHXErrorrr}r(h$jh%jubaubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$X Descriptionrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9K0h]rhHX Descriptionrr}r(h$jh%jubaubah+jubeh+jubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]r(j{)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$X HTTPErrorrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9K2h]rhHX HTTPErrorrr}r(h$jh%jubaubah+jubj)r}r(h$Uh-}r(h/]rh1]r h3]r h5]r h7]r uh%jh]r hL)r}r(h$XA generic HTTP Error Eventrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9K2h]rhHXA generic HTTP Error Eventrr}r(h$jh%jubaubah+jubeh+jubj{)r}r(h$Uh-}r(h/]rh1]rh3]r h5]r!h7]r"uh%jh]r#(j)r$}r%(h$Uh-}r&(h/]r'h1]r(h3]r)h5]r*h7]r+uh%jh]r,hL)r-}r.(h$X Forbiddenr/h%j$h&h)h+hPh-}r0(h/]r1h1]r2h3]r3h5]r4h7]r5uh9K4h]r6hHX Forbiddenr7r8}r9(h$j/h%j-ubaubah+jubj)r:}r;(h$Uh-}r<(h/]r=h1]r>h3]r?h5]r@h7]rAuh%jh]rBhL)rC}rD(h$XA Forbidden (403) EventrEh%j:h&h)h+hPh-}rF(h/]rGh1]rHh3]rIh5]rJh7]rKuh9K4h]rLhHXA Forbidden (403) EventrMrN}rO(h$jEh%jCubaubah+jubeh+jubj{)rP}rQ(h$Uh-}rR(h/]rSh1]rTh3]rUh5]rVh7]rWuh%jh]rX(j)rY}rZ(h$Uh-}r[(h/]r\h1]r]h3]r^h5]r_h7]r`uh%jPh]rahL)rb}rc(h$XNotFoundrdh%jYh&h)h+hPh-}re(h/]rfh1]rgh3]rhh5]rih7]rjuh9K6h]rkhHXNotFoundrlrm}rn(h$jdh%jbubaubah+jubj)ro}rp(h$Uh-}rq(h/]rrh1]rsh3]rth5]ruh7]rvuh%jPh]rwhL)rx}ry(h$XA Not Found (404) Eventrzh%joh&h)h+hPh-}r{(h/]r|h1]r}h3]r~h5]rh7]ruh9K6h]rhHXA Not Found (404) Eventrr}r(h$jzh%jxubaubah+jubeh+jubj{)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$XRedirectrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9K8h]rhHXRedirectrr}r(h$jh%jubaubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$XA Redirect (30x) Eventrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9K8h]rhHXA Redirect (30x) Eventrr}r(h$jh%jubaubah+jubeh+jubeh+j^ubeh+j_ubaubeubh!)r}r(h$Uh%hh&h)h+h,h-}r(h/]rh1]rh3]rh5]rhah7]rh auh9K}r?(h$Uh-}r@(h/]rAh1]rBh3]rCh5]rDh7]rEuh%j5h]rF(j)rG}rH(h$Uh-}rI(h/]rJh1]rKh3]rLh5]rMh7]rNuh%j>h]rOhL)rP}rQ(h$XStaticrRh%jGh&h)h+hPh-}rS(h/]rTh1]rUh3]rVh5]rWh7]rXuh9KAh]rYhHXStaticrZr[}r\(h$jRh%jPubaubah+jubj)r]}r^(h$Uh-}r_(h/]r`h1]rah3]rbh5]rch7]rduh%j>h]rehL)rf}rg(h$XA Static File Dispatcherrhh%j]h&h)h+hPh-}ri(h/]rjh1]rkh3]rlh5]rmh7]rnuh9KAh]rohHXA Static File Dispatcherrprq}rr(h$jhh%jfubaubah+jubeh+jubj{)rs}rt(h$Uh-}ru(h/]rvh1]rwh3]rxh5]ryh7]rzuh%j5h]r{(j)r|}r}(h$Uh-}r~(h/]rh1]rh3]rh5]rh7]ruh%jsh]rhL)r}r(h$X Dispatcherrh%j|h&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9KCh]rhHX Dispatcherrr}r(h$jh%jubaubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jsh]rhL)r}r(h$XThe Default Dispatcherrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9KCh]rhHXThe Default Dispatcherrr}r(h$jh%jubaubah+jubeh+jubj{)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%j5h]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$X VirtualHostsrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9KEh]rhHX VirtualHostsrr}r(h$jh%jubaubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$XVirtual Hosts Dispatcherrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9KEh]rhHXVirtual Hosts Dispatcherrr}r(h$jh%jubaubah+jubeh+jubj{)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%j5h]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$XXMLRPCrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9KGh]rhHXXMLRPCrr}r(h$jh%jubaubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$XXML-RPC Dispatcherrh%jh&h)h+hPh-}r(h/]r h1]r h3]r h5]r h7]r uh9KGh]rhHXXML-RPC Dispatcherrr}r(h$jh%jubaubah+jubeh+jubj{)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%j5h]r(j)r}r(h$Uh-}r(h/]rh1]rh3]r h5]r!h7]r"uh%jh]r#hL)r$}r%(h$XJSONRPCr&h%jh&h)h+hPh-}r'(h/]r(h1]r)h3]r*h5]r+h7]r,uh9KIh]r-hHXJSONRPCr.r/}r0(h$j&h%j$ubaubah+jubj)r1}r2(h$Uh-}r3(h/]r4h1]r5h3]r6h5]r7h7]r8uh%jh]r9hL)r:}r;(h$XJSON-RPC Dispatcherr<h%j1h&h)h+hPh-}r=(h/]r>h1]r?h3]r@h5]rAh7]rBuh9KIh]rChHXJSON-RPC DispatcherrDrE}rF(h$j<h%j:ubaubah+jubeh+jubeh+j^ubeh+j_ubaubeubh!)rG}rH(h$Uh%hh&h)h+h,h-}rI(h/]rJh1]rKh3]rLh5]rMhah7]rNh auh9KMh:hh]rO(h<)rP}rQ(h$XOther ComponentsrRh%jGh&h)h+h@h-}rS(h/]rTh1]rUh3]rVh5]rWh7]rXuh9KMh:hh]rYhHXOther ComponentsrZr[}r\(h$jRh%jPubaubjE)r]}r^(h$Uh%jGh&h)h+jHh-}r_(h/]r`h1]rah3]rbh5]rch7]rduh9Nh:hh]rejP)rf}rg(h$Uh-}rh(h5]rih3]rjh/]rkh1]rlh7]rmUcolsrnKuh%j]h]ro(j[)rp}rq(h$Uh-}rr(h5]rsh3]rth/]ruh1]rvh7]rwUcolwidthrxKuh%jfh]ryh+jfubj[)rz}r{(h$Uh-}r|(h5]r}h3]r~h/]rh1]rh7]rUcolwidthrK#uh%jfh]rh+jfubjq)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jfh]rj{)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$X Componentrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9KPh]rhHX Componentrr}r(h$jh%jubaubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$X Descriptionrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9KPh]rhHX Descriptionrr}r(h$jh%jubaubah+jubeh+jubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jfh]r(j{)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]r(j)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$XLoggerrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9KRh]rhHXLoggerrr}r(h$jh%jubaubah+jubj)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]rhL)r}r(h$XDefault Loggerrh%jh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9KRh]rhHXDefault Loggerrr}r(h$jh%jubaubah+jubeh+jubj{)r}r(h$Uh-}r(h/]rh1]rh3]rh5]rh7]ruh%jh]r(j)r }r (h$Uh-}r (h/]r h1]r h3]rh5]rh7]ruh%jh]rhL)r}r(h$X Controllerrh%j h&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9KTh]rhHX Controllerrr}r(h$jh%jubaubah+jubj)r}r (h$Uh-}r!(h/]r"h1]r#h3]r$h5]r%h7]r&uh%jh]r'hL)r(}r)(h$XRequest Handler Mapperr*h%jh&h)h+hPh-}r+(h/]r,h1]r-h3]r.h5]r/h7]r0uh9KTh]r1hHXRequest Handler Mapperr2r3}r4(h$j*h%j(ubaubah+jubeh+jubj{)r5}r6(h$Uh-}r7(h/]r8h1]r9h3]r:h5]r;h7]r<uh%jh]r=(j)r>}r?(h$Uh-}r@(h/]rAh1]rBh3]rCh5]rDh7]rEuh%j5h]rFhL)rG}rH(h$XSessionsrIh%j>h&h)h+hPh-}rJ(h/]rKh1]rLh3]rMh5]rNh7]rOuh9KVh]rPhHXSessionsrQrR}rS(h$jIh%jGubaubah+jubj)rT}rU(h$Uh-}rV(h/]rWh1]rXh3]rYh5]rZh7]r[uh%j5h]r\hL)r]}r^(h$XDefault Sessions Handlerr_h%jTh&h)h+hPh-}r`(h/]rah1]rbh3]rch5]rdh7]reuh9KVh]rfhHXDefault Sessions Handlerrgrh}ri(h$j_h%j]ubaubah+jubeh+jubeh+j^ubeh+j_ubaubhL)rj}rk(h$XdTo start working with circuits.web one normally only needs to import from circuits.web, for example:rlh%jGh&h)h+hPh-}rm(h/]rnh1]roh3]rph5]rqh7]rruh9KYh:hh]rshHXdTo start working with circuits.web one normally only needs to import from circuits.web, for example:rtru}rv(h$jlh%jjubaubcdocutils.nodes literal_block rw)rx}ry(h$Xfrom circuits import Component from circuits.web import BaseServer class Root(Component): def request(self, request, response): return "Hello World!" (BaseServer(8000) + Root()).run()rzh%jGh&h)h+U literal_blockr{h-}r|(Ulinenosr}Ulanguager~XpythonrU xml:spacerUpreserverh5]rh3]rh/]rh1]rh7]ruh9K\h:hh]rhHXfrom circuits import Component from circuits.web import BaseServer class Root(Component): def request(self, request, response): return "Hello World!" (BaseServer(8000) + Root()).run()rr}r(h$Uh%jxubaubhL)r}r(h$XFor further information regarding any of circuits.web's components, events or other modules and functions refer to the API Documentation.rh%jGh&h)h+hPh-}r(h/]rh1]rh3]rh5]rh7]ruh9Kih:hh]rhHXFor further information regarding any of circuits.web's components, events or other modules and functions refer to the API Documentation.rr}r(h$jh%jubaubeubeubeubah$UU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh:hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrjU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh@NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerU=/home/prologic/work/circuits/docs/source/web/introduction.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hjbhhhh"hhhjhj`hjGhj/uUsubstitution_namesr}rh+h:h-}r(h/]rh5]rh3]rUsourcerh)h1]rh7]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/web/basics.doctree0000644000014400001440000004512412113366671022333 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X the basicsqNXa stand alone serverqNXcherrypyquUsubstitution_defsq }q Uparse_messagesq ]q Ucurrent_sourceq NU decorationqNUautofootnote_startqKUnameidsq}q(hU the-basicsqhUa-stand-alone-serverqhUcherrypyquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX7/home/prologic/work/circuits/docs/source/web/basics.rstqq}q bUtagnameq!Usectionq"U attributesq#}q$(Udupnamesq%]q&Uclassesq']q(Ubackrefsq)]q*Uidsq+]q,haUnamesq-]q.hauUlineq/KUdocumentq0hh]q1(cdocutils.nodes title q2)q3}q4(hX The Basicsq5hhhhh!Utitleq6h#}q7(h%]q8h']q9h)]q:h+]q;h-]qX The Basicsq?q@}qA(hh5hh3ubaubcdocutils.nodes paragraph qB)qC}qD(hXcircuits.web is not a **full stack** web framework, rather it is more closely aligned with `CherryPy `_ and offers enough functionality to make quickly developing web applications easy and as flexible as possible. circuits.web does not provide features such as:qEhhhhh!U paragraphqFh#}qG(h%]qHh']qIh)]qJh+]qKh-]qLuh/Kh0hh]qM(h>Xcircuits.web is not a qNqO}qP(hXcircuits.web is not a qQhhCubcdocutils.nodes strong qR)qS}qT(hX**full stack**qUh#}qV(h%]qWh']qXh)]qYh+]qZh-]q[uhhCh]q\h>X full stackq]q^}q_(hUhhSubah!Ustrongq`ubh>X7 web framework, rather it is more closely aligned with qaqb}qc(hX7 web framework, rather it is more closely aligned with qdhhCubcdocutils.nodes reference qe)qf}qg(hX%`CherryPy `_qhh#}qi(UnameqjXCherryPyqkUrefuriqlXhttp://www.cherrypy.orgqmh+]qnh)]qoh%]qph']qqh-]qruhhCh]qsh>XCherryPyqtqu}qv(hUhhfubah!U referenceqwubcdocutils.nodes target qx)qy}qz(hX q{U referencedq|KhhCh!Utargetq}h#}q~(Urefuriqhmh+]qhah)]qh%]qh']qh-]qhauh]qubh>X and offers enough functionality to make quickly developing web applications easy and as flexible as possible. circuits.web does not provide features such as:qq}q(hX and offers enough functionality to make quickly developing web applications easy and as flexible as possible. circuits.web does not provide features such as:qhhCubeubcdocutils.nodes bullet_list q)q}q(hUhhhhh!U bullet_listqh#}q(UbulletqX*h+]qh)]qh%]qh']qh-]quh/K h0hh]q(cdocutils.nodes list_item q)q}q(hXbuiltin Templatingqhhhhh!U list_itemqh#}q(h%]qh']qh)]qh+]qh-]quh/Nh0hh]qhB)q}q(hhhhhhh!hFh#}q(h%]qh']qh)]qh+]qh-]quh/K h]qh>Xbuiltin Templatingqq}q(hhhhubaubaubh)q}q(hXbuiltin Database or ORM toolsqhhhhh!hh#}q(h%]qh']qh)]qh+]qh-]quh/Nh0hh]qhB)q}q(hhhhhhh!hFh#}q(h%]qh']qh)]qh+]qh-]quh/K h]qh>Xbuiltin Database or ORM toolsqq}q(hhhhubaubaubh)q}q(hX**etc** qhhhhh!hh#}q(h%]qh']qh)]qh+]qh-]quh/Nh0hh]qhB)q}q(hX**etc**qhhhhh!hFh#}q(h%]qh']qh)]qh+]qh-]quh/K h]qhR)q}q(hhh#}q(h%]qh']qh)]qh+]qh-]quhhh]qh>Xetcqᅁq}q(hUhhubah!h`ubaubaubeubhB)q}q(hXThe functionality that circutis.web *does* provide ensures that circuits.web is fully HTTP/1.1 and WSGI/1.0 compliant and offers all the essential tools you need to build your web application or website.qhhhhh!hFh#}q(h%]qh']qh)]qh+]qh-]quh/Kh0hh]q(h>X$The functionality that circutis.web qq}q(hX$The functionality that circutis.web qhhubcdocutils.nodes emphasis q)q}q(hX*does*qh#}q(h%]qh']qh)]qh+]qh-]quhhh]qh>Xdoesqq}q(hUhhubah!Uemphasisrubh>X provide ensures that circuits.web is fully HTTP/1.1 and WSGI/1.0 compliant and offers all the essential tools you need to build your web application or website.rr}r(hX provide ensures that circuits.web is fully HTTP/1.1 and WSGI/1.0 compliant and offers all the essential tools you need to build your web application or website.rhhubeubh)r}r(hUhhhhh!h"h#}r(h%]rh']r h)]r h+]r hah-]r hauh/Kh0hh]r (h2)r}r(hXA Stand Alone Serverrhjhhh!h6h#}r(h%]rh']rh)]rh+]rh-]ruh/Kh0hh]rh>XA Stand Alone Serverrr}r(hjhjubaubhB)r}r(hXA stand alone server consist of the components shown in section :ref:`web_getting_started`. The process of handling an HTTP request starts with the :class:`~circuits.net.sockets.TCPServer` receiving a chunk of bytes. It emits those bytes as a :class:`~circuits.net.sockets.Read` event on the channel shared by the Server, HTTP, TCPServer and Dispatcher components ("web" by default).rhjhhh!hFh#}r(h%]rh']r h)]r!h+]r"h-]r#uh/Kh0hh]r$(h>X@A stand alone server consist of the components shown in section r%r&}r'(hX@A stand alone server consist of the components shown in section r(hjubcsphinx.addnodes pending_xref r))r*}r+(hX:ref:`web_getting_started`r,hjhhh!U pending_xrefr-h#}r.(Ureftyper/Xrefr0Urefwarnr1U reftargetr2Xweb_getting_startedr3U refdomainr4Xstdr5h+]r6h)]r7U refexplicitr8h%]r9h']r:h-]r;Urefdocr<U web/basicsr=uh/Kh]r>h)r?}r@(hj,h#}rA(h%]rBh']rC(UxrefrDj5Xstd-refrEeh)]rFh+]rGh-]rHuhj*h]rIh>Xweb_getting_startedrJrK}rL(hUhj?ubah!jubaubh>X:. The process of handling an HTTP request starts with the rMrN}rO(hX:. The process of handling an HTTP request starts with the rPhjubj))rQ}rR(hX(:class:`~circuits.net.sockets.TCPServer`rShjhhh!j-h#}rT(UreftyperUXclassrVj1j2Xcircuits.net.sockets.TCPServerrWU refdomainrXXpyrYh+]rZh)]r[U refexplicitr\h%]r]h']r^h-]r_j<j=Upy:classr`NU py:moduleraNuh/Kh]rbcdocutils.nodes literal rc)rd}re(hjSh#}rf(h%]rgh']rh(jDjYXpy-classrieh)]rjh+]rkh-]rluhjQh]rmh>X TCPServerrnro}rp(hUhjdubah!Uliteralrqubaubh>X7 receiving a chunk of bytes. It emits those bytes as a rrrs}rt(hX7 receiving a chunk of bytes. It emits those bytes as a ruhjubj))rv}rw(hX#:class:`~circuits.net.sockets.Read`rxhjhhh!j-h#}ry(UreftyperzXclassr{j1j2Xcircuits.net.sockets.Readr|U refdomainr}Xpyr~h+]rh)]rU refexplicitrh%]rh']rh-]rj<j=j`NjaNuh/Kh]rjc)r}r(hjxh#}r(h%]rh']r(jDj~Xpy-classreh)]rh+]rh-]ruhjvh]rh>XReadrr}r(hUhjubah!jqubaubh>Xi event on the channel shared by the Server, HTTP, TCPServer and Dispatcher components ("web" by default).rr}r(hXi event on the channel shared by the Server, HTTP, TCPServer and Dispatcher components ("web" by default).rhjubeubhB)r}r(hXPThe Read events are handled by the :class:`~circuits.web.http.HTTP` component. It collects the chunks until a complete HTTP request has been received. The request is then emitted as a :class:`~circuits.web.events.Request` event with an instance of classes :class:`~circuits.web.wrappers.Request` and :class:`~circuits.web.wrappers.Response` each as arguments. To complete the client's request, a :class:`~circuits.web.events.Response` event must be fired. This is usually done by the HTTP component itself upon the receipt of a ``RequestSuccess`` event (automatically generated after all handlers for the ``Request`` event have been invoked successfully). In case of a problem, the ``Request`` event's handlers should fire or return a :class:`~circuits.web.errors.HTTPError` which is instead converted by the HTTP component to a ``Response`` event.rhjhhh!hFh#}r(h%]rh']rh)]rh+]rh-]ruh/Kh0hh]r(h>X#The Read events are handled by the rr}r(hX#The Read events are handled by the rhjubj))r}r(hX :class:`~circuits.web.http.HTTP`rhjhhh!j-h#}r(UreftyperXclassrj1j2Xcircuits.web.http.HTTPrU refdomainrXpyrh+]rh)]rU refexplicitrh%]rh']rh-]rj<j=j`NjaNuh/Kh]rjc)r}r(hjh#}r(h%]rh']r(jDjXpy-classreh)]rh+]rh-]ruhjh]rh>XHTTPrr}r(hUhjubah!jqubaubh>Xu component. It collects the chunks until a complete HTTP request has been received. The request is then emitted as a rr}r(hXu component. It collects the chunks until a complete HTTP request has been received. The request is then emitted as a rhjubj))r}r(hX%:class:`~circuits.web.events.Request`rhjhhh!j-h#}r(UreftyperXclassrj1j2Xcircuits.web.events.RequestrU refdomainrXpyrh+]rh)]rU refexplicitrh%]rh']rh-]rj<j=j`NjaNuh/Kh]rjc)r}r(hjh#}r(h%]rh']r(jDjXpy-classreh)]rh+]rh-]ruhjh]rh>XRequestrr}r(hUhjubah!jqubaubh>X# event with an instance of classes rr}r(hX# event with an instance of classes rhjubj))r}r(hX':class:`~circuits.web.wrappers.Request`rhjhhh!j-h#}r(UreftyperXclassrj1j2Xcircuits.web.wrappers.RequestrU refdomainrXpyrh+]rh)]rU refexplicitrh%]rh']rh-]rj<j=j`NjaNuh/Kh]rjc)r}r(hjh#}r(h%]rh']r(jDjXpy-classreh)]rh+]rh-]ruhjh]rh>XRequestrr}r(hUhjubah!jqubaubh>X and rr}r(hX and rhjubj))r}r (hX(:class:`~circuits.web.wrappers.Response`r hjhhh!j-h#}r (Ureftyper Xclassr j1j2Xcircuits.web.wrappers.ResponserU refdomainrXpyrh+]rh)]rU refexplicitrh%]rh']rh-]rj<j=j`NjaNuh/Kh]rjc)r}r(hj h#}r(h%]rh']r(jDjXpy-classreh)]rh+]rh-]r uhjh]r!h>XResponser"r#}r$(hUhjubah!jqubaubh>X8 each as arguments. To complete the client's request, a r%r&}r'(hX8 each as arguments. To complete the client's request, a r(hjubj))r)}r*(hX&:class:`~circuits.web.events.Response`r+hjhhh!j-h#}r,(Ureftyper-Xclassr.j1j2Xcircuits.web.events.Responser/U refdomainr0Xpyr1h+]r2h)]r3U refexplicitr4h%]r5h']r6h-]r7j<j=j`NjaNuh/Kh]r8jc)r9}r:(hj+h#}r;(h%]r<h']r=(jDj1Xpy-classr>eh)]r?h+]r@h-]rAuhj)h]rBh>XResponserCrD}rE(hUhj9ubah!jqubaubh>X^ event must be fired. This is usually done by the HTTP component itself upon the receipt of a rFrG}rH(hX^ event must be fired. This is usually done by the HTTP component itself upon the receipt of a rIhjubjc)rJ}rK(hX``RequestSuccess``rLh#}rM(h%]rNh']rOh)]rPh+]rQh-]rRuhjh]rSh>XRequestSuccessrTrU}rV(hUhjJubah!jqubh>X; event (automatically generated after all handlers for the rWrX}rY(hX; event (automatically generated after all handlers for the rZhjubjc)r[}r\(hX ``Request``r]h#}r^(h%]r_h']r`h)]rah+]rbh-]rcuhjh]rdh>XRequestrerf}rg(hUhj[ubah!jqubh>XB event have been invoked successfully). In case of a problem, the rhri}rj(hXB event have been invoked successfully). In case of a problem, the rkhjubjc)rl}rm(hX ``Request``rnh#}ro(h%]rph']rqh)]rrh+]rsh-]rtuhjh]ruh>XRequestrvrw}rx(hUhjlubah!jqubh>X* event's handlers should fire or return a ryrz}r{(hX* event's handlers should fire or return a r|hjubj))r}}r~(hX':class:`~circuits.web.errors.HTTPError`rhjhhh!j-h#}r(UreftyperXclassrj1j2Xcircuits.web.errors.HTTPErrorrU refdomainrXpyrh+]rh)]rU refexplicitrh%]rh']rh-]rj<j=j`NjaNuh/Kh]rjc)r}r(hjh#}r(h%]rh']r(jDjXpy-classreh)]rh+]rh-]ruhj}h]rh>X HTTPErrorrr}r(hUhjubah!jqubaubh>X7 which is instead converted by the HTTP component to a rr}r(hX7 which is instead converted by the HTTP component to a rhjubjc)r}r(hX ``Response``rh#}r(h%]rh']rh)]rh+]rh-]ruhjh]rh>XResponserr}r(hUhjubah!jqubh>X event.rr}r(hX event.rhjubeubhB)r}r(hXwHTTP's handler for the :class:`~circuits.web.events.Response` event retrieves the response information from the event and encodes it as required by HTTP (the protocol). It then fires one or more :class:`~circuits.net.sockets.Write` events which are handled by the TCPServer (and the response is thus sent to the client). More details can be found in :ref:`circuits_web_http`.rhjhhh!hFh#}r(h%]rh']rh)]rh+]rh-]ruh/K*h0hh]r(h>XHTTP's handler for the rr}r(hXHTTP's handler for the rhjubj))r}r(hX&:class:`~circuits.web.events.Response`rhjhhh!j-h#}r(UreftyperXclassrj1j2Xcircuits.web.events.ResponserU refdomainrXpyrh+]rh)]rU refexplicitrh%]rh']rh-]rj<j=j`NjaNuh/K*h]rjc)r}r(hjh#}r(h%]rh']r(jDjXpy-classreh)]rh+]rh-]ruhjh]rh>XResponserr}r(hUhjubah!jqubaubh>X event retrieves the response information from the event and encodes it as required by HTTP (the protocol). It then fires one or more rr}r(hX event retrieves the response information from the event and encodes it as required by HTTP (the protocol). It then fires one or more rhjubj))r}r(hX$:class:`~circuits.net.sockets.Write`rhjhhh!j-h#}r(UreftyperXclassrj1j2Xcircuits.net.sockets.WriterU refdomainrXpyrh+]rh)]rU refexplicitrh%]rh']rh-]rj<j=j`NjaNuh/K*h]rjc)r}r(hjh#}r(h%]rh']r(jDjXpy-classreh)]rh+]rh-]ruhjh]rh>XWriterr}r(hUhjubah!jqubaubh>Xw events which are handled by the TCPServer (and the response is thus sent to the client). More details can be found in rr}r(hXw events which are handled by the TCPServer (and the response is thus sent to the client). More details can be found in rhjubj))r}r(hX:ref:`circuits_web_http`rhjhhh!j-h#}r(UreftyperXrefrj1j2Xcircuits_web_httprU refdomainrXstdrh+]rh)]r U refexplicitr h%]r h']r h-]r j<j=uh/K*h]rh)r}r(hjh#}r(h%]rh']r(jDjXstd-refreh)]rh+]rh-]ruhjh]rh>Xcircuits_web_httprr}r(hUhjubah!jubaubh>X.r}r(hX.hjubeubhB)r}r(hXvA commonly used component for handling :class:`~circuits.web.events.Request` events is a dispatcher. [To be continued]r hjhhh!hFh#}r!(h%]r"h']r#h)]r$h+]r%h-]r&uh/K1h0hh]r'(h>X'A commonly used component for handling r(r)}r*(hX'A commonly used component for handling r+hjubj))r,}r-(hX%:class:`~circuits.web.events.Request`r.hjhhh!j-h#}r/(Ureftyper0Xclassr1j1j2Xcircuits.web.events.Requestr2U refdomainr3Xpyr4h+]r5h)]r6U refexplicitr7h%]r8h']r9h-]r:j<j=j`NjaNuh/K1h]r;jc)r<}r=(hj.h#}r>(h%]r?h']r@(jDj4Xpy-classrAeh)]rBh+]rCh-]rDuhj,h]rEh>XRequestrFrG}rH(hUhj<ubah!jqubaubh>X* events is a dispatcher. [To be continued]rIrJ}rK(hX* events is a dispatcher. [To be continued]rLhjubeubeubeubahUU transformerrMNU footnote_refsrN}rOUrefnamesrP}rQUsymbol_footnotesrR]rSUautofootnote_refsrT]rUUsymbol_footnote_refsrV]rWU citationsrX]rYh0hU current_linerZNUtransform_messagesr[]r\Ureporterr]NUid_startr^KU autofootnotesr_]r`U citation_refsra}rbUindirect_targetsrc]rdUsettingsre(cdocutils.frontend Values rforg}rh(Ufootnote_backlinksriKUrecord_dependenciesrjNU rfc_base_urlrkUhttp://tools.ietf.org/html/rlU tracebackrmUpep_referencesrnNUstrip_commentsroNU toc_backlinksrpUentryrqU language_coderrUenrsU datestamprtNU report_levelruKU _destinationrvNU halt_levelrwKU strip_classesrxNh6NUerror_encoding_error_handlerryUbackslashreplacerzUdebugr{NUembed_stylesheetr|Uoutput_encoding_error_handlerr}Ustrictr~U sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerU7/home/prologic/work/circuits/docs/source/web/basics.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrj~Uauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hjhhhhyuUsubstitution_namesr}rh!h0h#}r(h%]rh+]rh)]rUsourcerhh']rh-]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/web/index.doctree0000644000014400001440000000566112113366672022201 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qXthe circuits.web frameworkqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhUthe-circuits-web-frameworkqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX6/home/prologic/work/circuits/docs/source/web/index.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q(haUnamesq)]q*hauUlineq+KUdocumentq,hh]q-(cdocutils.nodes title q.)q/}q0(hXThe circuits.web Frameworkq1hhhhhUtitleq2h}q3(h!]q4h#]q5h%]q6h']q7h)]q8uh+Kh,hh]q9cdocutils.nodes Text q:XThe circuits.web Frameworkq;q<}q=(hh1hh/ubaubcdocutils.nodes compound q>)q?}q@(hUhhhhhUcompoundqAh}qB(h!]qCh#]qDUtoctree-wrapperqEah%]qFh']qGh)]qHuh+Nh,hh]qIcsphinx.addnodes toctree qJ)qK}qL(hUhh?hhhUtoctreeqMh}qN(UnumberedqOKhU web/indexqPU titlesonlyqQUglobqRh']qSh%]qTh!]qUh#]qVh)]qWUentriesqX]qY(NXweb/introductionqZq[NXweb/gettingstartedq\q]NX web/basicsq^q_eUhiddenq`U includefilesqa]qb(hZh\h^eUmaxdepthqcKuh+Kh]qdubaubeubahUU transformerqeNU footnote_refsqf}qgUrefnamesqh}qiUsymbol_footnotesqj]qkUautofootnote_refsql]qmUsymbol_footnote_refsqn]qoU citationsqp]qqh,hU current_lineqrNUtransform_messagesqs]qtUreporterquNUid_startqvKU autofootnotesqw]qxU citation_refsqy}qzUindirect_targetsq{]q|Usettingsq}(cdocutils.frontend Values q~oq}q(Ufootnote_backlinksqKUrecord_dependenciesqNU rfc_base_urlqUhttp://tools.ietf.org/html/qU tracebackqUpep_referencesqNUstrip_commentsqNU toc_backlinksqUentryqU language_codeqUenqU datestampqNU report_levelqKU _destinationqNU halt_levelqKU strip_classesqNh2NUerror_encoding_error_handlerqUbackslashreplaceqUdebugqNUembed_stylesheetqUoutput_encoding_error_handlerqUstrictqU sectnum_xformqKUdump_transformsqNU docinfo_xformqKUwarning_streamqNUpep_file_url_templateqUpep-%04dqUexit_status_levelqKUconfigqNUstrict_visitorqNUcloak_email_addressesqUtrim_footnote_reference_spaceqUenvqNUdump_pseudo_xmlqNUexpose_internalsqNUsectsubtitle_xformqU source_linkqNUrfc_referencesqNUoutput_encodingqUutf-8qU source_urlqNUinput_encodingqU utf-8-sigqU_disable_configqNU id_prefixqUU tab_widthqKUerror_encodingqU ISO-8859-1qU_sourceqU6/home/prologic/work/circuits/docs/source/web/index.rstqUgettext_compactqU generatorqNUdump_internalsqNU smart_quotesqU pep_base_urlqUhttp://www.python.org/dev/peps/qUsyntax_highlightqUlongqUinput_encoding_error_handlerqhUauto_id_prefixqUidqUdoctitle_xformqUstrip_elements_with_classesqNU _config_filesq]qUfile_insertion_enabledqKU raw_enabledqKU dump_settingsqNubUsymbol_footnote_startqKUidsq}qhhsUsubstitution_namesq}qhh,h}q(h!]qh']qh%]qUsourceqhh#]qh)]quU footnotesq]qUrefidsq}qub.circuits-2.1.0/docs/build/doctrees/web/gettingstarted.doctree0000644000014400001440000002077412113366672024124 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(Xgetting startedqNXweb_getting_startedquUsubstitution_defsq}q Uparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startqKUnameidsq}q(hUgetting-startedqhUweb-getting-startedquUchildrenq]q(cdocutils.nodes target q)q}q(U rawsourceqX.. _web_getting_started:qUparentqhUsourceqcdocutils.nodes reprunicode qX?/home/prologic/work/circuits/docs/source/web/gettingstarted.rstqq}qbUtagnameq Utargetq!U attributesq"}q#(Uidsq$]q%Ubackrefsq&]q'Udupnamesq(]q)Uclassesq*]q+Unamesq,]q-Urefidq.huUlineq/KUdocumentq0hh]q1ubcdocutils.nodes section q2)q3}q4(hUhhhhUexpect_referenced_by_nameq5}q6hhsh Usectionq7h"}q8(h(]q9h*]q:h&]q;h$]q<(hheh,]q=(hheuh/Kh0hUexpect_referenced_by_idq>}q?hhsh]q@(cdocutils.nodes title qA)qB}qC(hXGetting StartedqDhh3hhh UtitleqEh"}qF(h(]qGh*]qHh&]qIh$]qJh,]qKuh/Kh0hh]qLcdocutils.nodes Text qMXGetting StartedqNqO}qP(hhDhhBubaubcdocutils.nodes paragraph qQ)qR}qS(hX<Just like any application or system built with circuits, a circuits.web application follows the standard Component based design and structure whereby functionality is encapsulated in components. circuits.web itself is designed and built in this fashion. For example a circuits.web Server's structure looks like this:qThh3hhh U paragraphqUh"}qV(h(]qWh*]qXh&]qYh$]qZh,]q[uh/Kh0hh]q\hMX<Just like any application or system built with circuits, a circuits.web application follows the standard Component based design and structure whereby functionality is encapsulated in components. circuits.web itself is designed and built in this fashion. For example a circuits.web Server's structure looks like this:q]q^}q_(hhThhRubaubcdocutils.nodes image q`)qa}qb(hX.. image:: ../images/web.png qchh3hhh Uimageqdh"}qe(UuriqfXweb/../images/web.pngqgh$]qhh&]qih(]qjh*]qkU candidatesql}qmU*hgsh,]qnuh/K h0hh]qoubhQ)qp}qq(hXTo illustrate the basic steps, we will demonstrate developing your classical "Hello World!" applications in a web-based way with circuits.webqrhh3hhh hUh"}qs(h(]qth*]quh&]qvh$]qwh,]qxuh/Kh0hh]qyhMXTo illustrate the basic steps, we will demonstrate developing your classical "Hello World!" applications in a web-based way with circuits.webqzq{}q|(hhrhhpubaubhQ)q}}q~(hX9To get started, we first import the necessary components:qhh3hhh hUh"}q(h(]qh*]qh&]qh$]qh,]quh/Kh0hh]qhMX9To get started, we first import the necessary components:qq}q(hhhh}ubaubcdocutils.nodes literal_block q)q}q(hX+from circutis.web import Server, Controllerqhh3hhh U literal_blockqh"}q(UlinenosqUlanguageqXpythonqU xml:spaceqUpreserveqh$]qh&]qh(]qh*]qh,]quh/Kh0hh]qhMX+from circutis.web import Server, Controllerqq}q(hUhhubaubhQ)q}q(hXNext we define our first Controller with a single Request Handler defined as our index. We simply return "Hello World!" as the response for our Request Handler.qhh3hhh hUh"}q(h(]qh*]qh&]qh$]qh,]quh/Kh0hh]qhMXNext we define our first Controller with a single Request Handler defined as our index. We simply return "Hello World!" as the response for our Request Handler.qq}q(hhhhubaubh)q}q(hXHclass Root(Controller): def index(self): return "Hello World!"qhh3hhh hh"}q(hhXpythonqhhh$]qh&]qh(]qh*]qh,]quh/Kh0hh]qhMXHclass Root(Controller): def index(self): return "Hello World!"qq}q(hUhhubaubhQ)q}q(hXiThis completes our simple web application which will respond with "Hello World!" when anyone accesses it.qhh3hhh hUh"}q(h(]qh*]qh&]qh$]qh,]quh/K%h0hh]qhMXiThis completes our simple web application which will respond with "Hello World!" when anyone accesses it.qÅq}q(hhhhubaubhQ)q}q(hXz*Admittedly this is a stupidly simple web application! But circuits.web is very powerful and plays nice with other tools.*qhh3hhh hUh"}q(h(]qh*]qh&]qh$]qh,]quh/K(h0hh]qcdocutils.nodes emphasis q)q}q(hhh"}q(h(]qh*]qh&]qh$]qh,]quhhh]qhMXxAdmittedly this is a stupidly simple web application! But circuits.web is very powerful and plays nice with other tools.qڅq}q(hUhhubah UemphasisqubaubhQ)q}q(hX#Now we need to run the application:qhh3hhh hUh"}q(h(]qh*]qh&]qh$]qh,]quh/K+h0hh]qhMX#Now we need to run the application:q腁q}q(hhhhubaubh)q}q(hX(Server(8000) + Root()).run()qhh3hhh hh"}q(hhXpythonqhhh$]qh&]qh(]qh*]qh,]quh/K-h0hh]qhMX(Server(8000) + Root()).run()qq}q(hUhhubaubhQ)q}q(hXBThat's it! Navigate to: http://127.0.0.1:8000/ and see the result.qhh3hhh hUh"}q(h(]qh*]qh&]qh$]rh,]ruh/K2h0hh]r(hMXThat's it! Navigate to: rr}r(hXThat's it! Navigate to: rhhubcdocutils.nodes reference r)r}r (hXhttp://127.0.0.1:8000/r h"}r (Urefurir Xhttp://127.0.0.1:8000/r h$]rh&]rh(]rh*]rh,]ruhhh]rhMXhttp://127.0.0.1:8000/rr}r(hUhjubah U referencerubhMX and see the result.rr}r(hX and see the result.rhhubeubhQ)r}r(hXHere's the complete code:rhh3hhh hUh"}r(h(]r h*]r!h&]r"h$]r#h,]r$uh/K4h0hh]r%hMXHere's the complete code:r&r'}r((hjhjubaubh)r)}r*(hXfrom circuits.web import Server, Controller class Root(Controller): def index(self): return "Hello World!" (Server(8000) + Root()).run()r+hh3hhh hh"}r,(hhXpythonr-hhh$]r.h&]r/h(]r0h*]r1h,]r2uh/K6h0hh]r3hMXfrom circuits.web import Server, Controller class Root(Controller): def index(self): return "Hello World!" (Server(8000) + Root()).run()r4r5}r6(hUhj)ubaubhQ)r7}r8(hX Have fun!r9hh3hhh hUh"}r:(h(]r;h*]r<h&]r=h$]r>h,]r?uh/KCh0hh]r@hMX Have fun!rArB}rC(hj9hj7ubaubeubehUU transformerrDNU footnote_refsrE}rFUrefnamesrG}rHUsymbol_footnotesrI]rJUautofootnote_refsrK]rLUsymbol_footnote_refsrM]rNU citationsrO]rPh0hU current_linerQNUtransform_messagesrR]rScdocutils.nodes system_message rT)rU}rV(hUh"}rW(h(]rXUlevelrYKh$]rZh&]r[Usourcer\hh*]r]h,]r^Uliner_KUtyper`UINFOrauh]rbhQ)rc}rd(hUh"}re(h(]rfh*]rgh&]rhh$]rih,]rjuhjUh]rkhMX9Hyperlink target "web-getting-started" is not referenced.rlrm}rn(hUhjcubah hUubah Usystem_messageroubaUreporterrpNUid_startrqKU autofootnotesrr]rsU citation_refsrt}ruUindirect_targetsrv]rwUsettingsrx(cdocutils.frontend Values ryorz}r{(Ufootnote_backlinksr|KUrecord_dependenciesr}NU rfc_base_urlr~Uhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNhENUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerU?/home/prologic/work/circuits/docs/source/web/gettingstarted.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hh3hh3uUsubstitution_namesr}rh h0h"}r(h(]rh$]rh&]rUsourcerhh*]rh,]ruU footnotesr]rUrefidsr}rh]rhasub.circuits-2.1.0/docs/build/doctrees/start/0000755000014400001440000000000012113366740020067 5ustar prologicuserscircuits-2.1.0/docs/build/doctrees/start/installing.doctree0000644000014400001440000001502412113366671023607 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X*installing from the development repositoryqNX installingqNX installing from a source packageqNuUsubstitution_defsq }q Uparse_messagesq ]q Ucurrent_sourceq NU decorationqNUautofootnote_startqKUnameidsq}q(hU*installing-from-the-development-repositoryqhU installingqhU installing-from-a-source-packagequUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX=/home/prologic/work/circuits/docs/source/start/installing.rstqq}q bUtagnameq!Usectionq"U attributesq#}q$(Udupnamesq%]q&Uclassesq']q(Ubackrefsq)]q*Uidsq+]q,haUnamesq-]q.hauUlineq/KUdocumentq0hh]q1(cdocutils.nodes title q2)q3}q4(hX Installingq5hhhhh!Utitleq6h#}q7(h%]q8h']q9h)]q:h+]q;h-]qX Installingq?q@}qA(hh5hh3ubaubh)qB}qC(hUhhhhh!h"h#}qD(h%]qEh']qFh)]qGh+]qHhah-]qIhauh/Kh0hh]qJ(h2)qK}qL(hX Installing from a Source PackageqMhhBhhh!h6h#}qN(h%]qOh']qPh)]qQh+]qRh-]qSuh/Kh0hh]qTh>X Installing from a Source PackageqUqV}qW(hhMhhKubaubcdocutils.nodes paragraph qX)qY}qZ(hX?*If you have downloaded a source archive, this applies to you.*q[hhBhhh!U paragraphq\h#}q](h%]q^h']q_h)]q`h+]qah-]qbuh/Kh0hh]qccdocutils.nodes emphasis qd)qe}qf(hh[h#}qg(h%]qhh']qih)]qjh+]qkh-]qluhhYh]qmh>X=If you have downloaded a source archive, this applies to you.qnqo}qp(hUhheubah!Uemphasisqqubaubcdocutils.nodes literal_block qr)qs}qt(hX$ python setup.py installquhhBhhh!U literal_blockqvh#}qw(UlinenosqxUlanguageqyXshqzU xml:spaceq{Upreserveq|h+]q}h)]q~h%]qh']qh-]quh/K h0hh]qh>X$ python setup.py installqq}q(hUhhsubaubhX)q}q(hX#For other installation options see:qhhBhhh!h\h#}q(h%]qh']qh)]qh+]qh-]quh/Kh0hh]qh>X#For other installation options see:qq}q(hhhhubaubhr)q}q(hX $ python setup.py --help installqhhBhhh!hvh#}q(hxhyXshqh{h|h+]qh)]qh%]qh']qh-]quh/Kh0hh]qh>X $ python setup.py --help installqq}q(hUhhubaubeubh)q}q(hUhhhhh!h"h#}q(h%]qh']qh)]qh+]qhah-]qhauh/Kh0hh]q(h2)q}q(hX*Installing from the Development Repositoryqhhhhh!h6h#}q(h%]qh']qh)]qh+]qh-]quh/Kh0hh]qh>X*Installing from the Development Repositoryqq}q(hhhhubaubhX)q}q(hXE*If you have cloned the source code repository, this applies to you.*qhhhhh!h\h#}q(h%]qh']qh)]qh+]qh-]quh/Kh0hh]qhd)q}q(hhh#}q(h%]qh']qh)]qh+]qh-]quhhh]qh>XCIf you have cloned the source code repository, this applies to you.qʅq}q(hUhhubah!hqubaubhX)q}q(hXwIf you have cloned the development repository, it is recommended that you use setuptools and use the following command:qhhhhh!h\h#}q(h%]qh']qh)]qh+]qh-]quh/Kh0hh]qh>XwIf you have cloned the development repository, it is recommended that you use setuptools and use the following command:qׅq}q(hhhhubaubhr)q}q(hX$ python setup.py developqhhhhh!hvh#}q(hxhyXshqh{h|h+]qh)]qh%]qh']qh-]quh/Kh0hh]qh>X$ python setup.py developq允q}q(hUhhubaubhX)q}q(hXThis will allow you to regularly update your copy of the circuits development repository by simply performing the following in the circuits working directory:qhhhhh!h\h#}q(h%]qh']qh)]qh+]qh-]quh/K!h0hh]qh>XThis will allow you to regularly update your copy of the circuits development repository by simply performing the following in the circuits working directory:qq}q(hhhhubaubhr)q}q(hX $ hg pull -uqhhhhh!hvh#}q(hxhyXshqh{h|h+]qh)]qh%]qh']qh-]quh/K$h0hh]qh>X $ hg pull -urr}r(hUhhubaubcdocutils.nodes note r)r}r(hXYou do not need to reinstall if you have installed with setuptools via the circuits repository and used setuptools to install in "develop" mode.rhhhhh!Unoterh#}r(h%]r h']r h)]r h+]r h-]r uh/Nh0hh]rhX)r}r(hXYou do not need to reinstall if you have installed with setuptools via the circuits repository and used setuptools to install in "develop" mode.rhjhhh!h\h#}r(h%]rh']rh)]rh+]rh-]ruh/K)h]rh>XYou do not need to reinstall if you have installed with setuptools via the circuits repository and used setuptools to install in "develop" mode.rr}r(hjhjubaubaubeubeubahUU transformerrNU footnote_refsr}rUrefnamesr}r Usymbol_footnotesr!]r"Uautofootnote_refsr#]r$Usymbol_footnote_refsr%]r&U citationsr']r(h0hU current_liner)NUtransform_messagesr*]r+Ureporterr,NUid_startr-KU autofootnotesr.]r/U citation_refsr0}r1Uindirect_targetsr2]r3Usettingsr4(cdocutils.frontend Values r5or6}r7(Ufootnote_backlinksr8KUrecord_dependenciesr9NU rfc_base_urlr:Uhttp://tools.ietf.org/html/r;U tracebackr<Upep_referencesr=NUstrip_commentsr>NU toc_backlinksr?Uentryr@U language_coderAUenrBU datestamprCNU report_levelrDKU _destinationrENU halt_levelrFKU strip_classesrGNh6NUerror_encoding_error_handlerrHUbackslashreplacerIUdebugrJNUembed_stylesheetrKUoutput_encoding_error_handlerrLUstrictrMU sectnum_xformrNKUdump_transformsrONU docinfo_xformrPKUwarning_streamrQNUpep_file_url_templaterRUpep-%04drSUexit_status_levelrTKUconfigrUNUstrict_visitorrVNUcloak_email_addressesrWUtrim_footnote_reference_spacerXUenvrYNUdump_pseudo_xmlrZNUexpose_internalsr[NUsectsubtitle_xformr\U source_linkr]NUrfc_referencesr^NUoutput_encodingr_Uutf-8r`U source_urlraNUinput_encodingrbU utf-8-sigrcU_disable_configrdNU id_prefixreUU tab_widthrfKUerror_encodingrgU ISO-8859-1rhU_sourceriU=/home/prologic/work/circuits/docs/source/start/installing.rstrjUgettext_compactrkU generatorrlNUdump_internalsrmNU smart_quotesrnU pep_base_urlroUhttp://www.python.org/dev/peps/rpUsyntax_highlightrqUlongrrUinput_encoding_error_handlerrsjMUauto_id_prefixrtUidruUdoctitle_xformrvUstrip_elements_with_classesrwNU _config_filesrx]ryUfile_insertion_enabledrzKU raw_enabledr{KU dump_settingsr|NubUsymbol_footnote_startr}KUidsr~}r(hhhhhhBuUsubstitution_namesr}rh!h0h#}r(h%]rh+]rh)]rUsourcerhh']rh-]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/start/downloading.doctree0000644000014400001440000001545412113366671023757 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(Xlatest development source codeqNX downloadingqNXlatest stable releaseqNX mercurialq X downloadsq Xmercurial bookq uUsubstitution_defsq }q Uparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hUlatest-development-source-codeqhU downloadingqhUlatest-stable-releaseqh U mercurialqh U downloadsqh Umercurial-bookquUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceq UUparentq!hUsourceq"cdocutils.nodes reprunicode q#X>/home/prologic/work/circuits/docs/source/start/downloading.rstq$q%}q&bUtagnameq'Usectionq(U attributesq)}q*(Udupnamesq+]q,Uclassesq-]q.Ubackrefsq/]q0Uidsq1]q2haUnamesq3]q4hauUlineq5KUdocumentq6hh]q7(cdocutils.nodes title q8)q9}q:(h X Downloadingq;h!hh"h%h'Utitleqh-]q?h/]q@h1]qAh3]qBuh5Kh6hh]qCcdocutils.nodes Text qDX DownloadingqEqF}qG(h h;h!h9ubaubh)qH}qI(h Uh!hh"h%h'h(h)}qJ(h+]qKh-]qLh/]qMh1]qNhah3]qOhauh5Kh6hh]qP(h8)qQ}qR(h XLatest Stable ReleaseqSh!hHh"h%h'h`_ page (*specifically the Tags tab*).qah!hHh"h%h'U paragraphqbh)}qc(h+]qdh-]qeh/]qfh1]qgh3]qhuh5Kh6hh]qi(hDX6The latest stable releases can be downloaded from the qjqk}ql(h X6The latest stable releases can be downloaded from the qmh!h_ubcdocutils.nodes reference qn)qo}qp(h X@`Downloads `_qqh)}qr(UnameqsX DownloadsqtUrefuriquX1http://bitbucket.org/prologic/circuits/downloads/qvh1]qwh/]qxh+]qyh-]qzh3]q{uh!h_h]q|hDX Downloadsq}q~}q(h Uh!houbah'U referencequbcdocutils.nodes target q)q}q(h X4 qU referencedqKh!h_h'Utargetqh)}q(Urefuriqhvh1]qhah/]qh+]qh-]qh3]qh auh]qubhDX page (qq}q(h X page (qh!h_ubcdocutils.nodes emphasis q)q}q(h X*specifically the Tags tab*qh)}q(h+]qh-]qh/]qh1]qh3]quh!h_h]qhDXspecifically the Tags tabqq}q(h Uh!hubah'UemphasisqubhDX).qq}q(h X).qh!h_ubeubeubh)q}q(h Uh!hh"h%h'h(h)}q(h+]qh-]qh/]qh1]qhah3]qhauh5Kh6hh]q(h8)q}q(h XLatest Development Source Codeqh!hh"h%h'h`_ for source control and code sharing.qh!hh"h%h'hbh)}q(h+]qh-]qh/]qh1]qh3]quh5Kh6hh]q(hDXWe use qƅq}q(h XWe use qh!hubhn)q}q(h X,`Mercurial `_qh)}q(UnameqX MercurialqhuXhttp://mercurial.selenic.com/qh1]qh/]qh+]qh-]qh3]quh!hh]qhDX Mercurialqׅq}q(h Uh!hubah'hubh)q}q(h X qhKh!hh'hh)}q(Urefuriqhh1]qhah/]qh+]qh-]qh3]qh auh]qubhDX% for source control and code sharing.q允q}q(h X% for source control and code sharing.qh!hubeubh^)q}q(h XHThe latest development branch can be cloned using the following command:qh!hh"h%h'hbh)}q(h+]qh-]qh/]qh1]qh3]quh5Kh6hh]qhDXHThe latest development branch can be cloned using the following command:qq}q(h hh!hubaubcdocutils.nodes literal_block q)q}q(h X3$ hg clone https://bitbucket.org/prologic/circuits/qh!hh"h%h'U literal_blockqh)}q(UlinenosqUlanguageqXshqU xml:spaceqUpreserverh1]rh/]rh+]rh-]rh3]ruh5Kh6hh]rhDX3$ hg clone https://bitbucket.org/prologic/circuits/rr}r (h Uh!hubaubh^)r }r (h XFor further instructions on how to use Mercurial, please refer to the `Mercurial Book `_.r h!hh"h%h'hbh)}r (h+]rh-]rh/]rh1]rh3]ruh5Kh6hh]r(hDXFFor further instructions on how to use Mercurial, please refer to the rr}r(h XFFor further instructions on how to use Mercurial, please refer to the rh!j ubhn)r}r(h XC`Mercurial Book `_rh)}r(UnamerXMercurial BookrhuX/http://mercurial.selenic.com/wiki/MercurialBookrh1]rh/]r h+]r!h-]r"h3]r#uh!j h]r$hDXMercurial Bookr%r&}r'(h Uh!jubah'hubh)r(}r)(h X2 r*hKh!j h'hh)}r+(Urefurir,jh1]r-hah/]r.h+]r/h-]r0h3]r1h auh]r2ubhDX.r3}r4(h X.h!j ubeubeubeubah UU transformerr5NU footnote_refsr6}r7Urefnamesr8}r9Usymbol_footnotesr:]r;Uautofootnote_refsr<]r=Usymbol_footnote_refsr>]r?U citationsr@]rAh6hU current_linerBNUtransform_messagesrC]rDUreporterrENUid_startrFKU autofootnotesrG]rHU citation_refsrI}rJUindirect_targetsrK]rLUsettingsrM(cdocutils.frontend Values rNorO}rP(Ufootnote_backlinksrQKUrecord_dependenciesrRNU rfc_base_urlrSUhttp://tools.ietf.org/html/rTU tracebackrUUpep_referencesrVNUstrip_commentsrWNU toc_backlinksrXUentryrYU language_coderZUenr[U datestampr\NU report_levelr]KU _destinationr^NU halt_levelr_KU strip_classesr`Nh/home/prologic/work/circuits/docs/source/start/downloading.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjfUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hhhj(hhhhhhHhhuUsubstitution_namesr}rh'h6h)}r(h+]rh1]rh/]rUsourcerh%h-]rh3]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/start/requirements.doctree0000644000014400001440000002347312113366671024175 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X pyinotifyqXpydotqXrequirements and dependenciesqNXother optional dependenciesq NXpython standard libraryq uUsubstitution_defsq }q Uparse_messagesq ]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU pyinotifyqhUpydotqhUrequirements-and-dependenciesqh Uother-optional-dependenciesqh Upython-standard-libraryquUchildrenq]q(cdocutils.nodes target q)q}q(U rawsourceqX<.. _Python Standard Library: http://docs.python.org/library/qU referencedq KUparentq!hUsourceq"cdocutils.nodes reprunicode q#X?/home/prologic/work/circuits/docs/source/start/requirements.rstq$q%}q&bUtagnameq'Utargetq(U attributesq)}q*(Urefuriq+Xhttp://docs.python.org/library/q,Uidsq-]q.haUbackrefsq/]q0Udupnamesq1]q2Uclassesq3]q4Unamesq5]q6h auUlineq7KUdocumentq8hh]q9ubcdocutils.nodes section q:)q;}q<(hUh!hh"h%h'Usectionq=h)}q>(h1]q?h3]q@h/]qAh-]qBhah5]qChauh7Kh8hh]qD(cdocutils.nodes title qE)qF}qG(hXRequirements and DependenciesqHh!h;h"h%h'UtitleqIh)}qJ(h1]qKh3]qLh/]qMh-]qNh5]qOuh7Kh8hh]qPcdocutils.nodes Text qQXRequirements and DependenciesqRqS}qT(hhHh!hFubaubcdocutils.nodes bullet_list qU)qV}qW(hUh!h;h"h%h'U bullet_listqXh)}qY(UbulletqZX-h-]q[h/]q\h1]q]h3]q^h5]q_uh7Kh8hh]q`(cdocutils.nodes list_item qa)qb}qc(hXPcircuits has no **required** dependencies beyond the `Python Standard Library`_.qdh!hVh"h%h'U list_itemqeh)}qf(h1]qgh3]qhh/]qih-]qjh5]qkuh7Nh8hh]qlcdocutils.nodes paragraph qm)qn}qo(hhdh!hbh"h%h'U paragraphqph)}qq(h1]qrh3]qsh/]qth-]quh5]qvuh7Kh]qw(hQXcircuits has no qxqy}qz(hXcircuits has no q{h!hnubcdocutils.nodes strong q|)q}}q~(hX **required**qh)}q(h1]qh3]qh/]qh-]qh5]quh!hnh]qhQXrequiredqq}q(hUh!h}ubah'UstrongqubhQX dependencies beyond the qq}q(hX dependencies beyond the qh!hnubcdocutils.nodes reference q)q}q(hX`Python Standard Library`_qUresolvedqKh!hnh'U referenceqh)}q(UnameqXPython Standard Libraryqh+h,h-]qh/]qh1]qh3]qh5]quh]qhQXPython Standard Libraryqq}q(hUh!hubaubhQX.q}q(hX.h!hnubeubaubha)q}q(hXPython: >= 2.6 or pypy >= 2.0 qh!hVh"h%h'heh)}q(h1]qh3]qh/]qh-]qh5]quh7Nh8hh]qhm)q}q(hXPython: >= 2.6 or pypy >= 2.0qh!hh"h%h'hph)}q(h1]qh3]qh/]qh-]qh5]quh7K h]qhQXPython: >= 2.6 or pypy >= 2.0qq}q(hhh!hubaubaubeubcdocutils.nodes field_list q)q}q(hUh!h;h"h%h'U field_listqh)}q(h1]qh3]qh/]qh-]qh5]quh7K h8hh]q(cdocutils.nodes field q)q}q(hUh!hh"h%h'Ufieldqh)}q(h1]qh3]qh/]qh-]qh5]quh7K h8hh]q(cdocutils.nodes field_name q)q}q(hXSupported Platformsqh)}q(h1]qh3]qh/]qh-]qh5]quh!hh]qhQXSupported Platformsqۅq}q(hhh!hubah'U field_namequbcdocutils.nodes field_body q)q}q(hX"Linux, FreeBSD, Mac OS X, Windows qh)}q(h1]qh3]qh/]qh-]qh5]quh!hh]qhm)q}q(hX!Linux, FreeBSD, Mac OS X, Windowsqh!hh"h%h'hph)}q(h1]qh3]qh/]qh-]qh5]quh7K h]qhQX!Linux, FreeBSD, Mac OS X, Windowsqq}q(hhh!hubaubah'U field_bodyqubeubh)q}q(hUh!hh"h%h'hh)}q(h1]qh3]qh/]qh-]qh5]quh7K h8hh]r(h)r}r(hXSupported Python Versionsrh)}r(h1]rh3]rh/]rh-]rh5]r uh!hh]r hQXSupported Python Versionsr r }r (hjh!jubah'hubh)r}r(hX2.6, 2.7, 3.2, 3.3 rh)}r(h1]rh3]rh/]rh-]rh5]ruh!hh]rhm)r}r(hX2.6, 2.7, 3.2, 3.3rh!jh"h%h'hph)}r(h1]rh3]rh/]rh-]rh5]r uh7K h]r!hQX2.6, 2.7, 3.2, 3.3r"r#}r$(hjh!jubaubah'hubeubh)r%}r&(hUh!hh"h%h'hh)}r'(h1]r(h3]r)h/]r*h-]r+h5]r,uh7Kh8hh]r-(h)r.}r/(hXSupported pypy Versionsr0h)}r1(h1]r2h3]r3h/]r4h-]r5h5]r6uh!j%h]r7hQXSupported pypy Versionsr8r9}r:(hj0h!j.ubah'hubh)r;}r<(hX2.0 r=h)}r>(h1]r?h3]r@h/]rAh-]rBh5]rCuh!j%h]rDhm)rE}rF(hX2.0rGh!j;h"h%h'hph)}rH(h1]rIh3]rJh/]rKh-]rLh5]rMuh7Kh]rNhQX2.0rOrP}rQ(hjGh!jEubaubah'hubeubeubh:)rR}rS(hUh!h;h"h%h'h=h)}rT(h1]rUh3]rVh/]rWh-]rXhah5]rYh auh7Kh8hh]rZ(hE)r[}r\(hXOther Optional Dependenciesr]h!jRh"h%h'hIh)}r^(h1]r_h3]r`h/]rah-]rbh5]rcuh7Kh8hh]rdhQXOther Optional Dependenciesrerf}rg(hj]h!j[ubaubhm)rh}ri(hXNThese dependencies are not strictly required and only add additional features.rjh!jRh"h%h'hph)}rk(h1]rlh3]rmh/]rnh-]roh5]rpuh7Kh8hh]rqhQXNThese dependencies are not strictly required and only add additional features.rrrs}rt(hjjh!jhubaubhU)ru}rv(hUh!jRh"h%h'hXh)}rw(hZX-h-]rxh/]ryh1]rzh3]r{h5]r|uh7Kh8hh]r}(ha)r~}r(hXb`pydot `_ -- For rendering component graphs of an application.rh!juh"h%h'heh)}r(h1]rh3]rh/]rh-]rh5]ruh7Nh8hh]rhm)r}r(hXb`pydot `_ -- For rendering component graphs of an application.rh!j~h"h%h'hph)}r(h1]rh3]rh/]rh-]rh5]ruh7Kh]r(h)r}r(hX-`pydot `_rh)}r(UnamerXpydotrh+X"http://pypi.python.org/pypi/pydot/rh-]rh/]rh1]rh3]rh5]ruh!jh]rhQXpydotrr}r(hUh!jubah'hubh)r}r(hX% rh Kh!jh'h(h)}r(Urefurirjh-]rhah/]rh1]rh3]rh5]rhauh]rubhQX5 -- For rendering component graphs of an application.rr}r(hX5 -- For rendering component graphs of an application.rh!jubeubaubha)r}r(hX`pyinotify `_ -- For asynchronous file system event notifications and the :mod:`circuits.io.notify` module.rh!juh"h%h'heh)}r(h1]rh3]rh/]rh-]rh5]ruh7Nh8hh]rhm)r}r(hX`pyinotify `_ -- For asynchronous file system event notifications and the :mod:`circuits.io.notify` module.rh!jh"h%h'hph)}r(h1]rh3]rh/]rh-]rh5]ruh7Kh]r(h)r}r(hX4`pyinotify `_rh)}r(UnamerX pyinotifyrh+X%http://pypi.python.org/pypi/pyinotifyrh-]rh/]rh1]rh3]rh5]ruh!jh]rhQX pyinotifyrr}r(hUh!jubah'hubh)r}r(hX( rh Kh!jh'h(h)}r(Urefurirjh-]rhah/]rh1]rh3]rh5]rhauh]rubhQX= -- For asynchronous file system event notifications and the rr}r(hX= -- For asynchronous file system event notifications and the rh!jubcsphinx.addnodes pending_xref r)r}r(hX:mod:`circuits.io.notify`rh!jh"h%h'U pending_xrefrh)}r(UreftyperXmodrUrefwarnrU reftargetrXcircuits.io.notifyrU refdomainrXpyrh-]rh/]rU refexplicitrh1]rh3]rh5]rUrefdocrUstart/requirementsrUpy:classrNU py:modulerNuh7Kh]rcdocutils.nodes literal r)r}r(hjh)}r(h1]rh3]r(UxrefrjXpy-modreh/]rh-]rh5]ruh!jh]rhQXcircuits.io.notifyrr }r (hUh!jubah'Uliteralr ubaubhQX module.r r }r(hX module.rh!jubeubaubeubeubeubehUU transformerrNU footnote_refsr}rUrefnamesr}rXpython standard libraryr]rhasUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh8hU current_linerNUtransform_messagesr ]r!Ureporterr"NUid_startr#KU autofootnotesr$]r%U citation_refsr&}r'Uindirect_targetsr(]r)Usettingsr*(cdocutils.frontend Values r+or,}r-(Ufootnote_backlinksr.KUrecord_dependenciesr/NU rfc_base_urlr0Uhttp://tools.ietf.org/html/r1U tracebackr2Upep_referencesr3NUstrip_commentsr4NU toc_backlinksr5Uentryr6U language_coder7Uenr8U datestampr9NU report_levelr:KU _destinationr;NU halt_levelr<KU strip_classesr=NhINUerror_encoding_error_handlerr>Ubackslashreplacer?Udebugr@NUembed_stylesheetrAUoutput_encoding_error_handlerrBUstrictrCU sectnum_xformrDKUdump_transformsrENU docinfo_xformrFKUwarning_streamrGNUpep_file_url_templaterHUpep-%04drIUexit_status_levelrJKUconfigrKNUstrict_visitorrLNUcloak_email_addressesrMUtrim_footnote_reference_spacerNUenvrONUdump_pseudo_xmlrPNUexpose_internalsrQNUsectsubtitle_xformrRU source_linkrSNUrfc_referencesrTNUoutput_encodingrUUutf-8rVU source_urlrWNUinput_encodingrXU utf-8-sigrYU_disable_configrZNU id_prefixr[UU tab_widthr\KUerror_encodingr]U ISO-8859-1r^U_sourcer_U?/home/prologic/work/circuits/docs/source/start/requirements.rstr`Ugettext_compactraU generatorrbNUdump_internalsrcNU smart_quotesrdU pep_base_urlreUhttp://www.python.org/dev/peps/rfUsyntax_highlightrgUlongrhUinput_encoding_error_handlerrijCUauto_id_prefixrjUidrkUdoctitle_xformrlUstrip_elements_with_classesrmNU _config_filesrn]roUfile_insertion_enabledrpKU raw_enabledrqKU dump_settingsrrNubUsymbol_footnote_startrsKUidsrt}ru(hjRhhhjhh;hjuUsubstitution_namesrv}rwh'h8h)}rx(h1]ryh-]rzh/]r{Usourcer|h%h3]r}h5]r~uU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/start/quick.doctree0000644000014400001440000001315312113366671022560 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(XpipqXquick start guideqNuUsubstitution_defsq}q Uparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startqKUnameidsq}q(hUpipqhUquick-start-guidequUchildrenq]q(cdocutils.nodes target q)q}q(U rawsourceqX(.. _pip: http://pypi.python.org/pypi/pipqU referencedqKUparentqhUsourceqcdocutils.nodes reprunicode qX8/home/prologic/work/circuits/docs/source/start/quick.rstqq}q bUtagnameq!Utargetq"U attributesq#}q$(Urefuriq%Xhttp://pypi.python.org/pypi/pipq&Uidsq']q(haUbackrefsq)]q*Udupnamesq+]q,Uclassesq-]q.Unamesq/]q0hauUlineq1KUdocumentq2hh]q3ubcdocutils.nodes section q4)q5}q6(hUhhhhh!Usectionq7h#}q8(h+]q9h-]q:h)]q;h']q(cdocutils.nodes title q?)q@}qA(hXQuick Start GuideqBhh5hhh!UtitleqCh#}qD(h+]qEh-]qFh)]qGh']qHh/]qIuh1Kh2hh]qJcdocutils.nodes Text qKXQuick Start GuideqLqM}qN(hhBhh@ubaubcdocutils.nodes paragraph qO)qP}qQ(hXNThe easiest way to download and install circuits is to use the `pip`_ command:qRhh5hhh!U paragraphqSh#}qT(h+]qUh-]qVh)]qWh']qXh/]qYuh1Kh2hh]qZ(hKX?The easiest way to download and install circuits is to use the q[q\}q](hX?The easiest way to download and install circuits is to use the q^hhPubcdocutils.nodes reference q_)q`}qa(hX`pip`_qbUresolvedqcKhhPh!U referenceqdh#}qe(UnameqfXpipqgh%h&h']qhh)]qih+]qjh-]qkh/]qluh]qmhKXpipqnqo}qp(hUhh`ubaubhKX command:qqqr}qs(hX command:qthhPubeubcdocutils.nodes literal_block qu)qv}qw(hX$ pip install circuitsqxhh5hhh!U literal_blockqyh#}qz(Ulinenosq{Ulanguageq|Xshq}U xml:spaceq~Upreserveqh']qh)]qh+]qh-]qh/]quh1K h2hh]qhKX$ pip install circuitsqq}q(hUhhvubaubhO)q}q(hX}Now that you have successfully downloaded and installed circuits, let's test that circuits is properly installed and working.qhh5hhh!hSh#}q(h+]qh-]qh)]qh']qh/]quh1Kh2hh]qhKX}Now that you have successfully downloaded and installed circuits, let's test that circuits is properly installed and working.qq}q(hhhhubaubhO)q}q(hX)First, let's check the installed version:qhh5hhh!hSh#}q(h+]qh-]qh)]qh']qh/]quh1Kh2hh]qhKX)First, let's check the installed version:qq}q(hhhhubaubhu)q}q(hX8>>> import circuits >>> print circuits.__version__ 2.1.0qhh5hhh!hyh#}q(h{h|Xpythonqh~hh']qh)]qh+]qh-]qh/]quh1Kh2hh]qhKX8>>> import circuits >>> print circuits.__version__ 2.1.0qq}q(hUhhubaubhO)q}q(hXTry some of the examples in the examples/ directory shipped with the distribution or check out some :doc:`Applications using circuits <../users>`qhh5hhh!hSh#}q(h+]qh-]qh)]qh']qh/]quh1Kh2hh]q(hKXdTry some of the examples in the examples/ directory shipped with the distribution or check out some qq}q(hXdTry some of the examples in the examples/ directory shipped with the distribution or check out some qhhubcsphinx.addnodes pending_xref q)q}q(hX-:doc:`Applications using circuits <../users>`qhhhhh!U pending_xrefqh#}q(UreftypeqXdocqUrefwarnqLjU reftargetqX../usersqU refdomainqUh']qh)]qU refexplicitq͈h+]qh-]qh/]qUrefdocqU start/quickquh1Kh]qcdocutils.nodes literal q)q}q(hhh#}q(h+]qh-]q(Uxrefqheh)]qh']qh/]quhhh]qhKXApplications using circuitsq߅q}q(hUhhubah!UliteralqubaubeubhO)q}q(hX Have fun :)qhh5hhh!hSh#}q(h+]qh-]qh)]qh']qh/]quh1Kh2hh]qhKX Have fun :)q텁q}q(hhhhubaubeubehUU transformerqNU footnote_refsq}qUrefnamesq}qXpipq]qh`asUsymbol_footnotesq]qUautofootnote_refsq]qUsymbol_footnote_refsq]qU citationsq]qh2hU current_lineqNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]r Usettingsr (cdocutils.frontend Values r or }r (Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNhCNUerror_encoding_error_handlerrUbackslashreplacerUdebugr NUembed_stylesheetr!Uoutput_encoding_error_handlerr"Ustrictr#U sectnum_xformr$KUdump_transformsr%NU docinfo_xformr&KUwarning_streamr'NUpep_file_url_templater(Upep-%04dr)Uexit_status_levelr*KUconfigr+NUstrict_visitorr,NUcloak_email_addressesr-Utrim_footnote_reference_spacer.Uenvr/NUdump_pseudo_xmlr0NUexpose_internalsr1NUsectsubtitle_xformr2U source_linkr3NUrfc_referencesr4NUoutput_encodingr5Uutf-8r6U source_urlr7NUinput_encodingr8U utf-8-sigr9U_disable_configr:NU id_prefixr;UU tab_widthr<KUerror_encodingr=U ISO-8859-1r>U_sourcer?U8/home/prologic/work/circuits/docs/source/start/quick.rstr@Ugettext_compactrAU generatorrBNUdump_internalsrCNU smart_quotesrDU pep_base_urlrEUhttp://www.python.org/dev/peps/rFUsyntax_highlightrGUlongrHUinput_encoding_error_handlerrIj#Uauto_id_prefixrJUidrKUdoctitle_xformrLUstrip_elements_with_classesrMNU _config_filesrN]rOUfile_insertion_enabledrPKU raw_enabledrQKU dump_settingsrRNubUsymbol_footnote_startrSKUidsrT}rU(hhhh5uUsubstitution_namesrV}rWh!h2h#}rX(h+]rYh']rZh)]r[Usourcer\hh-]r]h/]r^uU footnotesr_]r`Urefidsra}rbub.circuits-2.1.0/docs/build/doctrees/start/index.doctree0000644000014400001440000000565212113366671022560 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qXgetting startedqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhUgetting-startedqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX8/home/prologic/work/circuits/docs/source/start/index.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q(haUnamesq)]q*hauUlineq+KUdocumentq,hh]q-(cdocutils.nodes title q.)q/}q0(hXGetting Startedq1hhhhhUtitleq2h}q3(h!]q4h#]q5h%]q6h']q7h)]q8uh+Kh,hh]q9cdocutils.nodes Text q:XGetting Startedq;q<}q=(hh1hh/ubaubcdocutils.nodes compound q>)q?}q@(hUhhhhhUcompoundqAh}qB(h!]qCh#]qDUtoctree-wrapperqEah%]qFh']qGh)]qHuh+Nh,hh]qIcsphinx.addnodes toctree qJ)qK}qL(hUhh?hhhUtoctreeqMh}qN(UnumberedqOKhU start/indexqPU titlesonlyqQUglobqRh']qSh%]qTh!]qUh#]qVh)]qWUentriesqX]qY(NX start/quickqZq[NXstart/downloadingq\q]NXstart/installingq^q_NXstart/requirementsq`qaeUhiddenqbU includefilesqc]qd(hZh\h^h`eUmaxdepthqeKuh+Kh]qfubaubeubahUU transformerqgNU footnote_refsqh}qiUrefnamesqj}qkUsymbol_footnotesql]qmUautofootnote_refsqn]qoUsymbol_footnote_refsqp]qqU citationsqr]qsh,hU current_lineqtNUtransform_messagesqu]qvUreporterqwNUid_startqxKU autofootnotesqy]qzU citation_refsq{}q|Uindirect_targetsq}]q~Usettingsq(cdocutils.frontend Values qoq}q(Ufootnote_backlinksqKUrecord_dependenciesqNU rfc_base_urlqUhttp://tools.ietf.org/html/qU tracebackqUpep_referencesqNUstrip_commentsqNU toc_backlinksqUentryqU language_codeqUenqU datestampqNU report_levelqKU _destinationqNU halt_levelqKU strip_classesqNh2NUerror_encoding_error_handlerqUbackslashreplaceqUdebugqNUembed_stylesheetqUoutput_encoding_error_handlerqUstrictqU sectnum_xformqKUdump_transformsqNU docinfo_xformqKUwarning_streamqNUpep_file_url_templateqUpep-%04dqUexit_status_levelqKUconfigqNUstrict_visitorqNUcloak_email_addressesqUtrim_footnote_reference_spaceqUenvqNUdump_pseudo_xmlqNUexpose_internalsqNUsectsubtitle_xformqU source_linkqNUrfc_referencesqNUoutput_encodingqUutf-8qU source_urlqNUinput_encodingqU utf-8-sigqU_disable_configqNU id_prefixqUU tab_widthqKUerror_encodingqU ISO-8859-1qU_sourceqU8/home/prologic/work/circuits/docs/source/start/index.rstqUgettext_compactqU generatorqNUdump_internalsqNU smart_quotesqU pep_base_urlqUhttp://www.python.org/dev/peps/qUsyntax_highlightqUlongqUinput_encoding_error_handlerqhUauto_id_prefixqUidqUdoctitle_xformqUstrip_elements_with_classesqNU _config_filesq]qUfile_insertion_enabledqKU raw_enabledqKU dump_settingsqNubUsymbol_footnote_startqKUidsq}qhhsUsubstitution_namesq}qhh,h}q(h!]qh']qh%]qUsourceqhh#]qh)]quU footnotesq]qUrefidsq}qub.circuits-2.1.0/docs/build/doctrees/todo.doctree0000644000014400001440000000510712113366671021254 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qXdocumentation todoqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhUdocumentation-todoqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX1/home/prologic/work/circuits/docs/source/todo.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q(haUnamesq)]q*hauUlineq+KUdocumentq,hh]q-(cdocutils.nodes title q.)q/}q0(hXDocumentation TODOq1hhhhhUtitleq2h}q3(h!]q4h#]q5h%]q6h']q7h)]q8uh+Kh,hh]q9cdocutils.nodes Text q:XDocumentation TODOq;q<}q=(hh1hh/ubaubcsphinx.ext.todo todolist q>)q?}q@(hUhhhhhUtodolistqAh}qB(h!]qCh#]qDh%]qEh']qFh)]qGuh+Kh,hh]qHubeubahUU transformerqINU footnote_refsqJ}qKUrefnamesqL}qMUsymbol_footnotesqN]qOUautofootnote_refsqP]qQUsymbol_footnote_refsqR]qSU citationsqT]qUh,hU current_lineqVNUtransform_messagesqW]qXUreporterqYNUid_startqZKU autofootnotesq[]q\U citation_refsq]}q^Uindirect_targetsq_]q`Usettingsqa(cdocutils.frontend Values qboqc}qd(Ufootnote_backlinksqeKUrecord_dependenciesqfNU rfc_base_urlqgUhttp://tools.ietf.org/html/qhU tracebackqiUpep_referencesqjNUstrip_commentsqkNU toc_backlinksqlUentryqmU language_codeqnUenqoU datestampqpNU report_levelqqKU _destinationqrNU halt_levelqsKU strip_classesqtNh2NUerror_encoding_error_handlerquUbackslashreplaceqvUdebugqwNUembed_stylesheetqxUoutput_encoding_error_handlerqyUstrictqzU sectnum_xformq{KUdump_transformsq|NU docinfo_xformq}KUwarning_streamq~NUpep_file_url_templateqUpep-%04dqUexit_status_levelqKUconfigqNUstrict_visitorqNUcloak_email_addressesqUtrim_footnote_reference_spaceqUenvqNUdump_pseudo_xmlqNUexpose_internalsqNUsectsubtitle_xformqU source_linkqNUrfc_referencesqNUoutput_encodingqUutf-8qU source_urlqNUinput_encodingqU utf-8-sigqU_disable_configqNU id_prefixqUU tab_widthqKUerror_encodingqU ISO-8859-1qU_sourceqU1/home/prologic/work/circuits/docs/source/todo.rstqUgettext_compactqU generatorqNUdump_internalsqNU smart_quotesqU pep_base_urlqUhttp://www.python.org/dev/peps/qUsyntax_highlightqUlongqUinput_encoding_error_handlerqhzUauto_id_prefixqUidqUdoctitle_xformqUstrip_elements_with_classesqNU _config_filesq]qUfile_insertion_enabledqKU raw_enabledqKU dump_settingsqNubUsymbol_footnote_startqKUidsq}qhhsUsubstitution_namesq}qhh,h}q(h!]qh']qh%]qUsourceqhh#]qh)]quU footnotesq]qUrefidsq}qub.circuits-2.1.0/docs/build/doctrees/pypitest.doctree0000644000014400001440000010150112113366671022163 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X mit licenseqXfeaturesqNXfreenode irc networkqXoverviewq NX communityq NXfeedbackq NX requirementsq NX*release notes - circuits-2.1.0 ()q NXpython programming languageqXcreate an issueqX mailing listqXsupported platformsqNX@pythoncircuitsqXwebsiteqX read the docsqX"pypi test page - tentative releaseqNXdownloads pageqX installationqNXlicenseqNX#circuits irc channelqX pypi pageqXpython standard libraryquUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceq NU decorationq!NUautofootnote_startq"KUnameidsq#}q$(hU mit-licenseq%hUfeaturesq&hUfreenode-irc-networkq'h Uoverviewq(h U communityq)h Ufeedbackq*h U requirementsq+h U$release-notes-circuits-2-1-0-releaseq,hUpython-programming-languageq-hUcreate-an-issueq.hU mailing-listq/hUsupported-platformsq0hUpythoncircuitsq1hUwebsiteq2hU read-the-docsq3hU pypi-test-page-tentative-releaseq4hUdownloads-pageq5hU installationq6hUlicenseq7hUcircuits-irc-channelq8hU pypi-pageq9hUpython-standard-libraryq:uUchildrenq;]q}q?(U rawsourceq@UUparentqAhUsourceqBcdocutils.nodes reprunicode qCX5/home/prologic/work/circuits/docs/source/pypitest.rstqDqE}qFbUtagnameqGUsectionqHU attributesqI}qJ(UdupnamesqK]qLUclassesqM]qNUbackrefsqO]qPUidsqQ]qRh4aUnamesqS]qThauUlineqUKUdocumentqVhh;]qW(cdocutils.nodes title qX)qY}qZ(h@X"PyPi Test Page - Tentative Releaseq[hAh>hBhEhGUtitleq\hI}q](hK]q^hM]q_hO]q`hQ]qahS]qbuhUKhVhh;]qccdocutils.nodes Text qdX"PyPi Test Page - Tentative Releaseqeqf}qg(h@h[hAhYubaubcdocutils.nodes target qh)qi}qj(h@X7.. _Python Programming Language: http://www.python.org/qkU referencedqlKhAh>hBhCX README.rstqmqn}qobhGUtargetqphI}qq(UrefuriqrXhttp://www.python.org/qshQ]qth-ahO]quhK]qvhM]qwhS]qxhauhUK hVhh;]qyubhh)qz}q{(h@X].. _#circuits IRC Channel: http://webchat.freenode.net/?randomnick=1&channels=circuits&uio=d4q|hlKhAh>hBhnhGhphI}q}(hrXBhttp://webchat.freenode.net/?randomnick=1&channels=circuits&uio=d4q~hQ]qh8ahO]qhK]qhM]qhS]qhauhUK hVhh;]qubhh)q}q(h@X-.. _FreeNode IRC Network: http://freenode.netqhlKhAh>hBhnhGhphI}q(hrXhttp://freenode.netqhQ]qh'ahO]qhK]qhM]qhS]qhauhUK hVhh;]qubhh)q}q(h@X<.. _Python Standard Library: http://docs.python.org/library/qhlKhAh>hBhnhGhphI}q(hrXhttp://docs.python.org/library/qhQ]qh:ahO]qhK]qhM]qhS]qhauhUK hVhh;]qubhh)q}q(h@X5.. _Website: https://bitbucket.org/prologic/circuits/qhlKhAh>hBhnhGhphI}q(hrX(https://bitbucket.org/prologic/circuits/qhQ]qh2ahO]qhK]qhM]qhS]qhauhUK hVhh;]qubhh)q}q(h@X3.. _PyPi Page: http://pypi.python.org/pypi/circuitsqhlKhAh>hBhnhGhphI}q(hrX$http://pypi.python.org/pypi/circuitsqhQ]qh9ahO]qhK]qhM]qhS]qhauhUKhVhh;]qubhh)q}q(h@X3.. _Read the Docs: http://circuits.readthedocs.org/qhlKhAh>hBhnhGhphI}q(hrX http://circuits.readthedocs.org/qhQ]qh3ahO]qhK]qhM]qhS]qhauhUKhVhh;]qubhh)q}q(h@XC.. _MIT License: http://www.opensource.org/licenses/mit-license.phpqhlKhAh>hBhnhGhphI}q(hrX2http://www.opensource.org/licenses/mit-license.phpqhQ]qh%ahO]qhK]qhM]qhS]qhauhUKhVhh;]qubhh)q}q(h@XF.. _Create an Issue: https://bitbucket.org/prologic/circuits/issue/newqhlKhAh>hBhnhGhphI}q(hrX1https://bitbucket.org/prologic/circuits/issue/newqhQ]qh.ahO]qhK]qhM]qhS]qhauhUKhVhh;]qubhh)q}q(h@X?.. _Mailing List: http://groups.google.com/group/circuits-usersqhlKhAh>hBhnhGhphI}q(hrX-http://groups.google.com/group/circuits-usersqhQ]qh/ahO]qhK]qhM]qhS]qhauhUKhVhh;]qubhh)q}q(h@XE.. _Downloads page: https://bitbucket.org/prologic/circuits/downloadsqhlKhAh>hBhnhGhphI}q(hrX1https://bitbucket.org/prologic/circuits/downloadsqhQ]qh5ahO]qhK]qhM]qhS]qhauhUKhVhh;]qubh=)q}q(h@UhAh>hBhnhGhHhI}q(hK]qhM]qhO]qhQ]qh(ahS]qh auhUKhVhh;]q(hX)q}q(h@XOverviewqhAhhBhnhGh\hI}q(hK]qhM]qhO]qhQ]qhS]quhUKhVhh;]qhdXOverviewqq}q(h@hhAhubaubcdocutils.nodes paragraph q)q}r(h@Xcircuits is a **Lightweight** **Event** driven and **Asynchronous** **Application Framework** for the `Python Programming Language`_ with a strong **Component** Architecture.rhAhhBhnhGU paragraphrhI}r(hK]rhM]rhO]rhQ]rhS]ruhUKhVhh;]r (hdXcircuits is a r r }r (h@Xcircuits is a r hAhubcdocutils.nodes strong r)r}r(h@X**Lightweight**rhI}r(hK]rhM]rhO]rhQ]rhS]ruhAhh;]rhdX Lightweightrr}r(h@UhAjubahGUstrongrubhdX r}r(h@X hAhubj)r}r (h@X **Event**r!hI}r"(hK]r#hM]r$hO]r%hQ]r&hS]r'uhAhh;]r(hdXEventr)r*}r+(h@UhAjubahGjubhdX driven and r,r-}r.(h@X driven and r/hAhubj)r0}r1(h@X**Asynchronous**r2hI}r3(hK]r4hM]r5hO]r6hQ]r7hS]r8uhAhh;]r9hdX Asynchronousr:r;}r<(h@UhAj0ubahGjubhdX r=}r>(h@X hAhubj)r?}r@(h@X**Application Framework**rAhI}rB(hK]rChM]rDhO]rEhQ]rFhS]rGuhAhh;]rHhdXApplication FrameworkrIrJ}rK(h@UhAj?ubahGjubhdX for the rLrM}rN(h@X for the rOhAhubcdocutils.nodes reference rP)rQ}rR(h@X`Python Programming Language`_rSUresolvedrTKhAhhGU referencerUhI}rV(UnamerWXPython Programming LanguagerXhrhshQ]rYhO]rZhK]r[hM]r\hS]r]uh;]r^hdXPython Programming Languager_r`}ra(h@UhAjQubaubhdX with a strong rbrc}rd(h@X with a strong rehAhubj)rf}rg(h@X **Component**rhhI}ri(hK]rjhM]rkhO]rlhQ]rmhS]rnuhAhh;]rohdX Componentrprq}rr(h@UhAjfubahGjubhdX Architecture.rsrt}ru(h@X Architecture.rvhAhubeubh)rw}rx(h@Xcircuits also includes a lightweight, high performance and scalable HTTP/WSGI compliant web server as well as various I/O and Networking components.ryhAhhBhnhGjhI}rz(hK]r{hM]r|hO]r}hQ]r~hS]ruhUKhVhh;]rhdXcircuits also includes a lightweight, high performance and scalable HTTP/WSGI compliant web server as well as various I/O and Networking components.rr}r(h@jyhAjwubaubh)r}r(h@XsTo take full advantage of circuits and its architecture, circuits encourages you to design your application in terms of loosely coupled components. Circuits has a very powerful message passing system that enables components to interact with each other via events. Applications written this way tend to be more maintainable, easier to develop and scale to complex systems.rhAhhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUKhVhh;]rhdXsTo take full advantage of circuits and its architecture, circuits encourages you to design your application in terms of loosely coupled components. Circuits has a very powerful message passing system that enables components to interact with each other via events. Applications written this way tend to be more maintainable, easier to develop and scale to complex systems.rr}r(h@jhAjubaubh)r}r(h@X8circuits' **Loosely Coupled** **Component Architecture** allows for a high level of **Reuse** and **Scalability**. Simpler components can be combined together to form Complex Components and provide higher level functionality and abstraction. Much of the circuits component library is designed and built this way.rhAhhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUK hVhh;]r(hdX circuits' rr}r(h@X circuits' rhAjubj)r}r(h@X**Loosely Coupled**rhI}r(hK]rhM]rhO]rhQ]rhS]ruhAjh;]rhdXLoosely Coupledrr}r(h@UhAjubahGjubhdX r}r(h@X hAjubj)r}r(h@X**Component Architecture**rhI}r(hK]rhM]rhO]rhQ]rhS]ruhAjh;]rhdXComponent Architecturerr}r(h@UhAjubahGjubhdX allows for a high level of rr}r(h@X allows for a high level of rhAjubj)r}r(h@X **Reuse**rhI}r(hK]rhM]rhO]rhQ]rhS]ruhAjh;]rhdXReuserr}r(h@UhAjubahGjubhdX and rr}r(h@X and rhAjubj)r}r(h@X**Scalability**rhI}r(hK]rhM]rhO]rhQ]rhS]ruhAjh;]rhdX Scalabilityrr}r(h@UhAjubahGjubhdX. Simpler components can be combined together to form Complex Components and provide higher level functionality and abstraction. Much of the circuits component library is designed and built this way.rr}r(h@X. Simpler components can be combined together to form Complex Components and provide higher level functionality and abstraction. Much of the circuits component library is designed and built this way.rhAjubeubcdocutils.nodes bullet_list r)r}r(h@UhAhhBhnhGU bullet_listrhI}r(UbulletrX-hQ]rhO]rhK]rhM]rhS]ruhUK&hVhh;]r(cdocutils.nodes list_item r)r}r(h@XK**Documentation**: http://packages.python.org/circuits or `Read the Docs`_.rhAjhBhnhGU list_itemrhI}r(hK]rhM]rhO]rhQ]rhS]ruhUNhVhh;]rh)r}r(h@jhAjhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUK&h;]r(j)r}r(h@X**Documentation**rhI}r(hK]rhM]rhO]rhQ]r hS]r uhAjh;]r hdX Documentationr r }r(h@UhAjubahGjubhdX: rr}r(h@X: rhAjubjP)r}r(h@X#http://packages.python.org/circuitsrhI}r(UrefurirX#http://packages.python.org/circuitsrhQ]rhO]rhK]rhM]rhS]ruhAjh;]rhdX#http://packages.python.org/circuitsrr }r!(h@UhAjubahGjUubhdX or r"r#}r$(h@X or r%hAjubjP)r&}r'(h@X`Read the Docs`_r(jTKhAjhGjUhI}r)(Unamer*X Read the Docsr+hrhhQ]r,hO]r-hK]r.hM]r/hS]r0uh;]r1hdX Read the Docsr2r3}r4(h@UhAj&ubaubhdX.r5}r6(h@X.hAjubeubaubj)r7}r8(h@X=**Project website**: https://bitbucket.org/prologic/circuits/r9hAjhBhnhGjhI}r:(hK]r;hM]r<hO]r=hQ]r>hS]r?uhUNhVhh;]r@h)rA}rB(h@j9hAj7hBhnhGjhI}rC(hK]rDhM]rEhO]rFhQ]rGhS]rHuhUK'h;]rI(j)rJ}rK(h@X**Project website**rLhI}rM(hK]rNhM]rOhO]rPhQ]rQhS]rRuhAjAh;]rShdXProject websiterTrU}rV(h@UhAjJubahGjubhdX: rWrX}rY(h@X: rZhAjAubjP)r[}r\(h@X(https://bitbucket.org/prologic/circuits/r]hI}r^(Urefurir_X(https://bitbucket.org/prologic/circuits/r`hQ]rahO]rbhK]rchM]rdhS]reuhAjAh;]rfhdX(https://bitbucket.org/prologic/circuits/rgrh}ri(h@UhAj[ubahGjUubeubaubj)rj}rk(h@X5**PyPI page**: http://pypi.python.org/pypi/circuits rlhAjhBhnhGjhI}rm(hK]rnhM]rohO]rphQ]rqhS]rruhUNhVhh;]rsh)rt}ru(h@X3**PyPI page**: http://pypi.python.org/pypi/circuitsrvhAjjhBhnhGjhI}rw(hK]rxhM]ryhO]rzhQ]r{hS]r|uhUK(h;]r}(j)r~}r(h@X **PyPI page**rhI}r(hK]rhM]rhO]rhQ]rhS]ruhAjth;]rhdX PyPI pagerr}r(h@UhAj~ubahGjubhdX: rr}r(h@X: rhAjtubjP)r}r(h@X$http://pypi.python.org/pypi/circuitsrhI}r(UrefurirX$http://pypi.python.org/pypi/circuitsrhQ]rhO]rhK]rhM]rhS]ruhAjth;]rhdX$http://pypi.python.org/pypi/circuitsrr}r(h@UhAjubahGjUubeubaubeubeubh=)r}r(h@UhAh>hBhnhGhHhI}r(hK]rhM]rhO]rhQ]rh&ahS]rhauhUK,hVhh;]r(hX)r}r(h@XFeaturesrhAjhBhnhGh\hI}r(hK]rhM]rhO]rhQ]rhS]ruhUK,hVhh;]rhdXFeaturesrr}r(h@jhAjubaubj)r}r(h@UhAjhBhnhGjhI}r(jX-hQ]rhO]rhK]rhM]rhS]ruhUK.hVhh;]r(j)r}r(h@X event drivenrhAjhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUNhVhh;]rh)r}r(h@jhAjhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUK.h;]rhdX event drivenrr}r(h@jhAjubaubaubj)r}r(h@Xconcurrency supportrhAjhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUNhVhh;]rh)r}r(h@jhAjhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUK/h;]rhdXconcurrency supportrr}r(h@jhAjubaubaubj)r}r(h@Xcomponent architecturerhAjhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUNhVhh;]rh)r}r(h@jhAjhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUK0h;]rhdXcomponent architecturerr}r(h@jhAjubaubaubj)r}r(h@Xasynchronous I/O componentsrhAjhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUNhVhh;]rh)r }r (h@jhAjhBhnhGjhI}r (hK]r hM]r hO]rhQ]rhS]ruhUK1h;]rhdXasynchronous I/O componentsrr}r(h@jhAj ubaubaubj)r}r(h@X!no required external dependenciesrhAjhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUNhVhh;]rh)r}r (h@jhAjhBhnhGjhI}r!(hK]r"hM]r#hO]r$hQ]r%hS]r&uhUK2h;]r'hdX!no required external dependenciesr(r)}r*(h@jhAjubaubaubj)r+}r,(h@X*full featured web framework (circuits.web)r-hAjhBhnhGjhI}r.(hK]r/hM]r0hO]r1hQ]r2hS]r3uhUNhVhh;]r4h)r5}r6(h@j-hAj+hBhnhGjhI}r7(hK]r8hM]r9hO]r:hQ]r;hS]r<uhUK3h;]r=hdX*full featured web framework (circuits.web)r>r?}r@(h@j-hAj5ubaubaubj)rA}rB(h@X,coroutine based synchronization primitives rChAjhBhnhGjhI}rD(hK]rEhM]rFhO]rGhQ]rHhS]rIuhUNhVhh;]rJh)rK}rL(h@X*coroutine based synchronization primitivesrMhAjAhBhnhGjhI}rN(hK]rOhM]rPhO]rQhQ]rRhS]rSuhUK4h;]rThdX*coroutine based synchronization primitivesrUrV}rW(h@jMhAjKubaubaubeubeubh=)rX}rY(h@UhAh>hBhnhGhHhI}rZ(hK]r[hM]r\hO]r]hQ]r^h+ahS]r_h auhUK8hVhh;]r`(hX)ra}rb(h@X RequirementsrchAjXhBhnhGh\hI}rd(hK]rehM]rfhO]rghQ]rhhS]riuhUK8hVhh;]rjhdX Requirementsrkrl}rm(h@jchAjaubaubj)rn}ro(h@UhAjXhBhnhGjhI}rp(jX-hQ]rqhO]rrhK]rshM]rthS]ruuhUK:hVhh;]rvj)rw}rx(h@XEcircuits has no dependencies beyond the `Python Standard Library`_. ryhAjnhBhnhGjhI}rz(hK]r{hM]r|hO]r}hQ]r~hS]ruhUNhVhh;]rh)r}r(h@XCcircuits has no dependencies beyond the `Python Standard Library`_.rhAjwhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUK:h;]r(hdX(circuits has no dependencies beyond the rr}r(h@X(circuits has no dependencies beyond the rhAjubjP)r}r(h@X`Python Standard Library`_rjTKhAjhGjUhI}r(UnamerXPython Standard LibraryrhrhhQ]rhO]rhK]rhM]rhS]ruh;]rhdXPython Standard Libraryrr}r(h@UhAjubaubhdX.r}r(h@X.hAjubeubaubaubeubh=)r}r(h@UhAh>hBhnhGhHhI}r(hK]rhM]rhO]rhQ]rh0ahS]rhauhUK>hVhh;]r(hX)r}r(h@XSupported PlatformsrhAjhBhnhGh\hI}r(hK]rhM]rhO]rhQ]rhS]ruhUK>hVhh;]rhdXSupported Platformsrr}r(h@jhAjubaubj)r}r(h@UhAjhBhnhGjhI}r(jX-hQ]rhO]rhK]rhM]rhS]ruhUK@hVhh;]r(j)r}r(h@XLinux, FreeBSD, Mac OS XrhAjhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUNhVhh;]rh)r}r(h@jhAjhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUK@h;]rhdXLinux, FreeBSD, Mac OS Xrr}r(h@jhAjubaubaubj)r}r(h@XPython 2.6, 2.7, 3.2, 3.3rhAjhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUNhVhh;]rh)r}r(h@jhAjhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUKAh;]rhdXPython 2.6, 2.7, 3.2, 3.3rr}r(h@jhAjubaubaubj)r}r(h@X pypy 2.0 rhAjhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUNhVhh;]rh)r}r(h@Xpypy 2.0rhAjhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUKBh;]rhdXpypy 2.0rr}r(h@jhAjubaubaubeubcdocutils.nodes definition_list r)r}r(h@UhAjhBhnhGUdefinition_listrhI}r(hK]rhM]rhO]r hQ]r hS]r uhUNhVhh;]r cdocutils.nodes definition_list_item r )r}r(h@X**Windows**: We acknowledge that Windows exists and make reasonable efforts to maintain compatibility. Unfortunately we cannot guarantee support at this time. rhAjhBhnhGUdefinition_list_itemrhI}r(hK]rhM]rhO]rhQ]rhS]ruhUKFh;]r(cdocutils.nodes term r)r}r(h@XK**Windows**: We acknowledge that Windows exists and make reasonable effortsrhAjhBhnhGUtermrhI}r(hK]rhM]r hO]r!hQ]r"hS]r#uhUKFh;]r$(j)r%}r&(h@X **Windows**r'hI}r((hK]r)hM]r*hO]r+hQ]r,hS]r-uhAjh;]r.hdXWindowsr/r0}r1(h@UhAj%ubahGjubhdX@: We acknowledge that Windows exists and make reasonable effortsr2r3}r4(h@X@: We acknowledge that Windows exists and make reasonable effortsr5hAjubeubcdocutils.nodes definition r6)r7}r8(h@UhI}r9(hK]r:hM]r;hO]r<hQ]r=hS]r>uhAjh;]r?h)r@}rA(h@XRto maintain compatibility. Unfortunately we cannot guarantee support at this time.rBhAj7hBhnhGjhI}rC(hK]rDhM]rEhO]rFhQ]rGhS]rHuhUKEh;]rIhdXRto maintain compatibility. Unfortunately we cannot guarantee support at this time.rJrK}rL(h@jBhAj@ubaubahGU definitionrMubeubaubh)rN}rO(h@X8**NB**: We are working toward getting Windows supported.rPhAjhBhnhGjhI}rQ(hK]rRhM]rShO]rThQ]rUhS]rVuhUKHhVhh;]rW(j)rX}rY(h@X**NB**rZhI}r[(hK]r\hM]r]hO]r^hQ]r_hS]r`uhAjNh;]rahdXNBrbrc}rd(h@UhAjXubahGjubhdX2: We are working toward getting Windows supported.rerf}rg(h@X2: We are working toward getting Windows supported.rhhAjNubeubeubh=)ri}rj(h@UhAh>hBhnhGhHhI}rk(hK]rlhM]rmhO]rnhQ]roh6ahS]rphauhUKLhVhh;]rq(hX)rr}rs(h@X InstallationrthAjihBhnhGh\hI}ru(hK]rvhM]rwhO]rxhQ]ryhS]rzuhUKLhVhh;]r{hdX Installationr|r}}r~(h@jthAjrubaubh)r}r(h@XThe simplest and recommended way to install circuits is with pip. You may install the latest stable release from PyPI with pip::rhAjihBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUKNhVhh;]rhdXThe simplest and recommended way to install circuits is with pip. You may install the latest stable release from PyPI with pip:rr}r(h@XThe simplest and recommended way to install circuits is with pip. You may install the latest stable release from PyPI with pip:rhAjubaubcdocutils.nodes literal_block r)r}r(h@X> pip install circuitsrhAjihBhnhGU literal_blockrhI}r(U xml:spacerUpreserverhQ]rhO]rhK]rhM]rhS]ruhUKYhVhh;]rhdX> pip install circuitsrr}r(h@UhAjubaubh)r}r(h@X2If you do not have pip, you may use easy_install::rhAjihBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUKShVhh;]rhdX1If you do not have pip, you may use easy_install:rr}r(h@X1If you do not have pip, you may use easy_install:rhAjubaubj)r}r(h@X> easy_install circuitsrhAjihBhnhGjhI}r(jjhQ]rhO]rhK]rhM]rhS]ruhUK]hVhh;]rhdX> easy_install circuitsrr}r(h@UhAjubaubh)r}r(h@XAlternatively, you may download the source package from the `PyPi Page`_ or the `Downloads page`_ on the `Website`_; extract it and install using::rhAjihBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUKWhVhh;]r(hdX<Alternatively, you may download the source package from the rr}r(h@X<Alternatively, you may download the source package from the rhAjubjP)r}r(h@X `PyPi Page`_rjTKhAjhGjUhI}r(UnamerX PyPi PagerhrhhQ]rhO]rhK]rhM]rhS]ruh;]rhdX PyPi Pagerr}r(h@UhAjubaubhdX or the rr}r(h@X or the rhAjubjP)r}r(h@X`Downloads page`_rjTKhAjhGjUhI}r(UnamerXDownloads pagerhrhhQ]rhO]rhK]rhM]rhS]ruh;]rhdXDownloads pagerr}r(h@UhAjubaubhdX on the rr}r(h@X on the rhAjubjP)r}r(h@X `Website`_rjTKhAjhGjUhI}r(UnamerXWebsiterhrhhQ]rhO]rhK]rhM]rhS]ruh;]rhdXWebsiterr}r(h@UhAjubaubhdX; extract it and install using:rr}r(h@X; extract it and install using:rhAjubeubj)r}r(h@X> python setup.py installrhAjihBhnhGjhI}r(jjhQ]rhO]rhK]rhM]rhS]ruhUKchVhh;]r hdX> python setup.py installr r }r (h@UhAjubaubeubh=)r }r(h@UhAh>hBhnhGhHhI}r(hK]rhM]rhO]rhQ]rh7ahS]rhauhUK_hVhh;]r(hX)r}r(h@XLicenserhAj hBhnhGh\hI}r(hK]rhM]rhO]rhQ]rhS]ruhUK_hVhh;]rhdXLicenser r!}r"(h@jhAjubaubh)r#}r$(h@X.circuits is licensed under the `MIT License`_.r%hAj hBhnhGjhI}r&(hK]r'hM]r(hO]r)hQ]r*hS]r+uhUKahVhh;]r,(hdXcircuits is licensed under the r-r.}r/(h@Xcircuits is licensed under the r0hAj#ubjP)r1}r2(h@X`MIT License`_r3jTKhAj#hGjUhI}r4(Unamer5X MIT Licenser6hrhhQ]r7hO]r8hK]r9hM]r:hS]r;uh;]r<hdX MIT Licenser=r>}r?(h@UhAj1ubaubhdX.r@}rA(h@X.hAj#ubeubeubh=)rB}rC(h@UhAh>hBhnhGhHhI}rD(hK]rEhM]rFhO]rGhQ]rHh*ahS]rIh auhUKehVhh;]rJ(hX)rK}rL(h@XFeedbackrMhAjBhBhnhGh\hI}rN(hK]rOhM]rPhO]rQhQ]rRhS]rSuhUKehVhh;]rThdXFeedbackrUrV}rW(h@jMhAjKubaubh)rX}rY(h@XWe welcome any questions or feedback about bugs and suggestions on how to improve circuits. Let us know what you think about circuits. `@pythoncircuits `_.rZhAjBhBhnhGjhI}r[(hK]r\hM]r]hO]r^hQ]r_hS]r`uhUKghVhh;]ra(hdXWe welcome any questions or feedback about bugs and suggestions on how to improve circuits. Let us know what you think about circuits. rbrc}rd(h@XWe welcome any questions or feedback about bugs and suggestions on how to improve circuits. Let us know what you think about circuits. rehAjXubjP)rf}rg(h@X6`@pythoncircuits `_rhhI}ri(UnamerjX@pythoncircuitsrkhrX!http://twitter.com/pythoncircuitsrlhQ]rmhO]rnhK]rohM]rphS]rquhAjXh;]rrhdX@pythoncircuitsrsrt}ru(h@UhAjfubahGjUubhh)rv}rw(h@X$ rxhlKhAjXhGhphI}ry(UrefurirzjlhQ]r{h1ahO]r|hK]r}hM]r~hS]rhauh;]rubhdX.r}r(h@X.hAjXubeubh)r}r(h@XDo 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.rhAjBhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUKjhVhh;]r(hdX5Do you have suggestions for improvement? Then please rr}r(h@X5Do you have suggestions for improvement? Then please rhAjubjP)r}r(h@X`Create an Issue`_rjTKhAjhGjUhI}r(UnamerXCreate an IssuerhrhhQ]rhO]rhK]rhM]rhS]ruh;]rhdXCreate an Issuerr}r(h@UhAjubaubhdX 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.rr}r(h@X 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.rhAjubeubeubh=)r}r(h@UhAh>hBhnhGhHhI}r(hK]rhM]rhO]rhQ]rh)ahS]rh auhUKphVhh;]r(hX)r}r(h@X CommunityrhAjhBhnhGh\hI}r(hK]rhM]rhO]rhQ]rhS]ruhUKphVhh;]rhdX Communityrr}r(h@jhAjubaubh)r}r(h@XThere is also a small community of circuits enthusiasts that you may find on the `#circuits IRC Channel`_ on the `FreeNode IRC Network`_ and the `Mailing List`_.rhAjhBhnhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUKrhVhh;]r(hdXQThere is also a small community of circuits enthusiasts that you may find on the rr}r(h@XQThere is also a small community of circuits enthusiasts that you may find on the rhAjubjP)r}r(h@X`#circuits IRC Channel`_rjTKhAjhGjUhI}r(UnamerX#circuits IRC Channelrhrh~hQ]rhO]rhK]rhM]rhS]ruh;]rhdX#circuits IRC Channelrr}r(h@UhAjubaubhdX on the rr}r(h@X on the rhAjubjP)r}r(h@X`FreeNode IRC Network`_rjTKhAjhGjUhI}r(UnamerXFreeNode IRC NetworkrhrhhQ]rhO]rhK]rhM]rhS]ruh;]rhdXFreeNode IRC Networkrr}r(h@UhAjubaubhdX and the rr}r(h@X and the rhAjubjP)r}r(h@X`Mailing List`_rjTKhAjhGjUhI}r(UnamerX Mailing ListrhrhhQ]rhO]rhK]rhM]rhS]ruh;]rhdX Mailing Listrr}r(h@UhAjubaubhdX.r}r(h@X.hAjubeubcdocutils.nodes raw r)r}r(h@UhAjhBhnhGUrawrhI}r(UformatrXhtmlrjjhQ]rhO]rhK]rhM]r hS]r uhUKwhVhh;]r hdXjr r }r(h@UhAjubaubeubh=)r}r(h@UhAh>hBhCX RELEASE.rstrr}rbhGhHhI}r(hK]rhM]rhO]rhQ]rh,ahS]rh auhUKhVhh;]r(hX)r}r(h@X*Release Notes - circuits-2.1.0 ()rhAjhBjhGh\hI}r(hK]rhM]r hO]r!hQ]r"hS]r#uhUKhVhh;]r$hdX*Release Notes - circuits-2.1.0 ()r%r&}r'(h@jhAjubaubh)r(}r)(h@X9This release adds the following new features to circuits:r*hAjhBjhGjhI}r+(hK]r,hM]r-hO]r.hQ]r/hS]r0uhUKhVhh;]r1hdX9This release adds the following new features to circuits:r2r3}r4(h@j*hAj(ubaubj)r5}r6(h@UhAjhBjhGjhI}r7(jX-hQ]r8hO]r9hK]r:hM]r;hS]r<uhUKhVhh;]r=(j)r>}r?(h@XPython 3 support.r@hAj5hBjhGjhI}rA(hK]rBhM]rChO]rDhQ]rEhS]rFuhUNhVhh;]rGh)rH}rI(h@j@hAj>hBjhGjhI}rJ(hK]rKhM]rLhO]rMhQ]rNhS]rOuhUKh;]rPhdXPython 3 support.rQrR}rS(h@j@hAjHubaubaubj)rT}rU(h@XWindows support.rVhAj5hBjhGjhI}rW(hK]rXhM]rYhO]rZhQ]r[hS]r\uhUNhVhh;]r]h)r^}r_(h@jVhAjThBjhGjhI}r`(hK]rahM]rbhO]rchQ]rdhS]reuhUKh;]rfhdXWindows support.rgrh}ri(h@jVhAj^ubaubaubj)rj}rk(h@X PyPy support.rlhAj5hBjhGjhI}rm(hK]rnhM]rohO]rphQ]rqhS]rruhUNhVhh;]rsh)rt}ru(h@jlhAjjhBjhGjhI}rv(hK]rwhM]rxhO]ryhQ]rzhS]r{uhUK h;]r|hdX PyPy support.r}r~}r(h@jlhAjtubaubaubj)r}r(h@X IPv6 support.rhAj5hBjhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUNhVhh;]rh)r}r(h@jhAjhBjhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUK h;]rhdX IPv6 support.rr}r(h@jhAjubaubaubj)r}r(h@XBetter WSGI support.rhAj5hBjhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUNhVhh;]rh)r}r(h@jhAjhBjhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUK h;]rhdXBetter WSGI support.rr}r(h@jhAjubaubaubj)r}r(h@XFully documented examples.rhAj5hBjhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUNhVhh;]rh)r}r(h@jhAjhBjhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUK h;]rhdXFully documented examples.rr}r(h@jhAjubaubaubj)r}r(h@XComponent Interface querying. rhAj5hBjhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUNhVhh;]rh)r}r(h@XComponent Interface querying.rhAjhBjhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUK h;]rhdXComponent Interface querying.rr}r(h@jhAjubaubaubeubh)r}r(h@XAnd many bug fixes!rhAjhBjhGjhI}r(hK]rhM]rhO]rhQ]rhS]ruhUKhVhh;]rhdXAnd many bug fixes!rr}r(h@jhAjubaubeubeubah@UU transformerrNU footnote_refsr}rUrefnamesr}r(Xwebsiter]rjaX mit licenser]rj1aX read the docsr]rj&aX#circuits irc channelr]rjaXfreenode irc networkr]rjaXpython programming languager]rjQaXcreate an issuer]rjaX mailing listr]rjaX pypi pager]rjaXdownloads pager]rjaXpython standard libraryr]rjauUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rhVhU current_liner NUtransform_messagesr ]r Ureporterr NUid_startr KU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryr U language_coder!Uenr"U datestampr#NU report_levelr$KU _destinationr%NU halt_levelr&KU strip_classesr'Nh\NUerror_encoding_error_handlerr(Ubackslashreplacer)Udebugr*NUembed_stylesheetr+Uoutput_encoding_error_handlerr,Ustrictr-U sectnum_xformr.KUdump_transformsr/NU docinfo_xformr0KUwarning_streamr1NUpep_file_url_templater2Upep-%04dr3Uexit_status_levelr4KUconfigr5NUstrict_visitorr6NUcloak_email_addressesr7Utrim_footnote_reference_spacer8Uenvr9NUdump_pseudo_xmlr:NUexpose_internalsr;NUsectsubtitle_xformr<U source_linkr=NUrfc_referencesr>NUoutput_encodingr?Uutf-8r@U source_urlrANUinput_encodingrBU utf-8-sigrCU_disable_configrDNU id_prefixrEUU tab_widthrFKUerror_encodingrGU ISO-8859-1rHU_sourcerIU5/home/prologic/work/circuits/docs/source/pypitest.rstrJUgettext_compactrKU generatorrLNUdump_internalsrMNU smart_quotesrNU pep_base_urlrOUhttp://www.python.org/dev/peps/rPUsyntax_highlightrQUlongrRUinput_encoding_error_handlerrSj-Uauto_id_prefixrTUidrUUdoctitle_xformrVUstrip_elements_with_classesrWNU _config_filesrX]rYUfile_insertion_enabledrZKU raw_enabledr[KU dump_settingsr\NubUsymbol_footnote_startr]KUidsr^}r_(h*jBh8hzh)jh&jh+jXh/hh-hih4h>h(hh'hh.hh3hh2hh5hh9hh0jh%hh:hh6jih7j h,jh1jvuUsubstitution_namesr`}rahGhVhI}rb(hK]rchQ]rdhO]reUsourcerfhEhM]rghS]rhuU footnotesri]rjUrefidsrk}rlub.circuits-2.1.0/docs/build/doctrees/howtos/0000755000014400001440000000000012113366740020255 5ustar prologicuserscircuits-2.1.0/docs/build/doctrees/howtos/simple_server.doctree0000644000014400001440000005672712113366670024526 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X source codeqNXstep 2 - building the serverqNXhow to: build a simple serverqNX prerequisitesq NXoverviewq NXstep 3 - running the serverq NXpythonq Xcircuitsq Xcomponents usedqNX events usedqNXstep 1 - setting upqNuUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU source-codeqhUstep-2-building-the-serverqhUhow-to-build-a-simple-serverqh U prerequisitesqh Uoverviewqh Ustep-3-running-the-serverqh Upythonq h Ucircuitsq!hUcomponents-usedq"hU events-usedq#hUstep-1-setting-upq$uUchildrenq%]q&cdocutils.nodes section q')q(}q)(U rawsourceq*UUparentq+hUsourceq,cdocutils.nodes reprunicode q-XA/home/prologic/work/circuits/docs/source/howtos/simple_server.rstq.q/}q0bUtagnameq1Usectionq2U attributesq3}q4(Udupnamesq5]q6Uclassesq7]q8Ubackrefsq9]q:Uidsq;]qhauUlineq?KUdocumentq@hh%]qA(cdocutils.nodes title qB)qC}qD(h*XHow To: Build a Simple ServerqEh+h(h,h/h1UtitleqFh3}qG(h5]qHh7]qIh9]qJh;]qKh=]qLuh?Kh@hh%]qMcdocutils.nodes Text qNXHow To: Build a Simple ServerqOqP}qQ(h*hEh+hCubaubh')qR}qS(h*Uh+h(h,h/h1h2h3}qT(h5]qUh7]qVh9]qWh;]qXhah=]qYh auh?Kh@hh%]qZ(hB)q[}q\(h*XOverviewq]h+hRh,h/h1hFh3}q^(h5]q_h7]q`h9]qah;]qbh=]qcuh?Kh@hh%]qdhNXOverviewqeqf}qg(h*h]h+h[ubaubcdocutils.nodes paragraph qh)qi}qj(h*XIn this guide we're going to walk through the steps required to build a simple chat server. Users will connect using a standard telnet client and start chatting with other users that are connected.qkh+hRh,h/h1U paragraphqlh3}qm(h5]qnh7]qoh9]qph;]qqh=]qruh?Kh@hh%]qshNXIn this guide we're going to walk through the steps required to build a simple chat server. Users will connect using a standard telnet client and start chatting with other users that are connected.qtqu}qv(h*hkh+hiubaubh')qw}qx(h*Uh+hRh,h/h1h2h3}qy(h5]qzh7]q{h9]q|h;]q}hah=]q~h auh?Kh@hh%]q(hB)q}q(h*X Prerequisitesqh+hwh,h/h1hFh3}q(h5]qh7]qh9]qh;]qh=]quh?Kh@hh%]qhNX Prerequisitesqq}q(h*hh+hubaubcdocutils.nodes bullet_list q)q}q(h*Uh+hwh,h/h1U bullet_listqh3}q(UbulletqX-h;]qh9]qh5]qh7]qh=]quh?Kh@hh%]q(cdocutils.nodes list_item q)q}q(h*X!`Python `_qh+hh,h/h1U list_itemqh3}q(h5]qh7]qh9]qh;]qh=]quh?Nh@hh%]qhh)q}q(h*hh+hh,h/h1hlh3}q(h5]qh7]qh9]qh;]qh=]quh?Kh%]q(cdocutils.nodes reference q)q}q(h*hh3}q(UnameqXPythonqUrefuriqXhttp://www.python.orgqh;]qh9]qh5]qh7]qh=]quh+hh%]qhNXPythonqq}q(h*Uh+hubah1U referencequbcdocutils.nodes target q)q}q(h*X qU referencedqKh+hh1Utargetqh3}q(Urefuriqhh;]qh ah9]qh5]qh7]qh=]qh auh%]qubeubaubh)q}q(h*X/`circuits `_ qh+hh,h/h1hh3}q(h5]qh7]qh9]qh;]qh=]quh?Nh@hh%]qhh)q}q(h*X-`circuits `_qh+hh,h/h1hlh3}q(h5]qh7]qh9]qh;]qh=]quh?Kh%]q(h)q}q(h*hh3}q(UnameqXcircuitsqhXhttp://pypi.python.org/circuitsqh;]qh9]qh5]qh7]qh=]quh+hh%]qhNXcircuitsqq}q(h*Uh+hubah1hubh)q}q(h*X" qhKh+hh1hh3}q(Urefuriqhh;]qh!ah9]qh5]qh7]qh=]qh auh%]qubeubaubeubh')q}q(h*Uh+hwh,h/h1h2h3}q(h5]qh7]rh9]rh;]rh"ah=]rhauh?Kh@hh%]r(hB)r}r(h*XComponents Usedrh+hh,h/h1hFh3}r(h5]r h7]r h9]r h;]r h=]r uh?Kh@hh%]rhNXComponents Usedrr}r(h*jh+jubaubh)r}r(h*Uh+hh,h/h1hh3}r(hX-h;]rh9]rh5]rh7]rh=]ruh?Kh@hh%]r(h)r}r(h*X/:py:class:`~circuits.core.components.Component`rh+jh,h/h1hh3}r(h5]rh7]r h9]r!h;]r"h=]r#uh?Nh@hh%]r$hh)r%}r&(h*jh+jh,h/h1hlh3}r'(h5]r(h7]r)h9]r*h;]r+h=]r,uh?Kh%]r-csphinx.addnodes pending_xref r.)r/}r0(h*jh+j%h,h/h1U pending_xrefr1h3}r2(Ureftyper3Xclassr4Urefwarnr5U reftargetr6X"circuits.core.components.Componentr7U refdomainr8Xpyr9h;]r:h9]r;U refexplicitr<h5]r=h7]r>h=]r?Urefdocr@Uhowtos/simple_serverrAUpy:classrBNU py:modulerCNuh?Kh%]rDcdocutils.nodes literal rE)rF}rG(h*jh3}rH(h5]rIh7]rJ(UxrefrKj9Xpy-classrLeh9]rMh;]rNh=]rOuh+j/h%]rPhNX ComponentrQrR}rS(h*Uh+jFubah1UliteralrTubaubaubaubh)rU}rV(h*X-:py:class:`~circuits.net.sockets.TCPServer` rWh+jh,h/h1hh3}rX(h5]rYh7]rZh9]r[h;]r\h=]r]uh?Nh@hh%]r^hh)r_}r`(h*X+:py:class:`~circuits.net.sockets.TCPServer`rah+jUh,h/h1hlh3}rb(h5]rch7]rdh9]reh;]rfh=]rguh?Kh%]rhj.)ri}rj(h*jah+j_h,h/h1j1h3}rk(UreftyperlXclassrmj5j6Xcircuits.net.sockets.TCPServerrnU refdomainroXpyrph;]rqh9]rrU refexplicitrsh5]rth7]ruh=]rvj@jAjBNjCNuh?Kh%]rwjE)rx}ry(h*jah3}rz(h5]r{h7]r|(jKjpXpy-classr}eh9]r~h;]rh=]ruh+jih%]rhNX TCPServerrr}r(h*Uh+jxubah1jTubaubaubaubeubeubh')r}r(h*Uh+hwh,h/h1h2h3}r(h5]rh7]rh9]rh;]rh#ah=]rhauh?Kh@hh%]r(hB)r}r(h*X Events Usedrh+jh,h/h1hFh3}r(h5]rh7]rh9]rh;]rh=]ruh?Kh@hh%]rhNX Events Usedrr}r(h*jh+jubaubh)r}r(h*Uh+jh,h/h1hh3}r(hX-h;]rh9]rh5]rh7]rh=]ruh?Kh@hh%]rh)r}r(h*X):py:class:`~circuits.net.sockets.Write` rh+jh,h/h1hh3}r(h5]rh7]rh9]rh;]rh=]ruh?Nh@hh%]rhh)r}r(h*X':py:class:`~circuits.net.sockets.Write`rh+jh,h/h1hlh3}r(h5]rh7]rh9]rh;]rh=]ruh?Kh%]rj.)r}r(h*jh+jh,h/h1j1h3}r(UreftyperXclassrj5j6Xcircuits.net.sockets.WriterU refdomainrXpyrh;]rh9]rU refexplicitrh5]rh7]rh=]rj@jAjBNjCNuh?Kh%]rjE)r}r(h*jh3}r(h5]rh7]r(jKjXpy-classreh9]rh;]rh=]ruh+jh%]rhNXWriterr}r(h*Uh+jubah1jTubaubaubaubaubeubeubeubh')r}r(h*Uh+h(h,h/h1h2h3}r(h5]rh7]rh9]rh;]rh$ah=]rhauh?K"h@hh%]r(hB)r}r(h*XStep 1 - Setting uprh+jh,h/h1hFh3}r(h5]rh7]rh9]rh;]rh=]ruh?K"h@hh%]rhNXStep 1 - Setting uprr}r(h*jh+jubaubhh)r}r(h*XBLet's start off by importing the components and events we'll need.rh+jh,h/h1hlh3}r(h5]rh7]rh9]rh;]rh=]ruh?K$h@hh%]rhNXBLet's start off by importing the components and events we'll need.rr}r(h*jh+jubaubcdocutils.nodes literal_block r)r}r(h*Xg#!/usr/bin/env python from circuits import Component from circuits.net.sockets import TCPServer, Writerh+jh,h/h1U literal_blockrh3}r(UlinenosrUlanguagerXpythonrU xml:spacerUpreserverh;]rh9]rh5]rh7]rh=]ruh?K&h@hh%]rhNXg#!/usr/bin/env python from circuits import Component from circuits.net.sockets import TCPServer, Writerr }r (h*Uh+jubaubeubh')r }r (h*Uh+h(h,h/h1h2h3}r (h5]rh7]rh9]rh;]rhah=]rhauh?K/h@hh%]r(hB)r}r(h*XStep 2 - Building the Serverrh+j h,h/h1hFh3}r(h5]rh7]rh9]rh;]rh=]ruh?K/h@hh%]rhNXStep 2 - Building the Serverrr}r (h*jh+jubaubhh)r!}r"(h*XNext let's define our ``Server`` Component with a simple event handler that broadcasts all incoming messages to every connected client. We'll keep a list of clients connected to our server in ``self._clients``.r#h+j h,h/h1hlh3}r$(h5]r%h7]r&h9]r'h;]r(h=]r)uh?K1h@hh%]r*(hNXNext let's define our r+r,}r-(h*XNext let's define our r.h+j!ubjE)r/}r0(h*X ``Server``r1h3}r2(h5]r3h7]r4h9]r5h;]r6h=]r7uh+j!h%]r8hNXServerr9r:}r;(h*Uh+j/ubah1jTubhNX Component with a simple event handler that broadcasts all incoming messages to every connected client. We'll keep a list of clients connected to our server in r<r=}r>(h*X Component with a simple event handler that broadcasts all incoming messages to every connected client. We'll keep a list of clients connected to our server in r?h+j!ubjE)r@}rA(h*X``self._clients``rBh3}rC(h5]rDh7]rEh9]rFh;]rGh=]rHuh+j!h%]rIhNX self._clientsrJrK}rL(h*Uh+j@ubah1jTubhNX.rM}rN(h*X.h+j!ubeubhh)rO}rP(h*X'We need to define three event handlers.rQh+j h,h/h1hlh3}rR(h5]rSh7]rTh9]rUh;]rVh=]rWuh?K5h@hh%]rXhNX'We need to define three event handlers.rYrZ}r[(h*jQh+jOubaubcdocutils.nodes enumerated_list r\)r]}r^(h*Uh+j h,h/h1Uenumerated_listr_h3}r`(UsuffixraU.h;]rbh9]rch5]rdUprefixreUh7]rfh=]rgUenumtyperhUarabicriuh?K7h@hh%]rj(h)rk}rl(h*XTAn event handler to update our list of connected clients when a new client connects.rmh+j]h,h/h1hh3}rn(h5]roh7]rph9]rqh;]rrh=]rsuh?Nh@hh%]rthh)ru}rv(h*XTAn event handler to update our list of connected clients when a new client connects.rwh+jkh,h/h1hlh3}rx(h5]ryh7]rzh9]r{h;]r|h=]r}uh?K7h%]r~hNXTAn event handler to update our list of connected clients when a new client connects.rr}r(h*jwh+juubaubaubh)r}r(h*XXAn event handler to update our list of connected clients when a client has disconnected.rh+j]h,h/h1hh3}r(h5]rh7]rh9]rh;]rh=]ruh?Nh@hh%]rhh)r}r(h*XXAn event handler to update our list of connected clients when a client has disconnected.rh+jh,h/h1hlh3}r(h5]rh7]rh9]rh;]rh=]ruh?K9h%]rhNXXAn event handler to update our list of connected clients when a client has disconnected.rr}r(h*jh+jubaubaubh)r}r(h*XpAn event handler to handle messages from connected clients and broadcast them to every other connected client. rh+j]h,h/h1hh3}r(h5]rh7]rh9]rh;]rh=]ruh?Nh@hh%]rhh)r}r(h*XnAn event handler to handle messages from connected clients and broadcast them to every other connected client.rh+jh,h/h1hlh3}r(h5]rh7]rh9]rh;]rh=]ruh?K;h%]rhNXnAn event handler to handle messages from connected clients and broadcast them to every other connected client.rr}r(h*jh+jubaubaubeubj)r}r(h*Xclass Server(Component): def __init__(self, host, port=8000): super(Server, self).__init__() self._clients = [] TCPServer((host, port)).register(self) def connect(self, sock, host, port): self._clients.append(sock) def disconnect(self, sock): self._clients.remove(sock) def read(self, sock, data): for client in self._clients: if not client == sock: self.fire(Write(client, data.strip()))rh+j h,h/h1jh3}r(jjXpythonrjjh;]rh9]rh5]rh7]rh=]ruh?K?h@hh%]rhNXclass Server(Component): def __init__(self, host, port=8000): super(Server, self).__init__() self._clients = [] TCPServer((host, port)).register(self) def connect(self, sock, host, port): self._clients.append(sock) def disconnect(self, sock): self._clients.remove(sock) def read(self, sock, data): for client in self._clients: if not client == sock: self.fire(Write(client, data.strip()))rr}r(h*Uh+jubaubhh)r}r(h*X#Let's walk through this in details:rh+j h,h/h1hlh3}r(h5]rh7]rh9]rh;]rh=]ruh?KVh@hh%]rhNX#Let's walk through this in details:rr}r(h*jh+jubaubj\)r}r(h*Uh+j h,h/h1j_h3}r(jaU.h;]rh9]rh5]rjeUh7]rh=]rjhjiuh?KXh@hh%]r(h)r}r(h*X(Create a new Component called ``Server``rh+jh,h/h1hh3}r(h5]rh7]rh9]rh;]rh=]ruh?Nh@hh%]rhh)r}r(h*jh+jh,h/h1hlh3}r(h5]rh7]rh9]rh;]rh=]ruh?KXh%]r(hNXCreate a new Component called rr}r(h*XCreate a new Component called rh+jubjE)r}r(h*X ``Server``rh3}r(h5]rh7]rh9]rh;]rh=]ruh+jh%]rhNXServerrr}r(h*Uh+jubah1jTubeubaubh)r}r(h*X<Define its initialization arguments as ``(host, port=8000)``rh+jh,h/h1hh3}r(h5]rh7]rh9]rh;]rh=]ruh?Nh@hh%]rhh)r}r(h*jh+jh,h/h1hlh3}r(h5]rh7]rh9]rh;]rh=]r uh?KYh%]r (hNX'Define its initialization arguments as r r }r (h*X'Define its initialization arguments as rh+jubjE)r}r(h*X``(host, port=8000)``rh3}r(h5]rh7]rh9]rh;]rh=]ruh+jh%]rhNX(host, port=8000)rr}r(h*Uh+jubah1jTubeubaubh)r}r(h*X~Call the super constructor of the underlying Component (*This is important as all components need to be initialized properly*)rh+jh,h/h1hh3}r(h5]r h7]r!h9]r"h;]r#h=]r$uh?Nh@hh%]r%hh)r&}r'(h*X~Call the super constructor of the underlying Component (*This is important as all components need to be initialized properly*)r(h+jh,h/h1hlh3}r)(h5]r*h7]r+h9]r,h;]r-h=]r.uh?KZh%]r/(hNX8Call the super constructor of the underlying Component (r0r1}r2(h*X8Call the super constructor of the underlying Component (r3h+j&ubcdocutils.nodes emphasis r4)r5}r6(h*XE*This is important as all components need to be initialized properly*r7h3}r8(h5]r9h7]r:h9]r;h;]r<h=]r=uh+j&h%]r>hNXCThis is important as all components need to be initialized properlyr?r@}rA(h*Uh+j5ubah1UemphasisrBubhNX)rC}rD(h*X)h+j&ubeubaubh)rE}rF(h*X4Register a ``TCPServer`` Component and configure it.rGh+jh,h/h1hh3}rH(h5]rIh7]rJh9]rKh;]rLh=]rMuh?Nh@hh%]rNhh)rO}rP(h*jGh+jEh,h/h1hlh3}rQ(h5]rRh7]rSh9]rTh;]rUh=]rVuh?K\h%]rW(hNX Register a rXrY}rZ(h*X Register a r[h+jOubjE)r\}r](h*X ``TCPServer``r^h3}r_(h5]r`h7]rah9]rbh;]rch=]rduh+jOh%]rehNX TCPServerrfrg}rh(h*Uh+j\ubah1jTubhNX Component and configure it.rirj}rk(h*X Component and configure it.rlh+jOubeubaubh)rm}rn(h*XCreate Event Handlers for: - Dealing with new connecting clients. - Dealing with clients whom have disconnected. - Dealing with messages from connected clients. roh+jh,Nh1hh3}rp(h5]rqh7]rrh9]rsh;]rth=]ruuh?Nh@hh%]rv(hh)rw}rx(h*XCreate Event Handlers for:ryh+jmh,h/h1hlh3}rz(h5]r{h7]r|h9]r}h;]r~h=]ruh?K]h%]rhNXCreate Event Handlers for:rr}r(h*jyh+jwubaubh)r}r(h*Uh3}r(hX-h;]rh9]rh5]rh7]rh=]ruh+jmh%]r(h)r}r(h*X$Dealing with new connecting clients.rh3}r(h5]rh7]rh9]rh;]rh=]ruh+jh%]rhh)r}r(h*jh+jh,h/h1hlh3}r(h5]rh7]rh9]rh;]rh=]ruh?K_h%]rhNX$Dealing with new connecting clients.rr}r(h*jh+jubaubah1hubh)r}r(h*X,Dealing with clients whom have disconnected.rh3}r(h5]rh7]rh9]rh;]rh=]ruh+jh%]rhh)r}r(h*jh+jh,h/h1hlh3}r(h5]rh7]rh9]rh;]rh=]ruh?K`h%]rhNX,Dealing with clients whom have disconnected.rr}r(h*jh+jubaubah1hubh)r}r(h*X/Dealing with messages from connected clients. rh3}r(h5]rh7]rh9]rh;]rh=]ruh+jh%]rhh)r}r(h*X-Dealing with messages from connected clients.rh+jh,h/h1hlh3}r(h5]rh7]rh9]rh;]rh=]ruh?Kah%]rhNX-Dealing with messages from connected clients.rr}r(h*jh+jubaubah1hubeh1hubeubeubeubh')r}r(h*Uh+h(h,h/h1h2h3}r(h5]rh7]rh9]rh;]rhah=]rh auh?Keh@hh%]r(hB)r}r(h*XStep 3 - Running the Serverrh+jh,h/h1hFh3}r(h5]rh7]rh9]rh;]rh=]ruh?Keh@hh%]rhNXStep 3 - Running the Serverrr}r(h*jh+jubaubhh)r}r(h*XThe last step is simply to create an instance of the ``Server`` Component and run it (*making sure to configure it with a host and port*).rh+jh,h/h1hlh3}r(h5]rh7]rh9]rh;]rh=]ruh?Kgh@hh%]r(hNX5The last step is simply to create an instance of the rr}r(h*X5The last step is simply to create an instance of the rh+jubjE)r}r(h*X ``Server``rh3}r(h5]rh7]rh9]rh;]rh=]ruh+jh%]rhNXServerrr}r(h*Uh+jubah1jTubhNX Component and run it (rr}r(h*X Component and run it (rh+jubj4)r}r(h*X2*making sure to configure it with a host and port*rh3}r(h5]r h7]r h9]r h;]r h=]r uh+jh%]rhNX0making sure to configure it with a host and portrr}r(h*Uh+jubah1jBubhNX).rr}r(h*X).rh+jubeubj)r}r(h*XServer("localhost").run()rh+jh,h/h1jh3}r(jjXpythonrjjh;]rh9]rh5]rh7]rh=]ruh?Kjh@hh%]r hNXServer("localhost").run()r!r"}r#(h*Uh+jubaubhh)r$}r%(h*X That's it!r&h+jh,h/h1hlh3}r'(h5]r(h7]r)h9]r*h;]r+h=]r,uh?Knh@hh%]r-hNX That's it!r.r/}r0(h*j&h+j$ubaubhh)r1}r2(h*XUsing a standard telnet client try connecting to localhost on port 8000. Try connecting a second client and watch what happens in the 2nd client when you type text into the 1st.r3h+jh,h/h1hlh3}r4(h5]r5h7]r6h9]r7h;]r8h=]r9uh?Kph@hh%]r:hNXUsing a standard telnet client try connecting to localhost on port 8000. Try connecting a second client and watch what happens in the 2nd client when you type text into the 1st.r;r<}r=(h*j3h+j1ubaubhh)r>}r?(h*XEnjoy!r@h+jh,h/h1hlh3}rA(h5]rBh7]rCh9]rDh;]rEh=]rFuh?Kth@hh%]rGhNXEnjoy!rHrI}rJ(h*j@h+j>ubaubeubh')rK}rL(h*Uh+h(h,h/h1h2h3}rM(h5]rNh7]rOh9]rPh;]rQhah=]rRhauh?Kxh@hh%]rS(hB)rT}rU(h*X Source CoderVh+jKh,h/h1hFh3}rW(h5]rXh7]rYh9]rZh;]r[h=]r\uh?Kxh@hh%]r]hNX Source Coder^r_}r`(h*jVh+jTubaubj)ra}rb(h*Xk#!/usr/bin/env python from circuits import Component from circuits.net.sockets import TCPServer, Write class Server(Component): def __init__(self, host, port=8000): super(Server, self).__init__() self._clients = [] TCPServer((host, port)).register(self) def connect(self, sock, host, port): self._clients.append(sock) def disconnect(self, sock): self._clients.remove(sock) def read(self, sock, data): for client in self._clients: if not client == sock: self.fire(Write(client, data.strip())) Server("localhost").run() rch+jKh,h/h1jh3}rd(jjh-Xpythonrerf}rgbh5]rhjjh;]rih9]rjUsourcerkX@/home/prologic/work/circuits/docs/source/howtos/simple_server.pyrlh7]rmh=]rnuh?Kzh@hh%]rohNXk#!/usr/bin/env python from circuits import Component from circuits.net.sockets import TCPServer, Write class Server(Component): def __init__(self, host, port=8000): super(Server, self).__init__() self._clients = [] TCPServer((host, port)).register(self) def connect(self, sock, host, port): self._clients.append(sock) def disconnect(self, sock): self._clients.remove(sock) def read(self, sock, data): for client in self._clients: if not client == sock: self.fire(Write(client, data.strip())) Server("localhost").run() rprq}rr(h*Uh+jaubaubhh)rs}rt(h*X8:download:`Download simple_server.py `ruh+jKh,h/h1hlh3}rv(h5]rwh7]rxh9]ryh;]rzh=]r{uh?K~h@hh%]r|csphinx.addnodes download_reference r})r~}r(h*juh+jsh,h/h1Udownload_referencerh3}r(UreftyperXdownloadrj5j6Xsimple_server.pyrU refdomainrUh;]rh9]rU refexplicitrh5]rh7]rh=]rj@jAUfilenamerXsimple_server.pyruh?K~h%]rjE)r}r(h*juh3}r(h5]rh7]r(jKjeh9]rh;]rh=]ruh+j~h%]rhNXDownload simple_server.pyrr}r(h*Uh+jubah1jTubaubaubeubeubah*UU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh@hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNhFNUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerUA/home/prologic/work/circuits/docs/source/howtos/simple_server.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hh(hhwh!hhhRh hh#jh"hh$jhjKhjhj uUsubstitution_namesr}rh1h@h3}r(h5]rh;]rh9]rUsourcerh/h7]rh=]ruU footnotesr]r Urefidsr }r ub.circuits-2.1.0/docs/build/doctrees/howtos/index.doctree0000644000014400001440000000546612113366670022750 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qXhowtosqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhUhowtosqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX9/home/prologic/work/circuits/docs/source/howtos/index.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q(haUnamesq)]q*hauUlineq+KUdocumentq,hh]q-(cdocutils.nodes title q.)q/}q0(hXHowTosq1hhhhhUtitleq2h}q3(h!]q4h#]q5h%]q6h']q7h)]q8uh+Kh,hh]q9cdocutils.nodes Text q:XHowTosq;q<}q=(hh1hh/ubaubcdocutils.nodes compound q>)q?}q@(hUhhhhhUcompoundqAh}qB(h!]qCh#]qDUtoctree-wrapperqEah%]qFh']qGh)]qHuh+Nh,hh]qIcsphinx.addnodes toctree qJ)qK}qL(hUhh?hhhUtoctreeqMh}qN(UnumberedqOKhU howtos/indexqPU titlesonlyqQUglobqRh']qSh%]qTh!]qUh#]qVh)]qWUentriesqX]qYNXhowtos/simple_serverqZq[aUhiddenq\U includefilesq]]q^hZaUmaxdepthq_Kuh+Kh]q`ubaubeubahUU transformerqaNU footnote_refsqb}qcUrefnamesqd}qeUsymbol_footnotesqf]qgUautofootnote_refsqh]qiUsymbol_footnote_refsqj]qkU citationsql]qmh,hU current_lineqnNUtransform_messagesqo]qpUreporterqqNUid_startqrKU autofootnotesqs]qtU citation_refsqu}qvUindirect_targetsqw]qxUsettingsqy(cdocutils.frontend Values qzoq{}q|(Ufootnote_backlinksq}KUrecord_dependenciesq~NU rfc_base_urlqUhttp://tools.ietf.org/html/qU tracebackqUpep_referencesqNUstrip_commentsqNU toc_backlinksqUentryqU language_codeqUenqU datestampqNU report_levelqKU _destinationqNU halt_levelqKU strip_classesqNh2NUerror_encoding_error_handlerqUbackslashreplaceqUdebugqNUembed_stylesheetqUoutput_encoding_error_handlerqUstrictqU sectnum_xformqKUdump_transformsqNU docinfo_xformqKUwarning_streamqNUpep_file_url_templateqUpep-%04dqUexit_status_levelqKUconfigqNUstrict_visitorqNUcloak_email_addressesqUtrim_footnote_reference_spaceqUenvqNUdump_pseudo_xmlqNUexpose_internalsqNUsectsubtitle_xformqU source_linkqNUrfc_referencesqNUoutput_encodingqUutf-8qU source_urlqNUinput_encodingqU utf-8-sigqU_disable_configqNU id_prefixqUU tab_widthqKUerror_encodingqU ISO-8859-1qU_sourceqU9/home/prologic/work/circuits/docs/source/howtos/index.rstqUgettext_compactqU generatorqNUdump_internalsqNU smart_quotesqU pep_base_urlqUhttp://www.python.org/dev/peps/qUsyntax_highlightqUlongqUinput_encoding_error_handlerqhUauto_id_prefixqUidqUdoctitle_xformqUstrip_elements_with_classesqNU _config_filesq]qUfile_insertion_enabledqKU raw_enabledqKU dump_settingsqNubUsymbol_footnote_startqKUidsq}qhhsUsubstitution_namesq}qhh,h}q(h!]qh']qh%]qUsourceqhh#]qh)]quU footnotesq]qUrefidsq}qub.circuits-2.1.0/docs/build/doctrees/changes.doctree0000644000014400001440000066416112113366670021731 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(XchoresqNXfeaturesqNX changelogqNX!circuits-2.0.0 20121122 (cheetah)q NX#circuits-2.1.0 20130224 ()q NXcircuits-2.0.1 20121124q NXbugsq NX circuits-1.6 (oceans) - 20110626q NX other changesqNXchangesquUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hUchoresqhUfeaturesqhU changelogqh Ucircuits-2-0-0-20121122-cheetahqh Ucircuits-2-1-0-20130224-releaseqh Ucircuits-2-0-1-20121124qh Ubugsqh Ucircuits-1-6-oceans-20110626q hU other-changesq!hUchangesq"uUchildrenq#]q$(cdocutils.nodes target q%)q&}q'(U rawsourceq(X .. _changes:q)Uparentq*hUsourceq+cdocutils.nodes reprunicode q,X4/home/prologic/work/circuits/docs/source/changes.rstq-q.}q/bUtagnameq0Utargetq1U attributesq2}q3(Uidsq4]q5Ubackrefsq6]q7Udupnamesq8]q9Uclassesq:]q;Unamesq<]q=Urefidq>h"uUlineq?KUdocumentq@hh#]qAubcdocutils.nodes section qB)qC}qD(h(Uh*hh+h.Uexpect_referenced_by_nameqE}qFhh&sh0UsectionqGh2}qH(h8]qIh:]qJh6]qKh4]qL(hh"eh<]qM(hheuh?Kh@hUexpect_referenced_by_idqN}qOh"h&sh#]qP(cdocutils.nodes title qQ)qR}qS(h(X ChangeLogqTh*hCh+h.h0UtitleqUh2}qV(h8]qWh:]qXh6]qYh4]qZh<]q[uh?Kh@hh#]q\cdocutils.nodes Text q]X ChangeLogq^q_}q`(h(hTh*hRubaubhB)qa}qb(h(Uh*hCh+h,X CHANGES.rstqcqd}qebh0hGh2}qf(h8]qgh:]qhh6]qih4]qjhah<]qkh auh?Kh@hh#]ql(hQ)qm}qn(h(X#circuits-2.1.0 20130224 ()qoh*hah+hdh0hUh2}qp(h8]qqh:]qrh6]qsh4]qth<]quuh?Kh@hh#]qvh]X#circuits-2.1.0 20130224 ()qwqx}qy(h(hoh*hmubaubhB)qz}q{(h(Uh*hah+hdh0hGh2}q|(h8]q}h:]q~h6]qh4]qhah<]qhauh?Kh@hh#]q(hQ)q}q(h(XFeaturesqh*hzh+hdh0hUh2}q(h8]qh:]qh6]qh4]qh<]quh?Kh@hh#]qh]XFeaturesqq}q(h(hh*hubaubcdocutils.nodes bullet_list q)q}q(h(Uh*hzh+hdh0U bullet_listqh2}q(UbulletqX-h4]qh6]qh8]qh:]qh<]quh?K h@hh#]q(cdocutils.nodes list_item q)q}q(h(XAdded IPv6 Support [#39987887]qh*hh+hdh0U list_itemqh2}q(h8]qh:]qh6]qh4]qh<]quh?Nh@hh#]qcdocutils.nodes paragraph q)q}q(h(hh*hh+hdh0U paragraphqh2}q(h8]qh:]qh6]qh4]qh<]quh?K h#]qh]XAdded IPv6 Support [#39987887]qq}q(h(hh*hubaubaubh)q}q(h(X-Document and Comment all Examples [#40112459]qh*hh+hdh0hh2}q(h8]qh:]qh6]qh4]qh<]quh?Nh@hh#]qh)q}q(h(hh*hh+hdh0hh2}q(h8]qh:]qh6]qh4]qh<]quh?K h#]qh]X-Document and Comment all Examples [#40112459]qɅq}q(h(hh*hubaubaubh)q}q(h(X7Update WebSockets dispatcher in circuits.web [40064247]qh*hh+hdh0hh2}q(h8]qh:]qh6]qh4]qh<]quh?Nh@hh#]qh)q}q(h(hh*hh+hdh0hh2}q(h8]qh:]qh6]qh4]qh<]quh?K h#]qh]X7Update WebSockets dispatcher in circuits.web [40064247]q߅q}q(h(hh*hubaubaubh)q}q(h(X-Component Event Handlers Property [#41573841]qh*hh+hdh0hh2}q(h8]qh:]qh6]qh4]qh<]quh?Nh@hh#]qh)q}q(h(hh*hh+hdh0hh2}q(h8]qh:]qh6]qh4]qh<]quh?K h#]qh]X-Component Event Handlers Property [#41573841]qq}q(h(hh*hubaubaubh)q}q(h(X+Component targeting performance [#41644031]qh*hh+hdh0hh2}q(h8]qh:]qh6]qh4]qh<]ruh?Nh@hh#]rh)r}r(h(hh*hh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]r uh?K h#]r h]X+Component targeting performance [#41644031]r r }r (h(hh*jubaubaubh)r}r(h(X"Multi-App WSGI Gateway [#40071339]rh*hh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]r h]X"Multi-App WSGI Gateway [#40071339]r!r"}r#(h(jh*jubaubaubh)r$}r%(h(X1More efficient timer implementation [#43700669] r&h*hh+hdh0hh2}r'(h8]r(h:]r)h6]r*h4]r+h<]r,uh?Nh@hh#]r-h)r.}r/(h(X/More efficient timer implementation [#43700669]r0h*j$h+hdh0hh2}r1(h8]r2h:]r3h6]r4h4]r5h<]r6uh?Kh#]r7h]X/More efficient timer implementation [#43700669]r8r9}r:(h(j0h*j.ubaubaubeubeubhB)r;}r<(h(Uh*hah+hdh0hGh2}r=(h8]r>h:]r?h6]r@h4]rAhah<]rBh auh?Kh@hh#]rC(hQ)rD}rE(h(XBugsrFh*j;h+hdh0hUh2}rG(h8]rHh:]rIh6]rJh4]rKh<]rLuh?Kh@hh#]rMh]XBugsrNrO}rP(h(jFh*jDubaubh)rQ}rR(h(Uh*j;h+hdh0hh2}rS(hX-h4]rTh6]rUh8]rVh:]rWh<]rXuh?Kh@hh#]rY(h)rZ}r[(h(X2Fix the broken links in the Users page [#40063597]r\h*jQh+hdh0hh2}r](h8]r^h:]r_h6]r`h4]rah<]rbuh?Nh@hh#]rch)rd}re(h(j\h*jZh+hdh0hh2}rf(h8]rgh:]rhh6]rih4]rjh<]rkuh?Kh#]rlh]X2Fix the broken links in the Users page [#40063597]rmrn}ro(h(j\h*jdubaubaubh)rp}rq(h(X8circuits.tools.inspect shows incorrect ticks [#41650961]rrh*jQh+hdh0hh2}rs(h8]rth:]ruh6]rvh4]rwh<]rxuh?Nh@hh#]ryh)rz}r{(h(jrh*jph+hdh0hh2}r|(h8]r}h:]r~h6]rh4]rh<]ruh?Kh#]rh]X8circuits.tools.inspect shows incorrect ticks [#41650961]rr}r(h(jrh*jzubaubaubh)r}r(h(X4Race Condition with call/wait primitives [#41643711]rh*jQh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]X4Race Condition with call/wait primitives [#41643711]rr}r(h(jh*jubaubaubh)r}r(h(XRESTful Dispatcher [#41643773]rh*jQh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XRESTful Dispatcher [#41643773]rr}r(h(jh*jubaubaubh)r}r(h(X,Fix Component instance targeting [#41644025]rh*jQh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]X,Fix Component instance targeting [#41644025]rr}r(h(jh*jubaubaubh)r}r(h(XWorker Processes [#41643831]rh*jQh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XWorker Processes [#41643831]rr}r(h(jh*jubaubaubh)r}r(h(X4Make examples/web/sslserver.py work again [42007509]rh*jQh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]X4Make examples/web/sslserver.py work again [42007509]rr}r(h(jh*jubaubaubh)r}r(h(X#Value instance in body [43287263] rh*jQh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(X!Value instance in body [43287263]rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]X!Value instance in body [43287263]rr }r (h(jh*jubaubaubeubeubhB)r }r (h(Uh*hah+hdh0hGh2}r (h8]rh:]rh6]rh4]rhah<]rhauh?K!h@hh#]r(hQ)r}r(h(XChoresrh*j h+hdh0hUh2}r(h8]rh:]rh6]rh4]rh<]ruh?K!h@hh#]rh]XChoresrr}r (h(jh*jubaubh)r!}r"(h(Uh*j h+hdh0hh2}r#(hX-h4]r$h6]r%h8]r&h:]r'h<]r(uh?K$h@hh#]r)(h)r*}r+(h(X*Import shadowing in manager.py [#41644023]r,h*j!h+hdh0hh2}r-(h8]r.h:]r/h6]r0h4]r1h<]r2uh?Nh@hh#]r3h)r4}r5(h(j,h*j*h+hdh0hh2}r6(h8]r7h:]r8h6]r9h4]r:h<]r;uh?K$h#]r<h]X*Import shadowing in manager.py [#41644023]r=r>}r?(h(j,h*j4ubaubaubh)r@}rA(h(X+Run the codebase through flake8 [#41651093]rBh*j!h+hdh0hh2}rC(h8]rDh:]rEh6]rFh4]rGh<]rHuh?Nh@hh#]rIh)rJ}rK(h(jBh*j@h+hdh0hh2}rL(h8]rMh:]rNh6]rOh4]rPh<]rQuh?K%h#]rRh]X+Run the codebase through flake8 [#41651093]rSrT}rU(h(jBh*jJubaubaubh)rV}rW(h(X!URL Quoting Unit Test [#41882655]rXh*j!h+hdh0hh2}rY(h8]rZh:]r[h6]r\h4]r]h<]r^uh?Nh@hh#]r_h)r`}ra(h(jXh*jVh+hdh0hh2}rb(h8]rch:]rdh6]reh4]rfh<]rguh?K&h#]rhh]X!URL Quoting Unit Test [#41882655]rirj}rk(h(jXh*j`ubaubaubh)rl}rm(h(XSSL Unit Test [#42849393]rnh*j!h+hdh0hh2}ro(h8]rph:]rqh6]rrh4]rsh<]rtuh?Nh@hh#]ruh)rv}rw(h(jnh*jlh+hdh0hh2}rx(h8]ryh:]rzh6]r{h4]r|h<]r}uh?K'h#]r~h]XSSL Unit Test [#42849393]rr}r(h(jnh*jvubaubaubh)r}r(h(XPython 3.x Support [43027337]rh*j!h+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?K(h#]rh]XPython 3.x Support [43027337]rr}r(h(jh*jubaubaubh)r}r(h(X Fill out FAQ in Docs [#43389199]rh*j!h+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?K)h#]rh]X Fill out FAQ in Docs [#43389199]rr}r(h(jh*jubaubaubh)r}r(h(X!Write Developer Docs [#43389193] rh*j!h+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(X Write Developer Docs [#43389193]rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?K*h#]rh]X Write Developer Docs [#43389193]rr}r(h(jh*jubaubaubeubeubhB)r}r(h(Uh*hah+hdh0hGh2}r(h8]rh:]rh6]rh4]rh!ah<]rhauh?K-h@hh#]r(hQ)r}r(h(X Other Changesrh*jh+hdh0hUh2}r(h8]rh:]rh6]rh4]rh<]ruh?K-h@hh#]rh]X Other Changesrr}r(h(jh*jubaubh)r}r(h(X-A list of other changes we forgot to track :)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?K0h@hh#]rh]X-A list of other changes we forgot to track :)rr}r(h(jh*jubaubh)r}r(h(Uh*jh+hdh0hh2}r(hX-h4]rh6]rh8]rh:]rh<]ruh?K2h@hh#]r(h)r}r(h(X0Fixed latency timing for circuits.bench on win32rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?K2h#]rh]X0Fixed latency timing for circuits.bench on win32rr}r(h(jh*jubaubaubh)r}r(h(XUpdated the URL for ReadTheDocsr h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]rh<]ruh?Nh@hh#]rh)r}r(h(j h*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?K3h#]rh]XUpdated the URL for ReadTheDocsrr}r(h(j h*jubaubaubh)r}r(h(XuUpdated the Getting Started / Downloading documentation to say something about the Tags tab for downloading archives.rh*jh+hdh0hh2}r (h8]r!h:]r"h6]r#h4]r$h<]r%uh?Nh@hh#]r&h)r'}r((h(XuUpdated the Getting Started / Downloading documentation to say something about the Tags tab for downloading archives.r)h*jh+hdh0hh2}r*(h8]r+h:]r,h6]r-h4]r.h<]r/uh?K4h#]r0h]XuUpdated the Getting Started / Downloading documentation to say something about the Tags tab for downloading archives.r1r2}r3(h(j)h*j'ubaubaubh)r4}r5(h(X-Removed unused import in ``circuits.app.env``r6h*jh+hdh0hh2}r7(h8]r8h:]r9h6]r:h4]r;h<]r<uh?Nh@hh#]r=h)r>}r?(h(j6h*j4h+hdh0hh2}r@(h8]rAh:]rBh6]rCh4]rDh<]rEuh?K6h#]rF(h]XRemoved unused import in rGrH}rI(h(XRemoved unused import in rJh*j>ubcdocutils.nodes literal rK)rL}rM(h(X``circuits.app.env``rNh2}rO(h8]rPh:]rQh6]rRh4]rSh<]rTuh*j>h#]rUh]Xcircuits.app.envrVrW}rX(h(Uh*jLubah0UliteralrYubeubaubh)rZ}r[(h(X=Added some documentation about how HTTP requests are handled.r\h*jh+hdh0hh2}r](h8]r^h:]r_h6]r`h4]rah<]rbuh?Nh@hh#]rch)rd}re(h(j\h*jZh+hdh0hh2}rf(h8]rgh:]rhh6]rih4]rjh<]rkuh?K7h#]rlh]X=Added some documentation about how HTTP requests are handled.rmrn}ro(h(j\h*jdubaubaubh)rp}rq(h(XRemoved unused coderrh*jh+hdh0hh2}rs(h8]rth:]ruh6]rvh4]rwh<]rxuh?Nh@hh#]ryh)rz}r{(h(jrh*jph+hdh0hh2}r|(h8]r}h:]r~h6]rh4]rh<]ruh?K8h#]rh]XRemoved unused coderr}r(h(jrh*jzubaubaubh)r}r(h(X.A simple chat server implementation (Examples)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?K9h#]rh]X.A simple chat server implementation (Examples)rr}r(h(jh*jubaubaubh)r}r(h(XaFixed a bug with Manager.processTasks and Error event firing. handler was not being set correctlyrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XaFixed a bug with Manager.processTasks and Error event firing. handler was not being set correctlyrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?K:h#]rh]XaFixed a bug with Manager.processTasks and Error event firing. handler was not being set correctlyrr}r(h(jh*jubaubaubh)r}r(h(X(Fixes wrong variable names in sockets.pyrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]r(h]X4Expect the original method to be passed as input to rr}r(h(X4Expect the original method to be passed as input to rh*jubjK)r}r(h(X``Manager.removeHandler``rh2}r(h8]rh:]rh6]rh4]rh<]ruh*jh#]rh]XManager.removeHandlerrr}r(h(Uh*jubah0jYubh]X r}r(h(X h*jubjK)r}r(h(X``Manager.addHandler``rh2}r (h8]r h:]r h6]r h4]r h<]ruh*jh#]rh]XManager.addHandlerrr}r(h(Uh*jubah0jYubh]X0 now returns a reference to the original method.rr}r(h(X0 now returns a reference to the original method.rh*jubeubaubh)r}r(h(X8Guard against a None _sock or non-existent _sock object.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]r h)r!}r"(h(jh*jh+hdh0hh2}r#(h8]r$h:]r%h6]r&h4]r'h<]r(uh?K@h#]r)h]X8Guard against a None _sock or non-existent _sock object.r*r+}r,(h(jh*j!ubaubaubh)r-}r.(h(XsAllow a custom host, port and secure option to be passed to the connect event handler of circuits.web.client.Clientr/h*jh+hdh0hh2}r0(h8]r1h:]r2h6]r3h4]r4h<]r5uh?Nh@hh#]r6h)r7}r8(h(XsAllow a custom host, port and secure option to be passed to the connect event handler of circuits.web.client.Clientr9h*j-h+hdh0hh2}r:(h8]r;h:]r<h6]r=h4]r>h<]r?uh?KAh#]r@h]XsAllow a custom host, port and secure option to be passed to the connect event handler of circuits.web.client.ClientrArB}rC(h(j9h*j7ubaubaubh)rD}rE(h(XVRedesigned tests/web/conftest.py with newer pytest APIs using ``@pytest.fixture(...)``rFh*jh+hdh0hh2}rG(h8]rHh:]rIh6]rJh4]rKh<]rLuh?Nh@hh#]rMh)rN}rO(h(XVRedesigned tests/web/conftest.py with newer pytest APIs using ``@pytest.fixture(...)``rPh*jDh+hdh0hh2}rQ(h8]rRh:]rSh6]rTh4]rUh<]rVuh?KCh#]rW(h]X>Redesigned tests/web/conftest.py with newer pytest APIs using rXrY}rZ(h(X>Redesigned tests/web/conftest.py with newer pytest APIs using r[h*jNubjK)r\}r](h(X``@pytest.fixture(...)``r^h2}r_(h8]r`h:]rah6]rbh4]rch<]rduh*jNh#]reh]X@pytest.fixture(...)rfrg}rh(h(Uh*j\ubah0jYubeubaubh)ri}rj(h(X)Experimental new Watcher/Manager fixturesrkh*jh+hdh0hh2}rl(h8]rmh:]rnh6]roh4]rph<]rquh?Nh@hh#]rrh)rs}rt(h(jkh*jih+hdh0hh2}ru(h8]rvh:]rwh6]rxh4]ryh<]rzuh?KEh#]r{h]X)Experimental new Watcher/Manager fixturesr|r}}r~(h(jkh*jsubaubaubh)r}r(h(XDocs for Fallback generatorrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?KFh#]rh]XDocs for Fallback generatorrr}r(h(jh*jubaubaubh)r}r(h(X1Removing the concept of _ticks, @tick and friendsrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?KGh#]rh]X1Removing the concept of _ticks, @tick and friendsrr}r(h(jh*jubaubaubh)r}r(h(X Fixes timersrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?KHh#]rh]X Fixes timersrr}r(h(jh*jubaubaubh)r}r(h(X:Reimplemented circuits.io.File as per circuits.net.socketsrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?KIh#]rh]X:Reimplemented circuits.io.File as per circuits.net.socketsrr}r(h(jh*jubaubaubh)r}r(h(X.Re-implemented Notify Component and fixed testrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?KJh#]rh]X.Re-implemented Notify Component and fixed testrr}r(h(jh*jubaubaubh)r}r(h(X5Reworked Notifier Component to be more async friendlyrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?KKh#]rh]X5Reworked Notifier Component to be more async friendlyrr}r(h(jh*jubaubaubh)r}r(h(XZFixed a bug with the repr of Manager and thus Components with non-str channels. eg: (1, 1)rh*jh+hdh0hh2}r(h8]rh:]rh6]r h4]r h<]r uh?Nh@hh#]r h)r }r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?KLh#]rh]XZFixed a bug with the repr of Manager and thus Components with non-str channels. eg: (1, 1)rr}r(h(jh*j ubaubaubh)r}r(h(X-Added a unit test for generate_events handlerrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]r h<]r!uh?Nh@hh#]r"h)r#}r$(h(jh*jh+hdh0hh2}r%(h8]r&h:]r'h6]r(h4]r)h<]r*uh?KMh#]r+h]X-Added a unit test for generate_events handlerr,r-}r.(h(jh*j#ubaubaubh)r/}r0(h(X@Fixed terminal example demonstrating Streaming with circuits.webr1h*jh+hdh0hh2}r2(h8]r3h:]r4h6]r5h4]r6h<]r7uh?Nh@hh#]r8h)r9}r:(h(j1h*j/h+hdh0hh2}r;(h8]r<h:]r=h6]r>h4]r?h<]r@uh?KNh#]rAh]X@Fixed terminal example demonstrating Streaming with circuits.webrBrC}rD(h(j1h*j9ubaubaubh)rE}rF(h(X)Fixed index page for terminal web examplerGh*jh+hdh0hh2}rH(h8]rIh:]rJh6]rKh4]rLh<]rMuh?Nh@hh#]rNh)rO}rP(h(jGh*jEh+hdh0hh2}rQ(h8]rRh:]rSh6]rTh4]rUh<]rVuh?KOh#]rWh]X)Fixed index page for terminal web examplerXrY}rZ(h(jGh*jOubaubaubh)r[}r\(h(XAdded an Open event to Filer]h*jh+hdh0hh2}r^(h8]r_h:]r`h6]rah4]rbh<]rcuh?Nh@hh#]rdh)re}rf(h(j]h*j[h+hdh0hh2}rg(h8]rhh:]rih6]rjh4]rkh<]rluh?KPh#]rmh]XAdded an Open event to Filernro}rp(h(j]h*jeubaubaubh)rq}rr(h(X_Fixed a bug with the static dispatcher for circuits.web whereby the path was not being unquotedrsh*jh+hdh0hh2}rt(h8]ruh:]rvh6]rwh4]rxh<]ryuh?Nh@hh#]rzh)r{}r|(h(X_Fixed a bug with the static dispatcher for circuits.web whereby the path was not being unquotedr}h*jqh+hdh0hh2}r~(h8]rh:]rh6]rh4]rh<]ruh?KQh#]rh]X_Fixed a bug with the static dispatcher for circuits.web whereby the path was not being unquotedrr}r(h(j}h*j{ubaubaubh)r}r(h(X`Fixed a bug with the static circuits.web dispatcher whereby directory listing did not quote urlsrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(X`Fixed a bug with the static circuits.web dispatcher whereby directory listing did not quote urlsrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?KSh#]rh]X`Fixed a bug with the static circuits.web dispatcher whereby directory listing did not quote urlsrr}r(h(jh*jubaubaubh)r}r(h(X8Added simple examples demonstrating circuits' primitivesrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?KUh#]rh]X8Added simple examples demonstrating circuits' primitivesrr}r(h(jh*jubaubaubh)r}r(h(X%Added example of .fire(...) primitiverh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?KVh#]rh]X%Added example of .fire(...) primitiverr}r(h(jh*jubaubaubh)r}r(h(XKRestructured circuits.io and implemented circuits.io.Process with unit testrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?KWh#]rh]XKRestructured circuits.io and implemented circuits.io.Process with unit testrr}r(h(jh*jubaubaubh)r}r(h(XAdded Hello World examplerh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?KXh#]rh]XAdded Hello World examplerr}r(h(jh*jubaubaubh)r}r(h(XzMade components started in process mode not link by default. Have to explicitly set the kwarg ``link=component_instance``.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XzMade components started in process mode not link by default. Have to explicitly set the kwarg ``link=component_instance``.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]r uh?KYh#]r (h]X^Made components started in process mode not link by default. Have to explicitly set the kwarg r r }r (h(X^Made components started in process mode not link by default. Have to explicitly set the kwarg rh*jubjK)r}r(h(X``link=component_instance``rh2}r(h8]rh:]rh6]rh4]rh<]ruh*jh#]rh]Xlink=component_instancerr}r(h(Uh*jubah0jYubh]X.r}r(h(X.h*jubeubaubh)r}r(h(X9Fixed raising of ``SystemExit`` or ``KeyboardInterrupt``.r h*jh+hdh0hh2}r!(h8]r"h:]r#h6]r$h4]r%h<]r&uh?Nh@hh#]r'h)r(}r)(h(j h*jh+hdh0hh2}r*(h8]r+h:]r,h6]r-h4]r.h<]r/uh?K[h#]r0(h]XFixed raising of r1r2}r3(h(XFixed raising of r4h*j(ubjK)r5}r6(h(X``SystemExit``r7h2}r8(h8]r9h:]r:h6]r;h4]r<h<]r=uh*j(h#]r>h]X SystemExitr?r@}rA(h(Uh*j5ubah0jYubh]X or rBrC}rD(h(X or rEh*j(ubjK)rF}rG(h(X``KeyboardInterrupt``rHh2}rI(h8]rJh:]rKh6]rLh4]rMh<]rNuh*j(h#]rOh]XKeyboardInterruptrPrQ}rR(h(Uh*jFubah0jYubh]X.rS}rT(h(X.h*j(ubeubaubh)rU}rV(h(X:Modified the way caching works with the Static dispatcher rWh*jh+hdh0hh2}rX(h8]rYh:]rZh6]r[h4]r\h<]r]uh?Nh@hh#]r^h)r_}r`(h(X9Modified the way caching works with the Static dispatcherrah*jUh+hdh0hh2}rb(h8]rch:]rdh6]reh4]rfh<]rguh?K\h#]rhh]X9Modified the way caching works with the Static dispatcherrirj}rk(h(jah*j_ubaubaubh)rl}rm(h(X`Brought back the ``circuits.core.bridge.Bridge``. With it better inter-process communications via high-speed full duplex pipes using ``circuits.net.sockets.Pipe`` (UNIX Only), a much simpler API. In addition, a change to the way Value Notification works. .notify of an event instance can either be True or a channel to send the ValueChanged event to. rnh*jh+hdh0hh2}ro(h8]rph:]rqh6]rrh4]rsh<]rtuh?Nh@hh#]ru(h)rv}rw(h(XBrought back the ``circuits.core.bridge.Bridge``. With it better inter-process communications via high-speed full duplex pipes using ``circuits.net.sockets.Pipe`` (UNIX Only), a much simpler API.rxh*jlh+hdh0hh2}ry(h8]rzh:]r{h6]r|h4]r}h<]r~uh?K^h#]r(h]XBrought back the rr}r(h(XBrought back the rh*jvubjK)r}r(h(X``circuits.core.bridge.Bridge``rh2}r(h8]rh:]rh6]rh4]rh<]ruh*jvh#]rh]Xcircuits.core.bridge.Bridgerr}r(h(Uh*jubah0jYubh]XU. With it better inter-process communications via high-speed full duplex pipes using rr}r(h(XU. With it better inter-process communications via high-speed full duplex pipes using rh*jvubjK)r}r(h(X``circuits.net.sockets.Pipe``rh2}r(h8]rh:]rh6]rh4]rh<]ruh*jvh#]rh]Xcircuits.net.sockets.Piperr}r(h(Uh*jubah0jYubh]X! (UNIX Only), a much simpler API.rr}r(h(X! (UNIX Only), a much simpler API.rh*jvubeubh)r}r(h(XIn addition, a change to the way Value Notification works. .notify of an event instance can either be True or a channel to send the ValueChanged event to.rh*jlh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kbh#]rh]XIn addition, a change to the way Value Notification works. .notify of an event instance can either be True or a channel to send the ValueChanged event to.rr}r(h(jh*jubaubeubh)r}r(h(X4Added timers examples resurrected from old circuits rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(X3Added timers examples resurrected from old circuitsrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kfh#]rh]X3Added timers examples resurrected from old circuitsrr}r(h(jh*jubaubaubh)r}r(h(X8Global handlers and component targeting Global handlers would be ignored when using component targeting. This patch considers them. To do this, we have added an extra property to managers. You can use traverse_children_handlers to increase performance when you have a huge number of components. Put the components that are only meant to be used with component targeting under a single component. The hierarchy looks like this: .. code-block:: python Root -> Umbrella Component -> Component 1, Component 2, Component 3, ... -> Debugger() -> etc rh*jh+Nh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]r(h)r}r(h(XhGlobal handlers and component targeting Global handlers would be ignored when using component targeting.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Khh#]rh]XhGlobal handlers and component targeting Global handlers would be ignored when using component targeting.rr}r(h(jh*jubaubh)r}r(h(XSThis patch considers them. To do this, we have added an extra property to managers.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kkh#]rh]XSThis patch considers them. To do this, we have added an extra property to managers.rr}r(h(jh*jubaubh)r}r(h(XYou can use traverse_children_handlers to increase performance when you have a huge number of components. Put the components that are only meant to be used with component targeting under a single component. The hierarchy looks like this:rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Knh#]rh]XYou can use traverse_children_handlers to increase performance when you have a huge number of components. Put the components that are only meant to be used with component targeting under a single component. The hierarchy looks like this:rr}r(h(jh*jubaubcdocutils.nodes literal_block r)r}r(h(XgRoot -> Umbrella Component -> Component 1, Component 2, Component 3, ... -> Debugger() -> etcrh*jh+hdh0U literal_blockrh2}r(UlinenosrUlanguagerXpythonrU xml:spacerUpreserverh4]rh6]rh8]rh:]r h<]r uh?Ksh#]r h]XgRoot -> Umbrella Component -> Component 1, Component 2, Component 3, ... -> Debugger() -> etcr r }r(h(Uh*jubaubeubh)r}r(h(XxSet Umbrella Component traverse_children_handlers to false to prevent traversing the huge number of children components.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XxSet Umbrella Component traverse_children_handlers to false to prevent traversing the huge number of children components.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]r h<]r!uh?Kyh#]r"h]XxSet Umbrella Component traverse_children_handlers to false to prevent traversing the huge number of children components.r#r$}r%(h(jh*jubaubaubh)r&}r'(h(X'Fixed Connection header interpretation.r(h*jh+hdh0hh2}r)(h8]r*h:]r+h6]r,h4]r-h<]r.uh?Nh@hh#]r/h)r0}r1(h(j(h*j&h+hdh0hh2}r2(h8]r3h:]r4h6]r5h4]r6h<]r7uh?K{h#]r8h]X'Fixed Connection header interpretation.r9r:}r;(h(j(h*j0ubaubaubh)r<}r=(h(X$Updated documentation for WebSocket.r>h*jh+hdh0hh2}r?(h8]r@h:]rAh6]rBh4]rCh<]rDuh?Nh@hh#]rEh)rF}rG(h(j>h*j<h+hdh0hh2}rH(h8]rIh:]rJh6]rKh4]rLh<]rMuh?K|h#]rNh]X$Updated documentation for WebSocket.rOrP}rQ(h(j>h*jFubaubaubh)rR}rS(h(X Removed pool - covered by workerrTh*jh+hdh0hh2}rU(h8]rVh:]rWh6]rXh4]rYh<]rZuh?Nh@hh#]r[h)r\}r](h(jTh*jRh+hdh0hh2}r^(h8]r_h:]r`h6]rah4]rbh<]rcuh?K}h#]rdh]X Removed pool - covered by workerrerf}rg(h(jTh*j\ubaubaubh)rh}ri(h(XFixed dispatchers return value.rjh*jh+hdh0hh2}rk(h8]rlh:]rmh6]rnh4]roh<]rpuh?Nh@hh#]rqh)rr}rs(h(jjh*jhh+hdh0hh2}rt(h8]ruh:]rvh6]rwh4]rxh<]ryuh?K~h#]rzh]XFixed dispatchers return value.r{r|}r}(h(jjh*jrubaubaubh)r~}r(h(XwFiring Connect event when a web socket connection is established to make behavior look even more like ordinary sockets.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XwFiring Connect event when a web socket connection is established to make behavior look even more like ordinary sockets.rh*j~h+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XwFiring Connect event when a web socket connection is established to make behavior look even more like ordinary sockets.rr}r(h(jh*jubaubaubh)r}r(h(XCNuked ``@future`` decorator due to pickling problems for processes.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]r(h]XNuked rr}r(h(XNuked rh*jubjK)r}r(h(X ``@future``rh2}r(h8]rh:]rh6]rh4]rh<]ruh*jh#]rh]X@futurerr}r(h(Uh*jubah0jYubh]X2 decorator due to pickling problems for processes.rr}r(h(X2 decorator due to pickling problems for processes.rh*jubeubaubh)r}r(h(XhAllow coroutine-style tasks to terminate the system via raise of ``SystemExit`` or ``KeyboardInterrupt``rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XhAllow coroutine-style tasks to terminate the system via raise of ``SystemExit`` or ``KeyboardInterrupt``rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]r(h]XAAllow coroutine-style tasks to terminate the system via raise of rr}r(h(XAAllow coroutine-style tasks to terminate the system via raise of rh*jubjK)r}r(h(X``SystemExit``rh2}r(h8]rh:]rh6]rh4]rh<]ruh*jh#]rh]X SystemExitrr}r(h(Uh*jubah0jYubh]X or rr}r(h(X or rh*jubjK)r}r(h(X``KeyboardInterrupt``rh2}r(h8]rh:]rh6]rh4]rh<]ruh*jh#]rh]XKeyboardInterruptrr}r(h(Uh*jubah0jYubeubaubh)r}r(h(XGDropping events unnoticed when waiting is definitely a bad idea. Fixed.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XGDropping events unnoticed when waiting is definitely a bad idea. Fixed.rr}r(h(jh*jubaubaubh)r }r (h(X7Clarification on implementing a GenerateEvents handler.r h*jh+hdh0hh2}r (h8]r h:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(j h*j h+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]X7Clarification on implementing a GenerateEvents handler.rr}r(h(j h*jubaubaubh)r}r (h(X"Optimized GenerateEvents handling.r!h*jh+hdh0hh2}r"(h8]r#h:]r$h6]r%h4]r&h<]r'uh?Nh@hh#]r(h)r)}r*(h(j!h*jh+hdh0hh2}r+(h8]r,h:]r-h6]r.h4]r/h<]r0uh?Kh#]r1h]X"Optimized GenerateEvents handling.r2r3}r4(h(j!h*j)ubaubaubh)r5}r6(h(X*Optimized management of FallbackGenerator.r7h*jh+hdh0hh2}r8(h8]r9h:]r:h6]r;h4]r<h<]r=uh?Nh@hh#]r>h)r?}r@(h(j7h*j5h+hdh0hh2}rA(h8]rBh:]rCh6]rDh4]rEh<]rFuh?Kh#]rGh]X*Optimized management of FallbackGenerator.rHrI}rJ(h(j7h*j?ubaubaubh)rK}rL(h(X Fixed a problem with events being out of sequence when _fire is called recursively. The fix exposes a problem with conftest.Waiter (events getting lost because they are produced too fast, therefore queue is increased). Reducing production rate will be in next commit.rMh*jh+hdh0hh2}rN(h8]rOh:]rPh6]rQh4]rRh<]rSuh?Nh@hh#]rTh)rU}rV(h(X Fixed a problem with events being out of sequence when _fire is called recursively. The fix exposes a problem with conftest.Waiter (events getting lost because they are produced too fast, therefore queue is increased). Reducing production rate will be in next commit.rWh*jKh+hdh0hh2}rX(h8]rYh:]rZh6]r[h4]r\h<]r]uh?Kh#]r^h]X Fixed a problem with events being out of sequence when _fire is called recursively. The fix exposes a problem with conftest.Waiter (events getting lost because they are produced too fast, therefore queue is increased). Reducing production rate will be in next commit.r_r`}ra(h(jWh*jUubaubaubh)rb}rc(h(X'Small fix for new event queue handling.rdh*jh+hdh0hh2}re(h8]rfh:]rgh6]rhh4]rih<]rjuh?Nh@hh#]rkh)rl}rm(h(jdh*jbh+hdh0hh2}rn(h8]roh:]rph6]rqh4]rrh<]rsuh?Kh#]rth]X'Small fix for new event queue handling.rurv}rw(h(jdh*jlubaubaubh)rx}ry(h(XFixed problem with handler cache update and concurrent event handling/structure changes. This happens e.g. in unit tests when the app is started and the test program adds or removes components concurrently.rzh*jh+hdh0hh2}r{(h8]r|h:]r}h6]r~h4]rh<]ruh?Nh@hh#]rh)r}r(h(XFixed problem with handler cache update and concurrent event handling/structure changes. This happens e.g. in unit tests when the app is started and the test program adds or removes components concurrently.rh*jxh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XFixed problem with handler cache update and concurrent event handling/structure changes. This happens e.g. in unit tests when the app is started and the test program adds or removes components concurrently.rr}r(h(jh*jubaubaubh)r}r(h(X2Optimized/clarified GenerateEvents implementation.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]X2Optimized/clarified GenerateEvents implementation.rr}r(h(jh*jubaubaubh)r}r(h(X#One more concurrency problem fixed.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]X#One more concurrency problem fixed.rr}r(h(jh*jubaubaubh)r}r(h(XFixed generate events handler.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XFixed generate events handler.rr}r(h(jh*jubaubaubh)r}r(h(XxFixed bug with handler cache being always invalidated. Avoid ``stop()`` acting as concurrent thread on ``_dispatcher()``rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XxFixed bug with handler cache being always invalidated. Avoid ``stop()`` acting as concurrent thread on ``_dispatcher()``rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]r(h]X=Fixed bug with handler cache being always invalidated. Avoid rr}r(h(X=Fixed bug with handler cache being always invalidated. Avoid rh*jubjK)r}r(h(X ``stop()``rh2}r(h8]rh:]rh6]rh4]rh<]ruh*jh#]rh]Xstop()rr}r(h(Uh*jubah0jYubh]X acting as concurrent thread on rr}r(h(X acting as concurrent thread on rh*jubjK)r}r(h(X``_dispatcher()``rh2}r(h8]rh:]rh6]r h4]r h<]r uh*jh#]r h]X _dispatcher()r r }r (h(Uh*jubah0jYubeubaubh)r }r (h(X9Fixed payload length calculation in web sockets protocol.r h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]X9Fixed payload length calculation in web sockets protocol.r r }r (h(j h*j ubaubaubh)r }r (h(XSome very small - but measurable - performance improvements. Checking them in mainly because now no one else needs to think about whether they have an effect.r h*jh+hdh0hh2}r (h8]r! h:]r" h6]r# h4]r$ h<]r% uh?Nh@hh#]r& h)r' }r( (h(XSome very small - but measurable - performance improvements. Checking them in mainly because now no one else needs to think about whether they have an effect.r) h*j h+hdh0hh2}r* (h8]r+ h:]r, h6]r- h4]r. h<]r/ uh?Kh#]r0 h]XSome very small - but measurable - performance improvements. Checking them in mainly because now no one else needs to think about whether they have an effect.r1 r2 }r3 (h(j) h*j' ubaubaubh)r4 }r5 (h(XBFixed IPv6 socket tests for OSX and badly configured IPv6 networksr6 h*jh+hdh0hh2}r7 (h8]r8 h:]r9 h6]r: h4]r; h<]r< uh?Nh@hh#]r= h)r> }r? (h(j6 h*j4 h+hdh0hh2}r@ (h8]rA h:]rB h6]rC h4]rD h<]rE uh?Kh#]rF h]XBFixed IPv6 socket tests for OSX and badly configured IPv6 networksrG rH }rI (h(j6 h*j> ubaubaubh)rJ }rK (h(X!Fixed ready handler for test_noderL h*jh+hdh0hh2}rM (h8]rN h:]rO h6]rP h4]rQ h<]rR uh?Nh@hh#]rS h)rT }rU (h(jL h*jJ h+hdh0hh2}rV (h8]rW h:]rX h6]rY h4]rZ h<]r[ uh?Kh#]r\ h]X!Fixed ready handler for test_noder] r^ }r_ (h(jL h*jT ubaubaubh)r` }ra (h(XgRe-added an old revived example of an IRC Client integrating the urwid curses library for the interfacerb h*jh+hdh0hh2}rc (h8]rd h:]re h6]rf h4]rg h<]rh uh?Nh@hh#]ri h)rj }rk (h(XgRe-added an old revived example of an IRC Client integrating the urwid curses library for the interfacerl h*j` h+hdh0hh2}rm (h8]rn h:]ro h6]rp h4]rq h<]rr uh?Kh#]rs h]XgRe-added an old revived example of an IRC Client integrating the urwid curses library for the interfacert ru }rv (h(jl h*jj ubaubaubh)rw }rx (h(XcAdded an example of using yield to perform cooperative multi-tasking inside a request event handlerry h*jh+hdh0hh2}rz (h8]r{ h:]r| h6]r} h4]r~ h<]r uh?Nh@hh#]r h)r }r (h(XcAdded an example of using yield to perform cooperative multi-tasking inside a request event handlerr h*jw h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XcAdded an example of using yield to perform cooperative multi-tasking inside a request event handlerr r }r (h(j h*j ubaubaubh)r }r (h(XUses echo for test_process r h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(XUses echo for test_processr h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XUses echo for test_processr r }r (h(j h*j ubaubaubh)r }r (h(XFixes process stdout/stderr handling Process was not waiting for all output from a process to have been processed and resulted sometimes some of the process output being lost while stopping. r h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(XFixes process stdout/stderr handling Process was not waiting for all output from a process to have been processed and resulted sometimes some of the process output being lost while stopping.r h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XFixes process stdout/stderr handling Process was not waiting for all output from a process to have been processed and resulted sometimes some of the process output being lost while stopping.r r }r (h(j h*j ubaubaubh)r }r (h(XPAdded a fall back error handler, so problems aren't discarded silently any more.r h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(XPAdded a fall back error handler, so problems aren't discarded silently any more.r h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XPAdded a fall back error handler, so problems aren't discarded silently any more.r r }r (h(j h*j ubaubaubh)r }r (h(XOFixed a TypeError being raised in the request handler for WebSockets dispatcherr h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(XOFixed a TypeError being raised in the request handler for WebSockets dispatcherr h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XOFixed a TypeError being raised in the request handler for WebSockets dispatcherr r }r (h(j h*j ubaubaubh)r }r (h(XPrevent the underlying TCPClient connect handler from inadvertently being triggered by connect events being fired to the web clientr h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(XPrevent the underlying TCPClient connect handler from inadvertently being triggered by connect events being fired to the web clientr h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XPrevent the underlying TCPClient connect handler from inadvertently being triggered by connect events being fired to the web clientr r }r (h(j h*j ubaubaubh)r }r (h(X/Added tox configuration file. Just run: ``tox``r h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r (h]X(Added tox configuration file. Just run: r r }r (h(X(Added tox configuration file. Just run: r h*j ubjK)r }r (h(X``tox``r h2}r (h8]r h:]r h6]r h4]r h<]r uh*j h#]r! h]Xtoxr" r# }r$ (h(Uh*j ubah0jYubeubaubh)r% }r& (h(X Configure tox to output junitxmlr' h*jh+hdh0hh2}r( (h8]r) h:]r* h6]r+ h4]r, h<]r- uh?Nh@hh#]r. h)r/ }r0 (h(j' h*j% h+hdh0hh2}r1 (h8]r2 h:]r3 h6]r4 h4]r5 h<]r6 uh?Kh#]r7 h]X Configure tox to output junitxmlr8 r9 }r: (h(j' h*j/ ubaubaubh)r; }r< (h(X6Fixed the logic of path -> wsgi dispatching in Gatewayr= h*jh+hdh0hh2}r> (h8]r? h:]r@ h6]rA h4]rB h<]rC uh?Nh@hh#]rD h)rE }rF (h(j= h*j; h+hdh0hh2}rG (h8]rH h:]rI h6]rJ h4]rK h<]rL uh?Kh#]rM h]X6Fixed the logic of path -> wsgi dispatching in GatewayrN rO }rP (h(j= h*jE ubaubaubh)rQ }rR (h(XFixed an awful bug with wrappers.Response whereby a default Content-Type was always set regardless and didn't allow anything else to set this.rS h*jh+hdh0hh2}rT (h8]rU h:]rV h6]rW h4]rX h<]rY uh?Nh@hh#]rZ h)r[ }r\ (h(XFixed an awful bug with wrappers.Response whereby a default Content-Type was always set regardless and didn't allow anything else to set this.r] h*jQ h+hdh0hh2}r^ (h8]r_ h:]r` h6]ra h4]rb h<]rc uh?Kh#]rd h]XFixed an awful bug with wrappers.Response whereby a default Content-Type was always set regardless and didn't allow anything else to set this.re rf }rg (h(j] h*j[ ubaubaubh)rh }ri (h(XBFixed test_disps so it doesn't use an existing port that's in use.rj h*jh+hdh0hh2}rk (h8]rl h:]rm h6]rn h4]ro h<]rp uh?Nh@hh#]rq h)rr }rs (h(jj h*jh h+hdh0hh2}rt (h8]ru h:]rv h6]rw h4]rx h<]ry uh?Kh#]rz h]XBFixed test_disps so it doesn't use an existing port that's in use.r{ r| }r} (h(jj h*jr ubaubaubh)r~ }r (h(XZAdded a missing piece of WSGI 1.0 functionality for wsgi.Gateway. The ``write()`` callabler h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(XZAdded a missing piece of WSGI 1.0 functionality for wsgi.Gateway. The ``write()`` callabler h*j~ h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r (h]XFAdded a missing piece of WSGI 1.0 functionality for wsgi.Gateway. The r r }r (h(XFAdded a missing piece of WSGI 1.0 functionality for wsgi.Gateway. The r h*j ubjK)r }r (h(X ``write()``r h2}r (h8]r h:]r h6]r h4]r h<]r uh*j h#]r h]Xwrite()r r }r (h(Uh*j ubah0jYubh]X callabler r }r (h(X callabler h*j ubeubaubh)r }r (h(XbRewrite test_filer unit test. Ensured EOF event is not triggered for files opened in a or + modes.r h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(XbRewrite test_filer unit test. Ensured EOF event is not triggered for files opened in a or + modes.r h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XbRewrite test_filer unit test. Ensured EOF event is not triggered for files opened in a or + modes.r r }r (h(j h*j ubaubaubh)r }r (h(X8Added simple examples demonstrating circuits' primitivesr h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]X8Added simple examples demonstrating circuits' primitivesr r }r (h(j h*j ubaubaubh)r }r (h(X%Added example of .fire(...) primitiver h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]X%Added example of .fire(...) primitiver r }r (h(j h*j ubaubaubh)r }r (h(XKRestructured circuits.io and implemented circuits.io.Process with unit testr h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XKRestructured circuits.io and implemented circuits.io.Process with unit testr r }r (h(j h*j ubaubaubh)r }r (h(X$Forgot to add test_process unit testr h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]X$Forgot to add test_process unit testr r }r (h(j h*j ubaubaubh)r }r (h(XAdded Hello World exampler h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r! (h(j h*j h+hdh0hh2}r" (h8]r# h:]r$ h6]r% h4]r& h<]r' uh?Kh#]r( h]XAdded Hello World exampler) r* }r+ (h(j h*j ubaubaubh)r, }r- (h(X'Fixed event handler for generate_eventsr. h*jh+hdh0hh2}r/ (h8]r0 h:]r1 h6]r2 h4]r3 h<]r4 uh?Nh@hh#]r5 h)r6 }r7 (h(j. h*j, h+hdh0hh2}r8 (h8]r9 h:]r: h6]r; h4]r< h<]r= uh?Kh#]r> h]X'Fixed event handler for generate_eventsr? r@ }rA (h(j. h*j6 ubaubaubh)rB }rC (h(XxImplemented multiprocessing support with communication via full duplex pipes. Fixed worker processes and added unit testrD h*jh+hdh0hh2}rE (h8]rF h:]rG h6]rH h4]rI h<]rJ uh?Nh@hh#]rK h)rL }rM (h(XxImplemented multiprocessing support with communication via full duplex pipes. Fixed worker processes and added unit testrN h*jB h+hdh0hh2}rO (h8]rP h:]rQ h6]rR h4]rS h<]rT uh?Kh#]rU h]XxImplemented multiprocessing support with communication via full duplex pipes. Fixed worker processes and added unit testrV rW }rX (h(jN h*jL ubaubaubh)rY }rZ (h(XgMade components started in process mode not link by default. Have to explicitly set the kwarg link=Truer[ h*jh+hdh0hh2}r\ (h8]r] h:]r^ h6]r_ h4]r` h<]ra uh?Nh@hh#]rb h)rc }rd (h(XgMade components started in process mode not link by default. Have to explicitly set the kwarg link=Truere h*jY h+hdh0hh2}rf (h8]rg h:]rh h6]ri h4]rj h<]rk uh?Kh#]rl h]XgMade components started in process mode not link by default. Have to explicitly set the kwarg link=Truerm rn }ro (h(je h*jc ubaubaubh)rp }rq (h(X'Fixed process pools and added unit testrr h*jh+hdh0hh2}rs (h8]rt h:]ru h6]rv h4]rw h<]rx uh?Nh@hh#]ry h)rz }r{ (h(jr h*jp h+hdh0hh2}r| (h8]r} h:]r~ h6]r h4]r h<]r uh?Kh#]r h]X'Fixed process pools and added unit testr r }r (h(jr h*jz ubaubaubh)r }r (h(XbFixed name of method for handling inotify events - conflicting with ._process of Manager/Componentr h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(XbFixed name of method for handling inotify events - conflicting with ._process of Manager/Componentr h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XbFixed name of method for handling inotify events - conflicting with ._process of Manager/Componentr r }r (h(j h*j ubaubaubh)r }r (h(XARenamed ._process to .__process so as to not conflict with Workerr h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XARenamed ._process to .__process so as to not conflict with Workerr r }r (h(j h*j ubaubaubh)r }r (h(X0Fixed raising of SystemExit or KeyboardInterruptr h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]X0Fixed raising of SystemExit or KeyboardInterruptr r }r (h(j h*j ubaubaubh)r }r (h(X:Trying to fix sending/receiving of events and their valuesr h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]X:Trying to fix sending/receiving of events and their valuesr r }r (h(j h*j ubaubaubh)r }r (h(XFixed IPv6 address evaluation.r h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XFixed IPv6 address evaluation.r r }r (h(j h*j ubaubaubh)r }r (h(X2WebSockets reimplemented as specified by RFC 6455.r h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]X2WebSockets reimplemented as specified by RFC 6455.r r }r (h(j h*j ubaubaubh)r }r (h(XModified the way caching works with the Statis dispatcher and serve_file(...) function. Set Last-Modified instead of a large Expires header.r h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(XModified the way caching works with the Statis dispatcher and serve_file(...) function. Set Last-Modified instead of a large Expires header.r h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XModified the way caching works with the Statis dispatcher and serve_file(...) function. Set Last-Modified instead of a large Expires header.r r }r! (h(j h*j ubaubaubh)r" }r# (h(X4Marked as a Missing Feature - still being worked on.r$ h*jh+hdh0hh2}r% (h8]r& h:]r' h6]r( h4]r) h<]r* uh?Nh@hh#]r+ h)r, }r- (h(j$ h*j" h+hdh0hh2}r. (h8]r/ h:]r0 h6]r1 h4]r2 h<]r3 uh?Kh#]r4 h]X4Marked as a Missing Feature - still being worked on.r5 r6 }r7 (h(j$ h*j, ubaubaubh)r8 }r9 (h(X_Brought back the ``circuits.core.bridge.Bridge``. With it better inter-process communications via high-speed full duplex pipes using ``circuits.net.sockets.Pipe`` (UNIX Only), a much simpler API. In addition, a chnage to the way Value Notification works. .notify of an event instance can either be True or a channel to send the ValueChanged event to.r: h*jh+hdh0hh2}r; (h8]r< h:]r= h6]r> h4]r? h<]r@ uh?Nh@hh#]rA (h)rB }rC (h(XBrought back the ``circuits.core.bridge.Bridge``. With it better inter-process communications via high-speed full duplex pipes using ``circuits.net.sockets.Pipe`` (UNIX Only), a much simpler API.rD h*j8 h+hdh0hh2}rE (h8]rF h:]rG h6]rH h4]rI h<]rJ uh?Kh#]rK (h]XBrought back the rL rM }rN (h(XBrought back the rO h*jB ubjK)rP }rQ (h(X``circuits.core.bridge.Bridge``rR h2}rS (h8]rT h:]rU h6]rV h4]rW h<]rX uh*jB h#]rY h]Xcircuits.core.bridge.BridgerZ r[ }r\ (h(Uh*jP ubah0jYubh]XU. With it better inter-process communications via high-speed full duplex pipes using r] r^ }r_ (h(XU. With it better inter-process communications via high-speed full duplex pipes using r` h*jB ubjK)ra }rb (h(X``circuits.net.sockets.Pipe``rc h2}rd (h8]re h:]rf h6]rg h4]rh h<]ri uh*jB h#]rj h]Xcircuits.net.sockets.Piperk rl }rm (h(Uh*ja ubah0jYubh]X! (UNIX Only), a much simpler API.rn ro }rp (h(X! (UNIX Only), a much simpler API.rq h*jB ubeubh)rr }rs (h(XIn addition, a chnage to the way Value Notification works. .notify of an event instance can either be True or a channel to send the ValueChanged event to.rt h*j8 h+hdh0hh2}ru (h8]rv h:]rw h6]rx h4]ry h<]rz uh?Kh#]r{ h]XIn addition, a chnage to the way Value Notification works. .notify of an event instance can either be True or a channel to send the ValueChanged event to.r| r} }r~ (h(jt h*jr ubaubeubh)r }r (h(X&Causes errors. Wrong thing to do here.r h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]X&Causes errors. Wrong thing to do here.r r }r (h(j h*j ubaubaubh)r }r (h(XUse uuid4 for worker channels.r h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XUse uuid4 for worker channels.r r }r (h(j h*j ubaubaubh)r }r (h(X Removed left over debugging coder h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]X Removed left over debugging coder r }r (h(j h*j ubaubaubh)r }r (h(XzAdded capability of components started in proces mode to link to artbritrary managers other than themselves (if link=True)r h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(XzAdded capability of components started in proces mode to link to artbritrary managers other than themselves (if link=True)r h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XzAdded capability of components started in proces mode to link to artbritrary managers other than themselves (if link=True)r r }r (h(j h*j ubaubaubh)r }r (h(XdAdded unit test for testing a component in process mode linked with another parent system separatelyr h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(XdAdded unit test for testing a component in process mode linked with another parent system separatelyr h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XdAdded unit test for testing a component in process mode linked with another parent system separatelyr r }r (h(j h*j ubaubaubh)r }r (h(X3Added timers examples ressurected from old circuitsr h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]X3Added timers examples ressurected from old circuitsr r }r (h(j h*j ubaubaubh)r }r (h(XThread safety for watcherr h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XThread safety for watcherr r }r (h(j h*j ubaubaubh)r }r (h(X#Reverts test_component_targeting.pyr h*jh+hdh0hh2}r (h8]r h:]r h6]r! h4]r" h<]r# uh?Nh@hh#]r$ h)r% }r& (h(j h*j h+hdh0hh2}r' (h8]r( h:]r) h6]r* h4]r+ h<]r, uh?Kh#]r- h]X#Reverts test_component_targeting.pyr. r/ }r0 (h(j h*j% ubaubaubh)r1 }r2 (h(X'Fixed Connection header interpretation.r3 h*jh+hdh0hh2}r4 (h8]r5 h:]r6 h6]r7 h4]r8 h<]r9 uh?Nh@hh#]r: h)r; }r< (h(j3 h*j1 h+hdh0hh2}r= (h8]r> h:]r? h6]r@ h4]rA h<]rB uh?Kh#]rC h]X'Fixed Connection header interpretation.rD rE }rF (h(j3 h*j; ubaubaubh)rG }rH (h(X$Updated documentation for WebSocket.rI h*jh+hdh0hh2}rJ (h8]rK h:]rL h6]rM h4]rN h<]rO uh?Nh@hh#]rP h)rQ }rR (h(jI h*jG h+hdh0hh2}rS (h8]rT h:]rU h6]rV h4]rW h<]rX uh?Kh#]rY h]X$Updated documentation for WebSocket.rZ r[ }r\ (h(jI h*jQ ubaubaubh)r] }r^ (h(XPChanged the way process linking works by not starting the parent in thread mode.r_ h*jh+hdh0hh2}r` (h8]ra h:]rb h6]rc h4]rd h<]re uh?Nh@hh#]rf h)rg }rh (h(XPChanged the way process linking works by not starting the parent in thread mode.ri h*j] h+hdh0hh2}rj (h8]rk h:]rl h6]rm h4]rn h<]ro uh?Kh#]rp h]XPChanged the way process linking works by not starting the parent in thread mode.rq rr }rs (h(ji h*jg ubaubaubh)rt }ru (h(XFixes watcher test fixturerv h*jh+hdh0hh2}rw (h8]rx h:]ry h6]rz h4]r{ h<]r| uh?Nh@hh#]r} h)r~ }r (h(jv h*jt h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XFixes watcher test fixturer r }r (h(jv h*j~ ubaubaubh)r }r (h(XKImplemented .handlers() and re-implemented .handles(). [Delivers #41573841]r h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XKImplemented .handlers() and re-implemented .handles(). [Delivers #41573841]r r }r (h(j h*j ubaubaubh)r }r (h(XRemoved superfluous bridge testr h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XRemoved superfluous bridge testr r }r (h(j h*j ubaubaubh)r }r (h(X6Fixed usage of .start starting Workers in process moder h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]X6Fixed usage of .start starting Workers in process moder r }r (h(j h*j ubaubaubh)r }r (h(XBetter internal variable namer h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]XBetter internal variable namer r }r (h(j h*j ubaubaubh)r }r (h(X\Start worked either when the system starts or we are regsitered to an already started systemr h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(X\Start worked either when the system starts or we are regsitered to an already started systemr h*j h+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Kh#]r h]X\Start worked either when the system starts or we are regsitered to an already started systemr r }r (h(j h*j ubaubaubh)r }r (h(X!Implemented .handlers() correctlyr h*jh+hdh0hh2}r (h8]r h:]r h6]r h4]rh<]ruh?Nh@hh#]rh)r}r(h(j h*j h+hdh0hh2}r(h8]rh:]rh6]rh4]r h<]r uh?Kh#]r h]X!Implemented .handlers() correctlyr r }r(h(j h*jubaubaubh)r}r(h(XBSet unique channels for the Pipe and Bridge when briding processesrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]r uh?Kh#]r!h]XBSet unique channels for the Pipe and Bridge when briding processesr"r#}r$(h(jh*jubaubaubh)r%}r&(h(X&Removed. Going to reimplement all thisr'h*jh+hdh0hh2}r((h8]r)h:]r*h6]r+h4]r,h<]r-uh?Nh@hh#]r.h)r/}r0(h(j'h*j%h+hdh0hh2}r1(h8]r2h:]r3h6]r4h4]r5h<]r6uh?Kh#]r7h]X&Removed. Going to reimplement all thisr8r9}r:(h(j'h*j/ubaubaubh)r;}r<(h(X Don't cause a nastry fork bomb\!r=h*jh+hdh0hh2}r>(h8]r?h:]r@h6]rAh4]rBh<]rCuh?Nh@hh#]rDh)rE}rF(h(j=h*j;h+hdh0hh2}rG(h8]rHh:]rIh6]rJh4]rKh<]rLuh?Kh#]rMh]XDon't cause a nastry fork bomb!rNrO}rP(h(X Don't cause a nastry fork bomb\!rQh*jEubaubaubh)rR}rS(h(X>Marked test_process_pool as skipping XXX: Broken FunctionalityrTh*jh+hdh0hh2}rU(h8]rVh:]rWh6]rXh4]rYh<]rZuh?Nh@hh#]r[h)r\}r](h(jTh*jRh+hdh0hh2}r^(h8]r_h:]r`h6]rah4]rbh<]rcuh?Kh#]rdh]X>Marked test_process_pool as skipping XXX: Broken Functionalityrerf}rg(h(jTh*j\ubaubaubh)rh}ri(h(XJFixed sleeping when nothing to do adding needs_resume logic to the pollersrjh*jh+hdh0hh2}rk(h8]rlh:]rmh6]rnh4]roh<]rpuh?Nh@hh#]rqh)rr}rs(h(jjh*jhh+hdh0hh2}rt(h8]ruh:]rvh6]rwh4]rxh<]ryuh?Kh#]rzh]XJFixed sleeping when nothing to do adding needs_resume logic to the pollersr{r|}r}(h(jjh*jrubaubaubh)r~}r(h(XAProposed new Worker Component -- wrapping multiprocessing.Processrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*j~h+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XAProposed new Worker Component -- wrapping multiprocessing.Processrr}r(h(jh*jubaubaubh)r}r(h(XAccidentla commitrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XAccidentla commitrr}r(h(jh*jubaubaubh)r}r(h(XTrying to re-implement Pool...rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XTrying to re-implement Pool...rr}r(h(jh*jubaubaubh)r}r(h(XMarked some tests as brokenrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XMarked some tests as brokenrr}r(h(jh*jubaubaubh)r}r(h(XLAdded support for both Process and Thread in Worker component with same API.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XLAdded support for both Process and Thread in Worker component with same API.rr}r(h(jh*jubaubaubh)r}r(h(X/Reverted changes to the task handler for Workerrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]X/Reverted changes to the task handler for Workerrr}r(h(jh*jubaubaubh)r}r(h(XRemoved .resume()rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]r h<]r uh?Nh@hh#]r h)r }r (h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XRemoved .resume()rr}r(h(jh*j ubaubaubh)r}r(h(XFixed some brokeness in futurerh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]r uh?Nh@hh#]r!h)r"}r#(h(jh*jh+hdh0hh2}r$(h8]r%h:]r&h6]r'h4]r(h<]r)uh?Kh#]r*h]XFixed some brokeness in futurer+r,}r-(h(jh*j"ubaubaubh)r.}r/(h(X7Trying to make @future work with Worker in process moder0h*jh+hdh0hh2}r1(h8]r2h:]r3h6]r4h4]r5h<]r6uh?Nh@hh#]r7h)r8}r9(h(j0h*j.h+hdh0hh2}r:(h8]r;h:]r<h6]r=h4]r>h<]r?uh?Kh#]r@h]X7Trying to make @future work with Worker in process moderArB}rC(h(j0h*j8ubaubaubh)rD}rE(h(X Lock benchrFh*jh+hdh0hh2}rG(h8]rHh:]rIh6]rJh4]rKh<]rLuh?Nh@hh#]rMh)rN}rO(h(jFh*jDh+hdh0hh2}rP(h8]rQh:]rRh6]rSh4]rTh<]rUuh?Kh#]rVh]X Lock benchrWrX}rY(h(jFh*jNubaubaubh)rZ}r[(h(XSwitches worker to apply_asyncr\h*jh+hdh0hh2}r](h8]r^h:]r_h6]r`h4]rah<]rbuh?Nh@hh#]rch)rd}re(h(j\h*jZh+hdh0hh2}rf(h8]rgh:]rhh6]rih4]rjh<]rkuh?Kh#]rlh]XSwitches worker to apply_asyncrmrn}ro(h(j\h*jdubaubaubh)rp}rq(h(X0Allow the poller to sleep when tasks are runningrrh*jh+hdh0hh2}rs(h8]rth:]ruh6]rvh4]rwh<]rxuh?Nh@hh#]ryh)rz}r{(h(jrh*jph+hdh0hh2}r|(h8]r}h:]r~h6]rh4]rh<]ruh?Kh#]rh]X0Allow the poller to sleep when tasks are runningrr}r(h(jrh*jzubaubaubh)r}r(h(X!Use ThreadPool for worker threadsrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]X!Use ThreadPool for worker threadsrr}r(h(jh*jubaubaubh)r}r(h(XCleaned up Workerrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XCleaned up Workerrr}r(h(jh*jubaubaubh)r}r(h(Xbenchmark only branchrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]Xbenchmark only branchrr}r(h(jh*jubaubaubh)r}r(h(X Removed pool - covered by workerrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]X Removed pool - covered by workerrr}r(h(jh*jubaubaubh)r}r(h(X<Workaround for Threadpool bug started from secondary threadsrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]X<Workaround for Threadpool bug started from secondary threadsrr}r(h(jh*jubaubaubh)r}r(h(XFixed dispatchers return value.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XFixed dispatchers return value.rr}r (h(jh*jubaubaubh)r }r (h(XwFiring Connect event when a web socket connection is established to make behavior look even more like ordinary sockets.r h*jh+hdh0hh2}r (h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XwFiring Connect event when a web socket connection is established to make behavior look even more like ordinary sockets.rh*j h+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XwFiring Connect event when a web socket connection is established to make behavior look even more like ordinary sockets.rr}r (h(jh*jubaubaubh)r!}r"(h(X[Restored 2.0.1 GenerateEvents handling with minor enhancements to get things working again.r#h*jh+hdh0hh2}r$(h8]r%h:]r&h6]r'h4]r(h<]r)uh?Nh@hh#]r*h)r+}r,(h(X[Restored 2.0.1 GenerateEvents handling with minor enhancements to get things working again.r-h*j!h+hdh0hh2}r.(h8]r/h:]r0h6]r1h4]r2h<]r3uh?Mh#]r4h]X[Restored 2.0.1 GenerateEvents handling with minor enhancements to get things working again.r5r6}r7(h(j-h*j+ubaubaubh)r8}r9(h(X?Nuked @future decotator due to pickling problems for processes.r:h*jh+hdh0hh2}r;(h8]r<h:]r=h6]r>h4]r?h<]r@uh?Nh@hh#]rAh)rB}rC(h(j:h*j8h+hdh0hh2}rD(h8]rEh:]rFh6]rGh4]rHh<]rIuh?Mh#]rJh]X?Nuked @future decotator due to pickling problems for processes.rKrL}rM(h(j:h*jBubaubaubh)rN}rO(h(X3Unmarked test as failing. Test now passes prefectlyrPh*jh+hdh0hh2}rQ(h8]rRh:]rSh6]rTh4]rUh<]rVuh?Nh@hh#]rWh)rX}rY(h(jPh*jNh+hdh0hh2}rZ(h8]r[h:]r\h6]r]h4]r^h<]r_uh?Mh#]r`h]X3Unmarked test as failing. Test now passes prefectlyrarb}rc(h(jPh*jXubaubaubh)rd}re(h(X`Allow coroutine-style tasks to terminate the system via raise of SystemExit or KeyboardINterruptrfh*jh+hdh0hh2}rg(h8]rhh:]rih6]rjh4]rkh<]rluh?Nh@hh#]rmh)rn}ro(h(X`Allow coroutine-style tasks to terminate the system via raise of SystemExit or KeyboardINterruptrph*jdh+hdh0hh2}rq(h8]rrh:]rsh6]rth4]ruh<]rvuh?Mh#]rwh]X`Allow coroutine-style tasks to terminate the system via raise of SystemExit or KeyboardINterruptrxry}rz(h(jph*jnubaubaubh)r{}r|(h(X7Fixed SSL support for circuits.web [Delivers #42007509]r}h*jh+hdh0hh2}r~(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(j}h*j{h+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]X7Fixed SSL support for circuits.web [Delivers #42007509]rr}r(h(j}h*jubaubaubh)r}r(h(XGDropping events unnoticed when waiting is definitely a bad idea. Fixed.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M h#]rh]XGDropping events unnoticed when waiting is definitely a bad idea. Fixed.rr}r(h(jh*jubaubaubh)r}r(h(X7Clarification on implementing a GenerateEvents handler.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M h#]rh]X7Clarification on implementing a GenerateEvents handler.rr}r(h(jh*jubaubaubh)r}r(h(XZAdded missing import (timed wait with FallBackGenerator cannot have worked for some time).rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XZAdded missing import (timed wait with FallBackGenerator cannot have worked for some time).rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M h#]rh]XZAdded missing import (timed wait with FallBackGenerator cannot have worked for some time).rr}r(h(jh*jubaubaubh)r}r(h(X"Optimized GenerateEvents handling.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M h#]rh]X"Optimized GenerateEvents handling.rr}r(h(jh*jubaubaubh)r}r(h(X)Backed out of changeset 3413:98d0056ef18arh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]X)Backed out of changeset 3413:98d0056ef18arr}r(h(jh*jubaubaubh)r}r(h(X*Optimized management of FallbackGenerator.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]r h)r }r (h(jh*jh+hdh0hh2}r (h8]r h:]rh6]rh4]rh<]ruh?Mh#]rh]X*Optimized management of FallbackGenerator.rr}r(h(jh*j ubaubaubh)r}r(h(X Fixed a problem with events being out of sequence when _fire is called recursively. The fix exposes a problem with conftest.Waiter (events getting lost because they are produced too fast, therefore queue is increased). Reducing production rate will be in next commit.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r }r!(h(X Fixed a problem with events being out of sequence when _fire is called recursively. The fix exposes a problem with conftest.Waiter (events getting lost because they are produced too fast, therefore queue is increased). Reducing production rate will be in next commit.r"h*jh+hdh0hh2}r#(h8]r$h:]r%h6]r&h4]r'h<]r(uh?Mh#]r)h]X Fixed a problem with events being out of sequence when _fire is called recursively. The fix exposes a problem with conftest.Waiter (events getting lost because they are produced too fast, therefore queue is increased). Reducing production rate will be in next commit.r*r+}r,(h(j"h*j ubaubaubh)r-}r.(h(X'Small fix for new event queue handling.r/h*jh+hdh0hh2}r0(h8]r1h:]r2h6]r3h4]r4h<]r5uh?Nh@hh#]r6h)r7}r8(h(j/h*j-h+hdh0hh2}r9(h8]r:h:]r;h6]r<h4]r=h<]r>uh?Mh#]r?h]X'Small fix for new event queue handling.r@rA}rB(h(j/h*j7ubaubaubh)rC}rD(h(XFixed problem with handler cache update and concurrent event handling/structure changes. This happens e.g. in unit tests when the app is started and the test program adds or removes components concurrently.rEh*jh+hdh0hh2}rF(h8]rGh:]rHh6]rIh4]rJh<]rKuh?Nh@hh#]rLh)rM}rN(h(XFixed problem with handler cache update and concurrent event handling/structure changes. This happens e.g. in unit tests when the app is started and the test program adds or removes components concurrently.rOh*jCh+hdh0hh2}rP(h8]rQh:]rRh6]rSh4]rTh<]rUuh?Mh#]rVh]XFixed problem with handler cache update and concurrent event handling/structure changes. This happens e.g. in unit tests when the app is started and the test program adds or removes components concurrently.rWrX}rY(h(jOh*jMubaubaubh)rZ}r[(h(X2Optimized/clarified GenerateEvents implementation.r\h*jh+hdh0hh2}r](h8]r^h:]r_h6]r`h4]rah<]rbuh?Nh@hh#]rch)rd}re(h(j\h*jZh+hdh0hh2}rf(h8]rgh:]rhh6]rih4]rjh<]rkuh?Mh#]rlh]X2Optimized/clarified GenerateEvents implementation.rmrn}ro(h(j\h*jdubaubaubh)rp}rq(h(X#One more concurrency problem fixed.rrh*jh+hdh0hh2}rs(h8]rth:]ruh6]rvh4]rwh<]rxuh?Nh@hh#]ryh)rz}r{(h(jrh*jph+hdh0hh2}r|(h8]r}h:]r~h6]rh4]rh<]ruh?Mh#]rh]X#One more concurrency problem fixed.rr}r(h(jrh*jzubaubaubh)r}r(h(XFixed generate events handler.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XFixed generate events handler.rr}r(h(jh*jubaubaubh)r}r(h(XqFixed bug with handler cache being always invalidated. Avoid stop() acting as concurrent thread on _dispatcher().rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XqFixed bug with handler cache being always invalidated. Avoid stop() acting as concurrent thread on _dispatcher().rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XqFixed bug with handler cache being always invalidated. Avoid stop() acting as concurrent thread on _dispatcher().rr}r(h(jh*jubaubaubh)r}r(h(XlAdded unit test for url quoting of static files for the static circuits.web dispatcher. [Delivers #41882655]rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XlAdded unit test for url quoting of static files for the static circuits.web dispatcher. [Delivers #41882655]rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XlAdded unit test for url quoting of static files for the static circuits.web dispatcher. [Delivers #41882655]rr}r(h(jh*jubaubaubh)r}r(h(XDAdded unit test for secure circutis.web server. [Delivers #42849393]rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M h#]rh]XDAdded unit test for secure circutis.web server. [Delivers #42849393]rr}r(h(jh*jubaubaubh)r}r(h(XKFixed creation/registration/location of poller upon startup or registrationrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M!h#]rh]XKFixed creation/registration/location of poller upon startup or registrationrr}r(h(jh*jubaubaubh)r}r(h(X/Skip test_secure_server if ssl is not availablerh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M"h#]rh]X/Skip test_secure_server if ssl is not availabler r }r (h(jh*jubaubaubh)r }r (h(X9Fixed payload length calculation in web sockets protocol.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*j h+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M#h#]rh]X9Fixed payload length calculation in web sockets protocol.rr }r!(h(jh*jubaubaubh)r"}r#(h(XSome very small - but measurable - performance improvements. Checking them in mainly because now no one else needs to think about whether they have an effect.r$h*jh+hdh0hh2}r%(h8]r&h:]r'h6]r(h4]r)h<]r*uh?Nh@hh#]r+h)r,}r-(h(XSome very small - but measurable - performance improvements. Checking them in mainly because now no one else needs to think about whether they have an effect.r.h*j"h+hdh0hh2}r/(h8]r0h:]r1h6]r2h4]r3h<]r4uh?M$h#]r5h]XSome very small - but measurable - performance improvements. Checking them in mainly because now no one else needs to think about whether they have an effect.r6r7}r8(h(j.h*j,ubaubaubh)r9}r:(h(XFixed conflicting attribute.r;h*jh+hdh0hh2}r<(h8]r=h:]r>h6]r?h4]r@h<]rAuh?Nh@hh#]rBh)rC}rD(h(j;h*j9h+hdh0hh2}rE(h8]rFh:]rGh6]rHh4]rIh<]rJuh?M'h#]rKh]XFixed conflicting attribute.rLrM}rN(h(j;h*jCubaubaubh)rO}rP(h(XYAdded new .pid property to Manager fixing tests.core.test_bridge - Broken by 70677b69bf05rQh*jh+hdh0hh2}rR(h8]rSh:]rTh6]rUh4]rVh<]rWuh?Nh@hh#]rXh)rY}rZ(h(XYAdded new .pid property to Manager fixing tests.core.test_bridge - Broken by 70677b69bf05r[h*jOh+hdh0hh2}r\(h8]r]h:]r^h6]r_h4]r`h<]rauh?M(h#]rbh]XYAdded new .pid property to Manager fixing tests.core.test_bridge - Broken by 70677b69bf05rcrd}re(h(j[h*jYubaubaubh)rf}rg(h(XBFixed ipv6 socket tests for OSX and badly configured IPv6 networksrhh*jh+hdh0hh2}ri(h8]rjh:]rkh6]rlh4]rmh<]rnuh?Nh@hh#]roh)rp}rq(h(jhh*jfh+hdh0hh2}rr(h8]rsh:]rth6]ruh4]rvh<]rwuh?M*h#]rxh]XBFixed ipv6 socket tests for OSX and badly configured IPv6 networksryrz}r{(h(jhh*jpubaubaubh)r|}r}(h(XUgly fix for this testr~h*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(j~h*j|h+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M+h#]rh]XUgly fix for this testrr}r(h(j~h*jubaubaubh)r}r(h(X!Fixed ready handler for test_noderh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M,h#]rh]X!Fixed ready handler for test_noderr}r(h(jh*jubaubaubh)r}r(h(XfFor some reason removing max_events in the Watcher fixture for esting purposes fixes some tests on OSXrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XfFor some reason removing max_events in the Watcher fixture for esting purposes fixes some tests on OSXrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M-h#]rh]XfFor some reason removing max_events in the Watcher fixture for esting purposes fixes some tests on OSXrr}r(h(jh*jubaubaubh)r}r(h(X2Small sample to hopefully test for memory leaks :)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M/h#]rh]X2Small sample to hopefully test for memory leaks :)rr}r(h(jh*jubaubaubh)r}r(h(XrImproved .handlers() to recursively return handlers of it's subclasses whilst filtering out private handlers (_.*)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XrImproved .handlers() to recursively return handlers of it's subclasses whilst filtering out private handlers (_.*)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M0h#]rh]XrImproved .handlers() to recursively return handlers of it's subclasses whilst filtering out private handlers (_.*)rr}r(h(jh*jubaubaubh)r}r(h(X9Use BaseComponent for convenience for non-handler methodsrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M2h#]rh]X9Use BaseComponent for convenience for non-handler methodsrr}r(h(jh*jubaubaubh)r}r(h(XIReturn a list of all handlers except handlers listneing to private eventsrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]r h<]r uh?Nh@hh#]r h)r }r (h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M3h#]rh]XIReturn a list of all handlers except handlers listneing to private eventsrr}r(h(jh*j ubaubaubh)r}r(h(XLeft over print - oops :)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]r uh?Nh@hh#]r!h)r"}r#(h(jh*jh+hdh0hh2}r$(h8]r%h:]r&h6]r'h4]r(h<]r)uh?M4h#]r*h]XLeft over print - oops :)r+r,}r-(h(jh*j"ubaubaubh)r.}r/(h(XMoved to examples/r0h*jh+hdh0hh2}r1(h8]r2h:]r3h6]r4h4]r5h<]r6uh?Nh@hh#]r7h)r8}r9(h(j0h*j.h+hdh0hh2}r:(h8]r;h:]r<h6]r=h4]r>h<]r?uh?M5h#]r@h]XMoved to examples/rArB}rC(h(j0h*j8ubaubaubh)rD}rE(h(XgRe-added an old revived example of an IRC Client integrating the urwid curses library for the interfacerFh*jh+hdh0hh2}rG(h8]rHh:]rIh6]rJh4]rKh<]rLuh?Nh@hh#]rMh)rN}rO(h(XgRe-added an old revived example of an IRC Client integrating the urwid curses library for the interfacerPh*jDh+hdh0hh2}rQ(h8]rRh:]rSh6]rTh4]rUh<]rVuh?M6h#]rWh]XgRe-added an old revived example of an IRC Client integrating the urwid curses library for the interfacerXrY}rZ(h(jPh*jNubaubaubh)r[}r\(h(XImproved comment.r]h*jh+hdh0hh2}r^(h8]r_h:]r`h6]rah4]rbh<]rcuh?Nh@hh#]rdh)re}rf(h(j]h*j[h+hdh0hh2}rg(h8]rhh:]rih6]rjh4]rkh<]rluh?M8h#]rmh]XImproved comment.rnro}rp(h(j]h*jeubaubaubh)rq}rr(h(XFAdded multi-add support for Gateway web compnoent [Delivers #40071339]rsh*jh+hdh0hh2}rt(h8]ruh:]rvh6]rwh4]rxh<]ryuh?Nh@hh#]rzh)r{}r|(h(jsh*jqh+hdh0hh2}r}(h8]r~h:]rh6]rh4]rh<]ruh?M9h#]rh]XFAdded multi-add support for Gateway web compnoent [Delivers #40071339]rr}r(h(jsh*j{ubaubaubh)r}r(h(XRFixed Python 3 compatibility for retrieving the .resumse() method. Fixes Issue #35rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XRFixed Python 3 compatibility for retrieving the .resumse() method. Fixes Issue #35rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M:h#]rh]XRFixed Python 3 compatibility for retrieving the .resumse() method. Fixes Issue #35rr}r(h(jh*jubaubaubh)r}r(h(XRemoved unused StringIO importrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M<h#]rh]XRemoved unused StringIO importrr}r(h(jh*jubaubaubh)r}r(h(X?A bunch of Python 3.1 compatibility fixes (mostly import fixes)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M=h#]rh]X?A bunch of Python 3.1 compatibility fixes (mostly import fixes)rr}r(h(jh*jubaubaubh)r}r(h(XcAdded an example of using yield to perform cooperative multi-tasking inside a request event handlerrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XcAdded an example of using yield to perform cooperative multi-tasking inside a request event handlerrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M>h#]rh]XcAdded an example of using yield to perform cooperative multi-tasking inside a request event handlerrr}r(h(jh*jubaubaubh)r}r(h(XUses echo for test_processrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M@h#]rh]XUses echo for test_processrr}r(h(jh*jubaubaubh)r}r(h(XFixes process stdout/stderr handling Process was not waiting for all output from a process to have been processed and resulted sometimes some of the process output being lost while stopping.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XFixes process stdout/stderr handling Process was not waiting for all output from a process to have been processed and resulted sometimes some of the process output being lost while stopping.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]r uh?MAh#]r h]XFixes process stdout/stderr handling Process was not waiting for all output from a process to have been processed and resulted sometimes some of the process output being lost while stopping.r r }r (h(jh*jubaubaubh)r}r(h(X7A bunch more Python 3 fixes. Using the six module here.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?MEh#]r h]X7A bunch more Python 3 fixes. Using the six module here.r!r"}r#(h(jh*jubaubaubh)r$}r%(h(XPAdded a fall back error handler, so problems aren't discarded silently any more.r&h*jh+hdh0hh2}r'(h8]r(h:]r)h6]r*h4]r+h<]r,uh?Nh@hh#]r-h)r.}r/(h(XPAdded a fall back error handler, so problems aren't discarded silently any more.r0h*j$h+hdh0hh2}r1(h8]r2h:]r3h6]r4h4]r5h<]r6uh?MFh#]r7h]XPAdded a fall back error handler, so problems aren't discarded silently any more.r8r9}r:(h(j0h*j.ubaubaubh)r;}r<(h(XOoops accidently committed thisr=h*jh+hdh0hh2}r>(h8]r?h:]r@h6]rAh4]rBh<]rCuh?Nh@hh#]rDh)rE}rF(h(j=h*j;h+hdh0hh2}rG(h8]rHh:]rIh6]rJh4]rKh<]rLuh?MHh#]rMh]XOoops accidently committed thisrNrO}rP(h(j=h*jEubaubaubh)rQ}rR(h(X!Fixed some Python 3 import issuesrSh*jh+hdh0hh2}rT(h8]rUh:]rVh6]rWh4]rXh<]rYuh?Nh@hh#]rZh)r[}r\(h(jSh*jQh+hdh0hh2}r](h8]r^h:]r_h6]r`h4]rah<]rbuh?MIh#]rch]X!Fixed some Python 3 import issuesrdre}rf(h(jSh*j[ubaubaubh)rg}rh(h(XMore Python 3 fixesrih*jh+hdh0hh2}rj(h8]rkh:]rlh6]rmh4]rnh<]rouh?Nh@hh#]rph)rq}rr(h(jih*jgh+hdh0hh2}rs(h8]rth:]ruh6]rvh4]rwh<]rxuh?MJh#]ryh]XMore Python 3 fixesrzr{}r|(h(jih*jqubaubaubh)r}}r~(h(X#Fixed Python 3 issue with iteratorsrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*j}h+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?MKh#]rh]X#Fixed Python 3 issue with iteratorsrr}r(h(jh*jubaubaubh)r}r(h(X$Use range for Python 3 compatibilityrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?MLh#]rh]X$Use range for Python 3 compatibilityrr}r(h(jh*jubaubaubh)r}r(h(X$Fixed assertions for Python 3 compatrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?MMh#]rh]X$Fixed assertions for Python 3 compatrr}r(h(jh*jubaubaubh)r}r(h(X(Accidently commited a test with Debuggerrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?MNh#]rh]X(Accidently commited a test with Debuggerrr}r(h(jh*jubaubaubh)r}r(h(XPFixed value_changed handler to check correctly for binary types (Python 3 fixes)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XPFixed value_changed handler to check correctly for binary types (Python 3 fixes)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?MOh#]rh]XPFixed value_changed handler to check correctly for binary types (Python 3 fixes)rr}r(h(jh*jubaubaubh)r}r(h(X%Python 3 fixes for string type checksrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?MQh#]rh]X%Python 3 fixes for string type checksrr}r(h(jh*jubaubaubh)r}r(h(XRefactored for Python 3rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]r h<]r uh?Nh@hh#]r h)r }r (h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?MRh#]rh]XRefactored for Python 3rr}r(h(jh*j ubaubaubh)r}r(h(X:More Python 3 fixes. Marked the rest as Broken on Python 3rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]r uh?Nh@hh#]r!h)r"}r#(h(jh*jh+hdh0hh2}r$(h8]r%h:]r&h6]r'h4]r(h<]r)uh?MSh#]r*h]X:More Python 3 fixes. Marked the rest as Broken on Python 3r+r,}r-(h(jh*j"ubaubaubh)r.}r/(h(XdFixed broken web tests for Python 3 by wrapping the request body in a TextIOWrapper for FieldStorager0h*jh+hdh0hh2}r1(h8]r2h:]r3h6]r4h4]r5h<]r6uh?Nh@hh#]r7h)r8}r9(h(XdFixed broken web tests for Python 3 by wrapping the request body in a TextIOWrapper for FieldStorager:h*j.h+hdh0hh2}r;(h8]r<h:]r=h6]r>h4]r?h<]r@uh?MTh#]rAh]XdFixed broken web tests for Python 3 by wrapping the request body in a TextIOWrapper for FieldStoragerBrC}rD(h(j:h*j8ubaubaubh)rE}rF(h(X/Fixed XML and JSON RPC Dispatchers for Python 3rGh*jh+hdh0hh2}rH(h8]rIh:]rJh6]rKh4]rLh<]rMuh?Nh@hh#]rNh)rO}rP(h(jGh*jEh+hdh0hh2}rQ(h8]rRh:]rSh6]rTh4]rUh<]rVuh?MVh#]rWh]X/Fixed XML and JSON RPC Dispatchers for Python 3rXrY}rZ(h(jGh*jOubaubaubh)r[}r\(h(X5Replace .has_key() with in for Python 3 compatibilityr]h*jh+hdh0hh2}r^(h8]r_h:]r`h6]rah4]rbh<]rcuh?Nh@hh#]rdh)re}rf(h(j]h*j[h+hdh0hh2}rg(h8]rhh:]rih6]rjh4]rkh<]rluh?MWh#]rmh]X5Replace .has_key() with in for Python 3 compatibilityrnro}rp(h(j]h*jeubaubaubh)rq}rr(h(XOFixed a TypeError being raised in the request handler for websockets dispatcherrsh*jh+hdh0hh2}rt(h8]ruh:]rvh6]rwh4]rxh<]ryuh?Nh@hh#]rzh)r{}r|(h(XOFixed a TypeError being raised in the request handler for websockets dispatcherr}h*jqh+hdh0hh2}r~(h8]rh:]rh6]rh4]rh<]ruh?MXh#]rh]XOFixed a TypeError being raised in the request handler for websockets dispatcherrr}r(h(j}h*j{ubaubaubh)r}r(h(XPrevent the underlying TCPClient connect handler from inadvertently being triggered by connec events being fired to the web clientrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XPrevent the underlying TCPClient connect handler from inadvertently being triggered by connec events being fired to the web clientrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?MZh#]rh]XPrevent the underlying TCPClient connect handler from inadvertently being triggered by connec events being fired to the web clientrr}r(h(jh*jubaubaubh)r}r(h(X2Unmarked as skipping. No longer broken on Python 3rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M\h#]rh]X2Unmarked as skipping. No longer broken on Python 3rr}r(h(jh*jubaubaubh)r}r(h(X"Finished cleaning up my code base.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M]h#]rh]X"Finished cleaning up my code base.rr}r(h(jh*jubaubaubh)r}r(h(X:Removed some debugging junk I had forgotten to get rid of.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M^h#]rh]X:Removed some debugging junk I had forgotten to get rid of.rr}r(h(jh*jubaubaubh)r}r(h(X@Fixed File for Python 3 support adding optional encoding supportrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M_h#]rh]X@Fixed File for Python 3 support adding optional encoding supportrr}r(h(jh*jubaubaubh)r}r(h(XFixed Process for Python 3rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M`h#]r h]XFixed Process for Python 3r r }r (h(jh*jubaubaubh)r }r(h(XOoops :/rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*j h+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mah#]rh]XOoops :/r r!}r"(h(jh*jubaubaubh)r#}r$(h(X$Fixed test_logger_Error for Python 3r%h*jh+hdh0hh2}r&(h8]r'h:]r(h6]r)h4]r*h<]r+uh?Nh@hh#]r,h)r-}r.(h(j%h*j#h+hdh0hh2}r/(h8]r0h:]r1h6]r2h4]r3h<]r4uh?Mbh#]r5h]X$Fixed test_logger_Error for Python 3r6r7}r8(h(j%h*j-ubaubaubh)r9}r:(h(XFixed Bridge for Python 3r;h*jh+hdh0hh2}r<(h8]r=h:]r>h6]r?h4]r@h<]rAuh?Nh@hh#]rBh)rC}rD(h(j;h*j9h+hdh0hh2}rE(h8]rFh:]rGh6]rHh4]rIh<]rJuh?Mch#]rKh]XFixed Bridge for Python 3rLrM}rN(h(j;h*jCubaubaubh)rO}rP(h(XFixed Node for Python 3rQh*jh+hdh0hh2}rR(h8]rSh:]rTh6]rUh4]rVh<]rWuh?Nh@hh#]rXh)rY}rZ(h(jQh*jOh+hdh0hh2}r[(h8]r\h:]r]h6]r^h4]r_h<]r`uh?Mdh#]rah]XFixed Node for Python 3rbrc}rd(h(jQh*jYubaubaubh)re}rf(h(X`Added pytest.PYVER and Marked test_secure_server web test as Broken on Python 3.2 (needs fixing)rgh*jh+hdh0hh2}rh(h8]rih:]rjh6]rkh4]rlh<]rmuh?Nh@hh#]rnh)ro}rp(h(X`Added pytest.PYVER and Marked test_secure_server web test as Broken on Python 3.2 (needs fixing)rqh*jeh+hdh0hh2}rr(h8]rsh:]rth6]ruh4]rvh<]rwuh?Meh#]rxh]X`Added pytest.PYVER and Marked test_secure_server web test as Broken on Python 3.2 (needs fixing)ryrz}r{(h(jqh*joubaubaubh)r|}r}(h(XeMarked a bunch of 3.2 and 3.3 specific tests that are broken with these versions (needs looking into)r~h*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XeMarked a bunch of 3.2 and 3.3 specific tests that are broken with these versions (needs looking into)rh*j|h+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mgh#]rh]XeMarked a bunch of 3.2 and 3.3 specific tests that are broken with these versions (needs looking into)rr}r(h(jh*jubaubaubh)r}r(h(XKRemoved Broken on Python 3 marked - these tests now pass on 3.1 3.2 and 3.3rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mih#]rh]XKRemoved Broken on Python 3 marked - these tests now pass on 3.1 3.2 and 3.3rr}r(h(jh*jubaubaubh)r}r(h(XUFixed SSL Sockets for Python 3.2/3.3 (Should do_handshake() be executed in a thread?)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XUFixed SSL Sockets for Python 3.2/3.3 (Should do_handshake() be executed in a thread?)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mjh#]rh]XUFixed SSL Sockets for Python 3.2/3.3 (Should do_handshake() be executed in a thread?)rr}r(h(jh*jubaubaubh)r}r(h(X+Added tox configuration file. Just run: runrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mlh#]rh]X+Added tox configuration file. Just run: runrr}r(h(jh*jubaubaubh)r}r(h(X Configure tox to output junitxmlrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mmh#]rh]X Configure tox to output junitxmlrr}r(h(jh*jubaubaubh)r}r(h(XFixed tox configurationrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mnh#]rh]XFixed tox configurationrr}r(h(jh*jubaubaubh)r}r(h(X/Assuming localhost was incorrect. Sorry Mark :/rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]r h<]r uh?Nh@hh#]r h)r }r (h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Moh#]rh]X/Assuming localhost was incorrect. Sorry Mark :/rr}r(h(jh*j ubaubaubh)r}r(h(XFixed test_logger for pypyrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]r uh?Nh@hh#]r!h)r"}r#(h(jh*jh+hdh0hh2}r$(h8]r%h:]r&h6]r'h4]r(h<]r)uh?Mph#]r*h]XFixed test_logger for pypyr+r,}r-(h(jh*j"ubaubaubh)r.}r/(h(X!Backed out changeset 7be64d8b6f7cr0h*jh+hdh0hh2}r1(h8]r2h:]r3h6]r4h4]r5h<]r6uh?Nh@hh#]r7h)r8}r9(h(j0h*j.h+hdh0hh2}r:(h8]r;h:]r<h6]r=h4]r>h<]r?uh?Mqh#]r@h]X!Backed out changeset 7be64d8b6f7crArB}rC(h(j0h*j8ubaubaubh)rD}rE(h(XReconfigured tox settingsrFh*jh+hdh0hh2}rG(h8]rHh:]rIh6]rJh4]rKh<]rLuh?Nh@hh#]rMh)rN}rO(h(jFh*jDh+hdh0hh2}rP(h8]rQh:]rRh6]rSh4]rTh<]rUuh?Mrh#]rVh]XReconfigured tox settingsrWrX}rY(h(jFh*jNubaubaubh)rZ}r[(h(X)Hopefully fixed tox.ini to detect jenkinsr\h*jh+hdh0hh2}r](h8]r^h:]r_h6]r`h4]rah<]rbuh?Nh@hh#]rch)rd}re(h(j\h*jZh+hdh0hh2}rf(h8]rgh:]rhh6]rih4]rjh<]rkuh?Msh#]rlh]X)Hopefully fixed tox.ini to detect jenkinsrmrn}ro(h(j\h*jdubaubaubh)rp}rq(h(XGFixed tox.ini to work on jenkins (can't seem to auto detect jenkins :/)rrh*jh+hdh0hh2}rs(h8]rth:]ruh6]rvh4]rwh<]rxuh?Nh@hh#]ryh)rz}r{(h(jrh*jph+hdh0hh2}r|(h8]r}h:]r~h6]rh4]rh<]ruh?Mth#]rh]XGFixed tox.ini to work on jenkins (can't seem to auto detect jenkins :/)rr}r(h(jrh*jzubaubaubh)r}r(h(X+Added tox config for checking documetnationrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Muh#]rh]X+Added tox config for checking documetnationrr}r(h(jh*jubaubaubh)r}r(h(X=Changed the output filename of xml resutls for docs env (tox)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mvh#]rh]X=Changed the output filename of xml resutls for docs env (tox)rr}r(h(jh*jubaubaubh)r}r(h(X/Added pytest-cov as a dep to the docs env (tox)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mwh#]rh]X/Added pytest-cov as a dep to the docs env (tox)rr}r(h(jh*jubaubaubh)r}r(h(X(Configured coverage to output xml outputrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mxh#]rh]X(Configured coverage to output xml outputrr}r(h(jh*jubaubaubh)r}r(h(X)Removed ptest-cov dep from docs env (tox)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Myh#]rh]X)Removed ptest-cov dep from docs env (tox)rr}r(h(jh*jubaubaubh)r}r(h(X2Trying to fix the randomly failing test_node test.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mzh#]rh]X2Trying to fix the randomly failing test_node test.rr}r (h(jh*jubaubaubh)r }r (h(X&Ooops broke wait_for - fixed hopefullyr h*jh+hdh0hh2}r (h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(j h*j h+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?M{h#]rh]X&Ooops broke wait_for - fixed hopefullyrr}r(h(j h*jubaubaubh)r }r!(h(X!Backed out changeset 795712654602r"h*jh+hdh0hh2}r#(h8]r$h:]r%h6]r&h4]r'h<]r(uh?Nh@hh#]r)h)r*}r+(h(j"h*j h+hdh0hh2}r,(h8]r-h:]r.h6]r/h4]r0h<]r1uh?M|h#]r2h]X!Backed out changeset 795712654602r3r4}r5(h(j"h*j*ubaubaubh)r6}r7(h(X!Backed out changeset 1ee04d5fb657r8h*jh+hdh0hh2}r9(h8]r:h:]r;h6]r<h4]r=h<]r>uh?Nh@hh#]r?h)r@}rA(h(j8h*j6h+hdh0hh2}rB(h8]rCh:]rDh6]rEh4]rFh<]rGuh?M}h#]rHh]X!Backed out changeset 1ee04d5fb657rIrJ}rK(h(j8h*j@ubaubaubh)rL}rM(h(X0Added ignore for generated junitxml output filesrNh*jh+hdh0hh2}rO(h8]rPh:]rQh6]rRh4]rSh<]rTuh?Nh@hh#]rUh)rV}rW(h(jNh*jLh+hdh0hh2}rX(h8]rYh:]rZh6]r[h4]r\h<]r]uh?M~h#]r^h]X0Added ignore for generated junitxml output filesr_r`}ra(h(jNh*jVubaubaubh)rb}rc(h(XPHopefully an improved unit test for node using the manager and watcher fixtures.rdh*jh+hdh0hh2}re(h8]rfh:]rgh6]rhh4]rih<]rjuh?Nh@hh#]rkh)rl}rm(h(XPHopefully an improved unit test for node using the manager and watcher fixtures.rnh*jbh+hdh0hh2}ro(h8]rph:]rqh6]rrh4]rsh<]rtuh?Mh#]ruh]XPHopefully an improved unit test for node using the manager and watcher fixtures.rvrw}rx(h(jnh*jlubaubaubh)ry}rz(h(X(Updated with supported version of Pythonr{h*jh+hdh0hh2}r|(h8]r}h:]r~h6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(j{h*jyh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]X(Updated with supported version of Pythonrr}r(h(j{h*jubaubaubh)r}r(h(X6Fixed the logic of path -> wsgi dispatching in Gatewayrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]X6Fixed the logic of path -> wsgi dispatching in Gatewayrr}r(h(jh*jubaubaubh)r}r(h(XFixed an awful bug with wrappers.Response whereby a default Content-Type was always set regardless and didn't allow anything else to set this.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XFixed an awful bug with wrappers.Response whereby a default Content-Type was always set regardless and didn't allow anything else to set this.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XFixed an awful bug with wrappers.Response whereby a default Content-Type was always set regardless and didn't allow anything else to set this.rr}r(h(jh*jubaubaubh)r}r(h(XBFixed test_disps so it doesn't use an existing port that's in use.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XBFixed test_disps so it doesn't use an existing port that's in use.rr}r(h(jh*jubaubaubh)r}r(h(XXAdded a missing piece of WSGI 1.0 functionality for wsgi.Gateway -- The write() callablerh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XXAdded a missing piece of WSGI 1.0 functionality for wsgi.Gateway -- The write() callablerh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XXAdded a missing piece of WSGI 1.0 functionality for wsgi.Gateway -- The write() callablerr}r(h(jh*jubaubaubh)r}r(h(XWrite bytes in this testrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XWrite bytes in this testrr}r(h(jh*jubaubaubh)r}r(h(X"Correctly handle unicode (I think)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r }r (h(jh*jh+hdh0hh2}r (h8]r h:]r h6]rh4]rh<]ruh?Mh#]rh]X"Correctly handle unicode (I think)rr}r(h(jh*j ubaubaubh)r}r(h(XFixed a bug with null responses from WSGI Applications hosted by wsgi.Gateway. Empty class did not implement __nonzero__ for Python 2.x [Delivers #43287263]rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r (h(XFixed a bug with null responses from WSGI Applications hosted by wsgi.Gateway. Empty class did not implement __nonzero__ for Python 2.x [Delivers #43287263]r!h*jh+hdh0hh2}r"(h8]r#h:]r$h6]r%h4]r&h<]r'uh?Mh#]r(h]XFixed a bug with null responses from WSGI Applications hosted by wsgi.Gateway. Empty class did not implement __nonzero__ for Python 2.x [Delivers #43287263]r)r*}r+(h(j!h*jubaubaubh)r,}r-(h(X>Remvoed pyinotify dep from tox config so Windows tests can runr.h*jh+hdh0hh2}r/(h8]r0h:]r1h6]r2h4]r3h<]r4uh?Nh@hh#]r5h)r6}r7(h(j.h*j,h+hdh0hh2}r8(h8]r9h:]r:h6]r;h4]r<h<]r=uh?Mh#]r>h]X>Remvoed pyinotify dep from tox config so Windows tests can runr?r@}rA(h(j.h*j6ubaubaubh)rB}rC(h(X Skip test_unixserver for WindowsrDh*jh+hdh0hh2}rE(h8]rFh:]rGh6]rHh4]rIh<]rJuh?Nh@hh#]rKh)rL}rM(h(jDh*jBh+hdh0hh2}rN(h8]rOh:]rPh6]rQh4]rRh<]rSuh?Mh#]rTh]X Skip test_unixserver for WindowsrUrV}rW(h(jDh*jLubaubaubh)rX}rY(h(XSkip this test on WindowsrZh*jh+hdh0hh2}r[(h8]r\h:]r]h6]r^h4]r_h<]r`uh?Nh@hh#]rah)rb}rc(h(jZh*jXh+hdh0hh2}rd(h8]reh:]rfh6]rgh4]rhh<]riuh?Mh#]rjh]XSkip this test on Windowsrkrl}rm(h(jZh*jbubaubaubh)rn}ro(h(XSkip these tests on Windowsrph*jh+hdh0hh2}rq(h8]rrh:]rsh6]rth4]ruh<]rvuh?Nh@hh#]rwh)rx}ry(h(jph*jnh+hdh0hh2}rz(h8]r{h:]r|h6]r}h4]r~h<]ruh?Mh#]rh]XSkip these tests on Windowsrr}r(h(jph*jxubaubaubh)r}r(h(XSkip this test on Windowsrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XSkip this test on Windowsrr}r(h(jh*jubaubaubh)r}r(h(XFixed test_tcp_bind for Windowsrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XFixed test_tcp_bind for Windowsrr}r(h(jh*jubaubaubh)r}r(h(XSUpdated docs and re-added FAQ from old wiki (updated slightly) [Delivers #43389199]rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XSUpdated docs and re-added FAQ from old wiki (updated slightly) [Delivers #43389199]rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XSUpdated docs and re-added FAQ from old wiki (updated slightly) [Delivers #43389199]rr}r(h(jh*jubaubaubh)r}r(h(XFixed bottom of FAQrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XFixed bottom of FAQrr}r(h(jh*jubaubaubh)r}r(h(XUpdated Change Log [#42945315]rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XUpdated Change Log [#42945315]rr}r(h(jh*jubaubaubh)r}r(h(X!Updated Release Notes [#42945315]rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]X!Updated Release Notes [#42945315]rr}r(h(jh*jubaubaubh)r }r (h(X1Fixed list of new changes for 2.1.0 release notesr h*jh+hdh0hh2}r (h8]r h:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(j h*j h+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]X1Fixed list of new changes for 2.1.0 release notesrr}r(h(j h*jubaubaubh)r}r (h(XUpdated Developet Docsr!h*jh+hdh0hh2}r"(h8]r#h:]r$h6]r%h4]r&h<]r'uh?Nh@hh#]r(h)r)}r*(h(j!h*jh+hdh0hh2}r+(h8]r,h:]r-h6]r.h4]r/h<]r0uh?Mh#]r1h]XUpdated Developet Docsr2r3}r4(h(j!h*j)ubaubaubh)r5}r6(h(XBumped version to 2.1.0r7h*jh+hdh0hh2}r8(h8]r9h:]r:h6]r;h4]r<h<]r=uh?Nh@hh#]r>h)r?}r@(h(j7h*j5h+hdh0hh2}rA(h8]rBh:]rCh6]rDh4]rEh<]rFuh?Mh#]rGh]XBumped version to 2.1.0rHrI}rJ(h(j7h*j?ubaubaubh)rK}rL(h(XBMore resource efficient timer implementation [Delivers #43700669].rMh*jh+hdh0hh2}rN(h8]rOh:]rPh6]rQh4]rRh<]rSuh?Nh@hh#]rTh)rU}rV(h(jMh*jKh+hdh0hh2}rW(h8]rXh:]rYh6]rZh4]r[h<]r\uh?Mh#]r]h]XBMore resource efficient timer implementation [Delivers #43700669].r^r_}r`(h(jMh*jUubaubaubh)ra}rb(h(XAFixed a problem with cLength being unknown if self.body == False.rch*jh+hdh0hh2}rd(h8]reh:]rfh6]rgh4]rhh<]riuh?Nh@hh#]rjh)rk}rl(h(jch*jah+hdh0hh2}rm(h8]rnh:]roh6]rph4]rqh<]rruh?Mh#]rsh]XAFixed a problem with cLength being unknown if self.body == False.rtru}rv(h(jch*jkubaubaubh)rw}rx(h(XTest fails on shining panda py32 only. May be a race condition (wait_for using same loop interval as timer interval). Checking in for testing.ryh*jh+hdh0hh2}rz(h8]r{h:]r|h6]r}h4]r~h<]ruh?Nh@hh#]rh)r}r(h(XTest fails on shining panda py32 only. May be a race condition (wait_for using same loop interval as timer interval). Checking in for testing.rh*jwh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XTest fails on shining panda py32 only. May be a race condition (wait_for using same loop interval as timer interval). Checking in for testing.rr}r(h(jh*jubaubaubh)r}r(h(XVFixed problem with "Content-Length: 0" header not being generated for empty responses.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XVFixed problem with "Content-Length: 0" header not being generated for empty responses.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XVFixed problem with "Content-Length: 0" header not being generated for empty responses.rr}r(h(jh*jubaubaubh)r}r(h(XLBacked out of changeset 3575:ece3ee5472ef, makes CI hang for unknown reason.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XLBacked out of changeset 3575:ece3ee5472ef, makes CI hang for unknown reason.rr}r(h(jh*jubaubaubh)r}r(h(X@Hopefully finally fixed problems with timer test on CI platform.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]X@Hopefully finally fixed problems with timer test on CI platform.rr}r(h(jh*jubaubaubh)r}r(h(X$Updated pypi classifier for circuitsrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]X$Updated pypi classifier for circuitsrr}r(h(jh*jubaubaubh)r}r(h(X.Fixed random problems with opening SSL socket.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]X.Fixed random problems with opening SSL socket.rr}r(h(jh*jubaubaubh)r}r(h(X^Fixed concurrence problem (doing reset() in event loop and calling unregister() concurrently).rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r (h8]r h:]r h6]r h4]r h<]ruh?Mh#]rh]X^Fixed concurrence problem (doing reset() in event loop and calling unregister() concurrently).rr}r(h(jh*jubaubaubh)r}r(h(XhModified test a bit to find out what happens in CI environment (problem not reproducible in local py32).rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XhModified test a bit to find out what happens in CI environment (problem not reproducible in local py32).rh*jh+hdh0hh2}r (h8]r!h:]r"h6]r#h4]r$h<]r%uh?Mh#]r&h]XhModified test a bit to find out what happens in CI environment (problem not reproducible in local py32).r'r(}r)(h(jh*jubaubaubh)r*}r+(h(XFCalling headers.setdefault twice for the same name doesn't make sense.r,h*jh+hdh0hh2}r-(h8]r.h:]r/h6]r0h4]r1h<]r2uh?Nh@hh#]r3h)r4}r5(h(j,h*j*h+hdh0hh2}r6(h8]r7h:]r8h6]r9h4]r:h<]r;uh?Mh#]r<h]XFCalling headers.setdefault twice for the same name doesn't make sense.r=r>}r?(h(j,h*j4ubaubaubh)r@}rA(h(X"Adapted test case to previous fix.rBh*jh+hdh0hh2}rC(h8]rDh:]rEh6]rFh4]rGh<]rHuh?Nh@hh#]rIh)rJ}rK(h(jBh*j@h+hdh0hh2}rL(h8]rMh:]rNh6]rOh4]rPh<]rQuh?Mh#]rRh]X"Adapted test case to previous fix.rSrT}rU(h(jBh*jJubaubaubh)rV}rW(h(XVFixed problem with "Content-Length: 0" header not being generated for empty responses.rXh*jh+hdh0hh2}rY(h8]rZh:]r[h6]r\h4]r]h<]r^uh?Nh@hh#]r_h)r`}ra(h(XVFixed problem with "Content-Length: 0" header not being generated for empty responses.rbh*jVh+hdh0hh2}rc(h8]rdh:]reh6]rfh4]rgh<]rhuh?Mh#]rih]XVFixed problem with "Content-Length: 0" header not being generated for empty responses.rjrk}rl(h(jbh*j`ubaubaubh)rm}rn(h(X'Fixed insecure usage of class variable.roh*jh+hdh0hh2}rp(h8]rqh:]rrh6]rsh4]rth<]ruuh?Nh@hh#]rvh)rw}rx(h(joh*jmh+hdh0hh2}ry(h8]rzh:]r{h6]r|h4]r}h<]r~uh?Mh#]rh]X'Fixed insecure usage of class variable.rr}r(h(joh*jwubaubaubh)r}r(h(XReverted to old timer implementation. Cannot find bug in new version that only occurs in CI/py32 environment (cannot be reproduced locally).rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XReverted to old timer implementation. Cannot find bug in new version that only occurs in CI/py32 environment (cannot be reproduced locally).rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XReverted to old timer implementation. Cannot find bug in new version that only occurs in CI/py32 environment (cannot be reproduced locally).rr}r(h(jh*jubaubaubh)r}r(h(X7Make sure that check runs faster than timer increments.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]X7Make sure that check runs faster than timer increments.rr}r(h(jh*jubaubaubh)r}r(h(XLAdded missing Content-Length header (must be present according to RFC 2616).rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XLAdded missing Content-Length header (must be present according to RFC 2616).rr}r(h(jh*jubaubaubh)r}r(h(X*Provide a more informative representation.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]X*Provide a more informative representation.rr}r(h(jh*jubaubaubh)r}r(h(XFixed a docstring typorh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XFixed a docstring typorr}r(h(jh*jubaubaubh)r}r(h(XUJust re-raise the exception here rather than hide it with an InternalServer exceptionrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XUJust re-raise the exception here rather than hide it with an InternalServer exceptionrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XUJust re-raise the exception here rather than hide it with an InternalServer exceptionrr}r(h(jh*jubaubaubh)r }r (h(X&Potential failing test for [#43885227]r h*jh+hdh0hh2}r (h8]r h:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(j h*j h+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]X&Potential failing test for [#43885227]rr}r(h(j h*jubaubaubh)r}r (h(XFixed problem with receiving incomplete header data (first chunk doesn't already include empty line that separates headers and body).r!h*jh+hdh0hh2}r"(h8]r#h:]r$h6]r%h4]r&h<]r'uh?Nh@hh#]r(h)r)}r*(h(XFixed problem with receiving incomplete header data (first chunk doesn't already include empty line that separates headers and body).r+h*jh+hdh0hh2}r,(h8]r-h:]r.h6]r/h4]r0h<]r1uh?Mh#]r2h]XFixed problem with receiving incomplete header data (first chunk doesn't already include empty line that separates headers and body).r3r4}r5(h(j+h*j)ubaubaubh)r6}r7(h(XFixed problem with header not being detected if a chunk ends exactly after \r\n of last header line and next chunk starts with empty line (\r\n) before body.r8h*jh+hdh0hh2}r9(h8]r:h:]r;h6]r<h4]r=h<]r>uh?Nh@hh#]r?h)r@}rA(h(XFixed problem with header not being detected if a chunk ends exactly after \r\n of last header line and next chunk starts with empty line (\r\n) before body.rBh*j6h+hdh0hh2}rC(h8]rDh:]rEh6]rFh4]rGh<]rHuh?Mh#]rIh]XFixed problem with header not being detected if a chunk ends exactly after rn of last header line and next chunk starts with empty line (rn) before body.rJrK}rL(h(XFixed problem with header not being detected if a chunk ends exactly after \r\n of last header line and next chunk starts with empty line (\r\n) before body.rMh*j@ubaubaubh)rN}rO(h(X9Fixes inconsisent semantic behavior in channel selection.rPh*jh+hdh0hh2}rQ(h8]rRh:]rSh6]rTh4]rUh<]rVuh?Nh@hh#]rWh)rX}rY(h(jPh*jNh+hdh0hh2}rZ(h8]r[h:]r\h6]r]h4]r^h<]r_uh?Mh#]r`h]X9Fixes inconsisent semantic behavior in channel selection.rarb}rc(h(jPh*jXubaubaubh)rd}re(h(XAFixed expression for _handler_channel in Manager.getHandlers(...)rfh*jh+hdh0hh2}rg(h8]rhh:]rih6]rjh4]rkh<]rluh?Nh@hh#]rmh)rn}ro(h(jfh*jdh+hdh0hh2}rp(h8]rqh:]rrh6]rsh4]rth<]ruuh?Mh#]rvh]XAFixed expression for _handler_channel in Manager.getHandlers(...)rwrx}ry(h(jfh*jnubaubaubh)rz}r{(h(X2Fixed (and simplified) handler_channel evaluation.r|h*jh+hdh0hh2}r}(h8]r~h:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(j|h*jzh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]X2Fixed (and simplified) handler_channel evaluation.rr}r(h(j|h*jubaubaubh)r}r(h(XDFixed channel representation for cases where channel is a component.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XDFixed channel representation for cases where channel is a component.rr}r(h(jh*jubaubaubh)r}r(h(X_Adapted prepare_unregister_complete handling to fixed semantics for using managers as channels.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(X_Adapted prepare_unregister_complete handling to fixed semantics for using managers as channels.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]X_Adapted prepare_unregister_complete handling to fixed semantics for using managers as channels.rr}r(h(jh*jubaubaubh)r}r(h(XNotifications are to be signaled to the given manager. Now that using managers as channels works properly, it showed that hey never were.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XNotifications are to be signaled to the given manager. Now that using managers as channels works properly, it showed that hey never were.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XNotifications are to be signaled to the given manager. Now that using managers as channels works properly, it showed that hey never were.rr}r(h(jh*jubaubaubh)r}r(h(XeValue change notifications are fired using Value's manager as channel, so mke sure to listen on that.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XeValue change notifications are fired using Value's manager as channel, so mke sure to listen on that.rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XeValue change notifications are fired using Value's manager as channel, so mke sure to listen on that.rr}r(h(jh*jubaubaubh)r}r(h(XValue's notifications are fired on its manager component -- by default the component that fired the event the value belongs to. Moved handler to proper place (is better place anyway).rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XValue's notifications are fired on its manager component -- by default the component that fired the event the value belongs to. Moved handler to proper place (is better place anyway).rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XValue's notifications are fired on its manager component -- by default the component that fired the event the value belongs to. Moved handler to proper place (is better place anyway).rr}r(h(jh*jubaubaubh)r}r(h(XcEncoding is necessary for this to succeed on py3.2 (urllib2 there doesn't accept body of type str).rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]r h<]r uh?Nh@hh#]r h)r }r (h(XcEncoding is necessary for this to succeed on py3.2 (urllib2 there doesn't accept body of type str).rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XcEncoding is necessary for this to succeed on py3.2 (urllib2 there doesn't accept body of type str).rr}r(h(jh*j ubaubaubh)r}r(h(XHAdded missing files to manifest. [Delivers #44650895] (Closes Issue #36)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]r h<]r!uh?Nh@hh#]r"h)r#}r$(h(jh*jh+hdh0hh2}r%(h8]r&h:]r'h6]r(h4]r)h<]r*uh?Mh#]r+h]XHAdded missing files to manifest. [Delivers #44650895] (Closes Issue #36)r,r-}r.(h(jh*j#ubaubaubh)r/}r0(h(XFixing encoding problems.r1h*jh+hdh0hh2}r2(h8]r3h:]r4h6]r5h4]r6h<]r7uh?Nh@hh#]r8h)r9}r:(h(j1h*j/h+hdh0hh2}r;(h8]r<h:]r=h6]r>h4]r?h<]r@uh?Mh#]rAh]XFixing encoding problems.rBrC}rD(h(j1h*j9ubaubaubh)rE}rF(h(XSFixing py2/py3 problem by using bytearray as abviously the only common denominator.rGh*jh+hdh0hh2}rH(h8]rIh:]rJh6]rKh4]rLh<]rMuh?Nh@hh#]rNh)rO}rP(h(XSFixing py2/py3 problem by using bytearray as abviously the only common denominator.rQh*jEh+hdh0hh2}rR(h8]rSh:]rTh6]rUh4]rVh<]rWuh?Mh#]rXh]XSFixing py2/py3 problem by using bytearray as abviously the only common denominator.rYrZ}r[(h(jQh*jOubaubaubh)r\}r](h(X}multipart/form-data is binary. Boundaries are ASCII, but data between boundaries may be anything (depending on part's header)r^h*jh+hdh0hh2}r_(h8]r`h:]rah6]rbh4]rch<]rduh?Nh@hh#]reh)rf}rg(h(X}multipart/form-data is binary. Boundaries are ASCII, but data between boundaries may be anything (depending on part's header)rhh*j\h+hdh0hh2}ri(h8]rjh:]rkh6]rlh4]rmh<]rnuh?Mh#]roh]X}multipart/form-data is binary. Boundaries are ASCII, but data between boundaries may be anything (depending on part's header)rprq}rr(h(jhh*jfubaubaubh)rs}rt(h(XTrying to fix unicode issuesruh*jh+hdh0hh2}rv(h8]rwh:]rxh6]ryh4]rzh<]r{uh?Nh@hh#]r|h)r}}r~(h(juh*jsh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XTrying to fix unicode issuesrr}r(h(juh*j}ubaubaubh)r}r(h(XGMarked test_node as Broken on Windows - Pickling Error with thread.lockrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XGMarked test_node as Broken on Windows - Pickling Error with thread.lockrr}r(h(jh*jubaubaubh)r}r(h(X)Trying to fix broken unit test on Windowsrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]X)Trying to fix broken unit test on Windowsrr}r(h(jh*jubaubaubh)r}r(h(X!Setup docs with Google Analyiticsrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]X!Setup docs with Google Analyiticsrr}r(h(jh*jubaubaubh)r}r(h(XnMarked test_tcp_connect_closed_port(...) as Broken on Windows -- Need to fix this; this test is a bit weird :/rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XnMarked test_tcp_connect_closed_port(...) as Broken on Windows -- Need to fix this; this test is a bit weird :/rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]XnMarked test_tcp_connect_closed_port(...) as Broken on Windows -- Need to fix this; this test is a bit weird :/rr}r(h(jh*jubaubaubh)r}r(h(X8Marked test_tcp_reconnect(...) test as Broken on Windowsrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Mh#]rh]X8Marked test_tcp_reconnect(...) test as Broken on Windowsrr}r(h(jh*jubaubaubh)r}r(h(XqUpdated state of test_tcp_reconnect(...) test on Windows -- Apparently only Broken on Windows on Python 3.2 (odd)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(XqUpdated state of test_tcp_reconnect(...) test on Windows -- Apparently only Broken on Windows on Python 3.2 (odd)rh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]r h<]r uh?Mh#]r h]XqUpdated state of test_tcp_reconnect(...) test on Windows -- Apparently only Broken on Windows on Python 3.2 (odd)r r }r(h(jh*jubaubaubh)r}r(h(XFixed TypeErrorrh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+hdh0hh2}r(h8]rh:]rh6]rh4]rh<]r uh?Mh#]r!h]XFixed TypeErrorr"r#}r$(h(jh*jubaubaubh)r%}r&(h(XMarked as Broken on pypy -- For some reason we're getting \x00 (null bytes) in the stream when using the Python std lib logger.r'h*jh+hdh0hh2}r((h8]r)h:]r*h6]r+h4]r,h<]r-uh?Nh@hh#]r.h)r/}r0(h(XMarked as Broken on pypy -- For some reason we're getting \x00 (null bytes) in the stream when using the Python std lib logger.r1h*j%h+hdh0hh2}r2(h8]r3h:]r4h6]r5h4]r6h<]r7uh?Mh#]r8h]X~Marked as Broken on pypy -- For some reason we're getting x00 (null bytes) in the stream when using the Python std lib logger.r9r:}r;(h(XMarked as Broken on pypy -- For some reason we're getting \x00 (null bytes) in the stream when using the Python std lib logger.r<h*j/ubaubaubh)r=}r>(h(X`Marked tests.core.test_debugger.test_filename(...) as Broken on pypy -- Need to investigate thisr?h*jh+hdh0hh2}r@(h8]rAh:]rBh6]rCh4]rDh<]rEuh?Nh@hh#]rFh)rG}rH(h(X`Marked tests.core.test_debugger.test_filename(...) as Broken on pypy -- Need to investigate thisrIh*j=h+hdh0hh2}rJ(h8]rKh:]rLh6]rMh4]rNh<]rOuh?Mh#]rPh]X`Marked tests.core.test_debugger.test_filename(...) as Broken on pypy -- Need to investigate thisrQrR}rS(h(jIh*jGubaubaubh)rT}rU(h(X*Updated support platforms to include pypy rVh*jh+X"internal padding after CHANGES.rstrWh0hh2}rX(h8]rYh:]rZh6]r[h4]r\h<]r]uh?Nh@hh#]r^h)r_}r`(h(X)Updated support platforms to include pypyrah*jTh+hdh0hh2}rb(h8]rch:]rdh6]reh4]rfh<]rguh?Mh#]rhh]X)Updated support platforms to include pypyrirj}rk(h(jah*j_ubaubaubeubeubeubhB)rl}rm(h(Uh*hCh+h.h0hGh2}rn(h8]roh:]rph6]rqh4]rrhah<]rsh auh?Kh@hh#]rt(hQ)ru}rv(h(Xcircuits-2.0.1 20121124rwh*jlh+h.h0hUh2}rx(h8]ryh:]rzh6]r{h4]r|h<]r}uh?Kh@hh#]r~h]Xcircuits-2.0.1 20121124rr}r(h(jwh*juubaubh)r}r(h(Uh*jlh+h.h0hh2}r(hX-h4]rh6]rh8]rh:]rh<]ruh?Kh@hh#]r(h)r}r(h(X9Fixed ``tests/web/test_main.py`` which was badly written.rh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]r(h]XFixed rr}r(h(XFixed rh*jubjK)r}r(h(X``tests/web/test_main.py``rh2}r(h8]rh:]rh6]rh4]rh<]ruh*jh#]rh]Xtests/web/test_main.pyrr}r(h(Uh*jubah0jYubh]X which was badly written.rr}r(h(X which was badly written.rh*jubeubaubh)r}r(h(X8Fixed a regression test testing the Debugger component rh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(X6Fixed a regression test testing the Debugger componentrh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]X6Fixed a regression test testing the Debugger componentrr}r(h(jh*jubaubaubeubeubhB)r}r(h(Uh*hCh+h.h0hGh2}r(h8]rh:]rh6]rh4]rhah<]rh auh?Kh@hh#]r(hQ)r}r(h(X!circuits-2.0.0 20121122 (cheetah)rh*jh+h.h0hUh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh@hh#]rh]X!circuits-2.0.0 20121122 (cheetah)rr}r(h(jh*jubaubh)r}r(h(Uh*jh+h.h0hh2}r(hX-h4]rh6]rh8]rh:]rh<]ruh?Kh@hh#]r(h)r}r(h(XFixed circuits.web entry pointrh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XFixed circuits.web entry pointrr}r(h(jh*jubaubaubh)r}r(h(X=Fixed `tools.reprhandler()` for compatibility with Python-3.3rh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r }r (h(jh*jh+h.h0hh2}r (h8]r h:]r h6]rh4]rh<]ruh?Kh#]r(h]XFixed rr}r(h(XFixed rh*j ubcdocutils.nodes title_reference r)r}r(h(X`tools.reprhandler()`rh2}r(h8]rh:]rh6]rh4]rh<]ruh*j h#]r h]Xtools.reprhandler()r!r"}r#(h(Uh*jubah0Utitle_referencer$ubh]X" for compatibility with Python-3.3r%r&}r'(h(X" for compatibility with Python-3.3r(h*j ubeubaubh)r)}r*(h(X(Added ``*channels`` support to waitEventr+h*jh+h.h0hh2}r,(h8]r-h:]r.h6]r/h4]r0h<]r1uh?Nh@hh#]r2h)r3}r4(h(j+h*j)h+h.h0hh2}r5(h8]r6h:]r7h6]r8h4]r9h<]r:uh?Kh#]r;(h]XAdded r<r=}r>(h(XAdded r?h*j3ubjK)r@}rA(h(X ``*channels``rBh2}rC(h8]rDh:]rEh6]rFh4]rGh<]rHuh*j3h#]rIh]X *channelsrJrK}rL(h(Uh*j@ubah0jYubh]X support to waitEventrMrN}rO(h(X support to waitEventrPh*j3ubeubaubh)rQ}rR(h(XAdded example of using .callrSh*jh+h.h0hh2}rT(h8]rUh:]rVh6]rWh4]rXh<]rYuh?Nh@hh#]rZh)r[}r\(h(jSh*jQh+h.h0hh2}r](h8]r^h:]r_h6]r`h4]rah<]rbuh?Kh#]rch]XAdded example of using .callrdre}rf(h(jSh*j[ubaubaubh)rg}rh(h(XpFixed logic around firing the Daemonize event when registering this component during run-time and after start-uprih*jh+h.h0hh2}rj(h8]rkh:]rlh6]rmh4]rnh<]rouh?Nh@hh#]rph)rq}rr(h(jih*jgh+h.h0hh2}rs(h8]rth:]ruh6]rvh4]rwh<]rxuh?Kh#]ryh]XpFixed logic around firing the Daemonize event when registering this component during run-time and after start-uprzr{}r|(h(jih*jqubaubaubh)r}}r~(h(XFixed use of reprhandlerrh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*j}h+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XFixed use of reprhandlerrr}r(h(jh*jubaubaubh)r}r(h(X.Fixed listening channel for exceptions/errors.rh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]X.Fixed listening channel for exceptions/errors.rr}r(h(jh*jubaubaubh)r}r(h(XFixed channels for Log event.rh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XFixed channels for Log event.rr}r(h(jh*jubaubaubh)r}r(h(XRFixed config loading. Fire a Ready event when the Environment is completely ready.rh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Kh#]rh]XRFixed config loading. Fire a Ready event when the Environment is completely ready.rr}r(h(jh*jubaubaubh)r}r(h(X-Added .items(...) method to Config component.rh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?K h#]rh]X-Added .items(...) method to Config component.rr}r(h(jh*jubaubaubh)r}r(h(XPAdded BaseEvent, LiteralEvent, DerivedEvent to the core and circuits name-spacesrh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?Nh@hh#]rh)r}r(h(jh*jh+h.h0hh2}r(h8]rh:]rh6]rh4]rh<]ruh?K!h#]rh]XPAdded BaseEvent, LiteralEvent, DerivedEvent to the core and circuits name-spacesrr}r (h(jh*jubaubaubh)r }r (h(XFixed IRC protocolr h*jh+h.h0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+h.h0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?K"h#]r h]XFixed IRC protocolr r }r (h(j h*j ubaubaubh)r }r (h(X$Added has_option to Config componentr h*jh+h.h0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r! }r" (h(j h*j h+h.h0hh2}r# (h8]r$ h:]r% h6]r& h4]r' h<]r( uh?K#h#]r) h]X$Added has_option to Config componentr* r+ }r, (h(j h*j! ubaubaubh)r- }r. (h(X3Avoid error if user un-registers a component twice.r/ h*jh+h.h0hh2}r0 (h8]r1 h:]r2 h6]r3 h4]r4 h<]r5 uh?Nh@hh#]r6 h)r7 }r8 (h(j/ h*j- h+h.h0hh2}r9 (h8]r: h:]r; h6]r< h4]r= h<]r> uh?K$h#]r? h]X3Avoid error if user un-registers a component twice.r@ rA }rB (h(j/ h*j7 ubaubaubh)rC }rD (h(XFixed base_url for WebConsolerE h*jh+h.h0hh2}rF (h8]rG h:]rH h6]rI h4]rJ h<]rK uh?Nh@hh#]rL h)rM }rN (h(jE h*jC h+h.h0hh2}rO (h8]rP h:]rQ h6]rR h4]rS h<]rT uh?K%h#]rU h]XFixed base_url for WebConsolerV rW }rX (h(jE h*jM ubaubaubh)rY }rZ (h(XMFixed bug with sending Response for a Expect: 100-continue (Closes issue #32)r[ h*jh+h.h0hh2}r\ (h8]r] h:]r^ h6]r_ h4]r` h<]ra uh?Nh@hh#]rb h)rc }rd (h(j[ h*jY h+h.h0hh2}re (h8]rf h:]rg h6]rh h4]ri h<]rj uh?K&h#]rk h]XMFixed bug with sending Response for a Expect: 100-continue (Closes issue #32)rl rm }rn (h(j[ h*jc ubaubaubh)ro }rp (h(XMAdded a new circuits.web test that ensures that large posts > 1024 bytes workrq h*jh+h.h0hh2}rr (h8]rs h:]rt h6]ru h4]rv h<]rw uh?Nh@hh#]rx h)ry }rz (h(jq h*jo h+h.h0hh2}r{ (h8]r| h:]r} h6]r~ h4]r h<]r uh?K'h#]r h]XMAdded a new circuits.web test that ensures that large posts > 1024 bytes workr r }r (h(jq h*jy ubaubaubh)r }r (h(XFUpdated conf so that doc can be built even if circuits isn't installedr h*jh+h.h0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+h.h0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?K(h#]r h]XFUpdated conf so that doc can be built even if circuits isn't installedr r }r (h(j h*j ubaubaubh)r }r (h(X$Updated reference of guide to howtosr h*jh+h.h0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+h.h0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?K)h#]r h]X$Updated reference of guide to howtosr r }r (h(j h*j ubaubaubh)r }r (h(X9Updated man headers so that they weren't all "Components"r h*jh+h.h0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+h.h0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?K*h#]r h]X9Updated man headers so that they weren't all "Components"r r }r (h(j h*j ubaubaubh)r }r (h(XFixed all web dispatcher testsr h*jh+h.h0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+h.h0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?K+h#]r h]XFixed all web dispatcher testsr r }r (h(j h*j ubaubaubh)r }r (h(XoFixed XMLRPC dispatcher. Must have a higher priority than the "default" dispatcher in order to coexist with it.r h*jh+h.h0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+h.h0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?K,h#]r h]XoFixed XMLRPC dispatcher. Must have a higher priority than the "default" dispatcher in order to coexist with it.r r }r (h(j h*j ubaubaubh)r }r (h(XFixed unit test for failure response from web *component* (component's handler must have higher priority than default dispatcher if default dispatcher exists).r h*jh+h.h0hh2}r (h8]r h:]r h6]r h4]r h<]r uh?Nh@hh#]r h)r }r (h(j h*j h+h.h0hh2}r (h8]r!h:]r!h6]r!h4]r!h<]r!uh?K-h#]r!(h]X.Fixed unit test for failure response from web r!r!}r!(h(X.Fixed unit test for failure response from web r !h*j ubcdocutils.nodes emphasis r !)r !}r !(h(X *component*r !h2}r!(h8]r!h:]r!h6]r!h4]r!h<]r!uh*j h#]r!h]X componentr!r!}r!(h(Uh*j !ubah0Uemphasisr!ubh]Xf (component's handler must have higher priority than default dispatcher if default dispatcher exists).r!r!}r!(h(Xf (component's handler must have higher priority than default dispatcher if default dispatcher exists).r!h*j ubeubaubh)r!}r!(h(X(Added failure test for web *controller*.r!h*jh+h.h0hh2}r !(h8]r!!h:]r"!h6]r#!h4]r$!h<]r%!uh?Nh@hh#]r&!h)r'!}r(!(h(j!h*j!h+h.h0hh2}r)!(h8]r*!h:]r+!h6]r,!h4]r-!h<]r.!uh?K.h#]r/!(h]XAdded failure test for web r0!r1!}r2!(h(XAdded failure test for web r3!h*j'!ubj !)r4!}r5!(h(X *controller*r6!h2}r7!(h8]r8!h:]r9!h6]r:!h4]r;!h<]r!r?!}r@!(h(Uh*j4!ubah0j!ubh]X.rA!}rB!(h(X.h*j'!ubeubaubh)rC!}rD!(h(XmFixed JSON dispatcher. Must have a higher priority than the "default" dispatcher in order to coexist with it.rE!h*jh+h.h0hh2}rF!(h8]rG!h:]rH!h6]rI!h4]rJ!h<]rK!uh?Nh@hh#]rL!h)rM!}rN!(h(jE!h*jC!h+h.h0hh2}rO!(h8]rP!h:]rQ!h6]rR!h4]rS!h<]rT!uh?K/h#]rU!h]XmFixed JSON dispatcher. Must have a higher priority than the "default" dispatcher in order to coexist with it.rV!rW!}rX!(h(jE!h*jM!ubaubaubh)rY!}rZ!(h(X]Fixed vpath traversal. vpath created in reverse ("test_args/1/2/3" became "3/2/1/test_args").r[!h*jh+h.h0hh2}r\!(h8]r]!h:]r^!h6]r_!h4]r`!h<]ra!uh?Nh@hh#]rb!h)rc!}rd!(h(j[!h*jY!h+h.h0hh2}re!(h8]rf!h:]rg!h6]rh!h4]ri!h<]rj!uh?K0h#]rk!h]X]Fixed vpath traversal. vpath created in reverse ("test_args/1/2/3" became "3/2/1/test_args").rl!rm!}rn!(h(j[!h*jc!ubaubaubh)ro!}rp!(h(XFixed evaluation of the Complete event: exclude events fired by other threads during event processing from the set of events to be tracked.rq!h*jh+h.h0hh2}rr!(h8]rs!h:]rt!h6]ru!h4]rv!h<]rw!uh?Nh@hh#]rx!h)ry!}rz!(h(jq!h*jo!h+h.h0hh2}r{!(h8]r|!h:]r}!h6]r~!h4]r!h<]r!uh?K1h#]r!h]XFixed evaluation of the Complete event: exclude events fired by other threads during event processing from the set of events to be tracked.r!r!}r!(h(jq!h*jy!ubaubaubh)r!}r!(h(XBDon't call tick on components that are waiting to be unregistered.r!h*jh+h.h0hh2}r!(h8]r!h:]r!h6]r!h4]r!h<]r!uh?Nh@hh#]r!h)r!}r!(h(j!h*j!h+h.h0hh2}r!(h8]r!h:]r!h6]r!h4]r!h<]r!uh?K2h#]r!h]XBDon't call tick on components that are waiting to be unregistered.r!r!}r!(h(j!h*j!ubaubaubh)r!}r!(h(XIUsing new PrepareUnregister event to reliably remove sockets from poller.r!h*jh+h.h0hh2}r!(h8]r!h:]r!h6]r!h4]r!h<]r!uh?Nh@hh#]r!h)r!}r!(h(j!h*j!h+h.h0hh2}r!(h8]r!h:]r!h6]r!h4]r!h<]r!uh?K3h#]r!h]XIUsing new PrepareUnregister event to reliably remove sockets from poller.r!r!}r!(h(j!h*j!ubaubaubh)r!}r!(h(X0Fixes for PrepareUnregister and added test case.r!h*jh+h.h0hh2}r!(h8]r!h:]r!h6]r!h4]r!h<]r!uh?Nh@hh#]r!h)r!}r!(h(j!h*j!h+h.h0hh2}r!(h8]r!h:]r!h6]r!h4]r!h<]r!uh?K4h#]r!h]X0Fixes for PrepareUnregister and added test case.r!r!}r!(h(j!h*j!ubaubaubh)r!}r!(h(XLAdded event that informs components about going to be removed from the tree.r!h*jh+h.h0hh2}r!(h8]r!h:]r!h6]r!h4]r!h<]r!uh?Nh@hh#]r!h)r!}r!(h(j!h*j!h+h.h0hh2}r!(h8]r!h:]r!h6]r!h4]r!h<]r!uh?K5h#]r!h]XLAdded event that informs components about going to be removed from the tree.r!r!}r!(h(j!h*j!ubaubaubh)r!}r!(h(X;Fixed client request generation (MUST include Host header).r!h*jh+h.h0hh2}r!(h8]r!h:]r!h6]r!h4]r!h<]r!uh?Nh@hh#]r!h)r!}r!(h(j!h*j!h+h.h0hh2}r!(h8]r!h:]r!h6]r!h4]r!h<]r!uh?K6h#]r!h]X;Fixed client request generation (MUST include Host header).r!r!}r!(h(j!h*j!ubaubaubh)r!}r!(h(XyFixed channel naming in web.Client to allow several clients (i.e. connections to web sites) to coexist in an application.r!h*jh+h.h0hh2}r!(h8]r!h:]r!h6]r!h4]r!h<]r!uh?Nh@hh#]r!h)r!}r!(h(j!h*j!h+h.h0hh2}r!(h8]r"h:]r"h6]r"h4]r"h<]r"uh?K7h#]r"h]XyFixed channel naming in web.Client to allow several clients (i.e. connections to web sites) to coexist in an application.r"r"}r"(h(j!h*j!ubaubaubh)r "}r "(h(XPrevented uncameling of event names that represent web requests. Handlers can now use the last path segment unmodified as handled event's name.r "h*jh+h.h0hh2}r "(h8]r "h:]r"h6]r"h4]r"h<]r"uh?Nh@hh#]r"h)r"}r"(h(j "h*j "h+h.h0hh2}r"(h8]r"h:]r"h6]r"h4]r"h<]r"uh?K8h#]r"h]XPrevented uncameling of event names that represent web requests. Handlers can now use the last path segment unmodified as handled event's name.r"r"}r"(h(j "h*j"ubaubaubh)r"}r "(h(X'Fixed the new dispatcher with new testsr!"h*jh+h.h0hh2}r""(h8]r#"h:]r$"h6]r%"h4]r&"h<]r'"uh?Nh@hh#]r("h)r)"}r*"(h(j!"h*j"h+h.h0hh2}r+"(h8]r,"h:]r-"h6]r."h4]r/"h<]r0"uh?K9h#]r1"h]X'Fixed the new dispatcher with new testsr2"r3"}r4"(h(j!"h*j)"ubaubaubh)r5"}r6"(h(X'Fixed bug in complete event generation.r7"h*jh+h.h0hh2}r8"(h8]r9"h:]r:"h6]r;"h4]r<"h<]r="uh?Nh@hh#]r>"h)r?"}r@"(h(j7"h*j5"h+h.h0hh2}rA"(h8]rB"h:]rC"h6]rD"h4]rE"h<]rF"uh?K:h#]rG"h]X'Fixed bug in complete event generation.rH"rI"}rJ"(h(j7"h*j?"ubaubaubh)rK"}rL"(h(XdAdded optional event signaling the completion of an event and everything that has been caused by it.rM"h*jh+h.h0hh2}rN"(h8]rO"h:]rP"h6]rQ"h4]rR"h<]rS"uh?Nh@hh#]rT"h)rU"}rV"(h(jM"h*jK"h+h.h0hh2}rW"(h8]rX"h:]rY"h6]rZ"h4]r["h<]r\"uh?K;h#]r]"h]XdAdded optional event signaling the completion of an event and everything that has been caused by it.r^"r_"}r`"(h(jM"h*jU"ubaubaubh)ra"}rb"(h(XGAdded the possibility to redirect the success events to other channels.rc"h*jh+h.h0hh2}rd"(h8]re"h:]rf"h6]rg"h4]rh"h<]ri"uh?Nh@hh#]rj"h)rk"}rl"(h(jc"h*ja"h+h.h0hh2}rm"(h8]rn"h:]ro"h6]rp"h4]rq"h<]rr"uh?Kh#]r"h]X,Replaced web dispatcher with simpler versionr"r"}r"(h(j"h*j"ubaubaubh)r"}r"(h(X/Added support for x = yield self.callEvent(...)r"h*jh+h.h0hh2}r"(h8]r"h:]r"h6]r"h4]r"h<]r"uh?Nh@hh#]r"h)r"}r"(h(j"h*j"h+h.h0hh2}r"(h8]r"h:]r"h6]r"h4]r"h<]r"uh?K?h#]r"h]X/Added support for x = yield self.callEvent(...)r"r"}r"(h(j"h*j"ubaubaubh)r"}r"(h(XMade test_main more reliabler"h*jh+h.h0hh2}r"(h8]r"h:]r"h6]r"h4]r"h<]r"uh?Nh@hh#]r"h)r"}r"(h(j"h*j"h+h.h0hh2}r"(h8]r"h:]r"h6]r"h4]r"h<]r"uh?K@h#]r"h]XMade test_main more reliabler"r"}r"(h(j"h*j"ubaubaubh)r"}r"(h(XRRemoved old BaseManager from playing with GreenletManager. Fixed test_manager_reprr"h*jh+h.h0hh2}r"(h8]r"h:]r"h6]r"h4]r"h<]r"uh?Nh@hh#]r"h)r"}r"(h(j"h*j"h+h.h0hh2}r"(h8]r"h:]r"h6]r"h4]r"h<]r"uh?KAh#]r"h]XRRemoved old BaseManager from playing with GreenletManager. Fixed test_manager_reprr"r"}r"(h(j"h*j"ubaubaubh)r"}r"(h(XIFixed the exceptions being thrown for test_eval, but the test still failsr"h*jh+h.h0hh2}r"(h8]r"h:]r"h6]r"h4]r"h<]r"uh?Nh@hh#]r"h)r"}r"(h(j"h*j"h+h.h0hh2}r"(h8]r"h:]r"h6]r"h4]r"h<]r"uh?KBh#]r"h]XIFixed the exceptions being thrown for test_eval, but the test still failsr"r"}r"(h(j"h*j"ubaubaubh)r"}r"(h(X8Added a new failing test - evaluation of promised valuesr"h*jh+h.h0hh2}r"(h8]r"h:]r#h6]r#h4]r#h<]r#uh?Nh@hh#]r#h)r#}r#(h(j"h*j"h+h.h0hh2}r#(h8]r#h:]r #h6]r #h4]r #h<]r #uh?KCh#]r #h]X8Added a new failing test - evaluation of promised valuesr#r#}r#(h(j"h*j#ubaubaubh)r#}r#(h(X+Removed superfluous .value in test_longwaitr#h*jh+h.h0hh2}r#(h8]r#h:]r#h6]r#h4]r#h<]r#uh?Nh@hh#]r#h)r#}r#(h(j#h*j#h+h.h0hh2}r#(h8]r#h:]r#h6]r #h4]r!#h<]r"#uh?KDh#]r##h]X+Removed superfluous .value in test_longwaitr$#r%#}r&#(h(j#h*j#ubaubaubh)r'#}r(#(h(XlAdded support for alllowing future handlers to have a "special" event parameter just like ordinary handlers.r)#h*jh+h.h0hh2}r*#(h8]r+#h:]r,#h6]r-#h4]r.#h<]r/#uh?Nh@hh#]r0#h)r1#}r2#(h(j)#h*j'#h+h.h0hh2}r3#(h8]r4#h:]r5#h6]r6#h4]r7#h<]r8#uh?KEh#]r9#h]XlAdded support for alllowing future handlers to have a "special" event parameter just like ordinary handlers.r:#r;#}r<#(h(j)#h*j1#ubaubaubh)r=#}r>#(h(XFixed test_successr?#h*jh+h.h0hh2}r@#(h8]rA#h:]rB#h6]rC#h4]rD#h<]rE#uh?Nh@hh#]rF#h)rG#}rH#(h(j?#h*j=#h+h.h0hh2}rI#(h8]rJ#h:]rK#h6]rL#h4]rM#h<]rN#uh?KFh#]rO#h]XFixed test_successrP#rQ#}rR#(h(j?#h*jG#ubaubaubh)rS#}rT#(h(XFixed test_removeHandlerrU#h*jh+h.h0hh2}rV#(h8]rW#h:]rX#h6]rY#h4]rZ#h<]r[#uh?Nh@hh#]r\#h)r]#}r^#(h(jU#h*jS#h+h.h0hh2}r_#(h8]r`#h:]ra#h6]rb#h4]rc#h<]rd#uh?KGh#]re#h]XFixed test_removeHandlerrf#rg#}rh#(h(jU#h*j]#ubaubaubh)ri#}rj#(h(XGAdded support for firing Done() and Success() after all done executing.rk#h*jh+h.h0hh2}rl#(h8]rm#h:]rn#h6]ro#h4]rp#h<]rq#uh?Nh@hh#]rr#h)rs#}rt#(h(jk#h*ji#h+h.h0hh2}ru#(h8]rv#h:]rw#h6]rx#h4]ry#h<]rz#uh?KHh#]r{#h]XGAdded support for firing Done() and Success() after all done executing.r|#r}#}r~#(h(jk#h*js#ubaubaubh)r#}r#(h(XFixed callEventr#h*jh+h.h0hh2}r#(h8]r#h:]r#h6]r#h4]r#h<]r#uh?Nh@hh#]r#h)r#}r#(h(j#h*j#h+h.h0hh2}r#(h8]r#h:]r#h6]r#h4]r#h<]r#uh?KIh#]r#h]XFixed callEventr#r#}r#(h(j#h*j#ubaubaubh)r#}r#(h(XAdded 2 failing tests for yieldr#h*jh+h.h0hh2}r#(h8]r#h:]r#h6]r#h4]r#h<]r#uh?Nh@hh#]r#h)r#}r#(h(j#h*j#h+h.h0hh2}r#(h8]r#h:]r#h6]r#h4]r#h<]r#uh?KJh#]r#h]XAdded 2 failing tests for yieldr#r#}r#(h(j#h*j#ubaubaubh)r#}r#(h(XImplemented promises which we detect for in circuits.web in cases where an event handler yields. Also only fire _success events after an event is well and truly finished (in the case of yielding event handlers)r#h*jh+h.h0hh2}r#(h8]r#h:]r#h6]r#h4]r#h<]r#uh?Nh@hh#]r#h)r#}r#(h(j#h*j#h+h.h0hh2}r#(h8]r#h:]r#h6]r#h4]r#h<]r#uh?KKh#]r#h]XImplemented promises which we detect for in circuits.web in cases where an event handler yields. Also only fire _success events after an event is well and truly finished (in the case of yielding event handlers)r#r#}r#(h(j#h*j#ubaubaubh)r#}r#(h(X$Fixed a bug with value not being setr#h*jh+h.h0hh2}r#(h8]r#h:]r#h6]r#h4]r#h<]r#uh?Nh@hh#]r#h)r#}r#(h(j#h*j#h+h.h0hh2}r#(h8]r#h:]r#h6]r#h4]r#h<]r#uh?KLh#]r#h]X$Fixed a bug with value not being setr#r#}r#(h(j#h*j#ubaubaubh)r#}r#(h(XFixed Issue #26r#h*jh+h.h0hh2}r#(h8]r#h:]r#h6]r#h4]r#h<]r#uh?Nh@hh#]r#h)r#}r#(h(j#h*j#h+h.h0hh2}r#(h8]r#h:]r#h6]r#h4]r#h<]r#uh?KMh#]r#h]XFixed Issue #26r#r#}r#(h(j#h*j#ubaubaubh)r#}r#(h(XLAdded capability of waiting for a specific event name on a specific channel.r#h*jh+h.h0hh2}r#(h8]r#h:]r#h6]r#h4]r#h<]r#uh?Nh@hh#]r#h)r#}r#(h(j#h*j#h+h.h0hh2}r#(h8]r#h:]r#h6]r#h4]r#h<]r#uh?KNh#]r#h]XLAdded capability of waiting for a specific event name on a specific channel.r$r$}r$(h(j#h*j#ubaubaubh)r$}r$(h(X2Fixed bug guarding against tasks already removed.r$h*jh+h.h0hh2}r$(h8]r$h:]r$h6]r $h4]r $h<]r $uh?Nh@hh#]r $h)r $}r$(h(j$h*j$h+h.h0hh2}r$(h8]r$h:]r$h6]r$h4]r$h<]r$uh?KOh#]r$h]X2Fixed bug guarding against tasks already removed.r$r$}r$(h(j$h*j $ubaubaubh)r$}r$(h(XImplemented Component.init() support whereby one can define an alternative init() without needing to remember to call super(...)r$h*jh+h.h0hh2}r$(h8]r$h:]r$h6]r$h4]r $h<]r!$uh?Nh@hh#]r"$h)r#$}r$$(h(j$h*j$h+h.h0hh2}r%$(h8]r&$h:]r'$h6]r($h4]r)$h<]r*$uh?KPh#]r+$h]XImplemented Component.init() support whereby one can define an alternative init() without needing to remember to call super(...)r,$r-$}r.$(h(j$h*j#$ubaubaubh)r/$}r0$(h(X1Fixed Python 3 compatibility with Unicode stringsr1$h*jh+h.h0hh2}r2$(h8]r3$h:]r4$h6]r5$h4]r6$h<]r7$uh?Nh@hh#]r8$h)r9$}r:$(h(j1$h*j/$h+h.h0hh2}r;$(h8]r<$h:]r=$h6]r>$h4]r?$h<]r@$uh?KQh#]rA$h]X1Fixed Python 3 compatibility with Unicode stringsrB$rC$}rD$(h(j1$h*j9$ubaubaubh)rE$}rF$(h(XdAdded 99bottles as an example of concurrency. See: http://wiki.python.org/moin/Concurrency/99BottlesrG$h*jh+h.h0hh2}rH$(h8]rI$h:]rJ$h6]rK$h4]rL$h<]rM$uh?Nh@hh#]rN$h)rO$}rP$(h(jG$h*jE$h+h.h0hh2}rQ$(h8]rR$h:]rS$h6]rT$h4]rU$h<]rV$uh?KRh#]rW$(h]X3Added 99bottles as an example of concurrency. See: rX$rY$}rZ$(h(X3Added 99bottles as an example of concurrency. See: r[$h*jO$ubcdocutils.nodes reference r\$)r]$}r^$(h(X1http://wiki.python.org/moin/Concurrency/99Bottlesr_$h2}r`$(Urefurira$X1http://wiki.python.org/moin/Concurrency/99Bottlesrb$h4]rc$h6]rd$h8]re$h:]rf$h<]rg$uh*jO$h#]rh$h]X1http://wiki.python.org/moin/Concurrency/99Bottlesri$rj$}rk$(h(Uh*j]$ubah0U referencerl$ubeubaubh)rm$}rn$(h(X#Removed old-style channel targetingro$h*jh+h.h0hh2}rp$(h8]rq$h:]rr$h6]rs$h4]rt$h<]ru$uh?Nh@hh#]rv$h)rw$}rx$(h(jo$h*jm$h+h.h0hh2}ry$(h8]rz$h:]r{$h6]r|$h4]r}$h<]r~$uh?KSh#]r$h]X#Removed old-style channel targetingr$r$}r$(h(jo$h*jw$ubaubaubh)r$}r$(h(XFixed and tested UDP forwardingr$h*jh+h.h0hh2}r$(h8]r$h:]r$h6]r$h4]r$h<]r$uh?Nh@hh#]r$h)r$}r$(h(j$h*j$h+h.h0hh2}r$(h8]r$h:]r$h6]r$h4]r$h<]r$uh?KTh#]r$h]XFixed and tested UDP forwardingr$r$}r$(h(j$h*j$ubaubaubh)r$}r$(h(XSimplified udpclient exampler$h*jh+h.h0hh2}r$(h8]r$h:]r$h6]r$h4]r$h<]r$uh?Nh@hh#]r$h)r$}r$(h(j$h*j$h+h.h0hh2}r$(h8]r$h:]r$h6]r$h4]r$h<]r$uh?KUh#]r$h]XSimplified udpclient exampler$r$}r$(h(j$h*j$ubaubaubh)r$}r$(h(X6Implemented new version of port forwarded. TCP tested.r$h*jh+h.h0hh2}r$(h8]r$h:]r$h6]r$h4]r$h<]r$uh?Nh@hh#]r$h)r$}r$(h(j$h*j$h+h.h0hh2}r$(h8]r$h:]r$h6]r$h4]r$h<]r$uh?KVh#]r$h]X6Implemented new version of port forwarded. TCP tested.r$r$}r$(h(j$h*j$ubaubaubh)r$}r$(h(X;Fixed Read events for UDPServer by setting .notify to True.r$h*jh+h.h0hh2}r$(h8]r$h:]r$h6]r$h4]r$h<]r$uh?Nh@hh#]r$h)r$}r$(h(j$h*j$h+h.h0hh2}r$(h8]r$h:]r$h6]r$h4]r$h<]r$uh?KWh#]r$h]X;Fixed Read events for UDPServer by setting .notify to True.r$r$}r$(h(j$h*j$ubaubaubh)r$}r$(h(X=Restructured the only How To Guide - Building a Simple Serverr$h*jh+h.h0hh2}r$(h8]r$h:]r$h6]r$h4]r$h<]r$uh?Nh@hh#]r$h)r$}r$(h(j$h*j$h+h.h0hh2}r$(h8]r$h:]r$h6]r$h4]r$h<]r$uh?KXh#]r$h]X=Restructured the only How To Guide - Building a Simple Serverr$r$}r$(h(j$h*j$ubaubaubh)r$}r$(h(X1Renamed _get_request_handler to just find_handlerr$h*jh+h.h0hh2}r$(h8]r$h:]r$h6]r$h4]r$h<]r$uh?Nh@hh#]r$h)r$}r$(h(j$h*j$h+h.h0hh2}r$(h8]r$h:]r$h6]r%h4]r%h<]r%uh?KYh#]r%h]X1Renamed _get_request_handler to just find_handlerr%r%}r%(h(j$h*j$ubaubaubh)r%}r%(h(X>Removed channels attribute from WebEvents (fix for issue #29).r %h*jh+h.h0hh2}r %(h8]r %h:]r %h6]r %h4]r%h<]r%uh?Nh@hh#]r%h)r%}r%(h(j %h*j%h+h.h0hh2}r%(h8]r%h:]r%h6]r%h4]r%h<]r%uh?KZh#]r%h]X>Removed channels attribute from WebEvents (fix for issue #29).r%r%}r%(h(j %h*j%ubaubaubh)r%}r%(h(X"Added Eclipse configuration files.r%h*jh+h.h0hh2}r %(h8]r!%h:]r"%h6]r#%h4]r$%h<]r%%uh?Nh@hh#]r&%h)r'%}r(%(h(j%h*j%h+h.h0hh2}r)%(h8]r*%h:]r+%h6]r,%h4]r-%h<]r.%uh?K[h#]r/%h]X"Added Eclipse configuration files.r0%r1%}r2%(h(j%h*j'%ubaubaubh)r3%}r4%(h(X-Fixed uses of deprecated syntax in app.configr5%h*jh+h.h0hh2}r6%(h8]r7%h:]r8%h6]r9%h4]r:%h<]r;%uh?Nh@hh#]r<%h)r=%}r>%(h(j5%h*j3%h+h.h0hh2}r?%(h8]r@%h:]rA%h6]rB%h4]rC%h<]rD%uh?K\h#]rE%h]X-Fixed uses of deprecated syntax in app.configrF%rG%}rH%(h(j5%h*j=%ubaubaubh)rI%}rJ%(h(XjModified the defaults for channels. Set channels to event.channels, otherwise self.channel defaulting to *rK%h*jh+h.h0hh2}rL%(h8]rM%h:]rN%h6]rO%h4]rP%h<]rQ%uh?Nh@hh#]rR%h)rS%}rT%(h(jK%h*jI%h+h.h0hh2}rU%(h8]rV%h:]rW%h6]rX%h4]rY%h<]rZ%uh?K]h#]r[%h]XjModified the defaults for channels. Set channels to event.channels, otherwise self.channel defaulting to *r\%r]%}r^%(h(jK%h*jS%ubaubaubh)r_%}r`%(h(X&Fixed uses of deprecated syntax in envra%h*jh+h.h0hh2}rb%(h8]rc%h:]rd%h6]re%h4]rf%h<]rg%uh?Nh@hh#]rh%h)ri%}rj%(h(ja%h*j_%h+h.h0hh2}rk%(h8]rl%h:]rm%h6]rn%h4]ro%h<]rp%uh?K^h#]rq%h]X&Fixed uses of deprecated syntax in envrr%rs%}rt%(h(ja%h*ji%ubaubaubh)ru%}rv%(h(X`Fixed a bug with the Redirect event/error in circuits.web where it didn't handle Unicode stringsrw%h*jh+h.h0hh2}rx%(h8]ry%h:]rz%h6]r{%h4]r|%h<]r}%uh?Nh@hh#]r~%h)r%}r%(h(jw%h*ju%h+h.h0hh2}r%(h8]r%h:]r%h6]r%h4]r%h<]r%uh?K_h#]r%h]X`Fixed a bug with the Redirect event/error in circuits.web where it didn't handle Unicode stringsr%r%}r%(h(jw%h*j%ubaubaubh)r%}r%(h(Xfixed the web dispatcherr%h*jh+h.h0hh2}r%(h8]r%h:]r%h6]r%h4]r%h<]r%uh?Nh@hh#]r%h)r%}r%(h(j%h*j%h+h.h0hh2}r%(h8]r%h:]r%h6]r%h4]r%h<]r%uh?K`h#]r%h]Xfixed the web dispatcherr%r%}r%(h(j%h*j%ubaubaubh)r%}r%(h(XIFixed test_poller_reuse test by using the now findtype() utility functionr%h*jh+h.h0hh2}r%(h8]r%h:]r%h6]r%h4]r%h<]r%uh?Nh@hh#]r%h)r%}r%(h(j%h*j%h+h.h0hh2}r%(h8]r%h:]r%h6]r%h4]r%h<]r%uh?Kah#]r%h]XIFixed test_poller_reuse test by using the now findtype() utility functionr%r%}r%(h(j%h*j%ubaubaubh)r%}r%(h(X+fixed and adds tests for the web dispatcherr%h*jh+h.h0hh2}r%(h8]r%h:]r%h6]r%h4]r%h<]r%uh?Nh@hh#]r%h)r%}r%(h(j%h*j%h+h.h0hh2}r%(h8]r%h:]r%h6]r%h4]r%h<]r%uh?Kbh#]r%h]X+fixed and adds tests for the web dispatcherr%r%}r%(h(j%h*j%ubaubaubh)r%}r%(h(X?Moved parseBody out into circuits.web.utils. Other code cleanupr%h*jh+h.h0hh2}r%(h8]r%h:]r%h6]r%h4]r%h<]r%uh?Nh@hh#]r%h)r%}r%(h(j%h*j%h+h.h0hh2}r%(h8]r%h:]r%h6]r%h4]r%h<]r%uh?Kch#]r%h]X?Moved parseBody out into circuits.web.utils. Other code cleanupr%r%}r%(h(j%h*j%ubaubaubh)r%}r%(h(X8Added a test for a bug with the dispatcher mehere found.r%h*jh+h.h0hh2}r%(h8]r%h:]r%h6]r%h4]r%h<]r%uh?Nh@hh#]r%h)r%}r%(h(j%h*j%h+h.h0hh2}r%(h8]r%h:]r%h6]r%h4]r%h<]r%uh?Kdh#]r%h]X8Added a test for a bug with the dispatcher mehere found.r%r%}r%(h(j%h*j%ubaubaubh)r%}r%(h(X{Removed itercmp() function. Added findtype() findchannel() and used better variable names. findcmp is an alias of findtype.r%h*jh+h.h0hh2}r%(h8]r%h:]r%h6]r%h4]r&h<]r&uh?Nh@hh#]r&h)r&}r&(h(j%h*j%h+h.h0hh2}r&(h8]r&h:]r&h6]r&h4]r &h<]r &uh?Keh#]r &h]X{Removed itercmp() function. Added findtype() findchannel() and used better variable names. findcmp is an alias of findtype.r &r &}r&(h(j%h*j&ubaubaubh)r&}r&(h(X5Implemented optional singleton support for componentsr&h*jh+h.h0hh2}r&(h8]r&h:]r&h6]r&h4]r&h<]r&uh?Nh@hh#]r&h)r&}r&(h(j&h*j&h+h.h0hh2}r&(h8]r&h:]r&h6]r&h4]r&h<]r &uh?Kfh#]r!&h]X5Implemented optional singleton support for componentsr"&r#&}r$&(h(j&h*j&ubaubaubh)r%&}r&&(h(XRemoved the circuits.web `routes` dispatcher as there are no tests for this and Routes dispatcher is broken - re implement at a later stager'&h*jh+h.h0hh2}r(&(h8]r)&h:]r*&h6]r+&h4]r,&h<]r-&uh?Nh@hh#]r.&h)r/&}r0&(h(j'&h*j%&h+h.h0hh2}r1&(h8]r2&h:]r3&h6]r4&h4]r5&h<]r6&uh?Kgh#]r7&(h]XRemoved the circuits.web r8&r9&}r:&(h(XRemoved the circuits.web r;&h*j/&ubj)r<&}r=&(h(X`routes`r>&h2}r?&(h8]r@&h:]rA&h6]rB&h4]rC&h<]rD&uh*j/&h#]rE&h]XroutesrF&rG&}rH&(h(Uh*j<&ubah0j$ubh]Xj dispatcher as there are no tests for this and Routes dispatcher is broken - re implement at a later stagerI&rJ&}rK&(h(Xj dispatcher as there are no tests for this and Routes dispatcher is broken - re implement at a later stagerL&h*j/&ubeubaubh)rM&}rN&(h(XRemoval of End feedback eventrO&h*jh+h.h0hh2}rP&(h8]rQ&h:]rR&h6]rS&h4]rT&h<]rU&uh?Nh@hh#]rV&h)rW&}rX&(h(jO&h*jM&h+h.h0hh2}rY&(h8]rZ&h:]r[&h6]r\&h4]r]&h<]r^&uh?Khh#]r_&h]XRemoval of End feedback eventr`&ra&}rb&(h(jO&h*jW&ubaubaubh)rc&}rd&(h(XFixed web/test_value.pyre&h*jh+h.h0hh2}rf&(h8]rg&h:]rh&h6]ri&h4]rj&h<]rk&uh?Nh@hh#]rl&h)rm&}rn&(h(je&h*jc&h+h.h0hh2}ro&(h8]rp&h:]rq&h6]rr&h4]rs&h<]rt&uh?Kih#]ru&h]XFixed web/test_value.pyrv&rw&}rx&(h(je&h*jm&ubaubaubh)ry&}rz&(h(XFixed web futures testr{&h*jh+h.h0hh2}r|&(h8]r}&h:]r~&h6]r&h4]r&h<]r&uh?Nh@hh#]r&h)r&}r&(h(j{&h*jy&h+h.h0hh2}r&(h8]r&h:]r&h6]r&h4]r&h<]r&uh?Kjh#]r&h]XFixed web futures testr&r&}r&(h(j{&h*j&ubaubaubh)r&}r&(h(X7Simplified and fixed a lot of issues the circuits.benchr&h*jh+h.h0hh2}r&(h8]r&h:]r&h6]r&h4]r&h<]r&uh?Nh@hh#]r&h)r&}r&(h(j&h*j&h+h.h0hh2}r&(h8]r&h:]r&h6]r&h4]r&h<]r&uh?Kkh#]r&h]X7Simplified and fixed a lot of issues the circuits.benchr&r&}r&(h(j&h*j&ubaubaubh)r&}r&(h(XAFixed circuits.web's exceptions tests and handling of exceptions.r&h*jh+h.h0hh2}r&(h8]r&h:]r&h6]r&h4]r&h<]r&uh?Nh@hh#]r&h)r&}r&(h(j&h*j&h+h.h0hh2}r&(h8]r&h:]r&h6]r&h4]r&h<]r&uh?Klh#]r&h]XAFixed circuits.web's exceptions tests and handling of exceptions.r&r&}r&(h(j&h*j&ubaubaubh)r&}r&(h(X=Fixed a potential bug with ``circuits.web.wsgi.Application``.r&h*jh+h.h0hh2}r&(h8]r&h:]r&h6]r&h4]r&h<]r&uh?Nh@hh#]r&h)r&}r&(h(j&h*j&h+h.h0hh2}r&(h8]r&h:]r&h6]r&h4]r&h<]r&uh?Kmh#]r&(h]XFixed a potential bug with r&r&}r&(h(XFixed a potential bug with r&h*j&ubjK)r&}r&(h(X!``circuits.web.wsgi.Application``r&h2}r&(h8]r&h:]r&h6]r&h4]r&h<]r&uh*j&h#]r&h]Xcircuits.web.wsgi.Applicationr&r&}r&(h(Uh*j&ubah0jYubh]X.r&}r&(h(X.h*j&ubeubaubh)r&}r&(h(XIModified Manager to only assign a handler return value if it is not None.r&h*jh+h.h0hh2}r&(h8]r&h:]r&h6]r&h4]r&h<]r&uh?Nh@hh#]r&h)r&}r&(h(j&h*j&h+h.h0hh2}r&(h8]r&h:]r&h6]r&h4]r&h<]r&uh?Knh#]r&h]XIModified Manager to only assign a handler return value if it is not None.r&r&}r&(h(j&h*j&ubaubaubh)r&}r&(h(XFixed ``*_success`` and ``*_failure`` events fire on ``*event.channels`` so they go to the right place as expected. Fixed Issue #21r&h*jh+h.h0hh2}r&(h8]r&h:]r&h6]r&h4]r&h<]r&uh?Nh@hh#]r'h)r'}r'(h(j&h*j&h+h.h0hh2}r'(h8]r'h:]r'h6]r'h4]r'h<]r'uh?Koh#]r '(h]XFixed r 'r '}r '(h(XFixed r 'h*j'ubjK)r'}r'(h(X ``*_success``r'h2}r'(h8]r'h:]r'h6]r'h4]r'h<]r'uh*j'h#]r'h]X *_successr'r'}r'(h(Uh*j'ubah0jYubh]X and r'r'}r'(h(X and r'h*j'ubjK)r'}r '(h(X ``*_failure``r!'h2}r"'(h8]r#'h:]r$'h6]r%'h4]r&'h<]r''uh*j'h#]r('h]X *_failurer)'r*'}r+'(h(Uh*j'ubah0jYubh]X events fire on r,'r-'}r.'(h(X events fire on r/'h*j'ubjK)r0'}r1'(h(X``*event.channels``r2'h2}r3'(h8]r4'h:]r5'h6]r6'h4]r7'h<]r8'uh*j'h#]r9'h]X*event.channelsr:'r;'}r<'(h(Uh*j0'ubah0jYubh]X; so they go to the right place as expected. Fixed Issue #21r='r>'}r?'(h(X; so they go to the right place as expected. Fixed Issue #21r@'h*j'ubeubaubh)rA'}rB'(h(X[Removed event equality test and related tests. Seems rather useless and inconsistently usedrC'h*jh+h.h0hh2}rD'(h8]rE'h:]rF'h6]rG'h4]rH'h<]rI'uh?Nh@hh#]rJ'h)rK'}rL'(h(jC'h*jA'h+h.h0hh2}rM'(h8]rN'h:]rO'h6]rP'h4]rQ'h<]rR'uh?Kph#]rS'h]X[Removed event equality test and related tests. Seems rather useless and inconsistently usedrT'rU'}rV'(h(jC'h*jK'ubaubaubh)rW'}rX'(h(XeFixed test_gzip circuits.web test. We no longer have a Started event feedback so have to use a filterrY'h*jh+h.h0hh2}rZ'(h8]r['h:]r\'h6]r]'h4]r^'h<]r_'uh?Nh@hh#]r`'h)ra'}rb'(h(jY'h*jW'h+h.h0hh2}rc'(h8]rd'h:]re'h6]rf'h4]rg'h<]rh'uh?Kqh#]ri'h]XeFixed test_gzip circuits.web test. We no longer have a Started event feedback so have to use a filterrj'rk'}rl'(h(jY'h*ja'ubaubaubh)rm'}rn'(h(X`Fixed a corner case where one might be trying to compare an event object with a non-event objectro'h*jh+h.h0hh2}rp'(h8]rq'h:]rr'h6]rs'h4]rt'h<]ru'uh?Nh@hh#]rv'h)rw'}rx'(h(jo'h*jm'h+h.h0hh2}ry'(h8]rz'h:]r{'h6]r|'h4]r}'h<]r~'uh?Krh#]r'h]X`Fixed a corner case where one might be trying to compare an event object with a non-event objectr'r'}r'(h(jo'h*jw'ubaubaubh)r'}r'(h(XFixed the event handling for circuits.web WebSockets Component by separating out the WebSockets handling from the HTTP handling (WebSocketsMediator).r'h*jh+h.h0hh2}r'(h8]r'h:]r'h6]r'h4]r'h<]r'uh?Nh@hh#]r'h)r'}r'(h(j'h*j'h+h.h0hh2}r'(h8]r'h:]r'h6]r'h4]r'h<]r'uh?Ksh#]r'h]XFixed the event handling for circuits.web WebSockets Component by separating out the WebSockets handling from the HTTP handling (WebSocketsMediator).r'r'}r'(h(j'h*j'ubaubaubh)r'}r'(h(X=Fixed use of Value notification in circuits.web for requests.r'h*jh+h.h0hh2}r'(h8]r'h:]r'h6]r'h4]r'h<]r'uh?Nh@hh#]r'h)r'}r'(h(j'h*j'h+h.h0hh2}r'(h8]r'h:]r'h6]r'h4]r'h<]r'uh?Kth#]r'h]X=Fixed use of Value notification in circuits.web for requests.r'r'}r'(h(j'h*j'ubaubaubh)r'}r'(h(X>Fixed a bunch of examples and tests using deprecated features.r'h*jh+h.h0hh2}r'(h8]r'h:]r'h6]r'h4]r'h<]r'uh?Nh@hh#]r'h)r'}r'(h(j'h*j'h+h.h0hh2}r'(h8]r'h:]r'h6]r'h4]r'h<]r'uh?Kuh#]r'h]X>Fixed a bunch of examples and tests using deprecated features.r'r'}r'(h(j'h*j'ubaubaubh)r'}r'(h(XCFixed the notify io driver and removed Debugger() from test_notify.r'h*jh+h.h0hh2}r'(h8]r'h:]r'h6]r'h4]r'h<]r'uh?Nh@hh#]r'h)r'}r'(h(j'h*j'h+h.h0hh2}r'(h8]r'h:]r'h6]r'h4]r'h<]r'uh?Kvh#]r'h]XCFixed the notify io driver and removed Debugger() from test_notify.r'r'}r'(h(j'h*j'ubaubaubh)r'}r'(h(XCAdded man pages for circuits.bench, circuits.sniff and circuits.webr'h*jh+h.h0hh2}r'(h8]r'h:]r'h6]r'h4]r'h<]r'uh?Nh@hh#]r'h)r'}r'(h(j'h*j'h+h.h0hh2}r'(h8]r'h:]r'h6]r'h4]r'h<]r'uh?Kwh#]r'h]XCAdded man pages for circuits.bench, circuits.sniff and circuits.webr'r'}r'(h(j'h*j'ubaubaubh)r'}r'(h(X)Wrapped UNIX-specific calls in try/exceptr'h*jh+h.h0hh2}r'(h8]r'h:]r'h6]r'h4]r'h<]r'uh?Nh@hh#]r'h)r'}r'(h(j'h*j'h+h.h0hh2}r'(h8]r'h:]r'h6]r(h4]r(h<]r(uh?Kxh#]r(h]X)Wrapped UNIX-specific calls in try/exceptr(r(}r((h(j'h*j'ubaubaubh)r(}r((h(X-Tidied up examples and removed unused importsr (h*jh+h.h0hh2}r ((h8]r (h:]r (h6]r (h4]r(h<]r(uh?Nh@hh#]r(h)r(}r((h(j (h*j(h+h.h0hh2}r((h8]r(h:]r(h6]r(h4]r(h<]r(uh?Kyh#]r(h]X-Tidied up examples and removed unused importsr(r(}r((h(j (h*j(ubaubaubh)r(}r((h(X-removed use of coverage module in daemon testr(h*jh+h.h0hh2}r ((h8]r!(h:]r"(h6]r#(h4]r$(h<]r%(uh?Nh@hh#]r&(h)r'(}r(((h(j(h*j(h+h.h0hh2}r)((h8]r*(h:]r+(h6]r,(h4]r-(h<]r.(uh?Kzh#]r/(h]X-removed use of coverage module in daemon testr0(r1(}r2((h(j(h*j'(ubaubaubh)r3(}r4((h(X.removed use of coverage module in signals testr5(h*jh+h.h0hh2}r6((h8]r7(h:]r8(h6]r9(h4]r:(h<]r;(uh?Nh@hh#]r<(h)r=(}r>((h(j5(h*j3(h+h.h0hh2}r?((h8]r@(h:]rA(h6]rB(h4]rC(h<]rD(uh?K{h#]rE(h]X.removed use of coverage module in signals testrF(rG(}rH((h(j5(h*j=(ubaubaubh)rI(}rJ((h(X"updated .push calls to .fire callsrK(h*jh+h.h0hh2}rL((h8]rM(h:]rN(h6]rO(h4]rP(h<]rQ(uh?Nh@hh#]rR(h)rS(}rT((h(jK(h*jI(h+h.h0hh2}rU((h8]rV(h:]rW(h6]rX(h4]rY(h<]rZ(uh?K|h#]r[(h]X"updated .push calls to .fire callsr\(r](}r^((h(jK(h*jS(ubaubaubh)r_(}r`((h(X Fixed some deprecations warningsra(h*jh+h.h0hh2}rb((h8]rc(h:]rd(h6]re(h4]rf(h<]rg(uh?Nh@hh#]rh(h)ri(}rj((h(ja(h*j_(h+h.h0hh2}rk((h8]rl(h:]rm(h6]rn(h4]ro(h<]rp(uh?K}h#]rq(h]X Fixed some deprecations warningsrr(rs(}rt((h(ja(h*ji(ubaubaubh)ru(}rv((h(XKAdded support for multiple webserver with different channels + tests for itrw(h*jh+h.h0hh2}rx((h8]ry(h:]rz(h6]r{(h4]r|(h<]r}(uh?Nh@hh#]r~(h)r(}r((h(jw(h*ju(h+h.h0hh2}r((h8]r(h:]r(h6]r(h4]r(h<]r(uh?K~h#]r(h]XKAdded support for multiple webserver with different channels + tests for itr(r(}r((h(jw(h*j(ubaubaubh)r(}r((h(XPAdded support for silently ignoring errors when writing to stderr from debuggerr(h*jh+h.h0hh2}r((h8]r(h:]r(h6]r(h4]r(h<]r(uh?Nh@hh#]r(h)r(}r((h(j(h*j(h+h.h0hh2}r((h8]r(h:]r(h6]r(h4]r(h<]r(uh?Kh#]r(h]XPAdded support for silently ignoring errors when writing to stderr from debuggerr(r(}r((h(j(h*j(ubaubaubh)r(}r((h(XXAdded requirements.txt file containing requirements for building docs on readthedocs.orgr(h*jh+h.h0hh2}r((h8]r(h:]r(h6]r(h4]r(h<]r(uh?Nh@hh#]r(h)r(}r((h(j(h*j(h+h.h0hh2}r((h8]r(h:]r(h6]r(h4]r(h<]r(uh?Kh#]r(h]XXAdded requirements.txt file containing requirements for building docs on readthedocs.orgr(r(}r((h(j(h*j(ubaubaubh)r(}r((h(X(Added link to Read the Docs for circuitsr(h*jh+h.h0hh2}r((h8]r(h:]r(h6]r(h4]r(h<]r(uh?Nh@hh#]r(h)r(}r((h(j(h*j(h+h.h0hh2}r((h8]r(h:]r(h6]r(h4]r(h<]r(uh?Kh#]r(h]X(Added link to Read the Docs for circuitsr(r(}r((h(j(h*j(ubaubaubh)r(}r((h(X%Updated doc message for success eventr(h*jh+h.h0hh2}r((h8]r(h:]r(h6]r(h4]r(h<]r(uh?Nh@hh#]r(h)r(}r((h(j(h*j(h+h.h0hh2}r((h8]r(h:]r(h6]r(h4]r(h<]r(uh?Kh#]r(h]X%Updated doc message for success eventr(r(}r((h(j(h*j(ubaubaubh)r(}r((h(XIFixed interrupt handler to allow ^C to be used to quit sample keyecho appr(h*jh+h.h0hh2}r((h8]r(h:]r(h6]r(h4]r(h<]r(uh?Nh@hh#]r(h)r(}r((h(j(h*j(h+h.h0hh2}r((h8]r(h:]r(h6]r(h4]r(h<]r(uh?Kh#]r(h]XIFixed interrupt handler to allow ^C to be used to quit sample keyecho appr(r(}r((h(j(h*j(ubaubaubh)r(}r((h(XARemoved deprecated modules and functions that were deprecated 1.6r(h*jh+h.h0hh2}r((h8]r(h:]r(h6]r(h4]r)h<]r)uh?Nh@hh#]r)h)r)}r)(h(j(h*j(h+h.h0hh2}r)(h8]r)h:]r)h6]r)h4]r )h<]r )uh?Kh#]r )h]XARemoved deprecated modules and functions that were deprecated 1.6r )r )}r)(h(j(h*j)ubaubaubh)r)}r)(h(X1Deleted old style event success/failure notifiersr)h*jh+h.h0hh2}r)(h8]r)h:]r)h6]r)h4]r)h<]r)uh?Nh@hh#]r)h)r)}r)(h(j)h*j)h+h.h0hh2}r)(h8]r)h:]r)h6]r)h4]r)h<]r )uh?Kh#]r!)h]X1Deleted old style event success/failure notifiersr")r#)}r$)(h(j)h*j)ubaubaubh)r%)}r&)(h(XGFixed handling of components being added/removed when looking for ticksr')h*jh+h.h0hh2}r()(h8]r))h:]r*)h6]r+)h4]r,)h<]r-)uh?Nh@hh#]r.)h)r/)}r0)(h(j')h*j%)h+h.h0hh2}r1)(h8]r2)h:]r3)h6]r4)h4]r5)h<]r6)uh?Kh#]r7)h]XGFixed handling of components being added/removed when looking for ticksr8)r9)}r:)(h(j')h*j/)ubaubaubh)r;)}r<)(h(X9Fixed bug with ``net.Server`` .host and .port attributes.r=)h*jh+h.h0hh2}r>)(h8]r?)h:]r@)h6]rA)h4]rB)h<]rC)uh?Nh@hh#]rD)h)rE)}rF)(h(j=)h*j;)h+h.h0hh2}rG)(h8]rH)h:]rI)h6]rJ)h4]rK)h<]rL)uh?Kh#]rM)(h]XFixed bug with rN)rO)}rP)(h(XFixed bug with rQ)h*jE)ubjK)rR)}rS)(h(X``net.Server``rT)h2}rU)(h8]rV)h:]rW)h6]rX)h4]rY)h<]rZ)uh*jE)h#]r[)h]X net.Serverr\)r])}r^)(h(Uh*jR)ubah0jYubh]X .host and .port attributes.r_)r`)}ra)(h(X .host and .port attributes.rb)h*jE)ubeubaubh)rc)}rd)(h(XSDeprecated ``__tick__``. Event handlers can now be specified as **tick** functions.re)h*jh+h.h0hh2}rf)(h8]rg)h:]rh)h6]ri)h4]rj)h<]rk)uh?Nh@hh#]rl)h)rm)}rn)(h(je)h*jc)h+h.h0hh2}ro)(h8]rp)h:]rq)h6]rr)h4]rs)h<]rt)uh?Kh#]ru)(h]X Deprecated rv)rw)}rx)(h(X Deprecated ry)h*jm)ubjK)rz)}r{)(h(X ``__tick__``r|)h2}r})(h8]r~)h:]r)h6]r)h4]r)h<]r)uh*jm)h#]r)h]X__tick__r)r)}r)(h(Uh*jz)ubah0jYubh]X). Event handlers can now be specified as r)r)}r)(h(X). Event handlers can now be specified as r)h*jm)ubcdocutils.nodes strong r))r)}r)(h(X**tick**r)h2}r)(h8]r)h:]r)h6]r)h4]r)h<]r)uh*jm)h#]r)h]Xtickr)r)}r)(h(Uh*j)ubah0Ustrongr)ubh]X functions.r)r)}r)(h(X functions.r)h*jm)ubeubaubh)r)}r)(h(XVFixed handler priority inheritance to make sure we get the results in the right harderr)h*jh+h.h0hh2}r)(h8]r)h:]r)h6]r)h4]r)h<]r)uh?Nh@hh#]r)h)r)}r)(h(j)h*j)h+h.h0hh2}r)(h8]r)h:]r)h6]r)h4]r)h<]r)uh?Kh#]r)h]XVFixed handler priority inheritance to make sure we get the results in the right harderr)r)}r)(h(j)h*j)ubaubaubh)r)}r)(h(X,Fixed missing import of sys in circuits.io r)h*jh+h.h0hh2}r)(h8]r)h:]r)h6]r)h4]r)h<]r)uh?Nh@hh#]r)h)r)}r)(h(X*Fixed missing import of sys in circuits.ior)h*j)h+h.h0hh2}r)(h8]r)h:]r)h6]r)h4]r)h<]r)uh?Kh#]r)h]X*Fixed missing import of sys in circuits.ior)r)}r)(h(j)h*j)ubaubaubeubeubhB)r)}r)(h(Uh*hCh+h.h0hGh2}r)(h8]r)h:]r)h6]r)h4]r)h ah<]r)h auh?Kh@hh#]r)(hQ)r)}r)(h(X circuits-1.6 (oceans) - 20110626r)h*j)h+h.h0hUh2}r)(h8]r)h:]r)h6]r)h4]r)h<]r)uh?Kh@hh#]r)h]X circuits-1.6 (oceans) - 20110626r)r)}r)(h(j)h*j)ubaubh)r)}r)(h(Uh*j)h+h.h0hh2}r)(hX-h4]r)h6]r)h8]r)h:]r)h<]r)uh?Kh@hh#]r)(h)r)}r)(h(XAdded Python 3 supportr)h*j)h+h.h0hh2}r)(h8]r)h:]r)h6]r)h4]r)h<]r)uh?Nh@hh#]r)h)r)}r)(h(j)h*j)h+h.h0hh2}r)(h8]r)h:]r)h6]r)h4]r)h<]r)uh?Kh#]r)h]XAdded Python 3 supportr)r)}r)(h(j)h*j)ubaubaubh)r*}r*(h(X80% Code Coverager*h*j)h+h.h0hh2}r*(h8]r*h:]r*h6]r*h4]r*h<]r*uh?Nh@hh#]r *h)r *}r *(h(j*h*j*h+h.h0hh2}r *(h8]r *h:]r*h6]r*h4]r*h<]r*uh?Kh#]r*h]X80% Code Coverager*r*}r*(h(j*h*j *ubaubaubh)r*}r*(h(XgAdded optional greenlet support adding two new primitives. ``.waitEvent(...)`` and ``.callEvent(...)``.r*h*j)h+h.h0hh2}r*(h8]r*h:]r*h6]r*h4]r*h<]r*uh?Nh@hh#]r*h)r *}r!*(h(XgAdded optional greenlet support adding two new primitives. ``.waitEvent(...)`` and ``.callEvent(...)``.r"*h*j*h+h.h0hh2}r#*(h8]r$*h:]r%*h6]r&*h4]r'*h<]r(*uh?Kh#]r)*(h]X;Added optional greenlet support adding two new primitives. r**r+*}r,*(h(X;Added optional greenlet support adding two new primitives. r-*h*j *ubjK)r.*}r/*(h(X``.waitEvent(...)``r0*h2}r1*(h8]r2*h:]r3*h6]r4*h4]r5*h<]r6*uh*j *h#]r7*h]X.waitEvent(...)r8*r9*}r:*(h(Uh*j.*ubah0jYubh]X and r;*r<*}r=*(h(X and r>*h*j *ubjK)r?*}r@*(h(X``.callEvent(...)``rA*h2}rB*(h8]rC*h:]rD*h6]rE*h4]rF*h<]rG*uh*j *h#]rH*h]X.callEvent(...)rI*rJ*}rK*(h(Uh*j?*ubah0jYubh]X.rL*}rM*(h(X.h*j *ubeubaubh)rN*}rO*(h(X5Added an example WebSockets server using circuits.webrP*h*j)h+h.h0hh2}rQ*(h8]rR*h:]rS*h6]rT*h4]rU*h<]rV*uh?Nh@hh#]rW*h)rX*}rY*(h(jP*h*jN*h+h.h0hh2}rZ*(h8]r[*h:]r\*h6]r]*h4]r^*h<]r_*uh?Kh#]r`*h]X5Added an example WebSockets server using circuits.webra*rb*}rc*(h(jP*h*jX*ubaubaubh)rd*}re*(h(XAdded support for specifying a ``Poll`` instance to use when using the ``@future`` decorator to create "future" event handlers.rf*h*j)h+h.h0hh2}rg*(h8]rh*h:]ri*h6]rj*h4]rk*h<]rl*uh?Nh@hh#]rm*h)rn*}ro*(h(XAdded support for specifying a ``Poll`` instance to use when using the ``@future`` decorator to create "future" event handlers.rp*h*jd*h+h.h0hh2}rq*(h8]rr*h:]rs*h6]rt*h4]ru*h<]rv*uh?Kh#]rw*(h]XAdded support for specifying a rx*ry*}rz*(h(XAdded support for specifying a r{*h*jn*ubjK)r|*}r}*(h(X``Poll``r~*h2}r*(h8]r*h:]r*h6]r*h4]r*h<]r*uh*jn*h#]r*h]XPollr*r*}r*(h(Uh*j|*ubah0jYubh]X instance to use when using the r*r*}r*(h(X instance to use when using the r*h*jn*ubjK)r*}r*(h(X ``@future``r*h2}r*(h8]r*h:]r*h6]r*h4]r*h<]r*uh*jn*h#]r*h]X@futurer*r*}r*(h(Uh*j*ubah0jYubh]X- decorator to create "future" event handlers.r*r*}r*(h(X- decorator to create "future" event handlers.r*h*jn*ubeubaubh)r*}r*(h(X^Added ``add_section``, ``has_section`` and ``set`` methods to ``app.config.Config`` Component.r*h*j)h+h.h0hh2}r*(h8]r*h:]r*h6]r*h4]r*h<]r*uh?Nh@hh#]r*h)r*}r*(h(X^Added ``add_section``, ``has_section`` and ``set`` methods to ``app.config.Config`` Component.r*h*j*h+h.h0hh2}r*(h8]r*h:]r*h6]r*h4]r*h<]r*uh?Kh#]r*(h]XAdded r*r*}r*(h(XAdded r*h*j*ubjK)r*}r*(h(X``add_section``r*h2}r*(h8]r*h:]r*h6]r*h4]r*h<]r*uh*j*h#]r*h]X add_sectionr*r*}r*(h(Uh*j*ubah0jYubh]X, r*r*}r*(h(X, r*h*j*ubjK)r*}r*(h(X``has_section``r*h2}r*(h8]r*h:]r*h6]r*h4]r*h<]r*uh*j*h#]r*h]X has_sectionr*r*}r*(h(Uh*j*ubah0jYubh]X and r*r*}r*(h(X and r*h*j*ubjK)r*}r*(h(X``set``r*h2}r*(h8]r*h:]r*h6]r*h4]r*h<]r*uh*j*h#]r*h]Xsetr*r*}r*(h(Uh*j*ubah0jYubh]X methods to r*r*}r*(h(X methods to r*h*j*ubjK)r*}r*(h(X``app.config.Config``r*h2}r*(h8]r*h:]r*h6]r*h4]r*h<]r*uh*j*h#]r*h]Xapp.config.Configr*r*}r*(h(Uh*j*ubah0jYubh]X Component.r*r*}r*(h(X Component.r*h*j*ubeubaubh)r*}r*(h(XMAdded support for running test suite with distutils ``python setup.py test``.r*h*j)h+h.h0hh2}r*(h8]r*h:]r*h6]r+h4]r+h<]r+uh?Nh@hh#]r+h)r+}r+(h(XMAdded support for running test suite with distutils ``python setup.py test``.r+h*j*h+h.h0hh2}r+(h8]r+h:]r +h6]r +h4]r +h<]r +uh?Kh#]r +(h]X4Added support for running test suite with distutils r+r+}r+(h(X4Added support for running test suite with distutils r+h*j+ubjK)r+}r+(h(X``python setup.py test``r+h2}r+(h8]r+h:]r+h6]r+h4]r+h<]r+uh*j+h#]r+h]Xpython setup.py testr+r+}r+(h(Uh*j+ubah0jYubh]X.r+}r +(h(X.h*j+ubeubaubh)r!+}r"+(h(XAdded a ``_on_signal`` event handler on the ``BaseEnvironment`` Component so that environments can be reloaded by listening to ``SIGHUP`` signals.r#+h*j)h+h.h0hh2}r$+(h8]r%+h:]r&+h6]r'+h4]r(+h<]r)+uh?Nh@hh#]r*+h)r++}r,+(h(XAdded a ``_on_signal`` event handler on the ``BaseEnvironment`` Component so that environments can be reloaded by listening to ``SIGHUP`` signals.r-+h*j!+h+h.h0hh2}r.+(h8]r/+h:]r0+h6]r1+h4]r2+h<]r3+uh?Kh#]r4+(h]XAdded a r5+r6+}r7+(h(XAdded a r8+h*j++ubjK)r9+}r:+(h(X``_on_signal``r;+h2}r<+(h8]r=+h:]r>+h6]r?+h4]r@+h<]rA+uh*j++h#]rB+h]X _on_signalrC+rD+}rE+(h(Uh*j9+ubah0jYubh]X event handler on the rF+rG+}rH+(h(X event handler on the rI+h*j++ubjK)rJ+}rK+(h(X``BaseEnvironment``rL+h2}rM+(h8]rN+h:]rO+h6]rP+h4]rQ+h<]rR+uh*j++h#]rS+h]XBaseEnvironmentrT+rU+}rV+(h(Uh*jJ+ubah0jYubh]X@ Component so that environments can be reloaded by listening to rW+rX+}rY+(h(X@ Component so that environments can be reloaded by listening to rZ+h*j++ubjK)r[+}r\+(h(X ``SIGHUP``r]+h2}r^+(h8]r_+h:]r`+h6]ra+h4]rb+h<]rc+uh*j++h#]rd+h]XSIGHUPre+rf+}rg+(h(Uh*j[+ubah0jYubh]X signals.rh+ri+}rj+(h(X signals.rk+h*j++ubeubaubh)rl+}rm+(h(XBAdded support for using absolute paths in ``app.env.Environment``.rn+h*j)h+h.h0hh2}ro+(h8]rp+h:]rq+h6]rr+h4]rs+h<]rt+uh?Nh@hh#]ru+h)rv+}rw+(h(jn+h*jl+h+h.h0hh2}rx+(h8]ry+h:]rz+h6]r{+h4]r|+h<]r}+uh?Kh#]r~+(h]X*Added support for using absolute paths in r+r+}r+(h(X*Added support for using absolute paths in r+h*jv+ubjK)r+}r+(h(X``app.env.Environment``r+h2}r+(h8]r+h:]r+h6]r+h4]r+h<]r+uh*jv+h#]r+h]Xapp.env.Environmentr+r+}r+(h(Uh*j+ubah0jYubh]X.r+}r+(h(X.h*jv+ubeubaubh)r+}r+(h(XqAdded support in circuits.web ``HTTP`` protocol to limit the no. of header fragments. This prevents OOM exploits.r+h*j)h+h.h0hh2}r+(h8]r+h:]r+h6]r+h4]r+h<]r+uh?Nh@hh#]r+h)r+}r+(h(XqAdded support in circuits.web ``HTTP`` protocol to limit the no. of header fragments. This prevents OOM exploits.r+h*j+h+h.h0hh2}r+(h8]r+h:]r+h6]r+h4]r+h<]r+uh?Kh#]r+(h]XAdded support in circuits.web r+r+}r+(h(XAdded support in circuits.web r+h*j+ubjK)r+}r+(h(X``HTTP``r+h2}r+(h8]r+h:]r+h6]r+h4]r+h<]r+uh*j+h#]r+h]XHTTPr+r+}r+(h(Uh*j+ubah0jYubh]XK protocol to limit the no. of header fragments. This prevents OOM exploits.r+r+}r+(h(XK protocol to limit the no. of header fragments. This prevents OOM exploits.r+h*j+ubeubaubh)r+}r+(h(X Added a ticks limit to waitEventr+h*j)h+h.h0hh2}r+(h8]r+h:]r+h6]r+h4]r+h<]r+uh?Nh@hh#]r+h)r+}r+(h(j+h*j+h+h.h0hh2}r+(h8]r+h:]r+h6]r+h4]r+h<]r+uh?Kh#]r+h]X Added a ticks limit to waitEventr+r+}r+(h(j+h*j+ubaubaubh)r+}r+(h(X=Added deprecation warnings for .push .add and .remove methodsr+h*j)h+h.h0hh2}r+(h8]r+h:]r+h6]r+h4]r+h<]r+uh?Nh@hh#]r+h)r+}r+(h(j+h*j+h+h.h0hh2}r+(h8]r+h:]r+h6]r+h4]r+h<]r+uh?Kh#]r+h]X=Added deprecation warnings for .push .add and .remove methodsr+r+}r+(h(j+h*j+ubaubaubh)r+}r+(h(XHNEW ``Loader`` Component in ``circuits.core`` for simple plugin support.r+h*j)h+h.h0hh2}r+(h8]r+h:]r+h6]r+h4]r+h<]r+uh?Nh@hh#]r+h)r+}r+(h(j+h*j+h+h.h0hh2}r+(h8]r+h:]r+h6]r+h4]r+h<]r+uh?Kh#]r+(h]XNEW r+r+}r+(h(XNEW r+h*j+ubjK)r+}r+(h(X ``Loader``r,h2}r,(h8]r,h:]r,h6]r,h4]r,h<]r,uh*j+h#]r,h]XLoaderr,r ,}r ,(h(Uh*j+ubah0jYubh]X Component in r ,r ,}r ,(h(X Component in r,h*j+ubjK)r,}r,(h(X``circuits.core``r,h2}r,(h8]r,h:]r,h6]r,h4]r,h<]r,uh*j+h#]r,h]X circuits.corer,r,}r,(h(Uh*j,ubah0jYubh]X for simple plugin support.r,r,}r,(h(X for simple plugin support.r,h*j+ubeubaubh)r ,}r!,(h(XNEW ``app.env`` and ``app.config`` modules including a new ``app.startup`` modules integrating a common startup for applications.r",h*j)h+h.h0hh2}r#,(h8]r$,h:]r%,h6]r&,h4]r',h<]r(,uh?Nh@hh#]r),h)r*,}r+,(h(XNEW ``app.env`` and ``app.config`` modules including a new ``app.startup`` modules integrating a common startup for applications.r,,h*j ,h+h.h0hh2}r-,(h8]r.,h:]r/,h6]r0,h4]r1,h<]r2,uh?Kh#]r3,(h]XNEW r4,r5,}r6,(h(XNEW r7,h*j*,ubjK)r8,}r9,(h(X ``app.env``r:,h2}r;,(h8]r<,h:]r=,h6]r>,h4]r?,h<]r@,uh*j*,h#]rA,h]Xapp.envrB,rC,}rD,(h(Uh*j8,ubah0jYubh]X and rE,rF,}rG,(h(X and rH,h*j*,ubjK)rI,}rJ,(h(X``app.config``rK,h2}rL,(h8]rM,h:]rN,h6]rO,h4]rP,h<]rQ,uh*j*,h#]rR,h]X app.configrS,rT,}rU,(h(Uh*jI,ubah0jYubh]X modules including a new rV,rW,}rX,(h(X modules including a new rY,h*j*,ubjK)rZ,}r[,(h(X``app.startup``r\,h2}r],(h8]r^,h:]r_,h6]r`,h4]ra,h<]rb,uh*j*,h#]rc,h]X app.startuprd,re,}rf,(h(Uh*jZ,ubah0jYubh]X7 modules integrating a common startup for applications.rg,rh,}ri,(h(X7 modules integrating a common startup for applications.rj,h*j*,ubeubaubh)rk,}rl,(h(XNEW ``KQueue`` pollerrm,h*j)h+h.h0hh2}rn,(h8]ro,h:]rp,h6]rq,h4]rr,h<]rs,uh?Nh@hh#]rt,h)ru,}rv,(h(jm,h*jk,h+h.h0hh2}rw,(h8]rx,h:]ry,h6]rz,h4]r{,h<]r|,uh?Kh#]r},(h]XNEW r~,r,}r,(h(XNEW r,h*ju,ubjK)r,}r,(h(X ``KQueue``r,h2}r,(h8]r,h:]r,h6]r,h4]r,h<]r,uh*ju,h#]r,h]XKQueuer,r,}r,(h(Uh*j,ubah0jYubh]X pollerr,r,}r,(h(X pollerr,h*ju,ubeubaubh)r,}r,(h(XFixed :bbissue:`17`r,h*j)h+h.h0hh2}r,(h8]r,h:]r,h6]r,h4]r,h<]r,uh?Nh@hh#]r,h)r,}r,(h(j,h*j,h+h.h0hh2}r,(h8]r,h:]r,h6]r,h4]r,h<]r,uh?Kh#]r,(h]XFixed r,r,}r,(h(XFixed r,h*j,ubj\$)r,}r,(h(X :bbissue:`17`r,h2}r,(Urefurir,U1https://bitbucket.org/prologic/circuits/issue/17/r,h4]r,h6]r,h8]r,h:]r,h<]r,uh*j,h#]r,h]Xissue 17r,r,}r,(h(Uh*j,ubah0jl$ubeubaubh)r,}r,(h(XpRenamed ``circuits.web.main`` module to ``circuits.web.__main__`` so that ``python -m circuits.web`` just works.r,h*j)h+h.h0hh2}r,(h8]r,h:]r,h6]r,h4]r,h<]r,uh?Nh@hh#]r,h)r,}r,(h(XpRenamed ``circuits.web.main`` module to ``circuits.web.__main__`` so that ``python -m circuits.web`` just works.r,h*j,h+h.h0hh2}r,(h8]r,h:]r,h6]r,h4]r,h<]r,uh?Kh#]r,(h]XRenamed r,r,}r,(h(XRenamed r,h*j,ubjK)r,}r,(h(X``circuits.web.main``r,h2}r,(h8]r,h:]r,h6]r,h4]r,h<]r,uh*j,h#]r,h]Xcircuits.web.mainr,r,}r,(h(Uh*j,ubah0jYubh]X module to r,r,}r,(h(X module to r,h*j,ubjK)r,}r,(h(X``circuits.web.__main__``r,h2}r,(h8]r,h:]r,h6]r,h4]r,h<]r,uh*j,h#]r,h]Xcircuits.web.__main__r,r,}r,(h(Uh*j,ubah0jYubh]X so that r,r,}r,(h(X so that r,h*j,ubjK)r,}r,(h(X``python -m circuits.web``r,h2}r,(h8]r,h:]r,h6]r,h4]r,h<]r,uh*j,h#]r,h]Xpython -m circuits.webr,r,}r,(h(Uh*j,ubah0jYubh]X just works.r-r-}r-(h(X just works.r-h*j,ubeubaubh)r-}r-(h(XQFixed ``Server.host`` and ``Server.port`` properties in ``circuits.net.sockets``.r-h*j)h+h.h0hh2}r-(h8]r-h:]r -h6]r -h4]r -h<]r -uh?Nh@hh#]r -h)r-}r-(h(XQFixed ``Server.host`` and ``Server.port`` properties in ``circuits.net.sockets``.r-h*j-h+h.h0hh2}r-(h8]r-h:]r-h6]r-h4]r-h<]r-uh?Kh#]r-(h]XFixed r-r-}r-(h(XFixed r-h*j-ubjK)r-}r-(h(X``Server.host``r-h2}r-(h8]r -h:]r!-h6]r"-h4]r#-h<]r$-uh*j-h#]r%-h]X Server.hostr&-r'-}r(-(h(Uh*j-ubah0jYubh]X and r)-r*-}r+-(h(X and r,-h*j-ubjK)r--}r.-(h(X``Server.port``r/-h2}r0-(h8]r1-h:]r2-h6]r3-h4]r4-h<]r5-uh*j-h#]r6-h]X Server.portr7-r8-}r9-(h(Uh*j--ubah0jYubh]X properties in r:-r;-}r<-(h(X properties in r=-h*j-ubjK)r>-}r?-(h(X``circuits.net.sockets``r@-h2}rA-(h8]rB-h:]rC-h6]rD-h4]rE-h<]rF-uh*j-h#]rG-h]Xcircuits.net.socketsrH-rI-}rJ-(h(Uh*j>-ubah0jYubh]X.rK-}rL-(h(X.h*j-ubeubaubh)rM-}rN-(h(XFixed :bbissue:`10`rO-h*j)h+h.h0hh2}rP-(h8]rQ-h:]rR-h6]rS-h4]rT-h<]rU-uh?Nh@hh#]rV-h)rW-}rX-(h(jO-h*jM-h+h.h0hh2}rY-(h8]rZ-h:]r[-h6]r\-h4]r]-h<]r^-uh?Kh#]r_-(h]XFixed r`-ra-}rb-(h(XFixed rc-h*jW-ubj\$)rd-}re-(h(X :bbissue:`10`rf-h2}rg-(Urefurirh-U1https://bitbucket.org/prologic/circuits/issue/10/ri-h4]rj-h6]rk-h8]rl-h:]rm-h<]rn-uh*jW-h#]ro-h]Xissue 10rp-rq-}rr-(h(Uh*jd-ubah0jl$ubeubaubh)rs-}rt-(h(XAFixed ``app.Daemon`` Component to correctly open the stderr file.ru-h*j)h+h.h0hh2}rv-(h8]rw-h:]rx-h6]ry-h4]rz-h<]r{-uh?Nh@hh#]r|-h)r}-}r~-(h(ju-h*js-h+h.h0hh2}r-(h8]r-h:]r-h6]r-h4]r-h<]r-uh?Kh#]r-(h]XFixed r-r-}r-(h(XFixed r-h*j}-ubjK)r-}r-(h(X``app.Daemon``r-h2}r-(h8]r-h:]r-h6]r-h4]r-h<]r-uh*j}-h#]r-h]X app.Daemonr-r-}r-(h(Uh*j-ubah0jYubh]X- Component to correctly open the stderr file.r-r-}r-(h(X- Component to correctly open the stderr file.r-h*j}-ubeubaubh)r-}r-(h(X'Fixed triggering of ``Success`` events.r-h*j)h+h.h0hh2}r-(h8]r-h:]r-h6]r-h4]r-h<]r-uh?Nh@hh#]r-h)r-}r-(h(j-h*j-h+h.h0hh2}r-(h8]r-h:]r-h6]r-h4]r-h<]r-uh?Kh#]r-(h]XFixed triggering of r-r-}r-(h(XFixed triggering of r-h*j-ubjK)r-}r-(h(X ``Success``r-h2}r-(h8]r-h:]r-h6]r-h4]r-h<]r-uh*j-h#]r-h]XSuccessr-r-}r-(h(Uh*j-ubah0jYubh]X events.r-r-}r-(h(X events.r-h*j-ubeubaubh)r-}r-(h(X2Fixed duplicate broadcast handler in ``UDPServer``r-h*j)h+h.h0hh2}r-(h8]r-h:]r-h6]r-h4]r-h<]r-uh?Nh@hh#]r-h)r-}r-(h(j-h*j-h+h.h0hh2}r-(h8]r-h:]r-h6]r-h4]r-h<]r-uh?Kh#]r-(h]X%Fixed duplicate broadcast handler in r-r-}r-(h(X%Fixed duplicate broadcast handler in r-h*j-ubjK)r-}r-(h(X ``UDPServer``r-h2}r-(h8]r-h:]r-h6]r-h4]r-h<]r-uh*j-h#]r-h]X UDPServerr-r-}r-(h(Uh*j-ubah0jYubeubaubh)r-}r-(h(X`Fixed duplicate ``Disconnect`` event from being triggered twice on ``Client`` socket components.r-h*j)h+h.h0hh2}r-(h8]r-h:]r-h6]r-h4]r-h<]r-uh?Nh@hh#]r-h)r-}r-(h(X`Fixed duplicate ``Disconnect`` event from being triggered twice on ``Client`` socket components.r-h*j-h+h.h0hh2}r-(h8]r-h:]r-h6]r-h4]r-h<]r-uh?Kh#]r-(h]XFixed duplicate r-r-}r-(h(XFixed duplicate r-h*j-ubjK)r-}r.(h(X``Disconnect``r.h2}r.(h8]r.h:]r.h6]r.h4]r.h<]r.uh*j-h#]r.h]X Disconnectr .r .}r .(h(Uh*j-ubah0jYubh]X% event from being triggered twice on r .r .}r.(h(X% event from being triggered twice on r.h*j-ubjK)r.}r.(h(X ``Client``r.h2}r.(h8]r.h:]r.h6]r.h4]r.h<]r.uh*j-h#]r.h]XClientr.r.}r.(h(Uh*j.ubah0jYubh]X socket components.r.r.}r.(h(X socket components.r .h*j-ubeubaubh)r!.}r".(h(X4Removed dynamic timeout code from ``Select`` poller.r#.h*j)h+h.h0hh2}r$.(h8]r%.h:]r&.h6]r'.h4]r(.h<]r).uh?Nh@hh#]r*.h)r+.}r,.(h(j#.h*j!.h+h.h0hh2}r-.(h8]r..h:]r/.h6]r0.h4]r1.h<]r2.uh?Kh#]r3.(h]X"Removed dynamic timeout code from r4.r5.}r6.(h(X"Removed dynamic timeout code from r7.h*j+.ubjK)r8.}r9.(h(X ``Select``r:.h2}r;.(h8]r<.h:]r=.h6]r>.h4]r?.h<]r@.uh*j+.h#]rA.h]XSelectrB.rC.}rD.(h(Uh*j8.ubah0jYubh]X poller.rE.rF.}rG.(h(X poller.rH.h*j+.ubeubaubh)rI.}rJ.(h(XcFixed a bug in the circuits.web ``HTTP`` protocol where headers were not being buffered per client.rK.h*j)h+h.h0hh2}rL.(h8]rM.h:]rN.h6]rO.h4]rP.h<]rQ.uh?Nh@hh#]rR.h)rS.}rT.(h(XcFixed a bug in the circuits.web ``HTTP`` protocol where headers were not being buffered per client.rU.h*jI.h+h.h0hh2}rV.(h8]rW.h:]rX.h6]rY.h4]rZ.h<]r[.uh?Kh#]r\.(h]X Fixed a bug in the circuits.web r].r^.}r_.(h(X Fixed a bug in the circuits.web r`.h*jS.ubjK)ra.}rb.(h(X``HTTP``rc.h2}rd.(h8]re.h:]rf.h6]rg.h4]rh.h<]ri.uh*jS.h#]rj.h]XHTTPrk.rl.}rm.(h(Uh*ja.ubah0jYubh]X; protocol where headers were not being buffered per client.rn.ro.}rp.(h(X; protocol where headers were not being buffered per client.rq.h*jS.ubeubaubh)rr.}rs.(h(XIFixes a missing Event ``Closed()`` not being triggered for ``UDPServer``.rt.h*j)h+h.h0hh2}ru.(h8]rv.h:]rw.h6]rx.h4]ry.h<]rz.uh?Nh@hh#]r{.h)r|.}r}.(h(jt.h*jr.h+h.h0hh2}r~.(h8]r.h:]r.h6]r.h4]r.h<]r.uh?Kh#]r.(h]XFixes a missing Event r.r.}r.(h(XFixes a missing Event r.h*j|.ubjK)r.}r.(h(X ``Closed()``r.h2}r.(h8]r.h:]r.h6]r.h4]r.h<]r.uh*j|.h#]r.h]XClosed()r.r.}r.(h(Uh*j.ubah0jYubh]X not being triggered for r.r.}r.(h(X not being triggered for r.h*j|.ubjK)r.}r.(h(X ``UDPServer``r.h2}r.(h8]r.h:]r.h6]r.h4]r.h<]r.uh*j|.h#]r.h]X UDPServerr.r.}r.(h(Uh*j.ubah0jYubh]X.r.}r.(h(X.h*j|.ubeubaubh)r.}r.(h(XIMake underlying ``UDPServer`` socket reusable by setting ``SO_REUSEADDR``r.h*j)h+h.h0hh2}r.(h8]r.h:]r.h6]r.h4]r.h<]r.uh?Nh@hh#]r.h)r.}r.(h(j.h*j.h+h.h0hh2}r.(h8]r.h:]r.h6]r.h4]r.h<]r.uh?Kh#]r.(h]XMake underlying r.r.}r.(h(XMake underlying r.h*j.ubjK)r.}r.(h(X ``UDPServer``r.h2}r.(h8]r.h:]r.h6]r.h4]r.h<]r.uh*j.h#]r.h]X UDPServerr.r.}r.(h(Uh*j.ubah0jYubh]X socket reusable by setting r.r.}r.(h(X socket reusable by setting r.h*j.ubjK)r.}r.(h(X``SO_REUSEADDR``r.h2}r.(h8]r.h:]r.h6]r.h4]r.h<]r.uh*j.h#]r.h]X SO_REUSEADDRr.r.}r.(h(Uh*j.ubah0jYubeubaubh)r.}r.(h(X?Fixes Server socket being discarded twice on close + disconnectr.h*j)h+h.h0hh2}r.(h8]r.h:]r.h6]r.h4]r.h<]r.uh?Nh@hh#]r.h)r.}r.(h(j.h*j.h+h.h0hh2}r.(h8]r.h:]r.h6]r.h4]r.h<]r.uh?Kh#]r.h]X?Fixes Server socket being discarded twice on close + disconnectr.r.}r.(h(j.h*j.ubaubaubh)r.}r.(h(XFSocket.write now expects bytes (bytes for python3 and str for python2)r.h*j)h+h.h0hh2}r.(h8]r.h:]r.h6]r.h4]r.h<]r.uh?Nh@hh#]r.h)r.}r.(h(j.h*j.h+h.h0hh2}r/(h8]r/h:]r/h6]r/h4]r/h<]r/uh?Kh#]r/h]XFSocket.write now expects bytes (bytes for python3 and str for python2)r/r/}r /(h(j.h*j.ubaubaubh)r /}r /(h(XHBetter handling of encoding in HTTP Component (allow non utf-8 encoding)r /h*j)h+h.h0hh2}r /(h8]r/h:]r/h6]r/h4]r/h<]r/uh?Nh@hh#]r/h)r/}r/(h(j /h*j /h+h.h0hh2}r/(h8]r/h:]r/h6]r/h4]r/h<]r/uh?Kh#]r/h]XHBetter handling of encoding in HTTP Component (allow non utf-8 encoding)r/r/}r/(h(j /h*j/ubaubaubh)r /}r!/(h(X#Always encode HTTP headers in utf-8r"/h*j)h+h.h0hh2}r#/(h8]r$/h:]r%/h6]r&/h4]r'/h<]r(/uh?Nh@hh#]r)/h)r*/}r+/(h(j"/h*j /h+h.h0hh2}r,/(h8]r-/h:]r./h6]r//h4]r0/h<]r1/uh?Kh#]r2/h]X#Always encode HTTP headers in utf-8r3/r4/}r5/(h(j"/h*j*/ubaubaubh)r6/}r7/(h(X/Fixes error after getting socket.ERRCONNREFUSEDr8/h*j)h+h.h0hh2}r9/(h8]r:/h:]r;/h6]r/uh?Nh@hh#]r?/h)r@/}rA/(h(j8/h*j6/h+h.h0hh2}rB/(h8]rC/h:]rD/h6]rE/h4]rF/h<]rG/uh?Kh#]rH/h]X/Fixes error after getting socket.ERRCONNREFUSEDrI/rJ/}rK/(h(j8/h*j@/ubaubaubh)rL/}rM/(h(X+Allows TCPClient to bind to a specific portrN/h*j)h+h.h0hh2}rO/(h8]rP/h:]rQ/h6]rR/h4]rS/h<]rT/uh?Nh@hh#]rU/h)rV/}rW/(h(jN/h*jL/h+h.h0hh2}rX/(h8]rY/h:]rZ/h6]r[/h4]r\/h<]r]/uh?Kh#]r^/h]X+Allows TCPClient to bind to a specific portr_/r`/}ra/(h(jN/h*jV/ubaubaubh)rb/}rc/(h(X Improved docsrd/h*j)h+h.h0hh2}re/(h8]rf/h:]rg/h6]rh/h4]ri/h<]rj/uh?Nh@hh#]rk/h)rl/}rm/(h(jd/h*jb/h+h.h0hh2}rn/(h8]ro/h:]rp/h6]rq/h4]rr/h<]rs/uh?Kh#]rt/h]X Improved docsru/rv/}rw/(h(jd/h*jl/ubaubaubh)rx/}ry/(h(X?Handles closing of UDPServer socket when no client is connectedrz/h*j)h+h.h0hh2}r{/(h8]r|/h:]r}/h6]r~/h4]r/h<]r/uh?Nh@hh#]r/h)r/}r/(h(jz/h*jx/h+h.h0hh2}r/(h8]r/h:]r/h6]r/h4]r/h<]r/uh?Kh#]r/h]X?Handles closing of UDPServer socket when no client is connectedr/r/}r/(h(jz/h*j/ubaubaubh)r/}r/(h(X*Adds an un-register handler for componentsr/h*j)h+h.h0hh2}r/(h8]r/h:]r/h6]r/h4]r/h<]r/uh?Nh@hh#]r/h)r/}r/(h(j/h*j/h+h.h0hh2}r/(h8]r/h:]r/h6]r/h4]r/h<]r/uh?Kh#]r/h]X*Adds an un-register handler for componentsr/r/}r/(h(j/h*j/ubaubaubh)r/}r/(h(X1Allows utils.kill to work from a different threadr/h*j)h+h.h0hh2}r/(h8]r/h:]r/h6]r/h4]r/h<]r/uh?Nh@hh#]r/h)r/}r/(h(j/h*j/h+h.h0hh2}r/(h8]r/h:]r/h6]r/h4]r/h<]r/uh?Kh#]r/h]X1Allows utils.kill to work from a different threadr/r/}r/(h(j/h*j/ubaubaubh)r/}r/(h(X3Fixes bug when handling "*" in channels and targetsr/h*j)h+h.h0hh2}r/(h8]r/h:]r/h6]r/h4]r/h<]r/uh?Nh@hh#]r/h)r/}r/(h(j/h*j/h+h.h0hh2}r/(h8]r/h:]r/h6]r/h4]r/h<]r/uh?Kh#]r/h]X3Fixes bug when handling "*" in channels and targetsr/r/}r/(h(X3Fixes bug when handling "*" in channels and targetsr/h*j/ubaubaubh)r/}r/(h(X;Fixes a bug that could occur when un-registering componentsr/h*j)h+h.h0hh2}r/(h8]r/h:]r/h6]r/h4]r/h<]r/uh?Nh@hh#]r/h)r/}r/(h(j/h*j/h+h.h0hh2}r/(h8]r/h:]r/h6]r/h4]r/h<]r/uh?Kh#]r/h]X;Fixes a bug that could occur when un-registering componentsr/r/}r/(h(j/h*j/ubaubaubh)r/}r/(h(XgFixes for CPU usage problems when using circuits with no I/O pollers and using a Timer for timed eventsr/h*j)h+h.h0hh2}r/(h8]r/h:]r/h6]r/h4]r/h<]r/uh?Nh@hh#]r/h)r/}r/(h(XgFixes for CPU usage problems when using circuits with no I/O pollers and using a Timer for timed eventsr/h*j/h+h.h0hh2}r/(h8]r/h:]r/h6]r/h4]r/h<]r/uh?Kh#]r/h]XgFixes for CPU usage problems when using circuits with no I/O pollers and using a Timer for timed eventsr/r/}r/(h(j/h*j/ubaubaubeubeubeubeh(UU transformerr/NU footnote_refsr/}r0Urefnamesr0}r0Usymbol_footnotesr0]r0Uautofootnote_refsr0]r0Usymbol_footnote_refsr0]r0U citationsr 0]r 0h@hU current_liner 0NUtransform_messagesr 0]r 0cdocutils.nodes system_message r0)r0}r0(h(Uh2}r0(h8]r0Ulevelr0Kh4]r0h6]r0Usourcer0h.h:]r0h<]r0Uliner0KUtyper0UINFOr0uh#]r0h)r0}r0(h(Uh2}r0(h8]r 0h:]r!0h6]r"0h4]r#0h<]r$0uh*j0h#]r%0h]X-Hyperlink target "changes" is not referenced.r&0r'0}r(0(h(Uh*j0ubah0hubah0Usystem_messager)0ubaUreporterr*0NUid_startr+0KU autofootnotesr,0]r-0U citation_refsr.0}r/0Uindirect_targetsr00]r10Usettingsr20(cdocutils.frontend Values r30or40}r50(Ufootnote_backlinksr60KUrecord_dependenciesr70NU rfc_base_urlr80Uhttp://tools.ietf.org/html/r90U tracebackr:0Upep_referencesr;0NUstrip_commentsr<0NU toc_backlinksr=0Uentryr>0U language_coder?0Uenr@0U datestamprA0NU report_levelrB0KU _destinationrC0NU halt_levelrD0KU strip_classesrE0NhUNUerror_encoding_error_handlerrF0UbackslashreplacerG0UdebugrH0NUembed_stylesheetrI0Uoutput_encoding_error_handlerrJ0UstrictrK0U sectnum_xformrL0KUdump_transformsrM0NU docinfo_xformrN0KUwarning_streamrO0NUpep_file_url_templaterP0Upep-%04drQ0Uexit_status_levelrR0KUconfigrS0NUstrict_visitorrT0NUcloak_email_addressesrU0Utrim_footnote_reference_spacerV0UenvrW0NUdump_pseudo_xmlrX0NUexpose_internalsrY0NUsectsubtitle_xformrZ0U source_linkr[0NUrfc_referencesr\0NUoutput_encodingr]0Uutf-8r^0U source_urlr_0NUinput_encodingr`0U utf-8-sigra0U_disable_configrb0NU id_prefixrc0UU tab_widthrd0KUerror_encodingre0U ISO-8859-1rf0U_sourcerg0U4/home/prologic/work/circuits/docs/source/changes.rstrh0Ugettext_compactri0U generatorrj0NUdump_internalsrk0NU smart_quotesrl0U pep_base_urlrm0Uhttp://www.python.org/dev/peps/rn0Usyntax_highlightro0Ulongrp0Uinput_encoding_error_handlerrq0jK0Uauto_id_prefixrr0Uidrs0Udoctitle_xformrt0Ustrip_elements_with_classesru0NU _config_filesrv0]rw0Ufile_insertion_enabledrx0KU raw_enabledry0KU dump_settingsrz0NubUsymbol_footnote_startr{0KUidsr|0}r}0(hj hhahhzhhCh j)hjlh!jhj;hjh"hCuUsubstitution_namesr~0}r0h0h@h2}r0(h8]r0h4]r0h6]r0Usourcer0h.h:]r0h<]r0uU footnotesr0]r0Urefidsr0}r0h"]r0h&asub.circuits-2.1.0/docs/build/doctrees/contributors.doctree0000644000014400001440000001541512113366670023046 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qX contributorsqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhU contributorsqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX9/home/prologic/work/circuits/docs/source/contributors.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q(haUnamesq)]q*hauUlineq+KUdocumentq,hh]q-(cdocutils.nodes title q.)q/}q0(hX Contributorsq1hhhhhUtitleq2h}q3(h!]q4h#]q5h%]q6h']q7h)]q8uh+Kh,hh]q9cdocutils.nodes Text q:X Contributorsq;q<}q=(hh1hh/ubaubcdocutils.nodes paragraph q>)q?}q@(hXycircuits was originally designed, written and primarily maintained by James Mills (http://prologic.shortcircuit.net.au/).qAhhhhhU paragraphqBh}qC(h!]qDh#]qEh%]qFh']qGh)]qHuh+Kh,hh]qI(h:XScircuits was originally designed, written and primarily maintained by James Mills (qJqK}qL(hXScircuits was originally designed, written and primarily maintained by James Mills (qMhh?ubcdocutils.nodes reference qN)qO}qP(hX$http://prologic.shortcircuit.net.au/qQh}qR(UrefuriqSX$http://prologic.shortcircuit.net.au/qTh']qUh%]qVh!]qWh#]qXh)]qYuhh?h]qZh:X$http://prologic.shortcircuit.net.au/q[q\}q](hUhhOubahU referenceq^ubh:X).q_q`}qa(hX).qbhh?ubeubh>)qc}qd(hX@The following users and developers have contributed to circuits:qehhhhhhBh}qf(h!]qgh#]qhh%]qih']qjh)]qkuh+Kh,hh]qlh:X@The following users and developers have contributed to circuits:qmqn}qo(hhehhcubaubcdocutils.nodes bullet_list qp)qq}qr(hUhhhhhU bullet_listqsh}qt(UbulletquX-h']qvh%]qwh!]qxh#]qyh)]qzuh+K h,hh]q{(cdocutils.nodes list_item q|)q}}q~(hXAlessio DeianaqhhqhhhU list_itemqh}q(h!]qh#]qh%]qh']qh)]quh+Nh,hh]qh>)q}q(hhhh}hhhhBh}q(h!]qh#]qh%]qh']qh)]quh+K h]qh:XAlessio Deianaqq}q(hhhhubaubaubh|)q}q(hXDariusz Suchojadqhhqhhhhh}q(h!]qh#]qh%]qh']qh)]quh+Nh,hh]qh>)q}q(hhhhhhhhBh}q(h!]qh#]qh%]qh']qh)]quh+K h]qh:XDariusz Suchojadqq}q(hhhhubaubaubh|)q}q(hX Tim Millerqhhqhhhhh}q(h!]qh#]qh%]qh']qh)]quh+Nh,hh]qh>)q}q(hhhhhhhhBh}q(h!]qh#]qh%]qh']qh)]quh+K h]qh:X Tim Millerqq}q(hhhhubaubaubh|)q}q(hX Holger Krekelqhhqhhhhh}q(h!]qh#]qh%]qh']qh)]quh+Nh,hh]qh>)q}q(hhhhhhhhBh}q(h!]qh#]qh%]qh']qh)]quh+K h]qh:X Holger KrekelqӅq}q(hhhhubaubaubh|)q}q(hX Justin Giorgiqhhqhhhhh}q(h!]qh#]qh%]qh']qh)]quh+Nh,hh]qh>)q}q(hhhhhhhhBh}q(h!]qh#]qh%]qh']qh)]quh+K h]qh:X Justin Giorgiq酁q}q(hhhhubaubaubh|)q}q(hXEdwin Marshallqhhqhhhhh}q(h!]qh#]qh%]qh']qh)]quh+Nh,hh]qh>)q}q(hhhhhhhhBh}q(h!]qh#]qh%]qh']qh)]quh+Kh]qh:XEdwin Marshallqr}r(hhhhubaubaubh|)r}r(hX Alex Mayfieldrhhqhhhhh}r(h!]rh#]rh%]rh']r h)]r uh+Nh,hh]r h>)r }r (hjhjhhhhBh}r(h!]rh#]rh%]rh']rh)]ruh+Kh]rh:X Alex Mayfieldrr}r(hjhj ubaubaubh|)r}r(hX Toni Alatalorhhqhhhhh}r(h!]rh#]rh%]rh']rh)]r uh+Nh,hh]r!h>)r"}r#(hjhjhhhhBh}r$(h!]r%h#]r&h%]r'h']r(h)]r)uh+Kh]r*h:X Toni Alatalor+r,}r-(hjhj"ubaubaubh|)r.}r/(hX Michael Lipp r0hhqhhhhh}r1(h!]r2h#]r3h%]r4h']r5h)]r6uh+Nh,hh]r7h>)r8}r9(hX Michael Lippr:hj.hhhhBh}r;(h!]r<h#]r=h%]r>h']r?h)]r@uh+Kh]rAh:X Michael LipprBrC}rD(hj:hj8ubaubaubeubh>)rE}rF(hXAnyone not listed here (*apologies as this list is taken directly from Mercurial's churn command and output*). We appreciate any and all contributions to circuits.rGhhhhhhBh}rH(h!]rIh#]rJh%]rKh']rLh)]rMuh+Kh,hh]rN(h:XAnyone not listed here (rOrP}rQ(hXAnyone not listed here (rRhjEubcdocutils.nodes emphasis rS)rT}rU(hXT*apologies as this list is taken directly from Mercurial's churn command and output*rVh}rW(h!]rXh#]rYh%]rZh']r[h)]r\uhjEh]r]h:XRapologies as this list is taken directly from Mercurial's churn command and outputr^r_}r`(hUhjTubahUemphasisraubh:X7). We appreciate any and all contributions to circuits.rbrc}rd(hX7). We appreciate any and all contributions to circuits.rehjEubeubeubahUU transformerrfNU footnote_refsrg}rhUrefnamesri}rjUsymbol_footnotesrk]rlUautofootnote_refsrm]rnUsymbol_footnote_refsro]rpU citationsrq]rrh,hU current_linersNUtransform_messagesrt]ruUreporterrvNUid_startrwKU autofootnotesrx]ryU citation_refsrz}r{Uindirect_targetsr|]r}Usettingsr~(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh2NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerU9/home/prologic/work/circuits/docs/source/contributors.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}rhhsUsubstitution_namesr}rhh,h}r(h!]rh']rh%]rUsourcerhh#]rh)]ruU footnotesr]rUrefidsr}rub.circuits-2.1.0/docs/build/doctrees/tutorial/0000755000014400001440000000000012113366740020575 5ustar prologicuserscircuits-2.1.0/docs/build/doctrees/tutorial/index.doctree0000644000014400001440000017457312113366671023277 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X event objectsqNX the componentqNXregistering componentsqNXoverviewq NXcomplex componentsq NXcomponent channelsq NXpython programming languageq X the debuggerq NXcomponent inheritanceqNXevent handlersqNXtutorialqNuUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU event-objectsqhU the-componentqhUregistering-componentsqh Uoverviewqh Ucomplex-componentsqh Ucomponent-channelsqh Upython-programming-languageq h U the-debuggerq!hUcomponent-inheritanceq"hUevent-handlersq#hUtutorialq$uUchildrenq%]q&(cdocutils.nodes target q')q(}q)(U rawsourceq*X7.. _Python Programming Language: http://www.python.org/q+U referencedq,KUparentq-hUsourceq.cdocutils.nodes reprunicode q/X;/home/prologic/work/circuits/docs/source/tutorial/index.rstq0q1}q2bUtagnameq3Utargetq4U attributesq5}q6(Urefuriq7Xhttp://www.python.org/q8Uidsq9]q:h aUbackrefsq;]qUclassesq?]q@UnamesqA]qBh auUlineqCKUdocumentqDhh%]qEubcdocutils.nodes section qF)qG}qH(h*Uh-hh.h1h3UsectionqIh5}qJ(h=]qKh?]qLh;]qMh9]qNh$ahA]qOhauhCKhDhh%]qP(cdocutils.nodes title qQ)qR}qS(h*XTutorialqTh-hGh.h1h3UtitleqUh5}qV(h=]qWh?]qXh;]qYh9]qZhA]q[uhCKhDhh%]q\cdocutils.nodes Text q]XTutorialq^q_}q`(h*hTh-hRubaubhF)qa}qb(h*Uh-hGh.h1h3hIh5}qc(h=]qdh?]qeh;]qfh9]qghahA]qhh auhCK hDhh%]qi(hQ)qj}qk(h*XOverviewqlh-hah.h1h3hUh5}qm(h=]qnh?]qoh;]qph9]qqhA]qruhCK hDhh%]qsh]XOverviewqtqu}qv(h*hlh-hjubaubcdocutils.nodes paragraph qw)qx}qy(h*XRWelcome to the circuits tutorial. This 5-minute tutorial will guide you through the basic concepts of circuits. The goal is to introduce new concepts incrementally with walk-through examples that you can try out! By the time you've finished, you should have a good basic understanding of circuits, how it feels and where to go from there.qzh-hah.h1h3U paragraphq{h5}q|(h=]q}h?]q~h;]qh9]qhA]quhCK hDhh%]qh]XRWelcome to the circuits tutorial. This 5-minute tutorial will guide you through the basic concepts of circuits. The goal is to introduce new concepts incrementally with walk-through examples that you can try out! By the time you've finished, you should have a good basic understanding of circuits, how it feels and where to go from there.qq}q(h*hzh-hxubaubeubhF)q}q(h*Uh-hGh.h1h3hIh5}q(h=]qh?]qh;]qh9]qhahA]qhauhCKhDhh%]q(hQ)q}q(h*X The Componentqh-hh.h1h3hUh5}q(h=]qh?]qh;]qh9]qhA]quhCKhDhh%]qh]X The Componentqq}q(h*hh-hubaubhw)q}q(h*X_First up, let's show how you can use the ``Component`` and run it in a very simple application.qh-hh.h1h3h{h5}q(h=]qh?]qh;]qh9]qhA]quhCKhDhh%]q(h]X)First up, let's show how you can use the qq}q(h*X)First up, let's show how you can use the qh-hubcdocutils.nodes literal q)q}q(h*X ``Component``qh5}q(h=]qh?]qh;]qh9]qhA]quh-hh%]qh]X Componentqq}q(h*Uh-hubah3Uliteralqubh]X) and run it in a very simple application.qq}q(h*X) and run it in a very simple application.qh-hubeubcdocutils.nodes literal_block q)q}q(h*XI#!/usr/bin/env python from circuits import Component Component().run() qh-hh.h1h3U literal_blockqh5}q(UlinenosqÈUlanguageqh/XpythonqŅq}qbh=]qU xml:spaceqUpreserveqh9]qh;]qUsourceqX8/home/prologic/work/circuits/docs/source/tutorial/001.pyqh?]qhA]quhCKhDhh%]qh]XI#!/usr/bin/env python from circuits import Component Component().run() q҅q}q(h*Uh-hubaubhw)q}q(h*X$:download:`Download 001.py <001.py>`qh-hh.h1h3h{h5}q(h=]qh?]qh;]qh9]qhA]quhCKhDhh%]qcsphinx.addnodes download_reference q)q}q(h*hh-hh.h1h3Udownload_referenceqh5}q(UreftypeqXdownloadqUrefwarnqU reftargetqX001.pyqU refdomainqUh9]qh;]qU refexplicitqh=]qh?]qhA]qUrefdocqUtutorial/indexqUfilenameqX001.pyquhCKh%]qh)q}q(h*hh5}q(h=]qh?]q(Uxrefqheh;]qh9]qhA]quh-hh%]qh]XDownload 001.pyqr}r(h*Uh-hubah3hubaubaubhw)r}r(h*XTOkay so that's pretty boring as it doesn't do very much! But that's okay... Read on!rh-hh.h1h3h{h5}r(h=]rh?]rh;]rh9]r hA]r uhCKhDhh%]r h]XTOkay so that's pretty boring as it doesn't do very much! But that's okay... Read on!r r }r(h*jh-jubaubhw)r}r(h*XDLet's try to create our own custom Component called ``MyComponent``.rh-hh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCK!hDhh%]r(h]X4Let's try to create our own custom Component called rr}r(h*X4Let's try to create our own custom Component called rh-jubh)r}r(h*X``MyComponent``rh5}r (h=]r!h?]r"h;]r#h9]r$hA]r%uh-jh%]r&h]X MyComponentr'r(}r)(h*Uh-jubah3hubh]X.r*}r+(h*X.h-jubeubh)r,}r-(h*X#!/usr/bin/env python from circuits import Component class MyComponent(Component): """My Component""" MyComponent().run() r.h-hh.h1h3hh5}r/(hÈhh/Xpythonr0r1}r2bh=]r3hhh9]r4h;]r5Usourcer6X8/home/prologic/work/circuits/docs/source/tutorial/002.pyr7h?]r8hA]r9uhCK#hDhh%]r:h]X#!/usr/bin/env python from circuits import Component class MyComponent(Component): """My Component""" MyComponent().run() r;r<}r=(h*Uh-j,ubaubhw)r>}r?(h*X$:download:`Download 002.py <002.py>`r@h-hh.h1h3h{h5}rA(h=]rBh?]rCh;]rDh9]rEhA]rFuhCK'hDhh%]rGh)rH}rI(h*j@h-j>h.h1h3hh5}rJ(UreftyperKXdownloadrLhhX002.pyrMU refdomainrNUh9]rOh;]rPU refexplicitrQh=]rRh?]rShA]rThhhX002.pyrUuhCK'h%]rVh)rW}rX(h*j@h5}rY(h=]rZh?]r[(hjLeh;]r\h9]r]hA]r^uh-jHh%]r_h]XDownload 002.pyr`ra}rb(h*Uh-jWubah3hubaubaubhw)rc}rd(h*XgOkay, so this still isn't very useful! But at least we can create components with the behavior we want.reh-hh.h1h3h{h5}rf(h=]rgh?]rhh;]rih9]rjhA]rkuhCK)hDhh%]rlh]XgOkay, so this still isn't very useful! But at least we can create components with the behavior we want.rmrn}ro(h*jeh-jcubaubhw)rp}rq(h*X.Let's move on to something more interesting...rrh-hh.h1h3h{h5}rs(h=]rth?]ruh;]rvh9]rwhA]rxuhCK,hDhh%]ryh]X.Let's move on to something more interesting...rzr{}r|(h*jrh-jpubaubeubhF)r}}r~(h*Uh-hGh.h1h3hIh5}r(h=]rh?]rh;]rh9]rh#ahA]rhauhCK0hDhh%]r(hQ)r}r(h*XEvent Handlersrh-j}h.h1h3hUh5}r(h=]rh?]rh;]rh9]rhA]ruhCK0hDhh%]rh]XEvent Handlersrr}r(h*jh-jubaubhw)r}r(h*XKLet's now extend our little example to say "Hello World!" when its started.rh-j}h.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCK2hDhh%]rh]XKLet's now extend our little example to say "Hello World!" when its started.rr}r(h*jh-jubaubh)r}r(h*X#!/usr/bin/env python from circuits import Component class MyComponent(Component): def started(self, *args): print("Hello World!") MyComponent().run() rh-j}h.h1h3hh5}r(hÈhh/Xpythonrr}rbh=]rhhh9]rh;]rUsourcerX8/home/prologic/work/circuits/docs/source/tutorial/003.pyrh?]rhA]ruhCK4hDhh%]rh]X#!/usr/bin/env python from circuits import Component class MyComponent(Component): def started(self, *args): print("Hello World!") MyComponent().run() rr}r(h*Uh-jubaubhw)r}r(h*X$:download:`Download 003.py <003.py>`rh-j}h.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCK8hDhh%]rh)r}r(h*jh-jh.h1h3hh5}r(UreftyperXdownloadrhhX003.pyrU refdomainrUh9]rh;]rU refexplicitrh=]rh?]rhA]rhhhX003.pyruhCK8h%]rh)r}r(h*jh5}r(h=]rh?]r(hjeh;]rh9]rhA]ruh-jh%]rh]XDownload 003.pyrr}r(h*Uh-jubah3hubaubaubhw)r}r(h*XHere we've created a simple **Event Handler** that listens for events on the "started" channel. Methods defined in a Component are converted into Event Handlers.rh-j}h.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCK:hDhh%]r(h]XHere we've created a simple rr}r(h*XHere we've created a simple rh-jubcdocutils.nodes strong r)r}r(h*X**Event Handler**rh5}r(h=]rh?]rh;]rh9]rhA]ruh-jh%]rh]X Event Handlerrr}r(h*Uh-jubah3Ustrongrubh]Xt that listens for events on the "started" channel. Methods defined in a Component are converted into Event Handlers.rr}r(h*Xt that listens for events on the "started" channel. Methods defined in a Component are converted into Event Handlers.rh-jubeubhw)r}r(h*XRunning this we get::rh-j}h.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCK>hDhh%]rh]XRunning this we get:rr}r(h*XRunning this we get:rh-jubaubh)r}r(h*X Hello World!rh-j}h.h1h3hh5}r (hhh9]r h;]r h=]r h?]r hA]ruhCK@hDhh%]rh]X Hello World!rr}r(h*Uh-jubaubhw)r}r(h*XGAlright! We have something slightly more useful! Whoohoo it says hello!rh-j}h.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKChDhh%]rh]XGAlright! We have something slightly more useful! Whoohoo it says hello!rr}r(h*jh-jubaubcdocutils.nodes note r )r!}r"(h*XPress ^C (*CTRL + C*) to exit.r#h-j}h.h1h3Unoter$h5}r%(h=]r&h?]r'h;]r(h9]r)hA]r*uhCNhDhh%]r+hw)r,}r-(h*j#h-j!h.h1h3h{h5}r.(h=]r/h?]r0h;]r1h9]r2hA]r3uhCKEh%]r4(h]X Press ^C (r5r6}r7(h*X Press ^C (r8h-j,ubcdocutils.nodes emphasis r9)r:}r;(h*X *CTRL + C*r<h5}r=(h=]r>h?]r?h;]r@h9]rAhA]rBuh-j,h%]rCh]XCTRL + CrDrE}rF(h*Uh-j:ubah3UemphasisrGubh]X ) to exit.rHrI}rJ(h*X ) to exit.rKh-j,ubeubaubeubhF)rL}rM(h*Uh-hGh.h1h3hIh5}rN(h=]rOh?]rPh;]rQh9]rRhahA]rShauhCKIhDhh%]rT(hQ)rU}rV(h*XRegistering ComponentsrWh-jLh.h1h3hUh5}rX(h=]rYh?]rZh;]r[h9]r\hA]r]uhCKIhDhh%]r^h]XRegistering Componentsr_r`}ra(h*jWh-jUubaubhw)rb}rc(h*XSo now that we've learned how to use a Component, create a custom Component and create simple Event Handlers, let's try something a bit more complex by creating a complex component made up of two simpler ones.rdh-jLh.h1h3h{h5}re(h=]rfh?]rgh;]rhh9]rihA]rjuhCKKhDhh%]rkh]XSo now that we've learned how to use a Component, create a custom Component and create simple Event Handlers, let's try something a bit more complex by creating a complex component made up of two simpler ones.rlrm}rn(h*jdh-jbubaubhw)ro}rp(h*XLet's create two components:rqh-jLh.h1h3h{h5}rr(h=]rsh?]rth;]ruh9]rvhA]rwuhCKOhDhh%]rxh]XLet's create two components:ryrz}r{(h*jqh-joubaubcdocutils.nodes bullet_list r|)r}}r~(h*Uh-jLh.h1h3U bullet_listrh5}r(UbulletrX-h9]rh;]rh=]rh?]rhA]ruhCKQhDhh%]r(cdocutils.nodes list_item r)r}r(h*X``Bob``rh-j}h.h1h3U list_itemrh5}r(h=]rh?]rh;]rh9]rhA]ruhCNhDhh%]rhw)r}r(h*jh-jh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKQh%]rh)r}r(h*jh5}r(h=]rh?]rh;]rh9]rhA]ruh-jh%]rh]XBobrr}r(h*Uh-jubah3hubaubaubj)r}r(h*X ``Fred`` rh-j}h.h1h3jh5}r(h=]rh?]rh;]rh9]rhA]ruhCNhDhh%]rhw)r}r(h*X``Fred``rh-jh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKRh%]rh)r}r(h*jh5}r(h=]rh?]rh;]rh9]rhA]ruh-jh%]rh]XFredrr}r(h*Uh-jubah3hubaubaubeubh)r}r(h*X#!/usr/bin/env python from circuits import Component class Bob(Component): def started(self, *args): print("Hello I'm Bob!") class Fred(Component): def started(self, *args): print("Hello I'm Fred!") (Bob() + Fred()).run() rh-jLh.h1h3hh5}r(hÈhh/Xpythonrr}rbh=]rhhh9]rh;]rUsourcerX8/home/prologic/work/circuits/docs/source/tutorial/004.pyrh?]rhA]ruhCKThDhh%]rh]X#!/usr/bin/env python from circuits import Component class Bob(Component): def started(self, *args): print("Hello I'm Bob!") class Fred(Component): def started(self, *args): print("Hello I'm Fred!") (Bob() + Fred()).run() rr}r(h*Uh-jubaubhw)r}r(h*X$:download:`Download 004.py <004.py>`rh-jLh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKXhDhh%]rh)r}r(h*jh-jh.h1h3hh5}r(UreftyperXdownloadrhhX004.pyrU refdomainrUh9]rh;]rU refexplicitrh=]rh?]rhA]rhhhX004.pyruhCKXh%]rh)r}r(h*jh5}r(h=]rh?]r(hjeh;]rh9]rhA]ruh-jh%]rh]XDownload 004.pyrr}r(h*Uh-jubah3hubaubaubhw)r}r(h*XNotice the way we register the two components ``Bob`` and ``Fred`` together ? Don't worry if this doesn't make sense right now. Think of it as putting two components together and plugging them into a circuits board.rh-jLh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKZhDhh%]r (h]X.Notice the way we register the two components r r }r (h*X.Notice the way we register the two components r h-jubh)r}r(h*X``Bob``rh5}r(h=]rh?]rh;]rh9]rhA]ruh-jh%]rh]XBobrr}r(h*Uh-jubah3hubh]X and rr}r(h*X and rh-jubh)r}r (h*X``Fred``r!h5}r"(h=]r#h?]r$h;]r%h9]r&hA]r'uh-jh%]r(h]XFredr)r*}r+(h*Uh-jubah3hubh]X together ? Don't worry if this doesn't make sense right now. Think of it as putting two components together and plugging them into a circuits board.r,r-}r.(h*X together ? Don't worry if this doesn't make sense right now. Think of it as putting two components together and plugging them into a circuits board.r/h-jubeubhw)r0}r1(h*X4Running this example produces the following result::r2h-jLh.h1h3h{h5}r3(h=]r4h?]r5h;]r6h9]r7hA]r8uhCK^hDhh%]r9h]X3Running this example produces the following result:r:r;}r<(h*X3Running this example produces the following result:r=h-j0ubaubh)r>}r?(h*XHello I'm Bob! Hello I'm Fred!r@h-jLh.h1h3hh5}rA(hhh9]rBh;]rCh=]rDh?]rEhA]rFuhCK`hDhh%]rGh]XHello I'm Bob! Hello I'm Fred!rHrI}rJ(h*Uh-j>ubaubhw)rK}rL(h*X]Cool! We have two components that each do something and print a simple message on the screen!rMh-jLh.h1h3h{h5}rN(h=]rOh?]rPh;]rQh9]rRhA]rSuhCKchDhh%]rTh]X]Cool! We have two components that each do something and print a simple message on the screen!rUrV}rW(h*jMh-jKubaubeubhF)rX}rY(h*Uh-hGh.h1h3hIh5}rZ(h=]r[h?]r\h;]r]h9]r^hahA]r_h auhCKhhDhh%]r`(hQ)ra}rb(h*XComplex Componentsrch-jXh.h1h3hUh5}rd(h=]reh?]rfh;]rgh9]rhhA]riuhCKhhDhh%]rjh]XComplex Componentsrkrl}rm(h*jch-jaubaubhw)rn}ro(h*XNow, what if we wanted to create a Complex Component? Let's say we wanted to create a new Component made up of two other smaller components?rph-jXh.h1h3h{h5}rq(h=]rrh?]rsh;]rth9]ruhA]rvuhCKjhDhh%]rwh]XNow, what if we wanted to create a Complex Component? Let's say we wanted to create a new Component made up of two other smaller components?rxry}rz(h*jph-jnubaubhw)r{}r|(h*X]We can do this by simply registering components to a Complex Component during initialization.r}h-jXh.h1h3h{h5}r~(h=]rh?]rh;]rh9]rhA]ruhCKmhDhh%]rh]X]We can do this by simply registering components to a Complex Component during initialization.rr}r(h*j}h-j{ubaubh)r}r(h*X#!/usr/bin/env python from circuits import Component from circuits.tools import graph class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) def started(self, *args): print(graph(self.root)) class Bob(Component): def started(self, *args): print("Hello I'm Bob!") class Fred(Component): def started(self, *args): print("Hello I'm Fred!") Pound().run() rh-jXh.h1h3hh5}r(hÈhh/Xpythonrr}rbh=]rhhh9]rh;]rUsourcerX8/home/prologic/work/circuits/docs/source/tutorial/005.pyrh?]rhA]ruhCKphDhh%]rh]X#!/usr/bin/env python from circuits import Component from circuits.tools import graph class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) def started(self, *args): print(graph(self.root)) class Bob(Component): def started(self, *args): print("Hello I'm Bob!") class Fred(Component): def started(self, *args): print("Hello I'm Fred!") Pound().run() rr}r(h*Uh-jubaubhw)r}r(h*X$:download:`Download 005.py <005.py>`rh-jXh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKthDhh%]rh)r}r(h*jh-jh.h1h3hh5}r(UreftyperXdownloadrhhX005.pyrU refdomainrUh9]rh;]rU refexplicitrh=]rh?]rhA]rhhhX005.pyruhCKth%]rh)r}r(h*jh5}r(h=]rh?]r(hjeh;]rh9]rhA]ruh-jh%]rh]XDownload 005.pyrr}r(h*Uh-jubah3hubaubaubhw)r}r(h*XlSo now ``Pound`` is a Component that consists of two other components registered to it: ``Bob`` and ``Fred``rh-jXh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKvhDhh%]r(h]XSo now rr}r(h*XSo now rh-jubh)r}r(h*X ``Pound``rh5}r(h=]rh?]rh;]rh9]rhA]ruh-jh%]rh]XPoundrr}r(h*Uh-jubah3hubh]XH is a Component that consists of two other components registered to it: rr}r(h*XH is a Component that consists of two other components registered to it: rh-jubh)r}r(h*X``Bob``rh5}r(h=]rh?]rh;]rh9]rhA]ruh-jh%]rh]XBobrr}r(h*Uh-jubah3hubh]X and rr}r(h*X and rh-jubh)r}r(h*X``Fred``rh5}r(h=]rh?]rh;]rh9]rhA]ruh-jh%]rh]XFredrr}r(h*Uh-jubah3hubeubhw)r}r(h*X1The output of this is identical to the previous::rh-jXh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKyhDhh%]rh]X0The output of this is identical to the previous:rr}r(h*X0The output of this is identical to the previous:r h-jubaubh)r }r (h*X* * * Hello I'm Bob! Hello I'm Fred!r h-jXh.h1h3hh5}r (hhh9]rh;]rh=]rh?]rhA]ruhCK{hDhh%]rh]X* * * Hello I'm Bob! Hello I'm Fred!rr}r(h*Uh-j ubaubhw)r}r(h*XThe only difference is that ``Bob`` and ``Fred`` are now part of a more Complex Component called ``Pound``. This can be illustrated by the following diagram:rh-jXh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]r (h]XThe only difference is that r!r"}r#(h*XThe only difference is that r$h-jubh)r%}r&(h*X``Bob``r'h5}r((h=]r)h?]r*h;]r+h9]r,hA]r-uh-jh%]r.h]XBobr/r0}r1(h*Uh-j%ubah3hubh]X and r2r3}r4(h*X and r5h-jubh)r6}r7(h*X``Fred``r8h5}r9(h=]r:h?]r;h;]r<h9]r=hA]r>uh-jh%]r?h]XFredr@rA}rB(h*Uh-j6ubah3hubh]X1 are now part of a more Complex Component called rCrD}rE(h*X1 are now part of a more Complex Component called rFh-jubh)rG}rH(h*X ``Pound``rIh5}rJ(h=]rKh?]rLh;]rMh9]rNhA]rOuh-jh%]rPh]XPoundrQrR}rS(h*Uh-jGubah3hubh]X3. This can be illustrated by the following diagram:rTrU}rV(h*X3. This can be illustrated by the following diagram:rWh-jubeubcsphinx.ext.graphviz graphviz rX)rY}rZ(h*Uh-jXh.h1h3Ugraphvizr[h5}r\(Ucoder]XLdigraph G { "Pound-1344" -> "Bob-9b0c"; "Pound-1344" -> "Fred-e98a"; }r^h9]r_h;]r`h=]rah?]rbhA]rcUinlinerdUoptionsre]rfuhCKhDhh%]rgubj )rh}ri(h*XtThe extra lines in the above output are an ASCII representation of the above graph (*produced by pydot + graphviz*).rjh-jXh.h1h3j$h5}rk(h=]rlh?]rmh;]rnh9]rohA]rpuhCNhDhh%]rqhw)rr}rs(h*XtThe extra lines in the above output are an ASCII representation of the above graph (*produced by pydot + graphviz*).rth-jhh.h1h3h{h5}ru(h=]rvh?]rwh;]rxh9]ryhA]rzuhCKh%]r{(h]XTThe extra lines in the above output are an ASCII representation of the above graph (r|r}}r~(h*XTThe extra lines in the above output are an ASCII representation of the above graph (rh-jrubj9)r}r(h*X*produced by pydot + graphviz*rh5}r(h=]rh?]rh;]rh9]rhA]ruh-jrh%]rh]Xproduced by pydot + graphvizrr}r(h*Uh-jubah3jGubh]X).rr}r(h*X).rh-jrubeubaubhw)r}r(h*XCool :-)rh-jXh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]rh]XCool :-)rr}r(h*jh-jubaubeubhF)r}r(h*Uh-hGh.h1h3hIh5}r(h=]rh?]rh;]rh9]rh"ahA]rhauhCKhDhh%]r(hQ)r}r(h*XComponent Inheritancerh-jh.h1h3hUh5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]rh]XComponent Inheritancerr}r(h*jh-jubaubhw)r}r(h*XSince circuits is a framework written for the `Python Programming Language`_ it naturally inherits properties of Object Orientated Programming (OOP) -- such as inheriaence.rh-jh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]r(h]X.Since circuits is a framework written for the rr}r(h*X.Since circuits is a framework written for the rh-jubcdocutils.nodes reference r)r}r(h*X`Python Programming Language`_rUresolvedrKh-jh3U referencerh5}r(UnamerXPython Programming Languagerh7h8h9]rh;]rh=]rh?]rhA]ruh%]rh]XPython Programming Languagerr}r(h*Uh-jubaubh]X` it naturally inherits properties of Object Orientated Programming (OOP) -- such as inheriaence.rr}r(h*X` it naturally inherits properties of Object Orientated Programming (OOP) -- such as inheriaence.rh-jubeubhw)r}r(h*XSo let's take our ``Bob`` and ``Fred`` components and create a Base Component called ``Dog`` and modify our two dogs (``Bob`` and ``Fred``) to subclass this.rh-jh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]r(h]XSo let's take our rr}r(h*XSo let's take our rh-jubh)r}r(h*X``Bob``rh5}r(h=]rh?]rh;]rh9]rhA]ruh-jh%]rh]XBobrr}r(h*Uh-jubah3hubh]X and rr}r(h*X and rh-jubh)r}r(h*X``Fred``rh5}r(h=]rh?]rh;]rh9]rhA]ruh-jh%]rh]XFredrr}r(h*Uh-jubah3hubh]X/ components and create a Base Component called rr}r(h*X/ components and create a Base Component called rh-jubh)r}r (h*X``Dog``r h5}r (h=]r h?]r h;]rh9]rhA]ruh-jh%]rh]XDogrr}r(h*Uh-jubah3hubh]X and modify our two dogs (rr}r(h*X and modify our two dogs (rh-jubh)r}r(h*X``Bob``rh5}r(h=]rh?]rh;]rh9]r hA]r!uh-jh%]r"h]XBobr#r$}r%(h*Uh-jubah3hubh]X and r&r'}r((h*X and r)h-jubh)r*}r+(h*X``Fred``r,h5}r-(h=]r.h?]r/h;]r0h9]r1hA]r2uh-jh%]r3h]XFredr4r5}r6(h*Uh-j*ubah3hubh]X) to subclass this.r7r8}r9(h*X) to subclass this.r:h-jubeubh)r;}r<(h*X#!/usr/bin/env python from circuits import Component, Event class Woof(Event): """Woof Event""" class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) def started(self, *args): self.fire(Woof()) class Dog(Component): def woof(self): print("Woof! I'm %s!" % self.name) class Bob(Dog): """Bob""" class Fred(Dog): """Fred""" Pound().run() r=h-jh.h1h3hh5}r>(hÈhh/Xpythonr?r@}rAbh=]rBhhh9]rCh;]rDUsourcerEX8/home/prologic/work/circuits/docs/source/tutorial/006.pyrFh?]rGhA]rHuhCKhDhh%]rIh]X#!/usr/bin/env python from circuits import Component, Event class Woof(Event): """Woof Event""" class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) def started(self, *args): self.fire(Woof()) class Dog(Component): def woof(self): print("Woof! I'm %s!" % self.name) class Bob(Dog): """Bob""" class Fred(Dog): """Fred""" Pound().run() rJrK}rL(h*Uh-j;ubaubhw)rM}rN(h*X$:download:`Download 006.py <006.py>`rOh-jh.h1h3h{h5}rP(h=]rQh?]rRh;]rSh9]rThA]rUuhCKhDhh%]rVh)rW}rX(h*jOh-jMh.h1h3hh5}rY(UreftyperZXdownloadr[hhX006.pyr\U refdomainr]Uh9]r^h;]r_U refexplicitr`h=]rah?]rbhA]rchhhX006.pyrduhCKh%]reh)rf}rg(h*jOh5}rh(h=]rih?]rj(hj[eh;]rkh9]rlhA]rmuh-jWh%]rnh]XDownload 006.pyrorp}rq(h*Uh-jfubah3hubaubaubhw)rr}rs(h*X0Now let's try to run this and see what happens::rth-jh.h1h3h{h5}ru(h=]rvh?]rwh;]rxh9]ryhA]rzuhCKhDhh%]r{h]X/Now let's try to run this and see what happens:r|r}}r~(h*X/Now let's try to run this and see what happens:rh-jrubaubh)r}r(h*XWoof! I'm Bob! Woof! I'm Fred!rh-jh.h1h3hh5}r(hhh9]rh;]rh=]rh?]rhA]ruhCKhDhh%]rh]XWoof! I'm Bob! Woof! I'm Fred!rr}r(h*Uh-jubaubhw)r}r(h*XSo both dogs barked! Hmmmrh-jh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]rh]XSo both dogs barked! Hmmmrr}r(h*jh-jubaubeubhF)r}r(h*Uh-hGh.h1h3hIh5}r(h=]rh?]rh;]rh9]rhahA]rh auhCKhDhh%]r(hQ)r}r(h*XComponent Channelsrh-jh.h1h3hUh5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]rh]XComponent Channelsrr}r(h*jh-jubaubhw)r}r(h*XnWhat if we only want one of our dogs to bark? How do we do this without causing the other one to bark as well?rh-jh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]rh]XnWhat if we only want one of our dogs to bark? How do we do this without causing the other one to bark as well?rr}r(h*jh-jubaubhw)r}r(h*X)Easy! Use a separate ``channel`` like so:rh-jh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]r(h]XEasy! Use a separate rr}r(h*XEasy! Use a separate rh-jubh)r}r(h*X ``channel``rh5}r(h=]rh?]rh;]rh9]rhA]ruh-jh%]rh]Xchannelrr}r(h*Uh-jubah3hubh]X like so:rr}r(h*X like so:rh-jubeubh)r}r(h*X*#!/usr/bin/env python from circuits import Component, Event class Woof(Event): """Woof Event""" class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) def started(self, *args): self.fire(Woof(), self.bob) class Dog(Component): def woof(self): print("Woof! I'm %s!" % self.name) class Bob(Dog): """Bob""" channel = "bob" class Fred(Dog): """Fred""" channel = "fred" Pound().run() rh-jh.h1h3hh5}r(hÈhh/Xpythonrr}rbh=]rhhh9]rh;]rUsourcerX8/home/prologic/work/circuits/docs/source/tutorial/007.pyrh?]rhA]ruhCKhDhh%]rh]X*#!/usr/bin/env python from circuits import Component, Event class Woof(Event): """Woof Event""" class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) def started(self, *args): self.fire(Woof(), self.bob) class Dog(Component): def woof(self): print("Woof! I'm %s!" % self.name) class Bob(Dog): """Bob""" channel = "bob" class Fred(Dog): """Fred""" channel = "fred" Pound().run() rr}r(h*Uh-jubaubhw)r}r(h*X$:download:`Download 007.py <007.py>`rh-jh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]rh)r}r(h*jh-jh.h1h3hh5}r(UreftyperXdownloadrhhX007.pyrU refdomainrUh9]rh;]rU refexplicitrh=]rh?]rhA]rhhhX007.pyruhCKh%]rh)r}r(h*jh5}r (h=]r h?]r (hjeh;]r h9]r hA]ruh-jh%]rh]XDownload 007.pyrr}r(h*Uh-jubah3hubaubaubj )r}r(h*XQEvents can be fired with either the ``.fire(...)`` or ``.fireEvent(...)`` method.rh-jh.h1h3j$h5}r(h=]rh?]rh;]rh9]rhA]ruhCNhDhh%]rhw)r}r(h*XQEvents can be fired with either the ``.fire(...)`` or ``.fireEvent(...)`` method.rh-jh.h1h3h{h5}r (h=]r!h?]r"h;]r#h9]r$hA]r%uhCKh%]r&(h]X$Events can be fired with either the r'r(}r)(h*X$Events can be fired with either the r*h-jubh)r+}r,(h*X``.fire(...)``r-h5}r.(h=]r/h?]r0h;]r1h9]r2hA]r3uh-jh%]r4h]X .fire(...)r5r6}r7(h*Uh-j+ubah3hubh]X or r8r9}r:(h*X or r;h-jubh)r<}r=(h*X``.fireEvent(...)``r>h5}r?(h=]r@h?]rAh;]rBh9]rChA]rDuh-jh%]rEh]X.fireEvent(...)rFrG}rH(h*Uh-j<ubah3hubh]X method.rIrJ}rK(h*X method.rLh-jubeubaubhw)rM}rN(h*XIf you run this, you'll get::rOh-jh.h1h3h{h5}rP(h=]rQh?]rRh;]rSh9]rThA]rUuhCKhDhh%]rVh]XIf you run this, you'll get:rWrX}rY(h*XIf you run this, you'll get:rZh-jMubaubh)r[}r\(h*XWoof! I'm Bob!r]h-jh.h1h3hh5}r^(hhh9]r_h;]r`h=]rah?]rbhA]rcuhCKhDhh%]rdh]XWoof! I'm Bob!rerf}rg(h*Uh-j[ubaubeubhF)rh}ri(h*Uh-hGh.h1h3hIh5}rj(h=]rkh?]rlh;]rmh9]rnhahA]rohauhCKhDhh%]rp(hQ)rq}rr(h*X Event Objectsrsh-jhh.h1h3hUh5}rt(h=]ruh?]rvh;]rwh9]rxhA]ryuhCKhDhh%]rzh]X Event Objectsr{r|}r}(h*jsh-jqubaubhw)r~}r(h*XgSo far in our tutorial we have been defining an Event Handler for a builtin Event called ``Started`` (*which incidentally gets fired on a channel called "started"*). What if we wanted to define our own Event Handlers and our own Events? You've already seen how easy it is to create a new Event Handler by simply defining a normal Python method on a Component.rh-jhh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]r(h]XYSo far in our tutorial we have been defining an Event Handler for a builtin Event called rr}r(h*XYSo far in our tutorial we have been defining an Event Handler for a builtin Event called rh-j~ubh)r}r(h*X ``Started``rh5}r(h=]rh?]rh;]rh9]rhA]ruh-j~h%]rh]XStartedrr}r(h*Uh-jubah3hubh]X (rr}r(h*X (rh-j~ubj9)r}r(h*X=*which incidentally gets fired on a channel called "started"*rh5}r(h=]rh?]rh;]rh9]rhA]ruh-j~h%]rh]X;which incidentally gets fired on a channel called "started"rr}r(h*Uh-jubah3jGubh]X). What if we wanted to define our own Event Handlers and our own Events? You've already seen how easy it is to create a new Event Handler by simply defining a normal Python method on a Component.rr}r(h*X). What if we wanted to define our own Event Handlers and our own Events? You've already seen how easy it is to create a new Event Handler by simply defining a normal Python method on a Component.rh-j~ubeubhw)r}r(h*X_Defining your own Events helps with documentation and testing and makes things a little easier.rh-jhh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]rh]X_Defining your own Events helps with documentation and testing and makes things a little easier.rr}r(h*jh-jubaubhw)r}r(h*X Example::rh-jhh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]rh]XExample:rr}r(h*XExample:rh-jubaubh)r}r(h*X&class MyEvent(Event): """MyEvent"""rh-jhh.h1h3hh5}r(hhh9]rh;]rh=]rh?]rhA]ruhCKhDhh%]rh]X&class MyEvent(Event): """MyEvent"""rr}r(h*Uh-jubaubhw)r}r(h*XSo here's our example where we'll define a new Event called ``Bark`` and make our ``Dog`` fire a ``Bark`` event when our application starts up.rh-jhh.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]r(h]X<So here's our example where we'll define a new Event called rr}r(h*X<So here's our example where we'll define a new Event called rh-jubh)r}r(h*X``Bark``rh5}r(h=]rh?]rh;]rh9]rhA]ruh-jh%]rh]XBarkrr}r(h*Uh-jubah3hubh]X and make our rr}r(h*X and make our rh-jubh)r}r(h*X``Dog``rh5}r(h=]rh?]rh;]rh9]rhA]ruh-jh%]rh]XDogrr}r(h*Uh-jubah3hubh]X fire a rr}r(h*X fire a rh-jubh)r}r(h*X``Bark``rh5}r (h=]r h?]r h;]r h9]r hA]ruh-jh%]rh]XBarkrr}r(h*Uh-jubah3hubh]X& event when our application starts up.rr}r(h*X& event when our application starts up.rh-jubeubh)r}r(h*X#!/usr/bin/env python from circuits import Component, Event class Bark(Event): """Bark Event""" class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) class Dog(Component): def started(self, *args): self.fire(Bark()) def bark(self): print("Woof! I'm %s!" % self.name) class Bob(Dog): """Bob""" channel = "bob" class Fred(Dog): """Fred""" channel = "fred" Pound().run() rh-jhh.h1h3hh5}r(hÈhh/Xpythonrr}rbh=]rhhh9]rh;]r Usourcer!X8/home/prologic/work/circuits/docs/source/tutorial/008.pyr"h?]r#hA]r$uhCKhDhh%]r%h]X#!/usr/bin/env python from circuits import Component, Event class Bark(Event): """Bark Event""" class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) class Dog(Component): def started(self, *args): self.fire(Bark()) def bark(self): print("Woof! I'm %s!" % self.name) class Bob(Dog): """Bob""" channel = "bob" class Fred(Dog): """Fred""" channel = "fred" Pound().run() r&r'}r((h*Uh-jubaubhw)r)}r*(h*X$:download:`Download 008.py <008.py>`r+h-jhh.h1h3h{h5}r,(h=]r-h?]r.h;]r/h9]r0hA]r1uhCKhDhh%]r2h)r3}r4(h*j+h-j)h.h1h3hh5}r5(Ureftyper6Xdownloadr7hhX008.pyr8U refdomainr9Uh9]r:h;]r;U refexplicitr<h=]r=h?]r>hA]r?hhhX008.pyr@uhCKh%]rAh)rB}rC(h*j+h5}rD(h=]rEh?]rF(hj7eh;]rGh9]rHhA]rIuh-j3h%]rJh]XDownload 008.pyrKrL}rM(h*Uh-jBubah3hubaubaubhw)rN}rO(h*XIf you run this, you'll get::rPh-jhh.h1h3h{h5}rQ(h=]rRh?]rSh;]rTh9]rUhA]rVuhCKhDhh%]rWh]XIf you run this, you'll get:rXrY}rZ(h*XIf you run this, you'll get:r[h-jNubaubh)r\}r](h*XWoof! I'm Bob! Woof! I'm Fred!r^h-jhh.h1h3hh5}r_(hhh9]r`h;]rah=]rbh?]rchA]rduhCKhDhh%]reh]XWoof! I'm Bob! Woof! I'm Fred!rfrg}rh(h*Uh-j\ubaubeubhF)ri}rj(h*Uh-hGh.h1h3hIh5}rk(h=]rlh?]rmh;]rnh9]roh!ahA]rph auhCKhDhh%]rq(hQ)rr}rs(h*X The Debuggerrth-jih.h1h3hUh5}ru(h=]rvh?]rwh;]rxh9]ryhA]rzuhCKhDhh%]r{h]X The Debuggerr|r}}r~(h*jth-jrubaubhw)r}r(h*X Lastly...rh-jih.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]rh]X Lastly...rr}r(h*jh-jubaubhw)r}r(h*XAsynchronous programming has many advantages but can be a little harder to write and follow. A silently caught exception in an Event Handler, or an Event that never gets fired, or any number of other weird things can cause your application to fail and leave you scratching your head.rh-jih.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]rh]XAsynchronous programming has many advantages but can be a little harder to write and follow. A silently caught exception in an Event Handler, or an Event that never gets fired, or any number of other weird things can cause your application to fail and leave you scratching your head.rr}r(h*jh-jubaubhw)r}r(h*XFortunately circuits comes with a ``Debugger`` Component to help you keep track of what's going on in your application, and allows you to tell what your application is doing.rh-jih.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]r(h]X"Fortunately circuits comes with a rr}r(h*X"Fortunately circuits comes with a rh-jubh)r}r(h*X ``Debugger``rh5}r(h=]rh?]rh;]rh9]rhA]ruh-jh%]rh]XDebuggerrr}r(h*Uh-jubah3hubh]X Component to help you keep track of what's going on in your application, and allows you to tell what your application is doing.rr}r(h*X Component to help you keep track of what's going on in your application, and allows you to tell what your application is doing.rh-jubeubhw)r}r(h*XZLet's say that we defined out ``bark`` Event Handler in our ``Dog`` Component as follows::rh-jih.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]r(h]XLet's say that we defined out rr}r(h*XLet's say that we defined out rh-jubh)r}r(h*X``bark``rh5}r(h=]rh?]rh;]rh9]rhA]ruh-jh%]rh]Xbarkrr}r(h*Uh-jubah3hubh]X Event Handler in our rr}r(h*X Event Handler in our rh-jubh)r}r(h*X``Dog``rh5}r(h=]rh?]rh;]rh9]rhA]ruh-jh%]rh]XDogrr}r(h*Uh-jubah3hubh]X Component as follows:rr}r(h*X Component as follows:rh-jubeubh)r}r(h*X0def bark(self): print("Woof! I'm %s!" % name)rh-jih.h1h3hh5}r(hhh9]rh;]rh=]rh?]rhA]ruhCKhDhh%]rh]X0def bark(self): print("Woof! I'm %s!" % name)rr}r(h*Uh-jubaubhw)r}r(h*XENow clearly there is no such variable as ``name`` in the local scope.rh-jih.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]r(h]X)Now clearly there is no such variable as rr}r(h*X)Now clearly there is no such variable as rh-jubh)r}r(h*X``name``rh5}r(h=]rh?]rh;]r h9]r hA]r uh-jh%]r h]Xnamer r}r(h*Uh-jubah3hubh]X in the local scope.rr}r(h*X in the local scope.rh-jubeubhw)r}r(h*X*For reference here's the entire example...rh-jih.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCKhDhh%]rh]X*For reference here's the entire example...rr}r (h*jh-jubaubh)r!}r"(h*X#!/usr/bin/env python from circuits import Component, Event class Bark(Event): """Bark Event""" class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) class Dog(Component): def started(self, *args): self.fire(Bark()) def bark(self): print("Woof! I'm %s!" % name) class Bob(Dog): """Bob""" channel = "bob" class Fred(Dog): """Fred""" channel = "fred" Pound().run() r#h-jih.h1h3hh5}r$(hÈhh/Xpythonr%r&}r'bh=]r(hhh9]r)h;]r*Usourcer+X8/home/prologic/work/circuits/docs/source/tutorial/009.pyr,h?]r-hA]r.uhCKhDhh%]r/h]X#!/usr/bin/env python from circuits import Component, Event class Bark(Event): """Bark Event""" class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) class Dog(Component): def started(self, *args): self.fire(Bark()) def bark(self): print("Woof! I'm %s!" % name) class Bob(Dog): """Bob""" channel = "bob" class Fred(Dog): """Fred""" channel = "fred" Pound().run() r0r1}r2(h*Uh-j!ubaubhw)r3}r4(h*X$:download:`Download 009.py <009.py>`r5h-jih.h1h3h{h5}r6(h=]r7h?]r8h;]r9h9]r:hA]r;uhCKhDhh%]r<h)r=}r>(h*j5h-j3h.h1h3hh5}r?(Ureftyper@XdownloadrAhhX009.pyrBU refdomainrCUh9]rDh;]rEU refexplicitrFh=]rGh?]rHhA]rIhhhX009.pyrJuhCKh%]rKh)rL}rM(h*j5h5}rN(h=]rOh?]rP(hjAeh;]rQh9]rRhA]rSuh-j=h%]rTh]XDownload 009.pyrUrV}rW(h*Uh-jLubah3hubaubaubhw)rX}rY(h*XIf you run this, you'll get:rZh-jih.h1h3h{h5}r[(h=]r\h?]r]h;]r^h9]r_hA]r`uhCMhDhh%]rah]XIf you run this, you'll get:rbrc}rd(h*jZh-jXubaubhw)re}rf(h*X3That's right! You get nothing! Why? Well in circuits any error or exception that occurs in a running application is automatically caught and dealt with in a way that lets your application "keep on going". Crashing is unwanted behavior in a system so we expect to be able to recover from horrible situations.rgh-jih.h1h3h{h5}rh(h=]rih?]rjh;]rkh9]rlhA]rmuhCMhDhh%]rnh]X3That's right! You get nothing! Why? Well in circuits any error or exception that occurs in a running application is automatically caught and dealt with in a way that lets your application "keep on going". Crashing is unwanted behavior in a system so we expect to be able to recover from horrible situations.rorp}rq(h*jgh-jeubaubhw)rr}rs(h*XSO what do we do? Well that's easy. circuits comes with a ``Debugger`` that lets you log all events as well as all errors so you can quickly and easily discover which Event is causing a problem and which Event Handler to look at.rth-jih.h1h3h{h5}ru(h=]rvh?]rwh;]rxh9]ryhA]rzuhCM hDhh%]r{(h]X:SO what do we do? Well that's easy. circuits comes with a r|r}}r~(h*X:SO what do we do? Well that's easy. circuits comes with a rh-jrubh)r}r(h*X ``Debugger``rh5}r(h=]rh?]rh;]rh9]rhA]ruh-jrh%]rh]XDebuggerrr}r(h*Uh-jubah3hubh]X that lets you log all events as well as all errors so you can quickly and easily discover which Event is causing a problem and which Event Handler to look at.rr}r(h*X that lets you log all events as well as all errors so you can quickly and easily discover which Event is causing a problem and which Event Handler to look at.rh-jrubeubhw)r}r(h*X'If you change Line 34 of our example...rh-jih.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCMhDhh%]rh]X'If you change Line 34 of our example...rr}r(h*jh-jubaubhw)r}r(h*XFrom:rh-jih.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCMhDhh%]rh]XFrom:rr}r(h*jh-jubaubh)r}r(h*XPound().run() rh-jih.h1h3hh5}r(hh/Xpythonrr}rbh=]rhhh9]rh;]rUsourcerX8/home/prologic/work/circuits/docs/source/tutorial/009.pyrh?]rhA]ruhCMhDhh%]rh]XPound().run() rr}r(h*Uh-jubaubhw)r}r(h*XTo:rh-jih.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCMhDhh%]rh]XTo:rr}r(h*jh-jubaubh)r}r(h*X;from circuits import Debugger (Pound() + Debugger()).run()rh-jih.h1h3hh5}r(hÉhXpythonrhhh9]rh;]rh=]rh?]rhA]ruhCMhDhh%]rh]X;from circuits import Debugger (Pound() + Debugger()).run()rr}r(h*Uh-jubaubhw)r}r(h*X)Then run this, you'll get the following::rh-jih.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCMhDhh%]rh]X(Then run this, you'll get the following:rr}r(h*X(Then run this, you'll get the following:rh-jubaubh)r}r(h*Xq , ] {}> , ] {}> , ] {}> , None] {}> , NameError("global name 'name' is not defined",), [' File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent\n retval = handler(*eargs, **ekwargs)\n', ' File "source/tutorial/009.py", line 22, in bark\n print("Woof! I\'m %s!" % name)\n'], >] {}> ERROR (): global name 'name' is not defined File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent retval = handler(*eargs, **ekwargs) File "source/tutorial/009.py", line 22, in bark print("Woof! I'm %s!" % name) , NameError("global name 'name' is not defined",), [' File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent\n retval = handler(*eargs, **ekwargs)\n', ' File "source/tutorial/009.py", line 22, in bark\n print("Woof! I\'m %s!" % name)\n'], >] {}> ERROR (): global name 'name' is not defined File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent retval = handler(*eargs, **ekwargs) File "source/tutorial/009.py", line 22, in bark print("Woof! I'm %s!" % name) ^C] {}> ] {}> ] {}>rh-jih.h1h3hh5}r(hhh9]rh;]rh=]rh?]rhA]ruhCM hDhh%]rh]Xq , ] {}> , ] {}> , ] {}> , None] {}> , NameError("global name 'name' is not defined",), [' File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent\n retval = handler(*eargs, **ekwargs)\n', ' File "source/tutorial/009.py", line 22, in bark\n print("Woof! I\'m %s!" % name)\n'], >] {}> ERROR (): global name 'name' is not defined File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent retval = handler(*eargs, **ekwargs) File "source/tutorial/009.py", line 22, in bark print("Woof! I'm %s!" % name) , NameError("global name 'name' is not defined",), [' File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent\n retval = handler(*eargs, **ekwargs)\n', ' File "source/tutorial/009.py", line 22, in bark\n print("Woof! I\'m %s!" % name)\n'], >] {}> ERROR (): global name 'name' is not defined File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent retval = handler(*eargs, **ekwargs) File "source/tutorial/009.py", line 22, in bark print("Woof! I'm %s!" % name) ^C] {}> ] {}> ] {}>rr}r(h*Uh-jubaubhw)r}r(h*XNYou'll notice whereas there was no output before there is now a pretty detailed output with the ``Debugger`` added to the application. Looking through the output, we find that the application does indeed start correctly, but when we fire our ``Bark`` Event it coughs up two exceptions, one for each of our dogs (``Bob`` and ``Fred``).rh-jih.h1h3h{h5}r(h=]rh?]rh;]rh9]rhA]ruhCM8hDhh%]r(h]X`You'll notice whereas there was no output before there is now a pretty detailed output with the rr}r(h*X`You'll notice whereas there was no output before there is now a pretty detailed output with the r h-jubh)r }r (h*X ``Debugger``r h5}r (h=]r h?]r h;]r h9]r hA]r uh-jh%]r h]XDebuggerr r }r (h*Uh-j ubah3hubh]X added to the application. Looking through the output, we find that the application does indeed start correctly, but when we fire our r r }r (h*X added to the application. Looking through the output, we find that the application does indeed start correctly, but when we fire our r h-jubh)r }r (h*X``Bark``r h5}r (h=]r h?]r h;]r h9]r hA]r uh-jh%]r h]XBarkr r }r (h*Uh-j ubah3hubh]X> Event it coughs up two exceptions, one for each of our dogs (r r }r! (h*X> Event it coughs up two exceptions, one for each of our dogs (r" h-jubh)r# }r$ (h*X``Bob``r% h5}r& (h=]r' h?]r( h;]r) h9]r* hA]r+ uh-jh%]r, h]XBobr- r. }r/ (h*Uh-j# ubah3hubh]X and r0 r1 }r2 (h*X and r3 h-jubh)r4 }r5 (h*X``Fred``r6 h5}r7 (h=]r8 h?]r9 h;]r: h9]r; hA]r< uh-jh%]r= h]XFredr> r? }r@ (h*Uh-j4 ubah3hubh]X).rA rB }rC (h*X).rD h-jubeubhw)rE }rF (h*XTFrom the error we can tell where the error is and roughly where to look in the code.rG h-jih.h1h3h{h5}rH (h=]rI h?]rJ h;]rK h9]rL hA]rM uhCM>hDhh%]rN h]XTFrom the error we can tell where the error is and roughly where to look in the code.rO rP }rQ (h*jG h-jE ubaubj )rR }rS (h*XcYou'll notice many other events that are displayed in the above output. These are all default events that circuits has builtin which your application can respond to. Each builtin Event has a special meaning with relation to the state of the application at that point. See: :py:mod:`circuits.core.events` for detailed documentation regarding these events.rT h-jih.h1h3j$h5}rU (h=]rV h?]rW h;]rX h9]rY hA]rZ uhCNhDhh%]r[ (hw)r\ }r] (h*X You'll notice many other events that are displayed in the above output. These are all default events that circuits has builtin which your application can respond to. Each builtin Event has a special meaning with relation to the state of the application at that point.r^ h-jR h.h1h3h{h5}r_ (h=]r` h?]ra h;]rb h9]rc hA]rd uhCMBh%]re h]X You'll notice many other events that are displayed in the above output. These are all default events that circuits has builtin which your application can respond to. Each builtin Event has a special meaning with relation to the state of the application at that point.rf rg }rh (h*j^ h-j\ ubaubhw)ri }rj (h*XVSee: :py:mod:`circuits.core.events` for detailed documentation regarding these events.rk h-jR h.h1h3h{h5}rl (h=]rm h?]rn h;]ro h9]rp hA]rq uhCMGh%]rr (h]XSee: rs rt }ru (h*XSee: rv h-ji ubcsphinx.addnodes pending_xref rw )rx }ry (h*X:py:mod:`circuits.core.events`rz h-ji h.h1h3U pending_xrefr{ h5}r| (Ureftyper} Xmodr~ hhXcircuits.core.eventsr U refdomainr Xpyr h9]r h;]r U refexplicitr h=]r h?]r hA]r hhUpy:classr NU py:moduler NuhCMGh%]r h)r }r (h*jz h5}r (h=]r h?]r (hj Xpy-modr eh;]r h9]r hA]r uh-jx h%]r h]Xcircuits.core.eventsr r }r (h*Uh-j ubah3hubaubh]X3 for detailed documentation regarding these events.r r }r (h*X3 for detailed documentation regarding these events.r h-ji ubeubeubhw)r }r (h*X;The correct code for the ``bark`` Event Handler should be::r h-jih.h1h3h{h5}r (h=]r h?]r h;]r h9]r hA]r uhCMJhDhh%]r (h]XThe correct code for the r r }r (h*XThe correct code for the r h-j ubh)r }r (h*X``bark``r h5}r (h=]r h?]r h;]r h9]r hA]r uh-j h%]r h]Xbarkr r }r (h*Uh-j ubah3hubh]X Event Handler should be:r r }r (h*X Event Handler should be:r h-j ubeubh)r }r (h*X6def bark(self): print("Woof! I'm %s!" % self.name)r h-jih.h1h3hh5}r (hhh9]r h;]r h=]r h?]r hA]r uhCMLhDhh%]r h]X6def bark(self): print("Woof! I'm %s!" % self.name)r r }r (h*Uh-j ubaubhw)r }r (h*XBRunning again with our correction results in the expected output::r h-jih.h1h3h{h5}r (h=]r h?]r h;]r h9]r hA]r uhCMOhDhh%]r h]XARunning again with our correction results in the expected output:r r }r (h*XARunning again with our correction results in the expected output:r h-j ubaubh)r }r (h*XWoof! I'm Bob! Woof! I'm Fred!r h-jih.h1h3hh5}r (hhh9]r h;]r h=]r h?]r hA]r uhCMQhDhh%]r h]XWoof! I'm Bob! Woof! I'm Fred!r r }r (h*Uh-j ubaubhw)r }r (h*XThat's it folks!r h-jih.h1h3h{h5}r (h=]r h?]r h;]r h9]r hA]r uhCMThDhh%]r h]XThat's it folks!r r }r (h*j h-j ubaubhw)r }r (h*XHopefully this gives you a feel of what circuits is all about and an easy tutorial on some of the basic concepts. As you're no doubt itching to get started on your next circuits project, here's some recommended reading:r h-jih.h1h3h{h5}r (h=]r h?]r h;]r h9]r hA]r uhCMVhDhh%]r h]XHopefully this gives you a feel of what circuits is all about and an easy tutorial on some of the basic concepts. As you're no doubt itching to get started on your next circuits project, here's some recommended reading:r r }r (h*j h-j ubaubj|)r }r (h*Uh-jih.h1h3jh5}r (jX-h9]r h;]r h=]r h?]r hA]r uhCMZhDhh%]r (j)r }r (h*X :doc:`../faq`r h-j h.h1h3jh5}r (h=]r h?]r h;]r h9]r hA]r uhCNhDhh%]r hw)r }r (h*j h-j h.h1h3h{h5}r (h=]r h?]r h;]r h9]r hA]r uhCMZh%]r jw )r }r (h*j h-j h.h1h3j{ h5}r (Ureftyper Xdocr hhX../faqr U refdomainr Uh9]r h;]r! U refexplicitr" h=]r# h?]r$ hA]r% hhuhCMZh%]r& h)r' }r( (h*j h5}r) (h=]r* h?]r+ (hj eh;]r, h9]r- hA]r. uh-j h%]r/ h]X../faqr0 r1 }r2 (h*Uh-j' ubah3hubaubaubaubj)r3 }r4 (h*X:doc:`../howtos/index`r5 h-j h.h1h3jh5}r6 (h=]r7 h?]r8 h;]r9 h9]r: hA]r; uhCNhDhh%]r< hw)r= }r> (h*j5 h-j3 h.h1h3h{h5}r? (h=]r@ h?]rA h;]rB h9]rC hA]rD uhCM[h%]rE jw )rF }rG (h*j5 h-j= h.h1h3j{ h5}rH (UreftyperI XdocrJ hhX../howtos/indexrK U refdomainrL Uh9]rM h;]rN U refexplicitrO h=]rP h?]rQ hA]rR hhuhCM[h%]rS h)rT }rU (h*j5 h5}rV (h=]rW h?]rX (hjJ eh;]rY h9]rZ hA]r[ uh-jF h%]r\ h]X../howtos/indexr] r^ }r_ (h*Uh-jT ubah3hubaubaubaubj)r` }ra (h*X:doc:`../api/index`rb h-j h.h1h3jh5}rc (h=]rd h?]re h;]rf h9]rg hA]rh uhCNhDhh%]ri hw)rj }rk (h*jb h-j` h.h1h3h{h5}rl (h=]rm h?]rn h;]ro h9]rp hA]rq uhCM\h%]rr jw )rs }rt (h*jb h-jj h.h1h3j{ h5}ru (Ureftyperv Xdocrw hhX ../api/indexrx U refdomainry Uh9]rz h;]r{ U refexplicitr| h=]r} h?]r~ hA]r hhuhCM\h%]r h)r }r (h*jb h5}r (h=]r h?]r (hjw eh;]r h9]r hA]r uh-js h%]r h]X ../api/indexr r }r (h*Uh-j ubah3hubaubaubaubeubeubeubeh*UU transformerr NU footnote_refsr }r Urefnamesr }r Xpython programming languager ]r jasUsymbol_footnotesr ]r Uautofootnote_refsr ]r Usymbol_footnote_refsr ]r U citationsr ]r hDhU current_liner NUtransform_messagesr ]r Ureporterr NUid_startr KU autofootnotesr ]r U citation_refsr }r Uindirect_targetsr ]r Usettingsr (cdocutils.frontend Values r or }r (Ufootnote_backlinksr KUrecord_dependenciesr NU rfc_base_urlr Uhttp://tools.ietf.org/html/r U tracebackr Upep_referencesr NUstrip_commentsr NU toc_backlinksr Uentryr U language_coder Uenr U datestampr NU report_levelr KU _destinationr NU halt_levelr KU strip_classesr NhUNUerror_encoding_error_handlerr Ubackslashreplacer Udebugr NUembed_stylesheetr Uoutput_encoding_error_handlerr Ustrictr U sectnum_xformr KUdump_transformsr NU docinfo_xformr KUwarning_streamr NUpep_file_url_templater Upep-%04dr Uexit_status_levelr KUconfigr NUstrict_visitorr NUcloak_email_addressesr Utrim_footnote_reference_spacer Uenvr NUdump_pseudo_xmlr NUexpose_internalsr NUsectsubtitle_xformr U source_linkr NUrfc_referencesr NUoutput_encodingr Uutf-8r U source_urlr NUinput_encodingr U utf-8-sigr U_disable_configr NU id_prefixr UU tab_widthr KUerror_encodingr U ISO-8859-1r U_sourcer U;/home/prologic/work/circuits/docs/source/tutorial/index.rstr Ugettext_compactr U generatorr NUdump_internalsr NU smart_quotesr U pep_base_urlr Uhttp://www.python.org/dev/peps/r Usyntax_highlightr Ulongr Uinput_encoding_error_handlerr j Uauto_id_prefixr Uidr Udoctitle_xformr Ustrip_elements_with_classesr NU _config_filesr ]r Ufile_insertion_enabledr KU raw_enabledr KU dump_settingsr NubUsymbol_footnote_startr KUidsr }r (hjhjhh#j}h"jhjLhhah h(hhh!jih$hGhjXuUsubstitution_namesr }r h3hDh5}r (h=]r h9]r h;]r Usourcer h1h?]r hA]r uU footnotesr ]r Urefidsr }r ub.circuits-2.1.0/docs/build/doctrees/faq.doctree0000644000014400001440000003503512113366670021060 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(Xfrequently asked questionsqNXgeneralqNX mailing listqX#circuits irc channelq uUsubstitution_defsq }q Uparse_messagesq ]q Ucurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hUfrequently-asked-questionsqhUgeneralqhU mailing-listqh Ucircuits-irc-channelquUchildrenq]q(cdocutils.nodes target q)q}q(U rawsourceqX].. _#circuits IRC Channel: http://webchat.freenode.net/?randomnick=1&channels=circuits&uio=d4qU referencedqKUparentqhUsourceq cdocutils.nodes reprunicode q!X0/home/prologic/work/circuits/docs/source/faq.rstq"q#}q$bUtagnameq%Utargetq&U attributesq'}q((Urefuriq)XBhttp://webchat.freenode.net/?randomnick=1&channels=circuits&uio=d4q*Uidsq+]q,haUbackrefsq-]q.Udupnamesq/]q0Uclassesq1]q2Unamesq3]q4h auUlineq5KUdocumentq6hh]q7ubh)q8}q9(hX?.. _Mailing List: http://groups.google.com/group/circuits-usersq:hKhhh h#h%h&h'}q;(h)X-http://groups.google.com/group/circuits-usersqh/]q?h1]q@h3]qAhauh5Kh6hh]qBubcdocutils.nodes comment qC)qD}qE(hXfaq:qFhhh h#h%UcommentqGh'}qH(U xml:spaceqIUpreserveqJh+]qKh-]qLh/]qMh1]qNh3]qOuh5Kh6hh]qPcdocutils.nodes Text qQXfaq:qRqS}qT(hUhhDubaubcdocutils.nodes section qU)qV}qW(hUhhh h#h%UsectionqXh'}qY(h/]qZh1]q[h-]q\h+]q]hah3]q^hauh5Kh6hh]q_(cdocutils.nodes title q`)qa}qb(hXFrequently Asked QuestionsqchhVh h#h%Utitleqdh'}qe(h/]qfh1]qgh-]qhh+]qih3]qjuh5Kh6hh]qkhQXFrequently Asked Questionsqlqm}qn(hhchhaubaubhC)qo}qp(hXgeneral:qqhhVh h#h%hGh'}qr(hIhJh+]qsh-]qth/]quh1]qvh3]qwuh5K h6hh]qxhQXgeneral:qyqz}q{(hUhhoubaubhU)q|}q}(hUhhVh h#h%hXh'}q~(h/]qh1]qh-]qh+]qhah3]qhauh5K h6hh]q(h`)q}q(hXGeneralqhh|h h#h%hdh'}q(h/]qh1]qh-]qh+]qh3]quh5K h6hh]qhQXGeneralqq}q(hhhhubaubcdocutils.nodes definition_list q)q}q(hUhh|h h#h%Udefinition_listqh'}q(h/]qh1]qh-]qh+]qh3]quh5Nh6hh]q(cdocutils.nodes definition_list_item q)q}q(hX... What is circuits? circuits is an event-driven framework with a high focus on Component architectures making your life as a software developer much easier. circuits allows you to write maintainable and scalable systems easily qhhh h#h%Udefinition_list_itemqh'}q(h/]qh1]qh-]qh+]qh3]quh5Kh]q(cdocutils.nodes term q)q}q(hX... What is circuits?qhhh h#h%Utermqh'}q(h/]qh1]qh-]qh+]qh3]quh5Kh]qhQX... What is circuits?qq}q(hX... What is circuits?qhhubaubcdocutils.nodes definition q)q}q(hUh'}q(h/]qh1]qh-]qh+]qh3]quhhh]qcdocutils.nodes paragraph q)q}q(hXcircuits is an event-driven framework with a high focus on Component architectures making your life as a software developer much easier. circuits allows you to write maintainable and scalable systems easilyqhhh h#h%U paragraphqh'}q(h/]qh1]qh-]qh+]qh3]quh5Kh]qhQXcircuits is an event-driven framework with a high focus on Component architectures making your life as a software developer much easier. circuits allows you to write maintainable and scalable systems easilyqυq}q(hhhhubaubah%U definitionqubeubh)q}q(hX... Can I write networking applications with circuits? Yes absolutely. circuits comes with socket I/O components for tcp, udp and unix sockets with asynchronous polling implementations for select, poll, epoll and kqueue. qhhh h#h%hh'}q(h/]qh1]qh-]qh+]qh3]quh5Kh6hh]q(h)q}q(hX6... Can I write networking applications with circuits?qhhh h#h%hh'}q(h/]qh1]qh-]qh+]qh3]quh5Kh]qhQX6... Can I write networking applications with circuits?q煁q}q(hX6... Can I write networking applications with circuits?qhhubaubh)q}q(hUh'}q(h/]qh1]qh-]qh+]qh3]quhhh]qh)q}q(hXYes absolutely. circuits comes with socket I/O components for tcp, udp and unix sockets with asynchronous polling implementations for select, poll, epoll and kqueue.qhhh h#h%hh'}q(h/]qh1]qh-]qh+]qh3]quh5Kh]qhQXYes absolutely. circuits comes with socket I/O components for tcp, udp and unix sockets with asynchronous polling implementations for select, poll, epoll and kqueue.qq}r(hhhhubaubah%hubeubh)r}r(hX|... Can I integrate circuits with a GUI library? This is entirely possible. You will have to hook into the GUI's main loop. rhhh h#h%hh'}r(h/]rh1]rh-]rh+]rh3]r uh5Kh6hh]r (h)r }r (hX0... Can I integrate circuits with a GUI library?r hjh h#h%hh'}r(h/]rh1]rh-]rh+]rh3]ruh5Kh]rhQX0... Can I integrate circuits with a GUI library?rr}r(hX0... Can I integrate circuits with a GUI library?rhj ubaubh)r}r(hUh'}r(h/]rh1]rh-]rh+]rh3]r uhjh]r!h)r"}r#(hXJThis is entirely possible. You will have to hook into the GUI's main loop.r$hjh h#h%hh'}r%(h/]r&h1]r'h-]r(h+]r)h3]r*uh5Kh]r+hQXJThis is entirely possible. You will have to hook into the GUI's main loop.r,r-}r.(hj$hj"ubaubah%hubeubh)r/}r0(hX... What are the core concepts in circuits? Components and Events. Components are maintainable reusable units of behavior that communicate with other components via a powerful message passing system. r1hhh h#h%hh'}r2(h/]r3h1]r4h-]r5h+]r6h3]r7uh5Kh6hh]r8(h)r9}r:(hX+... What are the core concepts in circuits?r;hj/h h#h%hh'}r<(h/]r=h1]r>h-]r?h+]r@h3]rAuh5Kh]rBhQX+... What are the core concepts in circuits?rCrD}rE(hX+... What are the core concepts in circuits?rFhj9ubaubh)rG}rH(hUh'}rI(h/]rJh1]rKh-]rLh+]rMh3]rNuhj/h]rOh)rP}rQ(hXComponents and Events. Components are maintainable reusable units of behavior that communicate with other components via a powerful message passing system.rRhjGh h#h%hh'}rS(h/]rTh1]rUh-]rVh+]rWh3]rXuh5Kh]rYhQXComponents and Events. Components are maintainable reusable units of behavior that communicate with other components via a powerful message passing system.rZr[}r\(hjRhjPubaubah%hubeubh)r]}r^(hX... How would you compare circuits to Twisted? Others have said that circuits is very elegant in terms of it's usage. circuits' component architecture allows you to define clear interfaces between components while maintaining a high level of scalability and maintainability. r_hhh h#h%hh'}r`(h/]rah1]rbh-]rch+]rdh3]reuh5K%h6hh]rf(h)rg}rh(hX.... How would you compare circuits to Twisted?rihj]h h#h%hh'}rj(h/]rkh1]rlh-]rmh+]rnh3]rouh5K%h]rphQX.... How would you compare circuits to Twisted?rqrr}rs(hX.... How would you compare circuits to Twisted?rthjgubaubh)ru}rv(hUh'}rw(h/]rxh1]ryh-]rzh+]r{h3]r|uhj]h]r}h)r~}r(hXOthers have said that circuits is very elegant in terms of it's usage. circuits' component architecture allows you to define clear interfaces between components while maintaining a high level of scalability and maintainability.rhjuh h#h%hh'}r(h/]rh1]rh-]rh+]rh3]ruh5K"h]rhQXOthers have said that circuits is very elegant in terms of it's usage. circuits' component architecture allows you to define clear interfaces between components while maintaining a high level of scalability and maintainability.rr}r(hjhj~ubaubah%hubeubh)r}r(hXu... Can Components communicate with other processes? Yes. circuits implements currently component bridging and nodes rhhh h#h%hh'}r(h/]rh1]rh-]rh+]rh3]ruh5K(h6hh]r(h)r}r(hX4... Can Components communicate with other processes?rhjh h#h%hh'}r(h/]rh1]rh-]rh+]rh3]ruh5K(h]rhQX4... Can Components communicate with other processes?rr}r(hX4... Can Components communicate with other processes?rhjubaubh)r}r(hUh'}r(h/]rh1]rh-]rh+]rh3]ruhjh]rh)r}r(hX?Yes. circuits implements currently component bridging and nodesrhjh h#h%hh'}r(h/]rh1]rh-]rh+]rh3]ruh5K(h]rhQX?Yes. circuits implements currently component bridging and nodesrr}r(hjhjubaubah%hubeubh)r}r(hX... What platforms does circuits support? circuits currently supports Linux, FreeBSD, OSX and Windows and is currently continually tested against Linux and Windows against Python versions 2.6, 2.7, 3.1 and 3.2 rhhh h#h%hh'}r(h/]rh1]rh-]rh+]rh3]ruh5K-h6hh]r(h)r}r(hX)... What platforms does circuits support?rhjh h#h%hh'}r(h/]rh1]rh-]rh+]rh3]ruh5K-h]rhQX)... What platforms does circuits support?rr}r(hX)... What platforms does circuits support?rhjubaubh)r}r(hUh'}r(h/]rh1]rh-]rh+]rh3]ruhjh]rh)r}r(hXcircuits currently supports Linux, FreeBSD, OSX and Windows and is currently continually tested against Linux and Windows against Python versions 2.6, 2.7, 3.1 and 3.2rhjh h#h%hh'}r(h/]rh1]rh-]rh+]rh3]ruh5K+h]rhQXcircuits currently supports Linux, FreeBSD, OSX and Windows and is currently continually tested against Linux and Windows against Python versions 2.6, 2.7, 3.1 and 3.2rr}r(hjhjubaubah%hubeubh)r}r(hX... Can circuits be used for concurrent or distributed programming? Yes. We also have plans to build more distributed components into circuits making distributing computing with circuits very trivial. rhhh h#h%hh'}r(h/]rh1]rh-]rh+]rh3]ruh5K1h6hh]r(h)r}r(hXC... Can circuits be used for concurrent or distributed programming?rhjh h#h%hh'}r(h/]rh1]rh-]rh+]rh3]ruh5K1h]rhQXC... Can circuits be used for concurrent or distributed programming?rr}r(hXC... Can circuits be used for concurrent or distributed programming?rhjubaubh)r}r(hUh'}r(h/]rh1]rh-]rh+]rh3]ruhjh]rh)r}r (hXYes. We also have plans to build more distributed components into circuits making distributing computing with circuits very trivial.r hjh h#h%hh'}r (h/]r h1]r h-]rh+]rh3]ruh5K0h]rhQXYes. We also have plans to build more distributed components into circuits making distributing computing with circuits very trivial.rr}r(hj hjubaubah%hubeubeubh)r}r(hXGot more questions?rhh|h h#h%hh'}r(h/]rh1]rh-]rh+]rh3]ruh5K3h6hh]rhQXGot more questions?rr }r!(hjhjubaubcdocutils.nodes bullet_list r")r#}r$(hUhh|h h#h%U bullet_listr%h'}r&(Ubulletr'X*h+]r(h-]r)h/]r*h1]r+h3]r,uh5K5h6hh]r-(cdocutils.nodes list_item r.)r/}r0(hX%Send an email to our `Mailing List`_.r1hj#h h#h%U list_itemr2h'}r3(h/]r4h1]r5h-]r6h+]r7h3]r8uh5Nh6hh]r9h)r:}r;(hj1hj/h h#h%hh'}r<(h/]r=h1]r>h-]r?h+]r@h3]rAuh5K5h]rB(hQXSend an email to our rCrD}rE(hXSend an email to our rFhj:ubcdocutils.nodes reference rG)rH}rI(hX`Mailing List`_rJUresolvedrKKhj:h%U referencerLh'}rM(UnamerNX Mailing ListrOh)hh]q?haRq@X006.pyqAqBX8/home/prologic/work/circuits/docs/source/tutorial/009.pyqCh]qDhaRqEX009.pyqFqGuh]qH(hh\]r?h^]r@uh`]rA(ht)rB}rC(hSXcircuits.net.protocolsrDhT}rE(hV]rFhX]rGhZ]rHh\]rIh^]rJuhgj9h`]rKhbXcircuits.net.protocolsrLrM}rN(hSUhgjBubahhhubhbX -- Networking ProtocolsrOrP}rQ(hSX -- Networking ProtocolsrRhgj9ubehhhiubUstart/downloadingrShP)rT}rU(hSUhT}rV(hV]rWhX]rXhZ]rYh\]rZh^]r[uh`]r\hbX Downloadingr]r^}r_(hSX Downloadingr`hgjTubahhhiubUfaqrahP)rb}rc(hSUhT}rd(hV]rehX]rfhZ]rgh\]rhh^]riuh`]rjhbXFrequently Asked Questionsrkrl}rm(hSXFrequently Asked QuestionsrnhgjbubahhhiubUpypitestrohP)rp}rq(hSUhT}rr(hV]rshX]rthZ]ruh\]rvh^]rwuh`]rxhbX"PyPi Test Page - Tentative Releaseryrz}r{(hSX"PyPi Test Page - Tentative Releaser|hgjpubahhhiubU#api/circuits_web_dispatchers_staticr}hP)r~}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.web.dispatchers.staticrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgj~h`]rhbXcircuits.web.dispatchers.staticrr}r(hSUhgjubahhhubhbX -- Staticrr}r(hSX -- Staticrhgj~ubehhhiubUapi/circuits_node_noderhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.node.noderhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.node.noderr}r(hSUhgjubahhhubhbX -- Noderr}r(hSX -- NoderhgjubehhhiubUapi/circuits_net_protocols_linerhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.net.protocols.linerhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.net.protocols.linerr}r(hSUhgjubahhhubhbX -- Line Protocolrr}r(hSX -- Line ProtocolrhgjubehhhiubUapi/circuits_core_debuggerrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.core.debuggerrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.core.debuggerrr}r(hSUhgjubahhhubhbX -- Debuggerrr}r(hSX -- DebuggerrhgjubehhhiubUapi/circuits_corerhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSX circuits.corerhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbX circuits.corerr}r(hSUhgjubahhhubhbX -- Core Functionalityrr}r(hSX -- Core FunctionalityrhgjubehhhiubUapi/circuits_io_eventsrhP)r}r(hSUhT}r(hV]rhX]r hZ]r h\]r h^]r uh`]r (ht)r}r(hSXcircuits.io.eventsrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.io.eventsrr}r(hSUhgjubahhhubhbX -- I/O Eventsrr}r(hSX -- I/O EventsrhgjubehhhiubUstart/requirementsrhP)r }r!(hSUhT}r"(hV]r#hX]r$hZ]r%h\]r&h^]r'uh`]r(hbXRequirements and Dependenciesr)r*}r+(hSXRequirements and Dependenciesr,hgj ubahhhiubUapi/circuits_appr-hP)r.}r/(hSUhT}r0(hV]r1hX]r2hZ]r3h\]r4h^]r5uh`]r6(ht)r7}r8(hSX circuits.appr9hT}r:(hV]r;hX]r<hZ]r=h\]r>h^]r?uhgj.h`]r@hbX circuits.apprArB}rC(hSUhgj7ubahhhubhbX -- Application SupportrDrE}rF(hSX -- Application SupportrGhgj.ubehhhiubUapi/circuits_core_handlersrHhP)rI}rJ(hSUhT}rK(hV]rLhX]rMhZ]rNh\]rOh^]rPuh`]rQ(ht)rR}rS(hSXcircuits.core.handlersrThT}rU(hV]rVhX]rWhZ]rXh\]rYh^]rZuhgjIh`]r[hbXcircuits.core.handlersr\r]}r^(hSUhgjRubahhhubhbX -- Handlersr_r`}ra(hSX -- HandlersrbhgjIubehhhiubUapi/circuits_core_loaderrchP)rd}re(hSUhT}rf(hV]rghX]rhhZ]rih\]rjh^]rkuh`]rl(ht)rm}rn(hSXcircuits.core.loaderrohT}rp(hV]rqhX]rrhZ]rsh\]rth^]ruuhgjdh`]rvhbXcircuits.core.loaderrwrx}ry(hSUhgjmubahhhubhbX -- Loaderrzr{}r|(hSX -- Loaderr}hgjdubehhhiubUapi/circuits_web_httpr~hP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.web.httprhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.web.httprr}r(hSUhgjubahhhubhbX -- HTTP Protocolrr}r(hSX -- HTTP ProtocolrhgjubehhhiubUapi/circuits_node_serverrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.node.serverrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.node.serverrr}r(hSUhgjubahhhubhbX -- Serverrr}r(hSX -- ServerrhgjubehhhiubU'api/circuits_web_dispatchers_dispatcherrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSX#circuits.web.dispatchers.dispatcherrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbX#circuits.web.dispatchers.dispatcherrr}r(hSUhgjubahhhubhbX -- Default Dispatcherrr}r(hSX -- Default DispatcherrhgjubehhhiubU web/basicsrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rhbX The Basicsrr}r(hSX The BasicsrhgjubahhhiubUstart/installingrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rhbX Installingrr}r(hSX InstallingrhgjubahhhiubUapi/circuits_app_daemonrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.app.daemonrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.app.daemonrr}r(hSUhgjubahhhubhbX -- Application Daemonrr}r(hSX -- Application DaemonrhgjubehhhiubUapi/circuits_core_utilsrhP)r}r(hSUhT}r (hV]r hX]r hZ]r h\]r h^]ruh`]r(ht)r}r(hSXcircuits.core.utilsrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.core.utilsrr}r(hSUhgjubahhhubhbX -- Utilitiesrr}r(hSX -- Utilitiesr hgjubehhhiubU man/debuggingr!hP)r"}r#(hSUhT}r$(hV]r%hX]r&hZ]r'h\]r(h^]r)uh`]r*hbX Debuggingr+r,}r-(hSX Debuggingr.hgj"ubahhhiubUapi/circuits_core_managerr/hP)r0}r1(hSUhT}r2(hV]r3hX]r4hZ]r5h\]r6h^]r7uh`]r8(ht)r9}r:(hSXcircuits.core.managerr;hT}r<(hV]r=hX]r>hZ]r?h\]r@h^]rAuhgj0h`]rBhbXcircuits.core.managerrCrD}rE(hSUhgj9ubahhhubhbX -- ManagerrFrG}rH(hSX -- ManagerrIhgj0ubehhhiubU man/managerrJhP)rK}rL(hSUhT}rM(hV]rNhX]rOhZ]rPh\]rQh^]rRuh`]rShbXManagerrTrU}rV(hSXManagerrWhgjKubahhhiubUtodorXhP)rY}rZ(hSUhT}r[(hV]r\hX]r]hZ]r^h\]r_h^]r`uh`]rahbXDocumentation TODOrbrc}rd(hSXDocumentation TODOrehgjYubahhhiubUapi/circuits_node_eventsrfhP)rg}rh(hSUhT}ri(hV]rjhX]rkhZ]rlh\]rmh^]rnuh`]ro(ht)rp}rq(hSXcircuits.node.eventsrrhT}rs(hV]rthX]ruhZ]rvh\]rwh^]rxuhgjgh`]ryhbXcircuits.node.eventsrzr{}r|(hSUhgjpubahhhubhbX -- Eventsr}r~}r(hSX -- EventsrhgjgubehhhiubUapi/circuits_core_valuesrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.core.valuesrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.core.valuesrr}r(hSUhgjubahhhubhbX -- Valuerr}r(hSX -- ValuerhgjubehhhiubUindexrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(hbX circuits rr}r(hSX circuits rhgjubhbX2.1.0rr}r(hSU2.1.0rhgjubhbX Documentationrr}r(hSX DocumentationrhgjubehhhiubUdev/contributingrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rhbXContributing to circuitsrr}r(hSXContributing to circuitsrhgjubahhhiubUapi/circuits_web_sessionsrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.web.sessionsrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.web.sessionsrr}r(hSUhgjubahhhubhbX -- Sessionsrr}r(hSX -- SessionsrhgjubehhhiubUapi/circuits_core_timersrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.core.timersrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.core.timersrr}r(hSUhgjubahhhubhbX -- Timersrr}r(hSX -- TimersrhgjubehhhiubUapi/circuits_web_wrappersrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.web.wrappersrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r hbXcircuits.web.wrappersr r }r (hSUhgjubahhhubhbX -- Request/Response Objectsr r}r(hSX -- Request/Response ObjectsrhgjubehhhiubhhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rhbXTutorialrr}r(hSXTutorialrhgjubahhhiubU man/indexrhP)r}r (hSUhT}r!(hV]r"hX]r#hZ]r$h\]r%h^]r&uh`]r'hbXThe circuits Frameworkr(r)}r*(hSXThe circuits Frameworkr+hgjubahhhiubUapi/circuits_web_errorsr,hP)r-}r.(hSUhT}r/(hV]r0hX]r1hZ]r2h\]r3h^]r4uh`]r5(ht)r6}r7(hSXcircuits.web.errorsr8hT}r9(hV]r:hX]r;hZ]r<h\]r=h^]r>uhgj-h`]r?hbXcircuits.web.errorsr@rA}rB(hSUhgj6ubahhhubhbX -- ErrorsrCrD}rE(hSX -- ErrorsrFhgj-ubehhhiubUapi/circuits_net_protocols_httprGhP)rH}rI(hSUhT}rJ(hV]rKhX]rLhZ]rMh\]rNh^]rOuh`]rP(ht)rQ}rR(hSXcircuits.net.protocols.httprShT}rT(hV]rUhX]rVhZ]rWh\]rXh^]rYuhgjHh`]rZhbXcircuits.net.protocols.httpr[r\}r](hSUhgjQubahhhubhbX -- HTTP Protocolr^r_}r`(hSX -- HTTP ProtocolrahgjHubehhhiubUapi/circuits_web_mainrbhP)rc}rd(hSUhT}re(hV]rfhX]rghZ]rhh\]rih^]rjuh`]rk(ht)rl}rm(hSXcircuits.web.mainrnhT}ro(hV]rphX]rqhZ]rrh\]rsh^]rtuhgjch`]ruhbXcircuits.web.mainrvrw}rx(hSUhgjlubahhhubhbX -- circuits.webryrz}r{(hSX -- circuits.webr|hgjcubehhhiubh hP)r}}r~(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rhbXHow To: Build a Simple Serverrr}r(hSXHow To: Build a Simple Serverrhgj}ubahhhiubUapi/circuits_core_componentsrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.core.componentsrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.core.componentsrr}r(hSUhgjubahhhubhbX -- Componentsrr}r(hSX -- ComponentsrhgjubehhhiubUapi/circuits_web_clientrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.web.clientrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.web.clientrr}r(hSUhgjubahhhubhbX -- Clientrr}r(hSX -- ClientrhgjubehhhiubUapi/circuits_core_workersrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.core.workersrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.core.workersrr}r(hSUhgjubahhhubhbX -- Workersrr}r(hSX -- WorkersrhgjubehhhiubUapi/circuits_web_websocketrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.web.websocketrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.web.websocketrr}r(hSUhgjubahhhubhbX -- WebSocket Clientrr}r(hSX -- WebSocket ClientrhgjubehhhiubUchangesrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rhbX ChangeLogrr}r(hSX ChangeLogrhgjubahhhiubUapi/circuits_toolsrhP)r}r(hSUhT}r(hV]rhX]r hZ]r h\]r h^]r uh`]r (ht)r}r(hSXcircuits.toolsrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.toolsrr}r(hSUhgjubahhhubhbX -- Development Toolsrr}r(hSX -- Development ToolsrhgjubehhhiubUapi/circuits_web_eventsrhP)r }r!(hSUhT}r"(hV]r#hX]r$hZ]r%h\]r&h^]r'uh`]r((ht)r)}r*(hSXcircuits.web.eventsr+hT}r,(hV]r-hX]r.hZ]r/h\]r0h^]r1uhgj h`]r2hbXcircuits.web.eventsr3r4}r5(hSUhgj)ubahhhubhbX -- Eventsr6r7}r8(hSX -- Eventsr9hgj ubehhhiubUapi/circuits_web_utilsr:hP)r;}r<(hSUhT}r=(hV]r>hX]r?hZ]r@h\]rAh^]rBuh`]rC(ht)rD}rE(hSXcircuits.web.utilsrFhT}rG(hV]rHhX]rIhZ]rJh\]rKh^]rLuhgj;h`]rMhbXcircuits.web.utilsrNrO}rP(hSUhgjDubahhhubhbX -- UtilitiesrQrR}rS(hSX -- UtilitiesrThgj;ubehhhiubUapi/circuits_node_utilsrUhP)rV}rW(hSUhT}rX(hV]rYhX]rZhZ]r[h\]r\h^]r]uh`]r^(ht)r_}r`(hSXcircuits.node.utilsrahT}rb(hV]rchX]rdhZ]reh\]rfh^]rguhgjVh`]rhhbXcircuits.node.utilsrirj}rk(hSUhgj_ubahhhubhbX -- Node Utilitiesrlrm}rn(hSX -- Node UtilitiesrohgjVubehhhiubU start/indexrphP)rq}rr(hSUhT}rs(hV]rthX]ruhZ]rvh\]rwh^]rxuh`]ryhbXGetting Startedrzr{}r|(hSXGetting Startedr}hgjqubahhhiubUapi/circuits_noder~hP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSX circuits.noderhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbX circuits.noderr}r(hSUhgjubahhhubhbX -- Noderr}r(hSX -- NoderhgjubehhhiubU$api/circuits_web_dispatchers_jsonrpcrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSX circuits.web.dispatchers.jsonrpcrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbX circuits.web.dispatchers.jsonrpcrr}r(hSUhgjubahhhubhbX -- JSON-RPCrr}r(hSX -- JSON-RPCrhgjubehhhiubU dev/processesrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rhbXDevelopment Processesrr}r(hSXDevelopment ProcessesrhgjubahhhiubUapi/circuits_io_notifyrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.io.notifyrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.io.notifyrr}r(hSUhgjubahhhubhbX -- File System Notificationrr}r(hSX -- File System NotificationrhgjubehhhiubU web/indexrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rhbXThe circuits.web Frameworkrr}r(hSXThe circuits.web FrameworkrhgjubahhhiubUapi/circuits_web_headersrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.web.headersrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.web.headersrr}r(hSUhgjubahhhubhbX -- Headersrr}r(hSX -- HeadersrhgjubehhhiubU howtos/indexrhP)r}r(hSUhT}r (hV]r hX]r hZ]r h\]r h^]ruh`]rhbXHowTosrr}r(hSXHowTosrhgjubahhhiubUdev/introductionrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rhbXDevelopment Introductionrr}r (hSXDevelopment Introductionr!hgjubahhhiubU#api/circuits_web_dispatchers_xmlrpcr"hP)r#}r$(hSUhT}r%(hV]r&hX]r'hZ]r(h\]r)h^]r*uh`]r+(ht)r,}r-(hSXcircuits.web.dispatchers.xmlrpcr.hT}r/(hV]r0hX]r1hZ]r2h\]r3h^]r4uhgj#h`]r5hbXcircuits.web.dispatchers.xmlrpcr6r7}r8(hSUhgj,ubahhhubhbX -- XML-RPCr9r:}r;(hSX -- XML-RPCr<hgj#ubehhhiubU'api/circuits_web_dispatchers_websocketsr=hP)r>}r?(hSUhT}r@(hV]rAhX]rBhZ]rCh\]rDh^]rEuh`]rF(ht)rG}rH(hSX#circuits.web.dispatchers.websocketsrIhT}rJ(hV]rKhX]rLhZ]rMh\]rNh^]rOuhgj>h`]rPhbX#circuits.web.dispatchers.websocketsrQrR}rS(hSUhgjGubahhhubhbX -- WebSocketsrTrU}rV(hSX -- WebSocketsrWhgj>ubehhhiubUapi/circuits_net_socketsrXhP)rY}rZ(hSUhT}r[(hV]r\hX]r]hZ]r^h\]r_h^]r`uh`]ra(ht)rb}rc(hSXcircuits.net.socketsrdhT}re(hV]rfhX]rghZ]rhh\]rih^]rjuhgjYh`]rkhbXcircuits.net.socketsrlrm}rn(hSUhgjbubahhhubhbX -- Socket Componentsrorp}rq(hSX -- Socket ComponentsrrhgjYubehhhiubUapi/circuits_core_eventsrshP)rt}ru(hSUhT}rv(hV]rwhX]rxhZ]ryh\]rzh^]r{uh`]r|(ht)r}}r~(hSXcircuits.core.eventsrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjth`]rhbXcircuits.core.eventsrr}r(hSUhgj}ubahhhubhbX -- Eventsrr}r(hSX -- EventsrhgjtubehhhiubUapi/circuits_web_serversrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.web.serversrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.web.serversrr}r(hSUhgjubahhhubhbX -- Serversrr}r(hSX -- ServersrhgjubehhhiubUglossaryrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rhbXGlossaryrr}r(hSXGlossaryrhgjubahhhiubUapi/circuits_web_wsgirhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.web.wsgirhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.web.wsgirr}r(hSUhgjubahhhubhbX -- WSGI Supportrr}r(hSX -- WSGI SupportrhgjubehhhiubU start/quickrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rhbXQuick Start Guiderr}r(hSXQuick Start Guiderhgjubahhhiubh&hP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rhbXEventsrr}r(hSXEventsrhgjubahhhiubU contributorsrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rhbX Contributorsrr}r(hSX ContributorsrhgjubahhhiubUweb/introductionrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rhbX Introductionrr}r(hSX IntroductionrhgjubahhhiubUapi/circuits_node_clientr hP)r }r (hSUhT}r (hV]r hX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.node.clientrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgj h`]rhbXcircuits.node.clientrr}r(hSUhgjubahhhubhbX -- Clientr r!}r"(hSX -- Clientr#hgj ubehhhiubh hP)r$}r%(hSUhT}r&(hV]r'hX]r(hZ]r)h\]r*h^]r+uh`]r,hbXHandlersr-r.}r/(hSXHandlersr0hgj$ubahhhiubUapi/circuits_app_envr1hP)r2}r3(hSUhT}r4(hV]r5hX]r6hZ]r7h\]r8h^]r9uh`]r:(ht)r;}r<(hSXcircuits.app.envr=hT}r>(hV]r?hX]r@hZ]rAh\]rBh^]rCuhgj2h`]rDhbXcircuits.app.envrErF}rG(hSUhgj;ubahhhubhbX -- Application EnvironmentrHrI}rJ(hSX -- Application EnvironmentrKhgj2ubehhhiubUapi/circuits_io_filerLhP)rM}rN(hSUhT}rO(hV]rPhX]rQhZ]rRh\]rSh^]rTuh`]rU(ht)rV}rW(hSXcircuits.io.filerXhT}rY(hV]rZhX]r[hZ]r\h\]r]h^]r^uhgjMh`]r_hbXcircuits.io.filer`ra}rb(hSUhgjVubahhhubhbX -- File I/Orcrd}re(hSX -- File I/OrfhgjMubehhhiubUapi/circuits_web_controllersrghP)rh}ri(hSUhT}rj(hV]rkhX]rlhZ]rmh\]rnh^]rouh`]rp(ht)rq}rr(hSXcircuits.web.controllersrshT}rt(hV]ruhX]rvhZ]rwh\]rxh^]ryuhgjhh`]rzhbXcircuits.web.controllersr{r|}r}(hSUhgjqubahhhubhbX -- Controllersr~r}r(hSX -- ControllersrhgjhubehhhiubU api/indexrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rhbX API Referencerr}r(hSX API ReferencerhgjubahhhiubUapi/circuits_netrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSX circuits.netrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbX circuits.netrr}r(hSUhgjubahhhubhbX -- Networkingrr}r(hSX -- NetworkingrhgjubehhhiubUapi/circuits_web_exceptionsrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.web.exceptionsrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.web.exceptionsrr}r(hSUhgjubahhhubhbX -- Exceptionsrr}r(hSX -- ExceptionsrhgjubehhhiubUman/componentsrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rhbX Componentsrr}r(hSX ComponentsrhgjubahhhiubUusersrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rhbXUsersrr}r(hSXUsersrhgjubahhhiubUapi/circuits_webrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSX circuits.webrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbX circuits.webrr}r(hSUhgjubahhhubhbX -- Web Frameworkrr}r(hSX -- Web FrameworkrhgjubehhhiubUapi/circuits_web_constantsrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]r(ht)r}r(hSXcircuits.web.constantsr hT}r (hV]r hX]r hZ]r h\]rh^]ruhgjh`]rhbXcircuits.web.constantsrr}r(hSUhgjubahhhubhbX -- Global Constantsrr}r(hSX -- Global ConstantsrhgjubehhhiubUapi/circuits_app_configrhP)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]r uh`]r!(ht)r"}r#(hSXcircuits.app.configr$hT}r%(hV]r&hX]r'hZ]r(h\]r)h^]r*uhgjh`]r+hbXcircuits.app.configr,r-}r.(hSUhgj"ubahhhubhbX -- Application Configr/r0}r1(hSX -- Application Configr2hgjubehhhiubUapi/circuits_web_toolsr3hP)r4}r5(hSUhT}r6(hV]r7hX]r8hZ]r9h\]r:h^]r;uh`]r<(ht)r=}r>(hSXcircuits.web.toolsr?hT}r@(hV]rAhX]rBhZ]rCh\]rDh^]rEuhgj4h`]rFhbXcircuits.web.toolsrGrH}rI(hSUhgj=ubahhhubhbX -- ToolsrJrK}rL(hSX -- ToolsrMhgj4ubehhhiubUapi/circuits_io_serialrNhP)rO}rP(hSUhT}rQ(hV]rRhX]rShZ]rTh\]rUh^]rVuh`]rW(ht)rX}rY(hSXcircuits.io.serialrZhT}r[(hV]r\hX]r]hZ]r^h\]r_h^]r`uhgjOh`]rahbXcircuits.io.serialrbrc}rd(hSUhgjXubahhhubhbX -- Serial I/Orerf}rg(hSX -- Serial I/OrhhgjOubehhhiubuU domaindatari}rj(Ustdrk}rl(Ulabelsrm}rn(UgenindexrojoUcsphinx.locale _TranslationProxy rpcsphinx.locale mygettext rqUIndexrrrsjqjrrtbruUmodindexrvU py-modindexUjpjqU Module IndexrwrxjqjwrybrzUsearchr{j{UjpjqU Search Pager|r}jqj|r~brXcircuits_web_eventsrjUcircuits-web-eventsrXcircuits.web.events -- EventsrXcircuits_web_httprj~Ucircuits-web-httprX"circuits.web.http -- HTTP ProtocolrXweb_getting_startedrhUweb-getting-startedrXGetting StartedrXchangesrjUchangesrX ChangeLogruU anonlabelsr}r(jojoUrjvU py-modindexUrj{UsearchUrjjjrjj~jrjhjrjjjruUversionrKU progoptionsr}rUobjectsr}rUtermrXvcsrjUterm-vcsrrsuUc}r(j}rjKuUpyr}r(j}r(Xcircuits.io.events.EOFrjXclassrX%circuits.net.sockets.UNIXClient.readyrjXXmethodrXcircuits.net.sockets.TCPClientrjXXclassrX"circuits.core.components.ComponentrjXclassrXcircuits.net.protocols.line.LPrjXclassrX!circuits.core.manager.Manager.pidrj/X attributerX!circuits.net.sockets.Server.writerjXXmethodrXcircuits.core.utils.findtyperjXfunctionrX circuits.net.sockets.Server.hostrjXX attributerXcircuits.web.exceptionsrjUmodulerrX%circuits.core.manager.Manager.runningrj/X attributerX circuits.net.protocols.http.HTTPrjGXclassrXcircuits.core.utils.findrootrjXfunctionrX+circuits.web.exceptions.InternalServerErrorrjX exceptionrXcircuits.core.events.EventrjsXclassrXcircuits.app.daemon.DaemonrjXclassrX)circuits.core.manager.Manager.flushEventsrj/XmethodrX!circuits.web.headers.Headers.keysrjXmethodrXcircuits.net.protocols.irc.RAWrhXclassrXcircuits.node.utils.load_valuerjUXfunctionrXcircuits.net.protocolsrj8jrX$circuits.net.sockets.UDPServer.writerjXXmethodrX'circuits.core.manager.Manager.callEventrj/XmethodrXcircuits.web.sessionsrjjrXcircuits.core.loader.LoaderrjcXclassrX&circuits.core.components.BaseComponentrjXclassrXcircuits.node.client.Clientrj XclassrXcircuits.io.notify.DeletedrjXclassrXcircuits.web.mainrjbjrX!circuits.core.events.UnregisteredrjsXclassrXcircuits.io.notify.AccessedrjXclassrX(circuits.web.exceptions.MethodNotAllowedrjX exceptionrXcircuits.core.events.StartedrjsXclassrX!circuits.net.sockets.Client.closerjXXmethodrX4circuits.core.events.GenerateEvents.reduce_time_leftrjsXmethodrXcircuits.toolsrjjrX&circuits.web.exceptions.RequestTimeoutrjX exceptionrXcircuits.web.http.HTTP._on_readrj~XmethodrX#circuits.web.dispatchers.dispatcherrjjrXcircuits.net.socketsrjXjrXcircuits.io.events.WriterjXclassrX circuits.core.pollers.BasePollerrjXclassrXcircuits.core.pollersrjjrXcircuits.core.loaderrjcjrXcircuits.node.node.NoderjXclassrXcircuits.core.values.ValuerjXclassrX!circuits.web.tools.validate_sincer j3Xfunctionr X(circuits.web.headers.HeaderElement.parser jX staticmethodr Xcircuits.web.loggersr hjjr Xcircuits.node.events.Packetr jfXclassr X&circuits.web.exceptions.NotImplementedr jX exceptionr Xcircuits.web.constantsr jjr X(circuits.web.dispatchers.jsonrpc.JSONRPCr jXclassr X$circuits.net.sockets.UDPServer.closer jXXmethodr Xcircuits.net.sockets.Clientr jXXclassr Xcircuits.net.protocols.ircr hjr Xcircuits.net.sockets.UDPServerr jXXclassr X circuits.ior hjr Xcircuits.core.events.Errorr jsXclassr Xcircuits.node.server.Serverr jXclassr Xcircuits.web.events.Responser jXclassr Xcircuits.app.config.Loadr jXclassr X&circuits.web.dispatchers.static.Staticr j}Xclassr! Xcircuits.web.clientr" jjr# X"circuits.core.manager.Manager.stopr$ j/Xmethodr% Xcircuits.io.notify.Unmountedr& jXclassr' Xcircuits.core.handlersr( jHjr) Xcircuits.net.sockets.TCPServerr* jXXclassr+ X,circuits.net.sockets.TCPServer.socket_familyr, jXX attributer- X$circuits.web.client.Client.connectedr. jX attributer/ Xcircuits.core.debuggerr0 jjr1 X"circuits.web.client.Client.requestr2 jXmethodr3 X'circuits.core.manager.Manager.fireEventr4 j/Xmethodr5 X$circuits.web.exceptions.Unauthorizedr6 jX exceptionr7 Xcircuits.app.env.Creater8 j1Xclassr9 Xcircuits.io.notify.Closedr: jXclassr; X circuits.core.timers.Timer.resetr< jXmethodr= X$circuits.web.wrappers.file_generatorr> jXfunctionr? X#circuits.net.sockets.Client.channelr@ jXX attributerA Xcircuits.app.configrB jjrC X circuits.web.errors.UnauthorizedrD j,XclassrE Xcircuits.web.controllers.exposerF jgXfunctionrG Xcircuits.web.loggers.formattimerH hjXfunctionrI Xcircuits.node.utils.dump_valuerJ jUXfunctionrK X'circuits.web.controllers.JSONControllerrL jgXclassrM Xcircuits.web.wrappers.HostrN jXclassrO Xcircuits.node.noderP jjrQ Xcircuits.core.componentsrR jjrS Xcircuits.core.events.SuccessrT jsXclassrU Xcircuits.core.utils.safeimportrV jXfunctionrW X circuits.web.dispatchers.jsonrpcrX jjrY X*circuits.web.exceptions.ServiceUnavailablerZ jX exceptionr[ Xcircuits.core.timersr\ jjr] X!circuits.core.manager.Manager.runr^ j/Xmethodr_ Xcircuits.web.controllersr` jgjra X circuits.web.client.Client.closerb jXmethodrc Xcircuits.web.tools.serve_filerd j3Xfunctionre X'circuits.web.headers.Headers.add_headerrf jXmethodrg Xcircuits.web.dispatchers.staticrh j}jri Xcircuits.web.wrappers.Requestrj jXclassrk X$circuits.web.headers.header_elementsrl jXfunctionrm Xcircuits.node.utils.load_eventrn jUXfunctionro X0circuits.net.sockets.Server.parse_bind_parameterrp jXXmethodrq X#circuits.web.client.Client.responserr jX attributers X!circuits.web.tools.validate_etagsrt j3Xfunctionru Xcircuits.app.envrv j1jrw X5circuits.core.components.PrepareUnregister.in_subtreerx jXmethodry X/circuits.core.components.BaseComponent.handlersrz jX classmethodr{ Xcircuits.io.events.Seekr| jXclassr} Xcircuits.web.tools.gzipr~ j3Xfunctionr X circuits.netr jjr X circuits.web.exceptions.Redirectr jX exceptionr Xcircuits.io.filer jLjr Xcircuits.core.workers.Taskr jXclassr Xcircuits.web.headers.Headersr jXclassr Xcircuits.io.notify.Notifyr jXclassr X/circuits.core.components.BaseComponent.registerr jXmethodr Xcircuits.web.utils.parse_qsr j:Xfunctionr r X!circuits.web.tools.serve_downloadr j3Xfunctionr X%circuits.web.exceptions.HTTPExceptionr jX exceptionr X"circuits.core.manager.Manager.callr j/Xmethodr Xcircuits.core.timers.Timerr jXclassr Xcircuits.net.protocols.httpr jGjr Xcircuits.web.events.WebEventr jXclassr X'circuits.net.sockets.UNIXClient.connectr jXXmethodr Xcircuits.web.wrappers.Bodyr jXclassr X$circuits.web.headers.Headers.get_allr jXmethodr Xcircuits.web.wsgi.Gatewayr jXclassr Xcircuits.core.pollers.Pollr jXclassr Xcircuits.web.utils.compressr j:Xfunctionr r Xcircuits.core.utilsr jjr Xcircuits.net.sockets.Closer jXXclassr Xcircuits.core.events.Signalr jsXclassr X-circuits.core.events.GenerateEvents.time_leftr jsX attributer X,circuits.web.exceptions.UnsupportedMediaTyper jX exceptionr Xcircuits.core.utils.findcmpr jXfunctionr X#circuits.core.manager.Manager.startr j/Xmethodr Xcircuits.io.serial.Serialr jNXclassr X circuits.net.sockets.Server.portr jXX attributer Xcircuits.web.wsgir jjr X.circuits.web.websocket.WebSocketClient.channelr jX attributer Xcircuits.web.utils.get_rangesr j:Xfunctionr r X$circuits.web.exceptions.UnicodeErrorr jX exceptionr Xcircuits.app.config.Configr jXclassr X circuits.webr jjr X)circuits.web.headers.AcceptElement.qvaluer jX attributer Xcircuits.web.servers.Serverr jXclassr X circuits.web.exceptions.NotFoundr jX exceptionr Xcircuits.core.workersr jjr X+circuits.web.headers.HeaderElement.from_strr jX classmethodr X%circuits.net.sockets.Server.connectedr jXX attributer Xcircuits.net.sockets.Writer jXXclassr X#circuits.web.http.HTTP._on_responser j~Xmethodr Xcircuits.app.log.Logr hXclassr X.circuits.core.components.BaseComponent.handlesr jX classmethodr Xcircuits.core.utils.flattenr jXfunctionr Xcircuits.web.errors.NotFoundr j,Xclassr X&circuits.web.websocket.WebSocketClientr jXclassr X.circuits.web.dispatchers.dispatcher.Dispatcherr jXclassr Xcircuits.core.valuesr jjr X$circuits.web.headers.Headers.has_keyr jXmethodr X-circuits.web.exceptions.RequestEntityTooLarger jX exceptionr X(circuits.net.sockets.UDPServer.broadcastr jXXmethodr X2circuits.web.dispatchers.virtualhosts.VirtualHostsr hXclassr X&circuits.web.exceptions.LengthRequiredr jX exceptionr X#circuits.web.headers.Headers.valuesr jXmethodr Xcircuits.node.clientr j jr Xcircuits.core.pollers.EPollr jXclassr Xcircuits.web.loggers.Loggerr hjXclassr Xcircuits.web.websocketr jjr Xcircuits.web.utils.parse_bodyr j:Xfunctionr r X"circuits.web.headers.HeaderElementr jXclassr Xcircuits.app.env.Environmentr j1Xclassr X#circuits.net.protocols.http.Requestr jGXclassr Xcircuits.io.serialr jNjr X*circuits.web.exceptions.RequestURITooLarger jX exceptionr X%circuits.web.dispatchers.virtualhostsr hjr X.circuits.web.dispatchers.websockets.WebSocketsr j=Xclassr X&circuits.web.dispatchers.xmlrpc.XMLRPCr j"Xclassr Xcircuits.app.env.Loadr j1Xclassr Xcircuits.core.workers.Workerr jXclassr Xcircuits.web.toolsr j3jr X3circuits.net.sockets.TCPServer.parse_bind_parameterr jXXmethodr Xcircuits.io.events.Readr jXclassr X#circuits.net.sockets.Server.channelr jXX attributer Xcircuits.net.sockets.UNIXServerr jXXclassr Xcircuits.node.utilsr jUjr X$circuits.web.dispatchers.jsonrpc.RPCr jXclassr Xcircuits.net.protocols.irc.IRCr hXclassr! Xcircuits.core.managerr" j/jr# Xcircuits.io.file.Filer$ jLXclassr% X,circuits.net.sockets.TCPClient.socket_familyr& jXX attributer' X*circuits.web.http.HTTP._on_request_successr( j~Xmethodr) X!circuits.web.exceptions.Forbiddenr* jX exceptionr+ Xcircuits.app.daemon.Daemonizer, jXclassr- X"circuits.core.manager.Manager.firer. j/Xmethodr/ Xcircuits.net.sockets.Disconnectr0 jXXclassr1 Xcircuits.io.notify.Createdr2 jXclassr3 X"circuits.web.exceptions.BadGatewayr4 jX exceptionr5 X$circuits.web.wrappers.Request.serverr6 jX attributer7 Xcircuits.web.exceptions.Goner8 jX exceptionr9 X'circuits.core.handlers.HandlerMetaClassr: jHXclassr; X"circuits.web.events.Request.creater< jX classmethodr= Xcircuits.net.sockets.Closedr> jXXclassr? Xcircuits.app.daemon.WritePIDr@ jXclassrA X'circuits.web.headers.Headers.setdefaultrB jXmethodrC Xcircuits.core.events.RegisteredrD jsXclassrE X circuits.web.client.Client.writerF jXmethodrG Xcircuits.web.tools.digest_authrH j3XfunctionrI X circuits.corerJ jjrK X circuits.noderL j~jrM Xcircuits.web.wsgi.ApplicationrN jXclassrO Xcircuits.io.events.CloserP jXclassrQ Xcircuits.web.wrappersrR jjrS Xcircuits.core.events.FailurerT jsXclassrU X0circuits.net.sockets.Client.parse_bind_parameterrV jXXmethodrW Xcircuits.core.events.StoppedrX jsXclassrY Xcircuits.web.tools.basic_authrZ j3Xfunctionr[ Xcircuits.web.errors.Forbiddenr\ j,Xclassr] Xcircuits.web.client.Requestr^ jXclassr_ X%circuits.net.sockets.Client.connectedr` jXX attributera Xcircuits.web.servers.BaseServerrb jXclassrc X0circuits.web.websocket.WebSocketClient.connectedrd jX attributere Xcircuits.web.client.Clientrf jXclassrg Xcircuits.net.sockets.UDPClientrh jXX attributeri Xcircuits.web.httprj j~jrk Xcircuits.web.headersrl jjrm X1circuits.core.components.BaseComponent.unregisterrn jXmethodro Xcircuits.core.eventsrp jsjrq Xcircuits.net.sockets.Connectedrr jXXclassrs X!circuits.net.sockets.Disconnectedrt jXXclassru X*circuits.core.components.PrepareUnregisterrv jXclassrw X,circuits.net.sockets.UDPServer.socket_familyrx jXX attributery Xcircuits.web.errors.HTTPErrorrz j,Xclassr{ Xcircuits.app.daemonr| jjr} X*circuits.web.exceptions.PreconditionFailedr~ jX exceptionr X"circuits.core.manager.Manager.tickr j/Xmethodr Xcircuits.web.dispatchers.xmlrpcr j"jr Xcircuits.web.errorsr j,jr X!circuits.net.sockets.Server.closer jXXmethodr Xcircuits.node.utils.dump_eventr jUXfunctionr Xcircuits.tools.graphr jXfunctionr X circuits.web.headers.Headers.getr jXmethodr X#circuits.core.events.GenerateEventsr jsXclassr X"circuits.web.headers.AcceptElementr jXclassr Xcircuits.web.sessions.Sessionsr jXclassr X#circuits.web.dispatchers.xmlrpc.RPCr j"Xclassr Xcircuits.app.logr hjr Xcircuits.web.utils.urlr j:Xfunctionr r Xcircuits.web.wrappers.Responser jXclassr Xcircuits.core.handlers.handlerr jHXfunctionr Xcircuits.node.serverr jjr Xcircuits.web.serversr jjr Xcircuits.node.eventsr jfjr X#circuits.web.controllers.exposeJSONr jgXfunctionr Xcircuits.io.events.Closedr jXclassr Xcircuits.core.pollers.Selectr jXclassr Xcircuits.web.http.HTTPr j~Xclassr Xcircuits.web.events.Requestr jXclassr X"circuits.web.headers.Headers.itemsr jXmethodr Xcircuits.net.sockets.Readr jXXclassr Xcircuits.net.sockets.Connectr jXXclassr Xcircuits.web.tools.expiresr j3Xfunctionr X%circuits.web.exceptions.NotAcceptabler jX exceptionr Xcircuits.web.tools.check_authr j3Xfunctionr X"circuits.core.manager.Manager.namer j/X attributer Xcircuits.web.eventsr jjr X$circuits.net.protocols.http.Responser jGXclassr Xcircuits.io.notify.Movedr jXclassr Xcircuits.io.notify.Openedr jXclassr Xcircuits.web.errors.Redirectr j,Xclassr X"circuits.web.client.Client.channelr jX attributer X circuits.net.sockets.SocketErrorr jXXclassr X!circuits.net.sockets.Client.writer jXXmethodr Xcircuits.io.eventsr jjr X$circuits.web.http.HTTP._on_httperrorr j~Xmethodr Xcircuits.net.sockets.Piper jXXfunctionr X&circuits.net.sockets.TCPClient.connectr jXXmethodr Xcircuits.web.utils.dictformr j:Xfunctionr r X#circuits.net.protocols.irc.IRC.liner hXmethodr Xcircuits.web.events.Streamr jXclassr Xcircuits.node.events.Remoter jfXclassr X circuits.appr j-jr X#circuits.web.controllers.Controllerr jgXclassr Xcircuits.app.config.Saver jXclassr X,circuits.web.websocket.WebSocketClient.closer jXmethodr X"circuits.web.exceptions.BadRequestr jX exceptionr X circuits.net.protocols.line.Liner jXclassr Xcircuits.web.utilsr j:jr Xcircuits.net.sockets.Serverr jXXclassr Xcircuits.core.debugger.Debuggerr jXclassr X%circuits.web.headers.Headers.elementsr jXmethodr X#circuits.web.dispatchers.websocketsr j=jr X"circuits.web.headers.parse_headersr jXfunctionr Xcircuits.io.events.Errorr jXclassr Xcircuits.net.sockets.UNIXClientr jXXclassr Xcircuits.io.notifyr jjr Xcircuits.core.manager.Managerr j/Xclassr Xcircuits.io.events.Openedr jXclassr Xcircuits.app.log.Loggerr hXclassr Xcircuits.core.utils.findchannelr jXfunctionr Xcircuits.core.events.Unregisterr jsXclassr X"circuits.core.handlers.reprhandlerr jHXfunctionr Xcircuits.io.notify.Modifiedr jXclassr X"circuits.web.client.Client.connectr jXmethodr X#circuits.core.manager.Manager.flushr j/Xmethodr Xcircuits.net.protocols.liner jjr X'circuits.core.components.SingletonErrorr jXclassr uUmodulesr }r (j0 (jUUtr jl (jUUtr j (jUUtr j(jUUtr jB (jUUtr j (j"UUtr j (j,UUtr j (jUUtr j (j UUtr j (hUUtr jP (jUUtr jR (jUUtr j(j8UUtr j (jUUtr! j (jUUtr" j (jfUUtr# j (hUUtr$ j(jXUUtr% j (jUUtr& j` (jgUUtr' j (j3UUtr( jh (j}UUtr) jp (jsUUtr* j (jUUUtr+ j (jNUUtr, j (jUUtr- jv (j1UUtr. j" (j/UUtr/ j (jUUtr0 j (jUUtr1 j| (jUUtr2 j (jUUtr3 j (jLUUtr4 j(jUUtr5 j (jUUtr6 j(jUUtr7 j (j-UUtr8 j\ (jUUtr9 j (jGUUtr: j (jUUtr; j(jcUUtr< jR (jUUtr= jL (j~UUtr> j(jUUtr? j (hjUUtr@ jJ (jUUtrA j (j:UUtrB j(jbUUtrC j (j=UUtrD j (hUUtrE j (jUUtrF j (hUUtrG jX (jUUtrH j" (jUUtrI j (jUUtrJ j( (jHUUtrK jj (j~UUtrL j (jUUtrM j(jUUtrN ujKuUjsrO }rP (j}rQ jKuUcpprR }rS (j}rT jKuUrstrU }rV (j}rW jKuuU glob_toctreesrX h]rY (jhj-jjj~j8eRrZ Uimagesr[ h)r\ Xweb/../images/web.pngr] h]r^ haRr_ Xweb.pngr` ra sh]rb j` aRrc bU doctreedirrd Udocs/build/doctreesre Uversioning_conditionrf U citationsrg }rh jK)Utodo_all_todosri ]rj (}rk (Udocnamerl j!Usourcerm cdocutils.nodes reprunicode rn X:/home/prologic/work/circuits/docs/source/man/debugging.rstro rp }rq bUtodorr csphinx.ext.todo todo_node rs )rt }ru (hSXWrite about this ...rv hT}rw (hV]rx hX]ry Uadmonition-todorz ahZ]r{ h\]r| Uindex-0r} ah^]r~ uh`]r (hP)r }r (hSXTodor hT}r (hV]r hX]r hZ]r h\]r h^]r uhgjt h`]r hbXTodor r }r (hSj hgj ubahhhiubcdocutils.nodes paragraph r )r }r (hSjv hT}r (hV]r hX]r hZ]r h\]r h^]r uhgjt h`]r hbXWrite about this ...r r }r (hSjv hgj ubahhU paragraphr ubehhU todo_noder ubUlinenor KUtargetr cdocutils.nodes target r )r }r (hSUhgcdocutils.nodes section r )r }r (hSUhgcdocutils.nodes document r )r }r (U nametypesr }r X debuggingr NsUsubstitution_defsr }r Uparse_messagesr ]r Ucurrent_sourcer NU decorationr NUautofootnote_startr KUnameidsr }r j U debuggingr sh`]r j ahSUU transformerr NU footnote_refsr }r Urefnamesr }r Usymbol_footnotesr ]r Uautofootnote_refsr ]r Usymbol_footnote_refsr ]r U citationsr ]r Udocumentr j U current_liner NUtransform_messagesr ]r cdocutils.nodes system_message r )r }r (hSUhT}r (hV]r Ulevelr Kh\]r hZ]r Usourcer jp hX]r h^]r Utyper UINFOr uh`]r j )r }r (hSUhT}r (hV]r hX]r hZ]r h\]r h^]r uhgj h`]r hbX-Hyperlink target "index-0" is not referenced.r r }r (hSUhgj ubahhj ubahhUsystem_messager ubaUreporterr NUid_startr KU autofootnotesr ]r U citation_refsr }r Uindirect_targetsr ]r Usettingsr (cdocutils.frontend Values r or }r (Ufootnote_backlinksr KUrecord_dependenciesr NU rfc_base_urlr Uhttp://tools.ietf.org/html/r U tracebackr Upep_referencesr NUstrip_commentsr NU toc_backlinksr Uentryr U language_coder Uenr U datestampr NU report_levelr KU _destinationr NU halt_levelr KU strip_classesr NhiNUerror_encoding_error_handlerr Ubackslashreplacer Udebugr NUembed_stylesheetr Uoutput_encoding_error_handlerr Ustrictr U sectnum_xformr KUdump_transformsr NU docinfo_xformr KUwarning_streamr NUpep_file_url_templater Upep-%04dr Uexit_status_levelr KUconfigr NUstrict_visitorr NUcloak_email_addressesr Utrim_footnote_reference_spacer Uenvr NUdump_pseudo_xmlr NUexpose_internalsr NUsectsubtitle_xformr U source_linkr NUrfc_referencesr NUoutput_encodingr Uutf-8r U source_urlr NUinput_encodingr U utf-8-sigr U_disable_configr NU id_prefixr UU tab_widthr KUerror_encodingr U ISO-8859-1r U_sourcer U:/home/prologic/work/circuits/docs/source/man/debugging.rstr Ugettext_compactr U generatorr! NUdump_internalsr" NU smart_quotesr# U pep_base_urlr$ Uhttp://www.python.org/dev/peps/r% Usyntax_highlightr& Ulongr' Uinput_encoding_error_handlerr( j Uauto_id_prefixr) Uidr* Udoctitle_xformr+ Ustrip_elements_with_classesr, NU _config_filesr- ]r. Ufile_insertion_enabledr/ KU raw_enabledr0 KU dump_settingsr1 NubUsymbol_footnote_startr2 KUidsr3 }r4 (j j j} js )r5 }r6 (hSjv hgj jm jp Uexpect_referenced_by_namer7 }r8 hhj hT}r9 (hV]r: hX]r; jz ahZ]r< h\]r= j} ah^]r> uUliner? Kj j Uexpect_referenced_by_idr@ }rA j} j sh`]rB (hP)rC }rD (hSj hT}rE (hV]rF hX]rG hZ]rH h\]rI h^]rJ uhgj5 h`]rK hbXTodorL rM }rN (hSj hgjC ubahhhiubj )rO }rP (hSjv hgj5 jm jp hhj hT}rQ (hV]rR hX]rS hZ]rT h\]rU h^]rV uj? Kh`]rW hbXWrite about this ...rX rY }rZ (hSjv hgjO ubaubeubuUsubstitution_namesr[ }r\ hhj hT}r] (hV]r^ h\]r_ hZ]r` Usourcera jp hX]rb h^]rc uU footnotesrd ]re Urefidsrf }rg j} ]rh j asubjm jp hhUsectionri hT}rj (hV]rk hX]rl hZ]rm h\]rn j ah^]ro j auj? Kj j h`]rp (hP)rq }rr (hSj.hgj jm jp hhhihT}rs (hV]rt hX]ru hZ]rv h\]rw h^]rx uj? Kj j h`]ry hbX Debuggingrz r{ }r| (hSj.hgjq ubaubj j5 eubjm jp hhj hT}r} (h\]r~ hZ]r hV]r hX]r h^]r Urefidr j} uj? Nj j h`]r ubu}r (jl jJjm jn X8/home/prologic/work/circuits/docs/source/man/manager.rstr r }r bjr js )r }r (hSXWrite about this...r hT}r (hV]r hX]r Uadmonition-todor ahZ]r h\]r Uindex-0r ah^]r uh`]r (hP)r }r (hSXTodor hT}r (hV]r hX]r hZ]r h\]r h^]r uhgj h`]r hbXTodor r }r (hSj hgj ubahhhiubj )r }r (hSj hT}r (hV]r hX]r hZ]r h\]r h^]r uhgj h`]r hbXWrite about this...r r }r (hSj hgj ubahhj ubehhj ubj Kj j )r }r (hSUhgj )r }r (hSUhgj )r }r (j }r Xmanagerr Nsj }r j ]r j Nj Nj Kj }r j Umanagerr sh`]r j ahSUj Nj }r j }r j ]r j ]r j ]r j ]r j j j Nj ]r j )r }r (hSUhT}r (hV]r Ulevelr Kh\]r hZ]r Usourcer j hX]r h^]r Utyper j uh`]r j )r }r (hSUhT}r (hV]r hX]r hZ]r h\]r h^]r uhgj h`]r hbX-Hyperlink target "index-0" is not referenced.r r }r (hSUhgj ubahhj ubahhj ubaj Nj Kj ]r j }r j ]r j (j or }r (j Kj Nj j j j Nj Nj j j j j Nj Kj Nj Kj NhiNj j j Nj j j j Kj Nj Kj Nj j j Kj Nj Nj j j Nj Nj Nj j Nj Nj j j Nj j j Nj Uj Kj j j U8/home/prologic/work/circuits/docs/source/man/manager.rstr j j! Nj" Nj# j$ j% j& j' j( j j) j* j+ j, Nj- ]r j/ Kj0 Kj1 Nubj2 Kj3 }r (j j j js )r }r (hSj hgj jm j j7 }r hhj hT}r (hV]r hX]r j ahZ]r h\]r j ah^]r uj? Kj j j@ }r j j sh`]r (hP)r }r (hSj hT}r (hV]r hX]r hZ]r h\]r h^]r uhgj h`]r hbXTodor r }r (hSj hgj ubahhhiubj )r }r (hSj hgj jm j hhj hT}r (hV]r hX]r hZ]r h\]r h^]r uj? Kh`]r hbXWrite about this...r r }r (hSj hgj ubaubeubuj[ }r hhj hT}r (hV]r h\]r hZ]r Usourcer j hX]r h^]r ujd ]r jf }r j ]r j asubjm j hhji hT}r (hV]r hX]r hZ]r h\]r j ah^]r j auj? Kj j h`]r (hP)r }r (hSjWhgj jm j hhhihT}r (hV]r hX]r hZ]r h\]r h^]r uj? Kj j h`]r hbXManagerr r! }r" (hSjWhgj ubaubj j eubjm j hhj hT}r# (h\]r$ hZ]r% hV]r& hX]r' h^]r( j j uj? Nj j h`]r) ubu}r* (jl j*jm jn X6/home/prologic/work/circuits/docs/source/man/tools.rstr+ r, }r- bjr js )r. }r/ (hSXWrite about this ...r0 hT}r1 (hV]r2 hX]r3 Uadmonition-todor4 ahZ]r5 h\]r6 Uindex-0r7 ah^]r8 uh`]r9 (hP)r: }r; (hSXTodor< hT}r= (hV]r> hX]r? hZ]r@ h\]rA h^]rB uhgj. h`]rC hbXTodorD rE }rF (hSj< hgj: ubahhhiubj )rG }rH (hSj0 hT}rI (hV]rJ hX]rK hZ]rL h\]rM h^]rN uhgj. h`]rO hbXWrite about this ...rP rQ }rR (hSj0 hgjG ubahhj ubehhj ubj Kj j )rS }rT (hSUhgj )rU }rV (hSUhgj )rW }rX (j }rY XtoolsrZ Nsj }r[ j ]r\ j Nj Nj Kj }r] jZ Utoolsr^ sh`]r_ jU ahSUj Nj }r` j }ra j ]rb j ]rc j ]rd j ]re j jW j Nj ]rf j )rg }rh (hSUhT}ri (hV]rj Ulevelrk Kh\]rl hZ]rm Usourcern j, hX]ro h^]rp Utyperq j uh`]rr j )rs }rt (hSUhT}ru (hV]rv hX]rw hZ]rx h\]ry h^]rz uhgjg h`]r{ hbX-Hyperlink target "index-0" is not referenced.r| r} }r~ (hSUhgjs ubahhj ubahhj ubaj Nj Kj ]r j }r j ]r j (j or }r (j Kj Nj j j j Nj Nj j j j j Nj Kj Nj Kj NhiNj j j Nj j j j Kj Nj Kj Nj j j Kj Nj Nj j j Nj Nj Nj j Nj Nj j j Nj j j Nj Uj Kj j j U6/home/prologic/work/circuits/docs/source/man/tools.rstr j j! Nj" Nj# j$ j% j& j' j( j j) j* j+ j, Nj- ]r j/ Kj0 Kj1 Nubj2 Kj3 }r (j7 js )r }r (hSj0 hgjU jm j, j7 }r hhj hT}r (hV]r hX]r j4 ahZ]r h\]r j7 ah^]r uj? Kj jW j@ }r j7 jS sh`]r (hP)r }r (hSj< hT}r (hV]r hX]r hZ]r h\]r h^]r uhgj h`]r hbXTodor r }r (hSj< hgj ubahhhiubj )r }r (hSj0 hgj jm j, hhj hT}r (hV]r hX]r hZ]r h\]r h^]r uj? Kh`]r hbXWrite about this ...r r }r (hSj0 hgj ubaubeubj^ jU uj[ }r hhj hT}r (hV]r h\]r hZ]r Usourcer j, hX]r h^]r ujd ]r jf }r j7 ]r jS asubjm j, hhji hT}r (hV]r hX]r hZ]r h\]r j^ ah^]r jZ auj? Kj jW h`]r (hP)r }r (hSj7hgjU jm j, hhhihT}r (hV]r hX]r hZ]r h\]r h^]r uj? Kj jW h`]r hbXToolsr r }r (hSj7hgj ubaubjS j eubjm j, hhj hT}r (h\]r hZ]r hV]r hX]r h^]r j j7 uj? Nj jW h`]r ubu}r (jl hjm jn X7/home/prologic/work/circuits/docs/source/man/values.rstr r }r bjr js )r }r (hSXWrite about this...r hT}r (hV]r hX]r Uadmonition-todor ahZ]r h\]r Uindex-0r ah^]r uh`]r (hP)r }r (hSXTodor hT}r (hV]r hX]r hZ]r h\]r h^]r uhgj h`]r hbXTodor r }r (hSj hgj ubahhhiubj )r }r (hSj hT}r (hV]r hX]r hZ]r h\]r h^]r uhgj h`]r hbXWrite about this...r r }r (hSj hgj ubahhj ubehhj ubj Kj j )r }r (hSUhgj )r }r (hSUhgj )r }r (j }r Xvaluesr Nsj }rj ]rj Nj Nj Kj }rj Uvaluesrsh`]rj ahSUj Nj }rj }rj ]rj ]rj ]r j ]r j j j Nj ]r j )r }r (hSUhT}r(hV]rUlevelrKh\]rhZ]rUsourcerj hX]rh^]rUtyperj uh`]rj )r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgj h`]r hbX-Hyperlink target "index-0" is not referenced.r!r"}r#(hSUhgjubahhj ubahhj ubaj Nj Kj ]r$j }r%j ]r&j (j or'}r((j Kj Nj j j j Nj Nj j j j j Nj Kj Nj Kj NhiNj j j Nj j j j Kj Nj Kj Nj j j Kj Nj Nj j j Nj Nj Nj j Nj Nj j j Nj j j Nj Uj Kj j j U7/home/prologic/work/circuits/docs/source/man/values.rstr)j j! Nj" Nj# j$ j% j& j' j( j j) j* j+ j, Nj- ]r*j/ Kj0 Kj1 Nubj2 Kj3 }r+(j js )r,}r-(hSj hgj jm j j7 }r.hhj hT}r/(hV]r0hX]r1j ahZ]r2h\]r3j ah^]r4uj? Kj j j@ }r5j j sh`]r6(hP)r7}r8(hSj hT}r9(hV]r:hX]r;hZ]r<h\]r=h^]r>uhgj,h`]r?hbXTodor@rA}rB(hSj hgj7ubahhhiubj )rC}rD(hSj hgj,jm j hhj hT}rE(hV]rFhX]rGhZ]rHh\]rIh^]rJuj? Kh`]rKhbXWrite about this...rLrM}rN(hSj hgjCubaubeubjj uj[ }rOhhj hT}rP(hV]rQh\]rRhZ]rSUsourcerTj hX]rUh^]rVujd ]rWjf }rXj ]rYj asubjm j hhji hT}rZ(hV]r[hX]r\hZ]r]h\]r^jah^]r_j auj? Kj j h`]r`(hP)ra}rb(hShhgj jm j hhhihT}rc(hV]rdhX]rehZ]rfh\]rgh^]rhuj? Kj j h`]rihbXValuesrjrk}rl(hShhgjaubaubj j,eubjm j hhj hT}rm(h\]rnhZ]rohV]rphX]rqh^]rrj j uj? Nj j h`]rsubueUsrcdirrtU(/home/prologic/work/circuits/docs/sourceruUconfigrvcsphinx.config Config rw)rx}ry(Upygments_stylerzUtracr{Uhtmlhelp_basenamer|U circuitsdocr}U html_themer~UomrUautodoc_member_orderrUbysourcerU exclude_treesr]rU master_docrUindexrU source_suffixrU.rstrU copyrightrX2004-2012, James MillsrUgoogleanalytics_idrU UA-38618352-3rUversionrjUautoclass_contentrUbothrU today_fmtrU %B %d, %YrUtemplates_pathr]rU _templatesraUautodoc_default_flagsr]rUshow-inheritanceraUlatex_documentsr]r(UindexU circuits.texXcircuits DocumentationX James MillsUmanualrtraUdevelrUhtml_static_pathr]rU_staticraUhtml_theme_pathr]rU_themesraUtodo_include_todosrUbitbucket_project_urlrU'https://bitbucket.org/prologic/circuitsrU overridesr}rUprojectrXcircuitsrU html_logorU_static/logo.pngrU extensionsr]r(Usphinx.ext.autodocrUsphinx.ext.autosummaryrUsphinx.ext.graphvizrUsphinx.ext.ifconfigrUsphinx.ext.todorUsphinxcontrib.bitbucketrUsphinxcontrib.googleanalyticsreUreleaserjubUmetadatar}r(hO}rhj}rh}rh}rh}rh}rh}rh}rj}rj*}rj8}rjS}rja}rjo}rj}}rj}rj}rj}rj}rj}rj}rj-}rjH}rjc}rj~}rj}rj}rj}rj}rj}rj}rj!}rj/}rjJ}rjX}rjf}rj}rj}rj}rj}rj}rj}rh}rj}rj,}rjG}rjb}rh }rj}rj}rj}rj}rj}rXtocdepthrX2sj}rj}rj:}rjU}rjp}rj~}rj}rj}rj}rj}rj}rj}rj}rj"}rj=}rjX}rjs}rj}rj}rj}rj}rh&}rj}rj}rj }rh }rj1}rjL}rjg}r j}r j}r j}r j}r j}rj}rj}rj}rj3}rjN}ruUversionchangesr}rUtoc_num_entriesr}r(hOKhjKhKhKhKhKhKhKjKj*Kj8KjSKjaKjoK j}KjKjKjKjKjKjKj-KjHKjcKj~KjKjKjKjKjKjKj!Kj/KjJKjXKjfKjKjK jKjKjKjKhK jKj,KjGKjbKh K jKjKjKjKjKjKjKj:KjUKjpKj~KjKjKjKjKjKjKjKj"Kj=KjXKjsKjKjKjKjKh&KjKjKj Kh Kj1KjLKjgKjKjKjKjKjKjKjKjKj3KjNKuUnumbered_toctreesrh]RrU found_docsrh]r(hOhjhhhhhhjj*j8jSjajoj}jjjjjjj-jHjcj~jjjjjjj!j/jJjXjfjjjjjjhjj,jGjbh jjjjjjjj:jUjpj~jjjjjjjj"j=jXjsjjjjh&jjj h j1jLjgjjNjjjjjjj3jeRrU longtitlesr}r(hOhQhjhkhhhhhhhhhhhhjjj*j+j8j9jSjTjajbjojpj}j~jjjjjjjjjjjj j-j.jHjIjcjdj~jjjjjjjjjjjjjj!j"j/j0jJjKjXjYjfjgjjjjjjjjjjjjhjjjj,j-jGjHjbjch j}jjjjjjjjjjjjjj j:j;jUjVjpjqj~jjjjjjjjjjjjjjjj"j#j=j>jXjYjsjtjjjjjjjjh&jjjjjj j h j$j1j2jLjMjgjhjjjjjjjjjjjjjjjjj3j4jNjOuU dependenciesr}r (jh]r!U ../../circuits/tools/__init__.pyr"aRr#h&h]r$Xman/examples/handler_returns.pyr%aRr&jh]r'U../../circuits/web/events.pyr(aRr)j:h]r*U../../circuits/web/utils.pyr+aRr,hjh]r-U../../circuits/web/loggers.pyr.aRr/jUh]r0U../../circuits/node/utils.pyr1aRr2hh]r3j] aRr4hh]r5U.../../circuits/web/dispatchers/virtualhosts.pyr6aRr7j~h]r8U../../circuits/node/__init__.pyr9aRr:j=h]r;U,../../circuits/web/dispatchers/websockets.pyr<aRr=j h]r>U../../circuits/node/client.pyr?aRr@jh]rAU../../circuits/app/daemon.pyrBaRrCjh]rDU../../circuits/core/utils.pyrEaRrFjGh]rGU$../../circuits/net/protocols/http.pyrHaRrIj1h]rJU../../circuits/app/env.pyrKaRrLh h]rMX"man/examples/handler_annotation.pyrNaRrOjh]rPU)../../circuits/web/dispatchers/jsonrpc.pyrQaRrRj/h]rSU../../circuits/core/manager.pyrTaRrUjfh]rVU../../circuits/node/events.pyrWaRrXhh]rYU../../circuits/app/log.pyrZaRr[jh]r\X../../README.rstr]aRr^jLh]r_U../../circuits/io/file.pyr`aRrajh]rbU../../circuits/io/notify.pyrcaRrdjh]reU../../circuits/web/sessions.pyrfaRrgjgh]rhU!../../circuits/web/controllers.pyriaRrjjh]rkU../../circuits/core/timers.pyrlaRrmhh]rnU../../circuits/io/__init__.pyroaRrpjh]rqU$../../circuits/net/protocols/line.pyrraRrsjh]rtU../../circuits/core/pollers.pyruaRrvjNh]rwU../../circuits/io/serial.pyrxaRryj"h]rzU(../../circuits/web/dispatchers/xmlrpc.pyr{aRr|jh]r}U ../../circuits/web/exceptions.pyr~aRrjh]rU../../circuits/web/headers.pyraRrj8h]rU(../../circuits/net/protocols/__init__.pyraRrjh]rU../../circuits/web/wsgi.pyraRrjHh]rU../../circuits/core/handlers.pyraRrhh]r(Xtutorial/007.pyrXtutorial/004.pyrXtutorial/001.pyrXtutorial/008.pyrXtutorial/005.pyrXtutorial/002.pyrXtutorial/009.pyrXtutorial/006.pyrXtutorial/003.pyreRrjh]rU../../circuits/web/wrappers.pyraRrjoh]r(X../../RELEASE.rstrX../../README.rstreRrj,h]rU../../circuits/web/errors.pyraRrjh]rU../../circuits/web/__init__.pyraRrj}h]rU(../../circuits/web/dispatchers/static.pyraRrjh]rU../../circuits/web/constants.pyraRrjbh]rU../../circuits/web/main.pyraRrjh]rU../../circuits/app/config.pyraRrj3h]rU../../circuits/web/tools.pyraRrjh]rU../../circuits/node/node.pyraRrh h]rXhowtos/simple_server.pyraRrjh]rU!../../circuits/core/components.pyraRrjsh]rU../../circuits/core/events.pyraRrjXh]rU../../circuits/net/sockets.pyraRrjh]rU../../circuits/core/debugger.pyraRrjh]rU../../circuits/core/__init__.pyraRrjh]rU../../circuits/web/client.pyraRrjh]rU../../circuits/core/workers.pyraRrjh]rU../../circuits/web/servers.pyraRrjh]rU../../circuits/node/server.pyraRrjh]rU../../circuits/io/events.pyraRrhh]rU#../../circuits/net/protocols/irc.pyraRrj-h]rU../../circuits/app/__init__.pyraRrjh]rU../../circuits/web/websocket.pyraRrjh]rU../../circuits/net/__init__.pyraRrjch]rU../../circuits/core/loader.pyraRrj~h]rU../../circuits/web/http.pyraRrjh]rU../../circuits/core/values.pyraRrjh]rX../../CHANGES.rstraRrjh]rU,../../circuits/web/dispatchers/dispatcher.pyraRruUtoctree_includesr}r(j]r(X start/indexrXtutorial/indexrX man/indexrX web/indexrX howtos/indexrX api/indexrX dev/indexrXchangesrXusersrX contributorsrXfaqrXglossaryrXusersrXpypitestrXtodorej]r(jjsjHj/jjjjcjjjej]r(Xman/componentsrX man/eventsrX man/handlersrX man/valuesr X man/debuggingr X man/toolsr X man/managerr ehO]r (Xdev/introductionrXdev/contributingrX dev/processesrej]r(Xapi/circuits_corerXapi/circuits_iorXapi/circuits_netrXapi/circuits_noderXapi/circuits_toolsrXapi/circuits_webrXapi/circuits_appreh]r(jjLjjNejp]r(X start/quickrXstart/downloadingrXstart/installingrXstart/requirementsrej-]r(jjj1hej]r (jjjgjjj}hj=j"j,jjjj~hjjbjjj3j:jjjej]r!(Xweb/introductionr"Xweb/gettingstartedr#X web/basicsr$ej]r%(j8jGhjjXej]r&Xhowtos/simple_serverr'aj~]r((j jfjjjUej8]r)(jGhjeuU temp_datar*}r+Utocsr,}r-(hOcdocutils.nodes bullet_list r.)r/}r0(hSUhT}r1(hV]r2hX]r3hZ]r4h\]r5h^]r6uh`]r7cdocutils.nodes list_item r8)r9}r:(hSUhT}r;(hV]r<hX]r=hZ]r>h\]r?h^]r@uhgj/h`]rA(csphinx.addnodes compact_paragraph rB)rC}rD(hSUhT}rE(hV]rFhX]rGhZ]rHh\]rIh^]rJuhgj9h`]rKcdocutils.nodes reference rL)rM}rN(hSUhT}rO(U anchornamerPUUrefurirQhOh\]rRhZ]rShV]rThX]rUh^]rVUinternalrWuhgjCh`]rXhbXDeveloper DocsrYrZ}r[(hShfhgjMubahhU referencer\ubahhUcompact_paragraphr]ubj.)r^}r_(hSUhT}r`(hV]rahX]rbhZ]rch\]rdh^]reuhgj9h`]rfcsphinx.addnodes toctree rg)rh}ri(hSUhT}rj(UnumberedrkKUparentrlhOU titlesonlyrmUglobrnh\]rohZ]rphV]rqhX]rrh^]rsUentriesrt]ru(NjrvNjrwNjrxeUhiddenryU includefilesrz]r{(jjjeUmaxdepthr|Kuhgj^h`]r}hhUtoctreer~ubahhU bullet_listrubehhU list_itemrubahhjubhjj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(jB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerUUrefurirhjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]r(ht)r}r(hSXcircuits.web.loggersrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.web.loggersrr}r(hSUhgjubahhhubhbX -- Loggersrr}r(hShhgjubehhj\ubahhj]ubj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(j8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU#eventsrUrefurirhjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbXEventsrr}r(hSXEventsrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #componentsrUrefurirhjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbX Componentsrr}r(hSX Componentsrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r (hV]r hX]r hZ]r h\]r h^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #functionsrUrefurirhjh\]rhZ]r hV]r!hX]r"h^]r#Uinternalr$uhgjh`]r%hbX Functionsr&r'}r((hSX Functionsr)hgjubahhj\ubahhj]ubahhjubehhjubehhjubahhjubhj.)r*}r+(hSUhT}r,(hV]r-hX]r.hZ]r/h\]r0h^]r1uh`]r2j8)r3}r4(hSUhT}r5(hV]r6hX]r7hZ]r8h\]r9h^]r:uhgj*h`]r;jB)r<}r=(hSUhT}r>(hV]r?hX]r@hZ]rAh\]rBh^]rCuhgj3h`]rDjL)rE}rF(hSUhT}rG(U anchornamerHUUrefurirIhh\]rJhZ]rKhV]rLhX]rMh^]rNUinternalrOuhgj<h`]rPhbXGetting StartedrQrR}rS(hShhgjEubahhj\ubahhj]ubahhjubahhjubhj.)rT}rU(hSUhT}rV(hV]rWhX]rXhZ]rYh\]rZh^]r[uh`]r\j8)r]}r^(hSUhT}r_(hV]r`hX]rahZ]rbh\]rch^]rduhgjTh`]re(jB)rf}rg(hSUhT}rh(hV]rihX]rjhZ]rkh\]rlh^]rmuhgj]h`]rnjL)ro}rp(hSUhT}rq(U anchornamerrUUrefurirshh\]rthZ]ruhV]rvhX]rwh^]rxUinternalryuhgjfh`]rz(ht)r{}r|(hSX%circuits.web.dispatchers.virtualhostsr}hT}r~(hV]rhX]rhZ]rh\]rh^]ruhgjoh`]rhbX%circuits.web.dispatchers.virtualhostsrr}r(hSUhgj{ubahhhubhbX -- Virtual Hostsrr}r(hShhgjoubehhj\ubahhj]ubj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgj]h`]r(j8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU#eventsrUrefurirhh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbXEventsrr}r(hSXEventsrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #componentsrUrefurirhh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbX Componentsrr}r(hSX Componentsrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #functionsrUrefurirhh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbX Functionsrr}r(hSX Functionsrhgjubahhj\ubahhj]ubahhjubehhjubehhjubahhjubhj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rj8)r}r(hSUhT}r(hV]r hX]r hZ]r h\]r h^]r uhgjh`]r(jB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerUUrefurirhh\]rhZ]rhV]rhX]r h^]r!Uinternalr"uhgjh`]r#(ht)r$}r%(hSXcircuits.net.protocols.ircr&hT}r'(hV]r(hX]r)hZ]r*h\]r+h^]r,uhgjh`]r-hbXcircuits.net.protocols.ircr.r/}r0(hSUhgj$ubahhhubhbX -- IRC Protocolr1r2}r3(hShhgjubehhj\ubahhj]ubj.)r4}r5(hSUhT}r6(hV]r7hX]r8hZ]r9h\]r:h^]r;uhgjh`]r<(j8)r=}r>(hSUhT}r?(hV]r@hX]rAhZ]rBh\]rCh^]rDuhgj4h`]rEjB)rF}rG(hSUhT}rH(hV]rIhX]rJhZ]rKh\]rLh^]rMuhgj=h`]rNjL)rO}rP(hSUhT}rQ(U anchornamerRU#eventsrSUrefurirThh\]rUhZ]rVhV]rWhX]rXh^]rYUinternalrZuhgjFh`]r[hbXEventsr\r]}r^(hSXEventsr_hgjOubahhj\ubahhj]ubahhjubj8)r`}ra(hSUhT}rb(hV]rchX]rdhZ]reh\]rfh^]rguhgj4h`]rhjB)ri}rj(hSUhT}rk(hV]rlhX]rmhZ]rnh\]roh^]rpuhgj`h`]rqjL)rr}rs(hSUhT}rt(U anchornameruU #componentsrvUrefurirwhh\]rxhZ]ryhV]rzhX]r{h^]r|Uinternalr}uhgjih`]r~hbX Componentsrr}r(hSX Componentsrhgjrubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgj4h`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #functionsrUrefurirhh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbX Functionsrr}r(hSX Functionsrhgjubahhj\ubahhj]ubahhjubehhjubehhjubahhjubhj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(jB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerUUrefurirhh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]r(ht)r}r(hSXcircuits.app.logrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.app.logrr}r(hSUhgjubahhhubhbX -- Application Loggingrr}r(hShhgjubehhj\ubahhj]ubj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(j8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU#eventsrUrefurirhh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbXEventsrr}r(hSXEventsrhgjubahhj\ubahhj]ubahhjubj8)r }r (hSUhT}r (hV]r hX]r hZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgj h`]rjL)r}r(hSUhT}r(U anchornamerU #componentsrUrefurir hh\]r!hZ]r"hV]r#hX]r$h^]r%Uinternalr&uhgjh`]r'hbX Componentsr(r)}r*(hSX Componentsr+hgjubahhj\ubahhj]ubahhjubj8)r,}r-(hSUhT}r.(hV]r/hX]r0hZ]r1h\]r2h^]r3uhgjh`]r4jB)r5}r6(hSUhT}r7(hV]r8hX]r9hZ]r:h\]r;h^]r<uhgj,h`]r=jL)r>}r?(hSUhT}r@(U anchornamerAU #functionsrBUrefurirChh\]rDhZ]rEhV]rFhX]rGh^]rHUinternalrIuhgj5h`]rJhbX FunctionsrKrL}rM(hSX FunctionsrNhgj>ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubhj.)rO}rP(hSUhT}rQ(hV]rRhX]rShZ]rTh\]rUh^]rVuh`]rWj8)rX}rY(hSUhT}rZ(hV]r[hX]r\hZ]r]h\]r^h^]r_uhgjOh`]r`jB)ra}rb(hSUhT}rc(hV]rdhX]rehZ]rfh\]rgh^]rhuhgjXh`]rijL)rj}rk(hSUhT}rl(U anchornamermUUrefurirnhh\]rohZ]rphV]rqhX]rrh^]rsUinternalrtuhgjah`]ruhbXValuesrvrw}rx(hShhgjjubahhj\ubahhj]ubahhjubahhjubhj.)ry}rz(hSUhT}r{(hV]r|hX]r}hZ]r~h\]rh^]ruh`]rj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjyh`]r(jB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerUUrefurirhh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]r(ht)r}r(hSX circuits.iorhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbX circuits.iorr}r(hSUhgjubahhhubhbX -- I/O Supportrr}r(hSjhgjubehhj\ubahhj]ubj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjg)r}r(hSUhT}r(UnumberedrKUparentrhU titlesonlyrUglobrh\]rhZ]rhV]rhX]rh^]rUentriesr]r(NjrNjLrNjrNjNreUhiddenrU includefilesr]r(jjLjjNeUmaxdepthrKuhgjh`]rhhj~ubahhjubehhjubahhjubjj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(jB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerUUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]r(ht)r}r(hSXcircuits.core.pollersrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.core.pollersrr}r(hSUhgjubahhhubhbX -- I/O Pollersrr}r(hSj)hgjubehhj\ubahhj]ubj.)r}r(hSUhT}r (hV]r hX]r hZ]r h\]r h^]ruhgjh`]r(j8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]r uhgjh`]r!jL)r"}r#(hSUhT}r$(U anchornamer%U#classesr&Urefurir'jh\]r(hZ]r)hV]r*hX]r+h^]r,Uinternalr-uhgjh`]r.hbXClassesr/r0}r1(hSXClassesr2hgj"ubahhj\ubahhj]ubahhjubj8)r3}r4(hSUhT}r5(hV]r6hX]r7hZ]r8h\]r9h^]r:uhgjh`]r;jB)r<}r=(hSUhT}r>(hV]r?hX]r@hZ]rAh\]rBh^]rCuhgj3h`]rDjL)rE}rF(hSUhT}rG(U anchornamerHU #componentsrIUrefurirJjh\]rKhZ]rLhV]rMhX]rNh^]rOUinternalrPuhgj<h`]rQhbX ComponentsrRrS}rT(hSX ComponentsrUhgjEubahhj\ubahhj]ubahhjubj8)rV}rW(hSUhT}rX(hV]rYhX]rZhZ]r[h\]r\h^]r]uhgjh`]r^jB)r_}r`(hSUhT}ra(hV]rbhX]rchZ]rdh\]reh^]rfuhgjVh`]rgjL)rh}ri(hSUhT}rj(U anchornamerkU#eventsrlUrefurirmjh\]rnhZ]rohV]rphX]rqh^]rrUinternalrsuhgj_h`]rthbXEventsrurv}rw(hSXEventsrxhgjhubahhj\ubahhj]ubahhjubj8)ry}rz(hSUhT}r{(hV]r|hX]r}hZ]r~h\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjyh`]rjL)r}r(hSUhT}r(U anchornamerU #functionsrUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbX Functionsrr}r(hSX Functionsrhgjubahhj\ubahhj]ubahhjubehhjubehhjubahhjubj*j.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerUUrefurirj*h\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbXToolsrr}r(hSj7hgjubahhj\ubahhj]ubahhjubahhjubj8j.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(jB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerUUrefurirj8h\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]r(ht)r}r(hSXcircuits.net.protocolsrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.net.protocolsrr}r(hSUhgjubahhhubhbX -- Networking Protocolsrr}r(hSjRhgjubehhj\ubahhj]ubj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjg)r}r(hSUhT}r(Unumberedr KUparentr j8U titlesonlyr Uglobr h\]r hZ]rhV]rhX]rh^]rUentriesr]r(NjGrNhrNjreUhiddenrU includefilesr]r(jGhjeUmaxdepthrKuhgjh`]rhhj~ubahhjubehhjubahhjubjSj.)r}r(hSUhT}r(hV]rhX]r hZ]r!h\]r"h^]r#uh`]r$j8)r%}r&(hSUhT}r'(hV]r(hX]r)hZ]r*h\]r+h^]r,uhgjh`]r-(jB)r.}r/(hSUhT}r0(hV]r1hX]r2hZ]r3h\]r4h^]r5uhgj%h`]r6jL)r7}r8(hSUhT}r9(U anchornamer:UUrefurir;jSh\]r<hZ]r=hV]r>hX]r?h^]r@UinternalrAuhgj.h`]rBhbX DownloadingrCrD}rE(hSj`hgj7ubahhj\ubahhj]ubj.)rF}rG(hSUhT}rH(hV]rIhX]rJhZ]rKh\]rLh^]rMuhgj%h`]rN(j8)rO}rP(hSUhT}rQ(hV]rRhX]rShZ]rTh\]rUh^]rVuhgjFh`]rWjB)rX}rY(hSUhT}rZ(hV]r[hX]r\hZ]r]h\]r^h^]r_uhgjOh`]r`jL)ra}rb(hSUhT}rc(U anchornamerdU#latest-stable-releasereUrefurirfjSh\]rghZ]rhhV]rihX]rjh^]rkUinternalrluhgjXh`]rmhbXLatest Stable Releasernro}rp(hSXLatest Stable Releaserqhgjaubahhj\ubahhj]ubahhjubj8)rr}rs(hSUhT}rt(hV]ruhX]rvhZ]rwh\]rxh^]ryuhgjFh`]rzjB)r{}r|(hSUhT}r}(hV]r~hX]rhZ]rh\]rh^]ruhgjrh`]rjL)r}r(hSUhT}r(U anchornamerU#latest-development-source-coderUrefurirjSh\]rhZ]rhV]rhX]rh^]rUinternalruhgj{h`]rhbXLatest Development Source Coderr}r(hSXLatest Development Source Coderhgjubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjaj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(jB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerUUrefurirjah\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbXFrequently Asked Questionsrr}r(hSjnhgjubahhj\ubahhj]ubj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU#generalrUrefurirjah\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbXGeneralrr}r(hSXGeneralrhgjubahhj\ubahhj]ubahhjubahhjubehhjubahhjubjoj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(jB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamer UUrefurir joh\]r hZ]r hV]r hX]rh^]rUinternalruhgjh`]rhbX"PyPi Test Page - Tentative Releaserr}r(hSj|hgjubahhj\ubahhj]ubj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(j8)r}r(hSUhT}r (hV]r!hX]r"hZ]r#h\]r$h^]r%uhgjh`]r&jB)r'}r((hSUhT}r)(hV]r*hX]r+hZ]r,h\]r-h^]r.uhgjh`]r/jL)r0}r1(hSUhT}r2(U anchornamer3U #overviewr4Urefurir5joh\]r6hZ]r7hV]r8hX]r9h^]r:Uinternalr;uhgj'h`]r<hbXOverviewr=r>}r?(hSXOverviewr@hgj0ubahhj\ubahhj]ubahhjubj8)rA}rB(hSUhT}rC(hV]rDhX]rEhZ]rFh\]rGh^]rHuhgjh`]rIjB)rJ}rK(hSUhT}rL(hV]rMhX]rNhZ]rOh\]rPh^]rQuhgjAh`]rRjL)rS}rT(hSUhT}rU(U anchornamerVU #featuresrWUrefurirXjoh\]rYhZ]rZhV]r[hX]r\h^]r]Uinternalr^uhgjJh`]r_hbXFeaturesr`ra}rb(hSXFeaturesrchgjSubahhj\ubahhj]ubahhjubj8)rd}re(hSUhT}rf(hV]rghX]rhhZ]rih\]rjh^]rkuhgjh`]rljB)rm}rn(hSUhT}ro(hV]rphX]rqhZ]rrh\]rsh^]rtuhgjdh`]rujL)rv}rw(hSUhT}rx(U anchornameryU #requirementsrzUrefurir{joh\]r|hZ]r}hV]r~hX]rh^]rUinternalruhgjmh`]rhbX Requirementsrr}r(hSX Requirementsrhgjvubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU#supported-platformsrUrefurirjoh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbXSupported Platformsrr}r(hSXSupported Platformsrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #installationrUrefurirjoh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbX Installationrr}r(hSX Installationrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU#licenserUrefurirjoh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbXLicenserr}r(hSXLicenserhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #feedbackrUrefurirjoh\]rhZ]r hV]r hX]r h^]r Uinternalr uhgjh`]rhbXFeedbackrr}r(hSXFeedbackrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]r hZ]r!h\]r"h^]r#uhgjh`]r$jL)r%}r&(hSUhT}r'(U anchornamer(U #communityr)Urefurir*joh\]r+hZ]r,hV]r-hX]r.h^]r/Uinternalr0uhgjh`]r1hbX Communityr2r3}r4(hSX Communityr5hgj%ubahhj\ubahhj]ubahhjubj8)r6}r7(hSUhT}r8(hV]r9hX]r:hZ]r;h\]r<h^]r=uhgjh`]r>jB)r?}r@(hSUhT}rA(hV]rBhX]rChZ]rDh\]rEh^]rFuhgj6h`]rGjL)rH}rI(hSUhT}rJ(U anchornamerKU%#release-notes-circuits-2-1-0-releaserLUrefurirMjoh\]rNhZ]rOhV]rPhX]rQh^]rRUinternalrSuhgj?h`]rThbX*Release Notes - circuits-2.1.0 ()rUrV}rW(hSX*Release Notes - circuits-2.1.0 ()rXhgjHubahhj\ubahhj]ubahhjubehhjubehhjubahhjubj}j.)rY}rZ(hSUhT}r[(hV]r\hX]r]hZ]r^h\]r_h^]r`uh`]raj8)rb}rc(hSUhT}rd(hV]rehX]rfhZ]rgh\]rhh^]riuhgjYh`]rj(jB)rk}rl(hSUhT}rm(hV]rnhX]rohZ]rph\]rqh^]rruhgjbh`]rsjL)rt}ru(hSUhT}rv(U anchornamerwUUrefurirxj}h\]ryhZ]rzhV]r{hX]r|h^]r}Uinternalr~uhgjkh`]r(ht)r}r(hSXcircuits.web.dispatchers.staticrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjth`]rhbXcircuits.web.dispatchers.staticrr}r(hSUhgjubahhhubhbX -- Staticrr}r(hSjhgjtubehhj\ubahhj]ubj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjbh`]r(j8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU#eventsrUrefurirj}h\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbXEventsrr}r(hSXEventsrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #componentsrUrefurirj}h\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbX Componentsrr}r(hSX Componentsrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #functionsrUrefurirj}h\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbX Functionsrr}r(hSX Functionsrhgjubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]r uh`]r j8)r }r (hSUhT}r (hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(jB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgj h`]rjL)r}r(hSUhT}r(U anchornamer UUrefurir!jh\]r"hZ]r#hV]r$hX]r%h^]r&Uinternalr'uhgjh`]r((ht)r)}r*(hSXcircuits.node.noder+hT}r,(hV]r-hX]r.hZ]r/h\]r0h^]r1uhgjh`]r2hbXcircuits.node.noder3r4}r5(hSUhgj)ubahhhubhbX -- Noder6r7}r8(hSjhgjubehhj\ubahhj]ubj.)r9}r:(hSUhT}r;(hV]r<hX]r=hZ]r>h\]r?h^]r@uhgj h`]rA(j8)rB}rC(hSUhT}rD(hV]rEhX]rFhZ]rGh\]rHh^]rIuhgj9h`]rJjB)rK}rL(hSUhT}rM(hV]rNhX]rOhZ]rPh\]rQh^]rRuhgjBh`]rSjL)rT}rU(hSUhT}rV(U anchornamerWU#eventsrXUrefurirYjh\]rZhZ]r[hV]r\hX]r]h^]r^Uinternalr_uhgjKh`]r`hbXEventsrarb}rc(hSXEventsrdhgjTubahhj\ubahhj]ubahhjubj8)re}rf(hSUhT}rg(hV]rhhX]rihZ]rjh\]rkh^]rluhgj9h`]rmjB)rn}ro(hSUhT}rp(hV]rqhX]rrhZ]rsh\]rth^]ruuhgjeh`]rvjL)rw}rx(hSUhT}ry(U anchornamerzU #componentsr{Urefurir|jh\]r}hZ]r~hV]rhX]rh^]rUinternalruhgjnh`]rhbX Componentsrr}r(hSX Componentsrhgjwubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgj9h`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #functionsrUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbX Functionsrr}r(hSX Functionsrhgjubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(jB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerUUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]r(ht)r}r(hSXcircuits.net.protocols.linerhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.net.protocols.linerr}r(hSUhgjubahhhubhbX -- Line Protocolrr}r(hSjhgjubehhj\ubahhj]ubj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(j8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU#eventsrUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]r hbXEventsr r }r (hSXEventsr hgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r }r!(hSUhT}r"(U anchornamer#U #componentsr$Urefurir%jh\]r&hZ]r'hV]r(hX]r)h^]r*Uinternalr+uhgjh`]r,hbX Componentsr-r.}r/(hSX Componentsr0hgj ubahhj\ubahhj]ubahhjubj8)r1}r2(hSUhT}r3(hV]r4hX]r5hZ]r6h\]r7h^]r8uhgjh`]r9jB)r:}r;(hSUhT}r<(hV]r=hX]r>hZ]r?h\]r@h^]rAuhgj1h`]rBjL)rC}rD(hSUhT}rE(U anchornamerFU #functionsrGUrefurirHjh\]rIhZ]rJhV]rKhX]rLh^]rMUinternalrNuhgj:h`]rOhbX FunctionsrPrQ}rR(hSX FunctionsrShgjCubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)rT}rU(hSUhT}rV(hV]rWhX]rXhZ]rYh\]rZh^]r[uh`]r\j8)r]}r^(hSUhT}r_(hV]r`hX]rahZ]rbh\]rch^]rduhgjTh`]re(jB)rf}rg(hSUhT}rh(hV]rihX]rjhZ]rkh\]rlh^]rmuhgj]h`]rnjL)ro}rp(hSUhT}rq(U anchornamerrUUrefurirsjh\]rthZ]ruhV]rvhX]rwh^]rxUinternalryuhgjfh`]rz(ht)r{}r|(hSXcircuits.core.debuggerr}hT}r~(hV]rhX]rhZ]rh\]rh^]ruhgjoh`]rhbXcircuits.core.debuggerrr}r(hSUhgj{ubahhhubhbX -- Debuggerrr}r(hSjhgjoubehhj\ubahhj]ubj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgj]h`]r(j8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU#classesrUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbXClassesrr}r(hSXClassesrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #componentsrUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbX Componentsrr}r(hSX Componentsrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU#eventsrUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbXEventsrr}r(hSXEventsrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]r hX]r hZ]r h\]r h^]r uhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #functionsrUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbX Functionsrr}r(hSX Functionsrhgjubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r }r!(hSUhT}r"(hV]r#hX]r$hZ]r%h\]r&h^]r'uh`]r(j8)r)}r*(hSUhT}r+(hV]r,hX]r-hZ]r.h\]r/h^]r0uhgj h`]r1(jB)r2}r3(hSUhT}r4(hV]r5hX]r6hZ]r7h\]r8h^]r9uhgj)h`]r:jL)r;}r<(hSUhT}r=(U anchornamer>UUrefurir?jh\]r@hZ]rAhV]rBhX]rCh^]rDUinternalrEuhgj2h`]rF(ht)rG}rH(hSX circuits.corerIhT}rJ(hV]rKhX]rLhZ]rMh\]rNh^]rOuhgj;h`]rPhbX circuits.corerQrR}rS(hSUhgjGubahhhubhbX -- Core FunctionalityrTrU}rV(hSjhgj;ubehhj\ubahhj]ubj.)rW}rX(hSUhT}rY(hV]rZhX]r[hZ]r\h\]r]h^]r^uhgj)h`]r_jg)r`}ra(hSUhT}rb(UnumberedrcKUparentrdjU titlesonlyreUglobrfh\]rghZ]rhhV]rihX]rjh^]rkUentriesrl]rm(NjrnNjsroNjHrpNj/rqNjrrNjrsNjrtNjcruNjrvNjrwNjrxeUhiddenryU includefilesrz]r{(jjsjHj/jjjjcjjjeUmaxdepthr|KuhgjWh`]r}hhj~ubahhjubehhjubahhjubjj.)r~}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgj~h`]r(jB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerUUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]r(ht)r}r(hSXcircuits.io.eventsrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.io.eventsrr}r(hSUhgjubahhhubhbX -- I/O Eventsrr}r(hSjhgjubehhj\ubahhj]ubj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(j8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU#eventsrUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbXEventsrr}r(hSXEventsrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #componentsrUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbX Componentsrr}r(hSX Componentsrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]r h\]r h^]r uhgjh`]r jB)r }r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #functionsrUrefurirjh\]rhZ]rhV]rhX]rh^]r Uinternalr!uhgj h`]r"hbX Functionsr#r$}r%(hSX Functionsr&hgjubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r'}r((hSUhT}r)(hV]r*hX]r+hZ]r,h\]r-h^]r.uh`]r/j8)r0}r1(hSUhT}r2(hV]r3hX]r4hZ]r5h\]r6h^]r7uhgj'h`]r8(jB)r9}r:(hSUhT}r;(hV]r<hX]r=hZ]r>h\]r?h^]r@uhgj0h`]rAjL)rB}rC(hSUhT}rD(U anchornamerEUUrefurirFjh\]rGhZ]rHhV]rIhX]rJh^]rKUinternalrLuhgj9h`]rMhbXRequirements and DependenciesrNrO}rP(hSj,hgjBubahhj\ubahhj]ubj.)rQ}rR(hSUhT}rS(hV]rThX]rUhZ]rVh\]rWh^]rXuhgj0h`]rYj8)rZ}r[(hSUhT}r\(hV]r]hX]r^hZ]r_h\]r`h^]rauhgjQh`]rbjB)rc}rd(hSUhT}re(hV]rfhX]rghZ]rhh\]rih^]rjuhgjZh`]rkjL)rl}rm(hSUhT}rn(U anchornameroU#other-optional-dependenciesrpUrefurirqjh\]rrhZ]rshV]rthX]ruh^]rvUinternalrwuhgjch`]rxhbXOther Optional Dependenciesryrz}r{(hSXOther Optional Dependenciesr|hgjlubahhj\ubahhj]ubahhjubahhjubehhjubahhjubj-j.)r}}r~(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgj}h`]r(jB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerUUrefurirj-h\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]r(ht)r}r(hSX circuits.apprhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbX circuits.apprr}r(hSUhgjubahhhubhbX -- Application Supportrr}r(hSjGhgjubehhj\ubahhj]ubj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjg)r}r(hSUhT}r(UnumberedrKUparentrj-U titlesonlyrUglobrh\]rhZ]rhV]rhX]rh^]rUentriesr]r(NjrNjrNj1rNhˆreUhiddenrU includefilesr]r(jjj1heUmaxdepthrKuhgjh`]rhhj~ubahhjubehhjubahhjubjHj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(jB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerUUrefurirjHh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]r(ht)r}r(hSXcircuits.core.handlersrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.core.handlersrr}r(hSUhgjubahhhubhbX -- Handlersrr }r (hSjbhgjubehhj\ubahhj]ubj.)r }r (hSUhT}r (hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(j8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgj h`]rjB)r}r(hSUhT}r(hV]r hX]r!hZ]r"h\]r#h^]r$uhgjh`]r%jL)r&}r'(hSUhT}r((U anchornamer)U#classesr*Urefurir+jHh\]r,hZ]r-hV]r.hX]r/h^]r0Uinternalr1uhgjh`]r2hbXClassesr3r4}r5(hSXClassesr6hgj&ubahhj\ubahhj]ubahhjubj8)r7}r8(hSUhT}r9(hV]r:hX]r;hZ]r<h\]r=h^]r>uhgj h`]r?jB)r@}rA(hSUhT}rB(hV]rChX]rDhZ]rEh\]rFh^]rGuhgj7h`]rHjL)rI}rJ(hSUhT}rK(U anchornamerLU #componentsrMUrefurirNjHh\]rOhZ]rPhV]rQhX]rRh^]rSUinternalrTuhgj@h`]rUhbX ComponentsrVrW}rX(hSX ComponentsrYhgjIubahhj\ubahhj]ubahhjubj8)rZ}r[(hSUhT}r\(hV]r]hX]r^hZ]r_h\]r`h^]rauhgj h`]rbjB)rc}rd(hSUhT}re(hV]rfhX]rghZ]rhh\]rih^]rjuhgjZh`]rkjL)rl}rm(hSUhT}rn(U anchornameroU#eventsrpUrefurirqjHh\]rrhZ]rshV]rthX]ruh^]rvUinternalrwuhgjch`]rxhbXEventsryrz}r{(hSXEventsr|hgjlubahhj\ubahhj]ubahhjubj8)r}}r~(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgj h`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgj}h`]rjL)r}r(hSUhT}r(U anchornamerU #functionsrUrefurirjHh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbX Functionsrr}r(hSX Functionsrhgjubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjcj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(jB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerUUrefurirjch\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]r(ht)r}r(hSXcircuits.core.loaderrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.core.loaderrr}r(hSUhgjubahhhubhbX -- Loaderrr}r(hSj}hgjubehhj\ubahhj]ubj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(j8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU#classesrUrefurirjch\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbXClassesrr}r(hSXClassesrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]r h^]r uhgjh`]r jB)r }r (hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #componentsrUrefurirjch\]rhZ]rhV]rhX]rh^]rUinternalr uhgj h`]r!hbX Componentsr"r#}r$(hSX Componentsr%hgjubahhj\ubahhj]ubahhjubj8)r&}r'(hSUhT}r((hV]r)hX]r*hZ]r+h\]r,h^]r-uhgjh`]r.jB)r/}r0(hSUhT}r1(hV]r2hX]r3hZ]r4h\]r5h^]r6uhgj&h`]r7jL)r8}r9(hSUhT}r:(U anchornamer;U#eventsr<Urefurir=jch\]r>hZ]r?hV]r@hX]rAh^]rBUinternalrCuhgj/h`]rDhbXEventsrErF}rG(hSXEventsrHhgj8ubahhj\ubahhj]ubahhjubj8)rI}rJ(hSUhT}rK(hV]rLhX]rMhZ]rNh\]rOh^]rPuhgjh`]rQjB)rR}rS(hSUhT}rT(hV]rUhX]rVhZ]rWh\]rXh^]rYuhgjIh`]rZjL)r[}r\(hSUhT}r](U anchornamer^U #functionsr_Urefurir`jch\]rahZ]rbhV]rchX]rdh^]reUinternalrfuhgjRh`]rghbX Functionsrhri}rj(hSX Functionsrkhgj[ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubj~j.)rl}rm(hSUhT}rn(hV]rohX]rphZ]rqh\]rrh^]rsuh`]rtj8)ru}rv(hSUhT}rw(hV]rxhX]ryhZ]rzh\]r{h^]r|uhgjlh`]r}(jB)r~}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjuh`]rjL)r}r(hSUhT}r(U anchornamerUUrefurirj~h\]rhZ]rhV]rhX]rh^]rUinternalruhgj~h`]r(ht)r}r(hSXcircuits.web.httprhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbXcircuits.web.httprr}r(hSUhgjubahhhubhbX -- HTTP Protocolrr}r(hSjhgjubehhj\ubahhj]ubj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjuh`]r(j8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #componentsrUrefurirj~h\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbX Componentsrr}r(hSX Componentsrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU#eventsrUrefurirj~h\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbXEventsrr}r(hSXEventsrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #functionsrUrefurir j~h\]r hZ]r hV]r hX]r h^]rUinternalruhgjh`]rhbX Functionsrr}r(hSX Functionsrhgjubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rj8)r}r(hSUhT}r (hV]r!hX]r"hZ]r#h\]r$h^]r%uhgjh`]r&(jB)r'}r((hSUhT}r)(hV]r*hX]r+hZ]r,h\]r-h^]r.uhgjh`]r/jL)r0}r1(hSUhT}r2(U anchornamer3UUrefurir4jh\]r5hZ]r6hV]r7hX]r8h^]r9Uinternalr:uhgj'h`]r;(ht)r<}r=(hSXcircuits.node.serverr>hT}r?(hV]r@hX]rAhZ]rBh\]rCh^]rDuhgj0h`]rEhbXcircuits.node.serverrFrG}rH(hSUhgj<ubahhhubhbX -- ServerrIrJ}rK(hSjhgj0ubehhj\ubahhj]ubj.)rL}rM(hSUhT}rN(hV]rOhX]rPhZ]rQh\]rRh^]rSuhgjh`]rT(j8)rU}rV(hSUhT}rW(hV]rXhX]rYhZ]rZh\]r[h^]r\uhgjLh`]r]jB)r^}r_(hSUhT}r`(hV]rahX]rbhZ]rch\]rdh^]reuhgjUh`]rfjL)rg}rh(hSUhT}ri(U anchornamerjU#eventsrkUrefurirljh\]rmhZ]rnhV]rohX]rph^]rqUinternalrruhgj^h`]rshbXEventsrtru}rv(hSXEventsrwhgjgubahhj\ubahhj]ubahhjubj8)rx}ry(hSUhT}rz(hV]r{hX]r|hZ]r}h\]r~h^]ruhgjLh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjxh`]rjL)r}r(hSUhT}r(U anchornamerU #componentsrUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbX Componentsrr}r(hSX Componentsrhgjubahhj\ubahhj]ubahhjubj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjLh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU #functionsrUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbX Functionsrr}r(hSX Functionsrhgjubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(jB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerUUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]r(ht)r}r(hSX#circuits.web.dispatchers.dispatcherrhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rhbX#circuits.web.dispatchers.dispatcherrr}r(hSUhgjubahhhubhbX -- Default Dispatcherrr}r(hSjhgjubehhj\ubahhj]ubj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(j8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r (hV]r hX]r hZ]r h\]r h^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU#eventsrUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbXEventsrr}r(hSXEventsr hgjubahhj\ubahhj]ubahhjubj8)r!}r"(hSUhT}r#(hV]r$hX]r%hZ]r&h\]r'h^]r(uhgjh`]r)jB)r*}r+(hSUhT}r,(hV]r-hX]r.hZ]r/h\]r0h^]r1uhgj!h`]r2jL)r3}r4(hSUhT}r5(U anchornamer6U #componentsr7Urefurir8jh\]r9hZ]r:hV]r;hX]r<h^]r=Uinternalr>uhgj*h`]r?hbX Componentsr@rA}rB(hSX ComponentsrChgj3ubahhj\ubahhj]ubahhjubj8)rD}rE(hSUhT}rF(hV]rGhX]rHhZ]rIh\]rJh^]rKuhgjh`]rLjB)rM}rN(hSUhT}rO(hV]rPhX]rQhZ]rRh\]rSh^]rTuhgjDh`]rUjL)rV}rW(hSUhT}rX(U anchornamerYU #functionsrZUrefurir[jh\]r\hZ]r]hV]r^hX]r_h^]r`UinternalrauhgjMh`]rbhbX Functionsrcrd}re(hSX FunctionsrfhgjVubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)rg}rh(hSUhT}ri(hV]rjhX]rkhZ]rlh\]rmh^]rnuh`]roj8)rp}rq(hSUhT}rr(hV]rshX]rthZ]ruh\]rvh^]rwuhgjgh`]rx(jB)ry}rz(hSUhT}r{(hV]r|hX]r}hZ]r~h\]rh^]ruhgjph`]rjL)r}r(hSUhT}r(U anchornamerUUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjyh`]rhbX The Basicsrr}r(hSjhgjubahhj\ubahhj]ubj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjph`]rj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerU#a-stand-alone-serverrUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbXA Stand Alone Serverrr}r(hSXA Stand Alone Serverrhgjubahhj\ubahhj]ubahhjubahhjubehhjubahhjubjj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruh`]rj8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(jB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjL)r}r(hSUhT}r(U anchornamerUUrefurirjh\]rhZ]rhV]rhX]rh^]rUinternalruhgjh`]rhbX Installingrr}r(hSjhgjubahhj\ubahhj]ubj.)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]r(j8)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]ruhgjh`]rjB)r}r(hSUhT}r(hV]rhX]rhZ]rh\]rh^]r uhgjh`]r jL)r }r (hSUhT}r (U anchornamer U!#installing-from-a-source-packager Urefurir jh\]r hZ]r hV]r hX]r h^]r Uinternalr uhgjh`]r hbX Installing from a Source Packager r }r (hSX Installing from a Source Packager hgj ubahhj\ubahhj]ubahhjubj8)r }r (hSUhT}r (hV]r hX]r hZ]r h\]r h^]r uhgjh`]r jB)r }r (hSUhT}r (hV]r hX]r hZ]r! h\]r" h^]r# uhgj h`]r$ jL)r% }r& (hSUhT}r' (U anchornamer( U+#installing-from-the-development-repositoryr) Urefurir* jh\]r+ hZ]r, hV]r- hX]r. h^]r/ Uinternalr0 uhgj h`]r1 hbX*Installing from the Development Repositoryr2 r3 }r4 (hSX*Installing from the Development Repositoryr5 hgj% ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r6 }r7 (hSUhT}r8 (hV]r9 hX]r: hZ]r; h\]r< h^]r= uh`]r> j8)r? }r@ (hSUhT}rA (hV]rB hX]rC hZ]rD h\]rE h^]rF uhgj6 h`]rG (jB)rH }rI (hSUhT}rJ (hV]rK hX]rL hZ]rM h\]rN h^]rO uhgj? h`]rP jL)rQ }rR (hSUhT}rS (U anchornamerT UUrefurirU jh\]rV hZ]rW hV]rX hX]rY h^]rZ Uinternalr[ uhgjH h`]r\ (ht)r] }r^ (hSXcircuits.app.daemonr_ hT}r` (hV]ra hX]rb hZ]rc h\]rd h^]re uhgjQ h`]rf hbXcircuits.app.daemonrg rh }ri (hSUhgj] ubahhhubhbX -- Application Daemonrj rk }rl (hSjhgjQ ubehhj\ubahhj]ubj.)rm }rn (hSUhT}ro (hV]rp hX]rq hZ]rr h\]rs h^]rt uhgj? h`]ru (j8)rv }rw (hSUhT}rx (hV]ry hX]rz hZ]r{ h\]r| h^]r} uhgjm h`]r~ jB)r }r (hSUhT}r (hV]r hX]r hZ]r h\]r h^]r uhgjv h`]r jL)r }r (hSUhT}r (U anchornamer U#eventsr Urefurir jh\]r hZ]r hV]r hX]r h^]r Uinternalr uhgj h`]r hbXEventsr r }r (hSXEventsr hgj ubahhj\ubahhj]ubahhjubj8)r }r (hSUhT}r (hV]r hX]r hZ]r h\]r h^]r uhgjm h`]r jB)r }r (hSUhT}r (hV]r hX]r hZ]r h\]r h^]r uhgj h`]r jL)r }r (hSUhT}r (U anchornamer U #componentsr Urefurir jh\]r hZ]r hV]r hX]r h^]r Uinternalr uhgj h`]r hbX Componentsr r }r (hSX Componentsr hgj ubahhj\ubahhj]ubahhjubj8)r }r (hSUhT}r (hV]r hX]r hZ]r h\]r h^]r uhgjm h`]r jB)r }r (hSUhT}r (hV]r hX]r hZ]r h\]r h^]r uhgj h`]r jL)r }r (hSUhT}r (U anchornamer U #functionsr Urefurir jh\]r hZ]r hV]r hX]r h^]r Uinternalr uhgj h`]r hbX Functionsr r }r (hSX Functionsr hgj ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r }r (hSUhT}r (hV]r hX]r hZ]r h\]r h^]r uh`]r j8)r }r (hSUhT}r (hV]r hX]r hZ]r h\]r h^]r uhgj h`]r (jB)r }r (hSUhT}r (hV]r hX]r hZ]r h\]r h^]r uhgj h`]r jL)r }r (hSUhT}r (U anchornamer UUrefurir jh\]r hZ]r!hV]r!hX]r!h^]r!Uinternalr!uhgj h`]r!(ht)r!}r!(hSXcircuits.core.utilsr!hT}r !(hV]r !hX]r !hZ]r !h\]r !h^]r!uhgj h`]r!hbXcircuits.core.utilsr!r!}r!(hSUhgj!ubahhhubhbX -- Utilitiesr!r!}r!(hSj hgj ubehhj\ubahhj]ubj.)r!}r!(hSUhT}r!(hV]r!hX]r!hZ]r!h\]r!h^]r!uhgj h`]r!(j8)r!}r !(hSUhT}r!!(hV]r"!hX]r#!hZ]r$!h\]r%!h^]r&!uhgj!h`]r'!jB)r(!}r)!(hSUhT}r*!(hV]r+!hX]r,!hZ]r-!h\]r.!h^]r/!uhgj!h`]r0!jL)r1!}r2!(hSUhT}r3!(U anchornamer4!U#classesr5!Urefurir6!jh\]r7!hZ]r8!hV]r9!hX]r:!h^]r;!Uinternalr!r?!}r@!(hSXClassesrA!hgj1!ubahhj\ubahhj]ubahhjubj8)rB!}rC!(hSUhT}rD!(hV]rE!hX]rF!hZ]rG!h\]rH!h^]rI!uhgj!h`]rJ!jB)rK!}rL!(hSUhT}rM!(hV]rN!hX]rO!hZ]rP!h\]rQ!h^]rR!uhgjB!h`]rS!jL)rT!}rU!(hSUhT}rV!(U anchornamerW!U #componentsrX!UrefurirY!jh\]rZ!hZ]r[!hV]r\!hX]r]!h^]r^!Uinternalr_!uhgjK!h`]r`!hbX Componentsra!rb!}rc!(hSX Componentsrd!hgjT!ubahhj\ubahhj]ubahhjubj8)re!}rf!(hSUhT}rg!(hV]rh!hX]ri!hZ]rj!h\]rk!h^]rl!uhgj!h`]rm!jB)rn!}ro!(hSUhT}rp!(hV]rq!hX]rr!hZ]rs!h\]rt!h^]ru!uhgje!h`]rv!jL)rw!}rx!(hSUhT}ry!(U anchornamerz!U#eventsr{!Urefurir|!jh\]r}!hZ]r~!hV]r!hX]r!h^]r!Uinternalr!uhgjn!h`]r!hbXEventsr!r!}r!(hSXEventsr!hgjw!ubahhj\ubahhj]ubahhjubj8)r!}r!(hSUhT}r!(hV]r!hX]r!hZ]r!h\]r!h^]r!uhgj!h`]r!jB)r!}r!(hSUhT}r!(hV]r!hX]r!hZ]r!h\]r!h^]r!uhgj!h`]r!jL)r!}r!(hSUhT}r!(U anchornamer!U #functionsr!Urefurir!jh\]r!hZ]r!hV]r!hX]r!h^]r!Uinternalr!uhgj!h`]r!hbX Functionsr!r!}r!(hSX Functionsr!hgj!ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubj!j.)r!}r!(hSUhT}r!(hV]r!hX]r!hZ]r!h\]r!h^]r!uh`]r!j8)r!}r!(hSUhT}r!(hV]r!hX]r!hZ]r!h\]r!h^]r!uhgj!h`]r!jB)r!}r!(hSUhT}r!(hV]r!hX]r!hZ]r!h\]r!h^]r!uhgj!h`]r!jL)r!}r!(hSUhT}r!(U anchornamer!UUrefurir!j!h\]r!hZ]r!hV]r!hX]r!h^]r!Uinternalr!uhgj!h`]r!hbX Debuggingr!r!}r!(hSj.hgj!ubahhj\ubahhj]ubahhjubahhjubj/j.)r!}r!(hSUhT}r!(hV]r!hX]r!hZ]r!h\]r!h^]r!uh`]r!j8)r!}r!(hSUhT}r!(hV]r!hX]r!hZ]r!h\]r!h^]r!uhgj!h`]r!(jB)r!}r!(hSUhT}r!(hV]r!hX]r!hZ]r!h\]r!h^]r!uhgj!h`]r!jL)r!}r!(hSUhT}r!(U anchornamer!UUrefurir!j/h\]r!hZ]r!hV]r!hX]r!h^]r!Uinternalr!uhgj!h`]r!(ht)r!}r!(hSXcircuits.core.managerr!hT}r!(hV]r"hX]r"hZ]r"h\]r"h^]r"uhgj!h`]r"hbXcircuits.core.managerr"r"}r"(hSUhgj!ubahhhubhbX -- Managerr "r "}r "(hSjIhgj!ubehhj\ubahhj]ubj.)r "}r "(hSUhT}r"(hV]r"hX]r"hZ]r"h\]r"h^]r"uhgj!h`]r"(j8)r"}r"(hSUhT}r"(hV]r"hX]r"hZ]r"h\]r"h^]r"uhgj "h`]r"jB)r"}r"(hSUhT}r "(hV]r!"hX]r""hZ]r#"h\]r$"h^]r%"uhgj"h`]r&"jL)r'"}r("(hSUhT}r)"(U anchornamer*"U#classesr+"Urefurir,"j/h\]r-"hZ]r."hV]r/"hX]r0"h^]r1"Uinternalr2"uhgj"h`]r3"hbXClassesr4"r5"}r6"(hSXClassesr7"hgj'"ubahhj\ubahhj]ubahhjubj8)r8"}r9"(hSUhT}r:"(hV]r;"hX]r<"hZ]r="h\]r>"h^]r?"uhgj "h`]r@"jB)rA"}rB"(hSUhT}rC"(hV]rD"hX]rE"hZ]rF"h\]rG"h^]rH"uhgj8"h`]rI"jL)rJ"}rK"(hSUhT}rL"(U anchornamerM"U #componentsrN"UrefurirO"j/h\]rP"hZ]rQ"hV]rR"hX]rS"h^]rT"UinternalrU"uhgjA"h`]rV"hbX ComponentsrW"rX"}rY"(hSX ComponentsrZ"hgjJ"ubahhj\ubahhj]ubahhjubj8)r["}r\"(hSUhT}r]"(hV]r^"hX]r_"hZ]r`"h\]ra"h^]rb"uhgj "h`]rc"jB)rd"}re"(hSUhT}rf"(hV]rg"hX]rh"hZ]ri"h\]rj"h^]rk"uhgj["h`]rl"jL)rm"}rn"(hSUhT}ro"(U anchornamerp"U#eventsrq"Urefurirr"j/h\]rs"hZ]rt"hV]ru"hX]rv"h^]rw"Uinternalrx"uhgjd"h`]ry"hbXEventsrz"r{"}r|"(hSXEventsr}"hgjm"ubahhj\ubahhj]ubahhjubj8)r~"}r"(hSUhT}r"(hV]r"hX]r"hZ]r"h\]r"h^]r"uhgj "h`]r"jB)r"}r"(hSUhT}r"(hV]r"hX]r"hZ]r"h\]r"h^]r"uhgj~"h`]r"jL)r"}r"(hSUhT}r"(U anchornamer"U #functionsr"Urefurir"j/h\]r"hZ]r"hV]r"hX]r"h^]r"Uinternalr"uhgj"h`]r"hbX Functionsr"r"}r"(hSX Functionsr"hgj"ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjJj.)r"}r"(hSUhT}r"(hV]r"hX]r"hZ]r"h\]r"h^]r"uh`]r"j8)r"}r"(hSUhT}r"(hV]r"hX]r"hZ]r"h\]r"h^]r"uhgj"h`]r"jB)r"}r"(hSUhT}r"(hV]r"hX]r"hZ]r"h\]r"h^]r"uhgj"h`]r"jL)r"}r"(hSUhT}r"(U anchornamer"UUrefurir"jJh\]r"hZ]r"hV]r"hX]r"h^]r"Uinternalr"uhgj"h`]r"hbXManagerr"r"}r"(hSjWhgj"ubahhj\ubahhj]ubahhjubahhjubjXj.)r"}r"(hSUhT}r"(hV]r"hX]r"hZ]r"h\]r"h^]r"uh`]r"j8)r"}r"(hSUhT}r"(hV]r"hX]r"hZ]r"h\]r"h^]r"uhgj"h`]r"jB)r"}r"(hSUhT}r"(hV]r"hX]r"hZ]r"h\]r"h^]r"uhgj"h`]r"jL)r"}r"(hSUhT}r"(U anchornamer"UUrefurir"jXh\]r"hZ]r"hV]r"hX]r"h^]r"Uinternalr"uhgj"h`]r"hbXDocumentation TODOr"r"}r"(hSjehgj"ubahhj\ubahhj]ubahhjubahhjubjfj.)r"}r"(hSUhT}r"(hV]r"hX]r"hZ]r"h\]r"h^]r"uh`]r"j8)r"}r"(hSUhT}r#(hV]r#hX]r#hZ]r#h\]r#h^]r#uhgj"h`]r#(jB)r#}r#(hSUhT}r #(hV]r #hX]r #hZ]r #h\]r #h^]r#uhgj"h`]r#jL)r#}r#(hSUhT}r#(U anchornamer#UUrefurir#jfh\]r#hZ]r#hV]r#hX]r#h^]r#Uinternalr#uhgj#h`]r#(ht)r#}r#(hSXcircuits.node.eventsr#hT}r#(hV]r #hX]r!#hZ]r"#h\]r##h^]r$#uhgj#h`]r%#hbXcircuits.node.eventsr&#r'#}r(#(hSUhgj#ubahhhubhbX -- Eventsr)#r*#}r+#(hSjhgj#ubehhj\ubahhj]ubj.)r,#}r-#(hSUhT}r.#(hV]r/#hX]r0#hZ]r1#h\]r2#h^]r3#uhgj"h`]r4#(j8)r5#}r6#(hSUhT}r7#(hV]r8#hX]r9#hZ]r:#h\]r;#h^]r<#uhgj,#h`]r=#jB)r>#}r?#(hSUhT}r@#(hV]rA#hX]rB#hZ]rC#h\]rD#h^]rE#uhgj5#h`]rF#jL)rG#}rH#(hSUhT}rI#(U anchornamerJ#U#eventsrK#UrefurirL#jfh\]rM#hZ]rN#hV]rO#hX]rP#h^]rQ#UinternalrR#uhgj>#h`]rS#hbXEventsrT#rU#}rV#(hSXEventsrW#hgjG#ubahhj\ubahhj]ubahhjubj8)rX#}rY#(hSUhT}rZ#(hV]r[#hX]r\#hZ]r]#h\]r^#h^]r_#uhgj,#h`]r`#jB)ra#}rb#(hSUhT}rc#(hV]rd#hX]re#hZ]rf#h\]rg#h^]rh#uhgjX#h`]ri#jL)rj#}rk#(hSUhT}rl#(U anchornamerm#U #componentsrn#Urefuriro#jfh\]rp#hZ]rq#hV]rr#hX]rs#h^]rt#Uinternalru#uhgja#h`]rv#hbX Componentsrw#rx#}ry#(hSX Componentsrz#hgjj#ubahhj\ubahhj]ubahhjubj8)r{#}r|#(hSUhT}r}#(hV]r~#hX]r#hZ]r#h\]r#h^]r#uhgj,#h`]r#jB)r#}r#(hSUhT}r#(hV]r#hX]r#hZ]r#h\]r#h^]r#uhgj{#h`]r#jL)r#}r#(hSUhT}r#(U anchornamer#U #functionsr#Urefurir#jfh\]r#hZ]r#hV]r#hX]r#h^]r#Uinternalr#uhgj#h`]r#hbX Functionsr#r#}r#(hSX Functionsr#hgj#ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r#}r#(hSUhT}r#(hV]r#hX]r#hZ]r#h\]r#h^]r#uh`]r#j8)r#}r#(hSUhT}r#(hV]r#hX]r#hZ]r#h\]r#h^]r#uhgj#h`]r#(jB)r#}r#(hSUhT}r#(hV]r#hX]r#hZ]r#h\]r#h^]r#uhgj#h`]r#jL)r#}r#(hSUhT}r#(U anchornamer#UUrefurir#jh\]r#hZ]r#hV]r#hX]r#h^]r#Uinternalr#uhgj#h`]r#(ht)r#}r#(hSXcircuits.core.valuesr#hT}r#(hV]r#hX]r#hZ]r#h\]r#h^]r#uhgj#h`]r#hbXcircuits.core.valuesr#r#}r#(hSUhgj#ubahhhubhbX -- Valuer#r#}r#(hSjhgj#ubehhj\ubahhj]ubj.)r#}r#(hSUhT}r#(hV]r#hX]r#hZ]r#h\]r#h^]r#uhgj#h`]r#(j8)r#}r#(hSUhT}r#(hV]r#hX]r#hZ]r#h\]r#h^]r#uhgj#h`]r#jB)r#}r#(hSUhT}r#(hV]r#hX]r#hZ]r#h\]r#h^]r#uhgj#h`]r#jL)r#}r#(hSUhT}r#(U anchornamer#U#classesr#Urefurir#jh\]r#hZ]r#hV]r#hX]r#h^]r#Uinternalr#uhgj#h`]r#hbXClassesr#r#}r#(hSXClassesr$hgj#ubahhj\ubahhj]ubahhjubj8)r$}r$(hSUhT}r$(hV]r$hX]r$hZ]r$h\]r$h^]r$uhgj#h`]r $jB)r $}r $(hSUhT}r $(hV]r $hX]r$hZ]r$h\]r$h^]r$uhgj$h`]r$jL)r$}r$(hSUhT}r$(U anchornamer$U #componentsr$Urefurir$jh\]r$hZ]r$hV]r$hX]r$h^]r$Uinternalr$uhgj $h`]r$hbX Componentsr $r!$}r"$(hSX Componentsr#$hgj$ubahhj\ubahhj]ubahhjubj8)r$$}r%$(hSUhT}r&$(hV]r'$hX]r($hZ]r)$h\]r*$h^]r+$uhgj#h`]r,$jB)r-$}r.$(hSUhT}r/$(hV]r0$hX]r1$hZ]r2$h\]r3$h^]r4$uhgj$$h`]r5$jL)r6$}r7$(hSUhT}r8$(U anchornamer9$U#eventsr:$Urefurir;$jh\]r<$hZ]r=$hV]r>$hX]r?$h^]r@$UinternalrA$uhgj-$h`]rB$hbXEventsrC$rD$}rE$(hSXEventsrF$hgj6$ubahhj\ubahhj]ubahhjubj8)rG$}rH$(hSUhT}rI$(hV]rJ$hX]rK$hZ]rL$h\]rM$h^]rN$uhgj#h`]rO$jB)rP$}rQ$(hSUhT}rR$(hV]rS$hX]rT$hZ]rU$h\]rV$h^]rW$uhgjG$h`]rX$jL)rY$}rZ$(hSUhT}r[$(U anchornamer\$U #functionsr]$Urefurir^$jh\]r_$hZ]r`$hV]ra$hX]rb$h^]rc$Uinternalrd$uhgjP$h`]re$hbX Functionsrf$rg$}rh$(hSX Functionsri$hgjY$ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)rj$}rk$(hSUhT}rl$(hV]rm$hX]rn$hZ]ro$h\]rp$h^]rq$uh`]rr$j8)rs$}rt$(hSUhT}ru$(hV]rv$hX]rw$hZ]rx$h\]ry$h^]rz$uhgjj$h`]r{$(jB)r|$}r}$(hSUhT}r~$(hV]r$hX]r$hZ]r$h\]r$h^]r$uhgjs$h`]r$jL)r$}r$(hSUhT}r$(U anchornamer$UUrefurir$jh\]r$hZ]r$hV]r$hX]r$h^]r$Uinternalr$uhgj|$h`]r$(hbX circuits r$r$}r$(hSjhgj$ubhbX2.1.0r$r$}r$(hSjhgj$ubhbX Documentationr$r$}r$(hSjhgj$ubehhj\ubahhj]ubj.)r$}r$(hSUhT}r$(hV]r$hX]r$hZ]r$h\]r$h^]r$uhgjs$h`]r$(j8)r$}r$(hSUhT}r$(hV]r$hX]r$hZ]r$h\]r$h^]r$uhgj$h`]r$jB)r$}r$(hSUhT}r$(hV]r$hX]r$hZ]r$h\]r$h^]r$uhgj$h`]r$jL)r$}r$(hSUhT}r$(U anchornamer$U #overviewr$Urefurir$jh\]r$hZ]r$hV]r$hX]r$h^]r$Uinternalr$uhgj$h`]r$hbXOverviewr$r$}r$(hSXOverviewr$hgj$ubahhj\ubahhj]ubahhjubj8)r$}r$(hSUhT}r$(hV]r$hX]r$hZ]r$h\]r$h^]r$uhgj$h`]r$jB)r$}r$(hSUhT}r$(hV]r$hX]r$hZ]r$h\]r$h^]r$uhgj$h`]r$jL)r$}r$(hSUhT}r$(U anchornamer$U #featuresr$Urefurir$jh\]r$hZ]r$hV]r$hX]r$h^]r$Uinternalr$uhgj$h`]r$hbXFeaturesr$r$}r$(hSXFeaturesr$hgj$ubahhj\ubahhj]ubahhjubj8)r$}r$(hSUhT}r$(hV]r$hX]r$hZ]r$h\]r$h^]r$uhgj$h`]r$jB)r$}r$(hSUhT}r$(hV]r$hX]r$hZ]r$h\]r$h^]r$uhgj$h`]r$jL)r$}r$(hSUhT}r$(U anchornamer$U #requirementsr$Urefurir%jh\]r%hZ]r%hV]r%hX]r%h^]r%Uinternalr%uhgj$h`]r%hbX Requirementsr%r %}r %(hSX Requirementsr %hgj$ubahhj\ubahhj]ubahhjubj8)r %}r %(hSUhT}r%(hV]r%hX]r%hZ]r%h\]r%h^]r%uhgj$h`]r%jB)r%}r%(hSUhT}r%(hV]r%hX]r%hZ]r%h\]r%h^]r%uhgj %h`]r%jL)r%}r%(hSUhT}r %(U anchornamer!%U#supported-platformsr"%Urefurir#%jh\]r$%hZ]r%%hV]r&%hX]r'%h^]r(%Uinternalr)%uhgj%h`]r*%hbXSupported Platformsr+%r,%}r-%(hSXSupported Platformsr.%hgj%ubahhj\ubahhj]ubahhjubj8)r/%}r0%(hSUhT}r1%(hV]r2%hX]r3%hZ]r4%h\]r5%h^]r6%uhgj$h`]r7%jB)r8%}r9%(hSUhT}r:%(hV]r;%hX]r<%hZ]r=%h\]r>%h^]r?%uhgj/%h`]r@%jL)rA%}rB%(hSUhT}rC%(U anchornamerD%U #installationrE%UrefurirF%jh\]rG%hZ]rH%hV]rI%hX]rJ%h^]rK%UinternalrL%uhgj8%h`]rM%hbX InstallationrN%rO%}rP%(hSX InstallationrQ%hgjA%ubahhj\ubahhj]ubahhjubj8)rR%}rS%(hSUhT}rT%(hV]rU%hX]rV%hZ]rW%h\]rX%h^]rY%uhgj$h`]rZ%jB)r[%}r\%(hSUhT}r]%(hV]r^%hX]r_%hZ]r`%h\]ra%h^]rb%uhgjR%h`]rc%jL)rd%}re%(hSUhT}rf%(U anchornamerg%U#licenserh%Urefuriri%jh\]rj%hZ]rk%hV]rl%hX]rm%h^]rn%Uinternalro%uhgj[%h`]rp%hbXLicenserq%rr%}rs%(hSXLicensert%hgjd%ubahhj\ubahhj]ubahhjubj8)ru%}rv%(hSUhT}rw%(hV]rx%hX]ry%hZ]rz%h\]r{%h^]r|%uhgj$h`]r}%jB)r~%}r%(hSUhT}r%(hV]r%hX]r%hZ]r%h\]r%h^]r%uhgju%h`]r%jL)r%}r%(hSUhT}r%(U anchornamer%U #feedbackr%Urefurir%jh\]r%hZ]r%hV]r%hX]r%h^]r%Uinternalr%uhgj~%h`]r%hbXFeedbackr%r%}r%(hSXFeedbackr%hgj%ubahhj\ubahhj]ubahhjubj8)r%}r%(hSUhT}r%(hV]r%hX]r%hZ]r%h\]r%h^]r%uhgj$h`]r%(jB)r%}r%(hSUhT}r%(hV]r%hX]r%hZ]r%h\]r%h^]r%uhgj%h`]r%jL)r%}r%(hSUhT}r%(U anchornamer%U #communityr%Urefurir%jh\]r%hZ]r%hV]r%hX]r%h^]r%Uinternalr%uhgj%h`]r%hbX Communityr%r%}r%(hSX Communityr%hgj%ubahhj\ubahhj]ubj.)r%}r%(hSUhT}r%(hV]r%hX]r%hZ]r%h\]r%h^]r%uhgj%h`]r%(j8)r%}r%(hSUhT}r%(hV]r%hX]r%hZ]r%h\]r%h^]r%uhgj%h`]r%(jB)r%}r%(hSUhT}r%(hV]r%hX]r%hZ]r%h\]r%h^]r%uhgj%h`]r%jL)r%}r%(hSUhT}r%(U anchornamer%U #contentsr%Urefurir%jh\]r%hZ]r%hV]r%hX]r%h^]r%Uinternalr%uhgj%h`]r%hbXContentsr%r%}r%(hSXContentsr%hgj%ubahhj\ubahhj]ubj.)r%}r%(hSUhT}r%(hV]r%hX]r%hZ]r%h\]r%h^]r%uhgj%h`]r%(jg)r%}r%(hSUhT}r%(Unumberedr%KUparentr%jU titlesonlyr%Uglobr%h\]r%hZ]r%hV]r%hX]r%h^]r%Uentriesr%]r%(Njr%Njr%Njr&Njr&Njr&Njr&Njr&Njr&Njr&Njr&Njr&eUhiddenr &U includefilesr &]r &(jjjjjjjjjjjeUmaxdepthr &Kuhgj%h`]r &hhj~ubjg)r&}r&(hSUhT}r&(Unumberedr&KUparentr&jU titlesonlyr&Uglobr&h\]r&hZ]r&hV]r&hX]r&h^]r&Uentriesr&]r&(Njr&Njr&eUhiddenr&U includefilesr&]r &(jjeUmaxdepthr!&Juhgj%h`]r"&hhj~ubjg)r#&}r$&(hSUhT}r%&(Unumberedr&&KUparentr'&jU titlesonlyr(&Uglobr)&h\]r*&hZ]r+&hV]r,&hX]r-&h^]r.&Uentriesr/&]r0&(Njr1&Njr2&eUhiddenr3&U includefilesr4&]r5&(jjeUmaxdepthr6&Juhgj%h`]r7&hhj~ubehhjubehhjubj8)r8&}r9&(hSUhT}r:&(hV]r;&hX]r<&hZ]r=&h\]r>&h^]r?&uhgj%h`]r@&jB)rA&}rB&(hSUhT}rC&(hV]rD&hX]rE&hZ]rF&h\]rG&h^]rH&uhgj8&h`]rI&jL)rJ&}rK&(hSUhT}rL&(U anchornamerM&U#indices-and-tablesrN&UrefurirO&jh\]rP&hZ]rQ&hV]rR&hX]rS&h^]rT&UinternalrU&uhgjA&h`]rV&hbXIndices and tablesrW&rX&}rY&(hSXIndices and tablesrZ&hgjJ&ubahhj\ubahhj]ubahhjubehhjubehhjubehhjubehhjubahhjubjj.)r[&}r\&(hSUhT}r]&(hV]r^&hX]r_&hZ]r`&h\]ra&h^]rb&uh`]rc&j8)rd&}re&(hSUhT}rf&(hV]rg&hX]rh&hZ]ri&h\]rj&h^]rk&uhgj[&h`]rl&(jB)rm&}rn&(hSUhT}ro&(hV]rp&hX]rq&hZ]rr&h\]rs&h^]rt&uhgjd&h`]ru&jL)rv&}rw&(hSUhT}rx&(U anchornamery&UUrefurirz&jh\]r{&hZ]r|&hV]r}&hX]r~&h^]r&Uinternalr&uhgjm&h`]r&hbXContributing to circuitsr&r&}r&(hSjhgjv&ubahhj\ubahhj]ubj.)r&}r&(hSUhT}r&(hV]r&hX]r&hZ]r&h\]r&h^]r&uhgjd&h`]r&(j8)r&}r&(hSUhT}r&(hV]r&hX]r&hZ]r&h\]r&h^]r&uhgj&h`]r&jB)r&}r&(hSUhT}r&(hV]r&hX]r&hZ]r&h\]r&h^]r&uhgj&h`]r&jL)r&}r&(hSUhT}r&(U anchornamer&U#share-your-storyr&Urefurir&jh\]r&hZ]r&hV]r&hX]r&h^]r&Uinternalr&uhgj&h`]r&hbXShare your storyr&r&}r&(hSXShare your storyr&hgj&ubahhj\ubahhj]ubahhjubj8)r&}r&(hSUhT}r&(hV]r&hX]r&hZ]r&h\]r&h^]r&uhgj&h`]r&jB)r&}r&(hSUhT}r&(hV]r&hX]r&hZ]r&h\]r&h^]r&uhgj&h`]r&jL)r&}r&(hSUhT}r&(U anchornamer&U#submitting-bug-reportsr&Urefurir&jh\]r&hZ]r&hV]r&hX]r&h^]r&Uinternalr&uhgj&h`]r&hbXSubmitting Bug Reportsr&r&}r&(hSXSubmitting Bug Reportsr&hgj&ubahhj\ubahhj]ubahhjubj8)r&}r&(hSUhT}r&(hV]r&hX]r&hZ]r&h\]r&h^]r&uhgj&h`]r&jB)r&}r&(hSUhT}r&(hV]r&hX]r&hZ]r&h\]r&h^]r&uhgj&h`]r&jL)r&}r&(hSUhT}r&(U anchornamer&U#writing-new-testsr&Urefurir&jh\]r&hZ]r&hV]r&hX]r&h^]r&Uinternalr&uhgj&h`]r&hbXWriting new testsr&r&}r&(hSXWriting new testsr&hgj&ubahhj\ubahhj]ubahhjubj8)r&}r&(hSUhT}r&(hV]r&hX]r&hZ]r&h\]r&h^]r&uhgj&h`]r&jB)r'}r'(hSUhT}r'(hV]r'hX]r'hZ]r'h\]r'h^]r'uhgj&h`]r'jL)r '}r '(hSUhT}r '(U anchornamer 'U#adding-new-featuresr 'Urefurir'jh\]r'hZ]r'hV]r'hX]r'h^]r'Uinternalr'uhgj'h`]r'hbXAdding New Featuresr'r'}r'(hSXAdding New Featuresr'hgj 'ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r'}r'(hSUhT}r'(hV]r'hX]r'hZ]r'h\]r 'h^]r!'uh`]r"'j8)r#'}r$'(hSUhT}r%'(hV]r&'hX]r''hZ]r('h\]r)'h^]r*'uhgj'h`]r+'(jB)r,'}r-'(hSUhT}r.'(hV]r/'hX]r0'hZ]r1'h\]r2'h^]r3'uhgj#'h`]r4'jL)r5'}r6'(hSUhT}r7'(U anchornamer8'UUrefurir9'jh\]r:'hZ]r;'hV]r<'hX]r='h^]r>'Uinternalr?'uhgj,'h`]r@'(ht)rA'}rB'(hSXcircuits.web.sessionsrC'hT}rD'(hV]rE'hX]rF'hZ]rG'h\]rH'h^]rI'uhgj5'h`]rJ'hbXcircuits.web.sessionsrK'rL'}rM'(hSUhgjA'ubahhhubhbX -- SessionsrN'rO'}rP'(hSjhgj5'ubehhj\ubahhj]ubj.)rQ'}rR'(hSUhT}rS'(hV]rT'hX]rU'hZ]rV'h\]rW'h^]rX'uhgj#'h`]rY'(j8)rZ'}r['(hSUhT}r\'(hV]r]'hX]r^'hZ]r_'h\]r`'h^]ra'uhgjQ'h`]rb'jB)rc'}rd'(hSUhT}re'(hV]rf'hX]rg'hZ]rh'h\]ri'h^]rj'uhgjZ'h`]rk'jL)rl'}rm'(hSUhT}rn'(U anchornamero'U#eventsrp'Urefurirq'jh\]rr'hZ]rs'hV]rt'hX]ru'h^]rv'Uinternalrw'uhgjc'h`]rx'hbXEventsry'rz'}r{'(hSXEventsr|'hgjl'ubahhj\ubahhj]ubahhjubj8)r}'}r~'(hSUhT}r'(hV]r'hX]r'hZ]r'h\]r'h^]r'uhgjQ'h`]r'jB)r'}r'(hSUhT}r'(hV]r'hX]r'hZ]r'h\]r'h^]r'uhgj}'h`]r'jL)r'}r'(hSUhT}r'(U anchornamer'U #componentsr'Urefurir'jh\]r'hZ]r'hV]r'hX]r'h^]r'Uinternalr'uhgj'h`]r'hbX Componentsr'r'}r'(hSX Componentsr'hgj'ubahhj\ubahhj]ubahhjubj8)r'}r'(hSUhT}r'(hV]r'hX]r'hZ]r'h\]r'h^]r'uhgjQ'h`]r'jB)r'}r'(hSUhT}r'(hV]r'hX]r'hZ]r'h\]r'h^]r'uhgj'h`]r'jL)r'}r'(hSUhT}r'(U anchornamer'U #functionsr'Urefurir'jh\]r'hZ]r'hV]r'hX]r'h^]r'Uinternalr'uhgj'h`]r'hbX Functionsr'r'}r'(hSX Functionsr'hgj'ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r'}r'(hSUhT}r'(hV]r'hX]r'hZ]r'h\]r'h^]r'uh`]r'j8)r'}r'(hSUhT}r'(hV]r'hX]r'hZ]r'h\]r'h^]r'uhgj'h`]r'(jB)r'}r'(hSUhT}r'(hV]r'hX]r'hZ]r'h\]r'h^]r'uhgj'h`]r'jL)r'}r'(hSUhT}r'(U anchornamer'UUrefurir'jh\]r'hZ]r'hV]r'hX]r'h^]r'Uinternalr'uhgj'h`]r'(ht)r'}r'(hSXcircuits.core.timersr'hT}r'(hV]r'hX]r'hZ]r'h\]r'h^]r'uhgj'h`]r'hbXcircuits.core.timersr'r'}r'(hSUhgj'ubahhhubhbX -- Timersr'r'}r'(hSjhgj'ubehhj\ubahhj]ubj.)r'}r'(hSUhT}r'(hV]r'hX]r'hZ]r'h\]r(h^]r(uhgj'h`]r((j8)r(}r((hSUhT}r((hV]r(hX]r(hZ]r(h\]r (h^]r (uhgj'h`]r (jB)r (}r ((hSUhT}r((hV]r(hX]r(hZ]r(h\]r(h^]r(uhgj(h`]r(jL)r(}r((hSUhT}r((U anchornamer(U#classesr(Urefurir(jh\]r(hZ]r(hV]r(hX]r(h^]r(Uinternalr (uhgj (h`]r!(hbXClassesr"(r#(}r$((hSXClassesr%(hgj(ubahhj\ubahhj]ubahhjubj8)r&(}r'((hSUhT}r(((hV]r)(hX]r*(hZ]r+(h\]r,(h^]r-(uhgj'h`]r.(jB)r/(}r0((hSUhT}r1((hV]r2(hX]r3(hZ]r4(h\]r5(h^]r6(uhgj&(h`]r7(jL)r8(}r9((hSUhT}r:((U anchornamer;(U #componentsr<(Urefurir=(jh\]r>(hZ]r?(hV]r@(hX]rA(h^]rB(UinternalrC(uhgj/(h`]rD(hbX ComponentsrE(rF(}rG((hSX ComponentsrH(hgj8(ubahhj\ubahhj]ubahhjubj8)rI(}rJ((hSUhT}rK((hV]rL(hX]rM(hZ]rN(h\]rO(h^]rP(uhgj'h`]rQ(jB)rR(}rS((hSUhT}rT((hV]rU(hX]rV(hZ]rW(h\]rX(h^]rY(uhgjI(h`]rZ(jL)r[(}r\((hSUhT}r]((U anchornamer^(U#eventsr_(Urefurir`(jh\]ra(hZ]rb(hV]rc(hX]rd(h^]re(Uinternalrf(uhgjR(h`]rg(hbXEventsrh(ri(}rj((hSXEventsrk(hgj[(ubahhj\ubahhj]ubahhjubj8)rl(}rm((hSUhT}rn((hV]ro(hX]rp(hZ]rq(h\]rr(h^]rs(uhgj'h`]rt(jB)ru(}rv((hSUhT}rw((hV]rx(hX]ry(hZ]rz(h\]r{(h^]r|(uhgjl(h`]r}(jL)r~(}r((hSUhT}r((U anchornamer(U #functionsr(Urefurir(jh\]r(hZ]r(hV]r(hX]r(h^]r(Uinternalr(uhgju(h`]r(hbX Functionsr(r(}r((hSX Functionsr(hgj~(ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r(}r((hSUhT}r((hV]r(hX]r(hZ]r(h\]r(h^]r(uh`]r(j8)r(}r((hSUhT}r((hV]r(hX]r(hZ]r(h\]r(h^]r(uhgj(h`]r((jB)r(}r((hSUhT}r((hV]r(hX]r(hZ]r(h\]r(h^]r(uhgj(h`]r(jL)r(}r((hSUhT}r((U anchornamer(UUrefurir(jh\]r(hZ]r(hV]r(hX]r(h^]r(Uinternalr(uhgj(h`]r((ht)r(}r((hSXcircuits.web.wrappersr(hT}r((hV]r(hX]r(hZ]r(h\]r(h^]r(uhgj(h`]r(hbXcircuits.web.wrappersr(r(}r((hSUhgj(ubahhhubhbX -- Request/Response Objectsr(r(}r((hSjhgj(ubehhj\ubahhj]ubj.)r(}r((hSUhT}r((hV]r(hX]r(hZ]r(h\]r(h^]r(uhgj(h`]r((j8)r(}r((hSUhT}r((hV]r(hX]r(hZ]r(h\]r(h^]r(uhgj(h`]r(jB)r(}r((hSUhT}r((hV]r(hX]r(hZ]r(h\]r(h^]r(uhgj(h`]r(jL)r(}r((hSUhT}r((U anchornamer(U#eventsr(Urefurir(jh\]r(hZ]r(hV]r(hX]r(h^]r(Uinternalr(uhgj(h`]r(hbXEventsr(r(}r((hSXEventsr(hgj(ubahhj\ubahhj]ubahhjubj8)r(}r((hSUhT}r((hV]r(hX]r(hZ]r(h\]r(h^]r(uhgj(h`]r(jB)r(}r((hSUhT}r((hV]r(hX]r(hZ]r)h\]r)h^]r)uhgj(h`]r)jL)r)}r)(hSUhT}r)(U anchornamer)U#classesr)Urefurir )jh\]r )hZ]r )hV]r )hX]r )h^]r)Uinternalr)uhgj(h`]r)hbXClassesr)r)}r)(hSXClassesr)hgj)ubahhj\ubahhj]ubahhjubj8)r)}r)(hSUhT}r)(hV]r)hX]r)hZ]r)h\]r)h^]r)uhgj(h`]r)jB)r)}r)(hSUhT}r )(hV]r!)hX]r")hZ]r#)h\]r$)h^]r%)uhgj)h`]r&)jL)r')}r()(hSUhT}r))(U anchornamer*)U #componentsr+)Urefurir,)jh\]r-)hZ]r.)hV]r/)hX]r0)h^]r1)Uinternalr2)uhgj)h`]r3)hbX Componentsr4)r5)}r6)(hSX Componentsr7)hgj')ubahhj\ubahhj]ubahhjubj8)r8)}r9)(hSUhT}r:)(hV]r;)hX]r<)hZ]r=)h\]r>)h^]r?)uhgj(h`]r@)jB)rA)}rB)(hSUhT}rC)(hV]rD)hX]rE)hZ]rF)h\]rG)h^]rH)uhgj8)h`]rI)jL)rJ)}rK)(hSUhT}rL)(U anchornamerM)U #functionsrN)UrefurirO)jh\]rP)hZ]rQ)hV]rR)hX]rS)h^]rT)UinternalrU)uhgjA)h`]rV)hbX FunctionsrW)rX)}rY)(hSX FunctionsrZ)hgjJ)ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubhj.)r[)}r\)(hSUhT}r])(hV]r^)hX]r_)hZ]r`)h\]ra)h^]rb)uh`]rc)j8)rd)}re)(hSUhT}rf)(hV]rg)hX]rh)hZ]ri)h\]rj)h^]rk)uhgj[)h`]rl)(jB)rm)}rn)(hSUhT}ro)(hV]rp)hX]rq)hZ]rr)h\]rs)h^]rt)uhgjd)h`]ru)jL)rv)}rw)(hSUhT}rx)(U anchornamery)UUrefurirz)hh\]r{)hZ]r|)hV]r})hX]r~)h^]r)Uinternalr)uhgjm)h`]r)hbXTutorialr)r)}r)(hSjhgjv)ubahhj\ubahhj]ubj.)r)}r)(hSUhT}r)(hV]r)hX]r)hZ]r)h\]r)h^]r)uhgjd)h`]r)(j8)r)}r)(hSUhT}r)(hV]r)hX]r)hZ]r)h\]r)h^]r)uhgj)h`]r)jB)r)}r)(hSUhT}r)(hV]r)hX]r)hZ]r)h\]r)h^]r)uhgj)h`]r)jL)r)}r)(hSUhT}r)(U anchornamer)U #overviewr)Urefurir)hh\]r)hZ]r)hV]r)hX]r)h^]r)Uinternalr)uhgj)h`]r)hbXOverviewr)r)}r)(hSXOverviewr)hgj)ubahhj\ubahhj]ubahhjubj8)r)}r)(hSUhT}r)(hV]r)hX]r)hZ]r)h\]r)h^]r)uhgj)h`]r)jB)r)}r)(hSUhT}r)(hV]r)hX]r)hZ]r)h\]r)h^]r)uhgj)h`]r)jL)r)}r)(hSUhT}r)(U anchornamer)U#the-componentr)Urefurir)hh\]r)hZ]r)hV]r)hX]r)h^]r)Uinternalr)uhgj)h`]r)hbX The Componentr)r)}r)(hSX The Componentr)hgj)ubahhj\ubahhj]ubahhjubj8)r)}r)(hSUhT}r)(hV]r)hX]r)hZ]r)h\]r)h^]r)uhgj)h`]r)jB)r)}r)(hSUhT}r)(hV]r)hX]r)hZ]r)h\]r)h^]r)uhgj)h`]r)jL)r)}r)(hSUhT}r)(U anchornamer)U#event-handlersr)Urefurir)hh\]r)hZ]r)hV]r)hX]r)h^]r)Uinternalr)uhgj)h`]r)hbXEvent Handlersr)r)}r)(hSXEvent Handlersr)hgj)ubahhj\ubahhj]ubahhjubj8)r)}r)(hSUhT}r)(hV]r)hX]r)hZ]r)h\]r)h^]r)uhgj)h`]r)jB)r*}r*(hSUhT}r*(hV]r*hX]r*hZ]r*h\]r*h^]r*uhgj)h`]r*jL)r *}r *(hSUhT}r *(U anchornamer *U#registering-componentsr *Urefurir*hh\]r*hZ]r*hV]r*hX]r*h^]r*Uinternalr*uhgj*h`]r*hbXRegistering Componentsr*r*}r*(hSXRegistering Componentsr*hgj *ubahhj\ubahhj]ubahhjubj8)r*}r*(hSUhT}r*(hV]r*hX]r*hZ]r*h\]r *h^]r!*uhgj)h`]r"*jB)r#*}r$*(hSUhT}r%*(hV]r&*hX]r'*hZ]r(*h\]r)*h^]r**uhgj*h`]r+*jL)r,*}r-*(hSUhT}r.*(U anchornamer/*U#complex-componentsr0*Urefurir1*hh\]r2*hZ]r3*hV]r4*hX]r5*h^]r6*Uinternalr7*uhgj#*h`]r8*hbXComplex Componentsr9*r:*}r;*(hSXComplex Componentsr<*hgj,*ubahhj\ubahhj]ubahhjubj8)r=*}r>*(hSUhT}r?*(hV]r@*hX]rA*hZ]rB*h\]rC*h^]rD*uhgj)h`]rE*jB)rF*}rG*(hSUhT}rH*(hV]rI*hX]rJ*hZ]rK*h\]rL*h^]rM*uhgj=*h`]rN*jL)rO*}rP*(hSUhT}rQ*(U anchornamerR*U#component-inheritancerS*UrefurirT*hh\]rU*hZ]rV*hV]rW*hX]rX*h^]rY*UinternalrZ*uhgjF*h`]r[*hbXComponent Inheritancer\*r]*}r^*(hSXComponent Inheritancer_*hgjO*ubahhj\ubahhj]ubahhjubj8)r`*}ra*(hSUhT}rb*(hV]rc*hX]rd*hZ]re*h\]rf*h^]rg*uhgj)h`]rh*jB)ri*}rj*(hSUhT}rk*(hV]rl*hX]rm*hZ]rn*h\]ro*h^]rp*uhgj`*h`]rq*jL)rr*}rs*(hSUhT}rt*(U anchornameru*U#component-channelsrv*Urefurirw*hh\]rx*hZ]ry*hV]rz*hX]r{*h^]r|*Uinternalr}*uhgji*h`]r~*hbXComponent Channelsr*r*}r*(hSXComponent Channelsr*hgjr*ubahhj\ubahhj]ubahhjubj8)r*}r*(hSUhT}r*(hV]r*hX]r*hZ]r*h\]r*h^]r*uhgj)h`]r*jB)r*}r*(hSUhT}r*(hV]r*hX]r*hZ]r*h\]r*h^]r*uhgj*h`]r*jL)r*}r*(hSUhT}r*(U anchornamer*U#event-objectsr*Urefurir*hh\]r*hZ]r*hV]r*hX]r*h^]r*Uinternalr*uhgj*h`]r*hbX Event Objectsr*r*}r*(hSX Event Objectsr*hgj*ubahhj\ubahhj]ubahhjubj8)r*}r*(hSUhT}r*(hV]r*hX]r*hZ]r*h\]r*h^]r*uhgj)h`]r*jB)r*}r*(hSUhT}r*(hV]r*hX]r*hZ]r*h\]r*h^]r*uhgj*h`]r*jL)r*}r*(hSUhT}r*(U anchornamer*U #the-debuggerr*Urefurir*hh\]r*hZ]r*hV]r*hX]r*h^]r*Uinternalr*uhgj*h`]r*hbX The Debuggerr*r*}r*(hSX The Debuggerr*hgj*ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r*}r*(hSUhT}r*(hV]r*hX]r*hZ]r*h\]r*h^]r*uh`]r*j8)r*}r*(hSUhT}r*(hV]r*hX]r*hZ]r*h\]r*h^]r*uhgj*h`]r*(jB)r*}r*(hSUhT}r*(hV]r*hX]r*hZ]r*h\]r*h^]r*uhgj*h`]r*jL)r*}r*(hSUhT}r*(U anchornamer*UUrefurir*jh\]r*hZ]r*hV]r*hX]r*h^]r*Uinternalr*uhgj*h`]r*hbXThe circuits Frameworkr*r*}r*(hSj+hgj*ubahhj\ubahhj]ubj.)r*}r*(hSUhT}r*(hV]r*hX]r*hZ]r*h\]r*h^]r*uhgj*h`]r*(jg)r*}r*(hSUhT}r*(Unumberedr*KUparentr+jU titlesonlyr+Uglobr+h\]r+hZ]r+hV]r+hX]r+h^]r+Uentriesr+]r +(Njr +Njr +Njr +eUhiddenr +U includefilesr+]r+(jjjeUmaxdepthr+Kuhgj*h`]r+hhj~ubjg)r+}r+(hSUhT}r+(Unumberedr+KUparentr+jU titlesonlyr+Uglobr+h\]r+hZ]r+hV]r+hX]r+h^]r+Uentriesr+]r+(Nj r +Nj r!+Nj r"+Nj r#+eUhiddenr$+U includefilesr%+]r&+(j j j j eUmaxdepthr'+Juhgj*h`]r(+hhj~ubehhjubehhjubahhjubj,j.)r)+}r*+(hSUhT}r++(hV]r,+hX]r-+hZ]r.+h\]r/+h^]r0+uh`]r1+j8)r2+}r3+(hSUhT}r4+(hV]r5+hX]r6+hZ]r7+h\]r8+h^]r9+uhgj)+h`]r:+(jB)r;+}r<+(hSUhT}r=+(hV]r>+hX]r?+hZ]r@+h\]rA+h^]rB+uhgj2+h`]rC+jL)rD+}rE+(hSUhT}rF+(U anchornamerG+UUrefurirH+j,h\]rI+hZ]rJ+hV]rK+hX]rL+h^]rM+UinternalrN+uhgj;+h`]rO+(ht)rP+}rQ+(hSXcircuits.web.errorsrR+hT}rS+(hV]rT+hX]rU+hZ]rV+h\]rW+h^]rX+uhgjD+h`]rY+hbXcircuits.web.errorsrZ+r[+}r\+(hSUhgjP+ubahhhubhbX -- Errorsr]+r^+}r_+(hSjFhgjD+ubehhj\ubahhj]ubj.)r`+}ra+(hSUhT}rb+(hV]rc+hX]rd+hZ]re+h\]rf+h^]rg+uhgj2+h`]rh+(j8)ri+}rj+(hSUhT}rk+(hV]rl+hX]rm+hZ]rn+h\]ro+h^]rp+uhgj`+h`]rq+jB)rr+}rs+(hSUhT}rt+(hV]ru+hX]rv+hZ]rw+h\]rx+h^]ry+uhgji+h`]rz+jL)r{+}r|+(hSUhT}r}+(U anchornamer~+U #componentsr+Urefurir+j,h\]r+hZ]r+hV]r+hX]r+h^]r+Uinternalr+uhgjr+h`]r+hbX Componentsr+r+}r+(hSX Componentsr+hgj{+ubahhj\ubahhj]ubahhjubj8)r+}r+(hSUhT}r+(hV]r+hX]r+hZ]r+h\]r+h^]r+uhgj`+h`]r+jB)r+}r+(hSUhT}r+(hV]r+hX]r+hZ]r+h\]r+h^]r+uhgj+h`]r+jL)r+}r+(hSUhT}r+(U anchornamer+U#eventsr+Urefurir+j,h\]r+hZ]r+hV]r+hX]r+h^]r+Uinternalr+uhgj+h`]r+hbXEventsr+r+}r+(hSXEventsr+hgj+ubahhj\ubahhj]ubahhjubj8)r+}r+(hSUhT}r+(hV]r+hX]r+hZ]r+h\]r+h^]r+uhgj`+h`]r+jB)r+}r+(hSUhT}r+(hV]r+hX]r+hZ]r+h\]r+h^]r+uhgj+h`]r+jL)r+}r+(hSUhT}r+(U anchornamer+U #functionsr+Urefurir+j,h\]r+hZ]r+hV]r+hX]r+h^]r+Uinternalr+uhgj+h`]r+hbX Functionsr+r+}r+(hSX Functionsr+hgj+ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjGj.)r+}r+(hSUhT}r+(hV]r+hX]r+hZ]r+h\]r+h^]r+uh`]r+j8)r+}r+(hSUhT}r+(hV]r+hX]r+hZ]r+h\]r+h^]r+uhgj+h`]r+(jB)r+}r+(hSUhT}r+(hV]r+hX]r+hZ]r+h\]r+h^]r+uhgj+h`]r+jL)r+}r+(hSUhT}r+(U anchornamer+UUrefurir+jGh\]r+hZ]r+hV]r+hX]r+h^]r+Uinternalr+uhgj+h`]r+(ht)r+}r+(hSXcircuits.net.protocols.httpr+hT}r+(hV]r+hX]r+hZ]r+h\]r,h^]r,uhgj+h`]r,hbXcircuits.net.protocols.httpr,r,}r,(hSUhgj+ubahhhubhbX -- HTTP Protocolr,r,}r,(hSjahgj+ubehhj\ubahhj]ubj.)r ,}r ,(hSUhT}r ,(hV]r ,hX]r ,hZ]r,h\]r,h^]r,uhgj+h`]r,(j8)r,}r,(hSUhT}r,(hV]r,hX]r,hZ]r,h\]r,h^]r,uhgj ,h`]r,jB)r,}r,(hSUhT}r,(hV]r,hX]r,hZ]r ,h\]r!,h^]r",uhgj,h`]r#,jL)r$,}r%,(hSUhT}r&,(U anchornamer',U#eventsr(,Urefurir),jGh\]r*,hZ]r+,hV]r,,hX]r-,h^]r.,Uinternalr/,uhgj,h`]r0,hbXEventsr1,r2,}r3,(hSXEventsr4,hgj$,ubahhj\ubahhj]ubahhjubj8)r5,}r6,(hSUhT}r7,(hV]r8,hX]r9,hZ]r:,h\]r;,h^]r<,uhgj ,h`]r=,jB)r>,}r?,(hSUhT}r@,(hV]rA,hX]rB,hZ]rC,h\]rD,h^]rE,uhgj5,h`]rF,jL)rG,}rH,(hSUhT}rI,(U anchornamerJ,U #componentsrK,UrefurirL,jGh\]rM,hZ]rN,hV]rO,hX]rP,h^]rQ,UinternalrR,uhgj>,h`]rS,hbX ComponentsrT,rU,}rV,(hSX ComponentsrW,hgjG,ubahhj\ubahhj]ubahhjubj8)rX,}rY,(hSUhT}rZ,(hV]r[,hX]r\,hZ]r],h\]r^,h^]r_,uhgj ,h`]r`,jB)ra,}rb,(hSUhT}rc,(hV]rd,hX]re,hZ]rf,h\]rg,h^]rh,uhgjX,h`]ri,jL)rj,}rk,(hSUhT}rl,(U anchornamerm,U #functionsrn,Urefuriro,jGh\]rp,hZ]rq,hV]rr,hX]rs,h^]rt,Uinternalru,uhgja,h`]rv,hbX Functionsrw,rx,}ry,(hSX Functionsrz,hgjj,ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjbj.)r{,}r|,(hSUhT}r},(hV]r~,hX]r,hZ]r,h\]r,h^]r,uh`]r,j8)r,}r,(hSUhT}r,(hV]r,hX]r,hZ]r,h\]r,h^]r,uhgj{,h`]r,jB)r,}r,(hSUhT}r,(hV]r,hX]r,hZ]r,h\]r,h^]r,uhgj,h`]r,jL)r,}r,(hSUhT}r,(U anchornamer,UUrefurir,jbh\]r,hZ]r,hV]r,hX]r,h^]r,Uinternalr,uhgj,h`]r,(ht)r,}r,(hSXcircuits.web.mainr,hT}r,(hV]r,hX]r,hZ]r,h\]r,h^]r,uhgj,h`]r,hbXcircuits.web.mainr,r,}r,(hSUhgj,ubahhhubhbX -- circuits.webr,r,}r,(hSj|hgj,ubehhj\ubahhj]ubahhjubahhjubh j.)r,}r,(hSUhT}r,(hV]r,hX]r,hZ]r,h\]r,h^]r,uh`]r,j8)r,}r,(hSUhT}r,(hV]r,hX]r,hZ]r,h\]r,h^]r,uhgj,h`]r,(jB)r,}r,(hSUhT}r,(hV]r,hX]r,hZ]r,h\]r,h^]r,uhgj,h`]r,jL)r,}r,(hSUhT}r,(U anchornamer,UUrefurir,h h\]r,hZ]r,hV]r,hX]r,h^]r,Uinternalr,uhgj,h`]r,hbXHow To: Build a Simple Serverr,r,}r,(hSjhgj,ubahhj\ubahhj]ubj.)r,}r,(hSUhT}r,(hV]r,hX]r,hZ]r,h\]r,h^]r,uhgj,h`]r,(j8)r,}r,(hSUhT}r,(hV]r,hX]r,hZ]r,h\]r,h^]r,uhgj,h`]r,(jB)r,}r,(hSUhT}r,(hV]r,hX]r,hZ]r,h\]r,h^]r,uhgj,h`]r,jL)r,}r,(hSUhT}r,(U anchornamer,U #overviewr,Urefurir,h h\]r,hZ]r,hV]r,hX]r-h^]r-Uinternalr-uhgj,h`]r-hbXOverviewr-r-}r-(hSXOverviewr-hgj,ubahhj\ubahhj]ubj.)r-}r -(hSUhT}r -(hV]r -hX]r -hZ]r -h\]r-h^]r-uhgj,h`]r-j8)r-}r-(hSUhT}r-(hV]r-hX]r-hZ]r-h\]r-h^]r-uhgj-h`]r-(jB)r-}r-(hSUhT}r-(hV]r-hX]r-hZ]r-h\]r -h^]r!-uhgj-h`]r"-jL)r#-}r$-(hSUhT}r%-(U anchornamer&-U#prerequisitesr'-Urefurir(-h h\]r)-hZ]r*-hV]r+-hX]r,-h^]r--Uinternalr.-uhgj-h`]r/-hbX Prerequisitesr0-r1-}r2-(hSX Prerequisitesr3-hgj#-ubahhj\ubahhj]ubj.)r4-}r5-(hSUhT}r6-(hV]r7-hX]r8-hZ]r9-h\]r:-h^]r;-uhgj-h`]r<-(j8)r=-}r>-(hSUhT}r?-(hV]r@-hX]rA-hZ]rB-h\]rC-h^]rD-uhgj4-h`]rE-jB)rF-}rG-(hSUhT}rH-(hV]rI-hX]rJ-hZ]rK-h\]rL-h^]rM-uhgj=-h`]rN-jL)rO-}rP-(hSUhT}rQ-(U anchornamerR-U#components-usedrS-UrefurirT-h h\]rU-hZ]rV-hV]rW-hX]rX-h^]rY-UinternalrZ-uhgjF-h`]r[-hbXComponents Usedr\-r]-}r^-(hSXComponents Usedr_-hgjO-ubahhj\ubahhj]ubahhjubj8)r`-}ra-(hSUhT}rb-(hV]rc-hX]rd-hZ]re-h\]rf-h^]rg-uhgj4-h`]rh-jB)ri-}rj-(hSUhT}rk-(hV]rl-hX]rm-hZ]rn-h\]ro-h^]rp-uhgj`-h`]rq-jL)rr-}rs-(hSUhT}rt-(U anchornameru-U #events-usedrv-Urefurirw-h h\]rx-hZ]ry-hV]rz-hX]r{-h^]r|-Uinternalr}-uhgji-h`]r~-hbX Events Usedr-r-}r-(hSX Events Usedr-hgjr-ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubehhjubj8)r-}r-(hSUhT}r-(hV]r-hX]r-hZ]r-h\]r-h^]r-uhgj,h`]r-jB)r-}r-(hSUhT}r-(hV]r-hX]r-hZ]r-h\]r-h^]r-uhgj-h`]r-jL)r-}r-(hSUhT}r-(U anchornamer-U#step-1-setting-upr-Urefurir-h h\]r-hZ]r-hV]r-hX]r-h^]r-Uinternalr-uhgj-h`]r-hbXStep 1 - Setting upr-r-}r-(hSXStep 1 - Setting upr-hgj-ubahhj\ubahhj]ubahhjubj8)r-}r-(hSUhT}r-(hV]r-hX]r-hZ]r-h\]r-h^]r-uhgj,h`]r-jB)r-}r-(hSUhT}r-(hV]r-hX]r-hZ]r-h\]r-h^]r-uhgj-h`]r-jL)r-}r-(hSUhT}r-(U anchornamer-U#step-2-building-the-serverr-Urefurir-h h\]r-hZ]r-hV]r-hX]r-h^]r-Uinternalr-uhgj-h`]r-hbXStep 2 - Building the Serverr-r-}r-(hSXStep 2 - Building the Serverr-hgj-ubahhj\ubahhj]ubahhjubj8)r-}r-(hSUhT}r-(hV]r-hX]r-hZ]r-h\]r-h^]r-uhgj,h`]r-jB)r-}r-(hSUhT}r-(hV]r-hX]r-hZ]r-h\]r-h^]r-uhgj-h`]r-jL)r-}r-(hSUhT}r-(U anchornamer-U#step-3-running-the-serverr-Urefurir-h h\]r-hZ]r-hV]r-hX]r-h^]r-Uinternalr-uhgj-h`]r-hbXStep 3 - Running the Serverr-r-}r-(hSXStep 3 - Running the Serverr-hgj-ubahhj\ubahhj]ubahhjubj8)r-}r-(hSUhT}r-(hV]r-hX]r-hZ]r-h\]r-h^]r-uhgj,h`]r-jB)r-}r-(hSUhT}r-(hV]r-hX]r-hZ]r-h\]r-h^]r-uhgj-h`]r-jL)r-}r-(hSUhT}r.(U anchornamer.U #source-coder.Urefurir.h h\]r.hZ]r.hV]r.hX]r.h^]r.Uinternalr .uhgj-h`]r .hbX Source Coder .r .}r .(hSX Source Coder.hgj-ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r.}r.(hSUhT}r.(hV]r.hX]r.hZ]r.h\]r.h^]r.uh`]r.j8)r.}r.(hSUhT}r.(hV]r.hX]r.hZ]r.h\]r.h^]r.uhgj.h`]r .(jB)r!.}r".(hSUhT}r#.(hV]r$.hX]r%.hZ]r&.h\]r'.h^]r(.uhgj.h`]r).jL)r*.}r+.(hSUhT}r,.(U anchornamer-.UUrefurir..jh\]r/.hZ]r0.hV]r1.hX]r2.h^]r3.Uinternalr4.uhgj!.h`]r5.(ht)r6.}r7.(hSXcircuits.core.componentsr8.hT}r9.(hV]r:.hX]r;.hZ]r<.h\]r=.h^]r>.uhgj*.h`]r?.hbXcircuits.core.componentsr@.rA.}rB.(hSUhgj6.ubahhhubhbX -- ComponentsrC.rD.}rE.(hSjhgj*.ubehhj\ubahhj]ubj.)rF.}rG.(hSUhT}rH.(hV]rI.hX]rJ.hZ]rK.h\]rL.h^]rM.uhgj.h`]rN.(j8)rO.}rP.(hSUhT}rQ.(hV]rR.hX]rS.hZ]rT.h\]rU.h^]rV.uhgjF.h`]rW.jB)rX.}rY.(hSUhT}rZ.(hV]r[.hX]r\.hZ]r].h\]r^.h^]r_.uhgjO.h`]r`.jL)ra.}rb.(hSUhT}rc.(U anchornamerd.U#classesre.Urefurirf.jh\]rg.hZ]rh.hV]ri.hX]rj.h^]rk.Uinternalrl.uhgjX.h`]rm.hbXClassesrn.ro.}rp.(hSXClassesrq.hgja.ubahhj\ubahhj]ubahhjubj8)rr.}rs.(hSUhT}rt.(hV]ru.hX]rv.hZ]rw.h\]rx.h^]ry.uhgjF.h`]rz.jB)r{.}r|.(hSUhT}r}.(hV]r~.hX]r.hZ]r.h\]r.h^]r.uhgjr.h`]r.jL)r.}r.(hSUhT}r.(U anchornamer.U #componentsr.Urefurir.jh\]r.hZ]r.hV]r.hX]r.h^]r.Uinternalr.uhgj{.h`]r.hbX Componentsr.r.}r.(hSX Componentsr.hgj.ubahhj\ubahhj]ubahhjubj8)r.}r.(hSUhT}r.(hV]r.hX]r.hZ]r.h\]r.h^]r.uhgjF.h`]r.jB)r.}r.(hSUhT}r.(hV]r.hX]r.hZ]r.h\]r.h^]r.uhgj.h`]r.jL)r.}r.(hSUhT}r.(U anchornamer.U#eventsr.Urefurir.jh\]r.hZ]r.hV]r.hX]r.h^]r.Uinternalr.uhgj.h`]r.hbXEventsr.r.}r.(hSXEventsr.hgj.ubahhj\ubahhj]ubahhjubj8)r.}r.(hSUhT}r.(hV]r.hX]r.hZ]r.h\]r.h^]r.uhgjF.h`]r.jB)r.}r.(hSUhT}r.(hV]r.hX]r.hZ]r.h\]r.h^]r.uhgj.h`]r.jL)r.}r.(hSUhT}r.(U anchornamer.U #functionsr.Urefurir.jh\]r.hZ]r.hV]r.hX]r.h^]r.Uinternalr.uhgj.h`]r.hbX Functionsr.r.}r.(hSX Functionsr.hgj.ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r.}r.(hSUhT}r.(hV]r.hX]r.hZ]r.h\]r.h^]r.uh`]r.j8)r.}r.(hSUhT}r.(hV]r.hX]r.hZ]r.h\]r.h^]r.uhgj.h`]r.(jB)r.}r.(hSUhT}r.(hV]r.hX]r.hZ]r.h\]r.h^]r.uhgj.h`]r.jL)r.}r.(hSUhT}r.(U anchornamer.UUrefurir.jh\]r.hZ]r.hV]r.hX]r.h^]r.Uinternalr/uhgj.h`]r/(ht)r/}r/(hSXcircuits.web.clientr/hT}r/(hV]r/hX]r/hZ]r/h\]r /h^]r /uhgj.h`]r /hbXcircuits.web.clientr /r /}r/(hSUhgj/ubahhhubhbX -- Clientr/r/}r/(hSjhgj.ubehhj\ubahhj]ubj.)r/}r/(hSUhT}r/(hV]r/hX]r/hZ]r/h\]r/h^]r/uhgj.h`]r/(j8)r/}r/(hSUhT}r/(hV]r/hX]r/hZ]r /h\]r!/h^]r"/uhgj/h`]r#/jB)r$/}r%/(hSUhT}r&/(hV]r'/hX]r(/hZ]r)/h\]r*/h^]r+/uhgj/h`]r,/jL)r-/}r./(hSUhT}r//(U anchornamer0/U#eventsr1/Urefurir2/jh\]r3/hZ]r4/hV]r5/hX]r6/h^]r7/Uinternalr8/uhgj$/h`]r9/hbXEventsr:/r;/}r/}r?/(hSUhT}r@/(hV]rA/hX]rB/hZ]rC/h\]rD/h^]rE/uhgj/h`]rF/jB)rG/}rH/(hSUhT}rI/(hV]rJ/hX]rK/hZ]rL/h\]rM/h^]rN/uhgj>/h`]rO/jL)rP/}rQ/(hSUhT}rR/(U anchornamerS/U #componentsrT/UrefurirU/jh\]rV/hZ]rW/hV]rX/hX]rY/h^]rZ/Uinternalr[/uhgjG/h`]r\/hbX Componentsr]/r^/}r_/(hSX Componentsr`/hgjP/ubahhj\ubahhj]ubahhjubj8)ra/}rb/(hSUhT}rc/(hV]rd/hX]re/hZ]rf/h\]rg/h^]rh/uhgj/h`]ri/jB)rj/}rk/(hSUhT}rl/(hV]rm/hX]rn/hZ]ro/h\]rp/h^]rq/uhgja/h`]rr/jL)rs/}rt/(hSUhT}ru/(U anchornamerv/U #functionsrw/Urefurirx/jh\]ry/hZ]rz/hV]r{/hX]r|/h^]r}/Uinternalr~/uhgjj/h`]r/hbX Functionsr/r/}r/(hSX Functionsr/hgjs/ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r/}r/(hSUhT}r/(hV]r/hX]r/hZ]r/h\]r/h^]r/uh`]r/j8)r/}r/(hSUhT}r/(hV]r/hX]r/hZ]r/h\]r/h^]r/uhgj/h`]r/(jB)r/}r/(hSUhT}r/(hV]r/hX]r/hZ]r/h\]r/h^]r/uhgj/h`]r/jL)r/}r/(hSUhT}r/(U anchornamer/UUrefurir/jh\]r/hZ]r/hV]r/hX]r/h^]r/Uinternalr/uhgj/h`]r/(ht)r/}r/(hSXcircuits.core.workersr/hT}r/(hV]r/hX]r/hZ]r/h\]r/h^]r/uhgj/h`]r/hbXcircuits.core.workersr/r/}r/(hSUhgj/ubahhhubhbX -- Workersr/r/}r/(hSjhgj/ubehhj\ubahhj]ubj.)r/}r/(hSUhT}r/(hV]r/hX]r/hZ]r/h\]r/h^]r/uhgj/h`]r/(j8)r/}r/(hSUhT}r/(hV]r/hX]r/hZ]r/h\]r/h^]r/uhgj/h`]r/jB)r/}r/(hSUhT}r/(hV]r/hX]r/hZ]r/h\]r/h^]r/uhgj/h`]r/jL)r/}r/(hSUhT}r/(U anchornamer/U#classesr/Urefurir/jh\]r/hZ]r/hV]r/hX]r/h^]r/Uinternalr/uhgj/h`]r/hbXClassesr/r/}r/(hSXClassesr/hgj/ubahhj\ubahhj]ubahhjubj8)r/}r/(hSUhT}r/(hV]r/hX]r/hZ]r/h\]r/h^]r/uhgj/h`]r/jB)r/}r/(hSUhT}r/(hV]r/hX]r/hZ]r/h\]r/h^]r/uhgj/h`]r/jL)r/}r/(hSUhT}r/(U anchornamer/U #componentsr/Urefurir/jh\]r/hZ]r0hV]r0hX]r0h^]r0Uinternalr0uhgj/h`]r0hbX Componentsr0r0}r0(hSX Componentsr 0hgj/ubahhj\ubahhj]ubahhjubj8)r 0}r 0(hSUhT}r 0(hV]r 0hX]r0hZ]r0h\]r0h^]r0uhgj/h`]r0jB)r0}r0(hSUhT}r0(hV]r0hX]r0hZ]r0h\]r0h^]r0uhgj 0h`]r0jL)r0}r0(hSUhT}r0(U anchornamer0U#eventsr 0Urefurir!0jh\]r"0hZ]r#0hV]r$0hX]r%0h^]r&0Uinternalr'0uhgj0h`]r(0hbXEventsr)0r*0}r+0(hSXEventsr,0hgj0ubahhj\ubahhj]ubahhjubj8)r-0}r.0(hSUhT}r/0(hV]r00hX]r10hZ]r20h\]r30h^]r40uhgj/h`]r50jB)r60}r70(hSUhT}r80(hV]r90hX]r:0hZ]r;0h\]r<0h^]r=0uhgj-0h`]r>0jL)r?0}r@0(hSUhT}rA0(U anchornamerB0U #functionsrC0UrefurirD0jh\]rE0hZ]rF0hV]rG0hX]rH0h^]rI0UinternalrJ0uhgj60h`]rK0hbX FunctionsrL0rM0}rN0(hSX FunctionsrO0hgj?0ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)rP0}rQ0(hSUhT}rR0(hV]rS0hX]rT0hZ]rU0h\]rV0h^]rW0uh`]rX0j8)rY0}rZ0(hSUhT}r[0(hV]r\0hX]r]0hZ]r^0h\]r_0h^]r`0uhgjP0h`]ra0(jB)rb0}rc0(hSUhT}rd0(hV]re0hX]rf0hZ]rg0h\]rh0h^]ri0uhgjY0h`]rj0jL)rk0}rl0(hSUhT}rm0(U anchornamern0UUrefuriro0jh\]rp0hZ]rq0hV]rr0hX]rs0h^]rt0Uinternalru0uhgjb0h`]rv0(ht)rw0}rx0(hSXcircuits.web.websocketry0hT}rz0(hV]r{0hX]r|0hZ]r}0h\]r~0h^]r0uhgjk0h`]r0hbXcircuits.web.websocketr0r0}r0(hSUhgjw0ubahhhubhbX -- WebSocket Clientr0r0}r0(hSjhgjk0ubehhj\ubahhj]ubj.)r0}r0(hSUhT}r0(hV]r0hX]r0hZ]r0h\]r0h^]r0uhgjY0h`]r0(j8)r0}r0(hSUhT}r0(hV]r0hX]r0hZ]r0h\]r0h^]r0uhgj0h`]r0jB)r0}r0(hSUhT}r0(hV]r0hX]r0hZ]r0h\]r0h^]r0uhgj0h`]r0jL)r0}r0(hSUhT}r0(U anchornamer0U#eventsr0Urefurir0jh\]r0hZ]r0hV]r0hX]r0h^]r0Uinternalr0uhgj0h`]r0hbXEventsr0r0}r0(hSXEventsr0hgj0ubahhj\ubahhj]ubahhjubj8)r0}r0(hSUhT}r0(hV]r0hX]r0hZ]r0h\]r0h^]r0uhgj0h`]r0jB)r0}r0(hSUhT}r0(hV]r0hX]r0hZ]r0h\]r0h^]r0uhgj0h`]r0jL)r0}r0(hSUhT}r0(U anchornamer0U #componentsr0Urefurir0jh\]r0hZ]r0hV]r0hX]r0h^]r0Uinternalr0uhgj0h`]r0hbX Componentsr0r0}r0(hSX Componentsr0hgj0ubahhj\ubahhj]ubahhjubj8)r0}r0(hSUhT}r0(hV]r0hX]r0hZ]r0h\]r0h^]r0uhgj0h`]r0jB)r0}r0(hSUhT}r0(hV]r0hX]r0hZ]r0h\]r0h^]r0uhgj0h`]r0jL)r0}r0(hSUhT}r0(U anchornamer0U #functionsr0Urefurir0jh\]r0hZ]r0hV]r0hX]r0h^]r0Uinternalr0uhgj0h`]r0hbX Functionsr0r0}r0(hSX Functionsr0hgj0ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r0}r0(hSUhT}r0(hV]r0hX]r0hZ]r0h\]r0h^]r1uh`]r1j8)r1}r1(hSUhT}r1(hV]r1hX]r1hZ]r1h\]r1h^]r 1uhgj0h`]r 1(jB)r 1}r 1(hSUhT}r 1(hV]r1hX]r1hZ]r1h\]r1h^]r1uhgj1h`]r1jL)r1}r1(hSUhT}r1(U anchornamer1UUrefurir1jh\]r1hZ]r1hV]r1hX]r1h^]r1Uinternalr1uhgj 1h`]r1hbX ChangeLogr 1r!1}r"1(hSjhgj1ubahhj\ubahhj]ubj.)r#1}r$1(hSUhT}r%1(hV]r&1hX]r'1hZ]r(1h\]r)1h^]r*1uhgj1h`]r+1(j8)r,1}r-1(hSUhT}r.1(hV]r/1hX]r01hZ]r11h\]r21h^]r31uhgj#1h`]r41jB)r51}r61(hSUhT}r71(hV]r81hX]r91hZ]r:1h\]r;1h^]r<1uhgj,1h`]r=1jL)r>1}r?1(hSUhT}r@1(U anchornamerA1U #circuits-2-1-0-20130224-releaserB1UrefurirC1jh\]rD1hZ]rE1hV]rF1hX]rG1h^]rH1UinternalrI1uhgj51h`]rJ1hbX#circuits-2.1.0 20130224 ()rK1rL1}rM1(hSX#circuits-2.1.0 20130224 ()rN1hgj>1ubahhj\ubahhj]ubahhjubj8)rO1}rP1(hSUhT}rQ1(hV]rR1hX]rS1hZ]rT1h\]rU1h^]rV1uhgj#1h`]rW1jB)rX1}rY1(hSUhT}rZ1(hV]r[1hX]r\1hZ]r]1h\]r^1h^]r_1uhgjO1h`]r`1jL)ra1}rb1(hSUhT}rc1(U anchornamerd1U#circuits-2-0-1-20121124re1Urefurirf1jh\]rg1hZ]rh1hV]ri1hX]rj1h^]rk1Uinternalrl1uhgjX1h`]rm1hbXcircuits-2.0.1 20121124rn1ro1}rp1(hSXcircuits-2.0.1 20121124rq1hgja1ubahhj\ubahhj]ubahhjubj8)rr1}rs1(hSUhT}rt1(hV]ru1hX]rv1hZ]rw1h\]rx1h^]ry1uhgj#1h`]rz1jB)r{1}r|1(hSUhT}r}1(hV]r~1hX]r1hZ]r1h\]r1h^]r1uhgjr1h`]r1jL)r1}r1(hSUhT}r1(U anchornamer1U #circuits-2-0-0-20121122-cheetahr1Urefurir1jh\]r1hZ]r1hV]r1hX]r1h^]r1Uinternalr1uhgj{1h`]r1hbX!circuits-2.0.0 20121122 (cheetah)r1r1}r1(hSX!circuits-2.0.0 20121122 (cheetah)r1hgj1ubahhj\ubahhj]ubahhjubj8)r1}r1(hSUhT}r1(hV]r1hX]r1hZ]r1h\]r1h^]r1uhgj#1h`]r1jB)r1}r1(hSUhT}r1(hV]r1hX]r1hZ]r1h\]r1h^]r1uhgj1h`]r1jL)r1}r1(hSUhT}r1(U anchornamer1U#circuits-1-6-oceans-20110626r1Urefurir1jh\]r1hZ]r1hV]r1hX]r1h^]r1Uinternalr1uhgj1h`]r1hbX circuits-1.6 (oceans) - 20110626r1r1}r1(hSX circuits-1.6 (oceans) - 20110626r1hgj1ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r1}r1(hSUhT}r1(hV]r1hX]r1hZ]r1h\]r1h^]r1uh`]r1j8)r1}r1(hSUhT}r1(hV]r1hX]r1hZ]r1h\]r1h^]r1uhgj1h`]r1jB)r1}r1(hSUhT}r1(hV]r1hX]r1hZ]r1h\]r1h^]r1uhgj1h`]r1jL)r1}r1(hSUhT}r1(U anchornamer1UUrefurir1jh\]r1hZ]r1hV]r1hX]r1h^]r1Uinternalr1uhgj1h`]r1(ht)r1}r1(hSXcircuits.toolsr1hT}r1(hV]r1hX]r1hZ]r1h\]r1h^]r1uhgj1h`]r1hbXcircuits.toolsr1r1}r1(hSUhgj1ubahhhubhbX -- Development Toolsr1r1}r1(hSjhgj1ubehhj\ubahhj]ubahhjubahhjubjj.)r1}r1(hSUhT}r1(hV]r1hX]r1hZ]r1h\]r1h^]r1uh`]r1j8)r1}r1(hSUhT}r1(hV]r1hX]r1hZ]r1h\]r1h^]r1uhgj1h`]r2(jB)r2}r2(hSUhT}r2(hV]r2hX]r2hZ]r2h\]r2h^]r2uhgj1h`]r 2jL)r 2}r 2(hSUhT}r 2(U anchornamer 2UUrefurir2jh\]r2hZ]r2hV]r2hX]r2h^]r2Uinternalr2uhgj2h`]r2(ht)r2}r2(hSXcircuits.web.eventsr2hT}r2(hV]r2hX]r2hZ]r2h\]r2h^]r2uhgj 2h`]r2hbXcircuits.web.eventsr 2r!2}r"2(hSUhgj2ubahhhubhbX -- Eventsr#2r$2}r%2(hSj9hgj 2ubehhj\ubahhj]ubj.)r&2}r'2(hSUhT}r(2(hV]r)2hX]r*2hZ]r+2h\]r,2h^]r-2uhgj1h`]r.2(j8)r/2}r02(hSUhT}r12(hV]r22hX]r32hZ]r42h\]r52h^]r62uhgj&2h`]r72jB)r82}r92(hSUhT}r:2(hV]r;2hX]r<2hZ]r=2h\]r>2h^]r?2uhgj/2h`]r@2jL)rA2}rB2(hSUhT}rC2(U anchornamerD2U#eventsrE2UrefurirF2jh\]rG2hZ]rH2hV]rI2hX]rJ2h^]rK2UinternalrL2uhgj82h`]rM2hbXEventsrN2rO2}rP2(hSXEventsrQ2hgjA2ubahhj\ubahhj]ubahhjubj8)rR2}rS2(hSUhT}rT2(hV]rU2hX]rV2hZ]rW2h\]rX2h^]rY2uhgj&2h`]rZ2jB)r[2}r\2(hSUhT}r]2(hV]r^2hX]r_2hZ]r`2h\]ra2h^]rb2uhgjR2h`]rc2jL)rd2}re2(hSUhT}rf2(U anchornamerg2U #componentsrh2Urefuriri2jh\]rj2hZ]rk2hV]rl2hX]rm2h^]rn2Uinternalro2uhgj[2h`]rp2hbX Componentsrq2rr2}rs2(hSX Componentsrt2hgjd2ubahhj\ubahhj]ubahhjubj8)ru2}rv2(hSUhT}rw2(hV]rx2hX]ry2hZ]rz2h\]r{2h^]r|2uhgj&2h`]r}2jB)r~2}r2(hSUhT}r2(hV]r2hX]r2hZ]r2h\]r2h^]r2uhgju2h`]r2jL)r2}r2(hSUhT}r2(U anchornamer2U #functionsr2Urefurir2jh\]r2hZ]r2hV]r2hX]r2h^]r2Uinternalr2uhgj~2h`]r2hbX Functionsr2r2}r2(hSX Functionsr2hgj2ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubj:j.)r2}r2(hSUhT}r2(hV]r2hX]r2hZ]r2h\]r2h^]r2uh`]r2j8)r2}r2(hSUhT}r2(hV]r2hX]r2hZ]r2h\]r2h^]r2uhgj2h`]r2(jB)r2}r2(hSUhT}r2(hV]r2hX]r2hZ]r2h\]r2h^]r2uhgj2h`]r2jL)r2}r2(hSUhT}r2(U anchornamer2UUrefurir2j:h\]r2hZ]r2hV]r2hX]r2h^]r2Uinternalr2uhgj2h`]r2(ht)r2}r2(hSXcircuits.web.utilsr2hT}r2(hV]r2hX]r2hZ]r2h\]r2h^]r2uhgj2h`]r2hbXcircuits.web.utilsr2r2}r2(hSUhgj2ubahhhubhbX -- Utilitiesr2r2}r2(hSjThgj2ubehhj\ubahhj]ubj.)r2}r2(hSUhT}r2(hV]r2hX]r2hZ]r2h\]r2h^]r2uhgj2h`]r2(j8)r2}r2(hSUhT}r2(hV]r2hX]r2hZ]r2h\]r2h^]r2uhgj2h`]r2jB)r2}r2(hSUhT}r2(hV]r2hX]r2hZ]r2h\]r2h^]r2uhgj2h`]r2jL)r2}r2(hSUhT}r2(U anchornamer2U#eventsr2Urefurir2j:h\]r2hZ]r2hV]r2hX]r2h^]r2Uinternalr2uhgj2h`]r2hbXEventsr2r2}r2(hSXEventsr2hgj2ubahhj\ubahhj]ubahhjubj8)r2}r2(hSUhT}r2(hV]r2hX]r2hZ]r3h\]r3h^]r3uhgj2h`]r3jB)r3}r3(hSUhT}r3(hV]r3hX]r3hZ]r 3h\]r 3h^]r 3uhgj2h`]r 3jL)r 3}r3(hSUhT}r3(U anchornamer3U #componentsr3Urefurir3j:h\]r3hZ]r3hV]r3hX]r3h^]r3Uinternalr3uhgj3h`]r3hbX Componentsr3r3}r3(hSX Componentsr3hgj 3ubahhj\ubahhj]ubahhjubj8)r3}r3(hSUhT}r 3(hV]r!3hX]r"3hZ]r#3h\]r$3h^]r%3uhgj2h`]r&3jB)r'3}r(3(hSUhT}r)3(hV]r*3hX]r+3hZ]r,3h\]r-3h^]r.3uhgj3h`]r/3jL)r03}r13(hSUhT}r23(U anchornamer33U #functionsr43Urefurir53j:h\]r63hZ]r73hV]r83hX]r93h^]r:3Uinternalr;3uhgj'3h`]r<3hbX Functionsr=3r>3}r?3(hSX Functionsr@3hgj03ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjUj.)rA3}rB3(hSUhT}rC3(hV]rD3hX]rE3hZ]rF3h\]rG3h^]rH3uh`]rI3j8)rJ3}rK3(hSUhT}rL3(hV]rM3hX]rN3hZ]rO3h\]rP3h^]rQ3uhgjA3h`]rR3(jB)rS3}rT3(hSUhT}rU3(hV]rV3hX]rW3hZ]rX3h\]rY3h^]rZ3uhgjJ3h`]r[3jL)r\3}r]3(hSUhT}r^3(U anchornamer_3UUrefurir`3jUh\]ra3hZ]rb3hV]rc3hX]rd3h^]re3Uinternalrf3uhgjS3h`]rg3(ht)rh3}ri3(hSXcircuits.node.utilsrj3hT}rk3(hV]rl3hX]rm3hZ]rn3h\]ro3h^]rp3uhgj\3h`]rq3hbXcircuits.node.utilsrr3rs3}rt3(hSUhgjh3ubahhhubhbX -- Node Utilitiesru3rv3}rw3(hSjohgj\3ubehhj\ubahhj]ubj.)rx3}ry3(hSUhT}rz3(hV]r{3hX]r|3hZ]r}3h\]r~3h^]r3uhgjJ3h`]r3(j8)r3}r3(hSUhT}r3(hV]r3hX]r3hZ]r3h\]r3h^]r3uhgjx3h`]r3jB)r3}r3(hSUhT}r3(hV]r3hX]r3hZ]r3h\]r3h^]r3uhgj3h`]r3jL)r3}r3(hSUhT}r3(U anchornamer3U#eventsr3Urefurir3jUh\]r3hZ]r3hV]r3hX]r3h^]r3Uinternalr3uhgj3h`]r3hbXEventsr3r3}r3(hSXEventsr3hgj3ubahhj\ubahhj]ubahhjubj8)r3}r3(hSUhT}r3(hV]r3hX]r3hZ]r3h\]r3h^]r3uhgjx3h`]r3jB)r3}r3(hSUhT}r3(hV]r3hX]r3hZ]r3h\]r3h^]r3uhgj3h`]r3jL)r3}r3(hSUhT}r3(U anchornamer3U #componentsr3Urefurir3jUh\]r3hZ]r3hV]r3hX]r3h^]r3Uinternalr3uhgj3h`]r3hbX Componentsr3r3}r3(hSX Componentsr3hgj3ubahhj\ubahhj]ubahhjubj8)r3}r3(hSUhT}r3(hV]r3hX]r3hZ]r3h\]r3h^]r3uhgjx3h`]r3jB)r3}r3(hSUhT}r3(hV]r3hX]r3hZ]r3h\]r3h^]r3uhgj3h`]r3jL)r3}r3(hSUhT}r3(U anchornamer3U #functionsr3Urefurir3jUh\]r3hZ]r3hV]r3hX]r3h^]r3Uinternalr3uhgj3h`]r3hbX Functionsr3r3}r3(hSX Functionsr3hgj3ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjpj.)r3}r3(hSUhT}r3(hV]r3hX]r3hZ]r3h\]r3h^]r3uh`]r3j8)r3}r3(hSUhT}r3(hV]r3hX]r3hZ]r3h\]r3h^]r3uhgj3h`]r3(jB)r3}r3(hSUhT}r3(hV]r3hX]r4hZ]r4h\]r4h^]r4uhgj3h`]r4jL)r4}r4(hSUhT}r4(U anchornamer4UUrefurir 4jph\]r 4hZ]r 4hV]r 4hX]r 4h^]r4Uinternalr4uhgj3h`]r4hbXGetting Startedr4r4}r4(hSj}hgj4ubahhj\ubahhj]ubj.)r4}r4(hSUhT}r4(hV]r4hX]r4hZ]r4h\]r4h^]r4uhgj3h`]r4jg)r4}r4(hSUhT}r4(Unumberedr 4KUparentr!4jpU titlesonlyr"4Uglobr#4h\]r$4hZ]r%4hV]r&4hX]r'4h^]r(4Uentriesr)4]r*4(Njr+4Njr,4Njr-4Njr.4eUhiddenr/4U includefilesr04]r14(jjjjeUmaxdepthr24Kuhgj4h`]r34hhj~ubahhjubehhjubahhjubj~j.)r44}r54(hSUhT}r64(hV]r74hX]r84hZ]r94h\]r:4h^]r;4uh`]r<4j8)r=4}r>4(hSUhT}r?4(hV]r@4hX]rA4hZ]rB4h\]rC4h^]rD4uhgj44h`]rE4(jB)rF4}rG4(hSUhT}rH4(hV]rI4hX]rJ4hZ]rK4h\]rL4h^]rM4uhgj=4h`]rN4jL)rO4}rP4(hSUhT}rQ4(U anchornamerR4UUrefurirS4j~h\]rT4hZ]rU4hV]rV4hX]rW4h^]rX4UinternalrY4uhgjF4h`]rZ4(ht)r[4}r\4(hSX circuits.noder]4hT}r^4(hV]r_4hX]r`4hZ]ra4h\]rb4h^]rc4uhgjO4h`]rd4hbX circuits.nodere4rf4}rg4(hSUhgj[4ubahhhubhbX -- Noderh4ri4}rj4(hSjhgjO4ubehhj\ubahhj]ubj.)rk4}rl4(hSUhT}rm4(hV]rn4hX]ro4hZ]rp4h\]rq4h^]rr4uhgj=4h`]rs4jg)rt4}ru4(hSUhT}rv4(Unumberedrw4KUparentrx4j~U titlesonlyry4Uglobrz4h\]r{4hZ]r|4hV]r}4hX]r~4h^]r4Uentriesr4]r4(Nj r4Njfr4Njr4Njr4NjUr4eUhiddenr4U includefilesr4]r4(j jfjjjUeUmaxdepthr4Kuhgjk4h`]r4hhj~ubahhjubehhjubahhjubjj.)r4}r4(hSUhT}r4(hV]r4hX]r4hZ]r4h\]r4h^]r4uh`]r4j8)r4}r4(hSUhT}r4(hV]r4hX]r4hZ]r4h\]r4h^]r4uhgj4h`]r4(jB)r4}r4(hSUhT}r4(hV]r4hX]r4hZ]r4h\]r4h^]r4uhgj4h`]r4jL)r4}r4(hSUhT}r4(U anchornamer4UUrefurir4jh\]r4hZ]r4hV]r4hX]r4h^]r4Uinternalr4uhgj4h`]r4(ht)r4}r4(hSX circuits.web.dispatchers.jsonrpcr4hT}r4(hV]r4hX]r4hZ]r4h\]r4h^]r4uhgj4h`]r4hbX circuits.web.dispatchers.jsonrpcr4r4}r4(hSUhgj4ubahhhubhbX -- JSON-RPCr4r4}r4(hSjhgj4ubehhj\ubahhj]ubj.)r4}r4(hSUhT}r4(hV]r4hX]r4hZ]r4h\]r4h^]r4uhgj4h`]r4(j8)r4}r4(hSUhT}r4(hV]r4hX]r4hZ]r4h\]r4h^]r4uhgj4h`]r4jB)r4}r4(hSUhT}r4(hV]r4hX]r4hZ]r4h\]r4h^]r4uhgj4h`]r4jL)r4}r4(hSUhT}r4(U anchornamer4U#eventsr4Urefurir4jh\]r4hZ]r4hV]r4hX]r4h^]r4Uinternalr4uhgj4h`]r4hbXEventsr4r4}r4(hSXEventsr4hgj4ubahhj\ubahhj]ubahhjubj8)r4}r4(hSUhT}r4(hV]r4hX]r4hZ]r4h\]r4h^]r4uhgj4h`]r4jB)r4}r4(hSUhT}r4(hV]r4hX]r4hZ]r4h\]r4h^]r4uhgj4h`]r5jL)r5}r5(hSUhT}r5(U anchornamer5U #componentsr5Urefurir5jh\]r5hZ]r5hV]r 5hX]r 5h^]r 5Uinternalr 5uhgj4h`]r 5hbX Componentsr5r5}r5(hSX Componentsr5hgj5ubahhj\ubahhj]ubahhjubj8)r5}r5(hSUhT}r5(hV]r5hX]r5hZ]r5h\]r5h^]r5uhgj4h`]r5jB)r5}r5(hSUhT}r5(hV]r5hX]r5hZ]r 5h\]r!5h^]r"5uhgj5h`]r#5jL)r$5}r%5(hSUhT}r&5(U anchornamer'5U #functionsr(5Urefurir)5jh\]r*5hZ]r+5hV]r,5hX]r-5h^]r.5Uinternalr/5uhgj5h`]r05hbX Functionsr15r25}r35(hSX Functionsr45hgj$5ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r55}r65(hSUhT}r75(hV]r85hX]r95hZ]r:5h\]r;5h^]r<5uh`]r=5j8)r>5}r?5(hSUhT}r@5(hV]rA5hX]rB5hZ]rC5h\]rD5h^]rE5uhgj55h`]rF5(jB)rG5}rH5(hSUhT}rI5(hV]rJ5hX]rK5hZ]rL5h\]rM5h^]rN5uhgj>5h`]rO5jL)rP5}rQ5(hSUhT}rR5(U anchornamerS5UUrefurirT5jh\]rU5hZ]rV5hV]rW5hX]rX5h^]rY5UinternalrZ5uhgjG5h`]r[5hbXDevelopment Processesr\5r]5}r^5(hSjhgjP5ubahhj\ubahhj]ubj.)r_5}r`5(hSUhT}ra5(hV]rb5hX]rc5hZ]rd5h\]re5h^]rf5uhgj>5h`]rg5(j8)rh5}ri5(hSUhT}rj5(hV]rk5hX]rl5hZ]rm5h\]rn5h^]ro5uhgj_5h`]rp5jB)rq5}rr5(hSUhT}rs5(hV]rt5hX]ru5hZ]rv5h\]rw5h^]rx5uhgjh5h`]ry5jL)rz5}r{5(hSUhT}r|5(U anchornamer}5U%#software-development-life-cycle-sdlcr~5Urefurir5jh\]r5hZ]r5hV]r5hX]r5h^]r5Uinternalr5uhgjq5h`]r5hbX&Software Development Life Cycle (SDLC)r5r5}r5(hSX&Software Development Life Cycle (SDLC)r5hgjz5ubahhj\ubahhj]ubahhjubj8)r5}r5(hSUhT}r5(hV]r5hX]r5hZ]r5h\]r5h^]r5uhgj_5h`]r5jB)r5}r5(hSUhT}r5(hV]r5hX]r5hZ]r5h\]r5h^]r5uhgj5h`]r5jL)r5}r5(hSUhT}r5(U anchornamer5U #bug-reportsr5Urefurir5jh\]r5hZ]r5hV]r5hX]r5h^]r5Uinternalr5uhgj5h`]r5hbX Bug Reportsr5r5}r5(hSX Bug Reportsr5hgj5ubahhj\ubahhj]ubahhjubj8)r5}r5(hSUhT}r5(hV]r5hX]r5hZ]r5h\]r5h^]r5uhgj_5h`]r5jB)r5}r5(hSUhT}r5(hV]r5hX]r5hZ]r5h\]r5h^]r5uhgj5h`]r5jL)r5}r5(hSUhT}r5(U anchornamer5U#feature-requestsr5Urefurir5jh\]r5hZ]r5hV]r5hX]r5h^]r5Uinternalr5uhgj5h`]r5hbXFeature Requestsr5r5}r5(hSXFeature Requestsr5hgj5ubahhj\ubahhj]ubahhjubj8)r5}r5(hSUhT}r5(hV]r5hX]r5hZ]r5h\]r5h^]r5uhgj_5h`]r5jB)r5}r5(hSUhT}r5(hV]r5hX]r5hZ]r5h\]r5h^]r5uhgj5h`]r5jL)r5}r5(hSUhT}r5(U anchornamer5U#writing-new-coder5Urefurir5jh\]r5hZ]r5hV]r5hX]r5h^]r5Uinternalr5uhgj5h`]r5hbXWriting new Coder5r5}r5(hSXWriting new Coder5hgj5ubahhj\ubahhj]ubahhjubj8)r5}r5(hSUhT}r5(hV]r5hX]r5hZ]r5h\]r5h^]r5uhgj_5h`]r5jB)r5}r5(hSUhT}r5(hV]r6hX]r6hZ]r6h\]r6h^]r6uhgj5h`]r6jL)r6}r6(hSUhT}r6(U anchornamer 6U#running-the-testsr 6Urefurir 6jh\]r 6hZ]r 6hV]r6hX]r6h^]r6Uinternalr6uhgj5h`]r6hbXRunning the Testsr6r6}r6(hSXRunning the Testsr6hgj6ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r6}r6(hSUhT}r6(hV]r6hX]r6hZ]r6h\]r6h^]r6uh`]r6j8)r 6}r!6(hSUhT}r"6(hV]r#6hX]r$6hZ]r%6h\]r&6h^]r'6uhgj6h`]r(6(jB)r)6}r*6(hSUhT}r+6(hV]r,6hX]r-6hZ]r.6h\]r/6h^]r06uhgj 6h`]r16jL)r26}r36(hSUhT}r46(U anchornamer56UUrefurir66jh\]r76hZ]r86hV]r96hX]r:6h^]r;6Uinternalr<6uhgj)6h`]r=6(ht)r>6}r?6(hSXcircuits.io.notifyr@6hT}rA6(hV]rB6hX]rC6hZ]rD6h\]rE6h^]rF6uhgj26h`]rG6hbXcircuits.io.notifyrH6rI6}rJ6(hSUhgj>6ubahhhubhbX -- File System NotificationrK6rL6}rM6(hSjhgj26ubehhj\ubahhj]ubj.)rN6}rO6(hSUhT}rP6(hV]rQ6hX]rR6hZ]rS6h\]rT6h^]rU6uhgj 6h`]rV6(j8)rW6}rX6(hSUhT}rY6(hV]rZ6hX]r[6hZ]r\6h\]r]6h^]r^6uhgjN6h`]r_6jB)r`6}ra6(hSUhT}rb6(hV]rc6hX]rd6hZ]re6h\]rf6h^]rg6uhgjW6h`]rh6jL)ri6}rj6(hSUhT}rk6(U anchornamerl6U#eventsrm6Urefurirn6jh\]ro6hZ]rp6hV]rq6hX]rr6h^]rs6Uinternalrt6uhgj`6h`]ru6hbXEventsrv6rw6}rx6(hSXEventsry6hgji6ubahhj\ubahhj]ubahhjubj8)rz6}r{6(hSUhT}r|6(hV]r}6hX]r~6hZ]r6h\]r6h^]r6uhgjN6h`]r6jB)r6}r6(hSUhT}r6(hV]r6hX]r6hZ]r6h\]r6h^]r6uhgjz6h`]r6jL)r6}r6(hSUhT}r6(U anchornamer6U #componentsr6Urefurir6jh\]r6hZ]r6hV]r6hX]r6h^]r6Uinternalr6uhgj6h`]r6hbX Componentsr6r6}r6(hSX Componentsr6hgj6ubahhj\ubahhj]ubahhjubj8)r6}r6(hSUhT}r6(hV]r6hX]r6hZ]r6h\]r6h^]r6uhgjN6h`]r6jB)r6}r6(hSUhT}r6(hV]r6hX]r6hZ]r6h\]r6h^]r6uhgj6h`]r6jL)r6}r6(hSUhT}r6(U anchornamer6U #functionsr6Urefurir6jh\]r6hZ]r6hV]r6hX]r6h^]r6Uinternalr6uhgj6h`]r6hbX Functionsr6r6}r6(hSX Functionsr6hgj6ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r6}r6(hSUhT}r6(hV]r6hX]r6hZ]r6h\]r6h^]r6uh`]r6j8)r6}r6(hSUhT}r6(hV]r6hX]r6hZ]r6h\]r6h^]r6uhgj6h`]r6(jB)r6}r6(hSUhT}r6(hV]r6hX]r6hZ]r6h\]r6h^]r6uhgj6h`]r6jL)r6}r6(hSUhT}r6(U anchornamer6UUrefurir6jh\]r6hZ]r6hV]r6hX]r6h^]r6Uinternalr6uhgj6h`]r6hbXThe circuits.web Frameworkr6r6}r6(hSjhgj6ubahhj\ubahhj]ubj.)r6}r6(hSUhT}r6(hV]r6hX]r6hZ]r6h\]r6h^]r6uhgj6h`]r6jg)r6}r6(hSUhT}r6(Unumberedr6KUparentr6jU titlesonlyr6Uglobr6h\]r6hZ]r6hV]r6hX]r6h^]r6Uentriesr6]r7(Nj"r7Nj#r7Nj$r7eUhiddenr7U includefilesr7]r7(j"j#j$eUmaxdepthr7Kuhgj6h`]r7hhj~ubahhjubehhjubahhjubjj.)r 7}r 7(hSUhT}r 7(hV]r 7hX]r 7hZ]r7h\]r7h^]r7uh`]r7j8)r7}r7(hSUhT}r7(hV]r7hX]r7hZ]r7h\]r7h^]r7uhgj 7h`]r7(jB)r7}r7(hSUhT}r7(hV]r7hX]r7hZ]r 7h\]r!7h^]r"7uhgj7h`]r#7jL)r$7}r%7(hSUhT}r&7(U anchornamer'7UUrefurir(7jh\]r)7hZ]r*7hV]r+7hX]r,7h^]r-7Uinternalr.7uhgj7h`]r/7(ht)r07}r17(hSXcircuits.web.headersr27hT}r37(hV]r47hX]r57hZ]r67h\]r77h^]r87uhgj$7h`]r97hbXcircuits.web.headersr:7r;7}r<7(hSUhgj07ubahhhubhbX -- Headersr=7r>7}r?7(hSjhgj$7ubehhj\ubahhj]ubj.)r@7}rA7(hSUhT}rB7(hV]rC7hX]rD7hZ]rE7h\]rF7h^]rG7uhgj7h`]rH7(j8)rI7}rJ7(hSUhT}rK7(hV]rL7hX]rM7hZ]rN7h\]rO7h^]rP7uhgj@7h`]rQ7jB)rR7}rS7(hSUhT}rT7(hV]rU7hX]rV7hZ]rW7h\]rX7h^]rY7uhgjI7h`]rZ7jL)r[7}r\7(hSUhT}r]7(U anchornamer^7U#eventsr_7Urefurir`7jh\]ra7hZ]rb7hV]rc7hX]rd7h^]re7Uinternalrf7uhgjR7h`]rg7hbXEventsrh7ri7}rj7(hSXEventsrk7hgj[7ubahhj\ubahhj]ubahhjubj8)rl7}rm7(hSUhT}rn7(hV]ro7hX]rp7hZ]rq7h\]rr7h^]rs7uhgj@7h`]rt7jB)ru7}rv7(hSUhT}rw7(hV]rx7hX]ry7hZ]rz7h\]r{7h^]r|7uhgjl7h`]r}7jL)r~7}r7(hSUhT}r7(U anchornamer7U#classesr7Urefurir7jh\]r7hZ]r7hV]r7hX]r7h^]r7Uinternalr7uhgju7h`]r7hbXClassesr7r7}r7(hSXClassesr7hgj~7ubahhj\ubahhj]ubahhjubj8)r7}r7(hSUhT}r7(hV]r7hX]r7hZ]r7h\]r7h^]r7uhgj@7h`]r7jB)r7}r7(hSUhT}r7(hV]r7hX]r7hZ]r7h\]r7h^]r7uhgj7h`]r7jL)r7}r7(hSUhT}r7(U anchornamer7U #componentsr7Urefurir7jh\]r7hZ]r7hV]r7hX]r7h^]r7Uinternalr7uhgj7h`]r7hbX Componentsr7r7}r7(hSX Componentsr7hgj7ubahhj\ubahhj]ubahhjubj8)r7}r7(hSUhT}r7(hV]r7hX]r7hZ]r7h\]r7h^]r7uhgj@7h`]r7jB)r7}r7(hSUhT}r7(hV]r7hX]r7hZ]r7h\]r7h^]r7uhgj7h`]r7jL)r7}r7(hSUhT}r7(U anchornamer7U #functionsr7Urefurir7jh\]r7hZ]r7hV]r7hX]r7h^]r7Uinternalr7uhgj7h`]r7hbX Functionsr7r7}r7(hSX Functionsr7hgj7ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r7}r7(hSUhT}r7(hV]r7hX]r7hZ]r7h\]r7h^]r7uh`]r7j8)r7}r7(hSUhT}r7(hV]r7hX]r7hZ]r7h\]r7h^]r7uhgj7h`]r7(jB)r7}r7(hSUhT}r7(hV]r7hX]r7hZ]r7h\]r7h^]r7uhgj7h`]r7jL)r7}r7(hSUhT}r7(U anchornamer7UUrefurir7jh\]r7hZ]r7hV]r7hX]r7h^]r7Uinternalr7uhgj7h`]r7hbXHowTosr7r7}r7(hSjhgj7ubahhj\ubahhj]ubj.)r7}r8(hSUhT}r8(hV]r8hX]r8hZ]r8h\]r8h^]r8uhgj7h`]r8jg)r8}r 8(hSUhT}r 8(Unumberedr 8KUparentr 8jU titlesonlyr 8Uglobr8h\]r8hZ]r8hV]r8hX]r8h^]r8Uentriesr8]r8Nj'r8aUhiddenr8U includefilesr8]r8j'aUmaxdepthr8Kuhgj7h`]r8hhj~ubahhjubehhjubahhjubjj.)r8}r8(hSUhT}r8(hV]r8hX]r 8hZ]r!8h\]r"8h^]r#8uh`]r$8j8)r%8}r&8(hSUhT}r'8(hV]r(8hX]r)8hZ]r*8h\]r+8h^]r,8uhgj8h`]r-8(jB)r.8}r/8(hSUhT}r08(hV]r18hX]r28hZ]r38h\]r48h^]r58uhgj%8h`]r68jL)r78}r88(hSUhT}r98(U anchornamer:8UUrefurir;8jh\]r<8hZ]r=8hV]r>8hX]r?8h^]r@8UinternalrA8uhgj.8h`]rB8hbXDevelopment IntroductionrC8rD8}rE8(hSj!hgj78ubahhj\ubahhj]ubj.)rF8}rG8(hSUhT}rH8(hV]rI8hX]rJ8hZ]rK8h\]rL8h^]rM8uhgj%8h`]rN8(j8)rO8}rP8(hSUhT}rQ8(hV]rR8hX]rS8hZ]rT8h\]rU8h^]rV8uhgjF8h`]rW8jB)rX8}rY8(hSUhT}rZ8(hV]r[8hX]r\8hZ]r]8h\]r^8h^]r_8uhgjO8h`]r`8jL)ra8}rb8(hSUhT}rc8(U anchornamerd8U #standardsre8Urefurirf8jh\]rg8hZ]rh8hV]ri8hX]rj8h^]rk8Uinternalrl8uhgjX8h`]rm8hbX Standardsrn8ro8}rp8(hSX Standardsrq8hgja8ubahhj\ubahhj]ubahhjubj8)rr8}rs8(hSUhT}rt8(hV]ru8hX]rv8hZ]rw8h\]rx8h^]ry8uhgjF8h`]rz8jB)r{8}r|8(hSUhT}r}8(hV]r~8hX]r8hZ]r8h\]r8h^]r8uhgjr8h`]r8jL)r8}r8(hSUhT}r8(U anchornamer8U#toolsr8Urefurir8jh\]r8hZ]r8hV]r8hX]r8h^]r8Uinternalr8uhgj{8h`]r8hbXToolsr8r8}r8(hSXToolsr8hgj8ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubj"j.)r8}r8(hSUhT}r8(hV]r8hX]r8hZ]r8h\]r8h^]r8uh`]r8j8)r8}r8(hSUhT}r8(hV]r8hX]r8hZ]r8h\]r8h^]r8uhgj8h`]r8(jB)r8}r8(hSUhT}r8(hV]r8hX]r8hZ]r8h\]r8h^]r8uhgj8h`]r8jL)r8}r8(hSUhT}r8(U anchornamer8UUrefurir8j"h\]r8hZ]r8hV]r8hX]r8h^]r8Uinternalr8uhgj8h`]r8(ht)r8}r8(hSXcircuits.web.dispatchers.xmlrpcr8hT}r8(hV]r8hX]r8hZ]r8h\]r8h^]r8uhgj8h`]r8hbXcircuits.web.dispatchers.xmlrpcr8r8}r8(hSUhgj8ubahhhubhbX -- XML-RPCr8r8}r8(hSj<hgj8ubehhj\ubahhj]ubj.)r8}r8(hSUhT}r8(hV]r8hX]r8hZ]r8h\]r8h^]r8uhgj8h`]r8(j8)r8}r8(hSUhT}r8(hV]r8hX]r8hZ]r8h\]r8h^]r8uhgj8h`]r8jB)r8}r8(hSUhT}r8(hV]r8hX]r8hZ]r8h\]r8h^]r8uhgj8h`]r8jL)r8}r8(hSUhT}r8(U anchornamer8U#eventsr8Urefurir8j"h\]r8hZ]r8hV]r8hX]r8h^]r8Uinternalr8uhgj8h`]r8hbXEventsr8r8}r8(hSXEventsr8hgj8ubahhj\ubahhj]ubahhjubj8)r8}r8(hSUhT}r8(hV]r8hX]r8hZ]r8h\]r8h^]r8uhgj8h`]r9jB)r9}r9(hSUhT}r9(hV]r9hX]r9hZ]r9h\]r9h^]r9uhgj8h`]r 9jL)r 9}r 9(hSUhT}r 9(U anchornamer 9U #componentsr9Urefurir9j"h\]r9hZ]r9hV]r9hX]r9h^]r9Uinternalr9uhgj9h`]r9hbX Componentsr9r9}r9(hSX Componentsr9hgj 9ubahhj\ubahhj]ubahhjubj8)r9}r9(hSUhT}r9(hV]r9hX]r9hZ]r 9h\]r!9h^]r"9uhgj8h`]r#9jB)r$9}r%9(hSUhT}r&9(hV]r'9hX]r(9hZ]r)9h\]r*9h^]r+9uhgj9h`]r,9jL)r-9}r.9(hSUhT}r/9(U anchornamer09U #functionsr19Urefurir29j"h\]r39hZ]r49hV]r59hX]r69h^]r79Uinternalr89uhgj$9h`]r99hbX Functionsr:9r;9}r<9(hSX Functionsr=9hgj-9ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubj=j.)r>9}r?9(hSUhT}r@9(hV]rA9hX]rB9hZ]rC9h\]rD9h^]rE9uh`]rF9j8)rG9}rH9(hSUhT}rI9(hV]rJ9hX]rK9hZ]rL9h\]rM9h^]rN9uhgj>9h`]rO9(jB)rP9}rQ9(hSUhT}rR9(hV]rS9hX]rT9hZ]rU9h\]rV9h^]rW9uhgjG9h`]rX9jL)rY9}rZ9(hSUhT}r[9(U anchornamer\9UUrefurir]9j=h\]r^9hZ]r_9hV]r`9hX]ra9h^]rb9Uinternalrc9uhgjP9h`]rd9(ht)re9}rf9(hSX#circuits.web.dispatchers.websocketsrg9hT}rh9(hV]ri9hX]rj9hZ]rk9h\]rl9h^]rm9uhgjY9h`]rn9hbX#circuits.web.dispatchers.websocketsro9rp9}rq9(hSUhgje9ubahhhubhbX -- WebSocketsrr9rs9}rt9(hSjWhgjY9ubehhj\ubahhj]ubj.)ru9}rv9(hSUhT}rw9(hV]rx9hX]ry9hZ]rz9h\]r{9h^]r|9uhgjG9h`]r}9(j8)r~9}r9(hSUhT}r9(hV]r9hX]r9hZ]r9h\]r9h^]r9uhgju9h`]r9jB)r9}r9(hSUhT}r9(hV]r9hX]r9hZ]r9h\]r9h^]r9uhgj~9h`]r9jL)r9}r9(hSUhT}r9(U anchornamer9U#eventsr9Urefurir9j=h\]r9hZ]r9hV]r9hX]r9h^]r9Uinternalr9uhgj9h`]r9hbXEventsr9r9}r9(hSXEventsr9hgj9ubahhj\ubahhj]ubahhjubj8)r9}r9(hSUhT}r9(hV]r9hX]r9hZ]r9h\]r9h^]r9uhgju9h`]r9jB)r9}r9(hSUhT}r9(hV]r9hX]r9hZ]r9h\]r9h^]r9uhgj9h`]r9jL)r9}r9(hSUhT}r9(U anchornamer9U #componentsr9Urefurir9j=h\]r9hZ]r9hV]r9hX]r9h^]r9Uinternalr9uhgj9h`]r9hbX Componentsr9r9}r9(hSX Componentsr9hgj9ubahhj\ubahhj]ubahhjubj8)r9}r9(hSUhT}r9(hV]r9hX]r9hZ]r9h\]r9h^]r9uhgju9h`]r9jB)r9}r9(hSUhT}r9(hV]r9hX]r9hZ]r9h\]r9h^]r9uhgj9h`]r9jL)r9}r9(hSUhT}r9(U anchornamer9U #functionsr9Urefurir9j=h\]r9hZ]r9hV]r9hX]r9h^]r9Uinternalr9uhgj9h`]r9hbX Functionsr9r9}r9(hSX Functionsr9hgj9ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjXj.)r9}r9(hSUhT}r9(hV]r9hX]r9hZ]r9h\]r9h^]r9uh`]r9j8)r9}r9(hSUhT}r9(hV]r9hX]r9hZ]r9h\]r9h^]r9uhgj9h`]r9(jB)r9}r9(hSUhT}r9(hV]r9hX]r9hZ]r9h\]r9h^]r:uhgj9h`]r:jL)r:}r:(hSUhT}r:(U anchornamer:UUrefurir:jXh\]r:hZ]r:hV]r :hX]r :h^]r :Uinternalr :uhgj9h`]r :(ht)r:}r:(hSXcircuits.net.socketsr:hT}r:(hV]r:hX]r:hZ]r:h\]r:h^]r:uhgj:h`]r:hbXcircuits.net.socketsr:r:}r:(hSUhgj:ubahhhubhbX -- Socket Componentsr:r:}r:(hSjrhgj:ubehhj\ubahhj]ubj.)r:}r:(hSUhT}r :(hV]r!:hX]r":hZ]r#:h\]r$:h^]r%:uhgj9h`]r&:(j8)r':}r(:(hSUhT}r):(hV]r*:hX]r+:hZ]r,:h\]r-:h^]r.:uhgj:h`]r/:jB)r0:}r1:(hSUhT}r2:(hV]r3:hX]r4:hZ]r5:h\]r6:h^]r7:uhgj':h`]r8:jL)r9:}r::(hSUhT}r;:(U anchornamer<:U#eventsr=:Urefurir>:jXh\]r?:hZ]r@:hV]rA:hX]rB:h^]rC:UinternalrD:uhgj0:h`]rE:hbXEventsrF:rG:}rH:(hSXEventsrI:hgj9:ubahhj\ubahhj]ubahhjubj8)rJ:}rK:(hSUhT}rL:(hV]rM:hX]rN:hZ]rO:h\]rP:h^]rQ:uhgj:h`]rR:jB)rS:}rT:(hSUhT}rU:(hV]rV:hX]rW:hZ]rX:h\]rY:h^]rZ:uhgjJ:h`]r[:jL)r\:}r]:(hSUhT}r^:(U anchornamer_:U #componentsr`:Urefurira:jXh\]rb:hZ]rc:hV]rd:hX]re:h^]rf:Uinternalrg:uhgjS:h`]rh:hbX Componentsri:rj:}rk:(hSX Componentsrl:hgj\:ubahhj\ubahhj]ubahhjubj8)rm:}rn:(hSUhT}ro:(hV]rp:hX]rq:hZ]rr:h\]rs:h^]rt:uhgj:h`]ru:jB)rv:}rw:(hSUhT}rx:(hV]ry:hX]rz:hZ]r{:h\]r|:h^]r}:uhgjm:h`]r~:jL)r:}r:(hSUhT}r:(U anchornamer:U #functionsr:Urefurir:jXh\]r:hZ]r:hV]r:hX]r:h^]r:Uinternalr:uhgjv:h`]r:hbX Functionsr:r:}r:(hSX Functionsr:hgj:ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjsj.)r:}r:(hSUhT}r:(hV]r:hX]r:hZ]r:h\]r:h^]r:uh`]r:j8)r:}r:(hSUhT}r:(hV]r:hX]r:hZ]r:h\]r:h^]r:uhgj:h`]r:(jB)r:}r:(hSUhT}r:(hV]r:hX]r:hZ]r:h\]r:h^]r:uhgj:h`]r:jL)r:}r:(hSUhT}r:(U anchornamer:UUrefurir:jsh\]r:hZ]r:hV]r:hX]r:h^]r:Uinternalr:uhgj:h`]r:(ht)r:}r:(hSXcircuits.core.eventsr:hT}r:(hV]r:hX]r:hZ]r:h\]r:h^]r:uhgj:h`]r:hbXcircuits.core.eventsr:r:}r:(hSUhgj:ubahhhubhbX -- Eventsr:r:}r:(hSjhgj:ubehhj\ubahhj]ubj.)r:}r:(hSUhT}r:(hV]r:hX]r:hZ]r:h\]r:h^]r:uhgj:h`]r:(j8)r:}r:(hSUhT}r:(hV]r:hX]r:hZ]r:h\]r:h^]r:uhgj:h`]r:jB)r:}r:(hSUhT}r:(hV]r:hX]r:hZ]r:h\]r:h^]r:uhgj:h`]r:jL)r:}r:(hSUhT}r:(U anchornamer:U#classesr:Urefurir:jsh\]r:hZ]r:hV]r:hX]r:h^]r:Uinternalr:uhgj:h`]r:hbXClassesr:r:}r:(hSXClassesr:hgj:ubahhj\ubahhj]ubahhjubj8)r:}r:(hSUhT}r:(hV]r:hX]r:hZ]r:h\]r:h^]r:uhgj:h`]r:jB)r:}r:(hSUhT}r:(hV]r:hX]r;hZ]r;h\]r;h^]r;uhgj:h`]r;jL)r;}r;(hSUhT}r;(U anchornamer;U #componentsr ;Urefurir ;jsh\]r ;hZ]r ;hV]r ;hX]r;h^]r;Uinternalr;uhgj:h`]r;hbX Componentsr;r;}r;(hSX Componentsr;hgj;ubahhj\ubahhj]ubahhjubj8)r;}r;(hSUhT}r;(hV]r;hX]r;hZ]r;h\]r;h^]r;uhgj:h`]r;jB)r;}r ;(hSUhT}r!;(hV]r";hX]r#;hZ]r$;h\]r%;h^]r&;uhgj;h`]r';jL)r(;}r);(hSUhT}r*;(U anchornamer+;U#eventsr,;Urefurir-;jsh\]r.;hZ]r/;hV]r0;hX]r1;h^]r2;Uinternalr3;uhgj;h`]r4;hbXEventsr5;r6;}r7;(hSXEventsr8;hgj(;ubahhj\ubahhj]ubahhjubj8)r9;}r:;(hSUhT}r;;(hV]r<;hX]r=;hZ]r>;h\]r?;h^]r@;uhgj:h`]rA;jB)rB;}rC;(hSUhT}rD;(hV]rE;hX]rF;hZ]rG;h\]rH;h^]rI;uhgj9;h`]rJ;jL)rK;}rL;(hSUhT}rM;(U anchornamerN;U #functionsrO;UrefurirP;jsh\]rQ;hZ]rR;hV]rS;hX]rT;h^]rU;UinternalrV;uhgjB;h`]rW;hbX FunctionsrX;rY;}rZ;(hSX Functionsr[;hgjK;ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r\;}r];(hSUhT}r^;(hV]r_;hX]r`;hZ]ra;h\]rb;h^]rc;uh`]rd;j8)re;}rf;(hSUhT}rg;(hV]rh;hX]ri;hZ]rj;h\]rk;h^]rl;uhgj\;h`]rm;(jB)rn;}ro;(hSUhT}rp;(hV]rq;hX]rr;hZ]rs;h\]rt;h^]ru;uhgje;h`]rv;jL)rw;}rx;(hSUhT}ry;(U anchornamerz;UUrefurir{;jh\]r|;hZ]r};hV]r~;hX]r;h^]r;Uinternalr;uhgjn;h`]r;(ht)r;}r;(hSXcircuits.web.serversr;hT}r;(hV]r;hX]r;hZ]r;h\]r;h^]r;uhgjw;h`]r;hbXcircuits.web.serversr;r;}r;(hSUhgj;ubahhhubhbX -- Serversr;r;}r;(hSjhgjw;ubehhj\ubahhj]ubj.)r;}r;(hSUhT}r;(hV]r;hX]r;hZ]r;h\]r;h^]r;uhgje;h`]r;(j8)r;}r;(hSUhT}r;(hV]r;hX]r;hZ]r;h\]r;h^]r;uhgj;h`]r;jB)r;}r;(hSUhT}r;(hV]r;hX]r;hZ]r;h\]r;h^]r;uhgj;h`]r;jL)r;}r;(hSUhT}r;(U anchornamer;U#eventsr;Urefurir;jh\]r;hZ]r;hV]r;hX]r;h^]r;Uinternalr;uhgj;h`]r;hbXEventsr;r;}r;(hSXEventsr;hgj;ubahhj\ubahhj]ubahhjubj8)r;}r;(hSUhT}r;(hV]r;hX]r;hZ]r;h\]r;h^]r;uhgj;h`]r;jB)r;}r;(hSUhT}r;(hV]r;hX]r;hZ]r;h\]r;h^]r;uhgj;h`]r;jL)r;}r;(hSUhT}r;(U anchornamer;U #componentsr;Urefurir;jh\]r;hZ]r;hV]r;hX]r;h^]r;Uinternalr;uhgj;h`]r;hbX Componentsr;r;}r;(hSX Componentsr;hgj;ubahhj\ubahhj]ubahhjubj8)r;}r;(hSUhT}r;(hV]r;hX]r;hZ]r;h\]r;h^]r;uhgj;h`]r;jB)r;}r;(hSUhT}r;(hV]r;hX]r;hZ]r;h\]r;h^]r;uhgj;h`]r;jL)r;}r;(hSUhT}r;(U anchornamer;U #functionsr;Urefurir;jh\]r;hZ]r;hV]r;hX]r;h^]r;Uinternalr;uhgj;h`]r<hbX Functionsr<r<}r<(hSX Functionsr<hgj;ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r<}r<(hSUhT}r<(hV]r<hX]r <hZ]r <h\]r <h^]r <uh`]r <j8)r<}r<(hSUhT}r<(hV]r<hX]r<hZ]r<h\]r<h^]r<uhgj<h`]r<jB)r<}r<(hSUhT}r<(hV]r<hX]r<hZ]r<h\]r<h^]r<uhgj<h`]r<jL)r <}r!<(hSUhT}r"<(U anchornamer#<UUrefurir$<jh\]r%<hZ]r&<hV]r'<hX]r(<h^]r)<Uinternalr*<uhgj<h`]r+<hbXGlossaryr,<r-<}r.<(hSjhgj <ubahhj\ubahhj]ubahhjubahhjubjj.)r/<}r0<(hSUhT}r1<(hV]r2<hX]r3<hZ]r4<h\]r5<h^]r6<uh`]r7<j8)r8<}r9<(hSUhT}r:<(hV]r;<hX]r<<hZ]r=<h\]r><h^]r?<uhgj/<h`]r@<(jB)rA<}rB<(hSUhT}rC<(hV]rD<hX]rE<hZ]rF<h\]rG<h^]rH<uhgj8<h`]rI<jL)rJ<}rK<(hSUhT}rL<(U anchornamerM<UUrefurirN<jh\]rO<hZ]rP<hV]rQ<hX]rR<h^]rS<UinternalrT<uhgjA<h`]rU<(ht)rV<}rW<(hSXcircuits.web.wsgirX<hT}rY<(hV]rZ<hX]r[<hZ]r\<h\]r]<h^]r^<uhgjJ<h`]r_<hbXcircuits.web.wsgir`<ra<}rb<(hSUhgjV<ubahhhubhbX -- WSGI Supportrc<rd<}re<(hSjhgjJ<ubehhj\ubahhj]ubj.)rf<}rg<(hSUhT}rh<(hV]ri<hX]rj<hZ]rk<h\]rl<h^]rm<uhgj8<h`]rn<(j8)ro<}rp<(hSUhT}rq<(hV]rr<hX]rs<hZ]rt<h\]ru<h^]rv<uhgjf<h`]rw<jB)rx<}ry<(hSUhT}rz<(hV]r{<hX]r|<hZ]r}<h\]r~<h^]r<uhgjo<h`]r<jL)r<}r<(hSUhT}r<(U anchornamer<U#eventsr<Urefurir<jh\]r<hZ]r<hV]r<hX]r<h^]r<Uinternalr<uhgjx<h`]r<hbXEventsr<r<}r<(hSXEventsr<hgj<ubahhj\ubahhj]ubahhjubj8)r<}r<(hSUhT}r<(hV]r<hX]r<hZ]r<h\]r<h^]r<uhgjf<h`]r<jB)r<}r<(hSUhT}r<(hV]r<hX]r<hZ]r<h\]r<h^]r<uhgj<h`]r<jL)r<}r<(hSUhT}r<(U anchornamer<U #componentsr<Urefurir<jh\]r<hZ]r<hV]r<hX]r<h^]r<Uinternalr<uhgj<h`]r<hbX Componentsr<r<}r<(hSX Componentsr<hgj<ubahhj\ubahhj]ubahhjubj8)r<}r<(hSUhT}r<(hV]r<hX]r<hZ]r<h\]r<h^]r<uhgjf<h`]r<jB)r<}r<(hSUhT}r<(hV]r<hX]r<hZ]r<h\]r<h^]r<uhgj<h`]r<jL)r<}r<(hSUhT}r<(U anchornamer<U #functionsr<Urefurir<jh\]r<hZ]r<hV]r<hX]r<h^]r<Uinternalr<uhgj<h`]r<hbX Functionsr<r<}r<(hSX Functionsr<hgj<ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r<}r<(hSUhT}r<(hV]r<hX]r<hZ]r<h\]r<h^]r<uh`]r<j8)r<}r<(hSUhT}r<(hV]r<hX]r<hZ]r<h\]r<h^]r<uhgj<h`]r<jB)r<}r<(hSUhT}r<(hV]r<hX]r<hZ]r<h\]r<h^]r<uhgj<h`]r<jL)r<}r<(hSUhT}r<(U anchornamer<UUrefurir<jh\]r<hZ]r<hV]r<hX]r<h^]r<Uinternalr<uhgj<h`]r<hbXQuick Start Guider<r=}r=(hSjhgj<ubahhj\ubahhj]ubahhjubahhjubh&j.)r=}r=(hSUhT}r=(hV]r=hX]r=hZ]r=h\]r=h^]r =uh`]r =j8)r =}r =(hSUhT}r =(hV]r=hX]r=hZ]r=h\]r=h^]r=uhgj=h`]r=(jB)r=}r=(hSUhT}r=(hV]r=hX]r=hZ]r=h\]r=h^]r=uhgj =h`]r=jL)r=}r=(hSUhT}r=(U anchornamer =UUrefurir!=h&h\]r"=hZ]r#=hV]r$=hX]r%=h^]r&=Uinternalr'=uhgj=h`]r(=hbXEventsr)=r*=}r+=(hSjhgj=ubahhj\ubahhj]ubj.)r,=}r-=(hSUhT}r.=(hV]r/=hX]r0=hZ]r1=h\]r2=h^]r3=uhgj =h`]r4=(j8)r5=}r6=(hSUhT}r7=(hV]r8=hX]r9=hZ]r:=h\]r;=h^]r<=uhgj,=h`]r==jB)r>=}r?=(hSUhT}r@=(hV]rA=hX]rB=hZ]rC=h\]rD=h^]rE=uhgj5=h`]rF=jL)rG=}rH=(hSUhT}rI=(U anchornamerJ=U #basic-usagerK=UrefurirL=h&h\]rM=hZ]rN=hV]rO=hX]rP=h^]rQ=UinternalrR=uhgj>=h`]rS=hbX Basic usagerT=rU=}rV=(hSX Basic usagerW=hgjG=ubahhj\ubahhj]ubahhjubj8)rX=}rY=(hSUhT}rZ=(hV]r[=hX]r\=hZ]r]=h\]r^=h^]r_=uhgj,=h`]r`=jB)ra=}rb=(hSUhT}rc=(hV]rd=hX]re=hZ]rf=h\]rg=h^]rh=uhgjX=h`]ri=jL)rj=}rk=(hSUhT}rl=(U anchornamerm=U#events-as-result-collectorsrn=Urefuriro=h&h\]rp=hZ]rq=hV]rr=hX]rs=h^]rt=Uinternalru=uhgja=h`]rv=hbXEvents as result collectorsrw=rx=}ry=(hSXEvents as result collectorsrz=hgjj=ubahhj\ubahhj]ubahhjubj8)r{=}r|=(hSUhT}r}=(hV]r~=hX]r=hZ]r=h\]r=h^]r=uhgj,=h`]r=jB)r=}r=(hSUhT}r=(hV]r=hX]r=hZ]r=h\]r=h^]r=uhgj{=h`]r=jL)r=}r=(hSUhT}r=(U anchornamer=U#advanced-usager=Urefurir=h&h\]r=hZ]r=hV]r=hX]r=h^]r=Uinternalr=uhgj=h`]r=hbXAdvanced usager=r=}r=(hSXAdvanced usager=hgj=ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r=}r=(hSUhT}r=(hV]r=hX]r=hZ]r=h\]r=h^]r=uh`]r=j8)r=}r=(hSUhT}r=(hV]r=hX]r=hZ]r=h\]r=h^]r=uhgj=h`]r=jB)r=}r=(hSUhT}r=(hV]r=hX]r=hZ]r=h\]r=h^]r=uhgj=h`]r=jL)r=}r=(hSUhT}r=(U anchornamer=UUrefurir=jh\]r=hZ]r=hV]r=hX]r=h^]r=Uinternalr=uhgj=h`]r=hbX Contributorsr=r=}r=(hSjhgj=ubahhj\ubahhj]ubahhjubahhjubjj.)r=}r=(hSUhT}r=(hV]r=hX]r=hZ]r=h\]r=h^]r=uh`]r=j8)r=}r=(hSUhT}r=(hV]r=hX]r=hZ]r=h\]r=h^]r=uhgj=h`]r=(jB)r=}r=(hSUhT}r=(hV]r=hX]r=hZ]r=h\]r=h^]r=uhgj=h`]r=jL)r=}r=(hSUhT}r=(U anchornamer=UUrefurir=jh\]r=hZ]r=hV]r=hX]r=h^]r=Uinternalr=uhgj=h`]r=hbX Introductionr=r=}r=(hSjhgj=ubahhj\ubahhj]ubj.)r=}r=(hSUhT}r=(hV]r=hX]r=hZ]r=h\]r=h^]r=uhgj=h`]r=j8)r=}r=(hSUhT}r=(hV]r=hX]r=hZ]r>h\]r>h^]r>uhgj=h`]r>(jB)r>}r>(hSUhT}r>(hV]r>hX]r>hZ]r >h\]r >h^]r >uhgj=h`]r >jL)r >}r>(hSUhT}r>(U anchornamer>U #overviewr>Urefurir>jh\]r>hZ]r>hV]r>hX]r>h^]r>Uinternalr>uhgj>h`]r>hbXOverviewr>r>}r>(hSXOverviewr>hgj >ubahhj\ubahhj]ubj.)r>}r>(hSUhT}r >(hV]r!>hX]r">hZ]r#>h\]r$>h^]r%>uhgj=h`]r&>(j8)r'>}r(>(hSUhT}r)>(hV]r*>hX]r+>hZ]r,>h\]r->h^]r.>uhgj>h`]r/>jB)r0>}r1>(hSUhT}r2>(hV]r3>hX]r4>hZ]r5>h\]r6>h^]r7>uhgj'>h`]r8>jL)r9>}r:>(hSUhT}r;>(U anchornamer<>U#eventsr=>Urefurir>>jh\]r?>hZ]r@>hV]rA>hX]rB>h^]rC>UinternalrD>uhgj0>h`]rE>hbXEventsrF>rG>}rH>(hSXEventsrI>hgj9>ubahhj\ubahhj]ubahhjubj8)rJ>}rK>(hSUhT}rL>(hV]rM>hX]rN>hZ]rO>h\]rP>h^]rQ>uhgj>h`]rR>jB)rS>}rT>(hSUhT}rU>(hV]rV>hX]rW>hZ]rX>h\]rY>h^]rZ>uhgjJ>h`]r[>jL)r\>}r]>(hSUhT}r^>(U anchornamer_>U#serversr`>Urefurira>jh\]rb>hZ]rc>hV]rd>hX]re>h^]rf>Uinternalrg>uhgjS>h`]rh>hbXServersri>rj>}rk>(hSXServersrl>hgj\>ubahhj\ubahhj]ubahhjubj8)rm>}rn>(hSUhT}ro>(hV]rp>hX]rq>hZ]rr>h\]rs>h^]rt>uhgj>h`]ru>jB)rv>}rw>(hSUhT}rx>(hV]ry>hX]rz>hZ]r{>h\]r|>h^]r}>uhgjm>h`]r~>jL)r>}r>(hSUhT}r>(U anchornamer>U #error-eventsr>Urefurir>jh\]r>hZ]r>hV]r>hX]r>h^]r>Uinternalr>uhgjv>h`]r>hbX Error Eventsr>r>}r>(hSX Error Eventsr>hgj>ubahhj\ubahhj]ubahhjubj8)r>}r>(hSUhT}r>(hV]r>hX]r>hZ]r>h\]r>h^]r>uhgj>h`]r>jB)r>}r>(hSUhT}r>(hV]r>hX]r>hZ]r>h\]r>h^]r>uhgj>h`]r>jL)r>}r>(hSUhT}r>(U anchornamer>U #dispatchersr>Urefurir>jh\]r>hZ]r>hV]r>hX]r>h^]r>Uinternalr>uhgj>h`]r>hbX Dispatchersr>r>}r>(hSX Dispatchersr>hgj>ubahhj\ubahhj]ubahhjubj8)r>}r>(hSUhT}r>(hV]r>hX]r>hZ]r>h\]r>h^]r>uhgj>h`]r>jB)r>}r>(hSUhT}r>(hV]r>hX]r>hZ]r>h\]r>h^]r>uhgj>h`]r>jL)r>}r>(hSUhT}r>(U anchornamer>U#other-componentsr>Urefurir>jh\]r>hZ]r>hV]r>hX]r>h^]r>Uinternalr>uhgj>h`]r>hbXOther Componentsr>r>}r>(hSXOther Componentsr>hgj>ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubehhjubahhjubj j.)r>}r>(hSUhT}r>(hV]r>hX]r>hZ]r>h\]r>h^]r>uh`]r>j8)r>}r>(hSUhT}r>(hV]r>hX]r>hZ]r>h\]r>h^]r>uhgj>h`]r>(jB)r>}r>(hSUhT}r>(hV]r>hX]r>hZ]r>h\]r>h^]r>uhgj>h`]r>jL)r>}r>(hSUhT}r>(U anchornamer>UUrefurir>j h\]r>hZ]r>hV]r>hX]r>h^]r>Uinternalr>uhgj>h`]r>(ht)r>}r>(hSXcircuits.node.clientr>hT}r?(hV]r?hX]r?hZ]r?h\]r?h^]r?uhgj>h`]r?hbXcircuits.node.clientr?r?}r ?(hSUhgj>ubahhhubhbX -- Clientr ?r ?}r ?(hSj#hgj>ubehhj\ubahhj]ubj.)r ?}r?(hSUhT}r?(hV]r?hX]r?hZ]r?h\]r?h^]r?uhgj>h`]r?(j8)r?}r?(hSUhT}r?(hV]r?hX]r?hZ]r?h\]r?h^]r?uhgj ?h`]r?jB)r?}r ?(hSUhT}r!?(hV]r"?hX]r#?hZ]r$?h\]r%?h^]r&?uhgj?h`]r'?jL)r(?}r)?(hSUhT}r*?(U anchornamer+?U#eventsr,?Urefurir-?j h\]r.?hZ]r/?hV]r0?hX]r1?h^]r2?Uinternalr3?uhgj?h`]r4?hbXEventsr5?r6?}r7?(hSXEventsr8?hgj(?ubahhj\ubahhj]ubahhjubj8)r9?}r:?(hSUhT}r;?(hV]r?h\]r??h^]r@?uhgj ?h`]rA?jB)rB?}rC?(hSUhT}rD?(hV]rE?hX]rF?hZ]rG?h\]rH?h^]rI?uhgj9?h`]rJ?jL)rK?}rL?(hSUhT}rM?(U anchornamerN?U #componentsrO?UrefurirP?j h\]rQ?hZ]rR?hV]rS?hX]rT?h^]rU?UinternalrV?uhgjB?h`]rW?hbX ComponentsrX?rY?}rZ?(hSX Componentsr[?hgjK?ubahhj\ubahhj]ubahhjubj8)r\?}r]?(hSUhT}r^?(hV]r_?hX]r`?hZ]ra?h\]rb?h^]rc?uhgj ?h`]rd?jB)re?}rf?(hSUhT}rg?(hV]rh?hX]ri?hZ]rj?h\]rk?h^]rl?uhgj\?h`]rm?jL)rn?}ro?(hSUhT}rp?(U anchornamerq?U #functionsrr?Urefurirs?j h\]rt?hZ]ru?hV]rv?hX]rw?h^]rx?Uinternalry?uhgje?h`]rz?hbX Functionsr{?r|?}r}?(hSX Functionsr~?hgjn?ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubh j.)r?}r?(hSUhT}r?(hV]r?hX]r?hZ]r?h\]r?h^]r?uh`]r?j8)r?}r?(hSUhT}r?(hV]r?hX]r?hZ]r?h\]r?h^]r?uhgj?h`]r?(jB)r?}r?(hSUhT}r?(hV]r?hX]r?hZ]r?h\]r?h^]r?uhgj?h`]r?jL)r?}r?(hSUhT}r?(U anchornamer?UUrefurir?h h\]r?hZ]r?hV]r?hX]r?h^]r?Uinternalr?uhgj?h`]r?hbXHandlersr?r?}r?(hSj0hgj?ubahhj\ubahhj]ubj.)r?}r?(hSUhT}r?(hV]r?hX]r?hZ]r?h\]r?h^]r?uhgj?h`]r?(j8)r?}r?(hSUhT}r?(hV]r?hX]r?hZ]r?h\]r?h^]r?uhgj?h`]r?jB)r?}r?(hSUhT}r?(hV]r?hX]r?hZ]r?h\]r?h^]r?uhgj?h`]r?jL)r?}r?(hSUhT}r?(U anchornamer?U#explicit-event-handlersr?Urefurir?h h\]r?hZ]r?hV]r?hX]r?h^]r?Uinternalr?uhgj?h`]r?hbXExplicit Event Handlersr?r?}r?(hSXExplicit Event Handlersr?hgj?ubahhj\ubahhj]ubahhjubj8)r?}r?(hSUhT}r?(hV]r?hX]r?hZ]r?h\]r?h^]r?uhgj?h`]r?jB)r?}r?(hSUhT}r?(hV]r?hX]r?hZ]r?h\]r?h^]r?uhgj?h`]r?jL)r?}r?(hSUhT}r?(U anchornamer?U#implicit-event-handlersr?Urefurir?h h\]r?hZ]r?hV]r?hX]r?h^]r?Uinternalr?uhgj?h`]r?hbXImplicit Event Handlersr?r?}r?(hSXImplicit Event Handlersr?hgj?ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubj1j.)r?}r?(hSUhT}r?(hV]r?hX]r?hZ]r?h\]r?h^]r?uh`]r@j8)r@}r@(hSUhT}r@(hV]r@hX]r@hZ]r@h\]r@h^]r@uhgj?h`]r @(jB)r @}r @(hSUhT}r @(hV]r @hX]r@hZ]r@h\]r@h^]r@uhgj@h`]r@jL)r@}r@(hSUhT}r@(U anchornamer@UUrefurir@j1h\]r@hZ]r@hV]r@hX]r@h^]r@Uinternalr@uhgj @h`]r@(ht)r@}r @(hSXcircuits.app.envr!@hT}r"@(hV]r#@hX]r$@hZ]r%@h\]r&@h^]r'@uhgj@h`]r(@hbXcircuits.app.envr)@r*@}r+@(hSUhgj@ubahhhubhbX -- Application Environmentr,@r-@}r.@(hSjKhgj@ubehhj\ubahhj]ubj.)r/@}r0@(hSUhT}r1@(hV]r2@hX]r3@hZ]r4@h\]r5@h^]r6@uhgj@h`]r7@(j8)r8@}r9@(hSUhT}r:@(hV]r;@hX]r<@hZ]r=@h\]r>@h^]r?@uhgj/@h`]r@@jB)rA@}rB@(hSUhT}rC@(hV]rD@hX]rE@hZ]rF@h\]rG@h^]rH@uhgj8@h`]rI@jL)rJ@}rK@(hSUhT}rL@(U anchornamerM@U#eventsrN@UrefurirO@j1h\]rP@hZ]rQ@hV]rR@hX]rS@h^]rT@UinternalrU@uhgjA@h`]rV@hbXEventsrW@rX@}rY@(hSXEventsrZ@hgjJ@ubahhj\ubahhj]ubahhjubj8)r[@}r\@(hSUhT}r]@(hV]r^@hX]r_@hZ]r`@h\]ra@h^]rb@uhgj/@h`]rc@jB)rd@}re@(hSUhT}rf@(hV]rg@hX]rh@hZ]ri@h\]rj@h^]rk@uhgj[@h`]rl@jL)rm@}rn@(hSUhT}ro@(U anchornamerp@U #componentsrq@Urefurirr@j1h\]rs@hZ]rt@hV]ru@hX]rv@h^]rw@Uinternalrx@uhgjd@h`]ry@hbX Componentsrz@r{@}r|@(hSX Componentsr}@hgjm@ubahhj\ubahhj]ubahhjubj8)r~@}r@(hSUhT}r@(hV]r@hX]r@hZ]r@h\]r@h^]r@uhgj/@h`]r@jB)r@}r@(hSUhT}r@(hV]r@hX]r@hZ]r@h\]r@h^]r@uhgj~@h`]r@jL)r@}r@(hSUhT}r@(U anchornamer@U #functionsr@Urefurir@j1h\]r@hZ]r@hV]r@hX]r@h^]r@Uinternalr@uhgj@h`]r@hbX Functionsr@r@}r@(hSX Functionsr@hgj@ubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjLj.)r@}r@(hSUhT}r@(hV]r@hX]r@hZ]r@h\]r@h^]r@uh`]r@j8)r@}r@(hSUhT}r@(hV]r@hX]r@hZ]r@h\]r@h^]r@uhgj@h`]r@(jB)r@}r@(hSUhT}r@(hV]r@hX]r@hZ]r@h\]r@h^]r@uhgj@h`]r@jL)r@}r@(hSUhT}r@(U anchornamer@UUrefurir@jLh\]r@hZ]r@hV]r@hX]r@h^]r@Uinternalr@uhgj@h`]r@(ht)r@}r@(hSXcircuits.io.filer@hT}r@(hV]r@hX]r@hZ]r@h\]r@h^]r@uhgj@h`]r@hbXcircuits.io.filer@r@}r@(hSUhgj@ubahhhubhbX -- File I/Or@r@}r@(hSjfhgj@ubehhj\ubahhj]ubj.)r@}r@(hSUhT}r@(hV]r@hX]r@hZ]r@h\]r@h^]r@uhgj@h`]r@(j8)r@}r@(hSUhT}r@(hV]r@hX]r@hZ]r@h\]r@h^]r@uhgj@h`]r@jB)r@}r@(hSUhT}r@(hV]r@hX]r@hZ]r@h\]r@h^]r@uhgj@h`]r@jL)r@}r@(hSUhT}r@(U anchornamer@U#eventsr@Urefurir@jLh\]r@hZ]r@hV]r@hX]r@h^]r@Uinternalr@uhgj@h`]r@hbXEventsrArA}rA(hSXEventsrAhgj@ubahhj\ubahhj]ubahhjubj8)rA}rA(hSUhT}rA(hV]rAhX]rAhZ]r Ah\]r Ah^]r Auhgj@h`]r AjB)r A}rA(hSUhT}rA(hV]rAhX]rAhZ]rAh\]rAh^]rAuhgjAh`]rAjL)rA}rA(hSUhT}rA(U anchornamerAU #componentsrAUrefurirAjLh\]rAhZ]rAhV]rAhX]rAh^]r AUinternalr!Auhgj Ah`]r"AhbX Componentsr#Ar$A}r%A(hSX Componentsr&AhgjAubahhj\ubahhj]ubahhjubj8)r'A}r(A(hSUhT}r)A(hV]r*AhX]r+AhZ]r,Ah\]r-Ah^]r.Auhgj@h`]r/AjB)r0A}r1A(hSUhT}r2A(hV]r3AhX]r4AhZ]r5Ah\]r6Ah^]r7Auhgj'Ah`]r8AjL)r9A}r:A(hSUhT}r;A(U anchornamerAjLh\]r?AhZ]r@AhV]rAAhX]rBAh^]rCAUinternalrDAuhgj0Ah`]rEAhbX FunctionsrFArGA}rHA(hSX FunctionsrIAhgj9Aubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjgj.)rJA}rKA(hSUhT}rLA(hV]rMAhX]rNAhZ]rOAh\]rPAh^]rQAuh`]rRAj8)rSA}rTA(hSUhT}rUA(hV]rVAhX]rWAhZ]rXAh\]rYAh^]rZAuhgjJAh`]r[A(jB)r\A}r]A(hSUhT}r^A(hV]r_AhX]r`AhZ]raAh\]rbAh^]rcAuhgjSAh`]rdAjL)reA}rfA(hSUhT}rgA(U anchornamerhAUUrefuririAjgh\]rjAhZ]rkAhV]rlAhX]rmAh^]rnAUinternalroAuhgj\Ah`]rpA(ht)rqA}rrA(hSXcircuits.web.controllersrsAhT}rtA(hV]ruAhX]rvAhZ]rwAh\]rxAh^]ryAuhgjeAh`]rzAhbXcircuits.web.controllersr{Ar|A}r}A(hSUhgjqAubahhhubhbX -- Controllersr~ArA}rA(hSjhgjeAubehhj\ubahhj]ubj.)rA}rA(hSUhT}rA(hV]rAhX]rAhZ]rAh\]rAh^]rAuhgjSAh`]rA(j8)rA}rA(hSUhT}rA(hV]rAhX]rAhZ]rAh\]rAh^]rAuhgjAh`]rAjB)rA}rA(hSUhT}rA(hV]rAhX]rAhZ]rAh\]rAh^]rAuhgjAh`]rAjL)rA}rA(hSUhT}rA(U anchornamerAU#eventsrAUrefurirAjgh\]rAhZ]rAhV]rAhX]rAh^]rAUinternalrAuhgjAh`]rAhbXEventsrArA}rA(hSXEventsrAhgjAubahhj\ubahhj]ubahhjubj8)rA}rA(hSUhT}rA(hV]rAhX]rAhZ]rAh\]rAh^]rAuhgjAh`]rAjB)rA}rA(hSUhT}rA(hV]rAhX]rAhZ]rAh\]rAh^]rAuhgjAh`]rAjL)rA}rA(hSUhT}rA(U anchornamerAU #componentsrAUrefurirAjgh\]rAhZ]rAhV]rAhX]rAh^]rAUinternalrAuhgjAh`]rAhbX ComponentsrArA}rA(hSX ComponentsrAhgjAubahhj\ubahhj]ubahhjubj8)rA}rA(hSUhT}rA(hV]rAhX]rAhZ]rAh\]rAh^]rAuhgjAh`]rAjB)rA}rA(hSUhT}rA(hV]rAhX]rAhZ]rAh\]rAh^]rAuhgjAh`]rAjL)rA}rA(hSUhT}rA(U anchornamerAU #functionsrAUrefurirAjgh\]rAhZ]rAhV]rAhX]rAh^]rAUinternalrAuhgjAh`]rAhbX FunctionsrArA}rA(hSX FunctionsrAhgjAubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)rA}rA(hSUhT}rA(hV]rAhX]rAhZ]rAh\]rAh^]rAuh`]rAj8)rA}rA(hSUhT}rA(hV]rAhX]rBhZ]rBh\]rBh^]rBuhgjAh`]rB(jB)rB}rB(hSUhT}rB(hV]rBhX]r BhZ]r Bh\]r Bh^]r BuhgjAh`]r BjL)rB}rB(hSUhT}rB(U anchornamerBUUrefurirBjh\]rBhZ]rBhV]rBhX]rBh^]rBUinternalrBuhgjBh`]rBhbX API ReferencerBrB}rB(hSjhgjBubahhj\ubahhj]ubj.)rB}rB(hSUhT}rB(hV]r BhX]r!BhZ]r"Bh\]r#Bh^]r$BuhgjAh`]r%Bjg)r&B}r'B(hSUhT}r(B(Unumberedr)BKUparentr*BjU titlesonlyr+BUglobr,Bh\]r-BhZ]r.BhV]r/BhX]r0Bh^]r1BUentriesr2B]r3B(Njr4BNjr5BNjr6BNjr7BNjr8BNjr9BNjr:BeUhiddenr;BU includefilesrBKuhgjBh`]r?Bhhj~ubahhjubehhjubahhjubjj.)r@B}rAB(hSUhT}rBB(hV]rCBhX]rDBhZ]rEBh\]rFBh^]rGBuh`]rHBj8)rIB}rJB(hSUhT}rKB(hV]rLBhX]rMBhZ]rNBh\]rOBh^]rPBuhgj@Bh`]rQB(jB)rRB}rSB(hSUhT}rTB(hV]rUBhX]rVBhZ]rWBh\]rXBh^]rYBuhgjIBh`]rZBjL)r[B}r\B(hSUhT}r]B(U anchornamer^BUUrefurir_Bjh\]r`BhZ]raBhV]rbBhX]rcBh^]rdBUinternalreBuhgjRBh`]rfB(ht)rgB}rhB(hSX circuits.netriBhT}rjB(hV]rkBhX]rlBhZ]rmBh\]rnBh^]roBuhgj[Bh`]rpBhbX circuits.netrqBrrB}rsB(hSUhgjgBubahhhubhbX -- NetworkingrtBruB}rvB(hSjhgj[Bubehhj\ubahhj]ubj.)rwB}rxB(hSUhT}ryB(hV]rzBhX]r{BhZ]r|Bh\]r}Bh^]r~BuhgjIBh`]rBjg)rB}rB(hSUhT}rB(UnumberedrBKUparentrBjU titlesonlyrBUglobrBh\]rBhZ]rBhV]rBhX]rBh^]rBUentriesrB]rB(Nj8rBNjGrBNhrBNjrBNjXrBeUhiddenrBU includefilesrB]rB(j8jGhjjXeUmaxdepthrBKuhgjwBh`]rBhhj~ubahhjubehhjubahhjubjj.)rB}rB(hSUhT}rB(hV]rBhX]rBhZ]rBh\]rBh^]rBuh`]rBj8)rB}rB(hSUhT}rB(hV]rBhX]rBhZ]rBh\]rBh^]rBuhgjBh`]rB(jB)rB}rB(hSUhT}rB(hV]rBhX]rBhZ]rBh\]rBh^]rBuhgjBh`]rBjL)rB}rB(hSUhT}rB(U anchornamerBUUrefurirBjh\]rBhZ]rBhV]rBhX]rBh^]rBUinternalrBuhgjBh`]rB(ht)rB}rB(hSXcircuits.web.exceptionsrBhT}rB(hV]rBhX]rBhZ]rBh\]rBh^]rBuhgjBh`]rBhbXcircuits.web.exceptionsrBrB}rB(hSUhgjBubahhhubhbX -- ExceptionsrBrB}rB(hSjhgjBubehhj\ubahhj]ubj.)rB}rB(hSUhT}rB(hV]rBhX]rBhZ]rBh\]rBh^]rBuhgjBh`]rB(j8)rB}rB(hSUhT}rB(hV]rBhX]rBhZ]rBh\]rBh^]rBuhgjBh`]rBjB)rB}rB(hSUhT}rB(hV]rBhX]rBhZ]rBh\]rBh^]rBuhgjBh`]rBjL)rB}rB(hSUhT}rB(U anchornamerBU #exceptionsrBUrefurirBjh\]rBhZ]rBhV]rBhX]rBh^]rBUinternalrBuhgjBh`]rBhbX ExceptionsrBrB}rB(hSX ExceptionsrBhgjBubahhj\ubahhj]ubahhjubj8)rB}rB(hSUhT}rB(hV]rBhX]rBhZ]rCh\]rCh^]rCuhgjBh`]rCjB)rC}rC(hSUhT}rC(hV]rChX]rChZ]r Ch\]r Ch^]r CuhgjBh`]r CjL)r C}rC(hSUhT}rC(U anchornamerCU#eventsrCUrefurirCjh\]rChZ]rChV]rChX]rCh^]rCUinternalrCuhgjCh`]rChbXEventsrCrC}rC(hSXEventsrChgj Cubahhj\ubahhj]ubahhjubj8)rC}rC(hSUhT}r C(hV]r!ChX]r"ChZ]r#Ch\]r$Ch^]r%CuhgjBh`]r&CjB)r'C}r(C(hSUhT}r)C(hV]r*ChX]r+ChZ]r,Ch\]r-Ch^]r.CuhgjCh`]r/CjL)r0C}r1C(hSUhT}r2C(U anchornamer3CU #componentsr4CUrefurir5Cjh\]r6ChZ]r7ChV]r8ChX]r9Ch^]r:CUinternalr;Cuhgj'Ch`]rC}r?C(hSX Componentsr@Chgj0Cubahhj\ubahhj]ubahhjubj8)rAC}rBC(hSUhT}rCC(hV]rDChX]rEChZ]rFCh\]rGCh^]rHCuhgjBh`]rICjB)rJC}rKC(hSUhT}rLC(hV]rMChX]rNChZ]rOCh\]rPCh^]rQCuhgjACh`]rRCjL)rSC}rTC(hSUhT}rUC(U anchornamerVCU #functionsrWCUrefurirXCjh\]rYChZ]rZChV]r[ChX]r\Ch^]r]CUinternalr^CuhgjJCh`]r_ChbX Functionsr`CraC}rbC(hSX FunctionsrcChgjSCubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)rdC}reC(hSUhT}rfC(hV]rgChX]rhChZ]riCh\]rjCh^]rkCuh`]rlCj8)rmC}rnC(hSUhT}roC(hV]rpChX]rqChZ]rrCh\]rsCh^]rtCuhgjdCh`]ruCjB)rvC}rwC(hSUhT}rxC(hV]ryChX]rzChZ]r{Ch\]r|Ch^]r}CuhgjmCh`]r~CjL)rC}rC(hSUhT}rC(U anchornamerCUUrefurirCjh\]rChZ]rChV]rChX]rCh^]rCUinternalrCuhgjvCh`]rChbX ComponentsrCrC}rC(hSjhgjCubahhj\ubahhj]ubahhjubahhjubjj.)rC}rC(hSUhT}rC(hV]rChX]rChZ]rCh\]rCh^]rCuh`]rCj8)rC}rC(hSUhT}rC(hV]rChX]rChZ]rCh\]rCh^]rCuhgjCh`]rC(jB)rC}rC(hSUhT}rC(hV]rChX]rChZ]rCh\]rCh^]rCuhgjCh`]rCjL)rC}rC(hSUhT}rC(U anchornamerCUUrefurirCjh\]rChZ]rChV]rChX]rCh^]rCUinternalrCuhgjCh`]rChbXUsersrCrC}rC(hSjhgjCubahhj\ubahhj]ubj.)rC}rC(hSUhT}rC(hV]rChX]rChZ]rCh\]rCh^]rCuhgjCh`]rC(j8)rC}rC(hSUhT}rC(hV]rChX]rChZ]rCh\]rCh^]rCuhgjCh`]rCjB)rC}rC(hSUhT}rC(hV]rChX]rChZ]rCh\]rCh^]rCuhgjCh`]rCjL)rC}rC(hSUhT}rC(U anchornamerCU!#applications-written-in-circuitsrCUrefurirCjh\]rChZ]rChV]rChX]rCh^]rCUinternalrCuhgjCh`]rChbX Applications written in circuitsrCrC}rC(hSX Applications written in circuitsrChgjCubahhj\ubahhj]ubahhjubj8)rC}rC(hSUhT}rC(hV]rChX]rChZ]rCh\]rCh^]rCuhgjCh`]rCjB)rC}rC(hSUhT}rC(hV]rChX]rChZ]rCh\]rCh^]rCuhgjCh`]rCjL)rC}rC(hSUhT}rC(U anchornamerCU"#applications-integrating-circuitsrCUrefurirCjh\]rChZ]rChV]rChX]rCh^]rDUinternalrDuhgjCh`]rDhbX!Applications integrating circuitsrDrD}rD(hSX!Applications integrating circuitsrDhgjCubahhj\ubahhj]ubahhjubj8)rD}rD(hSUhT}r D(hV]r DhX]r DhZ]r Dh\]r Dh^]rDuhgjCh`]rDjB)rD}rD(hSUhT}rD(hV]rDhX]rDhZ]rDh\]rDh^]rDuhgjDh`]rDjL)rD}rD(hSUhT}rD(U anchornamerDU #other-usersrDUrefurirDjh\]rDhZ]r DhV]r!DhX]r"Dh^]r#DUinternalr$DuhgjDh`]r%DhbX Other Usersr&Dr'D}r(D(hSX Other Usersr)DhgjDubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjj.)r*D}r+D(hSUhT}r,D(hV]r-DhX]r.DhZ]r/Dh\]r0Dh^]r1Duh`]r2Dj8)r3D}r4D(hSUhT}r5D(hV]r6DhX]r7DhZ]r8Dh\]r9Dh^]r:Duhgj*Dh`]r;D(jB)rD(hV]r?DhX]r@DhZ]rADh\]rBDh^]rCDuhgj3Dh`]rDDjL)rED}rFD(hSUhT}rGD(U anchornamerHDUUrefurirIDjh\]rJDhZ]rKDhV]rLDhX]rMDh^]rNDUinternalrODuhgjEuhgj.Eh`]r?EjL)r@E}rAE(hSUhT}rBE(U anchornamerCEU #componentsrDEUrefurirEEjh\]rFEhZ]rGEhV]rHEhX]rIEh^]rJEUinternalrKEuhgj7Eh`]rLEhbX ComponentsrMErNE}rOE(hSX ComponentsrPEhgj@Eubahhj\ubahhj]ubahhjubj8)rQE}rRE(hSUhT}rSE(hV]rTEhX]rUEhZ]rVEh\]rWEh^]rXEuhgjEh`]rYEjB)rZE}r[E(hSUhT}r\E(hV]r]EhX]r^EhZ]r_Eh\]r`Eh^]raEuhgjQEh`]rbEjL)rcE}rdE(hSUhT}reE(U anchornamerfEU #functionsrgEUrefurirhEjh\]riEhZ]rjEhV]rkEhX]rlEh^]rmEUinternalrnEuhgjZEh`]roEhbX FunctionsrpErqE}rrE(hSX FunctionsrsEhgjcEubahhj\ubahhj]ubahhjubehhjubehhjubahhjubj3j.)rtE}ruE(hSUhT}rvE(hV]rwEhX]rxEhZ]ryEh\]rzEh^]r{Euh`]r|Ej8)r}E}r~E(hSUhT}rE(hV]rEhX]rEhZ]rEh\]rEh^]rEuhgjtEh`]rE(jB)rE}rE(hSUhT}rE(hV]rEhX]rEhZ]rEh\]rEh^]rEuhgj}Eh`]rEjL)rE}rE(hSUhT}rE(U anchornamerEUUrefurirEj3h\]rEhZ]rEhV]rEhX]rEh^]rEUinternalrEuhgjEh`]rE(ht)rE}rE(hSXcircuits.web.toolsrEhT}rE(hV]rEhX]rEhZ]rEh\]rEh^]rEuhgjEh`]rEhbXcircuits.web.toolsrErE}rE(hSUhgjEubahhhubhbX -- ToolsrErE}rE(hSjMhgjEubehhj\ubahhj]ubj.)rE}rE(hSUhT}rE(hV]rEhX]rEhZ]rEh\]rEh^]rEuhgj}Eh`]rE(j8)rE}rE(hSUhT}rE(hV]rEhX]rEhZ]rEh\]rEh^]rEuhgjEh`]rEjB)rE}rE(hSUhT}rE(hV]rEhX]rEhZ]rEh\]rEh^]rEuhgjEh`]rEjL)rE}rE(hSUhT}rE(U anchornamerEU#eventsrEUrefurirEj3h\]rEhZ]rEhV]rEhX]rEh^]rEUinternalrEuhgjEh`]rEhbXEventsrErE}rE(hSXEventsrEhgjEubahhj\ubahhj]ubahhjubj8)rE}rE(hSUhT}rE(hV]rEhX]rEhZ]rEh\]rEh^]rEuhgjEh`]rEjB)rE}rE(hSUhT}rE(hV]rEhX]rEhZ]rEh\]rEh^]rEuhgjEh`]rEjL)rE}rE(hSUhT}rE(U anchornamerEU #componentsrEUrefurirEj3h\]rEhZ]rEhV]rEhX]rEh^]rEUinternalrEuhgjEh`]rEhbX ComponentsrErE}rE(hSX ComponentsrEhgjEubahhj\ubahhj]ubahhjubj8)rE}rE(hSUhT}rE(hV]rEhX]rEhZ]rEh\]rFh^]rFuhgjEh`]rFjB)rF}rF(hSUhT}rF(hV]rFhX]rFhZ]rFh\]r Fh^]r FuhgjEh`]r FjL)r F}r F(hSUhT}rF(U anchornamerFU #functionsrFUrefurirFj3h\]rFhZ]rFhV]rFhX]rFh^]rFUinternalrFuhgjFh`]rFhbX FunctionsrFrF}rF(hSX FunctionsrFhgj Fubahhj\ubahhj]ubahhjubehhjubehhjubahhjubjNj.)rF}rF(hSUhT}rF(hV]r FhX]r!FhZ]r"Fh\]r#Fh^]r$Fuh`]r%Fj8)r&F}r'F(hSUhT}r(F(hV]r)FhX]r*FhZ]r+Fh\]r,Fh^]r-FuhgjFh`]r.F(jB)r/F}r0F(hSUhT}r1F(hV]r2FhX]r3FhZ]r4Fh\]r5Fh^]r6Fuhgj&Fh`]r7FjL)r8F}r9F(hSUhT}r:F(U anchornamer;FUUrefurirFhV]r?FhX]r@Fh^]rAFUinternalrBFuhgj/Fh`]rCF(ht)rDF}rEF(hSXcircuits.io.serialrFFhT}rGF(hV]rHFhX]rIFhZ]rJFh\]rKFh^]rLFuhgj8Fh`]rMFhbXcircuits.io.serialrNFrOF}rPF(hSUhgjDFubahhhubhbX -- Serial I/OrQFrRF}rSF(hSjhhgj8Fubehhj\ubahhj]ubj.)rTF}rUF(hSUhT}rVF(hV]rWFhX]rXFhZ]rYFh\]rZFh^]r[Fuhgj&Fh`]r\F(j8)r]F}r^F(hSUhT}r_F(hV]r`FhX]raFhZ]rbFh\]rcFh^]rdFuhgjTFh`]reFjB)rfF}rgF(hSUhT}rhF(hV]riFhX]rjFhZ]rkFh\]rlFh^]rmFuhgj]Fh`]rnFjL)roF}rpF(hSUhT}rqF(U anchornamerrFU#eventsrsFUrefurirtFjNh\]ruFhZ]rvFhV]rwFhX]rxFh^]ryFUinternalrzFuhgjfFh`]r{FhbXEventsr|Fr}F}r~F(hSXEventsrFhgjoFubahhj\ubahhj]ubahhjubj8)rF}rF(hSUhT}rF(hV]rFhX]rFhZ]rFh\]rFh^]rFuhgjTFh`]rFjB)rF}rF(hSUhT}rF(hV]rFhX]rFhZ]rFh\]rFh^]rFuhgjFh`]rFjL)rF}rF(hSUhT}rF(U anchornamerFU #componentsrFUrefurirFjNh\]rFhZ]rFhV]rFhX]rFh^]rFUinternalrFuhgjFh`]rFhbX ComponentsrFrF}rF(hSX ComponentsrFhgjFubahhj\ubahhj]ubahhjubj8)rF}rF(hSUhT}rF(hV]rFhX]rFhZ]rFh\]rFh^]rFuhgjTFh`]rFjB)rF}rF(hSUhT}rF(hV]rFhX]rFhZ]rFh\]rFh^]rFuhgjFh`]rFjL)rF}rF(hSUhT}rF(U anchornamerFU #functionsrFUrefurirFjNh\]rFhZ]rFhV]rFhX]rFh^]rFUinternalrFuhgjFh`]rFhbX FunctionsrFrF}rF(hSX FunctionsrFhgjFubahhj\ubahhj]ubahhjubehhjubehhjubahhjubuU indexentriesrF}rF(hO]rFhj]rF((UsinglerFXcircuits.web.loggers (module)Xmodule-circuits.web.loggersUtrF(jFX&Logger (class in circuits.web.loggers)j UtrF(jFX-formattime() (in module circuits.web.loggers)jH UtrFeh]rFh]rF((jFX.circuits.web.dispatchers.virtualhosts (module)X,module-circuits.web.dispatchers.virtualhostsUtrF(jFX=VirtualHosts (class in circuits.web.dispatchers.virtualhosts)j UtrFeh]rF((jFX#circuits.net.protocols.irc (module)X!module-circuits.net.protocols.ircUtrF(jFX)RAW (class in circuits.net.protocols.irc)jUtrF(jFX)IRC (class in circuits.net.protocols.irc)j UtrF(jFX.line() (circuits.net.protocols.irc.IRC method)j UtrFeh]rF((jFXcircuits.app.log (module)Xmodule-circuits.app.logUtrF(jFXLog (class in circuits.app.log)j UtrF(jFX"Logger (class in circuits.app.log)j UtrFeh]rFh]rF(jFXcircuits.io (module)Xmodule-circuits.ioUtrFaj]rF((jFXcircuits.core.pollers (module)Xmodule-circuits.core.pollersUtrF(jFX+BasePoller (class in circuits.core.pollers)jUtrF(jFX'Select (class in circuits.core.pollers)j UtrF(jFX%Poll (class in circuits.core.pollers)j UtrF(jFX&EPoll (class in circuits.core.pollers)j UtrFej*]rFj8]rF(jFXcircuits.net.protocols (module)Xmodule-circuits.net.protocolsUtrFajS]rFja]rFjo]rFj}]rF((jFX(circuits.web.dispatchers.static (module)X&module-circuits.web.dispatchers.staticUtrF(jFX1Static (class in circuits.web.dispatchers.static)j UtrFej]rF((jFXcircuits.node.node (module)Xmodule-circuits.node.nodeUtrF(jFX"Node (class in circuits.node.node)jUtrFej]rF((jFX$circuits.net.protocols.line (module)X"module-circuits.net.protocols.lineUtrF(jFX+Line (class in circuits.net.protocols.line)j UtrF(jFX)LP (class in circuits.net.protocols.line)jUtrFej]rF((jFXcircuits.core.debugger (module)Xmodule-circuits.core.debuggerUtrF(jFX*Debugger (class in circuits.core.debugger)j UtrFej]rF(jFXcircuits.core (module)Xmodule-circuits.coreUtrFaj]rF((jFXcircuits.io.events (module)Xmodule-circuits.io.eventsUtrF(jFX#Close (class in circuits.io.events)jP UtrF(jFX$Closed (class in circuits.io.events)j UtrF(jFX!EOF (class in circuits.io.events)jUtrF(jFX#Error (class in circuits.io.events)j UtrF(jFX$Opened (class in circuits.io.events)j UtrF(jFX"Read (class in circuits.io.events)j UtrG(jFX"Seek (class in circuits.io.events)j| UtrG(jFX#Write (class in circuits.io.events)jUtrGej]rGj-]rG(jFXcircuits.app (module)Xmodule-circuits.appUtrGajH]rG((jFXcircuits.core.handlers (module)Xmodule-circuits.core.handlersUtrG(jFX2HandlerMetaClass (class in circuits.core.handlers)j: UtrG(jFX,handler() (in module circuits.core.handlers)j Utr G(jFX0reprhandler() (in module circuits.core.handlers)j Utr Gejc]r G((jFXcircuits.core.loader (module)Xmodule-circuits.core.loaderUtr G(jFX&Loader (class in circuits.core.loader)jUtr Gej~]rG((jFXcircuits.web.http (module)Xmodule-circuits.web.httpUtrG(jFX!HTTP (class in circuits.web.http)j UtrG(jFX._on_response() (circuits.web.http.HTTP method)j UtrG(jFX*_on_read() (circuits.web.http.HTTP method)jUtrG(jFX/_on_httperror() (circuits.web.http.HTTP method)j UtrG(jFX5_on_request_success() (circuits.web.http.HTTP method)j( UtrGej]rG((jFXcircuits.node.server (module)Xmodule-circuits.node.serverUtrG(jFX&Server (class in circuits.node.server)j UtrGej]rG((jFX,circuits.web.dispatchers.dispatcher (module)X*module-circuits.web.dispatchers.dispatcherUtrG(jFX9Dispatcher (class in circuits.web.dispatchers.dispatcher)j UtrGej]rGj]rGj]rG((jFXcircuits.app.daemon (module)Xmodule-circuits.app.daemonUtrG(jFX(Daemonize (class in circuits.app.daemon)j, UtrG(jFX'WritePID (class in circuits.app.daemon)j@ Utr G(jFX%Daemon (class in circuits.app.daemon)jUtr!Gej]r"G((jFXcircuits.core.utils (module)Xmodule-circuits.core.utilsUtr#G(jFX-findchannel() (in module circuits.core.utils)j Utr$G(jFX)findcmp() (in module circuits.core.utils)j Utr%G(jFX*findroot() (in module circuits.core.utils)jUtr&G(jFX*findtype() (in module circuits.core.utils)jUtr'G(jFX)flatten() (in module circuits.core.utils)j Utr(G(jFX,safeimport() (in module circuits.core.utils)jV Utr)Gej!]r*Gj/]r+G((jFXcircuits.core.manager (module)Xmodule-circuits.core.managerUtr,G(jFX(Manager (class in circuits.core.manager)j Utr-G(jFX.name (circuits.core.manager.Manager attribute)j Utr.G(jFX1running (circuits.core.manager.Manager attribute)jUtr/G(jFX-pid (circuits.core.manager.Manager attribute)jUtr0G(jFX2fireEvent() (circuits.core.manager.Manager method)j4 Utr1G(jFX-fire() (circuits.core.manager.Manager method)j. Utr2G(jFX2callEvent() (circuits.core.manager.Manager method)jUtr3G(jFX-call() (circuits.core.manager.Manager method)j Utr4G(jFX4flushEvents() (circuits.core.manager.Manager method)jUtr5G(jFX.flush() (circuits.core.manager.Manager method)j Utr6G(jFX.start() (circuits.core.manager.Manager method)j Utr7G(jFX-stop() (circuits.core.manager.Manager method)j$ Utr8G(jFX-tick() (circuits.core.manager.Manager method)j Utr9G(jFX,run() (circuits.core.manager.Manager method)j^ Utr:GejJ]r;GjX]rG(jFX&Packet (class in circuits.node.events)j Utr?G(jFX&Remote (class in circuits.node.events)j Utr@Gej]rAG((jFXcircuits.core.values (module)Xmodule-circuits.core.valuesUtrBG(jFX%Value (class in circuits.core.values)jUtrCGej]rDGj]rEGj]rFG((jFXcircuits.web.sessions (module)Xmodule-circuits.web.sessionsUtrGG(jFX)Sessions (class in circuits.web.sessions)j UtrHGej]rIG((jFXcircuits.core.timers (module)Xmodule-circuits.core.timersUtrJG(jFX%Timer (class in circuits.core.timers)j UtrKG(jFX+reset() (circuits.core.timers.Timer method)j< UtrLGej]rMG((jFXcircuits.web.wrappers (module)Xmodule-circuits.web.wrappersUtrNG(jFX%Body (class in circuits.web.wrappers)j UtrOG(jFX%Host (class in circuits.web.wrappers)jN UtrPG(jFX(Request (class in circuits.web.wrappers)jj UtrQG(jFX0server (circuits.web.wrappers.Request attribute)j6 UtrRG(jFX)Response (class in circuits.web.wrappers)j UtrSG(jFX2file_generator() (in module circuits.web.wrappers)j> UtrTGeh]rUGj]rVGj,]rWG((jFXcircuits.web.errors (module)Xmodule-circuits.web.errorsUtrXG(jFX(HTTPError (class in circuits.web.errors)jz UtrYG(jFX(Forbidden (class in circuits.web.errors)j\ UtrZG(jFX'NotFound (class in circuits.web.errors)j Utr[G(jFX'Redirect (class in circuits.web.errors)j Utr\G(jFX+Unauthorized (class in circuits.web.errors)jD Utr]GejG]r^G((jFX$circuits.net.protocols.http (module)X"module-circuits.net.protocols.httpUtr_G(jFX.Request (class in circuits.net.protocols.http)j Utr`G(jFX/Response (class in circuits.net.protocols.http)j UtraG(jFX+HTTP (class in circuits.net.protocols.http)jUtrbGejb]rcG(jFXcircuits.web.main (module)Xmodule-circuits.web.mainUtrdGah ]reGj]rfG((jFX!circuits.core.components (module)Xmodule-circuits.core.componentsUtrgG(jFX1BaseComponent (class in circuits.core.components)jUtrhG(jFX:register() (circuits.core.components.BaseComponent method)j UtriG(jFX<unregister() (circuits.core.components.BaseComponent method)jn UtrjG(jFX@handlers() (circuits.core.components.BaseComponent class method)jz UtrkG(jFX?handles() (circuits.core.components.BaseComponent class method)j UtrlG(jFX-Component (class in circuits.core.components)jUtrmG(jFX5PrepareUnregister (class in circuits.core.components)jv UtrnG(jFX@in_subtree() (circuits.core.components.PrepareUnregister method)jx UtroG(jFX2SingletonError (class in circuits.core.components)j UtrpGej]rqG((jFXcircuits.web.client (module)Xmodule-circuits.web.clientUtrrG(jFX&Request (class in circuits.web.client)j^ UtrsG(jFX%Client (class in circuits.web.client)jf UtrtG(jFX.channel (circuits.web.client.Client attribute)j UtruG(jFX+write() (circuits.web.client.Client method)jF UtrvG(jFX+close() (circuits.web.client.Client method)jb UtrwG(jFX-connect() (circuits.web.client.Client method)j UtrxG(jFX-request() (circuits.web.client.Client method)j2 UtryG(jFX0connected (circuits.web.client.Client attribute)j. UtrzG(jFX/response (circuits.web.client.Client attribute)jr Utr{Gej]r|G((jFXcircuits.core.workers (module)Xmodule-circuits.core.workersUtr}G(jFX'Worker (class in circuits.core.workers)j Utr~G(jFX%Task (class in circuits.core.workers)j UtrGej]rG((jFXcircuits.web.websocket (module)Xmodule-circuits.web.websocketUtrG(jFX1WebSocketClient (class in circuits.web.websocket)j UtrG(jFX:channel (circuits.web.websocket.WebSocketClient attribute)j UtrG(jFX7close() (circuits.web.websocket.WebSocketClient method)j UtrG(jFX<connected (circuits.web.websocket.WebSocketClient attribute)jd UtrGej]rGj]rG((jFXcircuits.tools (module)Xmodule-circuits.toolsUtrG(jFX"graph() (in module circuits.tools)j UtrGej]rG((jFXcircuits.web.events (module)Xmodule-circuits.web.eventsUtrG(jFX'WebEvent (class in circuits.web.events)j UtrG(jFX&Request (class in circuits.web.events)j UtrG(jFX3create() (circuits.web.events.Request class method)j< UtrG(jFX'Response (class in circuits.web.events)j UtrG(jFX%Stream (class in circuits.web.events)j UtrGej:]rG((jFXcircuits.web.utils (module)Xmodule-circuits.web.utilsUtrG(jFX)compress() (in module circuits.web.utils)j UtrG(jFX)dictform() (in module circuits.web.utils)j UtrG(jFX+get_ranges() (in module circuits.web.utils)j UtrG(jFX+parse_body() (in module circuits.web.utils)j UtrG(jFX)parse_qs() (in module circuits.web.utils)j UtrG(jFX$url() (in module circuits.web.utils)j UtrGejU]rG((jFXcircuits.node.utils (module)Xmodule-circuits.node.utilsUtrG(jFX,dump_event() (in module circuits.node.utils)j UtrG(jFX,dump_value() (in module circuits.node.utils)jJ UtrG(jFX,load_event() (in module circuits.node.utils)jn UtrG(jFX,load_value() (in module circuits.node.utils)jUtrGejp]rGj~]rG(jFXcircuits.node (module)Xmodule-circuits.nodeUtrGaj]rG((jFX)circuits.web.dispatchers.jsonrpc (module)X'module-circuits.web.dispatchers.jsonrpcUtrG(jFX/RPC (class in circuits.web.dispatchers.jsonrpc)j UtrG(jFX3JSONRPC (class in circuits.web.dispatchers.jsonrpc)j UtrGej]rGj]rG((jFXcircuits.io.notify (module)Xmodule-circuits.io.notifyUtrG(jFX&Accessed (class in circuits.io.notify)jUtrG(jFX$Closed (class in circuits.io.notify)j: UtrG(jFX%Created (class in circuits.io.notify)j2 UtrG(jFX%Deleted (class in circuits.io.notify)jUtrG(jFX&Modified (class in circuits.io.notify)j UtrG(jFX#Moved (class in circuits.io.notify)j UtrG(jFX$Opened (class in circuits.io.notify)j UtrG(jFX'Unmounted (class in circuits.io.notify)j& UtrG(jFX$Notify (class in circuits.io.notify)j UtrGej]rGj]rG((jFXcircuits.web.headers (module)Xmodule-circuits.web.headersUtrG(jFX'Headers (class in circuits.web.headers)j UtrG(jFX/has_key() (circuits.web.headers.Headers method)j UtrG(jFX/get_all() (circuits.web.headers.Headers method)j UtrG(jFX+get() (circuits.web.headers.Headers method)j UtrG(jFX,keys() (circuits.web.headers.Headers method)jUtrG(jFX.values() (circuits.web.headers.Headers method)j UtrG(jFX-items() (circuits.web.headers.Headers method)j UtrG(jFX2setdefault() (circuits.web.headers.Headers method)jB UtrG(jFX2add_header() (circuits.web.headers.Headers method)jf UtrG(jFX0elements() (circuits.web.headers.Headers method)j UtrG(jFX-HeaderElement (class in circuits.web.headers)j UtrG(jFX:parse() (circuits.web.headers.HeaderElement static method)j UtrG(jFX<from_str() (circuits.web.headers.HeaderElement class method)j UtrG(jFX-AcceptElement (class in circuits.web.headers)j UtrG(jFX5qvalue (circuits.web.headers.AcceptElement attribute)j UtrG(jFX2header_elements() (in module circuits.web.headers)jl UtrG(jFX0parse_headers() (in module circuits.web.headers)j UtrGej]rGj]rGj"]rG((jFX(circuits.web.dispatchers.xmlrpc (module)X&module-circuits.web.dispatchers.xmlrpcUtrG(jFX.RPC (class in circuits.web.dispatchers.xmlrpc)j UtrG(jFX1XMLRPC (class in circuits.web.dispatchers.xmlrpc)j UtrGej=]rG((jFX,circuits.web.dispatchers.websockets (module)X*module-circuits.web.dispatchers.websocketsUtrG(jFX9WebSockets (class in circuits.web.dispatchers.websockets)j UtrGejX]rG((jFXcircuits.net.sockets (module)Xmodule-circuits.net.socketsUtrG(jFX'Connect (class in circuits.net.sockets)j UtrG(jFX)Connected (class in circuits.net.sockets)jr UtrG(jFX%Close (class in circuits.net.sockets)j UtrG(jFX&Closed (class in circuits.net.sockets)j> UtrG(jFX$Read (class in circuits.net.sockets)j UtrG(jFX%Write (class in circuits.net.sockets)j UtrG(jFX+SocketError (class in circuits.net.sockets)j UtrG(jFX*Disconnect (class in circuits.net.sockets)j0 UtrG(jFX,Disconnected (class in circuits.net.sockets)jt UtrG(jFX&Client (class in circuits.net.sockets)j UtrG(jFX/channel (circuits.net.sockets.Client attribute)j@ UtrG(jFX;parse_bind_parameter() (circuits.net.sockets.Client method)jV UtrG(jFX1connected (circuits.net.sockets.Client attribute)j` UtrG(jFX,close() (circuits.net.sockets.Client method)jUtrG(jFX,write() (circuits.net.sockets.Client method)j UtrG(jFX)TCPClient (class in circuits.net.sockets)jUtrG(jFX8socket_family (circuits.net.sockets.TCPClient attribute)j& UtrG(jFX1connect() (circuits.net.sockets.TCPClient method)j UtrG(jFX*UDPClient (in module circuits.net.sockets)jh UtrG(jFX*UNIXClient (class in circuits.net.sockets)j UtrG(jFX0ready() (circuits.net.sockets.UNIXClient method)jUtrG(jFX2connect() (circuits.net.sockets.UNIXClient method)j UtrG(jFX&Server (class in circuits.net.sockets)j UtrG(jFX/channel (circuits.net.sockets.Server attribute)j UtrG(jFX;parse_bind_parameter() (circuits.net.sockets.Server method)jp UtrG(jFX1connected (circuits.net.sockets.Server attribute)j UtrG(jFX,host (circuits.net.sockets.Server attribute)jUtrG(jFX,port (circuits.net.sockets.Server attribute)j UtrG(jFX,close() (circuits.net.sockets.Server method)j UtrG(jFX,write() (circuits.net.sockets.Server method)jUtrG(jFX)TCPServer (class in circuits.net.sockets)j* UtrG(jFX8socket_family (circuits.net.sockets.TCPServer attribute)j, UtrG(jFX>parse_bind_parameter() (circuits.net.sockets.TCPServer method)j UtrG(jFX)UDPServer (class in circuits.net.sockets)j UtrG(jFX8socket_family (circuits.net.sockets.UDPServer attribute)jx UtrG(jFX/close() (circuits.net.sockets.UDPServer method)j UtrG(jFX/write() (circuits.net.sockets.UDPServer method)jUtrG(jFX3broadcast() (circuits.net.sockets.UDPServer method)j UtrG(jFX*UNIXServer (class in circuits.net.sockets)j UtrG(jFX'Pipe() (in module circuits.net.sockets)j UtrGejs]rG((jFXcircuits.core.events (module)Xmodule-circuits.core.eventsUtrG(jFX%Event (class in circuits.core.events)jUtrG(jFX%Error (class in circuits.core.events)j UtrG(jFX'Failure (class in circuits.core.events)jT UtrG(jFX*Registered (class in circuits.core.events)jD UtrG(jFX&Signal (class in circuits.core.events)j UtrG(jFX'Started (class in circuits.core.events)jUtrH(jFX'Stopped (class in circuits.core.events)jX UtrH(jFX'Success (class in circuits.core.events)jT UtrH(jFX*Unregister (class in circuits.core.events)j UtrH(jFX,Unregistered (class in circuits.core.events)jUtrH(jFX.GenerateEvents (class in circuits.core.events)j UtrH(jFX9time_left (circuits.core.events.GenerateEvents attribute)j UtrH(jFX?reduce_time_left() (circuits.core.events.GenerateEvents method)jUtrHej]rH((jFXcircuits.web.servers (module)Xmodule-circuits.web.serversUtr H(jFX*BaseServer (class in circuits.web.servers)jb Utr H(jFX&Server (class in circuits.web.servers)j Utr Hej]r H(jFXVCSjUmainr HtrHaj]rH((jFXcircuits.web.wsgi (module)Xmodule-circuits.web.wsgiUtrH(jFX(Application (class in circuits.web.wsgi)jN UtrH(jFX$Gateway (class in circuits.web.wsgi)j UtrHej]rHh&]rHj]rHj]rHj ]rH((jFXcircuits.node.client (module)Xmodule-circuits.node.clientUtrH(jFX&Client (class in circuits.node.client)jUtrHeh ]rHj1]rH((jFXcircuits.app.env (module)Xmodule-circuits.app.envUtrH(jFX"Create (class in circuits.app.env)j8 UtrH(jFX Load (class in circuits.app.env)j UtrH(jFX'Environment (class in circuits.app.env)j UtrHejL]r H((jFXcircuits.io.file (module)Xmodule-circuits.io.fileUtr!H(jFX File (class in circuits.io.file)j$ Utr"Hejg]r#H((jFX!circuits.web.controllers (module)Xmodule-circuits.web.controllersUtr$H(jFX.Controller (class in circuits.web.controllers)j Utr%H(jFX2JSONController (class in circuits.web.controllers)jL Utr&H(jFX-expose() (in module circuits.web.controllers)jF Utr'H(jFX1exposeJSON() (in module circuits.web.controllers)j Utr(Hej]r)Hj]r*H(jFXcircuits.net (module)Xmodule-circuits.netUtr+Haj]r,H((jFX circuits.web.exceptions (module)Xmodule-circuits.web.exceptionsUtr-H(jFX HTTPExceptionj Utr.H(jFX BadGatewayj4 Utr/H(jFX BadRequestj Utr0H(jFX Forbiddenj* Utr1H(jFXGonej8 Utr2H(jFXInternalServerErrorjUtr3H(jFXLengthRequiredj Utr4H(jFXMethodNotAllowedjUtr5H(jFX NotAcceptablej Utr6H(jFXNotFoundj Utr7H(jFXNotImplementedj Utr8H(jFXPreconditionFailedj~ Utr9H(jFXRedirectj Utr:H(jFXRequestEntityTooLargej Utr;H(jFXRequestTimeoutjUtrH(jFX Unauthorizedj6 Utr?H(jFX UnicodeErrorj Utr@H(jFXUnsupportedMediaTypej UtrAHej]rBHj]rCHj]rDH(jFXcircuits.web (module)Xmodule-circuits.webUtrEHaj]rFH(jFXcircuits.web.constants (module)Xmodule-circuits.web.constantsUtrGHaj]rHH((jFXcircuits.app.config (module)Xmodule-circuits.app.configUtrIH(jFX#Load (class in circuits.app.config)j UtrJH(jFX#Save (class in circuits.app.config)j UtrKH(jFX%Config (class in circuits.app.config)j UtrLHej3]rMH((jFXcircuits.web.tools (module)Xmodule-circuits.web.toolsUtrNH(jFX+basic_auth() (in module circuits.web.tools)jZ UtrOH(jFX+check_auth() (in module circuits.web.tools)j UtrPH(jFX,digest_auth() (in module circuits.web.tools)jH UtrQH(jFX(expires() (in module circuits.web.tools)j UtrRH(jFX%gzip() (in module circuits.web.tools)j~ UtrSH(jFX/serve_download() (in module circuits.web.tools)j UtrTH(jFX+serve_file() (in module circuits.web.tools)jd UtrUH(jFX/validate_etags() (in module circuits.web.tools)jt UtrVH(jFX/validate_since() (in module circuits.web.tools)j UtrWHejN]rXH((jFXcircuits.io.serial (module)Xmodule-circuits.io.serialUtrYH(jFX$Serial (class in circuits.io.serial)j UtrZHeuUall_docsr[H}r\H(hOGAK{n!hjGAK{m}nhGAK{nhGAK{l^hGAK{lEehGAK{kohGAK{nXhGAK{kjGAK{kj*GAK{nVxj8GAK{lݥjSGAK{n`IjaGAK{n,joGAK{n^:Cj}GAK{ljGAK{lWjGAK{lSjGAK{k;-wjGAK{k F jGAK{kjGAK{nh~tj-GAK{j9mjHGAK{k_8jcGAK{kdj~GAK{mt7jGAK{l\jGAK{l'jGAK{n|oXjGAK{ndgjGAK{kxjGAK{k j!GAK{nJvj/GAK{k&jJGAK{nUEjXGAK{nj$djfGAK{lHjGAK{kqjGAK{nFKjGAK{n?jGAK{mjGAK{kjGAK{mvhGAK{nuWjGAK{nT-kj,GAK{mjGGAK{l,jbGAK{mqTh GAK{n4jGAK{k3jGAK{lˌPjGAK{kǸjGAK{mVjGAK{njGAK{lPjGAK{m'j:GAK{mjUGAK{ljpGAK{nazj~GAK{l-jGAK{l;jGAK{n'4jGAK{l,jGAK{n^jGAK{m_jGAK{n/jGAK{n#j"GAK{m j=GAK{m2jXGAK{ljsGAK{kSɬjGAK{m=GjGAK{n.jGAK{mOjGAK{nfh&GAK{nM>jGAK{njGAK{nںj GAK{lk]h GAK{nRzj1GAK{knjLGAK{kjgGAK{lܤjGAK{mjGAK{l_jGAK{mE6mjGAK{nHjGAK{nxsjGAK{ljGAK{ljGAK{jmj3GAK{mAjNGAK{l uUsettingsr]H}r^H(Ucloak_email_addressesr_HU pep_base_urlr`Hj% U halt_levelraHKUsectsubtitle_xformrbHUembed_stylesheetrcHUtrim_footnote_reference_spacerdHUdoctitle_xformreHUwarning_streamrfHcsphinx.util.nodes WarningStream rgH)rhH}riH(U_rerjHcre _compile rkHU+\((DEBUG|INFO|WARNING|ERROR|SEVERE)/[0-4]\)rlHKRrmHUwarnfuncrnHNubUenvroHhU rfc_base_urlrpHj Ugettext_compactrqHUinput_encodingrrHj uUfiles_to_rebuildrsH}rtH(jh]ruHjaRrvHhjh]rwHjaRrxHj#h]ryHjaRrzHhh]r{HjaRr|HUapi/circuits_net_protocols_ircr}Hh]r~H(j8jeRrHhh]rHj-aRrHj h]rHjaRrHjh]rHjaRrHjh]rHjaRrHj h]rHjaRrHj8h]rHjaRrHjh]rHjpaRrHjh]rHjaRrHjh]rHjaRrHj}h]rHjaRrHjh]rHj~aRrHUapi/circuits_net_protocols_linerHh]rH(j8jeRrHjh]rHjaRrHjh]rHjaRrHjh]rHhaRrHjh]rHjpaRrHjh]rHjaRrHjHh]rHjaRrHjch]rHjaRrHj~h]rHjaRrHjh]rHj~aRrHjh]rHjaRrHj$h]rHjaRrHjh]rHjpaRrHjh]rHj-aRrHjh]rHjaRrHjh]rHjaRrHj/h]rHjaRrHj h]rHjaRrHjh]rHjaRrHjfh]rHj~aRrHjh]rHjaRrHjh]rHhOaRrHjh]rHjaRrHjh]rHjaRrHjh]rHjaRrHjh]rHjaRrHjh]rHjaRrHj,h]rHjaRrHUapi/circuits_net_protocols_httprHh]rH(j8jeRrHjbh]rHjaRrHj'h]rHjaRrHjh]rHjaRrHjh]rHjaRrHjh]rHjaRrHjh]rHjaRrHjh]rHjaRrHjh]rHjaRrHjh]rHjaRrHj:h]rHjaRrHjUh]rHj~aRrHjh]rHjaRrHjh]rHjaRrHjh]rHjaRrHjh]rHhOaRrHjh]rHhaRrHjh]rHjaRrHjh]rHjaRrHjh]rHjaRrHjh]rHhOaRrHj"h]rHjaRrHj=h]rHjaRrHjXh]rHjaRrHjsh]rIjaRrIjh]rIjaRrIjh]rIjaRrIjh]rIjaRrIjh]rIjpaRr Ijh]r IjaRr Ijh]r IjaRr Ij"h]rIjaRrIj h]rIj~aRrIj h]rIjaRrIj1h]rIj-aRrIjLh]rIhaRrIjgh]rIjaRrIjh]rIjaRrIjh]rIjaRrIjh]rIjaRrIjh]r IjaRr!Ijh]r"IjaRr#Ijh]r$IjaRr%Ijh]r&IjaRr'Ijh]r(Ij-aRr)Ij3h]r*IjaRr+IjNh]r,IhaRr-IuUtoc_secnumbersr.I}r/IU_nitpick_ignorer0Ih]Rr1IU _warnfuncr2INub.circuits-2.1.0/docs/build/doctrees/glossary.doctree0000644000014400001440000000671612113366670022160 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}qXglossaryqNsUsubstitution_defsq}qUparse_messagesq ]q Ucurrent_sourceq NU decorationq NUautofootnote_startq KUnameidsq}qhUglossaryqsUchildrenq]qcdocutils.nodes section q)q}q(U rawsourceqUUparentqhUsourceqcdocutils.nodes reprunicode qX5/home/prologic/work/circuits/docs/source/glossary.rstqq}qbUtagnameqUsectionqU attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q(haUnamesq)]q*hauUlineq+KUdocumentq,hh]q-(cdocutils.nodes title q.)q/}q0(hXGlossaryq1hhhhhUtitleq2h}q3(h!]q4h#]q5h%]q6h']q7h)]q8uh+Kh,hh]q9cdocutils.nodes Text q:XGlossaryq;q<}q=(hh1hh/ubaubcsphinx.addnodes glossary q>)q?}q@(hUhhhhhUglossaryqAh}qB(h!]qCh#]qDh%]qEh']qFh)]qGuh+Nh,hh]qHcdocutils.nodes definition_list qI)qJ}qK(hUhh?hhhUdefinition_listqLh}qM(h!]qNh#]qOhAah%]qPh']qQh)]qRuh+Nh,hh]qScdocutils.nodes definition_list_item qT)qU}qV(hUh}qW(h!]qXh#]qYh%]qZh']q[h)]q\uhhJh]q](cdocutils.nodes term q^)q_}q`(hUh}qa(h!]qbh#]qch%]qdh']qeUterm-vcsqfah)]qghfauhhUh]qh(csphinx.addnodes index qi)qj}qk(hUh}ql(h']qmh%]qnh!]qoh#]qph)]qqUentriesqr]qs(UsingleqtXVCShfUmainqutqvauhh_h]qwhUindexqxubh:XVCSqyqz}q{(hXVCSq|hh_ubehUtermq}ubcdocutils.nodes definition q~)q}q(hUh}q(h!]qh#]qh%]qh']qh)]quhhUh]qcdocutils.nodes paragraph q)q}q(hXDVersion Control System, what you use for versioning your source codeqhhhhhU paragraphqh}q(h!]qh#]qh%]qh']qh)]quh+K h]qh:XDVersion Control System, what you use for versioning your source codeqq}q(hhhhubaubahU definitionqubehUdefinition_list_itemqubaubaubeubahUU transformerqNU footnote_refsq}qUrefnamesq}qUsymbol_footnotesq]qUautofootnote_refsq]qUsymbol_footnote_refsq]qU citationsq]qh,hU current_lineqNUtransform_messagesq]qUreporterqNUid_startqKU autofootnotesq]qU citation_refsq}qUindirect_targetsq]qUsettingsq(cdocutils.frontend Values qoq}q(Ufootnote_backlinksqKUrecord_dependenciesqNU rfc_base_urlqUhttp://tools.ietf.org/html/qU tracebackqUpep_referencesqNUstrip_commentsqNU toc_backlinksqUentryqU language_codeqUenqU datestampqNU report_levelqKU _destinationqNU halt_levelqKU strip_classesqNh2NUerror_encoding_error_handlerqUbackslashreplaceqUdebugqNUembed_stylesheetqȉUoutput_encoding_error_handlerqUstrictqU sectnum_xformqKUdump_transformsqNU docinfo_xformqKUwarning_streamqNUpep_file_url_templateqUpep-%04dqUexit_status_levelqKUconfigqNUstrict_visitorqNUcloak_email_addressesqԈUtrim_footnote_reference_spaceqՉUenvqNUdump_pseudo_xmlqNUexpose_internalsqNUsectsubtitle_xformqىU source_linkqNUrfc_referencesqNUoutput_encodingqUutf-8qU source_urlqNUinput_encodingqU utf-8-sigqU_disable_configqNU id_prefixqUU tab_widthqKUerror_encodingqU ISO-8859-1qU_sourceqU5/home/prologic/work/circuits/docs/source/glossary.rstqUgettext_compactqU generatorqNUdump_internalsqNU smart_quotesqU pep_base_urlqUhttp://www.python.org/dev/peps/qUsyntax_highlightqUlongqUinput_encoding_error_handlerqhUauto_id_prefixqUidqUdoctitle_xformqUstrip_elements_with_classesqNU _config_filesq]qUfile_insertion_enabledqKU raw_enabledqKU dump_settingsqNubUsymbol_footnote_startqKUidsq}qhhsUsubstitution_namesq}qhh,h}q(h!]rh']rh%]rUsourcerhh#]rh)]ruU footnotesr]rUrefidsr}r ub.circuits-2.1.0/docs/build/doctrees/index.doctree0000644000014400001440000011273612113366671021425 0ustar prologicuserscdocutils.nodes document q)q}q(U nametypesq}q(X mit licenseqXfeaturesqNXfreenode irc networkqXoverviewq NX communityq NXindices and tablesq NXcontentsq NXfeedbackq NX requirementsqNXpython programming languageqXcreate an issueqX mailing listqXsupported platformsqNX@pythoncircuitsqXwebsiteqX read the docsqXdownloads pageqX installationqNXlicenseqNX#circuits irc channelqXcircuits version documentationqNX pypi pageqXpython standard libraryquUsubstitution_defsq}qUparse_messagesq]q Ucurrent_sourceq!NU decorationq"NUautofootnote_startq#KUnameidsq$}q%(hU mit-licenseq&hUfeaturesq'hUfreenode-irc-networkq(h Uoverviewq)h U communityq*h Uindices-and-tablesq+h Ucontentsq,h Ufeedbackq-hU requirementsq.hUpython-programming-languageq/hUcreate-an-issueq0hU mailing-listq1hUsupported-platformsq2hUpythoncircuitsq3hUwebsiteq4hU read-the-docsq5hUdownloads-pageq6hU installationq7hUlicenseq8hUcircuits-irc-channelq9hUcircuits-version-documentationq:hU pypi-pageq;hUpython-standard-libraryqcdocutils.nodes section q?)q@}qA(U rawsourceqBUUparentqChUsourceqDcdocutils.nodes reprunicode qEX2/home/prologic/work/circuits/docs/source/index.rstqFqG}qHbUtagnameqIUsectionqJU attributesqK}qL(UdupnamesqM]qNUclassesqO]qPUbackrefsqQ]qRUidsqS]qTh:aUnamesqU]qVhauUlineqWKUdocumentqXhh=]qY(cdocutils.nodes title qZ)q[}q\(hBX circuits |version| Documentationq]hCh@hDhGhIUtitleq^hK}q_(hM]q`hO]qahQ]qbhS]qchU]qduhWKhXhh=]qe(cdocutils.nodes Text qfX circuits qgqh}qi(hBX circuits qjhCh[ubhfX2.1.0qkql}qm(hBU2.1.0qnhDNhWNhXhhCh[ubhfX Documentationqoqp}qq(hBX DocumentationqrhCh[ubeubcdocutils.nodes field_list qs)qt}qu(hBUhCh@hDhGhIU field_listqvhK}qw(hM]qxhO]qyhQ]qzhS]q{hU]q|uhWKhXhh=]q}(cdocutils.nodes field q~)q}q(hBUhChthDhGhIUfieldqhK}q(hM]qhO]qhQ]qhS]qhU]quhWKhXhh=]q(cdocutils.nodes field_name q)q}q(hBXReleaseqhK}q(hM]qhO]qhQ]qhS]qhU]quhChh=]qhfXReleaseqq}q(hBhhChubahIU field_namequbcdocutils.nodes field_body q)q}q(hBX |release|qhK}q(hM]qhO]qhQ]qhS]qhU]quhChh=]qcdocutils.nodes paragraph q)q}q(hBhhChhDhGhIU paragraphqhK}q(hM]qhO]qhQ]qhS]qhU]quhWKh=]qhfX2.1.0qq}q(hBhnhChubaubahIU field_bodyqubeubh~)q}q(hBUhChthDhGhIhhK}q(hM]qhO]qhQ]qhS]qhU]quhWKhXhh=]q(h)q}q(hBXDateqhK}q(hM]qhO]qhQ]qhS]qhU]quhChh=]qhfXDateqŅq}q(hBhhChubahIhubh)q}q(hBX |today| qhK}q(hM]qhO]qhQ]qhS]qhU]quhChh=]qh)q}q(hBX|today|qhChhDhGhIhhK}q(hM]qhO]qhQ]qhS]qhU]quhWKh=]qhfXFebruary 27, 2013q܅q}q(hBXFebruary 27, 2013qhChubaubahIhubeubeubcdocutils.nodes target q)q}q(hBX7.. _Python Programming Language: http://www.python.org/qU referencedqKhCh@hDhEX README.rstq允q}qbhIUtargetqhK}q(UrefuriqXhttp://www.python.org/qhS]qh/ahQ]qhM]qhO]qhU]qhauhWKhXhh=]qubh)q}q(hBX].. _#circuits IRC Channel: http://webchat.freenode.net/?randomnick=1&channels=circuits&uio=d4qhKhCh@hDhhIhhK}q(hXBhttp://webchat.freenode.net/?randomnick=1&channels=circuits&uio=d4qhS]qh9ahQ]qhM]qhO]qhU]qhauhWKhXhh=]qubh)q}q(hBX-.. _FreeNode IRC Network: http://freenode.netqhKhCh@hDhhIhhK}r(hXhttp://freenode.netrhS]rh(ahQ]rhM]rhO]rhU]rhauhWKhXhh=]rubh)r}r (hBX<.. _Python Standard Library: http://docs.python.org/library/r hKhCh@hDhhIhhK}r (hXhttp://docs.python.org/library/r hS]r hubh)r?}r@(hBXF.. _Create an Issue: https://bitbucket.org/prologic/circuits/issue/newrAhKhCh@hDhhIhhK}rB(hX1https://bitbucket.org/prologic/circuits/issue/newrChS]rDh0ahQ]rEhM]rFhO]rGhU]rHhauhWKhXhh=]rIubh)rJ}rK(hBX?.. _Mailing List: http://groups.google.com/group/circuits-usersrLhKhCh@hDhhIhhK}rM(hX-http://groups.google.com/group/circuits-usersrNhS]rOh1ahQ]rPhM]rQhO]rRhU]rShauhWKhXhh=]rTubh)rU}rV(hBXE.. _Downloads page: https://bitbucket.org/prologic/circuits/downloadsrWhKhCh@hDhhIhhK}rX(hX1https://bitbucket.org/prologic/circuits/downloadsrYhS]rZh6ahQ]r[hM]r\hO]r]hU]r^hauhWKhXhh=]r_ubh?)r`}ra(hBUhCh@hDhhIhJhK}rb(hM]rchO]rdhQ]rehS]rfh)ahU]rgh auhWKhXhh=]rh(hZ)ri}rj(hBXOverviewrkhCj`hDhhIh^hK}rl(hM]rmhO]rnhQ]rohS]rphU]rquhWKhXhh=]rrhfXOverviewrsrt}ru(hBjkhCjiubaubh)rv}rw(hBXcircuits is a **Lightweight** **Event** driven and **Asynchronous** **Application Framework** for the `Python Programming Language`_ with a strong **Component** Architecture.rxhCj`hDhhIhhK}ry(hM]rzhO]r{hQ]r|hS]r}hU]r~uhWKhXhh=]r(hfXcircuits is a rr}r(hBXcircuits is a rhCjvubcdocutils.nodes strong r)r}r(hBX**Lightweight**rhK}r(hM]rhO]rhQ]rhS]rhU]ruhCjvh=]rhfX Lightweightrr}r(hBUhCjubahIUstrongrubhfX r}r(hBX hCjvubj)r}r(hBX **Event**rhK}r(hM]rhO]rhQ]rhS]rhU]ruhCjvh=]rhfXEventrr}r(hBUhCjubahIjubhfX driven and rr}r(hBX driven and rhCjvubj)r}r(hBX**Asynchronous**rhK}r(hM]rhO]rhQ]rhS]rhU]ruhCjvh=]rhfX Asynchronousrr}r(hBUhCjubahIjubhfX r}r(hBX hCjvubj)r}r(hBX**Application Framework**rhK}r(hM]rhO]rhQ]rhS]rhU]ruhCjvh=]rhfXApplication Frameworkrr}r(hBUhCjubahIjubhfX for the rr}r(hBX for the rhCjvubcdocutils.nodes reference r)r}r(hBX`Python Programming Language`_rUresolvedrKhCjvhIU referencerhK}r(UnamerXPython Programming LanguagerhhhS]rhQ]rhM]rhO]rhU]ruh=]rhfXPython Programming Languagerr}r(hBUhCjubaubhfX with a strong rr}r(hBX with a strong rhCjvubj)r}r(hBX **Component**rhK}r(hM]rhO]rhQ]rhS]rhU]ruhCjvh=]rhfX Componentrr}r(hBUhCjubahIjubhfX Architecture.rr}r(hBX Architecture.rhCjvubeubh)r}r(hBXcircuits also includes a lightweight, high performance and scalable HTTP/WSGI compliant web server as well as various I/O and Networking components.rhCj`hDhhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWKhXhh=]rhfXcircuits also includes a lightweight, high performance and scalable HTTP/WSGI compliant web server as well as various I/O and Networking components.rr}r(hBjhCjubaubh)r}r(hBXsTo take full advantage of circuits and its architecture, circuits encourages you to design your application in terms of loosely coupled components. Circuits has a very powerful message passing system that enables components to interact with each other via events. Applications written this way tend to be more maintainable, easier to develop and scale to complex systems.rhCj`hDhhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWKhXhh=]rhfXsTo take full advantage of circuits and its architecture, circuits encourages you to design your application in terms of loosely coupled components. Circuits has a very powerful message passing system that enables components to interact with each other via events. Applications written this way tend to be more maintainable, easier to develop and scale to complex systems.rr}r(hBjhCjubaubh)r}r(hBX8circuits' **Loosely Coupled** **Component Architecture** allows for a high level of **Reuse** and **Scalability**. Simpler components can be combined together to form Complex Components and provide higher level functionality and abstraction. Much of the circuits component library is designed and built this way.r hCj`hDhhIhhK}r (hM]r hO]r hQ]r hS]rhU]ruhWK hXhh=]r(hfX circuits' rr}r(hBX circuits' rhCjubj)r}r(hBX**Loosely Coupled**rhK}r(hM]rhO]rhQ]rhS]rhU]ruhCjh=]rhfXLoosely Coupledrr }r!(hBUhCjubahIjubhfX r"}r#(hBX hCjubj)r$}r%(hBX**Component Architecture**r&hK}r'(hM]r(hO]r)hQ]r*hS]r+hU]r,uhCjh=]r-hfXComponent Architecturer.r/}r0(hBUhCj$ubahIjubhfX allows for a high level of r1r2}r3(hBX allows for a high level of r4hCjubj)r5}r6(hBX **Reuse**r7hK}r8(hM]r9hO]r:hQ]r;hS]r<hU]r=uhCjh=]r>hfXReuser?r@}rA(hBUhCj5ubahIjubhfX and rBrC}rD(hBX and rEhCjubj)rF}rG(hBX**Scalability**rHhK}rI(hM]rJhO]rKhQ]rLhS]rMhU]rNuhCjh=]rOhfX ScalabilityrPrQ}rR(hBUhCjFubahIjubhfX. Simpler components can be combined together to form Complex Components and provide higher level functionality and abstraction. Much of the circuits component library is designed and built this way.rSrT}rU(hBX. Simpler components can be combined together to form Complex Components and provide higher level functionality and abstraction. Much of the circuits component library is designed and built this way.rVhCjubeubcdocutils.nodes bullet_list rW)rX}rY(hBUhCj`hDhhIU bullet_listrZhK}r[(Ubulletr\X-hS]r]hQ]r^hM]r_hO]r`hU]rauhWK&hXhh=]rb(cdocutils.nodes list_item rc)rd}re(hBXK**Documentation**: http://packages.python.org/circuits or `Read the Docs`_.rfhCjXhDhhIU list_itemrghK}rh(hM]rihO]rjhQ]rkhS]rlhU]rmuhWNhXhh=]rnh)ro}rp(hBjfhCjdhDhhIhhK}rq(hM]rrhO]rshQ]rthS]ruhU]rvuhWK&h=]rw(j)rx}ry(hBX**Documentation**rzhK}r{(hM]r|hO]r}hQ]r~hS]rhU]ruhCjoh=]rhfX Documentationrr}r(hBUhCjxubahIjubhfX: rr}r(hBX: rhCjoubj)r}r(hBX#http://packages.python.org/circuitsrhK}r(UrefurirX#http://packages.python.org/circuitsrhS]rhQ]rhM]rhO]rhU]ruhCjoh=]rhfX#http://packages.python.org/circuitsrr}r(hBUhCjubahIjubhfX or rr}r(hBX or rhCjoubj)r}r(hBX`Read the Docs`_rjKhCjohIjhK}r(UnamerX Read the Docsrhj-hS]rhQ]rhM]rhO]rhU]ruh=]rhfX Read the Docsrr}r(hBUhCjubaubhfX.r}r(hBX.hCjoubeubaubjc)r}r(hBX=**Project website**: https://bitbucket.org/prologic/circuits/rhCjXhDhhIjghK}r(hM]rhO]rhQ]rhS]rhU]ruhWNhXhh=]rh)r}r(hBjhCjhDhhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWK'h=]r(j)r}r(hBX**Project website**rhK}r(hM]rhO]rhQ]rhS]rhU]ruhCjh=]rhfXProject websiterr}r(hBUhCjubahIjubhfX: rr}r(hBX: rhCjubj)r}r(hBX(https://bitbucket.org/prologic/circuits/rhK}r(UrefurirX(https://bitbucket.org/prologic/circuits/rhS]rhQ]rhM]rhO]rhU]ruhCjh=]rhfX(https://bitbucket.org/prologic/circuits/rr}r(hBUhCjubahIjubeubaubjc)r}r(hBX5**PyPI page**: http://pypi.python.org/pypi/circuits rhCjXhDhhIjghK}r(hM]rhO]rhQ]rhS]rhU]ruhWNhXhh=]rh)r}r(hBX3**PyPI page**: http://pypi.python.org/pypi/circuitsrhCjhDhhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWK(h=]r(j)r}r(hBX **PyPI page**rhK}r(hM]rhO]rhQ]rhS]rhU]ruhCjh=]rhfX PyPI pagerr}r(hBUhCjubahIjubhfX: rr}r(hBX: rhCjubj)r}r(hBX$http://pypi.python.org/pypi/circuitsrhK}r(Urefurir X$http://pypi.python.org/pypi/circuitsr hS]r hQ]r hM]r hO]rhU]ruhCjh=]rhfX$http://pypi.python.org/pypi/circuitsrr}r(hBUhCjubahIjubeubaubeubeubh?)r}r(hBUhCh@hDhhIhJhK}r(hM]rhO]rhQ]rhS]rh'ahU]rhauhWK,hXhh=]r(hZ)r}r(hBXFeaturesrhCjhDhhIh^hK}r (hM]r!hO]r"hQ]r#hS]r$hU]r%uhWK,hXhh=]r&hfXFeaturesr'r(}r)(hBjhCjubaubjW)r*}r+(hBUhCjhDhhIjZhK}r,(j\X-hS]r-hQ]r.hM]r/hO]r0hU]r1uhWK.hXhh=]r2(jc)r3}r4(hBX event drivenr5hCj*hDhhIjghK}r6(hM]r7hO]r8hQ]r9hS]r:hU]r;uhWNhXhh=]r<h)r=}r>(hBj5hCj3hDhhIhhK}r?(hM]r@hO]rAhQ]rBhS]rChU]rDuhWK.h=]rEhfX event drivenrFrG}rH(hBj5hCj=ubaubaubjc)rI}rJ(hBXconcurrency supportrKhCj*hDhhIjghK}rL(hM]rMhO]rNhQ]rOhS]rPhU]rQuhWNhXhh=]rRh)rS}rT(hBjKhCjIhDhhIhhK}rU(hM]rVhO]rWhQ]rXhS]rYhU]rZuhWK/h=]r[hfXconcurrency supportr\r]}r^(hBjKhCjSubaubaubjc)r_}r`(hBXcomponent architecturerahCj*hDhhIjghK}rb(hM]rchO]rdhQ]rehS]rfhU]rguhWNhXhh=]rhh)ri}rj(hBjahCj_hDhhIhhK}rk(hM]rlhO]rmhQ]rnhS]rohU]rpuhWK0h=]rqhfXcomponent architecturerrrs}rt(hBjahCjiubaubaubjc)ru}rv(hBXasynchronous I/O componentsrwhCj*hDhhIjghK}rx(hM]ryhO]rzhQ]r{hS]r|hU]r}uhWNhXhh=]r~h)r}r(hBjwhCjuhDhhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWK1h=]rhfXasynchronous I/O componentsrr}r(hBjwhCjubaubaubjc)r}r(hBX!no required external dependenciesrhCj*hDhhIjghK}r(hM]rhO]rhQ]rhS]rhU]ruhWNhXhh=]rh)r}r(hBjhCjhDhhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWK2h=]rhfX!no required external dependenciesrr}r(hBjhCjubaubaubjc)r}r(hBX*full featured web framework (circuits.web)rhCj*hDhhIjghK}r(hM]rhO]rhQ]rhS]rhU]ruhWNhXhh=]rh)r}r(hBjhCjhDhhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWK3h=]rhfX*full featured web framework (circuits.web)rr}r(hBjhCjubaubaubjc)r}r(hBX,coroutine based synchronization primitives rhCj*hDhhIjghK}r(hM]rhO]rhQ]rhS]rhU]ruhWNhXhh=]rh)r}r(hBX*coroutine based synchronization primitivesrhCjhDhhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWK4h=]rhfX*coroutine based synchronization primitivesrr}r(hBjhCjubaubaubeubeubh?)r}r(hBUhCh@hDhhIhJhK}r(hM]rhO]rhQ]rhS]rh.ahU]rhauhWK8hXhh=]r(hZ)r}r(hBX RequirementsrhCjhDhhIh^hK}r(hM]rhO]rhQ]rhS]rhU]ruhWK8hXhh=]rhfX Requirementsrr}r(hBjhCjubaubjW)r}r(hBUhCjhDhhIjZhK}r(j\X-hS]rhQ]rhM]rhO]rhU]ruhWK:hXhh=]rjc)r}r(hBXEcircuits has no dependencies beyond the `Python Standard Library`_. rhCjhDhhIjghK}r(hM]rhO]rhQ]rhS]rhU]ruhWNhXhh=]rh)r}r(hBXCcircuits has no dependencies beyond the `Python Standard Library`_.rhCjhDhhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWK:h=]r(hfX(circuits has no dependencies beyond the rr}r(hBX(circuits has no dependencies beyond the rhCjubj)r}r(hBX`Python Standard Library`_rjKhCjhIjhK}r(Unamer XPython Standard Libraryr hj hS]r hQ]r hM]r hO]rhU]ruh=]rhfXPython Standard Libraryrr}r(hBUhCjubaubhfX.r}r(hBX.hCjubeubaubaubeubh?)r}r(hBUhCh@hDhhIhJhK}r(hM]rhO]rhQ]rhS]rh2ahU]rhauhWK>hXhh=]r(hZ)r}r (hBXSupported Platformsr!hCjhDhhIh^hK}r"(hM]r#hO]r$hQ]r%hS]r&hU]r'uhWK>hXhh=]r(hfXSupported Platformsr)r*}r+(hBj!hCjubaubjW)r,}r-(hBUhCjhDhhIjZhK}r.(j\X-hS]r/hQ]r0hM]r1hO]r2hU]r3uhWK@hXhh=]r4(jc)r5}r6(hBXLinux, FreeBSD, Mac OS Xr7hCj,hDhhIjghK}r8(hM]r9hO]r:hQ]r;hS]r<hU]r=uhWNhXhh=]r>h)r?}r@(hBj7hCj5hDhhIhhK}rA(hM]rBhO]rChQ]rDhS]rEhU]rFuhWK@h=]rGhfXLinux, FreeBSD, Mac OS XrHrI}rJ(hBj7hCj?ubaubaubjc)rK}rL(hBXPython 2.6, 2.7, 3.2, 3.3rMhCj,hDhhIjghK}rN(hM]rOhO]rPhQ]rQhS]rRhU]rSuhWNhXhh=]rTh)rU}rV(hBjMhCjKhDhhIhhK}rW(hM]rXhO]rYhQ]rZhS]r[hU]r\uhWKAh=]r]hfXPython 2.6, 2.7, 3.2, 3.3r^r_}r`(hBjMhCjUubaubaubjc)ra}rb(hBX pypy 2.0 rchCj,hDhhIjghK}rd(hM]rehO]rfhQ]rghS]rhhU]riuhWNhXhh=]rjh)rk}rl(hBXpypy 2.0rmhCjahDhhIhhK}rn(hM]rohO]rphQ]rqhS]rrhU]rsuhWKBh=]rthfXpypy 2.0rurv}rw(hBjmhCjkubaubaubeubcdocutils.nodes definition_list rx)ry}rz(hBUhCjhDhhIUdefinition_listr{hK}r|(hM]r}hO]r~hQ]rhS]rhU]ruhWNhXhh=]rcdocutils.nodes definition_list_item r)r}r(hBX**Windows**: We acknowledge that Windows exists and make reasonable efforts to maintain compatibility. Unfortunately we cannot guarantee support at this time. rhCjyhDhhIUdefinition_list_itemrhK}r(hM]rhO]rhQ]rhS]rhU]ruhWKFh=]r(cdocutils.nodes term r)r}r(hBXK**Windows**: We acknowledge that Windows exists and make reasonable effortsrhCjhDhhIUtermrhK}r(hM]rhO]rhQ]rhS]rhU]ruhWKFh=]r(j)r}r(hBX **Windows**rhK}r(hM]rhO]rhQ]rhS]rhU]ruhCjh=]rhfXWindowsrr}r(hBUhCjubahIjubhfX@: We acknowledge that Windows exists and make reasonable effortsrr}r(hBX@: We acknowledge that Windows exists and make reasonable effortsrhCjubeubcdocutils.nodes definition r)r}r(hBUhK}r(hM]rhO]rhQ]rhS]rhU]ruhCjh=]rh)r}r(hBXRto maintain compatibility. Unfortunately we cannot guarantee support at this time.rhCjhDhhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWKEh=]rhfXRto maintain compatibility. Unfortunately we cannot guarantee support at this time.rr}r(hBjhCjubaubahIU definitionrubeubaubh)r}r(hBX8**NB**: We are working toward getting Windows supported.rhCjhDhhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWKHhXhh=]r(j)r}r(hBX**NB**rhK}r(hM]rhO]rhQ]rhS]rhU]ruhCjh=]rhfXNBrr}r(hBUhCjubahIjubhfX2: We are working toward getting Windows supported.rr}r(hBX2: We are working toward getting Windows supported.rhCjubeubeubh?)r}r(hBUhCh@hDhhIhJhK}r(hM]rhO]rhQ]rhS]rh7ahU]rhauhWKLhXhh=]r(hZ)r}r(hBX InstallationrhCjhDhhIh^hK}r(hM]rhO]rhQ]rhS]rhU]ruhWKLhXhh=]rhfX Installationrr}r(hBjhCjubaubh)r}r(hBXThe simplest and recommended way to install circuits is with pip. You may install the latest stable release from PyPI with pip::rhCjhDhhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWKNhXhh=]rhfXThe simplest and recommended way to install circuits is with pip. You may install the latest stable release from PyPI with pip:rr}r(hBXThe simplest and recommended way to install circuits is with pip. You may install the latest stable release from PyPI with pip:rhCjubaubcdocutils.nodes literal_block r)r}r(hBX> pip install circuitsrhCjhDhhIU literal_blockrhK}r(U xml:spacer Upreserver hS]r hQ]r hM]r hO]rhU]ruhWK^hXhh=]rhfX> pip install circuitsrr}r(hBUhCjubaubh)r}r(hBX2If you do not have pip, you may use easy_install::rhCjhDhhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWKShXhh=]rhfX1If you do not have pip, you may use easy_install:rr}r (hBX1If you do not have pip, you may use easy_install:r!hCjubaubj)r"}r#(hBX> easy_install circuitsr$hCjhDhhIjhK}r%(j j hS]r&hQ]r'hM]r(hO]r)hU]r*uhWKbhXhh=]r+hfX> easy_install circuitsr,r-}r.(hBUhCj"ubaubh)r/}r0(hBXAlternatively, you may download the source package from the `PyPi Page`_ or the `Downloads page`_ on the `Website`_; extract it and install using::r1hCjhDhhIhhK}r2(hM]r3hO]r4hQ]r5hS]r6hU]r7uhWKWhXhh=]r8(hfX<Alternatively, you may download the source package from the r9r:}r;(hBX<Alternatively, you may download the source package from the r<hCj/ubj)r=}r>(hBX `PyPi Page`_r?jKhCj/hIjhK}r@(UnamerAX PyPi PagerBhj"hS]rChQ]rDhM]rEhO]rFhU]rGuh=]rHhfX PyPi PagerIrJ}rK(hBUhCj=ubaubhfX or the rLrM}rN(hBX or the rOhCj/ubj)rP}rQ(hBX`Downloads page`_rRjKhCj/hIjhK}rS(UnamerTXDownloads pagerUhjYhS]rVhQ]rWhM]rXhO]rYhU]rZuh=]r[hfXDownloads pager\r]}r^(hBUhCjPubaubhfX on the r_r`}ra(hBX on the rbhCj/ubj)rc}rd(hBX `Website`_rejKhCj/hIjhK}rf(UnamergXWebsiterhhjhS]rihQ]rjhM]rkhO]rlhU]rmuh=]rnhfXWebsiterorp}rq(hBUhCjcubaubhfX; extract it and install using:rrrs}rt(hBX; extract it and install using:ruhCj/ubeubj)rv}rw(hBX> python setup.py installrxhCjhDhhIjhK}ry(j j hS]rzhQ]r{hM]r|hO]r}hU]r~uhWKhhXhh=]rhfX> python setup.py installrr}r(hBUhCjvubaubeubh?)r}r(hBUhCh@hDhhIhJhK}r(hM]rhO]rhQ]rhS]rh8ahU]rhauhWK_hXhh=]r(hZ)r}r(hBXLicenserhCjhDhhIh^hK}r(hM]rhO]rhQ]rhS]rhU]ruhWK_hXhh=]rhfXLicenserr}r(hBjhCjubaubh)r}r(hBX.circuits is licensed under the `MIT License`_.rhCjhDhhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWKahXhh=]r(hfXcircuits is licensed under the rr}r(hBXcircuits is licensed under the rhCjubj)r}r(hBX`MIT License`_rjKhCjhIjhK}r(UnamerX MIT Licenserhj8hS]rhQ]rhM]rhO]rhU]ruh=]rhfX MIT Licenserr}r(hBUhCjubaubhfX.r}r(hBX.hCjubeubeubh?)r}r(hBUhCh@hDhhIhJhK}r(hM]rhO]rhQ]rhS]rh-ahU]rh auhWKehXhh=]r(hZ)r}r(hBXFeedbackrhCjhDhhIh^hK}r(hM]rhO]rhQ]rhS]rhU]ruhWKehXhh=]rhfXFeedbackrr}r(hBjhCjubaubh)r}r(hBXWe welcome any questions or feedback about bugs and suggestions on how to improve circuits. Let us know what you think about circuits. `@pythoncircuits `_.rhCjhDhhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWKghXhh=]r(hfXWe welcome any questions or feedback about bugs and suggestions on how to improve circuits. Let us know what you think about circuits. rr}r(hBXWe welcome any questions or feedback about bugs and suggestions on how to improve circuits. Let us know what you think about circuits. rhCjubj)r}r(hBX6`@pythoncircuits `_rhK}r(UnamerX@pythoncircuitsrhX!http://twitter.com/pythoncircuitsrhS]rhQ]rhM]rhO]rhU]ruhCjh=]rhfX@pythoncircuitsrr}r(hBUhCjubahIjubh)r}r(hBX$ rhKhCjhIhhK}r(UrefurirjhS]rh3ahQ]rhM]rhO]rhU]rhauh=]rubhfX.r}r(hBX.hCjubeubh)r}r(hBXDo 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.rhCjhDhhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWKjhXhh=]r(hfX5Do you have suggestions for improvement? Then please rr}r(hBX5Do you have suggestions for improvement? Then please rhCjubj)r}r(hBX`Create an Issue`_r jKhCjhIjhK}r (Unamer XCreate an Issuer hjChS]r hQ]rhM]rhO]rhU]ruh=]rhfXCreate an Issuerr}r(hBUhCjubaubhfX 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.rr}r(hBX 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.rhCjubeubeubh?)r}r(hBUhCh@hDhhIhJhK}r(hM]rhO]rhQ]rhS]r h*ahU]r!h auhWKphXhh=]r"(hZ)r#}r$(hBX Communityr%hCjhDhhIh^hK}r&(hM]r'hO]r(hQ]r)hS]r*hU]r+uhWKphXhh=]r,hfX Communityr-r.}r/(hBj%hCj#ubaubh)r0}r1(hBXThere is also a small community of circuits enthusiasts that you may find on the `#circuits IRC Channel`_ on the `FreeNode IRC Network`_ and the `Mailing List`_.r2hCjhDhhIhhK}r3(hM]r4hO]r5hQ]r6hS]r7hU]r8uhWKrhXhh=]r9(hfXQThere is also a small community of circuits enthusiasts that you may find on the r:r;}r<(hBXQThere is also a small community of circuits enthusiasts that you may find on the r=hCj0ubj)r>}r?(hBX`#circuits IRC Channel`_r@jKhCj0hIjhK}rA(UnamerBX#circuits IRC ChannelrChhhS]rDhQ]rEhM]rFhO]rGhU]rHuh=]rIhfX#circuits IRC ChannelrJrK}rL(hBUhCj>ubaubhfX on the rMrN}rO(hBX on the rPhCj0ubj)rQ}rR(hBX`FreeNode IRC Network`_rSjKhCj0hIjhK}rT(UnamerUXFreeNode IRC NetworkrVhjhS]rWhQ]rXhM]rYhO]rZhU]r[uh=]r\hfXFreeNode IRC Networkr]r^}r_(hBUhCjQubaubhfX and the r`ra}rb(hBX and the rchCj0ubj)rd}re(hBX`Mailing List`_rfjKhCj0hIjhK}rg(UnamerhX Mailing ListrihjNhS]rjhQ]rkhM]rlhO]rmhU]rnuh=]rohfX Mailing Listrprq}rr(hBUhCjdubaubhfX.rs}rt(hBX.hCj0ubeubcdocutils.nodes raw ru)rv}rw(hBUhCjhDhhIUrawrxhK}ry(UformatrzXhtmlr{j j hS]r|hQ]r}hM]r~hO]rhU]ruhWKwhXhh=]rhfXjrr}r(hBUhCjvubaubh?)r}r(hBUhCjhDhGhIhJhK}r(hM]rhO]rhQ]rhS]rh,ahU]rh auhWKhXhh=]r(hZ)r}r(hBXContentsrhCjhDhGhIh^hK}r(hM]rhO]rhQ]rhS]rhU]ruhWKhXhh=]rhfXContentsrr}r(hBjhCjubaubcdocutils.nodes compound r)r}r(hBUhCjhDhGhIUcompoundrhK}r(hM]rhO]rUtoctree-wrapperrahQ]rhS]rhU]ruhWNhXhh=]rcsphinx.addnodes toctree r)r}r(hBUhCjhDhGhIUtoctreerhK}r(UnumberedrKhCUindexrU titlesonlyrUglobrhS]rhQ]rhM]rhO]rhU]rUentriesr]r(NX start/indexrrNXtutorial/indexrrNX man/indexrrNX web/indexrrNX howtos/indexrrNX api/indexrrNX dev/indexrrNXchangesrrNXusersrrNX contributorsrrNXfaqrreUhiddenrU includefilesr]r(jjjjjjjjjjjeUmaxdepthrKuhWKh=]rubaubj)r}r(hBUhCjhDhGhIjhK}r(hM]rhO]rjahQ]rhS]rhU]ruhWNhXhh=]rj)r}r(hBUhCjhDhGhIjhK}r(jKhCjjjhS]rhQ]rhM]rhO]rhU]rj]r(NXglossaryrrNXusersrrejj]r(jjejJuhWK h=]rubaubcsphinx.ext.ifconfig ifconfig r)r}r(hBUhCjhDhGhIUifconfigrhK}r(UexprrXdevelrhS]rhQ]rhM]rhO]rhU]ruhWK&hXhh=]rj)r}r(hBUhCjhDhGhIjhK}r(hM]rhO]rjahQ]rhS]rhU]ruhWNhXhh=]rj)r}r(hBUhCjhDhGhIjhK}r(jKhCjjjhS]rhQ]rhM]rhO]rhU]rj]r(NXpypitestr r NXtodor r ejj]r (j j ejJuhWK(h=]rubaubaubeubh?)r}r(hBUhCjhDhGhIhJhK}r(hM]rhO]rhQ]rhS]rh+ahU]rh auhWK0hXhh=]r(hZ)r}r(hBXIndices and tablesrhCjhDhGhIh^hK}r(hM]rhO]rhQ]rhS]rhU]r uhWK0hXhh=]r!hfXIndices and tablesr"r#}r$(hBjhCjubaubjW)r%}r&(hBUhCjhDhGhIjZhK}r'(j\X*hS]r(hQ]r)hM]r*hO]r+hU]r,uhWK3hXhh=]r-(jc)r.}r/(hBX:ref:`Index `r0hCj%hDhGhIjghK}r1(hM]r2hO]r3hQ]r4hS]r5hU]r6uhWNhXhh=]r7h)r8}r9(hBj0hCj.hDhGhIhhK}r:(hM]r;hO]r<hQ]r=hS]r>hU]r?uhWK3h=]r@csphinx.addnodes pending_xref rA)rB}rC(hBj0hCj8hDhGhIU pending_xrefrDhK}rE(UreftyperFXrefrGUrefwarnrHU reftargetrIXgenindexrJU refdomainrKXstdrLhS]rMhQ]rNU refexplicitrOhM]rPhO]rQhU]rRUrefdocrSjuhWK3h=]rTcdocutils.nodes emphasis rU)rV}rW(hBj0hK}rX(hM]rYhO]rZ(Uxrefr[jLXstd-refr\ehQ]r]hS]r^hU]r_uhCjBh=]r`hfXIndexrarb}rc(hBUhCjVubahIUemphasisrdubaubaubaubjc)re}rf(hBX:ref:`modindex`rghCj%hDhGhIjghK}rh(hM]rihO]rjhQ]rkhS]rlhU]rmuhWNhXhh=]rnh)ro}rp(hBjghCjehDhGhIhhK}rq(hM]rrhO]rshQ]rthS]ruhU]rvuhWK4h=]rwjA)rx}ry(hBjghCjohDhGhIjDhK}rz(Ureftyper{Xrefr|jHjIXmodindexr}U refdomainr~XstdrhS]rhQ]rU refexplicitrhM]rhO]rhU]rjSjuhWK4h=]rjU)r}r(hBjghK}r(hM]rhO]r(j[jXstd-refrehQ]rhS]rhU]ruhCjxh=]rhfXmodindexrr}r(hBUhCjubahIjdubaubaubaubjc)r}r(hBX :ref:`search`rhCj%hDhGhIjghK}r(hM]rhO]rhQ]rhS]rhU]ruhWNhXhh=]rh)r}r(hBjhCjhDhGhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWK5h=]rjA)r}r(hBjhCjhDhGhIjDhK}r(UreftyperXrefrjHjIXsearchrU refdomainrXstdrhS]rhQ]rU refexplicitrhM]rhO]rhU]rjSjuhWK5h=]rjU)r}r(hBjhK}r(hM]rhO]r(j[jXstd-refrehQ]rhS]rhU]ruhCjh=]rhfXsearchrr}r(hBUhCjubahIjdubaubaubaubjc)r}r(hBX:doc:`glossary` rhCj%hDhGhIjghK}r(hM]rhO]rhQ]rhS]rhU]ruhWNhXhh=]rh)r}r(hBX:doc:`glossary`rhCjhDhGhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWK6h=]rjA)r}r(hBjhCjhDhGhIjDhK}r(UreftyperXdocrjHjIXglossaryrU refdomainrUhS]rhQ]rU refexplicitrhM]rhO]rhU]rjSjuhWK6h=]rcdocutils.nodes literal r)r}r(hBjhK}r(hM]rhO]r(j[jehQ]rhS]rhU]ruhCjh=]rhfXglossaryrr}r(hBUhCjubahIUliteralrubaubaubaubeubj)r}r(hBUhCjhDhGhIjhK}r(jXdevelrhS]rhQ]rhM]rhO]rhU]ruhWK8hXhh=]rjW)r}r(hBUhCjhDhGhIjZhK}r(j\X*hS]rhQ]rhM]rhO]rhU]ruhWK:hXhh=]r(jc)r}r(hBX:doc:`pypitest`rhCjhDhGhIjghK}r (hM]r hO]r hQ]r hS]r hU]ruhWNhXhh=]rh)r}r(hBjhCjhDhGhIhhK}r(hM]rhO]rhQ]rhS]rhU]ruhWK:h=]rjA)r}r(hBjhCjhDhGhIjDhK}r(UreftyperXdocrjHjIXpypitestrU refdomainrUhS]r hQ]r!U refexplicitr"hM]r#hO]r$hU]r%jSjuhWK:h=]r&j)r'}r((hBjhK}r)(hM]r*hO]r+(j[jehQ]r,hS]r-hU]r.uhCjh=]r/hfXpypitestr0r1}r2(hBUhCj'ubahIjubaubaubaubjc)r3}r4(hBX :doc:`todo`r5hCjhDhGhIjghK}r6(hM]r7hO]r8hQ]r9hS]r:hU]r;uhWNhXhh=]r<h)r=}r>(hBj5hCj3hDhGhIhhK}r?(hM]r@hO]rAhQ]rBhS]rChU]rDuhWK;h=]rEjA)rF}rG(hBj5hCj=hDhGhIjDhK}rH(UreftyperIXdocrJjHjIXtodorKU refdomainrLUhS]rMhQ]rNU refexplicitrOhM]rPhO]rQhU]rRjSjuhWK;h=]rSj)rT}rU(hBj5hK}rV(hM]rWhO]rX(j[jJehQ]rYhS]rZhU]r[uhCjFh=]r\hfXtodor]r^}r_(hBUhCjTubahIjubaubaubaubeubaubeubeubeubahBUU transformerr`NU footnote_refsra}rbUrefnamesrc}rd(Xwebsitere]rfjcaX mit licenserg]rhjaX read the docsri]rjjaX#circuits irc channelrk]rlj>aXfreenode irc networkrm]rnjQaXpython programming languagero]rpjaXcreate an issuerq]rrjaX mailing listrs]rtjdaX pypi pageru]rvj=aXdownloads pagerw]rxjPaXpython standard libraryry]rzjauUsymbol_footnotesr{]r|Uautofootnote_refsr}]r~Usymbol_footnote_refsr]rU citationsr]rhXhU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh^NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrU ISO-8859-1rU_sourcerU2/home/prologic/work/circuits/docs/source/index.rstrUgettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrUhttp://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]rUfile_insertion_enabledrKU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(h-jh9hh*jh,jh'jh.jh1jJh/hh)j`h(hh0j?h5j)h4jh+jh6jUh;jh2jh&j4h)q?}q@(h&XUsersqAh'h$h(h+h-UtitleqBh/}qC(h1]qDh3]qEh5]qFh7]qGh9]qHuh;Kh)qW}qX(h&X Applications written in circuitsqYh'hNh(h+h-hBh/}qZ(h1]q[h3]q\h5]q]h7]q^h9]q_uh;Kh`_ a Wiki / CMS / Blogging Engine.qsh'heh(h+h-U list_itemqth/}qu(h1]qvh3]qwh5]qxh7]qyh9]qzuh;Nh`_ a Wiki / CMS / Blogging Engine.qh'hqh(h+h-U paragraphqh/}q(h1]qh3]qh5]qh7]qh9]quh;Kh!]q(cdocutils.nodes reference q)q}q(h&X%`SahrisWiki `_qh/}q(UnameqX SahrisWikiqUrefuriqXhttp://sahriswiki.orgqh7]qh5]qh1]qh3]qh9]quh'h}h!]qhJX SahrisWikiqq}q(h&Uh'hubah-U referencequbcdocutils.nodes target q)q}q(h&X qU referencedqKh'h}h-Utargetqh/}q(Urefuriqhh7]qhah5]qh1]qh3]qh9]qh auh!]qubhJX a Wiki / CMS / Blogging Engine.qq}q(h&X a Wiki / CMS / Blogging Engine.qh'h}ubeubaubhp)q}q(h&XL`kdb `_ a pluggable IRC Bot Framework. qh'heh(h+h-hth/}q(h1]qh3]qh5]qh7]qh9]quh;Nh`_ a pluggable IRC Bot Framework.qh'hh(h+h-hh/}q(h1]qh3]qh5]qh7]qh9]quh;K h!]q(h)q}q(h&X+`kdb `_qh/}q(UnameqXkdbqhX"http://bitbucket.org/prologic/kdb/qh7]qh5]qh1]qh3]qh9]quh'hh!]qhJXkdbq΅q}q(h&Uh'hubah-hubh)q}q(h&X% qhKh'hh-hh/}q(Urefuriqhh7]qhah5]qh1]qh3]qh9]qhauh!]qubhJX a pluggable IRC Bot Framework.q܅q}q(h&X a pluggable IRC Bot Framework.qh'hubeubaubeubeubh#)q}q(h&Uh'h$h(h+h-h.h/}q(h1]qh3]qh5]qh7]qhah9]qhauh;Kh)q}q(h&X!Applications integrating circuitsqh'hh(h+h-hBh/}q(h1]qh3]qh5]qh7]qh9]quh;Kh`) Next generation virtual worlds viewer; Naali, for Python components. Worked on by Toni Alatalo and Petri Aura at `Playsign ` in collaboration with other realXtend developers.rh'hh(h+h-hth/}r(h1]rh3]rh5]rh7]rh9]ruh;Nh`) Next generation virtual worlds viewer; Naali, for Python components. Worked on by Toni Alatalo and Petri Aura at `Playsign ` in collaboration with other realXtend developers.r h'hh(h+h-hh/}r (h1]r h3]rh5]rh7]rh9]ruh;Kh!]r(cdocutils.nodes title_reference r)r}r(h&X#`realXtend `rh/}r(h1]rh3]rh5]rh7]rh9]ruh'j h!]rhJX!realXtend rr}r (h&Uh'jubah-Utitle_referencer!ubhJXs) Next generation virtual worlds viewer; Naali, for Python components. Worked on by Toni Alatalo and Petri Aura at r"r#}r$(h&Xs) Next generation virtual worlds viewer; Naali, for Python components. Worked on by Toni Alatalo and Petri Aura at r%h'j ubj)r&}r'(h&X%`Playsign `r(h/}r)(h1]r*h3]r+h5]r,h7]r-h9]r.uh'j h!]r/hJX#Playsign r0r1}r2(h&Uh'j&ubah-j!ubhJX2 in collaboration with other realXtend developers.r3r4}r5(h&X2 in collaboration with other realXtend developers.r6h'j ubeubaubhp)r7}r8(h&X`PriceWaterHouseCoopers `) `TAMS `_ Report Generator written by James Mills and Michael Anton.r9h'hh(h+h-hth/}r:(h1]r;h3]r<h5]r=h7]r>h9]r?uh;Nh`) `TAMS `_ Report Generator written by James Mills and Michael Anton.rCh'j7h(h+h-hh/}rD(h1]rEh3]rFh5]rGh7]rHh9]rIuh;Kh!]rJ(j)rK}rL(h&X.`PriceWaterHouseCoopers `rMh/}rN(h1]rOh3]rPh5]rQh7]rRh9]rSuh'jAh!]rThJX,PriceWaterHouseCoopers rUrV}rW(h&Uh'jKubah-j!ubhJX) rXrY}rZ(h&X) r[h'jAubh)r\}r](h&X `TAMS `_r^h/}r_(Unamer`XTAMSrahXhttp://www.tams.com.aurbh7]rch5]rdh1]reh3]rfh9]rguh'jAh!]rhhJXTAMSrirj}rk(h&Uh'j\ubah-hubh)rl}rm(h&X rnhKh'jAh-hh/}ro(Urefurirpjbh7]rqh ah5]rrh1]rsh3]rth9]ruhauh!]rvubhJX; Report Generator written by James Mills and Michael Anton.rwrx}ry(h&X; Report Generator written by James Mills and Michael Anton.rzh'jAubeubaubhp)r{}r|(h&X`Mangahelpers `_ Profiler for checking our webpages generation times, SQL and cache queries times, project page on r}h'hh(h+h-hth/}r~(h1]rh3]rh5]rh7]rh9]ruh;Nh`_ Profiler for checking our webpages generation times, SQL and cache queries times, project page on rh'j{h(h+h-hh/}r(h1]rh3]rh5]rh7]rh9]ruh;Kh!]r(h)r}r(h&X*`Mangahelpers `_rh/}r(UnamerX MangahelpersrhXhttp://mangahelpers.com/rh7]rh5]rh1]rh3]rh9]ruh'jh!]rhJX Mangahelpersrr}r(h&Uh'jubah-hubh)r}r(h&X rhKh'jh-hh/}r(Urefurirjh7]rhah5]rh1]rh3]rh9]rh auh!]rubhJXd Profiler for checking our webpages generation times, SQL and cache queries times, project page on r}r(h&X>h'jubeubaubeubeubh#)r}r(h&Uh'h$h(h+h-h.h/}r(h1]rh3]rh5]rh7]rhah9]rh auh;Kh)r}r(h&X Other Usersrh'jh(h+h-hBh/}r(h1]rh3]rh5]rh7]rh9]ruh;Kh`_ Uses circuits for several internal prototypesrh'jh(h+h-hth/}r(h1]rh3]rh5]rh7]rh9]ruh;Nh`_ Uses circuits for several internal prototypesrh'jh(h+h-hh/}r(h1]rh3]rh5]rh7]rh9]ruh;K h!]r(h)r}r(h&X)`MIT Media Lab, `_rh/}r(UnamerXMIT Media Lab,rhXhttp://media.mit.edu/rh7]rh5]rh1]rh3]rh9]ruh'jh!]rhJXMIT Media Lab,rr}r(h&Uh'jubah-hubh)r}r(h&X rhKh'jh-hh/}r(Urefurirjh7]rhah5]rh1]r h3]r h9]r h auh!]r ubhJX. Uses circuits for several internal prototypesr r}r(h&X. Uses circuits for several internal prototypesrh'jubeubaubaubeubeubah&UU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rhUdebugr?NUembed_stylesheetr@Uoutput_encoding_error_handlerrAUstrictrBU sectnum_xformrCKUdump_transformsrDNU docinfo_xformrEKUwarning_streamrFNUpep_file_url_templaterGUpep-%04drHUexit_status_levelrIKUconfigrJNUstrict_visitorrKNUcloak_email_addressesrLUtrim_footnote_reference_spacerMUenvrNNUdump_pseudo_xmlrONUexpose_internalsrPNUsectsubtitle_xformrQU source_linkrRNUrfc_referencesrSNUoutput_encodingrTUutf-8rUU source_urlrVNUinput_encodingrWU utf-8-sigrXU_disable_configrYNU id_prefixrZUU tab_widthr[KUerror_encodingr\U ISO-8859-1r]U_sourcer^U2/home/prologic/work/circuits/docs/source/users.rstr_Ugettext_compactr`U generatorraNUdump_internalsrbNU smart_quotesrcU pep_base_urlrdUhttp://www.python.org/dev/peps/reUsyntax_highlightrfUlongrgUinput_encoding_error_handlerrhjBUauto_id_prefixriUidrjUdoctitle_xformrkUstrip_elements_with_classesrlNU _config_filesrm]rnUfile_insertion_enabledroKU raw_enabledrpKU dump_settingsrqNubUsymbol_footnote_startrrKUidsrs}rt(hhNhh$hjhhhhhjhjh jlhhuUsubstitution_namesru}rvh-h` where ^ is one of echo. html to make standalone HTML files echo. dirhtml to make HTML files named index.html in directories echo. pickle to make pickle files echo. json to make JSON files echo. htmlhelp to make HTML files and a HTML help project echo. qthelp to make HTML files and a qthelp project echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter echo. changes to make an overview over all changed/added/deprecated items echo. linkcheck to check all external links for integrity echo. doctest to run all doctests embedded in the documentation if enabled goto end ) if "%1" == "clean" ( for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i del /q /s %BUILDDIR%\* goto end ) if "%1" == "html" ( %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html echo. echo.Build finished. The HTML pages are in %BUILDDIR%/html. goto end ) if "%1" == "dirhtml" ( %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml echo. echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. goto end ) if "%1" == "pickle" ( %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle echo. echo.Build finished; now you can process the pickle files. goto end ) if "%1" == "json" ( %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json echo. echo.Build finished; now you can process the JSON files. goto end ) if "%1" == "htmlhelp" ( %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp echo. echo.Build finished; now you can run HTML Help Workshop with the ^ .hhp project file in %BUILDDIR%/htmlhelp. goto end ) if "%1" == "qthelp" ( %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: echo.^> qcollectiongenerator %BUILDDIR%\qthelp\circuits.qhcp echo.To view the help file: echo.^> assistant -collectionFile %BUILDDIR%\qthelp\circuits.ghc goto end ) if "%1" == "latex" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex echo. echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. goto end ) if "%1" == "changes" ( %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes echo. echo.The overview file is in %BUILDDIR%/changes. goto end ) if "%1" == "linkcheck" ( %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck echo. echo.Link check complete; look for any errors in the above output ^ or in %BUILDDIR%/linkcheck/output.txt. goto end ) if "%1" == "doctest" ( %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest echo. echo.Testing of doctests in the sources finished, look at the ^ results in %BUILDDIR%/doctest/output.txt. goto end ) :end circuits-2.1.0/docs/source/0000755000014400001440000000000012113366740015323 5ustar prologicuserscircuits-2.1.0/docs/source/api/0000755000014400001440000000000012113366740016074 5ustar prologicuserscircuits-2.1.0/docs/source/api/circuits_web_dispatchers_websockets.rst0000644000014400001440000000043212113343751026126 0ustar prologicusers:mod:`circuits.web.dispatchers.websockets` -- WebSockets ========================================================= .. automodule :: circuits.web.dispatchers.websockets Events ------ Components ---------- .. autoclass :: WebSockets :members: Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_web_websocket.rst0000644000014400001440000000041212113343751023350 0ustar prologicusers:mod:`circuits.web.websocket` -- WebSocket Client ================================================= .. module :: circuits.web.websocket Events ------ Components ---------- .. autoclass :: WebSocketClient :members: :undoc-members: Functions --------- circuits-2.1.0/docs/source/api/circuits_io_serial.rst0000644000014400001440000000034612072034467022506 0ustar prologicusers:mod:`circuits.io.serial` -- Serial I/O ======================================= .. module :: circuits.io.serial Events ------ **none** Components ---------- .. autoclass :: Serial :members: Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_io_file.rst0000644000014400001440000000033212072034467022141 0ustar prologicusers:mod:`circuits.io.file` -- File I/O =================================== .. module :: circuits.io.file Events ------ **none** Components ---------- .. autoclass :: File :members: Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_node_node.rst0000644000014400001440000000033612072034467022471 0ustar prologicusers:mod:`circuits.node.node` -- Node ================================= .. automodule :: circuits.node.node Events ------ **none** Components ---------- .. autoclass :: Node :members: Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_core_loader.rst0000644000014400001440000000040512072034467023012 0ustar prologicusers:mod:`circuits.core.loader` -- Loader ===================================== .. automodule :: circuits.core.loader Classes ------- **none** Components ---------- .. autoclass :: Loader :members: Events ------ **none** Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_web_servers.rst0000644000014400001440000000042412072034467023063 0ustar prologicusers:mod:`circuits.web.servers` -- Servers ====================================== .. automodule :: circuits.web.servers Events ------ **none** Components ---------- .. autoclass :: BaseServer :members: .. autoclass :: Server :members: Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_web_events.rst0000644000014400001440000000056412072034467022703 0ustar prologicusers.. _circuits_web_events: :mod:`circuits.web.events` -- Events ==================================== .. automodule :: circuits.web.events Events ------ .. autoclass :: WebEvent :members: .. autoclass :: Request :members: .. autoclass :: Response :members: .. autoclass :: Stream :members: Components ---------- **none** Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_net_protocols_http.rst0000644000014400001440000000062312072034467024467 0ustar prologicusers:mod:`circuits.net.protocols.http` -- HTTP Protocol =================================================== .. module :: circuits.net.protocols.http Events ------ .. autoclass :: circuits.net.protocols.http.Request :members: .. autoclass :: circuits.net.protocols.http.Response :members: Components ---------- .. autoclass :: circuits.net.protocols.http.HTTP :members: Functions --------- circuits-2.1.0/docs/source/api/circuits_app_config.rst0000644000014400001440000000055012072034467022642 0ustar prologicusers:mod:`circuits.app.config` -- Application Config ================================================ .. module :: circuits.app.config Events ------ .. autoclass :: circuits.app.config.Load :members: .. autoclass :: circuits.app.config.Save :members: Components ---------- .. autoclass :: circuits.app.config.Config :members: Functions --------- circuits-2.1.0/docs/source/api/circuits_web_loggers.rst0000644000014400001440000000040112072034467023027 0ustar prologicusers:mod:`circuits.web.loggers` -- Loggers ====================================== .. automodule :: circuits.web.loggers Events ------ **none** Components ---------- .. autoclass :: Logger :members: Functions --------- .. autofunction :: formattime circuits-2.1.0/docs/source/api/circuits_app_daemon.rst0000644000014400001440000000056112072034467022642 0ustar prologicusers:mod:`circuits.app.daemon` -- Application Daemon ================================================ .. module :: circuits.app.daemon Events ------ .. autoclass :: circuits.app.daemon.Daemonize :members: .. autoclass :: circuits.app.daemon.WritePID :members: Components ---------- .. autoclass :: circuits.app.daemon.Daemon :members: Functions --------- circuits-2.1.0/docs/source/api/circuits_web_dispatchers_virtualhosts.rst0000644000014400001440000000046112072034467026533 0ustar prologicusers:mod:`circuits.web.dispatchers.virtualhosts` -- Virtual Hosts ============================================================= .. automodule :: circuits.web.dispatchers.virtualhosts Events ------ **none** Components ---------- .. autoclass :: VirtualHosts :members: Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_core_timers.rst0000644000014400001440000000040512072034467023047 0ustar prologicusers:mod:`circuits.core.timers` -- Timers ===================================== .. automodule :: circuits.core.timers Classes ------- **none** Components ---------- .. autoclass :: Timer :members: Events ------ **none** Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_core.rst0000644000014400001440000000067012113343751021463 0ustar prologicusers:mod:`circuits.core` -- Core Functionality ========================================== .. automodule :: circuits.core .. toctree:: :maxdepth: 1 :glob: circuits_core_components circuits_core_events circuits_core_handlers circuits_core_manager circuits_core_values circuits_core_pollers circuits_core_timers circuits_core_loader circuits_core_utils circuits_core_workers circuits_core_debugger circuits-2.1.0/docs/source/api/circuits_core_debugger.rst0000644000014400001440000000042212072034467023327 0ustar prologicusers:mod:`circuits.core.debugger` -- Debugger ========================================= .. automodule :: circuits.core.debugger Classes ------- **none** Components ---------- .. autoclass :: Debugger :members: Events ------ **none** Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_io_events.rst0000644000014400001440000000073712072034467022537 0ustar prologicusers:mod:`circuits.io.events` -- I/O Events ======================================= .. module :: circuits.io.events Events ------ .. autoclass :: Close :members: .. autoclass :: Closed :members: .. autoclass :: EOF :members: .. autoclass :: Error :members: .. autoclass :: Opened :members: .. autoclass :: Read :members: .. autoclass :: Seek :members: .. autoclass :: Write :members: Components ---------- **none** Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_web_dispatchers_static.rst0000644000014400001440000000041312072034467025250 0ustar prologicusers:mod:`circuits.web.dispatchers.static` -- Static ================================================ .. automodule :: circuits.web.dispatchers.static Events ------ **none** Components ---------- .. autoclass :: Static :members: Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_web_sessions.rst0000644000014400001440000000036312072034467023242 0ustar prologicusers:mod:`circuits.web.sessions` -- Sessions ======================================== .. automodule :: circuits.web.sessions Events ------ **none** Components ---------- .. autoclass :: Sessions :members: Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_web_constants.rst0000644000014400001440000000021612072034467023405 0ustar prologicusers:mod:`circuits.web.constants` -- Global Constants ================================================= .. automodule :: circuits.web.constants circuits-2.1.0/docs/source/api/circuits_web_controllers.rst0000644000014400001440000000054012072034467023737 0ustar prologicusers:mod:`circuits.web.controllers` -- Controllers ============================================== .. automodule :: circuits.web.controllers Events ------ **none** Components ---------- .. autoclass :: Controller :members: .. autoclass :: JSONController :members: Functions --------- .. autofunction :: expose .. autofunction :: exposeJSON circuits-2.1.0/docs/source/api/circuits_core_events.rst0000644000014400001440000000102012113343751023035 0ustar prologicusers:mod:`circuits.core.events` -- Events ===================================== .. automodule :: circuits.core.events Classes ------- .. autoclass :: Event :members: Components ---------- **none** Events ------ .. autoclass :: Error .. autoclass :: Failure .. autoclass :: Registered .. autoclass :: Signal .. autoclass :: Started .. autoclass :: Stopped .. autoclass :: Success .. autoclass :: Unregister .. autoclass :: Unregistered .. autoclass :: GenerateEvents :members: Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_web_wsgi.rst0000644000014400001440000000043012072034467022340 0ustar prologicusers:mod:`circuits.web.wsgi` -- WSGI Support ======================================== .. automodule :: circuits.web.wsgi Events ------ **none** Components ---------- .. autoclass :: Application :members: .. autoclass :: Gateway :members: Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_node_server.rst0000644000014400001440000000035212072034467023050 0ustar prologicusers:mod:`circuits.node.server` -- Server ===================================== .. automodule :: circuits.node.server Events ------ **none** Components ---------- .. autoclass :: Server :members: Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_net_protocols.rst0000644000014400001440000000033412072034467023427 0ustar prologicusers:mod:`circuits.net.protocols` -- Networking Protocols ===================================================== .. automodule :: circuits.net.protocols .. toctree:: :maxdepth: 1 :glob: circuits_net_protocols* circuits-2.1.0/docs/source/api/index.rst0000644000014400001440000000030212072034467017732 0ustar prologicusers============= API Reference ============= .. toctree:: :maxdepth: 1 circuits_core circuits_io circuits_net circuits_node circuits_tools circuits_web circuits_app circuits-2.1.0/docs/source/api/circuits_net.rst0000644000014400001440000000024012072034467021317 0ustar prologicusers:mod:`circuits.net` -- Networking ================================= .. automodule :: circuits.net .. toctree:: :maxdepth: 1 :glob: circuits_net* circuits-2.1.0/docs/source/api/circuits_net_sockets.rst0000644000014400001440000000207312113343751023053 0ustar prologicusers:mod:`circuits.net.sockets` -- Socket Components ================================================ .. module :: circuits.net.sockets Events ------ .. autoclass :: Connect .. autoclass :: Connected .. autoclass :: Close .. autoclass :: Closed .. autoclass :: Read .. autoclass :: Write .. autoclass :: SocketError .. autoclass :: Disconnect .. autoclass :: Disconnected Components ---------- .. autoclass :: Client :members: :undoc-members: .. autoclass :: circuits.net.sockets.TCPClient :members: :undoc-members: .. autoclass :: circuits.net.sockets.UDPClient :members: :undoc-members: .. autoclass :: circuits.net.sockets.UNIXClient :members: :undoc-members: .. autoclass :: circuits.net.sockets.Server :members: :undoc-members: .. autoclass :: circuits.net.sockets.TCPServer :members: :undoc-members: .. autoclass :: circuits.net.sockets.UDPServer :members: :undoc-members: .. autoclass :: circuits.net.sockets.UNIXServer :members: :undoc-members: Functions --------- .. autofunction :: circuits.net.sockets.Pipe circuits-2.1.0/docs/source/api/circuits_web_headers.rst0000644000014400001440000000063412072034467023010 0ustar prologicusers:mod:`circuits.web.headers` -- Headers ====================================== .. automodule :: circuits.web.headers Events ------ **none** Classes ------- .. autoclass :: Headers :members: .. autoclass :: HeaderElement :members: .. autoclass :: AcceptElement :members: Components ---------- **none** Functions --------- .. autofunction :: header_elements .. autofunction :: parse_headers circuits-2.1.0/docs/source/api/circuits_app_env.rst0000644000014400001440000000054712072034467022173 0ustar prologicusers:mod:`circuits.app.env` -- Application Environment ================================================== .. module :: circuits.app.env Events ------ .. autoclass :: circuits.app.env.Create :members: .. autoclass :: circuits.app.env.Load :members: Components ---------- .. autoclass :: circuits.app.env.Environment :members: Functions --------- circuits-2.1.0/docs/source/api/circuits_app_log.rst0000644000014400001440000000044312072034467022157 0ustar prologicusers:mod:`circuits.app.log` -- Application Logging ============================================== .. module :: circuits.app.log Events ------ .. autoclass :: circuits.app.log.Log :members: Components ---------- .. autoclass :: circuits.app.log.Logger :members: Functions --------- circuits-2.1.0/docs/source/api/circuits_node_client.rst0000644000014400001440000000035212072034467023020 0ustar prologicusers:mod:`circuits.node.client` -- Client ===================================== .. automodule :: circuits.node.client Events ------ **none** Components ---------- .. autoclass :: Client :members: Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_io_notify.rst0000644000014400001440000000104112072034467022530 0ustar prologicusers:mod:`circuits.io.notify` -- File System Notification ===================================================== .. module :: circuits.io.notify Events ------ .. autoclass :: Accessed :members: .. autoclass :: Closed :members: .. autoclass :: Created :members: .. autoclass :: Deleted :members: .. autoclass :: Modified :members: .. autoclass :: Moved :members: .. autoclass :: Opened :members: .. autoclass :: Unmounted :members: Components ---------- .. autoclass :: Notify :members: Functions --------- circuits-2.1.0/docs/source/api/circuits_core_pollers.rst0000644000014400001440000000060312072034467023224 0ustar prologicusers:mod:`circuits.core.pollers` -- I/O Pollers =========================================== .. automodule :: circuits.core.pollers Classes ------- **none** Components ---------- .. autoclass :: BasePoller :members: .. autoclass :: Select :members: .. autoclass :: Poll :members: .. autoclass :: EPoll :members: Events ------ **none** Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_web_dispatchers_jsonrpc.rst0000644000014400001440000000045012072034467025440 0ustar prologicusers:mod:`circuits.web.dispatchers.jsonrpc` -- JSON-RPC =================================================== .. automodule :: circuits.web.dispatchers.jsonrpc Events ------ .. autoclass :: RPC :members: Components ---------- .. autoclass :: JSONRPC :members: Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_core_utils.rst0000644000014400001440000000062012072034467022703 0ustar prologicusers:mod:`circuits.core.utils` -- Utilities ======================================= .. automodule :: circuits.core.utils Classes ------- **none** Components ---------- **none** Events ------ **none** Functions --------- .. autofunction :: findchannel .. autofunction :: findcmp .. autofunction :: findroot .. autofunction :: findtype .. autofunction :: flatten .. autofunction :: safeimport circuits-2.1.0/docs/source/api/circuits_node.rst0000644000014400001440000000023012072034467021455 0ustar prologicusers:mod:`circuits.node` -- Node ============================ .. automodule :: circuits.node .. toctree:: :maxdepth: 1 :glob: circuits_node* circuits-2.1.0/docs/source/api/circuits_core_workers.rst0000644000014400001440000000044312072034467023242 0ustar prologicusers:mod:`circuits.core.workers` -- Workers ======================================= .. automodule :: circuits.core.workers Classes ------- **none** Components ---------- .. autoclass :: Worker :members: Events ------ .. autoclass :: Task :members: Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_web_utils.rst0000644000014400001440000000055412072034467022536 0ustar prologicusers:mod:`circuits.web.utils` -- Utilities ====================================== .. automodule :: circuits.web.utils Events ------ **none** Components ---------- **none** Functions --------- .. autofunction :: compress .. autofunction :: dictform .. autofunction :: get_ranges .. autofunction :: parse_body .. autofunction :: parse_qs .. autofunction :: url circuits-2.1.0/docs/source/api/circuits_net_protocols_irc.rst0000644000014400001440000000050412072034467024263 0ustar prologicusers:mod:`circuits.net.protocols.irc` -- IRC Protocol ================================================= .. module :: circuits.net.protocols.irc Events ------ .. autoclass :: circuits.net.protocols.irc.RAW :members: Components ---------- .. autoclass :: circuits.net.protocols.irc.IRC :members: Functions --------- circuits-2.1.0/docs/source/api/circuits_web_exceptions.rst0000644000014400001440000000165212072034467023557 0ustar prologicusers:mod:`circuits.web.exceptions` -- Exceptions ============================================ .. automodule :: circuits.web.exceptions Exceptions ---------- .. autoexception :: HTTPException .. autoexception :: BadGateway .. autoexception :: BadRequest .. autoexception :: Forbidden .. autoexception :: Gone .. autoexception :: InternalServerError .. autoexception :: LengthRequired .. autoexception :: MethodNotAllowed .. autoexception :: NotAcceptable .. autoexception :: NotFound .. autoexception :: NotImplemented .. autoexception :: PreconditionFailed .. autoexception :: Redirect .. autoexception :: RequestEntityTooLarge .. autoexception :: RequestTimeout .. autoexception :: RequestURITooLarge .. autoexception :: ServiceUnavailable .. autoexception :: Unauthorized .. autoexception :: UnicodeError .. autoexception :: UnsupportedMediaType Events ------ **none** Components ---------- **none** Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_core_manager.rst0000644000014400001440000000041412072034467023156 0ustar prologicusers:mod:`circuits.core.manager` -- Manager ======================================= .. automodule :: circuits.core.manager Classes ------- .. autoclass :: Manager :members: Components ---------- **none** Events ------ **none** Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_web_http.rst0000644000014400001440000000053112072034467022350 0ustar prologicusers.. _circuits_web_http: :mod:`circuits.web.http` -- HTTP Protocol ========================================= .. automodule :: circuits.web.http Components ---------- .. autoclass :: HTTP :members: :private-members: Events ------ See :class:`circuits.web.events.Request` in :ref:`circuits_web_events`. Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_node_utils.rst0000644000014400001440000000051312072034467022701 0ustar prologicusers:mod:`circuits.node.utils` -- Node Utilities ============================================ .. automodule :: circuits.node.utils Events ------ **none** Components ---------- **none** Functions --------- .. autofunction :: dump_event .. autofunction :: dump_value .. autofunction :: load_event .. autofunction :: load_value circuits-2.1.0/docs/source/api/circuits_core_components.rst0000644000014400001440000000063612072034467023737 0ustar prologicusers:mod:`circuits.core.components` -- Components ============================================= .. automodule :: circuits.core.components Classes ------- .. autoclass :: BaseComponent :members: .. autoclass :: Component :members: Components ---------- **none** Events ------ .. autoclass :: PrepareUnregister :members: .. autoclass :: SingletonError :members: Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_io.rst0000644000014400001440000000023612072034467021145 0ustar prologicusers:mod:`circuits.io` -- I/O Support ================================= .. automodule :: circuits.io .. toctree:: :maxdepth: 1 :glob: circuits_io* circuits-2.1.0/docs/source/api/circuits_core_values.rst0000644000014400001440000000037012072034467023044 0ustar prologicusers:mod:`circuits.core.values` -- Value ==================================== .. automodule :: circuits.core.values Classes ------- .. autoclass :: Value Components ---------- **none** Events ------ **none** Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_app.rst0000644000014400001440000000026212072034467021315 0ustar prologicusers:mod:`circuits.app` -- Application Support ========================================== .. automodule :: circuits.app .. toctree:: :maxdepth: 1 :glob: circuits_app* circuits-2.1.0/docs/source/api/circuits_tools.rst0000644000014400001440000000051012113343751021664 0ustar prologicusers:mod:`circuits.tools` -- Development Tools ========================================== .. module :: circuits.tools Often you will end up needing to do some debugging or inspection of your system. The `circuits.tools` package provides a set of development tools for debugging, inspection and analysis. .. autofunction :: graph circuits-2.1.0/docs/source/api/circuits_web_main.rst0000644000014400001440000000034512072034467022320 0ustar prologicusers:mod:`circuits.web.main` -- circuits.web ======================================== .. automodule :: circuits.web.main Shipped application with static and directory index support suitable for quickly serving up simple web pages. circuits-2.1.0/docs/source/api/circuits_web.rst0000644000014400001440000000024712072034467021315 0ustar prologicusers:mod:`circuits.web` -- Web Framework ==================================== .. automodule :: circuits.web .. toctree:: :maxdepth: 1 :glob: circuits_web_* circuits-2.1.0/docs/source/api/circuits_net_protocols_line.rst0000644000014400001440000000042312072034467024435 0ustar prologicusers:mod:`circuits.net.protocols.line` -- Line Protocol =================================================== .. module :: circuits.net.protocols.line Events ------ .. autoclass :: Line :members: Components ---------- .. autoclass :: LP :members: Functions --------- circuits-2.1.0/docs/source/api/circuits_web_errors.rst0000644000014400001440000000061312072034467022706 0ustar prologicusers:mod:`circuits.web.errors` -- Errors ==================================== .. automodule :: circuits.web.errors Components ---------- **none** Events ------ .. autoclass :: HTTPError :members: .. autoclass :: Forbidden :members: .. autoclass :: NotFound :members: .. autoclass :: Redirect :members: .. autoclass :: Unauthorized :members: Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_node_events.rst0000644000014400001440000000041712072034467023050 0ustar prologicusers:mod:`circuits.node.events` -- Events ===================================== .. automodule :: circuits.node.events Events ------ .. autoclass :: Packet :members: .. autoclass :: Remote :members: Components ---------- **none** Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_core_handlers.rst0000644000014400001440000000051312113343751023337 0ustar prologicusers:mod:`circuits.core.handlers` -- Handlers ========================================= .. automodule :: circuits.core.handlers Classes ------- .. autoclass :: HandlerMetaClass :members: Components ---------- **none** Events ------ **none** Functions --------- .. autofunction :: handler .. autofunction :: reprhandler circuits-2.1.0/docs/source/api/circuits_web_client.rst0000644000014400001440000000041212072034467022645 0ustar prologicusers:mod:`circuits.web.client` -- Client ==================================== .. module :: circuits.web.client Events ------ .. autoclass :: Request :members: Components ---------- .. autoclass :: Client :members: :undoc-members: Functions --------- circuits-2.1.0/docs/source/api/circuits_web_wrappers.rst0000644000014400001440000000066012072034467023237 0ustar prologicusers:mod:`circuits.web.wrappers` -- Request/Response Objects ======================================================== .. module :: circuits.web.wrappers Events ------ **none** Classes ------- .. autoclass :: Body :members: .. autoclass :: Host :members: .. autoclass :: Request :members: .. autoclass :: Response :members: Components ---------- **none** Functions --------- .. autofunction :: file_generator circuits-2.1.0/docs/source/api/circuits_web_tools.rst0000644000014400001440000000072112072034467022532 0ustar prologicusers:mod:`circuits.web.tools` -- Tools ================================== .. automodule :: circuits.web.tools Events ------ **none** Components ---------- **none** Functions --------- .. autofunction :: basic_auth .. autofunction :: check_auth .. autofunction :: digest_auth .. autofunction :: expires .. autofunction :: gzip .. autofunction :: serve_download .. autofunction :: serve_file .. autofunction :: validate_etags .. autofunction :: validate_since circuits-2.1.0/docs/source/api/circuits_web_dispatchers_xmlrpc.rst0000644000014400001440000000044512072034467025273 0ustar prologicusers:mod:`circuits.web.dispatchers.xmlrpc` -- XML-RPC ================================================= .. automodule :: circuits.web.dispatchers.xmlrpc Events ------ .. autoclass :: RPC :members: Components ---------- .. autoclass :: XMLRPC :members: Functions --------- **none** circuits-2.1.0/docs/source/api/circuits_web_dispatchers_dispatcher.rst0000644000014400001440000000045412072034467026114 0ustar prologicusers:mod:`circuits.web.dispatchers.dispatcher` -- Default Dispatcher ================================================================ .. module :: circuits.web.dispatchers.dispatcher Events ------ **none** Components ---------- .. autoclass :: Dispatcher :members: Functions --------- **none** circuits-2.1.0/docs/source/dev/0000755000014400001440000000000012113366740016101 5ustar prologicuserscircuits-2.1.0/docs/source/dev/contributing.rst0000644000014400001440000000315112113343751021337 0ustar prologicusersContributing to circuits ======================== Here's how you can contribute to circuits Share your story ---------------- One of the best ways you can contribute to circuits is by using circuits. Share with us your story of how you've used circuits to solve a problem or create a new software solution using the circuits framework and library of components. See our :doc:`Users Page `. Submitting Bug Reports ---------------------- We welcome all bug reports. We do however prefer bug reports in a clear and concise form with repeatable steps. One of the best ways you can report a bug to us is by writing a unit test (//similar to the ones in our tests//) so that we can verify the bug, fix it and commit the fix along with the test. To submit a bug report, please use: http://bitbucket.org/prologic/circuits/issues Writing new tests ----------------- We're not perfect, and we're still writing more tests to ensure quality code. If you'd like to help, please `Fork circuits-dev `_, write more tests that cover more of our code base and submit a `Pull Request `_. Many Thanks! Adding New Features ------------------- If you'd like to see a new feature added to circutis, then we'd like to hear about it~ We would like to see some discussion around any new features as well as valid use-cases. To start the discussions off, please either: - `Chat to us on #circuits on the FreeNode IRC Network `_ or - `Submit a NEW Issue `_ circuits-2.1.0/docs/source/dev/introduction.rst0000644000014400001440000000131212113343751021346 0ustar prologicusersDevelopment Introduction ======================== Here's how we do things in circuits... Standards --------- We use the following coding standard: - `pep8 `_ Tools ----- We use the following tools to develop circuits and share code: - **Code Sharing:** `Mercurial `_ - **Code Hosting and Bug Reporting:** `BitBucket `_ - **Project Management:** `Pivotal Tracker `_ - **Documentation Hosting:** `Read the Docs `_ - **Package Hosting:** `Python Package Index (PyPi) `_ circuits-2.1.0/docs/source/dev/index.rst0000644000014400001440000000051312113343751017736 0ustar prologicusersDeveloper Docs ============== So, you'd like to contribute to circuits in some way? Got a bug report? Having problems running the examples? Having problems getting circuits working in your environment/platform? Excellent. Here's what you need to know. .. toctree:: :maxdepth: 2 introduction contributing processes circuits-2.1.0/docs/source/dev/processes.rst0000644000014400001440000000356312113343751020645 0ustar prologicusers.. _Pivotal Tracker: http://pivotaltracker.com/projects/695621 Development Processes ===================== We document all our internal development processes here so you know exactly how we work and what to expect. If you find any issues or problems please let us know! Software Development Life Cycle (SDLC) -------------------------------------- We employ the use of the `SCRUM Agile Process `_ and use `Pivotal Tracker`_ to track our stories, bugs, chores and releases. If you wish to contribute to circuits, please famiilarize yourself with SCRUM and Pivotal Tracker. Bug Reports ----------- - New Bug Reports are submitted via: http://bitbucket.org/prologic/circuits/issues - Confirmation and Discussion of all New Bug Reports. - Once confirmed, a new Bug is raised in `Pivotal Tracker`_ into the IceBox. Feature Requests ---------------- - New Feature Requests are submitted via: http://bitbucket.org/prologic/circuits/issues - Confirmation and Discussion of all New Feature Requests. - Once confirmed, a new Feature is raised in `Pivotal Tracker`_ into the IceBox. Writing new Code ---------------- - Write your code. - Use `flake8 `_ to ensure code quality. - Run the tests:: $ tox - Ensure any new or modified code does not break existing unit tests. - Updated any relevant docstrings or documentatino. Running the Tests ----------------- To run the tests you will need the following installed: - `tox `_ instaleld as well as - `pytest-cov `_ - `pytest `_ All of these can be instaleld via ``easy_isntall`` or ``pip``. Please also ensure that you you have all supported versions of Python that circuits supports installed in your local environment. To run the tests:: $ tox circuits-2.1.0/docs/source/man/0000755000014400001440000000000012113366740016076 5ustar prologicuserscircuits-2.1.0/docs/source/man/tools.rst0000644000014400001440000000005512113343751017765 0ustar prologicusersTools ===== .. todo:: Write about this ... circuits-2.1.0/docs/source/man/values.rst0000644000014400001440000000005612113343751020125 0ustar prologicusersValues ====== .. todo:: Write about this... circuits-2.1.0/docs/source/man/manager.rst0000644000014400001440000000006012113343751020233 0ustar prologicusersManager ======= .. todo:: Write about this... circuits-2.1.0/docs/source/man/index.rst0000644000014400001440000000031612113343751017734 0ustar prologicusers====================== The circuits Framework ====================== .. toctree:: :maxdepth: 2 components events handlers .. toctree:: :hidden: values debugging tools manager circuits-2.1.0/docs/source/man/debugging.rst0000644000014400001440000000006512113343751020561 0ustar prologicusersDebugging ========= .. todo:: Write about this ... circuits-2.1.0/docs/source/man/components.rst0000644000014400001440000000264612072034467021027 0ustar prologicusersComponents ========== The architectural concept of circuits is to encapsulate system functionality into discrete manageable and reusable units, called *Components*, that interact by sending and handling events that flow throughout the system. Technically, a circuits *Component* is a Python class that inherits (directly or indirectly) from :class:`~circuits.core.components.BaseComponent`. Components can be sub-classed like any other normal Python class, however components can also be composed of other components and it is natural to do so. These are called *Complex Components*. An example of a Complex Component within the circuits library is the :class:`circuits.web.servers.Server` Component which is comprised of: - :class:`circuits.net.sockets.TCPServer` - :class:`circuits.web.servers.BaseServer` - :class:`circuits.web.http.HTTP` - :class:`circuits.web.dispatchers.dispatcher.Dispatcher` Note that there is no class or other technical means to mark a component as a complex component. Rather, all component instances in a circuits based application belong to some component tree (there may be several), with Complex Components being a subtree within that structure. A Component is attached to the tree by registering with the parent and detached by un-registering itself (methods :meth:`~circuits.core.components.BaseComponent.register` and :meth:`~circuits.core.components.BaseComponent.unregister` of ``BaseComponent``).circuits-2.1.0/docs/source/man/examples/0000755000014400001440000000000012113366740017714 5ustar prologicuserscircuits-2.1.0/docs/source/man/examples/handler_annotation.py0000644000014400001440000000066212072034467024143 0ustar prologicusers#!/usr/bin/env python from circuits.core.debugger import Debugger from circuits.core.components import BaseComponent from circuits.core.handlers import handler class MyComponent(BaseComponent): def __init__(self): super(MyComponent, self).__init__() Debugger().register(self) @handler("started", channel="*") def _on_started(self, component): print "Start event detected" MyComponent().run() circuits-2.1.0/docs/source/man/examples/handler_returns.py0000644000014400001440000000142012072034467023464 0ustar prologicusers#!/usr/bin/env python from circuits import Component, Event from circuits.core.debugger import Debugger class Identify(Event): """Identify Event""" success = True class Pound(Component): def __init__(self): super(Pound, self).__init__() Debugger().register(self) Bob().register(self) Fred().register(self) def started(self, *args): self.fire(Identify()) def identify_success(self, evt, result): if not isinstance(result, list): result = [result] print "In pound:" for name in result: print name class Dog(Component): def identify(self): return self.__class__.__name__ class Bob(Dog): """Bob""" class Fred(Dog): """Fred""" Pound().run() circuits-2.1.0/docs/source/man/handlers.rst0000644000014400001440000000530012113343751020423 0ustar prologicusersHandlers ======== Explicit Event Handlers ----------------------- Event Handlers are methods of components that are invoked when a matching event is dispatched. These can be declared explicitly on a :class:`~circuits.core.components.BaseComponent` or :class:`~circuits.core.components.Component` or by using the :func:`~circuits.core.handlers.handler` decorator. .. literalinclude:: examples/handler_annotation.py :language: python :linenos: :download:`Download handler_annotation.py ` The handler decorator on line 14 turned the method ``_on_started`` into an event handler for the event ``Started``. Event names used to define handlers are the uncameled class names of the event. An event with a class name ``MySpecialEvent`` becomes "``my_special_event``" when referred to in a handler definition. When defining explicit event handlers in this way, it's convention to use the following pattern:: @handler("foo") def _on_foo(self, ...): ... This makes reading code clear and concise and obvious to the reader that the method is not part of the class's public API (*leading underscore as per Python convention*) and that it is invoked for events of type ``SomeEvent``. The optional keyword argument "``channel``" can be used to attach the handler to a different channel than the component's channel (*as specified by the component's channel attribute*). Handler methods must be declared with arguments and keyword arguments that match the arguments passed to the event upon its creation. Looking at the API for :class:`~circuits.core.events.Started` you'll find that the component that has been started is passed as an argument to its constructor. Therefore, our handler method must declare one argument (*Line 15*). The ``@handler(...)`` decorator accepts other keyword arguments that influence the behavior of the event handler and its invocation. Details can be found in the API description of :func:`~circuits.core.handlers.handler`. Implicit Event Handlers ----------------------- To make things easier for the developer when creating many event handlers and thus save on some typing, the :class:`~circuits.core.components.Component` can be used and subclassed instead which provides an implicit mechanism for creating event handlers. Basically every method in the component is automatically and implicitly marked as an event handler with ``@handler(>`` is the name of each method applied. The only exceptions are: - Methods are start with an underscore ``_``. - Methods already marked explicitly with the ``@handler(...)`` decorator. .. note:: You can specify that a method not be an event handler by marking it with ``@handler(False)``. circuits-2.1.0/docs/source/man/events.rst0000644000014400001440000001006212072034467020135 0ustar prologicusersEvents ====== Basic usage ----------- Events are objects that are fired by the circuits framework implicitly (like the :class:`~circuits.core.events.Started` event used in the tutorial) or explicitly by components while handling some other event. Once fired, events are dispatched to the components that are interested in these events, i.e. that have registered themselves as handlers for these events. Events are usually fired on one or more channels, allowing components to gather in "interest groups". This is especially useful if you want to reuse basic components such as a TCP server. A TCP server component fires a ``Read`` event for every package of data that it receives. If we hadn't the channels, it would be very difficult to separate the data from two different TCP connections. But using the channels, we can put one TCP server and all components interested in its events on one channel, and another TCP server and the components interested in this other TCP server's events on another channel. Components are associated with a channel by setting their ``channel`` attribute (see API description for :class:`~.components.Component`). Besides having a name, events carry additional arbitrary information. This information is passed as arguments or keyword arguments to the constructor. It is then delivered to the handler function that must have exactly the same number of arguments and keyword arguments. Of course, as is usual in Python, you can also pass additional information by setting attributes of the event object, though this usage pattern is discouraged for events. Events as result collectors --------------------------- Apart from delivering information to handlers, event objects may also collect information. If a handler returns something that is not ``None``, it is stored in the event's ``value`` attribute. If a second (or any subsequent) handler invocation also returns a value, the values are stored as a list. Note that the value attribute is of type :class:`~.values.Value` and you must access its property ``value`` to access the data stored (``collected_information = event.value.value``). The collected information can be accessed by handlers in order to find out about any return values from the previously invoked handlers. More useful though, is the possibility to access the information after all handlers have been invoked. After all handlers have run successfully (i.e. no handler has thrown an error) circuits may generate an event that indicates the successful handling. This event has the name of the event just handled with "Success" appended. So if the event is called ``Identify`` then the success event is called ``IdentifySuccess``. Success events aren't delivered by default. If you want successful handling to be indicated for an event, you have to set the optional attribute ``success`` of this event to ``True``. The handler for a success event must be defined with two arguments. When invoked, the first argument is the event just having been handled successfully and the second argument is (as a convenience) what has been collected in ``event.value.value`` (note that the first argument may not be called ``event``, for an explanation of this restriction as well as for an explanation why the method is called ``identify_success`` see the section on handlers). .. literalinclude:: examples/handler_returns.py :language: python :linenos: :download:`Download handler_returns.py ` Advanced usage -------------- Sometimes it may be necessary to take some action when all state changes triggered by an event are in effect. In this case it is not sufficient to wait for the completion of all handlers for this particular event. Rather, we also have to wait until all events that have been fired by those handlers have been processed (and again wait for the events fired by those events' handlers, and so on). To support this scenario, circuits can fire a ``Complete`` event. The usage is similar to the previously described success event. Details can be found in the API description of :class:`circuits.core.events.Event`. circuits-2.1.0/docs/source/web/0000755000014400001440000000000012113366740016100 5ustar prologicuserscircuits-2.1.0/docs/source/web/introduction.rst0000644000014400001440000000727012072034467021363 0ustar prologicusersIntroduction ============ circuits.web is a set of components for building high performance HTTP/1.1 and WSGI/1.0 compliant web applications. These components make it easy to rapidly develop rich, scalable web applications with minimal effort. circuits.web borrows from * `CherryPy `_ * BaseHTTPServer (*Python std. lib*) * wsgiref (*Python std. lib*) Overview -------- The ``circuits.web`` namespace contains the following exported components and events for convenience: Events ~~~~~~ +---------------+-----------------------------------+ | Event | Description | +===============+===================================+ | Request | The Request Event | +---------------+-----------------------------------+ | Response | The Response Event | +---------------+-----------------------------------+ | Stream | The Stream Event | +---------------+-----------------------------------+ Servers ~~~~~~~ +---------------+-----------------------------------+ | Server | Description | +===============+===================================+ | BaseServer | The Base Server (no Dispatcher) | +---------------+-----------------------------------+ | Server | The **full** Server + Dispatcher | +---------------+-----------------------------------+ Error Events ~~~~~~~~~~~~ +---------------+-----------------------------------+ | Error | Description | +===============+===================================+ | HTTPError | A generic HTTP Error Event | +---------------+-----------------------------------+ | Forbidden | A Forbidden (403) Event | +---------------+-----------------------------------+ | NotFound | A Not Found (404) Event | +---------------+-----------------------------------+ | Redirect | A Redirect (30x) Event | +---------------+-----------------------------------+ Dispatchers ~~~~~~~~~~~ +---------------+-----------------------------------+ | Dispatcher | Description | +===============+===================================+ | Static | A Static File Dispatcher | +---------------+-----------------------------------+ | Dispatcher | The Default Dispatcher | +---------------+-----------------------------------+ | VirtualHosts | Virtual Hosts Dispatcher | +---------------+-----------------------------------+ | XMLRPC | XML-RPC Dispatcher | +---------------+-----------------------------------+ | JSONRPC | JSON-RPC Dispatcher | +---------------+-----------------------------------+ Other Components ~~~~~~~~~~~~~~~~ +---------------+-----------------------------------+ | Component | Description | +===============+===================================+ | Logger | Default Logger | +---------------+-----------------------------------+ | Controller | Request Handler Mapper | +---------------+-----------------------------------+ | Sessions | Default Sessions Handler | +---------------+-----------------------------------+ To start working with circuits.web one normally only needs to import from circuits.web, for example: .. code-block:: python :linenos: from circuits import Component from circuits.web import BaseServer class Root(Component): def request(self, request, response): return "Hello World!" (BaseServer(8000) + Root()).run() For further information regarding any of circuits.web's components, events or other modules and functions refer to the API Documentation. circuits-2.1.0/docs/source/web/index.rst0000644000014400001440000000023412113343751017735 0ustar prologicusers========================== The circuits.web Framework ========================== .. toctree:: :maxdepth: 1 introduction gettingstarted basics circuits-2.1.0/docs/source/web/basics.rst0000644000014400001440000000447212072034467020107 0ustar prologicusersThe Basics ========== circuits.web is not a **full stack** web framework, rather it is more closely aligned with `CherryPy `_ and offers enough functionality to make quickly developing web applications easy and as flexible as possible. circuits.web does not provide features such as: * builtin Templating * builtin Database or ORM tools * **etc** The functionality that circutis.web *does* provide ensures that circuits.web is fully HTTP/1.1 and WSGI/1.0 compliant and offers all the essential tools you need to build your web application or website. A Stand Alone Server -------------------- A stand alone server consist of the components shown in section :ref:`web_getting_started`. The process of handling an HTTP request starts with the :class:`~circuits.net.sockets.TCPServer` receiving a chunk of bytes. It emits those bytes as a :class:`~circuits.net.sockets.Read` event on the channel shared by the Server, HTTP, TCPServer and Dispatcher components ("web" by default). The Read events are handled by the :class:`~circuits.web.http.HTTP` component. It collects the chunks until a complete HTTP request has been received. The request is then emitted as a :class:`~circuits.web.events.Request` event with an instance of classes :class:`~circuits.web.wrappers.Request` and :class:`~circuits.web.wrappers.Response` each as arguments. To complete the client's request, a :class:`~circuits.web.events.Response` event must be fired. This is usually done by the HTTP component itself upon the receipt of a ``RequestSuccess`` event (automatically generated after all handlers for the ``Request`` event have been invoked successfully). In case of a problem, the ``Request`` event's handlers should fire or return a :class:`~circuits.web.errors.HTTPError` which is instead converted by the HTTP component to a ``Response`` event. HTTP's handler for the :class:`~circuits.web.events.Response` event retrieves the response information from the event and encodes it as required by HTTP (the protocol). It then fires one or more :class:`~circuits.net.sockets.Write` events which are handled by the TCPServer (and the response is thus sent to the client). More details can be found in :ref:`circuits_web_http`. A commonly used component for handling :class:`~circuits.web.events.Request` events is a dispatcher. [To be continued]circuits-2.1.0/docs/source/web/gettingstarted.rst0000644000014400001440000000312412072034467021664 0ustar prologicusers.. _web_getting_started: Getting Started =============== Just like any application or system built with circuits, a circuits.web application follows the standard Component based design and structure whereby functionality is encapsulated in components. circuits.web itself is designed and built in this fashion. For example a circuits.web Server's structure looks like this: .. image:: ../images/web.png To illustrate the basic steps, we will demonstrate developing your classical "Hello World!" applications in a web-based way with circuits.web To get started, we first import the necessary components: .. code-block:: python from circutis.web import Server, Controller Next we define our first Controller with a single Request Handler defined as our index. We simply return "Hello World!" as the response for our Request Handler. .. code-block:: python class Root(Controller): def index(self): return "Hello World!" This completes our simple web application which will respond with "Hello World!" when anyone accesses it. *Admittedly this is a stupidly simple web application! But circuits.web is very powerful and plays nice with other tools.* Now we need to run the application: .. code-block:: python (Server(8000) + Root()).run() That's it! Navigate to: http://127.0.0.1:8000/ and see the result. Here's the complete code: .. code-block:: python :linenos: from circuits.web import Server, Controller class Root(Controller): def index(self): return "Hello World!" (Server(8000) + Root()).run() Have fun! circuits-2.1.0/docs/source/conf.py0000644000014400001440000001633312113366104016622 0ustar prologicusers# -*- coding: utf-8 -*- # # circuits documentation build configuration file, created by # sphinx-quickstart on Thu Feb 4 09:44:50 2010. # # This file is execfile()d with the current directory set to its containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys, os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0, os.path.abspath('../..')) # -- General configuration ----------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [] bitbucket_project_url = 'https://bitbucket.org/prologic/circuits' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8' # The master toctree document. master_doc = 'index' # General information about the project. project = u'circuits' copyright = u'2004-2012, James Mills' url = "http://bitbucket.org/prologic/circuits/" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = '2.1.0' # The full version, including alpha/beta/rc tags. release = '2.1.0' # Devel or Release mode for the documentation (if devel, include TODOs, # can also be used in conditionals: .. ifconfig :: devel) devel = False if devel: release += "dev" # -- Autodoc extensions.append('sphinx.ext.autodoc') autodoc_default_flags = ['show-inheritance'] autoclass_content = 'both' autodoc_member_order = 'bysource' # -- AutoSummary extensions.append('sphinx.ext.autosummary') # -- Graphviz extensions.append('sphinx.ext.graphviz') # -- Conditional content (see setup() below) extensions.append('sphinx.ext.ifconfig') # -- Keep track of :todo: items extensions.append('sphinx.ext.todo') todo_include_todos = devel # -- link to bitbucket issues extensions.append('sphinxcontrib.bitbucket') # -- track statistics with google analytics extensions.append("sphinxcontrib.googleanalytics") googleanalytics_id = "UA-38618352-3" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. today_fmt = '%B %d, %Y' # List of documents that shouldn't be included in the build. #unused_docs = [] # List of directories, relative to source directory, that shouldn't be searched # for source files. exclude_trees = [] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'trac' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # -- Options for HTML output --------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. html_theme = 'om' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. html_theme_path = ["_themes"] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. html_logo = "_static/logo.png" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_use_modindex = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = '' # Output file base name for HTML help builder. htmlhelp_basename = 'circuitsdoc' # -- Options for LaTeX output -------------------------------------------------- # The paper size ('letter' or 'a4'). #latex_paper_size = 'letter' # The font size ('10pt', '11pt' or '12pt'). #latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'circuits.tex', u'circuits Documentation', u'James Mills', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # Additional stuff for the LaTeX preamble. #latex_preamble = '' # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_use_modindex = True def setup(app): # ifconfig variables app.add_config_value('devel', '', True) # flake8: noqa circuits-2.1.0/docs/source/pypitest.rst0000644000014400001440000000020712072034467017737 0ustar prologicusersPyPi Test Page - Tentative Release ================================== .. include:: ../../README.rst .. include:: ../../RELEASE.rst circuits-2.1.0/docs/source/start/0000755000014400001440000000000012113366740016460 5ustar prologicuserscircuits-2.1.0/docs/source/start/quick.rst0000644000014400001440000000120112113343751020315 0ustar prologicusers.. _pip: http://pypi.python.org/pypi/pip Quick Start Guide ================= The easiest way to download and install circuits is to use the `pip`_ command: .. code-block:: sh $ pip install circuits Now that you have successfully downloaded and installed circuits, let's test that circuits is properly installed and working. First, let's check the installed version: .. code-block:: python >>> import circuits >>> print circuits.__version__ 2.1.0 Try some of the examples in the examples/ directory shipped with the distribution or check out some :doc:`Applications using circuits <../users>` Have fun :) circuits-2.1.0/docs/source/start/downloading.rst0000644000014400001440000000124412113343751021515 0ustar prologicusersDownloading =========== Latest Stable Release --------------------- The latest stable releases can be downloaded from the `Downloads `_ page (*specifically the Tags tab*). Latest Development Source Code ------------------------------ We use `Mercurial `_ for source control and code sharing. The latest development branch can be cloned using the following command: .. code-block:: sh $ hg clone https://bitbucket.org/prologic/circuits/ For further instructions on how to use Mercurial, please refer to the `Mercurial Book `_. circuits-2.1.0/docs/source/start/requirements.rst0000644000014400001440000000140312113343751021730 0ustar prologicusers.. _Python Standard Library: http://docs.python.org/library/ Requirements and Dependencies ============================= - circuits has no **required** dependencies beyond the `Python Standard Library`_. - Python: >= 2.6 or pypy >= 2.0 :Supported Platforms: Linux, FreeBSD, Mac OS X, Windows :Supported Python Versions: 2.6, 2.7, 3.2, 3.3 :Supported pypy Versions: 2.0 Other Optional Dependencies --------------------------- These dependencies are not strictly required and only add additional features. - `pydot `_ -- For rendering component graphs of an application. - `pyinotify `_ -- For asynchronous file system event notifications and the :mod:`circuits.io.notify` module. circuits-2.1.0/docs/source/start/index.rst0000644000014400001440000000016512072034467020325 0ustar prologicusersGetting Started =============== .. toctree:: :maxdepth: 2 quick downloading installing requirements circuits-2.1.0/docs/source/start/installing.rst0000644000014400001440000000173412113343751021360 0ustar prologicusersInstalling ========== Installing from a Source Package -------------------------------- *If you have downloaded a source archive, this applies to you.* .. code-block:: sh $ python setup.py install For other installation options see: .. code-block:: sh $ python setup.py --help install Installing from the Development Repository ------------------------------------------ *If you have cloned the source code repository, this applies to you.* If you have cloned the development repository, it is recommended that you use setuptools and use the following command: .. code-block:: sh $ python setup.py develop This will allow you to regularly update your copy of the circuits development repository by simply performing the following in the circuits working directory: .. code-block:: sh $ hg pull -u .. note:: You do not need to reinstall if you have installed with setuptools via the circuits repository and used setuptools to install in "develop" mode. circuits-2.1.0/docs/source/contributors.rst0000644000014400001440000000101512072034467020611 0ustar prologicusersContributors ============ circuits was originally designed, written and primarily maintained by James Mills (http://prologic.shortcircuit.net.au/). The following users and developers have contributed to circuits: - Alessio Deiana - Dariusz Suchojad - Tim Miller - Holger Krekel - Justin Giorgi - Edwin Marshall - Alex Mayfield - Toni Alatalo - Michael Lipp Anyone not listed here (*apologies as this list is taken directly from Mercurial's churn command and output*). We appreciate any and all contributions to circuits. circuits-2.1.0/docs/source/faq.rst0000644000014400001440000000373512113343751016631 0ustar prologicusers.. _#circuits IRC Channel: http://webchat.freenode.net/?randomnick=1&channels=circuits&uio=d4 .. _Mailing List: http://groups.google.com/group/circuits-users .. faq: Frequently Asked Questions ========================== .. general: General ------- ... What is circuits? circuits is an event-driven framework with a high focus on Component architectures making your life as a software developer much easier. circuits allows you to write maintainable and scalable systems easily ... Can I write networking applications with circuits? Yes absolutely. circuits comes with socket I/O components for tcp, udp and unix sockets with asynchronous polling implementations for select, poll, epoll and kqueue. ... Can I integrate circuits with a GUI library? This is entirely possible. You will have to hook into the GUI's main loop. ... What are the core concepts in circuits? Components and Events. Components are maintainable reusable units of behavior that communicate with other components via a powerful message passing system. ... How would you compare circuits to Twisted? Others have said that circuits is very elegant in terms of it's usage. circuits' component architecture allows you to define clear interfaces between components while maintaining a high level of scalability and maintainability. ... Can Components communicate with other processes? Yes. circuits implements currently component bridging and nodes ... What platforms does circuits support? circuits currently supports Linux, FreeBSD, OSX and Windows and is currently continually tested against Linux and Windows against Python versions 2.6, 2.7, 3.1 and 3.2 ... Can circuits be used for concurrent or distributed programming? Yes. We also have plans to build more distributed components into circuits making distributing computing with circuits very trivial. Got more questions? * Send an email to our `Mailing List`_. * Talk to us online on the `#circuits IRC Channel`_ circuits-2.1.0/docs/source/glossary.rst0000644000014400001440000000021112072034467017714 0ustar prologicusers======== Glossary ======== .. glossary:: :sorted: VCS Version Control System, what you use for versioning your source code circuits-2.1.0/docs/source/_themes/0000755000014400001440000000000012113366740016747 5ustar prologicuserscircuits-2.1.0/docs/source/_themes/om/0000755000014400001440000000000012113366740017362 5ustar prologicuserscircuits-2.1.0/docs/source/_themes/om/modindex.html0000644000014400001440000000016012072034467022056 0ustar prologicusers{% extends "basic/modindex.html" %} {% block bodyclass %}{% endblock %} {% block sidebarwrapper %}{% endblock %}circuits-2.1.0/docs/source/_themes/om/theme.conf0000644000014400001440000000010712072034467021333 0ustar prologicusers[theme] inherit = basic stylesheet = default.css pygments_style = trac circuits-2.1.0/docs/source/_themes/om/layout.html0000644000014400001440000000777112072034467021603 0ustar prologicusers{% extends "basic/layout.html" %} {%- macro secondnav() %} {%- if prev %} « previous {{ reldelim2 }} {%- endif %} {%- if parents %} up {%- else %} up {%- endif %} {%- if next %} {{ reldelim2 }} next » {%- endif %} {%- endmacro %} {% block extrahead %} {{ super() }} {% endblock %} {% block document %}

          {{ docstitle }}

          {{ secondnav() }}
          {% block body %}{% endblock %}
          {% block sidebarwrapper %} {% if pagename != 'index' %} {% endif %} {% endblock %}
          {{ secondnav() }}
          {% endblock %} {% block sidebarrel %}

          Browse

          You are here:

          {% endblock %} {# Empty some default blocks out #} {% block relbar1 %}{% endblock %} {% block relbar2 %}{% endblock %} {% block sidebar1 %}{% endblock %} {% block sidebar2 %}{% endblock %} {% block footer %}{% endblock %} circuits-2.1.0/docs/source/_themes/om/static/0000755000014400001440000000000012113366740020651 5ustar prologicuserscircuits-2.1.0/docs/source/_themes/om/static/reset-fonts-grids.css0000644000014400001440000001262212072034467024747 0ustar prologicusers/* Copyright (c) 2008, Yahoo! Inc. All rights reserved. Code licensed under the BSD License: http://developer.yahoo.net/yui/license.txt version: 2.5.1 */ html{color:#000;background:#FFF;}body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,textarea,p,blockquote,th,td{margin:0;padding:0;}table{border-collapse:collapse;border-spacing:0;}fieldset,img{border:0;}address,caption,cite,code,dfn,em,strong,th,var{font-style:normal;font-weight:normal;}li{list-style:none;}caption,th{text-align:left;}h1,h2,h3,h4,h5,h6{font-size:100%;font-weight:normal;}q:before,q:after{content:'';}abbr,acronym {border:0;font-variant:normal;}sup {vertical-align:text-top;}sub {vertical-align:text-bottom;}input,textarea,select{font-family:inherit;font-size:inherit;font-weight:inherit;}input,textarea,select{*font-size:100%;}legend{color:#000;}body {font:13px/1.231 arial,helvetica,clean,sans-serif;*font-size:small;*font:x-small;}table {font-size:inherit;font:100%;}pre,code,kbd,samp,tt{font-family:monospace;*font-size:108%;line-height:100%;} body{text-align:center;}#ft{clear:both;}#doc,#doc2,#doc3,#doc4,.yui-t1,.yui-t2,.yui-t3,.yui-t4,.yui-t5,.yui-t6,.yui-t7{margin:auto;text-align:left;width:57.69em;*width:56.25em;min-width:750px;}#doc2{width:73.076em;*width:71.25em;}#doc3{margin:auto 10px;width:auto;}#doc4{width:74.923em;*width:73.05em;}.yui-b{position:relative;}.yui-b{_position:static;}#yui-main .yui-b{position:static;}#yui-main{width:100%;}.yui-t1 #yui-main,.yui-t2 #yui-main,.yui-t3 #yui-main{float:right;margin-left:-25em;}.yui-t4 #yui-main,.yui-t5 #yui-main,.yui-t6 #yui-main{float:left;margin-right:-25em;}.yui-t1 .yui-b{float:left;width:12.30769em;*width:12.00em;}.yui-t1 #yui-main .yui-b{margin-left:13.30769em;*margin-left:13.05em;}.yui-t2 .yui-b{float:left;width:13.8461em;*width:13.50em;}.yui-t2 #yui-main .yui-b{margin-left:14.8461em;*margin-left:14.55em;}.yui-t3 .yui-b{float:left;width:23.0769em;*width:22.50em;}.yui-t3 #yui-main .yui-b{margin-left:24.0769em;*margin-left:23.62em;}.yui-t4 .yui-b{float:right;width:13.8456em;*width:13.50em;}.yui-t4 #yui-main .yui-b{margin-right:14.8456em;*margin-right:14.55em;}.yui-t5 .yui-b{float:right;width:18.4615em;*width:18.00em;}.yui-t5 #yui-main .yui-b{margin-right:19.4615em;*margin-right:19.125em;}.yui-t6 .yui-b{float:right;width:23.0769em;*width:22.50em;}.yui-t6 #yui-main .yui-b{margin-right:24.0769em;*margin-right:23.62em;}.yui-t7 #yui-main .yui-b{display:block;margin:0 0 1em 0;}#yui-main .yui-b{float:none;width:auto;}.yui-gb .yui-u,.yui-g .yui-gb .yui-u,.yui-gb .yui-g,.yui-gb .yui-gb,.yui-gb .yui-gc,.yui-gb .yui-gd,.yui-gb .yui-ge,.yui-gb .yui-gf,.yui-gc .yui-u,.yui-gc .yui-g,.yui-gd .yui-u{float:left;}.yui-g .yui-u,.yui-g .yui-g,.yui-g .yui-gb,.yui-g .yui-gc,.yui-g .yui-gd,.yui-g .yui-ge,.yui-g .yui-gf,.yui-gc .yui-u,.yui-gd .yui-g,.yui-g .yui-gc .yui-u,.yui-ge .yui-u,.yui-ge .yui-g,.yui-gf .yui-g,.yui-gf .yui-u{float:right;}.yui-g div.first,.yui-gb div.first,.yui-gc div.first,.yui-gd div.first,.yui-ge div.first,.yui-gf div.first,.yui-g .yui-gc div.first,.yui-g .yui-ge div.first,.yui-gc div.first div.first{float:left;}.yui-g .yui-u,.yui-g .yui-g,.yui-g .yui-gb,.yui-g .yui-gc,.yui-g .yui-gd,.yui-g .yui-ge,.yui-g .yui-gf{width:49.1%;}.yui-gb .yui-u,.yui-g .yui-gb .yui-u,.yui-gb .yui-g,.yui-gb .yui-gb,.yui-gb .yui-gc,.yui-gb .yui-gd,.yui-gb .yui-ge,.yui-gb .yui-gf,.yui-gc .yui-u,.yui-gc .yui-g,.yui-gd .yui-u{width:32%;margin-left:1.99%;}.yui-gb .yui-u{*margin-left:1.9%;*width:31.9%;}.yui-gc div.first,.yui-gd .yui-u{width:66%;}.yui-gd div.first{width:32%;}.yui-ge div.first,.yui-gf .yui-u{width:74.2%;}.yui-ge .yui-u,.yui-gf div.first{width:24%;}.yui-g .yui-gb div.first,.yui-gb div.first,.yui-gc div.first,.yui-gd div.first{margin-left:0;}.yui-g .yui-g .yui-u,.yui-gb .yui-g .yui-u,.yui-gc .yui-g .yui-u,.yui-gd .yui-g .yui-u,.yui-ge .yui-g .yui-u,.yui-gf .yui-g .yui-u{width:49%;*width:48.1%;*margin-left:0;}.yui-g .yui-gb div.first,.yui-gb .yui-gb div.first{*margin-right:0;*width:32%;_width:31.7%;}.yui-g .yui-gc div.first,.yui-gd .yui-g{width:66%;}.yui-gb .yui-g div.first{*margin-right:4%;_margin-right:1.3%;}.yui-gb .yui-gc div.first,.yui-gb .yui-gd div.first{*margin-right:0;}.yui-gb .yui-gb .yui-u,.yui-gb .yui-gc .yui-u{*margin-left:1.8%;_margin-left:4%;}.yui-g .yui-gb .yui-u{_margin-left:1.0%;}.yui-gb .yui-gd .yui-u{*width:66%;_width:61.2%;}.yui-gb .yui-gd div.first{*width:31%;_width:29.5%;}.yui-g .yui-gc .yui-u,.yui-gb .yui-gc .yui-u{width:32%;_float:right;margin-right:0;_margin-left:0;}.yui-gb .yui-gc div.first{width:66%;*float:left;*margin-left:0;}.yui-gb .yui-ge .yui-u,.yui-gb .yui-gf .yui-u{margin:0;}.yui-gb .yui-gb .yui-u{_margin-left:.7%;}.yui-gb .yui-g div.first,.yui-gb .yui-gb div.first{*margin-left:0;}.yui-gc .yui-g .yui-u,.yui-gd .yui-g .yui-u{*width:48.1%;*margin-left:0;}s .yui-gb .yui-gd div.first{width:32%;}.yui-g .yui-gd div.first{_width:29.9%;}.yui-ge .yui-g{width:24%;}.yui-gf .yui-g{width:74.2%;}.yui-gb .yui-ge div.yui-u,.yui-gb .yui-gf div.yui-u{float:right;}.yui-gb .yui-ge div.first,.yui-gb .yui-gf div.first{float:left;}.yui-gb .yui-ge .yui-u,.yui-gb .yui-gf div.first{*width:24%;_width:20%;}.yui-gb .yui-ge div.first,.yui-gb .yui-gf .yui-u{*width:73.5%;_width:65.5%;}.yui-ge div.first .yui-gd .yui-u{width:65%;}.yui-ge div.first .yui-gd div.first{width:32%;}#bd:after,.yui-g:after,.yui-gb:after,.yui-gc:after,.yui-gd:after,.yui-ge:after,.yui-gf:after{content:".";display:block;height:0;clear:both;visibility:hidden;}#bd,.yui-g,.yui-gb,.yui-gc,.yui-gd,.yui-ge,.yui-gf{zoom:1;}circuits-2.1.0/docs/source/_themes/om/static/default.css0000644000014400001440000000013312072034467023006 0ustar prologicusers@import url(reset-fonts-grids.css); @import url(djangodocs.css); @import url(homepage.css);circuits-2.1.0/docs/source/_themes/om/static/homepage.css0000644000014400001440000000157312072034467023160 0ustar prologicusers#index p.rubric { font-size:150%; font-weight:normal; margin-bottom:.2em; color:#487858; } #index div.section dt { font-weight: normal; } #index #s-getting-help { float: right; width: 35em; background: #E1ECE2; padding: 1em; margin: 2em 0 2em 2em; } #index #s-getting-help h2 { margin: 0; } #index #s-django-documentation div.section div.section h3 { margin: 0; } #index #s-django-documentation div.section div.section { background: #E1ECE2; padding: 1em; margin: 2em 0 2em 40.3em; } #index #s-django-documentation div.section div.section a.reference { white-space: nowrap; } #index #s-using-django dl, #index #s-add-on-contrib-applications dl, #index #s-solving-specific-problems dl, #index #s-reference dl { float: left; width: 41em; } #index #s-add-on-contrib-applications, #index #s-solving-specific-problems, #index #s-reference, #index #s-and-all-the-rest { clear: left; }circuits-2.1.0/docs/source/_themes/om/static/docicons-note.png0000644000014400001440000000176512072034467024136 0ustar prologicusersPNG  IHDR//E pHYs  IDATX ͙MhAǓuUFE[i+ 'IVZz9Y)jAOzbO VE6dggvv[J}>~y3;j>;3~ZYV[eM&Uٺ3?)VA a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, h4:hover > a.headerlink, h5:hover > a.headerlink, h6:hover > a.headerlink, dt:hover > a.headerlink { visibility: visible; } /*** index ***/ table.indextable td { text-align: left; vertical-align: top;} table.indextable dl, table.indextable dd { margin-top: 0; margin-bottom: 0; } table.indextable tr.pcap { height: 10px; } table.indextable tr.cap { margin-top: 10px; background-color: #f2f2f2;} /*** page-specific overrides ***/ div#contents ul { margin-bottom: 0;} div#contents ul li { margin-bottom: 0;} div#contents ul ul li { margin-top: 0.3em;} /*** IE hacks ***/ * pre { width: 100%; } circuits-2.1.0/docs/source/_themes/om/static/docicons-philosophy.png0000644000014400001440000000276312072034467025366 0ustar prologicusersPNG  IHDR//E pHYs  IDATX ͙]h\Em+&SU5P֢*RPm_!M&<*>P1 }Ҫ$ښn&!) ~wO2;;w{99̙lXYYo=_"5Yͼ 88\yّ?n_s3{d3MOVMO/4ǟ޲eLu[ߌACD* |SC҅ÎwєξD[TG;2"O񞻾DdmE}UQLLr™SD*Pd6|wS ܍Orq t*\XXc;^I DٕwDP../@X-/ZjHnLzG"9ރͺ +@vuǁVFR)9&c}ބ?L:=11AϜzYeH'])(A K(qb *1e{{{XdDIbaQttt(J1\uȨe'@7**jllp(I1JԪ=44433c!^Ua#a*0SBs||\%"#R%  )'!)P$MOO#O!P6xu1ܐfAiX 8&&( "y薀rty$![e3dreض.( )e(u|!fREta)}gX$A+/ X@HTU2(>P%a~FD!@ DԘ>Ն|'H!B! C70[]ܟ!8ORc3V[9?GOp|7V7>9Gù }(n\x^GTӸҨ߽iE]4U=Uu[~: ڰԖ08;DqUf" E(ຄEĔП[­#S YmsqGfVb۾TM[Œ-4@ ph?56z(3iP0mA H].8:5u((hrIțs[btP%ĩ^/VtϰkKpOVǟaŞa?G}bfIENDB`circuits-2.1.0/docs/source/_themes/om/static/docicons-behindscenes.png0000644000014400001440000000433512072034467025617 0ustar prologicusersPNG  IHDR//E pHYs  IDATX ͙kLWYY q>ƂXeSX[Q؆jMiZ4&M%Fjm54>P)Z*"X< *͞0̂m'pswFӧOr<]ZOԨ܅0 p,Gsй;U 3)"ut+膼> MYvp)l2ʥKjo(f Kcxj@>VG+JG0@`~D,bW}TfE_tE;% 8"&΋`1Vtlƍųт/-+'CesqS´`wY\t[P˯dGM@Pԉ.|SMg+\)o$wXl0]µX22$]KV"EZǰ)Qrʱ`,J1A`89I:C8KjuQ|sok`C  ÌƇ]OSu%8`Odeeڽ[YٓI;] t *Ko*haedo'䭨ȡSqGu;KH}uȸ) ɑjժB5vD:0_,Wf4IU^@aJ h#e`Ez sPV2a kCȡ岧tˆ4{O&1]鄹+ǐ^Q Y Ohҽn#edCY ^YAK[lYzuhhh{/$$LFzUC?L .5>(󫪂/+k.4w>~ghs_ &(mly)R!??2ܬٛ.RKw3;6qu`يW#Φ򑑦 ztw#Esl$[OT u*q I 'd})6-M<;Lq5=$)Lܬ{ !'$9DR:8|uGҨ;VJwGG/-kg*gGT#ZEH[R&zA|Y*b|҉{q3m!l!Ey, d̚5kM/ݯ8Շ%YqH JYa-/uC/.ţ=87.pt? ѓXԶoSJjAT*uF8JMIcIj$jwn(PAe o(;ؼR@# 'R"M} Qd4C *AO@Wa{72O)͆`IJhdϏKZ3].ҺG!hQ8"eFs#|0 h܅0 pTҗIENDB`circuits-2.1.0/docs/source/_themes/om/search.html0000644000014400001440000000015612072034467021521 0ustar prologicusers{% extends "basic/search.html" %} {% block bodyclass %}{% endblock %} {% block sidebarwrapper %}{% endblock %}circuits-2.1.0/docs/source/_themes/om/genindex.html0000644000014400001440000000016112072034467022051 0ustar prologicusers{% extends "basic/genindex.html" %} {% block bodyclass %}{% endblock %} {% block sidebarwrapper %}{% endblock %}circuits-2.1.0/docs/source/_static/0000755000014400001440000000000012113366740016751 5ustar prologicuserscircuits-2.1.0/docs/source/_static/tracsphinx.css0000644000014400001440000000531712072034467021656 0ustar prologicusers/* Trac specific styling */ @import url("sphinxdoc.css"); /* Structure */ div.footer { background-color: #4b4d4d; text-align: center; } div.bodywrapper { border-right: none; } /* Sidebar */ div.sphinxsidebarwrapper { -moz-box-shadow: 2px 2px 7px 0 grey; -webkit-box-shadow: 2px 2px 7px 0 grey; box-shadow: 2px 2px 7px 0 grey; padding: 0 0 1px .4em; } div.sphinxsidebar h3 a, div.sphinxsidebar h4 a { color: #b00; } div.sphinxsidebar h3, div.sphinxsidebar h4 { padding: 0; color: black; } div.sphinxsidebar h3, div.sphinxsidebar h4 { background: none; border: none; border-bottom: 1px solid #ddd; } div.sphinxsidebar input { border: 1px solid #d7d7d7; } p.searchtip { font-size: 90%; color: #999; } /* Navigation */ div.related ul li a { color: #b00 } div.related ul li a:hover { color: #b00; } /* Content */ body { font: normal 13px Verdana,Arial,'Bitstream Vera Sans',Helvetica,sans-serif; background-color: #4b4d4d; border: none; border-top: 1px solid #aaa; } h1, h2, h3, h4 { font-family: Arial,Verdana,'Bitstream Vera Sans',Helvetica,sans-serif; font-weight: bold; letter-spacing: -0.018em; page-break-after: avoid; } h1 { color: #555 } h2 { border-bottom: 1px solid #ddd } div.body a { text-decoration: none } a, a tt { color: #b00 } a:visited, a:visited tt { color: #800 } :link:hover, :visited:hover, a:link:hover tt, a:visited:hover tt { background-color: #eee; color: #555; } a.headerlink, a.headerlink:hover { color: #d7d7d7 !important; font-size: .8em; font-weight: normal; vertical-align: text-top; margin: 0; padding: .5em; } a.headerlink:hover { background: none; } div.body h1 a, div.body h2 a, div.body h3 a, div.body h4 a, div.body h5 a, div.body h6 a { color: #d7d7d7 !important; } dl.class { -moz-box-shadow: 1px 1px 6px 0 #888; -webkit-box-shadow: 1px 1px 6px 0 #888; box-shadow: 1px 1px 6px 0 #888; padding: .5em; } dl.function { margin-bottom: 24px; } dl.class > dt, dl.function > dt { border-bottom: 1px solid #ddd; } th.field-name { white-space: nowrap; font-size: 90%; color: #555; } td.field-body > ul { list-style-type: square; } td.field-body > ul > li > strong { font-weight: normal; font-style: italic; } /* Admonitions */ div.admonition p.admonition-title, div.warning p.admonition-title { background: none; color: #555; border: none; } div.admonition { background: none; border: none; border-left: 2px solid #acc; } div.warning { background: none; border: none; border-left: 3px solid #c33; } /* Search */ dl:target, dt:target, .highlighted { background-color: #ffa } circuits-2.1.0/docs/source/_static/logo.png0000644000014400001440000000075712072034467020432 0ustar prologicusersPNG  IHDR7BsRGBbKGD pHYs  tIME 6PoIDATxK n8~?֭6Tnh5 Ȉɷ7^&7XV(D~R;6Yh0E}/|`qք3%3vVeWLg<+m7(9 pVT[^fJmwi^!lBt=V=j@'&0NYN΁ΨAQ'~_-㳄Z:ѣ׉=r~o;JHt_6fdY}da+ZXK5}UPRs Ʉ x4H%%IENDB`circuits-2.1.0/docs/source/requirements.txt0000644000014400001440000000006612113343751020606 0ustar prologicuserssphinxcontrib-bitbucket sphinxcontrib-googleanalytics circuits-2.1.0/docs/source/howtos/0000755000014400001440000000000012113366740016646 5ustar prologicuserscircuits-2.1.0/docs/source/howtos/simple_server.py0000644000014400001440000000115312072034467022101 0ustar prologicusers#!/usr/bin/env python from circuits import Component from circuits.net.sockets import TCPServer, Write class Server(Component): def __init__(self, host, port=8000): super(Server, self).__init__() self._clients = [] TCPServer((host, port)).register(self) def connect(self, sock, host, port): self._clients.append(sock) def disconnect(self, sock): self._clients.remove(sock) def read(self, sock, data): for client in self._clients: if not client == sock: self.fire(Write(client, data.strip())) Server("localhost").run() circuits-2.1.0/docs/source/howtos/index.rst0000644000014400001440000000010512072034467020505 0ustar prologicusers====== HowTos ====== .. toctree:: :maxdepth: 1 simple_server circuits-2.1.0/docs/source/howtos/simple_server.rst0000644000014400001440000000612012072034467022260 0ustar prologicusersHow To: Build a Simple Server ============================= Overview -------- In this guide we're going to walk through the steps required to build a simple chat server. Users will connect using a standard telnet client and start chatting with other users that are connected. Prerequisites ^^^^^^^^^^^^^ - `Python `_ - `circuits `_ Components Used """"""""""""""" - :py:class:`~circuits.core.components.Component` - :py:class:`~circuits.net.sockets.TCPServer` Events Used """"""""""" - :py:class:`~circuits.net.sockets.Write` Step 1 - Setting up ------------------- Let's start off by importing the components and events we'll need. .. code-block:: python #!/usr/bin/env python from circuits import Component from circuits.net.sockets import TCPServer, Write Step 2 - Building the Server ---------------------------- Next let's define our ``Server`` Component with a simple event handler that broadcasts all incoming messages to every connected client. We'll keep a list of clients connected to our server in ``self._clients``. We need to define three event handlers. #. An event handler to update our list of connected clients when a new client connects. #. An event handler to update our list of connected clients when a client has disconnected. #. An event handler to handle messages from connected clients and broadcast them to every other connected client. .. code-block:: python class Server(Component): def __init__(self, host, port=8000): super(Server, self).__init__() self._clients = [] TCPServer((host, port)).register(self) def connect(self, sock, host, port): self._clients.append(sock) def disconnect(self, sock): self._clients.remove(sock) def read(self, sock, data): for client in self._clients: if not client == sock: self.fire(Write(client, data.strip())) Let's walk through this in details: 1. Create a new Component called ``Server`` 2. Define its initialization arguments as ``(host, port=8000)`` 3. Call the super constructor of the underlying Component (*This is important as all components need to be initialized properly*) 4. Register a ``TCPServer`` Component and configure it. 5. Create Event Handlers for: - Dealing with new connecting clients. - Dealing with clients whom have disconnected. - Dealing with messages from connected clients. Step 3 - Running the Server --------------------------- The last step is simply to create an instance of the ``Server`` Component and run it (*making sure to configure it with a host and port*). .. code-block:: python Server("localhost").run() That's it! Using a standard telnet client try connecting to localhost on port 8000. Try connecting a second client and watch what happens in the 2nd client when you type text into the 1st. Enjoy! Source Code ----------- .. literalinclude:: simple_server.py :language: python :linenos: :download:`Download simple_server.py ` circuits-2.1.0/docs/source/images/0000755000014400001440000000000012113366740016570 5ustar prologicuserscircuits-2.1.0/docs/source/images/web.png0000644000014400001440000010364012072034467020061 0ustar prologicusersPNG  IHDRņbKGD IDATxwXT6{IW(t(DEKQO1%Qk99Q_$Xc1j""HQ#" RTPfX3#]=󻮹vyfc1B!9B!F#!BiB!Y \ zA   ]ee%jkk Ѐ0hjjա(**JBި`$DBEEE())Aii)JJJ |>"***PUU&TUU]]]6W^04418M!xt4!ANN>}B ??EEE(**G^^ɂKSUU***Ԅ"tttuuuAYY'|eee5ZZZכq%IeII PQQ!UVWW7(n_}󥖭CCC011 ,,,`aaKKFBCs@BBv؁SN [nùE!Bٳի1c >>r ]%K`޽Rnܸ6m" Tx{{ʕ+o!//C Aaa!&M[[[$''ܹsXj曷Z~{t͛}}}\p\G"aȐ̖/_΄B!qc3yyy`H$bϟg$΍7;0H{Z?`nݒ>--%&&c[Xp!BCCo߾xMMMc4O>Xx1/^ … qe޽WC(bӦMM.ƊEӧc۶mv{aҥRiu7 q >|>\k-Ngiilذ/^eM"k,i"LMMu6{%p---7n QVVd\v ]ut]‡  HJJK:bݍyրÆ C\\]۷^\044رc%8 5qXZZb„ */{GѣG 8ujkkq%i:Chh(Ν;-C!2&Y"3sHlҥŅiii1yyy<<V\;wrBڄa$2E[[111сk#+Ē%K0{l|رcב!ͨ`$27o̙`s6~:pl޼JPHd [DEEڵk4h{rb6lTL2Xƨ`$2- 1c>S]zgx9VZ[[[DEE᧟~B[^H͛7۷//_9s4{K=B:CFFكXnBBBu4BiT0.'##qQx<̙3˖-FzHg~@tt4l2|:!+*IUVVbϞ=HOOcccn*11aaa8~8|81estq)))8~8C!88s΅5!QHZDEE8}4*++c"00nnn DZTQQDFF… B߾}iӦɉ누ҩ`$VMM .]#** 000#0fR!)) •+WP__///bرpvv:&!p Fc<~ĥKP^^cccxzzbذa򂫫+J:Xqq1q5!11հD`` mmmBLHB)))v횤h˃*ggg8;;ޞ.҅HNNFrr2nݺCNN񁷷7annu\BIT0rrrpU#99)))PTT ''' 0!eHuu5222;wH Ĝ9xxx@SSԄ5PHHcxTTJJ !tYT0F|>At*,,,`ii ȞϟyyyǏ,dggӧD^z8TBigT0N둓ldgg#++ 999x1Z055.`ooBOOсyW.PRR"y(**B~~> >ϟK>077%$-,,`ee^zquҳ(pBNNlt|}}=󑟟<{ /_FDD! QTTB6 mmmIMMMBEEPTTopmauuuhL{IIdjԀ磮eee +**BOO055JKKQYY+V 00ƒBBlN"''޽{wިիq̜9?CK4;@ 'O  QVV@*z.& Q^^ _cǓ`Ǐ O?fO>A||< _Xңѧ!c޼y>}:OD:. \]]q-̚5 3gĜ9sE!=&\zgFuu5~G;\GΝ; @EEưaøD!= 0ҎB!>3T,q!55QWWu,B1v#̘1w]d IZ  ѣGѯ_?#BHG=GX !!!HJJH$+~g#BHG#!oÜ9s0|$$$`\lmm%K>@pppS$h4!o(113gDii)BCC1~x#Hј;w.q:!B:0F1|򂅅RRRXP@@RSS |g \"nz i̝;ꫯ.-C݋?8rD!}JϟpU|'T,ʘ? 9u$Bӎ|G?~<ƌ[naȐ!\"M8p 0|̝;gϦ;B[]҄4#==3fÇ{n̙3H "##CMM G'ב!KFBO? HJJb DJJ 0|p|D\". FB^SZZӧcXl^}r!###ouV!;;Xҥ.iB^q5̚5 B@@בH;JMM̙3ݻ3f:!t HH-[DJJ ݐ#1{l̚5 s̡b!xyyy={6cX;w ,*9ooo#B̢Fң>}NNN(((@||#Xcƌ'OE! FmTUUaɒ%2e M7oXPTTW_}+W ;;8rױ!SPH4 2ǏGDD555cnoٳ1w\L:ϟ?:!t(*I?www!99'O:wŋHHH=Μ9u,B0T0.ŋ4iV\O?077:AF4wŢEE!.MdN}}=.ٳgC^^Ga:)!߰d"44ً}***B0rJDEE5:N(bÆ 9r$<< {zjRBțF"SN8S|>455%?~3g"%%| ,YULBuA\&&&8|0 1Ǐ:t(Q !UȌLxPTT?Oɸ07nܠbȴy!-- _|:ڵ .\(((`٨8-!zL!C:Cdd$O??7|C}.1ݻwc͚5033Cff&D';Q IDAT"dVXoÔ2*L ? P(&''###,XC aBB\BBQ[[+U0/Q:Bi&;v/U,/ϖ~9X$]c 7nP(lP,/{g͚ 2"+`$JOO… s]]BCCڵkJ!͢]ҤpuuQWW9-i i_=©Sm0'x<\|\$)T0v!%%%^E$@Fkn4yɫ444UUU@II mچ*<  Ѐ/F#F޾|||PQQ>2TVVJڈ:TTTX 555(++Kh*++CCCCVCCCZZZ֖.n;}}}p98T0Ree%<;;YYYx $Eaaa!>}*URŌ~Ŏ69RT^^2ɇϥpyaaaB011 ajj sssXZZzh IWW^^<~(((ӧOQXX(i+CCF==F mmϤJJJ|1՟ 011!333FFFm!!1"33ْ0''x䉤WVV%z CCC۔C555(,,D^^~?ğ>}|`T!iee.< PFKׇCN *털X/=UQQ,,,$Eѯ_?pUp%%%@zz:222 ##Cr‡:,--aaa!)^illL'[t#}C\ ,wEѯ_?Ɔveu>jѷo_/t$d`D{._.yܿ`ii ggg888 NNNC8QSSwJCUUnnn<<<лwo#w 1ddd !!AHIIP(X\ 8% ʒvÇD'WWW"CdgP( (//%o&OO&/Cx7n )) uuu033СC1bƆ]H$­[8ܸqPWW1tPxxx\%U*++\~ x)OOO9~~~mh;!S ŋx"bccQ^^b[[[9$]^uu5n߾x\~'={KKK5 9r$Wt ::()) &i!//uTBMnnxvn޼ :tt \uuuADD"### 5j)))x׬...0a0h cvZ~Cdd$rssahh(9r$,--IH|yw444w}Izv/kkkqE8qOFYY{aԨQt`BXȸ8DFFɓx1  ёQQQ8q~w|x{{cĉ5j} sΡ~~~2e {=sV0&&&b޽8y$ム L'OBPRR;PTTT ((K.ڤG޽{,Zvćt>|'Oϟ:t7*|>vڅ{SLҥK jjj={H[AAA26??[nŁӧOҥKm0B"Oؿ?rrrkϏh;am w}/YAAA[!0ooocteǎƆ)((0/:q9s&cCe'ב(--eׯǧ}wXHmH$bgϞe#Gd/:&Z]0>}0FH=TTTYm@YF67{Q^^.5.\옲2SUUelͬ] sssc֭c_||r,=$%%Ç\Gb"HERWWܹUUUqKJsg=ى'ĉ1STTdӓm۶x())1+++b/fLII)))1 6~xsNV__),}6[n;v,366nz6AV|}}cgϞ=:Z%]YY˗#44f֭[ann= ,TUU!77(((#~߿555.\z-Z+WSU֭[ǃ"|}}\t pvvF\\[_wř3gPTTZVGիݻwcΜ9ܹsq5ڵkIlܸM65qFcڴiD޽1j( y&tuuQ\\,Zܼy055ERR ???TTT`̘1233%쬫B&hƍشi1`6nI maG ǪU 1cptUUݝӧOwJ67G@lx<sttdto'06ƍb }Woǧ]^PSS1֬Y=RĄ۳۷owCK{'Ndm3nݺܪenݺ`֭c1Y\\\iE";|aLKKc1MYm ;Rii)5kgC&?KKK0`Ho~竫c[la ]M77ndlXjڲ2qF6tP%[|y2^2СCSRRb b~i ܹsY^ 6lKHHh:~8eZZZLEE9;;itZ٤In h_x1cƼvEaaaLEEY֙ʴ;Ё3lΜ9.C\شR=1Ƙ*suumsxOFGG7{l_'NMۇڄbmvY˳( j&9Νcjjj,==4.{f}iq>fff֠A#/Zt?` 7ȵsNRÛ%QFI5F{AիWK ߾};6m$ H"HAwZѬMiGO]]O^G?7َ: vb{fkײA5jk/,,,I-S> a۽{7KJJbM.ߓ/IIIR3226o޼[w[iTjִo]ի]sO#FZӸ5|ܼU;`Rß={噯o˨`جY7W=x<ѣVehP1lĉa&L`jX򕔔XYYYY^石&Xii)_!x,&&SRRjpVlGW.300`u3MMM믿v::Ks텊J[L333Iuѣfjj*"WYY}&''')`TTTr{2>>/6mbXddd-ޤ`lM/l{WPVV:e>W[[X,[Q=JPP<WWW̜9Çի0}}}iiiR###(..F}}d\~~~3&&&VVVRw)-- KHH&v` BKKKjXcg:lӦMJJJ9c1y!Ǝ yyyCMMMjnGW???DEE>uǣδlFnnZQQ}%KgP|8wnܸD矈šC)y{ +++aǎ #GLۙjMkm{]---xzz… 4iqHWzYXXԵZ K}\6mD"Q$=z`:::,88}'ވr4%//z_k8{j666LGG>dfffLMMɋXvtF^凅199D{nG1ܹS2=ߓbk׮eؕ+Wc/{ȮZ.ۃilm{&UL:M< {400&=zԖKx1Zu2lڴ ľ}`ll/~m]NiiԷ쯾 HKKï;v`ƍۼ=:::xEk\\\^#..UjlEUUU=z<{ O;|;Go߾|kkkYN=¡C.] 3f;&S<#AKZ&mÇѿc.AGrCw+LR6uY9" 777dff";;wnTSStXXX4'`(((@DD\[-ۇW͛7m۶fnqj14h! 333x{{KM' bme}ݻw!ip 7ݮ۶mÞ={Yf8_`[icD"|R>sD"L>]2Rǚ5k͡ _xb0[kXxqz勥7X>c | |>L"5.++ 1n8Y ??V}`)۷cΝ N1qD(**‰'i R7nK0d\vMrM6aƍDPPjkkggg rرk֬?aĄ #22Rjnsjlܺum6ƍ!ʐk׮={vߔ7b=z4,--!T899!..---C6z҅yۼu;V~!p֭%-6m4#66SZ}ր}ƍqzϟzN'''wwwBOOeee|2ܹ\zU#ޓ>   !;!Ǝ+v7i^ɶ2@iӦ!)) III2}S";qLQQC/ўҒM4>|kNoF سgd)zlHHH9sPVV3gãS_SSOCIIS3BZvY,Z8{,츎DϨ?ׯGTT/P[[!x9^% IDAT.] ///XYY!99ӋE;ݻwoŠApر.;Ço>TTTtdFBzL^صk"##smpF+Wqܾ}FFF7=!!4s;{tWlkƦñcǠ9s`ҥ0`@{g$D8wك(#$$/ZtU|8y$ttt0|ښht+8rۇ 2K,ٳbҮ޸`+))o>҂*sPUU___aƌ:"ڭ`|U]]._p:u /^1j(ɱMUNzgϞ!&&шD^^Sv:jkk'O~Cqq1#G***\$S1!::111P(ȑ#1yd{:&A:`|P(Dll,.\/"55>|tpp ioՈCtt4 UUU 6 0almm qh@II @@@\\\ //uTB:Ǐ#yww|TU_2d&uM鴐PB * PPuEE]׵+ ,@BI!$gR&;͐IHB;IO&3w}s{9Μ9f¼y\ o=aUee%EVV233@[[LMMȵj <LTUUb1Xq2.T*aN=;;[[[$RS7xzzٙ}ϣ\UUPTT~AAA Epp0~ 3mR"΢[RAhvnnnpuuk JKK!QXXTP(;4h___HR6r""h eff";;hkkp;Ȧ4ƚPVV Qs+,,Daa!ܼ^3wskO0ƈK{% P^^ny{{{8::NNNpvv3[[[ƆDMMMAuu5*** Q^^rr/++*yf+a...˻`hꈢ"spttGGGSS?ذAP(zB.R(//Gee%JJJ C*B*rwwwF?vQVV% \"+QQQX%lll`gg$:9annݬ`ee5BPhllBB@]]P]]*Uk}bKy'irtt3#U}}=W/99z8vN";#`ii sssrM]P(Ԅp2zB:ajj34899daz%VQYY3.ihh:)Dj&fH$000`jj  @/,,,t\g+hSSSV;tDFT*477CTBTmmm\2Y;ַM;uttdst2zOTZIO؈nש$- ˀ&~6119uY{{; Zh* n( 䰩 uuuݾoM=׹ŋe˖!44T+wttdfqD:<<5lCC:::ʸ---]*rh[uժysNJ,C$qP(Қjaatnaeuttti]kllD]]Wg#4IXKK Z[[ֆ.~hhh@ss3LMMZ-;xzdZrxfff\= HyѴv7qF$&&b͚5x܇Oa` (sN\Rg0wށ\.}i&`ӦMx aF)aѲsNw}>YnX|9222i&ۡVaF02 Ì׮]Crr2VXw(J,c¼yvZ?'O;41X0 3JpwwɓeP8;;?GJJ %K ''fc #0(@D)zqAc|Ň~hpaFaQ`Ν Ahh(ߡ )###[X~=^{5aϞ=|0 KaF6ڵk v sss p"66W\;4X0 3ǣ˗/;IRܹΝCkk+Ə+WFaf۹s'LC8w~'$&&" jAdю% 0#Xcc#?OGwK.Ezz:' KaF={@Raҥ|#;;/&>|0ߡ1` #0? ..666|)))pssÜ9s0w\\vw,adr9?>^طoN8 alofTc #0O? ,;aiڴix" ٳM͌j,ad~,Y"P-CCC<&ſo1̐a #0/D3wNNfΜ|8<ߡ1̐` #0ccƌ|2oŋ!+V% 0#JŽ;zjj~03'N$ॗ^B]]ߡ1̠`5 0s!rYPFŋ#==߰}v>J;4P,adaoߎ)SLJPFccclذXz56n܈0673afq~w<|2H$lݺǜ9sd102 Ì ;w ^Cd2vލxdff"((/ k,adA<033;QoΜ9HII;v̰FaҥKHKKc]􈑑֭[ץɓ'a% 0#_ DGG s72 KaF:X~=ߡ0=dؿ?<72 KaF_UV qqq#3afSϰfH$azIWƈֿK,ad~w';472z% 0֭[@Ca<72z% 0ٳgqilڴP_~ Zwh(Faa_ٳg={!** SL12fڿq?~<ƀ QVVף"\p˖-㖫Ƙ1cuVBe `L:O=~',\t5<󈏏ŋC&3q`ngӦM60 s'lllP[[  PTđ2KGDDDPXjOQ1 W]1p,011!*Fh7^~/cII mXp!xNX8J^K?FZ+KK. mۆbvۿqܲJfBII _2KGu7[$N '''"b̴# B{xGyg7>f_̚5 ^3227 R<ގsa͚5`cnQdѢE s8E0Jx뭷wH0Rv;͚f~ /F F|ܹzlCCT:hhh222 ɰ{.IX,H$1`eeSSSK1 3Zz(J477CP{VMMM:Osy  ٳcccH$^M͌^| rsso{AZ[6mBV444J]lkkCSSS[[[ko``[XX033%smڝFKK P^^ TUUUUU hhh@KKB3X!aaa[[[Ύkoo[[[NNN=2RT\.Gee%jkkQWWZjvp 5HĕSX DkkkX[[okk 899Ɔ5BnKO cʕގJ\.Gqq1ni hhhRDccc[hIX 333666:ﻸ C>a CNN544䒲[3ng`nnKKKG/H```J6m(Mi[ZZ K2[YYjB/ ?Q3*++QXX" (//Gee%*++^#M45 H$\K)7Gvfbb5EN/ٱcǠP(0e_^kkkΉv644hmpqq# gggxxx:ce[KK .^t"%%iii\- AD]6СC>}:@.#77yyyGyy9JKKQVVƕ-:0[[[XYYuiDʓ!b]Ύi΢uR91U(P*Gss3[wLD"\\\WWW8;;񁷷mg #"#%%FVVrrrPUUf 777A*pww3jjjU܌IP^^J\dzK2Zk׮!++ ׯ_GFF ###xzzj%6T*V@g(**B~~>knpE~~~뮻0_ڸt.qÖB-y...6#//yyy\+lnn.rrr ###d2 ((3f̰ٷr9ŋhiiD"Axx8BCCP#v .Tdׯ_G[[HDGGcl0(QZZdv偈 H%&>>>h~Cff&222A[[D"  ,"Bff&D@TAAAZLpp0{D@nn.ҴlT*a„ 0a888v,aA}}==Gȑ#ͅ(DGGÃPGvܹsHHHsPXXP &`֬Y3g&L##6S*HJJٳgƍ044L&Cxx8tٙT*dggk%wI&aҤI]ww#ZFJJ ?'N̙3Ǝ%';QI«Iⓒpujx{{cԩŌ3w,aLV#118|0!3g"&&j MkC밲Œ30k,̛7R0^P(̙3tJ%H3F0VK.qgnaoo(`ԩ7nܨYYY8|0??pwwGll,L & ((}z.]… pI9s 1k,^& Zٳg?cϞ=())A@@0k,L6JJJpa>|GEMM &LKbٲe;Dx?jaaaI WWWCeZիWq$$$(,, f͚8̞=[/ZZZƅ w^ݻpttDll,\d2d@{{;℄ttt`ԩ{p!k +W}v/;v,.]Kח;сSNo\qaŊXjըG/---8xs` IDAT vލ#G^^^3g0c ztQPPx:t'N@}}=BBB0w\{ｈ;!GD8}4~۷ =܃{&L`QFf:t*;/C=4J ~'|HJJBpp0VZKQJLttt̙3矱sN477cɒ%x1uTV"RÇ㧟~¾}ڊӧF\\k`DRܹs޽{q5xyyaw;v;({Xh|||AGGΞ=~ ?r9O5k`ɒ%}Fzgʊb1=CtbXss3ر W_}EJFK.ѣ>J͘1K;4fIMM͛7/WQee%ߡ ZM;͚5 Ņ^z%~:ߡ1zFRсhٲedbbBVVVn:m脱z)DF}UWW#ccc?%w{$J~)rCcFK.s=G666dbbB=]p; !?>8pT*ߡ1@uu5 LFl2JJJȄ6nH$J>VbPQQ_LLL͍vwHJcc#%{{{ wX(L| 7i|kj; BZj3LuttЮ]hfΜIW\F\¸grss#[[[jZII =cdhhHgϦCkJ>Srrr" zשsyZx1ФIԩS|ԣD$###z'رckݺutƍ>c$uuud200zhDcaΙ3g($$b1}'|O^^^$hƍxf\pf̘Ah޼yTPPwHZhڵdhhHӦM˗/3Bjھ};9;;}zH333ߟѣ| smmm׿Yug? cZjՈn@&M;cҤIˣGRPPYYYю;xE#++֖~GR|4"{$ȈЖ-[W3ϐ= ѣ$HhҤItu $Ji͚57dq TAQQQüfhhxÇ5EEED&{{{ڽ{7P~~>=M;ޡNT=p-Z|||H$P($z)77Wk#}W|nv˴!)) _|ߏ˗/.ڷo;hCiyBu]w@ZhBBBdرc=+CrrrrGyf|ts'z$8/))!KKKz(hٲev5(h%%%$;!w1211~Zo􈍍%@@O\GGw(Zb1;ϯ۵kM:,--I$Qxx8}:ߗiPkk+ӧvj@sܟ'& 7oeddeHDTYY9---G?l7[XWWs:nWRui֗ŷJJ=6r_ 'OɐNw_~}}=Yfqĉ ҦMhڴi::'}Yv˖-ubd``]'@SO/L , HthZ^y.%%%9-\?ӦMhBBBOi'T:jjzhzӲaccC= ^ @6l@/"ڰaCu=)+wZ~PPPm۶׿{!v7n?mmm3gΤM6Qll,999Q``^&DDׯ_'SSSڻwo7$FrxKO/}p y,1|ZjaQ_w@*ا~JhڵZ>>~-Ktg|Օy۾Koz3(<<PJJ8tuBל"{vMss3Y[[w}kC!55 )--PXv-0ڶm]|ں]>>>?vttO(!!A5~}]O_@z133o8plB -ZhٲeJ?@۶m#Ok=OPyW)44tP7) ӛ]+|$\[P%nNIwWS/>M}N̙C=wCPP(~Pka{Wh޼yd``@~~~Zύ!@迢M<_gdgguڷٳ_.]"hP(V\m˗ӢEc=w:555њ5kАKDD"M6.T,X@fff]F ݜDW뀮_ӗr'_R*TWWG رc:_~zS&сn255%//.#'OLFFF]ܸq^'999.]4hػw/ B^Gfi۾t}ٳ zVV[g ~K: a׮]C{{;BBBS\\7|S1;;;֖{ի󃝝ֲdHOOײotomuEd2xyyz۷oGO>ŋQSSZ=W^^mp||1蒒0qD׿/ԩS8y$;C,.\ lݺ˺4n빓YOVcllRx0}.߶mmۆ\p7nwߍ_~K,Gnn.Ν @Zϧ׷K=bgg___ddd]-#!!cǎm\|z9¤IpٳCMBnnnx'kq#oW>3BoiرcЀh?C{GN8AhA.oAh̘1ZEFF\=Y pBSLM\=imm%kkkDT[[sHMDB?ew m۶a ^yyyKL-&&Fk]~o}]O_JoOd2I$^-[QQAbBCCu>Kdjj%nWgF&;3hhĉ]ݪo}u-S. fv'/Ο?a¨/K>pttĖ-[P\\o| ?,,,P__uuuu˲CD>000ٳg5H$5كZXD2o6̐5Tccc\TTTٙ0 OwǏʝ%<<^>m8*++vypS\_[011֭[ FVVBvv6,|Gtހo`ܸqAaaaӛu8T3g ::0]\\;%`8HuމDDDڵkwu=})+-immEff&<<ۯӢ=4/kFsjF4kF[Nk9(?{/-\PEE@n/B9nm!yzz8 Ņ Shh^4呡aF w$HhΝ|͛Ls/2/c l2W.Stߌ.VOڴis  =cyyy$J{=PSg:P`8iŊ1c͛};}qUOINw^>M}ؗuGRL&{O[{PRRBz1R/?//ۛT*܊ӧOךgyo,O5Kosך5k7/L/&Xs7|o65}?===^gy\]]izQVXe?&{{{*..;-kFFFҺuW_~ 9g#Q5=k&OL.{zz[V[~lB|rzº|O<ꫴa;v, ÃPddVnGTr9s&4}truu MoNC2H,SffoFkH}իrppzL_{s80MnJkQZпo"9?O$ I*ҟg_P_U(zj%;{z_jK?~ '''CbF~ K._|՟s4ɓֆ1 /v܉?Oذa!n}}=&MH#Gzȶ0?~ ,SO={ݠ @]v:G1̝ڶm-[M6dp1H$;?#!1ijjO<|/R;`eeC&L@rrna:۶mΝ|n Y{ ٳg/|Ìmmm㏓@ >pxB6l \̓addggfΜI"ok,H+V @@N Ȟg} כ!tE7nYYYriɑ#G͍ ####;wn쇚J^{ iѢEwH(w^!:~x_7"F?D?34443m޼Ԕ6nH|5'|BbbbO?e-3^ TJ4|;ITWWoM$hʕtȑaUWWG_~%pyϯ: 0j?V\I&&&deeEO=3DiϞ=GJ[laG@VѣG&kkkK?ZpL  -[Pnn.ߡ /)**T*^{ a8tZr%bŴrJ:yngN_555oW_!##cƌҥKtR3:::pI/ؽ{70w\!xmmm8|0vڅ{ ;w.0n8`!P(p1СCχ~w} ;!o=1n8,Z .DHH1C 'No} QQQXf ~XYY 6G]¨AD8{,~())Ahh(-[{000;LZ[[q)޽wFuu5&NKbٲeJ|8j8x >,c3gN oood@{{;._'O8s j5s"<<0y9޷o݋B`ѢE?> `8v݋x( DEEa…Xx1|}}u6a쌈D gٳ1c vA=EDHKKÇqhkkĉl2{,ISG||<?F899!** 'OFtt4Ǝ Pw ABBΝ;ӧOŋhii'iӦ JH{b߾}r LLLX"""aN8ǏڵkD1c.\ qa 8|0>SN !!!Add$&NN_DTʕ+8PTHIIsﵴbƍØ1cpؘ~+Wd\t 044Dpp0bbb0i$L4Cee%N<%YYY077ĉL0|tсk׮!11p`dd̘1ӦMCTTLLLx%ֆ=zgΜARR`oo(DEEa̘1 3(Bjj*K.ATј2e fΜeXQQΞ=$''#%%   Dxx8p]w?iiiAVVpU.A,**HRc̘1ĉaaas#OYY;g… o;%IDATz*T*\]]1aDDD 44AAA`]Rq5\rt`ee#22SLALL LMMKLr$$$ !!{{{!,, !!! L&%QRdee!-- )))HMMիW ccc3QQQ`-!//Ou*%%%%%HǐMQ\\dff"33DQQj5B!d2Ǝ˵3666|?*HLLDRR "."00dJl`?477#77HOOGzz:^T* ,,K#""秷,aHMMEjjVptt|}} LL888hoo\.GQQldgg#'' %ݡ E@@tKL(JX,<==usvv듪*TVV(((@QQQXX2tttlmmoooV~Bבk׮!-- (--Bxzz>>>񁷷74j QRR|"//999ͅ\.pEpp0 D%DV#??K䨠dE"\]] Tݷ=`gg[[[bUWqP]]*TTTEEE(++Cqq1***VL&;;;3RjGQQ PXXbq˛sqNNNpvv=`cckkkH$X[[s%@RZVWWZԠ娨\.\.GeeceeT OOOxyyq=<< @\򓗗\~II 4郱1gggre666_>hnnFuu5jjjP]]eV^^rTTTp311PwN}||FDk0򠭭 (--Eqq1JJJƍ\Raff[[[ b055%! a``DzsMMMZ;v ---hhhB@ss3 vmb8:: pqq;ܸe?R3ZrC.ƍ(--Eee%***P^^ݯӹ+++.466b1D",,,  !H`ll 333@ MEWy\;\___[[-҂V444hmmĖ. B...pttkg'''ں_332)Jp Tyy9P^^R;֙%DjʋD"H$)`bbsss7Vnm0j;Zhii777---\x:pvv \]] 777899A*yX@KXMMV]MBW__&477PTPThllZ_CCVzk!444䦭055X,`jj XXXpSsiggN1#ֹ+JJT* P*hnnkؙD"&H$BXXXpswnܷX,JRŮF뾦j%tJK6omn:itn$ D"\맮ёKaaaaKaaaa`aaCKPIENDB`circuits-2.1.0/docs/source/index.rst0000644000014400001440000000124012113343751017156 0ustar prologicusers================================ circuits |version| Documentation ================================ :Release: |release| :Date: |today| .. include:: ../../README.rst Contents ======== .. toctree:: :maxdepth: 1 start/index tutorial/index man/index web/index howtos/index api/index dev/index changes users contributors faq .. toctree:: :hidden: glossary users .. ifconfig:: devel .. toctree:: :hidden: pypitest todo Indices and tables ================== * :ref:`Index ` * :ref:`modindex` * :ref:`search` * :doc:`glossary` .. ifconfig:: devel * :doc:`pypitest` * :doc:`todo` circuits-2.1.0/docs/source/todo.rst0000644000014400001440000000006612113343751017021 0ustar prologicusersDocumentation TODO ================== .. todolist:: circuits-2.1.0/docs/source/tutorial/0000755000014400001440000000000012113366740017166 5ustar prologicuserscircuits-2.1.0/docs/source/tutorial/index.rst0000644000014400001440000002547012113343751021034 0ustar prologicusers.. _Python Programming Language: http://www.python.org/ Tutorial ======== Overview -------- Welcome to the circuits tutorial. This 5-minute tutorial will guide you through the basic concepts of circuits. The goal is to introduce new concepts incrementally with walk-through examples that you can try out! By the time you've finished, you should have a good basic understanding of circuits, how it feels and where to go from there. The Component ------------- First up, let's show how you can use the ``Component`` and run it in a very simple application. .. literalinclude:: 001.py :language: python :linenos: :download:`Download 001.py <001.py>` Okay so that's pretty boring as it doesn't do very much! But that's okay... Read on! Let's try to create our own custom Component called ``MyComponent``. .. literalinclude:: 002.py :language: python :linenos: :download:`Download 002.py <002.py>` Okay, so this still isn't very useful! But at least we can create components with the behavior we want. Let's move on to something more interesting... Event Handlers -------------- Let's now extend our little example to say "Hello World!" when its started. .. literalinclude:: 003.py :language: python :linenos: :download:`Download 003.py <003.py>` Here we've created a simple **Event Handler** that listens for events on the "started" channel. Methods defined in a Component are converted into Event Handlers. Running this we get:: Hello World! Alright! We have something slightly more useful! Whoohoo it says hello! .. note:: Press ^C (*CTRL + C*) to exit. Registering Components ---------------------- So now that we've learned how to use a Component, create a custom Component and create simple Event Handlers, let's try something a bit more complex by creating a complex component made up of two simpler ones. Let's create two components: - ``Bob`` - ``Fred`` .. literalinclude:: 004.py :language: python :linenos: :download:`Download 004.py <004.py>` Notice the way we register the two components ``Bob`` and ``Fred`` together ? Don't worry if this doesn't make sense right now. Think of it as putting two components together and plugging them into a circuits board. Running this example produces the following result:: Hello I'm Bob! Hello I'm Fred! Cool! We have two components that each do something and print a simple message on the screen! Complex Components ------------------ Now, what if we wanted to create a Complex Component? Let's say we wanted to create a new Component made up of two other smaller components? We can do this by simply registering components to a Complex Component during initialization. .. literalinclude:: 005.py :language: python :linenos: :download:`Download 005.py <005.py>` So now ``Pound`` is a Component that consists of two other components registered to it: ``Bob`` and ``Fred`` The output of this is identical to the previous:: * * * Hello I'm Bob! Hello I'm Fred! The only difference is that ``Bob`` and ``Fred`` are now part of a more Complex Component called ``Pound``. This can be illustrated by the following diagram: .. graphviz:: digraph G { "Pound-1344" -> "Bob-9b0c"; "Pound-1344" -> "Fred-e98a"; } .. note:: The extra lines in the above output are an ASCII representation of the above graph (*produced by pydot + graphviz*). Cool :-) Component Inheritance --------------------- Since circuits is a framework written for the `Python Programming Language`_ it naturally inherits properties of Object Orientated Programming (OOP) -- such as inheriaence. So let's take our ``Bob`` and ``Fred`` components and create a Base Component called ``Dog`` and modify our two dogs (``Bob`` and ``Fred``) to subclass this. .. literalinclude:: 006.py :language: python :linenos: :download:`Download 006.py <006.py>` Now let's try to run this and see what happens:: Woof! I'm Bob! Woof! I'm Fred! So both dogs barked! Hmmm Component Channels ------------------ What if we only want one of our dogs to bark? How do we do this without causing the other one to bark as well? Easy! Use a separate ``channel`` like so: .. literalinclude:: 007.py :language: python :linenos: :download:`Download 007.py <007.py>` .. note:: Events can be fired with either the ``.fire(...)`` or ``.fireEvent(...)`` method. If you run this, you'll get:: Woof! I'm Bob! Event Objects ------------- So far in our tutorial we have been defining an Event Handler for a builtin Event called ``Started`` (*which incidentally gets fired on a channel called "started"*). What if we wanted to define our own Event Handlers and our own Events? You've already seen how easy it is to create a new Event Handler by simply defining a normal Python method on a Component. Defining your own Events helps with documentation and testing and makes things a little easier. Example:: class MyEvent(Event): """MyEvent""" So here's our example where we'll define a new Event called ``Bark`` and make our ``Dog`` fire a ``Bark`` event when our application starts up. .. literalinclude:: 008.py :language: python :linenos: :download:`Download 008.py <008.py>` If you run this, you'll get:: Woof! I'm Bob! Woof! I'm Fred! The Debugger ------------ Lastly... Asynchronous programming has many advantages but can be a little harder to write and follow. A silently caught exception in an Event Handler, or an Event that never gets fired, or any number of other weird things can cause your application to fail and leave you scratching your head. Fortunately circuits comes with a ``Debugger`` Component to help you keep track of what's going on in your application, and allows you to tell what your application is doing. Let's say that we defined out ``bark`` Event Handler in our ``Dog`` Component as follows:: def bark(self): print("Woof! I'm %s!" % name) Now clearly there is no such variable as ``name`` in the local scope. For reference here's the entire example... .. literalinclude:: 009.py :language: python :linenos: :download:`Download 009.py <009.py>` If you run this, you'll get: That's right! You get nothing! Why? Well in circuits any error or exception that occurs in a running application is automatically caught and dealt with in a way that lets your application "keep on going". Crashing is unwanted behavior in a system so we expect to be able to recover from horrible situations. SO what do we do? Well that's easy. circuits comes with a ``Debugger`` that lets you log all events as well as all errors so you can quickly and easily discover which Event is causing a problem and which Event Handler to look at. If you change Line 34 of our example... From: .. literalinclude:: 009.py :language: python :lines: 34 To: .. code-block:: python from circuits import Debugger (Pound() + Debugger()).run() Then run this, you'll get the following:: , ] {}> , ] {}> , ] {}> , None] {}> , NameError("global name 'name' is not defined",), [' File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent\n retval = handler(*eargs, **ekwargs)\n', ' File "source/tutorial/009.py", line 22, in bark\n print("Woof! I\'m %s!" % name)\n'], >] {}> ERROR (): global name 'name' is not defined File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent retval = handler(*eargs, **ekwargs) File "source/tutorial/009.py", line 22, in bark print("Woof! I'm %s!" % name) , NameError("global name 'name' is not defined",), [' File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent\n retval = handler(*eargs, **ekwargs)\n', ' File "source/tutorial/009.py", line 22, in bark\n print("Woof! I\'m %s!" % name)\n'], >] {}> ERROR (): global name 'name' is not defined File "/home/prologic/work/circuits/circuits/core/manager.py", line 459, in __handleEvent retval = handler(*eargs, **ekwargs) File "source/tutorial/009.py", line 22, in bark print("Woof! I'm %s!" % name) ^C] {}> ] {}> ] {}> You'll notice whereas there was no output before there is now a pretty detailed output with the ``Debugger`` added to the application. Looking through the output, we find that the application does indeed start correctly, but when we fire our ``Bark`` Event it coughs up two exceptions, one for each of our dogs (``Bob`` and ``Fred``). From the error we can tell where the error is and roughly where to look in the code. .. note:: You'll notice many other events that are displayed in the above output. These are all default events that circuits has builtin which your application can respond to. Each builtin Event has a special meaning with relation to the state of the application at that point. See: :py:mod:`circuits.core.events` for detailed documentation regarding these events. The correct code for the ``bark`` Event Handler should be:: def bark(self): print("Woof! I'm %s!" % self.name) Running again with our correction results in the expected output:: Woof! I'm Bob! Woof! I'm Fred! That's it folks! Hopefully this gives you a feel of what circuits is all about and an easy tutorial on some of the basic concepts. As you're no doubt itching to get started on your next circuits project, here's some recommended reading: - :doc:`../faq` - :doc:`../howtos/index` - :doc:`../api/index` circuits-2.1.0/docs/source/tutorial/001.py0000644000014400001440000000011112072034467020033 0ustar prologicusers#!/usr/bin/env python from circuits import Component Component().run() circuits-2.1.0/docs/source/tutorial/002.py0000644000014400001440000000020112072034467020034 0ustar prologicusers#!/usr/bin/env python from circuits import Component class MyComponent(Component): """My Component""" MyComponent().run() circuits-2.1.0/docs/source/tutorial/003.py0000644000014400001440000000024712072034467020047 0ustar prologicusers#!/usr/bin/env python from circuits import Component class MyComponent(Component): def started(self, *args): print("Hello World!") MyComponent().run() circuits-2.1.0/docs/source/tutorial/004.py0000644000014400001440000000037412072034467020051 0ustar prologicusers#!/usr/bin/env python from circuits import Component class Bob(Component): def started(self, *args): print("Hello I'm Bob!") class Fred(Component): def started(self, *args): print("Hello I'm Fred!") (Bob() + Fred()).run() circuits-2.1.0/docs/source/tutorial/005.py0000644000014400001440000000077612072034467020060 0ustar prologicusers#!/usr/bin/env python from circuits import Component from circuits.tools import graph class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) def started(self, *args): print(graph(self.root)) class Bob(Component): def started(self, *args): print("Hello I'm Bob!") class Fred(Component): def started(self, *args): print("Hello I'm Fred!") Pound().run() circuits-2.1.0/docs/source/tutorial/006.py0000644000014400001440000000076512072034467020057 0ustar prologicusers#!/usr/bin/env python from circuits import Component, Event class Woof(Event): """Woof Event""" class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) def started(self, *args): self.fire(Woof()) class Dog(Component): def woof(self): print("Woof! I'm %s!" % self.name) class Bob(Dog): """Bob""" class Fred(Dog): """Fred""" Pound().run() circuits-2.1.0/docs/source/tutorial/007.py0000644000014400001440000000105212072034467020046 0ustar prologicusers#!/usr/bin/env python from circuits import Component, Event class Woof(Event): """Woof Event""" class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) def started(self, *args): self.fire(Woof(), self.bob) class Dog(Component): def woof(self): print("Woof! I'm %s!" % self.name) class Bob(Dog): """Bob""" channel = "bob" class Fred(Dog): """Fred""" channel = "fred" Pound().run() circuits-2.1.0/docs/source/tutorial/008.py0000644000014400001440000000103312072034467020046 0ustar prologicusers#!/usr/bin/env python from circuits import Component, Event class Bark(Event): """Bark Event""" class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) class Dog(Component): def started(self, *args): self.fire(Bark()) def bark(self): print("Woof! I'm %s!" % self.name) class Bob(Dog): """Bob""" channel = "bob" class Fred(Dog): """Fred""" channel = "fred" Pound().run() circuits-2.1.0/docs/source/tutorial/009.py0000644000014400001440000000102612072034467020051 0ustar prologicusers#!/usr/bin/env python from circuits import Component, Event class Bark(Event): """Bark Event""" class Pound(Component): def __init__(self): super(Pound, self).__init__() self.bob = Bob().register(self) self.fred = Fred().register(self) class Dog(Component): def started(self, *args): self.fire(Bark()) def bark(self): print("Woof! I'm %s!" % name) class Bob(Dog): """Bob""" channel = "bob" class Fred(Dog): """Fred""" channel = "fred" Pound().run() circuits-2.1.0/docs/source/users.rst0000644000014400001440000000175412072034467017227 0ustar prologicusersUsers ===== Applications written in circuits -------------------------------- - `SahrisWiki `_ a Wiki / CMS / Blogging Engine. - `kdb `_ a pluggable IRC Bot Framework. Applications integrating circuits --------------------------------- - `realXtend `) Next generation virtual worlds viewer; Naali, for Python components. Worked on by Toni Alatalo and Petri Aura at `Playsign ` in collaboration with other realXtend developers. - `PriceWaterHouseCoopers `) `TAMS `_ Report Generator written by James Mills and Michael Anton. - `Mangahelpers `_ Profiler for checking our webpages generation times, SQL and cache queries times, project page on Other Users ----------- - `MIT Media Lab, `_ Uses circuits for several internal prototypes circuits-2.1.0/docs/source/changes.rst0000644000014400001440000002526512113343751017474 0ustar prologicusers:tocdepth: 2 .. _changes: ChangeLog ========= .. include:: ../../CHANGES.rst circuits-2.0.1 20121124 ----------------------- - Fixed ``tests/web/test_main.py`` which was badly written. - Fixed a regression test testing the Debugger component circuits-2.0.0 20121122 (cheetah) --------------------------------- - Fixed circuits.web entry point - Fixed `tools.reprhandler()` for compatibility with Python-3.3 - Added ``*channels`` support to waitEvent - Added example of using .call - Fixed logic around firing the Daemonize event when registering this component during run-time and after start-up - Fixed use of reprhandler - Fixed listening channel for exceptions/errors. - Fixed channels for Log event. - Fixed config loading. Fire a Ready event when the Environment is completely ready. - Added .items(...) method to Config component. - Added BaseEvent, LiteralEvent, DerivedEvent to the core and circuits name-spaces - Fixed IRC protocol - Added has_option to Config component - Avoid error if user un-registers a component twice. - Fixed base_url for WebConsole - Fixed bug with sending Response for a Expect: 100-continue (Closes issue #32) - Added a new circuits.web test that ensures that large posts > 1024 bytes work - Updated conf so that doc can be built even if circuits isn't installed - Updated reference of guide to howtos - Updated man headers so that they weren't all "Components" - Fixed all web dispatcher tests - Fixed XMLRPC dispatcher. Must have a higher priority than the "default" dispatcher in order to coexist with it. - Fixed unit test for failure response from web *component* (component's handler must have higher priority than default dispatcher if default dispatcher exists). - Added failure test for web *controller*. - Fixed JSON dispatcher. Must have a higher priority than the "default" dispatcher in order to coexist with it. - Fixed vpath traversal. vpath created in reverse ("test_args/1/2/3" became "3/2/1/test_args"). - Fixed evaluation of the Complete event: exclude events fired by other threads during event processing from the set of events to be tracked. - Don't call tick on components that are waiting to be unregistered. - Using new PrepareUnregister event to reliably remove sockets from poller. - Fixes for PrepareUnregister and added test case. - Added event that informs components about going to be removed from the tree. - Fixed client request generation (MUST include Host header). - Fixed channel naming in web.Client to allow several clients (i.e. connections to web sites) to coexist in an application. - Prevented uncameling of event names that represent web requests. Handlers can now use the last path segment unmodified as handled event's name. - Fixed the new dispatcher with new tests - Fixed bug in complete event generation. - Added optional event signaling the completion of an event and everything that has been caused by it. - Added the possibility to redirect the success events to other channels. - Updated documentation to reflect the new "handler suspend" feature. - Replaced web dispatcher with simpler version - Added support for x = yield self.callEvent(...) - Made test_main more reliable - Removed old BaseManager from playing with GreenletManager. Fixed test_manager_repr - Fixed the exceptions being thrown for test_eval, but the test still fails - Added a new failing test - evaluation of promised values - Removed superfluous .value in test_longwait - Added support for alllowing future handlers to have a "special" event parameter just like ordinary handlers. - Fixed test_success - Fixed test_removeHandler - Added support for firing Done() and Success() after all done executing. - Fixed callEvent - Added 2 failing tests for yield - Implemented promises which we detect for in circuits.web in cases where an event handler yields. Also only fire _success events after an event is well and truly finished (in the case of yielding event handlers) - Fixed a bug with value not being set - Fixed Issue #26 - Added capability of waiting for a specific event name on a specific channel. - Fixed bug guarding against tasks already removed. - Implemented Component.init() support whereby one can define an alternative init() without needing to remember to call super(...) - Fixed Python 3 compatibility with Unicode strings - Added 99bottles as an example of concurrency. See: http://wiki.python.org/moin/Concurrency/99Bottles - Removed old-style channel targeting - Fixed and tested UDP forwarding - Simplified udpclient example - Implemented new version of port forwarded. TCP tested. - Fixed Read events for UDPServer by setting .notify to True. - Restructured the only How To Guide - Building a Simple Server - Renamed _get_request_handler to just find_handler - Removed channels attribute from WebEvents (fix for issue #29). - Added Eclipse configuration files. - Fixed uses of deprecated syntax in app.config - Modified the defaults for channels. Set channels to event.channels, otherwise self.channel defaulting to * - Fixed uses of deprecated syntax in env - Fixed a bug with the Redirect event/error in circuits.web where it didn't handle Unicode strings - fixed the web dispatcher - Fixed test_poller_reuse test by using the now findtype() utility function - fixed and adds tests for the web dispatcher - Moved parseBody out into circuits.web.utils. Other code cleanup - Added a test for a bug with the dispatcher mehere found. - Removed itercmp() function. Added findtype() findchannel() and used better variable names. findcmp is an alias of findtype. - Implemented optional singleton support for components - Removed the circuits.web `routes` dispatcher as there are no tests for this and Routes dispatcher is broken - re implement at a later stage - Removal of End feedback event - Fixed web/test_value.py - Fixed web futures test - Simplified and fixed a lot of issues the circuits.bench - Fixed circuits.web's exceptions tests and handling of exceptions. - Fixed a potential bug with ``circuits.web.wsgi.Application``. - Modified Manager to only assign a handler return value if it is not None. - Fixed ``*_success`` and ``*_failure`` events fire on ``*event.channels`` so they go to the right place as expected. Fixed Issue #21 - Removed event equality test and related tests. Seems rather useless and inconsistently used - Fixed test_gzip circuits.web test. We no longer have a Started event feedback so have to use a filter - Fixed a corner case where one might be trying to compare an event object with a non-event object - Fixed the event handling for circuits.web WebSockets Component by separating out the WebSockets handling from the HTTP handling (WebSocketsMediator). - Fixed use of Value notification in circuits.web for requests. - Fixed a bunch of examples and tests using deprecated features. - Fixed the notify io driver and removed Debugger() from test_notify. - Added man pages for circuits.bench, circuits.sniff and circuits.web - Wrapped UNIX-specific calls in try/except - Tidied up examples and removed unused imports - removed use of coverage module in daemon test - removed use of coverage module in signals test - updated .push calls to .fire calls - Fixed some deprecations warnings - Added support for multiple webserver with different channels + tests for it - Added support for silently ignoring errors when writing to stderr from debugger - Added requirements.txt file containing requirements for building docs on readthedocs.org - Added link to Read the Docs for circuits - Updated doc message for success event - Fixed interrupt handler to allow ^C to be used to quit sample keyecho app - Removed deprecated modules and functions that were deprecated 1.6 - Deleted old style event success/failure notifiers - Fixed handling of components being added/removed when looking for ticks - Fixed bug with ``net.Server`` .host and .port attributes. - Deprecated ``__tick__``. Event handlers can now be specified as **tick** functions. - Fixed handler priority inheritance to make sure we get the results in the right harder - Fixed missing import of sys in circuits.io circuits-1.6 (oceans) - 20110626 -------------------------------- - Added Python 3 support - 80% Code Coverage - Added optional greenlet support adding two new primitives. ``.waitEvent(...)`` and ``.callEvent(...)``. - Added an example WebSockets server using circuits.web - Added support for specifying a ``Poll`` instance to use when using the ``@future`` decorator to create "future" event handlers. - Added ``add_section``, ``has_section`` and ``set`` methods to ``app.config.Config`` Component. - Added support for running test suite with distutils ``python setup.py test``. - Added a ``_on_signal`` event handler on the ``BaseEnvironment`` Component so that environments can be reloaded by listening to ``SIGHUP`` signals. - Added support for using absolute paths in ``app.env.Environment``. - Added support in circuits.web ``HTTP`` protocol to limit the no. of header fragments. This prevents OOM exploits. - Added a ticks limit to waitEvent - Added deprecation warnings for .push .add and .remove methods - NEW ``Loader`` Component in ``circuits.core`` for simple plugin support. - NEW ``app.env`` and ``app.config`` modules including a new ``app.startup`` modules integrating a common startup for applications. - NEW ``KQueue`` poller - Fixed :bbissue:`17` - Renamed ``circuits.web.main`` module to ``circuits.web.__main__`` so that ``python -m circuits.web`` just works. - Fixed ``Server.host`` and ``Server.port`` properties in ``circuits.net.sockets``. - Fixed :bbissue:`10` - Fixed ``app.Daemon`` Component to correctly open the stderr file. - Fixed triggering of ``Success`` events. - Fixed duplicate broadcast handler in ``UDPServer`` - Fixed duplicate ``Disconnect`` event from being triggered twice on ``Client`` socket components. - Removed dynamic timeout code from ``Select`` poller. - Fixed a bug in the circuits.web ``HTTP`` protocol where headers were not being buffered per client. - Fixes a missing Event ``Closed()`` not being triggered for ``UDPServer``. - Make underlying ``UDPServer`` socket reusable by setting ``SO_REUSEADDR`` - Fixes Server socket being discarded twice on close + disconnect - Socket.write now expects bytes (bytes for python3 and str for python2) - Better handling of encoding in HTTP Component (allow non utf-8 encoding) - Always encode HTTP headers in utf-8 - Fixes error after getting socket.ERRCONNREFUSED - Allows TCPClient to bind to a specific port - Improved docs - Handles closing of UDPServer socket when no client is connected - Adds an un-register handler for components - Allows utils.kill to work from a different thread - Fixes bug when handling "*" in channels and targets - Fixes a bug that could occur when un-registering components - Fixes for CPU usage problems when using circuits with no I/O pollers and using a Timer for timed events circuits-2.1.0/Makefile0000644000014400001440000000202712113366526014536 0ustar prologicusers.PHONY: help clean docs graph packages tests help: @echo "Please use \`make ' where is one of" @echo " clean to cleanup build and temporary files" @echo " docs to build the documentation" @echo " graph to generate dependency graph" @echo " packages to build python source and egg packages" @echo " tests to run the test suite" clean: @rm -rf build dist circuits.egg-info circuits/__version__.py @rm -rf .coverage coverage @rm -rf docs/build @find . -name '*.pyc' -delete @find . -name '*.pyo' -delete @find . -name '*~' -delete docs: @make -C docs html graph: @sfood circuits -i -I tests -d -u 2> /dev/null | sfood-graph | dot -Tps | ps2pdf - > circuits.pdf release: @python2.6 setup.py clean bdist_egg upload @python2.7 setup.py clean bdist_egg upload @python3.2 setup.py clean bdist_egg upload @python3.3 setup.py clean bdist_egg upload @python setup.py clean build_sphinx upload_sphinx @python setup.py clean sdist --formats=bztar,gztar,zip upload tests: @python -m tests.main circuits-2.1.0/RELEASE.rst0000644000014400001440000000050312113364644014704 0ustar prologicusersRelease Notes - circuits-2.1.0 () ------------------------------------------ This release adds the following new features to circuits: - Python 3 support. - Windows support. - PyPy support. - IPv6 support. - Better WSGI support. - Fully documented examples. - Component Interface querying. And many bug fixes! circuits-2.1.0/LICENSE0000644000014400001440000000211612072034467014102 0ustar prologicusersCopyright (C) 2004-2012 James Mills Circuits is covered by the MIT license:: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. circuits-2.1.0/tests/0000755000014400001440000000000012113366740014235 5ustar prologicuserscircuits-2.1.0/tests/io/0000755000014400001440000000000012113366740014644 5ustar prologicuserscircuits-2.1.0/tests/io/test_notify.py0000644000014400001440000000214012113343751017557 0ustar prologicusers#!/usr/bin/env python import pytest pytest.importorskip("pyinotify") from circuits.io.notify import Notify, AddPath, RemovePath from circuits import Component, handler class App(Component): def __init__(self, *args, **kwargs): super(App, self).__init__() self.add_path = False self.remove_path = False self.created = False def add_path(self, path): self.add_path = True def remove_path(self, path): self.remove_path = True @handler('created', channel='notify') def created(self, *args, **kwargs): self.created = True def test_notify(tmpdir): app = App() Notify().register(app) app.start() try: app.fire(AddPath(str(tmpdir))) pytest.wait_for(app, 'add_path') tmpdir.ensure("helloworld.txt") assert pytest.wait_for(app, 'created') app.created = False app.fire(RemovePath(str(tmpdir))) pytest.wait_for(app, 'remove_path') tmpdir.ensure("helloworld2.txt") assert not pytest.wait_for(app, 'created') finally: app.stop() assert True circuits-2.1.0/tests/io/test_file.py0000644000014400001440000000246112113343751017174 0ustar prologicusers#!/usr/bin/env python import pytest if pytest.PLATFORM == "win32": pytest.skip("Unsupported Platform") from io import BytesIO from circuits import Component from circuits.io import File, Write, Close class FileApp(Component): def init(self, *args, **kwargs): self.file = File(*args, **kwargs).register(self) self.eof = False self.buffer = BytesIO() def read(self, data): self.buffer.write(data) def eof(self): self.eof = True def test_read_write(manager, watcher, tmpdir): filename = str(tmpdir.ensure("helloworld.txt")) app = FileApp(filename, "w").register(manager) assert watcher.wait("opened", app.file.channel) app.fire(Write(b"Hello World!"), app.file.channel) assert watcher.wait("write", app.file.channel) app.fire(Close(), app.file.channel) assert watcher.wait("closed", app.file.channel) app.unregister() assert watcher.wait("unregistered") app = FileApp(filename, "r").register(manager) assert watcher.wait("opened", app.file.channel) assert watcher.wait("eof", app.file.channel) app.fire(Close(), app.file.channel) assert watcher.wait("closed", app.file.channel) app.unregister() assert watcher.wait("unregistered") s = app.buffer.getvalue() assert s == b"Hello World!" circuits-2.1.0/tests/io/test_process.py0000644000014400001440000000070512113343751017732 0ustar prologicusers#!/usr/bin/env python import pytest if pytest.PLATFORM == "win32": pytest.skip("Unsupported Platform") from circuits.io import Process, Start def test(manager, watcher): p = Process(["echo", "Hello World!"]).register(manager) assert watcher.wait("registered") p.fire(Start()) assert watcher.wait("started", p.channel) assert watcher.wait("stopped", p.channel) s = p.stdout.getvalue() assert s == b"Hello World!\n" circuits-2.1.0/tests/io/__init__.py0000644000014400001440000000000012072034467016745 0ustar prologicuserscircuits-2.1.0/tests/app/0000755000014400001440000000000012113366740015015 5ustar prologicuserscircuits-2.1.0/tests/app/test_config.py0000644000014400001440000000310212113343751017664 0ustar prologicusers#!/usr/bin/env python import pytest from circuits.app.config import Config, Load CONFIG = """\ [test] foo = bar int = 1 float = 1.0 bool = 1 """ @pytest.fixture(scope="function") def config_file(tmpdir): f = tmpdir.ensure("test.ini") f.write(CONFIG) return str(f) @pytest.fixture(scope="function") def config(request, manager, watcher, config_file): config = Config(config_file).register(manager) def finalizer(): config.unregister() request.addfinalizer(finalizer) manager.fire(Load(), config.channel) flag = watcher.wait("load_success") assert flag # This ensures the tests pass. WTF?! from time import sleep sleep(0.1) return config def test_add_section(config): config.add_section("foo") has_foo = config.has_section("foo") assert has_foo def test_has_section(config): has_test = config.has_section("test") assert has_test def test_get(config): foo = config.get("test", "foo") assert foo == "bar" asdf = config.get("test", "asdf", "foobar") assert asdf == "foobar" def test_get_int(config): one = config.getint("test", "int") assert one == 1 ottf = config.getint("test", "asdf", 1234) assert ottf == 1234 def test_get_float(config): opz = config.getfloat("test", "float") assert opz == 1.0 ottfpottf = config.getfloat("test", "asdf", 1234.1234) assert ottfpottf == 1234.1234 def test_get_bool(config): boolean = config.getboolean("test", "bool") assert boolean asdf = config.getboolean("test", "asdf", False) assert not asdf circuits-2.1.0/tests/app/test_daemon.py0000644000014400001440000000143712113343751017673 0ustar prologicusers#!/usr/bin/env python import pytest if pytest.PLATFORM == "win32": pytest.skip("Unsupported Platform") import os import sys import errno from time import sleep from signal import SIGTERM from subprocess import Popen from tests.app import app def test(tmpdir): tmpdir.ensure("app.pid") pid_path = tmpdir.join("app.pid") args = [sys.executable, app.__file__, str(pid_path)] Popen(args, env={'PYTHONPATH': ':'.join(sys.path)}).wait() sleep(1) assert pid_path.check(exists=True, file=True) pid = None with pid_path.open() as f: pid = int(f.read().strip()) assert isinstance(pid, int) assert pid > 0 os.kill(pid, SIGTERM) try: os.waitpid(pid, os.WTERMSIG(0)) except OSError as e: assert e.args[0] == errno.ECHILD circuits-2.1.0/tests/app/test_logger.py0000644000014400001440000000454512113343751017712 0ustar prologicusers#!/usr/bin/env python import sys import pytest if "__pypy__" in sys.modules: pytest.skip("Broken on pypy") from time import strftime from circuits import Event, Component from circuits.app.log import Log, Logger LEVELS = list(Logger.LEVELS.keys()) class Test(Event): """Test Event""" class App(Component): def test(self, level="debug"): self.fire(Log(level, "Hello World!")) def test(tmpdir): filepath = tmpdir.ensure("test.log") filename = str(filepath) app = App() logger = Logger(filename, "test", "file", "DEBUG") logger.register(app) while app: app.flush() f = open(filename, "r+") def test(f, level="debug"): app.fire(Test(level)) while app: app.flush() now = strftime("%H:%M:%S") f.seek(0) s = f.read().strip() if level == "exception": level = "error" elif level == "warn": level = "warning" assert s == "%s test[log] %s: Hello World!" % (now, level.upper()) or \ s[(len(now) + 1):] == ( "test[log] %s: Hello World!" % (level.upper()) ) for level in LEVELS: f.seek(0) f.truncate() test(f, level) def test_direct(tmpdir): filepath = tmpdir.ensure("test.log") filename = str(filepath) logger = Logger(filename, "test", "file", "DEBUG") f = open(filename, "r+") def test(f, level="debug"): getattr(logger, level)("Hello World!") f.seek(0) now = strftime("%H:%M:%S") s = f.read().strip() if level == "warn": level = "warning" if level == "exception": assert s[:len(now)+31] == ( "{0:s} test[log] ERROR: Hello World!\n".format(now) ) or s[(len(now) + 1):(len(now) + 1)+31] == ( "test[log] ERROR: Hello World!\n" ) else: assert s == ( "%s test[log] %s: Hello World!" % (now, level.upper()) or s[(len(now) + 1):] == ( "test[log] %s: Hello World!" % level.upper() ) ) for level in LEVELS: f.seek(0) f.truncate() if level == 'exception': try: raise Exception() except: test(f, level) else: test(f, level) circuits-2.1.0/tests/app/app.py0000644000014400001440000000121312113343751016141 0ustar prologicusers#!/usr/bin/env python import os import sys try: from coverage import coverage HAS_COVERAGE = True except ImportError: HAS_COVERAGE = False from circuits import Component from circuits.app import Daemon class App(Component): def __init__(self, pidfile): super(App, self).__init__() Daemon(pidfile).register(self) def main(): if HAS_COVERAGE: _coverage = coverage(data_suffix=True) _coverage.start() pidfile = os.path.abspath(sys.argv[1]) app = App(pidfile) app.run() if HAS_COVERAGE: _coverage.stop() _coverage.save() if __name__ == "__main__": main() circuits-2.1.0/tests/app/test_env.py0000644000014400001440000000565412113343751017225 0ustar prologicusers#!/usr/bin/env python import pytest def pytest_funcarg__path(request): tmpdir = request.getfuncargvalue("tmpdir") return tmpdir.join("env") def pytest_funcarg__env(request): return request.cached_setup( setup=lambda: setup_env(request), teardown=lambda env: teardown_env(env), scope="function" ) def setup_env(request): from circuits.app.env import Environment path = request.getfuncargvalue("path") env = Environment(str(path), "test") env.start() return env def teardown_env(env): env.stop() def test_create(env, path): from circuits.app.env import Create waiter = pytest.WaitEvent(env, "create_success") env.fire(Create()) assert waiter.wait() files = ("conf/test.ini", "README", "VERSION") for filename in files: assert path.join(filename).check(exists=True, file=True) def test_load(env, path): from circuits.app.env import Create, Load waiter = pytest.WaitEvent(env, "create_success") env.fire(Create()) assert waiter.wait() files = ("conf/test.ini", "README", "VERSION") for filename in files: assert path.join(filename).check(exists=True, file=True) waiter = pytest.WaitEvent(env, "load_success") env.fire(Load()) assert waiter.wait() def test_load_verify(env, path): from circuits.app.env import Create, Load waiter = pytest.WaitEvent(env, "create_success") env.fire(Create()) assert waiter.wait() files = ("conf/test.ini", "README", "VERSION") for filename in files: assert path.join(filename).check(exists=True, file=True) waiter = pytest.WaitEvent(env, "load_success") env.fire(Load(verify=True)) assert waiter.wait() def test_load_verify_fail(env, path): from circuits.app.env import Create, Load from circuits.app.env import EnvironmentError, ERRORS waiter = pytest.WaitEvent(env, "create_success") env.fire(Create()) assert waiter.wait() files = ("conf/test.ini", "README", "VERSION") for filename in files: assert path.join(filename).check(exists=True, file=True) path.join("VERSION").write("") waiter = pytest.WaitEvent(env, "verify_failure") v = env.fire(Load(verify=True)) assert waiter.wait() assert isinstance(v[1], EnvironmentError) assert v[1].args == ERRORS[0] def test_load_verify_upgrade(env, path): from circuits.app.env import Create, Load from circuits.app.env import EnvironmentError, ERRORS waiter = pytest.WaitEvent(env, "create_success") env.fire(Create()) assert waiter.wait() files = ("conf/test.ini", "README", "VERSION") for filename in files: assert path.join(filename).check(exists=True, file=True) env.version = 100 waiter = pytest.WaitEvent(env, "verify_failure") v = env.fire(Load(verify=True)) assert waiter.wait() assert isinstance(v[1], EnvironmentError) assert v[1].args == ERRORS[1] circuits-2.1.0/tests/app/__init__.py0000644000014400001440000000000012072034467017116 0ustar prologicuserscircuits-2.1.0/tests/net/0000755000014400001440000000000012113366740015023 5ustar prologicuserscircuits-2.1.0/tests/net/server.py0000644000014400001440000000153412113343751016703 0ustar prologicusersfrom circuits import Component from circuits.net.sockets import Write class Server(Component): channel = "server" def __init__(self): super(Server, self).__init__() self.data = "" self.host = None self.port = None self.client = None self.ready = False self.closed = False self.connected = False self.disconnected = False def ready(self, server, bind): self.ready = True self.host, self.port = bind def closed(self): self.closed = True def connect(self, sock, *args): self.connected = True self.client = args self.fire(Write(sock, b"Ready")) def disconnect(self, sock): self.client = None self.disconnected = True def read(self, sock, data): self.data = data return data circuits-2.1.0/tests/net/test_unix.py0000644000014400001440000000361312072034467017424 0ustar prologicusers#!/usr/bin/env python import os import sys import pytest if sys.platform in ("win32", "cygwin"): pytest.skip("Test Not Applicable on Windows") from circuits import Manager from circuits.core.pollers import Select from circuits.net.sockets import Close, Connect, Write from circuits.net.sockets import UNIXServer, UNIXClient from .client import Client from .server import Server def pytest_generate_tests(metafunc): metafunc.addcall(funcargs={"Poller": Select}) try: from circuits.core.pollers import Poll Poll() metafunc.addcall(funcargs={"Poller": Poll}) except AttributeError: pass try: from circuits.core.pollers import EPoll EPoll() metafunc.addcall(funcargs={"Poller": EPoll}) except AttributeError: pass try: from circuits.core.pollers import KQueue KQueue() metafunc.addcall(funcargs={"Poller": KQueue}) except AttributeError: pass def test_unix(tmpdir, Poller): m = Manager() + Poller() sockpath = tmpdir.ensure("test.sock") filename = str(sockpath) server = Server() + UNIXServer(filename) client = Client() + UNIXClient() server.register(m) client.register(m) m.start() try: assert pytest.wait_for(server, "ready") assert pytest.wait_for(client, "ready") client.fire(Connect(filename)) assert pytest.wait_for(client, "connected") assert pytest.wait_for(server, "connected") assert pytest.wait_for(client, "data", b"Ready") client.fire(Write(b"foo")) assert pytest.wait_for(server, "data", b"foo") client.fire(Close()) assert pytest.wait_for(client, "disconnected") assert pytest.wait_for(server, "disconnected") server.fire(Close()) assert pytest.wait_for(server, "closed") finally: m.stop() os.remove(filename) circuits-2.1.0/tests/net/test_client.py0000644000014400001440000000163012072034467017714 0ustar prologicusers#!/usr/bin/env python from socket import gaierror def test_client_bind_int(): from circuits.net.sockets import Client class TestClient(Client): def _create_socket(self): return None client = TestClient(1234) assert client._bind[1] == 1234 def test_client_bind_int_gaierror(monkeypatch): from circuits.net import sockets def broken_gethostname(): raise gaierror() monkeypatch.setattr(sockets, "gethostname", broken_gethostname) class TestClient(sockets.Client): def _create_socket(self): return None client = TestClient(1234) assert client._bind == ("0.0.0.0", 1234) def test_client_bind_str(): from circuits.net.sockets import Client class TestClient(Client): def _create_socket(self): return None client = TestClient("0.0.0.0:1234") assert client._bind == ("0.0.0.0", 1234) circuits-2.1.0/tests/net/test_tcp.py0000644000014400001440000001555212113343751017227 0ustar prologicusers#!/usr/bin/env python from socket import socket, AF_INET, AF_INET6, SOCK_STREAM, has_ipv6 import pytest from circuits import Manager from circuits.core.pollers import Select from circuits.net.sockets import TCPServer, TCP6Server, TCPClient, TCP6Client from circuits.net.sockets import Close, Connect, Write from .client import Client from .server import Server def wait_host(server): def checker(obj, attr): return all((getattr(obj, a) for a in attr)) assert pytest.wait_for(server, ("host", "port"), checker) def _pytest_generate_tests(metafunc, ipv6): metafunc.addcall(funcargs={"Poller": Select, "ipv6": ipv6}) try: from circuits.core.pollers import Poll Poll() metafunc.addcall(funcargs={"Poller": Poll, "ipv6": ipv6}) except AttributeError: pass try: from circuits.core.pollers import EPoll EPoll() metafunc.addcall(funcargs={"Poller": EPoll, "ipv6": ipv6}) except AttributeError: pass try: from circuits.core.pollers import KQueue KQueue() metafunc.addcall(funcargs={"Poller": KQueue, "ipv6": ipv6}) except AttributeError: pass def pytest_generate_tests(metafunc): _pytest_generate_tests(metafunc, ipv6=False) if has_ipv6: _pytest_generate_tests(metafunc, ipv6=True) def test_tcp_basic(Poller, ipv6): from circuits import Debugger m = Manager() + Poller() + Debugger() if ipv6: tcp_server = TCP6Server(("::1", 0)) tcp_client = TCP6Client() else: tcp_server = TCPServer(0) tcp_client = TCPClient() server = Server() + tcp_server client = Client() + tcp_client server.register(m) client.register(m) m.start() try: assert pytest.wait_for(client, "ready") assert pytest.wait_for(server, "ready") wait_host(server) client.fire(Connect(server.host, server.port)) assert pytest.wait_for(client, "connected") assert pytest.wait_for(server, "connected") assert pytest.wait_for(client, "data", b"Ready") client.fire(Write(b"foo")) assert pytest.wait_for(server, "data", b"foo") assert pytest.wait_for(client, "data", b"foo") client.fire(Close()) assert pytest.wait_for(client, "disconnected") assert pytest.wait_for(server, "disconnected") server.fire(Close()) assert pytest.wait_for(server, "closed") finally: m.stop() def test_tcp_reconnect(Poller, ipv6): ### XXX: Apparently this doesn't work on Windows either? ### XXX: UPDATE: Apparently Broken on Windows + Python 3.2 ### TODO: Need to look into this. Find out why... if pytest.PLATFORM == "win32" and pytest.PYVER[:2] == (3, 2): pytest.skip("Broken on Windows on Python 3.2") m = Manager() + Poller() if ipv6: tcp_server = TCP6Server(("::1", 0)) tcp_client = TCP6Client() else: tcp_server = TCPServer(0) tcp_client = TCPClient() server = Server() + tcp_server client = Client() + tcp_client server.register(m) client.register(m) m.start() try: assert pytest.wait_for(client, "ready") assert pytest.wait_for(server, "ready") wait_host(server) # 1st connect client.fire(Connect(server.host, server.port)) assert pytest.wait_for(client, "connected") assert pytest.wait_for(server, "connected") assert pytest.wait_for(client, "data", b"Ready") client.fire(Write(b"foo")) assert pytest.wait_for(server, "data", b"foo") # disconnect client.fire(Close()) assert pytest.wait_for(client, "disconnected") # 2nd reconnect client.fire(Connect(server.host, server.port)) assert pytest.wait_for(client, "connected") assert pytest.wait_for(server, "connected") assert pytest.wait_for(client, "data", b"Ready") client.fire(Write(b"foo")) assert pytest.wait_for(server, "data", b"foo") client.fire(Close()) assert pytest.wait_for(client, "disconnected") assert pytest.wait_for(server, "disconnected") server.fire(Close()) assert pytest.wait_for(server, "closed") finally: m.stop() def test_tcp_connect_closed_port(Poller, ipv6): ### FIXME: This test is wrong. ### We need to figure out the sequence of events on Windows ### for this scenario. I think if you attempt to connect to ### a shutdown listening socket (tcp server) you should get ### an error event as response. if pytest.PLATFORM == "win32": pytest.skip("Broken on Windows") m = Manager() + Poller() if ipv6: tcp_server = TCP6Server(("::1", 0)) tcp_client = TCP6Client() else: tcp_server = TCPServer(0) tcp_client = TCPClient() server = Server() + tcp_server client = Client() + tcp_client server.register(m) client.register(m) m.start() try: assert pytest.wait_for(client, "ready") assert pytest.wait_for(server, "ready") wait_host(server) host, port = server.host, server.port tcp_server._sock.close() # 1st connect client.fire(Connect(host, port)) assert pytest.wait_for(client, "connected") client.fire(Write(b"foo")) assert pytest.wait_for(client, "disconnected") client.disconnected = False client.fire(Write(b"foo")) assert pytest.wait_for(client, "disconnected", timeout=1.0) is None finally: m.stop() def test_tcp_bind(Poller, ipv6): m = Manager() + Poller() if ipv6: sock = socket(AF_INET6, SOCK_STREAM) sock.bind(("::1", 0)) sock.listen(5) _, bind_port, _, _ = sock.getsockname() sock.close() server = Server() + TCP6Server(("::1", 0)) client = Client() + TCP6Client() else: sock = socket(AF_INET, SOCK_STREAM) sock.bind(("", 0)) sock.listen(5) _, bind_port = sock.getsockname() sock.close() server = Server() + TCPServer(0) client = Client() + TCPClient() server.register(m) client.register(m) m.start() try: assert pytest.wait_for(client, "ready") assert pytest.wait_for(server, "ready") wait_host(server) client.fire(Connect(server.host, server.port)) assert pytest.wait_for(client, "connected") assert pytest.wait_for(server, "connected") assert pytest.wait_for(client, "data", b"Ready") #assert server.client[1] == bind_port client.fire(Write(b"foo")) assert pytest.wait_for(server, "data", b"foo") client.fire(Close()) assert pytest.wait_for(client, "disconnected") assert pytest.wait_for(server, "disconnected") server.fire(Close()) assert pytest.wait_for(server, "closed") finally: m.stop() circuits-2.1.0/tests/net/test_udp.py0000644000014400001440000000547012113343751017227 0ustar prologicusers#!/usr/bin/env python import pytest import socket from circuits import Manager from circuits.core.pollers import Select from circuits.core.events import Unregister from circuits.net.sockets import Close, Write from circuits.net.sockets import UDPServer, UDPClient, UDP6Server, UDP6Client from .client import Client from .server import Server def wait_host(server): def checker(obj, attr): return all((getattr(obj, a) for a in attr)) assert pytest.wait_for(server, ("host", "port"), checker) def _pytest_generate_tests(metafunc, ipv6): metafunc.addcall(funcargs={"Poller": Select, "ipv6": ipv6}) try: from circuits.core.pollers import Poll Poll() metafunc.addcall(funcargs={"Poller": Poll, "ipv6": ipv6}) except AttributeError: pass try: from circuits.core.pollers import EPoll EPoll() metafunc.addcall(funcargs={"Poller": EPoll, "ipv6": ipv6}) except AttributeError: pass try: from circuits.core.pollers import KQueue KQueue() metafunc.addcall(funcargs={"Poller": KQueue, "ipv6": ipv6}) except AttributeError: pass def pytest_generate_tests(metafunc): _pytest_generate_tests(metafunc, ipv6=False) if socket.has_ipv6: _pytest_generate_tests(metafunc, ipv6=True) def test_basic(Poller, ipv6): m = Manager() + Poller() if ipv6: udp_server = UDP6Server(("::1", 0)) udp_client = UDP6Client(("::1", 0), channel="client") else: udp_server = UDPServer(0) udp_client = UDPClient(0, channel="client") server = Server() + udp_server client = Client() + udp_client server.register(m) client.register(m) m.start() try: assert pytest.wait_for(server, "ready") assert pytest.wait_for(client, "ready") wait_host(server) client.fire(Write((server.host, server.port), b"foo")) assert pytest.wait_for(server, "data", b"foo") client.fire(Close()) assert pytest.wait_for(client, "closed") server.fire(Close()) assert pytest.wait_for(server, "closed") finally: m.stop() def test_close(Poller, ipv6): m = Manager() + Poller() server = Server() + UDPServer(0) server.register(m) m.start() try: assert pytest.wait_for(server, "ready") wait_host(server) host, port = server.host, server.port server.fire(Close()) assert pytest.wait_for(server, "disconnected") server.fire(Unregister(server)) def test(obj, attr): return attr not in obj.components assert pytest.wait_for(m, server, value=test) server = Server() + UDPServer((host, port)) server.register(m) assert pytest.wait_for(server, "ready", timeout=30.0) finally: m.stop() circuits-2.1.0/tests/net/client.py0000644000014400001440000000130212113343751016644 0ustar prologicusersfrom circuits import Component class Client(Component): channel = "client" def __init__(self, channel=channel): super(Client, self).__init__(channel=channel) self.data = "" self.ready = False self.closed = False self.connected = False self.disconnected = False def ready(self, *args): self.ready = True def connected(self, host, port): self.connected = True def disconnected(self): self.disconnected = True def closed(self): self.closed = True def read(self, *args): if len(args) == 2: _, data = args else: data = args[0] self.data = data circuits-2.1.0/tests/net/test_pipe.py0000644000014400001440000000202312113343751017363 0ustar prologicusers#!/usr/bin/env python import pytest if pytest.PLATFORM == "win32": pytest.skip("Unsupported Platform") from circuits import Manager from circuits.net.sockets import Pipe from circuits.core.pollers import Select from circuits.net.sockets import Close, Write from .client import Client def pytest_generate_tests(metafunc): metafunc.addcall(funcargs={"Poller": Select}) def test_pipe(Poller): m = Manager() + Poller() a, b = Pipe("a", "b") a.register(m) b.register(m) a = Client(channel=a.channel).register(m) b = Client(channel=b.channel).register(m) m.start() try: assert pytest.wait_for(a, "ready") assert pytest.wait_for(b, "ready") a.fire(Write(b"foo")) assert pytest.wait_for(b, "data", b"foo") b.fire(Write(b"foo")) assert pytest.wait_for(a, "data", b"foo") a.fire(Close()) assert pytest.wait_for(a, "disconnected") b.fire(Close()) assert pytest.wait_for(b, "disconnected") finally: m.stop() circuits-2.1.0/tests/net/test_poller_reuse.py0000644000014400001440000000076512113343751021141 0ustar prologicusers#!/usr/bin/env python from circuits import Manager from circuits.core.utils import findtype from circuits.core.pollers import BasePoller, Poller from circuits.net.sockets import TCPServer, TCPClient def test(): m = Manager() poller = Poller().register(m) TCPServer(0).register(m) TCPClient().register(m) m.start() try: pollers = findtype(m, BasePoller, all=True) assert len(pollers) == 1 assert pollers[0] is poller finally: m.stop() circuits-2.1.0/tests/net/__init__.py0000644000014400001440000000000012072034467017124 0ustar prologicuserscircuits-2.1.0/tests/net/protocols/0000755000014400001440000000000012113366740017047 5ustar prologicuserscircuits-2.1.0/tests/net/protocols/test_line.py0000644000014400001440000000230312072034467021407 0ustar prologicusers#!/usr/bin/env python from collections import defaultdict from circuits import Event, Component from circuits.net.protocols import LP class Read(Event): """Read Event""" class App(Component): lines = [] def line(self, line): self.lines.append(line) class AppServer(Component): channel = "server" lines = [] def line(self, sock, line): self.lines.append((sock, line)) def test(): app = App() LP().register(app) while app: app.flush() app.fire(Read(b"1\n2\r\n3\n4")) while app: app.flush() assert app.lines[0] == "1" assert app.lines[1] == "2" assert app.lines[2] == "3" def test_server(): app = AppServer() buffers = defaultdict(bytes) LP(getBuffer=buffers.__getitem__, updateBuffer=buffers.__setitem__).register(app) while app: app.flush() app.fire(Read(1, b"1\n2\r\n3\n4")) app.fire(Read(2, b"1\n2\r\n3\n4")) while app: app.flush() assert app.lines[0] == (1, "1") assert app.lines[1] == (1, "2") assert app.lines[2] == (1, "3") assert app.lines[3] == (2, "1") assert app.lines[4] == (2, "2") assert app.lines[5] == (2, "3") circuits-2.1.0/tests/net/protocols/test_irc.py0000644000014400001440000005132612072034467021246 0ustar prologicusers#!/usr/bin/env python from circuits import handler, Event, Component from circuits.net.protocols.irc import strip, sourceJoin, sourceSplit, IRC from circuits.net.protocols.irc import ( PASS, USER, NICK, PING, PONG, QUIT, JOIN, PART, PRIVMSG, NOTICE, CTCP, CTCPREPLY, KICK, TOPIC, MODE, INVITE, NAMES) class Read(Event): """Read Event""" class App(Component): def __init__(self): super(App, self).__init__() IRC().register(self) self.data = [] self.events = [] @handler(False) def reset(self): self.data = [] self.events = [] @handler(channel="*", priority=101.0) def event(self, event, *args, **kwargs): self.events.append(event) def write(self, data): self.data.append(data) def pytest_funcarg__app(request): return request.cached_setup( setup=lambda: setupapp(request), scope="module") def setupapp(request): app = App() while app: app.flush() app.reset() return app ### ### Test Functions (utility) ### def test_strip(): s = ":\x01\x02test\x02\x01" s = strip(s) assert s == "\x01\x02test\x02\x01" s = ":\x01\x02test\x02\x01" s = strip(s, color=True) assert s == "test" def test_sourceJoin(): nick, ident, host = "test", "foo", "localhost" s = sourceJoin(nick, ident, host) assert s == "test!foo@localhost" def test_sourceSplit(): s = "test!foo@localhost" nick, ident, host = sourceSplit(s) assert nick == "test" assert ident == "foo" assert host == "localhost" s = "test" nick, ident, host = sourceSplit(s) assert nick == "test" assert ident == None assert host == None ### ### Test IRC Commands ### def test_PASS(app): app.reset() app.fire(PASS("secret")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_pass" assert e.args[0] == "secret" e = next(events) assert e.name == "command_raw" assert e.args[0] == "PASS secret" e = next(events) assert e.name == "write" assert e.args[0] == "PASS secret\r\n" data = iter(app.data) s = next(data) assert s == "PASS secret\r\n" def test_USER(app): app.reset() app.fire(USER("foo", "localhost", "localhost", "Test Client")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_user" assert e.args[0] == "foo" assert e.args[1] == "localhost" assert e.args[2] == "localhost" assert e.args[3] == "Test Client" e = next(events) assert e.name == "command_raw" assert e.args[0] == "USER foo \"localhost\" \"localhost\" :Test Client" e = next(events) assert e.name == "write" assert e.args[0] == "USER foo \"localhost\" \"localhost\" :Test Client\r\n" data = iter(app.data) s = next(data) assert s == "USER foo \"localhost\" \"localhost\" :Test Client\r\n" def test_NICK(app): app.reset() app.fire(NICK("test")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_nick" assert e.args[0] == "test" e = next(events) assert e.name == "command_raw" assert e.args[0] == "NICK test" e = next(events) assert e.name == "write" assert e.args[0] == "NICK test\r\n" data = iter(app.data) s = next(data) assert s == "NICK test\r\n" def test_PING(app): app.reset() app.fire(PING("localhost")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_ping" assert e.args[0] == "localhost" e = next(events) assert e.name == "command_raw" assert e.args[0] == "PING :localhost" e = next(events) assert e.name == "write" assert e.args[0] == "PING :localhost\r\n" data = iter(app.data) s = next(data) assert s == "PING :localhost\r\n" def test_PONG(app): app.reset() app.fire(PONG("localhost")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_pong" assert e.args[0] == "localhost" e = next(events) assert e.name == "command_raw" assert e.args[0] == "PONG :localhost" e = next(events) assert e.name == "write" assert e.args[0] == "PONG :localhost\r\n" data = iter(app.data) s = next(data) assert s == "PONG :localhost\r\n" def test_QUIT(app): app.reset() app.fire(QUIT()) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_quit" assert not e.args e = next(events) assert e.name == "command_raw" assert e.args[0] == "QUIT :Leaving" e = next(events) assert e.name == "write" assert e.args[0] == "QUIT :Leaving\r\n" data = iter(app.data) s = next(data) assert s == "QUIT :Leaving\r\n" app.reset() app.fire(QUIT("Test")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_quit" assert e.args[0] == "Test" e = next(events) assert e.name == "command_raw" assert e.args[0] == "QUIT :Test" e = next(events) assert e.name == "write" assert e.args[0] == "QUIT :Test\r\n" data = iter(app.data) s = next(data) assert s == "QUIT :Test\r\n" def test_JOIN(app): app.reset() app.fire(JOIN("#test")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_join" assert e.args[0] == "#test" e = next(events) assert e.name == "command_raw" assert e.args[0] == "JOIN #test" e = next(events) assert e.name == "write" assert e.args[0] == "JOIN #test\r\n" data = iter(app.data) s = next(data) assert s == "JOIN #test\r\n" app.reset() app.fire(JOIN("#test", "secret")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_join" assert e.args[0] == "#test" assert e.args[1] == "secret" e = next(events) assert e.name == "command_raw" assert e.args[0] == "JOIN #test secret" e = next(events) assert e.name == "write" assert e.args[0] == "JOIN #test secret\r\n" data = iter(app.data) s = next(data) assert s == "JOIN #test secret\r\n" def test_PART(app): app.reset() app.fire(PART("#test")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_part" assert e.args[0] == "#test" e = next(events) assert e.name == "command_raw" assert e.args[0] == "PART #test :Leaving" e = next(events) assert e.name == "write" assert e.args[0] == "PART #test :Leaving\r\n" data = iter(app.data) s = next(data) assert s == "PART #test :Leaving\r\n" app.reset() app.fire(PART("#test", "Test")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_part" assert e.args[0] == "#test" assert e.args[1] == "Test" e = next(events) assert e.name == "command_raw" assert e.args[0] == "PART #test :Test" e = next(events) assert e.name == "write" assert e.args[0] == "PART #test :Test\r\n" data = iter(app.data) s = next(data) assert s == "PART #test :Test\r\n" def test_PRIVMSG(app): app.reset() app.fire(PRIVMSG("test", "Hello")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_privmsg" assert e.args[0] == "test" assert e.args[1] == "Hello" e = next(events) assert e.name == "command_raw" assert e.args[0] == "PRIVMSG test :Hello" e = next(events) assert e.name == "write" assert e.args[0] == "PRIVMSG test :Hello\r\n" data = iter(app.data) s = next(data) assert s == "PRIVMSG test :Hello\r\n" def test_NOTICE(app): app.reset() app.fire(NOTICE("test", "Hello")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_notice" assert e.args[0] == "test" assert e.args[1] == "Hello" e = next(events) assert e.name == "command_raw" assert e.args[0] == "NOTICE test :Hello" e = next(events) assert e.name == "write" assert e.args[0] == "NOTICE test :Hello\r\n" data = iter(app.data) s = next(data) assert s == "NOTICE test :Hello\r\n" def test_CTCP(app): app.reset() app.fire(CTCP("test", "PING", "1234567890")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_ctcp" assert e.args[0] == "test" assert e.args[1] == "PING" assert e.args[2] == "1234567890" e = next(events) assert e.name == "command_privmsg" assert e.args[0] == "test" assert e.args[1] == "PING 1234567890" e = next(events) assert e.name == "command_raw" assert e.args[0] == "PRIVMSG test :PING 1234567890" e = next(events) assert e.name == "write" assert e.args[0] == "PRIVMSG test :PING 1234567890\r\n" data = iter(app.data) s = next(data) assert s == "PRIVMSG test :PING 1234567890\r\n" def test_CTCPREPLY(app): app.reset() app.fire(CTCPREPLY("test", "PING", "1234567890")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_ctcpreply" assert e.args[0] == "test" assert e.args[1] == "PING" assert e.args[2] == "1234567890" e = next(events) assert e.name == "command_notice" assert e.args[0] == "test" assert e.args[1] == "PING 1234567890" e = next(events) assert e.name == "command_raw" assert e.args[0] == "NOTICE test :PING 1234567890" e = next(events) assert e.name == "write" assert e.args[0] == "NOTICE test :PING 1234567890\r\n" data = iter(app.data) s = next(data) assert s == "NOTICE test :PING 1234567890\r\n" def test_KICK(app): app.reset() app.fire(KICK("#test", "test")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_kick" assert e.args[0] == "#test" assert e.args[1] == "test" e = next(events) assert e.name == "command_raw" assert e.args[0] == "KICK #test test :" e = next(events) assert e.name == "write" assert e.args[0] == "KICK #test test :\r\n" data = iter(app.data) s = next(data) assert s == "KICK #test test :\r\n" app.reset() app.fire(KICK("#test", "test", "Bye")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_kick" assert e.args[0] == "#test" assert e.args[1] == "test" assert e.args[2] == "Bye" e = next(events) assert e.name == "command_raw" assert e.args[0] == "KICK #test test :Bye" e = next(events) assert e.name == "write" assert e.args[0] == "KICK #test test :Bye\r\n" data = iter(app.data) s = next(data) assert s == "KICK #test test :Bye\r\n" def test_TOPIC(app): app.reset() app.fire(TOPIC("#test", "Hello World!")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_topic" assert e.args[0] == "#test" assert e.args[1] == "Hello World!" e = next(events) assert e.name == "command_raw" assert e.args[0] == "TOPIC #test :Hello World!" e = next(events) assert e.name == "write" assert e.args[0] == "TOPIC #test :Hello World!\r\n" data = iter(app.data) s = next(data) assert s == "TOPIC #test :Hello World!\r\n" def test_MODE(app): app.reset() app.fire(MODE("+i")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_mode" assert e.args[0] == "+i" e = next(events) assert e.name == "command_raw" assert e.args[0] == "MODE :+i" e = next(events) assert e.name == "write" assert e.args[0] == "MODE :+i\r\n" data = iter(app.data) s = next(data) assert s == "MODE :+i\r\n" app.reset() app.fire(MODE("+o test", "#test")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_mode" assert e.args[0] == "+o test" assert e.args[1] == "#test" e = next(events) assert e.name == "command_raw" assert e.args[0] == "MODE #test :+o test" e = next(events) assert e.name == "write" assert e.args[0] == "MODE #test :+o test\r\n" data = iter(app.data) s = next(data) assert s == "MODE #test :+o test\r\n" def test_INVITE(app): app.reset() app.fire(INVITE("test", "#test")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_invite" assert e.args[0] == "test" assert e.args[1] == "#test" e = next(events) assert e.name == "command_raw" assert e.args[0] == "INVITE test #test" e = next(events) assert e.name == "write" assert e.args[0] == "INVITE test #test\r\n" data = iter(app.data) s = next(data) assert s == "INVITE test #test\r\n" def test_NAMES(app): app.reset() app.fire(NAMES()) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_names" assert not e.args e = next(events) assert e.name == "command_raw" assert e.args[0] == "NAMES" e = next(events) assert e.name == "write" assert e.args[0] == "NAMES\r\n" data = iter(app.data) s = next(data) assert s == "NAMES\r\n" app.reset() app.fire(NAMES("#test")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "command_names" assert e.args[0] == "#test" e = next(events) assert e.name == "command_raw" assert e.args[0] == "NAMES #test" e = next(events) assert e.name == "write" assert e.args[0] == "NAMES #test\r\n" data = iter(app.data) s = next(data) assert s == "NAMES #test\r\n" ### ### Test IRC Responses ### def test_ping(app): app.reset() app.fire(Read(b"PING :localhost\r\n")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "read" assert e.args[0] == b"PING :localhost\r\n" e = next(events) assert e.name == "line" assert e.args[0] == "PING :localhost" e = next(events) assert e.name == "ping" assert e.args[0] == "localhost" e = next(events) assert e.name == "command_pong" assert e.args[0] == "localhost" e = next(events) assert e.name == "command_raw" assert e.args[0] == "PONG :localhost" e = next(events) assert e.name == "write" assert e.args[0] == "PONG :localhost\r\n" data = iter(app.data) s = next(data) assert s == "PONG :localhost\r\n" def test_numerics(app): app.reset() app.fire(Read(b":localhost 001 test " + b":Welcome to the circuits Internet Relay Chat Network test\r\n")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "read" assert e.args[0] == b":localhost 001 test " \ b":Welcome to the circuits Internet Relay Chat Network test\r\n" e = next(events) assert e.name == "line" assert e.args[0] == ":localhost 001 test " \ ":Welcome to the circuits Internet Relay Chat Network test" e = next(events) assert e.name == "numeric" assert e.args[0] == "localhost" assert e.args[1] == "test" assert e.args[2] == 1 assert e.args[3] == None assert e.args[4] == \ "Welcome to the circuits Internet Relay Chat Network test" app.reset() app.fire(Read(b":localhost 332 test #test :Hello World!\r\n")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "read" assert e.args[0] == b":localhost 332 test #test :Hello World!\r\n" e = next(events) assert e.name == "line" assert e.args[0] == ":localhost 332 test #test :Hello World!" e = next(events) assert e.name == "numeric" assert e.args[0] == "localhost" assert e.args[1] == "test" assert e.args[2] == 332 assert e.args[3] == "#test" assert e.args[4] == "Hello World!" def test_ctcp(app): app.reset() app.fire(Read(b":test!foo@localhost PRIVMSG test :TIME\r\n")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "read" assert e.args[0] == b":test!foo@localhost PRIVMSG test :TIME\r\n" e = next(events) assert e.name == "line" assert e.args[0] == ":test!foo@localhost PRIVMSG test :TIME" e = next(events) assert e.name == "ctcp" assert e.args[0] == ("test", "foo", "localhost") assert e.args[1] == "test" assert e.args[2] == "TIME" assert e.args[3] == "" def test_message(app): app.reset() app.fire(Read(b":test!foo@localhost PRIVMSG test :Hello\r\n")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "read" assert e.args[0] == b":test!foo@localhost PRIVMSG test :Hello\r\n" e = next(events) assert e.name == "line" assert e.args[0] == ":test!foo@localhost PRIVMSG test :Hello" e = next(events) assert e.name == "message" assert e.args[0] == ("test", "foo", "localhost") assert e.args[1] == "test" assert e.args[2] == "Hello" def test_notice(app): app.reset() app.fire(Read(b":test!foo@localhost NOTICE test :Hello\r\n")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "read" assert e.args[0] == b":test!foo@localhost NOTICE test :Hello\r\n" e = next(events) assert e.name == "line" assert e.args[0] == ":test!foo@localhost NOTICE test :Hello" e = next(events) assert e.name == "notice" assert e.args[0] == ("test", "foo", "localhost") assert e.args[1] == "test" assert e.args[2] == "Hello" def test_join(app): app.reset() app.fire(Read(b":test!foo@localhost JOIN #test\r\n")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "read" assert e.args[0] == b":test!foo@localhost JOIN #test\r\n" e = next(events) assert e.name == "line" assert e.args[0] == ":test!foo@localhost JOIN #test" e = next(events) assert e.name == "join" assert e.args[0] == ("test", "foo", "localhost") assert e.args[1] == "#test" def test_part(app): app.reset() app.fire(Read(b":test!foo@localhost PART #test :Leaving\r\n")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "read" assert e.args[0] == b":test!foo@localhost PART #test :Leaving\r\n" e = next(events) assert e.name == "line" assert e.args[0] == ":test!foo@localhost PART #test :Leaving" e = next(events) assert e.name == "part" assert e.args[0] == ("test", "foo", "localhost") assert e.args[1] == "#test" assert e.args[2] == "Leaving" def test_quit(app): app.reset() app.fire(Read(b":test!foo@localhost QUIT :Leaving\r\n")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "read" assert e.args[0] == b":test!foo@localhost QUIT :Leaving\r\n" e = next(events) assert e.name == "line" assert e.args[0] == ":test!foo@localhost QUIT :Leaving" e = next(events) assert e.name == "quit" assert e.args[0] == ("test", "foo", "localhost") assert e.args[1] == "Leaving" def test_nick(app): app.reset() app.fire(Read(b":test!foo@localhost NICK :test_\r\n")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "read" assert e.args[0] == b":test!foo@localhost NICK :test_\r\n" e = next(events) assert e.name == "line" assert e.args[0] == ":test!foo@localhost NICK :test_" e = next(events) assert e.name == "nick" assert e.args[0] == ("test", "foo", "localhost") assert e.args[1] == "test_" def test_mode(app): app.reset() app.fire(Read(b":test!foo@localhost MODE #test +o test\r\n")) while app: app.flush() events = iter(app.events) e = next(events) assert e.name == "read" assert e.args[0] == b":test!foo@localhost MODE #test +o test\r\n" e = next(events) assert e.name == "line" assert e.args[0] == ":test!foo@localhost MODE #test +o test" e = next(events) assert e.name == "mode" assert e.args[0] == ("test", "foo", "localhost") assert e.args[1] == "#test" assert e.args[2] == "+o test" circuits-2.1.0/tests/net/protocols/__init__.py0000644000014400001440000000000012072034467021150 0ustar prologicuserscircuits-2.1.0/tests/web/0000755000014400001440000000000012113366740015012 5ustar prologicuserscircuits-2.1.0/tests/web/websocket.py0000644000014400001440000003616712113343751017364 0ustar prologicusers""" websocket - WebSocket client library for Python Copyright (C) 2010 Hiroki Ohtani(liris) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA """ import socket import random import struct from hashlib import md5 import logging from .helpers import urlparse logger = logging.getLogger() class WebSocketException(Exception): pass class ConnectionClosedException(WebSocketException): pass default_timeout = None traceEnabled = False def enableTrace(tracable): """ turn on/off the tracability. """ global traceEnabled traceEnabled = tracable if tracable: if not logger.handlers: logger.addHandler(logging.StreamHandler()) logger.setLevel(logging.DEBUG) def setdefaulttimeout(timeout): """ Set the global timeout setting to connect. """ global default_timeout default_timeout = timeout def getdefaulttimeout(): """ Return the global timeout setting to connect. """ return default_timeout def _parse_url(url): """ parse url and the result is tuple of (hostname, port, resource path and the flag of secure mode) """ parsed = urlparse(url) if parsed.hostname: hostname = parsed.hostname else: raise ValueError("hostname is invalid") port = 0 if parsed.port: port = parsed.port is_secure = False if parsed.scheme == "ws": if not port: port = 80 elif parsed.scheme == "wss": is_secure = True if not port: port = 443 else: raise ValueError("scheme %s is invalid" % parsed.scheme) if parsed.path: resource = parsed.path else: resource = "/" return (hostname, port, resource, is_secure) def create_connection(url, timeout=None, **options): """ connect to url and return websocket object. Connect to url and return the WebSocket object. Passing optional timeout parameter will set the timeout on the socket. If no timeout is supplied, the global default timeout setting returned by getdefauttimeout() is used. """ websock = WebSocket() websock.settimeout(timeout is not None and timeout or default_timeout) websock.connect(url, **options) return websock _MAX_INTEGER = (1 << 32) - 1 _AVAILABLE_KEY_CHARS = list(range(0x21, 0x2f + 1)).extend( list(range(0x3a, 0x7e + 1)) ) _MAX_CHAR_BYTE = (1 << 8) - 1 _MAX_ASCII_BYTE = (1 << 7) - 1 # ref. Websocket gets an update, and it breaks stuff. # http://axod.blogspot.com/2010/06/websocket-gets-update-and-it-breaks.html def _create_sec_websocket_key(): spaces_n = random.randint(1, 12) max_n = _MAX_INTEGER / spaces_n number_n = random.randint(0, int(max_n)) product_n = number_n * spaces_n key_n = str(product_n) for i in range(random.randint(1, 12)): c = random.choice(_AVAILABLE_KEY_CHARS) pos = random.randint(0, len(key_n)) key_n = key_n[0:pos] + chr(c) + key_n[pos:] for i in range(spaces_n): pos = random.randint(1, len(key_n)-1) key_n = key_n[0:pos] + " " + key_n[pos:] return number_n, key_n def _create_key3(): return "".join([chr(random.randint(0, _MAX_ASCII_BYTE)) for i in range(8)]) HEADERS_TO_CHECK = { "upgrade": "websocket", "connection": "upgrade", } HEADERS_TO_EXIST_FOR_HYBI00 = [ "sec-websocket-origin", "sec-websocket-location", ] HEADERS_TO_EXIST_FOR_HIXIE75 = [ "websocket-origin", "websocket-location", ] class _SSLSocketWrapper(object): def __init__(self, sock): self.ssl = socket.ssl(sock) def recv(self, bufsize): return self.ssl.read(bufsize) def send(self, payload): return self.ssl.write(payload) class WebSocket(object): """ Low level WebSocket interface. This class is based on The WebSocket protocol draft-hixie-thewebsocketprotocol-76 http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76 We can connect to the websocket server and send/recieve data. The following example is a echo client. >>> import websocket >>> ws = websocket.WebSocket() >>> ws.Connect("ws://localhost:8080/echo") >>> ws.send("Hello, Server") >>> ws.recv() 'Hello, Server' >>> ws.close() """ def __init__(self): """ Initalize WebSocket object. """ self.connected = False self.io_sock = self.sock = socket.socket() def settimeout(self, timeout): """ Set the timeout to the websocket. """ self.sock.settimeout(timeout) def gettimeout(self): """ Get the websocket timeout. """ return self.sock.gettimeout() def connect(self, url, **options): """ Connect to url. url is websocket url scheme. ie. ws://host:port/resource """ hostname, port, resource, is_secure = _parse_url(url) # TODO: we need to support proxy self.sock.connect((hostname, port)) if is_secure: self.io_sock = _SSLSocketWrapper(self.sock) self._handshake(hostname, port, resource, **options) def _handshake(self, host, port, resource, **options): sock = self.io_sock headers = [] headers.append("GET %s HTTP/1.1" % resource) headers.append("Upgrade: WebSocket") headers.append("Connection: Upgrade") if port == 80: hostport = host else: hostport = "%s:%d" % (host, port) headers.append("Host: %s" % hostport) headers.append("Origin: %s" % hostport) number_1, key_1 = _create_sec_websocket_key() headers.append("Sec-WebSocket-Key1: %s" % key_1) number_2, key_2 = _create_sec_websocket_key() headers.append("Sec-WebSocket-Key2: %s" % key_2) if "header" in options: headers.extend(options["header"]) headers.append("") key3 = _create_key3() headers.append(key3) header_str = "\r\n".join(headers) sock.send(header_str.encode('utf-8')) if traceEnabled: logger.debug("--- request header ---") logger.debug(header_str) logger.debug("-----------------------") status, resp_headers = self._read_headers() if status != 101: self.close() raise WebSocketException("Handshake Status %d" % status) success, secure = self._validate_header(resp_headers) if not success: self.close() raise WebSocketException("Invalid WebSocket Header") if secure: resp = self._get_resp() if not self._validate_resp(number_1, number_2, key3, resp): self.close() raise WebSocketException("challenge-response error") self.connected = True def _validate_resp(self, number_1, number_2, key3, resp): challenge = struct.pack("!I", number_1) challenge += struct.pack("!I", number_2) challenge += key3.encode('utf-8') digest = md5(challenge).digest() return resp == digest def _get_resp(self): result = self._recv(16) if traceEnabled: logger.debug("--- challenge response result ---") logger.debug(repr(result)) logger.debug("---------------------------------") return result def _validate_header(self, headers): #TODO: check other headers for key, value in HEADERS_TO_CHECK.items(): v = headers.get(key, None) if value != v: return False, False success = 0 for key in HEADERS_TO_EXIST_FOR_HYBI00: if key in headers: success += 1 if success == len(HEADERS_TO_EXIST_FOR_HYBI00): return True, True elif success != 0: return False, True success = 0 for key in HEADERS_TO_EXIST_FOR_HIXIE75: if key in headers: success += 1 if success == len(HEADERS_TO_EXIST_FOR_HIXIE75): return True, False return False, False def _read_headers(self): status = None headers = {} if traceEnabled: logger.debug("--- response header ---") while True: line = self._recv_line() if line == b"\r\n": break line = line.strip() if traceEnabled: logger.debug(line) if not status: status_info = line.split(b" ", 2) status = int(status_info[1]) else: kv = line.split(b":", 1) if len(kv) == 2: key, value = kv headers[key.lower().decode('utf-8')] \ = value.strip().lower().decode('utf-8') else: raise WebSocketException("Invalid header") if traceEnabled: logger.debug("-----------------------") return status, headers def send(self, payload): """ Send the data as string. payload must be utf-8 string or unicoce. """ if isinstance(payload, str): payload = payload.encode("utf-8") data = b"".join([b"\x00", payload, b"\xff"]) self.io_sock.send(data) if traceEnabled: logger.debug("send: " + repr(data)) def recv(self): """ Reeive utf-8 string data from the server. """ b = self._recv(1) if enableTrace: logger.debug("recv frame: " + repr(b)) frame_type = ord(b) if frame_type == 0x00: bytes = [] while True: b = self._recv(1) if b == b"\xff": break else: bytes.append(b) return b"".join(bytes) elif 0x80 < frame_type < 0xff: # which frame type is valid? length = self._read_length() bytes = self._recv_strict(length) return bytes elif frame_type == 0xff: self._recv(1) self._closeInternal() return None else: raise WebSocketException("Invalid frame type") def _read_length(self): length = 0 while True: b = ord(self._recv(1)) length = length * (1 << 7) + (b & 0x7f) if b < 0x80: break return length def close(self): """ Close Websocket object """ if self.connected: try: self.io_sock.send("\xff\x00") timeout = self.sock.gettimeout() self.sock.settimeout(1) try: result = self._recv(2) if result != "\xff\x00": logger.error("bad closing Handshake") except: pass self.sock.settimeout(timeout) self.sock.shutdown(socket.SHUT_RDWR) except: pass self._closeInternal() def _closeInternal(self): self.connected = False self.sock.close() self.io_sock = self.sock def _recv(self, bufsize): bytes = self.io_sock.recv(bufsize) if not bytes: raise ConnectionClosedException() return bytes def _recv_strict(self, bufsize): remaining = bufsize bytes = "" while remaining: bytes += self._recv(remaining) remaining = bufsize - len(bytes) return bytes def _recv_line(self): line = [] while True: c = self._recv(1) line.append(c) if c == b"\n": break return b"".join(line) class WebSocketApp(object): """ Higher level of APIs are provided. The interface is like JavaScript WebSocket object. """ def __init__(self, url, on_open=None, on_message=None, on_error=None, on_close=None): """ url: websocket url. on_open: callable object which is called at opening websocket. this function has one argument. The arugment is this class object. on_message: callbale object which is called when recieved data. on_message has 2 arguments. The 1st arugment is this class object. The passing 2nd arugment is utf-8 string which we get from the server. on_error: callable object which is called when we get error. on_error has 2 arguments. The 1st arugment is this class object. The passing 2nd arugment is exception object. on_close: callable object which is called when closed the connection. this function has one argument. The arugment is this class object. """ self.url = url self.on_open = on_open self.on_message = on_message self.on_error = on_error self.on_close = on_close self.sock = None def send(self, data): """ send message. data must be utf-8 string or unicode. """ self.sock.send(data) def close(self): """ close websocket connection. """ self.sock.close() def run_forever(self): """ run event loop for WebSocket framework. This loop is infinite loop and is alive during websocket is available. """ if self.sock: raise WebSocketException("socket is already opened") try: self.sock = WebSocket() self.sock.connect(self.url) self._run_with_no_err(self.on_open) while True: data = self.sock.recv() if data is None: break self._run_with_no_err(self.on_message, data) except Exception as e: self._run_with_no_err(self.on_error, e) finally: self.sock.close() self._run_with_no_err(self.on_close) self.sock = None def _run_with_no_err(self, callback, *args): if callback: try: callback(self, *args) except Exception as e: if logger.isEnabledFor(logging.DEBUG): logger.error(e) if __name__ == "__main__": enableTrace(True) #ws = create_connection("ws://localhost:8080/echo") ws = create_connection("ws://localhost:5000/chat") print("Sending 'Hello, World'...") ws.send("Hello, World") print("Sent") print("Receiving...") result = ws.recv() print("Received '%s'" % result) ws.close() circuits-2.1.0/tests/web/test_json.py0000644000014400001440000000267012113343751017376 0ustar prologicusers#!/usr/bin/env python from json import loads from circuits.web import JSONController, Sessions from .helpers import urlopen, build_opener, HTTPCookieProcessor from .helpers import CookieJar class Root(JSONController): def index(self): return {"success": True, "message": "Hello World!"} def test_sessions(self, name=None): if name: self.session["name"] = name else: name = self.session.get("name", "World!") return {"success": True, "message": "Hello %s" % name} def test(webapp): f = urlopen(webapp.server.base) data = f.read() data = data.decode("utf-8") d = loads(data) assert d["success"] assert d["message"] == "Hello World!" def test_sessions(webapp): Sessions().register(webapp) cj = CookieJar() opener = build_opener(HTTPCookieProcessor(cj)) f = opener.open("%s/test_sessions" % webapp.server.base) data = f.read() data = data.decode("utf-8") d = loads(data) assert d["success"] assert d["message"] == "Hello World!" f = opener.open("%s/test_sessions/test" % webapp.server.base) data = f.read() data = data.decode("utf-8") d = loads(data) assert d["success"] assert d["message"] == "Hello test" f = opener.open("%s/test_sessions" % webapp.server.base) data = f.read() data = data.decode("utf-8") d = loads(data) assert d["success"] assert d["message"] == "Hello test" circuits-2.1.0/tests/web/test_100_continue.py0000644000014400001440000000133112113343751020622 0ustar prologicusers#!/usr/bin/env python from circuits.web import Controller from .helpers import urlencode, urlopen, Request class Root(Controller): def index(self, *args, **kwargs): args = tuple((x.encode("utf-8") if type(x) != str else x for x in args)) return "{0}\n{1}".format(repr(args), repr(kwargs)) def test(webapp): args = ("1", "2", "3") kwargs = {"data": "\x00" * 4096} headers = {"Expect": "100-continue"} url = "%s/%s" % (webapp.server.base, "/".join(args)) data = urlencode(kwargs).encode('utf-8') req = Request(url, data, headers) res = urlopen(req) data = res.read().split(b"\n") assert eval(data[0]) == args assert eval(data[1]) == kwargs circuits-2.1.0/tests/web/test_expires.py0000644000014400001440000000220712113343751020100 0ustar prologicusers#!/usr/bin/env python from datetime import datetime from time import mktime from email.utils import parsedate from circuits.web import Controller from .helpers import urlopen class Root(Controller): def index(self): self.expires(60) return "Hello World!" def nocache(self): self.expires(0) return "Hello World!" def test(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" expires = f.headers["Expires"] diff = (mktime(parsedate(expires)) - mktime(datetime.utcnow().timetuple())) assert 60 - (60 * 0.1) < diff < 60 + (60 * 0.1) # diff is about 60 +- 10% def test_nocache(webapp): f = urlopen("%s/nocache" % webapp.server.base) s = f.read() assert s == b"Hello World!" expires = f.headers["Expires"] pragma = f.headers["Pragma"] cacheControl = f.headers["Cache-Control"] now = datetime.utcnow() lastyear = now.replace(year=now.year-1) diff = (mktime(parsedate(expires)) - mktime(lastyear.utctimetuple())) assert diff < 1.0 assert pragma == "no-cache" assert cacheControl == "no-cache, must-revalidate" circuits-2.1.0/tests/web/cert.pem0000644000014400001440000000420512113343751016450 0ustar prologicusers-----BEGIN RSA PRIVATE KEY----- MIICWwIBAAKBgQC9B7hV67bzhLA//STrZUIi0iHD4WFtftOhvj+xiHRNnYw0+r+4 WdQv1YiL+ab03pn/J9R1SQuOGwYDVPQvYX+qEFVRUFP9yvXIQl7PG40HQzfs8lJz hnmI+64HJT//oJ9e7PiyDHLfFH1FuCqSy9RlvzOd4hmydX9J3VxFFzrpJQIDAQAB AoGAHhGxT/Gb+6a6xqMFEXDdEV7twhQDBIDtN0hlJ192aLZMDE1q2+9mImnMO7/t v/v88Sqr0DBbZzKDRVppMXRH80ZtnmMu3/3kUCtA3WAbKxyFpIiXGv/NAUHZe5Gz rua+z3lUvmt6CmwMm2ReB70Q61zxr9q4HjrjYI82dtJ4M40CQQDnGujxdBdbPmiR oc8mcShfmPNP7igQrUkf/DpB0GWnLWdA97mmXLw4jHXpHy9gm3wGc+9uOi0Ex8Ml 1t9xAGFjAkEA0WSGwG45d5dmYV8Oa/9UsY5/F6hAlYAAI1TxRsKcl2YTqaQastac glV1GSUrgGw/8UBvdKKS2REF7cpAkiQV1wJAPtQhCiuOgf7YfOcpowDWgg7Z7xwH Bmml3K08xVG7oRSF4rK2ZRUHErSVBbi1r6T1tedk62mjfY41bp8ZBeadkwJAD7AG YHhhmdIf+3+Rpwm0ILFaWD1kyU6TtBHzGagO71DYfEctMOTfSOx6H24nejGiAMMh Fo3vjo+18ADNIaXOdQJAYdm+dUdyVaW2IDUi7ew0shyKTC4OaEZtXIwwINvrqUsX //6z8mw/S5rXGlfKadiz4uwzcXlSvg727O1efpibvA== -----END RSA PRIVATE KEY----- -----BEGIN CERTIFICATE----- MIIDjTCCAvagAwIBAgIJAN0msyL5El/jMA0GCSqGSIb3DQEBBQUAMIGMMQswCQYD VQQGEwJBVTETMBEGA1UECBMKUXVlZW5zbGFuZDERMA8GA1UEBxMIQnJpc2JhbmUx FTATBgNVBAoTDFNob3J0Q2lyY3VpdDEUMBIGA1UEAxMLSmFtZXMgTWlsbHMxKDAm BgkqhkiG9w0BCQEWGWFkbWluQHNob3J0Y2lyY3VpdC5uZXQuYXUwHhcNMTAwMTEz MDczOTAwWhcNMTEwMTEzMDczOTAwWjCBjDELMAkGA1UEBhMCQVUxEzARBgNVBAgT ClF1ZWVuc2xhbmQxETAPBgNVBAcTCEJyaXNiYW5lMRUwEwYDVQQKEwxTaG9ydENp cmN1aXQxFDASBgNVBAMTC0phbWVzIE1pbGxzMSgwJgYJKoZIhvcNAQkBFhlhZG1p bkBzaG9ydGNpcmN1aXQubmV0LmF1MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKB gQC9B7hV67bzhLA//STrZUIi0iHD4WFtftOhvj+xiHRNnYw0+r+4WdQv1YiL+ab0 3pn/J9R1SQuOGwYDVPQvYX+qEFVRUFP9yvXIQl7PG40HQzfs8lJzhnmI+64HJT// oJ9e7PiyDHLfFH1FuCqSy9RlvzOd4hmydX9J3VxFFzrpJQIDAQABo4H0MIHxMB0G A1UdDgQWBBSq+tU5ZDymUuMcgZ83gxk1PTN89zCBwQYDVR0jBIG5MIG2gBSq+tU5 ZDymUuMcgZ83gxk1PTN896GBkqSBjzCBjDELMAkGA1UEBhMCQVUxEzARBgNVBAgT ClF1ZWVuc2xhbmQxETAPBgNVBAcTCEJyaXNiYW5lMRUwEwYDVQQKEwxTaG9ydENp cmN1aXQxFDASBgNVBAMTC0phbWVzIE1pbGxzMSgwJgYJKoZIhvcNAQkBFhlhZG1p bkBzaG9ydGNpcmN1aXQubmV0LmF1ggkA3SazIvkSX+MwDAYDVR0TBAUwAwEB/zAN BgkqhkiG9w0BAQUFAAOBgQAokSGDpbFV2osC8nM8K12vheeDBVDHGxOaENXGVIm8 SWPXsaIUsm6JQx0wm/eouWRPbNJkOBwBrNCls1oMmdxdxG8mBh+kAMWUkdVeuT2H lCo9BRJnhUr4L6poJ7ORzL2oUilGZNwONpHGY0cWzFG8/tOoRJsfKZm23bwXbIxv Hw== -----END CERTIFICATE----- circuits-2.1.0/tests/web/test_serve_file.py0000644000014400001440000000121512113343751020542 0ustar prologicusers#!/usr/bin/env python import os from tempfile import mkstemp from circuits import handler from circuits.web import Controller from .helpers import urlopen class Root(Controller): @handler("started", priority=1.0, channel="*") def _on_started(self, component): fd, self.filename = mkstemp() os.write(fd, b"Hello World!") os.close(fd) @handler("stopped", channel="(") def _on_stopped(self, component): os.remove(self.filename) def index(self): return self.serve_file(self.filename) def test(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" circuits-2.1.0/tests/web/test_wsgi_application_generator.py0000644000014400001440000000065212113343751024025 0ustar prologicusers#!/usr/bin/env python from circuits.web import Controller from circuits.web.wsgi import Application from .helpers import urlopen class Root(Controller): def index(self): def response(): yield "Hello " yield "World!" return response() application = Application() + Root() def test(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" circuits-2.1.0/tests/web/test_unicode.py0000644000014400001440000000106512113343751020050 0ustar prologicusers#!/usr/bin/env python # -*- coding: utf-8 -*- from circuits.web import expose, Controller from .helpers import urlopen class Root(Controller): def index(self): return "Hello World!" @expose("hello") def hello(self): self.response.headers["Content-Type"] = "text/html; charset=utf-8" return "Hello World!" def test(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" url = "%s/hello" % webapp.server.base f = urlopen(url) s = f.read() assert s == b"Hello World!" circuits-2.1.0/tests/web/test_expose.py0000644000014400001440000000125312113343751017724 0ustar prologicusersfrom circuits.web import expose, Controller from .helpers import urlopen class Root(Controller): def index(self): return "Hello World!" @expose("+test") def test(self): return "test" @expose("foo+bar", "foo_bar") def foobar(self): return "foobar" def test(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" f = urlopen("%s/+test" % webapp.server.base) s = f.read() assert s == b"test" f = urlopen("%s/foo+bar" % webapp.server.base) s = f.read() assert s == b"foobar" f = urlopen("%s/foo_bar" % webapp.server.base) s = f.read() assert s == b"foobar" circuits-2.1.0/tests/web/test_dispatcher.py0000644000014400001440000000275212072034467020561 0ustar prologicusers#!/usr/bin/env python import pytest from circuits.web import Controller from circuits.web.client import Client, Connect, Request class Root(Controller): def __init__(self, *args, **kwargs): super(Root, self).__init__(*args, **kwargs) self += Leaf() def index(self): return "Hello World!" def name(self): return "Earth" class Leaf(Controller): channel = "/world/country/region" def index(self): return "Hello cities!" def city(self): return "Hello City!" def request(webapp, path): client = Client(webapp.server.base) client.start() waiter = pytest.WaitEvent(client, 'connected', channel='client') client.fire(Connect()) assert waiter.wait() client.fire(Request("GET", path)) while client.response is None: pass client.stop() response = client.response s = response.read() return response.status, s def test_root(webapp): status, content = request(webapp, "/") assert status == 200 assert content == b"Hello World!" def test_root_name(webapp): status, content = request(webapp, "/name") assert status == 200 assert content == b"Earth" def test_leaf(webapp): status, content = request(webapp, "/world/country/region") assert status == 200 assert content == b"Hello cities!" def test_city(webapp): status, content = request(webapp, "/world/country/region/city") assert status == 200 assert content == b"Hello City!" circuits-2.1.0/tests/web/helpers.py0000644000014400001440000000147312113343751017030 0ustar prologicuserstry: from urllib.error import HTTPError, URLError from urllib.parse import quote, urlencode, urljoin from urllib.request import HTTPBasicAuthHandler, HTTPCookieProcessor from urllib.request import urlopen, build_opener, install_opener from urllib.request import HTTPDigestAuthHandler, Request except ImportError: from urlparse import urljoin from urllib import quote, urlencode from urllib2 import HTTPError, URLError, HTTPDigestAuthHandler from urllib2 import HTTPBasicAuthHandler, HTTPCookieProcessor from urllib2 import urlopen, build_opener, install_opener, Request try: from http.cookiejar import CookieJar except ImportError: from cookielib import CookieJar try: from urllib.parse import urlparse except ImportError: from urlparse import urlparse # flake8: noqa circuits-2.1.0/tests/web/test_logger.py0000644000014400001440000000501712113343751017702 0ustar prologicusers#!/usr/bin/env python import sys try: from StringIO import StringIO except ImportError: from io import StringIO # NOQA from socket import gaierror, gethostbyname, gethostname from circuits.web import Controller, Logger from .helpers import urlopen class DummyLogger(object): def __init__(self): super(DummyLogger, self).__init__() self.message = None def info(self, message): self.message = message class Root(Controller): def index(self): return "Hello World!" def test_file(webapp): logfile = StringIO() logger = Logger(file=logfile) logger.register(webapp) f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" logfile.seek(0) s = logfile.read().strip() try: address = gethostbyname(gethostname()) except gaierror: address = "127.0.0.1" d = {} d["h"] = address d["l"] = "-" d["u"] = "-" d["r"] = "GET / HTTP/1.1" d["s"] = "200" d["b"] = "12" d["f"] = "" d["a"] = "Python-urllib/%s" % sys.version[:3] keys = list(d.keys()) for k in keys: assert d[k] in s logfile.close() logger.unregister() def test_logger(webapp): logobj = DummyLogger() logger = Logger(logger=logobj) logger.register(webapp) f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" s = logobj.message try: address = gethostbyname(gethostname()) except gaierror: address = "127.0.0.1" d = {} d["h"] = address d["l"] = "-" d["u"] = "-" d["r"] = "GET / HTTP/1.1" d["s"] = "200" d["b"] = "12" d["f"] = "" d["a"] = "Python-urllib/%s" % sys.version[:3] keys = list(d.keys()) for k in keys: assert d[k] in s logger.unregister() def test_filename(webapp, tmpdir): logfile = str(tmpdir.ensure("logfile")) logger = Logger(file=logfile) logger.register(webapp) logfile = open(logfile, "r") f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" logfile.seek(0) s = logfile.read().strip() try: address = gethostbyname(gethostname()) except gaierror: address = "127.0.0.1" d = {} d["h"] = address d["l"] = "-" d["u"] = "-" d["r"] = "GET / HTTP/1.1" d["s"] = "200" d["b"] = "12" d["f"] = "" d["a"] = "Python-urllib/%s" % sys.version[:3] keys = list(d.keys()) for k in keys: assert d[k] in s logfile.close() logger.unregister() circuits-2.1.0/tests/web/conftest.py0000644000014400001440000000367412113343751017220 0ustar prologicusers# Module: conftest # Date: 10 February 2010 # Author: James Mills, prologic at shortcircuit dot net dot au """py.test config""" import os import pytest from circuits import Component from circuits.net.sockets import Close from circuits.web import Server, Static from circuits.web.client import Client, Connect, Request DOCROOT = os.path.join(os.path.dirname(__file__), "static") class WebApp(Component): def init(self): self.server = Server(0).register(self) Static("/static", DOCROOT, dirlisting=True).register(self) class WebClient(Client): def __call__(self, method, path, body=None, headers={}): waiter = pytest.WaitEvent(self, "response", channel=self.channel) self.fire(Request(method, path, body, headers)) assert waiter.wait() return self.response @pytest.fixture(scope="module") def webapp(request): webapp = WebApp() if hasattr(request.module, "application"): from circuits.web.wsgi import Gateway application = getattr(request.module, "application") Gateway({"/": application}).register(webapp) Root = getattr(request.module, "Root", None) if Root is not None: Root().register(webapp) waiter = pytest.WaitEvent(webapp, "ready") webapp.start() assert waiter.wait() def finalizer(): webapp.fire(Close(), webapp.server) webapp.stop() request.addfinalizer(finalizer) return webapp @pytest.fixture(scope="module") def webclient(request, webapp): webclient = WebClient(webapp.server.base) waiter = pytest.WaitEvent(webclient, "ready", channel=webclient.channel) webclient.register(webapp) assert waiter.wait() webclient.fire(Connect(), webclient) waiter = pytest.WaitEvent( webclient, "connected", channel=webclient.channel ) assert waiter.wait() def finalizer(): webclient.unregister() request.addfinalizer(finalizer) return webclient circuits-2.1.0/tests/web/multipartform.py0000644000014400001440000000354512113343751020275 0ustar prologicusers import itertools from mimetypes import guess_type from email.generator import _make_boundary class MultiPartForm(dict): def __init__(self): self.files = [] self.boundary = _make_boundary() def get_content_type(self): return "multipart/form-data; boundary=%s" % self.boundary def add_file(self, fieldname, filename, fd, mimetype=None): body = fd.read() if mimetype is None: mimetype = guess_type(filename)[0] or "application/octet-stream" self.files.append((fieldname, filename, mimetype, body)) def bytes(self): parts = [] part_boundary = bytearray("--%s" % self.boundary, "ascii") # Add the form fields parts.extend([ part_boundary, bytearray( "Content-Disposition: form-data; name=\"%s\"" % k, "ascii" ), bytes(), v if isinstance(v, bytes) else bytearray(v, "ascii") ] for k, v in list(self.items())) # Add the files to upload parts.extend([ part_boundary, bytearray( "Content-Disposition: file; name=\"%s\"; filename=\"%s\"" % ( fieldname, filename), "ascii" ), bytearray("Content-Type: %s" % content_type, "ascii"), bytearray(), body if isinstance(body, bytes) else bytearray(body, "ascii"), ] for fieldname, filename, content_type, body in self.files) # Flatten the list and add closing boundary marker, # then return CR+LF separated data flattened = list(itertools.chain(*parts)) flattened.append(bytearray("--%s--" % self.boundary, "ascii")) res = bytearray() for item in flattened: res += item res += bytearray("\r\n", "ascii") return res circuits-2.1.0/tests/web/test_disps.py0000644000014400001440000000340112113343751017540 0ustar prologicusers#!/usr/bin/env python from circuits.core.manager import Manager from circuits.core.handlers import handler from circuits.core.components import BaseComponent from circuits.web import BaseServer, Controller from circuits.web.dispatchers.dispatcher import Dispatcher from .helpers import urlopen, urljoin class PrefixingDispatcher(BaseComponent): """Forward to another Dispatcher based on the channel.""" def __init__(self, channel): super(PrefixingDispatcher, self).__init__(channel=channel) @handler("request", filter=True, priority=1.0) def _on_request(self, event, request, response): path = request.path.strip("/") path = urljoin("/%s/" % self.channel, path) request.path = path class DummyRoot(Controller): channel = "/" def index(self): return "Not used" class Root1(Controller): channel = "/site1" def index(self): return "Hello from site 1!" class Root2(Controller): channel = "/site2" def index(self): return "Hello from site 2!" def test_disps(): manager = Manager() server1 = BaseServer(0, channel="site1") server1.register(manager) PrefixingDispatcher(channel="site1").register(server1) Dispatcher(channel="site1").register(server1) Root1().register(manager) server2 = BaseServer(("localhost", 0), channel="site2") server2.register(manager) PrefixingDispatcher(channel="site2").register(server2) Dispatcher(channel="site2").register(server2) Root2().register(manager) DummyRoot().register(manager) manager.start() f = urlopen(server1.base, timeout=3) s = f.read() assert s == b"Hello from site 1!" f = urlopen(server2.base, timeout=3) s = f.read() assert s == b"Hello from site 2!" circuits-2.1.0/tests/web/test_wsgi_gateway_multiple_apps.py0000644000014400001440000000201612113343751024047 0ustar prologicusers#!/usr/bin/env python import pytest if pytest.PYVER[:2] == (3, 3): pytest.skip("Broken on Python 3.3") from circuits.web import Server from circuits.web.wsgi import Gateway from .helpers import urlopen def hello(environ, start_response): status = "200 OK" response_headers = [("Content-type", "text/plain")] start_response(status, response_headers) return "Hello World!" def foobar(environ, start_response): status = "200 OK" response_headers = [("Content-type", "text/plain")] start_response(status, response_headers) return "FooBar!" @pytest.fixture def apps(request): return { "/": hello, "/foobar": foobar } def test(apps): server = Server(0) Gateway(apps).register(server) waiter = pytest.WaitEvent(server, "ready") server.start() waiter.wait() f = urlopen(server.base) s = f.read() assert s == b"Hello World!" f = urlopen("{0:s}/foobar/".format(server.base)) s = f.read() assert s == b"FooBar!" server.stop() circuits-2.1.0/tests/web/test_null_response.py0000644000014400001440000000050612113343751021311 0ustar prologicusersfrom circuits.web import Controller from .helpers import urlopen, HTTPError class Root(Controller): def index(self): pass def test(webapp): try: urlopen(webapp.server.base) except HTTPError as e: assert e.code == 404 assert e.msg == "Not Found" else: assert False circuits-2.1.0/tests/web/test_wsgi_gateway.py0000644000014400001440000000053612113343751021116 0ustar prologicusers#!/usr/bin/env python from .helpers import urlopen def application(environ, start_response): status = "200 OK" response_headers = [("Content-type", "text/plain")] start_response(status, response_headers) return "Hello World!" def test(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" circuits-2.1.0/tests/web/test_multipartformdata.py0000644000014400001440000000401112113343751022153 0ustar prologicusers#!/usr/bin/env python import pytest from os import path from io import BytesIO from circuits.web import Controller from .multipartform import MultiPartForm from .helpers import urlopen, Request @pytest.fixture() def sample_file(request): return open( path.join( path.dirname(__file__), "static", "unicode.txt" ), "rb" ) class Root(Controller): def index(self, file, description=""): yield "Filename: %s\n" % file.filename yield "Description: %s\n" % description yield "Content:\n" yield file.value def upload(self, file, description=""): return file.value def test(webapp): form = MultiPartForm() form["description"] = "Hello World!" fd = BytesIO(b"Hello World!") form.add_file("file", "helloworld.txt", fd, "text/plain; charset=utf-8") # Build the request request = Request(webapp.server.base) body = form.bytes() # charsets are defined in parts request.add_header("Content-Type", form.get_content_type()) request.add_header("Content-Length", len(body)) request.add_data(body) f = urlopen(request) s = f.read() lines = s.split(b"\n") assert lines[0] == b"Filename: helloworld.txt" assert lines[1] == b"Description: Hello World!" assert lines[2] == b"Content:" assert lines[3] == b"Hello World!" def test_unicode(webapp, sample_file): form = MultiPartForm() form["description"] = sample_file.name form.add_file( "file", "helloworld.txt", sample_file, "text/plain; charset=utf-8" ) # Build the request request = Request("{0:s}/upload".format(webapp.server.base)) body = form.bytes() # charsets are defined in parts request.add_header("Content-Type", form.get_content_type()) request.add_header("Content-Length", len(body)) request.add_data(body) f = urlopen(request) s = f.read() sample_file.seek(0) expected_output = sample_file.read() # use the byte stream assert s == expected_output circuits-2.1.0/tests/web/test_wsgi_application_yield.py0000644000014400001440000000056012113343751023143 0ustar prologicusers#!/usr/bin/env python from circuits.web import Controller from circuits.web.wsgi import Application from .helpers import urlopen class Root(Controller): def index(self): yield "Hello " yield "World!" application = Application() + Root() def test(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" circuits-2.1.0/tests/web/test_jsonrpc.py0000644000014400001440000000133512113343751020100 0ustar prologicusers#!/usr/bin/env python from circuits import Component from circuits.web import Controller, JSONRPC from .jsonrpclib import ServerProxy from .helpers import urlopen class Test(Component): def eval(self, s): return eval(s) class Root(Controller): def index(self): return "Hello World!" def test(webapp): rpc = JSONRPC("/rpc") test = Test() rpc.register(webapp) test.register(webapp) f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" url = "%s/rpc/" % webapp.server.base jsonrpc = ServerProxy(url, allow_none=True, encoding='utf-8') data = jsonrpc.eval("1 + 2") assert data["result"] == 3 rpc.unregister() test.unregister() circuits-2.1.0/tests/web/test_wsgi_application.py0000644000014400001440000000350212113343751021754 0ustar prologicusers#!/usr/bin/env python from circuits.web import Controller from circuits.web.wsgi import Application from .helpers import urlencode, urlopen, HTTPError class Root(Controller): def index(self): return "Hello World!" def test_args(self, *args, **kwargs): args = [arg if isinstance(arg, str) else arg.encode() for arg in args] return "%s\n%s" % (repr(tuple(args)), repr(kwargs)) def test_redirect(self): return self.redirect("/") def test_forbidden(self): return self.forbidden() def test_notfound(self): return self.notfound() application = Application() + Root() def test(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" def test_404(webapp): try: urlopen("%s/foo" % webapp.server.base) except HTTPError as e: assert e.code == 404 assert e.msg == "Not Found" else: assert False def test_args(webapp): args = ("1", "2", "3") kwargs = {"1": "one", "2": "two", "3": "three"} url = "%s/test_args/%s" % (webapp.server.base, "/".join(args)) data = urlencode(kwargs).encode() f = urlopen(url, data) data = f.read().split(b"\n") assert eval(data[0]) == args assert eval(data[1]) == kwargs def test_redirect(webapp): f = urlopen("%s/test_redirect" % webapp.server.base) s = f.read() assert s == b"Hello World!" def test_forbidden(webapp): try: urlopen("%s/test_forbidden" % webapp.server.base) except HTTPError as e: assert e.code == 403 assert e.msg == "Forbidden" else: assert False def test_notfound(webapp): try: urlopen("%s/test_notfound" % webapp.server.base) except HTTPError as e: assert e.code == 404 assert e.msg == "Not Found" else: assert False circuits-2.1.0/tests/web/test_websockets.py0000644000014400001440000000227712113343751020601 0ustar prologicusers#!/usr/bin/env python from circuits.web.servers import Server from circuits import Component from circuits.net.sockets import Write from circuits.web.dispatchers import WebSockets from circuits.web.controllers import Controller from circuits.web.websocket import WebSocketClient from circuits.web.client import Connect import time class Echo(Component): channel = "ws" def read(self, sock, data): self.fireEvent(Write(sock, "Received: " + data)) class Root(Controller): def index(self): return "Hello World!" class WSClient(Component): response = None def read(self, data): self.response = data def test1(webapp): server = Server(("localhost", 8123)) Echo().register(server) Root().register(server) WebSockets("/websocket").register(server) server.start() client = WebSocketClient("ws://localhost:8123/websocket") wsclient = WSClient().register(client) client.start() client.fire(Connect()) client.fire(Write("Hello!"), "ws") for i in range(100): if wsclient.response is not None: break time.sleep(0.010) assert wsclient.response is not None client.stop() server.stop() circuits-2.1.0/tests/web/test_sessions.py0000644000014400001440000000144212113343751020267 0ustar prologicusers#!/usr/bin/env python from circuits.web import Controller, Sessions from .helpers import build_opener, HTTPCookieProcessor from .helpers import CookieJar class Root(Controller): def index(self, vpath=None): if vpath: name = vpath self.session["name"] = name else: name = self.session.get("name", "World!") return "Hello %s" % name def test(webapp): Sessions().register(webapp) cj = CookieJar() opener = build_opener(HTTPCookieProcessor(cj)) f = opener.open(webapp.server.base) s = f.read() assert s == b"Hello World!" f = opener.open(webapp.server.base + "/test") s = f.read() assert s == b"Hello test" f = opener.open(webapp.server.base) s = f.read() assert s == b"Hello test" circuits-2.1.0/tests/web/test_client.py0000755000014400001440000000323712113343751017706 0ustar prologicusers#!/usr/bin/env python import pytest from circuits.web import Controller from circuits.web.client import Client, Connect, Request from circuits.core.manager import Manager class Root(Controller): def index(self): return "Hello World!" def test(webapp): client = Client(webapp.server.base) client.start() waiter = pytest.WaitEvent(client, 'connected', channel=client.channel) client.fire(Connect()) assert waiter.wait() client.fire(Request("GET", "/")) while client.response is None: pass client.stop() response = client.response assert response.status == 200 assert response.message == "OK" s = response.read() assert s == b"Hello World!" def test_named(webapp): client = Client(webapp.server.base, channel="Client2") client.start() waiter = pytest.WaitEvent(client, 'connected', channel=client.channel) client.fire(Connect()) assert waiter.wait() client.fire(Request("GET", "/")) while client.response is None: pass client.stop() response = client.response assert response.status == 200 assert response.message == "OK" s = response.read() assert s == b"Hello World!" def test_auto_close(webapp): m = Manager() client = Client(webapp.server.base).register(m) m.start() waiter = pytest.WaitEvent(client, 'connected', channel=client.channel) client.fire(Connect()) assert waiter.wait() assert client.connected waiter = pytest.WaitEvent( m, 'unregistered', channel=client.channel, timeout=10000 ) client.unregister() assert waiter.wait() assert not client.connected m.stop() circuits-2.1.0/tests/web/test_servers.py0000644000014400001440000000353612113343751020120 0ustar prologicusers#!/usr/bin/env python import pytest from os import path from socket import gaierror from circuits import Component from circuits.web import Controller from circuits.web import BaseServer, Server from .helpers import urlopen, URLError CERTFILE = path.join(path.dirname(__file__), "cert.pem") class BaseRoot(Component): channel = "web" def request(self, request, response): return "Hello World!" class Root(Controller): def index(self): return "Hello World!" def test_baseserver(): server = BaseServer(0) BaseRoot().register(server) server.start() try: f = urlopen(server.base) except URLError as e: if type(e[0]) is gaierror: f = urlopen("http://127.0.0.1:9000") else: raise s = f.read() assert s == b"Hello World!" def test_server(): server = Server(0) Root().register(server) server.start() try: f = urlopen(server.base) except URLError as e: if type(e[0]) is gaierror: f = urlopen("http://127.0.0.1:9000") else: raise s = f.read() assert s == b"Hello World!" def test_secure_server(): pytest.importorskip("ssl") server = Server(0, secure=True, certfile=CERTFILE) Root().register(server) server.start() try: f = urlopen(server.base) except URLError as e: if type(e[0]) is gaierror: f = urlopen("http://127.0.0.1:9000") else: raise s = f.read() assert s == b"Hello World!" def test_unixserver(tmpdir): if pytest.PLATFORM == "win32": pytest.skip("Unsupported Platform") sockpath = tmpdir.ensure("test.sock") socket = str(sockpath) server = Server(socket) Root().register(server) server.start() assert path.basename(server.host) == "test.sock" server.stop() circuits-2.1.0/tests/web/test_gzip.py0000644000014400001440000000155412113343751017376 0ustar prologicusers#!/usr/bin/env python try: from gzip import decompress except ImportError: import zlib decompress = zlib.decompressobj(16+zlib.MAX_WBITS).decompress # NOQA from circuits import handler, Component from circuits.web import Controller from circuits.web.tools import gzip from .helpers import build_opener, Request class Gzip(Component): channel = "web" @handler("response", filter=True) def _on_response(self, event, *args, **kwargs): event[0] = gzip(event[0]) class Root(Controller): def index(self): return "Hello World!" def test(webapp): gzip = Gzip() gzip.register(webapp) request = Request(webapp.server.base) request.add_header("Accept-Encoding", "gzip") opener = build_opener() f = opener.open(request) s = decompress(f.read()) assert s == b"Hello World!" gzip.unregister() circuits-2.1.0/tests/web/static/0000755000014400001440000000000012113366740016301 5ustar prologicuserscircuits-2.1.0/tests/web/static/test.css0000644000014400001440000000001112113343751017757 0ustar prologicusersbody { } circuits-2.1.0/tests/web/static/helloworld.txt0000644000014400001440000000001512072034467021213 0ustar prologicusersHello World! circuits-2.1.0/tests/web/static/#foobar.txt0000644000014400001440000000001512113343751020346 0ustar prologicusersHello World! circuits-2.1.0/tests/web/static/unicode.txt0000644000014400001440000003334412113343751020474 0ustar prologicusers UTF-8 encoded sample plain-text file ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾ Markus Kuhn [ˈmaʳkʊs kuːn] — 2002-07-25 The ASCII compatible UTF-8 encoding used in this plain-text file is defined in Unicode, ISO 10646-1, and RFC 2279. Using Unicode/UTF-8, you can write in emails and source code things such as Mathematics and sciences: ∮ E⋅da = Q, n → ∞, ∑ f(i) = ∏ g(i), ⎧⎡⎛┌─────┐⎞⎤⎫ ⎪⎢⎜│a²+b³ ⎟⎥⎪ ∀x∈ℝ: ⌈x⌉ = −⌊−x⌋, α ∧ ¬β = ¬(¬α ∨ β), ⎪⎢⎜│───── ⎟⎥⎪ ⎪⎢⎜⎷ c₈ ⎟⎥⎪ ℕ ⊆ ℕ₀ ⊂ ℤ ⊂ ℚ ⊂ ℝ ⊂ ℂ, ⎨⎢⎜ ⎟⎥⎬ ⎪⎢⎜ ∞ ⎟⎥⎪ ⊥ < a ≠ b ≡ c ≤ d ≪ ⊤ ⇒ (⟦A⟧ ⇔ ⟪B⟫), ⎪⎢⎜ ⎲ ⎟⎥⎪ ⎪⎢⎜ ⎳aⁱ-bⁱ⎟⎥⎪ 2H₂ + O₂ ⇌ 2H₂O, R = 4.7 kΩ, ⌀ 200 mm ⎩⎣⎝i=1 ⎠⎦⎭ Linguistics and dictionaries: ði ıntəˈnæʃənəl fəˈnɛtık əsoʊsiˈeıʃn Y [ˈʏpsilɔn], Yen [jɛn], Yoga [ˈjoːgɑ] APL: ((V⍳V)=⍳⍴V)/V←,V ⌷←⍳→⍴∆∇⊃‾⍎⍕⌈ Nicer typography in plain text files: ╔══════════════════════════════════════════╗ ║ ║ ║ • ‘single’ and “double” quotes ║ ║ ║ ║ • Curly apostrophes: “We’ve been here” ║ ║ ║ ║ • Latin-1 apostrophe and accents: '´` ║ ║ ║ ║ • ‚deutsche‘ „Anführungszeichen“ ║ ║ ║ ║ • †, ‡, ‰, •, 3–4, —, −5/+5, ™, … ║ ║ ║ ║ • ASCII safety test: 1lI|, 0OD, 8B ║ ║ ╭─────────╮ ║ ║ • the euro symbol: │ 14.95 € │ ║ ║ ╰─────────╯ ║ ╚══════════════════════════════════════════╝ Combining characters: STARGΛ̊TE SG-1, a = v̇ = r̈, a⃑ ⊥ b⃑ Greek (in Polytonic): The Greek anthem: Σὲ γνωρίζω ἀπὸ τὴν κόψη τοῦ σπαθιοῦ τὴν τρομερή, σὲ γνωρίζω ἀπὸ τὴν ὄψη ποὺ μὲ βία μετράει τὴ γῆ. ᾿Απ᾿ τὰ κόκκαλα βγαλμένη τῶν ῾Ελλήνων τὰ ἱερά καὶ σὰν πρῶτα ἀνδρειωμένη χαῖρε, ὦ χαῖρε, ᾿Ελευθεριά! From a speech of Demosthenes in the 4th century BC: Οὐχὶ ταὐτὰ παρίσταταί μοι γιγνώσκειν, ὦ ἄνδρες ᾿Αθηναῖοι, ὅταν τ᾿ εἰς τὰ πράγματα ἀποβλέψω καὶ ὅταν πρὸς τοὺς λόγους οὓς ἀκούω· τοὺς μὲν γὰρ λόγους περὶ τοῦ τιμωρήσασθαι Φίλιππον ὁρῶ γιγνομένους, τὰ δὲ πράγματ᾿ εἰς τοῦτο προήκοντα, ὥσθ᾿ ὅπως μὴ πεισόμεθ᾿ αὐτοὶ πρότερον κακῶς σκέψασθαι δέον. οὐδέν οὖν ἄλλο μοι δοκοῦσιν οἱ τὰ τοιαῦτα λέγοντες ἢ τὴν ὑπόθεσιν, περὶ ἧς βουλεύεσθαι, οὐχὶ τὴν οὖσαν παριστάντες ὑμῖν ἁμαρτάνειν. ἐγὼ δέ, ὅτι μέν ποτ᾿ ἐξῆν τῇ πόλει καὶ τὰ αὑτῆς ἔχειν ἀσφαλῶς καὶ Φίλιππον τιμωρήσασθαι, καὶ μάλ᾿ ἀκριβῶς οἶδα· ἐπ᾿ ἐμοῦ γάρ, οὐ πάλαι γέγονεν ταῦτ᾿ ἀμφότερα· νῦν μέντοι πέπεισμαι τοῦθ᾿ ἱκανὸν προλαβεῖν ἡμῖν εἶναι τὴν πρώτην, ὅπως τοὺς συμμάχους σώσομεν. ἐὰν γὰρ τοῦτο βεβαίως ὑπάρξῃ, τότε καὶ περὶ τοῦ τίνα τιμωρήσεταί τις καὶ ὃν τρόπον ἐξέσται σκοπεῖν· πρὶν δὲ τὴν ἀρχὴν ὀρθῶς ὑποθέσθαι, μάταιον ἡγοῦμαι περὶ τῆς τελευτῆς ὁντινοῦν ποιεῖσθαι λόγον. Δημοσθένους, Γ´ ᾿Ολυνθιακὸς Georgian: From a Unicode conference invitation: გთხოვთ ახლავე გაიაროთ რეგისტრაცია Unicode-ის მეათე საერთაშორისო კონფერენციაზე დასასწრებად, რომელიც გაიმართება 10-12 მარტს, ქ. მაინცში, გერმანიაში. კონფერენცია შეჰკრებს ერთად მსოფლიოს ექსპერტებს ისეთ დარგებში როგორიცაა ინტერნეტი და Unicode-ი, ინტერნაციონალიზაცია და ლოკალიზაცია, Unicode-ის გამოყენება ოპერაციულ სისტემებსა, და გამოყენებით პროგრამებში, შრიფტებში, ტექსტების დამუშავებასა და მრავალენოვან კომპიუტერულ სისტემებში. Russian: From a Unicode conference invitation: Зарегистрируйтесь сейчас на Десятую Международную Конференцию по Unicode, которая состоится 10-12 марта 1997 года в Майнце в Германии. Конференция соберет широкий круг экспертов по вопросам глобального Интернета и Unicode, локализации и интернационализации, воплощению и применению Unicode в различных операционных системах и программных приложениях, шрифтах, верстке и многоязычных компьютерных системах. Thai (UCS Level 2): Excerpt from a poetry on The Romance of The Three Kingdoms (a Chinese classic 'San Gua'): [----------------------------|------------------------] ๏ แผ่นดินฮั่นเสื่อมโทรมแสนสังเวช พระปกเกศกองบู๊กู้ขึ้นใหม่ สิบสองกษัตริย์ก่อนหน้าแลถัดไป สององค์ไซร้โง่เขลาเบาปัญญา ทรงนับถือขันทีเป็นที่พึ่ง บ้านเมืองจึงวิปริตเป็นนักหนา โฮจิ๋นเรียกทัพทั่วหัวเมืองมา หมายจะฆ่ามดชั่วตัวสำคัญ เหมือนขับไสไล่เสือจากเคหา รับหมาป่าเข้ามาเลยอาสัญ ฝ่ายอ้องอุ้นยุแยกให้แตกกัน ใช้สาวนั้นเป็นชนวนชื่นชวนใจ พลันลิฉุยกุยกีกลับก่อเหตุ ช่างอาเพศจริงหนาฟ้าร้องไห้ ต้องรบราฆ่าฟันจนบรรลัย ฤๅหาใครค้ำชูกู้บรรลังก์ ฯ (The above is a two-column text. If combining characters are handled correctly, the lines of the second column should be aligned with the | character above.) Ethiopian: Proverbs in the Amharic language: ሰማይ አይታረስ ንጉሥ አይከሰስ። ብላ ካለኝ እንደአባቴ በቆመጠኝ። ጌጥ ያለቤቱ ቁምጥና ነው። ደሀ በሕልሙ ቅቤ ባይጠጣ ንጣት በገደለው። የአፍ ወለምታ በቅቤ አይታሽም። አይጥ በበላ ዳዋ ተመታ። ሲተረጉሙ ይደረግሙ። ቀስ በቀስ፥ ዕንቁላል በእግሩ ይሄዳል። ድር ቢያብር አንበሳ ያስር። ሰው እንደቤቱ እንጅ እንደ ጉረቤቱ አይተዳደርም። እግዜር የከፈተውን ጉሮሮ ሳይዘጋው አይድርም። የጎረቤት ሌባ፥ ቢያዩት ይስቅ ባያዩት ያጠልቅ። ሥራ ከመፍታት ልጄን ላፋታት። ዓባይ ማደሪያ የለው፥ ግንድ ይዞ ይዞራል። የእስላም አገሩ መካ የአሞራ አገሩ ዋርካ። ተንጋሎ ቢተፉ ተመልሶ ባፉ። ወዳጅህ ማር ቢሆን ጨርስህ አትላሰው። እግርህን በፍራሽህ ልክ ዘርጋ። Runes: ᚻᛖ ᚳᚹᚫᚦ ᚦᚫᛏ ᚻᛖ ᛒᚢᛞᛖ ᚩᚾ ᚦᚫᛗ ᛚᚪᚾᛞᛖ ᚾᚩᚱᚦᚹᛖᚪᚱᛞᚢᛗ ᚹᛁᚦ ᚦᚪ ᚹᛖᛥᚫ (Old English, which transcribed into Latin reads 'He cwaeth that he bude thaem lande northweardum with tha Westsae.' and means 'He said that he lived in the northern land near the Western Sea.') Braille: ⡌⠁⠧⠑ ⠼⠁⠒ ⡍⠜⠇⠑⠹⠰⠎ ⡣⠕⠌ ⡍⠜⠇⠑⠹ ⠺⠁⠎ ⠙⠑⠁⠙⠒ ⠞⠕ ⠃⠑⠛⠔ ⠺⠊⠹⠲ ⡹⠻⠑ ⠊⠎ ⠝⠕ ⠙⠳⠃⠞ ⠱⠁⠞⠑⠧⠻ ⠁⠃⠳⠞ ⠹⠁⠞⠲ ⡹⠑ ⠗⠑⠛⠊⠌⠻ ⠕⠋ ⠙⠊⠎ ⠃⠥⠗⠊⠁⠇ ⠺⠁⠎ ⠎⠊⠛⠝⠫ ⠃⠹ ⠹⠑ ⠊⠇⠻⠛⠹⠍⠁⠝⠂ ⠹⠑ ⠊⠇⠻⠅⠂ ⠹⠑ ⠥⠝⠙⠻⠞⠁⠅⠻⠂ ⠁⠝⠙ ⠹⠑ ⠡⠊⠑⠋ ⠍⠳⠗⠝⠻⠲ ⡎⠊⠗⠕⠕⠛⠑ ⠎⠊⠛⠝⠫ ⠊⠞⠲ ⡁⠝⠙ ⡎⠊⠗⠕⠕⠛⠑⠰⠎ ⠝⠁⠍⠑ ⠺⠁⠎ ⠛⠕⠕⠙ ⠥⠏⠕⠝ ⠰⡡⠁⠝⠛⠑⠂ ⠋⠕⠗ ⠁⠝⠹⠹⠔⠛ ⠙⠑ ⠡⠕⠎⠑ ⠞⠕ ⠏⠥⠞ ⠙⠊⠎ ⠙⠁⠝⠙ ⠞⠕⠲ ⡕⠇⠙ ⡍⠜⠇⠑⠹ ⠺⠁⠎ ⠁⠎ ⠙⠑⠁⠙ ⠁⠎ ⠁ ⠙⠕⠕⠗⠤⠝⠁⠊⠇⠲ ⡍⠔⠙⠖ ⡊ ⠙⠕⠝⠰⠞ ⠍⠑⠁⠝ ⠞⠕ ⠎⠁⠹ ⠹⠁⠞ ⡊ ⠅⠝⠪⠂ ⠕⠋ ⠍⠹ ⠪⠝ ⠅⠝⠪⠇⠫⠛⠑⠂ ⠱⠁⠞ ⠹⠻⠑ ⠊⠎ ⠏⠜⠞⠊⠊⠥⠇⠜⠇⠹ ⠙⠑⠁⠙ ⠁⠃⠳⠞ ⠁ ⠙⠕⠕⠗⠤⠝⠁⠊⠇⠲ ⡊ ⠍⠊⠣⠞ ⠙⠁⠧⠑ ⠃⠑⠲ ⠔⠊⠇⠔⠫⠂ ⠍⠹⠎⠑⠇⠋⠂ ⠞⠕ ⠗⠑⠛⠜⠙ ⠁ ⠊⠕⠋⠋⠔⠤⠝⠁⠊⠇ ⠁⠎ ⠹⠑ ⠙⠑⠁⠙⠑⠌ ⠏⠊⠑⠊⠑ ⠕⠋ ⠊⠗⠕⠝⠍⠕⠝⠛⠻⠹ ⠔ ⠹⠑ ⠞⠗⠁⠙⠑⠲ ⡃⠥⠞ ⠹⠑ ⠺⠊⠎⠙⠕⠍ ⠕⠋ ⠳⠗ ⠁⠝⠊⠑⠌⠕⠗⠎ ⠊⠎ ⠔ ⠹⠑ ⠎⠊⠍⠊⠇⠑⠆ ⠁⠝⠙ ⠍⠹ ⠥⠝⠙⠁⠇⠇⠪⠫ ⠙⠁⠝⠙⠎ ⠩⠁⠇⠇ ⠝⠕⠞ ⠙⠊⠌⠥⠗⠃ ⠊⠞⠂ ⠕⠗ ⠹⠑ ⡊⠳⠝⠞⠗⠹⠰⠎ ⠙⠕⠝⠑ ⠋⠕⠗⠲ ⡹⠳ ⠺⠊⠇⠇ ⠹⠻⠑⠋⠕⠗⠑ ⠏⠻⠍⠊⠞ ⠍⠑ ⠞⠕ ⠗⠑⠏⠑⠁⠞⠂ ⠑⠍⠏⠙⠁⠞⠊⠊⠁⠇⠇⠹⠂ ⠹⠁⠞ ⡍⠜⠇⠑⠹ ⠺⠁⠎ ⠁⠎ ⠙⠑⠁⠙ ⠁⠎ ⠁ ⠙⠕⠕⠗⠤⠝⠁⠊⠇⠲ (The first couple of paragraphs of "A Christmas Carol" by Dickens) Compact font selection example text: ABCDEFGHIJKLMNOPQRSTUVWXYZ /0123456789 abcdefghijklmnopqrstuvwxyz £©µÀÆÖÞßéöÿ –—‘“”„†•…‰™œŠŸž€ ΑΒΓΔΩαβγδω АБВГДабвгд ∀∂∈ℝ∧∪≡∞ ↑↗↨↻⇣ ┐┼╔╘░►☺♀ fi�⑀₂ἠḂӥẄɐː⍎אԱა Greetings in various languages: Hello world, Καλημέρα κόσμε, コンニチハ Box drawing alignment tests: █ ▉ ╔══╦══╗ ┌──┬──┐ ╭──┬──╮ ╭──┬──╮ ┏━━┳━━┓ ┎┒┏┑ ╷ ╻ ┏┯┓ ┌┰┐ ▊ ╱╲╱╲╳╳╳ ║┌─╨─┐║ │╔═╧═╗│ │╒═╪═╕│ │╓─╁─╖│ ┃┌─╂─┐┃ ┗╃╄┙ ╶┼╴╺╋╸┠┼┨ ┝╋┥ ▋ ╲╱╲╱╳╳╳ ║│╲ ╱│║ │║ ║│ ││ │ ││ │║ ┃ ║│ ┃│ ╿ │┃ ┍╅╆┓ ╵ ╹ ┗┷┛ └┸┘ ▌ ╱╲╱╲╳╳╳ ╠╡ ╳ ╞╣ ├╢ ╟┤ ├┼─┼─┼┤ ├╫─╂─╫┤ ┣┿╾┼╼┿┫ ┕┛┖┚ ┌┄┄┐ ╎ ┏┅┅┓ ┋ ▍ ╲╱╲╱╳╳╳ ║│╱ ╲│║ │║ ║│ ││ │ ││ │║ ┃ ║│ ┃│ ╽ │┃ ░░▒▒▓▓██ ┊ ┆ ╎ ╏ ┇ ┋ ▎ ║└─╥─┘║ │╚═╤═╝│ │╘═╪═╛│ │╙─╀─╜│ ┃└─╂─┘┃ ░░▒▒▓▓██ ┊ ┆ ╎ ╏ ┇ ┋ ▏ ╚══╩══╝ └──┴──┘ ╰──┴──╯ ╰──┴──╯ ┗━━┻━━┛ ▗▄▖▛▀▜ └╌╌┘ ╎ ┗╍╍┛ ┋ ▁▂▃▄▅▆▇█ ▝▀▘▙▄▟ circuits-2.1.0/tests/web/test_exceptions.py0000644000014400001440000000173312113343751020605 0ustar prologicusers#!/usr/bin/env python from circuits.web import Controller from circuits.web.exceptions import Forbidden, NotFound, Redirect from .helpers import urlopen, HTTPError class Root(Controller): def index(self): return "Hello World!" def test_redirect(self): raise Redirect("/") def test_forbidden(self): raise Forbidden() def test_notfound(self): raise NotFound() def test_redirect(webapp): f = urlopen("%s/test_redirect" % webapp.server.base) s = f.read() assert s == b"Hello World!" def test_forbidden(webapp): try: urlopen("%s/test_forbidden" % webapp.server.base) except HTTPError as e: assert e.code == 403 assert e.msg == "Forbidden" else: assert False def test_notfound(webapp): try: urlopen("%s/test_notfound" % webapp.server.base) except HTTPError as e: assert e.code == 404 assert e.msg == "Not Found" else: assert False circuits-2.1.0/tests/web/test_static.py0000644000014400001440000000225412113343751017712 0ustar prologicusers#!/usr/bin/env python from circuits.web import Controller from .helpers import quote, urlopen, HTTPError class Root(Controller): def index(self): return "Hello World!" def test(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" def test_404(webapp): try: urlopen("%s/foo" % webapp.server.base) except HTTPError as e: assert e.code == 404 assert e.msg == "Not Found" else: assert False def test_file(webapp): url = "%s/static/helloworld.txt" % webapp.server.base f = urlopen(url) s = f.read().strip() assert s == b"Hello World!" def test_file404(webapp): try: urlopen("%s/static/foo.txt" % webapp.server.base) except HTTPError as e: assert e.code == 404 assert e.msg == "Not Found" else: assert False def test_directory(webapp): f = urlopen("%s/static/" % webapp.server.base) s = f.read() assert b"helloworld.txt" in s def test_file_quoating(webapp): url = "{0:s}{1:s}".format(webapp.server.base, quote("/static/#foobar.txt")) f = urlopen(url) s = f.read().strip() assert s == b"Hello World!" circuits-2.1.0/tests/web/test_yield.py0000644000014400001440000000044012113343751017524 0ustar prologicusers#!/usr/bin/env python from circuits.web import Controller from .helpers import urlopen class Root(Controller): def index(self): yield "Hello " yield "World!" def test(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" circuits-2.1.0/tests/web/test_wsgi_gateway_yield.py0000644000014400001440000000055212113343751022302 0ustar prologicusers#!/usr/bin/env python from .helpers import urlopen def application(environ, start_response): status = "200 OK" response_headers = [("Content-type", "text/plain")] start_response(status, response_headers) yield "Hello " yield "World!" def test(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" circuits-2.1.0/tests/web/test_wsgi_gateway_null_response.py0000644000014400001440000000057712113343751024073 0ustar prologicusers#!/usr/bin/env python from .helpers import urlopen from circuits.web import Controller class Root(Controller): def index(self, *args, **kwargs): return "ERROR" def application(environ, start_response): status = "200 OK" start_response(status, []) return [""] def test(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"" circuits-2.1.0/tests/web/test_vpath_args.py0000644000014400001440000000124412113343751020557 0ustar prologicusers#!/usr/bin/env python from circuits.web import expose, Controller from .helpers import urlopen class Root(Controller): @expose("test.txt") def index(self): return "Hello world!" class Leaf(Controller): channel = "/test" @expose("test.txt") def index(self, vpath=None): if vpath is None: return "Hello world!" else: return "Hello world! " + vpath def test(webapp): Leaf().register(webapp) f = urlopen(webapp.server.base + "/test.txt") s = f.read() assert s == b"Hello world!" f = urlopen(webapp.server.base + "/test/test.txt") s = f.read() assert s == b"Hello world!" circuits-2.1.0/tests/web/test_large_post.py0000644000014400001440000000121512113343751020556 0ustar prologicusers#!/usr/bin/env python from circuits.web import Controller from .helpers import urlencode, urlopen class Root(Controller): def index(self, *args, **kwargs): args = tuple(( x.encode("utf-8") if type(x) != str else x for x in args )) return "{0}\n{1}".format(repr(args), repr(kwargs)) def test(webapp): args = ("1", "2", "3") kwargs = {"data": "\x00" * 4096} url = "%s/%s" % (webapp.server.base, "/".join(args)) data = urlencode(kwargs).encode('utf-8') f = urlopen(url, data) data = f.read().split(b"\n") assert eval(data[0]) == args assert eval(data[1]) == kwargs circuits-2.1.0/tests/web/test_http.py0000644000014400001440000000226612113343751017405 0ustar prologicusers#!/usr/bin/env python import pytest from circuits import Component from circuits.web import Controller from circuits.web.client import parse_url from circuits.net.sockets import TCPClient from circuits.net.sockets import Connect, Write class Client(Component): def __init__(self, *args, **kwargs): super(Client, self).__init__(*args, **kwargs) self._buffer = [] self.done = False def read(self, data): self._buffer.append(data) if data.find(b"\r\n") != -1: self.done = True def buffer(self): return b''.join(self._buffer) class Root(Controller): def index(self): return "Hello World!" def test(webapp): transport = TCPClient() client = Client() client += transport client.start() host, port, resource, secure = parse_url(webapp.server.base) client.fire(Connect(host, port)) assert pytest.wait_for(transport, "connected") client.fire(Write(b"GET / HTTP/1.1\r\n")) client.fire(Write(b"Content-Type: text/plain\r\n\r\n")) assert pytest.wait_for(client, "done") client.stop() s = client.buffer().decode('utf-8').split('\r\n')[0] assert s == "HTTP/1.1 200 OK" circuits-2.1.0/tests/web/test_request_failure.py0000644000014400001440000000077712113343751021632 0ustar prologicusers#!/usr/bin/env python from .helpers import urlopen, HTTPError from circuits.core.handlers import handler from circuits.core.components import BaseComponent class Root(BaseComponent): channel = "web" @handler("request", filter=True, priority=0.2) def request(self, request, response): raise Exception() def test(webapp): try: Root().register(webapp) urlopen(webapp.server.base) except HTTPError as e: assert e.code == 500 else: assert False circuits-2.1.0/tests/web/test_cookies.py0000644000014400001440000000124012113343751020051 0ustar prologicusers#!/usr/bin/env python from circuits.web import Controller from .helpers import build_opener, HTTPCookieProcessor from .helpers import CookieJar class Root(Controller): def index(self): visited = self.cookie.get("visited") if visited and visited.value: return "Hello again!" else: self.cookie["visited"] = True return "Hello World!" def test(webapp): cj = CookieJar() opener = build_opener(HTTPCookieProcessor(cj)) f = opener.open(webapp.server.base) s = f.read() assert s == b"Hello World!" f = opener.open(webapp.server.base) s = f.read() assert s == b"Hello again!" circuits-2.1.0/tests/web/jsonrpclib.py0000644000014400001440000003062212113343751017531 0ustar prologicusers# a port of xmlrpclib to json.... # # # The JSON-RPC client interface is based on the XML-RPC client # # Copyright (c) 1999-2002 by Secret Labs AB # Copyright (c) 1999-2002 by Fredrik Lundh # Copyright (c) 2006 by Matt Harrison # # By obtaining, using, and/or copying this software and/or its # associated documentation, you agree that you have read, understood, # and will comply with the following terms and conditions: # # Permission to use, copy, modify, and distribute this software and # its associated documentation for any purpose and without fee is # hereby granted, provided that the above copyright notice appears in # all copies, and that both that copyright notice and this permission # notice appear in supporting documentation, and that the name of # Secret Labs AB or the author not be used in advertising or publicity # pertaining to distribution of the software without specific, written # prior permission. # # SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD # TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANT- # ABILITY AND FITNESS. IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR # BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY # DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, # WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS # ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE # OF THIS SOFTWARE. # -------------------------------------------------------------------- import json import base64 try: from http.client import HTTPConnection from http.client import HTTPSConnection except ImportError: from httplib import HTTP as HTTPConnection # NOQA from httplib import HTTPS as HTTPSConnection # NOQA try: from urllib.parse import unquote from urllib.parse import splithost, splittype, splituser except ImportError: from urllib import unquote # NOQA from urllib import splithost, splittype, splituser # NOQA __version__ = "0.0.1" ID = 1 def _gen_id(): global ID ID = ID + 1 return ID # -------------------------------------------------------------------- # Exceptions ## # Base class for all kinds of client-side errors. class Error(Exception): """Base class for client errors.""" def __str__(self): return repr(self) ## # Indicates an HTTP-level protocol error. This is raised by the HTTP # transport layer, if the server returns an error code other than 200 # (OK). # # @param url The target URL. # @param errcode The HTTP error code. # @param errmsg The HTTP error message. # @param headers The HTTP header dictionary. class ProtocolError(Error): """Indicates an HTTP protocol error.""" def __init__(self, url, errcode, errmsg, headers, response): Error.__init__(self) self.url = url self.errcode = errcode self.errmsg = errmsg self.headers = headers self.response = response def __repr__(self): return ( "" % (self.url, self.errcode, self.errmsg) ) def getparser(encoding): un = Unmarshaller(encoding) par = Parser(un) return par, un def dumps(params, methodname=None, methodresponse=None, encoding=None, allow_none=0): if methodname: request = {} request["method"] = methodname request["params"] = params request["id"] = _gen_id() return json.dumps(request) class Unmarshaller(object): def __init__(self, encoding): self.data = None self.encoding = encoding def feed(self, data): if self.data is None: self.data = data else: self.data = self.data + data def close(self): #try to convert string to json return json.loads(self.data.decode(self.encoding)) class Parser(object): def __init__(self, unmarshaller): self._target = unmarshaller self.data = None def feed(self, data): if self.data is None: self.data = data else: self.data = self.data + data def close(self): self._target.feed(self.data) class _Method(object): # some magic to bind an JSON-RPC method to an RPC server. # supports "nested" methods (e.g. examples.getStateName) def __init__(self, send, name): self.__send = send self.__name = name def __getattr__(self, name): return _Method(self.__send, "%s.%s" % (self.__name, name)) def __call__(self, *args): return self.__send(self.__name, args) ## # Standard transport class for JSON-RPC over HTTP. #

          # You can create custom transports by subclassing this method, and # overriding selected methods. class Transport: """Handles an HTTP transaction to an JSON-RPC server.""" # client identifier (may be overridden) user_agent = "jsonlib.py/%s (by matt harrison)" % __version__ ## # Send a complete request, and parse the response. # # @param host Target host. # @param handler Target PRC handler. # @param request_body JSON-RPC request body. # @param verbose Debugging flag. # @return Parsed response. def request(self, host, handler, request_body, encoding, verbose=0): # issue JSON-RPC request h = self.make_connection(host) if verbose: h.set_debuglevel(1) self.send_request(h, handler, request_body) self.send_host(h, host) self.send_user_agent(h) self.send_content(h, request_body) try: errcode, errmsg, headers = h.getreply() r = h.getfile() except AttributeError: r = h.getresponse() errcode = r.status errmsg = r.reason headers = r.getheaders() if errcode != 200: response = r.read() raise ProtocolError( host + handler, errcode, errmsg, headers, response ) self.verbose = verbose try: sock = h._conn.sock except AttributeError: sock = None return self._parse_response(r, sock, encoding) ## # Create parser. # # @return A 2-tuple containing a parser and a unmarshaller. def getparser(self, encoding): # get parser and unmarshaller return getparser(encoding) ## # Get authorization info from host parameter # Host may be a string, or a (host, x509-dict) tuple; if a string, # it is checked for a "user:pw@host" format, and a "Basic # Authentication" header is added if appropriate. # # @param host Host descriptor (URL or (URL, x509 info) tuple). # @return A 3-tuple containing (actual host, extra headers, # x509 info). The header and x509 fields may be None. def get_host_info(self, host): x509 = {} if isinstance(host, tuple): host, x509 = host auth, host = splituser(host) if auth: auth = base64.encodestring(unquote(auth)) auth = "".join(auth.split()) # get rid of whitespace extra_headers = [ ("Authorization", "Basic " + auth) ] else: extra_headers = None return host, extra_headers, x509 ## # Connect to server. # # @param host Target host. # @return A connection handle. def make_connection(self, host): # create a HTTP connection object from a host descriptor host, extra_headers, x509 = self.get_host_info(host) return HTTPConnection(host) ## # Send request header. # # @param connection Connection handle. # @param handler Target RPC handler. # @param request_body JSON-RPC body. def send_request(self, connection, handler, request_body): connection.putrequest("POST", handler) ## # Send host name. # # @param connection Connection handle. # @param host Host name. def send_host(self, connection, host): host, extra_headers, x509 = self.get_host_info(host) connection.putheader("Host", host) if extra_headers: if isinstance(extra_headers, dict): extra_headers = list(extra_headers.items()) for key, value in extra_headers: connection.putheader(key, value) ## # Send user-agent identifier. # # @param connection Connection handle. def send_user_agent(self, connection): connection.putheader("User-Agent", self.user_agent) ## # Send request body. # # @param connection Connection handle. # @param request_body JSON-RPC request body. def send_content(self, connection, request_body): connection.putheader("Content-Type", "text/xml") connection.putheader("Content-Length", str(len(request_body))) connection.endheaders() if request_body: connection.send(request_body) ## # Parse response. # # @param file Stream. # @return Response tuple and target method. def parse_response(self, file): # compatibility interface return self._parse_response(file, None) ## # Parse response (alternate interface). This is similar to the # parse_response method, but also provides direct access to the # underlying socket object (where available). # # @param file Stream. # @param sock Socket handle (or None, if the socket object # could not be accessed). # @return Response tuple and target method. def _parse_response(self, file, sock, encoding): # read response from input file/socket, and parse it p, u = self.getparser(encoding) while 1: if sock: response = sock.recv(1024) else: response = file.read(1024) if not response: break if self.verbose: print("body:", repr(response)) p.feed(response) file.close() p.close() return u.close() ## # Standard transport class for JSON-RPC over HTTPS. class SafeTransport(Transport): """Handles an HTTPS transaction to an JSON-RPC server.""" # FIXME: mostly untested def make_connection(self, host): # create a HTTPS connection object from a host descriptor # host may be a string, or a (host, x509-dict) tuple host, extra_headers, x509 = self.get_host_info(host) try: HTTPS = HTTPSConnection except AttributeError: raise NotImplementedError( "your version of httplib doesn't support HTTPS" ) else: return HTTPS(host, None, **(x509 or {})) class ServerProxy(object): def __init__(self, uri, transport=None, encoding=None, verbose=None, allow_none=0): utype, uri = splittype(uri) if utype not in ("http", "https"): raise IOError("Unsupported JSONRPC protocol") self.__host, self.__handler = splithost(uri) if not self.__handler: self.__handler = "/RPC2" if transport is None: if utype == "https": transport = SafeTransport() else: transport = Transport() self.__transport = transport self.__encoding = encoding self.__verbose = verbose self.__allow_none = allow_none def __request(self, methodname, params): """call a method on the remote server """ request = dumps(params, methodname, encoding=self.__encoding, allow_none=self.__allow_none) response = self.__transport.request( self.__host, self.__handler, request.encode(self.__encoding), self.__encoding, verbose=self.__verbose ) if len(response) == 1: response = response[0] return response def __repr__(self): return ("" % (self.__host, self.__handler) ) __str__ = __repr__ def __getattr__(self, name): #dispatch return _Method(self.__request, name) # note: to call a remote object with an non-standard name, use # result getattr(server, "strange-python-name")(args) if __name__ == "__main__": s = ServerProxy("http://localhost:8080/foo/", verbose=1) c = s.echo("foo bar") print(c) d = s.bad("other") print(d) e = s.echo("foo bar", "baz") print(e) f = s.echo(5) print(f) circuits-2.1.0/tests/web/test_xmlrpc.py0000644000014400001440000000140512113343751017725 0ustar prologicusers#!/usr/bin/env python try: from xmlrpc.client import ServerProxy except ImportError: from xmlrpclib import ServerProxy # NOQA from circuits import Component from circuits.web import Controller, XMLRPC from .helpers import urlopen class Test(Component): def eval(self, s): return eval(s) class Root(Controller): def index(self): return "Hello World!" def test(webapp): rpc = XMLRPC("/rpc") test = Test() rpc.register(webapp) test.register(webapp) f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" url = "%s/rpc/" % webapp.server.base server = ServerProxy(url, allow_none=True) r = server.eval("1 + 2") assert r == 3 rpc.unregister() test.unregister() circuits-2.1.0/tests/web/test_serve_download.py0000644000014400001440000000161612113343751021437 0ustar prologicusers#!/usr/bin/env python import os from tempfile import mkstemp from circuits import handler from circuits.web import Controller from .helpers import urlopen class Root(Controller): @handler("started", priority=1.0, channel="*") def _on_started(self, component): fd, self.filename = mkstemp() os.write(fd, b"Hello World!") os.close(fd) @handler("stopped", channel="(") def _on_stopped(self, component): os.remove(self.filename) def index(self): return self.serve_download(self.filename) def test(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" contentType = f.headers["Content-Type"] contentDisposition = f.headers["Content-Disposition"] assert contentType == "application/x-download" assert contentDisposition.startswith("attachment;") assert "filename" in contentDisposition circuits-2.1.0/tests/web/test_value.py0000644000014400001440000000072012113343751017533 0ustar prologicusers#!/usr/bin/env python from circuits.web import Controller from circuits import Event, Component from .helpers import urlopen class Hello(Event): """Hello Event""" class Test(Component): def hello(self): return "Hello World!" class Root(Controller): def index(self): return self.fire(Hello()) def test(webapp): Test().register(webapp) f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" circuits-2.1.0/tests/web/__init__.py0000644000014400001440000000000012072034467017113 0ustar prologicuserscircuits-2.1.0/tests/web/test_encodings.py0000644000014400001440000000156212113343751020375 0ustar prologicusersfrom circuits.web import Controller from .helpers import urlopen class Root(Controller): def index(self): return "Hello World!".encode('utf-16be') def foo(self): return b"Hello World!".decode() def test_utf_16_manual(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == "Hello World!".encode('utf-16be') def test_utf_16_server(): from circuits import Component class WebApp(Component): def __init__(self): super(WebApp, self).__init__() from circuits.web import Server self.server = Server(0, encoding='utf-16be').register(self) webapp = WebApp() Root().register(webapp) webapp.start() try: f = urlopen("%s/foo" % webapp.server.base) s = f.read() assert s == "Hello World!".encode('utf-16be') finally: webapp.stop() circuits-2.1.0/tests/web/test_digestauth.py0000644000014400001440000000202512113343751020560 0ustar prologicusers#!/usr/bin/env python import pytest if pytest.PYVER[:2] == (3, 3): pytest.skip("Broken on Python 3.3") from circuits.web import Controller from circuits.web.tools import check_auth, digest_auth from .helpers import HTTPError, HTTPDigestAuthHandler from .helpers import urlopen, build_opener, install_opener class Root(Controller): def index(self): realm = "Test" users = {"admin": "admin"} if check_auth(self.request, self.response, realm, users): return "Hello World!" return digest_auth(self.request, self.response, realm, users) def test(webapp): try: f = urlopen(webapp.server.base) except HTTPError as e: assert e.code == 401 assert e.msg == "Unauthorized" else: assert False handler = HTTPDigestAuthHandler() handler.add_password("Test", webapp.server.base, "admin", "admin") opener = build_opener(handler) install_opener(opener) f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" circuits-2.1.0/tests/web/test_wsgi_gateway_errors.py0000644000014400001440000000102512113343751022504 0ustar prologicusersfrom .helpers import urlopen, HTTPError def application(environ, start_response): status = "200 OK" response_headers = [("Content-type", "text/plain")] start_response(status, response_headers) raise Exception("Hello World!") def test(webapp): try: urlopen(webapp.server.base) except HTTPError as e: assert e.code == 500 assert e.msg == "Internal Server Error" s = e.read() assert b"Exception" in s assert b"Hello World!" in s else: assert False circuits-2.1.0/tests/web/test_wsgi_gateway_write.py0000644000014400001440000000056612113343751022333 0ustar prologicusers#!/usr/bin/env python from .helpers import urlopen def application(environ, start_response): status = "200 OK" response_headers = [("Content-type", "text/plain")] write = start_response(status, response_headers) write("Hello World!") return [""] def test(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" circuits-2.1.0/tests/web/test_generator.py0000644000014400001440000000053212113343751020406 0ustar prologicusers#!/usr/bin/env python from circuits.web import Controller from .helpers import urlopen class Root(Controller): def index(self): def response(): yield "Hello " yield "World!" return response() def test(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" circuits-2.1.0/tests/web/test_basicauth.py0000644000014400001440000000171412113343751020366 0ustar prologicusersfrom circuits.web import Controller from circuits.web.tools import check_auth, basic_auth from .helpers import HTTPError, HTTPBasicAuthHandler from .helpers import urlopen, build_opener, install_opener class Root(Controller): def index(self): realm = "Test" users = {"admin": "admin"} encrypt = str if check_auth(self.request, self.response, realm, users, encrypt): return "Hello World!" return basic_auth(self.request, self.response, realm, users, encrypt) def test(webapp): try: f = urlopen(webapp.server.base) except HTTPError as e: assert e.code == 401 assert e.msg == "Unauthorized" else: assert False handler = HTTPBasicAuthHandler() handler.add_password("Test", webapp.server.base, "admin", "admin") opener = build_opener(handler) install_opener(opener) f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" circuits-2.1.0/tests/web/test_wsgi_gateway_generator.py0000644000014400001440000000063612113343751023165 0ustar prologicusers#!/usr/bin/env python from .helpers import urlopen def application(environ, start_response): status = "200 OK" response_headers = [("Content-type", "text/plain")] start_response(status, response_headers) def response(): yield "Hello " yield "World!" return response() def test(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" circuits-2.1.0/tests/web/test_conn.py0000644000014400001440000000124212113343751017354 0ustar prologicusers#!/usr/bin/env python try: from httplib import HTTPConnection except ImportError: from http.client import HTTPConnection # NOQA from circuits.web import Controller class Root(Controller): def index(self): return "Hello World!" def test(webapp): connection = HTTPConnection(webapp.server.host, webapp.server.port) connection.auto_open = False connection.connect() for i in range(2): connection.request("GET", "/") response = connection.getresponse() assert response.status == 200 assert response.reason == "OK" s = response.read() assert s == b"Hello World!" connection.close() circuits-2.1.0/tests/web/test_core.py0000644000014400001440000000377712113343751017366 0ustar prologicusers#!/usr/bin/env python from circuits.web import Controller from .helpers import urlencode, urlopen, HTTPError class Root(Controller): def index(self): return "Hello World!" def test_args(self, *args, **kwargs): args = tuple( (x.encode('utf-8') if type(x) != str else x for x in args) ) return "{0}\n{1}".format(repr(args), repr(kwargs)) def test_redirect(self): return self.redirect("/") def test_forbidden(self): return self.forbidden() def test_notfound(self): return self.notfound() def test_failure(self): raise Exception() def test_root(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" def test_404(webapp): try: urlopen("%s/foo" % webapp.server.base) except HTTPError as e: assert e.code == 404 assert e.msg == "Not Found" else: assert False def test_args(webapp): args = ("1", "2", "3") kwargs = {"1": "one", "2": "two", "3": "three"} url = "%s/test_args/%s" % (webapp.server.base, "/".join(args)) data = urlencode(kwargs).encode('utf-8') f = urlopen(url, data) data = f.read().split(b"\n") assert eval(data[0]) == args assert eval(data[1]) == kwargs def test_redirect(webapp): f = urlopen("%s/test_redirect" % webapp.server.base) s = f.read() assert s == b"Hello World!" def test_forbidden(webapp): try: urlopen("%s/test_forbidden" % webapp.server.base) except HTTPError as e: assert e.code == 403 assert e.msg == "Forbidden" else: assert False def test_notfound(webapp): try: urlopen("%s/test_notfound" % webapp.server.base) except HTTPError as e: assert e.code == 404 assert e.msg == "Not Found" else: assert False def test_failure(webapp): try: urlopen("%s/test_failure" % webapp.server.base) except HTTPError as e: assert e.code == 500 else: assert False circuits-2.1.0/tests/web/test_headers.py0000644000014400001440000000224012113343751020031 0ustar prologicusers#!/usr/bin/env python from circuits.web import Controller from .helpers import urlopen class Root(Controller): def index(self): return "Hello World!" def foo(self): self.response.headers["Content-Type"] = "text/plain" return "Hello World!" def empty(self): return "" def test_default(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"Hello World!" content_type = f.headers["Content-Type"] assert content_type == "text/html; charset=utf-8" def test_explicit(webapp): f = urlopen("{0:s}/foo".format(webapp.server.base)) s = f.read() assert s == b"Hello World!" content_type = f.headers["Content-Type"] assert content_type == "text/plain" def test_static(webapp): f = urlopen("{0:s}/static/test.css".format(webapp.server.base)) s = f.read() assert s == b"body { }\n" content_type = f.headers["Content-Type"] assert content_type == "text/css" def test_empty(webapp): f = urlopen("{0:s}/empty".format(webapp.server.base)) s = f.read() assert s == b"" content_length = f.headers["Content-Length"] assert int(content_length) == 0 circuits-2.1.0/tests/web/test_utils.py0000644000014400001440000000115212113343751017557 0ustar prologicusers#!/usr/bin/env python from io import BytesIO try: from gzip import decompress except ImportError: import zlib decompress = zlib.decompressobj(16+zlib.MAX_WBITS).decompress # NOQA from circuits.web.utils import compress from circuits.web.utils import get_ranges def test_ranges(): assert get_ranges("bytes=3-6", 8) == [(3, 7)] assert get_ranges("bytes=2-4,-1", 8) == [(2, 5), (7, 8)] def test_gzip(): s = b"Hello World!" contents = BytesIO(s) compressed = b"".join(compress(contents, 1)) uncompressed = decompress(compressed) assert uncompressed == s contents.close() circuits-2.1.0/tests/web/test_dispatcher2.py0000644000014400001440000000377512072034467020651 0ustar prologicusers#!/usr/bin/env python # -*- coding: utf-8 -*- from circuits.web import expose, Controller from .helpers import urlopen class Root(Controller): def __init__(self, *args, **kwargs): super(Root, self).__init__(*args, **kwargs) self += Hello() self += World() def index(self): return "index" def hello1(self): return "hello1" @expose("hello2") def hello2(self): return "hello2" def query(req, test): return 'query %s' % test class Hello(Controller): channel = "/hello" def index(self): return 'hello index' def test(self): return 'hello test' def query(req, test): return 'hello query %s' % test class World(Controller): channel = "/world" def index(self): return 'world index' def test(self): return 'world test' def test_simple(webapp): url = "%s/hello1" % webapp.server.base f = urlopen(url) s = f.read() assert s == b"hello1" def test_expose(webapp): url = "%s/hello2" % webapp.server.base f = urlopen(url) s = f.read() assert s == b"hello2" def test_index(webapp): f = urlopen(webapp.server.base) s = f.read() assert s == b"index" def test_controller_index(webapp): url = "%s/hello/" % webapp.server.base f = urlopen(url) s = f.read() assert s == b"hello index" url = "%s/world/" % webapp.server.base f = urlopen(url) s = f.read() assert s == b"world index" def test_controller_expose(webapp): url = "%s/hello/test" % webapp.server.base f = urlopen(url) s = f.read() assert s == b"hello test" url = "%s/world/test" % webapp.server.base f = urlopen(url) s = f.read() assert s == b"world test" def test_query(webapp): url = "%s/query?test=1" % webapp.server.base f = urlopen(url) s = f.read() assert s == b"query 1" url = "%s/hello/query?test=2" % webapp.server.base f = urlopen(url) s = f.read() assert s == b"hello query 2" circuits-2.1.0/tests/web/test_dispatcher3.py0000644000014400001440000000150312113343751020630 0ustar prologicusers#!/usr/bin/env python import pytest try: from httplib import HTTPConnection except ImportError: from http.client import HTTPConnection # NOQA from circuits.web import Controller class Root(Controller): def GET(self): return "GET" def PUT(self): return "PUT" def POST(self): return "POST" def DELETE(self): return "DELETE" @pytest.mark.parametrize(("method"), ["GET", "PUT", "POST", "DELETE"]) def test(webapp, method): connection = HTTPConnection(webapp.server.host, webapp.server.port) connection.connect() connection.request(method, "/") response = connection.getresponse() assert response.status == 200 assert response.reason == "OK" s = response.read() assert s == "{0:s}".format(method).encode("utf-8") connection.close() circuits-2.1.0/tests/core/0000755000014400001440000000000012113366740015165 5ustar prologicuserscircuits-2.1.0/tests/core/test_signals.py0000644000014400001440000000176712113343751020246 0ustar prologicusers#!/usr/bin/env python import pytest import os import sys def test(tmpdir): if not os.name == "posix": pytest.skip("Cannot run test on a non-POSIX platform.") from time import sleep from subprocess import Popen from signal import SIGTERM from tests.core import signalapp tmpdir.ensure(".pid") tmpdir.ensure(".signal") pidfile = str(tmpdir.join(".pid")) signalfile = str(tmpdir.join(".signal")) args = [sys.executable, signalapp.__file__, pidfile, signalfile] cmd = " ".join(args) p = Popen(cmd, shell=True, env={'PYTHONPATH': ':'.join(sys.path)}) status = p.wait() assert status == 0 sleep(1) assert os.path.exists(pidfile) assert os.path.isfile(pidfile) f = open(pidfile, "r") pid = int(f.read().strip()) f.close() os.kill(pid, SIGTERM) sleep(1) f = open(signalfile, "r") signal = f.read().strip() f.close() assert signal == str(SIGTERM) os.remove(pidfile) os.remove(signalfile) circuits-2.1.0/tests/core/test_component_targeting.py0000644000014400001440000000126012113343751022640 0ustar prologicusers#!/usr/bin/env python import pytest from circuits import Component, Event class App(Component): channel = "app" def hello(self): return "Hello World!" def registered(self, component, manager): if component is self: self.fire(Event.create("Ready")) @pytest.fixture(scope="module") def app(request, manager, watcher): app = App().register(manager) def finalizer(): app.unregister() request.addfinalizer(finalizer) assert watcher.wait("ready") return app def test(manager, watcher, app): x = manager.fire(Event.create("Hello"), app) assert watcher.wait("hello") assert x.value == "Hello World!" circuits-2.1.0/tests/core/test_filter_order.py0000644000014400001440000000147412113343751021261 0ustar prologicusers# Module: test_filter_order # Date: 23rd February 2010 # Author: James Mills, prologic at shortcircuit dot net dot au """Filter Order Tests Test that Event Handlers set as Filters are added and sorted such that Filters preceed non-filters. """ from circuits import handler, Component, Event class Test(Event): pass class App(Component): def __init__(self): super(App, self).__init__() self.events_executed = [] def test(self, event, *args, **kwargs): self.events_executed.append('test') @handler("test", filter=True) def on_test(self, event, *args, **kwargs): self.events_executed.append('test_filter') return True def test(): app = App() app.fire(Test()) while app: app.flush() assert app.events_executed == ['test_filter'] circuits-2.1.0/tests/core/test_timers.py0000644000014400001440000000350112113343751020075 0ustar prologicusers# Module: test_timers # Date: 10th February 2010 # Author: James Mills, prologic at shortcircuit dot net dot au import time """Timers Tests""" import pytest from datetime import datetime, timedelta from circuits import Event, Component, Timer def pytest_funcarg__app(request): return request.cached_setup( setup=lambda: setupapp(request), teardown=lambda app: teardownapp(app), scope="module" ) def setupapp(request): app = App() app.start() return app def teardownapp(app): app.stop() class Test(Event): """Test Event""" class App(Component): def __init__(self): super(App, self).__init__() self.flag = False self.count = 0 self.timestamps = [] def reset(self): self.timestamps = [] self.flag = False self.count = 0 def test(self): self.timestamps.append(time.time()) self.count += 1 self.flag = True def test_timer(app): timer = Timer(0.1, Test(), "timer") timer.register(app) assert pytest.wait_for(app, "flag") app.reset() def test_persistentTimer(app): app.timestamps.append(time.time()) timer = Timer(0.2, Test(), "timer", persist=True) timer.register(app) wait_res = pytest.wait_for(app, "count", 2) assert app.count >= 2 assert wait_res delta = app.timestamps[1] - app.timestamps[0] # Should be 0.1, but varies depending on timer precision and load assert delta >= 0.08 and delta < 0.5 delta = app.timestamps[2] - app.timestamps[1] assert delta >= 0.08 and delta < 0.5 app.reset() timer.unregister() def test_datetime(app): now = datetime.now() d = now + timedelta(seconds=0.1) timer = Timer(d, Test(), "timer") timer.register(app) assert pytest.wait_for(app, "flag") app.reset() circuits-2.1.0/tests/core/test_inheritence.py0000644000014400001440000000141612113343751021072 0ustar prologicusers#!/usr/bin/env python import pytest from circuits import handler, Event, Component class Test(Event): """Test Event""" class Base(Component): def test(self): return "Hello World!" class App1(Base): @handler("test", priority=-1) def test(self): return "Foobar" class App2(Base): @handler("test", override=True) def test(self): return "Foobar" def test_inheritence(): app = App1() app.start() x = app.fire(Test()) assert pytest.wait_for(x, "result") v = x.value assert v == ["Hello World!", "Foobar"] app.stop() def test_override(): app = App2() app.start() x = app.fire(Test()) assert pytest.wait_for(x, "result") v = x.value assert v == "Foobar" app.stop() circuits-2.1.0/tests/core/test_channel_selection.py0000644000014400001440000000177212072034467022264 0ustar prologicusers#!/usr/bin/python -i from circuits import Event, Component, Manager class Foo(Event): """Foo Event""" channels = ("a",) class Bar(Event): """Bar Event""" class A(Component): channel = "a" def foo(self): return "Foo" class B(Component): channel = "b" def foo(self): return "Hello World!" class C(Component): channel = "c" def foo(self): return self.fire(Bar()) def bar(self): return "Bar" def test(): m = Manager() + A() + B() + C() while m: m.flush() # Rely on Event.channels x = m.fire(Foo()) m.flush() assert x.value == "Foo" # Explicitly specify the channel x = m.fire(Foo(), "b") m.flush() assert x.value == "Hello World!" # Explicitly specify a set of channels x = m.fire(Foo(), "a", "b") m.flush() assert x.value == ["Foo", "Hello World!"] # Rely on self.channel x = m.fire(Foo(), "c") m.flush() m.flush() assert x.value == "Bar" circuits-2.1.0/tests/core/test_dynamic_handlers.py0000644000014400001440000000153012113343751022076 0ustar prologicusers#!/usr/bin/env python import pytest from circuits import handler, Event, Manager class Foo(Event): """Foo Event""" @handler("foo") def on_foo(self): return "Hello World!" def test_addHandler(): m = Manager() m.start() m.addHandler(on_foo) waiter = pytest.WaitEvent(m, "foo") x = m.fire(Foo()) waiter.wait() s = x.value assert s == "Hello World!" m.stop() def test_removeHandler(): m = Manager() m.start() method = m.addHandler(on_foo) waiter = pytest.WaitEvent(m, "foo") x = m.fire(Foo()) waiter.wait() s = x.value assert s == "Hello World!" m.removeHandler(method) waiter = pytest.WaitEvent(m, "foo") x = m.fire(Foo()) waiter.wait() assert x.value is None assert on_foo not in dir(m) assert "foo" not in m._handlers m.stop() circuits-2.1.0/tests/core/test_worker_thread.py0000644000014400001440000000145412113343751021437 0ustar prologicusers# Module: test_workers # Date: 7th October 2008 # Author: James Mills, prologic at shortcircuit dot net dot au """Workers Tests""" import pytest from circuits import Task, Worker @pytest.fixture(scope="module") def worker(request): worker = Worker() def finalizer(): worker.stop() request.addfinalizer(finalizer) if request.config.option.verbose: from circuits import Debugger Debugger().register(worker) waiter = pytest.WaitEvent(worker, "started") worker.start() assert waiter.wait() return worker def f(): x = 0 i = 0 while i < 1000000: x += 1 i += 1 return x def test(worker): x = worker.fire(Task(f)) assert pytest.wait_for(x, "result") assert x.result assert x.value == 1000000 circuits-2.1.0/tests/core/test_interface_query.py0000644000014400001440000000124112113343751021756 0ustar prologicusers#!/usr/bin/env python """Test Interface Query Test the capabilities of querying a Component class or instance for it's interface. That is it's event handlers it responds to. """ from circuits import Component class Base(Component): def foo(self): pass class SuperBase(Base): def bar(self): pass def test_handles_base_class(): assert Base.handles("foo") def test_handles_super_base_class(): assert SuperBase.handles("foo", "bar") def test_handles_base_instance(): base = Base() assert base.handles("foo") def test_handles_super_base_instance(): superbase = SuperBase() assert superbase.handles("foo", "bar") circuits-2.1.0/tests/core/test_loader.py0000644000014400001440000000063212072034467020047 0ustar prologicusers#!/usr/bin/env python from os.path import dirname import pytest from circuits import Event, Loader, Manager class Test(Event): """Test Event""" def test(): m = Manager() loader = Loader(paths=[dirname(__file__)]).register(m) m.start() loader.load("app") x = m.fire(Test()) assert pytest.wait_for(x, "result") s = x.value assert s == "Hello World!" m.stop() circuits-2.1.0/tests/core/test_generate_events.py0000755000014400001440000000205212113343751021753 0ustar prologicusers#!/usr/bin/env python import pytest from circuits import Component, Event class App(Component): def init(self): self._ready = False self._done = False self._counter = 0 def registered(self, component, manager): if component is self: self.fire(Event.create("Ready")) def generate_events(self, event): if not self._ready or self._done: return if self._counter < 10: self.fire(Event.create("Hello")) else: self.fire(Event.create("Done")) event.reduce_time_left(0) def done(self): self._done = True def hello(self): self._counter += 1 def ready(self): self._ready = True @pytest.fixture(scope="module") def app(request, manager, watcher): app = App().register(manager) def finalizer(): app.unregister() request.addfinalizer(finalizer) assert watcher.wait("ready") return app def test(manager, watcher, app): watcher.wait("done") assert app._counter == 10 circuits-2.1.0/tests/core/test_call_wait.py0000644000014400001440000000440212113343751020532 0ustar prologicusers#!/usr/bin/env python from time import sleep import pytest from circuits import Component, Event class TestWait(Event): """TestWait Event""" class TestCall(Event): """TestCall Event""" class TestLongCall(Event): """TestLongCall Event""" class TestLongWait(Event): """TestLongCall Event""" class Hello(Event): """Hello Event""" success = True class Foo(Event): """Foo Event""" class GetX(Event): """Get X Event""" class GetY(Event): """Get Y Event""" class TestEval(Event): """Test Eval Event""" class Test(Component): def test_wait(self): x = self.fire(Hello()) yield self.wait("hello") yield x def test_call(self): x = yield self.call(Hello()) yield x def hello(self): return "Hello World!" def test_long_wait(self): x = self.fire(Foo()) yield self.wait("foo") yield x def test_long_call(self): x = yield self.call(Foo()) yield x def foo(self): for i in range(1, 10): yield i def get_x(self): return 1 def get_y(self): return 2 def test_eval(self): x = yield self.call(GetX()) y = yield self.call(GetY()) yield x.value + y.value def test_wait(): test = Test() test.start() x = pytest.call_event_from_name(test, TestWait(), "hello_success") # After event is done, app needs some time to update value # (happens when tasks are called again). sleep(0.1) value = x.value assert value == "Hello World!" test.stop() def test_call(): test = Test() test.start() x = pytest.call_event(test, TestCall()) value = x.value assert value == "Hello World!" test.stop() def test_long_call(): test = Test() test.start() x = pytest.call_event(test, TestLongCall()) value = x.value assert value == list(range(1, 10)) test.stop() def test_long_wait(): test = Test() test.start() x = pytest.call_event(test, TestLongWait()) value = x.value assert value == list(range(1, 10)) test.stop() def test_eval(): test = Test() test.start() x = pytest.call_event(test, TestEval()) value = x.value assert value == 3 test.stop() circuits-2.1.0/tests/core/app.py0000644000014400001440000000015212113343751016312 0ustar prologicusersfrom circuits import Component class App(Component): def test(self): return "Hello World!" circuits-2.1.0/tests/core/test_complete.py0000644000014400001440000000436412113343751020412 0ustar prologicusers#!/usr/bin/python from circuits import Event, Component class SimpleEvent(Event): complete = True class Test(Event): """Test Event""" success = True class Nested3(Component): channel = "nested3" def test(self): """ Updating state. Must be called twice to reach final state.""" if self.root._state != "Pre final state": self.root._state = "Pre final state" else: self.root._state = "Final state" class Nested2(Component): channel = "nested2" def test(self): """ Updating state. """ self.root._state = "New state" # State change involves even more components as well. self.fire(Test(), Nested3.channel) self.fire(Test(), Nested3.channel) class Nested1(Component): channel = "nested1" def test(self): """ State change involves other components as well. """ self.fire(Test(), Nested2.channel) class App(Component): channel = "app" _simple_event_completed = False _state = "Old state" _state_when_success = None _state_when_complete = None def simple_event_complete(self, e, value): self._simple_event_completed = True def test(self): """ Fire the test event that should produce a state change. """ evt = Test() evt.complete = True evt.complete_channels = [self.channel] self.fire(evt, Nested1.channel) def test_success(self, e, value): """ Test event has been processed, save the achieved state.""" self._state_when_success = self._state def test_complete(self, e, value): """ Test event has been completely processed, save the achieved state. """ self._state_when_complete = self._state app = App() Nested1().register(app) Nested2().register(app) Nested3().register(app) while app: app.flush() def test_complete_simple(): """ Test if complete works for an event without further effects """ app.fire(SimpleEvent()) while app: app.flush() assert app._simple_event_completed def test_complete_nested(): app.fire(Test()) while app: app.flush() assert app._state_when_success == "Old state" assert app._state_when_complete == "Final state" circuits-2.1.0/tests/core/test_component_setup.py0000644000014400001440000000301012113343751022007 0ustar prologicusers# Module: test_component_setup # Date: 23rd February 2010 # Author: James Mills, prologic at shortcircuit dot net dot au from circuits.core.handlers import handler """Component Setup Tests Tests that filters and listeners of a Component are automatically registered as event handlers. """ from circuits import Component, Manager class App(Component): def test(self, event, *args, **kwargs): pass class A(Component): pass class B(Component): informed = False @handler("prepare_unregister", channel="*") def _on_prepare_unregister(self, event, c): if event.in_subtree(self): self.informed = True class Base(Component): channel = "base" class C(Base): channel = "c" def test_basic(): m = Manager() app = App() app.register(m) assert app.test in app._handlers.get("test", set()) app.unregister() while m: m.flush() assert not m._handlers def test_complex(): m = Manager() a = A() b = B() a.register(m) b.register(a) assert a in m assert a.root == m assert a.parent == m assert b in a assert b.root == m assert b.parent == a a.unregister() while m: m.flush() assert b.informed assert a not in m assert a.root == a assert a.parent == a assert b in a assert b.root == a assert b.parent == a def test_subclassing_with_custom_channel(): base = Base() assert base.channel == "base" c = C() assert c.channel == "c" circuits-2.1.0/tests/core/test_generator_value.py0000644000014400001440000000132612113343751021757 0ustar prologicusers#!/usr/bin/env python from circuits import Event, Component class Test(Event): """Test Event""" class Hello(Event): """Hello Event""" class App(Component): def test(self): def f(): while True: yield "Hello" return f() def hello(self): yield "Hello " yield "World!" def test_return_generator(): app = App() while app: app.flush() v = app.fire(Test()) app.tick() app.tick() x = v.value assert x == "Hello" def test_yield(): app = App() while app: app.flush() v = app.fire(Hello()) app.tick() app.tick() app.tick() x = v.value assert x == ["Hello ", "World!"] circuits-2.1.0/tests/core/test_event.py0000644000014400001440000000244012113343751017714 0ustar prologicusers# Module: test_event # Date: 12th April 2010 # Author: James Mills, prologic at shortcircuit dot net dot au """Event Tests""" import py from circuits import Event, Component class Test(Event): """Test Event""" class App(Component): def test(self): return "Hello World!" def test_repr(): app = App() while app: app.flush() e = Test() s = repr(e) assert s == "" app.fire(e) s = repr(e) assert s == "" def test_create(): app = App() while app: app.flush() e = Event.create("Test") s = repr(e) assert s == "" app.fire(e) s = repr(e) assert s == "" def test_getitem(): app = App() while app: app.flush() e = Test(1, 2, 3, foo="bar") assert e[0] == 1 assert e["foo"] == "bar" def f(e, k): return e[k] py.test.raises(TypeError, f, e, None) def test_setitem(): app = App() while app: app.flush() e = Test(1, 2, 3, foo="bar") assert e[0] == 1 assert e["foo"] == "bar" e[0] = 0 e["foo"] = "Hello" def f(e, k, v): e[k] = v py.test.raises(TypeError, f, e, None, None) assert e[0] == 0 assert e["foo"] == "Hello" circuits-2.1.0/tests/core/test_imports.py0000644000014400001440000000037012113343751020270 0ustar prologicusers#!/usr/bin/env python from circuits.core.components import BaseComponent def test(): try: from circuits.core.pollers import BasePoller assert issubclass(BasePoller, BaseComponent) except ImportError: assert False circuits-2.1.0/tests/core/test_component_repr.py0000644000014400001440000000216612113343751021632 0ustar prologicusers# Module: test_component_repr # Date: 23rd February 2010 # Author: James Mills, prologic at shortcircuit dot net dot au """Component Repr Tests Test Component's representation string. """ import os try: from threading import current_thread except ImportError: from threading import currentThread as current_thread # NOQA from circuits import Event, Component class App(Component): def test(self, event, *args, **kwargs): pass class Test(Event): pass def test(): id = "%s:%s" % (os.getpid(), current_thread().getName()) app = App() assert repr(app) == "" % id app.fire(Test()) assert repr(app) == "" % id app.flush() assert repr(app) == "" % id def test_non_str_channel(): id = "%s:%s" % (os.getpid(), current_thread().getName()) app = App(channel=(1, 1)) assert repr(app) == "" % id app.fire(Test()) assert repr(app) == "" % id app.flush() assert repr(app) == "" % id circuits-2.1.0/tests/core/signalapp.py0000644000014400001440000000161112113343751017511 0ustar prologicusers#!/usr/bin/env python import os import sys try: from coverage import coverage HAS_COVERAGE = True except ImportError: HAS_COVERAGE = False from circuits import Component from circuits.app import Daemon class App(Component): def __init__(self, pidfile, signalfile): super(App, self).__init__() self.pidfile = pidfile self.signalfile = signalfile Daemon(self.pidfile).register(self) def signal(self, signal, stack): f = open(self.signalfile, "w") f.write(str(signal)) f.close() def main(): if HAS_COVERAGE: _coverage = coverage(data_suffix=True) _coverage.start() pidfile = os.path.abspath(sys.argv[1]) signalfile = os.path.abspath(sys.argv[2]) App(pidfile, signalfile).run() if HAS_COVERAGE: _coverage.stop() _coverage.save() if __name__ == "__main__": main() circuits-2.1.0/tests/core/test_filters.py0000644000014400001440000000066012113343751020245 0ustar prologicusers#!/usr/bin/env python from circuits import handler, Event, BaseComponent class Test(Event): """Test Event""" class App(BaseComponent): @handler("test", filter=True) def _on_test(self): return "Hello World!" def _on_test2(self): pass # Never reached def test(): app = App() while app: app.flush() x = app.fire(Test()) app.flush() assert x.value == "Hello World!" circuits-2.1.0/tests/core/test_priority.py0000644000014400001440000000102012113343751020445 0ustar prologicusers#!/usr/bin/python -i from circuits import handler, Event, Component, Manager class Test(Event): """Test Event""" class App(Component): @handler("test") def test_0(self): return 0 @handler("test", priority=3) def test_3(self): return 3 @handler("test", priority=2) def test_2(self): return 2 m = Manager() app = App() app.register(m) while m: m.flush() def test(): v = m.fire(Test()) while m: m.flush() x = list(v) assert x == [3, 2, 0] circuits-2.1.0/tests/core/test_singleton.py0000644000014400001440000000131312072034467020600 0ustar prologicusers#!/usr/bin/env python import pytest from circuits import Component, Manager from circuits.core.components import SingletonError class App(Component): singleton = True class Base(Component): pass Base.singleton = Base class A(Base): pass class B(Base): pass def test(): m = Manager() app = App() app.register(m) while m: m.flush() def f(): App().register(m) pytest.raises(SingletonError, f) def test_child_singleton(): m = Manager() app = App() app.register(m) while m: m.flush() def f(): inter = Component() App().register(inter) inter.register(m) pytest.raises(SingletonError, f) circuits-2.1.0/tests/core/test_bridge.py0000644000014400001440000000115212113343751020026 0ustar prologicusers#!/usr/bin/python -i import pytest if pytest.PLATFORM == "win32": pytest.skip("Unsupported Platform") pytest.importorskip("multiprocessing") from os import getpid from circuits import Component, Event class Hello(Event): """Hello Event""" class App(Component): def hello(self): return "Hello from {0:d}".format(getpid()) def test(manager, watcher): app = App() app.start(process=True, link=manager) assert watcher.wait("ready") x = manager.fire(Hello()) assert pytest.wait_for(x, "result") assert x.value == "Hello from {0:d}".format(app.pid) app.stop() circuits-2.1.0/tests/core/test_manager_repr.py0000644000014400001440000000171112113343751021235 0ustar prologicusers# Module: test_manager_repr # Date: 23rd February 2010 # Author: James Mills, prologic at shortcircuit dot net dot au """Manager Repr Tests Test Manager's representation string. """ import os from time import sleep from threading import current_thread import pytest from circuits import Event, Component, Manager class App(Component): def test(self, event, *args, **kwargs): pass class Test(Event): pass def test(): id = "%s:%s" % (os.getpid(), current_thread().getName()) m = Manager() assert repr(m) == "" % id app = App() app.register(m) s = repr(m) assert s == "" % id m.start() pytest.wait_for(m, "_running", True) sleep(0.1) s = repr(m) assert s == "" % id m.stop() pytest.wait_for(m, "_Manager__thread", None) s = repr(m) assert s == "" % id circuits-2.1.0/tests/core/test_debugger.py0000644000014400001440000001237012113343751020362 0ustar prologicusers# Module: debugger # Date: 5th November 2008 # Author: James Mills, prologic at shortcircuit dot net dot au """Debugger Tests""" import sys import pytest try: from StringIO import StringIO except ImportError: from io import StringIO # NOQA from circuits import Debugger from circuits.core import Event, Component class Test(Event): """Test Event""" class App(Component): raiseException = False def test(self, raiseException=False): if raiseException: raise Exception() class Logger(object): msg = None def debug(self, msg): self.msg = msg error = debug def test(): app = App() stderr = StringIO() debugger = Debugger(file=stderr) debugger.register(app) while app: app.flush() stderr.seek(0) stderr.truncate() assert debugger.events e = Event() app.fire(e) app.flush() stderr.seek(0) s = stderr.read().strip() assert s == str(e) stderr.seek(0) stderr.truncate() debugger.events = False assert not debugger.events e = Event() app.fire(e) stderr.seek(0) s = stderr.read().strip() assert s == "" stderr.seek(0) stderr.truncate() def test_file(tmpdir): logfile = str(tmpdir.ensure("debug.log")) stderr = open(logfile, "w+") app = App() debugger = Debugger(file=stderr) debugger.register(app) while app: app.flush() stderr.seek(0) stderr.truncate() assert debugger.events e = Event() app.fire(e) app.flush() stderr.seek(0) s = stderr.read().strip() assert s == str(e) stderr.seek(0) stderr.truncate() debugger.events = False assert not debugger.events e = Event() app.fire(e) stderr.seek(0) s = stderr.read().strip() assert s == "" stderr.seek(0) stderr.truncate() def test_filename(tmpdir): if "__pypy__" in sys.modules: pytest.skip("Broken on pypy") logfile = str(tmpdir.ensure("debug.log")) stderr = open(logfile, "r+") app = App() debugger = Debugger(file=logfile) debugger.register(app) while app: app.flush() stderr.seek(0) stderr.truncate() assert debugger.events e = Event() app.fire(e) app.flush() stderr.seek(0) s = stderr.read().strip() assert s == str(e) stderr.seek(0) stderr.truncate() debugger.events = False assert not debugger.events e = Event() app.fire(e) stderr.seek(0) s = stderr.read().strip() assert s == "" stderr.seek(0) stderr.truncate() def test_exceptions(): app = App() stderr = StringIO() debugger = Debugger(file=stderr) debugger.register(app) while app: app.flush() stderr.seek(0) stderr.truncate() assert debugger.events assert debugger.errors e = Test(raiseException=True) app.fire(e) app.flush() stderr.seek(0) s = stderr.read().strip() assert s == str(e) stderr.seek(0) stderr.truncate() app.flush() stderr.seek(0) s = stderr.read().strip() assert s.startswith(" (") circuits-2.1.0/tests/core/test_globals.py0000644000014400001440000000217212072034467020225 0ustar prologicusers#!/usr/bin/env python from circuits import handler, Event, Component class Foo(Event): """Foo Event""" class Test(Event): """Test Event""" class A(Component): channel = "a" def test(self): return "Hello World!" @handler(priority=1.0) def _on_event(self, event, *args, **kwargs): return "Foo" class B(Component): @handler(priority=10.0, channel="*") def _on_channel(self, event, *args, **kwargs): return "Bar" def test(): app = A() + B() while app: app.flush() x = app.fire(Test(), "a") while app: app.flush() assert x.value[0] == "Bar" assert x.value[1] == "Foo" assert x.value[2] == "Hello World!" def test_event(): app = A() + B() while app: app.flush() e = Test() x = app.fire(e) while app: app.flush() assert x.value[0] == "Bar" assert x.value[1] == "Foo" assert x.value[2] == "Hello World!" def test_channel(): app = A() + B() while app: app.flush() e = Foo() x = app.fire(e, "b") while app: app.flush() assert x.value == "Bar" circuits-2.1.0/tests/core/test_feedback.py0000644000014400001440000000356512072034467020335 0ustar prologicusers# Module: test_feedback # Date: 11th February 2010 # Author: James Mills, prologic at shortcircuit dot net dot au """Feedback Channels Tests""" import py from circuits import handler, Event, Component class Test(Event): """Test Event""" success = True failure = True class App(Component): def __init__(self): super(App, self).__init__() self.e = None self.error = None self.value = None self.success = False self.failure = False @handler("*", filter=True) def event(self, event, *args, **kwargs): if kwargs.get("filter", False): return True def test(self, error=False): if error: raise Exception("Hello World!") return "Hello World!" def test_success(self, e, value): self.e = e self.value = value self.success = True def test_failure(self, e, error): self.e = e self.error = error self.failure = True def reraise(e): raise e def test_success(): app = App() while app: app.flush() e = Test() value = app.fire(e) while app: app.flush() # The Event s = value.value assert s == "Hello World!" while app: app.flush() assert app.e == e assert app.success assert app.e.value == value assert app.value == value.value def test_failure(): app = App() while app: app.flush() e = Test(error=True) x = app.fire(e) while app: app.flush() # The Event py.test.raises(Exception, lambda x: reraise(x[1]), x.value) while app: app.flush() assert app.e == e etype, evalue, etraceback = app.error py.test.raises(Exception, lambda x: reraise(x), evalue) assert etype == Exception assert app.failure assert not app.success assert app.e.value == x circuits-2.1.0/tests/core/test_worker_process.py0000644000014400001440000000174512113343751021651 0ustar prologicusers# Module: test_workers # Date: 7th October 2008 # Author: James Mills, prologic at shortcircuit dot net dot au """Workers Tests""" import pytest from os import getpid from circuits import Task, Worker @pytest.fixture(scope="module") def worker(request, manager): worker = Worker().register(manager) def finalizer(): worker.unregister() request.addfinalizer(finalizer) return worker def err(): return x * 2 # NOQA def foo(): x = 0 i = 0 while i < 1000000: x += 1 i += 1 return x def pid(): return "Hello from {0:d}".format(getpid()) def test_failure(manager, watcher, worker): e = Task(err) e.failure = True x = worker.fire(e) assert watcher.wait("task_failure") assert isinstance(x.value[1], Exception) def test_success(manager, watcher, worker): e = Task(foo) e.success = True x = worker.fire(e) assert watcher.wait("task_success") assert x.value == 1000000 circuits-2.1.0/tests/core/test_value.py0000644000014400001440000000426212072034467017720 0ustar prologicusers#!/usr/bin/python -i from circuits import handler, Event, Component, Manager class Hello(Event): "Hello Event" class Test(Event): "Test Event" class Foo(Event): "Foo Event" class Values(Event): "Values Event" class App(Component): def hello(self): return "Hello World!" def test(self): return self.fire(Hello()) def foo(self): raise Exception("ERROR") @handler("hello_value_changed") def _on_hello_value_changed(self, value): self.value = value @handler("test_value_changed") def _on_test_value_changed(self, value): self.value = value @handler("values", priority=2.0) def _value1(self): return "foo" @handler("values", priority=1.0) def _value2(self): return "bar" @handler("values", priority=0.0) def _value3(self): return self.fire(Hello()) m = Manager() app = App() app.register(m) while m: m.flush() def test_value(): x = m.fire(Hello()) while m: m.flush() assert "Hello World!" in x assert x.value == "Hello World!" def test_nested_value(): x = m.fire(Test()) while m: m.flush() assert x.value == "Hello World!" assert str(x) == "Hello World!" def test_value_notify(): x = m.fire(Hello()) x.notify = True while m: m.flush() assert "Hello World!" in x assert x.value == "Hello World!" assert app.value is x app.value = None def test_nested_value_notify(): x = m.fire(Test()) x.notify = True while m: m.flush() assert x.value == "Hello World!" assert str(x) == "Hello World!" assert app.value is x app.value = None def test_error_value(): x = m.fire(Foo()) while m: m.flush() etype, evalue, etraceback = x assert etype is Exception assert str(evalue) == "ERROR" assert isinstance(etraceback, list) def test_multiple_values(): v = m.fire(Values()) while m: m.flush() assert isinstance(v.value, list) x = list(v) assert "foo" in v assert x == ["foo", "bar", "Hello World!"] assert x[0] == "foo" assert x[1] == "bar" assert x[2] == "Hello World!" circuits-2.1.0/tests/core/__init__.py0000644000014400001440000000000012072034467017266 0ustar prologicuserscircuits-2.1.0/tests/core/test_errors.py0000644000014400001440000000155312113343751020113 0ustar prologicusers#!/usr/bin/env python import py from circuits import Event, Component class Test(Event): """Test Event""" class App(Component): def __init__(self): super(App, self).__init__() self.etype = None self.evalue = None self.etraceback = None self.handler = None def test(self): return x # NOQA def error(self, etype, evalue, etraceback, handler=None): self.etype = etype self.evalue = evalue self.etraceback = etraceback self.handler = handler def reraise(e): raise e def test(): app = App() while app: app.flush() app.fire(Test()) while app: app.flush() assert app.etype == NameError py.test.raises(NameError, lambda e: reraise(e), app.evalue) assert isinstance(app.etraceback, list) assert app.handler == app.test circuits-2.1.0/tests/core/test_core.py0000644000014400001440000000064112113343751017524 0ustar prologicusers#!/usr/bin/python -i from circuits import Event, Component, Manager class Test(Event): """Test Event""" class App(Component): def test(self): return "Hello World!" m = Manager() app = App() app.register(m) while app: app.flush() def test_fire(): x = m.fire(Test()) m.flush() assert x.value == "Hello World!" def test_contains(): assert App in m assert not m in app circuits-2.1.0/tests/core/test_utils.py0000644000014400001440000000331612113343751017736 0ustar prologicusers#!/usr/bin/env python import sys from types import ModuleType from circuits import Component from circuits.core.utils import findchannel, findroot, findtype FOO = """\ def foo(): return "Hello World!" """ FOOBAR = """\ def foo(); return "Hello World!' """ class Base(Component): """Base""" class App(Base): def hello(self): return "Hello World!" class A(Component): channel = "a" class B(Component): channel = "b" def test_safeimport(tmpdir): from circuits.core.utils import safeimport sys.path.insert(0, str(tmpdir)) foo_path = tmpdir.ensure("foo.py") foo_path.write(FOO) foo = safeimport("foo") assert foo is not None assert type(foo) is ModuleType s = foo.foo() assert s == "Hello World!" pyc = foo_path.new(ext="pyc") if pyc.check(file=1): pyc.remove(ignore_errors=True) pyd = foo_path.dirpath('__pycache__') if pyd.check(dir=1): pyd.remove(ignore_errors=True) foo_path.write(FOOBAR) foo = safeimport("foo") assert foo is None assert foo not in sys.modules def test_uncamel(): from circuits.core.utils import uncamel s = "FooBar" x = uncamel(s) assert x == "foo_bar" def test_findroot(): app = App() a = A() b = B() b.register(a) a.register(app) while app: app.flush() root = findroot(b) assert root == app def test_findchannel(): app = App() (A() + B()).register(app) while app: app.flush() a = findchannel(app, "a") assert a.channel == "a" def test_findtype(): app = App() (A() + B()).register(app) while app: app.flush() a = findtype(app, A) assert isinstance(a, A) circuits-2.1.0/tests/node/0000755000014400001440000000000012113366740015162 5ustar prologicuserscircuits-2.1.0/tests/node/test_node.py0000644000014400001440000000252212113343751017516 0ustar prologicusers#!/usr/bin/env python import pytest if pytest.PLATFORM == "win32": pytest.skip("Broken on Windows") from circuits import Component, Event from circuits.net.sockets import Close from circuits.node import Node, Remote from circuits.net.sockets import UDPServer class Foo(Event): """Foo Event""" class App(Component): disconnected = False ready = False value = False def foo(self): return "Hello World!" def ready(self, *args): self.ready = True def disconnect(self, component): self.disconnected = True def remote_value_changed(self, value): self.value = True @pytest.fixture() def bind(manager, watcher): server = UDPServer(0).register(manager) assert watcher.wait("ready") host, port = server.host, server.port server.fire(Close()) assert watcher.wait("closed") server.unregister() return host, port def test_return_value(manager, watcher, bind): a1 = App().register(manager) n1 = Node().register(a1) a2 = (App() + Node(bind)) a2.start(process=True) n1.add("a2", *bind) e = Event.create("foo") e.notify = True r = Remote(e, "a2") r.notify = True value = a1.fire(r) watcher.wait("remote_value_changed") assert value.value == "Hello World!" a2.stop() a1.unregister() n1.unregister() circuits-2.1.0/tests/node/test_utils.py0000644000014400001440000000157112113343751017734 0ustar prologicusers# Module: test_utils # Date: ... # Author: ... """test_utils ... """ from circuits import Event class Test(Event): """Test Event""" def test_events(): from circuits.node.utils import dump_event, load_event e = Test(1, 2, 3, foo="bar") e.success = True e.failure = False id = 1 s = dump_event(e, id) x, id = load_event(s) assert hasattr(x, "args") assert hasattr(x, "kwargs") assert hasattr(x, "success") assert hasattr(x, "failure") assert hasattr(x, "channels") assert hasattr(x, "notify") def test_values(): from circuits.node.utils import dump_value, load_value from circuits.core.values import Value v = Value() v.value = 'foo' v.errors = False v.node_trn = 1 s = dump_value(v) x, id, errors = load_value(s) assert v.value == x assert id == 1 assert not errors circuits-2.1.0/tests/tools/0000755000014400001440000000000012113366740015375 5ustar prologicuserscircuits-2.1.0/tests/tools/test_tools.py0000644000014400001440000000545412113343751020153 0ustar prologicusers# Module: test_tools # Date: 13th March 2009 # Author: James Mills, prologic at shortcircuit dot net dot au """Tools Test Suite Test all functionality of the tools package. """ import pytest try: from threading import current_thread except ImportError: from threading import currentThread as current_thread # NOQA from circuits import Component, reprhandler from circuits.tools import kill, inspect, findroot, tryimport class A(Component): def foo(self): print("A!") class B(Component): def foo(self): print("B!") class C(Component): def foo(self): print("C!") class D(Component): def foo(self): print("D!") class E(Component): def foo(self): print("E!") class F(Component): def foo(self): print("F!") INSPECT = """\ Components: 0 Event Handlers: 3 unregister; 1 foo; 1 prepare_unregister_complete; 1 .prepare_unregister_complete] (A._on_prepare_unregister_complete)> """ def test_kill(): a = A() b = B() c = C() d = D() e = E() f = F() a += b b += c e += f d += e a += d assert a.parent == a assert b.parent == a assert c.parent == b assert not c.components assert b in a.components assert d in a.components assert d.parent == a assert e.parent == d assert f.parent == e assert f in e.components assert e in d.components assert not f.components assert kill(d) is None while a: a.flush() assert a.parent == a assert b.parent == a assert c.parent == b assert not c.components assert b in a.components assert not d in a.components assert not e in d.components assert not f in e.components assert d.parent == d assert e.parent == e assert f.parent == f assert not d.components assert not e.components assert not f.components def test_inspect(): if pytest.PYVER[:2] == (3, 3): pytest.skip("Broken on Python 3.3") a = A() s = inspect(a) assert s == INSPECT def test_findroot(): a = A() b = B() c = C() a += b b += c root = findroot(a) assert root == a root = findroot(b) assert root == a root = findroot(c) assert root == a def test_reprhandler(): a = A() s = reprhandler(a.foo) assert s == "" f = lambda: None pytest.raises(AttributeError, reprhandler, f) def test_tryimport(): import os m = tryimport("os") assert m is os def test_tryimport_obj(): from os import path m = tryimport("os", "path") assert m is path def test_tryimport_fail(): m = tryimport("asdf") assert m is None # flake8: noqa circuits-2.1.0/tests/tools/__init__.py0000644000014400001440000000000012072034467017476 0ustar prologicuserscircuits-2.1.0/tests/conftest.py0000644000014400001440000000662712113343751016444 0ustar prologicusers# Module: conftest # Date: 6th December 2010 # Author: James Mills, prologic at shortcircuit dot net dot au """py.test config""" import pytest import sys import threading import collections from time import sleep from collections import deque from circuits.core.manager import TIMEOUT from circuits import handler, BaseComponent, Debugger, Manager class Watcher(BaseComponent): def init(self): self._lock = threading.Lock() self.events = deque() @handler(channel="*", priority=999.9) def _on_event(self, event, *args, **kwargs): with self._lock: self.events.append(event) def wait(self, name, channel=None, timeout=3.0): for i in range(int(timeout / TIMEOUT)): if channel is None: with self._lock: for event in self.events: if event.name == name: return True else: with self._lock: for event in self.events: if event.name == name and channel in event.channels: return True sleep(TIMEOUT) class Flag(object): status = False def call_event_from_name(manager, event, event_name, *channels): fired = False value = None for r in manager.waitEvent(event_name): if not fired: fired = True value = manager.fire(event, *channels) sleep(0.1) return value def call_event(manager, event, *channels): return call_event_from_name(manager, event, event.name, *channels) class WaitEvent(object): def __init__(self, manager, name, channel=None, timeout=3.0): if channel is None: channel = getattr(manager, "channel", None) self.timeout = timeout self.manager = manager flag = Flag() @handler(name, channel=channel) def on_event(self, *args, **kwargs): flag.status = True self.handler = self.manager.addHandler(on_event) self.flag = flag def wait(self): try: for i in range(int(self.timeout / TIMEOUT)): if self.flag.status: return True sleep(TIMEOUT) finally: self.manager.removeHandler(self.handler) def wait_for(obj, attr, value=True, timeout=3.0): from circuits.core.manager import TIMEOUT for i in range(int(timeout / TIMEOUT)): if isinstance(value, collections.Callable): if value(obj, attr): return True elif getattr(obj, attr) == value: return True sleep(TIMEOUT) @pytest.fixture(scope="session") def manager(request): manager = Manager() def finalizer(): manager.stop() request.addfinalizer(finalizer) waiter = WaitEvent(manager, "started") manager.start() assert waiter.wait() if request.config.option.verbose: Debugger().register(manager) return manager @pytest.fixture def watcher(request, manager): watcher = Watcher().register(manager) def finalizer(): watcher.unregister() return watcher def pytest_namespace(): return dict(( ("WaitEvent", WaitEvent), ("wait_for", wait_for), ("call_event", call_event), ("PLATFORM", sys.platform), ("PYVER", sys.version_info[:3]), ("call_event_from_name", call_event_from_name), )) circuits-2.1.0/tests/main.py0000755000014400001440000000121112113343751015526 0ustar prologicusers#!/usr/bin/env python import sys from types import ModuleType from os.path import abspath, dirname from subprocess import Popen, STDOUT def importable(module): try: m = __import__(module, globals(), locals()) return type(m) is ModuleType except ImportError: return False def runtests(): cmd = ["py.test", "-r", "fsxX", "--ignore=tmp"] if importable("pytest_cov"): cmd.append("--cov=circuits") cmd.append("--cov-report=html") cmd.append(dirname(abspath(__file__))) raise SystemExit(Popen(cmd, stdout=sys.stdout, stderr=STDOUT).wait()) if __name__ == "__main__": runtests() circuits-2.1.0/tests/__init__.py0000644000014400001440000000020612072034467016346 0ustar prologicusers# Package: tests # Date: 10 February 2010 # Author: James Mills, prologic at shortcircuit dot net dot au """circuits tests""" circuits-2.1.0/tools/0000755000014400001440000000000012113366740014233 5ustar prologicuserscircuits-2.1.0/tools/mkpkgs0000755000014400001440000000433012072034467015457 0ustar prologicusers#!/bin/bash # # mkpkgs # # Copyright (C) 2010-2012 James Mills # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, # USA. # VERSION="0.1" test_application () { application=${1} $application --version &> /dev/null if [[ $? != 0 ]]; then echo "Cannot find or execute ${application}!" exit 1 fi } get_latest_tag() { echo "$(hg tags | awk '{if (NR == 2) print $1}')" } make_packages() { cwd=$(pwd) hg=$(which hg) python=$(which ${1}) test_application "$hg" test_application "$python" status=$(hg status -0 -m) if [[ $status ]]; then echo "Working directory not in a clean state! Aborting..." exit 2 fi echo "Building packages for $python ..." tag=$(get_latest_tag) $hg update -C ${tag} &> /dev/null $python setup.py clean &> /dev/null $python setup.py build &> /dev/null $python setup.py bdist_egg &> /dev/null $python setup.py sdist --formats=bztar,gztar,zip &> /dev/null $hg update -C &> /dev/null } print_help() { echo "usage: $COMMAND [options] machines" echo "options:" echo " -p=PYTHON specify python binary to use" echo " -v print version and exit" echo " -h print help and exit" } parse_options() { PYTHON="python2.6" while getopts "p:vh-" OPT ; do case $OPT in p) PYTHON="$OPTARG" ;; v) echo "$COMMAND $VERSION" exit 0 ;; h) print_help exit 0 ;; esac done shift $(($OPTIND - 1)) } main() { parse_options "$@" make_packages "$PYTHON" } ### Main COMMAND=$(basename $0) main "$@" #n End of File circuits-2.1.0/PKG-INFO0000644000014400001440000001674712113366740014207 0ustar prologicusersMetadata-Version: 1.0 Name: circuits Version: 2.1.0 Summary: Asynchronous Component based Event Application Framework Home-page: http://bitbucket.org/prologic/circuits/ Author: James Mills Author-email: James Mills, prologic at shortcircuit dot net dot au License: MIT Download-URL: http://bitbucket.org/prologic/circuits/downloads/ Description: .. _Python Programming Language: http://www.python.org/ .. _#circuits IRC Channel: http://webchat.freenode.net/?randomnick=1&channels=circuits&uio=d4 .. _FreeNode IRC Network: http://freenode.net .. _Python Standard Library: http://docs.python.org/library/ .. _Website: https://bitbucket.org/prologic/circuits/ .. _PyPi Page: http://pypi.python.org/pypi/circuits .. _Read the Docs: http://circuits.readthedocs.org/ .. _MIT License: http://www.opensource.org/licenses/mit-license.php .. _Create an Issue: https://bitbucket.org/prologic/circuits/issue/new .. _Mailing List: http://groups.google.com/group/circuits-users .. _Downloads page: https://bitbucket.org/prologic/circuits/downloads Overview -------- 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. To take full advantage of circuits and its architecture, circuits encourages you to design your application in terms of loosely coupled components. Circuits has a very powerful message passing system that enables components to interact with each other via events. Applications written this way tend to be more maintainable, easier to develop and scale to complex systems. circuits' **Loosely Coupled** **Component Architecture** allows for a high level of **Reuse** and **Scalability**. Simpler components can be combined together to form Complex Components and provide higher level functionality and abstraction. Much of the circuits component library is designed and built this way. - **Documentation**: http://packages.python.org/circuits or `Read the Docs`_. - **Project website**: https://bitbucket.org/prologic/circuits/ - **PyPI page**: http://pypi.python.org/pypi/circuits 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 - Python 2.6, 2.7, 3.2, 3.3 - pypy 2.0 **Windows**: We acknowledge that Windows exists and make reasonable efforts to maintain compatibility. Unfortunately we cannot guarantee support at this time. **NB**: We are working toward getting Windows supported. 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 Page`_ or the `Downloads page`_ on the `Website`_; extract it and install using:: > python setup.py install 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 is also a small community of circuits enthusiasts that you may find on the `#circuits IRC Channel`_ on the `FreeNode IRC Network`_ and the `Mailing List`_. .. raw:: html Release Notes - circuits-2.1.0 () ------------------------------------------ This release adds the following new features to circuits: - Python 3 support. - Windows support. - PyPy support. - IPv6 support. - Better WSGI support. - Fully documented examples. - Component Interface querying. And many bug fixes! Keywords: event framework distributed concurrent component asynchronous Platform: POSIX Classifier: Development Status :: 5 - Production/Stable Classifier: Environment :: Console Classifier: Environment :: No Input/Output (Daemon) Classifier: Environment :: Other Environment Classifier: Environment :: Plugins Classifier: Environment :: Web Environment Classifier: Intended Audience :: Developers Classifier: Intended Audience :: Information Technology Classifier: Intended Audience :: Science/Research Classifier: Intended Audience :: System Administrators Classifier: Intended Audience :: Telecommunications Industry Classifier: License :: OSI Approved :: MIT License Classifier: Natural Language :: English Classifier: Operating System :: POSIX :: BSD Classifier: Operating System :: POSIX :: Linux Classifier: Operating System :: MacOS :: MacOS X Classifier: Operating System :: Microsoft :: Windows Classifier: Programming Language :: Python :: 2.6 Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3.1 Classifier: Programming Language :: Python :: 3.2 Classifier: Programming Language :: Python :: 3.3 Classifier: Programming Language :: Python :: Implementation :: CPython Classifier: Programming Language :: Python :: Implementation :: PyPy Classifier: Topic :: Adaptive Technologies Classifier: Topic :: Communications :: Chat :: Internet Relay Chat Classifier: Topic :: Communications :: Email :: Mail Transport Agents Classifier: Topic :: Database Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Server Classifier: Topic :: Software Development :: Libraries :: Application Frameworks Classifier: Topic :: Software Development :: Libraries :: Python Modules Classifier: Topic :: System :: Clustering Classifier: Topic :: System :: Distributed Computing circuits-2.1.0/.hgtags0000644000014400001440000000235112113366552014353 0ustar prologicusers1deeba0cfda91463941c95dc7f727dcebf6b73fa 1.0a1 90a35fab524b1297aa15bbf17a65cc402a5eb474 1.0a2 eabf5dd3bdf891b62279745c87d5752cfc736dff 1.0b1 b587c1f604006744c5ab9237aa20e685c2cc5bc8 1.1 9c1e26e6b85065b3bf8f7f3a8c5584ded7c3bc3c 1.1.1 5347a60398b575a1c46d6da8969ded92063de068 1.2 c2311528f42f15002b82ffe783e91eede50d1cba 1.2.1 e00c8f8ed520212403fbdbff8c6ac8623dba3f4f 1.3 fc02432d239b0e2a98ad5f813965f636191f7d98 1.3.1 5df2b438a545652400cf0a861aa67a4d60d9dd79 1.3.2 8744bb46e94d5afd6800b97e42f1d2a40c8a7fee 1.3.3 8eeffa2149922cdd606856262169cbd3c7af61e3 1.4 2c8f6603dccf38e3e052db4675056d17089f37df 1.5 18f0db0026e726e55af8fc62752569a5d9e6bde3 1.6 95761a3ac93db9d1fefe2ba677a96053c1b4ce21 2.0.0 f4e00d39f3babb37998f59d5a3c948a6522dd7d9 2.0.1 b63857aa7ad3e868572875cf60f93c0854362732 2.1.0 b63857aa7ad3e868572875cf60f93c0854362732 2.1.0 4d82e4d5f9998010ed6784707a3659f2c024d424 2.1.0 4d82e4d5f9998010ed6784707a3659f2c024d424 2.1.0 b9494b0633e57f1f078ca6a7835e7a148d46916c 2.1.0 b9494b0633e57f1f078ca6a7835e7a148d46916c 2.1.0 a195aa8c6288ca4a2b663ae71319a0c6add02a0f 2.1.0 a195aa8c6288ca4a2b663ae71319a0c6add02a0f 2.1.0 7c54cc99cf9d7272654a1186c8ab8e4eb6af3845 2.1.0 7c54cc99cf9d7272654a1186c8ab8e4eb6af3845 2.1.0 20349b88830ad2fbd17dd6658bacd76ae78dafae 2.1.0 circuits-2.1.0/scripts/0000755000014400001440000000000012113366740014562 5ustar prologicuserscircuits-2.1.0/scripts/circuits.bench0000755000014400001440000001234512113343751017415 0ustar prologicusers#!/usr/bin/env python # -*- coding: utf-8 -*- """(Tool) Bench Marking Tool THis tool does some simple benchmaking of the circuits library. """ import sys import math import optparse from time import sleep if sys.platform == "win32": from time import clock as time else: from time import time # NOQA try: import hotshot import hotshot.stats except ImportError: hotshot = None # NOQA try: import psyco except ImportError: psyco = None # NOQA from circuits import __version__ as systemVersion from circuits import handler, Event, Component, Manager, Debugger USAGE = "%prog [options]" VERSION = "%prog v" + systemVersion def duration(seconds): days = int(seconds / 60 / 60 / 24) seconds = (seconds) % (60 * 60 * 24) hours = int((seconds / 60 / 60)) seconds = (seconds) % (60 * 60) mins = int((seconds / 60)) seconds = int((seconds) % (60)) return (days, hours, mins, seconds) def parse_options(): """parse_options() -> opts, args Parse the command-line options given returning both the parsed options and arguments. """ parser = optparse.OptionParser(usage=USAGE, version=VERSION) parser.add_option( "-t", "--time", action="store", type="int", default=0, dest="time", help="Stop after specified elapsed seconds" ) parser.add_option( "-e", "--events", action="store", type="int", default=0, dest="events", help="Stop after specified number of events" ) parser.add_option( "-p", "--profile", action="store_true", default=False, dest="profile", help="Enable execution profiling support" ) parser.add_option( "-d", "--debug", action="store_true", default=False, dest="debug", help="Enable debug mode" ) parser.add_option( "-m", "--mode", action="store", type="choice", default="speed", dest="mode", choices=["sync", "speed", "latency"], help="Operation mode" ) parser.add_option( "-s", "--speed", action="store_true", default=False, dest="speed", help="Enable psyco (circuits on speed!)" ) parser.add_option( "-q", "--quiet", action="store_false", default=True, dest="verbose", help="Suppress output" ) opts, args = parser.parse_args() return opts, args class Stop(Event): """Stop Event""" class Term(Event): """Term Event""" class Hello(Event): """Hello Event""" class Received(Event): """Received Event""" class Base(Component): def __init__(self, opts, *args, **kwargs): super(Base, self).__init__(*args, **kwargs) self.opts = opts class SpeedTest(Base): def received(self, message=""): self.fire(Hello("hello")) def hello(self, message): self.fire(Received(message)) class LatencyTest(Base): t = None def received(self, message=""): print("Latency: %0.9f us" % ((time() - self.t) * 1e6)) sleep(1) self.fire(Hello("hello")) def hello(self, message=""): self.t = time() self.fire(Received(message)) class State(Base): done = False def stop(self): self.fire(Term()) def term(self): self.done = True class Monitor(Base): sTime = sys.maxsize events = 0 state = 0 @handler(filter=True) def event(self, *args, **kwargs): self.events += 1 if self.events > self.opts.events: self.stop() def main(): opts, args = parse_options() if opts.speed and psyco: psyco.full() manager = Manager() monitor = Monitor(opts) manager += monitor state = State(opts) manager += state if opts.debug: manager += Debugger() if opts.mode.lower() == "speed": if opts.verbose: print("Setting up Speed Test...") manager += SpeedTest(opts) monitor.sTime = time() elif opts.mode.lower() == "latency": if opts.verbose: print("Setting up Latency Test...") manager += LatencyTest(opts) monitor.sTime = time() if opts.verbose: print("Setting up Sender...") print("Setting up Receiver...") monitor.sTime = time() if opts.profile: if hotshot: profiler = hotshot.Profile("bench.prof") profiler.start() manager.fire(Hello("hello")) while not state.done: try: manager.tick() if opts.events > 0 and monitor.events > opts.events: manager.fire(Stop()) if opts.time > 0 and (time() - monitor.sTime) > opts.time: manager.fire(Stop()) except KeyboardInterrupt: manager.fire(Stop()) if opts.verbose: print() eTime = time() tTime = eTime - monitor.sTime events = monitor.events speed = int(math.ceil(float(monitor.events) / tTime)) print("Total Events: %d (%d/s after %0.2fs)" % (events, speed, tTime)) if opts.profile and hotshot: profiler.stop() profiler.close() stats = hotshot.stats.load("bench.prof") stats.strip_dirs() stats.sort_stats("time", "calls") stats.print_stats(20) ### ### Entry Point ### if __name__ == "__main__": main() circuits-2.1.0/scripts/circuits.web0000755000014400001440000000014112072034467017107 0ustar prologicusers#!/usr/bin/env python from circuits.web.main import main if __name__ == "__main__": main() circuits-2.1.0/.hgchurn0000644000014400001440000000120512107477410014530 0ustar prologicusersantont@ubuntu.ubuntu-domain = Toni Alatalo prologic@shortcircuit.net.au = James Mills alessio.deiana@cern.ch = Alessio Deiana emarshall85@gmail.com = Edwin Marshall alexmax2742@gmail.com = Alex Mayfield dsuch@gefira.pl = Dariusz Suchojad adeiana@gmail.com = Alessio Deiana holger@merlinux.eu = Holger Krekel toni@playsign.net = Toni Alatalo root@localhost = James Mills aspidites = Edwin Marshall eriol@mornie.org = Eriol dsuch = Dariusz Suchojad jamesmills = James Mills jaemsmills = James Mills awendela = Justin Giorgi millsjam = James Mills prologic = James Mills mnlipp = Michael Lipp jmills = James Mills lashni = Tim Miller eriol = Eriol circuits-2.1.0/setup.cfg0000644000014400001440000000026712113366740014721 0ustar prologicusers[build_sphinx] all_files = 1 build-dir = docs/build source-dir = docs/source [egg_info] tag_build = tag_date = 0 tag_svn_revision = 0 [upload_sphinx] upload-dir = docs/build/html circuits-2.1.0/tox.ini0000644000014400001440000000104212113343751014400 0ustar prologicusers# Tox (http://tox.testrun.org/) is a tool for running tests # in multiple virtualenvs. This configuration file will run the # test suite on all supported python versions. To use it, "pip install tox" # and then run "tox" from this directory. [tox] envlist = py26,py27,py32,py33,pypy [testenv] commands=py.test --junitxml=circuits-{envname}.xml tests deps = pytest-cov pytest [testenv:docs] basepython=python changedir=docs deps= sphinx pytest commands=py.test --tb=line -v --junitxml=circuits-docs-{envname}.xml check_docs.py circuits-2.1.0/.hgignore0000644000014400001440000000024112113343751014670 0ustar prologicuserssyntax: glob *.pyc *.pyo *.xml tmp .tox dist build hgtools* .coverage* coverage docs/build circuits.egg-info __version__.py syntax: regexp ^tests/trace\.html$ circuits-2.1.0/README.rst0000644000014400001440000000743512113343751014570 0ustar prologicusers.. _Python Programming Language: http://www.python.org/ .. _#circuits IRC Channel: http://webchat.freenode.net/?randomnick=1&channels=circuits&uio=d4 .. _FreeNode IRC Network: http://freenode.net .. _Python Standard Library: http://docs.python.org/library/ .. _Website: https://bitbucket.org/prologic/circuits/ .. _PyPi Page: http://pypi.python.org/pypi/circuits .. _Read the Docs: http://circuits.readthedocs.org/ .. _MIT License: http://www.opensource.org/licenses/mit-license.php .. _Create an Issue: https://bitbucket.org/prologic/circuits/issue/new .. _Mailing List: http://groups.google.com/group/circuits-users .. _Downloads page: https://bitbucket.org/prologic/circuits/downloads Overview -------- 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. To take full advantage of circuits and its architecture, circuits encourages you to design your application in terms of loosely coupled components. Circuits has a very powerful message passing system that enables components to interact with each other via events. Applications written this way tend to be more maintainable, easier to develop and scale to complex systems. circuits' **Loosely Coupled** **Component Architecture** allows for a high level of **Reuse** and **Scalability**. Simpler components can be combined together to form Complex Components and provide higher level functionality and abstraction. Much of the circuits component library is designed and built this way. - **Documentation**: http://packages.python.org/circuits or `Read the Docs`_. - **Project website**: https://bitbucket.org/prologic/circuits/ - **PyPI page**: http://pypi.python.org/pypi/circuits 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 - Python 2.6, 2.7, 3.2, 3.3 - pypy 2.0 **Windows**: We acknowledge that Windows exists and make reasonable efforts to maintain compatibility. Unfortunately we cannot guarantee support at this time. **NB**: We are working toward getting Windows supported. 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 Page`_ or the `Downloads page`_ on the `Website`_; extract it and install using:: > python setup.py install 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 is also a small community of circuits enthusiasts that you may find on the `#circuits IRC Channel`_ on the `FreeNode IRC Network`_ and the `Mailing List`_. .. raw:: html circuits-2.1.0/MANIFEST.in0000644000014400001440000000017012113343751014624 0ustar prologicusersrecursive-include examples *.py recursive-include docs * recursive-include tests * include LICENSE Makefile *.rst *.ini circuits-2.1.0/circuits/0000755000014400001440000000000012113366740014720 5ustar prologicuserscircuits-2.1.0/circuits/io/0000755000014400001440000000000012113366740015327 5ustar prologicuserscircuits-2.1.0/circuits/io/serial.py0000644000014400001440000000441612113343751017162 0ustar prologicusers# Module: serial # Date: 4th August 2004 # Author: James Mills """Serial I/O This module implements basic Serial (RS232) I/O. """ import os import select from collections import deque from circuits.core import Component from circuits.tools import tryimport from .events import Closed, Error, Opened, Read serial = tryimport("serial") TIMEOUT = 0.2 BUFSIZE = 4096 class Serial(Component): channel = "serial" def __init__(self, port, baudrate=115200, bufsize=BUFSIZE, timeout=TIMEOUT, channel=channel): super(Serial, self).__init__(channel=channel) if serial is None: raise RuntimeError("No serial support available") self.port = port self.baudrate = baudrate self._serial = serial.Serial() self._serial.port = port self._serial.baudrate = baudrate if os.name == "posix": self._serial.timeout = 0 # non-blocking (POSIX) else: self._serial.timeout = timeout self._buffer = deque() self._bufsize = bufsize self._timeout = timeout self._read = [] self._write = [] self._serial.open() self._fd = self._serial.fileno() self._read.append(self._fd) self.fire(Opened(self.port)) def __tick__(self): r, w, e = select.select(self._read, self._write, [], self._timeout) if w and self._buffer: data = self._buffer.popleft() try: bytes = os.write(self._fd, data) if bytes < len(data): self._buffer.append(data[bytes:]) else: if not self._buffer and self._fd in self._write: self._write.remove(self._fd) except OSError as error: self.fire(Error(error)) if r: data = os.read(self._fd, self._bufsize) if data: self.fire(Read(data)) def write(self, data): if self._fd not in self._write: self._write.append(self._fd) self._buffer.append(data) def close(self): self._fd = None self._read = [] self._write = [] self._serial.close() self.fire(Closed(self.port)) circuits-2.1.0/circuits/io/notify.py0000644000014400001440000000734012113343751017212 0ustar prologicusers# Module: notify # Date: 2nd March 2009 # Author: James Mills, prologic at shortcircuit dot net dot au """File Notification Support A Component wrapping the inotify API using the pyinotify library. """ try: from pyinotify import IN_UNMOUNT from pyinotify import WatchManager, Notifier, ALL_EVENTS from pyinotify import IN_ACCESS, IN_MODIFY, IN_ATTRIB, IN_CLOSE_WRITE from pyinotify import IN_CREATE, IN_DELETE, IN_DELETE_SELF, IN_MOVE_SELF from pyinotify import IN_CLOSE_NOWRITE, IN_OPEN, IN_MOVED_FROM, IN_MOVED_TO except ImportError: raise Exception("No pyinotify support available. Is pyinotify installed?") from circuits.core.utils import findcmp from circuits.core import handler, Component, Event from circuits.core.pollers import BasePoller, Poller MASK = ALL_EVENTS class Ready(Event): """Ready Event""" class AddPath(Event): """Add path to watch""" class RemovePath(Event): """Remove path from watch""" class Moved(Event): """Moved Event""" class Opened(Event): """Opened Event""" class Closed(Event): """Closed Event""" class Created(Event): """Created Event""" class Deleted(Event): """Deleted Event""" class Accessed(Event): """Accessed Event""" class Modified(Event): """Modified Event""" class Unmounted(Event): """Unmounted Event""" EVENT_MAP = { IN_MOVED_TO: Moved, IN_MOVE_SELF: Moved, IN_MOVED_FROM: Moved, IN_CLOSE_WRITE: Closed, IN_CLOSE_NOWRITE: Closed, IN_OPEN: Opened, IN_DELETE_SELF: Deleted, IN_DELETE: Deleted, IN_CREATE: Created, IN_ACCESS: Accessed, IN_MODIFY: Modified, IN_ATTRIB: Modified, IN_UNMOUNT: Unmounted, } class Notify(Component): channel = "notify" def __init__(self, channel=channel): super(Notify, self).__init__(channel=channel) self._poller = None self._wm = WatchManager() self._notifier = Notifier(self._wm, self._on_process_events) def _on_process_events(self, event): dir = event.dir mask = event.mask path = event.path name = event.name pathname = event.pathname for k, v in EVENT_MAP.items(): if mask & k: self.fire(v(name, path, pathname, dir)) def add_path(self, path, mask=None, recursive=False): mask = mask or MASK self._wm.add_watch(path, mask, rec=recursive) def remove_path(self, path, recursive=False): wd = self._wm.get_wd(path) if wd: self._wm.rm_watch(wd, rec=recursive) @handler("ready") def _on_ready(self, component): self._poller.addReader(self, self._notifier._fd) @handler("registered", channel="*") def _on_registered(self, component, manager): if self._poller is None: if isinstance(component, BasePoller): self._poller = component self.fire(Ready(self)) else: if component is not self: return component = findcmp(self.root, BasePoller) if component is not None: self._poller = component self.fire(Ready(self)) else: self._poller = Poller().register(self) self.fire(Ready(self)) @handler("started", filter=True, channel="*") def _on_started(self, component): if self._poller is None: self._poller = Poller().register(self) self.fire(Ready(self)) return True @handler("_read", filter=True) def __on_read(self, fd): self._notifier.read_events() self._notifier.process_events() circuits-2.1.0/circuits/io/file.py0000644000014400001440000001440112113343751016615 0ustar prologicusers# Module: file # Date: 4th August 2004 # Author: James Mills """File I/O This module implements a wrapper for basic File I/O. """ try: from os import O_NONBLOCK except ImportError: #If it fails, that's fine. the fcntl import #will fail anyway. pass from os import write from collections import deque from sys import getdefaultencoding from socket import error as SocketError from errno import ENOTCONN, EPIPE, EWOULDBLOCK from circuits.tools import tryimport from circuits.core.utils import findcmp from circuits.six import binary_type, PY3 from circuits.core import handler, Component, Event from circuits.core.pollers import BasePoller, Poller if PY3: from io import FileIO FileType = FileIO else: FileType = file fcntl = tryimport("fcntl") TIMEOUT = 0.2 BUFSIZE = 4096 class EOF(Event): """EOF Event""" class Seek(Event): """Seek Event""" class Read(Event): """Read Event""" class Close(Event): """Close Event""" class Write(Event): """Write Event""" class Error(Event): """Error Event""" class Open(Event): """Open Event""" class Opened(Event): """Opened Event""" class Closed(Event): """Closed Event""" class Ready(Event): """Ready Event""" class File(Component): channel = "file" def init(self, filename, mode="r", bufsize=BUFSIZE, encoding=None, channel=channel): self._mode = mode self._bufsize = bufsize self._filename = filename self._encoding = encoding or getdefaultencoding() self._fd = None self._poller = None self._buffer = deque() self._closeflag = False @property def closed(self): return getattr(self._fd, "closed", True) \ if hasattr(self, "_fd") else True @property def filename(self): return getattr(self, "_filename", None) @property def mode(self): return getattr(self, "_mode", None) @handler("ready") def _on_ready(self, component): self.fire(Open(), self.channel) @handler("open") def _on_open(self, filename=None, mode=None, bufsize=None): self._filename = filename or self._filename self._bufsize = bufsize or self._bufsize self._mode = mode or self._mode if isinstance(self._filename, FileType): self._fd = self._filename self._mode = self._fd.mode self._filename = self._fd.name self._encoding = getattr(self._fd, "encoding", self._encoding) else: kwargs = {"encoding": self._encoding} if PY3 else {} self._fd = open(self.filename, self.mode, **kwargs) if fcntl is not None: # Set non-blocking file descriptor (non-portable) flag = fcntl.fcntl(self._fd, fcntl.F_GETFL) flag = flag | O_NONBLOCK fcntl.fcntl(self._fd, fcntl.F_SETFL, flag) if "r" in self.mode or "+" in self.mode: self._poller.addReader(self, self._fd) self.fire(Opened(self.filename, self.mode)) @handler("registered", channel="*") def _on_registered(self, component, manager): if self._poller is None: if isinstance(component, BasePoller): self._poller = component self.fire(Ready(self)) else: if component is not self: return component = findcmp(self.root, BasePoller) if component is not None: self._poller = component self.fire(Ready(self)) else: self._poller = Poller().register(self) self.fire(Ready(self)) @handler("stopped", channel="*") def _on_stopped(self, component): self.fire(Close()) @handler("prepare_unregister", channel="*") def _on_prepare_unregister(self, event, c): if event.in_subtree(self): self._close() def _close(self): if self.closed: return self._poller.discard(self._fd) self._buffer.clear() self._closeflag = False self._connected = False try: self._fd.cllse() except: pass self.fire(Closed()) def close(self): if not self._buffer: self._close() elif not self._closeflag: self._closeflag = True def _read(self): try: data = self._fd.read(self._bufsize) if not isinstance(data, binary_type): data = data.encode(self._encoding) if data: self.fire(Read(data)).notify = True else: self.fire(EOF()) if not any(m in self.mode for m in ("a", "+")): self.close() else: self._poller.discard(self._fd) except SocketError as e: if e.args[0] == EWOULDBLOCK: return else: self.fire(Error(e)) self._close() def seek(self, offset, whence=0): self._fd.seek(offset, whence) def _write(self, data): try: if not isinstance(data, binary_type): data = data.encode(self._encoding) nbytes = write(self._fd.fileno(), data) if nbytes < len(data): self._buffer.appendleft(data[nbytes:]) except SocketError as e: if e.args[0] in (EPIPE, ENOTCONN): self._close() else: self.fire(Error(e)) def write(self, data): if self._poller is not None and not self._poller.isWriting(self._fd): self._poller.addWriter(self, self._fd) self._buffer.append(data) @handler("_disconnect", filter=True) def __on_disconnect(self, sock): self._close() @handler("_read", filter=True) def __on_read(self, sock): self._read() @handler("_write", filter=True) def __on_write(self, sock): if self._buffer: data = self._buffer.popleft() self._write(data) if not self._buffer: if self._closeflag: self._close() elif self._poller.isWriting(self._fd): self._poller.removeWriter(self._fd) circuits-2.1.0/circuits/io/events.py0000644000014400001440000000122712113343751017204 0ustar prologicusers# Module: events # Date: 10th June 2011 # Author: James Mills """I/O Events This module implements commonly used I/O events used by other I/O modules. """ from circuits.core import Event class EOF(Event): """EOF Event""" class Seek(Event): """Seek Event""" class Read(Event): """Read Event""" class Close(Event): """Close Event""" class Write(Event): """Write Event""" class Error(Event): """Error Event""" class Open(Event): """Open Event""" class Opened(Event): """Opened Event""" class Closed(Event): """Closed Event""" class Ready(Event): """Ready Event""" circuits-2.1.0/circuits/io/process.py0000755000014400001440000001030012113343751017351 0ustar prologicusers#!/usr/bin/python -i from io import BytesIO from subprocess import Popen, PIPE from circuits.core.manager import TIMEOUT from circuits.io import File, Write from circuits import handler, Component, Event class Started(Event): """Started Event""" class Stopped(Event): """Stopped Event""" class Start(Event): """Start Event""" class Stop(Event): """Stop Event""" class Signal(Event): """Signal Event""" class Kill(Event): """Kill Event""" class Wait(Event): """Wait Event""" class Process(Component): channel = "process" def init(self, args, cwd=None, shell=False): self.args = args self.cwd = cwd self.shell = shell self.p = None self.stderr = BytesIO() self.stdout = BytesIO() self._status = None self._terminated = False self._stdout_closed = False self._stderr_closed = False self._stdin = None self._stderr = None self._stdout = None self._stdin_closed_handler = None self._stderr_read_handler = None self._stdout_read_handler = None self._stderr_closed_handler = None self._stdout_closed_handler = None def start(self): self.p = Popen( self.args, cwd=self.cwd, shell=self.shell, stdin=PIPE, stderr=PIPE, stdout=PIPE ) self.stderr = BytesIO() self.stdout = BytesIO() self._status = None self._stdin = File( self.p.stdin, channel="{0:d}.stdin".format(self.p.pid) ).register(self) self._stderr = File( self.p.stderr, channel="{0:d}.stderr".format(self.p.pid) ).register(self) self._stdout = File( self.p.stdout, channel="{0:d}.stdout".format(self.p.pid) ).register(self) self._stderr_read_handler = self.addHandler( handler("read", channel="{0:d}.stderr".format(self.p.pid))( self.__class__._on_stderr_read ) ) self._stdout_read_handler = self.addHandler( handler("read", channel="{0:d}.stdout".format(self.p.pid))( self.__class__._on_stdout_read ) ) self._stderr_closed_handler = self.addHandler( handler("closed", channel="{0:d}.stderr".format(self.p.pid))( self.__class__._on_stderr_closed ) ) self._stdout_closed_handler = self.addHandler( handler("closed", channel="{0:d}.stdout".format(self.p.pid))( self.__class__._on_stdout_closed ) ) self.fire(Started(self)) @staticmethod def _on_stdout_closed(self): self._stdout_closed = True @staticmethod def _on_stderr_closed(self): self._stderr_closed = True def stop(self): if self.p is not None: self.p.terminate() def kill(self): self.p.kill() def signal(self, signal): self.p.send_signal(signal) def wait(self): return self.p.wait() def write(self, data): self.fire(Write(data), "{0:d}.stdin".format(self.p.pid)) @property def status(self): if getattr(self, "p", None) is not None: return self.p.poll() @staticmethod def _on_stderr_read(self, data): self.stderr.write(data) @staticmethod def _on_stdout_read(self, data): self.stdout.write(data) @handler("generate_events") def _on_generate_events(self, event): if self.p is not None and self._status is None: self._status = self.p.poll() if self._status is not None and self._stderr_closed \ and self._stdout_closed and not self._terminated: self._terminated = True self.removeHandler(self._stderr_read_handler) self.removeHandler(self._stdout_read_handler) self.removeHandler(self._stderr_closed_handler) self.removeHandler(self._stdout_closed_handler) self.fire(Stopped(self)) event.reduce_time_left(0) return True else: event.reduce_time_left(TIMEOUT) circuits-2.1.0/circuits/io/__init__.py0000644000014400001440000000140712113343751017437 0ustar prologicusers# Module: io # Date: 4th August 2004 # Author: James Mills """I/O Support This package contains various I/O Components. Provided are a a generic File Component, StdIn, StdOut and StdErr components. Instances of StdIn, StdOUt and StdErr are also created by importing this package. """ import sys from .file import File from .file import Close, Open, Seek, Write from .process import Process from .process import Start, Stop, Signal, Kill, Wait try: from .notify import Notify except: pass try: from .serial import Serial except: pass try: stdin = File(sys.stdin, channel="stdin") stdout = File(sys.stdout, channel="stdout") stderr = File(sys.stderr, channel="stderr") except: pass # flake8: noqa circuits-2.1.0/circuits/app/0000755000014400001440000000000012113366740015500 5ustar prologicuserscircuits-2.1.0/circuits/app/config.py0000644000014400001440000000511212113343751017313 0ustar prologicusers# Module: config # Date: 13th August 2008 # Author: James Mills, prologic at shortcircuit dot net dot au """Config Configuration Component. This component uses the standard ConfigParser.ConfigParser class and adds support for saving the configuration to a file. """ try: from configparser import ConfigParser except ImportError: from ConfigParser import ConfigParser # NOQA from circuits import handler, BaseComponent, Event class ConfigEvent(Event): """Config Event""" channels = ("config",) success = True failure = True class Load(ConfigEvent): """Load Config Event""" class Save(ConfigEvent): """Save Config Event""" class Config(BaseComponent): channel = "config" def __init__(self, filename, defaults=None, channel=channel): super(Config, self).__init__(channel=channel) self._config = ConfigParser(defaults=defaults) self._filename = filename @handler("load") def load(self, filename=None): self._filename = filename or self._filename self._config.read([self._filename]) @handler("save") def save(self, filename=None): self._filename = filename or self._filename with open(self._filename, "w") as f: self._config.write(f) def add_section(self, section): return self._config.add_section(section) def items(self, section, raw=False, vars=None): return self._config.items(section, raw=False, vars=None) def get(self, section, option, default=None, raw=False, vars=None): if self._config.has_option(section, option): return self._config.get(section, option, raw=raw, vars=vars) else: return default def getint(self, section, option, default=0): if self._config.has_option(section, option): return self._config.getint(section, option) else: return default def getfloat(self, section, option, default=0.0): if self._config.has_option(section, option): return self._config.getfloat(section, option) else: return default def getboolean(self, section, option, default=False): if self._config.has_option(section, option): return self._config.getboolean(section, option) else: return default def has_section(self, section): return self._config.has_section(section) def has_option(self, section, option): return self._config.has_option(section, option) def set(self, section, option, value): return self._config.set(section, option, value) circuits-2.1.0/circuits/app/daemon.py0000644000014400001440000000763612113343751017326 0ustar prologicusers# Module: daemon # Date: 20th June 2009 # Author: James Mills, prologic at shortcircuit dot net dot au """Daemon Component Component to daemonizae a system into the background and detach it from its controlling PTY. Supports PID file writing, logging stdin, stdout and stderr and changing the current working directory. """ import os import sys import errno from circuits.core import handler, BaseComponent, Event class Daemonize(Event): """Daemonize Event This event can be fired to notify the `Daemon` Component to begin the "daemonization" process. This event is (*by default*) used automatically by the `Daemon` Component in its "started" Event Handler (*This behavior can be overridden*). Arguments: *None* """ class WritePID(Event): """"WritePID Event This event can be fired to notify the `Daemon` Component that is should retrive the current process's id (pid) and write it out to the configured path in the `Daemon` Component. This event (*by default*) is used automatically by the `Daemon` Component after the :class:`Daemonize`. """ class Daemon(BaseComponent): """Daemon Component :param pidfile: .pid filename :type pidfile: str or unicode :param stdin: filename to log stdin :type stdin: str or unicode :param stdout: filename to log stdout :type stdout: str or unicode :param stderr: filename to log stderr :type stderr: str or unicode """ channel = "daemon" def __init__(self, pidfile, path="/", stdin=None, stdout=None, stderr=None, channel=channel): "x.__init__(...) initializes x; see x.__class__.__doc__ for signature" super(Daemon, self).__init__(channel=channel) assert os.path.isabs(path), "path must be absolute" if os.path.isabs(pidfile): self._pidfile = pidfile else: self._pidfile = os.path.join(path, pidfile) self._path = path stdio_attrs = ["_stdin", "_stdout", "_stderr"] for i, stdio in enumerate([stdin, stdout, stderr]): if stdio and os.path.isabs(stdio): setattr(self, stdio_attrs[i], stdio) elif stdio: setattr(self, stdio_attrs[i], os.path.join(path, stdio)) else: setattr(self, stdio_attrs[i], "/dev/null") @handler("write_pid") def _on_writepid(self): f = open(self._pidfile, "w") f.write(str(os.getpid())) f.close() @handler("daemonize") def _on_daemonize(self): # Do first fork. try: pid = os.fork() if pid > 0: # Exit first parent os._exit(0) except OSError as e: print >> sys.stderr, "fork #1 failed: (%d) %s\n" % (errno, str(e)) raise SystemExit(1) # Decouple from parent environment. os.chdir(self._path) os.umask(0o077) os.setsid() # Do second fork. try: pid = os.fork() if pid > 0: # Exit second parent os._exit(0) except OSError as e: print >> sys.stderr, "fork #2 failed: (%d) %s\n" % (e, str(e)) raise SystemExit(1) # Now I am a daemon! # Redirect standard file descriptors. si = open(self._stdin, "r") so = open(self._stdout, "a+") se = open(self._stderr, "a+") os.dup2(si.fileno(), sys.stdin.fileno()) os.dup2(so.fileno(), sys.stdout.fileno()) os.dup2(se.fileno(), sys.stderr.fileno()) self.fire(WritePID()) @handler("started", filter=True, priority=100.0, channel="*") def _on_started(self, component): if component is not self: self.fire(Daemonize()) @handler("registered") def _on_registered(self, component, manager): if component == self and manager.root.running: self.fire(Daemonize()) circuits-2.1.0/circuits/app/env.py0000644000014400001440000001142612113343751016643 0ustar prologicusers# Module: env # Date: 10th June 2006 # Author: James Mills, prologic at shortcircuit dot net dot au """Environment Component An Environment Component that by default sets up a Config and Logger components and is used to create, load and manage system/application environments. """ from os import mkdir from os import makedirs from os.path import abspath, isabs, join as joinpath from circuits import handler, BaseComponent, Event from . import config from .config import Config from .log import Logger VERSION = 1 CONFIG = { "general": { "pidfile": joinpath("%(path)s", "log", "%(name)s.pid"), }, "logging": { "debug": "True", "type": "file", "verbose": "True", "level": "DEBUG", "file": joinpath("%(path)s", "log", "%(name)s.log"), } } ERRORS = ( (0, "No Environment version information",), (1, "Environment needs upgrading",), ) def createFile(filename, data=None): fd = open(filename, "w") if data: fd.write(data) fd.close() class EnvironmentError(Exception): """Environment Error""" class EnvironmentEvent(Event): """Environment Event""" channels = ("env",) class Ready(EnvironmentEvent): """Ready Environment Event""" class Create(EnvironmentEvent): """Create Environment Event""" success = True failure = True class Load(EnvironmentEvent): """Load Environment Event""" success = True failure = True class Verify(EnvironmentEvent): """Verify Environment Event""" success = True failure = True class Upgrade(EnvironmentEvent): """Upgrade Environment Event""" success = True failure = True class Environment(BaseComponent): """Base Environment Component Creates a new environment component that by default only holds configuration and logger components. This component can be extended to provide more complex system and application environments. """ channel = "env" version = VERSION def __init__(self, path, envname, channel=channel): super(Environment, self).__init__(channel=channel) self.path = abspath(path) self.envname = envname @handler("create", priority=1.0) def create(self): return self._create() @handler("load", priority=1.0) def load(self, verify=False): if verify: return self.fire(Verify()) else: return self._load() @handler("verify", priority=1.0) def _on_verify(self): f = open(joinpath(self.path, "VERSION"), "r") version = f.read().strip() f.close() if not version: raise EnvironmentError(*ERRORS[0]) else: if self.version > int(version): raise EnvironmentError(*ERRORS[1]) @handler("verify_success", filter=True) def _on_verify_success(self, evt, retval): return self._load() @handler("load_success", channel="config") def _on_config_load_success(self, evt, retval): # Create Logger Component logname = self.envname logtype = self.config.get("logging", "type", "file") loglevel = self.config.get("logging", "level", "INFO") logfile = self.config.get("logging", "file", "/dev/null") logfile = logfile % {"name": self.envname} if not isabs(logfile): logfile = joinpath(self.path, logfile) self.log = Logger(logfile, logname, logtype, loglevel).register(self) self.fire(Ready()) def _create(self): # Create the directory structure makedirs(self.path) mkdir(joinpath(self.path, "log")) mkdir(joinpath(self.path, "conf")) # Create a few files createFile(joinpath(self.path, "VERSION"), "%d" % self.version) createFile( joinpath(self.path, "README"), "This directory contains a %s Environment." % self.envname ) # Setup the default configuration configfile = joinpath(self.path, "conf", "%s.ini" % self.envname) createFile(configfile) self.config = Config(configfile).register(self) for section in CONFIG: if not self.config.has_section(section): self.config.add_section(section) for option, value in CONFIG[section].items(): if type(value) == str: value = value % { "name": self.envname, "path": self.path, } self.config.set(section, option, value) return self.fire(config.Save(), self.config) def _load(self): # Create Config Component configfile = joinpath(self.path, "conf", "%s.ini" % self.envname) self.config = Config(configfile).register(self) self.fire(config.Load()) return True circuits-2.1.0/circuits/app/startup.py0000644000014400001440000000647712113343751017567 0ustar prologicusers# Module: startup # Date: 21st March 2011 # Author: James Mills, jamesmills at comops dot com dot au """Startup Component This module implements a ``Startup`` Component that create a unified way of creating, managing and running an application in conjunction with an environment (``circuits.app.env``). The ``Startup`` Component provides five verbs that can be passed as command-line arguments: - start -- Start the application - stop -- Stop the application - init -- Create the application environment - rehash -- Reload the application's environment - upgrade -- Upgrade the application's environment """ import os import errno from time import sleep from signal import SIGINT, SIGTERM try: from signal import SIGHUP except ImportError: SIGHUP = None from circuits import handler, Event, BaseComponent from .daemon import Daemon from .env import Environment from .env import Create, Load, Upgrade class Error(Exception): """Error Exception""" class Command(Event): """Command Event""" class Terminate(Event): """Terminate Event""" class Startup(BaseComponent): channel = "startup" def __init__(self, path, opts, command, env=Environment, channel=channel): super(Startup, self).__init__(channel=channel) self.path = path self.opts = opts self.command = command self.env = env(path).register(self) def _getpid(self): with open(self.config.get("general", "pidfile"), "r") as f: return int(f.read().strip()) def __tick__(self): if not self.command == "start" and not self: self.stop() @handler("signal", channel="*") def _on_signal(self, signal, track): if signal in (SIGINT, SIGTERM): self.fire(Terminate()) @handler("environment_loaded", channel="env") def _on_environment_loaded(self, *args): self.fire(Command(), self.command, self) @handler("started") def _on_started(self, component): if not self.command == "init": if not os.path.exists(self.env.path): raise Error("Environment does not exist!") else: self.fire(Load(), self.env) else: if os.path.exists(self.env.path): raise Error("Environment already exists!") else: self.fire(Command(), self.command, self) @handler("start") def _on_start(self): if self.opts.daemon: pidfile = self.env.config.get("general", "pidfile", "app.pid") Daemon(pidfile, self.env.path).register(self) @handler("stop") def _on_stop(self): pid = self._getpid() try: os.kill(pid, SIGTERM) os.waitpid(pid, os.WTERMSIG(0)) except OSError as e: if not e.args[0] == errno.ECHILD: raise @handler("restart") def _on_restart(self): self.fire(Command(), "stop", self.channel) sleep(1) self.fire(Command(), "start", self.channel) if SIGHUP is not None: @handler("rehash") def _on_rehash(self): pid = self._getpid() os.kill(pid, SIGHUP) @handler("init") def _on_init(self): self.fire(Create(), self.env) @handler("upgrade") def _on_upgrade(self): self.fire(Upgrade(), self.env) circuits-2.1.0/circuits/app/log.py0000644000014400001440000000524712113343751016640 0ustar prologicusers# Module: logging # Date: 11th June 2006 # Author: James Mills """Logging Components""" import sys import logging from logging import DEBUG, INFO, WARNING, WARN, ERROR, CRITICAL from circuits.core import handler, Event, BaseComponent class Log(Event): """Log Event""" channels = ("logger",) class Logger(BaseComponent): channel = "logger" LEVELS = { "debug": DEBUG, "info": INFO, "warning": WARNING, "warn": WARN, "error": ERROR, "exception": ERROR, "critical": CRITICAL } def __init__(self, filename, name, type, level, channel=channel): super(Logger, self).__init__(channel=channel) self.logger = logging.getLogger(name) type = type.lower() if type == "file": hdlr = logging.FileHandler(filename) elif type in ["winlog", "eventlog", "nteventlog"]: # Requires win32 extensions hdlr = logging.handlers.NTEventLogHandler(name, type="Application") elif type in ["syslog", "unix"]: hdlr = logging.handlers.SysLogHandler("/dev/log") elif type in ["stderr"]: hdlr = logging.StreamHandler(sys.stderr) else: raise ValueError format = name + "[%(module)s] %(levelname)s: %(message)s" if type == "file": format = "%(asctime)s " + format dateFormat = "" level = level.upper() if level in ["DEBUG", "ALL"]: self.logger.setLevel(logging.DEBUG) dateFormat = "%X" elif level == "INFO": self.logger.setLevel(logging.INFO) elif level == "ERROR": self.logger.setLevel(logging.ERROR) elif level == "CRITICAL": self.logger.setLevel(logging.CRITICAL) else: self.logger.setLevel(logging.WARNING) formatter = logging.Formatter(format, dateFormat) hdlr.setFormatter(formatter) self.logger.addHandler(hdlr) @handler("log") def _on_log(self, level, msg, *args, **kwargs): self.logger.log(self.LEVELS[level.lower()], msg, *args, **kwargs) def debug(self, msg, *args, **kwargs): self.logger.debug(msg, *args, **kwargs) def info(self, msg, *args, **kwargs): self.logger.info(msg, *args, **kwargs) def warning(self, msg, *args, **kwargs): self.logger.warning(msg, *args, **kwargs) warn = warning def error(self, msg, *args, **kwargs): self.logger.error(msg, *args, **kwargs) def exception(self, msg, *args, **kwargs): self.logger.exception(msg, *args) def critical(self, msg, *args, **kwargs): self.logger.critical(msg, *args, **kwargs) circuits-2.1.0/circuits/app/__init__.py0000644000014400001440000000103412113343751017604 0ustar prologicusers# Package: app # Date: 20th June 2009 # Author: James Mills, prologic at shortcircuit dot net dot au """Application Components Contains various components useful for application development and tasks common to applications. :copyright: CopyRight (C) 2004-2012 by James Mills :license: MIT (See: LICENSE) """ from .log import Logger from .config import Config from .daemon import Daemon from .env import Environment from .startup import Startup __all__ = ("Logger", "Config", "Daemon", "Environment", "Startup",) # flake8: noqa circuits-2.1.0/circuits/net/0000755000014400001440000000000012113366740015506 5ustar prologicuserscircuits-2.1.0/circuits/net/sockets.py0000644000014400001440000006543312113343751017543 0ustar prologicusers# Module: sockets # Date: 04th August 2004 # Author: James Mills import select """Socket Components This module contains various Socket Components for use with Networking. """ import os from collections import defaultdict, deque from errno import EAGAIN, EALREADY, EBADF from errno import ECONNABORTED, EINPROGRESS, EINTR, EISCONN, EMFILE, ENFILE from errno import ENOBUFS, ENOMEM, ENOTCONN, EPERM, EPIPE, EINVAL, EWOULDBLOCK from _socket import socket as SocketType from socket import gaierror, error from socket import getfqdn, gethostbyname, socket, getaddrinfo, gethostname from socket import AF_INET, AF_INET6, IPPROTO_TCP, SOCK_STREAM, SOCK_DGRAM from socket import SOL_SOCKET, SO_BROADCAST, SO_REUSEADDR, TCP_NODELAY try: from ssl import wrap_socket as ssl_socket from ssl import CERT_NONE, PROTOCOL_SSLv23, SSLError, SSL_ERROR_WANT_READ, \ SSL_ERROR_WANT_WRITE HAS_SSL = 1 except ImportError: import warnings warnings.warn("No SSL support available.") HAS_SSL = 0 from circuits.six import binary_type from circuits.core.utils import findcmp from circuits.core.pollers import BasePoller, Poller from circuits.core import handler, Event, BaseComponent BUFSIZE = 4096 # 4KB Buffer BACKLOG = 5000 # 5K Concurrent Connections ### ### Event Objects ### class Connect(Event): """Connect Event This Event is sent when a new client connection has arrived on a server. This event is also used for client's to initiate a new connection to a remote host. .. note :: This event is used for both Client and Server Components. :param args: Client: (host, port) Server: (sock, host, port) :type args: tuple :param kwargs: Client: (ssl) :type kwargs: dict """ def __init__(self, *args, **kwargs): "x.__init__(...) initializes x; see x.__class__.__doc__ for signature" super(Connect, self).__init__(*args, **kwargs) class Disconnect(Event): """Disconnect Event This Event is sent when a client connection has closed on a server. This event is also used for client's to disconnect from a remote host. @note: This event is used for both Client and Server Components. :param args: Client: () Server: (sock) :type tuple: tuple """ def __init__(self, *args): "x.__init__(...) initializes x; see x.__class__.__doc__ for signature" super(Disconnect, self).__init__(*args) class Connected(Event): """Connected Event This Event is sent when a client has successfully connected. @note: This event is for Client Components. :param host: The hostname connected to. :type str: str :param port: The port connected to :type int: int """ def __init__(self, host, port): "x.__init__(...) initializes x; see x.__class__.__doc__ for signature" super(Connected, self).__init__(host, port) class Disconnected(Event): """Disconnected Event This Event is sent when a client has disconnected @note: This event is for Client Components. """ def __init__(self): "x.__init__(...) initializes x; see x.__class__.__doc__ for signature" super(Disconnected, self).__init__() class Read(Event): """Read Event This Event is sent when a client or server connection has read any data. @note: This event is used for both Client and Server Components. :param args: Client: (data) Server: (sock, data) :type tuple: tuple """ def __init__(self, *args): "x.__init__(...) initializes x; see x.__class__.__doc__ for signature" super(Read, self).__init__(*args) class SocketError(Event): """SocketError Event This Event is sent when a client or server connection has an error. @note: This event is used for both Client and Server Components. :param args: Client: (error) Server: (sock, error) :type tuple: tuple """ def __init__(self, *args): "x.__init__(...) initializes x; see x.__class__.__doc__ for signature" super(SocketError, self).__init__(*args) class Write(Event): """Write Event This Event is used to notify a client, client connection or server that we have data to be written. @note: This event is never sent, it is used to send data. @note: This event is used for both Client and Server Components. :param args: Client: (data) Server: (sock, data) :type tuple: tuple """ def __init__(self, *args): "x.__init__(...) initializes x; see x.__class__.__doc__ for signature" super(Write, self).__init__(*args) class Close(Event): """Close Event This Event is used to notify a client, client connection or server that we want to close. @note: This event is never sent, it is used to close. @note: This event is used for both Client and Server Components. :param args: Client: () Server: (sock) :type tuple: tuple """ def __init__(self, *args): "x.__init__(...) initializes x; see x.__class__.__doc__ for signature" super(Close, self).__init__(*args) class Ready(Event): """Ready Event This Event is used to notify the rest of the system that the underlying Client or Server Component is ready to begin processing connections or incoming/outgoing data. (This is triggered as a direct result of having the capability to support multiple client/server components with a single poller component instance in a system). @note: This event is used for both Client and Server Components. :param component: The Client/Server Component that is ready. :type tuple: Component (Client/Server) :param bind: The (host, port) the server has bound to. :type tuple: (host, port) """ def __init__(self, component, bind=None): "x.__init__(...) initializes x; see x.__class__.__doc__ for signature" args = (component, bind) if bind is not None else (component,) super(Ready, self).__init__(*args) class Closed(Event): """Closed Event This Event is sent when a server has closed its listening socket. @note: This event is for Server components. """ def __init__(self): "x.__init__(...) initializes x; see x.__class__.__doc__ for signature" super(Closed, self).__init__() class Client(BaseComponent): channel = "client" def __init__(self, bind=None, bufsize=BUFSIZE, channel=channel): super(Client, self).__init__(channel=channel) if isinstance(bind, SocketType): self._bind = bind.getsockname() self._sock = bind else: self._bind = self.parse_bind_parameter(bind) self._sock = self._create_socket() self._bufsize = bufsize self._ssock = None self._poller = None self._buffer = deque() self._closeflag = False self._connected = False self.host = None self.port = 0 self.secure = False self.server = {} self.issuer = {} def parse_bind_parameter(self, bind_parameter): return parse_ipv4_parameter(bind_parameter) @property def connected(self): return getattr(self, "_connected", None) @handler("registered", "started", channel="*") def _on_registered_or_started(self, component, manager=None): if self._poller is None: if isinstance(component, BasePoller): self._poller = component self.fire(Ready(self)) else: if component is not self: return component = findcmp(self.root, BasePoller) if component is not None: self._poller = component self.fire(Ready(self)) else: self._poller = Poller().register(self) self.fire(Ready(self)) @handler("stopped", channel="*") def _on_stopped(self, component): self.fire(Close()) @handler("read_value_changed") def _on_read_value_changed(self, value): if isinstance(value, binary_type): self.fire(Write(value)) @handler("prepare_unregister", channel="*") def _on_prepare_unregister(self, event, c): if event.in_subtree(self): self._close() def _close(self): if not self._connected: return self._poller.discard(self._sock) self._buffer.clear() self._closeflag = False self._connected = False try: self._sock.shutdown(2) self._sock.close() except error: pass self.fire(Disconnected()) @handler("close") def close(self): if not self._buffer: self._close() elif not self._closeflag: self._closeflag = True def _read(self): try: if self.secure and self._ssock: data = self._ssock.read(self._bufsize) else: data = self._sock.recv(self._bufsize) if data: self.fire(Read(data)).notify = True else: self.close() except error as e: if e.args[0] == EWOULDBLOCK: return else: self.fire(SocketError(e)) self._close() def _write(self, data): try: if self.secure and self._ssock: nbytes = self._ssock.write(data) else: nbytes = self._sock.send(data) if nbytes < len(data): self._buffer.appendleft(data[nbytes:]) except error as e: if e.args[0] in (EPIPE, ENOTCONN): self._close() else: self.fire(SocketError(e)) @handler("write") def write(self, data): if not self._poller.isWriting(self._sock): self._poller.addWriter(self, self._sock) self._buffer.append(data) @handler("_disconnect", filter=True) def __on_disconnect(self, sock): self._close() @handler("_read", filter=True) def __on_read(self, sock): self._read() @handler("_write", filter=True) def __on_write(self, sock): if self._buffer: data = self._buffer.popleft() self._write(data) if not self._buffer: if self._closeflag: self._close() elif self._poller.isWriting(self._sock): self._poller.removeWriter(self._sock) def _do_handshake_for_non_blocking(ssock): """ This is how to do handshake for an ssl socket with underlying non-blocking socket (according to the Python doc). """ while True: try: ssock.do_handshake() break except SSLError as err: if err.args[0] == SSL_ERROR_WANT_READ: select.select([ssock], [], []) elif err.args[0] == SSL_ERROR_WANT_WRITE: select.select([], [ssock], []) else: raise class TCPClient(Client): socket_family = AF_INET def _create_socket(self): sock = socket(self.socket_family, SOCK_STREAM, IPPROTO_TCP) if self._bind is not None: sock.bind(self._bind) sock.setblocking(False) sock.setsockopt(IPPROTO_TCP, TCP_NODELAY, 1) return sock @handler("connect") def connect(self, host, port, secure=False, **kwargs): self.host = host self.port = port self.secure = secure if self.secure: self.certfile = kwargs.get("certfile", None) self.keyfile = kwargs.get("keyfile", None) try: r = self._sock.connect((host, port)) except error as e: if e.args[0] in (EBADF, EINVAL,): self._sock = self._create_socket() r = self._sock.connect_ex((host, port)) else: r = e.args[0] if r in (EISCONN, EWOULDBLOCK, EINPROGRESS, EALREADY): self._connected = True else: raise self._connected = True self._poller.addReader(self, self._sock) if self.secure: self._ssock = ssl_socket( self._sock, self.keyfile, self.certfile, do_handshake_on_connect=False ) _do_handshake_for_non_blocking(self._ssock) self.fire(Connected(host, port)) class TCP6Client(TCPClient): socket_family = AF_INET6 def parse_bind_parameter(self, bind_parameter): return parse_ipv6_parameter(bind_parameter) class UNIXClient(Client): def _create_socket(self): from socket import AF_UNIX sock = socket(AF_UNIX, SOCK_STREAM) if self._bind is not None: sock.bind(self._bind) sock.setblocking(False) return sock @handler("ready") def ready(self, component): if self._poller is not None and self._connected: self._poller.addReader(self, self._sock) @handler("connect") def connect(self, path, secure=False, **kwargs): self.path = path self.secure = secure if self.secure: self.certfile = kwargs.get("certfile", None) self.keyfile = kwargs.get("keyfile", None) try: r = self._sock.connect_ex(path) except error as e: r = e.args[0] if r: if r in (EISCONN, EWOULDBLOCK, EINPROGRESS, EALREADY): self._connected = True else: self.fire(SocketError(r)) return self._connected = True self._poller.addReader(self, self._sock) if self.secure: self._ssock = ssl_socket( self._sock, self.keyfile, self.certfile, do_handshake_on_connect=False ) _do_handshake_for_non_blocking(self._ssock) self.fire(Connected(gethostname(), path)) class Server(BaseComponent): channel = "server" def __init__(self, bind, secure=False, backlog=BACKLOG, bufsize=BUFSIZE, channel=channel, **kwargs): super(Server, self).__init__(channel=channel) self._bind = self.parse_bind_parameter(bind) self._backlog = backlog self._bufsize = bufsize if isinstance(bind, socket): self._sock = bind else: self._sock = self._create_socket() self._closeq = [] self._clients = [] self._poller = None self._buffers = defaultdict(deque) self.secure = secure if self.secure: self.certfile = kwargs.get("certfile", None) self.keyfile = kwargs.get("keyfile", None) self.cert_reqs = kwargs.get("cert_reqs", CERT_NONE) self.ssl_version = kwargs.get("ssl_version", PROTOCOL_SSLv23) self.ca_certs = kwargs.get("ca_certs", None) def parse_bind_parameter(self, bind_parameter): return parse_ipv4_parameter(bind_parameter) @property def connected(self): return True @property def host(self): if getattr(self, "_sock", None) is not None: try: sockname = self._sock.getsockname() if isinstance(sockname, tuple): return sockname[0] else: return sockname except error: return None @property def port(self): if getattr(self, "_sock", None) is not None: try: sockname = self._sock.getsockname() if isinstance(sockname, tuple): return sockname[1] except error: return None @handler("registered", "started", channel="*") def _on_registered_or_started(self, component, manager=None): if self._poller is None: if isinstance(component, BasePoller): self._poller = component self._poller.addReader(self, self._sock) self.fire(Ready(self, (self.host, self.port))) else: if component is not self: return component = findcmp(self.root, BasePoller) if component is not None: self._poller = component self._poller.addReader(self, self._sock) self.fire(Ready(self, (self.host, self.port))) else: self._poller = Poller().register(self) self._poller.addReader(self, self._sock) self.fire(Ready(self, (self.host, self.port))) @handler("stopped", channel="*") def _on_stopped(self, component): self.fire(Close()) @handler("read_value_changed") def _on_read_value_changed(self, value): if isinstance(value.value, binary_type): sock = value.event.args[0] self.fire(Write(sock, value.value)) def _close(self, sock): if sock is None: return if not sock == self._sock and sock not in self._clients: return self._poller.discard(sock) if sock in self._buffers: del self._buffers[sock] if sock in self._clients: self._clients.remove(sock) else: self._sock = None try: sock.shutdown(2) sock.close() except error: pass self.fire(Disconnect(sock)) @handler("close") def close(self, sock=None): closed = sock is None if sock is None: socks = [self._sock] socks.extend(self._clients[:]) else: socks = [sock] for sock in socks: if not self._buffers[sock]: self._close(sock) elif sock not in self._closeq: self._closeq.append(sock) if closed: self.fire(Closed()) def _read(self, sock): if sock not in self._clients: return try: data = sock.recv(self._bufsize) if data: self.fire(Read(sock, data)).notify = True else: self.close(sock) except error as e: if e.args[0] == EWOULDBLOCK: return else: self.fire(SocketError(sock, e)) self._close(sock) def _write(self, sock, data): if sock not in self._clients: return try: nbytes = sock.send(data) if nbytes < len(data): self._buffers[sock].appendleft(data[nbytes:]) except error as e: if e.args[0] not in (EINTR, EWOULDBLOCK, ENOBUFS): self.fire(SocketError(sock, e)) self._close(sock) else: self._buffers[sock].appendleft(data) @handler("write") def write(self, sock, data): if not self._poller.isWriting(sock): self._poller.addWriter(self, sock) self._buffers[sock].append(data) def _accept(self): try: newsock, host = self._sock.accept() if self.secure and HAS_SSL: newsock = ssl_socket( newsock, server_side=True, keyfile=self.keyfile, ca_certs=self.ca_certs, certfile=self.certfile, cert_reqs=self.cert_reqs, ssl_version=self.ssl_version, do_handshake_on_connect=False ) _do_handshake_for_non_blocking(newsock) except SSLError as e: raise except error as e: if e.args[0] in (EWOULDBLOCK, EAGAIN): return elif e.args[0] == EPERM: # Netfilter on Linux may have rejected the # connection, but we get told to try to accept() # anyway. return elif e.args[0] in (EMFILE, ENOBUFS, ENFILE, ENOMEM, ECONNABORTED): # Linux gives EMFILE when a process is not allowed # to allocate any more file descriptors. *BSD and # Win32 give (WSA)ENOBUFS. Linux can also give # ENFILE if the system is out of inodes, or ENOMEM # if there is insufficient memory to allocate a new # dentry. ECONNABORTED is documented as possible on # both Linux and Windows, but it is not clear # whether there are actually any circumstances under # which it can happen (one might expect it to be # possible if a client sends a FIN or RST after the # server sends a SYN|ACK but before application code # calls accept(2), however at least on Linux this # _seems_ to be short-circuited by syncookies. return else: raise newsock.setblocking(False) self._poller.addReader(self, newsock) self._clients.append(newsock) self.fire(Connect(newsock, *host)) @handler("_disconnect", filter=True) def _on_disconnect(self, sock): self._close(sock) @handler("_read", filter=True) def _on_read(self, sock): if sock == self._sock: self._accept() else: self._read(sock) @handler("_write", filter=True) def _on_write(self, sock): if self._buffers[sock]: data = self._buffers[sock].popleft() self._write(sock, data) if not self._buffers[sock]: if sock in self._closeq: self._closeq.remove(sock) self._close(sock) elif self._poller.isWriting(sock): self._poller.removeWriter(sock) class TCPServer(Server): socket_family = AF_INET def _create_socket(self): sock = socket(self.socket_family, SOCK_STREAM) sock.setsockopt(SOL_SOCKET, SO_REUSEADDR, 1) sock.setsockopt(IPPROTO_TCP, TCP_NODELAY, 1) sock.setblocking(False) sock.bind(self._bind) sock.listen(self._backlog) return sock def parse_bind_parameter(self, bind_parameter): return parse_ipv4_parameter(bind_parameter) def parse_ipv4_parameter(bind_parameter): if type(bind_parameter) is int: try: bind = (gethostbyname(gethostname()), bind_parameter) except gaierror: bind = ("0.0.0.0", bind_parameter) elif type(bind_parameter) is str and ":" in bind_parameter: host, port = bind_parameter.split(":") port = int(port) bind = (host, port) else: bind = bind_parameter return bind def parse_ipv6_parameter(bind_parameter): if type(bind_parameter) is int: try: _, _, _, _, bind \ = getaddrinfo(getfqdn(), bind_parameter, AF_INET6)[0] except (gaierror, IndexError): bind = ("::", bind_parameter) else: bind = bind_parameter return bind class TCP6Server(TCPServer): socket_family = AF_INET6 def parse_bind_parameter(self, bind_parameter): return parse_ipv6_parameter(bind_parameter) class UNIXServer(Server): def _create_socket(self): from socket import AF_UNIX if os.path.exists(self._bind): os.unlink(self._bind) sock = socket(AF_UNIX, SOCK_STREAM) sock.bind(self._bind) sock.setsockopt(SOL_SOCKET, SO_REUSEADDR, 1) sock.setblocking(False) sock.listen(self._backlog) return sock class UDPServer(Server): socket_family = AF_INET def _create_socket(self): sock = socket(self.socket_family, SOCK_DGRAM) sock.bind(self._bind) sock.setsockopt(SOL_SOCKET, SO_BROADCAST, 1) sock.setsockopt(SOL_SOCKET, SO_REUSEADDR, 1) sock.setblocking(False) return sock def _close(self, sock): self._poller.discard(sock) if sock in self._buffers: del self._buffers[sock] try: sock.shutdown(2) except error: pass try: sock.close() except error: pass self.fire(Disconnect(sock)) @handler("close", override=True) def close(self): self.fire(Closed()) if self._buffers[self._sock] and self._sock not in self._closeq: self._closeq.append(self._sock) else: self._close(self._sock) def _read(self): try: data, address = self._sock.recvfrom(self._bufsize) if data: self.fire(Read(address, data)).notify = True except error as e: if e.args[0] in (EWOULDBLOCK, EAGAIN): return self.fire(SocketError(self._sock, e)) self._close(self._sock) def _write(self, address, data): try: bytes = self._sock.sendto(data, address) if bytes < len(data): self._buffers[self._sock].appendleft(data[bytes:]) except error as e: if e.args[0] in (EPIPE, ENOTCONN): self._close(self._sock) else: self.fire(SocketError(self._sock, e)) @handler("write", override=True) def write(self, address, data): if not self._poller.isWriting(self._sock): self._poller.addWriter(self, self._sock) self._buffers[self._sock].append((address, data)) @handler("broadcast", override=True) def broadcast(self, data, port): self.write(("", port), data) @handler("_disconnect", filter=True, override=True) def _on_disconnect(self, sock): self._close(sock) @handler("_read", filter=True, override=True) def _on_read(self, sock): self._read() @handler("_write", filter=True, override=True) def _on_write(self, sock): if self._buffers[self._sock]: address, data = self._buffers[self._sock].popleft() self._write(address, data) if not self._buffers[self._sock]: if self._sock in self._closeq: self._closeq.remove(self._sock) self._close(self._sock) elif self._poller.isWriting(self._sock): self._poller.removeWriter(self._sock) UDPClient = UDPServer class UDP6Server(UDPServer): socket_family = AF_INET6 def parse_bind_parameter(self, bind_parameter): return parse_ipv6_parameter(bind_parameter) UDP6Client = UDP6Server def Pipe(*channels, **kwargs): """Create a new full duplex Pipe Returns a pair of UNIXClient instances connected on either side of the pipe. """ from socket import socketpair if not channels: channels = ("a", "b") s1, s2 = socketpair() s1.setblocking(False) s2.setblocking(False) a = UNIXClient(s1, channel=channels[0], **kwargs) b = UNIXClient(s2, channel=channels[1], **kwargs) a._connected = True b._connected = True return a, b circuits-2.1.0/circuits/net/__init__.py0000644000014400001440000000054312072034467017623 0ustar prologicusers# Package: net # Date: 7th April 2010 # Author: James Mills, prologic at shortcircuit dot net dot au """Networking Components This package contains components that implement network sockets and protocols for implementing client and server network applications. :copyright: CopyRight (C) 2004-2012 by James Mills :license: MIT (See: LICENSE) """ circuits-2.1.0/circuits/net/protocols/0000755000014400001440000000000012113366740017532 5ustar prologicuserscircuits-2.1.0/circuits/net/protocols/websocket.py0000644000014400001440000001676412113343751022105 0ustar prologicusers""" .. codeauthor: mnl """ import os import random from circuits.six import string_types from circuits.core.handlers import handler from circuits.core.components import BaseComponent from circuits.net.sockets import Write, Read, Close class WebSocketCodec(BaseComponent): """WebSocket Protocol Implements the Data Framing protocol for WebSocket. This component is used in conjunction with a parent component that receives Read events on its channel. When created (after a successful WebSocket setup handshake), the codec registers a handler on the parent's channel that filters out these Read events for a given socket (if used in a server) or all Read events (if used in a client). The data is decoded and the contained payload is emitted as Read events on the codec's channel. The data from Write events sent to the codec's channel (with socket argument if used in a server) is encoded according to the WebSocket Data Framing protocol. The encoded data is then forwarded as Write events on the parents channel. """ channel = "ws" def __init__(self, sock=None, *args, **kwargs): """ Creates a new codec. :param sock: the socket used in Read and Write events (if used in a server, else None) """ super(WebSocketCodec, self).__init__(*args, **kwargs) self._sock = sock self._buffer = bytearray() self._pending_payload = bytearray() self._pending_type = None self._close_received = False self._close_sent = False @handler("registered") def _on_registered(self, component, parent): if component == self: @handler("read", priority=10, filter=True, channel=parent.channel) def _on_read_raw(self, *args): if self._sock is not None: if args[0] != self._sock: return data = args[1] else: data = args[0] self._buffer += data messages = self._parse_messages() for message in messages: if self._sock is not None: self.fire(Read(self._sock, message)) else: self.fire(Read(message)) return True self.addHandler(_on_read_raw) @handler("disconnect", channel=parent.channel) def _on_disconnect(self, *args): if self._sock is not None: if args[0] != self._sock: return self.unregister() self.addHandler(_on_disconnect) def _parse_messages(self): msgs = [] # one chunk of bytes may result in several messages if self._close_received: return msgs while self._buffer: # extract final flag, opcode and masking final = True if self._buffer[0] & 0x80 != 0 else False opcode = self._buffer[0] & 0xf masking = True if self._buffer[1] & 0x80 != 0 else False # evaluate payload length payload_length = self._buffer[1] & 0x7f offset = 2 if payload_length >= 126: payload_bytes = 2 if payload_length == 126 else 8 payload_length = 0 for _ in range(payload_bytes): payload_length = payload_length * 256 \ + self._buffer[offset] offset += 1 # retrieve optional masking key if masking: masking_key = self._buffer[offset:offset + 4] offset += 4 # if not enough bytes available yet, retry after next read if len(self._buffer) - offset < payload_length: break # rest of _buffer is payload msg = self._buffer[offset:offset + payload_length] if masking: # unmask msg = list(msg) for i, c in enumerate(msg): msg[i] = c ^ masking_key[i % 4] msg = bytearray(msg) # remove bytes of processed frame from byte _buffer offset += payload_length self._buffer = self._buffer[offset:] # if there have been parts already, combine msg = self._pending_payload + msg if final: if opcode < 8: # if text or continuation of text, convert if opcode == 1 \ or opcode == 0 and self._pending_type == 1: msg = msg.decode("utf-8", "replace") msgs.append(msg) # check for client closing the connection elif opcode == 8: self._close_received = True if self._sock: self.fire(Close(self._sock)) else: self.fire(Close()) break # check for Ping elif opcode == 9: if self._close_sent: return frame = bytearray(b'\x8a') frame += self._encode_tail(msg, self._sock is None) self._write(frame) else: self._pending_payload = msg if opcode != 0: self._pending_type = opcode return msgs @handler("write") def _on_write(self, *args): if self._close_sent: return if self._sock is not None: data = args[1] else: data = args[0] frame = bytearray() first = 0x80 # set FIN flag, we never fragment if isinstance(data, string_types): first += 1 # text data = bytearray(data, "utf-8") else: first += 2 # binary frame.append(first) frame += self._encode_tail(data, self._sock is None) self._write(frame) def _encode_tail(self, data, mask=False): tail = bytearray() data_length = len(data) if data_length <= 125: len_byte = data_length lbytes = 0 elif data_length <= 0xffff: len_byte = 126 lbytes = 2 else: len_byte = 127 lbytes = 8 if mask: len_byte = len_byte | 0x80 tail.append(len_byte) for i in range(lbytes - 1, 0, -1): tail.append(data_length >> (i * 8) & 0xff) if mask: try: masking_key = bytearray([ord(x) for x in list(os.urandom(4))]) except NotImplementedError: masking_key \ = bytearray([random.randint(0, 255) for i in range(4)]) tail += masking_key for i, c in enumerate(data): tail.append(c ^ masking_key[i % 4]) else: tail += data return tail def _write(self, data): if self._sock is not None: self.fire(Write(self._sock, data), self.parent.channel) else: self.fire(Write(data), self.parent.channel) @handler("close") def _on_close(self, *args): if not self._close_sent: self._write(b"\x88\x00") self._close_sent = True if self._close_received and self._close_sent: if self._sock: self.fire(Close(self._sock), self.parent.channel) else: self.fire(Close(), self.parent.channel) circuits-2.1.0/circuits/net/protocols/line.py0000644000014400001440000000715512113343751021040 0ustar prologicusers# Module: line # Date: 04th February 2010 # Author: James Mills """Line Protocol This module implements the basic Line protocol. This module can be used in both server and client implementations. """ import re from circuits.core import handler, Event, BaseComponent LINESEP = re.compile(b"\r?\n") def splitLines(s, buffer): """splitLines(s, buffer) -> lines, buffer Append s to buffer and find any new lines of text in the string splitting at the standard IRC delimiter CRLF. Any new lines found, return them as a list and the remaining buffer for further processing. """ lines = LINESEP.split(buffer + s) return lines[:-1], lines[-1] class Line(Event): """Line Event""" class LP(BaseComponent): """Line Protocol Implements the Line Protocol. Incoming data is split into lines with a splitter function. For each line of data processed a Line Event is created. Any unfinished lines are appended into an internal buffer. A custom line splitter function can be passed to customize how data is split into lines. This function must accept two arguments, the data to process and any left over data from a previous invocation of the splitter function. The function must also return a tiple of two items, a list of lines and any left over data. :param splitter: a line splitter function :type splitter: function This Component operates in two modes. In normal operation it's expected to be used in conjunction with components that expose a Read Event on a "read" channel with only one argument (data). Some builtin components that expose such events are: - circuits.net.sockets.TCPClient - circuits.io.File The second mode of operation works with circuits.net.sockets.Server components such as TCPServer, UNIXServer, etc. It's expected that two arguments exist in the Read Event, sock and data. The following two arguments can be passed to affect how unfinished data is stored and retrieved for such components: :param getBuffer: function to retrieve the buffer for a client sock :type getBuffer: function This function must accept one argument (sock,) the client socket whoose buffer is to be retrieved. :param updateBuffer: function to update the buffer for a client sock :type updateBuffer: function This function must accept two arguments (sock, buffer,) the client socket and the left over buffer to be updated. @note: This Component must be used in conjunction with a Component that exposes Read events on a "read" Channel. """ def __init__(self, *args, **kwargs): "initializes x; see x.__class__.__doc__ for signature" super(LP, self).__init__(*args, **kwargs) self.encoding = kwargs.get('encoding', 'utf-8') # Used for Servers self.getBuffer = kwargs.get("getBuffer") self.updateBuffer = kwargs.get("updateBuffer") self.splitter = kwargs.get("splitter", splitLines) self.buffer = b"" @handler("read") def _on_read(self, *args): if len(args) == 1: # Client read data, = args lines, self.buffer = self.splitter(data, self.buffer) for line in lines: self.fire(Line(line.decode(self.encoding, "replace"))) else: # Server read sock, data = args lines, buffer = self.splitter(data, self.getBuffer(sock)) self.updateBuffer(sock, buffer) for line in lines: self.fire(Line(sock, line.decode(self.encoding, "replace"))) circuits-2.1.0/circuits/net/protocols/irc.py0000644000014400001440000002667312113343751020674 0ustar prologicusers# Module: irc # Date: 04th August 2004 # Author: James Mills """Internet Relay Chat Protocol This module implements the Internet Relay Chat Protocol or commonly known as IRC. This module can be used in both server and client implementations. """ import re from circuits.net.sockets import Write from circuits.core import handler, Event, Component from .line import LP ### ### Supporting Functions ### def strip(s, color=False): """strip(s, color=False) -> str Strips the : from the start of a string and optionally also strips all colors if color is True. """ if len(s) > 0: if s[0] == ":": s = s[1:] if color: s = s.replace("\x01", "") s = s.replace("\x02", "") return s def sourceJoin(nick, ident, host): """sourceJoin(nick, ident, host) -> str Join a source previously split by sourceSplit and join it back together inserting the ! and @ appropiately. """ return "%s!%s@%s" % (nick, ident, host) def sourceSplit(source): """sourceSplit(source) -> str, str, str Split the given source into its parts. source must be of the form: nick!ident@host Example: >>> nick, ident, host, = sourceSplit("Joe!Blogs@localhost") """ m = re.match( "(?P[^!].*)!(?P.*)@(?P.*)", source ) if m is not None: d = m.groupdict() return d["nick"], d["ident"], d["host"] else: return source, None, None ### ### IRC Commands ### class Command(Event): """Command Event""" def __init__(self, *args, **kwargs): super(Command, self).__init__(*args, **kwargs) self.name = "command_{0}".format(self.__class__.__name__.lower()) class RAW(Command): """RAW command""" class PASS(Command): """PASS command""" class USER(Command): """USER command""" class NICK(Command): """NICK command""" class PING(Command): """PING command""" class PONG(Command): """PONG command""" class QUIT(Command): """QUIT command""" class JOIN(Command): """JOIN command""" class PART(Command): """PART command""" class PRIVMSG(Command): """PRIVMSG command""" class NOTICE(Command): """NOTICE command""" class CTCP(Command): """CTCP command""" class CTCPREPLY(Command): """CTCPREPLY command""" class KICK(Command): """KICK command""" class TOPIC(Command): """TOPIC command""" class MODE(Command): """MODE command""" class INVITE(Command): """INVITE command""" class NAMES(Command): """NAMES command""" ### ### IRC Responses ### class Response(Event): """Response (Event)""" class Numeric(Response): """Numeric response""" class Ping(Response): """Ping response""" class Ctcp(Response): """Ctcp response""" class Message(Response): """Message response""" class Notice(Response): """Notice response""" class Join(Response): """Join response""" class Part(Response): """Part response""" class Quit(Response): """Quit response""" class Nick(Response): """Nick response""" class Mode(Response): """Mode response""" ### ### Protocol Component(s) ### class IRC(Component): """IRC Protocol Component Creates a new IRC Component instance that implements the IRC Protocol. Incoming messages are handled by the "read" Event Handler, parsed and processed with appropriate Events created and exposed to the rest of te system to listen to and handle. @note: This Component must be used in conjunction with a Component that exposes Read Events on a "read" Channel. """ def __init__(self, *args, **kwargs): super(IRC, self).__init__(*args, **kwargs) LP(**kwargs).register(self) ### ### IRC Command Event Handlers ### def command_raw(self, data): self.fire(Write("%s\r\n" % data)) @handler("command_pass") def _on_command_pass(self, password): self.fire(RAW("PASS %s" % password)) def command_user(self, ident, host, server, name): self.fire(RAW("USER %s \"%s\" \"%s\" :%s" % ( ident, host, server, name))) def command_nick(self, nick): self.fire(RAW("NICK %s" % nick)) def command_ping(self, server): self.fire(RAW("PING :%s" % server)) def command_pong(self, server): self.fire(RAW("PONG :%s" % server)) def command_quit(self, message="Leaving"): self.fire(RAW("QUIT :%s" % message)) def command_join(self, channel, key=None): if key is None: self.fire(RAW("JOIN %s" % channel)) else: self.fire(RAW("JOIN %s %s" % (channel, key))) def command_part(self, channel, message="Leaving"): self.fire(RAW("PART %s :%s" % (channel, message))) def command_privmsg(self, target, message): self.fire(RAW("PRIVMSG %s :%s" % (target, message))) def command_notice(self, target, message): self.fire(RAW("NOTICE %s :%s" % (target, message))) def command_ctcp(self, target, type, message): self.fire(PRIVMSG(target, "%s %s" % (type, message))) def command_ctcpreply(self, target, type, message): self.fire(NOTICE(target, "%s %s" % (type, message))) def command_kick(self, channel, target, message=""): self.fire(RAW("KICK %s %s :%s" % (channel, target, message))) def command_topic(self, channel, topic): self.fire(RAW("TOPIC %s :%s" % (channel, topic))) def command_mode(self, modes, channel=None): if channel is None: self.fire(RAW("MODE :%s" % modes)) else: self.fire(RAW("MODE %s :%s" % (channel, modes))) def command_invite(self, target, channel): self.fire(RAW("INVITE %s %s" % (target, channel))) def command_names(self, channel=None): if channel: self.fire(RAW("NAMES %s" % channel)) else: self.fire(RAW("NAMES")) ### ### Event Processing ### def line(self, line): """Line Event Handler Process a line of text and generate the appropiate event. This must not be overridden by sub-classes, if it is, this must be explitetly called by the sub-class. Other Components may however listen to this event and process custom IRC events. """ tokens = line.split(" ") if tokens[0] == "PING": self.fire(Ping(strip(tokens[1]))) elif re.match("[0-9]+", tokens[1]): source = strip(tokens[0]) target = tokens[2] numeric = int(tokens[1]) if tokens[3].startswith(":"): arg = None message = strip(" ".join(tokens[3:])) else: arg = tokens[3] message = strip(" ".join(tokens[4:])) self.fire(Numeric(source, target, numeric, arg, message)) elif tokens[1] == "PRIVMSG": source = sourceSplit(strip(tokens[0])) target = tokens[2] message = strip(" ".join(tokens[3:])) if message and message[0] == "": tokens = strip(message, color=True).split(" ") type = tokens[0] message = " ".join(tokens[1:]) self.fire(Ctcp(source, target, type, message)) else: self.fire(Message(source, target, message)) elif tokens[1] == "NOTICE": source = sourceSplit(strip(tokens[0])) target = tokens[2] message = strip(" ".join(tokens[3:])) self.fire(Notice(source, target, message)) elif tokens[1] == "JOIN": source = sourceSplit(strip(tokens[0])) channel = strip(tokens[2]) self.fire(Join(source, channel)) elif tokens[1] == "PART": source = sourceSplit(strip(tokens[0])) channel = strip(tokens[2]) message = strip(" ".join(tokens[3:])) self.fire(Part(source, channel, message)) elif tokens[1] == "QUIT": source = sourceSplit(strip(tokens[0])) message = strip(" ".join(tokens[2:])) self.fire(Quit(source, message)) elif tokens[1] == "NICK": source = sourceSplit(strip(tokens[0])) newNick = strip(tokens[2]) self.fire(Nick(source, newNick)) elif tokens[1] == "MODE": source = sourceSplit(strip(tokens[0])) target = tokens[2] modes = strip(" ".join(tokens[3:])) self.fire(Mode(source, target, modes)) ### ### Default Events ### @handler("ping", filter=True) def _on_ping(self, event, server): """Ping Event This is a default event ro respond to Ping Events by sending out a Pong in response. Sub-classes may override this, but be sure to respond to Ping Events by either explitetly calling this method or sending your own Pong reponse. """ if isinstance(event, Ping): self.fire(PONG(server)) return True ### ### Errors and Numeric Replies ### RPL_WELCOME = 1 RPL_YOURHOST = 2 RPL_TRACELINK = 200 RPL_TRACECONNECTING = 201 RPL_TRACEHANDSHAKE = 202 RPL_TRACEUNKNOWN = 203 RPL_TRACEOPERATOR = 204 RPL_TRACEUSER = 205 RPL_TRACESERVER = 206 RPL_TRACENEWTYPE = 208 RPL_TRACELOG = 261 RPL_STATSLINKINFO = 211 RPL_STATSCOMMANDS = 212 RPL_STATSCLINE = 213 RPL_STATSNLINE = 214 RPL_STATSILINE = 215 RPL_STATSKLINE = 216 RPL_STATSYLINE = 218 RPL_ENDOFSTATS = 219 RPL_STATSLLINE = 241 RPL_STATSUPTIME = 242 RPL_STATSOLINE = 243 RPL_STATSHLINE = 244 RPL_UMODEIS = 221 RPL_LUSERCLIENT = 251 RPL_LUSEROP = 252 RPL_LUSERUNKNOWN = 253 RPL_LUSERCHANNELS = 254 RPL_LUSERME = 255 RPL_ADMINME = 256 RPL_ADMINLOC1 = 257 RPL_ADMINLOC2 = 258 RPL_ADMINEMAIL = 259 RPL_NONE = 300 RPL_USERHOST = 302 RPL_ISON = 303 RPL_AWAY = 301 RPL_UNAWAY = 305 RPL_NOWAWAY = 306 RPL_WHOISUSER = 311 RPL_WHOISSERVER = 312 RPL_WHOISOPERATOR = 313 RPL_WHOISIDLE = 317 RPL_ENDOFWHOIS = 318 RPL_WHOISCHANNELS = 319 RPL_WHOWASUSER = 314 RPL_ENDOFWHOWAS = 369 RPL_LIST = 322 RPL_LISTEND = 323 RPL_CHANNELMODEIS = 324 RPL_NOTOPIC = 331 RPL_TOPIC = 332 RPL_INVITING = 341 RPL_SUMMONING = 342 RPL_VERSION = 351 RPL_WHOREPLY = 352 RPL_ENDOFWHO = 315 RPL_NAMREPLY = 353 RPL_ENDOFNAMES = 366 RPL_LINKS = 364 RPL_ENDOFLINKS = 365 RPL_BANLIST = 367 RPL_ENDOFBANLIST = 368 RPL_INFO = 371 RPL_ENDOFINFO = 374 RPL_MOTDSTART = 375 RPL_MOTD = 372 RPL_ENDOFMOTD = 376 RPL_YOUREOPER = 381 RPL_REHASHING = 382 RPL_TIME = 391 RPL_USERSSTART = 392 RPL_USERS = 393 RPL_ENDOFUSERS = 394 RPL_NOUSERS = 395 ERR_NOSUCHNICK = 401 ERR_NOSUCHSERVER = 402 ERR_NOSUCHCHANNEL = 403 ERR_CANNOTSENDTOCHAN = 404 ERR_TOOMANYCHANNELS = 405 ERR_WASNOSUCHNICK = 406 ERR_TOOMANYTARGETS = 407 ERR_NOORIGIN = 409 ERR_NORECIPIENT = 411 ERR_NOTEXTTOSEND = 412 ERR_NOTOPLEVEL = 413 ERR_WILDTOPLEVEL = 414 ERR_UNKNOWNCOMMAND = 421 ERR_NOMOTD = 422 ERR_NOADMININFO = 423 ERR_FILEERROR = 424 ERR_NONICKNAMEGIVEN = 431 ERR_ERRONEUSNICKNAME = 432 ERR_NICKNAMEINUSE = 433 ERR_NICKCOLLISION = 436 ERR_NOTONCHANNEL = 442 ERR_USERONCHANNEL = 443 ERR_NOLOGIN = 444 ERR_SUMMONDISABLED = 445 ERR_USERSDISABLED = 446 ERR_NOTREGISTERED = 451 ERR_NEEDMOREPARAMS = 461 ERR_ALREADYREGISTRED = 462 ERR_PASSWDMISMATCH = 464 ERR_YOUREBANNEDCREEP = 465 ERR_KEYSET = 467 ERR_CHANNELISFULL = 471 ERR_UNKNOWNMODE = 472 ERR_INVITEONLYCHAN = 473 ERR_BANNEDFROMCHAN = 474 ERR_BADCHANNELKEY = 475 ERR_NOPRIVILEGES = 481 ERR_CHANOPRIVSNEEDED = 482 ERR_CANTKILLSERVER = 483 ERR_NOOPERHOST = 491 ERR_UMODEUNKNOWNFLAG = 501 ERR_USERSDONTMATCH = 502 circuits-2.1.0/circuits/net/protocols/http.py0000644000014400001440000000522712113343751021066 0ustar prologicusers from io import BytesIO from circuits.web.headers import parse_headers from circuits.core import handler, BaseComponent, Event class Request(Event): """Request Event""" class Response(Event): """Response Event""" class ResponseObject(object): def __init__(self, status, message, protocol=None): self.status = status self.message = message self.protocol = protocol self._headers = None self._body = BytesIO() def __repr__(self): return "" % ( self.status, self.headers["Content-Type"], len(self._body.getvalue()) ) @property def headers(self): return self._headers def read(self): return self._body.read() class HTTP(BaseComponent): channel = "web" def __init__(self, encoding="utf-8", channel=channel): super(HTTP, self).__init__(channel=channel) self._encoding = encoding self._header_head = None self._response = None self._buffer = BytesIO() @handler("read") def _on_client_read(self, data): if self._response is not None: self._response._body.write(data) cLen = int(self._response.headers.get("Content-Length", "0")) if cLen and self._response._body.tell() == cLen: self._response._body.seek(0) self.fire(Response(self._response)) self._response = None else: if self._header_head is not None: data = self._header_head + data self._header_head = None if data.find(b"\r\n\r\n") < 0: # Header not received completely yet self._header_head = data return statusline, data = data.split(b"\r\n", 1) statusline = statusline.strip().decode(self._encoding, "replace") protocol, status, message = statusline.split(" ", 2) status = int(status) protocol = tuple(map(int, protocol[5:].split("."))) response = ResponseObject(status, message, protocol) end_of_headers = data.find(b"\r\n\r\n") header_data = data[:end_of_headers].decode( self._encoding, "replace" ) headers = response._headers = parse_headers(header_data) response._body.write(data[(end_of_headers + 4):]) cLen = int(headers.get("Content-Length", "0")) if cLen and response._body.tell() < cLen: self._response = response return response._body.seek(0) self.fire(Response(response)) circuits-2.1.0/circuits/net/protocols/__init__.py0000644000014400001440000000043212113343751021637 0ustar prologicusers# Package: protocols # Date: 13th March 2009 # Author: James Mills, prologic at shortcircuit dot net dot au """Networking Protocols This package contains components that implement various networking protocols. """ from .line import LP from .irc import IRC # flake8: noqa circuits-2.1.0/circuits/web/0000755000014400001440000000000012113366740015475 5ustar prologicuserscircuits-2.1.0/circuits/web/wsgi.py0000644000014400001440000001406312113343751017021 0ustar prologicusers# Module: wsgi # Date: 6th November 2008 # Author: James Mills, prologic at shortcircuit dot net dot au """WSGI Components This module implements WSGI Components. """ try: from urllib.parse import unquote except ImportError: from urllib import unquote # NOQA from operator import itemgetter from traceback import format_tb from sys import exc_info as _exc_info from circuits.tools import tryimport from circuits.core import handler, BaseComponent StringIO = tryimport(("cStringIO", "StringIO", "io"), "StringIO") from . import wrappers from .http import HTTP from .events import Request from .headers import Headers from .errors import HTTPError from .dispatchers import Dispatcher def create_environ(errors, path, req): environ = {} env = environ.__setitem__ env("REQUEST_METHOD", req.method) env("SERVER_NAME", req.host.split(":", 1)[0]) env("SERVER_PORT", "%i" % (req.server.port or 0)) env("SERVER_PROTOCOL", "HTTP/%d.%d" % req.server_protocol) env("QUERY_STRING", req.qs) env("SCRIPT_NAME", req.script_name) env("CONTENT_TYPE", req.headers.get("Content-Type", "")) env("CONTENT_LENGTH", req.headers.get("Content-Length", "")) env("REMOTE_ADDR", req.remote.ip) env("REMOTE_PORT", "%i" % (req.remote.port or 0)) env("wsgi.version", (1, 0)) env("wsgi.input", req.body) env("wsgi.errors", errors) env("wsgi.multithread", False) env("wsgi.multiprocess", False) env("wsgi.run_once", False) env("wsgi.url_scheme", req.scheme) if req.path: req.script_name = req.path[:len(path)] req.path = req.path[len(path):] env("SCRIPT_NAME", req.script_name) env("PATH_INFO", req.path) for k, v in list(req.headers.items()): env("HTTP_%s" % k.upper().replace("-", "_"), v) return environ class Application(BaseComponent): channel = "web" headerNames = { "HTTP_CGI_AUTHORIZATION": "Authorization", "CONTENT_LENGTH": "Content-Length", "CONTENT_TYPE": "Content-Type", "REMOTE_HOST": "Remote-Host", "REMOTE_ADDR": "Remote-Addr", } def init(self): self._finished = False HTTP().register(self) Dispatcher().register(self) def translateHeaders(self, environ): for cgiName in environ: # We assume all incoming header keys are uppercase already. if cgiName in self.headerNames: yield self.headerNames[cgiName], environ[cgiName] elif cgiName[:5] == "HTTP_": # Hackish attempt at recovering original header names. translatedHeader = cgiName[5:].replace("_", "-") yield translatedHeader, environ[cgiName] def getRequestResponse(self, environ): env = environ.get headers = Headers(list(self.translateHeaders(environ))) protocol = tuple(map(int, env("SERVER_PROTOCOL")[5:].split("."))) request = wrappers.Request( None, env("REQUEST_METHOD"), env("wsgi.url_scheme"), env("PATH_INFO", ""), protocol, env("QUERY_STRING", "") ) request.server = None request.remote = wrappers.Host(env("REMOTE_ADDR"), env("REMTOE_PORT")) request.headers = headers request.script_name = env("SCRIPT_NAME") request.wsgi_environ = environ try: cl = int(headers.get("Content-Length", "0")) except: cl = 0 request.body.write(env("wsgi.input").read(cl)) request.body.seek(0) response = wrappers.Response(request) response.gzip = "gzip" in request.headers.get("Accept-Encoding", "") return request, response def __call__(self, environ, start_response, exc_info=None): self.request, self.response = self.getRequestResponse(environ) self.fire(Request(self.request, self.response)) self._finished = False while self or not self._finished: self.tick() self.response.prepare() body = self.response.body status = self.response.status headers = list(self.response.headers.items()) start_response(status, headers, exc_info) return body @handler("response", filter=True, channel="web") def response(self, response): self._finished = True return True class _Empty(str): def __bool__(self): return True __nonzero__ = __bool__ empty = _Empty() del _Empty class Gateway(BaseComponent): channel = "web" def init(self, apps): self.apps = apps self.errors = dict((k, StringIO()) for k in self.apps.keys()) @handler("request", filter=True, priority=0.2) def _on_request(self, event, request, response): if not self.apps: return parts = request.path.split("/") candidates = [] for i in range(len(parts)): k = "/".join(parts[:(i + 1)]) or "/" if k in self.apps: candidates.append((k, self.apps[k])) candidates = sorted(candidates, key=itemgetter(0), reverse=True) if not candidates: return path, app = candidates[0] buffer = StringIO() def start_response(status, headers, exc_info=None): response.code = int(status.split(" ", 1)[0]) for header in headers: response.headers.add_header(*header) return buffer.write errors = self.errors[path] environ = create_environ(errors, path, request) try: body = app(environ, start_response) if isinstance(body, list): body = "".join(body) if not body: if not buffer.tell(): return empty else: buffer.seek(0) return buffer else: return body except Exception as error: etype, evalue, etraceback = _exc_info() error = (etype, evalue, format_tb(etraceback)) return HTTPError(request, response, 500, error=error) circuits-2.1.0/circuits/web/websocket.py0000644000014400001440000001214712113343751020037 0ustar prologicusers""" .. codeauthor: mnl """ from circuits.web.headers import Headers from circuits.core.handlers import handler import os import random import base64 from circuits.web import client from circuits.net.protocols.websocket import WebSocketCodec try: from urllib.parse import urlparse except ImportError: from urlparse import urlparse from circuits.core.components import BaseComponent from circuits.web.client import NotConnected from circuits.net.sockets import TCPClient, Connect, Write, Close from circuits.net.protocols.http import HTTP from socket import error as SocketError from errno import ECONNRESET class WebSocketClient(BaseComponent): """ An RFC 6455 compliant WebSocket client component. Upon receiving a :class:`circuits.web.client.Connect` event, the component tries to establish the connection to the server in a two stage process. First, a :class:`circuits.net.sockets.Connect` event is sent to a child :class:`~.sockets.TCPClient`. When the TCP connection has been established, the HTTP request for opening the WebSocket is sent to the server. A failure in this setup process is signaled by a :class:`~.client.NotConnected` event. When the server accepts the request, the WebSocket connection is established and can be used very much like an ordinary socket by handling :class:`~.sockets.Read` events on and sending :class:`~.sockets.Write` events to the channel specified as the ``wschannel`` parameter of the constructor. Firing a :class:`~.sockets.Close` event on that channel closes the connection in an orderly fashion (i.e. as specified by the WebSocket protocol). """ channel = "wsclient" def __init__(self, url, channel=channel, wschannel="ws", headers={}): """ :param url: the URL to connect to. :param channel: the channel used by this component :param wschannel: the channel used for the actual WebSocket communication (read, write, close events) :param headers: additional headers to be passed with the WebSocket setup HTTP request """ super(WebSocketClient, self).__init__(channel=channel) self._url = url self._headers = headers self._response = None self._pending = 0 self._wschannel = wschannel self._transport = TCPClient(channel=self.channel).register(self) HTTP(channel=self.channel).register(self._transport) @handler("connect", priority=0.1, filter=True) def _on_connect(self, event, *args, **kwargs): if not isinstance(event, client.Connect): return p = urlparse(self._url) if not p.hostname: raise ValueError("URL must be absolute") self._host = p.hostname if p.scheme == "ws": self._secure = False self._port = p.port or 80 elif p.scheme == "wss": self._secure = True self._port = p.port or 443 else: self.fire(NotConnected()) return self._resource = p.path or "/" if p.query: self._resource += "?" + p.query self.fire(Connect(self._host, self._port, self._secure), self._transport) @handler("connected") def _on_connected(self, host, port): headers = Headers([(k, v) for k, v in self._headers.items()]) # Clients MUST include Host header in HTTP/1.1 requests (RFC 2616) if not "Host" in headers: headers["Host"] = self._host \ + (":" + str(self._port)) if self._port else "" headers["Upgrade"] = "websocket" headers["Connection"] = "Upgrade" try: sec_key = os.urandom(16) except NotImplementedError: sec_key = "".join([chr(random.randint(0,255)) for i in range(16)]) headers["Sec-WebSocket-Key"] = base64.b64encode(sec_key) headers["Sec-WebSocket-Version"] = "13" command = "GET %s HTTP/1.1" % self._resource message = "%s\r\n%s" % (command, headers) self._pending += 1 self.fire(Write(message.encode('utf-8')), self._transport) return True @handler("response") def _on_response(self, response): self._response = response self._pending -= 1 if response.headers.get("Connection") == "Close" \ or response.status != 101: self.fire(Close(), self._transport) self.fire(NotConnected()) WebSocketCodec(channel=self._wschannel).register(self) @handler("error", filter=True, priority=10) def _on_error(self, error, *args, **kwargs): # For HTTP 1.1 we leave the connection open. If the peer closes # it after some time and we have no pending request, that's OK. if isinstance(error, SocketError) and error.args[0] == ECONNRESET \ and self._pending == 0: return True def close(self): if self._transport != None: self._transport.close() @property def connected(self): return getattr(self._transport, "connected", False) \ if hasattr(self, "_transport") else False circuits-2.1.0/circuits/web/apps/0000755000014400001440000000000012113366740016440 5ustar prologicuserscircuits-2.1.0/circuits/web/apps/memorymonitor/0000755000014400001440000000000012113366740021360 5ustar prologicuserscircuits-2.1.0/circuits/web/apps/memorymonitor/htdocs/0000755000014400001440000000000012113366740022644 5ustar prologicuserscircuits-2.1.0/circuits/web/apps/memorymonitor/htdocs/graphs.html0000644000014400001440000000143212072034467025020 0ustar prologicusers Dowser: Types

          %(output)s
          circuits-2.1.0/circuits/web/apps/memorymonitor/htdocs/trace.html0000644000014400001440000000140012072034467024625 0ustar prologicusers Dowser: Trace

          %(typename)s %(objid)s

          %(output)s
          circuits-2.1.0/circuits/web/apps/memorymonitor/htdocs/main.css0000644000014400001440000000134012072034467024302 0ustar prologicusersbody { margin: 0; padding: 0; } #header { text-align: center; background-color: #CCCCCC; margin: 0; padding: 0.25em; } #header p { margin: 0; padding: 0.25em; } #header h1 a { text-decoration: none; } #header h1 a:visited { color: black; } h1 { font: 900 20pt Verdana, sans-serif; text-align: center; margin: 0; padding: 0.25em; } h2 { text-align: center; } .obj { border: 1px dashed #CCCCCC; padding: 0.5em; margin: 2px; font: 10pt Arial, sans-serif; vertical-align: middle; } .typename { font-weight: bold; } .refs { border: 1px solid #CCCCCC; padding: 0.25em; margin: 0; } circuits-2.1.0/circuits/web/apps/memorymonitor/htdocs/tree.html0000644000014400001440000000114412072034467024473 0ustar prologicusers Dowser: Tree

          %(typename)s %(objid)s

          %(output)s
          circuits-2.1.0/circuits/web/apps/memorymonitor/__init__.py0000644000014400001440000002533512113343751023476 0ustar prologicusersimport gc import os import cgi import sys import time import threading from types import FrameType, ModuleType import Image import ImageDraw from circuits import handler from circuits.web import Controller from circuits.tools import tryimport StringIO = tryimport(("cStringIO", "StringIO", "io"), "StringIO") import reftree docroot = os.path.abspath(os.path.join(os.path.dirname(__file__), "htdocs")) def get_repr(obj, limit=250): return cgi.escape(reftree.get_repr(obj, limit)) class _(object): pass dictproxy = type(_.__dict__) method_types = [ type(tuple.__le__), # 'wrapper_descriptor' type([1].__le__), # 'method-wrapper' type(sys.getcheckinterval), # 'builtin_function_or_method' type(cgi.FieldStorage.getfirst), # 'instancemethod' ] class MemoryMonitor(Controller): period = 5 maxhistory = 300 def __init__(self, *args, **kwargs): super(MemoryMonitor, self).__init__(*args, **kwargs) self.history = {} self.samples = 0 self.runthread = threading.Thread(target=self._start) self.runthread.start() def _render(self, name, **params): p = {'maincss': self.url("/main.css"), 'home': self.url("/"), } p.update(params) return open(os.path.join(docroot, name)).read() % p def _start(self): self._running = True while self._running: self._tick() time.sleep(self.period) def _tick(self): gc.collect() typecounts = {} for obj in gc.get_objects(): objtype = type(obj) if objtype in typecounts: typecounts[objtype] += 1 else: typecounts[objtype] = 1 for objtype, count in typecounts.iteritems(): typename = objtype.__module__ + "." + objtype.__name__ if typename not in self.history: self.history[typename] = [0] * self.samples self.history[typename].append(count) samples = self.samples + 1 # Add dummy entries for any types which no longer exist for typename, hist in self.history.iteritems(): diff = samples - len(hist) if diff > 0: hist.extend([0] * diff) # Truncate history to self.maxhistory if samples > self.maxhistory: for typename, hist in self.history.iteritems(): hist.pop(0) else: self.samples = samples @handler("stopped", channel="*") def stop(self, component): self._running = False def index(self, floor=0): rows = [] typenames = self.history.keys() typenames.sort() for typename in typenames: hist = self.history[typename] maxhist = max(hist) if maxhist > int(floor): row = ('
          %s
          ' '
          ' 'Min: %s Cur: %s Max: %s TRACE
          ' % (cgi.escape(typename), self.url("chart/%s" % typename), min(hist), hist[-1], maxhist, self.url("trace/%s" % typename), ) ) rows.append(row) return self._render("graphs.html", output="\n".join(rows)) def chart(self, typename): """Return a sparkline chart of the given type.""" data = self.history[typename] height = 20.0 scale = height / max(data) im = Image.new("RGB", (len(data), int(height)), 'white') draw = ImageDraw.Draw(im) draw.line([(i, int(height - (v * scale))) for i, v in enumerate(data)], fill="#009900") del draw f = StringIO() im.save(f, "PNG") result = f.getvalue() self.response.headers["Content-Type"] = "image/png" return result def trace(self, typename, objid=None): gc.collect() if objid is None: rows = self.trace_all(typename) else: rows = self.trace_one(typename, objid) return self._render( "trace.html", output="\n".join(rows), typename=cgi.escape(typename), objid=str(objid or '') ) def trace_all(self, typename): rows = [] for obj in gc.get_objects(): objtype = type(obj) if objtype.__module__ + "." + objtype.__name__ == typename: rows.append("

          %s

          " % ReferrerTree(obj).get_repr(obj)) if not rows: rows = ["

          The type you requested was not found.

          "] return rows def trace_one(self, typename, objid): rows = [] objid = int(objid) all_objs = gc.get_objects() for obj in all_objs: if id(obj) == objid: objtype = type(obj) if objtype.__module__ + "." + objtype.__name__ != typename: rows = ["

          The object you requested is no longer " "of the correct type.

          "] else: # Attributes rows.append('

          Attributes

          ') for k in dir(obj): v = getattr(obj, k) if type(v) not in method_types: rows.append('

          %s: %s

          ' % (k, get_repr(v))) del v rows.append('
          ') # Referrers rows.append( '

          Referrers (Parents)

          ' ) rows.append('

          Show the ' 'entire tree of reachable objects

          ' % self.url("/tree/%s/%s" % (typename, objid))) tree = ReferrerTree(obj) tree.ignore(all_objs) for depth, parentid, parentrepr in tree.walk(maxdepth=1): if parentid: rows.append("

          %s

          " % parentrepr) rows.append('
          ') # Referents rows.append( '

          Referents (Children)

          ' ) for child in gc.get_referents(obj): rows.append( "

          %s

          " % tree.get_repr(child) ) rows.append('
          ') break if not rows: rows = ["

          The object you requested was not found.

          "] return rows def tree(self, typename, objid): gc.collect() rows = [] objid = int(objid) all_objs = gc.get_objects() for obj in all_objs: if id(obj) == objid: objtype = type(obj) if objtype.__module__ + "." + objtype.__name__ != typename: rows = ["

          The object you requested is no longer " "of the correct type.

          "] else: rows.append('
          ') tree = ReferrerTree(obj) tree.ignore(all_objs) for depth, parentid, parentrepr in tree.walk( maxresults=1000): rows.append(parentrepr) rows.append('
          ') break if not rows: rows = ["

          The object you requested was not found.

          "] params = {'output': "\n".join(rows), 'typename': cgi.escape(typename), 'objid': str(objid), } return self._render("tree.html", **params) class ReferrerTree(reftree.Tree): ignore_modules = True def _gen(self, obj, depth=0): if self.maxdepth and depth >= self.maxdepth: yield depth, 0, "---- Max depth reached ----" raise StopIteration if isinstance(obj, ModuleType) and self.ignore_modules: raise StopIteration refs = gc.get_referrers(obj) refiter = iter(refs) self.ignore(refs, refiter) thisfile = sys._getframe().f_code.co_filename for ref in refiter: # Exclude all frames that are from this module or reftree. if (isinstance(ref, FrameType) and ref.f_code.co_filename in (thisfile, self.filename)): continue # Exclude all functions and classes from this module or reftree. mod = getattr(ref, "__module__", "") if "dowser" in mod or "reftree" in mod or mod == '__main__': continue # Exclude all parents in our ignore list. if id(ref) in self._ignore: continue # Yield the (depth, id, repr) of our object. yield depth, 0, '%s
          ' % (" " * depth) if id(ref) in self.seen: yield depth, id(ref), "see %s above" % id(ref) else: self.seen[id(ref)] = None yield depth, id(ref), self.get_repr(ref, obj) for parent in self._gen(ref, depth + 1): yield parent yield depth, 0, '%s
          ' % (" " * depth) def get_repr(self, obj, referent=None): """Return an HTML tree block describing the given object.""" objtype = type(obj) typename = objtype.__module__ + "." + objtype.__name__ prettytype = typename.replace("__builtin__.", "") name = getattr(obj, "__name__", "") if name: prettytype = "%s %r" % (prettytype, name) key = "" if referent: key = self.get_refkey(obj, referent) return ('%s ' '%s%s
          ' '%s' % (self.url("/trace/%s/%s" % (typename, id(obj))), id(obj), prettytype, key, get_repr(obj, 100)) ) def get_refkey(self, obj, referent): """ Return the dict key or attribute name of obj which refers to referent. """ if isinstance(obj, dict): for k, v in obj.iteritems(): if v is referent: return " (via its %r key)" % k for k in dir(obj) + ['__dict__']: if getattr(obj, k, None) is referent: return " (via its %r attribute)" % k return "" __all__ = ("MemoryMonitor",) circuits-2.1.0/circuits/web/apps/memorymonitor/reftree.py0000644000014400001440000001312412072034467023371 0ustar prologicusersimport gc import sys from types import FrameType class Tree: def __init__(self, obj): self.obj = obj self.filename = sys._getframe().f_code.co_filename self._ignore = {} def ignore(self, *objects): for obj in objects: self._ignore[id(obj)] = None def ignore_caller(self): f = sys._getframe() # = this function cur = f.f_back # = the function that called us (probably 'walk') self.ignore(cur, cur.f_builtins, cur.f_locals, cur.f_globals) caller = f.f_back # = the 'real' caller self.ignore(caller, caller.f_builtins, caller.f_locals, caller.f_globals) def walk(self, maxresults=100, maxdepth=None): """Walk the object tree, ignoring duplicates and circular refs.""" self.seen = {} self.ignore(self, self.__dict__, self.obj, self.seen, self._ignore) # Ignore the calling frame, its builtins, globals and locals self.ignore_caller() self.maxdepth = maxdepth count = 0 for result in self._gen(self.obj): yield result count += 1 if maxresults and count >= maxresults: yield 0, 0, "==== Max results reached ====" raise StopIteration def print_tree(self, maxresults=100, maxdepth=None): """Walk the object tree, pretty-printing each branch.""" self.ignore_caller() for depth, refid, rep in self.walk(maxresults, maxdepth): print ("%9d" % refid), (" " * depth * 2), rep def _repr_container(obj): return "%s of len %s: %r" % (type(obj).__name__, len(obj), obj) repr_dict = _repr_container repr_set = _repr_container repr_list = _repr_container repr_tuple = _repr_container def repr_str(obj): return "%s of len %s: %r" % (type(obj).__name__, len(obj), obj) repr_unicode = repr_str def repr_frame(obj): return "frame from %s line %s" % (obj.f_code.co_filename, obj.f_lineno) def get_repr(obj, limit=250): typename = getattr(type(obj), "__name__", None) handler = globals().get("repr_%s" % typename, repr) try: result = handler(obj) except: result = "unrepresentable object: %r" % sys.exc_info()[1] if len(result) > limit: result = result[:limit] + "..." return result class ReferentTree(Tree): def _gen(self, obj, depth=0): if self.maxdepth and depth >= self.maxdepth: yield depth, 0, "---- Max depth reached ----" raise StopIteration for ref in gc.get_referents(obj): if id(ref) in self._ignore: continue elif id(ref) in self.seen: yield depth, id(ref), "!" + get_repr(ref) continue else: self.seen[id(ref)] = None yield depth, id(ref), get_repr(ref) for child in self._gen(ref, depth + 1): yield child class ReferrerTree(Tree): def _gen(self, obj, depth=0): if self.maxdepth and depth >= self.maxdepth: yield depth, 0, "---- Max depth reached ----" raise StopIteration refs = gc.get_referrers(obj) refiter = iter(refs) self.ignore(refs, refiter) for ref in refiter: # Exclude all frames that are from this module. if isinstance(ref, FrameType): if ref.f_code.co_filename == self.filename: continue if id(ref) in self._ignore: continue elif id(ref) in self.seen: yield depth, id(ref), "!" + get_repr(ref) continue else: self.seen[id(ref)] = None yield depth, id(ref), get_repr(ref) for parent in self._gen(ref, depth + 1): yield parent class CircularReferents(Tree): def walk(self, maxresults=100, maxdepth=None): """Walk the object tree, showing circular referents.""" self.stops = 0 self.seen = {} self.ignore(self, self.__dict__, self.seen, self._ignore) # Ignore the calling frame, its builtins, globals and locals self.ignore_caller() self.maxdepth = maxdepth count = 0 for result in self._gen(self.obj): yield result count += 1 if maxresults and count >= maxresults: yield 0, 0, "==== Max results reached ====" raise StopIteration def _gen(self, obj, depth=0, trail=None): if self.maxdepth and depth >= self.maxdepth: self.stops += 1 raise StopIteration if trail is None: trail = [] for ref in gc.get_referents(obj): if id(ref) in self._ignore: continue elif id(ref) in self.seen: continue else: self.seen[id(ref)] = None refrepr = get_repr(ref) if id(ref) == id(self.obj): yield trail + [refrepr,] for child in self._gen(ref, depth + 1, trail + [refrepr,]): yield child def print_tree(self, maxresults=100, maxdepth=None): """Walk the object tree, pretty-printing each branch.""" self.ignore_caller() for trail in self.walk(maxresults, maxdepth): print trail if self.stops: print "%s paths stopped because max depth reached" % self.stops def count_objects(): d = {} for obj in gc.get_objects(): objtype = type(obj) d[objtype] = d.get(objtype, 0) + 1 d = [(v, k) for k, v in d.iteritems()] d.sort() return d circuits-2.1.0/circuits/web/apps/webconsole/0000755000014400001440000000000012113366740020600 5ustar prologicuserscircuits-2.1.0/circuits/web/apps/webconsole/htdocs/0000755000014400001440000000000012113366740022064 5ustar prologicuserscircuits-2.1.0/circuits/web/apps/webconsole/htdocs/index.html0000644000014400001440000003073012072034467024066 0ustar prologicusers circuits.web Terminal

          circuits.web Terminal

          >>>
          circuits-2.1.0/circuits/web/apps/webconsole/__init__.py0000644000014400001440000001156712113343751022720 0ustar prologicusersimport os import re import sys import codeop import inspect import traceback from circuits import handler from circuits.web import Controller from circuits.tools import tryimport StringIO = tryimport(("cStringIO", "StringIO", "io"), "StringIO") docroot = os.path.abspath(os.path.join(os.path.dirname(__file__), "htdocs")) class HTTPREPL(object): def __init__(self, locals=None): super(HTTPREPL, self).__init__() self.locals = {} if locals: self.locals.update(locals) self.buffer = [] def push(self, line): """Push 'line' and return exec results (None if more input needed).""" if line == "help": return "Type help(object) for help about object." if line == "help()": return "You cannot call help() without an argument." self.buffer.append(line) source = "\n".join(self.buffer) try: code = codeop.compile_command(source, "", 'single') except (OverflowError, SyntaxError, ValueError): self.buffer = [] return traceback.format_exc() if code is None: # More lines needed. return None self.buffer = [] return self.execute(code) def execute(self, code): """ Execute the given code in self.locals and return any stdout/sterr. """ out = StringIO() oldout = sys.stdout olderr = sys.stderr sys.stdout = sys.stderr = out try: try: exec code in self.locals except: result = traceback.format_exc() else: result = out.getvalue() finally: sys.stdout = oldout sys.stderr = olderr out.close() return result def dir(self, line): """Examine a partial line and provide attr list of final expr.""" line = re.split(r"\s", line)[-1].strip() # Support lines like "thing.attr" as "thing.", because the browser # may not finish calculating the partial line until after the user # has clicked on a few more keys. line = ".".join(line.split(".")[:-1]) try: result = eval("dir(%s)" % line, {}, self.locals) except: return "" return result def doc(self, line): """Examine a partial line and provide sig+doc of final expr.""" line = re.split(r"\s", line)[-1].strip() # Support lines like "func(text" as "func(", because the browser # may not finish calculating the partial line until after the user # has clicked on a few more keys. line = "(".join(line.split("(")[:-1]) try: result = eval(line, {}, self.locals) try: if isinstance(result, type): func = result.__init__ else: func = result args, varargs, varkw, defaults = inspect.getargspec(func) except TypeError: if callable(result): doc = getattr(result, "__doc__", "") or "" return "%s\n\n%s" % (line, doc) return None except: return None if args and args[0] == 'self': args.pop(0) missing = object() defaults = defaults or [] defaults = ([missing] * (len(args) - len(defaults))) + list(defaults) arglist = [] for a, d in zip(args, defaults): if d is missing: arglist.append(a) else: arglist.append("%s=%s" % (a, d)) if varargs: arglist.append("*%s" % varargs) if varkw: arglist.append("**%s" % varkw) doc = getattr(result, "__doc__", "") or "" return "%s(%s)\n%s" % (line, ", ".join(arglist), doc) class WebConsole(Controller): @handler("started", channel="*") def _on_started(self, component): self.repl = HTTPREPL(locals={"root": self.root}) def index(self): """Return an HTTP-based Read-Eval-Print-Loop terminal.""" return open(os.path.join(docroot, "index.html")).read() def push(self, line): """Push 'line' and return exec results as a bare response.""" result = self.repl.push(line) if result is None: # More input lines needed. self.response.code = 204 return result def dir(self, line): """Push 'line' and return result of eval on the final expr.""" result = self.repl.dir(line) if not result: self.response.code = 204 return return repr(result) def doc(self, line): """Push 'line' and return result of getargspec on the final expr.""" result = self.repl.doc(line) if not result: self.response.code = 204 return result __all__ = ("WebConsole",) circuits-2.1.0/circuits/web/apps/__init__.py0000644000014400001440000000071412113343751020550 0ustar prologicusers# Package: apps # Date: 3rd February 2011 # Author: James Mills, prologic at shortcircuit dot net dot au """Apps This package contains self-contained small packaged apps that come shipped with circuits.web that can be used within a circuits.web application. """ from circuits.web.apps.webconsole import WebConsole from circuits.web.apps.memorymonitor import MemoryMonitor __all__ = ( "WebConsole", "MemoryMonitor", ) # flake8: noqa circuits-2.1.0/circuits/web/exceptions.py0000644000014400001440000002034512113343751020231 0ustar prologicusers# Module: exceptions # Date: 10th July 2010 # Author: James Mills, prologic at shortcircuit dot net dot au """Exceptions This module implements a set of standard HTTP Errors as Python Exceptions. Note: This code is mostly borrowed from werkzeug and adapted for circuits.web """ from inspect import isclass from .constants import HTTP_STATUS_CODES class HTTPException(Exception): """ Baseclass for all HTTP exceptions. This exception can be called by WSGI applications to render a default error page or you can catch the subclasses of it independently and render nicer error messages. """ code = None traceback = True description = None def __init__(self, description=None, traceback=None): super(HTTPException, self).__init__("%d %s" % (self.code, self.name)) if description is not None: self.description = description if traceback is not None: self.traceback = traceback @property def name(self): """The status name.""" return HTTP_STATUS_CODES[self.code] def __repr__(self): return '<%s \'%s\'>' % (self.__class__.__name__, self) class BadRequest(HTTPException): """*400* `Bad Request` Raise if the browser sends something to the application the application or server cannot handle. """ code = 400 description = ( '

          The browser (or proxy) sent a request that this server could ' 'not understand.

          ' ) class UnicodeError(HTTPException): """ raised by the request functions if they were unable to decode the incoming data properly. """ class Unauthorized(HTTPException): """*401* `Unauthorized` Raise if the user is not authorized. Also used if you want to use HTTP basic auth. """ code = 401 description = ( '

          The server could not verify that you are authorized to access ' 'the URL requested. You either supplied the wrong credentials (e.g. ' 'a bad password), or your browser doesn\'t understand how to supply ' 'the credentials required.

          In case you are allowed to request ' 'the document, please check your user-id and password and try ' 'again.

          ' ) class Forbidden(HTTPException): """*403* `Forbidden` Raise if the user doesn't have the permission for the requested resource but was authenticated. """ code = 403 description = ( '

          You don\'t have the permission to access the requested resource. ' 'It is either read-protected or not readable by the server.

          ' ) class NotFound(HTTPException): """*404* `Not Found` Raise if a resource does not exist and never existed. """ code = 404 description = ( '

          The requested URL was not found on the server.

          ' '

          If you entered the URL manually please check your spelling and ' 'try again.

          ' ) class MethodNotAllowed(HTTPException): """*405* `Method Not Allowed` Raise if the server used a method the resource does not handle. For example `POST` if the resource is view only. Especially useful for REST. The first argument for this exception should be a list of allowed methods. Strictly speaking the response would be invalid if you don't provide valid methods in the header which you can do with that list. """ code = 405 def __init__(self, method, description=None): HTTPException.__init__(self, description) if description is None: self.description = ( '

          The method %s is not allowed ' 'for the requested URL.

          ' ) % method class NotAcceptable(HTTPException): """*406* `Not Acceptable` Raise if the server can't return any content conforming to the `Accept` headers of the client. """ code = 406 description = ( '

          The resource identified by the request is only capable of ' 'generating response entities which have content characteristics ' 'not acceptable according to the accept headers sent in the ' 'request.

          ' ) class RequestTimeout(HTTPException): """*408* `Request Timeout` Raise to signalize a timeout. """ code = 408 description = ( '

          The server closed the network connection because the browser ' 'didn\'t finish the request within the specified time.

          ' ) class Gone(HTTPException): """*410* `Gone` Raise if a resource existed previously and went away without new location. """ code = 410 description = ( '

          The requested URL is no longer available on this server and ' 'there is no forwarding address.

          If you followed a link ' 'from a foreign page, please contact the author of this page.' ) class LengthRequired(HTTPException): """*411* `Length Required` Raise if the browser submitted data but no ``Content-Length`` header which is required for the kind of processing the server does. """ code = 411 description = ( '

          A request with this method requires a valid Content-' 'Length header.

          ' ) class PreconditionFailed(HTTPException): """*412* `Precondition Failed` Status code used in combination with ``If-Match``, ``If-None-Match``, or ``If-Unmodified-Since``. """ code = 412 description = ( '

          The precondition on the request for the URL failed positive ' 'evaluation.

          ' ) class RequestEntityTooLarge(HTTPException): """*413* `Request Entity Too Large` The status code one should return if the data submitted exceeded a given limit. """ code = 413 description = ( '

          The data value transmitted exceeds the capacity limit.

          ' ) class RequestURITooLarge(HTTPException): """*414* `Request URI Too Large` Like *413* but for too long URLs. """ code = 414 description = ( '

          The length of the requested URL exceeds the capacity limit ' 'for this server. The request cannot be processed.

          ' ) class UnsupportedMediaType(HTTPException): """*415* `Unsupported Media Type` The status code returned if the server is unable to handle the media type the client transmitted. """ code = 415 description = ( '

          The server does not support the media type transmitted in ' 'the request.

          ' ) class InternalServerError(HTTPException): """*500* `Internal Server Error` Raise if an internal server error occurred. This is a good fallback if an unknown error occurred in the dispatcher. """ code = 500 description = ( '

          The server encountered an internal error and was unable to ' 'complete your request. Either the server is overloaded or there ' 'is an error in the application.

          ' ) class NotImplemented(HTTPException): """*501* `Not Implemented` Raise if the application does not support the action requested by the browser. """ code = 501 description = ( '

          The server does not support the action requested by the ' 'browser.

          ' ) class BadGateway(HTTPException): """*502* `Bad Gateway` If you do proxying in your application you should return this status code if you received an invalid response from the upstream server it accessed in attempting to fulfill the request. """ code = 502 description = ( '

          The proxy server received an invalid response from an upstream ' 'server.

          ' ) class ServiceUnavailable(HTTPException): """*503* `Service Unavailable` Status code you should return if a service is temporarily unavailable. """ code = 503 description = ( '

          The server is temporarily unable to service your request due to ' 'maintenance downtime or capacity problems. Please try again ' 'later.

          ' ) class Redirect(HTTPException): code = 303 def __init__(self, urls, status=None): super(Redirect, self).__init__() if isinstance(urls, str): self.urls = [urls] else: self.urls = urls self.status = status __all__ = [ x[0] for x in list(globals().items()) if isclass(x[1]) and issubclass(x[1], HTTPException) ] circuits-2.1.0/circuits/web/_httpauth.py0000755000014400001440000003201512113343751020050 0ustar prologicusers""" httpauth modules defines functions to implement HTTP Digest Authentication (RFC 2617). This has full compliance with 'Digest' and 'Basic' authentication methods. In 'Digest' it supports both MD5 and MD5-sess algorithms. Usage: First use 'doAuth' to request the client authentication for a certain resource. You should send an httplib.UNAUTHORIZED response to the client so he knows he has to authenticate itself. Then use 'parseAuthorization' to retrieve the 'auth_map' used in 'checkResponse'. To use 'checkResponse' you must have already verified the password associated with the 'username' key in 'auth_map' dict. Then you use the 'checkResponse' function to verify if the password matches the one sent by the client. SUPPORTED_ALGORITHM - list of supported 'Digest' algorithms SUPPORTED_QOP - list of supported 'Digest' 'qop'. """ __version__ = 1, 0, 1 __author__ = "Tiago Cogumbreiro " __credits__ = """ Peter van Kampen for its recipe which implement most of Digest authentication: http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/302378 """ __license__ = """ Copyright (c) 2005, Tiago Cogumbreiro All rights reserved. Redistribution and use in source and binary forms, with or without modification are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Sylvain Hellegouarch nor the names of his contributor may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. """ __all__ = ("digestAuth", "basicAuth", "doAuth", "checkResponse", "parseAuthorization", "SUPPORTED_ALGORITHM", "md5SessionKey", "calculateNonce", "SUPPORTED_QOP") ############################################################################### import time try: from base64 import decodebytes as base64_decodebytes except ImportError: from base64 import b64decode as base64_decodebytes # NOQA try: from urllib.request import parse_http_list, parse_keqv_list except ImportError: from urllib2 import parse_http_list, parse_keqv_list # NOQA from hashlib import md5 MD5 = "MD5" MD5_SESS = "MD5-sess" AUTH = "auth" AUTH_INT = "auth-int" SUPPORTED_ALGORITHM = (MD5, MD5_SESS) SUPPORTED_QOP = (AUTH, AUTH_INT) ############################################################################### # doAuth # DIGEST_AUTH_ENCODERS = { MD5: lambda val: md5(val).hexdigest(), MD5_SESS: lambda val: md5(val).hexdigest(), # SHA: lambda val: sha.new (val).hexdigest (), } def calculateNonce(realm, algorithm=MD5): """This is an auxaliary function that calculates 'nonce' value. It is used to handle sessions.""" global SUPPORTED_ALGORITHM, DIGEST_AUTH_ENCODERS assert algorithm in SUPPORTED_ALGORITHM try: encoder = DIGEST_AUTH_ENCODERS[algorithm] except KeyError: raise NotImplementedError( "The chosen algorithm (%s) does not have " "an implementation yet" % algorithm ) s = "%d:%s" % (time.time(), realm) return encoder(s.encode("utf-8")) def digestAuth(realm, algorithm=MD5, nonce=None, qop=AUTH): """Challenges the client for a Digest authentication.""" global SUPPORTED_ALGORITHM, DIGEST_AUTH_ENCODERS, SUPPORTED_QOP assert algorithm in SUPPORTED_ALGORITHM assert qop in SUPPORTED_QOP if nonce is None: nonce = calculateNonce(realm, algorithm) return 'Digest realm="%s", nonce="%s", algorithm="%s", qop="%s"' % ( realm, nonce, algorithm, qop ) def basicAuth(realm): """Challengenes the client for a Basic authentication.""" assert '"' not in realm, "Realms cannot contain the \" (quote) character." return 'Basic realm="%s"' % realm def doAuth(realm): """'doAuth' function returns the challenge string b giving priority over Digest and fallback to Basic authentication when the browser doesn't support the first one. This should be set in the HTTP header under the key 'WWW-Authenticate'.""" return digestAuth(realm) + " " + basicAuth(realm) ############################################################################### # Parse authorization parameters # def _parseDigestAuthorization(auth_params): # Convert the auth params to a dict items = parse_http_list(auth_params) params = parse_keqv_list(items) # Now validate the params # Check for required parameters required = ["username", "realm", "nonce", "uri", "response"] for k in required: if k not in params: return None # If qop is sent then cnonce and nc MUST be present if "qop" in params and not ("cnonce" in params and "nc" in params): return None # If qop is not sent, neither cnonce nor nc can be present if ("cnonce" in params or "nc" in params) and "qop" not in params: return None return params def _parseBasicAuthorization(auth_params): auth_params = auth_params.encode("utf-8") username, password = base64_decodebytes(auth_params).split(b":", 1) username = username.decode("utf-8") password = password.decode("utf-8") return {"username": username, "password": password} AUTH_SCHEMES = { "basic": _parseBasicAuthorization, "digest": _parseDigestAuthorization, } def parseAuthorization(credentials): """parseAuthorization will convert the value of the 'Authorization' key in the HTTP header to a map itself. If the parsing fails 'None' is returned. """ global AUTH_SCHEMES auth_scheme, auth_params = credentials.split(" ", 1) auth_scheme = auth_scheme.lower() parser = AUTH_SCHEMES[auth_scheme] params = parser(auth_params) if params is None: return assert "auth_scheme" not in params params["auth_scheme"] = auth_scheme return params ############################################################################### # Check provided response for a valid password # def md5SessionKey(params, password): """ If the "algorithm" directive's value is "MD5-sess", then A1 [the session key] is calculated only once - on the first request by the client following receipt of a WWW-Authenticate challenge from the server. This creates a 'session key' for the authentication of subsequent requests and responses which is different for each "authentication session", thus limiting the amount of material hashed with any one key. Because the server need only use the hash of the user credentials in order to create the A1 value, this construction could be used in conjunction with a third party authentication service so that the web server would not need the actual password value. The specification of such a protocol is beyond the scope of this specification. """ keys = ("username", "realm", "nonce", "cnonce") params_copy = {} for key in keys: params_copy[key] = params[key] params_copy["algorithm"] = MD5_SESS return _A1(params_copy, password) def _A1(params, password): algorithm = params.get("algorithm", MD5) H = DIGEST_AUTH_ENCODERS[algorithm] if algorithm == MD5: # If the "algorithm" directive's value is "MD5" or is # unspecified, then A1 is: # A1 = unq(username-value) ":" unq(realm-value) ":" passwd return "%s:%s:%s" % (params["username"], params["realm"], password) elif algorithm == MD5_SESS: # This is A1 if qop is set # A1 = H( unq(username-value) ":" unq(realm-value) ":" passwd ) # ":" unq(nonce-value) ":" unq(cnonce-value) s = "%s:%s:%s" % (params["username"], params["realm"], password) h_a1 = H(s.encode("utf-8")) return "%s:%s:%s" % (h_a1, params["nonce"], params["cnonce"]) def _A2(params, method, kwargs): # If the "qop" directive's value is "auth" or is unspecified, then A2 is: # A2 = Method ":" digest-uri-value qop = params.get("qop", "auth") if qop == "auth": return method + ":" + params["uri"] elif qop == "auth-int": # If the "qop" value is "auth-int", then A2 is: # A2 = Method ":" digest-uri-value ":" H(entity-body) entity_body = kwargs.get("entity_body", "") H = kwargs["H"] return "%s:%s:%s" % ( method, params["uri"], H(entity_body) ) else: raise NotImplementedError("The 'qop' method is unknown: %s" % qop) def _computeDigestResponse(auth_map, password, method="GET", A1=None, **kwargs): """ Generates a response respecting the algorithm defined in RFC 2617 """ params = auth_map algorithm = params.get("algorithm", MD5) H = DIGEST_AUTH_ENCODERS[algorithm] def KD(secret, data): s = secret + ":" + data return H(s.encode("utf-8")) qop = params.get("qop", None) s = _A2(params, method, kwargs) H_A2 = H(s.encode("utf-8")) if algorithm == MD5_SESS and A1 is not None: H_A1 = H(A1.encode("utf-8")) else: s = _A1(params, password) H_A1 = H(s.encode("utf-8")) if qop in ("auth", "auth-int"): # If the "qop" value is "auth" or "auth-int": # request-digest = <"> < KD ( H(A1), unq(nonce-value) # ":" nc-value # ":" unq(cnonce-value) # ":" unq(qop-value) # ":" H(A2) # ) <"> request = "%s:%s:%s:%s:%s" % ( params["nonce"], params["nc"], params["cnonce"], params["qop"], H_A2, ) elif qop is None: # If the "qop" directive is not present (this construction is # for compatibility with RFC 2069): # request-digest = # <"> < KD ( H(A1), unq(nonce-value) ":" H(A2) ) > <"> request = "%s:%s" % (params["nonce"], H_A2) return KD(H_A1, request) def _checkDigestResponse(auth_map, password, method="GET", A1=None, **kwargs): """This function is used to verify the response given by the client when he tries to authenticate. Optional arguments: entity_body - when 'qop' is set to 'auth-int' you MUST provide the raw data you are going to send to the client (usually the HTML page. request_uri - the uri from the request line compared with the 'uri' directive of the authorization map. They must represent the same resource (unused at this time). """ if auth_map['realm'] != kwargs.get('realm', None): return False response = _computeDigestResponse(auth_map, password, method, A1, **kwargs) return response == auth_map["response"] def _checkBasicResponse(auth_map, password, method='GET', encrypt=None, **kwargs): # Note that the Basic response doesn't provide the realm value so we cannot # test it try: return encrypt(auth_map["password"], auth_map["username"]) == password except TypeError: return encrypt(auth_map["password"]) == password AUTH_RESPONSES = { "basic": _checkBasicResponse, "digest": _checkDigestResponse, } def checkResponse(auth_map, password, method="GET", encrypt=None, **kwargs): """'checkResponse' compares the auth_map with the password and optionally other arguments that each implementation might need. If the response is of type 'Basic' then the function has the following signature: checkBasicResponse (auth_map, password) -> bool If the response is of type 'Digest' then the function has the following signature: checkDigestResponse (auth_map, password, method = 'GET', A1 = None) -> bool The 'A1' argument is only used in MD5_SESS algorithm based responses. Check md5SessionKey() for more info. """ global AUTH_RESPONSES checker = AUTH_RESPONSES[auth_map["auth_scheme"]] return checker( auth_map, password, method=method, encrypt=encrypt, **kwargs ) circuits-2.1.0/circuits/web/main.py0000755000014400001440000001072412113343751016777 0ustar prologicusers#!/usr/bin/env python # -*- coding: utf-8 -*- """Main circutis.web Web Server and Testing Tool. """ import os from optparse import OptionParser from wsgiref.validate import validator from wsgiref.simple_server import make_server try: import hotshot import hotshot.stats except ImportError: hostshot = None try: import psyco except: psyco = None # NOQA from circuits.core.pollers import Select from circuits.tools import inspect, graph from circuits import Component, Manager, Debugger from circuits import __version__ as systemVersion from circuits.web import BaseServer, Server, Controller, Static, wsgi try: from circuits.core.pollers import Poll except ImportError: Poll = None # NOQA try: from circuits.core.pollers import EPoll except ImportError: EPoll = None # NOQA USAGE = "%prog [options] [docroot]" VERSION = "%prog v" + systemVersion def parse_options(): parser = OptionParser(usage=USAGE, version=VERSION) parser.add_option( "-b", "--bind", action="store", type="string", default="0.0.0.0:8000", dest="bind", help="Bind to address:[port]" ) if psyco is not None: parser.add_option( "-j", "--jit", action="store_true", default=False, dest="jit", help="Use python HIT (psyco)" ) parser.add_option( "-m", "--multiprocessing", action="store", type="int", default=0, dest="mp", help="Specify no. of processes to start (multiprocessing)" ) parser.add_option( "-t", "--type", action="store", type="string", default="select", dest="type", help="Specify type of poller to use" ) parser.add_option( "-s", "--server", action="store", type="string", default="server", dest="server", help="Specify server to use" ) parser.add_option( "-p", "--profile", action="store_true", default=False, dest="profile", help="Enable execution profiling support" ) parser.add_option( "-d", "--debug", action="store_true", default=False, dest="debug", help="Enable debug mode" ) parser.add_option( "-v", "--validate", action="store_true", default=False, dest="validate", help="Enable WSGI validation mode" ) opts, args = parser.parse_args() return opts, args class HelloWorld(Component): channel = "web" def request(self, request, response): return "Hello World!" class Root(Controller): def hello(self): return "Hello World!" def main(): opts, args = parse_options() if psyco and opts.jit: psyco.full() if ":" in opts.bind: address, port = opts.bind.split(":") port = int(port) else: address, port = opts.bind, 8000 bind = (address, port) if opts.validate: application = (wsgi.Application() + Root()) app = validator(application) httpd = make_server(address, port, app) httpd.serve_forever() raise SystemExit(0) manager = Manager() if opts.debug: manager += Debugger() poller = opts.type.lower() if poller == "poll": if Poll is None: print("No poll support available - defaulting to Select...") Poller = Select else: Poller = Poll elif poller == "epoll": if EPoll is None: print("No epoll support available - defaulting to Select...") Poller = Select else: Poller = EPoll else: Poller = Select Poller().register(manager) if opts.server.lower() == "base": BaseServer(bind).register(manager) HelloWorld().register(manager) else: Server(bind).register(manager) Root().register(manager) docroot = os.getcwd() if not args else args[0] Static(docroot=docroot, dirlisting=True).register(manager) if opts.profile: if hotshot: profiler = hotshot.Profile(".profile") profiler.start() if opts.debug: print(graph(manager, name="circuits.web")) print() print(inspect(manager)) for i in range(opts.mp): manager.start(process=True) manager.run() if opts.profile and hotshot: profiler.stop() profiler.close() stats = hotshot.stats.load(".profile") stats.strip_dirs() stats.sort_stats("time", "calls") stats.print_stats(20) if __name__ == "__main__": main() circuits-2.1.0/circuits/web/events.py0000644000014400001440000000204612072034467017357 0ustar prologicusers# Module: events # Date: 3rd February 2009 # Author: James Mills, prologic at shortcircuit dot net dot au from circuits.core.events import LiteralEvent """Events This module implements the necessary Events needed. """ from circuits import Event class WebEvent(Event): """ WebEvents have both their ``success`` and ``failure`` attributes set to True. So event processing generates the derived events ``...Success`` or ``...Failure`` events. """ success = True failure = True class Request(WebEvent): """Request(WebEvent) -> Request WebEvent args: request, response """ @classmethod def create(cls, name, *args, **kwargs): """ All classes derived dynamically from Request are LiteralEvents. """ return LiteralEvent.create(cls, name, *args, **kwargs) class Response(WebEvent): """Response(WebEvent) -> Response WebEvent args: request, response """ class Stream(WebEvent): """Stream(WebEvent) -> Stream WebEvent args: request, response """ circuits-2.1.0/circuits/web/constants.py0000644000014400001440000000462712113343751020071 0ustar prologicusers# Module: constants # Date: 4th February 2009 # Author: James Mills, prologic at shortcircuit dot net dot au """Global Constants This module implements required shared global constants. """ from circuits import __version__ SERVER_PROTOCOL = (1, 1) SERVER_VERSION = "circuits/%s" % __version__ SERVER_URL = "http://bitbucket.org/prologic/circuits/" DEFAULT_ERROR_MESSAGE = """\ %(code)d %(name)s

          %(name)s

          %(description)s 
          %(traceback)s
          Powered by %(version)s
          """ HTTP_STATUS_CODES = { 100: "Continue", 101: "Switching Protocols", 102: "Processing", 200: "OK", 201: "Created", 202: "Accepted", 203: "Non Authoritative Information", 204: "No Content", 205: "Reset Content", 206: "Partial Content", 207: "Multi Status", 226: "IM Used", 300: "Multiple Choices", 301: "Moved Permanently", 302: "Found", 303: "See Other", 304: "Not Modified", 305: "Use Proxy", 307: "Temporary Redirect", 400: "Bad Request", 401: "Unauthorized", 402: "Payment Required", 403: "Forbidden", 404: "Not Found", 405: "Method Not Allowed", 406: "Not Acceptable", 407: "Proxy Authentication Required", 408: "Request Timeout", 409: "Conflict", 410: "Gone", 411: "Length Required", 412: "Precondition Failed", 413: "Request Entity Too Large", 414: "Request URI Too Long", 415: "Unsupported Media Type", 416: "Requested Range Not Satisfiable", 417: "Expectation Failed", 418: "I\"m a teapot", 422: "Unprocessable Entity", 423: "Locked", 424: "Failed Dependency", 426: "Upgrade Required", 449: "Retry With", 500: "Internal Server Error", 501: "Not Implemented", 502: "Bad Gateway", 503: "Service Unavailable", 504: "Gateway Timeout", 505: "HTTP Version Not Supported", 507: "Insufficient Storage", 510: "Not Extended" } circuits-2.1.0/circuits/web/servers.py0000644000014400001440000001157712113343751017550 0ustar prologicusers# Module: server # Date: 6th November 2008 # Author: James Mills, prologic at shortcircuit dot net dot au """Web Servers This module implements the several Web Server components. """ from circuits.core import handler, BaseComponent from circuits import io from circuits.net.sockets import Read, Write from circuits.net.sockets import TCPServer, UNIXServer from .http import HTTP from .events import WebEvent from .wrappers import Request, Host from .constants import SERVER_VERSION from .dispatchers import Dispatcher class BaseServer(BaseComponent): """Create a Base Web Server Create a Base Web Server (HTTP) bound to the IP Address / Port or UNIX Socket specified by the 'bind' parameter. :ivar server: Reference to underlying Server Component :param bind: IP Address / Port or UNIX Socket to bind to. :type bind: Instance of int, list, tuple or str The 'bind' parameter is quite flexible with what valid values it accepts. If an int is passed, a TCPServer will be created. The Server will be bound to the Port given by the 'bind' argument and the bound interface will default (normally to "0.0.0.0"). If a list or tuple is passed, a TCPServer will be created. The Server will be bound to the Port given by the 2nd item in the 'bind' argument and the bound interface will be the 1st item. If a str is passed and it contains the ':' character, this is assumed to be a request to bind to an IP Address / Port. A TCpServer will thus be created and the IP Address and Port will be determined by splitting the string given by the 'bind' argument. Otherwise if a str is passed and it does not contain the ':' character, a file path is assumed and a UNIXServer is created and bound to the file given by the 'bind' argument. """ channel = "web" def __init__(self, bind, encoding="utf-8", secure=False, certfile=None, channel=channel): "x.__init__(...) initializes x; see x.__class__.__doc__ for signature" super(BaseServer, self).__init__(channel=channel) if type(bind) in (int, list, tuple): SocketType = TCPServer else: if ":" in bind: SocketType = TCPServer else: SocketType = UNIXServer self.server = SocketType( bind, secure=secure, certfile=certfile, channel=channel ).register(self) HTTP(encoding=encoding, channel=channel).register(self) Request.server = self if isinstance(self.server._bind, tuple): Request.local = Host( self.server._bind[0], self.server._bind[1] ) else: Request.local = Host(self.server._bind, None) Request.host = self.host Request.scheme = "https" if self.server.secure else "http" @property def version(self): return SERVER_VERSION @property def host(self): if hasattr(self, "server"): return self.server.host @property def port(self): if hasattr(self, "server"): return self.server.port @property def secure(self): if hasattr(self, "server"): return self.server.secure @property def scheme(self): return "https" if self.secure else "http" @property def base(self): host = self.host or "0.0.0.0" port = self.port or 80 scheme = self.scheme secure = self.secure tpl = "%s://%s%s" if (port == 80 and not secure) or (port == 443 and secure): port = "" else: port = ":%d" % port return tpl % (scheme, host, port) class Server(BaseServer): """Create a Web Server Create a Web Server (HTTP) complete with the default Dispatcher to parse requests and posted form data dispatching to appropriate Controller(s). See: circuits.web.servers.BaseServer """ def __init__(self, bind, **kwargs): "x.__init__(...) initializes x; see x.__class__.__doc__ for signature" super(Server, self).__init__(bind, **kwargs) Dispatcher(channel=self.channel).register(self) class FakeSock(): def getpeername(self): return (None, None) class StdinServer(BaseComponent): channel = "web" def __init__(self, encoding="utf-8", channel=channel): super(StdinServer, self).__init__(channel=channel) WebEvent.channels = (channel,) self.server = ( io.stdin + io.stdout + HTTP(encoding=encoding, channel=channel) ) self += self.server Request.server = self Dispatcher(channel=self.channel).register(self) @handler("read", channel="stdin") def read(self, data): self.fire(Read(FakeSock(), data)) @handler("write") def write(self, sock, data): self.fire(Write(data)) circuits-2.1.0/circuits/web/loggers.py0000644000014400001440000000527512113343751017517 0ustar prologicusers# Module: loggers # Date: 6th November 2008 # Author: James Mills, prologic at shortcircuit dot net dot au """Logger Component This module implements Logger Components. """ import os import sys import datetime from io import IOBase from email._parseaddr import _monthnames from circuits.six import string_types from circuits.core import handler, BaseComponent def formattime(): now = datetime.datetime.now() month = _monthnames[now.month - 1].capitalize() return ("[%02d/%s/%04d:%02d:%02d:%02d]" % (now.day, month, now.year, now.hour, now.minute, now.second)) class Logger(BaseComponent): channel = "web" format = "%(h)s %(l)s %(u)s %(t)s " \ "\"%(r)s\" %(s)s %(b)s \"%(f)s\" \"%(a)s\"" def __init__(self, file=None, logger=None, **kwargs): super(Logger, self).__init__(**kwargs) if isinstance(file, string_types): self.file = open(os.path.abspath(os.path.expanduser(file)), "a") elif isinstance(file, IOBase) or hasattr(file, "write"): self.file = file else: self.file = sys.stdout self.logger = logger @handler("response", priority=-0.1) def response(self, response): self.log(response) def log(self, response): request = response.request remote = request.remote outheaders = response.headers inheaders = request.headers protocol = "HTTP/%d.%d" % request.protocol if "X-Forwarded-For" in inheaders: host = inheaders["X-Forwarded-For"] else: host = remote.name or remote.ip atoms = {"h": host, "l": "-", "u": getattr(request, "login", None) or "-", "t": formattime(), "r": "%s %s %s" % (request.method, request.path, protocol), "s": str(response.code), "b": outheaders.get("Content-Length", "") or "-", "f": inheaders.get("Referer", ""), "a": inheaders.get("User-Agent", ""), } for k, v in list(atoms.items()): if isinstance(v, str): v = v.encode("utf8") elif not isinstance(v, str): v = str(v) # Fortunately, repr(str) escapes unprintable chars, \n, \t, etc # and backslash for us. All we have to do is strip the quotes. v = repr(v)[1:-1] # Escape double-quote. atoms[k] = v.replace("\"", "\\\"") if self.logger is not None: self.logger.info(self.format % atoms) else: self.file.write(self.format % atoms) self.file.write("\n") self.file.flush() circuits-2.1.0/circuits/web/client.py0000644000014400001440000000700012113343751017317 0ustar prologicusers try: from urllib.parse import urlparse except ImportError: from urlparse import urlparse # NOQA from circuits.web.headers import Headers from circuits.core import handler, BaseComponent, Event from circuits.net.sockets import TCPClient, Connect, Write, Close from circuits.net.protocols.http import HTTP def parse_url(url): p = urlparse(url) if p.hostname: host = p.hostname else: raise ValueError("URL must be absolute") if p.scheme == "http": secure = False port = p.port or 80 elif p.scheme == "https": secure = True port = p.port or 443 else: raise ValueError("Invalid URL scheme") resource = p.path or "/" if p.query: resource += "?" + p.query return (host, port, resource, secure) class HTTPException(Exception): pass class NotConnected(HTTPException): pass class Request(Event): """Request Event This Event is used to initiate a new request. :param method: HTTP Method (PUT, GET, POST, DELETE) :type method: str :param path: Path to resource :type path: str """ def __init__(self, method, path, body=None, headers={}): "x.__init__(...) initializes x; see x.__class__.__doc__ for signature" super(Request, self).__init__(method, path, body, headers) class Client(BaseComponent): channel = "client" def __init__(self, url, channel=channel): super(Client, self).__init__(channel=channel) self._host, self._port, self._resource, self._secure = parse_url(url) self._response = None self._transport = TCPClient(channel=channel).register(self) HTTP(channel=channel).register(self._transport) @handler("write") def write(self, data): if self._transport.connected: self.fire(Write(data), self._transport) @handler("close") def close(self): if self._transport.connected: self.fire(Close(), self._transport) @handler("connect", filter=True) def connect(self, host=None, port=None, secure=None): host = host or self._host port = port or self._port secure = secure or self._secure if not self._transport.connected: self.fire(Connect(host, port, secure), self._transport) return True @handler("request") def request(self, method, path, body=None, headers={}): if self._transport.connected: headers = Headers([(k, v) for k, v in headers.items()]) # Clients MUST include Host header in HTTP/1.1 requests (RFC 2616) if "Host" not in headers: headers["Host"] = self._host \ + (":" + str(self._port)) if self._port else "" if body is not None: headers["Content-Length"] = len(body) command = "%s %s HTTP/1.1" % (method, path) message = "%s\r\n%s" % (command, headers) self.fire(Write(message.encode('utf-8')), self._transport) if body is not None: self.fire(Write(body), self._transport) else: raise NotConnected() @handler("response") def _on_response(self, response): self._response = response if response.headers.get("Connection") == "Close": self.fire(Close(), self._transport) @property def connected(self): if hasattr(self, "_transport"): return self._transport.connected @property def response(self): return getattr(self, "_response", None) circuits-2.1.0/circuits/web/sessions.py0000644000014400001440000000201412072034467017714 0ustar prologicusers# Module: sessions # Date: 22nd February 2009 # Author: James Mills, prologic at shortcircuit dot net dot au """Session Components This module implements Session Components that can be used to store and access persistent information. """ from uuid import uuid4 as uuid from collections import defaultdict from circuits import handler, Component class Sessions(Component): channel = "web" def __init__(self, name="circuits.session", *args, **kwargs): super(Sessions, self).__init__(*args, **kwargs) self._name = name self._data = defaultdict(dict) def _load(self, id): return self._data[id] def _save(self, id, data): self._data[id] = data @handler("request", priority=10) def request(self, request, response): if self._name in request.cookie: id = request.cookie[self._name].value else: id = str(uuid()) request.sid = id request.session = self._load(id) response.cookie[self._name] = id circuits-2.1.0/circuits/web/tools.py0000644000014400001440000004042012113343751017204 0ustar prologicusers# Module: tools # Date: 16th February 2009 # Author: James Mills, prologic at shortcircuit dot net dot au """Tools This module implements tools used throughout circuits.web. These tools can also be used within Controlelrs and request handlers. """ import os import stat import hashlib import mimetypes from time import mktime from email.utils import formatdate from datetime import datetime, timedelta from email.generator import _make_boundary import collections mimetypes.init() mimetypes.add_type("image/x-dwg", ".dwg") mimetypes.add_type("image/x-icon", ".ico") mimetypes.add_type("application/xhtml+xml", ".xhtml") from . import _httpauth from .utils import get_ranges, compress from .errors import HTTPError, NotFound, Redirect, Unauthorized def expires(request, response, secs=0, force=False): """Tool for influencing cache mechanisms using the 'Expires' header. 'secs' must be either an int or a datetime.timedelta, and indicates the number of seconds between response.time and when the response should expire. The 'Expires' header will be set to (response.time + secs). If 'secs' is zero, the 'Expires' header is set one year in the past, and the following "cache prevention" headers are also set: - 'Pragma': 'no-cache' - 'Cache-Control': 'no-cache, must-revalidate' If 'force' is False (the default), the following headers are checked: 'Etag', 'Last-Modified', 'Age', 'Expires'. If any are already present, none of the above response headers are set. """ headers = response.headers cacheable = False if not force: # some header names that indicate that the response can be cached for indicator in ('Etag', 'Last-Modified', 'Age', 'Expires'): if indicator in headers: cacheable = True break if not cacheable: if isinstance(secs, timedelta): secs = (86400 * secs.days) + secs.seconds if secs == 0: if force or "Pragma" not in headers: headers["Pragma"] = "no-cache" if request.protocol >= (1, 1): if force or "Cache-Control" not in headers: headers["Cache-Control"] = "no-cache, must-revalidate" # Set an explicit Expires date in the past. now = datetime.now() lastyear = now.replace(year=now.year - 1) expiry = formatdate( mktime(lastyear.timetuple()), usegmt=True ) else: expiry = formatdate(response.time + secs, usegmt=True) if force or "Expires" not in headers: headers["Expires"] = expiry def serve_file(request, response, path, type=None, disposition=None, name=None): """Set status, headers, and body in order to serve the given file. The Content-Type header will be set to the type arg, if provided. If not provided, the Content-Type will be guessed by the file extension of the 'path' argument. If disposition is not None, the Content-Disposition header will be set to "; filename=". If name is None, it will be set to the basename of path. If disposition is None, no Content-Disposition header will be written. """ if not os.path.isabs(path): raise ValueError("'%s' is not an absolute path." % path) try: st = os.stat(path) except OSError: return NotFound(request, response) # Check if path is a directory. if stat.S_ISDIR(st.st_mode): # Let the caller deal with it as they like. return NotFound(request, response) # Set the Last-Modified response header, so that # modified-since validation code can work. response.headers['Last-Modified'] = formatdate( st.st_mtime, usegmt=True ) result = validate_since(request, response) if result is not None: return result if type is None: # Set content-type based on filename extension ext = "" i = path.rfind('.') if i != -1: ext = path[i:].lower() type = mimetypes.types_map.get(ext, "text/plain") response.headers['Content-Type'] = type if disposition is not None: if name is None: name = os.path.basename(path) cd = '%s; filename="%s"' % (disposition, name) response.headers["Content-Disposition"] = cd # Set Content-Length and use an iterable (file object) # this way CP won't load the whole file in memory c_len = st.st_size bodyfile = open(path, 'rb') # HTTP/1.0 didn't have Range/Accept-Ranges headers, or the 206 code if request.protocol >= (1, 1): response.headers["Accept-Ranges"] = "bytes" r = get_ranges(request.headers.get('Range'), c_len) if r == []: response.headers['Content-Range'] = "bytes */%s" % c_len return HTTPError(request, response, 416) if r: if len(r) == 1: # Return a single-part response. start, stop = r[0] r_len = stop - start response.code = 206 response.headers['Content-Range'] = ( "bytes %s-%s/%s" % (start, stop - 1, c_len) ) response.headers['Content-Length'] = r_len bodyfile.seek(start) response.body = bodyfile.read(r_len) else: # Return a multipart/byteranges response. response.code = 206 boundary = _make_boundary() ct = "multipart/byteranges; boundary=%s" % boundary response.headers['Content-Type'] = ct if "Content-Length" in response.headers: # Delete Content-Length header so finalize() recalcs it. del response.headers["Content-Length"] def file_ranges(): # Apache compatibility: yield "\r\n" for start, stop in r: yield "--" + boundary yield "\r\nContent-type: %s" % type yield ("\r\nContent-range: bytes %s-%s/%s\r\n\r\n" % (start, stop - 1, c_len)) bodyfile.seek(start) yield bodyfile.read(stop - start) yield "\r\n" # Final boundary yield "--" + boundary + "--" # Apache compatibility: yield "\r\n" response.body = file_ranges() else: response.headers['Content-Length'] = c_len response.body = bodyfile else: response.headers['Content-Length'] = c_len response.body = bodyfile return response def serve_download(request, response, path, name=None): """Serve 'path' as an application/x-download attachment.""" type = "application/x-download" disposition = "attachment" return serve_file(request, response, path, type, disposition, name) def validate_etags(request, response, autotags=False): """Validate the current ETag against If-Match, If-None-Match headers. If autotags is True, an ETag response-header value will be provided from an MD5 hash of the response body (unless some other code has already provided an ETag header). If False (the default), the ETag will not be automatic. WARNING: the autotags feature is not designed for URL's which allow methods other than GET. For example, if a POST to the same URL returns no content, the automatic ETag will be incorrect, breaking a fundamental use for entity tags in a possibly destructive fashion. Likewise, if you raise 304 Not Modified, the response body will be empty, the ETag hash will be incorrect, and your application will break. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.24 """ # Guard against being run twice. if hasattr(response, "ETag"): return code = response.code etag = response.headers.get('ETag') # Automatic ETag generation. See warning in docstring. if (not etag) and autotags: if code == 200: etag = response.collapse_body() etag = '"%s"' % hashlib.md5.new(etag).hexdigest() response.headers['ETag'] = etag response.ETag = etag # "If the request would, without the If-Match header field, result in # anything other than a 2xx or 412 status, then the If-Match header # MUST be ignored." if code >= 200 and code <= 299: conditions = request.headers.elements('If-Match') or [] conditions = [str(x) for x in conditions] if conditions and not (conditions == ["*"] or etag in conditions): return HTTPError( request, response, 412, description="If-Match failed: ETag %r did not match %r" % ( etag, conditions ) ) conditions = request.headers.elements('If-None-Match') or [] conditions = [str(x) for x in conditions] if conditions == ["*"] or etag in conditions: if request.method in ("GET", "HEAD"): return Redirect(request, response, [], code=304) else: return HTTPError( request, response, 412, description=( "If-None-Match failed: ETag %r matched %r" % ( etag, conditions ) ) ) def validate_since(request, response): """Validate the current Last-Modified against If-Modified-Since headers. If no code has set the Last-Modified response header, then no validation will be performed. """ lastmod = response.headers.get('Last-Modified') if lastmod: code = response.code since = request.headers.get('If-Unmodified-Since') if since and since != lastmod: if (code >= 200 and code <= 299) or code == 412: return HTTPError(request, response, 412) since = request.headers.get('If-Modified-Since') if since and since == lastmod: if (code >= 200 and code <= 299) or code == 304: if request.method in ("GET", "HEAD"): return Redirect(request, response, [], code=304) else: return HTTPError(request, response, 412) def check_auth(request, response, realm, users, encrypt=None): """Check Authentication If an authorization header contains credentials, return True, else False. :param realm: The authentication realm. :type realm: str :param users: A dict of the form: {username: password} or a callable returning a dict. :type users: dict or callable :param encrypt: Callable used to encrypt the password returned from the user-agent. if None it defaults to a md5 encryption. :type encrypt: callable """ if 'authorization' in request.headers: # make sure the provided credentials are correctly set ah = _httpauth.parseAuthorization(request.headers['authorization']) if ah is None: return HTTPError(request, response, 400) if not encrypt: encrypt = _httpauth.DIGEST_AUTH_ENCODERS[_httpauth.MD5] if isinstance(users, collections.Callable): try: # backward compatibility users = users() # expect it to return a dictionary if not isinstance(users, dict): raise ValueError("Authentication users must be a dict") # fetch the user password password = users.get(ah["username"], None) except TypeError: # returns a password (encrypted or clear text) password = users(ah["username"]) else: if not isinstance(users, dict): raise ValueError("Authentication users must be a dict") # fetch the user password password = users.get(ah["username"], None) # validate the authorization by re-computing it here # and compare it with what the user-agent provided if _httpauth.checkResponse(ah, password, method=request.method, encrypt=encrypt, realm=realm): request.login = ah["username"] return True request.login = False return False def basic_auth(request, response, realm, users, encrypt=None): """Perform Basic Authentication If auth fails, returns an Unauthorized error with a basic authentication header. :param realm: The authentication realm. :type realm: str :param users: A dict of the form: {username: password} or a callable returning a dict. :type users: dict or callable :param encrypt: Callable used to encrypt the password returned from the user-agent. if None it defaults to a md5 encryption. :type encrypt: callable """ if check_auth(request, response, realm, users, encrypt): return # inform the user-agent this path is protected response.headers["WWW-Authenticate"] = _httpauth.basicAuth(realm) return Unauthorized(request, response) def digest_auth(request, response, realm, users): """Perform Digest Authentication If auth fails, raise 401 with a digest authentication header. :param realm: The authentication realm. :type realm: str :param users: A dict of the form: {username: password} or a callable returning a dict. :type users: dict or callable """ if check_auth(request, response, realm, users): return # inform the user-agent this path is protected response.headers["WWW-Authenticate"] = _httpauth.digestAuth(realm) return Unauthorized(request, response) def gzip(response, level=4, mime_types=['text/html', 'text/plain']): """Try to gzip the response body if Content-Type in mime_types. response.headers['Content-Type'] must be set to one of the values in the mime_types arg before calling this function. No compression is performed if any of the following hold: * The client sends no Accept-Encoding request header * No 'gzip' or 'x-gzip' is present in the Accept-Encoding header * No 'gzip' or 'x-gzip' with a qvalue > 0 is present * The 'identity' value is given with a qvalue > 0. """ if not response.body: # Response body is empty (might be a 304 for instance) return response # If returning cached content (which should already have been gzipped), # don't re-zip. if getattr(response.request, "cached", False): return response acceptable = response.request.headers.elements('Accept-Encoding') if not acceptable: # If no Accept-Encoding field is present in a request, # the server MAY assume that the client will accept any # content coding. In this case, if "identity" is one of # the available content-codings, then the server SHOULD use # the "identity" content-coding, unless it has additional # information that a different content-coding is meaningful # to the client. return response ct = response.headers.get('Content-Type', 'text/html').split(';')[0] for coding in acceptable: if coding.value == 'identity' and coding.qvalue != 0: return response if coding.value in ('gzip', 'x-gzip'): if coding.qvalue == 0: return response if ct in mime_types: # Return a generator that compresses the page varies = response.headers.get("Vary", "") varies = [x.strip() for x in varies.split(",") if x.strip()] if "Accept-Encoding" not in varies: varies.append("Accept-Encoding") response.headers['Vary'] = ", ".join(varies) response.headers['Content-Encoding'] = 'gzip' response.body = compress(response.body, level) if "Content-Length" in response.headers: # Delete Content-Length header so finalize() recalcs it. del response.headers["Content-Length"] return response return HTTPError( response.request, response, 406, description="identity, gzip" ) circuits-2.1.0/circuits/web/wrappers.py0000644000014400001440000002024412113343751017711 0ustar prologicusers# Module: wrappers # Date: 13th September 2007 # Author: James Mills, prologic at shortcircuit dot net dot au """Request/Response Wrappers This module implements the Request and Response objects. """ from io import BytesIO, IOBase from time import strftime, time try: from Cookie import SimpleCookie except ImportError: from http.cookies import SimpleCookie # NOQA from .utils import url from .headers import Headers from ..six import binary_type from .errors import HTTPError from circuits.net.sockets import BUFSIZE from .constants import HTTP_STATUS_CODES, SERVER_PROTOCOL, SERVER_VERSION try: unicode except NameError: unicode = str def file_generator(input, chunkSize=BUFSIZE): chunk = input.read(chunkSize) while chunk: yield chunk chunk = input.read(chunkSize) input.close() class Host(object): """An internet address. name should be the client's host name. If not available (because no DNS lookup is performed), the IP address should be used instead. """ ip = "0.0.0.0" port = 80 name = "unknown.tld" def __init__(self, ip, port, name=None): self.ip = ip self.port = port if name is None: name = ip self.name = name def __repr__(self): return "Host(%r, %r, %r)" % (self.ip, self.port, self.name) class Request(object): """Creates a new Request object to hold information about a request. :param sock: The socket object of the request. :type sock: socket.socket :param method: The requsted method. :type method: str :param scheme: The requsted scheme. :type scheme: str :param path: The requsted path. :type path: str :param protocol: The requsted protocol. :type protocol: str :param qs: The query string of the request. :type qs: str """ server = None """@cvar: A reference to the underlying server""" scheme = "http" protocol = (1, 1) server_protocol = (1, 1) host = "" local = Host("127.0.0.1", 80) remote = Host("", 0) xhr = False index = None script_name = "" login = None handled = False args = None kwargs = None def __init__(self, sock, method, scheme, path, protocol, qs): "initializes x; see x.__class__.__doc__ for signature" self.sock = sock self.method = method self.scheme = scheme or Request.scheme self.path = path self.protocol = protocol self.qs = qs self.cookie = SimpleCookie() self._headers = None if sock: name = sock.getpeername() if name: self.remote = Host(*name) else: name = sock.getsockname() self.remote = Host(name, "", name) self.body = BytesIO() def _getHeaders(self): return self._headers def _setHeaders(self, headers): self._headers = headers if "Cookie" in self.headers: rawcookies = self.headers["Cookie"] if not isinstance(rawcookies, str): rawcookies = rawcookies.encode('utf-8') self.cookie.load(rawcookies) host = self.headers.get("Host", None) if not host: host = self.local.name or self.local.ip self.base = "%s://%s" % (self.scheme, host) self.xhr = self.headers.get( "X-Requested-With", "").lower() == "xmlhttprequest" headers = property(_getHeaders, _setHeaders) def __repr__(self): protocol = "HTTP/%d.%d" % self.protocol return "" % (self.method, self.path, protocol) def url(self, *args, **kwargs): return url(self, *args, **kwargs) class Body(object): """Response Body""" def __get__(self, response, cls=None): if response is None: return self else: return response._body def __set__(self, response, value): if response == value: return if isinstance(value, binary_type): if value: value = [value] else: value = [] elif isinstance(value, IOBase): response.stream = True value = file_generator(value) elif isinstance(value, HTTPError): value = [str(value)] elif value is None: value = [] response._body = value class Response(object): """Response(sock, request) -> new Response object A Response object that holds the response to send back to the client. This ensure that the correct data is sent in the correct order. """ code = 200 message = None body = Body() done = False close = False stream = False chunked = False protocol = "HTTP/%d.%d" % SERVER_PROTOCOL def __init__(self, request, encoding='utf-8', code=None, message=None): "initializes x; see x.__class__.__doc__ for signature" self.request = request self.encoding = encoding if code is not None: self.code = code if message is not None: self.message = message self._body = [] self.time = time() self.headers = Headers([]) self.headers.add_header("Date", strftime("%a, %d %b %Y %H:%M:%S %Z")) if self.request.server: self.headers.add_header("Server", self.request.server.version) else: self.headers.add_header("X-Powered-By", SERVER_VERSION) self.cookie = self.request.cookie self.protocol = "HTTP/%d.%d" % self.request.server_protocol self._encoding = encoding def __repr__(self): return "" % ( self.status, self.headers["Content-Type"], (len(self.body) if type(self.body) == str else 0) ) def __str__(self): self.prepare() protocol = self.protocol status = self.status headers = self.headers return "%s %s\r\n%s" % (protocol, status, headers) @property def status(self): return "%d %s" % ( self.code, self.message or HTTP_STATUS_CODES[self.code] ) def prepare(self): # Set a default content-Type if we don't have one. self.headers.setdefault("Content-Type", "text/html; charset={0:s}".format(self.encoding) ) cLength = None if self.body is not None: if isinstance(self.body, bytes): cLength = len(self.body) elif isinstance(self.body, unicode): cLength = len(self.body.encode(self._encoding)) elif isinstance(self.body, list): cLength = sum( [ len(s.encode(self._encoding)) if not isinstance(s, bytes) else len(s) for s in self.body if s is not None ] ) if cLength is not None: self.headers["Content-Length"] = str(cLength) for k, v in self.cookie.items(): self.headers.add_header("Set-Cookie", v.OutputString()) status = self.code if status == 413: self.close = True elif "Content-Length" not in self.headers: if status < 200 or status in (204, 205, 304): pass else: if self.protocol == "HTTP/1.1" \ and self.request.method != "HEAD" \ and self.request.server is not None \ and not cLength == 0: self.chunked = True self.headers.add_header("Transfer-Encoding", "chunked") else: self.close = True if (self.request.server is not None and "Connection" not in self.headers): if self.protocol == "HTTP/1.1": if self.close: self.headers.add_header("Connection", "close") else: if not self.close: self.headers.add_header("Connection", "Keep-Alive") if self.headers.get("Transfer-Encoding", "") == "chunked": self.chunked = True circuits-2.1.0/circuits/web/controllers.py0000644000014400001440000001304412113343751020414 0ustar prologicusers# Module: controllers # Date: 6th November 2008 # Author: James Mills, prologic at shortcircuit dot net dot au """Controllers This module implements ... """ import json from inspect import getargspec from collections import Callable from functools import update_wrapper from circuits.core import handler, BaseComponent from . import tools from .wrappers import Response from .errors import Forbidden, HTTPError, NotFound, Redirect def expose(*channels, **config): def decorate(f): @handler(*channels, **config) def wrapper(self, event, *args, **kwargs): try: if not hasattr(self, "request"): (self.request, self.response), args = args[:2], args[2:] self.request.args = args self.request.kwargs = kwargs self.cookie = self.request.cookie if hasattr(self.request, "session"): self.session = self.request.session if not getattr(f, "event", False): return f(self, *args, **kwargs) else: return f(self, event, *args, **kwargs) finally: if hasattr(self, "request"): del self.request del self.response del self.cookie if hasattr(self, "session"): del self.session wrapper.args, wrapper.varargs, wrapper.varkw, wrapper.defaults = \ getargspec(f) if wrapper.args and wrapper.args[0] == "self": del wrapper.args[0] wrapper.event = True return update_wrapper(wrapper, f) return decorate class ExposeMetaClass(type): def __init__(cls, name, bases, dct): super(ExposeMetaClass, cls).__init__(name, bases, dct) for k, v in dct.items(): if isinstance(v, Callable) \ and not (k[0] == "_" or hasattr(v, "handler")): setattr(cls, k, expose(k)(v)) class BaseController(BaseComponent): channel = "/" def url(self, *args, **kwargs): """Return the current URL or create a new URL If no arguments or keywords arguments are passed, returns the current URL for the current request. .. seealso:: :py:func:`circuits.web.utils.url` """ return self.request.url(*args, **kwargs) def forbidden(self, description=None): """Return a 403 (Forbidden) response :param description: Message to display :type description: str """ return Forbidden(self.request, self.response, description=description) def notfound(self, description=None): """Return a 404 (Not Found) response :param description: Message to display :type description: str """ return NotFound(self.request, self.response, description=description) def redirect(self, urls, code=None): """Return a 30x (Redirect) response Redirect to another location specified by urls with an optional custom response code. :param urls: A single URL or list of URLs :type urls: str or list :param code: HTTP Redirect code :type code: int """ return Redirect(self.request, self.response, urls, code=code) def serve_file(self, path, type=None, disposition=None, name=None): return tools.serve_file( self.request, self.response, path, type, disposition, name ) def serve_download(self, path, name=None): return tools.serve_download( self.request, self.response, path, name ) def expires(self, secs=0, force=False): tools.expires(self.request, self.response, secs, force) Controller = ExposeMetaClass("Controller", (BaseController,), {}) def exposeJSON(*channels, **config): def decorate(f): @handler(*channels, **config) def wrapper(self, *args, **kwargs): try: if not hasattr(self, "request"): self.request, self.response = args[:2] args = args[2:] self.cookie = self.request.cookie if hasattr(self.request, "session"): self.session = self.request.session result = f(self, *args, **kwargs) if (isinstance(result, HTTPError) or isinstance(result, Response)): return result else: self.response.headers["Content-Type"] = ( "application/json" ) return json.dumps(result) finally: if hasattr(self, "request"): del self.request del self.response del self.cookie if hasattr(self, "session"): del self.session wrapper.args, wrapper.varargs, wrapper.varkw, wrapper.defaults = \ getargspec(f) if wrapper.args and wrapper.args[0] == "self": del wrapper.args[0] return update_wrapper(wrapper, f) return decorate class ExposeJSONMetaClass(type): def __init__(cls, name, bases, dct): super(ExposeJSONMetaClass, cls).__init__(name, bases, dct) for k, v in dct.items(): if isinstance(v, Callable) \ and not (k[0] == "_" or hasattr(v, "handler")): setattr(cls, k, exposeJSON(k)(v)) JSONController = ExposeJSONMetaClass("JSONController", (BaseController,), {}) circuits-2.1.0/circuits/web/http.py0000644000014400001440000004015412113343751017027 0ustar prologicusers# Module: http # Date: 13th September 2007 # Author: James Mills, prologic at shortcircuit dot net dot au """Hyper Text Transfer Protocol This module implements the server side Hyper Text Transfer Protocol or commonly known as HTTP. """ try: from urllib.parse import unquote from urllib.parse import urlparse except ImportError: from urllib import unquote # NOQA from urlparse import urlparse # NOQA from circuits.net.sockets import Close, Write from circuits.core import handler, BaseComponent, Value from . import wrappers from .utils import quoted_slash from .exceptions import HTTPException from .headers import parse_headers, Headers from .events import Request, Response, Stream from .errors import HTTPError, NotFound, Redirect from .exceptions import Redirect as RedirectException MAX_HEADER_FRAGENTS = 20 HTTP_ENCODING = 'utf-8' try: unicode except NameError: unicode = str class HTTP(BaseComponent): """HTTP Protocol Component Implements the HTTP server protocol and parses and processes incoming HTTP messages, creating and sending an appropriate response. The component handles :class:`~circuits.net.sockets.Read` events on its channel and collects the associated data until a complete HTTP request has been received. It parses the request's content and puts it in a :class:`~circuits.web.wrappers.Request` object and creates a corresponding :class:`~circuits.web.wrappers.Response` object. Then it emits a :class:`~circuits.web.events.Request` event with these objects as arguments. The component defines several handlers that send a response back to the client. """ channel = "web" def __init__(self, encoding="utf-8", channel=channel): super(HTTP, self).__init__(channel=channel) self._encoding = encoding self._clients = {} self._buffers = {} @handler("stream") def _on_stream(self, response, data): if data is not None: if data: if response.chunked: data = "{0:s}\r\n{1:s}\r\n".format( hex(len(data))[2:], data ).encode(self._encoding) self.fire(Write(response.request.sock, data)) if response.body and not response.done: try: data = next(response.body) except StopIteration: data = None self.fire(Stream(response, data)) else: if response.body: response.body.close() if response.chunked: self.fire(Write(response.request.sock, b"0\r\n\r\n")) if response.close: self.fire(Close(response.request.sock)) response.done = True @handler("response") def _on_response(self, response): """``Response`` Event Handler :param response: the ``Response`` object created when the HTTP request was initially received. :type response: :class:`~circuits.web.wrappers.Response` This handler builds an HTTP response data stream from the information contained in the *response* object and sends it to the client (firing ``Write`` events). """ self.fire( Write(response.request.sock, str(response).encode(HTTP_ENCODING)) ) if response.stream and response.body: try: data = next(response.body) except StopIteration: data = None self.fire(Stream(response, data)) else: if isinstance(response.body, bytes): body = response.body elif isinstance(response.body, unicode): body = response.body.encode(self._encoding) else: parts = ( s if isinstance(s, bytes) else s.encode(self._encoding) for s in response.body if s is not None ) body = b"".join(parts) if body: if response.chunked: buf = [hex(len(body))[2:].encode(), b"\r\n", body, b"\r\n"] body = b"".join(buf) self.fire(Write(response.request.sock, body)) if response.chunked: self.fire(Write(response.request.sock, b"0\r\n\r\n")) if not response.stream: if response.close: self.fire(Close(response.request.sock)) response.done = True @handler("disconnect") def _on_disconnect(self, sock): if sock in self._clients: del self._clients[sock] @handler("read") def _on_read(self, sock, data): """Read Event Handler Process any incoming data appending it to an internal buffer. Split the buffer by the standard HTTP delimiter CRLF and create Raw Event per line. Any unfinished lines of text, leave in the buffer. """ if sock in self._clients: request, response = self._clients[sock] if response.done: del self._clients[sock] if sock in self._clients: request, response = self._clients[sock] request.body.write(data) contentLength = int(request.headers.get("Content-Length", "0")) if not request.body.tell() == contentLength: return else: if sock in self._buffers: # header fragments have been received before self._buffers[sock].append(data) data = b"".join(self._buffers[sock]) if data.find(b'\r\n\r\n') == -1: # still not all headers received return # all headers received, use combined data and remove buffer del self._buffers[sock] else: # no pending header fragments for this socket if data.find(b'\r\n\r\n') == -1: # this first chunk doesn't contain all headers yet, buffer buf = self._buffers.setdefault(sock, []) buf.append(data) if len(buf) > MAX_HEADER_FRAGENTS: del self._buffers[sock] raise ValueError("Too many HTTP Headers Fragments.") return requestline, data = data.split(b"\r\n", 1) requestline = requestline.strip().decode( HTTP_ENCODING, "replace" ) method, path, protocol = requestline.split(" ", 2) scheme, location, path, params, qs, frag = urlparse(path) protocol = tuple(map(int, protocol[5:].split("."))) request = wrappers.Request( sock, method, scheme, path, protocol, qs ) response = wrappers.Response(request, encoding=self._encoding) self._clients[sock] = request, response if frag: return self.fire(HTTPError(request, response, 400)) if params: path = "%s;%s" % (path, params) # Unquote the path+params (e.g. "/this%20path" -> "this path"). # http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html#sec5.1.2 # # But note that "...a URI must be separated into its components # before the escaped characters within those components can be # safely decoded." http://www.ietf.org/rfc/rfc2396.txt, sec 2.4.2 path = "%2F".join(map(unquote, quoted_slash.split(path))) # Compare request and server HTTP protocol versions, in case our # server does not support the requested protocol. Limit our output # to min(req, server). We want the following output: # request server actual written supported response # protocol protocol response protocol feature set # a 1.0 1.0 1.0 1.0 # b 1.0 1.1 1.1 1.0 # c 1.1 1.0 1.0 1.0 # d 1.1 1.1 1.1 1.1 # Notice that, in (b), the response will be "HTTP/1.1" even though # the client only understands 1.0. RFC 2616 10.5.6 says we should # only return 505 if the _major_ version is different. if not request.protocol[0] == request.server_protocol[0]: return self.fire(HTTPError(request, response, 505)) rp = request.protocol sp = request.server_protocol response.protocol = "HTTP/%s.%s" % min(rp, sp) end_of_headers = data.find(b"\r\n\r\n") if end_of_headers > -1: header_data = data[:end_of_headers].decode( HTTP_ENCODING, "replace" ) headers = request.headers = parse_headers(header_data) else: headers = request.headers = Headers([]) request.body.write(data[(end_of_headers + 4):]) if headers.get("Expect", "") == "100-continue": return self.fire( Response( wrappers.Response( request, code=100, encoding=self._encoding ) ) ) contentLength = int(headers.get("Content-Length", "0")) if request.body.tell() < contentLength: return # Persistent connection support if request.protocol == (1, 1): # Both server and client are HTTP/1.1 if request.headers.get("Connection", "").lower() == "close": response.close = True else: # Either the server or client (or both) are HTTP/1.0 if request.headers.get("Connection", "").lower() != "keep-alive": response.close = True request.body.seek(0) if hasattr(sock, "getpeercert"): peer_cert = sock.getpeercert() if peer_cert: req = Request(request, response, peer_cert) else: req = Request(request, response) else: req = Request(request, response) self.fire(req) @handler("httperror") def _on_httperror(self, event, request, response, code, **kwargs): """Default HTTP Error Handler Default Error Handler that by default just fires a ``Response`` event with the *response* as argument. The *response* is normally modified by a :class:`~circuits.web.errors.HTTPError` instance or a subclass thereof. """ response.body = str(event) self.fire(Response(response)) @handler("request_success") def _on_request_success(self, e, value): """ Handler for the ``RequestSuccess`` event that is automatically generated after all handlers for a :class:`~circuits.web.events.Request` event have been invoked successfully. :param e: the successfully handled ``Request`` event (having as attributes the associated :class:`~circuits.web.wrappers.Request` and :class:`~circuits.web.wrappers.Response` objects). :param value: the value(s) returned by the invoked handler(s). This handler converts the value(s) returned by the (successfully invoked) handlers for the initial ``Request`` event to a body and assigns it to the ``Response`` object's ``body`` attribute. It then fires a :class:`~circuits.web.events.Response` event with the ``Response`` object as argument. """ # We only want the non-recursive value at this point. # If the value is an instance of Value we will set # the .notify flag and be notified of changes to the value. value = e.value.getValue(recursive=False) if isinstance(value, Value) and not value.promise: value = value.getValue(recursive=False) request, response = e.args[:2] if value is None: self.fire(NotFound(request, response)) elif isinstance(value, HTTPError): response.body = str(value) self.fire(Response(response)) elif isinstance(value, wrappers.Response): self.fire(Response(value)) elif isinstance(value, Value): if value.result and not value.errors: response.body = value.value self.fire(Response(response)) elif value.errors: error = value.value etype, evalue, traceback = error if isinstance(evalue, RedirectException): self.fire( Redirect(request, response, evalue.urls, evalue.status) ) elif isinstance(evalue, HTTPException): if evalue.traceback: self.fire( HTTPError( request, response, evalue.code, description=evalue.description, error=error ) ) else: self.fire( HTTPError( request, response, evalue.code, description=evalue.description ) ) else: self.fire(HTTPError(request, response, error=error)) else: # We want to be notified of changes to the value value = e.value.getValue(recursive=False) value.event = e value.notify = True elif type(value) is tuple: etype, evalue, traceback = error = value if isinstance(evalue, RedirectException): self.fire( Redirect(request, response, evalue.urls, evalue.status) ) elif isinstance(evalue, HTTPException): if evalue.traceback: self.fire( HTTPError( request, response, evalue.code, description=evalue.description, error=error ) ) else: self.fire( HTTPError( request, response, evalue.code, description=evalue.description ) ) else: self.fire(HTTPError(request, response, error=error)) elif type(value) is not bool: response.body = value self.fire(Response(response)) @handler("request_failure", "response_failure") def _on_request_or_response_failure(self, evt, err): if len(evt.args) == 1: response = evt.args[0] request = response.request else: request, response = evt.args[:2] # Ignore filtered requests already handled (eg: HTTPException(s)). # Ignore failed "response" handlers (eg: Loggers or Tools) if request.handled or response.done: return if not request.handled: request.handled = True etype, evalue, traceback = err if isinstance(evalue, RedirectException): self.fire( Redirect(request, response, evalue.urls, evalue.status) ) elif isinstance(evalue, HTTPException): if evalue.traceback: self.fire( HTTPError( request, response, evalue.code, description=evalue.description, error=err ) ) else: self.fire( HTTPError( request, response, evalue.code, description=evalue.description ) ) else: self.fire(HTTPError(request, response, error=err)) circuits-2.1.0/circuits/web/__init__.py0000644000014400001440000000134012113343751017601 0ustar prologicusers# Module: __init__ # Date: 3rd October 2008 # Author: James Mills, prologic at shortcircuit dot net dot au """Circuits Library - Web circuits.web contains the circuits full stack web server that is HTTP and WSGI compliant. """ from .utils import url from .loggers import Logger from .sessions import Sessions from .controllers import expose, Controller from .events import Request, Response from .servers import BaseServer, Server from .errors import HTTPError, Forbidden, NotFound, Redirect from .dispatchers import Static, Dispatcher, VirtualHosts, XMLRPC try: from .dispatchers import JSONRPC except ImportError: pass try: from .controllers import JSONController except ImportError: pass # flake8: noqa circuits-2.1.0/circuits/web/headers.py0000644000014400001440000002363512113343751017470 0ustar prologicusers# Module: headers # Date: 1st February 2009 November 2008 # Author: James Mills, prologic at shortcircuit dot net dot au """Headers Support This module implements support for parsing and handling headers. """ import re # Regular expression that matches `special' characters in parameters, the # existance of which force quoting of the parameter value. tspecials = re.compile(r'[ \(\)<>@,;:\\"/\[\]\?=]') q_separator = re.compile(r'; *q *=') def _formatparam(param, value=None, quote=1): """Convenience function to format and return a key=value pair. This will quote the value if needed or if quote is true. """ if value is not None and len(value) > 0: if quote or tspecials.search(value): value = value.replace('\\', '\\\\').replace('"', r'\"') return '%s="%s"' % (param, value) else: return '%s=%s' % (param, value) else: return param def header_elements(fieldname, fieldvalue): """Return a HeaderElement list from a comma-separated header str.""" if not fieldvalue: return None headername = fieldname.lower() result = [] for element in fieldvalue.split(","): if headername.startswith("accept") or headername == 'te': hv = AcceptElement.from_str(element) else: hv = HeaderElement.from_str(element) result.append(hv) result.sort() return result class HeaderElement(object): """An element (with parameters) from an HTTP header's element list.""" def __init__(self, value, params=None): self.value = value if params is None: params = {} self.params = params def __unicode__(self): p = [";%s=%s" % (k, v) for k, v in self.params.items()] return "%s%s" % (self.value, "".join(p)) def __str__(self): return str(self.__unicode__()) def parse(elementstr): """Transform 'token;key=val' to ('token', {'key': 'val'}).""" # Split the element into a value and parameters. The 'value' may # be of the form, "token=token", but we don't split that here. atoms = [x.strip() for x in elementstr.split(";") if x.strip()] initial_value = atoms.pop(0).strip() params = {} for atom in atoms: atom = [x.strip() for x in atom.split("=", 1) if x.strip()] key = atom.pop(0) if atom: val = atom[0] else: val = "" params[key] = val return initial_value, params parse = staticmethod(parse) def from_str(cls, elementstr): """Construct an instance from a string of the form 'token;key=val'.""" ival, params = cls.parse(elementstr) return cls(ival, params) from_str = classmethod(from_str) class AcceptElement(HeaderElement): """An element (with parameters) from an Accept* header's element list. AcceptElement objects are comparable; the more-preferred object will be "less than" the less-preferred object. They are also therefore sortable; if you sort a list of AcceptElement objects, they will be listed in priority order; the most preferred value will be first. Yes, it should have been the other way around, but it's too late to fix now. """ def from_str(cls, elementstr): qvalue = None # The first "q" parameter (if any) separates the initial # media-range parameter(s) (if any) from the accept-params. atoms = q_separator.split(elementstr, 1) media_range = atoms.pop(0).strip() if atoms: # The qvalue for an Accept header can have extensions. The other # headers cannot, but it's easier to parse them as if they did. qvalue = HeaderElement.from_str(atoms[0].strip()) media_type, params = cls.parse(media_range) if qvalue is not None: params["q"] = qvalue return cls(media_type, params) from_str = classmethod(from_str) def qvalue(self): val = self.params.get("q", "1") if isinstance(val, HeaderElement): val = val.value return float(val) qvalue = property(qvalue, doc="The qvalue, or priority, of this value.") def __cmp__(self, other): diff = cmp(other.qvalue, self.qvalue) if diff == 0: diff = cmp(str(other), str(self)) return diff class Headers(dict): """Manage a collection of HTTP response headers""" def __init__(self, headers=[]): if not isinstance(headers, list): raise TypeError("Headers must be a list of name/value tuples") self._headers = headers def __len__(self): """Return the total number of headers, including duplicates.""" return len(self._headers) def __setitem__(self, name, val): """Set the value of a header.""" del self[name] self._headers.append((name, val)) def __delitem__(self, name): """Delete all occurrences of a header, if present. Does *not* raise an exception if the header is missing. """ name = name.lower() self._headers[:] = [ kv for kv in self._headers if kv[0].lower() != name ] def __getitem__(self, name): """Get the first header value for 'name' Return None if the header is missing instead of raising an exception. Note that if the header appeared multiple times, the first exactly which occurrance gets returned is undefined. Use getall() to get all the values matching a header field name. """ return self.get(name) def pop(self, name, default=None): value = self.get(name, default) del self[name] return value def has_key(self, name): """Return true if the message contains the header.""" return self.get(name) is not None __contains__ = has_key def get_all(self, name): """Return a list of all the values for the named field. These will be sorted in the order they appeared in the original header list or were added to this instance, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list. If no fields exist with the given name, returns an empty list. """ name = name.lower() return [kv[1] for kv in self._headers if kv[0].lower() == name] def get(self, name, default=None): """Get the first header value for 'name', or return 'default'""" name = name.lower() for k, v in self._headers: if k.lower() == name: return v return default def keys(self): """Return a list of all the header field names. These will be sorted in the order they appeared in the original header list, or were added to this instance, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list. """ return [k for k, v in self._headers] def values(self): """Return a list of all header values. These will be sorted in the order they appeared in the original header list, or were added to this instance, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list. """ return [v for k, v in self._headers] def items(self): """Get all the header fields and values. These will be sorted in the order they were in the original header list, or were added to this instance, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list. """ return self._headers[:] def __repr__(self): return "Headers(%s)" % repr(self._headers) def __str__(self): """str() returns the formatted headers, complete with end line, suitable for direct HTTP transmission.""" return '\r\n'.join(["%s: %s" % kv for kv in self._headers] + ["", ""]) def setdefault(self, name, value): """Return first matching header value for 'name', or 'value' If there is no header named 'name', add a new header with name 'name' and value 'value'.""" result = self.get(name) if result is None: self._headers.append((name, value)) return value else: return result def add_header(self, _name, _value, **_params): """Extended header setting. _name is the header field to add. keyword arguments can be used to set additional parameters for the header field, with underscores converted to dashes. Normally the parameter will be added as key="value" unless value is None, in which case only the key will be added. Example: h.add_header('content-disposition', 'attachment', filename='bud.gif') Note that unlike the corresponding 'email.Message' method, this does *not* handle '(charset, language, value)' tuples: all values must be strings or None. """ parts = [] if _value is not None: parts.append(_value) for k, v in list(_params.items()): if v is None: parts.append(k.replace('_', '-')) else: parts.append(_formatparam(k.replace('_', '-'), v)) self._headers.append((_name, "; ".join(parts))) def elements(self, key): """Return a list of HeaderElements for the given header (or None).""" key = str(key).title() h = self.get(key) if h is None: return [] return header_elements(key, h) def parse_headers(data): headers = Headers([]) for line in data.split("\r\n"): if line[0] in " \t": # It's a continuation line. v = line.strip() else: k, v = line.split(":", 1) k, v = k.strip(), v.strip() headers.add_header(k, v) return headers circuits-2.1.0/circuits/web/dispatchers/0000755000014400001440000000000012113366740020006 5ustar prologicuserscircuits-2.1.0/circuits/web/dispatchers/websockets.py0000644000014400001440000000755512113343751022542 0ustar prologicusers# Module: websockets # Date: 26th February 2011 # Author: James Mills, prologic at shortcircuit dot net dot au from circuits.web.errors import HTTPError from circuits.net.protocols.websocket import WebSocketCodec import hashlib import base64 from circuits.core.handlers import handler from circuits import BaseComponent from circuits.net.sockets import Connect class WebSockets(BaseComponent): """ This class implements an RFC 6455 compliant WebSockets dispatcher that handles the WebSockets handshake and upgrades the connection. The dispatcher listens on its channel for :class:`~.web.events.Request` events and tries to match them with a given path. Upon a match, the request is checked for the proper Opening Handshake information. If successful, the dispatcher confirms the establishment of the connection to the client. Any subsequent data from the client is handled as a WebSocket data frame, decoded and fired as a :class:`~.sockets.Read` event on the ``wschannel`` passed to the constructor. The data from :class:`~.sockets.Write` events on that channel is encoded as data frames and forwarded to the client. Firing a :class:`~.sockets.Close` event on the ``wschannel`` closes the connection in an orderly fashion (i.e. as specified by the WebSocket protocol). """ channel = "web" def __init__(self, path=None, wschannel="ws", *args, **kwargs): """ :param path: the path to handle. Requests that start with this path are considered to be WebSocket Opening Handshakes. :param wschannel: the channel on which :class:`~.sockets.Read` events from the client will be delivered and where :class:`~.sockets.Write` events to the client will be sent to. """ super(WebSockets, self).__init__(*args, **kwargs) self._path = path self._wschannel = wschannel self._codecs = dict() @handler("request", filter=True, priority=0.2) def _on_request(self, request, response): if self._path is not None and not request.path.startswith(self._path): return self._protocol_version = 13 headers = request.headers sec_key = headers.get("Sec-WebSocket-Key", "").encode("utf-8") connection_tokens = [s.strip() for s in \ headers.get("Connection", "").lower().split(",")] if not "Host" in headers \ or headers.get("Upgrade", "").lower() != "websocket" \ or not "upgrade" in connection_tokens \ or sec_key is None \ or len(base64.b64decode(sec_key)) != 16: return HTTPError(request, response, code=400) if headers.get("Sec-WebSocket-Version", "") != "13": response.headers["Sec-WebSocket-Version"] = "13" return HTTPError(request, response, code=400) # Generate accept header information msg = sec_key + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11" hasher = hashlib.sha1() hasher.update(msg) accept = base64.b64encode(hasher.digest()) # Successful completion response.code = 101 response.close = False del response.headers["Content-Type"] response.headers["Upgrade"] = "WebSocket" response.headers["Connection"] = "Upgrade" response.headers["Sec-WebSocket-Accept"] = accept response.message = "WebSocket Protocol Handshake" codec = WebSocketCodec(request.sock, channel=self._wschannel) self._codecs[request.sock] = codec codec.register(self) self.fire(Connect(request.sock, *request.sock.getpeername()), self._wschannel) return response @handler("disconnect") def _on_disconnect(self, sock): if sock in self._codecs: del self._codecs[sock] circuits-2.1.0/circuits/web/dispatchers/virtualhosts.py0000644000014400001440000000347212113343751023132 0ustar prologicusers# Module: virtualhost # Date: 13th September 2007 # Author: James Mills, prologic at shortcircuit dot net dot au """VirtualHost This module implements a virtual host dispatcher that sends requests for configured virtual hosts to different dispatchers. """ try: from urllib.parse import urljoin except ImportError: from urlparse import urljoin # NOQA from circuits import handler, BaseComponent class VirtualHosts(BaseComponent): """Forward to anotehr Dispatcher based on the Host header. This can be useful when running multiple sites within one server. It allows several domains to point to different parts of a single website structure. For example: - http://www.domain.example -> / - http://www.domain2.example -> /domain2 - http://www.domain2.example:443 -> /secure :param domains: a dict of {host header value: virtual prefix} pairs. :type domains: dict The incoming "Host" request header is looked up in this dict, and, if a match is found, the corresponding "virtual prefix" value will be prepended to the URL path before passing the request onto the next dispatcher. Note that you often need separate entries for "example.com" and "www.example.com". In addition, "Host" headers may contain the port number. """ channel = "web" def __init__(self, domains): super(VirtualHosts, self).__init__() self.domains = domains @handler("request", filter=True, priority=1.0) def _on_request(self, event, request, response): path = request.path.strip("/") header = request.headers.get domain = header("X-Forwarded-Host", header("Host", "")) prefix = self.domains.get(domain, "") if prefix: path = urljoin("/%s/" % prefix, path) request.path = path circuits-2.1.0/circuits/web/dispatchers/jsonrpc.py0000644000014400001440000000571512113343751022043 0ustar prologicusers# Module: jsonrpc # Date: 13th September 2007 # Author: James Mills, prologic at shortcircuit dot net dot au """JSON RPC This module implements a JSON RPC dispatcher that translates incoming RPC calls over JSON into RPC events. """ from circuits.tools import tryimport json = tryimport(("json", "simplejson")) from circuits.six import binary_type from circuits.web.events import Response from circuits import handler, Event, BaseComponent class RPC(Event): """RPC Event""" class JSONRPC(BaseComponent): channel = "web" def __init__(self, path=None, encoding="utf-8", rpc_channel="*"): super(JSONRPC, self).__init__() if json is None: raise RuntimeError("No json support available") self.path = path self.encoding = encoding self.rpc_channel = rpc_channel @handler("request", filter=True, priority=0.2) def _on_request(self, request, response): if self.path is not None and self.path != request.path.rstrip("/"): return response.headers["Content-Type"] = "application/javascript" try: data = request.body.read().decode(self.encoding) o = json.loads(data) id, method, params = o["id"], o["method"], o["params"] if type(params) is dict: params = dict([(str(k), v) for k, v in params.iteritems()]) if "." in method: channel, name = method.split(".", 1) else: channel, name = self.rpc_channel, method name = str(name) if not isinstance(name, binary_type) else name @handler("%s_value_changed" % name, priority=0.1) def _on_value_changed(self, value): id = value.id response = value.response response.body = self._response(id, value.value) self.fire(Response(response), self.channel) value.handled = True self.addHandler(_on_value_changed) if type(params) is dict: value = self.fire(RPC.create(name, **params), channel) else: value = self.fire(RPC.create(name, *params), channel) value.id = id value.response = response value.notify = True except Exception as e: r = self._error(-1, 100, "%s: %s" % (e.__class__.__name__, e)) return r else: return True def _response(self, id, result): data = { "id": id, "version": "1.1", "result": result, "error": None } return json.dumps(data).encode(self.encoding) def _error(self, id, code, message): data = { "id": id, "version": "1.1", "error": { "name": "JSONRPCError", "code": code, "message": message } } return json.dumps(data).encode(self.encoding) circuits-2.1.0/circuits/web/dispatchers/dispatcher.py0000644000014400001440000000743512113343751022514 0ustar prologicusers# Module: dispatcher # Date: 13th September 2007 # Author: James Mills, prologic at shortcircuit dot net dot au from circuits.web.errors import HTTPError """Dispatcher This module implements a basic URL to Channel dispatcher. This is the default dispatcher used by circuits.web """ try: unicodestr = unicode except NameError: unicodestr = str from circuits import handler, BaseComponent from circuits.web.events import Request, Response from circuits.web.controllers import BaseController from circuits.web.utils import parse_body, parse_qs class Dispatcher(BaseComponent): channel = "web" def __init__(self, **kwargs): super(Dispatcher, self).__init__(**kwargs) self.paths = dict() def resolve_path(self, paths, parts): def rebuild_path(url_parts): return '/%s' % '/'.join(url_parts) left_over = [] while parts: if rebuild_path(parts) in self.paths: yield rebuild_path(parts), left_over left_over.insert(0, parts.pop()) if '/' in self.paths: yield '/', left_over def resolve_methods(self, parts): if parts: method = parts[0] vpath = parts[1:] yield method, vpath yield 'index', parts def find_handler(self, request): def get_handlers(path, method): component = self.paths[path] return component._handlers.get(method, None) def accepts_vpath(handlers, vpath): args_no = len(vpath) return all(len(h.args) == args_no or h.varargs for h in handlers) # Split /hello/world to ['hello', 'world'] starting_parts = [x for x in request.path.strip("/").split("/") if x] for path, parts in self.resolve_path(self.paths, starting_parts): if get_handlers(path, request.method): return request.method, path, parts for method, vpath in self.resolve_methods(parts): handlers = get_handlers(path, method) if handlers and (not vpath or accepts_vpath(handlers, vpath)): request.index = (method == 'index') return method, path, vpath return None, None, None @handler("registered", channel="*") def _on_registered(self, component, manager): if (isinstance(component, BaseController) and component.channel not in self.paths): self.paths[component.channel] = component @handler("unregistered", channel="*") def _on_unregistered(self, component, manager): if (isinstance(component, BaseController) and component.channel in self.paths): del self.paths[component.channel] @handler("request", filter=True, priority=0.1) def _on_request(self, event, request, response, peer_cert=None): if peer_cert: event.peer_cert = peer_cert name, channel, vpath = self.find_handler(request) if name is not None and channel is not None: event.kwargs = parse_qs(request.qs) parse_body(request, response, event.kwargs) if vpath: event.args += tuple(vpath) if isinstance(name, unicodestr): name = str(name) return self.fire( Request.create(name, *event.args, **event.kwargs), channel ) @handler("request_value_changed") def _on_request_value_changed(self, value): if value.handled: return request, response = value.event.args[:2] if value.result and not value.errors: response.body = value.value self.fire(Response(response)) else: # This possibly never occurs. self.fire(HTTPError(request, response, error=value.value)) circuits-2.1.0/circuits/web/dispatchers/static.py0000644000014400001440000001064212113343751021647 0ustar prologicusers# Module: static # Date: 13th September 2007 # Author: James Mills, prologic at shortcircuit dot net dot au """Static This modStatic implements a Static dispatcher used to serve up static resources and an optional apache-style directory listing. """ import os from string import Template try: from urllib import quote, unquote except ImportError: from urllib.parse import quote, unquote # NOQA from circuits import handler, BaseComponent from circuits.web.tools import serve_file DEFAULT_DIRECTORY_INDEX_TEMPLATE = """ Index of $directory

          Index of $directory

            $url_up $listing
          """ _dirlisting_template = Template(DEFAULT_DIRECTORY_INDEX_TEMPLATE) class Static(BaseComponent): channel = "web" def __init__(self, path=None, docroot=None, defaults=("index.html", "index.xhtml",), dirlisting=False): super(Static, self).__init__() self.path = path self.docroot = docroot or os.getcwd() self.defaults = defaults self.dirlisting = dirlisting @handler("request", filter=True, priority=0.9) def _on_request(self, request, response): if self.path is not None and not request.path.startswith(self.path): return path = request.path if self.path is not None: path = path[len(self.path):] path = unquote(path.strip("/")) if path: location = os.path.abspath(os.path.join(self.docroot, path)) else: location = os.path.abspath(os.path.join(self.docroot, ".")) if not os.path.exists(location): return # Is it a file we can serve directly? if os.path.isfile(location): # Don't set cookies for static content response.cookie.clear() return serve_file(request, response, location) # Is it a directory? elif os.path.isdir(location): # Try to serve one of default files first.. for default in self.defaults: location = os.path.abspath( os.path.join(self.docroot, path, default) ) if os.path.exists(location): # Don't set cookies for static content response.cookie.clear() return serve_file(request, response, location) # .. serve a directory listing if allowed to. if self.dirlisting: directory = os.path.abspath(os.path.join(self.docroot, path)) cur_dir = os.path.join(self.path, path) if self.path else "" if not path: url_up = "" else: if self.path is None: url_up = os.path.join("/", os.path.split(path)[0]) else: url_up = os.path.join(cur_dir, "..") url_up = '
        • %s
          • ' % (url_up, "..") listing = [] for item in os.listdir(directory): if not item.startswith("."): url = os.path.join("/", path, cur_dir, item) location = os.path.abspath( os.path.join(self.docroot, path, item) ) if os.path.isdir(location): li = '
        • %s/
          • ' % ( quote(url), item ) else: li = '
        • %s
          • ' % ( quote(url), item ) listing.append(li) ctx = {} ctx["directory"] = cur_dir or os.path.join("/", cur_dir, path) ctx["url_up"] = url_up ctx["listing"] = "\n".join(listing) return _dirlisting_template.safe_substitute(ctx) circuits-2.1.0/circuits/web/dispatchers/__init__.py0000644000014400001440000000123612113343751022116 0ustar prologicusers# Package: dispatchers # Date: 26th February 2011 # Author: James Mills, prologic at shortcircuit dot net dot au """Dispatchers This package contains various circuits.web dispatchers By default a ``circuits.web.Server`` Component uses the ``dispatcher.Dispatcher`` """ from circuits.web.dispatchers.static import Static from circuits.web.dispatchers.xmlrpc import XMLRPC from circuits.web.dispatchers.websockets import WebSockets from circuits.web.dispatchers.dispatcher import Dispatcher from circuits.web.dispatchers.virtualhosts import VirtualHosts try: from circuits.web.dispatchers.jsonrpc import JSONRPC except ImportError: pass # flake8: noqa circuits-2.1.0/circuits/web/dispatchers/xmlrpc.py0000644000014400001440000000434412113343751021667 0ustar prologicusers# Module: xmlrpc # Date: 13th September 2007 # Author: James Mills, prologic at shortcircuit dot net dot au """XML RPC This module implements a XML RPC dispatcher that translates incoming RPC calls over XML into RPC events. """ try: from xmlrpc.client import dumps, loads, Fault except ImportError: from xmlrpclib import dumps, loads, Fault # NOQA from circuits.six import binary_type from circuits.web.events import Response from circuits import handler, Event, BaseComponent class RPC(Event): """RPC Event""" class XMLRPC(BaseComponent): channel = "web" def __init__(self, path=None, encoding="utf-8", rpc_channel="*"): super(XMLRPC, self).__init__() self.path = path self.encoding = encoding self.rpc_channel = rpc_channel @handler("request", filter=True, priority=0.2) def _on_request(self, request, response): if self.path is not None and self.path != request.path.rstrip("/"): return response.headers["Content-Type"] = "text/xml" try: data = request.body.read() params, method = loads(data) if "." in method: channel, name = method.split(".", 1) else: channel, name = self.rpc_channel, method name = str(name) if not isinstance(name, binary_type) else name @handler("%s_value_changed" % name, priority=0.1) def _on_value_changed(self, value): response = value.response response.body = self._response(value.value) self.fire(Response(response), self.channel) value.handled = True self.addHandler(_on_value_changed) value = self.fire(RPC.create(name.title(), *params), channel) value.response = response value.notify = True except Exception as e: r = self._error(1, "%s: %s" % (type(e), e)) return r else: return True def _response(self, result): return dumps((result,), encoding=self.encoding, allow_none=True) def _error(self, code, message): fault = Fault(code, message) return dumps(fault, encoding=self.encoding, allow_none=True) circuits-2.1.0/circuits/web/errors.py0000644000014400001440000001561212113343751017365 0ustar prologicusers# Module: errors # Date: 11th February 2009 # Author: James Mills, prologic at shortcircuit dot net dot au """Errors This module implements a set of standard HTTP Errors. """ from cgi import escape try: from urllib.parse import urljoin as _urljoin except ImportError: from urlparse import urljoin as _urljoin # NOQA from circuits import Event from . import utils from ..six import string_types from .constants import SERVER_URL, SERVER_VERSION from .constants import DEFAULT_ERROR_MESSAGE, HTTP_STATUS_CODES class HTTPError(Event): """An event for signaling an HTTP error """ code = 500 description = "" def __init__(self, request, response, code=None, **kwargs): """ The constructor creates a new instance and modifies the *response* argument to reflect the error. """ super(HTTPError, self).__init__(request, response, code, **kwargs) # Override HTTPError subclasses self.name = "httperror" self.request = request self.response = response if code is not None: self.code = code self.error = kwargs.get("error", None) self.description = kwargs.get( "description", getattr(self.__class__, "description", "") ) if self.error is not None: self.traceback = "ERROR: (%s) %s\n%s" % ( self.error[0], self.error[1], "".join(self.error[2]) ) else: self.traceback = "" self.response.close = True self.response.code = self.code self.data = { "code": self.code, "name": HTTP_STATUS_CODES.get(self.code, "???"), "description": self.description, "traceback": escape(self.traceback), "url": SERVER_URL, "version": SERVER_VERSION } def sanitize(self): if self.code < 300 or self.code > 399: if "Location" in self.response.headers: del self.response.headers["Location"] def __str__(self): self.sanitize() return DEFAULT_ERROR_MESSAGE % self.data def __repr__(self): return "<%s %d %s>" % ( self.__class__.__name__, self.code, HTTP_STATUS_CODES.get( self.code, "???" ) ) class Forbidden(HTTPError): """An event for signaling the HTTP Forbidden error """ code = 403 class Unauthorized(HTTPError): """An event for signaling the HTTP Unauthorized error """ code = 401 class NotFound(HTTPError): """An event for signaling the HTTP Not Fouond error """ code = 404 class Redirect(HTTPError): """An event for signaling the HTTP Redirect response """ def __init__(self, request, response, urls, code=None): """ The constructor creates a new instance and modifies the *response* argument to reflect a redirect response to the given *url*. """ if isinstance(urls, string_types): urls = [urls] abs_urls = [] for url in urls: # Note that urljoin will "do the right thing" whether url is: # 1. a complete URL with host (e.g. "http://www.example.com/test") # 2. a URL relative to root (e.g. "/dummy") # 3. a URL relative to the current path # Note that any query string in request is discarded. url = _urljoin(utils.url(request), url) abs_urls.append(url) self.urls = urls = abs_urls # RFC 2616 indicates a 301 response code fits our goal; however, # browser support for 301 is quite messy. Do 302/303 instead. See # http://ppewww.ph.gla.ac.uk/~flavell/www/post-redirect.html if code is None: if request.protocol >= (1, 1): code = 303 else: code = 302 else: if code < 300 or code > 399: raise ValueError("status code must be between 300 and 399.") super(Redirect, self).__init__(request, response, code) if code in (300, 301, 302, 303, 307): response.headers["Content-Type"] = "text/html" # "The ... URI SHOULD be given by the Location field # in the response." response.headers["Location"] = urls[0] # "Unless the request method was HEAD, the entity of the response # SHOULD contain a short hypertext note with a hyperlink to the # new URI(s)." msg = {300: "This resource can be found at %s.", 301: ("This resource has permanently moved to " "%s."), 302: ("This resource resides temporarily at " "%s."), 303: ("This resource can be found at " "%s."), 307: ("This resource has moved temporarily to " "%s."), }[code] response.body = "
          \n".join([msg % (u, u) for u in urls]) # Previous code may have set C-L, so we have to reset it # (allow finalize to set it). response.headers.pop("Content-Length", None) elif code == 304: # Not Modified. # "The response MUST include the following header fields: # Date, unless its omission is required by section 14.18.1" # The "Date" header should have been set in Response.__init__ # "...the response SHOULD NOT include other entity-headers." for key in ("Allow", "Content-Encoding", "Content-Language", "Content-Length", "Content-Location", "Content-MD5", "Content-Range", "Content-Type", "Expires", "Last-Modified"): if key in response.headers: del response.headers[key] # "The 304 response MUST NOT contain a message-body." response.body = None # Previous code may have set C-L, so we have to reset it. response.headers.pop("Content-Length", None) elif code == 305: # Use Proxy. # urls[0] should be the URI of the proxy. response.headers["Location"] = urls[0] response.body = None # Previous code may have set C-L, so we have to reset it. response.headers.pop("Content-Length", None) else: raise ValueError("The %s status code is unknown." % code) def __repr__(self): if len(self.channels) > 1: channels = repr(self.channels) elif len(self.channels) == 1: channels = str(self.channels[0]) else: channels = "" return "<%s %d[%s.%s] %s>" % ( self.__class__.__name__, self.code, channels, self.name, " ".join(self.urls) ) circuits-2.1.0/circuits/web/utils.py0000644000014400001440000002046712113343751017215 0ustar prologicusers# Module: utils # Date: 13th September 2007 # Author: James Mills, prologic at shortcircuit dot net dot au """Utilities This module implements utility functions. """ import re import zlib import time import struct from io import TextIOWrapper from cgi import FieldStorage try: from urllib.parse import urljoin as _urljoin except ImportError: from urlparse import urljoin as _urljoin # NOQA try: from urllib.parse import parse_qs as _parse_qs except ImportError: from cgi import parse_qs as _parse_qs # NOQA from .exceptions import RequestEntityTooLarge quoted_slash = re.compile("(?i)%2F") image_map_pattern = re.compile("[0-9]+,[0-9]+") def parse_body(request, response, params): if "Content-Type" not in request.headers: request.headers["Content-Type"] = "" try: form = FieldStorage( environ={"REQUEST_METHOD": "POST"}, fp=request.body, headers=request.headers, keep_blank_values=True ) except Exception as e: if e.__class__.__name__ == 'MaxSizeExceeded': # Post data is too big raise RequestEntityTooLarge() raise if form.file: request.body = form.file else: params.update(dictform(form)) def parse_qs(query_string, keep_blank_values=True): """parse_qs(query_string) -> dict Build a params dictionary from a query_string. If keep_blank_values is True (the default), keep values that are blank. """ if image_map_pattern.match(query_string): # Server-side image map. Map the coords to "x" and "y" # (like CGI::Request does). pm = query_string.split(",") return {"x": int(pm[0]), "y": int(pm[1])} else: pm = _parse_qs(query_string, keep_blank_values) return dict((k, v[0]) for k, v in pm.items() if v) def dictform(form): d = {} for key in list(form.keys()): values = form[key] if isinstance(values, list): d[key] = [] for item in values: if item.filename is not None: value = item # It's a file upload else: value = item.value # It's a regular field d[key].append(value) else: if values.filename is not None: value = values # It's a file upload else: value = values.value # It's a regular field d[key] = value return d def compress(body, compress_level): """Compress 'body' at the given compress_level.""" # Header yield b"\037\213\010\0" \ + struct.pack("..." # This is also sometimes called "server-relative". newurl = '/' + '/'.join(newurl.split('/', 3)[3:]) elif relative: # "A relative reference that does not begin with a scheme name # or a slash character is termed a relative-path reference." old = url().split('/')[:-1] new = newurl.split('/') while old and new: a, b = old[0], new[0] if a != b: break old.pop(0) new.pop(0) new = (['..'] * len(old)) + new newurl = '/'.join(new) return newurl def get_ranges(headervalue, content_length): """Return a list of (start, stop) indices from a Range header, or None. Each (start, stop) tuple will be composed of two ints, which are suitable for use in a slicing operation. That is, the header "Range: bytes=3-6", if applied against a Python string, is requesting resource[3:7]. This function will return the list [(3, 7)]. If this function returns an empty list, you should return HTTP 416. """ if not headervalue: return None result = [] bytesunit, byteranges = headervalue.split("=", 1) for brange in byteranges.split(","): start, stop = [x.strip() for x in brange.split("-", 1)] if start: if not stop: stop = content_length - 1 start, stop = list(map(int, (start, stop))) if start >= content_length: # From rfc 2616 sec 14.16: # "If the server receives a request (other than one # including an If-Range request-header field) with an # unsatisfiable Range request-header field (that is, # all of whose byte-range-spec values have a first-byte-pos # value greater than the current length of the selected # resource), it SHOULD return a response code of 416 # (Requested range not satisfiable)." continue if stop < start: # From rfc 2616 sec 14.16: # "If the server ignores a byte-range-spec because it # is syntactically invalid, the server SHOULD treat # the request as if the invalid Range header field # did not exist. (Normally, this means return a 200 # response containing the full entity)." return None result.append((start, stop + 1)) else: if not stop: # See rfc quote above. return None # Negative subscript (last N bytes) result.append((content_length - int(stop), content_length)) return result circuits-2.1.0/circuits/core/0000755000014400001440000000000012113366740015650 5ustar prologicuserscircuits-2.1.0/circuits/core/handlers.py0000644000014400001440000001167112113343751020025 0ustar prologicusers# Package: handlers # Date: 11th April 2010 # Author: James Mills, prologic at shortcircuit dot net dot au """ This module define the @handler decorator/function and the HandlesType type. """ from inspect import getargspec from collections import Callable def handler(*names, **kwargs): """Creates an Event Handler This decorator can be applied to methods of classes derived from :class:`circuits.core.components.BaseComponent`. It marks the method as a handler for the events passed as arguments to the ``@handler`` decorator. The events are specified by their name. The decorated method's arguments must match the arguments passed to the :class:`circuits.core.events.Event` on creation. Optionally, the method may have an additional first argument named *event*. If declared, the event object that caused the handler to be invoked is assigned to it. By default, the handler is invoked by the component's root :class:`~.manager.Manager` for events that are propagated on the channel determined by the BaseComponent's *channel* attribute. This may be overridden by specifying a different channel as a keyword parameter of the decorator (``channel=...``). Keyword argument ``priority`` influences the order in which handlers for a specific event are invoked. The higher the priority, the earlier the handler is executed. A handler may also be specified as a filter by adding the keyword argument ``filter=True`` to the decorator. If such a handler returns a value different from ``None``, no more handlers are invoked for the handled event. Filtering handlers are invoked before normal handlers with the same priority (but after any handlers with higher priority). If you want to override a handler defined in a base class of your component, you must specify ``override=True``, else your method becomes an additional handler for the event. **Return value** Normally, the results returned by the handlers for an event are simply collected in the :class:`circuits.core.events.Event`'s :attr:`value` attribute. As a special case, a handler may return a :class:`types.GeneratorType`. This signals to the dispatcher that the handler isn't ready to deliver a result yet. Rather, it has interrupted it's execution with a ``yield None`` statement, thus preserving its current execution state. The dispatcher saves the returned generator object as a task. All tasks are reexamined (i.e. their :meth:`next()` method is invoked) when the pending events have been executed. This feature avoids an unnecessarily complicated chaining of event handlers. Imagine a handler A that needs the results from firing an event E in order to complete. Then without this feature, the final action of A would be to fire event E, and another handler for an event ``SuccessE`` would be required to complete handler A's operation, now having the result from invoking E available (actually it's even a bit more complicated). Using this "suspend" feature, the handler simply fires event E and then yields ``None`` until e.g. it finds a result in E's :attr:`value` attribute. For the simplest scenario, there even is a utility method :meth:`circuits.core.manager.Manager.callEvent` that combines firing and waiting. """ def wrapper(f): if names and type(names[0]) is bool and not names[0]: f.handler = False return f f.handler = True f.names = names f.priority = kwargs.get("priority", 0) f.filter = kwargs.get("filter", False) f.channel = kwargs.get("channel", None) f.override = kwargs.get("override", False) args = getargspec(f)[0] if args and args[0] == "self": del args[0] f.event = getattr(f, "event", bool(args and args[0] == "event")) return f return wrapper class Unknown(object): """Unknown Dummy Component""" def reprhandler(handler): format = "<%s[%s.%s] (%s.%s)>" channel = handler.channel if handler.channel is not None else "*" from circuits.core.manager import Manager if isinstance(channel, Manager): channel = "" names = ".".join(handler.names) type = "filter" if handler.filter else "listener" instance = getattr( handler, "im_self", getattr( handler, "__self__", Unknown() ) ).__class__.__name__ method = handler.__name__ return format % (type, channel, names, instance, method) class HandlerMetaClass(type): def __init__(cls, name, bases, ns): super(HandlerMetaClass, cls).__init__(name, bases, ns) callables = (x for x in ns.items() if isinstance(x[1], Callable)) for name, callable in callables: if not (name.startswith("_") or hasattr(callable, "handler")): setattr(cls, name, handler(name)(callable)) circuits-2.1.0/circuits/core/manager.py0000644000014400001440000006517012113343751017642 0ustar prologicusers# Package: manager # Date: 11th April 2010 # Author: James Mills, prologic at shortcircuit dot net dot au """ This module defines the Manager class. """ import atexit from os import getpid from itertools import chain from collections import deque from inspect import isfunction from uuid import uuid4 as uuid from types import GeneratorType from sys import exc_info as _exc_info from weakref import WeakValueDictionary from signal import signal, SIGINT, SIGTERM from traceback import format_exc, format_tb from threading import current_thread, Thread, RLock from multiprocessing import current_process, Process from .values import Value from ..tools import tryimport from .handlers import handler from ..six import create_bound_method, next from .events import Done, Success, Failure, Complete from .events import Error, Started, Stopped, Signal, GenerateEvents thread = tryimport(("thread", "_thread")) TIMEOUT = 0.1 # 100ms timeout when idle class UnregistrableError(Exception): """Raised if a component cannot be registered as child. """ def _sortkey(handler): return (handler.priority, handler.filter) class CallValue(object): def __init__(self, value): self.value = value class Dummy(object): channel = None _dummy = Dummy() del Dummy class Manager(object): """ The manager class has two roles. As a base class for component implementation, it provides methods for event and handler management. The method :meth:`.fireEvent` appends a new event at the end of the event queue for later execution. :meth:`.waitEvent` suspends the execution of a handler until all handlers for a given event have been invoked. :meth:`.callEvent` combines the last two methods in a single method. The methods :meth:`.addHandler` and :meth:`.removeHandler` allow handlers for events to be added and removed dynamically. (The more common way to register a handler is to use the :func:`~.handlers.handler` decorator or derive the class from :class:`~.components.Component`.) In its second role, the :class:`.Manager` takes the role of the event executor. Every component hierarchy has a root component that maintains a queue of events. Firing an event effectively means appending it to the event queue maintained by the root manager. The :meth:`.flush` method removes all pending events from the queue and, for each event, invokes all the handlers. Usually, :meth:`.flush` is indirectly invoked by :meth:`run`. The manager optionally provides information about the execution of events as automatically generated events. If an :class:`~.events.Event` has its :attr:`success` attribute set to True, the manager fires a :class:`~.events.Success` event if all handlers have been executed without error. Note that this event will be enqueued (and dispatched) immediately after the events that have been fired by the event's handlers. So the success event indicates both the successful invocation of all handlers for the event and the processing of the immediate follow-up events fired by those handlers. Sometimes it is not sufficient to know that an event and its immediate follow-up events have been processed. Rather, it is important to know when all state changes triggered by an event, directly or indirectly, have been performed. This also includes the processing of events that have been fired when invoking the handlers for the follow-up events and the processing of events that have again been fired by those handlers and so on. The completion of the processing of an event and all its direct or indirect follow-up events may be indicated by a :class:`~.events.Complete` event. This event is generated by the manager if :class:`~.events.Event` has its :attr:`complete` attribute set to True. Apart from the event queue, the root manager also maintains a list of tasks, actually Python generators, that are updated when the event queue has been flushed. """ _currently_handling = None """ The event currently being handled. """ def __init__(self, *args, **kwargs): "initializes x; see x.__class__.__doc__ for signature" self._tasks = set() self._cache = dict() self._cache_needs_refresh = False self._queue = deque() self._flush_batch = 0 self._globals = set() self._handlers = dict() self._values = WeakValueDictionary() self._executing_thread = None self._flushing_thread = None self._running = False self.__thread = None self.__process = None self._lock = RLock() self.root = self.parent = self self.components = set() def __repr__(self): "x.__repr__() <==> repr(x)" name = self.__class__.__name__ channel = "/{0:s}".format(getattr(self, "channel", "")) q = len(self._queue) state = "R" if self.running else "S" pid = current_process().pid if pid: id = "%s:%s" % (pid, current_thread().getName()) else: id = current_thread().getName() format = "<%s%s %s (queued=%d) [%s]>" return format % (name, channel, id, q, state) def __contains__(self, y): """x.__contains__(y) <==> y in x Return True if the Component y is registered. """ components = self.components.copy() return y in components or y in [c.__class__ for c in components] def __len__(self): """x.__len__() <==> len(x) Returns the number of events in the Event Queue. """ return len(self._queue) def __add__(self, y): """x.__add__(y) <==> x+y (Optional) Convenience operator to register y with x Equivalent to: y.register(x) @return: x @rtype Component or Manager """ y.register(self) return self def __iadd__(self, y): """x.__iadd__(y) <==> x += y (Optional) Convenience operator to register y with x Equivalent to: y.register(x) @return: x @rtype Component or Manager """ y.register(self) return self def __sub__(self, y): """x.__sub__(y) <==> x-y (Optional) Convenience operator to unregister y from x.manager Equivalent to: y.unregister() @return: x @rtype Component or Manager """ if y.manager is not y: y.unregister() return self def __isub__(self, y): """x.__sub__(y) <==> x -= y (Optional) Convenience operator to unregister y from x Equivalent to: y.unregister() @return: x @rtype Component or Manager """ if y.manager is not y: y.unregister() return self @property def name(self): """Return the name of this Component/Manager""" return self.__class__.__name__ @property def running(self): """Return the running state of this Component/Manager""" return self._running @property def pid(self): """Return the process id of this Component/Manager""" return getpid() if self.__process is None else self.__process.pid def getHandlers(self, event, channel, **kwargs): name = event.name handlers = set() handlers_chain = [self._handlers.get("*", [])] handlers_chain.append(self._handlers.get(name, [])) for _handler in chain(*handlers_chain): handler_channel = _handler.channel if handler_channel is None: handler_channel = getattr( getattr( _handler, "im_self", getattr( _handler, "__self__", _dummy ) ), "channel", None ) if channel == "*" or handler_channel in ("*", channel,) \ or channel is self: handlers.add(_handler) if not kwargs.get("exclude_globals", False): handlers.update(self._globals) for c in self.components.copy(): handlers.update(c.getHandlers(event, channel, **kwargs)) return handlers def addHandler(self, f): method = create_bound_method(f, self) if isfunction(f) else f setattr(self, method.__name__, method) if not method.names and method.channel == "*": self._globals.add(method) elif not method.names: self._handlers.setdefault("*", set()).add(method) else: for name in method.names: self._handlers.setdefault(name, set()).add(method) self.root._cache_needs_refresh = True return method def removeHandler(self, method, event=None): if event is None: names = method.names else: names = [event] for name in names: self._handlers[name].remove(method) if not self._handlers[name]: del self._handlers[name] try: delattr(self, method.__name__) except AttributeError: # Handler was never part of self pass self.root._cache_needs_refresh = True def registerChild(self, component): if component._executing_thread is not None: if self.root._executing_thread is not None: raise UnregistrableError() self.root._executing_thread = component._executing_thread component._executing_thread = None self.components.add(component) self.root._queue.extend(list(component._queue)) component._queue.clear() self.root._cache_needs_refresh = True def unregisterChild(self, component): self.components.remove(component) self.root._cache_needs_refresh = True def _fire(self, event, channel): # check if event is fired while handling an event if thread.get_ident() \ == (self._executing_thread or self._flushing_thread) \ and not isinstance(event, Signal): if self._currently_handling is not None \ and getattr(self._currently_handling, "cause", None): # if the currently handled event wants to track the # events generated by it, do the tracking now event.cause = self._currently_handling event.effects = 1 self._currently_handling.effects += 1 self._queue.append((event, channel)) # the event comes from another thread else: # Another thread has provided us with something to do. # If the component is running, we must make sure that # any pending generate event waits no longer, as there # is something to do now. with self._lock: # Modifications of attribute self._currently_handling # (in _dispatch()), calling reduce_time_left(0). and adding an # event to the (empty) event queue must be atomic, so we have # to lock. We can save the locking around # self._currently_handling = None though, but then need to copy # it to a local variable here before performing a sequence of # operations that assume its value to remain unchanged. handling = self._currently_handling if isinstance(handling, GenerateEvents): self._queue.append((event, channel)) handling.reduce_time_left(0) else: self._queue.append((event, channel)) def fireEvent(self, event, *channels): """Fire an event into the system. :param event: The event that is to be fired. :param channels: The channels that this event is delivered on. If no channels are specified, the event is delivered to the channels found in the event's :attr:`channel` attribute. If this attribute is not set, the event is delivered to the firing component's channel. And eventually, when set neither, the event is delivered on all channels ("*"). """ if not channels: channels = event.channels \ or (getattr(self, "channel", "*"),) \ or ("*",) event.channels = channels event.value = Value(event, self) self.root._fire(event, channels) return event.value fire = fireEvent def registerTask(self, g): self._tasks.add(g) def unregisterTask(self, g): if g in self._tasks: self._tasks.remove(g) def waitEvent(self, event, *channels): state = { 'run': False, 'flag': False, 'event': None, } _event = event def _on_event(self, event, *args, **kwargs): if not state['run']: self.removeHandler(_on_event_handler, _event) event.alert_done = True state['run'] = True state['event'] = event def _on_done(self, event, source, *args, **kwargs): if state['event'] == source: state['flag'] = True if not channels: channels = (None, ) for channel in channels: _on_event_handler = self.addHandler( handler(event, channel=channel)(_on_event)) _on_done_handler = self.addHandler( handler("%s_done" % event, channel=channel)(_on_done)) while not state['flag']: yield None self.removeHandler(_on_done_handler, "%s_done" % event) wait = waitEvent def callEvent(self, event, *channels): """ Fire the given event to the specified channels and suspend execution until it has been dispatched. This method may only be invoked as argument to a ``yield`` on the top execution level of a handler (e.g. "``yield self.callEvent(event)``"). It effectively creates and returns a generator that will be invoked by the main loop until the event has been dispatched (see :func:`circuits.core.handlers.handler`). """ value = self.fire(event, *channels) for r in self.waitEvent(event.name, event.channels): yield r yield CallValue(value) call = callEvent def _flush(self): # Handle events currently on queue, but none of the newly generated # events. Note that _flush can be called recursively. old_flushing = self._flushing_thread try: self._flushing_thread = thread.get_ident() if self._flush_batch == 0: self._flush_batch = len(self._queue) while self._flush_batch > 0: self._flush_batch -= 1 # Decrement first! event, channels = self._queue.popleft() self._dispatcher(event, channels, self._flush_batch) finally: self._flushing_thread = old_flushing def flushEvents(self): """ Flush all Events in the Event Queue. If called on a manager that is not the root of an object hierarchy, the invocation is delegated to the root manager. """ self.root._flush() flush = flushEvents def _dispatcher(self, event, channels, remaining): if event.complete: if not getattr(event, "cause", None): event.cause = event event.effects = 1 # event itself counts (must be done) eargs = event.args ekwargs = event.kwargs if self._cache_needs_refresh: # Don't call self._cache.clear() from other threads, # this may interfere with cache rebuild. self._cache.clear() self._cache_needs_refresh = False try: # try/except is fastest if successful in most cases handlers = self._cache[(event.name, channels)] except KeyError: h = (self.getHandlers(event, channel) for channel in channels) handlers = sorted(chain(*h), key=_sortkey, reverse=True) if isinstance(event, GenerateEvents): from .helpers import FallBackGenerator handlers.append(FallBackGenerator()._on_generate_events) elif isinstance(event, Error) and len(handlers) == 0: from .helpers import FallBackErrorHandler handlers.append(FallBackErrorHandler()._on_error) self._cache[(event.name, channels)] = handlers if isinstance(event, GenerateEvents): with self._lock: self._currently_handling = event if remaining > 0 or len(self._queue) or not self._running: event.reduce_time_left(0) elif len(self._tasks): event.reduce_time_left(TIMEOUT) # From now on, firing an event will reduce time left # to 0, which prevents handlers from waiting (or wakes # them up with resume if they should be waiting already) else: self._currently_handling = event value = None error = None for handler in handlers: event.handler = handler try: if handler.event: value = handler(event, *eargs, **ekwargs) else: value = handler(*eargs, **ekwargs) except (KeyboardInterrupt, SystemExit): self.stop() except: etype, evalue, etraceback = _exc_info() traceback = format_tb(etraceback) error = (etype, evalue, traceback) event.value.errors = True value = error if event.failure: self.fire( Failure.create("Failure", event, error), *event.channels ) self.fire(Error(etype, evalue, traceback, handler)) if value is not None: if isinstance(value, GeneratorType): event.waitingHandlers += 1 event.value.promise = True self.registerTask((event, value)) else: event.value.value = value # None is false, but not None may still be True or False if handler.filter and value: break self._currently_handling = None self._eventDone(event, error) def _eventDone(self, event, error=None): if event.waitingHandlers: return # The "%s_Done" event is for internal use by waitEvent only. # Use the "%s_Success" event in you application if you are # interested in being notified about the last handler for # an event having been invoked. if event.alert_done: self.fire( Done.create("Done", event, event.value.value), *event.channels ) if error is None and event.success: channels = getattr(event, "success_channels", event.channels) self.fire( Success.create("Success", event, event.value.value), *channels ) while True: # cause attributes indicates interest in completion event cause = getattr(event, "cause", None) if not cause: break # event takes part in complete detection (as nested or root event) event.effects -= 1 if event.effects > 0: break # some nested events remain to be completed if event.complete: # does this event want signaling? self.fire( Complete.create("Complete", event, event.value.value), *getattr(event, "complete_channels", event.channels) ) # this event and nested events are done now delattr(event, "cause") delattr(event, "effects") # cause has one of its nested events done, decrement and check event = cause def _signalHandler(self, signal, stack): self.fire(Signal(signal, stack)) if signal in [SIGINT, SIGTERM]: self.stop() def start(self, process=False, link=None): """ Start a new thread or process that invokes this manager's ``run()`` method. The invocation of this method returns immediately after the task or process has been started. """ if process: # Parent<->Child Bridge if link is not None: from circuits.net.sockets import Pipe from circuits.core.bridge import Bridge channels = (uuid(),) * 2 parent, child = Pipe(*channels) Bridge(parent, channel=channels[0]).register(link) args = (child,) else: args = () self.__process = Process( target=self.run, args=args, name=self.name ) self.__process.daemon = True self.__process.start() else: self.__thread = Thread(target=self.run, name=self.name) self.__thread.daemon = True self.__thread.start() def join(self): if getattr(self, "_thread", None) is not None: return self.__thread.join() if getattr(self, "_process", None) is not None: return self.__process.join() def stop(self): """ Stop this manager. Invoking this method causes an invocation of ``run()`` to return. """ if not self.running: return self._running = False self.fire(Stopped(self)) if self.root._executing_thread is None: for _ in range(3): self.tick() def processTask(self, event, task, parent=None): value = None try: value = next(task) if isinstance(value, CallValue): # Done here, next() will StopIteration anyway self.unregisterTask((event, task, parent)) # We are in a callEvent value = parent.send(value.value) if isinstance(value, GeneratorType): # We loose a yield but we gain one, we don't need to change # event.waitingHandlers self.registerTask((event, value, parent)) self.processTask(event, value, parent) else: event.waitingHandlers -= 1 if value is not None: event.value.value = value self.registerTask((event, parent)) elif isinstance(value, GeneratorType): event.waitingHandlers += 1 self.registerTask((event, value, task)) self.unregisterTask((event, task)) # We want to process all the tasks because # we bind handlers in there self.processTask(event, value, task) elif value is not None: event.value.value = value except StopIteration: event.waitingHandlers -= 1 if parent: self.unregisterTask((event, task, parent)) else: self.unregisterTask((event, task)) if parent: self.registerTask((event, parent)) elif event.waitingHandlers == 0: event.value.inform(True) self._eventDone(event) except (KeyboardInterrupt, SystemExit): self.stop() except: self.unregisterTask((event, task)) etype, evalue, etraceback = _exc_info() traceback = format_tb(etraceback) error = (etype, evalue, traceback) event.value.value = error event.value.errors = True event.value.inform(True) if event.failure: self.fire( Failure.create("Failure", event, error), *event.channels ) self.fire(Error(etype, evalue, traceback, event.handler)) def tick(self, timeout=-1): """ Execute all possible actions once. Process all registered tasks and flush the event queue. If the application is running fire a GenerateEvents to get new events from sources. This method is usually invoked from :meth:`~.run`. It may also be used to build an application specific main loop. :param timeout: the maximum waiting time spent in this method. If negative, the method may block until at least one action has been taken. :type timeout: float, measuring seconds """ # process tasks for task in self._tasks.copy(): self.processTask(*task) if self._running: self.fire(GenerateEvents(self._lock, timeout), "*") if len(self._queue): self.flush() def run(self, socket=None): """ Run this manager. The method fires the :class:`~.events.Started` event and then continuously calls :meth:`~.tick`. The method returns when the manager's :meth:`~.stop` method is invoked. If invoked by a programs main thread, a signal handler for the ``INT`` and ``TERM`` signals is installed. This handler fires the corresponding :class:`~.events.Signal` events and then calls :meth:`~.stop` for the manager. """ atexit.register(self.stop) if current_thread().getName() == "MainThread": try: signal(SIGINT, self._signalHandler) signal(SIGTERM, self._signalHandler) except ValueError: # Ignore if we can't install signal handlers pass self._running = True self.root._executing_thread = current_thread() # Setup Communications Bridge if socket is not None: from circuits.core.bridge import Bridge Bridge(socket, channel=socket.channel).register(self) self.fire(Started(self)) try: while self.running or len(self._queue): self.tick() # Fading out, handle remaining work from stop event for _ in range(3): self.tick() except Exception as e: print("ERROR: {0:s}".format(e)) print(format_exc()) finally: try: self.tick() except: pass self.root._executing_thread = None self.__thread = None self.__process = None circuits-2.1.0/circuits/core/helpers.py0000644000014400001440000000561212113343751017665 0ustar prologicusers""" .. codeauthor: mnl """ from threading import Event from .handlers import handler from .components import BaseComponent import sys from circuits.core.handlers import reprhandler class FallBackGenerator(BaseComponent): def __init__(self, *args, **kwargs): super(FallBackGenerator, self).__init__(*args, **kwargs) self._continue = Event() @handler("generate_events", priority=-100, filter=True) def _on_generate_events(self, event): """ Fall back handler for the :class:`~.events.GenerateEvents` event. When the queue is empty a GenerateEvents event is fired, here we sleep for as long as possible to avoid using extra cpu cycles. A poller would overwrite with with a higher priority filter, e.g. @handler("generate_events", priority=0, filter=True) and provide a different way to idle when the queue is empty. """ with event.lock: if event.time_left == 0: return True self._continue.clear() if event.time_left > 0: # If we get here, there is no component with work to be # done and no new event. But some component has requested # to be checked again after a certain timeout. self._continue.wait(event.time_left) # Either time is over or _continue has been set, which # implies resume has been called, which means that # reduce_time_left(0) has been called. So calling this # here is OK in any case. event.reduce_time_left(0) return True while event.time_left < 0: # If we get here, there was no work left to do when creating # the GenerateEvents event and there is no other handler that # is prepared to supply new events within a limited time. The # application will continue only if some other Thread fires # an event. # # Python ignores signals when waiting without timeout. self._continue.wait(10000) return True def resume(self): """ Implements the resume method as required from components that handle :class:`~.events.GenerateEvents`. """ self._continue.set() class FallBackErrorHandler(BaseComponent): """ If ther is no handler for error events in the component hierarchy, this component's handler is added automatically. It simply prints the error information on stderr. """ @handler("error", channel="*") def _on_error(self, error_type, value, traceback, handler=None): s = [] if handler is None: handler = "" else: handler = reprhandler(handler) msg = "ERROR %s (%s): %s\n" % (handler, error_type, value) s.append(msg) s.extend(traceback) s.append("\n") sys.stderr.write("".join(s)) circuits-2.1.0/circuits/core/timers.py0000644000014400001440000000416012113343751017523 0ustar prologicusers# Module: timers # Date: 04th August 2004 # Author: James Mills """ Timer component to facilitate timed events. """ from circuits.core.handlers import handler from time import time, mktime from datetime import datetime from .components import BaseComponent class Timer(BaseComponent): """ A timer is a component that fires an event once after a certain delay or periodically at a regular interval. """ def __init__(self, interval, event, *channels, **kwargs): """ :param interval: the delay or interval to wait for until the event is fired. If interval is specified as datetime, the interval is recalculated as the time span from now to the given datetime. :type interval: datetime or float number :param event: the event to fire. :type event: :class:`~.events.Event` If the optional keyword argument *persist* is set to ``True``, the event will be fired repeatedly. Else the timer fires the event once and then unregisters itself. """ super(Timer, self).__init__() if isinstance(interval, datetime): self.interval = mktime(interval.timetuple()) - time() else: self.interval = interval self.event = event self.channels = channels self.persist = kwargs.get("persist", False) self.reset() @handler("generate_events") def _on_generate_events(self, event): now = time() if now >= self._eTime: if self.unregister_pending: return self.fire(self.event, *self.channels) if self.persist: self.reset() else: self.unregister() event.reduce_time_left(0) else: event.reduce_time_left(self._eTime - now) def reset(self): """ Reset the timer, i.e. clear the amount of time already waited for. """ self._eTime = time() + self.interval @property def expiry(self): return getattr(self, "_eTime", None) circuits-2.1.0/circuits/core/pollers.py0000644000014400001440000003753212113343751017711 0ustar prologicusers# Module: pollers # Date: 15th September 2008 # Author: James Mills """Poller Components for asynchronous file and socket I/O. This module contains Poller components that enable polling of file or socket descriptors for read/write events. Pollers: - Select - Poll - EPoll """ import os import select import platform from errno import EBADF, EINTR from select import error as SelectError from socket import error as SocketError, create_connection, \ socket as create_socket, AF_INET, SOCK_STREAM, socket from threading import Thread from circuits.core.handlers import handler from .events import Event from .components import BaseComponent TIMEOUT = 0.01 # 10ms timeout class Read(Event): """Read Event""" name = "_read" class Write(Event): """Write Event""" name = "_write" class Error(Event): """Error Event""" name = "_error" class Disconnect(Event): """Disconnect Event""" name = "_disconnect" class BasePoller(BaseComponent): channel = None def __init__(self, timeout=TIMEOUT, channel=channel): super(BasePoller, self).__init__(channel=channel) self.timeout = timeout self._read = [] self._write = [] self._targets = {} self._ctrl_recv, self._ctrl_send = self._create_control_con() def _create_control_con(self): if platform.system() == "Linux": return os.pipe() server = create_socket(AF_INET, SOCK_STREAM) server.bind(("localhost", 0)) server.listen(1) res_list = [] def accept(): sock, _ = server.accept() sock.setblocking(False) res_list.append(sock) at = Thread(target=accept) at.start() clnt_sock = create_connection(server.getsockname()) at.join() return (res_list[0], clnt_sock) @handler("generate_events", priority=-9, filter=True) def _on_generate_events(self, event): """ Pollers have slightly higher priority than the default handler from Manager to ensure that they are invoked before the default handler. They act as filters to avoid the additional invocation of the default handler which would be unnecessary overhead. """ self._generate_events(event) return True def resume(self): if isinstance(self._ctrl_send, socket): self._ctrl_send.send(b"\0") else: os.write(self._ctrl_send, b"\0") def _read_ctrl(self): try: if isinstance(self._ctrl_recv, socket): return socket.recv(1) else: return os.read(self._ctrl_recv, 1) except: return b"\0" def addReader(self, source, fd): channel = getattr(source, "channel", "*") self._read.append(fd) self._targets[fd] = channel def addWriter(self, source, fd): channel = getattr(source, "channel", "*") self._write.append(fd) self._targets[fd] = channel def removeReader(self, fd): if fd in self._read: self._read.remove(fd) if fd in self._targets: del self._targets[fd] def removeWriter(self, fd): if fd in self._write: self._write.remove(fd) if not (fd in self._read or fd in self._write): del self._targets[fd] def isReading(self, fd): return fd in self._read def isWriting(self, fd): return fd in self._write def discard(self, fd): if fd in self._read: self._read.remove(fd) if fd in self._write: self._write.remove(fd) if fd in self._targets: del self._targets[fd] def getTarget(self, fd): return self._targets.get(fd, self.parent) class Select(BasePoller): """Select(...) -> new Select Poller Component Creates a new Select Poller Component that uses the select poller implementation. This poller is not recommended but is available for legacy reasons as most systems implement select-based polling for backwards compatibility. """ channel = "select" def __init__(self, timeout=TIMEOUT, channel=channel): super(Select, self).__init__(timeout, channel=channel) self._read.append(self._ctrl_recv) def _preenDescriptors(self): for socks in (self._read[:], self._write[:]): for sock in socks: try: select.select([sock], [sock], [sock], 0) except Exception: self.discard(sock) def _generate_events(self, event): try: if not any([self._read, self._write]): return timeout = event.time_left if timeout < 0: r, w, _ = select.select(self._read, self._write, []) else: r, w, _ = select.select(self._read, self._write, [], timeout) except ValueError as e: # Possibly a file descriptor has gone negative? return self._preenDescriptors() except TypeError as e: # Something *totally* invalid (object w/o fileno, non-integral # result) was passed return self._preenDescriptors() except (SelectError, SocketError, IOError) as e: # select(2) encountered an error if e.args[0] in (0, 2): # windows does this if it got an empty list if (not self._read) and (not self._write): return else: raise elif e.args[0] == EINTR: return elif e.args[0] == EBADF: return self._preenDescriptors() else: # OK, I really don't know what's going on. Blow up. raise for sock in w: if self.isWriting(sock): self.fire(Write(sock), self.getTarget(sock)) for sock in r: if sock == self._ctrl_recv: self._read_ctrl() continue if self.isReading(sock): self.fire(Read(sock), self.getTarget(sock)) class Poll(BasePoller): """Poll(...) -> new Poll Poller Component Creates a new Poll Poller Component that uses the poll poller implementation. """ channel = "poll" def __init__(self, timeout=TIMEOUT, channel=channel): super(Poll, self).__init__(timeout, channel=channel) self._map = {} self._poller = select.poll() self._disconnected_flag = ( select.POLLHUP | select.POLLERR | select.POLLNVAL ) self._read.append(self._ctrl_recv) self._updateRegistration(self._ctrl_recv) def _updateRegistration(self, fd): fileno = fd.fileno() try: self._poller.unregister(fileno) except KeyError: pass mask = 0 if fd in self._read: mask = mask | select.POLLIN if fd in self._write: mask = mask | select.POLLOUT if mask: self._poller.register(fd, mask) self._map[fileno] = fd else: super(Poll, self).discard(fd) del self._map[fileno] def addReader(self, source, fd): super(Poll, self).addReader(source, fd) self._updateRegistration(fd) def addWriter(self, source, fd): super(Poll, self).addWriter(source, fd) self._updateRegistration(fd) def removeReader(self, fd): super(Poll, self).removeReader(fd) self._updateRegistration(fd) def removeWriter(self, fd): super(Poll, self).removeWriter(fd) self._updateRegistration(fd) def discard(self, fd): super(Poll, self).discard(fd) self._updateRegistration(fd) def _generate_events(self, event): try: timeout = event.time_left if timeout < 0: l = self._poller.poll() else: l = self._poller.poll(1000 * timeout) except SelectError as e: if e.args[0] == EINTR: return else: raise for fileno, event in l: self._process(fileno, event) def _process(self, fileno, event): if fileno not in self._map: return fd = self._map[fileno] if fd == self._ctrl_recv: self._read_ctrl() return if event & self._disconnected_flag and not (event & select.POLLIN): self.fire(Disconnect(fd), self.getTarget(fd)) self._poller.unregister(fileno) super(Poll, self).discard(fd) del self._map[fileno] else: try: if event & select.POLLIN: self.fire(Read(fd), self.getTarget(fd)) if event & select.POLLOUT: self.fire(Write(fd), self.getTarget(fd)) except Exception as e: self.fire(Error(fd, e), self.getTarget(fd)) self.fire(Disconnect(fd), self.getTarget(fd)) self._poller.unregister(fileno) super(Poll, self).discard(fd) del self._map[fileno] class EPoll(BasePoller): """EPoll(...) -> new EPoll Poller Component Creates a new EPoll Poller Component that uses the epoll poller implementation. """ channel = "epoll" def __init__(self, timeout=TIMEOUT, channel=channel): super(EPoll, self).__init__(timeout, channel=channel) self._map = {} self._poller = select.epoll() self._disconnected_flag = (select.EPOLLHUP | select.EPOLLERR) self._read.append(self._ctrl_recv) self._updateRegistration(self._ctrl_recv) def _updateRegistration(self, fd): try: fileno = fd.fileno() self._poller.unregister(fileno) except (SocketError, IOError) as e: if e.args[0] == EBADF: keys = [k for k, v in list(self._map.items()) if v == fd] for key in keys: del self._map[key] mask = 0 if fd in self._read: mask = mask | select.EPOLLIN if fd in self._write: mask = mask | select.EPOLLOUT if mask: self._poller.register(fd, mask) self._map[fileno] = fd else: super(EPoll, self).discard(fd) def addReader(self, source, fd): super(EPoll, self).addReader(source, fd) self._updateRegistration(fd) def addWriter(self, source, fd): super(EPoll, self).addWriter(source, fd) self._updateRegistration(fd) def removeReader(self, fd): super(EPoll, self).removeReader(fd) self._updateRegistration(fd) def removeWriter(self, fd): super(EPoll, self).removeWriter(fd) self._updateRegistration(fd) def discard(self, fd): super(EPoll, self).discard(fd) self._updateRegistration(fd) def _generate_events(self, event): try: timeout = event.time_left if timeout < 0: l = self._poller.poll() else: l = self._poller.poll(timeout) except IOError as e: if e.args[0] == EINTR: return except SelectError as e: if e.args[0] == EINTR: return else: raise for fileno, event in l: self._process(fileno, event) def _process(self, fileno, event): if fileno not in self._map: return fd = self._map[fileno] if fd == self._ctrl_recv: self._read_ctrl() return if event & self._disconnected_flag and not (event & select.POLLIN): self.fire(Disconnect(fd), self.getTarget(fd)) self._poller.unregister(fileno) super(EPoll, self).discard(fd) del self._map[fileno] else: try: if event & select.EPOLLIN: self.fire(Read(fd), self.getTarget(fd)) if event & select.EPOLLOUT: self.fire(Write(fd), self.getTarget(fd)) except Exception as e: self.fire(Error(fd, e), self.getTarget(fd)) self.fire(Disconnect(fd), self.getTarget(fd)) self._poller.unregister(fileno) super(EPoll, self).discard(fd) del self._map[fileno] class KQueue(BasePoller): """KQueue(...) -> new KQueue Poller Component Creates a new KQueue Poller Component that uses the kqueue poller implementation. """ channel = "kqueue" def __init__(self, timeout=0.00001, channel=channel): super(KQueue, self).__init__(timeout, channel=channel) self._map = {} self._poller = select.kqueue() self._read.append(self._ctrl_recv) self._map[self._ctrl_recv.fileno()] = self._ctrl_recv self._poller.control( [ select.kevent( self._ctrl_recv, select.KQ_FILTER_READ, select.KQ_EV_ADD ) ], 0 ) def addReader(self, source, sock): super(KQueue, self).addReader(source, sock) self._map[sock.fileno()] = sock self._poller.control( [select.kevent(sock, select.KQ_FILTER_READ, select.KQ_EV_ADD)], 0 ) def addWriter(self, source, sock): super(KQueue, self).addWriter(source, sock) self._map[sock.fileno()] = sock self._poller.control( [select.kevent(sock, select.KQ_FILTER_WRITE, select.KQ_EV_ADD)], 0 ) def removeReader(self, sock): super(KQueue, self).removeReader(sock) self._poller.control( [ select.kevent(sock, select.KQ_FILTER_READ, select.KQ_EV_DELETE) ], 0 ) def removeWriter(self, sock): super(KQueue, self).removeWriter(sock) self._poller.control( [select.kevent(sock, select.KQ_FILTER_WRITE, select.KQ_EV_DELETE)], 0 ) def discard(self, sock): super(KQueue, self).discard(sock) del self._map[sock.fileno()] self._poller.control( [ select.kevent( sock, select.KQ_FILTER_WRITE | select.KQ_FILTER_READ, select.KQ_EV_DELETE ) ], 0 ) def _generate_events(self, event): try: timeout = event.time_left if timeout < 0: l = self._poller.control(None, 1000) else: l = self._poller.control(None, 1000, timeout) except SelectError as e: if e[0] == EINTR: return else: raise for event in l: self._process(event) def _process(self, event): if event.ident not in self._map: # shouldn't happen ? # we unregister the socket since we don't care about it anymore self._poller.control( [ select.kevent( event.ident, event.filter, select.KQ_EV_DELETE ) ], 0 ) return sock = self._map[event.ident] if sock == self._ctrl_recv: self._read_ctrl() return if event.flags & select.KQ_EV_ERROR: self.fire(Error(sock, "error"), self.getTarget(sock)) elif event.flags & select.KQ_EV_EOF: self.fire(Disconnect(sock), self.getTarget(sock)) elif event.filter == select.KQ_FILTER_WRITE: self.fire(Write(sock), self.getTarget(sock)) elif event.filter == select.KQ_FILTER_READ: self.fire(Read(sock), self.getTarget(sock)) Poller = Select __all__ = ("BasePoller", "Poller", "Select", "Poll", "EPoll", "KQueue") circuits-2.1.0/circuits/core/loader.py0000644000014400001440000000350712113343751017472 0ustar prologicusers# Package: loader # Date: 16th March 2011 # Author: James Mills, jamesmills at comops dot com dot au """ This module implements a generic Loader suitable for dynamically loading components from other modules. This supports loading from local paths, eggs and zip archives. Both setuptools and distribute are fully supported. """ import sys from inspect import getmembers, getmodule, isclass from .handlers import handler from .utils import safeimport from .components import BaseComponent class Loader(BaseComponent): """Create a new Loader Component Creates a new Loader Component that enables dynamic loading of components from modules either in local paths, eggs or zip archives. """ channel = "loader" def __init__(self, auto_register=True, init_args=None, init_kwargs=None, paths=None, channel=channel): "initializes x; see x.__class__.__doc__ for signature" super(Loader, self).__init__(channel=channel) self._auto_register = auto_register self._init_args = init_args or tuple() self._init_kwargs = init_kwargs or dict() if paths: for path in paths: sys.path.insert(0, path) @handler("load") def load(self, name): module = safeimport(name) if module is not None: test = lambda x: isclass(x) \ and issubclass(x, BaseComponent) \ and getmodule(x) is module components = [x[1] for x in getmembers(module, test)] if components: TheComponent = components[0] component = TheComponent( *self._init_args, **self._init_kwargs ) if self._auto_register: component.register(self) return component circuits-2.1.0/circuits/core/events.py0000644000014400001440000003200012113343751017516 0ustar prologicusers# Package: events # Date: 11th April 2010 # Author: James Mills, prologic at shortcircuit dot net dot au """ This module defines the basic Event class and common events. """ from .utils import uncamel from inspect import ismethod class EventMetaClass(type): def __init__(cls, name, bases, ns): super(EventMetaClass, cls).__init__(name, bases, ns) setattr(cls, "name", ns.get("name", uncamel(cls.__name__))) class BaseEvent(object): channels = () "The channels this message is sent to." notify = False success = False failure = False complete = False alert_done = False waitingHandlers = 0 @classmethod def create(cls, name, *args, **kwargs): return type(cls)(name, (cls,), {})(*args, **kwargs) def __init__(self, *args, **kwargs): """An Event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type. All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event. Every event has a :attr:`name` attribute that is used for matching the event with the handlers. By default, the name is the uncameled class name of the event. :cvar channels: an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component's channel. When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler. :ivar value: this is a :class:`circuits.core.values.Value` object that holds the results returned by the handlers invoked for the event. :var success: if this optional attribute is set to ``True``, an associated event ``EventSuccess`` (original name with "Success" appended) will automatically be fired when all handlers for the event have been invoked successfully. :var success_channels: the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute. :var complete: if this optional attribute is set to ``True``, an associated event ``EventComplete`` (original name with "Complete" appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully. :var success_channels: the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute. """ self.args = list(args) self.kwargs = kwargs self.uid = None self.value = None self.handler = None def __getstate__(self): odict = self.__dict__.copy() del odict["handler"] return odict def __setstate__(self, dict): self.__dict__.update(dict) def __repr__(self): "x.__repr__() <==> repr(x)" name = self.name type = self.__class__.__name__ if len(self.channels) > 1: channels = repr(self.channels) elif len(self.channels) == 1: channels = str(self.channels[0]) else: channels = "" data = "%s %s" % ( ", ".join(repr(arg) for arg in self.args), ", ".join("%s=%s" % (k, repr(v)) for k, v in self.kwargs.items()) ) return "<%s[%s.%s] (%s)>" % (type, channels, name, data) def __getitem__(self, x): """x.__getitem__(y) <==> x[y] Get and return data from the Event object requested by "x". If an int is passed to x, the requested argument from self.args is returned index by x. If a str is passed to x, the requested keyword argument from self.kwargs is returned keyed by x. Otherwise a TypeError is raised as nothing else is valid. """ if type(x) is int: return self.args[x] elif type(x) is str: return self.kwargs[x] else: raise TypeError("Expected int or str, got %r" % type(x)) def __setitem__(self, i, y): """x.__setitem__(i, y) <==> x[i] = y Modify the data in the Event object requested by "x". If i is an int, the ith requested argument from self.args shall be changed to y. If i is a str, the requested value keyed by i from self.kwargs, shall by changed to y. Otherwise a TypeError is raised as nothing else is valid. """ if type(i) is int: self.args[i] = y elif type(i) is str: self.kwargs[i] = y else: raise TypeError("Expected int or str, got %r" % type(i)) Event = EventMetaClass("Event", (BaseEvent,), {}) class LiteralEvent(Event): """ An event whose name is not uncameled when looking for a handler. """ @staticmethod def create(cls, name, *args, **kwargs): """ Utility method to create an event that inherits from a base event class (passed in as *cls*) and from LiteralEvent. """ return type(cls)(name, (cls, LiteralEvent), {"name": name})(*args, **kwargs) class DerivedEvent(Event): @classmethod def create(cls, topic, event, *args, **kwargs): if isinstance(event, LiteralEvent): name = "%s%s" % (event.__class__.__name__, uncamel("_%s" % topic)) return type(cls)(name, (cls,), {"name": name})(event, *args, **kwargs) else: name = "%s_%s" % (event.__class__.__name__, topic) return type(cls)(name, (cls,), {})(event, *args, **kwargs) class Error(Event): """Error Event This Event is sent for any exceptions that occur during the execution of an Event Handler that is not SystemExit or KeyboardInterrupt. :param type: type of exception :type type: type :param value: exception object :type value: exceptions.TypeError :param traceback: traceback of exception :type traceback: traceback :param kwargs: (Optional) Additional Information :type kwargs: dict """ def __init__(self, type, value, traceback, handler=None): super(Error, self).__init__(type, value, traceback, handler) class Done(DerivedEvent): """Done Event This Event is sent when an event is done. It is used by the wait and call primitives to know when to stop waiting. Don't use this for application development, use :class:`Success` instead. """ def __init__(self, *args, **kwargs): super(Done, self).__init__(*args, **kwargs) class Success(DerivedEvent): """Success Event This Event is sent when all handlers (for a particular event) have been executed successfully, see :class:`~.manager.Manager`. :param event: The event that has completed. :type event: Event """ def __init__(self, *args, **kwargs): super(Success, self).__init__(*args, **kwargs) class Complete(DerivedEvent): """Complete Event This Event is sent when all handlers (for a particular event) have been executed and (recursively) all handlers for all events fired by those handlers etc., see :class:`~.manager.Manager`. :param event: The event that has completed. :type event: Event """ def __init__(self, *args, **kwargs): super(Complete, self).__init__(*args, **kwargs) class Failure(DerivedEvent): """Failure Event This Event is sent when an error has occurred with the execution of an Event Handlers. :param event: The event that failed :type event: Event """ def __init__(self, *args, **kwargs): super(DerivedEvent, self).__init__(*args, **kwargs) class Started(Event): """Started Event This Event is sent when a Component has started running. :param component: The component that was started :type component: Component or Manager """ def __init__(self, component): super(Started, self).__init__(component) class Stopped(Event): """Stopped Event This Event is sent when a Component has stopped running. :param component: The component that has stopped :type component: Component or Manager """ def __init__(self, component): super(Stopped, self).__init__(component) class Signal(Event): """Signal Event This Event is sent when a Component receives a signal. :param signal: The signal number received. :type int: An int value for the signal :param stack: The interrupted stack frame. :type object: A stack frame """ def __init__(self, signal, stack): super(Signal, self).__init__(signal, stack) class Registered(Event): """Registered Event This Event is sent when a Component has registered with another Component or Manager. This Event is only sent iif the Component or Manager being registered with is not itself. :param component: The Component being registered :type component: Component :param manager: The Component or Manager being registered with :type manager: Component or Manager """ def __init__(self, component, manager): super(Registered, self).__init__(component, manager) class Unregister(Event): """Unregister Event This Event ask for a Component to unregister from its Component or Manager. """ def __init__(self, component=None): super(Unregister, self).__init__(component) class Unregistered(Event): """Unregistered Event This Event is sent when a Component has been unregistered from its Component or Manager. """ def __init__(self, component, manager): super(Unregistered, self).__init__(component, manager) class GenerateEvents(Event): """Generate events event This event is sent by the circuits core. All components that generate timed events or events from external sources (e.g. data becoming available) should fire any pending events in their "generate_events" handler. The handler must either be a filter (preventing other handler from being called in the same iteration) or must invoke :meth:`~.reduce_time_left` with parameter 0. :param max_wait: maximum time available for generating events. :type time_left: float Components that actually consume time waiting for events to be generated, thus suspending normal execution, must provide a method ``resume`` that interrupts waiting for events. """ def __init__(self, lock, max_wait): super(GenerateEvents, self).__init__() self._time_left = max_wait self._lock = lock @property def time_left(self): """ The time left for generating events. A value less than 0 indicates unlimited time. You should have only one component in your system (usually a poller component) that spends up to "time left" until it generates an event. """ return self._time_left def reduce_time_left(self, time_left): """ Update the time left for generating events. This is typically used by event generators that currently don't want to generate an event but know that they will within a certain time. By reducing the time left, they make sure that they are reinvoked when the time for generating the event has come (at the latest). This method can only be used to reduce the time left. If the parameter is larger than the current value of time left, it is ignored. If the time left is reduced to 0 and the event is currently being handled, the handler's *resume* method is invoked. """ with self._lock: if time_left >= 0 and (self._time_left < 0 or self._time_left > time_left): self._time_left = time_left if self._time_left == 0 and self.handler is not None: m = getattr( getattr( self.handler, "im_self", getattr( self.handler, "__self__" ) ), "resume", None ) if m is not None and ismethod(m): m() @property def lock(self): return self._lock circuits-2.1.0/circuits/core/components.py0000644000014400001440000002244512113343751020413 0ustar prologicusers# Package: components # Date: 11th April 2010 # Author: James Mills, prologic at shortcircuit dot net dot au """ This module defines the BaseComponent and its subclass Component. """ from itertools import chain from types import MethodType from collections import Callable from inspect import getmembers, isclass from .manager import Manager from .utils import flatten, findroot from .events import Event, Registered, Unregistered from .handlers import handler, HandlerMetaClass def check_singleton(x, y): """Return True if x contains a singleton that is already a member of y""" singletons = [i for i in flatten(x) if getattr(i, "singleton", False)] for component in singletons: singleton = getattr(component, "singleton", False) if isclass(singleton) and issubclass(singleton, Manager): if any([isinstance(c, singleton) for c in flatten(findroot(y))]): return True elif singleton: if any([type(component) in c for c in flatten(findroot(y))]): return True return False class SingletonError(Exception): """Raised if a Component with the `singleton` class attribute is True. """ class PrepareUnregister(Event): """ This event is fired when a component is about to be unregistered from the component tree. Unregistering a component actually detaches the complete subtree that the unregistered component is the root of. Components that need to know if they are removed from the main tree (e.g. because they maintain relationships to other components in the tree) handle this event, check if the component being unregistered is one of their ancestors and act accordingly. :param component: the component that will be unregistered :type type: :class:`~.BaseComponent` """ complete = True def __init__(self, *args, **kwargs): super(PrepareUnregister, self).__init__(*args, **kwargs) def in_subtree(self, component): """ Convenience method that checks if the given *component* is in the subtree that is about to be detached. """ while True: if component == self.args[0]: return True if component == component.root: return False component = component.parent class BaseComponent(Manager): """ This is the base class for all components in a circuits based application. Components can (and should, except for root components) be registered with a parent component. BaseComponents can declare methods as event handlers using the handler decoration (see :func:`circuits.core.handlers.handler`). The handlers are invoked for matching events from the component's channel (specified as the component's ``channel`` attribute). BaseComponents inherit from :class:`circuits.core.manager.Manager`. This provides components with the :func:`circuits.core.manager.Manager.fireEvent` method that can be used to fire events as the result of some computation. Apart from the ``fireEvent()`` method, the Manager nature is important for root components that are started or run. :ivar channel: a component can be associated with a specific channel by setting this attribute. This should either be done by specifying a class attribute *channel* in the derived class or by passing a keyword parameter *channel="..."* to *__init__*. If specified, the component's handlers receive events on the specified channel only, and events fired by the component will be sent on the specified channel (this behavior may be overridden, see :class:`~circuits.core.events.Event`, :meth:`~.fireEvent` and :func:`~circuits.core.handlers.handler`). By default, the channel attribute is set to "*", meaning that events are fired on all channels and received from all channels. """ channel = "*" singleton = False def __new__(cls, *args, **kwargs): self = super(BaseComponent, cls).__new__(cls) handlers = dict( [(k, v) for k, v in list(cls.__dict__.items()) if getattr(v, "handler", False)] ) overridden = lambda x: x in handlers and handlers[x].override for base in cls.__bases__: if issubclass(cls, base): for k, v in list(base.__dict__.items()): p1 = isinstance(v, Callable) p2 = getattr(v, "handler", False) p3 = overridden(k) if p1 and p2 and not p3: name = "%s_%s" % (base.__name__, k) method = MethodType(v, self) setattr(self, name, method) return self def __init__(self, *args, **kwargs): "initializes x; see x.__class__.__doc__ for signature" super(BaseComponent, self).__init__(*args, **kwargs) self.channel = kwargs.get("channel", self.channel) or "*" for k, v in getmembers(self): if getattr(v, "handler", False) is True: self.addHandler(v) if v is not self and isinstance(v, BaseComponent) \ and v not in ('parent', 'root'): v.register(self) if hasattr(self, "init") and isinstance(self.init, Callable): self.init(*args, **kwargs) @handler("prepare_unregister_complete", channel=self) def _on_prepare_unregister_complete(self, e, value): self._do_prepare_unregister_complete(e, value) self.addHandler(_on_prepare_unregister_complete) def register(self, parent): """ Inserts this component in the component tree as a child of the given *parent* node. :param parent: the parent component after registration has completed. :type parent: :class:`~.manager.Manager` This method fires a :class:`~.events.Registered` event to inform other components in the tree about the new member. """ if check_singleton(self, parent): raise SingletonError(self) self.parent = parent self.root = parent.root # Make sure that structure is consistent before firing event # because event may be handled in a concurrent thread. if parent is not self: parent.registerChild(self) self._updateRoot(parent.root) self.fire(Registered(self, self.parent)) else: self._updateRoot(parent.root) return self @handler('unregister') def _on_unregister(self, component): if component is not self: return return self.unregister() def unregister(self): """ Removes this component from the component tree. Removing a component from the component tree is a two stage process. First, the component is marked as to be removed, which prevents it from receiving further events, and a :class:`~.components.PrepareUnregister` event is fired. This allows other components to e.g. release references to the component to be removed before it is actually removed from the component tree. After the processing of the ``PrepareUnregister`` event has completed, the component is removed from the tree and an :class:`~.events.Unregistered` event is fired. """ if self.unregister_pending or self.parent == self: return self # tick shouldn't be called anymore, although component is still in tree self._unregister_pending = True self.root._cache_needs_refresh = True # Give components a chance to prepare for unregister evt = PrepareUnregister(self) evt.complete_channels = (self,) self.fire(evt) return self @property def unregister_pending(self): return getattr(self, "_unregister_pending", False) def _do_prepare_unregister_complete(self, e, value): # Remove component from tree now delattr(self, "_unregister_pending") self.fire(Unregistered(self, self.parent)) if self.parent is not self: self.parent.unregisterChild(self) self.parent = self self._updateRoot(self) return self def _updateRoot(self, root): self.root = root for c in self.components: c._updateRoot(root) @classmethod def handlers(cls): """Returns a list of all event handlers for this Component""" handlers = ( getattr(cls, k).names for k in dir(cls) if getattr(getattr(cls, k), "handler", False) ) return list( name for name in chain(*handlers) if not name.startswith("_") ) @classmethod def handles(cls, *names): """Returns True if all names are event handlers of this Component""" return all(name in cls.handlers() for name in names) Component = HandlerMetaClass("Component", (BaseComponent,), {}) """ If you use Component instead of BaseComponent as base class for your own component class, then all methods that are not marked as private (i.e: start with an underscore) are automatically decorated as handlers. The methods are invoked for all events from the component's channel where the event's name matches the method's name. """ circuits-2.1.0/circuits/core/workers.py0000644000014400001440000000511512113343751017715 0ustar prologicusers# Module: workers # Date: 6th February 2011 # Author: James Mills, prologic at shortcircuit dot net dot au """Workers Worker components used to perform "work" in independent threads or processes. Worker(s) are typically used by a Pool (circuits.core.pools) to create a pool of workers. Worker(s) are not registered with a Manager or another Component - instead they are managed by the Pool. If a Worker is used independently it should not be registered as it causes its main event handler ``_on_task`` to execute in the other thread blocking it. """ from threading import current_thread from weakref import WeakKeyDictionary from multiprocessing import cpu_count from multiprocessing.pool import ThreadPool from multiprocessing import Pool as ProcessPool from .events import Event from .handlers import handler from .components import BaseComponent DEFAULT_WORKERS = 10 class Task(Event): """Task Event This Event is used to initiate a new task to be performed by a Worker or a Pool of Worker(s). :param f: The function to be executed. :type f: function :param args: Arguments to pass to the function :type args: tuple :param kwargs: Keyword Arguments to pass to the function :type kwargs: dict """ def __init__(self, f, *args, **kwargs): "x.__init__(...) initializes x; see x.__class__.__doc__ for signature" super(Task, self).__init__(f, *args, **kwargs) class Worker(BaseComponent): """A thread/process Worker Component This Component creates a Worker (either a thread or process) which when given a ``Task``, will execute the given function in the task in the background in its thread/process. :param process: True to start this Worker as a process (Thread otherwise) :type process: bool """ channel = "worker" def init(self, process=False, workers=DEFAULT_WORKERS, channel=channel): if not hasattr(current_thread(), "_children"): current_thread()._children = WeakKeyDictionary() self.workers = workers or (cpu_count() if process else DEFAULT_WORKERS) Pool = ProcessPool if process else ThreadPool self.pool = Pool(self.workers) @handler("stopped", "unregistered", channel="*") def _on_stopped(self, event, *args): if event.name == "unregistered" and args[0] is not self: return self.pool.close() self.pool.join() @handler("task") def _on_task(self, f, *args, **kwargs): result = self.pool.apply_async(f, args, kwargs) while not result.ready(): yield yield result.get() circuits-2.1.0/circuits/core/values.py0000644000014400001440000000774512113343751017533 0ustar prologicusers# Package: values # Date: 11th April 2010 # Author: James Mills, prologic at shortcircuit dot net dot au """ This defines the Value object used by components and events. """ from .events import Event from ..six import string_types class ValueChanged(Event): """Value Changed Event This Event is triggered when the return Value of an Event Handler has changed its value. """ def __init__(self, value): "x.__init__(...) initializes x; see x.__class__.__doc__ for signature" super(ValueChanged, self).__init__(value) class Value(object): """Create a new future Value Object Creates a new future Value Object which is used by Event Objects and the Manager to store the result(s) of an Event Handler's exeuction of some Event in the system. :param event: The Event this Value is associated with. :type event: Event instance :param manager: The Manager/Component used to trigger notifications. :type manager: A Manager/Component instance. :ivar result: True if this value has been changed. :ivar errors: True if while setting this value an exception occured. :ivar notify: True or an event name to notify of changes to this value This is a Future/Promise implementation. """ def __init__(self, event=None, manager=None): self.event = event self.manager = manager self.notify = False self.promise = False self.result = False self.errors = False self.parent = self self.handled = False self._value = None def __getstate__(self): odict = self.__dict__.copy() del odict["manager"] return odict def __contains__(self, y): value = self.value return y in value if isinstance(value, list) else y == value def __getitem__(self, y): v = self.value[y] if isinstance(v, Value): return v.value else: return v def __iter__(self): return iter(map(lambda v: v.value if isinstance(v, Value) else v, self.value)) def __repr__(self): "x.__repr__() <==> repr(x)" value = "" if self.result: value = repr(self.value) format = " str(x)" return str(self.value) def inform(self, force=False): if self.promise and not force: return notify = getattr(self.event, "notify", False) or self.notify if self.manager is not None and notify: if isinstance(notify, string_types): e = Event.create(notify, self) else: e = ValueChanged.create( "{0:s}ValueChanged".format(self.event.__class__.__name__), self ) self.manager.fire(e, self.manager) def getValue(self, recursive=True): value = self._value if not recursive: return value while isinstance(value, Value): value = value._value return value def setValue(self, value): if isinstance(value, Value): value.parent = self if self.result and isinstance(self._value, list): self._value.append(value) elif self.result: self._value = [self._value] self._value.append(value) else: self._value = value def update(o, v): if isinstance(v, Value): o.errors = v.errors o.result = v.result elif v is not None: o.result = True o.inform() if o.parent is not o: o.parent.errors = o.errors o.parent.result = o.result update(o.parent, v) update(self, value) value = property(getValue, setValue, None, "Value of this Value") circuits-2.1.0/circuits/core/bridge.py0000644000014400001440000000515412113343751017460 0ustar prologicusers# Module: bridge # Date: 2nd April 2006 # Author: James Mills, prologic at shortcircuit dot net dot au """Bridge Bridge Component to Bridge one or more components in a single System. That is, events in System A bridged to System B are shared. For example: A <--> Bridge <--> B Events that propagate in A, will propagate to B across the Bridge. Events that propagate in B, will propagate to A across the Bridge. When the Bridge is created, it will automatically attempt to send a Helo Event to any configured nodes or on a broadcast address if no nodes are initially configured. The default Bridge implementation uses the UDP protocol and as such events cannot be guaranteed of their order or delivery. """ try: from cPickle import dumps, loads except ImportError: from pickle import dumps, loads # NOQA from .values import Value from .events import Event from .handlers import handler from .components import BaseComponent class Bridge(BaseComponent): channel = "bridge" ignore = [ "registered", "unregistered", "started", "stopped", "error", "value_changed", "generate_events", "read", "write", "close", "connected", "connect", "disconnect", "disconnected", "_read", "_write" ] def init(self, socket, channel=channel): self._socket = socket self._values = dict() if self._socket is not None: self._socket.register(self) self.addHandler( handler("read", channel=self._socket.channel)( self.__class__._on_read ) ) def _process_packet(self, eid, obj): if isinstance(obj, Event): obj.remote = True obj.notify = "ValueChanged" value = self.fire(obj) self._values[value] = eid elif isinstance(obj, Value): self._values[eid].value = obj.value @handler("value_changed", channel="*") def _on_value_changed(self, value): try: eid = self._values[value] self._socket.write(dumps((eid, value))) except: pass @staticmethod def _on_read(self, data): self._process_packet(*loads(data)) def send(self, event): try: eid = hash(event) self._values[eid] = event.value self._socket.write(dumps((eid, event))) except: pass @handler(channel="*", priority=100.0) def _on_event(self, event, *args, **kwargs): if event.name in self.ignore or getattr(event, "remote", False): return event.notify = "ValueChanged" self.send(event) circuits-2.1.0/circuits/core/debugger.py0000644000014400001440000000624112113343751020006 0ustar prologicusers# Module: debugger # Date: 2nd April 2006 # Author: James Mills, prologic at shortcircuit dot net dot au """ Debugger component used to debug each event in a system by printing each event to sys.stderr or to a Logger Component instance. """ import os import sys from .components import BaseComponent from .handlers import handler, reprhandler class Debugger(BaseComponent): """Create a new Debugger Component Creates a new Debugger Component that filters all events in the system printing each event to sys.stderr or a Logger Component. :var IgnoreEvents: list of events (str) to ignore :var IgnoreChannels: list of channels (str) to ignore :var enabled: Enabled/Disabled flag :param log: Logger Component instance or None (*default*) """ IgnoreEvents = ["generate_events"] IgnoreChannels = [] def __init__(self, errors=True, events=True, file=None, logger=None, prefix=None, trim=None, **kwargs): "initializes x; see x.__class__.__doc__ for signature" super(Debugger, self).__init__() self.errors = errors self.events = events if type(file) is str: self.file = open(os.path.abspath(os.path.expanduser(file)), "a") elif type(file) is file or hasattr(file, "write"): self.file = file else: self.file = sys.stderr self.logger = logger self.prefix = prefix self.trim = trim self.IgnoreEvents.extend(kwargs.get("IgnoreEvents", [])) self.IgnoreChannels.extend(kwargs.get("IgnoreChannels", [])) @handler("error", channel="*", priority=100.0) def _on_error(self, error_type, value, traceback, handler=None): if not self.errors: return s = [] if handler is None: handler = "" else: handler = reprhandler(handler) msg = "ERROR %s (%s): %s\n" % (handler, error_type, value) s.append(msg) s.extend(traceback) s.append("\n") if self.logger is not None: self.logger.error("".join(s)) else: try: self.file.write("".join(s)) self.file.flush() except IOError: pass @handler(channel="*", priority=101.0) def _on_event(self, event, *args, **kwargs): """Global Event Handler Event handler to listen and filter all events printing each event to self.file or a Logger Component instance by calling self.logger.debug """ if not self.events: return channels = event.channels if event.name in self.IgnoreEvents: return if all(channel in self.IgnoreChannels for channel in channels): return s = repr(event) if self.prefix: s = "%s: %s" % (self.prefix, s) if self.trim: s = "%s ...>" % s[:self.trim] if self.logger is not None: self.logger.debug(s) else: try: self.file.write(s) self.file.write("\n") self.file.flush() except IOError: pass circuits-2.1.0/circuits/core/__init__.py0000644000014400001440000000132412113343751017756 0ustar prologicusers# Package: core # Date: 2nd April 2006 # Author: James Mills, prologic at shortcircuit dot net dot au """Core This package contains the essential core parts of the circuits framework. """ from .bridge import Bridge from .loader import Loader from .manager import Manager from .handlers import handler, reprhandler from .components import BaseComponent, Component from .events import BaseEvent, DerivedEvent, Event, LiteralEvent from .values import Value from .timers import Timer from .workers import Task, Worker from .debugger import Debugger __all__ = ( "handler", "BaseComponent", "Component", "Event", "Map", "Pool", "Task", "Worker", "Bridge", "Debugger", "Timer", "Manager", ) # flake8: noqa circuits-2.1.0/circuits/core/utils.py0000644000014400001440000000305612113343751017363 0ustar prologicusers# Module: utils # Date: 11th April 2010 # Author: James Mills, prologic at shortcircuit dot net dot au """Utils This module defines utilities used by circuits. """ import re import sys from imp import reload UNCAMELRE = re.compile("([a-z0-9])([A-Z])") def uncamel(s): return UNCAMELRE.sub("\g<1>_\g<2>", s).lower() def flatten(root, visited=None): if not visited: visited = set() yield root for component in root.components.copy(): if component not in visited: visited.add(component) for child in flatten(component, visited): yield child def findchannel(root, channel, all=False): components = [x for x in flatten(root) if x.channel == channel] if all: return components if components: return components[0] def findtype(root, component, all=False): components = [x for x in flatten(root) if issubclass(type(x), component)] if all: return components if components: return components[0] findcmp = findtype def findroot(component): if component.parent == component: return component else: return findroot(component.parent) def safeimport(name): modules = sys.modules.copy() try: if name in sys.modules: return reload(sys.modules[name]) else: return __import__(name, globals(), locals(), [""]) except: for name in sys.modules.copy(): if not name in modules: del sys.modules[name] circuits-2.1.0/circuits/node/0000755000014400001440000000000012113366740015645 5ustar prologicuserscircuits-2.1.0/circuits/node/server.py0000644000014400001440000000267712113343751017536 0ustar prologicusers# Module: server # Date: ... # Author: ... """Server ... """ from circuits import handler, BaseComponent from circuits.net.sockets import TCPServer, Write from .utils import load_event, dump_value DELIMITER = b"\r\n\r\n" class Server(BaseComponent): """Server ... """ channel = "node" def __init__(self, bind, channel=channel): super(Server, self).__init__(channel=channel) self._buffers = {} TCPServer(bind, channel=self.channel).register(self) def process(self, sock, packet): e, id = load_event(packet) name = "%s_value_changed" % e.name channel = e.channels[0] if e.channels else self @handler(name, channel=self) def on_value_changed(self, event, value): self.send(value) self.addHandler(on_value_changed) v = self.fire(e, *e.channels) v.notify = True v.node_trn = id v.node_sock = sock def send(self, v): data = dump_value(v) packet = data.encode("utf-8") + DELIMITER self.fire(Write(v.node_sock, packet)) @handler("read") def _on_read(self, sock, data): buffer = self._buffers.get(sock, b"") buffer += data delimiter = buffer.find(DELIMITER) if delimiter > 0: packet = buffer[:delimiter].decode("utf-8") self._buffers[sock] = buffer[(delimiter + len(DELIMITER)):] self.process(sock, packet) circuits-2.1.0/circuits/node/events.py0000644000014400001440000000050112072034467017521 0ustar prologicusers# Module: events # Date: ... # Author: ... """Events ... """ from circuits import Event class Packet(Event): """Packet Event""" class Remote(Event): """Remote Event ... """ def __init__(self, event, node, channel=None): super(Remote, self).__init__(event, node, channel=None) circuits-2.1.0/circuits/node/node.py0000644000014400001440000000173712113343751017151 0ustar prologicusers# Module: node # Date: ... # Author: ... """Node ... """ from hashlib import sha256 from .client import Client from .server import Server from circuits import handler, BaseComponent class Node(BaseComponent): """Node ... """ channel = "node" def __init__(self, bind=None, channel=channel): super(Node, self).__init__(channel=channel) self._bind = bind self._nodes = {} if self._bind is not None: Server(self._bind).register(self) def add(self, name, host, port): channel = sha256( "{0:s}:{1:d}".format(host, port).encode("utf-8") ).hexdigest() node = Client(host, port, channel=channel) node.register(self) self._nodes[name] = node @handler("remote") def _on_remote(self, event, e, name, channel=None): node = self._nodes[name] if channel is not None: e.channels = (channel,) return node.send(event, e) circuits-2.1.0/circuits/node/client.py0000644000014400001440000000313112113343751017470 0ustar prologicusers# Module: client # Date: ... # Author: ... """Client ... """ from weakref import WeakValueDictionary from circuits import handler, BaseComponent from circuits.net.sockets import Close, Connect, TCPClient, Write from .utils import dump_event, load_value DELIMITER = b"\r\n\r\n" class Client(BaseComponent): """Client ... """ channel = "node" def __init__(self, host, port, channel=channel): super(Client, self).__init__(channel=channel) self._host = host self._port = port self._nid = 0 self._buffer = b"" self._values = WeakValueDictionary() TCPClient(channel=self.channel).register(self) self.fire(Connect(self._host, self._port)) def process(self, packet): v, id, errors = load_value(packet) if id in self._values: value = self._values[id] value.value = v value.errors = errors def close(self): self.fire(Close()) def connect(self, host, port): self.fire(Connect(host, port)) def send(self, event, e): id = self._nid self._nid += 1 self._values[id] = event.value data = dump_event(e, id) packet = data.encode("utf-8") + DELIMITER self.fire(Write(packet)) @handler("read") def _on_read(self, data): self._buffer += data delimiter = self._buffer.find(DELIMITER) if delimiter > 0: packet = self._buffer[:delimiter].decode("utf-8") self._buffer = self._buffer[(delimiter + len(DELIMITER)):] self.process(packet) circuits-2.1.0/circuits/node/__init__.py0000644000014400001440000000027012113343751017752 0ustar prologicusers# Module: node # Date: ... # Author: ... """Node Distributed and Inter-Processing support for circuits """ from .node import Node from .events import Remote # flake8: noqa circuits-2.1.0/circuits/node/utils.py0000644000014400001440000000245612113343751017363 0ustar prologicusers# Package: utils # Date: ... # Author: ... """Utils ... """ import json from circuits.core import Event from circuits.six import text_type def load_event(s): data = json.loads(s) name = "".join(x.title() for x in str(data["name"]).split("_")) args = [] for arg in data["args"]: if isinstance(arg, text_type): arg = arg.encode("utf-8") args.append(arg) kwargs = {} for k, v in data["kwargs"].items(): if isinstance(v, text_type): v = v.encode("utf-8") kwargs[str(k)] = v e = Event.create(name, *args, **kwargs) e.success = bool(data["success"]) e.failure = bool(data["failure"]) e.notify = bool(data["notify"]) e.channels = tuple(data["channels"]) return e, data["id"] def dump_event(e, id): data = { "id": id, "name": e.name, "args": e.args, "kwargs": e.kwargs, "success": e.success, "failure": e.failure, "channels": e.channels, "notify": e.notify } return json.dumps(data) def dump_value(v): data = { "id": v.node_trn, "errors": v.errors, "value": v._value, } return json.dumps(data) def load_value(v): data = json.loads(v) return data['value'], data['id'], data['errors'] circuits-2.1.0/circuits/tools/0000755000014400001440000000000012113366740016060 5ustar prologicuserscircuits-2.1.0/circuits/tools/__init__.py0000644000014400001440000000600412113343751020166 0ustar prologicusers# Module: __init__ # Date: 8th November 2008 # Author: James Mills, prologic at shortcircuit dot net dot au """Circuits Tools circuits.tools contains a standard set of tools for circuits. These tools are installed as executables with a prefix of "circuits." """ from hashlib import md5 from warnings import warn def tryimport(modules, obj=None, message=None): modules = (modules,) if isinstance(modules, str) else modules for module in modules: try: m = __import__(module, globals(), locals()) return getattr(m, obj) if obj is not None else m except: pass if message is not None: warn(message) def walk(x, f, d=0, v=None): if not v: v = set() yield f(d, x) for c in x.components.copy(): if c not in v: v.add(c) for r in walk(c, f, d + 1, v): yield r def edges(x, e=None, v=None): if not e: e = set() if not v: v = [] for c in x.components.copy(): e.add((x, c)) edges(c, e, v) return e def findroot(x): if x.parent == x: return x else: return findroot(x.parent) def kill(x): for c in x.components.copy(): kill(c) if x.parent is not x: x.unregister() def graph(x, name=None): """Display a directed graph of the Component structure of x :param x: A Component or Manager to graph :type x: Component or Manager :param name: A name for the graph (defaults to x's name) :type name: str @return: A directed graph representing x's Component sturcture. @rtype: str """ def getname(c): s = "%d" % id(c) h = md5(s.encode("utf-8")).hexdigest()[-4:] return "%s-%s" % (c.name, h) pydot = tryimport("pydot") if pydot is not None: graph_edges = [] for (u, v) in edges(x): graph_edges.append(("\"%s\"" % getname(u), "\"%s\"" % getname(v))) g = pydot.graph_from_edges(graph_edges, directed=True) g.write("%s.dot" % (name or x.name)) try: g.write("%s.png" % (name or x.name), format="png") except pydot.InvocationException: pass def printer(d, x): return "%s* %s" % (" " * d, x) return "\n".join(walk(x, printer)) def inspect(x): """Display an inspection report of the Component or Manager x :param x: A Component or Manager to graph :type x: Component or Manager @return: A detailed inspection report of x @rtype: str """ s = [] write = s.append write(" Components: %d\n" % len(x.components)) for component in x.components: write(" %s\n" % component) write("\n") from circuits import reprhandler write(" Event Handlers: %d\n" % len(x._handlers.values())) for event, handlers in x._handlers.items(): write(" %s; %d\n" % (event, len(x._handlers[event]))) for handler in x._handlers[event]: write(" %s\n" % reprhandler(handler)) return "".join(s) circuits-2.1.0/circuits/six.py0000644000014400001440000002465612113343751016107 0ustar prologicusers"""Utilities for writing code that runs on Python 2 and 3""" import sys import types import operator __author__ = "Benjamin Peterson " __version__ = "1.2.0" # True if we are running on Python 3. PY3 = sys.version_info[0] == 3 if PY3: string_types = str, integer_types = int, class_types = type, text_type = str binary_type = bytes MAXSIZE = sys.maxsize else: string_types = basestring, integer_types = (int, long) class_types = (type, types.ClassType) text_type = unicode binary_type = str if sys.platform == "java": # Jython always uses 32 bits. MAXSIZE = int((1 << 31) - 1) else: # It's possible to have sizeof(long) != sizeof(Py_ssize_t). class X(object): def __len__(self): return 1 << 31 try: len(X()) except OverflowError: # 32-bit MAXSIZE = int((1 << 31) - 1) else: # 64-bit MAXSIZE = int((1 << 63) - 1) del X def _add_doc(func, doc): """Add documentation to a function.""" func.__doc__ = doc def _import_module(name): """Import module, returning the module after the last dot.""" __import__(name) return sys.modules[name] class _LazyDescr(object): def __init__(self, name): self.name = name def __get__(self, obj, tp): result = self._resolve() setattr(obj, self.name, result) # This is a bit ugly, but it avoids running this again. delattr(tp, self.name) return result class MovedModule(_LazyDescr): def __init__(self, name, old, new=None): super(MovedModule, self).__init__(name) if PY3: if new is None: new = name self.mod = new else: self.mod = old def _resolve(self): return _import_module(self.mod) class MovedAttribute(_LazyDescr): def __init__(self, name, old_mod, new_mod, old_attr=None, new_attr=None): super(MovedAttribute, self).__init__(name) if PY3: if new_mod is None: new_mod = name self.mod = new_mod if new_attr is None: if old_attr is None: new_attr = name else: new_attr = old_attr self.attr = new_attr else: self.mod = old_mod if old_attr is None: old_attr = name self.attr = old_attr def _resolve(self): module = _import_module(self.mod) return getattr(module, self.attr) class _MovedItems(types.ModuleType): """Lazy loading of moved objects""" _moved_attributes = [ MovedAttribute("cStringIO", "cStringIO", "io", "StringIO"), MovedAttribute("filter", "itertools", "builtins", "ifilter", "filter"), MovedAttribute("input", "__builtin__", "builtins", "raw_input", "input"), MovedAttribute("map", "itertools", "builtins", "imap", "map"), MovedAttribute("reload_module", "__builtin__", "imp", "reload"), MovedAttribute("reduce", "__builtin__", "functools"), MovedAttribute("StringIO", "StringIO", "io"), MovedAttribute("xrange", "__builtin__", "builtins", "xrange", "range"), MovedAttribute("zip", "itertools", "builtins", "izip", "zip"), MovedModule("builtins", "__builtin__"), MovedModule("configparser", "ConfigParser"), MovedModule("copyreg", "copy_reg"), MovedModule("http_cookiejar", "cookielib", "http.cookiejar"), MovedModule("http_cookies", "Cookie", "http.cookies"), MovedModule("html_entities", "htmlentitydefs", "html.entities"), MovedModule("html_parser", "HTMLParser", "html.parser"), MovedModule("http_client", "httplib", "http.client"), MovedModule("BaseHTTPServer", "BaseHTTPServer", "http.server"), MovedModule("CGIHTTPServer", "CGIHTTPServer", "http.server"), MovedModule("SimpleHTTPServer", "SimpleHTTPServer", "http.server"), MovedModule("cPickle", "cPickle", "pickle"), MovedModule("queue", "Queue"), MovedModule("reprlib", "repr"), MovedModule("socketserver", "SocketServer"), MovedModule("tkinter", "Tkinter"), MovedModule("tkinter_dialog", "Dialog", "tkinter.dialog"), MovedModule("tkinter_filedialog", "FileDialog", "tkinter.filedialog"), MovedModule("tkinter_scrolledtext", "ScrolledText", "tkinter.scrolledtext"), MovedModule("tkinter_simpledialog", "SimpleDialog", "tkinter.simpledialog"), MovedModule("tkinter_tix", "Tix", "tkinter.tix"), MovedModule("tkinter_constants", "Tkconstants", "tkinter.constants"), MovedModule("tkinter_dnd", "Tkdnd", "tkinter.dnd"), MovedModule("tkinter_colorchooser", "tkColorChooser", "tkinter.colorchooser"), MovedModule("tkinter_commondialog", "tkCommonDialog", "tkinter.commondialog"), MovedModule("tkinter_tkfiledialog", "tkFileDialog", "tkinter.filedialog"), MovedModule("tkinter_font", "tkFont", "tkinter.font"), MovedModule("tkinter_messagebox", "tkMessageBox", "tkinter.messagebox"), MovedModule("tkinter_tksimpledialog", "tkSimpleDialog", "tkinter.simpledialog"), MovedModule("urllib_robotparser", "robotparser", "urllib.robotparser"), MovedModule("winreg", "_winreg"), ] for attr in _moved_attributes: setattr(_MovedItems, attr.name, attr) del attr moves = sys.modules["six.moves"] = _MovedItems("moves") def add_move(move): """Add an item to six.moves.""" setattr(_MovedItems, move.name, move) def remove_move(name): """Remove item from six.moves.""" try: delattr(_MovedItems, name) except AttributeError: try: del moves.__dict__[name] except KeyError: raise AttributeError("no such move, %r" % (name,)) if PY3: _meth_func = "__func__" _meth_self = "__self__" _func_code = "__code__" _func_defaults = "__defaults__" _iterkeys = "keys" _itervalues = "values" _iteritems = "items" else: _meth_func = "im_func" _meth_self = "im_self" _func_code = "func_code" _func_defaults = "func_defaults" _iterkeys = "iterkeys" _itervalues = "itervalues" _iteritems = "iteritems" try: advance_iterator = next except NameError: def advance_iterator(it): return it.next() next = advance_iterator if PY3: create_bound_method = types.MethodType def get_unbound_function(unbound): return unbound Iterator = object def callable(obj): return any("__call__" in klass.__dict__ for klass in type(obj).__mro__) else: def create_bound_method(function, instance): return types.MethodType(function, instance, instance.__class__) def get_unbound_function(unbound): return unbound.im_func class Iterator(object): def next(self): return type(self).__next__(self) callable = callable _add_doc(get_unbound_function, """Get the function out of a possibly unbound function""") get_method_function = operator.attrgetter(_meth_func) get_method_self = operator.attrgetter(_meth_self) get_function_code = operator.attrgetter(_func_code) get_function_defaults = operator.attrgetter(_func_defaults) def iterkeys(d): """Return an iterator over the keys of a dictionary.""" return iter(getattr(d, _iterkeys)()) def itervalues(d): """Return an iterator over the values of a dictionary.""" return iter(getattr(d, _itervalues)()) def iteritems(d): """Return an iterator over the (key, value) pairs of a dictionary.""" return iter(getattr(d, _iteritems)()) if PY3: def b(s): return s.encode("latin-1") def u(s): return s if sys.version_info[1] <= 1: def int2byte(i): return bytes((i,)) else: # This is about 2x faster than the implementation above on 3.2+ int2byte = operator.methodcaller("to_bytes", 1, "big") import io StringIO = io.StringIO BytesIO = io.BytesIO else: def b(s): return s def u(s): return unicode(s, "unicode_escape") int2byte = chr import StringIO StringIO = BytesIO = StringIO.StringIO _add_doc(b, """Byte literal""") _add_doc(u, """Text literal""") if PY3: import builtins exec_ = getattr(builtins, "exec") def reraise(tp, value, tb=None): if value.__traceback__ is not tb: raise value.with_traceback(tb) raise value print_ = getattr(builtins, "print") del builtins else: def exec_(code, globs=None, locs=None): """Execute code in a namespace.""" if globs is None: frame = sys._getframe(1) globs = frame.f_globals if locs is None: locs = frame.f_locals del frame elif locs is None: locs = globs exec("""exec code in globs, locs""") exec_("""def reraise(tp, value, tb=None): raise tp, value, tb """) def print_(*args, **kwargs): """The new-style print function.""" fp = kwargs.pop("file", sys.stdout) if fp is None: return def write(data): if not isinstance(data, basestring): data = str(data) fp.write(data) want_unicode = False sep = kwargs.pop("sep", None) if sep is not None: if isinstance(sep, unicode): want_unicode = True elif not isinstance(sep, str): raise TypeError("sep must be None or a string") end = kwargs.pop("end", None) if end is not None: if isinstance(end, unicode): want_unicode = True elif not isinstance(end, str): raise TypeError("end must be None or a string") if kwargs: raise TypeError("invalid keyword arguments to print()") if not want_unicode: for arg in args: if isinstance(arg, unicode): want_unicode = True break if want_unicode: newline = unicode("\n") space = unicode(" ") else: newline = "\n" space = " " if sep is None: sep = space if end is None: end = newline for i, arg in enumerate(args): if i: write(sep) write(arg) write(end) _add_doc(reraise, """Reraise an exception.""") def with_metaclass(meta, base=object): """Create a base class with a metaclass.""" return meta("NewBase", (base,), {}) circuits-2.1.0/circuits/__init__.py0000644000014400001440000000152312113343751017027 0ustar prologicusers# Package: circuits # Date: 3rd October 2008 # Author: James Mills, prologic at shortcircuit dot net dot au """Lightweight Event driven and Asynchronous Application Framework circuits is a **Lightweight** **Event** driven and **Asynchronous** **Application Framework** for the `Python Programming Language`_ with a strong **Component** Architecture. :copyright: CopyRight (C) 2004-2012 by James Mills :license: MIT (See: LICENSE) .. _Python Programming Language: http://www.python.org/ """ __author__ = "James Mills" __date__ = "24th February 2013" __version__ = "2.1.0" from circuits.core import Task, Worker from circuits.core import Debugger, Bridge, Loader, Manager, Timer from circuits.core import BaseEvent, DerivedEvent, Event, LiteralEvent from circuits.core import handler, reprhandler, BaseComponent, Component # flake8: noqa circuits-2.1.0/CHANGES.rst0000644000014400001440000005347712113343751014712 0ustar prologicuserscircuits-2.1.0 20130224 () ----------------------------------- Features ........ - Added IPv6 Support [#39987887] - Document and Comment all Examples [#40112459] - Update WebSockets dispatcher in circuits.web [40064247] - Component Event Handlers Property [#41573841] - Component targeting performance [#41644031] - Multi-App WSGI Gateway [#40071339] - More efficient timer implementation [#43700669] Bugs .... - Fix the broken links in the Users page [#40063597] - circuits.tools.inspect shows incorrect ticks [#41650961] - Race Condition with call/wait primitives [#41643711] - RESTful Dispatcher [#41643773] - Fix Component instance targeting [#41644025] - Worker Processes [#41643831] - Make examples/web/sslserver.py work again [42007509] - Value instance in body [43287263] Chores ...... - Import shadowing in manager.py [#41644023] - Run the codebase through flake8 [#41651093] - URL Quoting Unit Test [#41882655] - SSL Unit Test [#42849393] - Python 3.x Support [43027337] - Fill out FAQ in Docs [#43389199] - Write Developer Docs [#43389193] Other Changes ............. A list of other changes we forgot to track :) - Fixed latency timing for circuits.bench on win32 - Updated the URL for ReadTheDocs - Updated the Getting Started / Downloading documentation to say something about the Tags tab for downloading archives. - Removed unused import in ``circuits.app.env`` - Added some documentation about how HTTP requests are handled. - Removed unused code - A simple chat server implementation (Examples) - Fixed a bug with Manager.processTasks and Error event firing. handler was not being set correctly - Fixes wrong variable names in sockets.py - Fixed an UnboundLocalError bug - Expect the original method to be passed as input to ``Manager.removeHandler`` ``Manager.addHandler`` now returns a reference to the original method. - Guard against a None _sock or non-existent _sock object. - Allow a custom host, port and secure option to be passed to the connect event handler of circuits.web.client.Client - Redesigned tests/web/conftest.py with newer pytest APIs using ``@pytest.fixture(...)`` - Experimental new Watcher/Manager fixtures - Docs for Fallback generator - Removing the concept of _ticks, @tick and friends - Fixes timers - Reimplemented circuits.io.File as per circuits.net.sockets - Re-implemented Notify Component and fixed test - Reworked Notifier Component to be more async friendly - Fixed a bug with the repr of Manager and thus Components with non-str channels. eg: (1, 1) - Added a unit test for generate_events handler - Fixed terminal example demonstrating Streaming with circuits.web - Fixed index page for terminal web example - Added an Open event to File - Fixed a bug with the static dispatcher for circuits.web whereby the path was not being unquoted - Fixed a bug with the static circuits.web dispatcher whereby directory listing did not quote urls - Added simple examples demonstrating circuits' primitives - Added example of .fire(...) primitive - Restructured circuits.io and implemented circuits.io.Process with unit test - Added Hello World example - Made components started in process mode not link by default. Have to explicitly set the kwarg ``link=component_instance``. - Fixed raising of ``SystemExit`` or ``KeyboardInterrupt``. - Modified the way caching works with the Static dispatcher - Brought back the ``circuits.core.bridge.Bridge``. With it better inter-process communications via high-speed full duplex pipes using ``circuits.net.sockets.Pipe`` (UNIX Only), a much simpler API. In addition, a change to the way Value Notification works. .notify of an event instance can either be True or a channel to send the ValueChanged event to. - Added timers examples resurrected from old circuits - Global handlers and component targeting Global handlers would be ignored when using component targeting. This patch considers them. To do this, we have added an extra property to managers. You can use traverse_children_handlers to increase performance when you have a huge number of components. Put the components that are only meant to be used with component targeting under a single component. The hierarchy looks like this: .. code-block:: python Root -> Umbrella Component -> Component 1, Component 2, Component 3, ... -> Debugger() -> etc - Set Umbrella Component traverse_children_handlers to false to prevent traversing the huge number of children components. - Fixed Connection header interpretation. - Updated documentation for WebSocket. - Removed pool - covered by worker - Fixed dispatchers return value. - Firing Connect event when a web socket connection is established to make behavior look even more like ordinary sockets. - Nuked ``@future`` decorator due to pickling problems for processes. - Allow coroutine-style tasks to terminate the system via raise of ``SystemExit`` or ``KeyboardInterrupt`` - Dropping events unnoticed when waiting is definitely a bad idea. Fixed. - Clarification on implementing a GenerateEvents handler. - Optimized GenerateEvents handling. - Optimized management of FallbackGenerator. - Fixed a problem with events being out of sequence when _fire is called recursively. The fix exposes a problem with conftest.Waiter (events getting lost because they are produced too fast, therefore queue is increased). Reducing production rate will be in next commit. - Small fix for new event queue handling. - Fixed problem with handler cache update and concurrent event handling/structure changes. This happens e.g. in unit tests when the app is started and the test program adds or removes components concurrently. - Optimized/clarified GenerateEvents implementation. - One more concurrency problem fixed. - Fixed generate events handler. - Fixed bug with handler cache being always invalidated. Avoid ``stop()`` acting as concurrent thread on ``_dispatcher()`` - Fixed payload length calculation in web sockets protocol. - Some very small - but measurable - performance improvements. Checking them in mainly because now no one else needs to think about whether they have an effect. - Fixed IPv6 socket tests for OSX and badly configured IPv6 networks - Fixed ready handler for test_node - Re-added an old revived example of an IRC Client integrating the urwid curses library for the interface - Added an example of using yield to perform cooperative multi-tasking inside a request event handler - Uses echo for test_process - Fixes process stdout/stderr handling Process was not waiting for all output from a process to have been processed and resulted sometimes some of the process output being lost while stopping. - Added a fall back error handler, so problems aren't discarded silently any more. - Fixed a TypeError being raised in the request handler for WebSockets dispatcher - Prevent the underlying TCPClient connect handler from inadvertently being triggered by connect events being fired to the web client - Added tox configuration file. Just run: ``tox`` - Configure tox to output junitxml - Fixed the logic of path -> wsgi dispatching in Gateway - Fixed an awful bug with wrappers.Response whereby a default Content-Type was always set regardless and didn't allow anything else to set this. - Fixed test_disps so it doesn't use an existing port that's in use. - Added a missing piece of WSGI 1.0 functionality for wsgi.Gateway. The ``write()`` callable - Rewrite test_filer unit test. Ensured EOF event is not triggered for files opened in a or + modes. - Added simple examples demonstrating circuits' primitives - Added example of .fire(...) primitive - Restructured circuits.io and implemented circuits.io.Process with unit test - Forgot to add test_process unit test - Added Hello World example - Fixed event handler for generate_events - Implemented multiprocessing support with communication via full duplex pipes. Fixed worker processes and added unit test - Made components started in process mode not link by default. Have to explicitly set the kwarg link=True - Fixed process pools and added unit test - Fixed name of method for handling inotify events - conflicting with ._process of Manager/Component - Renamed ._process to .__process so as to not conflict with Worker - Fixed raising of SystemExit or KeyboardInterrupt - Trying to fix sending/receiving of events and their values - Fixed IPv6 address evaluation. - WebSockets reimplemented as specified by RFC 6455. - Modified the way caching works with the Statis dispatcher and serve_file(...) function. Set Last-Modified instead of a large Expires header. - Marked as a Missing Feature - still being worked on. - Brought back the ``circuits.core.bridge.Bridge``. With it better inter-process communications via high-speed full duplex pipes using ``circuits.net.sockets.Pipe`` (UNIX Only), a much simpler API. In addition, a chnage to the way Value Notification works. .notify of an event instance can either be True or a channel to send the ValueChanged event to. - Causes errors. Wrong thing to do here. - Use uuid4 for worker channels. - Removed left over debugging code - Added capability of components started in proces mode to link to artbritrary managers other than themselves (if link=True) - Added unit test for testing a component in process mode linked with another parent system separately - Added timers examples ressurected from old circuits - Thread safety for watcher - Reverts test_component_targeting.py - Fixed Connection header interpretation. - Updated documentation for WebSocket. - Changed the way process linking works by not starting the parent in thread mode. - Fixes watcher test fixture - Implemented .handlers() and re-implemented .handles(). [Delivers #41573841] - Removed superfluous bridge test - Fixed usage of .start starting Workers in process mode - Better internal variable name - Start worked either when the system starts or we are regsitered to an already started system - Implemented .handlers() correctly - Set unique channels for the Pipe and Bridge when briding processes - Removed. Going to reimplement all this - Don't cause a nastry fork bomb\! - Marked test_process_pool as skipping XXX: Broken Functionality - Fixed sleeping when nothing to do adding needs_resume logic to the pollers - Proposed new Worker Component -- wrapping multiprocessing.Process - Accidentla commit - Trying to re-implement Pool... - Marked some tests as broken - Added support for both Process and Thread in Worker component with same API. - Reverted changes to the task handler for Worker - Removed .resume() - Fixed some brokeness in future - Trying to make @future work with Worker in process mode - Lock bench - Switches worker to apply_async - Allow the poller to sleep when tasks are running - Use ThreadPool for worker threads - Cleaned up Worker - benchmark only branch - Removed pool - covered by worker - Workaround for Threadpool bug started from secondary threads - Fixed dispatchers return value. - Firing Connect event when a web socket connection is established to make behavior look even more like ordinary sockets. - Restored 2.0.1 GenerateEvents handling with minor enhancements to get things working again. - Nuked @future decotator due to pickling problems for processes. - Unmarked test as failing. Test now passes prefectly - Allow coroutine-style tasks to terminate the system via raise of SystemExit or KeyboardINterrupt - Fixed SSL support for circuits.web [Delivers #42007509] - Dropping events unnoticed when waiting is definitely a bad idea. Fixed. - Clarification on implementing a GenerateEvents handler. - Added missing import (timed wait with FallBackGenerator cannot have worked for some time). - Optimized GenerateEvents handling. - Backed out of changeset 3413:98d0056ef18a - Optimized management of FallbackGenerator. - Fixed a problem with events being out of sequence when _fire is called recursively. The fix exposes a problem with conftest.Waiter (events getting lost because they are produced too fast, therefore queue is increased). Reducing production rate will be in next commit. - Small fix for new event queue handling. - Fixed problem with handler cache update and concurrent event handling/structure changes. This happens e.g. in unit tests when the app is started and the test program adds or removes components concurrently. - Optimized/clarified GenerateEvents implementation. - One more concurrency problem fixed. - Fixed generate events handler. - Fixed bug with handler cache being always invalidated. Avoid stop() acting as concurrent thread on _dispatcher(). - Added unit test for url quoting of static files for the static circuits.web dispatcher. [Delivers #41882655] - Added unit test for secure circutis.web server. [Delivers #42849393] - Fixed creation/registration/location of poller upon startup or registration - Skip test_secure_server if ssl is not available - Fixed payload length calculation in web sockets protocol. - Some very small - but measurable - performance improvements. Checking them in mainly because now no one else needs to think about whether they have an effect. - Fixed conflicting attribute. - Added new .pid property to Manager fixing tests.core.test_bridge - Broken by 70677b69bf05 - Fixed ipv6 socket tests for OSX and badly configured IPv6 networks - Ugly fix for this test - Fixed ready handler for test_node - For some reason removing max_events in the Watcher fixture for esting purposes fixes some tests on OSX - Small sample to hopefully test for memory leaks :) - Improved .handlers() to recursively return handlers of it's subclasses whilst filtering out private handlers (_.*) - Use BaseComponent for convenience for non-handler methods - Return a list of all handlers except handlers listneing to private events - Left over print - oops :) - Moved to examples/ - Re-added an old revived example of an IRC Client integrating the urwid curses library for the interface - Improved comment. - Added multi-add support for Gateway web compnoent [Delivers #40071339] - Fixed Python 3 compatibility for retrieving the .resumse() method. Fixes Issue #35 - Removed unused StringIO import - A bunch of Python 3.1 compatibility fixes (mostly import fixes) - Added an example of using yield to perform cooperative multi-tasking inside a request event handler - Uses echo for test_process - Fixes process stdout/stderr handling Process was not waiting for all output from a process to have been processed and resulted sometimes some of the process output being lost while stopping. - A bunch more Python 3 fixes. Using the six module here. - Added a fall back error handler, so problems aren't discarded silently any more. - Ooops accidently committed this - Fixed some Python 3 import issues - More Python 3 fixes - Fixed Python 3 issue with iterators - Use range for Python 3 compatibility - Fixed assertions for Python 3 compat - Accidently commited a test with Debugger - Fixed value_changed handler to check correctly for binary types (Python 3 fixes) - Python 3 fixes for string type checks - Refactored for Python 3 - More Python 3 fixes. Marked the rest as Broken on Python 3 - Fixed broken web tests for Python 3 by wrapping the request body in a TextIOWrapper for FieldStorage - Fixed XML and JSON RPC Dispatchers for Python 3 - Replace .has_key() with in for Python 3 compatibility - Fixed a TypeError being raised in the request handler for websockets dispatcher - Prevent the underlying TCPClient connect handler from inadvertently being triggered by connec events being fired to the web client - Unmarked as skipping. No longer broken on Python 3 - Finished cleaning up my code base. - Removed some debugging junk I had forgotten to get rid of. - Fixed File for Python 3 support adding optional encoding support - Fixed Process for Python 3 - Ooops :/ - Fixed test_logger_Error for Python 3 - Fixed Bridge for Python 3 - Fixed Node for Python 3 - Added pytest.PYVER and Marked test_secure_server web test as Broken on Python 3.2 (needs fixing) - Marked a bunch of 3.2 and 3.3 specific tests that are broken with these versions (needs looking into) - Removed Broken on Python 3 marked - these tests now pass on 3.1 3.2 and 3.3 - Fixed SSL Sockets for Python 3.2/3.3 (Should do_handshake() be executed in a thread?) - Added tox configuration file. Just run: run - Configure tox to output junitxml - Fixed tox configuration - Assuming localhost was incorrect. Sorry Mark :/ - Fixed test_logger for pypy - Backed out changeset 7be64d8b6f7c - Reconfigured tox settings - Hopefully fixed tox.ini to detect jenkins - Fixed tox.ini to work on jenkins (can't seem to auto detect jenkins :/) - Added tox config for checking documetnation - Changed the output filename of xml resutls for docs env (tox) - Added pytest-cov as a dep to the docs env (tox) - Configured coverage to output xml output - Removed ptest-cov dep from docs env (tox) - Trying to fix the randomly failing test_node test. - Ooops broke wait_for - fixed hopefully - Backed out changeset 795712654602 - Backed out changeset 1ee04d5fb657 - Added ignore for generated junitxml output files - Hopefully an improved unit test for node using the manager and watcher fixtures. - Updated with supported version of Python - Fixed the logic of path -> wsgi dispatching in Gateway - Fixed an awful bug with wrappers.Response whereby a default Content-Type was always set regardless and didn't allow anything else to set this. - Fixed test_disps so it doesn't use an existing port that's in use. - Added a missing piece of WSGI 1.0 functionality for wsgi.Gateway -- The write() callable - Write bytes in this test - Correctly handle unicode (I think) - Fixed a bug with null responses from WSGI Applications hosted by wsgi.Gateway. Empty class did not implement __nonzero__ for Python 2.x [Delivers #43287263] - Remvoed pyinotify dep from tox config so Windows tests can run - Skip test_unixserver for Windows - Skip this test on Windows - Skip these tests on Windows - Skip this test on Windows - Fixed test_tcp_bind for Windows - Updated docs and re-added FAQ from old wiki (updated slightly) [Delivers #43389199] - Fixed bottom of FAQ - Updated Change Log [#42945315] - Updated Release Notes [#42945315] - Fixed list of new changes for 2.1.0 release notes - Updated Developet Docs - Bumped version to 2.1.0 - More resource efficient timer implementation [Delivers #43700669]. - Fixed a problem with cLength being unknown if self.body == False. - Test fails on shining panda py32 only. May be a race condition (wait_for using same loop interval as timer interval). Checking in for testing. - Fixed problem with "Content-Length: 0" header not being generated for empty responses. - Backed out of changeset 3575:ece3ee5472ef, makes CI hang for unknown reason. - Hopefully finally fixed problems with timer test on CI platform. - Updated pypi classifier for circuits - Fixed random problems with opening SSL socket. - Fixed concurrence problem (doing reset() in event loop and calling unregister() concurrently). - Modified test a bit to find out what happens in CI environment (problem not reproducible in local py32). - Calling headers.setdefault twice for the same name doesn't make sense. - Adapted test case to previous fix. - Fixed problem with "Content-Length: 0" header not being generated for empty responses. - Fixed insecure usage of class variable. - Reverted to old timer implementation. Cannot find bug in new version that only occurs in CI/py32 environment (cannot be reproduced locally). - Make sure that check runs faster than timer increments. - Added missing Content-Length header (must be present according to RFC 2616). - Provide a more informative representation. - Fixed a docstring typo - Just re-raise the exception here rather than hide it with an InternalServer exception - Potential failing test for [#43885227] - Fixed problem with receiving incomplete header data (first chunk doesn't already include empty line that separates headers and body). - Fixed problem with header not being detected if a chunk ends exactly after \r\n of last header line and next chunk starts with empty line (\r\n) before body. - Fixes inconsisent semantic behavior in channel selection. - Fixed expression for _handler_channel in Manager.getHandlers(...) - Fixed (and simplified) handler_channel evaluation. - Fixed channel representation for cases where channel is a component. - Adapted prepare_unregister_complete handling to fixed semantics for using managers as channels. - Notifications are to be signaled to the given manager. Now that using managers as channels works properly, it showed that hey never were. - Value change notifications are fired using Value's manager as channel, so mke sure to listen on that. - Value's notifications are fired on its manager component -- by default the component that fired the event the value belongs to. Moved handler to proper place (is better place anyway). - Encoding is necessary for this to succeed on py3.2 (urllib2 there doesn't accept body of type str). - Added missing files to manifest. [Delivers #44650895] (Closes Issue #36) - Fixing encoding problems. - Fixing py2/py3 problem by using bytearray as abviously the only common denominator. - multipart/form-data is binary. Boundaries are ASCII, but data between boundaries may be anything (depending on part's header) - Trying to fix unicode issues - Marked test_node as Broken on Windows - Pickling Error with thread.lock - Trying to fix broken unit test on Windows - Setup docs with Google Analyitics - Marked test_tcp_connect_closed_port(...) as Broken on Windows -- Need to fix this; this test is a bit weird :/ - Marked test_tcp_reconnect(...) test as Broken on Windows - Updated state of test_tcp_reconnect(...) test on Windows -- Apparently only Broken on Windows on Python 3.2 (odd) - Fixed TypeError - Marked as Broken on pypy -- For some reason we're getting \x00 (null bytes) in the stream when using the Python std lib logger. - Marked tests.core.test_debugger.test_filename(...) as Broken on pypy -- Need to investigate this - Updated support platforms to include pypy circuits-2.1.0/setup.py0000755000014400001440000000724012113343751014610 0ustar prologicusers#!/usr/bin/env python import os from glob import glob from distutils.util import convert_path try: from setuptools import setup except ImportError: from distutils.core import setup # NOQA def find_packages(where=".", exclude=()): """Borrowed directly from setuptools""" out = [] stack = [(convert_path(where), "")] while stack: where, prefix = stack.pop(0) for name in os.listdir(where): fn = os.path.join(where, name) if ("." not in name and os.path.isdir(fn) and os.path.isfile(os.path.join(fn, "__init__.py"))): out.append(prefix + name) stack.append((fn, prefix + name + ".")) from fnmatch import fnmatchcase for pat in list(exclude) + ["ez_setup"]: out = [item for item in out if not fnmatchcase(item, pat)] return out path = os.path.abspath(os.path.dirname(__file__)) try: README = open(os.path.join(path, "README.rst")).read() RELEASE = open(os.path.join(path, "RELEASE.rst")).read() except IOError: README = RELEASE = "" setup( name="circuits", version="2.1.0", description="Asynchronous Component based Event Application Framework", long_description="%s\n\n%s" % (README, RELEASE), author="James Mills", author_email="James Mills, prologic at shortcircuit dot net dot au", url="http://bitbucket.org/prologic/circuits/", download_url="http://bitbucket.org/prologic/circuits/downloads/", classifiers=[ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Environment :: No Input/Output (Daemon)", "Environment :: Other Environment", "Environment :: Plugins", "Environment :: Web Environment", "Intended Audience :: Developers", "Intended Audience :: Information Technology", "Intended Audience :: Science/Research", "Intended Audience :: System Administrators", "Intended Audience :: Telecommunications Industry", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: POSIX :: BSD", "Operating System :: POSIX :: Linux", "Operating System :: MacOS :: MacOS X", "Operating System :: Microsoft :: Windows", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.1", "Programming Language :: Python :: 3.2", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", "Topic :: Adaptive Technologies", "Topic :: Communications :: Chat :: Internet Relay Chat", "Topic :: Communications :: Email :: Mail Transport Agents", "Topic :: Database", "Topic :: Internet :: WWW/HTTP :: HTTP Servers", "Topic :: Internet :: WWW/HTTP :: WSGI :: Application", "Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware", "Topic :: Internet :: WWW/HTTP :: WSGI :: Server", "Topic :: Software Development :: Libraries :: Application Frameworks", "Topic :: Software Development :: Libraries :: Python Modules", "Topic :: System :: Clustering", "Topic :: System :: Distributed Computing"], license="MIT", keywords="event framework distributed concurrent component asynchronous", platforms="POSIX", packages=find_packages("."), scripts=glob("scripts/*"), entry_points=""" [console_scripts] circuits.web = circuits.web.main:main """, zip_safe=False, test_suite="tests.main.runtests", ) # hghooks: no-pyflakes circuits-2.1.0/examples/0000755000014400001440000000000012113366740014711 5ustar prologicuserscircuits-2.1.0/examples/web/0000755000014400001440000000000012113366740015466 5ustar prologicuserscircuits-2.1.0/examples/web/wsgi.py0000755000014400001440000000042612113343751017013 0ustar prologicusers#!/usr/bin/env python from circuits.web import wsgi from circuits.web import BaseServer def application(environ, start_response): start_response("200 OK", [("Content-Type", "text/plain")]) return ["Hello World!"] (BaseServer(8000) + wsgi.Gateway(application)).run() circuits-2.1.0/examples/web/tpl/0000755000014400001440000000000012113366740016265 5ustar prologicuserscircuits-2.1.0/examples/web/tpl/index.html0000644000014400001440000000117212072034467020265 0ustar prologicusers<%inherit file="base.html"/>

          Example of using circuits and its Web Components to build a simple web application that handles some basic form data.

          % if message:
          ${message}
          % endif
          First Name:
          Last Name:
          circuits-2.1.0/examples/web/tpl/base.html0000644000014400001440000000176212072034467020075 0ustar prologicusers Basic Templating
          ${self.body()}
          circuits-2.1.0/examples/web/counter.py0000755000014400001440000000247512113343751017527 0ustar prologicusers#!/usr/bin/env python from StringIO import StringIO from uuid import uuid4 as uuid from circuits import handler from circuits.io import File, Write, Close from circuits.web import Server, Controller class Root(Controller): def index(self): f = File("counter.txt", "r", channel=uuid()).register(self) yield self.wait("ready", f.channel) buffer = StringIO() def on_read(self, data): buffer.write(data) on_read_handler = self.addHandler( handler("read", channel=f.channel)( on_read ) ) #yield self.wait("opened", f.channel) yield self.wait("eof", f.channel) self.removeHandler(on_read_handler) try: n = int(buffer.getvalue()) + 1 except ValueError: n = 1 f.unregister() yield self.wait("unregistered", f.channel) f = File("counter.txt", "w", channel=uuid()).register(self) yield self.wait("ready", f.channel) self.fire(Write("{0:d}".format(n)), f.channel) yield self.wait("write", f.channel) self.fire(Close(), f.channel) yield self.wait("closed", f.channel) yield "You are visitor: {0:d}".format(n) from circuits import Debugger (Server(("0.0.0.0", 8000)) + Root() + Debugger()).run() circuits-2.1.0/examples/web/wsgiapp.py0000755000014400001440000000033112113343751017507 0ustar prologicusers#!/usr/bin/env python from circuits.web import Controller from circuits.web.wsgi import Application class Root(Controller): def index(self): return "Hello World!" application = Application() + Root() circuits-2.1.0/examples/web/wiki/0000755000014400001440000000000012113366740016431 5ustar prologicuserscircuits-2.1.0/examples/web/wiki/tpl/0000755000014400001440000000000012113366740017230 5ustar prologicuserscircuits-2.1.0/examples/web/wiki/tpl/edit.html0000644000014400001440000000224312072034467021046 0ustar prologicusers Editing %(title)s
          circuits-2.1.0/examples/web/wiki/tpl/view.html0000644000014400001440000000171512072034467021076 0ustar prologicusers %(title)s
          %(text)s
          Edit
          circuits-2.1.0/examples/web/wiki/defaultpages/0000755000014400001440000000000012113366740021075 5ustar prologicuserscircuits-2.1.0/examples/web/wiki/defaultpages/SiteMenu0000644000014400001440000000006412072034467022553 0ustar prologicusers* [[FrontPage|Home]] * [[CheatSheet]] * [[SandBox]] circuits-2.1.0/examples/web/wiki/defaultpages/RenderedPre0000644000014400001440000000005212072034467023216 0ustar prologicusers{{{ == [[Nowiki]]: //**don't format// }}} circuits-2.1.0/examples/web/wiki/defaultpages/Macros0000644000014400001440000000002712072034467022245 0ustar prologicusers= Macros = <> circuits-2.1.0/examples/web/wiki/defaultpages/BulletList0000644000014400001440000000005012072034467023100 0ustar prologicusers* Bullet list * Second item ** Sub item circuits-2.1.0/examples/web/wiki/defaultpages/CheatSheet0000644000014400001440000000447412072034467023050 0ustar prologicusers= Cheat Sheet = |= Wiki |= Rendered |= Source |##{{{//italics//}}}## |//italics// |<>//italics//<> |##{{{**bold**}}}## |**bold** |<>**bold**<> |##{{{^^super^^script}}}## |^^super^^script |<>^^super^^script<> |##{{{,,sub,,script}}}## |,,sub,,script |<>,,sub,,script<> |##{{{##monospace##}}}## |##monospace## |<>##monospace##<> |<> |<> |<> |<> |<> |<> |<> |<> |<> |<> |<> |<> |##Link to ~[[WikiPage]]## |Link to [[WikiPage]] |<
          >
          Link to WikiPage
          <
          > |##{{{[[http://google.com|Google]]}}}## |[[http://google.com|Google]]|<>[[http://google.com|Google]]<> |<> |<> |<> |<> |<> |<> |##Force~\\linebreak## |Force\\linebreak |<>Force\\linebreak<> |<> |<> |<> |##{{{{{Image.jpg|Cod}}}}}## |{{Image.jpg|Cod}} |<>{{Image.jpg|Cod}}<> |<> |<> |<> |<> |<> |<> |<> |<> |<> |{{{use a tilde to ~**escape}}} |use a tilde to ~**escape |<>use a tilde to ~**escape<> |##{{{<>a //simple// macro<>}}}##|<>a //simple// macro<>|<
          >
          a simple macro
          <
          > circuits-2.1.0/examples/web/wiki/defaultpages/NoLineBreak0000644000014400001440000000003512072034467023151 0ustar prologicusersNo linebreak! Use empty row circuits-2.1.0/examples/web/wiki/defaultpages/MixedList0000644000014400001440000000006012072034467022720 0ustar prologicusers# Mixed list ** Sub bullet item # Numbered item circuits-2.1.0/examples/web/wiki/defaultpages/HorizontalLine0000644000014400001440000000002612072034467023761 0ustar prologicusersHorizontal line: ---- circuits-2.1.0/examples/web/wiki/defaultpages/HeadingsPage0000644000014400001440000000006712072034467023344 0ustar prologicusers== Large heading === Medium Heading ==== Small heading circuits-2.1.0/examples/web/wiki/defaultpages/Indented0000644000014400001440000000006512072034467022555 0ustar prologicusers> Indented regions\\ > can include >> block elements circuits-2.1.0/examples/web/wiki/defaultpages/SandBox0000644000014400001440000000016212072034467022357 0ustar prologicusers= The Sand Box = This is just a page to practice and learn [[WikiFormatting]]. Go ahead, edit it freely. ---- circuits-2.1.0/examples/web/wiki/defaultpages/RenderedTable0000644000014400001440000000005712072034467023524 0ustar prologicusers|=|=table|=header| |a|table|row| |b|table|row| circuits-2.1.0/examples/web/wiki/defaultpages/FrontPage0000644000014400001440000000301012072034467022701 0ustar prologicusers= Front Page = Welcome to the simple [[http://bitbucket.org/prologic/circuits/|circuits.web]] wiki engine in < 100 lines of code!!!! This little demo wiki makes use of the following software/library: * [[http://www.python.org|Python]] D'uh :) * [[http://bitbucket.org/prologic/circuits/|circuits]] -- circuits.web * [[http://code.google.com/p/creoleparser/|creoleparser]] -- wiki parser * [[http://sqlite.org|SQLite]] -- wiki database * [[http://genshi.edgewall.org/|genshi]] -- used by creoleparser and macros * [[http://pygments.org/|pygments]] -- used by code macro for highlighting This is the simplest, most concise demonstration of quite a number of the features of the [[http://bitbucket.org/prologic/circuits/|circuits.web]] web framework as well as the smallest (//without resorting to obfuscation//). This wiki engine also fully supports macros and a list of available macros can be found here: [[Macros]] For help with wiki syntax see the [[CheatSheet]] page. THe entire source code to this wiki can be found on the [[http://bitbucket.org/prologic/circuits/|circuits]] project home page here: http://bitbucket.org/prologic/circuits/src/tip/examples/web/wiki/ Try the [[SandBox]] :) **NB**: This circuits.web wiki demo is not a complete wiki engine and lacks some rather basic wiki features such as history and recent changes. For a more complete wiki engine please see the [[http://bitbucket.org/prologic/sahriswiki/|sahriswiki]] project. Enjoy! --[[http://prologic.shortcircuit.net.au|JamesMills]] circuits-2.1.0/examples/web/wiki/defaultpages/NumberedList0000644000014400001440000000005212072034467023414 0ustar prologicusers# Numbered list # Second item ## Sub item circuits-2.1.0/examples/web/wiki/defaultpages/DefinitionList0000644000014400001440000000003712072034467023746 0ustar prologicusers; Definition List : Definition circuits-2.1.0/examples/web/wiki/macros/0000755000014400001440000000000012113366740017715 5ustar prologicuserscircuits-2.1.0/examples/web/wiki/macros/include.py0000644000014400001440000000237312072034467021721 0ustar prologicusers"""Include macros Macros for inclusion of other wiki pages """ from genshi import builder def include(macro, environ, pagename=None, *args, **kwargs): """Return the parsed content of the page identified by arg_string""" if pagename is None: return None db = environ["db"] page = db.get(pagename, None) if page is not None: environ["page.name"] = pagename return environ["parser"].generate(page, environ=environ) def include_raw(macro, environ, pagename=None, *args, **kwargs): """Return the raw text of the page identified by arg_string, rendered in a 
           block.
    """

    if pagename is None:
        return None

    db = environ["db"]
    page = db.get(pagename, None)

    if page is not None:
        return builder.tag.pre(page, class_="plain")

def include_source(macro, environ, pagename=None, *args, **kwargs):
    """Return the parsed text of the page identified by arg_string, rendered
    in a 
           block.
    """

    if pagename is None:
        return None

    db = environ["db"]
    page = db.get(pagename, None)

    if page is not None:
        environ["page.name"] = pagename

        return builder.tag.pre(environ["parser"].render(page,
            environ=environ).decode("utf-8"))
circuits-2.1.0/examples/web/wiki/macros/html.py0000644000014400001440000000515412072034467021242 0ustar  prologicusers"""HTML macros

Macros for generating snippets of HTML.
"""

import genshi
import pygments
import pygments.util
import pygments.lexers
import pygments.formatters
from genshi import builder
from genshi.filters import HTMLSanitizer

sanitizer = HTMLSanitizer()

def pre(macro, environ, *args, **kwargs):
    """Return the raw text of body, rendered in a 
           block.
    
    **Arguments:** //None//

    **Example:**
    {{{
    <
          >
    def hello():
        print "Hello World!"

    hello()
    <
          >
    }}}
    """
    
    if macro.body is None:
        return None

    return builder.tag.pre(macro.body)

def code(macro, environ, *args, **kwargs):
    """Render syntax highlighted code"""
    
    if not macro.body:
        return None

    lang = kwargs.get("lang", None)

    if lang is not None:
        if not macro.isblock:
            return None
        try:
            lexer = pygments.lexers.get_lexer_by_name(lang, stripall=True)
        except pygments.util.ClassNotFound:
            return None
    else:
        lexer = None

    if lexer:
        text = pygments.highlight(macro.body, lexer,
                pygments.formatters.HtmlFormatter())
        output = genshi.core.Markup(text)
    elif macro.isblock:
        output = genshi.builder.tag.pre(macro.body)
    else:
        output = genshi.builder.tag.code(macro.body,
                style="white-space:pre-wrap", class_="highlight")

    return output

def source(macro, environ, *args, **kwargs):
    """Return the parsed text of body, rendered in a 
           block."""
    
    if macro.body is None:
        return None

    return builder.tag.pre(environ["parser"].render(
        macro.body, environ=environ).decode("utf-8"))

def div(macro, environ, cls=None, float=None, id=None, style=None,
        *args, **kwargs):

    if macro.body is None:
        return None

    if float and float in ("left", "right"):
        style = "float: %s; %s" % (float, style)

    if style:
        style = ";".join(sanitizer.sanitize_css(style))

    if macro.isblock:
        context = "block"
    else:
        context = "inline"

    contents = environ["parser"].generate(
            macro.body, environ=environ, context=context)

    return builder.tag.div(contents, id=id, class_=cls, style=style)

def span(macro, environ, class_=None, id=None, style=None, *args, **kwargs):
    """..."""

    if macro.body is None:
        return None

    if style:
        style = ';'.join(sanitizer.sanitize_css(style))

    contents = environ['parser'].generate(
            macro.body, environ=environ, context='inline')

    return builder.tag.span(contents, id=id, class_=class_,style=style)
circuits-2.1.0/examples/web/wiki/macros/wiki.py0000644000014400001440000000027112072034467021234 0ustar  prologicusers"""Wiki macros"""

from genshi import builder

def title(macro, environ, *args, **kwargs):
    """Return the title of the current page."""

    return builder.tag(environ["page.name"])
circuits-2.1.0/examples/web/wiki/macros/__init__.py0000644000014400001440000000274112072034467022034 0ustar  prologicusers"""Macro

Macro support and dispatcher
"""

import os
from inspect import getmembers, getmodule, isfunction

from creoleparser import parse_args

class Macro(object):

    def __init__(self, name, arg_string, body, isblock):
        super(Macro, self).__init__()

        self.name = name
        self.arg_string = arg_string
        self.body = body
        self.isblock = isblock

def dispatcher(name, arg_string, body, isblock, environ):
    if name in environ["macros"]:
        macro = Macro(name, arg_string, body, isblock)
        args, kwargs = parse_args(arg_string)
        try:
            return environ["macros"][name](macro, environ, *args, **kwargs)
        except Exception, e:
            return "ERROR: Error while executing macro %r (%s)" % (name, e)
    else:
        return "Macro not found!"

def loadMacros():
    path = os.path.abspath(os.path.dirname(__file__))
    p = lambda x: os.path.splitext(x)[1] == ".py"
    modules = [x for x in os.listdir(path) if p(x) and not x == "__init__.py"]

    macros = {}

    for module in modules:
        name, _ = os.path.splitext(module)

        moduleName = "%s.%s" % (__package__, name)
        m = __import__(moduleName, globals(), locals(), __package__)

        p = lambda x: isfunction(x) and getmodule(x) is m
        for name, function in getmembers(m, p):
            name = name.replace("_", "-")
            try:
                macros[name] = function
            except Exception:
                continue

    return macros
circuits-2.1.0/examples/web/wiki/macros/utils.py0000644000014400001440000000050712072034467021433 0ustar  prologicusers"""Utils macros

Utility macros
"""

from inspect import getdoc

def macros(macro, environ, *args, **kwargs):
    """Return a list of available macros"""

    macros = environ["macros"].items()
    s = "\n".join(["== %s ==\n%s\n" % (k, getdoc(v)) for k, v in macros])

    return environ["parser"].generate(s, environ=environ)
circuits-2.1.0/examples/web/wiki/static/0000755000014400001440000000000012113366740017720 5ustar  prologicuserscircuits-2.1.0/examples/web/wiki/static/css/0000755000014400001440000000000012113366740020510 5ustar  prologicuserscircuits-2.1.0/examples/web/wiki/static/css/pygments.css0000644000014400001440000000623112072034467023074 0ustar  prologicusers.hll { background-color: #ffffcc }
.c { color: #408090; font-style: italic } /* Comment */
.err { border: 1px solid #FF0000 } /* Error */
.k { color: #007020; font-weight: bold } /* Keyword */
.o { color: #666666 } /* Operator */
.cm { color: #408090; font-style: italic } /* Comment.Multiline */
.cp { color: #007020 } /* Comment.Preproc */
.c1 { color: #408090; font-style: italic } /* Comment.Single */
.cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.gd { color: #A00000 } /* Generic.Deleted */
.ge { font-style: italic } /* Generic.Emph */
.gr { color: #FF0000 } /* Generic.Error */
.gh { color: #000080; font-weight: bold } /* Generic.Heading */
.gi { color: #00A000 } /* Generic.Inserted */
.go { color: #303030 } /* Generic.Output */
.gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
.gs { font-weight: bold } /* Generic.Strong */
.gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.gt { color: #0040D0 } /* Generic.Traceback */
.kc { color: #007020; font-weight: bold } /* Keyword.Constant */
.kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
.kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
.kp { color: #007020 } /* Keyword.Pseudo */
.kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
.kt { color: #902000 } /* Keyword.Type */
.m { color: #208050 } /* Literal.Number */
.s { color: #4070a0 } /* Literal.String */
.na { color: #4070a0 } /* Name.Attribute */
.nb { color: #007020 } /* Name.Builtin */
.nc { color: #0e84b5; font-weight: bold } /* Name.Class */
.no { color: #60add5 } /* Name.Constant */
.nd { color: #555555; font-weight: bold } /* Name.Decorator */
.ni { color: #d55537; font-weight: bold } /* Name.Entity */
.ne { color: #007020 } /* Name.Exception */
.nf { color: #06287e } /* Name.Function */
.nl { color: #002070; font-weight: bold } /* Name.Label */
.nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
.nt { color: #062873; font-weight: bold } /* Name.Tag */
.nv { color: #bb60d5 } /* Name.Variable */
.ow { color: #007020; font-weight: bold } /* Operator.Word */
.w { color: #bbbbbb } /* Text.Whitespace */
.mf { color: #208050 } /* Literal.Number.Float */
.mh { color: #208050 } /* Literal.Number.Hex */
.mi { color: #208050 } /* Literal.Number.Integer */
.mo { color: #208050 } /* Literal.Number.Oct */
.sb { color: #4070a0 } /* Literal.String.Backtick */
.sc { color: #4070a0 } /* Literal.String.Char */
.sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.s2 { color: #4070a0 } /* Literal.String.Double */
.se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
.sh { color: #4070a0 } /* Literal.String.Heredoc */
.si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
.sx { color: #c65d09 } /* Literal.String.Other */
.sr { color: #235388 } /* Literal.String.Regex */
.s1 { color: #4070a0 } /* Literal.String.Single */
.ss { color: #517918 } /* Literal.String.Symbol */
.bp { color: #007020 } /* Name.Builtin.Pseudo */
.vc { color: #bb60d5 } /* Name.Variable.Class */
.vg { color: #bb60d5 } /* Name.Variable.Global */
.vi { color: #bb60d5 } /* Name.Variable.Instance */
.il { color: #208050 } /* Literal.Number.Integer.Long */
circuits-2.1.0/examples/web/wiki/static/css/screen.css0000644000014400001440000000602612072034467022507 0ustar  prologicusers* {
	margin : 0;
	padding : 0;
}

a {
	color : #437fda;
	text-decoration : none;
}
a:visited {
	color : #437fda;
	text-decoration : none;
}
a:hover {
	color : #ba8f43;
}

h2 {
	color : #343434;
	font : italic 200% sans-serif;
}
h3 {
	color : #343434;
	font : italic 160% sans-serif;
}
h4 {
	color : #343434;
	font : bold italic 110% sans-serif;
	padding : 1em 1em 0 1em;
}

html {
	color : #565656;
	font : 70%/170% sans-serif;
	text-align : justify;
}

img {
	margin : 1em 1em 0 1em;
}
img.left {
	float : left;
	margin : 1em 1em 0 0;
}
img.right {
	float : right;
	margin : 1em 0 0 1em;
}

blockquote {
	font-style : italic;
	margin : 1em 1em 0 1em;
	padding : 0 0 1em 0;
}
blockquote span {
	font-size : 200%;
	line-height : 1%;
	margin : 0 0.15em;
	position : relative;
	top : 0.25em;
}

form button {
	background : #ffffff;
	border : 1px solid #cfcfcf;
	padding : 0.25em;
	margin : 0 0 0 0.75em;
}
form input {
	border : none;
	width : 100%;
}
form textarea {
	border : none;
	width : 100%;
	height : 100%;
}
form p.button {
	text-align : right;
}
form p.input,
form p.text {
	background : #ffffff;
	border : 1px solid #cfcfcf;
	padding : 0.25em;
	margin : 0.25em 1em 0 1em;
}

p {
	padding : 1em 1em 0 1em;
}

ul,
ol {
	padding : 1em 1em 0 3em;
}

code, pre {
    font-size: 90%;
    white-space: pre-wrap;
    line-height: 1.2;
    color: #666;
    font-family: Droid Mono, DejaVu Mono, Lucida Console, Lucida Typewriter, monospace;
    background: #f7f7f7;
    border: 1px solid #d7d7d7;
    margin: 1em 1.75em;
    padding: .25em;
    overflow: auto;
}

img.smiley {
 vertical-align: baseline;
}

.wiki table {
    border: 2px solid #ccc;
    border-collapse: collapse;
    border-spacing: 0;
}

#main {
	margin : auto;
	max-width : 65em;
	min-width : 40em;
	width : auto !important;
	width : 65em;
}

#header {
	background : #2b548c url('../images/header_bg.png') repeat-x bottom left;
	padding : 6em 4em 1em 4em;
}
#header h1 {
	color : #ffffff;
	font : italic 200% sans-serif;
}

#menu {
	background : #437fda;
	border-bottom : 1px solid #2b548c;
	font : 100% sans-serif;
}
#menu ul {
	padding : 0.75em 4em;
}
#menu li {
	display : inline;
}
#menu li a {
	color : #ffffff;
	padding : 0.75em 1.5em;
}
#menu li a:hover {
	background : #2b548c;
}
#menu li.selected a {
	background : #ffffff;
	border : 1px solid #2b548c;
	border-bottom : 1px solid #ffffff;
	color : #437fda;
}
#menu li.selected a:hover {
	background : #ffffff;
	color : #ba8f43;
}

#content {
	border-bottom : 1px solid #cfcfcf;
	height : auto !important;
	height : 1%;
	overflow : hidden;
	padding : 2em 0 0 0;
}
#content div {
	padding : 0 4em 2em 4em;
}

div.left {
	left : -1em;
	float : left;
	position : relative;
	width : 50%;
}
div.right {
	left : 1em;
	float : left;
	position : relative;
	width : 50%;
}

#footer {
	font-size : 85%;
	margin : auto;
	padding : 1em 0 3em 0;
	text-align : center;
	width : 65%;
}
circuits-2.1.0/examples/web/wiki/static/favicon.ico0000644000014400001440000000261612072034467022050 0ustar  prologicusersx(

			





   !!!"""###$$$%%%&&&'''((()))***+++,,,---...///000111222333444555666777888999:::;;;<<<===>>>???@@@AAABBBCCCDDDEEEFFFGGGHHHIIIJJJKKKLLLMMMNNNOOOPPPQQQRRRSSSTTTUUUVVVWWWXXXYYYZZZ[[[\\\]]]^^^___```aaabbbcccdddeeefffggghhhiiijjjkkklllmmmnnnooopppqqqrrrssstttuuuvvvwwwxxxyyyzzz{{{|||}}}~~~ٺGGj(((((;{{((Xj;j;(GG;G{X胺XG(jjj(G(胘jXGG{{XjXgC		@ @circuits-2.1.0/examples/web/wiki/static/Image.jpg0000644000014400001440000001102312072034467021443 0ustar  prologicusersJFIF
	












	






	



















`"	C	!1A"Q2aqB	#3R$CSbrDT(!1AQ"a#R?([+ĸg߽QHĸy=1r8o>TϧiŒCw8x8k*#!7c28A=1ob%8]P`cУr$619z,[J&p
nL6PvKO}!G|1jpZg)޸,9+'1!8Et`APGkG&ΡcVtt2*:|q)q!
DqG3_*O;~$'C8	ؗԜ#3|=Xهbv
MXoPE"<>yTOD&ύ gN$+b {`s%C^<~M5㭨W`+NENrG'pN	x&GE
LsfO<>ѧ-?اd@KP5W4:^}XN)S`kld_A=~XeO8sD\rImẂDZśW٩wْ,k0u:y8(YdmvK3])@!y&4"y96, aRe#7 +DCQ:Ag.IiLG)%Q&M\eԀv	
N΢
(h_JۖUHJ"@$sUc(1ߒW}<7ZVÖoLk|LIŇbeIG,6F+Mȣ關f65d\mLb[l~"Eq_fYyEfՃ!%ISjԤmaMǤ=2ED`b}q8$MVJ3D]U:٣,JQ%$lX;'?I<ŵ^Gtn@sE'3Q^?ν6đ
@JKbПC]Ђښ=1
33yAӿ+,6~j"?Kc^_/:15٭TXXt3B)=6Z	'|w3'{GBX^hhr{Vꇙ3=f+'Ȁ~LUV`9e EG
IE7@H;$(h}71jDXeT3[f _7l/]/շ`98Т3v'`ں=[C08MB!GDG.LqJB[$w#	X8GvUSq+,3)K*RlaFsm^/#-²^'7IJ˕-ZfyX@bP[XٶMO/#"eL"Օ]+9=wXpsnOYaܫʖh̛#Wm<Yn+5g@>b@5Q>k၉spS-4y$SzմyI6q[jedF--S[-9[Պ(ԡf,s2ȌnJEr[H֝܂>8Zv)2~lZpi[=fA&nH%fjyeQ$`m^,AjuS""O%cZt;7N/;[BG%XD؃g;7魱٢RIFvēHUEN0?8^&g(?:o^.,#}dIJeHޚF}t7d9V	!UQf?d|~+fkd$=q4vаj>L&~ HuЧr]vљdb‚
%\M@Hhu)*|
*PIXgqrீXU)}Һg	et‹\eƶX-ŜvYAc=0Zc=HG$dgUQb6"y.vds .ܱF"FbYoTl7n$R5n#ӝEm{.r6_|l:413C>%>2I%yu5Y
9Ъ
 XD,PdeE儖lRG;E,|6^B:
U\vGfyQ_+DrB
	,@82I
( $ql7ßR0x`Ut(ڏ1fQӌk;ܙw-8tԺEZCm)G>q"tx$:6ს#r=*<]Li&Ñ"A+7lQK~!EיP>$~ʥjEVZ{cϹD9zA\ı6Z&՚ 4	Hx t=kJUV3fg\Ť iŔ:vbُ;Ve$|Ï.u&PHʆؿR.m}Ͱ&e̮\^WKCg$"5iUPsC;.$gW0UԥKz[w#Yk;eDid:#)rHg.59"RFZ ǩ9rԅBkx|C)i h<ǔYdCD#empּ̘x߯o%haL%R# %I+CS"“X]e2ň
c_i';?ҋ&r~05,O&h.}3ВG}z`G0jXNfyFW[tt?v/8Fh-fF	)05I͠F9hU
3Z)a\ܲDa$]t6bC:;
	'h%ifUU)@/?SNռOG,2:G49l1o=Dښ̲SVڣ&u ^IV4Q2eiKjFugu;Ėw^dGܹwa5gH%rtE˽iq!hq,Ix:u23a¬e@"n:GZOIĹd}circuits-2.1.0/examples/web/wiki/static/images/0000755000014400001440000000000012113366740021165 5ustar  prologicuserscircuits-2.1.0/examples/web/wiki/static/images/header_bg.png0000644000014400001440000000104512072034467023575 0ustar  prologicusersPNG


IHDRl(?gAMA7tEXtSoftwareAdobe ImageReadyqe<PLTE@{,U;q2`@zC=tB~.Y,U?x,VB~A|-W3b4e:pw>v>v1^9m-W8l0\A}B}?y-WA}=uA{w,V.Y5e?y:o3a0]-X1_7i0]9n>w/[YIDATx"Ce%;!3ى;ǶtƖ_L#J1fƧm?o=ׁ{6yUԆKYuT[5w'j
",ə4WW&[oZ4=+Iɦ
 IENDB`circuits-2.1.0/examples/web/wiki/wiki.py0000755000014400001440000000451712113343751017755 0ustar  prologicusers#!/usr/bin/env python

import os
import sqlite3

from creoleparser import create_dialect, creole11_base, Parser

import circuits
from circuits.web import Server, Controller, Logger, Static

import macros

text2html = Parser(
    create_dialect(creole11_base, macro_func=macros.dispatcher),
    method="xhtml"
)


class Wiki(object):

    def __init__(self, database):
        super(Wiki, self).__init__()

        create = not os.path.exists(database)

        self._cx = sqlite3.connect(database)
        self._cu = self._cx.cursor()

        if create:
            self._cu.execute("CREATE TABLE pages (name, text)")
            for defaultpage in os.listdir("defaultpages"):
                filename = os.path.join("defaultpages", defaultpage)
                self.save(defaultpage, open(filename, "r").read())

    def save(self, name, text):
        self._cu.execute("SELECT COUNT() FROM pages WHERE name=?", (name,))
        row = self._cu.fetchone()
        if row[0]:
            self._cu.execute(
                "UPDATE pages SET text=? WHERE name=?",
                (text, name,)
            )
        else:
            self._cu.execute(
                "INSERT INTO pages (name, text) VALUES (?, ?)",
                (name, text,)
            )
        self._cx.commit()

    def get(self, name, default=None):
        self._cu.execute("SELECT text FROM pages WHERE name=?", (name,))
        row = self._cu.fetchone()
        return row[0] if row else default


class Root(Controller):

    db = Wiki("wiki.db")

    environ = {"db": db, "macros": macros.loadMacros()}

    def GET(self, name="FrontPage", action="view"):
        environ = self.environ.copy()
        environ["page.name"] = name
        environ["parser"] = text2html

        d = {}
        d["title"] = name
        d["version"] = circuits.__version__
        d["menu"] = text2html(self.db.get("SiteMenu", ""), environ=environ)

        text = self.db.get(name, "")
        s = open("tpl/%s.html" % action, "r").read()

        if action == "view":
            d["text"] = text2html(text, environ=environ)
        else:
            d["text"] = text

        return s % d

    def POST(self, name="FrontPage", **form):
        self.db.save(name, form.get("text", ""))
        return self.redirect(name)

(
    Server(("0.0.0.0", 8000))
    + Static(docroot="static")
    + Root()
    + Logger()
).run()
circuits-2.1.0/examples/web/websockets.py0000644000014400001440000000102212113343751020201 0ustar  prologicusers#!/usr/bin/env python

from circuits import Component
from circuits.web.dispatchers import WebSockets
from circuits.web import Server, Controller, Logger
from circuits.net.sockets import Write


class Echo(Component):

    channel = "ws"

    def read(self, sock, data):
        self.fireEvent(Write(sock, "Received: " + data))


class Root(Controller):

    def index(self):
        return "Hello World!"

(Server(("0.0.0.0", 8000))
        + Echo()
        + Root()
        + Logger()
        + WebSockets("/websocket")
).run()
circuits-2.1.0/examples/web/counter.txt0000644000014400001440000000000212113343751017673 0ustar  prologicusers13circuits-2.1.0/examples/web/cert.pem0000644000014400001440000000420512072034467017131 0ustar  prologicusers-----BEGIN RSA PRIVATE KEY-----
MIICWwIBAAKBgQC9B7hV67bzhLA//STrZUIi0iHD4WFtftOhvj+xiHRNnYw0+r+4
WdQv1YiL+ab03pn/J9R1SQuOGwYDVPQvYX+qEFVRUFP9yvXIQl7PG40HQzfs8lJz
hnmI+64HJT//oJ9e7PiyDHLfFH1FuCqSy9RlvzOd4hmydX9J3VxFFzrpJQIDAQAB
AoGAHhGxT/Gb+6a6xqMFEXDdEV7twhQDBIDtN0hlJ192aLZMDE1q2+9mImnMO7/t
v/v88Sqr0DBbZzKDRVppMXRH80ZtnmMu3/3kUCtA3WAbKxyFpIiXGv/NAUHZe5Gz
rua+z3lUvmt6CmwMm2ReB70Q61zxr9q4HjrjYI82dtJ4M40CQQDnGujxdBdbPmiR
oc8mcShfmPNP7igQrUkf/DpB0GWnLWdA97mmXLw4jHXpHy9gm3wGc+9uOi0Ex8Ml
1t9xAGFjAkEA0WSGwG45d5dmYV8Oa/9UsY5/F6hAlYAAI1TxRsKcl2YTqaQastac
glV1GSUrgGw/8UBvdKKS2REF7cpAkiQV1wJAPtQhCiuOgf7YfOcpowDWgg7Z7xwH
Bmml3K08xVG7oRSF4rK2ZRUHErSVBbi1r6T1tedk62mjfY41bp8ZBeadkwJAD7AG
YHhhmdIf+3+Rpwm0ILFaWD1kyU6TtBHzGagO71DYfEctMOTfSOx6H24nejGiAMMh
Fo3vjo+18ADNIaXOdQJAYdm+dUdyVaW2IDUi7ew0shyKTC4OaEZtXIwwINvrqUsX
//6z8mw/S5rXGlfKadiz4uwzcXlSvg727O1efpibvA==
-----END RSA PRIVATE KEY-----
-----BEGIN CERTIFICATE-----
MIIDjTCCAvagAwIBAgIJAN0msyL5El/jMA0GCSqGSIb3DQEBBQUAMIGMMQswCQYD
VQQGEwJBVTETMBEGA1UECBMKUXVlZW5zbGFuZDERMA8GA1UEBxMIQnJpc2JhbmUx
FTATBgNVBAoTDFNob3J0Q2lyY3VpdDEUMBIGA1UEAxMLSmFtZXMgTWlsbHMxKDAm
BgkqhkiG9w0BCQEWGWFkbWluQHNob3J0Y2lyY3VpdC5uZXQuYXUwHhcNMTAwMTEz
MDczOTAwWhcNMTEwMTEzMDczOTAwWjCBjDELMAkGA1UEBhMCQVUxEzARBgNVBAgT
ClF1ZWVuc2xhbmQxETAPBgNVBAcTCEJyaXNiYW5lMRUwEwYDVQQKEwxTaG9ydENp
cmN1aXQxFDASBgNVBAMTC0phbWVzIE1pbGxzMSgwJgYJKoZIhvcNAQkBFhlhZG1p
bkBzaG9ydGNpcmN1aXQubmV0LmF1MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKB
gQC9B7hV67bzhLA//STrZUIi0iHD4WFtftOhvj+xiHRNnYw0+r+4WdQv1YiL+ab0
3pn/J9R1SQuOGwYDVPQvYX+qEFVRUFP9yvXIQl7PG40HQzfs8lJzhnmI+64HJT//
oJ9e7PiyDHLfFH1FuCqSy9RlvzOd4hmydX9J3VxFFzrpJQIDAQABo4H0MIHxMB0G
A1UdDgQWBBSq+tU5ZDymUuMcgZ83gxk1PTN89zCBwQYDVR0jBIG5MIG2gBSq+tU5
ZDymUuMcgZ83gxk1PTN896GBkqSBjzCBjDELMAkGA1UEBhMCQVUxEzARBgNVBAgT
ClF1ZWVuc2xhbmQxETAPBgNVBAcTCEJyaXNiYW5lMRUwEwYDVQQKEwxTaG9ydENp
cmN1aXQxFDASBgNVBAMTC0phbWVzIE1pbGxzMSgwJgYJKoZIhvcNAQkBFhlhZG1p
bkBzaG9ydGNpcmN1aXQubmV0LmF1ggkA3SazIvkSX+MwDAYDVR0TBAUwAwEB/zAN
BgkqhkiG9w0BAQUFAAOBgQAokSGDpbFV2osC8nM8K12vheeDBVDHGxOaENXGVIm8
SWPXsaIUsm6JQx0wm/eouWRPbNJkOBwBrNCls1oMmdxdxG8mBh+kAMWUkdVeuT2H
lCo9BRJnhUr4L6poJ7ORzL2oUilGZNwONpHGY0cWzFG8/tOoRJsfKZm23bwXbIxv
Hw==
-----END CERTIFICATE-----
circuits-2.1.0/examples/web/virtualhosts.py0000755000014400001440000000104612113343751020610 0ustar  prologicusers#!/usr/bin/env python

from circuits.web import Server, Controller
from circuits.web.dispatchers import VirtualHosts


class Root(Controller):

    def index(self):
        return "I am the main vhost"


class Foo(Controller):

    channel = "/foo"

    def index(self):
        return "I am foo."


class Bar(Controller):

    channel = "/bar"

    def index(self):
        return "I am bar."

domains = {
    "foo.localdomain:8000": "foo",
    "bar.localdomain:8000": "bar",
}

(Server(8000) + VirtualHosts(domains) + Root() + Foo() + Bar()).run()
circuits-2.1.0/examples/web/ca-chain.pem0000644000014400001440000001314512072034467017642 0ustar  prologicusers-----BEGIN CERTIFICATE-----
MIIDtzCCAp+gAwIBAgIJAMnzwJQDL4VeMA0GCSqGSIb3DQEBBAUAMHIxEzARBgNV
BAoTCk15IENvbXBhbnkxEDAOBgNVBAsTB015IFVuaXQxEDAOBgNVBAcTB015IFRv
d24xETAPBgNVBAgTCE15IFN0YXRlMQswCQYDVQQGEwJVUzEXMBUGA1UEAxMOU0FN
UExFIFJvb3QgQ0EwHhcNMTAwOTE0MTkwOTEwWhcNMjAwOTExMTkwOTEwWjByMRMw
EQYDVQQKEwpNeSBDb21wYW55MRAwDgYDVQQLEwdNeSBVbml0MRAwDgYDVQQHEwdN
eSBUb3duMREwDwYDVQQIEwhNeSBTdGF0ZTELMAkGA1UEBhMCVVMxFzAVBgNVBAMT
DlNBTVBMRSBSb290IENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
vtsgzTwqnpHKblC8uHi+L+98q1FhB0hFNHfBTri7BFhOjsvJnOk/T8y2f6o8tpfS
8q0fUtzxOQbgsSekLBdgHGDMdVcEgCM5+zNW4Rvm62pXAi2yo4y4b9/Xl1GZQp1O
cCG5jz1s9FbeCYlrfRDPbSDCcxbtK0umnk6XmVYT47JXK8pieSlLidveMkhrrhlv
fg8KjQjljihZRQBeR4OQ/EbCKbLYTQWpGJCle/JZe/N0nm0iYKgehBjKZreCM9oS
fVUpp3ID46VQ3S9J3x1PbHiv75EBRMltY6kCZSllxT9TmifVSO2BWRJB0H5g7hR1
xSY/PegUj09clRIyKVhu6QIDAQABo1AwTjAMBgNVHRMEBTADAQH/MB0GA1UdDgQW
BBSXjmOlgHIg/X32Gf6byJzr6ME2QDAfBgNVHSMEGDAWgBSXjmOlgHIg/X32Gf6b
yJzr6ME2QDANBgkqhkiG9w0BAQQFAAOCAQEArXdsXg/nUeJk3Usslm1PDeHztiGQ
GH2yNdAjRVL0yV1z087Ikn9S0MCrqFsvc0b1LdlpfOWrzn5Kg7JvkhfqYvIHfmv1
bwtSXfKh1/Sbd2mZzdFzRzcZPYQSab0+IiT4/M1+IGwPnMMnBuAcQE7rUQScy2/4
pRYR4tP8VDC3XIxrLfZ5oSZB16IPrBvMIKSMb4Rgi9LRamo20UbSfy3WMjYpSL17
01f/ix/lMm3UwNsia4N9p4EVoOcs+f09mw9f1a19oj8x/jVdseMXs+LGJ7i8VTCo
tItbnFb2Oy71LwBpTZibQ3YBe3rMcKkLDgvJCroq3D9BQW12yR7m8d2REg==
-----END CERTIFICATE-----
Certificate:
    Data:
        Version: 3 (0x2)
        Serial Number: 1048595 (0x100013)
        Signature Algorithm: md5WithRSAEncryption
        Issuer: O=My Company, OU=My Unit, L=My Town, ST=My State, C=US, CN=SAMPLE Root CA
        Validity
            Not Before: Sep 14 19:19:53 2010 GMT
            Not After : Sep 11 19:19:53 2020 GMT
        Subject: C=US, ST=My State, O=My Company, OU=My Unit, CN=SAMPLE Signing CA
        Subject Public Key Info:
            Public Key Algorithm: rsaEncryption
            RSA Public Key: (2048 bit)
                Modulus (2048 bit):
                    00:ce:79:81:1f:b5:38:62:a9:9a:8b:80:26:ec:66:
                    f2:86:13:32:53:12:16:c7:d5:38:c0:e4:ee:1d:11:
                    bd:fc:8c:5b:f5:59:b5:a4:18:77:04:54:4c:57:8c:
                    85:0a:9e:02:b2:f6:f4:d5:d5:a6:cc:eb:91:d7:17:
                    ec:75:86:30:c9:60:79:40:69:13:7e:65:d5:e5:f8:
                    89:7e:de:9b:c9:c1:19:74:ae:d9:d7:e1:86:c0:1e:
                    2e:be:44:73:45:d9:3c:06:1a:4a:4d:f1:86:79:f8:
                    68:e6:24:d0:7a:5d:92:8e:76:62:63:9a:bd:b7:43:
                    52:a9:be:ad:3b:43:92:99:43:18:80:09:e9:9e:65:
                    d4:02:1d:97:c4:e4:6a:d9:9f:23:3d:66:2a:64:0c:
                    ad:41:48:ca:16:bf:82:34:32:ec:c2:09:5a:dd:0c:
                    a7:cc:99:a0:a5:5f:6a:e4:42:01:13:a9:e4:f7:ad:
                    e7:f0:78:51:9f:f0:7e:21:94:ff:0b:12:ce:19:a3:
                    51:a6:a3:53:3c:65:3f:26:3e:31:b4:f3:98:82:4e:
                    81:a3:14:aa:a4:63:6a:7e:6c:50:dd:86:74:cb:33:
                    f5:67:c7:29:24:d5:e9:86:9d:82:55:e3:d2:c2:4e:
                    85:3f:0d:03:fc:5a:15:29:cf:94:d8:e6:59:8c:d4:
                    13:25
                Exponent: 65537 (0x10001)
        X509v3 extensions:
            X509v3 Basic Constraints: 
                CA:TRUE
            X509v3 Subject Key Identifier: 
                FE:24:B7:46:DF:51:66:99:27:F6:68:02:F8:F2:9C:21:13:5E:5D:C1
            X509v3 Authority Key Identifier: 
                keyid:97:8E:63:A5:80:72:20:FD:7D:F6:19:FE:9B:C8:9C:EB:E8:C1:36:40

    Signature Algorithm: md5WithRSAEncryption
        3b:ea:41:d7:02:49:79:41:fb:35:07:85:ae:ae:40:86:63:08:
        82:52:4b:03:32:42:21:b9:f9:24:f9:ef:14:9c:e2:0f:99:42:
        36:a3:cf:41:79:e7:0b:90:27:4b:85:d7:57:a0:6e:de:05:8c:
        6e:27:f5:33:fe:d6:c5:fc:8a:39:2d:b3:4e:41:15:a3:71:1f:
        a2:75:4f:c7:aa:30:f4:1d:18:4b:44:a3:39:11:d2:05:c7:80:
        cd:76:59:79:67:25:25:e0:f2:5e:5d:14:3a:ec:71:eb:c8:d3:
        12:20:8f:f7:99:96:28:c7:40:7d:0f:66:bb:1f:58:c1:df:7d:
        d3:31:cb:1e:f5:bc:67:23:f6:74:b7:9c:d9:7f:d9:9a:d2:fe:
        71:05:8b:ba:05:51:a5:bc:e3:e8:db:b2:31:72:89:32:80:ff:
        61:09:37:7b:57:c8:c6:6a:06:e2:9a:7c:73:22:43:d2:9a:d8:
        9e:4b:3c:1c:50:38:40:84:da:b6:0a:a5:93:8c:21:1e:b7:4b:
        6b:f7:88:34:c4:16:d5:72:ed:dd:01:5b:b7:a5:9c:a5:46:0c:
        e9:cd:36:04:30:4f:ab:4b:96:a7:0c:71:8e:89:3c:3e:37:6f:
        d4:1f:8f:9b:01:16:ca:4e:16:17:93:a4:60:6f:c6:a2:55:a1:
        f0:4e:1c:e2
-----BEGIN CERTIFICATE-----
MIIDojCCAoqgAwIBAgIDEAATMA0GCSqGSIb3DQEBBAUAMHIxEzARBgNVBAoTCk15
IENvbXBhbnkxEDAOBgNVBAsTB015IFVuaXQxEDAOBgNVBAcTB015IFRvd24xETAP
BgNVBAgTCE15IFN0YXRlMQswCQYDVQQGEwJVUzEXMBUGA1UEAxMOU0FNUExFIFJv
b3QgQ0EwHhcNMTAwOTE0MTkxOTUzWhcNMjAwOTExMTkxOTUzWjBjMQswCQYDVQQG
EwJVUzERMA8GA1UECBMITXkgU3RhdGUxEzARBgNVBAoTCk15IENvbXBhbnkxEDAO
BgNVBAsTB015IFVuaXQxGjAYBgNVBAMTEVNBTVBMRSBTaWduaW5nIENBMIIBIjAN
BgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAznmBH7U4Yqmai4Am7GbyhhMyUxIW
x9U4wOTuHRG9/Ixb9Vm1pBh3BFRMV4yFCp4Csvb01dWmzOuR1xfsdYYwyWB5QGkT
fmXV5fiJft6bycEZdK7Z1+GGwB4uvkRzRdk8BhpKTfGGefho5iTQel2SjnZiY5q9
t0NSqb6tO0OSmUMYgAnpnmXUAh2XxORq2Z8jPWYqZAytQUjKFr+CNDLswgla3Qyn
zJmgpV9q5EIBE6nk963n8HhRn/B+IZT/CxLOGaNRpqNTPGU/Jj4xtPOYgk6BoxSq
pGNqfmxQ3YZ0yzP1Z8cpJNXphp2CVePSwk6FPw0D/FoVKc+U2OZZjNQTJQIDAQAB
o1AwTjAMBgNVHRMEBTADAQH/MB0GA1UdDgQWBBT+JLdG31FmmSf2aAL48pwhE15d
wTAfBgNVHSMEGDAWgBSXjmOlgHIg/X32Gf6byJzr6ME2QDANBgkqhkiG9w0BAQQF
AAOCAQEAO+pB1wJJeUH7NQeFrq5AhmMIglJLAzJCIbn5JPnvFJziD5lCNqPPQXnn
C5AnS4XXV6Bu3gWMbif1M/7WxfyKOS2zTkEVo3EfonVPx6ow9B0YS0SjORHSBceA
zXZZeWclJeDyXl0UOuxx68jTEiCP95mWKMdAfQ9mux9Ywd990zHLHvW8ZyP2dLec
2X/ZmtL+cQWLugVRpbzj6NuyMXKJMoD/YQk3e1fIxmoG4pp8cyJD0prYnks8HFA4
QITatgqlk4whHrdLa/eINMQW1XLt3QFbt6WcpUYM6c02BDBPq0uWpwxxjok8Pjdv
1B+PmwEWyk4WF5OkYG/GolWh8E4c4g==
-----END CERTIFICATE-----
circuits-2.1.0/examples/web/jsonserializer.py0000755000014400001440000000120112113343751021075 0ustar  prologicusers#!/usr/bin/env python

import json

from circuits import handler, Component
from circuits.web import Server, Controller, Logger


class JSONSerializer(Component):

    channel = "web"

    @handler("request_filtered", priority=1.0)
    def _on_request_success_or_filtered(self, event, evt, handler, retval):
        request, response = evt.args[:2]

        event[2] = json.dumps(retval.value)
        response.headers["Content-Type"] = "application/javascript"


class Root(Controller):

    def index(self):
        return {"message": "Hello World!"}

(
    Server(("0.0.0.0", 8000))
    + JSONSerializer()
    + Root() + Logger()
).run()
circuits-2.1.0/examples/web/jsoncontroller.py0000755000014400001440000000032612113343751021116 0ustar  prologicusers#!/usr/bin/env python

from circuits.web import Server, JSONController


class Root(JSONController):

    def index(self):
        return {"success": True, "message": "Hello World!"}

(Server(8000) + Root()).run()
circuits-2.1.0/examples/web/httpauth.py0000755000014400001440000000074612113343751017710 0ustar  prologicusers#!/usr/bin/env python

from circuits.web import Server, Controller
from circuits.web.tools import check_auth, basic_auth


class Root(Controller):

    def index(self):
        realm = "Test"
        users = {"admin": "admin"}
        encrypt = str

        if check_auth(self.request, self.response, realm, users, encrypt):
            return "Hello %s" % self.request.login

        return basic_auth(self.request, self.response, realm, users, encrypt)

(Server(8000) + Root()).run()
circuits-2.1.0/examples/web/forms.py0000755000014400001440000000204512113343751017167 0ustar  prologicusers#!/usr/bin/env python

from circuits.web import Server, Controller


class Root(Controller):

    html = """\

 
  Basic Form Handling
 
 
  
          Basic Form Handling
          
  
          
   Example of using
   circuits and its
   Web Components to build a simple web application that handles
   some basic form data.
  
          
  
          
   
          
    
          
     First Name:
     
    
          
    
          
     Last Name:
     
    
          
     
          
      
       
     
     
          
   
          
  
          
 
"""

    def index(self):
        return self.html

    def submit(self, firstName, lastName):
        return "Hello %s %s
          Return" % (
            firstName, lastName
        )

(Server(8000) + Root()).run()
circuits-2.1.0/examples/web/terminal/0000755000014400001440000000000012113366740017301 5ustar  prologicuserscircuits-2.1.0/examples/web/terminal/terminal.py0000755000014400001440000000714312113343751021473 0ustar  prologicusers#!/usr/bin/env python


import os
import signal
from StringIO import StringIO
from subprocess import Popen, PIPE

from circuits.io import File
from circuits.web.events import Stream
from circuits.net.sockets import Write
from circuits.tools import kill, inspect
from circuits import handler, Event, Component
from circuits.web import Server, Controller, Logger, Static, Sessions

BUFFERING = 1
STREAMING = 2


class Kill(Event):
    pass


class Input(Event):
    pass


class Command(Component):

    channel = "cmd"

    def __init__(self, request, response, command, channel=channel):
        super(Command, self).__init__(channel=channel)

        self._request = request
        self._response = response
        self._command = command

        self._state = BUFFERING
        self._buffer = None

        self._p = Popen(
            command, shell=True, stdout=PIPE, stderr=PIPE,
            close_fds=True, preexec_fn=os.setsid
        )

        self._stdin = None
        if self._p.stdin is not None:
            self._stdin = File(self._p.stdin, channel="%s.stdin" % channel)
            self._stdin.register(self)

        self._stdout = File(self._p.stdout, channel="%s.stdout" % channel)
        self.addHandler(
            handler("eof", channel="%s.stdout" % channel)(self._on_stdout_eof)
        )
        self.addHandler(
            handler("read", channel="%s.stdout" % channel)(
                self._on_stdout_read
            )
        )
        self._stdout.register(self)

    @handler("disconnect", channel="web")
    def disconnect(self, sock):
        if sock == self._request.sock:
            self.fire(Kill(), self)

    @handler("response", channel="web", priority=-1)
    def response(self, response):
        if response == self._response:
            self._state = STREAMING

    def kill(self):
        os.killpg(self._p.pid, signal.SIGINT)
        kill(self)

    def input(self, data):
        if self._stdin is not None:
            self.fire(Write(data), self._stdin)

    @staticmethod
    def _on_stdout_eof(self):
        if self._buffer is not None:
            self._buffer.flush()
            data = self._buffer.getvalue()
            self.fire(Stream(self._response, data), "web")
        self.fire(Stream(self._response, None), "web")
        self.fire(Kill())

    @staticmethod
    def _on_stdout_read(self, data):
        if self._state == BUFFERING:
            if self._buffer is None:
                self._buffer = StringIO()
            self._buffer.write(data)
        elif self._state == STREAMING:
            if self._buffer is not None:
                self._buffer.write(data)
                self._buffer.flush()
                data = self._buffer.getvalue()
                self._buffer = None
                self.fire(Stream(self._response, data), "web")
            else:
                self.fire(Stream(self._response, data), "web")


class Root(Controller):

    def GET(self, *args, **kwargs):
        self.expires(60 * 60 * 24 * 30)
        return self.serve_file(os.path.abspath("static/index.xhtml"))

    def POST(self, input=None):
        if not input:
            return ""

        self.response.headers["Content-Type"] = "text/plain"

        if input.strip() == "inspect":
            return inspect(self)

        self.response.stream = True

        sid = self.request.sid
        self += Command(self.request, self.response, input, channel=sid)

        return self.response


from circuits import Debugger

(
    Server(("0.0.0.0", 8000))
    + Debugger()
    + Static("/js", docroot="static/js")
    + Static("/css", docroot="static/css")
    + Sessions()
    + Logger()
    + Root()
).run()
circuits-2.1.0/examples/web/terminal/static/0000755000014400001440000000000012113366740020570 5ustar  prologicuserscircuits-2.1.0/examples/web/terminal/static/js/0000755000014400001440000000000012113366740021204 5ustar  prologicuserscircuits-2.1.0/examples/web/terminal/static/js/jquery.terminal.js0000644000014400001440000001356112072034467024703 0ustar  prologicusers/* 
 * AJAX Terminal (0.1)
 * by Sagie Maoz (n0nick.net)
 * n0nick@php.net
 *
 * jQuery plugin to create a web-based console-like behavior that posts user
 * input commands  to an AJAX server, and prints the result text.
 * Designed to be utterly simple and highly customizable.
 *
 * Copyright (c) 2009 Sagie Maoz 
 * Licensed under the GPL license, see http://www.gnu.org/licenses/gpl-3.0.html 
 *
 *
 * NOTE: This script requires jQuery to work.  Download jQuery at www.jquery.com
 *
 */
 
(function($) {

	$.fn.terminal = function(url, options) {

		settings = $.extend({
			'max_height' : '100%',
			'form_method' : 'POST',
			'input_name' : 'input',
			'post_vars' : {},
			'custom_prompt' : false,
            'focus_on_load' : true,
			'submit_on_load' : false,
			'grab_focus_on_click' : true,
			'hello_message' : false,
			'unix_theme' : true,
			'allow_empty_input' : false,
			'tab_width' : 4,
			'disable_input' : false,
			'onload' : null,
		}, options);

		if (settings.custom_prompt)
		{
			settings.custom_prompt = $.trim(settings.custom_prompt) + ' ';
		}

		return this.each(function()
		{
			var terminal_container = $(this);

			terminal_container.append('
          ');
			var terminal = terminal_container.find('div:last');

			if (settings.max_height == '100%')
			{
				settings.max_height = terminal_container.innerHeight();
			}

			terminal.css({
				'display' : 'block',
				'overflow-x' : 'none',
				'overflow-y' : 'auto',
				'padding' : '0',
				'max-height' : settings.max_height + 'px',
			});

			terminal.append('');
			var terminal_form = $(this).find('form:last');

			if (settings.custom_prompt)
			{
				terminal_form.append('' + settings.custom_prompt + '');
			}

			terminal_form.css('display', 'inline');
			terminal_form.attr('onsubmit', 'return false;');

			var tabString = "";
			for (var i=0; i').text(data);
				var dataRows = formattedData.html().split(/\n/);
				data = '';
				for (row in dataRows)
				{
					data += '' + dataRows[row].replace(/\t/g, tabString);
					if (!(row == dataRows.length-1 && (!dataRows[row] || !settings.custom_prompt)))
						data+= '
          ';
					data += '          ';
				}

				terminal_output.append('' + data + '');

				terminal_form.show();
				terminal_input.val('').focus();
				
				// if input is disabled, we trick a focus so the scrolling will be ok
				if (settings.disable_input)
				{
					terminal_input.removeAttr('disabled').focus().attr('disabled', 'disabled');
				}
			}
			// outsource this function for misc. implementations
			terminal_container[0].append = terminal_append;
			
			var terminal_command = function(first)
			{
				var first = first || false;
				var val = $.trim(terminal_input.val());

                if ("" == val && !first)
				{
                	if (!settings.allow_empty_input)
                		return;
				}

                terminal_form.hide();
                if ("" != val || settings.allow_empty_input)
                {
                    var last_command = '';
                    last_command+= settings.custom_prompt? settings.custom_prompt : '';
                    last_command+= val + '
          ';
                    terminal_output.append(last_command);
                }

                post_vars = settings.post_vars;
                post_vars[settings.input_name] = val;

				function terminal_command_success(data)
				{
					return terminal_append(data);
				}

				function terminal_command_error(x, tStatus)
				{
					var out = 'ERROR: ';
					switch(tStatus)
					{
						case 'timeout':
							out+= 'Server timeout. Try again later.';
							break;
						case 'notmodified':
							out+= 'Server did not response properly. Try again.';
							break;
						case 'parsererror':
							out+= 'Client error. Try again.';
							break;
						default:
						case 'error':
							out+= 'A server error has occured. Check your command.';
							break;
					}
					return terminal_command_success(out);
				}

				$.ajax({
					'type' : terminal_form.attr('method'),
					'url' : terminal_form.attr('action'),
					'cache' : false,
					'data' : post_vars,
					'dataType' : 'text',
					'success' : terminal_command_success,
					'error' : terminal_command_error,
				});

			}
			terminal_form.submit(terminal_command);

			terminal_form.append('');
			var terminal_input = terminal_form.find('input:last');
			terminal_input.css('width', '80%');
			terminal_input.attr('autocomplete', 'off');

			if (settings.unix_theme)
			{
				terminal_container.css({
					'border' : 'none',
					'background-color' : 'black',
				});
				terminal_form.css({
					'padding' : '0',
					'margin' : '0',
				});
				terminal_input.css({
					'border' : 'none',
					'background-color' : 'black',
					'padding' : '0',
					'margin' : '0',
				});
				terminal_container.find('input, span').css({
					'color' : 'lightgrey',
					'font-family' : 'monospace',
					'font-size' : '1em',
					'line-height' : '1.3em',
				});
			}

			$(document).ready(function()
			{
				if (settings.grab_focus_on_click)
				{
					terminal_container.mouseup(function()
					{
						if ("" == document.getSelection())
						{
							$(terminal_input.focus());
						}
					});
				}

				if (settings.hello_message)
					terminal_output.append('' + settings.hello_message + '
          ');

				if (settings.submit_on_load)
					terminal_command(true);

				if (settings.focus_on_load)
					terminal_input.focus();

				if (settings.disable_input)
					terminal_input.attr('disabled', 'disabled');

				if (settings.onload)
					settings.onload();

			});
		});

	}

}(jQuery));
circuits-2.1.0/examples/web/terminal/static/js/main.js0000644000014400001440000000034412072034467022471 0ustar  prologicusersvar options = {
    custom_prompt: ">>> ",
    hello_message: "Welcome! Type \'help\' for, well, help."
}

function main() {
    $("#terminal").height($(document).height());
    $("#terminal").terminal("/", options);
}
circuits-2.1.0/examples/web/terminal/static/js/jquery.js0000644000014400001440000035367312072034467023104 0ustar  prologicusers/*!
 * jQuery JavaScript Library v1.3.2
 * http://jquery.com/
 *
 * Copyright (c) 2009 John Resig
 * Dual licensed under the MIT and GPL licenses.
 * http://docs.jquery.com/License
 *
 * Date: 2009-02-19 17:34:21 -0500 (Thu, 19 Feb 2009)
 * Revision: 6246
 */
(function(){

var 
	// Will speed up references to window, and allows munging its name.
	window = this,
	// Will speed up references to undefined, and allows munging its name.
	undefined,
	// Map over jQuery in case of overwrite
	_jQuery = window.jQuery,
	// Map over the $ in case of overwrite
	_$ = window.$,

	jQuery = window.jQuery = window.$ = function( selector, context ) {
		// The jQuery object is actually just the init constructor 'enhanced'
		return new jQuery.fn.init( selector, context );
	},

	// A simple way to check for HTML strings or ID strings
	// (both of which we optimize for)
	quickExpr = /^[^<]*(<(.|\s)+>)[^>]*$|^#([\w-]+)$/,
	// Is it a simple selector
	isSimple = /^.[^:#\[\.,]*$/;

jQuery.fn = jQuery.prototype = {
	init: function( selector, context ) {
		// Make sure that a selection was provided
		selector = selector || document;

		// Handle $(DOMElement)
		if ( selector.nodeType ) {
			this[0] = selector;
			this.length = 1;
			this.context = selector;
			return this;
		}
		// Handle HTML strings
		if ( typeof selector === "string" ) {
			// Are we dealing with HTML string or an ID?
			var match = quickExpr.exec( selector );

			// Verify a match, and that no context was specified for #id
			if ( match && (match[1] || !context) ) {

				// HANDLE: $(html) -> $(array)
				if ( match[1] )
					selector = jQuery.clean( [ match[1] ], context );

				// HANDLE: $("#id")
				else {
					var elem = document.getElementById( match[3] );

					// Handle the case where IE and Opera return items
					// by name instead of ID
					if ( elem && elem.id != match[3] )
						return jQuery().find( selector );

					// Otherwise, we inject the element directly into the jQuery object
					var ret = jQuery( elem || [] );
					ret.context = document;
					ret.selector = selector;
					return ret;
				}

			// HANDLE: $(expr, [context])
			// (which is just equivalent to: $(content).find(expr)
			} else
				return jQuery( context ).find( selector );

		// HANDLE: $(function)
		// Shortcut for document ready
		} else if ( jQuery.isFunction( selector ) )
			return jQuery( document ).ready( selector );

		// Make sure that old selector state is passed along
		if ( selector.selector && selector.context ) {
			this.selector = selector.selector;
			this.context = selector.context;
		}

		return this.setArray(jQuery.isArray( selector ) ?
			selector :
			jQuery.makeArray(selector));
	},

	// Start with an empty selector
	selector: "",

	// The current version of jQuery being used
	jquery: "1.3.2",

	// The number of elements contained in the matched element set
	size: function() {
		return this.length;
	},

	// Get the Nth element in the matched element set OR
	// Get the whole matched element set as a clean array
	get: function( num ) {
		return num === undefined ?

			// Return a 'clean' array
			Array.prototype.slice.call( this ) :

			// Return just the object
			this[ num ];
	},

	// Take an array of elements and push it onto the stack
	// (returning the new matched element set)
	pushStack: function( elems, name, selector ) {
		// Build a new jQuery matched element set
		var ret = jQuery( elems );

		// Add the old object onto the stack (as a reference)
		ret.prevObject = this;

		ret.context = this.context;

		if ( name === "find" )
			ret.selector = this.selector + (this.selector ? " " : "") + selector;
		else if ( name )
			ret.selector = this.selector + "." + name + "(" + selector + ")";

		// Return the newly-formed element set
		return ret;
	},

	// Force the current matched set of elements to become
	// the specified array of elements (destroying the stack in the process)
	// You should use pushStack() in order to do this, but maintain the stack
	setArray: function( elems ) {
		// Resetting the length to 0, then using the native Array push
		// is a super-fast way to populate an object with array-like properties
		this.length = 0;
		Array.prototype.push.apply( this, elems );

		return this;
	},

	// Execute a callback for every element in the matched set.
	// (You can seed the arguments with an array of args, but this is
	// only used internally.)
	each: function( callback, args ) {
		return jQuery.each( this, callback, args );
	},

	// Determine the position of an element within
	// the matched set of elements
	index: function( elem ) {
		// Locate the position of the desired element
		return jQuery.inArray(
			// If it receives a jQuery object, the first element is used
			elem && elem.jquery ? elem[0] : elem
		, this );
	},

	attr: function( name, value, type ) {
		var options = name;

		// Look for the case where we're accessing a style value
		if ( typeof name === "string" )
			if ( value === undefined )
				return this[0] && jQuery[ type || "attr" ]( this[0], name );

			else {
				options = {};
				options[ name ] = value;
			}

		// Check to see if we're setting style values
		return this.each(function(i){
			// Set all the styles
			for ( name in options )
				jQuery.attr(
					type ?
						this.style :
						this,
					name, jQuery.prop( this, options[ name ], type, i, name )
				);
		});
	},

	css: function( key, value ) {
		// ignore negative width and height values
		if ( (key == 'width' || key == 'height') && parseFloat(value) < 0 )
			value = undefined;
		return this.attr( key, value, "curCSS" );
	},

	text: function( text ) {
		if ( typeof text !== "object" && text != null )
			return this.empty().append( (this[0] && this[0].ownerDocument || document).createTextNode( text ) );

		var ret = "";

		jQuery.each( text || this, function(){
			jQuery.each( this.childNodes, function(){
				if ( this.nodeType != 8 )
					ret += this.nodeType != 1 ?
						this.nodeValue :
						jQuery.fn.text( [ this ] );
			});
		});

		return ret;
	},

	wrapAll: function( html ) {
		if ( this[0] ) {
			// The elements to wrap the target around
			var wrap = jQuery( html, this[0].ownerDocument ).clone();

			if ( this[0].parentNode )
				wrap.insertBefore( this[0] );

			wrap.map(function(){
				var elem = this;

				while ( elem.firstChild )
					elem = elem.firstChild;

				return elem;
			}).append(this);
		}

		return this;
	},

	wrapInner: function( html ) {
		return this.each(function(){
			jQuery( this ).contents().wrapAll( html );
		});
	},

	wrap: function( html ) {
		return this.each(function(){
			jQuery( this ).wrapAll( html );
		});
	},

	append: function() {
		return this.domManip(arguments, true, function(elem){
			if (this.nodeType == 1)
				this.appendChild( elem );
		});
	},

	prepend: function() {
		return this.domManip(arguments, true, function(elem){
			if (this.nodeType == 1)
				this.insertBefore( elem, this.firstChild );
		});
	},

	before: function() {
		return this.domManip(arguments, false, function(elem){
			this.parentNode.insertBefore( elem, this );
		});
	},

	after: function() {
		return this.domManip(arguments, false, function(elem){
			this.parentNode.insertBefore( elem, this.nextSibling );
		});
	},

	end: function() {
		return this.prevObject || jQuery( [] );
	},

	// For internal use only.
	// Behaves like an Array's method, not like a jQuery method.
	push: [].push,
	sort: [].sort,
	splice: [].splice,

	find: function( selector ) {
		if ( this.length === 1 ) {
			var ret = this.pushStack( [], "find", selector );
			ret.length = 0;
			jQuery.find( selector, this[0], ret );
			return ret;
		} else {
			return this.pushStack( jQuery.unique(jQuery.map(this, function(elem){
				return jQuery.find( selector, elem );
			})), "find", selector );
		}
	},

	clone: function( events ) {
		// Do the clone
		var ret = this.map(function(){
			if ( !jQuery.support.noCloneEvent && !jQuery.isXMLDoc(this) ) {
				// IE copies events bound via attachEvent when
				// using cloneNode. Calling detachEvent on the
				// clone will also remove the events from the orignal
				// In order to get around this, we use innerHTML.
				// Unfortunately, this means some modifications to
				// attributes in IE that are actually only stored
				// as properties will not be copied (such as the
				// the name attribute on an input).
				var html = this.outerHTML;
				if ( !html ) {
					var div = this.ownerDocument.createElement("div");
					div.appendChild( this.cloneNode(true) );
					html = div.innerHTML;
				}

				return jQuery.clean([html.replace(/ jQuery\d+="(?:\d+|null)"/g, "").replace(/^\s*/, "")])[0];
			} else
				return this.cloneNode(true);
		});

		// Copy the events from the original to the clone
		if ( events === true ) {
			var orig = this.find("*").andSelf(), i = 0;

			ret.find("*").andSelf().each(function(){
				if ( this.nodeName !== orig[i].nodeName )
					return;

				var events = jQuery.data( orig[i], "events" );

				for ( var type in events ) {
					for ( var handler in events[ type ] ) {
						jQuery.event.add( this, type, events[ type ][ handler ], events[ type ][ handler ].data );
					}
				}

				i++;
			});
		}

		// Return the cloned set
		return ret;
	},

	filter: function( selector ) {
		return this.pushStack(
			jQuery.isFunction( selector ) &&
			jQuery.grep(this, function(elem, i){
				return selector.call( elem, i );
			}) ||

			jQuery.multiFilter( selector, jQuery.grep(this, function(elem){
				return elem.nodeType === 1;
			}) ), "filter", selector );
	},

	closest: function( selector ) {
		var pos = jQuery.expr.match.POS.test( selector ) ? jQuery(selector) : null,
			closer = 0;

		return this.map(function(){
			var cur = this;
			while ( cur && cur.ownerDocument ) {
				if ( pos ? pos.index(cur) > -1 : jQuery(cur).is(selector) ) {
					jQuery.data(cur, "closest", closer);
					return cur;
				}
				cur = cur.parentNode;
				closer++;
			}
		});
	},

	not: function( selector ) {
		if ( typeof selector === "string" )
			// test special case where just one selector is passed in
			if ( isSimple.test( selector ) )
				return this.pushStack( jQuery.multiFilter( selector, this, true ), "not", selector );
			else
				selector = jQuery.multiFilter( selector, this );

		var isArrayLike = selector.length && selector[selector.length - 1] !== undefined && !selector.nodeType;
		return this.filter(function() {
			return isArrayLike ? jQuery.inArray( this, selector ) < 0 : this != selector;
		});
	},

	add: function( selector ) {
		return this.pushStack( jQuery.unique( jQuery.merge(
			this.get(),
			typeof selector === "string" ?
				jQuery( selector ) :
				jQuery.makeArray( selector )
		)));
	},

	is: function( selector ) {
		return !!selector && jQuery.multiFilter( selector, this ).length > 0;
	},

	hasClass: function( selector ) {
		return !!selector && this.is( "." + selector );
	},

	val: function( value ) {
		if ( value === undefined ) {			
			var elem = this[0];

			if ( elem ) {
				if( jQuery.nodeName( elem, 'option' ) )
					return (elem.attributes.value || {}).specified ? elem.value : elem.text;
				
				// We need to handle select boxes special
				if ( jQuery.nodeName( elem, "select" ) ) {
					var index = elem.selectedIndex,
						values = [],
						options = elem.options,
						one = elem.type == "select-one";

					// Nothing was selected
					if ( index < 0 )
						return null;

					// Loop through all the selected options
					for ( var i = one ? index : 0, max = one ? index + 1 : options.length; i < max; i++ ) {
						var option = options[ i ];

						if ( option.selected ) {
							// Get the specifc value for the option
							value = jQuery(option).val();

							// We don't need an array for one selects
							if ( one )
								return value;

							// Multi-Selects return an array
							values.push( value );
						}
					}

					return values;				
				}

				// Everything else, we just grab the value
				return (elem.value || "").replace(/\r/g, "");

			}

			return undefined;
		}

		if ( typeof value === "number" )
			value += '';

		return this.each(function(){
			if ( this.nodeType != 1 )
				return;

			if ( jQuery.isArray(value) && /radio|checkbox/.test( this.type ) )
				this.checked = (jQuery.inArray(this.value, value) >= 0 ||
					jQuery.inArray(this.name, value) >= 0);

			else if ( jQuery.nodeName( this, "select" ) ) {
				var values = jQuery.makeArray(value);

				jQuery( "option", this ).each(function(){
					this.selected = (jQuery.inArray( this.value, values ) >= 0 ||
						jQuery.inArray( this.text, values ) >= 0);
				});

				if ( !values.length )
					this.selectedIndex = -1;

			} else
				this.value = value;
		});
	},

	html: function( value ) {
		return value === undefined ?
			(this[0] ?
				this[0].innerHTML.replace(/ jQuery\d+="(?:\d+|null)"/g, "") :
				null) :
			this.empty().append( value );
	},

	replaceWith: function( value ) {
		return this.after( value ).remove();
	},

	eq: function( i ) {
		return this.slice( i, +i + 1 );
	},

	slice: function() {
		return this.pushStack( Array.prototype.slice.apply( this, arguments ),
			"slice", Array.prototype.slice.call(arguments).join(",") );
	},

	map: function( callback ) {
		return this.pushStack( jQuery.map(this, function(elem, i){
			return callback.call( elem, i, elem );
		}));
	},

	andSelf: function() {
		return this.add( this.prevObject );
	},

	domManip: function( args, table, callback ) {
		if ( this[0] ) {
			var fragment = (this[0].ownerDocument || this[0]).createDocumentFragment(),
				scripts = jQuery.clean( args, (this[0].ownerDocument || this[0]), fragment ),
				first = fragment.firstChild;

			if ( first )
				for ( var i = 0, l = this.length; i < l; i++ )
					callback.call( root(this[i], first), this.length > 1 || i > 0 ?
							fragment.cloneNode(true) : fragment );
		
			if ( scripts )
				jQuery.each( scripts, evalScript );
		}

		return this;
		
		function root( elem, cur ) {
			return table && jQuery.nodeName(elem, "table") && jQuery.nodeName(cur, "tr") ?
				(elem.getElementsByTagName("tbody")[0] ||
				elem.appendChild(elem.ownerDocument.createElement("tbody"))) :
				elem;
		}
	}
};

// Give the init function the jQuery prototype for later instantiation
jQuery.fn.init.prototype = jQuery.fn;

function evalScript( i, elem ) {
	if ( elem.src )
		jQuery.ajax({
			url: elem.src,
			async: false,
			dataType: "script"
		});

	else
		jQuery.globalEval( elem.text || elem.textContent || elem.innerHTML || "" );

	if ( elem.parentNode )
		elem.parentNode.removeChild( elem );
}

function now(){
	return +new Date;
}

jQuery.extend = jQuery.fn.extend = function() {
	// copy reference to target object
	var target = arguments[0] || {}, i = 1, length = arguments.length, deep = false, options;

	// Handle a deep copy situation
	if ( typeof target === "boolean" ) {
		deep = target;
		target = arguments[1] || {};
		// skip the boolean and the target
		i = 2;
	}

	// Handle case when target is a string or something (possible in deep copy)
	if ( typeof target !== "object" && !jQuery.isFunction(target) )
		target = {};

	// extend jQuery itself if only one argument is passed
	if ( length == i ) {
		target = this;
		--i;
	}

	for ( ; i < length; i++ )
		// Only deal with non-null/undefined values
		if ( (options = arguments[ i ]) != null )
			// Extend the base object
			for ( var name in options ) {
				var src = target[ name ], copy = options[ name ];

				// Prevent never-ending loop
				if ( target === copy )
					continue;

				// Recurse if we're merging object values
				if ( deep && copy && typeof copy === "object" && !copy.nodeType )
					target[ name ] = jQuery.extend( deep, 
						// Never move original objects, clone them
						src || ( copy.length != null ? [ ] : { } )
					, copy );

				// Don't bring in undefined values
				else if ( copy !== undefined )
					target[ name ] = copy;

			}

	// Return the modified object
	return target;
};

// exclude the following css properties to add px
var	exclude = /z-?index|font-?weight|opacity|zoom|line-?height/i,
	// cache defaultView
	defaultView = document.defaultView || {},
	toString = Object.prototype.toString;

jQuery.extend({
	noConflict: function( deep ) {
		window.$ = _$;

		if ( deep )
			window.jQuery = _jQuery;

		return jQuery;
	},

	// See test/unit/core.js for details concerning isFunction.
	// Since version 1.3, DOM methods and functions like alert
	// aren't supported. They return false on IE (#2968).
	isFunction: function( obj ) {
		return toString.call(obj) === "[object Function]";
	},

	isArray: function( obj ) {
		return toString.call(obj) === "[object Array]";
	},

	// check if an element is in a (or is an) XML document
	isXMLDoc: function( elem ) {
		return elem.nodeType === 9 && elem.documentElement.nodeName !== "HTML" ||
			!!elem.ownerDocument && jQuery.isXMLDoc( elem.ownerDocument );
	},

	// Evalulates a script in a global context
	globalEval: function( data ) {
		if ( data && /\S/.test(data) ) {
			// Inspired by code by Andrea Giammarchi
			// http://webreflection.blogspot.com/2007/08/global-scope-evaluation-and-dom.html
			var head = document.getElementsByTagName("head")[0] || document.documentElement,
				script = document.createElement("script");

			script.type = "text/javascript";
			if ( jQuery.support.scriptEval )
				script.appendChild( document.createTextNode( data ) );
			else
				script.text = data;

			// Use insertBefore instead of appendChild  to circumvent an IE6 bug.
			// This arises when a base node is used (#2709).
			head.insertBefore( script, head.firstChild );
			head.removeChild( script );
		}
	},

	nodeName: function( elem, name ) {
		return elem.nodeName && elem.nodeName.toUpperCase() == name.toUpperCase();
	},

	// args is for internal usage only
	each: function( object, callback, args ) {
		var name, i = 0, length = object.length;

		if ( args ) {
			if ( length === undefined ) {
				for ( name in object )
					if ( callback.apply( object[ name ], args ) === false )
						break;
			} else
				for ( ; i < length; )
					if ( callback.apply( object[ i++ ], args ) === false )
						break;

		// A special, fast, case for the most common use of each
		} else {
			if ( length === undefined ) {
				for ( name in object )
					if ( callback.call( object[ name ], name, object[ name ] ) === false )
						break;
			} else
				for ( var value = object[0];
					i < length && callback.call( value, i, value ) !== false; value = object[++i] ){}
		}

		return object;
	},

	prop: function( elem, value, type, i, name ) {
		// Handle executable functions
		if ( jQuery.isFunction( value ) )
			value = value.call( elem, i );

		// Handle passing in a number to a CSS property
		return typeof value === "number" && type == "curCSS" && !exclude.test( name ) ?
			value + "px" :
			value;
	},

	className: {
		// internal only, use addClass("class")
		add: function( elem, classNames ) {
			jQuery.each((classNames || "").split(/\s+/), function(i, className){
				if ( elem.nodeType == 1 && !jQuery.className.has( elem.className, className ) )
					elem.className += (elem.className ? " " : "") + className;
			});
		},

		// internal only, use removeClass("class")
		remove: function( elem, classNames ) {
			if (elem.nodeType == 1)
				elem.className = classNames !== undefined ?
					jQuery.grep(elem.className.split(/\s+/), function(className){
						return !jQuery.className.has( classNames, className );
					}).join(" ") :
					"";
		},

		// internal only, use hasClass("class")
		has: function( elem, className ) {
			return elem && jQuery.inArray( className, (elem.className || elem).toString().split(/\s+/) ) > -1;
		}
	},

	// A method for quickly swapping in/out CSS properties to get correct calculations
	swap: function( elem, options, callback ) {
		var old = {};
		// Remember the old values, and insert the new ones
		for ( var name in options ) {
			old[ name ] = elem.style[ name ];
			elem.style[ name ] = options[ name ];
		}

		callback.call( elem );

		// Revert the old values
		for ( var name in options )
			elem.style[ name ] = old[ name ];
	},

	css: function( elem, name, force, extra ) {
		if ( name == "width" || name == "height" ) {
			var val, props = { position: "absolute", visibility: "hidden", display:"block" }, which = name == "width" ? [ "Left", "Right" ] : [ "Top", "Bottom" ];

			function getWH() {
				val = name == "width" ? elem.offsetWidth : elem.offsetHeight;

				if ( extra === "border" )
					return;

				jQuery.each( which, function() {
					if ( !extra )
						val -= parseFloat(jQuery.curCSS( elem, "padding" + this, true)) || 0;
					if ( extra === "margin" )
						val += parseFloat(jQuery.curCSS( elem, "margin" + this, true)) || 0;
					else
						val -= parseFloat(jQuery.curCSS( elem, "border" + this + "Width", true)) || 0;
				});
			}

			if ( elem.offsetWidth !== 0 )
				getWH();
			else
				jQuery.swap( elem, props, getWH );

			return Math.max(0, Math.round(val));
		}

		return jQuery.curCSS( elem, name, force );
	},

	curCSS: function( elem, name, force ) {
		var ret, style = elem.style;

		// We need to handle opacity special in IE
		if ( name == "opacity" && !jQuery.support.opacity ) {
			ret = jQuery.attr( style, "opacity" );

			return ret == "" ?
				"1" :
				ret;
		}

		// Make sure we're using the right name for getting the float value
		if ( name.match( /float/i ) )
			name = styleFloat;

		if ( !force && style && style[ name ] )
			ret = style[ name ];

		else if ( defaultView.getComputedStyle ) {

			// Only "float" is needed here
			if ( name.match( /float/i ) )
				name = "float";

			name = name.replace( /([A-Z])/g, "-$1" ).toLowerCase();

			var computedStyle = defaultView.getComputedStyle( elem, null );

			if ( computedStyle )
				ret = computedStyle.getPropertyValue( name );

			// We should always get a number back from opacity
			if ( name == "opacity" && ret == "" )
				ret = "1";

		} else if ( elem.currentStyle ) {
			var camelCase = name.replace(/\-(\w)/g, function(all, letter){
				return letter.toUpperCase();
			});

			ret = elem.currentStyle[ name ] || elem.currentStyle[ camelCase ];

			// From the awesome hack by Dean Edwards
			// http://erik.eae.net/archives/2007/07/27/18.54.15/#comment-102291

			// If we're not dealing with a regular pixel number
			// but a number that has a weird ending, we need to convert it to pixels
			if ( !/^\d+(px)?$/i.test( ret ) && /^\d/.test( ret ) ) {
				// Remember the original values
				var left = style.left, rsLeft = elem.runtimeStyle.left;

				// Put in the new values to get a computed value out
				elem.runtimeStyle.left = elem.currentStyle.left;
				style.left = ret || 0;
				ret = style.pixelLeft + "px";

				// Revert the changed values
				style.left = left;
				elem.runtimeStyle.left = rsLeft;
			}
		}

		return ret;
	},

	clean: function( elems, context, fragment ) {
		context = context || document;

		// !context.createElement fails in IE with an error but returns typeof 'object'
		if ( typeof context.createElement === "undefined" )
			context = context.ownerDocument || context[0] && context[0].ownerDocument || document;

		// If a single string is passed in and it's a single tag
		// just do a createElement and skip the rest
		if ( !fragment && elems.length === 1 && typeof elems[0] === "string" ) {
			var match = /^<(\w+)\s*\/?>$/.exec(elems[0]);
			if ( match )
				return [ context.createElement( match[1] ) ];
		}

		var ret = [], scripts = [], div = context.createElement("div");

		jQuery.each(elems, function(i, elem){
			if ( typeof elem === "number" )
				elem += '';

			if ( !elem )
				return;

			// Convert html string into DOM nodes
			if ( typeof elem === "string" ) {
				// Fix "XHTML"-style tags in all browsers
				elem = elem.replace(/(<(\w+)[^>]*?)\/>/g, function(all, front, tag){
					return tag.match(/^(abbr|br|col|img|input|link|meta|param|hr|area|embed)$/i) ?
						all :
						front + ">";
				});

				// Trim whitespace, otherwise indexOf won't work as expected
				var tags = elem.replace(/^\s+/, "").substring(0, 10).toLowerCase();

				var wrap =
					// option or optgroup
					!tags.indexOf("", "" ] ||

					!tags.indexOf("", "" ] ||

					tags.match(/^<(thead|tbody|tfoot|colg|cap)/) &&
					[ 1, "", "
          " ] ||

					!tags.indexOf("", "" ] ||

				 	//  matched above
					(!tags.indexOf("", "" ] ||

					!tags.indexOf("", "" ] ||

					// IE can't serialize  and 
  

  
  


    
          


circuits-2.1.0/examples/web/baseservers.py0000755000014400001440000000033712113343751020367 0ustar  prologicusers#!/usr/bin/env python

from circuits import Component
from circuits.web import BaseServer


class Root(Component):

    def request(self, request, response):
        return "Hello World!"

(BaseServer(8000) + Root()).run()
circuits-2.1.0/examples/web/jsonrpc.py0000755000014400001440000000035212113343751017516 0ustar  prologicusers#!/usr/bin/env python

from circuits import Component
from circuits.web import Server, Logger, JSONRPC


class Test(Component):

    def foo(self, a, b, c):
        return a, b, c

(Server(8000) + Logger() + JSONRPC() + Test()).run()
circuits-2.1.0/examples/web/makotemplates.py0000755000014400001440000000144712113343751020714 0ustar  prologicusers#!/usr/bin/env python

import os

import mako
from mako.lookup import TemplateLookup

from circuits.web import Server, Controller, Static

DEFAULTS = {}

templates = TemplateLookup(
    directories=[os.path.join(os.path.dirname(__file__), "tpl")],
    module_directory="/tmp",
    output_encoding="utf-8"
)


def render(name, **d):
    try:
        d.update(DEFAULTS)
        tpl = templates.get_template(name)
        return tpl.render(**d)
    except:
        return mako.exceptions.html_error_template().render()


class Root(Controller):

    tpl = "index.html"

    def index(self):
        return render(self.tpl)

    def submit(self, firstName, lastName):
        msg = "Thank you %s %s" % (firstName, lastName)
        return render(self.tpl, message=msg)

(Server(8000) + Static() + Root()).run()
circuits-2.1.0/examples/web/acldemo.py0000755000014400001440000000100112113343751017434 0ustar  prologicusers#!/usr/bin/env python

from circuits import handler, Component
from circuits.web.errors import Forbidden
from circuits.web import Server, Controller


class ACL(Component):

    allowed = ["127.0.0.1"]

    @handler("request", filter=True)
    def on_request(self, request, response):
        if not request.remote.ip in self.allowed:
            return Forbidden(request, response)


class Root(Controller):

    def index(self):
        return "Hello World!"

(Server(("0.0.0.0", 8000)) + ACL() + Root()).run()
circuits-2.1.0/examples/web/sslserver.py0000755000014400001440000000034212113343751020067 0ustar  prologicusers#!/usr/bin/env python

from circuits.web import Server, Controller


class Root(Controller):

    def index(self):
        return "Hello World!"


(Server(("localhost", 8000), secure=True, certfile="cert.pem") + Root()).run()
circuits-2.1.0/examples/web/wiki.zip0000644000014400001440000004734612072034467017175 0ustar  prologicusersPK
	P>wiki/UT	ZM
kMuxddPK
T=>	wiki/tpl/UT	?CM
kMuxddPKT=>Mwiki/tpl/edit.htmlUT	?CMiMuxdd}Sn0=7_	(apԬfKlCkmGfb!It(I5&H~-~?Yf?>}1	j&c%{Brb/]׍+.>3r3.(E]r"qeJ8ç/%Ȃg1*Ԑ^u<$[ՠ2475B	L\î3pGKc0_)ؽڽ>#ӪMg=8Z8ʦ*j},/uIzSz,;ip%r:N$'a"wt

%[	GbP7LaHx%U(` erj
At{Nu8N?GW>OsUr7e6zxIR0{Mh!rc>᫔˂%d@ymk:,5Yח!p 48Q;kMja*ug#uKΓwRE9U0^Ag_4PIM
X,n0k5`x5ڬT.reV<ݛ,؀u4/Lc밿ޠ&KHGPKT=>Hjwiki/tpl/view.htmlUT	?CMiMuxdd}R]0|
cC(5ս#m%@wGAlNM{lg;Z~]+RbB~.[KSpOfӷ;Z%#%DlnNݱ;Yi&iXDz)4n*-A~JQ&]ʆ@xEU
*Ťj3p/D#vAi	iՁNU4VRoD:@6ywԪSW %1VW
>Gdt*(i!Կ!2	^~WySgҍ)(ZQPwPq-bgBEzh2ƲHxRMXTRC`?O'gn^cהq2㿶`%lm:PMwiki/defaultpages/UT	?CM
kMuxddPKT=>Rx.4wiki/defaultpages/SiteMenuUT	?CMiMuxddRv++	HLOM
:g&g@R+<PK
T=>%>**wiki/defaultpages/RenderedPreUT	?CMiMuxdd{{{
== [[Nowiki]]:
//**don't format//
}}}
PKT=>j(wiki/defaultpages/MacrosUT	?CMiMuxddUML./VⲱPKT=> 8$(wiki/defaultpages/BulletListUT	?CMiMuxddRp*I-Q,.RNMKQ,IrK lPKT=>X$D<	wiki/defaultpages/CheatSheetUT	?CMiMuxddAo0VOvVui*9xѦ3$4ΖCǟGn\=&Ţ[ ȿ>e
2G٨]mK<iMiQa!$c\Xct=ix+,a	wiki/defaultpages/NoLineBreakUT	?CMiMuxddNo
linebreak!

Use empty row
PKT=>`rPH-0wiki/defaultpages/MixedListUT	?CMiMuxddSVͬHMQ,.R.MRH*I-Q,IRV+MJ-*PK
T=>Jeo wiki/defaultpages/HorizontalLineUT	?CMiMuxddHorizontal line:
----
PKT=>0 F*7wiki/defaultpages/HeadingsPageUT	?CMiMuxddUI,JOUHMLK粵UMM,U@*&UPK
T=>O55wiki/defaultpages/IndentedUT	?CMiMuxdd> Indented regions\\
> can include
>> block elements
PKT=>yfrwiki/defaultpages/SandBoxUT	?CMiMuxdd10{> 4)D(NC
M7+00v^Mg%aݴfizP]Hjj*D7PKT=>t!/wiki/defaultpages/RenderedTableUT	?CMiMuxdd-ILIHMLI-IyI<PKT=>:wiki/defaultpages/FrontPageUT	?CMiMuxddTn0+.+e;BEՅةF8tRj4DZ.wet^?*0%OI3EӴVԮL:TP6xk2Au&E?ʞ;8&=;;#H~KoM|J8lÍ66r]8zk}o\MoS/k ð.VG}ߗ퐴wzםrSZ[Lr	D+T`o!r@Ti$8M,#_1\$+yf)ySs/Yi'P5I*u"?ʀfҦOf9&')'s]LA&]r2Ir]Sdte0$W{i6Ȇ{v$#lm16
2c.!-mՈUrfJt8+;,jK++tTHwX9,g]\fuٶMG%Hy䃆L79~f`K&ɲ؟
/~&*wiki/defaultpages/NumberedListUT	?CMiMuxddSV+MJ-JMQ,.RVNMKQ,IRrK lPKT=>^QJ_ wiki/defaultpages/DefinitionListUT	?CMiMuxddVpIM,S,.BPK
T=>wiki/macros/UT	?CM
kMuxddPKT=>#owiki/macros/include.pyUT	?CMiMuxddݔ=O0w
"0rKj5Csv>TR8:)壭Q#&xJ34%o׀$8A腔R\-Z0`Qj4FBc3Ih$оr6OVX>;9l߲;>m,1
iV*Kl
wiki/macros/html.pyUT	?CMiMuxddVQo0~ϯYHPj^'Z*MӪ>}&aIjv
8	!NC_ﾻs@}k)ޯPHK*"%hʒ
g#Pu)qzŚr\Sa3%[6
%!ExN.w捉CfokFY+N(ƞxbJD-]Ə'%fJ	0+
lЭq,dKAQa
,?jYT1L&R$
d]rjٯٍ\	T<j4t~^^^:xip0N)kAʂ
YO#XvD	Cb_cu~i@ˉm9JM59ߋƴ/n{ַHfA{qYAIAJ웪hҺیc?r4ylP_
l|nKW>B83k~;!kwiki/macros/wiki.pyUT	?CMiMuxdd-10EqKC
N 	2~CCqxaKͼN$L@YWj*Ń%:+~/[~>)Y"L	0f
4T	վZ܊7fӚ?PKT=>_swiki/macros/__init__.pyUT	?CMiMuxddTMk0WLvp
ṟ-,B]5e$q(lKEf{le,ni.;负dho19cz&YzjW54*~n6yl#K)k$Wn?!3=h
B1թУB^Q@㵂v۾"օ)WD
\;WɲZjbH~oBh?Ni7AmbRe.>I5Ύk^1b'6Ù痜y`nX"keC
Bebt'ZBoxz^O<"LQ7`#hP ń8YNltSOt@IW\T3qHu6)HO>Xw!&پ+!one|p*3>(6`+,~eVmaؑ}JqPVL;<S*𯼼oBrL T}>Z*aPKT=>qGwiki/macros/utils.pyUT	?CMiMuxdd=OA0BKBOmno;Hj~ĭ.	G)tŘEpD4z]>3e)_Վy77P"JV/PK
T=>wiki/static/UT	?CM
kMuxddPK
T=>wiki/static/css/UT	?CM
kMuxddPKT=>#7wiki/static/css/pygments.cssUT	?CMiMuxddVMo0WD[Wh햪T۳UǎlV`:@ذޛ73SƂAG"E"	
`.Pz:3jyp'/BrmZ/%o	2%r G'$->
Mx泘ikgd,r&	Ă[oFyœ3uIh,B1Ib
*=p#`V2$YvGxjTR&6Ȩ6f-`	\Eڲlw+epw}/˥{1Z_kr>±R"ڃ>xIU̶!=ĒWEn7QC~’|XʃgY,uie
K8a[-ei3,-6?r
L4LIE85XSiFK[cd^ HԹÎ"-E6s2XukF;wiki/static/css/screen.cssUT	?CMiMuxddVKo6>'@#ض9vmkA
E-;|I-w[Ԅ
s8ϏÙuw{`U1hDbVH.$jBfҨRP'co+Uh:8U,BiYV=蒎*V:z>l7'p.94d&gߥ

lwfMBEV}Yy
ZYSŗ=cxRNKmK.eQL,BpǚsYKM,tpWL;duDqb14MV	z#s3Ͷޒdvi(}rt*jPk-/ 2K1T7IZYggֻ`e-92kc$L`EnFb-m:	7#a
%K|a5gspR둵>V$F2~@ⱆj@6@p&i6ҕ'
hv7裒ƯR~ƿ~K_0R`t:`x#Y^@?ٛv@fєu(½v=YGsFPPqG
D==4yr5ɒBHNsux|3M6ޒ>v!hC߱JcGIX'ʷ!MY+=:*mE(N-:yE6CSxi	:[U
^T3]C8q&j$ ƙe#k9>ŘG,^*s7ɴ0c7/(*.gy??*\Ӗ3X2p@!T7ӄ+M4;nmuJTq>\nC/4:A+:!R.Fm<7+ۨd5*B?PKT=>Cwiki/static/favicon.icoUT	?CMiMuxdd]	T]6
E&BH6"$-[2ɒ]ɾ2Bcߗ>{.Dϗ{s=\=v2.2PXAD;lVVX[[ccc-vvvɓyboo#8::䄳3
`*T\]])\0E͍EP(pwwXb/^J(Aɒ%)U.]2ePlY(Wޔ/_AB
TXJ*QreTBժUVիWFԬYZjQvmԩCݺuWקA(J6lHFhܸ1M4חMҬY3h޼9-Ze˖T*iժҺukڴiCPPm۶]voߞ`:t@HH;vSNtZM.]ڵ+ݺu{уPzI^ݻ7}o߾׏3`8p 
B0x`СC6lÇ'<<#F0rHFѣ3fcǎeܸqDDDjL0'2i$&O̔)S:u*ӦMCә1c3gd֬YDGG3{l̙ܹs7og,\EŋYd	K.eٲe,_^Oll,+V`ʕZիWf֮]˺uX~=6l`ƍlڴ͛7en݊` ..xmٱc;wd׮]޽={w^9pСC>|#G`49z(ǎ$$$p	L&'O$11SNqiΜ9CRRfgr9Ο?υx".]\rWr5_΍7y&nܹsdDQݻܻw>|ȣGx1)))Ɠ'Ox)Ϟ=#==y/_իW~7o[޽{GFF߿Ç|L>}ϟ˗/|o߾$Ors*(Iogd_NDŠQj$Y$Q)%˙ *UdΨՒd;,*Ag
NTh,^a0kBM% ZtzsQ2JVjQԨ?0.f"OFDF&&RM$$OPKT=>6!	wiki/static/Image.jpgUT	?CMiMuxddUw8]3Q=z޻%D$:yE JQHDe[h]xs9k_y}~Z7#&!"HIP22b2R1JJ|ˈ4)P>>BH)))adwvdw {7P@0&@!'A@V>_|JVe!T'Z%]8"`C޷7՝û" w! :=|7B㳊PR)Qaٍq#`!>eRAwsaJUfڗ꫆ETsŢܔǽ%=0AtiӇ(4k|:vx;.0tP&Z  x|F? <\Q#%KfBwdC}x}X|9ŞEbqrfU~,spcUoz2>1υ*#Ϸq,zQ\^1DPyΠV~6}]{^(3u?NأY0=Z綜'ݶ8oE_RߗQ}D^!|usmSa
/
>δ-p
%wJJ進wYXYYdic}	p=X{j-t^]4,i&3+B͛~oS
62˜KFijefʤ?a rPK5O3ʅHR'KJ\Qȏ^&OqD\I2ͱYI0^IQ/6i;%O(:n[^G=<}8>S)Q8cÿon7ڿtJU-=]Wk"pv
Ӣ"(+%nx摧de5z7eJM˭|$kqBl@	̀S>'ܿ|Toja)0`D
T
t1IU/*y?fLdznzHBWm^гкk$(jy=V#{2H0%<O?H

IƯ屨tlj/u~YQJ*W~)\IOP#e{td(;jt='T)>5U#re5raZn!F\R-&F0S	)x[0g53?sڭlJ~Asz
OJjٓσgH
ZueT>KbE)-Q8@tJ=ClNЇ^0@R>EBG
z/]ys4q2sO#ekYOs&]&@I΃L>Զ&ҪM5EOVM鍛al;>Ϝ-B4ΉӑZ&SE?NzP{5jmW!|O7PXJG	S`څbj֦˲:0à6
I6.99v()=R/;icN2mJ~?ȊNbClJv#ÕֵuHKzczTiQcm
"_Ih߉*8f9^ϖsgk*(s`LH67Nde@tWsWb*
,CjJsBܺhTc?f;Y7H?x[b
|}Ȱ/jKtM#͖me8$R!oa%Zpu!Rfy\<Ry*%XCH)籘U3˳l)0O(gZhjQDZX-Z>)p{	d4UJQ^S`VĆZ2@nDSiT28 vsi$d_T/{0سNyn_Þ{$Ycý U=4-`kUp
n~݉uǰ
aNuئӧr)2
)	A	~);ޙv
kKeL0vQ/KDo>*%▽R멄b6<ťxcHIaڐ-id*`iQC@JxNt	TAe#po!oϓDڅ{yVG3KҖ]DѲ0Ҩ˚ggnV
)kδ\ޚL	!#x?풗
r{I4[=(o}4rR
BgrVS*X4gyJZ\p9榊h6:
P a;MS|fu$H0!s	TU*Cn
#z3E[~+GVᇑ{p'jM*l\+ķRq5c2fDFΏ0a|pgc8Gv㍂x`XUOjwEan;WYfXu,G{ΈLQ˧zcxJ1&unːŭ32OkC2oFf66v.\|@ѵu*gt&@.	DNiOc{/0Zʓrh),rW/5c *GӃoFCl3!ÁC~)-,׌Kl/o-?J1ݑ@z׳O{El$+^gl*"b١AF AgA,0VH#+/qTnw6KL55ڀXԒX|gDUX/-DKb-[C]܆I?"__ԁ融PuLE=6R$jF~&a(r_1ّ#]Ͼfn)>d:V])97
;ՇոR|JLV&ց8Qֵ,g%l2ܐ@ٓ8c4χ~te|!>\t+x܎7<ƈ:5o¤ќ11;$O&#aZmk匧Ւ\,D	,)
0
tkz33إ)(VI
ϣPo8BP-.CMH@\{sp.9(i>'u:Ukv\8$Jݳ;~&䨮pypU-d:UӼ2kĞ>HXe`\'󐣢uRss|Mg-(Фr9b%e6ٌ5,Yzf|z$zbyY\?ʗ%Y8;}*hZz?ӲRmy&
lӵiIWjBIC\,^:?s=!(k"7Lx$n{Q"߀5M0^ 6 {%-.Eawiki/static/images/UT	?CM
kMuxddPK
T=>(M#%% wiki/static/images/header_bg.pngUT	?CMiMuxddPNG


IHDRl(?gAMA7tEXtSoftwareAdobe ImageReadyqe<PLTE@{,U;q2`@zC=tB~.Y,U?x,VB~A|-W3b4e:pw>v>v1^9m-W8l0\A}B}?y-WA}=uA{w,V.Y5e?y:o3a0]-X1_7i0]9n>w/[YIDATx"Ce%;!3ى;ǶtƖ_L#J1fƧm?o=ׁ{6yUԆKYuT[5w'j
",ə4WW&[oZ4=+Iɦ
 IENDB`PKT=>ߐՔ	wiki/wiki.pyUT	?CMiMuxddVn8}W,
ݗ"YiB%:aW"U{g(ZCmĹ93ḟIs}?KfS+I`t=&]]M.@c
?MCpOl$ΗOL||z-;Ua}\4ұInjPqzI03*t*֎7
xT+ٖF+C0պ#Q儨Hj*IRz'	}>N
)2`tO٠X{AG5uOăxdX@Jy>msz..@D|64OO'D2BzC][-~){}HSX0([@Zty(|	<`KiO
Z>act/8fWUUf_ZMq5\PK
	P>Awiki/UTZMuxddPK
T=>	A?wiki/tpl/UT?CMuxddPKT=>Mwiki/tpl/edit.htmlUT?CMuxddPKT=>Hjwiki/tpl/view.htmlUT?CMuxddPK
T=>AWwiki/defaultpages/UT?CMuxddPKT=>Rx.4wiki/defaultpages/SiteMenuUT?CMuxddPK
T=>%>**%wiki/defaultpages/RenderedPreUT?CMuxddPKT=>j(wiki/defaultpages/MacrosUT?CMuxddPKT=> 8$(
wiki/defaultpages/BulletListUT?CMuxddPKT=>X$D<	wiki/defaultpages/CheatSheetUT?CMuxddPK
T=>!
wiki/defaultpages/NoLineBreakUT?CMuxddPKT=>`rPH-0
wiki/defaultpages/MixedListUT?CMuxddPK
T=>Jeo wiki/defaultpages/HorizontalLineUT?CMuxddPKT=>0 F*7wiki/defaultpages/HeadingsPageUT?CMuxddPK
T=>O55	wiki/defaultpages/IndentedUT?CMuxddPKT=>yfrwiki/defaultpages/SandBoxUT?CMuxddPKT=>t!/K
wiki/defaultpages/RenderedTableUT?CMuxddPKT=>:
wiki/defaultpages/FrontPageUT?CMuxddPKT=>~&*wiki/defaultpages/NumberedListUT?CMuxddPKT=>^QJ_ Swiki/defaultpages/DefinitionListUT?CMuxddPK
T=>Awiki/macros/UT?CMuxddPKT=>#owiki/macros/include.pyUT?CMuxddPKT=>Kl
wiki/macros/html.pyUT?CMuxddPKT=>;!kbwiki/macros/wiki.pyUT?CMuxddPKT=>_s4wiki/macros/__init__.pyUT?CMuxddPKT=>qGwiki/macros/utils.pyUT?CMuxddPK
T=>Awiki/static/UT?CMuxddPK
T=>AUwiki/static/css/UT?CMuxddPKT=>#7wiki/static/css/pygments.cssUT?CMuxddPKT=>;, wiki/static/css/screen.cssUT?CMuxddPKT=>CE$wiki/static/favicon.icoUT?CMuxddPKT=>6!	$)wiki/static/Image.jpgUT?CMuxddPK
T=>A|;wiki/static/images/UT?CMuxddPK
T=>(M#%% ;wiki/static/images/header_bg.pngUT?CMuxddPKT=>ߐՔ	H>wiki/wiki.pyUT?CMuxddPK##"Bcircuits-2.1.0/examples/web/basecontrollers.py0000755000014400001440000000033412113343751021241 0ustar  prologicusers#!/usr/bin/env python

from circuits.web import Server
from circuits.web.controllers import BaseController


class Root(BaseController):

    def index(self):
        return "Hello World!"

(Server(8000) + Root()).run()
circuits-2.1.0/examples/web/ssl-forward-cert.py0000644000014400001440000000100112113343751021223 0ustar  prologicusers#!/usr/bin/env python

# stdlib
import ssl

from circuits.web import Server, Controller


class Root(Controller):
    def GET(self, peer_cert=None):
        return "Here's your cert %s" % peer_cert


class SSLServer(Server):
    pass


def main():
    ssl_server = SSLServer(
        ("localhost", 8443), ssl=True,
        certfile="server-cert.pem", keyfile="server-key.pem",
        ca_certs="ca-chain.pem", cert_reqs=ssl.CERT_OPTIONAL
    ) + Root()
    ssl_server.run()

if __name__ == "__main__":
    main()
circuits-2.1.0/examples/web/shadowauth.py0000755000014400001440000000550612113343751020215 0ustar  prologicusers#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""An example of a Circuits Component that requires users authenticate
against /etc/passwd and /etc/shadow before letting them into the web site."""

import os
import re

from circuits import handler, Component
from circuits.web import _httpauth, Server, Controller
from circuits.web.errors import HTTPError, Unauthorized

__author__ = 'Dan McDougall '


def check_credentials(user, password):
    """
    Checks a given user and password against /etc/shadow (or /etc/passwd if
    /etc/shadow doesn't exist).  Returns True on success and False on failure.
    """

    from crypt import crypt
    shadow_hash = ''

    # Matches salts, e.g. "$1$72p6zzHp$"
    salt_regex = re.compile(r'\$.*\$.*\$')

    if os.path.exists('/etc/shadow'):
        password_file = '/etc/shadow'
    else:
        password_file = '/etc/passwd'
    shadow = open(password_file, 'r').readlines()
    for line in shadow:
        cols = line.split(':')
        if cols[0] == user:
            shadow_hash = cols[1]
    if salt_regex.match(shadow_hash):  # If there's a hashed password...
        salt = salt_regex.match(shadow_hash).group()  # Grab it
        hashed_pass = crypt(password, salt)  # Now hash the plaintext password
        if hashed_pass == shadow_hash:  # If they match...
            return True
    return False


class PasswdAuth(Component):
    """A Circuits Component that authenticates the user using the credentials
    stored in /etc/passwd and /etc/shadow (if present)."""

    channel = "web"

    def __init__(self, name="circuits.passwdauth", *args, **kwargs):
        super(PasswdAuth, self).__init__(*args, **kwargs)
        self._name = name

    @handler("request", filter=True)
    def authcheck(self, request, response):
        """Obtains the authorization header (if any) and checks the supplied
        username and password against the credentials stored in /etc/passwd
        and /etc/shadow (if present)"""
        if 'authorization' in request.headers:
            ah = _httpauth.parseAuthorization(request.headers['authorization'])
            if ah is None:
                return HTTPError(request, response, 400)
            username = ah["username"]
            password = ah["password"]

            auth_result = check_credentials(username, password)
            if auth_result:  # User authenticated successfully
                request.login = ah["username"]
                return
        response.headers["WWW-Authenticate"] = _httpauth.basicAuth('System')
        request.login = False
        return Unauthorized(request, response)


class Root(Controller):
    """Our web site"""
    def index(self):
        return "Hello, %s" % self.request.login

(Server(8000) + PasswdAuth() + Root()).run()
circuits-2.1.0/examples/web/static/0000755000014400001440000000000012113366740016755 5ustar  prologicuserscircuits-2.1.0/examples/web/static/css/0000755000014400001440000000000012113366740017545 5ustar  prologicuserscircuits-2.1.0/examples/web/static/css/base.css0000644000014400001440000000354012072034467021175 0ustar  prologicusers@import url(/css/ext/ext-all.css);
@import url(/css/ext/xtheme-aero.css);

/* Main Layout */

* {
	font-family: "Bitstream Vera Sans", "Verdana", sans-serif;
	font-size: 10pt;
	margin: 0;
	padding: 0;
}

body {
	background: none rgb(240, 255, 240);
	min-width: 600px;
}

h1 {
	font-size: 18pt;
}

h2 {
	font-size: 16pt;
}

h3 {
	font-size: 14pt;
}

h4 {
	font-size: 12pt;
}

h5 {
	font-size: 8pt;
}

a:link, a:visited {
	color: #888888;
	text-decoration: none;
	border-bottom: 1px dashed;
}

a:focus, a:hover, a:active {
	border-bottom: 1px solid;
}

#window {
	position: relative;
	width: 600px;
	top: 10px;
	margin: 0 auto;
	border: 2px solid rgb(100, 155, 100);
	background: none rgb(255, 255, 255);
}

#header, #footer {
	background: none rgb(34, 170, 34);
	color: rgb(255, 255, 255);
}

#header {
	padding: 20px 5px 5px 5px;
}

#header h1 {
	text-align: center;
}

#footer {
	padding: 5px 10px;
}

/* Content */

#main {
	margin: 0 auto;
	padding: 20px;
	height: 300px;
	border: none;
	background: none rgb(255, 255, 255);
}

.main h2 {
	padding: 6px 0;
}

.main dt {
	padding: 4px 0:
}

.main dd {
	padding: 0 20px;
}

/* Menu */

#menu {
	color: rgb(0, 0, 0);
	background-color: transparent;
	font-family: arial, helvetica, sans-serif;
	white-space: nowrap;
	list-style-type: none;
	margin-top: 20px;
}

#menu ul {
	background: none;
}

#menu li {
	display: inline;
	border: 1px solid rgb(70, 100, 70);
	background: none rgb(255, 255, 240);
}

#menu a {
	padding: 2px;
	margin: 0px;
	color: rgb(0, 0, 0);
	text-decoration: none;
	border: none;
}

#menu a:hover {
	background: rgb(100, 100, 100);
}

/* validate icons */

#icons {
	float: right;
	margin-top: 5px;
}

#icons img, a:link, a:active, a:focus, a:visited, a:hover {
	border: none;
}
circuits-2.1.0/examples/web/static/img/0000755000014400001440000000000012113366740017531 5ustar  prologicuserscircuits-2.1.0/examples/web/static/img/vcss.gif0000644000014400001440000000301312072034467021175 0ustar  prologicusersGIF89aXsG6dT|LLLࡷْ,,,}}}!U捍MdD]]]&YEp<<1999ÜN^f3a̙3JZޱX{sf( ffffffffffffffffffffffffffffffffffffffffffffff!
Valid CSS!!,X$$%GF+%ĭʓ͟Ǵ՛А	
ب
<!xEI-&`
PP၅&@B`M CH`ҁ
8DTIJ.L@${$po҃
#i9tp*|C1$(0)0pXd`A@:6@H.RIH7i,lxM7kGAZu;p8u)12701<c 6J>jXN逺+Q`	9Ǎ8t/ؿ@"x%K,e9.U"WR8%`5aA=&9ʀ%&@FlYFpw@dWwbenH`Z %	pɋ"\"IY
`m_W9	B(ESIq
Ί9	T	#@H'K s7M"C
@[E(?!l⒰G,
Wlg0Q!
,$	

	L~@,ny;Aj{r$DAgi[7Bs%ebi^;'Z*P?D$w+T#aDMr<7#P/D6Q<BD	$oL{0+XϠC;circuits-2.1.0/examples/web/static/img/rss.gif0000644000014400001440000000255712072034467021042 0ustar  prologicusersGIF89a$8HWTYZ
V_^PX#cjc
e`mmw|?(6"#)=#6I	HJPYM$X8M R']8g?DINVVPKP
WZ$V&^.T%[3W W([&\&]1bag?is6ɄVׇK݈GہLՆUԌZŃIĉfƑrՌbԓiޔgԕtENUSXmch`rS[yajbv~|`jmt}vyw{}ťϦܹۨ߰始ꪆꭑ봋쿨̸ƄȄǍɕțЅіŧĭʹԤ٢ڭױҼ߹ֹ!,$7[xӥM,a
{[ְ`|f˖Yx;B^"iAsfM\y0l*L/_ZGI㓧HeP&2RDOSN)h.tDNݽfPpg/^=vVqfݽweIsh]9bOCFblkTQ
:u]eNF)Ad> !+C	&MhV^ PM9ܤR=~RB<}yUB9~`H2>$A>S	H>cJWhpO@+fEx0@0	`4<0@뀹0@;circuits-2.1.0/examples/web/static/img/valid-xhtml10.png0000644000014400001440000000455612072034467022645 0ustar  prologicusersPNG


IHDRX#DPLTE{9ތBBcZZބB{{ޥ{޵RssޭRZs{Rc19Jc猭RZ)J!{{{ZZJs9JZRJsssJk1!c1kkkBs9ƜJccck1c1kcRk99J֜kkƥZε9999R){9{c1s9111J!1{Jk1){)))ZֵBƽZ9))csZΥZkcRcR)cJ)9c1{9Zs1Z{skZB{BJJsBsBBJJ֌kB9skR)!sZ1kB1scRkZRB!ΥRkR)ZcsRcZZZZ9BJZ)ZJRRR!ZJ1kk)BJ{JJJ{ֵccZR֭cBBBޭc91c޵Z{sR1){J9{kR1!{ZJ!֭R)!sZ)ZZB!c֥R{RcckR!sZsZRJ!޽9sJRRJ9kRJJ!R޵cB?tRNSlIty]Dq>`IDATxڕV_E˻aFڊQY	DTrDiPP"|94B":$4G):[F~3w~=fs@Ŵ{"Ք5CYeF$WPVFt'1|NcDc>1YÕ-{~BI`[%[#I$H%aD|D	cO(Loau()y*aҺ)}*`&lf0wvӿfXmM>Dزn9kZ2ps!acf&Ia:Tqsr=4On
XL|Ԥjar|c9G+@yuJ\#1twA#G4H_5A=xb9*t5o{x5I,M*:	AN(Y$Im9Hbmi	feNBK~nfk~[pcD16)@hi)M?R&ȅHY)m4ZdTt#4~"T%.eVv%_ȥXd^.ЪhlzfRJdds*tYF\8LhX:֝U"_7e[ʆigJ;ܽqg7:AQOzr`7PaaaL፞g4@>	n;4h[l``'N
!Ҩ	ύWO*oхG`f3
;y_+'H6ssGAoѪh9Aq>g
 
  An example application
 

 
          This is my sample application
          
 Put the content here...
 
          
 Quit


"""


class Root(Controller):

    def index(self):
        return HTML

    def exit(self):
        raise SystemExit(0)

server = (Server(8000) + Root())
server.start()

webbrowser.open("http://127.0.0.1:8000/")
server.join()
circuits-2.1.0/examples/web/authdemo.py0000755000014400001440000000121712113343751017647 0ustar  prologicusers#!/usr/bin/env python

from circuits import handler, Component
from circuits.web import Server, Controller
from circuits.web.tools import check_auth, basic_auth


class Auth(Component):

    realm = "Test"
    users = {"admin": "21232f297a57a5a743894a0e4a801fc3"}

    @handler("request", filter=True)
    def on_request(self, request, response):
        realm = self.realm
        users = self.users
        if not check_auth(request, response, realm, users):
            return basic_auth(request, response, realm, users)


class Root(Controller):

    def index(self):
        return "Hello World!"

(Server(("0.0.0.0", 8000)) + Auth() + Root()).run()
circuits-2.1.0/examples/web/server-key.pem0000644000014400001440000000321312072034467020266 0ustar  prologicusers-----BEGIN RSA PRIVATE KEY-----
MIIEowIBAAKCAQEAmxC+vKAuNl8XBThOHxuPIZw4teDQBBrKdpplNxeiMcCFqma3
wDF56gDhr5s3u0PUFSDbmCHmIWzux0nboTUV5mw6WnnPjFa5KNonLc9D1Jl3SEH5
+hm8CEGazy3n4FXp1LxpheFiX3SVCAHV3H91ql2RFu3eTsjPXOlDb87GzVjRQxvw
ttUdzNdEvNwMnBKLRLJzehzm9QhWy9pictbaWog3OLuuwnQ3s+Su3iixzJ5sysF1
7vzRTWwBtJ/uuPQlJbOGq1+Inw1CAzHFokJG+C0SFc5FP/C8Qh6m7/fZi1uoHCXt
g75L9IPk03fOuvSLCT8Y7MrYuN38UM20D6JsBwIDAQABAoIBABUtJj8wSN9YARbP
Z6vL4bIfWYdNGltVJU0pLKVnbtkIh7iLqpBusU2JrUiEFApY6v+vqw2No5XxAHLq
3TmYvFLpeNaeR//MYCD6GduhsIu6IZYWnILRPOKLww6EIGR8lyBcUrTb4MlUbH3Z
clFYfsMzX/sXpQJxXhA8Mt90B6ZHQm8ky4dNlQnX3oAB04m3fGpmxiEo+3p46cWo
Q8hzxX6EfDtifuT9Zo3x+WoHa3momxvi2b0jt2xdwSxNT4/phGw1uBWrcrt9BtS5
l6EGaIFA6PsUrkie9vHelaaKhjF18uwpqjS9Zb7eNHQX9/hGtrNMhtJNBm8GrQex
86V/AlECgYEAyuu+bNifb/xPyYxittV+xqGpyX8QUSu3wo5ULRplvscuygGv29dc
N0XnzLQizyz13oHmsP2NEumzXw25unsMJMsa3YFQgXQaJzgHFYiTKIR3DIhIzBL5
CiLwlHPAz8vDSwKi9Mn0zVSySMkLNPhO05MlmRrxZM3nG0rTojG2+jMCgYEAw6Bw
t6Mj/gjouQiIyzvvo2cpXvwMDU6JuLjNu5bPVCUOLal++RcFIvGpm9tlqdgBNEjM
a9C61wsTCP49crvYM+ep/GrjI5KddQQEoqObvUR5ms4stOtfey3z6B679ygblbsp
NCbkQOQCtljmVa1ncqQsUR2JzNDKBv98AUrv2t0CgYBpgkI1Hj1oYOyrg08gecm9
RfmeR28YhX66rn6eJQeaNr7hUhc6W7QbGUH5cgBXcK020Jw+ktdzaghV+DEGAUzD
JMgHPGG7rb6bfcpRK/44Jwgvf/05/vN2jcxBpB4w7WXR7sEEPq4GxW8d4Uruc92o
rO3zucqh+12bF0ELKIZXeQKBgGGbHIJTkLLASTWBL5ePmRqDb13oDi9Zf1e+RVAS
h/Go53Ea/7JSrQppX0HXbtsWXktzAyPMKlz/NoknKQuk89O6A9NglWH7Vjq7PYDU
dvExSCdYNXAzfBlerTKkmw5PYawMjRtrSDmkSkInCw22jkXh6gay4T1i81oYgQu4
EwK1AoGBAMqAGXhtLRS8wmgM3riXcoGoq/34SHbnqf7mJ+25cIF5FAeOS7FtLMTA
9Fml25ZkB2vBHBxP6quvEehpPJ64cu5/GXDeatwOS+rhhIA7Q4kpM0uyjLBBlAZv
PdtX16f32bb/fj9lLCp3FFBHZ7HMFdX2MjYC8RWaGb0T7PpM+z86
-----END RSA PRIVATE KEY-----
circuits-2.1.0/examples/web/websocket.html0000644000014400001440000000175712113343751020351 0ustar  prologicusers






	

circuits-2.1.0/examples/web/sessions.py0000755000014400001440000000051012113343751017702 0ustar  prologicusers#!/usr/bin/env python

from circuits.web import Server, Controller, Sessions


class Root(Controller):

    def index(self, name="World"):
        if "name" in self.session:
            name = self.session["name"]
        self.session["name"] = name
        return "Hello %s!" % name

(Server(8000) + Sessions() + Root()).run()
circuits-2.1.0/examples/web/controllers.py0000755000014400001440000000032012113343751020401 0ustar  prologicusers#!/usr/bin/env python

from circuits.web import Server, Controller, Logger


class Root(Controller):

    def index(self):
        return "Hello World!"

(Server(("0.0.0.0", 8000)) + Root() + Logger()).run()
circuits-2.1.0/examples/web/fileupload.py0000755000014400001440000000154112113343751020165 0ustar  prologicusers#!/usr/bin/env python

from circuits.web import Server, Controller

UPLOAD_FORM = """

 
  Upload Form
 
 
  
          Upload Form
          
  
          
   Description: 
          
   
   
  
          
 

"""

UPLOADED_FILE = """

 
  Uploaded File
 
 
  
          Uploaded File
          
  
          
   Filename: %s
          
   Description: %s
  
          
  
          File Contents:
          
  
            %s
  
          
 

"""


class Root(Controller):

    def index(self, file=None, desc=""):
        if file is None:
            return UPLOAD_FORM
        else:
            return UPLOADED_FILE % (file.filename, desc, file.value)

(Server(8000) + Root()).run()
circuits-2.1.0/examples/web/filtering.py0000755000014400001440000000062612113343751020027 0ustar  prologicusers#!/usr/bin/env python

from circuits import handler, Component
from circuits.web import Server, Controller


class Upper(Component):

    channel = "web"

    @handler("response", priority=1.0)
    def _on_response(self, response):
        response.body = "".join(response.body).upper()


class Root(Controller):

    def index(self):
        return "Hello World!"

(Server(8000) + Upper() + Root()).run()
circuits-2.1.0/examples/web/xmlrpc.py0000755000014400001440000000035012113343751017343 0ustar  prologicusers#!/usr/bin/env python

from circuits import Component
from circuits.web import Server, Logger, XMLRPC


class Test(Component):

    def foo(self, a, b, c):
        return a, b, c

(Server(8000) + Logger() + XMLRPC() + Test()).run()
circuits-2.1.0/examples/web/server-cert.pem0000644000014400001440000000226412072034467020440 0ustar  prologicusers-----BEGIN CERTIFICATE-----
MIIDSzCCAjMCAxAAGzANBgkqhkiG9w0BAQUFADBjMQswCQYDVQQGEwJVUzERMA8G
A1UECBMITXkgU3RhdGUxEzARBgNVBAoTCk15IENvbXBhbnkxEDAOBgNVBAsTB015
IFVuaXQxGjAYBgNVBAMTEVNBTVBMRSBTaWduaW5nIENBMB4XDTEwMDkxNDE5NDgy
MVoXDTIwMDkxMTE5NDgyMVowcjELMAkGA1UEBhMCVVMxETAPBgNVBAgTCE15IFN0
YXRlMRAwDgYDVQQHEwdNeSBUb3duMRMwEQYDVQQKEwpNeSBDb21wYW55MRAwDgYD
VQQLEwdNeSBVbml0MRcwFQYDVQQDEw5NeVNhbXBsZVNlcnZlcjCCASIwDQYJKoZI
hvcNAQEBBQADggEPADCCAQoCggEBAJsQvrygLjZfFwU4Th8bjyGcOLXg0AQaynaa
ZTcXojHAhapmt8AxeeoA4a+bN7tD1BUg25gh5iFs7sdJ26E1FeZsOlp5z4xWuSja
Jy3PQ9SZd0hB+foZvAhBms8t5+BV6dS8aYXhYl90lQgB1dx/dapdkRbt3k7Iz1zp
Q2/Oxs1Y0UMb8LbVHczXRLzcDJwSi0Syc3oc5vUIVsvaYnLW2lqINzi7rsJ0N7Pk
rt4oscyebMrBde780U1sAbSf7rj0JSWzhqtfiJ8NQgMxxaJCRvgtEhXORT/wvEIe
pu/32YtbqBwl7YO+S/SD5NN3zrr0iwk/GOzK2Ljd/FDNtA+ibAcCAwEAATANBgkq
hkiG9w0BAQUFAAOCAQEAKURnSJwOP7DdZZWjCeFY2rURWW3gdP4zopvKRDIbEj0v
egjQjfHMSmKloE4ifu9HbTIecZ3ojUxXNHIJoG0eKTFnLN4rdE7TyLMkdkTCe07Y
ydh1uv4GadbCH0wf9JAaRD5EDSsYvBxn0x7s6SNk7fDLOdprkcuAetKG7pvKxckZ
HRU7hH4L06Lb50yol1AswrDuB5avBosNx/aoZFtOPv7SXK5wlvAU3T8yNLK0o5M3
ViM9nYCo41BP5JcrDyUFYd4ih8opwMgx/1lL+NgZZLvv9gImHodxS3KOjdDBpjwL
TLJxThm42HbbSgn3ZoS01+as0+nQZ5L4s0THkOEIXg==
-----END CERTIFICATE-----
circuits-2.1.0/examples/web/jsontool.py0000755000014400001440000000053212113343751017707 0ustar  prologicusers#!/usr/bin/env python

from json import dumps

from circuits.web import Server, Controller


def json(f):
    def wrapper(self, *args, **kwargs):
        return dumps(f(self, *args, **kwargs))
    return wrapper


class Root(Controller):

    @json
    def getrange(self, limit=4):
        return range(int(limit))

(Server(8000) + Root()).run()
circuits-2.1.0/examples/timers.py0000755000014400001440000000103212113343751016562 0ustar  prologicusers#!/usr/bin/env python

"""Simple Timers

A trivial simple example of using circuits and timers.
"""

from circuits import Event, Component, Timer


class App(Component):

    def hello(self):
        print "Hello World"

    def foo(self):
        print "Foo"

    def bar(self):
        print "Bar"

    def started(self, component):
        Timer(5, Event.create("Hello")).register(self)
        Timer(1, Event.create("Foo"), persist=True).register(self)
        Timer(3, Event.create("Bar"), persist=True).register(self)


App().run()
circuits-2.1.0/examples/test_worker.py0000755000014400001440000000067512113343751017643 0ustar  prologicusers#!/usr/bin/python -i


from os import getpid
from time import sleep

from circuits import Debugger, Event, Manager, Task, Worker


def e():
    return x * 2


def f(*args, **kwargs):
    sleep(3)
    return "Hello from {0:d} {1:s} {2:s}".format(
        getpid(), repr(args), repr(kwargs)
    )


Task.success = True
Task.failure = True


class FooBar(Event):
    """FooBar Event"""


m = Manager() + Worker(process=True) + Debugger()
m.start()
circuits-2.1.0/examples/tail.py0000755000014400001440000000240312113343751016213 0ustar  prologicusers#!/usr/bin/env python

"""Clone of the standard UNIX "tail" command.

This example shows how you can utilize some of the buitlin I/O components
in circuits to write a very simple clone of the standard UNIX "tail" command.
"""

import sys
from circuits import Component, Debugger
from circuits.io import stdout, File, Write


class Tail(Component):

    # Shorthand for declaring a compoent to be a part of this component.
    stdout = stdout

    def init(self, filename):
        """Initialize Tail Component

        Using the convenience ``init`` method we simply register a ``File``
        Component as part of our ``Tail`` Component and ask it to seek to
        the end of the file.
        """

        File(filename, "r", autoclose=False).register(self).seek(0, 2)

    def read(self, data):
        """Read Event Handler

        This event is triggered by the underlying ``File`` Component for
        when there is data to be processed. Here we simply fire a ``Write``
        event and target the ``stdout`` component instance that is a part of
        our system -- thus writing the contents of the file we read out
        to standard output.
        """

        self.fire(Write(data), self.stdout)

# Setup and run the system.
(Tail(sys.argv[1]) + Debugger()).run()
circuits-2.1.0/examples/portforward.py0000755000014400001440000001214312113343751017635 0ustar  prologicusers#!/usr/bin/env python

"""A Port Forwarding Example

This example demonstrates slightly more complex features and behaviors
implementing a TCP/UDP Port Forwarder of network traffic. This can be used
as a simple tool to forward traffic from one port to another.

Example:

    ./portforward.py 0.0.0.0:2222 127.0.0.1:22

This example also has support for daemonizing the process into the background.
"""


from uuid import uuid4 as uuid
from optparse import OptionParser

from circuits.app import Daemon
from circuits import handler, Component, Debugger
from circuits.net.sockets import Close, Connect, Write
from circuits.net.sockets import TCPClient, TCPServer

__version__ = "0.2"

USAGE = "%prog [options]  "
VERSION = "%prog v" + __version__


def parse_options():
    parser = OptionParser(usage=USAGE, version=VERSION)

    parser.add_option(
        "-d", "--daemon",
        action="store_true", default=False, dest="daemon",
        help="Enable daemon mode (fork into the background)"
    )

    parser.add_option(
        "", "--debug",
        action="store_true", default=False, dest="debug",
        help="Enable debug mode (verbose event output)"
    )

    opts, args = parser.parse_args()

    if len(args) < 2:
        parser.print_help()
        raise SystemExit(1)

    return opts, args


def _on_target_disconnected(self, event):
    """Disconnected Event Handler

    This unbound function will be later added as an event handler to a
    dynamically created and registered client instance and used to process
    Disconnected events of a connected client.
    """

    channel = event.channels[0]
    sock = self._sockets[channel]

    self.fire(Close(sock), "source")

    del self._sockets[channel]
    del self._clients[sock]


def _on_target_ready(self, component):
    """Ready Event Handler

    This unbound function will be later added as an event handler to a
    dynamically created and registered client instance and used to process
    Ready events of a registered client.
    """

    self.fire(Connect(*self._target, secure=self._secure), component.channel)


def _on_target_read(self, event, data):
    """Read Event Handler

    This unbound function will be later added as an event handler to a
    dynamically created and registered client instance and used to process
    Read events of a connected client.
    """

    sock = self._sockets[event.channels[0]]
    self.fire(Write(sock, data), "source")


class PortForwarder(Component):

    def init(self, source, target, secure=False):
        self._source = source
        self._target = target
        self._secure = secure

        self._clients = dict()
        self._sockets = dict()

        # Setup our components and register them.
        server = TCPServer(self._source, secure=self._secure, channel="source")
        server.register(self)

    @handler("connect", channel="source")
    def _on_source_connect(self, sock, host, port):
        """Explicitly defined Connect Event Handler

        This evens is triggered by the underlying TCPServer Component when
        a new client connection has been made.

        Here we dynamically create a Client instance, registere it and add
        custom event handlers to handle the events of the newly created
        client. The client is registered with a unique channel per connection.
        """

        bind = 0
        channel = uuid()

        client = TCPClient(bind, channel=channel)
        client.register(self)

        self.addHandler(
            handler("disconnected", channel=channel)(_on_target_disconnected)
        )

        self.addHandler(
            handler("ready", channel=channel)(_on_target_ready)
        )

        self.addHandler(
            handler("read", channel=channel)(_on_target_read)
        )

        self._clients[sock] = client
        self._sockets[client.channel] = sock

    @handler("read", channel="source")
    def _on_source_read(self, sock, data):
        """Explicitly defined Read Event Handler

        This evens is triggered by the underlying TCPServer Component when
        a connected client has some data ready to be processed.

        Here we simply fire a cooresponding Write event to the cooresponding
        matching client which we lookup using the socket object as the key
        to determinte the unique id.
        """

        client = self._clients[sock]
        self.fire(Write(data), client.channel)


def sanitize(s):
    if ":" in s:
        address, port = s.split(":")
        port = int(port)
        return address, port
    return s


def main():
    opts, args = parse_options()

    source = sanitize(args[0])
    target = sanitize(args[1])

    if type(source) is not tuple:
        print("ERROR: source address must specify port (address:port)")
        raise SystemExit(-1)

    if type(target) is not tuple:
        print("ERROR: target address must specify port (address:port)")
        raise SystemExit(-1)

    system = PortForwarder(source, target)

    if opts.daemon:
        Daemon("portforward.pid").register(system)

    if opts.debug:
        Debugger().register(system)

    system.run()

if __name__ == "__main__":
    main()
circuits-2.1.0/examples/99bottles.py0000755000014400001440000000231112113343751017116 0ustar  prologicusers#!/usr/bin/env python

"""An implementation of the Python Concurrency Problem of 99 Bottles of Beer

See: http://wiki.python.org/moin/Concurrency/99Bottles
"""

import sys

from circuits.io import File
from circuits import Component
from circuits.net.protocols import LP


class Tail(Component):
    """A complex component which combines the ``File`` and ``LP``
    (Line Protoco) components together to implement similar functionality to
    the UNIX ``tail`` command.
    """

    def init(self, filename):
        """Initialize the Component.

        NB: This is automatically called after ``__new__`` and ``__init__``.
        """

        (File(filename, "r", autoclose=False) + LP()).register(self).seek(0, 2)


class Grep(Component):
    """A simple component that simply listens for ``line`` events from the
    ``Tail`` component and performs a regular expression match against each
    line. If the line matches it is printed to standard output.
    """

    def init(self, pattern):
        self.pattern = pattern

    def line(self, line):
        """Line Event Handler"""

        if self.pattern in line:
            print(line)

# Configure and "run" the System.
(Tail(sys.argv[1]) + Grep(sys.argv[2])).run()
circuits-2.1.0/examples/cat.py0000755000014400001440000000144612113343751016037 0ustar  prologicusers#!/usr/bin/env python


"""Clone of the standard UNIX "cat" command.

This example shows how you can utilize some of the buitlin I/O components
in circuits to write a very simple clone of the standard UNIX "cat" command.
"""


import sys

from circuits.io import stdout, File, Write


class Cat(File):

    stdout = stdout

    def read(self, data):
        """Read Event Handler

        This is fired by the File Component when there is data to be read
        from the underlying file that was opened.
        """

        self.fire(Write(data), stdout)

    def eof(self):
        """End Of File Event

        This is fired by the File Component when the underlying input file
        has been exhcuasted.
        """

        raise SystemExit(0)

# Start and "run" the system.
Cat(sys.argv[1]).run()
circuits-2.1.0/examples/ircclient.py0000755000014400001440000001037412113343751017244 0ustar  prologicusers#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""Example IRC Client

A basic IRC client with a very basic console interface.

For usage type:

   ./ircclient.py --help

"""

import os
from socket import gethostname
from optparse import OptionParser

from circuits.io import stdin
from circuits import handler, Component
from circuits import __version__ as systemVersion
from circuits.net.sockets import TCPClient, Connect
from circuits.net.protocols.irc import IRC, PRIVMSG, USER, NICK, JOIN

USAGE = "%prog [options] host [port]"
VERSION = "%prog v" + systemVersion


def parse_options():
    parser = OptionParser(usage=USAGE, version=VERSION)

    parser.add_option(
        "-n", "--nick",
        action="store", default=os.environ["USER"], dest="nick",
        help="Nickname to use"
    )

    parser.add_option(
        "-c", "--channel",
        action="store", default="#circuits", dest="channel",
        help="Channel to join"
    )

    opts, args = parser.parse_args()

    if len(args) < 1:
        parser.print_help()
        raise SystemExit(1)

    return opts, args


class Client(Component):

    # Set a separate channel in case we want multiple ``Client`` instances.
    channel = "ircclient"

    def init(self, host, port=6667, opts=None):
        self.host = host
        self.port = port
        self.opts = opts
        self.hostname = gethostname()

        self.nick = opts.nick
        self.ircchannel = opts.channel

        # Add TCPClient and IRC to the system.
        self += (TCPClient(channel=self.channel) + IRC(channel=self.channel))

    def ready(self, component):
        """Ready Event

        This event is triggered by the underlying ``TCPClient`` Component
        when it is ready to start making a new connection.
        """

        self.fire(Connect(self.host, self.port))

    def connected(self, host, port):
        """Connected Event

        This event is triggered by the underlying ``TCPClient`` Component
        when a successfully connection has been made.
        """

        print("Connected to %s:%d" % (host, port))

        nick = self.nick
        hostname = self.hostname
        name = "%s on %s using circuits/%s" % (nick, hostname, systemVersion)

        self.fire(USER(nick, hostname, host, name))
        self.fire(NICK(nick))

    def numeric(self, source, target, numeric, args, message):
        """Numeric Event

        This event is triggered by the ``IRC`` Protocol Component when we have
        received an IRC Numberic Event from server we are connected to.
        """

        if numeric == 1:
            self.fire(JOIN(self.ircchannel))
        elif numeric == 433:
            self.nick = newnick = "%s_" % self.nick
            self.fire(NICK(newnick))

    def join(self, source, channel):
        """Join Event

        This event is triggered by the ``IRC`` Protocol Component when a
        user has joined a channel.
        """

        if source[0].lower() == self.nick.lower():
            print("Joined %s" % channel)
        else:
            print("--> %s (%s) has joined %s" % (source[0], source, channel))

    def notice(self, source, target, message):
        """Notice Event

        This event is triggered by the ``IRC`` Protocol Component for each
        notice we receieve from the server.
        """

        print("-%s- %s" % (source[0], message))

    def message(self, source, target, message):
        """Message Event

        This event is triggered by the ``IRC`` Protocol Component for each
        message we receieve from the server.
        """

        if target[0] == "#":
            print("<%s> %s" % (target, message))
        else:
            print("-%s- %s" % (source, message))

    @handler("read", channel="stdin")
    def stdin_read(self, data):
        """Read Event (on channel ``stdin``)

        This is the event handler for ``read`` events specifically from the
        ``stdin`` channel. This is triggered each time stdin has data that
        it has read.
        """

        self.fire(PRIVMSG(self.ircchannel, data.strip()))


def main():
    opts, args = parse_options()

    host = args[0]
    if len(args) > 1:
        port = int(args[1])
    else:
        port = 6667

    # Configure and run the system.
    (Client(host, port, opts=opts) + stdin).run()


if __name__ == "__main__":
    main()
circuits-2.1.0/examples/dirwatch.py0000755000014400001440000000106212113343751017067 0ustar  prologicusers#!/usr/bin/env python

"""Directory Watch Example

This example demonstrates the inotify I/O Component ``Notify`` which can
be used for real-time monitoring of file system events. The example simply
takes a path to watch as the first Command Line Argument and prints to
stdour every file system event it sees.
"""

import sys

from circuits import Debugger
from circuits.io import Notify

# Configure the system
app = (Notify() + Debugger())  # app gets assigned the Notify instance

# Add the path to watch
app.add_path(sys.argv[1])

# Run the system
app.run()
circuits-2.1.0/examples/primitives/0000755000014400001440000000000012113366740017104 5ustar  prologicuserscircuits-2.1.0/examples/primitives/fire.py0000755000014400001440000000075212113343751020407 0ustar  prologicusers#!/usr/bin/env python

from circuits import Component, Event


class Hello(Event):
    """Hello Event"""


class Foo(Event):
    """Foo Event"""


class Bar(Event):
    """Bar Event"""


class App(Component):

    def foo(self):
        print("Foo!")

    def bar(self):
        print("Bar!")

    def hello(self):
        self.fire(Foo())
        self.fire(Bar())
        print("Hello World!")

    def started(self, component):
        self.fire(Hello())
        self.stop()

App().run()
circuits-2.1.0/examples/primitives/wait.py0000755000014400001440000000116612113343751020426 0ustar  prologicusers#!/usr/bin/env python

from circuits import Component, Event


class Hello(Event):
    """Hello Event"""


class Foo(Event):
    """Foo Event"""


class Bar(Event):
    """Bar Event"""


class App(Component):

    def foo(self):
        return 1

    def bar(self):
        return 2

    def hello(self):
        x = self.fire(Foo())
        yield self.wait("foo")

        y = self.fire(Bar())
        yield self.wait("bar")

        yield x.value + y.value

    def started(self, component):
        x = self.fire(Hello())
        yield self.wait("hello")
        print("{0:d}".format(x.value))
        self.stop()

App().run()
circuits-2.1.0/examples/primitives/call.py0000755000014400001440000000104712113343751020373 0ustar  prologicusers#!/usr/bin/env python

from circuits import Component, Event


class Hello(Event):
    """Hello Event"""


class Foo(Event):
    """Foo Event"""


class Bar(Event):
    """Bar Event"""


class App(Component):

    def foo(self):
        return 1

    def bar(self):
        return 2

    def hello(self):
        x = yield self.call(Foo())
        y = yield self.call(Bar())
        yield x.value + y.value

    def started(self, component):
        x = yield self.call(Hello())
        print("{0:d}".format(x.value))
        self.stop()

App().run()
circuits-2.1.0/examples/echoserver.py0000755000014400001440000000111612113343751017427 0ustar  prologicusers#!/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.net.sockets import TCPServer


class EchoServer(TCPServer):

    def 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.
        """

        return data

# Start and "run" the system.
# Bind to port 0.0.0.0:8000
(EchoServer(8000)).run()
circuits-2.1.0/examples/telnet.py0000755000014400001440000000610312113343751016556 0ustar  prologicusers#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""Telnet Example

A basic telnet-like clone that connects to remote hosts
via tcp and allows the user to send data to the remote
server.

This example demonstrates:
    * Basic Component creation.
    * Basic Event handling.
    * Basiv Networking
    * Basic Request/Response Networking

This example makes use of:
    * Component
    * Event
    * net.sockets.TCPClient
"""

import os
from optparse import OptionParser

from circuits.io import stdin
from circuits import handler, Component
from circuits import __version__ as systemVersion
from circuits.net.sockets import TCPClient, UNIXClient, Connect, Write

USAGE = "%prog [options] host [port]"
VERSION = "%prog v" + systemVersion


def parse_options():
    parser = OptionParser(usage=USAGE, version=VERSION)

    parser.add_option(
        "-s", "--ssl",
        action="store_true", default=False, dest="ssl",
        help="Enable Secure Socket Layer (SSL)"
    )

    opts, args = parser.parse_args()

    if len(args) < 1:
        parser.print_help()
        raise SystemExit(1)

    return opts, args


class Telnet(Component):

    # Define a separate channel for this component so we don't clash with
    # the ``read`` event of the ``stdin`` component.
    channel = "telnet"

    def __init__(self, *args):
        super(Telnet, self).__init__()

        if len(args) == 1:
            if os.path.exists(args[0]):
                self += UNIXClient(channel=self.channel)
                host = dest = port = args[0]
                dest = (dest,)
            else:
                raise OSError("Path %s not found" % args[0])
        else:
            self += TCPClient(channel=self.channel)
            host, port = args
            port = int(port)
            dest = host, port

        print("Trying %s ..." % host)
        self.fire(Connect(*dest))

    def connected(self, host, port=None):
        """Connected Event Handler

        This event is fired by the TCPClient Componentt to indicate a
        successful connection.
        """

        print("Connected to {0}".format(host))

    def error(self, *args):
        """Error Event Handler

        If any exception/error occurs in the system this event is triggered.
        """

        if len(args) == 3:
            print("ERROR: {0}".format(args[1]))
        else:
            print("ERROR: {0}".format(args[0]))

    def read(self, data):
        """Read Event Handler

        This event is fired by the underlying TCPClient Component when there
        is data to be read from the connection.
        """

        print(data.strip())

    # Setup an Event Handler for "read" events on the "stdin" channel.
    @handler("read", "stdin")
    def _on_stdin_read(self, data):
        """Read Event Handler for stdin

        This event is triggered by the connected ``stdin`` component when
        there is new data to be read in from standard input.
        """

        self.fire(Write(data))


def main():
    opts, args = parse_options()

    # Configure and "run" the System.
    (Telnet(*args) + stdin).run()


if __name__ == "__main__":
    main()
circuits-2.1.0/examples/chatserver.py0000755000014400001440000000644212113343751017437 0ustar  prologicusers#!/usr/bin/env python

"""Chat Server Example

This example demonstrates how to create a very simple telnet-style chat
server that supports many connecting clients.
"""

from optparse import OptionParser

from circuits import Component, Debugger
from circuits.net.sockets import TCPServer, Write

__version__ = "0.0.1"

USAGE = "%prog [options]"
VERSION = "%prog v" + __version__


def parse_options():
    parser = OptionParser(usage=USAGE, version=VERSION)

    parser.add_option(
        "-b", "--bind",
        action="store", type="string",
        default="0.0.0.0:8000", dest="bind",
        help="Bind to address:[port]"
    )

    parser.add_option(
        "-d", "--debug",
        action="store_true",
        default=False, dest="debug",
        help="Enable debug mode"
    )

    opts, args = parser.parse_args()

    return opts, args


class ChatServer(Component):

    def init(self, args, opts):
        """Initialize our ``ChatServer`` Component.

        This uses the convenience ``init`` method which is called after the
        component is proeprly constructed and initialized and passed the
        same args and kwargs that were passed during construction.
        """

        self.args = args
        self.opts = opts

        self.clients = {}

        if opts.debug:
            Debugger().register(self)

        if ":" in opts.bind:
            address, port = opts.bind.split(":")
            port = int(port)
        else:
            address, port = opts.bind, 8000

        bind = (address, port)

        TCPServer(bind).register(self)

    def broadcast(self, data, exclude=None):
        exclude = exclude or []
        targets = (sock for sock in self.clients.keys() if sock not in exclude)
        for target in targets:
            self.fire(Write(target, data))

    def connect(self, sock, host, port):
        """Connect Event -- Triggered for new connecting clients"""

        self.clients[sock] = {
            "host": sock,
            "port": port,
            "state": {
                "nickname": None,
                "registered": False
            }
        }

        self.fire(Write(sock, "Welcome to the circuits Chat Server!\n"))
        self.fire(Write(sock, "Please enter a desired nickname: "))

    def disconnect(self, sock):
        """Disconnect Event -- Triggered for disconnecting clients"""

        nickname = self.clients[sock]["state"]["nickname"]
        self.broadcast("!!! {0:s} has left !!!\n".format(nickname),
                       exclude=[sock])
        del self.clients[sock]

    def read(self, sock, data):
        """Read Event -- Triggered for when client conenctions have data"""

        if not self.clients[sock]["state"]["registered"]:
            nickname = data.strip()
            self.clients[sock]["state"]["registered"] = True
            self.clients[sock]["state"]["nickname"] = nickname
            self.broadcast("!!! {0:s} has joined !!!\n".format(nickname),
                           exclude=[sock])
        else:
            nickname = self.clients[sock]["state"]["nickname"]
            self.broadcast("<{0:s}> {1:s}\n".format(nickname, data.strip()),
                           exclude=[sock])


def main():
    opts, args = parse_options()

    # Configure and "run" the System.
    (ChatServer(args, opts)).run()


if __name__ == "__main__":
    main()
circuits-2.1.0/examples/ircbot.py0000755000014400001440000000455712113343751016560 0ustar  prologicusers#!/usr/bin/env python

"""IRC Bot Example

This example shows how to use several components in circuits as well
as one of the builtin networking protocols. This IRC Bot simply connects
to the FreeNode IRC Network and joins the #circuits channel. It will also
echo anything privately messages to it in response.
"""


from circuits import Component, Debugger
from circuits.net.sockets import TCPClient, Connect
from circuits.net.protocols.irc import IRC, PRIVMSG, USER, NICK, JOIN

from circuits.net.protocols.irc import ERR_NICKNAMEINUSE
from circuits.net.protocols.irc import RPL_ENDOFMOTD, ERR_NOMOTD


class Bot(Component):

    # Define a separate channel so we can create many instances of ``Bot``
    channel = "ircbot"

    def init(self, host, port=6667, channel=channel):
        self.host = host
        self.port = port

        # Add TCPClient and IRC to the system.
        self += TCPClient(channel=self.channel) + IRC(channel=self.channel)

    def ready(self, component):
        """Ready Event

        This event is triggered by the underlying ``TCPClient`` Component
        when it is ready to start making a new connection.
        """

        self.fire(Connect(self.host, self.port))

    def connected(self, host, port):
        """Connected Event

        This event is triggered by the underlying ``TCPClient`` Component
        when a successfully connection has been made.
        """

        self.fire(USER("circuits", host, host, "Test circuits IRC Bot"))
        self.fire(NICK("circuits"))

    def numeric(self, source, target, numeric, args, message):
        """Numeric Event

        This event is triggered by the ``IRC`` Protocol Component when we have
        received an IRC Numberic Event from server we are connected to.
        """

        if numeric == ERR_NICKNAMEINUSE:
            self.fire(NICK("%s_" % args))
        if numeric in (RPL_ENDOFMOTD, ERR_NOMOTD):
            self.fire(JOIN("#circuits"))

    def message(self, source, target, message):
        """Message Event

        This event is triggered by the ``IRC`` Protocol Component for each
        message we receieve from the server.
        """

        self.fire(PRIVMSG(source[0], message))


# Configure and run the system
bot = Bot("irc.freenode.net") + Debugger()
# To register a 2nd ``Bot`` instance. Simply use a separate channel.
Bot("irc.freenode.net", channel="foo").register(bot)
bot.run()
circuits-2.1.0/examples/hello_bridge.py0000755000014400001440000000050012113343751017675 0ustar  prologicusers#!/usr/bin/python -i

from os import getpid

from circuits import Component, Debugger, Event, Manager


class Hello(Event):
    """Hello Event"""


class App(Component):

    def hello(self):
        return "Hello World! ({0:d})".format(getpid())


m = Manager() + Debugger()
m.start()
App().start(process=True, link=m)
circuits-2.1.0/examples/test_memory_leaks.py0000755000014400001440000000150612113343751021013 0ustar  prologicusers#!/usr/bin/env python

import gc

from circuits import Component, Event
from circuits.web import Controller, Server


class Hello(Event):
    """Hello Event"""


class App(Component):

    def hello(self):
        print("Hello World!")

    def started(self, component):
        self.fire(Hello())
        raise SystemExit(0)


class Root(Controller):

    def index(self):
        return "Hello World!"


old_count = len(gc.get_count())

#App().run()
(Server(8000) + Root()).run()

gc.collect()
new_count = len(gc.get_count())
diff_count = new_count - old_count

if diff_count > 0:
    print("Memory Leak Detected of {0:d} objects".format(diff_count))

    for obj in gc.get_objects():
        print("Object:", obj)
        print(" Referrers:")
        for ref in gc.get_referrer(obj):
            print("  ", ref)
else:
    print("OK")
circuits-2.1.0/examples/circ.py0000755000014400001440000002312012113343751016201 0ustar  prologicusers#!/usr/bin/env python

"""Circuits IRC Client

A circuits based IRC Client demonstrating integration with urwid - a curses
application development library and interacting with and processing irc
events from an IRC server.

NB: This is not a full featured client.

For usage type:

   ./circ.py --help
"""

import os
import sys
from operator import add
from select import select
from inspect import getargspec
from socket import gethostname
from optparse import OptionParser
from re import compile as compile_regex

from urwid.raw_display import Screen
from urwid import AttrWrap, Edit, Frame, ListBox, Pile, SimpleListWalker, Text

from circuits import handler, Component
from circuits import __version__ as systemVersion
from circuits.net.sockets import TCPClient, Connect

from circuits.net.protocols.irc import QUIT, PART, RAW
from circuits.net.protocols.irc import IRC, PRIVMSG, USER, NICK, JOIN
from circuits.net.protocols.irc import ERR_NICKNAMEINUSE, RPL_WELCOME

USAGE = "%prog [options] host [port]"
VERSION = "%prog v" + systemVersion

MAIN_TITLE = "cIRC - {0:s}".format(systemVersion)

HELP_STRINGS = {
    "main": "For help, type: /help"
}

CMD_REGEX = compile_regex(
    "\/(?P[a-z]+) ?"
    "(?P.*)(?iu)"
)


def back_merge(l, n, t=" "):
    return l[:-n].extend([t.join(l[-n:])])


def parse_options():
    parser = OptionParser(usage=USAGE, version=VERSION)

    parser.add_option(
        "-c", "--channel",
        action="store", default="#circuits", dest="channel",
        help="Channel to join"
    )

    parser.add_option(
        "", "--debug",
        action="store_true", default=False, dest="debug",
        help="Enable debug mode"
    )

    parser.add_option(
        "-n", "--nick",
        action="store", default=os.environ["USER"], dest="nick",
        help="Nickname to use"
    )

    opts, args = parser.parse_args()

    if len(args) < 1:
        parser.print_help()
        raise SystemExit(1)

    return opts, args


class Client(Component):

    channel = "client"

    def init(self, host, port=6667, opts=None):
        self.host = host
        self.port = port
        self.opts = opts
        self.hostname = gethostname()

        self.nick = opts.nick
        self.ircchannel = opts.channel

        # Add TCPClient and IRC to the system.
        self += (TCPClient(channel=self.channel) + IRC(channel=self.channel))

        self.create_interface()

    def create_interface(self):
        self.screen = Screen()
        self.screen.start()

        self.screen.register_palette([
            ("title", "white", "dark blue", "standout"),
            ("line", "light gray", "black"),
            ("help", "white", "dark blue")]
        )

        self.body = ListBox(SimpleListWalker([]))
        self.lines = self.body.body

        self.title = Text(MAIN_TITLE)
        self.header = AttrWrap(self.title, "title")

        self.help = AttrWrap(
            Text(HELP_STRINGS["main"]),
            "help"
        )

        self.input = Edit(caption="%s> " % self.ircchannel)
        self.footer = Pile([self.help, self.input])

        self.top = Frame(self.body, self.header, self.footer)

    def ready(self, component):
        """Ready Event

        This event is triggered by the underlying ``TCPClient`` Component
        when it is ready to start making a new connection.
        """

        self.fire(Connect(self.host, self.port))

    def connected(self, host, port):
        """Connected Event

        This event is triggered by the underlying ``TCPClient`` Component
        when a successfully connection has been made.
        """

        nick = self.nick
        hostname = self.hostname
        name = "%s on %s using circuits/%s" % (nick, hostname, systemVersion)

        self.fire(USER(nick, hostname, host, name))
        self.fire(NICK(nick))

    def numeric(self, source, target, numeric, args, message):
        """Numeric Event

        This event is triggered by the ``IRC`` Protocol Component when we have
        received an IRC Numberic Event from server we are connected to.
        """

        if numeric == RPL_WELCOME:
            self.fire(JOIN(self.ircchannel))
        elif numeric == ERR_NICKNAMEINUSE:
            self.nick = newnick = "%s_" % self.nick
            self.fire(NICK(newnick))

    @handler("stopped", channel="*")
    def _on_stopped(self, component):
        self.screen.stop()

    @handler("generate_events")
    def _on_generate_events(self, event):
        event.reduce_time_left(0)

        size = self.screen.get_cols_rows()

        if not select(
                self.screen.get_input_descriptors(), [], [], 0.1)[0] == []:
            timeout, keys, raw = self.screen.get_input_nonblocking()

            for k in keys:
                if k == "window resize":
                    size = self.screen.get_cols_rows()
                    continue
                elif k == "enter":
                    self.processCommand(self.input.get_edit_text())
                    self.input.set_edit_text("")
                    continue

                self.top.keypress(size, k)
                self.input.set_edit_text(self.input.get_edit_text() + k)

        self.update_screen(size)

    def unknownCommand(self, command):
        self.lines.append(Text("Unknown command: %s" % command))

    def syntaxError(self, command, args, expected):
        self.lines.append(
            Text("Syntax error ({0:s}): {1:s} Expected: {2:s}".format(
                command, args, expected)
            )
        )

    def processCommand(self, s):

        match = CMD_REGEX.match(s)
        if match is not None:

            command = match.groupdict()["command"]
            if not match.groupdict()["args"] == "":
                tokens = match.groupdict()["args"].split(" ")
            else:
                tokens = []

            fn = "cmd" + command.upper()
            if hasattr(self, fn):
                f = getattr(self, fn)
                if callable(f):

                    args, vargs, kwargs, default = getargspec(f)
                    args.remove("self")
                    if len(args) == len(tokens):
                        if len(args) == 0:
                            f()
                        else:
                            f(*tokens)
                    else:
                        if len(tokens) > len(args):
                            if vargs is None:
                                if len(args) > 0:
                                    factor = len(tokens) - len(args) + 1
                                    f(*back_merge(tokens, factor))
                                else:
                                    print "1"
                                    self.syntaxError(
                                        command, " ".join(tokens),
                                        " ".join(
                                            x for x in args + [vargs]
                                            if x is not None
                                        )
                                    )
                            else:
                                f(*tokens)
                        elif default is not None and \
                                len(args) == (
                                    len(tokens) + len(default)):
                            f(*(tokens + list(default)))
                        else:
                            self.syntaxError(
                                command,
                                " ".join(tokens),
                                " ".join(
                                    x for x in args + [vargs]
                                    if x is not None
                                )
                            )
        else:
            if self.ircchannel is not None:
                self.lines.append(Text("<%s> %s" % (self.nick, s)))
                self.fire(PRIVMSG(self.ircchannel, s))
            else:
                self.lines.append(Text(
                    "No channel joined. Try /join #"))

    def cmdEXIT(self, message=""):
        self.fire(QUIT(message))
        raise SystemExit(0)

    def cmdSERVER(self, host, port=6667):
        self.fire(Connect(host, port))

    def cmdSSLSERVER(self, host, port=6697):
        self.fire(Connect(host, port, secure=True))

    def cmdJOIN(self, channel):
        if self.ircchannel is not None:
            self.cmdPART(self.ircchannel, "Joining %s" % channel)
        self.fire(JOIN(channel))
        self.ircchannel = channel

    def cmdPART(self, channel=None, message="Leaving"):
        if channel is None:
            channel = self.ircchannel
        if channel is not None:
            self.fire(PART(channel, message))
            self.ircchannel = None

    def cmdQUOTE(self, message):
        self.fire(RAW(message))

    def cmdQUIT(self, message="Bye"):
        self.fire(QUIT(message))

    def update_screen(self, size):
        canvas = self.top.render(size, focus=True)
        self.screen.draw_screen(size, canvas)

    @handler("notice", "message")
    def _on_notice_or_message(self, event, source, target, message):
        nick, ident, host = source

        if event.name == "notice":
            self.lines.append(Text("-%s- %s" % (nick, message)))
        else:
            self.lines.append(Text("<%s> %s" % (nick, message)))


def main():
    opts, args = parse_options()

    host = args[0]
    if len(args) > 1:
        port = int(args[1])
    else:
        port = 6667

    # Configure and run the system.

    components = [Client(host, port, opts=opts)]

    if opts.debug:
        from circuits import Debugger
        components.append(Debugger(file=sys.stderr))

    system = reduce(add, components)
    system.run()

if __name__ == "__main__":
    main()
circuits-2.1.0/examples/hello.py0000755000014400001440000000043412113343751016367 0ustar  prologicusers#!/usr/bin/env python

from circuits import Component, Event


class Hello(Event):
    """Hello Event"""


class App(Component):

    def hello(self):
        print("Hello World!")

    def started(self, component):
        self.fire(Hello())
        raise SystemExit(0)

App().run()
circuits-2.1.0/.coveragerc0000644000014400001440000000067112113343751015215 0ustar  prologicusers[run]
omit = circuits/__init__.py
       circuits/app/__init__.py
       circuits/io/__init__.py
       circuits/core/__init__.py
       circuits/net/__init__.py
       circuits/net/protocols/__init__.py
       circuits/node/__init__.py
       circuits/web/__init__.py
       circuits/web/main.py
       circuits/web/dispatchers/__init__.py
       circuits/web/apps/*
       tests/*

[html]
directory = coverage

[xml]
output = coverage.xml