Extend package discovery to support passive mechanisms #685
+15
−6
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The current implementation of package discovery follows one of two paths: 1. None of the extensions were specifically enabled via a command line argument, in which case all of the extensions are engaged. 2. Some subset of the extensions were given arguments, in which case the others are ignored and their discover() methods are not called. This change adds support for discovery extensions which do not expose command line arguments and cannot therefore be specifically enabled, and ensures that those extensions are always engaged. This is a non-breaking enhancement of the PackageDiscoveryExtensionPoint interface.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #685 +/- ##
==========================================
+ Coverage 87.28% 87.51% +0.23%
==========================================
Files 68 70 +2
Lines 3949 4054 +105
Branches 760 784 +24
==========================================
+ Hits 3447 3548 +101
Misses 396 396
- Partials 106 110 +4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
j-rivero
reviewed
Mar 6, 2025
| if has_parameter: | ||
| with_parameters[extension.PACKAGE_DISCOVERY_NAME] = extension | ||
| return with_parameters | ||
| if has_parameter is not None: |
There was a problem hiding this comment.
This nested conditions are hard to read for a newbie in the code like me.
We could go explicit on has_parameter accepted values:
diff --git a/colcon_core/package_discovery/__init__.py b/colcon_core/package_discovery/__init__.py
index 165d7d3..44a897c 100644
--- a/colcon_core/package_discovery/__init__.py
+++ b/colcon_core/package_discovery/__init__.py
@@ -236,13 +236,20 @@ def _get_extensions_with_parameters(
'Exception in package discovery extension '
f"'{extension.PACKAGE_DISCOVERY_NAME}': {e}\n{exc}")
# skip failing extension, continue with next one
+ continue
+
+ if has_parameter is True:
+ explicitly_specified = True
+ if has_parameter is False:
+ continue
+ elif has_parameter is None:
+ pass
else:
- if has_parameter is not None:
- if has_parameter:
- explicitly_specified = True
- else:
- continue
- with_parameters[extension.PACKAGE_DISCOVERY_NAME] = extension
+ assert 'has_parameter returned a value different of True, '\
+ 'False or None'
+
+ with_parameters[extension.PACKAGE_DISCOVERY_NAME] = extension
+
return with_parameters if explicitly_specified else OrderedDict() or in a more packed form:
--- a/colcon_core/package_discovery/__init__.py
+++ b/colcon_core/package_discovery/__init__.py
@@ -236,13 +236,15 @@ def _get_extensions_with_parameters(
'Exception in package discovery extension '
f"'{extension.PACKAGE_DISCOVERY_NAME}': {e}\n{exc}")
# skip failing extension, continue with next one
- else:
- if has_parameter is not None:
- if has_parameter:
- explicitly_specified = True
- else:
- continue
- with_parameters[extension.PACKAGE_DISCOVERY_NAME] = extension
+ continue
+
+ if has_parameter is False:
+ continue
+ elif has_parameter:
+ explicitly_specified = True
+
+ with_parameters[extension.PACKAGE_DISCOVERY_NAME] = extension
+
return with_parameters if explicitly_specified else OrderedDict() There was a problem hiding this comment.
Does e14eb19 look better? I'm trying to keep the boolean semantics from the original implementation without actually checking that the type is bool (i.e. comparing directly with True/False)
j-rivero
reviewed
Mar 6, 2025
j-rivero
approved these changes
Mar 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current implementation of package discovery follows one of two paths:
This change adds support for discovery extensions which do not expose command line arguments and cannot therefore be specifically enabled, and ensures that those extensions are always engaged.
This is a non-breaking enhancement of the PackageDiscoveryExtensionPoint interface.