PLC/Parameter.py

   1 #
   2 # Shared type definitions
   3 #
   4 # Mark Huang <mlhuang@cs.princeton.edu>
   5 # Copyright (C) 2006 The Trustees of Princeton University
   6 #
   7
   8 from types import *
   9 from PLC.Faults import *
  10
  11 class Parameter:
  12     """
  13     Typed value wrapper. Use in accepts and returns to document method
  14     parameters. Set the optional and default attributes for
  15     sub-parameters (i.e., dict fields).
  16     """
  17
  18     def __init__(self, typeval, doc = "",
  19                  min = None, max = None,
  20                  optional = None,
  21                  ro = False,
  22                  nullok = False,
  23                  primary_key = False,
  24                  indexed = False,
  25                  joined=False):
  26         # Basic type of the parameter. Must be a builtin type
  27         # that can be marshalled by XML-RPC.
  28         self.type = typeval
  29
  30         # Documentation string for the parameter
  31         self.doc = doc
  32
  33         # Basic value checking. For numeric types, the minimum and
  34         # maximum possible values, inclusive. For string types, the
  35         # minimum and maximum possible UTF-8 encoded byte lengths.
  36         self.min = min
  37         self.max = max
  38
  39         # Whether the sub-parameter is optional or not. If None,
  40         # unknown whether it is optional.
  41         self.optional = optional
  42
  43         # Whether the DB field is read-only.
  44         self.ro = ro
  45
  46         # Whether the DB field can be NULL.
  47         self.nullok = nullok
  48
  49         self.primary_key = primary_key
  50
  51     def type(self):
  52         return self.type
  53
  54     def __repr__(self):
  55         return repr(self.type)
  56
  57 class Mixed(tuple):
  58     """
  59     A list (technically, a tuple) of types. Use in accepts and returns
  60     to document method parameters that may return mixed types.
  61     """
  62
  63     def __new__(cls, *types):
  64         return tuple.__new__(cls, types)
  65
  66 def python_type(arg):
  67     """
  68     Returns the Python type of the specified argument, which may be a
  69     Python type, a typed value, or a Parameter.
  70     """
  71
  72     if isinstance(arg, Parameter):
  73         arg = arg.type
  74
  75     if isinstance(arg, type):
  76         return arg
  77     else:
  78         return type(arg)
  79
  80 def xmlrpc_type(arg):
  81     """
  82     Returns the XML-RPC type of the specified argument, which may be a
  83     Python type, a typed value, or a Parameter.
  84     """
  85
  86     arg_type = python_type(arg)
  87
  88     if arg_type == NoneType:
  89         return "nil"
  90     elif arg_type == IntType or arg_type == LongType:
  91         return "int"
  92     elif arg_type == bool:
  93         return "boolean"
  94     elif arg_type == FloatType:
  95         return "double"
  96     elif arg_type in StringTypes:
  97         return "string"
  98     elif arg_type == ListType or arg_type == TupleType:
  99         return "array"
 100     elif arg_type == DictType:
 101         return "struct"
 102     elif arg_type == Mixed:
 103         # Not really an XML-RPC type but return "mixed" for
 104         # documentation purposes.
 105         return "mixed"
 106     else:
 107         raise PLCAPIError, "XML-RPC cannot marshal %s objects" % arg_type