Define project type and its class constructor in definition.py

Author: matthias_schaub

mapswipe_workers/mapswipe_workers/definitions.py

@@ -1,21 +1,11 @@
 import logging.config
 import os
-import sentry_sdk
-from xdg import XDG_DATA_HOME
-from mapswipe_workers.config import SENTRY_DSN
 from enum import Enum
 
+import sentry_sdk
+from xdg import XDG_DATA_HOME
 
-class CustomError(Exception):
-    pass
-
-
-class MessageType(Enum):
-    SUCCESS = 1
-    FAIL = 2
-    NOTIFICATION_90 = 3
-    NOTIFICATION_100 = 4
-
+from mapswipe_workers.config import SENTRY_DSN
 
 DATA_PATH = os.path.join(XDG_DATA_HOME, "mapswipe_workers")
 if not os.path.exists(DATA_PATH):
@@ -104,3 +94,44 @@ class MessageType(Enum):
         + "tilematrix={z}&tilecol={x}&tilerow={y}&layer={layer}"
     ),
 }
+
+
+class CustomError(Exception):
+    pass
+
+
+class MessageType(Enum):
+    SUCCESS = 1
+    FAIL = 2
+    NOTIFICATION_90 = 3
+    NOTIFICATION_100 = 4
+
+
+class ProjectType(Enum):
+    """
+    Definition of Project Type names, identifiers and constructors.
+
+    There are different project types with the same constructor.
+    Get the class constructor of a project type with:
+    ProjectType(1).constructor
+    """
+
+    BUILD_AREA = 1
+    FOOTPRINT = 2
+    CHANGE_DETECTION = 3
+
+    @property
+    def constuctor(self):
+        from mapswipe_workers.project_types.build_area.build_area_project import (
+            BuildAreaProject,
+        )
+        from mapswipe_workers.project_types.footprint.footprint_project import (
+            FootprintProject,
+        )
+
+        project_type_classes = {
+            1: BuildAreaProject,
+            2: FootprintProject,
+            3: BuildAreaProject,
+        }
+        return project_type_classes[self.value]

mapswipe_workers/mapswipe_workers/mapswipe_workers.py

@@ -4,11 +4,17 @@
 import json
 import time
 
+import click
 import schedule as sched
 
-import click
 from mapswipe_workers import auth
-from mapswipe_workers.definitions import CustomError, logger, sentry, MessageType
+from mapswipe_workers.definitions import (
+    CustomError,
+    MessageType,
+    ProjectType,
+    logger,
+    sentry,
+)
 from mapswipe_workers.firebase_to_postgres import (
     archive_project,
     delete_project,
@@ -17,19 +23,12 @@
 )
 from mapswipe_workers.generate_stats import generate_stats
 from mapswipe_workers.project_types.build_area import build_area_tutorial
-from mapswipe_workers.project_types.build_area.build_area_project import (
-    BuildAreaProject,
-)
 from mapswipe_workers.project_types.change_detection import change_detection_tutorial
-from mapswipe_workers.project_types.change_detection.change_detection_project import (
-    ChangeDetectionProject,
-)
-from mapswipe_workers.project_types.footprint.footprint_project import FootprintProject
 from mapswipe_workers.utils import user_management
 from mapswipe_workers.utils.create_directories import create_directories
 from mapswipe_workers.utils.slack_helper import (
-    send_slack_message,
     send_progress_notification,
+    send_slack_message,
 )
 
 
@@ -63,12 +62,6 @@ def run_create_projects():
     Save created projects, groups and tasks to Firebase and Postgres.
     """
 
-    project_type_classes = {
-        1: BuildAreaProject,
-        2: FootprintProject,
-        3: ChangeDetectionProject,
-    }
-
     fb_db = auth.firebaseDB()
     ref = fb_db.reference("v2/projectDrafts/")
     project_drafts = ref.get()
@@ -83,7 +76,7 @@ def run_create_projects():
         project_name = project_draft["name"]
         try:
             # Create a project object using appropriate class (project type).
-            project = project_type_classes[project_type](project_draft)
+            project = ProjectType(project_type).constructor()
             project.geometry = project.validate_geometries()
             project.create_groups()
             project.calc_required_results()