Repository URL to install this package:
|
Version:
3.16.1 ▾
|
# ContributionsPageExample.py
from __future__ import print_function
from __future__ import absolute_import
from optparse import OptionParser, OptionValueError
import time
import os
import sys
import platform as plat
if sys.version_info >= (3, 8) and plat.system().lower() == "windows":
# pylint: disable=no-member
with os.add_dll_directory(os.getenv('BLPAPI_LIBDIR')):
import blpapi
else:
import blpapi
SESSION_TERMINATED = blpapi.Name("SessionTerminated")
class MyStream(object): # pylint: disable=too-few-public-methods
def __init__(self, id=""):
self.id = id
class MyEventHandler(object): # pylint: disable=too-few-public-methods
"""Event handler for the session"""
def processEvent(self, event, session):
"""Process session event"""
global g_running
for msg in event:
print(msg)
if event.eventType() == blpapi.Event.SESSION_STATUS:
if msg.messageType() == SESSION_TERMINATED:
g_running = False
continue
def authOptionCallback(option, opt, value, parser):
"""Parse authorization options from user input"""
vals = value.split('=', 1)
if value == "user":
authUser = blpapi.AuthUser.createWithLogonName()
authOptions = blpapi.AuthOptions.createWithUser(authUser)
elif value == "none":
authOptions = None
elif vals[0] == "app" and len(vals) == 2:
appName = vals[1]
authOptions = blpapi.AuthOptions.createWithApp(appName)
elif vals[0] == "userapp" and len(vals) == 2:
appName = vals[1]
authUser = blpapi.AuthUser.createWithLogonName()
authOptions = blpapi.AuthOptions\
.createWithUserAndApp(authUser, appName)
elif vals[0] == "dir" and len(vals) == 2:
activeDirectoryProperty = vals[1]
authUser = blpapi.AuthUser\
.createWithActiveDirectoryProperty(activeDirectoryProperty)
authOptions = blpapi.AuthOptions.createWithUser(authUser)
elif vals[0] == "manual":
parts = []
if len(vals) == 2:
parts = vals[1].split(',')
if len(parts) != 3:
raise OptionValueError("Invalid auth option {}".format(value))
appName, ip, userId = parts
authUser = blpapi.AuthUser.createWithManualOptions(userId, ip)
authOptions = blpapi.AuthOptions.createWithUserAndApp(authUser, appName)
else:
raise OptionValueError("Invalid auth option '{}'".format(value))
parser.values.auth = {'option' : authOptions}
def parseCmdLine():
"""Parse command line arguments"""
parser = OptionParser(description="Publish on a topic.")
parser.add_option("-a",
"--ip",
dest="hosts",
help="server name or IP (default: localhost)",
metavar="ipAddress",
action="append",
default=[])
parser.add_option("-p",
dest="port",
type="int",
help="server port (default: %default)",
metavar="tcpPort",
default=8194)
parser.add_option("-s",
dest="service",
help="service name (default: %default)",
metavar="service",
default="//blp/mpfbapi")
parser.add_option("-t",
dest="topic",
help="topic (default: %default)",
metavar="topic",
default="220/660/1")
parser.add_option("-c",
dest="contributorId",
type="int",
help="contributor id (default: %default)",
metavar="contributorId",
default=8563)
parser.add_option("--auth",
dest="auth",
help="authentication option: "
"user|none|app=<app>|userapp=<app>|dir=<property>"
"|manual=<app,ip,user>"
" (default: none)\n"
"'none' is applicable to Desktop API product "
"that requires Bloomberg Professional service "
"to be installed locally.",
metavar="option",
action="callback",
callback=authOptionCallback,
type="string",
default={"option" : None})
# TLS Options
parser.add_option("--tls-client-credentials",
dest="tls_client_credentials",
help="name a PKCS#12 file to use as a source "
"of client credentials",
metavar="option",
type="string")
parser.add_option("--tls-client-credentials-password",
dest="tls_client_credentials_password",
help="specify password for accessing client credentials",
metavar="option",
type="string",
default="")
parser.add_option("--tls-trust-material",
dest="tls_trust_material",
help="name a PKCS#7 file to use as a source of"
" trusted certificates",
metavar="option",
type="string")
parser.add_option("--read-certificate-files",
dest="read_certificate_files",
help="(optional) read the TLS files and pass the blobs",
metavar="option",
action="store_true")
# ZFP Options
parser.add_option("--zfp-over-leased-line",
dest="zfpPort",
help="enable ZFP connections over leased lines on the "
"specified port (8194 or 8196)"
" (When this option is enabled, '-ip' and '-p' "
"arguments will be ignored.)",
metavar="port",
type="int")
(options, _) = parser.parse_args()
if not options.hosts:
options.hosts = ["localhost"]
options.tlsOptions = getTlsOptions(options)
options.remote = None
if options.zfpPort:
if not options.tlsOptions:
raise RuntimeError("ZFP connections require TLS parameters")
if options.zfpPort == 8194:
options.remote = blpapi.ZfpUtil.REMOTE_8194
elif options.zfpPort == 8196:
options.remote = blpapi.ZfpUtil.REMOTE_8196
else:
raise RuntimeError("Invalid ZFP port: " + options.product)
return options
def getTlsOptions(options):
"""Parse TlsOptions from user input"""
if (options.tls_client_credentials is None or
options.tls_trust_material is None):
return None
print("TlsOptions enabled")
if options.read_certificate_files:
credential_blob = None
trust_blob = None
with open(options.tls_client_credentials, 'rb') as credentialfile:
credential_blob = credentialfile.read()
with open(options.tls_trust_material, 'rb') as trustfile:
trust_blob = trustfile.read()
return blpapi.TlsOptions.createFromBlobs(
credential_blob,
options.tls_client_credentials_password,
trust_blob)
return blpapi.TlsOptions.createFromFiles(
options.tls_client_credentials,
options.tls_client_credentials_password,
options.tls_trust_material)
def prepareStandardSessionOptions(options):
"""Prepare SessionOptions for a regular session"""
sessionOptions = blpapi.SessionOptions()
for idx, host in enumerate(options.hosts):
sessionOptions.setServerAddress(host, options.port, idx)
sessionOptions.setNumStartAttempts(len(options.hosts))
if options.tlsOptions:
sessionOptions.setTlsOptions(options.tlsOptions)
return sessionOptions
def prepareZfpSessionOptions(options):
"""Prepare SessionOptions for a ZFP session"""
print("Creating a ZFP connection for leased lines.")
sessionOptions = blpapi.ZfpUtil.getZfpOptionsForLeasedLines(
options.remote,
options.tlsOptions)
return sessionOptions
def main():
"""Main function"""
options = parseCmdLine()
# Fill SessionOptions
sessionOptions = prepareZfpSessionOptions(options) \
if options.remote \
else prepareStandardSessionOptions(options)
sessionOptions.setSessionIdentityOptions(options.auth['option'])
sessionOptions.setAutoRestartOnDisconnection(True)
myEventHandler = MyEventHandler()
# Create a Session
session = blpapi.ProviderSession(sessionOptions,
myEventHandler.processEvent)
# Start a Session
if not session.start():
print("Failed to start session.")
return
topicList = blpapi.TopicList()
topicList.add(options.service + options.topic,
blpapi.CorrelationId(MyStream(options.topic)))
# Create topics
session.createTopics(topicList,
blpapi.ProviderSession.AUTO_REGISTER_SERVICES)
# createTopics() is synchronous, topicList will be updated
# with the results of topic creation (resolution will happen
# under the covers)
streams = []
for i in range(topicList.size()):
stream = topicList.correlationIdAt(i).value()
status = topicList.statusAt(i)
if status == blpapi.TopicList.CREATED:
stream.topic = session.getTopic(topicList.messageAt(i))
streams.append(stream)
else:
print("Stream '%s': topic not resolved, status = %d" % (
stream.id, status))
service = session.getService(options.service)
try:
# Now we will start publishing
while streams and g_running:
event = service.createPublishEvent()
eventFormatter = blpapi.EventFormatter(event)
for stream in streams:
eventFormatter.appendMessage("PageData", stream.topic)
eventFormatter.pushElement("rowUpdate")
eventFormatter.appendElement()
eventFormatter.setElement("rowNum", 1)
eventFormatter.pushElement("spanUpdate")
eventFormatter.appendElement()
eventFormatter.setElement("startCol", 20)
eventFormatter.setElement("length", 4)
eventFormatter.setElement("text", "TEST")
eventFormatter.popElement()
eventFormatter.appendElement()
eventFormatter.setElement("startCol", 25)
eventFormatter.setElement("length", 4)
eventFormatter.setElement("text", "PAGE")
eventFormatter.popElement()
tm = time.strftime("%X")
eventFormatter.appendElement()
eventFormatter.setElement("startCol", 30)
eventFormatter.setElement("length", len(tm))
eventFormatter.setElement("text", tm)
eventFormatter.setElement("attr", "BLINK")
eventFormatter.popElement()
eventFormatter.popElement()
eventFormatter.popElement()
eventFormatter.appendElement()
eventFormatter.setElement("rowNum", 2)
eventFormatter.pushElement("spanUpdate")
eventFormatter.appendElement()
eventFormatter.setElement("startCol", 20)
eventFormatter.setElement("length", 9)
eventFormatter.setElement("text", "---------")
eventFormatter.setElement("attr", "UNDERLINE")
eventFormatter.popElement()
eventFormatter.popElement()
eventFormatter.popElement()
eventFormatter.appendElement()
eventFormatter.setElement("rowNum", 3)
eventFormatter.pushElement("spanUpdate")
eventFormatter.appendElement()
eventFormatter.setElement("startCol", 10)
eventFormatter.setElement("length", 9)
eventFormatter.setElement("text", "TEST LINE")
eventFormatter.popElement()
eventFormatter.appendElement()
eventFormatter.setElement("startCol", 23)
eventFormatter.setElement("length", 5)
eventFormatter.setElement("text", "THREE")
eventFormatter.popElement()
eventFormatter.popElement()
eventFormatter.popElement()
eventFormatter.popElement()
eventFormatter.setElement("contributorId",
options.contributorId)
eventFormatter.setElement("productCode", 1)
eventFormatter.setElement("pageNumber", 1)
for msg in event:
print(msg)
session.publish(event)
time.sleep(10)
finally:
# Stop the session
session.stop()
if __name__ == "__main__":
print("ContributionsPageExample")
try:
main()
except KeyboardInterrupt:
print("Ctrl+C pressed. Stopping...")
__copyright__ = """
Copyright 2012. Bloomberg Finance L.P.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions: The above
copyright notice and this permission notice shall be included in all copies
or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
"""