Use __all__ to advertise public API.

Closes #324. Note that non-public symbols are still accessible, and that some applications, such as iPython, will ignore __all__ when offering tab-completion suggestions.
popsim-consortium · Jun 24, 2021 · 215a041 · 215a041
1 parent 8ec4796
commit 215a041
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 0 deletions.
diff --git a/demes/__init__.py b/demes/__init__.py
@@ -31,3 +31,26 @@
     dump_all,
 )
 from .ms import from_ms
+
+__all__ = [
+    "__version__",
+    "Builder",
+    "Epoch",
+    "AsymmetricMigration",
+    "Pulse",
+    "Deme",
+    "Graph",
+    "Split",
+    "Branch",
+    "Merge",
+    "Admix",
+    "load_asdict",
+    "loads_asdict",
+    "load",
+    "loads",
+    "load_all",
+    "dump",
+    "dumps",
+    "dump_all",
+    "from_ms",
+]
diff --git a/demes/demes.py b/demes/demes.py
@@ -10,6 +10,19 @@
 
 from .load_dump import dumps as demes_dumps
 
+__all__ = [
+    "Builder",
+    "Epoch",
+    "AsymmetricMigration",
+    "Pulse",
+    "Deme",
+    "Graph",
+    "Split",
+    "Branch",
+    "Merge",
+    "Admix",
+]
+
 Number = Union[int, float]
 Name = str
 Time = Number

diff --git a/demes/hypothesis_strategies.py b/demes/hypothesis_strategies.py
@@ -8,6 +8,8 @@
 
 import demes
 
+__all__ = ["graphs"]
+
 
 def prec32(x):
     """truncate x to the nearest single-precision floating point number"""

diff --git a/demes/load_dump.py b/demes/load_dump.py
@@ -11,6 +11,17 @@
 
 import demes
 
+__all__ = [
+    "load_asdict",
+    "loads_asdict",
+    "load",
+    "loads",
+    "load_all",
+    "dump",
+    "dumps",
+    "dump_all",
+]
+
 
 @contextlib.contextmanager
 def _open_file_polymorph(polymorph, mode="r"):

diff --git a/demes/ms.py b/demes/ms.py
@@ -10,6 +10,8 @@
 import demes
 from .demes import finite, positive, non_negative, unit_interval
 
+__all__ = ["from_ms"]
+
 logger = logging.getLogger(__name__)