#18 - autoflush processes for dirty exit

It is possible that TagUI processes (main TagUI, integration background processes - SikuliX, Chrome, Chrome browser) are not exited cleanly under certain conditions. For eg, if user Ctrl+C to kill a TagUI for Python script, or if user forgets to use close() to gracefully close off the running processes.

These dead processes have insignificant impact to TagUI for Python functionality. However they can cause unnecessary drain on battery and CPU cycles. Raising this issue to make a commit that runs a TagUI script that flush all TagUI-related processes.

This will be run within init() so that an accidental Ctrl+C or forgetting to close() allows immediate resumption of use by relaunching Jupyter notebook or Python interactive shell or Python script, and using init(). Placing within close() is meaningless for the scenarios where dead processes happen.

Author: kensoh

README.md

@@ -2,7 +2,7 @@
 
 # TagUI for Python
 
-[**Use Cases**](#use-cases) | [**API Reference**](#api-reference) | [**About**](#about) | [**v1.5**](https://github.com/tebelorg/TagUI-Python/releases)
+[**Use Cases**](#use-cases) | [**API Reference**](#api-reference) | [**About**](#about) | [**v1.6**](https://github.com/tebelorg/TagUI-Python/releases)
 
 ![TagUI for Python demo in Jupyter notebook](https://raw.githubusercontent.com/tebelorg/Tump/master/tagui_python.gif)
 

sample.py

@@ -1,4 +1,7 @@
-# use pip install tagui to install TagUI for Python
+# TagUI for Python's simple, expressive and powerful API makes digital automation fun and easy!
+# pip install tagui to install TagUI for Python, pip install tagui --upgrade for latest version
+
+# to use in Jupyter notebook, Python script or interactive shell
 import tagui as t
 
 # use init() to start TagUI, it autoruns setup() to download TagUI
@@ -32,7 +35,7 @@
 t.snap('logo', 'logo.png')
 
 # another example of interacting with a web page
-# include http:// or https:// in URL parameter
+# do include http:// or https:// in URL parameter
 t.url('https://duckduckgo.com')
 t.type('search_form_input_homepage', 'The search engine that doesn\'t track you.')
 t.snap('page', 'duckduckgo.png')
@@ -45,9 +48,9 @@
 # in above web automation example, web element identifier can be XPath selector, CSS selector or
 # attributes id, name, class, title, aria-label, text(), href (in decreasing order of priority)
 
-# TagUI also supports visual element identifier using .png or .bmp image snapshot
+# also supports visual element identifier using .png or .bmp image snapshot
 # representing the UI element (can be on desktop applications or web browser)
-# for eg t.click('start_menu.png'), t.type('username_box.png[enter]', 'Sonic')
+# for eg t.click('start_menu.png'), t.type('username_box.png', 'Sonic')
 
 # image transparency (0% opacity) is supported, ie images with empty sections
 # t.read('image_preview_frame.png'), t.snap('application_window_frame.png')
@@ -57,5 +60,3 @@
 
 # another eg is limits of area of interest x1, y1, x2, y2 for read() and snap()
 # t.read(200, 200, 600, 400), t.snap(200, 200, 600, 400, 'results.png')
-
-# TagUI's simple, expressive and powerful API makes digital automation fun and easy! 

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='tagui',
-    version='1.5.0',
+    version='1.6.0',
     py_modules=['tagui'],
     author='Ken Soh',
     author_email='[email protected]',

tagui.py

@@ -1,6 +1,6 @@
 """INTEGRATION ENGINE FOR TAGUI PYTHON PACKAGE ~ TEBEL.ORG"""
 __author__ = 'Ken Soh <[email protected]>'
-__version__ = '1.5.0'
+__version__ = '1.6.0'
 
 import subprocess
 import os
@@ -179,15 +179,18 @@ def _tagui_delta(base_directory = None):
     if os.path.isfile(base_directory + '/' + 'tagui_python_' + __version__): return True
 
     # define list of key tagui files to be downloaded and synced locally
-    delta_list = ['tagui', 'tagui.cmd', 'tagui_header.js', 'tagui_parse.php', 'tagui.sikuli/tagui.py']
+    delta_list = ['tagui', 'tagui.cmd', 'end_processes', 'end_processes.cmd', 
+                    'tagui_header.js', 'tagui_parse.php', 'tagui.sikuli/tagui.py']
+
     for delta_file in delta_list:
         tagui_delta_url = 'https://raw.githubusercontent.com/tebelorg/Tump/master/TagUI-Python/' + delta_file
         tagui_delta_file = base_directory + '/' + 'src' + '/' + delta_file
         if not download(tagui_delta_url, tagui_delta_file): return False
 
-    # make sure execute permission is there for .tagui/src/tagui
+    # make sure execute permission is there for .tagui/src/tagui and end_processes
     if platform.system() in ['Linux', 'Darwin']:
         os.system('chmod -R 755 ' + base_directory + '/' + 'src' + '/' + 'tagui > /dev/null 2>&1')
+        os.system('chmod -R 755 ' + base_directory + '/' + 'src' + '/' + 'end_processes > /dev/null 2>&1')
 
     # create marker file to skip syncing delta files next time for current release
     delta_done_file = _py23_open(base_directory + '/' + 'tagui_python_' + __version__, 'w')
@@ -399,6 +402,7 @@ def init(visual_automation = False, chrome_browser = True):
         tagui_directory = os.path.expanduser('~') + '/' + '.tagui'
 
     tagui_executable = tagui_directory + '/' + 'src' + '/' + 'tagui'
+    end_processes_executable = tagui_directory + '/' + 'src' + '/' + 'end_processes'
 
     # if tagui executable is not found, initiate setup() to install tagui
     if not os.path.isfile(tagui_executable):
@@ -441,7 +445,11 @@ def init(visual_automation = False, chrome_browser = True):
 
     # entry shell command to invoke tagui process
     tagui_cmd = tagui_executable + ' tagui_python ' + browser_option
-    
+
+    # run tagui end processes script to flush dead processes
+    # for eg execution ended with ctrl+c or forget to close()
+    os.system(end_processes_executable)
+
     try:
         # launch tagui using subprocess
         _process = subprocess.Popen(