Breaking/add remaining breaking changes for major (#333)

* breaking: remove deprecated ``str`` support in mnemonic

* breaking: bump eth-keyfile lower pin for new major

* chore: remove unused imports

* updates from comments on PR #333

Author: fselmo

.gitignore

@@ -110,3 +110,6 @@ crashlytics-build.properties
 fabric.properties
 
 # END JetBrains section
+
+# uv
+uv.lock

eth_account/account.py

@@ -207,7 +207,7 @@ def decrypt(keyfile_json: str | dict[str, Any], password: str) -> HexBytes:
         # type ignored because eth_keyfile appears to be using the wrong type for
         # the password arg.
         # once fixed there, this should error and can be removed
-        return HexBytes(decode_keyfile_json(keyfile, password_bytes))  # type: ignore[arg-type]  # noqa: E501
+        return HexBytes(decode_keyfile_json(keyfile, password_bytes))
 
     @classmethod
     def encrypt(
@@ -277,7 +277,10 @@ def encrypt(
         # the password arg.
         # once fixed there, this should error and can be removed
         return create_keyfile_json(
-            key_bytes, password_bytes, kdf=kdf, iterations=iterations  # type: ignore[arg-type]  # noqa: E501
+            key_bytes,
+            password_bytes,
+            kdf=kdf,
+            iterations=iterations,
         )
 
     @combomethod
@@ -384,7 +387,7 @@ def create_with_mnemonic(
         self,
         passphrase: str = "",
         num_words: int = 12,
-        language: Language | str = Language.ENGLISH,
+        language: Language = Language.ENGLISH,
         account_path: str = ETHEREUM_DEFAULT_PATH,
     ) -> tuple[LocalAccount, str]:
         r"""
@@ -400,9 +403,7 @@ def create_with_mnemonic(
         :param int num_words: Number of words to use with seed phrase.
                               Default is 12 words.
                               Must be one of [12, 15, 18, 21, 24].
-        :param (Language, str) language: Language to use for BIP39 mnemonic seed phrase.
-                                         The use of a string is deprecated and will be
-                                         removed in a future version.
+        :param Language language: Language to use for BIP39 mnemonic seed phrase.
         :param str account_path: Specify an alternate HD path for deriving the
             seed using BIP32 HD wallet key derivation.
         :returns: A tuple consisting of an object with private key and

eth_account/hdaccount/__init__.py

@@ -1,8 +1,3 @@
-from typing import (
-    Union,
-)
-import warnings
-
 from eth_utils import (
     ValidationError,
 )
@@ -21,7 +16,7 @@
 ETHEREUM_DEFAULT_PATH = "m/44'/60'/0'/0/0"
 
 
-def generate_mnemonic(num_words: int, lang: Language | str) -> str:
+def generate_mnemonic(num_words: int, lang: Language) -> str:
     return Mnemonic(lang).generate(num_words)
 
 

eth_account/hdaccount/mnemonic.py

@@ -25,7 +25,6 @@
     Path,
 )
 import secrets
-import warnings
 
 from bitarray import (
     bitarray,
@@ -110,23 +109,8 @@ class Mnemonic:
         b'\x97ii\x07\x12\xf0$\x81\x98\xb6?\x07\x08t7\x18d\x87\xe1\x7f\xbe\xbaL\xb4i%\xeb\x12\xce\xe2h\x1c\xb2\x19\x13\xfb9wtoV\x9c\xb8\xdf;5\xba4X\xa3\xd6b`|\xdc\xb1\x10\xb0\xeeS\x86\x95\xd75'
     """  # noqa: E501
 
-    def __init__(self, raw_language: Language | str = Language.ENGLISH):
-        if isinstance(raw_language, str):
-            warnings.warn(
-                "The language parameter should be a Language enum, not a string. "
-                "This will be enforced in a future version.",
-                DeprecationWarning,
-                stacklevel=2,
-            )
-
-            language = raw_language.lower().replace(" ", "_")
-            languages = Mnemonic.list_languages()
-            if language not in languages:
-                raise ValidationError(
-                    f"Invalid language choice '{language}', must be one of {languages}"
-                )
-        else:
-            language = raw_language.value
+    def __init__(self, raw_language: Language = Language.ENGLISH):
+        language = raw_language.value
         self.language = language
         self.wordlist = get_wordlist(self.language)
 

newsfragments/333.breaking.rst

@@ -0,0 +1 @@
+Bump ``eth-keyfile`` lower pin for new major version. Remove deprecated ``str`` support for mnemonic, opt for enum support only.

setup.py

@@ -52,7 +52,7 @@
     install_requires=[
         "bitarray>=2.4.0",
         "eth-abi>=4.0.0-b.2",
-        "eth-keyfile>=0.7.0, <0.9.0",
+        "eth-keyfile>=0.9.0",
         "eth-keys>=0.4.0",
         "eth-rlp>=2.1.0",
         "eth-utils>=5.3.0",

tests/core/test_hdaccount.py

@@ -92,22 +92,3 @@ def test_bad_account_path1():
 def test_bad_account_path2():
     with pytest.raises(ValidationError, match="Path.*is not valid.*"):
         Account.create_with_mnemonic(account_path="m/not/an/account/path")
-
-
-def test_unknown_language():
-    with pytest.raises(
-        ValidationError, match="Invalid language choice 'pig_latin', must be one of.*"
-    ):
-        with pytest.warns(
-            DeprecationWarning,
-            match="The language parameter should be a Language enum, not a string*.",
-        ):
-            Account.create_with_mnemonic(language="pig latin")
-
-
-def test_known_language_as_string_warns():
-    with pytest.warns(
-        DeprecationWarning,
-        match="The language parameter should be a Language enum, not a string*.",
-    ):
-        Account.create_with_mnemonic(language="spanish")

tests/core/test_mnemonic.py

@@ -67,12 +67,6 @@ def test_detection(language, word):
 def test_undetected_language():
     with pytest.raises(ValidationError):
         Mnemonic.detect_language("xxxxxxx")
-    with pytest.raises(ValidationError):
-        with pytest.warns(
-            DeprecationWarning,
-            match="The language parameter should be a Language enum, not a string",
-        ):
-            Mnemonic("xxxxxxx")
 
 
 def test_expand_word():
@@ -136,25 +130,6 @@ def test_generation_with_enum(lang, num_words):
     assert len(Mnemonic.to_seed(mnemonic)) == 64
 
 
-@pytest.mark.parametrize("lang", Mnemonic.list_languages())
-@pytest.mark.parametrize("num_words", [12, 15, 18, 21, 24])
-def test_generation_with_string(lang, num_words):
-    with pytest.warns(DeprecationWarning):
-        m = Mnemonic(lang)
-    mnemonic = m.generate(num_words)
-    assert m.is_mnemonic_valid(mnemonic)
-    try:
-        assert Mnemonic.detect_language(mnemonic) == Language(lang)
-    except AssertionError:
-        # NOTE: Sometimes traditional chinese can return characters that are also
-        # valid simplified chinese characters. In that scenario, the detection
-        # algorithm will assume simplified.
-        if lang != "chinese_traditional":
-            raise
-        assert Mnemonic.detect_language(mnemonic) == Language.CHINESE_SIMPLIFIED
-    assert len(Mnemonic.to_seed(mnemonic)) == 64
-
-
 @pytest.mark.parametrize(
     "entropy,expected_mnemonic,expected_seed",
     [