Skip to content

Conversation

@VikramadityasinghIN
Copy link

Describe your change:

Added static type hints to all functions in maths/primelib.py to ensure compliance with strict mypy checks.

Key Changes:

  • Added argument and return type annotations (e.g., -> list[int], -> bool) to 15+ functions.
  • Fixed a Type Error: In prime_factorization, changed quotient /= factor to quotient //= factor. The original code produced floats, which conflicted with the list[int] return type.

Verification:

  • black maths/primelib.py passed.

  • mypy maths/primelib.py passed (0 errors).

  • python -m doctest -v maths/primelib.py passed (79 tests).

  • Add an algorithm?

  • Fix a bug or typo in an existing algorithm?

  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.

  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@VikramadityasinghIN
Copy link
Author

Hi maintainers! 👋

I've finalized the type hints for maths/primelib.py and ensured all checks (Build, Ruff, Pre-commit) are passing.

Note: During the refactor, I also fixed a potential bug in prime_factorization where float division (/=) was used instead of integer division (//=), which could have caused type conflicts.

Ready for review whenever you have a moment. Thanks!

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.

1 participant