remote/common: allow ordering of ResourceMatches with/without name #1742
Conversation
This file contains hidden or 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
It is possible to create matches as:
$ export LG_PLACE=myplace
$ labgrid-client create
$ labgrid-client add-match myexporter/mygroup/mycls
$ labgrid-client add-named-match myexporter/mygroup/mycls/myname myrename
In this scenario, `labgrid-client show` throws an exception:
$ labgrid-client show
Place 'myplace':
matches:
Traceback (most recent call last):
File "/usr/ptx-venvs/labgrid/lib/python3.13/site-packages/labgrid/remote/client.py", line 2171, in main
session.loop.run_until_complete(coro)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^
File "/usr/lib/python3.13/asyncio/base_events.py", line 725, in run_until_complete
return future.result()
~~~~~~~~~~~~~^^
File "/usr/ptx-venvs/labgrid/lib/python3.13/site-packages/labgrid/remote/client.py", line 500, in print_place
place.show(level=1)
~~~~~~~~~~^^^^^^^^^
File "/usr/ptx-venvs/labgrid/lib/python3.13/site-packages/labgrid/remote/common.py", line 280, in show
for match in sorted(self.matches):
~~~~~~^^^^^^^^^^^^^^
File "/usr/ptx-venvs/labgrid/lib/python3.13/site-packages/attr/_make.py", line 1713, in __lt__
return attrs_to_tuple(self) < attrs_to_tuple(other)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: '<' not supported between instances of 'str' and 'NoneType'
The problem arises due to ResourceMatch objects being turned into tuples
by attrs for ordering, such as:
("myexporter", "mygroup", "mycls", None)
("myexporter", "mygroup", "mycls", "myname")
First, all elements with index 0 are compared, if these elements are
equal, elements with index 1 are compared and so forth until an order
can be determined. Normally, the comparison does not reach the "name"
element of the match.
In the example above, the first three elements are equal, so None and
"myname" are compared, which is unsupported and results in the
TypeError.
Fix that by removing the ResourceMatch's optional name attribute from
ordering operations.
Signed-off-by: Bastian Krause <bst@pengutronix.de>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1742 +/- ##
======================================
Coverage 45.4% 45.4%
======================================
Files 172 172
Lines 13503 13503
======================================
Hits 6131 6131
Misses 7372 7372
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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.
Description
It is possible to create matches as:
$ export LG_PLACE=myplace $ labgrid-client create $ labgrid-client add-match myexporter/mygroup/mycls $ labgrid-client add-named-match myexporter/mygroup/mycls/myname myrenameIn this scenario,
labgrid-client showthrows an exception:The problem arises due to
ResourceMatchobjects being turned into tuples by attrs for ordering, such as:First, all elements with index 0 are compared, if these elements are equal, elements with index 1 are compared and so forth until an order can be determined. Normally, the comparison does not reach the "name" element of the match.
In the example above, the first three elements are equal, so
Noneand"myname"are compared, which is unsupported and results in theTypeError.Fix that by removing the
ResourceMatch's optional "name" attribute from ordering operations.Checklist
Fixes #1736