1. SCons
  2. Core
  3. SCons


Clone wiki

SCons / ArchiveBuilder

Archive Builder

The ArchiveBuilder can build a tarfile or a zipfile with an internal directory structure. You can specify a list of directories and/or files to be included as sources for your target. There is also a 'Files' function that allows to recursively build a list of files matching a list of include patterns and not matching a list of exclude patterns.

Save this file as 'archive.py' and put it somewhere accessible from your environment.

  • Original file by Nicolas Rougier.
#! /usr/bin/env python
# Copyright 2007 Nicolas Rougier
# 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
# 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, see <http://www.gnu.org/licenses/>.

""" Archive builder for scons 

Example usage (from you Sconstruct file):

from archive import Files, archive_builder


env.Append (BUILDERS = {'Archive' : archive_builder})


if 'dist-tgz' in COMMAND_LINE_TARGETS:
    archive = env.Archive ('archive.tgz',
                           Files ('.', include=['*'], exclude=['*~', '.*', '*.o']))
    env.Alias ('dist-tgz', archive)


from SCons.Script import *
import os, os.path
import fnmatch
import tarfile, zipfile

# _________________________________________________________________________Files
def Files (path, include = ['*'],  exclude= []):
    """ Recursively find files in path matching include patterns list
        and not matching exclude patterns

    files = []
    for filename in os.listdir (path):
        included = False
        excluded = False
        for pattern in include:
            if fnmatch.fnmatch (filename, pattern):
                included = True
                for pattern in exclude:
                    if fnmatch.fnmatch (filename, pattern):
                        excluded = True
        if included and not excluded:
            fullname = os.path.join (path, filename)
            if os.path.isdir (fullname):
                files.extend (Files (fullname, include, exclude))
                files.append (fullname)
    return files

# _______________________________________________________________________Archive
def Archive (target, source, env):
    """ Make an archive from sources """

    path = os.path.basename (str(target[0]))
    type = os.path.splitext (path)[-1]
    if type == '.tgz' or type == '.gz':
        archive = tarfile.open (path, 'w:gz')
    elif type == '.bz2':
        archive = tarfile.open (path, 'w:bz2')
    elif type == '.zip':
        archive = zipfile.ZipFile (path, 'w')
        archive.add = archive.write
        print "Unknown archive type (%s)" % type

    src = [str(s) for s in source if str(s) != path]
    for s in src:
        archive.add (s, os.path.join (os.path.basename (str(target[0])), s))

# _________________________________________________________________ArchiveString
def ArchiveString (target, source, env):
    """ Information string for Archive """
    return 'Making archive %s' % os.path.basename (str (target[0]))

archive_builder = Builder (action = SCons.Action.Action(Archive, ArchiveString))