10000 GH-121970: Modernise the patchlevel extension by AA-Turner · Pull Request #121995 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

GH-121970: Modernise the patchlevel extension #121995

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 4 commits into from
Jul 20, 2024
Merged

GH-121970: Modernise the patchlevel extension #121995

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
af4cc37
GH-121970: Modernise patchlevel
AA-Turner Jul 18, 2024
32ef09a
Merge branch 'main' into docs/patchlevel
AA-Turner Jul 19, 2024
c1966bf
Apply Ruff
AA-Turner Jul 19, 2024
a7c389a
Formatting niceties
AA-Turner Jul 20, 2024
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
Next Next commit
GH-121970: Modernise patchlevel
  • Loading branch information
@AA-Turner
AA-Turner committed Jul 18, 2024
commit af4cc378780ef1765562d2a743fa965a1063060d
2 changes: 1 addition & 1 deletion Doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@

# We look for the Include/patchlevel.h file in the current Python source tree
# and replace the values accordingly.
import patchlevel
import patchlevel # tools/extensions/patchlevel.py
version, release = patchlevel.get_version_info()

rst_epilog = f"""
Expand Down
107 changes: 58 additions & 49 deletions Doc/tools/extensions/patchlevel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,68 +1,77 @@
# -*- coding: utf-8 -*-
"""
patchlevel.py
~~~~~~~~~~~~~

Extract version info from Include/patchlevel.h.
Adapted from Doc/tools/getversioninfo.
"""Extract version info from Include/patchlevel.h.

:copyright: 2007-2008 by Georg Brandl.
:license: Python license.
Adapted from Doc/tools/getversioninfo.
"""

from __future__ import print_function

import os
import re
import sys
import typing
from pathlib import Path

CPYTHON_ROOT = Path(
__file__, # cpython/Doc/tools/extensions/patchlevel.py
'..', # cpython/Doc/tools/extensions
'..', # cpython/Doc/tools
'..', # cpython/Doc
'..', # cpython
).resolve()
PATCHLEVEL_H = CPYTHON_ROOT / 'Include' / 'patchlevel.h'

RELEASE_LEVELS = {
'PY_RELEASE_LEVEL_ALPHA': 'alpha',
'PY_RELEASE_LEVEL_BETA': 'beta',
'PY_RELEASE_LEVEL_GAMMA': 'candidate',
'PY_RELEASE_LEVEL_FINAL': 'final',
}

def get_header_version_info(srcdir):
patchlevel_h = os.path.join(srcdir, '..', 'Include', 'patchlevel.h')

# This won't pick out all #defines, but it will pick up the ones we
# care about.
rx = re.compile(r'\s*#define\s+([a-zA-Z][a-zA-Z_0-9]*)\s+([a-zA-Z_0-9]+)')
class version_info(typing.NamedTuple):
major: int #: Major release number
minor: int #: Minor release number
micro: int #: Patch release number
releaselevel: typing.Literal['alpha', 'beta', 'candidate', 'final']
serial: int #: Serial release number


def get_header_version_info() -> version_info:
# Capture PY_ prefixed #defines.
pat = re.compile(r'\s*#define\s+(PY_\w*)\s+(\w+)', re.ASCII)

d = {}
with open(patchlevel_h) as f:
for line in f:
m = rx.match(line)
if m is not None:
name, value = m.group(1, 2)
d[name] = value

release = version = '%s.%s' % (d['PY_MAJOR_VERSION'], d['PY_MINOR_VERSION'])
micro = int(d['PY_MICRO_VERSION'])
release += '.' + str(micro)

level = d['PY_RELEASE_LEVEL']
suffixes = {
'PY_RELEASE_LEVEL_ALPHA': 'a',
'PY_RELEASE_LEVEL_BETA': 'b',
'PY_RELEASE_LEVEL_GAMMA': 'rc',
}
if level != 'PY_RELEASE_LEVEL_FINAL':
release += suffixes[level] + str(int(d['PY_RELEASE_SERIAL']))
return version, release
patchlevel_h = PATCHLEVEL_H.read_text(encoding='utf-8')
for line in patchlevel_h.splitlines():
if (m := pat.match(line)) is not None:
name, value = m.groups()
d[name] = value

return version_info(
major=int(d['PY_MAJOR_VERSION']),
minor=int(d['PY_MINOR_VERSION']),
micro=int(d['PY_MICRO_VERSION']),
releaselevel=RELEASE_LEVELS[d['PY_RELEASE_LEVEL']],
serial=int(d['PY_RELEASE_SERIAL']),
)

def get_sys_version_info():
major, minor, micro, level, serial = sys.version_info
release = version = '%s.%s' % (major, minor)
release += '.%s' % micro
if level != 'final':
release += '%s%s' % (level[0], serial)

def format_version_info(info: version_info) -> tuple[str, str]:
version = f'{info.major}.{info.minor}'
release = f'{info.major}.{info.minor}.{info.micro}'
if info.releaselevel != 'final':
suffix = {'alpha': 'a', 'beta': 'b', 'candidate': 'rc'}
release += f'{suffix[info.releaselevel]}{info.serial}'
return version, release


def get_version_info():
try:
return get_header_version_info('.')
except (IOError, OSError):
version, release = get_sys_version_info()
print('Can\'t get version info from Include/patchlevel.h, ' \
'using version of this interpreter (%s).' % release, file=sys.stderr)
info = get_header_version_info()
return format_version_info(info)
except OSError:
version, release = format_version_info(sys.version_info)
print(f"Can't get version info from Include/patchlevel.h, "
f"using version of this interpreter ({release}).", file=sys.stderr)
return version, release


if __name__ == '__main__':
print(get_header_version_info('.')[1])
print(format_version_info(get_header_version_info())[1])
Loading
0