def type_filter(_type, filters, limit=None):
fiscal_year = None
fiscal_quarter = None
fiscal_date = None
_types = [
"budget_function",
"budget_subfunction",
"federal_account",
"program_activity",
"object_class",
"recipient",
"award",
"award_category",
"agency",
"agency_type",
"agency_sub",
]
# Validate explorer _type
if _type is None:
raise InvalidParameterException(
'Missing Required Request Parameter, "type": "type"')
elif _type not in _types:
raise InvalidParameterException(
"Type does not have a valid value. "
"Valid Types: budget_function, budget_subfunction, federal_account, program_activity,"
"object_class, recipient, award, award_category agency, agency_type, agency_sub"
)
if filters is None:
raise InvalidParameterException(
'Missing Required Request Parameter, "filters": { "filter_options" }'
)
# Get fiscal_date and fiscal_quarter
for key, value in filters.items():
if key == "fy":
try:
fiscal_year = int(value)
if fiscal_year < 1000 or fiscal_year > 9999:
raise InvalidParameterException(
'Incorrect Fiscal Year Parameter, "fy": "YYYY"')
except ValueError:
raise InvalidParameterException(
'Incorrect or Missing Fiscal Year Parameter, "fy": "YYYY"')
elif key == "quarter":
if value in ("1", "2", "3", "4"):
fiscal_quarter = int(value)
else:
raise InvalidParameterException(
"Incorrect value provided for quarter parameter. Must be a string between 1 and 4"
)
if fiscal_year:
fiscal_date, fiscal_quarter = generate_last_completed_fiscal_quarter(
fiscal_year=fiscal_year, fiscal_quarter=fiscal_quarter)
# Recipient, Award Queryset
alt_set = (FinancialAccountsByAwards.objects.all().exclude(
transaction_obligated_amount__isnull=True).exclude(
transaction_obligated_amount="NaN").filter(
submission__reporting_fiscal_quarter=fiscal_quarter).filter(
submission__reporting_fiscal_year=fiscal_year).annotate(
amount=Sum("transaction_obligated_amount")))
# Base Queryset
queryset = (FinancialAccountsByProgramActivityObjectClass.objects.all(
).exclude(
obligations_incurred_by_program_object_class_cpe__isnull=True
).filter(submission__reporting_fiscal_quarter=fiscal_quarter).filter(
submission__reporting_fiscal_year=fiscal_year).annotate(
amount=Sum("obligations_incurred_by_program_object_class_cpe")))
# Apply filters to queryset results
alt_set, queryset = spending_filter(alt_set, queryset, filters, _type)
if _type == "recipient" or _type == "award" or _type == "award_category" or _type == "agency_type":
# Annotate and get explorer _type filtered results
exp = Explorer(alt_set, queryset)
if _type == "recipient":
alt_set = exp.recipient()
if _type == "award":
alt_set = exp.award()
if _type == "award_category":
alt_set = exp.award_category()
# Total value of filtered results
actual_total = 0
alt_set = alt_set.all()
for award in alt_set:
award["id"] = str(award["id"])
if _type in ["award", "award_category"]:
code = None
for code_type in ("piid", "fain", "uri"):
if award[code_type]:
code = award[code_type]
break
for code_type in ("piid", "fain", "uri"):
del award[code_type]
award["code"] = code
if _type == "award":
award["name"] = code
actual_total += award["total"]
alt_set = alt_set[:limit] if _type == "award" else alt_set
results = {
"total": actual_total,
"end_date": fiscal_date,
"results": alt_set
}
else:
# Annotate and get explorer _type filtered results
exp = Explorer(alt_set, queryset)
if _type == "budget_function":
queryset = exp.budget_function()
if _type == "budget_subfunction":
queryset = exp.budget_subfunction()
if _type == "federal_account":
queryset = exp.federal_account()
if _type == "program_activity":
queryset = exp.program_activity()
if _type == "object_class":
queryset = exp.object_class()
if _type == "agency":
queryset = exp.agency()
# Actual total value of filtered results
actual_total = queryset.aggregate(total=Sum(
"obligations_incurred_by_program_object_class_cpe"))["total"]
result_set, expected_total = get_unreported_data_obj(
queryset=queryset,
filters=filters,
limit=limit,
spending_type=_type,
actual_total=actual_total,
fiscal_year=fiscal_year,
fiscal_quarter=fiscal_quarter,
)
results = {
"total": expected_total,
"end_date": fiscal_date,
"results": result_set
}
return results
def type_filter(_type, filters, limit=None):
_types = [
"budget_function",
"budget_subfunction",
"federal_account",
"program_activity",
"object_class",
"recipient",
"award",
"award_category",
"agency",
"agency_type",
"agency_sub",
]
# Validate explorer _type
if _type is None:
raise InvalidParameterException('Missing Required Request Parameter, "type": "type"')
elif _type not in _types:
raise InvalidParameterException(
"Type does not have a valid value. "
"Valid Types: budget_function, budget_subfunction, federal_account, program_activity,"
"object_class, recipient, award, award_category agency, agency_type, agency_sub"
)
if filters is None:
raise InvalidParameterException('Missing Required Request Parameter, "filters": { "filter_options" }')
if "fy" not in filters:
raise InvalidParameterException('Missing required parameter "fy".')
if "quarter" not in filters and "period" not in filters:
raise InvalidParameterException('Missing required parameter, provide either "period" or "quarter".')
time_unit = "quarter" if "quarter" in filters else "period"
try:
fiscal_year = int(filters["fy"])
if fiscal_year < 1000 or fiscal_year > 9999:
raise InvalidParameterException('Incorrect Fiscal Year Parameter, "fy": "YYYY"')
except ValueError:
raise InvalidParameterException('Incorrect or Missing Fiscal Year Parameter, "fy": "YYYY"')
if time_unit == "quarter" and filters["quarter"] not in ("1", "2", "3", "4", 1, 2, 3, 4):
raise InvalidParameterException("Incorrect value provided for quarter parameter. Must be between 1 and 4")
if time_unit == "period" and int(filters["period"]) not in range(1, 13):
raise InvalidParameterException("Incorrect value provided for period parameter. Must be between 1 and 12")
fiscal_unit = int(filters[time_unit])
if time_unit == "quarter":
submission_window = DABSSubmissionWindowSchedule.objects.filter(
submission_fiscal_year=fiscal_year,
submission_fiscal_quarter=fiscal_unit,
is_quarter=True,
submission_reveal_date__lte=datetime.now(timezone.utc),
).first()
else:
submission_window = DABSSubmissionWindowSchedule.objects.filter(
submission_fiscal_year=fiscal_year,
submission_fiscal_month=fiscal_unit,
submission_reveal_date__lte=datetime.now(timezone.utc),
).first()
if submission_window is None:
return {"total": None}
fiscal_date = submission_window.period_end_date
fiscal_period = submission_window.submission_fiscal_month
# transaction_obligated_amount is summed across all periods in the year up to and including the requested quarter.
alt_set = FinancialAccountsByAwards.objects.filter(
submission__reporting_fiscal_year=fiscal_year, submission__reporting_fiscal_period__lte=fiscal_period
).annotate(amount=Sum("transaction_obligated_amount"))
# obligations_incurred_by_program_object_class_cpe is picked from the final period of the quarter.
queryset = FinancialAccountsByProgramActivityObjectClass.objects.filter(
submission__reporting_fiscal_year=fiscal_year, submission__reporting_fiscal_period=fiscal_period
).annotate(amount=Sum("obligations_incurred_by_program_object_class_cpe"))
# Apply filters to queryset results
alt_set, queryset = spending_filter(alt_set, queryset, filters, _type)
if _type == "recipient" or _type == "award" or _type == "award_category" or _type == "agency_type":
# Annotate and get explorer _type filtered results
exp = Explorer(alt_set, queryset)
if _type == "recipient":
alt_set = exp.recipient()
if _type == "award":
alt_set = exp.award()
if _type == "award_category":
alt_set = exp.award_category()
# Total value of filtered results
actual_total = 0
for award in alt_set:
award["id"] = str(award["id"])
if _type in ["award", "award_category"]:
code = None
for code_type in ("piid", "fain", "uri"):
if award[code_type]:
code = award[code_type]
break
for code_type in ("piid", "fain", "uri"):
del award[code_type]
award["code"] = code
if _type == "award":
award["name"] = code
if award["amount"] is None:
award["amount"] = 0
if award["name"] is None:
award["name"] = "Blank {}".format(_type.capitalize().replace("_", " "))
actual_total += award["total"] or 0
result_set = list(alt_set)
# we need to get the File B data for the same set of filters, so we re-run the spending_filter but without setting the _type to any of the alt keys.
alt_set2, queryset2 = spending_filter(alt_set, queryset, filters, "")
expected_total = queryset2.aggregate(total=Sum("amount"))["total"]
unreported_obj = {"id": None, "code": None, "type": _type, "name": UNREPORTED_FILE_C_NAME, "amount": None}
if not (actual_total is None or expected_total is None):
unreported_obj["amount"] = expected_total - actual_total
result_set.append(unreported_obj)
actual_total = expected_total
result_set.sort(key=lambda k: k["amount"], reverse=True)
result_set = result_set[:limit] if _type == "award" else result_set
results = {"total": actual_total, "end_date": fiscal_date, "results": result_set}
else:
# Annotate and get explorer _type filtered results
exp = Explorer(alt_set, queryset)
if _type == "budget_function":
queryset = exp.budget_function()
if _type == "budget_subfunction":
queryset = exp.budget_subfunction()
if _type == "federal_account":
queryset = exp.federal_account()
if _type == "program_activity":
queryset = exp.program_activity()
if _type == "object_class":
queryset = exp.object_class()
if _type == "agency":
queryset = exp.agency()
# Actual total value of filtered results
actual_total = queryset.aggregate(total=Sum("amount"))["total"] or 0
result_set, expected_total = get_unreported_data_obj(
queryset=queryset,
filters=filters,
limit=limit,
spending_type=_type,
actual_total=actual_total,
fiscal_year=fiscal_year,
fiscal_period=fiscal_period,
)
results = {"total": expected_total, "end_date": fiscal_date, "results": result_set}
return results
def type_filter(_type, filters, limit=None):
_types = [
"budget_function",
"budget_subfunction",
"federal_account",
"program_activity",
"object_class",
"recipient",
"award",
"award_category",
"agency",
"agency_type",
"agency_sub",
]
# Validate explorer _type
if _type is None:
raise InvalidParameterException(
'Missing Required Request Parameter, "type": "type"')
elif _type not in _types:
raise InvalidParameterException(
"Type does not have a valid value. "
"Valid Types: budget_function, budget_subfunction, federal_account, program_activity,"
"object_class, recipient, award, award_category agency, agency_type, agency_sub"
)
if filters is None:
raise InvalidParameterException(
'Missing Required Request Parameter, "filters": { "filter_options" }'
)
if "fy" not in filters:
raise InvalidParameterException('Missing required parameter "fy".')
if "quarter" not in filters:
raise InvalidParameterException(
'Missing required parameter "quarter".')
try:
fiscal_year = int(filters["fy"])
if fiscal_year < 1000 or fiscal_year > 9999:
raise InvalidParameterException(
'Incorrect Fiscal Year Parameter, "fy": "YYYY"')
except ValueError:
raise InvalidParameterException(
'Incorrect or Missing Fiscal Year Parameter, "fy": "YYYY"')
if filters["quarter"] not in ("1", "2", "3", "4", 1, 2, 3, 4):
raise InvalidParameterException(
"Incorrect value provided for quarter parameter. Must be between 1 and 4"
)
fiscal_quarter = int(filters["quarter"])
submission_window = DABSSubmissionWindowSchedule.objects.filter(
submission_fiscal_year=fiscal_year,
submission_fiscal_quarter=fiscal_quarter,
is_quarter=True,
submission_reveal_date__lte=datetime.now(timezone.utc),
).first()
if submission_window is None:
return {"total": None}
fiscal_date = submission_window.period_end_date
fiscal_period = submission_window.submission_fiscal_month
# transaction_obligated_amount is summed across all periods in the year up to and including the requested quarter.
alt_set = FinancialAccountsByAwards.objects.filter(
submission__reporting_fiscal_year=fiscal_year,
submission__reporting_fiscal_quarter__lte=fiscal_quarter,
).annotate(amount=Sum("transaction_obligated_amount"))
# obligations_incurred_by_program_object_class_cpe is picked from the final period of the quarter.
queryset = FinancialAccountsByProgramActivityObjectClass.objects.filter(
submission__reporting_fiscal_year=fiscal_year,
submission__reporting_fiscal_period=fiscal_period,
).annotate(amount=Sum("obligations_incurred_by_program_object_class_cpe"))
# Apply filters to queryset results
alt_set, queryset = spending_filter(alt_set, queryset, filters, _type)
if _type == "recipient" or _type == "award" or _type == "award_category" or _type == "agency_type":
# Annotate and get explorer _type filtered results
exp = Explorer(alt_set, queryset)
if _type == "recipient":
alt_set = exp.recipient()
if _type == "award":
alt_set = exp.award()
if _type == "award_category":
alt_set = exp.award_category()
# Total value of filtered results
actual_total = 0
for award in alt_set:
award["id"] = str(award["id"])
if _type in ["award", "award_category"]:
code = None
for code_type in ("piid", "fain", "uri"):
if award[code_type]:
code = award[code_type]
break
for code_type in ("piid", "fain", "uri"):
del award[code_type]
award["code"] = code
if _type == "award":
award["name"] = code
actual_total += award["total"]
alt_set = alt_set[:limit] if _type == "award" else alt_set
results = {
"total": actual_total,
"end_date": fiscal_date,
"results": alt_set
}
else:
# Annotate and get explorer _type filtered results
exp = Explorer(alt_set, queryset)
if _type == "budget_function":
queryset = exp.budget_function()
if _type == "budget_subfunction":
queryset = exp.budget_subfunction()
if _type == "federal_account":
queryset = exp.federal_account()
if _type == "program_activity":
queryset = exp.program_activity()
if _type == "object_class":
queryset = exp.object_class()
if _type == "agency":
queryset = exp.agency()
# Actual total value of filtered results
actual_total = queryset.aggregate(total=Sum("amount"))["total"]
result_set, expected_total = get_unreported_data_obj(
queryset=queryset,
filters=filters,
limit=limit,
spending_type=_type,
actual_total=actual_total,
fiscal_year=fiscal_year,
fiscal_period=fiscal_period,
)
results = {
"total": expected_total,
"end_date": fiscal_date,
"results": result_set
}
return results
def type_filter(_type, filters, limit=None):
fiscal_year = None
fiscal_quarter = None
fiscal_date = None
_types = [
'budget_function', 'budget_subfunction', 'federal_account',
'program_activity', 'object_class', 'recipient', 'award',
'award_category', 'agency', 'agency_type', 'agency_sub'
]
# Validate explorer _type
if _type is None:
raise InvalidParameterException(
'Missing Required Request Parameter, "type": "type"')
elif _type not in _types:
raise InvalidParameterException(
'Type does not have a valid value. '
'Valid Types: budget_function, budget_subfunction, federal_account, program_activity,'
'object_class, recipient, award, award_category agency, agency_type, agency_sub'
)
if filters is None:
raise InvalidParameterException(
'Missing Required Request Parameter, "filters": { "filter_options" }'
)
# Get fiscal_date and fiscal_quarter
for key, value in filters.items():
if key == 'fy':
try:
fiscal_year = int(value)
if fiscal_year < 1000 or fiscal_year > 9999:
raise InvalidParameterException(
'Incorrect Fiscal Year Parameter, "fy": "YYYY"')
except ValueError:
raise InvalidParameterException(
'Incorrect or Missing Fiscal Year Parameter, "fy": "YYYY"')
elif key == 'quarter':
if value in ("1", "2", "3", "4"):
fiscal_quarter = int(value)
else:
raise InvalidParameterException(
'Incorrect value provided for quarter parameter. Must be a string '
'between 1 and 4')
if fiscal_year:
fiscal_date, fiscal_quarter = generate_last_completed_fiscal_quarter(
fiscal_year=fiscal_year, fiscal_quarter=fiscal_quarter)
# Recipient, Award Queryset
alt_set = FinancialAccountsByAwards.objects.all(). \
exclude(transaction_obligated_amount__isnull=True). \
exclude(transaction_obligated_amount='NaN'). \
filter(submission__reporting_fiscal_quarter=fiscal_quarter). \
filter(submission__reporting_fiscal_year=fiscal_year). \
annotate(amount=Sum('transaction_obligated_amount'))
# Base Queryset
queryset = FinancialAccountsByProgramActivityObjectClass.objects.all(). \
exclude(obligations_incurred_by_program_object_class_cpe__isnull=True). \
filter(submission__reporting_fiscal_quarter=fiscal_quarter). \
filter(submission__reporting_fiscal_year=fiscal_year). \
annotate(amount=Sum('obligations_incurred_by_program_object_class_cpe'))
# Apply filters to queryset results
alt_set, queryset = spending_filter(alt_set, queryset, filters, _type)
if _type == 'recipient' or _type == 'award' or _type == 'award_category' \
or _type == 'agency_type':
# Annotate and get explorer _type filtered results
exp = Explorer(alt_set, queryset)
if _type == 'recipient':
alt_set = exp.recipient()
if _type == 'award':
alt_set = exp.award()
if _type == 'award_category':
alt_set = exp.award_category()
# Total value of filtered results
actual_total = 0
alt_set = alt_set.all()
for award in alt_set:
award['id'] = str(award['id'])
if _type in ['award', 'award_category']:
code = None
for code_type in ('piid', 'fain', 'uri'):
if award[code_type]:
code = award[code_type]
break
for code_type in ('piid', 'fain', 'uri'):
del award[code_type]
award["code"] = code
if _type == 'award':
award["name"] = code
actual_total += award['total']
alt_set = alt_set[:limit] if _type == 'award' else alt_set
results = {
'total': actual_total,
'end_date': fiscal_date,
'results': alt_set
}
else:
# Annotate and get explorer _type filtered results
exp = Explorer(alt_set, queryset)
if _type == 'budget_function':
queryset = exp.budget_function()
if _type == 'budget_subfunction':
queryset = exp.budget_subfunction()
if _type == 'federal_account':
queryset = exp.federal_account()
if _type == 'program_activity':
queryset = exp.program_activity()
if _type == 'object_class':
queryset = exp.object_class()
if _type == 'agency':
queryset = exp.agency()
# Actual total value of filtered results
actual_total = queryset.aggregate(total=Sum(
'obligations_incurred_by_program_object_class_cpe'))['total']
result_set, expected_total = get_unreported_data_obj(
queryset=queryset,
filters=filters,
limit=limit,
spending_type=_type,
actual_total=actual_total,
fiscal_year=fiscal_year,
fiscal_quarter=fiscal_quarter)
results = {
'total': expected_total,
'end_date': fiscal_date,
'results': result_set
}
return results
def type_filter(_type, filters, limit=None):
fiscal_year = None
fiscal_quarter = None
fiscal_date = None
_types = ['budget_function', 'budget_subfunction', 'federal_account', 'program_activity', 'object_class',
'recipient', 'award', 'award_category', 'agency', 'agency_type', 'agency_sub']
# Validate explorer _type
if _type is None:
raise InvalidParameterException('Missing Required Request Parameter, "type": "type"')
elif _type not in _types:
raise InvalidParameterException(
'Type does not have a valid value. '
'Valid Types: budget_function, budget_subfunction, federal_account, program_activity,'
'object_class, recipient, award, award_category agency, agency_type, agency_sub')
# Get fiscal_date and fiscal_quarter
for key, value in filters.items():
if key == 'fy':
try:
fiscal_year = int(value)
if fiscal_year < 1000 or fiscal_year > 9999:
raise InvalidParameterException('Incorrect Fiscal Year Parameter, "fy": "YYYY"')
except ValueError:
raise InvalidParameterException('Incorrect or Missing Fiscal Year Parameter, "fy": "YYYY"')
elif key == 'quarter':
if value in ("1", "2", "3", "4"):
fiscal_quarter = int(value)
else:
raise InvalidParameterException('Incorrect value provided for quarter parameter. Must be a string '
'between 1 and 4')
if fiscal_year:
fiscal_date, fiscal_quarter = generate_last_completed_fiscal_quarter(fiscal_year=fiscal_year,
fiscal_quarter=fiscal_quarter)
# Recipient, Award Queryset
alt_set = FinancialAccountsByAwards.objects.all(). \
exclude(transaction_obligated_amount__isnull=True). \
exclude(transaction_obligated_amount='NaN'). \
filter(submission__reporting_fiscal_quarter=fiscal_quarter). \
filter(submission__reporting_fiscal_year=fiscal_year). \
annotate(amount=Sum('transaction_obligated_amount'))
# Base Queryset
queryset = FinancialAccountsByProgramActivityObjectClass.objects.all(). \
exclude(obligations_incurred_by_program_object_class_cpe__isnull=True). \
filter(submission__reporting_fiscal_quarter=fiscal_quarter). \
filter(submission__reporting_fiscal_year=fiscal_year). \
annotate(amount=Sum('obligations_incurred_by_program_object_class_cpe'))
# Apply filters to queryset results
alt_set, queryset = spending_filter(alt_set, queryset, filters, _type)
if _type == 'recipient' or _type == 'award' or _type == 'award_category' \
or _type == 'agency_type':
# Annotate and get explorer _type filtered results
exp = Explorer(alt_set, queryset)
if _type == 'recipient':
alt_set = exp.recipient()
if _type == 'award':
alt_set = exp.award()
if _type == 'award_category':
alt_set = exp.award_category()
# Total value of filtered results
actual_total = 0
alt_set = alt_set.all()
for award in alt_set:
award['id'] = str(award['id'])
if _type in ['award', 'award_category']:
code = None
for code_type in ('piid', 'fain', 'uri'):
if award[code_type]:
code = award[code_type]
break
for code_type in ('piid', 'fain', 'uri'):
del award[code_type]
award["code"] = code
if _type == 'award':
award["name"] = code
actual_total += award['total']
alt_set = alt_set[:limit] if _type == 'award' else alt_set
results = {
'total': actual_total,
'end_date': fiscal_date,
'results': alt_set
}
else:
# Annotate and get explorer _type filtered results
exp = Explorer(alt_set, queryset)
if _type == 'budget_function':
queryset = exp.budget_function()
if _type == 'budget_subfunction':
queryset = exp.budget_subfunction()
if _type == 'federal_account':
queryset = exp.federal_account()
if _type == 'program_activity':
queryset = exp.program_activity()
if _type == 'object_class':
queryset = exp.object_class()
if _type == 'agency':
queryset = exp.agency()
# Actual total value of filtered results
actual_total = queryset.aggregate(total=Sum('obligations_incurred_by_program_object_class_cpe'))['total']
result_set, expected_total = get_unreported_data_obj(queryset=queryset, filters=filters, limit=limit,
spending_type=_type, actual_total=actual_total,
fiscal_year=fiscal_year, fiscal_quarter=fiscal_quarter)
results = {
'total': expected_total,
'end_date': fiscal_date,
'results': result_set
}
return results
