PMEAL / OpenPNM

A Python package for performing pore network modeling of porous media
http://openpnm.org
MIT License
442 stars 175 forks source link

Add list of checks to ignore in the pep8 action #2146

Closed jgostick closed 2 years ago

jgostick commented 2 years ago

Below is a collection of warnings/errors that I think we should ignore:

jgostick commented 2 years ago

The pep8 check sends a helpful email with each issue condensed to a single line. It's much easier to see all the offenses than in the PR thread. Below is an example, which we can use to populate our above list of things to ignore:

@github-actions[bot] commented on this pull request.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
pep8 
openpnm/models/network/topology.py|50 col 6| N806 variable 'D' in function should be lowercase
openpnm/models/network/topology.py|52 col 5| WPS110 Found wrong variable name: values
openpnm/models/network/topology.py|57 col 1| WPS210 Found too many local variables: 8 > 5
openpnm/models/network/topology.py|58 col 1| D200 One-line docstring should fit on one line with quotes
openpnm/models/network/topology.py|58 col 1| D400 First line should end with a period
openpnm/models/network/topology.py|58 col 1| DAR201 Missing "Returns" in Docstring: - return
openpnm/models/network/topology.py|58 col 1| DAR101 Missing parameter(s) in Docstring: - target
openpnm/models/network/topology.py|58 col 5| WPS360 Found an unnecessary use of a raw string: """
openpnm/models/network/topology.py|64 col 6| N806 variable 'C1' in function should be lowercase
openpnm/models/network/topology.py|65 col 6| N806 variable 'C2' in function should be lowercase
openpnm/models/network/topology.py|66 col 5| WPS111 Found too short name: D < 2
openpnm/models/network/topology.py|66 col 6| N806 variable 'D' in function should be lowercase
openpnm/models/network/topology.py|68 col 5| WPS110 Found wrong variable name: values
openpnm/models/network/topology.py|73 col 1| WPS210 Found too many local variables: 6 > 5
openpnm/models/network/topology.py|74 col 1| D205 1 blank line required between summary line and description
openpnm/models/network/topology.py|74 col 1| D400 First line should end with a period
openpnm/models/network/topology.py|74 col 1| DAR201 Missing "Returns" in Docstring: - return
openpnm/models/network/topology.py|74 col 1| DAR101 Missing parameter(s) in Docstring: - target
openpnm/models/network/topology.py|74 col 5| WPS360 Found an unnecessary use of a raw string: """
openpnm/models/network/topology.py|78 col 5| WPS433 Found nested import
openpnm/models/network/topology.py|78 col 5| WPS301 Found dotted raw import: scipy.spatial
openpnm/models/network/topology.py|83 col 5| WPS110 Found wrong variable name: values
openpnm/models/network/topology.py|84 col 5| WPS331 Found variables that are only used for return: values
openpnm/models/network/topology.py|87 col 33| WPS111 Found too short name: z < 2
openpnm/models/network/topology.py|88 col 1| D400 First line should end with a period
openpnm/models/network/topology.py|88 col 1| D401 First line should be in imperative mood
openpnm/models/network/topology.py|88 col 1| DAR201 Missing "Returns" in Docstring: - return
openpnm/models/network/topology.py|88 col 1| DAR101 Missing parameter(s) in Docstring: - target
openpnm/models/network/topology.py|88 col 1| DAR101 Missing parameter(s) in Docstring: - z
openpnm/models/network/topology.py|88 col 5| WPS360 Found an unnecessary use of a raw string: """
openpnm/models/network/topology.py|116 col 10| WPS317 Found incorrect multi-line parameters
openpnm/models/network/topology.py|117 col 42| WPS318 Found extra indentation
openpnm/models/network/topology.py|117 col 52| WPS319 Found bracket in wrong position
openpnm/models/network/topology.py|122 col 6| N806 variable 'Ts' in function should be lowercase
openpnm/models/network/topology.py|123 col 6| N806 variable 'Ts' in function should be lowercase
openpnm/models/network/topology.py|128 col 6| N806 variable 'Ts' in function should be lowercase
openpnm/models/network/topology.py|129 col 5| WPS420 Found wrong keyword: del
openpnm/models/network/topology.py|130 col 5| WPS221 Found line with high Jones Complexity: 16 > 14
openpnm/models/network/topology.py|130 col 6| N806 variable 'Ts' in function should be lowercase
openpnm/models/network/topology.py|131 col 6| N806 variable 'Ts' in function should be lowercase
openpnm/models/network/topology.py|132 col 5| WPS331 Found variables that are only used for return: Ts
openpnm/models/network/topology.py|135 col 1| WPS210 Found too many local variables: 6 > 5
openpnm/models/network/topology.py|135 col 38| WPS111 Found too short name: z < 2
openpnm/models/network/topology.py|136 col 1| D400 First line should end with a period
openpnm/models/network/topology.py|136 col 1| DAR101 Missing parameter(s) in Docstring: - pores
openpnm/models/network/topology.py|136 col 1| DAR201 Missing "Returns" in Docstring: - return
openpnm/models/network/topology.py|136 col 1| DAR101 Missing parameter(s) in Docstring: - target
openpnm/models/network/topology.py|136 col 1| DAR101 Missing parameter(s) in Docstring: - z
openpnm/models/network/topology.py|136 col 5| WPS360 Found an unnecessary use of a raw string: """
openpnm/models/network/topology.py|156 col 13| WPS437 Found protected attribute usage: _parse_indices
openpnm/models/network/topology.py|157 col 6| N806 variable 'Nz' in function should be lowercase
openpnm/models/network/topology.py|161 col 5| WPS331 Found variables that are only used for return: mask
openpnm/network/GenericNetwork.py|8 col 1| I001 isort found an import in the wrong position
openpnm/network/GenericNetwork.py|8 col 1| WPS301 Found dotted raw import: openpnm.models.network
openpnm/network/GenericNetwork.py|143 col 24| WPS318 Found extra indentation
openpnm/topotools/init.py|13 col 1| F403 'from .topotools import *' used; unable to detect undefined names
openpnm/topotools/init.py|13 col 1| WPS300 Found local folder import
openpnm/topotools/init.py|13 col 1| WPS347 Found vague import that may cause confusion: *
openpnm/topotools/init.py|14 col 1| F403 'from .perctools import *' used; unable to detect undefined names
openpnm/topotools/init.py|14 col 1| I001 isort found an import in the wrong position
openpnm/topotools/init.py|14 col 1| WPS300 Found local folder import
openpnm/topotools/init.py|14 col 1| WPS347 Found vague import that may cause confusion: *
openpnm/topotools/init.py|14 col 1| WPS440 Found block variables overlap: *
openpnm/topotools/init.py|15 col 1| F403 'from .graphtools import *' used; unable to detect undefined names
openpnm/topotools/init.py|15 col 1| I001 isort found an import in the wrong position
openpnm/topotools/init.py|15 col 1| WPS300 Found local folder import
openpnm/topotools/init.py|15 col 1| WPS347 Found vague import that may cause confusion: *
openpnm/topotools/init.py|15 col 1| WPS440 Found block variables overlap: *
openpnm/topotools/init.py|16 col 1| F403 'from .plottools import *' used; unable to detect undefined names
openpnm/topotools/init.py|16 col 1| I001 isort found an import in the wrong position
openpnm/topotools/init.py|16 col 1| WPS300 Found local folder import
openpnm/topotools/init.py|16 col 1| WPS347 Found vague import that may cause confusion: *
openpnm/topotools/init.py|16 col 1| WPS440 Found block variables overlap: *
openpnm/topotools/init.py|17 col 1| I001 isort found an import in the wrong position
openpnm/topotools/init.py|17 col 1| WPS300 Found local folder import
openpnm/topotools/graphtools.py|9 col 1| WPS410 Found wrong metadata variable: all
openpnm/topotools/graphtools.py|25 col 5| E123 closing bracket does not match indentation of opening bracket's line
openpnm/topotools/perctools.py|9 col 1| WPS410 Found wrong metadata variable: all
openpnm/topotools/perctools.py|16 col 5| E123 closing bracket does not match indentation of opening bracket's line
openpnm/topotools/plottools.py|6 col 1| WPS410 Found wrong metadata variable: all
openpnm/topotools/topotools.py|12 col 1| WPS410 Found wrong metadata variable: all
openpnm/topotools/topotools.py|45 col 5| E123 closing bracket does not match indentation of opening bracket's line
openpnm/utils/Project.py|757 col 9| WPS433 Found nested import
openpnm/utils/Project.py|757 col 9| WPS301 Found dotted raw import: openpnm.models.network.health