Inheritance diagram for scriptforge.SFScriptForge.SF_FileSystem:

Collaboration diagram for scriptforge.SFScriptForge.SF_FileSystem:

Public Member Functions
def	BuildPath (self, foldername, name)

def	CompareFiles (self, filename1, filename2, comparecontents=False)

def	CopyFile (self, source, destination, overwrite=True)

def	CopyFolder (self, source, destination, overwrite=True)

def	CreateFolder (self, foldername)

def	CreateTextFile (self, filename, overwrite=True, encoding='UTF-8')

def	DeleteFile (self, filename)

def	DeleteFolder (self, foldername)

def	ExtensionFolder (self, extension)

def	FileExists (self, filename)

def	Files (self, foldername, filter='', includesubfolders=False)

def	FolderExists (self, foldername)

def	GetBaseName (self, filename)

def	GetExtension (self, filename)

def	GetFileLen (self, filename)

def	GetFileModified (self, filename)

def	GetName (self, filename)

def	GetParentFolderName (self, filename)

def	GetTempName (self, extension='')

def	HashFile (self, filename, algorithm)

def	MoveFile (self, source, destination)

def	Normalize (self, filename)

def	MoveFolder (self, source, destination)

def	OpenTextFile (self, filename, iomode=1, create=False, encoding='UTF-8')

def	PickFile (self, defaultfile=ScriptForge.cstSymEmpty, mode='OPEN', filter='')

def	PickFolder (self, defaultfolder=ScriptForge.cstSymEmpty, freetext='')

def	SubFolders (self, foldername, filter='', includesubfolders=False)

Public Member Functions inherited from scriptforge.SFServices
def	__init__ (self, reference=-1, objtype=None, classmodule=0, name='')

def	__getattr__ (self, name)

def	__setattr__ (self, name, value)

def	__repr__ (self)

def	Dispose (self)

def	ExecMethod (self, flags=0, methodname='', *args)

def	GetProperty (self, propertyname, arg=None)

def	Properties (self)

def	basicmethods (self)

def	basicproperties (self)

def	SetProperty (self, propertyname, value)

Public Member Functions inherited from scriptforge._Singleton
def	__call__ (cls, args, *kwargs)

Static Public Attributes
string	serviceimplementation = 'basic'

string	servicename = 'ScriptForge.FileSystem'

tuple	servicesynonyms = ('filesystem', 'scriptforge.filesystem')

	serviceproperties

bool	forceGetProperty = True

	ForReading

	ForWriting

	ForAppending

Static Public Attributes inherited from scriptforge.SFServices
	vbGet

	vbLet

	vbMethod

	vbSet

int	flgPost = 32

int	flgDateArg = 64

int	flgDateRet = 128

int	flgArrayArg = 512

int	flgArrayRet = 1024

int	flgUno = 256

int	flgObject = 2048

int	flgHardCode = 4096

	moduleClass

	moduleStandard

bool	forceGetProperty = False

dictionary	propertysynonyms = {}

tuple	internal_attributes

	SIMPLEEXEC = ScriptForge.InvokeSimpleScript

	EXEC = ScriptForge.InvokeBasicService

Static Public Attributes inherited from scriptforge._Singleton
dictionary	instances = {}

Private Member Functions
def	_ConvertFromUrl (cls, filename)

Additional Inherited Members
Public Attributes inherited from scriptforge.SFServices
	objectreference

	objecttype

	classmodule

	name

	internal

	localProperties

	serviceimplementation

Detailed Description

    The "FileSystem" service includes common file and folder handling routines.

Definition at line 1078 of file scriptforge.py.

Member Function Documentation

◆ _ConvertFromUrl()

def scriptforge.SFScriptForge.SF_FileSystem._ConvertFromUrl	(	cls,
		filename
	)

private

Definition at line 1192 of file scriptforge.py.

References scriptforge.SFServices.SIMPLEEXEC.

Referenced by scriptforge.SFScriptForge.SF_FileSystem.CompareFiles(), scriptforge.SFScriptForge.SF_FileSystem.GetFileLen(), and scriptforge.SFScriptForge.SF_FileSystem.HashFile().

◆ BuildPath()

def scriptforge.SFScriptForge.SF_FileSystem.BuildPath	(	self,
		foldername,
		name
	)

Definition at line 1094 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ CompareFiles()

def scriptforge.SFScriptForge.SF_FileSystem.CompareFiles	(	self,
		filename1,
		filename2,
		comparecontents = `False`
	)

