sfa/storage/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 NoneType, IntType, LongType, FloatType, DictType, TupleType, ListType
   9 from sfa.util.faults import SfaAPIError
  10
  11
  12 class Parameter:
  13     """
  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).
  17     """
  18
  19     def __init__(self, type, doc="",
  20                  min=None, max=None,
  21                  optional=None,
  22                  ro=False,
  23                  nullok=False):
  24         # Basic type of the parameter. Must be a builtin type
  25         # that can be marshalled by XML-RPC.
  26         self.type = type
  27
  28         # Documentation string for the parameter
  29         self.doc = doc
  30
  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.
  34         self.min = min
  35         self.max = max
  36
  37         # Whether the sub-parameter is optional or not. If None,
  38         # unknown whether it is optional.
  39         self.optional = optional
  40
  41         # Whether the DB field is read-only.
  42         self.ro = ro
  43
  44         # Whether the DB field can be NULL.
  45         self.nullok = nullok
  46
  47     def type(self):
  48         return self.type
  49
  50     def __repr__(self):
  51         return repr(self.type)
  52
  53
  54 class Mixed(tuple):
  55     """
  56     A list (technically, a tuple) of types. Use in accepts and returns
  57     to document method parameters that may return mixed types.
  58     """
  59
  60     def __new__(cls, *types):
  61         return tuple.__new__(cls, types)
  62
  63
  64 def python_type(arg):
  65     """
  66     Returns the Python type of the specified argument, which may be a
  67     Python type, a typed value, or a Parameter.
  68     """
  69
  70     if isinstance(arg, Parameter):
  71         arg = arg.type
  72
  73     if isinstance(arg, type):
  74         return arg
  75     else:
  76         return type(arg)
  77
  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 issubclass(arg_type, str):
  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 SfaAPIError("XML-RPC cannot marshal %s objects" % arg_type)