feat/python: Lint sdk develop

.github/workflows/bindings-python.yml

@@ -112,6 +112,11 @@ jobs:
           sudo apt-get update
           sudo apt-get install libudev-dev libusb-1.0-0-dev
 
+      - name: Run linter for iota_sdk
+        if: ${{ startsWith(matrix.os, 'ubuntu-latest') }}
+        working-directory: bindings/python
+        run: tox -e lint-sdk
+
       - name: Run linter for examples
         if: ${{ startsWith(matrix.os, 'ubuntu-latest') }}
         working-directory: bindings/python

bindings/python/.pylintrc

@@ -5,6 +5,12 @@ disable=missing-module-docstring,
 	invalid-name, # files that starts with number
 	duplicate-code,
 	consider-using-with,
-	consider-using-f-string
-
+	fixme, # TODOS 
+	too-many-instance-attributes,
+	too-many-arguments,
+	too-many-public-methods,
+	too-few-public-methods,
+	too-many-locals
 
+[TYPECHECK]
+generated-members=from_dict,to_dict,to_json # Made from @json

bindings/python/iota_sdk/__init__.py

@@ -1,13 +1,13 @@
 # Copyright 2023 IOTA Stiftung
 # SPDX-License-Identifier: Apache-2.0
 
-from .iota_sdk import *
 from .client.client import Client, NodeIndexerAPI, ClientError
 from .client._high_level_api import GenerateAddressesOptions, GenerateAddressOptions
+from .external import *
 from .utils import Utils
 from .wallet.wallet import Wallet, Account
 from .wallet.common import WalletError
-from .wallet.sync_options import AccountSyncOptions, AliasSyncOptions, NftSyncOptions, SyncOptions
+from .wallet.sync_options import AccountSyncOptions, NftSyncOptions, SyncOptions
 from .secret_manager.secret_manager import *
 from .prefix_hex import *
 from .types.address import *

bindings/python/iota_sdk/client/_high_level_api.py

@@ -1,14 +1,14 @@
 # Copyright 2023 IOTA Stiftung
 # SPDX-License-Identifier: Apache-2.0
 
-from iota_sdk.secret_manager.secret_manager import LedgerNanoSecretManager, MnemonicSecretManager, StrongholdSecretManager, SeedSecretManager
+from typing import List, Optional, Union
+from abc import ABCMeta, abstractmethod
+from dacite import from_dict
 from iota_sdk.types.block import Block
-from iota_sdk.types.common import HexStr
+from iota_sdk.types.common import CoinType, HexStr
 from iota_sdk.types.output import OutputWithMetadata
 from iota_sdk.types.output_id import OutputId
-from iota_sdk.types.common import CoinType
-from typing import List, Optional, Union
-from dacite import from_dict
+from iota_sdk.secret_manager.secret_manager import LedgerNanoSecretManager, MnemonicSecretManager, StrongholdSecretManager, SeedSecretManager
 
 
 class Range:
@@ -50,8 +50,9 @@ class GenerateAddressesOptions():
         options: An instance of `GenerateAddressOptions`.
     """
 
+    # pylint: disable=redefined-builtin
     def __init__(self, coinType: CoinType,
-                 range: range,
+                 range: Range,
                  bech32Hrp: str,
                  accountIndex: Optional[int] = None,
                  options: Optional[GenerateAddressOptions] = None):
@@ -65,12 +66,14 @@ def __init__(self, coinType: CoinType,
             options: An instance of `GenerateAddressOptions`.
         """
         self.coinType = coinType
-        self.range = Range(range.start, range.stop)
+        self.range = range
         self.bech32Hrp = bech32Hrp
         self.accountIndex = accountIndex
         self.options = options
 
     def as_dict(self):
+        """Converts this object to a dict.
+        """
         config = {k: v for k, v in self.__dict__.items() if v is not None}
 
         config["range"] = config["range"].__dict__
@@ -79,10 +82,31 @@ def as_dict(self):
         return config
 
 
-class HighLevelAPI():
+class HighLevelAPI(metaclass=ABCMeta):
     """High level API.
     """
 
+    @abstractmethod
+    def _call_method(self, name, data=None):
+        """
+        Sends a message to the Rust library and returns the response.
+        It is abstract here as its implementation is located in `client.py`, which is a composite class.
+
+        Arguments:
+
+        * `name`: The `name` parameter is a string that represents the name of the method to be called.
+        It is used to identify the specific method to be executed in the Rust library.
+        * `data`: The `data` parameter is an optional parameter that represents additional data to be
+        sent along with the method call. It is a dictionary that contains key-value pairs of data. If
+        the `data` parameter is provided, it will be included in the `message` dictionary as the 'data'
+        key.
+
+        Returns:
+
+        The method returns either the payload from the JSON response or the entire response if there is
+        no payload.
+        """
+
     def get_outputs(
             self, output_ids: List[OutputId]) -> List[OutputWithMetadata]:
         """Fetch OutputWithMetadata from provided OutputIds (requests are sent in parallel).

bindings/python/iota_sdk/client/_node_core_api.py

@@ -1,21 +1,44 @@
 # Copyright 2023 IOTA Stiftung
 # SPDX-License-Identifier: Apache-2.0
 
+from typing import List, Union
+from abc import ABCMeta, abstractmethod
+from dacite import from_dict
+
 from iota_sdk.types.block import Block, BlockMetadata
 from iota_sdk.types.common import HexStr
 from iota_sdk.types.node_info import NodeInfo, NodeInfoWrapper
 from iota_sdk.types.output import OutputWithMetadata, OutputMetadata
 from iota_sdk.types.output_id import OutputId
 from iota_sdk.types.payload import MilestonePayload
 from iota_sdk.types.utxo_changes import UtxoChanges
-from typing import List, Union
-from dacite import from_dict
 
 
-class NodeCoreAPI():
+class NodeCoreAPI(metaclass=ABCMeta):
     """Node core API.
     """
 
+    @abstractmethod
+    def _call_method(self, name, data=None):
+        """
+        Sends a message to the Rust library and returns the response.
+        It is abstract here as its implementation is located in `client.py`, which is a composite class.
+
+        Arguments:
+
+        * `name`: The `name` parameter is a string that represents the name of the method to be called.
+        It is used to identify the specific method to be executed in the Rust library.
+        * `data`: The `data` parameter is an optional parameter that represents additional data to be
+        sent along with the method call. It is a dictionary that contains key-value pairs of data. If
+        the `data` parameter is provided, it will be included in the `message` dictionary as the 'data'
+        key.
+
+        Returns:
+
+        The method returns either the payload from the JSON response or the entire response if there is
+        no payload.
+        """
+
     def get_health(self, url: str):
         """ Get node health.
 

bindings/python/iota_sdk/client/_node_indexer_api.py

@@ -1,14 +1,32 @@
 # Copyright 2023 IOTA Stiftung
 # SPDX-License-Identifier: Apache-2.0
 
-from iota_sdk.types.common import HexStr
-from iota_sdk.types.output_id import OutputId
 from dataclasses import dataclass
 from typing import Dict, Optional
+from abc import ABCMeta, abstractmethod
 import humps
 
+from iota_sdk.types.common import HexStr
+from iota_sdk.types.output_id import OutputId
+
+
+class OutputIdsResponse:
+    """Response type for output IDs.
+
+    Attributes:
+        ledger_index: The ledger index for which the response is valid.
+        cursor: The cursor to the next page of results.
+        items: The query results.
+    """
+
+    def __init__(self, output_dict: Dict):
+        self.ledgerIndex = output_dict["ledgerIndex"]
+        self.cursor = output_dict["cursor"]
+        self.items = [OutputId.from_string(
+            output_id) for output_id in output_dict["items"]]
+
 
-class NodeIndexerAPI():
+class NodeIndexerAPI(metaclass=ABCMeta):
     """Node indexer API.
     """
 
@@ -23,48 +41,48 @@ class QueryParameters:
             Filter foundry outputs based on bech32-encoded address of the controlling alias.
         created_after :
             Returns outputs that were created after a certain Unix timestamp.
-         created_before :
+            created_before :
             Returns outputs that were created before a certain Unix timestamp.
-         cursor :
+            cursor :
             Starts the search from the cursor (confirmationMS+outputId.pageSize).
-         expiration_return_address :
+            expiration_return_address :
             Filters outputs based on the presence of a specific Bech32-encoded return address in the expiration unlock
             condition.
-         expires_after :
+            expires_after :
             Returns outputs that expire after a certain Unix timestamp.
-         expires_before :
+            expires_before :
             Returns outputs that expire before a certain Unix timestamp.
-         governor :
+            governor :
             Filters outputs based on bech32-encoded governor (governance controller) address.
-         has_expiration :
+            has_expiration :
             Filters outputs based on the presence of expiration unlock condition.
-         has_native_tokens :
+            has_native_tokens :
             Filters outputs based on the presence of native tokens.
-         has_storage_deposit_return :
+            has_storage_deposit_return :
             Filters outputs based on the presence of storage deposit return unlock condition.
-         has_timelock :
+            has_timelock :
             Filters outputs based on the presence of timelock unlock condition.
-         issuer:
+            issuer:
             Filters outputs based on bech32-encoded issuer address.
