siml.path_like_objects package

Subpackages

• siml.path_like_objects.siml_files package
  • Submodules
  • siml.path_like_objects.siml_files.checkpoint_file module
    • SimlCheckpointFile
      • SimlCheckpointFile.epoch
      • SimlCheckpointFile.file_path
      • SimlCheckpointFile.is_encrypted
      • SimlCheckpointFile.load()
      • SimlCheckpointFile.save()
  • siml.path_like_objects.siml_files.interface module
    • ISimlBaseFile
      • ISimlBaseFile.file_path
      • ISimlBaseFile.is_encrypted
    • ISimlCheckpointFile
      • ISimlCheckpointFile.epoch
      • ISimlCheckpointFile.load()
      • ISimlCheckpointFile.save()
    • ISimlNumpyFile
      • ISimlNumpyFile.file_extension
      • ISimlNumpyFile.load()
      • ISimlNumpyFile.save()
    • ISimlPickleFile
      • ISimlPickleFile.load()
      • ISimlPickleFile.save()
    • ISimlYamlFile
      • ISimlYamlFile.load()
      • ISimlYamlFile.save()
  • siml.path_like_objects.siml_files.numpy_file module
    • SimlNumpyFile
      • SimlNumpyFile.file_extension
      • SimlNumpyFile.file_path
      • SimlNumpyFile.is_encrypted
      • SimlNumpyFile.load()
      • SimlNumpyFile.save()
  • siml.path_like_objects.siml_files.pickle_file module
    • SimlPickleFile
      • SimlPickleFile.file_path
      • SimlPickleFile.is_encrypted
      • SimlPickleFile.load()
      • SimlPickleFile.save()
  • siml.path_like_objects.siml_files.yaml_file module
    • SimlYamlFile
      • SimlYamlFile.file_path
      • SimlYamlFile.is_encrypted
      • SimlYamlFile.load()
      • SimlYamlFile.save()
  • Module contents

Submodules

siml.path_like_objects.siml_directory module

class siml.path_like_objects.siml_directory.SimlDirectory(path: Path)

Bases: object

exist_variable_file(variable_name: str) → bool

find_pickle_file(file_base_name: str, *, allow_missing: bool = False) → ISimlPickleFile | None

find_variable_file(variable_name: str, *, allow_missing: bool = False) → ISimlNumpyFile | None

find_yaml_file(file_base_name: str, *, allow_missing: bool = False) → ISimlYamlFile | None

property path: Path

siml.path_like_objects.siml_file_builder module

class siml.path_like_objects.siml_file_builder.SimlFileBuilder

Bases: object

static checkpoint_file(file_path: Path) → ISimlCheckpointFile

static numpy_file(file_path: Path) → ISimlNumpyFile

static pickle_file(file_path: Path) → ISimlPickleFile

static yaml_file(file_path: Path) → ISimlYamlFile

Module contents