django-pfx 1.4.dev62__tar.gz → 1.4.dev66__tar.gz

{django_pfx-1.4.dev62 → django_pfx-1.4.dev66}/.gitignore

@@ -1,4 +1,5 @@
 # Python
+__pycache__
 /venv
 *.pyc
 *.egg-info

{django_pfx-1.4.dev62 → django_pfx-1.4.dev66}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: django-pfx
-Version: 1.4.dev62
+Version: 1.4.dev66
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.4.dev62 → django_pfx-1.4.dev66}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: django-pfx
-Version: 1.4.dev62
+Version: 1.4.dev66
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.4.dev62 → django_pfx-1.4.dev66}/django_pfx.egg-info/SOURCES.txt

@@ -61,6 +61,8 @@ pfx/pfxcore/middleware/authentication.py
 pfx/pfxcore/middleware/locale.py
 pfx/pfxcore/middleware/profiling.py
 pfx/pfxcore/migrations/0001_initial.py
+pfx/pfxcore/migrations/0002_pfxpermissionsuser.py
+pfx/pfxcore/migrations/0003_delete_pfxpermissionsuser.py
 pfx/pfxcore/migrations/__init__.py
 pfx/pfxcore/models/__init__.py
 pfx/pfxcore/models/abstract_pfx_base_user.py

{django_pfx-1.4.dev62 → django_pfx-1.4.dev66}/doc/source/authentication.md

@@ -9,20 +9,44 @@ including password validation and hashing.
 ## User Model
 
 You have the option to use the standard Django User with {class}`pfx.pfxcore.models.PFXUser`
-(which is a {class}`django.contrib.auth.models.User` with PFX required mixins),
-but you may prefer to use your own model. To do this, create your own user class.
+(which is a {class}`django.contrib.auth.models.User` with PFX required mixins):
+
+```python
+AUTH_USER_MODEL = 'pfxcore.PFXUser'
+```
+
+But you may prefer to use your own model. To do this, create your own user class.
+
+You have 2 options:
 
 ```python
 from pfx.pfxcore.models import AbstractPFXBaseUser
 
 class MyUser(AbstractPFXBaseUser):
+    # Equivalent of django.contrib.auth.models.AbstractBaseUser for PFX.
+    #
+    # Minimal user, you have to manage the USERNAME_FIELD by yourself,
+    # and you have to add django.contrib.auth.models.PermissionsMixin
+    # if you want to use the permission system.
     pass
 ```
 
+```python
+from pfx.pfxcore.models import AbstractPFXUser
+
+class MyUser(AbstractPFXUser):
+    # Equivalent of django.contrib.auth.models.AbstractUser for PFX.
+    #
+    # This is the same as using pfxcore.PFXUser, but you can add your
+    # custom fields.
+    pass
+
+```
+
 Then, define the model in your settings:
 
 ```python
-AUTH_USER_MODEL = "myapp.MyUser"
+AUTH_USER_MODEL = 'myapp.MyUser'
 ```
 
 ## Authentication Modes

django_pfx-1.4.dev66/pfx/pfxcore/migrations/0002_pfxpermissionsuser.py

@@ -0,0 +1,45 @@
+# Generated by Django 4.2.17 on 2025-01-20 06:47
+# flake8: noqa
+
+import django.contrib.auth.models
+import django.contrib.auth.validators
+import django.utils.timezone
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('auth', '0012_alter_user_first_name_max_length'),
+        ('pfxcore', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='PFXPermissionsUser',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('password', models.CharField(max_length=128, verbose_name='password')),
+                ('last_login', models.DateTimeField(blank=True, null=True, verbose_name='last login')),
+                ('is_superuser', models.BooleanField(default=False, help_text='Designates that this user has all permissions without explicitly assigning them.', verbose_name='superuser status')),
+                ('username', models.CharField(error_messages={'unique': 'A user with that username already exists.'}, help_text='Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.', max_length=150, unique=True, validators=[django.contrib.auth.validators.UnicodeUsernameValidator()], verbose_name='username')),
+                ('first_name', models.CharField(blank=True, max_length=150, verbose_name='first name')),
+                ('last_name', models.CharField(blank=True, max_length=150, verbose_name='last name')),
+                ('email', models.EmailField(blank=True, max_length=254, verbose_name='email address')),
+                ('is_staff', models.BooleanField(default=False, help_text='Designates whether the user can log into this admin site.', verbose_name='staff status')),
+                ('is_active', models.BooleanField(default=True, help_text='Designates whether this user should be treated as active. Unselect this instead of deleting accounts.', verbose_name='active')),
+                ('date_joined', models.DateTimeField(default=django.utils.timezone.now, verbose_name='date joined')),
+                ('groups', models.ManyToManyField(blank=True, help_text='The groups this user belongs to. A user will get all permissions granted to each of their groups.', related_name='user_set', related_query_name='user', to='auth.group', verbose_name='groups')),
+                ('user_permissions', models.ManyToManyField(blank=True, help_text='Specific permissions for this user.', related_name='user_set', related_query_name='user', to='auth.permission', verbose_name='user permissions')),
+            ],
+            options={
+                'verbose_name': 'user',
+                'verbose_name_plural': 'users',
+                'abstract': False,
+                'swappable': 'AUTH_USER_MODEL',
+            },
+            managers=[
+                ('objects', django.contrib.auth.models.UserManager()),
+            ],
+        ),
+    ]

