.. include:: headings.inc

.. module:: lib.pubsub.core.topicargspec

.. currentmodule:: lib.pubsub.core.topicargspec

.. highlight:: python



.. _lib.pubsub.core.topicargspec:

==========================================================================================================================================
|phoenix_title|  **topicargspec**
==========================================================================================================================================

Definitions related to listener signature specification.

:copyright: Copyright 2006-2009 by Oliver Schoenborn, all rights reserved.
:license: BSD, see LICENSE.txt for details.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for module **topicargspec**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.pubsub.core.topicargspec_inheritance.png" alt="Inheritance diagram of topicargspec" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.pubsub.core.topicargspec.ArgSpecGiven.html" title="The listener protocol specification (LPS) given for a topic" alt="" coords="5,5,232,35"/> </map> 
   </p>

|


|function_summary| Functions Summary
====================================

================================================================================ ================================================================================
:func:`~lib.pubsub.core.topicargspec.topicArgsFromCallable`                      Get the topic arguments and list of those that are required,
================================================================================ ================================================================================


|


|class_summary| Classes Summary
===============================

================================================================================ ================================================================================
:ref:`lib.pubsub.core.topicargspec.ArgSpecGiven`                                 The listener protocol specification (LPS) given for a topic
================================================================================ ================================================================================


|


.. toctree::
   :maxdepth: 1
   :hidden:

   lib.pubsub.core.topicargspec.ArgSpecGiven





Functions
------------

.. function:: topicArgsFromCallable(_callable)

   Get the topic arguments and list of those that are required, 
   by introspecting given listener. Returns a pair, (args, required)
   where args is a dictionary of allowed arguments, and required
   states which args are required rather than optional.