Merge pull request #229 from cs50/regex_module

Move regex to module

check50/__init__.py

@@ -38,16 +38,16 @@ def _setup_translation():
     exists,
     hash,
     include,
-    regex,
     run,
     log, _log,
     hidden,
-    Failure, Mismatch
+    Failure, Mismatch, Missing
 )
 
 
+from . import regex
 from .runner import check
 from pexpect import EOF
 
 __all__ = ["import_checks", "data", "exists", "hash", "include", "regex",
-           "run", "log", "Failure", "Mismatch", "check", "EOF"]
+           "run", "log", "Failure", "Mismatch", "Missing", "check", "EOF"]

check50/_api.py

@@ -12,7 +12,7 @@
 import pexpect
 from pexpect.exceptions import EOF, TIMEOUT
 
-from . import internal
+from . import internal, regex
 
 _log = []
 internal.register.before_every(_log.clear)
@@ -137,34 +137,6 @@ def import_checks(path):
     return mod
 
 
-class regex:
-    @staticmethod
-    def decimal(number):
-        """
-        Create a regular expression to match the number exactly:
-            In case of a positive number:
-                (?<![\d\-])number(?!(\.?\d))
-            In case of a negative number:
-                number(?!(\.?\d))
-
-        (?<![\d\-]) = negative lookbehind, \
-            asserts that there are no digits and no - in front of the number.
-        (?!(\.?\d)) = negative lookahead, \
-            asserts that there are no digits and no additional . followed by digits after the number.
-
-        :param number: the number to match in the regex
-        :type number: any numbers.Number (such as int, float, ...)
-        :rtype: str
-
-        Example usage::
-
-            # Check that 7.0000 is printed with 5 significant figures
-            check50.run("./prog").stdout(check50.regex.decimal("7.0000"))
-
-        """
-        negative_lookbehind = fr"(?<![\d\-])" if number >= 0 else ""
-        return fr"{negative_lookbehind}{re.escape(str(number))}(?!(\.?\d))"
-
 
 class run:
     """

check50/regex.py

@@ -0,0 +1,33 @@
+import re
+
+
+def decimal(number):
+    """
+    Create a regular expression to match the number exactly:
+
+    In case of a positive number::
+
+        (?<![\d\-])number(?!(\.?\d))
+
+    In case of a negative number::
+
+        number(?!(\.?\d))
+
+    :code:`(?<![\d\-])` = negative lookbehind, \
+        asserts that there are no digits and no - in front of the number.
+
+    :code:`(?!(\.?\d))` = negative lookahead, \
+        asserts that there are no digits and no additional . followed by digits after the number.
+
+    :param number: the number to match in the regex
+    :type number: any numbers.Number (such as int, float, ...)
+    :rtype: str
+
+    Example usage::
+
+        # Check that 7.0000 is printed with 5 significant figures
+        check50.run("./prog").stdout(check50.regex.decimal("7.0000"))
+
+    """
+    negative_lookbehind = fr"(?<![\d\-])" if number >= 0 else ""
+    return fr"{negative_lookbehind}{re.escape(str(number))}(?!(\.?\d))"

docs/source/api.rst

@@ -5,18 +5,21 @@ API docs
 
 .. _check50:
 
+
 check50
 *******
 
 .. automodule:: check50
    :members:
 
+
 check50.c
 **********
 
 .. automodule:: check50.c
   :members:
 
+
 check50.flask
 ****************
 
@@ -30,6 +33,12 @@ check50.py
    :members:
 
 
+check50.regex
+**************
+.. automodule:: check50.regex
+  :members:
+
+
 check50.internal
 *****************