From 9b3d03a3d257bca3eb99ca82770908adc7486a37 Mon Sep 17 00:00:00 2001 From: Bruno Alla Date: Tue, 21 Oct 2025 15:19:47 +0200 Subject: [PATCH] Update blacken-docs and black to latest versions (#9802) * Update blacken-docs and black to latest versions * Include docs folder for blackend-docs * Run blacken docs on docs folder * Fix broken link on authentication page --- .pre-commit-config.yaml | 5 ++--- README.md | 21 +++++++++++---------- docs/api-guide/authentication.md | 4 ++-- docs/api-guide/viewsets.md | 2 +- docs/community/3.11-announcement.md | 12 ++++-------- 5 files changed, 20 insertions(+), 24 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index cfea408e0..130793f80 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -19,12 +19,11 @@ repos: additional_dependencies: - flake8-tidy-imports - repo: https://github.com/adamchainz/blacken-docs - rev: 1.16.0 + rev: 1.20.0 hooks: - id: blacken-docs - exclude: ^(?!docs).*$ additional_dependencies: - - black==23.1.0 + - black==25.9.0 - repo: https://github.com/codespell-project/codespell # Configuration for codespell is in .codespellrc rev: v2.2.6 diff --git a/README.md b/README.md index b2bada7b4..1594ab0ad 100644 --- a/README.md +++ b/README.md @@ -67,10 +67,11 @@ Install using `pip`... pip install djangorestframework Add `'rest_framework'` to your `INSTALLED_APPS` setting. + ```python INSTALLED_APPS = [ - ... - 'rest_framework', + # ... + "rest_framework", ] ``` @@ -99,7 +100,7 @@ from rest_framework import routers, serializers, viewsets class UserSerializer(serializers.HyperlinkedModelSerializer): class Meta: model = User - fields = ['url', 'username', 'email', 'is_staff'] + fields = ["url", "username", "email", "is_staff"] # ViewSets define the view behavior. @@ -110,13 +111,13 @@ class UserViewSet(viewsets.ModelViewSet): # Routers provide a way of automatically determining the URL conf. router = routers.DefaultRouter() -router.register(r'users', UserViewSet) +router.register(r"users", UserViewSet) # Wire up our API using automatic URL routing. # Additionally, we include login URLs for the browsable API. urlpatterns = [ - path('', include(router.urls)), - path('api-auth/', include('rest_framework.urls', namespace='rest_framework')), + path("", include(router.urls)), + path("api-auth/", include("rest_framework.urls", namespace="rest_framework")), ] ``` @@ -126,15 +127,15 @@ Add the following to your `settings.py` module: ```python INSTALLED_APPS = [ - ... # Make sure to include the default installed apps here. - 'rest_framework', + # ... make sure to include the default installed apps here. + "rest_framework", ] REST_FRAMEWORK = { # Use Django's standard `django.contrib.auth` permissions, # or allow read-only access for unauthenticated users. - 'DEFAULT_PERMISSION_CLASSES': [ - 'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly', + "DEFAULT_PERMISSION_CLASSES": [ + "rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly", ] } ``` diff --git a/docs/api-guide/authentication.md b/docs/api-guide/authentication.md index 84e58bf4b..073ddc8f0 100644 --- a/docs/api-guide/authentication.md +++ b/docs/api-guide/authentication.md @@ -454,7 +454,7 @@ There are currently two forks of this project. More information can be found in the [Documentation](https://django-rest-durin.readthedocs.io/en/latest/index.html). -## django-pyoidc +## django-pyoidc [dango-pyoidc][django_pyoidc] adds support for OpenID Connect (OIDC) authentication. This allows you to delegate user management to an Identity Provider, which can be used to implement Single-Sign-On (SSO). It provides support for most uses-cases, such as customizing how token info are mapped to user models, using OIDC audiences for access control, etc. @@ -497,4 +497,4 @@ More information can be found in the [Documentation](https://django-pyoidc.readt [django-rest-authemail]: https://github.com/celiao/django-rest-authemail [django-rest-durin]: https://github.com/eshaan7/django-rest-durin [login-required-middleware]: https://docs.djangoproject.com/en/stable/ref/middleware/#django.contrib.auth.middleware.LoginRequiredMiddleware -[django-pyoidc] : https://github.com/makinacorpus/django_pyoidc +[django-pyoidc]: https://github.com/makinacorpus/django_pyoidc diff --git a/docs/api-guide/viewsets.md b/docs/api-guide/viewsets.md index 22acfe327..102bac40e 100644 --- a/docs/api-guide/viewsets.md +++ b/docs/api-guide/viewsets.md @@ -231,7 +231,7 @@ Using the example from the previous section: Alternatively, you can use the `url_name` attribute set by the `@action` decorator. ```pycon ->>> view.reverse_action(view.set_password.url_name, args=['1']) +>>> view.reverse_action(view.set_password.url_name, args=["1"]) 'http://localhost:8000/api/users/1/set_password' ``` diff --git a/docs/community/3.11-announcement.md b/docs/community/3.11-announcement.md index 2fc37a764..e913d5e0a 100644 --- a/docs/community/3.11-announcement.md +++ b/docs/community/3.11-announcement.md @@ -50,11 +50,9 @@ class DocStringExampleListView(APIView): permission_classes = [permissions.IsAuthenticatedOrReadOnly] - def get(self, request, *args, **kwargs): - ... + def get(self, request, *args, **kwargs): ... - def post(self, request, *args, **kwargs): - ... + def post(self, request, *args, **kwargs): ... ``` ## Validator / Default Context @@ -76,8 +74,7 @@ Validator implementations will look like this: class CustomValidator: requires_context = True - def __call__(self, value, serializer_field): - ... + def __call__(self, value, serializer_field): ... ``` Default implementations will look like this: @@ -86,8 +83,7 @@ Default implementations will look like this: class CustomDefault: requires_context = True - def __call__(self, serializer_field): - ... + def __call__(self, serializer_field): ... ``` ---