Skip to content

Add missing type hints to hill_climbing.py #14260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
anandvenugopal-tech wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add missing type hints to hill_climbing.py #14260

anandvenugopal-tech wants to merge 5 commits into from
+15 −8

Conversation

@anandvenugopal-tech
Copy link

@anandvenugopal-tech anandvenugopal-tech commented Feb 8, 2026 •
edited
Loading

This PR adds missing type hints to searches/hill_climbing.py.

  • Added type annotation for function_to_optimize (Callable[[int, int], int])
  • Added return type hints to get_neighbors, hash, eq, and str
  • Added missing type hint for search_prob in hill_climbing()
  • Followed modern Python typing (PEP 585)

Improves readability and typing consistency across the repository.

Describe your change:

  • 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".

@anandvenugopal-tech
Add missing type hints to hill_climbing.py
104311f 
This commit adds the missing type annotations to searches/hill_climbing.py.

- Added type annotation for function_to_optimize using Callable [[int, int], int]
- Added return type hints to get_neighbors, __hash__, __eq__, and __str__
- Added missing type hint for search_prob in hill_climbing()
- Improved type clarity while preserving existing logic
- Used modern Python type hints (PEP 585)

This improves readability and typing consistency across the repository.
@algorithms-keeper algorithms-keeper bot added enhancement This PR modified some existing files awaiting reviews This PR is ready to be reviewed labels Feb 8, 2026
@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Feb 8, 2026
@algorithms-keeper algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Feb 8, 2026
llukito
llukito reviewed Feb 8, 2026
View reviewed changes
Copy link

@llukito llukito left a comment

Choose a reason for hiding this comment

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

Left a suggestion regarding the type hints for the objective function.

searches/hill_climbing.py Outdated
x: int,
y: int,
step_size: int,
function_to_optimize: Callable[[int, int], int],
Copy link

@llukito llukito Feb 8, 2026

Choose a reason for hiding this comment

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

Nice work adding these hints!

I have one suggestion regarding function_to_optimize: Currently, it is typed to return an int (Callable[[int, int], int]). However, in optimization problems, objective functions very often return float values (costs, fitness scores, etc.).

Restricting it to int might flag valid use cases as errors. Would it be safer to type it as Callable[[int, int], float] or Callable[[int, int], int | float]?

llukito
llukito approved these changes Feb 8, 2026
View reviewed changes
Copy link

@llukito llukito left a comment

Choose a reason for hiding this comment

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

Thanks for the update!

@llukito
Copy link

llukito commented Feb 8, 2026

The CI failure confirms that the int | float change is correct, but we missed the return type hint for the score() method (or whichever method is at line 42).

You just need to update that method's return annotation to -> int | float so it matches the input function.

@anandvenugopal-tech
Update score() return type to support int | float
515bbde 
Mypy reported an incompatible return type because function_to_optimize may return float values. 
Updated score() return type from int to int | float for full compatibility.
@anandvenugopal-tech
Copy link
Author

anandvenugopal-tech commented Feb 8, 2026

Thanks for the suggestion!
I’ve updated the return type of score() to support int | float so it aligns with the updated type hint for function_to_optimize.
All checks have now passed. Please let me know if anything else is needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@mindaugl mindaugl mindaugl approved these changes

@llukito llukito llukito approved these changes

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

awaiting reviews This PR is ready to be reviewed enhancement This PR modified some existing files

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@anandvenugopal-tech @llukito @mindaugl