snaptrade-python-sdk 10.9.0__py3-none-any.whl → 11.0.152__py3-none-any.whl

snaptrade_client/client_custom.py

@@ -0,0 +1,29 @@
+# coding: utf-8
+"""
+    SnapTrade
+
+    Connect brokerage accounts to your app for live positions and trading
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: api@snaptrade.com
+    Created by: https://snaptrade.com/
+"""
+
+import typing
+
+from snaptrade_client.configuration import Configuration
+from snaptrade_client.api_client import ApiClient
+
+
+
+class ClientCustom:
+
+    def __init__(self, configuration: typing.Union[Configuration, None] = None, **kwargs):
+        if (len(kwargs) > 0):
+            configuration = Configuration(**kwargs)
+        if (configuration is None):
+            raise Exception("configuration is required")
+        api_client = ApiClient(configuration)
+        # customize here
+
+    # add custom methods here

snaptrade_client/configuration.py

@@ -7,7 +7,7 @@
 
     The version of the OpenAPI document: 1.0.0
     Contact: api@snaptrade.com
-    Generated by: https://konfigthis.com
+    Created by: https://snaptrade.com/
 """
 
 import copy
@@ -17,7 +17,7 @@ import sys
 import urllib3
 
 
-import validators
+import re
 from urllib.parse import urlparse
 from http import client as http_client
 from snaptrade_client.exceptions_base import ApiValueError
@@ -108,9 +108,9 @@ conf = snaptrade_client.Configuration(
                  api_key=None, api_key_prefix=None,
                  username=None, password=None,
                  discard_unknown_keys=False,
-                 client_id=None,
-                 signature=None,
-                 timestamp=None,
+                                  client_id=None,
+                                  signature=None,
+                                  timestamp=None,
                  consumer_key=None,
                  disabled_client_side_validations="",
                  server_index=None, server_variables=None,
@@ -125,8 +125,6 @@ conf = snaptrade_client.Configuration(
         self.server_operation_index = server_operation_index or {}
         """Default server index
         """
-        if consumer_key is None:
-            raise Exception("consumer_key is required")
         self.consumer_key = consumer_key
         """Client State
         """
@@ -145,16 +143,24 @@ conf = snaptrade_client.Configuration(
             else:
                 self.api_key = api_key
         if client_id:
+            if type(client_id) is not str:
+                raise ClientConfigurationError("client_id must be a string")
             self.api_key['PartnerClientId'] = client_id
         if signature:
+            if type(signature) is not str:
+                raise ClientConfigurationError("signature must be a string")
             self.api_key['PartnerSignature'] = signature
         if timestamp:
+            if type(timestamp) is not str:
+                raise ClientConfigurationError("timestamp must be a string")
             self.api_key['PartnerTimestamp'] = timestamp
         """dict to store API key(s)
         """
         self.api_key_prefix = {}
         if api_key_prefix:
             self.api_key_prefix = api_key_prefix
+        else:
+            pass
         """dict to store API prefix (e.g. Bearer)
         """
         self.refresh_api_key_hook = None
@@ -168,23 +174,15 @@ conf = snaptrade_client.Configuration(
         """
         self.discard_unknown_keys = discard_unknown_keys
         self.disabled_client_side_validations = disabled_client_side_validations
-        self.logger = {}
         """Logging Settings
         """
-        self.logger["package_logger"] = logging.getLogger("snaptrade_client")
-        self.logger["urllib3_logger"] = logging.getLogger("urllib3")
-        self.logger_format = '%(asctime)s %(levelname)s %(message)s'
+        self.logger = logging.getLogger("snaptrade_client")
+        # if no handler for logger, add a stream handler
+        if not self.logger.handlers:
+            self.logger.addHandler(logging.StreamHandler())
+        self.logger_format = '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
         """Log format
         """
-        self.logger_stream_handler = None
-        """Log stream handler
-        """
-        self.logger_file_handler = None
-        """Log file handler
-        """
-        self.logger_file = None
-        """Debug file location
-        """
         self.debug = False
         """Debug switch
         """
