fix(refactor): imports ordering and review fixes

Author: Ramanth

Utilities/examples/multiple_engines_example.py

@@ -2,28 +2,28 @@
 import sys
 import time
 
-from google.protobuf import json_format
-from google.protobuf.json_format import MessageToJson
-from google.protobuf.json_format import MessageToDict
-from fds.protobuf.stach.Package_pb2 import Package
-
-from fds.analyticsapi.engines.api_client import ApiClient
 from fds.analyticsapi.engines import ComponentSummary
-from fds.analyticsapi.engines.configuration import Configuration
+from fds.analyticsapi.engines.api.calculations_api import CalculationsApi
 from fds.analyticsapi.engines.api.components_api import ComponentsApi
 from fds.analyticsapi.engines.api.configurations_api import ConfigurationsApi
-from fds.analyticsapi.engines.api.calculations_api import CalculationsApi
 from fds.analyticsapi.engines.api.utility_api import UtilityApi
+from fds.analyticsapi.engines.api_client import ApiClient
+from fds.analyticsapi.engines.configuration import Configuration
 from fds.analyticsapi.engines.models.calculation import Calculation
 from fds.analyticsapi.engines.models.pa_calculation_parameters import PACalculationParameters
-from fds.analyticsapi.engines.models.pa_identifier import PAIdentifier
 from fds.analyticsapi.engines.models.pa_date_parameters import PADateParameters
+from fds.analyticsapi.engines.models.pa_identifier import PAIdentifier
 from fds.analyticsapi.engines.models.spar_calculation_parameters import SPARCalculationParameters
-from fds.analyticsapi.engines.models.spar_identifier import SPARIdentifier
 from fds.analyticsapi.engines.models.spar_date_parameters import SPARDateParameters
+from fds.analyticsapi.engines.models.spar_identifier import SPARIdentifier
 from fds.analyticsapi.engines.models.vault_calculation_parameters import VaultCalculationParameters
-from fds.analyticsapi.engines.models.vault_identifier import VaultIdentifier
 from fds.analyticsapi.engines.models.vault_date_parameters import VaultDateParameters
+from fds.analyticsapi.engines.models.vault_identifier import VaultIdentifier
+from fds.protobuf.stach.Package_pb2 import Package
+
+from google.protobuf import json_format
+from google.protobuf.json_format import MessageToJson
+from google.protobuf.json_format import MessageToDict
 from urllib3 import Retry
 
 # Copy 'Converting API output to Table Format' snippet to a file with name 'stach_extensions.py' to use below import statement
@@ -63,6 +63,7 @@
 # config.proxy = "<proxyUrl>"
 config.verify_ssl = False
 
+# Setting configuration to retry api calls on http status codes of 429 and 503.
 config.retries = Retry(total=3, status=3, status_forcelist=frozenset([429, 503]), backoff_factor=2, raise_on_status=False)
 
 api_client = ApiClient(config)
@@ -71,7 +72,7 @@
 
 components = components_api.get_pa_components(pa_document_name)
 pa_component_desc = ComponentSummary(name=pa_component_name, category=pa_component_category)
-component_id = [x for x in list(components.keys()) if components[x] == pa_component_desc][0]
+component_id = [id for id in list(components.keys()) if components[id] == pa_component_desc][0]
 
 pa_account_identifier = PAIdentifier(pa_benchmark_sp_50)
 pa_accounts = [pa_account_identifier]
@@ -83,7 +84,7 @@
 
 components = components_api.get_spar_components(spar_document_name)
 spar_component_desc = ComponentSummary(name=spar_component_name, category=spar_component_category)
-component_id = [x for x in list(components.keys()) if components[x] == spar_component_desc][0]
+component_id = [id for id in list(components.keys()) if components[id] == spar_component_desc][0]
 
 spar_account_identifier = SPARIdentifier(spar_benchmark_r_1000, spar_benchmark_russell_return_type, spar_benchmark_russell_prefix)
 spar_accounts = [spar_account_identifier]
@@ -94,7 +95,7 @@
 
 components = components_api.get_vault_components(vault_document_name)
 vault_component_desc = ComponentSummary(name=vault_component_name, category=vault_component_category)
