CLI: gitlab user-project list doesn't work #2558

Activity

1. nejch

   added

   bug

   cli

   on Apr 30, 2023
2. nejch commented on May 1, 2023

   

   nejch

   on May 1, 2023

   Member

   More actions

   Looks like a regression from ac1c619, as we started deleting kwargs for other reasons, so by the time we're doing do_list() in the CLI the user_id is already gone.
3. w7089 commented on May 3, 2023

   

   w7089

   on May 3, 2023

   Last edited by w7089

   More actions

   It's interesting that there's no issue with API, only with CLI.

   Below code

   user = gl.users.get(3)
   print(user.projects.list())
   

   gets and prints the project list without any issue.
4. nejch commented on May 3, 2023

   

   nejch

   on May 3, 2023

   Member

   More actions

   @w7089 it's mostly because of how the CLI constructs the methods called. Some arguments get passed around in run() and get cleaned up erroneously in this case because we use a custom method that expects the arguments used a little differently from our normal mixins.
5. w7089 commented on May 24, 2023

   

   w7089

   on May 24, 2023

   More actions

   @nejch I believe the fix is as simple as adding self.mgr._from_parent_attrs = self.parent_args here. I tried locally and the issue got resolved.

   If it's acceptable, i'll open a PR after testing of other managers.

   I may be wrong as well and miss something as it's my first ever PR here.
6. JohnVillalovos commented on May 28, 2023

   

   JohnVillalovos

   on May 28, 2023

   Member

   More actions

   If it's acceptable, i'll open a PR after testing of other managers.

   Please feel free to open a PR if you think you have a valid fix. Thanks.
7. JohnVillalovos commented on May 28, 2023

   

   JohnVillalovos

   on May 28, 2023

   Member

   More actions

   I think the main reason for this is because of UserProjectManager and the fact that the path has to be regenerated.

   python-gitlab/gitlab/v4/objects/users.py

   Lines 575 to 641 in 86eba06

   	class UserProjectManager(ListMixin, CreateMixin, RESTManager):
   	_path = "/projects/user/{user_id}"
   	_obj_cls = UserProject
   	_from_parent_attrs = {"user_id": "id"}
   	_create_attrs = RequiredOptional(
   	required=("name",),
   	optional=(
   	"default_branch",
   	"issues_enabled",
   	"wall_enabled",
   	"merge_requests_enabled",
   	"wiki_enabled",
   	"snippets_enabled",
   	"squash_option",
   	"public",
   	"visibility",
   	"description",
   	"builds_enabled",
   	"public_builds",
   	"import_url",
   	"only_allow_merge_if_build_succeeds",
   	),
   	)
   	_list_filters = (
   	"archived",
   	"visibility",
   	"order_by",
   	"sort",
   	"search",
   	"simple",
   	"owned",
   	"membership",
   	"starred",
   	"statistics",
   	"with_issues_enabled",
   	"with_merge_requests_enabled",
   	"with_custom_attributes",
   	"with_programming_language",
   	"wiki_checksum_failed",
   	"repository_checksum_failed",
   	"min_access_level",
   	"id_after",
   	"id_before",
   	)
   	def list(self, **kwargs: Any) -> Union[RESTObjectList, List[RESTObject]]:
   	"""Retrieve a list of objects.
   	Args:
   	all: If True, return all the items, without pagination
   	per_page: Number of items to retrieve per request
   	page: ID of the page to return (starts with page 1)
   	iterator: If set to True and no pagination option is
   	defined, return a generator instead of a list
   	**kwargs: Extra options to send to the server (e.g. sudo)
   	Returns:
   	The list of objects, or a generator if `iterator` is True
   	Raises:
   	GitlabAuthenticationError: If authentication is not correct
   	GitlabListError: If the server cannot perform the request
   	"""
   	if self._parent:
   	path = f"/users/{self._parent.id}/projects"
   	else:
   	path = f"/users/{kwargs['user_id']}/projects"

   So maybe the idea of setting the parent attributes is correct but I'm not sure.
8. w7089 commented on May 31, 2023

   

   w7089

   on May 31, 2023

   More actions

   ok, opened the pull request, 2 previous PRs can be deleted, they are not relevant.
9. w7089 commented on Jun 30, 2023

   

   w7089

   on Jun 30, 2023

   More actions

   @JohnVillalovos any feedback on the PR?
10. JohnVillalovos commented on Jul 6, 2023

    

    JohnVillalovos

    on Jul 6, 2023

    Member

    More actions

    @JohnVillalovos any feedback on the PR?

    I'll try to look at it this week. Sorry for the delay.
11. nejch

    closed this as completedin #2588on Oct 12, 2023
12. nejch

    added a commit that references this issue on Oct 12, 2023

    fix(cli): add _from_parent_attrs to user-project manager (#2558)

    016d90c
13. github-actions

    locked as resolved and limited conversation to collaborators on Oct 14, 2024