coalib.bearlib.languages.documentation.DocstyleDefinition.load() - Code Metrics - Inspection of "Makman2/doc format bear6" - coala-analyzer/coala - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#1098)

by Mischa

created 2015-12-01 01:29 UTC

load() B

↳ Parent: coalib.bearlib.languages.documentation.DocstyleDefinition

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Metric	Value
cc	5
dl	0
loc	52
rs	8.3534

How to fix Long Method

import os.path

from coalib.misc.Compatability import FileNotFoundError
from coalib.misc.Decorators import generate_eq, generate_repr
from coalib.parsing.ConfParser import ConfParser


@generate_repr()
@generate_eq("language", "docstyle", "markers")
class DocstyleDefinition:
    """
    The DocstyleDefinition class holds values that identify a certain type of
    documentation comment (for which language, documentation style/tool used
    etc.).
    """

    # TODO: Allow flattened tuple when providing a single marker_set. TEST THAT!
    # TODO: Type checks? This class is not involved in critical processes, a
    #       robust user friendly frontend would be good... TEST THAT!
    def __init__(self, language, docstyle, markers):
        """
        Instantiates a new DocstyleDefinition.

        :param language: The programming language of the documentation comment.
                         For example `"CPP"` for C++ or `"PYTHON3"` for
                         Python 3.
                         The given string is automatically lowered, so passing
                         i.e. "CPP" or "cpp" makes no difference.
        :param docstyle: The documentation style/tool used to document code.
                         For example `"default"` or `"doxygen"`.
                         The given string is automatically lowered, so passing
                         i.e. "default" or "DEFAULT" makes no difference.
        :param markers:  An iterable of marker/delimiter string iterables that
                         identify a documentation comment. See `markers`
                         property for more details on markers.
        """
        self._language = language.lower()
        self._docstyle = docstyle.lower()
        self._markers = tuple(tuple(marker_set) for marker_set in markers)

        # Check marker set dimensions.
        for marker_set in self._markers:
            length = len(marker_set)
            if length != 3:
                raise ValueError("Length of a given marker set was not 3 (was "
                                 "actually {}).".format(length))

    @property
    def language(self):
        """
        The programming language.

        :return: A lower-case string defining the programming language (i.e.
                 "cpp" or "python").
        """
        return self._language

    @property
    def docstyle(self):
        """
        The documentation style/tool used to document code.

        :return: A lower-case string defining the docstyle (i.e. "default" or
                 "doxygen").
        """
        return self._docstyle

    @property
    def markers(self):
        """
        A tuple of marker sets that identify a documentation comment.

        Marker sets consist of 3 entries where the first is the start-marker,
        the second one the each-line marker and the last one the end-marker.
        For example a marker tuple with a single marker set
        `(("/**", "*", "*/"),)` would match following documentation comment:

        ```
        /**
         * This is documentation.
         */
        ```

        It's also possible to supply an empty each-line marker
        (`("/**", "", "*/")`):

        ```
        /**
         This is more documentation.
         */
        ```

        Markers are matched "greedy", that means it will match as many
        each-line markers as possible. I.e. for `("///", "///", "///")`):

        ```
        /// Brief documentation.
        ///
        /// Detailed documentation.
        ```

        :return: A tuple of marker/delimiter string tuples that identify a
                 documentation comment.
        """
        return self._markers

    @classmethod
    def load(cls, language, docstyle):
        """
        Returns a `DocstyleDefinition` defined for the given language and
        docstyle from the coala docstyle definition files.

        The marker settings are loaded from the according coalang-files. Each
        setting inside them are considered a marker setting.

        :param language:           The programming language. For example
                                   `"CPP"` for C++ or `"PYTHON3"` for Python 3.
                                   The given string is automatically lowered,
                                   so passing i.e. "CPP" or "cpp" makes no
                                   difference.
        :param docstyle:           The documentation style/tool used. For
                                   example `"default"` or `"doxygen"`.
                                   The given string is automatically lowered,
                                   so passing i.e. "default" or "DEFAULT" makes
                                   no difference.
        :raises FileNotFoundError: Raised when the given docstyle was not
                                   found. This is a compatability exception
                                   from `coalib.misc.Compatability` module.
        :raises KeyError:          Raised when the given language is not
                                   defined for given docstyle.
        :return:                   The `DocstyleDefinition` for giving language
                                   and docstyle.
        """

        docstyle = docstyle.lower()

        language_config_parser = ConfParser(remove_empty_iter_elements=False)
        try:
            docstyle_settings = language_config_parser.parse(
                os.path.dirname(__file__) + "/" + docstyle + ".coalang")
        except FileNotFoundError as ex:
            raise type(ex)("Docstyle definition " + repr(docstyle) + " not "
                           "found.")

        language = language.lower()

        try:
            docstyle_settings = docstyle_settings[language]
        except KeyError:
            raise KeyError("Language {} is not defined for docstyle {}."
                           .format(repr(language), repr(docstyle)))

        marker_sets = (tuple(value)
                       for key, value in
                           filter(lambda kv: not kv[0].startswith("comment"),
                                  docstyle_settings.contents.items()))

        return cls(language, docstyle, marker_sets)


