python-weather 2.0.3__tar.gz → 2.0.5__tar.gz

{python_weather-2.0.3/python_weather.egg-info → python_weather-2.0.5}/PKG-INFO

@@ -1,22 +1,21 @@
 Metadata-Version: 2.1
 Name: python-weather
-Version: 2.0.3
+Version: 2.0.5
 Summary: A free and asynchronous weather API wrapper made in Python, for Python.
 Author: null8626
 License: MIT
-Project-URL: Donations, https://ko-fi.com/null8626
-Project-URL: Changelog, https://python-weather.readthedocs.io/en/latest/changelog.html
-Project-URL: Homepage, https://python-weather.readthedocs.io/en/latest/
 Project-URL: Documentation, https://python-weather.readthedocs.io/en/latest/
 Project-URL: Repository, https://github.com/null8626/python-weather
+Project-URL: Changelog, https://python-weather.readthedocs.io/en/latest/changelog.html
+Project-URL: Donate via GitHub Sponsors, https://github.com/sponsors/null8626
+Project-URL: Donate via Ko-fi, https://ko-fi.com/null8626
 Keywords: weather,forecast,weather-api,weather-forecast
 Classifier: Development Status :: 5 - Production/Stable
-Classifier: Framework :: aiohttp
-Classifier: Framework :: AsyncIO
 Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Information Technology
 Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
 Classifier: Topic :: Education
 Classifier: Topic :: Internet
 Classifier: Topic :: Scientific/Engineering
@@ -32,17 +31,20 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiohttp==3.9.5
+Requires-Dist: aiohttp>=3.10.10
 
-# [python-weather][pypi-url] [![pypi][pypi-image]][pypi-url] [![downloads][downloads-image]][pypi-url] [![ko-fi][ko-fi-brief-image]][ko-fi-url]
+# [python-weather][pypi-url] [![pypi][pypi-image]][pypi-url] [![downloads][downloads-image]][pypi-url] [![codacy-badge][codacy-url]][codacy-image] [![ko-fi][ko-fi-brief-image]][ko-fi-url]
 
 [pypi-image]: https://img.shields.io/pypi/v/python-weather.svg?style=flat-square
 [pypi-url]: https://pypi.org/project/python-weather/
 [downloads-image]: https://img.shields.io/pypi/dm/python-weather?style=flat-square
 [ko-fi-brief-image]: https://img.shields.io/badge/donations-ko--fi-red?color=ff5e5b&style=flat-square
+[codacy-url]: https://app.codacy.com/project/badge/Grade/0f7721b7e4314a748c75a04f0a7e0ce3
+[codacy-image]: https://app.codacy.com/gh/null8626/python-weather/dashboard
 [ko-fi-image]: https://ko-fi.com/img/githubbutton_sm.svg
 [ko-fi-url]: https://ko-fi.com/null8626
 
@@ -51,7 +53,7 @@ A free and asynchronous weather Python API wrapper made in Python, for Python.
 ## Installation
 
 ```console
-$ pip install python-weather
+pip install python-weather
 ```
 
 ## Example
@@ -65,7 +67,7 @@ import python_weather
 import asyncio
 import os
 
-async def getweather():
+async def getweather() -> None:
   # declare the client. the measuring unit used defaults to the metric system (celcius, km/h, etc.)
   async with python_weather.Client(unit=python_weather.IMPERIAL) as client:
     # fetch a weather forecast from a city
@@ -75,11 +77,11 @@ async def getweather():
     print(weather.temperature)
     
     # get the weather forecast for a few days
-    for daily in weather.daily_forecasts:
+    for daily in weather:
       print(daily)
       
       # hourly forecasts
-      for hourly in daily.hourly_forecasts:
+      for hourly in daily:
         print(f' --> {hourly!r}')
 
 if __name__ == '__main__':
