coala-analyzer / coala

coalib/settings/DocumentationComment.py

import inspect
from collections import OrderedDict

from coalib.misc.Enum import enum


class DocumentationComment:
    _ParseMode = enum("DESCRIPTION", "PARAM", "RETVAL")

    def __init__(self, desc, param_dict, retval_desc):
        """
        Represents a documentation comment of a python class or function.

        :param desc:        A description as string.
        :param param_dict:  A dictionary containing parameter names as key and
                            their description as value. To preserve the order,
                            use OrderedDict.
        :param retval_desc: A string describing the return value.
        """
        self.desc = desc

The variable desc does not seem to be defined.

        self.param_dict = param_dict

The variable param_dict does not seem to be defined.

        self.retval_desc = retval_desc

The variable retval_desc does not seem to be defined.

    @classmethod

The variable classmethod does not seem to be defined.

    def from_docstring(cls, docstring):
        """
        Parses a python docstring. Usable attributes are:
        :param
        @param
        :return
        @return
        """
        lines = inspect.cleandoc(docstring).split("\n")

        parse_mode = cls._ParseMode.DESCRIPTION

The variable cls does not seem to be defined.

        cur_param = ""

        desc = ""
        param_dict = OrderedDict()
        retval_desc = ""
        for line in lines:

The variable lines does not seem to be defined.

            line = line.strip()

            if line == "":

The variable line does not seem to be defined.

                parse_mode = cls._ParseMode.DESCRIPTION

                continue

            if line.startswith(":param ") or line.startswith("@param "):
                parse_mode = cls._ParseMode.PARAM
                splitted = line[7:].split(":", 1)
                cur_param = splitted[0]

The variable splitted does not seem to be defined.

                param_dict[cur_param] = splitted[1].strip()

                continue

            if line.startswith(":return: ") or line.startswith("@return: "):
                parse_mode = cls._ParseMode.RETVAL
                retval_desc = line[9:].strip()

                continue

            if parse_mode == cls._ParseMode.RETVAL:

The variable parse_mode does not seem to be defined.

                retval_desc += " " + line

The variable retval_desc does not seem to be defined.

            elif parse_mode == cls._ParseMode.PARAM:
                param_dict[cur_param] += " " + line

The variable cur_param does not seem to be defined.

The variable param_dict does not seem to be defined.

            else:
                desc += " " + line

The variable desc does not seem to be defined.

        return (cls(desc=desc.strip(),
                    param_dict=param_dict,
                    retval_desc=retval_desc.strip()))

    def __str__(self):
        return str(self.desc)

The variable self does not seem to be defined.