mirror of
https://github.com/acatoire/bipbipzizik.git
synced 2026-03-10 08:01:18 +00:00
152 lines
4.0 KiB
Python
152 lines
4.0 KiB
Python
"""
|
|
Bip bip object class
|
|
"""
|
|
import logging
|
|
import time
|
|
|
|
logger = logging.getLogger("bipbip")
|
|
|
|
|
|
class BipBip:
|
|
"""
|
|
The generic bipbip class
|
|
"""
|
|
|
|
def __init__(self, parameters: dict, player_name: str, multi_read_timeout: int or float = 3):
|
|
"""
|
|
:param parameters: Parameter dict, each BipBip can implement its own parameters
|
|
Generic parameters are:
|
|
name: The BipBip (card) Name
|
|
ids: list of ids that will run this BipBip
|
|
comment: BipBip comment
|
|
mode:
|
|
action: type of action to be executed
|
|
data: extra data related to the action
|
|
user: allowed user for the card
|
|
:param multi_read_timeout: (optional) Value to consider a multi read, default 3s
|
|
"""
|
|
self.player = None
|
|
self.parameters = parameters
|
|
self.player_name = player_name
|
|
self.multi_read_timeout = multi_read_timeout
|
|
self._execution_log = []
|
|
|
|
self.locked = False
|
|
|
|
def _parameter(self, param_name: str) -> str or None:
|
|
try:
|
|
return self.parameters[param_name]
|
|
except KeyError:
|
|
logger.error("The bipbip object doesn't have any parameter named %s.", param_name)
|
|
return None
|
|
|
|
@property
|
|
def name(self) -> str or None:
|
|
"""
|
|
Name of the bipbip
|
|
:return:
|
|
"""
|
|
return self._parameter("name")
|
|
|
|
@property
|
|
def ids(self) -> list[str] or None:
|
|
"""
|
|
Ids of the bipbip
|
|
:return:
|
|
"""
|
|
return self._parameter("ids")
|
|
|
|
@property
|
|
def comment(self) -> str or None:
|
|
"""
|
|
Comment of the bipbip
|
|
:return:
|
|
"""
|
|
return self._parameter("comment")
|
|
|
|
@property
|
|
def mode(self) -> str or list[str] or None:
|
|
"""
|
|
Mode of the bipbip
|
|
:return:
|
|
"""
|
|
return self._parameter("mode")
|
|
|
|
@property
|
|
def action(self) -> str or None:
|
|
"""
|
|
Action of the bipbip
|
|
:return:
|
|
"""
|
|
return self._parameter("action")
|
|
|
|
@property
|
|
def data(self) -> str or None:
|
|
"""
|
|
Data of the bipbip
|
|
:return:
|
|
"""
|
|
return self._parameter("data")
|
|
|
|
@property
|
|
def user(self) -> str or None:
|
|
"""
|
|
User of the bipbip
|
|
:return:
|
|
"""
|
|
return self._parameter("user")
|
|
|
|
@property
|
|
def execution_log(self) -> list or None:
|
|
"""
|
|
Execution log of the bipbip
|
|
:return:
|
|
"""
|
|
return self._execution_log
|
|
|
|
def check(self):
|
|
"""
|
|
Check of the bipbip status
|
|
:return:
|
|
"""
|
|
logger.info("Playing: %s", self.name)
|
|
|
|
def execute(self):
|
|
"""
|
|
Execute of the bipbip
|
|
:return:
|
|
"""
|
|
execution_time = time.time()
|
|
|
|
if len(self.execution_log) > 0:
|
|
last_time_period = (execution_time - self.execution_log[-1])
|
|
if last_time_period < self.multi_read_timeout:
|
|
self.locked = True
|
|
else:
|
|
self.locked = False
|
|
|
|
####################################################
|
|
# ## Cancel conditions
|
|
####################################################
|
|
if self.locked and "-cmd" not in self.action:
|
|
logger.warning("Action canceled because of the %ds multi read protection.",
|
|
self.multi_read_timeout)
|
|
return
|
|
|
|
####################################################
|
|
# ## Execution
|
|
####################################################
|
|
self._execution_log.append(execution_time)
|
|
self.check()
|
|
logger.info("Execute the bipbip: %s", self.name)
|
|
self.start()
|
|
|
|
def start(self):
|
|
"""
|
|
Action of the bipbip to be overwritten by the child class
|
|
:return:
|
|
"""
|
|
|
|
logger.info("ACTION (%s) To be overwritten by player implementation",
|
|
self.action)
|