def get_calculation_month_lower_bound_date(
calculation_month_upper_bound: datetime.date,
calculation_month_count: int) -> Optional[datetime.date]:
"""Returns the date at the beginning of the first month that should be included in the monthly calculations."""
first_of_last_month = first_day_of_month(calculation_month_upper_bound)
calculation_month_lower_bound = (first_of_last_month - relativedelta(months=(calculation_month_count - 1))) \
if calculation_month_count != -1 else None
return calculation_month_lower_bound
def get_month_supervision_type_default(
any_date_in_month: datetime.date,
supervision_sentences: List[StateSupervisionSentence],
incarceration_sentences: List[StateIncarcerationSentence],
supervision_period: StateSupervisionPeriod
) -> StateSupervisionPeriodSupervisionType:
"""Supervision type can change over time even if the period does not change. This function calculates the
supervision type that a given supervision period represents during the month that |any_date_in_month| falls in. We
do this by looking at all sentences attached to this supervision period, then determining which ones overlap with
any day in the month, and using the sentence supervision types to determine the period supervision type at this
point in time.
Args:
any_date_in_month: (date) Any day in the month to consider
supervision_period: (StateSupervisionPeriod) The supervision period we want to associate a supervision type with
supervision_sentences: (List[StateSupervisionSentence]) All supervision sentences for a given person.
"""
if not supervision_period.supervision_period_id:
raise ValueError('All objects should have database ids.')
if is_placeholder(supervision_period):
raise ValueError('Do not expect placeholder periods!')
start_of_month = first_day_of_month(any_date_in_month)
end_of_month = last_day_of_month(any_date_in_month)
# Find sentences that are attached to the period and overlap with the month
incarceration_sentences = _get_valid_attached_sentences(
incarceration_sentences, supervision_period)
incarceration_sentences = _get_sentences_overlapping_with_dates(
start_of_month, end_of_month, incarceration_sentences)
supervision_sentences = _get_valid_attached_sentences(
supervision_sentences, supervision_period)
supervision_sentences = _get_sentences_overlapping_with_dates(
start_of_month, end_of_month, supervision_sentences)
return get_supervision_type_from_sentences(incarceration_sentences,
supervision_sentences)
def us_mo_get_month_supervision_type(
any_date_in_month: datetime.date,
supervision_sentences: List[StateSupervisionSentence],
incarceration_sentences: List[StateIncarcerationSentence],
supervision_period: StateSupervisionPeriod
) -> StateSupervisionPeriodSupervisionType:
"""Calculates the supervision period supervision type that should be attributed to a US_MO supervision period
on a given month.
The date used to calculate the supervision period supervision type is either the last day of the month, or
the last day of supervision, whichever comes first.
"""
start_of_month = first_day_of_month(any_date_in_month)
end_of_month = last_day_of_month(any_date_in_month)
first_of_next_month = end_of_month + datetime.timedelta(days=1)
if supervision_period.termination_date is None:
upper_bound_exclusive_date = first_of_next_month
else:
upper_bound_exclusive_date = min(first_of_next_month,
supervision_period.termination_date)
lower_bound_inclusive = max(
start_of_month, supervision_period.start_date or datetime.date.min)
supervision_type = \
us_mo_get_most_recent_supervision_period_supervision_type_before_upper_bound_day(
upper_bound_exclusive_date=upper_bound_exclusive_date,
lower_bound_inclusive_date=lower_bound_inclusive,
supervision_sentences=supervision_sentences,
incarceration_sentences=incarceration_sentences)
if not supervision_type:
return StateSupervisionPeriodSupervisionType.INTERNAL_UNKNOWN
return supervision_type
@classmethod
def get_or_default(cls, text: Optional[str]) -> 'SnapshotType':
if text is None:
return SnapshotType.DAY
return cls(text)
DAY = 'DAY'
FIRST_DAY_OF_MONTH = 'FIRST_DAY_OF_MONTH'
LAST_DAY_OF_MONTH = 'LAST_DAY_OF_MONTH'
SNAPSHOT_CONVERTERS: Dict[SnapshotType, DateRangeConverterType] = {
SnapshotType.DAY:
DateRange.for_day,
SnapshotType.FIRST_DAY_OF_MONTH:
lambda date: DateRange.for_day(first_day_of_month(date)),
SnapshotType.LAST_DAY_OF_MONTH:
lambda date: DateRange.for_day(last_day_of_month(date)),
}
class Metric:
@property
@abstractmethod
def filters(self) -> List[Dimension]:
"""Any dimensions where the data only represents a subset of values for that dimension.
For instance, a table for the population metric may only cover data for the prison population, not those on
parole or probation. In that case filters would contain PopulationType.PRISON.
"""