[Good First Issue]: Implement `__repr__` Method for `TokenId` Class

[cheese-cakee]

🆕🐥 Newcomer Friendly

This Good First Issue is a guided, well-scoped task intended for new contributors to the Hiero Python SDK.

What you'll do

• ✅ understand how the repository is structured
• ✅ practice the standard contribution workflow
• ✅ submit and merge a pull request

Support

A maintainer or mentor actively monitors this issue and will help guide it to completion.

Important

This issue does not require prior domain knowledge.

• No Hiero or Hedera experience needed
• No distributed ledger background required
• Basic Python and Git are sufficient

Note

⏱️ Typical time to complete: 30–60 minutes (once setup is done)
🧩 Difficulty: Small, well-contained change
🎓 Best for: New contributors

🏁 Completion
When this issue is complete, you will have:

• ✅ Solved a real issue
• ✅ A merged pull request in the Hiero Python SDK
• ✅ Your name in the project history
• ✅ Confidence to take on larger issues next

---

👾 Description of the issue

The TokenId class in src/hiero_sdk_python/tokens/token_id.py has a __str__ method that returns shard.realm.num format, but it lacks a custom __repr__ method. The default dataclass __repr__ is used, which shows all fields including checksum=None even when not relevant.

When debugging, a clearer __repr__ that shows the constructor-style call would be more helpful:

>>> token_id = TokenId(0, 0, 123)
>>> repr(token_id)
# Current (default dataclass): "TokenId(shard=0, realm=0, num=123, checksum=None)"
# Desired: "TokenId(shard=0, realm=0, num=123)"

---

💡 Proposed Solution

