Make the library importable when no features are selected

.github/workflows/tests.yml

@@ -10,13 +10,37 @@ on:
     branches: [ master ]
 
 jobs:
+  # Test that importing works with no optional dependencies installed
+  minimal-import:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10"]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install PDM
+      run: curl -sSL https://raw.githubusercontent.com/pdm-project/pdm/main/install-pdm.py | python3
+    - name: Install dependencies
+      run: |
+        pdm sync -G :none
+    - name: Test importing
+      run: |
+        pdm run python -c "import pons"
+
   test:
 
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.10", "3.11", "3.12"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
     - uses: actions/checkout@v3

docs/api.rst

@@ -157,13 +157,17 @@ Testing utilities
 
 ``pons`` exposes several types useful for testing applications that connect to Ethereum RPC servers. Not intended for the production environment.
 
-.. autoclass:: LocalProvider
+Install the feature ``local-provider`` for the ``local_provider`` module to be available.
+
+.. autoclass:: pons.local_provider.LocalProvider
    :show-inheritance:
-   :members: disable_auto_mine_transactions, enable_auto_mine_transactions, take_snapshot, revert_to_snapshot
+   :members: disable_auto_mine_transactions, enable_auto_mine_transactions, take_snapshot, revert_to_snapshot, root
+
+.. autoclass:: pons.local_provider.SnapshotID()
 
-.. autoclass:: SnapshotID()
+Install the feature ``http-provider-server`` for the ``http_provider_server`` module to be available.
 
-.. autoclass:: HTTPProviderServer
+.. autoclass:: pons.http_provider_server.HTTPProviderServer
    :members:
    :special-members: __call__
 
@@ -174,9 +178,9 @@ Compiler
 Install with the feature ``compiler`` for it to be available.
 
 
-.. autofunction:: compile_contract_file
+.. autofunction:: pons.compiler.compile_contract_file
 
-.. autoclass:: EVMVersion
+.. autoclass:: pons.compiler.EVMVersion
    :members:
 
 

docs/changelog.rst

@@ -2,6 +2,18 @@ Changelog
 ---------
 
 
+0.10.0 (in development)
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Changed
+^^^^^^^
+
+- ``compile_contract_file`` and ``EVMVersion`` moved to ``compiler`` submodule; ``LocalProvider`` moved to ``local_provider`` submodule; ``HTTPProviderServer`` moved to ``http_provider_server`` submodule. (PR_89_)
+
+
+.. _PR_89: https://github.com/fjarri-eth/pons/pull/89
+
+
 0.9.0 (2025-10-18)
 ~~~~~~~~~~~~~~~~~~
 

docs/index.rst

@@ -14,7 +14,8 @@ A quick usage example:
     import ethereum_rpc
 
     from ethereum_rpc import Amount
-    from pons import LocalProvider, HTTPProviderServer
+    from pons.local_provider import LocalProvider
+    from pons.http_provider_server import HTTPProviderServer
 
     # Run examples with our test server in the background
 

pons/__init__.py

@@ -17,7 +17,6 @@
     LogFilter,
     PendingTransactionFilter,
 )
-from ._compiler import EVMVersion, compile_contract_file
 from ._contract import (
     BaseBoundMethodCall,
     BoundConstructor,
@@ -51,8 +50,6 @@
     FallbackStrategyFactory,
     PriorityFallback,
 )
-from ._http_provider_server import HTTPProviderServer
-from ._local_provider import LocalProvider, SnapshotID
 from ._multicall import BoundMultiMethodCall, BoundMultiMethodValueCall, Multicall
 from ._provider import (
     HTTPError,
@@ -94,7 +91,6 @@
     "ContractPanic",
     "CycleFallback",
     "DeployedContract",
-    "EVMVersion",
     "Either",
     "Error",
     "Event",
@@ -105,9 +101,7 @@
     "FallbackStrategyFactory",
     "HTTPError",
     "HTTPProvider",
-    "HTTPProviderServer",
     "InvalidResponse",
-    "LocalProvider",
     "LogFilter",
     "Method",
     "MethodCall",
@@ -122,11 +116,9 @@
     "ProviderPath",
     "Receive",
     "Signer",
-    "SnapshotID",
     "TransactionFailed",
     "Unreachable",
     "abi",
-    "compile_contract_file",
     "get_create2_address",
     "get_create_address",
 ]

