pypi/generator.py at main · GridTools/pypi · GitHub

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
"""Regenerates the index based on the specified folders.
"""
from typing import Final, Sequence

import hashlib
import pathlib
import re
import sys

#: The header for a html page.
#: It contains the opening `<body>` tag and has the `Titel` interpolation.
HTML_HEADER: Final[str] = """\
<!DOCTYPE HTML>
<html>
    <head>
        <title>{Title}</title>
        <meta charset="UTF-8" />
    </head>

    <body>
    <h1>{Title}</h1>
"""

#: Contains the footer of an html page.
#: This includes the closing `</body>` tag.
HTML_FOOTER: Final[str] = """\
    </body>
</html>
"""


def normalize_name(name: str) -> bool:
    """Normalize the project name according to the rules in PEP503."""
    return re.sub(r"[-_.]+", "-", name).lower()


def write_project_index(
    base_folder: pathlib.Path,
    project_name: str,
) -> int:
    """Generate the `index.html` file for a package.

    If no archive file was detected no `index.html` file is generated.
    """

    # Project folder must exists because we assume that the files are located inside.
    project_folder = base_folder / project_name
    if not project_folder.is_dir():
        raise NotADirectoryError(
            f"Expected that the project folder `{project_folder}` for project `{project_name}` exists."
    )

    found_packages = 0
    normalized_project_name = normalize_name(project_name)
    package_level_index_file = project_folder / "index.html"
    with open(package_level_index_file, "wt") as package_level_index:
        package_level_index.write(HTML_HEADER.format(Title=f"Custom Package for '{project_name}'"))

        for file in project_folder.iterdir():
            filename = file.name
            if filename.startswith(".") or not any(filename.endswith(ext) for ext in [".zip", ".tar.gz", ".whl"]):
                print(
                    f"While building the index for project '{project_name}' found non Python package file '{filename}', which will be ignored.",
                    file=sys.stderr,
                    flush=True,
                )
                continue
            assert filename.startswith(normalized_project_name + "-")

            # Compute the hash such that we can append it to the link.
            with open(file, "rb") as F:
                digest = hashlib.file_digest(F, "sha256")

            # PEP503 says that the text of the anchor element must be the filename, so there
            #  is not need for fancy processing of the file name. Furthermore, we assume that
            #  the file names have the correct normalized name and version.
            package_level_index.write(
                f'\t\t<a href="{filename}#sha256={digest.hexdigest()}">{filename}</a> </br>\n'.replace("\t", "    ")
            )
            found_packages += 1
        package_level_index.write(HTML_FOOTER)

    # If no package file was found remove the `index.html` file that was generated before.
    if found_packages == 0:
        package_level_index_file.unlink()

    return found_packages


def write_package_index(
    base_folder: pathlib.Path,
    packages: Sequence[str],
) -> None:

    with open(base_folder / "index.html", "wt") as top_level_index:
        top_level_index.write(HTML_HEADER.format(Title=f"Custom Package Index for GT4Py"))

        for project_name in packages:
            project_folder = base_folder / project_name
            normalized_project_name = normalize_name(project_name)
            if not project_folder.is_dir():
                print(
                    f"There is not folder associated to the project `{project_name}`, skipping it.",
                    flush=True,
                    file=sys.stderr,
                )
                continue

            # Now generate the index for that file.
            found_packages = write_project_index(base_folder, project_name)

            if found_packages == 0:
                # Consider "no packages" not as an error, only output a warning.
                print(
                    f"No packages for project `{project_name}` could be located.",
                    flush=True,
                    file=sys.stderr,
                )
                continue

            # Add an entry to the top level `index.html` file.
            top_level_index.write(f'\t\t<a href="{project_name}">{normalized_project_name}</a>\n'.replace("\t", "    "))

        top_level_index.write(HTML_FOOTER)


if __name__ == "__main__":
    write_package_index(
        base_folder=pathlib.Path(__file__).parent,
        packages=["dace", "ghex"],
    )