file

Bindings for utility::file namespace

class pyrosetta.rosetta.utility.file.FileName

Bases: pybind11_builtins.pybind11_object

File name class supporting Windows and UN*X/Linux format names

__call__(*args, **kwargs)

Overloaded function.

1. __call__(self: pyrosetta.rosetta.utility.file.FileName, name: pyrosetta.rosetta.utility.file.FileName) -> pyrosetta.rosetta.utility.file.FileName

Functor copy assignment

C++: utility::file::FileName::operator()(const class utility::file::FileName &) –> class utility::file::FileName &

2. __call__(self: pyrosetta.rosetta.utility.file.FileName, name_string: str) -> pyrosetta.rosetta.utility.file.FileName

Functor string assignment

C++: utility::file::FileName::operator()(const class std::basic_string<char> &) –> class utility::file::FileName &

3. __call__(self: pyrosetta.rosetta.utility.file.FileName) -> str

Functor

C++: utility::file::FileName::operator()() const –> std::string

__delattr__

Implement delattr(self, name).

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: pyrosetta.rosetta.utility.file.FileName) -> None
2. __init__(self: pyrosetta.rosetta.utility.file.FileName, name_string: str) -> None
3. __init__(self: pyrosetta.rosetta.utility.file.FileName, name_string: str, use_path: pyrosetta.rosetta.utility.file.PathName) -> None
4. __init__(self: pyrosetta.rosetta.utility.file.FileName, file_names: pyrosetta.rosetta.std.vector_utility_file_FileName) -> None
5. __init__(self: pyrosetta.rosetta.utility.file.FileName, arg0: pyrosetta.rosetta.utility.file.FileName) -> None

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__(self: pyrosetta.rosetta.utility.file.FileName) → str

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

absolute(self: pyrosetta.rosetta.utility.file.FileName) → bool

Absolute path?

C++: utility::file::FileName::absolute() const –> bool

assign(*args, **kwargs)

Overloaded function.

1. assign(self: pyrosetta.rosetta.utility.file.FileName, name_string: str) -> pyrosetta.rosetta.utility.file.FileName

String assignment

C++: utility::file::FileName::operator=(const class std::basic_string<char> &) –> class utility::file::FileName &

2. assign(self: pyrosetta.rosetta.utility.file.FileName, : pyrosetta.rosetta.utility.file.FileName) -> pyrosetta.rosetta.utility.file.FileName

C++: utility::file::FileName::operator=(const class utility::file::FileName &) –> class utility::file::FileName &

bare_name(self: pyrosetta.rosetta.utility.file.FileName) → str

Bare name (without volume or path or version)

C++: utility::file::FileName::bare_name() const –> std::string

base(*args, **kwargs)

Overloaded function.

1. base(self: pyrosetta.rosetta.utility.file.FileName, base_a: str) -> pyrosetta.rosetta.utility.file.FileName

Base assignment

C++: utility::file::FileName::base(const class std::basic_string<char> &) –> class utility::file::FileName &

2. base(self: pyrosetta.rosetta.utility.file.FileName) -> str

Base

C++: utility::file::FileName::base() const –> const std::string &

clear(self: pyrosetta.rosetta.utility.file.FileName) → pyrosetta.rosetta.utility.file.FileName

Clear the file name

C++: utility::file::FileName::clear() –> class utility::file::FileName &

empty(self: pyrosetta.rosetta.utility.file.FileName) → bool

Empty?

C++: utility::file::FileName::empty() const –> bool

erase(self: pyrosetta.rosetta.utility.file.FileName) → pyrosetta.rosetta.utility.file.FileName

Erase the file name

C++: utility::file::FileName::erase() –> class utility::file::FileName &

ext(*args, **kwargs)

Overloaded function.

1. ext(self: pyrosetta.rosetta.utility.file.FileName, ext_a: str) -> pyrosetta.rosetta.utility.file.FileName

Extension assignment

C++: utility::file::FileName::ext(const class std::basic_string<char> &) –> class utility::file::FileName &

2. ext(self: pyrosetta.rosetta.utility.file.FileName) -> str

Extension

C++: utility::file::FileName::ext() const –> const std::string &

extension(*args, **kwargs)

Overloaded function.

1. extension(self: pyrosetta.rosetta.utility.file.FileName, ext_a: str) -> pyrosetta.rosetta.utility.file.FileName

Extension assignment

C++: utility::file::FileName::extension(const class std::basic_string<char> &) –> class utility::file::FileName &

2. extension(self: pyrosetta.rosetta.utility.file.FileName) -> str

Extension with separator

C++: utility::file::FileName::extension() const –> std::string

local_name(self: pyrosetta.rosetta.utility.file.FileName) → str

Local name (without volume or path)

C++: utility::file::FileName::local_name() const –> std::string

name(self: pyrosetta.rosetta.utility.file.FileName) → str

File name string

C++: utility::file::FileName::name() const –> std::string

path(*args, **kwargs)

Overloaded function.

1. path(self: pyrosetta.rosetta.utility.file.FileName, path_a: str) -> pyrosetta.rosetta.utility.file.FileName

Path assignment

C++: utility::file::FileName::path(const class std::basic_string<char> &) –> class utility::file::FileName &

2. path(self: pyrosetta.rosetta.utility.file.FileName) -> str

Path

C++: utility::file::FileName::path() const –> const std::string &

relative(self: pyrosetta.rosetta.utility.file.FileName) → bool

Relative path?

C++: utility::file::FileName::relative() const –> bool

to_bare_name(self: pyrosetta.rosetta.utility.file.FileName) → pyrosetta.rosetta.utility.file.FileName

Change to bare name (without volume or path or version)

C++: utility::file::FileName::to_bare_name() –> class utility::file::FileName &

to_local_name(self: pyrosetta.rosetta.utility.file.FileName) → pyrosetta.rosetta.utility.file.FileName

Change to local name (without volume or path)

C++: utility::file::FileName::to_local_name() –> class utility::file::FileName &

ver(*args, **kwargs)

Overloaded function.

1. ver(self: pyrosetta.rosetta.utility.file.FileName, ver_a: str) -> pyrosetta.rosetta.utility.file.FileName

Version assignment

C++: utility::file::FileName::ver(const class std::basic_string<char> &) –> class utility::file::FileName &

2. ver(self: pyrosetta.rosetta.utility.file.FileName) -> str

Version

C++: utility::file::FileName::ver() const –> const std::string &

version(*args, **kwargs)

Overloaded function.

1. version(self: pyrosetta.rosetta.utility.file.FileName, ver_a: str) -> pyrosetta.rosetta.utility.file.FileName

Version assignment

C++: utility::file::FileName::version(const class std::basic_string<char> &) –> class utility::file::FileName &

2. version(self: pyrosetta.rosetta.utility.file.FileName) -> str

Version with separator

C++: utility::file::FileName::version() const –> std::string

vol(*args, **kwargs)

Overloaded function.

1. vol(self: pyrosetta.rosetta.utility.file.FileName, vol_a: str) -> pyrosetta.rosetta.utility.file.FileName

Volume assignment

C++: utility::file::FileName::vol(const class std::basic_string<char> &) –> class utility::file::FileName &

2. vol(self: pyrosetta.rosetta.utility.file.FileName) -> str

Volume

C++: utility::file::FileName::vol() const –> const std::string &

volume(*args, **kwargs)

Overloaded function.

1. volume(self: pyrosetta.rosetta.utility.file.FileName, vol_a: str) -> pyrosetta.rosetta.utility.file.FileName

Volume assignment

C++: utility::file::FileName::volume(const class std::basic_string<char> &) –> class utility::file::FileName &

2. volume(self: pyrosetta.rosetta.utility.file.FileName) -> str

Volume

C++: utility::file::FileName::volume() const –> const std::string &

class pyrosetta.rosetta.utility.file.PathName

Bases: pybind11_builtins.pybind11_object

Path name class supporting Windows and UN*X/Linux format names

__call__(*args, **kwargs)

Overloaded function.

1. __call__(self: pyrosetta.rosetta.utility.file.PathName, name: pyrosetta.rosetta.utility.file.PathName) -> pyrosetta.rosetta.utility.file.PathName

Functor copy assignment

C++: utility::file::PathName::operator()(const class utility::file::PathName &) –> class utility::file::PathName &