pons/_compiler.py → pons/compiler.py

@@ -1,3 +1,8 @@
+"""
+Solidity compiler support.
+Requires the dependencies from the ``compiler`` feature.
+"""
+
 from collections.abc import Mapping
 from enum import Enum
 from pathlib import Path
@@ -6,6 +11,8 @@
 
 from ._contract import CompiledContract
 
+__all__ = ["EVMVersion", "compile_contract_file"]
+
 
 class EVMVersion(Enum):
     """

pons/_http_provider_server.py → pons/http_provider_server.py

@@ -1,3 +1,8 @@
+"""
+HTTP provider server for tests.
+Requires the dependencies from the ``http-provider-server`` feature.
+"""
+
 from http import HTTPStatus
 from typing import cast
 
@@ -13,6 +18,8 @@
 
 from ._provider import RPC_JSON, HTTPProvider, Provider
 
+__all__ = ["HTTPProviderServer"]
+
 
 def parse_request(request: RPC_JSON) -> tuple[RPC_JSON, str, list[RPC_JSON]]:
     request = cast("dict[str, RPC_JSON]", request)
@@ -98,7 +105,7 @@ async def __call__(self, *, task_status: trio.TaskStatus = trio.TASK_STATUS_IGNO
         Starts the server in an external event loop.
         Useful for the cases when it needs to run in parallel with other servers or clients.
 
-        Supports start-up reporting when invoked via `nursery.start()`.
+        Supports start-up reporting when invoked via ``nursery.start()``.
         """
         config = Config()
         config.bind = [f"{self._host}:{self._port}"]

pons/_local_provider.py → pons/local_provider.py

@@ -1,4 +1,7 @@
-"""PyEVM-based provider for tests."""
+"""
+PyEVM-based provider for tests.
+Requires the dependencies from the ``local-provider`` feature.
+"""
 
 import itertools
 from collections.abc import AsyncIterator
@@ -13,6 +16,8 @@
 from ._provider import RPC_JSON, Provider, ProviderError, ProviderSession
 from ._signer import AccountSigner
 
+__all__ = ["LocalProvider", "SnapshotID"]
+
 
 class SnapshotID:
     """An ID of a snapshot in a :py:class:`LocalProvider`."""
