schrodinger.ui.qt.standard.controllers.map_source module

exception schrodinger.ui.qt.standard.controllers.map_source.InvalidMapInput

Bases: ValueError

Raised when a map is requested from invalid input.

class schrodinger.ui.qt.standard.controllers.map_source.MapSource

Bases: ABC

Validate and resolve a map from one configured input origin.

abstract validationErrorMessage() → str | None

Return an error describing invalid map input, or None.

abstract mapReference() → MapReference

Return the resolved map reference.

Raises:

InvalidMapInput – If the input is invalid.

class schrodinger.ui.qt.standard.controllers.map_source.PathMapSource(paths_provider: Callable[[], list[str]])

Bases: MapSource

Resolve a map from a selected filesystem path.

__init__(paths_provider: Callable[[], list[str]]) → None
validationErrorMessage() → str | None

Return an error describing invalid path input, or None.

mapReference() → MapReference

Return a reference to the selected map file.

class schrodinger.ui.qt.standard.controllers.map_source.ProjectMapSource(snapshot_provider: Callable[[], EntrySnapshot], empty_message: str, multiple_message: str)

Bases: MapSource

Resolve a map from a project-entry snapshot.

__init__(snapshot_provider: Callable[[], EntrySnapshot], empty_message: str, multiple_message: str) → None
validationErrorMessage() → str | None

Return an error describing invalid project input, or None.

mapReference() → MapReference

Return the first map surface from the single map-only entry.