@@ -91,6 +93,10 @@ if __name__ == '__main__':
   asyncio.run(getweather())
 ```
 
+## Data source
+
+This library depends on [`wttr.in`](https://github.com/chubin/wttr.in), which uses data from the [World Weather Online API](https://www.worldweatheronline.com/weather-api/).
+
 ## Donations
 
 If you want to support this project, consider donating! ❤

{python_weather-2.0.3 → python_weather-2.0.5}/README.md

@@ -1,9 +1,11 @@
-# [python-weather][pypi-url] [![pypi][pypi-image]][pypi-url] [![downloads][downloads-image]][pypi-url] [![ko-fi][ko-fi-brief-image]][ko-fi-url]
+# [python-weather][pypi-url] [![pypi][pypi-image]][pypi-url] [![downloads][downloads-image]][pypi-url] [![codacy-badge][codacy-url]][codacy-image] [![ko-fi][ko-fi-brief-image]][ko-fi-url]
 
 [pypi-image]: https://img.shields.io/pypi/v/python-weather.svg?style=flat-square
 [pypi-url]: https://pypi.org/project/python-weather/
 [downloads-image]: https://img.shields.io/pypi/dm/python-weather?style=flat-square
 [ko-fi-brief-image]: https://img.shields.io/badge/donations-ko--fi-red?color=ff5e5b&style=flat-square
+[codacy-url]: https://app.codacy.com/project/badge/Grade/0f7721b7e4314a748c75a04f0a7e0ce3
+[codacy-image]: https://app.codacy.com/gh/null8626/python-weather/dashboard
 [ko-fi-image]: https://ko-fi.com/img/githubbutton_sm.svg
 [ko-fi-url]: https://ko-fi.com/null8626
 
@@ -12,7 +14,7 @@ A free and asynchronous weather Python API wrapper made in Python, for Python.
 ## Installation
 
 ```console
-$ pip install python-weather
+pip install python-weather
 ```
 
 ## Example
@@ -26,7 +28,7 @@ import python_weather
 import asyncio
 import os
 
-async def getweather():
+async def getweather() -> None:
   # declare the client. the measuring unit used defaults to the metric system (celcius, km/h, etc.)
   async with python_weather.Client(unit=python_weather.IMPERIAL) as client:
     # fetch a weather forecast from a city
@@ -36,11 +38,11 @@ async def getweather():
     print(weather.temperature)
     
     # get the weather forecast for a few days
-    for daily in weather.daily_forecasts:
+    for daily in weather:
       print(daily)
       
       # hourly forecasts
-      for hourly in daily.hourly_forecasts:
+      for hourly in daily:
         print(f' --> {hourly!r}')
 
 if __name__ == '__main__':
@@ -52,8 +54,12 @@ if __name__ == '__main__':
   asyncio.run(getweather())
 ```
 
