Validate schemas¶

Module contains base schema for other complex pydantic models and simple schemas to use in other places

class luna_handlers.classes.schemas.base_schema.BaseSchema(**data)[source]

Base schema model

class Config[source]

Pydantic model config

classmethod alias_generator(paramName)[source]

Generate aliases :param paramName: model field name

Return type: str

asDict()[source]

Get data from initialized model :returns: dict with snake_case keys

Return type: dict

class luna_handlers.classes.schemas.base_schema.HandlerSettings[source]

Container class for service settings.

classmethod initialize(faceDescriptorVersion, bodyDescriptorVersion, livenessRealThreshold, handlersLimitsSettings, attributeStorageSettings)[source]

Initialize settings for schemas.

Parameters

faceDescriptorVersion – default face descriptor version
bodyDescriptorVersion – default body descriptor version
livenessRealThreshold – default liveness threshold setting
handlersLimitsSettings – luna handlers limits settings
attributeStorageSettings – attribute storage settings

class luna_handlers.classes.schemas.base_schema.SchemaUpdaterMixin[source]

Extended base schema model.

settings: alias of luna_handlers.classes.schemas.base_schema.HandlerSettings

classmethod update()[source]: Update inherit schema.

classmethod updateSchemas()[source]: Run settings update for inherited schemas.

luna_handlers.classes.schemas.base_schema.replaceEqualSuffix(snakeCaseName)[source]

Replace gt/gte/lt/lte suffix contains one underline with two underlines :param snakeCaseName: key in snake_case

Return type: str

Module contains schemas for attribute upgrade handler

class luna_handlers.classes.schemas.attribute_upgrade.BodyUpgradeData(**data)[source]: Body upgrade data schema

class luna_handlers.classes.schemas.attribute_upgrade.BodyUpgradePolicy(**data)[source]: Body attribute upgrade policy

class luna_handlers.classes.schemas.attribute_upgrade.FaceUpgradeData(**data)[source]: Face upgrade data schema

class luna_handlers.classes.schemas.attribute_upgrade.FaceUpgradePolicy(**data)[source]

Face attribute upgrade policy

classmethod validatePolicy(values)[source]: Validate attributes are select for extract :raises VLException(Error.NotSelectedAttributesForExtract, 400, False) if no attributes select for extract:

class luna_handlers.classes.schemas.attribute_upgrade.SamplesForUpgrade(**data)[source]

Samples for upgrade schema

classmethod validateOneOf(values)[source]: Validate one of request value:

‘face_id’ and ‘upgrade_data’ or ‘event_id’ and ‘face_upgrade_data’ and/or ‘body_upgrade_data’

Module contains schemas for conditional tags policy

class luna_handlers.classes.schemas.conditional_tags_policy.ConditionalTagsPolicy(**data)[source]

Conditional tags policy schema

execute(events)[source]

Execute additional tags policy

Parameters: events – processing events
Return type: None

class luna_handlers.classes.schemas.conditional_tags_policy.Tag[source]: Tag schema

Module contains schemas for detector handler

class luna_handlers.classes.schemas.detector.Detector(**data)[source]

Model for detector handler with urls or samples

static checkRequiredFaceBBox(values)[source]: Check required face bounding box for incoming image

classmethod validateHandler(values)[source]

Validate handler model

Return type: dict

Module contains schemas for extract policy

class luna_handlers.classes.schemas.extract_policies.BaseExtractPolicy(**data)[source]: Base extract policy

class luna_handlers.classes.schemas.extract_policies.HandlerExtractPolicy(**data)[source]: Handler extract policy schema

Module contains schemas for extractor handler

class luna_handlers.classes.schemas.extractor.Extractor(**data)[source]: Model for extractor handler with samples

Module contains schemas for filters

class luna_handlers.classes.schemas.filters.AttributesFilters(**data)[source]

Matching filters schema

property isEmpty: bool

Check there is nothing to filter.

Returns: True if all filters are equal to their defaults
Return type: bool

isEventSatisfies(event)[source]

Does event satisfy filters by face attributes.

Parameters: event – event
Returns: true if event satisfied a filters otherwise false
Return type: bool

class luna_handlers.classes.schemas.filters.ComplexFilter(**data)[source]

