51Degrees Pipeline for Python

fiftyone_pipeline_engines_fiftyone.share_usage Namespace Reference

Classes

class  ShareUsage
class  ReplacedString
 Makes an Evidence value fit in the usage sharing XML. More...
class  ShareUsageData
 Internal class that is used to store details of data in memory prior to it being sent to 51Degrees. More...

Functions

 devices_message (entries)
 The text of one message, being the queued Device entries inside the Devices element.
 is_valid_xml_char (code)
 plain_element (tag, value)
 An element of a usage sharing record that is not an Evidence entry, with its value made to fit the XML by ReplacedString and no attributes, as the record gives these elements none.
 record_element (tag, value, name=None)
 One element of a usage sharing record.

Variables

str HTTP_REQUEST_KEY = "server.http-request"
int SHARE_USAGE_MAX_EVIDENCE_LENGTH = 10000
str SHARE_USAGE_VERSION = '1.1'
int REQUEST_TIMEOUT = 60
int REQUESTED_PACKAGE_SIZE_DEFAULT = 50
int MAX_QUEUE_SIZE_DEFAULT = 1000
int CLEANUP_TIMEOUT_SECONDS = 5
float CLEANUP_POLL_SECONDS = 0.01
int QUEUE_FULL_LOG_EVERY_ENTRIES = 1000
int LOGGED_CONTENT_CHARACTERS = 500
int LONGEST_WAIT_SECONDS = 86400
tuple VALID_XML_RANGES
dict XML_ENTITIES
tuple XML_NAME_START
 XML_NAME

Function Documentation

◆ devices_message()

devices_message ( entries)

The text of one message, being the queued Device entries inside the Devices element.

◆ is_valid_xml_char()

is_valid_xml_char ( code)

◆ plain_element()

plain_element ( tag,
value )

An element of a usage sharing record that is not an Evidence entry, with its value made to fit the XML by ReplacedString and no attributes, as the record gives these elements none.

◆ record_element()

record_element ( tag,
value,
name = None )

One element of a usage sharing record.

The value, and the Name attribute when there is one, are made to fit the XML by ReplacedString, and the element is marked escaped or truncated when either changed.

Variable Documentation

◆ CLEANUP_POLL_SECONDS

float fiftyone_pipeline_engines_fiftyone.share_usage.CLEANUP_POLL_SECONDS = 0.01

◆ CLEANUP_TIMEOUT_SECONDS

int fiftyone_pipeline_engines_fiftyone.share_usage.CLEANUP_TIMEOUT_SECONDS = 5

◆ HTTP_REQUEST_KEY

str fiftyone_pipeline_engines_fiftyone.share_usage.HTTP_REQUEST_KEY = "server.http-request"

◆ LOGGED_CONTENT_CHARACTERS

int fiftyone_pipeline_engines_fiftyone.share_usage.LOGGED_CONTENT_CHARACTERS = 500

◆ LONGEST_WAIT_SECONDS

int fiftyone_pipeline_engines_fiftyone.share_usage.LONGEST_WAIT_SECONDS = 86400

◆ MAX_QUEUE_SIZE_DEFAULT

int fiftyone_pipeline_engines_fiftyone.share_usage.MAX_QUEUE_SIZE_DEFAULT = 1000

◆ QUEUE_FULL_LOG_EVERY_ENTRIES

int fiftyone_pipeline_engines_fiftyone.share_usage.QUEUE_FULL_LOG_EVERY_ENTRIES = 1000

◆ REQUEST_TIMEOUT

int fiftyone_pipeline_engines_fiftyone.share_usage.REQUEST_TIMEOUT = 60

◆ REQUESTED_PACKAGE_SIZE_DEFAULT

int fiftyone_pipeline_engines_fiftyone.share_usage.REQUESTED_PACKAGE_SIZE_DEFAULT = 50

◆ SHARE_USAGE_MAX_EVIDENCE_LENGTH

int fiftyone_pipeline_engines_fiftyone.share_usage.SHARE_USAGE_MAX_EVIDENCE_LENGTH = 10000

◆ SHARE_USAGE_VERSION

str fiftyone_pipeline_engines_fiftyone.share_usage.SHARE_USAGE_VERSION = '1.1'

◆ VALID_XML_RANGES

tuple fiftyone_pipeline_engines_fiftyone.share_usage.VALID_XML_RANGES
Initial value:
= (
(0x9, 0xA), (0xD, 0xD), (0x20, 0xD7FF), (0xE000, 0xFFFD),
(0x10000, 0x10FFFF))

◆ XML_ENTITIES

dict fiftyone_pipeline_engines_fiftyone.share_usage.XML_ENTITIES
Initial value:
= {
'&': '&',
'"': '"',
"'": ''',
'<': '&lt;',
'>': '&gt;',
}

◆ XML_NAME

fiftyone_pipeline_engines_fiftyone.share_usage.XML_NAME
Initial value:
= re.compile(
"[" + XML_NAME_START + "][" + XML_NAME_START +
"\\-.0-9\u00b7\u0300-\u036f\u203f-\u2040]*\\Z")

◆ XML_NAME_START

tuple fiftyone_pipeline_engines_fiftyone.share_usage.XML_NAME_START
Initial value:
= (
"A-Z_a-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u02ff\u0370-\u037d"
"\u037f-\u1fff\u200c-\u200d\u2070-\u218f\u2c00-\u2fef\u3001-\ud7ff"
"\uf900-\ufdcf\ufdf0-\ufffd\U00010000-\U000effff")