coalib.bearlib.abstractions.DefaultLinterInterface.generate_config() - Code Metrics - Inspection of "Makman2/linterv2" - coala-analyzer/coala - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#1814)

by Mischa

created 2016-03-05 20:55 UTC

generate_config() A

↳ Parent: coalib.bearlib.abstractions.DefaultLinterInterface

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Metric	Value
cc	1
dl	0
loc	19
rs	9.4285

class DefaultLinterInterface:

    @staticmethod
    def generate_config(filename, file):
        """
        Generates the content of a config-file the linter-tool might need.

        The contents generated from this function are written to a temporary
        file and the path is provided inside ``create_arguments()``.

        By default no configuration is generated.

        You can provide additional keyword arguments and defaults. These will
        be interpreted as required settings that need to be provided through a
        coafile-section.

        :param filename: The name of the file currently processed.
        :param file:     The contents of the file currently processed.
        :return:         The config-file-contents as a string or ``None``.
        """
        return None

    @staticmethod
    def create_arguments(filename, file, config_file):
        """
        Creates the arguments for the linter.

        You can provide additional keyword arguments and defaults. These will
        be interpreted as required settings that need to be provided through a
        coafile-section.

        :param filename:    The name of the file the linter-tool shall process.
        :param file:        The contents of the file.
        :param config_file: The path of the config-file if used. ``None`` if
                            unused.
        :return:            A sequence of arguments to feed the linter-tool
                            with.
        """
        raise NotImplementedError


1			class DefaultLinterInterface:
2
3			@staticmethod
4			def generate_config(filename, file):
5			"""
6			Generates the content of a config-file the linter-tool might need.
7
8			The contents generated from this function are written to a temporary
9			file and the path is provided inside ``create_arguments()``.
10
11			By default no configuration is generated.
12
13			You can provide additional keyword arguments and defaults. These will
14			be interpreted as required settings that need to be provided through a
15			coafile-section.
16
17			:param filename: The name of the file currently processed.
18			:param file: The contents of the file currently processed.
19			:return: The config-file-contents as a string or ``None``.
20			"""
21			return None
22
23			@staticmethod
24			def create_arguments(filename, file, config_file):
25			"""
26			Creates the arguments for the linter.
27
28			You can provide additional keyword arguments and defaults. These will
29			be interpreted as required settings that need to be provided through a
30			coafile-section.
31
32			:param filename: The name of the file the linter-tool shall process.
33			:param file: The contents of the file.
34			:param config_file: The path of the config-file if used. ``None`` if
35			unused.
36			:return: A sequence of arguments to feed the linter-tool
37			with.
38			"""
39			raise NotImplementedError
40

coala-analyzer / coala

Pull Request — master (#1814)

generate_config() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like