The seaice package

seaice is comprised of tools and datastructures on which the front ends are built. Distributed with SeaIce are two top level Python programs with very clever names:

  • sea – Command line tool for setting up, tearing down, and other wise interacting with the database in various ways.
  • ice – Web UI based on Flask for SeaIce. This facilitates user interactions with the database by serving various GET/POST requests.

See the section on top-level programs [ref] for more details. The SeaIce API should be imported into the application namespace with:

import seaice

Included in seaice.* are user data structures for Flask-login, get_config() which handles local database configuration, and the various output formatters (seaice.pretty.*). The most important object, seaice.SeaIceFlask is used to build a Flask-based web interface for SeaIce.

class SeaIceFlask

class seaice.SeaIceFlask.SeaIceFlask(import_name, static_path=None, static_url_path=None, static_folder='html/static', template_folder='html/templates', instance_path=None, instance_relative_config=False, db_user=None, db_password=None, db_name=None)[source]

Bases: flask.app.Flask

A subclass of the main Flask interface. This includes various live data structures used in the web interface, as well as a pool of database connectors. All features in the SeaIce API that the top-level progams make use of are available as attributes of this class.
Parameters:
SeaIceFlask.dbPool
Type:seaice.ConnectorPool.SeaIceConnectorPool
SeaIceFlask.userIdPool
Type:seaice.IdPool
SeaIceFlask.termIdPool
Type:seaice.IdPool
SeaIceFlask.commentIdPool
Type:seaice.IdPool
SeaIceFlask.SeaIceUsers
Type:seaice.user.User dict
seaice.SeaIceFlask.MAX_CONNECTIONS = 18

The number of DB connections that will be instantiated.

Table Of Contents

Previous topic

Welcome to the YAMZ documentation!

Next topic

class SeaIceConnector – interface for PostgreSQL DB

This Page