-         max_native_token_count :
+            max_native_token_count :
             Filters outputs that have at most a certain number of distinct native tokens.
-         min_native_token_count :
+            min_native_token_count :
             Filters outputs that have at least a certain number of distinct native tokens.
-         page_size :
+            page_size :
             The maximum amount of items returned in one call. If there are more items, a cursor to the next page is
             returned too. The parameter is ignored when pageSize is defined via the cursor parameter.
-         sender :
+            sender :
             Filters outputs based on the presence of validated Sender (bech32 encoded).
-         state_controller :
+            state_controller :
             Filters outputs based on bech32-encoded state controller address.
-         storage_deposit_return_address :
+            storage_deposit_return_address :
             Filters outputs based on the presence of a specific return address in the storage deposit return unlock
             condition.
-         tag :
+            tag :
             Filters outputs based on matching Tag Block.
-         timelocked_after :
+            timelocked_after :
             Returns outputs that are timelocked after a certain Unix timestamp.
-         timelocked_before :
+            timelocked_before :
             Returns outputs that are timelocked before a certain Unix timestamp.
          unlockable_by_address :
             Returns outputs that are unlockable by the bech32 address.
@@ -95,23 +113,31 @@ class QueryParameters:
         unlockable_by_address: Optional[str] = None
 
         def as_dict(self):
+            """Converts this object to a dict.
+            """
             return humps.camelize(
                 [{k: v} for k, v in self.__dict__.items() if v is not None])
 
-    class OutputIdsResponse:
-        """Response type for output IDs.
-
-        Attributes:
-            ledger_index: The ledger index for which the response is valid.
-            cursor: The cursor to the next page of results.
-            items: The query results.
+    @abstractmethod
+    def _call_method(self, name, data=None):
         """
+        Sends a message to the Rust library and returns the response.
+        It is abstract here as its implementation is located in `client.py`, which is a composite class.
+
+        Arguments:
 
-        def __init__(self, dict: Dict):
-            self.ledgerIndex = dict["ledgerIndex"]
-            self.cursor = dict["cursor"]
-            self.items = [OutputId.from_string(
-                output_id) for output_id in dict["items"]]
+        * `name`: The `name` parameter is a string that represents the name of the method to be called.
+        It is used to identify the specific method to be executed in the Rust library.
+        * `data`: The `data` parameter is an optional parameter that represents additional data to be
+        sent along with the method call. It is a dictionary that contains key-value pairs of data. If
+        the `data` parameter is provided, it will be included in the `message` dictionary as the 'data'
+        key.
+
+        Returns:
+
+        The method returns either the payload from the JSON response or the entire response if there is
+        no payload.
+        """
 
     def output_ids(
             self, query_parameters: QueryParameters) -> OutputIdsResponse:
@@ -127,7 +153,7 @@ def output_ids(
         response = self._call_method('outputIds', {
             'queryParameters': query_parameters_camelized,
         })
-        return self.OutputIdsResponse(response)
+        return OutputIdsResponse(response)
 
     def basic_output_ids(
             self, query_parameters: QueryParameters) -> OutputIdsResponse:
@@ -142,7 +168,7 @@ def basic_output_ids(
         response = self._call_method('basicOutputIds', {
             'queryParameters': query_parameters_camelized,
         })
-        return self.OutputIdsResponse(response)
+        return OutputIdsResponse(response)
 
     def alias_output_ids(
             self, query_parameters: QueryParameters) -> OutputIdsResponse:
@@ -157,7 +183,7 @@ def alias_output_ids(
         response = self._call_method('aliasOutputIds', {
             'queryParameters': query_parameters_camelized,
         })
-        return self.OutputIdsResponse(response)
+        return OutputIdsResponse(response)
 
     def alias_output_id(self, alias_id: HexStr) -> OutputId:
         """Fetch alias output ID from the given alias ID.
@@ -182,7 +208,7 @@ def nft_output_ids(
         response = self._call_method('nftOutputIds', {
             'queryParameters': query_parameters_camelized,
         })
-        return self.OutputIdsResponse(response)
+        return OutputIdsResponse(response)
 
     def nft_output_id(self, nft_id: HexStr) -> OutputId:
         """Fetch NFT output ID from the given NFT ID.
@@ -207,7 +233,7 @@ def foundry_output_ids(
         response = self._call_method('foundryOutputIds', {
             'queryParameters': query_parameters_camelized,
         })
-        return self.OutputIdsResponse(response)
+        return OutputIdsResponse(response)
 
     def foundry_output_id(self, foundry_id: HexStr) -> OutputId:
         """Fetch foundry Output ID from the given foundry ID.