Metadata-Version: 2.1
Name: amara3.xml
Version: 3.2.1
Summary: Amara3 project, which offers a variety of data processing tools. This module adds the MicroXML support, and adaptation to classic XML.
Home-page: https://github.com/uogbuji/amara3-xml
Author: Uche Ogbuji
Author-email: uche@ogbuji.net
License: License :: OSI Approved :: Apache Software License
Description: # Amara 3 XML
        
        Python 3 tools for processing [MicroXML](http://www.w3.org/community/microxml/), a simplification of XML. Amara 3 XML implements the MicroXML data model, and allows you to parse into this from tradiional XML and MicroXML.
        
        The `microx` command line tool is especially useful for quick query and processing of XML.
        
        ## Install
        
        Requires Python 3.4+. Just run:
        
        ```
        pip install amara3.xml
        ```
        
        ## Use
        
        Though Amara 3 is focused on MicroXML rather than full XML, the reality is that
        most of the XML-like data you’ll be dealing with is full XML
        1.0. his package provides capabilities to parse legacy XML and reduce it to
        MicroXML. In many cases the biggest implication of this is that
        namespace information is stripped. As long as you know what you’re doing
        you can get pretty far by ignoring this, but make sure you know what
        you’re doing.
        
            from amara3.uxml import xml
        
            MONTY_XML = """<monty xmlns="urn:spam:ignored">
              <python spam="eggs">What do you mean "bleh"</python>
              <python ministry="abuse">But I was looking for argument</python>
            </monty>"""
        
            builder = xml.treebuilder()
            root = builder.parse(MONTY_XML)
            print(root.xml_name) #"monty"
            child = next(root.xml_children)
            print(child) #First text node: "
          "
            child = next(root.xml_children)
            print(child.xml_value) #"What do you mean "bleh""
            print(child.xml_attributes["spam"]) #"eggs"
        
        There are some utilities to make this a bit easier as well.
        
            from amara3.uxml import xml
            from amara3.uxml.treeutil import *
        
            MONTY_XML = """<monty xmlns="urn:spam:ignored">
              <python spam="eggs">What do you mean "bleh"</python>
              <python ministry="abuse">But I was looking for argument</python>
            </monty>"""
        
            builder = xml.treebuilder()
            root = builder.parse(MONTY_XML)
            py1 = next(select_name(root, "python"))
            print(py1.xml_value) #"What do you mean "bleh""
            py2 = next(select_attribute(root, "ministry", "abuse"))
            print(py2.xml_value) #"But I was looking for argument"
        
        ## Experimental MicroXML parser
        
        For this parser the input truly must be MicroXML. Basics:
        
            >>> from amara3.uxml.parser import parse
            >>> events = parse('<hello><bold>world</bold></hello>')
            >>> for ev in events: print(ev)
            ...
            (<event.start_element: 1>, 'hello', {}, [])
            (<event.start_element: 1>, 'bold', {}, ['hello'])
            (<event.characters: 3>, 'world')
            (<event.end_element: 2>, 'bold', ['hello'])
            (<event.end_element: 2>, 'hello', [])
            >>>
        
        Or…And now for something completely different!…Incremental parsing.
        
            >>> from amara3.uxml.parser import parsefrags
            >>> events = parsefrags(['<hello', '><bold>world</bold></hello>'])
            >>> for ev in events: print(ev)
            ...
            (<event.start_element: 1>, 'hello', {}, [])
            (<event.start_element: 1>, 'bold', {}, ['hello'])
            (<event.characters: 3>, 'world')
            (<event.end_element: 2>, 'bold
        
        ## Implementation notes
        
        Switched to a hand-crafted parser because:
        
        1) Worried about memory consumption of the needed PLY lexer
        2) Lack of incremental feed parse for PLY
        3) Inspiration from James Clark's JS parser https://github.com/jclark/microxml-js/blob/master/microxml.js
        
        ----
        
        Author: [Uche Ogbuji](http://uche.ogbuji.net) <uche@ogbuji.net>
        
        
Keywords: xml,web,data
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Internet :: WWW/HTTP
Description-Content-Type: text/markdown
