rename constructor

Author: sweetStreet

README.md

@@ -21,7 +21,7 @@ Inline testing is a new granularity of testing that make it easier to check indi
 ## Example
 The regular expression (Line 5) in this code snippet checks if variable name matches a regex for a pattern that ends in a colon and has at least one digit
 The inline test (Line 6) that we write for target statement (Line 5) consists of three parts:
-- Declaration with Here() constructor
+- Declaration with itest() constructor
 - Assigning inputs with given() function calls
 - Specifying test oracles with check_*() function calls
 
@@ -31,7 +31,7 @@ def get_assignment_map_from_checkpoint(tvars, init_c):
     for var in tvars:
         name = var.name
         m = re.match("^(.*):\\d+$", name)
-        Here().given(name, "a:0").check_eq(m, "a")
+        itest().given(name, "a:0").check_eq(m, "a")
         if m is not None:
             name = m.group(1)
     ...
@@ -51,7 +51,7 @@ Use ``pytest {filename}`` to run all inline tests in a Python file.
 
 ### Declaration of an inline test
 
-- Here(test_name, parameterized, repeated, tag, disabled, timeout): 
+- itest(test_name, parameterized, repeated, tag, disabled, timeout): 
 1. test_name is a string that represents the name of the test. The default value is the file name + line number of the test statement.
 
 2. parameterized is a boolean value that indicates whether the test is parameterized. The default value is false.
@@ -77,7 +77,7 @@ Use ``pytest {filename}`` to run all inline tests in a Python file.
     def FileHeader(self):
             dt = self.date_time
             dosdate = (dt[0] - 1980) << 9 | dt[1] << 5 | dt[2]
-            Here().assume(2 < 4).given(dt, (1980, 1, 25, 17, 13, 14)).check_eq(dosdate, 57)
+            itest().assume(2 < 4).given(dt, (1980, 1, 25, 17, 13, 14)).check_eq(dosdate, 57)
     ```
 
 
@@ -87,12 +87,12 @@ Use ``pytest {filename}`` to run all inline tests in a Python file.
 - given(variable, value): 
         Assign the value to the variable. 
 
-    Note that any number of given statements can be added. Below is a small example of this functionality. Additionally, the first given call must proceed either a Here() declaration or a assume() call if it is added.
+    Note that any number of given statements can be added. Below is a small example of this functionality. Additionally, the first given call must proceed either an itest() declaration or a assume() call if it is added.
 
     ```python {.line-numbers}
     def multiple_givens(a, c):
         b = a + c
