Source code for pygeoapi.formatter.csv_
# =================================================================
#
# Authors: Tom Kralidis <tomkralidis@gmail.com>
#
# Copyright (c) 2022 Tom Kralidis
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation
# files (the "Software"), to deal in the Software without
# restriction, including without limitation the rights to use,
# copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following
# conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
#
# =================================================================
import io
import logging
import unicodecsv as csv
from pygeoapi.formatter.base import BaseFormatter, FormatterSerializationError
LOGGER = logging.getLogger(__name__)
[docs]class CSVFormatter(BaseFormatter):
"""CSV formatter"""
[docs] def __init__(self, formatter_def: dict):
"""
Initialize object
:param formatter_def: formatter definition
:returns: `pygeoapi.formatter.csv_.CSVFormatter`
"""
geom = False
if 'geom' in formatter_def:
geom = formatter_def['geom']
super().__init__({'name': 'csv', 'geom': geom})
self.mimetype = 'text/csv; charset=utf-8'
[docs] def write(self, options: dict = {}, data: dict = None) -> str:
"""
Generate data in CSV format
:param options: CSV formatting options
:param data: dict of GeoJSON data
:returns: string representation of format
"""
is_point = False
try:
fields = list(data['features'][0]['properties'].keys())
except IndexError:
LOGGER.error('no features')
return str()
if self.geom:
LOGGER.debug('Including point geometry')
if data['features'][0]['geometry']['type'] == 'Point':
fields.insert(0, 'x')
fields.insert(1, 'y')
is_point = True
else:
# TODO: implement wkt geometry serialization
LOGGER.debug('not a point geometry, skipping')
LOGGER.debug(f'CSV fields: {fields}')
try:
output = io.BytesIO()
writer = csv.DictWriter(output, fields)
writer.writeheader()
for feature in data['features']:
fp = feature['properties']
if is_point:
fp['x'] = feature['geometry']['coordinates'][0]
fp['y'] = feature['geometry']['coordinates'][1]
LOGGER.debug(fp)
writer.writerow(fp)
except ValueError as err:
LOGGER.error(err)
raise FormatterSerializationError('Error writing CSV output')
return output.getvalue()