benchling-sdk 1.10.0a12__py3-none-any.whl → 1.11.0a0__py3-none-any.whl

benchling_sdk/apps/status/helpers.py

@@ -12,9 +12,28 @@ def ref(reference: ReferencedSessionLinkType) -> str:
 
     Example:
         dna_sequence = benchling.dna_sequences.get_by_id("seq_1234")
-        AppSessionMessageCreate(f"This is my DNA sequence {ref(dna_sequence)} for analysis"
+        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 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.dist-info → benchling_sdk-1.11.0a0.dist-info}/METADATA

@@ -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.10.0a12.dist-info → benchling_sdk-1.11.0a0.dist-info}/RECORD

@@ -20,7 +20,7 @@ benchling_sdk/apps/helpers/webhook_helpers.py,sha256=R5bk480BbvomQ0kK9RXsnsrMBn-
 benchling_sdk/apps/status/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 benchling_sdk/apps/status/errors.py,sha256=BezqnaHkCG1QBscD4301NjSYBHu7BzdYEUKF90psuz0,2377
 benchling_sdk/apps/status/framework.py,sha256=go0pyU5qgMCvsrTDXWk3V9FZwbaRHgfhEWtjIZ-JLEE,27418
-benchling_sdk/apps/status/helpers.py,sha256=o8jdgdxUYdGh2j0Gb3AYoeXI9Bu-ubyIkgWBuCGLKgE,705
+benchling_sdk/apps/status/helpers.py,sha256=MSa2soRIK7TiA9TWAEg-EoqZ7ZYyjTmtJ28JIe6LUds,1316
 benchling_sdk/apps/status/types.py,sha256=vE7-_7ns3mvPRJoVv-GQxc3389dIIH4mcG0VDNWpVhQ,746
 benchling_sdk/apps/types.py,sha256=TBTfAB3IOoZjZqzTOK25kN3b6RTU9Z7tOMdBbq6u8lA,110
 benchling_sdk/auth/__init__.py,sha256=N4pJYVUnTLzg5HO9ZldHaI-Am97i6AOCdQS0M5QcVpA,120
@@ -115,7 +115,7 @@ benchling_sdk/services/v2/v2_alpha_service.py,sha256=vNfYK0Dheml9ozR_0tzTlA3blPD
 benchling_sdk/services/v2/v2_beta_service.py,sha256=0vbjFFfPQNUGUhckR_cnzGjypRMBpBP6c5c49zrA3mk,11564
 benchling_sdk/services/v2/v2_stable_service.py,sha256=YIc-_0p6x1NQqj7awnWgCTHxbxYO7ZOolePZyW90whc,35246
 benchling_sdk/services/v2_service.py,sha256=3eoIjYEmGLPdWCpBN0pl7q7_HNWCsUvfvTn3Hcz0wSM,2860
-benchling_sdk-1.10.0a12.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-benchling_sdk-1.10.0a12.dist-info/METADATA,sha256=n5szlyWEsJSYFRmKpajezDP15hNiJSzGh6MVRfDKyQs,2127
-benchling_sdk-1.10.0a12.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-benchling_sdk-1.10.0a12.dist-info/RECORD,,
+benchling_sdk-1.11.0a0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+benchling_sdk-1.11.0a0.dist-info/METADATA,sha256=kIJQoX4idjcIolmANOqV6HXFfbk9DpZ-ZG9TJ5hJXHk,2126
+benchling_sdk-1.11.0a0.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+benchling_sdk-1.11.0a0.dist-info/RECORD,,