Fix Python Scripts to Support Cache Control (#78)

* fix(scripts): Fixing the component comparsion logic in Vault

* fix(scripts): Fixing the component comparsion logic in Vault

* Revert "fix(scripts): Fixing the component comparsion logic in Vault"

This reverts commit 32f68b1.

* fix(scripts): Fixing the component comparsion logic in vault

* fix(scripts): Adding the cache control logic to the Python SDK

* fix(scripts): Adding the cache control logic to the Python SDK

* fix(scripts): Removed the unnecessary comments in the scripts

Author: avinashpipalwa

examples/afi_optimizer_example.py

@@ -62,12 +62,16 @@ def main():
             afi_optimizer_strategy, afi_optimizer_output_types)
         afi_optimization_parameters_root = AFIOptimizationParametersRoot(
             data=afi_optimization_parameters)
-
+        # uncomment the below code line to setup cache control; max-stale=0 will be a fresh adhoc run and the max-stale value is in seconds.
+        # Results are by default cached for 12 hours; Setting max-stale=300 will fetch a cached result which is 5 minutes older.
+        # cache_control = "max-stale=0"
         afi_optimizations_api = AFIOptimizerApi(api_client)
-
+        
         post_and_optimize_response = afi_optimizations_api.post_and_optimize(
             afi_optimization_parameters_root=afi_optimization_parameters_root)
-
+        # comment the above line and uncomment the below line to run the request with the cache_control header defined earlier
+        # post_and_optimize_response = afi_optimizations_api.post_and_optimize(
+            # afi_optimization_parameters_root=afi_optimization_parameters_root, cache_control=cache_control)
         if post_and_optimize_response[1] == 201:
             output_optimization_result(post_and_optimize_response[0]['data'])
         else:

examples/axp_optimizer_example.py

@@ -81,6 +81,9 @@ def main():
             account=axp_optimizer_account,
             optimization=axp_optimizer_optimization
         )
+        # uncomment the below code line to setup cache control; max-stale=0 will be a fresh adhoc run and the max-stale value is in seconds.
+        # Results are by default cached for 12 hours; Setting max-stale=300 will fetch a cached result which is 5 minutes older.
+        # cache_control = "max-stale=0"
         axp_optimization_parameters_root = AxiomaEquityOptimizationParametersRoot(
             data=axp_optimizer_parameters)
 
@@ -89,7 +92,10 @@ def main():
         post_and_optimize_response = axp_optimizations_api.post_and_optimize(
             axioma_equity_optimization_parameters_root=axp_optimization_parameters_root
         )
-
+        # comment the above line and uncomment the below line to run the request with the cache_control header defined earlier
+        # post_and_optimize_response = axp_optimizations_api.post_and_optimize(
+            # axioma_equity_optimization_parameters_root=axp_optimization_parameters_root, cache_control=cache_control
+        # )
         if post_and_optimize_response[1] == 201:
             output_optimization_result(post_and_optimize_response[0]['data'])
         else:

examples/bpm_optimizer_example.py

@@ -52,6 +52,9 @@ def main():
         #       }
         #   }
         # }
+        # uncomment the below code line to setup cache control; max-stale=0 will be a fresh adhoc run and the max-stale value is in seconds.
+        # Results are by default cached for 12 hours; Setting max-stale=300 will fetch a cached result which is 5 minutes older. 
+        # cache_control = "max-stale=0"
         bpm_optimizer_strategy = BPMOptimizerStrategy(
             id="CLIENT:/Aapi/BPMAPISIMPLE")
         bpm_optimizer_trades_list = OptimizerTradesList(
@@ -67,6 +70,9 @@ def main():
 
         post_and_optimize_response = bpm_optimizations_api.post_and_optimize(
             bpm_optimization_parameters_root=bpm_optimization_parameters_root)
+        # comment the above line and uncomment the below line to run the request with the cache_control header defined earlier
+        # post_and_optimize_response = bpm_optimizations_api.post_and_optimize(
+            # bpm_optimization_parameters_root=bpm_optimization_parameters_root, cache_control=cache_control)
 
         if post_and_optimize_response[1] == 201:
             output_optimization_result(post_and_optimize_response[0]['data'])

examples/fi_example.py

@@ -70,6 +70,10 @@ def main():
         discount_curve = "UST"
     )
 
+    # uncomment the below code line to setup cache control; max-stale=0 will be a fresh adhoc run and the max-stale value is in seconds.
+    # Results are by default cached for 12 hours; Setting max-stale=300 will fetch a cached result which is 5 minutes older. 
+    # cache_control = "max-stale=0"
+
     securities = [security1, security2]
 
     jobSettings = FIJobSettings(as_of_date="20201201",
@@ -82,7 +86,9 @@ def main():
     fi_calculations_api = FICalculationsApi(api_client)
     run_calculation_response = fi_calculations_api.post_and_calculate(
         fi_calculation_parameters_root=fi_calculation_parameters_root)
-
+    # comment the above line and uncomment the below line to run the request with the cache_control header defined earlier
+    # run_calculation_response = fi_calculations_api.post_and_calculate(
+        # fi_calculation_parameters_root=fi_calculation_parameters_root, cache_control=cache_control)
     if run_calculation_response[1] != 202 and run_calculation_response[1] != 201:
         print_error(run_calculation_response)
         sys.exit()

examples/fpo_optimizer_example.py

@@ -63,6 +63,9 @@ def main():
         #         }
         #     }
         # }
+        # uncomment the below code line to setup cache control; max-stale=0 will be a fresh adhoc run and the max-stale value is in seconds.
+        # Results are by default cached for 12 hours; Setting max-stale=300 will fetch a cached result which is 5 minutes older. 
+        # cache_control = "max-stale=0"
         fpo_optimizer_strategy = OptimizerStrategy(
             id="Client:/analytics_api/dbui_simple_strategy")
         fpo_pa_doc = PaDoc("CLIENT:/FPO/FPO_MASTER")
@@ -90,7 +93,10 @@ def main():
         post_and_optimize_response = fpo_optimizations_api.post_and_optimize(
             fpo_optimization_parameters_root=fpo_optimization_parameters_root
         )
-
+        # comment the above line and uncomment the below line to run the request with the cache_control header defined earlier
+        # post_and_optimize_response = fpo_optimizations_api.post_and_optimize(
+            # fpo_optimization_parameters_root=fpo_optimization_parameters_root, cache_control=cache_control
+        # )
         if post_and_optimize_response[1] == 201:
             output_optimization_result(post_and_optimize_response[0]['data'])
         else:

examples/pa_engine_multiple_unit_example.py

@@ -20,7 +20,7 @@
 
 host = "https://api.factset.com"
 username = "<username-serial>"
-password = "<apikey>"
+password = "<apiKey>"
 
 
 def main():
@@ -45,18 +45,20 @@ def main():
         pa_document_name = "PA_DOCUMENTS:DEFAULT"
         pa_component_name = "Weights"
         pa_component_category = "Weights / Exposures"
-        pa_benchmark_sp_50 = "BENCH:SP50"
-        pa_benchmark_r_1000 = "BENCH:R.1000"
+        portfolio = "BENCH:SP50"
+        benchmark = "BENCH:R.1000"
         startdate = "20180101"
         enddate = "20181231"
         frequency = "Monthly"
-
+        # uncomment the below code line to setup cache control; max-stale=0 will be a fresh adhoc run and the max-stale value is in seconds.
+        # Results are by default cached for 12 hours; Setting max-stale=300 will fetch a cached result which is 5 minutes older. 
+        # cache_control = "max-stale=0"
         get_components_response = components_api.get_pa_components(document=pa_document_name)
         component_id = [id for id in list(
             get_components_response[0].data.keys()) if get_components_response[0].data[id].name == pa_component_name and get_components_response[0].data[id].category == pa_component_category][0]
         print("PA Component Id: " + component_id)
-        pa_accounts = [PAIdentifier(id=pa_benchmark_sp_50)]
-        pa_benchmarks = [PAIdentifier(id=pa_benchmark_r_1000)]
+        pa_accounts = [PAIdentifier(id=portfolio)]
+        pa_benchmarks = [PAIdentifier(id=benchmark)]
         pa_dates = PADateParameters(
             startdate=startdate, enddate=enddate, frequency=frequency)
 
@@ -72,7 +74,8 @@ def main():
 
         post_and_calculate_response = pa_calculations_api.post_and_calculate(
             pa_calculation_parameters_root=pa_calculation_parameter_root)
-
+        # comment the above line and uncomment the below line to run the request with the cache_control header defined earlier
+        # post_and_calculate_response = pa_calculations_api.post_and_calculate(pa_calculation_parameters_root=pa_calculation_parameter_root, cache_control=cache_control)
         if post_and_calculate_response[1] == 202 or post_and_calculate_response[1] == 200:
             calculation_id = post_and_calculate_response[0].data.calculationid
             print("Calculation Id: " + calculation_id)

examples/pa_engine_single_unit_example.py

@@ -20,7 +20,7 @@
 
 host = "https://api.factset.com"
 username = "<username-serial>"
-password = "<apikey>"
+password = "<apiKey>"
 
 def main():
     config = Configuration()
@@ -44,18 +44,20 @@ def main():
         pa_document_name = "PA_DOCUMENTS:DEFAULT"
         pa_component_name = "Weights"
         pa_component_category = "Weights / Exposures"
-        pa_benchmark_sp_50 = "BENCH:SP50"
-        pa_benchmark_r_1000 = "BENCH:R.1000"
+        portfolio = "BENCH:SP50"
+        benchmark = "BENCH:R.1000"
         startdate = "20180101"
         enddate = "20181231"
         frequency = "Monthly"
-
+        # uncomment the below code line to setup cache control; max-stale=0 will be a fresh adhoc run and the max-stale value is in seconds.
+        # Results are by default cached for 12 hours; Setting max-stale=300 will fetch a cached result which is 5 minutes older.
+        # cache_control = "max-stale=0"
         get_components_response = components_api.get_pa_components(document=pa_document_name)
         component_id = [id for id in list(
             get_components_response[0].data.keys()) if get_components_response[0].data[id].name == pa_component_name and get_components_response[0].data[id].category == pa_component_category][0]
         print("PA Component Id: " + component_id)
-        pa_accounts = [PAIdentifier(id=pa_benchmark_sp_50)]
-        pa_benchmarks = [PAIdentifier(id=pa_benchmark_r_1000)]
+        pa_accounts = [PAIdentifier(id=portfolio)]
+        pa_benchmarks = [PAIdentifier(id=benchmark)]
         pa_dates = PADateParameters(
             startdate=startdate, enddate=enddate, frequency=frequency)
 
@@ -69,7 +71,8 @@ def main():
 
         post_and_calculate_response = pa_calculations_api.post_and_calculate(
             pa_calculation_parameters_root=pa_calculation_parameter_root)
-
+        # comment the above line and uncomment the below line to run the request with the cache_control header defined earlier
+        # post_and_calculate_response = pa_calculations_api.post_and_calculate(pa_calculation_parameters_root=pa_calculation_parameter_root, cache_control=cache_control)
         if post_and_calculate_response[1] == 201:
             output_calculation_result(post_and_calculate_response[0]['data'])
         elif post_and_calculate_response[1] == 200:

examples/pub_engine_multiple_unit_example.py

@@ -39,7 +39,9 @@ def main():
         pub_account_id = "BENCH:SP50"
         startdate = "-1M"
         enddate = "0M"
-
+        # uncomment the below code line to setup cache control; max-stale=0 will be a fresh adhoc run and the max-stale value is in seconds.
+        # Results are by default cached for 12 hours; Setting max-stale=300 will fetch a cached result which is 5 minutes older.
+        # cache_control = "max-stale=0"
         pub_account_identifier = PubIdentifier(pub_account_id)
         pub_dates = PubDateParameters(enddate, startdate=startdate)
 
@@ -54,7 +56,8 @@ def main():
         pub_calculations_api = PubCalculationsApi(api_client)
         post_and_calculate_response = pub_calculations_api.post_and_calculate(
             pub_calculation_parameters_root=pub_calculation_parameters_root)
-
+        # comment the above line and uncomment the below line to run the request with the cache_control header defined earlier
+        # post_and_calculate_response = pub_calculations_api.post_and_calculate(pub_calculation_parameters_root=pub_calculation_parameters_root, cache_control=cache_control)
         if post_and_calculate_response[1] == 202 or post_and_calculate_response[1] == 200:
             calculation_id = post_and_calculate_response[0].data.calculationid
             print("Calculation Id: " + calculation_id)

examples/pub_engine_single_unit_example.py

@@ -39,7 +39,9 @@ def main():
         pub_account_id = "BENCH:SP50"
         startdate = "-1M"
         enddate = "0M"
-
+        # uncomment the below code line to setup cache control; max-stale=0 will be a fresh adhoc run and the max-stale value is in seconds.
+        # Results are by default cached for 12 hours; Setting max-stale=300 will fetch a cached result which is 5 minutes older.
+        # cache_control = "max-stale=0"
         pub_account_identifier = PubIdentifier(pub_account_id)
         pub_dates = PubDateParameters(enddate, startdate=startdate)
 
@@ -52,8 +54,9 @@ def main():
 
         pub_calculations_api = PubCalculationsApi(api_client)
         post_and_calculate_response = pub_calculations_api.post_and_calculate(
-            pub_calculation_parameters_root=pub_calculation_parameters_root)
-
+           pub_calculation_parameters_root=pub_calculation_parameters_root)
+        # comment the above line and uncomment the below line to run the request with the cache_control header defined earlier
+        # post_and_calculate_response = pub_calculations_api.post_and_calculate(pub_calculation_parameters_root=pub_calculation_parameters_root, cache_control=cache_control)
         if post_and_calculate_response[1] == 201:
             output_calculation_result(
                 "single_unit", (post_and_calculate_response[0].read()))

