pyramid_jsonapi.workflow package

Subpackages

• pyramid_jsonapi.workflow.loop package
  • Submodules
    • pyramid_jsonapi.workflow.loop.collection_get module
    • pyramid_jsonapi.workflow.loop.collection_post module
    • pyramid_jsonapi.workflow.loop.item_delete module
    • pyramid_jsonapi.workflow.loop.item_get module
    • pyramid_jsonapi.workflow.loop.item_patch module
    • pyramid_jsonapi.workflow.loop.related_get module
    • pyramid_jsonapi.workflow.loop.relationships_delete module
    • pyramid_jsonapi.workflow.loop.relationships_get module
    • pyramid_jsonapi.workflow.loop.relationships_patch module
    • pyramid_jsonapi.workflow.loop.relationships_post module
  • Module contents

Module contents

class pyramid_jsonapi.workflow.Doc

Bases: dict

update_child(key, value)

class pyramid_jsonapi.workflow.Rejected(view, rejected=None)

Bases: object

identifier_to_str(identifier)

reject_attributes(identifier, things, reason, *, category='attributes')

reject_object(identifier, reason)

reject_relationships(identifier, things, reason, *, category='relationships')

property rejected_dict

class pyramid_jsonapi.workflow.ResultObject(view, object, related=None)

Bases: object

identifier()

property included_dict

serialise()

property str_identifier

to_dict()

property tuple_identifier

class pyramid_jsonapi.workflow.Results(view, objects=None, many=True, count=None, limit=None, is_included=False, is_top=False, not_found_message='Object not found.')

Bases: object

compute_meta()

data()

filter(predicate, reason='Permission denied', force_rerun=False)

identifiers()

included()

property included_dict

property meta

rel_dict(rel, rel_name, parent_url)

serialise(identifiers=False)

serialise_object_with(method_name)

class pyramid_jsonapi.workflow.SharedState(view, request=None, results=None, document=None, rejected=None)

Bases: object

pyramid_jsonapi.workflow.allowed_rel_changes(rel, view, stage, obj_data, perm)

Authorise write action on a relationship.

pyramid_jsonapi.workflow.current_related_ris(view, src_id, rel)

pyramid_jsonapi.workflow.execute_stage(view, stages, stage_name, arg)

pyramid_jsonapi.workflow.follow_rel(view, rel_name, include_path=None)

True if rel_name should be followed and added.

pyramid_jsonapi.workflow.get_item(view, item_or_id=None)

Wrapper around view.get_item() to allow passing an item or an id.

pyramid_jsonapi.workflow.get_jsonapi_accepts(request)

Return a set of all ‘application/vnd.api’ parts of the accept header.

pyramid_jsonapi.workflow.make_method(name, api)

pyramid_jsonapi.workflow.partition(items, predicate=<class 'bool'>)

pyramid_jsonapi.workflow.partition_doc_data(doc_data, partitioner)

pyramid_jsonapi.workflow.patch_rel_new_data(view, src_type, src_id, rel, rel_dict, stage)

pyramid_jsonapi.workflow.permission_handler(endpoint_name, stage_name)

pyramid_jsonapi.workflow.rel_patch_to_actions(view, src_id, rel, rel_patch_data)

Split a patch to a to_many rel into post and delete. Return a to_one patch.

pyramid_jsonapi.workflow.sh_alter_document_add_denied(doc, view, stage, view_method)

pyramid_jsonapi.workflow.sh_alter_document_add_returned_count(doc, view, stage, view_method)

Add the returned count to meta.

pyramid_jsonapi.workflow.sh_alter_document_debug_info(doc, view, stage, view_method)

Potentially add some debug information.

pyramid_jsonapi.workflow.sh_alter_document_self_link(doc, view, stage, view_method)

Include a self link unless the method is PATCH.

pyramid_jsonapi.workflow.sh_alter_request_add_info(request, view, stage, view_method)

Add information commonly used in view operations.

pyramid_jsonapi.workflow.sh_validate_request_common_validity(request, view, stage, view_method)

Perform common request validity checks.

pyramid_jsonapi.workflow.sh_validate_request_headers(request, view, stage, view_method)

Check that request headers comply with spec.

Raises

• HTTPUnsupportedMediaType –

• HTTPNotAcceptable –

pyramid_jsonapi.workflow.sh_validate_request_object_exists(request, view, stage, view_method)

Make sure that id exists in collection for all urls specifying an id.

pyramid_jsonapi.workflow.sh_validate_request_valid_json(request, view, stage, view_method)

Check that the body of any request is valid JSON.

Raises

HTTPBadRequest –

pyramid_jsonapi.workflow.shp_collection_post_alter_request(request, view, stage, view_method)

pyramid_jsonapi.workflow.shp_delete_alter_request(request, view, stage, view_method)

pyramid_jsonapi.workflow.shp_get_alter_document(doc, view, stage, view_method)

pyramid_jsonapi.workflow.shp_patch_alter_request(request, view, stage, view_method)

pyramid_jsonapi.workflow.shp_relationships_delete_alter_request(request, view, stage, view_method)

pyramid_jsonapi.workflow.shp_relationships_patch_alter_request(request, view, stage, view_method)

pyramid_jsonapi.workflow.shp_relationships_post_alter_request(request, view, stage, view_method)

pyramid_jsonapi.workflow.wrapped_query_all(query)

Wrap query.all() so that SQLAlchemy exceptions can be transformed to http ones.