Welcome to Jasy – Web Tooling Framework’s documentation!

Contents:

jasy package

Subpackages

jasy.abstract package

Submodules

jasy.abstract.Resolver module

class jasy.abstract.Resolver.Resolver(profile)

Bases: object

Resolves dependencies between items.

This class is not type depended e.g. is used for both scripts and styles.

add(nameOrItem, prepend=False)

Adds an item by its name or via the item instance.

exclude(items)

Excludes the given items (just a hard-exclude which is applied after calculating the current dependencies)

getIncluded()

Returns a final set of classes after resolving dependencies.

getRequired()

Returns the user added classes - the so-called required classes.

remove(nameOrItem)

Removes an item via its name or via the item instance.

exception jasy.abstract.Resolver.ResolverError

Bases: Exception

Error which is throws when resolving items could be be finished because of items which could not be found or are of an unexpected type.

jasy.abstract.Sorter module

class jasy.abstract.Sorter.AbstractSorter(resolver)

Bases: object

Sorts a final list of items according to their requirements.

This class is not type depended e.g. is used for both scripts and styles.

getSorted()

Returns the sorted item list (caches result)

exception jasy.abstract.Sorter.SorterError

Bases: Exception

Error which is throws when sorting could not be done because of circular dependencies.

Module contents

jasy.asset package

Subpackages

jasy.asset.sprite package

Submodules

jasy.asset.sprite.Block module

class jasy.asset.sprite.Block.Block(w, h, image=False)

Bases: object

toJSON()

jasy.asset.sprite.BlockNode module

class jasy.asset.sprite.BlockNode.BlockNode(parent, x, y, w, h)

Bases: object

jasy.asset.sprite.BlockPacker module

class jasy.asset.sprite.BlockPacker.BlockPacker(w=0, h=0)

Bases: object

findNode(root, w, h)

fit(blocks)

getUnused()

growDown(w, h)

growNode(w, h)

growRight(w, h)

splitNode(node, w, h)

jasy.asset.sprite.File module

class jasy.asset.sprite.File.SpriteFile(width, height, relPath, fullPath, checksum)

Bases: object

jasy.asset.sprite.Sheet module

class jasy.asset.sprite.Sheet.SpriteSheet(packer, blocks)

Bases: object

export()

write(filename, debug=False)

Module contents

Submodules

jasy.asset.ImageInfo module

class jasy.asset.ImageInfo.GifFile(filename)

Bases: jasy.asset.ImageInfo.ImgFile

Class for parsing GIF files.

size()

type()

verify()

class jasy.asset.ImageInfo.ImgFile(filename)

Bases: object

Abstract base class for all image types.

close()

getChecksum()

size()

type()

verify()

class jasy.asset.ImageInfo.ImgInfo(filename)

Bases: object

classes = [<class 'jasy.asset.ImageInfo.PngFile'>, <class 'jasy.asset.ImageInfo.GifFile'>, <class 'jasy.asset.ImageInfo.JpegFile'>]

getChecksum()

getInfo()

Returns (width, height, “type”) of the image.

getSize()

Returns the image sizes of png, gif and jpeg files as.

(width, height) tuple

class jasy.asset.ImageInfo.JpegFile(filename)

Bases: jasy.asset.ImageInfo.ImgFile

size()

type()

verify()

class jasy.asset.ImageInfo.PngFile(filename)

Bases: jasy.asset.ImageInfo.ImgFile

Class for parsing PNG files.

size()

type()

verify()

jasy.asset.Manager module

class jasy.asset.Manager.AssetManager(profile)

Bases: object

addProject(project)

copyAssets()

Copies assets from their source folder to the configured destination folder.

Does apply file name transformations during copying when requested.

exportToJson(items=None)

Exports asset data for usage at the client side.

Utilizes JavaScript class jasy.Asset to inject data into the client at runtime.

getAnimationColumns(fileId)

getAnimationFrames(fileId)

getAnimationRows(fileId)

getAssetHeight(fileId)

Returns the width (image height) of the given item.

getAssetUrl(fileId)

Returns the asset URL for the given item relative to the current working path.

getAssetWidth(fileId)

Returns the width (image width) of the given item.

getSpriteHeight(fileId)

Returns the height of the sprite sheet which contains the given single image.

getSpriteId(fileId)

Returns the sprite asset which contains the image with the given ID.

getSpriteLeft(fileId)

Returns the left position of the image on the sprite sheet.

getSpriteTop(fileId)

Returns the top position of the image on the sprite sheet.

getSpriteUrl(fileId)

Returns the url of the sprite sheet which contains the given single image.

getSpriteWidth(fileId)

Returns the width of the sprite sheet which contains the given single image.

processAnimations()

Processes jasyanimation files to merge animation data into asset registry.

processSprites()

Processes jasysprite files to merge sprite data into asset registry.

jasy.asset.SpritePacker module

class jasy.asset.SpritePacker.PackerScore(sheets, external)

Bases: object

data()

class jasy.asset.SpritePacker.SpritePacker(base, types='png', width=1024, height=1024)

Bases: object

Packs single images into sprite images automatically.

addDir(directory, recursive=False)

Adds all images within a directory to the sprite packer.

addFile(relPath, fullPath)

Adds the specific file to the sprite packer.

clear()

Removes all generated sprite files found in the base directory.

generate(path='', debug=False)

Generate sheets/variants.

pack(width=1024, height=1024, sort=None, silent=False)

Packs all sprites within the pack into sheets of the given size.

packBest()

Pack blocks into a sprite sheet by trying multiple settings.

packDir(path='', recursive=True, debug=False)

Pack images inside a dir into sprite sheets.

setDataFormat(format='yaml')

Sets format for metadata output - for format support take a look at jasy.core.Config.

Module contents

jasy.core package

Submodules

jasy.core.Base62 module

jasy.core.Base62.decode(str)

jasy.core.Base62.decodeStringToArray(str)

jasy.core.Base62.decodeToArrayOfBytes(arr)

jasy.core.Base62.encode(str)

jasy.core.Base62.encodeArrayOfBytes(arr)

jasy.core.Base62.encodeArrayToString(arr)

jasy.core.Cache module

class jasy.core.Cache.Cache(path, filename='jasycache', hashkeys=False)

Bases: object

A cache class based on shelve feature of Python.

Supports transient in-memory storage, too. Uses memory storage for caching requests to DB as well for improved performance. Uses keys for identification of entries like a normal hash table / dictionary.

clear()

Clears the cache file(s)

close()

Closes the internal storage database.

open()

Opens a cache file in the given path.

read(key, timestamp=None, inMemory=True)

Reads the given value from cache.

Optionally support to check wether the value was stored after the given time to be valid (useful for comparing with file modification times).

store(key, value, timestamp=None, transient=False, inMemory=True)

Stores the given value.

Default timestamp goes to the current time. Can be modified to the time of an other files modification date etc. Transient enables in-memory cache for the given value

sync()

Syncs the internal storage database.

jasy.core.Config module

class jasy.core.Config.Config(data=None)

Bases: object

Wrapper around YAML/JSON with easy to use import tools for using question files, command line arguments, etc.

ask(question, name, accept=None, required=True, default=None, force=False, parse=True)

Asks the user for value for the given configuration field:

Parameters:

• question (string) – Question to ask the user
• name (string) – Name of field to store value in
• accept (string) – Any of the supported types to validate for (see matchesType)
• required (boolean) – Whether the field is required
• default – Default value whenever user has given no value

debug()

Prints data to the console.

executeScript(fileName, autoDelete=True, optional=False, encoding='utf-8')

Executes the given script for configuration proposes and deletes the file afterwards (by default).

Returns True when the file was found and processed.

export()

Returns a flat data structure of the internal data.

get(name, default=None)

Returns the value of the given field or None when field is not set.

has(name)

Returns whether there is a value for the given field name.

injectValues(parse=True, **argv)

Injects a list of arguments into the configuration file, typically used for injecting command line arguments.

loadValues(fileName, optional=False, encoding='utf-8')

Imports the values of the given config file Returns True when the file was found and processed.

Note: Supports dotted names to store into sub trees Note: This method overrides keys when they are already defined!

readQuestions(fileName, force=False, autoDelete=True, optional=False, encoding='utf-8')

Reads the given configuration file with questions and deletes the file afterwards (by default).

Returns True when the file was found and processed.

set(name, value, accept=None, parse=False)

Saves the given value under the given field.

write(fileName, indent=2, encoding='utf-8')

Uses config writer to write the configuration file to the application.

jasy.core.Config.findConfig(fileName)

Returns the name of a config file based on the given base file name (without extension).

Returns either a filename which endswith .yaml, .json or None when no file was found.

jasy.core.Config.isConfigName(fileName, requiredBaseName=None)

jasy.core.Config.loadConfig(fileName, encoding='utf-8')

Loads the given configuration file (filename without extension) and returns the parsed object structure.

jasy.core.Config.writeConfig(data, fileName, indent=2, encoding='utf-8')

Writes the given data structure to the given file name.

Based on the given extension a different file format is choosen. Currently use either .yaml or .json.

jasy.core.Console module

Centralized logging for complete Jasy environment.

jasy.core.Console.colorize(text, color='red')

Uses to colorize the given text for output on Unix terminals.

jasy.core.Console.header(title)

Outputs the given title with prominent formatting.

jasy.core.Console.error(text, *argv)

Outputs an error message (visible by default)

jasy.core.Console.warn(text, *argv)

Outputs an warning (visible by default)

jasy.core.Console.info(text, *argv)

Outputs an info message (visible by default, disable via –quiet option)

jasy.core.Console.debug(text, *argv)

Output a debug message (hidden by default, enable via –verbose option)

jasy.core.Console.indent()

Increments global indenting level. Prepends spaces to the next logging messages until outdent() is called.

Should be called whenever leaving a structural logging section.

jasy.core.Console.outdent(all=False)

Decrements global indenting level.

Should be called whenever leaving a structural logging section.

jasy.core.Create module

jasy.core.Create.create(name='myproject', origin=None, originVersion=None, skeleton=None, destination=None, session=None, **argv)

Creates a new project from a defined skeleton or an existing project’s root directory (only if there is a jasycreate config file).

Parameters:

• name (string) – The name of the new created project
• origin (string) – Path or git url to the base project
• originVersion (string) – Version of the base project from wich will be created.
• skeleton (string) – Name of a defined skeleton. None for creating from root
• destination (string) – Destination path for the new created project
• session (object) – An optional session to use as origin project

jasy.core.Create.getFirstSubFolder(start)

jasy.core.Create.massFilePatcher(path, data)

jasy.core.Doctor module

jasy.core.Doctor.doCompleteDoctor()

Checks for uninstalled or too old versions of requirements and gives a complete output.

jasy.core.Doctor.doInitializationDoctor()

Checks for uninstalled or too old versions only of requirements and gives error output.

jasy.core.File module

A module consisting of some often used file system actions in easy to use unix tradition.

