diff --git a/.circleci/config.yml b/.circleci/config.yml index 42a909c4..0020a495 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -163,31 +163,14 @@ jobs: - restore_cache: keys: - v1-dependencies-python:3.11-{{ .Revision }} - - run: - name: Lint code with flake8 - command: ~/.local/bin/flake8 --toml-config core/pyproject.toml core plugins - working_directory: src/backend - - run: - name: Lint code with isort - command: ~/.local/bin/isort --recursive --check-only --settings-file core/pyproject.toml core plugins - working_directory: src/backend - run: name: Lint code with black command: ~/.local/bin/black --check --config core/pyproject.toml core plugins working_directory: src/backend - run: - name: Lint code with pylint - command: ~/.local/bin/pylint core plugins + name: Lint code with ruff + command: ~/.local/bin/ruff --config core/pyproject.toml core plugins working_directory: src/backend - - run: - name: Lint code with bandit - command: ~/.local/bin/bandit -c core/pyproject.toml -qr core/warren plugins - working_directory: src/backend - - run: - name: Lint code with pydocstyle - command: ~/.local/bin/pydocstyle --config core/pyproject.toml core plugins - working_directory: src/backend - test-backend: parameters: python-image: diff --git a/Makefile b/Makefile index 03b31e47..2661cbab 100644 --- a/Makefile +++ b/Makefile @@ -175,16 +175,10 @@ fixtures: \ # -- Linters -# -# Nota bene: Black should come after isort just in case they don't agree... lint: ## lint backend python sources lint: \ - lint-isort \ lint-black \ - lint-flake8 \ - lint-pylint \ - lint-bandit \ - lint-pydocstyle \ + lint-ruff \ lint-frontend .PHONY: lint @@ -195,30 +189,15 @@ lint-black: ## lint backend python sources with black @$(COMPOSE_RUN_BACKEND) black --config core/pyproject.toml core plugins .PHONY: lint-black -lint-flake8: ## lint backend python sources with flake8 - @echo 'lint:flake8 started…' - @$(COMPOSE_RUN_BACKEND) flake8 --toml-config core/pyproject.toml core plugins -.PHONY: lint-flake8 - -lint-isort: ## automatically re-arrange python imports in backend code base - @echo 'lint:isort started…' - @$(COMPOSE_RUN_BACKEND) isort --settings-file core/pyproject.toml --atomic core plugins -.PHONY: lint-isort - -lint-pylint: ## lint backend python sources with pylint - @echo 'lint:pylint started…' - @$(COMPOSE_RUN_BACKEND) pylint core plugins -.PHONY: lint-pylint - -lint-bandit: ## lint backend python sources with bandit - @echo 'lint:bandit started…' - @$(COMPOSE_RUN_BACKEND) bandit -c core/pyproject.toml -qr core/warren plugins -.PHONY: lint-bandit - -lint-pydocstyle: ## lint Python docstrings with pydocstyle - @echo 'lint:pydocstyle started…' - @$(COMPOSE_RUN_BACKEND) pydocstyle --config core/pyproject.toml core plugins -.PHONY: lint-pydocstyle +lint-ruff: ## lint backend python sources with ruff + @echo 'lint:ruff started…' + @$(COMPOSE_RUN_BACKEND) ruff --config core/pyproject.toml core plugins +.PHONY: lint-ruff + +lint-ruff-fix: ## lint and fix backend python sources with ruff + @echo 'lint:ruff-fix started…' + @$(COMPOSE_RUN_BACKEND) ruff --config core/pyproject.toml core plugins --fix +.PHONY: lint-ruff-fix ### Frontend ### diff --git a/src/backend/.pylintrc b/src/backend/.pylintrc deleted file mode 100644 index c8e33b52..00000000 --- a/src/backend/.pylintrc +++ /dev/null @@ -1,452 +0,0 @@ -[MASTER] - -# 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=pydantic - -# Add files or directories to the blacklist. They should be base names, not -# paths. -ignore=build - -# Add files or directories matching the regex patterns to the blacklist. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins=pylint.extensions.no_self_use - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# 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 - - -[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 (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 - - -[REPORTS] - -# 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= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).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 - -# Activate the evaluation score. -score=yes - - -[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=optparse.Values,sys.exit - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[SPELLING] - -# Limits count of emitted suggestions for spelling mistakes -max-spelling-suggestions=4 - -# 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 - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -notes=FIXME, - XXX, - TODO - - -[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 -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=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 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,responses, - Course,Organization,Page,Person,PersonTitle,Category - -# 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= - -# 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 - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# 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. expectedly -# not used). -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_ - -# 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 - - -[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=88 - -# 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 - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=yes - -# Minimum lines number of a similarity. -# First implementations of CMS wizards have common fields we do not want to factorize for now -min-similarity-lines=35 - - -[BASIC] - -# Naming style matching correct argument names -argument-naming-style=snake_case - -# Regular expression matching correct argument names. Overrides argument- -# 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 -#attr-rgx= - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo, - bar, - baz, - toto, - tutu, - tata - -# Naming style matching correct class attribute names -class-attribute-naming-style=any - -# Regular expression matching correct class attribute names. Overrides class- -# attribute-naming-style -#class-attribute-rgx= - -# Naming style matching correct class names -class-naming-style=PascalCase - -# Regular expression matching correct class names. Overrides class-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 -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__)|urlpatterns|logger)$ - -# 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 -#function-rgx= - -# Good variable names which should always be accepted, separated by a comma -good-names=i, - j, - k, - cm, - ex, - Run, - _ - -# 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 -#inlinevar-rgx= - -# Naming style matching correct method names -method-naming-style=snake_case - -# Regular expression matching correct method names. Overrides method-naming- -# style -method-rgx=([a-z_][a-z0-9_]{2,50}|setUp|set[Uu]pClass|tearDown|tear[Dd]ownClass|assert[A-Z]\w*|maxDiff|test_[a-z0-9_]+)$ - -# Naming style matching correct module names -module-naming-style=snake_case - -# Regular expression matching correct module names. Overrides module-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. -property-classes=abc.abstractproperty - -# Naming style matching correct variable names -variable-naming-style=snake_case - -# Regular expression matching correct variable names. Overrides variable- -# naming-style -#variable-rgx= - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# 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=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# 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 internal dependencies in 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 - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__, - __new__, - setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict, - _fields, - _replace, - _source, - _make - -# 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] - -# 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 a if statement -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=0 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=builtins.Exception diff --git a/src/backend/core/pyproject.toml b/src/backend/core/pyproject.toml index b77c5b9b..dd4641d7 100644 --- a/src/backend/core/pyproject.toml +++ b/src/backend/core/pyproject.toml @@ -46,22 +46,17 @@ dynamic = ["version"] [project.optional-dependencies] dev = [ - "bandit[toml]==1.7.4", "black==23.1.0", "build==0.10.0", "factory-boy==3.2.1", "Faker==17.0.0", - "Flake8-pyproject==1.2.2", - "flake8==6.0.0", "httpx==0.24.1", "ipdb==0.13.11", "ipython==8.10.0", - "isort==5.12.0", - "pydocstyle==6.3.0", - "pylint==2.16.2", "pytest==7.2.1", "pytest-cov==4.0.0", "pytest-httpx==0.22.0", + "ruff==0.0.272", ] ci = [ "twine==4.0.2", @@ -72,31 +67,6 @@ version = { attr = "warren.__version__" } # Third party packages configuration -[tool.flake8] -max-line-length = 88 -extend-ignore = ["E203"] -exclude = [ - "build", - "__pycache__", -] - -[tool.pydocstyle] -convention = "google" -match_dir = "^(?!tests|venv|build|scripts).*" - -[tool.isort] -known_warren = ["warren"] -sections = [ - "FUTURE", - "STDLIB", - "THIRDPARTY", - "WARREN", - "FIRSTPARTY", - "LOCALFOLDER", -] -skip_glob = ["venv"] -profile = "black" - [tool.pytest.ini_options] addopts = "-v --cov-report term-missing --cov=core --cov=plugins" python_files = [ @@ -107,5 +77,33 @@ testpaths = [ "tests", ] -[tool.bandit] -exclude_dirs = ["tests",] +[tool.ruff] +select = [ + "B", # flake8-bugbear + "C4", # flake8-comprehensions + "D", # pydocstyle + "E", # pycodestyle error + "F", # Pyflakes + "I", # Isort + "ISC", # flake8-implicit-str-concat + "PLC", # Pylint Convention + "PLE", # Pylint Error + "PLR", # Pylint Refactor + "PLW", # Pylint Warning + "RUF100", # Ruff unused-noqa + "S", # flake8-bandit + "W", # pycodestyle warning +] + +# Assume Python 3.8. +target-version = "py38" + +[tool.ruff.per-file-ignores] +"*/tests/*" = [ + "S101", + "PLR2004", # Pylint magic-value-comparison +] + +[tool.ruff.pydocstyle] +# Use Google-style docstrings. +convention = "google" diff --git a/src/backend/core/warren/tests/__init__.py b/src/backend/core/warren/tests/__init__.py index e69de29b..28ca2dd3 100644 --- a/src/backend/core/warren/tests/__init__.py +++ b/src/backend/core/warren/tests/__init__.py @@ -0,0 +1 @@ +"""Warren tests package.""" diff --git a/src/backend/core/warren/tests/fixtures/__init__.py b/src/backend/core/warren/tests/fixtures/__init__.py index e69de29b..13bd4295 100644 --- a/src/backend/core/warren/tests/fixtures/__init__.py +++ b/src/backend/core/warren/tests/fixtures/__init__.py @@ -0,0 +1 @@ +"""Warren tests fixtures.""" diff --git a/src/backend/core/warren/tests/test_filters.py b/src/backend/core/warren/tests/test_filters.py index d7bfbd66..acd2705a 100644 --- a/src/backend/core/warren/tests/test_filters.py +++ b/src/backend/core/warren/tests/test_filters.py @@ -14,7 +14,6 @@ # pylint: disable=no-member def test_datetime_range_model(): """Test the DatetimeRange model.""" - # Arrow supports various input string formats, let's just test one period = DatetimeRange(since="2023-01-01 10:42", until="2023-01-02 12:22") @@ -51,7 +50,6 @@ def test_datetime_range_model(): # pylint: disable=no-member def test_datetime_range_model_defaults(monkeypatch): """Test the DatetimeRange model defaults.""" - now = arrow.utcnow() monkeypatch.setattr(arrow, "utcnow", lambda: now) @@ -70,7 +68,6 @@ def test_datetime_range_model_defaults(monkeypatch): def test_base_query_filters_model(): """Test the BaseQueryFilters model.""" - filters = BaseQueryFilters(since="2023-01-11", until="2023-02-11") assert filters.since == arrow.get("2023-01-11") assert filters.until == arrow.get("2023-02-11") diff --git a/src/backend/plugins/video/tests/__init__.py b/src/backend/plugins/video/tests/__init__.py index e69de29b..fe64881e 100644 --- a/src/backend/plugins/video/tests/__init__.py +++ b/src/backend/plugins/video/tests/__init__.py @@ -0,0 +1 @@ +"""Video tests package.""" diff --git a/src/backend/plugins/video/tests/conftest.py b/src/backend/plugins/video/tests/conftest.py index 0e9b674d..0f4a8b9a 100644 --- a/src/backend/plugins/video/tests/conftest.py +++ b/src/backend/plugins/video/tests/conftest.py @@ -1,16 +1,14 @@ -"""Module py.test fixtures.""" +"""Video plugin test fixtures.""" -# pylint: disable=unused-import from dataclasses import dataclass from datetime import datetime, timedelta import pytest from ralph.models.xapi.concepts.constants.video import RESULT_EXTENSION_TIME from ralph.models.xapi.concepts.verbs.video import PlayedVerb -from warren_video.factories import VideoPlayedFactory - from warren.tests.fixtures.app import http_client # noqa: F401 from warren.tests.fixtures.asynchronous import anyio_backend # noqa: F401 +from warren_video.factories import VideoPlayedFactory @pytest.fixture @@ -21,7 +19,7 @@ def non_mocked_hosts() -> list: @pytest.fixture(scope="module") def video_statements(): - """Generate test video statements""" + """Generate test video statements.""" @dataclass class VideoStatementParams: diff --git a/src/backend/plugins/video/tests/test_api.py b/src/backend/plugins/video/tests/test_api.py index 57d75a84..cf618a36 100644 --- a/src/backend/plugins/video/tests/test_api.py +++ b/src/backend/plugins/video/tests/test_api.py @@ -9,10 +9,9 @@ from pytest_httpx import HTTPXMock from ralph.models.xapi import VideoPlayed from ralph.models.xapi.concepts.verbs.video import PlayedVerb -from warren_video.api import VideoDayViews, VideoViews - from warren.backends import lrs_client from warren.filters import DatetimeRange +from warren_video.api import VideoDayViews, VideoViews @pytest.mark.anyio @@ -59,7 +58,6 @@ async def test_views_valid_video_id_path_but_no_matching_video( http_client: AsyncClient, httpx_mock: HTTPXMock, video_id ): """Test the video views endpoint with a valid "video_id" but no results.""" - date_range = DatetimeRange() base_url = "http://fake-lrs.com" @@ -108,7 +106,6 @@ async def test_views_backend_query( video_statements: List[VideoPlayed], ): """Test the video views endpoint backend query results.""" - video_id = "uuid://ba4252ce-d042-43b0-92e8-f033f45612ee" date_range = DatetimeRange() diff --git a/src/backend/plugins/video/warren_video/api.py b/src/backend/plugins/video/warren_video/api.py index f313cffe..625d65c7 100644 --- a/src/backend/plugins/video/warren_video/api.py +++ b/src/backend/plugins/video/warren_video/api.py @@ -12,12 +12,11 @@ from ralph.models.xapi.concepts.verbs.video import PlayedVerb from starlette import status from typing_extensions import Annotated # python <3.9 compat -from warren_video.conf import settings as video_settings - from warren.backends import lrs_client from warren.conf import settings from warren.fields import IRI, Date from warren.filters import BaseQueryFilters +from warren_video.conf import settings as video_settings router = APIRouter( prefix="/video", diff --git a/src/backend/plugins/video/warren_video/factories.py b/src/backend/plugins/video/warren_video/factories.py index 96cb4103..73dae76f 100644 --- a/src/backend/plugins/video/warren_video/factories.py +++ b/src/backend/plugins/video/warren_video/factories.py @@ -1,7 +1,6 @@ """Factories for video xAPI events.""" from ralph.models.xapi.concepts.constants.video import RESULT_EXTENSION_TIME from ralph.models.xapi.video.statements import VideoPlayed - from warren.factories.base import BaseXapiStatementFactory