Skip to content

Refactor/type hinting pep561#37

Merged
KaykCaputo merged 2 commits intoKaykCaputo:masterfrom
waldo121:refactor/type-hinting-pep561
Apr 12, 2026
Merged

Refactor/type hinting pep561#37
KaykCaputo merged 2 commits intoKaykCaputo:masterfrom
waldo121:refactor/type-hinting-pep561

Conversation

@waldo121
Copy link
Copy Markdown
Contributor

@waldo121 waldo121 commented Apr 10, 2026

Summary

Adds type hints and CI check

Related Issue

Closes #36

Type of Change

  • Bug fix
  • New feature
  • Refactor
  • Documentation update
  • CLI behavior change

What Changed

List the key changes in a few bullets.

  • Adds dev dependency groups
  • Runs mypy in CI check
  • Adds type hints in function signatures and variables declaration
  • Adds py.typed in module root

Validation

Describe how you validated this change.

  • Ran mypy oracletrace
  • Ran pytest tests
  • Ran cli smoke checks to make sure nothing was broken

Checklist

  • The code follows style conventions.
  • I added unit tests for the new functionality.
  • CI (GitHub Actions) is green.
  • I updated documentation/README when needed.

Additional Notes

Is there a preferred order for CI checks?

@waldo121 waldo121 force-pushed the refactor/type-hinting-pep561 branch from 267d3eb to 48cc6f0 Compare April 10, 2026 21:05
@waldo121 waldo121 force-pushed the refactor/type-hinting-pep561 branch from 48cc6f0 to 02b6df3 Compare April 10, 2026 21:07
@waldo121 waldo121 marked this pull request as ready for review April 10, 2026 21:11
@KaykCaputo KaykCaputo requested a review from AndreXP1 April 10, 2026 22:24
@KaykCaputo
Copy link
Copy Markdown
Owner

@AndreXP1 could you please review this?

@vincent5678
Copy link
Copy Markdown
Contributor

Instead of dictionaries we should be using dataclasses where applicable

Comment thread oracletrace/compare.py Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be a dataclass instead of dictionary

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed it

Comment thread oracletrace/tracer.py Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be a dataclass

Copy link
Copy Markdown
Contributor Author

@waldo121 waldo121 Apr 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed it

Comment thread oracletrace/compare.py Outdated
@waldo121 waldo121 force-pushed the refactor/type-hinting-pep561 branch from 02b6df3 to 876fcd3 Compare April 11, 2026 20:48
@waldo121 waldo121 force-pushed the refactor/type-hinting-pep561 branch from 876fcd3 to 21fb4ae Compare April 11, 2026 20:58
Copy link
Copy Markdown
Collaborator

@AndreXP1 AndreXP1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!
Can we merge this? @KaykCaputo

@waldo121 waldo121 requested a review from vincent5678 April 11, 2026 21:10
@KaykCaputo KaykCaputo merged commit d5fa564 into KaykCaputo:master Apr 12, 2026
5 checks passed
@waldo121 waldo121 deleted the refactor/type-hinting-pep561 branch April 12, 2026 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Refactor] Comprehensive Type Hinting and PEP 561 Compliance

4 participants