Add property html to Dimensionality

bjodah · bjodah · commit 134085473b8f · 2016-04-22T14:29:12.000+02:00
diff --git a/quantities/dimensionality.py b/quantities/dimensionality.py
@@ -52,6 +52,10 @@ def unicode(self):
     def latex(self):
         return markup.format_units_latex(self)
 
+    @property
+    def html(self):
+        return markup.format_units_html(self)
+
     def __hash__(self):
         res = hash(unit_registry['dimensionless'])
         for key in sorted(self.keys(), key=operator.attrgetter('format_order')):
diff --git a/quantities/markup.py b/quantities/markup.py
@@ -89,27 +89,27 @@ def format_units_unicode(udict):
 def format_units_latex(udict,font='mathrm',mult=r'\cdot',paren=False):
     '''
     Replace the units string provided with an equivalent latex string.
-    
+
     Division (a/b) will be replaced by \frac{a}{b}.
-    
+
     Exponentiation (m**2) will be replaced with superscripts (m^{2})
-    
-    The latex is set  with the font argument, and the default is the normal, 
-    non-italicized font mathrm.  Other useful options include 'mathnormal', 
+
+    The latex is set  with the font argument, and the default is the normal,
+    non-italicized font mathrm.  Other useful options include 'mathnormal',
     'mathit', 'mathsf', and 'mathtt'.
-    
+
     Multiplication (*) are replaced with the symbol specified by the mult argument.
     By default this is the latex \cdot symbol.  Other useful
     options may be '' or '*'.
-    
+
     If paren=True, encapsulate the string in '\left(' and '\right)'
-    
+
     The result of format_units_latex is encapsulated in $.  This allows the result
     to be used directly in Latex in normal text mode, or in Matplotlib text via the
     MathText feature.
-    
+
     Restrictions:
-    This routine will not put CompoundUnits into a fractional form. 
+    This routine will not put CompoundUnits into a fractional form.
     '''
     res = format_units(udict)
     if res.startswith('(') and res.endswith(')'):
@@ -128,3 +128,36 @@ def format_units_latex(udict,font='mathrm',mult=r'\cdot',paren=False):
         res = r'\left(%s\right)' % res
     res = r'$\%s{%s}$' % (font,res)
     return res
+
+
+def format_units_html(udict,font='%s',mult=r'&sdot;',paren=False):
+    '''
+    Replace the units string provided with an equivalent html string.
+
+    Exponentiation (m**2) will be replaced with superscripts (m<sup>2</sup>})
+
+    No formating is done, change `font` argument to e.g.:
+    '<span style="color: #0000a0">%s</span>' to have text be colored blue.
+
+    Multiplication (*) are replaced with the symbol specified by the mult
+    argument. By default this is the latex &sdot; symbol.  Other useful options
+    may be '' or '*'.
+
+    If paren=True, encapsulate the string in '(' and ')'
+
+    '''
+    res = format_units(udict)
+    if res.startswith('(') and res.endswith(')'):
+        # Compound Unit
+        compound = True
+    else:
+        # Not a compound unit
+        compound = False
+    # Replace exponentiation (**exp) with ^{exp}
+    res = re.sub(r'\*{2,2}(?P<exp>\d+)',r'<sup>\g<exp></sup>',res)
+    # Remove multiplication signs
+    res = re.sub(r'\*',mult,res)
+    if paren and not compound:
+        res = '(%s)' % res
+    res = font % res
+    return res
diff --git a/quantities/tests/test_dimensionality.py b/quantities/tests/test_dimensionality.py
@@ -14,6 +14,7 @@
 joule_str = 'kg*m**2/s**2'
 joule_uni = 'kg·m²/s²'
 joule_tex = r'$\mathrm{\frac{kg{\cdot}m^{2}}{s^{2}}}$'
+joule_htm = 'kg&sdot;m<sup>2</sup>/s<sup>2</sup>'
 Joule = Dimensionality({pq.J: 1})
 Joule_str = 'J'
 
@@ -24,6 +25,7 @@ def test_dimensionality_str(self):
         self.assertEqual(joule.string, joule_str)
         self.assertEqual(joule.unicode, joule_uni)
         self.assertEqual(joule.latex, joule_tex)
+        self.assertEqual(joule.html, joule_htm)
         self.assertEqual(Joule.string, 'J')
 
     def test_equality(self):
