seesaw Package

seesaw Package

ArchiveTeam seesaw kit

config Module

Configuration value manipulation.

class seesaw.config.ConfigInterpolation(s, c)

Bases: object

realize(item)

class seesaw.config.ConfigValue(name, title='', description='', default=None, editable=True, advanced=True)

Bases: object

Configuration value validator.

The collection methods are useful for providing user configurable settings at run time. For example, when a pipeline file is executed by the warrior, the additional config values are presented in the warrior configuration panel.

check_value(value)

collector = None

convert_value(value)

is_valid()

realize(dummy)

set_value(value)

classmethod start_collecting()

classmethod stop_collecting()

class seesaw.config.NumberConfigValue(*args, **kwargs)

Bases: seesaw.config.ConfigValue

check_value(value)

convert_value(value)

class seesaw.config.StringConfigValue(*args, **kwargs)

Bases: seesaw.config.ConfigValue

check_value(value)

seesaw.config.realize(v, item=None)

Makes objects contain concrete values from an item.

A silly example:

class AddExpression(object):
    def realize(self, item):
        return = item['x'] + item['y']

pipeline = Pipeline(ComputeMath(AddExpression()))

In the example, we want to compute an addition expression. The values are defined in the Item.

event Module

Actor model.

class seesaw.event.Event

Bases: object

Lightweight event system.

Example:

my_event_system = Event()
my_event_system = my_listener_callback_function
my_event_system(my_event_data)

fire(*args, **kargs)

getHandlerCount()

handle(handler)

unhandle(handler)

externalprocess Module

Running subprocesses asynchronously.

class seesaw.externalprocess.AsyncPopen(*args, **kwargs)

Bases: object

Asynchronous version of subprocess.Popen.

Deprecated.

classmethod ignore_sigint()

run()

class seesaw.externalprocess.AsyncPopen2(*args, **kwargs)

Bases: object

Adapter for the legacy AsyncPopen

run()

stdin

class seesaw.externalprocess.CurlUpload(target, filename, connect_timeout='60', speed_limit='1', speed_time='900', max_tries=None)

Bases: seesaw.externalprocess.ExternalProcess

Upload with Curl process runner.

class seesaw.externalprocess.ExternalProcess(name, args, max_tries=1, retry_delay=30, accept_on_exit_code=None, retry_on_exit_code=None, env=None)

Bases: seesaw.task.Task

External subprocess runner.

enqueue(item)

handle_process_error(exit_code, item)

handle_process_result(exit_code, item)

on_subprocess_end(item, returncode)

on_subprocess_stdout(pipe, item, data)

process(item)

stdin_data(item)

class seesaw.externalprocess.RsyncUpload(target, files, target_source_path='./', bwlimit='0', max_tries=None, extra_args=None)

Bases: seesaw.externalprocess.ExternalProcess

Upload with Rsync process runner.

stdin_data(item)

class seesaw.externalprocess.WgetDownload(args, max_tries=1, accept_on_exit_code=None, retry_on_exit_code=None, env=None, stdin_data_function=None)

Bases: seesaw.externalprocess.ExternalProcess

Download with Wget process runner.

stdin_data(item)

seesaw.externalprocess.cleanup()

item Module

Managing work units.

class seesaw.item.Item(pipeline, item_id, item_number, properties=None, keep_data=False, prepare_data_directory=True)

Bases: object

A thing, or work unit, that needs to be downloaded.

It has properties that are filled by the Task.

An Item behaves like a mutable mapping.

Note

State belonging to a item should be stored on the actual item itself. That is, do not store variables onto a Task unless you know what you are doing.

class TaskStatus

Bases: object

completed = 'completed'

failed = 'failed'

running = 'running'

Item.cancel()

Item.clear_data_directory()

Item.complete()

Item.description()

Item.fail()

Item.get(key)

Item.log_error(task, *args)

Item.log_output(data, full_line=True)

Item.prepare_data_directory()

Item.set_task_status(task, status)

class seesaw.item.ItemInterpolation(s)

Bases: object

Formats a string using the percent operator during realize().

realize(item)

class seesaw.item.ItemValue(key)

Bases: object

Get an item’s value during realize().

fill(item, value)

realize(item)

pipeline Module

class seesaw.pipeline.Pipeline(*tasks)

Bases: object

The sequence of steps that complete a Task.

Your pipeline will probably be something like this:

1. Request an assignment from the tracker.
2. Run Wget to download the file.
3. Upload the downloaded file with rsync.
4. Tell the tracker that the assignment is done.

add_task(task)

cancel_items()

