tesla-fleet-api 0.0.1__py3-none-any.whl → 0.0.4__py3-none-any.whl

tesla_fleet_api/exceptions.py

@@ -1,218 +1,276 @@
 import aiohttp
-import json
 from .const import Errors
 
 
-class TeslaFleetError:
+class TeslaFleetError(BaseException):
     """Base class for all Tesla exceptions."""
 
-    class Base(BaseException):
-        message: str
-        status: int
-        error: str | None
-        error_description: str | None
+    message: str
+    status: int
+    error: str | None
+    error_description: str | None
 
-        def __init__(self, status: int, data: dict[str, str] | None = None):
-            self.status = status
+    def __init__(self, data: dict[str, str] | None = None):
+        if data:
+            self.status = data.get("status", self.status)
             self.error = data.get("error") or data.get("message")
             self.error_description = data.get("error_description")
 
-    class InvalidCommand(Base):
-        """The data request or command is unknown."""
 
-        message = "The data request or command is unknown."
+class InvalidCommand(TeslaFleetError):
+    """The data request or command is unknown."""
 
-    class InvalidField(Base):
-        """A field in the input is not valid."""
+    message = "The data request or command is unknown."
+    status = 400
 
-        message = "A field in the input is not valid."
 
-    class InvalidRequest(Base):
-        """The request body is not valid, a description giving a more specific error message may be returned."""
+class InvalidField(TeslaFleetError):
+    """A field in the input is not valid."""
 
-        message = "The request body is not valid"
+    message = "A field in the input is not valid."
+    status = 400
 
-    class InvalidAuthCode(Base):
-        """The "code" in request body is invalid, generate a new one and try again."""
 
-        message = (
-            "The 'code' in request body is invalid, generate a new one and try again."
-        )
+class InvalidRequest(TeslaFleetError):
+    """The request body is not valid, a description giving a more specific error message may be returned."""
 
-    class InvalidRedirectUrl(Base):
-        """Invalid redirect URI/URL. The authorize redirect URI and token redirect URI must match."""
+    message = "The request body is not valid"
+    status = 400
 
-        message = "Invalid redirect URI/URL. The authorize redirect URI and token redirect URI must match."
 
-    class UnauthorizedClient(Base):
-        """We don't recognize this client_id and client_secret combination. Use the client_id and client_secret that has been granted for the application."""
+class InvalidAuthCode(TeslaFleetError):
+    """The "code" in request body is invalid, generate a new one and try again."""
 
-        message = "We don't recognize this client_id and client_secret combination. Use the client_id and client_secret that has been granted for the application."
+    message = "The 'code' in request body is invalid, generate a new one and try again."
+    status = 400
 
-    class MobileAccessDisabled(Base):
-        """The vehicle has turned off remote access."""
 
-        message = "The vehicle has turned off remote access."
+class InvalidRedirectUrl(TeslaFleetError):
+    """Invalid redirect URI/URL. The authorize redirect URI and token redirect URI must match."""
 
-    class NoResponseBody(Base):
-        """The OAuth token has expired."""
+    message = "Invalid redirect URI/URL. The authorize redirect URI and token redirect URI must match."
+    status = 400
 
-        message = "The OAuth token has expired."
 
-    class PaymentRequired(Base):
-        """Payment is required in order to use the API (non-free account only)."""
+class UnauthorizedClient(TeslaFleetError):
+    """We don't recognize this client_id and client_secret combination. Use the client_id and client_secret that has been granted for the application."""
 
-        message = "Payment is required in order to use the API (non-free account only)."
+    message = "We don't recognize this client_id and client_secret combination. Use the client_id and client_secret that has been granted for the application."
+    status = 400
 
-    class Forbidden(Base):
-        """Access to this resource is not authorized, developers should check required scopes."""
 
-        message = "Access to this resource is not authorized, developers should check required scopes."
+class MobileAccessDisabled(TeslaFleetError):
+    """The vehicle has turned off remote access."""
 
