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 # $Id$
   8 # $URL$
   9 #
  10
  11 from types import *
  12 from PLC.Faults import *
  13
  14 class Parameter:
  15     """
  16     Typed value wrapper. Use in accepts and returns to document method
  17     parameters. Set the optional and default attributes for
  18     sub-parameters (i.e., dict fields).
  19     """
  20
  21     def __init__(self, typeval, doc = "",
  22                  min = None, max = None,
  23                  optional = None,
  24                  ro = False,
  25                  nullok = 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     def type(self):
  50         return self.type
  51
  52     def __repr__(self):
  53         return repr(self.type)
  54
  55 class Mixed(tuple):
  56     """
  57     A list (technically, a tuple) of types. Use in accepts and returns
  58     to document method parameters that may return mixed types.
  59     """
  60
  61     def __new__(cls, *types):
  62         return tuple.__new__(cls, types)
  63
  64
  65 def python_type(arg):
  66     """
  67     Returns the Python type of the specified argument, which may be a
  68     Python type, a typed value, or a Parameter.
  69     """
  70
  71     if isinstance(arg, Parameter):
  72         arg = arg.type
  73
  74     if isinstance(arg, type):
  75         return arg
  76     else:
  77         return type(arg)
  78
  79 def xmlrpc_type(arg):
  80     """
  81     Returns the XML-RPC type of the specified argument, which may be a
  82     Python type, a typed value, or a Parameter.
  83     """
  84
  85     arg_type = python_type(arg)
  86
  87     if arg_type == NoneType:
  88         return "nil"
  89     elif arg_type == IntType or arg_type == LongType:
  90         return "int"
  91     elif arg_type == bool:
  92         return "boolean"
  93     elif arg_type == FloatType:
  94         return "double"
  95     elif arg_type in StringTypes:
  96         return "string"
  97     elif arg_type == ListType or arg_type == TupleType:
  98         return "array"
  99     elif arg_type == DictType:
 100         return "struct"
 101     elif arg_type == Mixed:
 102         # Not really an XML-RPC type but return "mixed" for
 103         # documentation purposes.
 104         return "mixed"
 105     else:
 106         raise PLCAPIError, "XML-RPC cannot marshal %s objects" % arg_type