2. __call__(self: pyrosetta.rosetta.utility.file.PathName, name_string: str) -> pyrosetta.rosetta.utility.file.PathName

Functor string assignment

C++: utility::file::PathName::operator()(const class std::basic_string<char> &) –> class utility::file::PathName &

3. __call__(self: pyrosetta.rosetta.utility.file.PathName) -> str

Functor

C++: utility::file::PathName::operator()() const –> std::string

__delattr__

Implement delattr(self, name).

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: pyrosetta.rosetta.utility.file.PathName) -> None
2. __init__(self: pyrosetta.rosetta.utility.file.PathName, name_string: str) -> None
3. __init__(self: pyrosetta.rosetta.utility.file.PathName, arg0: pyrosetta.rosetta.utility.file.PathName) -> None

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__(self: pyrosetta.rosetta.utility.file.PathName) → str

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

absolute(self: pyrosetta.rosetta.utility.file.PathName) → bool

Absolute path?

C++: utility::file::PathName::absolute() const –> bool

assign(*args, **kwargs)

Overloaded function.

1. assign(self: pyrosetta.rosetta.utility.file.PathName, name_string: str) -> pyrosetta.rosetta.utility.file.PathName

String assignment

C++: utility::file::PathName::operator=(const class std::basic_string<char> &) –> class utility::file::PathName &

2. assign(self: pyrosetta.rosetta.utility.file.PathName, : pyrosetta.rosetta.utility.file.PathName) -> pyrosetta.rosetta.utility.file.PathName

C++: utility::file::PathName::operator=(const class utility::file::PathName &) –> class utility::file::PathName &

clear(self: pyrosetta.rosetta.utility.file.PathName) → pyrosetta.rosetta.utility.file.PathName

Clear the path name

C++: utility::file::PathName::clear() –> class utility::file::PathName &

empty(self: pyrosetta.rosetta.utility.file.PathName) → bool

Empty?

C++: utility::file::PathName::empty() const –> bool

erase(self: pyrosetta.rosetta.utility.file.PathName) → pyrosetta.rosetta.utility.file.PathName

Erase the path name

C++: utility::file::PathName::erase() –> class utility::file::PathName &

name(self: pyrosetta.rosetta.utility.file.PathName) → str

Path name string

C++: utility::file::PathName::name() const –> std::string

parent(self: pyrosetta.rosetta.utility.file.PathName) → pyrosetta.rosetta.utility.file.PathName

Returns the parent of this directory, or itself if no parent is available.

C++: utility::file::PathName::parent() const –> class utility::file::PathName

path(*args, **kwargs)

Overloaded function.

1. path(self: pyrosetta.rosetta.utility.file.PathName, path_a: str) -> pyrosetta.rosetta.utility.file.PathName

Path assignment

C++: utility::file::PathName::path(const class std::basic_string<char> &) –> class utility::file::PathName &

2. path(self: pyrosetta.rosetta.utility.file.PathName) -> str

Path

C++: utility::file::PathName::path() const –> const std::string &

relative(self: pyrosetta.rosetta.utility.file.PathName) → bool

Relative path?

C++: utility::file::PathName::relative() const –> bool

vol(*args, **kwargs)

Overloaded function.

1. vol(self: pyrosetta.rosetta.utility.file.PathName, vol_a: str) -> pyrosetta.rosetta.utility.file.PathName

Volume assignment

C++: utility::file::PathName::vol(const class std::basic_string<char> &) –> class utility::file::PathName &

2. vol(self: pyrosetta.rosetta.utility.file.PathName) -> str

Volume

C++: utility::file::PathName::vol() const –> const std::string &

volume(*args, **kwargs)

Overloaded function.

1. volume(self: pyrosetta.rosetta.utility.file.PathName, vol_a: str) -> pyrosetta.rosetta.utility.file.PathName

Volume assignment

C++: utility::file::PathName::volume(const class std::basic_string<char> &) –> class utility::file::PathName &

2. volume(self: pyrosetta.rosetta.utility.file.PathName) -> str

Volume

C++: utility::file::PathName::volume() const –> const std::string &

pyrosetta.rosetta.utility.file.combine_names(file_name_strings: pyrosetta.rosetta.utility.vector1_std_string) → pyrosetta.rosetta.utility.file.FileName

