rosetta.utility.file
index
(built-in)

Bindings for utility::file namespace

 
Classes
       
builtins.object
FileName
PathName

 
class FileName(builtins.object)
    File name class supporting Windows and UN*X/Linux format names
 
  Methods defined here:
__call__(...) from builtins.PyCapsule
__call__(*args, **kwargs)
Overloaded function.
 
1. __call__(self : rosetta.utility.file.FileName, name : rosetta.utility.file.FileName) -> rosetta.utility.file.FileName
 
Functor copy assignment
 
2. __call__(self : rosetta.utility.file.FileName, name_string : str) -> rosetta.utility.file.FileName
 
Functor string assignment
 
3. __call__(rosetta.utility.file.FileName) -> str
 
Functor
__init__(...) from builtins.PyCapsule
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(rosetta.utility.file.FileName) -> NoneType
 
2. __init__(self : rosetta.utility.file.FileName, name_string : str) -> NoneType
 
3. __init__(self : rosetta.utility.file.FileName, name_string : str, use_path : rosetta.utility.file.PathName) -> NoneType
 
4. __init__(self : rosetta.utility.file.FileName, file_names : rosetta.std.vector_utility_file_FileName) -> NoneType
 
5. __init__(self : rosetta.utility.file.FileName,  : rosetta.utility.file.FileName) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__str__(...) from builtins.PyCapsule
__str__(rosetta.utility.file.FileName) -> str
absolute(...) from builtins.PyCapsule
absolute(rosetta.utility.file.FileName) -> bool
 
Absolute path?
assign(...) from builtins.PyCapsule
assign(*args, **kwargs)
Overloaded function.
 
1. assign(self : rosetta.utility.file.FileName, name_string : str) -> rosetta.utility.file.FileName
 
String assignment
 
2. assign(self : rosetta.utility.file.FileName,  : rosetta.utility.file.FileName) -> rosetta.utility.file.FileName
bare_name(...) from builtins.PyCapsule
bare_name(rosetta.utility.file.FileName) -> str
 
Bare name (without volume or path or version)
base(...) from builtins.PyCapsule
base(*args, **kwargs)
Overloaded function.
 
1. base(self : rosetta.utility.file.FileName, base_a : str) -> rosetta.utility.file.FileName
 
Base assignment
 
2. base(rosetta.utility.file.FileName) -> str
 
Base
clear(...) from builtins.PyCapsule
clear(rosetta.utility.file.FileName) -> rosetta.utility.file.FileName
 
Clear the file name
empty(...) from builtins.PyCapsule
empty(rosetta.utility.file.FileName) -> bool
 
Empty?
erase(...) from builtins.PyCapsule
erase(rosetta.utility.file.FileName) -> rosetta.utility.file.FileName
 
Erase the file name
ext(...) from builtins.PyCapsule
ext(*args, **kwargs)
Overloaded function.
 
1. ext(self : rosetta.utility.file.FileName, ext_a : str) -> rosetta.utility.file.FileName
 
Extension assignment
 
2. ext(rosetta.utility.file.FileName) -> str
 
Extension
extension(...) from builtins.PyCapsule
extension(*args, **kwargs)
Overloaded function.
 
1. extension(self : rosetta.utility.file.FileName, ext_a : str) -> rosetta.utility.file.FileName
 
Extension assignment
 
2. extension(rosetta.utility.file.FileName) -> str
 
Extension with separator
local_name(...) from builtins.PyCapsule
local_name(rosetta.utility.file.FileName) -> str
 
Local name (without volume or path)
name(...) from builtins.PyCapsule
name(rosetta.utility.file.FileName) -> str
 
File name string
path(...) from builtins.PyCapsule
path(*args, **kwargs)
Overloaded function.
 
1. path(self : rosetta.utility.file.FileName, path_a : str) -> rosetta.utility.file.FileName
 
Path assignment
 
2. path(rosetta.utility.file.FileName) -> str
 
