Reformatted to pep-8 specification

Author: ri0t

docs/source/conf.py

@@ -18,7 +18,8 @@
 #
 import os
 import sys
-#sys.path.insert(0, 'C:\\Users\\gisadmin\\Documents\\Dev\\Git\\Uni\\ORS\\infrastructure\\SDK\\openrouteservice-python-api\\openrouteservice')
+
+# sys.path.insert(0, 'C:\\Users\\gisadmin\\Documents\\Dev\\Git\\Uni\\ORS\\infrastructure\\SDK\\openrouteservice-python-api\\openrouteservice')
 sys.path.insert(0, os.path.abspath('../..'))
 
 # -- General configuration ------------------------------------------------
@@ -30,9 +31,11 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc',
+extensions = [
+    'sphinx.ext.autodoc',
     'sphinx.ext.todo',
-    'sphinx.ext.coverage']
+    'sphinx.ext.coverage'
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['.templates']
@@ -78,7 +81,6 @@
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
 
-
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -112,13 +114,11 @@
     ]
 }
 
-
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'openrouteservice-pydoc'
 
-
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
@@ -147,7 +147,6 @@
      u'Nils Nolde', 'manual'),
 ]
 
-
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
@@ -157,7 +156,6 @@
      [author], 1)
 ]
 
-
 # -- Options for Texinfo output -------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
@@ -168,6 +166,3 @@
      author, 'openrouteservice-py', 'One line description of project.',
      'Miscellaneous'),
 ]
-
-
-

openrouteservice/__init__.py

@@ -19,6 +19,7 @@
 
 __version__ = "2.0.0"
 
+
 # Make sure QGIS plugin can import openrouteservice-py
 
 
@@ -37,4 +38,4 @@ def get_ordinal(number):
 
 from openrouteservice.client import Client
 ## Allow sphinx to pick up these symbols for the documentation.
-#__all__ = ["Client"]
+# __all__ = ["Client"]

openrouteservice/client.py

@@ -32,17 +32,17 @@
 
 from openrouteservice import exceptions, __version__, get_ordinal
 
-try: # Python 3
+try:  # Python 3
     from urllib.parse import urlencode
-except ImportError: # Python 2
+except ImportError:  # Python 2
     from urllib import urlencode
 
-
 _USER_AGENT = "ORSClientPython.v{}".format(__version__)
 _DEFAULT_BASE_URL = "https://api.openrouteservice.org"
 
 _RETRIABLE_STATUSES = set([503])
 
+
 class Client(object):
     """Performs requests to the ORS API services."""
 