Complex filter - includes attributes and list of match filters

property isEmpty: bool

Check there is nothing to filter.

Returns: True if all filters are equal to None
Return type: bool

isEventSatisfies(event)[source]

Does an event satisfy the filters.

Parameters: event – event
Returns: true if event satisfied filters otherwise false
Return type: bool

class luna_handlers.classes.schemas.filters.MatchFilter(**data)[source]

Simple match filter

property isEmpty: bool

Check there is nothing to filter.

Returns: True if all filters are equal to their defaults
Return type: bool

Module contains schemas for handler

class luna_handlers.classes.schemas.handler.CachedHandlerModel(**data)[source]

Cached handler model | contains minimal required fields

classmethod postInit(values)[source]: Post init

static postInitMatchPolicy(matchPolicies, accountId)[source]

Post init matching policy - apply handler account id for matching candidates :param matchPolicies: matching policies :param accountId: handler account id

Return type: None

class luna_handlers.classes.schemas.handler.CreateHandlerModel(**data)[source]

Handler model for handler creation

classmethod validateNPostInit(values)[source]: Validate handler, post init

class luna_handlers.classes.schemas.handler.FaceInputEstimationsModel(**data)[source]

Model for incoming face estimations: urls, image or samples

classmethod validateHandler(values)[source]

Validate handler model

Return type: dict

class luna_handlers.classes.schemas.handler.HandlerInputEstimationsModel(*, image: str = None, mimetype: str = None, face_bounding_boxes: types.ConstrainedListValue[classes.schemas.simple_schemas.BoundingBoxSchema] = None, body_bounding_boxes: types.ConstrainedListValue[classes.schemas.simple_schemas.BoundingBoxSchema] = None, urls: classes.schemas.types.userConstrainedList.<locals>.UserConstrainedList[luna_handlers.classes.schemas.handler.UrlForInputEvent] = None, samples: typing.Union[classes.schemas.types.userConstrainedList.<locals>.UserConstrainedList[luna_handlers.classes.schemas.handler.SampleForInputEvent], classes.schemas.types.userConstrainedList.<locals>.UserConstrainedList[uuid.UUID]] = None, detect_time: classes.schemas.types.CustomDatetime = None, image_origin: classes.schemas.types.Str256 = None)[source]

Handler model for incoming estimations: urls, image(with face and/or body bounding boxes) or samples

classmethod validateHandler(values)[source]

Validate handler model

Return type: dict

class luna_handlers.classes.schemas.handler.SampleForInputEvent(**data)[source]: Sample schema

class luna_handlers.classes.schemas.handler.UrlForInputEvent(**data)[source]: Url schema with detection time and image origin

class luna_handlers.classes.schemas.handler.ValidatorHandlerModel(**data)[source]: Handler validator model

Module contains schemas for match policy

class luna_handlers.classes.schemas.match_policy.AttributeMatchCandidates(**data)[source]: Face match candidates

class luna_handlers.classes.schemas.match_policy.BaseMatchPolicy(**data)[source]

Base match policy schema

async execute(events, luna3Client)[source]

Execute match policy:

filter events fo matching
match events’ descriptors with policy candidates

Results are stored in the input events.

Parameters

events – events (references)
luna3Client – client

Return type

None

classmethod targetsValidator(targets, values)[source]

Targets validator, depends on matching candidates

Return type: Optional[List[str]]

class luna_handlers.classes.schemas.match_policy.EventMatchCandidates(**data)[source]: Event match candidates

class luna_handlers.classes.schemas.match_policy.EventMatchResult(matchingLabel, matchResult)[source]

Event match result.

candidates: match candidates

listInfo: matching list info

matchingLabel: matching label

asDict()[source]

Get Event match results without matching label as dict :returns: dict with matching candidates and matching label

Return type: dict

class luna_handlers.classes.schemas.match_policy.FaceMatchCandidates(**data)[source]: Face match candidates

class luna_handlers.classes.schemas.match_policy.GeoPosition(**data)[source]: Geo position: longitude and latitude with deltas

class luna_handlers.classes.schemas.match_policy.MatchPolicy(**data)[source]: Match policy schema

class luna_handlers.classes.schemas.match_policy.OriginEnum(value)[source]: Match candidates origin

Module contains schemas for policies

