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: builtins.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: builtins.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: builtins.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: builtins.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: builtins.object

Parses CLDR locales into JavaScript files

export(path)

jasy.core.MetaData module

class jasy.core.MetaData.MetaData(tree)

Bases: builtins.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: builtins.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: builtins.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: builtins.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: builtins.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: builtins.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: builtins.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