py-geth 4.2.0__py3-none-any.whl → 5.2.0__py3-none-any.whl

geth/install.py

@@ -1,6 +1,10 @@
 """
 Install geth
 """
+from __future__ import (
+    annotations,
+)
+
 import contextlib
 import functools
 import os
@@ -8,28 +12,40 @@ import stat
 import subprocess
 import sys
 import tarfile
+from typing import (
+    Any,
+    Generator,
+)
+
+import requests
+from requests.exceptions import (
+    ConnectionError,
+    HTTPError,
+    Timeout,
+)
+
+from geth.exceptions import (
+    PyGethException,
+    PyGethKeyError,
+    PyGethOSError,
+    PyGethValueError,
+)
+from geth.types import (
+    IO_Any,
+)
 
-V1_11_0 = "v1.11.0"
-V1_11_1 = "v1.11.1"
-V1_11_2 = "v1.11.2"
-V1_11_3 = "v1.11.3"
-V1_11_4 = "v1.11.4"
-V1_11_5 = "v1.11.5"
-V1_11_6 = "v1.11.6"
-V1_12_0 = "v1.12.0"
-V1_12_1 = "v1.12.1"
-V1_12_2 = "v1.12.2"
-V1_13_0 = "v1.13.0"
-V1_13_1 = "v1.13.1"
-V1_13_2 = "v1.13.2"
-V1_13_3 = "v1.13.3"
-V1_13_4 = "v1.13.4"
-V1_13_5 = "v1.13.5"
-V1_13_6 = "v1.13.6"
-V1_13_7 = "v1.13.7"
-V1_13_8 = "v1.13.8"
-V1_13_9 = "v1.13.9"
-V1_13_10 = "v1.13.10"
+V1_14_0 = "v1.14.0"
+V1_14_2 = "v1.14.2"
+V1_14_3 = "v1.14.3"
+V1_14_4 = "v1.14.4"
+V1_14_5 = "v1.14.5"
+V1_14_6 = "v1.14.6"
+V1_14_7 = "v1.14.7"
+V1_14_8 = "v1.14.8"
+V1_14_9 = "v1.14.9"
+V1_14_10 = "v1.14.10"
+V1_14_11 = "v1.14.11"
+V1_14_12 = "v1.14.12"
 
 
 LINUX = "linux"
@@ -41,7 +57,7 @@ WINDOWS = "win32"
 # System utilities.
 #
 @contextlib.contextmanager
-def chdir(path):
+def chdir(path: str) -> Generator[None, None, None]:
     original_path = os.getcwd()
     try:
         os.chdir(path)
@@ -50,7 +66,7 @@ def chdir(path):
         os.chdir(original_path)
 
 
-def get_platform():
+def get_platform() -> str:
     if sys.platform.startswith("linux"):
         return LINUX
     elif sys.platform == OSX:
@@ -58,11 +74,11 @@ def get_platform():
     elif sys.platform == WINDOWS:
         return WINDOWS
     else:
-        raise KeyError(f"Unknown platform: {sys.platform}")
+        raise PyGethKeyError(f"Unknown platform: {sys.platform}")
 
 
-def is_executable_available(program):
-    def is_exe(fpath):
+def is_executable_available(program: str) -> bool:
+    def is_exe(fpath: str) -> bool:
         return os.path.isfile(fpath) and os.access(fpath, os.X_OK)
 
     fpath = os.path.dirname(program)
@@ -79,7 +95,7 @@ def is_executable_available(program):
     return False
 
 
-def ensure_path_exists(dir_path):
+def ensure_path_exists(dir_path: str) -> bool:
     """
     Make sure that a path exists
     """
@@ -89,13 +105,16 @@ def ensure_path_exists(dir_path):
     return False
 
 
