magpie.permissions

Module Contents

Classes

Permission

Applicable Permission values under certain Service and Resource.

Functions

convert_permission(permission: AnyPermissionType) → Optional[Permission]

Converts any permission representation to the Permission enum.

format_permissions(permissions: Iterable[AnyPermissionType]) → List[Str]

Obtains the formatted permission representation after validation that it is a member of Permission enum.
class magpie.permissions.Permission[source]

Bases: magpie.utils.ExtendedEnum

Applicable Permission values under certain Service and Resource.

Create and return a new object. See help(type) for accurate signature.

READ = read[source]
READ_MATCH = read-match[source]
WRITE = write[source]
WRITE_MATCH = write-match[source]
ACCESS = access[source]
GET_CAPABILITIES = getcapabilities[source]
GET_MAP = getmap[source]
GET_FEATURE_INFO = getfeatureinfo[source]
GET_LEGEND_GRAPHIC = getlegendgraphic[source]
GET_METADATA = getmetadata[source]
GET_FEATURE = getfeature[source]
DESCRIBE_FEATURE_TYPE = describefeaturetype[source]
DESCRIBE_PROCESS = describeprocess[source]
EXECUTE = execute[source]
LOCK_FEATURE = lockfeature[source]
TRANSACTION = transaction[source]
magpie.permissions.convert_permission(permission: AnyPermissionType) → Optional[Permission][source]

Converts any permission representation to the Permission enum.

If the permission cannot be matched to one of the enum’s value, None is returned instead.

magpie.permissions.format_permissions(permissions: Iterable[AnyPermissionType]) → List[Str][source]

Obtains the formatted permission representation after validation that it is a member of Permission enum.

The returned list is sorted alphabetically and cleaned of any duplicate entries.