mirror of
https://github.com/PyCQA/flake8.git
synced 2026-04-12 07:44:16 +00:00
type the rest of the legacy api
This commit is contained in:
parent
1c3fef6cda
commit
78b2db4072
3 changed files with 45 additions and 43 deletions
|
|
@ -106,9 +106,5 @@ disallow_untyped_defs = true
|
||||||
no_implicit_optional = true
|
no_implicit_optional = true
|
||||||
warn_unused_ignores = true
|
warn_unused_ignores = true
|
||||||
|
|
||||||
# TODO: fix these
|
|
||||||
[mypy-flake8.api.legacy]
|
|
||||||
disallow_untyped_defs = false
|
|
||||||
|
|
||||||
[mypy-tests.*]
|
[mypy-tests.*]
|
||||||
disallow_untyped_defs = false
|
disallow_untyped_defs = false
|
||||||
|
|
|
||||||
|
|
@ -6,9 +6,13 @@ In 3.0 we no longer have an "engine" module but we maintain the API from it.
|
||||||
import argparse
|
import argparse
|
||||||
import logging
|
import logging
|
||||||
import os.path
|
import os.path
|
||||||
|
from typing import Any
|
||||||
from typing import List
|
from typing import List
|
||||||
|
from typing import Optional
|
||||||
|
from typing import Type
|
||||||
|
|
||||||
import flake8
|
import flake8
|
||||||
|
from flake8.discover_files import expand_paths
|
||||||
from flake8.formatting import base as formatter
|
from flake8.formatting import base as formatter
|
||||||
from flake8.main import application as app
|
from flake8.main import application as app
|
||||||
from flake8.options import config
|
from flake8.options import config
|
||||||
|
|
@ -80,7 +84,7 @@ class StyleGuide:
|
||||||
.. versionchanged:: 3.0.0
|
.. versionchanged:: 3.0.0
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self, application):
|
def __init__(self, application: app.Application) -> None:
|
||||||
"""Initialize our StyleGuide."""
|
"""Initialize our StyleGuide."""
|
||||||
self._application = application
|
self._application = application
|
||||||
self._file_checker_manager = application.file_checker_manager
|
self._file_checker_manager = application.file_checker_manager
|
||||||
|
|
@ -91,14 +95,16 @@ class StyleGuide:
|
||||||
|
|
||||||
An instance of :class:`argparse.Namespace` containing parsed options.
|
An instance of :class:`argparse.Namespace` containing parsed options.
|
||||||
"""
|
"""
|
||||||
|
assert self._application.options is not None
|
||||||
return self._application.options
|
return self._application.options
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def paths(self):
|
def paths(self) -> List[str]:
|
||||||
"""Return the extra arguments passed as paths."""
|
"""Return the extra arguments passed as paths."""
|
||||||
return self._application.paths
|
assert self._application.options is not None
|
||||||
|
return self._application.options.filenames
|
||||||
|
|
||||||
def check_files(self, paths=None):
|
def check_files(self, paths: Optional[List[str]] = None) -> Report:
|
||||||
"""Run collected checks on the files provided.
|
"""Run collected checks on the files provided.
|
||||||
|
|
||||||
This will check the files passed in and return a :class:`Report`
|
This will check the files passed in and return a :class:`Report`
|
||||||
|
|
@ -111,12 +117,13 @@ class StyleGuide:
|
||||||
:rtype:
|
:rtype:
|
||||||
flake8.api.legacy.Report
|
flake8.api.legacy.Report
|
||||||
"""
|
"""
|
||||||
|
assert self._application.options is not None
|
||||||
self._application.options.filenames = paths
|
self._application.options.filenames = paths
|
||||||
self._application.run_checks()
|
self._application.run_checks()
|
||||||
self._application.report_errors()
|
self._application.report_errors()
|
||||||
return Report(self._application)
|
return Report(self._application)
|
||||||
|
|
||||||
def excluded(self, filename, parent=None):
|
def excluded(self, filename: str, parent: Optional[str] = None) -> bool:
|
||||||
"""Determine if a file is excluded.
|
"""Determine if a file is excluded.
|
||||||
|
|
||||||
:param str filename:
|
:param str filename:
|
||||||
|
|
@ -128,14 +135,27 @@ class StyleGuide:
|
||||||
:rtype:
|
:rtype:
|
||||||
bool
|
bool
|
||||||
"""
|
"""
|
||||||
return self._file_checker_manager.is_path_excluded(filename) or (
|
|
||||||
parent
|
def excluded(path: str) -> bool:
|
||||||
and self._file_checker_manager.is_path_excluded(
|
paths = tuple(
|
||||||
os.path.join(parent, filename)
|
expand_paths(
|
||||||
|
paths=[path],
|
||||||
|
stdin_display_name=self.options.stdin_display_name,
|
||||||
|
filename_patterns=self.options.filename,
|
||||||
|
exclude=self.options.exclude,
|
||||||
|
is_running_from_diff=self.options.diff,
|
||||||
|
)
|
||||||
)
|
)
|
||||||
|
return not paths
|
||||||
|
|
||||||
|
return excluded(filename) or (
|
||||||
|
parent is not None and excluded(os.path.join(parent, filename))
|
||||||
)
|
)
|
||||||
|
|
||||||
def init_report(self, reporter=None):
|
def init_report(
|
||||||
|
self,
|
||||||
|
reporter: Optional[Type[formatter.BaseFormatter]] = None,
|
||||||
|
) -> None:
|
||||||
"""Set up a formatter for this run of Flake8."""
|
"""Set up a formatter for this run of Flake8."""
|
||||||
if reporter is None:
|
if reporter is None:
|
||||||
return
|
return
|
||||||
|
|
@ -154,7 +174,13 @@ class StyleGuide:
|
||||||
self._application.file_checker_manager = None
|
self._application.file_checker_manager = None
|
||||||
self._application.make_file_checker_manager()
|
self._application.make_file_checker_manager()
|
||||||
|
|
||||||
def input_file(self, filename, lines=None, expected=None, line_offset=0):
|
def input_file(
|
||||||
|
self,
|
||||||
|
filename: str,
|
||||||
|
lines: Optional[Any] = None,
|
||||||
|
expected: Optional[Any] = None,
|
||||||
|
line_offset: Optional[Any] = 0,
|
||||||
|
) -> Report:
|
||||||
"""Run collected checks on a single file.
|
"""Run collected checks on a single file.
|
||||||
|
|
||||||
This will check the file passed in and return a :class:`Report`
|
This will check the file passed in and return a :class:`Report`
|
||||||
|
|
@ -176,7 +202,7 @@ class StyleGuide:
|
||||||
return self.check_files([filename])
|
return self.check_files([filename])
|
||||||
|
|
||||||
|
|
||||||
def get_style_guide(**kwargs):
|
def get_style_guide(**kwargs: Any) -> StyleGuide:
|
||||||
r"""Provision a StyleGuide for use.
|
r"""Provision a StyleGuide for use.
|
||||||
|
|
||||||
:param \*\*kwargs:
|
:param \*\*kwargs:
|
||||||
|
|
|
||||||
|
|
@ -57,9 +57,9 @@ def test_styleguide_options():
|
||||||
def test_styleguide_paths():
|
def test_styleguide_paths():
|
||||||
"""Show that we proxy the StyleGuide.paths attribute."""
|
"""Show that we proxy the StyleGuide.paths attribute."""
|
||||||
app = mock.Mock()
|
app = mock.Mock()
|
||||||
app.paths = "paths"
|
app.options.filenames = ["paths"]
|
||||||
style_guide = api.StyleGuide(app)
|
style_guide = api.StyleGuide(app)
|
||||||
assert style_guide.paths == "paths"
|
assert style_guide.paths == ["paths"]
|
||||||
|
|
||||||
|
|
||||||
def test_styleguide_check_files():
|
def test_styleguide_check_files():
|
||||||
|
|
@ -78,33 +78,13 @@ def test_styleguide_check_files():
|
||||||
def test_styleguide_excluded():
|
def test_styleguide_excluded():
|
||||||
"""Verify we delegate to our file checker manager.
|
"""Verify we delegate to our file checker manager.
|
||||||
|
|
||||||
We also want to ensure that if we don't specify a parent, is_path_excluded
|
|
||||||
is called exactly once.
|
|
||||||
"""
|
|
||||||
app = mock.Mock()
|
|
||||||
file_checker_manager = app.file_checker_manager = mock.Mock()
|
|
||||||
style_guide = api.StyleGuide(app)
|
|
||||||
|
|
||||||
style_guide.excluded("file.py")
|
|
||||||
file_checker_manager.is_path_excluded.assert_called_once_with("file.py")
|
|
||||||
|
|
||||||
|
|
||||||
def test_styleguide_excluded_with_parent():
|
|
||||||
"""Verify we delegate to our file checker manager.
|
|
||||||
|
|
||||||
When we add the parent argument, we don't check that is_path_excluded was
|
When we add the parent argument, we don't check that is_path_excluded was
|
||||||
called only once.
|
called only once.
|
||||||
"""
|
"""
|
||||||
app = mock.Mock()
|
style_guide = api.get_style_guide(exclude=["file*", "*/parent/*"])
|
||||||
file_checker_manager = app.file_checker_manager = mock.Mock()
|
assert not style_guide.excluded("unrelated.py")
|
||||||
file_checker_manager.is_path_excluded.return_value = False
|
assert style_guide.excluded("file.py")
|
||||||
style_guide = api.StyleGuide(app)
|
assert style_guide.excluded("test.py", "parent")
|
||||||
|
|
||||||
style_guide.excluded("file.py", "parent")
|
|
||||||
assert file_checker_manager.is_path_excluded.call_args_list == [
|
|
||||||
mock.call("file.py"),
|
|
||||||
mock.call(os.path.join("parent", "file.py")),
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
def test_styleguide_init_report_does_nothing():
|
def test_styleguide_init_report_does_nothing():
|
||||||
|
|
@ -121,7 +101,7 @@ def test_styleguide_init_report_with_non_subclass():
|
||||||
app = mock.Mock()
|
app = mock.Mock()
|
||||||
style_guide = api.StyleGuide(app)
|
style_guide = api.StyleGuide(app)
|
||||||
with pytest.raises(ValueError):
|
with pytest.raises(ValueError):
|
||||||
style_guide.init_report(object)
|
style_guide.init_report(object) # type: ignore
|
||||||
assert app.make_formatter.called is False
|
assert app.make_formatter.called is False
|
||||||
assert app.make_guide.called is False
|
assert app.make_guide.called is False
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue