senaite.core.api.geo

Complexity

Total Complexity

65

Size/Duplication

Total Lines	341
Duplicated Lines	15.84 %

Importance

Changes

0

12 Functions

Rating	Name	Duplication	Size	Complexity
B	get_country()	0	24	7
D	get_subdivision()	0	45	12
A	is_subdivision()	0	7	2
B	to_longitude_dms()	27	27	6
B	to_latitude_dms()	27	27	6
A	to_dms()	0	35	4
B	get_subdivisions()	0	27	7
B	get_country_or_subdivision()	0	30	8
A	is_country()	0	7	2
A	get_countries()	0	7	2
A	get_country_code()	0	12	3
B	to_decimal_degrees()	0	38	6

# -*- coding: utf-8 -*-
#
# This file is part of SENAITE.CORE.
#
# SENAITE.CORE is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation, version 2.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Software Foundation, Inc., 51
# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright 2018-2024 by it's authors.
# Some rights reserved, see README and LICENSE.

import math
import pycountry

from bika.lims.api import is_floatable
from bika.lims.api import to_float
from bika.lims.api import to_utf8
from six import string_types

_marker = object()


def get_countries():
    """Return the list of countries sorted by name ascending
    :return: list of countries sorted by name ascending
    :rtype: list of Country objects
    """
    countries = pycountry.countries
    return sorted(list(countries), key=lambda s: s.name)


def get_country(thing, default=_marker):
    """Returns the country object
    :param thing: country, subdivision object or search term
    :type thing: Country/Subdivision/string
    :returns: the country that matches with the parameter passed in
    :rtype: pycountry.db.Country
    """
    if is_country(thing):
        return thing

    if is_subdivision(thing):
        return get_country(thing.country_code)

    if not isinstance(thing, string_types):
        if default is _marker:
            raise TypeError("{} is not supported".format(repr(thing)))
        return default

    try:
        return pycountry.countries.lookup(thing)
    except LookupError as e:
        if default is _marker:
            raise ValueError(str(e))
        return default


def get_country_code(thing, default=_marker):
    """Returns the 2-character code (alpha2) of the country
    :param thing: country, subdivision object or search term
    :return: the 2-character (alpha2) code of the country
    :rtype: string
    """
    thing = get_country_or_subdivision(thing, default=default)
    if is_country(thing):
        return thing.alpha_2
    if is_subdivision(thing):
        return thing.country_code
    return default


def get_subdivision(subdivision_or_term, parent=None, default=_marker):
    """Returns the Subdivision object
    :param subdivision_or_term: subdivision or search term
    :param subdivision_or_term: Subdivision/string
    :param parent: filter by parent subdivision or country
    :returns: the subdivision that matches with the parameter passed in
    :rtype: pycountry.db.Subdivision
    """
    if is_subdivision(subdivision_or_term):
        return subdivision_or_term

    if not isinstance(subdivision_or_term, string_types):
        if default is _marker:
            raise TypeError("{} is not supported".format(
                repr(subdivision_or_term)))
        return default

    # Search by parent
    if parent:

        def is_match(subdivision):
            terms = [subdivision.name, subdivision.code]
            needle = to_utf8(subdivision_or_term)
            return needle in map(to_utf8, terms)

        subdivisions = get_subdivisions(parent, default=[])
        subdivisions = filter(lambda subdiv: is_match(subdiv), subdivisions)

The variable is_match does not seem to be defined for all execution paths.

        if len(subdivisions) == 1:
            return subdivisions[0]
        elif len(subdivisions) > 1:
            if default is _marker:
                raise ValueError("More than one subdivision found")
            return default
        else:
            if default is _marker:
                raise ValueError("No subdivisions found")
            return None

    # Search directly by term
    try:
        return pycountry.subdivisions.lookup(subdivision_or_term)
    except LookupError as e:
        if default is _marker:
            raise ValueError(str(e))
        return default


def is_country(thing):
    """Returns whether the value passed in is a country object
    """
    if not thing:
        return False
    # pycountry generates the classes dynamically, we cannot use isinstance
    return "Country" in repr(type(thing))


def is_subdivision(thing):
    """Returns whether the value passed in is a subdivision object
    """
    if not thing:
        return False
    # pycountry generates the classes dynamically, we cannot use isinstance
    return "Subdivision" in repr(type(thing))


def get_subdivisions(thing, default=_marker):
    """Returns the first-level subdivisions of the country or subdivision,
    sorted by code ascending
    :param thing: country, subdivision object or search term
    :return: the list of first-level subdivisions of the subdivision/country
    :rtype: list of pycountry.db.Subdivision
    """
    try:
        country_or_subdivision = get_country_or_subdivision(thing)
        country_code = get_country_code(country_or_subdivision)
    except (ValueError, TypeError) as e:
        if default is _marker:
            raise e
        return default

    # Extract the subdivisions
    subdivisions = pycountry.subdivisions.get(country_code=country_code)

    # Bail out those that are not first-level
    if is_subdivision(country_or_subdivision):
        code = country_or_subdivision.code
        subdivisions = filter(lambda sub: sub.parent_code == code, subdivisions)

The variable code does not seem to be defined for all execution paths.

    else:
        subdivisions = filter(lambda sub: sub.parent_code is None, subdivisions)

    # Sort by code
    return sorted(subdivisions, key=lambda s: s.code)


