elodie.geolocation.dms_string() - Code Metrics - jmathai/elodie - Measure and Improve Code Quality continuously with Scrutinizer

elodie.geolocation.dms_string() A
last analyzed 2024-04-01 21:53 UTC

↳ Parent: elodie.geolocation

Complexity

Conditions

Size

Total Lines	8
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	7
nop	2
dl	0
loc	8
rs	9.3333
c	0
b	0
f	0

"""Look up geolocation information for media objects."""
from __future__ import print_function
from __future__ import division
from future import standard_library
from past.utils import old_div

standard_library.install_aliases()  # noqa

from os import path

import requests
import urllib.request
import urllib.parse
import urllib.error

from elodie.config import load_config
from elodie import constants
from elodie import log
from elodie.localstorage import Db

__KEY__ = None
__DEFAULT_LOCATION__ = 'Unknown Location'
__PREFER_ENGLISH_NAMES__ = None


def coordinates_by_name(name):
    # Try to get cached location first
    db = Db()
    cached_coordinates = db.get_location_coordinates(name)
    if(cached_coordinates is not None):
        return {
            'latitude': cached_coordinates[0],
            'longitude': cached_coordinates[1]
        }

    # If the name is not cached then we go ahead with an API lookup
    geolocation_info = lookup(location=name)

    if(geolocation_info is not None):
        if(
            'results' in geolocation_info and
            len(geolocation_info['results']) != 0 and
            'locations' in geolocation_info['results'][0] and
            len(geolocation_info['results'][0]['locations']) != 0
        ):

            # By default we use the first entry unless we find one with
            #   geocodeQuality=city.
            geolocation_result = geolocation_info['results'][0]
            use_location = geolocation_result['locations'][0]['latLng']
            # Loop over the locations to see if we come accross a
            #   geocodeQuality=city.
            # If we find a city we set that to the use_location and break
            for location in geolocation_result['locations']:
                if(
                    'latLng' in location and
                    'lat' in location['latLng'] and
                    'lng' in location['latLng'] and
                    location['geocodeQuality'].lower() == 'city'
                ):
                    use_location = location['latLng']
                    break

            return {
                'latitude': use_location['lat'],
                'longitude': use_location['lng']
            }

    return None


def decimal_to_dms(decimal):
    decimal = float(decimal)
    decimal_abs = abs(decimal)
    minutes, seconds = divmod(decimal_abs*3600, 60)
    degrees, minutes = divmod(minutes, 60)
    degrees = degrees
    sign = 1 if decimal >= 0 else -1
    return (degrees, minutes, seconds, sign)


def dms_to_decimal(degrees, minutes, seconds, direction=' '):
    sign = 1
    if(direction[0] in 'WSws'):
        sign = -1
    return (
        float(degrees) + old_div(float(minutes), 60) +
        old_div(float(seconds), 3600)
    ) * sign


def dms_string(decimal, type='latitude'):
    # Example string -> 38 deg 14' 27.82" S
    dms = decimal_to_dms(decimal)
    if type == 'latitude':
        direction = 'N' if decimal >= 0 else 'S'
    elif type == 'longitude':
        direction = 'E' if decimal >= 0 else 'W'
    return '{} deg {}\' {}" {}'.format(dms[0], dms[1], dms[2], direction)



def get_key():
    global __KEY__
    if __KEY__ is not None:
        return __KEY__

    if constants.mapquest_key is not None:
        __KEY__ = constants.mapquest_key
        return __KEY__

    config = load_config()
    if('MapQuest' not in config):
        return None

    __KEY__ = config['MapQuest']['key']
    return __KEY__

def get_prefer_english_names():
    global __PREFER_ENGLISH_NAMES__
    if __PREFER_ENGLISH_NAMES__ is not None:
        return __PREFER_ENGLISH_NAMES__

    config_file = '%s/config.ini' % constants.application_directory
    if not path.exists(config_file):
        return False

    config = load_config()
    if('MapQuest' not in config):
        return False

    if('prefer_english_names' not in config['MapQuest']):
        return False

    __PREFER_ENGLISH_NAMES__ = bool(config['MapQuest']['prefer_english_names'])
    return __PREFER_ENGLISH_NAMES__

