chore: migrate to ruff instead of pycodestyle and isort

Author: mariajgrimaldi

Makefile

@@ -58,9 +58,9 @@ upgrade: ## update the requirements/*.txt files with the latest packages satisfy
 quality: ## check coding style with pycodestyle and pylint
 	tox -e quality
 
-format: ## format code with black and isort
+format: ## format code with black and isort. Enable ruff to fix E (pycodestyle) and I (isort) issues
 	ruff format openedx_authz tests --line-length 120
-	ruff check --select I --fix --line-length 120
+	ruff check --select E,I --fix --line-length 120
 
 pii_check: ## check for PII annotations on all Django models
 	tox -e pii_check

openedx_authz/api/roles.py

@@ -114,9 +114,7 @@ def get_permissions_for_active_roles_in_scope(
         permissions and scopes.
     """
     enforcer = AuthzEnforcer.get_enforcer()
-    filtered_policy = enforcer.get_filtered_grouping_policy(
-        GroupingPolicyIndex.SCOPE.value, scope.namespaced_key
-    )
+    filtered_policy = enforcer.get_filtered_grouping_policy(GroupingPolicyIndex.SCOPE.value, scope.namespaced_key)
 
     if role:
         filtered_policy = [
@@ -141,9 +139,7 @@ def get_role_definitions_in_scope(scope: ScopeData) -> list[RoleData]:
         list[Role]: A list of roles.
     """
     enforcer = AuthzEnforcer.get_enforcer()
-    policy_filtered = enforcer.get_filtered_policy(
-        PolicyIndex.SCOPE.value, scope.namespaced_key
-    )
+    policy_filtered = enforcer.get_filtered_policy(PolicyIndex.SCOPE.value, scope.namespaced_key)
 
     permissions_per_role = defaultdict(
         lambda: {
@@ -185,9 +181,7 @@ def get_all_roles_in_scope(scope: ScopeData) -> list[list[str]]:
         list[list[str]]: A list of policies in the specified scope.
     """
     enforcer = AuthzEnforcer.get_enforcer()
-    return enforcer.get_filtered_grouping_policy(
-        GroupingPolicyIndex.SCOPE.value, scope.namespaced_key
-    )
+    return enforcer.get_filtered_grouping_policy(GroupingPolicyIndex.SCOPE.value, scope.namespaced_key)
 
 
 def assign_role_to_subject_in_scope(subject: SubjectData, role: RoleData, scope: ScopeData) -> bool:
@@ -232,9 +226,7 @@ def unassign_role_from_subject_in_scope(subject: SubjectData, role: RoleData, sc
         bool: True if the role was unassigned successfully, False otherwise.
     """
     enforcer = AuthzEnforcer.get_enforcer()
-    return enforcer.delete_roles_for_user_in_domain(
-        subject.namespaced_key, role.namespaced_key, scope.namespaced_key
-    )
+    return enforcer.delete_roles_for_user_in_domain(subject.namespaced_key, role.namespaced_key, scope.namespaced_key)
 
 
 def batch_unassign_role_from_subjects_in_scope(subjects: list[SubjectData], role: RoleData, scope: ScopeData) -> None:

openedx_authz/settings/common.py

@@ -21,8 +21,6 @@ def plugin_settings(settings):
     if casbin_adapter_app not in settings.INSTALLED_APPS:
         settings.INSTALLED_APPS.append(casbin_adapter_app)
     # Add Casbin configuration
-    settings.CASBIN_MODEL = os.path.join(
-        ROOT_DIRECTORY, "engine", "config", "model.conf"
-    )
+    settings.CASBIN_MODEL = os.path.join(ROOT_DIRECTORY, "engine", "config", "model.conf")
     if not hasattr(settings, "CASBIN_AUTO_LOAD_POLICY_INTERVAL"):
         settings.CASBIN_AUTO_LOAD_POLICY_INTERVAL = 5

requirements/dev.txt

@@ -223,8 +223,6 @@ pycasbin==2.2.0
     # via
     #   -r requirements/quality.txt
     #   casbin-django-orm-adapter
-pycodestyle==2.14.0
-    # via -r requirements/quality.txt
 pycparser==2.23
     # via
     #   -r requirements/quality.txt

requirements/quality.in

@@ -5,7 +5,5 @@
 -r test.txt               # Core and testing dependencies for this package
 
 edx-lint                  # edX pylint rules and plugins
-isort                     # to standardize order of imports
-pycodestyle               # PEP 8 compliance validation
 pydocstyle                # PEP 257 compliance validation
 ruff                      # Fast Python linter and formatter

requirements/quality.txt

@@ -122,9 +122,7 @@ iniconfig==2.1.0
     #   -r requirements/test.txt
     #   pytest
 isort==6.0.1
-    # via
-    #   -r requirements/quality.in
-    #   pylint
+    # via pylint
 jinja2==3.1.6
     # via
     #   -r requirements/test.txt
@@ -157,8 +155,6 @@ pycasbin==2.2.0
     # via
     #   -r requirements/test.txt
     #   casbin-django-orm-adapter
-pycodestyle==2.14.0
-    # via -r requirements/quality.in
 pycparser==2.23
     # via
     #   -r requirements/test.txt

ruff.toml

@@ -0,0 +1,17 @@
+# Ruff configuration for openedx-authz
+# See https://docs.astral.sh/ruff/configuration/
+
+line-length = 120
+
+[lint]
+# E: pycodestyle errors
+# I: isort import sorting
+select = ["E", "I"]
+
+exclude = [
+    ".git",
+    ".tox",
+    "migrations",
+    "__pycache__",
+    "*.pyc",
+]

tox.ini

@@ -5,9 +5,10 @@ envlist = py{311,312}-django{42,52}
 ; D001 = Line too long
 ignore = D001
 
-[pycodestyle]
-exclude = .git,.tox,migrations
-max-line-length = 120
+[ruff]
+# Configuration moved to ruff.toml
+# select = E (pycodestyle errors), I (isort)
+# max-line-length = 120
 
 [pydocstyle]
 ; D101 = Missing docstring in public class
@@ -75,9 +76,8 @@ commands =
     touch tests/__init__.py
     pylint openedx_authz tests test_utils manage.py setup.py
     rm tests/__init__.py
-    pycodestyle openedx_authz tests manage.py setup.py
+    ruff check openedx_authz tests test_utils manage.py setup.py
     pydocstyle openedx_authz tests manage.py setup.py
-    isort --check-only --diff tests test_utils openedx_authz manage.py setup.py
     make selfcheck
 
 [testenv:pii_check]