sphinx_reports.DataModel.CodeCoverage

Abstract documentation coverage data model for Python code.

Classes

• Base: Abstract base class for generic types.

• Coverage: Abstract base class for generic types.

• ModuleCoverage: Abstract base class for generic types.

• PackageCoverage: Abstract base class for generic types.

---

Classes

class sphinx_reports.DataModel.CodeCoverage.Base(name, parent=None)

Inheritance

Parameters:

• name (str)

• parent (_ParentType | None)

__init__(name, parent=None)

Parameters:

• name (str)

• parent (_ParentType | None)

Return type:

None

classmethod __class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

classmethod __init_subclass__()

Function to initialize subclasses.

class sphinx_reports.DataModel.CodeCoverage.Coverage(name, file, parent=None)

Inheritance

Parameters:

• name (str)

• file (Path)

• parent (_ParentType | None)

__init__(name, file, parent=None)

Parameters:

• name (str)

• file (Path)

• parent (_ParentType | None)

Return type:

None

classmethod __class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

classmethod __init_subclass__()

Function to initialize subclasses.

class sphinx_reports.DataModel.CodeCoverage.ModuleCoverage(name, file, parent=None)

Inheritance

Parameters:

• name (str)

• file (Path)

• parent (PackageCoverage | None)

__init__(name, file, parent=None)

Parameters:

• name (str)

• file (Path)

• parent (PackageCoverage | None)

Return type:

None

classmethod __class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

classmethod __init_subclass__()

Function to initialize subclasses.

class sphinx_reports.DataModel.CodeCoverage.PackageCoverage(name, file, parent=None)

Inheritance

Parameters:

• name (str)

• file (Path)

• parent (PackageCoverage | None)

__init__(name, file, parent=None)

Parameters:

• name (str)

• file (Path)

• parent (PackageCoverage | None)

Return type:

None

classmethod __class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

classmethod __init_subclass__()

Function to initialize subclasses.