Commit4882cb2

authored and

committed

feat(namespaces): add support for namespace existence API

1 parent1ecbc7c commit4882cb2Copy full SHA for 4882cb2

File tree

+49

-4

lines changed

+49

-4

lines changed

Lines changed: 12 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -23,3 +23,15 @@ List namespaces::`
`23`	`23`	`Search namespaces::`
`24`	`24`
`25`	`25`	`namespaces = gl.namespaces.list(search='foo')`
	`26`	`+`
	`27`	`+Get a namespace by ID or path::`
	`28`	`+`
	`29`	`+ namespace = gl.namespaces.get("my-namespace")`
	`30`	`+`
	`31`	`+Get existence of a namespace by path::`
	`32`	`+`
	`33`	`+ namespace = gl.namespaces.exists("new-namespace")`
	`34`	`+`
	`35`	`+ if namespace.exists:`
	`36`	`+ # get suggestions of namespaces that don't already exist`
	`37`	`+ print(namespace.suggests)`

Lines changed: 26 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,10 @@`
`1`		`-fromtypingimportAny,cast,Union`
	`1`	`+fromtypingimportAny,cast,TYPE_CHECKING,Union`
`2`	`2`
	`3`	`+fromgitlabimportcli`
	`4`	`+fromgitlabimportexceptionsasexc`
`3`	`5`	`fromgitlab.baseimportRESTManager,RESTObject`
`4`	`6`	`fromgitlab.mixinsimportRetrieveMixin`
	`7`	`+fromgitlab.utilsimportEncodedId`
`5`	`8`
`6`	`9`	`__all__= [`
`7`	`10`	`"Namespace",`
`@@ -20,3 +23,25 @@ class NamespaceManager(RetrieveMixin, RESTManager):`
`20`	`23`
`21`	`24`	`defget(self,id:Union[str,int],lazy:bool=False,**kwargs:Any)->Namespace:`
`22`	`25`	`returncast(Namespace,super().get(id=id,lazy=lazy,**kwargs))`
	`26`	`+`
	`27`	`+@cli.register_custom_action("NamespaceManager", ("namespace","parent_id"))`
	`28`	`+@exc.on_http_error(exc.GitlabGetError)`
	`29`	`+defexists(self,namespace:str,**kwargs:Any)->Namespace:`
	`30`	`+"""Get existence of a namespace by path.`
	`31`	`+`
	`32`	`+ Args:`
	`33`	`+ namespace: The path to the namespace.`
	`34`	`+ **kwargs: Extra options to send to the server (e.g. sudo)`
	`35`	`+`
	`36`	`+ Raises:`
	`37`	`+ GitlabAuthenticationError: If authentication is not correct`
	`38`	`+ GitlabGetError: If the server failed to perform the request`
	`39`	`+`
	`40`	`+ Returns:`
	`41`	`+ Data on namespace existence returned from the server.`
	`42`	`+ """`
	`43`	`+path=f"{self.path}/{EncodedId(namespace)}/exists"`
	`44`	`+server_data=self.gitlab.http_get(path,**kwargs)`
	`45`	`+ifTYPE_CHECKING:`
	`46`	`+assertisinstance(server_data,dict)`
	`47`	`+returnself._obj_cls(self,server_data)`

Lines changed: 11 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -126,12 +126,20 @@ def test_hooks(gl):`
`126`	`126`
`127`	`127`
`128`	`128`	`deftest_namespaces(gl,get_all_kwargs):`
`129`		`-namespace=gl.namespaces.list(**get_all_kwargs)`
`130`		`-assertnamespace`
	`129`	`+current_user=gl.user.username`
`131`	`130`
`132`		`-namespace=gl.namespaces.list(search="root",**get_all_kwargs)[0]`
	`131`	`+namespaces=gl.namespaces.list(**get_all_kwargs)`
	`132`	`+assertnamespaces`
	`133`	`+`
	`134`	`+namespaces=gl.namespaces.list(search=current_user,**get_all_kwargs)`
	`135`	`+assertnamespaces[0].kind=="user"`
	`136`	`+`
	`137`	`+namespace=gl.namespaces.get(current_user)`
`133`	`138`	`assertnamespace.kind=="user"`
`134`	`139`
	`140`	`+namespace=gl.namespaces.exists(current_user)`
	`141`	`+assertnamespace.exists`
	`142`	`+`
`135`	`143`
`136`	`144`	`deftest_notification_settings(gl):`
`137`	`145`	`settings=gl.notificationsettings.get()`

Comments

(0)