[go: up one dir, main page]

Add `tests` module in `pdoc` Documentation

Currently, the tests are not included as part of the online documentation, mainly due to the following error:

Exception occurred during processing of request from ('127.0.0.1', 34980)
Traceback (most recent call last):
  File "/usr/lib/python3.9/socketserver.py", line 316, in _handle_request_noblock
    self.process_request(request, client_address)
  File "/usr/lib/python3.9/socketserver.py", line 347, in process_request
    self.finish_request(request, client_address)
  File "/usr/lib/python3.9/socketserver.py", line 360, in finish_request
    self.RequestHandlerClass(request, client_address, self)
  File "/usr/lib/python3.9/socketserver.py", line 720, in __init__
    self.handle()
  File "/usr/lib/python3.9/http/server.py", line 427, in handle
    self.handle_one_request()
  File "/usr/lib/python3.9/http/server.py", line 415, in handle_one_request
    method()
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/pdoc/web.py", line 37, in do_GET
    self.wfile.write(self.handle_request().encode())
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/pdoc/web.py", line 76, in handle_request
    out = render.html_module(
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/pdoc/render.py", line 70, in html_module
    return env.select_template(
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/jinja2/environment.py", line 1090, in render
    self.environment.handle_exception()
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/jinja2/environment.py", line 832, in handle_exception
    reraise(*rewrite_traceback_stack(source=source))
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/jinja2/_compat.py", line 28, in reraise
    raise value.with_traceback(tb)
  File "html/module.html.jinja2", line 1, in top-level template code
    {% extends "default/module.html.jinja2" %}
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/pdoc/templates/default/module.html.jinja2", line 650, in top-level template code
    {%- if loop.nextitem %}.{% endif -%}
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/pdoc/templates/frame.html.jinja2", line 18, in top-level template code
    <body>{% block body %}{% endblock %}</body>
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/pdoc/templates/default/module.html.jinja2", line 722, in block "body"
    {% block module_contents %}
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/pdoc/templates/default/module.html.jinja2", line 729, in block "module_contents"
    {{ member(m) }}
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/jinja2/runtime.py", line 679, in _invoke
    rv = self._func(*arguments)
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/pdoc/templates/default/module.html.jinja2", line 557, in template
    {{ function(doc) }}
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/jinja2/runtime.py", line 679, in _invoke
    rv = self._func(*arguments)
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/pdoc/templates/default/module.html.jinja2", line 523, in template
    {{ decorators(fn) }}
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/jinja2/runtime.py", line 679, in _invoke
    rv = self._func(*arguments)
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/pdoc/templates/default/module.html.jinja2", line 514, in template
    {% for d in doc.decorators if not d.startswith("@_") %}
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/jinja2/environment.py", line 471, in getattr
    return getattr(obj, attribute)
  File "/usr/lib/python3.9/functools.py", line 969, in __get__
    val = self.func(instance)
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/pdoc/doc.py", line 767, in decorators
    for t in doc_ast.parse(obj).decorator_list:
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/pdoc/doc_ast.py", line 60, in parse
    return _parse_function(src)
  File "/home/max/Git/cobib/.direnv/python-3.9.2/lib/python3.9/site-packages/pdoc/doc_ast.py", line 196, in _parse_function
    tree = ast.parse(_dedent(source))
  File "/usr/lib/python3.9/ast.py", line 50, in parse
    return compile(source, filename, mode, flags,
  File "<unknown>", line 9
    @pytest.mark.parametrize(
IndentationError: unexpected indent
----------------------------------------

As you can see, the pytest-decorators appear to cause problems. I will have to investigate further.

Edited by Max Rossmannek