examples/quant_engine_single_unit_feather_example_basic.py

@@ -53,7 +53,9 @@ def main():
             expr="P_PRICE(#DATE,#DATE,#FREQ)", name="Price (fql)")
         fqlExpression2 = QuantFqlExpression(source="FqlExpression",
             expr="OS_TOP_HLDR_POS(3,#DATE,#DATE,M,,S,SEC)", name="Top 3 Pos (fql)")
-
+        # uncomment the below code line to setup cache control; max-stale=0 will be a fresh adhoc run and the max-stale value is in seconds.
+        # Results are by default cached for 12 hours; Setting max-stale=300 will fetch a cached result which is 5 minutes older. 
+        # cache_control = "max-stale=0"
         quant_calculation_parameters = {"1": QuantCalculationParameters(
             universe=screeningExpressionUniverse,
             dates=fdsDate,
@@ -69,6 +71,9 @@ def main():
 
         post_and_calculate_response = quant_calculations_api.post_and_calculate(
             quant_calculation_parameters_root=quant_calculation_parameter_root)
+        # comment the above line and uncomment the below line to run the request with the cache_control header defined earlier
+        # post_and_calculate_response = quant_calculations_api.post_and_calculate(
+            # quant_calculation_parameters_root=quant_calculation_parameter_root, cache_control=cache_control)
 
         if post_and_calculate_response[1] == 201:
             output_calculation_result('data', post_and_calculate_response[0])