work on PR comments

Author: Hagellach37

mapswipe_workers/mapswipe_workers/definitions.py

@@ -146,7 +146,7 @@ def constructor(self):
     def tutorial(self):
         # Imports are first made once this method get called to avoid circular imports.
         from mapswipe_workers.project_types.arbitrary_geometry.tutorial import (
-            Tutorial as ArbitraryGeometriesTutorial,
+            Tutorial as ArbitraryGeometryTutorial,
         )
         from mapswipe_workers.project_types.tile_map_service_grid.tutorial import (
             Tutorial as tmsg_tutorial,
@@ -159,7 +159,7 @@ def tutorial(self):
 
         project_type_classes = {
             1: tmsg_tutorial,
-            2: ArbitraryGeometriesTutorial,
+            2: ArbitraryGeometryTutorial,
             3: tmsg_tutorial,
             4: tmsg_tutorial,
         }

mapswipe_workers/mapswipe_workers/mapswipe_workers.py

@@ -120,6 +120,7 @@ def run_firebase_to_postgres() -> list:
     help=(
         "Project ids for which to generate stats as a list of strings: "
         """ '["project_a", "project_b"]' """
+        "(You need the quotes.)"
     ),
 )
 def run_generate_stats(project_ids: list) -> None:
@@ -150,8 +151,9 @@ def run_generate_stats_all_projects() -> None:
     cls=PythonLiteralOption,
     default="[]",
     help=(
-        "The email of the MapSwipe users as a list of strings: "
+        "The emails of the MapSwipe users as a list of strings: "
         """ '["email_a", "email_b"]' """
+        "(You need the quotes.)"
     ),
 )
 @click.option("--team_id", "-i", help="The id of the team in Firebase.", type=str)
@@ -173,10 +175,13 @@ def run_user_management(email, emails, action, team_id) -> None:
 
     Grant or remove credentials.
     """
-    try:
-        if email:
-            emails = [email]
-        for email in emails:
+    if email:
+        email_list = [email]
+    else:
+        email_list = emails
+
+    for email in email_list:
+        try:
             if action == "add-manager-rights":
                 user_management.set_project_manager_rights(email)
             elif action == "remove-manager-rights":
@@ -188,9 +193,9 @@ def run_user_management(email, emails, action, team_id) -> None:
                 user_management.add_user_to_team(email, team_id)
             elif action == "remove-team":
                 user_management.remove_user_from_team(email)
-    except Exception:
-        logger.exception("grant user credentials failed")
-        sentry.capture_exception()
+        except Exception:
+            logger.exception("grant user credentials failed")
+            sentry.capture_exception()
 
 
 @cli.command("team-management")

mapswipe_workers/mapswipe_workers/project_types/arbitrary_geometry/task.py

@@ -40,6 +40,7 @@ def __init__(
         del self.groupId
 
         # create wkt geometry from geojson
+        # this geometry will be stored in postgres
         poly = ogr.CreateGeometryFromJson(str(featureGeometry))
         wkt_geometry = poly.ExportToWkt()
         self.geometry = wkt_geometry

mapswipe_workers/mapswipe_workers/project_types/arbitrary_geometry/tutorial.py

@@ -23,7 +23,7 @@ def __init__(self, tutorial_draft):
 
         # save tasks as geojson
         self.inputGeometries = (
-            f"{DATA_PATH}/" f"input_geometries/valid_input_{self.projectId}.geojson"
+            f"{DATA_PATH}/input_geometries/valid_input_{self.projectId}.geojson"
         )
 
         with open(self.inputGeometries, "w") as f:

mapswipe_workers/mapswipe_workers/project_types/base/project.py

@@ -1,4 +1,3 @@
-import base64
 import csv
 import datetime as dt
 import json
@@ -218,18 +217,10 @@ def save_to_firebase(self, project, groups, groupsOfTasks):
         for group_id, tasks_list in groupsOfTasks.items():
             c += 1
             if self.projectType in [ProjectType.FOOTPRINT.value]:
-                # we compress tasks for footprint project type using gzip
-                json_string_tasks = (
-                    json.dumps(tasks_list).replace(" ", "").replace("\n", "")
-                )
-                compressed_tasks = gzip_str.gzip_str(json_string_tasks)
-                # we need to decode back, but only when using Python 3.6
-                # when using Python 3.7 it just works
-                # Unfortunately the docker image uses Python 3.7
-                encoded_tasks = base64.b64encode(compressed_tasks).decode("ascii")
+                compressed_tasks = gzip_str.compress_tasks(tasks_list)
                 task_upload_dict[
                     f"v2/tasks/{self.projectId}/{group_id}"
-                ] = encoded_tasks
+                ] = compressed_tasks
             else:
                 task_upload_dict[f"v2/tasks/{self.projectId}/{group_id}"] = tasks_list
 

mapswipe_workers/mapswipe_workers/project_types/base/tutorial.py

@@ -1,5 +1,3 @@
-import base64
-import json
 from abc import ABCMeta, abstractmethod
 
 from mapswipe_workers import auth
@@ -51,12 +49,8 @@ def save_tutorial(self):
 
         if self.projectType in [ProjectType.FOOTPRINT.value]:
             # we compress tasks for footprint project type using gzip
-            json_string_tasks = json.dumps(tasks).replace(" ", "").replace("\n", "")
-            compressed_tasks = gzip_str.gzip_str(json_string_tasks)
-            # we need to decode back, but only when using Python 3.6
-            # when using Python 3.7 it just works
-            # Unfortunately the docker image uses Python 3.7
-            tasks = {"101": base64.b64encode(compressed_tasks).decode("ascii")}
+            compressed_tasks = gzip_str.compress_tasks(tasks)
+            tasks = {"101": compressed_tasks}
 
         ref.update(
             {

mapswipe_workers/mapswipe_workers/project_types/tile_map_service_grid/project.py

@@ -147,12 +147,16 @@ def validate_geometries(self):
             feat_geom.Transform(transform)
             project_area = +feat_geom.GetArea() / 1000000
 
-        # calculate max area based on zoom level
-        # for zoom level 18 this will be 5000 square kilometers
         # max zoom level is 22
         if self.zoomLevel > 22:
             raise CustomError(f"zoom level is too large (max: 22): {self.zoomLevel}.")
 
+        # We calculate the max area based on zoom level.
+        # This is an approximation to restrict the project size
+        # in respect to the number of tasks.
+        # At zoom level 22 the max area is set to 200 square kilometers.
+        # For zoom level 18 this will result in an max area of 5000 square kilometers.
+        # (23-18) * (23-18) * 200 = 5000
         max_area = (23 - int(self.zoomLevel)) * (23 - int(self.zoomLevel)) * 200
 
         if project_area > max_area:

mapswipe_workers/mapswipe_workers/utils/gzip_str.py

@@ -1,5 +1,8 @@
+import base64
 import gzip
 import io
+import json
+from typing import Dict, List
 
 
 def gzip_str(string_: str) -> bytes:
@@ -16,3 +19,15 @@ def gzip_str(string_: str) -> bytes:
 def gunzip_bytes_obj(bytes_obj: bytes) -> str:
     """Decompress gzip-compatible binary string."""
     return gzip.decompress(bytes_obj).decode()
+
+
+def compress_tasks(tasks_list: List[Dict]) -> str:
+    """Compress tasks for footprint project type using gzip."""
+    json_string_tasks = json.dumps(tasks_list).replace(" ", "").replace("\n", "")
+    compressed_tasks = gzip_str.gzip_str(json_string_tasks)
+    # we need to decode back, but only when using Python 3.6
+    # when using Python 3.7 it just works
+    # Unfortunately the docker image uses Python 3.6
+    encoded_tasks = base64.b64encode(compressed_tasks).decode("ascii")
+
+    return encoded_tasks