ultipa.utils package

Subpackages

• ultipa.utils.ufilter package
  • Submodules
  • ultipa.utils.ufilter.new_ufilter module
    • Filter
      • Filter.builder()
    • FilterEnum
      • FilterEnum.AND
      • FilterEnum.BT
      • FilterEnum.BTE
      • FilterEnum.EQ
      • FilterEnum.GT
      • FilterEnum.GTE
      • FilterEnum.IN
      • FilterEnum.LT
      • FilterEnum.LTE
      • FilterEnum.NEQ
      • FilterEnum.NIN
      • FilterEnum.NOT
      • FilterEnum.OR
    • UltipaAndFilter
      • UltipaAndFilter.builder()
    • UltipaFilter
      • UltipaFilter.builder()
    • UltipaFilterList
    • UltipaOrFilter
      • UltipaOrFilter.builder()
  • ultipa.utils.ufilter.ufilter module
    • AndFilter
      • AndFilter.builder()
    • BtFilter
      • BtFilter.builder()
    • EqFilter
      • EqFilter.builder()
    • Filter
      • Filter.builder()
    • FilterBase
    • FilterOpt
      • FilterOpt.AND
      • FilterOpt.BT
      • FilterOpt.EQ
      • FilterOpt.GT
      • FilterOpt.GTE
      • FilterOpt.IN
      • FilterOpt.LT
      • FilterOpt.LTE
      • FilterOpt.NIN
      • FilterOpt.OR
    • GtFilter
    • GteFilter
    • InFilter
      • InFilter.builder()
    • LtFilter
    • LteFilter
    • NinFilter
      • NinFilter.builder()
    • OrFilter
      • OrFilter.builder()
  • Module contents

Submodules

ultipa.utils.ResposeFormat module

class ultipa.utils.ResposeFormat.ResponseKeyFormat(jsonKeys: List[str] | None = None, boolKeys: List[str] | None = None, keyReplace: object | None = None, dataFormat: List[str] | None = None, convert2Int: List[str] | None = None)

Bases: object

Processing class that defines settings for returnd-data formatting related operations.

changeKeyValue(objs)

ultipa.utils.checkStrTime module

ultipa.utils.checkStrTime.is_valid_date(strdate)

Judge whether a string is a valid data or time.

ultipa.utils.common module

Settings of some constant values.

ultipa.utils.convert module

class ultipa.utils.convert.Any

Bases: BaseModel

Any model

ultipa.utils.convert.convertTableToDict(table_rows, headers)

Convert Table to Object.

Args:

table_rows: headers:

Returns:

ultipa.utils.convert.convertToAnyObject(dict1: dict)

Convert Dict to Object.

Args:

dict1:

Returns:

ultipa.utils.convert.convertToListAnyObject(list1: List[dict])

Convert List[Dict] to Object.

Args:

list1:

Returns:

ultipa.utils.errors module

exception ultipa.utils.errors.ParameterException(err='Parameter error!')

Bases: Exception

Class for customizing errors related to parameter

exception ultipa.utils.errors.SerializeException(err='Serialize failed!')

Bases: Exception

Class for customizing errors related to serialization

exception ultipa.utils.errors.ServerException(err='Server connection failed!')

Bases: Exception

Class for customizing errors related to server connection

exception ultipa.utils.errors.SettingException(err='Setting error!')

Bases: Exception

Class for customizing errors related to settings

ultipa.utils.errors.checkError(error: str)

Method for customizing errors related to parameter validation

ultipa.utils.fileSize module

ultipa.utils.fileSize.read_in_chunks(filePath, chunk_size=1048576)

Lazy function (generator) to read a file piece by piece. Default chunk size: 1M You can set your own chunk size

ultipa.utils.format module

class ultipa.utils.format.DataMerge

Bases: object

static arrayDiff(arr1: [str], arr2: [str])

