' + + '' + + _("Hide Search Matches") + + "
" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(SphinxHighlight.highlightSearchWords); +_ready(SphinxHighlight.initEscapeListener); diff --git a/genindex.html b/genindex.html new file mode 100644 index 00000000..ff02dd86 --- /dev/null +++ b/genindex.html @@ -0,0 +1,486 @@ + + + + + +| + | + |
| + | + |
| + |
| + | + |
| + | + |
| + | + |
| + | + |
| + | + |
|
+
| + | + |
| + |
| + | + |
| + | + |
Add analytics to your Python apps and Python games with the Snowplow event tracker for Python.
+With this tracker you can collect event data from your Python-based applications, games or Python web servers/frameworks.
+Contents:
+ +AsyncEmitter
+EmitterEmitter.as_collector_uri()Emitter.async_flush()Emitter.attach_sent_timestamp()Emitter.cancel_flush_timer()Emitter.flush()Emitter.http_get()Emitter.http_post()Emitter.input()Emitter.is_good_status_code()Emitter.reached_limit()Emitter.send_events()Emitter.set_flush_timer()Emitter.sync_flush()FlushTimer
+Requester
+SubjectSubject.combine_subject()Subject.set_color_depth()Subject.set_domain_session_id()Subject.set_domain_session_index()Subject.set_domain_user_id()Subject.set_ip_address()Subject.set_lang()Subject.set_network_user_id()Subject.set_platform()Subject.set_screen_resolution()Subject.set_timezone()Subject.set_user_id()Subject.set_useragent()Subject.set_viewport()TrackerTracker.add_emitter()Tracker.complete_payload()Tracker.flush()Tracker.get_namespace()Tracker.get_timestamp()Tracker.get_uuid()Tracker.set_subject()Tracker.track()Tracker.track_add_to_cart()Tracker.track_ecommerce_transaction()Tracker.track_ecommerce_transaction_item()Tracker.track_form_change()Tracker.track_form_submit()Tracker.track_link_click()Tracker.track_mobile_screen_view()Tracker.track_page_ping()Tracker.track_page_view()Tracker.track_remove_from_cart()Tracker.track_screen_view()Tracker.track_self_describing_event()Tracker.track_site_search()Tracker.track_struct_event()Tracker.track_unstruct_event()| + s | ||
| + |
+ snowplow_tracker | + |
| + |
+ snowplow_tracker.contracts | + |
| + |
+ snowplow_tracker.emitters | + |
| + |
+ snowplow_tracker.payload | + |
| + |
+ snowplow_tracker.self_describing_json | + |
| + |
+ snowplow_tracker.subject | + |
| + |
+ snowplow_tracker.tracker | + |
| + |
+ snowplow_tracker.typing | + |
Bases: Emitter
Uses threads to send HTTP requests asynchronously
+Removes all dead threads, then creates a new thread which +executes the flush method of the base Emitter class
+Calls the flush method of the base Emitter class. +This is guaranteed to be blocking, not asynchronous.
+Bases: EmitterProtocol
Synchronously send Snowplow events to a Snowplow collector +Supports both GET and POST requests
+endpoint (string) – The raw endpoint provided by the user
protocol (protocol) – The protocol to use - http or https
port (int | None) – The collector port to connect to
method (method) – Either get or post HTTP method
string
+Attach (by mutating in-place) current timestamp in milliseconds +as stm param
+events (list(dict(string:*))) – Array of events to be sent
+None
+Abort automatic async flushing
+Sends all events in the buffer to the collector.
+payload (dict(string:*)) – The event properties
+data (string) – The array of JSONs to be sent
+Adds an event to the buffer. +If the maximum size has been reached, flushes the buffer.
+payload (dict(string:*)) – The name-value pairs for the event
+status_code (int) – HTTP status code
+bool
+Checks if event-size or bytes limit are reached
+bool
+evts (list(dict(string:*))) – Array of events to be sent
+Set an interval at which the buffer will be flushed +:param timeout: interval in seconds +:type timeout: int | float
+Calls the flush method of the base Emitter class. +This is guaranteed to be blocking, not asynchronous.
+Bases: object
Add a name value pair to the Payload object
+Add a dict of name value pairs to the Payload object
+dict (dict(string:*)) – Dictionary to be added to the Payload
+Add an encoded or unencoded JSON to the payload
+dict (dict(string:*) | None) – Custom context for the event
encode_base64 (bool) – If the payload is base64 encoded
type_when_encoded (string) – Name of the field when encode_base64 is set
type_when_not_encoded (string) – Name of the field when encode_base64 is not set
json_encoder (function | None) – Custom JSON serializer that gets called on non-serializable object
Returns the context dictionary from the Payload object
+Bases: object
Class for an event subject, where we view events as of the form
+(Subject) -> (Verb) -> (Object)
+Merges another instance of Subject, with self taking priority +:param subject Subject to update +:type subject subject +:rtype PayloadDict
+depth (int) – Depth of the color on the screen
+subject
+Set the domain session ID +:param sid: Domain session ID +:type sid: string +:rtype: subject
+Set the domain session Index +:param vid: Domain session Index +:type vid: int +:rtype: subject
+Set the domain user ID
+duid (string) – Domain user ID
+subject
+Set the domain user ID
+ip (string) – IP address
+subject
+Set language.
+lang (string) – Language the application is set to
+subject
+Set the network user ID field +This overwrites the nuid field set by the collector
+nuid (string) – Network user ID
+subject
+value (supported_platform) – One of [“pc”, “tv”, “mob”, “cnsl”, “iot”, “web”, “srv”, “app”]
+subject
+width (int,>0) – Width of the screen
height (int,>0) – Height of the screen
subject
+timezone (string) – Timezone as a string
+subject
+user_id (string) – User ID
+subject
+Bases: object
Add a new emitter to which events should be passed
+emitter (emitter) – New emitter
+tracker
+Flush the emitter
+is_async (bool) – Whether the flush is done asynchronously. Default is False
+tracker
+tstamp (int | float | None) – User-input timestamp or None
+int
+Set transaction ID for the payload once during the lifetime of the +event.
+string
+Set the subject of the events fired by the tracker
+subject (subject | None) – Subject to be tracked
+tracker
+Send the event payload to a emitter. Returns the tracked event ID. +:param event: Event +:type event: events.Event +:rtype: String
+sku (non_empty_string) – Item SKU or ID
quantity (int) – Number added to cart
name (string_or_none) – Item’s name
category (string_or_none) – Item’s category
unit_price (int | float | None) – Item’s price
currency (string_or_none) – Type of currency the price is in
context (context_array | None) – Custom context for the event
tstamp (int | float | None) – Optional event timestamp in milliseconds
event_subject (subject | None) – Optional per event subject
order_id (non_empty_string) – ID of the eCommerce transaction
total_value (int | float) – Total transaction value
affiliation (string_or_none) – Transaction affiliation
tax_value (int | float | None) – Transaction tax value
shipping (int | float | None) – Delivery cost charged
city (string_or_none) – Delivery address city
state (string_or_none) – Delivery address state
country (string_or_none) – Delivery address country
currency (string_or_none) – The currency the price is expressed in
items (list(dict(str:*)) | None) – The items in the transaction
context (context_array | None) – Custom context for the event
tstamp (int | float | None) – Optional event timestamp in milliseconds
event_subject (subject | None) – Optional per event subject
This is an internal method called by track_ecommerce_transaction. +It is not for public use.
+order_id (non_empty_string) – Order ID
sku (non_empty_string) – Item SKU
price (int | float) – Item price
quantity (int) – Item quantity
name (string_or_none) – Item name
category (string_or_none) – Item category
currency (string_or_none) – The currency the price is expressed in
context (context_array | None) – Custom context for the event
tstamp (int | float | None) – Optional event timestamp in milliseconds
event_subject (subject | None) – Optional per event subject
form_id (non_empty_string) – ID attribute of the HTML form
element_id (string_or_none) – ID attribute of the HTML element
node_name (form_node_name) – Type of input element
value (string_or_none) – Value of the input element
type (non_empty_string, form_type) – Type of data the element represents
element_classes (list(str) | tuple(str,*) | None) – Classes of the HTML element
context (context_array | None) – Custom context for the event
tstamp (int | float | None) – Optional event timestamp in milliseconds
event_subject (subject | None) – Optional per event subject
form_id (non_empty_string) – ID attribute of the HTML form
form_classes (list(str) | tuple(str,*) | None) – Classes of the HTML form
elements (list(form_element) | None) – Classes of the HTML form
context (context_array | None) – Custom context for the event
tstamp (int | float | None) – Optional event timestamp in milliseconds
event_subject (subject | None) – Optional per event subject
target_url (non_empty_string) – Target URL of the link
element_id (string_or_none) – ID attribute of the HTML element
element_classes (list(str) | tuple(str,*) | None) – Classes of the HTML element
element_target (string_or_none) – ID attribute of the HTML element
element_content (string_or_none) – The content of the HTML element
context (context_array | None) – Custom context for the event
tstamp (int | float | None) – Optional event timestamp in milliseconds
event_subject (subject | None) – Optional per event subject
name (string_or_none) – The name of the screen view event
id (string | None) – Screen view ID. This must be of type UUID.
type (string | None) – The type of screen that was viewed e.g feed / carousel.
previous_name (string | None) – The name of the previous screen.
previous_id (string | None) – The screenview ID of the previous screenview.
:param previous_type The screen type of the previous screenview +:type previous_type string | None +:param transition_type The type of transition that led to the screen being viewed. +:type transition_type string | None +:param context: Custom context for the event +:type context: context_array | None +:param tstamp: Optional event timestamp in milliseconds +:type tstamp: int | float | None +:param event_subject: Optional per event subject +:type event_subject: subject | None +:rtype: Tracker
+page_url (non_empty_string) – URL of the viewed page
page_title (string_or_none) – Title of the viewed page
referrer (string_or_none) – Referrer of the page
min_x (int | None) – Minimum page x offset seen in the last ping period
max_x (int | None) – Maximum page x offset seen in the last ping period
min_y (int | None) – Minimum page y offset seen in the last ping period
max_y (int | None) – Maximum page y offset seen in the last ping period
context (context_array | None) – Custom context for the event
tstamp (int | float | None) – Optional event timestamp in milliseconds
event_subject (subject | None) – Optional per event subject
page_url (non_empty_string) – URL of the viewed page
page_title (string_or_none) – Title of the viewed page
referrer (string_or_none) – Referrer of the page
context (context_array | None) – Custom context for the event
tstamp (int | float | None) – Optional event timestamp in milliseconds
event_subject (subject | None) – Optional per event subject
sku (non_empty_string) – Item SKU or ID
quantity (int) – Number added to cart
name (string_or_none) – Item’s name
category (string_or_none) – Item’s category
unit_price (int | float | None) – Item’s price
currency (string_or_none) – Type of currency the price is in
context (context_array | None) – Custom context for the event
tstamp (int | float | None) – Optional event timestamp in milliseconds
event_subject (subject | None) – Optional per event subject
name (string_or_none) – The name of the screen view event
id (string_or_none) – Screen view ID
context (context_array | None) – Custom context for the event
tstamp (int | float | None) – Optional event timestamp in milliseconds
event_subject (subject | None) – Optional per event subject
event_json (self_describing_json) – The properties of the event. Has two field: +A “data” field containing the event properties and +A “schema” field identifying the schema against which the data is validated
context (context_array | None) – Custom context for the event
tstamp (int | float | None) – Optional event timestamp in milliseconds
event_subject (subject | None) – Optional per event subject
terms (seq[>=1](str)) – Search terms
filters (dict(str:str|bool) | None) – Filters applied to the search
total_results (int | None) – Total number of results returned
page_results (int | None) – Total number of pages of results
context (context_array | None) – Custom context for the event
tstamp (int | float | None) – Optional event timestamp in milliseconds
event_subject (subject | None) – Optional per event subject
category (non_empty_string) – Category of the event
action (non_empty_string) – The event itself
label (string_or_none) – Refer to the object the action is +performed on
property (string_or_none) – Property associated with either the action +or the object
value (int | float | None) – A value associated with the user action
context (context_array | None) – Custom context for the event
tstamp (int | float | None) – Optional event timestamp in milliseconds
event_subject (subject | None) – Optional per event subject
event_json (self_describing_json) – The properties of the event. Has two field: +A “data” field containing the event properties and +A “schema” field identifying the schema against which the data is validated
context (context_array | None) – Custom context for the event
tstamp (int | float | None) – Optional event timestamp in milliseconds
event_subject (subject | None) – Optional per event subject