enqueue(item)

ui_task_list()

project Module

Project information.

class seesaw.project.Project(title=None, project_html=None, utc_deadline=None)

Bases: object

Briefly describes a project metadata.

This class defines the title of the project, a short description with an optional project logo and an optional deadline. The information will be shown in the web interface when the project is running.

data_for_json()

runner Module

Pipeline execution.

class seesaw.runner.Runner(stop_file=None, concurrent_items=1, max_items=None, keep_data=False)

Bases: object

Executes and manages the lifetime of Pipeline instances.

add_items()

check_stop_file()

is_active()

keep_running()

set_current_pipeline(pipeline)

should_stop()

start()

stop_file_changed()

stop_file_mtime()

stop_gracefully()

class seesaw.runner.SimpleRunner(pipeline, stop_file=None, concurrent_items=1, max_items=None, keep_data=False)

Bases: seesaw.runner.Runner

Executes a single class:Pipeline instance.

forced_stop()

start()

task Module

Managing steps in a work unit.

class seesaw.task.ConditionalTask(condition_function, inner_task)

Bases: seesaw.task.Task

Runs a task optionally.

enqueue(item)

fill_ui_task_list(task_list)

class seesaw.task.LimitConcurrent(concurrency, inner_task)

Bases: seesaw.task.Task

Restricts the number of tasks of the same type that can be run at once.

enqueue(item)

fill_ui_task_list(task_list)

class seesaw.task.PrintItem

Bases: seesaw.task.SimpleTask

Output the name of the Item.

process(item)

class seesaw.task.SetItemKey(key, value)

Bases: seesaw.task.SimpleTask

Set a value onto a task.

process(item)

class seesaw.task.SimpleTask(name)

Bases: seesaw.task.Task

A subclassable Task that should do one small thing well.

Example:

class MyTask(SimpleTask):
    def process(self, item):
        item['my_message'] = 'hello world!'

enqueue(item)

process(item)

class seesaw.task.Task(name)

Bases: object

A step in the download process of an Item.

complete_item(item)

fail_item(item)

fill_ui_task_list(task_list)

start_item(item)

task_cwd(*args, **kwds)

tracker Module

Contacting the work unit server.