def place_name(lat, lon):
    lookup_place_name_default = {'default': __DEFAULT_LOCATION__}
    if(lat is None or lon is None):
        return lookup_place_name_default

    # Convert lat/lon to floats
    if(not isinstance(lat, float)):
        lat = float(lat)
    if(not isinstance(lon, float)):
        lon = float(lon)

    # Try to get cached location first
    db = Db()
    # 3km distace radious for a match
    cached_place_name = db.get_location_name(lat, lon, 3000)
    # We check that it's a dict to coerce an upgrade of the location
    #  db from a string location to a dictionary. See gh-160.
    if(isinstance(cached_place_name, dict)):
        return cached_place_name

    lookup_place_name = {}
    geolocation_info = lookup(lat=lat, lon=lon)
    if(geolocation_info is not None and 'address' in geolocation_info):
        address = geolocation_info['address']
        # gh-386 adds support for town
        # taking precedence after city for backwards compatability
        for loc in ['city', 'town', 'state', 'country']:
            if(loc in address):
                lookup_place_name[loc] = address[loc]
                # In many cases the desired key is not available so we
                #  set the most specific as the default.
                if('default' not in lookup_place_name):
                    lookup_place_name['default'] = address[loc]

    if(lookup_place_name):
        db.add_location(lat, lon, lookup_place_name)
        # TODO: Maybe this should only be done on exit and not for every write.
        db.update_location_db()

    if('default' not in lookup_place_name):
        lookup_place_name = lookup_place_name_default

    return lookup_place_name


def lookup(**kwargs):
    if(
        'location' not in kwargs and
        'lat' not in kwargs and
        'lon' not in kwargs
    ):
        return None

    if('lat' in kwargs and 'lon' in kwargs):
        kwargs['location'] = '{},{}'.format(kwargs['lat'], kwargs['lon'])

    key = get_key()
    prefer_english_names = get_prefer_english_names()

    if(key is None):
        return None

    try:
        headers = {}
        params = {'format': 'json', 'key': key}
        if(prefer_english_names):
            headers = {'Accept-Language':'en-EN,en;q=0.8'}
            params['locale'] = 'en_US'
        params.update(kwargs)
        path = '/geocoding/v1/address'
        if('lat' in kwargs and 'lon' in kwargs):
            path = '/geocoding/v1/reverse'
        url = '%s%s?%s' % (
                    constants.mapquest_base_url,
                    path,
                    urllib.parse.urlencode(params)
              )
        # log the MapQuest url gh-446
        log.info('MapQuest url: %s' % (url))
        r = requests.get(url, headers=headers)
        return parse_result(r.json())
    except requests.exceptions.RequestException as e:
        log.error(e)
        return None
    except ValueError as e:
        log.error(r.text)
        log.error(e)
        return None


def parse_result(result):
    # gh-421
    # Return None if statusCode is not 0
    #   https://developer.mapquest.com/documentation/geocoding-api/status-codes/
    if( 'info' not in result or
        'statuscode' not in result['info'] or
        result['info']['statuscode'] != 0
       ):
        return None

    address = parse_result_address(result)
    if(address is None):
        return None

    result['address'] = address
    result['latLng'] = parse_result_latlon(result)

    return result

def parse_result_address(result):
    # We want to store the city, state and country
    # The only way determined to identify an unfound address is 
    #   that none of the indicies were found
    if( 'results' not in result or
        len(result['results']) == 0 or
        'locations' not in result['results'][0] or
        len(result['results'][0]['locations']) == 0
        ):
        return None

    index_found = False
    addresses = {'city': None, 'state': None, 'country': None}
    result_compat = {}
    result_compat['address'] = {}


    locations = result['results'][0]['locations'][0]
    # We are looping over locations to find the adminAreaNType key which
    #   has a value of City, State or Country.
    # Once we find it then we obtain the value from the key adminAreaN
    #   where N is a numeric index.
    # For example
    #   * adminArea1Type = 'City'
    #   * adminArea1 = 'Sunnyvale'
    for key in locations:
        # Check if the key is of the form adminArea1Type
        if(key[-4:] == 'Type'):
            # If it's a type then check if it corresponds to one we are intereated in
            #   and store the index by parsing the key
            key_prefix = key[:-4]
            key_index = key[-5:-4]
            if(locations[key].lower() in addresses):
                addresses[locations[key].lower()] = locations[key_prefix]
                index_found = True

    if(index_found is False):
        return None

    return addresses

def parse_result_latlon(result):
    if( 'results' not in result or
        len(result['results']) == 0 or
        'locations' not in result['results'][0] or
        len(result['results'][0]['locations']) == 0 or
        'latLng' not in result['results'][0]['locations'][0]
        ):
        return None

    latLng = result['results'][0]['locations'][0]['latLng'];

    return {'lat': latLng['lat'], 'lon': latLng['lng']}