-        Here().given(a, 2).given(c, a + 1).check_true(b == 5)
+        itest().given(a, 2).given(c, a + 1).check_true(b == 5)
     ```
 
 

changelog

@@ -1,4 +1,7 @@
 # Changelog
+## [1.0.3]
+### Changed
+- Change: Use `itest` instead of `Here` for inline test constructor
 
 ## [1.0.2]
 ### Fix

integration-tests/parallelization/test_files/a.py

@@ -1,15 +1,15 @@
-from inline import Here
+from inline import itest
 
 a = 0
 a = a + 1
-Here("1", tag = ["add"]).given(a, 1).check_eq(a, 2)
-Here("1", tag = ["add"]).given(a, 1).check_eq(a, 2)
-Here("1", tag = ["add"]).given(a, 1).check_eq(a, 2)
+itest("1", tag = ["add"]).given(a, 1).check_eq(a, 2)
+itest("1", tag = ["add"]).given(a, 1).check_eq(a, 2)
+itest("1", tag = ["add"]).given(a, 1).check_eq(a, 2)
 a = a + 2
-Here("2").given(a, 1).check_eq(a, 3)
-Here("2").given(a, 1).check_eq(a, 3)
-Here("2").given(a, 1).check_eq(a, 3)
+itest("2").given(a, 1).check_eq(a, 3)
+itest("2").given(a, 1).check_eq(a, 3)
+itest("2").given(a, 1).check_eq(a, 3)
 a = a - 1
-Here("3", tag = ["minus"]).given(a, 1).check_eq(a, 0)
-Here("3", tag = ["minus"]).given(a, 1).check_eq(a, 0)
-Here("3", tag = ["minus"]).given(a, 1).check_eq(a, 0)
+itest("3", tag = ["minus"]).given(a, 1).check_eq(a, 0)
+itest("3", tag = ["minus"]).given(a, 1).check_eq(a, 0)
+itest("3", tag = ["minus"]).given(a, 1).check_eq(a, 0)

integration-tests/parallelization/test_files/b.py

@@ -1,17 +1,17 @@
-from inline import Here
+from inline import itest
 import time
 
 sleep = 1
 b = 0
 b = b + 1
-Here("1", tag = ["add"]).given(b, 1).check_eq(b, 2).check_eq(time.sleep(sleep), None)
-Here("1", tag = ["add"]).given(b, 1).check_eq(b, 2)
-Here("1", tag = ["add"]).given(b, 1).check_eq(b, 2)
+itest("1", tag = ["add"]).given(b, 1).check_eq(b, 2).check_eq(time.sleep(sleep), None)
+itest("1", tag = ["add"]).given(b, 1).check_eq(b, 2)
+itest("1", tag = ["add"]).given(b, 1).check_eq(b, 2)
 b = b + 2
-Here("2").given(b, 1).check_eq(b, 3).check_eq(time.sleep(sleep), None)
-Here("2").given(b, 1).check_eq(b, 3)
-Here("2").given(b, 1).check_eq(b, 3)
+itest("2").given(b, 1).check_eq(b, 3).check_eq(time.sleep(sleep), None)
+itest("2").given(b, 1).check_eq(b, 3)
+itest("2").given(b, 1).check_eq(b, 3)
 b = b - 1
-Here("3", tag = ["minus"]).given(b, 1).check_eq(b, 0).check_eq(time.sleep(sleep), None)
-Here("3", tag = ["minus"]).given(b, 1).check_eq(b, 0)
-Here("3", tag = ["minus"]).given(b, 1).check_eq(b, 0)
+itest("3", tag = ["minus"]).given(b, 1).check_eq(b, 0).check_eq(time.sleep(sleep), None)
+itest("3", tag = ["minus"]).given(b, 1).check_eq(b, 0)
+itest("3", tag = ["minus"]).given(b, 1).check_eq(b, 0)

integration-tests/parallelization/test_files/c.py

@@ -1,17 +1,17 @@
-from inline import Here
+from inline import itest
 import time
 
 sleep = 2
 c = 0
 c = c + 1
-Here("1", tag = ["add"]).given(c, 1).check_eq(c, 2).check_eq(time.sleep(sleep), None)
-Here("1", tag = ["add"]).given(c, 1).check_eq(c, 2)
-Here("1", tag = ["add"]).given(c, 1).check_eq(c, 2)
+itest("1", tag = ["add"]).given(c, 1).check_eq(c, 2).check_eq(time.sleep(sleep), None)
+itest("1", tag = ["add"]).given(c, 1).check_eq(c, 2)
+itest("1", tag = ["add"]).given(c, 1).check_eq(c, 2)
 c = c + 2
-Here("2").given(c, 1).check_eq(c, 3).check_eq(time.sleep(sleep), None)
-Here("2").given(c, 1).check_eq(c, 3)
-Here("2").given(c, 1).check_eq(c, 3)
+itest("2").given(c, 1).check_eq(c, 3).check_eq(time.sleep(sleep), None)
+itest("2").given(c, 1).check_eq(c, 3)
+itest("2").given(c, 1).check_eq(c, 3)
 c = c - 1
-Here("3", tag = ["minus"]).given(c, 1).check_eq(c, 0).check_eq(time.sleep(sleep), None)
-Here("3", tag = ["minus"]).given(c, 1)
-Here("3", tag = ["minus"]).given(c, 1)
+itest("3", tag = ["minus"]).given(c, 1).check_eq(c, 0).check_eq(time.sleep(sleep), None)
+itest("3", tag = ["minus"]).given(c, 1)
+itest("3", tag = ["minus"]).given(c, 1)

integration-tests/parallelization/test_files/d.py

@@ -1,17 +1,17 @@
-from inline import Here
+from inline import itest
 import time
 
 sleep = 1
 d = 0
 d = d + 1
-Here("1", tag = ["add"]).given(d, 1).check_eq(d, 2).check_eq(time.sleep(sleep), None)
-Here("1", tag = ["add"]).given(d, 1).check_eq(d, 2)
-Here("1", tag = ["add"]).given(d, 1).check_eq(d, 2)
+itest("1", tag = ["add"]).given(d, 1).check_eq(d, 2).check_eq(time.sleep(sleep), None)
+itest("1", tag = ["add"]).given(d, 1).check_eq(d, 2)
+itest("1", tag = ["add"]).given(d, 1).check_eq(d, 2)
 d = d + 2
-Here("2").given(d, 1).check_eq(d, 3).check_eq(time.sleep(sleep), None)
-Here("2").given(d, 1).check_eq(d, 3)
-Here("2").given(d, 1).check_eq(d, 3)
+itest("2").given(d, 1).check_eq(d, 3).check_eq(time.sleep(sleep), None)
+itest("2").given(d, 1).check_eq(d, 3)
+itest("2").given(d, 1).check_eq(d, 3)
 d = d - 1
-Here("3", tag = ["minus"]).given(d, 1).check_eq(d, 0).check_eq(time.sleep(sleep), None)
-Here("3", tag = ["minus"]).given(d, 1).check_eq(d, 0)
-Here("3", tag = ["minus"]).given(d, 1).check_eq(d, 0)
+itest("3", tag = ["minus"]).given(d, 1).check_eq(d, 0).check_eq(time.sleep(sleep), None)
+itest("3", tag = ["minus"]).given(d, 1).check_eq(d, 0)
+itest("3", tag = ["minus"]).given(d, 1).check_eq(d, 0)

integration-tests/parallelization/test_files/e.py

@@ -1,17 +1,17 @@
-from inline import Here
+from inline import itest
 import time
 
 sleep = 2
 e = 0
 e = e + 1
-Here("1", tag = ["add"]).given(e, 1).check_eq(e, 2).check_eq(time.sleep(sleep), None)
-Here("1", tag = ["add"]).given(e, 1).check_eq(e, 2)
-Here("1", tag = ["add"]).given(e, 1).check_eq(e, 2)
+itest("1", tag = ["add"]).given(e, 1).check_eq(e, 2).check_eq(time.sleep(sleep), None)
+itest("1", tag = ["add"]).given(e, 1).check_eq(e, 2)
+itest("1", tag = ["add"]).given(e, 1).check_eq(e, 2)
 e = e + 2
-Here("2").given(e, 1).check_eq(e, 3).check_eq(time.sleep(sleep), None)
-Here("2").given(e, 1).check_eq(e, 3)
-Here("2").given(e, 1).check_eq(e, 3)
+itest("2").given(e, 1).check_eq(e, 3).check_eq(time.sleep(sleep), None)
+itest("2").given(e, 1).check_eq(e, 3)
+itest("2").given(e, 1).check_eq(e, 3)
 e = e - 1
-Here("3", tag = ["minus"]).given(e, 1).check_eq(e, 0).check_eq(time.sleep(sleep), None)
-Here("3", tag = ["minus"]).given(e, 1).check_eq(e, 0)
-Here("3", tag = ["minus"]).given(e, 1).check_eq(e, 0)
+itest("3", tag = ["minus"]).given(e, 1).check_eq(e, 0).check_eq(time.sleep(sleep), None)
+itest("3", tag = ["minus"]).given(e, 1).check_eq(e, 0)
+itest("3", tag = ["minus"]).given(e, 1).check_eq(e, 0)

integration-tests/parallelization/test_files/f.py

@@ -1,17 +1,17 @@
-from inline import Here
+from inline import itest
 import time
 
 sleep = 1
 f = 0
 f = f + 1
-Here("1", tag = ["add"]).given(f, 1).check_eq(f, 2).check_eq(time.sleep(sleep), None)
-Here("1", tag = ["add"]).given(f, 1).check_eq(f, 2)
-Here("1", tag = ["add"]).given(f, 1).check_eq(f, 2)
+itest("1", tag = ["add"]).given(f, 1).check_eq(f, 2).check_eq(time.sleep(sleep), None)
+itest("1", tag = ["add"]).given(f, 1).check_eq(f, 2)
+itest("1", tag = ["add"]).given(f, 1).check_eq(f, 2)
 f = f + 2
-Here("2").given(f, 1).check_eq(f, 3).check_eq(time.sleep(sleep), None)
-Here("2").given(f, 1).check_eq(f, 3)
-Here("2").given(f, 1).check_eq(f, 3)
+itest("2").given(f, 1).check_eq(f, 3).check_eq(time.sleep(sleep), None)
+itest("2").given(f, 1).check_eq(f, 3)
+itest("2").given(f, 1).check_eq(f, 3)
 f = f - 1
-Here("3", tag = ["minus"]).given(f, 1).check_eq(f, 0).check_eq(time.sleep(sleep), None)
-Here("3", tag = ["minus"]).given(f, 1).check_eq(f, 0)
-Here("3", tag = ["minus"]).given(f, 1).check_eq(f, 0)
+itest("3", tag = ["minus"]).given(f, 1).check_eq(f, 0).check_eq(time.sleep(sleep), None)
+itest("3", tag = ["minus"]).given(f, 1).check_eq(f, 0)
+itest("3", tag = ["minus"]).given(f, 1).check_eq(f, 0)

integration-tests/parallelization/test_files/g.py

@@ -1,17 +1,17 @@
-from inline import Here
+from inline import itest
 import time
 
 sleep = 2
 g = 0
 g = g + 1
-Here("1", tag = ["add"]).given(g, 1).check_eq(g, 2).check_eq(time.sleep(sleep), None)
-Here("1", tag = ["add"]).given(g, 1).check_eq(g, 2)
-Here("1", tag = ["add"]).given(g, 1).check_eq(g, 2)
+itest("1", tag = ["add"]).given(g, 1).check_eq(g, 2).check_eq(time.sleep(sleep), None)
+itest("1", tag = ["add"]).given(g, 1).check_eq(g, 2)
+itest("1", tag = ["add"]).given(g, 1).check_eq(g, 2)
 g = g + 2
-Here("2").given(g, 1).check_eq(g, 3).check_eq(time.sleep(sleep), None)
-Here("2").given(g, 1).check_eq(g, 3)
-Here("2").given(g, 1).check_eq(g, 3)
+itest("2").given(g, 1).check_eq(g, 3).check_eq(time.sleep(sleep), None)
+itest("2").given(g, 1).check_eq(g, 3)
+itest("2").given(g, 1).check_eq(g, 3)
 g = g - 1
-Here("3", tag = ["minus"]).given(g, 1).check_eq(g, 0).check_eq(time.sleep(sleep), None)
-Here("3", tag = ["minus"]).given(g, 1).check_eq(g, 0)
-Here("3", tag = ["minus"]).given(g, 1).check_eq(g, 0)
+itest("3", tag = ["minus"]).given(g, 1).check_eq(g, 0).check_eq(time.sleep(sleep), None)
+itest("3", tag = ["minus"]).given(g, 1).check_eq(g, 0)
+itest("3", tag = ["minus"]).given(g, 1).check_eq(g, 0)

integration-tests/parallelization/test_files/h.py

@@ -1,17 +1,17 @@
-from inline import Here
+from inline import itest
 import time
 
 sleep = 1
 h = 0
 h = h + 1
-Here("1", tag = ["add"]).given(h, 1).check_eq(h, 2).check_eq(time.sleep(sleep), None)
-Here("1", tag = ["add"]).given(h, 1).check_eq(h, 2)
-Here("1", tag = ["add"]).given(h, 1).check_eq(h, 2)
+itest("1", tag = ["add"]).given(h, 1).check_eq(h, 2).check_eq(time.sleep(sleep), None)
+itest("1", tag = ["add"]).given(h, 1).check_eq(h, 2)
+itest("1", tag = ["add"]).given(h, 1).check_eq(h, 2)
 h = h + 2
-Here("2").given(h, 1).check_eq(h, 3).check_eq(time.sleep(sleep), None)
-Here("2").given(h, 1).check_eq(h, 3)
-Here("2").given(h, 1).check_eq(h, 3)
+itest("2").given(h, 1).check_eq(h, 3).check_eq(time.sleep(sleep), None)
+itest("2").given(h, 1).check_eq(h, 3)
+itest("2").given(h, 1).check_eq(h, 3)
 h = h - 1
-Here("3", tag = ["minus"]).given(h, 1).check_eq(h, 0).check_eq(time.sleep(sleep), None)
-Here("3", tag = ["minus"]).given(h, 1).check_eq(h, 0)
-Here("3", tag = ["minus"]).given(h, 1).check_eq(h, 0)
+itest("3", tag = ["minus"]).given(h, 1).check_eq(h, 0).check_eq(time.sleep(sleep), None)
+itest("3", tag = ["minus"]).given(h, 1).check_eq(h, 0)
+itest("3", tag = ["minus"]).given(h, 1).check_eq(h, 0)