psyclone.psyir.nodes.commentable_mixin.CommentableMixin Class Reference

Inheritance diagram for psyclone.psyir.nodes.commentable_mixin.CommentableMixin:

Public Member Functions
def	preceding_comment (self)
def	preceding_comment (self, comment)
def	inline_comment (self)
def	inline_comment (self, comment)

Detailed Description

Mixin that adds the Commentable trait into a PSyIR node. It provides
two attributes that store preceding and inline comments and their
respective property getters and setters.

Definition at line 40 of file commentable_mixin.py.

Member Function Documentation

inline_comment() [1/2]

def psyclone.psyir.nodes.commentable_mixin.CommentableMixin.inline_comment

(

self

)

:returns: inline comment associated with this statement.
:rtype: str

Definition at line 73 of file commentable_mixin.py.

    def inline_comment(self):
        '''
        :returns: inline comment associated with this statement.
        :rtype: str
        '''
        return self._inline_comment
 

References psyclone.psyir.nodes.commentable_mixin.CommentableMixin._inline_comment.

Here is the caller graph for this function:

inline_comment() [2/2]

def psyclone.psyir.nodes.commentable_mixin.CommentableMixin.inline_comment	(		self,
			comment
	)

:param str comment: inline comment associated with this statement.

Definition at line 81 of file commentable_mixin.py.

    def inline_comment(self, comment):
        '''
        :param str comment: inline comment associated with this statement.
        '''
        if not isinstance(comment, str):
            raise TypeError(f"The inline_comment must be a string but"
                            f" found '{type(comment).__name__}'.")
        self._inline_comment = comment
 
 
# For automatic API documentation generation

References psyclone.psyir.nodes.commentable_mixin.CommentableMixin._inline_comment, and psyclone.psyir.nodes.commentable_mixin.CommentableMixin.inline_comment().

Here is the call graph for this function:

preceding_comment() [1/2]

def psyclone.psyir.nodes.commentable_mixin.CommentableMixin.preceding_comment

(

self

)

:returns: comment preceding this statement.
:rtype: str

Definition at line 55 of file commentable_mixin.py.

    def preceding_comment(self):
        '''
        :returns: comment preceding this statement.
        :rtype: str
        '''
        return self._preceding_comment
 

References psyclone.psyir.nodes.commentable_mixin.CommentableMixin._preceding_comment.

Here is the caller graph for this function:

preceding_comment() [2/2]

def psyclone.psyir.nodes.commentable_mixin.CommentableMixin.preceding_comment	(		self,
			comment
	)

:param str comment: comment preceding this statement.

Definition at line 63 of file commentable_mixin.py.

    def preceding_comment(self, comment):
        '''
        :param str comment: comment preceding this statement.
        '''
        if not isinstance(comment, str):
            raise TypeError(f"The preceding_comment must be a string but"
                            f" found '{type(comment).__name__}'.")
        self._preceding_comment = comment
 

References psyclone.psyir.nodes.commentable_mixin.CommentableMixin._preceding_comment, and psyclone.psyir.nodes.commentable_mixin.CommentableMixin.preceding_comment().

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/psyclone-ref/checkouts/latest/src/psyclone/psyir/nodes/commentable_mixin.py