-def ensure_parent_dir_exists(path):
+def ensure_parent_dir_exists(path: str) -> None:
     ensure_path_exists(os.path.dirname(path))
 
 
 def check_subprocess_call(
-    command, message=None, stderr=subprocess.STDOUT, **proc_kwargs
-):
+    command: list[str],
+    message: str | None = None,
+    stderr: IO_Any = subprocess.STDOUT,
+    **proc_kwargs: Any,
+) -> int:
     if message:
         print(message)
     print(f"Executing: {' '.join(command)}")
@@ -104,8 +123,11 @@ def check_subprocess_call(
 
 
 def check_subprocess_output(
-    command, message=None, stderr=subprocess.STDOUT, **proc_kwargs
-):
+    command: list[str],
+    message: str | None = None,
+    stderr: IO_Any = subprocess.STDOUT,
+    **proc_kwargs: Any,
+) -> Any:
     if message:
         print(message)
     print(f"Executing: {' '.join(command)}")
@@ -113,23 +135,23 @@ def check_subprocess_output(
     return subprocess.check_output(command, stderr=stderr, **proc_kwargs)
 
 
-def chmod_plus_x(executable_path):
+def chmod_plus_x(executable_path: str) -> None:
     current_st = os.stat(executable_path)
     os.chmod(executable_path, current_st.st_mode | stat.S_IEXEC)
 
 
-def get_go_executable_path():
+def get_go_executable_path() -> str:
     return os.environ.get("GO_BINARY", "go")
 
 
-def is_go_available():
+def is_go_available() -> bool:
     return is_executable_available(get_go_executable_path())
 
 
 #
 #  Installation filesystem path utilities
 #
-def get_base_install_path(identifier):
+def get_base_install_path(identifier: str) -> str:
     if "GETH_BASE_INSTALL_PATH" in os.environ:
         return os.path.join(
             os.environ["GETH_BASE_INSTALL_PATH"],
@@ -145,21 +167,21 @@ def get_base_install_path(identifier):
         )
 
 
-def get_source_code_archive_path(identifier):
+def get_source_code_archive_path(identifier: str) -> str:
     return os.path.join(
         get_base_install_path(identifier),
         "release.tar.gz",
     )
 
 
-def get_source_code_extract_path(identifier):
+def get_source_code_extract_path(identifier: str) -> str:
     return os.path.join(
         get_base_install_path(identifier),
         "source",
     )
 
 
-def get_source_code_path(identifier):
+def get_source_code_path(identifier: str) -> str:
     return os.path.join(
         get_base_install_path(identifier),
         "source",
@@ -167,7 +189,7 @@ def get_source_code_path(identifier):
     )
 
 
-def get_build_path(identifier):
+def get_build_path(identifier: str) -> str:
     source_code_path = get_source_code_path(identifier)
     return os.path.join(
         source_code_path,
@@ -175,7 +197,7 @@ def get_build_path(identifier):
     )
 
 
-def get_built_executable_path(identifier):
+def get_built_executable_path(identifier: str) -> str:
     build_path = get_build_path(identifier)
     return os.path.join(
         build_path,
@@ -184,7 +206,7 @@ def get_built_executable_path(identifier):
     )
 
 
-def get_executable_path(identifier):
+def get_executable_path(identifier: str) -> str:
     base_install_path = get_base_install_path(identifier)
     return os.path.join(
         base_install_path,
@@ -201,29 +223,27 @@ DOWNLOAD_SOURCE_CODE_URI_TEMPLATE = (
 )
 
 
-def download_source_code_release(identifier):
+def download_source_code_release(identifier: str) -> None:
     download_uri = DOWNLOAD_SOURCE_CODE_URI_TEMPLATE.format(identifier)
     source_code_archive_path = get_source_code_archive_path(identifier)
 
     ensure_parent_dir_exists(source_code_archive_path)
+    try:
+        response = requests.get(download_uri)
+        response.raise_for_status()
+        with open(source_code_archive_path, "wb") as f:
+            f.write(response.content)
 
-    command = [
-        "wget",
-        download_uri,
-        "-c",  # resume previously incomplete download.
-        "-O",
-        source_code_archive_path,
-    ]
-
-    return check_subprocess_call(
-        command,
-        message=f"Downloading source code release from {download_uri}",
-    )
+        print(f"Downloading source code release from {download_uri}")
 
+    except (HTTPError, Timeout, ConnectionError) as e:
+        raise PyGethException(
+            f"An error occurred while downloading from {download_uri}: {e}"
+        )
 
-def extract_source_code_release(identifier):
-    source_code_archive_path = get_source_code_archive_path(identifier)
 
+def extract_source_code_release(identifier: str) -> None:
+    source_code_archive_path = get_source_code_archive_path(identifier)
     source_code_extract_path = get_source_code_extract_path(identifier)
     ensure_path_exists(source_code_extract_path)
 
@@ -233,7 +253,7 @@ def extract_source_code_release(identifier):
 
     with tarfile.open(source_code_archive_path, "r:gz") as archive_file:
 
-        def is_within_directory(directory, target):
+        def is_within_directory(directory: str, target: str) -> bool:
             abs_directory = os.path.abspath(directory)
             abs_target = os.path.abspath(target)
 
@@ -241,20 +261,20 @@ def extract_source_code_release(identifier):
 
             return prefix == abs_directory
 
-        def safe_extract(tar, path="."):
+        def safe_extract(tar: tarfile.TarFile, path: str = ".") -> None:
             for member in tar.getmembers():
                 member_path = os.path.join(path, member.name)
                 if not is_within_directory(path, member_path):
-                    raise Exception("Attempted Path Traversal in Tar File")
+                    raise PyGethException("Attempted Path Traversal in Tar File")
 
             tar.extractall(path)
 
         safe_extract(archive_file, source_code_extract_path)
 
 
-def build_from_source_code(identifier):
+def build_from_source_code(identifier: str) -> None:
     if not is_go_available():
-        raise OSError(
+        raise PyGethOSError(
             "The `go` runtime was not found but is required to build geth.  If "
             "the `go` executable is not in your $PATH you can specify the path "
             "using the environment variable GO_BINARY to specify the path."
@@ -271,7 +291,7 @@ def build_from_source_code(identifier):
 
     built_executable_path = get_built_executable_path(identifier)
     if not os.path.exists(built_executable_path):
-        raise OSError(
+        raise PyGethOSError(
             "Built executable not found in expected location: "
             f"{built_executable_path}"
         )
@@ -284,12 +304,14 @@ def build_from_source_code(identifier):
         if os.path.islink(executable_path):
             os.remove(executable_path)
         else:
-            raise OSError(f"Non-symlink file already present at `{executable_path}`")
+            raise PyGethOSError(
+                f"Non-symlink file already present at `{executable_path}`"
+            )
     os.symlink(built_executable_path, executable_path)
     chmod_plus_x(executable_path)
 
 
-def install_from_source_code_release(identifier):
+def install_from_source_code_release(identifier: str) -> None:
     download_source_code_release(identifier)
     extract_source_code_release(identifier)
     build_from_source_code(identifier)
@@ -307,91 +329,63 @@ def install_from_source_code_release(identifier):
     print(f"geth successfully installed at: {executable_path}\n\n{version_output}\n\n")
 
 
-install_v1_11_0 = functools.partial(install_from_source_code_release, V1_11_0)
-install_v1_11_1 = functools.partial(install_from_source_code_release, V1_11_1)
-install_v1_11_2 = functools.partial(install_from_source_code_release, V1_11_2)
-install_v1_11_3 = functools.partial(install_from_source_code_release, V1_11_3)
-install_v1_11_4 = functools.partial(install_from_source_code_release, V1_11_4)
-install_v1_11_5 = functools.partial(install_from_source_code_release, V1_11_5)
-install_v1_11_6 = functools.partial(install_from_source_code_release, V1_11_6)
-install_v1_12_0 = functools.partial(install_from_source_code_release, V1_12_0)
-install_v1_12_1 = functools.partial(install_from_source_code_release, V1_12_1)
-install_v1_12_2 = functools.partial(install_from_source_code_release, V1_12_2)
-install_v1_13_0 = functools.partial(install_from_source_code_release, V1_13_0)
-install_v1_13_1 = functools.partial(install_from_source_code_release, V1_13_1)
-install_v1_13_2 = functools.partial(install_from_source_code_release, V1_13_2)
-install_v1_13_3 = functools.partial(install_from_source_code_release, V1_13_3)
-install_v1_13_4 = functools.partial(install_from_source_code_release, V1_13_4)
-install_v1_13_5 = functools.partial(install_from_source_code_release, V1_13_5)
-install_v1_13_6 = functools.partial(install_from_source_code_release, V1_13_6)
-install_v1_13_7 = functools.partial(install_from_source_code_release, V1_13_7)
-install_v1_13_8 = functools.partial(install_from_source_code_release, V1_13_8)
-install_v1_13_9 = functools.partial(install_from_source_code_release, V1_13_9)
-install_v1_13_10 = functools.partial(install_from_source_code_release, V1_13_10)
-
+install_v1_14_0 = functools.partial(install_from_source_code_release, V1_14_0)
+install_v1_14_2 = functools.partial(install_from_source_code_release, V1_14_2)
+install_v1_14_3 = functools.partial(install_from_source_code_release, V1_14_3)
+install_v1_14_4 = functools.partial(install_from_source_code_release, V1_14_4)
+install_v1_14_5 = functools.partial(install_from_source_code_release, V1_14_5)
+install_v1_14_6 = functools.partial(install_from_source_code_release, V1_14_6)
+install_v1_14_7 = functools.partial(install_from_source_code_release, V1_14_7)
+install_v1_14_8 = functools.partial(install_from_source_code_release, V1_14_8)
+install_v1_14_9 = functools.partial(install_from_source_code_release, V1_14_9)
+install_v1_14_10 = functools.partial(install_from_source_code_release, V1_14_10)
+install_v1_14_11 = functools.partial(install_from_source_code_release, V1_14_11)
+install_v1_14_12 = functools.partial(install_from_source_code_release, V1_14_12)
 
 INSTALL_FUNCTIONS = {
     LINUX: {
-        V1_11_0: install_v1_11_0,
-        V1_11_1: install_v1_11_1,
-        V1_11_2: install_v1_11_2,
-        V1_11_3: install_v1_11_3,
-        V1_11_4: install_v1_11_4,
-        V1_11_5: install_v1_11_5,
-        V1_11_6: install_v1_11_6,
-        V1_12_0: install_v1_12_0,
-        V1_12_1: install_v1_12_1,
-        V1_12_2: install_v1_12_2,
-        V1_13_0: install_v1_13_0,
-        V1_13_1: install_v1_13_1,
-        V1_13_2: install_v1_13_2,
-        V1_13_3: install_v1_13_3,
-        V1_13_4: install_v1_13_4,
-        V1_13_5: install_v1_13_5,
-        V1_13_6: install_v1_13_6,
-        V1_13_7: install_v1_13_7,
-        V1_13_8: install_v1_13_8,
-        V1_13_9: install_v1_13_9,
-        V1_13_10: install_v1_13_10,
+        V1_14_0: install_v1_14_0,
+        V1_14_2: install_v1_14_2,
+        V1_14_3: install_v1_14_3,
+        V1_14_4: install_v1_14_4,
+        V1_14_5: install_v1_14_5,
+        V1_14_6: install_v1_14_6,
+        V1_14_7: install_v1_14_7,
+        V1_14_8: install_v1_14_8,
+        V1_14_9: install_v1_14_9,
+        V1_14_10: install_v1_14_10,
+        V1_14_11: install_v1_14_11,
+        V1_14_12: install_v1_14_12,
     },
     OSX: {
-        V1_11_0: install_v1_11_0,
-        V1_11_1: install_v1_11_1,
-        V1_11_2: install_v1_11_2,
-        V1_11_3: install_v1_11_3,
-        V1_11_4: install_v1_11_4,
-        V1_11_5: install_v1_11_5,
-        V1_11_6: install_v1_11_6,
-        V1_12_0: install_v1_12_0,
-        V1_12_1: install_v1_12_1,
-        V1_12_2: install_v1_12_2,
-        V1_13_0: install_v1_13_0,
-        V1_13_1: install_v1_13_1,
-        V1_13_2: install_v1_13_2,
-        V1_13_3: install_v1_13_3,
-        V1_13_4: install_v1_13_4,
-        V1_13_5: install_v1_13_5,
-        V1_13_6: install_v1_13_6,
-        V1_13_7: install_v1_13_7,
-        V1_13_8: install_v1_13_8,
-        V1_13_9: install_v1_13_9,
-        V1_13_10: install_v1_13_10,
+        V1_14_0: install_v1_14_0,
+        V1_14_2: install_v1_14_2,
+        V1_14_3: install_v1_14_3,
+        V1_14_4: install_v1_14_4,
+        V1_14_5: install_v1_14_5,
+        V1_14_6: install_v1_14_6,
+        V1_14_7: install_v1_14_7,
+        V1_14_8: install_v1_14_8,
+        V1_14_9: install_v1_14_9,
+        V1_14_10: install_v1_14_10,
+        V1_14_11: install_v1_14_11,
+        V1_14_12: install_v1_14_12,
     },
 }
 
 
-def install_geth(identifier, platform=None):
+def install_geth(identifier: str, platform: str | None = None) -> None:
     if platform is None:
         platform = get_platform()
 
     if platform not in INSTALL_FUNCTIONS:
-        raise ValueError(
+        raise PyGethValueError(
             "Installation of go-ethereum is not supported on your platform "
             f"({platform}). Supported platforms are: "
             f"{', '.join(sorted(INSTALL_FUNCTIONS.keys()))}"
         )
     elif identifier not in INSTALL_FUNCTIONS[platform]:
-        raise ValueError(
+        raise PyGethValueError(
             f"Installation of geth=={identifier} is not supported. Must be one of "
             f"{', '.join(sorted(INSTALL_FUNCTIONS[platform].keys()))}"
         )

geth/main.py

@@ -1,6 +1,24 @@
+from __future__ import (
+    annotations,
+)
+
 import re
 
 import semantic_version
+from typing_extensions import (
+    Unpack,
+)
+
+from geth.exceptions import (
+    PyGethTypeError,
+    PyGethValueError,
+)
+from geth.types import (
+    GethKwargsTypedDict,
+)
+from geth.utils.validation import (
+    validate_geth_kwargs,
+)
 
 from .utils.encoding import (
     force_text,
@@ -10,25 +28,29 @@ from .wrapper import (
 )
 
 
-def get_geth_version_info_string(**geth_kwargs):
+def get_geth_version_info_string(**geth_kwargs: Unpack[GethKwargsTypedDict]) -> str:
     if "suffix_args" in geth_kwargs:
-        raise TypeError(
+        raise PyGethTypeError(
             "The `get_geth_version` function cannot be called with the "
             "`suffix_args` parameter"
         )
     geth_kwargs["suffix_args"] = ["version"]
+    validate_geth_kwargs(geth_kwargs)
     stdoutdata, stderrdata, command, proc = geth_wrapper(**geth_kwargs)
-    return stdoutdata
+    return stdoutdata.decode("utf-8")
 
 
 VERSION_REGEX = r"Version: (.*)\n"
 
 
-def get_geth_version(**geth_kwargs):
+def get_geth_version(
+    **geth_kwargs: Unpack[GethKwargsTypedDict],
+) -> semantic_version.Version:
+    validate_geth_kwargs(geth_kwargs)
     version_info_string = get_geth_version_info_string(**geth_kwargs)
     version_match = re.search(VERSION_REGEX, force_text(version_info_string, "utf8"))
     if not version_match:
-        raise ValueError(
+        raise PyGethValueError(
             f"Did not match version string in geth output:\n{version_info_string}"
         )
     version_string = version_match.groups()[0]