comments.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#
#  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.
 
from robotide.lib.robot.utils import is_string
 
 
class CommentCache():
 
    def __init__(self):
        self._comments_comments = []
 
    def add(self, comment):
        self._comments_comments.append(comment)
 
    def consume_with(self, function):
        print(f"DEBUG: CommentCache enter consume_with {self._comments}")
        for comment in self._comments_comments:
            function(comment)
        self.__init____init__()
 
 
class Comments():
 
    def __init__(self):
        self._comments_comments = []
 
    def add(self, row):
        if row.comments:
            self._comments_comments.extend(c.strip() for c in row.comments if c.strip())
 
    @property
    value = property
    
    def value(self):
        return self._comments_comments
 
 
class Comment():
 
    def __init__(self, comment_data):
        if is_string(comment_data):
            comment_data = [comment_data] if comment_data else []
        self._comment_comment = comment_data or []
        # print(f"DEBUG RFLib Comment input={comment_data} self._comment={self._comment}")
 
    def __len__(self):
        return len(self._comment_comment)
 
    def as_list(self):
        if self._not_commented_not_commented():
            self._comment_comment[0] = '# ' + self._comment_comment[0]
        return self._comment_comment
 
    def _not_commented(self):
        return self._comment_comment and self._comment_comment[0] and self._comment_comment[0][0] != '#'