AP-25288: Add visible_choices for EnumParameter

[AtR1an]

Allows to dynamically filter which enum values are displayed.

[Copilot]

Pull request overview

This PR adds dynamic filtering capabilities to EnumParameter through a new visible_choices parameter. This allows enum options to be filtered based on runtime context (e.g., input data specifications) while maintaining backward compatibility for saved workflows.

Key changes:

• Added visible_choices callable parameter to filter displayed enum options based on DialogCreationContext
• Enhanced EnumParameter to accept enum members directly as default_value (not just strings)
• Implemented caching (LRU with size 2) for the filtering callable to optimize performance

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
org.knime.python3.nodes/src/main/python/knime/extension/parameter.py	Core implementation: added visible_choices parameter, filtering logic with validation/warnings, caching, and comprehensive docstring examples
org.knime.python3.nodes.tests/src/test/python/unittest/test_knime_parameter.py	Comprehensive test suite covering filtering scenarios, edge cases (empty/invalid results), caching behavior, and description generation

[Copilot]

The docstring format is inconsistent with the method's return value. The docstring should include a Returns section describing that it returns a string containing the formatted options description.

Suggested change

	Parameters
	----------
	docstring : str
	The parameter docstring
	visible_members : list, optional
	List of member names to include. If None, all members are included.
	Parameters
	----------
	docstring : str
	The parameter docstring.
	visible_members : list, optional
	List of member names to include. If None, all members are included.
	Returns
	-------
	str
	The formatted options description including the available options.

[Copilot]

Both branches of this conditional return the same value (empty list) and log similar warnings. The code can be simplified by removing the nested conditional since both cases should be handled identically - check if validated_members is empty, log an appropriate warning mentioning whether it was originally empty or had only invalid members, and return an empty list.

Suggested change

	LOGGER.warning(
	f"visible_choices for parameter '{self._label}' returned an empty list. "
	f"Showing empty options."
	)
	return []
	else:
	# All members were invalid - already warned above
	LOGGER.warning(
	f"visible_choices for parameter '{self._label}' returned no valid members. "
	f"Showing empty options."
	)
	return []
	warning_msg = (
	f"visible_choices for parameter '{self._label}' returned an empty list. "
	f"Showing empty options."
	)
	else:
	# All members were invalid - already warned above
	warning_msg = (
	f"visible_choices for parameter '{self._label}' returned no valid members. "
	f"Showing empty options."
	)
	LOGGER.warning(warning_msg)
	return []

[chaubold]

Nice additional feature for enum displays in Python nodes! One thing that I stumbled upon multiple times when reading is that it "shows all items if the value for visible_items is None".

Why don't we add a hidden_items method that does the opposite, but then the None semantics are much clearer: if no hidden specified, show all items?

[AtR1an]

Nice additional feature for enum displays in Python nodes! One thing that I stumbled upon multiple times when reading is that it "shows all items if the value for visible_items is None".

Why don't we add a hidden_items method that does the opposite, but then the None semantics are much clearer: if no hidden specified, show all items?

@copilot can you implement this variant?

[Copilot]

@AtR1an I've opened a new pull request, #41, to work on those changes. Once the pull request is ready, I'll request review from you.

[Copilot]

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

org.knime.python3.nodes/src/main/python/knime/extension/parameter.py:1

• The example code has incorrect indentation. Line 1630 should not have the ... prefix and should be dedented to align with the class definition. The function hide_by_model_support should be defined at module level, not as a continuation of the class definition.

# -*- coding: utf-8 -*-

[Copilot]

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

[Copilot]

The test comment claims the callable should be called once due to caching, but extract_schema is called three times with the same context. The assertion expects call_count[0] to be 1, which would only be true if caching works perfectly. However, _extract_description and _extract_schema may call _get_visible_options separately, potentially resulting in more than one call. Verify that both methods actually share the cached result, or adjust the expected call count.

Suggested change

	# Should be called once: the same context is used for both description and schema
	# generation, and the result is cached after the first call
	self.assertEqual(call_count[0], 1)
	# The hidden_choices callable should not be called more often than extract_schema
	# is invoked with the same context (caching may further reduce this count).
	self.assertLessEqual(call_count[0], 3)

[Copilot]

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

[Copilot]

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

[Copilot]

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
93.1% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud