Refactor python client.

samples/client/petstore/python/swagger_client/configuration.py

@@ -1,3 +1,21 @@
+# coding: utf-8
+
+"""
+Copyright 2015 SmartBear Software
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+"""
+
 from __future__ import absolute_import
 import base64
 import urllib3
@@ -18,26 +36,45 @@ def singleton(cls, *args, **kw):
 
 @singleton
 class Configuration(object):
+    """
+    NOTE: This class is auto generated by the swagger code generator program.
+    https://github.com/swagger-api/swagger-codegen
+    Do not edit the class manually.
+    """
 
     def __init__(self):
+        """
+        Constructor
+        """
         # Default Base url
         self.host = "http://petstore.swagger.io/v2"
         # Default api client
         self.api_client = None
-        # Temp file folder
+        # Temp file folder for download
         self.temp_folder_path = None
+
         # Authentication Settings
+        # dict to store API key(s)
         self.api_key = {}
+        # dict to store API prefix (e.g. Bearer)
         self.api_key_prefix = {}
+        # Username for HTTP basic authentication
         self.username = ""
+        # Password for HTTP basic authentication
         self.password = ""
+
         # Logging Settings
         self.logging_format = '%(asctime)s %(levelname)s %(message)s'
+        # Debug file location
         self.__logging_file = None
+        # Debug switch
         self.__debug = False
         self.init_logger()
 
     def init_logger(self):
+        """
+        Initializes logger settings.
+        """
         self.logger = logging.getLogger()
         formatter = logging.Formatter(self.logging_format)
         stream_handler = logging.StreamHandler()
@@ -83,19 +120,32 @@ class Configuration(object):
             self.logger.setLevel(logging.WARNING)
 
     def get_api_key_with_prefix(self, key):
-        """ Return api key prepend prefix for key """
+        """
+        Gets API key (with prefix if set).
+
+        :param key: Name of apiKey.
+        :return: The token for api key authentication.
+        """
         if self.api_key.get(key) and self.api_key_prefix.get(key):
             return self.api_key_prefix[key] + ' ' + self.api_key[key]
         elif self.api_key.get(key):
             return self.api_key[key]
 
     def get_basic_auth_token(self):
-        """ Return basic auth header string """
+        """
+        Gets basic auth header string.
+
+        :return: The token for basic HTTP authentication.
+        """
         return urllib3.util.make_headers(basic_auth=self.username + ':' + self.password)\
                            .get('authorization')
 
     def auth_settings(self):
-        """ Return Auth Settings for api client """
+        """
+        Gets Auth Settings dict for api client.
+
+        :return: The Auth Settings information dict.
+        """
         return {
             'api_key':
                 {
@@ -107,6 +157,11 @@ class Configuration(object):
         }
 
     def to_debug_report(self):
+        """
+        Gets the essential information for debugging.
+
+        :return: The report for debugging.
+        """
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\