Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit16fc048

Browse files
chore: simplified search scope constants
1 parent650b65c commit16fc048

File tree

2 files changed

+29
-65
lines changed

2 files changed

+29
-65
lines changed

‎docs/gl_objects/search.rst‎

Lines changed: 18 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -7,41 +7,26 @@ Searches are based on a scope (issues, merge requests, and so on) and a search
77
string. The following constants are provided to represent the possible scopes:
88

99

10-
*global scopes:
10+
*Shared scopes (global, group and project):
1111

12-
+ ``gitlab.SEARCH_SCOPE_GLOBAL_PROJECTS``: ``projects``
13-
+ ``gitlab.SEARCH_SCOPE_GLOBAL_ISSUES``: ``issues``
14-
+ ``gitlab.SEARCH_SCOPE_GLOBAL_MERGE_REQUESTS``: ``merge_requests``
15-
+ ``gitlab.SEARCH_SCOPE_GLOBAL_MILESTONES``: ``milestones``
16-
+ ``gitlab.SEARCH_SCOPE_GLOBAL_SNIPPET_TITLES``: ``snippet_titles``
17-
+ ``gitlab.SEARCH_SCOPE_GLOBAL_WIKI_BLOBS``: ``wiki_blobs``
18-
+ ``gitlab.SEARCH_SCOPE_GLOBAL_COMMITS``: ``commits``
19-
+ ``gitlab.SEARCH_SCOPE_GLOBAL_BLOBS``: ``blobs``
20-
+ ``gitlab.SEARCH_SCOPE_GLOBAL_USERS``: ``users``
12+
+ ``gitlab.SEARCH_SCOPE_PROJECTS``: ``projects``
13+
+ ``gitlab.SEARCH_SCOPE_ISSUES``: ``issues``
14+
+ ``gitlab.SEARCH_SCOPE_MERGE_REQUESTS``: ``merge_requests``
15+
+ ``gitlab.SEARCH_SCOPE_MILESTONES``: ``milestones``
16+
+ ``gitlab.SEARCH_SCOPE_WIKI_BLOBS``: ``wiki_blobs``
17+
+ ``gitlab.SEARCH_SCOPE_COMMITS``: ``commits``
18+
+ ``gitlab.SEARCH_SCOPE_BLOBS``: ``blobs``
19+
+ ``gitlab.SEARCH_SCOPE_USERS``: ``users``
2120

2221

23-
*group scopes:
22+
*specific global scope:
2423

25-
+ ``gitlab.SEARCH_SCOPE_GROUP_PROJECTS``: ``projects``
26-
+ ``gitlab.SEARCH_SCOPE_GROUP_ISSUES``: ``issues``
27-
+ ``gitlab.SEARCH_SCOPE_GROUP_MERGE_REQUESTS``: ``merge_requests``
28-
+ ``gitlab.SEARCH_SCOPE_GROUP_MILESTONES``: ``milestones``
29-
+ ``gitlab.SEARCH_SCOPE_GROUP_WIKI_BLOBS``: ``wiki_blobs``
30-
+ ``gitlab.SEARCH_SCOPE_GROUP_COMMITS``: ``commits``
31-
+ ``gitlab.SEARCH_SCOPE_GROUP_BLOBS``: ``blobs``
32-
+ ``gitlab.SEARCH_SCOPE_GROUP_USERS``: ``users``
24+
+ ``gitlab.SEARCH_SCOPE_GLOBAL_SNIPPET_TITLES``: ``snippet_titles``
3325

3426

35-
* projectscopes:
27+
*specificprojectscope:
3628

37-
+ ``gitlab.SEARCH_SCOPE_PROJECT_ISSUES``: ``issues``
38-
+ ``gitlab.SEARCH_SCOPE_PROJECT_MERGE_REQUESTS``: ``merge_requests``
39-
+ ``gitlab.SEARCH_SCOPE_PROJECT_MILESTONES``: ``milestones``
4029
+ ``gitlab.SEARCH_SCOPE_PROJECT_NOTES``: ``notes``
41-
+ ``gitlab.SEARCH_SCOPE_PROJECT_WIKI_BLOBS``: ``wiki_blobs``
42-
+ ``gitlab.SEARCH_SCOPE_PROJECT_COMMITS``: ``commits``
43-
+ ``gitlab.SEARCH_SCOPE_PROJECT_BLOBS``: ``blobs``
44-
+ ``gitlab.SEARCH_SCOPE_PROJECT_USERS``: ``users``
4530

4631

4732
Reference
@@ -61,30 +46,30 @@ Examples
6146
Search for issues matching a specific string::
6247

6348
# global search
64-
gl.search(gitlab.SEARCH_SCOPE_GLOBAL_ISSUES, 'regression')
49+
gl.search(gitlab.SEARCH_SCOPE_ISSUES, 'regression')
6550

6651
# group search
6752
group = gl.groups.get('mygroup')
68-
group.search(gitlab.SEARCH_SCOPE_GROUP_ISSUES, 'regression')
53+
group.search(gitlab.SEARCH_SCOPE_ISSUES, 'regression')
6954

7055
# project search
7156
project = gl.projects.get('myproject')
72-
project.search(gitlab.SEARCH_SCOPE_PROJECT_ISSUES, 'regression')
57+
project.search(gitlab.SEARCH_SCOPE_ISSUES, 'regression')
7358

7459
The ``search()`` methods implement the pagination support::
7560

