magpie.api.requests

Module Contents

Functions

check_value(value: Any, param_name: magpie.typedefs.Str, check_type: Any = six.string_types, pattern: Optional[Union[Str, bool]] = ax.PARAM_REGEX) → None	Validates the value against specified type and pattern.
get_request_method_content(request)
get_multiformat_body(request: pyramid.request.Request, key: magpie.typedefs.Str, default: Optional[Any] = None) → Any	Obtains the value of key element from the request body according to specified Content-Type header.
get_permission_multiformat_body_checked(request: pyramid.request.Request, service_or_resource: magpie.typedefs.ServiceOrResourceType) → magpie.permissions.PermissionSet	Retrieves the permission from the body and validates that it is allowed for the specified service or resource.
get_value_multiformat_body_checked(request: pyramid.request.Request, key: magpie.typedefs.Str, default: Any = None, check_type: Any = six.string_types, pattern: Optional[Union[Str, bool]] = ax.PARAM_REGEX) → magpie.typedefs.Str	Obtains and validates the matched value under key element from the request body.
get_principals(request: pyramid.request.Request) → List[AnyAccessPrincipalType]	Obtains the list of effective principals according to detected request session user.
get_logged_user(request: pyramid.request.Request) → Optional[models.User]
get_user(request: pyramid.request.Request, user_name_or_token: Optional[Str] = None) → magpie.models.User	Obtains the user corresponding to the provided user-name, token or via lookup of the logged user request session.
get_user_matchdict_checked_or_logged(request: pyramid.request.Request, user_name_key: magpie.typedefs.Str = 'user_name') → magpie.models.User	Obtains either the explicit or logged user specified in the request path variable.
get_user_matchdict_checked(request: pyramid.request.Request, user_name_key: magpie.typedefs.Str = 'user_name') → magpie.models.User	Obtains the user matched against the specified request path variable.
get_group_matchdict_checked(request: pyramid.request.Request, group_name_key: magpie.typedefs.Str = 'group_name') → magpie.models.Group	Obtains the group matched against the specified request path variable.
get_resource_matchdict_checked(request: pyramid.request.Request, resource_name_key: magpie.typedefs.Str = 'resource_id') → magpie.models.Resource	Obtains the resource matched against the specified request path variable.
get_service_matchdict_checked(request: pyramid.request.Request, service_name_key: magpie.typedefs.Str = 'service_name') → magpie.models.Service	Obtains the service matched against the specified request path variable.
get_permission_matchdict_checked(request: pyramid.request.Request, service_or_resource: magpie.models.Resource) → magpie.permissions.PermissionSet	Obtains the permission specified in the request path variable and validates that service_or_resource
get_value_matchdict_checked(request: pyramid.request.Request, key: magpie.typedefs.Str, check_type: Any = six.string_types, pattern: Optional[Union[Str, bool]] = ax.PARAM_REGEX) → magpie.typedefs.Str	Obtains the matched value located at the expected position of the specified path variable.
get_query_param(request: pyramid.request.Request, case_insensitive_key: Union[(Str, Iterable[Str])], default: Optional[Any] = None) → Any	Retrieves a query string value by name (case insensitive), or returns the default if not present.

magpie.api.requests.LOGGER

magpie.api.requests.check_value(value: Any, param_name: magpie.typedefs.Str, check_type: Any = six.string_types, pattern: Optional[Union[Str, bool]] = ax.PARAM_REGEX) → None

Validates the value against specified type and pattern.

Parameters

• value – value to validate.

• check_type – verify that parameter value is of specified type. Set to None to disable check.

• pattern – regex pattern to validate the input with. If value evaluates to False, skip this kind of validation (default: ax.PARAM_REGEX).

• param_name – path variable key.

Returns

None.

Raises

HTTPUnprocessableEntity – if the key is not an applicable path variable for this request.

magpie.api.requests.get_request_method_content(request)

magpie.api.requests.get_multiformat_body(request: pyramid.request.Request, key: magpie.typedefs.Str, default: Optional[Any] = None) → Any

Obtains the value of key element from the request body according to specified Content-Type header.

See also

• get_multiformat_body_checked()

• get_permission_multiformat_body_checked()

• get_value_multiformat_body_checked()

magpie.api.requests.get_permission_multiformat_body_checked(request: pyramid.request.Request, service_or_resource: magpie.typedefs.ServiceOrResourceType) → magpie.permissions.PermissionSet

Retrieves the permission from the body and validates that it is allowed for the specified service or resource.

Validation combines basic field checks followed by contextual values applicable for the service or resource. The permission can be provided either by literal string name (explicit or implicit format) or JSON object.

See also

• get_value_multiformat_body_checked()

magpie.api.requests.get_value_multiformat_body_checked(request: pyramid.request.Request, key: magpie.typedefs.Str, default: Any = None, check_type: Any = six.string_types, pattern: Optional[Union[Str, bool]] = ax.PARAM_REGEX) → magpie.typedefs.Str

