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)

Base schema model

class Config

Pydantic model config

classmethod alias_generator(paramName)

Generate aliases :param paramName: model field name

Return type

str

asDict()

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

Return type

dict

class luna_handlers.classes.schemas.base_schema.HandlerSettings

Container class for service settings.

classmethod initialize(faceDescriptorVersion, bodyDescriptorVersion, livenessRealThreshold, handlersLimitsSettings, attributeStorageSettings)

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

Extended base schema model.

settings

alias of luna_handlers.classes.schemas.base_schema.HandlerSettings

classmethod update()

Update inherit schema.

classmethod updateSchemas()

Run settings update for inherited schemas.

luna_handlers.classes.schemas.base_schema.replaceEqualSuffix(snakeCaseName)

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)

Body upgrade data schema

class luna_handlers.classes.schemas.attribute_upgrade.BodyUpgradePolicy(**data)

Body attribute upgrade policy

class luna_handlers.classes.schemas.attribute_upgrade.FaceUpgradeData(**data)

Face upgrade data schema

class luna_handlers.classes.schemas.attribute_upgrade.FaceUpgradePolicy(**data)

Face attribute upgrade policy

classmethod validatePolicy(values)

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)

Samples for upgrade schema

classmethod validateOneOf(values)

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)

Conditional tags policy schema

execute(events)

Execute additional tags policy

Parameters

events – processing events

Return type

None

class luna_handlers.classes.schemas.conditional_tags_policy.Tag

Tag schema

Module contains schemas for detector handler

class luna_handlers.classes.schemas.detector.Detector(**data)

Model for detector handler with urls or samples

static checkRequiredFaceBBox(values)

Check required face bounding box for incoming image

classmethod validateHandler(values)

Validate handler model

Return type

dict

Module contains schemas for extract policy

class luna_handlers.classes.schemas.extract_policies.BaseExtractPolicy(**data)

Base extract policy

class luna_handlers.classes.schemas.extract_policies.HandlerExtractPolicy(**data)

Handler extract policy schema

Module contains schemas for extractor handler

class luna_handlers.classes.schemas.extractor.Extractor(**data)

Model for extractor handler with samples

Module contains schemas for filters

class luna_handlers.classes.schemas.filters.AttributesFilters(**data)

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)

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)

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)

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)

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)

Cached handler model | contains minimal required fields

classmethod postInit(values)

Post init

static postInitMatchPolicy(matchPolicies, accountId)

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)

Handler model for handler creation

classmethod validateNPostInit(values)

Validate handler, post init

class luna_handlers.classes.schemas.handler.FaceInputEstimationsModel(**data)

Model for incoming face estimations: urls, image or samples

classmethod validateHandler(values)

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, detect_ts: classes.schemas.types.DetectTs = None, image_origin: classes.schemas.types.Str256 = None)

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

classmethod validateHandler(values)

Validate handler model

Return type

dict

class luna_handlers.classes.schemas.handler.SampleForInputEvent(**data)

Sample schema

class luna_handlers.classes.schemas.handler.UrlForInputEvent(**data)

Url schema with detection time and image origin

class luna_handlers.classes.schemas.handler.ValidatorHandlerModel(**data)

Handler validator model

Module contains schemas for match policy

class luna_handlers.classes.schemas.match_policy.AttributeMatchCandidates(**data)

Face match candidates

class luna_handlers.classes.schemas.match_policy.BaseMatchPolicy(**data)

Base match policy schema

async execute(events, luna3Client)

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)

Targets validator, depends on matching candidates

Return type

Optional[List[str]]

class luna_handlers.classes.schemas.match_policy.EventMatchCandidates(**data)

Event match candidates

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

Event match result.

candidates

match candidates

listInfo

matching list info

matchingLabel

matching label

asDict()

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)

Face match candidates

class luna_handlers.classes.schemas.match_policy.GeoPosition(**data)

Geo position: longitude and latitude with deltas

class luna_handlers.classes.schemas.match_policy.MatchPolicy(**data)

Match policy schema

class luna_handlers.classes.schemas.match_policy.OriginEnum(value)

Match candidates origin

Module contains schemas for policies

class luna_handlers.classes.schemas.policies.HandlerConfig(facesBucket, bodiesBucket, originBucket, lunaEventsUsage, lunaSenderUsage, aggregate, useExifInfo, useAutoRotation, faceDescriptorVersion, bodyDescriptorVersion)

