Commit62a8f03

Liora Milbaum

committed

feat: Generation of Gitlab class with custom requests session

1 parent0ecf3bb commit62a8f03Copy full SHA for 62a8f03

File tree

+27

-1

lines changed

+27

-1

lines changed

Lines changed: 7 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -62,6 +62,13 @@ You can also use configuration files to create ``gitlab.Gitlab`` objects:
`62`	`62`
`63`	`63`	`gl= gitlab.Gitlab.from_config('somewhere', ['/tmp/gl.cfg'])`
`64`	`64`
	`65`	`+With custom session`
	`66`	`+`
	`67`	`+..code-block::python`
	`68`	`+`
	`69`	`+ gl= gitlab.Gitlab.from_config('somewhere', ['/tmp/gl.cfg'],session=custom_session)`
	`70`	`+`
	`71`	`+`
`65`	`72`	See the:ref:`cli_configuration` section for more information about
`66`	`73`	`configuration files.`
`67`	`74`

Lines changed: 8 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -232,14 +232,20 @@ def api_version(self) -> str:`
`232`	`232`
`233`	`233`	`@classmethod`
`234`	`234`	`deffrom_config(`
`235`		`-cls,gitlab_id:Optional[str]=None,config_files:Optional[List[str]]=None`
	`235`	`+cls,`
	`236`	`+gitlab_id:Optional[str]=None,`
	`237`	`+config_files:Optional[List[str]]=None,`
	`238`	`+**kwargs:Any,`
`236`	`239`	`)->"Gitlab":`
`237`	`240`	`"""Create a Gitlab connection from configuration files.`
`238`	`241`
`239`	`242`	`Args:`
`240`	`243`	`gitlab_id: ID of the configuration section.`
`241`	`244`	`config_files list[str]: List of paths to configuration files.`
`242`	`245`
	`246`	`+ kwargs:`
	`247`	`+ session requests.Session: Custom requests Session`
	`248`	`+`
`243`	`249`	`Returns:`
`244`	`250`	`A Gitlab connection.`
`245`	`251`
`@@ -264,6 +270,7 @@ def from_config(`
`264`	`270`	`order_by=config.order_by,`
`265`	`271`	`user_agent=config.user_agent,`
`266`	`272`	`retry_transient_errors=config.retry_transient_errors,`
	`273`	`+**kwargs,`
`267`	`274`	`)`
`268`	`275`
`269`	`276`	`@classmethod`

Lines changed: 12 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`importpytest`
	`2`	`+importrequests`
`2`	`3`
`3`	`4`	`importgitlab`
`4`	`5`
`@@ -19,10 +20,21 @@ def test_auth_from_config(gl, temp_dir):`
`19`	`20`	`test_gitlab=gitlab.Gitlab.from_config(`
`20`	`21`	`config_files=[temp_dir/"python-gitlab.cfg"]`
`21`	`22`	`)`
	`23`	`+`
`22`	`24`	`test_gitlab.auth()`
`23`	`25`	`assertisinstance(test_gitlab.user,gitlab.v4.objects.CurrentUser)`
`24`	`26`
`25`	`27`
	`28`	`+deftest_custom_session(gl,temp_dir):`
	`29`	`+"""Test custom session"""`
	`30`	`+`
	`31`	`+custom_session=requests.Session()`
	`32`	`+test_gitlab=gitlab.Gitlab.from_config(`
	`33`	`+config_files=[temp_dir/"python-gitlab.cfg"],session=custom_session`
	`34`	`+ )`
	`35`	`+asserttest_gitlab.session==custom_session`
	`36`	`+`
	`37`	`+`
`26`	`38`	`deftest_broadcast_messages(gl,get_all_kwargs):`
`27`	`39`	`msg=gl.broadcastmessages.create({"message":"this is the message"})`
`28`	`40`	`msg.color="#444444"`

Comments

(0)