ml-tooling / lazydocs

📖 Generate markdown API documentation from Google-style Python docstring. The lazy alternative to Sphinx.
MIT License
205 stars 38 forks source link

Typer --ignored-modules type conversion failure #27

Closed razy69 closed 2 years ago

razy69 commented 2 years ago

Hi,

There is a command line argument type conversion issue (related to Typer).

When "ignored_modules" is set multiple times, the variable is not converted into a list but into a tuple.

$ lazydocs ./app --ignored-modules "main" --ignored-modules "tests" --overview-file README.md
Source path:... /Users/razy69/.pyenv/versions/3.9.6/envs/test39/lib/python3.9/site-packages/lazydocs/generation.py
Starting var:.. paths = ('./app',)
Starting var:.. output_path = './docs/'
Starting var:.. src_root_path = None
Starting var:.. src_base_url = None
Starting var:.. remove_package_prefix = True
Starting var:.. ignored_modules = ('main', 'tests')
Starting var:.. overview_file = 'README.md'
Starting var:.. watermark = True
Starting var:.. validate = False
...
11:29:20.267269 line       963             for loader, module_name, _ in pkgutil.walk_packages([path]):
Modified var:.. loader = FileFinder('/Users/razy69/Dev/Git/test39/./app')
Modified var:.. module_name = 'main'
11:29:20.267590 line       964                 if _is_module_ignored(module_name, ignored_modules):
11:29:20.267795 line       966                     ignored_modules.append(module_name)
11:29:20.267957 exception  966                     ignored_modules.append(module_name)
Exception:..... AttributeError: 'tuple' object has no attribute 'append'

@hellowhistler wrote a fix, but it is not merged:

Typer PR -> https://github.com/tiangolo/typer/pull/143#pullrequestreview-805875789

github-actions[bot] commented 2 years ago

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 14 days