Definition at line 1097 of file scriptforge.py.

References scriptforge.SFScriptForge.SF_FileSystem._ConvertFromUrl(), scriptforge.SFScriptForge.SF_FileSystem.FileExists(), and scriptforge.SFServices.SIMPLEEXEC.

◆ CopyFile()

def scriptforge.SFScriptForge.SF_FileSystem.CopyFile	(	self,
		source,
		destination,
		overwrite = `True`
	)

Definition at line 1106 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ CopyFolder()

def scriptforge.SFScriptForge.SF_FileSystem.CopyFolder	(	self,
		source,
		destination,
		overwrite = `True`
	)

Definition at line 1109 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ CreateFolder()

def scriptforge.SFScriptForge.SF_FileSystem.CreateFolder	(	self,
		foldername
	)

Definition at line 1112 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ CreateTextFile()

def scriptforge.SFScriptForge.SF_FileSystem.CreateTextFile	(	self,
		filename,
		overwrite = `True`,
		encoding = `'UTF-8'`
	)

Definition at line 1115 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ DeleteFile()

def scriptforge.SFScriptForge.SF_FileSystem.DeleteFile	(	self,
		filename
	)

Definition at line 1118 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ DeleteFolder()

def scriptforge.SFScriptForge.SF_FileSystem.DeleteFolder	(	self,
		foldername
	)

Definition at line 1121 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ ExtensionFolder()

def scriptforge.SFScriptForge.SF_FileSystem.ExtensionFolder	(	self,
		extension
	)

Definition at line 1124 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ FileExists()

def scriptforge.SFScriptForge.SF_FileSystem.FileExists	(	self,
		filename
	)

Definition at line 1127 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

Referenced by scriptforge.SFScriptForge.SF_FileSystem.CompareFiles(), scriptforge.SFScriptForge.SF_FileSystem.GetFileLen(), and scriptforge.SFScriptForge.SF_FileSystem.HashFile().

◆ Files()

def scriptforge.SFScriptForge.SF_FileSystem.Files	(	self,
		foldername,
		filter = `''`,
		includesubfolders = `False`
	)

Definition at line 1130 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ FolderExists()

def scriptforge.SFScriptForge.SF_FileSystem.FolderExists	(	self,
		foldername
	)

Definition at line 1133 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ GetBaseName()

def scriptforge.SFScriptForge.SF_FileSystem.GetBaseName	(	self,
		filename
	)

Definition at line 1136 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ GetExtension()

def scriptforge.SFScriptForge.SF_FileSystem.GetExtension	(	self,
		filename
	)

Definition at line 1139 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ GetFileLen()

def scriptforge.SFScriptForge.SF_FileSystem.GetFileLen	(	self,
		filename
	)

Definition at line 1142 of file scriptforge.py.

References scriptforge.SFScriptForge.SF_FileSystem._ConvertFromUrl(), scriptforge.SFScriptForge.SF_FileSystem.FileExists(), and scriptforge.SFServices.SIMPLEEXEC.

◆ GetFileModified()

def scriptforge.SFScriptForge.SF_FileSystem.GetFileModified	(	self,
		filename
	)

Definition at line 1150 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), scriptforge.SFServices.flgDateRet, and scriptforge.SFServices.vbMethod.

◆ GetName()

def scriptforge.SFScriptForge.SF_FileSystem.GetName	(	self,
		filename
	)

Definition at line 1153 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ GetParentFolderName()

def scriptforge.SFScriptForge.SF_FileSystem.GetParentFolderName	(	self,
		filename
	)

Definition at line 1156 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ GetTempName()

def scriptforge.SFScriptForge.SF_FileSystem.GetTempName	(	self,
		extension = `''`
	)

Definition at line 1159 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ HashFile()

def scriptforge.SFScriptForge.SF_FileSystem.HashFile	(	self,
		filename,
		algorithm
	)

Definition at line 1162 of file scriptforge.py.

References scriptforge.SFScriptForge.SF_FileSystem._ConvertFromUrl(), scriptforge.SFScriptForge.SF_FileSystem.FileExists(), and scriptforge.SFServices.SIMPLEEXEC.

◆ MoveFile()

def scriptforge.SFScriptForge.SF_FileSystem.MoveFile	(	self,
		source,
		destination
	)

Definition at line 1170 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ MoveFolder()

