Merge pull request #201 from adamtheturtle/more-hints

Add type hints for various classes

Author: adamtheturtle

src/mock_vws/_mock_common.py

@@ -35,6 +35,10 @@ class Route:
     later.
     """
 
+    route_name: str
+    path_pattern: str
+    http_methods: List[str]
+
     def __init__(
         self,
         route_name: str,

src/mock_vws/database.py

@@ -14,6 +14,14 @@ class VuforiaDatabase:
     Credentials for VWS APIs.
     """
 
+    database_name: str
+    server_access_key: bytes
+    server_secret_key: bytes
+    client_access_key: bytes
+    client_secret_key: bytes
+    targets: List[Target]
+    state: States
+
     def __init__(
         self,
         server_access_key: Optional[str] = None,

src/mock_vws/target.py

@@ -21,6 +21,18 @@ class Target:  # pylint: disable=too-many-instance-attributes
     https://developer.vuforia.com/target-manager.
     """
 
+    name: str
+    target_id: str
+    active_flag: bool
+    width: float
+    upload_date: datetime.datetime
+    last_modified_date: datetime.datetime
+    processed_tracking_rating: int
+    image: io.BytesIO
+    reco_rating: str
+    application_metadata: str
+    delete_date: Optional[datetime.datetime]
+
     def __init__(  # pylint: disable=too-many-arguments
         self,
         name: str,
@@ -46,7 +58,7 @@ def __init__(  # pylint: disable=too-many-arguments
             name (str): The name of the target.
             target_id (str): The unique ID of the target.
             active_flag (bool): Whether or not the target is active for query.
-            width (int): The width of the image in scene unit.
+            width (float): The width of the image in scene unit.
             upload_date (datetime.datetime): The time that the target was
                 created.
             last_modified_date (datetime.datetime): The time that the target

tests/mock_vws/utils/__init__.py

@@ -29,6 +29,13 @@ class Endpoint:
     Details of endpoints to be called in tests.
     """
 
+    prepared_request: requests.PreparedRequest
+    successful_headers_result_code: ResultCodes
+    successful_headers_status_code: int
+    auth_header_content_type: str
+    access_key: bytes
+    secret_key: bytes
+
     def __init__(
         self,
         prepared_request: requests.PreparedRequest,