Use __all__ in __init__.py

cratiu222 · May 30, 2024 · a05d3d2 · a05d3d2
1 parent a39aa9b
commit a05d3d2
Show file tree

Hide file tree

Showing 10 changed files with 101 additions and 7 deletions.
diff --git a/ens/__init__.py b/ens/__init__.py
@@ -1,5 +1,3 @@
-# flake8: noqa
-
 from .async_ens import (
     AsyncENS,
 )
@@ -18,3 +16,16 @@
     UnderfundedBid,
     UnownedName,
 )
+
+__all__ = [
+    "AsyncENS",
+    "BaseENS",
+    "ENS",
+    "AddressMismatch",
+    "BidTooLow",
+    "InvalidLabel",
+    "InvalidName",
+    "UnauthorizedError",
+    "UnderfundedBid",
+    "UnownedName",
+]
diff --git a/web3/beacon/__init__.py b/web3/beacon/__init__.py
@@ -1,2 +1,7 @@
 from .async_beacon import AsyncBeacon
 from .beacon import Beacon
+
+__all__ = [
+    "AsyncBeacon",
+    "Beacon",
+]
diff --git a/web3/contract/__init__.py b/web3/contract/__init__.py
@@ -7,3 +7,10 @@
     ContractCaller,
     ContractConstructor,
 )
+
+__all__ = [
+    "AsyncContract",
+    "AsyncContractCaller",
+    "Contract",
+    "ContractConstructor",
+]
diff --git a/web3/eth/__init__.py b/web3/eth/__init__.py
@@ -8,3 +8,10 @@
     Contract,
     Eth,
 )
+
+__all__ = [
+    "AsyncEth",
+    "BaseEth",
+    "Contract",
+    "Eth",
+]
diff --git a/web3/middleware/__init__.py b/web3/middleware/__init__.py
@@ -92,3 +92,25 @@ async def async_combine_middleware(
         initialized = mw(async_w3)
         accumulator_fn = await initialized.async_wrap_make_request(accumulator_fn)
     return accumulator_fn
+
+
+__all__ = [
+    "AttributeDictMiddleware",
+    "Middleware",
+    "Web3Middleware",
+    "BufferedGasEstimateMiddleware",
+    "LocalFilterMiddleware",
+    "FormattingMiddlewareBuilder",
+    "GasPriceStrategyMiddleware",
+    "ENSNameToAddressMiddleware",
+    "ExtraDataToPOAMiddleware",
+    "PythonicMiddleware",
+    "SignAndSendRawMiddlewareBuilder",
+    "StalecheckMiddlewareBuilder",
+    "ValidationMiddleware",
+    "AsyncWeb3",
+    "Web3",
+    "RPCResponse",
+    "combine_middleware",
+    "async_combine_middleware",
+]
diff --git a/web3/providers/__init__.py b/web3/providers/__init__.py
@@ -26,3 +26,18 @@
 from .auto import (
     AutoProvider,
 )
+
+__all__ = [
+    "AsyncBaseProvider",
+    "AsyncHTTPProvider",
+    "BaseProvider",
+    "JSONBaseProvider",
+    "IPCProvider",
+    "HTTPProvider",
+    "LegacyWebSocketProvider",
+    "AsyncIPCProvider",
+    "PersistentConnection",
+    "PersistentConnectionProvider",
+    "WebSocketProvider",
+    "AutoProvider",
+]
diff --git a/web3/providers/eth_tester/__init__.py b/web3/providers/eth_tester/__init__.py
@@ -2,3 +2,8 @@
     AsyncEthereumTesterProvider,
     EthereumTesterProvider,
 )
+
+__all__ = [
+    "AsyncEthereumTesterProvider",
+    "EthereumTesterProvider",
+]
diff --git a/web3/providers/persistent/__init__.py b/web3/providers/persistent/__init__.py
@@ -13,3 +13,11 @@
 from .websocket import (
     WebSocketProvider,
 )
+
+__all__ = [
+    "PersistentConnectionProvider",
+    "PersistentConnection",
+    "RequestProcessor",
+    "AsyncIPCProvider",
+    "WebSocketProvider",
+]
diff --git a/web3/providers/rpc/__init__.py b/web3/providers/rpc/__init__.py
@@ -4,3 +4,8 @@
 from .rpc import (
     HTTPProvider,
 )
+
+__all__ = [
+    "AsyncHTTPProvider",
+    "HTTPProvider",
+]
diff --git a/web3/utils/__init__.py b/web3/utils/__init__.py
@@ -3,17 +3,26 @@
 classify as breaking changes.
 """
 
-from .abi import (  # NOQA
+from .abi import (
     get_abi_input_names,
     get_abi_output_names,
 )
-from .address import get_create_address  # NOQA
-from .async_exception_handling import (  # NOQA
+from .address import get_create_address
+from .async_exception_handling import (
     async_handle_offchain_lookup,
 )
-from .caching import (  # NOQA
+from .caching import (
     SimpleCache,
 )
-from .exception_handling import (  # NOQA
+from .exception_handling import (
     handle_offchain_lookup,
 )
+
+__all__ = [
+    "get_abi_input_names",
+    "get_abi_output_names",
+    "get_create_address",
+    "async_handle_offchain_lookup",
+    "SimpleCache",
+    "handle_offchain_lookup",
+]