[Beginner]: Configure `Codacy` to skip `assert_used` rule in test files

[MonaaEid]

🐥 Beginner Friendly

Welcome! This Beginner Issue is designed to be a natural next step after good first issues.

It nudges you to:

• Research existing patterns
• Own more implementation decisions
• Test your changes

Difficulty:

• Requires knowledge of our workflow
• Beginner to intermediate Python and Git
• Beginner DLT/Blockchain experience

Important

We recommend completing at least 3 good first issues before attempting a beginner issue.

Tip

You should be comfortable with:

• Forking, branching, committing (with DCO + GPG signing), and opening a pull request without a tutorial
• Reading beginner Python code you did not write and following its patterns
• Handling simple merge conflicts in CHANGELOG.md
• Keeping your fork up to date with main by rebasing
• Looking things up on your own before asking for help

If any of that feels unfamiliar, good first issues might still be the most rewarding path
for you right now —
find one here.
You can always come back when you are ready.

Support: A maintainer actively monitors this issue and will help guide your implementation ideas.

⏱️ Typical time to complete: 4-6 hours
🧩 Difficulty: Manageable but requires investigation and testing
🎓 Best for: Beginner contributors

---

🏁 When this issue is complete, you will have:

✅ Improved your research abilities
✅ Improved your knowledge of the codebase
✅ Owned implementation decisions
✅ Created basic tests

👾 Description of the issue

• we have Codacy’s assert_used rule currently flags assert statements everywhere.

• In test files, this is expected usage, so we want to skip the rule for test files.

💡 Solution

Update the .codacy.yml configuration so that the assert_used rule is skipped for test files, while still enforced in production code.

🔍 Background Research

reference https://docs.python.org/3/reference/simple_stmts.html#the-assert-statement

🛠️ Implementation

Make the Change
1- Open the project root file: .codacy.yml (you can see it here in the repo )

2- Add the following configuration under the pylint engine and make sure it solves the problem:

engines:
  pylint:
    enabled: true
    rules:
      assert_used:
        skips:
          - "*_test.py"
          - "*test_*.py"

3. Add some tests to your fork that trigger these warnings.:
   1- Push your branch to your fork on GitHub.
   2- Codacy will automatically re‑run analysis on your fork.
   3- Check the Codacy dashboard/ workflow:
   • Before: test files flagged for assert usage
   • After: those warnings should disappear

🧪 Testing your changes

How you test depends on the type of change.
See the testing guide for full details.

Source code changes (e.g. Python files in src/):

• Write unit tests and run them locally: uv run pytest tests/unit/<specific_file>_test.py -v
• Integration tests will run automatically when you push to your fork or open a PR

Example script changes (e.g. files in examples/):

• Run the example script to confirm it works: instructions are at the top of each script
• You will need a Hedera Portal account for testnet credentials — see environment setup
• Example changes do not require unit or integration tests

Workflow / GitHub Actions changes (e.g. files in .github/):

• Where possible, test by merging to your fork's main and simulating the scenario (e.g. creating a test issue or PR)
• Link to any test issues or PRs you created as evidence
• See the workflow testing guide

✅ Done Checklist

Before opening your PR, confirm:

• My changes address what the issue asked for — nothing more, nothing less
• I tested my changes locally (if relevant — see testing section above)
• My commits are signed: git commit -S -s -m "chore: description" — Signing guide
• I added a CHANGELOG.md entry under [Unreleased] — Changelog guide
• All CI checks pass

📋 Workflow quick reference

You have done this before — here are the links if you need them:

Step	Guide
Claim this issue	Comment /assign below
Sync with main	Rebasing guide
Open a PR and link this issue	PR guide · Linking guide
Resolve merge conflicts	Merge conflicts guide

🤖 Tips for using AI tools

Here is how to get the most out of AI tools:

• Use Pylance in VS Code to catch errors and hallucinated methods in real time
• Build your solution in small steps — add print statements or logs to confirm each piece works before moving on
• When AI suggests code, check it against existing examples and similar classes in the SDK — that is the best source of Python SDK-specific patterns. AI sometimes borrows from other SDKs.
• If AI output and SDK patterns disagree, trust the SDK

🆘 Stuck?

Beginner issues can be tricky — it is completely normal to get blocked. Here is what to do:

• Comment on this issue and describe what you have tried. A maintainer will respond.
• Ask on Discord in #hiero-python-sdk for quick questions.
• Join Office Hours (Wednesdays, 2pm UTC) for live, hands-on help with a maintainer — screen sharing welcome.

Do not spend more than 30 minutes blocked without asking. Asking good questions is a skill too.

📚 Resources

Project references:

• Project structure
• CONTRIBUTING.md
• Browse closed beginner PRs — see how others did it

Python references:

• Python official docs
• Data model (dunder methods)
• Type hints

[github-actions]

@coderabbitai plan

[coderabbitai]

Coding Plan

Summary

