python3 3.2.3-0ubuntu1 / usr / bin / py3clean

#! /usr/bin/python3
# vim: et ts=4 sw=4

# Copyright © 2010 Piotr Ożarowski <piotr@debian.org>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.

import logging
import optparse
import sys
from glob import glob1
from os import environ, remove, rmdir, walk
from os.path import dirname, exists, isdir, isfile, join
from subprocess import Popen, PIPE
sys.path.insert(1, '/usr/share/python3/')
from debpython.version import SUPPORTED, getver, vrepr
from debpython.tools import get_magic_tags_map


# initialize script
logging.basicConfig(format='%(levelname).1s: %(module)s:%(lineno)d: '
                           '%(message)s')
log = logging.getLogger(__name__)

"""TODO: move it to manpage
Examples:
    py3clean -p python3-mako # all .py[co] files and __pycache__ directories from the package
    py3clean /usr/lib/python3.1/dist-packages # python3.1
    py3clean -V 3.3 /usr/lib/python3/ # python 3.3 only
    py3clean -V 3.3 /usr/lib/foo/bar.py # bar/__pycache__/bar.cpython-33.py[co]
    py3clean /usr/lib/python3/ # all Python 3.X
"""


def get_magic_tag_to_remove(version):
    """Returns magic tag or True if all of them should be removed."""
    map_ = get_magic_tags_map(set(SUPPORTED).union(set([version])))
    if version != (3, 1) and version not in map_:
        log.error('magic tag for %s not recognized', vrepr(version))
        exit(4)

    tag = map_[version]
    # skip shared tags
    for v, t in map_.items():
        if v == version:
            continue
        if t == tag:
            log.info('magic tag(s) used by python%s. Nothing to remove.',
                    vrepr(v))
            exit(0)

    log.debug('magic tags to remove: %s', tag)
    return tag


def destroyer(magic_tag=None):  # ;-)
    """Remove every .py[co] file associated to received .py file.

    :param magic_tag: if None, removes __pycache__ directories,
        if False, removes python3.1's .pyc files only,
        otherwise removes given magic tag from __pycache__ directory
    :type magic_tag: None or False or str"""
    if magic_tag is None:

        # remove all files in __pycache__ directory
        def find_files_to_remove(pyfile):
            directory = "%s/__pycache__/" % dirname(pyfile)
            for fn in glob1(directory, '*'):
                yield join(directory, fn)
            # remove "classic" .pyc files as well
            for filename in ("%sc" % pyfile, "%so" % pyfile):
                if exists(filename):
                    yield filename
    elif magic_tag is False:

        # remove 3.1's .pyc files only
        def find_files_to_remove(pyfile):
            for filename in ("%sc" % pyfile, "%so" % pyfile):
                if exists(filename):
                    yield filename
    else:

        # remove .pyc files for no longer needed magic tags
        def find_files_to_remove(pyfile):
            directory = "%s/__pycache__/" % dirname(pyfile)
            for fn in glob1(directory, "*.%s.py[co]" % magic_tag):
                yield join(directory, fn)

    def myremove(fname):
        remove(fname)
        directory = dirname(fname)
        # remove __pycache__ directory if it's empty
        if directory.endswith('__pycache__'):
            try:
                rmdir(directory)
            except:
                pass

    counter = 0
    try:
        while True:
            pyfile = (yield)
            for filename in find_files_to_remove(pyfile):
                try:
                    myremove(filename)
                    counter += 1
                except (IOError, OSError) as e:
                    log.error('cannot remove %s', filename)
                    log.debug(e)
    except GeneratorExit:
        log.info("removed files: %s", counter)


def get_files(items):
    for item in items:
        if isfile(item) and item.endswith('.py'):
            yield item
        elif isdir(item):
            for root, dirs, files in walk(item):
                #for fn in glob1(root, '*.py'):
                #    yield join(root, fn)
                for fn in files:
                    if fn.endswith('.py'):
                        yield join(root, fn)


def get_package_files(package_name):
    process = Popen("/usr/bin/dpkg -L %s" % package_name,\
                    shell=True, stdout=PIPE)
    stdout, stderr = process.communicate()
    if process.returncode != 0:
        log.error('cannot get content of %s', package_name)
        exit(2)
    stdout = str(stdout, 'utf-8')
    for line in stdout.split('\n'):
        if line.endswith('.py'):
            yield line


def main():
    usage = '%prog [-V VERSION] [-p PACKAGE | DIR_OR_FILE]'
    parser = optparse.OptionParser(usage, version='%prog 0.3')
    parser.add_option('-v', '--verbose', action='store_true', dest='verbose',
        help='turn verbose more one')
    parser.add_option('-q', '--quiet', action='store_false', dest='verbose',
        default=False, help='be quiet')
    parser.add_option('-p', '--package',
        help='specify Debian package name to clean')
    parser.add_option('-V', dest='version',
        help='specify Python version to clean')

    (options, args) = parser.parse_args()

    if options.verbose or environ.get('PYCLEAN_DEBUG') == '1':
        log.setLevel(logging.DEBUG)
        log.debug('argv: %s', sys.argv)
        log.debug('options: %s', options)
        log.debug('args: %s', args)
    else:
        log.setLevel(logging.WARNING)

    if options.version:
        if options.version.endswith('3.1'):  # 3.1, -3.1
            magic_tag = False
        else:
            magic_tag = get_magic_tag_to_remove(getver(options.version))
        d = destroyer(magic_tag)
    else:
        d = destroyer()  # remove everything
    next(d)  # initialize coroutine

    if options.package and args:
        parser.error('only one action is allowed at the same time ('
                     'cleaning directory or a package)')

    if options.package:
        log.info('cleaning package %s', options.package)
        for filename in get_package_files(options.package):
            d.send(filename)
    elif args:
        log.info('cleaning directories: %s', args)
        for filename in get_files(args):
            d.send(filename)
    else:
        parser.print_usage()
        exit(1)

if __name__ == '__main__':
    main()