1			import os.path
2
3			from coalib.misc.Compatability import FileNotFoundError
4			from coalib.misc.Decorators import generate_eq, generate_repr
5			from coalib.parsing.ConfParser import ConfParser
6
7
8			@generate_repr()
9			@generate_eq("language", "docstyle", "markers")
10			class DocstyleDefinition:
11			"""
12			The DocstyleDefinition class holds values that identify a certain type of
13			documentation comment (for which language, documentation style/tool used
14			etc.).
15			"""
16
17			# TODO: Allow flattened tuple when providing a single marker_set. TEST THAT!
18			# TODO: Type checks? This class is not involved in critical processes, a
19			# robust user friendly frontend would be good... TEST THAT!
20			def __init__(self, language, docstyle, markers):
21			"""
22			Instantiates a new DocstyleDefinition.
23
24			:param language: The programming language of the documentation comment.
25			For example `"CPP"` for C++ or `"PYTHON3"` for
26			Python 3.
27			The given string is automatically lowered, so passing
28			i.e. "CPP" or "cpp" makes no difference.
29			:param docstyle: The documentation style/tool used to document code.
30			For example `"default"` or `"doxygen"`.
31			The given string is automatically lowered, so passing
32			i.e. "default" or "DEFAULT" makes no difference.
33			:param markers: An iterable of marker/delimiter string iterables that
34			identify a documentation comment. See `markers`
35			property for more details on markers.
36			"""
37			self._language = language.lower()
38			self._docstyle = docstyle.lower()
39			self._markers = tuple(tuple(marker_set) for marker_set in markers)
40
41			# Check marker set dimensions.
42			for marker_set in self._markers:
43			length = len(marker_set)
44			if length != 3:
45			raise ValueError("Length of a given marker set was not 3 (was "
46			"actually {}).".format(length))
47
48			@property
49			def language(self):
50			"""
51			The programming language.
52
53			:return: A lower-case string defining the programming language (i.e.
54			"cpp" or "python").
55			"""
56			return self._language
57
58			@property
59			def docstyle(self):
60			"""
61			The documentation style/tool used to document code.
62
63			:return: A lower-case string defining the docstyle (i.e. "default" or
64			"doxygen").
65			"""
66			return self._docstyle
67
68			@property
69			def markers(self):
70			"""
71			A tuple of marker sets that identify a documentation comment.
72
73			Marker sets consist of 3 entries where the first is the start-marker,
74			the second one the each-line marker and the last one the end-marker.
75			For example a marker tuple with a single marker set
76			`(("/*", "", "*/"),)` would match following documentation comment:
77
78			```
79			/**
80			* This is documentation.
81			*/
82			```
83
84			It's also possible to supply an empty each-line marker
85			(`("/*", "", "/")`):
86
87			```
88			/**
89			This is more documentation.
90			*/
91			```
92
93			Markers are matched "greedy", that means it will match as many
94			each-line markers as possible. I.e. for `("///", "///", "///")`):
95
96			```
97			/// Brief documentation.
98			///
99			/// Detailed documentation.
100			```
101
102			:return: A tuple of marker/delimiter string tuples that identify a
103			documentation comment.
104			"""
105			return self._markers
106
107			@classmethod
108			def load(cls, language, docstyle):
109			"""
110			Returns a `DocstyleDefinition` defined for the given language and
111			docstyle from the coala docstyle definition files.
112
113			The marker settings are loaded from the according coalang-files. Each
114			setting inside them are considered a marker setting.
115
116			:param language: The programming language. For example
117			`"CPP"` for C++ or `"PYTHON3"` for Python 3.
118			The given string is automatically lowered,
119			so passing i.e. "CPP" or "cpp" makes no
120			difference.
121			:param docstyle: The documentation style/tool used. For
122			example `"default"` or `"doxygen"`.
123			The given string is automatically lowered,
124			so passing i.e. "default" or "DEFAULT" makes
125			no difference.
126			:raises FileNotFoundError: Raised when the given docstyle was not
127			found. This is a compatability exception
128			from `coalib.misc.Compatability` module.
129			:raises KeyError: Raised when the given language is not
130			defined for given docstyle.
131			:return: The `DocstyleDefinition` for giving language
132			and docstyle.
133			"""
134
135			docstyle = docstyle.lower()
136
137			language_config_parser = ConfParser(remove_empty_iter_elements=False)
138			try:
139			docstyle_settings = language_config_parser.parse(
140			os.path.dirname(__file__) + "/" + docstyle + ".coalang")
141			except FileNotFoundError as ex:
142			raise type(ex)("Docstyle definition " + repr(docstyle) + " not "
143			"found.")
144
145			language = language.lower()
146
147			try:
148			docstyle_settings = docstyle_settings[language]
149			except KeyError:
150			raise KeyError("Language {} is not defined for docstyle {}."
151			.format(repr(language), repr(docstyle)))
152
153			marker_sets = (tuple(value)
154			for key, value in
155			filter(lambda kv: not kv[0].startswith("comment"),
156			docstyle_settings.contents.items()))
157
158			return cls(language, docstyle, marker_sets)
159

coala-analyzer / coala

Pull Request — master (#1098)

load() B

Complexity

Size

Duplication

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like