From b44044356989f535bd6b4b9feb7a8b05f9462b99 Mon Sep 17 00:00:00 2001 From: David Aguilar Date: Sat, 17 Feb 2024 12:10:53 -0800 Subject: [PATCH] tests: use "ruff" to validate code instead of "pylint" Closes: #1353 Signed-off-by: David Aguilar --- .github/workflows/ci.yml | 2 - .pylintrc | 319 ----------------------------------------------- CHANGES.rst | 4 + README.md | 2 +- garden.yaml | 9 +- pyproject.toml | 3 + pytest.ini | 5 +- setup.cfg | 8 +- 8 files changed, 15 insertions(+), 337 deletions(-) delete mode 100644 .pylintrc diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6490ca2f..c67717f7 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -50,8 +50,6 @@ jobs: python3-send2trash # Development dependencies sudo apt-get install \ - pylint \ - python-is-python3 \ python3-pytest \ python3-setuptools-scm \ python3-sphinx diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index 46091ca3..00000000 --- a/.pylintrc +++ /dev/null @@ -1,319 +0,0 @@ -[MASTER] - -# Specify what version of Python to evaluate code against. -py-version = 3.6 - -# Specify a configuration file. -#rcfile= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Add files or directories to ignore. They should be base names, not paths. -ignore=.git,qtpy,sphinxtogithub - -# Pickle collected data for later comparisons. -persistent=yes - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins= - -# Use multiple processes to speed up Pylint. -jobs=4 - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - -# 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-whitelist=binascii,math,PyQt4,PyQt5,PyQt6,PySide,PySide2,select,struct,struct.pack,struct.unpack - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# 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. See also the "--disable" option for examples. -#enable= - -# 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 reenable 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-option-value, - consider-using-f-string, - duplicate-code, - invalid-name, - missing-docstring, - no-self-use, - raise-missing-from, - super-with-arguments, - too-many-instance-attributes, - useless-object-inheritance, - useless-option-value, - -[REPORTS] - -# Set the output format. Available formats are text, parseable, colorized, msvs -# (visual studio) and html. You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=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={path}:{line}:{column}: {msg} ({symbol}) - - -[BASIC] - -# Good variable names which should always be accepted, separated by a comma -good-names=f,i,j,k,ok,v,_ - -# Bad variable names which should always be refused, separated by a comma -bad-names= - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=yes - -# Regular expression matching correct function names -function-rgx=[a-z_][a-z0-9_]{2,30}$ - -# Regular expression matching correct variable names -variable-rgx=[a-z_][a-z0-9_]{2,30}$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Regular expression matching correct attribute names -attr-rgx=[a-z_][a-z0-9_]{2,30}$ - -# Regular expression matching correct argument names -argument-rgx=[a-z_][a-z0-9_]{2,30}$ - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct class names -class-rgx=[A-Z_][a-zA-Z0-9]+$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Regular expression matching correct method names -method-rgx=[a-z_][a-z0-9_]{2,30}$ - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=__.*__ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -notes=FIXME,XXX,TODO - - -[FORMAT] - -# Maximum number of characters on a single line. -max-line-length=88 - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# 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 - -# Maximum number of lines in a module -max-module-lines=3000 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -expected-line-ending-format=LF - - -[TYPECHECK] - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# 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 -ignored-modules= - -# List of classes names for which member attributes should not be checked -# (useful for classes with attributes dynamically set). -ignored-classes= - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E0201 when accessed. Python regular -# expressions are accepted. -generated-members= - - -[SIMILARITIES] - -# Minimum lines number of a similarity. -min-similarity-lines=4 - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=no - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[VARIABLES] - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_$|dummy - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-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 - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# 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 - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=12 - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.* - -# Maximum number of locals for function / method body -max-locals=32 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of branch for function / method body -max-branches=24 - -# Maximum number of statements in function / method body -max-statements=300 - -# Maximum number of parents for a class (see R0901). -max-parents=10 - -# Maximum number of attributes for a class (see R0902). -max-attributes=7 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=0 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=40 - - -[IMPORTS] - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= diff --git a/CHANGES.rst b/CHANGES.rst index 713e8ea7..f5e6e1b3 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -27,6 +27,10 @@ Development ----------- * The "actions/cache" and "styfle/cancel-workflow-action" github actions were upgraded. +* The test suite now uses ``ruff`` to validate python code. ``pylint`` is no longer used. + (`#1353 `_) + (`#1383 `_) + .. _v4.5.0: diff --git a/README.md b/README.md index 685fed76..aeab24b9 100644 --- a/README.md +++ b/README.md @@ -400,7 +400,7 @@ The following commands should be run during development: # Run the unit tests $ garden test - # Run tests and longer-running pylint checks + # Run tests and doc checks $ garden check # Run tests against multiple python interpreters using tox diff --git a/garden.yaml b/garden.yaml index a5e4417f..8df177f3 100644 --- a/garden.yaml +++ b/garden.yaml @@ -38,14 +38,13 @@ trees: - dev/development - dev/build dev/build: ${activate} ${PIP} install --editable '.[build]' - dev/development: ${activate} ${PIP} install --editable '.[docs,dev]' + dev/development: ${activate} ${PIP} install --editable '.[docs,dev,testing]' dev/extras: ${activate} ${PIP} install --editable '.[extras]' dev/pyqt6: ${activate} ${PIP} install --editable '.[pyqt6]' dev/env: ${activate} "$@" check>: - test - doc - - pylint fmt: | ${activate} ${CERCIS} --version @@ -106,9 +105,6 @@ trees: cola/*/*.py pages<: doc pages: ${GARDEN} -vv -D prefix=${TREE_PATH}/pages install docs "$@" - pylint: | - ${PYLINT} --version - ${PYLINT} ${PYLINT_OPTIONS} --rcfile=.pylintrc "$@" cola test run: ${activate} ./bin/git-cola "$@" run/qt6: ${activate} QT_API=PyQt6 ./bin/git-cola "$@" test: ${activate} ${PYTEST_CMD} cola test "$@" @@ -271,9 +267,6 @@ variables: MKDIR_P: mkdir -p MSGMERGE: msgmerge PIP: pip - PYLINT: ${activate} ${PYTHON} -B -m pylint - PYLINT_OPTIONS: | - $ ${activate} ${PYLINT} --score=no --help >/dev/null 2>&1 && printf '%s' --score=no PYTEST: ${activate} ${PYTHON} -B -m pytest PYTEST_OPTIONS: $ test "$(uname -s)" != "Linux" && printf '%s' --ignore=cola/inotify.py PYTEST_CMD: ${PYTEST} ${PYTEST_OPTIONS} -p no:cacheprovider diff --git a/pyproject.toml b/pyproject.toml index f25e6cd6..08177485 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -31,5 +31,8 @@ build-backend = "setuptools.build_meta" function-definition-extra-indent = false line-length = 88 +[tool.pytest-enabler.ruff] +addopts = "--ruff" + [tool.setuptools_scm] fallback_version = "4.5.0" diff --git a/pytest.ini b/pytest.ini index da06c9bb..efc3c0a9 100644 --- a/pytest.ini +++ b/pytest.ini @@ -1,7 +1,6 @@ [pytest] norecursedirs=dist build .tox .eggs env* addopts=--doctest-modules -doctest_optionflags=ALLOW_UNICODE ELLIPSIS filterwarnings= - # https://github.com/pytest-dev/pytest/issues/6928 - ignore:direct construction of .*Item has been deprecated:DeprecationWarning + # https://github.com/pytest-dev/pytest/issues/6928 + ignore:direct construction of .*Item has been deprecated:DeprecationWarning diff --git a/setup.cfg b/setup.cfg index 37a5dc64..5f5bc945 100644 --- a/setup.cfg +++ b/setup.cfg @@ -54,10 +54,11 @@ share/metainfo = [options.extras_require] testing = # upstream - pytest >= 3.5, !=3.7.3 - pytest-checkdocs >= 1.2.3 + pytest >= 6 + pytest-checkdocs >= 2.4 pytest-cov - pytest-enabler >= 1.0.1 + pytest-enabler >= 2.2 + pytest-ruff >= 0.2.1 # local @@ -80,7 +81,6 @@ extras = # Developer tools. dev = cercis - pylint >= 2.14.0 # Build and packaging tools. build = -- 2.11.4.GIT