class luna_handlers.classes.schemas.policies.Policies(**data)[source]

Policies schema

async checkListsAvailability(luna3Client, accountId)[source]

Check availability of lists from matching and link to list policies.

Parameters

luna3Client – luna platform client
accountId – account id

Raises

VLException(Error.ListNotFound.format(listId), 400, False), if some list is not found –

Return type

None

static enrichEventsWithMetadata(events, source, tags, userData, externalId, location, trackId=None)[source]

Enrich processing event with metadata.

Parameters

events – events
source – event source
tags – event tags
userData – user data
externalId – event external id
location – event location
trackId – (str) event track id

Return type

None

async execute(accountId, inputData, sdkLoop, luna3Client, aggregate, userData, externalId, source, userDefinedTags, location, logger, createEventTime, endEventTime, handlerId, trackId, plugins, redisContext, facesBucket, bodiesBucket, originBucket, lunaEventsUsage, lunaSenderUsage)[source]

Execute all policies for handler.

Parameters

accountId – account id
inputData – a list of input images (or warps) or descriptors
sdkLoop – sdk loop
luna3Client – luna platform client
aggregate – aggregate all extracted samples to one or not
userData – user data for created faces
externalId – external id for created faces
source – user-defined source
userDefinedTags – user-defined tags
location – user-defined location
logger – logger
createEventTime – event creation time
endEventTime – event end time
handlerId – handler id
trackId – event track id
plugins – plugin manager
redisContext – redis context
facesBucket – faces sample bucket
bodiesBucket – bodies sample bucket
originBucket – origin image bucket
lunaEventsUsage – luna events usage
lunaSenderUsage – luna sender usage

Returns

tuple, first - all detection, second - events, third - monitoring data

Raises

VLException(Error.AggregationNotSupported) if aggregate flag enabled and raw descriptor data received –

Return type

Tuple[List[dict], List[Event], Dict[str, List[dict]], HandlersMonitoringData]

getListIdsFromPolicies()[source]

Get list ids from matching and link to lists policies.

Returns: list ids
Return type: List[UUID]

async classmethod onShutdown()[source]: Stop Policies

async classmethod onStartup()[source]: Init Policies

prepareSDKTask(sdkData, aggregate)[source]

Prepare sdk task :param sdkData: a list of input images or warps :param aggregate: aggregate all extracted samples to one or not

Returns: sdk task
Return type: SDKTask

publishEventsToPlugins(events, handlerId, createEventTime, endEventTime, plugins, logger, accountId)[source]

Publish events to other services.

Parameters

events – list of events
handlerId – handler id
createEventTime – event creation time
endEventTime – event end time
plugins – plugin manager
logger – logger
accountId – account id

Return type

None

static validateDetectAndExtractCompatibility(detectPolicy, extractPolicy)[source]: Validate detect and extract policies compatibility

static validateDetectPolicyNotEmpty(detectPolicy)[source]: Validate non-empty detect policy

static validateGeneratedAttributesFilters(detectPolicy, extractPolicy, matchPolicies, conditionalTagsPolicies, storagePolicy)[source]: Validate attributes and detect/extract policy compatibility

static validateMatchAndExtractCompatibility(matchPolicies, extractPolicy)[source]: Validate match and extract policies compatibility

static validateMatchLabelsCompatibility(matchPolicies, conditionalTagsPolicies, storagePolicy)[source]: Validate matching label compatibility

static validateMatchPolicyUniqueLabels(matchPolicies)[source]: Validate match policy matching label uniqueness

classmethod validatePolicies(values)[source]: Execute all compatibility validators

luna_handlers.classes.schemas.policies.getImagesReplyData(sdkData, images, extractExif)[source]

Get images’ processing data in reply format.

Parameters

sdkData – sdk data
images – images
extractExif – whether to extract exif

Returns

list of images with status, filename, etc

Return type

List[dict]

luna_handlers.classes.schemas.policies.getObjectRecursively(data, expectedType)[source]

Recursively get object of expected type

Return type: List[~T]

Module contains schemas for multipart requests

class luna_handlers.classes.schemas.multipart.FileNameWithBodyBBs(**data)[source]: Model for filename with body bounding boxes

class luna_handlers.classes.schemas.multipart.FileNameWithDetectionTime(**data)[source]: Model for list of filename with image detect time

class luna_handlers.classes.schemas.multipart.FileNameWithFaceBBs(**data)[source]: Model for filename with face bounding boxes

class luna_handlers.classes.schemas.multipart.FileNameWithImageOrigin(**data)[source]: Model for list of filename with image origin

Module contains schemas for sdk handler

class luna_handlers.classes.schemas.sdk.SDKInputEstimationsModel(**data)[source]

SDK model for incoming estimations: urls, samples or image with/without face/body bounding boxes

classmethod validateHandler(values)[source]

Validate handler model

Return type: dict

Module contains simple schemas for multiple usage

class luna_handlers.classes.schemas.simple_schemas.BoundingBoxSchema(**data)[source]: Bounding box schema

class luna_handlers.classes.schemas.simple_schemas.UrlBboxSchema(**data)[source]: Url with face and body bounding boxes schema

class luna_handlers.classes.schemas.simple_schemas.UrlWithFaceBbox(**data)[source]: Url with face bounding boxes schema

Module contains schemas for storage policy

class luna_handlers.classes.schemas.storage_policy.AttributeStorePolicy(**data)[source]

Attribute store policy

async execute(events, accountId, luna3Client)[source]

Save attributes.

Parameters

events – events
accountId – account id
luna3Client – client

Return type

None

class luna_handlers.classes.schemas.storage_policy.BodySamplePolicy(**data)[source]

Body sample policy

async execute(events, bucket, accountId, luna3Client)[source]

Save body samples.

Parameters

events – events
bucket – bucket name
accountId – account id
luna3Client – client

Return type

None

class luna_handlers.classes.schemas.storage_policy.EventStoragePolicy(**data)[source]

Event store policy

async execute(logger, events, luna3Client, createEventTime, endEventTime, accountId, handlerId, lunaEventsUsage)[source]

Save events.

Parameters

logger – logger
events – events
luna3Client – client
createEventTime – event creation time
endEventTime – event end time
accountId – account id
handlerId – handler id
lunaEventsUsage – use or not luna events

Return type

None

async classmethod onShutdown()[source]: Stop Policies

async classmethod onStartup()[source]: Init Policies

class luna_handlers.classes.schemas.storage_policy.FaceSamplePolicy(**data)[source]

Face sample policy

async execute(events, bucket, accountId, luna3Client)[source]

Save face samples.

Parameters

events – events
bucket – bucket name
accountId – account id
luna3Client – client

Return type

None

class luna_handlers.classes.schemas.storage_policy.FaceStoragePolicy(**data)[source]

Face store policy

async execute(events, accountId, luna3Client, userData='', externalId=None)[source]

Execute face policy (with link to list policy).

Parameters

events – processing events
accountId – account id
luna3Client – luna3 client
userData – user data for all faces
externalId – external for all faces

Return type

None

class luna_handlers.classes.schemas.storage_policy.ImageOriginPolicy(**data)[source]

Image origin policy

async execute(events, bucket, accountId, luna3Client, originImages)[source]

Save origin images.

Parameters

events – events
bucket – bucket name
accountId – account id
luna3Client – client
originImages – list of input images

Return type

None

class luna_handlers.classes.schemas.storage_policy.LinkToListsPolicy(**data)[source]: Link to lists policy schema

class luna_handlers.classes.schemas.storage_policy.NotificationStoragePolicy(**data)[source]

Notification store policy

async execute(events, logger, handlerId, createEventTime, endEventTime, accountId, redisContext, lunaSenderUsage)[source]

Save notifications :param events: events :param logger: logger :param handlerId: handler id :param createEventTime: event creation time :param endEventTime: event end time :param accountId: account id :param redisContext: redis context :param lunaSenderUsage: use or not luna sender

Return type: None

class luna_handlers.classes.schemas.storage_policy.StoragePolicy(**data)[source]

Storage policy schema

async execute(events, accountId, luna3Client, originImages, userData, externalId, logger, createEventTime, endEventTime, handlerId, facesBucket, bodiesBucket, originBucket, lunaEventsUsage, redisContext, lunaSenderUsage)[source]

Execute storage policy - save objects.

Parameters