jasy.core.File.cp(src, dst)

Copies a file.

jasy.core.File.cpdir(src, dst)

Copies a directory.

jasy.core.File.exists(name)

Returns whether the given file or folder exists.

jasy.core.File.mkdir(name)

Creates directory (works recursively)

jasy.core.File.mv(src, dst)

Moves files or directories.

jasy.core.File.read(name, encoding='utf-8')

Read the given file.

Returns None when file could not be found/opended

jasy.core.File.rm(name)

Removes the given file.

jasy.core.File.rmdir(name)

Removes a directory (works recursively)

jasy.core.File.sha1(fileOrPath, block_size=1048576)

Returns a SHA 1 checksum (as hex digest) of the given file (handle)

jasy.core.File.syncfile(src, dst)

Same as cp() but only do copying when source file is newer than target file.

jasy.core.File.write(dst, content, encoding='utf-8')

Writes the content to the destination file name.

jasy.core.FileManager module

class jasy.core.FileManager.FileManager(profile=None)

Bases: object

Summarizes utility methods for operations in filesystem.

copyDir(src, dst)

Copies a directory to a destination directory.

Merges the existing directory structure with the folder to copy.

copyFile(src, dst)

Copy src file to dst file.

Both should be filenames, not directories.

makeDir(dirname)

Creates missing hierarchy levels for given directory.

removeDir(dirname)

Removes the given directory.

removeFile(filename)

Removes the given file.

updateFile(src, dst)

Same as copyFile() but only do copying when source file is newer than target file.

writeFile(dst, content)

Writes the content to the destination file name.

jasy.core.FlagSet module

class jasy.core.FlagSet.FlagSet(*args)

Bases: object

Configures an formatting object which can be used to compress classes afterwards.

The optimization set is frozen after initialization which also generates the unique key based on the given formatting options.

disable(flag)

enable(flag)

getKey()

Returns a unique key to identify this formatting set.

has(key)

Whether the given formatting is enabled.

jasy.core.Inspect module

jasy.core.Inspect.extractDoc(value, limit=80, indent=2)

jasy.core.Inspect.extractType(value)

jasy.core.Inspect.generateApi(api)

Returns a stringified output for the given API set.

jasy.core.Inspect.highlightArgs(value, inClassOrObject=False)

jasy.core.Locale module

class jasy.core.Locale.LocaleParser(locale)

Bases: object

Parses CLDR locales into JavaScript files.

export(path)

getData()

Returns a Python object with the parsed CLDR data.

jasy.core.Locale.camelCaseToUpper(input)

jasy.core.Locale.pluralToJavaScript(expr)

Translates the CLDR plural rules from http://cldr.unicode.org/index/cldr-spec/plural-rules into JavaScript expressions

jasy.core.MetaData module

class jasy.core.MetaData.MetaData(tree)

Bases: object

Data structure to hold all meta information.

A instance of this class is typically created by processing all meta data relevant tags of all doc comments in the given node structure.

Hint: Must be a clean data class without links to other systems for optiomal cachability using Pickle

assets

breaks

optionals

parse(node)

The internal inspection routine to add relevant data from comments.

requires

jasy.core.Options module

class jasy.core.Options.Options

Bases: object

More flexible alternative to the standard python option parser module which solves the requirements to have arbirary tasks and custom parameters for each task.

add(name, accept=<class 'bool'>, value=None, short=None, help='')

getTasks()

parse(args)

printOptions(indent=16)

jasy.core.Permutation module

class jasy.core.Permutation.Permutation(combination)

Bases: object

Object to store a single kind of permutation.

filter(available)

Returns a variant of that permutation which only holds values for the available keys.

get(key)

Returns the value of the given key in the permutation.

getChecksum()

Returns the computed (SHA1) checksum based on the key of this permutation.

getKey()

Returns the computed key from this permutation.

has(key)

Whether the permutation holds a value for the given key.

jasy.core.Permutation.getPermutation(combination)

Small wrapper to omit double creation of identical permutations in filter() method As these instances don’t have any reference to session etc.

they are actually cacheable globally.

jasy.core.Profile module

class jasy.core.Profile.Profile(session)

Bases: object

Configuration object for the build profile of the current task.

addCommand(name, func, resultType=None, globalName=False)

Registers the given function as a new command.

executeCommand(command, params=None)

Executes the given command and returns the result.

expandFileName(fileName)

Replaces placeholders inside the given filename and returns the result. The placeholders are based on the current state of the session.

These are the currently supported placeholders:

• {{locale}}: Name of current locale e.g. de_DE
• {{permutation}}: SHA1 checksum of current permutation
• {{id}}: SHA1 checksum based on permutation and repository branch/revision

exportData()

getAssetManager()

getAssetOutputFolder()

Name of the folder inside the destination folder for storing used assets.

getCompressionLevel()

getCopyAssets()

getCssOutputFolder()

Name of the folder inside the destination folder for storing generated style sheets.

getCurrentFormatting()

getCurrentLocale()

Returns the current locale as defined in current permutation.

getCurrentLocaleProject(update=False)

Returns a locale project for the currently configured locale.

Returns None if locale is not set to a valid value.

getCurrentOptimization()

getCurrentPermutation()

Returns current permutation object (useful during looping through permutations via permutate()).

getCurrentTranslation()

getDestinationPath()

Relative or path of the destination folder.

getDestinationUrl()

The same as destination folder but from the URL/server perspective.

getFieldSetupScripts()

getFileManager()

getFlag(name, fallback=None)

getFormattingLevel()

getHashAssets()

getId()

getJsOutputFolder()

Name of the folder inside the destination folder for storing generated script files.

getMatchingValues(matcher, transformer=None)

getOutputFolder(type, fallback=None)

getOutputFolders()

getParts()

getProjects()

Returns all currently registered projects.

Injects locale project when current permutation has configured a locale.

getSession()

getSetupScripts()

Returns a list of (virtual) classes which are relevant for initial setup.

getTemplateOutputFolder()

Name of the folder inside the destination folder for storing compiled templates.

getUseSource()

getValue(key, fallback=None)

getWorkingPath()

permutate()

Generator method for permutations for improving output capabilities.

permutateField(name, values=None, detect=None, default=None)

Adds the given key/value pair to the session for permutation usage.

It supports an optional test. A test is required as soon as there is more than one value available. The detection method and values are typically already defined by the project declaring the key/value pair.

registerPart(name, className='', styleName='', templateName='')

resetCurrentPermutation()

Resets the current permutation object.

setAssetOutputFolder(folder)

setCompressionLevel(level)

setCopyAssets(enable)

setCssOutputFolder(folder)

setDefaultLocale(locale)

Sets the default locale.

setDestinationPath(path)

setDestinationUrl(url)

setField(name, value)

Statically configure the value of the given field.

This field is just injected into Permutation data and used for permutations, but as it only holds a single value all alternatives paths are removed/ignored.

setFlag(name, value)

setFormattingLevel(level)

setHashAssets(enable)

setJsOutputFolder(folder)

setLocales(locales, default=None)

Store locales as a special built-in field with optional default value

setOutputFolder(type, value)

setStaticPermutation(**argv)

Sets current permutation to a static permutation which contains all values hardly wired to static values using setField() or given via additional named parameters.

setTemplateOutputFolder(folder)

setUseSource(enable)

setValue(key, value)

setWorkingPath(path)

jasy.core.Project module

class jasy.core.Project.Project(path, session, config=None, version=None, fromurl=False)

Bases: object

addFile(relPath, fullPath, itemType, package, override=False)

addItem(type, item)

Add item to item list of given type.

clean()

Clears the cache of the project.

close()

Closes the project which deletes the internal caches.

getAssets()

Returns all project asssets (images, stylesheets, static data, etc.).

getCache()

Returns the cache instance.

getConfigValue(key, default=None)

getDocs()

Returns all package docs.

getFields()

Return the project defined fields which may be configured by the build script.

getItem(type, name)

Return item of given type and name.

getItems(type)

Returns all items of given type.

getName()

getPackage()

getPath()

getRequires(checkoutDirectory='external', updateRepositories=True)

Return the project requirements as project instances.

getRevision()

Returns the current revision of the project.

getScriptByName(className)

Finds a class by its name.

getScripts()

Returns all project classes.

Requires all files to have a “js” extension.

getSession()

getStyles()

Returns all project style styles.

Requires all files to have a “sht” extension.

getTranslations()

Returns all translation objects.

hasRequires()

isReady()

kind = 'none'

pause()

Pauses the project so that other processes could modify/access it.

resume()

Resumes the paused project.

scan()

scanned = False

toRelativeUrl(path, prefix='', subpath='source')

jasy.core.Project.getProjectFromPath(path, session, config=None, version=None)

jasy.core.Project.getProjectDependencies(project, checkoutDirectory='external', updateRepositories=True)

Returns a sorted list of projects depending on the given project (including the given one)

jasy.core.Session module

class jasy.core.Session.Session

Bases: object

Manages all projects.

addCommand(name, func, resultType=None, globalName=False)

Registers the given function as a new command.

addItemType(itemType, name, cls)

addProject(project)

Adds the given project to the list of known projects. Projects should be added in order of their priority. This adds the field configuration of each project to the session fields. Fields must not conflict between different projects (same name).

Parameters:project (object) – Instance of Project to append to the list

clean()

Clears all caches of all registered projects.

close()

Closes the session and stores cache to the harddrive.

executeCommand(name, params)

getAvailableTranslations()

Returns a set of all available translations.

This is the sum of all projects so even if only one project supports “fr_FR” then it will be included here.

getCommands()

Returns a dictionary of all commands.

getCurrentTask()

getFields()

getItemType(itemType)

getItemTypes()

getMain()

Returns the main project which is the first project added to the session and the one with the highest priority.

getProjectByName(name)

Returns a project by its name.

getProjects()

Returns all currently registered projects.

getRelativePath(project)

Returns the relative path of any project to the main project.

getScriptByName(className)

Queries all currently registered projects for the given class and returns the class item. Returns None when no matching class item was found.

Parameters:className (str) – Any valid classname from any of the projects.

getStyleByName(styleName)

Queries all currently registered projects for the given style and returns the style item. Returns None when no matching style item was found.

Parameters:styleName (str) – Any valid styleName from any of the projects.

getTranslationBundle(language=None)

Returns a translation object for the given language containing all relevant translation files for the current project set.

getVirtualFilePathFromId(fileId, extension=None)

Returns a valid virtual path for the given file item ID.

Supports adding an optional extension for files where the extension is not part of the idea (effectively this are most of them, but not assets)

getVirtualItem(baseName, itemClass, text, extension)

getVirtualProject()

Returns the virtual project for this application.

The project offers storage for dynamically created JavaScript classes and other files. Storage is kept intact between different Jasy sessions.

init(autoInitialize=True, updateRepositories=True, scriptEnvironment=None)

Initialize the actual session with projects.

