Changeset 98:45f9210678c3 for relatorio/templates/opendocument.py

Timestamp:

01/22/09 05:11:25 (19 months ago)

Author:

Ga?tan de Menten <ged@…>

Branch:

default

Message:

- prefix make_href and guess_type methods by "relatorio" so that we don't

risk a collision with user-provided methods

- removed the second parameter to make_href which wasn't used
- added some more comments/docstrings

Files:

• relatorio/templates/opendocument.py (modified) (8 diffs)

relatorio/templates/opendocument.py

@@ -86 +86 @@
         self.context = context.copy()
 
-    def __call__(self, expr, name):
-        #FIXME: name argument is unused
+    def __call__(self, expr):
         bitstream, mimetype = expr
         if isinstance(bitstream, Report):
@@ -103 +102 @@
 
 class ColumnCounter:
-    """A class used to add the correct number of column definitions to a
-    table containing an horizontal repetition"
+    """A class used to count the actual maximum number of cells (and thus
+    columns) a table contains accross its rows.
     """
     def __init__(self):
@@ -122 +121 @@
 
 def wrap_nodes_between(first, last, new_parent):
+    """An helper function to move all nodes between two nodes to a new node
+    and add that new node to their former parent. The boundary nodes are
+    removed in the process.
+    """
     old_parent = first.getparent()
     for node in first.itersiblings():
@@ -449 +452 @@
                 # The grand-parent tag is a table cell we should set the
                 # correct value and type for this cell.
-                dico = "{'%s': %s, '%s': guess_type(%s)}"
+                dico = "{'%s': %s, '%s': __relatorio_guess_type(%s)}"
                 parent.attrib[py_attrs_attr] = dico % (office_name, expr,
-                                                     office_valuetype, expr)
+                                                       office_valuetype, expr)
                 parent.attrib.pop(office_valuetype, None)
                 parent.attrib.pop(office_name, None)
@@ -457 +460 @@
     def _handle_row_spanned_column_loops(self, parsed, outer_o_node,
                                          opening_pos, closing_pos):
+        """handles column repetitions which span several rows, by duplicating
+        the py:for node for each row, and make the loops work on a copy of the
+        original iterable as to not exhaust generators."""
         _, directive, attr, a_val = parsed
         table_rowspan_attr = '{%s}number-rows-spanned' \
@@ -516 +522 @@
 
     def _handle_images(self, tree):
-        "replaces all draw:frame named 'image: ...' by a draw:image node"
+        "replaces all draw:frame named 'image: ...' by draw:image nodes"
         draw_name = '{%s}name' % self.namespaces['draw']
         draw_image = '{%s}image' % self.namespaces['draw']
@@ -523 +529 @@
         for draw in tree.xpath(xpath_expr, namespaces=self.namespaces):
             d_name = draw.attrib[draw_name]
-            attr_expr = "make_href(%s, %r)" % (d_name[7:], d_name[7:])
+            attr_expr = "__relatorio_make_href(%s)" % d_name[7:]
             image_node = EtreeElement(draw_image,
                                       attrib={py_attrs: attr_expr},
@@ -540 +546 @@
         "creates the RelatorioStream."
         serializer = OOSerializer(self.filepath)
-        kwargs['make_href'] = ImageHref(serializer.outzip, kwargs)
-        kwargs['guess_type'] = guess_type
+        kwargs['__relatorio_make_href'] = ImageHref(serializer.outzip, kwargs)
+        kwargs['__relatorio_guess_type'] = guess_type
 
         counter = ColumnCounter()