-    class NotFound(Base):
-        """The requested resource does not exist."""
+    message = "The vehicle has turned off remote access."
+    status = 401
 
-        message = "The requested resource does not exist."
 
-    class NotAllowed(Base):
-        """The operation is not allowed."""
+class OAuthExpired(TeslaFleetError):
+    """The OAuth token has expired."""
 
-        message = "The operation is not allowed."
+    message = "The OAuth token has expired."
+    status = 401
 
-    class NotAcceptable(Base):
-        """The HTTP request does not have a Content-Type header set to application/json."""
 
-        message = "The HTTP request does not have a Content-Type header set to application/json."
+class PaymentRequired(TeslaFleetError):
+    """Payment is required in order to use the API (non-free account only)."""
 
-    class VehicleOffline(Base):
-        """The vehicle is not "online."""
+    message = "Payment is required in order to use the API (non-free account only)."
+    status = 402
 
-        message = "The vehicle is not 'online'."
 
-    class PreconditionFailed(Base):
-        """A condition has not been met to process the request."""
+class Forbidden(TeslaFleetError):
+    """Access to this resource is not authorized, developers should check required scopes."""
 
-        message = "A condition has not been met to process the request."
+    message = "Access to this resource is not authorized, developers should check required scopes."
+    status = 403
 
-    class InvalidRegion(Base):
-        """This user is not present in the current region."""
 
-        message = "This user is not present in the current region."
+class NotFound(TeslaFleetError):
+    """The requested resource does not exist."""
 
-    class InvalidResource(Base):
-        """There is a semantic problem with the data, e.g. missing or invalid data."""
+    message = "The requested resource does not exist."
+    status = 404
 
-        message = (
-            "There is a semantic problem with the data, e.g. missing or invalid data."
-        )
 
-    class Locked(Base):
-        """Account is locked, and must be unlocked by Tesla."""
+class NotAllowed(TeslaFleetError):
+    """The operation is not allowed."""
 
-        message = "Account is locked, and must be unlocked by Tesla."
+    message = "The operation is not allowed."
+    status = 405
 
-    class RateLimited(Base):
-        """Account or server is rate limited."""
 
-        message = "Account or server is rate limited."
+class NotAcceptable(TeslaFleetError):
+    """The HTTP request does not have a Content-Type header set to application/json."""
 
-    class ResourceUnavailableForLegalReasons(Base):
-        """Querying for a user/vehicle without proper privacy settings."""
+    message = (
+        "The HTTP request does not have a Content-Type header set to application/json."
+    )
+    status = 406
 
-        message = "Querying for a user/vehicle without proper privacy settings."
 
-    class ClientClosedRequest(Base):
-        """Client has closed the request before the server could send a response."""
+class VehicleOffline(TeslaFleetError):
+    """The vehicle is not "online."""
 
-        message = (
-            "Client has closed the request before the server could send a response."
-        )
+    message = "The vehicle is not 'online'."
+    status = 408
 
-    class InternalServerError(Base):
-        """An error occurred while processing the request."""
 
-        message = "An error occurred while processing the request."
+class PreconditionFailed(TeslaFleetError):
+    """A condition has not been met to process the request."""
 
-    class ServiceUnavailable(Base):
-        """Either an internal service or a vehicle did not respond (timeout)."""
+    message = "A condition has not been met to process the request."
+    status = 412
 
-        message = "Either an internal service or a vehicle did not respond (timeout)."
 
-    class GatewayTimeout(Base):
-        """Server did not receive a response."""
+class InvalidRegion(TeslaFleetError):
+    """This user is not present in the current region."""
 
-        message = "Server did not receive a response."
+    message = "This user is not present in the current region."
+    status = 421
 
-    class DeviceUnexpectedResponse(Base):
-        """Vehicle responded with an error - might need a reboot, OTA update, or service."""
 
