Skip to content

Commit

Permalink
Fix mypy errors due to unneeded type ignores (#469)
Browse files Browse the repository at this point in the history
It seems we brought in better sphinx types due to an upstream change?
  • Loading branch information
hoodmane authored Jul 17, 2024
1 parent df66980 commit fdad0d7
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion src/sphinx_autodoc_typehints/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -653,7 +653,7 @@ def process_docstring( # noqa: PLR0913, PLR0917

localns = TypeAliasNamespace(app.config["autodoc_type_aliases"])
type_hints = get_all_type_hints(app.config.autodoc_mock_imports, obj, name, localns)
app.config._annotation_globals = getattr(obj, "__globals__", {}) # type: ignore[attr-defined] # noqa: SLF001
app.config._annotation_globals = getattr(obj, "__globals__", {}) # noqa: SLF001
try:
_inject_types_to_docstring(type_hints, signature, original_obj, app, what, name, lines)
finally:
Expand Down
42 changes: 21 additions & 21 deletions tests/test_sphinx_autodoc_typehints.py
Original file line number Diff line number Diff line change
Expand Up @@ -565,8 +565,8 @@ def test_always_document_param_types(
) -> None:
set_python_path()

app.config.always_document_param_types = always_document_param_types # type: ignore[attr-defined] # create flag
app.config.autodoc_mock_imports = ["mailbox"] # type: ignore[attr-defined] # create flag
app.config.always_document_param_types = always_document_param_types # create flag
app.config.autodoc_mock_imports = ["mailbox"] # create flag

# Prevent "document isn't included in any toctree" warnings
for f in Path(app.srcdir).glob("*.rst"):
Expand Down Expand Up @@ -633,7 +633,7 @@ def maybe_fix_py310(expected_contents: str) -> str:
def test_sphinx_output_future_annotations(app: SphinxTestApp, status: StringIO) -> None:
set_python_path()

app.config.master_doc = "future_annotations" # type: ignore[attr-defined] # create flag
app.config.master_doc = "future_annotations" # create flag
app.build()

assert "build succeeded" in status.getvalue() # Build succeeded
Expand Down Expand Up @@ -667,8 +667,8 @@ def test_sphinx_output_future_annotations(app: SphinxTestApp, status: StringIO)
def test_sphinx_output_default_role(app: SphinxTestApp, status: StringIO) -> None:
set_python_path()

app.config.master_doc = "simple_default_role" # type: ignore[attr-defined] # create flag
app.config.default_role = "literal" # type: ignore[attr-defined]
app.config.master_doc = "simple_default_role" # create flag
app.config.default_role = "literal"
app.build()

assert "build succeeded" in status.getvalue() # Build succeeded
Expand Down Expand Up @@ -716,8 +716,8 @@ def test_sphinx_output_defaults(
) -> None:
set_python_path()

app.config.master_doc = "simple" # type: ignore[attr-defined] # create flag
app.config.typehints_defaults = defaults_config_val # type: ignore[attr-defined] # create flag
app.config.master_doc = "simple" # create flag
app.config.typehints_defaults = defaults_config_val # create flag
if isinstance(expected, Exception):
with pytest.raises(Exception, match=re.escape(str(expected))):
app.build()
Expand Down Expand Up @@ -763,8 +763,8 @@ def test_sphinx_output_formatter(
) -> None:
set_python_path()

app.config.master_doc = "simple" # type: ignore[attr-defined] # create flag
app.config.typehints_formatter = formatter_config_val # type: ignore[attr-defined] # create flag
app.config.master_doc = "simple" # create flag
app.config.typehints_formatter = formatter_config_val # create flag
if isinstance(expected, Exception):
with pytest.raises(Exception, match=re.escape(str(expected))):
app.build()
Expand Down Expand Up @@ -888,7 +888,7 @@ def func(x): # type: ignore[no-untyped-def] # noqa: ANN001, ANN202
@pytest.mark.sphinx("text", testroot="resolve-typing-guard")
def test_resolve_typing_guard_imports(app: SphinxTestApp, status: StringIO, warning: StringIO) -> None:
set_python_path()
app.config.autodoc_mock_imports = ["viktor"] # type: ignore[attr-defined] # create flag
app.config.autodoc_mock_imports = ["viktor"] # create flag
app.build()
out = status.getvalue()
assert "build succeeded" in out
Expand Down Expand Up @@ -917,8 +917,8 @@ def test_no_source_code_type_guard() -> None:
@patch("sphinx.writers.text.MAXWIDTH", 2000)
def test_sphinx_output_formatter_no_use_rtype(app: SphinxTestApp, status: StringIO) -> None:
set_python_path()
app.config.master_doc = "simple_no_use_rtype" # type: ignore[attr-defined] # create flag
app.config.typehints_use_rtype = False # type: ignore[attr-defined]
app.config.master_doc = "simple_no_use_rtype" # create flag
app.config.typehints_use_rtype = False
app.build()
assert "build succeeded" in status.getvalue()
text_path = Path(app.srcdir) / "_build" / "text" / "simple_no_use_rtype.txt"
Expand Down Expand Up @@ -982,8 +982,8 @@ def test_sphinx_output_formatter_no_use_rtype(app: SphinxTestApp, status: String
@patch("sphinx.writers.text.MAXWIDTH", 2000)
def test_sphinx_output_with_use_signature(app: SphinxTestApp, status: StringIO) -> None:
set_python_path()
app.config.master_doc = "simple" # type: ignore[attr-defined] # create flag
app.config.typehints_use_signature = True # type: ignore[attr-defined]
app.config.master_doc = "simple" # create flag
app.config.typehints_use_signature = True
app.build()
assert "build succeeded" in status.getvalue()
text_path = Path(app.srcdir) / "_build" / "text" / "simple.txt"
Expand Down Expand Up @@ -1011,8 +1011,8 @@ def test_sphinx_output_with_use_signature(app: SphinxTestApp, status: StringIO)
@patch("sphinx.writers.text.MAXWIDTH", 2000)
def test_sphinx_output_with_use_signature_return(app: SphinxTestApp, status: StringIO) -> None:
set_python_path()
app.config.master_doc = "simple" # type: ignore[attr-defined] # create flag
app.config.typehints_use_signature_return = True # type: ignore[attr-defined]
app.config.master_doc = "simple" # create flag
app.config.typehints_use_signature_return = True
app.build()
assert "build succeeded" in status.getvalue()
text_path = Path(app.srcdir) / "_build" / "text" / "simple.txt"
Expand Down Expand Up @@ -1040,9 +1040,9 @@ def test_sphinx_output_with_use_signature_return(app: SphinxTestApp, status: Str
@patch("sphinx.writers.text.MAXWIDTH", 2000)
def test_sphinx_output_with_use_signature_and_return(app: SphinxTestApp, status: StringIO) -> None:
set_python_path()
app.config.master_doc = "simple" # type: ignore[attr-defined] # create flag
app.config.typehints_use_signature = True # type: ignore[attr-defined]
app.config.typehints_use_signature_return = True # type: ignore[attr-defined]
app.config.master_doc = "simple" # create flag
app.config.typehints_use_signature = True
app.config.typehints_use_signature_return = True
app.build()
assert "build succeeded" in status.getvalue()
text_path = Path(app.srcdir) / "_build" / "text" / "simple.txt"
Expand Down Expand Up @@ -1070,8 +1070,8 @@ def test_sphinx_output_with_use_signature_and_return(app: SphinxTestApp, status:
@patch("sphinx.writers.text.MAXWIDTH", 2000)
def test_default_annotation_without_typehints(app: SphinxTestApp, status: StringIO) -> None:
set_python_path()
app.config.master_doc = "without_complete_typehints" # type: ignore[attr-defined]# create flag
app.config.typehints_defaults = "comma" # type: ignore[attr-defined]
app.config.master_doc = "without_complete_typehints" # create flag
app.config.typehints_defaults = "comma"
app.build()
assert "build succeeded" in status.getvalue()
text_path = Path(app.srcdir) / "_build" / "text" / "without_complete_typehints.txt"
Expand Down

0 comments on commit fdad0d7

Please sign in to comment.