-
-
Notifications
You must be signed in to change notification settings - Fork 703
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Adding Sefton Council Gets bin collection days for Sefton Council. Includes suggested changes from 5ila5 * refromatting + adding missing import + fixing test_cases --------- Co-authored-by: 5ila5 <5ila5@users.noreply.github.com>
- Loading branch information
1 parent
1c520c7
commit 23ef38f
Showing
8 changed files
with
251 additions
and
1 deletion.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
121 changes: 121 additions & 0 deletions
121
...om_components/waste_collection_schedule/waste_collection_schedule/source/sefton_gov_uk.py
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| import datetime | ||
|
|
||
| import requests | ||
| from bs4 import BeautifulSoup | ||
| from waste_collection_schedule import Collection | ||
| from waste_collection_schedule.exceptions import SourceArgumentNotFoundWithSuggestions | ||
|
|
||
| TITLE = "Sefton Council" # Title will show up in README.md and info.md | ||
| DESCRIPTION = "Source for Sefton Council, UK" # Describe your source | ||
| URL = "https://www.sefton.gov.uk/" # Insert url to service homepage. URL will show up in README.md and info.md | ||
| TEST_CASES = { # Insert arguments for test cases to be used by test_sources.py script | ||
| "Issue2369": { | ||
| "house_number_or_name": "1", | ||
| "streetname": "Ken Mews", | ||
| "postcode": "L20 6GF", | ||
| }, | ||
| "Housename": { | ||
| "house_number_or_name": "Gladstone House", | ||
| "streetname": "Rosemary Lane", | ||
| "postcode": "L37 3JB", | ||
| }, | ||
| "Issue2496": { | ||
| "house_number_or_name": 22, | ||
| "streetname": "Elton Avenue", | ||
| "postcode": "L23 8UW", | ||
| }, | ||
| } | ||
|
|
||
| API_URL = "https://www.sefton.gov.uk/bins-and-recycling/bins-and-recycling/when-is-my-bin-collection-day/" | ||
| ICON_MAP = { # Optional: Dict of waste types and suitable mdi icons | ||
| "RESIDUAL": "mdi:trash-can", | ||
| "RECYCLING": "mdi:recycle", | ||
| "GREEN": "mdi:leaf", | ||
| } | ||
|
|
||
| # ### Arguments affecting the configuration GUI #### | ||
|
|
||
| HOW_TO_GET_ARGUMENTS_DESCRIPTION = { # Optional dictionary to describe how to get the arguments, will be shown in the GUI configuration form above the input fields, does not need to be translated in all languages | ||
| "en": "Using a browser, go to [sefton.gov.uk](https://www.sefton.gov.uk/bins-and-recycling/bins-and-recycling/when-is-my-bin-collection-day/). " | ||
| "For _Postcode_ and _Street name_ use the values you'd enter on Sefton's first page." | ||
| "Search, and then for _House Name or Number_ you need the value that comes before the street name you entered on the first screen." | ||
| "e.g. if your streetname is 'Liverpool Road' and the select box has an option of '1A Liverpool Road' enter '1A' as your _House Name or Number_." | ||
| } | ||
|
|
||
| PARAM_DESCRIPTIONS = { # Optional dict to describe the arguments, will be shown in the GUI configuration below the respective input field | ||
| "en": { | ||
| "house_number_or_name": "House name or number", | ||
| "streetname": "Street name", | ||
| "postcode": "Postcode", | ||
| } | ||
| } | ||
|
|
||
|
|
||
| # ### End of arguments affecting the configuration GUI #### | ||
|
|
||
|
|
||
| class Source: | ||
| def __init__( | ||
| self, house_number_or_name: str | int, streetname: str, postcode: str | ||
| ): # argX correspond to the args dict in the source configuration | ||
| self._house_number_or_name = str(house_number_or_name).upper() | ||
| self._streetname = streetname | ||
| self._postcode = postcode | ||
|
|
||
| def fetch(self) -> list[Collection]: | ||
| with requests.Session() as sess: | ||
| request = sess.get( | ||
| "https://www.sefton.gov.uk/bins-and-recycling/bins-and-recycling/when-is-my-bin-collection-day/" | ||
| ) | ||
|
|
||
| soup = BeautifulSoup(request.content, "html.parser") | ||
| hidden = soup.find_all("input", {"type": "hidden"}, limit=2) | ||
| payload = {x["name"]: x["value"] for x in hidden} | ||
| payload["Postcode"] = self._postcode | ||
| payload["Streetname"] = self._streetname | ||
| request = sess.post( | ||
| "https://www.sefton.gov.uk/bins-and-recycling/bins-and-recycling/when-is-my-bin-collection-day/", | ||
| data=payload, | ||
| ) | ||
| # We should now have the page displaying the select list for addresses, parse again to find the form elements we need. | ||
| soup = BeautifulSoup(request.content, "html.parser") | ||
| hidden = soup.find_all("input", {"type": "hidden"}) | ||
| payload = {x["name"]: x["value"] for x in hidden} | ||
| payload["action"] = "Select" | ||
| option_tags = soup.select("select option") | ||
| for option in option_tags: | ||
| if option.text.upper().strip().startswith(self._house_number_or_name): | ||
| payload["selectedValue"] = option["value"] | ||
| break | ||
| if "selectedValue" not in payload: | ||
| raise SourceArgumentNotFoundWithSuggestions( | ||
| "houseNumberOrName", | ||
| self._house_number_or_name, | ||
| [option.text.strip() for option in option_tags], | ||
| ) | ||
| request = sess.post( | ||
| "https://www.sefton.gov.uk/bins-and-recycling/bins-and-recycling/when-is-my-bin-collection-day/", | ||
| data=payload, | ||
| ) | ||
| soup = BeautifulSoup(request.content, "html.parser") | ||
| tables = soup.find_all("table") | ||
| entries = [] | ||
| if len(tables) > 0: | ||
| for table in tables: | ||
| binType = table.td.text.split()[0] | ||
| binCollectionDate = datetime.datetime.strptime( | ||
| table.td.findNext("td").findNext("td").text, "%d/%m/%Y" | ||
| ).date() | ||
| entries.append( | ||
| Collection( | ||
| date=binCollectionDate, | ||
| t=binType, | ||
| icon=ICON_MAP.get(binType.upper()), | ||
| ) | ||
| ) | ||
| else: | ||
| raise Exception( | ||
| "No entries could be parsed, check the Sefton website is working and your arguments exactly match what you enter online." | ||
| ) | ||
|
|
||
| return entries |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # Sefton Council | ||
|
|
||
| Support for schedules provided by [Sefton Council](https://www.sefton.gov.uk/bins-and-recycling/bins-and-recycling/when-is-my-bin-collection-day/), serving the | ||
| district of Sefton, UK. | ||
|
|
||
| ## Configuration via configuration.yaml | ||
|
|
||
| ```yaml | ||
| waste_collection_schedule: | ||
| sources: | ||
| - name: sefton_gov_uk | ||
| args: | ||
| postcode: Postcode | ||
| streetname: Streetname | ||
| house_number_or_name: House number or name | ||
| ``` | ||
| ### Configuration Variables | ||
| **postcode** | ||
| *(string) (required)* | ||
| **streetname** | ||
| *(string) (required)* | ||
| **house_number_or_name** | ||
| *(string) (required)* | ||
| ## Example | ||
| ```yaml | ||
| waste_collection_schedule: | ||
| sources: | ||
| - name: sefton_gov_uk | ||
| args: | ||
| postcode: "L20 6GF" | ||
| streetname: "Ken Mews" | ||
| house_number_or_name: "1" | ||
| ``` | ||
| ## How to find the values for arguments above | ||
| Go to the Sefton "When is my Bin Collection Day?" page - the postcode and streetname arguments are the same values you'd enter on the first page of the form. The House Number or Name value is the string/number that appears before the streetname in the dropdown on the second page - e.g. if the dropdown shows "1A Liverpool Road" you should enter "1A" as your House Number or Name value. |
Oops, something went wrong.