A Tracker refers to the Universal Tracker (https://github.com/ArchiveTeam/universal-tracker).

class seesaw.tracker.GetItemFromTracker(tracker_url, downloader, version=None)

Bases: seesaw.tracker.TrackerRequest

Get a single work unit information from the Tracker.

data(item)

process_body(body, item)

class seesaw.tracker.PrepareStatsForTracker(defaults=None, file_groups=None, id_function=None)

Bases: seesaw.task.SimpleTask

Apply statistical values on the item.

process(item)

class seesaw.tracker.SendDoneToTracker(tracker_url, stats)

Bases: seesaw.tracker.TrackerRequest

Inform the Tracker the work unit has been completed.

data(item)

process_body(body, item)

class seesaw.tracker.TrackerRequest(name, tracker_url, tracker_command, may_be_canceled=False)

Bases: seesaw.task.Task

Represents a request to a Tracker.

DEFAULT_RETRY_DELAY = 60

data(item)

enqueue(item)

handle_response(item, response)

increment_retry_delay(max_delay=300)

process_body(body, item)

reset_retry_delay()

schedule_retry(item, message='')

send_request(item)

class seesaw.tracker.UploadWithTracker(tracker_url, downloader, files, version=None, rsync_target_source_path='./', rsync_bwlimit='0', rsync_extra_args=[], curl_connect_timeout='60', curl_speed_limit='1', curl_speed_time='900')

Bases: seesaw.tracker.TrackerRequest

Upload work unit results.

One of the inner task is used depending on the Tracker’s response to where to upload:

• RsyncUpload
• CurlUpload

data(item)

process_body(body, item)

util Module

Miscellaneous functions.

seesaw.util.find_executable(name, version, paths, version_arg='-V')

Returns the path of a matching executable.

See also

test_executable()

seesaw.util.test_executable(name, version, path, version_arg='-V')

Try to run an executable and check its version.

seesaw.util.unique_id_str()

Returns a unique string suitable for IDs.

warrior Module

The warrior server.

The warrior phones home to Warrior HQ (https://github.com/ArchiveTeam/warrior-hq).

class seesaw.warrior.BandwidthMonitor(device)

Bases: object

Extracts the bandwidth usage from the system stats.

current_stats()

devre = <_sre.SRE_Pattern object>

update()

class seesaw.warrior.ConfigManager(config_file)

Bases: object

Manages the configuration.

add(config_value)

all_valid()

editable_values()

load()

remove(name)

save()

set_value(name, value)

class seesaw.warrior.Warrior(projects_dir, data_dir, warrior_hq_url, real_shutdown=False, keep_data=False)

Bases: object

The warrior god object.

class Status

Bases: object

INVALID_SETTINGS = 'INVALID_SETTINGS'

NO_PROJECT = 'NO_PROJECT'

REBOOTING = 'REBOOTING'

RESTARTING_PROJECT = 'RESTARTING_PROJECT'

RUNNING_PROJECT = 'RUNNING_PROJECT'

SHUTTING_DOWN = 'SHUTTING_DOWN'

STARTING_PROJECT = 'STARTING_PROJECT'

STOPPING_PROJECT = 'STOPPING_PROJECT'

SWITCHING_PROJECT = 'SWITCHING_PROJECT'

UNINITIALIZED = 'UNINITIALIZED'

Warrior.bandwidth_stats()

Warrior.check_project_has_update(*args, **kwargs)

Warrior.clone_project(project_name, project_path)

Warrior.collect_install_output(data)

Warrior.find_lat_lng()

Warrior.fire_status()

Warrior.forced_reboot()

Warrior.forced_stop()

Warrior.handle_lat_lng(response)

Warrior.handle_runner_finish(runner)

Warrior.install_project(*args, **kwargs)

Warrior.keep_running()

Warrior.load_pipeline(pipeline_path, context)

Warrior.max_age_reached()

Warrior.reboot_gracefully()

Warrior.schedule_forced_reboot()

Warrior.select_project(*args, **kwargs)

Warrior.start()

Warrior.start_selected_project(*args, **kwargs)

Warrior.stop_gracefully()

Warrior.update_project(*args, **kwargs)

Warrior.update_warrior_hq(*args, **kwargs)

Warrior.warrior_status()

web Module

The warrior web interface.

class seesaw.web.ApiHandler(application, request, **kwargs)

Bases: tornado.web.RequestHandler

Processes API requests.

get(command)

get_template_path()

initialize(warrior=None, runner=None)

post(command)

class seesaw.web.IndexHandler(application, request, **kwargs)

Bases: tornado.web.RequestHandler

Shows the index.html.

get()

class seesaw.web.ItemMonitor(item)

Bases: object

Pushes item states and information to the client.

handle_item_cancel(item)

handle_item_complete(item)

handle_item_fail(item)

handle_item_output(item, data)

handle_item_property(item, key, new_value, old_value)

handle_item_task_status(item, task, new_status, old_status)

item_for_broadcast()

item_status()

class seesaw.web.SeesawConnection(session)

Bases: sockjs.tornado.conn.SockJSConnection

A WebSocket server that communicates the state of the warrior.

classmethod broadcast(event, message)

classmethod broadcast_bandwidth()

classmethod broadcast_project_refresh()

classmethod broadcast_projects()

classmethod broadcast_timestamp()

clients = set([])

emit(event_name, message)

tornadoio to sockjs adapter.

classmethod handle_broadcast_message(warrior, message)

classmethod handle_finish_item(runner, pipeline, item)

classmethod handle_project_installation_failed(warrior, project, output)

classmethod handle_project_installed(warrior, project, output)

classmethod handle_project_installing(warrior, project)

classmethod handle_project_refresh(warrior, project, runner)

classmethod handle_project_selected(warrior, project)

classmethod handle_projects_loaded(warrior, projects)

classmethod handle_runner_status(runner, status)

classmethod handle_start_item(runner, pipeline, item)

classmethod handle_warrior_status(warrior, new_status)

instance_id = '7735-0.956574'

item_monitors = {}

on_close()

on_message(message)

on_open(info)

project = None

runner = None

warrior = None

seesaw.web.hash_string(text)

Generate a digest for broadcast message.

seesaw.web.start_runner_server(project, runner, bind_address='localhost', port_number=8001, http_username=None, http_password=None)

Starts a web interface for a manually run pipeline.

Unlike start_warrior_server(), this UI does not contain an configuration or project management panel.

seesaw.web.start_warrior_server(warrior, bind_address='localhost', port_number=8001, http_username=None, http_password=None)

Starts the warrior web interface.

web_util Module

class seesaw.web_util.AuthenticatedApplication(*args, **kwargs)

Bases: tornado.web.Application

class seesaw.web_util.AuthenticationErrorHandler(application, request, **kwargs)

Bases: tornado.web.RequestHandler

initialize(realm='Restricted')

prepare()