def getPath(self):
"""Returns the exact position of the class file in the file system."""
# Automatically write file (from eventually processed text content) when it does not exist
if self.__text is not None and not File.exists(self.__path):
File.write(self.__path, self.getText())
return self.__path
def getPath(self):
"""Returns the exact position of the class file in the file system."""
# Automatically write file (from eventually processed text content) when it does not exist
if self.__text is not None and not File.exists(self.__path):
File.write(self.__path, self.getText())
return self.__path
def saveText(self, text, path, encoding="utf-8"):
"""
Saves the given text under the given path and stores both for future access
This is mainly useful for "virtual" files which are not edited by the developer
but which are created dynamically during runtime.
"""
self.__text = text
self.__path = path
if not File.exists(path) or File.read(path) != text:
File.write(path, text)
self.mtime = os.stat(path).st_mtime
def saveText(self, text, path, encoding="utf-8"):
"""
Saves the given text under the given path and stores both for future access.
This is mainly useful for "virtual" files which are not edited by the developer but which are created
dynamically during runtime.
"""
self.__text = text
self.__path = path
if not File.exists(path) or File.read(path) != text:
File.write(path, text)
self.mtime = os.stat(path).st_mtime
def write(self, distFolder, classFilter=None, callback="apiload", showInternals=False, showPrivates=False, printErrors=True, highlightCode=True):
"""
Writes API data generated from JavaScript into distFolder
:param distFolder: Where to store the API data
:param classFilter: Tuple of classes or method to use for filtering
:param callback: Name of callback to use for loading or None if pure JSON should be used
:param showInternals: Include internal methods inside API data
:param showPrivates: Include private methods inside API data
:param printErrors: Whether errors should be printed to the console
:param highlightCode: Whether to enable code highlighting using Pygments
:type distFolder: str
:type classFilter: tuple or function
:type callback: function
:type showInternals: bool
:type showPrivates: bool
:type printErrors: bool
:type highlightCode: bool
"""
#
# Collecting
#
Console.info("Collecting API Data...")
Console.indent()
apiData = {}
highlightedCode = {}
for project in self.__session.getProjects():
classes = project.getClasses()
Console.info("Loading API of project %s: %s...", Console.colorize(project.getName(), "bold"), Console.colorize("%s classes" % len(classes), "cyan"))
Console.indent()
for className in classes:
if self.__isIncluded(className, classFilter):
data = classes[className].getApi(highlightCode)
if not data.isEmpty:
apiData[className] = data
highlightedCode[className] = classes[className].getHighlightedCode()
else:
Console.info("Skipping %s, class is empty." % className)
Console.outdent()
Console.outdent()
#
# Processing
#
Console.info("Processing API Data...")
Console.indent()
data, index, search = self.__process(apiData, classFilter=classFilter, internals=showInternals, privates=showPrivates, printErrors=printErrors, highlightCode=highlightCode)
Console.outdent()
#
# Writing
#
Console.info("Storing API data...")
Console.indent()
writeCounter = 0
extension = "js" if callback else "json"
compress = True
class JsonEncoder(json.JSONEncoder):
def default(self, obj):
if isinstance(obj, set):
return list(obj)
return json.JSONEncoder.default(self, obj)
def encode(content, name):
if compress:
jsonContent = json.dumps(content, sort_keys=True, cls=JsonEncoder, separators=(',',':'))
else:
jsonContent = json.dumps(content, sort_keys=True, cls=JsonEncoder, indent=2)
if callback:
return "%s(%s,'%s');" % (callback, jsonContent, name)
else:
return jsonContent
Console.info("Saving class data (%s files)...", len(data))
Console.indent()
for className in data:
try:
classData = data[className]
if type(classData) is dict:
classExport = classData
else:
classExport = classData.export()
File.write(self.__session.expandFileName(os.path.join(distFolder, "%s.%s" % (className, extension))), encode(classExport, className))
except TypeError as writeError:
Console.error("Could not write API data of: %s: %s", className, writeError)
continue
Console.outdent()
if highlightCode:
Console.info("Saving highlighted code (%s files)...", len(highlightedCode))
Console.indent()
for className in highlightedCode:
try:
File.write(self.__session.expandFileName(os.path.join(distFolder, "%s.html" % className)), highlightedCode[className])
except TypeError as writeError:
Console.error("Could not write highlighted code of: %s: %s", className, writeError)
continue
Console.outdent()
Console.info("Writing index...")
Console.indent()
File.write(self.__session.expandFileName(os.path.join(distFolder, "meta-index.%s" % extension)), encode(index, "meta-index"))
File.write(self.__session.expandFileName(os.path.join(distFolder, "meta-search.%s" % extension)), encode(search, "meta-search"))
Console.outdent()
Console.outdent()
def write(self,
distFolder,
classFilter=None,
callback="apiload",
showInternals=False,
showPrivates=False,
printErrors=True,
highlightCode=True):
"""
Writes API data generated from JavaScript into distFolder.
:param distFolder: Where to store the API data
:param classFilter: Tuple of classes or method to use for filtering
:param callback: Name of callback to use for loading or None if pure JSON should be used
:param showInternals: Include internal methods inside API data
:param showPrivates: Include private methods inside API data
:param printErrors: Whether errors should be printed to the console
:param highlightCode: Whether to enable code highlighting using Pygments
:type distFolder: str
:type classFilter: tuple or function
:type callback: function
:type showInternals: bool
:type showPrivates: bool
:type printErrors: bool
:type highlightCode: bool
"""
#
# Collecting
#
Console.info("Collecting API Data...")
Console.indent()
apiData = {}
highlightedCode = {}
for project in self.__session.getProjects():
classes = project.getScripts()
Console.info("Loading API of project %s: %s...",
Console.colorize(project.getName(), "bold"),
Console.colorize("%s classes" % len(classes), "cyan"))
Console.indent()
for className in classes:
if self.__isIncluded(className, classFilter):
data = classes[className].getApi(highlightCode)
if not data.isEmpty:
apiData[className] = data
highlightedCode[className] = classes[
className].getHighlightedCode()
else:
Console.info("Skipping %s, class is empty." %
className)
Console.outdent()
Console.outdent()
#
# Processing
#
Console.info("Processing API Data...")
Console.indent()
data, index, search = self.__process(apiData,
classFilter=classFilter,
internals=showInternals,
privates=showPrivates,
printErrors=printErrors,
highlightCode=highlightCode)
Console.outdent()
#
# Writing
#
Console.info("Storing API data...")
Console.indent()
writeCounter = 0
extension = "js" if callback else "json"
compress = True
class JsonEncoder(json.JSONEncoder):
def default(self, obj):
if isinstance(obj, set):
return list(obj)
return json.JSONEncoder.default(self, obj)
def encode(content, name):
if compress:
jsonContent = json.dumps(content,
sort_keys=True,
cls=JsonEncoder,
separators=(',', ':'))
else:
jsonContent = json.dumps(content,
sort_keys=True,
cls=JsonEncoder,
indent=2)
if callback:
return "%s(%s,'%s');" % (callback, jsonContent, name)
else:
return jsonContent
Console.info("Saving class data (%s files)...", len(data))
Console.indent()
for className in data:
try:
classData = data[className]
if isinstance(classData, dict):
classExport = classData
else:
classExport = classData.export()
File.write(
self.__profile.expandFileName(
os.path.join(distFolder,
"%s.%s" % (className, extension))),
encode(classExport, className))
except TypeError as writeError:
Console.error("Could not write API data of: %s: %s", className,
writeError)
continue
Console.outdent()
if highlightCode:
Console.info("Saving highlighted code (%s files)...",
len(highlightedCode))
Console.indent()
for className in highlightedCode:
try:
File.write(
self.__profile.expandFileName(
os.path.join(distFolder, "%s.html" % className)),
highlightedCode[className])
except TypeError as writeError:
Console.error(
"Could not write highlighted code of: %s: %s",
className, writeError)
continue
Console.outdent()
Console.info("Writing index...")
Console.indent()
File.write(
self.__profile.expandFileName(
os.path.join(distFolder, "meta-index.%s" % extension)),
encode(index, "meta-index"))
File.write(
self.__profile.expandFileName(
os.path.join(distFolder, "meta-search.%s" % extension)),
encode(search, "meta-search"))
Console.outdent()
Console.outdent()
