Merge pull request #8819 from OpenMined/eelco/rename-project-start

notebooks/api/0.8/01-submit-code.ipynb

@@ -482,7 +482,7 @@
    "outputs": [],
    "source": [
     "# Once we start the project, it will submit the project along with the code request to the Domain Server\n",
-    "project = new_project.start()\n",
+    "project = new_project.send()\n",
     "project"
    ]
   },
@@ -599,7 +599,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.16"
+   "version": "3.10.13"
   },
   "toc": {
    "base_numbering": 1,

notebooks/api/0.8/06-multiple-code-requests.ipynb

@@ -250,7 +250,7 @@
    },
    "outputs": [],
    "source": [
-    "project = new_project.start()\n",
+    "project = new_project.send()\n",
     "\n",
     "project"
    ]
@@ -578,7 +578,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.5"
+   "version": "3.10.13"
   },
   "toc": {
    "base_numbering": 1,

notebooks/tutorials/data-owner/03-messages-and-requests.ipynb

@@ -200,7 +200,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "project = new_project.start()\n",
+    "project = new_project.send()\n",
     "project"
    ]
   },

notebooks/tutorials/data-scientist/05-syft-functions.ipynb

@@ -400,7 +400,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "project = new_project.start()\n",
+    "project = new_project.send()\n",
     "project"
    ]
   },

notebooks/tutorials/data-scientist/06-messaging-and-requests.ipynb

@@ -200,7 +200,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "project = new_project.start()\n",
+    "project = new_project.send()\n",
     "project"
    ]
   },

notebooks/tutorials/model-auditing/colab/01-user-log.ipynb

@@ -481,7 +481,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "project = audit_project.start()\n",
+    "project = audit_project.send()\n",
     "project"
    ]
   },

notebooks/tutorials/model-training/01-data-scientist-submit-code.ipynb

@@ -492,7 +492,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "project = new_project.start()"
+    "project = new_project.send()"
    ]
   },
   {

notebooks/tutorials/pandas-cookbook/01-reading-from-a-csv.ipynb

@@ -554,7 +554,7 @@
    },
    "outputs": [],
    "source": [
-    "project = new_project.start()\n",
+    "project = new_project.send()\n",
     "assert isinstance(project, sy.service.project.project.Project)\n",
     "project"
    ]

notebooks/tutorials/pandas-cookbook/02-selecting-data-finding-common-complain.ipynb

@@ -760,7 +760,7 @@
    },
    "outputs": [],
    "source": [
-    "project = new_project.start()\n",
+    "project = new_project.send()\n",
     "assert isinstance(project, sy.service.project.project.Project)\n",
     "project"
    ]

notebooks/tutorials/pandas-cookbook/03-which-borough-has-the-most-noise-complaints.ipynb

@@ -874,7 +874,7 @@
    },
    "outputs": [],
    "source": [
-    "project = new_project.start()\n",
+    "project = new_project.send()\n",
     "assert isinstance(project, sy.service.project.project.Project)\n",
     "project"
    ]

notebooks/tutorials/pandas-cookbook/04-weekday-bike-most-groupby-aggregate.ipynb

@@ -634,7 +634,7 @@
    },
    "outputs": [],
    "source": [
-    "project = new_project.start()\n",
+    "project = new_project.send()\n",
     "assert isinstance(project, sy.service.project.project.Project)\n",
     "project"
    ]

notebooks/tutorials/pandas-cookbook/05-combining-dataframes-scraping-weather-data.ipynb

@@ -821,7 +821,7 @@
    },
    "outputs": [],
    "source": [
-    "project = new_project.start()\n",
+    "project = new_project.send()\n",
     "assert isinstance(project, sy.service.project.project.Project)\n",
     "project"
    ]

notebooks/tutorials/pandas-cookbook/06-string-operations-which-month-was-the-snowiest.ipynb

@@ -723,7 +723,7 @@
    },
    "outputs": [],
    "source": [
-    "project = new_project.start()\n",
+    "project = new_project.send()\n",
     "assert isinstance(project, sy.service.project.project.Project)\n",
     "project"
    ]

notebooks/tutorials/pandas-cookbook/07-cleaning-up-messy-data.ipynb

@@ -778,7 +778,7 @@
    },
    "outputs": [],
    "source": [
-    "project = new_project.start()\n",
+    "project = new_project.send()\n",
     "assert isinstance(project, sy.service.project.project.Project)\n",
     "project"
    ]

notebooks/tutorials/pandas-cookbook/08-how-to-deal-with-timestamps.ipynb

@@ -728,7 +728,7 @@
    },
    "outputs": [],
    "source": [
-    "project = new_project.start()\n",
+    "project = new_project.send()\n",
     "assert isinstance(project, sy.service.project.project.Project)\n",
     "project"
    ]

packages/syft/src/syft/client/client.py

@@ -558,7 +558,7 @@ def create_project(
             user_email_address=user_email_address,
             members=[self],
         )
-        project = project_create.start()
+        project = project_create.send()
         return project
 
     # TODO: type of request should be REQUEST, but it will give circular import error

packages/syft/src/syft/client/syncing.py

@@ -1,5 +1,4 @@
 # stdlib
-import warnings
 
 # relative
 from ..abstract_node import NodeSideType
@@ -12,6 +11,7 @@
 from ..service.sync.resolve_widget import ResolveWidget
 from ..service.sync.sync_state import SyncState
 from ..types.uid import UID
+from ..util.decorators import deprecated
 from .client import SyftClient
 from .sync_decision import SyncDecision
 from .sync_decision import SyncDirection
@@ -69,12 +69,8 @@ def resolve(obj_diff_batch: ObjectDiffBatch) -> ResolveWidget:
     return widget
 
 
+@deprecated(reason="resolve_single has been renamed to resolve", return_syfterror=True)
 def resolve_single(obj_diff_batch: ObjectDiffBatch) -> ResolveWidget:
-    warnings.warn(
-        "resolve_single has been renamed to resolve",
-        DeprecationWarning,
-        stacklevel=1,
-    )
     return resolve(obj_diff_batch)
 
 

packages/syft/src/syft/service/project/project.py

@@ -38,6 +38,7 @@
 from ...types.uid import UID
 from ...util import options
 from ...util.colors import SURFACE
+from ...util.decorators import deprecated
 from ...util.markdown import markdown_as_class_with_fields
 from ...util.util import full_name_with_qualname
 from ..code.user_code import SubmitUserCode
@@ -1261,7 +1262,13 @@ def create_code_request(
             reason=reason,
         )
 
+    @deprecated(
+        reason="Project.start has been renamed to Project.send", return_syfterror=True
+    )
     def start(self, return_all_projects: bool = False) -> Project | list[Project]:
+        return self.send(return_all_projects=return_all_projects)
+
+    def send(self, return_all_projects: bool = False) -> Project | list[Project]:
         # Currently we are assuming that the first member is the leader
         # This would be changed in our future leaderless approach
         leader = self.clients[0]

packages/syft/src/syft/util/decorators.py

@@ -2,6 +2,10 @@
 from collections.abc import Callable
 import functools
 from typing import Any
+import warnings
+
+# relative
+from ..service.response import SyftError
 
 
 def singleton(cls: Any) -> Callable:
@@ -46,3 +50,25 @@ def wrapper(*args: Any, **kwargs: Any) -> Any:
             return previous_instances[cls].get("instance")
 
     return wrapper
+
+
+def deprecated(
+    reason: str = "This function is deprecated and may be removed in the future.",
+    return_syfterror: bool = False,
+) -> Callable:
+    def decorator(func: Callable) -> Callable:
+        @functools.wraps(func)
+        def wrapper(*args: list, **kwargs: dict) -> Any:
+            message = f"{func.__qualname__} is deprecated: {reason}"
+            if return_syfterror:
+                return SyftError(message=message)
+            warnings.warn(
+                message,
+                category=DeprecationWarning,
+                stacklevel=2,
+            )
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator

packages/syft/tests/syft/project/project_test.py

@@ -23,7 +23,7 @@ def test_project_creation(worker):
         name="My Cool Project", description="My Cool Description", members=[ds_client]
     )
 
-    project = new_project.start()
+    project = new_project.send()
 
     assert isinstance(project, Project)
     assert new_project.id == project.id
@@ -47,7 +47,7 @@ def test_error_data_owner_project_creation(worker):
         name="My Cool Project", description="My Cool Description", members=[root_client]
     )
 
-    project = new_project.start()
+    project = new_project.send()
 
     assert isinstance(project, sy.SyftError)
     assert project.message == "Only Data Scientists can create projects"
@@ -96,7 +96,7 @@ def test_project_serde(worker):
         name="My Cool Project", description="My Cool Description", members=[root_client]
     )
 
-    project = new_project.start()
+    project = new_project.send()
 
     ser_data = sy.serialize(project, to_bytes=True)
     assert isinstance(ser_data, bytes)