Coudn't get/parse source of '<Module> 'xxxx''>'

[OscarVanL]

Expected Behavior

pdoc3 should create the documentation.

Actual Behavior

The console shows a cryptic error and no documentation is generated:

pdoc3 --html xxxxxx

c:\users\*****\appdata\local\programs\python\python36-32\lib\site-packages\pdoc\__init__.py:223: UserWarning: Couldn't get/parse source of '<Module 'xxxxxx'>'
  warn("Couldn't get/parse source of '{!r}'".format(doc_obj))
Traceback (most recent call last):
  File "C:\Users\*****\AppData\Local\Programs\Python\Python36-32\Scripts\pdoc3-script.py", line 11, in <module>
    load_entry_point('pdoc3==0.6.3', 'console_scripts', 'pdoc3')()
  File "c:\users\*****\appdata\local\programs\python\python36-32\lib\site-packages\pdoc\cli.py", line 442, in main
    for module in args.modules]
  File "c:\users\*****\appdata\local\programs\python\python36-32\lib\site-packages\pdoc\cli.py", line 442, in <listcomp>
    for module in args.modules]
  File "c:\users\*****\appdata\local\programs\python\python36-32\lib\site-packages\pdoc\__init__.py", line 605, in __init__
    context=self._context)
  File "c:\users\*****\appdata\local\programs\python\python36-32\lib\site-packages\pdoc\__init__.py", line 605, in __init__
    context=self._context)
  File "c:\users\*****\appdata\local\programs\python\python36-32\lib\site-packages\pdoc\__init__.py", line 569, in __init__
    self.doc[name] = Function(name, self, obj)
  File "c:\users\*****\appdata\local\programs\python\python36-32\lib\site-packages\pdoc\__init__.py", line 1020, in __init__
    assert callable(obj)
AssertionError

Steps to Reproduce

I ran pdoc3 --html xxxxxx where xxxxx is the module/folder containing various .py files containing classes, then this error popped up.

Additional info

• pdoc version: 0.6.3

[kernc]

Duplicate of #76.

[kernc]

Can you share a small example of failing code? Maybe it's not an exact duplicate after all ...

[OscarVanL]

I tried copying my source files into another folder and running pdoc --html test_folder each time I added a file, it ended up failing when I added the __init__.py file (which AFAIK is required for making modules in Python) to the folder.

The __init__.py file is an empty file, I simply made a new .txt file in Windows and renamed it to __init__.py

So maybe it doesn't like empty source files?

UserWarning: Couldn't get/parse source of '<Module 'test_folder'>'
  warn("Couldn't get/parse source of '{!r}'".format(doc_obj))

[OscarVanL]

However, if I delete the __init__.py folder from it still didn't solve the issue.

I tried moving files one-by-one out of my project folder, and when I removed my examples folder (a folder where I have one example implementations of my module) from it, pdoc ran successfully.

The source of this example implementation was as follows:

(removed source code, but to summarise I had a static function outside a class definition)

[kernc]

So maybe it doesn't like empty source files?

These are then two issues. The warning is just a warning (which, true, we might wish to avoid).

pdoc/pdoc/__init__.py

Lines 220 to 224 in 5d8974c

	try:
	tree = ast.parse(inspect.getsource(doc_obj.obj))
	except (OSError, TypeError, SyntaxError):
	warn("Couldn't get/parse source of '{!r}'".format(doc_obj))
	return {}

[kernc]

The source of this example implementation was as follows:

I believe it might be failing on misdefined staticmethod a_static_function. What is a staticmethod doing in a global namespace?

I agree pdoc should handle that better (maybe failing in a more verbose way).

[OscarVanL]

Yeah, fixing that static method definition placement made it work :) My bad!

It would be nicer if pdoc could state which python file was responsible for it not working. I have quite a few python files in this directory, so tracing which was responsible was a little difficult :)

Thanks for the help.

[stevegore]

I've also encountered this issue. It was caused by a @cached_property annotation.