Source code for pygeoapi.util

# =================================================================
#
# Authors: Tom Kralidis <[email protected]>
#
# Copyright (c) 2019 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.
#
# =================================================================

"""Generic util functions used in the code"""

from datetime import date, datetime, time
from decimal import Decimal
import logging
import os
import re

import yaml

LOGGER = logging.getLogger(__name__)


[docs]def get_typed_value(value): """ Derive true type from data value :param value: value :returns: value as a native Python data type """ try: if '.' in value: # float? value2 = float(value) elif len(value) > 1 and value.startswith('0'): value2 = value else: # int? value2 = int(value) except ValueError: # string (default)? value2 = value return value2
[docs]def yaml_load(fh): """ serializes a YAML files into a pyyaml object :param fh: file handle :returns: `dict` representation of YAML """ # support environment variables in config # https://stackoverflow.com/a/55301129 path_matcher = re.compile(r'.*\$\{([^}^{]+)\}.*') def path_constructor(loader, node): env_var = path_matcher.match(node.value).group(1) if env_var not in os.environ: raise EnvironmentError('Undefined environment variable in config') return get_typed_value(os.path.expandvars(node.value)) class EnvVarLoader(yaml.SafeLoader): pass EnvVarLoader.add_implicit_resolver('!path', path_matcher, None) EnvVarLoader.add_constructor('!path', path_constructor) return yaml.load(fh, Loader=EnvVarLoader)
[docs]def str2bool(value): """ helper function to return Python boolean type (source: https://stackoverflow.com/a/715468) :param value: value to be evaluated :returns: `bool` of whether the value is boolean-ish """ value2 = False if isinstance(value, bool): value2 = value else: value2 = value.lower() in ('yes', 'true', 't', '1', 'on') return value2
[docs]def json_serial(obj): """ helper function to convert to JSON non-default types (source: https://stackoverflow.com/a/22238613) :param obj: `object` to be evaluate :returns: JSON non-default type to `str` """ if isinstance(obj, (datetime, date, time)): return obj.isoformat() elif isinstance(obj, Decimal): return float(obj) msg = '{} type {} not serializable'.format(obj, type(obj)) LOGGER.error(msg) raise TypeError(msg)