File: plugin_distutils.py

package info (click to toggle)
dh-python 7.20260125
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,592 kB
  • sloc: python: 6,493; makefile: 605; perl: 251; sh: 36
file content (174 lines) | stat: -rw-r--r-- 6,417 bytes parent folder | download | duplicates (2)
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
# Copyright © 2012-2013 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
from collections.abc import Callable
from functools import wraps
from glob import glob1
from os import remove
from os.path import exists, isdir, join
from shutil import rmtree, move
from typing import (
    TYPE_CHECKING,
    Concatenate,
    Literal,
    ParamSpec,
    TypeVar,
    override
)

from dhpython.build.base import Base, shell_command, copy_test_files, create_setuptools_parallel_cfg
from dhpython.build.types import Args, Context

if TYPE_CHECKING:
    from functools import _Wrapped


log = logging.getLogger('dhpython')
_setup_tpl = 'setup.py|setup-3.py'


P = ParamSpec('P')
T = TypeVar('T')

def create_pydistutils_cfg(
    func: Callable[Concatenate["BuildSystem", Context, Args, P], T]
) -> "_Wrapped[Concatenate[BuildSystem, Context, Args, P], T, Concatenate[BuildSystem, Context, Args, P], T]":
    """distutils doesn't have sane command-line API - this decorator creates
    .pydistutils.cfg file to workaround it

    hint: if you think this is plain stupid, please don't read
    distutils/setuptools/distribute sources
    """

    @wraps(func)
    def wrapped_func(
        self: "BuildSystem",
        context: Context,
        args: Args,
        *oargs: P.args,
        **kwargs: P.kwargs
    ) -> T:
        fpath = join(args.home_dir, '.pydistutils.cfg')
        if not exists(fpath):
            with open(fpath, 'w', encoding='utf-8') as fp:
                lines = ['[clean]\n',
                         'all=1\n',
                         '[build]\n',
                         'build_lib={}\n'.format(args.build_dir),
                         '[install]\n',
                         'force=1\n',
                         'install_layout=deb\n',
                         'install_scripts=$base/bin\n',
                         'install_lib={}\n'.format(args.install_dir),
                         'prefix=/usr\n']
                log.debug('pydistutils config file:\n%s', ''.join(lines))
                fp.writelines(lines)
        context.ENV['HOME'] = args.home_dir
        return func(self, context, args, *oargs, **kwargs)

    return wrapped_func


class BuildSystem(Base):
    DESCRIPTION = 'Distutils build system'
    SUPPORTED_INTERPRETERS = {'python', 'python3', 'python{version}',
                              'python-dbg', 'python3-dbg', 'python{version}-dbg'}
    REQUIRED_FILES = [_setup_tpl]
    OPTIONAL_FILES = {'setup.cfg': 1,
                      'requirements.txt': 1,
                      'PKG-INFO': 10,
                      '*.egg-info': 10}
    CLEAN_FILES = Base.CLEAN_FILES | {'build'}

    @override
    def detect(self, context: Context) -> int:
        result = super().detect(context)
        if _setup_tpl in self.DETECTED_REQUIRED_FILES:
            context.args['setup_py'] = self.DETECTED_REQUIRED_FILES[_setup_tpl][0]
        else:
            context.args['setup_py'] = 'setup.py'
        return result

    @shell_command
    @create_pydistutils_cfg
    @override
    def clean(self, context: Context, args: Args) -> str | Literal[0]:
        super().clean(context, args)
        if exists(args.interpreter.binary()):
            return '{interpreter} {setup_py} clean {args}'
        return 0  # no need to invoke anything

    @shell_command
    @create_pydistutils_cfg
    @override
    def configure(self, context: Context, args: Args) -> str:
        return '{interpreter} {setup_py} config {args}'

    @shell_command
    @create_pydistutils_cfg
    @override
    def build(self, context: Context, args: Args) -> str:
        return '{interpreter.binary_dv} {setup_py} build {args}'

    @shell_command
    @create_setuptools_parallel_cfg()
    def _bdist_wheel(self, context: Context, args: Args) -> str:
        # pylint: disable=unused-argument
        try:
            # pylint: disable=unused-import
            import wheel  # type: ignore
        except ImportError:
            raise Exception("wheel is required to build wheels for distutils/setuptools packages. Build-Depend on python3-wheel.")
        # Don't build a wheel in the deb install layout
        fpath = join(args.home_dir, '.pydistutils.cfg')
        remove(fpath)
        return '{interpreter.binary_dv} -c "import setuptools, runpy; runpy.run_path(\'{setup_py}\')" bdist_wheel {args}'

    @override
    def build_wheel(self, context: Context, args: Args) -> None:
        self._bdist_wheel(context, args)
        dist_dir = join(args.dir, 'dist')
        wheels = glob1(dist_dir, '*.whl')
        n_wheels = len(wheels)
        if n_wheels != 1:
            raise Exception(f"Expected 1 wheel, found {n_wheels}")
        move(join(dist_dir, wheels[0]), args.home_dir)

    @shell_command
    @create_pydistutils_cfg
    @override
    def install(self, context: Context, args: Args) -> str:
        # remove egg-info dirs from build_dir
        for fname in glob1(args.build_dir, '*.egg-info'):
            fpath = join(args.build_dir, fname)
            if isdir(fpath):
                rmtree(fpath)
            else:
                remove(fpath)

        return '{interpreter.binary_dv} {setup_py} install --root {destdir} {args}'

    @shell_command
    @create_pydistutils_cfg
    @copy_test_files()
    @override
    def test(self, context: Context, args: Args) -> str:
        return super().test_cmd(context, args)