feat(ux): display project.name_with_namespace on project repr #1996

Psycojoker · 2022-04-29T16:09:43Z

This change the repr from:

$ gitlab.projects.get(id=some_id)
<Project id:some_id>

To:

$ gitlab.projects.get(id=some_id)
<Project id:some_id name_with_namespace:"group_name / project_name">

This is especially useful when working on random projects or listing of
projects since users generally don't remember projects ids.

On a side note I've encountered this error when trying to do a commit:

An unexpected error has occurred: CalledProcessError: command: ('/home/psycojoker/.cache/pre-commit/repox1_osb0o/node_env-default/bin/node', '/home/psycojoker/.cache/pre-commit/repox1_osb0o/node_env-default/bin/npm', 'install', '--dev', '--prod', '--ignore-prepublish', '--no-progress', '--no-save')
return code: 1
expected return code: 0
stdout: (none)
stderr:
    /home/psycojoker/.cache/pre-commit/repox1_osb0o/node_env-default/bin/node: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.28' not found (required by /home/psycojoker/.cache/pre-commit/repox1_osb0o/node_env-default/bin/node)
    
Check the log at /home/psycojoker/.cache/pre-commit/pre-commit.log

I have to admit that, while I totally understand the importance of linters and good commit messages, having a hard dependency on a specific version of nodejs and glibc just do to a commit on a full python feels a bit ... intense? 😅

Anyway, thanks a lot for this project ❤️

This change the repr from: $ gitlab.projects.get(id=some_id) <Project id:some_id> To: $ gitlab.projects.get(id=some_id) <Project id:some_id name_with_namespace:"group_name / project_name"> This is especially useful when working on random projects or listing of projects since users generally don't remember projects ids.

JohnVillalovos · 2022-04-29T16:16:25Z

Cool. Just as an FYI we also have a pprint and pformat functions if of any use. Not a replacement for your PR though.

project = gl.projects.get(id=some_id)
project.pprint()

codecov-commenter · 2022-04-29T16:19:48Z

Codecov Report

Merging #1996 (e598762) into main (882fe7a) will increase coverage by 9.03%.
The diff coverage is 20.00%.

@@            Coverage Diff             @@
##             main    #1996      +/-   ##
==========================================
+ Coverage   83.47%   92.51%   +9.03%     
==========================================
  Files          78       78              
  Lines        4938     4943       +5     
==========================================
+ Hits         4122     4573     +451     
+ Misses        816      370     -446

