Refactor code structure for improved readability and maintainability, update LD Lib version

wasin-waeosri · wasin-waeosri · commit 9b08773fc4e2 · 2025-04-18T17:10:02.000+07:00
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Machine Readable News Example with LSEG Data Library for Python
 
-- Last update: January 2025
+- Last update: April 2025
 - Compiler: Python
 - Prerequisite: The Real-Time Distribution System or The Real-Time -- Optimized credentials (V1) with MRN service
 
@@ -19,6 +19,29 @@ This example requires the following dependencies.
 
 Please contact your LSEG representative to help you to access the RTO account and services.
 
+## <a id="rdp_lib"></a>Introduction to the Data Library for Python
+
+The [Data Library for Python](https://developers.lseg.com/en/api-catalog/lseg-data-platform/lseg-data-library-for-python) provides a set of ease-of-use interfaces offering coders uniform access to the breadth and depth of financial data and services available on the Workspace, RDP, and Real-Time Platforms. The API is designed to provide consistent access through multiple access channels and target both Professional Developers and Financial Coders. Developers can choose to access content from the desktop, through their deployed streaming services, or directly to the cloud. With the Data Library, the same Python code can be used to retrieve data regardless of which access point you choose to connect to the platform.
+
+![Figure-1](images/datalib_image.png "Data Library Diagram") 
+
+The Data Library are available in the following programming languages:
+
+- [Python](https://developers.lseg.com/en/api-catalog/lseg-data-platform/lseg-data-library-for-python)
+- [.NET](https://developers.lseg.com/en/api-catalog/lseg-data-platform/lseg-data-library-for-net)
+- [TypeScript](https://developers.lseg.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-library-for-typescript)
+
+For more deep detail regarding the Data Library for Python, please refer to the following articles and tutorials:
+
+- [Quickstart](https://developers.lseg.com/en/api-catalog/lseg-data-platform/lseg-data-library-for-python/quick-start).
+- [Documentation](https://developers.lseg.com/en/api-catalog/lseg-data-platform/lseg-data-library-for-python/documentation).
+- [Tutorials](https://developers.lseg.com/en/api-catalog/lseg-data-platform/lseg-data-library-for-python/tutorials).
+- [GitHub](https://github.com/LSEG-API-Samples/Example.DataLibrary.Python).
+
+### Disclaimer
+
+This project is based on Data Library Python versions **2.1.1**.
+
 ## <a id="news_mrn_overview"></a>Machine Readable News Overview
 
 Machine Readable News (MRN) is an advanced service for automating the consumption and systematic analysis of news. It delivers deep historical news archives, ultra-low latency structured news and news analytics directly to your applications. This enables algorithms to exploit the power of news to seize opportunities, capitalize on market inefficiencies, and manage event risk.
diff --git a/images/datalib_image.png b/images/datalib_image.png
diff --git a/requirements-notebook.txt b/requirements-notebook.txt
@@ -1,103 +1,102 @@
-anyio==4.8.0
+anyio==4.9.0
 appdirs==1.4.4
 argon2-cffi==23.1.0
 argon2-cffi-bindings==21.2.0
 arrow==1.3.0
 asttokens==3.0.0
-async-lru==2.0.4
-attrs==24.3.0
-babel==2.16.0
-beautifulsoup4==4.12.3
+async-lru==2.0.5
+attrs==25.3.0
+babel==2.17.0
+beautifulsoup4==4.13.4
 bleach==6.2.0
-certifi==2024.12.14
+certifi==2025.1.31
 cffi==1.17.1
 charset-normalizer==3.4.1
 colorama==0.4.6
 comm==0.2.2
-debugpy==1.8.11
-decorator==5.1.1
+debugpy==1.8.14
+decorator==5.2.1
 defusedxml==0.7.1
-exceptiongroup==1.2.2
-executing==2.1.0
+executing==2.2.0
 fastjsonschema==2.21.1
 fqdn==1.5.1
 h11==0.14.0
-httpcore==1.0.7
-httpx==0.26.0
+httpcore==1.0.8
+httpx==0.27.2
 idna==3.10
 ipykernel==6.29.5
-ipython==8.31.0
+ipython==9.1.0
+ipython_pygments_lexers==1.1.1
 isoduration==20.11.0
 jedi==0.19.2
-Jinja2==3.1.5
-json5==0.10.0
+Jinja2==3.1.6
+json5==0.12.0
 jsonpointer==3.0.0
 jsonschema==4.23.0
 jsonschema-specifications==2024.10.1
-jupyter-events==0.11.0
+jupyter-events==0.12.0
 jupyter-lsp==2.2.5
 jupyter_client==8.6.3
 jupyter_core==5.7.2
 jupyter_server==2.15.0
 jupyter_server_terminals==0.5.3
-jupyterlab==4.3.4
+jupyterlab==4.4.0
 jupyterlab_pygments==0.3.0
 jupyterlab_server==2.27.3
-lseg-data==2.0.1
+lseg-data==2.1.1
 MarkupSafe==3.0.2
 matplotlib-inline==0.1.7
-mistune==3.1.0
+mistune==3.1.3
 nbclient==0.10.2
-nbconvert==7.16.5
+nbconvert==7.16.6
 nbformat==5.10.4
 nest-asyncio==1.6.0
 notebook_shim==0.2.4
-numpy==1.26.4
+numpy==2.2.4
 overrides==7.7.0
 packaging==24.2
 pandas==2.2.3
 pandocfilters==1.5.1
 parso==0.8.4
-platformdirs==4.3.6
+platformdirs==4.3.7
 prometheus_client==0.21.1
-prompt_toolkit==3.0.48
-psutil==6.1.1
+prompt_toolkit==3.0.51
+psutil==7.0.0
 pure_eval==0.2.3
 pycparser==2.22
-pyee==11.1.0
+pyee==12.0.0
 Pygments==2.19.1
 pyhumps==3.8.0
 python-dateutil==2.9.0.post0
-python-json-logger==3.2.1
-pytz==2024.2
-pywin32==308; platform_system == "Windows"
-pywinpty==2.0.14; platform_system == "Windows"
+python-json-logger==3.3.0
+pytz==2025.2
+pywin32==310
+pywinpty==2.0.15
 PyYAML==6.0.2
-pyzmq==26.2.0
-referencing==0.35.1
+pyzmq==26.4.0
+referencing==0.36.2
 requests==2.32.3
 rfc3339-validator==0.1.4
 rfc3986-validator==0.1.1
-rpds-py==0.22.3
-scipy==1.12.0
+rpds-py==0.24.0
+scipy==1.15.2
 Send2Trash==1.8.3
-simplejson==3.19.3
+simplejson==3.20.1
 six==1.17.0
 sniffio==1.3.1
 soupsieve==2.6
 stack-data==0.6.3
-tenacity==8.5.0
+tenacity==9.1.2
 terminado==0.18.1
 tinycss2==1.4.0
-tomli==2.2.1
 tornado==6.4.2
 traitlets==5.14.3
 types-python-dateutil==2.9.0.20241206
-typing_extensions==4.12.2
-tzdata==2024.2
+typing_extensions==4.13.2
+tzdata==2025.2
 uri-template==1.3.0
-urllib3==2.3.0
-watchdog==2.3.1
+urllib3==2.4.0
+watchdog==6.0.0
 wcwidth==0.2.13
 webcolors==24.11.1
 webencodings==0.5.1
diff --git a/requirements.txt b/requirements.txt
@@ -1,29 +1,28 @@
-anyio==4.8.0
+anyio==4.9.0
 appdirs==1.4.4
-certifi==2024.12.14
+certifi==2025.1.31
 charset-normalizer==3.4.1
-exceptiongroup==1.2.2
 h11==0.14.0
-httpcore==1.0.7
-httpx==0.26.0
+httpcore==1.0.8
+httpx==0.27.2
 idna==3.10
-Jinja2==3.1.5
-lseg-data==2.0.1
+Jinja2==3.1.6
+lseg-data==2.1.1
 MarkupSafe==3.0.2
-numpy==1.26.4
+numpy==2.2.4
 pandas==2.2.3
-pyee==11.1.0
+pyee==12.0.0
 pyhumps==3.8.0
 python-dateutil==2.9.0.post0
-pytz==2024.2
+pytz==2025.2
 requests==2.32.3
-scipy==1.12.0
-simplejson==3.19.3
+scipy==1.15.2
+simplejson==3.20.1
 six==1.17.0
 sniffio==1.3.1
-tenacity==8.5.0
-typing_extensions==4.12.2
-tzdata==2024.2
-urllib3==2.3.0
-watchdog==2.3.1
+tenacity==9.1.2
+typing_extensions==4.13.2
+tzdata==2025.2
+urllib3==2.4.0
+watchdog==6.0.0
 websocket-client==1.8.0
diff --git a/src/OMMStream-MRN-LD.ipynb b/src/OMMStream-MRN-LD.ipynb
@@ -6,7 +6,7 @@
    "source": [
     "# Machine Readable News Example with LSEG Data Library for Python\n",
     "\n",
-    "- Last update: January 2025\n",
+    "- Last update: April 2025\n",
     "\n",
     "This example shows how developers may use the [LSEG Data Library for Python](https://developers.lseg.com/en/api-catalog/lseg-data-platform/lseg-data-library-for-python) Delivery layer feature to subscribe to the Machine Readable News (MRN) from LSEG Real-Time Distribution System (RTDS) and LSEG Real-Time Optimized (RTO). The example just connects to LSEG Real-Time platform via a WebSocket connection, then subscribes and displays MRN News data in a console. "
    ]
@@ -56,14 +56,14 @@
     "# Import all required library\n",
     "\n",
     "import sys\n",
-    "import lseg.data as ld\n",
-    "from lseg.data.delivery import omm_stream\n",
     "import datetime\n",
     "import time\n",
     "import json\n",
     "import base64\n",
     "import zlib\n",
-    "import binascii"
+    "import binascii\n",
+    "import lseg.data as ld\n",
+    "from lseg.data.delivery import omm_stream"
    ]
   },
   {
@@ -76,7 +76,7 @@
     "_news_envelopes = []\n",
     "RIC_CODE = 'MRN_STORY'\n",
     "DOMAIN = 'NewsTextAnalytics'\n",
-    "SERVICE = 'ELEKTRON_DD'\n"
+    "SERVICE = 'ELEKTRON_DD'"
    ]
   },
   {
@@ -88,16 +88,15 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
-    "# Retrieve data\n",
-    "# Callback function to display data or status events\n",
     "def display_event(eventType, event):\n",
-    "    currentTime = datetime.datetime.now().time()\n",
-    "    print(\"----------------------------------------------------------\")\n",
-    "    print(\">>> {} event received at {}\".format(eventType, currentTime))\n",
+    "    \"\"\"Retrieve data: Callback function to display data or status events. \"\"\"\n",
+    "    current_time = datetime.datetime.now().time()\n",
+    "    print('----------------------------------------------------------')\n",
+    "    print(f'>>> {eventType} event received at {current_time}')\n",
     "    print(json.dumps(event, indent=2))\n",
     "    return"
    ]
@@ -111,13 +110,13 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
-    "def process_mrn_update(eventType, event):  \n",
+    "def process_mrn_update(event):  \n",
+    "        \"\"\"Process MRN Update messages.\"\"\"\n",
     "        message_json = event\n",
-    "        \"\"\"Function process Update Message for MRN domain data\"\"\"\n",
     "        fields_data = message_json['Fields']\n",
     "\n",
     "        # declare variables\n",
@@ -192,8 +191,8 @@
     "        # Some console environments like Windows may encounter this unicode display as a limitation of OS\n",
     "        except UnicodeEncodeError as encodeerror:\n",
     "            print(f'UnicodeEncodeError exception. Cannot decode unicode character for {guid} in this environment: ', encodeerror)\n",
-    "        except Exception as e:\n",
-    "            print('exception: ', sys.exc_info()[0])"
+    "        except Exception as specific_error:\n",
+    "            print(f'exception: str{specific_error}', sys.exc_info()[0])"
    ]
   },
   {
@@ -205,7 +204,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -227,7 +226,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
@@ -249,16 +248,16 @@
     "\n",
     "# Define the event callbacks\n",
     "# Refresh - the first full image we get back from the server\n",
-    "stream.on_refresh(lambda event, item_stream  : display_event(\"Refresh\", event))\n",
+    "stream.on_refresh(lambda event, item_stream  : display_event('Refresh', event))\n",
     "\n",
     "# Update - as and when field values change, we receive updates from the server and process the MRN data\n",
-    "stream.on_update(lambda event, item_stream : process_mrn_update(\"Update\", event))\n",
+    "stream.on_update(lambda event, item_stream : process_mrn_update(event))\n",
     "\n",
     "# Status - if data goes stale or item closes, we get a status message\n",
-    "stream.on_status(lambda event, item_stream : display_event(\"Status\", event))\n",
+    "stream.on_status(lambda event, item_stream : display_event('Status', event))\n",
     "\n",
     "# Other errors\n",
-    "stream.on_error(lambda event, item_stream : display_event(\"Error\", event))"
+    "stream.on_error(lambda event, item_stream : display_event('Error', event))"
    ]
   },
   {
@@ -387,7 +386,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -396,7 +395,7 @@
     "    # Close the session\n",
     "    ld.close_session() \n",
     "except Exception as ex:\n",
-    "    print(\"Error in close session: \" + str(ex))\n",
+    "    print(f'Error in close session: {str(ex)}')\n",
     " "
    ]
   },
@@ -424,7 +423,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.10"
+   "version": "3.11.5"
   }
  },
  "nbformat": 4,
diff --git a/src/OMMStream-MRN-LD.py b/src/OMMStream-MRN-LD.py
