Skip to content

← file_system package

ImportStructure

Import a dictionary from disk.

This node is used to load a data structure (dictionary) from a file on disk, which may be in any of the following formats: pickle (default), JSON, YAML, or MessagePack. The data will be converted to a dictionary, which can then be passed into another node (for example, to populate the property of another node that accepts a dictionary). Note: Since the Python pickle format is very flexible, files obtained from the internet may be infected by viruses or could otherwise have been tampered with, and should be treated with the same caution as, e.g., MS Word documents. See also the documentation for the ExportStructure node. Version 1.1.1

Ports/Properties

data

Output data.

  • verbose name: Data
  • default value: None
  • port type: DataPort
  • value type: dict (can be None)
  • data direction: OUT

filename

Name of the recording dataset to import. If a relative path is given, a file of this name will be looked up in the standard data directories (/resources and Examples/).

  • verbose name: Filename
  • default value:
  • port type: StringPort
  • value type: str (can be None)

input_root

Path to the input folder; if specified, the filename will be relative to this folder. Alternatively, this can be left empty and the full path may be specified in filename).

  • verbose name: Input Root
  • default value:
  • port type: StringPort
  • value type: str (can be None)

encoding

Encoding in which the file was saved.

  • verbose name: Encoding
  • default value: pickle
  • port type: EnumPort
  • value type: str (can be None)

allow_pickle_fallback

Allow falling loading pickled data for some objects that aren't JSON or msgpack-serializable.

  • verbose name: Allow Pickle Fallback
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

file_missing

Whether to raise an exception (error) if the file is missing or not found (which may stop the pipeline), or print a log message and continue.

  • verbose name: File Missing
  • default value: raise
  • port type: EnumPort
  • value type: str (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

  • verbose name: Set Breakpoint (Debug Only)
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

  • verbose name: Metadata
  • default value: {}
  • port type: DictPort
  • value type: dict (can be None)

cloud_host

Cloud storage host to use (if any). You can override this option to select from what kind of cloud storage service data should be downloaded. On some environments (e.g., on NeuroScale), the value Default will be map to the default storage provider on that environment.

  • verbose name: Cloud Host
  • default value: Default
  • port type: EnumPort
  • value type: str (can be None)

cloud_account

Cloud account name on storage provider (use default if omitted). You can override this to choose a non-default account name for some storage provider (e.g., Azure or S3.). On some environments (e.g., on NeuroScale), this value will be default-initialized to your account.

  • verbose name: Cloud Account
  • default value:
  • port type: StringPort
  • value type: str (can be None)

cloud_bucket

Cloud bucket to read from (use default if omitted). This is the bucket or container on the cloud storage provider that the file would be written to. On some environments (e.g., on NeuroScale), this value will be default-initialized to a bucket that has been created for you.

  • verbose name: Cloud Bucket
  • default value:
  • port type: StringPort
  • value type: str (can be None)

cloud_credentials

Secure credential to access cloud data (use default if omitted). These are the security credentials (e.g., password or access token) for the the cloud storage provider. On some environments (e.g., on NeuroScale), this value will be default-initialized to the right credentials for you.

  • verbose name: Cloud Credentials
  • default value:
  • port type: StringPort
  • value type: str (can be None)