Source code for application.controller.controller

# Copyright 2017 SrMouraSilva
#
# 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.

from abc import ABCMeta, abstractmethod


class Controller(metaclass=ABCMeta):
    """
    Abstract class for Application controllers.

    Extends to offer functionalities for this API. Remember to manually register
    the extended class in :class:`Application` (in private ``_load_controllers``
    method)

    :param Application application: :class:`Application` instance
    """
    def __init__(self, application):
        self.app = application

    @abstractmethod
    def configure(self):
        """
        The `configure` method is called by :class:`Application` for initialize this object
        """
        pass

    def close(self):
        """
        The `close` method is called by :class:`Application` when application termination is requested
        """
        pass