-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Ajout de l'emplacement du projet dans __init__.py * Ajout dépendences: geopandas, shapely * Ajout du geojson des départements français métropolitains. * Utilisation d'une objet pour l'input de département. Lecture des coordonnées en URL pour le département par défaut * Ajout d'une property pour la valeur par defaut * Ajout des tests pour la classe DefaultDepartment * Ajout des Test pour DepartmentInput * Ajout de l'emplacement du projet dans __init__.py * Ajout dépendences: geopandas, shapely * Ajout du geojson des départements français métropolitains. * Utilisation d'une objet pour l'input de département. Lecture des coordonnées en URL pour le département par défaut * Ajout d'une property pour la valeur par defaut * Ajout des tests pour la classe DefaultDepartment * Ajout des Test pour DepartmentInput * Ajout des outils d'input pour les stations. * Noms des champs code bss et nom commune comme paramètre d'input * Ajout des test d'inputs de station * Ajout des valeurs par défaut pour les dates * Ajout des Test pour les stations, dates par defaut * Ajout des inputs de date et période * Utilisation des inputs de période * Correction nom méthode * Implémentation test pour période input
- Loading branch information
Showing
10 changed files
with
1,198 additions
and
51 deletions.
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
Large diffs are not rendered by default.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,5 @@ | ||
| """Provide collection and visualisation tools for water-related variables.""" | ||
|
|
||
| from pathlib import Path | ||
|
|
||
| BASE_DIR = Path(__file__).parent.resolve() |
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,207 @@ | ||
| """Tools to compute defaults values for user inputs.""" | ||
|
|
||
| import datetime as dt | ||
| from abc import ABC, abstractproperty | ||
| from functools import cached_property | ||
| from pathlib import Path | ||
| from typing import Generic, TypeVar | ||
|
|
||
| import geopandas as gpd | ||
| import pandas as pd | ||
| from shapely import Point | ||
|
|
||
| from water_tracker import BASE_DIR | ||
|
|
||
| depts_geojson_path_relative = Path("resources/departments_geojson.json") | ||
| depts_geojson_path = BASE_DIR.joinpath(depts_geojson_path_relative) | ||
|
|
||
| DefaultValueT = TypeVar("DefaultValueT") | ||
|
|
||
|
|
||
| class DefaultInput(ABC, Generic[DefaultValueT]): | ||
| """Base class for default user inputs.""" | ||
|
|
||
| @abstractproperty | ||
| def value(self) -> DefaultValueT: | ||
| """Value to use as default.""" | ||
|
|
||
|
|
||
| class DefaultDepartement(DefaultInput[str]): | ||
| """Default input for department selection from query_params. | ||
| Parameters | ||
| ---------- | ||
| query_params : dict[str, list[str]] | ||
| Query parameters shown in the browser's url. | ||
| longitude_query_param : str | ||
| Name of the latitude field. | ||
| latitude_query_param : str | ||
| Name of the longitude field. | ||
| depts_geojson_path : Path, optional | ||
| Path to the geojson with departments boundaries. | ||
| , by default depts_geojson_path | ||
| geojson_code_field : str, optional | ||
| Geojson field with departments code., by default "code" | ||
| """ | ||
|
|
||
| _default_dept_nb: str = "01" | ||
|
|
||
| def __init__( | ||
| self, | ||
| query_params: dict[str, list[str]], | ||
| longitude_query_param: str, | ||
| latitude_query_param: str, | ||
| depts_geojson_path: Path = depts_geojson_path, | ||
| geojson_code_field: str = "code", | ||
| ) -> None: | ||
| self.lat_param = latitude_query_param | ||
| self.lon_param = longitude_query_param | ||
| self._depts_path = depts_geojson_path | ||
| self.geojson_code_field = geojson_code_field | ||
| self.query_params = query_params | ||
|
|
||
| @property | ||
| def default_value(self) -> str: | ||
| """Default value.""" | ||
| return self._default_dept_nb | ||
|
|
||
| @cached_property | ||
| def departments_geojson(self) -> gpd.GeoDataFrame: | ||
| """Geodataframe with departments polygons.""" | ||
| return gpd.read_file(self._depts_path) | ||
|
|
||
| @property | ||
| def query_params(self) -> dict: | ||
| """Query parameters.""" | ||
| return self._query | ||
|
|
||
| @query_params.setter | ||
| def query_params(self, query_params: dict[str, list[str]]) -> None: | ||
| self._query = query_params | ||
| self._valid_query_params = self.check_params() | ||
|
|
||
| @property | ||
| def value(self) -> str: | ||
| """Value to use a default for department.""" | ||
| if self._valid_query_params: | ||
| point = self.read_query_params() | ||
| return self.get_point_department(point) | ||
| return self.default_value | ||
|
|
||
| def check_params(self) -> bool: | ||
| """Check if the query parameters have latitude and longitude fields. | ||
| Returns | ||
| ------- | ||
| bool | ||
| True if the query_parameters has fields for longitude and latitude. | ||
| """ | ||
| is_lat_in_key = self.lat_param in self.query_params | ||
| is_lon_in_key = self.lon_param in self.query_params | ||
| return is_lat_in_key and is_lon_in_key | ||
|
|
||
| def read_query_params(self) -> Point: | ||
| """Read the query parameters and returns the corresponding Point. | ||
| Returns | ||
| ------- | ||
| Point | ||
| Point corresponding to the query parameters. | ||
| """ | ||
| lat = float(self.query_params[self.lat_param][0]) | ||
| lon = float(self.query_params[self.lon_param][0]) | ||
| return Point(lon, lat) | ||
|
|
||
| def get_point_department(self, point: Point) -> str: | ||
| """Find department to which the point belongs to. | ||
| Parameters | ||
| ---------- | ||
| point : Point | ||
| Point to find the departement of. | ||
| Returns | ||
| ------- | ||
| str | ||
| Departement's code. | ||
| """ | ||
| contains_point = self.departments_geojson.contains(point) | ||
| if not contains_point.any(): | ||
| return self.default_value | ||
| first_containing = self.departments_geojson[contains_point].iloc[0] | ||
| return first_containing[self.geojson_code_field] | ||
|
|
||
|
|
||
| class DefaultStation(DefaultInput[int]): | ||
| """Default input for Station Selection. | ||
| Parameters | ||
| ---------- | ||
| stations_df : pd.DataFrame | ||
| DataFrame with all stations. | ||
| """ | ||
|
|
||
| def __init__(self, stations_df: pd.DataFrame) -> None: | ||
| self._stations_index = stations_df.index | ||
|
|
||
| @property | ||
| def stations_index(self) -> pd.Index: | ||
| """Indexes of the station DataFrame.""" | ||
| return self._stations_index | ||
|
|
||
| @property | ||
| def value(self) -> int: | ||
| """Value to use as default input.""" | ||
| return self.stations_index[0] | ||
|
|
||
|
|
||
| class DefaultDate(DefaultInput[dt.date]): | ||
| """Default Input for date selection. | ||
| Parameters | ||
| ---------- | ||
| min_date : dt.date | ||
| Data minimum date. | ||
| max_date : dt.date | ||
| Data maximum date. | ||
| """ | ||
|
|
||
| def __init__(self, min_date: dt.date, max_date: dt.date) -> None: | ||
| self._min = min_date | ||
| self._max = max_date | ||
|
|
||
|
|
||
| class DefaultMinDate(DefaultDate): | ||
| """Default Input for minimum date selection. | ||
| Parameters | ||
| ---------- | ||
| min_date : dt.date | ||
| Data minimum date. | ||
| max_date : dt.date | ||
| Data maximum date. | ||
| """ | ||
|
|
||
| @property | ||
| def value(self) -> dt.date: | ||
| """Value to use as default input.""" | ||
| max_minus_year = self._max - dt.timedelta(days=365) | ||
|
|
||
| return max(self._min, max_minus_year) | ||
|
|
||
|
|
||
| class DefaultMaxDate(DefaultDate): | ||
| """Default Input for maximum date selection. | ||
| Parameters | ||
| ---------- | ||
| min_date : dt.date | ||
| Data minimum date. | ||
| max_date : dt.date | ||
| Data maximum date. | ||
| """ | ||
|
|
||
| @property | ||
| def value(self) -> dt.date: | ||
| """Value to use as default input.""" | ||
| return self._max |
Oops, something went wrong.