Welcome to mirror list, hosted at ThFree Co, Russian Federation.

test_ext_autodoc_preserve_defaults.py « tests - github.com/sphinx-doc/sphinx.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: bb239a2bbdf6f587445f728b0d4c658f0b138ec3 (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
"""Test the autodoc extension.
"""

import sys

import pytest

from .test_ext_autodoc import do_autodoc


@pytest.mark.sphinx('html', testroot='ext-autodoc',
                    confoverrides={'autodoc_preserve_defaults': True})
def test_preserve_defaults(app):
    if sys.version_info < (3, 8):
        color = "16777215"
    else:
        color = "0xFFFFFF"

    options = {"members": None}
    actual = do_autodoc(app, 'module', 'target.preserve_defaults', options)
    assert list(actual) == [
        '',
        '.. py:module:: target.preserve_defaults',
        '',
        '',
        '.. py:class:: Class()',
        '   :module: target.preserve_defaults',
        '',
        '   docstring',
        '',
        '',
        '   .. py:method:: Class.meth(name: str = CONSTANT, sentinel: typing.Any = '
        'SENTINEL, now: datetime.datetime = datetime.now(), color: int = %s) -> None' % color,
        '      :module: target.preserve_defaults',
        '',
        '      docstring',
        '',
        '',
        '.. py:function:: foo(name: str = CONSTANT, sentinel: typing.Any = SENTINEL, '
        'now: datetime.datetime = datetime.now(), color: int = %s) -> None' % color,
        '   :module: target.preserve_defaults',
        '',
        '   docstring',
        '',
    ]