Package gnue :: Package common
[show private | hide private]

Package gnue.common

The GNUe Common Library is a set of Python modules used in the GNUe tools. Many of the modules can also be used outside GNUe.
Submodules
  • apps: Basic services for all GNUe based applications
    • CommandOption: Command option available to GBaseApp and descendants.
    • GBaseApp: Class that provides a basis for GNUe applications.
    • GClientApp
    • GConfig: Class that loads the configuration files so gnue apps can get default settings.
    • GDebug: Support for debugging messages with independent debug levels and redirection of messages to a file.
    • GImportLogger: Importing this module causes all modules imported after this to be printed to stdout
    • GLogger
    • GServerApp: This module provides the base class for server applications in GNU Enterprise.
    • RuntimeSettings: Saves the state of designer between runs.
    • checktype: Support for checking the type of variables.
    • errors: General exception classes.
    • i18n: Internationalization support.
    • manpage: Tool self-documenting base class
    • plugin: This module is *DEPRECATED*.
  • base: The base package contains a number of modules providing very basic functions that are used all over the GNU Enterprise tools.
    • checktype: Support for checking the type of variables.
    • errors: General exception classes.
    • i18n: Internationalization support.
    • log: The log module extends the standard logging module with some convenience functions related to the logging schema used in GNU Enterprise.
    • utils: The utils module provides some very basic although GNU Enterprise specific utility functions.
  • datasources
    • ConnectionTriggerObj: Wrapper object for connections to be used in trigger namespace.
    • Exceptions: Exceptions used in the database driver system.
    • GConditions: Classes for the condition object tree.
    • GConnections: Connection manager system.
    • GDataSource: Classes for the datasource object tree.
    • GLoginHandler: Classes for login handlers.
    • GSchema: Classes for the schema object tree.
    • drivers: Database driver plugins.
      • Base: Generic base classes for database driver plugins.
        • Behavior: Generic Behavior class extended by all database driver plugins.
        • Connection: Generic Connection class extended by all database driver plugins.
        • RecordSet: RecordSet class used by all database driver plugins.
        • ResultSet: Generic ResultSet class extended by all database driver plugins.
      • DBSIG2: Generic Database driver plugin for SQL based backends using a DBSIG2 compatible Python module.
        • Behavior: Generic Behavior class for DBSIG2 based database driver plugins.
        • Connection: Generic Connection class for DBSIG2 based database driver plugins.
        • ResultSet: Generic ResultSet class for DBSIG2 based database driver plugins.
      • file: Database driver plugins for file based backends.
        • Base: Generic database driver plugin for file based backends.
        • csvfile: Database driver plugin for CSV file backends.
        • dbffile: Database driver plugin for DBF file backends.
        • inifile: Database driver plugin for INI style configuration file backends.
      • other: Database driver plugins for special backends.
        • appserver: Database driver plugin for GNU Enterprise Application Server backends.
      • sql: Database driver plugins for SQL based backends.
        • interbase: Database driver plugins for Firebird/Interbase backends.
          • Behavior: Schema support plugin for Firebird/Interbase backends.
          • kinterbasdbdrv: Database driver plugin for Firebird/Interbase backends using the KinterbasDB DBSIG2 module.
        • maxdb: Database driver plugins for MaxDB/SAP-DB backends.
          • Behavior: Schema support plugin for MaxDB/SAP-DB backends.
          • maxdbdrv: Database driver plugin for MaxDB/SAP-DB backends.
        • msado: Database driver plugins for MS-ADO backends.
          • Behavior: Schema support plugin for MS-ADO backends.
          • adodbapidrv: Database driver plugin for MS-ADO backends using the adodbapi DBSIG2 module.
        • mysql: Database driver plugins for MySQL backends.
          • Behavior: Schema support plugin for MySQL backends.
          • mysqldbdrv: Database driver plugin for MySQL backends using the MySQLdb DBSIG2 module.
        • oracle: Database driver plugins for Oracle backends.
          • Base: Generic database driver plugin for Oracle backends.
          • Behavior: Schema support plugin for Oracle backends.
          • cxoracledrv: Database driver plugin for Oracle backends using the cxOracle DBSIG2 module.
          • dcoracledrv: Database driver plugin for Oracle backends using the DCOracle DBSIG2 module.
        • postgresql: Database driver plugins for PostgreSQL backends.
          • Base: Generic database driver plugin for PostgreSQL backends.
          • Behavior: Schema support plugin for PostgreSQL backends.
          • psycopg2drv: Database driver plugin for PostgreSQL backends using the psycopg2 DBSIG2 module.
          • psycopgdrv: Database driver plugin for PostgreSQL backends using the psycopg DBSIG2 module.
          • pygresqldrv: Database driver plugin for PostgreSQL backends using the PyGreSQL DBSIG2 module.
          • pypgsqldrv: Database driver plugin for PostgreSQL backends using the pyPgSQL DBSIG2 module.
        • sqlite2: Database driver plugins for SQLite backends.
          • Behavior: Schema support plugin for SQLite.
          • pysqlitedrv: Database driver plugin for SQLite backends using the pysqlite DBSIG2 module.
        • sqlite3: Database driver plugins for SQLite backends.
          • Base: Base driver plugin for SQLite3 backends.
          • Behavior: Schema support plugin for SQLite3.
          • pysqlite2drv: Database driver plugin for SQLite3 backends using the pysqlite2 DBSIG2 module.
          • sqlite3drv: Database driver plugin for SQLite3 backends using the Python's builtin sqlite3 DBSIG2 module.
    • readgsd: Program to import gsd files.
  • definitions: GNUe object trees based on XML.
    • GBinary: Provides a container object for binary data.
    • GObjects: Base class for GNUe objects which can be represented as XML
    • GParser: Class that contains a SAX2-based XML processor for GNUe
    • GParserHelpers: Base classes for GNUe objects which can be represented as XML.
    • GRootObj: Provides the base class that can optionally be used by root objects in a GObj based tree.
  • events: Framework for creating, passing and dispatching events.
  • external
    • decimal: This is a Py2.3 implementation of decimal floating point arithmetic based on the General Decimal Arithmetic Specification: www2.hursley.ibm.com/decimal/decarith.html and IEEE standard 854-1987: www.cs.berkeley.edu/~ejr/projects/754/private/drafts/854-1987/dir.html Decimal floating point has finite precision with arbitrarily large bounds.
    • fixedpoint: FixedPoint objects support decimal arithmetic with a fixed number of digits (called the object's precision) after the decimal point.
    • shellwords: shellwords.py Parse a string into words like a (POSIX) shell does.
  • formatting
  • GCConfig: Valid configuration options that apply to all GNUe tools (appears under [common] section in gnue.conf or can appear in each individual tool section)
  • gear
  • GMenu
  • lib: The lib package contains a number of modules providing very basic functions also usable independently of GNU Enterprise.
    • iso8601: Functions to parse ISO 8601 conformant date and time strings.
    • modules: Functions to find out about the module of the caller.
  • logic
    • GTrigger
    • GTriggerCore: Base Classes to derive from to make use of the action/trigger system.
    • NamespaceCore: Classes to build up a namespace object tree from an XML object tree.
    • adapters: Language adapter plugins for the various languages.
      • Base: Base classes for language adapter plugins.
      • python: Language adapter plugin for Python.
    • language: Interface to language adapters.
    • usercode: Classes for all the object trees that handle user code: Actions and Triggers.
  • printing
    • barcodes
      • Base
      • codabar: Implements the Codabar barcode spec
      • code39: Implements the Code 39 barcode spec
      • interleaved2of5: Implements the Interleaved 2 of 5 barcode spec
      • postnet: Implements the USPS PostNet barcode spec
      • standard2of5: Implements the Standard 2 of 5 barcode spec
    • pdftable
      • pdftable: A class that creates multisection tabular pdf reports.
      • sample: A sample application showing how to use pdftable
  • rpc: GNUe RPC library
  • setup
    • GSetup: Base classes for package setup based on distutils
  • utils
    • CaselessDict
    • FileUtils
    • GDateTime: Deprecated module.
    • GMimeTypes
    • TextUtils: Common text-related utilities
    • datatypes: Helper functions for datatype conversion.
    • dbf
    • file: Helper functions for opening/reading files or network resources.
    • http
    • importing: This module implements a dynamic module importer.
    • plugin: Functions to list and load avaliable plugins dynamically.
    • setup: Base classes for package setup based on distutils
    • tree: Classes representing a node in a tree structure.
    • ucsv: This module provides a csv.DictWriter class which is able to handle unicode values.
    • uuid: This module implements an UUID generator as described in the internet draft at 'http://www.ietf.org/internet-drafts/draft-mealling-uuid-urn-05.txt' or also described in the RPC-RFC.
    • version: Helper functions for version handling.
    • xlocale: Helper functions which we think are missing in python's locale module.

Variable Summary
str __hexversion__ = '0007a080'
str __version__ = '0.7-alpha0+svn.9894'
str HEXVERSION = '0007a080'
str PACKAGE = 'GNUe-Common'
str TITLE = 'GNUe Common Library'
Version version = <gnue.common.utils.version.Version instance at...
str VERSION = '0.7-alpha0+svn.9894'

Variable Details

__hexversion__

Type:
str
Value:
'0007a080'                                                             

__version__

Type:
str
Value:
'0.7-alpha0+svn.9894'                                                  

HEXVERSION

Type:
str
Value:
'0007a080'                                                             

PACKAGE

Type:
str
Value:
'GNUe-Common'                                                          

TITLE

Type:
str
Value:
'GNUe Common Library'                                                  

version

Type:
Version
Value:
<gnue.common.utils.version.Version instance at 0xb7d49aec>             

VERSION

Type:
str
Value:
'0.7-alpha0+svn.9894'                                                  


GNUe Home

Public API

Developer's Corner