conversion to tagui python object

kensoh · kensoh · commit f2e39fc07b09 · 2019-05-24T23:51:10.000+08:00
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,12 @@
 # exclude python packaging files
-dist/
-MANIFEST
+/dist/
+/MANIFEST
+
+# exclude pycache directory
+/__pycache__
+
+# exclude generated .pyc file
+/tagui.pyc
 
 # exclude entry flow log files
 /tagui_python.log
diff --git a/sample.py b/sample.py
@@ -0,0 +1,28 @@
+import tagui as t
+
+tagui_flow = [
+    'https://ca.yahoo.com',
+    'type search-box as github',
+    'show search-box',
+    'click search-button',
+    'snap page',
+    'snap logo',
+    'https://duckduckgo.com',
+    'type search_form_input_homepage as The search engine that doesnt track you.',
+]
+
+t.init()
+
+t.send(tagui_flow[0])
+t.send(tagui_flow[1])
+t.send(tagui_flow[2])
+t.click("search-button")
+
+t.wait(5)
+
+t.send(tagui_flow[4])
+t.send(tagui_flow[5])
+t.send(tagui_flow[6])
+t.send(tagui_flow[7])
+
+t.close()
diff --git a/setup.py b/setup.py
@@ -4,7 +4,7 @@
     name='tagui',
     version='0.0.2',
     author='Tebel.Automation',
-    author_email='support@tebel.org',
+    author_email='ken@tebel.org',
     url='https://github.com/tebelorg/TagUI-Python',
     license='LICENSE.txt',
     description='Placeholder for TagUI Python package',
diff --git a/tagui.py b/tagui.py
@@ -39,7 +39,7 @@ def py23_encode(input_variable):
     elif python2_env(): return input_variable
     else: return input_variable.encode('utf-8')
 
-def tagui_open():
+def init():
 # connect to tagui process by checking tagui live mode readiness
 
     global process, tagui_id
@@ -69,7 +69,7 @@ def tagui_open():
         print('[ERROR] - ' + str(e))
         return False
 
-def tagui_ready():
+def ready():
 # check whether tagui is ready to receive instructions
 
     global process, tagui_id
@@ -96,7 +96,7 @@ def tagui_ready():
         print('[ERROR] - ' + str(e))
         return False
 
-def tagui_send(tagui_instruction):
+def send(tagui_instruction):
 # send next live mode instruction to tagui for processing if tagui is ready
 
     global process, tagui_id
@@ -108,7 +108,7 @@ def tagui_send(tagui_instruction):
         if process.poll() is not None: return False
 
         # loop until tagui live mode is ready and listening for inputs
-        while not tagui_ready(): pass
+        while not ready(): pass
 
         # echo live mode instruction, first remove quotes to be echo-safe
         safe_tagui_instruction = tagui_instruction.replace("'", "").replace('"','')
@@ -130,7 +130,7 @@ def tagui_send(tagui_instruction):
         print('[ERROR] - ' + str(e))
         return False
 
-def tagui_close():
+def close():
 # disconnect from tagui process by sending done instruction
 
     global process, tagui_id
@@ -140,7 +140,7 @@ def tagui_close():
         if process.poll() is not None: return False
 
         # loop until tagui live mode is ready and listening for inputs
-        while not tagui_ready(): pass
+        while not ready(): pass
 
         # send done instruction to terminate live mode and exit tagui
         process.stdin.write(py23_encode('echo "[tagui][finished listening]"\n'))
@@ -157,15 +157,15 @@ def tagui_close():
         print('[ERROR] - ' + str(e))
         return False
 
-def tagui_present(element_identifier):
+def present(element_identifier):
     if element_identifier is None or element_identifier == '':
         return False
 
     tagui_timeout = time.time() + 10
     while time.time() < tagui_timeout:
-        tagui_send('present_result = present(\'' + element_identifier + '\')')
-        tagui_send('dump present_result.toString() to /tmp/tagui_python.txt')
-        tagui_send('load /tmp/tagui_python.txt to present_result')
+        send('present_result = present(\'' + element_identifier + '\')')
+        send('dump present_result.toString() to /tmp/tagui_python.txt')
+        send('load /tmp/tagui_python.txt to present_result')
 
         tagui_text = open('/tmp/tagui_python.txt', mode='r')
         element_present = tagui_text.read(); tagui_text.close()
@@ -174,51 +174,22 @@ def tagui_present(element_identifier):
 
     return False
  
-def tagui_click(element_identifier):
+def click(element_identifier):
     if element_identifier is None or element_identifier == '':
         print('[ERROR] - target missing for click()')
         return False
 
-    elif tagui_present(element_identifier) == False:
+    elif present(element_identifier) == False:
         print('[ERROR] - cannot find ' + element_identifier)
         return False
 
-    elif tagui_send('click ' + element_identifier) == False:
+    elif send('click ' + element_identifier) == False:
         return False
 
     else:
         return True
 
-def tagui_wait(delay_in_seconds):
+def wait(delay_in_seconds):
     if delay_in_seconds is None: delay_in_seconds = 5.0
     time.sleep(float(delay_in_seconds))
     return True
-
-# testing code for development
-
-tagui_flow = [
-    'https://ca.yahoo.com',
-    'type search-box as github',
-    'show search-box',
-    'click search-button',
-    'snap page',
-    'snap logo',
-    'https://duckduckgo.com',
-    'type search_form_input_homepage as The search engine that doesnt track you.',
-]
-
-tagui_open()
-
-tagui_send(tagui_flow[0])
-tagui_send(tagui_flow[1])
-tagui_send(tagui_flow[2])
-tagui_click("search-button")
-
-tagui_wait(5)
-
-tagui_send(tagui_flow[4])
-tagui_send(tagui_flow[5])
-tagui_send(tagui_flow[6])
-tagui_send(tagui_flow[7])
-
-tagui_close()
diff --git a/tagui_python b/tagui_python
@@ -1,3 +1,5 @@
+//
 // ENTRY FLOW FOR TAGUI PYTHON PACKAGE ~ TEBEL.ORG
+//
 
 live

-Original file line number
+Diff line change
@@ @@ -1,3 +1,5 @@ @@
 +//
 // ENTRY FLOW FOR TAGUI PYTHON PACKAGE ~ TEBEL.ORG
 +//
 live