1.0.0 DOC String corrected

Author: mshaileshr@gmail.com

contentstack/__init__.py

@@ -1,30 +1,31 @@
 
-#  __init__
-#  contentstack
-#
-#  Created by Shailesh Mishra on 22/06/19.
-#  Copyright © 2019 Contentstack. All rights reserved.
+"""
+__init__.py
+contentstack
+Created by Shailesh Mishra on 22/06/19.
+Copyright 2019 Contentstack. All rights reserved.
+
+"""
 
 import warnings
-__author__ = 'Shailesh Mishra'
+
+__author__ = 'Contentstack (Shailesh Mishra)'
 __status__ = 'debug'
 __version__ = '1.0.0'
 __package__ = 'contentstack'
 __endpoint__ = 'cdn.contentstack.io'
+__email__ = "mshaileshr@gmail.com"
 
 from .entry import Entry
 from .asset import Asset
 from .config import Config
 from .content_type import ContentType
-from .errors import Error, ConfigError, FileModeWarning
+from .errors import Error, FileModeWarning
 from .http_connection import HTTPConnection
 
 # Set a default logger to prevent "No handler found" warnings
 # Set default logging handler to avoid "No handler found" warnings.
 import logging
 from logging import NullHandler
-
 logging.getLogger(__name__).addHandler(NullHandler())
-
-# FileModeWarnings go off per the default.
 warnings.simplefilter('default', FileModeWarning, append=True)

contentstack/config.py

@@ -1,27 +1,25 @@
-#  Config
-#  contentstack
-#
-#  Created by Shailesh Mishra on 22/06/19.
-#  Copyright © 2019 Contentstack. All rights reserved.
+"""
+Config
+contentstack
+Created by Shailesh Mishra on 22/06/19.
+Copyright 2019 Contentstack. All rights reserved.
+
+"""
 
 import logging
-from enum import Enum
+import enum
 
-logging.basicConfig(filename='cs.log', format='%(asctime)s - %(message)s', level=logging.INFO)
-logging.getLogger("Config")
+logging.basicConfig(filename='report.log', format='%(asctime)s - %(message)s', level=logging.INFO)
+logging.getLogger(__name__)
 
 
-class ContentstackRegion(Enum):
+class ContentstackRegion(enum.Enum):
     US = 'us'
     EU = 'eu'
 
 
 class Config(object):
 
-    """
-    All API paths are relative to this base URL, for example, /users actually means <scheme>://<host>/<basePath>/users.
-    """
-
     def __init__(self):
         self.default = dict(protocol="https", region=ContentstackRegion.US, host="cdn.contentstack.io", version="v3")
 
@@ -30,19 +28,16 @@ def region(self, region=ContentstackRegion.US):
         """
         The base URL for Content Delivery API is cdn.contentstack.io.
         default region is for ContentstackRegion is US
-
         :param region: ContentstackRegion
         :return: self
-
-        Example:
-            >>> config  = Config().region(region=ContentstackRegion.US)
-
+        ==============================
+        [Example:]
+        >>> config  = Config().region(region=ContentstackRegion.US)
+        ==============================
         """
 
         if region is not None and isinstance(region, ContentstackRegion):
             self.default['region'] = region
-        else:
-            raise ValueError('Kindly provide a valid argument')
         return self
 
     def host(self, host):
@@ -59,10 +54,10 @@ def host(self, host):
         :return: self
         :rtype: Config
 
-        Example:
-
-            >>> config  = Config().host('api.contentstack.io')
-
+        ==============================
+        [Example:]
+        >>> config  = Config().host('api.contentstack.io')
+        ==============================
         """
 
         if host is not None and isinstance(host, str):
@@ -78,33 +73,33 @@ def version(self, version=None):
         :type version: str
         :return: self
         :rtype: Config
+        ==============================
+        [Example:] The API version (in our case, 'v3') can be found in the URL
 
-        Example: The API version (in our case, 'v3') can be found in the URL, e.g.
-
-            >>> config  = Config()
-            >>> config.version = 'v3'
-
+        >>> config  = Config()
+        >>> config.version = 'v3'
+        ==============================
         """
+
         if version is not None and isinstance(version, str):
             self.default['version'] = version
 
         return self
 
     @property
     def endpoint(self):
+
+        """
+        :return: url endpoint to make Http requst
+        """
         return self.__get_url()
 
     def __get_url(self):
         host = self.default["host"]
         if self.default['region'] is not ContentstackRegion.US:
-
             if self.default["host"] == 'cdn.contentstack.io':
-                # update the host to .com
                 self.default["host"] = 'cdn.contentstack.com'
             else:
-                # Find the regional value
                 regional_host = str(self.default['region'].value)
-                # Attach region to the host
                 host = '{}-{}'.format(regional_host, self.default["host"])
-
         return "{0}://{1}/{2}".format(self.default["protocol"], host, self.default["version"])

contentstack/errors.py

@@ -1,11 +1,14 @@
-#  Error
-#  contentstack
-#
-#  Created by Shailesh Mishra on 22/06/19.
-#  Copyright © 2019 Contentstack. All rights reserved.
+"""
+Error
+contentstack
+Created by Shailesh Mishra on 22/06/19.
+Copyright 2019 Contentstack. All rights reserved.
+
+"""
 
 
 class Error:
+
     """
     contentstack.error
     ~~~~~~~~~~~~~~~~~~
@@ -15,75 +18,78 @@ class Error:
     """
 
     def __init__(self):
-        """
-
-        """
+        # It has some values to set error_msg, error_code etc..
         self.__error_dict = {}
         self.__error_code = str
         self.__msg = str
-        self.__cause_err = str
-
-    def config(self, result: dict):
-        """
 
-        :param result:
-        :type result:
-        :return:
-        :rtype:
-        """
+    def _config(self, result: dict):
+        # config error information
         if result is not None and len(result) > 0:
             self.__error_dict = result
             self.__error_code = self.__error_dict['error_code']
             self.__msg = self.__error_dict['error_message']
-            self.__cause_err = self.__error_dict['errors']
         return self
 
     @property
     def error_code(self):
+
         """
         It returns error code from the stack response
         :return: error_code as int
         :rtype: int
+        ==============================
+        [Example:]
 
-        Example. code = error.error_code
-
+        >>> ode = error.error_code
+        ==============================
         """
         return self.__error_code
 
     @property
     def error_message(self):
+
         """
         Returns error_message from the stack response
         :return: error_message
         :rtype: str
+        ==============================
+        [Example:]
 
-        Example. error.error_message
-
+        >>> ode = error.error_message
+        ==============================
         """
 
         return self.__msg
 
     @property
     def error(self):
+
         """
         This returns error code and error_message in dict formats
         :return: error dict
         :rtype: dict
+        ==============================
+        [Example:]
 
-        Example. error = error.error
+        >>> ode = error.error
+        ==============================
         """
 
-        return self.__cause_err
+        return self.__msg
 
     @property
     def error_info(self) -> dict:
+
         """
         error information
         :return: error information
         :rtype: dict
+        ==============================
+        [Example:]
 
-        Example. error.error_info
-
+        >>> ode = error.error_info
+        ==============================
         """
         return self.__error_dict
 
@@ -114,28 +120,15 @@ def error_info(self) -> dict:
         429: "The number of requests exceeds the allowed limit for the given time period.",
         500: "The server is malfunctioning and is not specific on what the problem is.",
         502: "A server received an invalid response from another server.",
-        504: "A server did not receive a timely response from another server that it was accessing while attempting "
-             "to load the web page or fill another request by the browser. "
+        504: """ A server did not receive a timely response from another server that it was accessing while attempting
+             to load the web page or fill another request by the browser. """
     }
 
-    @staticmethod
-    def logging_config(level):
-        print('level ' + level)
-
-
-class ConfigError(Exception):
-    pass
-
 
 class StackException(Exception):
-    pass
-
-
-class ContentstackError(Exception):
-    pass
-
-
-class NotSupportedException(Exception):
+    """
+    StackException used to handle Stack validation Errors.
+    """
     pass