Implement a custom __repr__() method for the TokenId class that returns a clear, constructor-style representation. The checksum should not be shown (it's an internal detail).

---

👩‍💻 Implementation Steps

• Open the file src/hiero_sdk_python/tokens/token_id.py

• Review the existing __str__() method to understand the current formatting

• Review the dataclass fields: shard, realm, num, checksum

• Add a new __repr__() method after the existing __str__() method (around line 172):

  def __repr__(self) -> str:
      """
      Returns a detailed representation of the TokenId suitable for debugging.
  
      Returns:
          str: A string in constructor format 'TokenId(shard=X, realm=Y, num=Z)'.
      """
      return f"TokenId(shard={self.shard}, realm={self.realm}, num={self.num})"

• Write a unit test for the new __repr__() method:

  def test_token_id_repr():
      token_id = TokenId(0, 0, 123)
      assert repr(token_id) == "TokenId(shard=0, realm=0, num=123)"

• Run the tests to verify everything works: uv run pytest tests/

---

✅ Acceptance Criteria

• The issue is solved:
  My changes do exactly what the issue asked for.

• I did not add extra changes:
  I did not modify anything that was not mentioned in the issue description.

• Nothing else was broken:
  All existing features still work the same as before.

• All checks pass:
  The automated tests (unit and integration tests) run successfully.

---

📋 Step-by-Step Contribution Guide

• Assignment: You must be assigned to the issue, comment: /assign in the issue to get assigned see guide
• Fork, Branch and Work on the issue: Create a copy of the repository, create a branch for the issue and solve the problem. For instructions, please read our Contributing guide file. Further help can be found at Set-up Training (including the Windows Setup Guide for Windows users) and Workflow Training.
• DCO and GPG key sign each commit : each commit must be -s and -S signed. An explanation on how to do this is at Signing Guide
• Add a Changelog Entry : your pull request will require a changelog. Read Changelog Entry Guide to learn how.
• Push and Create a Pull Request : Once your issue is resolved, and your commits are signed, and you have a changelog entry, push your changes and create a pull request. Detailed instructions can be found at Submit PR Training, part of Workflow Training.
• You did it 🎉: A maintainer or committer will review your pull request and provide feedback. If approved, we will merge the fix in the main branch. Thanks for being part of the Hiero community as an open-source contributor ❤️

IMPORTANT You will ONLY be assigned to the issue if you comment: /assign
IMPORTANT Your pull request CANNOT BE MERGED until you add a changelog entry AND sign your commits each with git commit -S -s -m "chore: your commit message" with a GPG key setup.

---

🤖 AI Usage Guidelines

You are welcome to use AI to help you understand and solve this issue.

Because AI tools can sometimes make mistakes, please take care to:

• Only implement what is described in this issue
• Avoid changing anything else in the file
• Be careful when modifying parameters or return statements, as this may affect runtime behavior

If you're unsure, ask your mentor or the maintainers for help — they can provide expert Python SDK guidance and point you to the right examples or methods.

---

🤔 Additional Information

For more help, we have extensive documentation:

• SDK Developer Docs
• SDK Developer Training

Additionally, we invite you to join our community on our Discord server.

We also invite you to attend each Wednesday, 2pm UTC our Python SDK Office Hour and Community Calls. The Python SDK Office hour is for hands-on-help and the Community Call for general community discussion.

You can also ask for help in a comment below!

[cnaples79]

/assign

[github-actions]

👋 Hi @cnaples79, welcome to the Hiero Python SDK community!

You've been assigned this Good First Issue. Your on-call mentor today from @hiero-ledger/hiero-sdk-python-triage is @exploreriii, and the Good First Issue Support Team is @hiero-ledger/hiero-sdk-good-first-issue-support.
We’re here to help you get your first PR merged successfully 🚀

---

Step 1: Read the task

• Open the issue description, carefully read the requirements and workflow
• Read any linked documentation
• Make sure you understand the expected outcome
  If anything is unclear, ask your mentor before writing code.

---

Step 2: Tell us your plan (in this thread)

Reply here with:

• What you think the task is
• What you plan to change to solve the issue requirement and no more
• Any questions you have
  This means we can guide you early on, helping you to have a more stress free experience

---

Step 3: Get the right kind of help

Finishing your first PR can be really hard. We are here to help you - please ask us!

🛠 Good First Issue Support Team (@hiero-ledger/hiero-sdk-good-first-issue-support)
Use them for workflow and GitHub issues, such as:

• Failing CI checks
• Commit signing problems
• Merge conflicts
• Git/GitHub errors
  They can also jump on a call if needed.

🐍 Your Mentor (@exploreriii)
Use your mentor for Python and code guidance, such as:

• Which files to edit
• How to structure your solution
• Docstring and code style questions
• Making sure your PR meets the issue requirements

💬 Discord (for fast help)
Guide: Join the Python SDK Discord
Use Discord when you need immediate answers from the community, like:

• What docs to read
• How to unblock yourself quickly
• Clarifying next steps in real time

---

Mentor: @exploreriii
Mentee: @cnaples79
If you're enjoying the SDK, consider ⭐️ starring the repository so it's easy to find later.
Happy building!
— Python SDK Team

[github-actions]

@coderabbitai plan

[coderabbitai]

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Fetch the details of issue `#1653`
gh issue view 1653 --json title,body,labels,url,comments

Length of output: 11378

---

🏁 Script executed:

#!/bin/bash
# Read the TokenId class file to see current implementation
cat src/hiero_sdk_python/tokens/token_id.py

Length of output: 5968

---

🏁 Script executed:

#!/bin/bash
# Find and read the test file for TokenId
fd -t f "test.*token_id" tests/

Length of output: 0

---

🏁 Script executed:

#!/bin/bash
# Search for existing TokenId tests in the codebase
rg -n "TokenId" tests/ -C2 --type=py | head -50

# Also check the tests directory structure
echo "=== Tests directory structure ==="
tree tests/ -L 3 -I "__pycache__|*.pyc"

Length of output: 10665

---

🏁 Script executed:

#!/bin/bash
# Read the existing TokenId test file
cat tests/unit/token_id_test.py

Length of output: 2158

---

@github-actions[bot], here's a comprehensive implementation plan for issue #1653:

📋 Implementation Plan for Issue #1653

🎯 Task Summary

Implement a custom __repr__() method for the TokenId class that returns a clean, constructor-style representation without showing the internal checksum field.

---

📝 Step-by-Step Implementation

Phase 1: Understand the Current State1. Review the TokenId class in src/hiero_sdk_python/tokens/token_id.py:

• Current implementation: The class is a frozen dataclass with fields shard, realm, num, and checksum
• The __repr__() method returns the official string representation aimed at programmers for development and debugging
• The __str__() method returns the informal string representation aimed at the user
• The file currently has __str__() method (line 172) but relies on dataclass default __repr__()

2. Current behavior issue:
   • Default dataclass __repr__ shows: TokenId(shard=0, realm=0, num=123, checksum=None)
   • The checksum=None is displayed even when not relevant
   • Desired: TokenId(shard=0, realm=0, num=123) (cleaner for debugging)

---

Phase 2: Implementation Steps

Step 2.1: Add the __repr__() method

Open src/hiero_sdk_python/tokens/token_id.py and add the following method after the existing __str__() method (after line 172):

def __repr__(self) -> str:
    """
    Returns a detailed representation of the TokenId suitable for debugging.

    Returns:
        str: A string in constructor format 'TokenId(shard=X, realm=Y, num=Z)'.
    """
    return f"TokenId(shard={self.shard}, realm={self.realm}, num={self.num})"

Step 2.2: Add a unit test

Open tests/unit/token_id_test.py and add the following test function at the end of the file:

def test_token_id_repr():
    """Should return constructor-style representation without checksum."""
    token_id = TokenId(0, 0, 123)
    assert repr(token_id) == "TokenId(shard=0, realm=0, num=123)"
    
    # Test with different values
    token_id2 = TokenId(1, 2, 456)
    assert repr(token_id2) == "TokenId(shard=1, realm=2, num=456)"

---

Phase 3: Verification

Step 3.1: Run the tests

# Run only the TokenId tests
uv run pytest tests/unit/token_id_test.py -v

# Or run all tests
uv run pytest tests/

Step 3.2: Verify your implementation manually (optional)

You can test it in a Python shell:

from hiero_sdk_python.tokens.token_id import TokenId

token_id = TokenId(0, 0, 123)
print(repr(token_id))  # Should output: TokenId(shard=0, realm=0, num=123)
print(str(token_id))   # Should output: 0.0.123

---

Phase 4: Pull Request Submission

Once all tests pass:

1. Add a changelog entry (see Changelog Entry Guide)
2. Sign your commits: git commit -S -s -m "feat: implement __repr__ for TokenId class"
3. Push your branch and create a pull request
4. Reference issue #1653 in your PR description

---

✅ Expected Outcome

After implementation:

• ✅ repr(TokenId(0, 0, 123)) returns "TokenId(shard=0, realm=0, num=123)"
• ✅ The checksum field is not shown in the repr output
• ✅ All existing tests continue to pass
• ✅ New test validates the __repr__() behavior

---

📚 Key Guidelines

DO:

• ✅ Only add the __repr__() method as specified
• ✅ Follow the exact format shown in the issue
• ✅ Add the unit test as described
• ✅ Ensure all tests pass before submitting PR

DON'T:

• ❌ Modify any other methods or classes
• ❌ Change the __str__() method
• ❌ Add extra features not mentioned in the issue
• ❌ Modify the dataclass structure or fields

---

🆘 Getting Help

• Code questions: Tag your mentor @exploreriii
• Workflow issues: Tag @hiero-ledger/hiero-sdk-good-first-issue-support
• Quick help: Join Discord

---

Good luck with your first contribution, @cnaples79! 🚀 This is a well-defined task that will help you get familiar with the codebase and contribution workflow. Don't hesitate to ask questions if anything is unclear!

[github-actions]

Hello, this is CommunityCallBot.

This is a reminder that the Hiero Python SDK Community Call will begin in approximately 4 hours (14:00 UTC).

The call is an open forum where contributors and users can discuss topics, raise issues, and influence the direction of the Python SDK.

Details:

• Time: 14:00 UTC
• Join Link: Zoom Meeting

Disclaimer: This is an automated reminder. Please verify the schedule here for any changes.

[Rajsinha7]

/assign

[github-actions]

Hi @Rajsinha7 — this issue is already assigned to @cnaples79, so I can’t assign it again.

👉 Choose a different Good First Issue to work on next:
Browse unassigned Good First Issues

Once you find one you like, comment /assign to get started.