Add ability to handle blurbs in C-style comments.

diff --git a/README b/README
index a3b561ae1cd8a04ecd8d152a007676888b3dd598..995c19248145e9d917eb263459b1ab43ef1f7f99 100644 (file)
--- a/README
+++ b/README
@@ -114,6 +114,17 @@ is replaced by a new blurb, which is automatically generated from your
 configured long copyright string, with author names and edit years
 extracted from the VCS data for that file.
 
 configured long copyright string, with author names and edit years
 extracted from the VCS data for that file.
 

+While the above works well for languages that use ``#`` to mark
+comment lines, it doesn't work for languages like C that use ``/*…*/``
+to mark comments.  There blurb-update algorithm also looks for any
+lines that begging with ``/* Copyright`` and replaces that line, and
+subsequent lines up to one beginning with `` */``, with a new blurb.
+
+Because I've never seen a file with *both* trigger lines, it shouldn't
+be a problem to run both against each of your versioned files.  If it
+is a problem for you, let me know, and we can add some configuration
+options to work around the problem.
+

 Incomplete VCS history
 ----------------------
 
 Incomplete VCS history
 ----------------------
 

diff --git a/update_copyright/project.py b/update_copyright/project.py
index 2a408f5bb47b16a521fec80432247620fd4ead9a..f9a70e141359587a4c3be3c1e5973857caf6df81 100644 (file)
--- a/update_copyright/project.py
+++ b/update_copyright/project.py
@@ -189,8 +189,13 @@ class Project (object):
         authors = self._vcs.authors(filename=filename)
         new_contents = _utils.update_copyright(
             contents=contents, original_year=original_year, authors=authors,
         authors = self._vcs.authors(filename=filename)
         new_contents = _utils.update_copyright(
             contents=contents, original_year=original_year, authors=authors,

-            text=self._copyright, info=self._info(), prefix='# ',
+            text=self._copyright, info=self._info(), prefix=('# ', '# ', None),

             width=self._width, tag=self._copyright_tag)
             width=self._width, tag=self._copyright_tag)

