doc/README.development

   1 == Pickle Failures ==
   2
   3 Our schemas are "best guesses" based on what we've seen on the
   4 wire. From time to time they'll be wrong, and thus the (un)pickler
   5 implementation will fail to unpickle some XML document. The easiest
   6 way to test a fix for this is interactively: it's quick, and error
   7 messages are written to the console. Here's an example of such a
   8 session (wrapped for readability):
   9
  10   $ ghci
  11   htsn-import> runX $ xunpickleDocument
  12                       TSN.XML.AutoRacingResults.pickle_message
  13                       parse_opts
  14                       "schemagen/AutoRacingResultsXML/21241892.xml"
  15   [Message {xml_xml_file_id = 21241892... stamp = 2014-06-08 04:05:00 UTC}]
  16
  17 If there's an error, you'll see something like the following:
  18
  19   $ ghci
  20   htsn-import> runX $ xunpickleDocument
  21                       TSN.XML.AutoRacingResults.pickle_message
  22                       parse_opts
  23                       "schemagen/AutoRacingResultsXML/21241892-bad.xml"
  24   fatal error: document unpickling failed
  25   xpElem: got element name "RaceDate", but expected "RaceID"
  26   context:    element "message"
  27   contents:   <Title>IRL - Firestone 600 - Final Results</Title><Track_Location>
  28   Texas Motor Sp...
  29   []