events – events to process
accountId – account id
luna3Client – client
originImages – data with origin images
userData – user data
externalId – external id
logger – logger
createEventTime – event creation time
endEventTime – event end time
handlerId – handler id
facesBucket – faces samples bucket
bodiesBucket – bodies samples bucket,
originBucket – origin image bucket,
lunaEventsUsage – luna events usage
redisContext – redis context
lunaSenderUsage – luna sender usage

Returns

monitoring data

Return type

HandlersMonitoringData

async luna_handlers.classes.schemas.storage_policy.saveSamples(warpsToSave, bucket, accountId, storeApiClient)[source]

Save warps in LIS.

Parameters

warpsToSave – SDK warps to save
bucket – bucket name
accountId – account id
storeApiClient – image-store client

Return type

List[str]

Module contains schemas for verifier

class luna_handlers.classes.schemas.verifier.VerifierAttributeStorePolicy(**data)[source]

Verifier attribute storage policy

async execute(events, accountId, luna3Client)[source]

Save attributes.

Parameters

events – events
accountId – account id
luna3Client – client

Return type

None

class luna_handlers.classes.schemas.verifier.VerifierDetectPolicy(**data)[source]: Verifier detect policy

class luna_handlers.classes.schemas.verifier.VerifierExtractPolicy(**data)[source]: Verifier extract policy

class luna_handlers.classes.schemas.verifier.VerifierFaceSampleStorePolicy(**data)[source]

Verifier face sample storage policy

async execute(events, bucket, accountId, luna3Client)[source]

Save face samples.

Parameters

events – events
bucket – bucket name
accountId – account id
luna3Client – client

Return type

None

class luna_handlers.classes.schemas.verifier.VerifierInputEstimationsModel(**data)[source]: Verifier model for incoming estimations: urls, image (only face bounding boxes available) or samples

class luna_handlers.classes.schemas.verifier.VerifierMatchPolicy(**data)[source]: Verifier match policy schema

class luna_handlers.classes.schemas.verifier.VerifierModel(**data)[source]: Verifier

class luna_handlers.classes.schemas.verifier.VerifierPoliciesModel(**data)[source]

Verifier policies

async execute(accountId, inputData, sdkLoop, luna3Client, logger, matchPolicies, facesBucket)[source]

Executes given policies against provided data.

Parameters

accountId – A str, account id
inputData – A list of images/descriptors
sdkLoop – A sdk loop instance
luna3Client – A luna3 client instance
logger – A Logger instance
matchPolicies – MatchingPolicy instances
facesBucket – faces samples bucket

Returns

tuple, first - all detection, second - events, third - monitoring data

Return type

Tuple[List[dict], List[Event], Dict[str, List[dict]], HandlersMonitoringData]

prepareSDKTask(sdkData, aggregate)[source]

Prepare sdk task :param sdkData: a list of input images or warps :param aggregate: aggregate all extracted samples to one or not

Returns: sdk task
Return type: SDKTask

class luna_handlers.classes.schemas.verifier.VerifierStoragePolicy(**data)[source]

Verifier storage policy

async execute(events, accountId, luna3Client, facesBucket)[source]

Execute storage policy - save objects. :param events: events :param accountId: account id :param luna3Client: luna 3 client :param facesBucket: faces samples bucket

Returns: monitoring data
Return type: HandlersMonitoringData

Types¶

Module contains custom basics for validation schemas It highly recommended to use represented classes instead of pydantic defaults!

luna_handlers.classes.schemas.types.BodyDescriptorVersion: alias of luna_handlers.classes.schemas.types.Choice.<locals>._Class

luna_handlers.classes.schemas.types.Choice(options, title='')[source]

Choice model generator :param options: available options :param title: title fo option

Returns: Class for pydantic with choice validation
Return type: Type[~T]

class luna_handlers.classes.schemas.types.CustomDatetime[source]

Custom extended datetime - do not use default if it needs to get attribute as str in ISO-format,

classmethod validateDatetime(value)[source]

Validate value is not string :param value: input value

Returns: datetime in string format
Return type: str

class luna_handlers.classes.schemas.types.CustomExtendedDatetime[source]

Custom datetime - do not use default if it needs to get attribute as str in ISO-format

classmethod initialize(storageTime)[source]: Initialize storage time :param storageTime: storage time - utc or local

