Tronverte
API documentation for Tronverte products.
 All Classes Namespaces Files Functions Variables
Public Member Functions
tronverte.io.io.IO Class Reference

This class offers IO related methods. More...

List of all members.

Public Member Functions

def __init__
def setDirectory
def getDirectory
def listFolders
def listDirectories
def listDirectoriesRecursively
def listFiles
def listFilesAbsolutePath
def listFilesRecursively

Detailed Description

This class offers IO related methods.

import tronverte.io.io as tronverte_io
reload(tronverte_io)
io = tronverte_io.IO('c:/')

You can get files, folders, directories, etc. Class allows you to make recursive queries as well.

Constructor & Destructor Documentation

def tronverte.io.io.IO.__init__ (   self,
  directory 
)
# DESCRIPTION
Default constructor.

# ARGUMENTS
directory | str | None | in | + | arg | Absolute path of the directory.

# RETURN
None

Member Function Documentation

# DESCRIPTION
Get the directory.

# ARGUMENTS
None

# RETURN
str | Directory.
def tronverte.io.io.IO.listDirectories (   self,
  directory = None 
)
# DESCRIPTION
List directories in given directory.

# ARGUMENTS
directory | str | None | in | + | arg | Absolute path of the directory. If this argument is left out directory of the instance of the class will be used.

# RETURN
str list | Directories.
# DESCRIPTION
List directories including sub directories.

# ARGUMENTS
None.

# RETURN
str list | Directories.
def tronverte.io.io.IO.listFiles (   self,
  extension = None 
)
# DESCRIPTION
List files.

# ARGUMENTS
extension | str | None | in | * | arg | Extension of the files that need to be found.

# RETURN
str list | Files.
def tronverte.io.io.IO.listFilesAbsolutePath (   self,
  directory = None,
  extension = None 
)
# DESCRIPTION
List files with full path.

# ARGUMENTS
directory | str | None | in | + | arg | Directory that will be searched. If this argument is left out directory of the instance of the class will be used.
extension | str | None | in | * | arg | Extension of the files that need to be found.

# RETURN
str list | Files.
def tronverte.io.io.IO.listFilesRecursively (   self,
  extension = None 
)
# DESCRIPTION
List files including files under sub directories.

# ARGUMENTS
extension | str | None | in | * | arg | Extension of the files that need to be found.

# RETURN
str list | Files.
# DESCRIPTION
List folders.

# ARGUMENTS
None.

# RETURN
str list | Folders.
def tronverte.io.io.IO.setDirectory (   self,
  directory 
)
# DESCRIPTION
Associate the given directory.

# ARGUMENTS
directory | str | None | in | + | arg | Absolute path of the directory.

# RETURN
bool | Result.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables