aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/python/setuptools/py3/setuptools/command/develop.py
blob: ec70008518322f067d7adddf01b3694cdc4cc6b7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
from distutils.util import convert_path 
from distutils import log 
from distutils.errors import DistutilsError, DistutilsOptionError 
import os 
import glob 
import io 
 
import pkg_resources
from setuptools.command.easy_install import easy_install 
from setuptools import namespaces
import setuptools 
 
 
class develop(namespaces.DevelopInstaller, easy_install):
    """Set up package for development""" 
 
    description = "install package in 'development mode'" 
 
    user_options = easy_install.user_options + [ 
        ("uninstall", "u", "Uninstall this source package"), 
        ("egg-path=", None, "Set the path to be used in the .egg-link file"), 
    ] 
 
    boolean_options = easy_install.boolean_options + ['uninstall'] 
 
    command_consumes_arguments = False  # override base 
 
    def run(self): 
        if self.uninstall: 
            self.multi_version = True 
            self.uninstall_link() 
            self.uninstall_namespaces()
        else: 
            self.install_for_development() 
        self.warn_deprecated_options() 
 
    def initialize_options(self): 
        self.uninstall = None 
        self.egg_path = None 
        easy_install.initialize_options(self) 
        self.setup_path = None 
        self.always_copy_from = '.'  # always copy eggs installed in curdir 
 
    def finalize_options(self): 
        ei = self.get_finalized_command("egg_info") 
        if ei.broken_egg_info: 
            template = "Please rename %r to %r before using 'develop'" 
            args = ei.egg_info, ei.broken_egg_info 
            raise DistutilsError(template % args) 
        self.args = [ei.egg_name] 
 
        easy_install.finalize_options(self) 
        self.expand_basedirs() 
        self.expand_dirs() 
        # pick up setup-dir .egg files only: no .egg-info 
        self.package_index.scan(glob.glob('*.egg')) 
 
        egg_link_fn = ei.egg_name + '.egg-link' 
        self.egg_link = os.path.join(self.install_dir, egg_link_fn) 
        self.egg_base = ei.egg_base 
        if self.egg_path is None: 
            self.egg_path = os.path.abspath(ei.egg_base) 
 
        target = pkg_resources.normalize_path(self.egg_base)
        egg_path = pkg_resources.normalize_path(
            os.path.join(self.install_dir, self.egg_path)
        )
        if egg_path != target: 
            raise DistutilsOptionError( 
                "--egg-path must be a relative path from the install" 
                " directory to " + target 
            ) 
 
        # Make a distribution for the package's source 
        self.dist = pkg_resources.Distribution(
            target, 
            pkg_resources.PathMetadata(target, os.path.abspath(ei.egg_info)),
            project_name=ei.egg_name,
        ) 
 
        self.setup_path = self._resolve_setup_path(
            self.egg_base,
            self.install_dir,
            self.egg_path,
        )

    @staticmethod
    def _resolve_setup_path(egg_base, install_dir, egg_path):
        """
        Generate a path from egg_base back to '.' where the
        setup script resides and ensure that path points to the
        setup path from $install_dir/$egg_path.
        """
        path_to_setup = egg_base.replace(os.sep, '/').rstrip('/')
        if path_to_setup != os.curdir:
            path_to_setup = '../' * (path_to_setup.count('/') + 1)
        resolved = pkg_resources.normalize_path(
            os.path.join(install_dir, egg_path, path_to_setup)
        )
        if resolved != pkg_resources.normalize_path(os.curdir):
            raise DistutilsOptionError( 
                "Can't get a consistent path to setup script from" 
                " installation directory",
                resolved,
                pkg_resources.normalize_path(os.curdir),
            )
        return path_to_setup
 
    def install_for_development(self): 
        self.run_command('egg_info')
 
        # Build extensions in-place
        self.reinitialize_command('build_ext', inplace=1)
        self.run_command('build_ext')
 
        if setuptools.bootstrap_install_from: 
            self.easy_install(setuptools.bootstrap_install_from) 
            setuptools.bootstrap_install_from = None 
 
        self.install_namespaces()

        # create an .egg-link in the installation dir, pointing to our egg 
        log.info("Creating %s (link to %s)", self.egg_link, self.egg_base) 
        if not self.dry_run: 
            with open(self.egg_link, "w") as f: 
                f.write(self.egg_path + "\n" + self.setup_path) 
        # postprocess the installed distro, fixing up .pth, installing scripts, 
        # and handling requirements 
        self.process_distribution(None, self.dist, not self.no_deps) 
 
    def uninstall_link(self): 
        if os.path.exists(self.egg_link): 
            log.info("Removing %s (link to %s)", self.egg_link, self.egg_base) 
            egg_link_file = open(self.egg_link) 
            contents = [line.rstrip() for line in egg_link_file] 
            egg_link_file.close() 
            if contents not in ([self.egg_path], [self.egg_path, self.setup_path]):
                log.warn("Link points to %s: uninstall aborted", contents) 
                return 
            if not self.dry_run: 
                os.unlink(self.egg_link) 
        if not self.dry_run: 
            self.update_pth(self.dist)  # remove any .pth link to us 
        if self.distribution.scripts: 
            # XXX should also check for entry point scripts! 
            log.warn("Note: you must uninstall or replace scripts manually!") 
 
    def install_egg_scripts(self, dist): 
        if dist is not self.dist: 
            # Installing a dependency, so fall back to normal behavior 
            return easy_install.install_egg_scripts(self, dist) 
 
        # create wrapper scripts in the script dir, pointing to dist.scripts 
 
        # new-style... 
        self.install_wrapper_scripts(dist) 
 
        # ...and old-style 
        for script_name in self.distribution.scripts or []: 
            script_path = os.path.abspath(convert_path(script_name)) 
            script_name = os.path.basename(script_path) 
            with io.open(script_path) as strm: 
                script_text = strm.read() 
            self.install_script(dist, script_name, script_text, script_path) 
 
    def install_wrapper_scripts(self, dist): 
        dist = VersionlessRequirement(dist) 
        return easy_install.install_wrapper_scripts(self, dist) 
 
 
class VersionlessRequirement:
    """ 
    Adapt a pkg_resources.Distribution to simply return the project 
    name as the 'requirement' so that scripts will work across 
    multiple versions. 
 
    >>> from pkg_resources import Distribution
    >>> dist = Distribution(project_name='foo', version='1.0') 
    >>> str(dist.as_requirement()) 
    'foo==1.0' 
    >>> adapted_dist = VersionlessRequirement(dist) 
    >>> str(adapted_dist.as_requirement()) 
    'foo' 
    """ 

    def __init__(self, dist): 
        self.__dist = dist 
 
    def __getattr__(self, name): 
        return getattr(self.__dist, name) 
 
    def as_requirement(self): 
        return self.project_name