django_pfx-1.4.dev66/pfx/pfxcore/migrations/0003_delete_pfxpermissionsuser.py

@@ -0,0 +1,16 @@
+# Generated by Django 4.2.18 on 2025-01-20 13:24
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('pfxcore', '0002_pfxpermissionsuser'),
+    ]
+
+    operations = [
+        migrations.DeleteModel(
+            name='PFXPermissionsUser',
+        ),
+    ]

{django_pfx-1.4.dev62 → django_pfx-1.4.dev66}/pfx/pfxcore/models/__init__.py

@@ -1,4 +1,4 @@
-from .abstract_pfx_base_user import AbstractPFXBaseUser
+from .abstract_pfx_base_user import AbstractPFXBaseUser, AbstractPFXUser
 from .cache_mixins import CacheableMixin, CacheDependsMixin
 from .login_ban import LoginBan
 from .not_null_fields import (

{django_pfx-1.4.dev62 → django_pfx-1.4.dev66}/pfx/pfxcore/models/abstract_pfx_base_user.py

@@ -1,7 +1,9 @@
-from django.contrib.auth.models import AbstractBaseUser
+from django.contrib.auth.models import AbstractBaseUser, AbstractUser
 
+from .pfx_models import PFXModelMixin
 
-class AbstractPFXBaseUser(AbstractBaseUser):
+
+class AbstractPFXBaseUser(PFXModelMixin, AbstractBaseUser):
     """The base abstract user for PFX."""
 
     class Meta:
@@ -16,3 +18,10 @@ class AbstractPFXBaseUser(AbstractBaseUser):
         changes, the previously issued tokens will no longer be valid.
         """
         return self.password
+
+
+class AbstractPFXUser(AbstractUser, AbstractPFXBaseUser):
+    """The base abstract user for PFX with permissions mixin."""
+
+    class Meta:
+        abstract = True

django_pfx-1.4.dev66/pfx/pfxcore/models/pfx_user.py

@@ -0,0 +1,11 @@
+from django.contrib.auth.models import AbstractUser
+
+from .abstract_pfx_base_user import AbstractPFXUser
+
+
+class PFXUser(AbstractPFXUser):
+    """The Django User with PFX mixins.
+    """
+
+    class Meta(AbstractUser.Meta):
+        swappable = "AUTH_USER_MODEL"

{django_pfx-1.4.dev62 → django_pfx-1.4.dev66}/tests/models.py

@@ -50,7 +50,7 @@ class UserManager(BaseUserManager):
             is_superuser=True)
 
 
-class User(CacheableMixin, JSONReprMixin, OtpUserMixin, AbstractPFXBaseUser):
+class User(CacheableMixin, OtpUserMixin, AbstractPFXBaseUser):
     username = models.CharField(
         'username',
         max_length=150,

django_pfx-1.4.dev62/pfx/pfxcore/models/pfx_user.py

@@ -1,11 +0,0 @@
-from django.contrib.auth.models import AbstractUser
-
-from .abstract_pfx_base_user import AbstractPFXBaseUser
-
-
-class PFXUser(AbstractUser, AbstractPFXBaseUser):
-    """The Django User with PFX mixin.
-    """
-
-    class Meta(AbstractUser.Meta):
-        swappable = "AUTH_USER_MODEL"