senaite.core.api.geo.is_country() - Code Metrics - Inspection of "Added `geo` api that relies on `pycountry` for re..." - senaite/senaite.core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 2.x (#1961)

by Ramon

created 2022-04-09 20:51 UTC

senaite.core.api.geo.is_country() A

↳ Parent: senaite.core.api.geo

Complexity

Conditions

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	4
dl	0
loc	7
rs	10
c	0
b	0
f	0
cc	2
nop	1

# -*- 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-2022 by it's authors.
# Some rights reserved, see README and LICENSE.

from six import string_types

import pycountry
from bika.lims.api import to_utf8

_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)

        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)

    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


1			# -- coding: utf-8 --
2			#
3			# This file is part of SENAITE.CORE.
4			#
5			# SENAITE.CORE is free software: you can redistribute it and/or modify it under
6			# the terms of the GNU General Public License as published by the Free Software
7			# Foundation, version 2.
8			#
9			# This program is distributed in the hope that it will be useful, but WITHOUT
10			# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11			# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
12			# details.
13			#
14			# You should have received a copy of the GNU General Public License along with
15			# this program; if not, write to the Free Software Foundation, Inc., 51
16			# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17			#
18			# Copyright 2018-2022 by it's authors.
19			# Some rights reserved, see README and LICENSE.
20
21			from six import string_types
22
23			import pycountry
24			from bika.lims.api import to_utf8
25
26			_marker = object()
27
28
29			def get_countries():
30			"""Return the list of countries sorted by name ascending
31			:return: list of countries sorted by name ascending
32			:rtype: list of Country objects
33			"""
34			countries = pycountry.countries
35			return sorted(list(countries), key=lambda s: s.name)
36
37
38			def get_country(thing, default=_marker):
39			"""Returns the country object
40			:param thing: country, subdivision object or search term
41			:type thing: Country/Subdivision/string
42			:returns: the country that matches with the parameter passed in
43			:rtype: pycountry.db.Country
44			"""
45			if is_country(thing):
46			return thing
47
48			if is_subdivision(thing):
49			return get_country(thing.country_code)
50
51			if not isinstance(thing, string_types):
52			if default is _marker:
53			raise TypeError("{} is not supported".format(repr(thing)))
54			return default
55
56			try:
57			return pycountry.countries.lookup(thing)
58			except LookupError as e:
59			if default is _marker:
60			raise ValueError(str(e))
61			return default
62
63
64			def get_country_code(thing, default=_marker):
65			"""Returns the 2-character code (alpha2) of the country
66			:param thing: country, subdivision object or search term
67			:return: the 2-character (alpha2) code of the country
68			:rtype: string
69			"""
70			thing = get_country_or_subdivision(thing, default=default)
71			if is_country(thing):
72			return thing.alpha_2
73			if is_subdivision(thing):
74			return thing.country_code
75			return default
76
77
78			def get_subdivision(subdivision_or_term, parent=None, default=_marker):
79			"""Returns the Subdivision object
80			:param subdivision_or_term: subdivision or search term
81			:param subdivision_or_term: Subdivision/string
82			:param parent: filter by parent subdivision or country
83			:returns: the subdivision that matches with the parameter passed in
84			:rtype: pycountry.db.Subdivision
85			"""
86			if is_subdivision(subdivision_or_term):
87			return subdivision_or_term
88
89			if not isinstance(subdivision_or_term, string_types):
90			if default is _marker:
91			raise TypeError("{} is not supported".format(
92			repr(subdivision_or_term)))
93			return default
94
95			# Search by parent
96			if parent:
97
98			def is_match(subdivision):
99			terms = [subdivision.name, subdivision.code]
100			needle = to_utf8(subdivision_or_term)
101			return needle in map(to_utf8, terms)
102
103			subdivisions = get_subdivisions(parent, default=[])
104			subdivisions = filter(lambda subdiv: is_match(subdiv), subdivisions)
			0 ignored issues – show introduced 2022-04-08 12:24 UTC by Report Bug Copy Issue Report The variable `is_match` does not seem to be defined for all execution paths. Loading history...
105			if len(subdivisions) == 1:
106			return subdivisions[0]
107			elif len(subdivisions) > 1:
108			if default is _marker:
109			raise ValueError("More than one subdivision found")
110			return default
111			else:
112			if default is _marker:
113			raise ValueError("No subdivisions found")
114			return None
115
116			# Search directly by term
117			try:
118			return pycountry.subdivisions.lookup(subdivision_or_term)
119			except LookupError as e:
120			if default is _marker:
121			raise ValueError(str(e))
122			return default
123
124
125			def is_country(thing):
126			"""Returns whether the value passed in is a country object
127			"""
128			if not thing:
129			return False
130			# pycountry generates the classes dynamically, we cannot use isinstance
131			return "Country" in repr(type(thing))
132
133
134			def is_subdivision(thing):
135			"""Returns whether the value passed in is a subdivision object
136			"""
137			if not thing:
138			return False
139			# pycountry generates the classes dynamically, we cannot use isinstance
140			return "Subdivision" in repr(type(thing))
141
142
143			def get_subdivisions(thing, default=_marker):
144			"""Returns the first-level subdivisions of the country or subdivision,
145			sorted by code ascending
146			:param thing: country, subdivision object or search term
147			:return: the list of first-level subdivisions of the subdivision/country
148			:rtype: list of pycountry.db.Subdivision
149			"""
150			try:
151			country_or_subdivision = get_country_or_subdivision(thing)
152			country_code = get_country_code(country_or_subdivision)
153			except (ValueError, TypeError) as e:
154			if default is _marker:
155			raise e
156			return default
157
158			# Extract the subdivisions
159			subdivisions = pycountry.subdivisions.get(country_code=country_code)
160
161			# Bail out those that are not first-level
162			if is_subdivision(country_or_subdivision):
163			code = country_or_subdivision.code
164			subdivisions = filter(lambda sub: sub.parent_code == code, subdivisions)
			0 ignored issues – show introduced 2022-04-08 12:24 UTC by Report Bug Copy Issue Report The variable `code` does not seem to be defined for all execution paths. Loading history...
165			else:
166			subdivisions = filter(lambda sub: sub.parent_code is None, subdivisions)
167
168			# Sort by code
169			return sorted(subdivisions, key=lambda s: s.code)
170
171
172			def get_country_or_subdivision(thing, default=_marker):
173			"""Returns the country or subdivision for the thing passed-in
174			:param thing: the thing or search term to look for a country or subdivision
175			:type thing: Country/Subdivision/string
176			:return: the country or subdivision for the given thing
177			"""
178			if is_country(thing):
179			return thing
180			if is_subdivision(thing):
181			return thing
182
183			if not isinstance(thing, string_types):
184			if default is _marker:
185			raise TypeError("{} is not supported".format(repr(thing)))
186			return default
187
188			# Maybe a country
189			country = get_country(thing, default=None)
190			if country:
191			return country
192
193			# Maybe a subdivision
194			subdivision = get_subdivision(thing, default=None)
195			if subdivision:
196			return subdivision
197
198			if default is _marker:
199			raise ValueError("Could not find a record for '{}'".format(
200			thing.lower()))
201			return default
202

senaite / senaite.core

Pull Request — 2.x (#1961)

senaite.core.api.geo.is_country() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like