From b7512cda6b56211b575c6c8e6c3a41ef2b00858f Mon Sep 17 00:00:00 2001 From: Linda Le Date: Wed, 2 Nov 2022 23:28:57 -0600 Subject: [PATCH 1/4] Snakecase isAddress --- docs/overview.rst | 2 +- docs/web3.main.rst | 4 ++-- web3/main.py | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/overview.rst b/docs/overview.rst index a93bdd74f6..e913b8cd03 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -101,7 +101,7 @@ Encoding and Decoding Helpers Address Helpers --------------- -- :meth:`Web3.isAddress() ` +- :meth:`Web3.is_address() ` - :meth:`Web3.isChecksumAddress() ` - :meth:`Web3.toChecksumAddress() ` diff --git a/docs/web3.main.rst b/docs/web3.main.rst index 48a0951d9b..10281b8a07 100644 --- a/docs/web3.main.rst +++ b/docs/web3.main.rst @@ -208,7 +208,7 @@ Currency Conversions Addresses ~~~~~~~~~ -.. py:method:: Web3.isAddress(value) +.. py:method:: Web3.is_address(value) Returns ``True`` if the value is one of the recognized address formats. @@ -218,7 +218,7 @@ Addresses .. code-block:: python - >>> Web3.isAddress('0xd3CdA913deB6f67967B99D67aCDFa1712C293601') + >>> Web3.is_address('0xd3CdA913deB6f67967B99D67aCDFa1712C293601') True diff --git a/web3/main.py b/web3/main.py index 915e79f32b..689f8eaf4b 100644 --- a/web3/main.py +++ b/web3/main.py @@ -216,7 +216,7 @@ def from_wei(number: int, unit: str) -> Union[int, decimal.Decimal]: # Address Utility @staticmethod @wraps(is_address) - def isAddress(value: Any) -> bool: + def is_address(value: Any) -> bool: return is_address(value) @staticmethod From 4500612eac16a0cae51adb3a0b2029b34e96581c Mon Sep 17 00:00:00 2001 From: Linda Le Date: Wed, 2 Nov 2022 23:30:04 -0600 Subject: [PATCH 2/4] Snakecase isChecksumAddress --- docs/overview.rst | 2 +- docs/web3.main.rst | 6 +++--- web3/main.py | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/overview.rst b/docs/overview.rst index e913b8cd03..5ffcddf9b4 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -102,7 +102,7 @@ Address Helpers --------------- - :meth:`Web3.is_address() ` -- :meth:`Web3.isChecksumAddress() ` +- :meth:`Web3.is_checksum_address() ` - :meth:`Web3.toChecksumAddress() ` diff --git a/docs/web3.main.rst b/docs/web3.main.rst index 10281b8a07..2f9e83cf73 100644 --- a/docs/web3.main.rst +++ b/docs/web3.main.rst @@ -222,16 +222,16 @@ Addresses True -.. py:method:: Web3.isChecksumAddress(value) +.. py:method:: Web3.is_checksum_address(value) Returns ``True`` if the value is a valid `EIP55`_ checksummed address .. code-block:: python - >>> Web3.isChecksumAddress('0xd3CdA913deB6f67967B99D67aCDFa1712C293601') + >>> Web3.is_checksum_address('0xd3CdA913deB6f67967B99D67aCDFa1712C293601') True - >>> Web3.isChecksumAddress('0xd3cda913deb6f67967b99d67acdfa1712c293601') + >>> Web3.is_checksum_address('0xd3cda913deb6f67967b99d67acdfa1712c293601') False diff --git a/web3/main.py b/web3/main.py index 689f8eaf4b..974563a89e 100644 --- a/web3/main.py +++ b/web3/main.py @@ -221,7 +221,7 @@ def is_address(value: Any) -> bool: @staticmethod @wraps(is_checksum_address) - def isChecksumAddress(value: Any) -> bool: + def is_checksum_address(value: Any) -> bool: return is_checksum_address(value) @staticmethod From 9d6bba1855d9edd3fdc1bd3be8fe1e6f68f7e20b Mon Sep 17 00:00:00 2001 From: Linda Le Date: Wed, 2 Nov 2022 23:31:49 -0600 Subject: [PATCH 3/4] Snakecase toChecksumAddress --- docs/overview.rst | 2 +- docs/web3.main.rst | 4 ++-- web3/_utils/validation.py | 2 +- web3/main.py | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/overview.rst b/docs/overview.rst index 5ffcddf9b4..0cc9c40e2d 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -103,7 +103,7 @@ Address Helpers - :meth:`Web3.is_address() ` - :meth:`Web3.is_checksum_address() ` -- :meth:`Web3.toChecksumAddress() ` +- :meth:`Web3.to_checksum_address() ` Currency Conversions diff --git a/docs/web3.main.rst b/docs/web3.main.rst index 2f9e83cf73..07211db695 100644 --- a/docs/web3.main.rst +++ b/docs/web3.main.rst @@ -235,14 +235,14 @@ Addresses False -.. py:method:: Web3.toChecksumAddress(value) +.. py:method:: Web3.to_checksum_address(value) Returns the given address with an `EIP55`_ checksum. .. code-block:: python - >>> Web3.toChecksumAddress('0xd3cda913deb6f67967b99d67acdfa1712c293601') + >>> Web3.to_checksum_address('0xd3cda913deb6f67967b99d67acdfa1712c293601') '0xd3CdA913deB6f67967B99D67aCDFa1712C293601' .. _EIP55: https://github.com/ethereum/EIPs/issues/55 diff --git a/web3/_utils/validation.py b/web3/_utils/validation.py index ca36b897fd..a009c3f9ac 100644 --- a/web3/_utils/validation.py +++ b/web3/_utils/validation.py @@ -186,7 +186,7 @@ def validate_address(value: Any) -> None: "The software that gave you this non-checksum address should be " "considered unsafe, please file it as a bug on their platform. " "Try using an ENS name instead. Or, if you must accept lower safety, " - "use Web3.toChecksumAddress(lower_case_address).", + "use Web3.to_checksum_address(lower_case_address).", value, ) else: diff --git a/web3/main.py b/web3/main.py index 974563a89e..49dce1e003 100644 --- a/web3/main.py +++ b/web3/main.py @@ -226,7 +226,7 @@ def is_checksum_address(value: Any) -> bool: @staticmethod @wraps(to_checksum_address) - def toChecksumAddress(value: Union[AnyAddress, str, bytes]) -> ChecksumAddress: + def to_checksum_address(value: Union[AnyAddress, str, bytes]) -> ChecksumAddress: return to_checksum_address(value) # mypy Types From 297a77186e472024204d4f167c3ee3dad826a799 Mon Sep 17 00:00:00 2001 From: Linda Le Date: Wed, 2 Nov 2022 23:38:23 -0600 Subject: [PATCH 4/4] Add entry to release notes --- newsfragments/2708.breaking.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 newsfragments/2708.breaking.rst diff --git a/newsfragments/2708.breaking.rst b/newsfragments/2708.breaking.rst new file mode 100644 index 0000000000..597685fe5b --- /dev/null +++ b/newsfragments/2708.breaking.rst @@ -0,0 +1 @@ +Snakecase the toAddress, isChecksumAddress, and toChecksumAddress methods \ No newline at end of file