Version 1.3.5

Author: sfanous

HISTORY.rst

@@ -2,35 +2,33 @@
 
 Release History
 ===============
-1.3.0 (2020-04-02)
+1.3.5 (2020-04-03)
 ------------------
+* Code refactoring and cleanup
 
+1.3.0 (2020-04-02)
+------------------
 * Uplift the implementation to include all update to the ecobee API since mid 2017
 
 1.2.1 (2017-06-01)
 ------------------
-
 * Internal __slots__ improvements
 
 1.2.0 (2017-05-31)
 ------------------
-
 * Internal refactoring of EcobeeObject and EcobeeResponse
 
 
 1.1.1 (2017-05-31)
 ------------------
-
 * Miscellaneous minor internal changes to facilitate the automatic generation of PlantUML Class Diagrams
 
 
 1.1.0 (2017-05-24)
 ------------------
-
 * Added ecobee API operations that are only accessible by EMS and Utility accounts
 
 
 1.0.0 (2017-05-12)
 ------------------
-
 * First public release supporting all ecobee API operations except those that are only accessible by EMS and Utility accounts

pyecobee/__init__.py

@@ -97,8 +97,7 @@
 from pyecobee.responses import EcobeeThermostatsSummaryResponse
 from pyecobee.responses import EcobeeTokensResponse
 from pyecobee.service import EcobeeService
-from pyecobee.utilities import dictionary_to_object
-from pyecobee.utilities import object_to_dictionary
+from pyecobee.utilities import Utilities
 
 try:  # Python 2.X
     from logging import NullHandler

pyecobee/ecobee_object.py

@@ -4,8 +4,19 @@
 class EcobeeObject(object):
     __slots__ = []
 
-    def slots(self):
-        return chain.from_iterable(getattr(cls, '__slots__', []) for cls in type(self).__mro__)
+    attribute_name_map = {}
+
+    attribute_type_map = {}
+
+    def __repr__(self):
+        return '{0}('.format(self.__class__.__name__) + ', '.join(
+            ['{0}={1!r}'.format(attribute_name[1:], getattr(self, attribute_name))
+             for attribute_name in self.slots()]) + ')'
+
+    def __str__(self):
+        return '{0}('.format(self.__class__.__name__) + ', '.join(
+            ['{0}={1!s}'.format(type(self).attribute_name_map[attribute_name[1:]], getattr(self, attribute_name))
+             for attribute_name in self.slots()]) + ')'
 
     def pretty_format(self, indent=2, level=0, sort_attributes=True):
         """
@@ -18,16 +29,20 @@ def pretty_format(self, indent=2, level=0, sort_attributes=True):
         """
         pretty_formatted = ['{0}(\n'.format(self.__class__.__name__)]
         level = level + 1
+
         for (i, attribute_name) in enumerate(sorted(self.slots()) if sort_attributes else self.slots()):
             if i:
                 pretty_formatted.append(',\n')
+
             if isinstance(getattr(self, attribute_name), list):
                 pretty_formatted.append('{0}{1}=[\n'.format(' ' * (indent * level),
                                                             self.attribute_name_map[attribute_name[1:]]))
                 level = level + 1
+
                 for (j, list_entry) in enumerate(getattr(self, attribute_name)):
                     if j:
                         pretty_formatted.append(',\n')
+
                     if hasattr(list_entry, 'pretty_format'):
                         pretty_formatted.append('{0}{1}'.format(' ' * (indent * level),
                                                                 list_entry.pretty_format(indent,
@@ -36,23 +51,31 @@ def pretty_format(self, indent=2, level=0, sort_attributes=True):
                     else:
                         if isinstance(list_entry, list):
                             pretty_formatted.append('{0}[\n'.format(' ' * (indent * level)))
+
                             level = level + 1
+
                             for (k, sub_list_entry) in enumerate(list_entry):
                                 if k:
                                     pretty_formatted.append(',\n')
+
                                 pretty_formatted.append('{0}{1}'.format(' ' * (indent * level), sub_list_entry))
+
                             if list_entry:
                                 pretty_formatted.append('\n')
+
                             level = level - 1
                             pretty_formatted.append('{0}]'.format(' ' * (indent * level)))
                         else:
                             pretty_formatted.append('{0}{1}'.format(' ' * (indent * level), list_entry))
+
                 if getattr(self, attribute_name):
                     pretty_formatted.append('\n')
+
                 level = level - 1
                 pretty_formatted.append('{0}]'.format(' ' * (indent * level)))
             else:
                 pretty_formatted.append(' ' * (indent * level))
+
                 if hasattr(getattr(self, attribute_name), 'pretty_format'):
                     pretty_formatted.append('{0}={1!s}'.format(self.attribute_name_map[attribute_name[1:]],
                                                                getattr(self, attribute_name).pretty_format(
@@ -62,16 +85,11 @@ def pretty_format(self, indent=2, level=0, sort_attributes=True):
                 else:
                     pretty_formatted.append('{0}={1!s}'.format(self.attribute_name_map[attribute_name[1:]],
                                                                getattr(self, attribute_name)))
+
         level = level - 1
         pretty_formatted.append('\n{0})'.format(' ' * (indent * level)))
-        return ''.join(pretty_formatted)
 
-    def __repr__(self):
-        return '{0}('.format(self.__class__.__name__) + ', '.join(
-            ['{0}={1!r}'.format(attribute_name[1:], getattr(self, attribute_name)) for attribute_name in
-             self.slots()]) + ')'
+        return ''.join(pretty_formatted)
 
-    def __str__(self):
-        return '{0}('.format(self.__class__.__name__) + ', '.join(
-            ['{0}={1!s}'.format(type(self).attribute_name_map[attribute_name[1:]], getattr(self, attribute_name)) for
-             attribute_name in self.slots()]) + ')'
+    def slots(self):
+        return chain.from_iterable(getattr(cls, '__slots__', []) for cls in type(self).__mro__)

pyecobee/exceptions.py

@@ -20,7 +20,8 @@ def status_message(self):
 
 
 class EcobeeAuthorizationException(EcobeeException):
-    attribute_type_map = {'error': 'six.text_type', 'error_description': 'six.text_type', 'error_uri': 'six.text_type'}
+    attribute_type_map = {'error': 'six.text_type', 'error_description': 'six.text_type',
+                          'error_uri': 'six.text_type'}
 
     def __init__(self, message, error, error_description, error_uri):
         super(EcobeeAuthorizationException, self).__init__(message)

pyecobee/responses.py

@@ -30,8 +30,8 @@ def status(self):
 class EcobeeAuthorizeResponse(EcobeeObject):
     __slots__ = ['_ecobee_pin', '_code', '_scope', '_expires_in', '_interval']
 
-    attribute_name_map = {'ecobee_pin': 'ecobeePin', 'ecobeePin': 'ecobee_pin', 'code': 'code', 'scope': 'scope',
-                          'expires_in': 'expires_in', 'interval': 'interval'}
+    attribute_name_map = {'ecobee_pin': 'ecobeePin', 'ecobeePin': 'ecobee_pin', 'code': 'code',
+                          'scope': 'scope', 'expires_in': 'expires_in', 'interval': 'interval'}
 
     attribute_type_map = {'ecobee_pin': 'six.text_type', 'code': 'six.text_type', 'scope': 'six.text_type',
                           'expires_in': 'int', 'interval': 'int'}
@@ -106,8 +106,8 @@ def interval(self):
 class EcobeeCreateRuntimeReportJobResponse(EcobeeStatusResponse):
     __slots__ = ['_job_id', '_job_status']
 
-    attribute_name_map = {'job_id': 'jobId', 'jobId': 'job_id', 'job_status': 'jobStatus', 'jobStatus': 'job_status',
-                          'status': 'status'}
+    attribute_name_map = {'job_id': 'jobId', 'jobId': 'job_id', 'job_status': 'jobStatus',
+                          'jobStatus': 'job_status', 'status': 'status'}
 
     attribute_type_map = {'job_id': 'six.text_type', 'job_status': 'six.text_type', 'status': 'Status'}
 
@@ -147,9 +147,11 @@ def job_status(self):
 class EcobeeErrorResponse(EcobeeObject):
     __slots__ = ['_error', '_error_description', '_error_uri']
 
-    attribute_name_map = {'error': 'error', 'error_description': 'error_description', 'error_uri': 'error_uri'}
+    attribute_name_map = {'error': 'error', 'error_description': 'error_description',
+                          'error_uri': 'error_uri'}
 
-    attribute_type_map = {'error': 'six.text_type', 'error_description': 'six.text_type', 'error_uri': 'six.text_type'}
+    attribute_type_map = {'error': 'six.text_type', 'error_description': 'six.text_type',
+                          'error_uri': 'six.text_type'}
 
     def __init__(self, error, error_description, error_uri):
         """
@@ -225,8 +227,8 @@ def groups(self):
 class EcobeeIssueDemandResponsesResponse(EcobeeStatusResponse):
     __slots__ = ['_demand_response_ref']
 
-    attribute_name_map = {'demand_response_ref': 'demandResponseRef', 'demandResponseRef': 'demand_response_ref',
-                          'status': 'status'}
+    attribute_name_map = {'demand_response_ref': 'demandResponseRef',
+                          'demandResponseRef': 'demand_response_ref', 'status': 'status'}
 
     attribute_type_map = {'demand_response_ref': 'six.text_type', 'status': 'Status'}
 
@@ -254,7 +256,8 @@ def demand_response_ref(self):
 class EcobeeListDemandResponsesResponse(EcobeeStatusResponse):
     __slots__ = ['_demand_response_list']
 
-    attribute_name_map = {'demand_response_list': 'drList', 'drList': 'demand_response_list', 'status': 'status'}
+    attribute_name_map = {'demand_response_list': 'drList', 'drList': 'demand_response_list',
+                          'status': 'status'}
 
     attribute_type_map = {'demand_response_list': 'List[DemandResponse]', 'status': 'Status'}
 
@@ -408,15 +411,17 @@ class EcobeeRuntimeReportsResponse(EcobeeStatusResponse):
     __slots__ = ['_start_date', '_start_interval', '_end_date', '_end_interval', '_columns', '_report_list',
                  '_sensor_list']
 
-    attribute_name_map = {'start_date': 'startDate', 'startDate': 'start_date', 'start_interval': 'startInterval',
-                          'startInterval': 'start_interval', 'end_date': 'endDate', 'endDate': 'end_date',
-                          'end_interval': 'endInterval', 'endInterval': 'end_interval', 'columns': 'columns',
-                          'report_list': 'reportList', 'reportList': 'report_list', 'sensor_list': 'sensorList',
+    attribute_name_map = {'start_date': 'startDate', 'startDate': 'start_date',
+                          'start_interval': 'startInterval', 'startInterval': 'start_interval',
+                          'end_date': 'endDate', 'endDate': 'end_date', 'end_interval': 'endInterval',
+                          'endInterval': 'end_interval', 'columns': 'columns', 'report_list': 'reportList',
+                          'reportList': 'report_list', 'sensor_list': 'sensorList',
                           'sensorList': 'sensor_list', 'status': 'status'}
 
     attribute_type_map = {'start_date': 'six.text_type', 'start_interval': 'int', 'end_date': 'six.text_type',
-                          'end_interval': 'int', 'columns': 'six.text_type', 'report_list': 'List[RuntimeReport]',
-                          'sensor_list': 'List[RuntimeSensorReport]', 'status': 'Status'}
+                          'end_interval': 'int', 'columns': 'six.text_type',
+                          'report_list': 'List[RuntimeReport]', 'sensor_list': 'List[RuntimeSensorReport]',
+                          'status': 'Status'}
 
     def __init__(self, start_date, start_interval, end_date, end_interval, columns, report_list, sensor_list, status):
         """
@@ -514,8 +519,8 @@ def sensor_list(self):
 class EcobeeThermostatResponse(EcobeeStatusResponse):
     __slots__ = ['_page', '_thermostat_list']
 
-    attribute_name_map = {'page': 'page', 'thermostat_list': 'thermostatList', 'thermostatList': 'thermostat_list',
-                          'status': 'status'}
+    attribute_name_map = {'page': 'page', 'thermostat_list': 'thermostatList',
+                          'thermostatList': 'thermostat_list', 'status': 'status'}
 
     attribute_type_map = {'page': 'Page', 'thermostat_list': 'List[Thermostat]', 'status': 'Status'}
 
@@ -611,8 +616,8 @@ def status_list(self):
 class EcobeeTokensResponse(EcobeeObject):
     __slots__ = ['_access_token', '_token_type', '_expires_in', '_refresh_token', '_scope']
 
-    attribute_name_map = {'access_token': 'access_token', 'token_type': 'token_type', 'expires_in': 'expires_in',
-                          'refresh_token': 'refresh_token', 'scope': 'scope'}
+    attribute_name_map = {'access_token': 'access_token', 'token_type': 'token_type',
+                          'expires_in': 'expires_in', 'refresh_token': 'refresh_token', 'scope': 'scope'}
 
     attribute_type_map = {'access_token': 'six.text_type', 'token_type': 'six.text_type', 'expires_in': 'int',
                           'refresh_token': 'six.text_type', 'scope': 'six.text_type'}