• Add pylint engine to existing .codacy.yml under the engines: section alongside the existing bandit configuration
• Configure the assert_used rule to skip files matching both *_test.py and *test_*.py patterns, covering all test file naming conventions in the codebase
• Follow the exact configuration structure provided in the ticket to ensure compatibility with Codacy's expected format

Implementation Steps

Update Codacy Configuration

Add pylint engine configuration to skip assert_used rule in test files, allowing assert statements in tests while maintaining enforcement in production code.

Task 1: Add Pylint Engine Configuration to .codacy.yml

Add a new pylint engine entry to the existing Codacy configuration file that skips the assert_used rule for test files matching both naming conventions used in the codebase.

• Update .codacy.yml to add a new pylint: entry under the existing engines: section (do not create a duplicate engines: key)
• Enable the pylint engine with enabled: true
• Add a rules: section containing assert_used: with a skips: list
• Include both glob patterns in the skips list: *_test.py (primary convention, 200 files) and *test_*.py (covers the 4 outlier test_*.py files)
• Preserve the existing bandit configuration exactly as-is

Task 2: Verify Configuration and Test in Fork

Push changes and verify Codacy analysis runs correctly with the new configuration.

• Commit the change with proper signing: git commit -S -s -m "chore: configure Codacy to skip assert_used rule in test files"
• Push branch to fork and verify Codacy re-runs analysis automatically
• Check Codacy dashboard/workflow to confirm assert warnings no longer appear for test files
• Add a CHANGELOG.md entry under [Unreleased] documenting the configuration change

🤖 Prompt for AI agents

Update the `.codacy.yml` file to add a pylint engine configuration that skips
the `assert_used` rule for test files, while preserving the existing bandit
configuration.

- Open `.codacy.yml` and locate the existing `engines:` section
- Add a new `pylint:` entry inside the existing `engines:` section — do NOT
create a duplicate `engines:` key
- Under `pylint:`, set `enabled: true`
- Add a `rules:` section with an `assert_used:` key containing a `skips:` list
- The `skips:` list must include both glob patterns:
  - `*_test.py` (covers the primary naming convention, 200 files)
  - `*test_*.py` (covers the 4 outlier files using the `test_*.py` convention)
- Leave the existing bandit engine block completely unchanged
- After updating `.codacy.yml`, add an entry to `CHANGELOG.md` under the
`[Unreleased]` section documenting the configuration change

Research

The project is a Python SDK with a straightforward Codacy configuration. The .codacy.yml file currently contains only a bandit engine configuration (9 lines) that skips rule B101 (assert_used) and excludes the tests/** directory. There is no pylint engine configured yet. Test files follow two naming conventions: the dominant pattern is *_test.py (200 files), with 4 outlier files using test_*.py. Both patterns need to be covered by the skip configuration.

---

🚀 Next Steps

🤖 All AI agent prompts combined

Update the `.codacy.yml` file to add a pylint engine configuration that skips
the `assert_used` rule for test files, while preserving the existing bandit
configuration.

- Open `.codacy.yml` and locate the existing `engines:` section
- Add a new `pylint:` entry inside the existing `engines:` section — do NOT
create a duplicate `engines:` key
- Under `pylint:`, set `enabled: true`
- Add a `rules:` section with an `assert_used:` key containing a `skips:` list
- The `skips:` list must include both glob patterns:
  - `*_test.py` (covers the primary naming convention, 200 files)
  - `*test_*.py` (covers the 4 outlier files using the `test_*.py` convention)
- Leave the existing bandit engine block completely unchanged
- After updating `.codacy.yml`, add an entry to `CHANGELOG.md` under the
`[Unreleased]` section documenting the configuration change

💡 Iterate on the plan with: @coderabbitai <feedback>

Example Feedback
- `@coderabbitai` You can skip phase 3. Add a simple unit test case for phase 2.
- `@coderabbitai` For design choice 1 go ahead with option 3 and replan.

---

💬 Have feedback or questions? Drop into our discord!

[emanisaikumar01]

Hi @exploreriii,

I would like to work on this beginner issue.

Please assign it to me. I will follow the contribution guidelines and submit a PR once the fix is ready.

Thanks!

[github-actions]

👋 Hi @emanisaikumar01! If you'd like to work on this issue, please comment /assign to get assigned.

[emanisaikumar01]

/assign

[MonaaEid]

Hi @emanisaikumar01 are you still working on this?

[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.

[exploreriii]

Hi @emanisaikumar01 please confirm if you'd like to remain assigned to this issue, thank you

[github-actions]

Hi @emanisaikumar01 👋

This issue has been assigned but no pull request has been created yet.
Are you still planning on working on it?
If you are, please create a draft PR linked to this issue or comment /working to let us know.
If you’re no longer able to work on this issue, you can comment /unassign to release it.

From the Python SDK Team

[emanisaikumar01]

/unassign

Sorry, I’m unable to continue working on this issue currently.