Skip to content

Commit fe7d19d

Browse files
nejchJohnVillalovos
nejch
authored and
JohnVillalovos
committed
chore: apply suggestions
1 parent f731707 commit fe7d19d

File tree

5 files changed

+27
-18
lines changed

5 files changed

+27
-18
lines changed

‎docs/gl_objects/issues.rst

+16-12
Original file line numberDiff line numberDiff line change
@@ -236,40 +236,44 @@ Reference
236236

237237
+ :class:`gitlab.v4.objects.IssuesStatistics`
238238
+ :class:`gitlab.v4.objects.IssuesStatisticsManager`
239-
+ :attr:`gitlab.issuesstatistics`
239+
+ :attr:`gitlab.issues_statistics`
240240
+ :class:`gitlab.v4.objects.GroupIssuesStatistics`
241241
+ :class:`gitlab.v4.objects.GroupIssuesStatisticsManager`
242-
+ :attr:`gitlab.v4.objects.Group.issuesstatistics`
242+
+ :attr:`gitlab.v4.objects.Group.issues_statistics`
243243
+ :class:`gitlab.v4.objects.ProjectIssuesStatistics`
244244
+ :class:`gitlab.v4.objects.ProjectIssuesStatisticsManager`
245-
+ :attr:`gitlab.v4.objects.Project.issuesstatistics`
245+
+ :attr:`gitlab.v4.objects.Project.issues_statistics`
246246

247247

248248
* GitLab API: https://docs.gitlab.com/ce/api/issues_statistics.htm
249249

250250
Examples
251251
---------
252252

253+
Get statistics of all issues created by the current user::
254+
255+
statistics = gl.issues_statistics.get()
256+
253257
Get statistics of all issues the user has access to::
254258

255-
statistics = gl.issuesstatistics.get()
259+
statistics = gl.issues_statistics.get(scope='all')
256260

257-
Get statistics of issues for the user with ``foobar`` in ``title`` and ``description``::
261+
Get statistics of issues for the user with ``foobar`` in the ``title`` or the ``description``::
258262

259-
statistics = gl.issuesstatistics.get(search='foobar')
263+
statistics = gl.issues_statistics.get(search='foobar')
260264

261265
Get statistics of all issues in a group::
262266

263-
statistics = group.issuesstatistics.get()
267+
statistics = group.issues_statistics.get()
264268

265-
Get statistics of issues in a group with ``foobar`` in ``title`` and ``description``::
269+
Get statistics of issues in a group with ``foobar`` in the ``title`` or the ``description``::
266270

267-
statistics = group.issuesstatistics.get(search='foobar')
271+
statistics = group.issues_statistics.get(search='foobar')
268272

269273
Get statistics of all issues in a project::
270274

271-
statistics = project.issuesstatistics.get()
275+
statistics = project.issues_statistics.get()
272276

273-
Get statistics of issues in a project with ``foobar`` in ``title`` and ``description``::
277+
Get statistics of issues in a project with ``foobar`` in the ``title`` or the ``description``::
274278

275-
statistics = project.issuesstatistics.get(search='foobar')
279+
statistics = project.issues_statistics.get(search='foobar')

‎gitlab/client.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ def __init__(
118118
self.groups = objects.GroupManager(self)
119119
self.hooks = objects.HookManager(self)
120120
self.issues = objects.IssueManager(self)
121-
self.issuesstatistics = objects.IssuesStatisticsManager(self)
121+
self.issues_statistics = objects.IssuesStatisticsManager(self)
122122
self.ldapgroups = objects.LDAPGroupManager(self)
123123
self.licenses = objects.LicenseManager(self)
124124
self.namespaces = objects.NamespaceManager(self)

‎gitlab/v4/objects/groups.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject):
5353
("epics", "GroupEpicManager"),
5454
("imports", "GroupImportManager"),
5555
("issues", "GroupIssueManager"),
56-
("issuesstatistics", "GroupIssuesStatisticsManager"),
56+
("issues_statistics", "GroupIssuesStatisticsManager"),
5757
("labels", "GroupLabelManager"),
5858
("members", "GroupMemberManager"),
5959
("members_all", "GroupMemberAllManager"),

‎gitlab/v4/objects/projects.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,8 @@ class Project(RefreshMixin, SaveMixin, ObjectDeleteMixin, RepositoryMixin, RESTO
155155
("wikis", "ProjectWikiManager"),
156156
("clusters", "ProjectClusterManager"),
157157
("additionalstatistics", "ProjectAdditionalStatisticsManager"),
158-
("issuesstatistics", "ProjectIssuesStatisticsManager"),
158+
("issues_statistics", "ProjectIssuesStatisticsManager"),
159+
("issuesstatistics", "ProjectIssuesStatisticsManager"), # Deprecated
159160
("deploytokens", "ProjectDeployTokenManager"),
160161
)
161162

‎tests/unit/objects/test_issues.py

+7-3
Original file line numberDiff line numberDiff line change
@@ -71,18 +71,22 @@ def test_get_issue(gl, resp_get_issue):
7171

7272

7373
def test_get_issues_statistics(gl, resp_issue_statistics):
74-
statistics = gl.issuesstatistics.get()
74+
statistics = gl.issues_statistics.get()
7575
assert isinstance(statistics, IssuesStatistics)
7676
assert statistics.statistics["counts"]["all"] == 20
7777

7878

7979
def test_get_group_issues_statistics(group, resp_issue_statistics):
80-
statistics = group.issuesstatistics.get()
80+
statistics = group.issues_statistics.get()
8181
assert isinstance(statistics, GroupIssuesStatistics)
8282
assert statistics.statistics["counts"]["all"] == 20
8383

8484

8585
def test_get_project_issues_statistics(project, resp_issue_statistics):
86-
statistics = project.issuesstatistics.get()
86+
statistics = project.issues_statistics.get()
8787
assert isinstance(statistics, ProjectIssuesStatistics)
8888
assert statistics.statistics["counts"]["all"] == 20
89+
90+
# Deprecated attribute
91+
deprecated = project.issuesstatistics.get()
92+
assert deprecated.statistics == statistics.statistics

0 commit comments

Comments
 (0)