Merge pull request #9001 from OpenMined/rename_unsafe_function

Rename 'unsafe_function' to 'run'
OpenMined · Jul 2, 2024 · be0deb9 · be0deb9
2 parents 0b8e366 + 6cfcc52
commit be0deb9
Show file tree

Hide file tree

Showing 15 changed files with 25 additions and 19 deletions.
diff --git a/notebooks/api/0.8/02-review-code-and-approve.ipynb b/notebooks/api/0.8/02-review-code-and-approve.ipynb
@@ -325,7 +325,7 @@
  "outputs": [],
  "source": [
  "# Let's grab the actual executable function that was submitted by the user\n",
- "users_function = func.unsafe_function"
+ "users_function = func.run"
  ]
  },
  {
@@ -501,7 +501,7 @@
  "name": "python",
  "nbconvert_exporter": "python",
  "pygments_lexer": "ipython3",
- "version": "3.10.13"
+ "version": "3.12.4"
  },
  "toc": {
  "base_numbering": 1,

diff --git a/notebooks/api/0.8/05-custom-policy.ipynb b/notebooks/api/0.8/05-custom-policy.ipynb
@@ -507,7 +507,7 @@
  },
  "outputs": [],
  "source": [
- "result = func.unsafe_function(x=x_pointer)\n",
+ "result = func.run(x=x_pointer)\n",
  "result"
  ]
  },
@@ -626,7 +626,7 @@
  "name": "python",
  "nbconvert_exporter": "python",
  "pygments_lexer": "ipython3",
- "version": "3.10.13"
+ "version": "3.12.4"
  },
  "toc": {
  "base_numbering": 1,

diff --git a/notebooks/tutorials/hello-syft/01-hello-syft.ipynb b/notebooks/tutorials/hello-syft/01-hello-syft.ipynb
@@ -412,7 +412,7 @@
  "metadata": {},
  "outputs": [],
  "source": [
- "get_mean_age_user_function = usercode.unsafe_function"
+ "get_mean_age_user_function = usercode.run"
  ]
  },
  {

diff --git a/notebooks/tutorials/model-auditing/colab/01-user-log.ipynb b/notebooks/tutorials/model-auditing/colab/01-user-log.ipynb
@@ -592,7 +592,7 @@
  "metadata": {},
  "outputs": [],
  "source": [
- "real_result = request.code.unsafe_function(data=asset.data)\n",
+ "real_result = request.code.run(data=asset.data)\n",
  "real_result"
  ]
  },

diff --git a/notebooks/tutorials/model-training/02-data-owner-review-approve-code.ipynb b/notebooks/tutorials/model-training/02-data-owner-review-approve-code.ipynb
@@ -156,7 +156,7 @@
  "metadata": {},
  "outputs": [],
  "source": [
- "users_function = user_code.unsafe_function\n",
+ "users_function = user_code.run\n",
  "users_function"
  ]
  },

