add system exit event

finchan/__main__.py

@@ -26,7 +26,6 @@
 import uvloop
 
 from .env import env
-from .event import Event, SysEvents
 from .exts import ExtManager
 from .options import parse_yaml_conf
 from .dispatcher import BackTrackDispatcher, LiveDispatcher
@@ -115,9 +114,6 @@ def main(verbose=0, config=None):
     if not ext_dict:
         ext_dict = {}
     env.load_exts(ext_dict)
-
-    # system initialized, we can send event now.
-    dispatcher.eq_put(Event(str(SysEvents.SYSTEM_STARTED)))
     env.run()
 
 

finchan/dispatcher.py

@@ -29,7 +29,7 @@
 from datetime import datetime
 from collections import defaultdict
 
-from finchan.event import Event
+from .event import Event, SysEvents
 from finchan.interface.event_source import AbsEventSource
 
 
@@ -228,6 +228,9 @@ def dispatch(self):
             logger.warning('#Dispatcher No EventSource registered, system will exit directly.')
             return None
 
+        # system initialized
+        self.eq_put(Event(SysEvents.SYSTEM_STARTED))
+
         self.setup()
         last_event = None
         while True:
@@ -248,13 +251,15 @@ def dispatch(self):
             logger.debug('#Dispatcher Start process event: %s', event)
             for call_func in self._event_subscribes[event.name]:
                 call_func(event)
+                if self._will_stop:
+                    break
             last_event = event
             if self.now >= self._end_dt:
                 logger.info('#Dispatcher Run out of time, dispatch finish.')
                 break
-            if self._will_stop:
-                break
 
+        # system is exiting
+        self.eq_put(Event(SysEvents.SYSTEM_EXITING))
         logger.info('#Dispatcher loop exit.')
         self._will_stop = True
         self.cleanup()

finchan/event.py

@@ -99,17 +99,13 @@ def __repr__(self):
                                                          self.kwargs)
 
 
-class SysEvents(Enum):
+class SysEvents(object):
     """system defined events
 
     enum of events that finchan system generate/reserved:
 
-        * SYSTEM_STARTED = 'system_started'
+        * SYSTEM_STARTED = 'system_event.system_started'
+        * SYSTEM_EXITING = 'system_event.system_will_exit'
     """
     SYSTEM_STARTED = 'system_event.system_started'
-
-    def __repr__(self):
-        return self.value
-
-    def __str__(self):
-        return self.value
+    SYSTEM_EXITING = 'system_event.system_will_exit'

finchan/exts/timer_callback.py

@@ -21,6 +21,12 @@
 from finchan.env import env
 from finchan.event import SysEvents
 
+# name of the extension
+ext_name = 'finchan.exts.timer_callback'
+# required extension
+required_exts = ['finchan.exts.timer_source']
+
+logger = logging.getLogger(__name__)
 
 logger = logging.getLogger()
 
@@ -39,7 +45,7 @@ def add_timer(event):
 
 
 def load_finchan_ext(env, process_time=3, *args, **kwargs):
-    env.dispatcher.subscribe(str(SysEvents.SYSTEM_STARTED), add_timer)
+    env.dispatcher.subscribe(SysEvents.SYSTEM_STARTED, add_timer)
 
 def unload_finchan_ext(env):
     scheduler = env.get_ext_obj('finchan.exts.timer_source')

finchan/exts/timer_source.py

@@ -14,7 +14,25 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-"""Timer event source, interface inspired by `schedule <https://github.com/dbader/schedule>`_"""
+"""Timer event source, interface inspired by `schedule <https://github.com/dbader/schedule>`_
+
+usage::
+
+    def setup()
+        scheduler = env.get_ext_obj('finchan.exts.timer_source')
+        scheduler.run_every(3).to(5).minutes().do(timer_call)
+        scheduler.run_every(1).days.offset('09:31').tag('daily_task').do(timer_call)
+        # runs on every two weeks' friday 09:31
+        scheduler.run_every(2).weeks.offset('friday 09:31').tag('daily_task').do(timer_call)
+        # runs on every month's 09 day 09:31
+        scheduler.run_every(1).months.offset('09 09:31').tag('daily_task').do(timer_call)
+
+
+    def clean()
+        scheduler = env.get_ext_obj('finchan.exts.timer_source')
+        scheduler.cancel_all_jobs()
+
+"""
 import random
 import asyncio
 import logging
@@ -28,8 +46,12 @@
 from finchan.interface.event_source import AbsEventSource
 
 
-logger = logging.getLogger(__name__)
+# name of the extension
 ext_name = 'finchan.exts.timer_source'
+# required extension
+required_exts = []
+
+logger = logging.getLogger(__name__)
 
 
 def event_callback(event):