diff --git a/bin/platypush b/bin/platypush index 2a17eefa83..2661c30c4d 100755 --- a/bin/platypush +++ b/bin/platypush @@ -1,9 +1,13 @@ #!python3 -from platypush import main +import sys + +from platypush.app import Application + if __name__ == '__main__': - main() + app = Application.build(*sys.argv[1:]) + app.run() # vim:sw=4:ts=4:et: diff --git a/platypush/__init__.py b/platypush/__init__.py index c87313751d..f4e9ecb921 100644 --- a/platypush/__init__.py +++ b/platypush/__init__.py @@ -5,291 +5,27 @@ Platypush .. license: MIT """ -import argparse -import logging -import os -import sys -from typing import Optional - -from .bus import Bus -from .bus.redis import RedisBus +from .app import Application, main from .config import Config -from .context import register_backends, register_plugins -from .cron.scheduler import CronScheduler -from .entities import init_entities_engine, EntitiesEngine -from .event.processor import EventProcessor -from .logger import Logger +from .context import get_backend, get_bus, get_plugin from .message.event import Event -from .message.event.application import ApplicationStartedEvent from .message.request import Request from .message.response import Response -from .utils import get_enabled_plugins + __author__ = 'Fabio Manganiello ' __version__ = '0.50.3' - -log = logging.getLogger('platypush') - - -class Daemon: - """Main class for the Platypush daemon""" - - # Default bus queue name - _default_redis_queue = 'platypush/bus' - - # backend_name => backend_obj map - backends = None - - # number of executions retries before a request fails - n_tries = 2 - - def __init__( - self, - config_file=None, - pidfile=None, - requests_to_process=None, - no_capture_stdout=False, - no_capture_stderr=False, - redis_queue=None, - verbose=False, - ): - """ - Constructor - Params: - config_file -- Configuration file override (default: None) - pidfile -- File where platypush will store its PID upon launch, - useful if you're planning to integrate the application - within a service or a launcher script (default: None) - requests_to_process -- Exit after processing the specified number - of requests (default: None, loop forever) - no_capture_stdout -- Set to true if you want to disable the stdout - capture by the logging system - no_capture_stderr -- Set to true if you want to disable the stderr - capture by the logging system - redis_queue -- Name of the (Redis) queue used for dispatching messages (default: platypush/bus). - verbose -- Enable debug/verbose logging, overriding the stored configuration (default: False). - """ - - self.pidfile = pidfile - if pidfile: - with open(pidfile, 'w') as f: - f.write(str(os.getpid())) - - self.bus: Optional[Bus] = None - self.redis_queue = redis_queue or self._default_redis_queue - self.config_file = config_file - self._verbose = verbose - Config.init(self.config_file) - - self.no_capture_stdout = no_capture_stdout - self.no_capture_stderr = no_capture_stderr - self.event_processor = EventProcessor() - self.entities_engine: Optional[EntitiesEngine] = None - self.requests_to_process = requests_to_process - self.processed_requests = 0 - self.cron_scheduler = None - - self._init_bus() - self._init_logging() - - def _init_bus(self): - redis_conf = Config.get('backend.redis') or {} - self.bus = RedisBus( - redis_queue=self.redis_queue, - on_message=self.on_message(), - **redis_conf.get('redis_args', {}) - ) - - def _init_logging(self): - logging_conf = Config.get('logging') or {} - if self._verbose: - logging_conf['level'] = logging.DEBUG - logging.basicConfig(**logging_conf) - - @classmethod - def build_from_cmdline(cls, args): - """ - Build the app from command line arguments. - Params: - args -- Your sys.argv[1:] [List of strings] - """ - parser = argparse.ArgumentParser() - parser.add_argument( - '--config', - '-c', - dest='config', - required=False, - default=None, - help='Custom location for the configuration file', - ) - parser.add_argument( - '--version', - dest='version', - required=False, - action='store_true', - help="Print the current version and exit", - ) - parser.add_argument( - '--verbose', - '-v', - dest='verbose', - required=False, - action='store_true', - help="Enable verbose/debug logging", - ) - parser.add_argument( - '--pidfile', - '-P', - dest='pidfile', - required=False, - default=None, - help="File where platypush will " - + "store its PID, useful if you're planning to " - + "integrate it in a service", - ) - parser.add_argument( - '--no-capture-stdout', - dest='no_capture_stdout', - required=False, - action='store_true', - help="Set this flag if you have max stack depth " - + "exceeded errors so stdout won't be captured by " - + "the logging system", - ) - parser.add_argument( - '--no-capture-stderr', - dest='no_capture_stderr', - required=False, - action='store_true', - help="Set this flag if you have max stack depth " - + "exceeded errors so stderr won't be captured by " - + "the logging system", - ) - parser.add_argument( - '--redis-queue', - dest='redis_queue', - required=False, - default=cls._default_redis_queue, - help="Name of the Redis queue to be used to internally deliver messages " - "(default: platypush/bus)", - ) - - opts, args = parser.parse_known_args(args) - - if opts.version: - print(__version__) - sys.exit(0) - - return cls( - config_file=opts.config, - pidfile=opts.pidfile, - no_capture_stdout=opts.no_capture_stdout, - no_capture_stderr=opts.no_capture_stderr, - redis_queue=opts.redis_queue, - verbose=opts.verbose, - ) - - def on_message(self): - """ - Default message handler - """ - - def _f(msg): - """ - on_message closure - Params: - msg -- platypush.message.Message instance - """ - - if isinstance(msg, Request): - try: - msg.execute(n_tries=self.n_tries) - except PermissionError: - log.info('Dropped unauthorized request: %s', msg) - - self.processed_requests += 1 - if ( - self.requests_to_process - and self.processed_requests >= self.requests_to_process - ): - self.stop_app() - elif isinstance(msg, Response): - msg.log() - elif isinstance(msg, Event): - msg.log() - self.event_processor.process_event(msg) - - return _f - - def stop_app(self): - """Stops the backends and the bus""" - from .plugins import RunnablePlugin - - if self.backends: - for backend in self.backends.values(): - backend.stop() - - for plugin in get_enabled_plugins().values(): - if isinstance(plugin, RunnablePlugin): - plugin.stop() - - if self.bus: - self.bus.stop() - self.bus = None - - if self.cron_scheduler: - self.cron_scheduler.stop() - self.cron_scheduler = None - - if self.entities_engine: - self.entities_engine.stop() - self.entities_engine = None - - def run(self): - """Start the daemon""" - if not self.no_capture_stdout: - sys.stdout = Logger(log.info) - if not self.no_capture_stderr: - sys.stderr = Logger(log.warning) - - log.info('---- Starting platypush v.%s', __version__) - - # Initialize the backends and link them to the bus - self.backends = register_backends(bus=self.bus, global_scope=True) - - # Start the backend threads - for backend in self.backends.values(): - backend.start() - - # Initialize the plugins - register_plugins(bus=self.bus) - - # Initialize the entities engine - self.entities_engine = init_entities_engine() - - # Start the cron scheduler - if Config.get_cronjobs(): - self.cron_scheduler = CronScheduler(jobs=Config.get_cronjobs()) - self.cron_scheduler.start() - - assert self.bus, 'The bus is not running' - self.bus.post(ApplicationStartedEvent()) - - # Poll for messages on the bus - try: - self.bus.poll() - except KeyboardInterrupt: - log.info('SIGINT received, terminating application') - finally: - self.stop_app() - - -def main(): - """ - Platypush daemon main - """ - app = Daemon.build_from_cmdline(sys.argv[1:]) - app.run() +__all__ = [ + 'Application', + 'Config', + 'Event', + 'Request', + 'Response', + 'get_backend', + 'get_bus', + 'get_plugin', + 'main', +] # vim:sw=4:ts=4:et: diff --git a/platypush/__main__.py b/platypush/__main__.py index 194177922e..2b4e690896 100644 --- a/platypush/__main__.py +++ b/platypush/__main__.py @@ -1,5 +1,10 @@ -from platypush import main +import sys + +from platypush.app import main + + +if __name__ == '__main__': + main(*sys.argv[1:]) -main() # vim:sw=4:ts=4:et: diff --git a/platypush/app.py b/platypush/app.py new file mode 100644 index 0000000000..ec1c84cc7b --- /dev/null +++ b/platypush/app.py @@ -0,0 +1,286 @@ +import argparse +import logging +import os +import sys +from typing import Optional + +from .bus import Bus +from .bus.redis import RedisBus +from .config import Config +from .context import register_backends, register_plugins +from .cron.scheduler import CronScheduler +from .entities import init_entities_engine, EntitiesEngine +from .event.processor import EventProcessor +from .logger import Logger +from .message.event import Event +from .message.event.application import ApplicationStartedEvent +from .message.request import Request +from .message.response import Response +from .utils import get_enabled_plugins + +log = logging.getLogger('platypush') + + +class Application: + """Main class for the Platypush application.""" + + # Default bus queue name + _default_redis_queue = 'platypush/bus' + + # backend_name => backend_obj map + backends = None + + # number of executions retries before a request fails + n_tries = 2 + + def __init__( + self, + config_file: Optional[str] = None, + pidfile: Optional[str] = None, + requests_to_process: Optional[int] = None, + no_capture_stdout: bool = False, + no_capture_stderr: bool = False, + redis_queue: Optional[str] = None, + verbose: bool = False, + ): + """ + :param config_file: Configuration file override (default: None). + :param pidfile: File where platypush will store its PID upon launch, + useful if you're planning to integrate the application within a + service or a launcher script (default: None). + :param requests_to_process: Exit after processing the specified + number of requests (default: None, loop forever). + :param no_capture_stdout: Set to true if you want to disable the + stdout capture by the logging system (default: False). + :param no_capture_stderr: Set to true if you want to disable the + stderr capture by the logging system (default: False). + :param redis_queue: Name of the (Redis) queue used for dispatching + messages (default: platypush/bus). + :param verbose: Enable debug/verbose logging, overriding the stored + configuration (default: False). + """ + + self.pidfile = pidfile + if pidfile: + with open(pidfile, 'w') as f: + f.write(str(os.getpid())) + + self.bus: Optional[Bus] = None + self.redis_queue = redis_queue or self._default_redis_queue + self.config_file = config_file + self._verbose = verbose + Config.init(self.config_file) + + self.no_capture_stdout = no_capture_stdout + self.no_capture_stderr = no_capture_stderr + self.event_processor = EventProcessor() + self.entities_engine: Optional[EntitiesEngine] = None + self.requests_to_process = requests_to_process + self.processed_requests = 0 + self.cron_scheduler = None + + self._init_bus() + self._init_logging() + + def _init_bus(self): + redis_conf = Config.get('backend.redis') or {} + self.bus = RedisBus( + redis_queue=self.redis_queue, + on_message=self.on_message(), + **redis_conf.get('redis_args', {}) + ) + + def _init_logging(self): + logging_conf = Config.get('logging') or {} + if self._verbose: + logging_conf['level'] = logging.DEBUG + logging.basicConfig(**logging_conf) + + @classmethod + def build(cls, *args: str): + """ + Build the app from command line arguments. + """ + from . import __version__ + + parser = argparse.ArgumentParser() + parser.add_argument( + '--config', + '-c', + dest='config', + required=False, + default=None, + help='Custom location for the configuration file', + ) + parser.add_argument( + '--version', + dest='version', + required=False, + action='store_true', + help="Print the current version and exit", + ) + parser.add_argument( + '--verbose', + '-v', + dest='verbose', + required=False, + action='store_true', + help="Enable verbose/debug logging", + ) + parser.add_argument( + '--pidfile', + '-P', + dest='pidfile', + required=False, + default=None, + help="File where platypush will " + + "store its PID, useful if you're planning to " + + "integrate it in a service", + ) + parser.add_argument( + '--no-capture-stdout', + dest='no_capture_stdout', + required=False, + action='store_true', + help="Set this flag if you have max stack depth " + + "exceeded errors so stdout won't be captured by " + + "the logging system", + ) + parser.add_argument( + '--no-capture-stderr', + dest='no_capture_stderr', + required=False, + action='store_true', + help="Set this flag if you have max stack depth " + + "exceeded errors so stderr won't be captured by " + + "the logging system", + ) + parser.add_argument( + '--redis-queue', + dest='redis_queue', + required=False, + default=cls._default_redis_queue, + help="Name of the Redis queue to be used to internally deliver messages " + "(default: platypush/bus)", + ) + + opts, _ = parser.parse_known_args(args) + if opts.version: + print(__version__) + sys.exit(0) + + return cls( + config_file=opts.config, + pidfile=opts.pidfile, + no_capture_stdout=opts.no_capture_stdout, + no_capture_stderr=opts.no_capture_stderr, + redis_queue=opts.redis_queue, + verbose=opts.verbose, + ) + + def on_message(self): + """ + Default message handler. + """ + + def _f(msg): + """ + on_message closure + Params: + msg -- platypush.message.Message instance + """ + + if isinstance(msg, Request): + try: + msg.execute(n_tries=self.n_tries) + except PermissionError: + log.info('Dropped unauthorized request: %s', msg) + + self.processed_requests += 1 + if ( + self.requests_to_process + and self.processed_requests >= self.requests_to_process + ): + self.stop_app() + elif isinstance(msg, Response): + msg.log() + elif isinstance(msg, Event): + msg.log() + self.event_processor.process_event(msg) + + return _f + + def stop_app(self): + """Stops the backends and the bus.""" + from .plugins import RunnablePlugin + + if self.backends: + for backend in self.backends.values(): + backend.stop() + + for plugin in get_enabled_plugins().values(): + if isinstance(plugin, RunnablePlugin): + plugin.stop() + + if self.bus: + self.bus.stop() + self.bus = None + + if self.cron_scheduler: + self.cron_scheduler.stop() + self.cron_scheduler = None + + if self.entities_engine: + self.entities_engine.stop() + self.entities_engine = None + + def run(self): + """Start the daemon.""" + from . import __version__ + + if not self.no_capture_stdout: + sys.stdout = Logger(log.info) + if not self.no_capture_stderr: + sys.stderr = Logger(log.warning) + + log.info('---- Starting platypush v.%s', __version__) + + # Initialize the backends and link them to the bus + self.backends = register_backends(bus=self.bus, global_scope=True) + + # Start the backend threads + for backend in self.backends.values(): + backend.start() + + # Initialize the plugins + register_plugins(bus=self.bus) + + # Initialize the entities engine + self.entities_engine = init_entities_engine() + + # Start the cron scheduler + if Config.get_cronjobs(): + self.cron_scheduler = CronScheduler(jobs=Config.get_cronjobs()) + self.cron_scheduler.start() + + assert self.bus, 'The bus is not running' + self.bus.post(ApplicationStartedEvent()) + + # Poll for messages on the bus + try: + self.bus.poll() + except KeyboardInterrupt: + log.info('SIGINT received, terminating application') + finally: + self.stop_app() + + +def main(*args: str): + """ + Application entry point. + """ + app = Application.build(*args) + app.run() + + +# vim:sw=4:ts=4:et: diff --git a/platypush/logger.py b/platypush/logger.py index 7351278580..2d2afb475c 100644 --- a/platypush/logger.py +++ b/platypush/logger.py @@ -21,7 +21,6 @@ class Logger: This function only serves to prevent PyCharm unit tests from failing when the stdout is redirected to the Logger. """ - pass # vim:sw=4:ts=4:et: diff --git a/tests/conftest.py b/tests/conftest.py index 5c31dd0b42..3357f74752 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -5,7 +5,7 @@ from threading import Thread import pytest -from platypush import Daemon, Config +from platypush import Application, Config from .utils import config_file, set_base_url @@ -30,7 +30,7 @@ def app(): logging.info('Starting Platypush test service') Config.init(config_file) - _app = Daemon(config_file=config_file, redis_queue='platypush-tests/bus') + _app = Application(config_file=config_file, redis_queue='platypush-tests/bus') Thread(target=_app.run).start() logging.info( 'Sleeping %d seconds while waiting for the daemon to start up',