Skip to main content

types

Datasource related types.

Classes​

AccessibilityDetails​

class AccessibilityDetails(*args, **kwargs):

Error details returned by accessibility_details when source is inaccessible.

Attributes

  • error_code: The error code indicating the type of accessibility failure.
  • message: Human-readable error description.
  • path: (Optional) Resolved path, included for file-based sources.

Variables​

  • static message : str
  • static path : str

AccessibilityErrorCode​

class AccessibilityErrorCode(*args, **kwds):

Standard error codes for datasource accessibility checks.

These codes provide consistent error reporting across all datasource types.

Ancestors​

Variables​

  • static AUTH_FAILED
  • static CHECK_ERROR
  • static CHECK_TIMEOUT
  • static CONNECTION_ERROR
  • static CONNECTION_REFUSED
  • static CONNECTION_TIMEOUT
  • static DATABASE_NOT_FOUND
  • static DB_ERROR
  • static EMPTY_DIRECTORY
  • static EMPTY_FILE
  • static HTTP_ERROR
  • static NOT_A_DIRECTORY
  • static OS_ERROR
  • static PATH_NOT_FOUND
  • static PERMISSION_DENIED
  • static READ_TIMEOUT
  • static SERVICE_UNAVAILABLE
  • static TEMPLATE_NOT_FOUND
  • static UNKNOWN

DataSourceFileFilter​

class DataSourceFileFilter(*args, **kwargs):

A datasource-level filter that can be applied to files.

Provides a datasource-level filter (i.e. one that does not rely solely on filesystem information, but instead on contents of the data) that can be applied to files to include/exclude it from a datasource.

Ancestors​

DatasourceSummaryStats​

class DatasourceSummaryStats(*args, **kwargs):

Dictionary with datasource summary statistics.

Variables​

  • static additional_metrics : dict[str, typing.Any]
  • static files_with_errors : int
  • static skip_reasons : Dict[str, int]
  • static task_skip_reasons : Dict[str, int]
  • static total_files_found : int
  • static total_files_skipped : int
  • static total_files_successfully_processed : int
  • static total_task_files_skipped : int

Date​

class Date(year: int, month: Optional[int] = None, day: Optional[int] = None):

Simple date class used for filtering files based on date headers.

This is used by FileSystemIterableSource to filter files based on their creation and modification dates.

Arguments

  • year: The oldest possible year to consider.
  • month: The oldest possible month to consider. If None, all months in the given year are considered. Defaults to None.
  • day: The oldest possible day to consider. If None, all days in the given month are considered. If month is None, this is ignored. Defaults to None.

Variables​

  • static day : Optional[int]
  • static month : Optional[int]
  • static year : int

Static methods​

from_datetime_date​

def from_datetime_date(date: date) ‑> Date:

Create a Date object from a datetime.date object.

Methods​

get_date​

def get_date(self) ‑> datetime.date:

Get a datetime.date object from the date components year, month and day.

DateTD​

class DateTD(*args, **kwargs):

Typed dict form of Date dataclass.

Variables​

  • static day : int
  • static month : int
  • static year : int

FilterConfig​

class FilterConfig(*args, **kwargs):

Filter configurations for a datasource.

Variables​

  • static check_required_fields : Optional[bool]
  • static file_creation_max_date : Union[Date, DateTD, ForwardRef(None)]
  • static file_creation_min_date : Union[Date, DateTD, ForwardRef(None)]
  • static file_modification_max_date : Union[Date, DateTD, ForwardRef(None)]
  • static file_modification_min_date : Union[Date, DateTD, ForwardRef(None)]
  • static max_file_size : Optional[float]
  • static max_num_frames : Optional[int]
  • static maximum_acquisition_date : Union[Date, DateTD, ForwardRef(None)]
  • static maximum_dob : Union[Date, DateTD, ForwardRef(None)]
  • static min_file_size : Optional[float]
  • static min_num_frames : Optional[int]
  • static minimum_acquisition_date : Union[Date, DateTD, ForwardRef(None)]
  • static minimum_dob : Union[Date, DateTD, ForwardRef(None)]
  • static modality : Optional[Literal['OCT', 'SLO', None]]
  • static required_field_names : Optional[list[str]]
  • static series_description : Optional[str]