refactor: Use __all__ to expose public API (#935)

edgarrmondragon · Aug 17, 2023 · c3c7251 · c3c7251
1 parent f49d41e
commit c3c7251
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 0 deletions.
diff --git a/.changes/unreleased/Refactored-20230815-200414.yaml b/.changes/unreleased/Refactored-20230815-200414.yaml
@@ -0,0 +1,5 @@
+kind: Refactored
+body: Use `__all__` to expose public API
+time: 2023-08-15T20:04:14.027511-06:00
+custom:
+  Issue: "935"
diff --git a/src/citric/client.py b/src/citric/client.py
@@ -29,6 +29,13 @@
     else:
         from typing_extensions import Self, Unpack
 
+__all__ = [
+    "QuestionReference",
+    "FileMetadata",
+    "UploadedFile",
+    "Client",
+]
+
 EMAILS_SENT_STATUS_PATTERN = re.compile(r"(-?\d+) left to send")
 
 

diff --git a/src/citric/enums.py b/src/citric/enums.py
@@ -4,6 +4,21 @@
 
 import enum
 
+__all__ = [
+    "StringEnum",
+    "ImportGroupType",
+    "ImportSurveyType",
+    "NewSurveyType",
+    "StatisticsExportFormat",
+    "ResponsesExportFormat",
+    "SurveyCompletionStatus",
+    "HeadingType",
+    "ResponseType",
+    "TimelineAggregationPeriod",
+    "QuotaAction",
+    "EmailSendStrategy",
+]
+
 
 class StringEnum(str, enum.Enum):
     """Enum with string values."""

diff --git a/src/citric/method.py b/src/citric/method.py
@@ -4,6 +4,8 @@
 
 import typing as t
 
+__all__ = ["Method"]
+
 T = t.TypeVar("T")
 
 

diff --git a/src/citric/types.py b/src/citric/types.py
@@ -14,6 +14,22 @@
 
     from citric import enums
 
+__all__ = [
+    "Result",
+    "FileUploadResult",
+    "GroupProperties",
+    "LanguageProperties",
+    "OperationStatus",
+    "QuestionsListElement",
+    "QuestionProperties",
+    "QuotaListElement",
+    "QuotaProperties",
+    "RPCResponse",
+    "SetQuotaPropertiesResult",
+    "SurveyProperties",
+    "CPDBParticipantImportResult",
+]
+
 Result: TypeAlias = t.Any
 YesNo: TypeAlias = t.Literal["Y", "N"]