chore: Use TypedDict for more precise **kwargs typing

noxfile.py

@@ -70,6 +70,7 @@ def mypy(session: Session) -> None:
     session.install(
         "mypy",
         "pytest",
+        "sphinx",
         "types-docutils",
         "types-requests",
     )

pyproject.toml

@@ -36,6 +36,7 @@ omit = [
 show_missing = true
 
 [tool.mypy]
+enable_incomplete_feature = "Unpack"
 warn_unreachable = true
 warn_unused_configs = true
 warn_unused_ignores = true
@@ -85,7 +86,7 @@ version = "0.5.0"
 importlib_metadata = {version = ">=1.6", python = "<3.8"}
 python = "^3.7.0"
 requests = "^2.23.0"
-typing-extensions = {version = "^4.4.0", python = "<3.8"}
+typing-extensions = {version = "^4.4.0", python = "<3.12"}
 
 # Docs
 furo = {version = "^2022.12.7", optional = true}

src/citric/client.py

@@ -21,6 +21,8 @@
     from types import TracebackType
     from typing import Any, BinaryIO, Generator, Iterable, Mapping, Sequence
 
+    from typing_extensions import Unpack
+
     from citric import types
 
     if sys.version_info >= (3, 8):
@@ -1231,7 +1233,11 @@ def list_survey_groups(
         """
         return self.__session.list_survey_groups(username)
 
-    def set_group_properties(self, group_id: int, **properties: Any) -> dict[str, bool]:
+    def set_group_properties(
+        self,
+        group_id: int,
+        **properties: Unpack[types.GroupProperties],
+    ) -> dict[str, bool]:
         """Set properties of a group.
 
         Args:
@@ -1247,7 +1253,7 @@ def set_language_properties(
         self,
         survey_id: int,
         language: str | None = None,
-        **properties: Any,
+        **properties: Unpack[types.LanguageProperties],
     ) -> dict[str, Any]:
         """Set properties of a survey language.
 
@@ -1288,7 +1294,7 @@ def set_question_properties(
         self,
         question_id: int,
         language: str | None = None,
-        **properties: Any,
+        **properties: Unpack[types.QuestionProperties],
     ) -> dict[str, bool]:
         """Set properties of a question.
 
@@ -1305,7 +1311,7 @@ def set_question_properties(
     def set_quota_properties(
         self,
         quota_id: int,
-        **properties: Any,
+        **properties: Unpack[types.QuotaProperties],
     ) -> types.SetQuotaPropertiesResult:
         """Set properties of a quota.
 
@@ -1325,7 +1331,7 @@ def set_quota_properties(
     def set_survey_properties(
         self,
         survey_id: int,
-        **properties: Any,
+        **properties: Unpack[types.SurveyProperties],
     ) -> dict[str, bool]:
         """Set properties of a survey.
 

src/citric/types.py

@@ -37,7 +37,7 @@ class FileUploadResult(TypedDict):
     msg: str
 
 
-class GroupProperties(TypedDict):
+class GroupProperties(TypedDict, total=False):
     """Group properties.
 
     Keys:
@@ -59,7 +59,7 @@ class GroupProperties(TypedDict):
     description: str
 
 
-class LanguageProperties(TypedDict):
+class LanguageProperties(TypedDict, total=False):
     """Language properties.
 
     Keys:
@@ -197,7 +197,7 @@ class QuestionsListElement(TypedDict):
     same_script: int
 
 
-class QuestionProperties(TypedDict):
+class QuestionProperties(TypedDict, total=False):
     """Question properties result.
 
     Keys:
@@ -278,7 +278,7 @@ class QuotaListElement(TypedDict):
     autoload_url: int
 
 
-class QuotaProperties(TypedDict):
+class QuotaProperties(TypedDict, total=False):
     """Quota properties result.
 
     Keys:
@@ -326,7 +326,7 @@ class SetQuotaPropertiesResult(TypedDict):
     message: QuotaProperties
 
 
-class SurveyProperties(TypedDict):
+class SurveyProperties(TypedDict, total=False):
     """Survey properties result.
 
     Keys:

tests/test_client.py

@@ -20,6 +20,7 @@
 
     from _pytest._py.path import LocalPath
 
+    from citric import types
 
 NEW_SURVEY_NAME = "New Survey"
 
@@ -493,7 +494,7 @@ def test_download_files(client: MockClient, tmp_path: Path):
 
 def test_set_group_properties(client: MockClient):
     """Test set_group_properties client method."""
-    props = {"name": "foo"}
+    props: types.GroupProperties = {"group_name": "foo"}
     assert client.set_group_properties(
         1,
         **props,
@@ -502,7 +503,7 @@ def test_set_group_properties(client: MockClient):
 
 def test_set_language_properties(client: MockClient):
     """Test set_language_properties client method."""
-    props = {"name": "foo"}
+    props: types.LanguageProperties = {"surveyls_title": "foo"}
     assert client.set_language_properties(
         1,
         language="en",
@@ -522,7 +523,7 @@ def test_set_participant_properties(client: MockClient):
 
 def test_set_question_properties(client: MockClient):
     """Test set_question_properties client method."""
-    props = {"title": "foo", "question": "bar", "type": "text"}
+    props: types.QuestionProperties = {"title": "foo", "mandatory": "Y", "type": "text"}
     assert client.set_question_properties(
         1,
         language="en",
@@ -532,7 +533,7 @@ def test_set_question_properties(client: MockClient):
 
 def test_set_quota_properties(client: MockClient):
     """Test set_quota_properties client method."""
-    props = {"name": "foo", "quota": "bar", "action": "baz"}
+    props: types.QuotaProperties = {"name": "foo", "qlimit": 150, "action": 1}
     assert client.set_quota_properties(
         1,
         **props,
@@ -541,7 +542,11 @@ def test_set_quota_properties(client: MockClient):
 
 def test_set_survey_properties(client: MockClient):
     """Test set_survey_properties client method."""
-    props = {"title": "foo", "welcome": "bar", "end": "baz"}
+    props: types.SurveyProperties = {
+        "allowsave": "Y",
+        "ipanonymize": "Y",
+        "emailnotificationto": "[email protected]",
+    }
     assert client.set_survey_properties(
         1,
         **props,