summaryrefslogtreecommitdiff
path: root/site_scons/zip_utils.py
blob: a38a68f23463785e02acb921f75a6e9fcf014daa (plain)
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
# MIT License
#
# Copyright The SCons Foundation
#
# 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.

"""
Actions to zip and unzip, for working with SCons release bundles
Action for creating a zipapp
"""

import os.path
import zipfile
import zipapp


def zipit(env, target, source):
    """Action function to zip *source* into *target*

    Values extracted from *env*:
      *CD*: the directory to work in
      *PSV*: the directory name to walk down to find the files
    """
    print(f"Zipping {target[0]}:")

    def visit(arg, dirname, filenames):
        for filename in filenames:
            path = os.path.join(dirname, filename)
            if os.path.isfile(path):
                arg.write(path)

    # default ZipFile compression is ZIP_STORED
    zf = zipfile.ZipFile(str(target[0]), 'w', compression=zipfile.ZIP_DEFLATED)
    olddir = os.getcwd()
    os.chdir(env.Dir(env['CD']).abspath)
    try:
        for dirname, dirnames, filenames in os.walk(env['PSV']):
            visit(zf, dirname, filenames)
    finally:
        os.chdir(olddir)
    zf.close()


def unzipit(env, target, source):
    """Action function to unzip *source*"""

    print(f"Unzipping {source[0]}:")
    zf = zipfile.ZipFile(str(source[0]), 'r')
    for name in zf.namelist():
        dest = os.path.join(env['UNPACK_ZIP_DIR'], name)
        dir = os.path.dirname(dest)
        os.makedirs(dir, exist_ok=True)
        print(dest, name)
        # if the file exists, then delete it before writing
        # to it so that we don't end up trying to write to a symlink:
        if os.path.isfile(dest) or os.path.islink(dest):
            os.unlink(dest)
        if not os.path.isdir(dest):
            with open(dest, 'wb') as fp:
                fp.write(zf.read(name))


def zipappit(env, target, source):
    """Action function to Create a zipapp *target* from specified directory.

    Values extracted from *env*:
      *CD*: the Dir node for the place we want to work.
      *PSV*: the directory name to point :meth:`zipapp.create_archive` at
        (note *source* is unused here in favor of PSV)
      *main*: the entry point for the zipapp
    """
    print(f"Creating zipapp {target[0]}:")
    dest = target[0].abspath
    olddir = os.getcwd()
    os.chdir(env['CD'].abspath)
    try:
        zipapp.create_archive(
            source=env['PSV'],
            target=dest,
            main=env['entry'],
            interpreter="/usr/bin/env python",
        )
    finally:
        os.chdir(olddir)