Changeset 5410

Timestamp:

May 4, 2015, 5:12:06 AM (9 years ago)

Author:

mmh

Message:

add new python API, PyXml?

Location:

branches/uq/lang/python

Files:

• README (modified) (4 diffs)
• Rappture/__init__.py (modified) (1 diff)
• Rappture/pyxml.py (added)
• Rappture/test (added)
• Rappture/test/pyxml_test.py (added)
• Rappture/test/results.txt (added)
• Rappture/test/test.xml (added)
• setup.py.in (modified) (1 diff)

branches/uq/lang/python/README

@@ -38 +38 @@
  Python scripts.
 
- Rappture applications load their data from a library object.  You can
- load a library as follows:
+ Rappture applications load their data from a an XML driver file.
+ In the tool.xml file, you should have something like
+
+ <command> @tool/path/to/executable @driver </command>
+
+The "@driver" pattern is replaced by the driver xml file generated by
+Rappture.  This driver file will contain the values to use for the
+parameters in your application.  See
+https://nanohub.org/infrastructure/rappture/wiki/rappture_xml_elements
+for more information.
+
+The first thing your application should do is load the driver file.
 
    import Rappture
-   lib = Rappture.library('example.xml')
-   print lib.xml()
- 
+   rx = Rappture.PyXml('example.xml')
+
+You can see the xml contents by doing
+   print rx.xml()
+
  The "import" statement loads the Rappture toolkit into your Python
  application.  The next line creates a library object representing
@@ -54 +66 @@
 
    import Rappture
-   lib = Rappture.library('example.xml')
+   lib = Rappture.PyXml('example.xml')
    tval = lib.get('group(ambient).number(temp).current')
+or alternatively
+   tval = lib['group(ambient).number(temp).current'].value
 
  The get() method follows a path through the XML.  In this example,
@@ -68 +82 @@
 
    tval += 10
-   lib.put('group(ambient).number(temp).current',str(tval))
+   lib.put('group(ambient).number(temp).current', tval)
+or
+   lib[group(ambient).number(temp).current'] = tval
 
  This changes the text within the <current>...</current> tag,
- replacing it with the new value.  Note that the value must be a
- string, so we use str(tval), rather than tval itself, when inserting
- a value.
+ replacing it with the new value, converted to a string if necessary.
 
  You can also append to an existing value.  For example,
@@ -79 +93 @@
    lib.put('group(ambient).number(temp).current', 'more text', append=1)
 
- This adds the string 'more text' after the value (tval) within the 
- <current>...</current> tag.
+ This adds the string 'more text' after the value (tval) within the
+ <current>...</current> tag.  Use of append in a loop is not
+ recommended because it can be very slow.  It is faster to collect
+ data in python and put it all at once.
 
- Suppose we wanted to add another number to the "ambient" group.
- We could do that by requesting "number#".  The # sign indicates
- that you'd like to create a new number element (number1, number2,
- etc.).  For example, we could add a number for a damping factor:
-
-   lib.put('group(ambient).number#(damping).current','0.25')
-
- This creates a new element <number id="damping"> within
- <group id="ambient">, positioned just after the existing
- <number id="temp">.

branches/uq/lang/python/Rappture/__init__.py

@@ -1 +1 @@
 # Rappture package
 from library import library
+from pyxml import PyXml
 from interface import interface
 from number import number

branches/uq/lang/python/setup.py.in

@@ -41 +41 @@
                      'Rappture.signalHandler',
                      'Rappture.tools',
-                     'Rappture.result'],
+                     'Rappture.result',
+                     'Rappture.pyxml'],
         ext_modules=[ encode_module,
                       library_module,