weaver.datatype

Module Contents

weaver.datatype.LOGGER

class weaver.datatype.Base

Dictionary with extended attributes auto-getter/setter for convenience. Explicitly overridden getter/setter attributes are called instead of dict-key get/set-item to ensure corresponding checks and/or value adjustments are executed before applying it to the sub-dict.

Initialize self. See help(type(self)) for accurate signature.

property id(self)

property uuid(self)

abstract json(self) → weaver.typedefs.JSON

Obtain the JSON data representation for response body.

Note

This method implementation should validate the JSON schema against the API definition whenever applicable to ensure integrity between the represented data type and the expected API response.

abstract params(self) → Dict[str, Any]

Obtain the internal data representation for storage.

Note

This method implementation should provide a JSON-serializable definition of all fields representing the object to store.

class weaver.datatype.Service(*args, **kwargs)

Dictionary that contains OWS services. It always has url key.

Initialize self. See help(type(self)) for accurate signature.

property id(self)

property url(self)

Service URL.

property name(self)

Service name.

property type(self)

Service type.

property public(self)

Flag if service has public access.

property auth(self)

Authentication method: public, token, cert.

json(self) → weaver.typedefs.JSON

Obtain the JSON data representation for response body.

Note

This method implementation should validate the JSON schema against the API definition whenever applicable to ensure integrity between the represented data type and the expected API response.

params(self)

Obtain the internal data representation for storage.

Note

This method implementation should provide a JSON-serializable definition of all fields representing the object to store.

summary(self: pyramid.request.Request, request) → Optional[JSON]

class weaver.datatype.Job(*args, **kwargs)

Dictionary that contains OWS service jobs. It always has id and task_id keys.

Initialize self. See help(type(self)) for accurate signature.

inputs

results

exceptions

logs

tags

_get_log_msg(self: Optional[str], msg: Optional[str] = None, status: Optional[Number] = None, progress=None) → str

static _get_err_msg(error: owslib.wps.WPSException) → str

save_log(self, errors: Optional[Union[str, Exception, WPSException, List[WPSException]]] = None, logger: Optional[Logger] = None, message: Optional[str] = None, level: int = INFO, status: Optional[str] = None, progress: Optional[Number] = None) → None

Logs the specified error and/or message, and adds the log entry to the complete job log.

For each new log entry, additional Job properties are added according to Job._get_log_msg() and the format defined by get_job_log_msg().

Parameters

• errors – An error message or a list of WPS exceptions from which to log and save generated message stack.

• logger – An additional Logger for which to propagate logged messages on top saving them to the job.

• message – Explicit string to be logged, otherwise use the current Job.status_message is used.

• level – Logging level to apply to the logged message. This parameter is ignored if errors are logged.

• status – Override status applied in the logged message entry, but does not set it to the job object. Uses the current :prop:`Job.status` value if not specified. Must be one of Weaver.status values.

• progress – Override progress applied in the logged message entry, but does not set it to the job object. Uses the current :prop:`Job.progress` value if not specified.

Note

The job object is updated with the log but still requires to be pushed to database to actually persist it.

property id(self) → str

Job UUID to retrieve the details from storage.

property task_id(self) → Optional[str]

Reference Task UUID attributed by the Celery worker that monitors and executes this job.

property wps_id(self) → Optional[str]

Reference WPS Request/Response UUID attributed by the executed PyWPS process.

This UUID matches the status-location, log and output directory of the WPS process. This parameter is only available when the process is executed on this local instance.

See also

• Job.request

• Job.response

property service(self) → Optional[str]

Service identifier of the corresponding remote process.

See also

• Service.id

property process(self) → Optional[str]

Process identifier of the corresponding remote process.

See also

• Process.id

_get_inputs(self) → List[Optional[Dict[str, Any]]]

_set_inputs(self: List[Optional[Dict[str, Any]]], inputs) → None

property user_id(self) → Optional[str]

property status(self) → str

property status_message(self) → str

property status_location(self) → Optional[str]

property notification_email(self) → Optional[str]

property accept_language(self) → Optional[str]

property execute_async(self) → bool

property is_local(self) → bool

property is_workflow(self) → bool

property created(self) → datetime.datetime

property started(self) → Optional[datetime]

property finished(self) → Optional[datetime]

is_finished(self) → bool

mark_finished(self) → None

property duration(self) → Optional[timedelta]

property duration_str(self) → str

property progress(self) → weaver.typedefs.Number

_get_results(self) → List[Optional[Dict[str, Any]]]

_set_results(self: List[Optional[Dict[str, Any]]], results) → None

_get_exceptions(self) → List[Optional[Dict[str, str]]]

_set_exceptions(self: List[Optional[Dict[str, str]]], exceptions) → None

_get_logs(self) → List[Dict[str, str]]

_set_logs(self: List[Dict[str, str]], logs) → None

_get_tags(self) → List[Optional[str]]

_set_tags(self: List[Optional[str]], tags) → None

property access(self) → str

Job visibility access from execution.

property request(self) → Optional[str]

XML request for WPS execution submission as string (binary).

property response(self) → Optional[str]

XML status response from WPS execution submission as string (binary).

_job_url(self, settings)

links(self: Optional[AnySettingsContainer], container: Optional[str] = None, self_link=None) → weaver.typedefs.JSON

Obtains the JSON links section of many response body for jobs.

