{"author":"Lynn Root","author_email":"lynn@lynnroot.com","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Natural Language :: English","Operating System :: OS Independent","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Topic :: Software Development :: Documentation","Topic :: Software Development :: Libraries :: Python Modules","Topic :: Software Development :: Quality Assurance"],"description":".. image:: https://interrogate.readthedocs.io/en/latest/_static/logo_pink.png\n :alt: Pink Sloth Logo\n\n=================================\n``interrogate``: explain yourself\n=================================\n\n.. image:: https://interrogate.readthedocs.io/en/latest/_static/interrogate_badge.svg\n :target: https://github.com/econchick/interrogate\n :alt: Documentation Coverage\n\n.. image:: https://codecov.io/gh/econchick/interrogate/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/econchick/interrogate\n :alt: Testing Coverage\n\n.. image:: https://readthedocs.org/projects/interrogate/badge/?version=latest&style=flat\n :target: https://interrogate.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://github.com/econchick/interrogate/workflows/CI/badge.svg?branch=master\n :target: https://github.com/econchick/interrogate/actions?workflow=CI\n :alt: CI Status\n\n.. start-readme\n\nInterrogate a codebase for docstring coverage.\n\nWhy Do I Need This?\n===================\n\n``interrogate`` checks your code base for missing docstrings.\n\nDocumentation should be as important as code itself. And it should live *within* code. Python `standardized `_ docstrings, allowing for developers to navigate libraries as simply as calling ``help()`` on objects, and with powerful tools like `Sphinx `_, `pydoc `_, and `Docutils `_ to automatically generate HTML, LaTeX, PDFs, etc.\n\n*Enter:* ``interrogate``.\n\n``interrogate`` will tell you which methods, functions, classes, and modules have docstrings, and which do not. Use ``interrogate`` to:\n\n* Get an understanding of how well your code is documented;\n* Add it to CI/CD checks to enforce documentation on newly-added code;\n* Assess a new code base for (one aspect of) code quality and maintainability.\n\nLet's get started.\n\nRequirements\n============\n\n``interrogate`` supports Python 3.8 and above.\n\n\nInstallation\n============\n\n``interrogate`` is available on `PyPI `_ and `GitHub `_. The recommended installation method is `pip `_-installing into a `virtualenv `_:\n\n.. code-block:: console\n\n $ pip install interrogate\n\nExtras\n------\n\n``interrogate`` provides a way to generate a `shields.io-like coverage badge <#other-usage>`_ as an **SVG file**.\nTo generate a **PNG file** instead, install ``interrogate`` with the extras ``[png]``:\n\n.. code-block:: console\n\n $ pip install interrogate[png]\n\n**NOTICE:** Additional system libraries/tools may be required in order to generate a PNG file of the coverage badge:\n\n* on Windows, install Visual C++ compiler for Cairo;\n* on macOS, install ``cairo`` and ``libffi`` (with Homebrew for example);\n* on Linux, install the ``cairo``, ``python3-dev`` and ``libffi-dev`` packages (names may vary depending on distribution).\n\nRefer to the ``cairosvg`` `documentation `_ for more information.\n\nUsage\n=====\n\nTry it out on a Python project:\n\n.. code-block:: console\n\n $ interrogate [PATH]\n RESULT: PASSED (minimum: 80.0%, actual: 100.0%)\n\n\nAdd verbosity to see a summary:\n\n.. code-block:: console\n\n $ interrogate -v [PATH]\n\n ================== Coverage for /Users/lynn/dev/interrogate/ ====================\n ------------------------------------ Summary ------------------------------------\n | Name | Total | Miss | Cover | Cover% |\n |---------------------------------------|---------|--------|---------|----------|\n | src/interrogate/__init__.py | 1 | 0 | 1 | 100% |\n | src/interrogate/__main__.py | 1 | 0 | 1 | 100% |\n | src/interrogate/badge_gen.py | 6 | 0 | 6 | 100% |\n | src/interrogate/cli.py | 2 | 0 | 2 | 100% |\n | src/interrogate/config.py | 8 | 0 | 8 | 100% |\n | src/interrogate/coverage.py | 27 | 0 | 27 | 100% |\n | src/interrogate/utils.py | 10 | 0 | 10 | 100% |\n | src/interrogate/visit.py | 18 | 0 | 18 | 100% |\n | tests/functional/__init__.py | 1 | 0 | 1 | 100% |\n | tests/functional/test_cli.py | 8 | 0 | 8 | 100% |\n | tests/functional/test_coverage.py | 10 | 0 | 10 | 100% |\n | tests/unit/__init__.py | 1 | 0 | 1 | 100% |\n | tests/unit/test_badge_gen.py | 8 | 0 | 8 | 100% |\n | tests/unit/test_config.py | 10 | 0 | 10 | 100% |\n | tests/unit/test_utils.py | 13 | 0 | 13 | 100% |\n |---------------------------------------|---------|--------|---------|----------|\n | TOTAL | 124 | 0 | 124 | 100.0% |\n ---------------- RESULT: PASSED (minimum: 80.0%, actual: 100.0%) ----------------\n\n\nAdd even *more* verbosity:\n\n\n.. code-block:: console\n\n $ interrogate -vv [PATH]\n\n ================== Coverage for /Users/lynn/dev/interrogate/ ====================\n ------------------------------- Detailed Coverage -------------------------------\n | Name | Status |\n |---------------------------------------------------------------------|---------|\n | src/interrogate/__init__.py (module) | COVERED |\n |---------------------------------------------------------------------|---------|\n | src/interrogate/__main__.py (module) | COVERED |\n |---------------------------------------------------------------------|---------|\n | src/interrogate/badge_gen.py (module) | COVERED |\n | save_badge (L42) | COVERED |\n | get_badge (L87) | COVERED |\n | should_generate_badge (L103) | COVERED |\n | get_color (L160) | COVERED |\n | create (L173) | COVERED |\n |---------------------------------------------------------------------|---------|\n | src/interrogate/cli.py (module) | COVERED |\n | main (L258) | COVERED |\n |---------------------------------------------------------------------|---------|\n | src/interrogate/config.py (module) | COVERED |\n | InterrogateConfig (L19) | COVERED |\n | find_project_root (L61) | COVERED |\n | find_project_config (L89) | COVERED |\n | parse_pyproject_toml (L100) | COVERED |\n | sanitize_list_values (L116) | COVERED |\n | parse_setup_cfg (L139) | COVERED |\n | read_config_file (L173) | COVERED |\n |---------------------------------------------------------------------|---------|\n | src/interrogate/coverage.py (module) | COVERED |\n | BaseInterrogateResult (L23) | COVERED |\n | BaseInterrogateResult.perc_covered (L37) | COVERED |\n | InterrogateFileResult (L54) | COVERED |\n | InterrogateFileResult.combine (L67) | COVERED |\n | InterrogateResults (L81) | COVERED |\n | InterrogateResults.combine (L93) | COVERED |\n | InterrogateCoverage (L101) | COVERED |\n | InterrogateCoverage._add_common_exclude (L121) | COVERED |\n | InterrogateCoverage._filter_files (L128) | COVERED |\n | InterrogateCoverage.get_filenames_from_paths (L141) | COVERED |\n | InterrogateCoverage._filter_nodes (L168) | COVERED |\n | InterrogateCoverage._filter_inner_nested (L194) | COVERED |\n | InterrogateCoverage._get_file_coverage (L203) | COVERED |\n | InterrogateCoverage._get_coverage (L231) | COVERED |\n | InterrogateCoverage.get_coverage (L248) | COVERED |\n | InterrogateCoverage._get_filename (L253) | COVERED |\n | InterrogateCoverage._get_detailed_row (L264) | COVERED |\n | InterrogateCoverage._create_detailed_table (L281) | COVERED |\n | InterrogateCoverage._create_detailed_table._sort_nodes (L288) | COVERED |\n | InterrogateCoverage._print_detailed_table (L315) | COVERED |\n | InterrogateCoverage._create_summary_table (L338) | COVERED |\n | InterrogateCoverage._print_summary_table (L381) | COVERED |\n | InterrogateCoverage._sort_results (L399) | COVERED |\n | InterrogateCoverage._get_header_base (L429) | COVERED |\n | InterrogateCoverage._print_omitted_file_count (L438) | COVERED |\n | InterrogateCoverage.print_results (L469) | COVERED |\n |---------------------------------------------------------------------|---------|\n | src/interrogate/utils.py (module) | COVERED |\n | parse_regex (L21) | COVERED |\n | smart_open (L40) | COVERED |\n | get_common_base (L60) | COVERED |\n | OutputFormatter (L80) | COVERED |\n | OutputFormatter.should_markup (L90) | COVERED |\n | OutputFormatter.set_detailed_markup (L105) | COVERED |\n | OutputFormatter.set_summary_markup (L129) | COVERED |\n | OutputFormatter._interrogate_line_formatter (L158) | COVERED |\n | OutputFormatter.get_table_formatter (L226) | COVERED |\n |---------------------------------------------------------------------|---------|\n | src/interrogate/visit.py (module) | COVERED |\n | CovNode (L15) | COVERED |\n | CoverageVisitor (L44) | COVERED |\n | CoverageVisitor._has_doc (L58) | COVERED |\n | CoverageVisitor._visit_helper (L65) | COVERED |\n | CoverageVisitor._is_nested_func (L112) | COVERED |\n | CoverageVisitor._is_nested_cls (L121) | COVERED |\n | CoverageVisitor._is_private (L133) | COVERED |\n | CoverageVisitor._is_semiprivate (L141) | COVERED |\n | CoverageVisitor._is_ignored_common (L151) | COVERED |\n | CoverageVisitor._has_property_decorators (L168) | COVERED |\n | CoverageVisitor._has_setters (L182) | COVERED |\n | CoverageVisitor._is_func_ignored (L193) | COVERED |\n | CoverageVisitor._is_class_ignored (L217) | COVERED |\n | CoverageVisitor.visit_Module (L221) | COVERED |\n | CoverageVisitor.visit_ClassDef (L228) | COVERED |\n | CoverageVisitor.visit_FunctionDef (L237) | COVERED |\n | CoverageVisitor.visit_AsyncFunctionDef (L246) | COVERED |\n |---------------------------------------------------------------------|---------|\n | tests/functional/__init__.py (module) | COVERED |\n |---------------------------------------------------------------------|---------|\n | tests/functional/test_cli.py (module) | COVERED |\n | runner (L22) | COVERED |\n | test_run_no_paths (L30) | COVERED |\n | test_run_shortflags (L77) | COVERED |\n | test_run_longflags (L106) | COVERED |\n | test_run_multiple_flags (L124) | COVERED |\n | test_generate_badge (L135) | COVERED |\n | test_incompatible_options (L170) | COVERED |\n |---------------------------------------------------------------------|---------|\n | tests/functional/test_coverage.py (module) | COVERED |\n | test_coverage_simple (L60) | COVERED |\n | test_coverage_errors (L73) | COVERED |\n | test_print_results (L101) | COVERED |\n | test_print_results_omit_covered (L130) | COVERED |\n | test_print_results_omit_none (L156) | COVERED |\n | test_print_results_omit_all_summary (L174) | COVERED |\n | test_print_results_omit_all_detailed (L198) | COVERED |\n | test_print_results_ignore_module (L226) | COVERED |\n | test_print_results_single_file (L253) | COVERED |\n |---------------------------------------------------------------------|---------|\n | tests/unit/__init__.py (module) | COVERED |\n |---------------------------------------------------------------------|---------|\n | tests/unit/test_badge_gen.py (module) | COVERED |\n | test_save_badge (L26) | COVERED |\n | test_save_badge_windows (L50) | COVERED |\n | test_save_badge_no_cairo (L62) | COVERED |\n | test_get_badge (L73) | COVERED |\n | test_should_generate (L96) | COVERED |\n | test_get_color (L115) | COVERED |\n | test_create (L136) | COVERED |\n |---------------------------------------------------------------------|---------|\n | tests/unit/test_config.py (module) | COVERED |\n | test_find_project_root (L29) | COVERED |\n | test_find_project_config (L48) | COVERED |\n | test_parse_pyproject_toml (L57) | COVERED |\n | test_sanitize_list_values (L93) | COVERED |\n | test_parse_setup_cfg (L98) | COVERED |\n | test_parse_setup_cfg_raises (L123) | COVERED |\n | test_read_config_file_none (L134) | COVERED |\n | test_read_config_file (L193) | COVERED |\n | test_read_config_file_raises (L207) | COVERED |\n |---------------------------------------------------------------------|---------|\n | tests/unit/test_utils.py (module) | COVERED |\n | test_parse_regex (L32) | COVERED |\n | test_smart_open (L39) | COVERED |\n | test_get_common_base (L69) | COVERED |\n | test_get_common_base_windows (L100) | COVERED |\n | test_output_formatter_should_markup (L132) | COVERED |\n | test_output_formatter_set_detailed_markup (L163) | COVERED |\n | test_output_formatter_set_summary_markup (L206) | COVERED |\n | test_output_formatter_interrogate_line_formatter (L258) | COVERED |\n | test_output_formatter_interrogate_line_formatter_windows (L319) | COVERED |\n | test_output_formatter_get_table_formatter (L343) | COVERED |\n | test_output_formatter_get_table_formatter_py38 (L381) | COVERED |\n | test_output_formatter_get_table_formatter_raises (L395) | COVERED |\n |---------------------------------------------------------------------|---------|\n\n ------------------------------------ Summary ------------------------------------\n | Name | Total | Miss | Cover | Cover% |\n |---------------------------------------|---------|--------|---------|----------|\n | src/interrogate/__init__.py | 1 | 0 | 1 | 100% |\n | src/interrogate/__main__.py | 1 | 0 | 1 | 100% |\n | src/interrogate/badge_gen.py | 6 | 0 | 6 | 100% |\n | src/interrogate/cli.py | 2 | 0 | 2 | 100% |\n | src/interrogate/config.py | 8 | 0 | 8 | 100% |\n | src/interrogate/coverage.py | 27 | 0 | 27 | 100% |\n | src/interrogate/utils.py | 10 | 0 | 10 | 100% |\n | src/interrogate/visit.py | 18 | 0 | 18 | 100% |\n | tests/functional/__init__.py | 1 | 0 | 1 | 100% |\n | tests/functional/test_cli.py | 8 | 0 | 8 | 100% |\n | tests/functional/test_coverage.py | 10 | 0 | 10 | 100% |\n | tests/unit/__init__.py | 1 | 0 | 1 | 100% |\n | tests/unit/test_badge_gen.py | 8 | 0 | 8 | 100% |\n | tests/unit/test_config.py | 10 | 0 | 10 | 100% |\n | tests/unit/test_utils.py | 13 | 0 | 13 | 100% |\n |---------------------------------------|---------|--------|---------|----------|\n | TOTAL | 124 | 0 | 124 | 100.0% |\n ---------------- RESULT: PASSED (minimum: 80.0%, actual: 100.0%) ----------------\n\nOther Usage\n===========\n\nGenerate a `shields.io `_ badge (like this one! |interrogate-badge| ):\n\n.. code-block:: console\n\n $ interrogate --generate-badge PATH\n RESULT: PASSED (minimum: 80.0%, actual: 100.0%)\n Generated badge to /Users/lynn/dev/interrogate/docs/_static/interrogate_badge.svg\n\n`See below <#badge-options>`_ for more badge configuration.\n\nAdd it to your ``tox.ini`` file to enforce a level of coverage:\n\n.. code-block:: ini\n\n [testenv:doc]\n deps = interrogate\n skip_install = true\n commands =\n interrogate --quiet --fail-under 95 src tests\n\nOr use it with `pre-commit `_:\n\n.. code-block:: yaml\n\n repos:\n - repo: https://github.com/econchick/interrogate\n rev: 1.7.0 # or master if you're bold\n hooks:\n - id: interrogate\n args: [--quiet, --fail-under=95]\n pass_filenames: false # needed if excluding files with pyproject.toml or setup.cfg\n\nUse it within your code directly:\n\n.. code-block:: pycon\n\n >>> from interrogate import coverage\n >>> cov = coverage.InterrogateCoverage(paths=[\"src\"])\n >>> results = cov.get_coverage()\n >>> results\n InterrogateResults(total=68, covered=65, missing=3)\n\n\nUse ``interrogate`` with `GitHub Actions `_. Check out the `action `_ written & maintained by `Jack McKew `_ (thank you, Jack!).\n\nOr use ``interrogate`` in VSCode with the `interrogate extension `_ written & maintained by `Kenneth Love `_ (thank you, Kenneth!).\n\nConfiguration\n=============\n\nConfigure within your ``pyproject.toml`` (``interrogate`` will automatically detect a ``pyproject.toml`` file and pick up default values for the command line options):\n\n.. code-block:: console\n\n $ interrogate -c pyproject.toml [OPTIONS] [PATHS]...\n\n.. code-block:: toml\n\n [tool.interrogate]\n ignore-init-method = true\n ignore-init-module = false\n ignore-magic = false\n ignore-semiprivate = false\n ignore-private = false\n ignore-property-decorators = false\n ignore-module = false\n ignore-nested-functions = false\n ignore-nested-classes = true\n ignore-setters = false\n ignore-overloaded-functions = false\n fail-under = 95\n exclude = [\"setup.py\", \"docs\", \"build\"]\n ignore-regex = [\"^get$\", \"^mock_.*\", \".*BaseClass.*\"]\n ext = []\n # possible values: sphinx (default), google\n style = sphinx\n # possible values: 0 (minimal output), 1 (-v), 2 (-vv)\n verbose = 0\n quiet = false\n whitelist-regex = []\n color = true\n omit-covered-files = false\n generate-badge = \".\"\n badge-format = \"svg\"\n\n\nOr configure within your ``setup.cfg`` (``interrogate`` will automatically detect a ``setup.cfg`` file and pick up default values for the command line options):\n\n.. code-block:: console\n\n $ interrogate -c setup.cfg [OPTIONS] [PATHS]...\n\n.. code-block:: ini\n\n [tool:interrogate]\n ignore-init-method = true\n ignore-init-module = false\n ignore-magic = false\n ignore-semiprivate = false\n ignore-private = false\n ignore-property-decorators = false\n ignore-module = false\n ignore-nested-functions = false\n ignore-nested-classes = true\n ignore-setters = false\n ignore-overloaded-functions = false\n fail-under = 95\n exclude = setup.py,docs,build\n ignore-regex = ^get$,^mock_.*,.*BaseClass.*\n ext = []\n ; possible values: sphinx (default), google\n style = sphinx\n ; possible values: 0 (minimal output), 1 (-v), 2 (-vv)\n verbose = 0\n quiet = false\n whitelist-regex =\n color = true\n omit-covered-files = false\n generate-badge = .\n badge-format = svg\n\n\n.. warning::\n\n The use of ``setup.cfg`` is not recommended unless for very simple use cases. ``.cfg`` files use a different parser than ``pyproject.toml`` which might cause hard to track down problems. When possible, it is recommended to use ``pyproject.toml`` to define your interrogate configuration.\n\n.. _badge-opts:\n\nBadge Options\n=============\n\nBadge Format\n------------\n\nThe default file format is ``svg``. Use the ``--badge-format`` flag to create a ``png`` file instead.\n**Note**: ``interrogate`` must be installed with ``interrogate[png]`` in order to generate ``png`` files (see `above <#extras>`_).\n\n.. code-block:: console\n\n $ interrogate --generate-badge PATH --badge-format png\n RESULT: PASSED (minimum: 80.0%, actual: 100.0%)\n Generated badge to /Users/lynn/dev/interrogate/docs/_static/interrogate_badge.png\n\nBadge Style\n-----------\n\nThe following badge styles are available via the ``--badge-style`` flag:\n\n+------------------------------------+--------------------------------+\n| option | example |\n+====================================+================================+\n| ``flat`` | |flat-example| |\n+------------------------------------+--------------------------------+\n| ``flat-square`` | |flat-square-example| |\n+------------------------------------+--------------------------------+\n| ``flat-square-modified`` (default) | |interrogate-badge| |\n+------------------------------------+--------------------------------+\n| ``for-the-badge`` | |for-the-badge-example| |\n+------------------------------------+--------------------------------+\n| ``plastic`` | |plastic-example| |\n+------------------------------------+--------------------------------+\n| ``social`` | |social-example| |\n+------------------------------------+--------------------------------+\n\n.. end-readme\n\nCommand Line Options\n====================\n\nTo view all options available, run ``interrogate --help``:\n\n.. code-block:: console\n\n interrogate -h\n Usage: interrogate [OPTIONS] [PATHS]...\n\n Measure and report on documentation coverage in Python modules.\n\n Options:\n --version Show the version and exit.\n -v, --verbose Level of verbosity.\n\n NOTE: When configuring verbosity in\n pyproject.toml or setup.cfg, `verbose=1`\n maps to `-v`, and `verbose=2` maps to `-vv`.\n `verbose=0` is the equivalent of no verbose\n flags used, producing minimal output.\n -q, --quiet Do not print output [default: False]\n -f, --fail-under INT | FLOAT Fail when coverage % is less than a given\n amount. [default: 80.0]\n\n -e, --exclude PATH Exclude PATHs of files and/or directories.\n Multiple `-e/--exclude` invocations\n supported.\n\n -i, --ignore-init-method Ignore `__init__` method of classes.\n [default: False]\n\n -I, --ignore-init-module Ignore `__init__.py` modules. [default:\n False]\n\n -m, --ignore-magic Ignore all magic methods of classes.\n [default: False]\n\n NOTE: This does not include the `__init__`\n method. To ignore `__init__` methods, use\n `--ignore-init-method`.\n\n -M, --ignore-module Ignore module-level docstrings. [default:\n False]\n\n -n, --ignore-nested-functions Ignore nested functions and methods.\n [default: False]\n\n -C, --ignore-nested-classes Ignore nested classes. [default: False]\n\n -O, --ignore-overloaded-functions\n Ignore `@typing.overload`-decorated functions.\n [default: False]\n\n -p, --ignore-private Ignore private classes, methods, and\n functions starting with two underscores.\n [default: False]\n\n NOTE: This does not include magic methods;\n use `--ignore-magic` and/or `--ignore-init-\n method` instead.\n\n -P, --ignore-property-decorators\n Ignore methods with property setter/getter/deleter\n decorators. [default: False]\n\n -S, --ignore-setters Ignore methods with property setter\n decorators. [default: False]\n\n -s, --ignore-semiprivate Ignore semiprivate classes, methods, and\n functions starting with a single underscore.\n [default: False]\n\n -r, --ignore-regex STR Regex identifying class, method, and\n function names to ignore. Multiple\n `-r/--ignore-regex` invocations supported.\n\n --ext Include Python-like files with the given\n extension (supported: ``pyi``). Multiple\n `--ext` invocations supported.\n\n -w, --whitelist-regex STR Regex identifying class, method, and\n function names to include. Multiple\n `-w/--whitelist-regex` invocations\n supported.\n\n --style [sphinx|google] Style of docstrings to honor. Using `google`\n will consider a class and its `__init__`\n method both covered if there is either a\n class-level docstring, or an `__init__`\n method docstring, instead of enforcing both.\n Mutually exclusive with `-i`/`--ignore-init`\n flag. [default: sphinx]\n\n -o, --output FILE Write output to a given FILE. [default:\n stdout]\n\n --color / --no-color Toggle color output on/off when printing to\n stdout. [default: True]\n\n --omit-covered-files Omit reporting files that have 100%\n documentation coverage. This option is\n ignored if verbosity is not set. [default:\n False]\n\n -g, --generate-badge PATH Generate a 'shields.io' status badge (an SVG\n image) in at a given file or directory. Will\n not generate a badge if results did not\n change from an existing badge of the same\n path.\n\n --badge-format [svg|png] File format for the generated badge. Used\n with the `-g/--generate-badge` flag.\n [default: svg]\n\n NOTE: To generate a PNG file, interrogate\n must be installed with `interrogate[png]`,\n i.e. `pip install interrogate[png]`.\n\n --badge-style [flat|flat-square|flat-square-modified|for-the-badge|plastic|social]\n Desired style of shields.io badge. Used with\n the `-g/--generate-badge` flag. [default:\n flat-square-modified]\n\n -h, --help Show this message and exit.\n -c, --config FILE Read configuration from `pyproject.toml` or\n `setup.cfg`.\n\n\n.. start-uses-this\n\nUsers of Interrogate\n====================\n\n* `attrs `_\n* `OpenMMLab `_'s ecosystem\n* `pyjanitor `_\n* `klio `_\n\nInterrogate in the Wild\n-----------------------\n\n* `Why You Should Document Your Tests `_ by `Hynek Schlawack `_\n* `Episode #181: It's time to interrogate your Python code `_ - `PythonBytes podcast `_\n\n.. end-uses-this\n\n.. start-credits\n\nCredits\n=======\n\n.. role:: smol\n\n``interrogate`` was inspired by |docstr-coverage|_, which was forked from Alexey \"DataGreed\" Strelkov's |docstring-coverage|_, which was inspired by a 2004 `recipe from James Harlow `_ :smol:`(turtles...)`.\n\nThe cute |sloth| logo is by `JustineW `_ purchased via `the Noun Project `_ (but also available under the `Creative Commons License `_ with attribution).\n\n\n.. |interrogate-badge| image:: https://interrogate.readthedocs.io/en/latest/_static/interrogate_badge.svg\n.. |flat-example| image:: https://interrogate.readthedocs.io/en/latest/_static/badge_examples/interrogate_badge_f.svg\n.. |flat-square-example| image:: https://interrogate.readthedocs.io/en/latest/_static/badge_examples/interrogate_badge_fs.svg\n.. |for-the-badge-example| image:: https://interrogate.readthedocs.io/en/latest/_static/badge_examples/interrogate_badge_ftb.svg\n.. |plastic-example| image:: https://interrogate.readthedocs.io/en/latest/_static/badge_examples/interrogate_badge_p.svg\n.. |social-example| image:: https://interrogate.readthedocs.io/en/latest/_static/badge_examples/interrogate_badge_s.svg\n.. |sloth| image:: https://interrogate.readthedocs.io/en/latest/_static/logo_smol.png\n\n.. |docstr-coverage| replace:: ``docstr-coverage``\n.. _docstr-coverage: https://pypi.org/project/docstr-coverage\n.. |docstring-coverage| replace:: ``docstring-coverage``\n.. _docstring-coverage: https://bitbucket.org/DataGreed/docstring-coverage\n\n.. end-credits\n\nRelease Information\n===================\n\n1.7.0 (2024-04-07)\n------------------\n\nAdded\n^^^^^\n\n* `tomli` dependency for Python versions < 3.11, making use of `tomllib` in the standard library with 3.11+ (`#150 `_).\n* Support for ``pyi`` file extensions (and leave room for other file extensions to be added, like maybe ``ipynb``).\n* Support for Google-style docstrings for class ``__init__`` methods with new ``--style [sphinx|google]`` flag (`#128 `_).\n\nFixed\n^^^^^\n\n* Include support for deleters when ignoring property decorators (`#126 _`).\n* Support floats for `--fail-under` values (`#114 `_).\n\nRemoved\n^^^^^^^\n\n* `toml` dependency for all Python versions (`#150 `_).\n\n\n`Full changelog `_.\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://interrogate.readthedocs.io","keywords":"documentation, coverage, quality","license":null,"license_expression":null,"license_files":null,"maintainer":"Lynn Root","maintainer_email":"lynn@lynnroot.com","name":"interrogate","package_url":"https://pypi.org/project/interrogate/","platform":null,"project_url":"https://pypi.org/project/interrogate/","project_urls":{"Bug Tracker":"https://github.com/econchick/interrogate/issues","Documentation":"https://interrogate.readthedocs.io","Homepage":"https://interrogate.readthedocs.io","Source Code":"https://github.com/econchick/interrogate"},"provides_extra":null,"release_url":"https://pypi.org/project/interrogate/1.7.0/","requires_dist":["attrs","click>=7.1","colorama","py","tabulate","tomli; python_version < \"3.11\"","cairosvg; extra == \"dev\"","sphinx; extra == \"dev\"","sphinx-autobuild; extra == \"dev\"","pytest; extra == \"dev\"","pytest-cov; extra == \"dev\"","pytest-mock; extra == \"dev\"","coverage[toml]; extra == \"dev\"","wheel; extra == \"dev\"","pre-commit; extra == \"dev\"","sphinx; extra == \"docs\"","sphinx-autobuild; extra == \"docs\"","cairosvg; extra == \"png\"","pytest; extra == \"tests\"","pytest-cov; extra == \"tests\"","pytest-mock; extra == \"tests\"","coverage[toml]; extra == \"tests\""],"requires_python":">=3.8","summary":"Interrogate a codebase for docstring coverage.","version":"1.7.0","yanked":false,"yanked_reason":null}

Dependency	Optional
attrs	false
click	false
colorama	false
py	false
tabulate	false
tomli	false
cairosvg	true
coverage	true
pre-commit	true
pytest	true
pytest-cov	true
pytest-mock	true
sphinx	true
sphinx-autobuild	true
wheel	true

Package search

interrogate

project_urls

Dependencies

All package metadata

Releases