Skip to main content

Python library with useful functions for developers and QA needs

Project description

th2-common-utils-py

Python library with useful functions for developers and QA needs.

Installation

pip install th2-common-utils

Usage

1. Message fields access

The library provides a convenient way for Message fields access.

Instead of this:

msg.fields['BO5Items'].list_value.values[0].message_value.fields['segment_instance_number'].message_value.fields['segment_number'].simple_value

You can do this:

import th2_common_utils

msg['BO5Items'][0]['segment_instance_number']['segment_number']

2. Converters

  • message_to_dict(message) - note, you will lose all metadata of the Message.
  • dict_to_message(fields, session_alias, message_type) - where:
    • fields - required argument - message fields as a python dict;
    • session_alias and message_type - optional arguments - used to generate message metadata.
  • dict_to_root_message_filter(message_type, message_filter, metadata_filter, ignore_fields, check_repeating_group_order, time_precision, decimal_precision) - all arguments are optional.
  • message_to_typed_message(message, message_type) - where:
    • message - Message object;
    • message_type - TypedMessage class object.
  • message_to_table(message) - where:
    • message - Message object or dict.

To import functions above:

from th2_common_utils import message_to_dict, dict_to_message # ...

3. Working with events

th2-common-utils provides the class to work with events - EventUtils.

Methods of EventUtils class:

  • create_event_body(component) - creates event body from component as bytes.
  • create_event_id() - creates EventID.
  • create_event(id, parent_id, start_timestamp, end_timestamp, status, name, type, body, attached_message_ids) - creates event; all arguments are optional.

To use functions above:

from th2_common_utils import EventUtils as eu

my_event = eu.create_event(id=eu.create_event_id,
                           name='My event',
                           #... )

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

th2-common-utils-1.1.0.dev2264044439.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file th2-common-utils-1.1.0.dev2264044439.tar.gz.

File metadata

File hashes

Hashes for th2-common-utils-1.1.0.dev2264044439.tar.gz
Algorithm Hash digest
SHA256 006f53c74c36ebb36eea42e7437f8090c41a06d0ae68adb7fc5762b39cba9848
MD5 561996703b2fcd6e98179385baa5ba5d
BLAKE2b-256 cd4f4f422343e4b75b8216c43b5ae32fb7fc07b636a447f581cc999c745137b9

See more details on using hashes here.

File details

Details for the file th2_common_utils-1.1.0.dev2264044439-py3-none-any.whl.

File metadata

File hashes

Hashes for th2_common_utils-1.1.0.dev2264044439-py3-none-any.whl
Algorithm Hash digest
SHA256 727d2b2587f152e8afce194a857b2272a52727395e39174a6a014317a47c767a
MD5 7075d14553758d78f23d0fe41f27963e
BLAKE2b-256 b3deca8c382d8f022695b3accead9a1347e15fd9dcdc70244cd384200993d930

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page