Add Linter and Formatter for python source codes

[anencore94]

/kind feature

Describe the solution you'd like

In kubeflow/katib, there are lots of source codes written in python. Even though there are well-defined CI processes for source codes written in Golang, however for Python codes, only charmed-katib seems to have such process now.

There should be a fixed linter, formatter and tester with some rule-config files(.flake8, .pylintrc, ...) and the github action workflow to check those all. For example, there are lots of unit test codes for suggestion, but current CI process doesn't check if they are failed or check the test coverage decreased in every PR. If there are any convention checking tools, please share in katib community :)

Anything else you would like to add: If you guys agree to this, I'd like to contribute to this feature in some parts.

[andreyvelich]

That is a great suggestion and it will be very useful for us. Thank you for your help @anencore94!

In addition to that, I think we should move our current Python tests from AWS CI Workflow to GitHub actions: https://github.com/kubeflow/katib/blob/master/test/scripts/v1beta1/python-tests.sh.

Currently, we are not using AWS Kubernetes cluster requirement to perform this workflow step. We can create separate GitHub Actions Workflow for all Python tests (linter, formatter, unit), similar to Go: https://github.com/kubeflow/katib/tree/master/.github/workflows.

cc @gaocegege @johnugeorge

[anencore94]

Using mypy to type check would be nice too.

[gaocegege]

SGTM, I am not quite familiar with Python, I think we need it.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[andreyvelich]

/lifecycle frozen

[tenzen-y]

/good-first-issue

[google-oss-prow[bot]]

@tenzen-y: This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-good-first-issue command.

In response to this:

/good-first-issue

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[sandipanpanda]

I would like to work on this. /assign

[sagnik3788]

@sandipanpanda still working on it ?

[sandipanpanda]

Sorry, this fell off my radar. @sagnik3788 feel free to work on this. /unassign

[sagnik3788]

/assign