File#

class pyopenms.File#

Bases: object

Cython implementation of _File

Original C++ documentation is available here

__init__()#

Methods

__init__()

absolutePath

__static_File_absolutePath(file: Union[bytes, str, String] ) -> Union[bytes, str, String]

basename

__static_File_basename(file: Union[bytes, str, String] ) -> Union[bytes, str, String]

empty

__static_File_empty(file: Union[bytes, str, String] ) -> bool

exists

__static_File_exists(file: Union[bytes, str, String] ) -> bool

fileList

__static_File_fileList(dir: Union[bytes, str, String] , file_pattern: Union[bytes, str, String] , output: List[bytes] , full_path: bool ) -> bool

find

__static_File_find(filename: Union[bytes, str, String] , directories: List[bytes] ) -> Union[bytes, str, String]

findDatabase

__static_File_findDatabase(db_name: Union[bytes, str, String] ) -> Union[bytes, str, String]

findDoc

__static_File_findDoc(filename: Union[bytes, str, String] ) -> Union[bytes, str, String]

findExecutable

__static_File_findExecutable(toolName: Union[bytes, str, String] ) -> Union[bytes, str, String]

getExecutablePath

__static_File_getExecutablePath() -> Union[bytes, str, String]

getOpenMSDataPath

__static_File_getOpenMSDataPath() -> Union[bytes, str, String]

getOpenMSHomePath

__static_File_getOpenMSHomePath() -> Union[bytes, str, String]

getSystemParameters

__static_File_getSystemParameters() -> Param

getTempDirectory

__static_File_getTempDirectory() -> Union[bytes, str, String]

getTemporaryFile

__static_File_getTemporaryFile(alternative_file: Union[bytes, str, String] ) -> Union[bytes, str, String]

getUniqueName

__static_File_getUniqueName() -> Union[bytes, str, String]

getUserDirectory

__static_File_getUserDirectory() -> Union[bytes, str, String]

isDirectory

__static_File_isDirectory(path: Union[bytes, str, String] ) -> bool

path

__static_File_path(file: Union[bytes, str, String] ) -> Union[bytes, str, String]

readable

__static_File_readable(file: Union[bytes, str, String] ) -> bool

remove

__static_File_remove(file: Union[bytes, str, String] ) -> bool

removeDirRecursively

__static_File_removeDirRecursively(dir_name: Union[bytes, str, String] ) -> bool

rename

__static_File_rename(from_: Union[bytes, str, String] , to: Union[bytes, str, String] , overwrite_existing: bool , verbose: bool ) -> bool

writable

__static_File_writable(file: Union[bytes, str, String] ) -> bool

absolutePath()#

__static_File_absolutePath(file: Union[bytes, str, String] ) -> Union[bytes, str, String]

basename()#

__static_File_basename(file: Union[bytes, str, String] ) -> Union[bytes, str, String]

empty()#

__static_File_empty(file: Union[bytes, str, String] ) -> bool

exists()#

__static_File_exists(file: Union[bytes, str, String] ) -> bool

fileList()#

__static_File_fileList(dir: Union[bytes, str, String] , file_pattern: Union[bytes, str, String] , output: List[bytes] , full_path: bool ) -> bool

find()#

__static_File_find(filename: Union[bytes, str, String] , directories: List[bytes] ) -> Union[bytes, str, String]

findDatabase()#

__static_File_findDatabase(db_name: Union[bytes, str, String] ) -> Union[bytes, str, String]

findDoc()#

__static_File_findDoc(filename: Union[bytes, str, String] ) -> Union[bytes, str, String]

findExecutable()#

__static_File_findExecutable(toolName: Union[bytes, str, String] ) -> Union[bytes, str, String]

getExecutablePath()#

__static_File_getExecutablePath() -> Union[bytes, str, String]

getOpenMSDataPath()#

__static_File_getOpenMSDataPath() -> Union[bytes, str, String]

getOpenMSHomePath()#

__static_File_getOpenMSHomePath() -> Union[bytes, str, String]

getSystemParameters()#

__static_File_getSystemParameters() -> Param

getTempDirectory()#

__static_File_getTempDirectory() -> Union[bytes, str, String]

getTemporaryFile()#

__static_File_getTemporaryFile(alternative_file: Union[bytes, str, String] ) -> Union[bytes, str, String]

getUniqueName()#

__static_File_getUniqueName() -> Union[bytes, str, String]

getUserDirectory()#

__static_File_getUserDirectory() -> Union[bytes, str, String]

isDirectory()#

__static_File_isDirectory(path: Union[bytes, str, String] ) -> bool

path()#

__static_File_path(file: Union[bytes, str, String] ) -> Union[bytes, str, String]

readable()#

__static_File_readable(file: Union[bytes, str, String] ) -> bool

remove()#

__static_File_remove(file: Union[bytes, str, String] ) -> bool

removeDirRecursively()#

__static_File_removeDirRecursively(dir_name: Union[bytes, str, String] ) -> bool

rename()#

__static_File_rename(from_: Union[bytes, str, String] , to: Union[bytes, str, String] , overwrite_existing: bool , verbose: bool ) -> bool

writable()#

__static_File_writable(file: Union[bytes, str, String] ) -> bool