scripter.document_scripter.document.Document Class Reference

Inheritance diagram for scripter.document_scripter.document.Document:

Public Member Functions
	__init__ (self, filePath)
	compare (self, new_doc)
	data (self)
	data (self, data)
	filePath (self)
	open (self, filePath='')
	save (self)

Protected Attributes
	_document
	_filePath

Detailed Description

Definition at line 7 of file document.py.

Constructor & Destructor Documentation

__init__()

scripter.document_scripter.document.Document.__init__	(		self,
			filePath )

Definition at line 9 of file document.py.

    def __init__(self, filePath):
        self._document = []
        self._filePath = filePath
 

Member Function Documentation

compare()

scripter.document_scripter.document.Document.compare	(		self,
			new_doc )

Definition at line 24 of file document.py.

    def compare(self, new_doc):
        if len(self._document) != len(new_doc):
            return False
 
        if new_doc != self._document:
            return False
 
        return True
 

References scripter.document_scripter.document.Document._document.

data() [1/2]

scripter.document_scripter.document.Document.data

(

self

)

Definition at line 34 of file document.py.

    def data(self):
        return self._document
 

References scripter.document_scripter.document.Document._document.

data() [2/2]

scripter.document_scripter.document.Document.data	(		self,
			data )

Definition at line 38 of file document.py.

    def data(self, data):
        self._document = data
 

References scripter.document_scripter.document.Document._document.

filePath()

scripter.document_scripter.document.Document.filePath

(

self

)

Definition at line 42 of file document.py.

    def filePath(self):
        return self._filePath

References scripter.document_scripter.document.Document._filePath.

open()

scripter.document_scripter.document.Document.open	(		self,
			filePath = '' )

Definition at line 13 of file document.py.

    def open(self, filePath=''):
        if filePath:
            self._filePath = filePath
 
        with open(self._filePath, 'r') as pythonFile:
            self._document = pythonFile.read()
 

References scripter.document_scripter.document.Document._document, scripter.document_scripter.document.Document._filePath, and scripter.document_scripter.document.Document.open().

save()

scripter.document_scripter.document.Document.save

(

self

)

Definition at line 20 of file document.py.

    def save(self):
        with open(self._filePath, 'w') as pythonFile:
            pythonFile.write(self._document)
 

References scripter.document_scripter.document.Document._document, scripter.document_scripter.document.Document._filePath, and scripter.document_scripter.document.Document.open().

Member Data Documentation

_document

scripter.document_scripter.document.Document._document

protected

Definition at line 10 of file document.py.

_filePath

scripter.document_scripter.document.Document._filePath

protected

Definition at line 11 of file document.py.

---

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

• plugins/python/scripter/document_scripter/document.py