mFileSystem.jsonFileLib.JSONFile Class Reference

[ CLASS ] - Class to operate on JSON files. More...

Inheritance diagram for mFileSystem.jsonFileLib.JSONFile:

Public Member Functions
def	__init__ (self, path=None)
	Constructor. More...
def	setFile (self, path)
	Set file. More...
PROPERTIES
def	setContent (self, content)
	Set JSON content. More...
CONTENT
def	write (self, indent=None)
	Write the content into the file. More...
def	read (self)
	Read the content of the file and store it in content member. More...
Public Member Functions inherited from mFileSystem.fileLib.File
def	__str__ (self)
	String representation. More...
def	asStr (self)
	Get string representation. More...
def	asDict (self)
	Get file information as dict instance. More...
def	update (self)
	Update information of the file in case it has been altered. More...
def	exists (self)
	Check whether the file exists. More...
def	rename (self, newName)
	Rename the file. More...
def	remove (self)
	Remove the file. More...
def	create (cls, path, overwrite=False, binary=False)
	Create a file and return a mFileSystem.fileLib.File instance for it. More...
def	file (self)
	Absolute path of the file. More...
def	directory (self)
	Directory where the file is located in. More...
def	fileName (self)
	Name of the file with it's extension. More...
def	baseName (self)
	Name of the file without extension, base name. More...
def	extension (self)
	File's extension. More...
def	size (self)
	File size in bytes. More...
def	sizeStr (self)
	File size as human readable string. More...
def	content (self)
	Content of the file. More...
def	copy (self, destinationFile, overwrite=False)
	Copy the file. More...
def	copyToPath (self, destinationPath, overwrite=False)
	Copy the file to given path. More...
def	write (self, line, append=True)
	Write given line into the file. More...
def	writeLines (self, lines, append=True)
	Write given lines into the file. More...
def	readLines (self)
	Read lines. More...
def	lineCount (self)
	Get line count of the file. More...

Additional Inherited Members
Static Public Member Functions inherited from mFileSystem.fileLib.File
def	fileExists (path)
	Check whether the given file exists. More...
def	getFileSizeAsStr (size, precision=2)
	Get given byte size in human readable string. More...
def	replaceExtension (path, newExtension)
	Replace given files extension with given extension. More...

Detailed Description

[ CLASS ] - Class to operate on JSON files.

Constructor & Destructor Documentation

__init__()

def mFileSystem.jsonFileLib.JSONFile.__init__	(		self,
			path = None
	)

Constructor.

Parameters

path	[ str | None | in ] - Absolute path of a file.

Exceptions

N/A

Returns

None - None.

Reimplemented from mFileSystem.fileLib.File.

Reimplemented in mMecoSettings.appLib.AppFile.

Member Function Documentation

setContent()

def mFileSystem.jsonFileLib.JSONFile.setContent	(		self,
			content
	)

Set JSON content.

Parameters

content

[ variant | None | in ] - Value to be set.

Exceptions

N/A

Returns

None - None.

setFile()

def mFileSystem.jsonFileLib.JSONFile.setFile	(		self,
			path
	)

Set file.

Parameters

path	[ str | None | in ] - Absolute path of a file.

Exceptions

N/A

Returns

bool - Result, returns False is the file doesn't exist, True otherwise.

Reimplemented from mFileSystem.fileLib.File.

Reimplemented in mMecoSettings.appLib.AppFile.

write()

def mFileSystem.jsonFileLib.JSONFile.write	(		self,
			indent = None
	)

Write the content into the file.

Parameters

indent

[ int | None | in ] - Indentation.

Exceptions

N/A

Returns

bool - Result.

read()

def mFileSystem.jsonFileLib.JSONFile.read

(

self

)

Read the content of the file and store it in content member.

Exceptions

N/A

Returns

variant - Content.

Reimplemented from mFileSystem.fileLib.File.

Reimplemented in mMecoSettings.appLib.AppFile.

---

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

• mFileSystem/python/mFileSystem/jsonFileLib.py