@@ -238,12 +236,10 @@ conf = snaptrade_client.Configuration(
         result = cls.__new__(cls)
         memo[id(self)] = result
         for k, v in self.__dict__.items():
-            if k not in ('logger', 'logger_file_handler'):
+            if k not in ('logger'):
                 setattr(result, k, copy.deepcopy(v, memo))
         # shallow copy of loggers
         result.logger = copy.copy(self.logger)
-        # use setters to configure loggers
-        result.logger_file = self.logger_file
         result.debug = self.debug
         return result
 
@@ -306,12 +302,11 @@ conf = snaptrade_client.Configuration(
         """
         self.__logger_file = value
         if self.__logger_file:
-            # If set logging file,
-            # then add file handler and remove stream handler.
-            self.logger_file_handler = logging.FileHandler(self.__logger_file)
-            self.logger_file_handler.setFormatter(self.logger_formatter)
-            for _, logger in self.logger.items():
-                logger.addHandler(self.logger_file_handler)
+            # If set logging file, then add file handler to self.logger if one
+            # does not already exist. Otherwise, do nothing.
+            if not any(isinstance(handler, logging.FileHandler)
+                          for handler in self.logger.handlers):
+                 self.logger.addHandler(logging.FileHandler(self.__logger_file))
 
     @property
     def debug(self):
@@ -332,15 +327,13 @@ conf = snaptrade_client.Configuration(
         self.__debug = value
         if self.__debug:
             # if debug status is True, turn on debug logging
-            for _, logger in self.logger.items():
-                logger.setLevel(logging.DEBUG)
+            self.logger.setLevel(logging.DEBUG)
             # turn on http_client debug
             http_client.HTTPConnection.debuglevel = 1
         else:
             # if debug status is False, turn off debug logging,
             # setting log level to default `logging.WARNING`
-            for _, logger in self.logger.items():
-                logger.setLevel(logging.WARNING)
+            self.logger.setLevel(logging.WARNING)
             # turn off http_client debug
             http_client.HTTPConnection.debuglevel = 0
 
@@ -365,7 +358,9 @@ conf = snaptrade_client.Configuration(
         :type: str
         """
         self.__logger_format = value
-        self.logger_formatter = logging.Formatter(self.__logger_format)
+        # set Formatter for all handlers in self.logger
+        for handler in self.logger.handlers:
+            handler.setFormatter(logging.Formatter(self.__logger_format))
 
     def get_api_key_with_prefix(self, identifier, alias=None):
         """Gets API key (with prefix if set).
@@ -380,7 +375,7 @@ conf = snaptrade_client.Configuration(
         if key:
             prefix = self.api_key_prefix.get(identifier)
             if prefix:
-                return "%s %s" % (prefix, key)
+                return "%s%s" % (prefix, key)
             else:
                 return key
 
@@ -443,7 +438,7 @@ conf = snaptrade_client.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.0.0\n"\
-               "SDK Package Version: 10.9.0".\
+               "SDK Package Version: 11.0.152".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):
@@ -507,8 +502,11 @@ conf = snaptrade_client.Configuration(
         """Fix base path."""
         self._base_path = check_url(value)
         self.server_index = None
-        
-def check_url(url: str):
+
+DOMAIN_REGEX = re.compile(
+    r'^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9](?::[0-9]{1,5})?$|^(?:[0-9]{1,3}\.){3}[0-9]{1,3}(?::[0-9]{1,5})?$'
+)
+def check_url(url: str) -> str:
     parsed = urlparse(url)
     if parsed.query != '':
         raise InvalidHostConfigurationError(url, "query string is not allowed")
@@ -516,8 +514,10 @@ def check_url(url: str):
         raise InvalidHostConfigurationError(url, "fragment is not allowed")
     if parsed.scheme not in ["http", "https"]:
         raise InvalidHostConfigurationError(url, 'scheme must be "http" or "https"'.format(parsed.scheme))
-    if not validators.url(url):
-        raise InvalidHostConfigurationError(url, "invalid url")
+    if (parsed.netloc == ''):
+        raise InvalidHostConfigurationError(url, "host is not set")
+    if not DOMAIN_REGEX.match(parsed.netloc):
+        raise InvalidHostConfigurationError(url, "Invalid domain")
     if (url.endswith("/")):
         return url[:-1]
     return url

snaptrade_client/exceptions.py

@@ -7,12 +7,12 @@
 
     The version of the OpenAPI document: 1.0.0
     Contact: api@snaptrade.com
-    Generated by: https://konfigthis.com
+    Created by: https://snaptrade.com/
 """
 
 
 import typing
-from snaptrade_client.api_response import ApiResponse
+from snaptrade_client.api_response import ApiResponse, AsyncApiResponse
 from snaptrade_client.exceptions_base import OpenApiException, ApiTypeError, ApiValueError, render_path
 
 class ClientConfigurationError(OpenApiException):
@@ -56,14 +56,26 @@ class ApiKeyError(OpenApiException, KeyError):
         super(ApiKeyError, self).__init__(full_msg)
 
 
+class ApiStreamingException(OpenApiException):
+
+    def __init__(self, status=None, reason=None, body=None):
+        self.status = status
+        self.reason = reason
+        self.body = body
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        return "({0})\n Reason: {1}\n Body: {2}".format(self.status, self.reason, self.body)
+
+
 class ApiException(OpenApiException):
 
-    def __init__(self, status=None, reason=None, api_response: ApiResponse = None):
+    def __init__(self, status=None, reason=None, api_response: typing.Optional[typing.Union[ApiResponse, AsyncApiResponse]] = None):
         if api_response:
             self.status = api_response.status
             self.reason = api_response.response.reason
             self.body = api_response.body
-            self.headers = api_response.response.getheaders()
+            self.headers = api_response.response.headers
             self.round_trip_time = api_response.round_trip_time
         else:
             self.status = status
@@ -86,48 +98,6 @@ class ApiException(OpenApiException):
         return error_message
 
 
-class AnyOfValidationError(OpenApiException):
-    def __init__(self, error_list: typing.List[typing.Union[ApiTypeError, ApiValueError]]):
-        self.error_list = error_list
-        sub_msgs: typing.List[str] = []
-        for type_error in error_list:
-            sub_msgs.append(str(type_error))
-        num_validation_errors = len(self.error_list)
-        if num_validation_errors == 1:
-            super().__init__(sub_msgs[0])
-        else:
-            # create a string that says how many validation errors there were and
-            # prints each sub_msg out using a bulleted list of messages
-            msg = "{} validation error{} detected: \n".format(num_validation_errors, "s" if num_validation_errors > 1 else "")
-            for i, sub_msg in enumerate(sub_msgs):
-                msg += " {}. {}\n".format(i+1, sub_msg)
-            super().__init__(msg)
-
-
-class InvalidHostConfigurationError(ClientConfigurationError):
-    def __init__(self, host: str, reason: str):
-        self.host = host
-        self.reason = reason
-        super().__init__('Invalid host: "{}", {}'.format(self.host, self.reason))
-
-
-class MissingRequiredPropertiesError(TypeError):
-    def __init__(self, msg: str):
-        super().__init__(msg)
-
-
-class MissingRequiredParametersError(TypeError):
-    def __init__(self, error: TypeError):
-        self.error = error
-        error_str = str(error)
-        self.msg = error_str
-        if "__new__()" in error_str:
-            # parse error to reformat
-            missing_parameters = error_str.split(":")[1].strip()
-            number_of_parameters = error_str.split("missing")[1].split("required")[0].strip()
-            self.msg = "Missing {} required parameter{}: {}".format(number_of_parameters, "s" if int(number_of_parameters) > 1 else "", missing_parameters)
-        super().__init__(self.msg)
-
 class SchemaValidationError(OpenApiException):
     def __init__(self, validation_errors: typing.List[typing.Union[ApiValueError, ApiTypeError]]):
         """ Aggregates schema validation errors
@@ -164,10 +134,13 @@ class SchemaValidationError(OpenApiException):
                 sub_msgs.append(str(error))
         if len(self.type_errors) > 0:
             for type_error in self.type_errors:
-                classes = ", ".join([cls.__name__ for cls in type_error.valid_classes])
-                msg = 'Got {}({}) for required type {} at {}'.format(
-                    type(type_error.invalid_value).__name__, type_error.invalid_value, classes, render_path(type_error.path_to_item))
-                sub_msgs.append(msg)
+                if isinstance(type_error, MissingRequiredPropertiesError) or isinstance(type_error, MissingRequiredParametersError):
+                    sub_msgs.append(str(type_error))
+                else:
+                    classes = ", ".join([cls.__name__ for cls in type_error.valid_classes])
+                    msg = 'Got {}({}) for required type {} at {}'.format(
+                        type(type_error.invalid_value).__name__, type_error.invalid_value, classes, render_path(type_error.path_to_item))
+                    sub_msgs.append(msg)
         if len(self.value_errors) > 0:
             for value_error in self.value_errors:
                 sub_msgs.append(value_error.full_msg)
@@ -175,3 +148,45 @@ class SchemaValidationError(OpenApiException):
         num_validation_errors = len(self.validation_errors)
         self.msg = "{} invalid argument{}. {}".format(num_validation_errors, "s" if num_validation_errors > 1 else "", sub_msg)
         super().__init__(self.msg)
+
+class AnyOfValidationError(OpenApiException):
+    def __init__(self, error_list: typing.List[typing.Union[ApiTypeError, ApiValueError, SchemaValidationError]]):
+        self.error_list = error_list
+        sub_msgs: typing.List[str] = []
+        for type_error in error_list:
+            sub_msgs.append(str(type_error))
+        num_validation_errors = len(self.error_list)
+        if num_validation_errors == 1:
+            super().__init__(sub_msgs[0])
+        else:
+            # create a string that says how many validation errors there were and
+            # prints each sub_msg out using a bulleted list of messages
+            msg = "{} validation error{} detected: \n".format(num_validation_errors, "s" if num_validation_errors > 1 else "")
+            for i, sub_msg in enumerate(sub_msgs):
+                msg += " {}. {}\n".format(i+1, sub_msg)
+            super().__init__(msg)
+
+
+class InvalidHostConfigurationError(ClientConfigurationError):
+    def __init__(self, host: str, reason: str):
+        self.host = host
+        self.reason = reason
+        super().__init__('Invalid host: "{}", {}'.format(self.host, self.reason))
+
+
+class MissingRequiredPropertiesError(ApiTypeError):
+    def __init__(self, msg: str):
+        super().__init__(msg)
+
+
+class MissingRequiredParametersError(ApiTypeError):
+    def __init__(self, error: TypeError):
+        self.error = error
+        error_str = str(error)
+        self.msg = error_str
+        if "__new__()" in error_str:
+            # parse error to reformat
+            missing_parameters = error_str.split(":")[1].strip()
+            number_of_parameters = error_str.split("missing")[1].split("required")[0].strip()
+            self.msg = "Missing {} required parameter{}: {}".format(number_of_parameters, "s" if int(number_of_parameters) > 1 else "", missing_parameters)
+        super().__init__(self.msg)