def get_country_or_subdivision(thing, default=_marker):
    """Returns the country or subdivision for the thing passed-in
    :param thing: the thing or search term to look for a country or subdivision
    :type thing: Country/Subdivision/string
    :return: the country or subdivision for the given thing
    """
    if is_country(thing):
        return thing
    if is_subdivision(thing):
        return thing

    if not isinstance(thing, string_types):
        if default is _marker:
            raise TypeError("{} is not supported".format(repr(thing)))
        return default

    # Maybe a country
    country = get_country(thing, default=None)
    if country:
        return country

    # Maybe a subdivision
    subdivision = get_subdivision(thing, default=None)
    if subdivision:
        return subdivision

    if default is _marker:
        raise ValueError("Could not find a record for '{}'".format(
            thing.lower()))
    return default


def to_dms(degrees, precision=4, default=_marker):
    """Converts a geographical coordinate in decimal degrees to a dict with
    degrees, minutes and seconds as the keys

    :param degrees: coordinate in decimal degrees
    :type degrees: string,int,float
    :param precision: number of decimals for seconds
    :type precision: int
    :return: a dict with degrees, minutes and seconds as keys
    """
    if not is_floatable(degrees):
        if default is _marker:
            raise ValueError("Expected decimal degrees to be a floatable, but "
                             "got %r" % degrees)
        return default

    # calculate the DMS
    decimal_degrees = to_float(degrees)
    degrees = math.trunc(decimal_degrees)
    minutes = math.trunc((decimal_degrees - degrees) * 60)
    seconds = decimal_degrees * 3600 % 60

    # check precision type
    if not isinstance(precision, int):
        raise TypeError("Expected precision to be an `int`, but got %r"
                        % type(precision))

    # apply the precision to seconds
    template = "{:.%df}" % precision
    seconds = template.format(seconds)

    return {
        "degrees": degrees,
        "minutes": minutes,
        "seconds": to_float(seconds),
    }


def to_latitude_dms(degrees, precision=4, default=_marker):

This code seems to be duplicated in your project.

    """Converts a geographical latitude in decimal degrees to a dict with
    degrees, minutes, seconds and bearing as the keys

    :param degrees: latitude in decimal degrees
    :type degrees: string,int,float
    :param precision: number of decimals for seconds
    :type precision: int
    :return: a dict with degrees, minutes, seconds and bearing as keys
    """
    if not is_floatable(degrees):
        if default is _marker:
            raise ValueError("Expected decimal degrees to be a floatable, but "
                             "got %r" % degrees)
        return default

    # check latitude is in range
    latitude = to_float(degrees)
    if abs(latitude) > 90:
        if default is _marker:
            raise ValueError("Latitude must be within -90 and 90 degrees")
        return default

    # calculate the DMS
    dms = to_dms(abs(latitude), precision=precision)
    dms["bearing"] = "N" if latitude >= 0 else "S"
    return dms


def to_longitude_dms(degrees, precision=4, default=_marker):

This code seems to be duplicated in your project.

    """Converts a geographical longitude in decimal degrees to a dict with
    degrees, minutes, seconds and bearing as the keys

    :param degrees: longitude in decimal degrees
    :type degrees: string,int,float
    :param precision: number of decimals for seconds
    :type precision: int
    :return: a dict with degrees, minutes, seconds and bearing as keys
    """
    if not is_floatable(degrees):
        if default is _marker:
            raise ValueError("Expected decimal degrees to be a floatable, but "
                             "got %r" % degrees)
        return default

    # check longitude is in range
    longitude = to_float(degrees)
    if abs(longitude) > 180:
        if default is _marker:
            raise ValueError("Longitude must be within -180 and 180 degrees")
        return default

    # calculate the DMS
    dms = to_dms(abs(longitude), precision=precision)
    dms["bearing"] = "E" if longitude >= 0 else "W"
    return dms


def to_decimal_degrees(dms, precision=7, default=_marker):
    """Converts a geographical coordinate in DMS format to decimal degrees

    :param dms: coordinate in DMS
    :type dms: dict
    :param precision: number of decimals for decimal degrees
    :type precision: int
    :return: a float representing a geographical coordinate in decimal degrees
    """
    if not isinstance(dms, dict):
        if default is _marker:
            raise TypeError("Expected dms to be a dict, but got %r" % dms)
        return default

    # get the degrees, minutes and seconds
    degrees = to_float(dms.get("degrees"), default=0)
    minutes = to_float(dms.get("minutes"), default=0)
    seconds = to_float(dms.get("seconds"), default=0)

    # calculate the decimal degrees
    decimal_degrees = abs(degrees + (minutes / 60) + (seconds / 3600))

    # Use +/- to express N/S, W/E
    bearing = dms.get("bearing")
    if bearing and bearing in "SW":
        decimal_degrees = -decimal_degrees

    # check precision type
    if not isinstance(precision, int):
        raise TypeError("Expected precision to be an `int`, but got %r"
                        % type(precision))

    # apply the precision
    template = "{:.%df}" % precision
    decimal_degrees = template.format(decimal_degrees)

    # return the float value
    return to_float(decimal_degrees)