Update provider explicit exports for __all__

fselmo · fselmo · commit f9b7f21411e2 · 2024-05-29T12:51:39.000-06:00
- Add base provider classes.
- Add `AsyncEthereumTesterProvider` and include in explicit export
diff --git a/newsfragments/3409.feature.rst b/newsfragments/3409.feature.rst
@@ -0,0 +1 @@
+Provide explicit ``__all__`` exports for providers in `web3/providers/__init__.py`; update `web3/__init__.py` to include all provider classes including base classes.
diff --git a/web3/__init__.py b/web3/__init__.py
@@ -1,5 +1,4 @@
 from eth_account import Account  # noqa: E402
-import sys
 
 from importlib.metadata import version
 
@@ -10,12 +9,20 @@
     AsyncWeb3,
     Web3,
 )
+from web3.providers import (
+    AsyncBaseProvider,
+    AutoProvider,
+    BaseProvider,
+    JSONBaseProvider,
+    PersistentConnection,
+)
 from web3.providers.persistent import (  # noqa: E402
     AsyncIPCProvider,
     PersistentConnectionProvider,
     WebSocketProvider,
 )
 from web3.providers.eth_tester import (  # noqa: E402
+    AsyncEthereumTesterProvider,
     EthereumTesterProvider,
 )
 from web3.providers.ipc import (  # noqa: E402
@@ -32,14 +39,23 @@
 
 __all__ = [
     "__version__",
+    "Account",
+    # web3:
     "AsyncWeb3",
     "Web3",
+    # providers:
+    "AsyncBaseProvider",
+    "AsyncEthereumTesterProvider",
+    "AsyncHTTPProvider",
+    "AsyncIPCProvider",
+    "AutoProvider",
+    "BaseProvider",
+    "EthereumTesterProvider",
     "HTTPProvider",
     "IPCProvider",
+    "JSONBaseProvider",
     "LegacyWebSocketProvider",
+    "PersistentConnection",
+    "PersistentConnectionProvider",
     "WebSocketProvider",
-    "EthereumTesterProvider",
-    "Account",
-    "AsyncHTTPProvider",
-    "AsyncIPCProvider",
 ]
diff --git a/web3/providers/__init__.py b/web3/providers/__init__.py
@@ -26,3 +26,18 @@
 from .auto import (
     AutoProvider,
 )
+
+__all__ = [
+    "AsyncBaseProvider",
+    "AsyncHTTPProvider",
+    "AsyncIPCProvider",
+    "AutoProvider",
+    "BaseProvider",
+    "LegacyWebSocketProvider",
+    "HTTPProvider",
+    "IPCProvider",
+    "JSONBaseProvider",
+    "PersistentConnection",
+    "PersistentConnectionProvider",
+    "WebSocketProvider",
+]

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Provide explicit ``__all__`` exports for providers in `web3/providers/__init__.py`; update `web3/__init__.py` to include all provider classes including base classes.