ifctester.reporter

Module Contents

class ifctester.reporter.Bcf(ids: ifctester.ids.Ids)

Bases: Json

report_failed_entities(requirement: ifctester.facet.Facet) → list[ifctester.facet.FacetFailure]

to_file(filepath: str) → None

class ifctester.reporter.Console(ids: ifctester.ids.Ids, use_colour=True)

Bases: Reporter

print(txt: str, end: str | None = None)

report() → None

report_reason(failure: ifctester.facet.FacetFailure) → None

report_specification(specification: ifctester.ids.Specification) → None

set_style(*colours: str)

class ifctester.reporter.Html(ids: ifctester.ids.Ids)

Bases: Json

report() → None

to_file(filepath: str) → None

to_string() → str

class ifctester.reporter.Json(ids: ifctester.ids.Ids)

Bases: Reporter

report() → Results

report_failed_entities(requirement: ifctester.facet.Facet) → list[ResultsFailedEntity]

report_specification(specification: ifctester.ids.Specification) → ResultsSpecification

to_file(filepath: str) → None

to_string() → str

class ifctester.reporter.Ods(ids: ifctester.ids.Ids, excel_safe=False)

Bases: Json

excel_safe_spreadsheet_name(name: str) → str

to_file(filepath: str) → None

class ifctester.reporter.Reporter(ids: ifctester.ids.Ids)

report(ids)

to_string()

write(filepath)

class ifctester.reporter.Results

Bases: TypedDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

Initialize self. See help(type(self)) for accurate signature.

date: str

filename: str

filepath: str

percent_checks_pass: ResultsPercent

percent_requirements_pass: ResultsPercent

percent_specifications_pass: ResultsPercent

specifications: list[ResultsSpecification]

status: bool

title: str

total_checks: int

total_checks_fail: int

total_checks_pass: int

total_requirements: int

total_requirements_fail: int

total_requirements_pass: int

total_specifications: int

total_specifications: int

total_specifications_fail: int

total_specifications_pass: int

class ifctester.reporter.ResultsRequirement

Bases: TypedDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

Initialize self. See help(type(self)) for accurate signature.

description: str

failed_entities: list[ResultsFailedEntity]

percent_pass: ResultsPercent

status: bool

total_applicable: int

total_fail: int

total_pass: int

class ifctester.reporter.ResultsSpecification

Bases: TypedDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

Initialize self. See help(type(self)) for accurate signature.

applicability: list[str]

description: str

instructions: str

name: str

percent_applicable_pass: ResultsPercent

percent_checks_pass: ResultsPercent

required: bool

requirements: list[ResultsRequirement]

status: bool

total_applicable: int

total_applicable_fail: int

total_applicable_pass: int

total_checks: int

total_checks_fail: int

total_checks_pass: int

class ifctester.reporter.Txt(ids: ifctester.ids.Ids)

Bases: Console

print(txt: str, end: str | None = None)

to_file(filepath: str) → None

to_string() → None

ifctester.reporter.ResultsFailedEntity

ifctester.reporter.ResultsPercent

ifctester.reporter.cwd