rbi4dZddlmZddlmZddlmZddlmZddlmZddlm Z dd lm Z dd lm Z dd lm Z dd lm Z dd lmZddlmZddlmZddlmZGddZdS)u'Client for the Météo-France REST API.)List)Optional)COASTAL_DEPARTMENT_LIST)METEOFRANCE_API_TOKEN)METEOFRANCE_API_URL)CurrentPhenomenons)Forecast)Full) Observation)PictureOfTheDayPlace)Rain)WarningDictionary)MeteoFranceSessionc ^eZdZdZddeeddfdZ ddedeedeedeefd Z dde de d ede fd Z dd ed ede fdZ dde de d edefdZ dd ed edefdZdde de d edefdZ d dedededefdZ d!dededefdZd"dedefdZdd edefdZd"dedefdZdS)#MeteoFranceClientuProxy to the Météo-France REST API. You will find methods and helpers to request weather forecast, rain forecast and weather alert bulletin. N access_tokenreturnc.t||_dS)zInitialize the API and store the auth so we can make requests. Args: access_token: a string containing the authentication token for the REST API. N)rsession)selfrs f/var/www/html/mdtn/previsions/meteo_cartes/venv/lib/python3.11/site-packages/meteofrance_api/client.py__init__zMeteoFranceClient.__init__"s *,77 search_querylatitude longitudecd|i}|||d<|||d<|jdd|}d|DS) aSearch the places (cities) linked to a query by name. You can add GPS coordinates in parameter to search places around a given location. Args: search_query: A complete name, only a part of a name or a postal code (for France only) corresponding to a city in the world. latitude: Optional; Latitude in degree of a reference point to order results. The nearest places first. longitude: Optional; Longitude in degree of a reference point to order results. The nearest places first. Returns: A list of places (Place instance) corresponding to the query. qNlatlongetplacesparamsc,g|]}t|Sr).0 place_datas r z3MeteoFranceClient.search_places..Ls @@@jj!!@@@r)rrequestjson)rrrrr'resps r search_placeszMeteoFranceClient.search_places-sf.|$  $F5M  %F5M|##E8F#CC@@DIIKK@@@@rfrlanguagec|jdd|||d}t|S)ajRetrieve the weather observation for a given GPS location. Results can be fetched in french or english according to the language parameter. Args: latitude: Latitude in degree of the GPS point corresponding to the weather forecast. longitude: Longitude in degree of the GPS point corresponding to the weather forecast. language: Optional; If language is equal "fr" (default value) results will be in French. All other value will give results in English. Returns: An Observation instance. r$zv2/observationr"r#langr&)rr-r r.rrrr2r/s rget_observationz!MeteoFranceClient.get_observationQsK*|##  #IxHH$   499;;'''rplacecD||j|j|S)aRetrieve the weather observation for a given Place instance. Results can be fetched in french or english according to the language parameter. Args: place: Place class instance corresponding to a location. language: Optional; If language is equal "fr" (default value) results will be in French. All other value will give results in English. Returns: An Observation instance. )r7rrrr8r2s rget_observation_for_placez+MeteoFranceClient.get_observation_for_placems "##ENEOXNNNrc|jdd|||d}t|S)aRetrieve the weather forecast for a given GPS location. Results can be fetched in french or english according to the language parameter. Args: latitude: Latitude in degree of the GPS point corresponding to the weather forecast. longitude: Longitude in degree of the GPS point corresponding to the weather forecast. language: Optional; If language is equal "fr" (default value) results will be in French. All other value will give results in English. Returns: A Forecast instance representing the hourly and daily weather forecast. r$forecastr4r&)rr-r r.r6s r get_forecastzMeteoFranceClient.get_forecastsK0|##  #IxHH$    $$$rcD||j|j|S)aRetrieve the weather forecast for a given Place instance. Results can be fetched in french or english according to the language parameter. Args: place: Place class instance corresponding to a location. language: Optional; If language is equal "fr" (default value) results will be in French. All other value will give results in English. Returns: A Forecast instance representing the hourly and daily weather forecast. )r>rrr:s rget_forecast_for_placez(MeteoFranceClient.get_forecast_for_places "  (KKKrc|jdd|||d}t|S)aRetrieve the next 1 hour rain forecast for a given GPS the location. Results can be fetched in french or english according to the language parameter. Args: latitude: Latitude in degree of the GPS point corresponding to the rain forecast. longitude: Longitude in degree of the GPS point corresponding to the rain forecast. language: Optional; If language is equal "fr" (default value) results will be in French. All other value will give results in English. Returns: A Rain instance representing the next hour rain forecast. r$rainr4r&)rr-rr.r6s rget_rainzMeteoFranceClient.get_rainsI&|## 6(9h"W"W$  DIIKK   rrFdomaindepthwith_coastal_bulletincJ|jdd||d}t|}|r_|tvrV|jddd|dzi}|t||S)aReturn the current weather phenomenons (or alerts) for a given domain. Args: domain: could be `france` or any metropolitan France department numbers on two digits. For some departments you can access an additional bulletin for coastal phenomenons. To access it add `10` after the domain id (example: `1310`). depth: Optional; To be used with domain = 'france'. With depth = 0 the results will show only national sum up of the weather alerts. If depth = 1, you will have in addition, the bulletin for all metropolitan France department and Andorre with_coastal_bulletin: Optional; If set to True (default is False), you can get the basic bulletin and coastal bulletin merged. Returns: A warning.CurrentPhenomenons instance representing the weather alert bulletin. r$zv3/warning/currentphenomenons)rDrEr&rD10)rr-r r.rmerge_with_coastal_phenomenons)rrDrErFr/ phenomenonss rget_warning_current_phenomenonsz1MeteoFranceClient.get_warning_current_phenomenonss,|##  +$u55$  )55 000|++3$ftm4, ::&tyy{{33rcH|jddd|i}t|}|r_|tvrV|jddd|dzi}|t||S)a.Retrieve a complete bulletin of the weather phenomenons for a given domain. For a given domain we can access the maximum alert, a timelaps of the alert evolution for the next 24 hours, a list of alerts and other metadata. Args: domain: could be `france` or any metropolitan France department numbers on two digits. For some departments you can access an additional bulletin for coastal phenomenons. To access it add `10` after the domain id (example: `1310`). with_coastal_bulletin: Optional; If set to True (default is False), you can get the basic bulletin and coastal bulletin merged. Returns: A warning.Full instance representing the complete weather alert bulletin. r$z/v3/warning/fullrDr&zv3/warning/fullrH)rr-r r.rrI)rrDrFr/full_phenomenonss rget_warning_fullz"MeteoFranceClient.get_warning_fulls,|## %x.@$     ,, ! S000|++%$ftm4, !??TYY[[@Q@QRRRrfrancec*tdtd|S)a-Retrieve the thumbnail URL of the weather phenomenons or alerts map. Args: domain: could be `france` or any metropolitan France department numbers on two digits. Returns: The URL of the thumbnail representing the weather alert status. z/v3/warning/thumbnail?&token=z&domain=)rr)rrDs rget_warning_thumbnailz'MeteoFranceClient.get_warning_thumbnail(s0#  AV     rc|jddd|i}t|}|S)uRetrieves the meteorological dictionary from the Météo-France API. This dictionary includes information about various meteorological phenomena and color codes used for weather warnings. Args: language (str): The language in which to retrieve the dictionary data. Default is 'fr' for French. Other language codes can be used if supported by the API. Returns: WarningDictionary: An object containing structured data about meteorological phenomena and warning color codes. It has two main attributes: 'phenomenons' (list of PhenomenonDictionaryEntry) and 'colors' (list of ColorDictionaryEntry). r$zv3/warning/dictionaryr5r&)rr-rr.)rr2r/ dictionarys rget_warning_dictionaryz(MeteoFranceClient.get_warning_dictionary8sJ"|## *FH3E$  'tyy{{33 rc |jdd|dddd}td|d t}t ||jd S) zRetrieve the picture of the day image URL & description. Args: domain: could be `france` Returns: PictureOfTheDay instance with the URL and the description of the picture of the day. r$z v2/report observationz image du jourtxt)rD report_typereport_subtypeformatr&z/v2/report?domain=zK&report_type=observation&report_subtype=image%20du%20jour&format=jpg&token=) image_url description)rr-rrr text)rrDr/r[s rget_picture_of_the_dayz(MeteoFranceClient.get_picture_of_the_dayRs|##   ,"1 $   # . . . ., . . YtyQQRRRr)N)NN)r1)rF)F)rO)__name__ __module__ __qualname____doc__rstrrrrr0floatr r7r;r r>r@rrCintboolr rKr rNrQrrTr r^r)rrrrs 88Xc]8d8888#'#' AAA3-AC= A e AAAAP (((( (  ((((>OOOO  OOOO4 %%%% %  %%%%DLLLL  LLLL,!!!5!C!SW!!!!8JO***"%*BF* ****Z:?' ' ' 26' ' ' ' ' R  C s    s>O4SSSSSSSSSSrrN)rbtypingrrconstrrrmodelr r r r r rrrrrrr)rrrjsM--******((((((&&&&&&%%%%%%""""""$$$$$$''''''VSVSVSVSVSVSVSVSVSVSr