🐛 fix naming of job ID property

Author: ianardee

.pylintrc

@@ -419,7 +419,7 @@ attr-naming-style=snake_case
 # Regular expression matching correct attribute names. Overrides attr-naming-
 # style. If left empty, attribute names will be checked with the set naming
 # style.
-#attr-rgx=
+attr-rgx=[a-z_][a-z0-9_]{1,30}$
 
 # Bad variable names which should always be refused, separated by a comma.
 bad-names=foo,
@@ -489,7 +489,7 @@ good-names=i,
 good-names-rgxs=
 
 # Include a hint for the correct naming format with invalid-name.
-include-naming-hint=no
+include-naming-hint=yes
 
 # Naming style matching correct inline iteration names.
 inlinevar-naming-style=any

mindee/response.py

@@ -37,7 +37,7 @@ class Job:
     Will hold information on the queue a document has been submitted to.
     """
 
-    job_id: Optional[str] = None
+    id: Optional[str] = None
     """ID of the job sent by the API in response to an enqueue request."""
     issued_at: datetime
     """Timestamp of the request reception by the API."""
@@ -57,7 +57,7 @@ def __init__(self, json_response: dict) -> None:
         self.issued_at = datetime.fromisoformat(json_response["issued_at"])
         if json_response.get("available_at"):
             self.available_at = datetime.fromisoformat(json_response["available_at"])
-        self.job_id = json_response.get("id")
+        self.id = json_response.get("id")
         self.status = json_response.get("status")
         if self.available_at:
             self.millisecs_taken = int(

tests/api/test_async_response.py

@@ -56,7 +56,7 @@ def test_async_response_post_success(dummy_file_input, dummy_config):
     )
     assert parsed_response.job.available_at is None
     assert parsed_response.job.status == "waiting"
-    assert parsed_response.job.job_id == "76c90710-3a1b-4b91-8a39-31a6543e347c"
+    assert parsed_response.job.id == "76c90710-3a1b-4b91-8a39-31a6543e347c"
     assert not parsed_response.api_request.error
 
 
@@ -72,7 +72,7 @@ def test_async_response_post_fail(dummy_file_input, dummy_config):
     assert parsed_response.job.issued_at.isoformat() == "2023-01-01T00:00:00+00:00"
     assert parsed_response.job.available_at is None
     assert parsed_response.job.status is None
-    assert parsed_response.job.job_id is None
+    assert parsed_response.job.id is None
     assert parsed_response.api_request.error
     assert parsed_response.api_request.error["code"] == "Forbidden"
 
@@ -89,7 +89,7 @@ def test_async_get_processing(dummy_file_input, dummy_config):
     assert parsed_response.job.issued_at.isoformat() == "2023-03-16T12:33:49.602947"
     assert parsed_response.job.available_at is None
     assert parsed_response.job.status == "processing"
-    assert parsed_response.job.job_id == "76c90710-3a1b-4b91-8a39-31a6543e347c"
+    assert parsed_response.job.id == "76c90710-3a1b-4b91-8a39-31a6543e347c"
     assert not parsed_response.api_request.error