7661
# get lists of 10 items, and start at page 2
77-
gl.search(gitlab.SEARCH_SCOPE_GLOBAL_ISSUES, search_str, page=2, per_page=10)
62+
gl.search(gitlab.SEARCH_SCOPE_ISSUES, search_str, page=2, per_page=10)
7863

7964
# get a generator that will automatically make required API calls for
8065
# pagination
81-
for item in gl.search(gitlab.SEARCH_SCOPE_GLOBAL_ISSUES, search_str, as_list=False):
66+
for item in gl.search(gitlab.SEARCH_SCOPE_ISSUES, search_str, as_list=False):
8267
do_something(item)
8368

8469
The search API doesn't return objects, but dicts. If you need to act on
8570
objects, you need to create them explicitly::
8671

87-
for item in gl.search(gitlab.SEARCH_SCOPE_GLOBAL_ISSUES, search_str, as_list=False):
72+
for item in gl.search(gitlab.SEARCH_SCOPE_ISSUES, search_str, as_list=False):
8873
issue_project = gl.projects.get(item['project_id'], lazy=True)
8974
issue = issue_project.issues.get(item['iid'])
9075
issue.state = 'closed'

‎gitlab/const.py‎

Lines changed: 11 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -35,39 +35,18 @@
3535
NOTIFICATION_LEVEL_CUSTOM="custom"
3636

3737
# Search scopes
38-
_SEARCH_SCOPE_PROJECTS="projects"
39-
_SEARCH_SCOPE_ISSUES="issues"
40-
_SEARCH_SCOPE_MERGE_REQUESTS="merge_requests"
41-
_SEARCH_SCOPE_MILESTONES="milestones"
42-
_SEARCH_SCOPE_WIKI_BLOBS="wiki_blobs"
43-
_SEARCH_SCOPE_COMMITS="commits"
44-
_SEARCH_SCOPE_BLOBS="blobs"
45-
_SEARCH_SCOPE_USERS="users"
38+
# all scopes (global, group and project)
39+
SEARCH_SCOPE_PROJECTS="projects"
40+
SEARCH_SCOPE_ISSUES="issues"
41+
SEARCH_SCOPE_MERGE_REQUESTS="merge_requests"
42+
SEARCH_SCOPE_MILESTONES="milestones"
43+
SEARCH_SCOPE_WIKI_BLOBS="wiki_blobs"
44+
SEARCH_SCOPE_COMMITS="commits"
45+
SEARCH_SCOPE_BLOBS="blobs"
46+
SEARCH_SCOPE_USERS="users"
4647

47-
SEARCH_SCOPE_GLOBAL_PROJECTS=_SEARCH_SCOPE_PROJECTS
48-
SEARCH_SCOPE_GLOBAL_ISSUES=_SEARCH_SCOPE_ISSUES
49-
SEARCH_SCOPE_GLOBAL_MERGE_REQUESTS=_SEARCH_SCOPE_MERGE_REQUESTS
50-
SEARCH_SCOPE_GLOBAL_MILESTONES=_SEARCH_SCOPE_MILESTONES
48+
# specific global scope
5149
SEARCH_SCOPE_GLOBAL_SNIPPET_TITLES="snippet_titles"
52-
SEARCH_SCOPE_GLOBAL_WIKI_BLOBS=_SEARCH_SCOPE_WIKI_BLOBS
53-
SEARCH_SCOPE_GLOBAL_COMMITS=_SEARCH_SCOPE_COMMITS
54-
SEARCH_SCOPE_GLOBAL_BLOBS=_SEARCH_SCOPE_BLOBS
55-
SEARCH_SCOPE_GLOBAL_USERS=_SEARCH_SCOPE_USERS
5650

57-
SEARCH_SCOPE_GROUP_PROJECTS=_SEARCH_SCOPE_PROJECTS
58-
SEARCH_SCOPE_GROUP_ISSUES=_SEARCH_SCOPE_ISSUES
59-
SEARCH_SCOPE_GROUP_MERGE_REQUESTS=_SEARCH_SCOPE_MERGE_REQUESTS
60-
SEARCH_SCOPE_GROUP_MILESTONES=_SEARCH_SCOPE_MILESTONES
61-
SEARCH_SCOPE_GROUP_WIKI_BLOBS=_SEARCH_SCOPE_WIKI_BLOBS
62-
SEARCH_SCOPE_GROUP_COMMITS=_SEARCH_SCOPE_COMMITS
63-
SEARCH_SCOPE_GROUP_BLOBS=_SEARCH_SCOPE_BLOBS
64-
SEARCH_SCOPE_GROUP_USERS=_SEARCH_SCOPE_USERS
65-
66-
SEARCH_SCOPE_PROJECT_ISSUES=_SEARCH_SCOPE_ISSUES
67-
SEARCH_SCOPE_PROJECT_MERGE_REQUESTS=_SEARCH_SCOPE_MERGE_REQUESTS
68-
SEARCH_SCOPE_PROJECT_MILESTONES=_SEARCH_SCOPE_MILESTONES
51+
# specific project scope
6952
SEARCH_SCOPE_PROJECT_NOTES="notes"
70-
SEARCH_SCOPE_PROJECT_WIKI_BLOBS=_SEARCH_SCOPE_WIKI_BLOBS
71-
SEARCH_SCOPE_PROJECT_COMMITS=_SEARCH_SCOPE_COMMITS
72-
SEARCH_SCOPE_PROJECT_BLOBS=_SEARCH_SCOPE_BLOBS
73-
SEARCH_SCOPE_PROJECT_USERS=_SEARCH_SCOPE_USERS

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp