API Reference¶

This reference is generated from source docstrings and type hints. All symbols are importable directly from the top-level tunas package:

from tunas import read_cl2, Meet, Swimmer, Event, Time, qualifies_for

For guides and walkthoughs, see the Getting Started Guide.

Parsing & Diagnostics: Parse function and report/warning classes.
Exceptions: Custom error and warning classes.
Domain Model: Core classes representing meets, clubs, swimmers, and results.
Events & Time: Objects representing individual swimming events and times.
Enumerations: Categorical SDIF/meet fields.
Geography: Local Swimming Committees, US states, and FINA country codes.
Time Standards: Lookups for USA Swimming motivational standards.

Everything below is exported from the top-level tunas package (and re-exported in tunas.__all__):

Group	Symbols
Parsing	`read_cl2`, `read_hy3`, `MeetArchive`, `ParseReport`, `ParseWarning`, `Severity`, `IssueKind`
Exceptions	`TunasError`, `ParseError`, `StandardsError`
Aggregates	`Meet`, `Club`, `Swimmer`
Results	`Swim`, `MeetResult`, `IndividualSwim`, `Relay`, `RelaySwim`, `Split`
Metadata / PII	`MeetHost`, `SourceFile`, `ClubEntryCounts`, `SwimmerContact`, `SwimmerRegistration`
Value types	`Time`, `Event`
Enums	`Sex`, `Stroke`, `Course`, `Session`, `AttachStatus`, `MeetType`, `Region`, `EventTimeClass`, `Organization`, `FileType`, `SplitType`, `ResultStatus`, `RelayLegOrder`, `MemberStatus`, `Season`, `Ethnicity`, `Affiliation`, `Citizenship`
Geography	`LSC`, `State`, `Country`
Standards	`TimeStandard`, `qualifies_for`, `all_qualified`, `standard_time`