Merge pull request #9 from leagueutils/fix/no-error-handling-on-stop

Fix/no error handling on stop

Author: lukasthaler

CHANGELOG.md

@@ -3,6 +3,10 @@
 This page contains a fairly detailed, fairly complete, fairly readable summary of what changed with each version of the
 library.
 
+## v1.1.1
+Fixed a behaviour where if a trigger with `iter_args` was stopped by raising `triggers.StopRunning()`, the error handler
+would be invoked.
+
 ## v1.1.0
 This release adds:
 - an execution limit for triggers. By specifying the `max_trigger_count` parameter, a trigger can be instructed to

README.md

@@ -74,7 +74,9 @@ aren't already running.
 
 If you want to conditionally stop the trigger based on something that happens in the decorated function, you can
 simply raise `triggers.StopRunning()` from the function. The trigger will catch that exception, finish processing the
-current iteration of the run and exit gracefully after.
+current iteration of the run and exit gracefully after. If you want to stop the trigger after executing a fixed
+number of times, supply the `max_trigger_count` argument during trigger initialization. The trigger will automatically
+and gracefully exit after performing the desired number of executions.
 
 ### Error Handling
 
@@ -83,7 +85,7 @@ The library offers two ways to deal with error handling:
 - passing a handler function directly to the trigger's `error_handler` parameter. This allows you to specify
   individual error handlers for each repeated task if you need to.
 - designating a global error handler by decorating a function with `on_error()`. This will be used
-  as a fallback by all triggers that don't have a dedicated error handler passed to them during initialisation.
+  as a fallback by all triggers that don't have a dedicated error handler passed to them during initialization.
 
 An error handler function must be defined with `async def` and accept three parameters in the following order:
 
@@ -112,7 +114,7 @@ trigger has been called that amount of times, it will exit. If the parameter is
 indefinitely.
 
 Triggers allow you to specify a list of elements you want the decorated function to be spread over. If you specify
-the `iter_args` parameter when initialising a trigger, it will call the decorated function once for each element of
+the `iter_args` parameter when initializing a trigger, it will call the decorated function once for each element of
 that parameter. Each element will be positionally passed into the function's first argument. If you prefer to keep
 your logic inside the function or load it from somewhere else, simply don't pass the `iter_args` parameter. That will
 let the trigger know not to inject any positional args.
@@ -145,7 +147,7 @@ both the decorator variant and the programmatic application of triggers.
 ### Extending this Library
 
 If you find yourself in need of scheduling logic that none of the included triggers can provide, you can easily
-create a trigger class that fits your needs by importing the `BaseTrigger` from this extension, creating a
+create a trigger class that fits your needs by importing the `BaseTrigger` from this library, creating a
 subclass and overwriting the `next_run`  property. The property needs to return a *timezone-aware*
 `datetime.datetime` object indicating when the trigger should run next based on the current system time. If you
 want to tell the trigger to stop repeating the decorated function and terminate, you can raise `triggers.StopRunning()`

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "triggers"
-version = "1.1.0"
+version = "1.1.1"
 description = ""
 authors = ["lukasthaler <[email protected]>"]
 readme = "README.md"

triggers/__init__.py

@@ -1,6 +1,6 @@
 """A library that provides decorators to facilitate automated, periodic repetition of functions."""
 
-__version__ = '1.1.0'
+__version__ = '1.1.1'
 
 import types
 

triggers/triggers.py

@@ -128,7 +128,7 @@ async def inner():
                             for arg, res in zip(self.iter_args, results):
                                 if isinstance(res, StopRunning):
                                     terminate = True
-                                if isinstance(res, Exception):
+                                elif isinstance(res, Exception):
                                     await self.__handle_exception(func, arg, res)
                             if terminate:
                                 raise StopRunning()