tools Package

tools Package

class tic.development.tools.AppYamlGeneratorBuildTask(compmgr, init=None, cls=<class 'tic.development.tools.AppYamlGeneratorBuildTask'>)

Bases: tic.core.Component

app_yaml = 'app.yaml'

run(build_path)

Gnerates the app.yaml file

class tic.development.tools.BuildTaskRunner(compmgr, init=None, cls=<class 'tic.development.tools.BuildTaskRunner'>)

Bases: tic.core.Component

build_path = '../build'

get_admin_commands()

run(build=None)

Cleans and initializes the build directory.

tasks

List of components that implement tic.development.tools.api.IBuildTask

class tic.development.tools.CopySourceTreeBuildTask(compmgr, init=None, cls=<class 'tic.development.tools.CopySourceTreeBuildTask'>)

Bases: tic.core.Component

run(build_path)

class tic.development.tools.DeleteDevelopmentFiles(compmgr, init=None, cls=<class 'tic.development.tools.DeleteDevelopmentFiles'>)

Bases: tic.core.Component

directories_to_delete = ['tic/web/client/']

run(build_path)

class tic.development.tools.SettingsPyGeneratorBuildTask(compmgr, init=None, cls=<class 'tic.development.tools.SettingsPyGeneratorBuildTask'>)

Bases: tic.core.Component

run(build_path)

Writes the file

settings_file = 'settings.py'

api Module

class tic.development.tools.api.IBuildTask

Bases: tic.core.Interface

Interface for running a build task

run(build_path)

What to do to execute the task

class tic.development.tools.api.IDirectoryWatcher

Bases: tic.core.Interface

Interface for watching deleted files and stuff

changed(changed_files)

changed_files: list of paths to changed files

created(created_files)

created_files: list of paths to newly created files

deleted(deleted_files)

deleted_files: list of paths to removed files

class tic.development.tools.api.IRunServerTask

Bases: tic.core.Interface

Interface for running a task before the server starts

run()

Executes the task

directory_watcher Module

class tic.development.tools.directory_watcher.DirectoryWatcher(compmgr, init=None, cls=<class 'tic.development.tools.directory_watcher.DirectoryWatcher'>)

Bases: tic.core.Component

directory_watchers

List of components that implement tic.development.tools.api.IDirectoryWatcher

watch(path, delay=1)

starts watching the provided path

class tic.development.tools.directory_watcher.DirectoryWatcherCommand(compmgr, init=None, cls=<class 'tic.development.tools.directory_watcher.DirectoryWatcherCommand'>)

Bases: tic.core.Component

get_admin_commands()

Returns a list of commands to execute @see tic.admin.api.IAdminCommandProvider

class tic.development.tools.directory_watcher.SimpleDirectoryChangeLogger(compmgr, init=None, cls=<class 'tic.development.tools.directory_watcher.SimpleDirectoryChangeLogger'>)

Bases: tic.core.Component

changed(list)

created(list)

deleted(list)

tic.development.tools.directory_watcher.watch_directories(paths, func, delay=1)

(paths:[str], func:callable, delay:float) Continuously monitors the paths and their subdirectories for changes. If any files or directories are modified, the callable ‘func’ is called with a list of the modified paths of both files and directories. ‘func’ can return a Boolean value for rescanning; if it returns True, the directory tree will be rescanned without calling func() for any found changes. (This is so func() can write changes into the tree and prevent itself from being immediately called again.)