feat(SDK): Fixed Python Stach Metadata (#112)

* feat(SDK): Fixed Python Stach Metadata

Fixed the code snippets to generate metadata in the response similar to other SDK's.
Also added a change to disable warnings in the examples.

* feat(sdk): Addressed review comments

Made changes to the variable name for metadata as per @vamshimupparaju suggestion.

Author: avinashpipalwa

auto-generated-sdk/setup.py

@@ -14,7 +14,7 @@
 from setuptools import setup, find_packages  # noqa: H301
 
 NAME = "fds.analyticsapi.engines"
-VERSION = "5.6.0"
+VERSION = "5.7.0"
 # To install the library, run the following
 #
 # python setup.py install

examples/afi_optimizer_example.py

@@ -2,6 +2,7 @@
 import os
 import uuid
 import pandas as pd
+import urllib3
 
 from fds.analyticsapi.engines import ApiException
 from fds.analyticsapi.engines.api.afi_optimizer_api import AFIOptimizerApi
@@ -16,6 +17,7 @@
 from fds.protobuf.stach.extensions.StachVersion import StachVersion
 
 from urllib3 import Retry
+urllib3.disable_warnings()
 
 host = os.environ['FACTSET_HOST']
 fds_username = os.environ['FACTSET_USERNAME']

examples/axp_optimizer_example.py

@@ -2,6 +2,7 @@
 import os
 import uuid
 import pandas as pd
+import urllib3
 
 from fds.analyticsapi.engines import ApiException
 from fds.analyticsapi.engines.api.axp_optimizer_api import AXPOptimizerApi
@@ -18,6 +19,7 @@
 from fds.protobuf.stach.extensions.StachVersion import StachVersion
 
 from urllib3 import Retry
+urllib3.disable_warnings()
 
 host = os.environ['FACTSET_HOST']
 fds_username = os.environ['FACTSET_USERNAME']

examples/bpm_optimizer_example.py

@@ -2,6 +2,7 @@
 import os
 import uuid
 import pandas as pd
+import urllib3
 
 from fds.analyticsapi.engines import ApiException
 from fds.analyticsapi.engines.api.bpm_optimizer_api import BPMOptimizerApi
@@ -16,6 +17,7 @@
 from fds.protobuf.stach.extensions.StachVersion import StachVersion
 
 from urllib3 import Retry
+urllib3.disable_warnings()
 
 host = os.environ['FACTSET_HOST']
 fds_username = os.environ['FACTSET_USERNAME']

examples/fi_example.py

@@ -3,6 +3,7 @@
 import uuid
 import os
 import pandas as pd
+import urllib3
 
 from fds.analyticsapi.engines.api.fi_calculations_api import FICalculationsApi
 from fds.analyticsapi.engines.api_client import ApiClient
@@ -19,6 +20,7 @@
 from fds.analyticsapi.engines.model.fi_municipal_bonds_for_job_settings import FIMunicipalBondsForJobSettings
 
 from urllib3 import Retry
+urllib3.disable_warnings()
 
 host = os.environ['FACTSET_HOST']
 fds_username = os.environ['FACTSET_USERNAME']

examples/fiab_example.py

@@ -15,7 +15,7 @@
 from fds.analyticsapi.engines.model.fiab_identifier import FIABIdentifier
 from urllib3 import Retry
 
-urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+urllib3.disable_warnings()
 
 fds_username = os.environ['FACTSET_USERNAME']
 fds_api_key = os.environ['FACTSET_API_KEY']

examples/fpo_optimizer_example.py

@@ -2,6 +2,7 @@
 import os
 import uuid
 import pandas as pd
+import urllib3
 
 from fds.analyticsapi.engines import ApiException
 from fds.analyticsapi.engines.api.fpo_optimizer_api import FPOOptimizerApi
@@ -19,6 +20,7 @@
 from fds.protobuf.stach.extensions.StachVersion import StachVersion
 
 from urllib3 import Retry
+urllib3.disable_warnings()
 
 host = os.environ['FACTSET_HOST']
 fds_username = os.environ['FACTSET_USERNAME']

examples/pa_engine_multiple_unit_example.py

@@ -2,6 +2,7 @@
 import os
 import uuid
 import pandas as pd
+import urllib3
 
 from fds.analyticsapi.engines import ApiException
 from fds.analyticsapi.engines.api.pa_calculations_api import PACalculationsApi
@@ -18,8 +19,10 @@
 from fds.analyticsapi.engines.model.pa_calculation_pricing_source import PACalculationPricingSource
 from fds.protobuf.stach.extensions.StachVersion import StachVersion
 from fds.protobuf.stach.extensions.StachExtensionFactory import StachExtensionFactory
+from fds.protobuf.stach.extensions.v2.StachUtilities import StachUtilities
 
 from urllib3 import Retry
+urllib3.disable_warnings()
 
 host = os.environ['FACTSET_HOST']
 fds_username = os.environ['FACTSET_USERNAME']
@@ -143,11 +146,26 @@ def main():
 
 def output_calculation_result(result):
     print("Calculation Result")
-    stachBuilder = StachExtensionFactory.get_row_organized_builder(
-        StachVersion.V2)
+    metadata_list = []
+    stachBuilder = StachExtensionFactory.get_row_organized_builder(StachVersion.V2)
     stachExtension = stachBuilder.set_package(result).build()
     dataFramesList = stachExtension.convert_to_dataframe()
+    MetaData = stachExtension.get_metadata()
     print(dataFramesList)
+    print('\n MetaData:')
+    for metadataItem in MetaData:
+        metadata_dict = {}
+        for keyName in metadataItem:
+            appendedMetadata = ','.join(str(StachUtilities.get_value(x)) for x in metadataItem[keyName])
+            metadata_dict[keyName] = appendedMetadata
+        metadata_list.append(metadata_dict)
+
+    metadata_df = pd.DataFrame(metadata_list)
+    # Set display options for better readability
+    pd.set_option('display.max_rows', None)
+    pd.set_option('display.max_columns', None)
+    pd.set_option('display.width', None)
+    print(metadata_df.to_string(index=False, header=True, justify='left', col_space=20))
     # generate_excel(dataFramesList)  # Uncomment this line to get the result in table format exported to excel file.
 
 

examples/pa_engine_multiple_unit_linked_templated_component_example.py

@@ -2,6 +2,7 @@
 import os
 import uuid
 import pandas as pd
+import urllib3
 
 from fds.analyticsapi.engines import ApiException
 from fds.analyticsapi.engines.api.pa_calculations_api import PACalculationsApi
@@ -32,8 +33,10 @@
 from fds.analyticsapi.engines.model.column_statistic import ColumnStatistic
 from fds.analyticsapi.engines.api.groups_api import GroupsApi
 from fds.analyticsapi.engines.model.group import Group
+from fds.protobuf.stach.extensions.v2.StachUtilities import StachUtilities
 
 from urllib3 import Retry
+urllib3.disable_warnings()
 
 host = os.environ['FACTSET_HOST']
 fds_username = os.environ['FACTSET_USERNAME']
@@ -229,11 +232,26 @@ def main():
 
 def output_calculation_result(result):
     print("Calculation Result")
-    stachBuilder = StachExtensionFactory.get_row_organized_builder(
-        StachVersion.V2)
-    stachExtension = stachBuilder.set_package(pkg=result).build()
+    metadata_list = []
+    stachBuilder = StachExtensionFactory.get_row_organized_builder(StachVersion.V2)
+    stachExtension = stachBuilder.set_package(result).build()
     dataFramesList = stachExtension.convert_to_dataframe()
+    MetaData = stachExtension.get_metadata()
     print(dataFramesList)
+    print('\n MetaData:')
+    for metadataItem in MetaData:
+        metadata_dict = {}
+        for keyName in metadataItem:
+            appendedMetadata = ','.join(str(StachUtilities.get_value(x)) for x in metadataItem[keyName])
+            metadata_dict[keyName] = appendedMetadata
+        metadata_list.append(metadata_dict)
+
+    metadata_df = pd.DataFrame(metadata_list)
+    # Set display options for better readability
+    pd.set_option('display.max_rows', None)
+    pd.set_option('display.max_columns', None)
+    pd.set_option('display.width', None)
+    print(metadata_df.to_string(index=False, header=True, justify='left', col_space=20))
     # generate_excel(dataFramesList)  # Uncomment this line to get the result in table format exported to excel file.
 
 

examples/pa_engine_multiple_unit_unlinked_templated_component_example.py

@@ -2,6 +2,7 @@
 import os
 import uuid
 import pandas as pd
+import urllib3
 
 from fds.analyticsapi.engines import ApiException
 from fds.analyticsapi.engines.api.pa_calculations_api import PACalculationsApi
@@ -30,8 +31,10 @@
 from fds.analyticsapi.engines.model.column_statistic import ColumnStatistic
 from fds.analyticsapi.engines.api.groups_api import GroupsApi
 from fds.analyticsapi.engines.model.group import Group
+from fds.protobuf.stach.extensions.v2.StachUtilities import StachUtilities
 
 from urllib3 import Retry
+urllib3.disable_warnings()
 
 host = os.environ['FACTSET_HOST']
 fds_username = os.environ['FACTSET_USERNAME']
@@ -229,11 +232,26 @@ def main():
 
 def output_calculation_result(result):
     print("Calculation Result")
-    stachBuilder = StachExtensionFactory.get_row_organized_builder(
-        StachVersion.V2)
-    stachExtension = stachBuilder.set_package(pkg=result).build()
+    metadata_list = []
+    stachBuilder = StachExtensionFactory.get_row_organized_builder(StachVersion.V2)
+    stachExtension = stachBuilder.set_package(result).build()
     dataFramesList = stachExtension.convert_to_dataframe()
+    MetaData = stachExtension.get_metadata()
     print(dataFramesList)
+    print('\n MetaData:')
+    for metadataItem in MetaData:
+        metadata_dict = {}
+        for keyName in metadataItem:
+            appendedMetadata = ','.join(str(StachUtilities.get_value(x)) for x in metadataItem[keyName])
+            metadata_dict[keyName] = appendedMetadata
+        metadata_list.append(metadata_dict)
+
+    metadata_df = pd.DataFrame(metadata_list)
+    # Set display options for better readability
+    pd.set_option('display.max_rows', None)
+    pd.set_option('display.max_columns', None)
+    pd.set_option('display.width', None)
+    print(metadata_df.to_string(index=False, header=True, justify='left', col_space=20))
     # generate_excel(dataFramesList)  # Uncomment this line to get the result in table format exported to excel file.