Andrew Cooke | Contents | Latest | RSS | 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

Choochoo Training Diary

Last 100 entries

Surprise Paradox; [Books] Good Author List; [Computing] Efficient queries with grouping in Postgres; [Computing] Automatic Wake (Linux); [Computing] AWS CDK Aspects in Go; [Bike] Adidas Gravel Shoes; [Computing, Horror] Biological Chips; [Books] Weird Lit Recs; [Covid] Extended SIR Models; [Art] York-based Printmaker; [Physics] Quantum Transitions are not Instantaneous; [Computing] AI and Drum Machines; [Computing] Probabilities, Stopping Times, Martingales; bpftrace Intro Article; [Computing] Starlab Systems - Linux Laptops; [Computing] Extended Berkeley Packet Filter; [Green] Mainspring Linear Generator; Better Approach; Rummikub Solver; Chilean Poetry; Felicitations - Empowerment Grant; [Bike] Fixing Spyre Brakes (That Need Constant Adjustment); [Computing, Music] Raspberry Pi Media (Audio) Streamer; [Computing] Amazing Hack To Embed DSL In Python; [Bike] Ruta Del Condor (El Alfalfal); [Bike] Estimating Power On Climbs; [Computing] Applying Azure B2C Authentication To Function Apps; [Bike] Gearing On The Back Of An Envelope; [Computing] Okular and Postscript in OpenSuse; There's a fix!; [Computing] Fail2Ban on OpenSuse Leap 15.3 (NFTables); [Cycling, Computing] Power Calculation and Brakes; [Hardware, Computing] Amazing Pockit Computer; Bullying; How I Am - 3 Years Post Accident, 8+ Years With MS; [USA Politics] In America's Uncivil War Republicans Are The Aggressors; [Programming] Selenium and Python; Better Walking Data; [Bike] How Fast Before Walking More Efficient Than Cycling?; [COVID] Coronavirus And Cycling; [Programming] Docker on OpenSuse; Cadence v Speed; [Bike] Gearing For Real Cyclists; [Programming] React plotting - visx; [Programming] React Leaflet; AliExpress Independent Sellers; Applebaum - Twilight of Democracy; [Politics] Back + US Elections; [Programming,Exercise] Simple Timer Script; [News] 2019: The year revolt went global; [Politics] The world's most-surveilled cities; [Bike] Hope Freehub; [Restaurant] Mama Chau's (Chinese, Providencia); [Politics] Brexit Podcast; [Diary] Pneumonia; [Politics] Britain's Reichstag Fire moment; install cairo; [Programming] GCC Sanitizer Flags; [GPU, Programming] Per-Thread Program Counters; My Bike Accident - Looking Back One Year; [Python] Geographic heights are incredibly easy!; [Cooking] Cookie Recipe; Efficient, Simple, Directed Maximisation of Noisy Function; And for argparse; Bash Completion in Python; [Computing] Configuring Github Jekyll Locally; [Maths, Link] The Napkin Project; You can Masquerade in Firewalld; [Bike] Servicing Budget (Spring) Forks; [Crypto] CIA Internet Comms Failure; [Python] Cute Rate Limiting API; [Causality] Judea Pearl Lecture; [Security, Computing] Chinese Hardware Hack Of Supermicro Boards; SQLAlchemy Joined Table Inheritance and Delete Cascade; [Translation] The Club; [Computing] Super Potato Bruh; [Computing] Extending Jupyter; Further HRM Details; [Computing, Bike] Activities in ch2; [Books, Link] Modern Japanese Lit; What ended up there; [Link, Book] Logic Book; Update - Garmin Express / Connect; Garmin Forerunner 35 v 230; [Link, Politics, Internet] Government Trolls; [Link, Politics] Why identity politics benefits the right more than the left; SSH Forwarding; A Specification For Repeating Events; A Fight for the Soul of Science; [Science, Book, Link] Lost In Math; OpenSuse Leap 15 Network Fixes; Update; [Book] Galileo's Middle Finger; [Bike] Chinese Carbon Rims; [Bike] Servicing Shimano XT Front Hub HB-M8010; [Bike] Aliexpress Cycling Tops; [Computing] Change to ssh handling of multiple identities?; [Bike] Endura Hummvee Lite II; [Computing] Marble Based Logic; [Link, Politics] Sanity Check For Nuclear Launch; [Link, Science] Entropy and Life

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