Merge branch 'beta' into sdk-core/2026-02-06-3d49ce29

Author: AndyTitu

.github/workflows/validate.yml

@@ -19,7 +19,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3

example/desktop_app.py

@@ -0,0 +1,138 @@
+# [developer-docs.sdk.python.sdk-import]-start
+from onepassword import *
+import asyncio
+import os
+
+
+async def main():
+    vault_id = os.environ.get("OP_VAULT_ID")
+    if vault_id is None:
+        raise Exception("OP_VAULT_ID is required")
+
+    # [developer-docs.sdk.python.client-initialization]-start
+    # Connects to the 1Password desktop app.
+    client = await Client.authenticate(
+        auth=DesktopAuth(
+            account_name="YourAccountNameAsShownInTheDesktopApp"  # Set to your 1Password account name as shown at the top left sidebar of the app, or your account UUID.
+        ),
+        # Set the following to your own integration name and version.
+        integration_name="My 1Password Integration",
+        integration_version="v1.0.0",
+    )
+
+    # [developer-docs.sdk.python.list-vaults]-start
+    vaults = await client.vaults.list()
+    for vault in vaults:
+        print(vault)
+    # [developer-docs.sdk.python.list-vaults]-end
+
+    # [developer-docs.sdk.python.list-items]-start
+    overviews = await client.items.list(vault_id)
+    for overview in overviews:
+        print(overview.title)
+    # [developer-docs.sdk.python.list-items]-end
+
+    # [developer-docs.sdk.python.get-vault-overview]-start
+	# Get vault overview
+    vaultOverview = await client.vaults.get_overview(vault_id)
+    print(vaultOverview)
+    # [developer-docs.sdk.python.get-vault-overview]-end
+
+    # [developer-docs.sdk.python.get-vault-details]-start
+	# Get vault details
+    vault = await client.vaults.get(vaultOverview.id, VaultGetParams(accessors=False))
+    print(vault)
+    # [developer-docs.sdk.python.get-vault-details]-end
+
+	# [developer-docs.sdk.python.batch-create-items]-start
+    items_to_create = []
+    for i in range(1, 4):
+        items_to_create.append(ItemCreateParams(
+            title="My Login Item {}".format(i),
+            category=ItemCategory.LOGIN,
+            vault_id=vault.id,
+            fields=[
+                ItemField(
+                    id="username",
+                    title="username",
+                    field_type=ItemFieldType.TEXT,
+                    value="mynameisjeff",
+                ),
+                ItemField(
+                    id="password",
+                    title="password",
+                    field_type=ItemFieldType.CONCEALED,
+                    value="jeff",
+                ),
+                ItemField(
+                    id="onetimepassword",
+                    title="one-time-password",
+                    field_type=ItemFieldType.TOTP,
+                    section_id="totpsection",
+                    value="otpauth://totp/my-example-otp?secret=jncrjgbdjnrncbjsr&issuer=1Password",
+                ),
+            ],
+            sections=[
+                ItemSection(
+                    id="", title=""),
+                ItemSection(
+                    id="totpsection", title=""),
+            ],
+            tags=[
+                "test tag 1", "test tag 2"],
+            websites=[
+                Website(
+                    label="my custom website",
+                    url="https://example.com",
+                    autofill_behavior=AutofillBehavior.NEVER,
+                )
+            ],
+        ))
+
+	# Create all items in the same vault in a single batch
+    batchCreateResponse = await client.items.create_all(vault.id, items_to_create)
+
+    item_ids = []
+    for res in batchCreateResponse.individual_responses:
+        if res.content is not None:
+            print('Created item "{}" ({})'.format(
+                res.content.title, res.content.id))
+            item_ids.append(res.content.id)
+        elif res.error is not None:
+            print("[Batch create] Something went wrong: {}".format(res.error))
+    # [developer-docs.sdk.python.batch-create-items]-end
+
+    # [developer-docs.sdk.python.batch-get-items]-start
+	# Get multiple items form the same vault in a single batch
+    batchGetReponse = await client.items.get_all(vault.id, item_ids)
+    for res in batchGetReponse.individual_responses:
+        if res.content is not None:
+            print('Obtained item "{}" ({})'.format(
+                res.content.title, res.content.id))
+        elif res.error is not None:
+            print("[Batch get] Something went wrong: {}".format(res.error))
+    # [developer-docs.sdk.python.batch-get-items]-end
+
+    # [developer-docs.sdk.python.batch-delete-items]-start
+	# Delete multiple items from the same vault in a single batch
+    batchDeleteResponse = await client.items.delete_all(vault.id, item_ids)
+    for id, res in batchDeleteResponse.individual_responses.items():
+        if res.error is not None:
+            print("[Batch delete] Something went wrong: {}".format(res.error))
+        else:
+            print("Deleted item {}".format(id))
+    # [developer-docs.sdk.python.batch-delete-items]-end
+
+    group_id = os.environ.get("OP_GROUP_ID")
+    if group_id is None:
+        raise Exception("OP_GROUP_ID is required")
+
+    # [developer-docs.sdk.python.get-group]-start
+    # Get a group
+    group = await client.groups.get(group_id, GroupGetParams(vaultPermissions=False))
+    print(group)
+    # [developer-docs.sdk.python.get-group]-end
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