-component_id = [x for x in list(components.keys()) if components[x] == vault_component_desc][0]
+component_id = [id for id in list(components.keys()) if components[id] == vault_component_desc][0]
 
 vault_account_identifier = VaultIdentifier(vault_default_account)
 vault_dates = VaultDateParameters(vault_startdate, vault_enddate, frequency)

Utilities/examples/pa_engine_example.py

@@ -2,21 +2,21 @@
 import sys
 import time
 
-from google.protobuf import json_format
-from google.protobuf.json_format import MessageToJson
-from google.protobuf.json_format import MessageToDict
-from fds.protobuf.stach.Package_pb2 import Package
-
-from fds.analyticsapi.engines.api_client import ApiClient
 from fds.analyticsapi.engines import ComponentSummary
-from fds.analyticsapi.engines.configuration import Configuration
-from fds.analyticsapi.engines.api.components_api import ComponentsApi
 from fds.analyticsapi.engines.api.calculations_api import CalculationsApi
+from fds.analyticsapi.engines.api.components_api import ComponentsApi
 from fds.analyticsapi.engines.api.utility_api import UtilityApi
+from fds.analyticsapi.engines.api_client import ApiClient
+from fds.analyticsapi.engines.configuration import Configuration
 from fds.analyticsapi.engines.models.calculation import Calculation
 from fds.analyticsapi.engines.models.pa_calculation_parameters import PACalculationParameters
-from fds.analyticsapi.engines.models.pa_identifier import PAIdentifier
 from fds.analyticsapi.engines.models.pa_date_parameters import PADateParameters
+from fds.analyticsapi.engines.models.pa_identifier import PAIdentifier
+from fds.protobuf.stach.Package_pb2 import Package
+
+from google.protobuf import json_format
+from google.protobuf.json_format import MessageToJson
+from google.protobuf.json_format import MessageToDict
 from urllib3 import Retry
 
 # Copy 'Converting API output to Table Format' snippet to a file with name 'stach_extensions.py' to use below import statement
@@ -43,6 +43,7 @@
 # config.proxy = "<proxyUrl>"
 config.verify_ssl = False
 
+# Setting configuration to retry api calls on http status codes of 429 and 503.
 config.retries = Retry(total=3, status=3, status_forcelist=frozenset([429, 503]), backoff_factor=2, raise_on_status=False)
 
 api_client = ApiClient(config)
@@ -51,7 +52,7 @@
 
 components = components_api.get_pa_components(pa_document_name)
 component_desc = ComponentSummary(name=pa_component_name, category=pa_component_category)
-component_id = [x for x in list(components.keys()) if components[x] == component_desc][0]
+component_id = [id for id in list(components.keys()) if components[id] == component_desc][0]
 
 pa_account_identifier = PAIdentifier(pa_benchmark_sp_50)
 pa_accounts = [pa_account_identifier]

Utilities/examples/spar_engine_example.py

@@ -2,21 +2,21 @@
 import sys
 import time
 
-from google.protobuf import json_format
-from google.protobuf.json_format import MessageToJson
-from google.protobuf.json_format import MessageToDict
-from fds.protobuf.stach.Package_pb2 import Package
-
-from fds.analyticsapi.engines.api_client import ApiClient
 from fds.analyticsapi.engines import ComponentSummary
-from fds.analyticsapi.engines.configuration import Configuration
-from fds.analyticsapi.engines.api.components_api import ComponentsApi
 from fds.analyticsapi.engines.api.calculations_api import CalculationsApi
+from fds.analyticsapi.engines.api.components_api import ComponentsApi
 from fds.analyticsapi.engines.api.utility_api import UtilityApi
+from fds.analyticsapi.engines.api_client import ApiClient
+from fds.analyticsapi.engines.configuration import Configuration
 from fds.analyticsapi.engines.models.calculation import Calculation
 from fds.analyticsapi.engines.models.spar_calculation_parameters import SPARCalculationParameters
