Update typing

Author: ivlevdenis

toggl_python/api.py

@@ -2,6 +2,7 @@
 
 import typing
 from functools import partial
+from typing import Any, Dict, Optional
 
 import httpx
 
@@ -21,13 +22,13 @@ class Api:
     def __init__(
         self,
         base_url: typing.Optional[str] = None,
-        auth: typing.Union[BasicAuth, TokenAuth] = None,
+        auth: Optional[typing.Union[BasicAuth, TokenAuth]] = None,
     ):
         if base_url:
             self.BASE_URL = httpx.URL(base_url)
         self.client = httpx.Client(base_url=self.BASE_URL, auth=auth)
 
-    def __getattr__(self, httpmethod):
+    def __getattr__(self, httpmethod: str) -> Any:
         try:
             method = getattr(self.client, httpmethod)
         except AttributeError:
@@ -37,12 +38,12 @@ def __getattr__(self, httpmethod):
 
     def api_method(
         self,
-        method: typing.Callable,
+        method: Any,
         url: str,
-        params: dict = None,
-        data: dict = None,
-        files: dict = None,
-    ) -> httpx.Response:
+        params: Optional[Dict[str, Any]] = None,
+        data: Optional[Dict[str, Any]] = None,
+        files: Optional[Dict[str, Any]] = None,
+    ) -> Any:
         """
         Call http method with specified url and params
         """

toggl_python/entities.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import Callable, List, Optional, Union
+from typing import Any, Callable, Dict, List, Optional, Union
 
 from pydantic import BaseModel, EmailStr, HttpUrl
 
@@ -31,7 +31,7 @@ class Project(BaseEntity):
     billable: bool = True
     auto_estimates: Optional[bool] = False
     estimated_hours: Optional[int] = None
-    color: Union[str, int] = None
+    color: Union[str, int] = 0
     rate: Optional[float] = None
     created_at: Optional[datetime] = None
 
@@ -66,8 +66,8 @@ class TimeEntry(BaseEntity):
     tid: Optional[int] = None
     description: Optional[str] = None
     billable: Optional[bool] = False
-    start: Union[datetime, Callable] = datetime.now
-    stop: Union[datetime, Callable] = None
+    start: Union[datetime, Callable[[], datetime]] = datetime.now
+    stop: Optional[Union[datetime, Callable[[], datetime]]] = None
     duration: int
     created_with: Optional[str]
     tags: List[str] = []
@@ -82,9 +82,9 @@ class ReportTimeEntry(BaseEntity):
     description: Optional[str] = None
     billable: Optional[int] = False
     is_billable: Optional[bool] = False
-    cur: Optional[str] = False
-    start: Union[datetime, Callable] = datetime.now
-    end: Union[datetime, Callable] = None
+    cur: Optional[Union[str, bool]] = False
+    start: Union[datetime, Callable[[], datetime]] = datetime.now
+    end: Optional[Union[datetime, Callable[[], datetime]]] = None
     dur: int
     tags: List[str] = []
 
@@ -103,7 +103,7 @@ class User(BaseEntity):
     language: str
     image_url: HttpUrl
     sidebar_piechart: bool
-    new_blog_post: dict
+    new_blog_post: Dict[str, Any]
     send_product_emails: bool
     send_weekly_report: bool
     send_timer_notifications: bool

toggl_python/repository.py

@@ -1,4 +1,5 @@
 from functools import partial
+from typing import Any, Dict, Optional, Tuple, Type, Union
 
 import httpx
 
@@ -10,72 +11,81 @@
     Group,
     Project,
     ProjectUser,
+    ReportTimeEntry,
     Tag,
     Task,
     TimeEntry,
     User,
     Workspace,
     WorkspaceUser,
-    ReportTimeEntry,
 )
 from .exceptions import MethodNotAllowed, NotSupported
-from .response import ReportTimeEntriesList
+from .response import ListResponse, ReportTimeEntriesList
+from .auth import BasicAuth, TokenAuth
 
 
 class BaseRepository(Api):
     LIST_URL = ""
