chore: resolve pylint issues in /consensus module (#278)

* feat: resolve linting issues and formatting

Signed-off-by: harshadsutar <[email protected]>

* chore:linting topic_create_transaction

Signed-off-by: harshadsutar <[email protected]>

* fix : rename .env.example filename

Signed-off-by: harshadsutar <[email protected]>

---------

Signed-off-by: harshadsutar <[email protected]>

Author: harshadsutar

CHANGELOG.md

@@ -23,6 +23,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
 
 ### Fixed
 - missing ECDSA support in query.py and contract_create_transaction.py (was only creating ED25519 keys)
+- Applied linting and code formatting across the consensus module
 
 
 ### Breaking API changes

generate_proto.sh

@@ -3,6 +3,7 @@
 # Source the activate script to set up the PATH for this shell session
 source ./.venv/bin/activate
 
+
 hapi_version="v0.57.3"
 protos_dir=".protos"
 services_dir="src/hiero_sdk_python/hapi/services"

src/hiero_sdk_python/consensus/topic_create_transaction.py

@@ -1,20 +1,39 @@
-from typing import Union
+"""
+This module defines the TopicCreateTransaction class for creating topics
+on the Hedera Consensus Service (HCS) using the Hiero Python SDK.
+
+It provides methods to set properties such as memo, admin key, submit key,
+auto-renew period, and auto-renew account, and to build the protobuf
+transaction body for submission to the Hedera network .
+"""
 
+from typing import Union
 from hiero_sdk_python.Duration import Duration
 from hiero_sdk_python.transaction.transaction import Transaction
-from hiero_sdk_python.hapi.services import consensus_create_topic_pb2, transaction_body_pb2, basic_types_pb2
+from hiero_sdk_python.hapi.services import (
+    consensus_create_topic_pb2,
+    transaction_body_pb2,
+    basic_types_pb2)
 from hiero_sdk_python.channels import _Channel
 from hiero_sdk_python.executable import _Method
 from hiero_sdk_python.account.account_id import AccountId
 
+
 class TopicCreateTransaction(Transaction):
+    """
+        Represents a transaction to create a new topic in the Hedera
+        Consensus Service (HCS).
+
+        This transaction can optionally define an admin key, submit key,
+        auto-renew period, auto-renew account, and memo.
+    """
     def __init__(
-        self,
-        memo: str = None,
-        admin_key: basic_types_pb2.Key = None,
-        submit_key: basic_types_pb2.Key = None,
-        auto_renew_period: Duration = None,
-        auto_renew_account: AccountId = None
+            self,
+            memo: str = None,
+            admin_key: basic_types_pb2.Key = None,
+            submit_key: basic_types_pb2.Key = None,
+            auto_renew_period: Duration = None,
+            auto_renew_account: AccountId = None
     ) -> None:
         """
         Initializes a new instance of the TopicCreateTransaction class.
@@ -69,7 +88,7 @@ def set_submit_key(self, key: basic_types_pb2.Key) -> "TopicCreateTransaction":
         self.submit_key = key
         return self
 
-    def set_auto_renew_period(self, seconds: Union[Duration,int]) -> "TopicCreateTransaction":
+    def set_auto_renew_period(self, seconds: Union[Duration, int]) -> "TopicCreateTransaction":
         """
         Sets the auto-renew period for the topic creation transaction.
         Args:
@@ -110,14 +129,28 @@ def build_transaction_body(self):
         Raises:
             ValueError: If required fields are missing.
         """
-        transaction_body: transaction_body_pb2.TransactionBody = self.build_base_transaction_body()
-        transaction_body.consensusCreateTopic.CopyFrom(consensus_create_topic_pb2.ConsensusCreateTopicTransactionBody(
-            adminKey=self.admin_key._to_proto() if self.admin_key is not None else None,
-            submitKey=self.submit_key._to_proto() if self.submit_key is not None else None,
-            autoRenewPeriod=self.auto_renew_period._to_proto() if self.auto_renew_period is not None else None,
-            autoRenewAccount=self.auto_renew_account._to_proto() if self.auto_renew_account is not None else None,
-            memo=self.memo
-        ))
+        transaction_body: transaction_body_pb2.TransactionBody = (
+            self.build_base_transaction_body())
+        transaction_body.consensusCreateTopic.CopyFrom(
+            consensus_create_topic_pb2.ConsensusCreateTopicTransactionBody(
+                adminKey=(
+                    self.admin_key._to_proto()
+                    if self.admin_key is not None
+                    else None),
+                submitKey=(
+                    self.submit_key._to_proto()
+                    if self.submit_key is not None
+                    else None),
+                autoRenewPeriod=(
+                    self.auto_renew_period._to_proto()
+                    if self.auto_renew_period is not None
+                    else None),
+                autoRenewAccount=(
+                    self.auto_renew_account._to_proto()
+                    if self.auto_renew_account is not None
+                    else None),
+                memo=self.memo
+            ))
 
         return transaction_body
 

src/hiero_sdk_python/consensus/topic_delete_transaction.py

@@ -1,9 +1,28 @@
+"""
+This module provides the `TopicDeleteTransaction` class for deleting consensus topics
+on the Hedera network using the Hiero SDK.
+
+It handles setting the target topic ID, building the protobuf transaction body, and
+defining the execution method required to perform the deletion transaction.
+"""
+
+
 from hiero_sdk_python.transaction.transaction import Transaction
-from hiero_sdk_python.hapi.services import consensus_delete_topic_pb2, transaction_body_pb2, basic_types_pb2
+from hiero_sdk_python.hapi.services import (
+    consensus_delete_topic_pb2,
+    transaction_body_pb2,
+    basic_types_pb2
+)
 from hiero_sdk_python.channels import _Channel
 from hiero_sdk_python.executable import _Method
 
+
 class TopicDeleteTransaction(Transaction):
+    """
+        Represents a transaction to delete an existing topic in the Hedera
+        Consensus Service (HCS).
+
+    """
     def __init__(self, topic_id: basic_types_pb2.TopicID = None):
         super().__init__()
         self.topic_id: basic_types_pb2.TopicID = topic_id
@@ -35,9 +54,9 @@ def build_transaction_body(self) -> transaction_body_pb2.TransactionBody:
         """
         if self.topic_id is None:
             raise ValueError("Missing required fields: topic_id")
-    
         transaction_body: transaction_body_pb2.TransactionBody = self.build_base_transaction_body()
-        transaction_body.consensusDeleteTopic.CopyFrom(consensus_delete_topic_pb2.ConsensusDeleteTopicTransactionBody(
+        transaction_body.consensusDeleteTopic.CopyFrom(
+            consensus_delete_topic_pb2.ConsensusDeleteTopicTransactionBody(
             topicID=self.topic_id._to_proto()
         ))
 
@@ -54,4 +73,4 @@ def _get_method(self, channel: _Channel) -> _Method:
         return _Method(
             transaction_func=channel.topic.deleteTopic,
             query_func=None
-        )
+        )

src/hiero_sdk_python/consensus/topic_id.py

@@ -1,6 +1,23 @@
+"""
+This module defines the `TopicId` class, a utility for working with Hedera
+Consensus Service (HCS) topic identifiers.
+
+It provides methods for converting between protobuf `TopicID` objects and
+string representations, making it easier to work with topics in different
+formats within the Hiero SDK.
+"""
+
 from hiero_sdk_python.hapi.services import basic_types_pb2
 
 class TopicId:
+
+    """
+    Represents the unique identifier of a topic in the Hedera Consensus Service (HCS).
+
+    A `TopicId` consists of three components: shard, realm, and num.
+    This class provides convenient methods for converting between Python objects,
+    protobuf `TopicID` instances, and string formats.
+    """
     def __init__(self, shard: int = 0, realm: int = 0, num: int = 0) -> None:
         """
         Initializes a new instance of the TopicId class.
@@ -48,4 +65,4 @@ def from_string(cls, topic_id_str) -> "TopicId":
         parts = topic_id_str.strip().split('.')
         if len(parts) != 3:
             raise ValueError("Invalid TopicId format. Expected 'shard.realm.num'")
-        return cls(shard=int(parts[0]), realm=int(parts[1]), num=int(parts[2]))
+        return cls(shard=int(parts[0]), realm=int(parts[1]), num=int(parts[2]))

src/hiero_sdk_python/consensus/topic_info.py

@@ -1,23 +1,39 @@
+"""
+This module provides the `TopicInfo` class for representing consensus topic
+metadata on the Hedera network using the Hiero SDK.
+
+It handles constructing the object from a protobuf message, formatting
+optional fields, and providing a readable string representation of the
+topic state.
+"""
 from datetime import datetime
+from typing import Optional
 from hiero_sdk_python.hapi.services.basic_types_pb2 import Key, AccountID
 from hiero_sdk_python.hapi.services.timestamp_pb2 import Timestamp
 from hiero_sdk_python.hapi.services import consensus_topic_info_pb2
 from hiero_sdk_python.Duration import Duration
 from hiero_sdk_python.utils.key_format import format_key
-from typing import Optional
+
 
 class TopicInfo:
+    """
+        Represents consensus topic information on the Hedera network.
+
+        It wraps the `ConsensusTopicInfo` protobuf message, exposing attributes
+        such as memo, running hash, sequence number, expiration time, admin key,
+        submit key, auto-renewal configuration, and ledger ID.
+    """
     def __init__(
-        self,
-        memo: str,
-        running_hash: bytes,
-        sequence_number: int,
-        expiration_time: Timestamp,
-        admin_key: Optional[Key],
-        submit_key: Optional[Key],
-        auto_renew_period: Optional[Duration],
-        auto_renew_account: Optional[AccountID],
-        ledger_id: Optional[bytes],
+            self,
+            memo: str,
+            running_hash: bytes,
+            sequence_number: int,
+            expiration_time: Timestamp,
+            admin_key: Optional[Key],
+            submit_key: Optional[Key],
+            auto_renew_period: Optional[Duration],
+            auto_renew_account: Optional[AccountID],
+            ledger_id: Optional[bytes],
 
     ) -> None:
         """
@@ -44,7 +60,10 @@ def __init__(
         self.ledger_id: bytes = ledger_id
 
     @classmethod
-    def _from_proto(cls, topic_info_proto: consensus_topic_info_pb2.ConsensusTopicInfo) -> "TopicInfo":
+    def _from_proto(
+            cls,
+            topic_info_proto: consensus_topic_info_pb2.ConsensusTopicInfo
+    ) -> "TopicInfo":
         """
         Constructs a TopicInfo object from a protobuf ConsensusTopicInfo message.
         """
@@ -53,26 +72,27 @@ def _from_proto(cls, topic_info_proto: consensus_topic_info_pb2.ConsensusTopicIn
             running_hash=topic_info_proto.runningHash,
             sequence_number=topic_info_proto.sequenceNumber,
             expiration_time=(
-                topic_info_proto.expirationTime 
+                topic_info_proto.expirationTime
                 if topic_info_proto.HasField("expirationTime") else None
             ),
             admin_key=(
-                topic_info_proto.adminKey 
+                topic_info_proto.adminKey
                 if topic_info_proto.HasField("adminKey") else None
             ),
             submit_key=(
-                topic_info_proto.submitKey 
+                topic_info_proto.submitKey
                 if topic_info_proto.HasField("submitKey") else None
             ),
             auto_renew_period=(
                 Duration._from_proto(proto=topic_info_proto.autoRenewPeriod)
                 if topic_info_proto.HasField("autoRenewPeriod") else None
             ),
             auto_renew_account=(
-                topic_info_proto.autoRenewAccount 
+                topic_info_proto.autoRenewAccount
                 if topic_info_proto.HasField("autoRenewAccount") else None
             ),
-            ledger_id=getattr(topic_info_proto, "ledger_id", None),  # fallback if the field doesn't exist
+            ledger_id=getattr(topic_info_proto, "ledger_id", None),
+            # fallback if the field doesn't exist
         )
 
     def __repr__(self) -> str:
@@ -89,7 +109,7 @@ def __str__(self) -> str:
         exp_dt: datetime = None
         if self.expiration_time and hasattr(self.expiration_time, "seconds"):
             exp_dt = datetime.fromtimestamp(self.expiration_time.seconds)
-            
+
         running_hash_hex: str = self.running_hash.hex() if self.running_hash else None
         ledger_id_hex: Optional[str] = (
             self.ledger_id.hex() if isinstance(self.ledger_id, (bytes, bytearray)) else None

src/hiero_sdk_python/consensus/topic_message.py

@@ -1,6 +1,10 @@
+"""
+This module provides the `TopicMessage` and `TopicMessageChunk` classes for handling
+Hedera Consensus Service topic messages using the Hiero SDK.
+"""
+
 from datetime import datetime
 from typing import Optional, List, Union, Dict
-
 from hiero_sdk_python import Timestamp
 from hiero_sdk_python.hapi.mirror import consensus_service_pb2 as mirror_proto
 
@@ -17,22 +21,25 @@ def __init__(self, response: mirror_proto.ConsensusTopicResponse) -> None:
         Args:
             response: The ConsensusTopicResponse containing chunk data.
         """
-        self.consensus_timestamp: datetime = Timestamp._from_protobuf(response.consensusTimestamp).to_date()
+        self.consensus_timestamp: datetime = Timestamp._from_protobuf(
+            response.consensusTimestamp
+        ).to_date()
         self.content_size: int = len(response.message)
         self.running_hash: Union[bytes, int] = response.runningHash
         self.sequence_number: Union[bytes, int] = response.sequenceNumber
 
+
 class TopicMessage:
     """
     Represents a Hedera TopicMessage, possibly composed of multiple chunks.
     """
 
     def __init__(
-        self,
-        consensus_timestamp: datetime,
-        message_data: Dict[str, Union[bytes, int]],
-        chunks: List[TopicMessageChunk],
-        transaction_id: Optional[str] = None,
+            self,
+            consensus_timestamp: datetime,
+            message_data: Dict[str, Union[bytes, int]],
+            chunks: List[TopicMessageChunk],
+            transaction_id: Optional[str] = None,
     ) -> None:
         """
         Args:
@@ -100,9 +107,9 @@ def of_many(cls, responses: List[mirror_proto.ConsensusTopicResponse]) -> "Topic
             total_size += len(r.message)
 
             if (
-                transaction_id is None
-                and r.HasField("chunkInfo")
-                and r.chunkInfo.HasField("initialTransactionID")
+                    transaction_id is None
+                    and r.HasField("chunkInfo")
+                    and r.chunkInfo.HasField("initialTransactionID")
             ):
                 tx_id = r.chunkInfo.initialTransactionID
                 transaction_id = (
@@ -135,9 +142,12 @@ def of_many(cls, responses: List[mirror_proto.ConsensusTopicResponse]) -> "Topic
 
     @classmethod
     def _from_proto(
-        cls,
-        response_or_responses: Union[mirror_proto.ConsensusTopicResponse, List[mirror_proto.ConsensusTopicResponse]],
-        chunking_enabled: bool = False
+            cls,
+            response_or_responses: Union[
+                mirror_proto.ConsensusTopicResponse,
+                List[mirror_proto.ConsensusTopicResponse]
+            ],
+            chunking_enabled: bool = False
     ) -> "TopicMessage":
         """
         Creates a TopicMessage from either:
@@ -159,7 +169,8 @@ def _from_proto(
         response = response_or_responses
         if chunking_enabled and response.HasField("chunkInfo") and response.chunkInfo.total > 1:
             raise ValueError(
-                "Cannot handle multi-chunk in a single response. Pass all chunk responses in a list."
+                "Cannot handle multi-chunk in a single response."
+                " Pass all chunk responses in a list."
             )
         return cls.of_single(response)