Overview

XMLProps provides means to access properties that are stored in XML (file or string) - Java XML style.

There are two main classes xmlprops provides:

1. XMLPropsFile: file based XML that containing properties

2. XMLPropsStr: string base XML that containing properties

Both classes inherit from dict class. Both classes provide similar methods to allow stractured access to the properties.

Both classes inherit same base class that provides access and manipulation methods that used by XMLProps family.

A property is represented by key value XML entries.

Key: property path. string names separated by, usually, ‘.’ (dot). Key examples:

1. ‘factory_name’

2. ‘arizona.capitol’

3. ‘texas.dallas.mayor’

The property name is the last element in property path (similar to basename in path methods) The property hierarchy is the path to it. Value: property value. string representing the value assignment to property

The get dict function ‘[]’ was enhanced to include hierarchical get. On the item a.b.c; get will try to get c, a.c, and a.b.c. The last one available, wins.

Functions

Examples of use

from xmlprops import XMLPropsStr
from xmlprops import XMLPropsFile

## Define example string
props_xml_01='''<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
  <entry key="product">MySql</entry>
  <entry key="service_mode">BF</entry>
  <entry key="exposure">shared</entry>
  <entry key="makers">db1</entry>
  <entry key="max_active">10</entry>
  <entry key="init_active">1</entry>
  <entry key="db1.user">userdb</entry>
  <entry key="db1.password">passworddb</entry>
  <entry key="db1.host">hostdb</entry>
  <entry key="host">hw_host</entry>
  <entry key="db1.port">portdb1</entry>
  <entry key="db1.database">databasedb1</entry>
  <entry key="db2.port">portdb2</entry>
  <entry key="db2.database">databasedb2</entry>
  <entry key="db1.priority">1</entry>
  <entry key="db1.priority">2</entry>
</properties>
'''
##Load XML from string
xmlprops=XMLPropsStr(props=props_xml_01)
print(xmlprops)
## prints {'db1.charset': 'utf8', 'db1.use_unicode': 'True', 'init_active': '1', 'product': 'MySql', 'db1.host': 'hostdb', 'service_mode': 'BF', 'db1.port': 'portdb', 'exposure': 'shared', 'db1.password': 'passworddb', 'db1.database': 'databasedb', 'max_active': '10', 'db1.user': 'userdb', 'db1.priority': '2', 'makers': 'db1'}
xmlprops.get_match(key_prefix='db2.')['port'] ## returns 'portdb2'
xmlprops.get_match(key_prefix='db1.')['port'] ##returns 'portdb1'
xmlprops.get_match(key_prefix='db1.port')[''] ##returns 'portdb1'
xmlprops.get_match(key_prefix='db2.') ## returns OrderedDict([('port', 'portdb2'), ('database', 'databasedb2')])
##Next statement examplifies that last value for key "priority" was loaded
xmlprops.get_match(key_prefix='db1.')['priority'] ## returns '2'
## Next statements examplify priority in evaluating keys when using "get" function
xmlprops.get('db1.host') ## returns 'hostdb' - since key 'db1.host' is evaluated after key 'host'
xmlprops.get('db1.max_active') ## returns '10' - key 'max_active' is evaluated first, then 'db1.max_active' is evaluated and is not found
xmlprops.get('db2.max_active') ## returns '10' - key 'max_active' is evaluated first, then 'db2.max_active' is evaluated and is not found
xmlprops.set('new_key','new_key_value') ## Add new key/value
xmlprops.get_contain('host') ## returns {'host': 'hw_host', 'db1.host': 'hostdb'}
xmlprops.get_contain(key_value='host',exact_match=True) ## returns {'host': 'hw_host'}
xmlprops.get_contain('db1.host') ## retuns {'db1.host': 'hostdb'}
xmlprops.get_contain('db.\.port') ## returns {'db2.port': 'portdb2', 'db1.port': 'portdb1'}

Additional resources

Documentation is in the “docs” directory and online at the design and use of xmlprops.

example and tests directory shows ways to use xmlprops . Both directories are available to view and download as part of source code on GitHub. GitHub_link

Docs are updated rigorously. If you find any problems in the docs, or think they should be clarified in any way, please take 30 seconds to fill out a ticket in github or send us email at support@acrisel.com

To get more help or to provide suggestions you can send as email to: arnon@acrisel.com uri@acrisel.com