Styling: Unify styling of signal handlers

Signed-off-by: Roberto Rosario <Roberto.Rosario@mayan-edms.com>

HISTORY.rst

@@ -189,6 +189,7 @@
   no longer need it.
 - Raise the NeedPassphrase exception when GPG has no terminal
   available.
+- Unified styling of signal handlers functions. 
 
 3.1.9 (2018-11-01)
 ==================

mayan/apps/autoadmin/apps.py

@@ -17,7 +17,7 @@ class AutoAdminAppConfig(MayanAppConfig):
     def ready(self):
         super(AutoAdminAppConfig, self).ready()
         post_save.connect(
-            dispatch_uid='auto_admin_account_password_change',
+            dispatch_uid='auto_admin_handler_account_password_change',
             receiver=handler_auto_admin_account_password_change,
             sender=settings.AUTH_USER_MODEL
         )

mayan/apps/checkouts/apps.py

@@ -21,7 +21,7 @@ from .events import (
     event_document_auto_check_in, event_document_check_in,
     event_document_check_out, event_document_forceful_check_in
 )
-from .handlers import check_new_version_creation
+from .handlers import handler_check_new_version_creation
 from .links import (
     link_checkin_document, link_checkout_document, link_checkout_info,
     link_checkout_list
@@ -126,7 +126,7 @@ class CheckoutsApp(MayanAppConfig):
         )
 
         pre_save.connect(
-            check_new_version_creation,
+            dispatch_uid='checkouts_handler_check_new_version_creation',
-            dispatch_uid='check_new_version_creation',
+            receiver=handler_check_new_version_creation,
             sender=DocumentVersion
         )

mayan/apps/checkouts/handlers.py

@@ -5,7 +5,7 @@ from django.apps import apps
 from .exceptions import NewDocumentVersionNotAllowed
 
 
-def check_new_version_creation(sender, instance, **kwargs):
+def handler_check_new_version_creation(sender, instance, **kwargs):
     """
     Make sure that new version creation is allowed for this document
     """

mayan/apps/common/apps.py

@@ -19,8 +19,9 @@ from mayan.celery import app
 
 from .classes import Template
 from .handlers import (
-    handler_pre_initial_setup, handler_pre_upgrade, user_locale_profile_create,
+    handler_pre_initial_setup, handler_pre_upgrade,
-    user_locale_profile_session_config
+    handler_user_locale_profile_create,
+    handler_user_locale_profile_session_config
 )
 from .licenses import *  # NOQA
 from .links import (
@@ -146,22 +147,22 @@ class CommonApp(MayanAppConfig):
         )
 
         post_save.connect(
-            user_locale_profile_create,
+            dispatch_uid='common_handler_user_locale_profile_create',
-            dispatch_uid='user_locale_profile_create',
+            receiver=handler_user_locale_profile_create,
             sender=settings.AUTH_USER_MODEL
         )
         pre_initial_setup.connect(
-            handler_pre_initial_setup,
+            dispatch_uid='common_handler_pre_initial_setup',
-            dispatch_uid='common_handler_pre_initial_setup'
+            receiver=handler_pre_initial_setup
         )
         pre_upgrade.connect(
-            handler_pre_upgrade,
             dispatch_uid='common_handler_pre_upgrade',
+            receiver=handler_pre_upgrade
         )
 
         user_logged_in.connect(
-            user_locale_profile_session_config,
+            dispatch_uid='common_handler_user_locale_profile_session_config',
-            dispatch_uid='user_locale_profile_session_config'
+            receiver=handler_user_locale_profile_session_config
         )
         self.setup_auto_logging()
 

mayan/apps/common/handlers.py

@@ -15,7 +15,16 @@ def handler_pre_upgrade(sender, **kwargs):
     management.call_command('purgeperiodictasks', interactive=False)
 
 
-def user_locale_profile_session_config(sender, request, user, **kwargs):
+def handler_user_locale_profile_create(sender, instance, created, **kwargs):
+    UserLocaleProfile = apps.get_model(
+        app_label='common', model_name='UserLocaleProfile'
+    )
+
+    if created:
+        UserLocaleProfile.objects.create(user=instance)
+
+
+def handler_user_locale_profile_session_config(sender, request, user, **kwargs):
     UserLocaleProfile = apps.get_model(
         app_label='common', model_name='UserLocaleProfile'
     )
@@ -44,12 +53,3 @@ def user_locale_profile_session_config(sender, request, user, **kwargs):
             request.set_cookie(
                 settings.TIMEZONE_COOKIE_NAME, user_locale_profile.timezone
             )
-
-
-def user_locale_profile_create(sender, instance, created, **kwargs):
-    UserLocaleProfile = apps.get_model(
-        app_label='common', model_name='UserLocaleProfile'
-    )
-
-    if created:
-        UserLocaleProfile.objects.create(user=instance)

mayan/apps/document_indexing/apps.py

@@ -23,7 +23,7 @@ from mayan.apps.navigation import SourceColumn
 from mayan.celery import app
 
 from .handlers import (
-    create_default_document_index, handler_delete_empty,
+    handler_create_default_document_index, handler_delete_empty,
     handler_index_document, handler_post_save_index_document,
     handler_remove_document
 )
@@ -224,8 +224,8 @@ class DocumentIndexingApp(MayanAppConfig):
             sender=Document
         )
         post_initial_document_type.connect(
-            dispatch_uid='document_indexing_create_default_document_index',
+            dispatch_uid='document_indexing_handler_create_default_document_index',
-            receiver=create_default_document_index,
+            receiver=handler_create_default_document_index,
             sender=DocumentType
         )
         post_save.connect(

mayan/apps/document_indexing/handlers.py

@@ -8,7 +8,7 @@ from .tasks import (
 )
 
 
-def create_default_document_index(sender, **kwargs):
+def handler_create_default_document_index(sender, **kwargs):
     DocumentType = apps.get_model(
         app_label='documents', model_name='DocumentType'
     )

mayan/apps/document_signatures/apps.py

@@ -15,7 +15,9 @@ from mayan.apps.common import (
 from mayan.apps.navigation import SourceColumn
 from mayan.celery import app
 
-from .handlers import unverify_key_signatures, verify_key_signatures
+from .handlers import (
+    handler_unverify_key_signatures, handler_verify_key_signatures
+)
 from .links import (
     link_all_document_version_signature_verify, link_document_signature_list,
     link_document_version_signature_delete,
@@ -156,12 +158,10 @@ class DocumentSignaturesApp(MayanAppConfig):
         )
 
         post_delete.connect(
-            unverify_key_signatures,
+            dispatch_uid='document_signatures_handler_unverify_key_signatures',
-            dispatch_uid='unverify_key_signatures',
+            receiver=handler_unverify_key_signatures, sender=Key
-            sender=Key
         )
         post_save.connect(
-            verify_key_signatures,
+            dispatch_uid='document_signatures_handler_verify_key_signatures',
-            dispatch_uid='verify_key_signatures',
+            receiver=handler_verify_key_signatures, sender=Key
-            sender=Key
         )

mayan/apps/document_signatures/handlers.py

@@ -6,17 +6,13 @@ from .tasks import (
 )
 
 
-def unverify_key_signatures(sender, **kwargs):
+def handler_unverify_key_signatures(sender, **kwargs):
     task_unverify_key_signatures.apply_async(
         kwargs=dict(key_id=kwargs['instance'].key_id)
     )
 
 
-def verify_key_signatures(sender, **kwargs):
+def handler_verify_key_signatures(sender, **kwargs):
     task_verify_key_signatures.apply_async(
         kwargs=dict(key_pk=kwargs['instance'].pk)
     )
-
-
-def verify_missing_embedded_signature(sender, **kwargs):
-    task_verify_missing_embedded_signature.delay()

mayan/apps/document_states/apps.py

@@ -21,7 +21,8 @@ from mayan.celery import app
 
 from .classes import WorkflowAction
 from .handlers import (
-    handler_index_document, handler_trigger_transition, launch_workflow
+    handler_index_document, handler_launch_workflow,
+    handler_trigger_transition,
 )
 from .methods import method_get_workflow
 from .links import (
@@ -352,18 +353,17 @@ class DocumentStatesApp(MayanAppConfig):
         menu_tools.bind_links(links=(link_tool_launch_all_workflows,))
 
         post_save.connect(
-            launch_workflow, dispatch_uid='launch_workflow', sender=Document
+            dispatch_uid='workflows_handler_launch_workflow',
+            receiver=handler_launch_workflow, sender=Document
         )
 
         # Index updating
 
         post_save.connect(
-            handler_index_document,
+            dispatch_uid='workflows_handler_index_document_save',
-            dispatch_uid='handler_index_document_save',
+            receiver=handler_index_document, sender=WorkflowInstanceLogEntry
-            sender=WorkflowInstanceLogEntry
         )
         post_save.connect(
-            handler_trigger_transition,
+            dispatch_uid='workflows_handler_handler_trigger_transition',
-            dispatch_uid='document_states_handler_trigger_transition',
+            receiver=handler_trigger_transition, sender=Action
-            sender=Action
         )

mayan/apps/document_states/handlers.py

@@ -15,6 +15,15 @@ def handler_index_document(sender, **kwargs):
     )
 
 
+def handler_launch_workflow(sender, instance, created, **kwargs):
+    Workflow = apps.get_model(
+        app_label='document_states', model_name='Workflow'
+    )
+
+    if created:
+        Workflow.objects.launch_for(instance)
+
+
 def handler_trigger_transition(sender, **kwargs):
     action = kwargs['instance']
 
@@ -45,12 +54,3 @@ def handler_trigger_transition(sender, **kwargs):
                 comment=_('Event trigger: %s') % EventType.get(name=action.verb).label,
                 transition=valid_transitions[0]
             )
-
-
-def launch_workflow(sender, instance, created, **kwargs):
-    Workflow = apps.get_model(
-        app_label='document_states', model_name='Workflow'
-    )
-
-    if created:
-        Workflow.objects.launch_for(instance)

mayan/apps/documents/apps.py

@@ -48,7 +48,7 @@ from .events import (
     event_document_version_revert, event_document_view
 )
 from .handlers import (
-    create_default_document_type, handler_create_document_cache,
+    handler_create_default_document_type, handler_create_document_cache,
     handler_remove_empty_duplicates_lists, handler_scan_duplicates_for
 )
 from .links import (
@@ -589,21 +589,21 @@ class DocumentsApp(MayanAppConfig):
         )
 
         post_delete.connect(
-            dispatch_uid='handler_remove_empty_duplicates_lists',
+            dispatch_uid='documents_handler_remove_empty_duplicates_lists',
             receiver=handler_remove_empty_duplicates_lists,
             sender=Document,
         )
         post_initial_setup.connect(
-            create_default_document_type,
+            dispatch_uid='documents_handler_create_default_document_type',
-            dispatch_uid='create_default_document_type'
+            receiver=handler_create_default_document_type,
         )
         post_migrate.connect(
             dispatch_uid='documents_handler_create_document_cache',
             receiver=handler_create_document_cache,
         )
         post_version_upload.connect(
-            handler_scan_duplicates_for,
+            dispatch_uid='documents_handler_scan_duplicates_for',
-            dispatch_uid='handler_scan_duplicates_for',
+            receiver=handler_scan_duplicates_for,
         )
 
         registry.register(DeletedDocument)

mayan/apps/documents/handlers.py

@@ -12,7 +12,7 @@ from .signals import post_initial_document_type
 from .tasks import task_clean_empty_duplicate_lists, task_scan_duplicates_for
 
 
-def create_default_document_type(sender, **kwargs):
+def handler_create_default_document_type(sender, **kwargs):
     DocumentType = apps.get_model(
         app_label='documents', model_name='DocumentType'
     )

mayan/apps/metadata/apps.py

@@ -33,9 +33,9 @@ from .events import (
     event_metadata_type_relationship
 )
 from .handlers import (
-    handler_index_document, post_document_type_metadata_type_add,
+    handler_post_document_type_metadata_type_add,
-    post_document_type_metadata_type_delete,
+    handler_post_document_type_metadata_type_delete,
-    post_document_type_change_metadata
+    handler_post_document_type_change_metadata, handler_index_document,
 )
 from .links import (
     link_metadata_add, link_metadata_edit, link_metadata_multiple_add,
@@ -242,31 +242,31 @@ class MetadataApp(MayanAppConfig):
         )
 
         post_delete.connect(
-            post_document_type_metadata_type_delete,
+            dispatch_uid='metadata_handler_post_document_type_metadata_type_delete',
-            dispatch_uid='metadata_post_document_type_metadata_type_delete',
+            receiver=handler_post_document_type_metadata_type_delete,
             sender=DocumentTypeMetadataType
         )
         post_document_type_change.connect(
-            post_document_type_change_metadata,
+            dispatch_uid='metadata_handler_post_document_type_change_metadata',
-            dispatch_uid='metadata_post_document_type_change_metadata',
+            receiver=handler_post_document_type_change_metadata,
             sender=Document
         )
         post_save.connect(
-            post_document_type_metadata_type_add,
+            dispatch_uid='metadata_handler_post_document_type_metadata_type_add',
-            dispatch_uid='metadata_post_document_type_metadata_type_add',
+            receiver=handler_post_document_type_metadata_type_add,
             sender=DocumentTypeMetadataType
         )
 
         # Index updating
 
         post_delete.connect(
-            handler_index_document,
             dispatch_uid='metadata_handler_index_document_delete',
+            receiver=handler_index_document,
             sender=DocumentMetadata
         )
         post_save.connect(
-            handler_index_document,
             dispatch_uid='metadata_handler_index_document_save',
+            receiver=handler_index_document,
             sender=DocumentMetadata
         )
 

mayan/apps/metadata/handlers.py

@@ -11,7 +11,7 @@ from .tasks import task_add_required_metadata_type, task_remove_metadata_type
 logger = logging.getLogger(__name__)
 
 
-def post_document_type_metadata_type_add(sender, instance, created, **kwargs):
+def handler_post_document_type_metadata_type_add(sender, instance, created, **kwargs):
     logger.debug('instance: %s', instance)
 
     if created and instance.required:
@@ -23,7 +23,7 @@ def post_document_type_metadata_type_add(sender, instance, created, **kwargs):
         )
 
 
