# Copyright 2026 jCloud

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#     http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import docstring_parser

__all__ = ['PythonDocstring']


class PythonDocstring:
    """
    Represents a Python docstring.

    :param docstring: The docstring as a string.
    :type docstring: str
    """

    def __init__(self, docstring: str) -> None:
        self.docstring = docstring

    def __repr__(self) -> str:
        return type(self).__name__ + '(' + repr(self.docstring) + ')'

    def __eq__(self, value) -> bool:
        if not isinstance(value, type(self)):
            return False
        return self.docstring == value.docstring

    def parse(self) -> docstring_parser.Docstring:
        """
        Parses the docstring.

        :return: The parsed docstring.
        :rtype: docstring_parser.Docstring
        """

        return docstring_parser.parse(self.docstring)