-
-
Notifications
You must be signed in to change notification settings - Fork 770
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New Source : BEP-Environnement (Belgium) (#3355)
* Add support for BEP-Environnement (Belgium) * Fix: Use date object not datetime * fix: use SourceArgumentNotFoundWithSuggestions instead of SourceArgumentException doc: HOW_TO_GET_ARGUMENTS_DESCRIPTION completed refactor: rename Cities keyword with localities * reformatting + fixing typehint + fix exception * ./update_docu_links.py --------- Co-authored-by: 5ila5 <[email protected]>
- Loading branch information
Showing
8 changed files
with
232 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
128 changes: 128 additions & 0 deletions
128
...onents/waste_collection_schedule/waste_collection_schedule/source/bep_environnement_be.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,128 @@ | ||
| import json | ||
| from datetime import date | ||
| from typing import List | ||
|
|
||
| import requests | ||
| from bs4 import BeautifulSoup | ||
| from waste_collection_schedule import Collection | ||
| from waste_collection_schedule.exceptions import SourceArgumentNotFoundWithSuggestions | ||
|
|
||
| TITLE = "Bep-Environnement" | ||
| DESCRIPTION = "Source for Bep Environnement garbage collection" # Describe your source | ||
| # Insert url to service homepage. URL will show up in README.md and info.md | ||
| URL = "https://www.bep-environnement.be" | ||
| TEST_CASES = { # Insert arguments for test cases to be used by test_sources.py script | ||
| "Dinant": {"locality": "Dinant"}, | ||
| } | ||
|
|
||
| WASTE_MAP = { | ||
| # Déchers ménagers + organique | ||
| "dmorga": {"type": "DM & Organiques", "icon": "mdi:trash-can"}, | ||
| # PMC | ||
| "pmc": {"type": "PMC", "icon": "mdi:recycle"}, | ||
| # Papiers cartons | ||
| "papierscartons": {"type": "Papiers & Cartons", "icon": "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": 'Go to the "https://www.bep-environnement.be" website if you\'re unsure about your locality.', | ||
| } | ||
|
|
||
| PARAM_DESCRIPTIONS = { # Optional dict to describe the arguments, will be shown in the GUI configuration below the respective input field | ||
| "en": {"locality": "Name of the locality"} | ||
| } | ||
|
|
||
|
|
||
| def GetLocalities() -> dict[str, str]: | ||
| """Return id for each locality available in calendar. | ||
| Returns: | ||
| List[dict]: key is the city, value is the id for the calendar | ||
| """ | ||
| response = requests.get(URL) | ||
| soup = BeautifulSoup(response.text, "html.parser") | ||
|
|
||
| # Find all <option> elements inside the select | ||
| options = soup.select("#locform-loc option") | ||
|
|
||
| # Create a dictionary of city names and their values | ||
| localities = { | ||
| option.text.lower(): option["value"] | ||
| for option in options | ||
| if option.text.strip() | ||
| } | ||
|
|
||
| # Print the result | ||
| return localities | ||
|
|
||
|
|
||
| def BepWasteParser(response: dict) -> List[Collection]: | ||
| """Specific implementation to parse response from Bep-Environement. | ||
| Args: | ||
| response (dict): response from the website | ||
| Returns: | ||
| List[Collection]: list of Collection found | ||
| """ | ||
| collections = [] | ||
| cal_soup = BeautifulSoup(response.get("cal", ""), "html.parser") | ||
| cells = cal_soup.find_all("td") | ||
|
|
||
| for cell in cells: | ||
| # Extract attributes | ||
| data_day = cell.get("data-day") | ||
| data_month = cell.get("data-month") | ||
| data_year = cell.get("data-year") | ||
|
|
||
| # Check for waste types in the class attribute | ||
| classes = cell.get("class", []) | ||
| waste_types = [cls for cls in classes if cls in WASTE_MAP] | ||
|
|
||
| if data_day and data_month and data_year and waste_types: | ||
| # Construct the date | ||
| collection_date = date( | ||
| year=int(data_year), month=int(data_month), day=int(data_day) | ||
| ) | ||
|
|
||
| for abbr, map in WASTE_MAP.items(): | ||
| if abbr in waste_types: | ||
| c = Collection( | ||
| date=collection_date, t=map["type"], icon=map["icon"] | ||
| ) | ||
| collections.append(c) | ||
|
|
||
| return collections | ||
|
|
||
|
|
||
| class Source: | ||
| BEP_CALENDAR_URL = "https://www.bep-environnement.be/wp-admin/admin-ajax.php" | ||
| GARBAGE_COLLECTION_ACTION = "calendriercollectes" | ||
|
|
||
| def __init__(self, locality: str): | ||
| self._locality = locality.lower() | ||
|
|
||
| def fetch(self) -> list[Collection]: | ||
| # Check for city name given | ||
| localities = GetLocalities() | ||
|
|
||
| if self._locality not in localities: | ||
| raise SourceArgumentNotFoundWithSuggestions( | ||
| "locality", self._locality, localities.keys() | ||
| ) | ||
|
|
||
| # Make the request to get the data | ||
| params = { | ||
| "action": self.GARBAGE_COLLECTION_ACTION, | ||
| "locID": localities[self._locality], | ||
| } | ||
| response = requests.get(self.BEP_CALENDAR_URL, params=params) | ||
| response.raise_for_status() | ||
| data = json.loads(response.text) | ||
|
|
||
| # Parse the response | ||
| entries = BepWasteParser(data) | ||
|
|
||
| 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,33 @@ | ||
| # BEP Environnement | ||
|
|
||
| Support for schedules provided by [bep-environnement.be](https://www.bep-environnement.be/). | ||
|
|
||
| ## Configuration via configuration.yaml | ||
|
|
||
| ```yaml | ||
| waste_collection_schedule: | ||
| sources: | ||
| - name: bep_environnement_be | ||
| args: | ||
| locality: LOCALITY | ||
| ``` | ||
| The arguments can be found in the URL after visiting the [the calendar](https://www.bep-environnement.be/). Type your *Postal Code* or *City Name* then select the **Locality**. This is the value you have to give in argument. | ||
| ### Configuration Variables | ||
| **locality** | ||
| *(string)* | ||
| Name of your Locality (Localité). | ||
| ## Example | ||
| ```yaml | ||
| # URL: https://www.bep-environnement.be/ | ||
|
|
||
| waste_collection_schedule: | ||
| sources: | ||
| - name: bep_environnement_be | ||
| args: | ||
| locality: "Dinant" | ||
| ``` |
Oops, something went wrong.