def scriptforge.SFScriptForge.SF_FileSystem.MoveFolder	(	self,
		source,
		destination
	)

Definition at line 1176 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ Normalize()

def scriptforge.SFScriptForge.SF_FileSystem.Normalize	(	self,
		filename
	)

Definition at line 1173 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ OpenTextFile()

def scriptforge.SFScriptForge.SF_FileSystem.OpenTextFile	(	self,
		filename,
		iomode = `1`,
		create = `False`,
		encoding = `'UTF-8'`
	)

Definition at line 1179 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ PickFile()

def scriptforge.SFScriptForge.SF_FileSystem.PickFile	(	self,
		defaultfile = `ScriptForge.cstSymEmpty`,
		mode = `'OPEN'`,
		filter = `''`
	)

Definition at line 1182 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ PickFolder()

def scriptforge.SFScriptForge.SF_FileSystem.PickFolder	(	self,
		defaultfolder = `ScriptForge.cstSymEmpty`,
		freetext = `''`
	)

Definition at line 1185 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

◆ SubFolders()

def scriptforge.SFScriptForge.SF_FileSystem.SubFolders	(	self,
		foldername,
		filter = `''`,
		includesubfolders = `False`
	)

Definition at line 1188 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

Member Data Documentation

◆ ForAppending

scriptforge.SFScriptForge.SF_FileSystem.ForAppending

static

Definition at line 1092 of file scriptforge.py.

◆ forceGetProperty

bool scriptforge.SFScriptForge.SF_FileSystem.forceGetProperty = True

static

Definition at line 1090 of file scriptforge.py.

◆ ForReading

scriptforge.SFScriptForge.SF_FileSystem.ForReading

static

Definition at line 1092 of file scriptforge.py.

◆ ForWriting

scriptforge.SFScriptForge.SF_FileSystem.ForWriting

static

Definition at line 1092 of file scriptforge.py.

◆ serviceimplementation

string scriptforge.SFScriptForge.SF_FileSystem.serviceimplementation = 'basic'

static

Definition at line 1083 of file scriptforge.py.

Referenced by scriptforge.SFServices.__repr__(), scriptforge.SFServices.__setattr__(), scriptforge.SFServices.basicmethods(), scriptforge.SFServices.basicproperties(), scriptforge.SFServices.Dispose(), scriptforge.SFServices.GetProperty(), and scriptforge.SFServices.SetProperty().

◆ servicename

string scriptforge.SFScriptForge.SF_FileSystem.servicename = 'ScriptForge.FileSystem'

static

Definition at line 1084 of file scriptforge.py.

Referenced by scriptforge.ScriptForge.__init__(), and scriptforge.SFServices.__repr__().

◆ serviceproperties

scriptforge.SFScriptForge.SF_FileSystem.serviceproperties

static

Initial value:

=  dict(FileNaming = True, ConfigFolder = False, ExtensionsFolder = False, HomeFolder = False,
                                 InstallFolder = False, TemplatesFolder = False, TemporaryFolder = False,
                                 UserTemplatesFolder = False)

Definition at line 1086 of file scriptforge.py.

Referenced by scriptforge.SFServices.__setattr__(), and scriptforge.SFServices.Properties().

◆ servicesynonyms

tuple scriptforge.SFScriptForge.SF_FileSystem.servicesynonyms = ('filesystem', 'scriptforge.filesystem')

static

Definition at line 1085 of file scriptforge.py.

The documentation for this class was generated from the following file:

scriptforge.py

Public Member Functions

Static Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _ConvertFromUrl()

◆ BuildPath()

◆ CompareFiles()

◆ CopyFile()

◆ CopyFolder()

◆ CreateFolder()

◆ CreateTextFile()

◆ DeleteFile()

◆ DeleteFolder()

◆ ExtensionFolder()

◆ FileExists()

◆ Files()

◆ FolderExists()

◆ GetBaseName()

◆ GetExtension()

◆ GetFileLen()

◆ GetFileModified()

◆ GetName()

◆ GetParentFolderName()

◆ GetTempName()

◆ HashFile()

◆ MoveFile()

◆ MoveFolder()

◆ Normalize()

◆ OpenTextFile()

◆ PickFile()

◆ PickFolder()

◆ SubFolders()

Member Data Documentation

◆ ForAppending

◆ forceGetProperty

◆ ForReading

◆ ForWriting

◆ serviceimplementation

◆ servicename

◆ serviceproperties

◆ servicesynonyms