tests: Change tests/runtest.py to match the pylint code style

[sypark9646]

apply black for linting, and follow common rules in python code.
The following warnings from pylint are fixed.

If you want to find the full pylint warning, run the following command:

pylint tests/runtest.py 

And if you want to find a specific pylint warning(ex. W0613), you can run a command like this:

pylint tests/runtest.py --disable R,C,W,E --enable W0613

resolves #1497
related #1396

[honggyukim]

Thanks, but it looks too many changes are applied in a single patch. Is it possible to apply each pylint violation one at a single commit then create multiple commits?

[honggyukim]

Simply speaking, it's very difficult to review if a single change contains too many different changes.

[sypark9646]

Oh I get it.
I'll split and re-commit as per warning, thanks!

[namhyung]

Can you please change the max line length from 80 to 100?

[sypark9646]

Okay, I'll incorporate your suggestion into the code! Thanks

[sypark9646]

The pylint warning you mentioned is left W0613 (unused-argument),
If you need a commit to delete ignored arguments used in simple_sort, report_sort, graph_sort, dump_sort, chrome_sort, etc. I'd delete that, but I'm afraid it might be important, so I couldn't delete it now.

[namhyung]

LGTM, and it'd be nice if you could share the exact command line you ran to get these warnings.

[namhyung]

Oh, you already wrote the command line in the PR. I'll merge the change then.

[namhyung]

Ugh, please put a blank line after the subject line later so that git log --oneline can show it properly.

I hate github displaying such a subject line without any warnings.

[honggyukim]

@sypark9646, You will understand what @namhyung mentioned by running git log and git log --oneline.

The commit message should have a separate commit title, which is written in a single line at the top.

For example, the your commit message is written as follows.

commit 8d8f168b1b57ab1de1a8f7a6b0404da6d7b0053e
Author:     Soyeon Park <[email protected]>
AuthorDate: Mon Sep 4 12:44:32 2023 +0900

    Pylint W0612: Unused variable
    Used when a variable is defined but not used.
    
    Signed-off-by: Soyeon Park <[email protected]>

But it should have a separate commit title in a single line. Because of this, the git log --oneline output looks weird.

$ git log --oneline 8d8f168b -1
8d8f168b Pylint W0612: Unused variable Used when a variable is defined but not used.

So the commit message should be changed with an empty line as follows.

commit 8d8f168b1b57ab1de1a8f7a6b0404da6d7b0053e
Author:     Soyeon Park <[email protected]>
AuthorDate: Mon Sep 4 12:44:32 2023 +0900

    tests: Pylint W0612: Unused variable

    Used when a variable is defined but not used.
    
    Signed-off-by: Soyeon Park <[email protected]>

It will show the commit log with --oneline properly as follows.

$ git log --oneline 8d8f168b -1
8d8f168b tests: Pylint W0612: Unused variable

This PR is already merged so we can't change it, but please keep that in mind for the next PR. Thanks.

[MichelleJin12]

Hello, @sypark9646,

In addition to Honggyu's comment,
You don't need to add . to the end of the title of the commit message.

Thank you for your contribution. :D

[sypark9646]

Ah, thank you. I'll make sure to keep that in mind next time!!

[namhyung]

Is there any checker doing this automatically?

[honggyukim]

There is https://github.com/conventional-changelog/commitlint but I haven’t had a chance to add it in our pre-commit hook yet.