Merge pull request #966 from jairhenrique/ruff-pth

Enable PTH rule on ruff

ninja/management/commands/export_openapi_schema.py

@@ -1,4 +1,5 @@
 import json
+from pathlib import Path
 from typing import Any, Optional
 
 from django.core.management.base import BaseCommand, CommandError, CommandParser
@@ -83,7 +84,7 @@ def handle(self, *args: Any, **options: Any) -> None:
         )
 
         if options["output"]:
-            with open(options["output"], "wb") as f:
+            with Path(options["output"]).open("wb") as f:
                 f.write(result.encode())
         else:
             self.stdout.write(result)

ninja/openapi/docs.py

@@ -1,5 +1,4 @@
 import json
-import os
 from abc import ABC, abstractmethod
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, Optional
@@ -16,7 +15,7 @@
     # if anyone knows a cleaner way to make mypy happy - welcome
     from ninja import NinjaAPI  # pragma: no cover
 
-ABS_TPL_PATH = os.path.join(os.path.dirname(__file__), "../templates/")
+ABS_TPL_PATH = Path(__file__).parent.parent / "templates/ninja/"
 
 
 class DocsBase(ABC):
@@ -32,7 +31,7 @@ def get_openapi_url(self, api: "NinjaAPI", path_params: DictStrAny) -> str:
 
 class Swagger(DocsBase):
     template = "ninja/swagger.html"
-    template_cdn = os.path.join(ABS_TPL_PATH, "ninja/swagger_cdn.html")
+    template_cdn = str(ABS_TPL_PATH / "swagger_cdn.html")
     default_settings = {
         "layout": "BaseLayout",
         "deepLinking": True,
@@ -58,7 +57,7 @@ def render_page(
 
 class Redoc(DocsBase):
     template = "ninja/redoc.html"
-    template_cdn = os.path.join(ABS_TPL_PATH, "ninja/redoc_cdn.html")
+    template_cdn = str(ABS_TPL_PATH / "redoc_cdn.html")
     default_settings: DictStrAny = {}
 
     def __init__(self, settings: Optional[DictStrAny] = None):

pyproject.toml

@@ -58,7 +58,6 @@ test = [
     "pytest-django",
     "pytest-asyncio",
     "psycopg2-binary",
-    "black",
     "mypy==1.7.1",
     "ruff==0.1.6",
     "django-stubs",
@@ -70,14 +69,15 @@ dev = ["pre-commit"]
 [tool.ruff]
 target-version = "py37"
 select = [
+    "B",    # flake8-bugbear
+    "C",    # flake8-comprehensions
     "E",    # pycodestyle errors
-    "W",    # pycodestyle warnings
     "F",    # pyflakes
+    "FURB", # refurb
     "I",    # isort
-    "C",    # flake8-comprehensions
-    "B",    # flake8-bugbear
+    "PTH",  # flake8-use-pathlib
     "UP",   # pyupgrade
-    "FURB", # refurb
+    "W",    # pycodestyle warnings
 ]
 ignore = [
     "E501", # line too long, handled by black
@@ -86,10 +86,9 @@ ignore = [
 ]
 
 [tool.ruff.per-file-ignores]
-"__init__.py" = ["F401"]
 "ninja/compatibility/datastructures.py" = ["C416"]
 "ninja/utils.py" = ["B004"]
-"tests/*" = ["C408", "F401"]
+"tests/*" = ["C408"]
 
 
 [tool.coverage.run]

tests/conftest.py

@@ -1,13 +1,14 @@
 import os
 import sys
+from pathlib import Path
+
+ROOT = Path(__file__).parent.parent.resolve()
+
+sys.path.insert(0, str(ROOT))
+sys.path.insert(0, str(ROOT / "tests/demo_project"))
 
-ROOT = os.path.abspath(os.path.join(os.path.dirname(os.path.dirname(__file__))))
-sys.path.insert(0, ROOT)
-sys.path.insert(0, os.path.join(ROOT, "tests/demo_project"))
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "demo.settings")
 
-# from django.conf import settings
-# settings.configure()
 import django  # noqa
 
 django.setup()

tests/demo_project/demo/settings.py

@@ -1,6 +1,6 @@
-import os
+from pathlib import Path
 
-BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+BASE_DIR = Path(__file__).parent.parent
 
 
 SECRET_KEY = "NOT-SUPER-SECRET-DO-NOT-USE-ME"
@@ -57,7 +57,7 @@
 DATABASES = {
     "default": {
         "ENGINE": "django.db.backends.sqlite3",
-        "NAME": os.path.join(BASE_DIR, "db.sqlite3"),
+        "NAME": BASE_DIR / "db.sqlite3",
     }
 }
 

tests/demo_project/someapp/admin.py

@@ -1,3 +1 @@
-from django.contrib import admin
-
 # Register your models here.

tests/demo_project/someapp/views.py

@@ -1,3 +1 @@
-from django.shortcuts import render
-
 # Create your views here.

tests/test_app.py

@@ -1,5 +1,6 @@
 import contextlib
 import os
+from pathlib import Path
 from tempfile import NamedTemporaryFile
 
 import pytest
@@ -65,12 +66,12 @@ def html(request):
 def file_response(request):
     tmp = NamedTemporaryFile(delete=False)
     try:
-        with open(tmp.name, "wb") as f:
-            f.write(b"this is a file")
-        return FileResponse(open(tmp.name, "rb"))
+        p = Path(tmp.name)
+        p.write_bytes(b"this is a file")
+        return FileResponse(Path(tmp.name).open("rb"))
     finally:
         with contextlib.suppress(PermissionError):
-            os.remove(tmp.name)
+            Path(tmp.name).unlink()
 
 
 @pytest.mark.parametrize(

tests/test_async.py

@@ -1,6 +1,5 @@
 import asyncio
 
-import django
 import pytest
 
 from ninja import NinjaAPI

tests/test_auth_async.py

@@ -1,6 +1,5 @@
 import asyncio
 
-import django
 import pytest
 
 from ninja import NinjaAPI

tests/test_csrf.py

@@ -1,12 +1,9 @@
 import re
-from unittest import mock
 
-import pytest
 from django.conf import settings
 from django.views.decorators.csrf import csrf_exempt
 
 from ninja import NinjaAPI
-from ninja.errors import ConfigError
 from ninja.security import APIKeyCookie, APIKeyHeader
 from ninja.testing import TestClient as BaseTestClient
 

tests/test_csrf_async.py

@@ -1,12 +1,7 @@
-from unittest import mock
-
-import django
 import pytest
 from django.conf import settings
 
 from ninja import NinjaAPI
-from ninja.errors import ConfigError
-from ninja.security import APIKeyCookie
 from ninja.testing import TestAsyncClient as BaseTestAsyncClient
 
 

tests/test_exceptions.py

@@ -1,4 +1,3 @@
-import django
 import pytest
 from django.http import Http404
 

tests/test_export_openapi_schema.py

@@ -1,5 +1,4 @@
 import json
-import os
 import tempfile
 from io import StringIO
 from pathlib import Path
@@ -27,7 +26,7 @@ def test_export_indent():
 
 def test_export_to_file():
     with tempfile.TemporaryDirectory() as tmp:
-        output_file = os.path.join(tmp, "result.json")
+        output_file = Path(tmp) / "result.json"
         call_command(ExportCmd(), output=output_file)
         json.loads(Path(output_file).read_text())
 

tests/test_misc.py

@@ -2,7 +2,6 @@
 import uuid
 
 import pytest
-from django.http import Http404
 from pydantic import BaseModel
 
 from ninja import NinjaAPI

tests/test_orm_schemas.py

@@ -1,7 +1,6 @@
 from typing import List
 from unittest.mock import Mock
 
-import django
 import pytest
 from django.contrib.postgres import fields as ps_fields
 from django.db import models

tests/test_query_schema.py

@@ -4,7 +4,6 @@
 from pydantic import Field
 
 from ninja import NinjaAPI, Query, Schema
-from ninja.testing import TestClient
 
 
 class Range(IntEnum):

tests/test_with_django/test_multi_param_parsing.py

@@ -101,9 +101,9 @@ def test_validate_test_data():
         if 0:  # pragma: nocover
             # if test cases or schema generation changes,
             #   use this block of code to regenerate the fixtures
-            with open(filename, "w") as f:
+            with Path(filename).open("w") as f:
                 json.dump(schema["paths"][path], f, indent=2)
-        with open(filename) as f:
+        with Path(filename).open() as f:
             data = json.load(f)
             assert json.loads(json.dumps(schema["paths"][path])) == data