Merge pull request #42 from GrandMoff100/dev

Post Version Fixes

Author: GrandMoff100

CHANGELOG.md

@@ -18,4 +18,8 @@
 **v2.4.0**
 - Bug fixes (see closed issues between releases)
 - Added a processing framework for hooking into mimetype processing
-- Fixed some issues with some ``AsyncClient`` methods
+- Fixed some issues with some ``AsyncClient`` methods
+
+**v2.4.0.post1**
+- Replaced `text/plain` with `application/octet-stream` in docs and processing module.
+- Added message content to UnrecognizedStatusCodeError to help with user debugging

docs/processing.rst

@@ -15,7 +15,7 @@ To register a response processor you need to import the Processing class and the
     from homeassistant_api.processing import process_json
 
 
-    @Processing.processor("text/plain", override=True)
+    @Processing.processor("application/octet-stream", override=True)
     def text_processor(response):
         return response.text.lower()
 
@@ -33,14 +33,17 @@ To register a response processor you need to import the Processing class and the
     client = Client(url, token)
     print(client.get_entities())
 
+
 In this example. 
 The first processor (a function wrapped with the processor decorator) is going to be called when we receive a response that has that as its :code:`Content-Type` header.
-Because :code:`homeassistant_api` provides processors for :code:`text/plain` and :code:`application/json` by default,
+Because :code:`homeassistant_api` provides processors for :code:`application/octet-stream` and :code:`application/json` by default,
 we need to tell :code:`homeassistant_api` to override the default processor with :code:`override=True`.
 
 The second processor is an async processor that only gets called when AsyncClient receives a response that has :code:`text/csv` as its :code:`Content-Type` header.
 If you wanted to override :code:`homeassistant_api`'s default json processing using the :code:`json` module with a different way to process json data.
 Such as using instead, the :code:`ujson` module (which is faster but more limiting).
 
 The third processor function implements the default processor function for the :code:`application/json` mimetype after printing a string.
-If you wanted to run some intermediate processing 
+If you wanted to run some intermediate processing.
+
+Most likely the only processors you will ever use are :code:`application/json` and :code:`application/octet-stream`

homeassistant_api/__init__.py

@@ -3,5 +3,5 @@
 from .processing import Processing
 
 
-__version__ = '2.4.0'
+__version__ = '2.4.0.post1'
 __name__ = 'Homeassistant API'

homeassistant_api/errors.py

@@ -31,8 +31,8 @@ class ParameterMissingError(HomeassistantAPIError):
 class UnexpectedStatusCodeError(HomeassistantAPIError):
     """Error raised when Homeassistant returns a response with status code that was unexpected."""
 
-    def __init__(self, code: int):
-        super().__init__(f"Homeassistant return response with an unrecognized status code {code!r}")
+    def __init__(self, code: int, content):
+        super().__init__(f"Homeassistant return response with an unrecognized status code {code!r}.\n{content}")
 
 
 class UnauthorizedError(HomeassistantAPIError):

homeassistant_api/processing.py

@@ -70,8 +70,7 @@ def process(self, _async=False):
             raise MethodNotAllowedError(self.response.request.method)
         else:
             print("If this happened, please report it at https://github.com/GrandMoff100/HomeAssistantAPI/issues with the request status code and the request content")
-            print(self.response.content)
-            raise UnexpectedStatusCodeError(self.response.status_code)
+            raise UnexpectedStatusCodeError(self.response.status_code, self.response.content)
 
 
 # List of default processors
@@ -87,7 +86,7 @@ def process_json(response):
         raise MalformedDataError(f'Homeassistant responded with non-json response: {repr(response.text)}')
 
 
-@Processing.processor("text/plain")
+@Processing.processor("application/octet-stream")
 def process_text(response):
     """Returns the plaintext of the reponse."""
     return response.text
@@ -105,7 +104,7 @@ async def async_process_json(response):
         raise MalformedDataError(f'Homeassistant responded with non-json response: {repr(await response.text())}')
 
 
-@Processing.async_processor("text/plain")
+@Processing.async_processor("application/octet-stream")
 async def async_process_text(response):
     """Returns the plaintext of the reponse."""
     return await response.text()