-        message = "Vehicle responded with an error - might need a reboot, OTA update, or service."
+class InvalidResource(TeslaFleetError):
+    """There is a semantic problem with the data, e.g. missing or invalid data."""
+
+    message = "There is a semantic problem with the data, e.g. missing or invalid data."
+    status = 422
+
+
+class Locked(TeslaFleetError):
+    """Account is locked, and must be unlocked by Tesla."""
+
+    message = "Account is locked, and must be unlocked by Tesla."
+    status = 423
+
+
+class RateLimited(TeslaFleetError):
+    """Account or server is rate limited."""
+
+    message = "Account or server is rate limited."
+    status = 429
+
+
+class ResourceUnavailableForLegalReasons(TeslaFleetError):
+    """Querying for a user/vehicle without proper privacy settings."""
+
+    message = "Querying for a user/vehicle without proper privacy settings."
+    status = 451
+
+
+class ClientClosedRequest(TeslaFleetError):
+    """Client has closed the request before the server could send a response."""
+
+    message = "Client has closed the request before the server could send a response."
+    status = 499
+
+
+class InternalServerError(TeslaFleetError):
+    """An error occurred while processing the request."""
+
+    message = "An error occurred while processing the request."
+    status = 500
+
+
+class ServiceUnavailable(TeslaFleetError):
+    """Either an internal service or a vehicle did not respond (timeout)."""
+
+    message = "Either an internal service or a vehicle did not respond (timeout)."
+    status = 503
+
+
+class GatewayTimeout(TeslaFleetError):
+    """Server did not receive a response."""
+
+    message = "Server did not receive a response."
+    status = 504
+
+
+class DeviceUnexpectedResponse(TeslaFleetError):
+    """Vehicle responded with an error - might need a reboot, OTA update, or service."""
+
+    message = (
+        "Vehicle responded with an error - might need a reboot, OTA update, or service."
+    )
+    status = 540
+
+
+class InvalidToken(TeslaFleetError):  # Teslemetry specific
+    """Teslemetry specific error for invalid access token."""
+
+    message = "Invalid Teslemetry access token."
+    status = 401
+
+
+class LibraryError(Exception):
+    """Errors related to this library."""
 
 
 async def raise_for_status(resp: aiohttp.ClientResponse) -> None:
     """Raise an exception if the response status code is >=400."""
     # https://developer.tesla.com/docs/fleet-api#response-codes
 
-    try:
-        data = await resp.json()
-    except json.decoder.JSONDecodeError as error:
-        raise TeslaFleetError.NotFound() from error
+    if e.status == 401 and resp.content_length == 0:
+        # This error does not return a body
+        raise OAuthExpired() from e
+
+    data = await resp.json()
+
     try:
         resp.raise_for_status()
     except aiohttp.ClientResponseError as e:
         if e.status == 400:
             if data.error == Errors.INVALID_COMMAND:
-                raise TeslaFleetError.InvalidCommand(e.status, data) from e
+                raise InvalidCommand(data) from e
             elif data.error == Errors.INVALID_FIELD:
-                raise TeslaFleetError.InvalidField(e.status, data) from e
+                raise InvalidField(data) from e
             elif data.error == Errors.INVALID_REQUEST:
-                raise TeslaFleetError.InvalidRequest(e.status, data) from e
+                raise InvalidRequest(data) from e
             elif data.error == Errors.INVALID_AUTH_CODE:
-                raise TeslaFleetError.InvalidAuthCode(e.status, data) from e
+                raise InvalidAuthCode(data) from e
             elif data.error == Errors.INVALID_REDIRECT_URL:
-                raise TeslaFleetError.InvalidRedirectUrl(e.status, data) from e
+                raise InvalidRedirectUrl(data) from e
             elif data.error == Errors.UNAUTHORIZED_CLIENT:
-                raise TeslaFleetError.UnauthorizedClient(e.status, data) from e
+                raise UnauthorizedClient(data) from e
         elif e.status == 401:
             if data.error == Errors.MOBILE_ACCESS_DISABLED:
