Commit529f1fa

JohnVillalovos

authored and

nejch

committed

fix: user.warn() to show correct filename of issue

Previously would only go to the 2nd level of the stack for determiningthe offending filename and line number. When it should be showing thefirst filename outside of the python-gitlab source code. As we want itto show the warning for the user of the libraries code.Update test to show it works as expected.

1 parente11d889 commit529f1faCopy full SHA for 529f1fa

File tree

3 files changed

-2

lines changed

gitlab
- utils.py
tests
- functional/api
  - test_gitlab.py
- unit
  - test_gitlab_http_methods.py

3 files changed

-2

lines changed

`‎gitlab/utils.py`

Lines changed: 1 addition & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -191,8 +191,7 @@ def warn(`
`191`	`191`	`stacklevel=1`
`192`	`192`	`warning_from=""`
`193`	`193`	`forstacklevel,frameinenumerate(reversed(stack),start=1):`
`194`		`-ifstacklevel==2:`
`195`		`-warning_from=f" (python-gitlab:{frame.filename}:{frame.lineno})"`
	`194`	`+warning_from=f" (python-gitlab:{frame.filename}:{frame.lineno})"`
`196`	`195`	`frame_dir=str(pathlib.Path(frame.filename).parent.resolve())`
`197`	`196`	`ifnotframe_dir.startswith(str(pg_dir)):`
`198`	`197`	`break`

`‎tests/functional/api/test_gitlab.py`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -252,6 +252,7 @@ def test_list_default_warning(gl):`
`252`	`252`	`assertlen(record)==1`
`253`	`253`	`warning=record[0]`
`254`	`254`	`assert__file__==warning.filename`
	`255`	`+assert__file__instr(warning.message)`
`255`	`256`
`256`	`257`
`257`	`258`	`deftest_list_page_nowarning(gl,recwarn):`

`‎tests/unit/test_gitlab_http_methods.py`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -600,6 +600,7 @@ def test_list_request_pagination_warning(gl):`
`600`	`600`	`message=str(warning.message)`
`601`	`601`	assert"Calling a `list()` method"inmessage
`602`	`602`	`assert"python-gitlab.readthedocs.io"inmessage`
	`603`	`+assert__file__inmessage`
`603`	`604`	`assert__file__==warning.filename`
`604`	`605`	`assertisinstance(result,list)`
`605`	`606`	`assertlen(result)==20`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit529f1fa

File tree

3 files changed

3 files changed

`‎gitlab/utils.py`

`‎tests/functional/api/test_gitlab.py`

`‎tests/unit/test_gitlab_http_methods.py`

0 commit comments