static concat(arr1: list, arr2: list, bykey: str = None, ignoreKeys: [str] = None)

static customizer(objValue, srcValue, key, ignoreKeys)

static merge(o1: object, o2: object, ignoreKeys: [<class 'str'>] = None)

class ultipa.utils.format.FormatResponse

Bases: object

static formatStatisticsTable(table: Table)

static resTableToArray(table: Table)

class ultipa.utils.format.FormatType

Bases: object

static Response(_res, host: str | None = None) → Response

static arrays(_arrays) → List[ArrayAlias]

static attr(attr, timeZone, timeZoneOffset) → UltipaAttr

static attrAlias(_attrs, timeZone, timeZoneOffset) → List[AttrNewAlias]

static attrAlias1(_attrs) → List[Attr]

static attrEdgeEntityTable(data) → List[Edge]

static attrEntity(entityRows, type: str)

static attrNodeEntityTable(data) → List[Node]

static attrPath(_paths, timeZone, timeZoneOffset) → [<class 'ultipa.structs.Path.Path'>]

static checkEdgeRow(i: int, schema: Schema, row: EntityRow)

static checkEntityEdgeRow(i: int, schema: Schema, row: EntityRow)

static checkEntityNodeRow(i: int, schema: Schema, row: EntityRow)

static checkNodeRow(i: int, schema: Schema, row: EntityRow)

static checkProperty(row, schemaProperties)

static downloadResponse(_res) → Response

static edgeAliases(_edges, timeZone, timeZoneOffset) → List[EdgeAlias]

static edgeTable(edgeTableData, timeZone, timeZoneOffset)

static explainPlan(_explainPlan) → List[ExplainPlan]

static exportResponse(_res, timeZone, timeZoneOffset) → Response

static export_edges(_edges, timeZone, timeZoneOffset) → List

static export_nodes(_nodes, timeZone, timeZoneOffset) → List

static getRaftStatus(data: dict) → Status

static graphPrivileges(graphPrivileges: [object])

static makeEntityEdgeTable(schema: Schema, rows: List[EntityRow], timeZoneOffset=None) → EdgeEntityTable

static makeEntityNodeTable(schema: Schema, entity_rows: List[EntityRow], timeZoneOffset=None) → NodeEntityTable

static mergeUqlResponse(mergeRes: Response, res: Response)

static nodeAliases(_nodes, timeZone, timeZoneOffset) → List[NodeAlias]

static nodeTable(nodeTableData, timeZone, timeZoneOffset)

classmethod parseAttr(attr, aliasName) → Attr

classmethod parseAttrAlias(attrAlias) → Attr

classmethod parseAttrListData(datas) → List[PaserAttrListData]

static pathAlias(_paths, timeZone, timeZoneOffset) → [<class 'ultipa.structs.Path.PathAlias'>]

static pathScheams(path)

static propertyType(type: str) → PropertyType

Convert the type input by the user to ULTIPA.PropertyType :param type: :return:

static response(uql_response: Response, uqlReply, timeZone, timeZoneOffset) → Response

static resultalias(_arrays) → List[ResultAlias]

static statistics(_table, timeZone, timeZoneOffset) → UltipaStatistics

static status(_status, host: str | None = None) → Status

static table(_table, timeZone, timeZoneOffset) → Table

static tables(_tables, timeZone, timeZoneOffset) → List[Table]

static uqlMergeResponse(_res, timeZone, timeZoneOffset) → UltipaResponse

static uqlResponse(_res, timeZone, timeZoneOffset) → UltipaResponse

static values(_values) → dict

class ultipa.utils.format.HasDataMap(has_ultipa_data, has_attr_data, only_attr_list)

Bases: object

has_attr_data: bool

has_ultipa_data: bool

only_attr_list: bool

ultipa.utils.logger module

class ultipa.utils.logger.LoggerConfig(name: str, fileName: str | None = None, isWriteToFile: bool = False, level: <module 'logging' from '/Applications/Xcode.app/Contents/Developer/Library/Frameworks/Python3.framework/Versions/3.9/lib/python3.9/logging/__init__.py'> = 20, isStream: bool = False)

Bases: object

A class that defines how log messages related to Ultipa connection are handled.

It specifies settings such as log name, log file paths, log level, etc.

getlogger()

ultipa.utils.nullValue module

ultipa.utils.nullValue.isNullValue(v: any, type: PropertyType)

Judge whether a value is null

Args:

v: The value to be judged type: The property type of v

Returns:

bool

ultipa.utils.nullValue.nullValue(type: PropertyType)

Returns the null value corresponding to different data types

Args:

type: The data type

Returns:

ultipa.utils.password2md5 module

ultipa.utils.password2md5.passwrod2md5(password: str)

Use the MD5 algorithm to encrypt user password

Args:

password:

Returns:

ultipa.utils.privileges module

class ultipa.utils.privileges.GraphPrivileges

Bases: object

Data class for graphset privileges.

AB = 'AB'

ALGO = 'ALGO'

ALTER_PROPERTY = 'ALTER_PROPERTY'

ALTER_SCHEMA = 'ALTER_SCHEMA'

AUTONET = 'AUTONET'

CLEAR_TASK = 'CLEAR_TASK'

CREATE_FULLTEXT = 'CREATE_FULLTEXT'

CREATE_INDEX = 'CREATE_INDEX'

CREATE_PROPERTY = 'CREATE_PROPERTY'

CREATE_SCHEMA = 'CREATE_SCHEMA'

DELETE = 'DELETE'

DROP_FULLTEXT = 'DROP_FULLTEXT'

DROP_INDEX = 'DROP_INDEX'

DROP_PROPERTY = 'DROP_PROPERTY'

DROP_SCHEMA = 'DROP_SCHEMA'

EXPORT = 'EXPORT'

FIND = 'FIND'

INSERT = 'INSERT'

KHOP = 'KHOP'

LTE = 'LTE'

PAUSE_TASK = 'PAUSE_TASK'

RESUME_TASK = 'RESUME_TASK'

SHOW_ALGO = 'SHOW_ALGO'

SHOW_FULLTEXT = 'SHOW_FULLTEXT'

SHOW_INDEX = 'SHOW_INDEX'

SHOW_PROPERTY = 'SHOW_PROPERTY'

SHOW_SCHEMA = 'SHOW_SCHEMA'

SHOW_TASK = 'SHOW_TASK'

SPREAD = 'SPREAD'

STOP_TASK = 'STOP_TASK'

TEMPLATE = 'TEMPLATE'

UFE = 'UFE'

UPDATE = 'UPDATE'

UPSERT = 'UPSERT'

class ultipa.utils.privileges.SystemPrivileges

Bases: object

Data class for system privileges.

ALTER_GRAPH = 'ALTER_GRAPH'

ALTER_POLICY = 'ALTER_POLICY'

ALTER_USER = 'ALTER_USER'

COMPACT = 'COMPACT'

CREATE_GRAPH = 'CREATE_GRAPH'

CREATE_POLICY = 'CREATE_POLICY'

CREATE_USER = 'CREATE_USER'

DROP_GRAPH = 'DROP_GRAPH'

DROP_POLICY = 'DROP_POLICY'

DROP_USER = 'DROP_USER'

KILL = 'KILL'

MOUNT_GRAPH = 'MOUNT_GRAPH'

SHOW_GRAPH = 'SHOW_GRAPH'

SHOW_POLICY = 'SHOW_POLICY'

SHOW_PRIVILEGE = 'SHOW_PRIVILEGE'

SHOW_USER = 'SHOW_USER'

STAT = 'STAT'

TOP = 'TOP'

TRUNCATE = 'TRUNCATE'

UNMOUNT_GRAPH = 'UNMOUNT_GRAPH'

ultipa.utils.propertyUtils module

ultipa.utils.propertyUtils.getPropertyTypesDesc(type: PropertyTypeStr, subTypes: List[PropertyTypeStr])

Generate the format string a list type corresponds to.

Args:

type:

subTypes:

Returns:

str[]

ultipa.utils.propertyUtils.isBasePropertyType(type: PropertyTypeStr)

Judge whether a data type is a base property type (not a list).

Args:

type:

Returns:

ultipa.utils.raftRetry module

class ultipa.utils.raftRetry.RetryHelp

Bases: object

Configuration class that defines settings for the retry mechanism.

static check(conn, requestConfig, response) → RetryResponse

static checkRes(response)

currentRetry: Retry = None

static getRty(requestConfig)

ultipa.utils.serialize module

ultipa.utils.typeCheck module

class ultipa.utils.typeCheck.TypeCheck

Bases: object

Check the data type.

static checkProperty(type, value)

ultipa.utils.ultipaSchedule module

ultipa.utils.ultipaSchedule.background_job()

ultipa.utils.ultipaSchedule.run_continuously(interval=2)

Continuously run, while executing pending jobs at each elapsed time interval. @return cease_continuous_run: threading. Event which can be set to cease continuous run. Please note that it is intended behavior that run_continuously() does not run missed jobs. For example, if you’ve registered a job that should run every minute and you set a continuous run interval of one hour then your job won’t be run 60 times at each interval but only once.

ultipa.utils.ultipa_datetime module

class ultipa.utils.ultipa_datetime.DateTimestamp(date=None)

Bases: object

A class that realizes the mutual conversion of datetime and timestamp.

class ultipa.utils.ultipa_datetime.UTC(offsetHours=0, offsetSeconds=0)

Bases: tzinfo

dst(dt)

datetime -> DST offset as timedelta positive east of UTC.

tzname(dt)

datetime -> string name of time zone.

utcoffset(dt)

datetime -> timedelta showing offset from UTC, negative values indicating West of UTC

class ultipa.utils.ultipa_datetime.UltipaDatetime

Bases: object

Processing class for date and time related operations.

static datetimeInt2datetimeStr(datetime_int)

Convert the customized datetime integer into a datetime string

Args:

datetime_int:

Returns:

classmethod datetimeStr2datetimeInt(strDatetime: datetime)

Convert a datatime string into a customized datatime integer.

Args:

strDatetime:

Returns:

day = 0

hour = 0

microsecond = 0

minute = 0

month = 0

second = 0

static timestampInt2timestampStr(datetime_int, timeZone: str | None = None, timeZoneOffset: int = 0)

classmethod timestampStr2timestampInt(strDatetime: str, timeZone, timeZoneOffset=0)

Convert strings of datetime, timezone and timezone-offset into the Unix timestamp integer in seconds.

Args:

strDatetime: timeZone: timeZoneOffset:

Returns:

year = 0

ultipa.utils.ultipa_datetime.getTimeOffsetSeconds(timeZoneOffset)

ultipa.utils.ultipa_datetime.getTimeZoneOffset(requestConfig, defaultConfig)

Get timezone offset

Args:

requestConfig:

defaultConfig:

Returns:

ultipa.utils.ultipa_datetime.getTimeZoneSeconds(timeZone)

ultipa.utils.ultipa_datetime.wrapper(func)

Measures the execution time of a method.

Args:

func:

Returns:

ultipa.utils.uql_marker module

class ultipa.utils.uql_marker.CommandList

Bases: object

ab = 'ab'

algo = 'algo'

algo_dv = 'algo_dv'

alterEdgeProperty = 'alter().edge_property'

alterEdgeSchema = 'alter().edge_schema'

alterGraph = 'alter().graph'

alterNodeProperty = 'alter().node_property'

alterNodeSchema = 'alter().node_schema'

