plynx.constants

Main PLynx constants defined in this module

Package Contents

class plynx.constants.Collections[source]

All basic collections used in DB

NODE_CACHE :str = node_cache
RUN_CANCELLATIONS :str = run_cancellations
RUNS :str = runs
TEMPLATES :str = templates
USERS :str = users
WORKER_STATE :str = worker_state
HUB_NODE_REGISTRY :str = hub_node_registry
plynx.constants.IGNORED_CACHE_PARAMETERS[source]
class plynx.constants.NodeClonePolicy[source]

Clone algorithm

NODE_TO_NODE :int = 0
NODE_TO_RUN :int = 1
RUN_TO_NODE :int = 2
class plynx.constants.NodeOrigin[source]

Enum that indicates where the Node came from

DB :str = DB
BUILT_IN_HUBS :str = BUILT_IN_HUBS
class plynx.constants.NodePostAction[source]

HTTP post action

SAVE :str = SAVE
APPROVE :str = APPROVE
CREATE_RUN :str = CREATE_RUN
CREATE_RUN_FROM_SCRATCH :str = CREATE_RUN_FROM_SCRATCH
CLONE :str = CLONE
VALIDATE :str = VALIDATE
DEPRECATE :str = DEPRECATE
MANDATORY_DEPRECATE :str = MANDATORY_DEPRECATE
PREVIEW_CMD :str = PREVIEW_CMD
REARRANGE_NODES :str = REARRANGE_NODES
UPGRADE_NODES :str = UPGRADE_NODES
CANCEL :str = CANCEL
GENERATE_CODE :str = GENERATE_CODE
class plynx.constants.NodePostStatus[source]

Standard HTTP response status

SUCCESS :str = SUCCESS
FAILED :str = FAILED
VALIDATION_FAILED :str = VALIDATION_FAILED
class plynx.constants.NodeRunningStatus[source]

Running status enum

STATIC :str = STATIC
CREATED :str = CREATED
READY :str = READY
IN_QUEUE :str = IN_QUEUE
RUNNING :str = RUNNING
SUCCESS :str = SUCCESS
RESTORED :str = RESTORED
FAILED :str = FAILED
FAILED_WAITING :str = FAILED_WAITING
CANCELED :str = CANCELED
SPECIAL :str = SPECIAL
_FAILED_STATUSES :Set[str]
_SUCCEEDED_STATUSES :Set[str]
_AWAITING_STATUSES :Set[str]
_NON_CHANGEABLE_STATUSES :Set[str]
_FINISHED_STATUSES :Set[str]
static is_finished(node_running_status: str)

Check if the status is final

static is_succeeded(node_running_status: str)

Check if the status is final and successful

static is_failed(node_running_status: str)

Check if the status is final and failed

static is_non_changeable(node_running_status: str)

Check if the status is in static or special

class plynx.constants.NodeStatus[source]

Node permanent status

CREATED :str = CREATED
READY :str = READY
DEPRECATED :str = DEPRECATED
MANDATORY_DEPRECATED :str = MANDATORY_DEPRECATED
class plynx.constants.NodeVirtualCollection[source]

Virtual collection

OPERATIONS :str = operations
WORKFLOWS :str = workflows
class plynx.constants.SpecialNodeId[source]

Special Node IDs in the workflows

INPUT :ObjectId
OUTPUT :ObjectId
plynx.constants.PRIMITIVE_TYPES[source]
class plynx.constants.ParameterTypes[source]

Standard parameter types

STR :str = str
INT :str = int
FLOAT :str = float
BOOL :str = bool
TEXT :str = text
ENUM :str = enum
LIST_STR :str = list_str
LIST_INT :str = list_int
LIST_NODE :str = list_node
CODE :str = code
COLOR :str = color
class plynx.constants.HubSearchParams[source]

Describing serach based on resource

INPUT_FILE_TYPE :str = input_file_type
OUTPUT_FILE_TYPE :str = output_file_type
class plynx.constants.NodeResources[source]

Internal node elements

INPUT :str = inputs
OUTPUT :str = outputs
CLOUD_INPUT :str = cloud_inputs
CLOUD_OUTPUT :str = cloud_outputs
PARAM :str = params
LOG :str = logs
class plynx.constants.IAMPolicies[source]

Standard role policies

CAN_VIEW_OTHERS_OPERATIONS :str = CAN_VIEW_OTHERS_OPERATIONS
CAN_VIEW_OTHERS_WORKFLOWS :str = CAN_VIEW_OTHERS_WORKFLOWS
CAN_VIEW_OPERATIONS :str = CAN_VIEW_OPERATIONS
CAN_VIEW_WORKFLOWS :str = CAN_VIEW_WORKFLOWS
CAN_CREATE_OPERATIONS :str = CAN_CREATE_OPERATIONS
CAN_CREATE_WORKFLOWS :str = CAN_CREATE_WORKFLOWS
CAN_MODIFY_OTHERS_WORKFLOWS :str = CAN_MODIFY_OTHERS_WORKFLOWS
CAN_RUN_WORKFLOWS :str = CAN_RUN_WORKFLOWS
IS_ADMIN :str = IS_ADMIN
class plynx.constants.RegisterUserExceptionCode[source]

Validation error codes

EMPTY_USERNAME :str = EMPTY_USERNAME
EMPTY_PASSWORD :str = EMPTY_PASSWORD
USERNAME_ALREADY_EXISTS :str = USERNAME_ALREADY_EXISTS
EMAIL_ALREADY_EXISTS :str = EMAIL_ALREADY_EXISTS
INVALID_EMAIL :str = INVALID_EMAIL
INVALID_LENGTH_OF_USERNAME :str = INVALID_LENGTH_OF_USERNAME
class plynx.constants.TokenType[source]

Auth token type

ACCESS_TOKEN = access
REFRESH_TOKEN = refresh
class plynx.constants.UserPostAction[source]

HTTP POST action options

MODIFY :str = MODIFY
class plynx.constants.ValidationCode[source]

Standard validation code

IN_DEPENDENTS :str = IN_DEPENDENTS
MISSING_INPUT :str = MISSING_INPUT
MISSING_PARAMETER :str = MISSING_PARAMETER
INVALID_VALUE :str = INVALID_VALUE
DEPRECATED_NODE :str = DEPRECATED_NODE
EMPTY_GRAPH :str = EMPTY_GRAPH
class plynx.constants.ValidationTargetType[source]

Object Target

BLOCK :str = BLOCK
GRAPH :str = GRAPH
INPUT :str = INPUT
NODE :str = NODE
PARAMETER :str = PARAMETER
PROPERTY :str = PROPERTY
class plynx.constants.ResponseStatus[source]

Returned response status

SUCCESS :str = SUCCESS
FAILED :str = FAILED