If self_link is provided (e.g.: “outputs”) the link for that corresponding item will also be added as self entry to the links. It must be a recognized job link field.

Parameters

• container – object that helps retrieve instance details, namely the host URL.

• self_link – name of a section that represents the current link that will be returned.

json(self: Optional[AnySettingsContainer], container: Optional[str] = None, self_link=None) → weaver.typedefs.JSON

Obtains the JSON data representation for response body.

Note

Settings are required to update API shortcut URLs to job additional information. Without them, paths will not include the API host, which will not resolve to full URI.

params(self) → Dict[str, Any]

Obtain the internal data representation for storage.

Note

This method implementation should provide a JSON-serializable definition of all fields representing the object to store.

class weaver.datatype.Process(*args, **kwargs)

Dictionary that contains a process description for db storage. It always has identifier and processEndpointWPS1 keys.

Initialize self. See help(type(self)) for accurate signature.

_character_codes = [['$', '＄'], ['.', '．']]

property id(self) → str

property identifier(self) → str

property title(self) → str

property abstract(self) → str

property keywords(self) → List[str]

property metadata(self) → List[str]

property version(self) → Optional[str]

property inputs(self) → Optional[List[Dict[str, Any]]]

property outputs(self) → Optional[List[Dict[str, Any]]]

property jobControlOptions(self) → List[str]

property outputTransmission(self) → List[str]

property processDescriptionURL(self) → Optional[str]

property processEndpointWPS1(self) → Optional[str]

property executeEndpoint(self) → Optional[str]

property owsContext(self) → Optional[JSON]

property type(self) → str

Type of process amongst weaver.processes.types definitions.

property package(self) → Optional[CWL]

Package CWL definition as JSON.

property payload(self) → weaver.typedefs.JSON

Deployment specification as JSON body.

static _recursive_replace(pkg: weaver.typedefs.JSON, index_from: int, index_to: int) → weaver.typedefs.JSON

static _encode(obj: Optional[JSON]) → Optional[JSON]

static _decode(obj: Optional[JSON]) → Optional[JSON]

property visibility(self) → str

params(self) → Dict[str, Any]

Obtain the internal data representation for storage.

Note

This method implementation should provide a JSON-serializable definition of all fields representing the object to store.

property params_wps(self) → Dict[str, Any]

Values applicable to PyWPS Process __init__

json(self) → weaver.typedefs.JSON

Obtains the JSON serializable complete representation of the process.

offering(self) → weaver.typedefs.JSON

Obtains the JSON serializable offering representation of the process.

summary(self) → weaver.typedefs.JSON

Obtains the JSON serializable summary representation of the process.

static from_wps(wps_process: pywps.Process, **extra_params: Any) → weaver.datatype.Process

Converts a pywps Process into a weaver.datatype.Process using provided parameters.

static from_ows(process: owslib.wps.Process, service: weaver.datatype.Service, container: weaver.typedefs.AnySettingsContainer, **kwargs: Any) → weaver.datatype.Process

Converts a owslib.wps Process to local storage weaver.datatype.Process.

static convert(process: weaver.typedefs.AnyProcess, service: Optional[Service] = None, container: Optional[AnySettingsContainer] = None, **kwargs: Any) → weaver.datatype.Process

Converts known process equivalents definitions into the formal datatype employed by Weaver.

wps(self) → pywps.Process

Converts this Process to a corresponding format understood by pywps.

class weaver.datatype.Quote(*args, **kwargs)

Dictionary that contains quote information. It always has id and process keys.

Initialize self. See help(type(self)) for accurate signature.

property id(self)

Quote ID.

property title(self)

Quote title.

property description(self)

Quote description.

property details(self)

Quote details.

property user(self)

User ID requesting the quote

property process(self)

WPS Process ID.

property estimatedTime(self)

Process estimated time.

property processParameters(self)

Process execution parameters for quote.

property location(self)

WPS Process URL.

property price(self)

Price of the current quote

property currency(self)

Currency of the quote price

property expire(self)

Quote expiration datetime.

property created(self)

Quote creation datetime.

property steps(self)

Sub-quote IDs if applicable

params(self) → Dict[str, Any]

Obtain the internal data representation for storage.

Note

This method implementation should provide a JSON-serializable definition of all fields representing the object to store.

json(self) → weaver.typedefs.JSON

Obtain the JSON data representation for response body.

Note

This method implementation should validate the JSON schema against the API definition whenever applicable to ensure integrity between the represented data type and the expected API response.

class weaver.datatype.Bill(*args, **kwargs)

Dictionary that contains bill information. It always has id, user, quote and job keys.

Initialize self. See help(type(self)) for accurate signature.

property id(self)

Bill ID.

property user(self)

User ID

property quote(self)

Quote ID.

property job(self)

Job ID.

property price(self)

Price of the current quote

property currency(self)

Currency of the quote price

property created(self)

Quote creation datetime.

property title(self)

Quote title.

property description(self)

Quote description.

params(self) → Dict[str, Any]

Obtain the internal data representation for storage.

Note

This method implementation should provide a JSON-serializable definition of all fields representing the object to store.

json(self) → weaver.typedefs.JSON

Obtain the JSON data representation for response body.

Note

This method implementation should validate the JSON schema against the API definition whenever applicable to ensure integrity between the represented data type and the expected API response.