Пример #1
0
def _test_process_docstring(lines, obj_in_package):
    t = build_sphinx.build_sphinx(Distribution())
    originals = lines[:]

    with patch.object(t, "_obj_in_package", return_value=obj_in_package):
        t._process_docstring("foo", lines)

    return originals
Пример #2
0
def test_process_docstring__accepts_doctests_the_same_package():
    t = build_sphinx.build_sphinx(Distribution())
    lines = [">>> print('hello')"]
    expected_lines = lines[:]

    with patch.object(t, "_obj_in_package", return_value=True):
        t._process_docstring("foo", lines)

    assert expected_lines
Пример #3
0
def test_make_sphinx_setup__autodoc_external_methods_is_not_set():
    t = build_sphinx.build_sphinx(Distribution())
    t.autodoc_external_methods = False
    t._skip_member = Mock()
    prev_setup = Mock()
    app = Mock()

    setup = t._make_sphinx_setup(prev_setup)

    setup(app)

    prev_setup.assert_called_once_with(app)
    app.connect.assert_called_once_with("autodoc-skip-member", ANY)
    app.connect.call_args[0][1]("app", "what", "name", "obj", "opts", "lines")

    t._skip_member.assert_called_once_with("obj")
Пример #4
0
def test_make_sphinx_setup__autodoc_external_methods_is_set():
    t = build_sphinx.build_sphinx(Distribution())
    t.autodoc_external_methods = True
    t._process_docstring = Mock()
    prev_setup = Mock()
    app = Mock()

    setup = t._make_sphinx_setup(prev_setup)

    setup(app)

    prev_setup.assert_called_once_with(app)
    app.connect.assert_called_once_with("autodoc-process-docstring", ANY)
    app.connect.call_args[0][1]("app", "what", "name", "obj", "opts", "lines")

    t._process_docstring.assert_called_once_with("obj", "lines")
Пример #5
0
def test_run_sphinx():
    t = build_sphinx.build_sphinx(Distribution(attrs={"name": "RunSphinx",
                                                      "version": sentinel.v}))
    t._make_sphinx_setup = Mock()
    t.all_files = sentinel.all_files
    builder_name = "my_builder"

    sphinx_mock = {"Sphinx": Mock()}
    makedirs_mock = Mock()

    expected_build_dir = os.path.join(t.build_dir, builder_name)
    expected_doc_dir = os.path.join(t.build_dir, "doctrees")

    with ExitStack() as stack:
        stack.enter_context(_mock_modules({"sphinx.application": sphinx_mock}))
        stack.enter_context(patch("os.path.isdir", return_value=False))
        stack.enter_context(patch("os.makedirs", new=makedirs_mock))
        stack.enter_context(patch("os.path.abspath",
                                  new=lambda f: "ABS: " + f))
        t.run_sphinx(builder_name)

    # Check directories were created
    calls = [call(t.build_dir),
             call(expected_doc_dir),
             call(expected_build_dir)]
    makedirs_mock.assert_has_calls(calls, any_order=True)

    sphinx = sphinx_mock["Sphinx"]
    sphinx.assert_called_once_with(srcdir="ABS: " + t.source_dir,
                                   confdir="ABS: " + t.source_dir,
                                   outdir="ABS: " + expected_build_dir,
                                   doctreedir="ABS: " + expected_doc_dir,
                                   buildername=builder_name,
                                   confoverrides={"version": sentinel.v,
                                                  "release": sentinel.v},
                                   status=sys.stdout,
                                   freshenv=False)
Пример #6
0
def _test_run(mocks, attrs={}, run_sphinx_rc=0):
    dist_attrs = {"name": "RunSphinx", "version": sentinel.v}
    t = build_sphinx.build_sphinx(Distribution(attrs=dist_attrs))
    for k, v in attrs.items():
        setattr(t, k, v)
    t.run_sphinx = Mock(return_value=run_sphinx_rc)

    with ExitStack() as stack:
        fbg = stack.enter_context(patch(_cmd + ".fetch_build_eggs"))
        d_autodoc = stack.enter_context(patch(_cmd + ".dynamicautodoc"))
        autodoc = stack.enter_context(patch(_cmd + ".autodoc"))
        mocks["dynamicautodoc"] = d_autodoc
        mocks["autodoc"] = autodoc
        mocks["cmd"] = t
        try:
            t.run()
        except:
            # Need to re-raise here because of some weird `pytest.raises`
            # and `ExitStack` incompatibility bug surfacing on Python 2, which
            # causes the underlying exception to be returned instead of:
            # `py._code.code.ExceptionInfo`
            raise
        finally:
            assert fbg.called_once_with(["Sphinx", "numpydoc"])
Пример #7
0
def test_skip_member__skips_obj_having_name_starting_with_underscore():
    t = build_sphinx.build_sphinx(Distribution())
    with patch.object(t, "_obj_in_package", return_value=True):
        assert t._skip_member(Mock(__name__="_foo"))
Пример #8
0
def test_skip_member__rejects_obj_from_another_package():
    t = build_sphinx.build_sphinx(Distribution())
    with patch.object(t, "_obj_in_package", return_value=False):
        assert t._skip_member("foo")
Пример #9
0
def test_skip_member__accepts_obj_from_the_same_package():
    t = build_sphinx.build_sphinx(Distribution())
    with patch.object(t, "_obj_in_package", return_value=True):
        assert not t._skip_member("foo")
Пример #10
0
def _test_obj_in_package(pkg_name, obj):
    t = build_sphinx.build_sphinx(Distribution(attrs={"name": pkg_name}))
    return t._obj_in_package(obj)
Пример #11
0
def test_finilize_options__negates_doc_test_options(no_doctest):
    t = build_sphinx.build_sphinx(Distribution())
    t.no_doctest = no_doctest
    t.finalize_options()
    assert t.doctest == (not no_doctest)
Пример #12
0
def test_initialize_options__uses_reasonable_defaults():
    t = build_sphinx.build_sphinx(Distribution())
    assert t.build_dir == 'build/sphinx'
    assert t.source_dir == 'docs'