Merge pull request #1 from beemeeupnow/touchups

Miscellaneous touchups

Author: PatrickAlphaC

alchemy_sdk_py/alchemy.py

@@ -1,11 +1,11 @@
+import requests
+import time
 from datetime import datetime
-from typing import Optional, Tuple, Union
+from typing import List, Optional, Tuple, Union
 from .errors import NO_API_KEY_ERROR
-from .networks import Network
-from .utils import HexIntStringNumber, ETH_NULL_VALUE, is_hash, is_hex_int
 from .evm_node import POSSIBLE_BLOCK_TAGS, EVM_Node, HEADERS
-import requests
-import time
+from .networks import Network
+from .utils import HexIntStringNumber, ETH_NULL_VALUE, is_hash
 
 NFT_FILTERS = ["SPAM", "AIRDROPS"]
 
@@ -156,7 +156,7 @@ def _get_all_asset_transfers(
         from_block: Union[int, str, None] = 0,
         to_block: Union[int, str, None] = None,
         contract_addresses: Optional[list] = None,
-        category: Optional[list[str]] = [
+        category: Optional[List[str]] = [
             "external",
             "internal",
             "erc20",
@@ -202,7 +202,7 @@ def get_asset_transfers(
         max_count: Union[int, str, None] = 1000,
         page_key: Optional[str] = None,
         contract_addresses: Optional[list] = None,
-        category: Optional[list[str]] = [
+        category: Optional[List[str]] = [
             "external",
             "internal",
             "erc20",
@@ -433,7 +433,7 @@ def base_fee_per_gas(self) -> int:
     def get_token_balances(
         self,
         address: str,
-        token_addresses_or_type: Union[list[str], str, None] = None,
+        token_addresses_or_type: Union[List[str], str, None] = None,
         options_or_page_key: Union[dict, str, None] = None,
     ) -> dict:
         """
@@ -520,10 +520,10 @@ def get_nfts_for_owner(
         owner: str,
         page_key: Optional[str] = None,
         page_size: Optional[int] = 100,
-        contract_addresses: Optional[list[str]] = None,
+        contract_addresses: Optional[List[str]] = None,
         omit_metadata: Optional[bool] = False,
         token_uri_timeout_in_ms: Union[int, None] = None,
-        filters: Optional[list[str]] = None,
+        filters: Optional[List[str]] = None,
     ) -> dict:
         """Gets all NFTs currently owned by a given address.
 
@@ -553,11 +553,11 @@ def get_nfts(
         owner: str,
         page_key: Optional[str] = None,
         page_size: Optional[int] = 100,
-        contract_addresses: Optional[list[str]] = None,
+        contract_addresses: Optional[List[str]] = None,
         with_metadata: Optional[bool] = False,
         token_uri_timeout_in_ms: Union[int, None] = None,
-        exclude_filters: Optional[list[str]] = None,
-        include_filters: Optional[list[str]] = None,
+        exclude_filters: Optional[List[str]] = None,
+        include_filters: Optional[List[str]] = None,
         order_by: Optional[str] = None,
     ) -> dict:
         """Gets all NFTs currently owned by a given address.
@@ -691,8 +691,8 @@ def get_contracts_for_owner(
         owner: str,
         page_key: Optional[str] = None,
         page_size: Optional[int] = 100,
-        include_filters: Optional[list[str]] = None,
-        exclude_filters: Optional[list[str]] = None,
+        include_filters: Optional[List[str]] = None,
+        exclude_filters: Optional[List[str]] = None,
         order_by: Optional[str] = None,
     ) -> dict:
         """Gets all contracts for a given owner.
@@ -701,8 +701,8 @@ def get_contracts_for_owner(
             owner (str): Owner address to check
             page_key (Optional[str], optional): Page key to get the next page of results. Defaults to None.
             page_size (Optional[int], optional): Page size to get the next page of results. Defaults to 100.
-            include_filters (Optional[list[str]], optional): Optional list of strings from "SPAM" and "AIRDROPS". Defaults to None.
-            exclude_filters (Optional[list[str]], optional): Optional list of strings from "SPAM" and "AIRDROPS". Defaults to None.
+            include_filters (Optional[List[str]], optional): Optional list of strings from "SPAM" and "AIRDROPS". Defaults to None.
+            exclude_filters (Optional[List[str]], optional): Optional list of strings from "SPAM" and "AIRDROPS". Defaults to None.
             order_by (Optional[str], optional): Optional string to order by "transferTime" or None. Defaults to None.
 
         Returns:
@@ -956,7 +956,7 @@ def compute_rarity(self, contract_address: str, token_id: Union[str, int]) -> di
         return json_response
 
     def verify_nft_ownership(
-        self, wallet_address: str, contract_addresses: Union[str, list[str]]
+        self, wallet_address: str, contract_addresses: Union[str, List[str]]
     ) -> dict:
         """Verifies if a wallet owns a given NFT.
 

alchemy_sdk_py/errors.py

@@ -12,7 +12,7 @@
 
 def NETWORK_INITIALIZATION_ERROR(network_id_map):
     str = (
-        "Network has been given a poor name or chain ID."
+        "Network has been given a poor name or chain ID. "
         f"Please use one of the following options: {network_id_map.keys()}"
     )
     return str

alchemy_sdk_py/evm_node.py

@@ -1,10 +1,10 @@
 import os
-from typing import Optional, Union
-from alchemy_sdk_py.utils import HexIntStringNumber, is_hash
-from .errors import NO_API_KEY_ERROR
-from .networks import Network
 import requests
 from dotenv import load_dotenv
+from typing import List, Optional, Union
+from .utils import HexIntStringNumber
+from .errors import NO_API_KEY_ERROR
+from .networks import Network
 
 load_dotenv()
 
@@ -711,7 +711,7 @@ def get_gas_price(self) -> int:
         return self.gas_price()
 
     # Unsupported by Alchemy
-    # def get_compilers(self) -> list[str]:
+    # def get_compilers(self) -> List[str]:
     #     """
     #     params:
     #         None
@@ -729,7 +729,7 @@ def get_gas_price(self) -> int:
     #     return result
 
     # Unsupported by Alchemy
-    # def get_work(self) -> list[str]:
+    # def get_work(self) -> List[str]:
     #     """
     #     params:
     #         None
@@ -749,7 +749,7 @@ def get_gas_price(self) -> int:
     def get_logs(
         self,
         contract_address: str,
-        topics: Union[list[str], str],
+        topics: Union[List[str], str],
         from_block: Union[str, int, None] = 0,
         to_block: Union[str, int, None] = "latest",
     ) -> list:
@@ -758,7 +758,7 @@ def get_logs(
     def get_events(
         self,
         contract_address: str,
-        topics: Union[list[str], str],
+        topics: Union[List[str], str],
         from_block: Union[str, int, None] = 0,
         to_block: Union[str, int, None] = "latest",
     ) -> list:

alchemy_sdk_py/networks.py

@@ -1,5 +1,5 @@
-from .errors import NETWORK_INITIALIZATION_ERROR
 from typing import Union
+from .errors import NETWORK_INITIALIZATION_ERROR
 
 network_id_map = {
     "eth_mainnet": "1",

requirements.txt

@@ -1,6 +1,6 @@
-certifi==2022.12.7
-charset-normalizer==2.1.1
-idna==3.4
-requests==2.28.1
-urllib3==1.26.13
-python-dotenv==0.21.0
+certifi>=2022.12.7
+charset-normalizer~=2.1.1
+idna~=3.4
+requests~=2.28.1
+urllib3~=1.26.13
+python-dotenv~=0.21.0

tests/conftest.py

@@ -21,7 +21,7 @@ def alchemy_with_key() -> Alchemy:
 
 @pytest.fixture
 def mock_env_missing(monkeypatch: MonkeyPatch):
-    """A plugin from pytest to help saftely mock and delete environment variables.
+    """A plugin from pytest to help safely mock and delete environment variables.
 
     Args:
         monkeypatch (_pytest.monkeypatch.MonkeyPatch): _description_

tests/integration/test_alchemy_setup.py

@@ -1,6 +1,7 @@
-from alchemy_sdk_py import Alchemy
-import pytest
 import os
+import pytest
+from alchemy_sdk_py import Alchemy
+from _pytest.monkeypatch import MonkeyPatch
 
 
 def test_initialize_empty_network(dummy_api_key, mock_env_missing):
@@ -38,8 +39,8 @@ def test_api_key_property(dummy_api_key):
     assert alchemy.key == dummy_api_key
 
 
-def test_key_with_environment_variable():
+def test_key_with_environment_variable(monkeypatch: MonkeyPatch):
     test_key = "test_key"
-    os.environ["ALCHEMY_API_KEY"] = test_key
+    monkeypatch.setenv("ALCHEMY_API_KEY", test_key)
     alchemy = Alchemy()
     assert alchemy.key == test_key