+        new_contents = _utils.update_copyright(
+            contents=new_contents, original_year=original_year,
+            authors=authors, text=self._copyright, info=self._info(),
+            prefix=('/* ', ' * ', ' */'), width=self._width,
+            tag=self._copyright_tag)

         _utils.set_contents(
             filename=filename, contents=new_contents,
             original_contents=contents, unicode=True, encoding=self._encoding,
         _utils.set_contents(
             filename=filename, contents=new_contents,
             original_contents=contents, unicode=True, encoding=self._encoding,

diff --git a/update_copyright/utils.py b/update_copyright/utils.py
index 37af5b8b7dc57254f80c29f95ce41c853b55daf4..e950596b6e1dab75a1bed93c42bb08027c2498b2 100644 (file)
--- a/update_copyright/utils.py
+++ b/update_copyright/utils.py
@@ -57,12 +57,12 @@ def short_author_formatter(copyright_year_string, authors):
 
 def copyright_string(original_year, final_year, authors, text, info={},
                      author_format_fn=long_author_formatter,
 
 def copyright_string(original_year, final_year, authors, text, info={},
                      author_format_fn=long_author_formatter,

-                     formatter_kwargs={}, prefix='', wrap=True,
+                     formatter_kwargs={}, prefix=('', '', None), wrap=True,

                      **wrap_kwargs):
     """
     >>> print(copyright_string(original_year=2005, final_year=2005,
     ...                        authors=['A <a@a.com>', 'B <b@b.edu>'],
                      **wrap_kwargs):
     """
     >>> print(copyright_string(original_year=2005, final_year=2005,
     ...                        authors=['A <a@a.com>', 'B <b@b.edu>'],

-    ...                        text=['BLURB',], prefix='# '
+    ...                        text=['BLURB',], prefix=('# ', '# ', None),

     ...                        )) # doctest: +REPORT_UDIFF
     # Copyright (C) 2005 A <a@a.com>
     #                    B <b@b.edu>
     ...                        )) # doctest: +REPORT_UDIFF
     # Copyright (C) 2005 A <a@a.com>
     #                    B <b@b.edu>


@@ -70,6 +70,15 @@ def copyright_string(original_year, final_year, authors, text, info={},
     # BLURB
     >>> print(copyright_string(original_year=2005, final_year=2009,
     ...                        authors=['A <a@a.com>', 'B <b@b.edu>'],
     # BLURB
     >>> print(copyright_string(original_year=2005, final_year=2009,
     ...                        authors=['A <a@a.com>', 'B <b@b.edu>'],

+    ...                        text=['BLURB',], prefix=('/* ', ' * ', ' */'),
+    ...                        )) # doctest: +REPORT_UDIFF
+    /* Copyright (C) 2005-2009 A <a@a.com>
+     *                         B <b@b.edu>
+     *
+     * BLURB
+     */
+    >>> print(copyright_string(original_year=2005, final_year=2009,
+    ...                        authors=['A <a@a.com>', 'B <b@b.edu>'],

     ...                        text=['BLURB',]
     ...                        )) # doctest: +REPORT_UDIFF
     Copyright (C) 2005-2009 A <a@a.com>
     ...                        text=['BLURB',]
     ...                        )) # doctest: +REPORT_UDIFF
     Copyright (C) 2005-2009 A <a@a.com>


@@ -101,7 +110,7 @@ def copyright_string(original_year, final_year, authors, text, info={},
     """
     for key in ['initial_indent', 'subsequent_indent']:
         if key not in wrap_kwargs:
     """
     for key in ['initial_indent', 'subsequent_indent']:
         if key not in wrap_kwargs:

-            wrap_kwargs[key] = prefix
+            wrap_kwargs[key] = prefix[1]

 
     if original_year == final_year:
         date_range = '%s' % original_year
 
     if original_year == final_year:
         date_range = '%s' % original_year


@@ -112,7 +121,10 @@ def copyright_string(original_year, final_year, authors, text, info={},
     lines = author_format_fn(copyright_year_string, authors,
                              **formatter_kwargs)
     for i,line in enumerate(lines):
     lines = author_format_fn(copyright_year_string, authors,
                              **formatter_kwargs)
     for i,line in enumerate(lines):

-        lines[i] = prefix + line
+        if i == 0:
+            lines[i] = prefix[0] + line
+        else:
+            lines[i] = prefix[1] + line

 
     for i,paragraph in enumerate(text):
         try:
 
     for i,paragraph in enumerate(text):
         try:


@@ -132,10 +144,13 @@ def copyright_string(original_year, final_year, authors, text, info={},
     else:
         assert wrap_kwargs['subsequent_indent'] == '', \
             wrap_kwargs['subsequent_indent']
     else:
         assert wrap_kwargs['subsequent_indent'] == '', \
             wrap_kwargs['subsequent_indent']

-    sep = '\n%s\n' % prefix.rstrip()
-    return sep.join(['\n'.join(lines)] + text)
+    sep = '\n{}\n'.format(prefix[1].rstrip())
+    ret = sep.join(['\n'.join(lines)] + text)
+    if prefix[2]:
+        ret += ('\n{}'.format(prefix[2]))
+    return ret

 
 

-def tag_copyright(contents, tag=None):
+def tag_copyright(contents, prefix=('# ', '# ', None), tag=None):

     """
     >>> contents = '''Some file
     ... bla bla
     """
     >>> contents = '''Some file
     ... bla bla


@@ -152,20 +167,45 @@ def tag_copyright(contents, tag=None):
     (copyright ends)
     bla bla bla
     <BLANKLINE>
     (copyright ends)
     bla bla bla
     <BLANKLINE>

+    >>> contents = '''Some file
+    ... bla bla
+    ... /* Copyright (copyright begins)
+    ...  * (copyright continues)
+    ...  *
+    ...  * bla bla bla
+    ...  */
+    ... (copyright ends)
+    ... bla bla bla
+    ... '''
+    >>> print tag_copyright(
+    ...     contents, prefix=('/* ', ' * ', ' */'), tag='-xyz-CR-zyx-')
+    Some file
+    bla bla
+    -xyz-CR-zyx-
+    (copyright ends)
+    bla bla bla
+    <BLANKLINE>

     """
     lines = []
     incopy = False
     """
     lines = []
     incopy = False

+    start = prefix[0] + 'Copyright'
+    middle = prefix[1].rstrip()
+    end = prefix[2]

     for line in contents.splitlines():
     for line in contents.splitlines():

-        if incopy == False and line.startswith('# Copyright'):
+        if not incopy and line.startswith(start):

             incopy = True
             lines.append(tag)
             incopy = True
             lines.append(tag)

-        elif incopy == True and not line.startswith('#'):
+        elif incopy and not line.startswith(middle):
+            if end:
+                assert line.startswith(end), line

             incopy = False
             incopy = False

-        if incopy == False:
+        if not incopy:

             lines.append(line.rstrip('\n'))
             lines.append(line.rstrip('\n'))

+        if incopy and end and line.startswith(end):
+            incopy = False

     return '\n'.join(lines)+'\n'
 
     return '\n'.join(lines)+'\n'
 

-def update_copyright(contents, tag=None, **kwargs):
+def update_copyright(contents, prefix=('# ', '# ', None), tag=None, **kwargs):

     """
     >>> contents = '''Some file
     ... bla bla
     """
     >>> contents = '''Some file
     ... bla bla


@@ -175,9 +215,9 @@ def update_copyright(contents, tag=None, **kwargs):
     ... (copyright ends)
     ... bla bla bla
     ... '''
     ... (copyright ends)
     ... bla bla bla
     ... '''

-    >>> print update_copyright(contents, original_year=2008,
-    ...                        authors=['Jack', 'Jill'],
-    ...                        text=['BLURB',], prefix='# ', tag='--tag--'
+    >>> print update_copyright(
+    ...     contents, original_year=2008, authors=['Jack', 'Jill'],
+    ...     text=['BLURB',], prefix=('# ', '# ', None), tag='--tag--'

     ...     ) # doctest: +ELLIPSIS, +REPORT_UDIFF
     Some file
     bla bla
     ...     ) # doctest: +ELLIPSIS, +REPORT_UDIFF
     Some file
     bla bla


@@ -190,8 +230,8 @@ def update_copyright(contents, tag=None, **kwargs):
     <BLANKLINE>
     """
     current_year = _time.gmtime()[0]
     <BLANKLINE>
     """
     current_year = _time.gmtime()[0]

-    string = copyright_string(final_year=current_year, **kwargs)
-    contents = tag_copyright(contents=contents, tag=tag)
+    string = copyright_string(final_year=current_year, prefix=prefix, **kwargs)
+    contents = tag_copyright(contents=contents, prefix=prefix, tag=tag)

     return contents.replace(tag, string)
 
 def get_contents(filename, unicode=False, encoding=None):
     return contents.replace(tag, string)
 
 def get_contents(filename, unicode=False, encoding=None):