Handler config that policies should apply.

class luna_handlers.classes.schemas.policies.Policies(**data)

Policies schema

async checkListsAvailability(luna3Client, accountId)

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

async execute(inputData, eventMetadata, config, luna3Client, redisContext, plugins)

Execute all policies for handler.

Parameters

• inputData – input data (images / raw descriptors)

• eventMetadata – user defined event metadata

• config – handler configuration parameters

• luna3Client – luna platform client

• redisContext – redis context

• plugins – plugin manager

Returns

• estimations in api format

• monitoring data

Return type

tuple[dict, HandlersMonitoringData]

getListIdsFromPolicies()

Get list ids from matching and link to lists policies.

Returns

list ids

Return type

list[UUID]

async classmethod onShutdown()

Stop Policies

async classmethod onStartup()

Init Policies

prepareSDKTaskParams(config)

Prepare sdk task parameters

Returns

sdk task parameters

publishEventsToPlugins(events, plugins)

Publish events to other services.

Parameters

• events – list of events

• plugins – plugin manager

Return type

None

property sdkFilters: sdk.sdk_loop.tasks.filters.Filters

Prepare sdk task filters

Returns

sdk task filters

property sdkTargets: set[Union[sdk.sdk_loop.enums.LoopEstimations, app.api_sdk_adaptors.base.LoopEstimationsAlwaysOn]]

Prepare sdk task targets

Returns

sdk task targets

static validateDetectAndExtractCompatibility(detectPolicy, extractPolicy)

Validate detect and extract policies compatibility

static validateDetectPolicyNotEmpty(detectPolicy)

Validate non-empty detect policy

static validateGeneratedAttributesFilters(detectPolicy, extractPolicy, matchPolicies, conditionalTagsPolicies, storagePolicy)

Validate attributes and detect/extract policy compatibility

static validateMatchAndExtractCompatibility(matchPolicies, extractPolicy)

Validate match and extract policies compatibility

static validateMatchLabelsCompatibility(matchPolicies, conditionalTagsPolicies, storagePolicy)

Validate matching label compatibility

static validateMatchPolicyUniqueLabels(matchPolicies)

Validate match policy matching label uniqueness

classmethod validatePolicies(values)

Execute all compatibility validators

luna_handlers.classes.schemas.policies.getObjectRecursively(data, expectedType)

Recursively get object of expected type

Return type

list[~T]

Module contains schemas for multipart requests

class luna_handlers.classes.schemas.multipart.FileNameWithBodyBBs(**data)

Model for filename with body bounding boxes

class luna_handlers.classes.schemas.multipart.FileNameWithDetectionRelativeTimestamp(**data)

Model for list of filename with image detect relative detection timestamp

class luna_handlers.classes.schemas.multipart.FileNameWithDetectionTime(**data)

Model for list of filename with image detect time

class luna_handlers.classes.schemas.multipart.FileNameWithFaceBBs(**data)

Model for filename with face bounding boxes

class luna_handlers.classes.schemas.multipart.FileNameWithImageOrigin(**data)

Model for list of filename with image origin

Module contains schemas for sdk handler

class luna_handlers.classes.schemas.sdk.SDKInputEstimationsModel(**data)

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

classmethod validateHandler(values)

Validate handler model

Return type

dict

Module contains simple schemas for multiple usage

class luna_handlers.classes.schemas.simple_schemas.BoundingBoxSchema(**data)

Bounding box schema

class luna_handlers.classes.schemas.simple_schemas.UrlBboxSchema(**data)

Url with face and body bounding boxes schema

class luna_handlers.classes.schemas.simple_schemas.UrlWithFaceBbox(**data)

Url with face bounding boxes schema

Module contains schemas for storage policy

class luna_handlers.classes.schemas.storage_policy.AttributeStorePolicy(**data)

Attribute store policy

async execute(events, luna3Client)

Save attributes.

Parameters

• events – events

• luna3Client – client

Return type

None

class luna_handlers.classes.schemas.storage_policy.BodySamplePolicy(**data)

Body sample policy

async execute(events, sources, bucket, luna3Client)

Save body samples.

Parameters

• events – events

• sources – origin image sources

• bucket – bucket name

• luna3Client – client

class luna_handlers.classes.schemas.storage_policy.EventStoragePolicy(**data)

Event store policy

async execute(events, luna3Client, lunaEventsUsage)

Save events.