1			"""Look up geolocation information for media objects."""
2			from __future__ import print_function
3			from __future__ import division
4			from future import standard_library
5			from past.utils import old_div
6
7			standard_library.install_aliases() # noqa
8
9			from os import path
10
11			import requests
12			import urllib.request
13			import urllib.parse
14			import urllib.error
15
16			from elodie.config import load_config
17			from elodie import constants
18			from elodie import log
19			from elodie.localstorage import Db
20
21			__KEY__ = None
22			__DEFAULT_LOCATION__ = 'Unknown Location'
23			__PREFER_ENGLISH_NAMES__ = None
24
25
26			def coordinates_by_name(name):
27			# Try to get cached location first
28			db = Db()
29			cached_coordinates = db.get_location_coordinates(name)
30			if(cached_coordinates is not None):
31			return {
32			'latitude': cached_coordinates[0],
33			'longitude': cached_coordinates[1]
34			}
35
36			# If the name is not cached then we go ahead with an API lookup
37			geolocation_info = lookup(location=name)
38
39			if(geolocation_info is not None):
40			if(
41			'results' in geolocation_info and
42			len(geolocation_info['results']) != 0 and
43			'locations' in geolocation_info['results'][0] and
44			len(geolocation_info['results'][0]['locations']) != 0
45			):
46
47			# By default we use the first entry unless we find one with
48			# geocodeQuality=city.
49			geolocation_result = geolocation_info['results'][0]
50			use_location = geolocation_result['locations'][0]['latLng']
51			# Loop over the locations to see if we come accross a
52			# geocodeQuality=city.
53			# If we find a city we set that to the use_location and break
54			for location in geolocation_result['locations']:
55			if(
56			'latLng' in location and
57			'lat' in location['latLng'] and
58			'lng' in location['latLng'] and
59			location['geocodeQuality'].lower() == 'city'
60			):
61			use_location = location['latLng']
62			break
63
64			return {
65			'latitude': use_location['lat'],
66			'longitude': use_location['lng']
67			}
68
69			return None
70
71
72			def decimal_to_dms(decimal):
73			decimal = float(decimal)
74			decimal_abs = abs(decimal)
75			minutes, seconds = divmod(decimal_abs*3600, 60)
76			degrees, minutes = divmod(minutes, 60)
77			degrees = degrees
78			sign = 1 if decimal >= 0 else -1
79			return (degrees, minutes, seconds, sign)
80
81
82			def dms_to_decimal(degrees, minutes, seconds, direction=' '):
83			sign = 1
84			if(direction[0] in 'WSws'):
85			sign = -1
86			return (
87			float(degrees) + old_div(float(minutes), 60) +
88			old_div(float(seconds), 3600)
89			) * sign
90
91
92			def dms_string(decimal, type='latitude'):
93			# Example string -> 38 deg 14' 27.82" S
94			dms = decimal_to_dms(decimal)
95			if type == 'latitude':
96			direction = 'N' if decimal >= 0 else 'S'
97			elif type == 'longitude':
98			direction = 'E' if decimal >= 0 else 'W'
99			return '{} deg {}\' {}" {}'.format(dms[0], dms[1], dms[2], direction)
			0 ignored issues – show introduced 2019-01-24 14:20 UTC by Report Bug Copy Issue Report The variable `direction` does not seem to be defined for all execution paths. Loading history...