Path
relative(...) from builtins.PyCapsule
relative(rosetta.utility.file.FileName) -> bool
 
Relative path?
to_bare_name(...) from builtins.PyCapsule
to_bare_name(rosetta.utility.file.FileName) -> rosetta.utility.file.FileName
 
Change to bare name (without volume or path or version)
to_local_name(...) from builtins.PyCapsule
to_local_name(rosetta.utility.file.FileName) -> rosetta.utility.file.FileName
 
Change to local name (without volume or path)
ver(...) from builtins.PyCapsule
ver(*args, **kwargs)
Overloaded function.
 
1. ver(self : rosetta.utility.file.FileName, ver_a : str) -> rosetta.utility.file.FileName
 
Version assignment
 
2. ver(rosetta.utility.file.FileName) -> str
 
Version
version(...) from builtins.PyCapsule
version(*args, **kwargs)
Overloaded function.
 
1. version(self : rosetta.utility.file.FileName, ver_a : str) -> rosetta.utility.file.FileName
 
Version assignment
 
2. version(rosetta.utility.file.FileName) -> str
 
Version with separator
vol(...) from builtins.PyCapsule
vol(*args, **kwargs)
Overloaded function.
 
1. vol(self : rosetta.utility.file.FileName, vol_a : str) -> rosetta.utility.file.FileName
 
Volume assignment
 
2. vol(rosetta.utility.file.FileName) -> str
 
Volume
volume(...) from builtins.PyCapsule
volume(*args, **kwargs)
Overloaded function.
 
1. volume(self : rosetta.utility.file.FileName, vol_a : str) -> rosetta.utility.file.FileName
 
Volume assignment
 
2. volume(rosetta.utility.file.FileName) -> str
 
Volume

 
class PathName(builtins.object)
    Path name class supporting Windows and UN*X/Linux format names
 
  Methods defined here:
__call__(...) from builtins.PyCapsule
__call__(*args, **kwargs)
Overloaded function.
 
1. __call__(self : rosetta.utility.file.PathName, name : rosetta.utility.file.PathName) -> rosetta.utility.file.PathName
 
Functor copy assignment
 
2. __call__(self : rosetta.utility.file.PathName, name_string : str) -> rosetta.utility.file.PathName
 
Functor string assignment
 
3. __call__(rosetta.utility.file.PathName) -> str
 
Functor
__init__(...) from builtins.PyCapsule
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(rosetta.utility.file.PathName) -> NoneType
 
2. __init__(self : rosetta.utility.file.PathName, name_string : str) -> NoneType
 
3. __init__(self : rosetta.utility.file.PathName,  : rosetta.utility.file.PathName) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__str__(...) from builtins.PyCapsule
__str__(rosetta.utility.file.PathName) -> str
absolute(...) from builtins.PyCapsule
absolute(rosetta.utility.file.PathName) -> bool
 
Absolute path?
assign(...) from builtins.PyCapsule
assign(*args, **kwargs)
Overloaded function.
 
1. assign(self : rosetta.utility.file.PathName, name_string : str) -> rosetta.utility.file.PathName
 
String assignment
 
2. assign(self : rosetta.utility.file.PathName,  : rosetta.utility.file.PathName) -> rosetta.utility.file.PathName
clear(...) from builtins.PyCapsule
clear(rosetta.utility.file.PathName) -> rosetta.utility.file.PathName
 
Clear the path name
empty(...) from builtins.PyCapsule
empty(rosetta.utility.file.PathName) -> bool
 
Empty?
erase(...) from builtins.PyCapsule
erase(rosetta.utility.file.PathName) -> rosetta.utility.file.PathName
 
Erase the path name
name(...) from builtins.PyCapsule
name(rosetta.utility.file.PathName) -> str
 
Path name string
parent(...) from builtins.PyCapsule
parent(rosetta.utility.file.PathName) -> rosetta.utility.file.PathName
 
Returns the parent of this directory, or itself if no parent is available.
path(...) from builtins.PyCapsule
path(*args, **kwargs)
Overloaded function.
 
