weaver.store.mongodb

Stores to read/write data to from/to MongoDB using pymongo.

Module Contents

weaver.store.mongodb.LOGGER

class weaver.store.mongodb.MongodbStore(: pymongo.collection.Collection, collection: Optional[Dict[str, Any]], sane_name_config=None)

Base class extended by all concrete store implementations.

classmethod get_args_kwargs(cls: Any, *args: Any, **kwargs) → Tuple[Tuple, Dict]

Filters MongodbStore-specific arguments to safely pass them down its __init__.

class weaver.store.mongodb.MongodbServiceStore(*args, **kwargs)

Registry for OWS services. Uses MongoDB to store service url and attributes.

save_service(self: weaver.datatype.Service, service: bool, overwrite=True) → weaver.datatype.Service

Stores an OWS service in mongodb.

delete_service(self: str, name) → bool

Removes service from MongoDB storage.

list_services(self) → List[Service]

Lists all services in MongoDB storage.

fetch_by_name(self: str, name: Optional[str], visibility=None) → weaver.datatype.Service

Gets service for given name from MongoDB storage.

fetch_by_url(self: str, url) → weaver.datatype.Service

Gets service for given url from MongoDB storage.

clear_services(self) → bool

Removes all OWS services from MongoDB storage.

class weaver.store.mongodb.MongodbProcessStore(*args, **kwargs)

Registry for processes. Uses MongoDB to store processes and attributes.

_register_defaults(self: List[Process], processes) → None

Default process registration to apply definition updates with duplicate entry handling.

_add_process(self: weaver.typedefs.AnyProcess, process) → None

static _get_process_field(process: weaver.typedefs.AnyProcess, function_dict: Union[Dict[AnyProcessType, Callable[], Any]], Callable[], Any]]) → Any

Takes a lambda expression or a dict of process-specific lambda expressions to retrieve a field. Validates that the passed process object is one of the supported types.

Parameters

• process – process to retrieve the field from.

• function_dict – lambda or dict of lambda of process type

Returns

retrieved field if the type was supported

Raises

ProcessInstanceError – invalid process type

_get_process_id(self: weaver.typedefs.AnyProcess, process) → str

_get_process_type(self: weaver.typedefs.AnyProcess, process) → str

_get_process_endpoint_wps1(self: weaver.typedefs.AnyProcess, process) → str

save_process(self: Union[Process, ProcessWPS], process: bool, overwrite=True) → weaver.datatype.Process

Stores a process in storage.

Parameters

• process – An instance of weaver.datatype.Process.

• overwrite – Overwrite the matching process instance by name if conflicting.

delete_process(self: str, process_id: Optional[str], visibility=None) → bool

Removes process from database, optionally filtered by visibility. If visibility=None, the process is deleted (if existing) regardless of its visibility value.

list_processes(self: Optional[str], visibility=None) → List[Process]

Lists all processes in database, optionally filtered by visibility.

Parameters

visibility – One value amongst weaver.visibility.

fetch_by_id(self: str, process_id: Optional[str], visibility=None) → weaver.datatype.Process

Get process for given process_id from storage, optionally filtered by visibility. If visibility=None, the process is retrieved (if existing) regardless of its visibility value.

Parameters

• process_id – process identifier

• visibility – one value amongst weaver.visibility.

Returns

An instance of weaver.datatype.Process.

get_visibility(self: str, process_id) → str

Get visibility of a process.

Returns

One value amongst weaver.visibility.

set_visibility(self: str, process_id: str, visibility) → None

Set visibility of a process.

Parameters

• visibility – One value amongst weaver.visibility.

• process_id –

Raises

• TypeError – when visibility is not str.

• ValueError – when visibility is not one of weaver.visibility.VISIBILITY_VALUES.

clear_processes(self) → bool

Clears all processes from the store.

class weaver.store.mongodb.MongodbJobStore(*args, **kwargs)

Registry for process jobs tracking. Uses MongoDB to store job attributes.

save_job(self, task_id: str, process: str, service: Optional[str] = None, inputs: Optional[List[Any]] = None, is_workflow: bool = False, is_local: bool = False, user_id: Optional[int] = None, execute_async: bool = True, custom_tags: Optional[List[str]] = None, access: Optional[str] = None, notification_email: Optional[str] = None, accept_language: Optional[str] = None) → weaver.datatype.Job

