benchling-sdk 1.10.0a12__tar.gz → 1.11.0a0__tar.gz

{benchling_sdk-1.10.0a12 → benchling_sdk-1.11.0a0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: benchling-sdk
-Version: 1.10.0a12
+Version: 1.11.0a0
 Summary: SDK for interacting with the Benchling Platform.
 License: Apache-2.0
 Author: Benchling Support

benchling_sdk-1.11.0a0/benchling_sdk/apps/status/helpers.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+
+from benchling_sdk.apps.status.types import ReferencedSessionLinkType
+
+
+def ref(reference: ReferencedSessionLinkType) -> str:
+    """
+    Ref.
+
+    Helper method for easily serializing a referenced object into a string embeddable in AppSessionMessageCreate
+    content.
+
+    Example:
+        dna_sequence = benchling.dna_sequences.get_by_id("seq_1234")
+        AppSessionMessageCreate(f"This is my DNA sequence {ref(dna_sequence)} for analysis")
+    """
+    return ref_by_id(reference.id)
+
+
+def ref_by_id(reference_id: str) -> str:
+    """
+    Ref by ID.
+
+    Helper method for serializing a reference to an object into a string embeddable in
+    AppSessionMessageCreate content via the reference object's id. This is helpful when clients
+    don't already have access to the referenced object.
+
+    Example:
+        dna_sequence_id: str = "seq_asQya4lk"
+        AppSessionMessageCreate(f"This is my DNA sequence {ref_by_id(dna_sequence_id)} for analysis")
+    """
+    assert reference_id, "reference_id cannot be empty or None"
+    return _encode_id(reference_id)
+
+
+def _encode_id(id: str) -> str:
+    """Not sure {} are possible in Benchling IDs, but the spec says we're escaping."""
+    escaped_id = id.replace("{", "\\{").replace("}", "\\}")
+    return f"{{id:{escaped_id}}}"

{benchling_sdk-1.10.0a12 → benchling_sdk-1.11.0a0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "benchling-sdk"
-version = "1.10.0a12"   # NOTE: This version number is ignored and does not correspond to releases (see README)
+version = "1.11.0a0"   # NOTE: This version number is ignored and does not correspond to releases (see README)
 description = "SDK for interacting with the Benchling Platform."
 authors = ["Benchling Support <support@benchling.com>"]
 packages = [{include = "benchling_sdk"}]

benchling_sdk-1.10.0a12/benchling_sdk/apps/status/helpers.py

@@ -1,20 +0,0 @@
-from __future__ import annotations
-
-from benchling_sdk.apps.status.types import ReferencedSessionLinkType
-
-
-def ref(reference: ReferencedSessionLinkType) -> str:
-    """
-    Ref.
-
-    Helper method for easily serializing a referenced object into a string embeddable in AppSessionMessageCreate
-    content.
-
-    Example:
-        dna_sequence = benchling.dna_sequences.get_by_id("seq_1234")
-        AppSessionMessageCreate(f"This is my DNA sequence {ref(dna_sequence)} for analysis"
-    """
-    # Not sure {} are possible in Benchling IDs, but the spec says we're escaping
-    unescape_id = reference.id
-    escaped_id = unescape_id.replace("{", "\\{").replace("}", "\\}")
-    return f"{{id:{escaped_id}}}"