Can mypy check docstrings?
up vote
2
down vote
favorite
I have numpydoc-style docstrings:
def foobar(filename, copy, dtype, iterable, shape, files):
"""
foobar is 42.
Parameters
----------
filename : str
copy : bool
dtype : data-type
iterable : iterable object
shape : int or tuple of int
files : list of str
Returns
-------
foobarfoo : int
"""
pass
Is it possible to check if the docstring-types can possibly be correct?
(side question: Can numpy return/print the function signatures it discovered?)
For example, I would expect the following to fail:
Return Types
def foobar():
"""
Returns
-------
blub : int
"""
return "foo"
or
def foobar(a, b):
"""
Parameters
----------
a : number
b : number
Returns
-------
blub : int
"""
if a > b:
return "foo"
return 42
Parameter types
def foobar(a, b):
"""
Parameters
----------
a : str
b : int
Returns
-------
blub : int
"""
return a * b
python mypy numpydoc
asked Nov 9 at 7:21
Martin Thoma
39.2k52282498
add a comment |
up vote
2
down vote
favorite
I have numpydoc-style docstrings:
def foobar(filename, copy, dtype, iterable, shape, files):
"""
foobar is 42.
Parameters
----------
filename : str
copy : bool
dtype : data-type
iterable : iterable object
shape : int or tuple of int
files : list of str
Returns
-------
foobarfoo : int
"""
pass
Is it possible to check if the docstring-types can possibly be correct?
(side question: Can numpy return/print the function signatures it discovered?)
For example, I would expect the following to fail:
Return Types
def foobar():
"""
Returns
-------
blub : int
"""
return "foo"
or
def foobar(a, b):
"""
Parameters
----------
a : number
b : number
Returns
-------
blub : int
"""
if a > b:
return "foo"
return 42
Parameter types
def foobar(a, b):
"""
Parameters
----------
a : str
b : int
Returns
-------
blub : int
"""
return a * b
python mypy numpydoc
asked Nov 9 at 7:21
Martin Thoma
39.2k52282498
add a comment |
up vote
2
down vote
favorite
up vote
2
down vote
favorite
I have numpydoc-style docstrings:
def foobar(filename, copy, dtype, iterable, shape, files):
"""
foobar is 42.
Parameters
----------
filename : str
copy : bool
dtype : data-type
iterable : iterable object
shape : int or tuple of int
files : list of str
Returns
-------
foobarfoo : int
"""
pass
Is it possible to check if the docstring-types can possibly be correct?
(side question: Can numpy return/print the function signatures it discovered?)
For example, I would expect the following to fail:
Return Types
def foobar():
"""
Returns
-------
blub : int
"""
return "foo"
or
def foobar(a, b):
"""
Parameters
----------
a : number
b : number
Returns
-------
blub : int
"""
if a > b:
return "foo"
return 42
Parameter types
def foobar(a, b):
"""
Parameters
----------
a : str
b : int
Returns
-------
blub : int
"""
return a * b
python mypy numpydoc
asked Nov 9 at 7:21
Martin Thoma
39.2k52282498
I have numpydoc-style docstrings:
def foobar(filename, copy, dtype, iterable, shape, files):
"""
foobar is 42.
Parameters
----------
filename : str
copy : bool
dtype : data-type
iterable : iterable object
shape : int or tuple of int
files : list of str
Returns
-------
foobarfoo : int
"""
pass
Is it possible to check if the docstring-types can possibly be correct?
(side question: Can numpy return/print the function signatures it discovered?)
For example, I would expect the following to fail:
Return Types
def foobar():
"""
Returns
-------
blub : int
"""
return "foo"
or
def foobar(a, b):
"""
Parameters
----------
a : number
b : number
Returns
-------
blub : int
"""
if a > b:
return "foo"
return 42
Parameter types
def foobar(a, b):
"""
Parameters
----------
a : str
b : int
Returns
-------
blub : int
"""
return a * b
python mypy numpydoc
python mypy numpydoc
asked Nov 9 at 7:21
Martin Thoma
39.2k52282498
asked Nov 9 at 7:21
Martin Thoma
39.2k52282498
asked Nov 9 at 7:21
Martin Thoma
39.2k52282498
asked Nov 9 at 7:21
Martin Thoma
39.2k52282498
asked Nov 9 at 7:21
Martin Thoma
39.2k52282498
39.2k52282498
add a comment |
add a comment |
1 Answer
1
active
oldest
votes
up vote
1
down vote
No, mypy understands the official Python's typing notation only. See the mypy docs. And this fine, we don't need many alternative ways to type annotate, as
There should be one-- and preferably only one --obvious way to do it.
answered Nov 9 at 15:37
pawelswiecki
294112
Aparently you got me wrong. I don't want mypy to assume the docstring is correct. I want to check the docstring correctnes with mypy. As to your comment about "only one way to do it": Can mypy generate documentation?
– Martin Thoma
Nov 9 at 15:50
@MartinThoma I think I understood you correctly, after all, because my reply is the answer to "I want to check the docstring correctnes with mypy." problem as well :) So, mypy does not analyze docstrings at all, in any way. It uses Python's type annotations and the very code to get (or guess) types and analyze them. As far as I know, docstrings are completely ignored by mypy.
– pawelswiecki
Nov 9 at 16:08
add a comment |
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
up vote
1
down vote
No, mypy understands the official Python's typing notation only. See the mypy docs. And this fine, we don't need many alternative ways to type annotate, as
There should be one-- and preferably only one --obvious way to do it.
answered Nov 9 at 15:37
pawelswiecki
294112
Aparently you got me wrong. I don't want mypy to assume the docstring is correct. I want to check the docstring correctnes with mypy. As to your comment about "only one way to do it": Can mypy generate documentation?
– Martin Thoma
Nov 9 at 15:50
@MartinThoma I think I understood you correctly, after all, because my reply is the answer to "I want to check the docstring correctnes with mypy." problem as well :) So, mypy does not analyze docstrings at all, in any way. It uses Python's type annotations and the very code to get (or guess) types and analyze them. As far as I know, docstrings are completely ignored by mypy.
– pawelswiecki
Nov 9 at 16:08
add a comment |
up vote
1
down vote
No, mypy understands the official Python's typing notation only. See the mypy docs. And this fine, we don't need many alternative ways to type annotate, as
There should be one-- and preferably only one --obvious way to do it.
answered Nov 9 at 15:37
pawelswiecki
294112
Aparently you got me wrong. I don't want mypy to assume the docstring is correct. I want to check the docstring correctnes with mypy. As to your comment about "only one way to do it": Can mypy generate documentation?
– Martin Thoma
Nov 9 at 15:50
@MartinThoma I think I understood you correctly, after all, because my reply is the answer to "I want to check the docstring correctnes with mypy." problem as well :) So, mypy does not analyze docstrings at all, in any way. It uses Python's type annotations and the very code to get (or guess) types and analyze them. As far as I know, docstrings are completely ignored by mypy.
– pawelswiecki
Nov 9 at 16:08
add a comment |
up vote
1
down vote
up vote
1
down vote
No, mypy understands the official Python's typing notation only. See the mypy docs. And this fine, we don't need many alternative ways to type annotate, as
There should be one-- and preferably only one --obvious way to do it.
answered Nov 9 at 15:37
pawelswiecki
294112
No, mypy understands the official Python's typing notation only. See the mypy docs. And this fine, we don't need many alternative ways to type annotate, as
There should be one-- and preferably only one --obvious way to do it.
answered Nov 9 at 15:37
pawelswiecki
294112
answered Nov 9 at 15:37
pawelswiecki
294112
answered Nov 9 at 15:37
pawelswiecki
294112
answered Nov 9 at 15:37
pawelswiecki
294112
294112
Aparently you got me wrong. I don't want mypy to assume the docstring is correct. I want to check the docstring correctnes with mypy. As to your comment about "only one way to do it": Can mypy generate documentation?
– Martin Thoma
Nov 9 at 15:50
@MartinThoma I think I understood you correctly, after all, because my reply is the answer to "I want to check the docstring correctnes with mypy." problem as well :) So, mypy does not analyze docstrings at all, in any way. It uses Python's type annotations and the very code to get (or guess) types and analyze them. As far as I know, docstrings are completely ignored by mypy.
– pawelswiecki
Nov 9 at 16:08
add a comment |
Aparently you got me wrong. I don't want mypy to assume the docstring is correct. I want to check the docstring correctnes with mypy. As to your comment about "only one way to do it": Can mypy generate documentation?
– Martin Thoma
Nov 9 at 15:50
@MartinThoma I think I understood you correctly, after all, because my reply is the answer to "I want to check the docstring correctnes with mypy." problem as well :) So, mypy does not analyze docstrings at all, in any way. It uses Python's type annotations and the very code to get (or guess) types and analyze them. As far as I know, docstrings are completely ignored by mypy.
– pawelswiecki
Nov 9 at 16:08
Aparently you got me wrong. I don't want mypy to assume the docstring is correct. I want to check the docstring correctnes with mypy. As to your comment about "only one way to do it": Can mypy generate documentation?
– Martin Thoma
Nov 9 at 15:50
Aparently you got me wrong. I don't want mypy to assume the docstring is correct. I want to check the docstring correctnes with mypy. As to your comment about "only one way to do it": Can mypy generate documentation?
– Martin Thoma
Nov 9 at 15:50
@MartinThoma I think I understood you correctly, after all, because my reply is the answer to "I want to check the docstring correctnes with mypy." problem as well :) So, mypy does not analyze docstrings at all, in any way. It uses Python's type annotations and the very code to get (or guess) types and analyze them. As far as I know, docstrings are completely ignored by mypy.
– pawelswiecki
Nov 9 at 16:08
@MartinThoma I think I understood you correctly, after all, because my reply is the answer to "I want to check the docstring correctnes with mypy." problem as well :) So, mypy does not analyze docstrings at all, in any way. It uses Python's type annotations and the very code to get (or guess) types and analyze them. As far as I know, docstrings are completely ignored by mypy.
– pawelswiecki
Nov 9 at 16:08
add a comment |
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53221369%2fcan-mypy-check-docstrings%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
