birdy.client.converters module¶
- class birdy.client.converters.BaseConverter(output=None, path=None, verify=True)[source]¶
Bases:
object
- _check_import(name, package=None)[source]¶
Check if libraries can be imported.
- Parameters:
name (str) – module name to try to import
package (str) – package of the module
- property data¶
Return the data from the remote output in memory.
- extensions = ()¶
- property file¶
Return output Path object. Download from server if not found.
- mimetypes = ()¶
- nested = False¶
- priority = None¶
- class birdy.client.converters.GenericConverter(output=None, path=None, verify=True)[source]¶
Bases:
BaseConverter
- priority = 0¶
- class birdy.client.converters.GeoJSONConverter(output=None, path=None, verify=True)[source]¶
Bases:
BaseConverter
- extensions = ['json', 'geojson']¶
- mimetypes = ['application/geo+json', 'application/vnd.geo+json']¶
- priority = 2¶
- class birdy.client.converters.GeotiffGdalConverter(output=None, path=None, verify=True)[source]¶
Bases:
BaseConverter
- extensions = ['tiff', 'tif']¶
- mimetypes = ['image/tiff; subtype=geotiff']¶
- priority = 1¶
- class birdy.client.converters.GeotiffRioxarrayConverter(output=None, path=None, verify=True)[source]¶
Bases:
BaseConverter
- extensions = ['tiff', 'tif']¶
- mimetypes = ['image/tiff; subtype=geotiff']¶
- priority = 3¶
- class birdy.client.converters.ImageConverter(output=None, path=None, verify=True)[source]¶
Bases:
BaseConverter
- extensions = ['png']¶
- mimetypes = ['image/png']¶
- priority = 1¶
- class birdy.client.converters.JSONConverter(output=None, path=None, verify=True)[source]¶
Bases:
BaseConverter
- extensions = ['json']¶
- mimetypes = ['application/json']¶
- priority = 1¶
- class birdy.client.converters.MetalinkConverter(output=None, path=None, verify=True)[source]¶
Bases:
BaseConverter
- extensions = ['metalink', 'meta4']¶
- mimetypes = ['application/metalink+xml; version=3.0', 'application/metalink+xml; version=4.0']¶
- nested = True¶
- priority = 1¶
- class birdy.client.converters.Netcdf4Converter(output=None, path=None, verify=True)[source]¶
Bases:
BaseConverter
- extensions = ['nc', 'nc4']¶
- mimetypes = ['application/x-netcdf']¶
- priority = 1¶
- class birdy.client.converters.ShpFionaConverter(output=None, path=None, verify=True)[source]¶
Bases:
BaseConverter
- mimetypes = ['application/x-zipped-shp']¶
- priority = 1¶
- class birdy.client.converters.ShpOgrConverter(output=None, path=None, verify=True)[source]¶
Bases:
BaseConverter
- extensions = ['zip']¶
- mimetypes = ['application/x-zipped-shp']¶
- priority = 2¶
- class birdy.client.converters.TextConverter(output=None, path=None, verify=True)[source]¶
Bases:
BaseConverter
- extensions = ['txt', 'csv', 'md', 'rst']¶
- mimetypes = ['text/plain']¶
- priority = 1¶
- class birdy.client.converters.XarrayConverter(output=None, path=None, verify=True)[source]¶
Bases:
BaseConverter
- extensions = ['nc', 'nc4']¶
- mimetypes = ['application/x-netcdf']¶
- priority = 2¶
- class birdy.client.converters.ZipConverter(output=None, path=None, verify=True)[source]¶
Bases:
BaseConverter
- extensions = ['zip']¶
- mimetypes = ['application/zip']¶
- nested = True¶
- priority = 1¶
- birdy.client.converters._find_converter(mimetype=None, extension=None, converters=())[source]¶
Return a list of compatible converters ordered by priority.
- birdy.client.converters.convert(output: owslib.wps.Output | Path | str, path: str | Path, converters: Sequence[BaseConverter] = None, verify: bool = True)[source]¶
Convert a file to an object.
- Parameters:
output (owslib.wps.Output, Path, str) – Item to convert to an object.
path (str, Path) – Path on disk where temporary files are stored.
converters (sequence of BaseConverter subclasses) – Converter classes to search within for a match.
verify (bool)
- Returns:
Python object or file’s content as bytes.
- Return type:
objs