remove version specific Gentoo ebuild

.gitignore

@@ -117,6 +117,3 @@ dmypy.json
 
 # Temporary Vim files
 .*.swp
-
-# config file
-/config.py

README.md

@@ -1,5 +1,5 @@
 # pyinotifyd
-A daemon to monitor filesystems events with inotify on Linux and run tasks like filesystem operations (copy, move or delete), a shell command or custom async python methods.  
+A daemon for monitoring filesystem events with inotify on Linux and run tasks like filesystem operations (copy, move or delete), a shell command or custom async python methods.  
 
 It is possible to schedule tasks with a delay, which can then be canceled again in case a canceling event occurs. A useful example for this is to run tasks only if a file has not changed within a certain amount of time.  
 
@@ -49,7 +49,7 @@ The basic idea is to instantiate one or multiple schedulers and map specific ino
 pyinotifyd has different schedulers to schedule tasks with an optional delay. The advantages of using a scheduler are consistent logging and the possibility to cancel delayed tasks. Furthermore, schedulers have the ability to differentiate between files and directories.
 
 ### TaskScheduler
-Schedule a custom python method *job* with an optional *delay* in seconds. Skip scheduling of tasks for files and/or directories according to *files* and *dirs* arguments. If there already is a scheduled task, re-schedule it with *delay*. Use *logname* in log messages.  
+Schedule a custom python method *job* with an optional *delay* in seconds. Skip scheduling of tasks for files and/or directories according to *files* and *dirs* arguments. If there already is a scheduled task, re-schedule it with *delay*. Use *logname* in log messages. All additional modules, functions and variables that are defined in the config file and are needed within the *job*, need to be passed as dictionary to the TaskManager through *global_vars*. If you want to limit the scheduler to run only one job at a time, set *singlejob* to True.  
 All arguments except for *job* are optional.
 ```python
 # Please note that pyinotifyd uses pythons asyncio for asynchronous task execution.
@@ -58,6 +58,9 @@ All arguments except for *job* are optional.
 # Bad:  time.sleep(10)
 # Good: await asyncio.sleep(10)
 
+import asyncio
+import logging
+
 async def custom_job(event, task_id):
     await asyncio.sleep(10)
     logging.info(f"{task_id}: execute example task: {event}")
@@ -67,13 +70,16 @@ task_sched = TaskScheduler(
     files=True,
     dirs=False,
     delay=0,
-    logname="sched")
+    logname="sched",
+    global_vars=globals(),
+    singlejob=False)
 ```
 
 ### ShellScheduler
 Schedule a shell command *cmd*. Replace  **{maskname}**, **{pathname}** and **{src_pathname}** in *cmd* with the actual values of occuring events. This scheduler is based on TaskScheduler and has the same optional arguments.
 ```python
-# Please note that **{src_pathname}** is only present for IN_MOVED_TO events and only in the case where the IN_MOVED_FROM events are watched too.
+# Please note that **{src_pathname}** is only present for IN_MOVED_TO events and only
+# in the case where the IN_MOVED_FROM events are watched too.
 # If it is not present, the command line argument will be an empty string.
 shell_sched = ShellScheduler(
     cmd="/usr/local/bin/task.sh {maskname} {pathname} {src_pathname}")
@@ -129,7 +135,7 @@ event_map = {
     "IN_Q_OVERFLOW": None,
     "IN_UNMOUNT": Cancel(task_sched)}
 
-# It is possible to instantiate an event map with a default scheduler set for every event,
+# It is possible to instantiate an event map with a default scheduler set for every event
 event_map = EventMap(default_sched=task_sched)
 ```
 The following events are available:
@@ -209,6 +215,8 @@ enableSyslog(lglevel=INFO, name="daemon")
 
 ## Schedule python method for all events on files and directories
 ```python
+import logging
+
 async def custom_job(event, task_id):
     logging.info(f"{task_id}: execute example task: {event}")
 

distribution/gentoo/dev-python/pyinotifyd/pyinotifyd-0.0.4.ebuild

@@ -1,47 +0,0 @@
-# Copyright 2020 Gentoo Authors
-# Distributed under the terms of the GNU General Public License v2
-
-EAPI=7
-PYTHON_COMPAT=( python3_{7,8,9} )
-DISTUTILS_USE_SETUPTOOLS=rdepend
-
-SCM=""
-if [ "${PV#9999}" != "${PV}" ] ; then
-	SCM="git-r3"
-	EGIT_REPO_URI="https://github.com/spacefreak86/${PN}"
-fi
-
-inherit ${SCM} distutils-r1 systemd
-
-DESCRIPTION="Monitore filesystems events and execute Python methods or Shell commands."
-HOMEPAGE="https://github.com/spacefreak86/pymodmilter"
-if [ "${PV#9999}" != "${PV}" ] ; then
-	SRC_URI=""
-	KEYWORDS=""
-	# Needed for tests
-	S="${WORKDIR}/${PN}"
-	EGIT_CHECKOUT_DIR="${S}"
-else
-	SRC_URI="https://github.com/spacefreak86/${PN}/archive/${PV}.tar.gz -> ${P}.tar.gz"
-	KEYWORDS="amd64 x86"
-fi
-
-LICENSE="GPL-3"
-SLOT="0"
-
-IUSE="systemd"
-
-RDEPEND="dev-python/pyinotify[${PYTHON_USEDEP}]"
-
-python_install_all() {
-	distutils-r1_python_install_all
-
-	dodir /etc/${PN}
-	insinto /etc/${PN}
-	newins ${PN}/misc/config.py.default config.py
-
-	use systemd && systemd_dounit ${PN}/misc/${PN}.service
-
-	newinitd ${PN}/misc/openrc/${PN}.initd ${PN}
-	newconfd ${PN}/misc/openrc/${PN}.confd ${PN}
-}

distribution/gentoo/dev-python/pyinotifyd/pyinotifyd-9999.ebuild

@@ -2,7 +2,7 @@
 # Distributed under the terms of the GNU General Public License v2
 
 EAPI=7
-PYTHON_COMPAT=( python3_{7,8,9} )
+PYTHON_COMPAT=( python3_{8..10} )
 DISTUTILS_USE_SETUPTOOLS=rdepend
 
 SCM=""

distribution/pypi/build.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 set -e
-
+set -x
 PYTHON=$(which python)
 
 script_dir=$(dirname "$(readlink -f -- "$BASH_SOURCE")")

distribution/pypi/distribute.sh

@@ -7,6 +7,7 @@ script_dir=$(dirname "$(readlink -f -- "$BASH_SOURCE")")
 pkg_dir=$(realpath "${script_dir}/../..")
 
 cd "${pkg_dir}/dist"
+ls -la
 msg="Select version to distribute (cancel with CTRL+C):"
 echo "${msg}"
 select version in $(find . -maxdepth 1 -type f -name "pyinotifyd-*.*.*.tar.gz" -printf "%f\n" | sed "s#\.tar\.gz##g"); do

pyinotifyd/__init__.py

@@ -36,7 +36,7 @@ from pyinotify import ProcessEvent
 from pyinotifyd._install import install, uninstall
 from pyinotifyd.scheduler import TaskScheduler, Cancel
 
-__version__ = "0.0.4"
+__version__ = "0.0.7"
 
 
 def setLoglevel(loglevel, logname=None):
@@ -203,12 +203,12 @@ class Pyinotifyd:
         config = {}
         name = Pyinotifyd.name
         exec("from logging import DEBUG, INFO, WARNING, ERROR, CRITICAL",
-             {}, config)
+            config)
-        exec(f"from {name} import Pyinotifyd, Watch", {}, config)
+        exec(f"from {name} import Pyinotifyd, Watch", config)
-        exec(f"from {name} import setLoglevel, enableSyslog", {}, config)
+        exec(f"from {name} import setLoglevel, enableSyslog", config)
-        exec(f"from {name}.scheduler import *", {}, config)
+        exec(f"from {name}.scheduler import *", config)
         with open(config_file, "r") as fh:
-            exec(fh.read(), {}, config)
+            exec(fh.read(), config)
         instance = config[f"{name}"]
         assert isinstance(instance, Pyinotifyd), \
             f"{name}: expected {type(Pyinotifyd)}, " \
@@ -436,15 +436,14 @@ def main():
     ch.setFormatter(formatter)
 
     loop = asyncio.get_event_loop()
-    for signame in ["SIGINT", "SIGTERM"]:
     loop.add_signal_handler(
-            getattr(signal, signame),
+        signal.SIGTERM, lambda: loop.create_task(
-            lambda: loop.create_task(
+            daemon.shutdown("SIGTERM")))
-                daemon.shutdown(signame)))
-
     loop.add_signal_handler(
-        getattr(signal, "SIGHUP"),
+        signal.SIGINT, lambda: loop.create_task(
-        lambda: loop.create_task(
+            daemon.shutdown("SIGINT")))
+    loop.add_signal_handler(
+        signal.SIGHUP, lambda: loop.create_task(
             daemon.reload("SIGHUP", args.config, args.debug)))
 
     daemon.start()

pyinotifyd/_install.py

@@ -21,14 +21,19 @@ import shutil
 import sys
 
 
-SYSTEMD_PATH = "/lib/systemd/system"
+SYSTEMD_PATHS = ["/lib/systemd/system", "/usr/lib/systemd/system"]
+
 OPENRC = "/sbin/openrc"
 
 
 def _systemd_files(pkg_dir, name):
+    for path in SYSTEMD_PATHS:
+        if os.path.isdir(path):
+            break
+
     return [
         (f"{pkg_dir}/misc/systemd/{name}.service",
-            f"{SYSTEMD_PATH}/{name}.service", True)]
+            f"{path}/{name}.service", True)]
 
 
 def _openrc_files(pkg_dir, name):
@@ -113,7 +118,11 @@ def _check_root():
 
 
 def _check_systemd():
-    systemd = os.path.isdir(SYSTEMD_PATH)
+    for path in SYSTEMD_PATHS:
+        systemd = os.path.isdir(path)
+        if systemd:
+            break
+
     if systemd:
         logging.info("systemd detected")
 

pyinotifyd/misc/config.py.default

@@ -2,14 +2,20 @@
 #  TaskScheduler config  #
 ##########################
 
+#import asyncio
+#import logging
+#
 #async def custom_job(event, task_id):
+#    await asyncio.sleep(1)
 #    logging.info(f"{task_id}: execute example task: {event}")
 #
 #task_sched = TaskScheduler(
 #    job=custom_job,
 #    files=True,
 #    dirs=False,
-#    delay=10)
+#    delay=10,
+#    global_vars=globals(),
+#    singlejob=False)
 
 
 ###########################
@@ -20,7 +26,8 @@
 #    cmd="/usr/local/bin/task.sh {maskname} {pathname} {src_pathname}",
 #    files=True,
 #    dirs=False,
-#    delay=10)
+#    delay=10,
+#    singlejob=False)
 
 
 #################################

pyinotifyd/misc/openrc/pyinotifyd.initd

@@ -13,11 +13,6 @@ retry="SIGTERM/${shutdown_timeout}"
 
 extra_commands="configtest reload"
 
-depend() {
-	need net
-	before mta
-}
-
 checkconfig() {
 	output=$(${command} ${command_args} -t 2>&1)
 	ret=$?

pyinotifyd/scheduler.py

@@ -25,7 +25,6 @@ import os
 import re
 import shutil
 
-from dataclasses import dataclass
 from inspect import iscoroutinefunction
 from shlex import quote as shell_quote
 from uuid import uuid4
@@ -46,14 +45,14 @@ class SchedulerLogger(logging.LoggerAdapter):
 
 class TaskScheduler:
 
-    @dataclass
     class TaskState:
-        id: str = str(uuid4())
+        def __init__(self, task_id=None, task=None, cancelable=True):
-        task: asyncio.Task = None
+            self.id = task_id or str(uuid4())
-        cancelable: bool = True
+            self.task = task
+            self.cancelable = cancelable
 
     def __init__(self, job, files=True, dirs=False, delay=0, logname="sched",
-                 loop=None):
+                 loop=None, global_vars={}, singlejob=False):
         assert iscoroutinefunction(job), \
             f"job: expected coroutine, got {type(job)}"
         assert isinstance(files, bool), \
@@ -62,6 +61,8 @@ class TaskScheduler:
             f"dirs: expected {type(bool)}, got {type(dirs)}"
         assert isinstance(delay, int), \
             f"delay: expected {type(int)}, got {type(delay)}"
+        assert isinstance(global_vars, dict), \
+            f"global_vars: expected {type(dict)}, got {type(global_vars)}"
 
         self._job = job
         self._files = files
@@ -69,7 +70,8 @@ class TaskScheduler:
         self._delay = delay
         self._log = logging.getLogger((logname or __name__))
         self._loop = (loop or asyncio.get_event_loop())
-
+        self._globals = global_vars
+        self._singlejob = singlejob
         self._tasks = {}
         self._pause = False
 
@@ -104,6 +106,9 @@ class TaskScheduler:
             else:
                 self._log.info("all remainig tasks completed")
 
+    def taskindex(self, event):
+        return "singlejob" if self._singlejob else event.pathname
+
     async def _run_job(self, event, task_state, restart=False):
         logger = SchedulerLogger(self._log, {
             "event": event,
@@ -111,7 +116,7 @@ class TaskScheduler:
 
         if self._delay > 0:
             task_state.task = self._loop.create_task(
-                asyncio.sleep(self._delay, loop=self._loop))
+                asyncio.sleep(self._delay))
             try:
                 if restart:
                     prefix = "re-"
@@ -125,7 +130,14 @@ class TaskScheduler:
                 return
 
         logger.info("start task")
+        if self._globals:
+            local_vars = {"self": self,
+                          "event": event,
+                          "task_id": task_state.id}
+            task_state.task = self._loop.create_task(
+                eval("self._job(event, task_id)", self._globals, local_vars))
 
+        else:
             task_state.task = self._loop.create_task(
                 self._job(event, task_state.id))
 
@@ -135,9 +147,10 @@ class TaskScheduler:
         except asyncio.CancelledError:
             logger.warning("ongoing task cancelled")
         else:
-            self._log.info("task finished")
+            logger.info("task finished")
         finally:
-            del self._tasks[event.pathname]
+            task_index = self.taskindex(event)
+            del self._tasks[task_index]
 
     async def process_event(self, event):
         if not ((not event.dir and self._files) or
@@ -145,9 +158,13 @@ class TaskScheduler:
             return
 
         restart = False
+        task_index = self.taskindex(event)
         try:
-            task_state = self._tasks[event.pathname]
+            task_state = self._tasks[task_index]
-
+        except KeyError:
+            task_state = TaskScheduler.TaskState()
+            self._tasks[task_index] = task_state
+        else:
             logger = SchedulerLogger(self._log, {
                 "event": event,
                 "id": task_state.id})
@@ -163,16 +180,13 @@ class TaskScheduler:
                 logger.warning("skip event due to ongoing task")
                 return
 
-        except KeyError:
-            task_state = TaskScheduler.TaskState()
-            self._tasks[event.pathname] = task_state
-
         if not self._pause:
             await self._run_job(event, task_state, restart)
 
     async def process_cancel_event(self, event):
         try:
-            task_state = self._tasks[event.pathname]
+            task_index = self.taskindex(event)
+            task_state = self._tasks[task_index]
         except KeyError:
             return
 
@@ -184,7 +198,8 @@ class TaskScheduler:
             task_state.task.cancel()
             logger.info("scheduled task cancelled")
             task_state.task = None
-            del self._tasks[event.pathname]
+            logger.info(f"{task_index}")
+            del self._tasks[task_index]
         else:
             logger.warning("skip event due to ongoing task")
 
@@ -277,7 +292,8 @@ class FileManagerRule:
 
 class FileManagerScheduler(TaskScheduler):
     def __init__(self, rules, job=None, *args, **kwargs):
-        super().__init__(*args, **kwargs, job=self._manager_job)
+        super().__init__(
+            *args, **kwargs, job=self._manager_job, singlejob=False)
 
         if not isinstance(rules, list):
             rules = [rules]

setup.py

@@ -18,7 +18,7 @@ setup(name = "pyinotifyd",
         #   3 - Alpha
         #   4 - Beta
         #   5 - Production/Stable
-        "Development Status :: 3 - Alpha",
+        "Development Status :: 5 - Production/Stable",
         "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
         "Operating System :: OS Independent",
         "Programming Language :: Python",

test-pyinotifyd

@@ -1,9 +0,0 @@
-#!/usr/bin/env python
-
-import sys
-import pyinotifyd
-
-if __name__ == '__main__':
-    sys.exit(
-        pyinotifyd.main()
-    )