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

Completed

Pull Request — master (#1098)

by Mischa

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

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