From 08384a0a9f1088596a107d05b8301f981e1822dc Mon Sep 17 00:00:00 2001 From: paulbochtler <65470117+datapumpernickel@users.noreply.github.com> Date: Tue, 18 Jun 2024 11:22:33 +0200 Subject: [PATCH 1/7] docs: updated documentation to use UUID class for retrieving user #5011 --- .../installation/configurations/user_management.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_source/getting_started/installation/configurations/user_management.md b/docs/_source/getting_started/installation/configurations/user_management.md index fd791b046a..3ecc0682c6 100644 --- a/docs/_source/getting_started/installation/configurations/user_management.md +++ b/docs/_source/getting_started/installation/configurations/user_management.md @@ -179,10 +179,10 @@ You can get a user by id using the `from_id` classmethod in the `User` class. ```python import argilla as rg - +from uuid import UUID rg.init(api_url="", api_key="") -user = rg.User.from_id("00000000-0000-0000-0000-000000000000") +user = rg.User.from_id(UUID("00000000-0000-0000-0000-000000000000")) ``` ### Assign a `User` to a `Workspace` From 9a158c76338a5bcef1b3571df070ff5fad172be9 Mon Sep 17 00:00:00 2001 From: paulbochtler <65470117+datapumpernickel@users.noreply.github.com> Date: Tue, 18 Jun 2024 11:25:29 +0200 Subject: [PATCH 2/7] docs: updated examples in function for retrieving user #5011 --- argilla/src/argilla/client/users.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/argilla/src/argilla/client/users.py b/argilla/src/argilla/client/users.py index b4ed6805b1..8448a52f27 100644 --- a/argilla/src/argilla/client/users.py +++ b/argilla/src/argilla/client/users.py @@ -104,7 +104,7 @@ def __init__( " advance in Argilla, unless you are creating a new one." ) if id is not None: - error_msg += f" As the `id` argument is not None, you should use `User.from_id('{id}')` instead." + error_msg += f" As the `id` argument is not None, you should use `User.from_id(UUID('{id}'))` instead." if name is not None: error_msg += f" As the `name` argument is not None, you should use `User.from_name('{name}')` instead." raise Exception(error_msg) @@ -285,7 +285,8 @@ def from_id(cls, id: UUID) -> "User": Examples: >>> from argilla import rg - >>> user = rg.User.from_id("my-user") + >>> from uuid import UUID + >>> user = rg.User.from_id(UUID("my-user")) """ client = cls.__active_client() try: From 15f65f5d75909853769ed03d90d75b8a084dd164 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 18 Jun 2024 09:31:22 +0000 Subject: [PATCH 3/7] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .../installation/configurations/user_management.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_source/getting_started/installation/configurations/user_management.md b/docs/_source/getting_started/installation/configurations/user_management.md index 3ecc0682c6..ef16944682 100644 --- a/docs/_source/getting_started/installation/configurations/user_management.md +++ b/docs/_source/getting_started/installation/configurations/user_management.md @@ -182,7 +182,7 @@ import argilla as rg from uuid import UUID rg.init(api_url="", api_key="") -user = rg.User.from_id(UUID("00000000-0000-0000-0000-000000000000")) +user = rg.User.from_id(UUID("00000000-0000-0000-0000-000000000000")) ``` ### Assign a `User` to a `Workspace` From 76a98089c8355faab148e9cd294d843c2cb53fc5 Mon Sep 17 00:00:00 2001 From: paulbochtler <65470117+datapumpernickel@users.noreply.github.com> Date: Wed, 19 Jun 2024 10:12:44 +0200 Subject: [PATCH 4/7] convert str id to UUID instance, if not already of instance uuid.UUID --- argilla/src/argilla/client/users.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/argilla/src/argilla/client/users.py b/argilla/src/argilla/client/users.py index 8448a52f27..fee155fb80 100644 --- a/argilla/src/argilla/client/users.py +++ b/argilla/src/argilla/client/users.py @@ -289,6 +289,12 @@ def from_id(cls, id: UUID) -> "User": >>> user = rg.User.from_id(UUID("my-user")) """ client = cls.__active_client() + + try: + if not isinstance(id,UUID): + id = UUID(id) + except: BaseClientError as e: + raise RuntimeError(f"Error while converting id=`{id}` to UUID. Is it a valid UUID?") from e try: users = users_api.list_users(client).parsed try: From 7d942b6274c373fa10bb3efa11ad19d38367a533 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 19 Jun 2024 08:13:07 +0000 Subject: [PATCH 5/7] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- argilla/src/argilla/client/users.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/argilla/src/argilla/client/users.py b/argilla/src/argilla/client/users.py index fee155fb80..f3b80386ef 100644 --- a/argilla/src/argilla/client/users.py +++ b/argilla/src/argilla/client/users.py @@ -290,8 +290,8 @@ def from_id(cls, id: UUID) -> "User": """ client = cls.__active_client() - try: - if not isinstance(id,UUID): + try: + if not isinstance(id,UUID): id = UUID(id) except: BaseClientError as e: raise RuntimeError(f"Error while converting id=`{id}` to UUID. Is it a valid UUID?") from e From 19f3c16a0bf34f75a69b708cd8a949e468a31c65 Mon Sep 17 00:00:00 2001 From: paulbochtler <65470117+datapumpernickel@users.noreply.github.com> Date: Wed, 19 Jun 2024 10:18:15 +0200 Subject: [PATCH 6/7] fix typo in except block --- argilla/src/argilla/client/users.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/argilla/src/argilla/client/users.py b/argilla/src/argilla/client/users.py index f3b80386ef..8886d7781b 100644 --- a/argilla/src/argilla/client/users.py +++ b/argilla/src/argilla/client/users.py @@ -293,7 +293,7 @@ def from_id(cls, id: UUID) -> "User": try: if not isinstance(id,UUID): id = UUID(id) - except: BaseClientError as e: + except BaseClientError as e: raise RuntimeError(f"Error while converting id=`{id}` to UUID. Is it a valid UUID?") from e try: users = users_api.list_users(client).parsed From a77b125d18a5ff56f23044a7323c3728d38203ae Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 19 Jun 2024 08:18:38 +0000 Subject: [PATCH 7/7] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- argilla/src/argilla/client/users.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/argilla/src/argilla/client/users.py b/argilla/src/argilla/client/users.py index 8886d7781b..6fe8b5d7ee 100644 --- a/argilla/src/argilla/client/users.py +++ b/argilla/src/argilla/client/users.py @@ -291,7 +291,7 @@ def from_id(cls, id: UUID) -> "User": client = cls.__active_client() try: - if not isinstance(id,UUID): + if not isinstance(id, UUID): id = UUID(id) except BaseClientError as e: raise RuntimeError(f"Error while converting id=`{id}` to UUID. Is it a valid UUID?") from e