entrouvert
/
authentic
16
0
Fork 0
Code Issues Pull Requests 35 Releases Activity

journal: make all record() arguments keyword only (#63174)

This commit is contained in:
Benjamin Dauvergne 2022-03-25 07:46:13 +01:00
parent eb8cd06d80
commit 43ac8dbb51
5 changed files with 44 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/authentic2/apps/journal/models.py
View File

@ -84,7 +84,7 @@ class EventTypeDefinition(metaclass=EventTypeDefinitionMeta):
retention_days = None
@classmethod
def record(cls, user=None, session=None, references=None, data=None, api=False):
def record(cls, *, user=None, session=None, references=None, data=None, api=False):
event_type = EventType.objects.get_for_name(cls.name)
if user and not isinstance(user, User):

40
src/authentic2/journal_event_types.py
View File

@ -26,7 +26,7 @@ from .models import Service
class EventTypeWithService(EventTypeDefinition):
@classmethod
def record(cls, user=None, session=None, references=None, data=None, api=False, service=None):
def record(cls, *, user=None, session=None, references=None, data=None, api=False, service=None):
if service:
if not data:
data = {}
@ -48,7 +48,7 @@ class EventTypeWithService(EventTypeDefinition):
class EventTypeWithHow(EventTypeWithService):
@classmethod
def record(cls, user, session, service, how):
def record(cls, *, user, session, service, how):
super().record(user=user, session=session, service=service, data={'how': how})
@classmethod
@ -150,7 +150,7 @@ class UserLoginFailure(EventTypeWithService):
label = _('login failure')
@classmethod
def record(cls, service, username, user, reason=None):
def record(cls, *, service, username, user, reason=None):
super().record(user=user, service=service, data={'username': username, 'reason': reason})
@classmethod
@ -168,7 +168,7 @@ class UserRegistrationRequest(EventTypeDefinition):
label = _('registration request')
@classmethod
def record(cls, email):
def record(cls, *, email):
super().record(data={'email': email.lower()})
@classmethod
@ -192,7 +192,7 @@ class UserLogout(EventTypeWithService):
label = _('logout')
@classmethod
def record(cls, user, session, service):
def record(cls, *, user, session, service):
super().record(user=user, session=session, service=service)
@classmethod
@ -205,7 +205,7 @@ class UserRequestPasswordReset(EventTypeDefinition):
label = _('password reset request')
@classmethod
def record(cls, user, email):
def record(cls, *, user, email):
super().record(user=user, data={'email': email.lower()})
@classmethod
@ -221,7 +221,7 @@ class UserResetPassword(EventTypeDefinition):
label = _('password reset')
@classmethod
def record(cls, user, session):
def record(cls, *, user, session):
super().record(user=user, session=session)
@ -230,7 +230,7 @@ class UserResetPasswordFailure(EventTypeDefinition):
label = _('password reset failure')
@classmethod
def record(cls, email):
def record(cls, *, email):
super().record(data={'email': email})
@classmethod
@ -246,7 +246,7 @@ class UserChangePassword(EventTypeWithService):
label = _('password change')
@classmethod
def record(cls, user, session, service):
def record(cls, *, user, session, service):
super().record(user=user, session=session, service=service)
@ -255,7 +255,7 @@ class UserEdit(EventTypeWithService):
label = _('profile edit')
@classmethod
def record(cls, user, session, service, form):
def record(cls, *, user, session, service, form):
data = form_to_old_new(form)
super().record(user=user, session=session, service=service, data=data)
@ -273,7 +273,7 @@ class UserDeletion(EventTypeWithService):
label = _('user deletion')
@classmethod
def record(cls, user, session, service):
def record(cls, *, user, session, service):
super().record(user=user, session=session, service=service)
@ -292,7 +292,7 @@ class UserServiceSSOAuthorization(EventTypeWithService):
label = _('consent to single sign on')
@classmethod
def record(cls, user, session, service, **kwargs):
def record(cls, *, user, session, service, **kwargs):
super().record(user=user, session=session, service=service, data=kwargs)
@classmethod
@ -306,7 +306,7 @@ class UserServiceSSORefusal(EventTypeWithService):
label = _('do not consent to single sign on')
@classmethod
def record(cls, user, session, service, **kwargs):
def record(cls, *, user, session, service, **kwargs):
super().record(user=user, session=session, service=service, data=kwargs)
@classmethod
@ -320,7 +320,7 @@ class UserServiceSSOUnauthorization(EventTypeWithService):
label = _('remove consent to single sign on')
@classmethod
def record(cls, user, session, service):
def record(cls, *, user, session, service):
super().record(user=user, session=session, service=service)
@classmethod
@ -334,7 +334,7 @@ class UserServiceSSODenied(EventTypeWithService):
label = _('was denied single-sign-on')
@classmethod
def record(cls, user, session, service, **kwargs):
def record(cls, *, user, session, service, **kwargs):
super().record(user=user, session=session, service=service, data=kwargs)
@classmethod
@ -348,7 +348,7 @@ class UserEmailChangeRequest(EventTypeDefinition):
label = _('email change request')
@classmethod
def record(cls, user, session, new_email):
def record(cls, *, user, session, new_email):
data = {
'old_email': user.email,
'email': new_email,
@ -366,7 +366,7 @@ class UserEmailChange(EventTypeDefinition):
label = _('email change')
@classmethod
def record(cls, user, session, old_email, new_email):
def record(cls, *, user, session, old_email, new_email):
data = {
'old_email': old_email,
'email': new_email,
@ -385,7 +385,7 @@ class UserProfileAdd(EventTypeDefinition):
label = _('user profile creation')
@classmethod
def record(cls, user, profile):
def record(cls, *, user, profile):
profile_type = ''
if profile.profile_type is not None:
profile_type = profile.profile_type.name or profile.profile_type.slug
@ -413,7 +413,7 @@ class UserProfileUpdate(EventTypeDefinition):
label = _('user profile update')
@classmethod
def record(cls, user, profile):
def record(cls, *, user, profile):
profile_type = ''
if profile.profile_type is not None:
profile_type = profile.profile_type.name or profile.profile_type.slug
@ -441,7 +441,7 @@ class UserProfileDelete(EventTypeDefinition):
label = _('user profile deletion')
@classmethod
def record(cls, user, profile):
def record(cls, *, user, profile):
profile_type = ''
if profile.profile_type is not None:
profile_type = profile.profile_type.name or profile.profile_type.slug

36
src/authentic2/manager/journal_event_types.py
View File

@ -35,7 +35,7 @@ class ManagerUserCreation(EventTypeDefinition):
label = _('user creation')
@classmethod
def record(cls, user, session, form, api=False):
def record(cls, *, user, session, form, api=False):
super().record(user=user, session=session, references=[form.instance], api=api)
@classmethod
@ -55,7 +55,7 @@ class ManagerUserProfileEdit(EventTypeDefinition):
label = _('user profile edit')
@classmethod
def record(cls, user, session, form, api=False):
def record(cls, *, user, session, form, api=False):
super().record(
user=user, session=session, references=[form.instance], data=form_to_old_new(form), api=api
)
@ -77,7 +77,7 @@ class ManagerUserEmailChangeRequest(EventTypeDefinition):
label = _('email change request')
@classmethod
def record(cls, user, session, form):
def record(cls, *, user, session, form):
data = {
'old_email': form.instance.email,
'email': form.cleaned_data.get('new_email'),
@ -100,7 +100,7 @@ class ManagerUserPasswordChange(EventTypeDefinition):
label = _('user password change')
@classmethod
def record(cls, user, session, form, api=False):
def record(cls, *, user, session, form, api=False):
cleaned_data = getattr(form, 'cleaned_data', {})
data = {
'generate_password': cleaned_data.get('generate_password', False),
@ -130,7 +130,7 @@ class ManagerUserPasswordResetRequest(EventTypeDefinition):
label = _('user password reset request')
@classmethod
def record(cls, user, session, target_user, api=False):
def record(cls, *, user, session, target_user, api=False):
super().record(
user=user, session=session, references=[target_user], data={'email': target_user.email}, api=api
)
@ -151,7 +151,7 @@ class ManagerUserPasswordChangeForce(EventTypeDefinition):
label = _('mandatory password change at next login set')
@classmethod
def record(cls, user, session, target_user, api=False):
def record(cls, *, user, session, target_user, api=False):
super().record(user=user, session=session, references=[target_user], api=api)
@classmethod
@ -169,7 +169,7 @@ class ManagerUserPasswordChangeUnforce(EventTypeDefinition):
label = _('mandatory password change at next login unset')
@classmethod
def record(cls, user, session, target_user):
def record(cls, *, user, session, target_user):
super().record(user=user, session=session, references=[target_user])
@classmethod
@ -188,7 +188,7 @@ class ManagerUserActivation(EventTypeDefinition):
@classmethod
# pylint: disable=arguments-renamed
def record(cls, target_user, user=None, session=None, origin=None, reason=None):
def record(cls, *, target_user, user=None, session=None, origin=None, reason=None):
data = {'origin': origin, 'reason': reason}
super().record(user=user, session=session, references=[target_user], data=data)
@ -218,7 +218,7 @@ class ManagerUserDeactivation(EventTypeDefinition):
@classmethod
# pylint: disable=arguments-renamed
def record(cls, target_user, user=None, session=None, origin=None, reason=None):
def record(cls, *, target_user, user=None, session=None, origin=None, reason=None):
data = {'reason': reason, 'origin': origin}
super().record(user=user, session=session, references=[target_user], data=data)
@ -259,7 +259,7 @@ class ManagerUserDeletion(EventTypeDefinition):
label = _('user deletion')
@classmethod
def record(cls, user, session, target_user, api=False):
def record(cls, *, user, session, target_user, api=False):
super().record(user=user, session=session, references=[target_user], api=api)
@classmethod
@ -277,7 +277,7 @@ class ManagerUserSSOAuthorizationDeletion(EventTypeWithService):
label = _('delete authorization')
@classmethod
def record(cls, user, session, service, target_user):
def record(cls, *, user, session, service, target_user):
super().record(user=user, session=session, service=service, references=[target_user])
@classmethod
@ -299,7 +299,7 @@ class ManagerUserSSOAuthorizationDeletion(EventTypeWithService):
class RoleEventsMixin(EventTypeDefinition):
@classmethod
def record(cls, user, role, session=None, references=None, data=None, api=False):
def record(cls, *, user, role, session=None, references=None, data=None, api=False):
references = references or []
references = [role] + references
data = data or {}
@ -332,7 +332,7 @@ class ManagerRoleEdit(RoleEventsMixin):
label = _('role edit')
@classmethod
def record(cls, user, session, role, form, api=False):
def record(cls, *, user, session, role, form, api=False):
super().record(user=user, session=session, role=role, data=form_to_old_new(form), api=api)
@classmethod
@ -366,7 +366,7 @@ class ManagerRoleMembershipGrant(RoleEventsMixin):
label = _('role membership grant')
@classmethod
def record(cls, user, session, role, member, api=False):
def record(cls, *, user, session, role, member, api=False):
data = {'member_name': str(member)}
super().record(user=user, session=session, role=role, references=[member], data=data, api=api)
@ -388,7 +388,7 @@ class ManagerRoleMembershipRemoval(RoleEventsMixin):
label = _('role membership removal')
@classmethod
def record(cls, user, session, role, member, api=False):
def record(cls, *, user, session, role, member, api=False):
data = {'member_name': str(member)}
super().record(user=user, session=session, role=role, references=[member], data=data, api=api)
@ -412,7 +412,7 @@ class ManagerRoleInheritanceAddition(RoleEventsMixin):
label = _('role inheritance addition')
@classmethod
def record(cls, user, session, parent, child):
def record(cls, *, user, session, parent, child):
data = {
'child_name': str(child),
'child_uuid': child.uuid,
@ -458,7 +458,7 @@ class ManagerRoleAdministratorRoleAddition(RoleEventsMixin):
label = _('role administrator role addition')
@classmethod
def record(cls, user, session, role, admin_role):
def record(cls, *, user, session, role, admin_role):
data = {
'admin_role_name': str(admin_role),
'admin_role_uuid': admin_role.uuid,
@ -504,7 +504,7 @@ class ManagerRoleAdministratorUserAddition(RoleEventsMixin):
label = _('role administrator user addition')
@classmethod
def record(cls, user, session, role, admin_user):
def record(cls, *, user, session, role, admin_user):
data = {
'admin_user_name': str(admin_user),
'admin_user_uuid': admin_user.uuid,

8
tests/test_journal.py
View File

@ -54,7 +54,7 @@ def some_event_types(clean_event_types_definition_registry):
label = 'registration request'
@classmethod
def record(cls, email):
def record(cls, *, email):
super().record(data={'email': email.lower()})
class UserRegistration(EventTypeDefinition):
@ -62,7 +62,7 @@ def some_event_types(clean_event_types_definition_registry):
label = 'registration'
@classmethod
def record(cls, user, session, how):
def record(cls, *, user, session, how):
super().record(user=user, session=session, data={'how': how})
class UserLogin(EventTypeDefinition):
@ -70,7 +70,7 @@ def some_event_types(clean_event_types_definition_registry):
label = 'login'
@classmethod
def record(cls, user, session, how):
def record(cls, *, user, session, how):
super().record(user=user, session=session, data={'how': how})
class UserLogout(EventTypeDefinition):
@ -78,7 +78,7 @@ def some_event_types(clean_event_types_definition_registry):
label = 'logout'
@classmethod
def record(cls, user, session):
def record(cls, *, user, session):
super().record(user=user, session=session)
yield locals()

2
tests/test_journal_app/journal_event_types.py
View File

@ -23,5 +23,5 @@ class Login(EventTypeDefinition):
label = 'Login'
@classmethod
def record(cls, user=None, session=None):
def record(cls, *, user=None, session=None):
super().record(user=user, session=session)