th2_common
Project description
th2 common library (Python)
Installation
pip install th2-common
This package can be found on PyPI.
Usage
First things first, you need to import CommonFactory
class:
from th2_common.schema.factory.common_factory import CommonFactory
Then you create an instance of imported class, choosing one of the options:
- Create factory with configs from default path (
/var/th2/config/*
):factory = CommonFactory()
- Create factory with configs from specified directory path (
path/*
):factory = CommonFactory(config_path=...)
- Create factory with configs from specified file paths:
factory = CommonFactory(rabbit_mq_config_filepath=..., mq_router_config_filepath=..., grpc_router_config_filepath=..., cradle_config_filepath=..., custom_config_filepath=...)
- Create factory with configs from command line arguments (
sys.argv
):factory = CommonFactory.create_from_arguments()
- Create factory with configs from specified arguments:
factory = CommonFactory.create_from_arguments(args)
- Create factory with a namespace in Kubernetes and the name of the target th2 box from Kubernetes:
factory = CommonFactory.create_from_kubernetes(namespace, box_name)
Requirements for creatring factory with Kubernetes
-
It is necessary to have Kubernetes configuration written in ~/.kube/config. See more on kubectl configuration here.
-
It is necessary to have environment variables
CASSANDRA_PASS
andRABBITMQ_PASS
to use configs fromcradle.json
andrabbitMQ.json
as the passwords are not stored there explicitly. -
Also note that
generated_configs
directory will be created to store.json
files with configs from Kubernetes. Those files are overridden whenCommonFactory.create_from_kubernetes(namespace, box_name)
is invoked again.
After that you can get various Routers
through factory
properties:
message_parsed_batch_router = factory.message_parsed_batch_router
message_raw_batch_router = factory.message_raw_batch_router
event_batch_router = factory.event_batch_router
message_parsed_batch_router
is working with MessageBatch
message_raw_batch_router
is working with RawMessageBatch
event_batch_router
is working with EventBatch
See th2-grpc-common for details.
With router
created, you can subscribe to pins (specifying callback function) or send data that router works with:
router.subscribe(callback) # subscribe to only one pin
router.subscribe_all(callback) # subscribe to one or several pins
router.send(message) # send to only one pin
router.send_all(message) # send to one or several pins
You can do these actions with extra pin attributes in addition to default ones.
router.subscribe(callback, attrs...) # subscribe to only one pin
router.subscribe_all(callback, attrs...) # subscribe to one or several pins
router.send(message, attrs...) # send to only one pin
router.send_all(message, attrs...) # send to one or several pins
Default attributes are:
message_parsed_batch_router
- Subscribe:
subscribe
,parsed
- Send:
publish
,parsed
- Subscribe:
message_raw_batch_router
- Subscribe:
subscribe
,raw
- Send:
publish
,raw
- Subscribe:
event_batch_router
- Subscribe:
subscribe
,event
- Send:
publish
,event
- Subscribe:
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
Hashes for th2_common-2.3.3.dev554141088.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 533a8c87818560905e2a755aa994bbdfdb105ca02f05e18ba1b85b0d4f725c95 |
|
MD5 | 6e21223d26cf6ef6d729087915516f71 |
|
BLAKE2b-256 | 2d2cad4ba81d5c5692e2a3cbba81aa1f482bf997971ecbbd32f23940598ddf4a |