Parameters:

• autoInitialize – Whether the projects should be automatically added when the current folder contains a valid Jasy project.
• updateRepositories – Whether to update repositories of all project dependencies.
• scriptEnvironment – API object as being used for loadLibrary to add Python features offered by projects.
• commandEnvironment – API object as being used for loadCommands to add Python features for any item nodes.

loadCommands(objectName, fileName, encoding='utf-8')

Loads new commands into the session wide command registry.

loadLibrary(objectName, fileName, encoding='utf-8', doc=None)

Creates a new object inside the user API (jasyscript.py) with the given name containing all @share’d functions and fields loaded from the given file.

pause()

Pauses the session.

This release cache files etc. and makes it possible to call other jasy processes on the same projects.

resume()

Resumes the session after it has been paused.

scan()

Scans all registered projects.

setCurrentTask(name=None)

jasy.core.Text module

jasy.core.Text.highlightCodeBlocks(html, tabsize=2, defaultlang='javascript')

Patches ‘code’ elements in HTML to apply HTML based syntax highlighting.

Automatically chooses the matching language detected via a CSS class of the ‘code’ element.

jasy.core.Text.markdownToHtml(markdownStr)

Converts Markdown to HTML.

Supports GitHub’s fenced code blocks, auto linking and typographic features by SmartyPants.

jasy.core.Types module

class jasy.core.Types.CaseInsensitiveDict

Bases: dict

A case-insensitive dict subclass. Each key is changed on entry to str(key).title().

classmethod fromkeys(seq, value=None)

get(key, default=None)

pop(key, default)

setdefault(key, x=None)

update(E)

jasy.core.Util module

jasy.core.Util.camelize(str)

Returns a camelized version of the incoming string: foo-bar-baz => fooBarBaz

Parameters:str – Input string

jasy.core.Util.executeCommand(args, failMessage=None, path=None, wrapOutput=True)

Executes the given process and outputs failMessage when errors happen.

Parameters:

• args (str or list) –
• failMessage (str) – Message for exception when command fails
• path (str) – Directory path where the command should be executed
• wrapOutput (bool) – Whether shell output should be wrapped and returned (and passed through to Console.debug())

Raises:

Exception – Raises an exception whenever the shell command fails in execution

jasy.core.Util.generateChecksum(key, method='base62')

Generates a unique SHA1 based hash/checksum encoded as Base62 or Hex depending on the given parameters.

Parameters:

• key (str) –
• method (str) –

jasy.core.Util.getKey(data, key, default=None)

Returns the key from the data if available or the given default.

Parameters:

• data (dict) – Data structure to inspect
• key (str) – Key to lookup in dictionary
• default (any) – Default value to return when key is not set

jasy.core.Util.hyphenate(str)

Returns a hyphenated version of the incoming string: fooBarBaz => foo-bar-baz

Parameters:str – Input string

Module contents

jasy.env package

Submodules

jasy.env.Context module

Global environment which is used by jasyscript.py files.

jasy.env.State module

This module is used to pass a single session instance around to different modules.

jasy.env.Task module

Tasks are basically functions with some managment code allow them to run in jasyscript.py.

jasy.env.Task.task(*args, **kwargs)

Specifies that this function is a task.

jasy.env.Task.executeTask(taskname, **kwargs)

Executes the given task by name with any optional named arguments.

jasy.env.Task.runTask(project, task, **kwargs)

Executes the given task of the given projects.

This happens inside a new sandboxed session during which the current session is paused/resumed automatically.

jasy.env.Task.printTasks(indent=16)

Prints out a list of all avaible tasks and their descriptions.

jasy.env.Task.setCommand(cmd)

Sets the jasy command which should be used to execute tasks with runTask()

jasy.env.Task.setOptions(options)

Sets currently configured command line options.

Mainly used for printing help screens.

jasy.env.Task.getOptions()

Returns the options as passed to the jasy command.

Useful for printing all command line arguments.

Module contents

Glue code used in jasyscript.py to have a convenient API on top of the full Jasy API.

jasy.http package

Submodules

jasy.http.Request module

jasy.http.Request.requestUrl(url, content_type='text/plain', headers=None, method='GET', port=None, body='', user=None, password=None)

Generic HTTP request wrapper with support for basic authentification and automatic parsing of response content.

jasy.http.Request.uploadData(url, fields, files, user=None, password=None, method='POST')

Easy wrapper for uploading content via HTTP multi part.

jasy.http.Server module

class jasy.http.Server.Proxy(id, config)

Bases: object

default(*args, **query)

This method returns the content of existing files on the file system.

Query string might be used for cache busting and are otherwise ignored.

class jasy.http.Server.Result(headers, content, status_code)

Bases: tuple

content

Alias for field number 1

headers

Alias for field number 0

status_code

Alias for field number 2

class jasy.http.Server.Server(port=8080, host='127.0.0.1', mimeTypes=None)

Bases: object

Starts the built-in HTTP server inside the project’s root directory

setRoutes(routes)

Adds the given routes to the server configuration. Routes can be used to add special top level entries to the different features of the integrated webserver either mirroring a remote server or delivering a local directory.

The parameters is a dict where every key is the name of the route and the value is the configuration of that route.

start()

Starts the web server and blocks execution.

Note: This stops further execution of the current task or method.

class jasy.http.Server.Static(id, config, mimeTypes=None)

Bases: object

default(*args, **query)

This method returns the content of existing files on the file system.

Query string might be used for cache busting and are otherwise ignored.

jasy.http.Server.enableCrossDomain()

jasy.http.Server.findIndex(path)

jasy.http.Server.noBodyProcess()

Module contents

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

jasy.parse package

Submodules

jasy.parse.AbstractNode module

class jasy.parse.AbstractNode.AbstractNode(tokenizer=None, type=None, args=[])

Bases: list

append(kid, rel=None)

Appends the given kid with an optional relation hint.

assignOp

comments

condition

elsePart

end

fileId

getChildrenLength(filter=True)

Number of (per default unrelated) children.

getFileName()

Traverses up the tree to find a node with a fileId and returns it.

getSource()

Returns the source code of the node.

getUnrelatedChildren()

Collects all unrelated children.

initializer

insert(index, kid)

Inserts the given kid at the given index.

insertAll(index, kids)

Inserts all kids starting with the given index.

insertAllReplace(orig, kids)

Inserts all kids at the same position as the original node (which is removed afterwards)

line

name

names

params

parent

parenthesized

postfix

rel

remove(kid)

Removes the given kid.

replace(kid, repl)

Replaces the given kid with a replacement kid.

scope

start

statement

statements

thenPart

toXml(format=True, indent=0, tab=' ')

Converts the node to XML.

tokenizer

type

value

values

variables

jasy.parse.ScopeData module

class jasy.parse.ScopeData.ScopeData

Bases: object

Used by core/Variables.py to store the resulting statistics data efficiently. Contains information about:

• Declared Variables (declared)
• Modified Variables (modified)
• Shared
• Unused Variables (unused)

accessed

declared

export()

Exports all data as a Python dict instance.

increment(name, by=1)

Small helper so simplify adding variables to “accessed” dict.

modified

name

packages

params

shared

unused

Module contents

jasy.script package

Subpackages

jasy.script.api package

Submodules

jasy.script.api.Comment module

class jasy.script.api.Comment.Comment(text, context=None, lineNo=0, indent='', fileId=None)

Bases: object

Comment class is attached to parsed nodes and used to store all comment related information.

The class supports a new Markdown and TomDoc inspired dialect to make developers life easier and work less repeative.

context = None

getHtml(highlight=True)

Returns the comment text converted to HTML.

Parameters:highlight (bool) – Whether to highlight the code

getTags()

hasContent()

hasTag(name)

params = None

returns = None

tags = None

text = None

type = None

exception jasy.script.api.Comment.CommentException(message, lineNo=0)

Bases: Exception

Thrown when errors during comment processing are detected.

jasy.script.api.Data module

class jasy.script.api.Data.ApiData(id, highlight=True)

Bases: object

Container for all relevant API data.

Automatically generated, filled and cached by jasy.item.Script.getApiDocs().

addAssets(assets)

Adds the info about used assets.

addConstructor(valueNode, commentNode=None)

addEntry(name, valueNode, commentNode, collection)

addEvent(name, valueNode, commentNode, collection)

addFields(permutations)

addProperty(name, valueNode, commentNode, collection)

addSize(size)

Adds the statistics on different size aspects.

addUses(uses)

assets

basename

construct

content

errors

events

export()

highlight

id

implementedBy

implements

includedBy

includes

isEmpty

main

members

package

permutations

properties

removeUses(uses)

scanTree(tree)

setMain(mainType, mainNode, exportName)

size

statics

usedBy

uses

warn(message, line)

jasy.script.api.Text module

jasy.script.api.Text.extractSummary(text)

jasy.script.api.Writer module

class jasy.script.api.Writer.ApiWriter(profile)

Bases: object

Processes JavaScript classes into data for API documentation.

Exports plain data which can be used by a wide varity of tools for further processing or for displaying documentation. A good example of how to use the data generated by write is the ApiBrowser: https://github.com/zynga/apibrowser

write(distFolder, classFilter=None, callback='apiload', showInternals=False, showPrivates=False, printErrors=True, highlightCode=True)

Writes API data generated from JavaScript into distFolder.

Parameters:

• distFolder (str) – Where to store the API data
• classFilter (tuple or function) – Tuple of classes or method to use for filtering
• callback (function) – Name of callback to use for loading or None if pure JSON should be used
• showInternals (bool) – Include internal methods inside API data
• showPrivates (bool) – Include private methods inside API data
• printErrors (bool) – Whether errors should be printed to the console
• highlightCode (bool) – Whether to enable code highlighting using Pygments

jasy.script.api.Writer.connectInterface(className, interfaceName, classApi, interfaceApi)

jasy.script.api.Writer.convertFunction(item)

jasy.script.api.Writer.convertTags(item)

jasy.script.api.Writer.isErrornous(data)

jasy.script.api.Writer.mergeMixin(className, mixinName, classApi, mixinApi)

jasy.script.api.Writer.safeUpdate(dest, origin)

Like update() but only never overwrites.

Module contents

jasy.script.clean package

Submodules

jasy.script.clean.DeadCode module

This module is used to detect dead code branches and remove them. This is escecially useful after injecting values from the outside which might lead to simple truish equations which can be easily resolved.

This module is directly used by Class after Permutations have been applied (code branches) but can be used more widely, too.

This acts somewhat like the optimizers you find under “optimizer”, but is dependency relevant (Permutations might remove whole blocks of alternative code branches). It makes no sense to optimize this just before compilation. It must be done pretty early during the processing of classes.

The module currently support the following statements:

• if
• hook (?:)
• switch

and can detect good code based on:

• true
• false
• equal: ==
• strict equal: ===
• not equal: !=
• strict not equal: !==
• not: !
• and: &&
• or: ||