diff --git a/notebooks/tutorials/pandas-cookbook/01-reading-from-a-csv.ipynb b/notebooks/tutorials/pandas-cookbook/01-reading-from-a-csv.ipynb
@@ -738,7 +738,7 @@
  },
  "outputs": [],
  "source": [
- "get_col_user_function = func.unsafe_function"
+ "get_col_user_function = func.run"
  ]
  },
  {

diff --git a/notebooks/tutorials/pandas-cookbook/02-selecting-data-finding-common-complain.ipynb b/notebooks/tutorials/pandas-cookbook/02-selecting-data-finding-common-complain.ipynb
@@ -913,7 +913,7 @@
  },
  "outputs": [],
  "source": [
- "get_counts_user_func = func.unsafe_function"
+ "get_counts_user_func = func.run"
  ]
  },
  {

diff --git a/notebooks/tutorials/pandas-cookbook/03-which-borough-has-the-most-noise-complaints.ipynb b/notebooks/tutorials/pandas-cookbook/03-which-borough-has-the-most-noise-complaints.ipynb
@@ -1030,7 +1030,7 @@
  },
  "outputs": [],
  "source": [
- "get_counts_user_func = func.unsafe_function"
+ "get_counts_user_func = func.run"
  ]
  },
  {

diff --git a/notebooks/tutorials/pandas-cookbook/04-weekday-bike-most-groupby-aggregate.ipynb b/notebooks/tutorials/pandas-cookbook/04-weekday-bike-most-groupby-aggregate.ipynb
@@ -799,7 +799,7 @@
  },
  "outputs": [],
  "source": [
- "get_col_user_function = func.unsafe_function"
+ "get_col_user_function = func.run"
  ]
  },
  {

diff --git a/notebooks/tutorials/pandas-cookbook/05-combining-dataframes-scraping-weather-data.ipynb b/notebooks/tutorials/pandas-cookbook/05-combining-dataframes-scraping-weather-data.ipynb
@@ -986,7 +986,7 @@
  },
  "outputs": [],
  "source": [
- "get_col_user_function = func.unsafe_function"
+ "get_col_user_function = func.run"
  ]
  },
  {

diff --git a/notebooks/tutorials/pandas-cookbook/06-string-operations-which-month-was-the-snowiest.ipynb b/notebooks/tutorials/pandas-cookbook/06-string-operations-which-month-was-the-snowiest.ipynb
@@ -889,7 +889,7 @@
  },
  "outputs": [],
  "source": [
- "get_col_user_function = func.unsafe_function"
+ "get_col_user_function = func.run"
  ]
  },
  {

diff --git a/notebooks/tutorials/pandas-cookbook/07-cleaning-up-messy-data.ipynb b/notebooks/tutorials/pandas-cookbook/07-cleaning-up-messy-data.ipynb
@@ -944,7 +944,7 @@
  },
  "outputs": [],
  "source": [
- "zip_codes = func.unsafe_function"
+ "zip_codes = func.run"
  ]
  },
  {

diff --git a/notebooks/tutorials/pandas-cookbook/08-how-to-deal-with-timestamps.ipynb b/notebooks/tutorials/pandas-cookbook/08-how-to-deal-with-timestamps.ipynb
@@ -895,7 +895,7 @@
  },
  "outputs": [],
  "source": [
- "find_recently_installed = func.unsafe_function"
+ "find_recently_installed = func.run"
  ]
  },
  {

diff --git a/packages/syft/src/syft/service/code/user_code.py b/packages/syft/src/syft/service/code/user_code.py
@@ -68,6 +68,7 @@
 from ...types.uid import UID
 from ...util import options
 from ...util.colors import SURFACE
+from ...util.decorators import deprecated
 from ...util.markdown import CodeMarkdown
 from ...util.markdown import as_markdown_code
 from ...util.util import prompt_warning_message
@@ -808,7 +809,7 @@ def get_sync_dependencies(
  return dependencies
 
  @property
- def unsafe_function(self) -> Callable | None:
+ def run(self) -> Callable | None:
  warning = SyftWarning(
  message="This code was submitted by a User and could be UNSAFE."
  )
@@ -850,10 +851,15 @@ def wrapper(*args: Any, **kwargs: Any) -> Callable | SyftError:
  # return the results
  return result
  except Exception as e:
- return SyftError(f"Failed to run unsafe_function. Error: {e}")
+ return SyftError(f"Failed to execute 'run'. Error: {e}")
 
  return wrapper
 
+ @property
+ @deprecated(reason="Use 'run' instead")
+ def unsafe_function(self) -> Callable | None:
+ return self.run
+
  def _inner_repr(self, level: int = 0) -> str:
  shared_with_line = ""
  if len(self.output_readers) > 0 and self.output_reader_names is not None:

diff --git a/packages/syft/tests/syft/users/user_code_test.py b/packages/syft/tests/syft/users/user_code_test.py
@@ -61,7 +61,7 @@ def test_user_code(worker) -> None:
  message = root_domain_client.notifications[-1]
  request = message.link
  user_code = request.changes[0].code
- result = user_code.unsafe_function()
+ result = user_code.run()
  request.approve()
 
  result = guest_client.api.services.code.mock_syft_func()
@@ -355,7 +355,7 @@ def compute_sum():
  message = root_domain_client.notifications[-1]
  request = message.link
  user_code = request.changes[0].code
- result = user_code.unsafe_function()
+ result = user_code.run()
  request.approve()
 
  result = ds_client.api.services.code.compute_sum()