From: Vladimír Vondruš Date: Thu, 26 Sep 2024 17:16:50 +0000 (+0200) Subject: documentation/python: test annotation special cases in a less hacky way. X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=fe7f3d7983a8cd97f406504824bff521bef61e1d;p=blog.git documentation/python: test annotation special cases in a less hacky way. We can just pull those into a custom module with __all__, no need to modify directly math.__all__. This also means we don't need to worry about the module-level docstring. --- diff --git a/documentation/test_python/inspect_annotations/math373.html b/documentation/test_python/inspect_annotations/math373.html deleted file mode 100644 index 226e28ed..00000000 --- a/documentation/test_python/inspect_annotations/math373.html +++ /dev/null @@ -1,68 +0,0 @@ - - - - - math | My Python Project - - - - - -

- math module -

This module is always available. It provides access to the -mathematical functions defined by the C standard.

- -

Functions

- def pow(x, y, /) -: Return x**y (x to the power of y).
- def log(...) -: log(x, [base=math.e]) -Return the logarithm of x to the given base.

Function documentation

- def math.log(...) -

log(x, [base=math.e]) -Return the logarithm of x to the given base.

If the base not specified, returns the natural logarithm (base e) of x.

- - diff --git a/documentation/test_python/inspect_annotations/math.html b/documentation/test_python/inspect_builtin/inspect_builtin.html similarity index 83% rename from documentation/test_python/inspect_annotations/math.html rename to documentation/test_python/inspect_builtin/inspect_builtin.html index 982c3150..74a2585c 100644 --- a/documentation/test_python/inspect_annotations/math.html +++ b/documentation/test_python/inspect_builtin/inspect_builtin.html @@ -2,7 +2,7 @@ - math | My Python Project + inspect_builtin | My Python Project @@ -20,10 +20,8 @@

- math module + inspect_builtin module

This module provides access to the mathematical functions -defined by the C standard.

Function documentation

- def math.log(...) + def inspect_builtin.log(...)

log(x, [base=math.e]) Return the logarithm of x to the given base.

diff --git a/documentation/test_python/inspect_builtin/inspect_builtin.py b/documentation/test_python/inspect_builtin/inspect_builtin.py new file mode 100644 index 00000000..12a6d880 --- /dev/null +++ b/documentation/test_python/inspect_builtin/inspect_builtin.py @@ -0,0 +1,9 @@ +import sys +from math import log, pow + +__all__ = ['pow', 'log'] + +# Signature with / for pow() is not present in 3.6 so it makes no sense to have +# it there. +if sys.version_info < (3, 7): + __all__ = __all__[1:] diff --git a/documentation/test_python/inspect_annotations/math36.html b/documentation/test_python/inspect_builtin/inspect_builtin36.html similarity index 80% rename from documentation/test_python/inspect_annotations/math36.html rename to documentation/test_python/inspect_builtin/inspect_builtin36.html index 7301a216..b9e7b300 100644 --- a/documentation/test_python/inspect_annotations/math36.html +++ b/documentation/test_python/inspect_builtin/inspect_builtin36.html @@ -2,7 +2,7 @@ - math | My Python Project + inspect_builtin | My Python Project @@ -20,10 +20,8 @@

- math module + inspect_builtin module

This module is always available. It provides access to the -mathematical functions defined by the C standard.

Function documentation

- def math.log(...) + def inspect_builtin.log(...)

log(x[, base])

Return the logarithm of x to the given base. diff --git a/documentation/test_python/inspect_annotations/math39.html b/documentation/test_python/inspect_builtin/inspect_builtin39.html similarity index 83% rename from documentation/test_python/inspect_annotations/math39.html rename to documentation/test_python/inspect_builtin/inspect_builtin39.html index cb97c7fa..5711a4e9 100644 --- a/documentation/test_python/inspect_annotations/math39.html +++ b/documentation/test_python/inspect_builtin/inspect_builtin39.html @@ -2,7 +2,7 @@ - math | My Python Project + inspect_builtin | My Python Project @@ -20,10 +20,8 @@

- math module + inspect_builtin module

This module provides access to the mathematical functions -defined by the C standard.

Function documentation

- def math.log(...) + def inspect_builtin.log(...)

log(x, [base=math.e]) Return the logarithm of x to the given base.

diff --git a/documentation/test_python/test_inspect.py b/documentation/test_python/test_inspect.py index 05b7fc1d..fee28f5e 100644 --- a/documentation/test_python/test_inspect.py +++ b/documentation/test_python/test_inspect.py @@ -109,36 +109,23 @@ class Annotations(BaseInspectTestCase): else: self.assertEqual(*self.actual_expected_contents('inspect_annotations.AContainer.html', 'inspect_annotations.AContainer-py36-38.html')) - def test_math(self): - # From math export only pow() so we have the verification easier, and - # in addition log() because it doesn't provide any signature metadata - assert not hasattr(math, '__all__') - math.__all__ = ['log'] - # signature with / for pow() is not present in 3.6 so it makes no sense - # to have it - if sys.version_info >= (3, 7): - math.__all__ = ['pow'] + math.__all__ - - self.run_python({ - 'INPUT_MODULES': [math] - }) +class Builtin(BaseInspectTestCase): + def test(self): + self.run_python() - # 3.12 improves a docstring further. It got seemingly backported to - # 3.11.3 and 3.10.11 as well, but an actual build of 3.11.9 doesn't - # seem to have that, so checking this just on 3.12. + # log() and pow() from the builtin math module. 3.12 improves a + # docstring. It got seemingly backported to 3.11.3 and 3.10.11 as well, + # but an actual build of 3.11.9 doesn't seem to have that, so checking + # this just on 3.12. # https://github.com/python/cpython/pull/102049 if sys.version_info >= (3, 12): - file = 'math.html' - elif sys.version_info >= (3, 7, 4): - file = 'math39.html' - # 3.7.3 and below has a different docstring - # https://github.com/python/cpython/pull/13394 + file = 'inspect_builtin.html' elif sys.version_info >= (3, 7): - file = 'math373.html' - # signature with / for pow() is not present in 3.6 + file = 'inspect_builtin39.html' + # Signature with / for pow() is not present in 3.6 else: - file = 'math36.html' - self.assertEqual(*self.actual_expected_contents('math.html', file)) + file = 'inspect_builtin36.html' + self.assertEqual(*self.actual_expected_contents('inspect_builtin.html', file)) class NameMapping(BaseInspectTestCase): def test(self):