Ensure all modules have __all__ defined.

Author: domdfcoding

domdf_python_tools/bases.py

@@ -32,6 +32,8 @@
 # 3rd party
 import pydash  # type: ignore
 
+__all__ = ["Dictable", "NamedList", "namedlist"]
+
 
 class Dictable(Iterable):
 	"""

domdf_python_tools/dates.py

@@ -35,6 +35,17 @@
 from collections import OrderedDict
 from typing import Optional, Union
 
+__all__ = [
+		"current_tzinfo",
+		"set_timezone",
+		"utc_timestamp_to_datetime",
+		"months",
+		"parse_month",
+		"get_month_number",
+		"check_date",
+		]
+
+
 try:
 
 	# 3rd party
@@ -84,6 +95,10 @@ def get_timezone(tz: str, date: Optional[datetime.datetime] = None) -> Optional[
 
 		return pytz.timezone(tz).localize(d).tzinfo
 
+
+	__all__.extend(["get_utc_offset", "get_timezone"])
+
+
 except ImportError as e:  # pragma: no cover
 
 	# stdlib

domdf_python_tools/doctools.py

@@ -31,6 +31,18 @@
 from textwrap import dedent
 from typing import Any, Callable, Optional, Sequence, Type, TypeVar, Union
 
+__all__ = [
+		"F",
+		"deindent_string",
+		"document_object_from_another",
+		"append_doctring_from_another",
+		"make_sphinx_links",
+		"is_documented_by",
+		"append_docstring_from",
+		"sphinxify_docstring",
+		]
+
+
 F = TypeVar('F', bound=Callable[..., Any])
 
 

domdf_python_tools/import_tools.py

@@ -50,6 +50,8 @@
 from types import ModuleType
 from typing import Any, Callable, List, Optional, Type
 
+__all__ = ["discover"]
+
 
 def discover(
 		package: ModuleType,

domdf_python_tools/paths.py

@@ -44,6 +44,22 @@
 # this package
 from domdf_python_tools.typing import PathLike
 
+__all__ = [
+		"append",
+		"copytree",
+		"delete",
+		"maybe_make",
+		"parent_path",
+		"read",
+		"relpath",
+		"write",
+		"clean_writer",
+		"make_executable",
+		"PathPlus",
+		"PosixPathPlus",
+		"WindowsPathPlus",
+		]
+
 
 def append(var: str, filename: PathLike, **kwargs) -> int:
 	"""

domdf_python_tools/secrets.py

@@ -25,6 +25,8 @@
 #  MA 02110-1301, USA.
 #
 
+__all__ = ["Secret"]
+
 
 class Secret(str):
 	"""

domdf_python_tools/terminal.py

@@ -70,6 +70,15 @@
 import textwrap
 from typing import Any, Optional, Tuple
 
+__all__ = [
+		"clear",
+		"br",
+		"interrupt",
+		"overtype",
+		"get_terminal_size",
+		"Echo",
+		]
+
 
 def clear() -> None:
 	"""

domdf_python_tools/terminal_colours.py

@@ -65,6 +65,26 @@
 from colorama import init  # type: ignore
 from typing_extensions import Final
 
+__all__ = [
+		"CSI",
+		"OSC",
+		"BEL",
+		"code_to_chars",
+		"set_title",
+		"clear_screen",
+		"clear_line",
+		"Colour",
+		"AnsiCodes",
+		"AnsiCursor",
+		"AnsiFore",
+		"AnsiBack",
+		"AnsiStyle",
+		"Fore",
+		"Back",
+		"Style",
+		"Cursor",
+		]
+
 init()
 
 CSI: Final[str] = "\033["

domdf_python_tools/testing.py

@@ -5,6 +5,8 @@
 Handy functions for testing code.
 
 Requires `pytest <https://docs.pytest.org/en/stable/>`_ to be installed.
+
+.. versionadded:: 0.4.9
 """
 #
 #  Copyright © 2020 Dominic Davis-Foster <[email protected]>
@@ -38,6 +40,16 @@
 # this package
 from domdf_python_tools.utils import Len
 
+__all__ = [
+		"generate_truthy_values",
+		"generate_falsy_values",
+		"testing_boolean_values",
+		"whitespace",
+		"whitespace_perms_list",
+		"whitespace_perms",
+		"count",
+		]
+
 
 def generate_truthy_values(extra_truthy: Sequence = (), ratio: float = 1) -> Iterator[Any]:
 	"""
@@ -47,6 +59,8 @@ def generate_truthy_values(extra_truthy: Sequence = (), ratio: float = 1) -> Ite
 
 	:param extra_truthy: Additional values that should be considered :py:obj:`True`.
 	:param ratio: The ratio of the number of values to select to the total number of values.
+
+	.. versionadded:: 0.4.9
 	"""
 
 	truthy_values = [
@@ -81,6 +95,8 @@ def generate_falsy_values(extra_falsy: Sequence = (), ratio: float = 1) -> Itera
 
 	:param extra_falsy: Additional values that should be considered :py:obj:`True`.
 	:param ratio: The ratio of the number of values to select to the total number of values.
+
+	.. versionadded:: 0.4.9
 	"""
 
 	falsy_values = [
@@ -124,6 +140,8 @@ def testing_boolean_values(
 	:param extra_truthy: Additional values that should be considered :py:obj:`True`.
 	:param extra_falsy: Additional values that should be considered :py:obj:`False`.
 	:param ratio: The ratio of the number of values to select to the total number of values.
+
+	.. versionadded:: 0.4.9
 	"""
 
 	truthy = generate_truthy_values(extra_truthy, ratio)
@@ -157,6 +175,8 @@ def whitespace_perms(ratio: float = 0.5) -> MarkDecorator:
 	The single parametrized argument is ``char``.
 
 	:param ratio: The ratio of the number of permutations to select to the total number of permutations.
+
+	.. versionadded:: 0.4.9
 	"""
 
 	perms = whitespace_perms_list()
@@ -173,6 +193,8 @@ def count(stop: int, start: int = 0, step: int = 1) -> MarkDecorator:
 	:param stop: The stop value passed to :class:`range`.
 	:param start: The start value passed to :class:`range`.
 	:param step: The step passed to :class:`range`.
+
+	.. versionadded:: 0.4.9
 	"""
 
 	return pytest.mark.parametrize("count", range(start, stop, step))

domdf_python_tools/typing.py

@@ -29,6 +29,9 @@
 from decimal import Decimal
 from typing import Any, Type, Union
 
+__all__ = ["PathLike", "AnyNumber", "check_membership"]
+
+
 #: Type hint for objects that represent filesystem paths.
 PathLike = Union[str, pathlib.Path, os.PathLike]