chore(post_gen_project.py): fix formatting and add missing newline at end of file (#635)

mabdullahabid · web-flow · commit 8e37f4f2a569 · 2023-09-19T10:44:06.000-04:00
chore(server.ts): change port variable case from lowercase port to uppercase PORT to improve semantics
feat(server.ts): add support for process.env.PORT environment variable to be able to run app on a configurable port
chore(serializers.py): fix formatting of field names in SignupSerializer and UserSerializer
feat(serializers.py): add required and allow_blank options to email field in SignupSerializer
chore(apps.py): fix formatting of name field in HomeConfig
chore(createsuperuserauto.py): fix formatting and typo in help message
chore(customchangepassword.py): fix formatting and typo in help message
chore(upgradetosuperuser.py): fix formatting and add missing newline at end of file
chore(0001_load_initial_data.py): remove unnecessary newline at end of file

chore(views.py): reformat code for better readability and maintainability
chore(manage.py): reformat code for better readability and maintainability
chore(admin.py): reformat code for better readability and maintainability
chore(apps.py): reformat code for better readability and maintainability
chore(urls.py): reformat code for better readability and maintainability
chore(utils.py): reformat code for better readability and maintainability
chore(admin.py): reformat code for better readability and maintainability
chore(forms.py): reformat code for better readability and maintainability
chore(0001_initial.py): reformat code for better readability and maintainability
chore(factories.py): reformat code for better readability and maintainability
chore(views.py): reformat code for better readability and maintainability
chore(wsgi.py): reformat code for better readability and maintainability
diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py
@@ -4,7 +4,7 @@
 
 REMOVE_PATHS = [
     '{% if cookiecutter.is_mobile != "y" %} web_build {% endif %}',
-    '{% if cookiecutter.is_mobile == "y" %} .github {% endif %}'
+    '{% if cookiecutter.is_mobile == "y" %} .github {% endif %}',
 ]
 
 for path in REMOVE_PATHS:
@@ -14,4 +14,4 @@
     if os.path.isdir(path):
         shutil.rmtree(path)
     else:
-        os.unlink(path)
+        os.unlink(path)
diff --git a/{{cookiecutter.project_slug}}/home/api/v1/serializers.py b/{{cookiecutter.project_slug}}/home/api/v1/serializers.py
@@ -16,23 +16,22 @@
 class SignupSerializer(serializers.ModelSerializer):
     class Meta:
         model = User
-        fields = ('id', 'name', 'email', 'password')
+        fields = ("id", "name", "email", "password")
         extra_kwargs = {
-            'password': {
-                'write_only': True,
-                'style': {
-                    'input_type': 'password'
-                }
+            "password": {"write_only": True, "style": {"input_type": "password"}},
+            "email": {
+                "required": True,
+                "allow_blank": False,
             },
-            'email': {
-                'required': True,
-                'allow_blank': False,
-            }
         }
 
     def _get_request(self):
-        request = self.context.get('request')
-        if request and not isinstance(request, HttpRequest) and hasattr(request, '_request'):
+        request = self.context.get("request")
+        if (
+            request
+            and not isinstance(request, HttpRequest)
+            and hasattr(request, "_request")
+        ):
             request = request._request
         return request
 
@@ -41,20 +40,19 @@ def validate_email(self, email):
         if allauth_settings.UNIQUE_EMAIL:
             if email and email_address_exists(email):
                 raise serializers.ValidationError(
-                    _("A user is already registered with this e-mail address."))
+                    _("A user is already registered with this e-mail address.")
+                )
         return email
 
     def create(self, validated_data):
         user = User(
-            email=validated_data.get('email'),
-            name=validated_data.get('name'),
-            username=generate_unique_username([
-                validated_data.get('name'),
-                validated_data.get('email'),
-                'user'
-            ])
+            email=validated_data.get("email"),
+            name=validated_data.get("name"),
+            username=generate_unique_username(
+                [validated_data.get("name"), validated_data.get("email"), "user"]
+            ),
         )
-        user.set_password(validated_data.get('password'))
+        user.set_password(validated_data.get("password"))
         user.save()
         request = self._get_request()
         setup_user_email(request, user, [])
@@ -68,9 +66,10 @@ def save(self, request=None):
 class UserSerializer(serializers.ModelSerializer):
     class Meta:
         model = User
-        fields = ['id', 'email', 'name']
+        fields = ["id", "email", "name"]
 
 
 class PasswordSerializer(PasswordResetSerializer):
     """Custom serializer for rest_auth to solve reset password error"""
+
     password_reset_form_class = ResetPasswordForm
diff --git a/{{cookiecutter.project_slug}}/home/apps.py b/{{cookiecutter.project_slug}}/home/apps.py
@@ -2,4 +2,4 @@
 
 
 class HomeConfig(AppConfig):
-    name = 'home'
+    name = "home"
diff --git a/{{cookiecutter.project_slug}}/home/management/commands/createsuperuserauto.py b/{{cookiecutter.project_slug}}/home/management/commands/createsuperuserauto.py
@@ -5,39 +5,49 @@
 
 
 class Command(createsuperuser.Command):
-    help = 'Crate a superuser, and allow password to be provided'
+    help = "Crate a superuser, and allow password to be provided"
 
     def add_arguments(self, parser):
         super(Command, self).add_arguments(parser)
         parser.add_argument(
-            '--password', dest='password', default=None,
-            help='Specifies the password for the superuser.',
+            "--password",
+            dest="password",
+            default=None,
+            help="Specifies the password for the superuser.",
         )
         if self.UserModel.USERNAME_FIELD != "username":
             parser.add_argument(
-                '--username', dest='username', default=None,
-                help="Specifies the username for the superuser"
+                "--username",
+                dest="username",
+                default=None,
+                help="Specifies the username for the superuser",
             )
 
     def handle(self, *args, **options):
-        password = options.get('password')
-        username = options.get('username')
-        database = options.get('database')
-        email = options.get('email')
+        password = options.get("password")
+        username = options.get("username")
+        database = options.get("database")
+        email = options.get("email")
 
         User = self.UserModel
         username_field_type = type(User._meta.get_field(User.USERNAME_FIELD))
         username = email if username_field_type == EmailField else username
         username_type = "email" if username_field_type == EmailField else "username"
         if not password or not username:
-            raise CommandError(f"You need to specify both password and {username_type}.")
+            raise CommandError(
+                f"You need to specify both password and {username_type}."
+            )
         options.update({User.USERNAME_FIELD: username})
         super(Command, self).handle(*args, **options)
 
-        user = self.UserModel._default_manager.db_manager(database).get(**{User.USERNAME_FIELD: username})
+        user = self.UserModel._default_manager.db_manager(database).get(
+            **{User.USERNAME_FIELD: username}
+        )
         if password:
             user.set_password(password)
             user.save()
 
         if email:
-            EmailAddress.objects.create(user=user, email=email, primary=True, verified=True)
+            EmailAddress.objects.create(
+                user=user, email=email, primary=True, verified=True
+            )
diff --git a/{{cookiecutter.project_slug}}/home/management/commands/customchangepassword.py b/{{cookiecutter.project_slug}}/home/management/commands/customchangepassword.py
@@ -5,35 +5,43 @@
 
 
 class Command(BaseCommand):
-    help = 'Update password of the provided username.'
+    help = "Update password of the provided username."
 
     def add_arguments(self, parser):
         parser.add_argument(
-            '--username', dest='username', default=None,
-            help='Specifies the username to be updated.',
+            "--username",
+            dest="username",
+            default=None,
+            help="Specifies the username to be updated.",
         )
 
         parser.add_argument(
-            '--email', dest='email', default=None,
-            help='Specifies the email to be updated.',
+            "--email",
+            dest="email",
+            default=None,
+            help="Specifies the email to be updated.",
         )
 
         parser.add_argument(
-            '--password', dest='password', default=None,
-            help='Specifies the password to be updated.',
+            "--password",
+            dest="password",
+            default=None,
+            help="Specifies the password to be updated.",
         )
 
     def handle(self, *args, **options):
         User = get_user_model()
-        password = options.get('password')
-        username = options.get('username')
-        email = options.get('email')
+        password = options.get("password")
+        username = options.get("username")
+        email = options.get("email")
 
         username_field_type = type(User._meta.get_field(User.USERNAME_FIELD))
         username = email if username_field_type == EmailField else username
         username_type = "email" if username_field_type == EmailField else "username"
         if not password or not username:
-            raise CommandError(f"You need to specify both password and {username_type}.")
+            raise CommandError(
+                f"You need to specify both password and {username_type}."
+            )
 
         try:
             user = User.objects.get(**{User.USERNAME_FIELD: username})
diff --git a/{{cookiecutter.project_slug}}/home/management/commands/upgradetosuperuser.py b/{{cookiecutter.project_slug}}/home/management/commands/upgradetosuperuser.py
@@ -28,6 +28,10 @@ def handle(self, *args, **kwargs) -> None:
                     )
                 )
             except EmailAddress.DoesNotExist:
