mirror of
https://github.com/wxWidgets/Phoenix.git
synced 2025-09-05 17:30:26 +02:00
ea0f874a40
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@75301 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
78 lines
2.8 KiB
Python
78 lines
2.8 KiB
Python
"""
|
|
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.
|
|
|
|
"""
|
|
|
|
|
|
from .listener import getArgs as getListenerArgs
|
|
from .validatedefnargs import MessageDataSpecError
|
|
from .topicargspecimpl import (
|
|
SenderMissingReqdMsgDataError,
|
|
SenderUnknownMsgDataError,
|
|
ArgsInfo
|
|
)
|
|
|
|
|
|
def 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."""
|
|
argsInfo = getListenerArgs(_callable)
|
|
required = argsInfo.getRequiredArgs()
|
|
defaultDoc = 'UNDOCUMENTED'
|
|
args = dict.fromkeys(argsInfo.allParams, defaultDoc)
|
|
return args, required
|
|
|
|
|
|
class ArgSpecGiven:
|
|
"""
|
|
The message data specification (MDS) for a topic.
|
|
This consists of each argument name that listener should have in its
|
|
call protocol, plus which ones are required in any sendMessage(), and a
|
|
documentation string for each argument. This instance will be transformed
|
|
into an ArgsInfo object which is basically a superset of that information,
|
|
needed to ensure that the arguments specifications satisfy
|
|
pubsub policies for chosen API version.
|
|
"""
|
|
|
|
SPEC_GIVEN_NONE = 1 # specification not given
|
|
SPEC_GIVEN_ALL = 3 # all args specified
|
|
|
|
def __init__(self, argsDocs=None, reqdArgs=None):
|
|
self.reqdArgs = tuple(reqdArgs or ())
|
|
|
|
if argsDocs is None:
|
|
self.argsSpecType = ArgSpecGiven.SPEC_GIVEN_NONE
|
|
self.argsDocs = {}
|
|
else:
|
|
self.argsSpecType = ArgSpecGiven.SPEC_GIVEN_ALL
|
|
self.argsDocs = argsDocs
|
|
|
|
# check that all args marked as required are in argsDocs
|
|
missingArgs = set(self.reqdArgs).difference(self.argsDocs.keys()) # py3: iter keys ok
|
|
if missingArgs:
|
|
msg = 'Params [%s] missing inherited required args [%%s]' % ','.join(argsDocs.keys()) # iter keys ok
|
|
raise MessageDataSpecError(msg, missingArgs)
|
|
|
|
def setAll(self, allArgsDocs, reqdArgs = None):
|
|
self.argsDocs = allArgsDocs
|
|
self.reqdArgs = reqdArgs or ()
|
|
self.argsSpecType = ArgSpecGiven.SPEC_GIVEN_ALL
|
|
|
|
def isComplete(self):
|
|
"""Returns True if the definition is usable, false otherwise."""
|
|
return self.argsSpecType == ArgSpecGiven.SPEC_GIVEN_ALL
|
|
|
|
def getOptional(self):
|
|
return tuple( set( self.argsDocs.keys() ).difference( self.reqdArgs ) )
|
|
|
|
def __str__(self):
|
|
return "%s, %s, %s" % \
|
|
(self.argsDocs, self.reqdArgs, self.argsSpecType)
|
|
|
|
|