-from fds.analyticsapi.engines.models.spar_identifier import SPARIdentifier
 from fds.analyticsapi.engines.models.spar_date_parameters import SPARDateParameters
+from fds.analyticsapi.engines.models.spar_identifier import SPARIdentifier
+from fds.protobuf.stach.Package_pb2 import Package
+
+from google.protobuf import json_format
+from google.protobuf.json_format import MessageToJson
+from google.protobuf.json_format import MessageToDict
 from urllib3 import Retry
 
 # Copy 'Converting API output to Table Format' snippet to a file with name 'stach_extensions.py' to use below import statement
@@ -45,6 +45,7 @@
 # config.proxy = "<proxyUrl>"
 config.verify_ssl = False
 
+# Setting configuration to retry api calls on http status codes of 429 and 503.
 config.retries = Retry(total=3, status=3, status_forcelist=frozenset([429, 503]), backoff_factor=2, raise_on_status=False)
 
 api_client = ApiClient(config)
@@ -53,7 +54,7 @@
 
 components = components_api.get_spar_components(spar_document_name)
 component_desc = ComponentSummary(name=spar_component_name, category=spar_component_category)
-component_id = [x for x in list(components.keys()) if components[x] == component_desc][0]
+component_id = [id for id in list(components.keys()) if components[id] == component_desc][0]
 
 spar_account_identifier = SPARIdentifier(spar_benchmark_r_1000, spar_benchmark_russell_return_type, spar_benchmark_russell_prefix)
 spar_accounts = [spar_account_identifier]

Utilities/examples/vault_engine_example.py

@@ -2,22 +2,22 @@
 import sys
 import time
 
-from google.protobuf import json_format
-from google.protobuf.json_format import MessageToJson
-from google.protobuf.json_format import MessageToDict
-from fds.protobuf.stach.Package_pb2 import Package
-
-from fds.analyticsapi.engines.api_client import ApiClient
 from fds.analyticsapi.engines import ComponentSummary
-from fds.analyticsapi.engines.configuration import Configuration
+from fds.analyticsapi.engines.api.calculations_api import CalculationsApi
 from fds.analyticsapi.engines.api.components_api import ComponentsApi
 from fds.analyticsapi.engines.api.configurations_api import ConfigurationsApi
-from fds.analyticsapi.engines.api.calculations_api import CalculationsApi
 from fds.analyticsapi.engines.api.utility_api import UtilityApi
+from fds.analyticsapi.engines.api_client import ApiClient
+from fds.analyticsapi.engines.configuration import Configuration
 from fds.analyticsapi.engines.models.calculation import Calculation
 from fds.analyticsapi.engines.models.vault_calculation_parameters import VaultCalculationParameters
-from fds.analyticsapi.engines.models.vault_identifier import VaultIdentifier
 from fds.analyticsapi.engines.models.vault_date_parameters import VaultDateParameters
+from fds.analyticsapi.engines.models.vault_identifier import VaultIdentifier
+from fds.protobuf.stach.Package_pb2 import Package
+
+from google.protobuf import json_format
+from google.protobuf.json_format import MessageToJson
+from google.protobuf.json_format import MessageToDict
 from urllib3 import Retry
 
 # Copy 'Converting API output to Table Format' snippet to a file with name 'stach_extensions.py' to use below import statement
@@ -43,6 +43,7 @@
 # config.proxy = "<proxyUrl>"
 config.verify_ssl = False
 
+# Setting configuration to retry api calls on http status codes of 429 and 503.
 config.retries = Retry(total=3, status=3, status_forcelist=frozenset([429, 503]), backoff_factor=2, raise_on_status=False)
 
 api_client = ApiClient(config)
@@ -51,7 +52,7 @@
 
 components = components_api.get_vault_components(vault_document_name)
 component_desc = ComponentSummary(name=vault_component_name, category=vault_component_category)
-component_id = [x for x in list(components.keys()) if components[x] == component_desc][0]
+component_id = [id for id in list(components.keys()) if components[id] == component_desc][0]
 
 vault_account_identifier = VaultIdentifier(vault_default_account)
 vault_dates = VaultDateParameters(vault_startdate, vault_enddate, frequency)