-                self.stdout.write(self.style.ERROR(f"User {email} does not exist or not active or verified"))
+                self.stdout.write(
+                    self.style.ERROR(
+                        f"User {email} does not exist or not active or verified"
+                    )
+                )
         else:
             self.stdout.write(self.style.ERROR(f"No email address provided."))
diff --git a/{{cookiecutter.project_slug}}/home/migrations/0001_load_initial_data.py b/{{cookiecutter.project_slug}}/home/migrations/0001_load_initial_data.py
@@ -15,7 +15,6 @@ def create_site(apps, schema_editor):
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("sites", "0002_alter_domain_unique"),
     ]
diff --git a/{{cookiecutter.project_slug}}/home/views.py b/{{cookiecutter.project_slug}}/home/views.py
@@ -3,11 +3,18 @@
 
 def home(request):
     packages = [
-	{'name':'django-allauth', 'url': 'https://pypi.org/project/django-allauth/0.38.0/'},
-	{'name':'django-bootstrap4', 'url': 'https://pypi.org/project/django-bootstrap4/0.0.7/'},
-	{'name':'djangorestframework', 'url': 'https://pypi.org/project/djangorestframework/3.9.0/'},
+        {
+            "name": "django-allauth",
+            "url": "https://pypi.org/project/django-allauth/0.38.0/",
+        },
+        {
+            "name": "django-bootstrap4",
+            "url": "https://pypi.org/project/django-bootstrap4/0.0.7/",
+        },
+        {
+            "name": "djangorestframework",
+            "url": "https://pypi.org/project/djangorestframework/3.9.0/",
+        },
     ]
