| Andrew Cooke | Contents | Latest | RSS | Twitter | Previous | Next

C[omp]ute

Welcome to my blog, which was once a mailing list of the same name and is still generated by mail. Please reply via the "comment" links.

Always interested in offers/projects/new ideas. Eclectic experience in fields like: numerical computing; Python web; Java enterprise; functional languages; GPGPU; SQL databases; etc. Based in Santiago, Chile; telecommute worldwide. CV; email.

Personal Projects

Lepl parser for Python.

Colorless Green.

Photography around Santiago.

SVG experiment.

Professional Portfolio

Calibration of seismometers.

Data access via web services.

Cache rewrite.

Extending OpenSSH.

C-ORM: docs, API.

Last 100 entries

An Outsider's Guide To Julia Packages; Nobody gives a shit; Lepton Decay Irregularity; An Easier Way; Julia's BinDeps (aka How To Install Cairo); Good Example Of Good Police Work (And Anonymity Being Hard); Best Santiago Burgers; Also; Michael Emmerich (Vibrator Translator) Interview (Japanese Books); Clarice Lispector (Brazillian Writer); Books On Evolution; Looks like Ara (Modular Phone) is dead; Index - Translations From Chile; More Emotion in Chilean Wines; Week 7; Aeon Magazine (Science-ish); QM, Deutsch, Constructor Theory; Interesting Talk Transcripts; Interesting Suggestion Of Election Fraud; "Hard" Books; Articles or Papers on depolarizing the US; Textbook for "QM as complex probabilities"; SFO Get Libor Trader (14 years); Why Are There Still So Many Jobs?; Navier Stokes Incomplete; More on Benford; FBI Claimed Vandalism; Architectural Tessellation; Also: Go, Blake's 7; Delusions of Gender (book); Crypto AG DID work with NSA / GCHQ; UNUMS (Universal Number Format); MOOCs (Massive Open Online Courses); Interesting Looking Game; Euler's Theorem for Polynomials; Weeks 3-6; Reddit Comment; Differential Cryptanalysis For Dummies; Japanese Graphic Design; Books To Be Re-Read; And Today I Learned Bugs Need Clear Examples; Factoring a 67 bit prime in your head; Islamic Geometric Art; Useful Julia Backtraces from Tasks; Nothing, however, is lost with less discomfort than that which, when lost, cannot be missed; Article on Didion; Cost of Living by City; British Slavery; Derrida on Metaphor; African SciFi; Traits in Julia; Alternative Japanese Lit; Pulic Key as Address (Snow); Why Information Grows; The Blindness Of The Chilean Elite; Some Victoriagate Links; This Is Why I Left StackOverflow; New TLS Implementation; Maths for Physicists; How I Am 8; 1000 Word Philosophy; Cyberpunk Reading List; Detailed Discussion of Message Dispatch in ParserCombinator Library for Julia; FizzBuzz in Julia w Dependent Types; kokko - Design Shop in Osaka; Summary of Greece, Currently; LLVM and GPUs; See Also; Schoolgirl Groyps (Maths); Japanese Lit; Another Example - Modular Arithmetic; Music from United; Python 2 and 3 compatible alternative.; Read Agatha Christie for the Plot; A Constructive Look at TempleOS; Music Thread w Many Recommendations; Fixed Version; A Useful Julia Macro To Define Equality And Hash; k3b cdrom access, OpenSuse 13.1; Week 2; From outside, the UK looks less than stellar; Huge Fonts in VirtualBox; Keen - Complex Emergencies; The Fallen of World War II; Some Spanish Fiction; Calling C From Fortran 95; Bjork DJ Set; Z3 Example With Python; Week 1; Useful Guide To Starting With IJulia; UK Election + Media; Review: Reinventing Organizations; Inline Assembly With Julia / LLVM; Against the definition of types; Dumb Crypto Paper; The Search For Quasi-Periodicity...; Is There An Alternative To Processing?; CARDIAC (CARDboard Illustrative Aid to Computation); The Bolivian Case Against Chile At The Hague; Clear, Cogent Economic Arguments For Immigration; A Program To Say If I Am Working

© 2006-2015 Andrew Cooke (site) / post authors (content).

Declarative Validation of XMLRPC Responses in Python