src/onepassword/build_number.py

@@ -1 +1 @@
-SDK_BUILD_NUMBER = "0030201"
+SDK_BUILD_NUMBER = "0040002"

src/onepassword/core.py

@@ -1,59 +1,98 @@
+from __future__ import annotations
 import json
 import platform
-
-from onepassword.errors import raise_typed_exception
+from typing import Any, Protocol
+from onepassword.desktop_core import DesktopCore
+from onepassword.errors import raise_typed_exception, DesktopSessionExpiredException
 
 # In empirical tests, we determined that maximum message size that can cross the FFI boundary
 # is ~128MB. Past this limit, FFI will throw an error and the program will crash.
 # We set the limit to 50MB to be safe and consistent with the other SDKs (where this limit is 64MB), to be reconsidered upon further testing
 MESSAGE_LIMIT = 50 * 1024 * 1024
 
-machine_arch = platform.machine().lower()
-
-if machine_arch in ["x86_64", "amd64"]:
-    import onepassword.lib.x86_64.op_uniffi_core as core
-elif machine_arch in ["aarch64", "arm64"]:
-    import onepassword.lib.aarch64.op_uniffi_core as core
-else:
-    raise ImportError(
-        f"Your machine's architecture is not currently supported: {machine_arch}"
-    )
-
-
-# InitClient creates a client instance in the current core module and returns its unique ID.
-async def _init_client(client_config):
-    try:
-        return await core.init_client(json.dumps(client_config))
-    except Exception as e:
-        raise_typed_exception(e)
-
-
-# Invoke calls specified business logic from the SDK core.
-async def _invoke(invoke_config):
-    serialized_config = json.dumps(invoke_config)
-    if len(serialized_config.encode()) > MESSAGE_LIMIT:
-        raise ValueError(
-            f"message size exceeds the limit of {MESSAGE_LIMIT} bytes, please contact 1Password at support@1password.com or https://developer.1password.com/joinslack if you need help."
-        )
-    try:
-        return await core.invoke(serialized_config)
-    except Exception as e:
-        raise_typed_exception(e)
-
-
-# Invoke calls specified business logic from the SDK core.
-def _invoke_sync(invoke_config):
-    serialized_config = json.dumps(invoke_config)
-    if len(serialized_config.encode()) > MESSAGE_LIMIT:
-        raise ValueError(
-            f"message size exceeds the limit of {MESSAGE_LIMIT} bytes, please contact 1Password at support@1password.com or https://developer.1password.com/joinslack if you need help."
-        )
-    try:
-        return core.invoke_sync(serialized_config)
-    except Exception as e:
-        raise_typed_exception(e)
-
-
-# ReleaseClient releases memory in the SDK core associated with the given client ID.
-def _release_client(client_id):
-    return core.release_client(json.dumps(client_id))
+
+class Core(Protocol):
+    async def init_client(self, client_config: dict) -> str: ...
+    async def invoke(self, invoke_config: dict) -> str: ...
+    def invoke_sync(self, invoke_config: dict) -> str: ...
+    def release_client(self, client_id: int) -> None: ...
+
+
+class InnerClient:
+    client_id: int
+    core: DesktopCore | UniffiCore
+    config: dict[str, Any]
+
+    def __init__(self, client_id: int, core: "DesktopCore | UniffiCore", config: dict[str, any]):
+        self.client_id = client_id
+        self.core = core
+        self.config = config
+
+    async def invoke(self, invoke_config: dict):
+        try:
+            return await self.core.invoke(invoke_config)
+        except DesktopSessionExpiredException:
+            new_client_id = await self.core.init_client(self.config)
+            self.client_id = new_client_id
+            invoke_config["invocation"]["clientId"] = self.client_id
+            return await self.core.invoke(invoke_config)
+        except Exception as e:
+            raise e
+
+
+class UniffiCore:
+    def __init__(self):
+        machine_arch = platform.machine().lower()
+
+        if machine_arch in ["x86_64", "amd64"]:
+            import onepassword.lib.x86_64.op_uniffi_core as core
+        elif machine_arch in ["aarch64", "arm64"]:
+            import onepassword.lib.aarch64.op_uniffi_core as core
+        else:
+            raise ImportError(
+                f"Your machine's architecture is not currently supported: {machine_arch}"
+            )
+
+        self.core = core
+
+    async def init_client(self, client_config: dict):
+        """Creates a client instance in the current core module and returns its unique ID."""
+        try:
+            return await self.core.init_client(json.dumps(client_config))
+        except Exception as e:
+            raise_typed_exception(e)
+
+    async def invoke(self, invoke_config: dict):
+        """Invoke business logic asynchronously."""
+        serialized_config = json.dumps(invoke_config)
+        if len(serialized_config.encode()) > MESSAGE_LIMIT:
+            raise ValueError(
+                f"message size exceeds the limit of {MESSAGE_LIMIT} bytes, "
+                "please contact 1Password at support@1password.com or "
+                "https://developer.1password.com/joinslack if you need help."
+            )
+        try:
+            return await self.core.invoke(serialized_config)
+        except Exception as e:
+            raise_typed_exception(e)
+
+    def invoke_sync(self, invoke_config: dict):
+        """Invoke business logic synchronously."""
+        serialized_config = json.dumps(invoke_config)
+        if len(serialized_config.encode()) > MESSAGE_LIMIT:
+            raise ValueError(
+                f"message size exceeds the limit of {MESSAGE_LIMIT} bytes, "
+                "please contact 1Password at support@1password.com or "
+                "https://developer.1password.com/joinslack if you need help."
+            )
+        try:
+            return self.core.invoke_sync(serialized_config)
+        except Exception as e:
+            raise_typed_exception(e)
+
+    def release_client(self, client_id: int):
+        """Releases memory in the SDK core associated with the given client ID."""
+        try:
+            return self.core.release_client(json.dumps(client_id))
+        except Exception as e:
+            raise_typed_exception(e)

src/onepassword/defaults.py

@@ -9,11 +9,19 @@
 DEFAULT_REQUEST_LIBRARY_VERSION = "0.11.24"
 DEFAULT_OS_VERSION = "0.0.0"
 
+class DesktopAuth:
+    def __init__(self, account_name: str):
+        """
+        Initialize a DesktopAuth instance.
+
+        Args:
+            account_name (str): The name of the account.
+        """
+        self.account_name = account_name
 
 # Generates a configuration dictionary with the user's parameters
-def new_default_config(auth, integration_name, integration_version):
+def new_default_config(auth: DesktopAuth | str, integration_name, integration_version):
     client_config_dict = {
-        "serviceAccountToken": auth,
         "programmingLanguage": SDK_LANGUAGE,
         "sdkVersion": SDK_VERSION,
         "integrationName": integration_name,
@@ -24,4 +32,7 @@ def new_default_config(auth, integration_name, integration_version):
         "osVersion": DEFAULT_OS_VERSION,
         "architecture": platform.machine(),
     }
+    if not isinstance(auth, DesktopAuth):
+        client_config_dict["serviceAccountToken"] = auth
+
     return client_config_dict