GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — chore: simplified search scope constants · python-gitlab/python-gitlab@16fc048

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

docs/gl_objects
- search.rst
gitlab
- const.py

Expand file treeCollapse file tree

Open diff view settings

Collapse file

`‎docs/gl_objects/search.rst‎`

Copy file name to clipboardExpand all lines: docs/gl_objects/search.rst

+18-33Lines changed: 18 additions & 33 deletions

Display the source diff
Display the rich diff

Original file line number	Diff line number	Diff line change
`@@ -7,41 +7,26 @@ Searches are based on a scope (issues, merge requests, and so on) and a search`
`7`	`7`	`string. The following constants are provided to represent the possible scopes:`
`8`	`8`
`9`	`9`
`10`		`-* global scopes:`
	`10`	`+* Shared scopes (global, group and project):`
`11`	`11`
`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``
`21`	`20`
`22`	`21`
`23`		`-* group scopes:`
	`22`	`+* specific global scope:`
`24`	`23`
`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``
`33`	`25`
`34`	`26`
`35`		`-* project scopes:`
	`27`	`+* specific project scope:`
`36`	`28`
`37`		- + ``gitlab.SEARCH_SCOPE_PROJECT_ISSUES``: ``issues``
`38`		- + ``gitlab.SEARCH_SCOPE_PROJECT_MERGE_REQUESTS``: ``merge_requests``
`39`		- + ``gitlab.SEARCH_SCOPE_PROJECT_MILESTONES``: ``milestones``
`40`	`29`	+ ``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``
`45`	`30`
`46`	`31`
`47`	`32`	`Reference`
`@@ -61,30 +46,30 @@ Examples`
`61`	`46`	`Search for issues matching a specific string::`
`62`	`47`
`63`	`48`	`# global search`
`64`		`- gl.search(gitlab.SEARCH_SCOPE_GLOBAL_ISSUES, 'regression')`
	`49`	`+ gl.search(gitlab.SEARCH_SCOPE_ISSUES, 'regression')`
`65`	`50`
`66`	`51`	`# group search`
`67`	`52`	`group = gl.groups.get('mygroup')`
`68`		`- group.search(gitlab.SEARCH_SCOPE_GROUP_ISSUES, 'regression')`
	`53`	`+ group.search(gitlab.SEARCH_SCOPE_ISSUES, 'regression')`
`69`	`54`
`70`	`55`	`# project search`
`71`	`56`	`project = gl.projects.get('myproject')`
`72`		`- project.search(gitlab.SEARCH_SCOPE_PROJECT_ISSUES, 'regression')`
	`57`	`+ project.search(gitlab.SEARCH_SCOPE_ISSUES, 'regression')`
`73`	`58`
`74`	`59`	The ``search()`` methods implement the pagination support::
`75`	`60`
`76`	`61`	`# 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)`
`78`	`63`
`79`	`64`	`# get a generator that will automatically make required API calls for`
`80`	`65`	`# 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):`
`82`	`67`	`do_something(item)`
`83`	`68`
`84`	`69`	`The search API doesn't return objects, but dicts. If you need to act on`
`85`	`70`	`objects, you need to create them explicitly::`
`86`	`71`
`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):`
`88`	`73`	`issue_project = gl.projects.get(item['project_id'], lazy=True)`
`89`	`74`	`issue = issue_project.issues.get(item['iid'])`
`90`	`75`	`issue.state = 'closed'`

Collapse file

`‎gitlab/const.py‎`

Copy file name to clipboardExpand all lines: gitlab/const.py

+11-32Lines changed: 11 additions & 32 deletions

Original file line number	Diff line number	Diff line change
`@@ -35,39 +35,18 @@`
`35`	`35`	`NOTIFICATION_LEVEL_CUSTOM = "custom"`
`36`	`36`
`37`	`37`	`# 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"`
`46`	`47`
`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`
`51`	`49`	`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`
`56`	`50`
`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`
`69`	`52`	`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 (0)

You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.