Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Allow passing multiple branches to build via CLI#235

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.

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

Already on GitHub?Sign in to your account

Merged
AA-Turner merged 12 commits intopython:mainfromhugovk:version-filter
Apr 11, 2025
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
Show all changes
12 commits
Select commitHold shift + click to select a range
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
7 changes: 7 additions & 0 deletions.coveragerc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
# .coveragerc to control coverage.py

[report]
# Regexes for lines to exclude from consideration
exclude_also =
# Don't complain if non-runnable code isn't run:
if __name__ == .__main__.:
7 changes: 7 additions & 0 deletions.github/workflows/test.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,3 +33,10 @@ jobs:
- name: Tox tests
run: |
uvx --with tox-uv tox -e py

- name: Upload coverage
uses: codecov/codecov-action@v5
with:
flags: ${{ matrix.os }}
name: ${{ matrix.os }} Python ${{ matrix.python-version }}
token: ${{ secrets.CODECOV_ORG_TOKEN }}
7 changes: 6 additions & 1 deletionREADME.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
# docsbuild-scripts

[![GitHub Actions status](https://github.com/python/docsbuild-scripts/actions/workflows/test.yml/badge.svg)](https://github.com/python/docsbuild-scripts/actions/workflows/test.yml)
[![Codecov](https://codecov.io/gh/python/docsbuild-scripts/branch/main/graph/badge.svg)](https://codecov.io/gh/python/docsbuild-scripts)

This repository contains scripts for automatically building the Python
documentation on [docs.python.org](https://docs.python.org).

Expand All@@ -12,7 +17,7 @@ python3 ./build_docs.py --quick --build-root ./build_root --www-root ./www --log
```

If you don't need to build all translations of all branches, add
`--language en --branch main`.
`--languages en --branches main`.


## Check current version
Expand Down
19 changes: 10 additions & 9 deletionsbuild_docs.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -86,16 +86,17 @@ def from_json(cls, data) -> Versions:
)
return cls(versions)

def filter(self,branch:str ="") -> Sequence[Version]:
def filter(self,branches: Sequence[str] =()) -> Sequence[Version]:
"""Filter the given versions.

If *branch* is given, only *versions* matching *branch* are returned.
If *branches* is given, only *versions* matching *branches* are returned.

Else all live versions are returned (this means no EOL and no
security-fixes branches).
"""
if branch:
return [v for v in self if branch in (v.name, v.branch_or_tag)]
if branches:
branches = frozenset(branches)
return [v for v in self if {v.name, v.branch_or_tag} & branches]
return [v for v in self if v.status not in {"EOL", "security-fixes"}]

@property
Expand DownExpand Up@@ -935,9 +936,10 @@ def parse_args():
)
parser.add_argument(
"-b",
"--branch",
"--branches",
nargs="*",
metavar="3.12",
help="Version to build (defaults to all maintained branches).",
help="Versions to build (defaults to all maintained branches).",
)
parser.add_argument(
"-r",
Expand DownExpand Up@@ -971,7 +973,6 @@ def parse_args():
)
parser.add_argument(
"--languages",
"--language",
nargs="*",
help="Language translation, as a PEP 545 language tag like"
" 'fr' or 'pt-br'. "
Expand DownExpand Up@@ -1045,10 +1046,10 @@ def build_docs(args: argparse.Namespace) -> bool:
# This runs languages in config.toml order and versions newest first.
todo = [
(version, language)
for version in versions.filter(args.branch)
for version in versions.filter(args.branches)
for language in reversed(languages.filter(args.languages))
]
del args.branch
del args.branches
del args.languages

build_succeeded = set()
Expand Down
62 changes: 62 additions & 0 deletionstests/test_build_docs_versions.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
from build_docs import Versions, Version


def test_filter_default() -> None:
# Arrange
versions = Versions([
Version("3.14", status="feature"),
Version("3.13", status="bugfix"),
Version("3.12", status="bugfix"),
Version("3.11", status="security"),
Version("3.10", status="security"),
Version("3.9", status="security"),
])

# Act
filtered = versions.filter()

# Assert
assert filtered == [
Version("3.14", status="feature"),
Version("3.13", status="bugfix"),
Version("3.12", status="bugfix"),
]


def test_filter_one() -> None:
# Arrange
versions = Versions([
Version("3.14", status="feature"),
Version("3.13", status="bugfix"),
Version("3.12", status="bugfix"),
Version("3.11", status="security"),
Version("3.10", status="security"),
Version("3.9", status="security"),
])

# Act
filtered = versions.filter(["3.13"])

# Assert
assert filtered == [Version("3.13", status="security")]


def test_filter_multiple() -> None:
# Arrange
versions = Versions([
Version("3.14", status="feature"),
Version("3.13", status="bugfix"),
Version("3.12", status="bugfix"),
Version("3.11", status="security"),
Version("3.10", status="security"),
Version("3.9", status="security"),
])

# Act
filtered = versions.filter(["3.13", "3.14"])

# Assert
assert filtered == [
Version("3.14", status="feature"),
Version("3.13", status="security"),
]
13 changes: 12 additions & 1 deletiontox.ini
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,8 +12,19 @@ skip_install = true
deps =
-r requirements.txt
pytest
pytest-cov
pass_env =
FORCE_COLOR
set_env =
COVERAGE_CORE = sysmon
commands =
{envpython} -m pytest {posargs}
{envpython} -m pytest \
--cov . \
--cov tests \
--cov-report html \
--cov-report term \
--cov-report xml \
{posargs}

[testenv:lint]
skip_install = true
Expand Down
[8]ページ先頭
©2009-2025 Movatter.jp