100
101
102			def get_key():
103			global __KEY__
104			if __KEY__ is not None:
105			return __KEY__
106
107			if constants.mapquest_key is not None:
108			__KEY__ = constants.mapquest_key
109			return __KEY__
110
111			config = load_config()
112			if('MapQuest' not in config):
113			return None
114
115			__KEY__ = config['MapQuest']['key']
116			return __KEY__
117
118			def get_prefer_english_names():
119			global __PREFER_ENGLISH_NAMES__
120			if __PREFER_ENGLISH_NAMES__ is not None:
121			return __PREFER_ENGLISH_NAMES__
122
123			config_file = '%s/config.ini' % constants.application_directory
124			if not path.exists(config_file):
125			return False
126
127			config = load_config()
128			if('MapQuest' not in config):
129			return False
130
131			if('prefer_english_names' not in config['MapQuest']):
132			return False
133
134			__PREFER_ENGLISH_NAMES__ = bool(config['MapQuest']['prefer_english_names'])
135			return __PREFER_ENGLISH_NAMES__
136
137			def place_name(lat, lon):
138			lookup_place_name_default = {'default': __DEFAULT_LOCATION__}
139			if(lat is None or lon is None):
140			return lookup_place_name_default
141
142			# Convert lat/lon to floats
143			if(not isinstance(lat, float)):
144			lat = float(lat)
145			if(not isinstance(lon, float)):
146			lon = float(lon)
147
148			# Try to get cached location first
149			db = Db()
150			# 3km distace radious for a match
151			cached_place_name = db.get_location_name(lat, lon, 3000)
152			# We check that it's a dict to coerce an upgrade of the location
153			# db from a string location to a dictionary. See gh-160.
154			if(isinstance(cached_place_name, dict)):
155			return cached_place_name
156
157			lookup_place_name = {}
158			geolocation_info = lookup(lat=lat, lon=lon)
159			if(geolocation_info is not None and 'address' in geolocation_info):
160			address = geolocation_info['address']
161			# gh-386 adds support for town
162			# taking precedence after city for backwards compatability
163			for loc in ['city', 'town', 'state', 'country']:
164			if(loc in address):
165			lookup_place_name[loc] = address[loc]
166			# In many cases the desired key is not available so we
167			# set the most specific as the default.
168			if('default' not in lookup_place_name):
169			lookup_place_name['default'] = address[loc]
170
171			if(lookup_place_name):
172			db.add_location(lat, lon, lookup_place_name)
173			# TODO: Maybe this should only be done on exit and not for every write.
174			db.update_location_db()
175
176			if('default' not in lookup_place_name):
177			lookup_place_name = lookup_place_name_default
178
179			return lookup_place_name
180
181
182			def lookup(**kwargs):
183			if(
184			'location' not in kwargs and
185			'lat' not in kwargs and
186			'lon' not in kwargs
187			):
188			return None
189
190			if('lat' in kwargs and 'lon' in kwargs):
191			kwargs['location'] = '{},{}'.format(kwargs['lat'], kwargs['lon'])
192
193			key = get_key()
194			prefer_english_names = get_prefer_english_names()
195
196			if(key is None):
197			return None
198
199			try:
200			headers = {}
201			params = {'format': 'json', 'key': key}
202			if(prefer_english_names):
203			headers = {'Accept-Language':'en-EN,en;q=0.8'}
204			params['locale'] = 'en_US'
205			params.update(kwargs)
206			path = '/geocoding/v1/address'
207			if('lat' in kwargs and 'lon' in kwargs):
208			path = '/geocoding/v1/reverse'
209			url = '%s%s?%s' % (
210			constants.mapquest_base_url,
211			path,
212			urllib.parse.urlencode(params)
213			)
214			# log the MapQuest url gh-446
215			log.info('MapQuest url: %s' % (url))
216			r = requests.get(url, headers=headers)
217			return parse_result(r.json())
218			except requests.exceptions.RequestException as e:
219			log.error(e)
220			return None
221			except ValueError as e:
222			log.error(r.text)
223			log.error(e)
224			return None
225
226
227			def parse_result(result):
228			# gh-421
229			# Return None if statusCode is not 0
230			# https://developer.mapquest.com/documentation/geocoding-api/status-codes/
231			if( 'info' not in result or
232			'statuscode' not in result['info'] or
233			result['info']['statuscode'] != 0
234			):
235			return None
236
237			address = parse_result_address(result)
238			if(address is None):
239			return None
240
241			result['address'] = address
242			result['latLng'] = parse_result_latlon(result)
243
244			return result
245
246			def parse_result_address(result):
247			# We want to store the city, state and country
248			# The only way determined to identify an unfound address is
249			# that none of the indicies were found
250			if( 'results' not in result or
251			len(result['results']) == 0 or
252			'locations' not in result['results'][0] or
253			len(result['results'][0]['locations']) == 0
254			):
255			return None
256
257			index_found = False
258			addresses = {'city': None, 'state': None, 'country': None}
259			result_compat = {}
260			result_compat['address'] = {}
261
262
263			locations = result['results'][0]['locations'][0]
264			# We are looping over locations to find the adminAreaNType key which
265			# has a value of City, State or Country.
266			# Once we find it then we obtain the value from the key adminAreaN
267			# where N is a numeric index.
268			# For example
269			# * adminArea1Type = 'City'
270			# * adminArea1 = 'Sunnyvale'
271			for key in locations:
272			# Check if the key is of the form adminArea1Type
273			if(key[-4:] == 'Type'):
274			# If it's a type then check if it corresponds to one we are intereated in
275			# and store the index by parsing the key
276			key_prefix = key[:-4]
277			key_index = key[-5:-4]
278			if(locations[key].lower() in addresses):
279			addresses[locations[key].lower()] = locations[key_prefix]
280			index_found = True
281
282			if(index_found is False):
283			return None
284
285			return addresses
286
287			def parse_result_latlon(result):
288			if( 'results' not in result or
289			len(result['results']) == 0 or
290			'locations' not in result['results'][0] or
291			len(result['results'][0]['locations']) == 0 or
292			'latLng' not in result['results'][0]['locations'][0]
293			):
294			return None
295
296			latLng = result['results'][0]['locations'][0]['latLng'];
297
298			return {'lat': latLng['lat'], 'lon': latLng['lng']}
299

jmathai / elodie

elodie.geolocation.dms_string() A last analyzed 2024-04-01 21:53 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

elodie.geolocation.dms_string() A
last analyzed 2024-04-01 21:53 UTC