[hotfix] Extension example for clean could not import Conan API search

[uilianries]

When pushing the PR #192 , the following error occurred in the CI:

clean_other/1.0: Package folder /Users/jenkins/workspace/Examples2.0_PR-192/c226/cbe2/.conan/p/b/clean3acc120868975/p

Elapsed time: 0.17 seconds

Running: conan clean --force

ERROR: Traceback (most recent call last):

  File "/Users/jenkins/workspace/Examples2.0_PR-192/c226/conanenv/src/conan/conan/cli/cli.py", line 308, in main

    cli.run(args)

  File "/Users/jenkins/workspace/Examples2.0_PR-192/c226/conanenv/src/conan/conan/cli/cli.py", line 193, in run

    command.run(self._conan_api, args[0][1:])

  File "/Users/jenkins/workspace/Examples2.0_PR-192/c226/conanenv/src/conan/conan/cli/command.py", line 183, in run

    info = self._method(conan_api, parser, *args)

  File "/Users/jenkins/workspace/Examples2.0_PR-192/c226/cbe2/.conan/extensions/commands/cmd_clean.py", line 31, in clean

    recipes = conan_api.search.recipes("*/*", remote=remote)

AttributeError: 'ConanAPI' object has no attribute 'search'

It seems be affected by conan-io/conan#18726

[memsharded]

Yes, it is true that the search API has been removed, thanks for noticing!

I understand that this PR will later update the example to use the list api instead, isn't it?

[uilianries]

@memsharded as far as I see, it comes from conan-io/conan#18726

I could import the search package as in the commit 3005ea6 only to unblock other PRs, then, thinking to update it to conan list in a next PR

[memsharded]

I think the whole command implementation sounds a bit too complicated.
For example, it is not necessary to select all binaries and all revisions here with :*#* as later only the recipe will be removed (and it will remove all the associated binaries automatically)

Then, it sounds very inefficient to list twice with the */* pattern. It sounds better to do a recipe revision list only pkg_list = conan_api.list.select(ListPattern("*/*", rrev=None, prev=None), then remove all but the latest revision, and for that latest revision list the specific package revisions to remove (!latest)

[uilianries]

Indeed, I have a learn curve just to write this small piece, needing to understand the API class implementation around this example. Let me update according to your suggestion.

[uilianries]

Please, check the commit 48c7135

[memsharded]

I still don't love that the ListPattern is running twice again for returning the whole Conan cache pkg+versions, but good enough for me for a custom command example

[uilianries]

I still don't love that the ListPattern is running twice again for returning the whole Conan cache pkg+versions, but good enough for me for a custom command example

We don't have helpers anymore to filter the latest rrev and later, to filter prev. It looks a bit complex now, but without these methods, my feeling is the code will be harder to understand based on accessing the list index and filtering manually.

[AbrilRBS]

In Conan we usually would call this static method from the pkg_list object itself, but do note that this is still an undocumented method, maybe we need to take a look into it - I think getting the refs and prefs of a pkglist is a valid operation that users might want access to.

We also need to check if the remove api can be improved

[uilianries]

I still don't love that the ListPattern is running twice again for returning the whole Conan cache pkg+versions, but good enough for me for a custom command example

@memsharded Please, check the commit 729e9f7. I'm using a single list now and filtering the latest revision.

I used max() to find the latest revision, but not sure if it's the best way. Probably @AbrilRBS should have a better idea.

[memsharded]

conan-io/conan#18833 has been merged, examples should use the new PackagesLists API

[memsharded]

Looks good, just avoid the "bundle" terminology for package lists (it is still used internally, but it was removed from all public code)

[uilianries]

@memsharded Thanks for reviewing! Your suggestions are addressed in the commits ae4d974 and e1ed8d7

[uilianries]

The CI will NOT pass until we have Conan 2.21 available as latest release. As the CI validates with Conan develop 2 and latest, the API is now only compatible with develop2 (future 2.21)

[czoido]

@uilianries maybe we can add a condition to the test so it only runs on conan >= 2.21.0-dev?

[uilianries]

There was a small bug that was pronounced in this new test.

[uilianries]

@czoido Good to go now. It's skipping Conan <2.21.0-dev.

[czoido]

We also have to update the code in the docs: https://docs.conan.io/2/examples/extensions/commands/clean/custom_command_clean_revisions.html targeting to develop2 as these chages will be released in 2.21.0