install_data.py 2.87 KB
Newer Older
1 2 3 4 5 6 7
"""distutils.command.install_data

Implements the Distutils 'install_data' command, for installing
platform-independent data files."""

# contributed by Bastian Kleineidam

8
# This module should be kept compatible with Python 2.1.
9

10 11
__revision__ = "$Id$"

12 13 14
import os
from types import StringType
from distutils.core import Command
15
from distutils.util import change_root, convert_path
16

17
class install_data (Command):
18 19 20

    description = "install data files"

21 22
    user_options = [
        ('install-dir=', 'd',
23
         "base directory for installing data files "
24
         "(default: installation base dir)"),
25 26
        ('root=', None,
         "install everything relative to this alternate root directory"),
27
        ('force', 'f', "force installation (overwrite existing files)"),
28 29
        ]

30 31
    boolean_options = ['force']

32 33
    def initialize_options (self):
        self.install_dir = None
34
        self.outfiles = []
35
        self.root = None
36
        self.force = 0
37

38
        self.data_files = self.distribution.data_files
39
        self.warn_dir = 1
40

41
    def finalize_options (self):
42
        self.set_undefined_options('install',
Greg Ward's avatar
Greg Ward committed
43 44
                                   ('install_data', 'install_dir'),
                                   ('root', 'root'),
45
                                   ('force', 'force'),
Greg Ward's avatar
Greg Ward committed
46
                                  )
47 48

    def run (self):
49 50
        self.mkpath(self.install_dir)
        for f in self.data_files:
51
            if type(f) is StringType:
52
                # it's a simple file, so copy it
53
                f = convert_path(f)
54 55 56 57
                if self.warn_dir:
                    self.warn("setup script did not provide a directory for "
                              "'%s' -- installing right in '%s'" %
                              (f, self.install_dir))
58
                (out, _) = self.copy_file(f, self.install_dir)
59
                self.outfiles.append(out)
60
            else:
61
                # it's a tuple with path to install to and a list of files
62
                dir = convert_path(f[0])
63 64 65
                if not os.path.isabs(dir):
                    dir = os.path.join(self.install_dir, dir)
                elif self.root:
66
                    dir = change_root(self.root, dir)
67
                self.mkpath(dir)
68 69 70 71 72 73 74 75 76 77 78 79

                if f[1] == []:
                    # If there are no files listed, the user must be
                    # trying to create an empty directory, so add the
                    # directory to the list of output files.
                    self.outfiles.append(dir)
                else:
                    # Copy files, adding them to the list of output files.
                    for data in f[1]:
                        data = convert_path(data)
                        (out, _) = self.copy_file(data, dir)
                        self.outfiles.append(out)
80 81

    def get_inputs (self):
82 83 84
        return self.data_files or []

    def get_outputs (self):
85
        return self.outfiles