It supports the types “string” and “number” during comparisions. It uses a simple equality operator in Python which behaves like strict equal in JavaScript. This also means that number 42 is not equal to string “42” during the dead code analysis.

It can figure out combined expressions as well like:

• 4 == 4 && !false

jasy.script.clean.DeadCode.cleanup(node)

Reprocesses JavaScript to remove dead paths.

jasy.script.clean.Permutate module

jasy.script.clean.Permutate.patch(node, permutation)

Replaces all occourences with incoming values.

jasy.script.clean.Unused module

exception jasy.script.clean.Unused.Error(name, line)

Bases: Exception

jasy.script.clean.Unused.cleanup(node)

Module contents

jasy.script.optimize package

Submodules

jasy.script.optimize.BlockReducer module

exception jasy.script.optimize.BlockReducer.Error(line)

Bases: Exception

jasy.script.optimize.BlockReducer.cleanParens(node)

Automatically tries to remove superfluous parens which are sometimes added for more clearance and readability but which are not required for parsing and just produce overhead.

jasy.script.optimize.BlockReducer.combineAssignments(condition, thenExpression, elseExpression, compressor)

Combines then and else expression to one assignment when they both assign to the same target node and using the same operator.

jasy.script.optimize.BlockReducer.combineExpressions(condition, thenExpression, elseExpression)

Combines then and else expression using a hook statement.

jasy.script.optimize.BlockReducer.combineToCommaExpression(node)

This method tries to combine a block with multiple statements into one semicolon statement with a comma expression containing all expressions from the previous block. This only works when the block exclusively consists of expressions as this do not work with other statements. Still this conversion reduces the size impact of many blocks and leads to the removal of a lot of curly braces in the result code.

Example: {x++;y+=3} => x++,x+=3

jasy.script.optimize.BlockReducer.compactIf(node, thenPart, condition)

Reduces the size of a if statement (without elsePart) using boolean operators instead of the typical keywords e.g. “if(something)make()” is translated to “something&&make()” which is two characters shorter.

This however only works when the thenPart is only based on expressions and does not contain other statements.

jasy.script.optimize.BlockReducer.containsIf(node)

Checks whether the given node contains another if-statement

jasy.script.optimize.BlockReducer.containsIfElse(node)

Checks whether the given node contains another if-else-statement

jasy.script.optimize.BlockReducer.createHook(condition, thenPart, elsePart)

Creates a hook expression with the given then/else parts.

jasy.script.optimize.BlockReducer.createReturn(value)

Creates a return statement with the given value.

jasy.script.optimize.BlockReducer.endsWithReturnOrThrow(node)

Used by the automatic elsePart removal logic to find out whether the given node ends with a return or throw which is bascially the allowance to remove the else keyword as this is not required to keep the logic intact.

jasy.script.optimize.BlockReducer.fixParens(node)

Automatically wraps the given node into parens when it was moved into another block and is not parsed there in the same way as it was the case previously.

The method needs to be called after the node has been moved to the target node.

jasy.script.optimize.BlockReducer.mergeParts(node, thenPart, elsePart, condition, compressor)

Merges if statement with a elsePart using a hook. Supports two different ways of doing this: using a hook expression outside, or using a hook expression inside an assignment.

Example: if(test) first(); else second() => test ? first() : second(); if(foo) x=1; else x=2 => x = foo ? 1 : 2;

jasy.script.optimize.BlockReducer.optimize(node)

jasy.script.optimize.BlockReducer.reworkElse(node, elsePart)

If an if ends with a return/throw we are able to inline the content of the else to the same parent as the if resides into.

This method deals with all the nasty details of this operation.

jasy.script.optimize.ClosureWrapper module

jasy.script.optimize.ClosureWrapper.optimize(node)

jasy.script.optimize.CombineDeclarations module

exception jasy.script.optimize.CombineDeclarations.Error(line)

Bases: Exception

jasy.script.optimize.CombineDeclarations.optimize(node)

jasy.script.optimize.CryptPrivates module

exception jasy.script.optimize.CryptPrivates.Error(name, line)

Bases: Exception

jasy.script.optimize.CryptPrivates.optimize(node, contextId='')

jasy.script.optimize.LocalVariables module

exception jasy.script.optimize.LocalVariables.Error(name, line)

Bases: Exception

jasy.script.optimize.LocalVariables.optimize(node)

Node to optimize with the global variables to ignore as names.

jasy.script.optimize.Translation module

jasy.script.optimize.Translation.hasText(node)

jasy.script.optimize.Translation.optimize(node, translation)

jasy.script.optimize.Translation.collectTranslations(node)

Module contents

jasy.script.output package

Submodules

jasy.script.output.Compressor module

class jasy.script.output.Compressor.Compressor(format=None)

Bases: object

compress(node)

type_array_comp(node)

type_array_init(node)

type_assign(node)

type_block(node)

type_break(node)

type_call(node)

type_comma(node)

type_comp_tail(node)

Comprehensions Tails.

type_const(node)

type_continue(node)

type_declaration(node)

type_do(node)

type_exception(node)

type_for(node)

type_for_in(node)

type_function(node)

type_generator(node)

Generator Expression.

type_getter(node)

type_hook(node)

aka ternary operator.

type_identifier(node)

type_if(node)

type_in(node)

type_index(node)

type_instanceof(node)

type_label(node)

type_let(node)

type_let_block(node)

type_list(node)

type_new_with_args(node)

type_number(node)

type_object_init(node)

type_property_init(node)

type_regexp(node)

type_return(node)

type_script(node)

type_semicolon(node)

type_setter(node)

type_string(node)

type_switch(node)

type_throw(node)

type_try(node)

type_var(node)

type_while(node)

jasy.script.output.Formatting module

class jasy.script.output.Formatting.Formatting(*args)

Bases: jasy.core.FlagSet.FlagSet

Configures an formatting object which can be used to compress classes afterwards.

The optimization set is frozen after initialization which also generates the unique key based on the given formatting options.

jasy.script.output.Optimization module

exception jasy.script.output.Optimization.Error(msg)

Bases: Exception

Error object which is raised whenever an optimization could not be applied correctly.

class jasy.script.output.Optimization.Optimization(*args)

Bases: jasy.core.FlagSet.FlagSet

Configures an optimization object which can be used to compress classes afterwards.

The optimization set is frozen after initialization which also generates the unique key based on the given optimizations.

apply(tree)

Applies the configured optimizations to the given node tree.

Modifies the tree in-place to be sure to have a deep copy if you need the original one. It raises an error instance whenever any optimization could not be applied to the given tree.

Module contents

jasy.script.parse package

Submodules

jasy.script.parse.Lang module

jasy.script.parse.Node module

class jasy.script.parse.Node.Node(tokenizer=None, type=None, args=[])

Bases: jasy.parse.AbstractNode.AbstractNode

assignOp

block

body

comments

condition

defaultIndex

discriminant

elsePart

end

exception

expression

expressionClosure

fileId

finallyBlock

for

functionForm

guard

initializer

isEach

isLoop

iterator

label

line

name

names

object

params

parent

parenthesized

postfix

readOnly

rel

scope

setup

start

statement

statements

tail

thenPart

tokenizer

tryBlock

type

update

value

variables

jasy.script.parse.Parser module

jasy.script.parse.Parser.parse(source, fileId=None, line=1, builder=None)

jasy.script.parse.Parser.parseExpression(source, fileId=None, line=1, builder=None)

jasy.script.parse.ScopeScanner module

jasy.script.parse.ScopeScanner.scan(tree)

Scans the given tree and attaches variable data instances (core/ScopeData.py) to every scope (aka function).

This data is being stored independently from the real tree so that if you modifiy the tree the data is not automatically updated. This means that every time you modify the tree heavily, it might make sense to re-execute this method to bring it in sync to the current tree structure.

jasy.script.parse.VanillaBuilder module

class jasy.script.parse.VanillaBuilder.VanillaBuilder

Bases: object

The vanilla AST builder.

ADD_addOperand(node, childNode)

ADD_build(tokenizer)

ADD_finish(node)

AND_addOperand(node, childNode)

AND_build(tokenizer)

AND_finish(node)

ARRAYCOMP_build(tokenizer)

ARRAYCOMP_finish(node)

ARRAYCOMP_setExpression(node, expression)

ARRAYCOMP_setTail(node, childNode)

ARRAYINIT_addElement(node, childNode)

ARRAYINIT_build(tokenizer)

ARRAYINIT_finish(node)

ASSIGN_addOperand(node, childNode)

ASSIGN_build(tokenizer)

ASSIGN_finish(node)

ASSIGN_setAssignOp(node, operator)

BITWISEAND_addOperand(node, childNode)

BITWISEAND_build(tokenizer)

BITWISEAND_finish(node)

BITWISEOR_addOperand(node, childNode)

BITWISEOR_build(tokenizer)

BITWISEOR_finish(node)

BITWISEXOR_addOperand(node, childNode)

BITWISEXOR_build(tokenizer)

BITWISEXOR_finish(node)

BLOCK_addStatement(node, childNode)

BLOCK_build(tokenizer, id)

BLOCK_finish(node)

BLOCK_hoistLets(node)

BREAK_build(tokenizer)

BREAK_finish(node)

BREAK_setLabel(node, label)

BREAK_setTarget(node, target)

CASE_addStatement(node, statement)

CASE_build(tokenizer)

CASE_finish(node)

CASE_initializeStatements(node, tokenizer)

CASE_setLabel(node, expression)

CATCH_build(tokenizer)

CATCH_finish(node)

CATCH_setBlock(node, statement)

CATCH_setException(node, exception)

CATCH_setGuard(node, expression)

CATCH_wrapException(tokenizer)

COMMA_addOperand(node, childNode)

COMMA_build(tokenizer)

COMMA_finish(node)

COMMENTS_add(currNode, prevNode, comments)

COMPTAIL_addFor(node, childNode)

COMPTAIL_build(tokenizer)

COMPTAIL_finish(node)

COMPTAIL_setGuard(node, expression)

CONST_addDecl(node, childNode, childContext=None)

CONST_build(tokenizer)

CONST_finish(node)

CONTINUE_build(tokenizer)

CONTINUE_finish(node)

CONTINUE_setLabel(node, label)

CONTINUE_setTarget(node, target)

DEBUGGER_build(tokenizer)

DECL_build(tokenizer)

DECL_finish(node)

DECL_setInitializer(node, expression)

DECL_setName(node, identifier)

DECL_setNames(node, expression)

DECL_setReadOnly(node, readOnly)

DEFAULT_addStatement(node, statement)

DEFAULT_build(tokenizer)

DEFAULT_finish(node)

DEFAULT_initializeStatements(node, tokenizer)

DO_build(tokenizer)

DO_finish(node)

DO_setBody(node, statement)

DO_setCondition(node, expression)

EQUALITY_addOperand(node, childNode)

EQUALITY_build(tokenizer)

