rtmigo / commie.python

Find comments in a file

from pathlib import Path
import commie

for comment in commie.iter_comments_file(Path("/path/to/source.cpp")):

  # something like "/* sample */"
  print("Comment code:", comment.code)
  print("Comment code location:", comment.code_span.start, comment.code_span.end)

  # something like " sample " 
  print("Comment inner text:", comment.text)
  print("Comment text location:", comment.text_span.start, comment.text_span.end)

Find comments in a string

import commie

source_code_in_golang:str = ...

for comment in commie.iter_comments_go(source_code_in_golang):
  # ... process comment ...
  pass

Find comments in a string with a known filename

Method commie.iter_comments will try to guess the file format from the provided filename

from pathlib import Path
import commie

filename:str = "/path/to/mycode.go"
source_code:str = Path(filename).read_text()

for comment in commie.iter_comments(source_code, filename):
  # ... process comment ...
  pass

This project was forked from comment_parser. Motivation: