tatami.doctor module

class tatami.doctor.Diagnose(*, detail)[source]

Bases: BaseModel

Parameters:

detail (list[Message])

detail: list[Message]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

property summary: Summary
class tatami.doctor.Doctor[source]

Bases: object

__init__()[source]
add_message(msg, level=MessageLevel.DEFAULT)[source]
Parameters:
Return type:

Self

get_diagnose()[source]
Return type:

Diagnose

class tatami.doctor.Message(*, level, message, frame=<factory>)[source]

Bases: BaseModel

Parameters:
frame: FrameInfo
level: MessageLevel
message: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class tatami.doctor.MessageLevel(*values)[source]

Bases: Enum

CRITICAL = 'critical'
DEFAULT = 'default'
HIGH = 'high'
LOW = 'low'
MEDIUM = 'medium'
WARNING = 'warning'
class tatami.doctor.Summary(*, warning=0, low=0, medium=0, high=0, critical=0)[source]

Bases: BaseModel

Parameters:

  • warning (int)

  • low (int)

  • medium (int)

  • high (int)

  • critical (int)

critical: int
high: int
low: int
medium: int
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

warning: int
tatami.doctor.diagnose_project(project_path)[source]

Diagnose a Tatami project and return a detailed analysis.

Parameters:

project_path (str)

Return type:

Diagnose