1. path(self : rosetta.utility.file.PathName, path_a : str) -> rosetta.utility.file.PathName
 
Path assignment
 
2. path(rosetta.utility.file.PathName) -> str
 
Path
relative(...) from builtins.PyCapsule
relative(rosetta.utility.file.PathName) -> bool
 
Relative path?
vol(...) from builtins.PyCapsule
vol(*args, **kwargs)
Overloaded function.
 
1. vol(self : rosetta.utility.file.PathName, vol_a : str) -> rosetta.utility.file.PathName
 
Volume assignment
 
2. vol(rosetta.utility.file.PathName) -> str
 
Volume
volume(...) from builtins.PyCapsule
volume(*args, **kwargs)
Overloaded function.
 
1. volume(self : rosetta.utility.file.PathName, vol_a : str) -> rosetta.utility.file.PathName
 
Volume assignment
 
2. volume(rosetta.utility.file.PathName) -> str
 
Volume

 
Functions
       
combine_names(...) method of builtins.PyCapsule instance
combine_names(file_name_strings : rosetta.utility.vector1_std_string) -> rosetta.utility.file.FileName
create_blank_file(...) method of builtins.PyCapsule instance
create_blank_file(blank_file : str) -> bool
 
Create a blank file if it doesn't already exist
create_directory(...) method of builtins.PyCapsule instance
create_directory(dir_path : str) -> bool
 
Create a directory if it doesn't already exist
create_directory_recursive(...) method of builtins.PyCapsule instance
create_directory_recursive(dir_path : str) -> bool
 
Create a directory and its parent directories if they doesn't already exist
create_temp_filename(...) method of builtins.PyCapsule instance
create_temp_filename(dir : str, prefix : str) -> str
 
Find an unused random tempfile name with a given prefix (which may include a directory)
cwd(...) method of builtins.PyCapsule instance
cwd() -> str
 
current working directory
file_basename(...) method of builtins.PyCapsule instance
file_basename(filename : str) -> str
 
Prefix of a file name
file_delete(...) method of builtins.PyCapsule instance
file_delete(path : str) -> int
 
Delete file
file_exists(...) method of builtins.PyCapsule instance
file_exists(path : str) -> bool
 
Does file exist?
file_extension(...) method of builtins.PyCapsule instance
file_extension(filename : str) -> str
 
Extension of a file name
file_size(...) method of builtins.PyCapsule instance
file_size(filename : str) -> int
 
File size
gunzip(...) method of builtins.PyCapsule instance
gunzip(*args, **kwargs)
Overloaded function.
 
1. gunzip(compressedfile : str) -> int
 
gunzip: file decompression
 
2. gunzip(compressedfile : str, overwrite : bool) -> int
 
gunzip: file decompression
gzip(...) method of builtins.PyCapsule instance
gzip(*args, **kwargs)
Overloaded function.
 
1. gzip(uncompressedfile : str) -> int
 
gzip: file compression
 
2. gzip(uncompressedfile : str, overwrite : bool) -> int
 
gzip: file compression
is_directory(...) method of builtins.PyCapsule instance
is_directory(path : str) -> bool
 
Is the file a directory?
list_dir(...) method of builtins.PyCapsule instance
list_dir(dir : str, files : rosetta.utility.vector1_std_string) -> int
trytry_ifstream_open(...) method of builtins.PyCapsule instance
trytry_ifstream_open(ifstream_ : rosetta.std.basic_ifstream_char_std_char_traits_char_t, name : str, open_mode : rosetta.std._Ios_Openmode) -> bool
 
Try to open file for read a few times just in case it is locked (from BOINC LIB)
trytry_ofstream_open(...) method of builtins.PyCapsule instance
trytry_ofstream_open(ofstream_ : rosetta.std.basic_ofstream_char_std_char_traits_char_t, name : str, open_mode : rosetta.std._Ios_Openmode) -> bool
 
Try to open file for write a few times just in case it is locked (from BOINC LIB)