2 # Shared type definitions
4 # Mark Huang <mlhuang@cs.princeton.edu>
5 # Copyright (C) 2006 The Trustees of Princeton University
7 # $Id: Parameter.py,v 1.5 2006/11/02 18:32:55 mlhuang Exp $
14 Typed value wrapper. Use in accepts and returns to document method
15 parameters. Set the optional and default attributes for
16 sub-parameters (i.e., dict fields).
19 def __init__(self, type, doc = "",
20 min = None, max = None,
24 # Basic type of the parameter. Must be a builtin type
25 # that can be marshalled by XML-RPC.
28 # Documentation string for the parameter
31 # Basic value checking. For numeric types, the minimum and
32 # maximum possible values, inclusive. For string types, the
33 # minimum and maximum possible UTF-8 encoded byte lengths.
37 # Whether the sub-parameter is optional or not. If None,
38 # unknown whether it is optional.
39 self.optional = optional
41 # Whether the DB field is read-only.
44 # Whether the DB field can be NULL.
51 return repr(self.type)
55 A list (technically, a tuple) of types. Use in accepts and returns
56 to document method parameters that may return mixed types.
59 def __new__(cls, *types):
60 return tuple.__new__(cls, types)
65 Returns the Python type of the specified argument, which may be a
66 Python type, a typed value, or a Parameter.
69 if isinstance(arg, Parameter):
72 if isinstance(arg, type):
79 Returns the XML-RPC type of the specified argument, which may be a
80 Python type, a typed value, or a Parameter.
83 arg_type = python_type(arg)
85 if arg_type == NoneType:
87 elif arg_type == IntType or arg_type == LongType:
89 elif arg_type == bool:
91 elif arg_type == FloatType:
93 elif arg_type in StringTypes:
95 elif arg_type == ListType or arg_type == TupleType:
97 elif arg_type == DictType:
99 elif arg_type == Mixed:
100 # Not really an XML-RPC type but return "mixed" for
101 # documentation purposes.
104 raise PLCAPIError, "XML-RPC cannot marshal %s objects" % arg_type