weaver.formats

Module Contents

weaver.formats.LOGGER

class weaver.formats.AcceptLanguage

Supported languages.

EN_CA = en-CA

FR_CA = fr-CA

EN_US = en-US

class weaver.formats.ContentType

Supported Content-Types.

Media-type nomenclature:

<type> "/" [x- | <tree> "."] <subtype> ["+" suffix] *[";" parameter=value]

APP_CWL = application/x-cwl

APP_FORM = application/x-www-form-urlencoded

APP_GEOJSON = application/geo+json

APP_GZIP = application/gzip

APP_HDF5 = application/x-hdf5

APP_JSON = application/json

APP_NETCDF = application/x-netcdf

APP_OCTET_STREAM = application/octet-stream

APP_PDF = application/pdf

APP_TAR = application/x-tar

APP_TAR_GZ = application/tar+gzip

APP_VDN_GEOJSON = application/vnd.geo+json

APP_XML = application/xml

APP_YAML = application/x-yaml

APP_ZIP = application/zip

IMAGE_GEOTIFF = image/tiff; subtype=geotiff

IMAGE_JPEG = image/jpeg

IMAGE_GIF = image/gif

IMAGE_PNG = image/png

IMAGE_TIFF = image/tiff

MULTI_PART_FORM = multipart/form-data

TEXT_ENRICHED = text/enriched

TEXT_HTML = text/html

TEXT_PLAIN = text/plain

TEXT_RICHTEXT = text/richtext

TEXT_XML = text/xml

VIDEO_MPEG = video/mpeg

ANY_XML

