[DO NOT MERGE]: tmp: annotate exceptions

pyodata/client.py

@@ -18,11 +18,13 @@ def _fetch_metadata(connection, url, logger):
                  resp.content)
 
     if resp.status_code != 200:
+        # ANNOT_EX: fatal runtime communication initialization error on service side
         raise HttpError(
             'Metadata request failed, status code: {}, body:\n{}'.format(resp.status_code, resp.content), resp)
 
     mime_type = resp.headers['content-type']
     if not any((typ in ['application/xml', 'text/xml'] for typ in mime_type.split(';'))):
+        # ANNOT_EX: fatal runtime communication initialization error on service side
         raise HttpError(
             'Metadata request did not return XML, MIME type: {}, body:\n{}'.format(mime_type, resp.content),
             resp)
@@ -54,6 +56,7 @@ def __new__(cls, url, connection, odata_version=ODATA_VERSION_2, namespaces=None
                 logger.info('Using static metadata')
 
             if config is not None and namespaces is not None:
+                # ANNOT_EX: fatal invalid usage error
                 raise PyODataException('You cannot pass namespaces and config at the same time')
 
             if config is None:
@@ -73,4 +76,5 @@ def __new__(cls, url, connection, odata_version=ODATA_VERSION_2, namespaces=None
 
             return service
 
+        # ANNOT_EX: fatal runtime initialization error on pyodata side
         raise PyODataException('No implementation for selected odata version {}'.format(odata_version))

pyodata/exceptions.txt

@@ -0,0 +1,17 @@
+internal error:
+- unimplemented handlers
+- unimplemented if/else branch
+- type mismatch when resolving odata metadata references (
+
+service error:
+- invalid metadata
+-- unknown reference target (ValueHelper annotation, Assocition role, ...)
+-- redefinition of something
+-- malformed metadata (e.g. missing Navigation role XML nodes)
+- runtime
+-- malformed http responses
+-- malformed odata values
+
+programmer error:
+- request unknown type / property
+- assigns invalid data