@@ -32,7 +37,7 @@ def __init__(
         *,
         root_balance: Amount,
         chain_id: int = 1,
-        evm_version: EVMVersion = EVMVersion.CANCUN,
+        evm_version: EVMVersion = EVMVersion.PRAGUE,
     ):
         self._local_node = Node(
             root_balance_wei=root_balance.as_wei(), chain_id=chain_id, evm_version=evm_version
@@ -65,14 +70,14 @@ def revert_to_snapshot(self, snapshot_id: SnapshotID) -> None:
         self._local_node = self._snapshots[snapshot_id.id_]
         self._rpc_node = RPCNode(self._local_node)
 
-    def rpc(self, method: str, *args: Any) -> RPC_JSON:
+    def rpc(self, method: str, *args: Any) -> RPC_JSON:  # noqa: D102
         try:
             return self._rpc_node.rpc(method, *args)
         except RPCError as exc:
             raise ProviderError(exc) from exc
 
     @asynccontextmanager
-    async def session(self) -> AsyncIterator["LocalProviderSession"]:
+    async def session(self) -> AsyncIterator["LocalProviderSession"]:  # noqa: D102
         yield LocalProviderSession(self)
 
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pons"
-version = "0.9.0"
+version = "0.10.0-dev"
 description = "Async RPC client for Ethereum"
 authors = [
     {name = "Bogdan Opanchuk", email = "bogdan@opanchuk.net"},
@@ -139,6 +139,8 @@ ignore = [
     "RUF009",
     # Way too restrictive. Sometimes it is useful to import types from pytest.
     "PT013",
+    # Sphinx does not need a separate docstring for ``__init__``.
+    "D107",
 ]
 
 # Allow autofix for all enabled rules (when `--fix`) is provided.

tests/conftest.py

@@ -4,7 +4,8 @@
 from alysis import EVMVersion
 from ethereum_rpc import Amount
 
-from pons import AccountSigner, Client, ClientSession, LocalProvider
+from pons import AccountSigner, Client, ClientSession
+from pons.local_provider import LocalProvider
 
 
 @pytest.fixture

tests/test_client.py

@@ -30,18 +30,18 @@
     ContractLegacyError,
     ContractPanic,
     DeployedContract,
-    LocalProvider,
     Method,
     Mutability,
     ProviderError,
     TransactionFailed,
     Unreachable,
     abi,
-    compile_contract_file,
 )
 from pons._abi_types import encode_args
 from pons._contract_abi import PANIC_ERROR
 from pons._provider import RPC_JSON
+from pons.compiler import compile_contract_file
+from pons.local_provider import LocalProvider
 
 
 @pytest.fixture

tests/test_client_rpc.py

@@ -26,13 +26,13 @@
     ClientSession,
     CompiledContract,
     Either,
-    LocalProvider,
     ProviderError,
     abi,
-    compile_contract_file,
 )
 from pons._abi_types import encode_args
 from pons._provider import RPC_JSON
+from pons.compiler import compile_contract_file
+from pons.local_provider import LocalProvider
 
 
 @pytest.fixture

tests/test_compiler.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from pons import EVMVersion, compile_contract_file
+from pons.compiler import EVMVersion, compile_contract_file
 
 
 def test_multiple_contracts() -> None:

tests/test_contract.py

@@ -13,9 +13,9 @@
     Method,
     Receive,
     abi,
-    compile_contract_file,
 )
 from pons._abi_types import encode_args
+from pons.compiler import compile_contract_file
 
 
 @pytest.fixture

tests/test_contract_functionality.py

@@ -10,18 +10,17 @@
     Constructor,
     ContractABI,
     DeployedContract,
-    EVMVersion,
     Method,
     Mutability,
     abi,
-    compile_contract_file,
 )
+from pons.compiler import compile_contract_file
 
 
 @pytest.fixture
 def compiled_contracts() -> dict[str, CompiledContract]:
     path = Path(__file__).resolve().parent / "TestContractFunctionality.sol"
-    return compile_contract_file(path, evm_version=EVMVersion.CANCUN)
+    return compile_contract_file(path)
 
 
 async def test_empty_constructor(

tests/test_http_provider_server.py

@@ -5,8 +5,10 @@
 import trio
 from ethereum_rpc import RPCError, RPCErrorCode
 
-from pons import HTTPProviderServer, LocalProvider, ProviderError
+from pons import ProviderError
 from pons._provider import RPC_JSON, ProviderSession
+from pons.http_provider_server import HTTPProviderServer
+from pons.local_provider import LocalProvider
 
 
 @pytest.fixture

tests/test_local_provider.py

@@ -4,7 +4,8 @@
 import pytest
 from ethereum_rpc import Amount
 
-from pons import AccountSigner, Client, ClientSession, LocalProvider, ProviderError
+from pons import AccountSigner, Client, ClientSession, ProviderError
+from pons.local_provider import LocalProvider
 
 
 # Masking the global fixtures to make this test self-contained

tests/test_multicall.py

@@ -10,8 +10,8 @@
     ContractLegacyError,
     DeployedContract,
     Multicall,
-    compile_contract_file,
 )
+from pons.compiler import compile_contract_file
 
 
 @pytest.fixture