-                raise TeslaFleetError.MobileAccessDisabled(e.status, data) from e
-            elif data.error == Errors.NO_RESPONSE_BODY:
-                raise TeslaFleetError.NoResponseBody(e.status, data) from e
+                raise MobileAccessDisabled(data) from e
+            elif data.error == Errors.INVALID_TOKEN:
+                raise InvalidToken(data) from e
         elif e.status == 402:
-            raise TeslaFleetError.PaymentRequired(e.status, data) from e
+            raise PaymentRequired(data) from e
         elif e.status == 403:
-            raise TeslaFleetError.Forbidden(e.status, data) from e
+            raise Forbidden(data) from e
         elif e.status == 404:
-            raise TeslaFleetError.NotFound(e.status, data) from e
+            raise NotFound(data) from e
         elif e.status == 405:
-            raise TeslaFleetError.NotAllowed(e.status, data) from e
+            raise NotAllowed(data) from e
         elif e.status == 406:
-            raise TeslaFleetError.NotAcceptable(e.status, data) from e
+            raise NotAcceptable(data) from e
         elif e.status == 408:
-            raise TeslaFleetError.VehicleOffline(e.status, data) from e
+            raise VehicleOffline(data) from e
         elif e.status == 412:
-            raise TeslaFleetError.PreconditionFailed(e.status, data) from e
+            raise PreconditionFailed(data) from e
         elif e.status == 421:
-            raise TeslaFleetError.InvalidRegion(e.status, data) from e
+            raise InvalidRegion(data) from e
         elif e.status == 422:
-            raise TeslaFleetError.InvalidResource(e.status, data) from e
+            raise InvalidResource(data) from e
         elif e.status == 423:
-            raise TeslaFleetError.Locked(e.status, data) from e
+            raise Locked(data) from e
         elif e.status == 429:
-            raise TeslaFleetError.RateLimited(e.status, data) from e
+            raise RateLimited(data) from e
         elif e.status == 451:
-            raise TeslaFleetError.ResourceUnavailableForLegalReasons(
-                e.status, data
-            ) from e
+            raise ResourceUnavailableForLegalReasons(data) from e
         elif e.status == 499:
-            raise TeslaFleetError.ClientClosedRequest(e.status, data) from e
+            raise ClientClosedRequest(data) from e
         elif e.status == 500:
-            raise TeslaFleetError.InternalServerError(e.status, data) from e
+            raise InternalServerError(data) from e
         elif e.status == 503:
-            raise TeslaFleetError.ServiceUnavailable(e.status, data) from e
+            raise ServiceUnavailable(data) from e
         elif e.status == 504:
-            raise TeslaFleetError.GatewayTimeout(e.status, data) from e
+            raise GatewayTimeout(data) from e
         elif e.status == 540:
-            raise TeslaFleetError.DeviceUnexpectedResponse(e.status, data) from e
+            raise DeviceUnexpectedResponse(data) from e
         else:
             raise e

