docstr-coverage

import os from docstr_coverage import get_docstr_coverage # Create a dummy file for demonstration with open('example_module.py', 'w') as f: f.write("""""""Module docstring."""\n class MyClass:\n """Class docstring."""\n def __init__(self):\n # No docstring here - this will be reported\n pass\n\n def my_method(self, arg):\n """Method docstring."""\n return arg * 2\n""") # Run docstr-coverage programmatically report = get_docstr_coverage( paths=['example_module.py'], skip_init=False, skip_magic=True, skip_private=False, skip_class_innards=False, verbose=2 ) print(f"\nOverall coverage: {report['overall_coverage']:.2f}%") if report['missing_docstrings']: print("\nMissing docstrings found:") for item in report['missing_docstrings']: print(f" - {item['file']}:{item['line']} ({item['name']}) -> {item['type']}") # Clean up dummy file os.remove('example_module.py')