Add type hints

Author: serderovsh

tronapi/base/datatypes.py

@@ -11,8 +11,18 @@
 )
 
 
+@curry
+def verify_attr(class_name, key, namespace):
+    if key not in namespace:
+        raise AttributeError(
+            "Property {0} not found on {1} class. "
+            "`{1}.factory` only accepts keyword arguments which are "
+            "present on the {1} class".format(key, class_name)
+        )
+
+
 class PropertyCheckingFactory(type):
-    def __init__(cls, name, bases, namespace):
+    def __init__(cls, name, bases, namespace, **kargs):
         # see PEP487.  To accept kwargs in __new__, they need to be
         # filtered out here.
         super().__init__(name, bases, namespace)
@@ -31,13 +41,3 @@ def __new__(mcs, name, bases, namespace, normalizers=None):
             processed_namespace = namespace
 
         return super().__new__(mcs, name, bases, processed_namespace)
-
-
-@curry
-def verify_attr(class_name, key, namespace):
-    if key not in namespace:
-        raise AttributeError(
-            "Property {0} not found on {1} class. "
-            "`{1}.factory` only accepts keyword arguments which are "
-            "present on the {1} class".format(key, class_name)
-        )

tronapi/base/decorators.py

@@ -1,19 +1,20 @@
 import functools
 import threading
 import warnings
+from typing import Callable
 
 
 class combomethod:
     def __init__(self, method):
         self.method = method
 
-    def __get__(self, obj=None, objtype=None):
+    def __get__(self, obj=None, obj_type=None) -> Callable:
         @functools.wraps(self.method)
         def _wrapper(*args, **kwargs):
             if obj is not None:
                 return self.method(obj, *args, **kwargs)
             else:
-                return self.method(objtype, *args, **kwargs)
+                return self.method(obj_type, *args, **kwargs)
 
         return _wrapper
 

tronapi/base/encoding.py

@@ -1,11 +1,16 @@
+from typing import Optional, Union
+
 from eth_utils import hexstr_if_str, to_hex
 
 from tronapi.utils.hexadecimal import remove_0x_prefix, decode_hex, encode_hex, add_0x_prefix
 from tronapi.utils.types import is_boolean, is_integer
 from tronapi.utils.validation import assert_one_val
 
 
-def to_bytes(primitive=None, hexstr=None, text=None):
+def to_bytes(primitive: Optional[Union[bytes, int]] = None,
+             hexstr: Optional[str] = None,
+             text: Optional[str] = None) -> bytes:
+
     assert_one_val(primitive, hexstr=hexstr, text=text)
 
     if is_boolean(primitive):
@@ -23,15 +28,15 @@ def to_bytes(primitive=None, hexstr=None, text=None):
     raise TypeError("expected an int in first arg, or keyword of hexstr or text")
 
 
-def pad_hex(value, bit_size):
+def pad_hex(value: str, bit_size: int) -> str:
     """
     Pads a hex string up to the given bit_size
     """
     value = remove_0x_prefix(value)
     return add_0x_prefix(value.zfill(int(bit_size / 4)))
 
 
-def to_4byte_hex(hex_or_str_or_bytes):
+def to_4byte_hex(hex_or_str_or_bytes: Union[int, str, bytes]) -> str:
     size_of_4bytes = 4 * 8
     byte_str = hexstr_if_str(to_bytes, hex_or_str_or_bytes)
     if len(byte_str) > 4:

tronapi/constants.py

@@ -1,7 +1,8 @@
-# --------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------
 # Copyright (c) iEXBase. All rights reserved.
-# Licensed under the MIT License. See License.txt in the project root for license information.
-# --------------------------------------------------------------------------------------------
+# Licensed under the MIT License.
+# See License.txt in the project root for license information.
+# --------------------------------------------------------------------
 
 # Tron nodes
 DEFAULT_FULL_NODE = "https://api.trongrid.io"

tronapi/exceptions.py

@@ -1,7 +1,8 @@
-# --------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------
 # Copyright (c) iEXBase. All rights reserved.
-# Licensed under the MIT License. See License.txt in the project root for license information.
-# --------------------------------------------------------------------------------------------
+# Licensed under the MIT License.
+# See License.txt in the project root for license information.
+# --------------------------------------------------------------------
 
 
 class TronError(Exception):

tronapi/module.py

@@ -8,11 +8,11 @@
 class Module:
     """Module Class"""
 
-    def __init__(self, tron):
+    def __init__(self, tron) -> None:
         self.tron = tron
 
     @classmethod
-    def attach(cls, target, module_name=None):
+    def attach(cls, target, module_name: str = None) -> None:
         if not module_name:
             module_name = cls.__name__.lower()
 

tronapi/transactionbuilder.py

@@ -1,7 +1,8 @@
-# --------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------
 # Copyright (c) iEXBase. All rights reserved.
-# Licensed under the MIT License. See License.txt in the project root for license information.
-# --------------------------------------------------------------------------------------------
+# Licensed under the MIT License.
+# See License.txt in the project root for license information.
+# --------------------------------------------------------------------
 
 from datetime import datetime
 from typing import Any, Tuple, List

tronapi/trx.py

@@ -27,18 +27,15 @@ class Trx(Module):
     defaultContractFactory = Contract
 
     def get_current_block(self):
-        """Query the latest block
-
-        Returns:
-            Latest block on full node
-        """
+        """Query the latest block"""
         return self.tron.manager.request(url='/wallet/getnowblock')
 
     def get_block(self, block: Any = None):
         """Get block details using HashString or blockNumber
 
         Args:
-            block (Any): Number or Hash Block
+            block (Any): ID or height for the block
+
         """
 
         # If the block identifier is not specified,
@@ -307,10 +304,11 @@ def send_trx(self, to, amount, options=None):
 
     def send_transaction(self, to, amount, options=None):
         """Send an asset to another account.
+        Will create and broadcast the transaction if a private key is provided.
 
-        Parameters:
-            to (str): Recipient
-            amount (float): Amount to transfer
+        Args:
+            to (str): Address to send TRX to.
+            amount (float): Amount of TRX to send.
             options (Any, optional): Options
 
         """
@@ -322,7 +320,6 @@ def send_transaction(self, to, amount, options=None):
             options = assoc(options, 'from', self.tron.default_address.hex)
 
         tx = self.tron.transaction.send_transaction(to, amount, options['from'])
-
         # If a comment is attached to the transaction,
         # in this case adding to the object
         if 'message' in options:
@@ -402,6 +399,10 @@ def sign(self, transaction: Any, use_tron: bool = True):
         """Sign the transaction, the api has the risk of leaking the private key,
         please make sure to call the api in a secure environment
 
+        Warnings:
+            Do not use this in any web / user-facing applications.
+            This will expose the private key.
+
         Args:
             transaction (Any): transaction details
             use_tron (bool): is Tron header
@@ -440,9 +441,6 @@ def broadcast(self, signed_transaction):
         Args:
             signed_transaction (object): signed transaction contract data
 
-        Returns:
-            broadcast success or failure
-
         """
         if not is_object(signed_transaction):
             raise InvalidTronError('Invalid transaction provided')