Skip to content

Fix school districts #17

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

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

Fix school districts #17

wants to merge 2 commits into from

Conversation

@brianfullerusa
Copy link

@brianfullerusa brianfullerusa commented Nov 13, 2025

This pull request is scoped to fix the issue of the additional fields for "school" returning "None" when the code below is executed.

response = client.geocode(
    "some address,
    fields=["school"]
)

The root cause of the issue appears to be a mismatch of names between what the API returns and the expected values.

This pull request makes the following adjustments:

  • src/geocodio/client.py: since the api does not turn school but instead returns "school_districts" an elif was added to match some of the other fields in this file.
  • src/geocodio/models.py: added fields to match the return values from the api. Left existing fields as they are, but they currently always return None. lea_code is really the nces_id, but I left the field as lea_code since that is what the api returns instead of aliasing the return value to nces_id.
  • tests/e2e/test_api.py: added new fields from models.

References:
Geocod.io - Guide - School Districts
Geocod.io - API Reference

sylvesterdamgaard added a commit that referenced this pull request Nov 19, 2025
@sylvesterdamgaard
fix(parser): support nested field structures with backward compatibility
af65377 
API changed response format from flat to nested structure for several fields:
- Census: census2010: {...} → census: {2010: {...}}
- ACS: acs-demographics: {...} → acs: {demographics: {...}}
- School districts: school: [...] → school_districts: {elementary: {...}}

Additionally, census field names changed (block → block_code, etc.) which
would break existing code accessing the old field names.

Changes:
- Add nested census parsing with dynamic year support (census2020-census2099+)
- Add nested ACS parsing supporting both simple and metric-specific formats
- Add nested school districts parsing (dict and list formats)
- Map new census field names to legacy names for backward compatibility
- Update ZIP4Data and FFIECData models with complete field definitions
- Remove hardcoded census year fields, use dynamic __getattr__ instead

Backward compatibility ensured:
- fields.census2020.block still works (maps to block_code)
- fields.census2020.blockgroup still works (maps to block_group)
- fields.census2020.tract still works (maps to tract_code)

Future-proof:
- census2031+ years work automatically without code changes
- cd120+ congressional districts work automatically
- Unknown API fields captured in extras dict

Fixes #15
Fixes #16
Closes #14
Closes #17
@sylvesterdamgaard sylvesterdamgaard mentioned this pull request Nov 19, 2025
Merged
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@brianfullerusa