.. wxPython Phoenix documentation This file was generated by Phoenix's sphinx generator and associated tools, do not edit by hand. Copyright: (c) 2011-2020 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 useful first step in migrating an application that has been using *arg1* protocol to the more powerful *kwargs* protocol.