magpie.adapter.magpieowssecurity¶

Attributes¶

`ProviderSigninAPI`
`CONTENT_TYPE_JSON`
`LOGGER`

Classes¶

`LooseVersion`	This class abstracts handling of a project's versions.
`Service`	Resource of service type.
`Permission`	Applicable Permission values (names) under certain Service and Resource.
`MagpieOWSSecurity`

Functions¶

`evaluate_call`(→ Any)	Evaluates the specified `call` with a wrapped HTTP exception handling. On failure, tries to call.
`verify_param`(→ None)	Evaluate various parameter combinations given the requested verification flags. Given a failing verification,
`get_constant`(→ magpie.typedefs.SettingValue)	Search in order for matched value of `constant_name`:
`get_connected_session`(→ sqlalchemy.orm.session.Session)	Retrieve the session attached to the request or recreated it to ensure it is open and within scoped transaction.
`invalidate_service`(→ None)	Invalidates any caching reference to the specified service name.
`service_factory`(→ ServiceInterface)	Retrieve the specific service class from the provided database service entry.
`get_authenticate_headers`(...)	Obtains all required headers by 401 responses based on executed `request`.
`get_logger`(→ logging.Logger)	Immediately sets the logger level to avoid duplicate log outputs from the root logger and this logger when
`get_magpie_url`(→ magpie.typedefs.Str)	Obtains the configured Magpie URL entrypoint based on the various combinations of supported configuration settings.
`get_settings`(→ magpie.typedefs.SettingsType)	Retrieve application settings from a supported container.

Module Contents¶

magpie.adapter.magpieowssecurity.evaluate_call(call: Callable[[], Any], fallback: Callable[[], None] | None = None, http_error: Type[pyramid.httpexceptions.HTTPError] = HTTPInternalServerError, http_kwargs: magpie.typedefs.ParamsType | None = None, msg_on_fail: magpie.typedefs.Str = '', content: magpie.typedefs.JSON | None = None, content_type: magpie.typedefs.Str = CONTENT_TYPE_JSON, metadata: magpie.typedefs.JSON | None = None) → Any[source]¶

Evaluates the specified call with a wrapped HTTP exception handling. On failure, tries to call.

fallback if specified, and finally raises the specified http_error.

Any potential error generated by fallback or http_error themselves are treated as HTTPInternalServerError.

Exceptions are generated using the standard output method formatted based on specified content_type.

Example:

normal call:

try:
    res = func(args)
except Exception as exc:
    fb_func()
    raise HTTPExcept(exc.message)

wrapped call:

res = evaluate_call(lambda: func(args), fallback=lambda: fb_func(), http_error=HTTPExcept, **kwargs)

Parameters:

call – function to call, MUST be specified as lambda: <function_call>
fallback – function to call (if any) when call failed, MUST be lambda: <function_call>
http_error – alternative exception to raise on call failure
http_kwargs – additional keyword arguments to pass to http_error if called in case of HTTP exception
msg_on_fail – message details to return in HTTP exception if call failed
content – json formatted additional content to provide in case of exception
content_type – format in which to return the exception (one of magpie.common.SUPPORTED_ACCEPT_TYPES)
metadata – request metadata to add to the response body. (see: magpie.api.requests.get_request_info())

Raises:

http_error – on call failure
HTTPInternalServerError – on fallback failure

Returns:

whichever return value call might have if no exception occurred

magpie.adapter.magpieowssecurity.verify_param(param: Any, param_compare: Any | List[Any] | None = None, param_name: magpie.typedefs.Str | None = None, param_content: magpie.typedefs.JSON | None = None, with_param: bool = True, http_error: Type[pyramid.httpexceptions.HTTPError] = HTTPBadRequest, http_kwargs: magpie.typedefs.ParamsType | None = None, msg_on_fail: magpie.typedefs.Str = '', content: magpie.typedefs.JSON | None = None, content_type: magpie.typedefs.Str = CONTENT_TYPE_JSON, metadata: magpie.typedefs.JSON | None = None, not_none: bool = False, not_empty: bool = False, not_in: bool = False, not_equal: bool = False, is_true: bool = False, is_false: bool = False, is_none: bool = False, is_empty: bool = False, is_in: bool = False, is_equal: bool = False, is_type: bool = False, matches: bool = False) → None[source]¶

Evaluate various parameter combinations given the requested verification flags. Given a failing verification, directly raises the specified http_error. Invalid usage exceptions generated by this verification process are treated as HTTPInternalServerError. Exceptions are generated using the standard output method.

Parameters:

