NetMsgs.NetMsgsXmlParser Namespace Reference

NetMsgs XML parser module. More...

Classes
class	NetMsgsXmlParser
class	NetMsgsXmlParserError
class	UTUsage

Functions
def	UTPrintUsageErr (emsg)
def	UTPrintUsage ()
def	UTGetOptions (argv=None, kwargs)
def	UTMain (argv=None, kwargs)

Detailed Description

NetMsgs XML parser module.

LastChangedDate

2013-08-08 13:02:57 -0600 (Thu, 08 Aug 2013)

Rev

3183

Todo:

Add brief elements to xdefs for better comments to generated language constructs

See also

PyDoc Generated Documentation

Author

Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright

© 2009-2017. RoadNarrows LLC.
http://www.roadnarrows.com
All Rights Reserved

Function Documentation

def NetMsgs.NetMsgsXmlParser.UTGetOptions	(		argv = None,
			kwargs
	)

Get Main Options

    Parameters:
      argv    - Argument list. If not None, the overrides command-line
                arguments.
      kwargs  - Keyword argument list.  

Definition at line 1372 of file NetMsgsXmlParser.py.

References NetMsgs.NetMsgsXmlParser.UTPrintUsage(), and NetMsgs.NetMsgsXmlParser.UTPrintUsageErr().

Referenced by NetMsgs.NetMsgsXmlParser.UTMain().

  def UTGetOptions(argv=None, **kwargs):
    """ Get Main Options

        Parameters:
          argv    - Argument list. If not None, the overrides command-line
                    arguments.
          kwargs  - Keyword argument list.  
    """
    global _Argv0

    if argv is None:
      argv = sys.argv

    _Argv0 = kwargs.get('argv0', __file__)

    # defaults
    kwargs['debug'] = 0

    # parse command-line options
    try:
      try:
        opts, args = getopt.getopt(argv[1:], "?hd:o:",
            ['help', 'debug=', "overrides=", ''])
      except getopt.error, msg:
        raise UTUsage(msg)
      for opt, optarg in opts:
        if opt in ('-h', '--help', '-?'):
          UTPrintUsage()
          sys.exit(0)
        elif opt in ('-d', '--debug'):
          try:
            kwargs['debug'] = int(optarg)
          except ValueError:
            raise UTUsage("%s %s: not an integer value" % (opt, optarg))
        elif opt in ('-o', '--overrides'):
          overrides = optarg.split(',')
          for entry in overrides:
            try:
              name,value = entry.split('=')
              name = name.strip()
              value = value.strip()
              kwargs[name] = value
            except:
              raise UTUsage("%s %s: bad syntax" % (opt, repr(optarg)))
    except UTUsage, err:
      UTPrintUsageErr(err.msg)
      sys.exit(2)

    if len(args) < 1:
      UTPrintUsageErr("No input xml file specified")
      sys.exit(2)
    else:
      kwargs['filename'] = args[0]

    return kwargs

def NetMsgs.NetMsgsXmlParser.UTMain	(		argv = None,
			kwargs
	)

Unit Test Main.
    
    Parameters:
      argv    - Optional argument list to override command-line arguments.
      kwargs  - Optional keyword argument list.

Definition at line 1430 of file NetMsgsXmlParser.py.

References NetMsgs.NetMsgsXmlParser.UTGetOptions().

  def UTMain(argv=None, **kwargs):
    """ Unit Test Main.
        
        Parameters:
          argv    - Optional argument list to override command-line arguments.
          kwargs  - Optional keyword argument list.
    """
    global _Argv0
  
    kwargs = UTGetOptions(argv, **kwargs)

    xmlNetMsgs = NetMsgsXmlParser(**kwargs)

    try:
      xmlNetMsgs.Parse()
    except NetMsgsXmlParserError as inst:
      print "Error: %s" % (inst)
      return 8

    xmlNetMsgs.PrettyPrintDB()

def NetMsgs.NetMsgsXmlParser.UTPrintUsage

(

)

Print Command-Line Usage Message. 

Definition at line 1353 of file NetMsgsXmlParser.py.

Referenced by NetMsgs.NetMsgsXmlParser.UTGetOptions().

  def UTPrintUsage():
    """ Print Command-Line Usage Message. """
    print """
usage: %s [OPTIONS] <xmlfile>

       %s --help
    """  % (_Argv0, _Argv0)
    print """Options and arguments:
  -d, --debug=<level>       : Debug level. One of: 0 1 2 3
                              Default: 0  (off)
  -o, --overrides=<list>    : XML overrides. List of form name=value,...
                              Supported overrides:
                                encoding, endian, ns, brief

  -h, --help                : Display this help and exit.
    """

def NetMsgs.NetMsgsXmlParser.UTPrintUsageErr

(

emsg

)

Print Error Usage Message.
      
    Parameters:
      msg   - Error message string.

Definition at line 1339 of file NetMsgsXmlParser.py.

Referenced by NetMsgs.NetMsgsXmlParser.UTGetOptions().

  def UTPrintUsageErr(emsg):
    """ Print Error Usage Message.
          
        Parameters:
          msg   - Error message string.
    """
    if emsg:
      print "%s: %s" % (_Argv0, emsg)
    else:
      print "%s: error" % (_Argv0)
    print "Try '%s --help' for more information." % (_Argv0)