-    DETAIL_URL = None
-    ENTITY_CLASS = BaseEntity
-    ADDITIONAL_METHODS = {}
-    EXCLUDED_METHODS = ()
-    ADDITIONAL_PARAMS = {}
-    DATA_CONTAINER = {}
-    LIST_RESPONSE = None
-
-    def __init__(self, base_url=None, auth=None):
+    DETAIL_URL: Optional[str] = None
+    ENTITY_CLASS: Type[BaseEntity] = BaseEntity
+    ADDITIONAL_METHODS: Dict[str, Dict[str, Any]] = {}
+    EXCLUDED_METHODS: Optional[Tuple[str, ...]] = None
+    ADDITIONAL_PARAMS: Dict[str, Dict[str, Any]] = {}
+    DATA_CONTAINER: Dict[str, Optional[str]] = {}
+    LIST_RESPONSE: Optional[Type[ListResponse]] = None
+
+    def __init__(
+        self,
+        base_url: Optional[str] = None,
+        auth: Optional[Union[BasicAuth, TokenAuth]] = None,
+    ) -> None:
         super().__init__(base_url=base_url, auth=auth)
         if not self.DETAIL_URL:
             self.DETAIL_URL = self.LIST_URL + "/{id}"
 
-    def __getattr__(self, method: str):
-        if method in self.EXCLUDED_METHODS:
+    def __getattr__(self, attr: str) -> Any:
+        if self.EXCLUDED_METHODS and attr in self.EXCLUDED_METHODS:
             raise MethodNotAllowed
         try:
-            method = super().__getattr__(method)
+            method = super().__getattr__(attr)
         except AttributeError:
-            if method in self.ADDITIONAL_METHODS.keys():
+            if attr in self.ADDITIONAL_METHODS.keys():
                 method = partial(
-                    self.additionat_method, **self.ADDITIONAL_METHODS[method]
+                    self.additionat_method, **self.ADDITIONAL_METHODS[attr]
                 )
             else:
-                raise AttributeError(f"No such method ({method})!")
+                raise AttributeError(f"No such method ({attr})!")
         return method
 
     def additionat_method(
         self,
         url: str,
-        _id: int = None,
-        additional_id: int = None,
-        entity: object = None,
+        _id: Optional[int] = None,
+        additional_id: Optional[int] = None,
+        entity: Any = None,
         detail: bool = False,
         single_item: bool = False,
-        data_key: str = None,
-        params: dict = None,
-        data: dict = None,
-        files: dict = None,
-    ) -> httpx.Response:
+        data_key: Optional[str] = None,
+        params: Optional[Dict[str, Any]] = None,
+        data: Optional[Dict[str, Any]] = None,
+        files: Optional[Dict[str, Any]] = None,
+    ) -> Any:
         """
         Call additional method with specified url and params
         """
 
         if detail:
+            if not self.DETAIL_URL:
+                raise AttributeError("Not defined DETAIL_URL")
             _url = (self.DETAIL_URL + "/" + url + "/{additional_id}").format(
                 id=_id, additional_id=additional_id
             )
             return self._retrieve(
                 _url, entity, headers=self.HEADERS, params=params
             )
         elif _id:
+            if not self.DETAIL_URL:
+                raise AttributeError("Not defined DETAIL_URL")
             _url = (self.DETAIL_URL + "/" + url).format(id=_id)
             return self._list(_url, entity, headers=self.HEADERS, param=params)
         elif single_item:
@@ -90,7 +100,13 @@ def additionat_method(
         else:
             raise NotSupported
 
-    def _retrieve(self, _url, entity_class, data_key: str = "data", **kwargs):
+    def _retrieve(
+        self,
+        _url: Union[str, httpx.URL],
+        entity_class: Any,
+        data_key: Optional[str] = "data",
+        **kwargs: Any,
+    ) -> Any:
         params = kwargs
         params.update(self.ADDITIONAL_PARAMS.get("retrieve", {}))
 
@@ -102,11 +118,19 @@ def _retrieve(self, _url, entity_class, data_key: str = "data", **kwargs):
         if data:
             return entity_class(**data)
 
-    def retrieve(self, id: int = None, **kwargs):
+    def retrieve(self, id: Optional[int] = None) -> Any:
+        if not self.DETAIL_URL:
+            raise AttributeError("Not defined DETAIL_URL")
         full_url = self.BASE_URL.join(self.DETAIL_URL.format(id=id))
         return self._retrieve(full_url, self.ENTITY_CLASS)
 
-    def _list(self, _url, entity_class, data_key: str = None, **kwargs):
+    def _list(
+        self,
+        _url: Union[str, httpx.URL],
+        entity_class: Any,
+        data_key: Optional[str] = None,
+        **kwargs: Any,
+    ) -> Any:
         params = kwargs
         params.update(self.ADDITIONAL_PARAMS.get("list", {}))
 
@@ -123,29 +147,33 @@ def _list(self, _url, entity_class, data_key: str = None, **kwargs):
                 value = self.LIST_RESPONSE(value, response_body)
             return value
 
-    def list(self, **kwargs):
-        if "list" in self.EXCLUDED_METHODS:
+    def list(self, **kwargs: Any) -> Any:
+        if self.EXCLUDED_METHODS and "list" in self.EXCLUDED_METHODS:
             raise MethodNotAllowed
         full_url = self.BASE_URL.join(self.LIST_URL)
         return self._list(full_url, self.ENTITY_CLASS, **kwargs)
 
-    def create(self, entity: ENTITY_CLASS, **kwargs):
-        if "create" in self.EXCLUDED_METHODS:
+    def create(self, entity: Any, **kwargs: Any) -> Any:
+        if self.EXCLUDED_METHODS and "create" in self.EXCLUDED_METHODS:
             raise MethodNotAllowed
         full_url = self.BASE_URL.join(self.LIST_URL)
         response = self.post(full_url, data=entity.dict(), **kwargs)
         return self.ENTITY_CLASS(**response.json())
 
-    def update(self, entity: ENTITY_CLASS, **kwargs):
-        if "update" in self.EXCLUDED_METHODS:
+    def update(self, entity: Any, **kwargs: Any) -> Any:
+        if self.EXCLUDED_METHODS and "update" in self.EXCLUDED_METHODS:
             raise MethodNotAllowed
+        if not self.DETAIL_URL:
+            raise AttributeError("Not defined DETAIL_URL")
         full_url = self.BASE_URL.join(self.DETAIL_URL.format(id=entity.id))
         response = self.put(full_url, data=entity.dict(), **kwargs)
         return self.ENTITY_CLASS(**response.json())
 
-    def partial_update(self, entity: ENTITY_CLASS, **kwargs):
-        if "partial_update" in self.EXCLUDED_METHODS:
+    def partial_update(self, entity: Any, **kwargs: Any) -> Any:
+        if self.EXCLUDED_METHODS and "partial_update" in self.EXCLUDED_METHODS:
             raise MethodNotAllowed
+        if not self.DETAIL_URL:
+            raise AttributeError("Not defined DETAIL_URL")
         full_url = self.BASE_URL.join(self.DETAIL_URL.format(id=entity.id))
         response = self.patch(full_url, data=entity.dict(), **kwargs)
         return self.ENTITY_CLASS(**response.json())

toggl_python/response.py

@@ -1,7 +1,10 @@
-class ListResponse(list):
-    response_parameters = ()
+from typing import Any, List, Tuple
 
-    def __init__(self, value, response_body):
+
+class ListResponse(List[Any]):
+    response_parameters: Tuple[str, ...] = ()
+
+    def __init__(self, value: Any, response_body: Any):
         super(ListResponse, self).__init__(value)
 
         for parameter in self.response_parameters: