Special characters in projects

Author: hovnatan

superannotate/db/project_api.py

@@ -163,6 +163,14 @@ def create_folder(project, folder_name):
     if not isinstance(project, dict):
         project = get_project_metadata_bare(project)
     params = {"team_id": project["team_id"], "project_id": project["id"]}
+    special_characters = set('/\\:*?"<>|')
+    name_changed = False
+    if len(set(folder_name).intersection(special_characters)) > 0:
+        logger.warning(
+            "New folder name has special characters. Special characters will be replaced by underscores."
+        )
+        name_changed = True
+
     data = {"name": folder_name}
     response = _api.send_request(
         req_type='POST', path='/folder', params=params, json_req=data
@@ -172,7 +180,8 @@ def create_folder(project, folder_name):
             response.status_code, "Couldn't create project " + response.text
         )
     res = response.json()
-    if res["name"] != folder_name:
+
+    if res["name"] != folder_name and not name_changed:
         logger.warning(
             "Created folder has name %s, since folder with name %s already existed.",
             res["name"], folder_name

superannotate/version.py

@@ -1 +1 @@
-__version__ = "4.1.0b5"
+__version__ = "4.1.0b6"

tests/test_folders.py

@@ -493,3 +493,22 @@ def test_folder_image_annotation_status(tmpdir):
     for image in ["example_image_3.jpg", "example_image_3.jpg"]:
         metadata = sa.get_image_metadata(project, image)
         assert metadata["annotation_status"] == "InProgress"
+
+
+def test_folder_misnamed(tmpdir):
+    PROJECT_NAME = "test folder misnamed"
+    tmpdir = Path(tmpdir)
+
+    projects_found = sa.search_projects(PROJECT_NAME, return_metadata=True)
+    for pr in projects_found:
+        sa.delete_project(pr)
+
+    project = sa.create_project(PROJECT_NAME, 'test', 'Vector')
+    sa.create_folder(project, "folder1")
+    assert "folder1" in sa.search_folders(project)
+
+    sa.create_folder(project, "folder1")
+    assert "folder1 (1)" in sa.search_folders(project)
+
+    sa.create_folder(project, "folder2\\")
+    assert "folder2_" in sa.search_folders(project)