-def post_document_type_metadata_type_delete(sender, instance, **kwargs):
+def handler_post_document_type_metadata_type_delete(sender, instance, **kwargs):
     logger.debug('instance: %s', instance)
     task_remove_metadata_type.apply_async(
         kwargs={
@@ -33,7 +33,7 @@ def post_document_type_metadata_type_delete(sender, instance, **kwargs):
     )
 
 
-def post_document_type_change_metadata(sender, instance, **kwargs):
+def handler_post_document_type_change_metadata(sender, instance, **kwargs):
     logger.debug('received post_document_type_change')
     logger.debug('instance: %s', instance)
 

mayan/apps/permissions/apps.py

@@ -12,7 +12,7 @@ from mayan.apps.common import (
 )
 from mayan.apps.common.signals import perform_upgrade
 
-from .handlers import purge_permissions
+from .handlers import handler_purge_permissions
 from .links import (
     link_group_roles, link_permission_grant, link_permission_revoke,
     link_role_create, link_role_delete, link_role_edit, link_role_groups,
@@ -72,5 +72,6 @@ class PermissionsApp(MayanAppConfig):
         menu_setup.bind_links(links=(link_role_list,))
 
         perform_upgrade.connect(
-            purge_permissions, dispatch_uid='purge_permissions'
+            dispatch_uid='permissions_handler_purge_permissions',
+            receiver=handler_purge_permissions
         )

mayan/apps/permissions/handlers.py

@@ -3,5 +3,5 @@ from __future__ import unicode_literals
 from django.core import management
 
 
-def purge_permissions(**kwargs):
+def handler_purge_permissions(**kwargs):
     management.call_command('purgepermissions')

mayan/apps/sources/apps.py

@@ -17,8 +17,8 @@ from mayan.celery import app
 
 from .classes import StagingFile
 from .handlers import (
-    copy_transformations_to_version, create_default_document_source,
+    handler_copy_transformations_to_version,
-    initialize_periodic_tasks
+    handler_create_default_document_source, handler_initialize_periodic_tasks
 )
 from .links import (
     link_document_create_multiple, link_setup_source_check_now,
@@ -172,14 +172,14 @@ class SourcesApp(MayanAppConfig):
         )
 
         post_upgrade.connect(
-            initialize_periodic_tasks,
+            dispatch_uid='sources_handler_initialize_periodic_tasks',
-            dispatch_uid='initialize_periodic_tasks'
+            receiver=handler_initialize_periodic_tasks
         )
         post_initial_setup.connect(
-            create_default_document_source,
+            dispatch_uid='sources_handler_create_default_document_source',
-            dispatch_uid='create_default_document_source'
+            receiver=handler_create_default_document_source
         )
         post_version_upload.connect(
-            copy_transformations_to_version,
+            dispatch_uid='sources_handler_copy_transformations_to_version',
-            dispatch_uid='copy_transformations_to_version'
+            receiver=handler_copy_transformations_to_version
         )

mayan/apps/sources/handlers.py

@@ -6,7 +6,7 @@ from django.utils.translation import ugettext_lazy as _
 from .literals import SOURCE_UNCOMPRESS_CHOICE_ASK
 
 
-def create_default_document_source(sender, **kwargs):
+def handler_create_default_document_source(sender, **kwargs):
     WebFormSource = apps.get_model(
         app_label='sources', model_name='WebFormSource'
     )
@@ -17,7 +17,7 @@ def create_default_document_source(sender, **kwargs):
         )
 
 
-def copy_transformations_to_version(sender, **kwargs):
+def handler_copy_transformations_to_version(sender, **kwargs):
     Transformation = apps.get_model(
         app_label='converter', model_name='Transformation'
     )
@@ -31,7 +31,7 @@ def copy_transformations_to_version(sender, **kwargs):
     )
 
 
-def initialize_periodic_tasks(sender, **kwargs):
+def handler_initialize_periodic_tasks(sender, **kwargs):
     POP3Email = apps.get_model(app_label='sources', model_name='POP3Email')
     IMAPEmail = apps.get_model(app_label='sources', model_name='IMAPEmail')
     WatchFolderSource = apps.get_model(