scoring.py

"""
This module contains functions for calculating scores for different types of
activities. Each function takes a list as a parameter and computes the score
based on that. The score is returned wrapped into a score object, which has a
type "good" (hyvinvointi) or "bad" (pahoinvointi) and a numeric value.
"""
from math import sqrt


GOOD_KEY = "good"
BAD_KEY = "bad"

class ScoreObject():

  def __init__(self, value, _type, hist):
    """
    hist is the history based on which the value has been calculated
    """
    assert _type in [GOOD_KEY, BAD_KEY]
    value = float(value)
    assert value >= 0.0
    self.type = _type
    self.value = value
    self.history = hist

  def __repr__(self):
    return "{}({})".format(self.__class__, self.__dict__)


def liikunta_score(history):
  # history = ['Liikunta', intensity, duration]
  assert type(history) == list
  duration = min(history[2], 5)
  #print("liikunta_score(): {}".format(history))
  score = 3*sqrt(history[1]*duration)/sqrt(6)

  return ScoreObject(score, GOOD_KEY, history)

########################
# VALIDATION FUNCTIONS #
########################

def validate_number(number_str, a, b):
  """
  return float(number_str) if number_str is a number and is in the range [a, b],
  otherwise return None
  """
  try:
    n = float(number_str)
    if a <= n <= b:
      return n
    else: return None

  except ValueError:
    return None

def liikunta_validate_intensity(intensity_str):
  return validate_number(intensity_str, 0, 5)

def liikunta_validate_duration(duration_str):
  return validate_number(duration_str, 0, 12)