docs: add __all__ variables to some modules

c0d33ngr · Jul 7, 2024 · 43e5357 · 43e5357
1 parent 6d0596d
commit 43e5357
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 0 deletions.
diff --git a/src/icalendar/cal.py b/src/icalendar/cal.py
@@ -764,3 +764,8 @@ def example(cls, name) -> Calendar:
 # These are read only singleton, so one instance is enough for the module
 types_factory = TypesFactory()
 component_factory = ComponentFactory()
+
+__all__ = ["Alarm", "Calendar", "Component", "ComponentFactory", "Event",
+           "FreeBusy", "INLINE", "Journal", "Timezone", "TimezoneDaylight",
+           "TimezoneStandard", "Todo", "component_factory", "dateutil",
+           "types_factory"]
diff --git a/src/icalendar/caselessdict.py b/src/icalendar/caselessdict.py
@@ -106,3 +106,6 @@ def sorted_items(self):
         Items not specified in canonical_order will appear at the end.
         """
         return canonsort_items(self, self.canonical_order)
+
+
+__all__ = ["canonsort_keys", "canonsort_items", "CaselessDict"]
diff --git a/src/icalendar/parser.py b/src/icalendar/parser.py
@@ -384,3 +384,11 @@ def from_ical(cls, st):
 
 # XXX: what kind of hack is this? import depends to be at end
 from icalendar.prop import vText
+
+
+__all__ = ["Contentline", "Contentlines", "FOLD", "NAME", "NEWLINE",
+           "Parameters", "QUNSAFE_CHAR", "QUOTABLE", "UNSAFE_CHAR", "dquote",
+           "escape_char", "escape_string", "foldline", "param_value", "q_join",
+           "q_split", "tzid_from_dt", "uFOLD", "unescape_char",
+           "unescape_list_or_string", "unescape_string", "validate_param_value",
+           "validate_token"]
diff --git a/src/icalendar/parser_tools.py b/src/icalendar/parser_tools.py
@@ -48,3 +48,7 @@ def data_encode(data: Union[ICAL_TYPE, dict, list], encoding=DEFAULT_ENCODING) -
         return list(map(data_encode, data))
     else:
         return data
+
+
+__all__ = ["DEFAULT_ENCODING", "SEQUENCE_TYPES", "data_encode", "from_unicode",
+           "to_unicode"]
diff --git a/src/icalendar/prop.py b/src/icalendar/prop.py
@@ -1119,3 +1119,11 @@ def from_ical(self, name, value):
         type_class = self.for_property(name)
         decoded = type_class.from_ical(value)
         return decoded
+
+__all__ = ["DSTDIFF", "DSTOFFSET", "DURATION_REGEX", "FixedOffset", "HOUR",
+           "LocalTimezone", "STDOFFSET", "TimeBase", "TypesFactory",
+           "WEEKDAY_RULE", "ZERO", "from_unicode", "tzid_from_dt", "vBinary",
+           "vBoolean", "vCalAddress", "vCategory", "vDDDLists", "vDDDTypes",
+           "vDate", "vDatetime", "vDuration", "vFloat", "vFrequency", "vGeo",
+           "vInline", "vInt", "vPeriod", "vRecur", "vText", "vTime",
+           "vUTCOffset", "vUri", "vWeekday"]
diff --git a/src/icalendar/timezone/provider.py b/src/icalendar/timezone/provider.py
@@ -43,3 +43,5 @@ def uses_pytz(self) -> bool:
     @abstractmethod
     def uses_zoneinfo(self) -> bool:
         """Whether we use zoneinfo."""
+
+__all__ = ["TZProvider"]
diff --git a/src/icalendar/tools.py b/src/icalendar/tools.py
@@ -31,3 +31,5 @@ def uid(host_name='example.com', unique=''):
         unique = unique or UIDGenerator.rnd_string()
         today = to_unicode(vDatetime(datetime.today()).to_ical())
         return vText(f'{today}-{unique}@{host_name}')
+
+__all__ = ["UIDGenerator"]