{tesla_fleet_api-0.0.1.dist-info → tesla_fleet_api-0.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tesla_fleet_api
-Version: 0.0.1
+Version: 0.0.4
 Summary: Tesla Fleet API library for Python
 Home-page: https://github.com/Teslemetry/tesla_fleet_api
 Author: Brett Adams
@@ -15,12 +15,16 @@ License-File: LICENSE
 Requires-Dist: aiohttp
 
 # tesla_fleet_api
-Python library for Tesla Fleet API and Teslemetry
+Python library for Tesla Fleet API and Teslemetry.
 
-Currently does not support the End to End encrypted Telemetry or Command API.
+Currently does not support the end to end encrypted telemetry or command API.
 
 Based on [Tesla Developer documentation](https://developer.tesla.com/docs/fleet-api).
 
+
+## TeslaFleetApi
+This is the base class, however can also be used directly if you have a valid user access_token.
+
 ```
 import asyncio
 import aiohttp
@@ -45,3 +49,33 @@ async def main():
 
 asyncio.run(main())
 ```
+
+## TeslaFleetOAuth
+This extends TeslaFleetApi to support OAuth, and requires a client_id, and either a refresh_token or initial authentication code.
+
+## Teslemetry
+This extends TeslaFleetApi to send requests through Teslemetry, which manages all aspects of Tesla OAuth. This class only requires an access_token from the Teslemetry console.
+
+```
+import asyncio
+import aiohttp
+
+from tesla_fleet_api import Teslemetry, TeslaFleetError
+
+
+async def main():
+    async with aiohttp.ClientSession() as session:
+        api = Teslemetry(
+            access_token="<access_token>",
+            session=session,
+            raise_for_status=True,
+        )
+
+        try:
+            data = await api.vehicle.list()
+            print(data)
+        except TeslaFleetError.Base as e:
+            print(e.message, e.error)
+
+asyncio.run(main())
+```

tesla_fleet_api-0.0.4.dist-info/RECORD

@@ -0,0 +1,11 @@
+tesla_fleet_api/TeslaFleetApi.py,sha256=khQJxemvcrPSjIdt1_SCpaQEbdHB-dBcABkOUFcvtJ4,68779
+tesla_fleet_api/TeslaFleetOAuth.py,sha256=ra14xPhlaUc71T9fiEH3g8P2PzUnVHSG9cMe8jMhil8,1982
+tesla_fleet_api/Teslemetry.py,sha256=izjIwzLNbsl9INc5LdtoIVvCbBolmScLTGSttzU1_CA,1491
+tesla_fleet_api/__init__.py,sha256=HvYW6aikklbgaa6n0gB49ZXcWV0c7tyqW-fvIk86qtE,121
+tesla_fleet_api/const.py,sha256=pJMdikCcERfdSt6nh6KiDcV5op1XfyaOv7qKAWE7fO4,8592
+tesla_fleet_api/exceptions.py,sha256=uAfITaX4D2K1PgozTHOStjZfcksmNvxKf5YRLWkiZDU,8588
+tesla_fleet_api-0.0.4.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+tesla_fleet_api-0.0.4.dist-info/METADATA,sha256=X4C43gQsM8DGZ_h6J_n4tVPjyEcIcgDEYYF4YV7vP10,2235
+tesla_fleet_api-0.0.4.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+tesla_fleet_api-0.0.4.dist-info/top_level.txt,sha256=jeNbog_1saXBFrGpom9WyPWmilxsyP3szL_G7JLWQfM,16
+tesla_fleet_api-0.0.4.dist-info/RECORD,,

tesla_fleet_api-0.0.1.dist-info/RECORD

@@ -1,11 +0,0 @@
-tesla_fleet_api/TeslaFleetApi.py,sha256=gzS7XdhUs2GJtWp0BwH-r-wdiovnPnXsu3PH6FYseIQ,45391
-tesla_fleet_api/TeslaFleetOAuth.py,sha256=AHzuKlrywD9Hf_nj4_1WcQCIaoxiI4JuD7XAv8dV6tU,469
-tesla_fleet_api/Teslemetry.py,sha256=66IorPsqvpZ8Uk1bgj_vkoWNLi9kb5HHnNag_iNoBD8,668
-tesla_fleet_api/__init__.py,sha256=HFzNi2gaIAOSUwE2vO5TgZZAqol47zyhuNOoPXidbVQ,161
-tesla_fleet_api/const.py,sha256=FohVnzQhy_onvN1qkEVvHsx1ox9BvBsedRxDjaO9WRs,663
-tesla_fleet_api/exceptions.py,sha256=y-uWOCgZx-BqZHtMGUV5560xNmu9YTNTmXgqK45egcM,8623
-tesla_fleet_api-0.0.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-tesla_fleet_api-0.0.1.dist-info/METADATA,sha256=zM87ZTGmciNaEg72yqF8XLyY52iSuLOdQDS_CKCUfsY,1284
-tesla_fleet_api-0.0.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-tesla_fleet_api-0.0.1.dist-info/top_level.txt,sha256=jeNbog_1saXBFrGpom9WyPWmilxsyP3szL_G7JLWQfM,16
-tesla_fleet_api-0.0.1.dist-info/RECORD,,