def file_reporter(self, filename): # pylint: disable=unused-argument
"""Return the FileReporter class to use for filename.
This will only be invoked if `filename` returns non-None from
:meth:`file_tracer`. It's an error to return None.
"""
_needs_to_implement(self, "file_reporter")
def file_reporter(self, filename): # pylint: disable=unused-argument
"""Return the FileReporter class to use for filename.
This will only be invoked if `filename` returns non-None from
:meth:`file_tracer`. It's an error to return None.
"""
_needs_to_implement(self, "file_reporter")
def file_reporter(self, filename): # pylint: disable=unused-argument
"""Get the :class:`FileReporter` class to use for a file.
This will only be invoked if `filename` returns non-None from
:meth:`file_tracer`. It's an error to return None from this method.
Returns a :class:`FileReporter` object to use to report on `filename`.
"""
_needs_to_implement(self, "file_reporter")
def lines(self):
"""Get the executable lines in this file.
Your plugin must determine which lines in the file were possibly
executable. This method returns a set of those line numbers.
Returns a set of line numbers.
"""
_needs_to_implement(self, "lines")
def source_filename(self):
"""The source filename for this file.
This may be any filename you like. A key responsibility of a plugin is
to own the mapping from Python execution back to whatever source
filename was originally the source of the code.
Returns the filename to credit with this execution.
"""
_needs_to_implement(self, "source_filename")
def source_filename(self):
"""The source filename for this file.
This may be any filename you like. A key responsibility of a plugin is
to own the mapping from Python execution back to whatever source
filename was originally the source of the code.
Returns:
The filename to credit with this execution.
"""
_needs_to_implement(self, "source_filename")
def file_reporter(self, filename): # pylint: disable=unused-argument
"""Get the :class:`FileReporter` class to use for a file.
Plug-in type: file tracer.
This will only be invoked if `filename` returns non-None from
:meth:`file_tracer`. It's an error to return None from this method.
Returns a :class:`FileReporter` object to use to report on `filename`,
or the string `"python"` to have coverage.py treat the file as Python.
"""
_needs_to_implement(self, "file_reporter")
def file_reporter(self, filename): # pylint: disable=unused-argument
"""Get the :class:`FileReporter` class to use for a file.
Plug-in type: file tracer.
This will only be invoked if `filename` returns non-None from
:meth:`file_tracer`. It's an error to return None from this method.
Returns a :class:`FileReporter` object to use to report on `filename`,
or the string `"python"` to have coverage.py treat the file as Python.
"""
_needs_to_implement(self, "file_reporter")
def source_filename(self):
"""The source file name for this file.
This may be any file name you like. A key responsibility of a plugin
is to own the mapping from Python execution back to whatever source
file name was originally the source of the code.
See :meth:`CoveragePlugin.file_tracer` for details about static and
dynamic file names.
Returns the file name to credit with this execution.
"""
_needs_to_implement(self, "source_filename")
def statements(self):
_needs_to_implement(self, "statements")
def lines(self):
"""Return a set of executable lines"""
_needs_to_implement(self, "lines")
def statements(self):
_needs_to_implement(self, "statements")
