Glassvision/IfcOpenShell
1
0
Fork 0
mirror of https://github.com/IfcOpenShell/IfcOpenShell.git synced 2026-08-12 02:23:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

ifcsverchok - document value types in doc-strings

Browse Source
This commit is contained in:
Andrej730
2026-01-22 16:54:32 +05:00
parent 2f5bcccd2c
commit b96a21350c
1 changed files with 23 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ifcsverchok/helper.py
+23 -3
View File
@@ -75,7 +75,18 @@ def get_socket_value(
*,
value_type: Literal["SINGLE_VALUE", "CONTAINER", "FLATTEN"] = "SINGLE_VALUE",
) -> Any:
value = sockets[name].sv_get()
"""
:param value_type:
- ``SINGLE_VALUE`` - e.g. ``[[x]]`` -> ``x``.
- ``CONTAINER`` - e.g. ``[ [ [x, y, z], [x,y, z] ] ]`` -> ``[ [x1, y1, z1], [x2, y2, z2] ]``.
- ``FLATTEN`` - e.g. `` [ [ [x1], [x2] ] ] `` -> `` [x1, x2] ``.
"""
socket = sockets[name]
assert isinstance(socket, sverchok.core.sockets.SvSocketCommon)
value = socket.sv_get()
if value_type == "FLATTEN":
return flatten_data(value)
value = value[0]
@@ -91,10 +102,19 @@ def set_socket_value(
*,
value_type: Literal["SINGLE_VALUE", "FINAL_VALUE"] = "SINGLE_VALUE",
) -> None:
"""
:param value_type:
- ``SINGLE_VALUE`` - e.g. ``x`` -> ``[[x]]``.
- ``FINAL_VALUE`` - keep value as is.
"""
socket = sockets[name]
assert isinstance(socket, sverchok.core.sockets.SvSocketCommon)
if value_type == "SINGLE_VALUE":
sockets[name].sv_set([[value]])
socket.sv_set([[value]])
return
sockets[name].sv_set(value)
socket.sv_set(value)
def create_socket(