ANY = */*

class weaver.formats.OutputFormat

Renderer output formats for CLI, OpenAPI and HTTP response content generation.

JSON

JSON_STR

JSON_RAW

YAML

YML

XML

XML_STR

XML_RAW

TXT

TEXT

classmethod get(cls: Union[str, AnyOutputFormat], format_or_version: AnyOutputFormat, default: bool = JSON, allow_version=True) → AnyOutputFormat

Resolve the applicable output format.

Parameters

• format_or_version – Either a WPS version, a known value for a f/format query parameter, or an Accept header that can be mapped to one of the supported output formats.

• default – Default output format if none could be resolved.

• allow_version – Enable WPS version specifiers to infer the corresponding output representation.

Returns

Resolved output format.

classmethod convert(cls: weaver.typedefs.JSON, data: Union[str, AnyOutputFormat], to: str, item_root='item') → Union[str, weaver.typedefs.JSON]

Converts the input data from JSON to another known format.

Parameters

• data – Input data to convert. Must be a literal JSON object, not a JSON-like string.

• to – Target format representation. If the output format is not JSON, it is ALWAYS converted to the formatted string of the requested format to ensure the contents are properly represented as intended. In the case of JSON as target format or unknown format, the original object is returned directly.

• item_root – When using XML representations, defines the top-most item name. Unused for other representations.

Returns

Formatted output.

class weaver.formats.SchemaRole

Constants container that provides similar functionalities to ExtendedEnum without explicit Enum membership.

JSON_SCHEMA = https://www.w3.org/2019/wot/json-schema

weaver.formats._CONTENT_TYPE_EXTENSION_OVERRIDES

weaver.formats._CONTENT_TYPE_EXCLUDE

weaver.formats._EXTENSION_CONTENT_TYPES_OVERRIDES

weaver.formats._CONTENT_TYPE_EXTENSION_MAPPING :Dict[str, str]

weaver.formats._CONTENT_TYPE_FORMAT_MAPPING :Dict[str, Format]

weaver.formats._CONTENT_TYPE_EXT_PATTERN

weaver.formats._CONTENT_TYPE_LOCALS_MISSING

weaver.formats._CONTENT_TYPE_LOCALS_MISSING

weaver.formats._EXTENSION_CONTENT_TYPES_MAPPING

weaver.formats._CONTENT_TYPE_CHAR_TYPES = ['application', 'multipart', 'text']

weaver.formats._CONTENT_TYPE_SYNONYM_MAPPING

weaver.formats.IANA_NAMESPACE = iana

weaver.formats.IANA_NAMESPACE_URL = https://www.iana.org/assignments/media-types/

weaver.formats.IANA_NAMESPACE_DEFINITION

weaver.formats.IANA_KNOWN_MEDIA_TYPES

weaver.formats.IANA_MAPPING

weaver.formats.EDAM_NAMESPACE = edam

weaver.formats.EDAM_NAMESPACE_URL = http://edamontology.org/

weaver.formats.EDAM_NAMESPACE_DEFINITION

weaver.formats.EDAM_SCHEMA = http://edamontology.org/EDAM_1.24.owl

weaver.formats.EDAM_MAPPING

weaver.formats.OPENGIS_NAMESPACE = opengis

weaver.formats.OPENGIS_NAMESPACE_URL = http://www.opengis.net/

weaver.formats.OPENGIS_NAMESPACE_DEFINITION

weaver.formats.OPENGIS_MAPPING

weaver.formats.FORMAT_NAMESPACE_DEFINITIONS

weaver.formats.FORMAT_NAMESPACES

weaver.formats.get_allowed_extensions() → List[str]

Obtain the complete list of extensions that are permitted for processing by the application.

Note

This is employed for security reasons. Files can still be specified with another allowed extension, but it will not automatically inherit properties applicable to scripts and executables. If a specific file type is refused due to its extension, a PR can be submitted to add it explicitly.

weaver.formats.get_format(mime_type: str, default: Optional[str] = None) → Optional[pywps.inout.formats.Format]

Obtains a Format with predefined extension and encoding details from known MIME-types.

weaver.formats.get_extension(mime_type: str, dot: bool = True) → str

Retrieves the extension corresponding to mime_type if explicitly defined, or by parsing it.

weaver.formats.get_content_type(extension: str, charset: Optional[str] = None, default: Optional[str] = None) → Optional[str]

Retrieves the Content-Type corresponding to the specified extension if it can be matched.

Parameters

• extension – Extension for which to attempt finding a known Content-Type.

• charset – Charset to apply to the Content-Type as needed if extension was matched.

• default – Default Content-Type to return if no extension is matched.

Returns

Matched or default Content-Type.

weaver.formats.add_content_type_charset(content_type: str, charset: Optional[str]) → str

Apply the specific charset to the content-type with some validation in case of conflicting definitions.

Parameters

• content_type – Desired Content-Type.

• charset – Desired charset parameter.

Returns

updated content-type with charset.

weaver.formats.get_cwl_file_format(mime_type: str, make_reference: bool = False, must_exist: bool = True, allow_synonym: bool = True) → Union[Tuple[Optional[weaver.typedefs.JSON], Optional[str]], Optional[str]]

Obtains the extended schema reference from the media-type identifier.

Obtains the corresponding IANA/EDAM format value to be applied under a CWL I/O File from the mime_type (Content-Type header) using the first matched one.

Lookup procedure is as follows:

• If make_reference=False:

  • If there is a match, returns tuple({<namespace-name: namespace-url>}, <format>) with:

    1. corresponding namespace mapping to be applied under $namespaces in the CWL.

    2. value of format adjusted according to the namespace to be applied to File in the CWL.

  • If there is no match but must_exist=False, returns a literal and non-existing definition as tuple({"iana": <iana-url>}, <format>).

  • If there is no match but must_exist=True AND allow_synonym=True, retry the call with the synonym if available, or move to next step. Skip this step if allow_synonym=False.

  • Otherwise, returns (None, None)

• If make_reference=True:

  • If there is a match, returns the explicit format reference as <namespace-url>/<format>.

  • If there is no match but must_exist=False, returns the literal reference as <iana-url>/<format> (N.B.: literal non-official MIME-type reference will be returned even if an official synonym exists).

  • If there is no match but must_exist=True AND allow_synonym=True, retry the call with the synonym if available, or move to next step. Skip this step if allow_synonym=False.

  • Returns a single None as there is not match (directly or synonym).

Note:

In situations where must_exist=False is used and that the namespace and/or full format URL cannot be resolved to an existing reference, CWL will raise a validation error as it cannot confirm the format. You must therefore make sure that the returned reference (or a synonym format) really exists when using must_exist=False before providing it to the CWL I/O definition. Setting must_exist=False should be used only for literal string comparison or pre-processing steps to evaluate formats.

Parameters

• mime_type – Some reference, namespace’d or literal (possibly extended) MIME-type string.

• make_reference – Construct the full URL reference to the resolved MIME-type. Otherwise return tuple details.

• must_exist – Return result only if it can be resolved to an official MIME-type (or synonym if enabled), otherwise None. Non-official MIME-type can be enforced if disabled, in which case IANA namespace/URL is used as it preserves the original <type>/<subtype> format.

• allow_synonym – Allow resolution of non-official MIME-type to an official MIME-type synonym if available. Types defined as synonym have semantically the same format validation/resolution for CWL. Requires must_exist=True, otherwise the non-official MIME-type is employed directly as result.

Returns

Resolved MIME-type format for CWL usage, accordingly to specified arguments (see description details).

weaver.formats.clean_mime_type_format(mime_type: str, suffix_subtype: bool = False, strip_parameters: bool = False) → Optional[str]

Obtains a generic media-type identifier by cleaning up any additional parameters.

Removes any additional namespace key or URL from mime_type so that it corresponds to the generic representation (e.g.: application/json) instead of the <namespace-name>:<format> mapping variant used in CWL->inputs/outputs->File->format or the complete URL reference.

Removes any leading temporary local file prefix inserted by CWL when resolving namespace mapping. This transforms file:///tmp/dir/path/package#application/json to plain application/json.

According to provided arguments, it also cleans up additional parameters or extracts sub-type suffixes.

Parameters

• mime_type – MIME-type, full URL to MIME-type or namespace-formatted string that must be cleaned up.

• suffix_subtype – Remove additional sub-type specializations details separated by + symbol such that an explicit format like application/vnd.api+json returns only its most basic suffix format defined as``application/json``.

• strip_parameters – Removes additional MIME-type parameters such that only the leading part defining the type/subtype are returned. For example, this will get rid of ; charset=UTF-8 or ; version=4.0 parameters.

Note

Parameters suffix_subtype and strip_parameters are not necessarily exclusive.

weaver.formats.guess_target_format(request: weaver.typedefs.AnyRequestType, default: str = ContentType.APP_JSON) → str

Guess the best applicable response Content-Type header from the request.

Considers the request Accept header, format query and alternatively f query to parse possible formats. Full Media-Type are expected in the header. Query parameters can use both the full type, or only the sub-type (i.e.: JSON, XML, etc.), with case-insensitive names. Defaults to ContentType.APP_JSON if none was specified.

Applies some specific logic to handle automatically added Accept headers by many browsers such that sending requests to the API using them will not automatically default back to XML or similar HTML representations. If browsers are used to send requests, but that format/f queries are used directly in the URL, those will be applied since this is a very intuitive (and easier) approach to request different formats when using browsers.

When user-agent clients are identified as another source, such as sending requests from a server or from code, both headers and query parameters are applied directly without question.

Returns

Matched MIME-type or default.

weaver.formats.repr_json(data: Any, force_string: bool = True, ensure_ascii: bool = False, indent: Optional[int] = 2, **kwargs: Any) → Union[weaver.typedefs.JSON, str, None]

Ensure that the input data can be serialized as JSON to return it formatted representation as such.

If formatting as JSON fails, returns the data as string representation or None accordingly.

weaver.formats.AnyOutputFormat