ogs5py.fileclasses.base.File

class ogs5py.fileclasses.base.File(task_root=None, task_id='model', file_ext='.std')[source]

Bases: object

File class with minimal functionality.

Parameters
  • task_root (str, optional) – Path to the destiny folder. Default is cwd+”ogs5model”

  • task_id (str, optional) – Name for the ogs task. Default: “model”

  • file_ext (str, optional) – extension of the file (with leading dot “.std”) Default: “.std”

Attributes
file_name

str: base name of the file with extension.

file_path

str: save path of the file.

force_writing

bool: state if the file is written even if empty.

is_empty

bool: state if the OGS file is empty.

name

str: name of the file without extension.

Methods

add_copy_link(path[, symlink])

Add a link to copy a file instead of writing.

check([verbose])

Check if the given file is valid.

del_copy_link()

Remove a former given link to an external file.

get_file_type()

Get the OGS file class name.

read_file(path[, encoding, verbose])

Read an existing file.

reset()

Delete every content.

save(path, **kwargs)

Save the actual file in the given path.

write_file()

Write the actual OGS input file to the given folder.

Add a link to copy a file instead of writing.

Instead of writing a file, you can give a path to an existing file, that will be copied/linked to the target folder.

Parameters
  • path (str) – path to the existing file that should be copied

  • symlink (bool, optional) – on UNIX systems it is possible to use a symbolic link to save time if the file is big. Default: False

check(verbose=True)[source]

Check if the given file is valid.

Parameters

verbose (bool, optional) – Print information for the executed checks. Default: True

Returns

result – Validity of the given file.

Return type

bool

Remove a former given link to an external file.

get_file_type()[source]

Get the OGS file class name.

read_file(path, encoding=None, verbose=False)[source]

Read an existing file.

reset()[source]

Delete every content.

save(path, **kwargs)[source]

Save the actual file in the given path.

Parameters

path (str) – path to where to file should be saved

write_file()[source]

Write the actual OGS input file to the given folder.

Its path is given by “task_root+task_id+file_ext”.

property file_name

base name of the file with extension.

Type

str

property file_path

save path of the file.

Type

str

property force_writing

state if the file is written even if empty.

Type

bool

property is_empty

state if the OGS file is empty.

Type

bool

property name

name of the file without extension.

Type

str