From: W. Trevor King Date: Tue, 8 Feb 2011 21:46:17 +0000 (-0500) Subject: Rename project piezo -> pypiezo and restructure. X-Git-Tag: 0.4 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=bd53397da0b53ee818fe6cc50dafc9a0522ba3c0;p=pypiezo.git Rename project piezo -> pypiezo and restructure. --- diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0d20b64 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*.pyc diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..f5e04de --- /dev/null +++ b/AUTHORS @@ -0,0 +1,2 @@ +pypiezo was written by: +W. Trevor King diff --git a/LICENSE b/COPYING similarity index 100% rename from LICENSE rename to COPYING diff --git a/MANIFEST.in b/MANIFEST.in index c75e0c1..faf4a5a 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1 +1 @@ -include LICENSE veeco_header +include AUTHORS COPYING veeco_header diff --git a/Makefile b/Makefile deleted file mode 100644 index 21415b7..0000000 --- a/Makefile +++ /dev/null @@ -1,19 +0,0 @@ -.PHONY : all check dist clean - -all : dummy_py - -dummy_py : setup.py piezo/*.py - python setup.py install --home=~ - echo "dummy for Makefile dependencies" > $@ - -check : all - echo "No checks currently implemented" - -dist : - python setup.py sdist - scp dist/piezo*tar.gz einstein:public_html/code/python/ - -clean : - python setup.py clean - rm -rf build dist piezo.egg-info - rm -f dummy_py *.pyc diff --git a/README b/README index 16453ba..2d03505 100644 --- a/README +++ b/README @@ -1,57 +1,99 @@ -Python modules to control piezoelectric actuators. Mostly a set of -convenient wrappers around pycomedi calls for keeping track of the -relevant calibration constants. To get a feel for an `official' set -of calibration constants, you can take a peek at veeco_header, which -is the beginning of a saved Veeco NanoScope image file. It lists the -parameters used by the NanoScope during imaging. +Pypiezo: Python modules to control piezoelectric actuators. -== Installation == +Mostly a set of convenient wrappers around pycomedi calls for keeping +track of the relevant calibration constants. To get a feel for an +"official" set of calibration constants, you can take a peek at +`veeco_header`, which is the beginning of a saved Veeco NanoScope +image file. It lists the parameters used by the NanoScope during +imaging. -Non-Python dependencies (Debian packagename): - easy_install (python-setuptools) - Numpy (python-numpy) - Scipy (python-scipy) - Matplotlib (python-matplotlib) -Piezo uses `setuptools' for installation. Setuptools is basically an -extension of the standard Python distutils package which supports -automatic package dependency tracking. The installation procedure -should be (on Debian-esque systems) - # apt-get intall python-setuptools python-numpy python-scipy python-matplotlib - # easy_install -f http://www.physics.drexel.edu/~wking/code/python/ piezo +Installation +============ -There is one speedbump you might run into: - * an outdated version of easy_install (see ez_setup.py section) +Packages +-------- -** ez_setup.py +Gentoo +~~~~~~ -This package bundles - http://peak.telecommunity.com/dist/ez_setup.py -to bootstrap setuputils installation on your machine (if neccessary). +I've packaged FFT-tools for Gentoo. You need layman_ and my `wtk +overlay`_. Install with:: -If the bootstrapping doesn't work, you may need to install a current version -of setuptools. On Debian-based systems `apt-get install python-setuptools'. -Once you have *some* version of setuptools, upgrade with - easy_install -U setuptools + # emerge -av app-portage/layman + # layman --add wtk + # emerge -av sci-libs/pycomedi -For more information see - http://peak.telecommunity.com/DevCenter/EasyInstall - http://peak.telecommunity.com/DevCenter/setuptools#what-your-users-should-know +Dependencies +------------ -== Usage == +If you're installing by hand or packaging pycomedi for another +distribution, you'll need the following dependencies: -See piezo/z_piezo_utils.py for some simple examples. +=========== ================= ===================== +Package Debian_ Gentoo_ +=========== ================= ===================== +Numpy_ python-numpy dev-python/numpy +Scipy_ python-scipy sci-libs/scipy +Matplotlib_ python-matplotlib dev-python/matplotlib +Nose_ python-nose dev-python/nose +Pycomedi_ dev-python/pycomedi +=========== ================= ===================== -== Licence == +Installing by hand +------------------ -This project is distributed under the GNU General Public Licence -Version 3 or greater. See LICENSE. +Pypiezo is available as a Git_ repository:: + $ git clone http://www.physics.drexel.edu/~wking/code/git/pypiezo.git -== Author == +See the homepage_ for details. To install the checkout, run the +standard:: + + $ python setup.py install + + +Usage +===== + +See the module docstrings for simple examples. + + +Testing +======= + +Run internal unit tests with:: + + $ nosetests --with-doctests --doctest-tests pypiezo + + +Licence +======= + +This project is distributed under the `GNU General Public License +Version 3`_ or greater. + + +Author +====== W. Trevor King wking@drexel.edu -Copyright 2007, 2008 +Copyright 2007-2011 + + +.. _layman: http://layman.sourceforge.net/ +.. _wtk overlay: + http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay +.. _Debian: http://www.debian.org/ +.. _Gentoo: http://www.gentoo.org/ +.. _NumPy: http://numpy.scipy.org/ +.. _SciPy: http://www.scipy.org/ +.. _Matplotlib: http://matplotlib.sourceforge.net/ +.. _Nose: http://somethingaboutorange.com/mrl/projects/nose/ +.. _Git: http://git-scm.com/ +.. _homepage: + http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/pypiezo/ +.. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt diff --git a/piezo/__init__.py b/piezo/__init__.py deleted file mode 100644 index 25e8469..0000000 --- a/piezo/__init__.py +++ /dev/null @@ -1,24 +0,0 @@ -# calibcant - tools for thermally calibrating AFM cantilevers -# -# Copyright (C) 2007-2009 William Trevor King -# -# This program is free software; you can redistribute it and/or -# modify it under the terms of the GNU General Public License as -# published by the Free Software Foundation; either version 3 of the -# License, or (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -# See the GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA -# 02111-1307, USA. -# -# The author may be contacted at on the Internet, or -# write to Trevor King, Drexel University, Physics Dept., 3141 Chestnut St., -# Philadelphia PA 19104, USA. - -__version__ = '0.3' diff --git a/pypiezo/__init__.py b/pypiezo/__init__.py new file mode 100644 index 0000000..3d079a0 --- /dev/null +++ b/pypiezo/__init__.py @@ -0,0 +1,18 @@ +# Copyright (C) 2009-2011 W. Trevor King +# +# This file is part of pypiezo. +# +# pypiezo is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by the +# Free Software Foundation, either version 3 of the License, or (at your +# option) any later version. +# +# pypiezo is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with pypiezo. If not, see . + +__version__ = '0.4' diff --git a/piezo/x_piezo.py b/pypiezo/x_piezo.py similarity index 80% rename from piezo/x_piezo.py rename to pypiezo/x_piezo.py index 9405b65..7dddaee 100644 --- a/piezo/x_piezo.py +++ b/pypiezo/x_piezo.py @@ -1,3 +1,20 @@ +# Copyright (C) 2008-2011 W. Trevor King +# +# This file is part of pypiezo. +# +# pypiezo is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by the +# Free Software Foundation, either version 3 of the License, or (at your +# option) any later version. +# +# pypiezo is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with pypiezo. If not, see . + from pycomedi.single_aio import AO class x_piezoError (Exception) : diff --git a/piezo/z_piezo.py b/pypiezo/z_piezo.py similarity index 96% rename from piezo/z_piezo.py rename to pypiezo/z_piezo.py index 42e1572..a85ebab 100644 --- a/piezo/z_piezo.py +++ b/pypiezo/z_piezo.py @@ -1,3 +1,20 @@ +# Copyright (C) 2008-2011 W. Trevor King +# +# This file is part of pypiezo. +# +# pypiezo is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by the +# Free Software Foundation, either version 3 of the License, or (at your +# option) any later version. +# +# pypiezo is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with pypiezo. If not, see . + """The z_piezo module controls the one-dimensional displacement of a piezoelectric actuator, while allowing simultaneous data aquisition on two channels. The module is called z_piezo, because for force spectroscopy, diff --git a/piezo/z_piezo_utils.py b/pypiezo/z_piezo_utils.py similarity index 95% rename from piezo/z_piezo_utils.py rename to pypiezo/z_piezo_utils.py index 692b9fb..11f8b7c 100644 --- a/piezo/z_piezo_utils.py +++ b/pypiezo/z_piezo_utils.py @@ -1,3 +1,20 @@ +# Copyright (C) 2008-2011 W. Trevor King +# +# This file is part of pypiezo. +# +# pypiezo is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by the +# Free Software Foundation, either version 3 of the License, or (at your +# option) any later version. +# +# pypiezo is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with pypiezo. If not, see . + TEXT_VERBOSE = False PYLAB_INTERACTIVE = True PYLAB_VERBOSE = False diff --git a/setup.py b/setup.py index 5f8cae5..9acf353 100644 --- a/setup.py +++ b/setup.py @@ -1,13 +1,28 @@ -"""Piezo: tools for controlling piezoelectric actuators +# Copyright (C) 2009-2011 W. Trevor King +# +# This file is part of pypiezo. +# +# pypiezo is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by the +# Free Software Foundation, either version 3 of the License, or (at your +# option) any later version. +# +# pypiezo is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with pypiezo. If not, see . -Requires - * pycomedi - * data_logger - * curses_check_for_keypress +"Tools for controlling piezoelectric actuators." + +from distutils.core import setup +from os import walk +import os.path + +from pypiezo import __version__ -Git repository: -http://www.physics.drexel.edu/~wking/code/git/piezo.git -""" classifiers = """\ Development Status :: 2 - Pre-Alpha @@ -21,49 +36,31 @@ Topic :: Scientific/Engineering Topic :: Software Development :: Libraries :: Python Modules """ -# http://peak.telecommunity.com/DevCenter/setuptools#using-setuptools-without-bundling-it -import ez_setup -ez_setup.use_setuptools() - -from setuptools import setup, find_packages +def find_packages(root='calibcant'): + packages = [] + prefix = '.'+os.path.sep + for dirpath,dirnames,filenames in walk(root): + if '__init__.py' in filenames: + if dirpath.startswith(prefix): + dirpath = dirpath[len(prefix):] + packages.append(dirpath.replace(os.path.sep, '.')) + return packages -# patch distutils if it can't cope with the "classifiers" or -# "download_url" keywords -from sys import version -if version < '2.2.3': - from distutils.dist import DistributionMetadata - DistributionMetadata.classifiers = None - DistributionMetadata.download_url = None +_this_dir = os.path.dirname(__file__) +packages = find_packages() -import piezo -__version__ = piezo.__version__ - -doclines = __doc__.split("\n") - -setup(name="piezo", +setup(name="pypiezo", version=__version__, maintainer="W. Trevor King", maintainer_email="wking@drexel.edu", - url = "http://www.physics.drexel.edu/~wking/code/python/", - download_url = "http://www.physics.drexel.edu/~wking/code/python/piezo-%s.tar.gz" % __version__, + url = "http://www.physics.drexel.edu/~wking/unfolding-disasters/pypiezo/", + download_url = "http://www.physics.drexel.edu/~wking/code/python/pypiezo-%s.tar.gz" % __version__, license = "GNU General Public License (GPL)", platforms = ["all"], - description = doclines[0], - long_description = "\n".join(doclines[2:]), + description = __doc__, + long_description = open(os.path.join(_this_dir, 'README'), 'r').read(), classifiers = filter(None, classifiers.split("\n")), - py_modules = ['ez_setup'], - packages = find_packages(), - dependency_links = [ - "http://www.physics.drexel.edu/~wking/code/python/" - ], - install_requires = ['pycomedi >= 0.2', - 'data_logger >= 0.4', - 'curses_check_for_keypress'], + packages = packages, + provides = ['pypiezo (%s)' % __version__], + requires = ['pycomedi (>= 0.3)'], ) - -# use packages to include subdirectory packages -# use py_modules to include single-module packages -# use ext_modules to include extension modules -# see -# http://www.python.org/doc/2.5.2/dist/listing-modules.html -# http://www.python.org/doc/2.5.2/dist/describing-extensions.html diff --git a/update_copyright.py b/update_copyright.py new file mode 100755 index 0000000..1ad7063 --- /dev/null +++ b/update_copyright.py @@ -0,0 +1,635 @@ +#!/usr/bin/python +# +# Copyright (C) 2009-2011 W. Trevor King +# +# This file is part of Bugs Everywhere. +# +# Bugs Everywhere is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by the +# Free Software Foundation, either version 3 of the License, or (at your +# option) any later version. +# +# Bugs Everywhere is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Bugs Everywhere. If not, see . + +"""Automatically update copyright boilerplate. + +This script is adapted from one written for `Bugs Everywhere`_. and +later modified for `Hooke`_ before returning to `Bugs Everywhere`_. + +.. _Bugs Everywhere: http://bugseverywhere.org/ +.. _Hooke: http://code.google.com/p/hooke/ +""" + +import difflib +import email.utils +import os +import os.path +import re +import sys +import time + + +PROJECT_INFO = { + 'project': 'pypiezo', + 'vcs': 'Git', + } + +# Break "copyright" into "copy" and "right" to avoid matching the +# REGEXP. +COPY_RIGHT_TEXT=""" +This file is part of %(project)s. + +%(project)s is free software; you can redistribute it and/or modify it +under the terms of the GNU General Public License as published by the +Free Software Foundation, either version 3 of the License, or (at your +option) any later version. + +%(project)s is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with %(project)s. If not, see . +""".strip() + +COPY_RIGHT_TAG='-xyz-COPY' + '-RIGHT-zyx-' # unlikely to occur in the wild :p + +# Convert author names to canonical forms. +# ALIASES[] = +# for example, +# ALIASES = { +# 'John Doe ': +# ['John Doe', 'jdoe', 'J. Doe '], +# } +# Git-based projects are encouraged to use .mailmap instead of +# ALIASES. See git-shortlog(1) for details. +ALIASES = {} + +# List of paths that should not be scanned for copyright updates. +# IGNORED_PATHS = ['./.git/'] +IGNORED_PATHS = ['./.git/', './build/'] +# List of files that should not be scanned for copyright updates. +# IGNORED_FILES = ['COPYING'] +IGNORED_FILES = ['COPYING', 'MANIFEST.in', 'README', 'veeco_header'] + +# Work around missing author holes in the VCS history. +# AUTHOR_HACKS[] = [] = +# for example, if module.py was published in 2008 but the VCS history +# only goes back to 2010: +# YEAR_HACKS = { +# ('path', 'to', 'module.py'):2008, +# } +YEAR_HACKS = {} + +# Helpers for VCS-specific commands + +def splitpath(path): + """Recursively split a path into elements. + + Examples + -------- + + >>> splitpath(os.path.join('a', 'b', 'c')) + ('a', 'b', 'c') + >>> splitpath(os.path.join('.', 'a', 'b', 'c')) + ('a', 'b', 'c') + """ + path = os.path.normpath(path) + elements = [] + while True: + dirname,basename = os.path.split(path) + elements.insert(0,basename) + if dirname in ['', '.']: + break + path = dirname + return tuple(elements) + +# VCS-specific commands + +if PROJECT_INFO['vcs'] == 'Git': + + import subprocess + + _MSWINDOWS = sys.platform == 'win32' + _POSIX = not _MSWINDOWS + + def invoke(args, stdin=None, stdout=subprocess.PIPE, stderr=subprocess.PIPE, expect=(0,)): + """ + expect should be a tuple of allowed exit codes. + """ + try : + if _POSIX: + q = subprocess.Popen(args, stdin=subprocess.PIPE, + stdout=stdout, stderr=stderr) + else: + assert _MSWINDOWS == True, 'invalid platform' + # win32 don't have os.execvp() so run the command in a shell + q = subprocess.Popen(args, stdin=subprocess.PIPE, + stdout=stdout, stderr=stderr, shell=True) + except OSError, e: + raise ValueError([args, e]) + stdout,stderr = q.communicate(input=stdin) + status = q.wait() + if status not in expect: + raise ValueError([args, status, stdout, stderr]) + return status, stdout, stderr + + def git_cmd(*args): + status,stdout,stderr = invoke(['git'] + list(args)) + return stdout.rstrip('\n') + + version = git_cmd('--version').split(' ')[-1] + if version.startswith('1.5.'): + # Author name + author_format = '--pretty=format:%an <%ae>' + year_format = ['--pretty=format:%ai'] # Author date + # YYYY-MM-DD HH:MM:SS Z + # Earlier versions of Git don't seem to recognize --date=short + else: + author_format = '--pretty=format:%aN <%aE>' + year_format = ['--pretty=format:%ad', # Author date + '--date=short'] # YYYY-MM-DD + + def original_year(filename, year_hacks=YEAR_HACKS): + output = git_cmd(*(['log', '--follow'] + + year_format + + [filename])) + if version.startswith('1.5.'): + output = '\n'.join([x.split()[0] for x in output.splitlines()]) + years = [int(line.split('-', 1)[0]) for line in output.splitlines()] + if splitpath(filename) in year_hacks: + years.append(year_hacks[splitpath(filename)]) + years.sort() + return years[0] + + def authors(filename, author_hacks=AUTHOR_HACKS): + output = git_cmd('log', '--follow', author_format, + filename) + ret = list(set(output.splitlines())) + if splitpath(filename) in author_hacks: + ret.extend(author_hacks[splitpath(filename)]) + return ret + + def authors_list(author_hacks=AUTHOR_HACKS): + output = git_cmd('log', author_format) + ret = list(set(output.splitlines())) + for path,authors in author_hacks.items(): + ret.extend(authors) + return ret + + def is_versioned(filename): + output = git_cmd('log', '--follow', filename) + if len(output) == 0: + return False + return True + +elif PROJECT_INFO['vcs'] == 'Mercurial': + + import StringIO + import mercurial + import mercurial.dispatch + + def mercurial_cmd(*args): + cwd = os.getcwd() + stdout = sys.stdout + stderr = sys.stderr + tmp_stdout = StringIO.StringIO() + tmp_stderr = StringIO.StringIO() + sys.stdout = tmp_stdout + sys.stderr = tmp_stderr + try: + mercurial.dispatch.dispatch(list(args)) + finally: + os.chdir(cwd) + sys.stdout = stdout + sys.stderr = stderr + return (tmp_stdout.getvalue().rstrip('\n'), + tmp_stderr.getvalue().rstrip('\n')) + + def original_year(filename, year_hacks=YEAR_HACKS): + # shortdate filter: YEAR-MONTH-DAY + output,error = mercurial_cmd('log', '--follow', + '--template', '{date|shortdate}\n', + filename) + years = [int(line.split('-', 1)[0]) for line in output.splitlines()] + if splitpath(filename) in year_hacks: + years.append(year_hacks[splitpath(filename)]) + years.sort() + return years[0] + + def authors(filename, author_hacks=AUTHOR_HACKS): + output,error = mercurial_cmd('log', '--follow', + '--template', '{author}\n', + filename) + ret = list(set(output.splitlines())) + if splitpath(filename) in author_hacks: + ret.extend(author_hacks[splitpath(filename)]) + return ret + + def authors_list(author_hacks=AUTHOR_HACKS): + output,error = mercurial_cmd('log', '--template', '{author}\n') + ret = list(set(output.splitlines())) + for path,authors in author_hacks.items(): + ret.extend(authors) + return ret + + def is_versioned(filename): + output,error = mercurial_cmd('log', '--follow', filename) + if len(error) > 0: + return False + return True + +elif PROJECT_INFO['vcs'] == 'Bazaar': + + import StringIO + import bzrlib + import bzrlib.builtins + import bzrlib.log + + class LogFormatter (bzrlib.log.LogFormatter): + supports_merge_revisions = True + preferred_levels = 0 + supports_deta = False + supports_tags = False + supports_diff = False + + def log_revision(self, revision): + raise NotImplementedError + + class YearLogFormatter (LogFormatter): + def log_revision(self, revision): + self.to_file.write( + time.strftime('%Y', time.gmtime(revision.rev.timestamp)) + +'\n') + + class AuthorLogFormatter (LogFormatter): + def log_revision(self, revision): + authors = revision.rev.get_apparent_authors() + self.to_file.write('\n'.join(authors)+'\n') + + def original_year(filename, year_hacks=YEAR_HACKS): + cmd = bzrlib.builtins.cmd_log() + cmd.outf = StringIO.StringIO() + cmd.run(file_list=[filename], log_format=YearLogFormatter, levels=0) + years = [int(year) for year in set(cmd.outf.getvalue().splitlines())] + if splitpath(filename) in year_hacks: + years.append(year_hacks[splitpath(filename)]) + years.sort() + return years[0] + + def authors(filename, author_hacks=AUTHOR_HACKS): + cmd = bzrlib.builtins.cmd_log() + cmd.outf = StringIO.StringIO() + cmd.run(file_list=[filename], log_format=AuthorLogFormatter, levels=0) + ret = list(set(cmd.outf.getvalue().splitlines())) + if splitpath(filename) in author_hacks: + ret.extend(author_hacks[splitpath(filename)]) + return ret + + def authors_list(author_hacks=AUTHOR_HACKS): + cmd = bzrlib.builtins.cmd_log() + cmd.outf = StringIO.StringIO() + cmd.run(log_format=AuthorLogFormatter, levels=0) + output = cmd.outf.getvalue() + ret = list(set(cmd.outf.getvalue().splitlines())) + for path,authors in author_hacks.items(): + ret.extend(authors) + return ret + + def is_versioned(filename): + cmd = bzrlib.builtins.cmd_log() + cmd.outf = StringIO.StringIO() + cmd.run(file_list=[filename]) + return True + +else: + raise NotImplementedError('Unrecognized VCS: %(vcs)s' % PROJECT_INFO) + +# General utility commands + +def _strip_email(*args): + """Remove email addresses from a series of names. + + Examples + -------- + + >>> _strip_email('J Doe ') + ['J Doe'] + >>> _strip_email('J Doe ', 'JJJ Smith ') + ['J Doe', 'JJJ Smith'] + """ + args = list(args) + for i,arg in enumerate(args): + if arg == None: + continue + author,addr = email.utils.parseaddr(arg) + args[i] = author + return args + +def _reverse_aliases(aliases): + """Reverse an `aliases` dict. + + Input: key: canonical name, value: list of aliases + Output: key: alias, value: canonical name + + Examples + -------- + + >>> aliases = { + ... 'J Doe ':['Johnny ', 'J'], + ... 'JJJ Smith ':['Jingly '], + ... None:['Anonymous '], + ... } + >>> r = _reverse_aliases(aliases) + >>> for item in sorted(r.items()): + ... print item + ('Anonymous ', None) + ('J', 'J Doe ') + ('Jingly ', 'JJJ Smith ') + ('Johnny ', 'J Doe ') + """ + output = {} + for canonical_name,_aliases in aliases.items(): + for alias in _aliases: + output[alias] = canonical_name + return output + +def _replace_aliases(authors, with_email=True, aliases=None): + """Consolidate and sort `authors`. + + Make the replacements listed in the `aliases` dict (key: canonical + name, value: list of aliases). If `aliases` is ``None``, default + to ``ALIASES``. + + >>> aliases = { + ... 'J Doe ':['Johnny '], + ... 'JJJ Smith ':['Jingly '], + ... None:['Anonymous '], + ... } + >>> _replace_aliases(['JJJ Smith ', 'Johnny ', + ... 'Jingly ', 'Anonymous '], + ... with_email=True, aliases=aliases) + ['J Doe ', 'JJJ Smith '] + >>> _replace_aliases(['JJJ Smith', 'Johnny', 'Jingly', 'Anonymous'], + ... with_email=False, aliases=aliases) + ['J Doe', 'JJJ Smith'] + >>> _replace_aliases(['JJJ Smith ', 'Johnny ', + ... 'Jingly ', 'J Doe '], + ... with_email=True, aliases=aliases) + ['J Doe ', 'JJJ Smith '] + """ + if aliases == None: + aliases = ALIASES + if with_email == False: + aliases = dict([(_strip_email(author)[0], _strip_email(*_aliases)) + for author,_aliases in aliases.items()]) + rev_aliases = _reverse_aliases(aliases) + for i,author in enumerate(authors): + if author in rev_aliases: + authors[i] = rev_aliases[author] + authors = sorted(list(set(authors))) + if None in authors: + authors.remove(None) + return authors + +def _copyright_string(original_year, final_year, authors, prefix=''): + """ + >>> print _copyright_string(original_year=2005, + ... final_year=2005, + ... authors=['A ', 'B '], + ... prefix='# ' + ... ) # doctest: +ELLIPSIS + # Copyright (C) 2005 A + # B + # + # This file... + >>> print _copyright_string(original_year=2005, + ... final_year=2009, + ... authors=['A ', 'B '] + ... ) # doctest: +ELLIPSIS + Copyright (C) 2005-2009 A + B + + This file... + """ + if original_year == final_year: + date_range = '%s' % original_year + else: + date_range = '%s-%s' % (original_year, final_year) + lines = ['Copyright (C) %s %s' % (date_range, authors[0])] + for author in authors[1:]: + lines.append(' '*(len('Copyright (C) ')+len(date_range)+1) + + author) + lines.append('') + lines.extend((COPY_RIGHT_TEXT % PROJECT_INFO).splitlines()) + for i,line in enumerate(lines): + lines[i] = (prefix + line).rstrip() + return '\n'.join(lines) + +def _tag_copyright(contents): + """ + >>> contents = '''Some file + ... bla bla + ... # Copyright (copyright begins) + ... # (copyright continues) + ... # bla bla bla + ... (copyright ends) + ... bla bla bla + ... ''' + >>> print _tag_copyright(contents).replace('COPY-RIGHT', 'CR') + Some file + bla bla + -xyz-CR-zyx- + (copyright ends) + bla bla bla + + """ + lines = [] + incopy = False + for line in contents.splitlines(): + if incopy == False and line.startswith('# Copyright'): + incopy = True + lines.append(COPY_RIGHT_TAG) + elif incopy == True and not line.startswith('#'): + incopy = False + if incopy == False: + lines.append(line.rstrip('\n')) + return '\n'.join(lines)+'\n' + +def _update_copyright(contents, original_year, authors): + """ + >>> contents = '''Some file + ... bla bla + ... # Copyright (copyright begins) + ... # (copyright continues) + ... # bla bla bla + ... (copyright ends) + ... bla bla bla + ... ''' + >>> print _update_copyright(contents, 2008, ['Jack', 'Jill'] + ... ) # doctest: +ELLIPSIS, +REPORT_UDIFF + Some file + bla bla + # Copyright (C) 2008-... Jack + # Jill + # + # This file... + (copyright ends) + bla bla bla + + """ + current_year = time.gmtime()[0] + copyright_string = _copyright_string( + original_year, current_year, authors, prefix='# ') + contents = _tag_copyright(contents) + return contents.replace(COPY_RIGHT_TAG, copyright_string) + +def ignored_file(filename, ignored_paths=None, ignored_files=None, + check_disk=True, check_vcs=True): + """ + >>> ignored_paths = ['./a/', './b/'] + >>> ignored_files = ['x', 'y'] + >>> ignored_file('./a/z', ignored_paths, ignored_files, False, False) + True + >>> ignored_file('./ab/z', ignored_paths, ignored_files, False, False) + False + >>> ignored_file('./ab/x', ignored_paths, ignored_files, False, False) + True + >>> ignored_file('./ab/xy', ignored_paths, ignored_files, False, False) + False + >>> ignored_file('./z', ignored_paths, ignored_files, False, False) + False + """ + if ignored_paths == None: + ignored_paths = IGNORED_PATHS + if ignored_files == None: + ignored_files = IGNORED_FILES + if check_disk == True and os.path.isfile(filename) == False: + return True + for path in ignored_paths: + if filename.startswith(path): + return True + if os.path.basename(filename) in ignored_files: + return True + if check_vcs == True and is_versioned(filename) == False: + return True + return False + +def _set_contents(filename, contents, original_contents=None, dry_run=False, + verbose=0): + if original_contents == None and os.path.isfile(filename): + f = open(filename, 'r') + original_contents = f.read() + f.close() + if verbose > 0: + print "checking %s ... " % filename, + if contents != original_contents: + if verbose > 0: + if original_contents == None: + print "[creating]" + else: + print "[updating]" + if verbose > 1 and original_contents != None: + print '\n'.join( + difflib.unified_diff( + original_contents.splitlines(), contents.splitlines(), + fromfile=os.path.normpath(os.path.join('a', filename)), + tofile=os.path.normpath(os.path.join('b', filename)), + n=3, lineterm='')) + if dry_run == False: + f = file(filename, 'w') + f.write(contents) + f.close() + elif verbose > 0: + print "[no change]" + +# Update commands + +def update_authors(authors_fn=authors_list, dry_run=False, verbose=0): + authors = authors_fn() + authors = _replace_aliases(authors, with_email=True, aliases=ALIASES) + new_contents = '%s was written by:\n%s\n' % ( + PROJECT_INFO['project'], + '\n'.join(authors) + ) + _set_contents('AUTHORS', new_contents, dry_run=dry_run, verbose=verbose) + +def update_file(filename, original_year_fn=original_year, authors_fn=authors, + dry_run=False, verbose=0): + f = file(filename, 'r') + contents = f.read() + f.close() + + original_year = original_year_fn(filename) + authors = authors_fn(filename) + authors = _replace_aliases(authors, with_email=True, aliases=ALIASES) + + new_contents = _update_copyright(contents, original_year, authors) + _set_contents(filename, contents=new_contents, original_contents=contents, + dry_run=dry_run, verbose=verbose) + +def update_files(files=None, dry_run=False, verbose=0): + if files == None or len(files) == 0: + files = [] + for dirpath,dirnames,filenames in os.walk('.'): + for filename in filenames: + files.append(os.path.join(dirpath, filename)) + + for filename in files: + if ignored_file(filename) == True: + continue + update_file(filename, dry_run=dry_run, verbose=verbose) + +def test(): + import doctest + doctest.testmod() + +if __name__ == '__main__': + import optparse + import sys + + usage = """%%prog [options] [file ...] + +Update copyright information in source code with information from +the %(vcs)s repository. Run from the %(project)s repository root. + +Replaces every line starting with '^# Copyright' and continuing with +'^#' with an auto-generated copyright blurb. If you want to add +#-commented material after a copyright blurb, please insert a blank +line between the blurb and your comment, so the next run of +``update_copyright.py`` doesn't clobber your comment. + +If no files are given, a list of files to update is generated +automatically. +""" % PROJECT_INFO + p = optparse.OptionParser(usage) + p.add_option('--test', dest='test', default=False, + action='store_true', help='Run internal tests and exit') + p.add_option('--dry-run', dest='dry_run', default=False, + action='store_true', help="Don't make any changes") + p.add_option('-v', '--verbose', dest='verbose', default=0, + action='count', help='Increment verbosity') + options,args = p.parse_args() + + if options.test == True: + test() + sys.exit(0) + + update_authors(dry_run=options.dry_run, verbose=options.verbose) + update_files(files=args, dry_run=options.dry_run, verbose=options.verbose)