lories.location
===============

.. py:module:: lories.location

.. autoapi-nested-parse::

   lories.core.location
   ~~~~~~~~~~~~~~~~~~~~




Exceptions
----------

.. autoapisummary::

   lories.location.LocationException
   lories.location.LocationUnavailableException


Classes
-------

.. autoapisummary::

   lories.location.Location


Module Contents
---------------

.. py:exception:: LocationException

   Bases: :py:obj:`lories.core.ResourceError`

   .. autoapi-inheritance-diagram:: lories.location.LocationException
      :parts: 1
      :private-bases:


   Raise if an error occurred accessing the location.


   Initialize self.  See help(type(self)) for accurate signature.


.. py:exception:: LocationUnavailableException

   Bases: :py:obj:`lories.core.ResourceUnavailableError`, :py:obj:`LocationException`

   .. autoapi-inheritance-diagram:: lories.location.LocationUnavailableException
      :parts: 1
      :private-bases:


   Raise if a configured location access can not be found.


   Initialize self.  See help(type(self)) for accurate signature.


.. py:class:: Location(latitude: float, longitude: float, timezone: str | pytz.BaseTzInfo = tz.UTC, altitude: Optional[float] = None, country: Optional[str] = None, state: Optional[str] = None)

   Location objects are convenient containers for latitude, longitude,
   timezone, and altitude data associated with a particular
   geographic location.

   :param latitude: Positive is north of the equator.
                    Use decimal degrees notation.
   :type latitude: float.
   :param longitude: Positive is east of the prime meridian.
                     Use decimal degrees notation.
   :type longitude: float.
   :param timezone: See
                    http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
                    for a list of valid time zones.
   :type timezone: str or pytz.timezone, default is 'UTC'.
   :param altitude: Altitude from sea level in meters.
   :type altitude: float, default 0.