Parameters

• events – events

• luna3Client – client

• lunaEventsUsage – use or not luna events

Return type

None

async classmethod onShutdown()

Stop Policies

async classmethod onStartup()

Init Policies

class luna_handlers.classes.schemas.storage_policy.FaceSamplePolicy(**data)

Face sample policy

async execute(events, sources, bucket, luna3Client)

Save face samples.

Parameters

• events – events

• sources – origin image sources

• bucket – bucket name

• luna3Client – client

class luna_handlers.classes.schemas.storage_policy.FaceStoragePolicy(**data)

Face store policy

async execute(events, luna3Client)

Execute face policy (with link to list policy).

Parameters

• events – processing events

• luna3Client – luna3 client

Return type

None

class luna_handlers.classes.schemas.storage_policy.ImageOriginPolicy(**data)

Image origin policy

async execute(events, sources, bucket, luna3Client)

Save origin images.

Parameters

• events – events

• sources – origin image sources

• bucket – bucket name

• luna3Client – client

Return type

None

class luna_handlers.classes.schemas.storage_policy.LinkToListsPolicy(**data)

Link to lists policy schema

class luna_handlers.classes.schemas.storage_policy.MetaAttribute(sdkAttribute, sampleIds)

Attribute.

class luna_handlers.classes.schemas.storage_policy.MetaWarp(warpedImage, sampleId=None)

Warp.

sampleId

sample id

Type

str

warpedImage

warped image

Type

Union[bytes, FaceWarpedImage, HumanWarpedImage]

asBytes()

Returns

warp binary representation

Return type

bytes

class luna_handlers.classes.schemas.storage_policy.NotificationStoragePolicy(**data)

Notification store policy

async execute(events, redisContext, lunaSenderUsage)

Save notifications :param events: events :param redisContext: redis context :param lunaSenderUsage: use or not luna sender

Return type

None

class luna_handlers.classes.schemas.storage_policy.StoragePolicy(**data)

Storage policy schema

async execute(sources, events, config, luna3Client, redisContext)

Execute storage policy - save objects.

Parameters

• sources – origin image sources

• events – events to process

• config – app config

• luna3Client – client

• redisContext – redis context

Returns

monitoring data

Return type

HandlersMonitoringData

class luna_handlers.classes.schemas.storage_policy.StorePolicyConfig(facesBucket, bodiesBucket, originBucket, lunaEventsUsage, lunaSenderUsage)

Handler config that policies should apply.

async luna_handlers.classes.schemas.storage_policy.saveAttributes(attributesToSave, accountId, facesClient, ttl)

Save attributes.

Parameters

• attributesToSave – attributes

• accountId – account id

• facesClient – faces client

• ttl – time to store attribute

Return type

None

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

Save warps in LIS.

Parameters

• warpsToSave – SDK warps to save

• bucket – bucket name

• accountId – account id

• storeApiClient – image-store client

Module contains schemas for verifier

class luna_handlers.classes.schemas.verifier.VerifierAttributeStorePolicy(**data)

Verifier attribute storage policy

async execute(events, luna3Client)

Save attributes.

Parameters

• events – events

• luna3Client – client

Return type

None

class luna_handlers.classes.schemas.verifier.VerifierConfig(useExifInfo, useAutoRotation, faceDescriptorVersion, facesBucket)

Verifier config that policies should apply.

class luna_handlers.classes.schemas.verifier.VerifierDetectPolicy(**data)

Verifier detect policy

class luna_handlers.classes.schemas.verifier.VerifierExtractPolicy(**data)

Verifier extract policy

class luna_handlers.classes.schemas.verifier.VerifierFaceSampleStorePolicy(**data)

Verifier face sample storage policy

async execute(events, sources, bucket, luna3Client)

Save face samples.

Parameters

• events – events

• bucket – bucket name

• luna3Client – client

class luna_handlers.classes.schemas.verifier.VerifierInputEstimationsModel(**data)

Verifier model for incoming estimations: urls, image (only face bounding boxes available) or samples

class luna_handlers.classes.schemas.verifier.VerifierMatchPolicy(**data)

Verifier match policy schema

class luna_handlers.classes.schemas.verifier.VerifierModel(**data)

Verifier

class luna_handlers.classes.schemas.verifier.VerifierPoliciesModel(**data)

Verifier policies

buildVerifications(matches)

Build verification result in api format. :param matches: matches result

Returns