Creates a new Job and stores it in mongodb.

update_job(self: weaver.datatype.Job, job) → weaver.datatype.Job

Updates a job parameters in MongoDB storage. :param job: instance of weaver.datatype.Job.

delete_job(self: str, job_id) → bool

Removes job from MongoDB storage.

fetch_by_id(self: str, job_id) → weaver.datatype.Job

Gets job for given job_id from MongoDB storage.

list_jobs(self) → List[Job]

Lists all jobs in MongoDB storage. For user-specific access to available jobs, use MongodbJobStore.find_jobs() instead.

find_jobs(self, process: Optional[str] = None, service: Optional[str] = None, tags: Optional[List[str]] = None, access: Optional[str] = None, notification_email: Optional[str] = None, status: Optional[str] = None, sort: Optional[str] = None, page: int = 0, limit: int = 10, group_by: Optional[Union[str, List[str]]] = None, request: Optional[Request] = None) → Union[JobListAndCount, JobCategoriesAndCount]

Finds all jobs in MongoDB storage matching search filters to obtain results with requested paging or grouping.

Parameters

• request – request that lead to this call to obtain permissions and user id.

• process – process name to filter matching jobs.

• service – service name to filter matching jobs.

• tags – list of tags to filter matching jobs.

• access – access visibility to filter matching jobs (default: VISIBILITY_PUBLIC).

• notification_email – notification email to filter matching jobs.

• status – status to filter matching jobs.

• sort – field which is used for sorting results (default: creation date, descending).

• page – page number to return when using result paging (only when not using group_by).

• limit – number of jobs per page when using result paging (only when not using group_by).

• group_by – one or many fields specifying categories to form matching groups of jobs (paging disabled).

Returns

(list of jobs matching paging OR list of {categories, list of jobs, count}) AND total of matched job

Example:

Using paging (default), result will be in the form:

(
    [Job(1), Job(2), Job(3), ...],
    <total>
)

Where <total> will indicate the complete count of matched jobs with filters, but the list of jobs will be limited only to page index and limit specified.

Using grouping with a list of field specified with group_by, results will be in the form:

(
    [{category: {field1: valueA, field2: valueB, ...}, [Job(1), Job(2), ...], count: <count>},
     {category: {field1: valueC, field2: valueD, ...}, [Job(x), Job(y), ...], count: <count>},
     ...
    ],
    <total>
)

Where <total> will again indicate all matched jobs by every category combined, and <count> will indicate the amount of jobs matched for each individual category. Also, category will indicate values of specified fields (from group_by) that compose corresponding jobs with matching values.

clear_jobs(self) → bool

Removes all jobs from MongoDB storage.

class weaver.store.mongodb.MongodbQuoteStore(*args, **kwargs)

Registry for quotes. Uses MongoDB to store quote attributes.

save_quote(self: weaver.datatype.Quote, quote) → weaver.datatype.Quote

Stores a quote in mongodb.

fetch_by_id(self: str, quote_id) → weaver.datatype.Quote

Gets quote for given quote_id from MongoDB storage.

list_quotes(self) → List[Quote]

Lists all quotes in MongoDB storage.

find_quotes(self: Optional[str], process_id: int = None, page: int = 0, limit: Optional[str] = 10, sort=None) → Tuple[List[Quote], int]

Finds all quotes in MongoDB storage matching search filters.

Returns a tuple of filtered items and their count, where items can have paging and be limited to a maximum per page, but count always indicate the total number of matches.

class weaver.store.mongodb.MongodbBillStore(*args, **kwargs)

Registry for bills. Uses MongoDB to store bill attributes.

save_bill(self: weaver.datatype.Bill, bill) → weaver.datatype.Bill

Stores a bill in mongodb.

fetch_by_id(self: str, bill_id) → weaver.datatype.Bill

Gets bill for given bill_id from MongoDB storage.

list_bills(self) → List[Bill]

Lists all bills in MongoDB storage.

find_bills(self: Optional[str], quote_id: int = None, page: int = 0, limit: Optional[str] = 10, sort=None) → Tuple[List[Bill], int]

Finds all bills in MongoDB storage matching search filters.

Returns a tuple of filtered items and their count, where items can have paging and be limited to a maximum per page, but count always indicate the total number of matches.