support CSV

This adds CSV support and prepares for deprecation of upper case method names.

Author: mvexel

.gitignore

@@ -57,3 +57,7 @@ docs/_build/
 
 # PyBuilder
 target/
+
+Pipfile.lock
+
+.vscode/

Pipfile

@@ -0,0 +1,21 @@
+[[source]]
+
+url = "https://pypi.python.org/simple"
+verify_ssl = true
+name = "pypi"
+
+
+[packages]
+
+geojson = "==1.3.1"
+requests = "==2.8.1"
+nose = "==1.3.7"
+
+
+[dev-packages]
+
+
+
+[requires]
+
+python_version = "3.6"

overpass/api.py

@@ -1,16 +1,17 @@
 import requests
 import json
+import csv
 import geojson
 import logging
-
+from io import StringIO
 from .errors import (OverpassSyntaxError, TimeoutError, MultipleRequestsError,
                      ServerLoadError, UnknownOverpassError, ServerRuntimeError)
 
 
 class API(object):
     """A simple Python wrapper for the OpenStreetMap Overpass API."""
 
-    SUPPORTED_FORMATS = ["geojson", "json", "xml"]
+    SUPPORTED_FORMATS = ["geojson", "json", "xml", "csv"]
 
     # defaults for the API class
     _timeout = 25  # second
@@ -43,30 +44,40 @@ def __init__(self, *args, **kwargs):
             requests_log.setLevel(logging.DEBUG)
             requests_log.propagate = True
 
-    def Get(self,
+    def get(self,
             query,
             responseformat="geojson",
             verbosity="body",
             build=True):
         """Pass in an Overpass query in Overpass QL."""
         # Construct full Overpass query
         if build:
-            full_query = self._ConstructQLQuery(query,
-                                                responseformat=responseformat,
-                                                verbosity=verbosity)
+            full_query = self._construct_ql_query(
+                query,
+                responseformat=responseformat,
+                verbosity=verbosity)
         else:
             full_query = query
 
         if self.debug:
             logging.getLogger().info(query)
 
         # Get the response from Overpass
-        raw_response = self._GetFromOverpass(full_query)
+        r = self._get_from_overpass(full_query)
+        content_type = r.headers.get('content-type')
 
-        if responseformat == "xml" or responseformat.startswith("csv"):
-            return raw_response
+        if self.debug:
+            print(content_type)
+        if content_type == "text/csv":
+            result = []
+            reader = csv.reader(StringIO(r.text), delimiter='\t')
+            for row in reader:
+                result.append(row)
+            return result
+        elif content_type == "text/xml" or content_type == "application/xml":
+            return r.text
 
-        response = json.loads(raw_response)
+        response = json.loads(r)
 
         # Check for valid answer from Overpass.
         # A valid answer contains an 'elements' key at the root level.
@@ -83,13 +94,17 @@ def Get(self,
             return response
 
         # construct geojson
-        return self._asGeoJSON(response["elements"])
+        return self._as_geojson(response["elements"])
 
-    def Search(self, feature_type, regex=False):
+    def search(self, feature_type, regex=False):
         """Search for something."""
         raise NotImplementedError()
 
-    def _ConstructQLQuery(self, userquery, responseformat, verbosity):
+    # deprecation of upper case functions
+    Get = get
+    Search = search
+
+    def _construct_ql_query(self, userquery, responseformat, verbosity):
         raw_query = str(userquery)
         if not raw_query.endswith(";"):
             raw_query += ";"
@@ -110,10 +125,7 @@ def _ConstructQLQuery(self, userquery, responseformat, verbosity):
             print(complete_query)
         return complete_query
 
-    def _GetFromOverpass(self, query):
-        """This sends the API request to the Overpass instance and
-        returns the raw result, or an error."""
-
+    def _get_from_overpass(self, query):
         payload = {"data": query}
 
         try:
@@ -141,20 +153,22 @@ def _GetFromOverpass(self, query):
                     code=self._status))
         else:
             r.encoding = 'utf-8'
-            return r.text
+            return r
 
-    def _asGeoJSON(self, elements):
+    def _as_geojson(self, elements):
 
         features = []
         for elem in elements:
-            elem_type = elem["type"]
-            if elem_type == "node":
-                geometry = geojson.Point((elem["lon"], elem["lat"]))
-            elif elem_type == "way":
+            elem_type = elem.get("type")
+            if elem_type and elem_type == "node":
+                geometry = geojson.Point((elem.get("lon"), elem.get("lat")))
+            elif elem_type and elem_type == "way":
                 points = []
-                for coords in elem["geometry"]:
-                    points.append((coords["lon"], coords["lat"]))
-                geometry = geojson.LineString(points)
+                geom = elem.get("geometry")
+                if geom:
+                    for coords in elem.get("geometry"):
+                        points.append((coords["lon"], coords["lat"]))
+                    geometry = geojson.LineString(points)
             else:
                 continue
 

setup.py

@@ -1,10 +1,9 @@
-from codecs import open as codecs_open
-from setuptools import setup, find_packages
+from setuptools import setup
 
 setup(
     name='overpass',
     packages=['overpass'],
-    version='0.5.6',
+    version='0.5.7',
     description='Python wrapper for the OpenStreetMap Overpass API',
     long_description='See README.md',
     author='Martijn van Exel',
@@ -13,14 +12,14 @@
     license='Apache',
     keywords=['openstreetmap', 'overpass', 'wrapper'],
     classifiers=[
-    'License :: OSI Approved :: Apache Software License',
-    'Programming Language :: Python :: 2.6',
-    'Programming Language :: Python :: 2.7',
-    'Programming Language :: Python :: 3.3',
-    'Programming Language :: Python :: 3.4',
-    'Programming Language :: Python :: 3.5',
-    'Topic :: Scientific/Engineering :: GIS',
-    'Topic :: Utilities',
+        'License :: OSI Approved :: Apache Software License',
+        'Programming Language :: Python :: 2.6',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3.3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Topic :: Scientific/Engineering :: GIS',
+        'Topic :: Utilities',
     ],
     install_requires=['requests>=2.3.0', 'geojson>=1.0.9'],
     extras_require={