Adding type hinting tests #9319
Conversation
|
@trivialfis I've started type hinting for the tests here, beginning with |
There was a problem hiding this comment.
Thank you for the work on type hint @michael-gendy-mention-me !
I'm happy to continue for remaining tests, but I'm not sure how much value adding type hinting for the tests is generating. Do you see this as important and should I therefore continue with more files?
Indeed, I believe it's essential. By having type hints in tests, we can check the type-hint of the xgboost library from a user's perspective thoroughly.
Based on this, my priority for type hint implementation would be:
- Core module.
- Scripts in
demo/guide-python. - Other scripts like dask and survival training in
demo. - Tests.
I put demo over tests just to add value as soon as possible. The type hint might make some of the demonstration scripts easier to read. Others can freely choose what they want to work on.
There was a problem hiding this comment.
Please add the file to:
xgboost/tests/ci_build/lint_python.py
Line 62 in 4066d68
- (optional, but would be great to sort out for formatting when we get a chance).
xgboost/tests/ci_build/lint_python.py
Line 16 in 4066d68
Install mypy, black, and isort. Run the script in the project root. Feel free to disable --pylint and let the CI run it for time saving.
|
|
||
| # save, assert exists, remove file | ||
| binary_path = Path("dtrain.bin") | ||
| binary_path: Path = Path("dtrain.bin") |
There was a problem hiding this comment.
I'm happy with these changes. But for the ease of working on type hints and consistency with the rest of the library, trivially deducible types don't need annotation.
| @@ -16,32 +18,31 @@ | |||
| class TestBasic: | |||
| def test_compat(self): | |||
There was a problem hiding this comment.
mypy doesn't check the function if there's no annotation in the signature.
| def test_compat(self): | |
| def test_compat(self) -> None: |
As part of this issue, we want to add mypy support to our tests. This PR will be type hinting a range of tests for the Python package