+## Data source
+
+This library depends on [`wttr.in`](https://github.com/chubin/wttr.in), which uses data from the [World Weather Online API](https://www.worldweatheronline.com/weather-api/).
+
 ## Donations
 
 If you want to support this project, consider donating! ❤
 
-[![ko-fi][ko-fi-image]][ko-fi-url]
+[![ko-fi][ko-fi-image]][ko-fi-url]

{python_weather-2.0.3 → python_weather-2.0.5}/pyproject.toml

@@ -3,21 +3,20 @@ requires = ["setuptools"]
 
 [project]
 name = "python-weather"
-version = "2.0.3"
+version = "2.0.5"
 description = "A free and asynchronous weather API wrapper made in Python, for Python."
 readme = "README.md"
 license = { text = "MIT" }
 authors = [{ name = "null8626" }]
 keywords = ["weather", "forecast", "weather-api", "weather-forecast"]
-dependencies = ["aiohttp==3.9.5"]
+dependencies = ["aiohttp>=3.10.10"]
 classifiers = [
   "Development Status :: 5 - Production/Stable",
-  "Framework :: aiohttp",
-  "Framework :: AsyncIO",
   "Intended Audience :: Education",
   "Intended Audience :: Developers",
   "Intended Audience :: Information Technology",
   "Natural Language :: English",
+  "Operating System :: OS Independent",
   "Topic :: Education",
   "Topic :: Internet",
   "Topic :: Scientific/Engineering",
@@ -32,13 +31,14 @@ classifiers = [
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
-  "Programming Language :: Python :: 3.12"
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13"
 ]
 requires-python = ">=3.8"
 
 [project.urls]
-Donations = "https://ko-fi.com/null8626"
-Changelog = "https://python-weather.readthedocs.io/en/latest/changelog.html"
-Homepage = "https://python-weather.readthedocs.io/en/latest/"
 Documentation = "https://python-weather.readthedocs.io/en/latest/"
-Repository = "https://github.com/null8626/python-weather"
+Repository = "https://github.com/null8626/python-weather"
+Changelog = "https://python-weather.readthedocs.io/en/latest/changelog.html"
+"Donate via GitHub Sponsors" = "https://github.com/sponsors/null8626"
+"Donate via Ko-fi" = "https://ko-fi.com/null8626"

python_weather-2.0.5/python_weather/__init__.py

@@ -0,0 +1,47 @@
+"""
+The MIT License (MIT)
+
+Copyright (c) 2021-2024 null8626
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+from .enums import HeatIndex, Kind, Locale, Phase, UltraViolet, WindDirection
+from .constants import METRIC, IMPERIAL
+from .errors import Error, RequestError
+from .client import Client
+
+__title__ = 'python-weather'
+__author__ = 'null8626'
+__license__ = 'MIT'
+__copyright__ = 'Copyright (c) 2021-2024 null8626'
+__version__ = '2.0.5'
+__all__ = (
+  'METRIC',
+  'IMPERIAL',
+  'Client',
+  'Error',
+  'RequestError',
+  'HeatIndex',
+  'Kind',
+  'Locale',
+  'Phase',
+  'UltraViolet',
+  'WindDirection',
+)

python_weather-2.0.5/python_weather/base.py

@@ -0,0 +1,149 @@
+"""
+The MIT License (MIT)
+
+Copyright (c) 2021-2024 null8626
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+from enum import auto
+from typing import Tuple
+
+from .errors import Error
+from .enums import WindDirection, Kind, Locale, UltraViolet
+from .constants import _Unit
+
+
+class CustomizableBase:
+  __slots__: Tuple[str, ...] = ('__unit', '__locale')
+
+  def __init__(self, unit: _Unit, locale: Locale):
+    self.unit = unit
+    self.locale = locale
+
+  @property
+  def unit(self) -> auto:
+    """The measuring unit used to display information in this object."""
+
+    return self.__unit
+
+  @unit.setter
+  def unit(self, to: _Unit) -> None:
+    """
+    Sets the default measuring unit used to display information in this object.
+
+    :param to: The new default measuring unit to be used to display information in this object. Must be either ``METRIC`` or ``IMPERIAL``.
+    :exception Error: If the ``to`` argument is not either ``METRIC`` or ``IMPERIAL``.
+    """
+
+    if not isinstance(to, _Unit):
+      raise Error('Invalid measuring unit specified!')
+
+    self.__unit = to
+
+  @property
+  def locale(self) -> Locale:
+    """The localization used to display information in this object."""
+
+    return self.__locale
+
+  @locale.setter
+  def locale(self, to: Locale) -> None:
+    """
+    Sets the default localization used to display information in this object.
+
+    :param to: The new :class:`Locale` to be used to display information in this object.
+    :type to: Locale
+    :exception Error: If the ``to`` argument is not a part of the :class:`Locale` enum.
+    """
+
+    if not isinstance(to, Locale):
+      raise Error(f'Expected {to!r} to be a Locale enum')
+
+    self.__locale = to
+
+
+class BaseForecast:
+  __slots__: Tuple[str, ...] = (
+    'ultraviolet',
+    'humidity',
+    'wind_direction',
+    'kind',
+    'feels_like',
+    'temperature',
+    'precipitation',
+    'pressure',
+    'visibility',
+    'wind_speed',
+    'description',
+  )
+
+  ultraviolet: UltraViolet
+  """The ultra-violet (UV) index."""
+
+  humidity: int
+  """The humidity value in percent."""
+
+  wind_direction: WindDirection
+  """The wind direction."""
+
+  kind: Kind
+  """The kind of the forecast."""
+
+  feels_like: int
+  """What it felt like, in celcius or fahrenheit."""
+
+  temperature: int
+  """The temperature in either celcius or Fahrenheit."""
+
+  precipitation: float
+  """The precipitation in either millimeters or inches."""
+
+  pressure: float
+  """The pressure in either pascal or inches."""
+
+  visibility: int
+  """The visibility distance in either kilometers or miles."""
+
+  wind_speed: int
+  """The wind speeds in either kilometers/hour or miles/hour."""
+
+  description: str
+  """The description regarding the forecast. This can be localized in different languages depending on the localization used."""
+
+  def __init__(self, json: dict, unit: _Unit, locale: Locale):
+    description = (
+      json['weatherDesc'][0]['value']
+      if locale is Locale.ENGLISH
+      else json[f'lang_{locale.value}'][0]['value']
+    )
+
+    self.ultraviolet = UltraViolet._new(int(json['uvIndex']))
+    self.humidity = int(json['humidity'])
+    self.wind_direction = WindDirection._new(
+      json['winddir16Point'], int(json['winddirDegree'])
+    )
+    self.kind = Kind(int(json['weatherCode']))
+    self.feels_like = int(json[f'FeelsLike{unit.temperature}'])
+    self.temperature = int(json[f'temp_{unit.temperature}'])
+    self.precipitation = float(json[f'precip{unit.precipitation}'])
+    self.pressure = float(json[f'pressure{unit.pressure}'])
+    self.visibility = int(json[f'visibility{unit.visibility}'])
+    self.wind_speed = int(json[f'windspeed{unit.velocity}'])
+    self.description = description.strip()

{python_weather-2.0.3 → python_weather-2.0.5}/python_weather/client.py

@@ -1,13 +1,37 @@
+"""
+The MIT License (MIT)
+
+Copyright (c) 2021-2024 null8626
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
 from aiohttp import ClientSession, ClientTimeout, TCPConnector
 from urllib.parse import quote_plus
-from typing import Optional
+from typing import Optional, Tuple
 from asyncio import sleep
 from enum import auto
 
+from .errors import Error, RequestError
 from .constants import _Unit, METRIC
 from .base import CustomizableBase
 from .forecast import Forecast
-from .errors import Error
 from .enums import Locale
 
 
@@ -22,10 +46,10 @@ class Client(CustomizableBase):
   :param session: Whether to use an existing aiohttp client session for requesting or not. Defaults to ``None`` (creates a new one instead)
   :type session: Optional[:class:`aiohttp.ClientSession`]
 
-  :raises Error: If the ``unit`` argument is not ``None`` and it's also not ``METRIC`` or ``IMPERIAL``, or if the ``locale`` argument is not ``None`` and it's also not a part of the :class:`Locale` enum.
+  :raises Error: If ``unit`` is not ``METRIC`` or ``IMPERIAL``, or if ``locale`` is not ``None`` and not a part of the :class:`Locale` enum.
   """
 
-  __slots__ = ('__session',)
+  __slots__: Tuple[str, ...] = ('__own_session', '__session')
 
   def __init__(
     self,
@@ -36,13 +60,14 @@ class Client(CustomizableBase):
   ):
     super().__init__(unit, locale)
 
+    self.__own_session = session is None
     self.__session = session or ClientSession(
       timeout=ClientTimeout(total=5000.0),
       connector=TCPConnector(verify_ssl=False),
     )
 
   def __repr__(self) -> str:
-    return f'<{self.__class__.__name__} {self.__session!r}>'
+    return f'<{__class__.__name__} {self.__session!r}>'
 
   async def get(
     self,
@@ -56,9 +81,9 @@ class Client(CustomizableBase):
 
     :param location: The requested location name for said weather forecast.
     :type location: str
-    :param unit: Overrides the metric or imperial/customary system (``IMPERIAL``) used by the :class:`Client` object. Defaults to ``None`` (uses the one from the :class:`Client`).
+    :param unit: Overrides the unit used by this object. Defaults to the one used by this object.
     :type unit: Optional[:py:class:`enum.auto`]
-    :param locale: Overrides the locale/language used by the :class:`Client` object. Defaults to ``None`` (uses the one from the :class:`Client`).
+    :param locale: Overrides the locale used by this object. Defaults to the one used by this object.
     :type locale: Optional[Locale]
 
     :exception Error: If the aiohttp client session used by the :class:`Client` object is already closed, if the ``unit`` argument is not ``None`` and it's also not ``METRIC`` or ``IMPERIAL``, if the ``locale`` argument is not ``None`` and it's also not a part of the :class:`Locale` enum, or if the :class:`Client` cannot send a web request to the web server.
@@ -82,25 +107,27 @@ class Client(CustomizableBase):
     delay = 0.5
 
     while True:
-      async with self.__session.get(
-        f'https://{subdomain}wttr.in/{quote_plus(location)}?format=j1'
-      ) as resp:
-        try:
+      try:
+        async with self.__session.get(
+          f'https://{subdomain}wttr.in/{quote_plus(location)}?format=j1'
+        ) as resp:
+          resp.raise_for_status()
+
           return Forecast(await resp.json(), unit, locale)
-        except Exception as e:
-          if delay == 2:
-            raise e  # okay, that's too much requests - just raise the error
+      except Exception as err:
+        if delay == 4:
+          raise RequestError(err)
 
-          await sleep(delay)
-          delay *= 2
+        await sleep(delay)
+        delay *= 2
 
-  async def close(self):
-    """Closes the :class:`Client` object. Nothing will happen if it's already closed."""
+  async def close(self) -> None:
+    """Closes the :class:`Client` object. Nothing will happen if the client uses a pre-existing :class:`aiohttp.ClientSession` or if the session is already closed."""
 
-    if not self.__session.closed:
+    if self.__own_session and not self.__session.closed:
       await self.__session.close()
 
-  async def __aenter__(self):
+  async def __aenter__(self) -> 'Client':
     return self
 
   async def __aexit__(self, *_, **__):

python_weather-2.0.5/python_weather/constants.py

@@ -0,0 +1,63 @@
+"""
+The MIT License (MIT)
+
+Copyright (c) 2021-2024 null8626
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+from typing import Union, Tuple
+import re
+
+
+class _Unit:
+  __slots__: Tuple[str, ...] = (
+    'temperature',
+    'velocity',
+    'pressure',
+    'precipitation',
+    'visibility',
+    'cm_divisor',
+  )
+
+  def __init__(
+    self,
+    temperature: str,
+    velocity: str,
+    pressure: str,
+    precipitation: str,
+    visibility: str,
+    cm_divisor: Union[int, float],
+  ):
+    self.temperature = temperature
+    self.velocity = velocity
+    self.pressure = pressure
+    self.precipitation = precipitation
+    self.visibility = visibility
+    self.cm_divisor = cm_divisor
+
+  def __repr__(self) -> str:
+    return f'<Unit [{self.temperature}, {self.velocity}]>'
+
+
+METRIC = _Unit('C', 'Kmph', '', 'MM', '', 1)
+IMPERIAL = _Unit('F', 'Miles', 'Inches', 'Inches', 'Miles', 2.54)
+
+WIND_DIRECTION_EMOJIS = ('↓', '↙', '←', '↖', '↑', '↗', '→', '↘')
+LATLON_REGEX = re.compile(r'^Lat (\-?[\d\.]+) and Lon (\-?[\d\.]+)$')