response format flexibility

Author: mvexel

README.rst

@@ -48,7 +48,7 @@ file.
     Options:
     --timeout INTEGER  Timeout in seconds
     --endpoint TEXT    URL of your prefered API
-    --format TEXT      Format to save the data. Options are 'geojson' and 'osm'. Default format is geojson.
+    --format TEXT      Format to save the data. Options are 'geojson', 'json', 'xml'. Default format is geojson.
     --help             Show this message and exit.
 
 For example:
@@ -63,7 +63,7 @@ Or to get the result as an OSM XML file:
 
 .. code:: bash
 
-    overpass --timeout 50 --format osm 'node(area:3602758138)[amenity=cafe]' brasilia-cafe.osm
+    overpass --timeout 50 --format xml 'node(area:3602758138)[amenity=cafe]' brasilia-cafe.osm
 
 Python Library
 -------------
@@ -87,13 +87,13 @@ could do this for example:
     >>> print [(feature['tags']['name'], feature['id']) for feature in response['elements']]
     [(u'Salt Lake City', 150935219), (u'Salt Lake City', 585370637), (u'Salt Lake City', 1615721573)]
 
-If you want to get the data on the OSM XML format, pass the option 'asGeoJSON=False':
+You can specify the format of the response. By default, you will get GeoJSON using the `responseformat` parameter. Alternatives are plain JSON (`json`) and OSM XML (`xml`), as ouput directly by the Overpass API.
 
 .. code:: python
 
     >>> import overpass
     >>> api = overpass.API()
-    >>> response = api.Get('node["name"="Salt Lake City"]', asGeoJSON=False)
+    >>> response = api.Get('node["name"="Salt Lake City"]', responseformat="xml")
 
 Parameters
 ~~~~~~~~~~

overpass/api.py

@@ -8,13 +8,14 @@
 class API(object):
     """A simple Python wrapper for the OpenStreetMap Overpass API"""
 
+    SUPPORTED_FORMATS = ["geojson", "json", "xml"]
+
     # defaults for the API class
     _timeout = 25  # seconds
     _endpoint = "http://overpass-api.de/api/interpreter"
     _debug = False
 
-    _XML_QUERY_TEMPLATE = "[out:xml]{query}out body;"
-    _JSON_QUERY_TEMPLATE = "[out:json]{query}out body;"
+    _QUERY_TEMPLATE = "[out:{out}];{query}out body;"
     _GEOJSON_QUERY_TEMPLATE = "[out:json];{query}out body geom;"
 
     def __init__(self, *args, **kwargs):
@@ -34,19 +35,18 @@ def __init__(self, *args, **kwargs):
             requests_log.setLevel(logging.DEBUG)
             requests_log.propagate = True
 
-    def Get(self, query, asGeoJSON=False):
+    def Get(self, query, responseformat="geojson"):
         """Pass in an Overpass query in Overpass QL"""
 
         # Construct full Overpass query
-        full_query = self._ConstructQLQuery(query, asGeoJSON=asGeoJSON)
+        full_query = self._ConstructQLQuery(query, responseformat=responseformat)
 
-        print("full query: ", full_query)
-
         # Get the response from Overpass
         raw_response = self._GetFromOverpass(full_query)
 
-        print("raw response: ", raw_response)
-
+        if responseformat == "xml":
+            return raw_response
+            
         response = json.loads(raw_response)
 
         # Check for valid answer from Overpass. A valid answer contains an 'elements' key at the root level.
@@ -58,30 +58,27 @@ def Get(self, query, asGeoJSON=False):
         if overpass_remark and overpass_remark.startswith('runtime error'):
             raise ServerRuntimeError(overpass_remark)
 
-        if not asGeoJSON:
+        if responseformat is not "geojson":
             return response
 
         # construct geojson
         return self._asGeoJSON(response["elements"])
 
-        # construct geojson
-        return self._asGeoJSON(response["elements"])
-
     def Search(self, feature_type, regex=False):
         """Search for something."""
         raise NotImplementedError()
 
-    def _ConstructQLQuery(self, userquery, asGeoJSON=False):
+    def _ConstructQLQuery(self, userquery, responseformat):
         raw_query = str(userquery)
         if not raw_query.endswith(";"):
             raw_query += ";"
 
-        if asGeoJSON:
+        if responseformat == "geojson":
             template = self._GEOJSON_QUERY_TEMPLATE
+            complete_query = template.format(query=raw_query)
         else:
-            template = self._JSON_QUERY_TEMPLATE
-
-        complete_query = template.format(query=raw_query)
+            template = self._QUERY_TEMPLATE
+            complete_query = template.format(query=raw_query, out=responseformat)
 
         if self.debug:
             print(complete_query)
@@ -91,8 +88,6 @@ def _GetFromOverpass(self, query):
         """This sends the API request to the Overpass instance and
         returns the raw result, or an error."""
 
-        print("query: ", query)
-
         payload = {"data": query}
 
         try:
@@ -125,7 +120,6 @@ def _GetFromOverpass(self, query):
             return r.text
 
     def _asGeoJSON(self, elements):
-        #print 'DEB _asGeoJson elements:', elements
 
         features = []
         for elem in elements:

overpass/cli.py

@@ -18,16 +18,16 @@ def cli(timeout, endpoint, format, query, output_file):
     """Run query and save the result in output_file"""
 
     api = overpass.API(timeout=timeout, endpoint=endpoint)
-    if format == 'geojson':
-        result = api.Get(query, asGeoJSON=True)
-        with open(output_file, 'w') as f:
+
+    if format not in api.SUPPORTED_FORMATS:
+        print("format {} not supported. Supported formats: {}".format(
+            format,
+            api.SUPPORTED_FORMATS.join(", ")))
+    result = api.Get(query, responseformat=format)
+    with open(output_file, 'w') as f:
+        if responseformat=="geojson":
             geojson.dump(result, f, indent=2, sort_keys=True)
-        print('File saved at %s.' % output_file)
-    elif format == 'osm':
-        result = api.Get(query, asGeoJSON=False)
-        with open(output_file, 'wb') as f:
+        else:
             f.write(result.encode('utf-8'))
-            f.close()
-        print('File saved at %s.' % output_file)
-    else:
-        print('The format you typed is not supported.')
+        f.close()
+    print('File saved at %s.' % output_file)

tests/test_api.py

@@ -11,12 +11,8 @@ def test_geojson():
     api = overpass.API()
 
     osm_geo = api.Get(
-        overpass.MapQuery(37.86517, -122.31851, 37.86687, -122.31635),
-        asGeoJSON=True
-        )
+        overpass.MapQuery(37.86517, -122.31851, 37.86687, -122.31635))
     assert len(osm_geo['features']) > 1
 
-    osm_geo = api.Get('node(area:3602758138)[amenity=cafe]',
-        asGeoJSON=True
-        )
+    osm_geo = api.Get('node(area:3602758138)[amenity=cafe]')
     assert len(osm_geo['features']) > 1

tests/test_cli.py

@@ -23,7 +23,7 @@ def test_cli_xml():
     with runner.isolated_filesystem():
         result = runner.invoke(cli, [
             '--timeout', 40,
-            '--endpoint', 'http://overpass.osm.rambler.ru/cgi/interpreter',
+            '--endpoint', 'http://overpass-api.de/api/interpreter',
             '--format', 'osm',
             'node(area:3600362504)[amenity=cafe]', 'out.osm'
             ])