Migrate from Flake8 & Autopep8 to Ruff (#14)

Author: vdusek

.flake8

@@ -1,6 +1,7 @@
 __pycache__
 .mypy_cache
 .pytest_cache
+.ruff_cache
 
 .venv
 .direnv

.gitignore

@@ -1,8 +1,10 @@
 # Changelog
 
-## [1.0.5](../../releases/tag/v1.0.5) - Unreleased
+## [1.1.0](../../releases/tag/v1.1.0) - Unreleased
 
-...
+### Internal changes
+
+- Migrate from Autopep8 and Flake8 to Ruff
 
 ## [1.0.4](../../releases/tag/v1.0.4) - 2023-10-18
 

.isort.cfg

@@ -2,7 +2,7 @@
 
 ## Environment
 
-For local development, it is required to have Python 3.8 installed.
+For local development, it is required to have Python 3.8 (or a later version) installed.
 
 It is recommended to set up a virtual environment while developing this package to isolate your development environment,
 however, due to the many varied ways Python can be installed and virtual environments can be set up,
@@ -24,11 +24,11 @@ To install this package and its development dependencies, run `make install-dev`
 
 ## Formatting
 
-We use `autopep8` and `isort` to automatically format the code to a common format. To run the formatting, just run `make format`.
+We use `ruff` to automatically format the code to a common format. To run the formatting, just run `make format`.
 
 ## Linting, type-checking and unit testing
 
-We use `flake8` for linting, `mypy` for type checking and `pytest` for unit testing. To run these tools, just run `make check-code`.
+We use `ruff` for linting, `mypy` for type checking and `pytest` for unit testing. To run these tools, just run `make check-code`.
 
 ## Release process
 

CHANGELOG.md

@@ -1,39 +1,41 @@
 .PHONY: clean install-dev build publish twine-check lint unit-tests type-check check-code format check-version-availability check-changelog-entry
 
+DIRS_WITH_CODE = src tests scripts
+
 clean:
-	rm -rf build dist .mypy_cache .pytest_cache src/*.egg-info __pycache__
+	rm -rf build dist .mypy_cache .pytest_cache .ruff_cache src/*.egg-info __pycache__
 
 install-dev:
-	python -m pip install --upgrade pip
+	python3 -m pip install --upgrade pip
 	pip install --no-cache-dir -e ".[dev]"
 	pre-commit install
 
 build:
-	python -m build
+	python3 -m build
 
 publish:
-	python -m twine upload dist/*
+	python3 -m twine upload dist/*
 
 twine-check:
-	python -m twine check dist/*
+	python3 -m twine check dist/*
 
 lint:
-	python3 -m flake8
+	python3 -m ruff check $(DIRS_WITH_CODE)
 
 unit-tests:
 	python3 -m pytest -n auto -ra tests/unit
 
 type-check:
-	python3 -m mypy
+	python3 -m mypy $(DIRS_WITH_CODE)
 
 check-code: lint type-check unit-tests
 
 format:
-	python3 -m isort src tests
-	python3 -m autopep8 --in-place --recursive src tests
+	python3 -m ruff check --fix $(DIRS_WITH_CODE)
+	python3 -m ruff format $(DIRS_WITH_CODE)
 
 check-version-availability:
-	python3 scripts/check_version_availability.py
+	python scripts/check_version_availability.py
 
 check-changelog-entry:
-	python3 scripts/check_version_in_changelog.py
+	python scripts/check_version_in_changelog.py

CONTRIBUTING.md

@@ -19,29 +19,13 @@ license = { text = "Apache Software License" }
 name = "apify_shared"
 readme = "README.md"
 requires-python = ">=3.8"
-version = "1.0.5"
+version = "1.1.0"
 
 [project.optional-dependencies]
 dev = [
-    "autopep8 ~= 2.0.4",
     "build ~= 1.0.3",
     "filelock ~= 3.12.4",
-    "flake8 ~= 6.1.0",
-    "flake8-bugbear ~= 23.9.16",
-    "flake8-commas ~= 2.1.0; python_version < '3.12'",
-    "flake8-comprehensions ~= 3.14.0",
-    "flake8-datetimez ~= 20.10.0",
-    "flake8-docstrings ~= 1.7.0",
-    "flake8-encodings ~= 0.5.0",
-    "flake8-isort ~= 6.1.0",
-    "flake8-noqa ~= 1.3.1; python_version < '3.12'",
-    "flake8-pytest-style ~= 1.7.2",
-    "flake8-quotes ~= 3.3.2; python_version < '3.12'",
-    "flake8-simplify ~= 0.21.0",
-    "flake8-unused-arguments ~= 0.0.13",
-    "isort ~= 5.12.0",
     "mypy ~= 1.5.1",
-    "pep8-naming ~= 0.13.3",
     "pre-commit ~= 3.4.0",
     "pydoc-markdown ~= 4.8.2",
     "pytest ~= 7.4.2",
@@ -50,6 +34,7 @@ dev = [
     "pytest-timeout ~= 2.2.0",
     "pytest-xdist ~= 3.3.1",
     "respx ~= 0.20.1",
+    "ruff ~= 0.1.5",
     "twine ~= 4.0.2",
 ]
 
@@ -69,3 +54,57 @@ where = ["src"]
 
 [tool.setuptools.package-data]
 apify_shared = ["py.typed"]
+
+[tool.ruff]
+line-length = 120
+select = ["ALL"]
+ignore = [
+    "ANN401",  # Dynamically typed expressions (typing.Any) are disallowed in {filename}
+    "BLE001",  # Do not catch blind exception
+    "COM812",  # This rule may cause conflicts when used with the formatter
+    "D100",    # Missing docstring in public module
+    "D104",    # Missing docstring in public package
+    "EM",      # flake8-errmsg
+    "ISC001",  # This rule may cause conflicts when used with the formatter
+    "FIX",     # flake8-fixme
+    "PGH003",  # Use specific rule codes when ignoring type issues
+    "PLR0913", # Too many arguments in function definition
+    "PTH",     # flake8-use-pathlib
+    "S102",    # Use of `exec` detected
+    "S105",    # Possible hardcoded password assigned to
+    "TD002",   # Missing author in TODO; try: `# TODO(<author_name>): ...` or `# TODO @<author_name>: ...
+    "TID252",  # Relative imports from parent modules are bannedRuff
+    "TRY003",  # Avoid specifying long messages outside the exception class
+]
+
+[tool.ruff.format]
+quote-style = "single"
+indent-style = "space"
+
+[tool.ruff.lint.per-file-ignores]
+"**/__init__.py" = [
+    "F401", # Unused imports
+]
+"**/{scripts}/*" = [
+    "D",       # Everything from the pydocstyle
+    "INP001",  # File {filename} is part of an implicit namespace package, add an __init__.py
+    "PLR2004", # Magic value used in comparison, consider replacing {value} with a constant variable
+    "T20",     # flake8-print
+]
+"**/{tests}/*" = [
+    "D",       # Everything from the pydocstyle
+    "INP001",  # File {filename} is part of an implicit namespace package, add an __init__.py
+    "PLR2004", # Magic value used in comparison, consider replacing {value} with a constant variable
+    "T20",     # flake8-print
+    "S101",    # Use of assert detected
+]
+
+[tool.ruff.lint.flake8-quotes]
+docstring-quotes = "double"
+inline-quotes = "single"
+
+[tool.ruff.lint.isort]
+known-first-party = ["apify", "apify_client", "apify_shared"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"

Makefile

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+
 from utils import get_current_package_version, get_published_package_versions
 
 # Checks whether the current package version number was not already used in a published release.

pyproject.toml

@@ -15,8 +15,11 @@
 
     with open(CHANGELOG_PATH, encoding='utf-8') as changelog_file:
         for line in changelog_file:
-            # The heading for the changelog entry for the given version can start with either the version number, or the version number in a link
-            if re.match(fr'(## )\[?{current_package_version}([\] ]|$)', line):
+            # The heading for the changelog entry for the given version can start with either the version number,
+            # or the version number in a link
+            if re.match(rf'(## )\[?{current_package_version}([\] ]|$)', line):
                 break
         else:
-            raise RuntimeError(f'There is no entry in the changelog for the current package version ({current_package_version})')
+            raise RuntimeError(
+                f'There is no entry in the changelog for the current package version ({current_package_version})'
+            )