LSEG Data Library for Python

Built with Pandora

session.platform.Definition object

The session.platform.Definition object allows you to define the platform session you want to create.
Platform sessions can be defined indirectly using the name of a session defined in the configuration file or directly by specifying the other Definition parameters.

Module

lseg.data.session.platform

Syntax

session.platform.Definition(
    name, app_key, grant, signon_control,
    deployed_platform_host, deployed_platform_username, dacs_position,
    dacs_application_id
    )

Parameters

Value Description Data Type Optional Default value
name Session name str Yes "default"
app_key Application key str Yes None
grant Grants objects containing the credentials used to authenticate the user (or the machine) when connecting to the data platform. Several kind of grant objects can be used GrantPassword is the most common one. GrantPassword obj. Yes None
signon_control Controls the exclusive sign-on behavior when the user account (or computer account) for this session is concurrently used by another application. When this parameter is set to True, opening this session automatically disconnects the other application. When this parameter is set to False, the opening of this session fails preserving the other application. bool Yes True
deployed_platform_host Host name (or IP) and port to be used to connect to Real-Time Distribution System. str Yes None
deployed_platform_username LSEG Real-Time Data Access Control System (DACS) user name identifying the user when to connecting to a Real-Time Distribution System str Yes None
dacs_position Real-Time Data Access Control System (DACS) position identifying the terminal when connecting to a Real-Time Distribution System. str Yes None
dacs_application_id Must contain the Real-Time Data Access Control System (DACS) application ID of the user. For more information, refer to the DACS documentation on MyAccount (formerly MyRefinitiv). str Yes None
proxies Proxies configuration. If string, should be the URL of the proxy (e.g. 'https://proxy.com:8080'). If a dict, the keys are the protocol name (e.g. 'http', 'https') and the values are the proxy URLs. str Yes None
app_name Application name str Yes None

Returned value

None.

Usage

The following example demonstrates how to create a Definition object for a platform session named “custom-session” and defined in the configuration file of the library.

import lseg.data as ld

definition = ld.session.platform.Definition(name="custom-session")

None
316 words (1:40 mins)