verification result in api format

Return type

list[dict]

async execute(inputData, config, matchPolicies, accountId, luna3Client, facesBucket)

Executes given policies against provided data.

Parameters

• inputData – input data (images / raw descriptors)

• config – handler configuration parameters

• matchPolicies – MatchingPolicy instances

• accountId – A str, account id

• luna3Client – A luna3 client instance

• facesBucket – faces samples bucket

Returns

• estimations in api format

• monitoring data

Return type

tuple[dict, HandlersMonitoringData]

prepareSDKTaskParams(config)

Prepare sdk task parameters

Returns

sdk task parameters

property sdkFilters: sdk.sdk_loop.tasks.filters.Filters

Prepare sdk task filters

Returns

sdk task filters

property sdkTargets: set[Union[sdk.sdk_loop.enums.LoopEstimations, app.api_sdk_adaptors.base.LoopEstimationsAlwaysOn]]

Prepare sdk task targets

Returns

sdk task targets

class luna_handlers.classes.schemas.verifier.VerifierStoragePolicy(**data)

Verifier storage policy

async execute(sources, events, luna3Client, facesBucket)

Execute storage policy - save objects. :param sources: origin image sources :param events: events :param facesBucket: faces samples bucket :param luna3Client: luna3 client

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='')

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

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

classmethod validateDatetime(value)

Validate value is not string :param value: input value

Returns

datetime in string format

Return type

str

class luna_handlers.classes.schemas.types.CustomExtendedDatetime

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

classmethod initialize(storageTime)

Initialize storage time :param storageTime: storage time - utc or local

classmethod validateDatetime(value)

Validate value is not string :param value: input value

Returns

datetime in string format

Return type

str

class luna_handlers.classes.schemas.types.CustomFloat

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

classmethod validateNonStr(value)

Validate value is not string

Return type

float

class luna_handlers.classes.schemas.types.DetectTs

User-defined timestamp relative to something, such as the start of a video

luna_handlers.classes.schemas.types.FaceDescriptorVersion

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

class luna_handlers.classes.schemas.types.Float01

Non-strict float in range 0.0 - 1.0

class luna_handlers.classes.schemas.types.Float180

Strict float in range -180 to 180

class luna_handlers.classes.schemas.types.FloatGeoDelta(x=0, /)

Non-strict float for latitude in range 0.0 - 9.0

class luna_handlers.classes.schemas.types.FloatLatitude(x=0, /)

Non-strict float for latitude in range -90.0 - 90.0

class luna_handlers.classes.schemas.types.FloatLongitude(x=0, /)

Non-strict float for longitude in range -180.0 - 180.0

class luna_handlers.classes.schemas.types.GeoPosition(**data)

class luna_handlers.classes.schemas.types.Int01

Int in range 0 - 1

class luna_handlers.classes.schemas.types.Int02

Int in range 0 - 2

class luna_handlers.classes.schemas.types.IntAge

Int in range 0 - 100

class luna_handlers.classes.schemas.types.IntAngle180

Int for angles - in range 0 - 180

class luna_handlers.classes.schemas.types.IntAttributeTTL

Int in range 0 - MAX_ATTRIBUTE_TTL

classmethod update()

Update inherit schema.

class luna_handlers.classes.schemas.types.IntEmotions

Int in range of available emotions values

class luna_handlers.classes.schemas.types.IntEthnicities

Int in range of available ethnicities values

class luna_handlers.classes.schemas.types.IntLiveness

Int in range of available liveness state values

class luna_handlers.classes.schemas.types.IntMasks

Int in range of available masks values

class luna_handlers.classes.schemas.types.IntMatchingLimit

Int in range 0 - RESULT_CANDIDATE_LIMIT

classmethod update()

Update inherit schema.

class luna_handlers.classes.schemas.types.IntNonNegative

Int non negative

luna_handlers.classes.schemas.types.OptionalNotNullable()

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

Int in range from min to max SDK magic numbers

class luna_handlers.classes.schemas.types.Str128

Strict string 128 len max

class luna_handlers.classes.schemas.types.Str256

Strict string 128 len max

class luna_handlers.classes.schemas.types.Str36

Strict string 36 len max

class luna_handlers.classes.schemas.types.StrictFloat01

Strict float in range 0.0 - 1.0

class luna_handlers.classes.schemas.types.StrictFloatNonNegative

Strict float non negative

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

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)

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)

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]]