Skip to content

Rename totalCounts with totalRecipientCount #335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 30, 2025
Merged

Rename totalCounts with totalRecipientCount #335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
525f997
Rename totalCounts with totalRecipientCount
ylyangtw Jul 28, 2025
05e35a9
rename title I totalRecipients to totalRecipientCount
ylyangtw Jul 30, 2025
3631318
Merge branch 'develop' into 334-task-rename-totalcounts-with-totalrec…
ylyangtw Jul 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased
## [Unreleased]

### Changed
- Rename totalCounts with totalRecipientCount. [#334](https://github.com/policy-design-lab/pdl-api/issues/334)
- Update Title I endpoints to include data from 2014 to 2023. [#192](https://github.com/policy-design-lab/pdl-api/issues/192)

## [0.23.0] - 2025-06-26
Expand Down
48 changes: 24 additions & 24 deletions app/controllers/pdl.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1457,7 +1457,7 @@ def generate_title_iv_state_distribution_response(program_id, start_year, end_ye
Program.name.label('programName'),
Payment.year.label('year'),
Payment.payment.label('totalPaymentInDollars'),
Payment.recipient_count.label('totalCounts')
Payment.recipient_count.label('totalRecipientCount')
).join(
Program, Payment.program_id == Program.id
).filter(
Expand Down Expand Up @@ -1591,7 +1591,7 @@ def generate_title_i_total_state_distribution_response(title_id, start_year, end
Subtitle.name.label('subtitleName'),
Payment.year.label('year'),
Payment.payment.label('totalPaymentInDollars'),
Payment.recipient_count.label('totalCounts')).join(
Payment.recipient_count.label('totalRecipientCount')).join(
Subtitle, Payment.subtitle_id == Subtitle.id).filter(
Payment.title_id == title_id,
Payment.year.between(start_year, end_year)
Expand All @@ -1602,21 +1602,21 @@ def generate_title_i_total_state_distribution_response(title_id, start_year, end

# create a nested dictionary to store data by year and state
data_by_year_and_state = defaultdict(
lambda: defaultdict(lambda: {'totalPaymentInDollars': 0, 'totalRecipients': 0}))
all_years_summary = defaultdict(lambda: {'totalPaymentInDollars': 0, 'totalRecipients': 0})
lambda: defaultdict(lambda: {'totalPaymentInDollars': 0, 'totalRecipientCount': 0}))
all_years_summary = defaultdict(lambda: {'totalPaymentInDollars': 0, 'totalRecipientCount': 0})

for record in result:
state, title_name, year, payments, recipients = record
entry = data_by_year_and_state[year][state]
entry['state'] = state
entry['totalPaymentInDollars'] += payments
entry['totalRecipients'] += recipients
entry['totalRecipientCount'] += recipients

# add to all years summary
summary = all_years_summary[state]
summary['state'] = state
summary['totalPaymentInDollars'] += payments
summary['totalRecipients'] += recipients
summary['totalRecipientCount'] += recipients

# sort by total payment
sorted_data_by_year = {}
Expand Down Expand Up @@ -1717,7 +1717,7 @@ def generate_title_i_total_summary_response(title_id, start_year, end_year):
Title.name.label('titleName'),
Payment.year.label('year'),
Payment.payment.label('totalPaymentInDollars'),
Payment.recipient_count.label('totalCounts'),
Payment.recipient_count.label('totalRecipientCount'),
Subtitle.name.label('subtitleName')
).join(
Title, Payment.title_id == Title.id
Expand All @@ -1734,25 +1734,25 @@ def generate_title_i_total_summary_response(title_id, start_year, end_year):
# Initialize dictionaries to store aggregated data
title_summary = defaultdict(lambda: {
'totalPaymentInDollars': 0,
'totalCounts': 0,
'totalRecipientCount': 0,
'recipients': [],
'subtitles': defaultdict(lambda: {
'totalPaymentInDollars': 0,
'totalCounts': 0,
'totalRecipientCount': 0,
'recipients': []
})
})

# Process each record in the data
for state, title_name, year, payment, recipients, subtitle in results:
title_summary[title_name]['totalPaymentInDollars'] += payment
title_summary[title_name]['totalCounts'] += recipients
title_summary[title_name]['totalRecipientCount'] += recipients
title_summary[title_name]['recipients'].append(recipients)

# Aggregate subtitle data
subtitle_dict = title_summary[title_name]['subtitles'][subtitle]
subtitle_dict['totalPaymentInDollars'] += payment
subtitle_dict['totalCounts'] += recipients
subtitle_dict['totalRecipientCount'] += recipients
subtitle_dict['recipients'].append(recipients)

# Prepare the final summary
Expand All @@ -1770,15 +1770,15 @@ def generate_title_i_total_summary_response(title_id, start_year, end_year):
subtitle_list.append({
'programName': subtitle_name,
'totalPaymentInDollars': round(subtitle_info['totalPaymentInDollars'], 2),
'totalCounts': subtitle_info['totalCounts'],
'totalRecipientCount': subtitle_info['totalRecipientCount'],
'averageRecipientCount': subtitle_avg_recipients,
'totalPaymentInPercentage': round(payment_percentage, 2)
})

title_entry = {
'titleName': title,
'totalPaymentInDollars': round(info['totalPaymentInDollars'], 2),
'totalCounts': info['totalCounts'],
'totalRecipientCount': info['totalRecipientCount'],
'averageRecipientCount': round(average_recipient_count, 2),
'startYear': start_year,
'endYear': end_year,
Expand Down Expand Up @@ -1865,7 +1865,7 @@ def generate_title_i_state_distribution_response(subtitle_id, start_year, end_ye
func.sum(Payment.payment).label('totalPaymentInDollars'),
func.round(func.avg(Payment.base_acres), 2).label('averageAreaInAcres'),
func.cast(func.avg(Payment.recipient_count), BigInteger).label('averageRecipientCount'),
func.cast(func.sum(Payment.recipient_count), Integer).label('totalCounts'),
func.cast(func.sum(Payment.recipient_count), Integer).label('totalRecipientCount'),
(func.cast(func.sum(Payment.recipient_count) / subtitle_subquery_recipient_count * 100, Numeric(5, 2))).label(
'averageRecipientCountInPercentageNationwide')
).join(
Expand All @@ -1890,7 +1890,7 @@ def generate_title_i_state_distribution_response(subtitle_id, start_year, end_ye
response_dict = dict(zip(column_names, row))

# Cleanup / renaming attributes
response_dict["totalCountsInPercentageNationwide"] = response_dict["averageRecipientCountInPercentageNationwide"]
response_dict["totalRecipientCountInPercentageNationwide"] = response_dict["averageRecipientCountInPercentageNationwide"]
if response_dict['averageAreaInAcres'] is None:
response_dict['averageAreaInAcres'] = 0.0
subtitle_response_dict[response_dict['state']] = response_dict
Expand Down Expand Up @@ -1926,7 +1926,7 @@ def generate_title_i_state_distribution_response(subtitle_id, start_year, end_ye
Payment.state_code.label('state'),
Program.name.label('programName'),
func.sum(Payment.payment).label('totalPaymentInDollars'),
func.cast(func.sum(Payment.recipient_count), Integer).label('totalCounts'),
func.cast(func.sum(Payment.recipient_count), Integer).label('totalRecipientCount'),
func.round(func.avg(Payment.base_acres), 2).label('averageAreaInAcres'),
func.cast(func.sum(Payment.recipient_count) / total_years, BigInteger).label('averageRecipientCount'),
(func.cast(func.sum(Payment.payment) / program_subquery_total_payment * 100, Numeric(5, 2))).label(
Expand Down Expand Up @@ -1956,7 +1956,7 @@ def generate_title_i_state_distribution_response(subtitle_id, start_year, end_ye
state = response_dict['state']

# Cleanup / renaming attributes
response_dict["totalCountsInPercentageNationwide"] = response_dict[
response_dict["totalRecipientCountInPercentageNationwide"] = response_dict[
"averageRecipientCountInPercentageNationwide"]
response_dict['subPrograms'] = []
if response_dict['averageAreaInAcres'] is None:
Expand Down Expand Up @@ -2038,14 +2038,14 @@ def generate_title_i_state_distribution_response(subtitle_id, start_year, end_ye
else:
program["totalPaymentInPercentageWithinState"] = 0.0

if subtitle_response_dict[state]["totalCounts"] != 0:
program["totalCountsInPercentageWithinState"] = (
round(program["totalCounts"] / subtitle_response_dict[state]["totalCounts"] * 100, 2))
if subtitle_response_dict[state]["totalRecipientCount"] != 0:
program["totalRecipientCountInPercentageWithinState"] = (
round(program["totalRecipientCount"] / subtitle_response_dict[state]["totalRecipientCount"] * 100, 2))
# TODO: Temporary fix. The below attribute may need to be calculated based on the average recipient count or removed if not needed.
program["averageRecipientCountInPercentageWithinState"] = program["totalCountsInPercentageWithinState"]
program["averageRecipientCountInPercentageWithinState"] = program["totalRecipientCountInPercentageWithinState"]
else:
program["averageRecipientCountInPercentageWithinState"] = 0.0
program["totalCountsInPercentageWithinState"] = 0.0
program["totalRecipientCountInPercentageWithinState"] = 0.0

for subprogram in program["subPrograms"]:
if subtitle_response_dict[state]["totalPaymentInDollars"] != 0.0:
Expand Down Expand Up @@ -2078,7 +2078,7 @@ def generate_title_i_summary_response(subtitle_id, start_year, end_year):
subtitle_query = (session.query(
Subtitle.name.label('subtitleName'),
func.sum(Payment.payment).label('totalPaymentInDollars'),
func.cast(func.sum(Payment.recipient_count), Integer).label('totalCounts'),
func.cast(func.sum(Payment.recipient_count), Integer).label('totalRecipientCount'),
func.cast(subtitle_avg_recipient_count, BigInteger).label('averageRecipientCount')
).join(
Subtitle, Payment.subtitle_id == Subtitle.id
Expand Down Expand Up @@ -2131,7 +2131,7 @@ def generate_title_i_summary_response(subtitle_id, start_year, end_year):
program_query = (session.query(
Program.name.label('programName'),
func.sum(Payment.payment).label('totalPaymentInDollars'),
func.cast(func.sum(Payment.recipient_count), Integer).label('totalCounts'),
func.cast(func.sum(Payment.recipient_count), Integer).label('totalRecipientCount'),
func.cast(program_avg_recipient_count, BigInteger).label('averageRecipientCount'),
(func.cast(func.sum(Payment.payment) / subtitle_subquery * 100, Numeric(5, 2))).label(
'totalPaymentInPercentage')
Expand Down