EQUALITY_finish(node)

EXPRESSION_addOperand(node, childNode)

EXPRESSION_build(tokenizer, tokenType)

EXPRESSION_finish(node)

FOR_build(tokenizer)

FOR_finish(node)

FOR_rebuildForEach(node)

FOR_rebuildForIn(node)

FOR_setBody(node, statement)

FOR_setCondition(node, expression)

FOR_setIterator(node, expression, forBlock=None)

FOR_setObject(node, expression, forBlock=None)

FOR_setSetup(node, expression)

FOR_setUpdate(node, expression)

FUNCTION_addParam(node, tokenizer, expression)

FUNCTION_build(tokenizer)

FUNCTION_finish(node, x)

FUNCTION_hoistVars(x)

FUNCTION_initParams(node, tokenizer)

FUNCTION_setBody(node, statement)

FUNCTION_setExpressionClosure(node, expressionClosure)

FUNCTION_setName(node, identifier)

FUNCTION_wrapParam(tokenizer)

GENERATOR_build(tokenizer)

GENERATOR_finish(node)

GENERATOR_setExpression(node, expression)

GENERATOR_setTail(node, childNode)

HOOK_build(tokenizer)

HOOK_finish(node)

HOOK_setCondition(node, expression)

HOOK_setElsePart(node, childNode)

HOOK_setThenPart(node, childNode)

IF_build(tokenizer)

IF_finish(node)

IF_setCondition(node, expression)

IF_setElsePart(node, statement)

IF_setThenPart(node, statement)

LABEL_build(tokenizer)

LABEL_finish(node)

LABEL_setLabel(node, label)

LABEL_setStatement(node, statement)

LETBLOCK_build(tokenizer)

LETBLOCK_finish(node)

LETBLOCK_setBlock(node, statement)

LETBLOCK_setExpression(node, expression)

LETBLOCK_setVariables(node, childNode)

LET_addDecl(node, childNode, childContext=None)

LET_build(tokenizer)

LET_finish(node)

LIST_addOperand(node, childNode)

LIST_build(tokenizer)

LIST_finish(node)

MEMBER_addOperand(node, childNode)

MEMBER_build(tokenizer, tokenType=None)

MEMBER_finish(node)

MEMBER_rebuildNewWithArgs(node)

MULTIPLY_addOperand(node, childNode)

MULTIPLY_build(tokenizer)

MULTIPLY_finish(node)

OBJECTINIT_addProperty(node, childNode)

OBJECTINIT_build(tokenizer)

OBJECTINIT_finish(node)

OR_addOperand(node, childNode)

OR_build(tokenizer)

OR_finish(node)

PRIMARY_build(tokenizer, tokenType)

PRIMARY_finish(node)

PROPERTYINIT_addOperand(node, childNode)

PROPERTYINIT_build(tokenizer)

PROPERTYINIT_finish(node)

RELATIONAL_addOperand(node, childNode)

RELATIONAL_build(tokenizer)

RELATIONAL_finish(node)

RETURN_build(tokenizer)

RETURN_finish(node)

RETURN_setValue(node, expression)

SEMICOLON_build(tokenizer)

SEMICOLON_finish(node)

SEMICOLON_setExpression(node, expression)

SHIFT_addOperand(node, childNode)

SHIFT_build(tokenizer)

SHIFT_finish(node)

SWITCH_addCase(node, childNode)

SWITCH_build(tokenizer)

SWITCH_finish(node)

SWITCH_setDefaultIndex(node, index)

SWITCH_setDiscriminant(node, expression)

THROW_build(tokenizer)

THROW_finish(node)

THROW_setException(node, expression)

TRY_addCatch(node, childNode)

TRY_build(tokenizer)

TRY_finish(node)

TRY_finishCatches(node)

TRY_setFinallyBlock(node, statement)

TRY_setTryBlock(node, statement)

UNARY_addOperand(node, childNode)

UNARY_build(tokenizer)

UNARY_finish(node)

UNARY_setPostfix(node)

VAR_addDecl(node, childNode, childContext=None)

VAR_build(tokenizer)

VAR_finish(node)

WHILE_build(tokenizer)

WHILE_finish(node)

WHILE_setBody(node, statement)

WHILE_setCondition(node, expression)

WITH_build(tokenizer)

WITH_finish(node)

WITH_setBody(node, statement)

WITH_setObject(node, expression)

YIELD_build(tokenizer)

YIELD_finish(node)

YIELD_setValue(node, expression)

setHoists(id, vds)

Module contents

jasy.script.tokenize package

Submodules

jasy.script.tokenize.Lang module

JavaScript 1.7 keywords

jasy.script.tokenize.Tokenizer module

exception jasy.script.tokenize.Tokenizer.ParseError(message, fileId, line)

Bases: Exception

class jasy.script.tokenize.Tokenizer.Token

Bases: object

assignOp

end

line

start

type

value

class jasy.script.tokenize.Tokenizer.Tokenizer(source, fileId='', line=1)

Bases: object

done()

get(scanOperand=False)

It consumes input only if there is no lookahead. Dispatches to the appropriate lexing function depending on the input.

getComments()

input_

lexDot(ch)

lexExponent()

lexIdent(ch)

lexNumber(ch)

lexOp(ch)

lexRegExp(ch)

lexString(ch)

lexZeroNumber(ch)

match(tokenType, scanOperand=False)

mustMatch(tokenType)

peek(scanOperand=False)

peekOnSameLine(scanOperand=False)

skip()

Eats comments and whitespace.

token

unget()

Match depends on unget returning undefined.

Module contents

jasy.script.util package

Module contents

jasy.script.util.assembleDot(node, result=None)

Joins a dot node (cascaded supported, too) into a single string like “foo.bar.Baz”.

jasy.script.util.detectObjectType(objectNode)

Returns a human readable type information of the given node.

jasy.script.util.detectPlusType(plusNode)

Analyses the given “plus” node and tries to figure out if a “string” or “number” result is produced.

jasy.script.util.findAssignments(name, node)

Returns a list of assignments which might have impact on the value used in the given node.

jasy.script.util.findCall(node, methodName)

Recurses the tree starting with the given node and returns the first node which calls the given method name (supports namespaces, too)

jasy.script.util.findCommentNode(node)

Finds the first doc comment node inside the given node.

jasy.script.util.findFunction(node)

Returns the first function inside the given node.

jasy.script.util.findReturn(node)

Finds the first return inside the given node.

jasy.script.util.getCallName(node)

jasy.script.util.getDocComment(node)

Returns the first doc comment of the given node.

jasy.script.util.getKeyValue(dict, key)

Returns the value node of the given key inside the given object initializer.

jasy.script.util.getParamNamesFromFunction(func)

Returns a human readable list of parameter names (sorted by their order in the given function)

jasy.script.util.getParameterFromCall(call, index=0)

Returns a parameter node by index on the call node.

jasy.script.util.getVisibility(name)

Returns the visibility of the given name by convention.

jasy.script.util.query(node, matcher, deep=True, inner=False)

Recurses the tree starting with the given node and returns the first node which is matched by the given matcher method.

• node: any node
• matcher: function which should return a truish value when node matches
• deep: whether inner scopes should be scanned, too
• inner: used internally to differentiate between current and inner nodes

jasy.script.util.queryAll(node, matcher, deep=True, inner=False, result=None)

Recurses the tree starting with the given node and returns a list of nodes matched by the given matcher method.

• node: any node
• matcher: function which should return a truish value when node matches
• deep: whether inner scopes should be scanned, too
• inner: used internally to differentiate between current and inner nodes
• result: can be used to extend an existing list, otherwise a new list is created and returned

jasy.script.util.requiresDocumentation(name)

Whether the given name suggests that documentation is required.

jasy.script.util.resolveIdentifierNode(identifierNode)

jasy.script.util.valueToString(node)

Converts the value of the given node into something human friendly.

Submodules

jasy.script.Resolver module

class jasy.script.Resolver.Resolver(profile)

Bases: jasy.abstract.Resolver.Resolver

addVirtual(name, text)

Adds a virtual aka generated class to the resolver with the given name and text.

Please note: The file name is modified to contain a checksum of the content as a postfix. This keeps caches in-tact when using different contents for the same file name aka different sets of assets, translations, etc. The classname itself (which is modified here as said) is not so much of relevance because of the situation that the virtual class object is automatically added to the resolver (and sorter).

getItemDependencies(item)

getSorted()

Returns a list of sorted classes.

jasy.script.Sorter module

class jasy.script.Sorter.Sorter(resolver)

Bases: jasy.abstract.Sorter.AbstractSorter

Sorter for Script items.

getItemBreaks(item)

getItemDependencies(item)

Module contents

jasy.style package

Subpackages

jasy.style.clean package

Submodules

jasy.style.clean.Permutate module

This class is responsible for resolving if-conditions based on permutation data Not all if blocks are being able to be resolved that way though as some use variables etc. which are not available before actual full processing of the content.

exception jasy.style.clean.Permutate.ResolverError(message, node=None)

Bases: Exception

jasy.style.clean.Permutate.patch(tree, permutation)

jasy.style.clean.Unused module

exception jasy.style.clean.Unused.Error(name, line)

Bases: Exception

jasy.style.clean.Unused.cleanup(node)

Module contents

jasy.style.output package

Submodules

jasy.style.output.Compressor module

class jasy.style.output.Compressor.Compressor(optimize=None, format=None)

Bases: object

compress(node)

Compresses the given node and returns the compressed text result.

indent(code)

Indents the given code by the current indenting setup.

type_block(node)

type_call(node)

type_comma(node)

type_expr(node)

type_fontface(node)

type_frame(node)

type_function(node)

type_identifier(node)

type_keyframes(node)

type_list(node)

type_media(node)

type_mixin(node)

type_number(node)

type_page(node)

type_property(node)

type_raw(node)

type_selector(node)

type_sheet(node)

type_slash(node)

type_string(node)

type_supports(node)

exception jasy.style.output.Compressor.CompressorError(message, node)

Bases: Exception

jasy.style.output.Formatting module

class jasy.style.output.Formatting.Formatting(*args)

Bases: jasy.core.FlagSet.FlagSet

Configures an formatting object which can be used to compress stylesheets afterwards.

The optimization set is frozen after initialization which also generates the unique key based on the given formatting options.

jasy.style.output.Optimization module

exception jasy.style.output.Optimization.Error(msg)

Bases: Exception

Error object which is raised whenever an optimization could not be applied correctly.

class jasy.style.output.Optimization.Optimization(*args)

Bases: jasy.core.FlagSet.FlagSet

Configures an optimization object which can be used to compress stylesheets afterwards.

The optimization set is frozen after initialization which also generates the unique key based on the given optimizations.

apply(tree)

Applies the configured optimizations to the given node tree.

Modifies the tree in-place to be sure to have a deep copy if you need the original one. It raises an error instance whenever any optimization could not be applied to the given tree.

