jasy.item package

Submodules

jasy.item.Abstract module

class jasy.item.Abstract.AbstractItem(project, id=None, package=None)

Bases: object

attach(path)

classmethod fromPath(project, relpath, package=None)

Initialize MyData from a dict’s items.

generateId(relpath, package)

getChecksum(mode='rb')

Returns the SHA1 checksum of the item.

getId()

Returns a unique identify of the class.

Typically as it is stored inside the project.

getModificationTime()

Returns last modification time of the class.

getPath()

Returns the exact position of the class file in the file system.

getProject()

Returns the project which the class belongs to.

getText(encoding='utf-8')

Reads the file (as UTF-8) and returns the text

id = None

kind = 'jasy.Item'

mtime = None

project = None

saveText(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.

setId(id)

setPath(path)

Sets the path for the item.

setText(text)

Stores text from custom reader.

setTextFilter(filterCallback)

Sets text filter callback that is called on getText().

With this callback e.g. transformations from CoffeeScript to JavaScript are possible. The callback gets two parameter (text, ItemClass)

jasy.item.Asset module

class jasy.item.Asset.AssetItem(project, id=None, package=None)

Bases: jasy.item.Abstract.AbstractItem

addImageAnimationData(columns, rows, frames=None, layout=None)

addImageDimensionData(width, height)

addImageSpriteData(id, left, top)

exportData()

generateId(relpath, package)

getParsedObject()

getType(short=False)

isAudio()

isImage()

isImageAnimationConfig()

isImageSpriteConfig()

isText()

isVideo()

kind = 'jasy.Asset'

setId(id)

jasy.item.Doc module

class jasy.item.Doc.DocItem(project, id=None, package=None)

Bases: jasy.item.Abstract.AbstractItem

generateId(relpath, package)

Generates the fileId of this item as being used by other modules.

getApi()

kind = 'jasy.Doc'

jasy.item.Script module

exception jasy.item.Script.ScriptError(inst, msg)

Bases: Exception

class jasy.item.Script.ScriptItem(project, id=None, package=None)

Bases: jasy.item.Abstract.AbstractItem

filterPermutation(permutation)

generateId(relpath, package)

Generates the fileId of this item as being used by other modules.

getApi(highlight=True)

getBreaks(permutation=None, items=None)

Returns all down-priorized dependencies. This are dependencies which are required to make the module work, but are not required being available before the current item.

getCompressed(profile)

getDependencies(permutation=None, items=None, fields=None, warnings=True)

Returns a set of dependencies seen through the given list of known classes (ignoring all unknown items in original set) and configured fields with their individual detection classes.

This method also makes use of the meta data and the variable data.

getFields()

getHighlightedCode()

getMetaData(permutation=None)

getScopeData(permutation=None)

Returns the top level scope object which contains information about the global variable and package usage/influence.

getTranslations()

kind = 'jasy.Script'

jasy.item.Script.collectFields(node, keys=None)

jasy.item.Style module

exception jasy.item.Style.StyleError(inst, msg)

Bases: Exception

Error class used for issues during style processing.

class jasy.item.Style.StyleItem(project, id=None, package=None)

Bases: jasy.item.Abstract.AbstractItem

filterPermutation(permutation)

Returns a new permutation which only contains information about the fields actually accessed in this stylesheet.

generateId(relpath, package)

Generates the fileId of this item as being used by other modules.

getBreaks(permutation=None, items=None, warnings=True)

Returns all down-priorized dependencies. These are dependencies which are required to make the item work, but are not required being available before the current item.

getCompressed(profile)

Returns the compressed CSS code of this item.

getDependencies(permutation=None, items=None, fields=None, warnings=True)

Returns a set of dependencies seen through the given list of known items (ignoring all unknown items in original set).

getFields()

Returns the fields which are used by this stylesheet.

getIncludes(permutation)

Returns the includes which are referenced by this stylesheet.

getMergedTree(profile)

Returns the merged (includes resolved) and optimized.

(permutation values applied) tree.

getMetaData(permutation)

Returns the meta data of this stylesheet.

getModificationTime(profile)

Returns the modification date of the stylesheet.

(or the sum of modification dates when using includes)

kind = 'jasy.Style'

jasy.item.Style.collectFields(node, keys=None, condition=False)

Collects all fields accessed by the given root node and all children.

Returns a set of field names.

jasy.item.Style.includeGenerator(node)

A generator which yiels include names and the origin include nodes for every include in the given root node.

jasy.item.Template module

class jasy.item.Template.TemplateItem(project, id=None, package=None)

Bases: jasy.item.Abstract.AbstractItem

attach(path)

generateId(relpath, package)

Generates the fileId of this item as being used by other modules.

getScriptItem()

Returns a class representation for the template instance.

kind = 'jasy.Template'

jasy.item.Template.escapeContent(content)

jasy.item.Template.templateFilter(text, item)

jasy.item.Translation module

class jasy.item.Translation.TranslationItem(project, id=None, package=None, table=None)

Bases: jasy.item.Abstract.AbstractItem

attach(path)

export(classes, formatted=True)

Exports the translation table as JSON based on the given set of classes.

generateId(relpath, package)

Generates the fileId of this item as being used by other modules.

getLanguage()

Returns the language of the translation file.

getTable()

Returns the translation table.

kind = 'jasy.Translation'

setId(id)

jasy.item.Translation.generateMessageId(basic, plural=None, context=None)

Returns a unique message ID based on info typically stored in the code: id, plural, context

Module contents