Skip to content

Commit 81c2088

Browse files
authored
Snakecase fromWeb3 (#2703)
* Snakecase fromWeb3 * Add entry to release notes
1 parent 191a072 commit 81c2088

File tree

9 files changed

+17
-14
lines changed

9 files changed

+17
-14
lines changed

docs/ens_overview.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Create an :class:`~ens.ENS` object (named ``ns`` below) in one of three ways:
3535
# Note: This inherits the w3 middlewares from the w3 instance and adds a stalecheck middleware to the middleware onion
3636
from ens import ENS
3737
w3 = Web3(...)
38-
ns = ENS.fromWeb3(w3)
38+
ns = ENS.from_web3(w3)
3939
4040
4141
Asynchronous support is available via the ``AsyncENS`` module:
@@ -49,7 +49,7 @@ Asynchronous support is available via the ``AsyncENS`` module:
4949
5050
Note that an ``ens`` module instance is also avaliable on the ``w3`` instance.
5151
The first time it's used, Web3.py will create the ``ens`` instance using
52-
``ENS.fromWeb3(w3)`` or ``AsyncENS.fromWeb3(w3)`` as appropriate.
52+
``ENS.from_web3(w3)`` or ``AsyncENS.from_web3(w3)`` as appropriate.
5353

5454
.. code-block:: python
5555

ens/async_ens.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ def __init__(
108108
)
109109

110110
@classmethod
111-
def fromWeb3(cls, w3: "Web3", addr: ChecksumAddress = None) -> "AsyncENS":
111+
def from_web3(cls, w3: "Web3", addr: ChecksumAddress = None) -> "AsyncENS":
112112
"""
113113
Generate an AsyncENS instance with web3
114114

ens/ens.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ def __init__(
108108
)
109109

110110
@classmethod
111-
def fromWeb3(cls, w3: "Web3", addr: ChecksumAddress = None) -> "ENS":
111+
def from_web3(cls, w3: "Web3", addr: ChecksumAddress = None) -> "ENS":
112112
"""
113113
Generate an ENS instance with web3
114114

ethpm/backends/registry.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ def parse_registry_uri(uri: str) -> RegistryURI:
9696
address_or_ens, chain_id = parsed_uri.netloc.split(":")
9797
else:
9898
address_or_ens, chain_id = parsed_uri.netloc, "1"
99-
ns = ENS.fromWeb3(w3)
99+
ns = ENS.from_web3(w3)
100100
if is_address(address_or_ens):
101101
address = address_or_ens
102102
ens = None

newsfragments/2703.breaking.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Snakecase the fromWeb3 method

tests/core/pm-module/test_ens_integration.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ def ens_setup(deployer):
104104
ens_contract.functions.setSubnodeOwner(
105105
b"\0" * 32, eth_labelhash, eth_registrar.address
106106
).transact({"from": ens_key})
107-
return ENS.fromWeb3(w3, ens_contract.address)
107+
return ENS.from_web3(w3, ens_contract.address)
108108

109109

110110
@pytest.fixture
@@ -124,7 +124,7 @@ def test_ens_must_be_set_before_ens_methods_can_be_used(ens):
124124
@pytest.mark.xfail(reason="Need to properly add authorization as of 8/10/2022")
125125
def test_web3_ens(ens):
126126
w3 = ens.w3
127-
ns = ENS.fromWeb3(w3, ens.ens.address)
127+
ns = ENS.from_web3(w3, ens.ens.address)
128128
w3.ens = ns
129129
registry = SimpleRegistry.deploy_new_instance(w3)
130130
w3.ens.setup_address("tester.eth", registry.address)

tests/ens/conftest.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ def ens_setup():
343343
reverse_tld_namehash, w3.keccak(text="addr"), reverse_registrar.address
344344
).transact({"from": ens_key})
345345

346-
return ENS.fromWeb3(w3, ens_contract.address)
346+
return ENS.from_web3(w3, ens_contract.address)
347347

348348

349349
@pytest.fixture()
@@ -645,7 +645,7 @@ async def async_ens_setup(async_w3):
645645
reverse_tld_namehash, async_w3.keccak(text="addr"), reverse_registrar.address
646646
).transact({"from": ens_key})
647647

648-
return AsyncENS.fromWeb3(async_w3, ens_contract.address)
648+
return AsyncENS.from_web3(async_w3, ens_contract.address)
649649

650650

651651
@pytest_asyncio.fixture

tests/ens/test_ens.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@
1010
)
1111

1212

13-
def test_fromWeb3_inherits_web3_middlewares(w3):
13+
def test_from_web3_inherits_web3_middlewares(w3):
1414
test_middleware = pythonic_middleware
1515
w3.middleware_onion.add(test_middleware, "test_middleware")
1616

17-
ns = ENS.fromWeb3(w3)
17+
ns = ENS.from_web3(w3)
1818
assert ns.w3.middleware_onion.get("test_middleware") == test_middleware
1919

2020

2121
# -- async -- #
2222

2323

2424
@pytest.mark.asyncio
25-
async def test_async_fromWeb3_inherits_web3_middlewares(async_w3):
25+
async def test_async_from_web3_inherits_web3_middlewares(async_w3):
2626
test_middleware = async_validation_middleware
2727
async_w3.middleware_onion.add(test_middleware, "test_middleware")
2828

29-
ns = AsyncENS.fromWeb3(async_w3)
29+
ns = AsyncENS.from_web3(async_w3)
3030
assert ns.w3.middleware_onion.get("test_middleware") == test_middleware

web3/main.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,9 @@ def is_encodable(self, _type: TypeStr, value: Any) -> bool:
347347
@property
348348
def ens(self) -> Union[ENS, AsyncENS, "Empty"]:
349349
if self._ens is empty:
350-
return AsyncENS.fromWeb3(self) if self.eth.is_async else ENS.fromWeb3(self)
350+
return (
351+
AsyncENS.from_web3(self) if self.eth.is_async else ENS.from_web3(self)
352+
)
351353

352354
return self._ens
353355

0 commit comments

Comments
 (0)