Remove unnecessary UTF-8 encoding declarations and update string formatting to f-strings (#595)

Author: eduzen

.github/workflows/test.yaml

@@ -28,33 +28,37 @@ jobs:
       matrix:
         python-version: [3.9]
     env:
-      DJANGO: 3.0 
+      DJANGO: 3.0
       SECRET_KEY: supersecret
-      DB_PORT: 5432 
+      DB_PORT: 5432
       POSTGRES_HOST: localhost
       POSTGRES_PASSWORD: somepassword
       POSTGRES_USER: postgres
       POSTGRES_DB: testing_db
       DJANGO_SETTINGS_MODULE: pyarweb.settings.development
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
+
       - name: Install system libraries
         run: |
           sudo apt-get install -y libpq-dev libxml2-dev libxslt1-dev
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install -r dev_requirements.txt
-      - name: Lint with flake8
-        run: |
-          flake8
+
+      - name: Check Code Style
+        uses: pre-commit/[email protected]
+
       - name: Run migrations
         run: |
-          python manage.py migrate          
+          python manage.py migrate
       - name: Run tests
         run: |
           pytest -v

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.1.1
+    hooks:
+      - id: flake8
+        args:
+          - '--config=.flake8'
+          - '--exclude=.venv,**/migrations/*.py'
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.19.1
+    hooks:
+      - id: pyupgrade
+        args: [--py39-plus]
+

Makefile

@@ -28,6 +28,9 @@ only_test:
 pep8:
 	docker-compose run --rm web flake8
 
+format:
+	pre-commit run -a
+
 test: pep8 only_test
 
 dockershell:

README.md

@@ -20,6 +20,13 @@ instrucciones generales en [esta página de la wiki](https://github.com/PyAr/pya
 
 podés ver las instrucciones en [esta página de la wiki](https://github.com/PyAr/pyarweb/wiki/Instalacion-con-Docker)
 
+## Lint & Format
+
+Para correr el linter y el formateador de código, podés correr:
+
+```bash
+make format
+```
 
 ## Más info
 

community/urls.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 from django.conf.urls import patterns, url
 
 

community/views.py

@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-
-
 """Handle the Views of the Homepage and others."""
 
 from django.db.models import F, Value, CharField
@@ -59,7 +56,7 @@ def get_context_data(self, **kwargs):
         # Sort the last news, jobs and events to define the definitive 'recent' list
         recent = sorted(news + jobs + events, key=lambda r: r.created, reverse=True)
 
-        context = super(HomePageView, self).get_context_data(**kwargs)
+        context = super().get_context_data(**kwargs)
         context['recent'] = recent[:RECENT_ITEMS_LEN]
         return context
 
@@ -84,7 +81,7 @@ class OwnedObject(SingleObjectMixin):
         before allowing manipulation. """
 
     def get_object(self, *args, **kwargs):
-        obj = super(OwnedObject, self).get_object(*args, **kwargs)
+        obj = super().get_object(*args, **kwargs)
         return validate_obj_owner(obj, self.request.user)
 
 
@@ -102,7 +99,7 @@ def dispatch(self, request, *args, **kwargs):
                     self.included_tags.append(k[4:])
                 elif v == '2':
                     self.excluded_tags.append(k[4:])
-        return super(FilterableList, self).dispatch(request, *args, **kwargs)
+        return super().dispatch(request, *args, **kwargs)
 
     def filter_queryset_tags(self, obj_list):
         included = self.included_tags
@@ -114,10 +111,10 @@ def filter_queryset_tags(self, obj_list):
         return obj_list
 
     def get_queryset(self):
-        return self.filter_queryset_tags(super(FilterableList, self).get_queryset())
+        return self.filter_queryset_tags(super().get_queryset())
 
     def get_context_data(self, **kwargs):
-        context = super(FilterableList, self).get_context_data(**kwargs)
+        context = super().get_context_data(**kwargs)
         context['tags'] = self.model.tags.all()
         context['included'] = self.included_tags
         context['excluded'] = self.excluded_tags

events/forms.py

@@ -73,7 +73,7 @@ class Meta:
         }
 
     def clean(self):
-        cleaned_data = super(EventForm, self).clean()
+        cleaned_data = super().clean()
         start_at = cleaned_data.get('start_at')
         end_at = cleaned_data.get('end_at')
         if start_at is not None and end_at is not None:
@@ -84,7 +84,7 @@ def clean(self):
         return cleaned_data
 
     def save(self, *args, **kwargs):
-        super(EventForm, self).save(*args, **kwargs)
+        super().save(*args, **kwargs)
         self.instance.save()
 
 

events/migrations/0001_initial.py

@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
 from django.db import migrations, models
 from django.conf import settings
 

events/migrations/0002_auto_20170325_2011.py

@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
 from django.db import migrations, models
 from django.conf import settings
 
@@ -50,6 +47,6 @@ class Migration(migrations.Migration):
         ),
         migrations.AlterUniqueTogether(
             name='eventparticipation',
-            unique_together=set([('event', 'email')]),
+            unique_together={('event', 'email')},
         ),
     ]

events/migrations/0003_eventparticipation_gender.py

@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
 from django.db import migrations, models
 
 

events/migrations/0004_auto_20180428_1949.py

@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
 from django.db import migrations, models
 
 

events/migrations/0005_auto_20180429_1546.py

@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
 from django.db import migrations, models
 import autoslug.fields
 

events/mixins.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 import csv
 
 from crispy_forms.helper import FormHelper
@@ -29,7 +28,7 @@ def get_crispy_fields(self):
         return self.Meta.fields
 
 
-class EventMixin(object):
+class EventMixin:
     """Mixin for common attrs."""
 
     model = Event
@@ -38,7 +37,7 @@ def get_success_url(self):
         return reverse_lazy('events:events_list_all')
 
 
-class EventParticipationMixin(object):
+class EventParticipationMixin:
     """Mixin for common attrs."""
 
     model = EventParticipation
@@ -51,13 +50,13 @@ def get_success_url(self):
         return reverse_lazy('events:detail', kwargs={'pk': self.kwargs['pk']})
 
 
-class ReadOnlyFieldsMixin(object):
+class ReadOnlyFieldsMixin:
     """Adds the posibility to declare fields as read-only (until we update to Django 1.9 or so"""
 
     readonly_fields = ()
 
     def __init__(self, *args, **kwargs):
-        super(ReadOnlyFieldsMixin, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
         for field in (field for name, field in self.fields.items() if
                       name in self.readonly_fields):
             field.widget.attrs['disabled'] = 'true'
@@ -66,10 +65,10 @@ def __init__(self, *args, **kwargs):
     def clean(self):
         for f in self.readonly_fields:
             self.cleaned_data.pop(f, None)
-        return super(ReadOnlyFieldsMixin, self).clean()
+        return super().clean()
 
 
-class CSVResponseMixin(object):
+class CSVResponseMixin:
     """Return a csv file based on a list of lists."""
     csv_filename = 'csvfile.csv'
 
@@ -84,7 +83,7 @@ def get_csv_filename(self):
 
     def render_to_csv(self):
         response = HttpResponse(content_type='text/csv')
-        cd = 'attachment; filename="{0}"'.format(self.get_csv_filename())
+        cd = f'attachment; filename="{self.get_csv_filename()}"'
         response['Content-Disposition'] = cd
 
         writer = csv.writer(response)

events/tests/test_views.py

@@ -103,5 +103,5 @@ def test_events_view_delete(self):
 
     def test_events_view_slug(self):
         event = EventFactory()
-        response_por_slug = self.client.get('/eventos/{}/'.format(event.slug))
+        response_por_slug = self.client.get(f'/eventos/{event.slug}/')
         self.assertEqual(response_por_slug.context['event'].id, event.id)

events/urls.py

@@ -1,4 +1,3 @@
-
 from django.urls import re_path, path
 from django.views.generic.detail import DetailView
 

events/views.py

@@ -54,7 +54,7 @@ class EventList(ListView):
     context_object_name = "eventos_pasados"
 
     def get_context_data(self, **kwargs):
-        context = super(EventList, self).get_context_data(**kwargs)
+        context = super().get_context_data(**kwargs)
         context['eventos_proximos'] = Event.objects.filter(
             end_at__gte=timezone.now()).order_by('start_at')
 
@@ -86,7 +86,7 @@ def user_participation_details(self):
         return details
 
     def get_context_data(self, **kwargs):
-        context = super(EventDetail, self).get_context_data(**kwargs)
+        context = super().get_context_data(**kwargs)
         context.update(self.user_participation_details())
         return context
 
@@ -96,7 +96,7 @@ class EventCreate(LoginRequiredMixin, EventMixin, CreateView):
 
     def form_valid(self, form):
         form.instance.owner = self.request.user
-        return super(EventCreate, self).form_valid(form)
+        return super().form_valid(form)
 
 
 class EventUpdate(LoginRequiredMixin, EventMixin, OwnedObject, UpdateView):
@@ -215,7 +215,7 @@ def get_success_url(self):
 
 
 class EventParticipationList(LoginRequiredMixin, ListView):
-    http_method_names = [u'get']
+    http_method_names = ['get']
     context_object_name = 'participants'
 
     def __init__(self, *args, **kwargs):
@@ -224,7 +224,7 @@ def __init__(self, *args, **kwargs):
 
     def get_context_data(self, **kwargs):
         """Overwrite get_context_data to add the related Event's ID to the template context."""
-        context = super(EventParticipationList, self).get_context_data(**kwargs)
+        context = super().get_context_data(**kwargs)
         context['event'] = self.event
         return context
 
@@ -246,7 +246,7 @@ class EventParticipationDelete(LoginRequiredMixin, EventParticipationMixin, Dele
     def get_object(self, *args, **kwargs):
         """A User can delete its participation to an Event. The Event owner can also do that."""
 
-        inscription = super(EventParticipationDelete, self).get_object(*args, **kwargs)
+        inscription = super().get_object(*args, **kwargs)
         if self.request.user not in [inscription.user, inscription.event.owner]:
             raise Http404()
         return inscription
@@ -256,7 +256,7 @@ class EventParticipationDownload(CSVResponseMixin, EventParticipationList):
     def get_csv_filename(self):
         event = self.event.name.lower().replace(' ', '_')
         timestamp = timezone.now().isoformat().replace(':', '').replace('-', '').split('.')[0]
-        return '{0}-{1}.csv'.format(event, timestamp)
+        return f'{event}-{timestamp}.csv'
 
     def get_rows(self):
         columns = ('Nombre', 'Correo electrónico', 'Género', 'Nivel', 'Usuario PyAr',

joboffers/joboffer_actions.py

@@ -1,6 +1,4 @@
-
 from dataclasses import dataclass
-from typing import Set
 
 from django.db.models import Q
 
@@ -187,7 +185,7 @@ def get_valid_actions(user, joboffer=None, roles=None):
     else:
         roles_ = roles
 
-    actions: Set[str] = set()
+    actions: set[str] = set()
 
     for role in roles_:
         # Appends the actions for every role

joboffers/management/commands/create_facebook_page_token.py

@@ -84,8 +84,8 @@ def handle(self, *args, **options):
         data = json.loads(result.text)
 
         long_lived_page_access_token = data.get('access_token')
-        self.stdout.write(('\nPor favor, copiá el token y pegalo en el archivo .env o su '
-                          'equivalente para el entorno de producción:'))
+        self.stdout.write('\nPor favor, copiá el token y pegalo en el archivo .env o su '
+                          'equivalente para el entorno de producción:')
 
         self.stdout.write(
             self.style.SUCCESS(

joboffers/tests/fixtures.py

@@ -35,7 +35,7 @@ def create_admin_client(client, admin_user):
     return client
 
 
-class DummyTelegram(object):
+class DummyTelegram:
     """
     Convenience wrapper of requests mock to simulate telegram responses and tests messages sent
     """

joboffers/tests/test_joboffer_actions.py

@@ -1,4 +1,3 @@
-
 import pytest
 from django.contrib.auth.models import AnonymousUser
 

news/forms.py

@@ -12,7 +12,7 @@ class NewsArticleForm(forms.ModelForm):
     body = forms.CharField(widget=SummernoteInplaceWidget())
 
     def __init__(self, *args, **kwargs):
-        super(NewsArticleForm, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
         self.helper = FormHelper()
         self.helper.add_input(Submit('news_submit', _('Guardar')))
         self.helper.add_input(Reset('news_reset', _('Limpiar'),

news/migrations/0001_initial.py

@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
 from django.db import migrations, models
 import taggit_autosuggest.managers
 import django.utils.timezone