Pylint default - Githubissues

SpiNNakerManchester / SpiNNUtils

Utility classes and functions for SpiNNaker projects

Apache License 2.0

1 stars 5 forks source link

Pylint default #267

Closed Christian-B closed 8 months ago

Christian-B commented 10 months ago

This pr and later similar (but independent) prs make pylint checking stricter and also more constant between repositories.

I have done my best to only do one type of change per commit so reviewing the commits may be easiest.

Changes include: Using a global rcfile https://github.com/SpiNNakerManchester/SupportScripts/blob/master/actions/pylint/strict_rcfile Rather than one per repository

A global spelling exceptions list https://github.com/SpiNNakerManchester/SupportScripts/blob/master/actions/pylint/default_dict.txt

A pylint.bash file to make it easier to run pylint manually/locally using as close as possible to the github actions settings.

To support the pylint.bash finding other repositories without requiring them to be in the path

each repository (except utils) has a import_hooks.py file which adds paths to other repositories on a temporary basis.
the strict_rcfile has an init-hook setting to import (therefor run) this code.
this import assumes the file is local to the calling script so works with pylint_bash but try except passes in github actions.

Note: The changes to support scripts are already in master as impossible to test otherwise!

A number of spelling changes found by either github or running locally.

The code changes are limited to -refactors some method or param names

using f strings
removing the keys() in for x in dict.keys() style
import reordering
adding overrides tags
typing - and using cast
replacing pattern for i in range(len(foo)):
fixing slots to use square brackets
removing or adding a FINAL decorator

Similar prs that can be done in any order: https://github.com/SpiNNakerManchester/SpiNNMachine/pull/236 https://github.com/SpiNNakerManchester/SpiNNMan/pull/391 https://github.com/SpiNNakerManchester/PACMAN/pull/541 https://github.com/SpiNNakerManchester/SpiNNFrontEndCommon/pull/1157 https://github.com/SpiNNakerManchester/sPyNNaker/pull/1437

tested by http://apollo.cs.man.ac.uk:8080/blue/organizations/jenkins/Integration%20Tests/detail/pylint_default/3/pipeline

coveralls commented 10 months ago

coverage: 88.271%. remained the same when pulling f1d5cfac66f4364d775686374bcde2c2c07e9ce5 on pylint_default into 3ee7bd0e376cf23216897dbc8e04d57d8ac809ef on master.