2015-08-18 16:29:56 +00:00
|
|
|
# Copyright 2015 Canonical, Ltd.
|
|
|
|
#
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU Affero General Public License as
|
|
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
|
|
# License, or (at your option) any later version.
|
|
|
|
#
|
|
|
|
# This program is distributed in the hope that it will be useful,
|
|
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
# GNU Affero General Public License for more details.
|
|
|
|
#
|
|
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
2020-07-31 00:14:51 +00:00
|
|
|
from abc import ABC
|
2015-08-18 16:29:56 +00:00
|
|
|
import logging
|
|
|
|
|
2016-06-30 18:17:01 +00:00
|
|
|
log = logging.getLogger("subiquitycore.controller")
|
2015-08-18 16:29:56 +00:00
|
|
|
|
|
|
|
|
2016-11-01 23:44:04 +00:00
|
|
|
class BaseController(ABC):
|
2016-07-26 02:16:46 +00:00
|
|
|
"""Base class for controllers."""
|
2015-08-18 16:29:56 +00:00
|
|
|
|
2019-12-17 02:05:17 +00:00
|
|
|
model_name = None
|
2016-10-10 23:48:28 +00:00
|
|
|
|
2019-08-06 02:11:57 +00:00
|
|
|
def __init__(self, app):
|
2019-11-18 00:55:43 +00:00
|
|
|
self.name = type(self).__name__[:-len("Controller")]
|
2019-08-06 02:11:57 +00:00
|
|
|
self.opts = app.opts
|
2019-08-06 02:41:58 +00:00
|
|
|
self.app = app
|
2019-12-19 10:23:43 +00:00
|
|
|
self.context = self.app.context.child(self.name, childlevel="DEBUG")
|
2019-12-17 02:05:17 +00:00
|
|
|
if self.model_name is not None:
|
|
|
|
self.model = getattr(self.app.base_model, self.model_name)
|
2015-08-18 16:29:56 +00:00
|
|
|
|
2019-03-07 02:31:39 +00:00
|
|
|
def start(self):
|
2019-09-03 01:04:47 +00:00
|
|
|
"""Called just before the main loop is started.
|
|
|
|
|
|
|
|
At the time this is called, all controllers and models and so on
|
|
|
|
have been created. This is when the controller should start
|
|
|
|
interacting with the outside world, e.g. probing for network
|
|
|
|
devices or start making connections to the snap store.
|
|
|
|
"""
|
2019-03-07 02:31:39 +00:00
|
|
|
pass
|
|
|
|
|
2019-03-06 02:52:13 +00:00
|
|
|
def serialize(self):
|
|
|
|
return None
|
|
|
|
|
|
|
|
def deserialize(self, data):
|
|
|
|
if data is not None:
|
|
|
|
raise Exception("missing deserialize method on {}".format(self))
|