summaryrefslogtreecommitdiff
path: root/pydoc.py
blob: 8db292edc86b821a547fb42eb203fdcb51e6bbfb (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
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
#!/usr/bin/env python3
import json
import shutil
import tarfile
import tempfile
from pathlib import Path
from typing import Dict, List

import pkg_resources
import pydoctor.driver
import requests
import toml

# TODO: set USER_AGENT


def fetch_package_info(package_name: str):
    return requests.get(f'https://pypi.org/pypi/{package_name}/json').json()


def find_packages(path: Path, package_name: str) -> List[Path]:
    package_name = package_name.lower()

    if (path / package_name / '__init__.py').exists():
        return [path / package_name]

    if (path / 'src' / package_name / '__init__.py').exists():
        return [path / 'src' / package_name]

    packages = []

    for subpath in path.iterdir():
        if subpath.is_dir():
            if (subpath / '__init__.py').exists():
                packages.append(subpath)
    return packages


if __name__ == '__main__':
    sources = Path('sources')
    sources.mkdir(exist_ok=True)

    try:
        with open('versions.json') as f:
            versions = json.load(f)
    except FileNotFoundError:
        versions: Dict[str, str] = {}

    download_dir = Path(tempfile.mkdtemp(prefix='pydoc-'))

    # 1. fetch sources

    for package_name in (
        pkg_resources.resource_string(__name__, 'packages.txt').decode().splitlines()
    ):
        package = fetch_package_info(package_name)
        version = package['info']['version']

        sourceid = f'{package_name}-{version}'

        if (
            package_name not in versions
            or versions[package_name] != version
            or not (sources / sourceid).exists()
        ):
            print('downloading', sourceid)

            source_packages = [
                p for p in package['releases'][version] if p['packagetype'] == 'sdist'
            ]
            assert len(source_packages) > 0

            if len(source_packages) > 1:
                print(
                    f"[warning] {package_name} returned multiple source distributions, we're just using the first one"
                )

            source_package = source_packages[0]

            filename = source_package['filename']
            assert '/' not in filename  # for security

            archive_path = download_dir / filename

            with requests.get(source_package['url'], stream=True) as r:
                with open(archive_path, 'wb') as f:
                    shutil.copyfileobj(r.raw, f)

            tf = tarfile.open(archive_path)
            for member in tf.getmembers():
                if '/' in member.name:
                    member.name = member.name.split('/', maxsplit=1)[1]
                else:
                    member.name = '.'
            tf.extractall(sources / sourceid)
            versions[package_name] = version

    with open('versions.json', 'w') as f:
        json.dump(versions, f)

    shutil.rmtree(download_dir)

    with open('overrides.toml') as f:
        overrides = toml.load(f)

    # 2. generate docs with pydoctor

    dist = Path('dist')
    dist.mkdir(exist_ok=True)

    for path in sources.iterdir():
        sourceid = path.name
        package_name, version = sourceid.rsplit('-', maxsplit=1)
        out_dir = dist / package_name / version

        if out_dir.exists():
            continue

        print('generating', sourceid)

        packages = list(find_packages(sources / sourceid, package_name))

        if len(packages) == 0:
            print(
                '[error] failed to determine package directory for', sources / sourceid
            )
            continue

        if len(packages) > 1:
            print(
                f"[warning] found multiple packages for {package_name} ({packages}), we're just using the first one"
            )

        docformat = overrides['docformat'].get(package_name, 'restructuredtext')

        out_dir.mkdir(parents=True)
        pydoctor.driver.main(
            # fmt: off
            [
                str(packages[0]),
                '--html-output', out_dir,
                '--docformat', docformat,
            ]
            # fmt: on
        )

    # 3. create latest symlinks
    for package_name, version in versions.items():
        latest = dist / package_name / 'latest'
        latest.unlink(missing_ok=True)
        latest.symlink_to(version)