From 6bf2af7efc8d0efe2f063ec817ba23c314605518 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Mikrut?= Date: Mon, 15 Jan 2024 08:34:39 +0100 Subject: [PATCH] Use ruff for formatting and code checking --- .flake8 | 13 -- .github/workflows/static.yml | 50 +++++ .isort.cfg | 15 -- .pylintrc | 409 ----------------------------------- .travis.yml | 50 ----- .yapf | 16 -- INSTALL.rst | 2 +- Makefile | 34 +-- pyproject.toml | 2 +- ruff.toml | 44 ++++ setup.py | 4 +- 11 files changed, 108 insertions(+), 531 deletions(-) delete mode 100644 .flake8 create mode 100644 .github/workflows/static.yml delete mode 100644 .isort.cfg delete mode 100644 .pylintrc delete mode 100644 .travis.yml delete mode 100644 .yapf create mode 100644 ruff.toml diff --git a/.flake8 b/.flake8 deleted file mode 100644 index 5f97fe87c..000000000 --- a/.flake8 +++ /dev/null @@ -1,13 +0,0 @@ -[flake8] -ignore = - # , # description - # do not use bare except' (done by pylint) - E722, - # line break before binary operator - W503, - # module level import not at top of file (gtk stuff) - E402, -max-line-length = 120 -exclude = .venv,venv,.env,env,lutris/game.py -max-complexity = 15 -accept-encodings = utf-8 diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml new file mode 100644 index 000000000..b301906da --- /dev/null +++ b/.github/workflows/static.yml @@ -0,0 +1,50 @@ +on: + pull_request: + +name: Static Analysis +jobs: + mypy-checker: + name: Mypy + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Print current dir + run: pwd + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + - name: Install Ubuntu dependencies + run: | + sudo apt update + sudo apt-get install libdbus-1-dev pkg-config libgirepository1.0-dev + - name: Install Python dependencies + run: | + python -m pip install --upgrade pip + make req-python + make dev + - name: Run mypy analysis + run: | + mypy --version + mypy . + + ruff-checker: + name: Ruff + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + - name: Install Python dependencies + run: | + python -m pip install --upgrade pip + make dev + - name: Check code style + run: + ruff --version + ruff check . + - name: Check format + continue-on-error: true # TODO remove this line when format is applied + run: ruff format . --check diff --git a/.isort.cfg b/.isort.cfg deleted file mode 100644 index fa2f31926..000000000 --- a/.isort.cfg +++ /dev/null @@ -1,15 +0,0 @@ -[settings] -line_length=120 -multi_line_output=6 -skip= - application.py, -;known_deps = -;known_third_party = -known_first_party = lutris -sections = - FUTURE, - STDLIB, - THIRDPARTY, - FIRSTPARTY, - LOCALFOLDER -default_section=THIRDPARTY diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index 508be402c..000000000 --- a/.pylintrc +++ /dev/null @@ -1,409 +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=lxml.etree - -# Add files or directories to the blacklist. They should be base names, not -# paths. -ignore= - -# 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="import gi; gi.require_version('Gdk', '3.0'); gi.require_version('Gtk', '3.0'); gi.require_version('GnomeDesktop', '3.0')" - -# Use multiple processes to speed up Pylint. -jobs=4 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins= - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# 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= - -# 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= - broad-except, - fixme, - global-statement, - invalid-name, - missing-docstring, - too-few-public-methods, - unexpected-keyword-arg, - ungrouped-imports, - useless-object-inheritance, - inconsistent-return-statements, - unsubscriptable-object, - not-an-iterable, - unused-argument, - bare-except, - too-many-statements, - too-many-locals, - too-many-branches, - too-many-public-methods, - arguments-differ, - signature-differs, - unsupported-membership-test, - protected-access, - wrong-import-position, - import-outside-toplevel, - duplicate-code, - consider-using-f-string - -# 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= - - -[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 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[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 - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -notes=FIXME,TODO - - -[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. -min-similarity-lines=4 - - -[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 - -# 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,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=120 - -# 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 - - -[BASIC] - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class names -class-rgx=[A-Z_][a-zA-Z0-9]+$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Good variable names which should always be accepted, separated by a comma -good-names=i,j,k,ex,Run,_ - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# 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 - -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=9 - -# Maximum number of attributes for a class (see R0902). -max-attributes=35 - -# 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=2 - - -[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 - - -[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=regsub,TERMIOS,Bastion,rexec - -# 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= - diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index f30d3fb79..000000000 --- a/.travis.yml +++ /dev/null @@ -1,50 +0,0 @@ -dist: bionic -language: python -python: - - "3.7" - - "3.8" - - "3.9" -env: - - LUTRIS_SKIP_INIT=1 -virtualenv: - system_site_packages: false -services: - - xvfb -addons: - apt: - update: true - packages: - - xvfb - - libdbus-1-dev - - python3-yaml - - python3-gi - - python3-gi-cairo - - python3-pil - - python3-setproctitle - - python3-distro - - python3-magic - - python3-lxml - - gir1.2-gtk-3.0 - - psmisc - - gir1.2-glib-2.0 - - libgirepository1.0-dev - - gir1.2-gnomedesktop-3.0 - - gir1.2-webkit2-4.0 - - gir1.2-notify-0.7 - - at-spi2-core -before_install: - - "export DISPLAY=:99.0" - - Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 & - - "/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -ac -screen 0 1280x1024x16" - - sleep 3 # Give xvfb some time to start -install: - - pip install --upgrade pip pypresence~=3.3.2 poetry - - poetry install --no-root -script: - - make isort-check - - make flake8 - - make pylint - - nosetests - -# Cache the pip dependencies -cache: pip diff --git a/.yapf b/.yapf deleted file mode 100644 index 29809cefa..000000000 --- a/.yapf +++ /dev/null @@ -1,16 +0,0 @@ -[style] -based_on_style = pep8 -column_limit = 120 - -align_closing_bracket_with_visual_indent = true -blank_line_before_class_docstring = true -blank_line_before_module_docstring = true -blank_line_before_nested_class_or_def = true -coalesce_brackets = false -dedent_closing_brackets = true -spaces_around_power_operator = false -spaces_before_comment = 2 -split_before_first_argument = false -split_before_logical_operator = true -split_before_arithmetic_operator = true -split_penalty_after_opening_bracket = 1000 diff --git a/INSTALL.rst b/INSTALL.rst index 9401248d3..39b88c531 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -10,7 +10,7 @@ If you installed Lutris from our PPA or some other repository, it should already come with all of its essential dependencies. However, if you need to install Lutris manually, it requires the following components: - * Python >= 3.7 + * Python >= 3.8 * PyGObject * PyGObject bindings for: Gtk, Gdk, Cairo, GnomeDesktop, Webkit2, Notify * python3-requests diff --git a/Makefile b/Makefile index 6270cbf6e..1503a7290 100644 --- a/Makefile +++ b/Makefile @@ -89,42 +89,28 @@ snap: snapcraft clean lutris -s pull snapcraft +req-python: + pip3 install PyYAML lxml requests Pillow setproctitle python-magic distro dbus-python types-requests \ + types-PyYAML evdev PyGObject pypresence protobuf moddb + dev: - pip3 install isort flake8 pylint autopep8 pytest mypy mypy-baseline nose2 + pip3 install ruff==0.1.13 mypy==1.8.0 mypy-baseline nose2 # ============ # Style checks # ============ -style: isort autopep8 ## Format code - -isort: - isort lutris - -autopep8: - autopep8 --in-place --recursive --ignore E402 setup.py lutris - +style: + ruff format . --check # =============== # Static analysis # =============== -check: isort-check flake8 pylint mypy +check: ruff_lint mypy -isort-check: - isort lutris -c - -flake8: - flake8 . --count --max-complexity=25 --max-line-length=120 --show-source --statistics - -pylint: - pylint lutris --rcfile=.pylintrc --output-format=colorized - -bandit: - bandit . --recursive --skip B101,B105,B107,B108,B303,B310,B311,B314,B320,B404,B405,B410,B602,B603,B607,B608 - -black: - black . --check +ruff_lint: + ruff check . mypy: mypy . --install-types --non-interactive 2>&1 | mypy-baseline filter diff --git a/pyproject.toml b/pyproject.toml index 6055a402b..df293a63a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,5 +1,5 @@ [tool.mypy] -python_version = "3.7" +python_version = "3.8" packages = [ "lutris", "tests", diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 000000000..1d82e25eb --- /dev/null +++ b/ruff.toml @@ -0,0 +1,44 @@ +select = ["A", "ARG", "B", "E", "F", "I", "W", "PERF", "RUF"] +ignore = [ + # Ignores that is not worth/too hard to fix + "RUF001", # String contains ambiguous `！` (FULLWIDTH EXCLAMATION MARK). Did you mean `!` (EXCLAMATION MARK)? - used ,mostly on tests + "B028", # No explicit `stacklevel` keyword argument found - not sure why this is needed + "E402", # Module level import not at top of file - gtk stuff + + # Ignores that should be fixed and removed + "RUF012", # Mutable class attributes should be annotated with `typing.ClassVar` + "PERF401", # Use a list comprehension to create a transformed list + "RUF100", # [*] Unused `noqa` directive (non-enabled: `C901`) - unused pylint/noqa directives that should be removed + "RUF013", # PEP 484 prohibits implicit `Optional` + "PERF203", # `try`-`except` within a loop incurs performance overhead + "RUF015", # Prefer `next(...)` over single element slice - opinionated, but some cases could be changed + "PERF102",# When using only the values of a dict use the `values()` method + "B011", # Do not `assert False` (`python -O` removes these calls), raise `AssertionError()` + "RUF005", # Consider iterable unpacking instead of concatenation + "A003", # Class attribute `id` is shadowing a Python builtin + "B024", # `DiscordRichPresenceBase` is an abstract base class, but it has no abstract methods + "B905", # `zip()` without an explicit `strict=` parameter + "ARG002", # Unused method argument: `mock_path_exists` + "I001", # Import block is un-sorted or un-formatted + "E722", # Do not use bare `except` + "B904", # Within an `except` clause, raise exceptions with `raise ... from err` or `raise ... from None` to distinguish them from errors in exception handling + "B008", # Do not perform function call `_try_import_moddb_library` in argument defaults; instead, perform the call within the function, or read the default from a module-level singleton variable + "ARG005", # Unused lambda argument: `e` + "ARG003", # Unused class method argument: `game_id` + "ARG001", # Unused function argument: `args` + "PERF402", # Use `list` or `list.copy` to create a copy of a list + "B009", # Do not call `getattr` with a constant attribute value. It is not any safer than normal property access. + "A002", # Argument `type` is shadowing a Python builtin + "ARG004", # Unused static method argument: `x` + "B020", # Loop control variable `upstream_runners` overrides iterable it iterates + "B018", # Found useless expression. Either assign it to a variable or remove it +] + + +fixable = ["ALL"] +unfixable = [] + +line-length = 120 + +[format] +quote-style = "single" diff --git a/setup.py b/setup.py index a2553471f..b24c922aa 100644 --- a/setup.py +++ b/setup.py @@ -6,8 +6,8 @@ from setuptools import setup from lutris import __version__ as VERSION -if sys.version_info < (3, 7): - sys.exit('Python >= 3.7 is required to run Lutris') +if sys.version_info < (3, 8): + sys.exit('Python >= 3.8 is required to run Lutris') data_files = []