Skip to content

Commit ffc535f

Browse files
JohnVillalovosJohnVillalovos
committed
docs: update docs to use gitlab.const for constants
Update the docs to use gitlab.const to access constants.
1 parent 4c6a669 commit ffc535f

File tree

7 files changed

+50
-50
lines changed

7 files changed

+50
-50
lines changed

‎docs/gl_objects/access_requests.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ Users can request access to groups and projects.
77
When access is granted the user should be given a numerical access level. The
88
following constants are provided to represent the access levels:
99

10-
* ``gitlab.GUEST_ACCESS``: ``10``
11-
* ``gitlab.REPORTER_ACCESS``: ``20``
12-
* ``gitlab.DEVELOPER_ACCESS``: ``30``
13-
* ``gitlab.MAINTAINER_ACCESS``: ``40``
14-
* ``gitlab.OWNER_ACCESS``: ``50``
10+
* ``gitlab.const.GUEST_ACCESS``: ``10``
11+
* ``gitlab.const.REPORTER_ACCESS``: ``20``
12+
* ``gitlab.const.DEVELOPER_ACCESS``: ``30``
13+
* ``gitlab.const.MAINTAINER_ACCESS``: ``40``
14+
* ``gitlab.const.OWNER_ACCESS``: ``50``
1515

1616
References
1717
----------
@@ -43,7 +43,7 @@ Create an access request::
4343
Approve an access request::
4444

4545
ar.approve() # defaults to DEVELOPER level
46-
ar.approve(access_level=gitlab.MAINTAINER_ACCESS) # explicitly set access level
46+
ar.approve(access_level=gitlab.const.MAINTAINER_ACCESS) # explicitly set access level
4747

4848
Deny (delete) an access request::
4949

‎docs/gl_objects/groups.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Remove a group::
8080

8181
Share/unshare the group with a group::
8282

83-
group.share(group2.id, gitlab.DEVELOPER_ACCESS)
83+
group.share(group2.id, gitlab.const.DEVELOPER_ACCESS)
8484
group.unshare(group2.id)
8585

8686
Import / Export
@@ -237,11 +237,11 @@ Group members
237237

238238
The following constants define the supported access levels:
239239

240-
* ``gitlab.GUEST_ACCESS = 10``
241-
* ``gitlab.REPORTER_ACCESS = 20``
242-
* ``gitlab.DEVELOPER_ACCESS = 30``
243-
* ``gitlab.MAINTAINER_ACCESS = 40``
244-
* ``gitlab.OWNER_ACCESS = 50``
240+
* ``gitlab.const.GUEST_ACCESS = 10``
241+
* ``gitlab.const.REPORTER_ACCESS = 20``
242+
* ``gitlab.const.DEVELOPER_ACCESS = 30``
243+
* ``gitlab.const.MAINTAINER_ACCESS = 40``
244+
* ``gitlab.const.OWNER_ACCESS = 50``
245245

246246
Reference
247247
---------
@@ -284,11 +284,11 @@ Get a member of a group, including members inherited through ancestor groups::
284284
Add a member to the group::
285285

286286
member = group.members.create({'user_id': user_id,
287-
'access_level': gitlab.GUEST_ACCESS})
287+
'access_level': gitlab.const.GUEST_ACCESS})
288288

289289
Update a member (change the access level)::
290290

291-
member.access_level = gitlab.DEVELOPER_ACCESS
291+
member.access_level = gitlab.const.DEVELOPER_ACCESS
292292
member.save()
293293

294294
Remove a member from the group::
@@ -316,7 +316,7 @@ LDAP group links
316316

317317
Add an LDAP group link to an existing GitLab group::
318318

319-
group.add_ldap_group_link(ldap_group_cn, gitlab.DEVELOPER_ACCESS, 'ldapmain')
319+
group.add_ldap_group_link(ldap_group_cn, gitlab.const.DEVELOPER_ACCESS, 'ldapmain')
320320

321321
Remove a link::
322322

‎docs/gl_objects/notifications.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ Notification settings
55
You can define notification settings globally, for groups and for projects.
66
Valid levels are defined as constants:
77

