module cli.code_cli

Short summary

module pyquickhelper.cli.code_cli

Command line about transfering files.

source on GitHub

Functions

function

truncated documentation

code_stat

Returns statistics about the documentation of a module.

Documentation

Command line about transfering files.

source on GitHub

pyquickhelper.cli.code_cli.code_stat(names, output=None, fLOG=<built-in function print>)[source]

Returns statistics about the documentation of a module.

Parameters:

  • names – module name comma separated value

  • output – output file name

  • fLOG – logging function

Returns:

status

Returns statistics about the documentation of a module

The command line returns a table with the number of lines of code and documentatation.

<<<

python -m pyquickhelper code_stat --help

>>>

usage: code_stat [-h] [-n NAMES] [-o OUTPUT]

Returns statistics about the documentation of a module.

optional arguments:
  -h, --help            show this help message and exit
  -n NAMES, --names NAMES
                        module name comma separated value (default: None)
  -o OUTPUT, --output OUTPUT
                        output file name (default: )

source on GitHub