v3.25.12.1

Author: github-actions

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blpapi
-Version: 3.25.11.1
+Version: 3.25.12.1
 Summary: Python SDK for Bloomberg BLPAPI
 Home-page: http://www.bloomberglabs.com/api/
 Author: Bloomberg L.P.

changelog.txt

@@ -1,3 +1,15 @@
+Version 3.25.12.1:
+==================
+- JSON serialization and deserialization support for elements
+    Introduced `toJson()` and `fromJson(JSON)` methods to enable conversion
+    between element objects and JSON.
+    Requests can be constructed using `request.fromJson(REQUEST_JSON)`,
+    events can be populated with `eventFormatter.fromJson(REQUEST_JSON)`,
+    and messages can be converted to JSON using `message.toJson()`. You
+    can also apply `toJson()` and `fromJson(JSON)` to any `Element` objects.
+
+- Stability and performance improvements
+
 Version 3.25.11.1:
 ==================
 - Stability and performance improvements

examples/demoapps/snippets/requestresponse/HistoricalDataRequest.py

@@ -16,6 +16,7 @@ def createRequest(service, options):
     # NOTE: this function uses `Request.__setitem__` to format a `Request`. See
     # the other `createRequest` functions in this `requestresponse` directory
     # for examples of alternative interfaces for formatting a `Request`.
+    # An alternative using `request.fromJson` is shown in the comments below.
     request = service.createRequest("HistoricalDataRequest")
 
     request[SECURITIES] = options.securities
@@ -28,6 +29,22 @@ def createRequest(service, options):
     request[MAX_DATA_POINTS] = 100
     request[RETURN_EIDS] = True
 
+    # Alternative: Using `Request.fromJson` to format the request
+    # import json
+    # REQUEST_JSON = f"""
+    # {{
+    #     "securities": {json.dumps(options.securities)},
+    #     "fields": {json.dumps(options.fields)},
+    #     "periodicityAdjustment": "ACTUAL",
+    #     "periodicitySelection": "MONTHLY",
+    #     "startDate": "20200101",
+    #     "endDate": "20201231",
+    #     "maxDataPoints": 100,
+    #     "returnEids": true
+    # }}
+    # """
+    # request.fromJson(REQUEST_JSON)
+
     return request
 
 
@@ -36,6 +53,10 @@ def processResponseEvent(event):
         print(f"Received response to request {msg.getRequestId()}")
         print(msg)
 
+        # Alternative: Using `Message.toJson` to convert the message to JSON
+        # jsonStr = msg.toJson()
+        # print(jsonStr)
+
 
 __copyright__ = """
 Copyright 2021, Bloomberg Finance L.P.

src/blpapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blpapi
-Version: 3.25.11.1
+Version: 3.25.12.1
 Summary: Python SDK for Bloomberg BLPAPI
 Home-page: http://www.bloomberglabs.com/api/
 Author: Bloomberg L.P.

src/blpapi/eventformatter.py

@@ -459,6 +459,17 @@ def appendElement(self) -> None:
             internals.blpapi_EventFormatter_appendElement(self.__handle)
         )
 
+    def fromJson(self, jsonString: str) -> None:
+        """Equivalent to :meth:`getElement().fromJson(jsonString)
+        <Element.fromJson>`.
+
+        Args:
+            jsonString: JSON formatted string used to populate the current
+                element.
+        """
+
+        self.getElement().fromJson(jsonString)
+
     def fromPy(self, value: MappingType) -> None:
         r"""
         Format this :class:`EventFormatter`'s underlying :class:`Event` using

src/blpapi/message.py

@@ -384,6 +384,15 @@ def asElement(self) -> Element:
             self.__element = weakref.ref(el)
         return el
 
+    def toJson(self) -> str:
+        """Equivalent to :meth:`asElement().toJson()<Element.toJson>`.
+
+        Returns:
+            JSON string representation of this message.
+        """
+
+        return self.asElement().toJson()
+
     def toString(self, level: int = 0, spacesPerLevel: int = 4) -> str:
         """Format this :class:`Message` to the string at the specified
         indentation level.

src/blpapi/request.py

@@ -115,6 +115,16 @@ def fromPy(self, requestDict: Mapping) -> None:
         """
         self.asElement().fromPy(requestDict)
 
+    def fromJson(self, jsonString: str) -> None:
+        """Equivalent to :meth:`asElement().fromJson(jsonString)
+        <Element.fromJson>`.
+
+        Args:
+            jsonString: JSON formatted string used to populate this request.
+        """
+
+        self.asElement().fromJson(jsonString)
+
     def asElement(self) -> Element:
         """
         Returns:

src/blpapi/version.py

@@ -4,8 +4,8 @@
 
 from . import internals
 
-__version__ = "3.25.11.1"
-__expected_cpp_sdk_version__ = "3.25.11"
+__version__ = "3.25.12.1"
+__expected_cpp_sdk_version__ = "3.25.12"
 
 
 def print_version() -> None: