viniciuschiele/flask-apscheduler

View on GitHub
flask_apscheduler/api.py

Summary

Maintainability
A
0 mins
Test Coverage
# Copyright 2015 Vinicius Chiele. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# 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.

import logging

from apscheduler.jobstores.base import ConflictingIdError, JobLookupError
from apscheduler.schedulers import SchedulerAlreadyRunningError, SchedulerNotRunningError
from collections import OrderedDict
from flask import current_app, request, Response
from .json import jsonify


def get_scheduler_info():
    """Gets the scheduler info."""

    scheduler = current_app.apscheduler

    d = OrderedDict([
        ("current_host", scheduler.host_name),
        ("allowed_hosts", scheduler.allowed_hosts),
        ("running", scheduler.running)
    ])

    return jsonify(d)


def pause_scheduler():
    """
    Pauses job processing in the scheduler.

    This will prevent the scheduler from waking up to do job processing until :meth:`resume`
    is called. It will not however stop any already running job processing.
    """
    try:
        current_app.apscheduler.pause()
        return Response(status=204)
    except Exception as e:
        return jsonify(dict(error_message=str(e)), status=500)


def resume_scheduler():
    """
    Resumes job processing in the scheduler.
    """

    try:
        current_app.apscheduler.resume()
        return Response(status=204)
    except Exception as e:
        return jsonify(dict(error_message=str(e)), status=500)


def start_scheduler():
    """
    Starts the scheduler.
    """

    try:
        current_app.apscheduler.start()
        return Response(status=204)
    except SchedulerAlreadyRunningError as e:
        return jsonify(dict(error_message=str(e)), status=400)
    except Exception as e:
        return jsonify(dict(error_message=str(e)), status=500)


def shutdown_scheduler():
    """
    Shuts down the scheduler. Does not interrupt any currently running jobs.
    """

    try:
        data = request.get_json(silent=True, force=True) or {}
        wait = data.get("wait") is not False

        current_app.apscheduler.shutdown(wait=wait)
        return Response(status=204)
    except SchedulerNotRunningError as e:
        return jsonify(dict(error_message=str(e)), status=400)
    except Exception as e:
        return jsonify(dict(error_message=str(e)), status=500)


def add_job():
    """Adds a new job."""

    data = request.get_json(force=True)

    try:
        job = current_app.apscheduler.add_job(**data)
        return jsonify(job)
    except ConflictingIdError:
        logging.warning(f"Job {data.get('id')} already exists.")
        return jsonify(dict(error_message=f"Job {data.get('id')} already exists."), status=409)
    except Exception as e:
        logging.error(e, exc_info=True)
        return jsonify(dict(error_message=str(e)), status=500)


def delete_job(job_id):
    """Deletes a job."""

    try:
        current_app.apscheduler.remove_job(job_id)
        return Response(status=204)
    except JobLookupError:
        logging.warning(f"Job {job_id} not found.")
        return jsonify(dict(error_message=f"Job {job_id} not found"), status=404)
    except Exception as e:
        logging.error(e, exc_info=True)
        return jsonify(dict(error_message=str(e)), status=500)


def get_job(job_id):
    """Gets a job."""

    job = current_app.apscheduler.get_job(job_id)

    if not job:
        logging.warning(f"Job {job_id} not found.")
        return jsonify(dict(error_message=f"Job {job_id} not found"), status=404)

    return jsonify(job)


def get_jobs():
    """Gets all scheduled jobs."""

    jobs = current_app.apscheduler.get_jobs()

    job_states = []

    for job in jobs:
        job_states.append(job)

    return jsonify(job_states)


def update_job(job_id):
    """Updates a job."""

    data = request.get_json(force=True)

    try:
        current_app.apscheduler.modify_job(job_id, **data)
        job = current_app.apscheduler.get_job(job_id)
        return jsonify(job)
    except JobLookupError:
        logging.warning(f"Job {job_id} not found.")
        return jsonify(dict(error_message=f"Job {job_id} not found"), status=404)
    except Exception as e:
        logging.error(e, exc_info=True)
        return jsonify(dict(error_message=str(e)), status=500)


def pause_job(job_id):
    """Pauses a job."""

    try:
        current_app.apscheduler.pause_job(job_id)
        job = current_app.apscheduler.get_job(job_id)
        return jsonify(job)
    except JobLookupError:
        logging.warning(f"Job {job_id} not found.")
        return jsonify(dict(error_message=f"Job {job_id} not found"), status=404)
    except Exception as e:
        logging.error(e, exc_info=True)
        return jsonify(dict(error_message=str(e)), status=500)


def resume_job(job_id):
    """Resumes a job."""

    try:
        current_app.apscheduler.resume_job(job_id)
        job = current_app.apscheduler.get_job(job_id)
        return jsonify(job)
    except JobLookupError:
        logging.warning(f"Job {job_id} not found.")
        return jsonify(dict(error_message=f"Job {job_id} not found"), status=404)
    except Exception as e:
        logging.error(e, exc_info=True)
        return jsonify(dict(error_message=str(e)), status=500)


def run_job(job_id):
    """Executes a job."""

    try:
        current_app.apscheduler.run_job(job_id)
        job = current_app.apscheduler.get_job(job_id)
        return jsonify(job)
    except JobLookupError:
        logging.warning(f"Job {job_id} not found.")
        return jsonify(dict(error_message=f"Job {job_id} not found"), status=404)
    except Exception as e:
        logging.error(e, exc_info=True)
        return jsonify(dict(error_message=str(e)), status=500)