Add type hints to `skll.data` module & improve types in `skll.config` #730

desilinguist · 2023-05-17T13:17:02Z

Update pre-commit checks to include a check for commit message format and to exclude missing imports from the mypy check.
Add new custom types to skll.types module.
Add type hints to skll.data module
- Refactor code to ensure correct types.
- Add a lot of checks for labels, features, vectorizer being None that was previously unhandled.
- Update docstrings to use the type hints.
Improve type hints in config/__init__.py
- Use new ClassMap custom type.
- Make sure pos_label is typed correctly.
- Fix incorrect default value for sampler parameters.

- Use new `ClassMap` custom type. - Make sure `pos_label` is typed correctly. - Fix incorrect default value for sampler parameters.

- Refactor code to ensure correct types. - Add a lot of checks for labels, features, vectorizer being ``None`` that was previously handled. - Update docstrings to use the type hints.

- Add new tests for merging featuresets. - Tweak tests that were using `StringIO` to use actual files.

skll/types.py

skll/data/featureset.py

codecov · 2023-05-17T13:51:12Z

Codecov Report

Patch coverage: 92.44% and project coverage change: -0.22 ⚠️

Comparison is base (d7f0eb2) 95.37% compared to head (482f4df) 95.16%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #730      +/-   ##
==========================================
- Coverage   95.37%   95.16%   -0.22%     
==========================================
  Files          29       29              
  Lines        3415     3451      +36     
==========================================
+ Hits         3257     3284      +27     
- Misses        158      167       +9

Impacted Files	Coverage Δ
skll/data/featureset.py	`90.00% <86.04%> (-0.57%)`	⬇️
skll/data/writers.py	`93.65% <93.93%> (-0.76%)`	⬇️
skll/data/readers.py	`90.36% <98.33%> (ø)`
skll/config/__init__.py	`94.75% <100.00%> (-0.02%)`	⬇️
skll/types.py	`100.00% <100.00%> (ø)`

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

skll/data/featureset.py

skll/data/readers.py

skll/data/writers.py

skll/data/featureset.py

skll/data/writers.py

Co-authored-by: tamarl08 <102983105+tamarl08@users.noreply.github.com>

desilinguist · 2023-05-24T20:49:08Z

This is part of #561.

desilinguist added 6 commits May 17, 2023 09:11

chore(pre-commit): ignore missing imports in my check

79d434a

chore(pre-commit): add conventional commit check

6de4a70

chore: add new custom types in skll.types

b27f52b

chore: improve type hints in config/__init__.py

a9e81eb

- Use new `ClassMap` custom type. - Make sure `pos_label` is typed correctly. - Fix incorrect default value for sampler parameters.

chore: add type hints to skll.data module

6e76347

- Refactor code to ensure correct types. - Add a lot of checks for labels, features, vectorizer being ``None`` that was previously handled. - Update docstrings to use the type hints.

chore: Update test_featureset.py

ba4f650

- Add new tests for merging featuresets. - Tweak tests that were using `StringIO` to use actual files.

desilinguist requested review from Frost45, damien2012eng, dblandan, mulhod and tamarl08 May 17, 2023 13:17