8-
* ``gitlab.NOTIFICATION_LEVEL_DISABLED``
9-
* ``gitlab.NOTIFICATION_LEVEL_PARTICIPATING``
10-
* ``gitlab.NOTIFICATION_LEVEL_WATCH``
11-
* ``gitlab.NOTIFICATION_LEVEL_GLOBAL``
12-
* ``gitlab.NOTIFICATION_LEVEL_MENTION``
13-
* ``gitlab.NOTIFICATION_LEVEL_CUSTOM``
8+
* ``gitlab.const.NOTIFICATION_LEVEL_DISABLED``
9+
* ``gitlab.const.NOTIFICATION_LEVEL_PARTICIPATING``
10+
* ``gitlab.const.NOTIFICATION_LEVEL_WATCH``
11+
* ``gitlab.const.NOTIFICATION_LEVEL_GLOBAL``
12+
* ``gitlab.const.NOTIFICATION_LEVEL_MENTION``
13+
* ``gitlab.const.NOTIFICATION_LEVEL_CUSTOM``
1414

1515
You get access to fine-grained settings if you use the
1616
``NOTIFICATION_LEVEL_CUSTOM`` level.
@@ -47,10 +47,10 @@ Get the notifications settings::
4747
Update the notifications settings::
4848

4949
# use a predefined level
50-
settings.level = gitlab.NOTIFICATION_LEVEL_WATCH
50+
settings.level = gitlab.const.NOTIFICATION_LEVEL_WATCH
5151

5252
# create a custom setup
53-
settings.level = gitlab.NOTIFICATION_LEVEL_CUSTOM
53+
settings.level = gitlab.const.NOTIFICATION_LEVEL_CUSTOM
5454
settings.save() # will create additional attributes, but not mandatory
5555

5656
settings.new_merge_request = True

‎docs/gl_objects/projects.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -439,9 +439,9 @@ Project snippets
439439

440440
The snippet visibility can be defined using the following constants:
441441

442-
* ``gitlab.VISIBILITY_PRIVATE``
443-
* ``gitlab.VISIBILITY_INTERNAL``
444-
* ``gitlab.VISIBILITY_PUBLIC``
442+
* ``gitlab.const.VISIBILITY_PRIVATE``
443+
* ``gitlab.const.VISIBILITY_INTERNAL``
444+
* ``gitlab.const.VISIBILITY_PUBLIC``
445445

446446
Reference
447447
---------
@@ -480,7 +480,7 @@ Create a snippet::
480480
'file_name': 'foo.py',
481481
'code': 'import gitlab',
482482
'visibility_level':
483-
gitlab.VISIBILITY_PRIVATE})
483+
gitlab.const.VISIBILITY_PRIVATE})
484484

485485
Update a snippet::
486486

@@ -546,11 +546,11 @@ Get a member of a project, including members inherited through ancestor groups::
546546
Add a project member::
547547

548548
member = project.members.create({'user_id': user.id, 'access_level':
549-
gitlab.DEVELOPER_ACCESS})
549+
gitlab.const.DEVELOPER_ACCESS})
550550

551551
Modify a project member (change the access level)::
552552

553-
member.access_level = gitlab.MAINTAINER_ACCESS
553+
member.access_level = gitlab.const.MAINTAINER_ACCESS
554554
member.save()
555555

556556
Remove a member from the project team::
@@ -561,7 +561,7 @@ Remove a member from the project team::
561561

562562
Share/unshare the project with a group::
563563

564-
project.share(group.id, gitlab.DEVELOPER_ACCESS)
564+
project.share(group.id, gitlab.const.DEVELOPER_ACCESS)
565565
project.unshare(group.id)
566566

567567
Project hooks

‎docs/gl_objects/protected_branches.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ Create a protected branch::
3131

3232
p_branch = project.protectedbranches.create({
3333
'name': '*-stable',
34-
'merge_access_level': gitlab.DEVELOPER_ACCESS,
35-
'push_access_level': gitlab.MAINTAINER_ACCESS
34+
'merge_access_level': gitlab.const.DEVELOPER_ACCESS,
35+
'push_access_level': gitlab.const.MAINTAINER_ACCESS
3636
})
3737

3838
Create a protected branch with more granular access control::
@@ -41,7 +41,7 @@ Create a protected branch with more granular access control::
4141
'name': '*-stable',
4242
'allowed_to_push': [{"user_id": 99}, {"user_id": 98}],
4343
'allowed_to_merge': [{"group_id": 653}],
44-
'allowed_to_unprotect': [{"access_level": gitlab.MAINTAINER_ACCESS}]
44+
'allowed_to_unprotect': [{"access_level": gitlab.const.MAINTAINER_ACCESS}]
4545
})
4646

