Skip to content

Convert some relative imports to absolute #256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 11, 2025
Merged

Convert some relative imports to absolute #256

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 19 additions & 18 deletions build_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,22 @@

from __future__ import annotations

import argparse
import dataclasses
import datetime as dt
import filecmp
import json
import logging
import logging.handlers
import os
import re
import shlex
import shutil
import subprocess
import sys
from argparse import ArgumentParser, Namespace
from bisect import bisect_left as bisect
from contextlib import contextmanager, suppress
from dataclasses import dataclass
from datetime import datetime as dt, timezone
from functools import total_ordering
from os import getenv, readlink
from pathlib import Path
from string import Template
from time import perf_counter, sleep
Expand Down Expand Up @@ -68,7 +68,7 @@
HERE = Path(__file__).resolve().parent


@dataclass(frozen=True, slots=True)
@dataclasses.dataclass(frozen=True, slots=True)
class Versions:
_seq: Sequence[Version]

Expand Down Expand Up @@ -213,7 +213,7 @@ def picker_label(self):
return self.name


@dataclass(frozen=True, slots=True)
@dataclasses.dataclass(frozen=True, slots=True)
class Languages:
_seq: Sequence[Language]

Expand Down Expand Up @@ -250,7 +250,7 @@ def filter(self, language_tags: Sequence[str] = ()) -> Sequence[Language]:
return list(self)


@dataclass(order=True, frozen=True, kw_only=True)
@dataclasses.dataclass(order=True, frozen=True, kw_only=True)
class Language:
iso639_tag: str
name: str
Expand Down Expand Up @@ -337,7 +337,7 @@ def traverse(dircmp_result):
return changed


@dataclass
@dataclasses.dataclass
class Repository:
"""Git repository abstraction for our specific needs."""

Expand Down Expand Up @@ -505,7 +505,7 @@ def version_info():
)


@dataclass
@dataclasses.dataclass
class DocBuilder:
"""Builder for a CPython version and a language."""

Expand Down Expand Up @@ -539,7 +539,7 @@ def includes_html(self):
def run(self, http: urllib3.PoolManager) -> bool:
"""Build and publish a Python doc, for a language, and a version."""
start_time = perf_counter()
start_timestamp = dt.now(tz=timezone.utc).replace(microsecond=0)
start_timestamp = dt.datetime.now(tz=dt.UTC).replace(microsecond=0)
logging.info("Running.")
try:
if self.language.html_only and not self.includes_html:
Expand Down Expand Up @@ -861,7 +861,7 @@ def load_state(self) -> dict:
except (KeyError, FileNotFoundError):
return {}

def save_state(self, build_start: dt, build_duration: float, trigger: str):
def save_state(self, build_start: dt.datetime, build_duration: float, trigger: str):
"""Save current CPython sha1 and current translation sha1.

Using this we can deduce if a rebuild is needed or not.
Expand Down Expand Up @@ -932,8 +932,9 @@ def main():
def parse_args():
"""Parse command-line arguments."""

parser = ArgumentParser(
description="Runs a build of the Python docs for various branches."
parser = argparse.ArgumentParser(
description="Runs a build of the Python docs for various branches.",
allow_abbrev=False,
)
parser.add_argument(
"--select-output",
Expand Down Expand Up @@ -1032,7 +1033,7 @@ def setup_logging(log_directory: Path, select_output: str | None):
logging.getLogger().setLevel(logging.DEBUG)


def build_docs_with_lock(args: Namespace, lockfile_name: str) -> int:
def build_docs_with_lock(args: argparse.Namespace, lockfile_name: str) -> int:
try:
lock = zc.lockfile.LockFile(HERE / lockfile_name)
except zc.lockfile.LockError:
Expand All @@ -1045,7 +1046,7 @@ def build_docs_with_lock(args: Namespace, lockfile_name: str) -> int:
lock.close()


def build_docs(args) -> bool:
def build_docs(args: argparse.Namespace) -> bool:
"""Build all docs (each language and each version)."""
logging.info("Full build start.")
start_time = perf_counter()
Expand Down Expand Up @@ -1259,7 +1260,7 @@ def symlink(
if not directory_path.exists():
return # No touching link, dest doc not built yet.

if not link.exists() or readlink(link) != directory:
if not link.exists() or os.readlink(link) != directory:
# Link does not exist or points to the wrong target.
link.unlink(missing_ok=True)
link.symlink_to(directory)
Expand Down Expand Up @@ -1318,8 +1319,8 @@ def purge_surrogate_key(http: urllib3.PoolManager, surrogate_key: str) -> None:

https://www.fastly.com/documentation/reference/api/purging/#purge-tag
"""
service_id = getenv("FASTLY_SERVICE_ID", "__UNSET__")
fastly_key = getenv("FASTLY_TOKEN", "__UNSET__")
service_id = os.environ.get("FASTLY_SERVICE_ID", "__UNSET__")
fastly_key = os.environ.get("FASTLY_TOKEN", "__UNSET__")

logging.info("Purging Surrogate-Key '%s' from CDN", surrogate_key)
http.request(
Expand Down