183760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh"""distutils.command.install_data
283760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh
383760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew HsiehImplements the Distutils 'install_data' command, for installing
483760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsiehplatform-independent data files."""
583760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh
683760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh# contributed by Bastian Kleineidam
783760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh
883760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh__revision__ = "$Id$"
983760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh
1083760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsiehimport os
1183760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsiehfrom distutils.core import Command
1283760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsiehfrom distutils.util import change_root, convert_path
1383760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh
1483760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsiehclass install_data(Command):
1583760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh
1683760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh    description = "install data files"
1783760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh
1883760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh    user_options = [
1983760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh        ('install-dir=', 'd',
2083760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh         "base directory for installing data files "
2183760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh         "(default: installation base dir)"),
2283760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh        ('root=', None,
2383760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh         "install everything relative to this alternate root directory"),
2483760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh        ('force', 'f', "force installation (overwrite existing files)"),
2583760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh        ]
2683760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh
2783760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh    boolean_options = ['force']
2883760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh
2983760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh    def initialize_options(self):
3083760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh        self.install_dir = None
3183760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh        self.outfiles = []
3283760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh        self.root = None
3383760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh        self.force = 0
3483760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh        self.data_files = self.distribution.data_files
3583760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh        self.warn_dir = 1
3683760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh
3783760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh    def finalize_options(self):
3883760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh        self.set_undefined_options('install',
3983760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                                   ('install_data', 'install_dir'),
4083760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                                   ('root', 'root'),
4183760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                                   ('force', 'force'),
4283760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                                  )
4383760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh
4483760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh    def run(self):
4583760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh        self.mkpath(self.install_dir)
4683760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh        for f in self.data_files:
4783760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh            if isinstance(f, str):
4883760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                # it's a simple file, so copy it
4983760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                f = convert_path(f)
5083760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                if self.warn_dir:
5183760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                    self.warn("setup script did not provide a directory for "
5283760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                              "'%s' -- installing right in '%s'" %
5383760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                              (f, self.install_dir))
5483760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                (out, _) = self.copy_file(f, self.install_dir)
5583760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                self.outfiles.append(out)
5683760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh            else:
5783760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                # it's a tuple with path to install to and a list of files
5883760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                dir = convert_path(f[0])
5983760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                if not os.path.isabs(dir):
6083760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                    dir = os.path.join(self.install_dir, dir)
6183760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                elif self.root:
6283760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                    dir = change_root(self.root, dir)
6383760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                self.mkpath(dir)
6483760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh
6583760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                if f[1] == []:
6683760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                    # If there are no files listed, the user must be
6783760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                    # trying to create an empty directory, so add the
6883760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                    # directory to the list of output files.
6983760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                    self.outfiles.append(dir)
7083760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                else:
7183760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                    # Copy files, adding them to the list of output files.
7283760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                    for data in f[1]:
7383760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                        data = convert_path(data)
7483760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                        (out, _) = self.copy_file(data, dir)
7583760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh                        self.outfiles.append(out)
7683760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh
7783760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh    def get_inputs(self):
7883760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh        return self.data_files or []
7983760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh
8083760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh    def get_outputs(self):
8183760d213fb3bec7b4117d266fcfbf6fe2ba14abAndrew Hsieh        return self.outfiles
82