From: whitequark <whitequark@whitequark.org>
Date: Mon, 21 Oct 2019 10:39:21 +0000 (+0000)
Subject: Explicitly restrict prelude imports.
X-Git-Tag: v0.1~10
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=61e6267dafa4e4cde711c91509bd825e6e6839a6;p=nmigen.git

Explicitly restrict prelude imports.

It turns out that while Python does not import _private identifiers
when using * imports, it does nevertheless import all submodules.

Avoid polluting the namespace in the prelude by explicitly listing
all exported identifiers.
---

diff --git a/nmigen/__init__.py b/nmigen/__init__.py
index e90da10..bb0c239 100644
--- a/nmigen/__init__.py
+++ b/nmigen/__init__.py
@@ -4,4 +4,18 @@ try:
 except pkg_resources.DistributionNotFound:
     pass
 
+
 from .hdl import *
+
+
+__all__ = [
+    "Shape", "unsigned", "signed",
+    "Value", "Const", "C", "Mux", "Cat", "Repl", "Array", "Signal", "ClockSignal", "ResetSignal",
+    "Module",
+    "ClockDomain",
+    "Elaboratable", "Fragment", "Instance",
+    "Memory",
+    "Record",
+    "DomainRenamer", "ResetInserter", "EnableInserter",
+    "CEInserter", # TODO(nmigen-0.2): remove this
+]
diff --git a/nmigen/hdl/__init__.py b/nmigen/hdl/__init__.py
index 355b9f8..9b53c87 100644
--- a/nmigen/hdl/__init__.py
+++ b/nmigen/hdl/__init__.py
@@ -6,4 +6,17 @@ from .ir import Elaboratable, Fragment, Instance
 from .mem import Memory
 from .rec import Record
 from .xfrm import DomainRenamer, ResetInserter, EnableInserter, \
-                  CEInserter # deprecated
+                  CEInserter # TODO(nmigen-0.2): remove this
+
+
+__all__ = [
+    "Shape", "unsigned", "signed",
+    "Value", "Const", "C", "Mux", "Cat", "Repl", "Array", "Signal", "ClockSignal", "ResetSignal",
+    "Module",
+    "ClockDomain",
+    "Elaboratable", "Fragment", "Instance",
+    "Memory",
+    "Record",
+    "DomainRenamer", "ResetInserter", "EnableInserter",
+    "CEInserter", # TODO(nmigen-0.2): remove this
+]