alterPolicy = 'alter().policy'

alterUser = 'alter().user'

autoNet = 'autoNet'

autoNetByPart = 'autoNetByPart'

clearTask = 'clear().task'

compact = 'compact'

createBackup = 'db.backup.create'

createEdgeFulltext = 'create().edge_fulltext'

createEdgeIndex = 'create().edge_index'

createEdgeProperty = 'create().edge_property'

createEdgeSchema = 'create().edge_schema'

createGraph = 'create().graph'

createNodeFulltext = 'create().node_fulltext'

createNodeIndex = 'create().node_index'

createNodeProperty = 'create().node_property'

createNodeSchema = 'create().node_schema'

createPolicy = 'create().policy'

createUser = 'create().user'

deleteEdges = 'delete().edges'

deleteNodes = 'delete().nodes'

dropEdgeFulltext = 'drop().edge_fulltext'

dropEdgeIndex = 'drop().edge_index'

dropEdgeProperty = 'drop().edge_property'

dropEdgeSchema = 'drop().edge_schema'

dropGraph = 'drop().graph'

dropNodeFulltext = 'drop().node_fulltext'

dropNodeIndex = 'drop().node_index'

dropNodeProperty = 'drop().node_property'

dropNodeSchema = 'drop().node_schema'

dropPolicy = 'drop().policy'

dropUser = 'drop().user'

edges = 'find().edges'

getPolicy = 'show().policy'

getSelfInfo = 'show().self'

getUser = 'show().user'

grant = 'grant'

grantUser = 'grant().user'

insert = 'insert'

khop = 'khop'

kill = 'kill'

lteEdge = 'LTE().edge_property'

lteNode = 'LTE().node_property'

mount = 'mount().graph'

nodeSpread = 'spread'

nodes = 'find().nodes'

pauseTask = 'pause().task'

restoreBackup = 'db.backup.restore'

resumeTask = 'resume().task'

revoke = 'revoke().user'

showAlgo = 'show().algo'

showBackup = 'db.backup.show'

showEdgeFulltext = 'show().edge_fulltext'

showEdgeIndex = 'show().edge_index'

showEdgeProperty = 'show().edge_property'

showEdgeSchema = 'show().edge_schema'

showFulltext = 'show().fulltext'

showGraph = 'show().graph'

showIndex = 'show().index'

showNodeFulltext = 'show().node_fulltext'

showNodeIndex = 'show().node_index'

showNodeProperty = 'show().node_property'

showNodeSchema = 'show().node_schema'

showPolicy = 'show().policy'

showPrivilege = 'show().privilege'

showProperty = 'show().property'

showSchema = 'show().schema'

showTask = 'show().task'

showUser = 'show().user'

stat = 'stats'

stopTask = 'stop().task'

template = 't'

top = 'top'

truncate = 'truncate'

ufeEdge = 'UFE().edge_property'

ufeNode = 'UFE().node_property'

unmount = 'unmount().graph'

updateEdges = 'update().edges'

updateNodes = 'update().nodes'

upsert = 'upsert'

class ultipa.utils.uql_marker.UQL

Bases: object

static parse(uqlStr)

Parse UQL.

Args:

uqlStr: A uql statement

Returns:

static parse_globle(uqlStr)

static uqlObjectExample(uqlStr)

class ultipa.utils.uql_marker.UQLMAKER(command: CommandList, commandP: any | None = None, commonParams=None)

Bases: object

A class that assembles UQL.

static PointFunction(latitude: float, longitude: float)

static PointString(latitude: float, longitude: float)

addParam(key: str, value: any, required: bool = True, notQuotes=False)

addTemplateParams(templateParams: List[object])

setCommandParams(commandP: any)

toString()

class ultipa.utils.uql_marker.UQLParmas

Bases: object

getCommands(index)

getCommandsParam(index)

getFirstCommands()

getSecondCommands()

Module contents