Source code for pyEpiabm.core.household

#
# Household Class
#

import typing
from numbers import Number
import re

from pyEpiabm.property import InfectionStatus




class Household:
    """Class representing a household,
    a group of people (family or otherwise) who live
    together and share living spaces. This group will
    have a combined susceptibility and infectiousness
    different to that of the individuals.
    """
    def __init__(self, microcell, loc: typing.Tuple[float, float],
                 susceptibility=0, infectiousness=0):
        """Constructor Method.

        Parameters
        ----------
        loc : Tuple[float, float]
            Location of household
        susceptibility : float
            Household's base susceptibility to infection events
        infectiousness : float
            Household's base infectiousness

        """
        self.persons = []
        self.susceptible_persons = []
        self.location = loc
        self.susceptibility = susceptibility
        self.infectiousness = infectiousness
        self.cell = microcell.cell
        self.microcell = microcell
        self.isolation_location = False
        self.id = self.microcell.id + "." + str(len(self.microcell.households))

        if not (len(loc) == 2 and isinstance(loc[0], Number) and
                isinstance(loc[1], Number)):
            raise ValueError("Location must be a tuple of float-type")

        microcell.households.append(self)
        microcell.cell.households.append(self)

    def __repr__(self):
        """Returns a string representation of Household.

        Returns
        -------
        str
            String representation of the household

        """
        return f"Household ({self.id}) at " \
            + f"({self.location[0]:.2f}, {self.location[1]:.2f}) "\
            + f"with {len(self.persons)} people."



    def add_person(self, person):
        """Adds a person to this household.

        Parameters
        ----------
        person : Person
            Person to be added

        """
        self.persons.append(person)
        person.household = self
        if person.infection_status == InfectionStatus.Susceptible:
            self.add_susceptible_person(person)




    def add_susceptible_person(self, susceptible_person):
        """Adds a person to the list of susceptible people in the household.

        Parameters
        ----------
        susceptible_person : Person
            Person to be added

        """
        if susceptible_person not in self.susceptible_persons:
            self.susceptible_persons.append(susceptible_person)




    def remove_susceptible_person(self, non_susceptible_person):
        """Removes a susceptible person from the list of susceptible people
        in the household.

        Parameters
        ----------
        non_susceptible_person : Person
            Person to be removed

        """
        self.susceptible_persons.remove(non_susceptible_person)




    def remove_household(self):
        """Method to remove Household object from population.
        Used to remove household in which a traveller was hotel
        isolating.

        """
        self.microcell.households.remove(self)
        self.cell.households.remove(self)




    def set_id(self, id: str):
        """Updates id of current household (i.e. for input from file).
        Format of id - for example 3.1.2 represents household 2 within
        microcell 1 within cell 3. The id will only be changed if it has the
        correct expression.

        Parameters
        ----------
        id : str
            Identity of household

        """

        # Ensure id is a string
        if not isinstance(id, str):
            raise TypeError("Provided id must be a string")

        # This regex will match on any string which takes the form "i.j.k"
        # where i, j and k are integers
        if not re.match("^-?\\d+\\.-?\\d+\\.-?\\d+$", id):
            raise ValueError(f"Invalid id: {id}. id must be of the form "
                             f"'i.j.k' where i, j, k are integers")

        # Finally, check for duplicates
        household_ids = [household.id
                         for household in self.microcell.households]
        if id in household_ids:
            raise ValueError(f"Duplicate id: {id}.")

        self.id = id