+ DictExtractString

nodes_dict.py

@@ -116,6 +116,80 @@ class DictAddString(_BaseNode):
 		result= _new_dict_with_updated_key(dict, name, string)
 		return _io.NodeOutput(result)
 
+# ----------------------------------------------------------
+
+class DictExtractString(_BaseNode):
+	"""Extract a single string from a Format-Dict."""
+	_schema = _io.Schema(
+		node_id=f'DictExtractString{_pack_id}',
+		display_name='Extract String from Dict',
+		category=_category_dict,
+		description=_format_docstring(_cleandoc(__doc__)),
+		inputs=[
+			_io.Boolean.Input(
+				'cleanup_key', display_name='cleanup',
+				tooltip=(
+					"Automatically remove leading/trailing spaces and newlines from the key."
+				),
+				default=True,
+				label_on='leading/trailing spaces',
+				label_off='no',
+			),
+			_io.String.Input(
+				'key',
+				tooltip=(
+					"Key (unique name) of a string to extract from dictionary.\n"
+					"If the element with such key isn't a string, it will be turned to one.\n"
+					"If no such key exists in the dict, an empty string returned."
+				),
+			),
+			_io.Boolean.Input(
+				'show_status',
+				tooltip="Show the extracted string on the node itself?",
+				default=False,
+				label_on='value',
+				label_off='no',
+			),
+
+			_DICT_INPUT_OPTIONAL,
+		],
+		outputs=[_io.String.Output('string')],
+		# hidden=[_io.Hidden.unique_id],
+	)
+
+	@classmethod
+	def execute(cls,
+		cleanup_key: bool, key: str, show_status: bool = False,
+		dict: _O[_FormatDict] = None
+	) -> _io.NodeOutput:
+		"""Extract a single string from the Format-Dict."""
+		if cleanup_key:
+			for line in key.split():
+				line = line.strip()  # just in case \r is left
+				if line:
+					key = line
+					break
+
+		# The passed dict might not actually be a dict but ANY mapping,
+		# which doesn't have a `get()` method.
+		# So direct key access is better:
+		string: str = ''
+		# noinspection PyBroadException
+		try:
+			string = dict[key]
+		except Exception:
+			pass
+
+		if string is None:
+			string = ''
+		elif not isinstance(string, str):
+			string = repr(string)
+
+		return _io.NodeOutput(
+			string,
+			ui=_ui.PreviewText(string) if show_status else None
+		)
+
 
 # ==========================================================
 # Deprecated nodes with old IDs (for backwards compatibility)
@@ -133,3 +207,25 @@ class DictAddStringOld1(DictAddString):
 		DictAddString._schema,
 		'StringConstructorDictAddString'
 	)
+
+
+class DictExtractStringOld1(_BaseNode):
+	# noinspection PyProtectedMember
+	_schema = _schema_old_name(
+		DictExtractString._schema,
+		'StringConstructorDictExtractString',
+		inputs=[
+			_input_override(x, id='name') if x.id == 'key' else x
+			for x in DictExtractString._schema.inputs
+			if x.id != 'cleanup_key'
+		],
+	)
+
+	@classmethod
+	def execute(cls,
+		name: str, show_status: bool = False,
+		dict: _O[_FormatDict] = None
+	) -> _io.NodeOutput:
+		return DictExtractString.execute(
+			cleanup_key=False, key=name, show_status=show_status, dict=dict
+		)