Flag	Coverage Δ
cli_func_v4	`81.42% <20.00%> (?)`
py_func_v4	`80.43% <20.00%> (?)`
unit	`83.41% <20.00%> (-0.07%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
gitlab/v4/objects/projects.py	`87.71% <20.00%> (+7.50%)`	⬆️
gitlab/base.py	`92.59% <0.00%> (+0.52%)`	⬆️
gitlab/exceptions.py	`100.00% <0.00%> (+0.69%)`	⬆️
gitlab/config.py	`94.44% <0.00%> (+1.66%)`	⬆️
gitlab/v4/objects/members.py	`94.73% <0.00%> (+1.75%)`	⬆️
gitlab/v4/objects/export_import.py	`94.59% <0.00%> (+2.70%)`	⬆️
gitlab/types.py	`96.66% <0.00%> (+3.33%)`	⬆️
gitlab/v4/objects/wikis.py	`96.42% <0.00%> (+3.57%)`	⬆️
gitlab/v4/objects/notes.py	`94.23% <0.00%> (+3.84%)`	⬆️
gitlab/v4/objects/groups.py	`88.65% <0.00%> (+4.25%)`	⬆️
... and 33 more

JohnVillalovos

Overall looks good to me. Left a minor suggestion.

Unsure if we want a unit/functional test or not for this? @nejch what do you think?

JohnVillalovos · 2022-04-29T16:33:25Z

gitlab/v4/objects/projects.py

+
+        if hasattr(self, "name_with_namespace"):
+            return (
+                f'{project_repr[:-1]} name_with_namespace:"{self.name_with_namespace}">'


Can use the !r to quote the value.

Suggested change

f'{project_repr[:-1]} name_with_namespace:"{self.name_with_namespace}">'

f"{project_repr[:-1]} name_with_namespace:{self.name_with_namespace!r}>"

JohnVillalovos · 2022-04-29T16:37:13Z

On a side note I've encountered this error when trying to do a commit:
An unexpected error has occurred: CalledProcessError: command: ('/home/psycojoker/.cache/pre-commit/repox1_osb0o/node_env-default/bin/node', '/home/psycojoker/.cache/pre-commit/repox1_osb0o/node_env-default/bin/npm', 'install', '--dev', '--prod', '--ignore-prepublish', '--no-progress', '--no-save')
return code: 1
expected return code: 0
stdout: (none)
stderr:
    /home/psycojoker/.cache/pre-commit/repox1_osb0o/node_env-default/bin/node: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.28' not found (required by /home/psycojoker/.cache/pre-commit/repox1_osb0o/node_env-default/bin/node)
    
Check the log at /home/psycojoker/.cache/pre-commit/pre-commit.log
I have to admit that, while I totally understand the importance of linters and good commit messages, having a hard dependency on a specific version of nodejs and glibc just do to a commit on a full python feels a bit ... intense? 😅

So don't tell @nejch 😜 But I still don't use pre-commit myself. I run my tests manually for the most part and then push the PR. I let the Github CI tell me if I screwed up the commit message.

nejch

Thanks @Psycojoker for this, I really like the idea to make repr more human-readable.

What do you think about generalizing it a bit to have a more declarative approach on individual resources (project, group,..) and handling the __repr__ based on that in the RESTObject method, like we do with id using _id_attr now? Otherwise, we'll have to add a bunch more overrides if people want similar for other objects (or even GroupProject, UserProject.. etc).

For this, I'd introduce a _repr_attr on individual resources, and handle that centrally here:

python-gitlab/gitlab/base.py

Lines 160 to 164 in 882fe7a

    
           def __repr__(self) -> str: 
        
               if self._id_attr: 
        
                   return f"<{self.__class__.__name__} {self._id_attr}:{self.get_id()}>" 
        
               else: 
        
                   return f"<{self.__class__.__name__}>"

Just to illustrate this, here's a full list (I think) of objects, a lot of them would benefit from this feature. I don't want you to do this for all of them, but if you could try to add it for every type of *Project we have a good start to check it works. If it's too repetitive, we could introduce mixins for this at some point, or some other more reusable way if you have any ideas :) WDYT @Psycojoker @JohnVillalovos

Application
ApplicationAppearance
ApplicationSettings
AuditEvent
BroadcastMessage
CurrentUser
CurrentUserEmail
CurrentUserGPGKey
CurrentUserKey
CurrentUserStatus
DeployKey
DeployToken
Dockerfile
Event
Feature
GenericPackage
GeoNode
Gitignore
Gitlabciyml
Group
GroupAccessRequest
GroupAccessToken
GroupAuditEvent
GroupBadge
GroupBillableMember
GroupBillableMemberMembership
GroupBoard
GroupBoardList
GroupCluster
GroupCustomAttribute
GroupDeployToken
GroupDescendantGroup
GroupEpic
GroupEpicAwardEmoji
GroupEpicDiscussionNote
GroupEpicIssue
GroupEpicNote
GroupEpicNoteAwardEmoji
GroupEpicResourceLabelEvent
GroupExport
GroupHook
GroupImport
GroupIssue
GroupIssuesStatistics
GroupLabel
GroupMember
GroupMemberAll
GroupMergeRequest
GroupMilestone
GroupNotificationSettings
GroupPackage
GroupProject
GroupRunner
GroupSubgroup
GroupVariable
GroupWiki
Hook
Issue
IssuesStatistics
Key
LDAPGroup
License
List
MergeRequest
Namespace
NotificationSettings
Optional
PagesDomain
PersonalAccessToken
Project
ProjectAccessRequest
ProjectAccessToken
ProjectAdditionalStatistics
ProjectApproval
ProjectApprovalRule
ProjectArtifact
ProjectAudit
ProjectAuditEvent
ProjectBadge
ProjectBoard
ProjectBoardList
ProjectBranch
ProjectCluster
ProjectCommit
ProjectCommitComment
ProjectCommitDiscussion
ProjectCommitDiscussionNote
ProjectCommitStatus
ProjectCustomAttribute
ProjectDeployToken
ProjectDeployment
ProjectDeploymentMergeRequest
ProjectEnvironment
ProjectEvent
ProjectExport
ProjectFile
ProjectFork
ProjectHook
ProjectImport
ProjectIssue
ProjectIssueAwardEmoji
ProjectIssueDiscussion
ProjectIssueDiscussionNote
ProjectIssueLink
ProjectIssueNote
ProjectIssueNoteAwardEmoji
ProjectIssueResourceLabelEvent
ProjectIssueResourceMilestoneEvent
ProjectIssueResourceStateEvent
ProjectIssuesStatistics
ProjectJob
ProjectKey
ProjectLabel
ProjectMember
ProjectMemberAll
ProjectMergeRequest
ProjectMergeRequestApproval
ProjectMergeRequestApprovalRule
ProjectMergeRequestApprovalState
ProjectMergeRequestAwardEmoji
ProjectMergeRequestDiff
ProjectMergeRequestDiscussion
ProjectMergeRequestDiscussionNote
ProjectMergeRequestNote
ProjectMergeRequestNoteAwardEmoji
ProjectMergeRequestPipeline
ProjectMergeRequestResourceLabelEvent
ProjectMergeRequestResourceMilestoneEvent
ProjectMergeRequestResourceStateEvent
ProjectMergeTrain
ProjectMilestone
ProjectNote
ProjectNotificationSettings
ProjectPackage
ProjectPackageFile
ProjectPagesDomain
ProjectPipeline
ProjectPipelineBridge
ProjectPipelineJob
ProjectPipelineSchedule
ProjectPipelineScheduleVariable
ProjectPipelineTestReport
ProjectPipelineTestReportSummary
ProjectPipelineVariable
ProjectProtectedBranch
ProjectProtectedTag
ProjectPushRules
ProjectRegistryRepository
ProjectRegistryTag
ProjectRelease
ProjectReleaseLink
ProjectRemoteMirror
ProjectRunner
ProjectService
ProjectSnippet
ProjectSnippetAwardEmoji
ProjectSnippetDiscussion
ProjectSnippetDiscussionNote
ProjectSnippetNote
ProjectSnippetNoteAwardEmoji
ProjectTag
ProjectTrigger
ProjectUser
ProjectVariable
ProjectWiki
RepositoryMixin
Runner
RunnerJob
Snippet
StarredProject
Todo
Topic
User
UserActivities
UserCustomAttribute
UserEmail
UserEvent
UserGPGKey
UserImpersonationToken
UserKey
UserMembership
UserPersonalAccessToken
UserProject
UserStatus
Variable

nejch · 2022-04-30T08:14:19Z

On a side note I've encountered this error when trying to do a commit:
An unexpected error has occurred: CalledProcessError: command: ('/home/psycojoker/.cache/pre-commit/repox1_osb0o/node_env-default/bin/node', '/home/psycojoker/.cache/pre-commit/repox1_osb0o/node_env-default/bin/npm', 'install', '--dev', '--prod', '--ignore-prepublish', '--no-progress', '--no-save')
return code: 1
expected return code: 0
stdout: (none)
stderr:
    /home/psycojoker/.cache/pre-commit/repox1_osb0o/node_env-default/bin/node: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.28' not found (required by /home/psycojoker/.cache/pre-commit/repox1_osb0o/node_env-default/bin/node)
    
Check the log at /home/psycojoker/.cache/pre-commit/pre-commit.log
I have to admit that, while I totally understand the importance of linters and good commit messages, having a hard dependency on a specific version of nodejs and glibc just do to a commit on a full python feels a bit ... intense? sweat_smile
So don't tell @nejch stuck_out_tongue_winking_eye But I still don't use pre-commit myself. I run my tests manually for the most part and then push the PR. I let the Github CI tell me if I screwed up the commit message.

About pre-commit - sorry to hear that. Generally the idea of pre-commit is to handle all of its environments for any kind of tool regardless of language and avoid exactly the type of issue you have here. But looks like that comes with hiccups (pre-commit/pre-commit#2351). I'll change to commitizen based on your feedback which is python native, though it'll still be managed by pre-commit's env so we might get similar issues still.

We kind of do need pre-commit or something like that if we keep adding more linters and nitpicky rules though. Otherwise people will push a lot of failing code and it creates more noise for followers and extra effort, especially with new contributors where every push needs approval for CI to run.

The other option is that we calm down with the linting a bit and make things looser. But the commit messages at least are nice, as it makes our release process really smooth and we can bring out new versions much quicker if needed :)

nejch · 2022-04-30T16:26:59Z

I've started #1998 to address the pre-commit issue. We can also just merge this as is and work on refactoring after, just let us know @Psycojoker if you'd like to try yourself already. :)

nejch · 2022-05-07T19:04:40Z

Ok, so let's get this in to have the feature and I'll rework it based on my comment in a follow-up.

JohnVillalovos reviewed Apr 29, 2022

View reviewed changes

nejch requested changes Apr 30, 2022

View reviewed changes

nejch mentioned this pull request Apr 30, 2022

chore(ci): replace commitlint with commitizen #1998

Merged

nejch merged commit 82c9a07 into python-gitlab:main May 7, 2022

nejch mentioned this pull request May 7, 2022

feat: display human-readable attribute in repr() if present #2010

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(ux): display project.name_with_namespace on project repr #1996

feat(ux): display project.name_with_namespace on project repr #1996

Uh oh!

Psycojoker commented Apr 29, 2022

Uh oh!

JohnVillalovos commented Apr 29, 2022

Uh oh!

codecov-commenter commented Apr 29, 2022

Uh oh!

JohnVillalovos left a comment

Uh oh!

JohnVillalovos Apr 29, 2022

Uh oh!

JohnVillalovos commented Apr 29, 2022

Uh oh!

nejch left a comment

Uh oh!

nejch commented Apr 30, 2022

Uh oh!

nejch commented Apr 30, 2022

Uh oh!

nejch commented May 7, 2022

Uh oh!

Uh oh!

	f'{project_repr[:-1]} name_with_namespace:"{self.name_with_namespace}">'
	f"{project_repr[:-1]} name_with_namespace:{self.name_with_namespace!r}>"

	def __repr__(self) -> str:
	if self._id_attr:
	return f"<{self.__class__.__name__} {self._id_attr}:{self.get_id()}>"
	else:
	return f"<{self.__class__.__name__}>"

feat(ux): display project.name_with_namespace on project repr #1996

feat(ux): display project.name_with_namespace on project repr #1996

Uh oh!

Conversation

Psycojoker commented Apr 29, 2022

Uh oh!

JohnVillalovos commented Apr 29, 2022

Uh oh!

codecov-commenter commented Apr 29, 2022

Codecov Report

Uh oh!

JohnVillalovos left a comment

Choose a reason for hiding this comment

Uh oh!

JohnVillalovos Apr 29, 2022

Choose a reason for hiding this comment

Uh oh!

JohnVillalovos commented Apr 29, 2022

Uh oh!

nejch left a comment

Choose a reason for hiding this comment

Uh oh!

nejch commented Apr 30, 2022

Uh oh!

nejch commented Apr 30, 2022

Uh oh!

nejch commented May 7, 2022

Uh oh!

Uh oh!