51Degrees Pipeline Python  4.1Newer Version 4.2

51Degrees Pipeline for Python

Classes

51Degrees Python classes. These contain the interfaces and logic of the Pipeline API.
[detail level 123456]
Npipeline-python
Nfiftyone_pipeline_cloudrequestengine
Nfiftyone_pipeline_cloudrequestengine
Ncloudengine
CCloudEngine
This is a template for all 51Degrees cloud engines
Ncloudrequestengine
CCloudRequestEngine
Nfiftyone_pipeline_core
Nexamples
Nclient_side_evidence_custom_flow_element
CAstrologyFlowElement
Nfiftyone_pipeline_core
Naspectproperty_value
CAspectPropertyValue
An AspectPropertyValue is a wrapper for a value It lets you check this wrapper has a value inside it If not value is set, a specific no value message is returned
Nbasiclist_evidence_keyfilter
CBasicListEvidenceKeyFilter
An instance of EvidenceKeyFilter that uses a simple array of keys Evidence not using these keys is filtered out
Nelementdata
CElementData
Core ElementData class Stores information created by a FlowElement based on FlowData
Nelementdata_dictionary
CElementDataDictionary
An extension of ElementData with dictionary object storage / lookup
Nevidence
CEvidence
Nevidence_keyfilter
CEvidenceKeyFilter
An EvidenceKeyFilter is attached to a FlowElement and is used to check if a specific evidence key is needed by it
Nflowdata
CFlowData
FlowData is created by a specific Pipeline It collects evidence set by the user It passes evidence to FlowElements in the Pipeline These elements can return ElementData or populate an errors object
Nflowelement
CFlowElement
A FlowElement is placed inside a Pipeline It receives Evidence via a FlowData object It uses this to optionally create ElementData on the FlowData Any errors in processing are caught in the FlowData's errors object
Njavascriptbuilder
CJavascriptBuilderElement
The JavaScriptBuilder aggregates JavaScript properties from FlowElements in the Pipeline
CJavaScriptBuilderEvidenceKeyFilter
Njsonbundler
CJSONBundlerElement
The JSONBundler aggregates all properties from FlowElements into a JSON object It is used for retrieving via an endpoint from the client side via the JavaScriptBuilder and also used inside the JavaScriptBuilder itself to pass properties to the client side
Nlogger
CLogger
Logging for a Pipeline
Npipeline
CPipeline
Pipeline holding a list of FlowElements for processing, can create FlowData that will be passed through these, collecting ElementData Should be constructed through the PipelineBuilder class
Npipelinebuilder
CPipelineBuilder
Nsequenceelement
CSequenceElement
The SequenceElement stores session data regarding requests for client side JavaScript from the JavaScript created by a Pipeline's JavaScriptBuilder If a Pipeline is constructed with the JavaScript elements enabled this is added automatically along with the JavaScriptBuilder and JSONBundler
CSequenceElementEvidenceKeyFilter
Ntests
Nclasses
Napvflowelement
CAPVFlowElement
Nerrorflowdata
CErrorFlowData
Nexampleflowelement1
CExampleFlowElement1
Nexampleflowelement2
CExampleFlowElement2
Nmemorylogger
CMemoryLogger
Nstopflowdata
CStopFlowData
Ntestpipeline
CTestPipeline
Ntest_core
CCoreTests
The Tests
Ntest_javascriptbuilder
CDelayedExecutionEngine1
CDelayedExecutionEngine2
CDelayedExecutionEngine3
CJavaScriptBundlerTests
CTestEngine
CTestPipeline
Nfiftyone_pipeline_engines
Nfiftyone_pipeline_engines
Naspectdata
CAspectData
AspectData extends elementData by adding the option of a missing property service It also allows properties to be explicitly excluded by a flowElement / engine
Naspectdata_dictionary
CAspectDataDictionary
AspectDataDictionary class extension that stores content as dictionary
Nbasic_dictionary_cache
CBasicDictionaryCache
A simple cache that stores its results in a dictionary
Ndatakeyed_cache
CDataKeyedCache
A data keyed cache is the base class for caches used in the pipeline It does nothing on its own and should be extended by a specific cache
Nengine
CEngine
An engine is an extension of the FlowElement class that adds extra functionality
Nmissingproperty_service
CMissingPropertyService
A missing property service runs when a property is not available in the aspectData
Ntracker
Ctracker
A tracker is an instance of datakeyed cache which, if a result is found in the cache, calls an additional boolean match method
Ntests
Ntest_engines
CEngineTests
CExampleAspectEngine
CTestCache