| 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.

Last 100 entries

Mapa de Ciclovias en Santiago; How Unreliable is UDP?; SE Santiago 20m Bike Route; Cameron's Rap; Configuring libxml with Eclipse; Reducing Combinatorial Complexity With Occam - AI; Sentidos Comunes (Chilean Online Magazine); Hilary Mantel: The Assassination of Margaret Thatcher - August 6th 1983; NSA Interceptng Gmail During Delivery; General IIR Filters; What's happening with Scala?; Interesting (But Largely Illegible) Typeface; Retiring Essentialism; Poorest in UK, Poorest in N Europe; I Want To Be A Redneck!; Reverse Racism; The Lost Art Of Nomography; IBM Data Center (Photo); Interesting Account Of Gamma Hack; The Most Interesting Audiophile In The World; How did the first world war actually end?; Ky - Restaurant Santiago; The Black Dork Lives!; The UN Requires Unaninmous Decisions; LPIR - Steganography in Practice; How I Am 6; Clear Explanation of Verizon / Level 3 / Netflix; Teenage Girls; Formalising NSA Attacks; Switching Brakes (Tektro Hydraulic); Naim NAP 100 (Power Amp); AKG 550 First Impressions; Facebook manipulates emotions (no really); Map Reduce "No Longer Used" At Google; Removing RAID metadata; New Bike (Good Bike Shop, Santiago Chile); Removing APE Tags in Linux; Compiling Python 3.0 With GCC 4.8; Maven is Amazing; Generating Docs from a GitHub Wiki; Modular Shelves; Bash Best Practices; Good Emergency Gasfiter (Santiago, Chile); Readings in Recent Architecture; Roger Casement; Integrated Information Theory (Or Not); Possibly undefined macro AC_ENABLE_SHARED; Update on Charges; Sunburst Visualisation; Spectral Embeddings (Distances -> Coordinates); Introduction to Causality; Filtering To Help Colour-Blindness; ASUS 1015E-DS02 Too; Ready Player One; Writing Clear, Fast Julia Code; List of LatAm Novels; Running (for women); Building a Jenkins Plugin and a Jar (for Command Line use); Headphone Test Recordings; Causal Consistency; The Quest for Randomness; Chat Wars; Real-life Financial Co Without ACID Database...; Flexible Muscle-Based Locomotion for Bipedal Creatures; SQL Performance Explained; The Little Manual of API Design; Multiple Word Sizes; CRC - Next Steps; FizzBuzz; Update on CRCs; Decent Links / Discussion Community; Automated Reasoning About LLVM Optimizations and Undefined Behavior; A Painless Guide To CRC Error Detection Algorithms; Tests in Julia; Dave Eggers: what's so funny about peace, love and Starship?; Cello - High Level C Programming; autoreconf needs tar; Will Self Goes To Heathrow; Top 5 BioInformatics Papers; Vasovagal Response; Good Food in Vina; Chilean Drug Criminals Use Subsitution Cipher; Adrenaline; Stiglitz on the Impact of Technology; Why Not; How I Am 5; Lenovo X240 OpenSuse 13.1; NSA and GCHQ - Psychological Trolls; Finite Fields in Julia (Defining Your Own Number Type); Julian Assange; Starting Qemu on OpenSuse; Noisy GAs/TMs; Venezuela; Reinstalling GRUB with EFI; Instructions For Disabling KDE Indexing; Evolving Speakers; Changing Salt Size in Simple Crypt 3.0.0; Logarithmic Map (Moved); More Info; Words Found in Voynich Manuscript; An Inventory Of 3D Space-Filling Curves

© 2006-2013 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