squirrels.types (module)

All classes below are available to import from the "squirrels.types" module or directly from the "squirrels" module. These classes should not be instantiated, and should only be used as type hints (which helps code editors to provide autocomplete suggestions) or to create derived classes from.

📄️ DataSource (class)

This is the base class for all [data source classes], used for specifying the database lookup table to use for the parameter options or details of a parameter.

📄️ ParameterOption (class)

This is the base class for all [parameter option classes].

📄️ Parameter (class)

This is the base class for all [parameter classes]. It can be imported from the module squirrels.types or squirrels.

📄️ TextValue (class)

This is the return type of calling the getenteredtext method on a [TextParameter] object.

📄️ DatasetMetadata (class)

This is the return type of the dataset_metadata method of a [SquirrelsProject] object.

📄️ DatasetResult (class)

This is the return type of the dataset method of a [SquirrelsProject] object. It is also a subclass of [DatasetMetadata].

📄️ Dashboard (class)

This is the base class for all dashboard types such as [PngDashboard]. See the [dashboards module] for the full list of dashboard types.