-    context = {
-        'packages': packages
-    }
-    return render(request, 'home/index.html', context)
+    context = {"packages": packages}
+    return render(request, "home/index.html", context)
diff --git a/{{cookiecutter.project_slug}}/manage.py b/{{cookiecutter.project_slug}}/manage.py
@@ -5,7 +5,9 @@
 
 
 def main():
-    os.environ.setdefault('DJANGO_SETTINGS_MODULE', '{{cookiecutter.project_slug}}.settings')
+    os.environ.setdefault(
+        "DJANGO_SETTINGS_MODULE", "{{cookiecutter.project_slug}}.settings"
+    )
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:
@@ -17,5 +19,5 @@ def main():
     execute_from_command_line(sys.argv)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()
diff --git a/{{cookiecutter.project_slug}}/modules/admin.py b/{{cookiecutter.project_slug}}/modules/admin.py
@@ -7,7 +7,7 @@
 # Crowdbotics' official modules working properly.
 
 try:
-    admins = Path(".").rglob('admin.py')
+    admins = Path(".").rglob("admin.py")
 
     for admin in admins:
         module = import_module(posixpath_to_modulepath(admin), package="modules")
diff --git a/{{cookiecutter.project_slug}}/modules/apps.py b/{{cookiecutter.project_slug}}/modules/apps.py
@@ -2,5 +2,5 @@
 
 
 class ModulesConfig(AppConfig):
-    name = 'modules'
-    verbose_name = 'Crowdbotics Modules'
+    name = "modules"
+    verbose_name = "Crowdbotics Modules"
diff --git a/{{cookiecutter.project_slug}}/modules/urls.py b/{{cookiecutter.project_slug}}/modules/urls.py
@@ -20,12 +20,9 @@
         if not module_name == "modules":
             module_url = module_name.replace("_", "-")
             urlpatterns += [
-                path(f"{module_url}/",
-                     include(
-                        posixpath_to_modulepath(
-                            url.relative_to(base_dir)
-                        )
-                     )
+                path(
+                    f"{module_url}/",
+                    include(posixpath_to_modulepath(url.relative_to(base_dir))),
                 )  # noqa
             ]
 except (ImportError, IndexError, ProgrammingError):
diff --git a/{{cookiecutter.project_slug}}/modules/utils.py b/{{cookiecutter.project_slug}}/modules/utils.py
@@ -28,8 +28,6 @@ def get_options(module_slug, option_key):
     )
 
     options_module = posixpath_to_modulepath(module_options_file)