classmethod validateDatetime(value)[source]

Validate value is not string :param value: input value

Returns: datetime in string format
Return type: str

class luna_handlers.classes.schemas.types.CustomFloat[source]

Custom float - same as default pydantic non-strict float, but not allow to use string as float

classmethod validateNonStr(value)[source]

Validate value is not string

Return type: float

luna_handlers.classes.schemas.types.FaceDescriptorVersion: alias of luna_handlers.classes.schemas.types.Choice.<locals>._Class

class luna_handlers.classes.schemas.types.Float01[source]: Non-strict float in range 0.0 - 1.0

class luna_handlers.classes.schemas.types.FloatGeoDelta(x=0, /)[source]: Non-strict float for latitude in range 0.0 - 9.0

class luna_handlers.classes.schemas.types.FloatLatitude(x=0, /)[source]: Non-strict float for latitude in range -90.0 - 90.0

class luna_handlers.classes.schemas.types.FloatLongitude(x=0, /)[source]: Non-strict float for longitude in range -180.0 - 180.0

class luna_handlers.classes.schemas.types.GeoPosition(**data)[source]

class luna_handlers.classes.schemas.types.Int01[source]: Int in range 0 - 1

class luna_handlers.classes.schemas.types.Int02[source]: Int in range 0 - 2

class luna_handlers.classes.schemas.types.IntAge[source]: Int in range 0 - 100

class luna_handlers.classes.schemas.types.IntAngle180[source]: Int for angles - in range 0 - 180

class luna_handlers.classes.schemas.types.IntAttributeTTL[source]

Int in range 0 - MAX_ATTRIBUTE_TTL

classmethod update()[source]: Update inherit schema.

class luna_handlers.classes.schemas.types.IntEmotions[source]: Int in range of available emotions values

class luna_handlers.classes.schemas.types.IntEthnicities[source]: Int in range of available ethnicities values

class luna_handlers.classes.schemas.types.IntLiveness[source]: Int in range of available liveness state values

class luna_handlers.classes.schemas.types.IntMasks[source]: Int in range of available masks values

class luna_handlers.classes.schemas.types.IntMatchingLimit[source]

Int in range 0 - RESULT_CANDIDATE_LIMIT

classmethod update()[source]: Update inherit schema.

luna_handlers.classes.schemas.types.OptionalNotNullable()[source]

Pydantic hack for not required not nullable fields. If field does not present in an input json will be initialize of the None, if field is present as null in the input json will be raise corresponding error. .. rubric:: Examples

>>> class A(BaseModel):
>>>     id: int
>>>     description: str = OptionalNotNullable()
if input json is equal to `{"id": 1, "description": None}` will be raize the error.
if input json is equal to `{"id": 1}` will be correct parsing.

Returns: Field with default None
Return type: Any

class luna_handlers.classes.schemas.types.SDKInt[source]: Int in range from min to max SDK magic numbers

class luna_handlers.classes.schemas.types.Str128[source]: Strict string 128 len max

class luna_handlers.classes.schemas.types.Str256[source]: Strict string 128 len max

class luna_handlers.classes.schemas.types.Str36[source]: Strict string 36 len max

class luna_handlers.classes.schemas.types.StrictFloat01(x=0, /)[source]: Non-strict float in range 0.0 - 1.0

luna_handlers.classes.schemas.types.getNonNullableOptionalListField(maxItems=None, minItems=None)[source]

Get non nullable optional list field - there is no default mechanism in pydantic at the moment :param maxItems: max list items :param minItems: min list items

Returns: prepared pydantic Field
Return type: Field

luna_handlers.classes.schemas.types.isNumber(value)[source]

Check that object is float or int :param value: object

Returns: object
Raises: FloatError – if object is not number

luna_handlers.classes.schemas.types.userConstrainedList(itemType, minItems=None, maxItems=None, minItemsGetter=None, maxItemsGetter=None)[source]

Create pydantic constrained list for schema validation. Update list constraints after creating a service app.

Parameters

itemType – list item type
minItems – set min items permanently
maxItems – set max items permanently
minItemsGetter – set min items from callable object
maxItemsGetter – set max items from callable object

Returns

user constrained list

Return type

Type[List[~T]]