diff --git a/.flake8 b/.flake8 deleted file mode 100644 index d078cf9002..0000000000 --- a/.flake8 +++ /dev/null @@ -1,164 +0,0 @@ -[flake8] - -select = - # Full lists are given in order to suppress all errors from other plugins - # Full list of pyflakes error codes: - F401, # module imported but unused - F402, # import module from line N shadowed by loop variable - F403, # 'from module import *' used; unable to detect undefined names - F404, # future import(s) name after other statements - F405, # name may be undefined, or defined from star imports: module - F406, # 'from module import *' only allowed at module level - F407, # an undefined __future__ feature name was imported - F601, # dictionary key name repeated with different values - F602, # dictionary key variable name repeated with different values - F621, # too many expressions in an assignment with star-unpacking - F622, # two or more starred expressions in an assignment (a, *b, *c = d) - F631, # assertion test is a tuple, which are always True - F701, # a break statement outside of a while or for loop - F702, # a continue statement outside of a while or for loop - F703, # a continue statement in a finally block in a loop - F704, # a yield or yield from statement outside of a function - F705, # a return statement with arguments inside a generator - F706, # a return statement outside of a function/method - F707, # an except: block as not the last exception handler - F721, F722, # doctest syntax error syntax error in forward type annotation - F811, # redefinition of unused name from line N - F812, # list comprehension redefines name from line N - F821, # undefined name name - F822, # undefined name name in __all__ - F823, # local variable name referenced before assignment - F831, # duplicate argument name in function definition - F841, # local variable name is assigned to but never used - F901, # raise NotImplemented should be raise NotImplementedError - - # Full list of pycodestyle violations: - E101, # indentation contains mixed spaces and tabs - E111, # indentation is not a multiple of four - E112, # expected an indented block - E113, # unexpected indentation - E114, # indentation is not a multiple of four (comment) - E115, # expected an indented block (comment) - E116, # unexpected indentation (comment) - E121, # continuation line under-indented for hanging indent - E122, # continuation line missing indentation or outdented - E123, # closing bracket does not match indentation of opening bracket's line - E124, # closing bracket does not match visual indentation - E125, # continuation line with same indent as next logical line - E126, # continuation line over-indented for hanging indent - E127, # continuation line over-indented for visual indent - E128, # continuation line under-indented for visual indent - E129, # visually indented line with same indent as next logical line - E131, # continuation line unaligned for hanging indent - E133, # closing bracket is missing indentation - E201, # whitespace after '(' - E202, # whitespace before ')' - E211, # whitespace before '(' - E221, # multiple spaces before operator - E222, # multiple spaces after operator - E223, # tab before operator - E224, # tab after operator - E226, # missing whitespace around arithmetic operator - E227, # missing whitespace around bitwise or shift operator - E228, # missing whitespace around modulo operator - E231, # missing whitespace after ',', ';', or ':' - E241, # multiple spaces after ',' - E242, # tab after ',' - E251, # unexpected spaces around keyword / parameter equals - E261, # at least two spaces before inline comment - E262, # inline comment should start with '# ' - E265, # block comment should start with '# ' - E266, # too many leading '#' for block comment - E271, # multiple spaces after keyword - E272, # multiple spaces before keyword - E273, # tab after keyword - E274, # tab before keyword - E275, # missing whitespace after keyword - E301, # expected 1 blank line, found 0 - E302, # expected 2 blank lines, found 0 - E303, # too many blank lines - E304, # blank lines found after function decorator - E305, # expected 2 blank lines after end of function or class - E306, # expected 1 blank line before a nested definition - E401, # multiple imports on one line - E402, # module level import not at top of file - E501, # line too long (82 > 79 characters) - E502, # the backslash is redundant between brackets - E701, # multiple statements on one line (colon) - E702, # multiple statements on one line (semicolon) - E703, # statement ends with a semicolon - E704, # multiple statements on one line (def) - E711, # comparison to None should be 'if cond is None:' - E712, # comparison to True should be 'if cond is True:' or 'if cond:' - E713, # test for membership should be 'not in' - E714, # test for object identity should be 'is not' - E721, # do not compare types, use 'isinstance()' - E722, # do not use bare except, specify exception instead - E731, # do not assign a lambda expression, use a def - E741, # do not use variables named 'l', 'O', or 'I' - E742, # do not define classes named 'l', 'O', or 'I' - E743, # do not define functions named 'l', 'O', or 'I' - E901, # SyntaxError or IndentationError - E902, # IOError - W191, # indentation contains tabs - W291, # trailing whitespace - W292, # no newline at end of file - W293, # blank line contains whitespace - W391, # blank line at end of file - W503, # line break before binary operator - W504, # line break after binary operator - W505, # doc line too long (82 > 79 characters) - W601, # .has_key() is deprecated, use 'in' - W602, # deprecated form of raising exception - W603, # '<>' is deprecated, use '!=' - W604, # backticks are deprecated, use 'repr()' - W605, # invalid escape sequence 'x' - W606, # 'async' and 'await' are reserved keywords starting with Python 3.7 - - # Full list of flake8 violations - E999, # failed to compile a file into an Abstract Syntax Tree for the plugins that require it - - # Full list of mccabe violations - C901 # complexity value provided by the user - -ignore = - E221, # multiple spaces before operator - E225, # missing whitespace around operator - E231, # missing whitespace after ',', ';', or ':' - E241, # multiple spaces after ',' - W503, # line break before binary operator - W504 # line break after binary operator - -max-line-length = 160 - -show_source = True - -statistics = True - -exclude = - .git, - __pycache__, - # submodules - components/bootloader/subproject/components/micro-ecc/micro-ecc, - components/bt/host/nimble/nimble, - components/cmock/CMock, - components/json/cJSON, - components/mbedtls/mbedtls, - components/openthread/openthread, - components/unity/unity, - components/spiffs/spiffs, - # autogenerated scripts - components/protocomm/python/constants_pb2.py, - components/protocomm/python/sec0_pb2.py, - components/protocomm/python/sec1_pb2.py, - components/protocomm/python/sec2_pb2.py, - components/protocomm/python/session_pb2.py, - components/wifi_provisioning/python/wifi_ctrl_pb2.py, - components/wifi_provisioning/python/wifi_scan_pb2.py, - components/wifi_provisioning/python/wifi_config_pb2.py, - components/wifi_provisioning/python/wifi_constants_pb2.py, - components/esp_local_ctrl/python/esp_local_ctrl_pb2.py, - -per-file-ignores = - # Sphinx conf.py files use star imports to setup config variables - docs/conf_common.py: F405 diff --git a/.gitlab/CODEOWNERS b/.gitlab/CODEOWNERS index 36e1976100..0ccb4bda6a 100644 --- a/.gitlab/CODEOWNERS +++ b/.gitlab/CODEOWNERS @@ -66,6 +66,7 @@ /export.* @esp-idf-codeowners/tools /install.* @esp-idf-codeowners/tools /pytest.ini @esp-idf-codeowners/ci +/ruff.toml @esp-idf-codeowners/tools /sdkconfig.rename @esp-idf-codeowners/build-config /sonar-project.properties @esp-idf-codeowners/ci diff --git a/.gitlab/ci/README.md b/.gitlab/ci/README.md index ab138c0943..d51a4f5673 100644 --- a/.gitlab/ci/README.md +++ b/.gitlab/ci/README.md @@ -145,11 +145,11 @@ check if there's a suitable `.if-` anchor 1. if there is, create a rule following [`rules` Template Naming Rules](#rules-template-naming-rules).For detail information, please refer to [GitLab Documentation `rules-if`](https://docs.gitlab.com/ee/ci/yaml/README.html#rulesif). Here's an example. ```yaml - .rules:patterns:python-files: + .rules:patterns:clang_tidy: rules: - <<: *if-protected - <<: *if-dev-push - changes: *patterns-python-files + changes: *patterns-c-files ``` 2. if there isn't diff --git a/.gitlab/ci/rules.yml b/.gitlab/ci/rules.yml index ad98792510..eb2488a844 100644 --- a/.gitlab/ci/rules.yml +++ b/.gitlab/ci/rules.yml @@ -270,11 +270,6 @@ - <<: *if-dev-push changes: *patterns-c-files -.rules:patterns:python-files: - rules: - - <<: *if-protected - - <<: *if-dev-push - changes: *patterns-python-files #.rules:patterns:static-code-analysis-preview: # rules: diff --git a/.gitlab/ci/static-code-analysis.yml b/.gitlab/ci/static-code-analysis.yml index 2773d2cbf7..eb40c9c3ae 100644 --- a/.gitlab/ci/static-code-analysis.yml +++ b/.gitlab/ci/static-code-analysis.yml @@ -16,28 +16,6 @@ clang_tidy_check: --limit-file tools/ci/static-analysis-rules.yml --xtensa-include-dir -check_pylint: - extends: - - .pre_check_template - - .rules:patterns:python-files - needs: - - pipeline_variables - artifacts: - reports: - codequality: pylint.json - paths: - - pylint.json - expire_in: 1 week - when: always - script: - - | - if [ -n "$CI_MERGE_REQUEST_IID" ]; then - export files=$(echo "$GIT_DIFF_OUTPUT" | grep ".py$" | xargs); - else - export files=$(git ls-files "*.py" | xargs); - fi - - if [ -z "$files" ]; then echo "No python files found"; exit 0; fi - - run_cmd pylint --exit-zero --load-plugins=pylint_gitlab --output-format=gitlab-codeclimate:pylint.json $files # ## build stage ## Sonarqube related jobs put here for this reason: diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 37121a452e..1f6b291178 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -8,8 +8,8 @@ repos: rev: "v0.9.7" hooks: - id: ruff-format - args: [ "--preview" ] - files: 'pytest_.*\.py$' + - id: ruff + args: [ "--fix" ] - repo: local hooks: - id: pytest-linter @@ -65,23 +65,6 @@ repos: - id: no-commit-to-branch name: Do not use uppercase letters in the branch name args: ['--pattern', '^[^A-Z]*[A-Z]'] - - repo: https://github.com/PyCQA/flake8 - rev: 5.0.4 - hooks: - - id: flake8 - args: ['--config=.flake8', '--tee', '--benchmark'] - - repo: https://github.com/asottile/reorder-python-imports - rev: v3.12.0 - hooks: - - id: reorder-python-imports - name: Reorder Python imports - args: [--py38-plus] - exclude: > - (?x)^( - .*_pb2.py - )$ - |pytest_eth_iperf.py - |pytest_iperf.py - repo: https://github.com/codespell-project/codespell rev: v2.3.0 hooks: diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index 720bbf92d4..0000000000 --- a/.pylintrc +++ /dev/null @@ -1,641 +0,0 @@ -[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=no - -# Clear in-memory caches upon conclusion of linting. Useful if running pylint -# in a server-like mode. -clear-cache-post-run=no - -# Load and enable all available extensions. Use --list-extensions to see a list -# all available extensions. -#enable-all-extensions= - -# In error mode, messages with a category besides ERROR or FATAL are -# suppressed, and no reports are done by default. Error mode is compatible with -# disabling specific errors. -#errors-only= - -# 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= - -# 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 -# (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=1 - -# 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= - -# Pickle collected data for later comparisons. -persistent=yes - -# Minimum Python version to use for version dependent checks. Will default to -# the version used to run pylint. -py-version=3.8 - -# Discover python modules and packages in the file system subtree. -recursive=no - -# 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= - -# When enabled, pylint would attempt to guess common misconfiguration and emit -# user-friendly hints instead of false-positive error messages. -suggestion-mode=yes - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - -# In verbose mode, extra non-checker-related info will be displayed. -#verbose= - - -[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=no - -# 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= - - -[CLASSES] - -# Warn about protected attribute access inside special methods -check-protected-access-in-special-methods=no - -# 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 - - -[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. -max-args=5 - -# Maximum number of attributes for a class (see R0902). -max-attributes=7 - -# Maximum number of boolean expressions in an if statement (see R0916). -max-bool-expr=5 - -# Maximum number of branch for function / method body. -max-branches=12 - -# Maximum number of locals for function / method body. -max-locals=15 - -# 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. -max-returns=6 - -# Maximum number of statements in function / method body. -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=2 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when caught. -overgeneral-exceptions=builtins.BaseException,builtins.Exception - - -[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=160 - -# Maximum number of lines in a module. -max-module-lines=1000 - -# 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 - - -[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=no - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# 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= - - -[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 - - -[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=raw-checker-failed, - bad-inline-option, - locally-disabled, - file-ignored, - suppressed-message, - useless-suppression, - deprecated-pragma, - use-symbolic-message-instead, - missing-function-docstring, # Modified since here, include this line - missing-class-docstring, - missing-module-docstring, - wrong-import-order, - invalid-name, - too-few-public-methods, - too-many-locals, - ungrouped-imports, # since we have isort in pre-commit - no-name-in-module, # since we have flake8 to check this - too-many-instance-attributes, - -# 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 - - -[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 - - -[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= - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - -# 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 - - -[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, json -# and msvs (visual studio). You can also give a reporter class, e.g. -# mypackage.mymodule.MyReporterClass. -#output-format= - -# Tells whether to display a full report or only the messages. -reports=no - -# Activate the evaluation score. -score=yes - - -[SIMILARITIES] - -# Comments are removed from the similarity computation -ignore-comments=yes - -# Docstrings are removed from the similarity computation -ignore-docstrings=yes - -# Imports are removed from the similarity computation -ignore-imports=yes - -# Signatures are removed from the similarity computation -ignore-signatures=yes - -# Minimum lines number of a similarity. -min-similarity-lines=4 - - -[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=no - - -[STRING] - -# 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 - -# 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 - - -[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 to warn about missing members when the owner of the attribute -# is inferred to be None. -ignore-none=yes - -# 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 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=yes - -# 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= - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid defining new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# 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=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io diff --git a/ruff.toml b/ruff.toml index 5ce8d55523..4d795ecbf0 100644 --- a/ruff.toml +++ b/ruff.toml @@ -2,6 +2,50 @@ line-length = 120 target-version = "py38" [format] -quote-style = "single" -exclude = [] -docstring-code-format = true + quote-style = "single" + docstring-code-format = true + +[lint] + select = [ + "A", # flake8-builtins + "E", # pycodestyle + "F", # pyflakes + "W", # pycodestyle + "I", # reorder-imports + ] + ignore = [ + "E203", # whitespace before ':' + "E221", # multiple spaces before operator + "E225", # missing whitespace around operator + "E231", # missing whitespace after ',', ';', or ':' + "E241", # multiple spaces after ',' + ] + + # Exclude a variety of commonly ignored directories. + exclude = [ + ".git", + "__pycache__", + # submodules + "components/bootloader/subproject/components/micro-ecc/micro-ecc", + "components/bt/host/nimble/nimble", + "components/cmock/CMock", + "components/JSON/cJSON", + "components/mbedtls/mbedtls", + "components/openthread/openthread", + "components/unity/unity", + "components/spiffs/spiffs", + # autogenerated scripts + "components/protocomm/python/constants_pb2.py", + "components/protocomm/python/sec0_pb2.py", + "components/protocomm/python/sec1_pb2.py", + "components/protocomm/python/sec2_pb2.py", + "components/protocomm/python/session_pb2.py", + "components/wifi_provisioning/python/wifi_ctrl_pb2.py", + "components/wifi_provisioning/python/wifi_scan_pb2.py", + "components/wifi_provisioning/python/wifi_config_pb2.py", + "components/wifi_provisioning/python/wifi_constants_pb2.py", + "components/esp_local_ctrl/python/esp_local_ctrl_pb2.py", + ] + +[lint.isort] + force-single-line = true diff --git a/tools/requirements/requirements.ci.txt b/tools/requirements/requirements.ci.txt index dfec5b20fc..1b2ada0d29 100644 --- a/tools/requirements/requirements.ci.txt +++ b/tools/requirements/requirements.ci.txt @@ -13,6 +13,5 @@ junit_xml python-gitlab pyyaml SimpleWebSocketServer -pylint-gitlab minio prettytable diff --git a/tools/test_build_system/README.md b/tools/test_build_system/README.md index 30fa0e7eec..9472b642cb 100644 --- a/tools/test_build_system/README.md +++ b/tools/test_build_system/README.md @@ -56,7 +56,8 @@ def test_something(test_app_copy): # the current working directory now contains the copy of the test app ``` -If the test case doesn't use the `test_app_copy` argument, pylint will typically warn about an unused argument, even if the fixture is actually used. To avoid the warning, use the following pattern: +If the test case doesn't use the `test_app_copy` argument, ruff will typically warn about an unused argument, even if the fixture is actually used. To avoid the warning, use the following pattern: + ```python @pytest.mark.usefixtures('test_app_copy') def test_something(idf_py): @@ -138,7 +139,7 @@ def test_idf_copy(idf_copy): @pytest.mark.usefixtures('test_app_copy') def test_build_jsons_updated_by_reconfigure(idf_py): globs = ['build/*.json'] - + idf_py('reconfigure') snapshot_1 = get_snapshot(globs) snapshot_2 = get_snapshot(globs)