-    default_value = getattr(
-        importlib.import_module(options_module), option_key
-    )
+    default_value = getattr(importlib.import_module(options_module), option_key)
 
     return option_value if option_value else default_value
diff --git a/{{cookiecutter.project_slug}}/users/admin.py b/{{cookiecutter.project_slug}}/users/admin.py
@@ -9,7 +9,6 @@
 
 @admin.register(User)
 class UserAdmin(auth_admin.UserAdmin):
-
     form = UserChangeForm
     add_form = UserCreationForm
     fieldsets = (("User", {"fields": ("name",)}),) + auth_admin.UserAdmin.fieldsets
diff --git a/{{cookiecutter.project_slug}}/users/forms.py b/{{cookiecutter.project_slug}}/users/forms.py
@@ -11,7 +11,6 @@ class Meta(forms.UserChangeForm.Meta):
 
 
 class UserCreationForm(forms.UserCreationForm):
-
     error_message = forms.UserCreationForm.error_messages.update(
         {"duplicate_username": _("This username has already been taken.")}
     )
diff --git a/{{cookiecutter.project_slug}}/users/migrations/0001_initial.py b/{{cookiecutter.project_slug}}/users/migrations/0001_initial.py
@@ -5,7 +5,6 @@
 
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies = [
@@ -132,6 +131,8 @@ class Migration(migrations.Migration):
                 "verbose_name_plural": "users",
                 "abstract": False,
             },
-            managers=[("objects", django.contrib.auth.models.UserManager()),],
+            managers=[
+                ("objects", django.contrib.auth.models.UserManager()),
+            ],
         ),
     ]
diff --git a/{{cookiecutter.project_slug}}/users/tests/factories.py b/{{cookiecutter.project_slug}}/users/tests/factories.py
@@ -5,9 +5,7 @@
 from factory.django import DjangoModelFactory
 
 
-
 class UserFactory(DjangoModelFactory):
-
     username = Faker("user_name")
     email = Faker("email")
     name = Faker("name")
diff --git a/{{cookiecutter.project_slug}}/users/views.py b/{{cookiecutter.project_slug}}/users/views.py
@@ -7,7 +7,6 @@
 
 
 class UserDetailView(LoginRequiredMixin, DetailView):
-
     model = User
     slug_field = "username"
     slug_url_kwarg = "username"
@@ -17,7 +16,6 @@ class UserDetailView(LoginRequiredMixin, DetailView):
 
 
 class UserUpdateView(LoginRequiredMixin, UpdateView):
-
     model = User
     fields = ["name"]
 
@@ -32,7 +30,6 @@ def get_object(self):
 
 
 class UserRedirectView(LoginRequiredMixin, RedirectView):
-
     permanent = False
 
     def get_redirect_url(self):
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/wsgi.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/wsgi.py
@@ -11,6 +11,8 @@
 
 from django.core.wsgi import get_wsgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', '{{cookiecutter.project_slug}}.settings')
+os.environ.setdefault(
+    "DJANGO_SETTINGS_MODULE", "{{cookiecutter.project_slug}}.settings"
+)
 
 application = get_wsgi_application()

Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,4 @@`
`2`	`2`
`3`	`3`
`4`	`4`	`class HomeConfig(AppConfig):`
`5`		`- name = 'home'`
	`5`	`+ name = "home"`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,10 @@ def handle(self, args, *kwargs) -> None:`
`28`	`28`	`)`
`29`	`29`	`)`
`30`	`30`	`except EmailAddress.DoesNotExist:`
`31`		`- self.stdout.write(self.style.ERROR(f"User {email} does not exist or not active or verified"))`
	`31`	`+ self.stdout.write(`
	`32`	`+ self.style.ERROR(`
	`33`	`+ f"User {email} does not exist or not active or verified"`
	`34`	`+ )`
	`35`	`+ )`
`32`	`36`	`else:`
`33`	`37`	`self.stdout.write(self.style.ERROR(f"No email address provided."))`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,6 @@ def create_site(apps, schema_editor):`
`15`	`15`
`16`	`16`
`17`	`17`	`class Migration(migrations.Migration):`
`18`		`-`
`19`	`18`	`dependencies = [`
`20`	`19`	`("sites", "0002_alter_domain_unique"),`
`21`	`20`	`]`