grass.jupyter: Add docstrings, f-strings, fix var names, imports #2200

wenzeslaus · 2022-02-13T03:55:07Z

Add missing docstrings.
Reorder imports (with both pylint and isort).
Use full-word variable names.
Use f-strings if possible. Here it replaces smart, but hard to decode, dictionary usage in format, by simple, although longer, direct use of the dictionary.

* Add missing docstrings. * Reorder imports (with both pylint and isort). * Use full-word variable names. * Use f-strings if possible. Here it replaces smart, but hard to decode, dictionary usage in format, by simple, although longer, direct use of the dictionary.

This adds Pylint check job in a new workflow. It uses the current latest Pylint and latest Python. It uses Pylint to check for minimal supported Python version. The check runs for the grass package (python/grass) and for wxGUI (gui/wxpython). However, most of the files are ignored. Each of the directories has its own .pylintrc file. Pylint runs for grass.jupyter and grass.benchmark with only slightly modified configuration after fixes in targeted files (#2199, #2200, #2201, #2206). The approach for future compliance is that the other sub-packages should also eventually comply with default or almost default configuration. For wxGUI, many Pylint messages are disabled and numbers driving coding standard limits, such as max number of local variables, are greatly loosened. Many of the disabled messages show real errors, but ignoring these for now allowed for enabling the check right away at least for the least problematic directories. The approach for future compliance is that new directories can be added (removed from ignore paths) and new issues can be checked (removed from disable) when fixed. This compiles the code. Just testing Python functions from the grass package in the python directory does not require compiled code and package on path when started from the python directory, but checking other files requires packages on path. The config file is in the python directory because that's the focus of this PR. (In the future, GUI may have a different config file, e.g., due to different naming conventions. On the other hand, in an ideal case, the whole source code will use this file or even a more strict version of this file in the future.) Pylint should produce warning for disabled warnings which are not generated, although that seems to not be the case right now (useless-suppression). The only code change here is that Pylint disable comment needs to be on the same line or inside (). It needs to install also all optional Python dependencies because Pylint checks (can check unless disabled) all imports. This change is applied also to pytest workflow. Using workflow on settings to run on push only to main and release branches and semver tags. It uses strategy.matrix.include to get job-level config variables without using environmental variables.

…eo#2200) * Add missing docstrings. * Reorder imports (with both pylint and isort). * Use full-word variable names. * Use f-strings if possible. Here it replaces smart, but hard to decode, dictionary usage in format, by simple, although longer, direct use of the dictionary.

This adds Pylint check job in a new workflow. It uses the current latest Pylint and latest Python. It uses Pylint to check for minimal supported Python version. The check runs for the grass package (python/grass) and for wxGUI (gui/wxpython). However, most of the files are ignored. Each of the directories has its own .pylintrc file. Pylint runs for grass.jupyter and grass.benchmark with only slightly modified configuration after fixes in targeted files (OSGeo#2199, OSGeo#2200, OSGeo#2201, OSGeo#2206). The approach for future compliance is that the other sub-packages should also eventually comply with default or almost default configuration. For wxGUI, many Pylint messages are disabled and numbers driving coding standard limits, such as max number of local variables, are greatly loosened. Many of the disabled messages show real errors, but ignoring these for now allowed for enabling the check right away at least for the least problematic directories. The approach for future compliance is that new directories can be added (removed from ignore paths) and new issues can be checked (removed from disable) when fixed. This compiles the code. Just testing Python functions from the grass package in the python directory does not require compiled code and package on path when started from the python directory, but checking other files requires packages on path. The config file is in the python directory because that's the focus of this PR. (In the future, GUI may have a different config file, e.g., due to different naming conventions. On the other hand, in an ideal case, the whole source code will use this file or even a more strict version of this file in the future.) Pylint should produce warning for disabled warnings which are not generated, although that seems to not be the case right now (useless-suppression). The only code change here is that Pylint disable comment needs to be on the same line or inside (). It needs to install also all optional Python dependencies because Pylint checks (can check unless disabled) all imports. This change is applied also to pytest workflow. Using workflow on settings to run on push only to main and release branches and semver tags. It uses strategy.matrix.include to get job-level config variables without using environmental variables.

…eo#2200) * Add missing docstrings. * Reorder imports (with both pylint and isort). * Use full-word variable names. * Use f-strings if possible. Here it replaces smart, but hard to decode, dictionary usage in format, by simple, although longer, direct use of the dictionary.

This adds Pylint check job in a new workflow. It uses the current latest Pylint and latest Python. It uses Pylint to check for minimal supported Python version. The check runs for the grass package (python/grass) and for wxGUI (gui/wxpython). However, most of the files are ignored. Each of the directories has its own .pylintrc file. Pylint runs for grass.jupyter and grass.benchmark with only slightly modified configuration after fixes in targeted files (OSGeo#2199, OSGeo#2200, OSGeo#2201, OSGeo#2206). The approach for future compliance is that the other sub-packages should also eventually comply with default or almost default configuration. For wxGUI, many Pylint messages are disabled and numbers driving coding standard limits, such as max number of local variables, are greatly loosened. Many of the disabled messages show real errors, but ignoring these for now allowed for enabling the check right away at least for the least problematic directories. The approach for future compliance is that new directories can be added (removed from ignore paths) and new issues can be checked (removed from disable) when fixed. This compiles the code. Just testing Python functions from the grass package in the python directory does not require compiled code and package on path when started from the python directory, but checking other files requires packages on path. The config file is in the python directory because that's the focus of this PR. (In the future, GUI may have a different config file, e.g., due to different naming conventions. On the other hand, in an ideal case, the whole source code will use this file or even a more strict version of this file in the future.) Pylint should produce warning for disabled warnings which are not generated, although that seems to not be the case right now (useless-suppression). The only code change here is that Pylint disable comment needs to be on the same line or inside (). It needs to install also all optional Python dependencies because Pylint checks (can check unless disabled) all imports. This change is applied also to pytest workflow. Using workflow on settings to run on push only to main and release branches and semver tags. It uses strategy.matrix.include to get job-level config variables without using environmental variables.

…eo#2200) * Add missing docstrings. * Reorder imports (with both pylint and isort). * Use full-word variable names. * Use f-strings if possible. Here it replaces smart, but hard to decode, dictionary usage in format, by simple, although longer, direct use of the dictionary.

This adds Pylint check job in a new workflow. It uses the current latest Pylint and latest Python. It uses Pylint to check for minimal supported Python version. The check runs for the grass package (python/grass) and for wxGUI (gui/wxpython). However, most of the files are ignored. Each of the directories has its own .pylintrc file. Pylint runs for grass.jupyter and grass.benchmark with only slightly modified configuration after fixes in targeted files (OSGeo#2199, OSGeo#2200, OSGeo#2201, OSGeo#2206). The approach for future compliance is that the other sub-packages should also eventually comply with default or almost default configuration. For wxGUI, many Pylint messages are disabled and numbers driving coding standard limits, such as max number of local variables, are greatly loosened. Many of the disabled messages show real errors, but ignoring these for now allowed for enabling the check right away at least for the least problematic directories. The approach for future compliance is that new directories can be added (removed from ignore paths) and new issues can be checked (removed from disable) when fixed. This compiles the code. Just testing Python functions from the grass package in the python directory does not require compiled code and package on path when started from the python directory, but checking other files requires packages on path. The config file is in the python directory because that's the focus of this PR. (In the future, GUI may have a different config file, e.g., due to different naming conventions. On the other hand, in an ideal case, the whole source code will use this file or even a more strict version of this file in the future.) Pylint should produce warning for disabled warnings which are not generated, although that seems to not be the case right now (useless-suppression). The only code change here is that Pylint disable comment needs to be on the same line or inside (). It needs to install also all optional Python dependencies because Pylint checks (can check unless disabled) all imports. This change is applied also to pytest workflow. Using workflow on settings to run on push only to main and release branches and semver tags. It uses strategy.matrix.include to get job-level config variables without using environmental variables.

wenzeslaus added bug Something isn't working Python Related code is in Python labels Feb 13, 2022

wenzeslaus added this to the 8.2.0 milestone Feb 13, 2022

wenzeslaus merged commit ffc874d into OSGeo:main Feb 13, 2022

wenzeslaus deleted the simple-pylint-fixes-for-jupyter branch February 13, 2022 20:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

grass.jupyter: Add docstrings, f-strings, fix var names, imports #2200

grass.jupyter: Add docstrings, f-strings, fix var names, imports #2200

wenzeslaus commented Feb 13, 2022

grass.jupyter: Add docstrings, f-strings, fix var names, imports #2200

grass.jupyter: Add docstrings, f-strings, fix var names, imports #2200

Conversation

wenzeslaus commented Feb 13, 2022