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
|
.. 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.setuparg1
.. currentmodule:: wx.lib.pubsub.setuparg1
.. highlight:: python
.. _wx.lib.pubsub.setuparg1:
==========================================================================================================================================
|phoenix_title| **wx.lib.pubsub.setuparg1**
==========================================================================================================================================
Setup pubsub for the *arg1* message protocol. In a default pubsub installation
the default protocol is *kargs*.
This module must be imported before the first ``from pubsub import pub``
statement in the application. Once :mod:pub has been imported, the messaging
protocol must not be changed (i.e., importing it after the first
``from pubsub import pub`` statement has undefined behavior).
::
from .. import setuparg1
from .. import pub
The *arg1* protocol is identical to the legacy messaging protocol from
first version of pubsub (when it was still part of wxPython) and
is *deprecated*. This module is therefore *deprecated*.
|function_summary| Functions Summary
====================================
================================================================================ ================================================================================
:func:`~wx.lib.pubsub.setuparg1.enforceArgName` This will configure pubsub to require that all listeners use
================================================================================ ================================================================================
|
Functions
------------
.. function:: enforceArgName(commonName)
This will configure pubsub to require that all listeners use
the same argument name (*commonName*) as first parameter. This
is a ueful first step in migrating an application that has been
using *arg1* protocol to the more powerful *kwargs* protocol.
|
