| 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

President Bachelet's Speech; Baltimore Primer; libxml2 Parsing Stream; configure.ac Recipe For Library Path; The Davalos Affair For Idiots; Not The Onion: Google Fireside Chat w Kissinger; Bicycle Wheels, Inertia, and Energy; Another Tax Fraud; Google's Borg; A Verion That Redirects To Local HTTP Server; Spanish Accents For Idiots; Aluminium Cans; Advice on Spray Painting; Female View of Online Chat From a Male; UX Reading List; S4 Subgroups - Geometric Interpretation; Fucking Email; The SQM Affair For Idiots; Using Kolmogorov Complexity; Oblique Strategies in bash; Curses Tools; Markov Chain Monte Carlo Without all the Bullshit; Email Para Matias Godoy Mercado; The Penta Affair For Idiots; Example Code To Create numpy Array in C; Good Article on Bias in Graphic Design (NYTimes); Do You Backup github?; Data Mining Books; SimpleDateFormat should be synchronized; British Words; Chinese Govt Intercepts External Web To DDOS github; Numbering Permutations; Teenage Engineering - Low Price Synths; GCHQ Can Do Whatever It Wants; Dublinesque; A Cryptographic SAT Solver; Security Challenges; Word Lists for Crosswords; 3D Printing and Speaker Design; Searchable Snowden Archive; XCode Backdoored; Derived Apps Have Malware (CIA); Rowhammer - Hacking Software Via Hardware (DRAM) Bugs; Immutable SQL Database (Kinda); Tor GPS Tracker; That PyCon Dongle Mess...; ASCII Fluid Dynamics; Brandalism; Table of Shifter, Cassette and Derailleur Compatability; Lenovo Demonstrates How Bad HTTPS Is; Telegraph Owned by HSBC; Smaptop - Sunrise (Music); Equation Group (NSA); UK Torture in NI; And - A Natural Extension To Regexps; This Is The Future Of Religion; The Shazam (Music Matching) Algorithm; Tributes To Lesbian Community From AIDS Survivors; Nice Rust Summary; List of Good Fiction Books; Constructing JSON From Postgres (Part 2); Constructing JSON From Postgres (Part 1); Postgres in Docker; Why Poor Places Are More Diverse; Smart Writing on Graceland; Satire in France; Free Speech in France; MTB Cornering - Where Should We Point Our Thrusters?; Secure Secure Shell; Java Generics over Primitives; 2014 (Charlie Brooker); How I am 7; Neural Nets Applied to Go; Programming, Business, Social Contracts; Distributed Systems for Fun and Profit; XML and Scheme; Internet Radio Stations (Curated List); Solid Data About Placebos; Half of Americans Think Climate Change Is a Sign of the Apocalypse; Saturday Surf Sessions With Juvenile Delinquents; Ssh, tty, stdout and stderr; Feathers falling in a vacuum; Santiago 30m Bike Route; 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

© 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