smartinspectpython.siconst

VERSION: str = '3.0.33'

Current version of the SmartInspect Python3 Library.

PACKAGENAME: str = 'smartinspectpython'

Name of our package (used by PDoc Documentation build).

PDOC_BRAND_ICON_URL: str = 'https://code-partners.com/offerings/smartinspect/'

PDoc Documentation brand icon link url that is displayed in the help document TOC. Value = "https://code-partners.com/offerings/smartinspect/"

PDOC_BRAND_ICON_URL_SRC: str = 'smartinspect.ico'

PDoc Documentation brand icon link url that is displayed in the help document TOC. Value = "smartinspect.ico"

PDOC_BRAND_ICON_URL_TITLE: str = 'A SmartInspect Client'

PDoc Documentation brand icon link title that is displayed in the help document TOC. Value = "A SmartInspect Client"

TEXTFILE_PATTERN_DEFAULT: str = '[%timestamp%] %level%: %title%'

Default value assigned to a Pattern property, which controls how lines are formatted in text log files.

Value: "[%timestamp%] %level%: %title%"

TEXTFILE_INDENT_DEFAULT: bool = False

Default value assigned to a Indent property, which controls how lines are indented in text log files.

Value: False

TEXTFILE_HEADER_BOM = bytearray(b'\xef\xbb\xbf')

Standard UTF-8 Byte Order Mark (BOM) that is written to a file stream to identify a log file as text in UTF-8 encoding.

Value: [0xEF, 0xBB, 0xBF]

CLIENT_BANNER: str = 'SmartInspect Python Library v3.0.33 ({0})\r\n'

Our (client) banner sent to a SmartInspect Console server, which will be added to the console connections log. This identifies what clients are connecting to the SI Console server.

Value: "SmartInspect Python3 Library vN.NN "

SERVER_BANNER_ERROR: str = 'Could not read server banner correctly: Connection has been closed unexpectedly!'

Indicates that the SmartInspect Console server unexpectedly closed the connection to our client.

Value: "Could not read server banner correctly: Connection has been closed unexpectedly!"

DEFAULT_COLOR_VALUE: int = 16777215

Default color integer value that represents 'White (transparent)'.

Value: 16777215 (0x00FFFFFF in ARGB format).

UNKNOWN_VALUE: str = '<unknown>'

Indicates if an event argument value is unknown for event argument objects that are displayed as a string.

Value: "<unknown>"