Literal check on config section and key by mypy

elastic / rally

Macrobenchmarking framework for Elasticsearch

Apache License 2.0

37 stars 314 forks source link

Closed sakurai-youhei closed 10 months ago

sakurai-youhei commented 1 year ago

This PR will introduce a type check by mypy, which helps find illegal literals on the config section and key.

Relates #1646

sakurai-youhei commented 1 year ago

@gbanasiak Thank you for your comments. Please feel free to bring up anything.

sakurai-youhei commented 12 months ago

@gbanasiak Here are the highlights in this round. I appreciate a fresh pair of eyes as this PR gets bigger. Thanks.

Split out esrally.types to avoid circular references between esrally.config and other modules.
Added one more test to check annotation for cfg and config around functions.
The number of keys has reached 115, thanks to the test that discovers missing annotations.
Replaced Union[T, None] with Optional[T].
Eliminated # pylint: disable=C0301.

P.S. Although I wrote “fresh”, I just meant the second pair; not a new pair from someone else.

sakurai-youhei commented 11 months ago

git-rebased in the source branch because this PR gets aged.

sakurai-youhei commented 10 months ago

@gbanasiak I didn't notice my git-rebase messed it up. I reverted it instead of appending something more.

Thank you very much for your review. I've learned a lot through this PR. I will merge this PR once all the CI checks have passed.