pyicat_plus.utils.sync_types.Dataset#

class pyicat_plus.utils.sync_types.Dataset(path, proposal, beamline, name, raw_root_dir, status_reason, startdate=None, enddate=None, metadata=None, icat_dataset=None)[source]#

Bases: object

Parameters:

  • path (str)

  • proposal (str)

  • beamline (str)

  • name (Optional[str])

  • raw_root_dir (str)

  • status_reason (List[str])

  • startdate (Optional[datetime])

  • enddate (Optional[datetime])

  • metadata (Optional[dict])

  • icat_dataset (Optional[Dataset])

as_dict()[source]#
Return type:

Dict[str, Any]

beamline: str#
enddate: Optional[datetime] = None#
classmethod from_dict(data)[source]#

Factory method to create a Dataset instance from a dictionary.

Parameters:

data (Dict[str, Any])

Return type:

Dataset

get_status()[source]#
Return type:

str

has_metadata()[source]#
Return type:

bool

icat_dataset: Optional[Dataset] = None#
is_invalid()[source]#
Return type:

bool

is_non_empty_dir()[source]#
Return type:

bool

is_registered()[source]#
Return type:

bool

is_registered_without_files()[source]#
Return type:

bool

metadata: Optional[dict] = None#
property metadata_file: str | None#

File stored by Bliss when ending the proposal without confirmation of registration

name: Optional[str]#
path: str#
proposal: str#
raw_root_dir: str#
startdate: Optional[datetime] = None#
status_reason: List[str]#
to_be_uploaded()[source]#
Return type:

bool