[WIP] typing: fix _pytest._code.source.getfslineno: returns str; assignment #6590

blueyed · 2020-01-28T00:02:14Z

Fixes:

src/_pytest/_code/source.py:309: error: Incompatible types in
assignment (expression has type "Union[local, str]", variable has type
"Optional[local]") [assignment]

blueyed · 2020-01-28T00:03:44Z

src/_pytest/_code/source.py

@@ -305,11 +310,7 @@ def getfslineno(obj) -> Tuple[Optional[Union["Literal['']", py.path.local]], int
                _, lineno = findsource(obj)
            except IOError:
                pass


@bluetech
We've discussed the fspath = fn and py.path.local(fn) or None line above recently (#6527 (comment)).
I think it might actually never happen (and will try to write a test for it), but in general I think we should remove the Optional from the return type, which would simpify typing internally already.

This is relevant for

pytest/src/_pytest/compat.py

Lines 310 to 317 in 0e777a6

def getfslineno(obj) -> Tuple[Union[str, py.path.local], int]:

# xxx let decorators etc specify a sane ordering

obj = get_real_func(obj)

if hasattr(obj, "place_as"):

obj = obj.place_as

fslineno = _pytest._code.getfslineno(obj)

assert isinstance(fslineno[1], int), obj

return fslineno

It depends on whether fn = inspect.getsourcefile(obj) or inspect.getfile(obj) can end up being falsey. I didn't check.

Fixes: > src/_pytest/_code/source.py:309: error: Incompatible types in > assignment (expression has type "Union[local, str]", variable has type > "Optional[local]") [assignment]

blueyed · 2020-01-28T00:48:04Z

src/_pytest/_code/source.py

@@ -282,7 +283,7 @@ def compile_(  # noqa: F811
    return s.compile(filename, mode, flags, _genframe=_genframe)


-def getfslineno(obj) -> Tuple[Optional[Union["Literal['']", py.path.local]], int]:
+def getfslineno(obj: Any) -> Tuple[Optional[Union[str, py.path.local]], int]:


@bluetech
Not sure about obj: Any here. I've tried Callable[[Any], None] inbetween, but that would e.g. not cover classes etc.
I think it makes sense to allow Any here explicitly, given that TypeErrors are handled etc anyway.

Yes, looks like this really is supposed to handle everything. I'd make it object though, instead of Any. object means the code can assume nothing on the value, while Any means the code can assume anything.

Then it complains with the inspect.get{source,}file calls though, which expects "Union[Module, Type[Any], MethodType, FunctionType, TracebackType, FrameType, CodeType, Callable[..., Any]]".
Should we use this then maybe also, or # type: ignore it?

Catching TypeError is basically a runtime type: ignore. So seems justifiable in this case.

(Of course, eventually it will be good to get rid of this except TypeError, which indicates some type confusion)

bluetech · 2020-01-28T07:43:23Z

src/_pytest/_code/source.py

@@ -282,7 +283,7 @@ def compile_(  # noqa: F811
    return s.compile(filename, mode, flags, _genframe=_genframe)


-def getfslineno(obj) -> Tuple[Optional[Union["Literal['']", py.path.local]], int]:
+def getfslineno(obj: Any) -> Tuple[Optional[Union[str, py.path.local]], int]:


Yes, looks like this really is supposed to handle everything. I'd make it object though, instead of Any. object means the code can assume nothing on the value, while Any means the code can assume anything.

src/_pytest/_code/source.py

bluetech · 2020-01-28T07:54:42Z

src/_pytest/_code/source.py

@@ -305,11 +310,7 @@ def getfslineno(obj) -> Tuple[Optional[Union["Literal['']", py.path.local]], int
                _, lineno = findsource(obj)
            except IOError:
                pass


It depends on whether fn = inspect.getsourcefile(obj) or inspect.getfile(obj) can end up being falsey. I didn't check.

…ignment

It should be in `test_code` when testing `_pytest._code.getfslineno`, not to be confused with `_pytest._code.source.getfslineno`. Adds an extra assert (via pytest-dev#6590).

Closes pytest-dev#6590.

blueyed · 2020-02-03T17:51:22Z

Moved into #6656.

Closes pytest-dev#6590.

blueyed commented Jan 28, 2020

View reviewed changes

typing: fix _pytest._code.source.getfslineno: returns str; assignment

0e777a6

Fixes: > src/_pytest/_code/source.py:309: error: Incompatible types in > assignment (expression has type "Union[local, str]", variable has type > "Optional[local]") [assignment]

blueyed force-pushed the fix-typing-getfslineno branch from 2c3702e to 0e777a6 Compare January 28, 2020 00:46

blueyed commented Jan 28, 2020

View reviewed changes

bluetech reviewed Jan 28, 2020

View reviewed changes

blueyed added 4 commits January 28, 2020 15:09

fixup! typing: fix _pytest._code.source.getfslineno: returns str; ass…

fe8ac07

…ignment

getfslineno(obj: object)

110b0f7

TEST: assert fn

dcd70a7

getfslineno: skip trying Code

5bd79f1

blueyed mentioned this pull request Jan 28, 2020

[WIP] getfslineno: skip trying Code #6609

Closed

blueyed mentioned this pull request Jan 29, 2020

tests: move test_getfslineno #6610

Merged

blueyed mentioned this pull request Jan 29, 2020

typing: fix getfslineno (assignment) #6622

Closed

blueyed changed the title ~~typing: fix _pytest._code.source.getfslineno: returns str; assignment~~ [WIP] typing: fix _pytest._code.source.getfslineno: returns str; assignment Jan 30, 2020

blueyed added a commit to blueyed/pytest that referenced this pull request Feb 3, 2020

typing: fix getfslineno

fcbb6f0

Closes pytest-dev#6590.

blueyed closed this Feb 3, 2020

blueyed deleted the fix-typing-getfslineno branch February 3, 2020 17:51

blueyed added a commit to blueyed/pytest that referenced this pull request Feb 3, 2020

typing: fix getfslineno

dab90ef

Closes pytest-dev#6590.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] typing: fix _pytest._code.source.getfslineno: returns str; assignment #6590

[WIP] typing: fix _pytest._code.source.getfslineno: returns str; assignment #6590

blueyed commented Jan 28, 2020

blueyed Jan 28, 2020 •

edited

Loading

blueyed Jan 28, 2020

bluetech Jan 28, 2020

blueyed Jan 28, 2020

bluetech Jan 28, 2020

blueyed Jan 28, 2020

bluetech Jan 28, 2020

bluetech Jan 28, 2020

bluetech Jan 28, 2020

blueyed commented Feb 3, 2020

	def getfslineno(obj) -> Tuple[Union[str, py.path.local], int]:
	# xxx let decorators etc specify a sane ordering
	obj = get_real_func(obj)
	if hasattr(obj, "place_as"):
	obj = obj.place_as
	fslineno = _pytest._code.getfslineno(obj)
	assert isinstance(fslineno[1], int), obj
	return fslineno

[WIP] typing: fix _pytest._code.source.getfslineno: returns str; assignment #6590

[WIP] typing: fix _pytest._code.source.getfslineno: returns str; assignment #6590

Conversation

blueyed commented Jan 28, 2020

blueyed Jan 28, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blueyed commented Feb 3, 2020

blueyed Jan 28, 2020 •

edited

Loading