fix(StratfordUponAvonCouncil): Add postcode lookup via council API#2057
Open
InertiaUK wants to merge 2 commits into
Open
fix(StratfordUponAvonCouncil): Add postcode lookup via council API#2057InertiaUK wants to merge 2 commits into
InertiaUK wants to merge 2 commits into
Conversation
Contributor
|
Warning Review limit reached
Your plan currently allows 2 reviews/hour. Refill in 25 minutes and 52 seconds. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more review capacity refills, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than trial, open-source, and free plans. In all cases, review capacity refills continuously over time. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe parser now resolves a UPRN via Stratford’s address API using postcode/paon/uprn, POSTs the resolved UPRN to the calendar endpoint, and parses the returned HTML table to compute the earliest upcoming collection date per bin, failing fast on missing data. ChangesWaste Collection Data Flow
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
❌ 1 Tests Failed:
View the top 1 failed test(s) by shortest run time
To view more test analytics, go to the Test Analytics Dashboard |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
uk_bin_collection/uk_bin_collection/councils/StratfordUponAvonCouncil.py (1)
31-32: ⚡ Quick winAdd timeout to requests to prevent indefinite hangs.
Both
s.get()ands.post()(line 76) lack atimeoutparameter. If the server is unresponsive, the request could block indefinitely.⏱️ Proposed fix to add timeouts
- r1 = s.get(f"{api_base}/{postcode_stripped}", params=params, verify=False) + r1 = s.get(f"{api_base}/{postcode_stripped}", params=params, verify=False, timeout=30)And similarly for the POST:
- r2 = s.post(calendar_url, data=payload, verify=False) + r2 = s.post(calendar_url, data=payload, verify=False, timeout=30)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@uk_bin_collection/uk_bin_collection/councils/StratfordUponAvonCouncil.py` around lines 31 - 32, Requests in StratfordUponAvonCouncil.py use s.get(...) (assigned to r1) and s.post(...) without timeouts; update both calls to include a sensible timeout (e.g., timeout=10) so they don't hang indefinitely, i.e., add the timeout keyword to the s.get(...) call that creates r1 and to the s.post(...) call later (preserving params, data, and verify settings) and consider centralizing the value as a constant at the top of the module if reuse is desired.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@uk_bin_collection/uk_bin_collection/councils/StratfordUponAvonCouncil.py`:
- Around line 108-114: The loop over column_headers and collection_info can
silently misalign when their lengths differ; update the zip call in the loop
that iterates over column_headers, collection_info (where next_collection_dates
and date_obj are used) to use zip(..., strict=True) so a mismatch raises
immediately, or if mismatches may be legitimate, wrap that loop in a try/except
to catch the ValueError, log a warning including the offending column_headers
and collection_info, and skip or handle the malformed row so
next_collection_dates is not silently corrupted.
- Around line 10-13: The code calls check_postcode(user_postcode) and later uses
user_postcode.replace(...) which will raise AttributeError when user_postcode is
None; update StratfordUponAvonCouncil logic to explicitly validate user_postcode
before using it: ensure user_postcode is not None (e.g., if not user_postcode:
raise ValueError or return early) or guard the call to check_postcode so you
only call check_postcode and subsequent user_postcode.replace(...) when
user_postcode is provided; refer to the variables user_postcode and the function
check_postcode to locate and change the flow.
- Around line 42-64: The code silently falls back to the first address when a
user-supplied UPRN (user_uprn) doesn't match any address in addresses; change
this to fail explicitly: after the loop that attempts to match user_uprn (the
block that sets selected_uprn when str(addr.get("uprn")) == str(user_uprn)), if
user_uprn was provided and selected_uprn is still unset, raise a clear exception
(or return an explicit error) indicating "UPRN not found" instead of assigning
addresses[0]["uprn"]; keep the existing PAON matching logic unchanged for cases
where user_uprn is not provided.
---
Nitpick comments:
In `@uk_bin_collection/uk_bin_collection/councils/StratfordUponAvonCouncil.py`:
- Around line 31-32: Requests in StratfordUponAvonCouncil.py use s.get(...)
(assigned to r1) and s.post(...) without timeouts; update both calls to include
a sensible timeout (e.g., timeout=10) so they don't hang indefinitely, i.e., add
the timeout keyword to the s.get(...) call that creates r1 and to the
s.post(...) call later (preserving params, data, and verify settings) and
consider centralizing the value as a constant at the top of the module if reuse
is desired.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: fbe20f84-2c9b-4043-9e49-8ed8b635bf35
📒 Files selected for processing (1)
uk_bin_collection/uk_bin_collection/councils/StratfordUponAvonCouncil.py
InertiaUK
force-pushed
the
fix-stratford-postcode-lookup
branch
from
fe928be to
858b8dd
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@uk_bin_collection/uk_bin_collection/councils/StratfordUponAvonCouncil.py`:
- Line 31: The GET calls use verify=False (seen in the s.get call assigned to r1
and the second similar call), which will emit InsecureRequestWarning; either
re-enable SSL verification or, if you must keep verify=False, suppress warnings
once by disabling urllib3.exceptions.InsecureRequestWarning before performing
these requests (or set the session to ignore warnings), and ensure suppression
is applied where r1 is created and the second API call around line 76 so users
are not spammed with warnings.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: c99fb70a-1f0f-4878-8a7e-db02d1e1670a
📒 Files selected for processing (1)
uk_bin_collection/uk_bin_collection/councils/StratfordUponAvonCouncil.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
api.stratford.gov.uk/v1/addresses/postcode/to resolve correct UPRN before POSTing to calendarTest
Summary by CodeRabbit