@@ -91,16 +91,19 @@ def __init__(self,
         self._base_url = base_url
 
         if self._base_url == _DEFAULT_BASE_URL and key is None:
-            raise ValueError("No API key was specified. Please visit https://openrouteservice.org/sign-up to create one.")
+            raise ValueError(
+                "No API key was specified. Please visit https://openrouteservice.org/sign-up to create one.")
 
         self._timeout = timeout
         self._retry_over_query_limit = retry_over_query_limit
         self._retry_timeout = timedelta(seconds=retry_timeout)
         self._requests_kwargs = requests_kwargs or {}
         self._requests_kwargs.update({
-            "headers": {"User-Agent": _USER_AGENT,
-                        'Content-type': 'application/json',
-                        "Authorization": self._key},
+            "headers": {
+                "User-Agent": _USER_AGENT,
+                'Content-type': 'application/json',
+                "Authorization": self._key
+            },
             "timeout": self._timeout,
         })
 
@@ -229,7 +232,7 @@ def req(self):
     def _get_body(response):
         """Returns the body of a response object, raises status code exceptions if necessary."""
         body = response.json()
-#        error = body.get('error')
+        # error = body.get('error')
         status_code = response.status_code
 
         if status_code == 429:
@@ -288,6 +291,7 @@ def _make_api_method(func):
     Please note that this is an unsupported feature for advanced use only.
     It's also currently incompatibile with multiple threads, see GH #160.
     """
+
     @functools.wraps(func)
     def wrapper(*args, **kwargs):
         args[0]._extra_params = kwargs.pop("extra_params", None)
@@ -297,6 +301,7 @@ def wrapper(*args, **kwargs):
         except AttributeError:
             pass
         return result
+
     return wrapper
 
 

openrouteservice/convert.py

@@ -20,13 +20,14 @@
 """Converts Python types to string representations suitable for ORS API server.
 """
 
+
 def _pipe_list(arg):
     """Convert list of values to pipe-delimited string"""
     if not _is_list(arg):
         raise TypeError(
             "Expected a list or tuple, "
             "but got {}".format(type(arg).__name__))
-    return "|".join(map(str,arg))
+    return "|".join(map(str, arg))
 
 
 def _comma_list(arg):
@@ -35,12 +36,12 @@ def _comma_list(arg):
         raise TypeError(
             "Expected a list or tuple, "
             "but got {}".format(type(arg).__name__))
-    return ",".join(map(str,arg))
+    return ",".join(map(str, arg))
 
 
 def _convert_bool(boolean):
     """Convert to stringified boolean"""
-        
+
     return str(boolean).lower()
 
 
@@ -105,10 +106,10 @@ def _concat_coords(arg):
 
 
 def _is_list(arg):
-    """Checks if arg is list-like."""    
+    """Checks if arg is list-like."""
     if isinstance(arg, dict):
         return False
-    if isinstance(arg, str): # Python 3-only, as str has __iter__
+    if isinstance(arg, str):  # Python 3-only, as str has __iter__
         return False
     return (not _has_method(arg, "strip")
             and _has_method(arg, "__getitem__")
@@ -141,7 +142,7 @@ def decode_polyline(polyline, is3d=False):
     :rtype: dict
     """
     points = []
-    index = lat = lng = z= 0
+    index = lat = lng = z = 0
 
     while index < len(polyline):
         result = 1
@@ -165,7 +166,7 @@ def decode_polyline(polyline, is3d=False):
             if b < 0x1f:
                 break
         lng += ~(result >> 1) if (result & 1) != 0 else (result >> 1)
-        
+
         if is3d:
             result = 1
             shift = 0
@@ -179,13 +180,13 @@ def decode_polyline(polyline, is3d=False):
             if (result & 1) != 0:
                 z += ~(result >> 1)
             else:
-                z += (result >> 1) 
-                
-            points.append([round(lng * 1e-5, 6), round(lat * 1e-5, 6), round(z*1e-2,1)])   
-            
+                z += (result >> 1)
+
+            points.append([round(lng * 1e-5, 6), round(lat * 1e-5, 6), round(z * 1e-2, 1)])
+
         else:
             points.append([round(lng * 1e-5, 6), round(lat * 1e-5, 6)])
-    
+
     geojson = {u'type': u'LineString', u'coordinates': points}
 
     return geojson

openrouteservice/directions.py

@@ -21,6 +21,7 @@
 
 from openrouteservice import validator, deprecation
 
+
 def directions(client,
                coordinates,
                profile='driving-car',

openrouteservice/elevation.py

@@ -19,6 +19,7 @@
 
 from openrouteservice import validator
 
+
 def elevation_point(client, format_in, geometry,
                     format_out='geojson',
                     dataset='srtm',
@@ -49,18 +50,21 @@ def elevation_point(client, format_in, geometry,
     if validate:
         validator.validator(locals(), 'elevation_point')
 
-    params = {'format_in': format_in,
-              'geometry': geometry,
-              'format_out': format_out,
-              'dataset': dataset}    
-            
+    params = {
+        'format_in': format_in,
+        'geometry': geometry,
+        'format_out': format_out,
+        'dataset': dataset
+    }
+
     return client.request('/elevation/point', {}, post_json=params, dry_run=dry_run)
 
+
 def elevation_line(client, format_in, geometry,
-                    format_out='geojson',
-                    dataset='srtm',
-                    validate=True,
-                    dry_run=None):
+                   format_out='geojson',
+                   dataset='srtm',
+                   validate=True,
+                   dry_run=None):
     """
     POSTs 2D point to be enriched with elevation.
     
@@ -88,9 +92,11 @@ def elevation_line(client, format_in, geometry,
     if validate:
         validator.validator(locals(), 'elevation_line')
 
-    params = {'format_in': format_in,
-              'geometry': geometry,
-              'format_out': format_out,
-              'dataset': dataset}    
-            
-    return client.request('/elevation/line', {}, post_json=params, dry_run=dry_run)
+    params = {
+        'format_in': format_in,
+        'geometry': geometry,
+        'format_out': format_out,
+        'dataset': dataset
+    }
+
+    return client.request('/elevation/line', {}, post_json=params, dry_run=dry_run)

openrouteservice/exceptions.py

@@ -21,14 +21,18 @@
 Defines exceptions that are thrown by the ORS client.
 """
 
+
 class ValidationError(Exception):
     """Something went wrong during cerberus validation"""
+
     def __init__(self, errors):
         msg = '\n'.join(["{}".format(str(errors))])
         Exception.__init__(self, msg)
 
+
 class ApiError(Exception):
     """Represents an exception returned by the remote API."""
+
     def __init__(self, status, message=None):
         self.status = status
         self.message = message
@@ -39,22 +43,27 @@ def __str__(self):
         else:
             return "%s (%s)" % (self.status, self.message)
 
+
 class HTTPError(Exception):
     """An unexpected HTTP error occurred."""
+
     def __init__(self, status_code):
         self.status_code = status_code
 
     def __str__(self):
         return "HTTP Error: %d" % self.status_code
 
+
 class Timeout(Exception):
     """The request timed out."""
     pass
 
+
 class _RetriableRequest(Exception):
     """Signifies that the request can be retried."""
     pass
 
+
 class _OverQueryLimit(ApiError, _RetriableRequest):
     """Signifies that the request failed because the client exceeded its query rate limit.
 

openrouteservice/isochrones.py

@@ -119,7 +119,7 @@ def isochrones(client, locations,
     interval = interval or segments
     if interval:
         params['interval'] = interval
-        
+
     if units:
         params["units"] = units