fileparser.Parser Class Reference

Inheritance diagram for fileparser.Parser:

Public Member Functions
	__init__ (self)
	FindCopyrightBlock (self, comment_blocks)
	GetCopyrightBlockAttributes (self, comment_block)

Protected Attributes
	_copyright_pattern
	_attribute_pattern

Detailed Description

Base class for all language-specific parsers.

Definition at line 22 of file fileparser.py.

Constructor & Destructor Documentation

__init__()

fileparser.Parser.__init__

(

self

)

Reimplemented in fileparser.CParser.

Definition at line 26 of file fileparser.py.

    def __init__(self):
        self._copyright_pattern = re.compile('copyright', re.IGNORECASE)
        self._attribute_pattern = re.compile(
            'copyright.*\D(\d{4})\W*(\w.*[\w.])', re.IGNORECASE)
 

Member Function Documentation

FindCopyrightBlock()

fileparser.Parser.FindCopyrightBlock	(		self,
			comment_blocks
	)

Given a list of comment block strings, return the one that seems
like the most likely copyright block.

Returns None if comment_blocks was empty, or if we couldn't find
a comment block that contains copyright info.

Definition at line 31 of file fileparser.py.

    def FindCopyrightBlock(self, comment_blocks):
        """Given a list of comment block strings, return the one that seems
        like the most likely copyright block.
 
        Returns None if comment_blocks was empty, or if we couldn't find
        a comment block that contains copyright info."""
        if not comment_blocks:
            return None
        for block in comment_blocks:
            if self._copyright_pattern.search(block):
                return block
 

GetCopyrightBlockAttributes()

fileparser.Parser.GetCopyrightBlockAttributes	(		self,
			comment_block
	)

Given a comment block, return a tuple of attributes: (year, holder).

If comment_block is None, or none of the attributes are found,
this will return (None, None).

Definition at line 43 of file fileparser.py.

    def GetCopyrightBlockAttributes(self, comment_block):
        """Given a comment block, return a tuple of attributes: (year, holder).
 
        If comment_block is None, or none of the attributes are found,
        this will return (None, None)."""
        if not comment_block:
            return (None, None)
        matches = self._attribute_pattern.findall(comment_block)
        if not matches:
            return (None, None)
        first_match = matches[0]
        return (first_match[0], first_match[1])
 
 

Member Data Documentation

_attribute_pattern

fileparser.Parser._attribute_pattern

protected

Definition at line 28 of file fileparser.py.

_copyright_pattern

fileparser.Parser._copyright_pattern

protected

Definition at line 27 of file fileparser.py.

---

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

• third_party/skia/tools/copyright/fileparser.py