FIX: Escape chars in re (#194)

Author: larsoner

numpydoc/docscrape.py

@@ -324,7 +324,8 @@ def _parse_summary(self):
         while True:
             summary = self._doc.read_to_next_empty_line()
             summary_str = " ".join([s.strip() for s in summary]).strip()
-            if re.compile('^([\w., ]+=)?\s*[\w\.]+\(.*\)$').match(summary_str):
+            compiled = re.compile(r'^([\w., ]+=)?\s*[\w\.]+\(.*\)$')
+            if compiled.match(summary_str):
                 self['Signature'] = summary_str
                 if not self._is_at_section():
                     continue
@@ -396,7 +397,7 @@ def _str_indent(self, doc, indent=4):
 
     def _str_signature(self):
         if self['Signature']:
-            return [self['Signature'].replace('*', '\*')] + ['']
+            return [self['Signature'].replace('*', r'\*')] + ['']
         else:
             return ['']
 
@@ -528,7 +529,7 @@ def __init__(self, func, role='func', doc=None, config={}):
                     else:
                         argspec = inspect.getargspec(func)
                     signature = inspect.formatargspec(*argspec)
-                signature = '%s%s' % (func_name, signature.replace('*', '\*'))
+                signature = '%s%s' % (func_name, signature.replace('*', r'\*'))
             except TypeError:
                 signature = '%s()' % func_name
             self['Signature'] = signature
@@ -545,7 +546,7 @@ def __str__(self):
         out = ''
 
         func, func_name = self.get_func()
-        signature = self['Signature'].replace('*', '\*')
+        signature = self['Signature'].replace('*', r'\*')
 
         roles = {'func': 'function',
                  'meth': 'method'}

numpydoc/docscrape_sphinx.py

@@ -168,7 +168,7 @@ def _process_param(self, param, desc, fake_autosummary):
                                               param)
         if obj_doc:
             # Overwrite desc. Take summary logic of autosummary
-            desc = re.split('\n\s*\n', obj_doc.strip(), 1)[0]
+            desc = re.split(r'\n\s*\n', obj_doc.strip(), 1)[0]
             # XXX: Should this have DOTALL?
             #      It does not in autosummary
             m = re.search(r"^([A-Z].*?\.)(?:\s|$)",

numpydoc/numpydoc.py

@@ -53,7 +53,7 @@ def rename_references(app, what, name, obj, options, lines):
     references = set()
     for line in lines:
         line = line.strip()
-        m = re.match(sixu('^.. \\[(%s)\\]') % app.config.numpydoc_citation_re,
+        m = re.match(sixu(r'^.. \[(%s)\]') % app.config.numpydoc_citation_re,
                      line, re.I)
         if m:
             references.add(m.group(1))

numpydoc/tests/test_docscrape.py

@@ -631,13 +631,13 @@ def test_parameters_without_extended_description():
 
 def test_escape_stars():
     signature = str(doc3).split('\n')[0]
-    assert signature == 'my_signature(\*params, \*\*kwds)'
+    assert signature == r'my_signature(\*params, \*\*kwds)'
 
     def my_func(a, b, **kwargs):
         pass
 
     fdoc = FunctionDoc(func=my_func)
-    assert fdoc['Signature'] == 'my_func(a, b, \*\*kwargs)'
+    assert fdoc['Signature'] == r'my_func(a, b, \*\*kwargs)'
 
 
 doc4 = NumpyDocString(
@@ -1238,7 +1238,7 @@ def test_args_and_kwargs():
     **kwargs : dict
         Keyword arguments
     """, config=cfg)
-    line_by_line_compare(str(doc), """
+    line_by_line_compare(str(doc), r"""
 :Parameters:
 
     **param1** : int