From: "andrew cooke" <andrew@...>

Date: Thu, 23 Oct 2008 09:17:10 -0300 (CLST)

This is a fairly nice bit of code I wrote yesterday.  I wanted to validate
XMLRPC responses against a specification.  What I finally ended up with
was code like:

GET_VALUES = Array(Struct(ObjectName=Type(basestring),
                          ObjectClass=Type(basestring))
                   .either(ParameterList=Array(Struct(
                                ParameterName=Type(basestring),
                                ParameterClass=Type(basestring),
                                ParameterValue=Type(basestring),
                                ParameterTime=Optional(Type(int)))))
                   .or_(ParameterName=Type(basestring),
                        ParameterClass=Type(basestring),
                        ParameterValue=Type(basestring),
                        ParameterTime=Optional(Type(int))))
GET_VALUES.validate(client.GetValues(...))

And this would check the response from the client to make sure that it
matched that give above (it checks that: all fields received are in the
spec; all non-optional fields are present; maps and lists and values have
the correct types; the general nested structure is correct).

Note that "ObjectName" and the like are the names used in the XML
response.  They are specified in the declaration above (and are not
hard-coded below).

For Python's standard XMLRPC libraries, "structs" are returned as dicts
and "arrays" are lists.  The code is below.  Apart from the either/or,
which is a bit specific to this particular application, it should be
useful in general.

Andrew

def limit(obj):
  '''
  Reduce text size.
  '''
  text = str(obj)
  if len(text) > 100:
    text = text[0:100] + '...'
  return text

class Type(object):
  '''
  Specification for a simple value.
  '''

  def __init__(self, type):
    self.__type = type

  def validate(self, value):
    '''
    Check type of value.
    '''
    if not isinstance(value, self.__type):
      raise Exception('%s not of type %s' %
                      (limit(value), self.__type))

class Optional(object):
  '''
  Specification for verifying an optional value - does
  nothing, but is detected by Struct.
  '''

  def __init__(self, delegate):
    self.__delegate = delegate

  def validate(self, value):
    '''
    Pass on to delegate.
    '''
    self.__delegate.validate(value)

class Array(Type):
  '''
  Specification for verifying an array of values.
  '''

  def __init__(self, value):
    super(Array, self).__init__(list)
    self.__value = value

  def validate(self, value):
    '''
    Pass each value to delegate.
    '''
    super(Array, self).validate(value)
    for entry in value:
      self.__value.validate(entry)

class Struct(Type):
  '''
  Specification for verifying a struct of values.
  '''

  def __init__(self, **map):
    super(Struct, self).__init__(dict)
    self.__map = map
    self.__either = {}
    self.__or = {}
    self.__choice = None

  def either(self, **choice):
    '''
    Add first of a choice of two maps (chained)
    '''
    self.__either = choice
    return self

  def or_(self, **choice):
    '''
    Add second a choice of two maps
    '''
    self.__or = choice
    return self

  def validate(self, value):
    '''
    Check all entries.
    '''
    super(Struct, self).validate(value)
    self.__choice = None
    for name in value:
      if not self.__validate_choice(name, value[name]):
        if name not in self.__map:
          raise Exception('%s has unexpected content %s' %
                  (limit(value), name))
        else:
          self.__map[name].validate(value[name])
    for name in self.__map:
      if name not in value and \
          not isinstance(self.__map[name], Optional):
        raise Exception('%s is missing %s' %
                        (limit(value), name))
    if self.__choice is None and \
        (self.__either or self.__or):
      raise Exception('%s did not select either choice %s/%s'
              % (limit(value),
                 self.__either.keys(), self.__or.keys()))
    if self.__choice:
      for name in self.__choice:
        if name not in value and \
            not isinstance(self.__choice[name], Optional):
          raise Exception('%s is missing %s' %
                          (limit(value), name))

  def __validate_choice(self, name, value):
    '''
    Check choices
    '''
    # resolve choice once
    if self.__choice is None:
      if name in self.__either:
        self.__choice = self.__either
      elif name in self.__or:
        self.__choice = self.__or
    # check against resolved choice
    if self.__choice is not None:
      if name in self.__choice:
        self.__choice[name].validate(value)
        return True
    return False

Comment on this post