param – parameter value to evaluate
param_compare – Other value(s) to test param against. Can be an iterable (single value resolved as iterable unless None). To test for None type, use is_none/not_none flags instead.
param_name – name of the tested parameter returned in response if specified for debugging purposes
param_content – Additional JSON content to apply to generated error content on raise when with_param is True. Must be JSON serializable. Provided content can override generated error parameter if matching fields.
with_param – On raise, adds values of param, param_name and param_compare, as well as additional failing conditions metadata to the JSON response body for each of the corresponding value.
http_error – derived exception to raise on test failure (default: HTTPBadRequest)
http_kwargs – additional keyword arguments to pass to http_error called in case of HTTP exception
msg_on_fail – message details to return in HTTP exception if flag condition failed
content – json formatted additional content to provide in case of exception
content_type – format in which to return the exception (one of magpie.common.SUPPORTED_ACCEPT_TYPES)
metadata – request metadata to add to the response body. (see: magpie.api.requests.get_request_info())
not_none – test that param is not None type
not_empty – test that param is not an empty iterable (string, list, set, etc.)
not_in – test that param does not exist in param_compare values
not_equal – test that param is not equal to param_compare value
is_true – test that param is True
is_false – test that param is False
is_none – test that param is None type
is_empty – test param for an empty iterable (string, list, set, etc.)
is_in – test that param exists in param_compare values
is_equal – test that param equals param_compare value
is_type – test that param is of same type as specified by param_compare type
matches – test that param matches the regex specified by param_compare value

Raises:

HTTPError – if tests fail, specified exception is raised (default: HTTPBadRequest)
HTTPInternalServerError – for evaluation error

Returns:

nothing if all tests passed

magpie.adapter.magpieowssecurity.ProviderSigninAPI[source]¶

class magpie.adapter.magpieowssecurity.LooseVersion(version: str)[source]¶

Bases: packaging.version.Version, VersionInterface

This class abstracts handling of a project’s versions.

A Version instance is comparison aware and can be compared and sorted using the standard Python interfaces.

>>> v1 = Version("1.0a5")
>>> v2 = Version("1.0")
>>> v1
<Version('1.0a5')>
>>> v2
<Version('1.0')>
>>> v1 < v2
True
>>> v1 == v2
False
>>> v1 > v2
False
>>> v1 >= v2
False
>>> v1 <= v2
True

Initialize a Version object.

Parameters:: version – The string representation of a version which will be parsed and normalized before use.
Raises:: InvalidVersion – If the version does not conform to PEP 440 in any way then this exception will be raised.

property version: Tuple[int | str, Ellipsis]¶

property patch¶

_cmp(other: LooseVersion | str) → int[source]¶

magpie.adapter.magpieowssecurity.get_constant(constant_name: magpie.typedefs.Str, settings_container: magpie.typedefs.AnySettingsContainer | None = None, settings_name: magpie.typedefs.Str | None = None, default_value: magpie.typedefs.SettingValue | None = None, raise_not_set: bool = True, raise_missing: bool = True, print_missing: bool = False, empty_missing: bool = False) → magpie.typedefs.SettingValue[source]¶

Search in order for matched value of constant_name:

search in MAGPIE_CONSTANTS
search in settings if specified
search alternative setting names (see below)
search in magpie.constants definitions
search in environment variables

Parameter constant_name is expected to have the format MAGPIE_[VARIABLE_NAME] although any value can be passed to retrieve generic settings from all above-mentioned search locations.

If settings_name is provided as alternative name, it is used as is to search for results if constant_name was not found. Otherwise, magpie.[variable_name] is used for additional search when the format MAGPIE_[VARIABLE_NAME] was used for constant_name (i.e.: MAGPIE_ADMIN_USER will also search for magpie.admin_user and so on for corresponding constants).

Parameters:

constant_name – key to search for a value
settings_container – WSGI application settings container (if not provided, uses found one in current thread)
settings_name – alternative name for settings if specified
default_value – default value to be returned if not found anywhere, and exception raises are disabled.
raise_not_set – raise an exception if the found key is None, search until last case if others are None
raise_missing – raise exception if key is not found anywhere
print_missing – print message if key is not found anywhere, return None
empty_missing – consider an empty value for an existing key as if it was missing (i.e.: as if not set).

Returns:

found value or default_value

Raises:

ValueError – if resulting value is invalid based on options (by default raise missing/empty/None value)
LookupError – if no appropriate value could be found from all search locations (according to options)

magpie.adapter.magpieowssecurity.get_connected_session(request: pyramid.request.Request) → sqlalchemy.orm.session.Session[source]¶: Retrieve the session attached to the request or recreated it to ensure it is open and within scoped transaction.

class magpie.adapter.magpieowssecurity.Service[source]¶

Bases: Resource

Resource of service type.

__tablename__ = 'services'¶

resource_id¶

resource_type_name = 'service'¶

__mapper_args__¶

property permissions¶

property url¶

property type¶
Identifier matching ``magpie.services.ServiceInterface.service_type``.

property sync_type¶
Identifier matching ``magpie.cli.SyncServiceInterface.sync_type``.

property configuration¶

Configuration modifiers for parsing access to resources and permissions.

magpie.adapter.magpieowssecurity¶

Attributes¶

Classes¶

Functions¶

Module Contents¶

Table of Contents

Previous topic

Next topic

This Page