diff --git a/.github/workflows/python-code-quality.yml b/.github/workflows/python-code-quality.yml index 63bfd709bcf..238ed9a3ebc 100644 --- a/.github/workflows/python-code-quality.yml +++ b/.github/workflows/python-code-quality.yml @@ -25,14 +25,14 @@ jobs: env: # renovate: datasource=python-version depName=python - PYTHON_VERSION: "3.10" - MIN_PYTHON_VERSION: "3.8" + PYTHON_VERSION: "3.12" + MIN_PYTHON_VERSION: "3.9" # renovate: datasource=pypi depName=black BLACK_VERSION: "24.10.0" # renovate: datasource=pypi depName=flake8 FLAKE8_VERSION: "7.1.1" # renovate: datasource=pypi depName=pylint - PYLINT_VERSION: "2.12.2" + PYLINT_VERSION: "3.3.1" # renovate: datasource=pypi depName=bandit BANDIT_VERSION: "1.7.10" # renovate: datasource=pypi depName=ruff @@ -156,6 +156,7 @@ jobs: echo "$HOME/install/bin" >> $GITHUB_PATH - name: Run Pylint on grass package + continue-on-error: true # DEBUG run: | export PYTHONPATH=`grass --config python_path`:$PYTHONPATH export LD_LIBRARY_PATH=$(grass --config path)/lib:$LD_LIBRARY_PATH @@ -163,6 +164,7 @@ jobs: pylint --persistent=no --py-version=${{ env.MIN_PYTHON_VERSION }} --jobs=$(nproc) grass - name: Run Pylint on wxGUI + continue-on-error: true # DEBUG run: | export PYTHONPATH=`grass --config python_path`:$PYTHONPATH export LD_LIBRARY_PATH=$(grass --config path)/lib:$LD_LIBRARY_PATH @@ -170,14 +172,10 @@ jobs: pylint --persistent=no --py-version=${{ env.MIN_PYTHON_VERSION }} --jobs=$(nproc) * - name: Run Pylint on other files using pytest + continue-on-error: true # DEBUG run: | - pipx inject --include-apps pylint pytest==7.4.4 - pipx inject pylint pytest-pylint==0.19 pytest-github-actions-annotate-failures - echo "::warning file=.github/workflows/python-code-quality.yml,line=149,col=42,endColumn=48::\ - Temporarily downgraded pytest-pylint and pytest to allow merging other PRs.\ - The errors reported with a newer version seem legitimite and should be fixed \ - (2023-10-18, see https://github.com/OSGeo/grass/pull/3205)\ - (2024-01-28, see https://github.com/OSGeo/grass/issues/3380)" + pipx inject --include-apps pylint pytest + pipx inject pylint pytest-pylint pytest-github-actions-annotate-failures pytest-timeout export PYTHONPATH=`grass --config python_path`:$PYTHONPATH export LD_LIBRARY_PATH=$(grass --config path)/lib:$LD_LIBRARY_PATH pytest --pylint -m pylint --pylint-rcfile=.pylintrc --pylint-jobs=$(nproc) \ @@ -207,6 +205,34 @@ jobs: path: sphinx-grass retention-days: 3 + - name: Run Pylint on grass package + run: | + export PYTHONPATH=`grass --config python_path`:$PYTHONPATH + export LD_LIBRARY_PATH=$(grass --config path)/lib:$LD_LIBRARY_PATH + cd python + pylint --persistent=no --py-version=${{ env.MIN_PYTHON_VERSION }} --jobs=$(nproc) grass + + - name: Run Pylint on wxGUI + run: | + export PYTHONPATH=`grass --config python_path`:$PYTHONPATH + export LD_LIBRARY_PATH=$(grass --config path)/lib:$LD_LIBRARY_PATH + cd gui/wxpython + pylint --persistent=no --py-version=${{ env.MIN_PYTHON_VERSION }} --jobs=$(nproc) * + + - name: Run Pylint on other files using pytest + run: | + pipx inject --include-apps pylint pytest + pipx inject pylint pytest-pylint= pytest-github-actions-annotate-failures + export PYTHONPATH=`grass --config python_path`:$PYTHONPATH + export LD_LIBRARY_PATH=$(grass --config path)/lib:$LD_LIBRARY_PATH + pytest --pylint -m pylint --pylint-rcfile=.pylintrc --pylint-jobs=$(nproc) \ + --pylint-ignore-patterns="${{ env.PylintIgnore }}" + env: + PylintIgnore: "python/.*,gui/wxpython/.*,doc/.*,man/.*,utils/.*,locale/.*,raster/.*,\ + imagery/.*,scripts/r.in.wms/wms_drv.py,scripts/g.extension/g.extension.py,\ + temporal/t.rast.accdetect/t.rast.accdetect.py,temporal/t.rast.accumulate/t.rast.accumulate.py,\ + scripts/d.rast.edit/d.rast.edit.py" + python-success: name: Python Code Quality Result needs: diff --git a/.pylintrc b/.pylintrc.old similarity index 99% rename from .pylintrc rename to .pylintrc.old index b260c0fd401..cdf904fea7b 100644 --- a/.pylintrc +++ b/.pylintrc.old @@ -65,592 +65,590 @@ suggestion-mode=yes unsafe-load-any-extension=no -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once). You can also use "--disable=all" to -# disable everything first and then re-enable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use "--disable=all --enable=classes -# --disable=W". -disable=raw-checker-failed, - bad-inline-option, - locally-disabled, - file-ignored, - suppressed-message, - deprecated-pragma, - fixme, - missing-module-docstring, - missing-function-docstring, - missing-class-docstring, - import-outside-toplevel, - useless-import-alias, - consider-using-from-import, - wrong-import-order, - wrong-import-position, - import-error, - no-name-in-module, - no-member, - unused-import, - unused-variable, - unused-argument, - expression-not-assigned, - self-assigning-variable, - unspecified-encoding, - no-self-use, - inconsistent-return-statements, - invalid-name, - broad-except, - bare-except, - raise-missing-from, - undefined-variable, - undefined-loop-variable, - cell-var-from-loop, - not-callable, - global-variable-undefined, - global-statement, - global-variable-not-assigned, - attribute-defined-outside-init, - line-too-long, - eval-used, - no-value-for-parameter, - deprecated-method, - deprecated-argument, - anomalous-backslash-in-string, - redefined-builtin, - redefined-outer-name, - useless-object-inheritance, - useless-return, - consider-using-f-string, - consider-iterating-dictionary, - consider-using-dict-items, - consider-using-enumerate, - consider-using-in, - consider-using-with, - consider-using-generator, - consider-using-max-builtin, - consider-using-min-builtin, - consider-using-get, - unnecessary-comprehension, - unnecessary-pass, - super-with-arguments, - unidiomatic-typecheck, - use-implicit-booleaness-not-comparison, - no-else-break, - no-else-return, - no-else-raise, - simplifiable-if-statement, - use-maxsplit-arg, - use-list-literal, - use-a-generator, - unneeded-not, - chained-comparison, - use-symbolic-message-instead +[BASIC] -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable=c-extension-no-member +# Naming style matching correct argument names. +argument-naming-style=snake_case +# Regular expression matching correct argument names. Overrides argument- +# naming-style. +#argument-rgx= -[REPORTS] +# Naming style matching correct attribute names. +attr-naming-style=snake_case -# Python expression which should return a score less than or equal to 10. You -# have access to the variables 'error', 'warning', 'refactor', and 'convention' -# which contain the number of messages in each category, as well as 'statement' -# which is the total number of statements analyzed. This score is used by the -# global evaluation report (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. +#attr-rgx= -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details. -#msg-template= +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio). You can also give a reporter class, e.g. -# mypackage.mymodule.MyReporterClass. -output-format=text +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= -# Tells whether to display a full report or only the messages. -reports=no +# Naming style matching correct class attribute names. +class-attribute-naming-style=any -# Activate the evaluation score. -score=yes +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. +#class-attribute-rgx= +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE -[REFACTORING] +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. +#class-const-rgx= -# Maximum number of nested blocks for function / method body -max-nested-blocks=7 +# Naming style matching correct class names. +class-naming-style=PascalCase -# Complete name of functions that never returns. When checking for -# inconsistent-return-statements if a never returning function is called then -# it will be considered as an explicit return statement and no message will be -# printed. -never-returning-functions=sys.exit,argparse.parse_error +# Regular expression matching correct class names. Overrides class-naming- +# style. +#class-rgx= +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE -[SPELLING] +# Regular expression matching correct constant names. Overrides const-naming- +# style. +#const-rgx= -# Limits count of emitted suggestions for spelling mistakes. -max-spelling-suggestions=4 +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 -# Spelling dictionary name. Available dictionaries: fr_MC (myspell), fr_CA -# (myspell), fr_BE (myspell), fr_LU (myspell), fr_CH (myspell), fr_FR -# (myspell), ar (myspell), es_CR (myspell), de_CH_frami (myspell), es_EC -# (myspell), ar_YE (myspell), en_CA (myspell), ar_BH (myspell), ar_IN -# (myspell), ar_TN (myspell), en_ZA (myspell), de_DE_frami (myspell), ar_SY -# (myspell), ar_IQ (myspell), ar_LB (myspell), ar_KW (myspell), ru_RU -# (myspell), es_BO (myspell), en_GB (myspell), ar_SD (myspell), de_DE -# (myspell), es_CU (myspell), es_PA (myspell), ar_EG (myspell), es_HN -# (myspell), de_CH (myspell), es_NI (myspell), es_AR (myspell), es_ES -# (myspell), ar_SA (myspell), es_VE (myspell), de_AT_frami (myspell), it_IT -# (myspell), ar_OM (myspell), ar_DZ (myspell), it_CH (myspell), es_MX -# (myspell), es_PY (myspell), en_AU (myspell), es_DO (myspell), es_SV -# (myspell), es_PR (myspell), es_GT (myspell), ar_LY (myspell), ar_JO -# (myspell), en_US (myspell), de_AT (myspell), es_PE (myspell), ar_QA -# (myspell), es_CL (myspell), pt_BR (myspell), ar_AE (myspell), pt_PT -# (myspell), es_CO (myspell), es_UY (myspell), ar_MA (myspell), fr (myspell), -# es_US (myspell), en (aspell). -spelling-dict= +# Naming style matching correct function names. +function-naming-style=snake_case -# List of comma separated words that should be considered directives if they -# appear and the beginning of a comment and should not be checked. -spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: +# Regular expression matching correct function names. Overrides function- +# naming-style. +#function-rgx= -# List of comma separated words that should not be checked. -spelling-ignore-words= +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + x, + y, + z, + ex, + Run, + _ -# A path to a file that contains the private dictionary; one word per line. -spelling-private-dict-file= +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= -# Tells whether to store unknown words to the private dictionary (see the -# --spelling-private-dict-file option) instead of raising a message. -spelling-store-unknown-words=no +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any -[MISCELLANEOUS] +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. +#inlinevar-rgx= -# List of note tags to take in consideration, separated by a comma. -notes=FIXME, - XXX, - TODO +# Naming style matching correct method names. +method-naming-style=snake_case -# Regular expression of note tags to take in consideration. -#notes-rgx= +# Regular expression matching correct method names. Overrides method-naming- +# style. +#method-rgx= +# Naming style matching correct module names. +module-naming-style=snake_case -[STRING] +# Regular expression matching correct module names. Overrides module-naming- +# style. +#module-rgx= -# This flag controls whether inconsistent-quotes generates a warning when the -# character used as a quote delimiter is used inconsistently within a module. -check-quote-consistency=no +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= -# This flag controls whether the implicit-str-concat should generate a warning -# on implicit string concatenation in sequences defined over several lines. -check-str-concat-over-line-jumps=no +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty -[TYPECHECK] +# Naming style matching correct variable names. +variable-naming-style=snake_case -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager +# Regular expression matching correct variable names. Overrides variable- +# naming-style. +#variable-rgx= -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= -# Tells whether missing members accessed in mixin class should be ignored. A -# class is considered mixin if its name matches the mixin-class-rgx option. -ignore-mixin-members=yes +[CLASSES] -# Tells whether to warn about missing members when the owner of the attribute -# is inferred to be None. -ignore-none=yes +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis). It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules= +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=cls -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 +[DESIGN] -# Regex pattern to define which classes are considered mixins ignore-mixin- -# members is set to 'yes' -mixin-class-rgx=.*[Mm]ixin +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= -# List of decorators that change the signature of a decorated function. -signature-mutators= +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= +# Maximum number of arguments for function / method. +max-args=15 -[VARIABLES] +# Maximum number of attributes for a class (see R0902). +max-attributes=25 -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid defining new builtins when possible. -# Translation function is (unfortunately) defined as a buildin. -additional-builtins=_ +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=8 -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes +# Maximum number of branch for function / method body. +max-branches=44 -# List of names allowed to shadow builtins -allowed-redefined-builtins= +# Maximum number of locals for function / method body. +max-locals=50 -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_, - _cb +# Maximum number of parents for a class (see R0901). +max-parents=7 -# A regular expression matching the name of dummy variables (i.e. expected to -# not be used). -# On top of the defaults, simple unused is also permissible. -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 -# Argument names that match this expression will be ignored. Default to name -# with leading underscore. -ignored-argument-names=_.*|^ignored_|^unused_ +# Maximum number of return / yield for function / method body. +max-returns=9 -# Tells whether we should check for unused import in __init__ files. -init-import=no +# Maximum number of statements in function / method body. +max-statements=220 -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=past.builtins,future.builtins,builtins,io +# Minimum number of public methods for a class (see R0903). +min-public-methods=1 +[EXCEPTIONS] -[SIMILARITIES] +# Exceptions that will emit a warning when being caught. Defaults to +# "BaseException, Exception". +overgeneral-exceptions=BaseException, + Exception -# Comments are removed from the similarity computation -ignore-comments=yes -# Docstrings are removed from the similarity computation -ignore-docstrings=yes +[FORMAT] -# Imports are removed from the similarity computation -ignore-imports=no +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= -# Signatures are removed from the similarity computation -ignore-signatures=no +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ -# Minimum lines number of a similarity. -# Matching only larger chunks of code, not the default 4 lines. -min-similarity-lines=50 +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' -[LOGGING] +# Maximum number of characters on a single line. +max-line-length=100 -# The type of string formatting that logging methods do. `old` means using % -# formatting, `new` is for `{}` formatting. -logging-format-style=old +# Maximum number of lines in a module. +max-module-lines=2000 -# Logging modules to check that the string format arguments are in logging -# function parameter format. -logging-modules=logging +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no -[BASIC] -# Naming style matching correct argument names. -argument-naming-style=snake_case +[IMPORTS] -# Regular expression matching correct argument names. Overrides argument- -# naming-style. -#argument-rgx= +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= -# Naming style matching correct attribute names. -attr-naming-style=snake_case +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no -# Regular expression matching correct attribute names. Overrides attr-naming- -# style. -#attr-rgx= +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no -# Bad variable names which should always be refused, separated by a comma. -bad-names=foo, - bar, - baz, - toto, - tutu, - tata +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= -# Bad variable names regexes, separated by a comma. If names match any regex, -# they will always be refused -bad-names-rgxs= +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= -# Naming style matching correct class attribute names. -class-attribute-naming-style=any +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= -# Regular expression matching correct class attribute names. Overrides class- -# attribute-naming-style. -#class-attribute-rgx= +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= -# Naming style matching correct class constant names. -class-const-naming-style=UPPER_CASE +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= -# Regular expression matching correct class constant names. Overrides class- -# const-naming-style. -#class-const-rgx= +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant -# Naming style matching correct class names. -class-naming-style=PascalCase +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= -# Regular expression matching correct class names. Overrides class-naming- -# style. -#class-rgx= -# Naming style matching correct constant names. -const-naming-style=UPPER_CASE +[LOGGING] -# Regular expression matching correct constant names. Overrides const-naming- -# style. -#const-rgx= +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging -# Naming style matching correct function names. -function-naming-style=snake_case -# Regular expression matching correct function names. Overrides function- -# naming-style. -#function-rgx= +[MESSAGES CONTROL] -# Good variable names which should always be accepted, separated by a comma. -good-names=i, - j, - k, - x, - y, - z, - ex, - Run, - _ +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. +confidence= -# Good variable names regexes, separated by a comma. If names match any regex, -# they will always be accepted -good-names-rgxs= +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then re-enable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=bad-inline-option, + deprecated-pragma, + file-ignored, + locally-disabled, + raw-checker-failed, + suppressed-message, + use-implicit-booleaness-not-comparison, + use-symbolic-message-instead, + anomalous-backslash-in-string, + attribute-defined-outside-init, + bare-except, + broad-except, + cell-var-from-loop, + chained-comparison, + consider-iterating-dictionary, + consider-using-dict-items, + consider-using-enumerate, + consider-using-f-string, + consider-using-from-import, + consider-using-generator, + consider-using-get, + consider-using-in, + consider-using-max-builtin, + consider-using-min-builtin, + consider-using-with, + deprecated-argument, + deprecated-method, + eval-used, + expression-not-assigned, + fixme, + global-statement, + global-variable-not-assigned, + global-variable-undefined, + import-error, + import-outside-toplevel, + inconsistent-return-statements, + invalid-name, + line-too-long, + missing-class-docstring, + missing-function-docstring, + missing-module-docstring, + no-else-break, + no-else-raise, + no-else-return, + no-member, + no-name-in-module, + no-self-use, + no-value-for-parameter, + not-callable, + raise-missing-from, + redefined-builtin, + redefined-outer-name, + self-assigning-variable, + simplifiable-if-statement, + super-with-arguments, + undefined-loop-variable, + undefined-variable, + unidiomatic-typecheck, + unnecessary-comprehension, + unnecessary-pass, + unneeded-not, + unspecified-encoding, + unused-argument, + unused-import, + unused-variable, + use-a-generator, + use-list-literal, + use-maxsplit-arg, + useless-import-alias, + useless-object-inheritance, + useless-return, + wrong-import-order, + wrong-import-position -# Include a hint for the correct naming format with invalid-name. -include-naming-hint=no +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member -# Naming style matching correct inline iteration names. -inlinevar-naming-style=any -# Regular expression matching correct inline iteration names. Overrides -# inlinevar-naming-style. -#inlinevar-rgx= +[MISCELLANEOUS] -# Naming style matching correct method names. -method-naming-style=snake_case +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO -# Regular expression matching correct method names. Overrides method-naming- -# style. -#method-rgx= +# Regular expression of note tags to take in consideration. +#notes-rgx= -# Naming style matching correct module names. -module-naming-style=snake_case -# Regular expression matching correct module names. Overrides module-naming- -# style. -#module-rgx= +[STRING] -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -# These decorators are taken in consideration only for invalid-name. -property-classes=abc.abstractproperty +[REFACTORING] -# Naming style matching correct variable names. -variable-naming-style=snake_case +# Maximum number of nested blocks for function / method body +max-nested-blocks=7 -# Regular expression matching correct variable names. Overrides variable- -# naming-style. -#variable-rgx= +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error -[FORMAT] +[REPORTS] -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -expected-line-ending-format= +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'error', 'warning', 'refactor', and 'convention' +# which contain the number of messages in each category, as well as 'statement' +# which is the total number of statements analyzed. This score is used by the +# global evaluation report (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +#msg-template= -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +output-format=text -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' +# Tells whether to display a full report or only the messages. +reports=no -# Maximum number of characters on a single line. -max-line-length=100 +# Activate the evaluation score. +score=yes -# Maximum number of lines in a module. -max-module-lines=2000 -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no +[SIMILARITIES] -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no +# Comments are removed from the similarity computation +ignore-comments=yes +# Docstrings are removed from the similarity computation +ignore-docstrings=yes -[IMPORTS] +# Imports are removed from the similarity computation +ignore-imports=no -# List of modules that can be imported at any level, not just the top level -# one. -allow-any-import-level= +# Signatures are removed from the similarity computation +ignore-signatures=no -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no +# Minimum lines number of a similarity. +# Matching only larger chunks of code, not the default 4 lines. +min-similarity-lines=50 -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no -# Deprecated modules which should not be used, separated by a comma. -deprecated-modules= +[SPELLING] -# Output a graph (.gv or any supported image format) of external dependencies -# to the given file (report RP0402 must not be disabled). -ext-import-graph= +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 -# Output a graph (.gv or any supported image format) of all (i.e. internal and -# external) dependencies to the given file (report RP0402 must not be -# disabled). -import-graph= +# Spelling dictionary name. Available dictionaries: fr_MC (myspell), fr_CA +# (myspell), fr_BE (myspell), fr_LU (myspell), fr_CH (myspell), fr_FR +# (myspell), ar (myspell), es_CR (myspell), de_CH_frami (myspell), es_EC +# (myspell), ar_YE (myspell), en_CA (myspell), ar_BH (myspell), ar_IN +# (myspell), ar_TN (myspell), en_ZA (myspell), de_DE_frami (myspell), ar_SY +# (myspell), ar_IQ (myspell), ar_LB (myspell), ar_KW (myspell), ru_RU +# (myspell), es_BO (myspell), en_GB (myspell), ar_SD (myspell), de_DE +# (myspell), es_CU (myspell), es_PA (myspell), ar_EG (myspell), es_HN +# (myspell), de_CH (myspell), es_NI (myspell), es_AR (myspell), es_ES +# (myspell), ar_SA (myspell), es_VE (myspell), de_AT_frami (myspell), it_IT +# (myspell), ar_OM (myspell), ar_DZ (myspell), it_CH (myspell), es_MX +# (myspell), es_PY (myspell), en_AU (myspell), es_DO (myspell), es_SV +# (myspell), es_PR (myspell), es_GT (myspell), ar_LY (myspell), ar_JO +# (myspell), en_US (myspell), de_AT (myspell), es_PE (myspell), ar_QA +# (myspell), es_CL (myspell), pt_BR (myspell), ar_AE (myspell), pt_PT +# (myspell), es_CO (myspell), es_UY (myspell), ar_MA (myspell), fr (myspell), +# es_US (myspell), en (aspell). +spelling-dict= -# Output a graph (.gv or any supported image format) of internal dependencies -# to the given file (report RP0402 must not be disabled). -int-import-graph= +# List of comma separated words that should be considered directives if they +# appear and the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= +# List of comma separated words that should not be checked. +spelling-ignore-words= -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= -# Couples of modules and preferred modules, separated by a comma. -preferred-modules= +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no -[CLASSES] +[TYPECHECK] -# Warn about protected attribute access inside special methods -check-protected-access-in-special-methods=no +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__, - __new__, - setUp, - __post_init__ +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict, - _fields, - _replace, - _source, - _make +# Tells whether missing members accessed in mixin class should be ignored. A +# class is considered mixin if its name matches the mixin-class-rgx option. +ignore-mixin-members=yes -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=cls +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local -[DESIGN] +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= -# List of regular expressions of class ancestor names to ignore when counting -# public methods (see R0903) -exclude-too-few-public-methods= +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes -# List of qualified class names to ignore when counting class parents (see -# R0901) -ignored-parents= +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 -# Maximum number of arguments for function / method. -max-args=15 +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 -# Maximum number of attributes for a class (see R0902). -max-attributes=25 +# Regex pattern to define which classes are considered mixins ignore-mixin- +# members is set to 'yes' +mixin-class-rgx=.*[Mm]ixin -# Maximum number of boolean expressions in an if statement (see R0916). -max-bool-expr=8 +# List of decorators that change the signature of a decorated function. +signature-mutators= -# Maximum number of branch for function / method body. -max-branches=44 -# Maximum number of locals for function / method body. -max-locals=50 +[VARIABLES] -# Maximum number of parents for a class (see R0901). -max-parents=7 +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +# Translation function is (unfortunately) defined as a buildin. +additional-builtins=_ -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes -# Maximum number of return / yield for function / method body. -max-returns=9 +# List of names allowed to shadow builtins +allowed-redefined-builtins= -# Maximum number of statements in function / method body. -max-statements=220 +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb -# Minimum number of public methods for a class (see R0903). -min-public-methods=1 +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +# On top of the defaults, simple unused is also permissible. +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused +# Argument names that match this expression will be ignored. Default to name +# with leading underscore. +ignored-argument-names=_.*|^ignored_|^unused_ -[EXCEPTIONS] +# Tells whether we should check for unused import in __init__ files. +init-import=no -# Exceptions that will emit a warning when being caught. Defaults to -# "BaseException, Exception". -overgeneral-exceptions=BaseException, - Exception +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=past.builtins,future.builtins,builtins,io diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000000..25110a44c78 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,8 @@ +{ + "pylint.importStrategy": "fromEnvironment", + "python.analysis.diagnosticMode": "workspace", + "python.analysis.extraPaths": [ + "dist.x86_64-pc-linux-gnu/etc/python" + ], + "python.analysis.typeCheckingMode": "standard" +} diff --git a/gui/wxpython/.pylintrc b/gui/wxpython/.pylintrc.old3 similarity index 100% rename from gui/wxpython/.pylintrc rename to gui/wxpython/.pylintrc.old3 diff --git a/pyproject.toml b/pyproject.toml index c9f621a679f..74b38579cfa 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -404,3 +404,789 @@ exclude_dirs = [ "utils/test_generate_last_commit_file.py", ] skips = ["B324", "B110", "B101", "B112", "B311", "B404", "B603"] + + +[tool.pylint.main] +# # Analyse import fallback blocks. This can be used to support both Python 2 and 3 +# # compatible code, which means that the block might have code that exists only in +# # one or another interpreter, leading to false positives when analysed. +# # analyse-fallback-blocks = + +# # Clear in-memory caches upon conclusion of linting. Useful if running pylint in +# # a server-like mode. +# # clear-cache-post-run = + +# # Always return a 0 (non-error) status code, even if lint errors are found. This +# # is primarily useful in continuous integration scripts. +# # exit-zero = + +# # A comma-separated list of package or module names from where C extensions may +# # be loaded. Extensions are loading into the active Python interpreter and may +# # run arbitrary code. +# # extension-pkg-allow-list = + +# # A comma-separated list of package or module names from where C extensions may +# # be loaded. Extensions are loading into the active Python interpreter and may +# # run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# # for backward compatibility.) +# # extension-pkg-whitelist = + +# # Return non-zero exit code if any of these messages/categories are detected, +# # even if score is above --fail-under value. Syntax same as enable. Messages +# # specified are enabled, while categories only check already-enabled messages. +# # fail-on = + +# # Specify a score threshold under which the program will exit with error. +# fail-under = 10 + +# # Interpret the stdin as a python script, whose filename needs to be passed as +# # the module_or_package argument. +# # from-stdin = + +# # Files or directories to be skipped. They should be base names, not paths. +# ignore = ["CVS"] + +# Add files or directories matching the regular expressions patterns to the +# ignore-list. The regex matches against paths and can be in Posix or Windows +# format. Because '\\' represents the directory delimiter on Windows systems, it +# can't be used as an escape character. +ignore-paths = [".*/python/libgrass_interface_generator/.*", ".*/Makefile$", ".*/OBJ\\..*"] + +# # Files or directories matching the regular expression patterns are skipped. The +# # regex matches against base names, not paths. The default value ignores Emacs +# # file locks +# ignore-patterns = ["^\\.#"] + +# # List of module names for which member attributes should not be checked and will +# # not be imported (useful for modules/projects where namespaces are manipulated +# # during runtime and thus existing member attributes cannot be deduced by static +# # analysis). It supports qualified module names, as well as Unix pattern +# # matching. +# # ignored-modules = + +# # Python code to execute, usually for sys.path manipulation such as +# # pygtk.require(). +# # init-hook = + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use, and will cap the count on Windows to +# avoid hangs. +jobs = 0 + +# # Control the amount of potential inferred values when inferring a single object. +# # This can help the performance when dealing with large functions or complex, +# # nested conditions. +# limit-inference-results = 100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +# load-plugins = [ +# # "pylint_per_file_ignores" +# # , +# # "pylint.extensions.redefined_variable_type", # *GRASS TODO: Enable later* +# # "pylint.extensions.bad_builtin", # *GRASS TODO: Enable later* +# ] +# load-plugins = ["pylint_per_file_ignores"] +load-plugins = [ + # "pylint_per_file_ignores", + # "pylint.extensions.redefined_variable_type", # *GRASS TODO: Enable later* + # "pylint.extensions.bad_builtin", # *GRASS TODO: Enable later* + # "no_self_use", + "pylint.extensions.no_self_use" +] + +# # Pickle collected data for later comparisons. +# persistent = true + +# # Resolve imports to .pyi stubs if available. May reduce no-member messages and +# # increase not-an-iterable messages. +# # prefer-stubs = + +# Minimum Python version to use for version dependent checks. Will default to the +# version used to run pylint. +# *GRASS modified* +# *GRASS TODO: keep in sync with MIN_PYTHON_VERSION supported* +py-version = "3.9" + +# # Discover python modules and packages in the file system subtree. +# # recursive = + +# Add paths to the list of the source roots. Supports globbing patterns. The +# source root is an absolute path or a path relative to the current working +# directory used to determine a package namespace for modules located under the +# source root. +# source-roots = ["./python/", "gui/"] +# source-roots = ["./python/*", "gui"] +# source-roots = ["python", "gui"] +# source-roots = "python" +# source-roots ="python/" +# source-roots = ["./python/grass/*", "./gui/wxpython/*"] +# source-roots = ["./python/grass", "./gui/wxpython/*"] + +# # When enabled, pylint would attempt to guess common misconfiguration and emit +# # user-friendly hints instead of false-positive error messages. +# suggestion-mode = true + +# # Allow loading of arbitrary C extensions. Extensions are imported into the +# # active Python interpreter and may run arbitrary code. +# # unsafe-load-any-extension = + +# [tool.pylint.basic] +# # Naming style matching correct argument names. +# argument-naming-style = "snake_case" + +# # Regular expression matching correct argument names. Overrides argument-naming- +# # style. If left empty, argument names will be checked with the set naming style. +# # argument-rgx = + +# # Naming style matching correct attribute names. +# attr-naming-style = "snake_case" + +# # Regular expression matching correct attribute names. Overrides attr-naming- +# # style. If left empty, attribute names will be checked with the set naming +# # style. +# # attr-rgx = + +# # Bad variable names which should always be refused, separated by a comma. +# bad-names = ["foo", "bar", "baz", "toto", "tutu", "tata"] + +# # Bad variable names regexes, separated by a comma. If names match any regex, +# # they will always be refused +# # bad-names-rgxs = + +# # Naming style matching correct class attribute names. +# class-attribute-naming-style = "any" + +# # Regular expression matching correct class attribute names. Overrides class- +# # attribute-naming-style. If left empty, class attribute names will be checked +# # with the set naming style. +# # class-attribute-rgx = + +# # Naming style matching correct class constant names. +# class-const-naming-style = "UPPER_CASE" + +# # Regular expression matching correct class constant names. Overrides class- +# # const-naming-style. If left empty, class constant names will be checked with +# # the set naming style. +# # class-const-rgx = + +# # Naming style matching correct class names. +# class-naming-style = "PascalCase" + +# # Regular expression matching correct class names. Overrides class-naming-style. +# # If left empty, class names will be checked with the set naming style. +# # class-rgx = + +# # Naming style matching correct constant names. +# const-naming-style = "UPPER_CASE" + +# # Regular expression matching correct constant names. Overrides const-naming- +# # style. If left empty, constant names will be checked with the set naming style. +# # const-rgx = + +# # Minimum line length for functions/classes that require docstrings, shorter ones +# # are exempt. +# docstring-min-length = -1 + +# # Naming style matching correct function names. +# function-naming-style = "snake_case" + +# # Regular expression matching correct function names. Overrides function-naming- +# # style. If left empty, function names will be checked with the set naming style. +# # function-rgx = + +# # Good variable names which should always be accepted, separated by a comma. +# good-names = ["i", "j", "k", "ex", "Run", "_"] + +# # Good variable names regexes, separated by a comma. If names match any regex, +# # they will always be accepted +# # good-names-rgxs = + +# # Include a hint for the correct naming format with invalid-name. +# # include-naming-hint = + +# # Naming style matching correct inline iteration names. +# inlinevar-naming-style = "any" + +# # Regular expression matching correct inline iteration names. Overrides +# # inlinevar-naming-style. If left empty, inline iteration names will be checked +# # with the set naming style. +# # inlinevar-rgx = + +# # Naming style matching correct method names. +# method-naming-style = "snake_case" + +# # Regular expression matching correct method names. Overrides method-naming- +# # style. If left empty, method names will be checked with the set naming style. +# # method-rgx = + +# # Naming style matching correct module names. +# module-naming-style = "snake_case" + +# # Regular expression matching correct module names. Overrides module-naming- +# # style. If left empty, module names will be checked with the set naming style. +# # module-rgx = + +# # Colon-delimited sets of names that determine each other's naming style when the +# # name regexes allow several styles. +# # name-group = + +# # Regular expression which should only match function or class names that do not +# # require a docstring. +# no-docstring-rgx = "^_" + +# # List of decorators that produce properties, such as abc.abstractproperty. Add +# # to this list to register other decorators that produce valid properties. These +# # decorators are taken in consideration only for invalid-name. +# property-classes = ["abc.abstractproperty"] + +# # Regular expression matching correct type alias names. If left empty, type alias +# # names will be checked with the set naming style. +# # typealias-rgx = + +# # Regular expression matching correct type variable names. If left empty, type +# # variable names will be checked with the set naming style. +# # typevar-rgx = + +# # Naming style matching correct variable names. +# variable-naming-style = "snake_case" + +# # Regular expression matching correct variable names. Overrides variable-naming- +# # style. If left empty, variable names will be checked with the set naming style. +# # variable-rgx = + +# [tool.pylint.classes] +# # Warn about protected attribute access inside special methods +# # check-protected-access-in-special-methods = + +# # List of method names used to declare (i.e. assign) instance attributes. +# defining-attr-methods = [ +# "__init__", +# "__new__", +# "setUp", +# "asyncSetUp", +# "__post_init__", +# ] + +# # List of member names, which should be excluded from the protected access +# # warning. +# exclude-protected = [ +# "_asdict", +# "_fields", +# "_replace", +# "_source", +# "_make", +# "os._exit", +# ] + +# # List of valid names for the first argument in a class method. +# valid-classmethod-first-arg = ["cls"] + +# # List of valid names for the first argument in a metaclass class method. +# valid-metaclass-classmethod-first-arg = ["mcs"] +# [tool.pylint.MASTER] +# load-plugins=[ +# "pylint_per_file_ignores", + +# ] + +# [tool.pylint.messages_control] +# per-file-ignores = [ +# "scripts/modal/:import-error", # Modal Image imports are a false positive +# "scripts/db.py:not-callable", # not-callable is a false positive, SEE: https://github.com/pylint-dev/pylint/issues/8138 +# ] + +[tool.pylint.design] +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +# exclude-too-few-public-methods = + +# List of qualified class names to ignore when counting class parents (see R0901) +# ignored-parents = + +# Maximum number of arguments for function / method. +# *GRASS modified: default 5, (see R0913)* +# *GRASS TODO: Try to reduce this value* +max-args = 15 + +# Maximum number of attributes for a class (see R0902). +# *GRASS modified: default 7* +# *GRASS TODO: Try to reduce this value* +max-attributes = 25 + +# Maximum number of boolean expressions in an if statement (see R0916). +# *GRASS modified: default 5* +# *GRASS TODO: Try to reduce this value* +max-bool-expr = 8 + +# Maximum number of branch for function / method body. +# *GRASS modified: default 12, (see R0912)* +# *GRASS TODO: Try to reduce this value* +max-branches = 44 + +# Maximum number of locals for function / method body. +# *GRASS modified: default 15, (see R0914)* +# *GRASS TODO: Try to reduce this value* +max-locals = 50 + +# # Maximum number of parents for a class (see R0901). +# max-parents = 7 + +# # Maximum number of public methods for a class (see R0904). +# max-public-methods = 20 + +# Maximum number of return / yield for function / method body. +# *GRASS modified: default 6, (see R0911)* +# *GRASS TODO: Try to reduce this value* +max-returns = 9 + +# Maximum number of statements in function / method body. +# *GRASS modified: default 50, (see R0915)* +# *GRASS TODO: Try to reduce this value* +max-statements = 220 + +# Minimum number of public methods for a class (see R0903). +# *GRASS modified: default 2, (see R0915)* +# *GRASS TODO: Try to increase this value* +min-public-methods = 1 + +# [tool.pylint.exceptions] +# # Exceptions that will emit a warning when caught. +# overgeneral-exceptions = ["builtins.BaseException", "builtins.Exception"] + +[tool.pylint.format] +# # Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +# # expected-line-ending-format = + +# # Regexp for a line that is allowed to be longer than the limit. +# ignore-long-lines = "^\\s*(# )??$" + +# # Number of spaces of indent required inside a hanging or continued line. +# indent-after-paren = 4 + +# # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# # tab). +# indent-string = " " + +# # Maximum number of characters on a single line. +# max-line-length = 100 + +# Maximum number of lines in a module. +# *GRASS modified: default 1000, (see C0302)* +# *GRASS TODO: Try to reduce this value* +max-module-lines = 2000 + +# # Allow the body of a class to be on the same line as the declaration if body +# # contains single statement. +# # single-line-class-stmt = + +# # Allow the body of an if to be on the same line as the test if there is no else. +# # single-line-if-stmt = + +[tool.pylint.imports] +# # List of modules that can be imported at any level, not just the top level one. +# # allow-any-import-level = + +# # Allow explicit reexports by alias from a package __init__. +# # allow-reexport-from-package = + +# # Allow wildcard imports from modules that define __all__. +# # allow-wildcard-with-all = + +# # Deprecated modules which should not be used, separated by a comma. +# # deprecated-modules = + +# # Output a graph (.gv or any supported image format) of external dependencies to +# # the given file (report RP0402 must not be disabled). +# # ext-import-graph = + +# # Output a graph (.gv or any supported image format) of all (i.e. internal and +# # external) dependencies to the given file (report RP0402 must not be disabled). +# # import-graph = + +# # Output a graph (.gv or any supported image format) of internal dependencies to +# # the given file (report RP0402 must not be disabled). +# # int-import-graph = + +# # Force import order to recognize a module as part of the standard compatibility +# # libraries. +# # known-standard-library = + +# # Force import order to recognize a module as part of a third party library. +# known-third-party = ["enchant"] + +# # Couples of modules and preferred modules, separated by a comma. +# # preferred-modules = + +# [tool.pylint.logging] +# # The type of string formatting that logging methods do. `old` means using % +# # formatting, `new` is for `{}` formatting. +# logging-format-style = "old" + +# # Logging modules to check that the string format arguments are in logging +# # function parameter format. +# logging-modules = ["logging"] + +[tool.pylint."messages control"] +# # Only show warnings with the listed confidence levels. Leave empty to show all. +# # Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, UNDEFINED. +# confidence = [ +# "HIGH", +# "CONTROL_FLOW", +# "INFERENCE", +# "INFERENCE_FAILURE", +# "UNDEFINED", +# ] + +# Disable the message, report, category or checker with the given id(s). You can +# either give multiple identifiers separated by comma (,) or put this option +# multiple times (only on the command line, not in the configuration file where +# it should appear only once). You can also use "--disable=all" to disable +# everything first and then re-enable specific checks. For example, if you want +# to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable = [ + # *GRASS: The 10 following rules are disabled by default* + "bad-inline-option", + "deprecated-pragma", + "file-ignored", + "locally-disabled", + "raw-checker-failed", + "suppressed-message", + "use-implicit-booleaness-not-comparison-to-string", + "use-implicit-booleaness-not-comparison-to-zero", + "use-symbolic-message-instead", + "useless-suppression", + # *GRASS modified: The following rules are added to the disabled list* + # *GRASS TODO: Try to ignore less rules* + "anomalous-backslash-in-string", + "attribute-defined-outside-init", + "bare-except", + "broad-except", + "cell-var-from-loop", + "chained-comparison", + "consider-iterating-dictionary", + "consider-using-dict-items", + "consider-using-enumerate", + "consider-using-f-string", + "consider-using-from-import", + "consider-using-generator", + "consider-using-get", + "consider-using-in", + "consider-using-max-builtin", + "consider-using-min-builtin", + "consider-using-with", + "deprecated-argument", + "deprecated-method", + "eval-used", + "expression-not-assigned", + "fixme", + "global-statement", + "global-variable-not-assigned", + "global-variable-undefined", + "import-error", + "import-outside-toplevel", + "inconsistent-return-statements", + "invalid-name", + "line-too-long", + "missing-class-docstring", + "missing-function-docstring", + "missing-module-docstring", + "no-else-break", + "no-else-raise", + "no-else-return", + "no-member", + "no-name-in-module", + "no-value-for-parameter", + "not-callable", + "raise-missing-from", + "redefined-builtin", + "redefined-outer-name", + "self-assigning-variable", + "simplifiable-if-statement", + "super-with-arguments", + "undefined-loop-variable", + "undefined-variable", + "unidiomatic-typecheck", + "unnecessary-comprehension", + "unnecessary-pass", + "unneeded-not", + "unspecified-encoding", + "unused-argument", + "unused-import", + "unused-variable", + "use-a-generator", + "use-list-literal", + "use-maxsplit-arg", + "useless-import-alias", + "useless-object-inheritance", + "useless-return", + "wrong-import-order", + "wrong-import-position", +] + +# # Enable the message, report, category or checker with the given id(s). You can +# # either give multiple identifier separated by comma (,) or put this option +# # multiple time (only on the command line, not in the configuration file where it +# # should appear only once). See also the "--disable" option for examples. +# # enable = + +# [tool.pylint.'MESSAGES CONTROL'] +# per-file-ignores = [ +# "/folder_1/:missing-function-docstring,W0621,W0240,C0115", +# "file.py:C0116,E0001" +# ] + +# [tool.pylint-per-file-ignores] +# "/folder_1/"="missing-function-docstring,W0621,W0240,C0115" +# "file.py"="C0116,E0001" + +# [tool.pylint.messages_control] +# Modal Image imports are a false positive +# not-callable is a false positive, SEE: https://github.com/pylint-dev/pylint/issues/8138 +# per-file-ignores = """ +# python/grass/jupyter/.*:R0917,too-many-positional-arguments, +# python/grass/script/core.py:C0302,R0917 +# """ +# per-file-ignores = """ +# python/grass/jupyter:R0917,too-many-positional-arguments, +# python/grass/jupyter/*.py:R0917,too-many-positional-arguments, +# python/grass/script/core.py:C0302,R0917 +# """ +# per-file-ignores = """ +# scripts/modal/:import-error, +# scripts/db.py:not-callable, +# python/grass/jupyter/*:R0917, +# python/grass/script/core.py:C0302,R0917 +# """ +# per-file-ignores = """ +# scripts/modal/:import-error +# scripts/db.py:not-callable +# python/grass/jupyter/*.py:R0917, +# python/grass/jupyter/interactivemap.py:too-many-positional-arguments +# """ +# per-file-ignores=""" +# """ +# [tool.pylint.method_args] +# # List of qualified names (i.e., library.method) which require a timeout +# # parameter e.g. 'requests.api.get,requests.api.post' +# timeout-methods = [ +# "requests.api.delete", +# "requests.api.get", +# "requests.api.head", +# "requests.api.options", +# "requests.api.patch", +# "requests.api.post", +# "requests.api.put", +# "requests.api.request", +# ] + +# [tool.pylint.miscellaneous] +# # List of note tags to take in consideration, separated by a comma. +# notes = ["FIXME", "XXX", "TODO"] + +# # Regular expression of note tags to take in consideration. +# # notes-rgx = + +[tool.pylint.refactoring] +# Maximum number of nested blocks for function / method body +# *GRASS modified: default 5, (see R1702)* +# *GRASS TODO: Try to reduce this value* +max-nested-blocks = 7 + +# # Complete name of functions that never returns. When checking for inconsistent- +# # return-statements if a never returning function is called then it will be +# # considered as an explicit return statement and no message will be printed. +# never-returning-functions = ["sys.exit", "argparse.parse_error"] + +# # Let 'consider-using-join' be raised when the separator to join on would be non- +# # empty (resulting in expected fixes of the type: ``"- " + " - ".join(items)``) +# suggest-join-with-non-empty-separator = true + +# [tool.pylint.reports] +# # Python expression which should return a score less than or equal to 10. You +# # have access to the variables 'fatal', 'error', 'warning', 'refactor', +# # 'convention', and 'info' which contain the number of messages in each category, +# # as well as 'statement' which is the total number of statements analyzed. This +# # score is used by the global evaluation report (RP0004). +# evaluation = "max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10))" + +# # Template used to display messages. This is a python new-style format string +# # used to format the message information. See doc for all details. +# # msg-template = + +# Set the output format. Available formats are: text, parseable, colorized, json2 +# (improved json format), json (old json format) and msvs (visual studio). You +# can also give a reporter class, e.g. mypackage.mymodule.MyReporterClass. +output-format = "colorized" + +# # Tells whether to display a full report or only the messages. +# # reports = + +# # Activate the evaluation score. +# score = true + +[tool.pylint.similarities] +# # Comments are removed from the similarity computation +# ignore-comments = true + +# # Docstrings are removed from the similarity computation +# ignore-docstrings = true + +# # Imports are removed from the similarity computation +# ignore-imports = true + +# # Signatures are removed from the similarity computation +# ignore-signatures = true + +# Minimum lines number of a similarity. +# *GRASS modified: default 4, (see R0801)* +# *GRASS TODO: Try to reduce this value* +# *GRASS justification: Matching only larger chunks of code, not the default 4 lines.* +min-similarity-lines = 50 + +# [tool.pylint.spelling] +# # Limits count of emitted suggestions for spelling mistakes. +# max-spelling-suggestions = 4 + +# # Spelling dictionary name. No available dictionaries : You need to install both +# # the python package and the system dependency for enchant to work. +# # spelling-dict = + +# # List of comma separated words that should be considered directives if they +# # appear at the beginning of a comment and should not be checked. +# spelling-ignore-comment-directives = "fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:" + +# # List of comma separated words that should not be checked. +# # spelling-ignore-words = + +# # A path to a file that contains the private dictionary; one word per line. +# # spelling-private-dict-file = + +# # Tells whether to store unknown words to the private dictionary (see the +# # --spelling-private-dict-file option) instead of raising a message. +# # spelling-store-unknown-words = + +# [tool.pylint.typecheck] +# # List of decorators that produce context managers, such as +# # contextlib.contextmanager. Add to this list to register other decorators that +# # produce valid context managers. +# contextmanager-decorators = ["contextlib.contextmanager"] + +# # List of members which are set dynamically and missed by pylint inference +# # system, and so shouldn't trigger E1101 when accessed. Python regular +# # expressions are accepted. +# # generated-members = + +# # Tells whether missing members accessed in mixin class should be ignored. A +# # class is considered mixin if its name matches the mixin-class-rgx option. +# # Tells whether to warn about missing members when the owner of the attribute is +# # inferred to be None. +# ignore-none = true + +# # This flag controls whether pylint should warn about no-member and similar +# # checks whenever an opaque object is returned when inferring. The inference can +# # return multiple potential results while evaluating a Python object, but some +# # branches might not be evaluated, which results in partial inference. In that +# # case, it might be useful to still emit no-member and other checks for the rest +# # of the inferred objects. +# ignore-on-opaque-inference = true + +# # List of symbolic message names to ignore for Mixin members. +# ignored-checks-for-mixins = [ +# "no-member", +# "not-async-context-manager", +# "not-context-manager", +# "attribute-defined-outside-init", +# ] + +# # List of class names for which member attributes should not be checked (useful +# # for classes with dynamically set attributes). This supports the use of +# # qualified names. +# ignored-classes = [ +# "optparse.Values", +# "thread._local", +# "_thread._local", +# "argparse.Namespace", +# ] + +# # Show a hint with possible names when a member name was not found. The aspect of +# # finding the hint is based on edit distance. +# missing-member-hint = true + +# # The minimum edit distance a name should have in order to be considered a +# # similar match for a missing member name. +# missing-member-hint-distance = 1 + +# # The total number of similar names that should be taken in consideration when +# # showing a hint for a missing member. +# missing-member-max-choices = 1 + +# # Regex pattern to define which classes are considered mixins. +# mixin-class-rgx = ".*[Mm]ixin" + +# # List of decorators that change the signature of a decorated function. +# # signature-mutators = + +[tool.pylint.variables] +# List of additional names supposed to be defined in builtins. Remember that you +# should avoid defining new builtins when possible. +# *GRASS modified: default '# additional-builtins ='* +# *GRASS justification: Translation function is (unfortunately) defined as a builtin.* +# *GRASS TODO: Find another pattern for translation that allows to use _ as a discard variable and other* +additional-builtins = ["_"] + +# # Tells whether unused global variables should be treated as a violation. +# allow-global-unused-variables = true + +# # List of names allowed to shadow builtins +# # allowed-redefined-builtins = + +# # List of strings which can identify a callback function by name. A callback name +# # must start or end with one of those strings. +# callbacks = ["cb_", "_cb"] + +# # A regular expression matching the name of dummy variables (i.e. expected to not +# # be used). +# dummy-variables-rgx = "_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_" + +# # Argument names that match this expression will be ignored. +# ignored-argument-names = "_.*|^ignored_|^unused_" + +# # Tells whether we should check for unused import in __init__ files. +# # init-import = + +# # List of qualified module names which can have objects that can redefine +# # builtins. +# redefining-builtins-modules = [ +# "six.moves", +# "past.builtins", +# "future.builtins", +# "builtins", +# "io", +# ] +[tool.pylint-per-file-ignores] +# "/folder_1/"="missing-function-docstring,W0621,W0240,C0115" +# "file.py"="C0116,E0001" +"grass/jupyter/map3d.py"="R0917" +"./python/grass/jupyter/region.py"="R0917,too-many-positional-arguments" +# "grass/jupyter/region.py"="too-many-positional-arguments" +# "python/grass/jupyter/.*" = "R0917" +"python/grass/script/core.py" = "C0302,R0917" +# per-file-ignores = """ +# scripts/modal/:import-error, +# scripts/db.py:not-callable, +# python/grass/jupyter/*:R0917, +# python/grass/script/core.py:C0302,R0917 +# """ +[tool.pyright] +include = ["python"] +exclude = ["**/__pycache__", "**/OBJ.*", "bin.*/**", "dist.*/**"] + +# Set extraPath to the output of $(grass --config python_path) + +# *GRASS modified* +# *GRASS TODO: keep in sync with MIN_PYTHON_VERSION supported* +pythonVersion = "3.9" diff --git a/python/.pylintrc b/python/.pylintrc.old2 similarity index 100% rename from python/.pylintrc rename to python/.pylintrc.old2 diff --git a/python/grass/imaging/images2gif.py b/python/grass/imaging/images2gif.py index d37ec0c4e32..cc5f383de85 100644 --- a/python/grass/imaging/images2gif.py +++ b/python/grass/imaging/images2gif.py @@ -213,12 +213,11 @@ def getAppExt(self, loops=float("inf")): # (the extension interprets zero loops # to mean an infinite number of loops) # Mmm, does not seem to work - if True: - bb = "\x21\xFF\x0B" # application extension - bb += "NETSCAPE2.0" - bb += "\x03\x01" - bb += intToBin(loops) - bb += "\x00" # end + bb = "\x21\xFF\x0B" # application extension + bb += "NETSCAPE2.0" + bb += "\x03\x01" + bb += intToBin(loops) + bb += "\x00" # end return bb def getGraphicsControlExt(self, duration=0.1, dispose=2): @@ -442,33 +441,29 @@ def writeGifToFile(self, fp, images, durations, loops, xys, disposes): # Next frame is not the first firstFrame = False - if True: - # Write palette and image data - - # Gather info - data = getdata(im) - imdes, data = data[0], data[1:] - graphext = self.getGraphicsControlExt( - durations[frames], disposes[frames] - ) - # Make image descriptor suitable for using 256 local color palette - lid = self.getImageDescriptor(im, xys[frames]) - - # Write local header - if (palette != globalPalette) or (disposes[frames] != 2): - # Use local color palette - fp.write(graphext) - fp.write(lid) # write suitable image descriptor - fp.write(palette) # write local color table - fp.write("\x08") # LZW minimum size code - else: - # Use global color palette - fp.write(graphext) - fp.write(imdes) # write suitable image descriptor + # Write palette and image data + # Gather info + data = getdata(im) + imdes, data = data[0], data[1:] + graphext = self.getGraphicsControlExt(durations[frames], disposes[frames]) + # Make image descriptor suitable for using 256 local color palette + lid = self.getImageDescriptor(im, xys[frames]) + + # Write local header + if (palette != globalPalette) or (disposes[frames] != 2): + # Use local color palette + fp.write(graphext) + fp.write(lid) # write suitable image descriptor + fp.write(palette) # write local color table + fp.write("\x08") # LZW minimum size code + else: + # Use global color palette + fp.write(graphext) + fp.write(imdes) # write suitable image descriptor - # Write image data - for d in data: - fp.write(d) + # Write image data + for d in data: + fp.write(d) # Prepare for next round frames += 1 diff --git a/python/grass/jupyter/utils.py b/python/grass/jupyter/utils.py index b06553d2d3b..c443d2590f2 100644 --- a/python/grass/jupyter/utils.py +++ b/python/grass/jupyter/utils.py @@ -11,6 +11,7 @@ # for details. """Utility functions warpping existing processes in a suitable way""" +from collections.abc import Mapping import tempfile import json import os @@ -303,7 +304,9 @@ def query_vector(coord, vector_list, distance): return _style_table(final_output) -def estimate_resolution(raster, mapset, location, dbase, env): +def estimate_resolution( + raster: str, mapset: str, location: str, dbase: str, env: Mapping +) -> float: """Estimates resolution of reprojected raster. :param str raster: name of raster @@ -326,9 +329,9 @@ def estimate_resolution(raster, mapset, location, dbase, env): ).strip() params = gs.parse_key_val(output, vsep=" ") output = gs.read_command("g.region", flags="ug", env=env, **params) - output = gs.parse_key_val(output, val_type=float) - cell_ns = (output["n"] - output["s"]) / output["rows"] - cell_ew = (output["e"] - output["w"]) / output["cols"] + keyval = gs.parse_key_val(output, val_type=float) + cell_ns = (keyval["n"] - keyval["s"]) / keyval["rows"] + cell_ew = (keyval["e"] - keyval["w"]) / keyval["cols"] return (cell_ew + cell_ns) / 2.0 diff --git a/python/grass/pygrass/rpc/__init__.py b/python/grass/pygrass/rpc/__init__.py index e95c3453250..9685b279b0e 100644 --- a/python/grass/pygrass/rpc/__init__.py +++ b/python/grass/pygrass/rpc/__init__.py @@ -478,7 +478,7 @@ def get_vector_features_as_wkb_list( doctest.testmod() - """Remove the generated maps, if exist""" + # Remove the generated maps, if exist mset = utils.get_mapset_raster(test_raster_name, mapset="") if mset: Module("g.remove", flags="f", type="raster", name=test_raster_name) diff --git a/python/grass/script/array.py b/python/grass/script/array.py index 29c99d7617c..5f23bb6f022 100644 --- a/python/grass/script/array.py +++ b/python/grass/script/array.py @@ -131,6 +131,7 @@ def __del__(self): class array(np.memmap): + # pylint: disable-next=signature-differs; W0222 def __new__(cls, mapname=None, null=None, dtype=np.double, env=None): """Define new numpy array @@ -242,6 +243,7 @@ def write(self, mapname, title=None, null=None, overwrite=None, quiet=None): class array3d(np.memmap): + # pylint: disable-next=signature-differs; W0222 def __new__(cls, mapname=None, null=None, dtype=np.double, env=None): """Define new 3d numpy array diff --git a/python/grass/script/db.py b/python/grass/script/db.py index 5591b92d4ca..0ae4fe6b53f 100644 --- a/python/grass/script/db.py +++ b/python/grass/script/db.py @@ -127,9 +127,8 @@ def db_connection(force=False, env=None): :return: parsed output of db.connect """ # noqa: E501 try: - nuldev = open(os.devnull, "w") - conn = parse_command("db.connect", flags="g", stderr=nuldev, env=env) - nuldev.close() + with open(os.devnull, "w") as nuldev: + conn = parse_command("db.connect", flags="g", stderr=nuldev, env=env) except CalledModuleError: conn = None diff --git a/python/grass/script/utils.py b/python/grass/script/utils.py index 0a32a9e7b4e..57a4f4bff4c 100644 --- a/python/grass/script/utils.py +++ b/python/grass/script/utils.py @@ -231,7 +231,7 @@ def text_to_string(text, encoding=None): return decode(text, encoding=encoding) -def parse_key_val(s, sep="=", dflt=None, val_type=None, vsep=None): +def parse_key_val(s, sep="=", dflt=None, val_type=None, vsep=None) -> KeyValue: """Parse a string into a dictionary, where entries are separated by newlines and the key and value are separated by `sep` (default: `=`) diff --git a/temporal/t.unregister/t.unregister.py b/temporal/t.unregister/t.unregister.py index cacfe579a7b..a67ef91adb5 100755 --- a/temporal/t.unregister/t.unregister.py +++ b/temporal/t.unregister/t.unregister.py @@ -103,17 +103,16 @@ def main(): # Read the map list from file if file: - fd = open(file) - - line = True - while True: - line = fd.readline() - if not line: - break - - mapname = line.strip() - mapid = dummy.build_id(mapname, mapset) - maplist.append(mapid) + with open(file) as fd: + line = True + while True: + line = fd.readline() + if not line: + break + + mapname = line.strip() + mapid = dummy.build_id(mapname, mapset) + maplist.append(mapid) num_maps = len(maplist) update_dict = {} diff --git a/utils/pylintrc.txt b/utils/pylintrc.txt.old4 similarity index 100% rename from utils/pylintrc.txt rename to utils/pylintrc.txt.old4