Module contents

jasy.style.parse package

Submodules

jasy.style.parse.Node module

class jasy.style.parse.Node.Node(tokenizer=None, type=None, args=[])

Bases: jasy.parse.AbstractNode.AbstractNode

assignOp

comments

condition

dynamic

elsePart

end

fileId

initializer

line

name

names

noscope

params

parent

parenthesized

quote

rel

rules

scope

selector

start

statement

statements

thenPart

token

tokenizer

type

unit

value

variables

vendor

jasy.style.parse.Parser module

jasy.style.parse.Parser.AddExpression(tokenizer, staticContext)

jasy.style.parse.Parser.AndExpression(tokenizer, staticContext)

jasy.style.parse.Parser.ArgumentList(tokenizer, staticContext)

jasy.style.parse.Parser.AssignExpression(tokenizer, staticContext)

jasy.style.parse.Parser.Block(tokenizer, staticContext)

jasy.style.parse.Parser.Charset(tokenizer, staticContext)

jasy.style.parse.Parser.CssArgumentList(tokenizer, staticContext)

jasy.style.parse.Parser.EqualityExpression(tokenizer, staticContext)

jasy.style.parse.Parser.Expression(tokenizer, staticContext)

Top-down expression parser for stylestyles.

jasy.style.parse.Parser.ExpressionArgument(tokenizer, staticContext)

jasy.style.parse.Parser.FontFace(tokenizer, staticContext)

jasy.style.parse.Parser.KeyFrames(tokenizer, staticContext)

Supports e.g.:

@keyframes fade{

from, 10%{

background-color: #000000;

}

100%{

background-color: #FFFFFF;

}

}

jasy.style.parse.Parser.Media(tokenizer, staticContext)

Supports e.g.:

@media print{

body{

background-color: #000000;

}

}

@media handheld, tv{

body{

background-color: yellow;

}

}

@media screen and (max-width: 300px) {

body{

background-color: orange;

}

}

jasy.style.parse.Parser.MemberExpression(tokenizer, staticContext)

jasy.style.parse.Parser.MultiplyExpression(tokenizer, staticContext)

jasy.style.parse.Parser.OrExpression(tokenizer, staticContext)

jasy.style.parse.Parser.Page(tokenizer, staticContext)

Supports e.g.:

@page{

margin: 1cm;

}

@page :first{

margin: 5cm 2cm;

}

jasy.style.parse.Parser.ParenExpression(tokenizer, staticContext)

An expression in parens.

Sometimes to force priority of math operations etc.

exception jasy.style.parse.Parser.ParseError(message, tokenizer)

Bases: Exception

jasy.style.parse.Parser.PrimaryExpression(tokenizer, staticContext)

jasy.style.parse.Parser.Property(tokenizer, staticContext)

Parses all CSS properties e.g.

• background: red
• font: 12px bold Arial;

jasy.style.parse.Parser.RawArgument(tokenizer, staticContext)

jasy.style.parse.Parser.RelationalExpression(tokenizer, staticContext)

jasy.style.parse.Parser.Root(tokenizer, staticContext)

Supports e.g.:

h1{

font-size: 20px;

@root html.desktop &{

font-size: 30px;

}

}

.date{

color: black; background: white;

@root{

&__dialog{

position: absolute;

}

}

}

jasy.style.parse.Parser.Selector(tokenizer, staticContext)

CSS selector parser e.g.

h1 .infobox #header h1::after h2:first-child

jasy.style.parse.Parser.Sheet(tokenizer, staticContext)

Parses the toplevel and rule bodies.

jasy.style.parse.Parser.Statement(tokenizer, staticContext)

Parses a Statement.

jasy.style.parse.Parser.Statements(tokenizer, staticContext)

Parses a list of Statements.

class jasy.style.parse.Parser.StaticContext

Bases: object

jasy.style.parse.Parser.Supports(tokenizer, staticContext)

jasy.style.parse.Parser.UnaryExpression(tokenizer, staticContext)

jasy.style.parse.Parser.UrlArgumentList(tokenizer, staticContext)

jasy.style.parse.Parser.ValueExpression(tokenizer, staticContext)

Top-down expression parser for rule values in stylestyles.

jasy.style.parse.Parser.Variable(tokenizer, staticContext)

All kind of variable usage:

• variable access
• variable declaration
• mixin declaration
• mixin call

jasy.style.parse.Parser.addComments(currNode, prevNode, comments)

jasy.style.parse.Parser.parse(source, fileId=None, line=1)

jasy.style.parse.Parser.parseExpression(source, fileId=None, line=1)

jasy.style.parse.ScopeScanner module

jasy.style.parse.ScopeScanner.scan(tree)

Scans the given tree and attaches variable data instances (core/ScopeData.py) to every scope (aka function).

This data is being stored independently from the real tree so that if you modifiy the tree the data is not automatically updated. This means that every time you modify the tree heavily, it might make sense to re-execute this method to bring it in sync to the current tree structure.

Module contents

jasy.style.process package

Submodules

jasy.style.process.Executer module

exception jasy.style.process.Executer.ExecuterError(message, node)

Bases: Exception

jasy.style.process.Executer.process(tree, profile)

jasy.style.process.Flatter module

jasy.style.process.Flatter.process(tree)

Flattens selectors to that h1{ span{ ... is merged into h1 span{ ...

jasy.style.process.Mixins module

jasy.style.process.Mixins.isExtendCall(node)

jasy.style.process.Mixins.isMixinCall(node)

jasy.style.process.Mixins.processExtends(tree)

Processes all requests for mixin extends.

jasy.style.process.Mixins.processMixins(tree)

Processes all mixin includes inside mixins.

jasy.style.process.Mixins.processSelectors(tree)

Processes all mixin includes inside selectors.

jasy.style.process.Operation module

exception jasy.style.process.Operation.OperationError(message, node)

Bases: Exception

jasy.style.process.Operation.castToBool(node)

Returns the boolean Python representation for the given Node.

jasy.style.process.Operation.compute(node, first=None, second=None, operator=None, session=None)

Recursively processes given operation node.

Consumes optional hints for the first/second child of an operation as well as the operator itself (in cases where it could not be figured out automatically). The session is useful for supporting commands inside of operations.

Module contents

jasy.style.tokenize package

Submodules

jasy.style.tokenize.Tokenizer module

class jasy.style.tokenize.Tokenizer.Token

Bases: object

assignOp

end

line

quote

start

type

unit

value

class jasy.style.tokenize.Tokenizer.Tokenizer(source, fileId='', line=1)

Bases: object

done()

find(anyOf)

get(scanOperand=False)

It consumes input only if there is no lookahead. Dispatches to the appropriate lexing function depending on the input.

getComments()

input_

lexDot(ch)

lexIdent(ch)

lexNumber(ch)

lexOp(ch)

lexString(ch)

lexUnit()

Parses units like %, cm, inch, px, etc.

lexZeroNumber(ch)

match(tokenType, scanOperand=False)

mustMatch(tokenType)

peek(scanOperand=False)

peekOnSameLine(scanOperand=False)

rewind(point)

save()

skip()

Eats comments and whitespace.

token

unget()

Match depends on unget returning undefined.

exception jasy.style.tokenize.Tokenizer.TokenizerError(message, fileId, line)

Bases: Exception

Module contents

Submodules

jasy.style.Engine module

jasy.style.Engine.compressTree(tree, optimizationLevel=0, formattingLevel=0)

Returns the compressed result from the given tree.

jasy.style.Engine.getTokenizer(text, fileId=None)

Returns a tokenizer for the given file content.

jasy.style.Engine.getTree(text, fileId=None)

Returns a tree of nodes from the given text.

jasy.style.Engine.permutateTree(tree, permutation=None)

Returns an optimized tree with permutations applied.

jasy.style.Engine.printTokens(text, fileId=None)

Prints out a structured list of tokens.

jasy.style.Engine.reduceTree(tree, profile=None)

Applies all relevant modifications to the tree to allow compression to CSS.

jasy.style.Resolver module

class jasy.style.Resolver.Resolver(profile)

Bases: jasy.abstract.Resolver.Resolver

getItemDependencies(item)

getSorted()

Returns a list of sorted classes.

jasy.style.Sorter module

class jasy.style.Sorter.Sorter(resolver)

Bases: jasy.abstract.Sorter.AbstractSorter

Sorter for Style items.

getItemBreaks(item)

getItemDependencies(item)

jasy.style.Util module

jasy.style.Util.assembleDot(node, result=None)

Joins a dot node (cascaded supported, too) into a single string like “foo.bar.Baz”.

jasy.style.Util.castNativeToNode(value)

jasy.style.Util.combineMediaQueryList(media)

jasy.style.Util.combineSelector(node, stop=None)

Figures out the fully qualified selector, media query and @supports value of the given Node.

jasy.style.Util.combineSelectorList(selector, stop, root=None)

jasy.style.Util.combineSupportList(supports)

jasy.style.Util.executeCommand(node, profile)

jasy.style.Util.extractName(name)

jasy.style.Util.extractVendor(name)

Module contents

jasy.template package

Submodules

jasy.template.Compiler module

jasy.template.Compiler.compile(text, labels=[], nostrip=False, name=None)

jasy.template.Compiler.escapeContent(content)

jasy.template.Compiler.escapeMatcher(str)

jasy.template.Compiler.walk(node, labels, nostrip)

jasy.template.Parser module

jasy.template.Parser.tokenize(text, nostrip=False)

Tokenizer for template @text {String}. Returns an array of tokens where tags are returned as an object with the keys tag and name while normal strings are kept as strings.

Optionally you can keep white spaces (line breaks, leading, trailing, etc.) by enabling @nostrip {Boolean?false}.

jasy.template.Parser.parse(text, nostrip=False)

Returns the token tree of the given template @text {String}.

A token holds the following information:

• tag: tag of the token
• name: name of the token
• nodes: children of the node

Optionally you can keep white spaces (line breaks, leading, trailing, etc.) by enabling @nostrip {Boolean?false}.

Module contents

jasy.test package

Subpackages

jasy.test.script package

Submodules

jasy.test.script.api module

class jasy.test.script.api.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_boolean()

test_closure()

test_closure_call()

test_closure_call_alter()

test_closure_hook()

test_closure_if_else()

test_closure_namedfunc()

test_closure_static()

test_closure_static_doc()

test_closure_static_hoisting()

test_closure_static_later()

test_closure_static_sum()

test_construct()

test_core_class()

test_core_module()

test_custom_type()

test_dynamic()

test_dynamic_auto()

test_dynamic_cascaded()

test_events()

test_events_doc()

test_events_reference()

test_function()

test_function_return_dotted()

test_function_return_number()

test_function_return_plus_string()

test_function_return_plus_x()

test_function_return_string()

test_implement()

test_include()

test_interface()

test_kinds()

test_lines()

test_literal()

test_number()

test_params()

test_params_optional()

test_primitives()

test_properties()

test_properties_groups()

test_properties_init()

test_properties_multi()

test_properties_nullable()

test_reference()

test_specials()

test_summary()

test_summary_nodot()

test_tags()

test_unsupported()

test_uses()

test_values()

test_visibility()

jasy.test.script.blockreduce module

class jasy.test.script.blockreduce.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_combine_inner_out()

test_combine_inner_out_parens()

test_combine_inner_out_parens_mix()

test_combine_mixed()

test_combine_mixed_empty()

test_combine_number()

test_combine_number_omit()

test_combine_string()

test_elseinline_cascaded()

test_elseinline_elseif()

test_elseinline_elseif_nolast()

test_elseinline_return()

test_elseinline_throw()

test_if_deep_if()

test_if_else_both_empty()

test_if_else_cascaded()

test_if_else_empty()

test_if_else_expression()

test_if_else_while_if()

test_if_empty_else()

test_if_empty_else_two()

test_ifoptimize_assign()

test_ifoptimize_assign_late()

test_ifoptimize_crazy()

test_ifoptimize_empty()

test_loop_brackets()

test_mergeassign_assign()

test_mergeassign_assign_plus()

test_mergeassign_object()

test_mergereturn()

test_parens_arithm()

test_parens_assign()

test_parens_condition()

test_parens_directexec()

test_parens_new()

test_parens_new_args()

test_parens_numberoper()

test_parens_return()

test_return_in_elseif()

test_single_command_if_block()

test_strict()

test_switch_return()

jasy.test.script.combinedecl module

class jasy.test.script.combinedecl.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_combine_basic()

test_combine_closure()

test_combine_closure_innerfirst()

test_combine_complex()

test_combine_destruct()

test_combine_destruct_assign()

test_combine_doubles()

test_combine_doubles_break()

test_combine_doubles_for()

test_combine_doubles_oneassign()

jasy.test.script.comments module

class jasy.test.script.comments.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_code_blocks_in_list()

test_doc()

test_doc_links()

test_doc_links_in_code_block()

test_doc_links_object_alike()

test_doc_links_primitive()

test_doc_links_type()

test_doc_markdown_code()

test_doc_markdown_code_html()

test_doc_markdown_code_single_blockquote()

test_doc_markdown_code_single_inline()

test_doc_markdown_formatting()

test_doc_markdown_formatting_code()

test_doc_markdown_quote()

test_doc_markdown_smartypants()

test_doc_multiline()

test_doc_multiline_clean()

test_doc_multiline_clean_three()

test_doc_multiline_three()

test_doc_params()

test_doc_params_dynamic()

test_doc_params_dynamic_default()

test_doc_params_dynamic_multi()

test_doc_params_dynamic_multi_spacey()

test_doc_params_firstloose()

test_doc_params_firstwin()

test_doc_params_in_code_block()

test_doc_params_lazytypes()

test_doc_params_maps()

test_doc_params_maps_multi_levels()

test_doc_params_namespaced()

test_doc_return()

test_doc_return_twotypes()

test_doc_tags()

test_doc_tags_clean()

test_doc_unbound()

test_doc_unbound_nobreak()

test_missing_node()

test_multi()

test_multi_code_blocks()

test_multi_context_block_after()

test_multi_context_block_before()

test_multi_context_inline()

test_multi_context_inline_multiline()

test_multi_context_section()

test_multi_multiline()

test_multi_multiline_otherbreaks()

test_multi_two()

test_multi_unbound()

test_multi_unbound_nobreak()

test_protected()

test_protected_jquery()

test_protected_newline()

test_single()

test_single_context_block_after()

test_single_context_block_before()

test_single_context_inline()

test_single_context_section()

test_single_two()

test_single_unbound()

test_single_unbound_nobreak()

jasy.test.script.compressor module

class jasy.test.script.compressor.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_and()

test_arithm()

test_arithm_decrement()

test_arithm_increment()

test_array_comprehension()

test_array_number()

test_array_sparse()

test_array_string()

test_bitwise_and()

test_block_empty()

test_block_separate()

test_call_destruct()

test_call_multiargs()

test_call_singlearg()

test_const()

test_const_multi()

test_continue()

test_continue_label()

test_declaration()

test_declaration_destruct()

test_delete()

test_destruct_assign()

test_destruct_for()

test_destruct_for_let()

test_do_while()

test_dot()

test_expression_closure()

test_for_each()

test_for_in()

test_for_multiinit()

test_for_simple()

test_function_declared()

test_function_expressed()

test_generator_expression()

test_generator_expression_guard()

test_getter()

test_hook_assign()

test_hook_left_child()

test_hook_right_child()

test_hook_simple()

test_hook_two_children()

test_if()

test_if_else()

test_if_else_if()

test_if_else_if_noblocks()

test_if_else_noblocks()

test_if_empty()

test_if_noblock()

test_if_not()

test_if_not_else()

test_in()

test_increment_postfix()

test_increment_prefix()

test_index()

test_let_definition()

test_let_expression()

test_let_statement()

test_new()

test_new_args()

test_new_args_empty()

test_new_args_empty_dot_call()

test_new_args_empty_dot_call_paren()

test_new_dot_call()

test_number_float()

test_number_float_short()

test_number_float_zero_prefix()

test_number_hex()

test_number_int()

test_number_max()

test_number_min()

test_object_init()

test_object_init_trail()

test_or()

test_regexp()

test_regexp_in_array()

test_return()

test_return_array()

test_return_empty()

test_setter()

test_strict()

test_string()

test_string_escape()

test_string_quotes()

test_switch()

test_throw()

test_tofixed()

test_trycatch()

test_trycatch_guard()

test_unary()

test_unicode()

test_while()

test_while_comma_condition()

jasy.test.script.deadcode module

class jasy.test.script.deadcode.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_if_equal_false()

test_if_equal_true()

test_if_falsy()

test_if_falsy_and_falsy()

test_if_falsy_and_trueish()

test_if_falsy_and_unknown()

test_if_falsy_or_falsy()

test_if_falsy_or_trueish()

test_if_falsy_or_unknown()

test_if_identical_false()

test_if_identical_true()

test_if_not_falsy()

test_if_not_trueish()

test_if_trueish()

test_if_trueish_and_falsy()

test_if_trueish_and_trueish()

test_if_trueish_and_unknown()

test_if_trueish_or_falsy()

test_if_trueish_or_trueish()

test_if_trueish_or_unknown()

test_if_unknown_and_falsy()

test_if_unknown_and_trueish()

test_if_unknown_or_falsy()

test_if_unknown_or_trueish()

jasy.test.script.inject module

class jasy.test.script.inject.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code, contextId='')

test_get()

test_if_isset()

test_isset_bool_false()

test_isset_bool_shorthand_false()

test_isset_bool_shorthand_true()

test_isset_bool_true()

test_isset_float_false()

test_isset_float_true()

test_isset_int_false()

test_isset_int_true()

test_isset_lookup()

test_isset_str_multi()

test_isset_str_multilong()

test_isset_str_single()

test_isset_typediff()

test_select()

test_select_default()

test_select_multi()

test_select_notfound()

jasy.test.script.localvariables module

class jasy.test.script.localvariables.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_accessor_names()

test_args()

test_basic()

test_bind()

test_closure()

test_conflict_generatedname()

test_conflict_param_var()

test_conflict_same_name()

test_declaration()

test_exception()

test_exception_catchvar()

test_function()

test_inline_access()

test_let_definition()

test_let_expression()

test_let_statement()

test_reuse_different()

test_reuse_names()

jasy.test.script.meta module

class jasy.test.script.meta.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_asset_escape()

test_assets()

test_classes()

test_other()

test_structured()

jasy.test.script.privates module

class jasy.test.script.privates.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code, contextId='')

test_access_same_named_external()

Is is somehow an unsupported edge case which is not supported correctly yet.

Normally one would expect that the access to __field on RemoteObj would raise an error. At least it breaks this wrong access because this field is renamed based on file name as well.

test_assign()

test_assign_long()

test_global_obj_file1()

test_global_obj_file2()

test_local_deep()

test_localvar()

test_localvar_undeclared()

test_mixin()

test_remote()

jasy.test.script.translation module

class jasy.test.script.translation.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_basic()

test_marktr()

test_trc1()

test_trc2()

test_trc3()

test_trn1()

test_trn2()

test_vars1()

test_vars2()

test_vars3()

test_vars4()

jasy.test.script.unused module

class jasy.test.script.unused.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_func_called()

test_func_expressed_form_named()

test_func_expressed_form_named_inner()

test_func_named_called()

test_func_named_direct_called()

test_func_named_unused()

test_func_unused()

test_global_func()

test_global_var()

test_named_func_same_inner_outer()

test_named_vs_var()

test_object()

Non expressions must be protected with parens.

test_object_multi()

Non expressions must be protected with parens.

test_object_multi_others()

Non expressions must be protected with parens.

test_outdent()

test_outdent_multi_var()

test_params_first()

x is unused but could not be removed.

test_params_last()

y is unused and can be removed.

test_params_middle()

y is unused but could not be removed.

test_var_dep_blocks()

y contains operation so could not be removed and x is still in use.

test_var_dep_closure()

Removes y first and in a second run removes x as well.

test_var_ief()

test_var_ief_end()

test_var_ief_middle()

test_var_ief_noparens()

test_var_ief_noparens_end()

test_var_ief_noparens_middle()

test_var_multi_first()

y is unused.

Removes list entry.

test_var_multi_last()

y is unused.

Removes list entry.

test_var_same_inner_outer()

test_var_single()

y is unused.

Removed whole var block.

test_var_vs_named()

test_var_vs_named_inner()

Module contents

jasy.test.style package

Submodules

jasy.test.style.commands module

class jasy.test.style.commands.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_expr_minus()

test_expr_minus_compact()

test_expr_plus()

test_expr_plus_compact()

test_minus()

test_multi()

test_noexpr_minus_compact()

test_noexpr_plus_compact()

test_raw()

test_simple()

test_unary_minus()

test_unary_plus()

jasy.test.style.conditionals module

class jasy.test.style.conditionals.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_field()

test_field_as_variable()

test_if()

test_if_else_false()

test_if_else_false_paren()

test_if_else_false_paren_notoper()

test_if_else_true()

jasy.test.style.cssat module

class jasy.test.style.cssat.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_charset()

test_charset_invalid()

test_charset_wrong_syntax()

test_page()

test_page_selector_first()

test_page_selector_left()

test_page_selector_right()

jasy.test.style.extend module

class jasy.test.style.extend.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_atmedia()

test_atsupport()

test_basic()

test_call()

test_content_deeper()

test_content_media_and_supports()

test_content_simple()

test_content_simple_double()

test_content_with_followup()

test_content_with_media_in_call()

test_content_with_media_in_mixin()

test_content_with_preceding()

test_content_with_supports_in_call()

test_content_with_supports_in_mixin()

test_content_without_call()

test_def_as_func()

test_double()

test_extend_or_mixin()

test_local()

test_local_complex()

test_local_deeper()

test_local_override()

test_local_with_atmedia()

test_local_with_atsupports()

test_local_with_inner_atmedia()

test_local_with_inner_atsupports()

jasy.test.style.flattening module

class jasy.test.style.flattening.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_media_with_one_selector()

test_merge_media()

test_merge_media_and_selector()

test_merge_media_and_selector_conditional()

test_merge_selector()

test_order()

test_order_inner_media()

jasy.test.style.fontface module

class jasy.test.style.fontface.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_double()

test_multi_local()

test_single()

jasy.test.style.keyframes module

class jasy.test.style.keyframes.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_multistep()

test_named()

test_named_prefixed()

test_percent()

jasy.test.style.media module

class jasy.test.style.media.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_and()

test_and_color()

test_and_inner()

test_comma()

test_comma_and()

test_inner()

test_inner_children()

test_inner_double()

test_inner_double_list()

test_inner_double_switched()

test_inner_not_double()

test_print()

test_ratio()

test_reallife_pixel()

test_size()

jasy.test.style.mixins module

class jasy.test.style.mixins.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_content_complex()

test_content_double()

test_content_mediaquery_case()

test_content_none()

test_content_simple()

test_content_with_param()

test_content_with_param_double()

test_default_param()

test_default_param_two_extends()

test_double()

test_local_override()

test_param()

test_param_forcall()

test_param_missing()

test_param_mixed_units()

test_param_name_conflicts()

test_param_name_conflicts_default_ignore()

test_param_name_conflicts_default_use()

test_param_name_default_from_outer()

test_param_toomany()

test_param_transparent_units()

test_param_uses_extend()

test_param_with_compution()

test_param_with_mixed_compution()

test_wrong_place_call()

test_wrong_place_variable()

jasy.test.style.parentreference module

class jasy.test.style.parentreference.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_after()

test_attribute()

test_before()

test_bem()

test_between()

test_inside()

test_inside_variant()

jasy.test.style.root module

class jasy.test.style.root.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_basic()

test_basic_media()

test_basic_supports()

test_deep()

test_deep_multidist()

test_parentreference_append()

test_parentreference_append_multiroot()

test_parentreference_between()

test_parentreference_extend_content_double()

test_parentreference_extend_content_double_deeper()

test_parentreference_extend_content_double_multi()

test_parentreference_extend_content_single()

test_parentreference_generatedcontent()

test_parentreference_inline()

test_parentreference_inline_extend()

test_parentreference_inline_inner()

test_parentreference_inline_multidist_extend()

test_parentreference_inline_multiroot()

test_parentreference_inline_multiroot_multidist()

jasy.test.style.selectorcss3 module

class jasy.test.style.selectorcss3.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_adjacent_sibling_combinator()

test_attribute()

test_attribute_compare1()

test_attribute_compare2()

test_attribute_compare3()

test_attribute_compare4()

test_attribute_compare5()

test_attribute_equal()

test_child_combinator()

test_class_multi()

test_classname()

test_general_sibling_combinator()

test_id()

test_id_multi()

test_methodlike_iterarg()

test_methodlike_lang()

test_methodlike_noarg()

test_methodlike_not()

test_methodlike_posarg()

test_pseudo_class()

test_pseudo_element()

test_pseudo_element_dashed()

test_star()

test_tag()

test_tag_child()

test_tag_id()

test_tag_multi()

jasy.test.style.specials module

class jasy.test.style.specials.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_mozfullscreen()

test_msbackdrop()

jasy.test.style.strings module

class jasy.test.style.strings.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_basic()

test_quotes()

test_single()

jasy.test.style.supports module

class jasy.test.style.supports.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_atmedia()

test_atmedia_deeper()

test_between()

test_combined()

test_combined_inner()

test_inner()

test_join()

test_join_inside_atmedia()

test_outer()

jasy.test.style.values module

class jasy.test.style.values.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_collection_arguments()

jasy.test.style.variables module

class jasy.test.style.variables.Tests(methodName='runTest')

Bases: unittest.case.TestCase

process(code)

test_complex_font_setting()

test_condition_define_new()

test_condition_define_new_override()

test_condition_redefine()

test_condition_redefine_deep()

test_condition_redefine_override()

test_condition_strcomp()

test_default_available()

test_default_new()

test_define_assignop_multi()

test_define_assignop_plus()

test_define_color_hex()

test_define_color_hex3()

test_define_color_rgb()

test_define_multi()

test_define_multi_mutation_begin()

test_define_multi_mutation_end()

test_define_multi_mutation_plex()

test_define_multi_plus_operation_decl()

test_define_override()

test_define_unary()

test_math_operation()

test_math_operation_percent()

test_mixed_operation()

test_nonequal()

test_nonequal_combined()

test_nonequal_combined_human()

test_nonequal_combined_parens()

test_string_operation()

test_unused()

test_unused_operation()

test_value_operator_math()

test_value_simple()

test_value_simple_math()

test_value_simple_multi()

test_value_simple_namespaced()

test_value_simple_scope()

test_variable_property()

test_variable_selector()

test_variable_selector_complex()

test_variable_usedonly_in_property()

test_variable_usedonly_in_selector()

Module contents

Submodules

jasy.test.assettype module

class jasy.test.assettype.Tests(methodName='runTest')

Bases: unittest.case.TestCase

createGIF(path)

createJPG(path)

createPNG(path)

test_img_file_classes()

test_img_info_class()

test_type_correction()

jasy.test.cache module

class jasy.test.cache.Tests(methodName='runTest')

Bases: unittest.case.TestCase

test_clear()

test_close_and_reopen()

test_overwriting()

test_store_and_read()

test_store_iMfalse_and_read_iMfalse()

test_store_iMfalse_and_read_iMtrue()

test_store_iMtrue_and_read_iMfalse()

test_store_read_transient()

jasy.test.config module

class jasy.test.config.Tests(methodName='runTest')

Bases: unittest.case.TestCase

test_config_object_getdata()

test_config_object_getdata_withdot()

test_config_object_hasdata()

test_config_object_setdata()

test_config_object_setdata_withdot()

test_matching_types()

test_write_and_read_json()

test_write_and_read_yaml()

test_write_json()

test_write_yaml()

jasy.test.giturl module

class jasy.test.giturl.Tests(methodName='runTest')

Bases: unittest.case.TestCase

test_git_urls()

jasy.test.options module

class jasy.test.options.Tests(methodName='runTest')

Bases: unittest.case.TestCase

test_add()

test_add_and_parse()

test_getTasks()

test_parse()

jasy.test.project module

class jasy.test.project.Tests(methodName='runTest')

Bases: unittest.case.TestCase

createCaseFour()

createCaseOne()

createCaseThree()

createCaseTwo()

createjpyaml(path)

createjpyaml_withContent(path)

getProjects()

readFile(path, fileName)

test_assets()

test_fields()

test_get_class_by_name()

test_get_name_from_path()

test_get_project()

test_has_requires()

test_manual_class_fusion()

test_scan()

test_translations()

writeFile(path, fileName, content)

jasy.test.requirements module

class jasy.test.requirements.Tests(methodName='runTest')

Bases: unittest.case.TestCase

createProject(session, requirements)

createRequirement(name, subrequirements=None, manPath=None)

createSubRequirement(name, manPath=None)

createjpyaml(path, requirements)

readFile(path, fileName)

test_classes()

test_has_requires()

test_requires()

test_same_subrequirements()

test_subrequirement()

test_subrequirement_classes()

writeFile(path, fileName, content)

jasy.test.session module

class jasy.test.session.Tests(methodName='runTest')

Bases: unittest.case.TestCase

createProject(session, requirements, onlyFileCreation=False)

createRequirement(name, manPath=None)

createjpyaml(path, requirements)

readFile(path, fileName)

test_init()

test_load_library()

test_locale()

test_other_process()

test_pause_resume()

test_permutate()

writeFile(path, fileName, content)

jasy.test.text module

class jasy.test.text.Tests(methodName='runTest')

Bases: unittest.case.TestCase

test_markdown()

Module contents

jasy.vcs package

Submodules

jasy.vcs.Git module

jasy.vcs.Git.cleanRepository()

Cleans git repository from untracked files.

jasy.vcs.Git.distcleanRepository()

Cleans git repository from untracked files.

Ignores the files listed in ”.gitignore”.

jasy.vcs.Git.expandVersion(version=None)

jasy.vcs.Git.getBranch(path=None)

Returns the name of the git branch.

jasy.vcs.Git.getRevision(path=None)

Returns the last revision/hash of the git repository.

jasy.vcs.Git.getShortRevision(path=None)

Returns the last shortened revision/hash of the git repository.

jasy.vcs.Git.isUrl(url)

Figures out whether the given string is a valid Git repository URL.

jasy.vcs.Git.update(url, version, path, update=True, submodules=True)

Clones the given repository URL (optionally with overriding/update features)

jasy.vcs.Repository module

jasy.vcs.Repository.clean(path=None)

Cleans repository from untracked files.

Parameters:url (string) – Path to the local repository

jasy.vcs.Repository.distclean(path=None)

Cleans repository from untracked and ignored files. This method is pretty agressive in a way that it deletes all non repository managed files e.g. external folder, uncommitted changes, unstaged files, etc.

Parameters:url (string) – Path to the local repository

jasy.vcs.Repository.getRevision(path=None)

Returns the current revision of the repository in the given path.

jasy.vcs.Repository.getTargetFolder(url, version=None)

Returns the target folder name based on the URL and version using SHA1 checksums.

Parameters:

• url (string) – URL to the repository
• version – Version to use

jasy.vcs.Repository.getType(url)

Returns repository type of the given URL.

Parameters:url (string) – URL to the repository

jasy.vcs.Repository.isUrl(url)

Figures out whether the given string is a valid Git repository URL.

Parameters:url (string) – URL to the repository

jasy.vcs.Repository.update(url, version=None, path=None, update=True)

Clones the given repository URL (optionally with overriding/update features)

Parameters:

• url (string) – URL to the repository
• version – Version to clone
• version – Destination path
• version – Eneable/disable update functionality

jasy.vcs.Svn module

jasy.vcs.Svn.getBranch(path=None)

Returns the current branch name.

jasy.vcs.Svn.getInfo(path=None)

jasy.vcs.Svn.getRevision(path=None)

Returns the last revision/hash of the svn.

Module contents

Module contents

Jasy - Web Tooling Framework

Jasy is a powerful Python3-based tooling framework. It makes it easy to manage heavy web projects. Its main goal is to offer an API which could be used by developers to write their custom build/deployment scripts.

exception jasy.UserError

Bases: Exception

Standard Jasy error class raised whenever something happens which the system understands (somehow excepected)

jasy.info()

Prints information about Jasy to the console.

Indices and tables

• Index
• Module Index
• Search Page