>>> from comment_parser import comment_parser >>> # Returns a list of comment_parser.parsers.common.Comments >>> comment_parser.extract_comments('/path/to/source_file') >>> # Or >>> comment_parser.extract_comments_from_str('...')

def extract_comments(filename, mime=None): """Extracts and returns the comments from the given source file.   Args:  filename: String name of the file to extract comments from.  mime: Optional MIME type for file (str). Note some MIME types accepted  don't comply with RFC2045. If not given, an attempt to deduce the  MIME type will occur.  Returns:  Python list of parsers.common.Comment in the order that they appear in  the source file.  Raises:  UnsupportedError: If filename is of an unsupported MIME type.  """ pass def extract_comments_from_str(code, mime=None): """Extracts and returns comments from the given source string.   Args:  code: String containing code to extract comments from.  mime: Optional MIME type for code (str). Note some MIME types accepted  don't comply with RFC2045. If not given, an attempt to deduce the  MIME type will occur.  Returns:  Python list of parsers.common.Comment in the order that they appear in  the source code.  Raises:  UnsupportedError: If code is of an unsupported MIME type.  """ pass

class Comment(object): """Represents comments found in source files.""" def text(self): """Returns the comment's text.  Returns:  String  """ pass def line_number(self): """Returns the line number the comment was found on.  Returns:  Int  """ pass def is_multiline(self): """Returns whether this comment was a multiline comment.  Returns:  True if comment was a multiline comment, False if not.  """ pass def __str__(self): pass def __eq__(self, other): pass

from comment_parser import comment_parser comment_parser.extract_comments('foo.c', mime='text/x-c')