Obtains and validates the matched value under key element from the request body.

Parsing of the body is accomplished according to Content-Type header.

Parameters

• request – request from which to retrieve the key.

• key – body key variable.

• default – value to return instead if not found. If this default is None, it will raise.

• check_type – verify that parameter value is of specified type. Set to None to disable check.

• pattern – regex pattern to validate the input with. If value evaluates to False, skip this kind of validation (default: magpie.api.exception.PARAM_REGEX).

Returns

matched path variable value.

Raises

• HTTPBadRequest – if the key could not be retrieved from the request body and has no provided default value.

• HTTPUnprocessableEntity – if the retrieved value from the key is invalid for this request.

See also

• get_multiformat_body()

magpie.api.requests.get_principals(request: pyramid.request.Request) → List[AnyAccessPrincipalType]

Obtains the list of effective principals according to detected request session user.

magpie.api.requests.get_logged_user(request: pyramid.request.Request) → Optional[models.User]

magpie.api.requests.get_user(request: pyramid.request.Request, user_name_or_token: Optional[Str] = None) → magpie.models.User

Obtains the user corresponding to the provided user-name, token or via lookup of the logged user request session.

Parameters

• request – request from which to obtain application settings and session user as applicable.

• user_name_or_token – reference value to employ for lookup of the user.

Returns

found user.

Raises

• HTTPForbidden – if the requesting user does not have sufficient permission to execute this request.

• HTTPNotFound – if the specified user name or token does not correspond to any existing user.

magpie.api.requests.get_user_matchdict_checked_or_logged(request: pyramid.request.Request, user_name_key: magpie.typedefs.Str = 'user_name') → magpie.models.User

Obtains either the explicit or logged user specified in the request path variable.

:returns found user. :raises HTTPForbidden: if the requesting user does not have sufficient permission to execute this request. :raises HTTPNotFound: if the specified user name or logged user keyword does not correspond to any existing user.

magpie.api.requests.get_user_matchdict_checked(request: pyramid.request.Request, user_name_key: magpie.typedefs.Str = 'user_name') → magpie.models.User

Obtains the user matched against the specified request path variable.

Returns

found user.

Raises

• HTTPForbidden – if the requesting user does not have sufficient permission to execute this request.

• HTTPNotFound – if the specified user name does not correspond to any existing user.

See also

• get_value_matchdict_checked()

• get_user()

magpie.api.requests.get_group_matchdict_checked(request: pyramid.request.Request, group_name_key: magpie.typedefs.Str = 'group_name') → magpie.models.Group

Obtains the group matched against the specified request path variable.

Returns

found group.

Raises

• HTTPForbidden – if the requesting user does not have sufficient permission to execute this request.

• HTTPNotFound – if the specified group name does not correspond to any existing group.

magpie.api.requests.get_resource_matchdict_checked(request: pyramid.request.Request, resource_name_key: magpie.typedefs.Str = 'resource_id') → magpie.models.Resource

Obtains the resource matched against the specified request path variable.

Returns

found resource.

Raises

• HTTPForbidden – if the requesting user does not have sufficient permission to execute this request.

• HTTPNotFound – if the specified resource ID does not correspond to any existing resource.

magpie.api.requests.get_service_matchdict_checked(request: pyramid.request.Request, service_name_key: magpie.typedefs.Str = 'service_name') → magpie.models.Service

Obtains the service matched against the specified request path variable.

Returns

found service.

Raises

• HTTPForbidden – if the requesting user does not have sufficient permission to execute this request.

• HTTPNotFound – if the specified service name does not correspond to any existing service.

magpie.api.requests.get_permission_matchdict_checked(request: pyramid.request.Request, service_or_resource: magpie.models.Resource) → magpie.permissions.PermissionSet

Obtains the permission specified in the request path variable and validates that service_or_resource allows it.

The service_or_resource can be top-level service or a children resource.

Allowed permissions correspond to the direct service permissions or restrained permissions of the resource under its root service. The permission name can be provided either by implicit or explicit string representation.

Returns

found permission name if valid for the service/resource

magpie.api.requests.get_value_matchdict_checked(request: pyramid.request.Request, key: magpie.typedefs.Str, check_type: Any = six.string_types, pattern: Optional[Union[Str, bool]] = ax.PARAM_REGEX) → magpie.typedefs.Str

Obtains the matched value located at the expected position of the specified path variable.

Parameters

• request – request from which to retrieve the key.

• key – path variable key.

• check_type – verify that parameter value is of specified type. Set to None to disable check.

• pattern – regex pattern to validate the input with. If value evaluates to False, skip this kind of validation (default: ax.PARAM_REGEX).

Returns

matched path variable value.

Raises

HTTPUnprocessableEntity – if the key is not an applicable path variable for this request.

magpie.api.requests.get_query_param(request: pyramid.request.Request, case_insensitive_key: Union[Str, Iterable[Str]], default: Optional[Any] = None) → Any

Retrieves a query string value by name (case insensitive), or returns the default if not present.