C++: utility::file::combine_names(class utility::vector1<class std::basic_string<char>, class std::allocator<class std::basic_string<char> > >) –> class utility::file::FileName

pyrosetta.rosetta.utility.file.create_blank_file(blank_file: str) → bool

Create a blank file if it doesn’t already exist

C++: utility::file::create_blank_file(const class std::basic_string<char> &) –> bool

pyrosetta.rosetta.utility.file.create_directory(dir_path: str) → bool

Create a directory if it doesn’t already exist

C++: utility::file::create_directory(const class std::basic_string<char> &) –> bool

pyrosetta.rosetta.utility.file.create_directory_recursive(dir_path: str) → bool

Create a directory and its parent directories if they doesn’t already exist

C++: utility::file::create_directory_recursive(const class std::basic_string<char> &) –> bool

pyrosetta.rosetta.utility.file.create_temp_filename(dir: str, prefix: str) → str

Find an unused random tempfile name with a given prefix (which may include a directory)

C++: utility::file::create_temp_filename(const class std::basic_string<char> &, const class std::basic_string<char> &) –> std::string

pyrosetta.rosetta.utility.file.cwd() → str

current working directory

C++: utility::file::cwd() –> std::string

pyrosetta.rosetta.utility.file.file_basename(filename: str) → str

Prefix of a file name

C++: utility::file::file_basename(const class std::basic_string<char> &) –> std::string

pyrosetta.rosetta.utility.file.file_delete(path: str) → int

Delete file

C++: utility::file::file_delete(const class std::basic_string<char> &) –> int

pyrosetta.rosetta.utility.file.file_exists(path: str) → bool

Does file exist?

C++: utility::file::file_exists(const class std::basic_string<char> &) –> bool

pyrosetta.rosetta.utility.file.file_extension(filename: str) → str

Extension of a file name

C++: utility::file::file_extension(const class std::basic_string<char> &) –> std::string

pyrosetta.rosetta.utility.file.file_size(filename: str) → int

File size

C++: utility::file::file_size(const class std::basic_string<char> &) –> long

pyrosetta.rosetta.utility.file.gunzip(*args, **kwargs)

Overloaded function.

1. gunzip(compressedfile: str) -> int
2. gunzip(compressedfile: str, overwrite: bool) -> int

gunzip: file decompression

C++: utility::file::gunzip(const class std::basic_string<char> &, bool) –> long

pyrosetta.rosetta.utility.file.gzip(*args, **kwargs)

Overloaded function.

1. gzip(uncompressedfile: str) -> int
2. gzip(uncompressedfile: str, overwrite: bool) -> int

gzip: file compression

C++: utility::file::gzip(const class std::basic_string<char> &, bool) –> long

pyrosetta.rosetta.utility.file.is_directory(path: str) → bool

Is the file a directory?

C++: utility::file::is_directory(const class std::basic_string<char> &) –> bool

pyrosetta.rosetta.utility.file.list_dir(dir: str, files: pyrosetta.rosetta.utility.vector1_std_string) → int

generate sorted file listing for given directory, return non-zero value on error

C++: utility::file::list_dir(class std::basic_string<char>, class utility::vector1<class std::basic_string<char>, class std::allocator<class std::basic_string<char> > > &) –> int

pyrosetta.rosetta.utility.file.trytry_ifstream_open(ifstream_: pyrosetta.rosetta.std.ifstream, name: str, open_mode: pyrosetta.rosetta.std._Ios_Openmode) → bool

Try to open file for read a few times just in case it is locked (from BOINC LIB)

C++: utility::file::trytry_ifstream_open(class std::basic_ifstream<char> &, const class std::basic_string<char> &, enum std::_Ios_Openmode) –> bool

pyrosetta.rosetta.utility.file.trytry_ofstream_open(ofstream_: pyrosetta.rosetta.std.ofstream, name: str, open_mode: pyrosetta.rosetta.std._Ios_Openmode) → bool

Try to open file for write a few times just in case it is locked (from BOINC LIB)

C++: utility::file::trytry_ofstream_open(class std::basic_ofstream<char> &, const class std::basic_string<char> &, enum std::_Ios_Openmode) –> bool