File: wx.lib.pubsub.core.topicargspec.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (73 lines) | stat: -rw-r--r-- 2,466 bytes parent folder | download | duplicates (2)
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

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

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

.. highlight:: python



.. _wx.lib.pubsub.core.topicargspec:

==========================================================================================================================================
|phoenix_title|  **wx.lib.pubsub.core.topicargspec**
==========================================================================================================================================

Definitions related to message data specification.

:copyright: Copyright since 2006 by Oliver Schoenborn, all rights reserved.
:license: BSD, see LICENSE_BSD_Simple.txt for details.


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

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


|


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

================================================================================ ================================================================================
:ref:`~wx.lib.pubsub.core.topicargspec.ArgSpecGiven`                             The message data specification (MDS) for a topic.
================================================================================ ================================================================================


|


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

   wx.lib.pubsub.core.topicargspec.ArgSpecGiven





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

.. function:: topicArgsFromCallable(_callable)

   Get the topic message data names and list of those that are required,
   by introspecting given callable. Returns a pair, (args, required)
   where args is a dictionary of allowed message data names vs docstring,
   and required states which ones are required rather than optional.