Skip to content

dotnet_coverage

dotnet-coverage documentation

DotnetCoverage

Bases: Tool[_R]

Classes:

Name Description
Collect
Connect
Instrument
Merge
Shutdown
Snapshot

Methods:

Name Description
__call__
flags

Bind tool-level global options before the subcommand.

Attributes:

Name Type Description
collect Collect[_R]
connect Connect[_R]
instrument Instrument[_R]
merge Merge[_R]
shutdown Shutdown[_R]
snapshot Snapshot[_R]
argv DotnetCoverage[Argv]

collect instance-attribute

collect: Collect[_R]

connect instance-attribute

connect: Connect[_R]

instrument instance-attribute

instrument: Instrument[_R]

merge instance-attribute

merge: Merge[_R]

shutdown instance-attribute

shutdown: Shutdown[_R]

snapshot instance-attribute

snapshot: Snapshot[_R]

argv property

Collect

Bases: Tool[_R2]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Collect[Argv]

argv property

argv: Collect[Argv]

__call__

__call__(*args: str | PathLike[str], app_id: Value = ..., background: Flag = ..., disable_console_output: Flag = ..., include_files: Value = ..., log_file: Value = ..., log_level: Value = ..., nologo: Flag = ..., output: Value = ..., output_format: Value = ..., server_mode: Flag = ..., session_id: Value = ..., settings: Value = ..., timeout: Value = ..., **flags: Any) -> _R2

Run this verb.

Parameters:

Name Type Description Default
app_id Value

Application User Model ID (AUMID, in the form PackageFamilyName!AppId) of a packaged (MSIX) app to activate and collect coverage for.

...
background Flag

Starts code coverage collection server in a new background process.

...
disable_console_output Flag

Disables console output.

...
include_files Value

List of files to be instrumented.

...
log_file Value

Log file path.

...
log_level Value

Log level.

...
nologo Flag

Do not display Code Coverage banner.

...
output Value

Output file.

...
output_format Value

Output file format.

...
server_mode Flag

Starts code coverage collection in server mode.

...
session_id Value

Session ID of collection.

...
settings Value

XML code coverage settings.

...
timeout Value

Timeout (in milliseconds) for interprocess communication.

...

Connect

Bases: Tool[_R2]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Connect[Argv]

argv property

argv: Connect[Argv]

__call__

__call__(session: str | PathLike[str], /, *args: str | PathLike[str], background: Flag = ..., disable_console_output: Flag = ..., log_file: Value = ..., log_level: Value = ..., nologo: Flag = ..., timeout: Value = ..., **flags: Any) -> _R2

Run this verb.

Parameters:

Name Type Description Default
background Flag

Executes command in a new background process.

...
disable_console_output Flag

Disables console output.

...
log_file Value

Log file path.

...
log_level Value

Log level.

...
nologo Flag

Do not display Code Coverage banner.

...
timeout Value

Timeout (in milliseconds) for interprocess communication.

...

Instrument

Bases: Tool[_R2]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Instrument[Argv]

argv property

__call__

__call__(input_file: str | PathLike[str], /, *args: str | PathLike[str], disable_console_output: Flag = ..., log_file: Value = ..., log_level: Value = ..., nologo: Flag = ..., output: Value = ..., session_id: Value = ..., settings: Value = ..., **flags: Any) -> _R2

Run this verb.

Parameters:

Name Type Description Default
disable_console_output Flag

Disables console output.

...
log_file Value

Log file path.

...
log_level Value

Log level.

...
nologo Flag

Do not display Code Coverage banner.

...
output Value

Output file.

...
session_id Value

Session ID of collection.

...
settings Value

XML code coverage settings.

...

Merge

Bases: Tool[_R2]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Merge[Argv]

argv property

argv: Merge[Argv]

__call__

__call__(*args: str | PathLike[str], disable_console_output: Flag = ..., log_file: Value = ..., log_level: Value = ..., nologo: Flag = ..., output: Value = ..., output_format: Value = ..., recursive: Flag = ..., remove_input_files: Flag = ..., **flags: Any) -> _R2

Run this verb.

Parameters:

Name Type Description Default
disable_console_output Flag

Disables console output.

...
log_file Value

Log file path.

...
log_level Value

Log level.

...
nologo Flag

Do not display Code Coverage banner.

...
output Value

Output file.

...
output_format Value

Output file format.

...
recursive Flag

Search for coverage reports in subdirectories.

...
remove_input_files Flag

Removes all input coverage reports which were merged.

...

Shutdown

Bases: Tool[_R2]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Shutdown[Argv]

argv property

argv: Shutdown[Argv]

__call__

__call__(session: str | PathLike[str], /, *args: str | PathLike[str], disable_console_output: Flag = ..., log_file: Value = ..., log_level: Value = ..., nologo: Flag = ..., timeout: Value = ..., **flags: Any) -> _R2

Run this verb.

Parameters:

Name Type Description Default
disable_console_output Flag

Disables console output.

...
log_file Value

Log file path.

...
log_level Value

Log level.

...
nologo Flag

Do not display Code Coverage banner.

...
timeout Value

Timeout (in milliseconds) for interprocess communication.

...

Snapshot

Bases: Tool[_R2]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Snapshot[Argv]

argv property

argv: Snapshot[Argv]

__call__

__call__(session: str | PathLike[str], /, *args: str | PathLike[str], disable_console_output: Flag = ..., log_file: Value = ..., log_level: Value = ..., nologo: Flag = ..., output: Value = ..., reset: Flag = ..., tag_identifier: Value = ..., tag_name: Value = ..., timeout: Value = ..., **flags: Any) -> _R2

Run this verb.

Parameters:

Name Type Description Default
disable_console_output Flag

Disables console output.

...
log_file Value

Log file path.

...
log_level Value

Log level.

...
nologo Flag

Do not display Code Coverage banner.

...
output Value

Output file.

...
reset Flag

Clears coverage information for a code coverage collection.

...
tag_identifier Value

Tag id of the snapshot stored in the coverage file.

...
tag_name Value

Tag name of the snapshot stored in the coverage file.

...
timeout Value

Timeout (in milliseconds) for interprocess communication.

...

__call__

__call__(*args: str | PathLike[str], **flags: Any) -> _R

flags

flags(**flags: Any) -> Self

Bind tool-level global options before the subcommand.

tools.docker.flags(host=...) puts a tool's own options ahead of the verb, where they belong.