4747
Delete a protected branch::

‎docs/gl_objects/search.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,24 @@ string. The following constants are provided to represent the possible scopes:
99

1010
* Shared scopes (global, group and project):
1111

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``
12+
+ ``gitlab.const.SEARCH_SCOPE_PROJECTS``: ``projects``
13+
+ ``gitlab.const.SEARCH_SCOPE_ISSUES``: ``issues``
14+
+ ``gitlab.const.SEARCH_SCOPE_MERGE_REQUESTS``: ``merge_requests``
15+
+ ``gitlab.const.SEARCH_SCOPE_MILESTONES``: ``milestones``
16+
+ ``gitlab.const.SEARCH_SCOPE_WIKI_BLOBS``: ``wiki_blobs``
17+
+ ``gitlab.const.SEARCH_SCOPE_COMMITS``: ``commits``
18+
+ ``gitlab.const.SEARCH_SCOPE_BLOBS``: ``blobs``
19+
+ ``gitlab.const.SEARCH_SCOPE_USERS``: ``users``
2020

2121

2222
* specific global scope:
2323

24-
+ ``gitlab.SEARCH_SCOPE_GLOBAL_SNIPPET_TITLES``: ``snippet_titles``
24+
+ ``gitlab.const.SEARCH_SCOPE_GLOBAL_SNIPPET_TITLES``: ``snippet_titles``
2525

2626

2727
* specific project scope:
2828

29-
+ ``gitlab.SEARCH_SCOPE_PROJECT_NOTES``: ``notes``
29+
+ ``gitlab.const.SEARCH_SCOPE_PROJECT_NOTES``: ``notes``
3030

3131

3232
Reference
@@ -46,30 +46,30 @@ Examples
4646
Search for issues matching a specific string::
4747

4848
# global search
49-
gl.search(gitlab.SEARCH_SCOPE_ISSUES, 'regression')
49+
gl.search(gitlab.const.SEARCH_SCOPE_ISSUES, 'regression')
5050

5151
# group search
5252
group = gl.groups.get('mygroup')
53-
group.search(gitlab.SEARCH_SCOPE_ISSUES, 'regression')
53+
group.search(gitlab.const.SEARCH_SCOPE_ISSUES, 'regression')
5454

5555
# project search
5656
project = gl.projects.get('myproject')
57-
project.search(gitlab.SEARCH_SCOPE_ISSUES, 'regression')
57+
project.search(gitlab.const.SEARCH_SCOPE_ISSUES, 'regression')
5858

5959
The ``search()`` methods implement the pagination support::
6060

6161
# get lists of 10 items, and start at page 2
62-
gl.search(gitlab.SEARCH_SCOPE_ISSUES, search_str, page=2, per_page=10)
62+
gl.search(gitlab.const.SEARCH_SCOPE_ISSUES, search_str, page=2, per_page=10)
6363

6464
# get a generator that will automatically make required API calls for
6565
# pagination
66-
for item in gl.search(gitlab.SEARCH_SCOPE_ISSUES, search_str, as_list=False):
66+
for item in gl.search(gitlab.const.SEARCH_SCOPE_ISSUES, search_str, as_list=False):
6767
do_something(item)
6868

6969
The search API doesn't return objects, but dicts. If you need to act on
7070
objects, you need to create them explicitly::
7171

72-
for item in gl.search(gitlab.SEARCH_SCOPE_ISSUES, search_str, as_list=False):
72+
for item in gl.search(gitlab.const.SEARCH_SCOPE_ISSUES, search_str, as_list=False):
7373
issue_project = gl.projects.get(item['project_id'], lazy=True)
7474
issue = issue_project.issues.get(item['iid'])
7575
issue.state = 'closed'

‎docs/gl_objects/snippets.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Create a snippet::
4444

4545
Update the snippet attributes::
4646

47-
snippet.visibility_level = gitlab.VISIBILITY_PUBLIC
47+
snippet.visibility_level = gitlab.const.VISIBILITY_PUBLIC
4848
snippet.save()
4949

5050
To update a snippet code you need to create a ``ProjectSnippet`` object::

0 commit comments

Comments
 (0)