Zope-2-CVS-srcdocs/0040700000176200017510000000000007306455542014054 5ustar dhellmanndevelZope-2-CVS-srcdocs/index.html0100600000176200017510000004626007306455646016065 0ustar dhellmanndevel Zope2 CVS with ZEO

Table of Contents

Zope2 CVS with ZEO  

Welcome to the Zope source release

This document provides some general information about the Zope source release and provides links to other documents.

Installation information can be found in doc/INSTALL.txt. Other documentation is also in the doc directory.

Zope information is available at http://www.zope.org/

Report problems with this release on the Zope mailing list (zope@zope.org) To subscribe to the list send mail to zope-request@zope.org with "subscribe" in the subject line.

Introduction

The source release is intended for tinkerers, those who want to use Zope components separately, Bobo hackers, people who want to use their own Python, and people who work on obscure platforms because they love to compile everything from source.

If you just want to use Zope easily and aren't a programmer the binary release will probably suit you better. All are available at http://www.zope.org/Download

License

The Zope License is included in LICENSE.txt Send your feedback about the license to zope-license@zope.org.

Important

This release requires Python 1.5.2.

Installing Zope

Follow the instructions in doc/INSTALL.txt to install Zope.

Using Zope Components Separately

Zope consists of many Python packages which can be profitably used by themselves. For example you will find all your old friends from Bobo here:

  • ZPublisher - A packagized version of the Bobo ORB you know and love.

  • DocumentTemplate - This package includes cDocumentTemplate which speeds things up considerably.

  • BoboPOS - This is NOT ZODB 3. It a version of BoboPOS2 which include c code to make things faster.

You can find most of these packages in the lib/python directory. If you poke around, you might find other goodies too, like StructuredText.

ZPublisher and DocumentTemplate are also available separately.

Notes

  • Zope requires Python 1.5.2.

  • Lots more documentation is coming.

  • Don't forget to check the Zope web site and mailing list.

  • Read the source, have fun!

Modules and Packages   

Zope-2-CVS-src/

LICENSE.txt.html

Zope Public License (ZPL) Version 1.0 -------------------------------------

README.txt.html

Welcome to the Zope source release

ZServer

ZServer README --------------

w_pcgi

Try to do all of the installation steps.

wo_pcgi

Try to do all of the installation steps.

z2

Zope 2 ZServer start-up file

zpasswd

Zope user bootstrap system

Zope-2-CVS-src/inst/

binary_install

Try to do all of the installation steps.

build_extensions

Build the Zope Extension Modules

build_pcgi

Build a PCGI

compilezpy
default_content
do

Shared routines used by the various scripts.

make_resource

Build a PCGI resource file.

make_start
walkandscrub

Zope-2-CVS-src/lib/Components/ExtensionClass/

README.html

See the file doc/ExtensionClass.stx or doc/ExtensionClass.html for a description of extension class.

Xaq
setup

Support for Python classes implemented in C

Zope-2-CVS-src/lib/Components/ExtensionClass/test/

regrtest
test_AqAlg
test_MultiMapping
test_Sync
test_ThreadLock
test_acquisition
test_add
test_binding
test_explicit_acquisition
test_method_hook

Zope-2-CVS-src/lib/Components/cPickle/

copy_reg

Zope-2-CVS-src/lib/python/

AccessControl

Zope2 CVS with ZEO: AccessControl

App

Zope2 CVS with ZEO: App

BTrees

Zope2 CVS with ZEO: BTrees

DateTime

Zope2 CVS with ZEO: DateTime

DocumentTemplate

Zope2 CVS with ZEO: DocumentTemplate

Globals

Global definitions

HelpSys

Zope2 CVS with ZEO: HelpSys

ImageFile

Image object that is stored in a file

Interface

Scarecrow interface implementation

LOG
Main

Provide a Main application for the Zope framework

OFS

Zope2 CVS with ZEO: OFS

Persistence

Provide access to Persistent and PersistentMapping

Products

Zope2 CVS with ZEO: Products

RestrictedPython

RestrictedPython package.

SearchIndex

Zope2 CVS with ZEO: SearchIndex

Shared

Zope2 CVS with ZEO: Shared

StructuredText

Zope2 CVS with ZEO: StructuredText

Testing

Set up testing environment

ThreadedAsync

Manage the asyncore mainloop in a multi-threaded app

TreeDisplay

Zope2 CVS with ZEO: TreeDisplay

ZClasses

Zope2 CVS with ZEO: ZClasses

ZEO

Zope2 CVS with ZEO: ZEO

ZLogger

Zope2 CVS with ZEO: ZLogger

ZODB

Zope2 CVS with ZEO: ZODB

ZPublisher

Zope2 CVS with ZEO: ZPublisher

Zope

Initialize the Zope Package and provide a published module

dcdb
tempfile

Temporary files and filenames. This is r1.27 of the Python MAIN CVS

ts_regex

Provide a thread-safe interface to regex

unittest

Python unit testing framework, based on Erich Gamma's JUnit and Kent Beck's

webdav

The webdav package provides WebDAV capability for common Zope objects.

xmlrpclib
zLOG

General logging facility

zdaemon

zinit, slightly smarter server manager and ZServer startup script.

Zope-2-CVS-src/pcgi/

README.html

README notes for Persistent CGI - version 2.0 alpha 4

pcgi_publisher

Zope-2-CVS-src/pcgi/Example/

pcgitime

Zope-2-CVS-src/pcgi/MrCreosote/

README.MrCreosote.html

README.MrCreosote - JeffBauer@bigfoot.com - May 21, 1998

creosote

Zope-2-CVS-src/pcgi/Util/

README.html

pcgifile.py - JeffBauer@bigfoot.com - May 21, 1998

killpcgi
pcgifile

Zope-2-CVS-src/utilities/

README.txt.html

This directory contains utility scripts and modules that augment Zope.

FS
bbb

Read and (re-)format BoboPOS 2 database files

fixbbbts
load_site

Load a Zope site from a collection of files or directories

requestprofiler

Request log profiler script

testrunner

testrunner - a Zope test suite utility.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/0040700000176200017510000000000007306455645016352 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/0040700000176200017510000000000007306455643017116 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/0040700000176200017510000000000007306455645020441 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/0040700000176200017510000000000007306455543023200 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/index.html0100600000176200017510000001111207306455543025170 0ustar dhellmanndevel Zope2 CVS with ZEO: AccessControl

Table of Contents

Zope2 CVS with ZEO: AccessControl  
Modules and Packages   

Zope-2-CVS-src/lib/python/AccessControl/

AuthEncoding
DTML

Add security system support to Document Templates

IUserFolder
Owned
Permission
PermissionMapping

Permission Mapping

PermissionRole
Permissions

Constant definitions for built-in Zope permissions

Role

Access control support

SecurityInfo

SecurityInfo objects and access control constants.

SecurityManagement
SecurityManager
SimpleObjectPolicies
SpecialUsers
User

Access control package

ZopeGuards
ZopeSecurityPolicy
__init__

Zope-2-CVS-src/lib/python/AccessControl/tests/

testSecurity

Document Template Tests

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/AuthEncoding.py.html0100600000176200017510000001034407306455542027065 0ustar dhellmanndevel Module: AuthEncoding

Table of Contents

Module: AuthEncoding Zope-2-CVS-src/lib/python/AccessControl/AuthEncoding.py

Imported modules   
import binascii
import sha
from string import upper
Functions   
pw_encode
pw_validate
  pw_encode  
pw_encode ( pw,  encoding='SHA' )

Encode the provided plain text password using the encoding if provided and return it in an LDAP-style representation.

  pw_validate  
pw_validate ( reference,  attempt )

Validate the provided password string, which uses LDAP-style encoding notation. Reference is the correct password, attempt is clear text password attempt.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/DTML.py.html0100600000176200017510000000636707306455542025267 0ustar dhellmanndevel Module: DTML

Table of Contents

Module: DTML Zope-2-CVS-src/lib/python/AccessControl/DTML.py

Add security system support to Document Templates

$Id: DTML.py,v 1.4 2001/05/23 14:42:04 andreas Exp $

Imported modules   
from DocumentTemplate import DT_Util
import DocumentTemplate.sequence
import SecurityManagement
import math
import random
import string
import whrandom
Classes   
DTMLSecurityAPI

API for performing security checks in DTML using _ methods.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/DTML_DTMLSecurityAPI.py.html0100600000176200017510000001503007306455542030154 0ustar dhellmanndevel Class: DTMLSecurityAPI

Table of Contents

Class: DTMLSecurityAPI Zope-2-CVS-src/lib/python/AccessControl/DTML.py

API for performing security checks in DTML using _ methods.

Methods   
SecurityCalledByExecutable
SecurityCheckPermission
SecurityGetUser
SecurityValidate
SecurityValidateValue
  SecurityCalledByExecutable  
SecurityCalledByExecutable ( md )

Return a boolean value indicating if this context was called by an executable

  SecurityCheckPermission  
SecurityCheckPermission (
        md,
        permission,
        object,
        )

Check whether the security context allows the given permission on the given object.

Arguments:

permission

A permission name

object

The object being accessed according to the permission

  SecurityGetUser  
SecurityGetUser ( md )

Gen the current authenticated user

  SecurityValidate  
SecurityValidate (
        md,
        inst,
        parent,
        name,
        value,
        )

Validate access.

Arguments:

accessed

the object that was being accessed

container

the object the value was found in

name

The name used to access the value

value

The value retrieved though the access.

The arguments may be provided as keyword arguments. Some of these arguments may be ommitted, however, the policy may reject access in some cases when arguments are ommitted. It is best to provide all the values possible.

  SecurityValidateValue  
SecurityValidateValue ( md,  value )

Convenience for common case of simple value validation.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/IUserFolder.py.html0100600000176200017510000000402507306455542026677 0ustar dhellmanndevel Module: IUserFolder

Table of Contents

Module: IUserFolder Zope-2-CVS-src/lib/python/AccessControl/IUserFolder.py

Classes   
IStandardUserFolder

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/IUserFolder_IStandardUserFolder.py.html0100600000176200017510000001007207306455542032622 0ustar dhellmanndevel Class: IStandardUserFolder

Table of Contents

Class: IStandardUserFolder Zope-2-CVS-src/lib/python/AccessControl/IUserFolder.py

Methods   
getUser
getUserNames
getUsers
  getUser  
getUser ( self,  name )

Returns the user object specified by name. If there is no user named name in the user folder, return None.

  getUserNames  
getUserNames ( self )

Returns a sequence of names of the users which reside in the user folder.

  getUsers  
getUsers ( self )

Returns a sequence of all user objects which reside in the user folder.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/Owned.py.html0100600000176200017510000001272007306455542025571 0ustar dhellmanndevel Module: Owned

Table of Contents

Module: Owned Zope-2-CVS-src/lib/python/AccessControl/Owned.py

Imported modules   
from AccessControl import getSecurityManager, Unauthorized
from Acquisition import aq_get, aq_parent, aq_base
import ExtensionClass
import Globals
import SpecialUsers
import string
import urlparse
Functions   
ownableFilter
ownerInfo
  ownableFilter  
ownableFilter (
        self,
        aq_get=aq_get,
        UnownableOwner=UnownableOwner,
        )

  ownerInfo  
ownerInfo (
        user,
        getattr=getattr,
        type=type,
        st=type( '' ),
        None=None,
        )

Classes   
EditUnowned

Can't edit unowned executables

EmergencyUserCannotOwn

The emergency user cannot own anything

Owned

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/Owned_EditUnowned.py.html0100600000176200017510000000364107306455542030100 0ustar dhellmanndevel Class: EditUnowned

Table of Contents

Class: EditUnowned Zope-2-CVS-src/lib/python/AccessControl/Owned.py

Can't edit unowned executables

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/Owned_EmergencyUserCannotOwn.py.html0100600000176200017510000000367707306455542032270 0ustar dhellmanndevel Class: EmergencyUserCannotOwn

Table of Contents

Class: EmergencyUserCannotOwn Zope-2-CVS-src/lib/python/AccessControl/Owned.py

The emergency user cannot own anything

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/Owned_Owned.py.html0100600000176200017510000002463507306455542026735 0ustar dhellmanndevel Class: Owned

Table of Contents

Class: Owned Zope-2-CVS-src/lib/python/AccessControl/Owned.py

Base Classes   
ExtensionClass.Base
Methods   
_deleteOwnershipAfterAdd
changeOwnership
getOwner
manage_changeOwnershipType
manage_fixupOwnershipAfterAdd
manage_takeOwnership
owner_info
userCanTakeOwnership
  _deleteOwnershipAfterAdd  
_deleteOwnershipAfterAdd ( self )

  changeOwnership  
changeOwnership (
        self,
        user,
        recursive=0,
        aq_get=aq_get,
        None=None,
        )

Change the ownership to the given user. If recursive is true then also take ownership of all sub-objects, otherwise sub-objects retain their ownership information.

  getOwner  
getOwner (
        self,
        info=0,
        aq_get=aq_get,
        None=None,
        UnownableOwner=UnownableOwner,
        )

Get the owner

If a true argument is provided, then only the owner path and id are returned. Otherwise, the owner object is returned.

  manage_changeOwnershipType  
manage_changeOwnershipType (
        self,
        explicit=1,
        RESPONSE=None,
        REQUEST=None,
        )

Change the type (implicit or explicit) of ownership.

  manage_fixupOwnershipAfterAdd  
manage_fixupOwnershipAfterAdd ( self )

Exceptions   
EmergencyUserCannotOwn, ( "Objects cannot be owned by the emergency user" )
  manage_takeOwnership  
manage_takeOwnership (
        self,
        REQUEST,
        RESPONSE,
        recursive=0,
        )

Take ownership (responsibility) for an object. If recursive is true, then also take ownership of all sub-objects.

Exceptions   
Unauthorized, ( 'manage_takeOwnership was called from an invalid context' )
  owner_info  
owner_info ( self )

Get ownership info for display

  userCanTakeOwnership  
userCanTakeOwnership ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/Permission.py.html0100600000176200017510000001151307306455542026644 0ustar dhellmanndevel Module: Permission

Table of Contents

Module: Permission Zope-2-CVS-src/lib/python/AccessControl/Permission.py

Imported modules   
import Globals
import Products
import string
Functions   
pname
registerPermissions
  pname  
pname (
        name,
        translate=string.translate,
        name_trans=name_trans,
        )

  registerPermissions  
registerPermissions ( permissions,  defaultDefault=( 'Manager', ) )

Register an __ac_permissions__ sequence.

Classes   
Permission

A Permission maps a named logical permission to a set

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/Permission_Permission.py.html0100600000176200017510000001423707306455542031062 0ustar dhellmanndevel Class: Permission

Table of Contents

Class: Permission Zope-2-CVS-src/lib/python/AccessControl/Permission.py

A Permission maps a named logical permission to a set of attribute names. Attribute names which appear in a permission may not appear in any other permission defined by the object.

Methods   
__init__
__len__
__str__
getRoles
setRole
setRoles
  __init__  
__init__ (
        self,
        name,
        data,
        obj,
        default=None,
        )

  __len__  
__len__ ( self )

  __str__  
__str__ ( self )

  getRoles  
getRoles ( self,  default=_marker )

  setRole  
setRole (
        self,
        role,
        present,
        )

  setRoles  
setRoles ( self,  roles )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/PermissionMapping.py.html0100600000176200017510000001426707306455542030171 0ustar dhellmanndevel Module: PermissionMapping

Table of Contents

Module: PermissionMapping Zope-2-CVS-src/lib/python/AccessControl/PermissionMapping.py

Permission Mapping

Sometimes, we need an object's permissions to be remapped to other permissions when the object is used in specual ways. This is rather hard, since we need the object's ordinary permissions intact so we can manage it.

Imported modules   
import Acquisition
import ExtensionClass
from Globals import InitializeClass
from Owned import UnownableOwner
from Permission import pname
Functions   
aqwrap
getPermissionMapping
setPermissionMapping
  aqwrap  
aqwrap (
        object,
        wrapper,
        parent,
        )

  getPermissionMapping  
getPermissionMapping (
        name,
        obj,
        st=type( '' ),
        )

  setPermissionMapping  
setPermissionMapping (
        name,
        obj,
        v,
        )

Classes   
PM
Rewrapper
RoleManager

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/PermissionMapping_PM.py.html0100600000176200017510000000747107306455542030564 0ustar dhellmanndevel Class: PM

Table of Contents

Class: PM Zope-2-CVS-src/lib/python/AccessControl/PermissionMapping.py

Base Classes   
ExtensionClass.Base
Methods   
__getattr__
  __getattr__  
__getattr__ ( self,  name )

Exceptions   
AttributeError, name

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/PermissionMapping_Rewrapper.py.html0100600000176200017510000001110707306455542032206 0ustar dhellmanndevel Class: Rewrapper

Table of Contents

Class: Rewrapper Zope-2-CVS-src/lib/python/AccessControl/PermissionMapping.py

Base Classes   
ExtensionClass.Base
Methods   
__call__
__getattr__
__of__
  __call__  
__call__ (
        self,
        *args,
        *kw,
        )

  __getattr__  
__getattr__ ( self,  name )

  __of__  
__of__ ( self,  parent )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/PermissionMapping_RoleManager.py.html0100600000176200017510000001427607306455542032445 0ustar dhellmanndevel Class: RoleManager

Table of Contents

Class: RoleManager Zope-2-CVS-src/lib/python/AccessControl/PermissionMapping.py

Methods   
_isBeingAccessedAsZClassDefinedInstanceMethod
_isBeingUsedAsAMethod
manage_getPermissionMapping
manage_setPermissionMapping
  _isBeingAccessedAsZClassDefinedInstanceMethod  
_isBeingAccessedAsZClassDefinedInstanceMethod ( self )

  _isBeingUsedAsAMethod  
_isBeingUsedAsAMethod (
        self,
        REQUEST=None,
        wannaBe=0,
        )

  manage_getPermissionMapping  
manage_getPermissionMapping ( self )

Return the permission mapping for the object

This is a list of dictionaries with:

permission_name

The name of the native object permission

class_permission

The class permission the permission is mapped to.

  manage_setPermissionMapping  
manage_setPermissionMapping (
        self,
        permission_names=[],
        class_permissions=[],
        REQUEST=None,
        )

Change the permission mapping

Exceptions   
'Permission mapping error', ( """Attempted to map a permission to a permission, %s, that is not valid. This should never happen. (Waaa). """ % p )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/PermissionRole.py.html0100600000176200017510000001210407306455542027463 0ustar dhellmanndevel Module: PermissionRole

Table of Contents

Module: PermissionRole Zope-2-CVS-src/lib/python/AccessControl/PermissionRole.py

Imported modules   
from ExtensionClass import Base
import string
import sys
Functions   
main
rolesForPermissionOn
  main  
main ()

The "main" program for this module

  rolesForPermissionOn  
rolesForPermissionOn (
        perm,
        object,
        default=( 'Manager', ),
        )

Return the roles that have the given permission on the given object

Classes   
PermissionRole

Implement permission-based roles.

imPermissionRole

Implement permission-based roles

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/PermissionRole_PermissionRole.py.html0100600000176200017510000001031507306455542032517 0ustar dhellmanndevel Class: PermissionRole

Table of Contents

Class: PermissionRole Zope-2-CVS-src/lib/python/AccessControl/PermissionRole.py

Implement permission-based roles.

Under normal circumstances, our __of__ method will be called with an unwrapped object. The result will then be called with a wrapped object, if the original object was wrapped. To deal with this, we have to create an intermediate object.

Base Classes   
Base
Methods   
__init__
__of__
  __init__  
__init__ (
        self,
        name,
        default=( 'Manager', ),
        )

  __of__  
__of__ (
        self,
        parent,
        None=None,
        getattr=getattr,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/PermissionRole_imPermissionRole.py.html0100600000176200017510000001125307306455542033047 0ustar dhellmanndevel Class: imPermissionRole

Table of Contents

Class: imPermissionRole Zope-2-CVS-src/lib/python/AccessControl/PermissionRole.py

Implement permission-based roles

Base Classes   
Base
Methods   
__getitem__
__len__
__of__
  __getitem__  
__getitem__ ( self,  i )

The following methods are needed in the unlikely case that an unwrapped object is accessed:

  __len__  
__len__ ( self )

  __of__  
__of__ (
        self,
        parent,
        tt=type(() ),
        st=type( '' ),
        getattr=getattr,
        None=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/Permissions.py.html0100600000176200017510000000246007306455542027030 0ustar dhellmanndevel Module: Permissions

Table of Contents

Module: Permissions Zope-2-CVS-src/lib/python/AccessControl/Permissions.py

Constant definitions for built-in Zope permissions

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/Role.py.html0100600000176200017510000002430207306455542025415 0ustar dhellmanndevel Module: Role

Table of Contents

Module: Role Zope-2-CVS-src/lib/python/AccessControl/Role.py

Access control support

Imported modules   
from Acquisition import Implicit, Acquired, aq_get
from App.Common import aq_base
import ExtensionClass
import Globals
from Globals import DTMLFile, MessageDialog, Dictionary
from Permission import Permission
import PermissionMapping
import Products
from string import join, strip, split, find
Functions   
_isBeingUsedAsAMethod
_isNotBeingUsedAsAMethod
class_attrs
class_dict
classattr
gather_permissions
instance_attrs
instance_dict
reqattr
  _isBeingUsedAsAMethod  
_isBeingUsedAsAMethod ( self )

  _isNotBeingUsedAsAMethod  
_isNotBeingUsedAsAMethod ( self )

  class_attrs  
class_attrs (
        inst,
        _class=None,
        data=None,
        )

  class_dict  
class_dict ( _class )

  classattr  
classattr ( cls,  attr )

  gather_permissions  
gather_permissions (
        klass,
        result,
        seen,
        )

  instance_attrs  
instance_attrs ( inst )

  instance_dict  
instance_dict ( inst )

  reqattr  
reqattr ( request,  attr )

Classes   
RoleManager

An obect that has configurable permissions

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/Role_RoleManager.py.html0100600000176200017510000007020007306455542027667 0ustar dhellmanndevel Class: RoleManager

Table of Contents

Class: RoleManager Zope-2-CVS-src/lib/python/AccessControl/Role.py

An obect that has configurable permissions

Base Classes   
ExtensionClass.Base
PermissionMapping.RoleManager
Methods   
_addRole
_delRoles
_has_user_defined_role
_setRoles
ac_inherited_permissions
access_debug_info
acquiredRolesAreUsedBy
get_local_roles
get_local_roles_for_userid
get_valid_userids
 has_local_roles
manage_access
manage_acquiredPermissions
manage_addLocalRoles
manage_changePermissions
manage_defined_roles
manage_delLocalRoles
manage_editRoles
manage_permission
manage_role
 manage_setLocalRoles
permission_settings
permissionsOfRole
possible_permissions
rolesOfPermission
userdefined_roles
users_with_local_role
valid_roles
validate_roles
  _addRole  
_addRole (
        self,
        role,
        REQUEST=None,
        )

  _delRoles  
_delRoles (
        self,
        roles,
        REQUEST,
        )

  _has_user_defined_role  
_has_user_defined_role ( self,  role )

  _setRoles  
_setRoles (
        self,
        acl_type,
        acl_roles,
        )

  ac_inherited_permissions  
ac_inherited_permissions ( self,  all=0 )

  access_debug_info  
access_debug_info ( self )

Return debug info

  acquiredRolesAreUsedBy  
acquiredRolesAreUsedBy ( self,  permission )

used by management screen

Exceptions   
'Invalid Permission', ( "The permission %s is invalid." % permission )
  get_local_roles  
get_local_roles ( self )

  get_local_roles_for_userid  
get_local_roles_for_userid ( self,  userid )

  get_valid_userids  
get_valid_userids ( self )

  has_local_roles  
has_local_roles ( self )

  manage_access  
manage_access (
        self,
        REQUEST,
        **kw,
        )

Return an interface for making permissions settings

  manage_acquiredPermissions  
manage_acquiredPermissions (
        self,
        permissions=[],
        REQUEST=None,
        )

Change the permissions that acquire

  manage_addLocalRoles  
manage_addLocalRoles (
        self,
        userid,
        roles,
        REQUEST=None,
        )

Set local roles for a user.

Exceptions   
ValueError, 'One or more roles must be given!'
  manage_changePermissions  
manage_changePermissions ( self,  REQUEST )

Change all permissions settings, called by management screen

  manage_defined_roles  
manage_defined_roles (
        self,
        submit=None,
        REQUEST=None,
        )

Called by management screen.

  manage_delLocalRoles  
manage_delLocalRoles (
        self,
        userids,
        REQUEST=None,
        )

Remove all local roles for a user.

  manage_editRoles  
manage_editRoles (
        self,
        REQUEST,
        acl_type='A',
        acl_roles=[],
        )

  manage_permission  
manage_permission (
        self,
        permission_to_manage,
        roles=[],
        acquire=0,
        REQUEST=None,
        )

Change the settings for the given permission

If optional arg acquire is true, then the roles for the permission are acquired, in addition to the ones specified, otherwise the permissions are restricted to only the designated roles.

Exceptions   
'Invalid Permission', ( "The permission %s is invalid." % permission_to_manage )
  manage_role  
manage_role (
        self,
        role_to_manage,
        permissions=[],
        REQUEST=None,
        )

Change the permissions given to the given role

  manage_setLocalRoles  
manage_setLocalRoles (
        self,
        userid,
        roles,
        REQUEST=None,
        )

Set local roles for a user.

Exceptions   
ValueError, 'One or more roles must be given!'
  permission_settings  
permission_settings ( self )

Return user-role permission settings

  permissionsOfRole  
permissionsOfRole ( self,  role )

used by management screen

  possible_permissions  
possible_permissions ( self )

  rolesOfPermission  
rolesOfPermission ( self,  permission )

used by management screen

Exceptions   
'Invalid Permission', ( "The permission %s is invalid." % permission )
  userdefined_roles  
userdefined_roles ( self )

Return list of user-defined roles

  users_with_local_role  
users_with_local_role ( self,  role )

  valid_roles  
valid_roles ( self )

Return list of valid roles

  validate_roles  
validate_roles ( self,  roles )

Return true if all given roles are valid

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/SecurityInfo.py.html0100600000176200017510000001326207306455542027142 0ustar dhellmanndevel Module: SecurityInfo

Table of Contents

Module: SecurityInfo Zope-2-CVS-src/lib/python/AccessControl/SecurityInfo.py

SecurityInfo objects and access control constants.

SecurityInfo objects are used in class definitions to allow a declarative style of associating access control information with class attributes.

More information on using SecurityInfo and guide to Zope security for developers can be found in the dev.zope.org "Declarative Security" project:

http://dev.zope.org/Wikis/DevSite/Projects/DeclarativeSecurity

While SecurityInfo objects largely remove the need for Python programmers to care about the underlying implementation, there are several constants defined that should be used by code that must set __roles__ attributes directly. (the constants are also accessible from the AccessControl namespace). The defined access control constants and their meanings are:

ACCESS_PUBLIC: accessible from restricted code and possibly through the web (if object has a docstring)

ACCESS_PRIVATE: accessible only from python code

ACCESS_NONE: no access

Imported modules   
import Acquisition
import PermissionRole
from string import lower
import sys
from zLOG import LOG, WARNING
Functions   
secureModule
  secureModule  
secureModule ( mname,  *imp )

Classes   
ClassSecurityInfo

Encapsulate security information for class objects.

ModuleSecurityInfo

Encapsulate security information for modules.

SecurityInfo

Encapsulate security information.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/SecurityInfo_ClassSecurityInfo.py.html0100600000176200017510000000641307306455542032633 0ustar dhellmanndevel Class: ClassSecurityInfo

Table of Contents

Class: ClassSecurityInfo Zope-2-CVS-src/lib/python/AccessControl/SecurityInfo.py

Encapsulate security information for class objects.

Base Classes   
SecurityInfo
    Acquisition.Implicit
Methods   
apply
  apply  
apply ( self,  classobj )

Apply security information to the given class object.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/SecurityInfo_ModuleSecurityInfo.py.html0100600000176200017510000001576507306455542033025 0ustar dhellmanndevel Class: ModuleSecurityInfo

Table of Contents

Class: ModuleSecurityInfo Zope-2-CVS-src/lib/python/AccessControl/SecurityInfo.py

Encapsulate security information for modules.

Base Classes   
SecurityInfo
    Acquisition.Implicit
Methods   
__call__
__init__
apply
declareObjectProtected
declareProtected
setDefaultRoles
  __call__  
__call__ (
        self,
        name,
        value,
        )

Callback for __allow_access_to_unprotected_subobjects__ hook.

  __init__  
__init__ ( self,  module_name=None )

  apply  
apply ( self,  dict )

Apply security information to the given module dict.

  declareObjectProtected  
declareObjectProtected ( self,  permission_name )

Cannot declare module protected.

  declareProtected  
declareProtected (
        self,
        permission_name,
        *names,
        )

Cannot declare module names protected.

  setDefaultRoles  
setDefaultRoles (
        self,
        permission_name,
        roles,
        )

Cannot set default roles for permissions in a module.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/SecurityInfo_SecurityInfo.py.html0100600000176200017510000002561107306455542031646 0ustar dhellmanndevel Class: SecurityInfo

Table of Contents

Class: SecurityInfo Zope-2-CVS-src/lib/python/AccessControl/SecurityInfo.py

Encapsulate security information.

Base Classes   
Acquisition.Implicit
Methods   
__init__
_setaccess
declareObjectPrivate
declareObjectProtected
declareObjectPublic
declarePrivate
declareProtected
declarePublic
setDefaultAccess
setPermissionDefault
  __init__  
__init__ ( self )

  _setaccess  
_setaccess (
        self,
        names,
        access,
        )

  declareObjectPrivate  
declareObjectPrivate ( self )

Declare the object to be inaccessible to restricted code.

  declareObjectProtected  
declareObjectProtected ( self,  permission_name )

Declare the object to be associated with a permission.

  declareObjectPublic  
declareObjectPublic ( self )

Declare the object to be publicly accessible.

  declarePrivate  
declarePrivate ( self,  *names )

Declare names to be inaccessible to restricted code.

  declareProtected  
declareProtected (
        self,
        permission_name,
        *names,
        )

Declare names to be associated with a permission.

  declarePublic  
declarePublic ( self,  *names )

Declare names to be publicly accessible.

  setDefaultAccess  
setDefaultAccess ( self,  access )

Declare default attribute access policy.

This should be a boolean value, a map of attribute names to booleans, or a callable (name, value) -> boolean.

Exceptions   
ValueError, "'allow' or 'deny' expected"
  setPermissionDefault  
setPermissionDefault (
        self,
        permission_name,
        roles,
        )

Declare default roles for a permission

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/SecurityManagement.py.html0100600000176200017510000001476207306455542030331 0ustar dhellmanndevel Module: SecurityManagement

Table of Contents

Module: SecurityManagement Zope-2-CVS-src/lib/python/AccessControl/SecurityManagement.py

Imported modules   
from SecurityManager import SecurityManager
import SpecialUsers
Functions   
getSecurityManager
newSecurityManager
noSecurityManager
setSecurityPolicy
  getSecurityManager  
getSecurityManager ()

Get a security manager, for the current thread.

  newSecurityManager  
newSecurityManager ( request,  user )

Set up a new security context for a request for a user

  noSecurityManager  
noSecurityManager ()

  setSecurityPolicy  
setSecurityPolicy ( aSecurityPolicy )

Set the system default security policy.

This method should only be caused by system startup code. It should never, for example, be called during a web request.

Classes   
SecurityContext

The security context is an object used internally to the security

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/SecurityManagement_SecurityContext.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/SecurityManagement_SecurityContext.py.ht0100600000176200017510000000516707306455542033233 0ustar dhellmanndevel Class: SecurityContext

Table of Contents

Class: SecurityContext Zope-2-CVS-src/lib/python/AccessControl/SecurityManagement.py

The security context is an object used internally to the security machinery. It captures data about the current security context.

Methods   
__init__
  __init__  
__init__ ( self,  user )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/SecurityManager.py.html0100600000176200017510000001052307306455542027616 0ustar dhellmanndevel Module: SecurityManager

Table of Contents

Module: SecurityManager Zope-2-CVS-src/lib/python/AccessControl/SecurityManager.py

Imported modules   
import ZopeSecurityPolicy
import os
import string
Functions   
setSecurityPolicy
  setSecurityPolicy  
setSecurityPolicy ( aSecurityPolicy )

Set the system default security policy.

This method should only be caused by system startup code. It should never, for example, be called during a web request.

Classes   
SecurityManager

A security manager provides methods for checking access and managing

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/SecurityManager_SecurityManager.py.html0100600000176200017510000002314207306455542033001 0ustar dhellmanndevel Class: SecurityManager

Table of Contents

Class: SecurityManager Zope-2-CVS-src/lib/python/AccessControl/SecurityManager.py

A security manager provides methods for checking access and managing executable context and policies

Methods   
__init__
addContext
calledByExecutable
checkPermission
getUser
removeContext
validate
validateValue
  __init__  
__init__ (
        self,
        thread_id,
        context,
        )

  addContext  
addContext (
        self,
        anExecutableObject,
        getattr=getattr,
        )

Add an ExecutableObject to the current security context. Optionally, add a new SecurityPolicy as well.

Exceptions   
SystemError, 'Excessive recursion'
  calledByExecutable  
calledByExecutable ( self )

Return a boolean value indicating if this context was called by an executable

  checkPermission  
checkPermission (
        self,
        permission,
        object,
        )

Check whether the security context allows the given permission on the given object.

Arguments:

permission

A permission name

object

The object being accessed according to the permission

  getUser  
getUser ( self )

Gen the current authenticated user

  removeContext  
removeContext (
        self,
        anExecutableObject,
        getattr=getattr,
        )

Remove an ExecutableObject, and optionally, a SecurityPolicy, from the current security context.

  validate  
validate (
        self,
        accessed=None,
        container=None,
        name=None,
        value=None,
        roles=_noroles,
        )

Validate access.

Arguments:

accessed

the object that was being accessed

container

the object the value was found in

name

The name used to access the value

value

The value retrieved though the access.

roles

The roles of the object if already known.

The arguments may be provided as keyword arguments. Some of these arguments may be ommitted, however, the policy may reject access in some cases when arguments are ommitted. It is best to provide all the values possible.

  validateValue  
validateValue (
        self,
        value,
        roles=_noroles,
        )

Convenience for common case of simple value validation.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/SimpleObjectPolicies.py.html0100600000176200017510000000530607306455542030567 0ustar dhellmanndevel Module: SimpleObjectPolicies

Table of Contents

Module: SimpleObjectPolicies Zope-2-CVS-src/lib/python/AccessControl/SimpleObjectPolicies.py

Imported modules   
from DocumentTemplate.DT_Util import TemplateDict
import Record
Classes   
_dummy_class

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/SimpleObjectPolicies__dummy_class.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/SimpleObjectPolicies__dummy_class.py.htm0100600000176200017510000000245707306455542033156 0ustar dhellmanndevel Class: _dummy_class

Table of Contents

Class: _dummy_class Zope-2-CVS-src/lib/python/AccessControl/SimpleObjectPolicies.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/SpecialUsers.py.html0100600000176200017510000000245107306455542027117 0ustar dhellmanndevel Module: SpecialUsers

Table of Contents

Module: SpecialUsers Zope-2-CVS-src/lib/python/AccessControl/SpecialUsers.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/User.py.html0100600000176200017510000002446507306455543025445 0ustar dhellmanndevel Module: User

Table of Contents

Module: User Zope-2-CVS-src/lib/python/AccessControl/User.py

Access control package

Imported modules   
from AccessControl import getSecurityManager, Unauthorized
from AccessControl.SecurityManagement import newSecurityManager, noSecurityManager
from AccessControl.ZopeSecurityPolicy import _noroles
from Acquisition import Implicit
from App.ImageFile import ImageFile
from App.Management import Navigation, Tabs
from AuthEncoding import pw_validate
import Globals
from Globals import DTMLFile, MessageDialog, Persistent, PersistentMapping
from OFS.SimpleItem import Item
from PermissionRole import _what_not_even_god_should_do, rolesForPermissionOn
from Role import RoleManager
import SpecialUsers
from base64 import decodestring
import os
import re
import socket
from string import join, strip, split, lower, upper
Functions   
absattr
domainSpecMatch
manage_addUserFolder
readUserAccessFile
reqattr
rolejoin
  absattr  
absattr ( attr )

  domainSpecMatch  
domainSpecMatch ( spec,  request )

  manage_addUserFolder  
manage_addUserFolder (
        self,
        dtself=None,
        REQUEST=None,
        **ignored,
        )

  readUserAccessFile  
readUserAccessFile ( filename )

Reads an access file from INSTANCE_HOME. Returns name, password, domains, remote_user_mode.

  reqattr  
reqattr ( request,  attr )

  rolejoin  
rolejoin ( roles,  other )

Classes   
BasicUser

Base class for all User objects

BasicUserFolder

Base class for UserFolder-like objects

NullUnrestrictedUser

User created if no emergency user exists. It is only around to

SimpleUser

A very simple user implementation

SpecialUser

Class for special users, like emergency user and nobody

UnrestrictedUser

User that passes all security checks. Note, however, that modules

User

Standard User object

UserFolder

Standard UserFolder object

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/User_BasicUser.py.html0100600000176200017510000004434007306455542027376 0ustar dhellmanndevel Class: BasicUser

Table of Contents

Class: BasicUser Zope-2-CVS-src/lib/python/AccessControl/User.py

Base class for all User objects

Base Classes   
Implicit
Methods   
__allow_access_to_unprotected_subobjects__
__init__
__len__
__str__
_check_context
_getPassword
_shared_roles
allowed
authenticate
getDomains
 getId
getRoles
getRolesInContext
getUserName
has_permission
has_role
  __allow_access_to_unprotected_subobjects__  
__allow_access_to_unprotected_subobjects__ (
        self,
        name,
        value=None,
        )

Maybe allow access to unprotected attributes. Note that this is temporary to avoid exposing information but without breaking everyone's current code. In the future the security will be clamped down and permission-protected here. Because there are a fair number of user object types out there, this method denies access to names that are private parts of the standard User interface or implementation only. The other approach (only allowing access to public names in the User interface) would probably break a lot of other User implementations with extended functionality that we cant anticipate from the base scaffolding.

  __init__  
__init__ (
        self,
        name,
        password,
        roles,
        domains,
        )

Exceptions   
NotImplemented
  __len__  
__len__ ( self )

  __str__  
__str__ ( self )

  _check_context  
_check_context ( self,  object )

  _getPassword  
_getPassword ( self )

Return the password of the user.

Exceptions   
NotImplemented
  _shared_roles  
_shared_roles ( self,  parent )

  allowed  
allowed (
        self,
        object,
        object_roles=None,
        )

Check whether the user has access to object. The user must have one of the roles in object_roles to allow access.

  authenticate  
authenticate (
        self,
        password,
        request,
        )

  getDomains  
getDomains ( self )

Return the list of domain restrictions for a user

Exceptions   
NotImplemented
  getId  
getId ( self )

Get the ID of the user. The ID can be used, at least from Python, to get the user from the user's UserDatabase

  getRoles  
getRoles ( self )

Return the list of roles assigned to a user.

Exceptions   
NotImplemented
  getRolesInContext  
getRolesInContext ( self,  object )

Return the list of roles assigned to the user, including local roles assigned in context of the passed in object.

  getUserName  
getUserName ( self )

Return the username of a user

Exceptions   
NotImplemented
  has_permission  
has_permission (
        self,
        permission,
        object,
        )

Check to see if a user has a given permission on an object.

  has_role  
has_role (
        self,
        roles,
        object=None,
        )

Check to see if a user has a given role or roles.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/User_BasicUserFolder.py.html0100600000176200017510000006640707306455543030543 0ustar dhellmanndevel Class: BasicUserFolder

Table of Contents

Class: BasicUserFolder Zope-2-CVS-src/lib/python/AccessControl/User.py

Base class for UserFolder-like objects

Base Classes   
Implicit
Persistent
Navigation
Tabs
RoleManager
Item
Methods   
__creatable_by_emergency_user__
__len__
_addUser
_changeUser
_delUsers
_doAddUser
_doChangeUser
_doDelUsers
_getobcontext
_isTop
 _setId
authenticate
authorize
domainSpecValidate
getUser
getUserById
getUserNames
getUsers
identify
manage_afterAdd
 manage_beforeDelete
manage_users
setDomainAuthenticationMode
user_names
validate
  __creatable_by_emergency_user__  
__creatable_by_emergency_user__ ( self )

  __len__  
__len__ ( self )

  _addUser  
_addUser (
        self,
        name,
        password,
        confirm,
        roles,
        domains,
        REQUEST=None,
        )

  _changeUser  
_changeUser (
        self,
        name,
        password,
        confirm,
        roles,
        domains,
        REQUEST=None,
        )

  _delUsers  
_delUsers (
        self,
        names,
        REQUEST=None,
        )

  _doAddUser  
_doAddUser (
        self,
        name,
        password,
        roles,
        domains,
        )

Create a new user

Exceptions   
NotImplemented
  _doChangeUser  
_doChangeUser (
        self,
        name,
        password,
        roles,
        domains,
        )

Modify an existing user

Exceptions   
NotImplemented
  _doDelUsers  
_doDelUsers ( self,  names )

Delete one or more users

Exceptions   
NotImplemented
  _getobcontext  
_getobcontext (
        self,
        v,
        request,
        )

v is the object (value) we're validating access to n is the name used to access the object a is the object the object was accessed through c is the physical container of the object

  _isTop  
_isTop ( self )

  _setId  
_setId ( self,  id )

Exceptions   
Globals.MessageDialog( title = 'Invalid Id', message = 'Cannot change the id of a UserFolder', action = './manage_main', )
  authenticate  
authenticate (
        self,
        name,
        password,
        request,
        )

  authorize  
authorize (
        self,
        user,
        accessed,
        container,
        name,
        value,
        roles,
        )

  domainSpecValidate  
domainSpecValidate ( self,  spec )

  getUser  
getUser ( self,  name )

Return the named user object or None

Exceptions   
NotImplemented
  getUserById  
getUserById (
        self,
        id,
        default=_marker,
        )

Return the user corresponding to the given id.

  getUserNames  
getUserNames ( self )

Return a list of usernames

Exceptions   
NotImplemented
  getUsers  
getUsers ( self )

Return a list of user objects

Exceptions   
NotImplemented
  identify  
identify ( self,  auth )

Exceptions   
'Bad Request', 'Invalid authentication token'
  manage_afterAdd  
manage_afterAdd (
        self,
        item,
        container,
        )

  manage_beforeDelete  
manage_beforeDelete (
        self,
        item,
        container,
        )

  manage_users  
manage_users (
        self,
        submit=None,
        REQUEST=None,
        RESPONSE=None,
        )

  setDomainAuthenticationMode  
setDomainAuthenticationMode ( self,  domain_auth_mode )

Set the domain-based authentication mode. By default, this mode is off due to the high overhead of the operation that is incurred for all anonymous accesses. If you have the Manage Users permission, you can call this method via the web, passing a boolean value for domain_auth_mode to turn this behavior on or off.

  user_names  
user_names ( self )

  validate  
validate (
        self,
        request,
        auth='',
        roles=_noroles,
        )

this method performs identification, authentication, and authorization v is the object (value) we're validating access to n is the name used to access the object a is the object the object was accessed through c is the physical container of the object

We allow the publishing machinery to defer to higher-level user folders or to raise an unauthorized by returning None from this method.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/User_NullUnrestrictedUser.py.html0100600000176200017510000002150207306455543031657 0ustar dhellmanndevel Class: NullUnrestrictedUser

Table of Contents

Class: NullUnrestrictedUser Zope-2-CVS-src/lib/python/AccessControl/User.py

User created if no emergency user exists. It is only around to satisfy third party userfolder implementations that may expect the emergency user to exist and to be able to call certain methods on it (in other words, backward compatibility).

Note that when no emergency user is installed, this object that exists in its place is more of an anti-superuser since you cannot login as this user and it has no priveleges at all.

Base Classes   
SpecialUser
Methods   
__init__
allowed
authenticate
getRoles
getRolesInContext
getUserName
has_permission
has_role
  __init__  
__init__ ( self )

  allowed  
allowed (
        self,
        parent,
        roles=None,
        )

  authenticate  
authenticate (
        self,
        password,
        request,
        )

  getRoles  
getRoles ( self )

  getRolesInContext  
getRolesInContext ( self,  object )

  getUserName  
getUserName ( self )

  has_permission  
has_permission (
        self,
        permission,
        object,
        )

  has_role  
has_role (
        self,
        roles,
        object=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/User_SimpleUser.py.html0100600000176200017510000001407607306455543027612 0ustar dhellmanndevel Class: SimpleUser

Table of Contents

Class: SimpleUser Zope-2-CVS-src/lib/python/AccessControl/User.py

A very simple user implementation

that doesn't make a database commitment

Base Classes   
BasicUser
    Implicit
Methods   
__init__
_getPassword
getDomains
getRoles
getUserName
  __init__  
__init__ (
        self,
        name,
        password,
        roles,
        domains,
        )

  _getPassword  
_getPassword ( self )

Return the password of the user.

  getDomains  
getDomains ( self )

Return the list of domain restrictions for a user

  getRoles  
getRoles ( self )

Return the list of roles assigned to a user.

  getUserName  
getUserName ( self )

Return the username of a user

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/User_SpecialUser.py.html0100600000176200017510000000641307306455543027735 0ustar dhellmanndevel Class: SpecialUser

Table of Contents

Class: SpecialUser Zope-2-CVS-src/lib/python/AccessControl/User.py

Class for special users, like emergency user and nobody

Base Classes   
SimpleUser
Methods   
getId
  getId  
getId ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/User_UnrestrictedUser.py.html0100600000176200017510000001170407306455543031027 0ustar dhellmanndevel Class: UnrestrictedUser

Table of Contents

Class: UnrestrictedUser Zope-2-CVS-src/lib/python/AccessControl/User.py

User that passes all security checks. Note, however, that modules like Owner.py can still impose restrictions.

Base Classes   
SpecialUser
Methods   
allowed
has_permission
has_role
  allowed  
allowed (
        self,
        parent,
        roles=None,
        )

  has_permission  
has_permission (
        self,
        permission,
        object,
        )

  has_role  
has_role (
        self,
        roles,
        object=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/User_User.py.html0100600000176200017510000000403007306455543026425 0ustar dhellmanndevel Class: User

Table of Contents

Class: User Zope-2-CVS-src/lib/python/AccessControl/User.py

Standard User object

Base Classes   
SimpleUser
Persistent

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/User_UserFolder.py.html0100600000176200017510000002150607306455543027570 0ustar dhellmanndevel Class: UserFolder

Table of Contents

Class: UserFolder Zope-2-CVS-src/lib/python/AccessControl/User.py

Standard UserFolder object

A UserFolder holds User objects which contain information about users including name, password domain, and roles. UserFolders function chiefly to control access by authenticating users and binding them to a collection of roles.

Base Classes   
BasicUserFolder
    Implicit
    Persistent
    Navigation
    Tabs
    RoleManager
    Item
Methods   
__init__
_createInitialUser
_doAddUser
_doChangeUser
_doDelUsers
getUser
getUserNames
getUsers
  __init__  
__init__ ( self )

  _createInitialUser  
_createInitialUser ( self )

If there are no users or only one user in this user folder, populates from the inituser file in INSTANCE_HOME. We have to do this even when there is already a user just in case the initial user ignored the setup messages. We don't do it for more than one user to avoid abuse of this mechanism. Called only by OFS.Application.initialize().

  _doAddUser  
_doAddUser (
        self,
        name,
        password,
        roles,
        domains,
        )

Create a new user

  _doChangeUser  
_doChangeUser (
        self,
        name,
        password,
        roles,
        domains,
        )

  _doDelUsers  
_doDelUsers ( self,  names )

  getUser  
getUser ( self,  name )

Return the named user object or None

  getUserNames  
getUserNames ( self )

Return a list of usernames

  getUsers  
getUsers ( self )

Return a list of user objects

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/ZopeGuards.py.html0100600000176200017510000003072007306455543026601 0ustar dhellmanndevel Module: ZopeGuards

Table of Contents

Module: ZopeGuards Zope-2-CVS-src/lib/python/AccessControl/ZopeGuards.py

Imported modules   
from RestrictedPython.Guards import safe_builtins, _full_read_guard, full_write_guard
from RestrictedPython.Utilities import utility_builtins
from SecurityInfo import secureModule
from SecurityManagement import getSecurityManager
import sys
Functions   
aq_validate
guarded_filter
guarded_getattr
guarded_getitem
guarded_hasattr
guarded_import
guarded_map
load_module
  aq_validate  
aq_validate (
        inst,
        obj,
        name,
        v,
        validate,
        )

  guarded_filter  
guarded_filter (
        f,
        seq,
        skip_unauthorized=0,
        )

Exceptions   
Unauthorized, 'unauthorized access to element'
  guarded_getattr  
guarded_getattr (
        inst,
        name,
        default=_marker,
        )

Exceptions   
AttributeError
Unauthorized, name
  guarded_getitem  
guarded_getitem ( object,  index )

Exceptions   
Unauthorized, 'unauthorized access to element %s' % ` i `
  guarded_hasattr  
guarded_hasattr ( object,  name )

  guarded_import  
guarded_import (
        mname,
        globals={},
        locals={},
        fromlist=None,
        )

Exceptions   
ImportError, 'import of "%s" is unauthorized' % mname
ImportError, ( '"from %s import *" is not allowed' % mname )
ImportError, ('import of "%s" from "%s" is unauthorized' %( name, mname ) )
Unauthorized
  guarded_map  
guarded_map ( f,  *seqs )

Exceptions   
TypeError, 'cannot map a string'
  load_module  
load_module (
        module,
        mname,
        mnameparts,
        validate,
        globals,
        locals,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/ZopeSecurityPolicy.py.html0100600000176200017510000001034207306455543030341 0ustar dhellmanndevel Module: ZopeSecurityPolicy

Table of Contents

Module: ZopeSecurityPolicy Zope-2-CVS-src/lib/python/AccessControl/ZopeSecurityPolicy.py

Imported modules   
from AccessControl import Unauthorized
from PermissionRole import _what_not_even_god_should_do, rolesForPermissionOn
import SimpleObjectPolicies
from zLOG import LOG, PROBLEM
Functions   
cleanupName
  cleanupName  
cleanupName ( name,  value )

Classes   
ZopeSecurityPolicy

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/ZopeSecurityPolicy_ZopeSecurityPolicy.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/ZopeSecurityPolicy_ZopeSecurityPolicy.py0100600000176200017510000001072207306455543033305 0ustar dhellmanndevel Class: ZopeSecurityPolicy

Table of Contents

Class: ZopeSecurityPolicy Zope-2-CVS-src/lib/python/AccessControl/ZopeSecurityPolicy.py

Methods   
checkPermission
validate
  checkPermission  
checkPermission (
        self,
        permission,
        object,
        context,
        )

  validate  
validate (
        self,
        accessed,
        container,
        name,
        value,
        context,
        roles=_noroles,
        None=None,
        type=type,
        IntType=type( 0 ),
        DictType=type({} ),
        getattr=getattr,
        _noroles=_noroles,
        StringType=type( '' ),
        Containers=SimpleObjectPolicies.Containers,
        valid_aq_=( 'aq_parent', 'aq_explicit' ),
        )

Exceptions   
Unauthorized, ('You are not authorized to access %s.' % cleanupName( name, value ) )
Unauthorized, cleanupName( name, value )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/__init__.py.html0100600000176200017510000000511007306455543026250 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/AccessControl/__init__.py

Imported modules   
import DTML
from SecurityInfo import ClassSecurityInfo, ModuleSecurityInfo, ACCESS_PRIVATE, ACCESS_PUBLIC, ACCESS_NONE, secureModule
from SecurityManagement import getSecurityManager, setSecurityPolicy
from ZopeGuards import full_read_guard, full_write_guard, safe_builtins

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/tests/0040700000176200017510000000000007306455543024342 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/tests/testSecurity.py.html0100600000176200017510000001465207306455543030375 0ustar dhellmanndevel Module: testSecurity

Table of Contents

Module: testSecurity Zope-2-CVS-src/lib/python/AccessControl/tests/testSecurity.py

Document Template Tests

Imported modules   
from AccessControl import User, Unauthorized
from DocumentTemplate import HTML
from DocumentTemplate.tests.testDTML import DTMLTests
from ExtensionClass import Base
from Products.PythonScripts.standard import DTML
import ZODB
import os
import sys
import unittest
Functions   
debug
main
pdebug
test_suite
  debug  
debug ()

  main  
main ()

  pdebug  
pdebug ()

  test_suite  
test_suite ()

Classes   
SecurityTests
UnownedDTML

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/tests/testSecurity_SecurityTests.py.html0100600000176200017510000001136107306455543033301 0ustar dhellmanndevel Class: SecurityTests

Table of Contents

Class: SecurityTests Zope-2-CVS-src/lib/python/AccessControl/tests/testSecurity.py

Base Classes   
DTMLTests
Methods   
checkExprExplicitDeny
checkNoImplicitAccess
checkSecurityInSyntax
  checkExprExplicitDeny  
checkExprExplicitDeny ( self )

  checkNoImplicitAccess  
checkNoImplicitAccess ( self )

  checkSecurityInSyntax  
checkSecurityInSyntax ( self )

Ensures syntax errors are thrown for an expr with restricted syntax.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/AccessControl/tests/testSecurity_UnownedDTML.py.html0100600000176200017510000000623107306455543032547 0ustar dhellmanndevel Class: UnownedDTML

Table of Contents

Class: UnownedDTML Zope-2-CVS-src/lib/python/AccessControl/tests/testSecurity.py

Base Classes   
DTML
Methods   
getOwner
  getOwner  
getOwner ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/0040700000176200017510000000000007306455544021157 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/index.html0100600000176200017510000001166207306455545023162 0ustar dhellmanndevel Zope2 CVS with ZEO: App

Table of Contents

Zope2 CVS with ZEO: App  
Modules and Packages   

Zope-2-CVS-src/lib/python/App/

ApplicationManager
CacheManager
Common

Commonly used utility functions.

DavLockManager
Dialogs

Common HTML dialog boxes

Extensions
Factory
FactoryDispatcher
FindHomes

Commonly used utility functions.

ImageFile

Image object that is stored in a file

Management

Standard management interface support

Permission
PersistentExtra
Product

Product objects

ProductContext

Objects providing context for product initialization

ProductRegistry
RefreshFuncs

Functions for refreshing products.

Undo
__init__
class_init
special_dtml
tar
version_txt

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/ApplicationManager.py.html0100600000176200017510000001144407306455543026234 0ustar dhellmanndevel Module: ApplicationManager

Table of Contents

Module: ApplicationManager Zope-2-CVS-src/lib/python/App/ApplicationManager.py

Imported modules   
from AccessControl import getSecurityManager
import Acquisition
from App.Dialogs import MessageDialog
from CacheManager import CacheManager
from DateTime.DateTime import DateTime
from DavLockManager import DavLockManager
import Globals
from Globals import DTMLFile
from OFS import SimpleItem
from OFS.Folder import Folder
from OFS.ObjectManager import ObjectManager
from Product import ProductFolder
from StringIO import StringIO
import Undo
import os
import string
import sys
import time
from version_txt import version_txt
import zLOG
Classes   
ApplicationManager

System management

DatabaseManager

Database management

DebugManager

Debug and profiling information

Fake
VersionManager

Version management

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/ApplicationManager_ApplicationManager.py.html0100600000176200017510000004126307306455543032054 0ustar dhellmanndevel Class: ApplicationManager

Table of Contents

Class: ApplicationManager Zope-2-CVS-src/lib/python/App/ApplicationManager.py

System management

Base Classes   
Folder
CacheManager
Methods   
__init__
_canCopy
_init
db_name
db_size
manage_app
manage_discardVersions
manage_pack
manage_saveVersions
manage_shutdown
 process_time
revert_points
sys_platform
sys_version
thread_get_ident
version_info
version_list
version_txt
  __init__  
__init__ ( self )

  _canCopy  
_canCopy ( self,  op=0 )

  _init  
_init ( self )

  db_name  
db_name ( self )

  db_size  
db_size ( self )

  manage_app  
manage_app ( self,  URL2 )

Return to the main management screen

Exceptions   
'Redirect', URL2 + '/manage'
  manage_discardVersions  
manage_discardVersions (
        self,
        versions,
        REQUEST=None,
        )

Discard some versions

  manage_pack  
manage_pack (
        self,
        days=0,
        REQUEST=None,
        )

Pack the database

  manage_saveVersions  
manage_saveVersions (
        self,
        versions,
        REQUEST=None,
        )

Commit some versions

  manage_shutdown  
manage_shutdown ( self )

Shut down the application

  process_time  
process_time ( self )

  revert_points  
revert_points ( self )

  sys_platform  
sys_platform ( self )

  sys_version  
sys_version ( self )

  thread_get_ident  
thread_get_ident ( self )

  version_info  
version_info ( self )

Exceptions   
'Zope database version error', """ Sorry, Version management is only supported if you use ZODB 3. """
  version_list  
version_list ( self )

  version_txt  
version_txt ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/ApplicationManager_DatabaseManager.py.html0100600000176200017510000000376707306455543031324 0ustar dhellmanndevel Class: DatabaseManager

Table of Contents

Class: DatabaseManager Zope-2-CVS-src/lib/python/App/ApplicationManager.py

Database management

Base Classes   
Fake
SimpleItem.Item
Acquisition.Implicit

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/ApplicationManager_DebugManager.py.html0100600000176200017510000001676007306455543030643 0ustar dhellmanndevel Class: DebugManager

Table of Contents

Class: DebugManager Zope-2-CVS-src/lib/python/App/ApplicationManager.py

Debug and profiling information

Base Classes   
Fake
SimpleItem.Item
Acquisition.Implicit
Methods   
dbconnections
manage_profile_stats
rcdate
rcdeltas
rcsnapshot
refcount
refdict
  dbconnections  
dbconnections ( self )

  manage_profile_stats  
manage_profile_stats (
        self,
        sort='time',
        limit=200,
        )

Return profile data if available

  rcdate  
rcdate ( self )

  rcdeltas  
rcdeltas ( self )

  rcsnapshot  
rcsnapshot ( self )

  refcount  
refcount (
        self,
        n=None,
        t=(type( Fake ), type( Acquisition.Implicit ) ),
        )

  refdict  
refdict ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/ApplicationManager_Fake.py.html0100600000176200017510000000504007306455543027155 0ustar dhellmanndevel Class: Fake

Table of Contents

Class: Fake Zope-2-CVS-src/lib/python/App/ApplicationManager.py

Methods   
locked_in_version
  locked_in_version  
locked_in_version ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/ApplicationManager_VersionManager.py.html0100600000176200017510000000376407306455543031242 0ustar dhellmanndevel Class: VersionManager

Table of Contents

Class: VersionManager Zope-2-CVS-src/lib/python/App/ApplicationManager.py

Version management

Base Classes   
Fake
SimpleItem.Item
Acquisition.Implicit

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/CacheManager.py.html0100600000176200017510000000545707306455543025003 0ustar dhellmanndevel Module: CacheManager

Table of Contents

Module: CacheManager Zope-2-CVS-src/lib/python/App/CacheManager.py

Imported modules   
import Globals
import sys
import time
Classes   
CacheManager

Cache management mix-in

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/CacheManager_CacheManager.py.html0100600000176200017510000003555707306455543027365 0ustar dhellmanndevel Class: CacheManager

Table of Contents

Class: CacheManager Zope-2-CVS-src/lib/python/App/CacheManager.py

Cache management mix-in

Methods   
cacheStatistics
cache_age
cache_detail
cache_extreme_detail
cache_last_gc_time
cache_length
cache_mean_age
cache_mean_deac
cache_mean_deal
cache_size
 database_size
initialize_cache
manage_cache_age
manage_cache_size
manage_full_sweep
manage_minimize
  cacheStatistics  
cacheStatistics ( self )

  cache_age  
cache_age ( self )

  cache_detail  
cache_detail ( self )

  cache_extreme_detail  
cache_extreme_detail ( self )

  cache_last_gc_time  
cache_last_gc_time ( self )

BoboPOS 2

  cache_length  
cache_length ( self )

  cache_mean_age  
cache_mean_age ( self )

BoboPOS 2

  cache_mean_deac  
cache_mean_deac ( self )

BoboPOS 2

  cache_mean_deal  
cache_mean_deal ( self )

BoboPOS 2

  cache_size  
cache_size ( self )

  database_size  
database_size ( self )

  initialize_cache  
initialize_cache ( self )

  manage_cache_age  
manage_cache_age (
        self,
        value,
        REQUEST,
        )

set cache age

Exceptions   
'Version Error', ( '''You may not change the database cache age while working in a version''' )
  manage_cache_size  
manage_cache_size (
        self,
        value,
        REQUEST,
        )

set cache size

Exceptions   
'Version Error', ( '''You may not change the database cache size while working in a version''' )
  manage_full_sweep  
manage_full_sweep (
        self,
        value,
        REQUEST,
        )

Perform a full sweep through the cache

  manage_minimize  
manage_minimize (
        self,
        value,
        REQUEST,
        )

Perform a full sweep through the cache

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Common.py.html0100600000176200017510000002212107306455543023720 0ustar dhellmanndevel Module: Common

Table of Contents

Module: Common Zope-2-CVS-src/lib/python/App/Common.py

Commonly used utility functions.

Imported modules   
import os
from string import rfind
import sys
import time
Functions   
Dictionary
absattr
aq_base
attrget
is_acquired
iso8601_date
package_home
rfc1123_date
rfc850_date
  Dictionary  
Dictionary ( **kw )

  absattr  
absattr ( attr,  c=callable )

  aq_base  
aq_base ( ob,  hasattr=hasattr )

  attrget  
attrget (
        o,
        name,
        default,
        )

  is_acquired  
is_acquired (
        ob,
        hasattr=hasattr,
        aq_base=aq_base,
        absattr=absattr,
        )

  iso8601_date  
iso8601_date ( ts=None )

  package_home  
package_home ( globals_dict )

  rfc1123_date  
rfc1123_date ( ts=None )

  rfc850_date  
rfc850_date ( ts=None )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/DavLockManager.py.html0100600000176200017510000000544507306455543025320 0ustar dhellmanndevel Module: DavLockManager

Table of Contents

Module: DavLockManager Zope-2-CVS-src/lib/python/App/DavLockManager.py

Imported modules   
from AccessControl import getSecurityManager, ClassSecurityInfo
import Acquisition
import Globals
import OFS
from webdav.Lockable import wl_isLocked
Classes   
DavLockManager

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/DavLockManager_DavLockManager.py.html0100600000176200017510000001436507306455543030217 0ustar dhellmanndevel Class: DavLockManager

Table of Contents

Class: DavLockManager Zope-2-CVS-src/lib/python/App/DavLockManager.py

Base Classes   
OFS.SimpleItem.Item
Acquisition.Implicit
Methods   
_findapply
findLockedObjects
locked_in_version
manage_unlockObjects
unlockObjects
  _findapply  
_findapply (
        self,
        obj,
        result=None,
        path='',
        )

recursive function to actually dig through and find the locked objects.

  findLockedObjects  
findLockedObjects ( self,  frompath='' )

  locked_in_version  
locked_in_version ( self )

  manage_unlockObjects  
manage_unlockObjects (
        self,
        paths=[],
        REQUEST=None,
        )

Management screen action to unlock objects.

  unlockObjects  
unlockObjects ( self,  paths=[] )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Dialogs.py.html0100600000176200017510000000526507306455543024064 0ustar dhellmanndevel Module: Dialogs

Table of Contents

Module: Dialogs Zope-2-CVS-src/lib/python/App/Dialogs.py

Common HTML dialog boxes

MessageDialog(title, message, action, [target])

A very simple dialog used to display an HTML page titled title, displaying message message and an OK button. Clicking the OK button will take the browser to the URL specified in action. The optional target argument can be used to force a (frames capable) browser to load the URL specified in action into a specific frame. (Specifying _new will cause the browser to load the specified URL into a new window, for example).

example usage: <PRE> return MessageDialog(title='Just thought you should know...', message='You have wiped out your data.', action='/paid_tech_support/prices.html', target='_top') </PRE>

Imported modules   
from Globals import HTML

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Extensions.py.html0100600000176200017510000002523607306455543024641 0ustar dhellmanndevel Module: Extensions

Table of Contents

Module: Extensions Zope-2-CVS-src/lib/python/App/Extensions.py

Imported modules   
import Products
import imp
import os
import rotor
from string import find, split
import zlib
Functions   
_getPath
getBrain
getObject
getPath
  _getPath  
_getPath (
        home,
        prefix,
        name,
        suffixes,
        )

Exceptions   
ValueError, ( 'The file name, %s, should be a simple file name' % name )
ValueError, ( 'The prefix, %s, should be a relative path' % prefix )
  getBrain  
getBrain (
        module,
        class_name,
        reload=0,
        )

Check/load a class

Exceptions   
ValueError, ( '%s, is not a class' % class_name )
ValueError, ('The class, %s, is not defined in file, %s' %( class_name, module ) )
  getObject  
getObject (
        module,
        name,
        reload=0,
        modules={},
        )

Exceptions   
"Module Error", ( "The specified module, %s, couldn't be found." % module )
"Module Error", ( "The specified module, %s, couldn't be opened." % module )
'Invalid Object Name', ("The specified object, %s, was not found in module, " "%s." %( name, module ) )
  getPath  
getPath (
        prefix,
        name,
        checkProduct=1,
        suffixes=( '', ),
        )

Find a file in one of several relative locations

Arguments:

prefix

The location, relative to some home, to look for the file

name

The name of the file. This must not be a path.

checkProduct

a flag indicating whether product directories should be used as additional hope ares to be searched. This defaults to a true value.

If this is true and the name contains a dot, then the text before the dot is treated as a product name and the product package directory is used as anothe rhome.

suffixes

a sequences of file suffixes to check. By default, the name is used without a suffix.

The search takes on multiple homes which are INSTANCE_HOME, the directory containing the directory containing SOFTWARE_HOME, and possibly product areas.

Exceptions   
ValueError, ( 'The file name, %s, should be a simple file name' % name )
Classes   
FuncCode
NoBrains

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Extensions_FuncCode.py.html0100600000176200017510000000632407306455543026404 0ustar dhellmanndevel Class: FuncCode

Table of Contents

Class: FuncCode Zope-2-CVS-src/lib/python/App/Extensions.py

Methods   
__cmp__
__init__
  __cmp__  
__cmp__ ( self,  other )

  __init__  
__init__ (
        self,
        f,
        im=0,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Extensions_NoBrains.py.html0100600000176200017510000000242307306455543026425 0ustar dhellmanndevel Class: NoBrains

Table of Contents

Class: NoBrains Zope-2-CVS-src/lib/python/App/Extensions.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Factory.py.html0100600000176200017510000000563507306455544024113 0ustar dhellmanndevel Module: Factory

Table of Contents

Module: Factory Zope-2-CVS-src/lib/python/App/Factory.py

Imported modules   
import AccessControl.Role
import Acquisition
import Globals
import OFS.SimpleItem
import Product
import Products
Classes   
Factory

Model factory meta-data

ProductFactory

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Factory_Factory.py.html0100600000176200017510000002215307306455544025574 0ustar dhellmanndevel Class: Factory

Table of Contents

Class: Factory Zope-2-CVS-src/lib/python/App/Factory.py

Model factory meta-data

Base Classes   
AccessControl.Role.RoleManager
Globals.Persistent
Acquisition.Implicit
OFS.SimpleItem.Item
Methods   
__init__
_register
_unregister
index_html
initializePermission
manage_afterAdd
manage_beforeDelete
manage_edit
objectIds
  __init__  
__init__ (
        self,
        id,
        title,
        object_type,
        initial,
        permission='',
        )

  _register  
_register ( self )

  _unregister  
_unregister ( self )

  index_html  
index_html ( self,  REQUEST )

  initializePermission  
initializePermission ( self )

  manage_afterAdd  
manage_afterAdd (
        self,
        item,
        container,
        )

  manage_beforeDelete  
manage_beforeDelete (
        self,
        item,
        container,
        )

  manage_edit  
manage_edit (
        self,
        title,
        object_type,
        initial,
        permission='',
        REQUEST=None,
        )

Modify factory properties.

  objectIds  
objectIds ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Factory_ProductFactory.py.html0100600000176200017510000000410507306455544027132 0ustar dhellmanndevel Class: ProductFactory

Table of Contents

Class: ProductFactory Zope-2-CVS-src/lib/python/App/Factory.py

Base Classes   
Factory
    AccessControl.Role.RoleManager
    Globals.Persistent
    Acquisition.Implicit
    OFS.SimpleItem.Item

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/FactoryDispatcher.py.html0100600000176200017510000000654507306455544026123 0ustar dhellmanndevel Module: FactoryDispatcher

Table of Contents

Module: FactoryDispatcher Zope-2-CVS-src/lib/python/App/FactoryDispatcher.py

Imported modules   
from AccessControl.Owned import UnownableOwner
from AccessControl.PermissionMapping import aqwrap
import Acquisition
import ExtensionClass
import Products
from string import rfind
import sys
Classes   
FactoryDispatcher

Provide a namespace for product "methods

ProductDispatcher
ofWrapper

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/FactoryDispatcher_FactoryDispatcher.py.html0100600000176200017510000001553707306455544031622 0ustar dhellmanndevel Class: FactoryDispatcher

Table of Contents

Class: FactoryDispatcher Zope-2-CVS-src/lib/python/App/FactoryDispatcher.py

Provide a namespace for product "methods"

Base Classes   
Acquisition.Implicit
Methods   
Destination
DestinationURL
__getattr__
__init__
manage_main
  Destination  
Destination ( self )

Return the destination for factory output

  DestinationURL  
DestinationURL ( self )

Return the URL for the destination for factory output

  __getattr__  
__getattr__ ( self,  name )

Exceptions   
AttributeError, name
  __init__  
__init__ (
        self,
        product,
        dest,
        REQUEST=None,
        )

  manage_main  
manage_main (
        trueself,
        self,
        REQUEST,
        update_menu=0,
        )

Implement a contents view by redirecting to the true view

Provide a replacement for manage_main that does a redirection:

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/FactoryDispatcher_ProductDispatcher.py.html0100600000176200017510000000771307306455544031630 0ustar dhellmanndevel Class: ProductDispatcher

Table of Contents

Class: ProductDispatcher Zope-2-CVS-src/lib/python/App/FactoryDispatcher.py

Base Classes   
Acquisition.Implicit
Methods   
__bobo_traverse__
__getitem__
  __bobo_traverse__  
__bobo_traverse__ (
        self,
        REQUEST,
        name,
        )

  __getitem__  
__getitem__ ( self,  name )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/FactoryDispatcher_ofWrapper.py.html0100600000176200017510000000751207306455544030143 0ustar dhellmanndevel Class: ofWrapper

Table of Contents

Class: ofWrapper Zope-2-CVS-src/lib/python/App/FactoryDispatcher.py

Base Classes   
ExtensionClass.Base
Methods   
__init__
__of__
  __init__  
__init__ ( self,  o )

  __of__  
__of__ ( self,  parent )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/FindHomes.py.html0100600000176200017510000000436207306455544024354 0ustar dhellmanndevel Module: FindHomes

Table of Contents

Module: FindHomes Zope-2-CVS-src/lib/python/App/FindHomes.py

Commonly used utility functions.

Imported modules   
from Common import package_home
import Products
import os
import string
import sys

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/ImageFile.py.html0100600000176200017510000000663607306455544024330 0ustar dhellmanndevel Module: ImageFile

Table of Contents

Module: ImageFile Zope-2-CVS-src/lib/python/App/ImageFile.py

Image object that is stored in a file

Imported modules   
import Acquisition
from Common import rfc1123_date
from DateTime import DateTime
from Globals import package_home
from OFS.content_types import guess_content_type
import os
from os import stat
import string
from string import rfind, split
from time import time
Classes   
ImageFile

Image objects stored in external files.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/ImageFile_ImageFile.py.html0100600000176200017510000001371407306455544026225 0ustar dhellmanndevel Class: ImageFile

Table of Contents

Class: ImageFile Zope-2-CVS-src/lib/python/App/ImageFile.py

Image objects stored in external files.

Base Classes   
Acquisition.Explicit
Methods   
HEAD
__init__
__len__
__str__
index_html
  HEAD  
HEAD (
        self,
        REQUEST,
        RESPONSE,
        )

  __init__  
__init__ (
        self,
        path,
        _prefix=None,
        )

  __len__  
__len__ ( self )

  __str__  
__str__ ( self )

  index_html  
index_html (
        self,
        REQUEST,
        RESPONSE,
        )

Default document

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Management.py.html0100600000176200017510000000660507306455544024556 0ustar dhellmanndevel Module: Management

Table of Contents

Module: Management Zope-2-CVS-src/lib/python/App/Management.py

Standard management interface support

$Id: Management.py,v 1.47 2001/01/16 21:26:56 chrism Exp $

Imported modules   
from AccessControl import getSecurityManager
from Dialogs import MessageDialog
import ExtensionClass
import Globals
from Globals import DTMLFile, HTMLFile
from string import split, join, find
import sys
import urllib
Classes   
Navigation

Basic navigation UI support

Tabs

Mix-in provides management folder tab support.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Management_Navigation.py.html0100600000176200017510000000631507306455544026733 0ustar dhellmanndevel Class: Navigation

Table of Contents

Class: Navigation Zope-2-CVS-src/lib/python/App/Management.py

Basic navigation UI support

Base Classes   
ExtensionClass.Base
Methods   
manage_zmi_logout
  manage_zmi_logout  
manage_zmi_logout (
        self,
        REQUEST,
        RESPONSE,
        )

Logout current user

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Management_Tabs.py.html0100600000176200017510000001442507306455544025526 0ustar dhellmanndevel Class: Tabs

Table of Contents

Class: Tabs Zope-2-CVS-src/lib/python/App/Management.py

Mix-in provides management folder tab support.

Base Classes   
ExtensionClass.Base
Methods   
filtered_manage_options
manage_workspace
tabs_path_default
tabs_path_info
  filtered_manage_options  
filtered_manage_options ( self,  REQUEST=None )

  manage_workspace  
manage_workspace ( self,  REQUEST )

Dispatch to first interface in manage_options

Exceptions   
'Redirect', ("%s/%s" %( REQUEST [ 'URL1' ], m ) )
'Unauthorized', ( 'You are not authorized to view this object.

' )
TypeError

  tabs_path_default  
tabs_path_default (
        self,
        REQUEST,
        unquote=urllib.unquote,
        )

  tabs_path_info  
tabs_path_info (
        self,
        script,
        path,
        quote=urllib.quote,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Permission.py.html0100600000176200017510000000561107306455544024626 0ustar dhellmanndevel Module: Permission

Table of Contents

Module: Permission Zope-2-CVS-src/lib/python/App/Permission.py

Imported modules   
import AccessControl.Role
import Acquisition
import ExtensionClass
import Globals
import OFS.SimpleItem
Classes   
Permission

Model Permission meta-data

PermissionManager

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Permission_Permission.py.html0100600000176200017510000001565307306455544027045 0ustar dhellmanndevel Class: Permission

Table of Contents

Class: Permission Zope-2-CVS-src/lib/python/App/Permission.py

Model Permission meta-data

Base Classes   
AccessControl.Role.RoleManager
Globals.Persistent
Acquisition.Implicit
OFS.SimpleItem.Item
Methods   
__init__
_register
_unregister
manage_afterAdd
manage_beforeDelete
manage_edit
  __init__  
__init__ (
        self,
        id,
        title,
        name,
        )

  _register  
_register ( self )

  _unregister  
_unregister ( self )

  manage_afterAdd  
manage_afterAdd (
        self,
        item,
        container,
        )

  manage_beforeDelete  
manage_beforeDelete (
        self,
        item,
        container,
        )

  manage_edit  
manage_edit (
        self,
        title,
        name,
        REQUEST=None,
        )

Modify Permission properties.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Permission_PermissionManager.py.html0100600000176200017510000000645607306455544030341 0ustar dhellmanndevel Class: PermissionManager

Table of Contents

Class: PermissionManager Zope-2-CVS-src/lib/python/App/Permission.py

Base Classes   
ExtensionClass.Base
Methods   
manage_addPermission
  manage_addPermission  
manage_addPermission (
        self,
        id,
        title,
        permission,
        REQUEST=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/PersistentExtra.py.html0100600000176200017510000000554507306455544025650 0ustar dhellmanndevel Module: PersistentExtra

Table of Contents

Module: PersistentExtra Zope-2-CVS-src/lib/python/App/PersistentExtra.py

Imported modules   
from DateTime import DateTime
import Globals
from Persistence import Persistent
from class_init import default__class_init__
Classes   
PersistentUtil

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/PersistentExtra_PersistentUtil.py.html0100600000176200017510000001005107306455544030712 0ustar dhellmanndevel Class: PersistentUtil

Table of Contents

Class: PersistentUtil Zope-2-CVS-src/lib/python/App/PersistentExtra.py

Methods   
bobobase_modification_time
locked_in_version
modified_in_version
  bobobase_modification_time  
bobobase_modification_time ( self )

  locked_in_version  
locked_in_version ( self )

Was the object modified in any version?

  modified_in_version  
modified_in_version ( self )

Was the object modified in this version?

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Product.py.html0100600000176200017510000001477207306455544024126 0ustar dhellmanndevel Module: Product

Table of Contents

Module: Product Zope-2-CVS-src/lib/python/App/Product.py

Product objects

Imported modules   
import AccessControl.Owned
import Acquisition
from Factory import Factory
import Globals
from HelpSys.HelpSys import ProductHelp
import OFS.Folder
from OFS.Folder import Folder
import OFS.SimpleItem
from Permission import PermissionManager
import Products
import RefreshFuncs
import ZClasses
import ZClasses.ZClass
import cPickle
import marshal
import os
import re
import rotor
import string
from string import rfind, atoi, find, strip, join
import zlib
Functions   
ihasattr
initializeProduct
  ihasattr  
ihasattr ( o,  name )

  initializeProduct  
initializeProduct (
        productp,
        name,
        home,
        app,
        )

Classes   
CompressedInputFile
CompressedOutputFile
Distribution

A distribution builder

Product

Model a product that can be created through the web.

ProductFolder

Manage a collection of Products

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Product_CompressedInputFile.py.html0100600000176200017510000001106107306455544030116 0ustar dhellmanndevel Class: CompressedInputFile

Table of Contents

Class: CompressedInputFile Zope-2-CVS-src/lib/python/App/Product.py

Methods   
__init__
_next
read
readline
  __init__  
__init__ (
        self,
        f,
        rot,
        )

  _next  
_next ( self )

  read  
read ( self,  l=None )

  readline  
readline ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Product_CompressedOutputFile.py.html0100600000176200017510000000754607306455544030334 0ustar dhellmanndevel Class: CompressedOutputFile

Table of Contents

Class: CompressedOutputFile Zope-2-CVS-src/lib/python/App/Product.py

Methods   
__init__
getdata
write
  __init__  
__init__ ( self,  rot )

  getdata  
getdata ( self )

  write  
write ( self,  s )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Product_Distribution.py.html0100600000176200017510000000625107306455544026656 0ustar dhellmanndevel Class: Distribution

Table of Contents

Class: Distribution Zope-2-CVS-src/lib/python/App/Product.py

A distribution builder

Methods   
__init__
index_html
  __init__  
__init__ ( self,  product )

  index_html  
index_html ( self,  RESPONSE )

Return distribution data

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Product_Product.py.html0100600000176200017510000004444707306455544025630 0ustar dhellmanndevel Class: Product

Table of Contents

Class: Product Zope-2-CVS-src/lib/python/App/Product.py

Model a product that can be created through the web.

Base Classes   
Folder
PermissionManager
Methods   
Destination
DestinationURL
__init__
_distribution
_readRefreshTxt
getProductHelp
manage_addPrincipiaFactory
manage_distribute
manage_enableAutoRefresh
manage_get_product_readme__
 manage_performRefresh
manage_refresh
manage_selectDependentProducts
new_version
permissionMappingPossibleValues
zclass_product_name
  Destination  
Destination ( self )

Return the destination for factory output

  DestinationURL  
DestinationURL ( self )

Return the URL for the destination for factory output

  __init__  
__init__ (
        self,
        id,
        title,
        )

  _distribution  
_distribution ( self )

Exceptions   
TypeError, 'This product is not redistributable.'
  _readRefreshTxt  
_readRefreshTxt ( self,  pid=None )

  getProductHelp  
getProductHelp ( self )

Returns the ProductHelp object associated with the Product.

  manage_addPrincipiaFactory  
manage_addPrincipiaFactory (
        self,
        id,
        title,
        object_type,
        initial,
        permission=None,
        REQUEST=None,
        )

  manage_distribute  
manage_distribute (
        self,
        version,
        RESPONSE,
        configurable_objects=[],
        redistributable=0,
        )

Set the product up to create a distribution and give a link

Exceptions   
TypeError, 'This product is not redistributable.'
  manage_enableAutoRefresh  
manage_enableAutoRefresh (
        self,
        enable=0,
        REQUEST=None,
        )

Changes the auto refresh flag for this product.

Exceptions   
'Unauthorized', 'refresh.txt not created'
  manage_get_product_readme__  
manage_get_product_readme__ ( self )

  manage_performRefresh  
manage_performRefresh ( self,  REQUEST=None )

Attempts to perform a refresh operation.

Exceptions   
'Unauthorized', 'refresh.txt not found'
  manage_refresh  
manage_refresh (
        self,
        REQUEST,
        manage_tabs_message=None,
        )

Displays the refresh management screen.

  manage_selectDependentProducts  
manage_selectDependentProducts (
        self,
        selections=(),
        REQUEST=None,
        )

Selects which products to refresh simultaneously.

Exceptions   
'Unauthorized', 'refresh.txt not created'
  new_version  
new_version ( self,  _intending=re.compile( r"[.]?[0-9]+$" ).search )

  permissionMappingPossibleValues  
permissionMappingPossibleValues ( self )

  zclass_product_name  
zclass_product_name ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Product_ProductFolder.py.html0100600000176200017510000001114007306455544026744 0ustar dhellmanndevel Class: ProductFolder

Table of Contents

Class: ProductFolder Zope-2-CVS-src/lib/python/App/Product.py

Manage a collection of Products

Base Classes   
Folder
Methods   
_canCopy
_product
manage_addProduct
  _canCopy  
_canCopy ( self,  op=0 )

  _product  
_product ( self,  name )

  manage_addProduct  
manage_addProduct (
        self,
        id,
        title,
        REQUEST=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/ProductContext.py.html0100600000176200017510000000740607306455544025467 0ustar dhellmanndevel Module: ProductContext

Table of Contents

Module: ProductContext Zope-2-CVS-src/lib/python/App/ProductContext.py

Objects providing context for product initialization

Imported modules   
import AccessControl.Permission
from AccessControl.PermissionRole import PermissionRole
from DateTime import DateTime
from FactoryDispatcher import FactoryDispatcher
import Globals
from HelpSys import HelpTopic, APIHelpTopic
from HelpSys.HelpSys import ProductHelp
from Interface import instancesOfObjectImplements
import OFS.ObjectManager
import OFS.misc_
import Products
import os
import os.path
import re
import stat
import string
from types import ListType, TupleType
from zLOG import LOG, WARNING
Classes   
ProductContext

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/ProductContext_ProductContext.py.html0100600000176200017510000002470707306455544030537 0ustar dhellmanndevel Class: ProductContext

Table of Contents

Class: ProductContext Zope-2-CVS-src/lib/python/App/ProductContext.py

Methods   
__init__
getProductHelp
registerBaseClass
registerClass
registerHelp
registerHelpTitle
registerHelpTopic
registerZClass
  __init__  
__init__ (
        self,
        product,
        app,
        package,
        )

  getProductHelp  
getProductHelp ( self )

Returns the ProductHelp associated with the current Product.

  registerBaseClass  
registerBaseClass (
        self,
        base_class,
        meta_type=None,
        )

  registerClass  
registerClass (
        self,
        instance_class=None,
        meta_type='',
        permission=None,
        constructors=(),
        icon=None,
        permissions=None,
        legacy=(),
        visibility="Global",
        interfaces=_marker,
        )

Register a constructor

Keyword arguments are used to provide meta data:

instance_class

The class of the object that will be created.

This is not currently used, but may be used in the future to increase object mobility.

meta_type

The kind of object being created This appears in add lists. If not specified, then the class meta_type will be used.

permission

The permission name for the constructors. If not specified, then a permission name based on the meta type will be used.

constructors

A list of constructor methods A method can me a callable object with a __name__ attribute giving the name the method should have in the product, or the method may be a tuple consisting of a name and a callable object. The method must be picklable.

The first method will be used as the initial method called when creating an object.

icon

The name of an image file in the package to be used for instances. Note that the class icon attribute will be set automagically if an icon is provided.

permissions

Additional permissions to be registered If not provided, then permissions defined in the class will be registered.

legacy

A list of legacy methods to be added to ObjectManager for backward compatibility

visibility

"Global" if the object is globally visible, None else

interfaces

a list of the interfaces the object supports

  registerHelp  
registerHelp (
        self,
        directory='help',
        clear=1,
        title_re=re.compile( r'<title>(.+?)</title>', re.I ),
        )

Registers Help Topics for all objects in a directory.

Nothing will be done if the files in the directory haven't changed since the last registerHelp call.

clear indicates whether or not to delete all existing Topics from the Product.

HelpTopics are created for these kind of files

.dtml

DTMLHelpTopic .html .htm -- TextHelpTopic .stx .txt -- STXHelpTopic .jpg .png .gif -- ImageHelpTopic .py -- APIHelpTopic

  registerHelpTitle  
registerHelpTitle ( self,  title )

Sets the title of the Product's Product Help

  registerHelpTopic  
registerHelpTopic (
        self,
        id,
        topic,
        )

Register a Help Topic for a product.

  registerZClass  
registerZClass (
        self,
        Z,
        meta_type=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/ProductRegistry.py.html0100600000176200017510000000565607306455544025660 0ustar dhellmanndevel Module: ProductRegistry

Table of Contents

Module: ProductRegistry Zope-2-CVS-src/lib/python/App/ProductRegistry.py

Imported modules   
from OFS.Folder import Folder
Classes   
ProductRegistry

This class implements a protocol for registering products that

ProductRegistryMixin

This class implements a protocol for registering products that

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/ProductRegistry_ProductRegistry.py.html0100600000176200017510000001616507306455544031106 0ustar dhellmanndevel Class: ProductRegistry

Table of Contents

Class: ProductRegistry Zope-2-CVS-src/lib/python/App/ProductRegistry.py

This class implements a protocol for registering products that are defined through the web. It also provides methods for getting hold of the Product Registry, Control_Panel.Products.

Base Classes   
ProductRegistryMixin
Methods   
_getProductRegistryData
_getProductRegistryMetaTypes
_getProducts
_setProductRegistryData
_setProductRegistryMetaTypes
  _getProductRegistryData  
_getProductRegistryData ( self,  name )

  _getProductRegistryMetaTypes  
_getProductRegistryMetaTypes ( self )

  _getProducts  
_getProducts ( self )

  _setProductRegistryData  
_setProductRegistryData (
        self,
        name,
        v,
        )

Exceptions   
AttributeError, name
  _setProductRegistryMetaTypes  
_setProductRegistryMetaTypes ( self,  v )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/ProductRegistry_ProductRegistryMixin.py.html0100600000176200017510000002410507306455544032104 0ustar dhellmanndevel Class: ProductRegistryMixin

Table of Contents

Class: ProductRegistryMixin Zope-2-CVS-src/lib/python/App/ProductRegistry.py

This class implements a protocol for registering products that are defined through the web.

Methods   
_constructor_prefix_string
_manage_add_product_data
_manage_add_product_meta_type
_manage_add_product_permission
_manage_remove_product_data
_manage_remove_product_meta_type
_manage_remove_product_permission
aq_maybe
  _constructor_prefix_string  
_constructor_prefix_string ( self,  pid )

  _manage_add_product_data  
_manage_add_product_data (
        self,
        type,
        product,
        id,
        **data,
        )

  _manage_add_product_meta_type  
_manage_add_product_meta_type (
        self,
        product,
        id,
        meta_type,
        permission='',
        )

Exceptions   
'Type Exists', ( 'The type %s is already defined.' % meta_type )
  _manage_add_product_permission  
_manage_add_product_permission (
        self,
        product,
        permission,
        methods=(),
        default=( 'Manager', ),
        )

Exceptions   
'Type Exists', ( 'The permission %s is already defined.' % permission )
  _manage_remove_product_data  
_manage_remove_product_data (
        self,
        type,
        product,
        id,
        )

  _manage_remove_product_meta_type  
_manage_remove_product_meta_type (
        self,
        product,
        id=None,
        meta_type=None,
        )

  _manage_remove_product_permission  
_manage_remove_product_permission (
        self,
        product,
        permission=None,
        )

  aq_maybe  
aq_maybe ( self,  name )

HACK - sometimes an unwrapped App object seems to be passed as self to these methods, which means that they dont have an aq_aquire method. Until Jim has time to look into this, this aq_maybe method appears to be an effective work-around...

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/RefreshFuncs.py.html0100600000176200017510000005477607306455544025113 0ustar dhellmanndevel Module: RefreshFuncs

Table of Contents

Module: RefreshFuncs Zope-2-CVS-src/lib/python/App/RefreshFuncs.py

Functions for refreshing products. $Id: RefreshFuncs.py,v 1.1 2001/05/17 18:35:08 shane Exp $

Imported modules   
from ExtensionClass import Base
from Globals import PersistentMapping
import Products
import os
from string import split, join
import sys
from time import time
from zLOG import format_exception, LOG, ERROR, INFO
Functions   
_getCentralRefreshData
autoRefresh
checkAutoRefresh
checkModTimes
dummyFunc
enableAutoRefresh
finishAutoRefresh
getDependentProducts
getLastRefreshException
getReloadVar
 isAutoRefreshEnabled
listAutoRefreshableProducts
listRefreshableModules
listRequiredModules
listRequiredModulesByClass
logBadRefresh
performFullRefresh
performRefresh
performSafeRefresh
setDependentProducts
 setupAutoRefresh
setupModTimes
sortModulesByDependency
tryFindModuleFilename
tryFindProductDirectory
  _getCentralRefreshData  
_getCentralRefreshData ( jar,  create=0 )

  autoRefresh  
autoRefresh ( jar )

  checkAutoRefresh  
checkAutoRefresh ( jar )

  checkModTimes  
checkModTimes ( productid )

  dummyFunc  
dummyFunc ()

  enableAutoRefresh  
enableAutoRefresh (
        jar,
        productid,
        enable,
        )

  finishAutoRefresh  
finishAutoRefresh ( jar,  productids )

  getDependentProducts  
getDependentProducts ( jar,  productid )

  getLastRefreshException  
getLastRefreshException ( productid )

  getReloadVar  
getReloadVar ( module )

  isAutoRefreshEnabled  
isAutoRefreshEnabled ( jar,  productid )

  listAutoRefreshableProducts  
listAutoRefreshableProducts ( jar )

  listRefreshableModules  
listRefreshableModules ( productid )

  listRequiredModules  
listRequiredModules ( module )

  listRequiredModulesByClass  
listRequiredModulesByClass ( klass,  rval )

  logBadRefresh  
logBadRefresh ( productid )

  performFullRefresh  
performFullRefresh ( jar,  productid )

  performRefresh  
performRefresh ( jar,  productid )

Attempts to perform a refresh operation.

  performSafeRefresh  
performSafeRefresh ( jar,  productid )

  setDependentProducts  
setDependentProducts (
        jar,
        productid,
        dep_ids,
        )

  setupAutoRefresh  
setupAutoRefresh ( jar )

  setupModTimes  
setupModTimes ( productid )

  sortModulesByDependency  
sortModulesByDependency ( modlist )

  tryFindModuleFilename  
tryFindModuleFilename ( product_dir,  filename )

  tryFindProductDirectory  
tryFindProductDirectory ( productid )

Classes   
dummyClass
dummyClass2

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/RefreshFuncs_dummyClass.py.html0100600000176200017510000000243107306455544027271 0ustar dhellmanndevel Class: dummyClass

Table of Contents

Class: dummyClass Zope-2-CVS-src/lib/python/App/RefreshFuncs.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/RefreshFuncs_dummyClass2.py.html0100600000176200017510000000364307306455544027361 0ustar dhellmanndevel Class: dummyClass2

Table of Contents

Class: dummyClass2 Zope-2-CVS-src/lib/python/App/RefreshFuncs.py

Base Classes   
Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Undo.py.html0100600000176200017510000001202107306455544023374 0ustar dhellmanndevel Module: Undo

Table of Contents

Module: Undo Zope-2-CVS-src/lib/python/App/Undo.py

Imported modules   
from AccessControl import getSecurityManager
from DateTime import DateTime
import ExtensionClass
import Globals
import base64
import binascii
from string import atof, find, atoi, split, rfind, join
Functions   
decode64
encode64
  decode64  
decode64 ( s,  a2b=binascii.a2b_base64 )

  encode64  
encode64 ( s,  b2a=binascii.b2a_base64 )

Classes   
Prefix
UndoSupport

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Undo_Prefix.py.html0100600000176200017510000000624307306455544024722 0ustar dhellmanndevel Class: Prefix

Table of Contents

Class: Prefix Zope-2-CVS-src/lib/python/App/Undo.py

Methods   
__cmp__
__init__
  __cmp__  
__cmp__ ( self,  o )

  __init__  
__init__ ( self,  path )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/Undo_UndoSupport.py.html0100600000176200017510000001166407306455544025772 0ustar dhellmanndevel Class: UndoSupport

Table of Contents

Class: UndoSupport Zope-2-CVS-src/lib/python/App/Undo.py

Base Classes   
ExtensionClass.Base
Methods   
get_request_var_or_attr
manage_undo_transactions
undoable_transactions
  get_request_var_or_attr  
get_request_var_or_attr (
        self,
        name,
        default,
        )

  manage_undo_transactions  
manage_undo_transactions (
        self,
        transaction_info,
        REQUEST=None,
        )

  undoable_transactions  
undoable_transactions (
        self,
        first_transaction=None,
        last_transaction=None,
        PrincipiaUndoBatchSize=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/__init__.py.html0100600000176200017510000000242307306455544024233 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/App/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/class_init.py.html0100600000176200017510000000776307306455544024640 0ustar dhellmanndevel Module: class_init

Table of Contents

Module: class_init Zope-2-CVS-src/lib/python/App/class_init.py

Imported modules   
import AccessControl.Permission
from AccessControl.PermissionRole import PermissionRole
Functions   
default__class_init__
  default__class_init__  
default__class_init__ ( self )

Classes   
ApplicationDefaultPermissions

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/class_init_ApplicationDefaultPermissions.py.html0100600000176200017510000000247507306455544032717 0ustar dhellmanndevel Class: ApplicationDefaultPermissions

Table of Contents

Class: ApplicationDefaultPermissions Zope-2-CVS-src/lib/python/App/class_init.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/special_dtml.py.html0100600000176200017510000000726307306455544025143 0ustar dhellmanndevel Module: special_dtml

Table of Contents

Module: special_dtml Zope-2-CVS-src/lib/python/App/special_dtml.py

Imported modules   
from AccessControl import getSecurityManager
from Acquisition import Explicit, aq_inner, aq_parent
import Common
from ComputedAttribute import ComputedAttribute
import DocumentTemplate
from DocumentTemplate.DT_String import _marker, DTReturn, render_blocks
from DocumentTemplate.DT_Util import TemplateDict, InstanceDict
import Globals
import MethodObject
import Persistence
from Shared.DC.Scripts.Bindings import Bindings
import os
Classes   
ClassicHTMLFile

Persistent HTML Document Templates read from files

DTMLFile

HTMLFile with bindings and support for __render_with_namespace__

HTML

Persistent HTML Document Templates

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/special_dtml_ClassicHTMLFile.py.html0100600000176200017510000001125107306455544030061 0ustar dhellmanndevel Class: ClassicHTMLFile

Table of Contents

Class: ClassicHTMLFile Zope-2-CVS-src/lib/python/App/special_dtml.py

Persistent HTML Document Templates read from files

Base Classes   
DocumentTemplate.HTMLFile
MethodObject.Method
Methods   
__call__
__init__
_cook_check
  __call__  
__call__ (
        self,
        *args,
        *kw,
        )

  __init__  
__init__ (
        self,
        name,
        _prefix=None,
        **kw,
        )

  _cook_check  
_cook_check ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/special_dtml_DTMLFile.py.html0100600000176200017510000001302007306455544026547 0ustar dhellmanndevel Class: DTMLFile

Table of Contents

Class: DTMLFile Zope-2-CVS-src/lib/python/App/special_dtml.py

HTMLFile with bindings and support for __render_with_namespace__

Base Classes   
Bindings
Explicit
ClassicHTMLFile
    DocumentTemplate.HTMLFile
    MethodObject.Method
Methods   
__init__
_exec
_get__roles__
getOwner
  __init__  
__init__ (
        self,
        name,
        _prefix=None,
        **kw,
        )

  _exec  
_exec (
        self,
        bound_data,
        args,
        kw,
        )

  _get__roles__  
_get__roles__ ( self )

  getOwner  
getOwner ( self,  info=0 )

This method is required of all objects that go into the security context stack.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/special_dtml_HTML.py.html0100600000176200017510000000367307306455544025770 0ustar dhellmanndevel Class: HTML

Table of Contents

Class: HTML Zope-2-CVS-src/lib/python/App/special_dtml.py

Persistent HTML Document Templates

Base Classes   
DocumentTemplate.HTML
Persistence.Persistent

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/tar.py.html0100600000176200017510000001722307306455544023266 0ustar dhellmanndevel Module: tar

Table of Contents

Module: tar Zope-2-CVS-src/lib/python/App/tar.py

Imported modules   
from string import find, join
import sys
import time
import zlib
Functions   
oct12
oct8
pad
tar
tgz
  oct12  
oct12 ( i )

  oct8  
oct8 ( i )

  pad  
pad ( s,  l )

Exceptions   
ValueError, 'value, %s, too wide for field (%d)' %( s, l )
  tar  
tar ( entries )

  tgz  
tgz ( entries )

Classes   
TarEntry
gzFile
tgzarchive

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/tar_TarEntry.py.html0100600000176200017510000001002007306455544025102 0ustar dhellmanndevel Class: TarEntry

Table of Contents

Class: TarEntry Zope-2-CVS-src/lib/python/App/tar.py

Methods   
__init__
__str__
  __init__  
__init__ (
        self,
        path,
        data,
        mode=0644,
        uid=0,
        gid=0,
        mtime=None,
        typeflag='0',
        linkname='',
        uname='jim',
        gname='system',
        prefix='',
        )

Initialize a Tar archive entry

Exceptions   
'Bad Header Length', len( header )
  __str__  
__str__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/tar_gzFile.py.html0100600000176200017510000000755707306455544024577 0ustar dhellmanndevel Class: gzFile

Table of Contents

Class: gzFile Zope-2-CVS-src/lib/python/App/tar.py

Methods   
__init__
getdata
write
  __init__  
__init__ (
        self,
        name,
        t=None,
        )

  getdata  
getdata ( self )

  write  
write ( self,  s )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/tar_tgzarchive.py.html0100600000176200017510000001110307306455544025503 0ustar dhellmanndevel Class: tgzarchive

Table of Contents

Class: tgzarchive Zope-2-CVS-src/lib/python/App/tar.py

Methods   
__init__
__str__
add
finish
  __init__  
__init__ (
        self,
        name,
        time=None,
        )

  __str__  
__str__ ( self )

  add  
add (
        self,
        name,
        data,
        )

  finish  
finish ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/App/version_txt.py.html0100600000176200017510000000623707306455544025067 0ustar dhellmanndevel Module: version_txt

Table of Contents

Module: version_txt Zope-2-CVS-src/lib/python/App/version_txt.py

Imported modules   
import os
Functions   
version_txt
  version_txt  
version_txt ()

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/0040700000176200017510000000000007306455546021625 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/index.html0100600000176200017510000000562607306455546023632 0ustar dhellmanndevel Zope2 CVS with ZEO: BTrees

Table of Contents

Zope2 CVS with ZEO: BTrees  
Modules and Packages   

Zope-2-CVS-src/lib/python/BTrees/

IIBTree
IOBTree
Interfaces
Length
OIBTree
OOBTree
__init__
convert
tests

Zope2 CVS with ZEO: BTrees.tests

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/0040700000176200017510000000000007306455546022767 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/index.html0100600000176200017510000000431607306455546024767 0ustar dhellmanndevel Zope2 CVS with ZEO: BTrees.tests

Table of Contents

Zope2 CVS with ZEO: BTrees.tests  
Modules and Packages   

Zope-2-CVS-src/lib/python/BTrees/tests/

__init__
testBTrees
testConflict

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/__init__.py.html0100600000176200017510000000244207306455545026043 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/BTrees/tests/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py.html0100600000176200017510000002444707306455545026401 0ustar dhellmanndevel Module: testBTrees

Table of Contents

Module: testBTrees Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Imported modules   
from BTrees.IIBTree import IIBTree, IIBucket, IISet, IITreeSet
from BTrees.IOBTree import IOBTree, IOBucket, IOSet, IOTreeSet
from BTrees.OIBTree import OIBTree, OIBucket, OISet, OITreeSet
from BTrees.OOBTree import OOBTree, OOBucket, OOSet, OOTreeSet
import os
import sys
import time
from unittest import TestCase, TestSuite, JUnitTextTestRunner, VerboseTextTestRunner, makeSuite
import whrandom
Functions   
debug
lsubtract
main
realseq
test_suite
  debug  
debug ()

  lsubtract  
lsubtract ( l1,  l2 )

  main  
main ()

  realseq  
realseq ( itemsob )

  test_suite  
test_suite ()

Classes   
BTreeTests

Tests common to all BTrees

Base

Tests common to all types: sets, buckets, and BTrees

BucketTests

Tests common to all buckets

ExtendedSetTests
MappingBase

Tests common to mappings (buckets, btrees)

NormalSetTests

Test common to all set types

TestIIBTrees
TestIIBuckets
TestIISets
TestIITreeSets
TestIOBTrees
TestIOBuckets
TestIOSets
TestIOTreeSets
TestOIBTrees
TestOIBuckets
TestOISets
TestOITreeSets
TestOOBTrees
TestOOBuckets
TestOOSets
TestOOTreeSets

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_BTreeTests.py.html0100600000176200017510000003620507306455545030500 0ustar dhellmanndevel Class: BTreeTests

Table of Contents

Class: BTreeTests Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Tests common to all BTrees

Base Classes   
MappingBase
Methods   
testDeleteNoChildrenWorks
testDeleteOneChildWorks
testDeleteRootWorks
testDeleteTwoChildrenInorderSuccessorWorks
testDeleteTwoChildrenNoInorderSuccessorWorks
testInsertMethod
testPathologicalLeftBranching
testPathologicalRightBranching
testRandomDeletes
testRandomNonOverlappingInserts
 testRandomOverlappingInserts
testRangeSearchAfterRandomInsert
testRangeSearchAfterSequentialInsert
testSuccessorChildParentRewriteExerciseCase
testTargetedDeletes
  testDeleteNoChildrenWorks  
testDeleteNoChildrenWorks ( self )

  testDeleteOneChildWorks  
testDeleteOneChildWorks ( self )

  testDeleteRootWorks  
testDeleteRootWorks ( self )
7, 3, 8, 1, 5, 10, 6, 4

del 7

  testDeleteTwoChildrenInorderSuccessorWorks  
testDeleteTwoChildrenInorderSuccessorWorks ( self )
7, 3, 8, 1, 5, 10, 6, 4

del 3

  testDeleteTwoChildrenNoInorderSuccessorWorks  
testDeleteTwoChildrenNoInorderSuccessorWorks ( self )

  testInsertMethod  
testInsertMethod ( self )

  testPathologicalLeftBranching  
testPathologicalLeftBranching ( self )

  testPathologicalRightBranching  
testPathologicalRightBranching ( self )

  testRandomDeletes  
testRandomDeletes ( self )

Exceptions   
"had problems deleting %s" % k
  testRandomNonOverlappingInserts  
testRandomNonOverlappingInserts ( self )

  testRandomOverlappingInserts  
testRandomOverlappingInserts ( self )

  testRangeSearchAfterRandomInsert  
testRangeSearchAfterRandomInsert ( self )

  testRangeSearchAfterSequentialInsert  
testRangeSearchAfterSequentialInsert ( self )

  testSuccessorChildParentRewriteExerciseCase  
testSuccessorChildParentRewriteExerciseCase ( self )

  testTargetedDeletes  
testTargetedDeletes ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_Base.py.html0100600000176200017510000001372707306455545027332 0ustar dhellmanndevel Class: Base

Table of Contents

Class: Base Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Tests common to all types: sets, buckets, and BTrees

Methods   
_closeDB
_delDB
_getRoot
tearDown
testGhostUnghost
testLoadAndStore
  _closeDB  
_closeDB ( self,  root )

  _delDB  
_delDB ( self )

  _getRoot  
_getRoot ( self )

  tearDown  
tearDown ( self )

  testGhostUnghost  
testGhostUnghost ( self )

  testLoadAndStore  
testLoadAndStore ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_BucketTests.py.html0100600000176200017510000000402307306455545030705 0ustar dhellmanndevel Class: BucketTests

Table of Contents

Class: BucketTests Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Tests common to all buckets

Base Classes   
MappingBase

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_ExtendedSetTests.py.html0100600000176200017510000000771607306455545031720 0ustar dhellmanndevel Class: ExtendedSetTests

Table of Contents

Class: ExtendedSetTests Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Base Classes   
NormalSetTests
Methods   
testGetItem
testLen
  testGetItem  
testGetItem ( self )

  testLen  
testLen ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_MappingBase.py.html0100600000176200017510000003553507306455545030647 0ustar dhellmanndevel Class: MappingBase

Table of Contents

Class: MappingBase Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Tests common to mappings (buckets, btrees)

Base Classes   
Base
Methods   
_deletefail
_getitemfail
_populate
testClear
testDeleteInvalidKeyRaisesKeyError
testEmptyRangeSearches
testGetItemFails
testGetReturnsDefault
testHasKeyWorks
testItemsWorks
 testKeysWorks
testLen
testMaxKeyMinKey
testReplaceWorks
testSetItemGetItemWorks
testUpdate
testValuesWorks
  _deletefail  
_deletefail ( self )

  _getitemfail  
_getitemfail ( self )

  _populate  
_populate (
        self,
        t,
        l,
        )

  testClear  
testClear ( self )

  testDeleteInvalidKeyRaisesKeyError  
testDeleteInvalidKeyRaisesKeyError ( self )

  testEmptyRangeSearches  
testEmptyRangeSearches ( self )

  testGetItemFails  
testGetItemFails ( self )

  testGetReturnsDefault  
testGetReturnsDefault ( self )

  testHasKeyWorks  
testHasKeyWorks ( self )

  testItemsWorks  
testItemsWorks ( self )

  testKeysWorks  
testKeysWorks ( self )

  testLen  
testLen ( self )

  testMaxKeyMinKey  
testMaxKeyMinKey ( self )

  testReplaceWorks  
testReplaceWorks ( self )

  testSetItemGetItemWorks  
testSetItemGetItemWorks ( self )

  testUpdate  
testUpdate ( self )

mapping update

  testValuesWorks  
testValuesWorks ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_NormalSetTests.py.html0100600000176200017510000003121207306455545031374 0ustar dhellmanndevel Class: NormalSetTests

Table of Contents

Class: NormalSetTests Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Test common to all set types

Base Classes   
Base
Methods   
_populate
_removenonexistent
testBigInsert
testClear
testDuplicateInsert
testEmptyRangeSearches
testHasKeyFails
testInsert
testInsertReturnsValue
testKeys
 testMaxKeyMinKey
testRemoveFails
testRemoveSucceeds
testUpdate
  _populate  
_populate (
        self,
        t,
        l,
        )

  _removenonexistent  
_removenonexistent ( self )

  testBigInsert  
testBigInsert ( self )

  testClear  
testClear ( self )

  testDuplicateInsert  
testDuplicateInsert ( self )

  testEmptyRangeSearches  
testEmptyRangeSearches ( self )

  testHasKeyFails  
testHasKeyFails ( self )

  testInsert  
testInsert ( self )

  testInsertReturnsValue  
testInsertReturnsValue ( self )

  testKeys  
testKeys ( self )

  testMaxKeyMinKey  
testMaxKeyMinKey ( self )

  testRemoveFails  
testRemoveFails ( self )

  testRemoveSucceeds  
testRemoveSucceeds ( self )

  testUpdate  
testUpdate ( self )

mapping update

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_TestIIBTrees.py.html0100600000176200017510000002217007306455545030716 0ustar dhellmanndevel Class: TestIIBTrees

Table of Contents

Class: TestIIBTrees Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Base Classes   
BTreeTests
TestCase
Methods   
_floatraiseskey
_floatraisesvalue
_noneraiseskey
_noneraisesvalue
_stringraiseskey
_stringraisesvalue
setUp
testNonIntegerKeyRaises
testNonIntegerValueRaises
  _floatraiseskey  
_floatraiseskey ( self )

  _floatraisesvalue  
_floatraisesvalue ( self )

  _noneraiseskey  
_noneraiseskey ( self )

  _noneraisesvalue  
_noneraisesvalue ( self )

  _stringraiseskey  
_stringraiseskey ( self )

  _stringraisesvalue  
_stringraisesvalue ( self )

  setUp  
setUp ( self )

  testNonIntegerKeyRaises  
testNonIntegerKeyRaises ( self )

  testNonIntegerValueRaises  
testNonIntegerValueRaises ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_TestIIBuckets.py.html0100600000176200017510000000651407306455545031136 0ustar dhellmanndevel Class: TestIIBuckets

Table of Contents

Class: TestIIBuckets Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Base Classes   
BucketTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_TestIISets.py.html0100600000176200017510000000652607306455545030457 0ustar dhellmanndevel Class: TestIISets

Table of Contents

Class: TestIISets Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Base Classes   
ExtendedSetTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_TestIITreeSets.py.html0100600000176200017510000000641207306455545031271 0ustar dhellmanndevel Class: TestIITreeSets

Table of Contents

Class: TestIITreeSets Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Base Classes   
NormalSetTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_TestIOBTrees.py.html0100600000176200017510000001421307306455545030723 0ustar dhellmanndevel Class: TestIOBTrees

Table of Contents

Class: TestIOBTrees Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Base Classes   
BTreeTests
TestCase
Methods   
_floatraises
_noneraises
_stringraises
nonIntegerKeyRaises
setUp
  _floatraises  
_floatraises ( self )

  _noneraises  
_noneraises ( self )

  _stringraises  
_stringraises ( self )

  nonIntegerKeyRaises  
nonIntegerKeyRaises ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_TestIOBuckets.py.html0100600000176200017510000000651407306455545031144 0ustar dhellmanndevel Class: TestIOBuckets

Table of Contents

Class: TestIOBuckets Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Base Classes   
BucketTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_TestIOSets.py.html0100600000176200017510000001442607306455545030463 0ustar dhellmanndevel Class: TestIOSets

Table of Contents

Class: TestIOSets Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Base Classes   
ExtendedSetTests
TestCase
Methods   
_insertfloatraises
_insertnoneraises
_insertstringraises
setUp
testNonIntegerInsertRaises
  _insertfloatraises  
_insertfloatraises ( self )

  _insertnoneraises  
_insertnoneraises ( self )

  _insertstringraises  
_insertstringraises ( self )

  setUp  
setUp ( self )

  testNonIntegerInsertRaises  
testNonIntegerInsertRaises ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_TestIOTreeSets.py.html0100600000176200017510000000641207306455545031277 0ustar dhellmanndevel Class: TestIOTreeSets

Table of Contents

Class: TestIOTreeSets Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Base Classes   
NormalSetTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_TestOIBTrees.py.html0100600000176200017510000001425107306455545030725 0ustar dhellmanndevel Class: TestOIBTrees

Table of Contents

Class: TestOIBTrees Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Base Classes   
BTreeTests
TestCase
Methods   
_floatraises
_noneraises
_stringraises
setUp
testNonIntegerValueRaises
  _floatraises  
_floatraises ( self )

  _noneraises  
_noneraises ( self )

  _stringraises  
_stringraises ( self )

  setUp  
setUp ( self )

  testNonIntegerValueRaises  
testNonIntegerValueRaises ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_TestOIBuckets.py.html0100600000176200017510000000651407306455545031144 0ustar dhellmanndevel Class: TestOIBuckets

Table of Contents

Class: TestOIBuckets Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Base Classes   
BucketTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_TestOISets.py.html0100600000176200017510000000652607306455545030465 0ustar dhellmanndevel Class: TestOISets

Table of Contents

Class: TestOISets Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Base Classes   
ExtendedSetTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_TestOITreeSets.py.html0100600000176200017510000000641207306455545031277 0ustar dhellmanndevel Class: TestOITreeSets

Table of Contents

Class: TestOITreeSets Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Base Classes   
NormalSetTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_TestOOBTrees.py.html0100600000176200017510000000651007306455545030732 0ustar dhellmanndevel Class: TestOOBTrees

Table of Contents

Class: TestOOBTrees Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Base Classes   
BTreeTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_TestOOBuckets.py.html0100600000176200017510000000651407306455545031152 0ustar dhellmanndevel Class: TestOOBuckets

Table of Contents

Class: TestOOBuckets Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Base Classes   
BucketTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_TestOOSets.py.html0100600000176200017510000000652607306455545030473 0ustar dhellmanndevel Class: TestOOSets

Table of Contents

Class: TestOOSets Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Base Classes   
ExtendedSetTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees_TestOOTreeSets.py.html0100600000176200017510000000641207306455545031305 0ustar dhellmanndevel Class: TestOOTreeSets

Table of Contents

Class: TestOOTreeSets Zope-2-CVS-src/lib/python/BTrees/tests/testBTrees.py

Base Classes   
NormalSetTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py.html0100600000176200017510000002754007306455546026754 0ustar dhellmanndevel Module: testConflict

Table of Contents

Module: testConflict Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Imported modules   
from BTrees.IIBTree import IIBTree, IIBucket, IISet, IITreeSet
from BTrees.IOBTree import IOBTree, IOBucket, IOSet, IOTreeSet
from BTrees.OIBTree import OIBTree, OIBucket, OISet, OITreeSet
from BTrees.OOBTree import OOBTree, OOBucket, OOSet, OOTreeSet
import os
import sys
import time
from unittest import TestCase, TestSuite, JUnitTextTestRunner, VerboseTextTestRunner, makeSuite
import whrandom
Functions   
debug
lsubtract
main
pdebug
realseq
test_merge
test_suite
  debug  
debug ()

  lsubtract  
lsubtract ( l1,  l2 )

  main  
main ()

  pdebug  
pdebug ()

  realseq  
realseq ( itemsob )

  test_merge  
test_merge (
        o1,
        o2,
        o3,
        expect,
        message='failed to merge',
        should_fail=0,
        )

  test_suite  
test_suite ()

Classes   
BTreeTests

Tests common to all BTrees

Base

Tests common to all types: sets, buckets, and BTrees

BucketTests

Tests common to all buckets

ExtendedSetTests

Set (as opposed to TreeSet) specific tests.

MappingBase

Tests common to mappings (buckets, btrees)

NormalSetTests

Test common to all set types

TestIIBTrees
TestIIBuckets
TestIISets
TestIITreeSets
TestIOBTrees
TestIOBuckets
TestIOSets
TestIOTreeSets
TestOIBTrees
TestOIBuckets
TestOISets
TestOITreeSets
TestOOBTrees
TestOOBuckets
TestOOSets
TestOOTreeSets

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_BTreeTests.py.html0100600000176200017510000000402607306455546031052 0ustar dhellmanndevel Class: BTreeTests

Table of Contents

Class: BTreeTests Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Tests common to all BTrees

Base Classes   
MappingBase

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_Base.py.html0100600000176200017510000001104107306455546027673 0ustar dhellmanndevel Class: Base

Table of Contents

Class: Base Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Tests common to all types: sets, buckets, and BTrees

Methods   
_closeDB
_delDB
_getRoot
tearDown
  _closeDB  
_closeDB ( self,  root )

  _delDB  
_delDB ( self )

  _getRoot  
_getRoot ( self )

  tearDown  
tearDown ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_BucketTests.py.html0100600000176200017510000000403107306455546031262 0ustar dhellmanndevel Class: BucketTests

Table of Contents

Class: BucketTests Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Tests common to all buckets

Base Classes   
MappingBase

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_ExtendedSetTests.py.html0100600000176200017510000002062007306455546032263 0ustar dhellmanndevel Class: ExtendedSetTests

Table of Contents

Class: ExtendedSetTests Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Set (as opposed to TreeSet) specific tests.

Base Classes   
NormalSetTests
Methods   
_setupConflict
testFailMergeDelete
testFailMergeInsert
testMergeDelete
testMergeEmpty
testMergeEmptyAndFill
testMergeInserts
testMergeInsertsFromEmpty
  _setupConflict  
_setupConflict ( self )

  testFailMergeDelete  
testFailMergeDelete ( self )

  testFailMergeInsert  
testFailMergeInsert ( self )

  testMergeDelete  
testMergeDelete ( self )

  testMergeEmpty  
testMergeEmpty ( self )

  testMergeEmptyAndFill  
testMergeEmptyAndFill ( self )

  testMergeInserts  
testMergeInserts ( self )

  testMergeInsertsFromEmpty  
testMergeInsertsFromEmpty ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_MappingBase.py.html0100600000176200017510000003026107306455546031214 0ustar dhellmanndevel Class: MappingBase

Table of Contents

Class: MappingBase Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Tests common to mappings (buckets, btrees)

Base Classes   
Base
Methods   
_deletefail
_setupConflict
testFailMergeDelete
testFailMergeDeleteAndUpdate
testFailMergeInsert
testFailMergeUpdate
testMergeDelete
testMergeDeleteAndUpdate
testMergeEmpty
testMergeEmptyAndFill
 testMergeInserts
testMergeInsertsFromEmpty
testMergeUpdate
  _deletefail  
_deletefail ( self )

  _setupConflict  
_setupConflict ( self )

  testFailMergeDelete  
testFailMergeDelete ( self )

  testFailMergeDeleteAndUpdate  
testFailMergeDeleteAndUpdate ( self )

  testFailMergeInsert  
testFailMergeInsert ( self )

  testFailMergeUpdate  
testFailMergeUpdate ( self )

  testMergeDelete  
testMergeDelete ( self )

  testMergeDeleteAndUpdate  
testMergeDeleteAndUpdate ( self )

  testMergeEmpty  
testMergeEmpty ( self )

  testMergeEmptyAndFill  
testMergeEmptyAndFill ( self )

  testMergeInserts  
testMergeInserts ( self )

  testMergeInsertsFromEmpty  
testMergeInsertsFromEmpty ( self )

  testMergeUpdate  
testMergeUpdate ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_NormalSetTests.py.html0100600000176200017510000000372407306455546031761 0ustar dhellmanndevel Class: NormalSetTests

Table of Contents

Class: NormalSetTests Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Test common to all set types

Base Classes   
Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_TestIIBTrees.py.html0100600000176200017510000000652007306455546031275 0ustar dhellmanndevel Class: TestIIBTrees

Table of Contents

Class: TestIIBTrees Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Base Classes   
BTreeTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_TestIIBuckets.py.html0100600000176200017510000000652407306455546031515 0ustar dhellmanndevel Class: TestIIBuckets

Table of Contents

Class: TestIIBuckets Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Base Classes   
BucketTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_TestIISets.py.html0100600000176200017510000000653607306455546031036 0ustar dhellmanndevel Class: TestIISets

Table of Contents

Class: TestIISets Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Base Classes   
ExtendedSetTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_TestIITreeSets.py.html0100600000176200017510000000642007306455546031646 0ustar dhellmanndevel Class: TestIITreeSets

Table of Contents

Class: TestIITreeSets Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Base Classes   
NormalSetTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_TestIOBTrees.py.html0100600000176200017510000000652007306455546031303 0ustar dhellmanndevel Class: TestIOBTrees

Table of Contents

Class: TestIOBTrees Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Base Classes   
BTreeTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_TestIOBuckets.py.html0100600000176200017510000000652407306455546031523 0ustar dhellmanndevel Class: TestIOBuckets

Table of Contents

Class: TestIOBuckets Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Base Classes   
BucketTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_TestIOSets.py.html0100600000176200017510000000653607306455546031044 0ustar dhellmanndevel Class: TestIOSets

Table of Contents

Class: TestIOSets Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Base Classes   
ExtendedSetTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_TestIOTreeSets.py.html0100600000176200017510000000642007306455546031654 0ustar dhellmanndevel Class: TestIOTreeSets

Table of Contents

Class: TestIOTreeSets Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Base Classes   
NormalSetTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_TestOIBTrees.py.html0100600000176200017510000000652007306455546031303 0ustar dhellmanndevel Class: TestOIBTrees

Table of Contents

Class: TestOIBTrees Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Base Classes   
BTreeTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_TestOIBuckets.py.html0100600000176200017510000000652407306455546031523 0ustar dhellmanndevel Class: TestOIBuckets

Table of Contents

Class: TestOIBuckets Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Base Classes   
BucketTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_TestOISets.py.html0100600000176200017510000000653607306455546031044 0ustar dhellmanndevel Class: TestOISets

Table of Contents

Class: TestOISets Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Base Classes   
ExtendedSetTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_TestOITreeSets.py.html0100600000176200017510000000642007306455546031654 0ustar dhellmanndevel Class: TestOITreeSets

Table of Contents

Class: TestOITreeSets Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Base Classes   
NormalSetTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_TestOOBTrees.py.html0100600000176200017510000000652007306455546031311 0ustar dhellmanndevel Class: TestOOBTrees

Table of Contents

Class: TestOOBTrees Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Base Classes   
BTreeTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_TestOOBuckets.py.html0100600000176200017510000000652407306455546031531 0ustar dhellmanndevel Class: TestOOBuckets

Table of Contents

Class: TestOOBuckets Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Base Classes   
BucketTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_TestOOSets.py.html0100600000176200017510000000653607306455546031052 0ustar dhellmanndevel Class: TestOOSets

Table of Contents

Class: TestOOSets Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Base Classes   
ExtendedSetTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/tests/testConflict_TestOOTreeSets.py.html0100600000176200017510000000642007306455546031662 0ustar dhellmanndevel Class: TestOOTreeSets

Table of Contents

Class: TestOOTreeSets Zope-2-CVS-src/lib/python/BTrees/tests/testConflict.py

Base Classes   
NormalSetTests
TestCase
Methods   
setUp
  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/IIBTree.py.html0100600000176200017510000000357207306455546024373 0ustar dhellmanndevel Module: IIBTree

Table of Contents

Module: IIBTree Zope-2-CVS-src/lib/python/BTrees/IIBTree.py

Imported modules   
from _IIBTree import *

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/IOBTree.py.html0100600000176200017510000000357207306455546024401 0ustar dhellmanndevel Module: IOBTree

Table of Contents

Module: IOBTree Zope-2-CVS-src/lib/python/BTrees/IOBTree.py

Imported modules   
from _IOBTree import *

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/Interfaces.py.html0100600000176200017510000001011007306455546025215 0ustar dhellmanndevel Module: Interfaces

Table of Contents

Module: Interfaces Zope-2-CVS-src/lib/python/BTrees/Interfaces.py

Imported modules   
import Interface
import Interface.Standard
import OOBTree
Classes   
IBTree
ICollection
IDictionaryIsh
IIMerge

Merge collections with integer value type.

IKeySequence
IKeyed
IMerge

Object with methods for merging sets, buckets, and trees.

IReadSequence
ISet
ISetMutable
ITreeSet

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/Interfaces_IBTree.py.html0100600000176200017510000000766207306455546026431 0ustar dhellmanndevel Class: IBTree

Table of Contents

Class: IBTree Zope-2-CVS-src/lib/python/BTrees/Interfaces.py

Base Classes   
IDictionaryIsh
Methods   
insert
  insert  
insert ( key,  value )

Insert a key and value into the collection.

If the key was already in the collection, then there is no change and 0 is returned.

If the key was not already in the collection, then the item is added and 1 is returned.

This method is here to allow one to generate random keys and to insert and test whether the key was there in one operation.

A standard idiom for generating new keys will be:

          key=generate_key()
          while not t.insert(key, value):
              key=generate_key()

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/Interfaces_ICollection.py.html0100600000176200017510000000763207306455546027520 0ustar dhellmanndevel Class: ICollection

Table of Contents

Class: ICollection Zope-2-CVS-src/lib/python/BTrees/Interfaces.py

Base Classes   
Interface.Base
Methods   
__nonzero__
clear
  __nonzero__  
__nonzero__ ()

Check if the collection is non-empty.

Return a true value if the collection is non-empty and a false otherwise.

  clear  
clear ()

Remove all of the items from the collection

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/Interfaces_IDictionaryIsh.py.html0100600000176200017510000001544507306455546030177 0ustar dhellmanndevel Class: IDictionaryIsh

Table of Contents

Class: IDictionaryIsh Zope-2-CVS-src/lib/python/BTrees/Interfaces.py

Base Classes   
IKeyed
Interface.Standard.MinimalDictionary
Methods   
byValue
items
update
values
  byValue  
byValue ( minValue )

Return a sequence of value-key pairs, sorted by value

Values < min are ommitted and other values are "normalized" by the minimum value. This normalization may be a noop, but, for integer values, the normalization is division.

  items  
items ( min=None,  max=None )

Return a IReadSequence containing the items in the collection

An item is a key-value tuple.

The type of the IReadSequence is not specified. It could be a list or a tuple or some other type.

If a min is specified, then output is constrained to items having keys greater than or equal to the given min. A min value of None is ignored.

If a max is specified, then output is constrained to items having keys less than or equal to the given min. A max value of None is ignored.

  update  
update ( collection )

Add the items from the given collection object to the collection

The input collection must be a sequence of key-value tuples, or an object with an items method that returns a sequence of key-value tuples.

  values  
values ( min=None,  max=None )

Return a IReadSequence containing the values in the collection

The type of the IReadSequence is not specified. It could be a list or a tuple or some other type.

If a min is specified, then output is constrained to items having keys greater than or equal to the given min. A min value of None is ignored.

If a max is specified, then output is constrained to items having keys less than or equal to the given min. A max value of None is ignored.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/Interfaces_IIMerge.py.html0100600000176200017510000001377107306455546026576 0ustar dhellmanndevel Class: IIMerge

Table of Contents

Class: IIMerge Zope-2-CVS-src/lib/python/BTrees/Interfaces.py

Merge collections with integer value type.

A primary intent is to support operations with no or integer values, which are used as "scores" to rate indiviual keys. That is, in this context, a BTree or Bucket is viewed as a set with scored keys, using integer scores.

Base Classes   
IMerge
    Interface.Base
Methods   
weightedIntersection
weightedUnion
  weightedIntersection  
weightedIntersection (
        c1,
        c2,
        weight1=1,
        weight2=1,
        )

Compute the weighted intersection of c1 and c2.

If c1 and c2 are None, the output is None, None.

if c1 is None and c2 is not None, the output is weight2 and c2.

if c1 is not None and c2 not None, the output is weight1 and c1.

If c1 and c2 are sets, the output is the sum of the weights and the (unweighted) intersection of the sets.

If c1 and c2 are not None and not both sets, the output is 1 and a Bucket such that the output values are:

          v1*weight1 + v2*weight2

          where:

            v1 is 0 if the key was not in c1. Otherwise, v1 is 1, if
            c1 is a set, or the value from c1.

            v2 is 0 if the key was not in c2. Otherwise, v2 is 2, if
            c2 is a set, or the value from c2.

Note that c1 and c2 must be collections. None may not be passed as one of the collections.

  weightedUnion  
weightedUnion (
        c1,
        c2,
        weight1=1,
        weight2=1,
        )

Compute the weighted Union of c1 and c2.

If c1 and c2 are None, the output is 0 and None

if c1 is None and c2 is not None, the output is weight2 and c2.

if c1 is not None and c2 not None, the output is weight1 and c1.

If c1 and c2 are not None, the output is 1 and a Bucket such that the output values are:

          v1*weight1 + v2*weight2

          where:

            v1 is 0 if the key was not in c1. Otherwise, v1 is 1, if
            c1 is a set, or the value from c1.

            v2 is 0 if the key was not in c2. Otherwise, v2 is 2, if
            c2 is a set, or the value from c2.

Note that c1 and c2 must be collections. None may not be passed as one of the collections.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/Interfaces_IKeySequence.py.html0100600000176200017510000000670607306455546027647 0ustar dhellmanndevel Class: IKeySequence

Table of Contents

Class: IKeySequence Zope-2-CVS-src/lib/python/BTrees/Interfaces.py

Base Classes   
IKeyed
Interface.Standard.Sized
Methods   
__getitem__
  __getitem__  
__getitem__ ( index )

Return the key in the given index position

This allows iteration with for loops and use in functions, like map and list, that read sequences.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/Interfaces_IKeyed.py.html0100600000176200017510000001364607306455546026470 0ustar dhellmanndevel Class: IKeyed

Table of Contents

Class: IKeyed Zope-2-CVS-src/lib/python/BTrees/Interfaces.py

Base Classes   
ICollection
    Interface.Base
Methods   
has_key
keys
maxKey
minKey
  has_key  
has_key ( key )

Check whether the object has an item with the given key

  keys  
keys ( min=None,  max=None )

Return an IReadSequence containing the keys in the collection

The type of the IReadSequence is not specified. It could be a list or a tuple or some other type.

If a min is specified, then output is constrained to items having keys greater than or equal to the given min. A min value of None is ignored.

If a max is specified, then output is constrained to items having keys less than or equal to the given min. A max value of None is ignored.

  maxKey  
maxKey ( key=None )

Return the maximum key

If a key argument if provided, return the largest key that is less than or equal to the argument.

  minKey  
minKey ( key=None )

Return the minimum key

If a key argument if provided, return the smallest key that is greater than or equal to the argument.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/Interfaces_IMerge.py.html0100600000176200017510000001331707306455546026461 0ustar dhellmanndevel Class: IMerge

Table of Contents

Class: IMerge Zope-2-CVS-src/lib/python/BTrees/Interfaces.py

Object with methods for merging sets, buckets, and trees.

These methods are supplied in modules that define collection classes with particular key and value types. The operations apply only to collections from the same module. For example, the IIBTree.union can only be used with IIBTree.IIBTree, IIBTree.IIBucket, IIBTree.IISet, and IIBTree.IITreeSet.

The implementing module has a value type. The IOBTree and OOBTree modules have object value type. The IIBTree and OIBTree modules have integer value tyoes. Other modules may be defined in the future that have other value types.

The individual types are classified into set (Set and TreeSet) and mapping (Bucket and BTree) types.

Base Classes   
Interface.Base
Methods   
difference
intersection
union
  difference  
difference ( c1,  c2 )

Return the keys or items in c1 for which there is no key in c2.

If c1 is None, then None is returned. If c2 is none, then c1 is returned.

  intersection  
intersection ( c1,  c2 )

Compute the Union of c1 and c2.

If c1 is None, then c2 is returned, otherwise, if c2 is None, then c1 is returned.

The output is a Set containing matching keys from the input collections.

  union  
union ( c1,  c2 )

Compute the Union of c1 and c2.

If c1 is None, then c2 is returned, otherwise, if c2 is None, then c1 is returned.

The output is a Set containing keys from the input collections.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/Interfaces_IReadSequence.py.html0100600000176200017510000000647207306455546027772 0ustar dhellmanndevel Class: IReadSequence

Table of Contents

Class: IReadSequence Zope-2-CVS-src/lib/python/BTrees/Interfaces.py

Base Classes   
Interface.Standard.Sequence
Methods   
__getslice__
  __getslice__  
__getslice__ ( index1,  index2 )

Return a subsequence from the original sequence

Such that the subsequence includes the items from index1 up to, but not including, index2.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/Interfaces_ISet.py.html0100600000176200017510000000457207306455546026160 0ustar dhellmanndevel Class: ISet

Table of Contents

Class: ISet Zope-2-CVS-src/lib/python/BTrees/Interfaces.py

Base Classes   
IKeySequence
ISetMutable

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/Interfaces_ISetMutable.py.html0100600000176200017510000001124507306455546027465 0ustar dhellmanndevel Class: ISetMutable

Table of Contents

Class: ISetMutable Zope-2-CVS-src/lib/python/BTrees/Interfaces.py

Base Classes   
IKeyed
Methods   
insert
remove
update
  insert  
insert ( key )

Add the key (value) to the set.

If the key was already in the set, return 0, otherwise return 1.

  remove  
remove ( key )

Remove the key from the set.

  update  
update ( seq )

Add the items from the given sequence to the set

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/Interfaces_ITreeSet.py.html0100600000176200017510000000443107306455546026772 0ustar dhellmanndevel Class: ITreeSet

Table of Contents

Class: ITreeSet Zope-2-CVS-src/lib/python/BTrees/Interfaces.py

Base Classes   
IKeyed
ISetMutable

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/Length.py.html0100600000176200017510000000515707306455546024372 0ustar dhellmanndevel Module: Length

Table of Contents

Module: Length Zope-2-CVS-src/lib/python/BTrees/Length.py

Imported modules   
import Persistence
Classes   
Length

BTree lengths are too expensive to compute

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/Length_Length.py.html0100600000176200017510000002036307306455546025667 0ustar dhellmanndevel Class: Length

Table of Contents

Class: Length Zope-2-CVS-src/lib/python/BTrees/Length.py

BTree lengths are too expensive to compute

Objects that use BTrees need to keep track of lengths themselves. This class provides an object for doing this.

As a bonus, the object support application-level conflict resolution.

Base Classes   
Persistence.Persistent
Methods   
__call__
__getstate__
__init__
__setstate__
_p_independent
_p_resolveConflict
change
set
  __call__  
__call__ ( self,  *args )

  __getstate__  
__getstate__ ( self )

  __init__  
__init__ ( self,  v=0 )

  __setstate__  
__setstate__ ( self,  v )

  _p_independent  
_p_independent ( self )

  _p_resolveConflict  
_p_resolveConflict (
        self,
        old,
        s1,
        s2,
        )

  change  
change ( self,  delta )

  set  
set ( self,  v )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/OIBTree.py.html0100600000176200017510000000357207306455546024401 0ustar dhellmanndevel Module: OIBTree

Table of Contents

Module: OIBTree Zope-2-CVS-src/lib/python/BTrees/OIBTree.py

Imported modules   
from _OIBTree import *

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/OOBTree.py.html0100600000176200017510000000357207306455546024407 0ustar dhellmanndevel Module: OOBTree

Table of Contents

Module: OOBTree Zope-2-CVS-src/lib/python/BTrees/OOBTree.py

Imported modules   
from _OOBTree import *

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/__init__.py.html0100600000176200017510000000355307306455546024706 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/BTrees/__init__.py

Imported modules   
import ZODB

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/BTrees/convert.py.html0100600000176200017510000000511007306455546024616 0ustar dhellmanndevel Module: convert

Table of Contents

Module: convert Zope-2-CVS-src/lib/python/BTrees/convert.py

Functions   
convert
  convert  
convert (
        old,
        new,
        threshold=200,
        f=None,
        None=None,
        )

Utility for converting old btree to new

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DateTime/0040700000176200017510000000000007306455547022136 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DateTime/index.html0100600000176200017510000000471407306455547024140 0ustar dhellmanndevel Zope2 CVS with ZEO: DateTime

Table of Contents

Zope2 CVS with ZEO: DateTime  
Modules and Packages   

Zope-2-CVS-src/lib/python/DateTime/

DateTime

Encapsulation of date/time values

DateTimeZone
__init__

Zope-2-CVS-src/lib/python/DateTime/tests/

testDateTime

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:17 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DateTime/DateTime.py.html0100600000176200017510000004007707306455547025156 0ustar dhellmanndevel Module: DateTime

Table of Contents

Module: DateTime Zope-2-CVS-src/lib/python/DateTime/DateTime.py

Encapsulation of date/time values

Imported modules   
import DateTimeZone
import math
import os
import re
from string import strip, split, upper, lower, atoi, atof, find, join
import sys
from time import time, gmtime, localtime, asctime, timezone, strftime, mktime, daylight, altzone
from types import InstanceType, IntType, FloatType, StringType
Functions   
Timezones
_calcDependentSecond
_calcDependentSecond2
_calcHMS
_calcIndependentSecondEtc
_calcSD
_calcYMDHMS
_calendarday
_correctYear
_findLocalTimeZoneName
 _julianday
_tzoffset
safegmtime
safelocaltime
  Timezones  
Timezones ()

Return the list of recognized timezone names

Module methods

  _calcDependentSecond  
_calcDependentSecond ( tz,  t )

  _calcDependentSecond2  
_calcDependentSecond2 (
        yr,
        mo,
        dy,
        hr,
        mn,
        sc,
        )

  _calcHMS  
_calcHMS ( x,  ms )

  _calcIndependentSecondEtc  
_calcIndependentSecondEtc (
        tz,
        x,
        ms,
        )

  _calcSD  
_calcSD ( t )

  _calcYMDHMS  
_calcYMDHMS ( x,  ms )

  _calendarday  
_calendarday ( j )

  _correctYear  
_correctYear ( year )

  _findLocalTimeZoneName  
_findLocalTimeZoneName ( isDST )

  _julianday  
_julianday (
        yr,
        mo,
        dy,
        )

  _tzoffset  
_tzoffset ( tz,  t )

  safegmtime  
safegmtime ( t )

gmtime with a safety zone.

Exceptions   
'TimeError', 'The time %f is beyond the range ' 'of this Python implementation.' % float( t )
  safelocaltime  
safelocaltime ( t )

localtime with a safety zone.

Exceptions   
'TimeError', 'The time %f is beyond the range ' 'of this Python implementation.' % float( t )
Classes   
DateTime

DateTime objects represent instants in time and provide

_cache
_timezone
strftimeFormatter

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:17 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DateTime/DateTime_DateTime.py.html0100600000176200017510000020630607306455547026731 0ustar dhellmanndevel Class: DateTime

Table of Contents

Class: DateTime Zope-2-CVS-src/lib/python/DateTime/DateTime.py

DateTime objects represent instants in time and provide interfaces for controlling its representation without affecting the absolute value of the object.

DateTime objects may be created from a wide variety of string or numeric data, or may be computed from other DateTime objects. DateTimes support the ability to convert their representations to many major timezones, as well as the ablility to create a DateTime object in the context of a given timezone.

DateTime objects provide partial numerical behavior:

  • Two date-time objects can be subtracted to obtain a time, in days between the two.

  • A date-time object and a positive or negative number may be added to obtain a new date-time object that is the given number of days later than the input date-time object.

  • A positive or negative number and a date-time object may be added to obtain a new date-time object that is the given number of days later than the input date-time object.

  • A positive or negative number may be subtracted from a date-time object to obtain a new date-time object that is the given number of days earlier than the input date-time object.

DateTime objects may be converted to integer, long, or float numbers of days since January 1, 1901, using the standard int, long, and float functions (Compatibility Note: int, long and float return the number of days since 1901 in GMT rather than local machine timezone). DateTime objects also provide access to their value in a float format usable with the python time module, provided that the value of the object falls in the range of the epoch-based time module.

A DateTime object should be considered immutable; all conversion and numeric operations return a new DateTime object rather than modify the current object.

Methods   
AMPM
AMPMMinutes
Date
Day
DayOfWeek
Day_
HTML4
ISO
Mon
Mon_
Month
PreciseAMPM
PreciseTime
Time
TimeMinutes
__add__
__cmp__
__float__
__getattr__
__getinitargs__
__hash__
__init__
__int__
__long__
__repr__
__str__
__sub__
 _calcTimezoneName
_parse
_validDate
_validTime
aCommon
aCommonZ
aDay
aMonth
ampm
day
dayOfYear
dd
debugCompare
dow
dow_1
earliestTime
equalTo
fCommon
fCommonZ
greaterThan
greaterThanEqualTo
h_12
h_24
hour
isCurrentDay
isCurrentHour
isCurrentMinute
 isCurrentMonth
isCurrentYear
isFuture
isLeapYear
isPast
latestTime
lessThan
lessThanEqualTo
localZone
millis
minute
mm
month
notEqualTo
pCommon
pCommonZ
pDay
pMonth
parts
rfc822
second
strftime
timeTime
timezone
toZone
year
yy
  AMPM  
AMPM ( self )

Return the time string for an object to the nearest second.

  AMPMMinutes  
AMPMMinutes ( self )

Return the time string for an object not showing seconds.

  Date  
Date ( self )

Return the date string for the object.

General formats from previous DateTime

  Day  
Day ( self )

Return the full name of the day of the week

  DayOfWeek  
DayOfWeek ( self )

Compatibility: see Day

  Day_  
Day_ ( self )

Compatibility: see pDay

  HTML4  
HTML4 ( self )

Return the object in the format used in the HTML4.0 specification, one of the standard forms in ISO8601. See http://www.w3.org/TR/NOTE-datetime

Dates are output as: YYYY-MM-DDTHH:MM:SSZ T, Z are literal characters. The time is in UTC.

  ISO  
ISO ( self )

Return the object in ISO standard format

Dates are output as: YYYY-MM-DD HH:MM:SS

  Mon  
Mon ( self )

Compatibility: see aMonth

  Mon_  
Mon_ ( self )

Compatibility: see pMonth

  Month  
Month ( self )

Return the full month name

  PreciseAMPM  
PreciseAMPM ( self )

Return the time string for the object.

  PreciseTime  
PreciseTime ( self )

Return the time string for the object.

  Time  
Time ( self )

Return the time string for an object to the nearest second.

  TimeMinutes  
TimeMinutes ( self )

Return the time string for an object not showing seconds.

  __add__  
__add__ ( self,  other )

A DateTime may be added to a number and a number may be added to a DateTime; two DateTimes cannot be added.

Exceptions   
self.DateTimeError, 'Cannot add two DateTimes'
  __cmp__  
__cmp__ ( self,  obj )

Compare a DateTime with another DateTime object, or a float such as those returned by time.time().

NOTE: __cmp__ support is provided for backward compatibility only, and mixing DateTimes with ExtensionClasses could cause __cmp__ to break. You should use the methods lessThan, greaterThan, lessThanEqualTo, greaterThanEqualTo, equalTo and notEqualTo to avoid potential problems later!!

  __float__  
__float__ ( self )

Convert to floating-point number of seconds since the epoch (gmt)

  __getattr__  
__getattr__ ( self,  name )

Exceptions   
AttributeError, name
  __getinitargs__  
__getinitargs__ ( self )

Internal methods

  __hash__  
__hash__ ( self )

Compute a hash value for a DateTime

  __init__  
__init__ ( self,  *args )

Exceptions   
self.DateTimeError, 'Invalid date: %s' % arg
self.DateTimeError, 'Invalid date: %s' %( args, )
self.DateTimeError, 'Invalid time: %s' % ` args `
self.DateTimeError, 'Invalid time: %s' % arg
self.DateTimeError, 'Too many arguments'
self.DateTimeError, 'Unknown time zone in date: %s' % arg
self.DateTimeError, 'Unknown time zone: %s' % tz
self.SyntaxError, arg
  __int__  
__int__ ( self )

Convert to an integer number of seconds since the epoch (gmt)

  __long__  
__long__ ( self )

Convert to a long-int number of seconds since the epoch (gmt)

  __repr__  
__repr__ ( self )

Convert a DateTime to a string that looks like a Python expression.

  __str__  
__str__ ( self )

Convert a DateTime to a string.

  __sub__  
__sub__ ( self,  other )

Either a DateTime or a number may be subtracted from a DateTime, however, a DateTime may not be subtracted from a number.

  _calcTimezoneName  
_calcTimezoneName (
        self,
        x,
        ms,
        )

  _parse  
_parse ( self,  string )

Exceptions   
self.DateError, string
self.DateTimeError, string
self.SyntaxError, string
  _validDate  
_validDate (
        self,
        y,
        m,
        d,
        )

  _validTime  
_validTime (
        self,
        h,
        m,
        s,
        )

  aCommon  
aCommon ( self )

Return a string representing the object's value in the format: Mar 1, 1997 1:45 pm

  aCommonZ  
aCommonZ ( self )

Return a string representing the object's value in the format: Mar 1, 1997 1:45 pm US/Eastern

  aDay  
aDay ( self )

Return the abreviated name of the day of the week

  aMonth  
aMonth ( self )

Return the abreviated month name.

  ampm  
ampm ( self )

Return the appropriate time modifier (am or pm)

  day  
day ( self )

Return the integer day

  dayOfYear  
dayOfYear ( self )

Return the day of the year, in context of the timezone representation of the object

  dd  
dd ( self )

Return day as a 2 digit string

  debugCompare  
debugCompare ( self,  dt )

Compares the internal representation of the date with the representation in dt. Allows sub-millisecond variations. Primarily for testing.

  dow  
dow ( self )

Return the integer day of the week, where sunday is 0

  dow_1  
dow_1 ( self )

Return the integer day of the week, where sunday is 1

  earliestTime  
earliestTime ( self )

Return a new DateTime object that represents the earliest possible time (in whole seconds) that still falls within the current object's day, in the object's timezone context

  equalTo  
equalTo ( self,  t )

Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time equal to the specified DateTime or time module style time. Revised to give more correct results through comparison of long integer milliseconds.

  fCommon  
fCommon ( self )

Return a string representing the object's value in the format: March 1, 1997 1:45 pm

New formats

  fCommonZ  
fCommonZ ( self )

Return a string representing the object's value in the format: March 1, 1997 1:45 pm US/Eastern

  greaterThan  
greaterThan ( self,  t )

Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time greater than the specified DateTime or time module style time. Revised to give more correct results through comparison of long integer milliseconds.

  greaterThanEqualTo  
greaterThanEqualTo ( self,  t )

Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time greater than or equal to the specified DateTime or time module style time. Revised to give more correct results through comparison of long integer milliseconds.

  h_12  
h_12 ( self )

Return the 12-hour clock representation of the hour

  h_24  
h_24 ( self )

Return the 24-hour clock representation of the hour

  hour  
hour ( self )

Return the 24-hour clock representation of the hour

  isCurrentDay  
isCurrentDay ( self )

Return true if this object represents a date/time that falls within the current day, in the context of this object's timezone representation

  isCurrentHour  
isCurrentHour ( self )

Return true if this object represents a date/time that falls within the current hour, in the context of this object's timezone representation

  isCurrentMinute  
isCurrentMinute ( self )

Return true if this object represents a date/time that falls within the current minute, in the context of this object's timezone representation

  isCurrentMonth  
isCurrentMonth ( self )

Return true if this object represents a date/time that falls within the current month, in the context of this object's timezone representation

  isCurrentYear  
isCurrentYear ( self )

Return true if this object represents a date/time that falls within the current year, in the context of this object's timezone representation

  isFuture  
isFuture ( self )

Return true if this object represents a date/time later than the time of the call

  isLeapYear  
isLeapYear ( self )

Return true if the current year (in the context of the object's timezone) is a leap year

  isPast  
isPast ( self )

Return true if this object represents a date/time earlier than the time of the call

  latestTime  
latestTime ( self )

Return a new DateTime object that represents the latest possible time (in whole seconds) that still falls within the current object's day, in the object's timezone context

  lessThan  
lessThan ( self,  t )

Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time less than the specified DateTime or time module style time. Revised to give more correct results through comparison of long integer milliseconds.

  lessThanEqualTo  
lessThanEqualTo ( self,  t )

Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time less than or equal to the specified DateTime or time module style time. Revised to give more correct results through comparison of long integer milliseconds.

  localZone  
localZone ( self,  ltm=None )

Returns the time zone on the given date. The time zone can change according to daylight savings.

  millis  
millis ( self )

Return the millisecond since the epoch in GMT.

  minute  
minute ( self )

Return the minute

  mm  
mm ( self )

Return month as a 2 digit string

  month  
month ( self )

Return the month of the object as an integer

  notEqualTo  
notEqualTo ( self,  t )

Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time not equal to the specified DateTime or time module style time. Revised to give more correct results through comparison of long integer milliseconds.

  pCommon  
pCommon ( self )

Return a string representing the object's value in the format: Mar. 1, 1997 1:45 pm

  pCommonZ  
pCommonZ ( self )

Return a string representing the object's value in the format: Mar. 1, 1997 1:45 pm US/Eastern

  pDay  
pDay ( self )

Return the abreviated (with period) name of the day of the week

  pMonth  
pMonth ( self )

Return the abreviated (with period) month name.

  parts  
parts ( self )

Return a tuple containing the calendar year, month, day, hour, minute second and timezone of the object

Component access

  rfc822  
rfc822 ( self )

Return the date in RFC 822 format

  second  
second ( self )

Return the second

  strftime  
strftime ( self,  format )

  timeTime  
timeTime ( self )

Return the date/time as a floating-point number in UTC, in the format used by the python time module. Note that it is possible to create date/time values with DateTime that have no meaningful value to the time module.

Conversion and comparison methods

  timezone  
timezone ( self )

Return the timezone in which the object is represented.

  toZone  
toZone ( self,  z )

Return a DateTime with the value as the current object, represented in the indicated timezone.

  year  
year ( self )

Return the calendar year of the object

  yy  
yy ( self )

Return calendar year as a 2 digit string

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:17 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DateTime/DateTime__cache.py.html0100600000176200017510000000755107306455547026440 0ustar dhellmanndevel Class: _cache

Table of Contents

Class: _cache Zope-2-CVS-src/lib/python/DateTime/DateTime.py

Methods   
__getitem__
__init__
  __getitem__  
__getitem__ ( self,  k )

Exceptions   
'DateTimeError', 'Unrecognized timezone: %s' % k
  __init__  
__init__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:17 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DateTime/DateTime__timezone.py.html0100600000176200017510000001104307306455547027216 0ustar dhellmanndevel Class: _timezone

Table of Contents

Class: _timezone Zope-2-CVS-src/lib/python/DateTime/DateTime.py

Methods   
__init__
default_index
index
info
  __init__  
__init__ ( self,  data )

  default_index  
default_index ( self )

  index  
index ( self,  t=None )

  info  
info ( self,  t=None )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:17 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DateTime/DateTime_strftimeFormatter.py.html0100600000176200017510000000635107306455547030754 0ustar dhellmanndevel Class: strftimeFormatter

Table of Contents

Class: strftimeFormatter Zope-2-CVS-src/lib/python/DateTime/DateTime.py

Methods   
__call__
__init__
  __call__  
__call__ ( self )

  __init__  
__init__ (
        self,
        dt,
        format,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:17 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DateTime/DateTimeZone.py.html0100600000176200017510000000244407306455547026006 0ustar dhellmanndevel Module: DateTimeZone

Table of Contents

Module: DateTimeZone Zope-2-CVS-src/lib/python/DateTime/DateTimeZone.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:17 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DateTime/__init__.py.html0100600000176200017510000000400107306455547025204 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/DateTime/__init__.py

Imported modules   
from DateTime import DateTime, Timezones

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:17 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DateTime/tests/0040700000176200017510000000000007306455547023300 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DateTime/tests/testDateTime.py.html0100600000176200017510000001006207306455547027207 0ustar dhellmanndevel Module: testDateTime

Table of Contents

Module: testDateTime Zope-2-CVS-src/lib/python/DateTime/tests/testDateTime.py

Imported modules   
from DateTime import DateTime
import string
import unittest
Functions   
test_suite
  test_suite  
test_suite ()

Classes   
DateTimeTests

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:17 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DateTime/tests/testDateTime_DateTimeTests.py.html0100600000176200017510000003662207306455547032020 0ustar dhellmanndevel Class: DateTimeTests

Table of Contents

Class: DateTimeTests Zope-2-CVS-src/lib/python/DateTime/tests/testDateTime.py

Base Classes   
unittest.TestCase
Methods   
testAddPrecision
testBug1203
testConstructor3
testConstructor4
testConstructor5
testConstructor6
testConstructor7
testDSTInEffect
testDSTNotInEffect
testDayOfWeek
 testOldDate
testSubtraction
testTZ1add
testTZ1diff
testTZ1sub
testTZ2
testTZDiffDaylight
testY10KDate
  testAddPrecision  
testAddPrecision ( self )

Precision of serial additions

  testBug1203  
testBug1203 ( self )

01:59:60 occurred in old DateTime

  testConstructor3  
testConstructor3 ( self )

Constructor from date/time string

  testConstructor4  
testConstructor4 ( self )

Constructor from time float

  testConstructor5  
testConstructor5 ( self )

Constructor from time float and timezone

  testConstructor6  
testConstructor6 ( self )

Constructor from year and julian date

  testConstructor7  
testConstructor7 ( self )

Constructor from parts

  testDSTInEffect  
testDSTInEffect ( self )

Checks GMT offset for a DST date in the US/Eastern time zone

  testDSTNotInEffect  
testDSTNotInEffect ( self )

Checks GMT offset for a non-DST date in the US/Eastern time zone

  testDayOfWeek  
testDayOfWeek ( self )

strftime() used to always be passed a day of week of 0.

  testOldDate  
testOldDate ( self )

Fails when an 1800 date is displayed with negative signs

  testSubtraction  
testSubtraction ( self )

Reconstruction of a DateTime from its parts, with subtraction

  testTZ1add  
testTZ1add ( self )

Time zone manipulation: add to a date

  testTZ1diff  
testTZ1diff ( self )

Time zone manipulation: diff two dates

  testTZ1sub  
testTZ1sub ( self )

Time zone manipulation: subtract from a date

  testTZ2  
testTZ2 ( self )

Time zone manipulation test 2

  testTZDiffDaylight  
testTZDiffDaylight ( self )

Diff dates across daylight savings dates

  testY10KDate  
testY10KDate ( self )

Comparison of a Y10K date and a Y2K date

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:17 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/0040700000176200017510000000000007306455550023706 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/index.html0100600000176200017510000001104007306455551025677 0ustar dhellmanndevel Zope2 CVS with ZEO: DocumentTemplate

Table of Contents

Zope2 CVS with ZEO: DocumentTemplate  
Modules and Packages   

Zope-2-CVS-src/lib/python/DocumentTemplate/

DT_HTML

HTML formated DocumentTemplates

DT_If
DT_InSV
DT_Let

The Let tag was contributed to Zope by and is copyright, 1999

DT_Raise

Raising exceptions

DT_Return
DT_String

$Id: DT_String.py,v 1.45 2001/05/30 15:57:30 andreas Exp $

DT_Try
DT_UI
DT_Util

$Id: DT_Util.py,v 1.77 2001/05/16 19:07:02 evan Exp $

DT_Var
DT_With

Nested namespace access

DTtestExpr
DocumentTemplate

Document templates with fill-in fields

__init__
pDocumentTemplate
sequence

Zope2 CVS with ZEO: DocumentTemplate.sequence

tests

Python package.

ts_regex

Provide a thread-safe interface to regex

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/0040700000176200017510000000000007306455547025524 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/index.html0100600000176200017510000000525607306455547027530 0ustar dhellmanndevel Zope2 CVS with ZEO: DocumentTemplate.sequence

Table of Contents

Zope2 CVS with ZEO: DocumentTemplate.sequence  
Modules and Packages   

Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/

SortEx

Advanced sort support by Oleg Broytmann <phd@@phd.pp.ru> 23 Apr 2001

__init__

Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/tests/

results
testSequence
ztestlib

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/SortEx.py.html0100600000176200017510000001666607306455547030303 0ustar dhellmanndevel Module: SortEx

Table of Contents

Module: SortEx Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/SortEx.py

Advanced sort support by Oleg Broytmann <phd@@phd.pp.ru> 23 Apr 2001 eg Sort(sequence, (("akey", "nocase"), ("anotherkey", "cmp", "desc")))

$Id: SortEx.py,v 1.2 2001/05/23 14:42:08 andreas Exp $

Imported modules   
from string import lower
import sys
Functions   
make_sortfunctions
nocase
sort
  make_sortfunctions  
make_sortfunctions ( sortfields,  _ )

Accepts a list of sort fields; splits every field, finds comparison function. Returns a list of 3-tuples (field, cmp_function, asc_multplier)

Exceptions   
SyntaxError, "sort oder must be either ASC or DESC"
SyntaxError, "sort option must contains no more than 2 fields"
  nocase  
nocase ( str1,  str2 )

  sort  
sort (
        sequence,
        sort=(),
        _=None,
        mapping=0,
        )

  • sequence is a sequence of objects to be sorted

    • sort is a sequence of tuples (key,func,direction) that define the sort order:

      • key is the name of an attribute to sort the objects by

      • func is the name of a comparison function. This parameter is optional

        allowed values:

        • "cmp" -- the standard comparison function (default)

        • "nocase" -- case-insensitive comparison

        • "strcoll" or "locale" -- locale-aware string comparison

        • "strcoll_nocase" or "locale_nocase" -- locale-aware case-insensitive string comparison

        • "xxx" -- a user-defined comparison function

      • direction -- defines the sort direction for the key (optional). (allowed values: "asc" (default) , "desc")

Classes   
SortBy

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/SortEx_SortBy.py.html0100600000176200017510000000643007306455547031571 0ustar dhellmanndevel Class: SortBy

Table of Contents

Class: SortBy Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/SortEx.py

Methods   
__call__
__init__
  __call__  
__call__ (
        self,
        o1,
        o2,
        )

  __init__  
__init__ (
        self,
        multsort,
        sf_list,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/__init__.py.html0100600000176200017510000000366107306455547030605 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/__init__.py

Imported modules   
from SortEx import *

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/tests/0040700000176200017510000000000007306455547026666 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/tests/results.py.html0100600000176200017510000000247007306455547031706 0ustar dhellmanndevel Module: results

Table of Contents

Module: results Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/tests/results.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/tests/testSequence.py.html0100600000176200017510000001420407306455547032653 0ustar dhellmanndevel Module: testSequence

Table of Contents

Module: testSequence Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/tests/testSequence.py

Imported modules   
from SortEx import *
from results import *
import sys
import unittest
from ztestlib import *
Functions   
debug
main
pdebug
test_suite
  debug  
debug ()

  main  
main ()

  pdebug  
pdebug ()

  test_suite  
test_suite ()

Classes   
TestCase

Test SortEx .

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/tests/testSequence_TestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/tests/testSequence_TestCase.0100600000176200017510000002031207306455547033127 0ustar dhellmanndevel Class: TestCase

Table of Contents

Class: TestCase Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/tests/testSequence.py

Test SortEx .

Base Classes   
unittest.TestCase
Methods   
setUp
tearDown
test1
test2
test3
test4
test5
test6
test7
  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

  test1  
test1 ( self )

test1

  test2  
test2 ( self )

test2

  test3  
test3 ( self )

test3

  test4  
test4 ( self )

test4

  test5  
test5 ( self )

test5

  test6  
test6 ( self )

test6

  test7  
test7 ( self )

test7

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/tests/ztestlib.py.html0100600000176200017510000000763307306455547032053 0ustar dhellmanndevel Module: ztestlib

Table of Contents

Module: ztestlib Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/tests/ztestlib.py

Functions   
exception
test
  exception  
exception ()

  test  
test ( s )

Classes   
standard_html

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/tests/ztestlib_standard_html.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/tests/ztestlib_standard_html0100600000176200017510000000505307306455547033357 0ustar dhellmanndevel Class: standard_html

Table of Contents

Class: standard_html Zope-2-CVS-src/lib/python/DocumentTemplate/sequence/tests/ztestlib.py

Methods   
__init__
  __init__  
__init__ ( self,  title )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/tests/0040700000176200017510000000000007306455547025056 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/tests/index.html0100600000176200017510000000424107306455547027053 0ustar dhellmanndevel Zope2 CVS with ZEO: DocumentTemplate.tests

Table of Contents

Zope2 CVS with ZEO: DocumentTemplate.tests  
Modules and Packages   

Zope-2-CVS-src/lib/python/DocumentTemplate/tests/

__init__

Python package.

testDTML

Document Template Tests

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:24 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/tests/__init__.py.html0100600000176200017510000000242507306455547030134 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/DocumentTemplate/tests/__init__.py

Python package.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:24 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/tests/testDTML.py.html0100600000176200017510000001675607306455547030051 0ustar dhellmanndevel Module: testDTML

Table of Contents

Module: testDTML Zope-2-CVS-src/lib/python/DocumentTemplate/tests/testDTML.py

Document Template Tests

Imported modules   
from DocumentTemplate import HTML, String
from ExtensionClass import Base
import os
import sys
import unittest
Functions   
d
debug
main
pdebug
read_file
test_suite
  d  
d ( **kw )

  debug  
debug ()

  main  
main ()

  pdebug  
pdebug ()

  read_file  
read_file ( name )

  test_suite  
test_suite ()

Classes   
D
DTMLTests

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:24 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/tests/testDTML_D.py.html0100600000176200017510000000626707306455547030310 0ustar dhellmanndevel Class: D

Table of Contents

Class: D Zope-2-CVS-src/lib/python/DocumentTemplate/tests/testDTML.py

Methods   
__init__
__repr__
  __init__  
__init__ ( self,  **kw )

  __repr__  
__repr__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:24 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/tests/testDTML_DTMLTests.py.html0100600000176200017510000003702107306455547031700 0ustar dhellmanndevel Class: DTMLTests

Table of Contents

Class: DTMLTests Zope-2-CVS-src/lib/python/DocumentTemplate/tests/testDTML.py

Base Classes   
unittest.TestCase
Methods   
checkBasicHTMLIn
checkBasicHTMLIn2
checkBasicStringIn
checkBatchingEtc
checkDTMLDateFormatting
checkHTMLInElse
checkNull
checkPropogatedError
checkRaise
checkRenderCallable
 checkSequence1
checkSequence2
checkSequenceSummaries
checkSimpleString
checkStringDateFormatting
checkWith
check_fmt
  checkBasicHTMLIn  
checkBasicHTMLIn ( self )

  checkBasicHTMLIn2  
checkBasicHTMLIn2 ( self )

  checkBasicStringIn  
checkBasicStringIn ( self )

  checkBatchingEtc  
checkBatchingEtc ( self )

  checkDTMLDateFormatting  
checkDTMLDateFormatting ( self )

  checkHTMLInElse  
checkHTMLInElse ( self )

  checkNull  
checkNull ( self )

  checkPropogatedError  
checkPropogatedError ( self )

Exceptions   
'Puke', 'raaalf'
IndexError, i
  checkRaise  
checkRaise ( self )

  checkRenderCallable  
checkRenderCallable ( self )

Test automatic rendering of callable objects

  checkSequence1  
checkSequence1 ( self )

  checkSequence2  
checkSequence2 ( self )

  checkSequenceSummaries  
checkSequenceSummaries ( self )

  checkSimpleString  
checkSimpleString ( self )

  checkStringDateFormatting  
checkStringDateFormatting ( self )

  checkWith  
checkWith ( self )

  check_fmt  
check_fmt ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:24 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_HTML.py.html0100600000176200017510000000735307306455550026365 0ustar dhellmanndevel Module: DT_HTML

Table of Contents

Module: DT_HTML Zope-2-CVS-src/lib/python/DocumentTemplate/DT_HTML.py

HTML formated DocumentTemplates

$Id: DT_HTML.py,v 1.29 2001/05/25 11:34:56 andreas Exp $

Imported modules   
import DT_String
from DT_String import String, FileMixin
from DT_Util import ParseError, str
import re
from string import strip, find, split, join, rfind, replace
Classes   
HTML

HTML Document Templates

HTMLDefault

HTML document templates that edit themselves through copy.

HTMLFile

HTML Document templates read from files.

dtml_re_class

This needs to be replaced before 2.4. It's a hackaround.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_HTML_HTML.py.html0100600000176200017510000002507407306455547027217 0ustar dhellmanndevel Class: HTML

Table of Contents

Class: HTML Zope-2-CVS-src/lib/python/DocumentTemplate/DT_HTML.py

HTML Document Templates

HTML Document templates use HTML server-side-include syntax, rather than Python format-string syntax. Here's a simple example:

      &lt;!--#in results--&gt;
        &lt;!--#var name--&gt;
      &lt;!--#/in--&gt;

HTML document templates quote HTML tags in source when the template is converted to a string. This is handy when templates are inserted into HTML editing forms.

Base Classes   
DT_String.String
Methods   
SubTemplate
__str__
manage_edit
manage_editForm
management_interface
parseTag
quotedHTML
tagre
varExtra
  SubTemplate  
SubTemplate ( self,  name )

  __str__  
__str__ ( self )

  manage_edit  
manage_edit (
        self,
        data,
        REQUEST=None,
        )

edit a template

  manage_editForm  
manage_editForm (
        self,
        URL1,
        REQUEST,
        )

  management_interface  
management_interface ( self )

Hook to allow public execution of management interface with everything else private.

  parseTag  
parseTag (
        self,
        match_ob,
        command=None,
        sargs='',
        )

Parse a tag using an already matched re

Return: tag, args, command, coname

where: tag is the tag, args is the tag's argument string, command is a corresponding command info structure if the tag is a start tag, or None otherwise, and coname is the name of a continue tag (e.g. else) or None otherwise

Exceptions   
ParseError, ( 'Unexpected tag', tag )
ParseError, ( 'unexpected end tag', tag )
  quotedHTML  
quotedHTML (
        self,
        text=None,
        character_entities=((( '&' ), '&amp;' ), (( "<" ), '&lt;' ), (( ">" ), '&gt;' ), (( '"' ), '&quot;' ) ),
        )

  tagre  
tagre ( self )

  varExtra  
varExtra ( self,  match_ob )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_HTML_HTMLDefault.py.html0100600000176200017510000000661707306455547030526 0ustar dhellmanndevel Class: HTMLDefault

Table of Contents

Class: HTMLDefault Zope-2-CVS-src/lib/python/DocumentTemplate/DT_HTML.py

HTML document templates that edit themselves through copy.

This is to make a distinction from HTML objects that should edit themselves in place.

Base Classes   
HTML
    DT_String.String
Methods   
manage_edit
  manage_edit  
manage_edit (
        self,
        data,
        PARENTS,
        URL1,
        REQUEST,
        )

edit a template

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_HTML_HTMLFile.py.html0100600000176200017510000001207107306455550030002 0ustar dhellmanndevel Class: HTMLFile

Table of Contents

Class: HTMLFile Zope-2-CVS-src/lib/python/DocumentTemplate/DT_HTML.py

HTML Document templates read from files.

If the object is pickled, the file name, rather than the file contents is pickled. When the object is unpickled, then the file will be re-read to obtain the string. Note that the file will not be read until the document template is used the first time.

Base Classes   
FileMixin
HTML
    DT_String.String
Methods   
manage_default
manage_edit
manage_editForm
  manage_default  
manage_default ( self,  REQUEST=None )

Revert to factory defaults

  manage_edit  
manage_edit (
        self,
        data,
        PARENTS=[],
        URL1='',
        URL2='',
        REQUEST='',
        SUBMIT='',
        )

edit a template

  manage_editForm  
manage_editForm (
        self,
        URL1,
        REQUEST,
        )

Display doc template editing form

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_HTML_dtml_re_class.py.html0100600000176200017510000001032007306455550031244 0ustar dhellmanndevel Class: dtml_re_class

Table of Contents

Class: dtml_re_class Zope-2-CVS-src/lib/python/DocumentTemplate/DT_HTML.py

This needs to be replaced before 2.4. It's a hackaround.

Methods   
group
search
start
  group  
group ( self,  *args )

  search  
search (
        self,
        text,
        start=0,
        name_match=re.compile( '[\000- ]*[a-zA-Z]+[\000- ]*' ).match,
        end_match=re.compile( '[\000- ]*(/|end)', re.I ).match,
        start_search=re.compile( '[<&]' ).search,
        ent_name=re.compile( '[-a-zA-Z0-9_.]+' ).match,
        find=find,
        strip=strip,
        replace=replace,
        )

  start  
start ( self,  *args )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_If.py.html0100600000176200017510000000571407306455550026156 0ustar dhellmanndevel Module: DT_If

Table of Contents

Module: DT_If Zope-2-CVS-src/lib/python/DocumentTemplate/DT_If.py

Imported modules   
from DT_Util import ParseError, parse_params, name_param, str
Classes   
Else
If
Unless

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_If_Else.py.html0100600000176200017510000000370007306455550027117 0ustar dhellmanndevel Class: Else

Table of Contents

Class: Else Zope-2-CVS-src/lib/python/DocumentTemplate/DT_If.py

Base Classes   
Unless

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_If_If.py.html0100600000176200017510000000636507306455550026577 0ustar dhellmanndevel Class: If

Table of Contents

Class: If Zope-2-CVS-src/lib/python/DocumentTemplate/DT_If.py

Methods   
__init__
  __init__  
__init__ ( self,  blocks )

Exceptions   
ParseError, ( 'more than one else tag for a single if tag', 'in' )
ParseError, ( 'name in else does not match if', 'in' )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_If_Unless.py.html0100600000176200017510000000500007306455550027473 0ustar dhellmanndevel Class: Unless

Table of Contents

Class: Unless Zope-2-CVS-src/lib/python/DocumentTemplate/DT_If.py

Methods   
__init__
  __init__  
__init__ ( self,  blocks )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_InSV.py.html0100600000176200017510000001004307306455550026426 0ustar dhellmanndevel Module: DT_InSV

Table of Contents

Module: DT_InSV Zope-2-CVS-src/lib/python/DocumentTemplate/DT_InSV.py

Imported modules   
from math import sqrt
import re
Functions   
opt
  opt  
opt (
        start,
        end,
        size,
        orphan,
        sequence,
        )

Classes   
sequence_variables

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_InSV_sequence_variables.py.html0100600000176200017510000004666107306455550032365 0ustar dhellmanndevel Class: sequence_variables

Table of Contents

Class: sequence_variables Zope-2-CVS-src/lib/python/DocumentTemplate/DT_InSV.py

Methods   
Letter
Roman
__getitem__
__init__
__len__
__setitem__
even
first
item
key
 last
length
letter
next_batches
number
odd
previous_batches
query
roman
statistics
 value
  Letter  
Letter ( self,  index )

  Roman  
Roman ( self,  num )

  __getitem__  
__getitem__ (
        self,
        key,
        special_prefixes=special_prefixes,
        special_prefix=special_prefixes.has_key,
        )

Exceptions   
KeyError, key
  __init__  
__init__ (
        self,
        items=None,
        query_string='',
        start_name_re=None,
        alt_prefix='',
        )

  __len__  
__len__ ( self )

  __setitem__  
__setitem__ (
        self,
        key,
        value,
        )

  even  
even ( self,  index )

  first  
first (
        self,
        name,
        key='',
        )

  item  
item (
        self,
        index,
        tt=type(() ),
        )

  key  
key ( self,  index )

  last  
last (
        self,
        name,
        key='',
        )

  length  
length ( self,  ignored )

  letter  
letter ( self,  index )

  next_batches  
next_batches (
        self,
        suffix='batches',
        key='',
        )

Exceptions   
KeyError, key
  number  
number ( self,  index )

  odd  
odd ( self,  index )

  previous_batches  
previous_batches (
        self,
        suffix='batches',
        key='',
        )

Exceptions   
KeyError, key
  query  
query ( self,  *ignored )

Exceptions   
KeyError, 'sequence-query'
  roman  
roman ( self,  index )

  statistics  
statistics (
        self,
        name,
        key,
        )

  value  
value (
        self,
        index,
        name,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Let.py.html0100600000176200017510000001371707306455550026346 0ustar dhellmanndevel Module: DT_Let

Table of Contents

Module: DT_Let Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Let.py

The Let tag was contributed to Zope by and is copyright, 1999 Phillip J. Eby. Permission has been granted to release the Let tag under the Zope Public License.

Let name=value...

The let tag is used to bind variables to values within a block.

The text enclosed in the let tag is rendered using information from the given variables or expressions.

For example:

     &lt;!--#let foofunc=&quot;foo()&quot; my_bar=bar--&gt;
       foo() = &lt;!--#var foofunc--&gt;,
       bar = &lt;!--#var my_bar--&gt;
     &lt;!--#/let--&gt;

Notice that both name and expr style attributes may be used to specify data. name style attributes (e.g. my_bar=bar) will be rendered as they are for var/with/in/etc. Quoted attributes will be treated as Python expressions.

Variables are processed in sequence, so later assignments can reference and/or overwrite the results of previous assignments, as desired.

Imported modules   
from DT_Util import render_blocks, Eval, ParseError
import re
Functions   
parse_let_params
  parse_let_params  
parse_let_params (
        text,
        result=None,
        tag='let',
        parmre=re.compile( '([\000- ]*([^\000- ="]+)=([^\000- ="]+))' ),
        qparmre=re.compile( '([\000- ]*([^\000- ="]+)="([^"]*)")' ),
        **parms,
        )

Exceptions   
ParseError, ( 'invalid parameter: "%s"' % text, tag )
Classes   
Let

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Let_Let.py.html0100600000176200017510000000762707306455550027155 0ustar dhellmanndevel Class: Let

Table of Contents

Class: Let Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Let.py

Methods   
__init__
render
  __init__  
__init__ ( self,  blocks )

Exceptions   
ParseError, ( 'Expression (Python) Syntax error:' '\n
\n%s\n
\n' % v [ 0 ], 'let' )
  render  
render ( self,  md )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Raise.py.html0100600000176200017510000000621307306455550026656 0ustar dhellmanndevel Module: DT_Raise

Table of Contents

Module: DT_Raise Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Raise.py

Raising exceptions

Errors can be raised from DTML using the raise tag.

For example:

    &lt;!--#if expr=&quot;condition_that_tests_input&quot;--&gt;
       &lt;!--#raise type=&quot;Input Error&quot;--&gt;
           The value you entered is not valid
       &lt;!--#/raise--&gt;
    &lt;!--#/if--&gt;

Imported modules   
from DT_Util import parse_params, name_param, render_blocks, str
Classes   
Raise

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Raise_Raise.py.html0100600000176200017510000000746407306455550030012 0ustar dhellmanndevel Class: Raise

Table of Contents

Class: Raise Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Raise.py

Methods   
__init__
render
  __init__  
__init__ ( self,  blocks )

  render  
render ( self,  md )

Exceptions   
t, v

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Return.py.html0100600000176200017510000000626607306455550027102 0ustar dhellmanndevel Module: DT_Return

Table of Contents

Module: DT_Return Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Return.py

Imported modules   
from DT_Util import parse_params, name_param, str
import string
from string import find, split, join, atoi, rfind
import sys
Classes   
DTReturn
ReturnTag

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Return_DTReturn.py.html0100600000176200017510000000500307306455550030655 0ustar dhellmanndevel Class: DTReturn

Table of Contents

Class: DTReturn Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Return.py

Methods   
__init__
  __init__  
__init__ ( self,  v )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Return_ReturnTag.py.html0100600000176200017510000000750607306455550031073 0ustar dhellmanndevel Class: ReturnTag

Table of Contents

Class: ReturnTag Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Return.py

Methods   
__init__
render
  __init__  
__init__ ( self,  args )

  render  
render ( self,  md )

Exceptions   
DTReturn( val )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_String.py.html0100600000176200017510000000766107306455550027071 0ustar dhellmanndevel Module: DT_String

Table of Contents

Module: DT_String Zope-2-CVS-src/lib/python/DocumentTemplate/DT_String.py

$Id: DT_String.py,v 1.45 2001/05/30 15:57:30 andreas Exp $

Imported modules   
from DT_Return import ReturnTag, DTReturn
from DT_Util import ParseError, InstanceDict, TemplateDict, render_blocks, str
from DT_Var import Var, Call, CommentLine, Comment
import exceptions
import os
import re
from string import split, strip
import thread
Classes   
File

Document templates read from files.

FileMixin
String

Document templates defined from strings.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_String_File.py.html0100600000176200017510000001025307306455550030017 0ustar dhellmanndevel Class: File

Table of Contents

Class: File Zope-2-CVS-src/lib/python/DocumentTemplate/DT_String.py

Document templates read from files.

If the object is pickled, the file name, rather than the file contents is pickled. When the object is unpickled, then the file will be re-read to obtain the string. Note that the file will not be read until the document template is used the first time.

Base Classes   
FileMixin
String
Methods   
manage_edit
  manage_edit  
manage_edit ( self,  data )

Exceptions   
TypeError, 'cannot edit files'

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_String_FileMixin.py.html0100600000176200017510000000667707306455550031043 0ustar dhellmanndevel Class: FileMixin

Table of Contents

Class: FileMixin Zope-2-CVS-src/lib/python/DocumentTemplate/DT_String.py

Methods   
__init__
read_raw
  __init__  
__init__ (
        self,
        file_name='',
        mapping=None,
        __name__='',
        **vars,
        )

Create a document template based on a named file.

The optional parameter, mapping, may be used to provide a mapping object containing defaults for values to be inserted.

  read_raw  
read_raw ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_String_String.py.html0100600000176200017510000006542707306455550030423 0ustar dhellmanndevel Class: String

Table of Contents

Class: String Zope-2-CVS-src/lib/python/DocumentTemplate/DT_String.py

Document templates defined from strings.

Document template strings use an extended form of python string formatting. To insert a named value, simply include text of the form: %(name)x, where name is the name of the value and x is a format specification, such as 12.2d.

To intrduce a block such as an if or an in or a block continuation, such as an else, use [ as the format specification. To terminate a block, ise ] as the format specification, as in:

      %(in results)[
        %(name)s
      %(in results)]
Methods   
SubTemplate
ZDocumentTemplate_afterRender
ZDocumentTemplate_beforeRender
__call__
__getstate__
__init__
__str__
_parseTag
cook
default
 errQuote
initvars
manage_edit
munge
name
parse
parseTag
parse_block
parse_close
parse_error
 read
read_raw
setName
skip_eol
tagre
var
varExtra
  SubTemplate  
SubTemplate ( self,  name )

  ZDocumentTemplate_afterRender  
ZDocumentTemplate_afterRender (
        self,
        md,
        result,
        )

  ZDocumentTemplate_beforeRender  
ZDocumentTemplate_beforeRender (
        self,
        md,
        default,
        )

  __call__  
__call__ (
        self,
        client=None,
        mapping={},
        **kw,
        )

Generate a document from a document template.

The document will be generated by inserting values into the format string specified when the document template was created. Values are inserted using standard python named string formats.

The optional argument client is used to specify a object containing values to be looked up. Values will be looked up using getattr, so inheritence of values is supported. Note that names beginning with _ will not be looked up from the client.

The optional argument, mapping is used to specify a mapping object containing values to be inserted.

Values to be inserted may also be specified using keyword arguments.

Values will be inserted from one of several sources. The sources, in the order in which they are consulted, are:

  • Keyword arguments,

  • The client argument,

  • The mapping argument,

  • The keyword arguments provided when the object was created, and

  • The mapping argument provided when the template was created.

Exceptions   
SystemError, ( 'infinite recursion in document template' )
  __getstate__  
__getstate__ ( self,  _special=( '_v_', '_p_' ) )

  __init__  
__init__ (
        self,
        source_string='',
        mapping=None,
        __name__='<string>',
        **vars,
        )

Create a document template from a string.

The optional parameter, mapping, may be used to provide a mapping object containing defaults for values to be inserted.

  __str__  
__str__ ( self )

  _parseTag  
_parseTag (
        self,
        match_ob,
        command=None,
        sargs='',
        tt=type(() ),
        )

  cook  
cook ( self,  cooklock=thread.allocate_lock() )

  default  
default (
        self,
        name=None,
        **kw,
        )

Change or query default values in a document template.

If a name is specified, the value of the named default value before the operation is returned.

Keyword arguments are used to provide default values.

  errQuote  
errQuote ( self,  s )

  initvars  
initvars (
        self,
        globals,
        vars,
        )

  manage_edit  
manage_edit (
        self,
        data,
        REQUEST=None,
        )

  munge  
munge (
        self,
        source_string=None,
        mapping=None,
        **vars,
        )

Change the text or default values for a document template.

  name  
name ( self )

  parse  
parse (
        self,
        text,
        start=0,
        result=None,
        tagre=None,
        )

  parseTag  
parseTag (
        self,
        match_ob,
        command=None,
        sargs='',
        )

Parse a tag using an already matched re

Return: tag, args, command, coname

where: tag is the tag, args is the tag's argument string, command is a corresponding command info structure if the tag is a start tag, or None otherwise, and coname is the name of a continue tag (e.g. else) or None otherwise

Exceptions   
ParseError, ( 'Unexpected tag', tag )
ParseError, ( 'unexpected end tag', tag )
  parse_block  
parse_block (
        self,
        text,
        start,
        result,
        tagre,
        stag,
        sloc,
        sargs,
        scommand,
        )

  parse_close  
parse_close (
        self,
        text,
        start,
        tagre,
        stag,
        sloc,
        scommand,
        sa,
        )

  parse_error  
parse_error (
        self,
        mess,
        tag,
        text,
        start,
        )

Exceptions   
ParseError, "%s, for tag %s, on line %s of %s

" %(mess, self.errQuote( tag ), len(split( text [ : start ], '\n' ) ), self.errQuote( self.__name__ ) )

  read  
read ( self,  raw=None )

  read_raw  
read_raw ( self,  raw=None )

  setName  
setName ( self,  v )

  skip_eol  
skip_eol (
        self,
        text,
        start,
        eol=re.compile( '[ \t]*\n' ),
        )

  tagre  
tagre ( self )

  var  
var (
        self,
        name=None,
        **kw,
        )

Change or query a variable in a document template.

If a name is specified, the value of the named variable before the operation is returned.

Keyword arguments are used to provide variable values.

  varExtra  
varExtra ( self,  match_ob )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Try.py.html0100600000176200017510000000646207306455550026377 0ustar dhellmanndevel Module: DT_Try

Table of Contents

Module: DT_Try Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Try.py

Imported modules   
from DT_Return import DTReturn
from DT_Util import ParseError, parse_params, render_blocks, namespace, InstanceDict
from StringIO import StringIO
import string
import sys
import traceback
Classes   
Try

Zope DTML Exception handling

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Try_Try.py.html0100600000176200017510000002316607306455550027235 0ustar dhellmanndevel Class: Try

Table of Contents

Class: Try Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Try.py

Zope DTML Exception handling

usage:

<!--#try--> <!--#except SomeError AnotherError--> <!--#except YetAnotherError--> <!--#except--> <!--#else--> <!--#/try-->

or:

<!--#try--> <!--#finally--> <!--#/try-->

The DTML try tag functions quite like Python's try command.

The contents of the try tag are rendered. If an exception is raised, then control switches to the except blocks. The first except block to match the type of the error raised is rendered. If an except block has no name then it matches all raised errors.

The try tag understands class-based exceptions, as well as string-based exceptions. Note: the raise tag raises string-based exceptions.

Inside the except blocks information about the error is available via three variables.

error_type

This variable is the name of the exception caught.

error_value

This is the caught exception's value.

error_tb

This is a traceback for the caught exception.

The optional else block is rendered when no exception occurs in the try block. Exceptions in the else block are not handled by the preceding except blocks.

The try..finally form specifies a `cleanup` block, to be rendered even when an exception occurs. Note that any rendered result is discarded if an exception occurs in either the try or finally blocks. The finally block is only of any use if you need to clean up something that will not be cleaned up by the transaction abort code.

The finally block will always be called, wether there was an exception in the try block or not, or wether or not you used a return tag in the try block. Note that any output of the finally block is discarded if you use a return tag in the try block.

If an exception occurs in the try block, and an exception occurs in the finally block, or you use the return tag in that block, any information about that first exception is lost. No information about the first exception is available in the finally block. Also, if you use a return tag in the try block, and an exception occurs in the finally block or you use a return tag there as well, the result returned in the try block will be lost.

Original version by Jordan B. Baker.

Try..finally and try..else implementation by Martijn Pieters.

Methods   
__init__
find_handler
match_base
render
render_try_except
render_try_finally
  __init__  
__init__ ( self,  blocks )

Exceptions   
ParseError, ( 'A try..finally combination cannot contain ' 'any other else, except or finally blocks', self.name )
ParseError, ( 'No more than one else block is allowed', self.name )
ParseError, ( 'Only one default exception handler ' 'is allowed', self.name )
ParseError, ( 'The else block should be the last block ' 'in a try tag', self.name )
  find_handler  
find_handler ( self,  exception )

recursively search for a handler for a given exception

  match_base  
match_base (
        self,
        exception,
        name,
        )

  render  
render ( self,  md )

  render_try_except  
render_try_except ( self,  md )

  render_try_finally  
render_try_finally ( self,  md )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_UI.py.html0100600000176200017510000000370107306455550026127 0ustar dhellmanndevel Module: DT_UI

Table of Contents

Module: DT_UI Zope-2-CVS-src/lib/python/DocumentTemplate/DT_UI.py

Imported modules   
from DT_HTML import HTML

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Util.py.html0100600000176200017510000003366107306455550026537 0ustar dhellmanndevel Module: DT_Util

Table of Contents

Module: DT_Util Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Util.py

$Id: DT_Util.py,v 1.77 2001/05/16 19:07:02 evan Exp $

Imported modules   
from RestrictedPython.Eval import RestrictionCapableEval
from RestrictedPython.Guards import safe_builtins
from RestrictedPython.Utilities import utility_builtins
import os
import re
Functions   
add_with_prefix
careful_getattr
careful_hasattr
int_param
name_param
namespace
parse_params
render
  add_with_prefix  
add_with_prefix (
        map,
        defprefix,
        prefix,
        )

  careful_getattr  
careful_getattr (
        md,
        inst,
        name,
        default=_marker,
        )

  careful_hasattr  
careful_hasattr (
        md,
        inst,
        name,
        )

  int_param  
int_param (
        params,
        md,
        name,
        default=0,
        st=type( '' ),
        )

  name_param  
name_param (
        params,
        tag='',
        expr=0,
        attr='name',
        default_unnamed=1,
        )

Exceptions   
ParseError, ( '%s and expr given' % attr, tag )
ParseError, ( 'Expression (Python) Syntax error:' '\n
\n%s\n
\n' % v [ 0 ], tag )
ParseError, ( 'No %s given' % attr, tag )
ParseError, ( 'The "..." shorthand for expr was used in a tag ' 'that doesn\'t support expr attributes.', tag )
ParseError, ( 'Two %s values were given' % attr, tag )
ParseError, ( 'two exprs given', tag )
  namespace  
namespace ( self,  **kw )

Create a tuple consisting of a single instance whose attributes are provided as keyword arguments.

Exceptions   
TypeError, '''A call was made to DT_Util.namespace() with an incorrect "self" argument. It could be caused by a product which is not yet compatible with this version of Zope. The traceback information may contain more details.)'''
  parse_params  
parse_params (
        text,
        result=None,
        tag='',
        unparmre=re.compile( '([\000- ]*([^\000- ="]+))' ),
        qunparmre=re.compile( '([\000- ]*("[^"]*"))' ),
        parmre=re.compile( '([\000- ]*([^\000- ="]+)=([^\000- ="]+))' ),
        qparmre=re.compile( '([\000- ]*([^\000- ="]+)="([^"]*)")' ),
        **parms,
        )

Parse tag parameters

The format of tag parameters consists of 1 or more parameter specifications separated by whitespace. Each specification consists of an unnamed and unquoted value, a valueless name, or a name-value pair. A name-value pair consists of a name and a quoted or unquoted value separated by an =.

The input parameter, text, gives the text to be parsed. The keyword parameters give valid parameter names and default values.

If a specification is not a name-value pair and it is not the first specification and it is a valid parameter name, then it is treated as a name-value pair with a value as given in the keyword argument. Otherwise, if it is not a name-value pair, it is treated as an unnamed value.

The data are parsed into a dictionary mapping names to values. Unnamed values are mapped from the name "". Only one value may be given for a name and there may be only one unnamed value.

Exceptions   
ParseError, ( 'Attribute %s requires a value' % name, tag )
ParseError, ( 'Duplicate values for attribute "%s"' % name, tag )
ParseError, ( 'Invalid attribute name, "%s"' % name, tag )
ParseError, ( 'invalid parameter: "%s"' % text, tag )
  render  
render ( self,  v )

Render an object in the way done by the name attribute

Classes   
Add_with_prefix
Eval
NotBindable

Used to prevent TemplateDict from trying to bind to functions.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Util_Add_with_prefix.py.html0100600000176200017510000000647507306455550031722 0ustar dhellmanndevel Class: Add_with_prefix

Table of Contents

Class: Add_with_prefix Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Util.py

Methods   
__init__
__setitem__
  __init__  
__init__ (
        self,
        map,
        defprefix,
        prefix,
        )

  __setitem__  
__setitem__ (
        self,
        name,
        value,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Util_Eval.py.html0100600000176200017510000000747307306455550027510 0ustar dhellmanndevel Class: Eval

Table of Contents

Class: Eval Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Util.py

Base Classes   
RestrictionCapableEval
Methods   
__call__
eval
  __call__  
__call__ ( self,  **kw )

  eval  
eval ( self,  md )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Util_NotBindable.py.html0100600000176200017510000000503507306455550030772 0ustar dhellmanndevel Class: NotBindable

Table of Contents

Class: NotBindable Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Util.py

Used to prevent TemplateDict from trying to bind to functions.

Methods   
__init__
  __init__  
__init__ ( self,  f )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Var.py.html0100600000176200017510000003651107306455550026347 0ustar dhellmanndevel Module: DT_Var

Table of Contents

Module: DT_Var Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Var.py

Imported modules   
from DT_Util import parse_params, name_param, str
from cgi import escape
import re
import string
from string import find, split, join, atoi, rfind
import sys
from urllib import quote, quote_plus
Functions   
dollars_and_cents
dollars_and_cents_with_commas
html_quote
len_comma
len_format
newline_to_br
spacify
sql_quote
structured_text
thousands_commas
 url_quote
url_quote_plus
whole_dollars
whole_dollars_with_commas
  dollars_and_cents  
dollars_and_cents (
        v,
        name='(Unknown name)',
        md={},
        )

  dollars_and_cents_with_commas  
dollars_and_cents_with_commas (
        v,
        name='(Unknown name)',
        md={},
        )

  html_quote  
html_quote (
        v,
        name='(Unknown name)',
        md={},
        )

  len_comma  
len_comma (
        v,
        name='(Unknown name)',
        md={},
        )

  len_format  
len_format (
        v,
        name='(Unknown name)',
        md={},
        )

  newline_to_br  
newline_to_br (
        v,
        name='(Unknown name)',
        md={},
        )

  spacify  
spacify ( val )

  sql_quote  
sql_quote (
        v,
        name='(Unknown name)',
        md={},
        )

Quote single quotes in a string by doubling them.

This is needed to securely insert values into sql string literals in templates that generate sql.

  structured_text  
structured_text (
        v,
        name='(Unknown name)',
        md={},
        )

  thousands_commas  
thousands_commas (
        v,
        name='(Unknown name)',
        md={},
        thou=re.compile( r"([0-9])([0-9][0-9][0-9]([,.]|$))" ).search,
        )

  url_quote  
url_quote (
        v,
        name='(Unknown name)',
        md={},
        )

  url_quote_plus  
url_quote_plus (
        v,
        name='(Unknown name)',
        md={},
        )

  whole_dollars  
whole_dollars (
        v,
        name='(Unknown name)',
        md={},
        )

  whole_dollars_with_commas  
whole_dollars_with_commas (
        v,
        name='(Unknown name)',
        md={},
        )

Classes   
Call
Comment
CommentLine

Comments

Var

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Var_Call.py.html0100600000176200017510000000477307306455550027307 0ustar dhellmanndevel Class: Call

Table of Contents

Class: Call Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Var.py

Methods   
__init__
  __init__  
__init__ ( self,  args )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Var_Comment.py.html0100600000176200017510000000372207306455550030027 0ustar dhellmanndevel Class: Comment

Table of Contents

Class: Comment Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Var.py

Base Classes   
CommentLine

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Var_CommentLine.py.html0100600000176200017510000000667307306455550030647 0ustar dhellmanndevel Class: CommentLine

Table of Contents

Class: CommentLine Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Var.py

Comments

The comment tag can be used to simply include comments in DTML source.

For example:

      &lt;!--#comment--&gt;

        This text is not rendered.

      &lt;!--#/comment--&gt;
Methods   
__init__
render
  __init__  
__init__ (
        self,
        args,
        fmt='',
        )

  render  
render ( self,  md )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Var_Var.py.html0100600000176200017510000000776307306455550027166 0ustar dhellmanndevel Class: Var

Table of Contents

Class: Var Zope-2-CVS-src/lib/python/DocumentTemplate/DT_Var.py

Methods   
__init__
render
  __init__  
__init__ (
        self,
        args,
        fmt='s',
        )

  render  
render ( self,  md )

Exceptions   
'Document Error', ( '''a size attribute was used in a var tag with a non-integer value.''' )
KeyError, name
t, v

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_With.py.html0100600000176200017510000000721307306455550026527 0ustar dhellmanndevel Module: DT_With

Table of Contents

Module: DT_With Zope-2-CVS-src/lib/python/DocumentTemplate/DT_With.py

Nested namespace access

The with tag is used to introduce nested namespaces.

The text enclosed in the with tag is rendered using information from the given variable or expression.

For example, if the variable person is bound to an object that has attributes name and age, then a with tag like the following can be used to access these attributes:

     &lt;!--#with person--&gt;
       &lt;!--#var name--&gt;,
       &lt;!--#var age--&gt;
     &lt;!--#/with--&gt;

Eather a name or an expr attribute may be used to specify data. A mapping attribute may be used to indicate that the given data should be treated as mapping object, rather than as an object with named attributes.

Imported modules   
from DT_Util import parse_params, name_param, InstanceDict, render_blocks, str, TemplateDict
Classes   
With

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DT_With_With.py.html0100600000176200017510000000625507306455550027527 0ustar dhellmanndevel Class: With

Table of Contents

Class: With Zope-2-CVS-src/lib/python/DocumentTemplate/DT_With.py

Methods   
__init__
render
  __init__  
__init__ ( self,  blocks )

  render  
render ( self,  md )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DTtestExpr.py.html0100600000176200017510000001230207306455550027266 0ustar dhellmanndevel Module: DTtestExpr

Table of Contents

Module: DTtestExpr Zope-2-CVS-src/lib/python/DocumentTemplate/DTtestExpr.py

Imported modules   
from DocumentTemplate import *
import sys
Functions   
test1
test2
test3
test4
  test1  
test1 ()

  test2  
test2 ()

  test3  
test3 ()

  test4  
test4 ()

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/DocumentTemplate.py.html0100600000176200017510000001457307306455550030506 0ustar dhellmanndevel Module: DocumentTemplate

Table of Contents

Module: DocumentTemplate Zope-2-CVS-src/lib/python/DocumentTemplate/DocumentTemplate.py

Document templates with fill-in fields

Document templates provide for creation of textual documents, such as HTML pages, from template source by inserting data from python objects and name-spaces.

When a document template is created, a collection of default values to be inserted may be specified with a mapping object and with keyword arguments.

A document templated may be called to create a document with values inserted. When called, an instance, a mapping object, and keyword arguments may be specified to provide values to be inserted. If an instance is provided, the document template will try to look up values in the instance using getattr, so inheritence of values is supported. If an inserted value is a function, method, or class, then an attempt will be made to call the object to obtain values. This allows instance methods to be included in documents.

Document templates masquerade as functions, so the python object publisher (Bobo) will call templates that are stored as instances of published objects. Bobo will pass the object the template was found in and the HTTP request object.

Two source formats are supported:

Extended Python format strings (EPFS)

This format is based on the insertion by name format strings of python with additional format characters, [ and ] to indicate block boundaries. In addition, parameters may be used within formats to control how insertion is done.

For example:

         %%(date fmt=DayOfWeek upper)s

causes the contents of variable date to be inserted using custom format DayOfWeek and with all lower case letters converted to upper case.

HTML

This format uses HTML server-side-include syntax with commands for inserting text. Parameters may be included to customize the operation of a command.

For example:

         &lt;!--#var total fmt=12.2f--&gt;

is used to insert the variable total with the C format 12.2f.

Document templates support conditional and sequence insertion

Document templates extend python string substitition rules with a mechanism that allows conditional insertion of template text and that allows sequences to be inserted with element-wise insertion of template text.

Access Control

Document templates provide a basic level of access control by preventing access to names beginning with an underscore. Additional control may be provided by providing document templates with a read_guard method. This would typically be done by subclassing one or more of the DocumentTemplate classes.

If provided, the the read_guard method will be called when objects are accessed as accessed as instance attributes or when they are accessed through keyed access in an expression.. The read_guard method will be called with the containing object. It can return a wrapper object from which the attribute will be accessed.

Document Templates may be created 4 ways:

DocumentTemplate.String

Creates a document templated from a string using an extended form of python string formatting.

DocumentTemplate.File

Creates a document templated bound to a named file using an extended form of python string formatting. If the object is pickled, the file name, rather than the file contents is pickled. When the object is unpickled, then the file will be re-read to obtain the string. Note that the file will not be read until the document template is used the first time.

DocumentTemplate.HTML

Creates a document templated from a string using HTML server-side-include rather than python-format-string syntax.

DocumentTemplate.HTMLFile

Creates an HTML document template from a named file.

Imported modules   
from DT_HTML import HTML, HTMLFile, HTMLDefault
from DT_String import String, File

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/__init__.py.html0100600000176200017510000000373607306455550026772 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/DocumentTemplate/__init__.py

Imported modules   
from DocumentTemplate import String, File, HTML, HTMLDefault, HTMLFile

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/pDocumentTemplate.py.html0100600000176200017510000001247607306455550030666 0ustar dhellmanndevel Module: pDocumentTemplate

Table of Contents

Module: pDocumentTemplate Zope-2-CVS-src/lib/python/DocumentTemplate/pDocumentTemplate.py

Imported modules   
import string
from string import join
import sys
import types
Functions   
render_blocks
  render_blocks  
render_blocks ( blocks,  md )

Exceptions   
KeyError, v, sys.exc_traceback
Classes   
DictInstance
InstanceDict
MultiMapping
TemplateDict

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/pDocumentTemplate_DictInstance.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/pDocumentTemplate_DictInstance.py.htm0100600000176200017510000000756707306455550033147 0ustar dhellmanndevel Class: DictInstance

Table of Contents

Class: DictInstance Zope-2-CVS-src/lib/python/DocumentTemplate/pDocumentTemplate.py

Methods   
__getattr__
__init__
  __getattr__  
__getattr__ ( self,  name )

Exceptions   
AttributeError, name
  __init__  
__init__ ( self,  mapping )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/pDocumentTemplate_InstanceDict.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/pDocumentTemplate_InstanceDict.py.htm0100600000176200017510000001366607306455550033144 0ustar dhellmanndevel Class: InstanceDict

Table of Contents

Class: InstanceDict Zope-2-CVS-src/lib/python/DocumentTemplate/pDocumentTemplate.py

Methods   
__getitem__
__init__
__repr__
has_key
keys
  __getitem__  
__getitem__ ( self,  key )

Exceptions   
KeyError, key
  __init__  
__init__ (
        self,
        o,
        namespace,
        read_guard=None,
        )

  __repr__  
__repr__ ( self )

  has_key  
has_key ( self,  key )

  keys  
keys ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/pDocumentTemplate_MultiMapping.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/pDocumentTemplate_MultiMapping.py.htm0100600000176200017510000001351207306455550033170 0ustar dhellmanndevel Class: MultiMapping

Table of Contents

Class: MultiMapping Zope-2-CVS-src/lib/python/DocumentTemplate/pDocumentTemplate.py

Methods   
__getitem__
__init__
keys
pop
push
  __getitem__  
__getitem__ ( self,  key )

Exceptions   
KeyError, key
  __init__  
__init__ ( self )

  keys  
keys ( self )

  pop  
pop ( self,  n=1 )

  push  
push ( self,  d )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/pDocumentTemplate_TemplateDict.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/pDocumentTemplate_TemplateDict.py.htm0100600000176200017510000001405107306455550033140 0ustar dhellmanndevel Class: TemplateDict

Table of Contents

Class: TemplateDict Zope-2-CVS-src/lib/python/DocumentTemplate/pDocumentTemplate.py

Methods   
__call__
__getitem__
__init__
_pop
_push
has_key
  __call__  
__call__ (
        self,
        *args,
        *kw,
        )

  __getitem__  
__getitem__ (
        self,
        key,
        call=1,
        simple=isSimpleType,
        isFunctionType=isFunctionType,
        )

  __init__  
__init__ ( self )

  _pop  
_pop ( self,  n=1 )

  _push  
_push ( self,  d )

  has_key  
has_key ( self,  key )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/ts_regex.py.html0100600000176200017510000000565407306455550027054 0ustar dhellmanndevel Module: ts_regex

Table of Contents

Module: ts_regex Zope-2-CVS-src/lib/python/DocumentTemplate/ts_regex.py

Provide a thread-safe interface to regex

Imported modules   
from regex import *
from regsub import split, sub, gsub, splitx, capwords
Classes   
compile
symcomp

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/ts_regex_compile.py.html0100600000176200017510000002032107306455550030550 0ustar dhellmanndevel Class: compile

Table of Contents

Class: compile Zope-2-CVS-src/lib/python/DocumentTemplate/ts_regex.py

Methods   
__init__
_init
match
match_group
match_regs
search
search_group
search_regs
  __init__  
__init__ ( self,  *args )

  _init  
_init ( self,  r )

  match  
match (
        self,
        string,
        pos=0,
        )

  match_group  
match_group (
        self,
        str,
        group,
        pos=0,
        )

Match a pattern against a string

If the string does not match the pattern, then None is returned, otherwise, the length of the match, as well as any specified group are returned.

  match_regs  
match_regs (
        self,
        str,
        pos=0,
        )

Match a pattern against a string

If the string does not match the pattern, then None is returned, otherwise, the regs attribute of the expression is returned.

  search  
search (
        self,
        string,
        pos=0,
        )

  search_group  
search_group (
        self,
        str,
        group,
        pos=0,
        )

Search a string for a pattern.

If the pattern was not found, then None is returned, otherwise, the location where the pattern was found, as well as any specified group are returned.

  search_regs  
search_regs (
        self,
        str,
        pos=0,
        )

Search a string for a pattern.

If the pattern was not found, then None is returned, otherwise, the regs attribute of the expression is returned.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/DocumentTemplate/ts_regex_symcomp.py.html0100600000176200017510000000626607306455550030623 0ustar dhellmanndevel Class: symcomp

Table of Contents

Class: symcomp Zope-2-CVS-src/lib/python/DocumentTemplate/ts_regex.py

Base Classes   
compile
Methods   
__init__
  __init__  
__init__ ( self,  *args )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:20 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/0040700000176200017510000000000007306455551022024 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/index.html0100600000176200017510000000522307306455551024022 0ustar dhellmanndevel Zope2 CVS with ZEO: HelpSys

Table of Contents

Zope2 CVS with ZEO: HelpSys  
Modules and Packages   

Zope-2-CVS-src/lib/python/HelpSys/

APIHelpTopic

API documentation help topics

HelpSys
HelpTopic
HelpUtil

Help system support module

ObjectRef

Object Reference implementation

__init__

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/APIHelpTopic.py.html0100600000176200017510000001126607306455551025567 0ustar dhellmanndevel Module: APIHelpTopic

Table of Contents

Module: APIHelpTopic Zope-2-CVS-src/lib/python/HelpSys/APIHelpTopic.py

API documentation help topics

Imported modules   
from Globals import DTMLFile, Persistent
import HelpTopic
import string
import types
Functions   
trim_doc_string
  trim_doc_string  
trim_doc_string ( text )

Trims a doc string to make it format correctly with structured text.

Classes   
APIDoc

Describes an API.

APIHelpTopic

Provides API documentation.

AttributeDoc

Describes an attribute of an API.

MethodDoc

Describes a method of an API.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/APIHelpTopic_APIDoc.py.html0100600000176200017510000001307107306455551026702 0ustar dhellmanndevel Class: APIDoc

Table of Contents

Class: APIDoc Zope-2-CVS-src/lib/python/HelpSys/APIHelpTopic.py

Describes an API.

Base Classes   
Persistent
Methods   
SearchableText
__init__
_createFromClass
_createFromInterface
  SearchableText  
SearchableText ( self )

The full text of the API, for indexing purposes.

  __init__  
__init__ (
        self,
        klass,
        isInterface=0,
        )

  _createFromClass  
_createFromClass ( self,  klass )

Creates an APIDoc instance given a python class. the class describes the API; it contains methods, arguments and doc strings.

The name of the API is deduced from the name of the class.

The base APIs are deduced from the __extends__ attribute.

  _createFromInterface  
_createFromInterface ( self,  klass )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/APIHelpTopic_APIHelpTopic.py.html0100600000176200017510000000764507306455551030076 0ustar dhellmanndevel Class: APIHelpTopic

Table of Contents

Class: APIHelpTopic Zope-2-CVS-src/lib/python/HelpSys/APIHelpTopic.py

Provides API documentation.

Base Classes   
HelpTopic.HelpTopic
Methods   
SearchableText
__init__
  SearchableText  
SearchableText ( self )

The full text of the Help Topic, for indexing purposes

  __init__  
__init__ (
        self,
        id,
        title,
        file,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/APIHelpTopic_AttributeDoc.py.html0100600000176200017510000000626607306455551030244 0ustar dhellmanndevel Class: AttributeDoc

Table of Contents

Class: AttributeDoc Zope-2-CVS-src/lib/python/HelpSys/APIHelpTopic.py

Describes an attribute of an API.

Base Classes   
Persistent
Methods   
__init__
  __init__  
__init__ (
        self,
        name,
        value,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/APIHelpTopic_MethodDoc.py.html0100600000176200017510000001160507306455551027512 0ustar dhellmanndevel Class: MethodDoc

Table of Contents

Class: MethodDoc Zope-2-CVS-src/lib/python/HelpSys/APIHelpTopic.py

Describes a method of an API.

required - a sequence of required arguments optional - a sequence of tuples (name, default value) varargs - the name of the variable argument or None kwargs - the name of the kw argument or None

Base Classes   
Persistent
Methods   
__init__
_createFromFunc
_createFromInterfaceMethod
  __init__  
__init__ (
        self,
        func,
        isInterface=0,
        )

  _createFromFunc  
_createFromFunc ( self,  func )

  _createFromInterfaceMethod  
_createFromInterfaceMethod ( self,  func )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpSys.py.html0100600000176200017510000000660607306455551024737 0ustar dhellmanndevel Module: HelpSys

Table of Contents

Module: HelpSys Zope-2-CVS-src/lib/python/HelpSys/HelpSys.py

Imported modules   
import Acquisition
import Globals
from Globals import Persistent, DTMLFile, HTML
import HelpTopic
from OFS.ObjectManager import ObjectManager
from OFS.SimpleItem import Item
import Products
from Products.ZCatalog.Lazy import LazyCat
from Products.ZCatalog.ZCatalog import ZCatalog
Classes   
HelpSys

Zope Help System

ProductHelp

Manages a collection of Help Topics for a given Product.

TreeCollection

A temporary wrapper for a collection of objects

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpSys_HelpSys.py.html0100600000176200017510000001602107306455551026376 0ustar dhellmanndevel Class: HelpSys

Table of Contents

Class: HelpSys Zope-2-CVS-src/lib/python/HelpSys/HelpSys.py

Zope Help System

Provides browsing and searching of Zope Product Help.

Base Classes   
Acquisition.Implicit
ObjectManager
Item
Persistent
Methods   
HelpButton
__call__
__init__
helpLink
helpValues
tpValues
  HelpButton  
HelpButton (
        self,
        topic,
        product,
        )

Insert a help button linked to a help topic.

  __call__  
__call__ (
        self,
        REQUEST=None,
        **kw,
        )

Searchable interface

Seaching does an aggregated search of all ProductHelp objects. Only Help Topics for which the user has permissions are returned.

  __init__  
__init__ ( self,  id='HelpSys' )

  helpLink  
helpLink (
        self,
        product='OFSP',
        topic='ObjectManager_Contents.stx',
        )

  helpValues  
helpValues ( self,  spec=None )

ProductHelp objects of all Products that have help

  tpValues  
tpValues ( self )

Tree protocol - returns child nodes

Aggregates Product Helps with the same title.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpSys_ProductHelp.py.html0100600000176200017510000001556107306455551027250 0ustar dhellmanndevel Class: ProductHelp

Table of Contents

Class: ProductHelp Zope-2-CVS-src/lib/python/HelpSys/HelpSys.py

Manages a collection of Help Topics for a given Product.

Provides searching services to HelpSystem.

Base Classes   
Acquisition.Implicit
ObjectManager
Item
Persistent
Methods   
__call__
__init__
addTopic
all_meta_types
helpValues
tpValues
  __call__  
__call__ (
        self,
        *args,
        *kw,
        )

Searchable interface

  __init__  
__init__ (
        self,
        id='Help',
        title='',
        )

  addTopic  
addTopic (
        self,
        id,
        title,
        REQUEST=None,
        )

Add a Help Topic

  all_meta_types  
all_meta_types ( self )

  helpValues  
helpValues ( self,  REQUEST=None )

Lists contained Help Topics. Help Topics for which the user is not authorized are not listed.

  tpValues  
tpValues ( self )

Tree protocol - child nodes

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpSys_TreeCollection.py.html0100600000176200017510000001000107306455551027712 0ustar dhellmanndevel Class: TreeCollection

Table of Contents

Class: TreeCollection Zope-2-CVS-src/lib/python/HelpSys/HelpSys.py

A temporary wrapper for a collection of objects objects, used for help topic browsing to make a collection of objects appear as a single object.

Methods   
__init__
tpId
tpValues
  __init__  
__init__ (
        self,
        id,
        objs,
        simple=1,
        )

  tpId  
tpId ( self )

  tpValues  
tpValues ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpTopic.py.html0100600000176200017510000001025607306455551025233 0ustar dhellmanndevel Module: HelpTopic

Table of Contents

Module: HelpTopic Zope-2-CVS-src/lib/python/HelpSys/HelpTopic.py

Imported modules   
import Acquisition
from ComputedAttribute import ComputedAttribute
import Globals
from Globals import Persistent, HTML, DTMLFile, ImageFile
from OFS.DTMLDocument import DTMLDocument
from OFS.PropertyManager import PropertyManager
from OFS.SimpleItem import Item
import os.path
import string
Classes   
DTMLDocumentTopic

A user addable Help Topic based on DTML Document.

DTMLTopic

A basic Help Topic. Holds a HTMLFile object.

HelpTopic

Abstract base class for Help Topics

HelpTopicBase

Mix-in Help Topic support class

ImageTopic

A image Help Topic. Holds an ImageFile object.

STXTopic

A structured-text topic. Holds a HTMLFile object.

TextTopic

A basic Help Topic. Holds a text file.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpTopic_DTMLDocumentTopic.py.html0100600000176200017510000000772107306455551030554 0ustar dhellmanndevel Class: DTMLDocumentTopic

Table of Contents

Class: DTMLDocumentTopic Zope-2-CVS-src/lib/python/HelpSys/HelpTopic.py

A user addable Help Topic based on DTML Document.

Base Classes   
HelpTopicBase
DTMLDocument
Methods   
SearchableText
munge
  SearchableText  
SearchableText ( self )

  munge  
munge (
        self,
        *args,
        *kw,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpTopic_DTMLTopic.py.html0100600000176200017510000001022207306455551027043 0ustar dhellmanndevel Class: DTMLTopic

Table of Contents

Class: DTMLTopic Zope-2-CVS-src/lib/python/HelpSys/HelpTopic.py

A basic Help Topic. Holds a HTMLFile object.

Base Classes   
HelpTopic
    Acquisition.Implicit
    HelpTopicBase
    Item
    PropertyManager
    Persistent
Methods   
SearchableText
__init__
  SearchableText  
SearchableText ( self )

The full text of the Help Topic, for indexing purposes

  __init__  
__init__ (
        self,
        id,
        title,
        file,
        permissions=None,
        categories=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpTopic_HelpTopic.py.html0100600000176200017510000001255507306455551027206 0ustar dhellmanndevel Class: HelpTopic

Table of Contents

Class: HelpTopic Zope-2-CVS-src/lib/python/HelpSys/HelpTopic.py

Abstract base class for Help Topics

Base Classes   
Acquisition.Implicit
HelpTopicBase
Item
PropertyManager
Persistent
Methods   
_check_for_update
_set_last_read
index_html
  _check_for_update  
_check_for_update ( self )

  _set_last_read  
_set_last_read ( self,  filepath )

  index_html  
index_html (
        self,
        REQUEST,
        RESPONSE,
        )

View the Help Topic

Exceptions   
"Unimplemented"

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpTopic_HelpTopicBase.py.html0100600000176200017510000002776107306455551030006 0ustar dhellmanndevel Class: HelpTopicBase

Table of Contents

Class: HelpTopicBase Zope-2-CVS-src/lib/python/HelpSys/HelpTopic.py

Mix-in Help Topic support class

Methods   
SearchableText
_permissions_values
_setPropValue
authorized
get_catalog
helpValues
index_object
manage_afterAdd
manage_afterClone
manage_beforeDelete
 reindex_object
unindex_object
url
  SearchableText  
SearchableText ( self )

The full text of the Help Topic, for indexing purposes

Exceptions   
"Unimplemented"
  _permissions_values  
_permissions_values ( self )

  _setPropValue  
_setPropValue (
        self,
        id,
        value,
        )

  authorized  
authorized ( self,  user )

Is a given user authorized to view this Help Topic?

  get_catalog  
get_catalog ( self )

  helpValues  
helpValues ( self,  REQUEST=None )

  index_object  
index_object ( self,  prefix='' )

  manage_afterAdd  
manage_afterAdd (
        self,
        item,
        container,
        )

  manage_afterClone  
manage_afterClone ( self,  item )

  manage_beforeDelete  
manage_beforeDelete (
        self,
        item,
        container,
        )

  reindex_object  
reindex_object ( self )

  unindex_object  
unindex_object ( self,  prefix='' )

  url  
url ( self )

URL for indexing purposes

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpTopic_ImageTopic.py.html0100600000176200017510000001156307306455551027336 0ustar dhellmanndevel Class: ImageTopic

Table of Contents

Class: ImageTopic Zope-2-CVS-src/lib/python/HelpSys/HelpTopic.py

A image Help Topic. Holds an ImageFile object.

Base Classes   
HelpTopic
    Acquisition.Implicit
    HelpTopicBase
    Item
    PropertyManager
    Persistent
Methods   
SearchableText
__init__
index_html
  SearchableText  
SearchableText ( self )

The full text of the Help Topic, for indexing purposes

  __init__  
__init__ (
        self,
        id,
        title,
        file,
        categories=None,
        permissions=None,
        )

  index_html  
index_html (
        self,
        REQUEST,
        RESPONSE,
        )

View the Help Topic

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpTopic_STXTopic.py.html0100600000176200017510000000662507306455551026775 0ustar dhellmanndevel Class: STXTopic

Table of Contents

Class: STXTopic Zope-2-CVS-src/lib/python/HelpSys/HelpTopic.py

A structured-text topic. Holds a HTMLFile object.

Base Classes   
TextTopic
Methods   
index_html
  index_html  
index_html ( self,  REQUEST=None )

View the STX Help Topic

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpTopic_TextTopic.py.html0100600000176200017510000001150407306455551027233 0ustar dhellmanndevel Class: TextTopic

Table of Contents

Class: TextTopic Zope-2-CVS-src/lib/python/HelpSys/HelpTopic.py

A basic Help Topic. Holds a text file.

Base Classes   
HelpTopic
    Acquisition.Implicit
    HelpTopicBase
    Item
    PropertyManager
    Persistent
Methods   
SearchableText
__init__
index_html
  SearchableText  
SearchableText ( self )

The full text of the Help Topic, for indexing purposes

  __init__  
__init__ (
        self,
        id,
        title,
        file,
        permissions=None,
        categories=None,
        )

  index_html  
index_html ( self,  REQUEST=None )

View the Help Topic

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpUtil.py.html0100600000176200017510000002303107306455551025065 0ustar dhellmanndevel Module: HelpUtil

Table of Contents

Module: HelpUtil Zope-2-CVS-src/lib/python/HelpSys/HelpUtil.py

Help system support module

Imported modules   
import Acquisition
import Globals
import StructuredText.StructuredText
import os
import re
import string
import sys
Functions   
_chAttribute
_chClass
_chMethod
_chModule
is_attribute
is_class
is_method
is_module
  _chAttribute  
_chAttribute ( name,  ob )

  _chClass  
_chClass ( name,  ob )

  _chMethod  
_chMethod ( name,  ob )

  _chModule  
_chModule ( name,  ob )

  is_attribute  
is_attribute ( ob )

  is_class  
is_class ( ob )

  is_method  
is_method ( ob )

  is_module  
is_module ( ob )

Classes   
HelpBase
classobject
methodobject
moduleobject
object

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpUtil_HelpBase.py.html0100600000176200017510000000763607306455551026645 0ustar dhellmanndevel Class: HelpBase

Table of Contents

Class: HelpBase Zope-2-CVS-src/lib/python/HelpSys/HelpUtil.py

Base Classes   
Acquisition.Implicit
Methods   
__bobo_traverse__
__len__
  __bobo_traverse__  
__bobo_traverse__ (
        self,
        REQUEST,
        name=None,
        )

  __len__  
__len__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpUtil_classobject.py.html0100600000176200017510000002014607306455551027445 0ustar dhellmanndevel Class: classobject

Table of Contents

Class: classobject Zope-2-CVS-src/lib/python/HelpSys/HelpUtil.py

Base Classes   
object
    Acquisition.Implicit
Methods   
get_base_list
get_bases
get_file
get_metatype
get_method_dict
get_method_list
get_methods
get_module
  get_base_list  
get_base_list ( self,  list=None )

  get_bases  
get_bases ( self )

  get_file  
get_file ( self )

  get_metatype  
get_metatype ( self )

  get_method_dict  
get_method_dict ( self,  dict=None )

  get_method_list  
get_method_list ( self )

  get_methods  
get_methods ( self )

  get_module  
get_module ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpUtil_methodobject.py.html0100600000176200017510000001526607306455551027627 0ustar dhellmanndevel Class: methodobject

Table of Contents

Class: methodobject Zope-2-CVS-src/lib/python/HelpSys/HelpUtil.py

Base Classes   
object
    Acquisition.Implicit
Methods   
get_class
get_docstring
get_file
get_module
get_signature
get_signaturex
  get_class  
get_class ( self )

  get_docstring  
get_docstring ( self )

  get_file  
get_file ( self )

  get_module  
get_module ( self )

  get_signature  
get_signature ( self )

  get_signaturex  
get_signaturex ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpUtil_moduleobject.py.html0100600000176200017510000001113107306455551027617 0ustar dhellmanndevel Class: moduleobject

Table of Contents

Class: moduleobject Zope-2-CVS-src/lib/python/HelpSys/HelpUtil.py

Base Classes   
object
    Acquisition.Implicit
Methods   
get_classes
get_file
get_modules
  get_classes  
get_classes ( self )

  get_file  
get_file ( self )

  get_modules  
get_modules ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/HelpUtil_object.py.html0100600000176200017510000002311007306455551026411 0ustar dhellmanndevel Class: object

Table of Contents

Class: object Zope-2-CVS-src/lib/python/HelpSys/HelpUtil.py

Base Classes   
Acquisition.Implicit
Methods   
__getattr__
__init__
__len__
get_docstring
get_docstring_html
get_id
get_name
get_type
get_value
version
  __getattr__  
__getattr__ ( self,  name )

  __init__  
__init__ (
        self,
        name,
        ob,
        op=None,
        )

  __len__  
__len__ ( self )

  get_docstring  
get_docstring ( self )

  get_docstring_html  
get_docstring_html ( self )

  get_id  
get_id ( self )

  get_name  
get_name ( self )

  get_type  
get_type ( self )

  get_value  
get_value ( self )

  version  
version ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/ObjectRef.py.html0100600000176200017510000000665507306455551025217 0ustar dhellmanndevel Module: ObjectRef

Table of Contents

Module: ObjectRef Zope-2-CVS-src/lib/python/HelpSys/ObjectRef.py

Object Reference implementation

Imported modules   
import Acquisition
import Globals
from Globals import DTMLFile
from HelpUtil import HelpBase, classobject, is_class, is_module
import os
import string
import sys
from urllib import quote
Classes   
ObjectItem
ObjectRef

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/ObjectRef_ObjectItem.py.html0100600000176200017510000001507507306455551027320 0ustar dhellmanndevel Class: ObjectItem

Table of Contents

Class: ObjectItem Zope-2-CVS-src/lib/python/HelpSys/ObjectRef.py

Base Classes   
HelpBase
classobject
Methods   
__getattr__
get_method_list
hs_id
hs_objectvalues
hs_url
  __getattr__  
__getattr__ ( self,  name )

Exceptions   
AttributeError, name
  get_method_list  
get_method_list ( self )

  hs_id  
hs_id ( self )

  hs_objectvalues  
hs_objectvalues ( self )

  hs_url  
hs_url ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/ObjectRef_ObjectRef.py.html0100600000176200017510000001252407306455551027132 0ustar dhellmanndevel Class: ObjectRef

Table of Contents

Class: ObjectRef Zope-2-CVS-src/lib/python/HelpSys/ObjectRef.py

Base Classes   
HelpBase
Methods   
__getitem__
hs_deferred__init__
hs_objectvalues
hs_search_mod
  __getitem__  
__getitem__ ( self,  key )

  hs_deferred__init__  
hs_deferred__init__ ( self )

  hs_objectvalues  
hs_objectvalues ( self )

  hs_search_mod  
hs_search_mod (
        self,
        mod,
        dict,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/HelpSys/__init__.py.html0100600000176200017510000000374707306455551025112 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/HelpSys/__init__.py

Imported modules   
import HelpSys
import sys

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:26 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/0040700000176200017510000000000007306455553022337 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/index.html0100600000176200017510000003617707306455554024352 0ustar dhellmanndevel Zope2 CVS with ZEO: Interface

Table of Contents

Zope2 CVS with ZEO: Interface  

Python Interfaces - The Scarecrow Implementation

Note: This is Jim's original proposal. Up to date user docs can be found at http://www.zope.org/Wikis/Interfaces

This document describes my implementation of the Python interfaces scarecrow proposal.

Status

This is a first-cut implementation of the proposal. My primary goal is to shed light on some ideas and to provide a framework for concrete discussion.

This implementation has had minimal testing. I expect many aspects of the implementation to evolve over time.

Basic assumptions:

Interfaces are not classes:

  • Interfaces have their own "hierarchy" (DAG really)

  • Interfaces are objects that provide a protocol for querying attributes (including methods) defined by an an interface:

    names()

    return a sequence of defined names

    getDescriptionFor(name, [default])

    Get a description of a name.

  • You cannot mix interfaces and classes in base-class lists.

There are utilities and methods for computing implied interfaces from classes and for computing "deferred" classes from interfaces.

Why aren't interface classes? Interfaces perform a different function that classes. Classes are for sharing implementation. Interfaces are for denoting, defining, and documenting abstract behavior.

Details

Software layout

There is an Interface package that exports a variety of useful facilities. These are described below.

Creating Interfaces

Interfaces can be created in several ways. The class statement can be used with one or more interfaces provided as base classes. This approach is convenient, syntactically, although it is a little misleading, since interfaces are not classes. A minimal interface that can be used as a base is Interface.Base.

You can also call Interface.new:

new(name, [bases, attrs, __doc__]) --

Create a new interface. The arguments are:

name

the interface name

bases

a sequence of "base" interfaces. Base interfaces are "extended" by the new interface.

attrs

an object that conforms to Interfaces.Standard.Dictionary that provides attributes defined by an interface. The attributes should be Interface.Attribute objects.

Finally you can compute an implied interface from a class by calling Interface.impliedInterface:

impliedInterface(klass, [__name__, __doc__])
klass

a class from which to create an interface.

__name__

The name of the interface. The default name is the class name with the suffix "Interface".

__doc__

a doc string for the interface. The default doc string is the class doc string.

The generated interface has attributes for each public method defined in or inherited by the interface. A method is considered public if it has a non-empty doc string and if it's name does not begin with _ or does begin and end with __ and is greater than 4 characters in length.

Note that computing an interface from a class does not automatically assert that the class implements an interface.

Here's an example:

      class X:

        def foo(self, a, b):
          ...

      XInterface=Interface.impliedInterface(X)
      X.__implements__=XInterface

Interface assertions

Objects can assert that they implement one or more interfaces. They do this by by defining an __interfaces__ attribute that is bound to an interface assertion.

An interface assertion is either:

  • an Interface or

  • a sequence of interface assertions.

Here are some examples of interface assertions:

I1

I1, I2

I1, (I2, I3)

where I1, I2, and I3 are interfaces.

Classes may provide (default) assertions for their instances (and subclass instances). The usual inheritance rules apply. Note that the definition of interface assertions makes composition of interfaces straightforward. For example:

      class A:

        __implements__ = I1, I2 

        ...

      class B

        __implements__ = I3, I4

      class C(A. B):
        ...

      class D:

        __implements__ = I5

      class E:

        __implements__ = I5, A.__implements__

Special-case handling of classes

Special handling is required for Python classes to make assertions about the interfaces a class implements, as opposed to the interfaces that the instances of the class implement. You cannot simply define an __implements__ attribute for the class because class "attributes" apply to instances.

By default, classes are assumed to implement the Interface.Standard.Class interface. A class may override the default by providing a __class_implements__ attribute which will be treated as if it were the __implements__ attribute of the class.

Testing assertions

You can test whether an object implements an interface by calling the implementedBy method of the interface and passing the object:

      I1.implementedBy(x)

Similarly, you can test whether, by default, instances of a class implement an interface by calling the implementedByInstancesOf method on the interface and passing the class:

      I1.implementedByInstancesOf(A)

Testing interfaces

You can test whether one interface extends another by calling the extends method on an interface:

I1.extends(I2)

Note that an interface does not extend itself.

Interface attributes

The purpose of an interface is to describe behavior, not to provide implementation. In a similar fashion the attributes of an interface describe and document the attributes provided by an object that implements the interface.

There are currently two kinds of supported attributes:

Interface.Attribute

The objects describe interface attributes. They define at least names and doc strings and may define other information as well.

Interface.Method

These are interface attributes that describe methods. They may define information about method signatures. (Note Methods are kinds of Attributes.)

When a class statement is used to define an interface, method definitions may be provided. These get converted to Method objects during interface creation. For example:

      class I1(Interface.Base):

        __name__=Attribute("The object's name")

        def foo(self, a, b):
           "blah blah"

defines an interface, I1 that has two attributes, __name__ and foo. The attribute foo is a Method instance. It is not a Python method.

It is my expectation that Attribute objects will eventually be able to provide all sorts of interesting meta-data.

Deferred classes

You cannot use interfaces as base classes. You can, however, create "deferred" classes from an interface:

class StackInterface(Interface.Base):

def push(self, v): "Add a value to the top of a stack"

def pop(self): "Remove and return an object from the top of the stack"

class Stack(StackInterface.deferred()): "This is supposed to implement a stack"

__implements__=StackInterface

Attempts to call methods inherited from a deferred class will raise Interface.BrokenImplementation exceptions.

Trial balloon: abstract implementations

Tim Peters has expressed the desire to provide abstract implementations in interface definitions, where, presumably, an abstract implementation uses only features defined by the interface.

Perhaps if a method definition has a body (other than a doc string), then the corresponding method in the deferred class will not be deferred. This would not be hard to do in CPython if I cheat and sniff at method bytecodes.

For example:

      class ListInterface(Interface.Standard.MutableSequence):

        def append(self, v):
           "add a value to the end of the object"

        def push(self, v):
           "add a value to the end of the object"
           self.append(v)

      ListBase=ListInterface.deferred()

      class ListImplementer(Listbase):
         def append(self, v): ...

In this example, we can create a base class, ListBase, that provides an abstract implementation of push and an implementation of append that raises an error if not overridden.

Standard interfaces

The module Interface.Standard defines interfaces for standard python objects.

This module and the modules it uses need a lot more work!

Handling existing built-in types

A hack is provided to allow implementation assertions to be made for builtin types. Interfaces.assertTypeImplements can be called to assert that instances of a built-in type implement one or more interfaces:

       Util.assertTypeImplements(
         type(1L), 
         (AbritraryPrecision, BitNumber, Signed))

Issues

  • What should the objects that define attributes look like? They shouldn't be the attributes, but should describe the the attributes.

    Note that we've made a first cut with Attribute and Method objects.

    Note that the information contained in a non-method attribute object might contain the attribute value's interface as well as other information, such as an attribute's usage.

  • There are places in the current implementation that use isinstance that should be changed to use interface checks.

  • When the interface interfaces are finalized, C implementations will be highly desirable for performance reasons.

  • A lot more work is needed on the standard interface hierarchy.

...

Modules and Packages   

Zope-2-CVS-src/lib/python/Interface/

CHANGES.txt.html

Interface package change history

README.html

Scarecrow interface implementation

README.txt.html

Python Interfaces - The Scarecrow Implementation

Attr
Basic
Exceptions
InterfaceBase
Mapping
Method

Method interfaces

Number
Standard
Util
__init__
iclass

Python Interfaces

pprint
test
unitfixtures
unittests
verify

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Attr.py.html0100600000176200017510000000531607306455552024571 0ustar dhellmanndevel Module: Attr

Table of Contents

Module: Attr Zope-2-CVS-src/lib/python/Interface/Attr.py

Imported modules   
from InterfaceBase import InterfaceBase
Classes   
Attribute

Attribute descriptions

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Attr_Attribute.py.html0100600000176200017510000000626607306455552026621 0ustar dhellmanndevel Class: Attribute

Table of Contents

Class: Attribute Zope-2-CVS-src/lib/python/Interface/Attr.py

Attribute descriptions

Base Classes   
InterfaceBase
Methods   
__init__
  __init__  
__init__ (
        self,
        __name__=None,
        __doc__=None,
        )

Create an attribute description

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Basic.py.html0100600000176200017510000000651407306455552024701 0ustar dhellmanndevel Module: Basic

Table of Contents

Module: Basic Zope-2-CVS-src/lib/python/Interface/Basic.py

Imported modules   
from iclass import Base
Classes   
Comparable

Objects that can be tested for equality

HashKey

Objects that are immutable with respect to state that

Hashable

Objects that support hash

Mutable

Mutable objects

Orderable

Objects that can be compared with < > == <= >= !=

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Basic_Comparable.py.html0100600000176200017510000000363707306455552027031 0ustar dhellmanndevel Class: Comparable

Table of Contents

Class: Comparable Zope-2-CVS-src/lib/python/Interface/Basic.py

Objects that can be tested for equality

Base Classes   
Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Basic_HashKey.py.html0100600000176200017510000000413407306455552026311 0ustar dhellmanndevel Class: HashKey

Table of Contents

Class: HashKey Zope-2-CVS-src/lib/python/Interface/Basic.py

Objects that are immutable with respect to state that influences comparisons or hash values

Base Classes   
Comparable
    Base
Hashable
    Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Basic_Hashable.py.html0100600000176200017510000000361507306455552026467 0ustar dhellmanndevel Class: Hashable

Table of Contents

Class: Hashable Zope-2-CVS-src/lib/python/Interface/Basic.py

Objects that support hash

Base Classes   
Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Basic_Mutable.py.html0100600000176200017510000000360107306455552026344 0ustar dhellmanndevel Class: Mutable

Table of Contents

Class: Mutable Zope-2-CVS-src/lib/python/Interface/Basic.py

Mutable objects

Base Classes   
Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Basic_Orderable.py.html0100600000176200017510000000376607306455552026666 0ustar dhellmanndevel Class: Orderable

Table of Contents

Class: Orderable Zope-2-CVS-src/lib/python/Interface/Basic.py

Objects that can be compared with < > == <= >= !=

Base Classes   
Comparable
    Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Exceptions.py.html0100600000176200017510000000514507306455552026000 0ustar dhellmanndevel Module: Exceptions

Table of Contents

Module: Exceptions Zope-2-CVS-src/lib/python/Interface/Exceptions.py

Classes   
BrokenImplementation

An attribute is not completely implemented.

BrokenMethodImplementation

An method is not completely implemented.

DoesNotImplement

This object does not implement

InvalidInterface

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Exceptions_BrokenImplementation.py.html0100600000176200017510000000760207306455552032206 0ustar dhellmanndevel Class: BrokenImplementation

Table of Contents

Class: BrokenImplementation Zope-2-CVS-src/lib/python/Interface/Exceptions.py

An attribute is not completely implemented.

Base Classes   
Exception
Methods   
__init__
__str__
  __init__  
__init__ (
        self,
        interface,
        name,
        )

  __str__  
__str__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Exceptions_BrokenMethodImplementation.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Exceptions_BrokenMethodImplementation.py.htm0100600000176200017510000000754207306455552033176 0ustar dhellmanndevel Class: BrokenMethodImplementation

Table of Contents

Class: BrokenMethodImplementation Zope-2-CVS-src/lib/python/Interface/Exceptions.py

An method is not completely implemented.

Base Classes   
Exception
Methods   
__init__
__str__
  __init__  
__init__ ( self,  method )

  __str__  
__str__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Exceptions_DoesNotImplement.py.html0100600000176200017510000000750707306455552031312 0ustar dhellmanndevel Class: DoesNotImplement

Table of Contents

Class: DoesNotImplement Zope-2-CVS-src/lib/python/Interface/Exceptions.py

This object does not implement

Base Classes   
Exception
Methods   
__init__
__str__
  __init__  
__init__ ( self,  interface )

  __str__  
__str__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Exceptions_InvalidInterface.py.html0100600000176200017510000000366607306455552031275 0ustar dhellmanndevel Class: InvalidInterface

Table of Contents

Class: InvalidInterface Zope-2-CVS-src/lib/python/Interface/Exceptions.py

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/InterfaceBase.py.html0100600000176200017510000000401507306455552026345 0ustar dhellmanndevel Module: InterfaceBase

Table of Contents

Module: InterfaceBase Zope-2-CVS-src/lib/python/Interface/InterfaceBase.py

Classes   
InterfaceBase

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/InterfaceBase_InterfaceBase.py.html0100600000176200017510000001255207306455552031125 0ustar dhellmanndevel Class: InterfaceBase

Table of Contents

Class: InterfaceBase Zope-2-CVS-src/lib/python/Interface/InterfaceBase.py

Methods   
getDoc
getName
getTaggedValue
getTaggedValueTags
setTaggedValue
  getDoc  
getDoc ( self )

Returns the documentation for the object.

  getName  
getName ( self )

Returns the name of the object.

  getTaggedValue  
getTaggedValue ( self,  tag )

Returns the value associated with tag.

  getTaggedValueTags  
getTaggedValueTags ( self )

Returns a list of all tags.

  setTaggedValue  
setTaggedValue (
        self,
        tag,
        value,
        )

Associates value with key.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Mapping.py.html0100600000176200017510000000747507306455552025262 0ustar dhellmanndevel Module: Mapping

Table of Contents

Module: Mapping Zope-2-CVS-src/lib/python/Interface/Mapping.py

Imported modules   
import Basic
import Util
Classes   
EnumerableMapping
Mapping

anything supporting __getitem__

MinimalDictionary

Provide minimal dictionary-like behavior

MutableMapping

Has __setitem__ and __delitem__

QueryMapping
Sequence

Keys must be integers in a sequence starting at 0.

Sequential

Keys must be used in order

Sized

anything supporting __len

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Mapping_EnumerableMapping.py.html0100600000176200017510000000650707306455552030730 0ustar dhellmanndevel Class: EnumerableMapping

Table of Contents

Class: EnumerableMapping Zope-2-CVS-src/lib/python/Interface/Mapping.py

Base Classes   
Mapping
    Basic.Base
Methods   
keys
  keys  
keys ()

Return an Sequence containing the keys in the collection

The type of the IReadSequence is not specified. It could be a list or a tuple or some other type.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Mapping_Mapping.py.html0100600000176200017510000000630707306455552026726 0ustar dhellmanndevel Class: Mapping

Table of Contents

Class: Mapping Zope-2-CVS-src/lib/python/Interface/Mapping.py

anything supporting __getitem__

Base Classes   
Basic.Base
Methods   
__getitem__
  __getitem__  
__getitem__ ( key )

Get the value for the given key

Raise a key error if the key if not in the collection.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Mapping_MinimalDictionary.py.html0100600000176200017510000001111007306455552030733 0ustar dhellmanndevel Class: MinimalDictionary

Table of Contents

Class: MinimalDictionary Zope-2-CVS-src/lib/python/Interface/Mapping.py

Provide minimal dictionary-like behavior

Base Classes   
QueryMapping
Sized
    Basic.Base
MutableMapping
    Basic.Mutable
EnumerableMapping
Methods   
items
values
  items  
items ()

Return a IReadSequence containing the items in the collection

An item is a key-value tuple.

The type of the IReadSequence is not specified. It could be a list or a tuple or some other type.

  values  
values ()

Return a IReadSequence containing the values in the collection

The type of the IReadSequence is not specified. It could be a list or a tuple or some other type.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Mapping_MutableMapping.py.html0100600000176200017510000000763407306455552030244 0ustar dhellmanndevel Class: MutableMapping

Table of Contents

Class: MutableMapping Zope-2-CVS-src/lib/python/Interface/Mapping.py

Has __setitem__ and __delitem__

Base Classes   
Basic.Mutable
Methods   
__delitem__
__setitem__
  __delitem__  
__delitem__ ( key )

delete the value for the given key

Raise a key error if the key if not in the collection.

  __setitem__  
__setitem__ ( key,  value )

Set the value for the given key

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Mapping_QueryMapping.py.html0100600000176200017510000000767207306455552027762 0ustar dhellmanndevel Class: QueryMapping

Table of Contents

Class: QueryMapping Zope-2-CVS-src/lib/python/Interface/Mapping.py

Base Classes   
Mapping
    Basic.Base
Methods   
get
has_key
  get  
get ( key,  default )

Get the value for the given key

Return the default if the key is not in the collection.

  has_key  
has_key ( key )

Check whether the object has an item with the given key

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Mapping_Sequence.py.html0100600000176200017510000000375507306455552027107 0ustar dhellmanndevel Class: Sequence

Table of Contents

Class: Sequence Zope-2-CVS-src/lib/python/Interface/Mapping.py

Keys must be integers in a sequence starting at 0.

Base Classes   
Mapping
    Basic.Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Mapping_Sequential.py.html0100600000176200017510000000403207306455552027436 0ustar dhellmanndevel Class: Sequential

Table of Contents

Class: Sequential Zope-2-CVS-src/lib/python/Interface/Mapping.py

Keys must be used in order

Base Classes   
Sequence

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Mapping_Sized.py.html0100600000176200017510000000614707306455552026413 0ustar dhellmanndevel Class: Sized

Table of Contents

Class: Sized Zope-2-CVS-src/lib/python/Interface/Mapping.py

anything supporting __len

Base Classes   
Basic.Base
Methods   
__len__
  __len__  
__len__ ()

Return the number of items in the container

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Method.py.html0100600000176200017510000000552407306455552025100 0ustar dhellmanndevel Module: Method

Table of Contents

Module: Method Zope-2-CVS-src/lib/python/Interface/Method.py

Method interfaces

Imported modules   
from Attr import Attribute
import Exceptions
Classes   
Method

Method interfaces

MethodClass

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Method_Method.py.html0100600000176200017510000001421107306455552026371 0ustar dhellmanndevel Class: Method

Table of Contents

Class: Method Zope-2-CVS-src/lib/python/Interface/Method.py

Method interfaces

The idea here is that you have objects that describe methods. This provides an opportunity for rich meta-data.

Base Classes   
Attribute
Methods   
__call__
__init__
getSignatureInfo
getSignatureString
  __call__  
__call__ (
        self,
        *args,
        *kw,
        )

Exceptions   
Exceptions.BrokenImplementation( self.interface, self.__name__ )
  __init__  
__init__ (
        self,
        __name__=None,
        __doc__=None,
        )

Create a method description

  getSignatureInfo  
getSignatureInfo ( self )

  getSignatureString  
getSignatureString ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Method_MethodClass.py.html0100600000176200017510000000646707306455552027375 0ustar dhellmanndevel Class: MethodClass

Table of Contents

Class: MethodClass Zope-2-CVS-src/lib/python/Interface/Method.py

Methods   
fromFunction
fromMethod
  fromFunction  
fromFunction (
        self,
        func,
        interface='',
        )

  fromMethod  
fromMethod (
        self,
        meth,
        interface='',
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number.py.html0100600000176200017510000001351407306455552025106 0ustar dhellmanndevel Module: Number

Table of Contents

Module: Number Zope-2-CVS-src/lib/python/Interface/Number.py

Imported modules   
import Basic
import Util
Classes   
AbritraryPrecision

  1. long, rationals

BitNumber

Numbers that can be interpreted as strings of bits

CheckedOverflow

raises OverflowError when results don't fit

Complex

has re and im fields (which are themselves real)

Exact

  1. integers and rationals; also fixed point

FD

fixed_decimal<n+m>

FP1

int() applied to these returns an integer that fits in 16 bits

FP16

int() applied to these returns an integer that fits in 16 bits

FP32

int() applied to these returns an integer that fits in 32 bits

FP64

int() applied to these returns an integer that fits in 32 bits

FP8

int() applied to these returns an integer that fits in 16 bits

FixedPrecisionInt

Fixed precision integers

Inexact

floating point arithmetic

Number

Numeric interface

Offsetable

Things that you can subtract and add numbers too

Real

any subset of the real numbers (this includes ints and rationals)

Signed

These can be < 0

UncheckedOverflow

take results module 2**N (for example)

Unsigned

These can not be < 0

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_AbritraryPrecision.py.html0100600000176200017510000000404707306455552031002 0ustar dhellmanndevel Class: AbritraryPrecision

Table of Contents

Class: AbritraryPrecision Zope-2-CVS-src/lib/python/Interface/Number.py

  1. long, rationals

Base Classes   
Exact

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_BitNumber.py.html0100600000176200017510000000375007306455552027056 0ustar dhellmanndevel Class: BitNumber

Table of Contents

Class: BitNumber Zope-2-CVS-src/lib/python/Interface/Number.py

Numbers that can be interpreted as strings of bits

they support & | ~ ^ << >>

Base Classes   
Basic.Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_CheckedOverflow.py.html0100600000176200017510000000417407306455552030242 0ustar dhellmanndevel Class: CheckedOverflow

Table of Contents

Class: CheckedOverflow Zope-2-CVS-src/lib/python/Interface/Number.py

raises OverflowError when results don't fit

Base Classes   
FixedPrecisionInt

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_Complex.py.html0100600000176200017510000000374507306455552026602 0ustar dhellmanndevel Class: Complex

Table of Contents

Class: Complex Zope-2-CVS-src/lib/python/Interface/Number.py

has re and im fields (which are themselves real)

Base Classes   
Number
    Basic.Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_Exact.py.html0100600000176200017510000000375407306455552026237 0ustar dhellmanndevel Class: Exact

Table of Contents

Class: Exact Zope-2-CVS-src/lib/python/Interface/Number.py

  1. integers and rationals; also fixed point

Base Classes   
Number
    Basic.Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_FD.py.html0100600000176200017510000000414707306455552025461 0ustar dhellmanndevel Class: FD

Table of Contents

Class: FD Zope-2-CVS-src/lib/python/Interface/Number.py

fixed_decimal<n+m>

a signed fixed decimal number with n digits before and m digits after the decimal point

Base Classes   
Exact

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_FP1.py.html0100600000176200017510000000452607306455552025557 0ustar dhellmanndevel Class: FP1

Table of Contents

Class: FP1 Zope-2-CVS-src/lib/python/Interface/Number.py

int() applied to these returns an integer that fits in 16 bits

Base Classes   
FP8

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_FP16.py.html0100600000176200017510000000435207306455552025642 0ustar dhellmanndevel Class: FP16

Table of Contents

Class: FP16 Zope-2-CVS-src/lib/python/Interface/Number.py

int() applied to these returns an integer that fits in 16 bits

Base Classes   
FP32

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_FP32.py.html0100600000176200017510000000426207306455552025640 0ustar dhellmanndevel Class: FP32

Table of Contents

Class: FP32 Zope-2-CVS-src/lib/python/Interface/Number.py

int() applied to these returns an integer that fits in 32 bits

Base Classes   
FP64

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_FP64.py.html0100600000176200017510000000417207306455552025645 0ustar dhellmanndevel Class: FP64

Table of Contents

Class: FP64 Zope-2-CVS-src/lib/python/Interface/Number.py

int() applied to these returns an integer that fits in 32 bits

Base Classes   
FixedPrecisionInt

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_FP8.py.html0100600000176200017510000000444007306455552025561 0ustar dhellmanndevel Class: FP8

Table of Contents

Class: FP8 Zope-2-CVS-src/lib/python/Interface/Number.py

int() applied to these returns an integer that fits in 16 bits

Base Classes   
FP16

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_FixedPrecisionInt.py.html0100600000176200017510000000403307306455552030550 0ustar dhellmanndevel Class: FixedPrecisionInt

Table of Contents

Class: FixedPrecisionInt Zope-2-CVS-src/lib/python/Interface/Number.py

Fixed precision integers

Base Classes   
Exact

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_Inexact.py.html0100600000176200017510000000371607306455552026564 0ustar dhellmanndevel Class: Inexact

Table of Contents

Class: Inexact Zope-2-CVS-src/lib/python/Interface/Number.py

floating point arithmetic

Base Classes   
Number
    Basic.Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_Number.py.html0100600000176200017510000000411707306455552026415 0ustar dhellmanndevel Class: Number

Table of Contents

Class: Number Zope-2-CVS-src/lib/python/Interface/Number.py

Numeric interface

it is assumed that numeric types are embedded in each other in some way (this is the Scheme numerical tower I think); they support operators + - *, usually / and %, perhaps **

Base Classes   
Basic.Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_Offsetable.py.html0100600000176200017510000000373607306455552027245 0ustar dhellmanndevel Class: Offsetable

Table of Contents

Class: Offsetable Zope-2-CVS-src/lib/python/Interface/Number.py

Things that you can subtract and add numbers too

  1. Date-Time values.

Base Classes   
Basic.Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_Real.py.html0100600000176200017510000000376007306455552026053 0ustar dhellmanndevel Class: Real

Table of Contents

Class: Real Zope-2-CVS-src/lib/python/Interface/Number.py

any subset of the real numbers (this includes ints and rationals)

Base Classes   
Number
    Basic.Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_Signed.py.html0100600000176200017510000000412207306455552026372 0ustar dhellmanndevel Class: Signed

Table of Contents

Class: Signed Zope-2-CVS-src/lib/python/Interface/Number.py

These can be < 0

Base Classes   
FixedPrecisionInt

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_UncheckedOverflow.py.html0100600000176200017510000000417307306455552030604 0ustar dhellmanndevel Class: UncheckedOverflow

Table of Contents

Class: UncheckedOverflow Zope-2-CVS-src/lib/python/Interface/Number.py

take results module 2**N (for example)

Base Classes   
FixedPrecisionInt

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Number_Unsigned.py.html0100600000176200017510000000413207306455552026736 0ustar dhellmanndevel Class: Unsigned

Table of Contents

Class: Unsigned Zope-2-CVS-src/lib/python/Interface/Number.py

These can not be < 0

Base Classes   
FixedPrecisionInt

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Standard.py.html0100600000176200017510000000444007306455552025414 0ustar dhellmanndevel Module: Standard

Table of Contents

Module: Standard Zope-2-CVS-src/lib/python/Interface/Standard.py

Imported modules   
from Basic import *
from Mapping import *
from Number import *
import Util
import iclass
from iclass import Named, Class

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/Util.py.html0100600000176200017510000001451707306455553024600 0ustar dhellmanndevel Module: Util

Table of Contents

Module: Util Zope-2-CVS-src/lib/python/Interface/Util.py

Imported modules   
from types import FunctionType
Functions   
_ii
_wi
impliedInterface
instancesOfObjectImplements
objectImplements
  _ii  
_ii ( klass,  items )

  _wi  
_wi ( interfaces,  append )

  impliedInterface  
impliedInterface (
        klass,
        __name__=None,
        __doc__=None,
        )

Create an interface object from a class

The interface will contain only objects with doc strings and with names that begin and end with __ or names that don't begin with _.

  instancesOfObjectImplements  
instancesOfObjectImplements ( klass,  tiget=_typeImplements.get )

Return the interfaces that instanced implement (by default)

  objectImplements  
objectImplements ( object,  tiget=_typeImplements.get )

Return the interfaces implemented by the object

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/__init__.py.html0100600000176200017510000000560207306455553025415 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Interface/__init__.py

Imported modules   
from Attr import Attribute
from Exceptions import BrokenImplementation
from Method import Method
from Standard import Base
from Util import impliedInterface, assertTypeImplements, objectImplements, instancesOfObjectImplements
import iclass
from pprint import interface_as_stx
from verify import verify_class_implementation

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/iclass.py.html0100600000176200017510000001270607306455553025137 0ustar dhellmanndevel Module: iclass

Table of Contents

Module: iclass Zope-2-CVS-src/lib/python/Interface/iclass.py

Python Interfaces

Scarecrow version:

Classes or objects can implement an __implements__ attribute that names an interface object or a collection of interface objects.

An interface is defined using the class statement and one or more base interfaces.

Imported modules   
from Attr import Attribute
import Exceptions
from InterfaceBase import InterfaceBase
from Method import Method
from types import FunctionType, ClassType
Functions   
assertTypeImplements
  assertTypeImplements  
assertTypeImplements ( type,  interfaces )

Return the interfaces implemented by objects of the given type

Classes   
Class

Implement shared instance behavior and create instances

Interface

Prototype (scarecrow) Interfaces Implementation

InterfaceBaseInterface

A base class that defines a common Interface inteface.

InterfaceInterface

Interface objects describe the behavior of an object by containing

Named

Objects that have a name.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/iclass_Class.py.html0100600000176200017510000000414407306455553026261 0ustar dhellmanndevel Class: Class

Table of Contents

Class: Class Zope-2-CVS-src/lib/python/Interface/iclass.py

Implement shared instance behavior and create instances

Classes can be called to create an instance. This interface does not specify what if any arguments are required.

Base Classes   
Named
    Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/iclass_Interface.py.html0100600000176200017510000003004707306455553027115 0ustar dhellmanndevel Class: Interface

Table of Contents

Class: Interface Zope-2-CVS-src/lib/python/Interface/iclass.py

Prototype (scarecrow) Interfaces Implementation

Base Classes   
InterfaceBase
Methods   
__any
__d
__init__
__repr__
deferred
extends
getBases
getDescriptionFor
isImplementedBy
isImplementedByInstancesOf
 names
namesAndDescriptions
  __any  
__any ( self,  interfaces )

  __d  
__d ( self,  dict )

  __init__  
__init__ (
        self,
        name,
        bases=(),
        attrs=None,
        __doc__=None,
        )

Create a new interface

Exceptions   
Exceptions.InvalidInterface( "Concrete attribute, %s" % k )
TypeError, 'Expected base interfaces'
  __repr__  
__repr__ ( self )

  deferred  
deferred ( self )

Return a defrered class corresponding to the interface

  extends  
extends ( self,  other )

Does an interface extend another?

  getBases  
getBases ( self )

  getDescriptionFor  
getDescriptionFor (
        self,
        name,
        default=None,
        )

Return the attribute description for the given name

  isImplementedBy  
isImplementedBy (
        self,
        object,
        tiget=_typeImplements.get,
        )

Does the given object implement the interface?

  isImplementedByInstancesOf  
isImplementedByInstancesOf (
        self,
        klass,
        tiget=_typeImplements.get,
        )

Do instances of the given class implement the interface?

  names  
names ( self )

Return the attribute names defined by the interface

  namesAndDescriptions  
namesAndDescriptions ( self )

Return the attribute names and descriptions defined by the interface

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/iclass_InterfaceBaseInterface.py.html0100600000176200017510000000755007306455553031534 0ustar dhellmanndevel Class: InterfaceBaseInterface

Table of Contents

Class: InterfaceBaseInterface Zope-2-CVS-src/lib/python/Interface/iclass.py

A base class that defines a common Interface inteface.

Base Classes   
Base
Methods   
getDoc
getName
  getDoc  
getDoc ( self )

Returns the documentation for the current interface object.

  getName  
getName ( self )

Returns the name of the current interface object.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/iclass_InterfaceInterface.py.html0100600000176200017510000001323307306455553030734 0ustar dhellmanndevel Class: InterfaceInterface

Table of Contents

Class: InterfaceInterface Zope-2-CVS-src/lib/python/Interface/iclass.py

Interface objects describe the behavior of an object by containing useful information about the object. This information includes:

  • Prose documentation about the object. In Python terms, this is called the "doc string" of the interface. In this element, you describe how the object works in prose language and any other useful information about the object.

  • Descriptions of attributes. Attribute descriptions include the name of the attribute and prose documentation describing the attributes usage.

  • Descriptions of methods. Method descriptions can include:

    • Prose "doc string" documentation about the method and its usage.

    • A description of the methods arguments; how many arguments are expected, optional arguments and their default values, the position or arguments in the signature, whether the method accepts arbitrary arguments and whether the method accepts arbitrary keyword arguments.

  • Optional tagged data. Interface objects (and their attributes and methods) can have optional, application specific tagged data associated with them. Examples uses for this are examples, security assertions, pre/post conditions, and other possible information you may want to associate with an Interface or its attributes.

Not all of this information is mandatory. For example, you may only want the methods of your interface to have prose documentation and not describe the arguments of the method in exact detail. Interface objects are flexible and let you give or take any of these components.

Base Classes   
InterfaceBaseInterface
    Base
Methods   
extends
getBases
  extends  
extends ( self,  other )

  getBases  
getBases ( self )

Returns a sequence of base interfaces this interface extends.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/iclass_Named.py.html0100600000176200017510000000361007306455553026235 0ustar dhellmanndevel Class: Named

Table of Contents

Class: Named Zope-2-CVS-src/lib/python/Interface/iclass.py

Objects that have a name.

Base Classes   
Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/pprint.py.html0100600000176200017510000001147407306455553025176 0ustar dhellmanndevel Module: pprint

Table of Contents

Module: pprint Zope-2-CVS-src/lib/python/Interface/pprint.py

Imported modules   
import string
Functions   
interface_as_stx
justify_and_indent
trim_doc_string
  interface_as_stx  
interface_as_stx ( I,  munge=0 )

Output structured text format. Note, this will wack any existing structured format of the text.

  justify_and_indent  
justify_and_indent (
        text,
        level,
        munge=0,
        width=72,
        )

indent and justify text, rejustify (munge) if specified

  trim_doc_string  
trim_doc_string ( text )

Trims a doc string to make it format correctly with structured text.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/test.py.html0100600000176200017510000000756107306455553024643 0ustar dhellmanndevel Module: test

Table of Contents

Module: test Zope-2-CVS-src/lib/python/Interface/test.py

Imported modules   
import Interface
Classes   
A
AConcreteClass

A concrete class

AnAbstractBaseClass

This is an Abstract Base Class

B
Blah
C
D
E
I1
I2
I3
I4

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/test_A.py.html0100600000176200017510000000362607306455553025101 0ustar dhellmanndevel Class: A

Table of Contents

Class: A Zope-2-CVS-src/lib/python/Interface/test.py

Base Classes   
I1.deferred()

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/test_AConcreteClass.py.html0100600000176200017510000001120407306455553027541 0ustar dhellmanndevel Class: AConcreteClass

Table of Contents

Class: AConcreteClass Zope-2-CVS-src/lib/python/Interface/test.py

A concrete class

Methods   
aMethod
anotherMethod
useless
wammy
  aMethod  
aMethod (
        self,
        foo,
        bar,
        bingo,
        )

This is aMethod

  anotherMethod  
anotherMethod (
        self,
        foo=6,
        bar="where you get sloshed",
        bingo=( 1, 3, ),
        )

This is anotherMethod

  useless  
useless ( self,  **keywords )

useless code is fun!

  wammy  
wammy (
        self,
        zip,
        *argues,
        )

yadda yadda

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/test_AnAbstractBaseClass.py.html0100600000176200017510000001123407306455553030516 0ustar dhellmanndevel Class: AnAbstractBaseClass

Table of Contents

Class: AnAbstractBaseClass Zope-2-CVS-src/lib/python/Interface/test.py

This is an Abstract Base Class

Methods   
aMethod
anotherMethod
useless
wammy
  aMethod  
aMethod (
        self,
        foo,
        bar,
        bingo,
        )

This is aMethod

  anotherMethod  
anotherMethod (
        self,
        foo=6,
        bar="where you get sloshed",
        bingo=( 1, 3, ),
        )

This is anotherMethod

  useless  
useless ( self,  **keywords )

useless code is fun!

  wammy  
wammy (
        self,
        zip,
        *argues,
        )

yadda yadda

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/test_B.py.html0100600000176200017510000000240507306455553025074 0ustar dhellmanndevel Class: B

Table of Contents

Class: B Zope-2-CVS-src/lib/python/Interface/test.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/test_Blah.py.html0100600000176200017510000000241307306455553025560 0ustar dhellmanndevel Class: Blah

Table of Contents

Class: Blah Zope-2-CVS-src/lib/python/Interface/test.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/test_C.py.html0100600000176200017510000000615307306455553025101 0ustar dhellmanndevel Class: C

Table of Contents

Class: C Zope-2-CVS-src/lib/python/Interface/test.py

Methods   
m1
m2
  m1  
m1 (
        self,
        a,
        b,
        )

return 1

  m2  
m2 (
        self,
        a,
        b,
        )

return 2

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/test_D.py.html0100600000176200017510000000375107306455553025103 0ustar dhellmanndevel Class: D

Table of Contents

Class: D Zope-2-CVS-src/lib/python/Interface/test.py

Base Classes   
A
    I1.deferred()
B

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/test_E.py.html0100600000176200017510000000375107306455553025104 0ustar dhellmanndevel Class: E

Table of Contents

Class: E Zope-2-CVS-src/lib/python/Interface/test.py

Base Classes   
A
    I1.deferred()
B

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/test_I1.py.html0100600000176200017510000000606707306455553025174 0ustar dhellmanndevel Class: I1

Table of Contents

Class: I1 Zope-2-CVS-src/lib/python/Interface/test.py

Base Classes   
Interface.Base
Methods   
ma
  ma  
ma ( self )

blah

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/test_I2.py.html0100600000176200017510000000371307306455553025170 0ustar dhellmanndevel Class: I2

Table of Contents

Class: I2 Zope-2-CVS-src/lib/python/Interface/test.py

Base Classes   
I1
    Interface.Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/test_I3.py.html0100600000176200017510000000363107306455553025170 0ustar dhellmanndevel Class: I3

Table of Contents

Class: I3 Zope-2-CVS-src/lib/python/Interface/test.py

Base Classes   
Interface.Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/test_I4.py.html0100600000176200017510000000363107306455553025171 0ustar dhellmanndevel Class: I4

Table of Contents

Class: I4 Zope-2-CVS-src/lib/python/Interface/test.py

Base Classes   
Interface.Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/unitfixtures.py.html0100600000176200017510000000770507306455553026435 0ustar dhellmanndevel Module: unitfixtures

Table of Contents

Module: unitfixtures Zope-2-CVS-src/lib/python/Interface/unitfixtures.py

Imported modules   
import Interface
Classes   
A
B
Blah
C
D
E
Foo

A concrete class

FooInterface

This is an Abstract Base Class

I1
I2
I3
I4

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/unitfixtures_A.py.html0100600000176200017510000000363607306455553026674 0ustar dhellmanndevel Class: A

Table of Contents

Class: A Zope-2-CVS-src/lib/python/Interface/unitfixtures.py

Base Classes   
I1.deferred()

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/unitfixtures_B.py.html0100600000176200017510000000241507306455553026667 0ustar dhellmanndevel Class: B

Table of Contents

Class: B Zope-2-CVS-src/lib/python/Interface/unitfixtures.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/unitfixtures_Blah.py.html0100600000176200017510000000242307306455553027353 0ustar dhellmanndevel Class: Blah

Table of Contents

Class: Blah Zope-2-CVS-src/lib/python/Interface/unitfixtures.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/unitfixtures_C.py.html0100600000176200017510000000616307306455553026674 0ustar dhellmanndevel Class: C

Table of Contents

Class: C Zope-2-CVS-src/lib/python/Interface/unitfixtures.py

Methods   
m1
m2
  m1  
m1 (
        self,
        a,
        b,
        )

return 1

  m2  
m2 (
        self,
        a,
        b,
        )

return 2

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/unitfixtures_D.py.html0100600000176200017510000000400107306455553026662 0ustar dhellmanndevel Class: D

Table of Contents

Class: D Zope-2-CVS-src/lib/python/Interface/unitfixtures.py

Base Classes   
A
    I1.deferred()
B

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/unitfixtures_E.py.html0100600000176200017510000000400107306455553026663 0ustar dhellmanndevel Class: E

Table of Contents

Class: E Zope-2-CVS-src/lib/python/Interface/unitfixtures.py

Base Classes   
A
    I1.deferred()
B

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/unitfixtures_Foo.py.html0100600000176200017510000001116607306455553027234 0ustar dhellmanndevel Class: Foo

Table of Contents

Class: Foo Zope-2-CVS-src/lib/python/Interface/unitfixtures.py

A concrete class

Methods   
aMethod
anotherMethod
useless
wammy
  aMethod  
aMethod (
        self,
        foo,
        bar,
        bingo,
        )

This is aMethod

  anotherMethod  
anotherMethod (
        self,
        foo=6,
        bar="where you get sloshed",
        bingo=( 1, 3, ),
        )

This is anotherMethod

  useless  
useless ( self,  **keywords )

useless code is fun!

  wammy  
wammy (
        self,
        zip,
        *argues,
        )

yadda yadda

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/unitfixtures_FooInterface.py.html0100600000176200017510000001245007306455553031052 0ustar dhellmanndevel Class: FooInterface

Table of Contents

Class: FooInterface Zope-2-CVS-src/lib/python/Interface/unitfixtures.py

This is an Abstract Base Class

Base Classes   
Interface.Base
Methods   
aMethod
anotherMethod
useless
wammy
  aMethod  
aMethod (
        self,
        foo,
        bar,
        bingo,
        )

This is aMethod

  anotherMethod  
anotherMethod (
        self,
        foo=6,
        bar="where you get sloshed",
        bingo=( 1, 3, ),
        )

This is anotherMethod

  useless  
useless ( self,  **keywords )

useless code is fun!

  wammy  
wammy (
        self,
        zip,
        *argues,
        )

yadda yadda

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/unitfixtures_I1.py.html0100600000176200017510000000607707306455553026767 0ustar dhellmanndevel Class: I1

Table of Contents

Class: I1 Zope-2-CVS-src/lib/python/Interface/unitfixtures.py

Base Classes   
Interface.Base
Methods   
ma
  ma  
ma ( self )

blah

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/unitfixtures_I2.py.html0100600000176200017510000000373307306455553026764 0ustar dhellmanndevel Class: I2

Table of Contents

Class: I2 Zope-2-CVS-src/lib/python/Interface/unitfixtures.py

Base Classes   
I1
    Interface.Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/unitfixtures_I3.py.html0100600000176200017510000000364107306455553026763 0ustar dhellmanndevel Class: I3

Table of Contents

Class: I3 Zope-2-CVS-src/lib/python/Interface/unitfixtures.py

Base Classes   
Interface.Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/unitfixtures_I4.py.html0100600000176200017510000000364107306455553026764 0ustar dhellmanndevel Class: I4

Table of Contents

Class: I4 Zope-2-CVS-src/lib/python/Interface/unitfixtures.py

Base Classes   
Interface.Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/unittests.py.html0100600000176200017510000000750307306455553025722 0ustar dhellmanndevel Module: unittests

Table of Contents

Module: unittests Zope-2-CVS-src/lib/python/Interface/unittests.py

Imported modules   
import Interface
import unittest
Functions   
suite
  suite  
suite ()

Classes   
InterfaceTests

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/unittests_InterfaceTests.py.html0100600000176200017510000001545307306455553030730 0ustar dhellmanndevel Class: InterfaceTests

Table of Contents

Class: InterfaceTests Zope-2-CVS-src/lib/python/Interface/unittests.py

Base Classes   
unittest.TestCase
Methods   
setUp
tearDown
testClassImplements
testDeferredClass
testInterfaceExtendsInterface
testVerifyImplementation
  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

  testClassImplements  
testClassImplements ( self )

  testDeferredClass  
testDeferredClass ( self )

  testInterfaceExtendsInterface  
testInterfaceExtendsInterface ( self )

  testVerifyImplementation  
testVerifyImplementation ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/verify.py.html0100600000176200017510000001122307306455553025156 0ustar dhellmanndevel Module: verify

Table of Contents

Module: verify Zope-2-CVS-src/lib/python/Interface/verify.py

Imported modules   
from Exceptions import BrokenImplementation, DoesNotImplement, BrokenMethodImplementation
from Method import Method
import types
Functions   
verify_class_implementation
  verify_class_implementation  
verify_class_implementation ( iface,  klass )

Verify that klass correctly implements iface. This involves:

  • Making sure the klass defines all the necessary methods

  • Making sure the methods have the correct signature

  • Making sure the klass asserts that it implements the interface

Exceptions   
BrokenImplementation( iface, n )
BrokenMethodImplementation( n )
DoesNotImplement( iface )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/CHANGES.txt.html0100600000176200017510000000301607306455553025112 0ustar dhellmanndevel Zope2 CVS with ZEO: Interface

Table of Contents

Zope2 CVS with ZEO: Interface  

Interface package change history

Release 0.5 (Zope 2.3b1)

Many changes to API. Added unit tests, pretty printing, verification code, tagged data, and other stuff.

Release 0.1.1

This release includes some changes to the documentation to reflect comments made on 0.1.

Release 0.1

This was the initial release.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/README.html0100600000176200017510000000226007306455553024161 0ustar dhellmanndevel Zope2 CVS with ZEO: Interface

Table of Contents

Zope2 CVS with ZEO: Interface  

Scarecrow interface implementation

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Interface/README.txt.html0100600000176200017510000003025607306455553025005 0ustar dhellmanndevel Zope2 CVS with ZEO: Interface

Table of Contents

Zope2 CVS with ZEO: Interface  

Python Interfaces - The Scarecrow Implementation

Note: This is Jim's original proposal. Up to date user docs can be found at http://www.zope.org/Wikis/Interfaces

This document describes my implementation of the Python interfaces scarecrow proposal.

Status

This is a first-cut implementation of the proposal. My primary goal is to shed light on some ideas and to provide a framework for concrete discussion.

This implementation has had minimal testing. I expect many aspects of the implementation to evolve over time.

Basic assumptions:

Interfaces are not classes:

  • Interfaces have their own "hierarchy" (DAG really)

  • Interfaces are objects that provide a protocol for querying attributes (including methods) defined by an an interface:

    names()

    return a sequence of defined names

    getDescriptionFor(name, [default])

    Get a description of a name.

  • You cannot mix interfaces and classes in base-class lists.

There are utilities and methods for computing implied interfaces from classes and for computing "deferred" classes from interfaces.

Why aren't interface classes? Interfaces perform a different function that classes. Classes are for sharing implementation. Interfaces are for denoting, defining, and documenting abstract behavior.

Details

Software layout

There is an Interface package that exports a variety of useful facilities. These are described below.

Creating Interfaces

Interfaces can be created in several ways. The class statement can be used with one or more interfaces provided as base classes. This approach is convenient, syntactically, although it is a little misleading, since interfaces are not classes. A minimal interface that can be used as a base is Interface.Base.

You can also call Interface.new:

new(name, [bases, attrs, __doc__]) --

Create a new interface. The arguments are:

name

the interface name

bases

a sequence of "base" interfaces. Base interfaces are "extended" by the new interface.

attrs

an object that conforms to Interfaces.Standard.Dictionary that provides attributes defined by an interface. The attributes should be Interface.Attribute objects.

Finally you can compute an implied interface from a class by calling Interface.impliedInterface:

impliedInterface(klass, [__name__, __doc__])
klass

a class from which to create an interface.

__name__

The name of the interface. The default name is the class name with the suffix "Interface".

__doc__

a doc string for the interface. The default doc string is the class doc string.

The generated interface has attributes for each public method defined in or inherited by the interface. A method is considered public if it has a non-empty doc string and if it's name does not begin with _ or does begin and end with __ and is greater than 4 characters in length.

Note that computing an interface from a class does not automatically assert that the class implements an interface.

Here's an example:

      class X:

        def foo(self, a, b):
          ...

      XInterface=Interface.impliedInterface(X)
      X.__implements__=XInterface

Interface assertions

Objects can assert that they implement one or more interfaces. They do this by by defining an __interfaces__ attribute that is bound to an interface assertion.

An interface assertion is either:

  • an Interface or

  • a sequence of interface assertions.

Here are some examples of interface assertions:

I1

I1, I2

I1, (I2, I3)

where I1, I2, and I3 are interfaces.

Classes may provide (default) assertions for their instances (and subclass instances). The usual inheritance rules apply. Note that the definition of interface assertions makes composition of interfaces straightforward. For example:

      class A:

        __implements__ = I1, I2 

        ...

      class B

        __implements__ = I3, I4

      class C(A. B):
        ...

      class D:

        __implements__ = I5

      class E:

        __implements__ = I5, A.__implements__

Special-case handling of classes

Special handling is required for Python classes to make assertions about the interfaces a class implements, as opposed to the interfaces that the instances of the class implement. You cannot simply define an __implements__ attribute for the class because class "attributes" apply to instances.

By default, classes are assumed to implement the Interface.Standard.Class interface. A class may override the default by providing a __class_implements__ attribute which will be treated as if it were the __implements__ attribute of the class.

Testing assertions

You can test whether an object implements an interface by calling the implementedBy method of the interface and passing the object:

      I1.implementedBy(x)

Similarly, you can test whether, by default, instances of a class implement an interface by calling the implementedByInstancesOf method on the interface and passing the class:

      I1.implementedByInstancesOf(A)

Testing interfaces

You can test whether one interface extends another by calling the extends method on an interface:

I1.extends(I2)

Note that an interface does not extend itself.

Interface attributes

The purpose of an interface is to describe behavior, not to provide implementation. In a similar fashion the attributes of an interface describe and document the attributes provided by an object that implements the interface.

There are currently two kinds of supported attributes:

Interface.Attribute

The objects describe interface attributes. They define at least names and doc strings and may define other information as well.

Interface.Method

These are interface attributes that describe methods. They may define information about method signatures. (Note Methods are kinds of Attributes.)

When a class statement is used to define an interface, method definitions may be provided. These get converted to Method objects during interface creation. For example:

      class I1(Interface.Base):

        __name__=Attribute(&quot;The object's name&quot;)

        def foo(self, a, b):
           &quot;blah blah&quot;

defines an interface, I1 that has two attributes, __name__ and foo. The attribute foo is a Method instance. It is not a Python method.

It is my expectation that Attribute objects will eventually be able to provide all sorts of interesting meta-data.

Deferred classes

You cannot use interfaces as base classes. You can, however, create "deferred" classes from an interface:

class StackInterface(Interface.Base):

def push(self, v): "Add a value to the top of a stack"

def pop(self): "Remove and return an object from the top of the stack"

class Stack(StackInterface.deferred()): "This is supposed to implement a stack"

__implements__=StackInterface

Attempts to call methods inherited from a deferred class will raise Interface.BrokenImplementation exceptions.

Trial balloon: abstract implementations

Tim Peters has expressed the desire to provide abstract implementations in interface definitions, where, presumably, an abstract implementation uses only features defined by the interface.

Perhaps if a method definition has a body (other than a doc string), then the corresponding method in the deferred class will not be deferred. This would not be hard to do in CPython if I cheat and sniff at method bytecodes.

For example:

      class ListInterface(Interface.Standard.MutableSequence):

        def append(self, v):
           &quot;add a value to the end of the object&quot;

        def push(self, v):
           &quot;add a value to the end of the object&quot;
           self.append(v)

      ListBase=ListInterface.deferred()

      class ListImplementer(Listbase):
         def append(self, v): ...

In this example, we can create a base class, ListBase, that provides an abstract implementation of push and an implementation of append that raises an error if not overridden.

Standard interfaces

The module Interface.Standard defines interfaces for standard python objects.

This module and the modules it uses need a lot more work!

Handling existing built-in types

A hack is provided to allow implementation assertions to be made for builtin types. Interfaces.assertTypeImplements can be called to assert that instances of a built-in type implement one or more interfaces:

       Util.assertTypeImplements(
         type(1L), 
         (AbritraryPrecision, BitNumber, Signed))

Issues

  • What should the objects that define attributes look like? They shouldn't be the attributes, but should describe the the attributes.

    Note that we've made a first cut with Attribute and Method objects.

    Note that the information contained in a non-method attribute object might contain the attribute value's interface as well as other information, such as an attribute's usage.

  • There are places in the current implementation that use isinstance that should be changed to use interface checks.

  • When the interface interfaces are finalized, C implementations will be highly desirable for performance reasons.

  • A lot more work is needed on the standard interface hierarchy.

...

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:18 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/0040700000176200017510000000000007306455557021072 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/index.html0100600000176200017510000001334107306455557023070 0ustar dhellmanndevel Zope2 CVS with ZEO: OFS

Table of Contents

Zope2 CVS with ZEO: OFS  
Modules and Packages   

Zope-2-CVS-src/lib/python/OFS/

Application
Cache
CopySupport
DTMLDocument

DTML Document objects.

DTMLMethod

DTML Method objects.

DefaultObservable
Document

Deprecated - use DTMLMethod

FTPInterface

FTP Support for Zope classes.

FindSupport
Folder

Folder object

History

Object Histories

Image

Image object

Moniker

Object monikers

ObjectManager
PropertyManager

Property management

PropertySheets

Property sheets

SimpleItem

This module implements a simple item mix-in for objects that have a

Traversable

This module implements a mix-in for traversable objects.

Uninstalled

Objects for packages that have been uninstalled.

XMLExportImport
ZDOM

DOM implementation in ZOPE : Read-Only methods

__init__
content_types

A utility module for content-type handling.

misc_
ndiff

ndiff [-q] file1 file2

rPickle

Restricted unpickler

tests

Zope2 CVS with ZEO: OFS.tests

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/tests/0040700000176200017510000000000007306455554022231 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/tests/index.html0100600000176200017510000000410607306455554024226 0ustar dhellmanndevel Zope2 CVS with ZEO: OFS.tests

Table of Contents

Zope2 CVS with ZEO: OFS.tests  
Modules and Packages   

Zope-2-CVS-src/lib/python/OFS/tests/

__init__
testRanges

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:43 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/tests/__init__.py.html0100600000176200017510000000243707306455554025312 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/OFS/tests/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:43 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/tests/testRanges.py.html0100600000176200017510000001674107306455554025675 0ustar dhellmanndevel Module: testRanges

Table of Contents

Module: testRanges Zope-2-CVS-src/lib/python/OFS/tests/testRanges.py

Imported modules   
from Testing.makerequest import makerequest
import Zope
import cStringIO
from mimetools import Message
from multifile import MultiFile
import os
import re
import string
import sys
import time
import unittest
from webdav.common import rfc1123_date
import whrandom
Functions   
createBigFile
debug
main
pdebug
test_suite
  createBigFile  
createBigFile ()

  debug  
debug ()

  main  
main ()

  pdebug  
pdebug ()

  test_suite  
test_suite ()

Classes   
TestRequestRange

Test case setup and teardown

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:43 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/tests/testRanges_TestRequestRange.py.html0100600000176200017510000006245507306455554031225 0ustar dhellmanndevel Class: TestRequestRange

Table of Contents

Class: TestRequestRange Zope-2-CVS-src/lib/python/OFS/tests/testRanges.py

Test case setup and teardown

Base Classes   
unittest.TestCase
Methods   
createLastModifiedDate
doGET
expectMultipleRanges
expectOK
expectSingleRange
expectUnsatisfiable
setUp
tearDown
testAdjacentRanges
testBigFile
 testBigFileEndOverflow
testEndOverflow
testEqualIfRangeDate
testEqualIfRangeEtag
testGarbage
testIllegalIfRange
testIllegalSpec
testIsModifiedIfRangeDate
testIsNotModifiedIfRangeDate
testMultipleRanges
 testMultipleRangesBigFile
testMultipleRangesBigFileEndOverflow
testMultipleUnsatisfiable
testNegativeZero
testNotEqualIfRangeEtag
testOpenEndedRange
testSimpleRange
testStartBeyondLength
testSuffixRange
testWithNegativeZero
  createLastModifiedDate  
createLastModifiedDate ( self,  offset=0 )

  doGET  
doGET (
        self,
        request,
        response,
        )

  expectMultipleRanges  
expectMultipleRanges (
        self,
        range,
        sets,
        rangeParse=re.compile( 'bytes\s*(\d+)-(\d+)/(\d+)' ),
        )

  expectOK  
expectOK (
        self,
        rangeHeader,
        if_range=None,
        )

  expectSingleRange  
expectSingleRange (
        self,
        range,
        start,
        end,
        if_range=None,
        )

  expectUnsatisfiable  
expectUnsatisfiable ( self,  range )

  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

  testAdjacentRanges  
testAdjacentRanges ( self )

  testBigFile  
testBigFile ( self )

  testBigFileEndOverflow  
testBigFileEndOverflow ( self )

  testEndOverflow  
testEndOverflow ( self )

  testEqualIfRangeDate  
testEqualIfRangeDate ( self )

  testEqualIfRangeEtag  
testEqualIfRangeEtag ( self )

  testGarbage  
testGarbage ( self )

Malformed Range header

  testIllegalIfRange  
testIllegalIfRange ( self )

If-Range headers

  testIllegalSpec  
testIllegalSpec ( self )

  testIsModifiedIfRangeDate  
testIsModifiedIfRangeDate ( self )

  testIsNotModifiedIfRangeDate  
testIsNotModifiedIfRangeDate ( self )

  testMultipleRanges  
testMultipleRanges ( self )

Multiple ranges

  testMultipleRangesBigFile  
testMultipleRangesBigFile ( self )

  testMultipleRangesBigFileEndOverflow  
testMultipleRangesBigFileEndOverflow ( self )

  testMultipleUnsatisfiable  
testMultipleUnsatisfiable ( self )

  testNegativeZero  
testNegativeZero ( self )

Unsatisfiable requests

  testNotEqualIfRangeEtag  
testNotEqualIfRangeEtag ( self )

  testOpenEndedRange  
testOpenEndedRange ( self )

  testSimpleRange  
testSimpleRange ( self )

Single ranges

  testStartBeyondLength  
testStartBeyondLength ( self )

  testSuffixRange  
testSuffixRange ( self )

  testWithNegativeZero  
testWithNegativeZero ( self )

  uploadBigFile  
uploadBigFile ( self )

Utility methods

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:43 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Application.py.html0100600000176200017510000003415307306455554024654 0ustar dhellmanndevel Module: Application

Table of Contents

Module: Application Zope-2-CVS-src/lib/python/OFS/Application.py

Imported modules   
from AccessControl.PermissionRole import PermissionRole
from AccessControl.User import UserFolder
from App.ApplicationManager import ApplicationManager
import App.Product
from App.ProductContext import ProductContext
import App.ProductRegistry
from DateTime import DateTime
from FindSupport import FindSupport
import Folder
import Globals
from HelpSys.HelpSys import HelpSys
import Products
from StringIO import StringIO
import ZDOM
import misc_
from misc_ import Misc_
import os
import string
from string import strip, lower, find, rfind, join
import sys
import time
import traceback
from urllib import quote
from webdav.NullResource import NullResource
from zLOG import LOG, ERROR, WARNING, INFO
Functions   
get_folder_permissions
import_product
import_products
initialize
install_product
install_products
pgetattr
reimport_product
reinstall_product
removeProductMetaTypes
  get_folder_permissions  
get_folder_permissions ()

  import_product  
import_product (
        product_dir,
        product_name,
        raise_exc=0,
        log_exc=1,
        )

Exceptions   
exc [ 0 ], exc [ 1 ], exc [ 2 ]
  import_products  
import_products ()

  initialize  
initialize ( app )

Initialize the application

  install_product  
install_product (
        app,
        product_dir,
        product_name,
        meta_types,
        folder_permissions,
        raise_exc=0,
        log_exc=1,
        )

  install_products  
install_products ( app )

Install a list of products into the basic folder class, so that all folders know about top-level objects, aka products

  pgetattr  
pgetattr (
        product,
        name,
        default=install_products,
        __init__=0,
        )

Exceptions   
AttributeError, name
  reimport_product  
reimport_product ( product_name )

  reinstall_product  
reinstall_product ( app,  product_name )

  removeProductMetaTypes  
removeProductMetaTypes ( pid )

Unregisters the meta types registered by a product.

Classes   
Application

Top-level system object

Expired

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Application_Application.py.html0100600000176200017510000004250707306455554027201 0ustar dhellmanndevel Class: Application

Table of Contents

Class: Application Zope-2-CVS-src/lib/python/OFS/Application.py

Top-level system object

Base Classes   
Globals.ApplicationDefaultPermissions
ZDOM.Root
Folder.Folder
App.ProductRegistry.ProductRegistry
FindSupport
Methods   
DELETE
MOVE
PrincipiaRedirect
PrincipiaTime
ZopeAttributionButton
__bobo_traverse__
__class_init__
__init__
absolute_url
checkGlobalRegistry
 fixupZClassDependencies
getPhysicalPath
getPhysicalRoot
id
title_and_id
title_or_id
  DELETE  
DELETE (
        self,
        REQUEST,
        RESPONSE,
        )

Delete a resource object.

Exceptions   
'Forbidden', 'This resource cannot be deleted.'
  MOVE  
MOVE (
        self,
        REQUEST,
        RESPONSE,
        )

Move a resource to a new location.

Exceptions   
'Forbidden', 'This resource cannot be moved.'
  PrincipiaRedirect  
PrincipiaRedirect (
        self,
        destination,
        URL1,
        )

Utility function to allow user-controlled redirects

Exceptions   
'Redirect', ("%s/%s" %( URL1, destination ) )
'Redirect', destination
  PrincipiaTime  
PrincipiaTime ( self,  *args )

Utility function to return current date/time

  ZopeAttributionButton  
ZopeAttributionButton ( self )

Returns an HTML fragment that displays the powered by zope button along with a link to the Zope site.

  __bobo_traverse__  
__bobo_traverse__ (
        self,
        REQUEST,
        name=None,
        )

Exceptions   
KeyError, name
  __class_init__  
__class_init__ ( self )

  __init__  
__init__ ( self )

  absolute_url  
absolute_url ( self,  relative=0 )

Return an absolute url to the object. Note that the url will reflect the acquisition path of the object if the object has been acquired.

  checkGlobalRegistry  
checkGlobalRegistry ( self )

Check the global (zclass) registry for problems, which can be caused by things like disk-based products being deleted. Return true if a problem is found

  fixupZClassDependencies  
fixupZClassDependencies ( self,  rebuild=0 )

  getPhysicalPath  
getPhysicalPath ( self )

Returns a path that can be used to access this object again later, for example in a copy/paste operation. Designed to be used with getPhysicalRoot().

  getPhysicalRoot  
getPhysicalRoot ( self )

  id  
id ( self )

  title_and_id  
title_and_id ( self )

  title_or_id  
title_or_id ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Application_Expired.py.html0100600000176200017510000000752707306455554026341 0ustar dhellmanndevel Class: Expired

Table of Contents

Class: Expired Zope-2-CVS-src/lib/python/OFS/Application.py

Base Classes   
Globals.Persistent
Methods   
__save__
__setstate__
  __save__  
__save__ ( self )

  __setstate__  
__setstate__ ( self,  s={} )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Cache.py.html0100600000176200017510000002145507306455554023415 0ustar dhellmanndevel Module: Cache

Table of Contents

Module: Cache Zope-2-CVS-src/lib/python/OFS/Cache.py

Imported modules   
from AccessControl import getSecurityManager
from AccessControl.Role import _isBeingUsedAsAMethod
from Acquisition import aq_get, aq_acquire, aq_inner, aq_parent, aq_base
import Globals
from Globals import DTMLFile
from string import join
import sys
import time
from zLOG import LOG, WARNING
Functions   
filterCacheManagers
filterCacheTab
findCacheables
getVerifiedManagerIds
isCacheable
managersExist
  filterCacheManagers  
filterCacheManagers (
        orig,
        container,
        name,
        value,
        extra,
        )

This is a filter method for aq_acquire. It causes objects to be found only if they are in the list of cache managers.

  filterCacheTab  
filterCacheTab ( ob )

  findCacheables  
findCacheables (
        ob,
        manager_id,
        require_assoc,
        subfolders,
        meta_types,
        rval,
        path,
        )

Used by the CacheManager UI. Recursive. Similar to the Zope "Find" function. Finds all Cacheable objects in a hierarchy.

  getVerifiedManagerIds  
getVerifiedManagerIds ( container )

Gets the list of cache managers in a container, verifying each one.

  isCacheable  
isCacheable ( ob )

  managersExist  
managersExist ( ob )

Classes   
Cache

A base class (and interface description) for caches.

CacheManager

A base class for cache managers. Implement ZCacheManager_getCache().

Cacheable

Mix-in for cacheable objects.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Cache_Cache.py.html0100600000176200017510000001416307306455554024476 0ustar dhellmanndevel Class: Cache

Table of Contents

Class: Cache Zope-2-CVS-src/lib/python/OFS/Cache.py

A base class (and interface description) for caches. Note that Cache objects are not intended to be visible by restricted code.

Methods   
ZCache_get
ZCache_invalidate
ZCache_set
  ZCache_get  
ZCache_get (
        self,
        ob,
        view_name,
        keywords,
        mtime_func,
        default,
        )

Exceptions   
'Not implemented'
  ZCache_invalidate  
ZCache_invalidate ( self,  ob )

Exceptions   
'Not implemented'
  ZCache_set  
ZCache_set (
        self,
        ob,
        data,
        view_name,
        keywords,
        mtime_func,
        )

Exceptions   
'Not implemented'

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Cache_CacheManager.py.html0100600000176200017510000001615007306455554025767 0ustar dhellmanndevel Class: CacheManager

Table of Contents

Class: CacheManager Zope-2-CVS-src/lib/python/OFS/Cache.py

A base class for cache managers. Implement ZCacheManager_getCache().

Methods   
ZCacheManager_getCache
ZCacheManager_locate
ZCacheManager_setAssociations
manage_afterAdd
manage_beforeDelete
  ZCacheManager_getCache  
ZCacheManager_getCache ( self )

Exceptions   
'Not implemented'
  ZCacheManager_locate  
ZCacheManager_locate (
        self,
        require_assoc,
        subfolders,
        meta_types=[],
        REQUEST=None,
        )

Locates cacheable objects.

  ZCacheManager_setAssociations  
ZCacheManager_setAssociations (
        self,
        props=None,
        REQUEST=None,
        )

Associates and un-associates cacheable objects with this cache manager.

Exceptions   
'Unauthorized'
  manage_afterAdd  
manage_afterAdd (
        self,
        item,
        container,
        )

  manage_beforeDelete  
manage_beforeDelete (
        self,
        item,
        container,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Cache_Cacheable.py.html0100600000176200017510000003600607306455554025322 0ustar dhellmanndevel Class: Cacheable

Table of Contents

Class: Cacheable Zope-2-CVS-src/lib/python/OFS/Cache.py

Mix-in for cacheable objects.

Methods   
ZCacheable_configHTML
ZCacheable_enabled
ZCacheable_get
ZCacheable_getCache
ZCacheable_getManager
ZCacheable_getManagerId
ZCacheable_getManagerIds
ZCacheable_getManagerURL
ZCacheable_getModTime
ZCacheable_getObAndView
 ZCacheable_invalidate
ZCacheable_isAMethod
ZCacheable_isCachingEnabled
ZCacheable_set
ZCacheable_setEnabled
ZCacheable_setManagerId
  ZCacheable_configHTML  
ZCacheable_configHTML ( self )

Override to provide configuration of caching behavior that can only be specific to the cacheable object.

  ZCacheable_enabled  
ZCacheable_enabled ( self )

Returns true if caching is enabled for this object or method.

  ZCacheable_get  
ZCacheable_get (
        self,
        view_name='',
        keywords=None,
        mtime_func=None,
        default=None,
        )

Retrieves the cached view for the object under the conditions specified by keywords. If the value is not yet cached, returns the default.

  ZCacheable_getCache  
ZCacheable_getCache ( self )

Gets the cache associated with this object.

  ZCacheable_getManager  
ZCacheable_getManager ( self )

Returns the currently associated cache manager.

  ZCacheable_getManagerId  
ZCacheable_getManagerId ( self )

Returns the id of the current ZCacheManager.

  ZCacheable_getManagerIds  
ZCacheable_getManagerIds ( self )

Returns a list of mappings containing the id and title of the available ZCacheManagers.

  ZCacheable_getManagerURL  
ZCacheable_getManagerURL ( self )

Returns the URL of the current ZCacheManager.

  ZCacheable_getModTime  
ZCacheable_getModTime ( self,  mtime_func=None )

Returns the highest of the last mod times.

  ZCacheable_getObAndView  
ZCacheable_getObAndView ( self,  view_name )

If this object is a method of a ZClass and we're working with the primary view, uses the ZClass instance as ob and our own ID as the view_name. Otherwise returns self and view_name unchanged.

  ZCacheable_invalidate  
ZCacheable_invalidate (
        self,
        view_name='',
        REQUEST=None,
        )

Called after a cacheable object is edited. Causes all cache entries that apply to the view_name to be removed. Returns a status message.

  ZCacheable_isAMethod  
ZCacheable_isAMethod ( self )

Returns 1 when this object is a ZClass method.

  ZCacheable_isCachingEnabled  
ZCacheable_isCachingEnabled ( self )

Returns true only if associated with a cache manager and caching of this method is enabled.

  ZCacheable_set  
ZCacheable_set (
        self,
        data,
        view_name='',
        keywords=None,
        mtime_func=None,
        )

Cacheable views should call this method after generating cacheable results. The data argument can be of any Python type.

  ZCacheable_setEnabled  
ZCacheable_setEnabled (
        self,
        enabled=0,
        REQUEST=None,
        )

Changes the enabled flag. Normally used only when setting up cacheable ZClass methods.

  ZCacheable_setManagerId  
ZCacheable_setManagerId (
        self,
        manager_id,
        REQUEST=None,
        )

Changes the manager_id for this object.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/CopySupport.py.html0100600000176200017510000001725407306455554024723 0ustar dhellmanndevel Module: CopySupport

Table of Contents

Module: CopySupport Zope-2-CVS-src/lib/python/OFS/CopySupport.py

Imported modules   
from AccessControl import getSecurityManager
from Acquisition import aq_base, aq_inner, aq_parent
from App.Dialogs import MessageDialog
import ExtensionClass
import Globals
import Moniker
from marshal import loads, dumps
import string
import sys
import tempfile
from urllib import quote, unquote
from zlib import compress, decompress
Functions   
_cb_decode
_cb_encode
absattr
cookie_path
sanity_check
  _cb_decode  
_cb_decode ( s )

  _cb_encode  
_cb_encode ( d )

  absattr  
absattr ( attr )

  cookie_path  
cookie_path ( request )

  sanity_check  
sanity_check ( c,  ob )

Classes   
CopyContainer

Interface for containerish objects which allow cut/copy/paste

CopySource

Interface for objects which allow themselves to be copied.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/CopySupport_CopyContainer.py.html0100600000176200017510000005010407306455554027547 0ustar dhellmanndevel Class: CopyContainer

Table of Contents

Class: CopyContainer Zope-2-CVS-src/lib/python/OFS/CopySupport.py

Interface for containerish objects which allow cut/copy/paste

Base Classes   
ExtensionClass.Base
Methods   
_delOb
_getOb
_get_id
_setOb
_verifyObjectPaste
cb_dataItems
cb_dataValid
manage_CopyContainerAllItems
manage_CopyContainerFirstItem
manage_clone
 manage_copyObjects
manage_cutObjects
manage_pasteObjects
manage_renameObject
manage_renameObjects
  _delOb  
_delOb ( self,  id )

  _getOb  
_getOb (
        self,
        id,
        default=_marker,
        )

  _get_id  
_get_id ( self,  id )

  _setOb  
_setOb (
        self,
        id,
        object,
        )

The following three methods should be overridden to store sub-objects as non-attributes.

  _verifyObjectPaste  
_verifyObjectPaste (
        self,
        object,
        validate_src=1,
        )

Exceptions   
'Unauthorized', absattr( object.id )
'Unauthorized', method_name
'Unauthorized', mt_permission
CopyError, MessageDialog( title = 'Not Supported', message = 'Cannot paste into this object.', action = 'manage_main' )
CopyError, MessageDialog( title = 'Not Supported', message = 'The object %s does not support this ' 'operation' % absattr( object.id ), action = 'manage_main' )
  cb_dataItems  
cb_dataItems ( self )

  cb_dataValid  
cb_dataValid ( self )

  manage_CopyContainerAllItems  
manage_CopyContainerAllItems ( self,  REQUEST )

  manage_CopyContainerFirstItem  
manage_CopyContainerFirstItem ( self,  REQUEST )

  manage_clone  
manage_clone (
        self,
        ob,
        id,
        REQUEST=None,
        )

Exceptions   
CopyError, MessageDialog( title = 'Clone Error', message = sys.exc_info() [ 1 ], action = 'manage_main' )
CopyError, MessageDialog( title = 'Invalid Id', message = sys.exc_info() [ 1 ], action = 'manage_main' )
CopyError, eNotSupported % ob.getId()
  manage_copyObjects  
manage_copyObjects (
        self,
        ids=None,
        REQUEST=None,
        RESPONSE=None,
        )

Put a reference to the objects named in ids in the clip board

Exceptions   
CopyError, eNotSupported % id
ValueError, 'ids must be specified'
  manage_cutObjects  
manage_cutObjects (
        self,
        ids=None,
        REQUEST=None,
        )

Put a reference to the objects named in ids in the clip board

Exceptions   
CopyError, eNotSupported % id
ValueError, 'ids must be specified'
  manage_pasteObjects  
manage_pasteObjects (
        self,
        cb_copy_data=None,
        REQUEST=None,
        )

Paste previously copied objects into the current object. If calling manage_pasteObjects from python code, pass the result of a previous call to manage_cutObjects or manage_copyObjects as the first argument.

Exceptions   
CopyError, 'This object cannot be pasted into itself'
CopyError, MessageDialog( title = 'Copy Error', message = sys.exc_info() [ 1 ], action = 'manage_main' )
CopyError, MessageDialog( title = 'Move Error', message = sys.exc_info() [ 1 ], action = 'manage_main' )
CopyError, eInvalid
CopyError, eNoData
CopyError, eNotFound
CopyError, eNotSupported % id
CopyError, eNotSupported % ob.getId()
  manage_renameObject  
manage_renameObject (
        self,
        id,
        new_id,
        REQUEST=None,
        )

Rename a particular sub-object

Exceptions   
CopyError, MessageDialog( title = 'Invalid Id', message = sys.exc_info() [ 1 ], action = 'manage_main' )
CopyError, MessageDialog( title = 'Rename Error', message = sys.exc_info() [ 1 ], action = 'manage_main' )
CopyError, eNotSupported % id
  manage_renameObjects  
manage_renameObjects (
        self,
        ids=[],
        new_ids=[],
        REQUEST=None,
        )

Rename several sub-objects

Exceptions   
'Bad Request', 'Please rename each listed object.'

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/CopySupport_CopySource.py.html0100600000176200017510000001567207306455554027100 0ustar dhellmanndevel Class: CopySource

Table of Contents

Class: CopySource Zope-2-CVS-src/lib/python/OFS/CopySupport.py

Interface for objects which allow themselves to be copied.

Methods   
_canCopy
_getCopy
_notifyOfCopyTo
_postCopy
_setId
cb_isCopyable
cb_isMoveable
  _canCopy  
_canCopy ( self,  op=0 )

Called to make sure this object is copyable. The op var is 0 for a copy, 1 for a move.

  _getCopy  
_getCopy ( self,  container )

  _notifyOfCopyTo  
_notifyOfCopyTo (
        self,
        container,
        op=0,
        )

Overide this to be pickly about where you go! If you dont want to go there, raise an exception. The op variable is 0 for a copy, 1 for a move.

  _postCopy  
_postCopy (
        self,
        container,
        op=0,
        )

  _setId  
_setId ( self,  id )

  cb_isCopyable  
cb_isCopyable ( self )

  cb_isMoveable  
cb_isMoveable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/DTMLDocument.py.html0100600000176200017510000001232007306455554024640 0ustar dhellmanndevel Module: DTMLDocument

Table of Contents

Module: DTMLDocument Zope-2-CVS-src/lib/python/OFS/DTMLDocument.py

DTML Document objects.

Imported modules   
from AccessControl import getSecurityManager
from DTMLMethod import DTMLMethod, decapitate
import Globals
from Globals import HTML, DTMLFile, MessageDialog
from OFS.content_types import guess_content_type
from PropertyManager import PropertyManager
from ZPublisher.Converters import type_converters
from sgmllib import SGMLParser
from string import find
from urllib import quote
from webdav.Lockable import ResourceLockedError
from webdav.WriteLockInterface import WriteLockInterface
from webdav.common import rfc1123_date
Functions   
addDTMLDocument
  addDTMLDocument  
addDTMLDocument (
        self,
        id,
        title='',
        file='',
        REQUEST=None,
        submit=None,
        )

Add a DTML Document object with the contents of file. If file is empty, default document text is used.

Classes   
DTMLDocument

DTML Document objects are DocumentTemplate.HTML objects that act

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/DTMLDocument_DTMLDocument.py.html0100600000176200017510000001545607306455554027174 0ustar dhellmanndevel Class: DTMLDocument

Table of Contents

Class: DTMLDocument Zope-2-CVS-src/lib/python/OFS/DTMLDocument.py

DTML Document objects are DocumentTemplate.HTML objects that act as methods whose self is the DTML Document itself.

Base Classes   
PropertyManager
DTMLMethod
Methods   
__call__
manage_edit
manage_upload
  __call__  
__call__ (
        self,
        client=None,
        REQUEST={},
        RESPONSE=None,
        **kw,
        )

Render the document given a client object, REQUEST mapping, Response, and key word arguments.

  manage_edit  
manage_edit (
        self,
        data,
        title,
        SUBMIT='Change',
        dtpref_cols='50',
        dtpref_rows='20',
        REQUEST=None,
        )

Replaces a Documents contents with Data, Title with Title.

The SUBMIT parameter is also used to change the size of the editing area on the default Document edit screen. If the value is "Smaller", the rows and columns decrease by 5. If the value is "Bigger", the rows and columns increase by 5. If any other or no value is supplied, the data gets checked for DTML errors and is saved.

Exceptions   
ResourceLockedError, ( 'This document has been locked via WebDAV.' )
  manage_upload  
manage_upload (
        self,
        file='',
        REQUEST=None,
        )

Replace the contents of the document with the text in file.

Exceptions   
ResourceLockedError, ( 'This document has been locked via WebDAV.' )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/DTMLMethod.py.html0100600000176200017510000001455507306455554024316 0ustar dhellmanndevel Module: DTMLMethod

Table of Contents

Module: DTMLMethod Zope-2-CVS-src/lib/python/OFS/DTMLMethod.py

DTML Method objects.

Imported modules   
from AccessControl import getSecurityManager, full_read_guard
from AccessControl.Role import RoleManager
import Acquisition
from Cache import Cacheable
from DateTime.DateTime import DateTime
import Globals
from Globals import HTML, DTMLFile, MessageDialog
import History
from OFS.content_types import guess_content_type
from PropertyManager import PropertyManager
from SimpleItem import Item_w__name__, pretty_tb
from ZDOM import ElementWithTitle
import re
from string import join, split, strip, rfind, atoi, lower, find
import sys
from urllib import quote
from webdav.Lockable import ResourceLockedError
from webdav.WriteLockInterface import WriteLockInterface
from webdav.common import rfc1123_date
Functions   
addDTMLMethod
decapitate
  addDTMLMethod  
addDTMLMethod (
        self,
        id,
        title='',
        file='',
        REQUEST=None,
        submit=None,
        )

Add a DTML Method object with the contents of file. If file is empty, default document text is used.

  decapitate  
decapitate ( html,  RESPONSE=None )

Classes   
DTMLMethod

DTML Method objects are DocumentTemplate.HTML objects that act

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/DTMLMethod_DTMLMethod.py.html0100600000176200017510000004615207306455554026275 0ustar dhellmanndevel Class: DTMLMethod

Table of Contents

Class: DTMLMethod Zope-2-CVS-src/lib/python/OFS/DTMLMethod.py

DTML Method objects are DocumentTemplate.HTML objects that act as methods of their containers.

Base Classes   
HTML
Acquisition.Implicit
RoleManager
ElementWithTitle
Item_w__name__
History.Historical
Cacheable
Methods   
PUT
PrincipiaSearchSource
ZDocumentTemplate_afterRender
ZDocumentTemplate_beforeRender
__call__
_er
_validateProxy
document_src
getCacheNamespaceKeys
get_size
 manage_FTPget
manage_edit
manage_haveProxy
manage_historyCompare
manage_proxy
manage_upload
read_guard
setCacheNamespaceKeys
  PUT  
PUT (
        self,
        REQUEST,
        RESPONSE,
        )

Handle HTTP PUT requests.

  PrincipiaSearchSource  
PrincipiaSearchSource ( self )

Support for searching - the document's contents are searched.

  ZDocumentTemplate_afterRender  
ZDocumentTemplate_afterRender (
        self,
        md,
        result,
        )

  ZDocumentTemplate_beforeRender  
ZDocumentTemplate_beforeRender (
        self,
        md,
        default,
        )

  __call__  
__call__ (
        self,
        client=None,
        REQUEST={},
        RESPONSE=None,
        **kw,
        )

Render the document given a client object, REQUEST mapping, Response, and key word arguments.

  _er  
_er (
        self,
        data,
        title,
        SUBMIT,
        dtpref_cols,
        dtpref_rows,
        REQUEST,
        )

  _validateProxy  
_validateProxy (
        self,
        request,
        roles=None,
        )

Exceptions   
'Forbidden', ('You are not authorized to change %s because you ' 'do not have proxy roles.\n' %( self.__name__, u, roles ) )
  document_src  
document_src (
        self,
        REQUEST=None,
        RESPONSE=None,
        )

Return unprocessed document source.

  getCacheNamespaceKeys  
getCacheNamespaceKeys ( self )

Returns the cacheNamespaceKeys.

  get_size  
get_size ( self )

  manage_FTPget  
manage_FTPget ( self )

Get source for FTP download

  manage_edit  
manage_edit (
        self,
        data,
        title,
        SUBMIT='Change',
        dtpref_cols='50',
        dtpref_rows='20',
        REQUEST=None,
        )

Replaces a Documents contents with Data, Title with Title.

The SUBMIT parameter is also used to change the size of the editing area on the default Document edit screen. If the value is "Smaller", the rows and columns decrease by 5. If the value is "Bigger", the rows and columns increase by 5. If any other or no value is supplied, the data gets checked for DTML errors and is saved.

Exceptions   
ResourceLockedError, 'This DTML Method is locked via WebDAV'
  manage_haveProxy  
manage_haveProxy ( self,  r )

  manage_historyCompare  
manage_historyCompare (
        self,
        rev1,
        rev2,
        REQUEST,
        historyComparisonResults='',
        )

  manage_proxy  
manage_proxy (
        self,
        roles=(),
        REQUEST=None,
        )

Change Proxy Roles

  manage_upload  
manage_upload (
        self,
        file='',
        REQUEST=None,
        )

Replace the contents of the document with the text in file.

Exceptions   
ResourceLockedError, 'This DTML Method is locked via WebDAV'
  read_guard  
read_guard ( self,  ob )

  setCacheNamespaceKeys  
setCacheNamespaceKeys (
        self,
        keys,
        REQUEST=None,
        )

Sets the list of names that should be looked up in the namespace to provide a cache key.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/DefaultObservable.py.html0100600000176200017510000000554407306455554026004 0ustar dhellmanndevel Module: DefaultObservable

Table of Contents

Module: DefaultObservable Zope-2-CVS-src/lib/python/OFS/DefaultObservable.py

Imported modules   
import string
from types import StringType
Classes   
DefaultObservable

See the Interfaces wiki for design notes:

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/DefaultObservable_DefaultObservable.py.html0100600000176200017510000001603407306455554031451 0ustar dhellmanndevel Class: DefaultObservable

Table of Contents

Class: DefaultObservable Zope-2-CVS-src/lib/python/OFS/DefaultObservable.py

See the Interfaces wiki for design notes:

http://www.zope.org/Members/michel/Projects/Interfaces/ObserverAndNotification

DefaultObservable is intended to be used as a mix-in, like so:

        from OFS.SimpleItem import SimpleItem
        from OFS.DefaultObservable import DefaultObservable

        class Foo( SimpleItem, DefaultObservable ):
            '''
                Some foo or other
            '''
            ...
            def bar( self, ... ):
                '''
                '''
                ...
                self.notify( &quot;bar&quot; )

Clients register with a Foo instance using the methods of the Observable interface, e.g.:

        foo.registerObserver( self.getPhysicalPath() + ( 'watchFoo',) )

When the Foo instance has its bar() method called, it will notify all registered observers, passing bar as the event; in this case, the client's watchFoo() method will be called, with the foo object and bar passed as parameters.

Methods   
__init__
_normalize
notify
registerObserver
unregisterObserver
  __init__  
__init__ ( self,  debug=0 )

  _normalize  
_normalize ( self,  observer )

  notify  
notify ( self,  event=None )

Convenience method for derivatives.

  registerObserver  
registerObserver ( self,  observer )

Observable interface methods.

Exceptions   
NameError, observer
  unregisterObserver  
unregisterObserver ( self,  observer )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Document.py.html0100600000176200017510000000360207306455554024162 0ustar dhellmanndevel Module: Document

Table of Contents

Module: Document Zope-2-CVS-src/lib/python/OFS/Document.py

Deprecated - use DTMLMethod

Imported modules   
import DTMLMethod

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/FTPInterface.py.html0100600000176200017510000000445507306455554024665 0ustar dhellmanndevel Module: FTPInterface

Table of Contents

Module: FTPInterface Zope-2-CVS-src/lib/python/OFS/FTPInterface.py

FTP Support for Zope classes.

Preliminary FTP support interface. Note, most FTP functions are provided by existing methods such as PUT and manage_delObjects.

All FTP methods should be governed by a single permission: FTP access.

Classes   
FTPInterface

Interface for FTP objects

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/FTPInterface_FTPInterface.py.html0100600000176200017510000001057207306455554027214 0ustar dhellmanndevel Class: FTPInterface

Table of Contents

Class: FTPInterface Zope-2-CVS-src/lib/python/OFS/FTPInterface.py

Interface for FTP objects

Methods   
manage_FTPget
manage_FTPlist
manage_FTPstat
  manage_FTPget  
manage_FTPget ( self )

Returns the source content of an object. For example, the source text of a Document, or the data of a file.

  manage_FTPlist  
manage_FTPlist ( self,  REQUEST )

Returns a directory listing consisting of a tuple of (id,stat) tuples, marshaled to a string. Note, the listing it should include .. if there is a Folder above the current one.

In the case of non-foldoid objects it should return a single tuple (id,stat) representing itself.

  manage_FTPstat  
manage_FTPstat ( self,  REQUEST )

Returns a stat-like tuple. (marshalled to a string) Used by FTP for directory listings, and MDTM and SIZE

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/FindSupport.py.html0100600000176200017510000001733007306455554024664 0ustar dhellmanndevel Module: FindSupport

Table of Contents

Module: FindSupport Zope-2-CVS-src/lib/python/OFS/FindSupport.py

Imported modules   
from AccessControl import getSecurityManager, full_read_guard
from AccessControl.Permission import name_trans
from DateTime import DateTime
from DocumentTemplate.DT_Util import Eval, InstanceDict, TemplateDict
import ExtensionClass
import Globals
from Globals import DTMLFile
import os
import string
from string import find
import sys
import time
Functions   
absattr
expr_match
mtime_match
p_name
role_match
  absattr  
absattr ( attr )

  expr_match  
expr_match (
        ob,
        ed,
        c=InstanceDict,
        r=0,
        )

  mtime_match  
mtime_match (
        ob,
        t,
        q,
        fn=hasattr,
        )

  p_name  
p_name ( name )

  role_match  
role_match (
        ob,
        permission,
        roles,
        lt=type([] ),
        tt=type(() ),
        )

Classes   
FindSupport

Find support for Zope Folders

td

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/FindSupport_FindSupport.py.html0100600000176200017510000001343207306455554027220 0ustar dhellmanndevel Class: FindSupport

Table of Contents

Class: FindSupport Zope-2-CVS-src/lib/python/OFS/FindSupport.py

Find support for Zope Folders

Base Classes   
ExtensionClass.Base
Methods   
ZopeFind
ZopeFindAndApply
  ZopeFind  
ZopeFind (
        self,
        obj,
        obj_ids=None,
        obj_metatypes=None,
        obj_searchterm=None,
        obj_expr=None,
        obj_mtime=None,
        obj_mspec=None,
        obj_permission=None,
        obj_roles=None,
        search_sub=0,
        REQUEST=None,
        result=None,
        pre='',
        )

Zope Find interface

Exceptions   
AttributeError, ` result `
  ZopeFindAndApply  
ZopeFindAndApply (
        self,
        obj,
        obj_ids=None,
        obj_metatypes=None,
        obj_searchterm=None,
        obj_expr=None,
        obj_mtime=None,
        obj_mspec=None,
        obj_permission=None,
        obj_roles=None,
        search_sub=0,
        REQUEST=None,
        result=None,
        pre='',
        apply_func=None,
        apply_path='',
        )

Zope Find interface and apply

Exceptions   
AttributeError, ` result `

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/FindSupport_td.py.html0100600000176200017510000000620707306455554025354 0ustar dhellmanndevel Class: td

Table of Contents

Class: td Zope-2-CVS-src/lib/python/OFS/FindSupport.py

Base Classes   
TemplateDict
Methods   
read_guard
  read_guard  
read_guard ( self,  ob )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Folder.py.html0100600000176200017510000001316007306455555023620 0ustar dhellmanndevel Module: Folder

Table of Contents

Module: Folder Zope-2-CVS-src/lib/python/OFS/Folder.py

Folder object

Folders are the basic container objects and are analogous to directories.

$Id: Folder.py,v 1.94 2001/01/31 21:26:52 jeffrey Exp $

Imported modules   
from AccessControl import getSecurityManager
import AccessControl.Role
import FindSupport
import Globals
from Globals import DTMLFile
import ObjectManager
import PropertyManager
import SimpleItem
import webdav.Collection
from webdav.WriteLockInterface import WriteLockInterface
Functions   
manage_addFolder
  manage_addFolder  
manage_addFolder (
        self,
        id,
        title='',
        createPublic=0,
        createUserF=0,
        REQUEST=None,
        )

Add a new Folder object with id id.

If the createPublic and createUserF parameters are set to any true value, an index_html and a UserFolder objects are created respectively in the new folder.

Exceptions   
'Unauthorized', ( 'You are not authorized to add DTML Documents.' )
'Unauthorized', ( 'You are not authorized to add User Folders.' )
Classes   
Folder

Folders are basic container objects that provide a standard

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Folder_Folder.py.html0100600000176200017510000000432607306455555025117 0ustar dhellmanndevel Class: Folder

Table of Contents

Class: Folder Zope-2-CVS-src/lib/python/OFS/Folder.py

Folders are basic container objects that provide a standard interface for object management. Folder objects also implement a management interface and can have arbitrary properties.

Base Classes   
ObjectManager.ObjectManager
PropertyManager.PropertyManager
AccessControl.Role.RoleManager
webdav.Collection.Collection
SimpleItem.Item
FindSupport.FindSupport

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/History.py.html0100600000176200017510000001764007306455555024055 0ustar dhellmanndevel Module: History

Table of Contents

Module: History Zope-2-CVS-src/lib/python/OFS/History.py

Object Histories

Imported modules   
from Acquisition import Implicit
from DateTime import DateTime
import ExtensionClass
import Globals
from cgi import escape
import ndiff
from string import join, split, atoi, strip
from struct import pack, unpack
Functions   
dump
historicalRevision
html_diff
replace
  dump  
dump (
        tag,
        x,
        lo,
        hi,
        r,
        )

  historicalRevision  
historicalRevision ( self,  serial )

  html_diff  
html_diff ( s1,  s2 )

Exceptions   
ValueError, 'unknown tag ' + ` tag `
  replace  
replace (
        x,
        xlo,
        xhi,
        y,
        ylo,
        yhi,
        r,
        )

Classes   
Historian

An Historian's job is to find hysterical revisions of

Historical

Mix-in class to provide a veiw that shows hystorical changes

HistorySelectionError
HystoryJar

A ZODB Connection-like object that provides access to data

TemporalParadox

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/History_Historian.py.html0100600000176200017510000001115607306455555026071 0ustar dhellmanndevel Class: Historian

Table of Contents

Class: Historian Zope-2-CVS-src/lib/python/OFS/History.py

An Historian's job is to find hysterical revisions of objects, given a time.

Base Classes   
Implicit
Methods   
__getitem__
manage_workspace
  __getitem__  
__getitem__ ( self,  key )

  manage_workspace  
manage_workspace ( self,  REQUEST )

We aren't real, so we delegate to that that spawned us!

Exceptions   
'Redirect', REQUEST [ 'URL2' ] + '/manage_change_history_page'

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/History_Historical.py.html0100600000176200017510000002217207306455555026232 0ustar dhellmanndevel Class: Historical

Table of Contents

Class: Historical Zope-2-CVS-src/lib/python/OFS/History.py

Mix-in class to provide a veiw that shows hystorical changes

The display is similar to that used for undo, except that the transactions are limited to those that effect the displayed object and that the interface doesn't provide an undo capability.

This interface is generally only interesting for objects, such as methods, and documents, that are self-contained, meaning that they don't have persistent sub-objects.

Base Classes   
ExtensionClass.Base
Methods   
manage_afterHistoryCopy
manage_beforeHistoryCopy
manage_change_history
manage_historicalComparison
manage_historyCompare
manage_historyCopy
  manage_afterHistoryCopy  
manage_afterHistoryCopy ( self )

  manage_beforeHistoryCopy  
manage_beforeHistoryCopy ( self )

  manage_change_history  
manage_change_history ( self )

  manage_historicalComparison  
manage_historicalComparison (
        self,
        REQUEST,
        keys=[],
        )

Compare two selected revisions

Exceptions   
HistorySelectionError, ( "No historical revision was selected.

" )
HistorySelectionError, ( "Only two historical revision can be compared

" )

  manage_historyCompare  
manage_historyCompare (
        self,
        rev1,
        rev2,
        REQUEST,
        historyComparisonResults='',
        )

  manage_historyCopy  
manage_historyCopy (
        self,
        keys=[],
        RESPONSE=None,
        URL1=None,
        )

Copy a selected revision to the present

Exceptions   
HistorySelectionError, ( "No historical revision was selected.

" )
HistorySelectionError, ( "Only one historical revision can be " "copied to the present.

" )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/History_HistorySelectionError.py.html0100600000176200017510000000366707306455555030462 0ustar dhellmanndevel Class: HistorySelectionError

Table of Contents

Class: HistorySelectionError Zope-2-CVS-src/lib/python/OFS/History.py

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/History_HystoryJar.py.html0100600000176200017510000001241607306455555026247 0ustar dhellmanndevel Class: HystoryJar

Table of Contents

Class: HystoryJar Zope-2-CVS-src/lib/python/OFS/History.py

A ZODB Connection-like object that provides access to data but prevents history from being changed.

Methods   
__getattr__
__init__
abort
commit
  __getattr__  
__getattr__ ( self,  name )

  __init__  
__init__ ( self,  base )

  abort  
abort ( *args,  *kw )

  commit  
commit ( *args,  *kw )

Exceptions   
TemporalParadox, "You can\'t change history!"

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/History_TemporalParadox.py.html0100600000176200017510000000365307306455555027236 0ustar dhellmanndevel Class: TemporalParadox

Table of Contents

Class: TemporalParadox Zope-2-CVS-src/lib/python/OFS/History.py

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Image.py.html0100600000176200017510000001776307306455555023444 0ustar dhellmanndevel Module: Image

Table of Contents

Module: Image Zope-2-CVS-src/lib/python/OFS/Image.py

Image object

Imported modules   
from AccessControl.Role import RoleManager
from Acquisition import Implicit
from Cache import Cacheable
from DateTime import DateTime
import Globals
from Globals import DTMLFile, Persistent
from OFS.content_types import guess_content_type
from PropertyManager import PropertyManager
from SimpleItem import Item_w__name__
from ZPublisher import HTTPRangeSupport
from cStringIO import StringIO
from mimetools import choose_boundary
import string
import struct
from webdav.Lockable import ResourceLockedError
from webdav.WriteLockInterface import WriteLockInterface
from webdav.common import rfc1123_date
Functions   
cookId
getImageInfo
manage_addFile
manage_addImage
  cookId  
cookId (
        id,
        title,
        file,
        )

  getImageInfo  
getImageInfo ( data )

  manage_addFile  
manage_addFile (
        self,
        id,
        file='',
        title='',
        precondition='',
        content_type='',
        REQUEST=None,
        )

Add a new File object.

Creates a new File object id with the contents of file

  manage_addImage  
manage_addImage (
        self,
        id,
        file,
        title='',
        precondition='',
        content_type='',
        REQUEST=None,
        )

Add a new Image object.

Creates a new Image object id with the contents of file.

Classes   
File

A File object is a content object for arbitrary files.

Image

Image objects can be GIF, PNG or JPEG and have the same methods

Pdata

Wrapper for possibly large data

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Image_File.py.html0100600000176200017510000003642707306455555024401 0ustar dhellmanndevel Class: File

Table of Contents

Class: File Zope-2-CVS-src/lib/python/OFS/Image.py

A File object is a content object for arbitrary files.

Base Classes   
Persistent
Implicit
PropertyManager
RoleManager
Item_w__name__
Cacheable
Methods   
PUT
__init__
__len__
__str__
_get_content_type
_read_data
getContentType
get_size
id
index_html
 manage_edit
manage_upload
update_data
view_image_or_file
  PUT  
PUT (
        self,
        REQUEST,
        RESPONSE,
        )

Handle HTTP PUT requests

  __init__  
__init__ (
        self,
        id,
        title,
        file,
        content_type='',
        precondition='',
        )

  __len__  
__len__ ( self )

  __str__  
__str__ ( self )

  _get_content_type  
_get_content_type (
        self,
        file,
        body,
        id,
        content_type=None,
        )

  _read_data  
_read_data ( self,  file )

  getContentType  
getContentType ( self )

Get the content type of a file or image.

Returns the content type (MIME type) of a file or image.

  get_size  
get_size ( self )

Get the size of a file or image.

Returns the size of the file or image.

  id  
id ( self )

  index_html  
index_html (
        self,
        REQUEST,
        RESPONSE,
        )

The default view of the contents of a File or Image.

Returns the contents of the file or image. Also, sets the Content-Type HTTP header to the objects content type.

  manage_edit  
manage_edit (
        self,
        title,
        content_type,
        precondition='',
        REQUEST=None,
        )

Changes the title and content type attributes of the File or Image.

Exceptions   
ResourceLockedError, "File is locked via WebDAV"
  manage_upload  
manage_upload (
        self,
        file='',
        REQUEST=None,
        )

Replaces the current contents of the File or Image object with file.

The file or images contents are replaced with the contents of file.

Exceptions   
ResourceLockedError, "File is locked via WebDAV"
  update_data  
update_data (
        self,
        data,
        content_type=None,
        size=None,
        )

  view_image_or_file  
view_image_or_file ( self,  URL1 )

The default view of the contents of the File or Image.

Exceptions   
'Redirect', URL1

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Image_Image.py.html0100600000176200017510000001354407306455555024537 0ustar dhellmanndevel Class: Image

Table of Contents

Class: Image Zope-2-CVS-src/lib/python/OFS/Image.py

Image objects can be GIF, PNG or JPEG and have the same methods as File objects. Images also have a string representation that renders an HTML IMG tag.

Base Classes   
File
    Persistent
    Implicit
    PropertyManager
    RoleManager
    Item_w__name__
    Cacheable
Methods   
__str__
tag
update_data
  __str__  
__str__ ( self )

  tag  
tag (
        self,
        height=None,
        width=None,
        alt=None,
        scale=0,
        xscale=0,
        yscale=0,
        css_class=None,
        **args,
        )

Generate an HTML IMG tag for this image, with customization. Arguments to self.tag() can be any valid attributes of an IMG tag. src will always be an absolute pathname, to prevent redundant downloading of images. Defaults are applied intelligently for height, width, and alt. If specified, the scale, xscale, and yscale keyword arguments will be used to automatically adjust the output height and width values of the image tag.

Since class is a Python reserved word, it cannot be passed in directly in keyword arguments which is a problem if you are trying to use tag() to include a CSS class. The tag() method will accept a css_class argument that will be converted to class in the output tag to work around this.

  update_data  
update_data (
        self,
        data,
        content_type=None,
        size=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Image_Pdata.py.html0100600000176200017510000001231607306455555024542 0ustar dhellmanndevel Class: Pdata

Table of Contents

Class: Pdata Zope-2-CVS-src/lib/python/OFS/Image.py

Wrapper for possibly large data

Base Classes   
Persistent
Implicit
Methods   
__getslice__
__init__
__len__
__str__
  __getslice__  
__getslice__ (
        self,
        i,
        j,
        )

  __init__  
__init__ ( self,  data )

  __len__  
__len__ ( self )

  __str__  
__str__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Moniker.py.html0100600000176200017510000001166107306455555024015 0ustar dhellmanndevel Module: Moniker

Table of Contents

Module: Moniker Zope-2-CVS-src/lib/python/OFS/Moniker.py

Object monikers

An object moniker is an intelligent reference to a persistent object. A moniker can be turned back into a real object that retains its correct version context and aquisition relationships via a simple interface.

Imported modules   
import Globals
import string
Functions   
absattr
loadMoniker
  absattr  
absattr ( attr )

  loadMoniker  
loadMoniker ( data )

Re-creates a Moniker object from the given data which had been generated by Moniker.dump().

Classes   
Moniker

An object moniker is an intelligent reference to a

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Moniker_Moniker.py.html0100600000176200017510000001011107306455555025466 0ustar dhellmanndevel Class: Moniker

Table of Contents

Class: Moniker Zope-2-CVS-src/lib/python/OFS/Moniker.py

An object moniker is an intelligent reference to a persistent object. A moniker can be turned back into a real object that retains its correct version context and acquisition relationships via a simple interface.

Methods   
__init__
bind
dump
  __init__  
__init__ ( self,  ob=None )

  bind  
bind ( self,  app )

Returns the real object named by this moniker

  dump  
dump ( self )

Returns an object which can be reconstituted by loadMoniker(). Result must be compatible with marshal.dump().

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ObjectManager.py.html0100600000176200017510000001742007306455555025111 0ustar dhellmanndevel Module: ObjectManager

Table of Contents

Module: ObjectManager Zope-2-CVS-src/lib/python/OFS/ObjectManager.py

Imported modules   
from AccessControl import getSecurityManager
import Acquisition
from Acquisition import aq_base
import App.Common
import App.FactoryDispatcher
import App.Management
import CopySupport
import Globals
from Globals import DTMLFile, Persistent, MessageDialog, default__class_init__
from OFS.Traversable import Traversable
import Products
import XMLExportImport
from cStringIO import StringIO
import copy
import fnmatch
import marshal
import os
import re
import string
import sys
from urllib import quote
from webdav.Collection import Collection
from webdav.NullResource import NullResource
from zLOG import LOG, ERROR
Functions   
checkValidId
findChilds
  checkValidId  
checkValidId (
        self,
        id,
        allow_dup=0,
        )

Exceptions   
BadRequestException, 'Empty or invalid id specified.'
BadRequestException, 'REQUEST is a reserved name.'
BadRequestException, ( 'The id "%s" contains characters illegal in URLs.' % id )
BadRequestException, ( 'The id "%s" is invalid - it begins with "aq_".' % id )
BadRequestException, ( 'The id "%s" is invalid - it begins with an underscore.' % id )
BadRequestException, ( 'The id "%s" is invalid - it ends with two underscores.' % id )
BadRequestException, ( 'The id "%s" is invalid--' 'it is already in use.' % id )
BadRequestException, ( 'The id "%s" is reserved.' % id )
  findChilds  
findChilds ( obj,  dirname='' )

recursive walk through the object hierarchy to find all childs of an object (ajung)

Classes   
BeforeDeleteException
BreakoutException
IFAwareObjectManager
ObjectManager

Generic object manager

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ObjectManager_BeforeDeleteException.py.html0100600000176200017510000000367507306455555031404 0ustar dhellmanndevel Class: BeforeDeleteException

Table of Contents

Class: BeforeDeleteException Zope-2-CVS-src/lib/python/OFS/ObjectManager.py

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ObjectManager_BreakoutException.py.html0100600000176200017510000000366507306455555030632 0ustar dhellmanndevel Class: BreakoutException

Table of Contents

Class: BreakoutException Zope-2-CVS-src/lib/python/OFS/ObjectManager.py

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ObjectManager_IFAwareObjectManager.py.html0100600000176200017510000000507607306455555031075 0ustar dhellmanndevel Class: IFAwareObjectManager

Table of Contents

Class: IFAwareObjectManager Zope-2-CVS-src/lib/python/OFS/ObjectManager.py

Methods   
all_meta_types
  all_meta_types  
all_meta_types ( self,  interfaces=None )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ObjectManager_ObjectManager.py.html0100600000176200017510000006647107306455555027704 0ustar dhellmanndevel Class: ObjectManager

Table of Contents

Class: ObjectManager Zope-2-CVS-src/lib/python/OFS/ObjectManager.py

Generic object manager

This class provides core behavior for collections of heterogeneous objects.

Base Classes   
CopySupport.CopyContainer
App.Management.Navigation
App.Management.Tabs
Acquisition.Implicit
Persistent
Collection
Traversable
Methods   
__class_init__
__getitem__
_delOb
_delObject
_getOb
_setOb
_setObject
_subobject_permissions
all_meta_types
filtered_meta_types
 manage_FTPlist
manage_FTPstat
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_delObjects
manage_exportObject
manage_importObject
objectIds
objectIds_d
 objectItems
objectItems_d
objectMap
objectMap_d
objectValues
objectValues_d
superValues
tpValues
  __class_init__  
__class_init__ ( self )

  __getitem__  
__getitem__ ( self,  key )

Exceptions   
KeyError, key
  _delOb  
_delOb ( self,  id )

  _delObject  
_delObject (
        self,
        id,
        dp=1,
        )

  _getOb  
_getOb (
        self,
        id,
        default=_marker,
        )

Exceptions   
AttributeError, id
  _setOb  
_setOb (
        self,
        id,
        object,
        )

  _setObject  
_setObject (
        self,
        id,
        object,
        roles=None,
        user=None,
        set_owner=1,
        )

  _subobject_permissions  
_subobject_permissions ( self )

  all_meta_types  
all_meta_types ( self,  interfaces=None )

Exceptions   
BreakoutException
  filtered_meta_types  
filtered_meta_types ( self,  user=None )

  manage_FTPlist  
manage_FTPlist ( self,  REQUEST )

Directory listing for FTP

Exceptions   
ValueError( 'FTP List not supported on acquired objects' )
  manage_FTPstat  
manage_FTPstat ( self,  REQUEST )

Psuedo stat used for FTP listings

  manage_afterAdd  
manage_afterAdd (
        self,
        item,
        container,
        )

  manage_afterClone  
manage_afterClone ( self,  item )

  manage_beforeDelete  
manage_beforeDelete (
        self,
        item,
        container,
        )

  manage_delObjects  
manage_delObjects (
        self,
        ids=[],
        REQUEST=None,
        )

Delete a subordinate object

The objects specified in ids get deleted.

Exceptions   
'BadRequest', '%s does not exist' % ids [ -1 ]
  manage_exportObject  
manage_exportObject (
        self,
        id='',
        download=None,
        toxml=None,
        RESPONSE=None,
        )

Exports an object to a file and returns that file.

  manage_importObject  
manage_importObject (
        self,
        file,
        REQUEST=None,
        set_owner=1,
        )

Import an object from a file

Exceptions   
BadRequestException, 'File does not exist: %s' % file
BadRequestException, 'Invalid file name %s' % file
  objectIds  
objectIds ( self,  spec=None )

  objectIds_d  
objectIds_d ( self,  t=None )

  objectItems  
objectItems ( self,  spec=None )

  objectItems_d  
objectItems_d ( self,  t=None )

  objectMap  
objectMap ( self )

  objectMap_d  
objectMap_d ( self,  t=None )

  objectValues  
objectValues ( self,  spec=None )

  objectValues_d  
objectValues_d ( self,  t=None )

  superValues  
superValues ( self,  t )

  tpValues  
tpValues ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/PropertyManager.py.html0100600000176200017510000000647107306455556025534 0ustar dhellmanndevel Module: PropertyManager

Table of Contents

Module: PropertyManager Zope-2-CVS-src/lib/python/OFS/PropertyManager.py

Property management

Imported modules   
from Acquisition import Implicit, aq_base
from DateTime import DateTime
import ExtensionClass
import Globals
from Globals import DTMLFile, MessageDialog, Persistent
from PropertySheets import DefaultPropertySheets, vps
import ZDOM
from ZPublisher.Converters import type_converters
from string import find, join, lower, split
Classes   
PropertyManager

The PropertyManager mixin class provides an object with

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/PropertyManager_PropertyManager.py.html0100600000176200017510000006611607306455556030735 0ustar dhellmanndevel Class: PropertyManager

Table of Contents

Class: PropertyManager Zope-2-CVS-src/lib/python/OFS/PropertyManager.py

The PropertyManager mixin class provides an object with transparent property management. An object which wants to have properties should inherit from PropertyManager.

An object may specify that it has one or more predefined properties, by specifying an _properties structure in its class:

      _properties=({'id':'title', 'type': 'string', 'mode': 'w'},
                   {'id':'color', 'type': 'string', 'mode': 'w'},
                   )

The _properties structure is a sequence of dictionaries, where each dictionary represents a predefined property. Note that if a predefined property is defined in the _properties structure, you must provide an attribute with that name in your class or instance that contains the default value of the predefined property.

Each entry in the _properties structure must have at least an id and a type key. The id key contains the name of the property, and the type key contains a string representing the object's type. The type string must be one of the values: float, int, long, string, lines, text, date, tokens, selection, or multiple section.

For selection and multiple selection properties, there is an addition item in the property dictionay, select_variable which provides the name of a property or method which returns a list of strings from which the selection(s) can be chosen.

Each entry in the _properties structure may optionally provide a mode key, which specifies the mutability of the property. The mode string, if present, must contain 0 or more characters from the set w,'d'.

A w present in the mode string indicates that the value of the property may be changed by the user. A d indicates that the user can delete the property. An empty mode string indicates that the property and its value may be shown in property listings, but that it is read-only and may not be deleted.

Entries in the _properties structure which do not have a mode key are assumed to have the mode wd (writeable and deleteable).

To fully support property management, including the system-provided tabs and user interfaces for working with properties, an object which inherits from PropertyManager should include the following entry in its manage_options structure:

      {'label':'Properties', 'action':'manage_propertiesForm',}

to ensure that a Properties tab is displayed in its management interface. Objects that inherit from PropertyManager should also include the following entry in its __ac_permissions__ structure:

      ('Manage properties', ('manage_addProperty',
                             'manage_editProperties',
                             'manage_delProperties',
                             'manage_changeProperties',)),
Base Classes   
ExtensionClass.Base
ZDOM.ElementWithAttributes
Methods   
_delPropValue
_delProperty
_propertyMap
_setPropValue
_setProperty
_updateProperty
_wrapperCheck
getProperty
getPropertyType
hasProperty
 manage_addProperty
manage_changeProperties
manage_changePropertyTypes
manage_delProperties
manage_editProperties
propdict
propertyIds
propertyItems
propertyLabel
propertyMap
 propertyValues
valid_property_id
  _delPropValue  
_delPropValue ( self,  id )

  _delProperty  
_delProperty ( self,  id )

Exceptions   
ValueError, 'The property %s does not exist' % id
  _propertyMap  
_propertyMap ( self )

Return a tuple of mappings, giving meta-data for properties

  _setPropValue  
_setPropValue (
        self,
        id,
        value,
        )

  _setProperty  
_setProperty (
        self,
        id,
        value,
        type='string',
        )

for selection and multiple selection properties the value argument indicates the select variable of the property

Exceptions   
'Bad Request', 'Invalid or duplicate property id'
'Bad Request', 'No select variable %s' % value
  _updateProperty  
_updateProperty (
        self,
        id,
        value,
        )

Exceptions   
'Bad Request', 'The property %s does not exist' % id
  _wrapperCheck  
_wrapperCheck ( self,  object )

Exceptions   
ValueError, 'Invalid property value: wrapped object'
  getProperty  
getProperty (
        self,
        id,
        d=None,
        )

Get the property id, returning the optional second argument or None if no such property is found.

  getPropertyType  
getPropertyType ( self,  id )

Get the type of property id, returning None if no such property exists

  hasProperty  
hasProperty ( self,  id )

Return true if object has a property id

  manage_addProperty  
manage_addProperty (
        self,
        id,
        value,
        type,
        REQUEST=None,
        )

Add a new property via the web. Sets a new property with the given id, type, and value.

  manage_changeProperties  
manage_changeProperties (
        self,
        REQUEST=None,
        **kw,
        )

Change existing object properties.

Change object properties by passing either a mapping object of name:value pairs {'foo':6} or passing name=value parameters

Exceptions   
'BadRequest', '%s cannot be changed' % name
  manage_changePropertyTypes  
manage_changePropertyTypes (
        self,
        old_ids,
        props,
        REQUEST=None,
        )

Replace one set of properties with another

Delete all properties that have ids in old_ids, then add a property for each item in props. Each item has a new_id, new_value, and new_type. The type of new_value should match new_type.

  manage_delProperties  
manage_delProperties (
        self,
        ids=None,
        REQUEST=None,
        )

Delete one or more properties specified by ids.

Exceptions   
'BadRequest', ( 'The property %s does not exist' % id )
  manage_editProperties  
manage_editProperties ( self,  REQUEST )

Edit object properties via the web. The purpose of this method is to change all property values, even those not listed in REQUEST; otherwise checkboxes that get turned off will be ignored. Use manage_changeProperties() instead for most situations.

  propdict  
propdict ( self )

  propertyIds  
propertyIds ( self )

Return a list of property ids

  propertyItems  
propertyItems ( self )

Return a list of (id,property) tuples

  propertyLabel  
propertyLabel ( self,  id )

Return a label for the given property id

  propertyMap  
propertyMap ( self )

Return a tuple of mappings, giving meta-data for properties. Return copies of the real definitions for security.

  propertyValues  
propertyValues ( self )

Return a list of actual property objects

  valid_property_id  
valid_property_id ( self,  id )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/PropertySheets.py.html0100600000176200017510000001454707306455556025420 0ustar dhellmanndevel Module: PropertySheets

Table of Contents

Module: PropertySheets Zope-2-CVS-src/lib/python/OFS/PropertySheets.py

Property sheets

Imported modules   
from Acquisition import Implicit, Explicit, aq_base
from App.Common import rfc1123_date, iso8601_date
import App.Management
from ExtensionClass import Base
import Globals
from Globals import DTMLFile, MessageDialog, Persistent
from Traversable import Traversable
from ZPublisher.Converters import type_converters
import string
from string import find, join, lower, split, rfind
import time
from webdav.WriteLockInterface import WriteLockInterface
from webdav.common import urlbase
Functions   
absattr
  absattr  
absattr ( attr )

Classes   
DAVProperties

WebDAV properties

DefaultProperties

The default property set mimics the behavior of old-style Zope

DefaultPropertySheets

A PropertySheets container that contains a default property

FixedSchema

A Fixed-schema property sheet has no control over it's schema

PropertySheet

A PropertySheet is a container for a set of related properties and

PropertySheets

A tricky container to keep property sets from polluting

View

A view of an object, typically used for management purposes

Virtual

A virtual propertysheet stores it's properties in it's instance.

vps

Virtual Propertysheets

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/PropertySheets_DAVProperties.py.html0100600000176200017510000003741207306455556030163 0ustar dhellmanndevel Class: DAVProperties

Table of Contents

Class: DAVProperties Zope-2-CVS-src/lib/python/OFS/PropertySheets.py

WebDAV properties

Base Classes   
Virtual
PropertySheet
    Traversable
    Persistent
    Implicit
View
    App.Management.Tabs
    Base
Methods   
_delProperty
_propertyMap
_setProperty
_updateProperty
dav__creationdate
dav__displayname
dav__getcontentlength
dav__getcontenttype
dav__getlastmodified
dav__lockdiscovery
 dav__resourcetype
dav__source
dav__supportedlock
getProperty
propertyMap
  _delProperty  
_delProperty ( self,  id )

Exceptions   
ValueError, '%s cannot be deleted.' % id
  _propertyMap  
_propertyMap ( self )

  _setProperty  
_setProperty (
        self,
        id,
        value,
        type='string',
        meta=None,
        )

Exceptions   
ValueError, '%s cannot be set.' % id
  _updateProperty  
_updateProperty (
        self,
        id,
        value,
        )

Exceptions   
ValueError, '%s cannot be updated.' % id
  dav__creationdate  
dav__creationdate ( self )

  dav__displayname  
dav__displayname ( self )

  dav__getcontentlength  
dav__getcontentlength ( self )

  dav__getcontenttype  
dav__getcontenttype ( self )

  dav__getlastmodified  
dav__getlastmodified ( self )

  dav__lockdiscovery  
dav__lockdiscovery ( self )

  dav__resourcetype  
dav__resourcetype ( self )

  dav__source  
dav__source ( self )

  dav__supportedlock  
dav__supportedlock ( self )

  getProperty  
getProperty (
        self,
        id,
        default=None,
        )

  propertyMap  
propertyMap ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/PropertySheets_DefaultProperties.py.html0100600000176200017510000000445607306455556031137 0ustar dhellmanndevel Class: DefaultProperties

Table of Contents

Class: DefaultProperties Zope-2-CVS-src/lib/python/OFS/PropertySheets.py

The default property set mimics the behavior of old-style Zope properties -- it stores its property values in the instance of its owner.

Base Classes   
Virtual
PropertySheet
    Traversable
    Persistent
    Implicit
View
    App.Management.Tabs
    Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/PropertySheets_DefaultPropertySheets.py.html0100600000176200017510000000665507306455556032006 0ustar dhellmanndevel Class: DefaultPropertySheets

Table of Contents

Class: DefaultPropertySheets Zope-2-CVS-src/lib/python/OFS/PropertySheets.py

A PropertySheets container that contains a default property sheet for compatibility with the arbitrary property mgmt design of Zope PropertyManagers.

Base Classes   
PropertySheets
    Traversable
    Implicit
    App.Management.Tabs
Methods   
_get_defaults
  _get_defaults  
_get_defaults ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/PropertySheets_FixedSchema.py.html0100600000176200017510000001340707306455556027652 0ustar dhellmanndevel Class: FixedSchema

Table of Contents

Class: FixedSchema Zope-2-CVS-src/lib/python/OFS/PropertySheets.py

A Fixed-schema property sheet has no control over it's schema

It gets its schema from another proprtysheet but has control over its value storage.

This mix-in is used for ZClass instance proprtysheets, which store their data in instances, but get their schema from the proprtysheet managed in the ZClass.

Base Classes   
PropertySheet
    Traversable
    Persistent
    Implicit
Methods   
__init__
_propertyMap
propertyMap
property_extensible_schema__
  __init__  
__init__ (
        self,
        id,
        base,
        md=None,
        )

  _propertyMap  
_propertyMap ( self )

  propertyMap  
propertyMap ( self )

  property_extensible_schema__  
property_extensible_schema__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/PropertySheets_PropertySheet.py.html0100600000176200017510000007253507306455556030316 0ustar dhellmanndevel Class: PropertySheet

Table of Contents

Class: PropertySheet Zope-2-CVS-src/lib/python/OFS/PropertySheets.py

A PropertySheet is a container for a set of related properties and metadata describing those properties. PropertySheets may or may not provide a web interface for managing its properties.

Base Classes   
Traversable
Persistent
Implicit
Methods   
__init__
_delProperty
_propdict
_propertyMap
_setProperty
_updateProperty
_wrapperCheck
dav__allprop
dav__propnames
dav__propstat
 getId
getProperty
getPropertyType
hasProperty
manage_addProperty
manage_changeProperties
manage_delProperties
manage_editProperties
manage_propertiesForm
p_self
 propertyIds
propertyInfo
propertyItems
propertyMap
propertyValues
property_extensible_schema__
v_self
valid_property_id
xml_namespace
  __init__  
__init__ (
        self,
        id,
        md=None,
        )

  _delProperty  
_delProperty ( self,  id )

Exceptions   
'Bad Request', '%s cannot be deleted.' % id
'Bad Request', 'The property %s does not exist.' % id
  _propdict  
_propdict ( self )

  _propertyMap  
_propertyMap ( self )

  _setProperty  
_setProperty (
        self,
        id,
        value,
        type='string',
        meta=None,
        )

Exceptions   
'Bad Request', 'Invalid property id, %s.' % id
'Bad Request', ( 'Invalid property id, %s. It is in use.' % id )
'Bad Request', ( 'Properties cannot be added to this property sheet' )
'Bad Request', ( 'The value given for a new selection property ' 'must be a variable name

' )

  _updateProperty  
_updateProperty (
        self,
        id,
        value,
        meta=None,
        )

Exceptions   
'Bad Request', '%s cannot be changed.' % id
'Bad Request', 'The property %s does not exist.' % id
  _wrapperCheck  
_wrapperCheck ( self,  object )

Exceptions   
ValueError, 'Invalid property value: wrapped object'
  dav__allprop  
dav__allprop (
        self,
        propstat=propstat,
        join=string.join,
        )

  dav__propnames  
dav__propnames (
        self,
        propstat=propstat,
        join=string.join,
        )

  dav__propstat  
dav__propstat (
        self,
        name,
        result,
        propstat=propstat,
        propdesc=propdesc,
        join=string.join,
        )

  getId  
getId ( self )

  getProperty  
getProperty (
        self,
        id,
        default=None,
        )

  getPropertyType  
getPropertyType ( self,  id )

Get the type of property id, returning None if no such property exists

  hasProperty  
hasProperty ( self,  id )

  manage_addProperty  
manage_addProperty (
        self,
        id,
        value,
        type,
        REQUEST=None,
        )

Add a new property via the web. Sets a new property with the given id, type, and value.

  manage_changeProperties  
manage_changeProperties (
        self,
        REQUEST=None,
        **kw,
        )

Change existing object properties by passing either a mapping object of name:value pairs {'foo':6} or passing name=value parameters.

Exceptions   
'BadRequest', '%s cannot be changed' % name
  manage_delProperties  
manage_delProperties (
        self,
        ids=None,
        REQUEST=None,
        )

Delete one or more properties specified by ids.

  manage_editProperties  
manage_editProperties ( self,  REQUEST )

Edit object properties via the web.

  manage_propertiesForm  
manage_propertiesForm ( self,  URL1 )

Exceptions   
'Redirect', URL1 + '/manage'
  p_self  
p_self ( self )

  propertyIds  
propertyIds ( self )

  propertyInfo  
propertyInfo ( self,  id )

Exceptions   
ValueError, 'The property %s does not exist.' % id
  propertyItems  
propertyItems ( self )

  propertyMap  
propertyMap ( self )

  propertyValues  
propertyValues ( self )

  property_extensible_schema__  
property_extensible_schema__ ( self )

Return a flag indicating whether new properties may be added or removed.

  v_self  
v_self ( self )

  valid_property_id  
valid_property_id ( self,  id )

  xml_namespace  
xml_namespace ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/PropertySheets_PropertySheets.py.html0100600000176200017510000003132407306455556030470 0ustar dhellmanndevel Class: PropertySheets

Table of Contents

Class: PropertySheets Zope-2-CVS-src/lib/python/OFS/PropertySheets.py

A tricky container to keep property sets from polluting an object's direct attribute namespace.

Base Classes   
Traversable
Implicit
App.Management.Tabs
Methods   
__bobo_traverse__
__getitem__
__len__
__propsets__
_get_defaults
addPropertySheet
delPropertySheet
get
getId
items
 manage_addPropertySheet
manage_options
tabs_path_info
values
  __bobo_traverse__  
__bobo_traverse__ (
        self,
        REQUEST,
        name=None,
        )

  __getitem__  
__getitem__ ( self,  n )

  __len__  
__len__ ( self )

  __propsets__  
__propsets__ ( self )

  _get_defaults  
_get_defaults ( self )

  addPropertySheet  
addPropertySheet ( self,  propset )

  delPropertySheet  
delPropertySheet ( self,  name )

  get  
get (
        self,
        name,
        default=None,
        )

  getId  
getId ( self )

  items  
items ( self )

  manage_addPropertySheet  
manage_addPropertySheet (
        self,
        id,
        ns,
        )

  manage_options  
manage_options ( self )

Return a manage option data structure for me instance

  tabs_path_info  
tabs_path_info (
        self,
        script,
        path,
        )

  values  
values ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/PropertySheets_View.py.html0100600000176200017510000001427407306455556026407 0ustar dhellmanndevel Class: View

Table of Contents

Class: View Zope-2-CVS-src/lib/python/OFS/PropertySheets.py

A view of an object, typically used for management purposes

This class provides bits of management framework needed by propertysheets to be used as a view on an object.

Base Classes   
App.Management.Tabs
Base
Methods   
manage_options
manage_workspace
meta_type
tabs_path_info
tpURL
  manage_options  
manage_options ( self )

Return a manage option data structure for me instance

  manage_workspace  
manage_workspace (
        self,
        URL1,
        RESPONSE,
        )

Implement a "management" interface

  meta_type  
meta_type ( self )

  tabs_path_info  
tabs_path_info (
        self,
        script,
        path,
        )

  tpURL  
tpURL ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/PropertySheets_Virtual.py.html0100600000176200017510000000626707306455556027126 0ustar dhellmanndevel Class: Virtual

Table of Contents

Class: Virtual Zope-2-CVS-src/lib/python/OFS/PropertySheets.py

A virtual propertysheet stores it's properties in it's instance.

Methods   
__init__
v_self
  __init__  
__init__ ( self )

  v_self  
v_self ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/PropertySheets_vps.py.html0100600000176200017510000000776607306455556026315 0ustar dhellmanndevel Class: vps

Table of Contents

Class: vps Zope-2-CVS-src/lib/python/OFS/PropertySheets.py

Virtual Propertysheets

The vps object implements a "computed attribute" - it ensures that a PropertySheets instance is returned when the propertysheets attribute of a PropertyManager is accessed.

Base Classes   
Base
Methods   
__init__
__of__
  __init__  
__init__ ( self,  c=PropertySheets )

  __of__  
__of__ ( self,  parent )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/SimpleItem.py.html0100600000176200017510000001532507306455556024463 0ustar dhellmanndevel Module: SimpleItem

Table of Contents

Module: SimpleItem Zope-2-CVS-src/lib/python/OFS/SimpleItem.py

This module implements a simple item mix-in for objects that have a very simple (e.g. one-screen) management interface, like documents, Aqueduct database adapters, etc.

This module can also be used as a simple template for implementing new item types.

$Id: SimpleItem.py,v 1.89 2001/04/27 18:07:13 andreas Exp $

Imported modules   
from AccessControl import getSecurityManager
import AccessControl.Owned
import AccessControl.Role
import Acquisition
from Acquisition import aq_base
import App.Common
import App.Management
import App.Undo
from ComputedAttribute import ComputedAttribute
from CopySupport import CopySource
from DateTime import DateTime
from ExtensionClass import Base
import Globals
from Traversable import Traversable
import ZDOM
import marshal
import re
from string import join, lower, find, split
import sys
import time
from types import InstanceType, StringType
from webdav.Resource import Resource
Functions   
format_exception
pretty_tb
  format_exception  
format_exception (
        etype,
        value,
        tb,
        limit=None,
        )

  pretty_tb  
pretty_tb (
        t,
        v,
        tb,
        )

Classes   
Item

A common base class for simple, non-container objects.

Item_w__name__

Mixin class to support common name/id functions

SimpleItem

Mix-in class combining the most common set of basic mix-ins

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/SimpleItem_Item.py.html0100600000176200017510000004274307306455556025445 0ustar dhellmanndevel Class: Item

Table of Contents

Class: Item Zope-2-CVS-src/lib/python/OFS/SimpleItem.py

A common base class for simple, non-container objects.

Base Classes   
Base
Resource
CopySource
App.Management.Tabs
Traversable
ZDOM.Element
AccessControl.Owned.Owned
App.Undo.UndoSupport
Methods   
__len__
getId
manage
manage_FTPlist
manage_FTPstat
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_editedDialog
objectValues
 raise_standardErrorMessage
this
title_and_id
title_or_id
tpURL
tpValues
  __len__  
__len__ ( self )

  getId  
getId ( self )

Return the id of the object as a string. This method should be used in preference to accessing an id attribute of an object directly. The getId method is public.

Exceptions   
AttributeError, 'This object has no id'
  manage  
manage ( self,  URL1 )

Exceptions   
'Redirect', "%s/manage_main" % URL1
  manage_FTPlist  
manage_FTPlist ( self,  REQUEST )

Directory listing for FTP. In the case of non-Foldoid objects, the listing should contain one object, the object itself.

Exceptions   
ValueError( 'FTP List not supported on acquired objects' )
  manage_FTPstat  
manage_FTPstat ( self,  REQUEST )

psuedo stat, used by FTP for directory listings

  manage_afterAdd  
manage_afterAdd (
        self,
        item,
        container,
        )

  manage_afterClone  
manage_afterClone ( self,  item )

  manage_beforeDelete  
manage_beforeDelete (
        self,
        item,
        container,
        )

  manage_editedDialog  
manage_editedDialog (
        self,
        REQUEST,
        **args,
        )

  objectValues  
objectValues ( self,  spec=None )

This keeps simple items from acquiring their parents objectValues, etc., when used in simple tree tags.

  raise_standardErrorMessage  
raise_standardErrorMessage (
        self,
        client=None,
        REQUEST={},
        error_type=None,
        error_value=None,
        tb=None,
        error_tb=None,
        error_message='',
        tagSearch=re.compile( r'[a-zA-Z]>' ).search,
        )

Exceptions   
error_type, error_value, tb
error_type, v, tb
  this  
this ( self )

  title_and_id  
title_and_id ( self )

Utility that returns the title if it is not blank and the id otherwise. If the title is not blank, then the id is included in parens.

  title_or_id  
title_or_id ( self )

Utility that returns the title if it is not blank and the id otherwise.

  tpURL  
tpURL ( self )

  tpValues  
tpValues ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/SimpleItem_Item_w__name__.py.html0100600000176200017510000001341707306455556027424 0ustar dhellmanndevel Class: Item_w__name__

Table of Contents

Class: Item_w__name__ Zope-2-CVS-src/lib/python/OFS/SimpleItem.py

Mixin class to support common name/id functions

Base Classes   
Item
    Base
    Resource
    CopySource
    App.Management.Tabs
    Traversable
    ZDOM.Element
    AccessControl.Owned.Owned
    App.Undo.UndoSupport
Methods   
_setId
getPhysicalPath
title_and_id
title_or_id
  _setId  
_setId ( self,  id )

  getPhysicalPath  
getPhysicalPath ( self )

Returns a path (an immutable sequence of strings) that can be used to access this object again later, for example in a copy/paste operation. getPhysicalRoot() and getPhysicalPath() are designed to operate together.

  title_and_id  
title_and_id ( self )

Utility that returns the title if it is not blank and the id otherwise. If the title is not blank, then the id is included in parens.

  title_or_id  
title_or_id ( self )

Utility that returns the title if it is not blank and the id otherwise.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/SimpleItem_SimpleItem.py.html0100600000176200017510000000431507306455556026610 0ustar dhellmanndevel Class: SimpleItem

Table of Contents

Class: SimpleItem Zope-2-CVS-src/lib/python/OFS/SimpleItem.py

Mix-in class combining the most common set of basic mix-ins

Base Classes   
Item
    Base
    Resource
    CopySource
    App.Management.Tabs
    Traversable
    ZDOM.Element
    AccessControl.Owned.Owned
    App.Undo.UndoSupport
Globals.Persistent
Acquisition.Implicit
AccessControl.Role.RoleManager

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Traversable.py.html0100600000176200017510000000572107306455556024664 0ustar dhellmanndevel Module: Traversable

Table of Contents

Module: Traversable Zope-2-CVS-src/lib/python/OFS/Traversable.py

This module implements a mix-in for traversable objects.

$Id: Traversable.py,v 1.8 2001/05/21 19:47:28 evan Exp $

Imported modules   
from AccessControl import getSecurityManager
import Acquisition
from string import split, join
from urllib import quote
Classes   
Traversable

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Traversable_Traversable.py.html0100600000176200017510000001327607306455556027222 0ustar dhellmanndevel Class: Traversable

Table of Contents

Class: Traversable Zope-2-CVS-src/lib/python/OFS/Traversable.py

Methods   
absolute_url
getPhysicalPath
restrictedTraverse
unrestrictedTraverse
  absolute_url  
absolute_url ( self,  relative=0 )

  getPhysicalPath  
getPhysicalPath ( self )

Returns a path (an immutable sequence of strings) that can be used to access this object again later, for example in a copy/paste operation. getPhysicalRoot() and getPhysicalPath() are designed to operate together.

  restrictedTraverse  
restrictedTraverse (
        self,
        path,
        default=_marker,
        )

  unrestrictedTraverse  
unrestrictedTraverse (
        self,
        path,
        default=_marker,
        restricted=0,
        )

Exceptions   
'NotFound', name
'Unauthorized', name

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Uninstalled.py.html0100600000176200017510000001016107306455556024666 0ustar dhellmanndevel Module: Uninstalled

Table of Contents

Module: Uninstalled Zope-2-CVS-src/lib/python/OFS/Uninstalled.py

Objects for packages that have been uninstalled.

Imported modules   
import Acquisition
from Acquisition import Acquired
import Globals
import Persistence
import SimpleItem
import string
Functions   
Broken
  Broken  
Broken (
        self,
        oid,
        klass,
        )

Classes   
BrokenClass

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/Uninstalled_BrokenClass.py.html0100600000176200017510000001250707306455556027162 0ustar dhellmanndevel Class: BrokenClass

Table of Contents

Class: BrokenClass Zope-2-CVS-src/lib/python/OFS/Uninstalled.py

Base Classes   
Acquisition.Explicit
SimpleItem.Item
Persistence.Overridable
Methods   
__getattr__
__getstate__
  __getattr__  
__getattr__ ( self,  name )

Exceptions   
AttributeError, name
  __getstate__  
__getstate__ ( self )

Exceptions   
SystemError, ( """This object was originally created by a product that is no longer installed. It cannot be updated. """ )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/XMLExportImport.py.html0100600000176200017510000001771407306455556025454 0ustar dhellmanndevel Module: XMLExportImport

Table of Contents

Module: XMLExportImport Zope-2-CVS-src/lib/python/OFS/XMLExportImport.py

Imported modules   
import Shared.DC.xml.ppml
from ZODB.ExportImport import TemporaryFile, export_end_marker
from ZODB.referencesf import referencesf
from base64 import encodestring
from cStringIO import StringIO
import string
Functions   
XMLrecord
exportXML
importXML
save_record
save_zopedata
start_zopedata
  XMLrecord  
XMLrecord (
        oid,
        len,
        p,
        )

  exportXML  
exportXML (
        jar,
        oid,
        file=None,
        )

  importXML  
importXML (
        jar,
        file,
        clue='',
        )

  save_record  
save_record (
        parser,
        tag,
        data,
        )

  save_zopedata  
save_zopedata (
        parser,
        tag,
        data,
        )

  start_zopedata  
start_zopedata (
        parser,
        tag,
        data,
        )

Classes   
zopedata

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/XMLExportImport_zopedata.py.html0100600000176200017510000000634607306455556027342 0ustar dhellmanndevel Class: zopedata

Table of Contents

Class: zopedata Zope-2-CVS-src/lib/python/OFS/XMLExportImport.py

Methods   
__init__
append
  __init__  
__init__ (
        self,
        parser,
        tag,
        attrs,
        )

  append  
append ( self,  data )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM.py.html0100600000176200017510000001375207306455557023167 0ustar dhellmanndevel Module: ZDOM

Table of Contents

Module: ZDOM Zope-2-CVS-src/lib/python/OFS/ZDOM.py

DOM implementation in ZOPE : Read-Only methods

All standard Zope objects support DOM to a limited extent.

Imported modules   
import Acquisition
import string
Classes   
Attr

Attr interface - The Attr interface represents an attriubte in an

DOMException
DOMImplementation

DOMImplementation Interface

DOMStringSizeException
Document

Document Interface

Element

Element interface

ElementWithAttributes

Elements that allow DOM access to Zope properties of type string.

ElementWithTitle

Elements that allow DOM access to Zope title property.

HierarchyRequestException
InUseAttributeException
IndexSizeException
InvalidCharacterException
NamedNodeMap

NamedNodeMap interface - Is used to represent collections

NoDataAllowedException
NoModificationAllowedException
Node

Node Interface

NodeList

NodeList interface - Provides the abstraction of an ordered

NotFoundException
NotSupportedException
Root

The top-level Zope object.

WrongDocumentException

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_Attr.py.html0100600000176200017510000001550107306455556024152 0ustar dhellmanndevel Class: Attr

Table of Contents

Class: Attr Zope-2-CVS-src/lib/python/OFS/ZDOM.py

Attr interface - The Attr interface represents an attriubte in an Element object. Attr objects inherit the Node Interface

Base Classes   
Acquisition.Implicit
Node
Methods   
__init__
getName
getNodeName
getNodeType
getNodeValue
getSpecified
  __init__  
__init__ (
        self,
        name,
        value,
        )

  getName  
getName ( self )

Returns the name of this attribute.

  getNodeName  
getNodeName ( self )

The name of this node, depending on its type

  getNodeType  
getNodeType ( self )

A code representing the type of the node.

  getNodeValue  
getNodeValue ( self )

The value of this node, depending on its type

  getSpecified  
getSpecified ( self )

If this attribute was explicitly given a value in the original document, this is true; otherwise, it is false.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_DOMException.py.html0100600000176200017510000000364207306455556025541 0ustar dhellmanndevel Class: DOMException

Table of Contents

Class: DOMException Zope-2-CVS-src/lib/python/OFS/ZDOM.py

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_DOMImplementation.py.html0100600000176200017510000000613507306455556026570 0ustar dhellmanndevel Class: DOMImplementation

Table of Contents

Class: DOMImplementation Zope-2-CVS-src/lib/python/OFS/ZDOM.py

DOMImplementation Interface

Methods   
hasFeature
  hasFeature  
hasFeature (
        self,
        feature,
        version=None,
        )

hasFeature - Test if the DOM implementation implements a specific feature. Parameters: feature The package name of the feature to test. In Level 1, the legal values are "HTML" and "XML" (case-insensitive). version This is the version number of the package name to test. In Level 1, this is the string "1.0". If the version is not specified, supporting any version of the feature will cause the method to return true. Return Value true if the feature is implemented in the specified version, false otherwise.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_DOMStringSizeException.py.html0100600000176200017510000000377407306455556027571 0ustar dhellmanndevel Class: DOMStringSizeException

Table of Contents

Class: DOMStringSizeException Zope-2-CVS-src/lib/python/OFS/ZDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_Document.py.html0100600000176200017510000002427107306455557025023 0ustar dhellmanndevel Class: Document

Table of Contents

Class: Document Zope-2-CVS-src/lib/python/OFS/ZDOM.py

Document Interface

Base Classes   
Acquisition.Explicit
Node
Methods   
getChildNodes
getDoctype
getDocumentElement
getFirstChild
getImplementation
getLastChild
getNodeName
getNodeType
getOwnerDocument
hasChildNodes
  getChildNodes  
getChildNodes ( self )

Returns a NodeList that contains all children of this node. If there are no children, this is a empty NodeList

  getDoctype  
getDoctype ( self )

The Document Type Declaration associated with this document. For HTML documents as well as XML documents without a document type declaration this returns null.

  getDocumentElement  
getDocumentElement ( self )

This is a convenience attribute that allows direct access to the child node that is the root element of the document.

  getFirstChild  
getFirstChild ( self )

The first child of this node. If there is no such node this returns None.

  getImplementation  
getImplementation ( self )

The DOMImplementation object that handles this document.

  getLastChild  
getLastChild ( self )

The last child of this node. If there is no such node this returns None.

  getNodeName  
getNodeName ( self )

The name of this node, depending on its type

  getNodeType  
getNodeType ( self )

A code representing the type of the node.

  getOwnerDocument  
getOwnerDocument ( self )

The Document object associated with this node. When this is a document this is None

  hasChildNodes  
hasChildNodes ( self )

Returns true if the node has any children, false if it doesn't.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_Element.py.html0100600000176200017510000002737207306455557024643 0ustar dhellmanndevel Class: Element

Table of Contents

Class: Element Zope-2-CVS-src/lib/python/OFS/ZDOM.py

Element interface

Base Classes   
Node
Methods   
getAttribute
getAttributeNode
getChildNodes
getElementsByTagName
getFirstChild
getLastChild
getNextSibling
getNodeName
getNodeType
getParentNode
 getPreviousSibling
getTagName
  getAttribute  
getAttribute ( self,  name )

Retrieves an attribute value by name.

  getAttributeNode  
getAttributeNode ( self,  name )

Retrieves an Attr node by name or None if there is no such attribute.

  getChildNodes  
getChildNodes ( self )

Returns a NodeList that contains all children of this node. If there are no children, this is a empty NodeList

  getElementsByTagName  
getElementsByTagName ( self,  tagname )

Returns a NodeList of all the Elements with a given tag name in the order in which they would be encountered in a preorder traversal of the Document tree. Parameter: tagname The name of the tag to match (* = all tags). Return Value: A new NodeList object containing all the matched Elements.

  getFirstChild  
getFirstChild ( self )

The first child of this node. If there is no such node this returns None

  getLastChild  
getLastChild ( self )

The last child of this node. If there is no such node this returns None.

  getNextSibling  
getNextSibling ( self )

The node immediately preceding this node. If there is no such node, this returns None.

  getNodeName  
getNodeName ( self )

The name of this node, depending on its type

  getNodeType  
getNodeType ( self )

A code representing the type of the node.

  getParentNode  
getParentNode ( self )

The parent of this node. All nodes except Document DocumentFragment and Attr may have a parent

  getPreviousSibling  
getPreviousSibling ( self )

The node immediately preceding this node. If there is no such node, this returns None.

  getTagName  
getTagName ( self )

The name of the element

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_ElementWithAttributes.py.html0100600000176200017510000001161707306455557027541 0ustar dhellmanndevel Class: ElementWithAttributes

Table of Contents

Class: ElementWithAttributes Zope-2-CVS-src/lib/python/OFS/ZDOM.py

Elements that allow DOM access to Zope properties of type string.

Note: This sub-class should only be used by PropertyManagers

Base Classes   
Element
Methods   
getAttribute
getAttributeNode
getAttributes
  getAttribute  
getAttribute ( self,  name )

Retrieves an attribute value by name.

  getAttributeNode  
getAttributeNode ( self,  name )

Retrieves an Attr node by name or None if there is no such attribute.

  getAttributes  
getAttributes ( self )

Returns a NamedNodeMap containing the attributes of this node (if it is an element) or None otherwise.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_ElementWithTitle.py.html0100600000176200017510000001156107306455557026472 0ustar dhellmanndevel Class: ElementWithTitle

Table of Contents

Class: ElementWithTitle Zope-2-CVS-src/lib/python/OFS/ZDOM.py

Elements that allow DOM access to Zope title property.

Note: Don't use this sub-class for PropertyManagers

Base Classes   
Element
Methods   
getAttribute
getAttributeNode
getAttributes
  getAttribute  
getAttribute ( self,  name )

Retrieves an attribute value by name.

  getAttributeNode  
getAttributeNode ( self,  name )

Retrieves an Attr node by name or None if there is no such attribute.

  getAttributes  
getAttributes ( self )

Returns a NamedNodeMap containing the attributes of this node (if it is an element) or None otherwise.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_HierarchyRequestException.py.html0100600000176200017510000000400207306455557030401 0ustar dhellmanndevel Class: HierarchyRequestException

Table of Contents

Class: HierarchyRequestException Zope-2-CVS-src/lib/python/OFS/ZDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_InUseAttributeException.py.html0100600000176200017510000000377607306455557030042 0ustar dhellmanndevel Class: InUseAttributeException

Table of Contents

Class: InUseAttributeException Zope-2-CVS-src/lib/python/OFS/ZDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_IndexSizeException.py.html0100600000176200017510000000376407306455557027032 0ustar dhellmanndevel Class: IndexSizeException

Table of Contents

Class: IndexSizeException Zope-2-CVS-src/lib/python/OFS/ZDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_InvalidCharacterException.py.html0100600000176200017510000000400207306455557030315 0ustar dhellmanndevel Class: InvalidCharacterException

Table of Contents

Class: InvalidCharacterException Zope-2-CVS-src/lib/python/OFS/ZDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_NamedNodeMap.py.html0100600000176200017510000001332107306455557025527 0ustar dhellmanndevel Class: NamedNodeMap

Table of Contents

Class: NamedNodeMap Zope-2-CVS-src/lib/python/OFS/ZDOM.py

NamedNodeMap interface - Is used to represent collections of nodes that can be accessed by name. NamedNodeMaps are not maintained in any particular order.

Python extensions: can use sequence-style len, getitem, and for..in constructs, and mapping-style getitem.

Methods   
__getitem__
__init__
getLength
getNamedItem
item
  __getitem__  
__getitem__ ( self,  key )

  __init__  
__init__ ( self,  data=None )

  getLength  
getLength ( self )

The length of the NodeList

  getNamedItem  
getNamedItem ( self,  name )

Retrieves a node specified by name. Parameters: name Name of a node to retrieve. Return Value A Node (of any type) with the specified name, or None if the specified name did not identify any node in the map.

  item  
item ( self,  index )

Returns the index-th item in the map

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_NoDataAllowedException.py.html0100600000176200017510000000377407306455557027607 0ustar dhellmanndevel Class: NoDataAllowedException

Table of Contents

Class: NoDataAllowedException Zope-2-CVS-src/lib/python/OFS/ZDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_NoModificationAllowedException.py.html0100600000176200017510000000401407306455557031327 0ustar dhellmanndevel Class: NoModificationAllowedException

Table of Contents

Class: NoModificationAllowedException Zope-2-CVS-src/lib/python/OFS/ZDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_Node.py.html0100600000176200017510000002431107306455557024125 0ustar dhellmanndevel Class: Node

Table of Contents

Class: Node Zope-2-CVS-src/lib/python/OFS/ZDOM.py

Node Interface

Methods   
getAttributes
getChildNodes
getFirstChild
getLastChild
getNextSibling
getNodeName
getNodeValue
getOwnerDocument
getParentNode
getPreviousSibling
 hasChildNodes
  getAttributes  
getAttributes ( self )

Returns a NamedNodeMap containing the attributes of this node (if it is an element) or None otherwise.

  getChildNodes  
getChildNodes ( self )

Returns a NodeList that contains all children of this node. If there are no children, this is a empty NodeList

  getFirstChild  
getFirstChild ( self )

The first child of this node. If there is no such node this returns None.

  getLastChild  
getLastChild ( self )

The last child of this node. If there is no such node this returns None.

  getNextSibling  
getNextSibling ( self )

The node immediately preceding this node. If there is no such node, this returns None.

  getNodeName  
getNodeName ( self )

The name of this node, depending on its type

  getNodeValue  
getNodeValue ( self )

The value of this node, depending on its type

  getOwnerDocument  
getOwnerDocument ( self )

The Document object associated with this node. When this is a document this is None

  getParentNode  
getParentNode ( self )

The parent of this node. All nodes except Document DocumentFragment and Attr may have a parent

  getPreviousSibling  
getPreviousSibling ( self )

The node immediately preceding this node. If there is no such node, this returns None.

  hasChildNodes  
hasChildNodes ( self )

Returns true if the node has any children, false if it doesn't.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_NodeList.py.html0100600000176200017510000001131507306455557024761 0ustar dhellmanndevel Class: NodeList

Table of Contents

Class: NodeList Zope-2-CVS-src/lib/python/OFS/ZDOM.py

NodeList interface - Provides the abstraction of an ordered collection of nodes.

Python extensions: can use sequence-style len, getitem, and for..in constructs.

Methods   
__getitem__
__init__
getLength
item
  __getitem__  
__getitem__ ( self,  index )

  __init__  
__init__ ( self,  list=None )

  getLength  
getLength ( self )

The length of the NodeList

  item  
item ( self,  index )

Returns the index-th item in the collection

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_NotFoundException.py.html0100600000176200017510000000376207306455557026662 0ustar dhellmanndevel Class: NotFoundException

Table of Contents

Class: NotFoundException Zope-2-CVS-src/lib/python/OFS/ZDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_NotSupportedException.py.html0100600000176200017510000000377207306455557027575 0ustar dhellmanndevel Class: NotSupportedException

Table of Contents

Class: NotSupportedException Zope-2-CVS-src/lib/python/OFS/ZDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_Root.py.html0100600000176200017510000000647307306455557024174 0ustar dhellmanndevel Class: Root

Table of Contents

Class: Root Zope-2-CVS-src/lib/python/OFS/ZDOM.py

The top-level Zope object.

Base Classes   
ElementWithAttributes
Methods   
getOwnerDocument
  getOwnerDocument  
getOwnerDocument ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ZDOM_WrongDocumentException.py.html0100600000176200017510000000377407306455557027724 0ustar dhellmanndevel Class: WrongDocumentException

Table of Contents

Class: WrongDocumentException Zope-2-CVS-src/lib/python/OFS/ZDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/__init__.py.html0100600000176200017510000000242307306455557024146 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/OFS/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/content_types.py.html0100600000176200017510000001025607306455557025310 0ustar dhellmanndevel Module: content_types

Table of Contents

Module: content_types Zope-2-CVS-src/lib/python/OFS/content_types.py

A utility module for content-type handling.

Imported modules   
import mimetypes
import re
from string import split, strip, lower, find
Functions   
guess_content_type
text_type
  guess_content_type  
guess_content_type (
        name='',
        body='',
        default=None,
        )

  text_type  
text_type ( s )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/misc_.py.html0100600000176200017510000000565107306455557023507 0ustar dhellmanndevel Module: misc_

Table of Contents

Module: misc_ Zope-2-CVS-src/lib/python/OFS/misc_.py

Imported modules   
from App.ImageFile import ImageFile
Classes   
Misc_

Miscellaneous product information

misc_

Miscellaneous product information

p_

Shared system information

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/misc__Misc_.py.html0100600000176200017510000001116407306455557024615 0ustar dhellmanndevel Class: Misc_

Table of Contents

Class: Misc_ Zope-2-CVS-src/lib/python/OFS/misc_.py

Miscellaneous product information

Methods   
__getitem__
__init__
__setitem__
__str__
  __getitem__  
__getitem__ ( self,  name )

  __init__  
__init__ (
        self,
        name,
        dict,
        )

  __setitem__  
__setitem__ (
        self,
        name,
        v,
        )

  __str__  
__str__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/misc__misc_.py.html0100600000176200017510000000240107306455557024647 0ustar dhellmanndevel Class: misc_

Table of Contents

Class: misc_ Zope-2-CVS-src/lib/python/OFS/misc_.py

Miscellaneous product information

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/misc__p_.py.html0100600000176200017510000000236307306455557024162 0ustar dhellmanndevel Class: p_

Table of Contents

Class: p_ Zope-2-CVS-src/lib/python/OFS/misc_.py

Shared system information

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ndiff.py.html0100600000176200017510000003407407306455557023504 0ustar dhellmanndevel Module: ndiff

Table of Contents

Module: ndiff Zope-2-CVS-src/lib/python/OFS/ndiff.py

ndiff [-q] file1 file2 or ndiff (-r1 | -r2) < ndiff_output > file1_or_file2

Print a human-friendly file difference report to stdout. Both inter- and intra-line differences are noted. In the second form, recreate file1 (-r1) or file2 (-r2) on stdout, from an ndiff report on stdin.

In the first form, if -q ("quiet") is not specified, the first two lines of output are

-: file1 +: file2

Each remaining line begins with a two-letter code:

"- " line unique to file1 "+ " line unique to file2 " " line common to both files "? " line not present in either input file

Lines beginning with "? " attempt to guide the eye to intraline differences, and were not present in either input file. These lines can be confusing if the source files contain tab characters.

The first file can be recovered by retaining only lines that begin with " " or "- ", and deleting those 2-character prefixes; use ndiff with -r1.

The second file can be recovered similarly, but by retaining only " " and "+ " lines; use ndiff with -r2; or, on Unix, the second file can be recovered by piping the output through

sed -n /^[+ ] /s/^..//p

See module comments for details and programmatic interface.

Imported modules   
import re
import string
Functions   
IS_CHARACTER_JUNK
IS_LINE_JUNK
dump
fail
fancy_helper
fancy_replace
fcompare
fopen
main
plain_replace
 restore
  IS_CHARACTER_JUNK  
IS_CHARACTER_JUNK ( ch,  ws=" \t" )

  IS_LINE_JUNK  
IS_LINE_JUNK ( line,  pat=re.compile( r"\s*#?\s*$" ).match )

  dump  
dump (
        tag,
        x,
        lo,
        hi,
        )

meant for dumping lines

  fail  
fail ( msg )

  fancy_helper  
fancy_helper (
        a,
        alo,
        ahi,
        b,
        blo,
        bhi,
        )

  fancy_replace  
fancy_replace (
        a,
        alo,
        ahi,
        b,
        blo,
        bhi,
        )

Exceptions   
ValueError, 'unknown tag ' + ` tag `
  fcompare  
fcompare ( f1name,  f2name )

open two files & spray the diff to stdout; return false iff a problem

Exceptions   
ValueError, 'unknown tag ' + ` tag `
  fopen  
fopen ( fname )

open a file & return the file object; gripe and return 0 if it couldn't be opened

  main  
main ( args )

  plain_replace  
plain_replace (
        a,
        alo,
        ahi,
        b,
        blo,
        bhi,
        )

  restore  
restore ( which )

Classes   
SequenceMatcher

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/ndiff_SequenceMatcher.py.html0100600000176200017510000003251507306455557026636 0ustar dhellmanndevel Class: SequenceMatcher

Table of Contents

Class: SequenceMatcher Zope-2-CVS-src/lib/python/OFS/ndiff.py

Methods   
__chain_b
__helper
__init__
find_longest_match
get_matching_blocks
get_opcodes
quick_ratio
ratio
real_quick_ratio
set_seq1
 set_seq2
set_seqs
  __chain_b  
__chain_b ( self )

  __helper  
__helper (
        self,
        alo,
        ahi,
        blo,
        bhi,
        answer,
        )

  __init__  
__init__ (
        self,
        isjunk=None,
        a='',
        b='',
        )

Members: a first sequence b second sequence; differences are computed as "what do we need to do to a to change it into b?" b2j for x in b, b2j[x] is a list of the indices (into b) at which x appears; junk elements do not appear b2jhas b2j.has_key fullbcount for x in b, fullbcount[x] == the number of times x appears in b; only materialized if really needed (used only for computing quick_ratio()) matching_blocks a list of (i, j, k) triples, where a[i:i+k] == b[j:j+k]; ascending & non-overlapping in i and in j; terminated by a dummy (len(a), len(b), 0) sentinel opcodes a list of (tag, i1, i2, j1, j2) tuples, where tag is one of replace a[i1:i2] should be replaced by b[j1:j2] delete a[i1:i2] should be deleted insert b[j1:j2] should be inserted equal a[i1:i2] == b[j1:j2] isjunk a user-supplied function taking a sequence element and returning true iff the element is "junk" -- this has subtle but helpful effects on the algorithm, which I'll get around to writing up someday <0.9 wink>. DON'T USE! Only __chain_b uses this. Use isbjunk. isbjunk for x in b, isbjunk(x) == isjunk(x) but much faster; it's really the has_key method of a hidden dict. DOES NOT WORK for x in a!

  find_longest_match  
find_longest_match (
        self,
        alo,
        ahi,
        blo,
        bhi,
        )

Find longest matching block in a[alo:ahi] and b[blo:bhi].

If isjunk is not defined:

Return (i,j,k) such that a[i:i+k] is equal to b[j:j+k], where alo <= i <= i+k <= ahi blo <= j <= j+k <= bhi and for all (i',j',k') meeting those conditions, k >= k' i <= i' and if i == i', j <= j' In other words, of all maximal matching blocks, return one that starts earliest in a, and of all those maximal matching blocks that start earliest in a, return the one that starts earliest in b.

If isjunk is defined, first the longest matching block is determined as above, but with the additional restriction that no junk element appears in the block. Then that block is extended as far as possible by matching (only) junk elements on both sides. So the resulting block never matches on junk except as identical junk happens to be adjacent to an "interesting" match.

If no blocks match, return (alo, blo, 0).

  get_matching_blocks  
get_matching_blocks ( self )

  get_opcodes  
get_opcodes ( self )

  quick_ratio  
quick_ratio ( self )

Return an upper bound on ratio() relatively quickly.

  ratio  
ratio ( self )

Return a measure of the sequences' similarity (float in [0,1]).

Where T is the total number of elements in both sequences, and M is the number of matches, this is 2*M / T. Note that this is 1 if the sequences are identical, and 0 if they have nothing in common.

  real_quick_ratio  
real_quick_ratio ( self )

Return an upper bound on ratio() very quickly

  set_seq1  
set_seq1 ( self,  a )

  set_seq2  
set_seq2 ( self,  b )

  set_seqs  
set_seqs (
        self,
        a,
        b,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/rPickle.py.html0100600000176200017510000001232007306455557023775 0ustar dhellmanndevel Module: rPickle

Table of Contents

Module: rPickle Zope-2-CVS-src/lib/python/OFS/rPickle.py

Restricted unpickler

Imported modules   
from cStringIO import StringIO
import pickle
Functions   
loads
register
unregister
  loads  
loads ( s )

Unpickle a string

  register  
register (
        mod,
        cls,
        obj,
        )

Register a class

  unregister  
unregister ( mod,  cls )

Unregister a class

Classes   
Unpickler

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/OFS/rPickle_Unpickler.py.html0100600000176200017510000001230107306455557026010 0ustar dhellmanndevel Class: Unpickler

Table of Contents

Class: Unpickler Zope-2-CVS-src/lib/python/OFS/rPickle.py

Base Classes   
pickle.Unpickler
Methods   
find_class
load_string
  find_class  
find_class (
        self,
        module,
        name,
        )

Exceptions   
SystemError, 'Class not registered'
  load_string  
load_string ( self )

Exceptions   
'BadPickle', 'Non binstring'

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:33 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/0040700000176200017510000000000007306455606022241 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/index.html0100600000176200017510000001025307306455606024236 0ustar dhellmanndevel Zope2 CVS with ZEO: Products

Table of Contents

Zope2 CVS with ZEO: Products  

External Methods

The External Method product provides support for external Python methods, exposing them as callable objects within the Zope environment.

Modules and Packages   

Zope-2-CVS-src/lib/python/Products/

ExternalMethod

External Methods

MIMETools

The MIMETools Product

MailHost

MailHost

OFSP

OFSP

PluginIndexes

Zope 2.4 introduces a new way to register customized indexes (see PluggableIndex interface).

PythonMethod

Python Methods

PythonScripts

Python Scripts

SiteAccess

SiteAccess

StandardCacheManagers

Some standard Zope cache managers from Digital Creations.

ZCatalog

ZCatalog product

ZGadflyDA

ZGadflyDA

ZSQLMethods

ZSQLMethods

ZopeTutorial

Zope2 CVS with ZEO: Products.ZopeTutorial

__init__

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:45 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ExternalMethod/0040700000176200017510000000000007306455560025163 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ExternalMethod/index.html0100600000176200017510000000471507306455560027166 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.ExternalMethod

Table of Contents

Zope2 CVS with ZEO: Products.ExternalMethod  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/ExternalMethod/

CHANGES.txt.html

External Method Changes

README.txt.html

External Methods

ExternalMethod

External Method Product

__init__

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:45 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ExternalMethod/ExternalMethod.py.html0100600000176200017510000001373107306455560031427 0ustar dhellmanndevel Module: ExternalMethod

Table of Contents

Module: ExternalMethod Zope-2-CVS-src/lib/python/Products/ExternalMethod/ExternalMethod.py

External Method Product

This product provides support for external methods, which allow domain-specific customization of web environments.

Imported modules   
import AccessControl.Role
import Acquisition
from App.Extensions import getObject, getPath, FuncCode
from App.Management import Navigation
from Globals import Persistent, DTMLFile, MessageDialog, HTML, DevelopmentMode
import OFS.SimpleItem
from OFS.SimpleItem import pretty_tb
import os
import stat
from string import split, join, find, lower
import sys
import traceback
Functions   
manage_addExternalMethod
  manage_addExternalMethod  
manage_addExternalMethod (
        self,
        id,
        title,
        module,
        function,
        REQUEST=None,
        )

Add an external method to a folder

Un addition to the standard object-creation arguments, id and title, the following arguments are defined:

function

The name of the python function. This can be a an ordinary Python function, or a bound method.

module

The name of the file containing the function definition.

The module normally resides in the Extensions directory, however, the file name may have a prefix of product., indicating that it should be found in a product directory.

For example, if the module is: ACMEWidgets.foo, then an attempt will first be made to use the file lib/python/Products/ACMEWidgets/Extensions/foo.py. If this failes, then the file Extensions/ACMEWidgets.foo.py will be used.

Classes   
ExternalMethod

Web-callable functions that encapsulate external python functions.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:45 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ExternalMethod/ExternalMethod_ExternalMethod.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ExternalMethod/ExternalMethod_ExternalMethod.0100600000176200017510000002401707306455560033115 0ustar dhellmanndevel Class: ExternalMethod

Table of Contents

Class: ExternalMethod Zope-2-CVS-src/lib/python/Products/ExternalMethod/ExternalMethod.py

Web-callable functions that encapsulate external python functions.

The function is defined in an external file. This file is treated like a module, but is not a module. It is not imported directly, but is rather read and evaluated. The file must reside in the Extensions subdirectory of the Zope installation, or in an Extensions subdirectory of a product directory.

Due to the way ExternalMethods are loaded, it is not currently possible to use Python modules that reside in the Extensions directory. It is possible to load modules found in the lib/python directory of the Zope installation, or in packages that are in the lib/python directory.

Base Classes   
OFS.SimpleItem.Item
Persistent
Acquisition.Explicit
AccessControl.Role.RoleManager
Navigation
Methods   
__call__
__init__
filepath
function
getFunction
manage_edit
module
  __call__  
__call__ (
        self,
        *args,
        *kw,
        )

Call an ExternalMethod

Calling an External Method is roughly equivalent to calling the original actual function from Python. Positional and keyword parameters can be passed as usual. Note however that unlike the case of a normal Python method, the "self" argument must be passed explicitly. An exception to this rule is made if:

  • The supplied number of arguments is one less than the required number of arguments, and

  • The name of the function's first argument is self.

In this case, the URL parent of the object is supplied as the first argument.

Exceptions   
TypeError, v, tb
  __init__  
__init__ (
        self,
        id,
        title,
        module,
        function,
        )

  filepath  
filepath ( self )

  function  
function ( self )

  getFunction  
getFunction (
        self,
        check=0,
        reload=0,
        )

  manage_edit  
manage_edit (
        self,
        title,
        module,
        function,
        REQUEST=None,
        )

Change the external method

See the description of manage_addExternalMethod for a descriotion of the arguments module and function.

Note that calling manage_edit causes the "module" to be effectively reloaded. This is useful during debugging to see the effects of changes, but can lead to problems of functions rely on shared global data.

  module  
module ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:45 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ExternalMethod/__init__.py.html0100600000176200017510000000636007306455560030243 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/ExternalMethod/__init__.py

Imported modules   
import ExternalMethod
Functions   
initialize
  initialize  
initialize ( context )

This is the new way to initialize products. It is hoped that this more direct mechanism will be more understandable.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:45 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ExternalMethod/CHANGES.txt.html0100600000176200017510000000532207306455560027740 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.ExternalMethod

Table of Contents

Zope2 CVS with ZEO: Products.ExternalMethod  

External Method Changes

External Method 1.3

Features

  • Permissions have been updated to work with the Principia 1.2 and later permission-management enhancements.

External Method 1.2

Bug Fixes

  • TypeError exceptions in external methods were reported incorrectly.

Features

  • ExternalMethods now use standard_error_message to report errors.

External Method 1.1

This release changes the way that ExternalMethods are bound to folders. ExternalMethods now bind themselves to their acquisition parents, rather than to REQUEST['PARENTS'][0]. This is needed to make ExternalMethods useful in trees and exprs. The 1.1 release of Principia is needed for this release of ExternalMethod to function correctly.

External Method 1.0.3

Bugs Fixed

  • A new copy of an external method was written the first time it was used after being loaded from the database. In addition to database bloat, this could also cause strange session/locking behavior.

External Method 1.0.2

Bugs Fixed

  • Add permissions were not editable.

Features

  • If an ExternalMethod takes a single argument, named self, and is called with no arguments, then the folder in which the method is accessed is passed. This is handy when the method is called from a document.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:45 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ExternalMethod/README.txt.html0100600000176200017510000000253207306455560027625 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.ExternalMethod

Table of Contents

Zope2 CVS with ZEO: Products.ExternalMethod  

External Methods

The External Method product provides support for external Python methods, exposing them as callable objects within the Zope environment.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:45 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/MIMETools/0040700000176200017510000000000007306455561024011 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/MIMETools/index.html0100600000176200017510000001460007306455561026006 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.MIMETools

Table of Contents

Zope2 CVS with ZEO: Products.MIMETools  

The MIMETools Product

The MIMETools product is alpha quality software. It may not work as documented or at all. If you encounter bugs in MIMETools, please report your problem to support@digicool.com or discuss it on the Zope mailing list, zope@zope.org.

Currently, the MIMETools product's only function is to provide the DTML tag.

The tag is used to construct MIME containers. The syntax of the tag is:

Contents of first part

Contents of second part

Contents of nth part

The area of data between tags, called a block, is encoded into whatever is specified with the encode tag attribute for that block. If no encoding is specified, base64 is defaulted. Valid encoding options include base64, quoted-printable, uuencode, x-uuencode, uue and x-uue. If the encode attribute is set to 7bit no encoding is done on the block and the data is assumed to be in a valid MIME format.

If the disposition attribute is not specified for a certain block, then the Content-Disposition: MIME header is not included in that block's MIME part.

The entire MIME container, from the opening mime tag to the closing, has it's Content-Type: MIME header set to multipart/mixed.

For example, the following DTML:

This is the first part. This is the second.

Is rendered to the following text:

Content-Type: multipart/mixed; boundary="216.164.72.30.501.1550.923070182.795.22531"

--216.164.72.30.501.1550.923070182.795.22531 Content-Type: text/plain Content-Transfer-Encoding: 7bit

This is the first part.

--216.164.72.30.501.1550.923070182.795.22531 Content-Type: text/plain Content-Transfer-Encoding: base64

VGhpcyBpcyB0aGUgc2Vjb25kLgo=

--216.164.72.30.501.1550.923070182.795.22531--

The #mime tag is particulary handy in conjunction with the #sendmail tag. This allows Zope to send attachments along with email. Here is an example:

  Create a DTML method called 'input' with the following code:

    <!--#var standard_html_header-->
    <form method=post action="send" ENCTYPE="multipart/form-data">
    <input type=file name="afile"><br>
    Send to:<input type=textbox name="who"><br>
    <input type=submit value="Send">
    </form>
    <!--#var standard_html_footer-->

  Create another DTML Method called 'send' with the following code:

    <!--#var standard_html_header-->
    <!--#sendmail smtphost=localhost -->
    From: michel@digicool.com
    To: <!--#var who-->
    <!--#mime type=text/plain encode=7bit-->

    Hi <!--#var who-->, someone sent you this attachment.

    <!--#boundary type=application/octet-stream disposition=attachment 
    encode=base64--><!--#var "afile.read()"--><!--#/mime-->

    <!--#/sendmail-->

    Mail with attachment was sent.
    <!--#var standard_html_footer-->

  Notice that there is no blank line between the 'To:' header and the
  starting #mime tag.  If a blank line is inserted between them then
  the message will not be interpreted as multipart by the recieving mailreader.

  Also notice that there is no newline between the #boundary tag and
  the #var tag, or the end of the #var tag and the closing #mime tag.
  This is important, if you break the tags up with newlines then they
  will be encoded and included in the MIME part, which is probably not
  what you're after.

  As per the MIME spec, #mime tags may be nested within #mime tags arbitrarily.
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/MIMETools/

README.txt.html

The MIMETools Product

MIMETag
__init__

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/MIMETools/MIMETag.py.html0100600000176200017510000000604507306455561026515 0ustar dhellmanndevel Module: MIMETag

Table of Contents

Module: MIMETag Zope-2-CVS-src/lib/python/Products/MIMETools/MIMETag.py

Imported modules   
from DocumentTemplate.DT_String import String
from DocumentTemplate.DT_Util import *
from MimeWriter import MimeWriter
from cStringIO import StringIO
import mimetools
import string
Classes   
MIMETag

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/MIMETools/MIMETag_MIMETag.py.html0100600000176200017510000001026407306455561027756 0ustar dhellmanndevel Class: MIMETag

Table of Contents

Class: MIMETag Zope-2-CVS-src/lib/python/Products/MIMETools/MIMETag.py

Methods   
__init__
render
  __init__  
__init__ ( self,  blocks )

Exceptions   
MIMEError, ( 'An unsupported encoding was specified in tag' )
ParseError, _tm( 'disposition and disposition_expr given', 'mime' )
ParseError, _tm( 'encode and encode_expr given', 'mime' )
ParseError, _tm( 'filename and filename_expr given', 'mime' )
ParseError, _tm( 'name and name_expr given', 'mime' )
ParseError, _tm( 'type and type_expr given', 'mime' )
  render  
render ( self,  md )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/MIMETools/__init__.py.html0100600000176200017510000000363607306455561027074 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/MIMETools/__init__.py

Imported modules   
import MIMETag

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/MIMETools/README.txt.html0100600000176200017510000001306507306455561026456 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.MIMETools

Table of Contents

Zope2 CVS with ZEO: Products.MIMETools  

The MIMETools Product

The MIMETools product is alpha quality software. It may not work as documented or at all. If you encounter bugs in MIMETools, please report your problem to support@digicool.com or discuss it on the Zope mailing list, zope@zope.org.

Currently, the MIMETools product's only function is to provide the <!--#mime--> DTML tag.

The <!--#mime--> tag is used to construct MIME containers. The syntax of the <!--#mime--> tag is:

<!--#mime [type=x, disposition=y, encode=z]-->

Contents of first part

<!--#boundary [type=x, disposition=y, encode=z]-->

Contents of second part

<!--#boundary [type=x, disposition=y, encode=z]-->

Contents of nth part

<!--#/mime-->

The area of data between tags, called a block, is encoded into whatever is specified with the encode tag attribute for that block. If no encoding is specified, base64 is defaulted. Valid encoding options include base64, quoted-printable, uuencode, x-uuencode, uue and x-uue. If the encode attribute is set to 7bit no encoding is done on the block and the data is assumed to be in a valid MIME format.

If the disposition attribute is not specified for a certain block, then the Content-Disposition: MIME header is not included in that block's MIME part.

The entire MIME container, from the opening mime tag to the closing, has it's Content-Type: MIME header set to multipart/mixed.

For example, the following DTML:

<!--#mime encode=7bit type=text/plain--> This is the first part. <!--#boundary encode=base64 type=text/plain--> This is the second. <!--#/mime-->

Is rendered to the following text:

Content-Type: multipart/mixed; boundary="216.164.72.30.501.1550.923070182.795.22531"

--216.164.72.30.501.1550.923070182.795.22531 Content-Type: text/plain Content-Transfer-Encoding: 7bit

This is the first part.

--216.164.72.30.501.1550.923070182.795.22531 Content-Type: text/plain Content-Transfer-Encoding: base64

VGhpcyBpcyB0aGUgc2Vjb25kLgo=

--216.164.72.30.501.1550.923070182.795.22531--

The #mime tag is particulary handy in conjunction with the #sendmail tag. This allows Zope to send attachments along with email. Here is an example:

  Create a DTML method called 'input' with the following code:

    &lt;!--#var standard_html_header--&gt;
    &lt;form method=post action=&quot;send&quot; ENCTYPE=&quot;multipart/form-data&quot;&gt;
    &lt;input type=file name=&quot;afile&quot;&gt;&lt;br&gt;
    Send to:&lt;input type=textbox name=&quot;who&quot;&gt;&lt;br&gt;
    &lt;input type=submit value=&quot;Send&quot;&gt;
    &lt;/form&gt;
    &lt;!--#var standard_html_footer--&gt;

  Create another DTML Method called 'send' with the following code:

    &lt;!--#var standard_html_header--&gt;
    &lt;!--#sendmail smtphost=localhost --&gt;
    From: michel@digicool.com
    To: &lt;!--#var who--&gt;
    &lt;!--#mime type=text/plain encode=7bit--&gt;

    Hi &lt;!--#var who--&gt;, someone sent you this attachment.

    &lt;!--#boundary type=application/octet-stream disposition=attachment 
    encode=base64--&gt;&lt;!--#var &quot;afile.read()&quot;--&gt;&lt;!--#/mime--&gt;

    &lt;!--#/sendmail--&gt;

    Mail with attachment was sent.
    &lt;!--#var standard_html_footer--&gt;

  Notice that there is no blank line between the 'To:' header and the
  starting #mime tag.  If a blank line is inserted between them then
  the message will not be interpreted as multipart by the recieving mailreader.

  Also notice that there is no newline between the #boundary tag and
  the #var tag, or the end of the #var tag and the closing #mime tag.
  This is important, if you break the tags up with newlines then they
  will be encoded and included in the MIME part, which is probably not
  what you're after.

  As per the MIME spec, #mime tags may be nested within #mime tags arbitrarily.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/MailHost/0040700000176200017510000000000007306455561023761 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/MailHost/index.html0100600000176200017510000000457707306455562025773 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.MailHost

Table of Contents

Zope2 CVS with ZEO: Products.MailHost  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/MailHost/

README.txt.html

MailHost

MailHost

SMTP mail objects

SendMailTag
__init__

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/MailHost/MailHost.py.html0100600000176200017510000001652107306455561027022 0ustar dhellmanndevel Module: MailHost

Table of Contents

Module: MailHost Zope-2-CVS-src/lib/python/Products/MailHost/MailHost.py

SMTP mail objects

$Id: MailHost.py,v 1.60 2001/01/11 15:03:52 chrism Exp $

Imported modules   
from AccessControl.Role import RoleManager
import Acquisition
import Globals
from Globals import Persistent, DTMLFile, HTML, MessageDialog
import OFS.SimpleItem
from cStringIO import StringIO
import mimetools
from operator import truth
import quopri
import re
import rfc822
from smtplib import SMTP
import string
import sys
import types
Functions   
_encode
extractheaders
manage_addMailHost
  _encode  
_encode ( body,  encode=None )

Exceptions   
MailHostError, 'Message already encoded'
  extractheaders  
extractheaders ( message )

  manage_addMailHost  
manage_addMailHost (
        self,
        id,
        title='',
        smtp_host=None,
        localhost='localhost',
        smtp_port=25,
        timeout=1.0,
        REQUEST=None,
        )

add a MailHost into the system

Classes   
MailBase

a mailhost...?

MailHost

persistent version

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/MailHost/MailHost_MailBase.py.html0100600000176200017510000002366507306455561030566 0ustar dhellmanndevel Class: MailBase

Table of Contents

Class: MailBase Zope-2-CVS-src/lib/python/Products/MailHost/MailHost.py

a mailhost...?

Base Classes   
Acquisition.Implicit
OFS.SimpleItem.Item
RoleManager
Methods   
__init__
_init
manage_makeChanges
scheduledSend
send
sendTemplate
simple_send
  __init__  
__init__ ( self )

nothing yet

  _init  
_init (
        self,
        smtp_host,
        smtp_port,
        )

  manage_makeChanges  
manage_makeChanges (
        self,
        title,
        smtp_host,
        smtp_port,
        REQUEST=None,
        )

make the changes

  scheduledSend  
scheduledSend (
        self,
        messageText,
        mto=None,
        mfrom=None,
        subject=None,
        encode=None,
        )

Exceptions   
MailHostError, "Message missing SMTP Header '%s'" % requiredHeader
  send  
send (
        self,
        messageText,
        mto=None,
        mfrom=None,
        subject=None,
        encode=None,
        )

Exceptions   
MailHostError, "Message missing SMTP Header '%s'" % requiredHeader
  sendTemplate  
sendTemplate (
        trueself,
        self,
        messageTemplate,
        statusTemplate=None,
        mto=None,
        mfrom=None,
        encode=None,
        REQUEST=None,
        )

render a mail template, then send it...

Exceptions   
MailHostError, "Message missing SMTP Header '%s'" % requiredHeader
  simple_send  
simple_send (
        self,
        mto,
        mfrom,
        subject,
        body,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/MailHost/MailHost_MailHost.py.html0100600000176200017510000000404007306455561030613 0ustar dhellmanndevel Class: MailHost

Table of Contents

Class: MailHost Zope-2-CVS-src/lib/python/Products/MailHost/MailHost.py

persistent version

Base Classes   
Persistent
MailBase
    Acquisition.Implicit
    OFS.SimpleItem.Item
    RoleManager

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/MailHost/SendMailTag.py.html0100600000176200017510000000611307306455561027426 0ustar dhellmanndevel Module: SendMailTag

Table of Contents

Module: SendMailTag Zope-2-CVS-src/lib/python/Products/MailHost/SendMailTag.py

Imported modules   
from DocumentTemplate.DT_String import String
from DocumentTemplate.DT_Util import parse_params
from MailHost import MailBase
from socket import gethostname
import string
Classes   
SendMailTag

the send mail tag, used like thus:

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/MailHost/SendMailTag_SendMailTag.py.html0100600000176200017510000001233207306455561031636 0ustar dhellmanndevel Class: SendMailTag

Table of Contents

Class: SendMailTag Zope-2-CVS-src/lib/python/Products/MailHost/SendMailTag.py

the send mail tag, used like thus:

<dtml-sendmail mailhost="someMailHostID"> to: person@their.machine.com from: me@mymachine.net subject: just called to say...

boy howdy! </dtml-sendmail>

Text between the sendmail and /sendmail tags is processed by the MailHost machinery and delivered. There must be at least one blank line seperating the headers (to/from/etc..) from the body of the message.

Instead of specifying a MailHost, an smtphost may be specified ala smtphost="mail.mycompany.com" port=25 (port defaults to 25 automatically). Other parameters are

  • mailto -- person (or comma-seperated list of persons) to send the mail to. If not specified, there must be a to: header in the message.

  • mailfrom -- person sending the mail (basically who the recipient can reply to). If not specified, there must be a from: header in the message.

  • subject -- optional subject. If not specified, there must be a subject: header in the message.

  • encode -- optional encoding. Possible values are: base64, quoted-printable and uuencode.

Methods   
__init__
render
  __init__  
__init__ ( self,  blocks )

Exceptions   
MailHostError, 'No mailhost was specified in tag'
MailHostError, ( 'An unsupported encoding was specified in tag' )
  render  
render ( self,  md )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/MailHost/__init__.py.html0100600000176200017510000000632007306455561027035 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/MailHost/__init__.py

Imported modules   
import MailHost
import SendMailTag
Functions   
initialize
  initialize  
initialize ( context )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/MailHost/README.txt.html0100600000176200017510000000261507306455561026425 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.MailHost

Table of Contents

Zope2 CVS with ZEO: Products.MailHost  

MailHost

The MailHost product provides support for sending email from within the Zope environment using MailHost objects.

Email can optionally be encoded using Base64, Quoted-Printable or UUEncode encoding.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/0040700000176200017510000000000007306455563023012 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/index.html0100600000176200017510000001055007306455563025007 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.OFSP

Table of Contents

Zope2 CVS with ZEO: Products.OFSP  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/OFSP/

README.txt.html

OFSP

Draft
Session

Backward compatability!

Version

Version object

__init__

Zope-2-CVS-src/lib/python/Products/OFSP/help/

AuthenticatedUser
DTMLDocument
DTMLMethod
DateTime
File
Folder
Image
ObjectManager
ObjectManagerItem
PropertyManager
PropertySheet
PropertySheets
Request
Response

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/0040700000176200017510000000000007306455563023742 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/AuthenticatedUser.py.html0100600000176200017510000000416707306455562030706 0ustar dhellmanndevel Module: AuthenticatedUser

Table of Contents

Module: AuthenticatedUser Zope-2-CVS-src/lib/python/Products/OFSP/help/AuthenticatedUser.py

Classes   
AuthenticatedUser

This interface needs to be supported by objects that

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/AuthenticatedUser_AuthenticatedUser.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/AuthenticatedUser_AuthenticatedUser0100600000176200017510000001376107306455562033015 0ustar dhellmanndevel Class: AuthenticatedUser

Table of Contents

Class: AuthenticatedUser Zope-2-CVS-src/lib/python/Products/OFSP/help/AuthenticatedUser.py

This interface needs to be supported by objects that are returned by user validation and used for access control.

Methods   
getDatabasePath
getId
getRoles
getUserName
hasRole
  getDatabasePath  
getDatabasePath ()

Get a physical path to the user's UserDatabase. A Traversal facility can be used to get the user database from the path returned by this method.

Permission

Python only

  getId  
getId ()

Get the ID of the user. The ID can be used, at least from Python, to get the user from the user's UserDatabase.

Permission

Python only

  getRoles  
getRoles ( object )

Returns a list of the roles the user has on the given object (in the current context?)

Permission

Always available

  getUserName  
getUserName ()

Return the name of a user

Permission

Always available

  hasRole  
hasRole ( object,  roles )

Return a value that is true if the user has the given roles on the given object and return false otherwise.

Permission

Always available

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/DTMLDocument.py.html0100600000176200017510000000661107306455562027520 0ustar dhellmanndevel Module: DTMLDocument

Table of Contents

Module: DTMLDocument Zope-2-CVS-src/lib/python/Products/OFSP/help/DTMLDocument.py

Functions   
manage_addDocument
  manage_addDocument  
manage_addDocument ( id,  title )

Add a DTML Document to the current ObjectManager

Classes   
DTMLDocument

A DTML Document is a Zope object that contains and executes DTML

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/DTMLDocument_DTMLDocument.py.html0100600000176200017510000002057707306455562032046 0ustar dhellmanndevel Class: DTMLDocument

Table of Contents

Class: DTMLDocument Zope-2-CVS-src/lib/python/Products/OFSP/help/DTMLDocument.py

A DTML Document is a Zope object that contains and executes DTML code. It is useful to represent web pages.

Methods   
__call__
document_src
get_size
manage_edit
  __call__  
__call__ (
        client=None,
        REQUEST={},
        RESPONSE=None,
        **kw,
        )

Calling a DTMLDocument causes the Document to interpret the DTML code that it contains. The method returns the result of the interpretation, which can be any kind of object.

To accomplish its task, DTML Document often needs to resolve various names into objects. For example, when the code &lt;dtml-var spam&gt; is executed, the DTML engine tries to resolve the name spam.

In order to resolve names, the Document must be passed a namespace to look them up in. This can be done several ways:

  • By passing a client object -- If the argument client is passed, then names are looked up as attributes on the argument.

  • By passing a REQUEST mapping -- If the argument REQUEST is passed, then names are looked up as items on the argument. If the object is not a mapping, an TypeError will be raised when a name lookup is attempted.

  • By passing keyword arguments -- names and their values can be passed as keyword arguments to the Document.

The namespace given to a DTML Document is the composite of these three methods. You can pass any number of them or none at all. Names are looked up first in the keyword arguments, then in the client, and finally in the mapping.

A DTMLDocument implicitly pass itself as a client argument in addition to the specified client, so names are looked up in the DTMLDocument itself.

Passing in a namespace to a DTML Document is often referred to as providing the Document with a context.

DTML Documents can be called three ways.

From DTML

A DTML Document can be called from another DTML Method or Document:

            &lt;dtml-var standard_html_header&gt;
              &lt;dtml-var aDTMLDocument&gt;
            &lt;dtml-var standard_html_footer&gt;

In this example, the Document aDTMLDocument is being called from another DTML object by name. The calling method passes the value this as the client argument and the current DTML namespace as the REQUEST argument. The above is identical to this following usage in a DTML Python expression:

            &lt;dtml-var standard_html_header&gt;
              &lt;dtml-var &quot;aDTMLDocument(_.None, _)&quot;&gt;
            &lt;dtml-var standard_html_footer&gt;

From Python

Products, External Methods, and Scripts can call a DTML Document in the same way as calling a DTML Document from a Python expression in DTML; as shown in the previous example.

By the Publisher

When the URL of a DTML Document is fetched from Zope, the DTML Document is called by the publisher. The REQUEST object is passed as the second argument to the Document.

Permission

View

  document_src  
document_src ()

Returns the unrendered source text of the DTML Document.

Permission

View management screens

  get_size  
get_size ()

Returns the size of the unrendered source text of the DTML Document in bytes.

Permission

View

  manage_edit  
manage_edit ( data,  title )

Change the DTML Document, replacing its contents with data and changing its title.

The data argument may be a file object or a string.

Permission

Change DTML Documents

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/DTMLMethod.py.html0100600000176200017510000000660307306455562027163 0ustar dhellmanndevel Module: DTMLMethod

Table of Contents

Module: DTMLMethod Zope-2-CVS-src/lib/python/Products/OFSP/help/DTMLMethod.py

Functions   
manage_addDTMLMethod
  manage_addDTMLMethod  
manage_addDTMLMethod ( id,  title )

Add a DTML Method to the current ObjectManager

Classes   
DTMLMethod

A DTML Method is a Zope object that contains and executes DTML

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/DTMLMethod_DTMLMethod.py.html0100600000176200017510000002100607306455562031136 0ustar dhellmanndevel Class: DTMLMethod

Table of Contents

Class: DTMLMethod Zope-2-CVS-src/lib/python/Products/OFSP/help/DTMLMethod.py

A DTML Method is a Zope object that contains and executes DTML code. It can act as a template to display other objects. It can also hold small pieces of content which are inserted into other DTML Documents or DTML Methods.

The DTML Method's id is available via the document_id variable and the title is available via the document_title variable.

Methods   
__call__
document_src
get_size
manage_edit
  __call__  
__call__ (
        client=None,
        REQUEST={},
        **kw,
        )

Calling a DTMLMethod causes the Method to interpret the DTML code that it contains. The method returns the result of the interpretation, which can be any kind of object.

To accomplish its task, DTML Method often needs to resolve various names into objects. For example, when the code &lt;dtml-var spam&gt; is executed, the DTML engine tries to resolve the name spam.

In order to resolve names, the Method must be passed a namespace to look them up in. This can be done several ways:

  • By passing a client object -- If the argument client is passed, then names are looked up as attributes on the argument.

  • By passing a REQUEST mapping -- If the argument REQUEST is passed, then names are looked up as items on the argument. If the object is not a mapping, an TypeError will be raised when a name lookup is attempted.

  • By passing keyword arguments -- names and their values can be passed as keyword arguments to the Method.

The namespace given to a DTML Method is the composite of these three methods. You can pass any number of them or none at all. Names will be looked up first in the keyword argument, next in the client and finally in the mapping.

Unlike DTMLDocuments, DTMLMethods do not look up names in their own instance dictionary.

Passing in a namespace to a DTML Method is often referred to as providing the Method with a context.

DTML Methods can be called three ways:

From DTML

A DTML Method can be called from another DTML Method or Document:

            &lt;dtml-var standard_html_header&gt;
              &lt;dtml-var aDTMLMethod&gt;
            &lt;dtml-var standard_html_footer&gt;

In this example, the Method aDTMLMethod is being called from another DTML object by name. The calling method passes the value this as the client argument and the current DTML namespace as the REQUEST argument. The above is identical to this following usage in a DTML Python expression:

            &lt;dtml-var standard_html_header&gt;
              &lt;dtml-var &quot;aDTMLMethod(_.None, _)&quot;&gt;
            &lt;dtml-var standard_html_footer&gt;

From Python

Products, External Methods, and Scripts can call a DTML Method in the same way as calling a DTML Method from a Python expression in DTML; as shown in the previous example.

By the Publisher

When the URL of a DTML Method is fetched from Zope, the DTML Method is called by the publisher. The REQUEST object is passed as the second argument to the Method.

Permission

View

  document_src  
document_src ()

Returns the unrendered source text of the DTML Method.

Permission

View management screens

  get_size  
get_size ()

Returns the size of the unrendered source text of the DTML Method in bytes.

Permission

View

  manage_edit  
manage_edit ( data,  title )

Change the DTML Method, replacing its contents with data and changing its title.

The data argument may be a file object or a string.

Permission

Change DTML Methods

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/DateTime.py.html0100600000176200017510000000411507306455562026752 0ustar dhellmanndevel Module: DateTime

Table of Contents

Module: DateTime Zope-2-CVS-src/lib/python/Products/OFSP/help/DateTime.py

Classes   
DateTime

The DateTime object provides an interface for working with dates

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/DateTime_DateTime.py.html0100600000176200017510000017277107306455562030544 0ustar dhellmanndevel Class: DateTime

Table of Contents

Class: DateTime Zope-2-CVS-src/lib/python/Products/OFSP/help/DateTime.py

The DateTime object provides an interface for working with dates and times in various formats. DateTime also provides methods for calendar operations, date and time arithmetic and formatting.

DateTime objects represent instants in time and provide interfaces for controlling its representation without affecting the absolute value of the object.

DateTime objects may be created from a wide variety of string or numeric data, or may be computed from other DateTime objects. DateTimes support the ability to convert their representations to many major timezones, as well as the ability to create a DateTime object in the context of a given timezone.

DateTime objects provide partial numerical behavior:

  • Two date-time objects can be subtracted to obtain a time, in days between the two.

  • A date-time object and a positive or negative number may be added to obtain a new date-time object that is the given number of days later than the input date-time object.

  • A positive or negative number and a date-time object may be added to obtain a new date-time object that is the given number of days later than the input date-time object.

  • A positive or negative number may be subtracted from a date-time object to obtain a new date-time object that is the given number of days earlier than the input date-time object.

DateTime objects may be converted to integer, long, or float numbers of days since January 1, 1901, using the standard int, long, and float functions (Compatibility Note: int, long and float return the number of days since 1901 in GMT rather than local machine timezone). DateTime objects also provide access to their value in a float format usable with the python time module, provided that the value of the object falls in the range of the epoch-based time module.

A DateTime object should be considered immutable; all conversion and numeric operations return a new DateTime object rather than modify the current object.

A DateTime object always maintains its value as an absolute UTC time, and is represented in the context of some timezone based on the arguments used to create the object. A DateTime object's methods return values based on the timezone context.

Note that in all cases the local machine timezone is used for representation if no timezone is specified.

DateTimes may be created with from zero to seven arguments.

  • If the function is called with no arguments, then the current date/time is returned, represented in the timezone of the local machine.

  • If the function is invoked with a single string argument which is a recognized timezone name, an object representing the current time is returned, represented in the specified timezone.

  • If the function is invoked with a single string argument representing a valid date/time, an object representing that date/time will be returned.

    As a general rule, any date-time representation that is recognized and unambiguous to a resident of North America is acceptable.(The reason for this qualification is that in North America, a date like: 2/1/1994 is interpreted as February 1, 1994, while in some parts of the world, it is interpreted as January 2, 1994.) A date/time string consists of two components, a date component and an optional time component, separated by one or more spaces. If the time component is omitted, 12:00am is assumed. Any recognized timezone name specified as the final element of the date/time string will be used for computing the date/time value. (If you create a DateTime with the string Mar 9, 1997 1:45pm US/Pacific, the value will essentially be the same as if you had captured time.time() at the specified date and time on a machine in that timezone):

              e=DateTime(&quot;US/Eastern&quot;)
          # returns current date/time, represented in US/Eastern.

          x=DateTime(&quot;1997/3/9 1:45pm&quot;)
          # returns specified time, represented in local machine zone.

          y=DateTime(&quot;Mar 9, 1997 13:45:00&quot;)
          # y is equal to x

    The date component consists of year, month, and day values. The year value must be a one-, two-, or four-digit integer. If a one- or two-digit year is used, the year is assumed to be in the twentieth century. The month may be an integer, from 1 to 12, a month name, or a month abbreviation, where a period may optionally follow the abbreviation. The day must be an integer from 1 to the number of days in the month. The year, month, and day values may be separated by periods, hyphens, forward slashes, or spaces. Extra spaces are permitted around the delimiters. Year, month, and day values may be given in any order as long as it is possible to distinguish the components. If all three components are numbers that are less than 13, then a month-day-year ordering is assumed.

    The time component consists of hour, minute, and second values separated by colons. The hour value must be an integer between 0 and 23 inclusively. The minute value must be an integer between 0 and 59 inclusively. The second value may be an integer value between 0 and 59.999 inclusively. The second value or both the minute and second values may be omitted. The time may be followed by am or pm in upper or lower case, in which case a 12-hour clock is assumed.

  • If the DateTime function is invoked with a single Numeric argument, the number is assumed to be a floating point value such as that returned by time.time().

    A DateTime object is returned that represents the gmt value of the time.time() float represented in the local machine's timezone.

  • If the function is invoked with two numeric arguments, then the first is taken to be an integer year and the second argument is taken to be an offset in days from the beginning of the year, in the context of the local machine timezone. The date-time value returned is the given offset number of days from the beginning of the given year, represented in the timezone of the local machine. The offset may be positive or negative. Two-digit years are assumed to be in the twentieth century.

  • If the function is invoked with two arguments, the first a float representing a number of seconds past the epoch in gmt (such as those returned by time.time()) and the second a string naming a recognized timezone, a DateTime with a value of that gmt time will be returned, represented in the given timezone.::

              import time
          t=time.time()

          now_east=DateTime(t,'US/Eastern')
          # Time t represented as US/Eastern

          now_west=DateTime(t,'US/Pacific')
          # Time t represented as US/Pacific

          # now_east == now_west
          # only their representations are different

  • If the function is invoked with three or more numeric arguments, then the first is taken to be an integer year, the second is taken to be an integer month, and the third is taken to be an integer day. If the combination of values is not valid, then a DateTimeError is raised. Two-digit years are assumed to be in the twentieth century. The fourth, fifth, and sixth arguments specify a time in hours, minutes, and seconds; hours and minutes should be positive integers and seconds is a positive floating point value, all of these default to zero if not given. An optional string may be given as the final argument to indicate timezone (the effect of this is as if you had taken the value of time.time() at that time on a machine in the specified timezone).

If a string argument passed to the DateTime constructor cannot be parsed, it will raise DateTime.SyntaxError. Invalid date, time, or timezone components will raise a DateTime.DateTimeError.

The module function Timezones() will return a list of the timezones recognized by the DateTime module. Recognition of timezone names is case-insensitive.

Methods   
AMPM
AMPMMinutes
Date
Day
DayOfWeek
Day_
HTML4
ISO
Mon
Mon_
Month
PreciseAMPM
PreciseTime
Time
TimeMinutes
aCommon
aCommonZ
aDay
aMonth
ampm
day
 dayOfYear
dd
dow
dow_1
earliestTime
equalTo
fCommon
fCommonZ
greaterThan
greaterThanEqualTo
h_12
h_24
hour
isCurrentDay
isCurrentHour
isCurrentMinute
isCurrentMonth
isCurrentYear
isFuture
isLeapYear
isPast
 latestTime
lessThan
lessThanEqualTo
millis
minute
mm
month
notEqualTo
pCommon
pCommonZ
pDay
pMonth
parts
rfc822
second
strftime
timeTime
timezone
toZone
year
yy
  AMPM  
AMPM ()

Return the time string for an object to the nearest second.

Permission

Always available

  AMPMMinutes  
AMPMMinutes ()

Return the time string for an object not showing seconds.

Permission

Always available

  Date  
Date ()

Return the date string for the object.

Permission

Always available

General formats from previous DateTime

  Day  
Day ()

Return the full name of the day of the week

Permission

Always available

  DayOfWeek  
DayOfWeek ()

Compatibility: see Day

Permission

Always available

  Day_  
Day_ ()

Compatibility: see pDay

Permission

Always available

  HTML4  
HTML4 ()

Return the object in the format used in the HTML4.0 specification, one of the standard forms in ISO8601.

See HTML 4.0 Specification

Dates are output as: YYYY-MM-DDTHH:MM:SSZ T, Z are literal characters. The time is in UTC.

Permission

Always available

  ISO  
ISO ()

Return the object in ISO standard format

Dates are output as: YYYY-MM-DD HH:MM:SS

Permission

Always available

  Mon  
Mon ()

Compatibility: see aMonth

Permission

Always available

  Mon_  
Mon_ ()

Compatibility: see pMonth

Permission

Always available

  Month  
Month ()

Return the full month name

Permission

Always available

  PreciseAMPM  
PreciseAMPM ()

Return the time string for the object.

Permission

Always available

  PreciseTime  
PreciseTime ()

Return the time string for the object.

Permission

Always available

  Time  
Time ()

Return the time string for an object to the nearest second.

Permission

Always available

  TimeMinutes  
TimeMinutes ()

Return the time string for an object not showing seconds.

Permission

Always available

  aCommon  
aCommon ()

Return a string representing the object's value in the format: Mar 1, 1997 1:45 pm

Permission

Always available

  aCommonZ  
aCommonZ ()

Return a string representing the object's value in the format: Mar 1, 1997 1:45 pm US/Eastern

Permission

Always available

  aDay  
aDay ()

Return the abbreviated name of the day of the week

Permission

Always available

  aMonth  
aMonth ()

Return the abbreviated month name.

Permission

Always available

  ampm  
ampm ()

Return the appropriate time modifier (am or pm)

Permission

Always available

  day  
day ()

Return the integer day

Permission

Always available

  dayOfYear  
dayOfYear ()

Return the day of the year, in context of the timezone representation of the object

Permission

Always available

  dd  
dd ()

Return day as a 2 digit string

Permission

Always available

  dow  
dow ()

Return the integer day of the week, where Sunday is 0

Permission

Always available

  dow_1  
dow_1 ()

Return the integer day of the week, where Sunday is 1

Permission

Always available

  earliestTime  
earliestTime ()

Return a new DateTime object that represents the earliest possible time (in whole seconds) that still falls within the current object's day, in the object's timezone context

Permission

Always available

  equalTo  
equalTo ( t )

Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time equal to the specified DateTime or time module style time. Revised to give more correct results through comparison of long integer milliseconds.

Permission

Always available

  fCommon  
fCommon ()

Return a string representing the object's value in the format: March 1, 1997 1:45 pm

Permission

Always available

New formats

  fCommonZ  
fCommonZ ()

Return a string representing the object's value in the format: March 1, 1997 1:45 pm US/Eastern

Permission

Always available

  greaterThan  
greaterThan ( t )

Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time greater than the specified DateTime or time module style time. Revised to give more correct results through comparison of long integer milliseconds.

Permission

Always available

  greaterThanEqualTo  
greaterThanEqualTo ( t )

Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time greater than or equal to the specified DateTime or time module style time. Revised to give more correct results through comparison of long integer milliseconds.

Permission

Always available

  h_12  
h_12 ()

Return the 12-hour clock representation of the hour

Permission

Always available

  h_24  
h_24 ()

Return the 24-hour clock representation of the hour

Permission

Always available

  hour  
hour ()

Return the 24-hour clock representation of the hour

Permission

Always available

  isCurrentDay  
isCurrentDay ()

Return true if this object represents a date/time that falls within the current day, in the context of this object's timezone representation

Permission

Always available

  isCurrentHour  
isCurrentHour ()

Return true if this object represents a date/time that falls within the current hour, in the context of this object's timezone representation

Permission

Always available

  isCurrentMinute  
isCurrentMinute ()

Return true if this object represents a date/time that falls within the current minute, in the context of this object's timezone representation

Permission

Always available

  isCurrentMonth  
isCurrentMonth ()

Return true if this object represents a date/time that falls within the current month, in the context of this object's timezone representation

Permission

Always available

  isCurrentYear  
isCurrentYear ()

Return true if this object represents a date/time that falls within the current year, in the context of this object's timezone representation

Permission

Always available

  isFuture  
isFuture ()

Return true if this object represents a date/time later than the time of the call

Permission

Always available

  isLeapYear  
isLeapYear ()

Return true if the current year (in the context of the object's timezone) is a leap year

Permission

Always available

  isPast  
isPast ()

Return true if this object represents a date/time earlier than the time of the call

Permission

Always available

  latestTime  
latestTime ()

Return a new DateTime object that represents the latest possible time (in whole seconds) that still falls within the current object's day, in the object's timezone context

Permission

Always available

  lessThan  
lessThan ( t )

Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time less than the specified DateTime or time module style time. Revised to give more correct results through comparison of long integer milliseconds.

Permission

Always available

  lessThanEqualTo  
lessThanEqualTo ( t )

Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time less than or equal to the specified DateTime or time module style time. Revised to give more correct results through comparison of long integer milliseconds.

Permission

Always available

  millis  
millis ()

Return the millisecond since the epoch in GMT.

Permission

Always available

  minute  
minute ()

Return the minute

Permission

Always available

  mm  
mm ()

Return month as a 2 digit string

Permission

Always available

  month  
month ()

Return the month of the object as an integer

Permission

Always available

  notEqualTo  
notEqualTo ( t )

Compare this DateTime object to another DateTime object OR a floating point number such as that which is returned by the python time module. Returns true if the object represents a date/time not equal to the specified DateTime or time module style time. Revised to give more correct results through comparison of long integer milliseconds.

Permission

Always available

  pCommon  
pCommon ()

Return a string representing the object's value in the format: Mar. 1, 1997 1:45 pm

Permission

Always available

  pCommonZ  
pCommonZ ()

Return a string representing the object's value in the format: Mar. 1, 1997 1:45 pm US/Eastern

Permission

Always available

  pDay  
pDay ()

Return the abbreviated (with period) name of the day of the week

Permission

Always available

  pMonth  
pMonth ()

Return the abbreviated (with period) month name.

Permission

Always available

  parts  
parts ()

Return a tuple containing the calendar year, month, day, hour, minute second and timezone of the object

Permission

Always available

Component access

  rfc822  
rfc822 ()

Return the date in RFC 822 format

Permission

Always available

  second  
second ()

Return the second

Permission

Always available

  strftime  
strftime ( format )

Return date time string formatted according to format

See Python's time.strftime function.

  timeTime  
timeTime ()

Return the date/time as a floating-point number in UTC, in the format used by the python time module. Note that it is possible to create date/time values with DateTime that have no meaningful value to the time module.

Permission

Always available

  timezone  
timezone ()

Return the timezone in which the object is represented.

Permission

Always available

  toZone  
toZone ( z )

Return a DateTime with the value as the current object, represented in the indicated timezone.

Permission

Always available

  year  
year ()

Return the calendar year of the object

Permission

Always available

  yy  
yy ()

Return calendar year as a 2 digit string

Permission

Always available

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/File.py.html0100600000176200017510000000675207306455562026146 0ustar dhellmanndevel Module: File

Table of Contents

Module: File Zope-2-CVS-src/lib/python/Products/OFSP/help/File.py

Functions   
manage_addFile
  manage_addFile  
manage_addFile (
        id,
        file='',
        title='',
        precondition='',
        content_type='',
        )

Add a new File object.

Creates a new File object id with the contents of file

Classes   
File

A File is a Zope object that contains file content. A File object

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/File_File.py.html0100600000176200017510000001341707306455562027101 0ustar dhellmanndevel Class: File

Table of Contents

Class: File Zope-2-CVS-src/lib/python/Products/OFSP/help/File.py

A File is a Zope object that contains file content. A File object can be used to upload or download file information with Zope.

Using a File object in Zope is easy. The most common usage is to display the contents of a file object in a web page. This is done by simply referencing the object from DTML:

      &lt;dtml-var standard_html_header&gt;
        &lt;dtml-var FileObject&gt;
      &lt;dtml-var standard_html_footer&gt;

A more complex example is presenting the File object for download by the user. The next example displays a link to every File object in a folder for the user to download:

      &lt;dtml-var standard_html_header&gt;
      &lt;ul&gt;
        &lt;dtml-in &quot;ObjectValues('File')&quot;&gt;
          &lt;li&gt;&lt;a href=&quot;&lt;dtml-var absolute_url&gt;&quot;&gt;&lt;dtml-var
          id&gt;&lt;/a&gt;&lt;/li&gt;
        &lt;/dtml-in&gt;
      &lt;/ul&gt;
      &lt;dtml-var standard_html_footer&gt;

In this example, the absolute_url method and id are used to create a list of HTML hyperlinks to all of the File objects in the current Object Manager.

Also see ObjectManager for details on the objectValues method.

Methods   
getContentType
getSize
update_data
  getContentType  
getContentType ()

Returns the content type of the file.

Permission

View

  getSize  
getSize ()

Returns the size of the file in bytes.

Permission

View

  update_data  
update_data (
        data,
        content_type=None,
        size=None,
        )

Updates the contents of the File with data.

The data argument must be a string. If content_type is not provided, then a content type will not be set. If size is not provided, the size of the file will be computed from data.

Permission

Python only

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/Folder.py.html0100600000176200017510000000662007306455562026474 0ustar dhellmanndevel Module: Folder

Table of Contents

Module: Folder Zope-2-CVS-src/lib/python/Products/OFSP/help/Folder.py

Functions   
manage_addFolder
  manage_addFolder  
manage_addFolder ( id,  title )

Add a Folder to the current ObjectManager

Permission

Add Folders

Classes   
Folder

A Folder is a generic container object in Zope.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/Folder_Folder.py.html0100600000176200017510000000256707306455562027775 0ustar dhellmanndevel Class: Folder

Table of Contents

Class: Folder Zope-2-CVS-src/lib/python/Products/OFSP/help/Folder.py

A Folder is a generic container object in Zope.

Folders are the most common ObjectManager subclass in Zope.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/Image.py.html0100600000176200017510000000676307306455563026314 0ustar dhellmanndevel Module: Image

Table of Contents

Module: Image Zope-2-CVS-src/lib/python/Products/OFSP/help/Image.py

Functions   
manage_addImage
  manage_addImage  
manage_addImage (
        id,
        file,
        title='',
        precondition='',
        content_type='',
        )

Add a new Image object.

Creates a new Image object id with the contents of file.

Classes   
Image

An Image is a Zope object that contains image content. An Image

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/Image_Image.py.html0100600000176200017510000001160507306455563027405 0ustar dhellmanndevel Class: Image

Table of Contents

Class: Image Zope-2-CVS-src/lib/python/Products/OFSP/help/Image.py

An Image is a Zope object that contains image content. An Image object can be used to upload or download image information with Zope.

Image objects have two properties the define their dimension, height and width. These are calculated when the image is uploaded. For image types that Zope does not understand, these properties may be undefined.

Using a Image object in Zope is easy. The most common usage is to display the contents of an image object in a web page. This is done by simply referencing the object from DTML:

      &lt;dtml-var standard_html_header&gt;
        &lt;dtml-var ImageObject&gt;
      &lt;dtml-var standard_html_footer&gt;

This will generate an HTML IMG tag referencing the URL to the Image. This is equivalent to:

      &lt;dtml-var standard_html_header&gt;
        &lt;dtml-with ImageObject&gt;
          &lt;img src=&quot;&lt;dtml-var absolute_url&gt;&quot;&gt;
        &lt;/dtml-with&gt;
      &lt;dtml-var standard_html_footer&gt;

You can control the image display more precisely with the tag method. For example:

      &lt;dtml-var &quot;ImageObject.tag(border=5, align=left)&quot;&gt;
Methods   
tag
  tag  
tag (
        height=None,
        width=None,
        alt=None,
        scale=0,
        xscale=0,
        yscale=0,
        **args,
        )

This method returns a string which contains an HTML IMG tag reference to the image.

Optionally, the height, width, alt, scale, xscale and yscale arguments can be provided which are turned into HTML IMG tag attributes. Note, height and width are provided by default, and alt comes from the title_or_id method.

Keyword arguments may be provided to support other or future IMG tag attributes. The one exception to this is the HTML Cascading Style Sheet tag class. Because the word class is a reserved keyword in Python, you must instead use the keyword argument css_class. This will be turned into a class HTML tag attribute on the rendered img tag.

Permission

View

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/ObjectManager.py.html0100600000176200017510000000414607306455563027764 0ustar dhellmanndevel Module: ObjectManager

Table of Contents

Module: ObjectManager Zope-2-CVS-src/lib/python/Products/OFSP/help/ObjectManager.py

Classes   
ObjectManager

An ObjectManager contains other Zope objects. The contained

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/ObjectManager_ObjectManager.py.html0100600000176200017510000001767707306455563032562 0ustar dhellmanndevel Class: ObjectManager

Table of Contents

Class: ObjectManager Zope-2-CVS-src/lib/python/Products/OFSP/help/ObjectManager.py

An ObjectManager contains other Zope objects. The contained objects are Object Manager Items.

To create an object inside an object manager use manage_addProduct:

      self.manage_addProduct['OFSP'].manage_addFolder(id, title)

In DTML this would be:

        &lt;dtml-call &quot;manage_addProduct['OFSP'].manage_addFolder(id, title)&quot;&gt;

These examples create a new Folder inside the current ObjectManager.

manage_addProduct is a mapping that provides access to product constructor methods. It is indexed by product id.

Constructor methods are registered during product initialization and should be documented in the API docs for each addable object.

Methods   
objectIds
objectItems
objectValues
superValues
  objectIds  
objectIds ( type=None )

This method returns a list of the ids of the contained objects.

Optionally, you can pass an argument specifying what object meta_type(es) to restrict the results to. This argument can be a string specifying one meta_type, or it can be a list of strings to specify many.

Example:

          &lt;dtml-in objectIds&gt;
            &lt;dtml-var sequence-item&gt;
          &lt;dtml-else&gt;
            There are no sub-objects.
          &lt;/dtml-in&gt;

This DTML code will display all the ids of the objects contained in the current Object Manager.

Permission

Access contents information

  objectItems  
objectItems ( type=None )

This method returns a sequence of (id, object) tuples.

Like objectValues and objectIds, it accepts one argument, either a string or a list to restrict the results to objects of a given meta_type or set of meta_types.

Each tuple's first element is the id of an object contained in the Object Manager, and the second element is the object itself.

Example:

          &lt;dtml-in objectItems&gt;
           id: &lt;dtml-var sequence-key&gt;,
           type: &lt;dtml-var meta_type&gt;
          &lt;dtml-else&gt;
            There are no sub-objects.
          &lt;/dtml-in&gt;
Permission

Access contents information

  objectValues  
objectValues ( type=None )

This method returns a sequence of contained objects.

Like objectItems and objectIds, it accepts one argument, either a string or a list to restrict the results to objects of a given meta_type or set of meta_types.

Example:

          &lt;dtml-in expr=&quot;objectValues('Folder')&quot;&gt;
            &lt;dtml-var icon&gt;
            This is the icon for the: &lt;dtml-var id&gt; Folder&lt;br&gt;.
          &lt;dtml-else&gt;
            There are no Folders.
          &lt;/dtml-in&gt;

The results were restricted to Folders by passing a meta_type to objectValues method.

Permission

Access contents information

  superValues  
superValues ( type )

This method returns a list of objects of a given meta_type(es) contained in the Object Manager and all its parent Object Managers.

The type argument specifies the meta_type(es). It can be a string specifying one meta_type, or it can be a list of strings to specify many.

Permission

Python only

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/ObjectManagerItem.py.html0100600000176200017510000000420007306455563030572 0ustar dhellmanndevel Module: ObjectManagerItem

Table of Contents

Module: ObjectManagerItem Zope-2-CVS-src/lib/python/Products/OFSP/help/ObjectManagerItem.py

Classes   
ObjectManagerItem

A Zope object that can be contained within an Object Manager.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/ObjectManagerItem_ObjectManagerItem.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/ObjectManagerItem_ObjectManagerItem0100600000176200017510000003053307306455563032610 0ustar dhellmanndevel Class: ObjectManagerItem

Table of Contents

Class: ObjectManagerItem Zope-2-CVS-src/lib/python/Products/OFSP/help/ObjectManagerItem.py

A Zope object that can be contained within an Object Manager. Almost all Zope objects that can be managed through the web are Object Manager Items.

ObjectMangerItems have these instance attributes:

title

The title of the object.

This is an optional one-line string description of the object.

meta_type

A short name for the type of the object.

This is the name that shows up in product add list for the object and is used when filtering objects by type.

This attribute is provided by the object's class and should not be changed directly.

REQUEST

The current web request.

This object is acquired and should not be set.

Methods   
absolute_url
getId
getPhysicalPath
getPhysicalRoot
manage_workspace
restrictedTraverse
this
title_and_id
title_or_id
unrestrictedTraverse
  absolute_url  
absolute_url ( relative=None )

Return the absolute url to the object.

If the relative argument is provided with a true value, then the URL returned is relative to the site object. Note, if virtual hosts are being used, then the path returned is a logical, rather than a physical path.

Permission

Always available

  getId  
getId ()

Returns the object's id.

The id is the unique name of the object within its parent object manager. This should be a string, and can contain letters, digits, underscores, dashes, commas, and spaces.

This method replaces direct access to the id attribute.

Permission

Always available

  getPhysicalPath  
getPhysicalPath ()

Get the path of an object from the root, ignoring virtual hosts.

Permission

Always available

  getPhysicalRoot  
getPhysicalRoot ()

Returns the top-level Zope Application object.

Permission

Python only

  manage_workspace  
manage_workspace ()

This is the web method that is called when a user selects an item in a object manager contents view or in the Zope Management navigation view.

Permission

View management screens

  restrictedTraverse  
restrictedTraverse ( path,  default=None )

Return the object obtained by traversing the given path from the object on which the method was called, performing security checks along the way.

If an object is not found then the default argument will be returned.

Permission

Always available

  this  
this ()

Return the object.

This turns out to be handy in two situations. First, it provides a way to refer to an object in DTML expressions.

The second use for this is rather deep. It provides a way to acquire an object without getting the full context that it was acquired from. This is useful, for example, in cases where you are in a method of a non-item subobject of an item and you need to get the item outside of the context of the subobject.

Permission

Always available

  title_and_id  
title_and_id ()

If the title is not blank, the return the title followed by the id in parentheses. Otherwise return the id.

Permission

Always available

  title_or_id  
title_or_id ()

If the title is not blank, return it, otherwise return the id.

Permission

Always available

  unrestrictedTraverse  
unrestrictedTraverse ( path,  default=None )

Return the object obtained by traversing the given path from the object on which the method was called. This method begins with "unrestricted" because (almost) no security checks are performed.

If an object is not found then the default argument will be returned.

Permission

Python only

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/PropertyManager.py.html0100600000176200017510000000416507306455563030403 0ustar dhellmanndevel Module: PropertyManager

Table of Contents

Module: PropertyManager Zope-2-CVS-src/lib/python/Products/OFSP/help/PropertyManager.py

Classes   
PropertyManager

A Property Manager object has a collection of typed attributes

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/PropertyManager_PropertyManager.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/PropertyManager_PropertyManager.py.0100600000176200017510000001762407306455563032721 0ustar dhellmanndevel Class: PropertyManager

Table of Contents

Class: PropertyManager Zope-2-CVS-src/lib/python/Products/OFSP/help/PropertyManager.py

A Property Manager object has a collection of typed attributes called properties. Properties can be managed through the web or via DTML.

In addition to having a type, properties can be writable or read-only and can have default values.

Methods   
getProperty
getPropertyType
hasProperty
propertyIds
propertyItems
propertyMap
propertyValues
  getProperty  
getProperty ( id,  d=None )

Return the value of the property id. If the property is not found the optional second argument or None is returned.

Permission

Access contents information

  getPropertyType  
getPropertyType ( id )

Get the type of property id. Returns None if no such property exists.

Permission

Access contents information

  hasProperty  
hasProperty ( id )

Returns a true value if the Property Manager has the property id. Otherwise returns a false value.

Permission

Access contents information

  propertyIds  
propertyIds ()

Returns a list of property ids.

Permission

Access contents information

  propertyItems  
propertyItems ()

Return a list of (id, property) tuples.

Permission

Access contents information

  propertyMap  
propertyMap ()

Returns a tuple of mappings, giving meta-data for properties. The meta-data includes id, type, and mode.

Permission

Access contents information

  propertyValues  
propertyValues ()

Returns a list of property values.

Permission

Access contents information

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/PropertySheet.py.html0100600000176200017510000000414707306455563030101 0ustar dhellmanndevel Module: PropertySheet

Table of Contents

Module: PropertySheet Zope-2-CVS-src/lib/python/Products/OFSP/help/PropertySheet.py

Classes   
PropertySheet

A PropertySheet is an abstraction for organizing and working

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/PropertySheet_PropertySheet.py.html0100600000176200017510000004055607306455563033002 0ustar dhellmanndevel Class: PropertySheet

Table of Contents

Class: PropertySheet Zope-2-CVS-src/lib/python/Products/OFSP/help/PropertySheet.py

A PropertySheet is an abstraction for organizing and working with a set of related properties. Conceptually it acts like a container for a set of related properties and meta-data describing those properties. A PropertySheet may or may not provide a web interface for managing its properties.

Methods   
getProperty
getPropertyType
hasProperty
manage_addProperty
manage_changeProperties
manage_delProperties
propertyIds
propertyInfo
propertyItems
propertyMap
 propertyValues
xml_namespace
  getProperty  
getProperty ( id,  d=None )

Get the property id, returning the optional second argument or None if no such property is found.

Permission

Python only

  getPropertyType  
getPropertyType ( id )

Get the type of property id. Returns None if no such property exists.

Permission

Python only

  hasProperty  
hasProperty ( id )

Returns true if self has a property with the given id, false otherwise.

Permission

Access contents information

  manage_addProperty  
manage_addProperty (
        id,
        value,
        type,
        REQUEST=None,
        )

Add a new property with the given id, value and type.

These are the property types:

boolean

1 or 0.

date

A DateTime value, for example 12/31/1999 15:42:52 PST.

float

A decimal number, for example 12.4.

int

An integer number, for example, 12.

lines

A list of strings, one per line.

long

A long integer, for example 12232322322323232323423.

string

A string of characters, for example This is a string.

text

A multi-line string, for example a paragraph.

tokens

A list of strings separated by white space, for example one two three.

selection

A string selected by a pop-up menu.

multiple selection

A list of strings selected by a selection list.

This method will use the passed in type to try to convert the value argument to the named type. If the given value cannot be converted, a ValueError will be raised.

The value given for selection and multiple selection properites may be an attribute or method name. The attribute or method must return a sequence values.

If the given type is not recognized, the value and type given are simply stored blindly by the object.

If no value is passed in for REQUEST, the method will return None. If a value is provided for REQUEST (as it will when called via the web), the property management form for the object will be rendered and returned.

This method may be called via the web, from DTML or from Python code.

Permission

Manage Properties

  manage_changeProperties  
manage_changeProperties ( REQUEST=None,  **kw )

Change existing object properties by passing either a mapping object as REQUEST containing name:value pairs or by passing name=value keyword arguments.

Some objects have "special" properties defined by product authors that cannot be changed. If you try to change one of these properties through this method, an error will be raised.

Note that no type checking or conversion happens when this method is called, so it is the caller's responsibility to ensure that the updated values are of the correct type. This should probably change.

If a value is provided for REQUEST (as it will be when called via the web), the method will return an HTML message dialog. If no REQUEST is passed, the method returns None on success.

This method may be called via the web, from DTML or from Python code.

Permission

Manage Properties

  manage_delProperties  
manage_delProperties ( ids=None,  REQUEST=None )

Delete one or more properties with the given ids. The ids argument should be a sequence (tuple or list) containing the ids of the properties to be deleted. If ids is empty no action will be taken. If any of the properties named in ids does not exist, an error will be raised.

Some objects have "special" properties defined by product authors that cannot be deleted. If one of these properties is named in ids, an HTML error message is returned.

If no value is passed in for REQUEST, the method will return None. If a value is provided for REQUEST (as it will be when called via the web), the property management form for the object will be rendered and returned.

This method may be called via the web, from DTML or from Python code.

Permission

Manage Properties

  propertyIds  
propertyIds ()

Returns a list of property ids.

Permission

Access contents information

  propertyInfo  
propertyInfo ()

Returns a mapping containing property meta-data.

Permission

Python only

  propertyItems  
propertyItems ()

Return a list of (id, property) tuples.

Permission

Access contents information

  propertyMap  
propertyMap ()

Returns a tuple of mappings, giving meta-data for properties.

Permssion

Python only

  propertyValues  
propertyValues ()

Returns a list of actual property values.

Permission

Access contents information

  xml_namespace  
xml_namespace ()

Return a namespace string usable as an xml namespace for this property set. This may be an empty string if there is no default namespace for a given property sheet (especially property sheets added in ZClass definitions).

Permission

Python only

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/PropertySheets.py.html0100600000176200017510000000416207306455563030261 0ustar dhellmanndevel Module: PropertySheets

Table of Contents

Module: PropertySheets Zope-2-CVS-src/lib/python/Products/OFSP/help/PropertySheets.py

Classes   
PropertySheets

A PropertySheet is an abstraction for organizing and working with

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/PropertySheets_PropertySheets.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/PropertySheets_PropertySheets.py.ht0100600000176200017510000001174707306455563033017 0ustar dhellmanndevel Class: PropertySheets

Table of Contents

Class: PropertySheets Zope-2-CVS-src/lib/python/Products/OFSP/help/PropertySheets.py

A PropertySheet is an abstraction for organizing and working with a set of related properties. Conceptually it acts like a container for a set of related properties and meta-data describing those properties. PropertySheet objects are accessed through a PropertySheets object that acts as a collection of PropertySheet instances.

Objects that support property sheets (objects that support the PropertyManager interface or ZClass objects) have a propertysheets attribute (a PropertySheets instance) that is the collection of PropertySheet objects. The PropertySheets object exposes an interface much like a Python mapping, so that individual PropertySheet objects may be accessed via dictionary-style key indexing.

Methods   
get
items
values
  get  
get ( name,  default=None )

Return the PropertySheet identified by name, or the value given in default if the named PropertySheet is not found.

Permission

Python only

  items  
items ()

Return a sequence containing an (id, object) tuple for each PropertySheet object in the collection.

Permission

Python only

  values  
values ()

Return a sequence of all of the PropertySheet objects in the collection.

Permission

Python only

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/Request.py.html0100600000176200017510000000410707306455563026710 0ustar dhellmanndevel Module: Request

Table of Contents

Module: Request Zope-2-CVS-src/lib/python/Products/OFSP/help/Request.py

Classes   
Request

The request object encapsulates all of the information regarding

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/Request_Request.py.html0100600000176200017510000003110307306455563030414 0ustar dhellmanndevel Class: Request

Table of Contents

Class: Request Zope-2-CVS-src/lib/python/Products/OFSP/help/Request.py

The request object encapsulates all of the information regarding the current request in Zope. This includes, the input headers, form data, server data, and cookies.

The request object is a mapping object that represents a collection of variable to value mappings. In addition, variables are divided into four categories:

  • Environment variables

    These variables include input headers, server data, and other request-related data. The variable names are as <a href="http://hoohoo.ncsa.uiuc.edu/cgi/env.html">specified</a> in the <a href="http://hoohoo.ncsa.uiuc.edu/cgi/interface.html">CGI specification</a>

  • Form data

    These are data extracted from either a URL-encoded query string or body, if present.

  • Cookies

    These are the cookie data, if present.

  • Other

    Data that may be set by an application object.

The request object may be used as a mapping object, in which case values will be looked up in the order: environment variables, other variables, form data, and then cookies.

These special variables are set in the Request:

PARENTS

A list of the objects traversed to get to the published object. So, PARENTS[0] would be the ancestor of the published object.

REQUEST

The Request object.

RESPONSE

The Response object.

PUBLISHED

The actual object published as a result of url traversal.

URL

The URL of the Request without query string.

URLn

URL0 is the same as URL. URL1 is the same as URL0 with the last path element removed. URL2 is the same as URL1 with the last element removed. Etcetera.

For example if URL='http://localhost/foo/bar', then URL1='http://localhost/foo' and URL2='http://localhost'.

URLPATHn

URLPATH0 is the path portion of URL, URLPATH1 is the path portion of URL1, and so on.

For example if URL='http://localhost/foo/bar', then URLPATH1='/foo' and URLPATH2='/'.

BASEn

BASE0 is the URL up to but not including the Zope application object. BASE1 is the URL of the Zope application object. BASE2 is the URL of the Zope application object with an additional path element added in the path to the published object. Etcetera.

For example if URL='http://localhost/Zope.cgi/foo/bar', then BASE0='http://localhost', BASE1='http://localhost/Zope.cgi', and BASE2='http://localhost/Zope.cgi/foo'.

BASEPATHn

BASEPATH0 is the path portion of BASE0, BASEPATH1 is the path portion of BASE1, and so on. BASEPATH1 is the externally visible path to the root Zope folder, equivalent to CGI's SCRIPT_NAME, but virtual-host aware.

For example if URL='http://localhost/Zope.cgi/foo/bar', then BASEPATH0='/', BASEPATH1='/Zope.cgi', and BASEPATH2='/Zope.cgi/foo'.

Methods   
get_header
has_key
items
keys
set
setServerURL
setVirtualRoot
values
  get_header  
get_header ( name,  default=None )

Return the named HTTP header, or an optional default argument or None if the header is not found. Note that both original and CGI header names without the leading HTTP_ are recognized, for example, Content-Type, CONTENT_TYPE and HTTP_CONTENT_TYPE should all return the Content-Type header, if available.

Permission

Always available

  has_key  
has_key ( key )

Returns a true value if the REQUEST object contains key, returns a false value otherwise.

Permission

Always available

  items  
items ()

Returns a sequence of (key, value) tuples for all the keys in the REQUEST object.

Permission

Always available

  keys  
keys ()

Returns a sorted sequence of all keys in the REQUEST object.

Permission

Always available

  set  
set ( name,  value )

Create a new name in the REQUEST object and assign it a value. This name and value is stored in the Other category.

Permission

Always available

  setServerURL  
setServerURL (
        protocol=None,
        hostname=None,
        port=None,
        )

Sets the specified elements of SERVER_URL, also affecting URL, URLn, BASEn, and absolute_url().

Provides virtual hosting support.

Permission

Always available

  setVirtualRoot  
setVirtualRoot ( path,  hard=0 )

Alters URL, URLn, URLPATHn, BASEn, BASEPATHn, and absolute_url() so that the current object has path path. If hard is true, PARENTS is emptied.

Provides virtual hosting support. Intended to be called from publishing traversal hooks.

Permission

Always available

  values  
values ()

Returns a sequence of values for all the keys in the REQUEST object.

Permission

Always available

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/Response.py.html0100600000176200017510000000411307306455563027053 0ustar dhellmanndevel Module: Response

Table of Contents

Module: Response Zope-2-CVS-src/lib/python/Products/OFSP/help/Response.py

Classes   
Response

The Response object represents the response to a Zope request.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/help/Response_Response.py.html0100600000176200017510000003063307306455563030737 0ustar dhellmanndevel Class: Response

Table of Contents

Class: Response Zope-2-CVS-src/lib/python/Products/OFSP/help/Response.py

The Response object represents the response to a Zope request.

Methods   
addHeader
appendCookie
appendHeader
expireCookie
redirect
setBase
setCookie
setHeader
setStatus
write
  addHeader  
addHeader ( name,  value )

Set a new HTTP return header with the given value, while retaining any previously set headers with the same name.

Permission

Always available

  appendCookie  
appendCookie ( name,  value )

Returns an HTTP header that sets a cookie on cookie-enabled browsers with a key "name" and value "value". If a value for the cookie has previously been set in the response object, the new value is appended to the old one separated by a colon.

Permission

Always available

  appendHeader  
appendHeader (
        name,
        value,
        delimiter=",",
        )

Append a value to a cookie

Sets an HTTP return header "name" with value "value", appending it following a comma if there was a previous value set for the header.

Permission

Always available

  expireCookie  
expireCookie ( name,  **kw )

Cause an HTTP cookie to be removed from the browser

The response will include an HTTP header that will remove the cookie corresponding to "name" on the client, if one exists. This is accomplished by sending a new cookie with an expiration date that has already passed. Note that some clients require a path to be specified - this path must exactly match the path given when creating the cookie. The path can be specified as a keyword argument.

Permission

Always available

  redirect  
redirect ( location,  lock=0 )

Cause a redirection without raising an error. If the "lock" keyword argument is passed with a true value, then the HTTP redirect response code will not be changed even if an error occurs later in request processing (after redirect() has been called).

Permission

Always available

  setBase  
setBase ( base )

Set the base URL for the returned document.

Permission

Always available

  setCookie  
setCookie (
        name,
        value,
        **kw,
        )

Set an HTTP cookie on the browser

The response will include an HTTP header that sets a cookie on cookie-enabled browsers with a key "name" and value "value". This overwrites any previously set value for the cookie in the Response object.

Permission

Always available

  setHeader  
setHeader ( name,  value )

Sets an HTTP return header "name" with value "value", clearing the previous value set for the header, if one exists. If the literal flag is true, the case of the header name is preserved, otherwise word-capitalization will be performed on the header name on output.

Permission

Always available

  setStatus  
setStatus ( status,  reason=None )

Sets the HTTP status code of the response; the argument may either be an integer or one of the following strings:

OK, Created, Accepted, NoContent, MovedPermanently, MovedTemporarily, NotModified, BadRequest, Unauthorized, Forbidden, NotFound, InternalError, NotImplemented, BadGateway, ServiceUnavailable

that will be converted to the correct integer value.

Permission

Always available

  write  
write ( data )

Return data as a stream

HTML data may be returned using a stream-oriented interface. This allows the browser to display partial results while computation of a response to proceed.

The published object should first set any output headers or cookies on the response object.

Note that published objects must not generate any errors after beginning stream-oriented output.

Permission

Always available

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/Draft.py.html0100600000176200017510000001204307306455562025365 0ustar dhellmanndevel Module: Draft

Table of Contents

Module: Draft Zope-2-CVS-src/lib/python/Products/OFSP/Draft.py

Imported modules   
import AccessControl.User
from Acquisition import Implicit
import Globals
from Globals import Persistent
from OFS import SimpleItem
from string import rfind
Functions   
getdraft
manage_addPrincipiaDraft
  getdraft  
getdraft ( ob,  jar )

  manage_addPrincipiaDraft  
manage_addPrincipiaDraft (
        self,
        id,
        baseid,
        PATH_INFO,
        REQUEST=None,
        )

Add a draft object

Classes   
Cleanup
Draft

Daft objects

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/Draft_Cleanup.py.html0100600000176200017510000000243407306455562027037 0ustar dhellmanndevel Class: Cleanup

Table of Contents

Class: Cleanup Zope-2-CVS-src/lib/python/Products/OFSP/Draft.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/Draft_Draft.py.html0100600000176200017510000003016407306455562026511 0ustar dhellmanndevel Class: Draft

Table of Contents

Class: Draft Zope-2-CVS-src/lib/python/Products/OFSP/Draft.py

Daft objects

Base Classes   
Persistent
Implicit
SimpleItem.Item
Methods   
__bobo_traverse__
__init__
icon
manage_Discard__draft__
manage_Save__draft__
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_options
nonempty
 title
title_and_id
  __bobo_traverse__  
__bobo_traverse__ (
        self,
        REQUEST,
        name,
        )

  __init__  
__init__ (
        self,
        id,
        baseid,
        PATH_INFO,
        )

  icon  
icon ( self )

  manage_Discard__draft__  
manage_Discard__draft__ ( self,  REQUEST=None )

Discard changes made during the version

  manage_Save__draft__  
manage_Save__draft__ (
        self,
        remark,
        REQUEST=None,
        )

Make version changes permanent

  manage_afterAdd  
manage_afterAdd (
        self,
        item,
        container,
        )

  manage_afterClone  
manage_afterClone ( self,  item )

  manage_beforeDelete  
manage_beforeDelete (
        self,
        item,
        container,
        )

Exceptions   
'Version Error', ('Attempt to %sdelete a non-empty version.

'(( self is not item ) and 'indirectly ' or '' ) )

  manage_options  
manage_options ( self )

  nonempty  
nonempty ( self )

  title  
title ( self )

  title_and_id  
title_and_id ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/Session.py.html0100600000176200017510000000370007306455563025751 0ustar dhellmanndevel Module: Session

Table of Contents

Module: Session Zope-2-CVS-src/lib/python/Products/OFSP/Session.py

Backward compatability!

Imported modules   
from Version import Version

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/Version.py.html0100600000176200017510000001111507306455563025752 0ustar dhellmanndevel Module: Version

Table of Contents

Module: Version Zope-2-CVS-src/lib/python/Products/OFSP/Version.py

Version object

Imported modules   
from AccessControl.Role import RoleManager
from Acquisition import Implicit
from App.Dialogs import MessageDialog
import Globals
from Globals import MessageDialog, Persistent, HTML
from OFS.ObjectManager import BeforeDeleteException
from OFS.SimpleItem import Item
from string import rfind, join
import time
Functions   
manage_addVersion
  manage_addVersion  
manage_addVersion (
        self,
        id,
        title,
        REQUEST=None,
        )

Classes   
Version
VersionException

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/Version_Version.py.html0100600000176200017510000003240407306455563027463 0ustar dhellmanndevel Class: Version

Table of Contents

Class: Version Zope-2-CVS-src/lib/python/Products/OFSP/Version.py

Base Classes   
Persistent
Implicit
RoleManager
Item
Methods   
__init__
_canCopy
discard
enter
leave
leave_another
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_edit
 nonempty
save
title_and_id
  __init__  
__init__ (
        self,
        id,
        title,
        REQUEST,
        )

  _canCopy  
_canCopy ( self,  op=0 )

  discard  
discard (
        self,
        remark='',
        REQUEST=None,
        )

Discard changes made during the version

  enter  
enter (
        self,
        REQUEST,
        RESPONSE,
        )

Begin working in a version

  leave  
leave (
        self,
        REQUEST,
        RESPONSE,
        )

Temporarily stop working in a version

  leave_another  
leave_another (
        self,
        REQUEST,
        RESPONSE,
        )

Leave a version that may not be the current version

  manage_afterAdd  
manage_afterAdd (
        self,
        item,
        container,
        )

  manage_afterClone  
manage_afterClone ( self,  item )

  manage_beforeDelete  
manage_beforeDelete (
        self,
        item,
        container,
        )

Exceptions   
VersionException('An attempt was made to delete a version, %s, or an\n' 'object containing %s while\n working in the\n' 'version %s. This would lead to a "version\n' 'paradox". The object containing the deleted\n' 'object would be locked and it would be impossible\n' 'to clear the lock by saving or discarding the\n' 'version, because the version would no longer\n' 'be accessable.

\n' %( v, v, v ) )
VersionException('Attempt to %sdelete a non-empty version.
' %(( self is not item ) and 'indirectly ' or '' ) )

  manage_edit  
manage_edit (
        self,
        title,
        REQUEST=None,
        )

  nonempty  
nonempty ( self )

  save  
save (
        self,
        remark,
        REQUEST=None,
        )

Make version changes permanent

  title_and_id  
title_and_id ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/Version_VersionException.py.html0100600000176200017510000000371107306455563031341 0ustar dhellmanndevel Class: VersionException

Table of Contents

Class: VersionException Zope-2-CVS-src/lib/python/Products/OFSP/Version.py

Base Classes   
BeforeDeleteException

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/__init__.py.html0100600000176200017510000000700307306455563026065 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/OFSP/__init__.py

Imported modules   
import AccessControl.User
import OFS.DTMLDocument
import OFS.DTMLMethod
import OFS.Folder
import OFS.Image
import OFS.PropertySheets
import Version
from ZClasses import createZClassForBase
import ZClasses.ObjectManager
Functions   
initialize
  initialize  
initialize ( context )

This is the new way to initialize products. It is hoped that this more direct mechanism will be more understandable.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/OFSP/README.txt.html0100600000176200017510000000232707306455563025456 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.OFSP

Table of Contents

Zope2 CVS with ZEO: Products.OFSP  

OFSP

ODFS Providers Draft Folders and Versions.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:47 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/0040700000176200017510000000000007306455566025024 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/index.html0100600000176200017510000000742307306455566027026 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PluginIndexes

Table of Contents

Zope2 CVS with ZEO: Products.PluginIndexes  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/PluginIndexes/

README.txt.html

Zope 2.4 introduces a new way to register customized indexes (see PluggableIndex interface).

FieldIndex

Zope2 CVS with ZEO: Products.PluginIndexes.FieldIndex

KeywordIndex

Zope2 CVS with ZEO: Products.PluginIndexes.KeywordIndex

PathIndex

Zope2 CVS with ZEO: Products.PluginIndexes.PathIndex

TextIndex

Zope2 CVS with ZEO: Products.PluginIndexes.TextIndex

common

Zope2 CVS with ZEO: Products.PluginIndexes.common

Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/

testFieldIndex
testKeywordIndex
testPathIndex
testSplitter
testTextIndex

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/FieldIndex/0040700000176200017510000000000007306455564027035 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/FieldIndex/index.html0100600000176200017510000000425407306455564031036 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PluginIndexes.FieldIndex

Table of Contents

Zope2 CVS with ZEO: Products.PluginIndexes.FieldIndex  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/PluginIndexes/FieldIndex/

FieldIndex

Simple column indices

__init__

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/FieldIndex/FieldIndex.py.html0100600000176200017510000001153207306455564032366 0ustar dhellmanndevel Module: FieldIndex

Table of Contents

Module: FieldIndex Zope-2-CVS-src/lib/python/Products/PluginIndexes/FieldIndex/FieldIndex.py

Simple column indices

Imported modules   
from Acquisition import Implicit
import BTree
from BTrees.IIBTree import IITreeSet, IISet, union
from BTrees.IOBTree import IOBTree
import BTrees.Length
from BTrees.OOBTree import OOBTree, OOSet
from Globals import Persistent, DTMLFile
import IOBTree
from OFS.History import Historical
from OFS.SimpleItem import SimpleItem
from Products.PluginIndexes import PluggableIndex
from Products.PluginIndexes.common.UnIndex import UnIndex
import string
from types import StringType, ListType, IntType, TupleType
from zLOG import LOG, ERROR
Functions   
manage_addFieldIndex
  manage_addFieldIndex  
manage_addFieldIndex (
        self,
        id,
        REQUEST=None,
        RESPONSE=None,
        URL3=None,
        )

Add a field index

Classes   
FieldIndex

Field Indexes

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/FieldIndex/FieldIndex_FieldIndex.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/FieldIndex/FieldIndex_FieldInde0100600000176200017510000000377607306455564032712 0ustar dhellmanndevel Class: FieldIndex

Table of Contents

Class: FieldIndex Zope-2-CVS-src/lib/python/Products/PluginIndexes/FieldIndex/FieldIndex.py

Field Indexes

Base Classes   
UnIndex
PluggableIndex.PluggableIndex
Persistent
Implicit
SimpleItem

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/FieldIndex/__init__.py.html0100600000176200017510000000247507306455564032120 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/PluginIndexes/FieldIndex/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/KeywordIndex/0040700000176200017510000000000007306455564027436 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/KeywordIndex/index.html0100600000176200017510000000423007306455564031431 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PluginIndexes.KeywordIndex

Table of Contents

Zope2 CVS with ZEO: Products.PluginIndexes.KeywordIndex  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/PluginIndexes/KeywordIndex/

KeywordIndex
__init__

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/KeywordIndex/KeywordIndex.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/KeywordIndex/KeywordIndex.py.ht0100600000176200017510000001105207306455564033034 0ustar dhellmanndevel Module: KeywordIndex

Table of Contents

Module: KeywordIndex Zope-2-CVS-src/lib/python/Products/PluginIndexes/KeywordIndex/KeywordIndex.py

Imported modules   
from Acquisition import Implicit
from BTrees.OOBTree import OOSet, difference
from Globals import Persistent, DTMLFile
from OFS.History import Historical
from OFS.SimpleItem import SimpleItem
from Products.PluginIndexes import PluggableIndex
from Products.PluginIndexes.common.UnIndex import UnIndex
from types import StringType
from zLOG import LOG, ERROR
Functions   
manage_addKeywordIndex
  manage_addKeywordIndex  
manage_addKeywordIndex (
        self,
        id,
        REQUEST=None,
        RESPONSE=None,
        URL3=None,
        )

Add a keyword index

Classes   
KeywordIndex

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016300000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/KeywordIndex/KeywordIndex_KeywordIndex.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/KeywordIndex/KeywordIndex_Keywo0100600000176200017510000001231207306455564033151 0ustar dhellmanndevel Class: KeywordIndex

Table of Contents

Class: KeywordIndex Zope-2-CVS-src/lib/python/Products/PluginIndexes/KeywordIndex/KeywordIndex.py

Base Classes   
UnIndex
PluggableIndex.PluggableIndex
Persistent
Implicit
SimpleItem
Methods   
index_object
unindex_object
unindex_objectKeywords
  index_object  
index_object (
        self,
        documentId,
        obj,
        threshold=None,
        )

index an object obj with integer id i

Ideally, we've been passed a sequence of some sort that we can iterate over. If however, we haven't, we should do something useful with the results. In the case of a string, this means indexing the entire string as a keyword.

  unindex_object  
unindex_object ( self,  documentId )

carefully unindex the object with integer id documentId

  unindex_objectKeywords  
unindex_objectKeywords (
        self,
        documentId,
        keywords,
        )

carefully unindex the object with integer id documentId

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/KeywordIndex/__init__.py.html0100600000176200017510000000247707306455564032523 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/PluginIndexes/KeywordIndex/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/PathIndex/0040700000176200017510000000000007306455564026706 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/PathIndex/index.html0100600000176200017510000000421107306455564030700 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PluginIndexes.PathIndex

Table of Contents

Zope2 CVS with ZEO: Products.PluginIndexes.PathIndex  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/PluginIndexes/PathIndex/

PathIndex
__init__

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/PathIndex/PathIndex.py.html0100600000176200017510000001127207306455564032111 0ustar dhellmanndevel Module: PathIndex

Table of Contents

Module: PathIndex Zope-2-CVS-src/lib/python/Products/PluginIndexes/PathIndex/PathIndex.py

Imported modules   
from Acquisition import Implicit
from BTrees.IIBTree import IISet, difference, intersection, union
from BTrees.IOBTree import IOBTree
from BTrees.OIBTree import OIBTree
from BTrees.OOBTree import OOBTree, OOSet
from Globals import Persistent, DTMLFile
from OFS.History import Historical
from OFS.SimpleItem import SimpleItem
from Products.PluginIndexes import PluggableIndex
from Products.PluginIndexes.common.util import parseIndexRequest
import re
Functions   
manage_addPathIndex
  manage_addPathIndex  
manage_addPathIndex (
        self,
        id,
        REQUEST=None,
        RESPONSE=None,
        URL3=None,
        )

Add a path index

Classes   
PathIndex

A path index stores all path components of the physical

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/PathIndex/PathIndex_PathIndex.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/PathIndex/PathIndex_PathIndex.p0100600000176200017510000003417307306455564032726 0ustar dhellmanndevel Class: PathIndex

Table of Contents

Class: PathIndex Zope-2-CVS-src/lib/python/Products/PluginIndexes/PathIndex/PathIndex.py

A path index stores all path components of the physical path of an object:

Internal datastructure:

  • a physical path of an object is split into its components

  • every component is kept as a key of a OOBTree in self._indexes

  • the value is a mapping level of the path component to all documentIds with this path component on this level

Base Classes   
PluggableIndex.PluggableIndex
Persistent
Implicit
SimpleItem
Methods   
__init__
__len__
_apply_index
clear
index_object
insertEntry
items
keys
numObjects
printIndex
 search
splitPath
unindex_object
uniqueValues
values
  __init__  
__init__ (
        self,
        id,
        caller=None,
        )

  __len__  
__len__ ( self )

len

  _apply_index  
_apply_index (
        self,
        request,
        cid='',
        )

hook for (Z)Catalog request mapping type (usually {"path": "..." } additionaly a parameter "path_level" might be passed to specify the level (see search())

cid ???

  clear  
clear ( self )

clear everything

  index_object  
index_object (
        self,
        documentId,
        obj,
        threshold=100,
        )

hook for (Z)Catalog

  insertEntry  
insertEntry (
        self,
        comp,
        id,
        level,
        )

k is a path component (generated by splitPath() ) v is the documentId level is the level of the component inside the path

  items  
items ( self )

mapping path components : documentIds

  keys  
keys ( self )

return list of all path components

  numObjects  
numObjects ( self )

return the number of indexed objects

  printIndex  
printIndex ( self )

  search  
search (
        self,
        path,
        level=0,
        )

path is a list of path components to be searched level>=0 starts searching at the given level level<0 not implemented yet

  splitPath  
splitPath (
        self,
        path,
        obj=None,
        )

split physical path of object. If the object has as function splitPath() we use this user-defined function to split the path

  unindex_object  
unindex_object ( self,  id )

hook for (Z)Catalog

  uniqueValues  
uniqueValues (
        self,
        name=None,
        withLength=0,
        )

need to be consistent with the interface

  values  
values ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/PathIndex/__init__.py.html0100600000176200017510000000247407306455564031770 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/PluginIndexes/PathIndex/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/0040700000176200017510000000000007306455565026737 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/index.html0100600000176200017510000000613107306455565030734 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PluginIndexes.TextIndex

Table of Contents

Zope2 CVS with ZEO: Products.PluginIndexes.TextIndex  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/

GlobbingLexicon
Lexicon
Splitter

Zope2 CVS with ZEO: Products.PluginIndexes.TextIndex.Splitter

TextIndex

Text Index

Vocabulary

ZCatalog product

__init__
randid

Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/tests/

testSplitter

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/0040700000176200017510000000000007306455564030544 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/index.html0100600000176200017510000000513307306455564032542 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PluginIndexes.TextIndex.Splitter

Table of Contents

Zope2 CVS with ZEO: Products.PluginIndexes.TextIndex.Splitter  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/

ISO_8859_1_Splitter

Zope2 CVS with ZEO: Products.PluginIndexes.TextIndex.Splitter.ISO_8859_1_Splitter

ZopeSplitter

Zope2 CVS with ZEO: Products.PluginIndexes.TextIndex.Splitter.ZopeSplitter

__init__
setup

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:26 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ISO_8859_1_Splitter/Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ISO_8859_1_S0040700000176200017510000000000007306455564032316 5ustar dhellmanndevel././@LongLink0000000000000000000000000000016600000000000011570 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ISO_8859_1_Splitter/index.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ISO_8859_1_S0100600000176200017510000000414707306455564032325 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PluginIndexes.TextIndex.Splitter.ISO_8859_1_Splitter

Table of Contents

Zope2 CVS with ZEO: Products.PluginIndexes.TextIndex.Splitter.ISO_8859_1_Splitter  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ISO_8859_1_Splitter/

__init__

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:26 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017400000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ISO_8859_1_Splitter/__init__.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ISO_8859_1_S0100600000176200017510000000372307306455564032324 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ISO_8859_1_Splitter/__init__.py

Imported modules   
from Splitter import Splitter

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:26 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ZopeSplitter/Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ZopeSplitter0040700000176200017510000000000007306455564033131 5ustar dhellmanndevel././@LongLink0000000000000000000000000000015700000000000011570 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ZopeSplitter/index.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ZopeSplitter0100600000176200017510000000412207306455564033131 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PluginIndexes.TextIndex.Splitter.ZopeSplitter

Table of Contents

Zope2 CVS with ZEO: Products.PluginIndexes.TextIndex.Splitter.ZopeSplitter  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ZopeSplitter/

__init__

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:26 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016500000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ZopeSplitter/__init__.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ZopeSplitter0100600000176200017510000000525207306455564033136 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ZopeSplitter/__init__.py

Imported modules   
from Splitter import Splitter
Classes   
ZopeSplitter

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:26 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000020200000000000011557 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ZopeSplitter/__init___ZopeSplitter.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ZopeSplitter0100600000176200017510000000743007306455564033136 0ustar dhellmanndevel Class: ZopeSplitter

Table of Contents

Class: ZopeSplitter Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/ZopeSplitter/__init__.py

Methods   
__init__
a
b
  __init__  
__init__ ( self )

  a  
a ( self )

a

  b  
b ( self )

b

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:26 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/__init__.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/__init__.py.0100600000176200017510000001012207306455564032726 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/__init__.py

Imported modules   
import exceptions
import os
import sys
Functions   
getSplitter
  getSplitter  
getSplitter ( name=None )

Exceptions   
exceptions.RuntimeError, "No such splitter '%s'" % name

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:26 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/setup.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/setup.py.htm0100600000176200017510000000463407306455564033053 0ustar dhellmanndevel Module: setup

Table of Contents

Module: setup Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Splitter/setup.py

Imported modules   
import commands
from distutils.core import setup, Extension
import exceptions
import os
import string
import sys

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:26 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/GlobbingLexicon.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/GlobbingLexicon.py.ht0100600000176200017510000000667007306455565033000 0ustar dhellmanndevel Module: GlobbingLexicon

Table of Contents

Module: GlobbingLexicon Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/GlobbingLexicon.py

Imported modules   
from BTrees.IIBTree import IISet, union, IITreeSet
from BTrees.IOBTree import IOBTree
from BTrees.OIBTree import OIBTree
from BTrees.OOBTree import OOBTree
from Lexicon import Lexicon
from Products.PluginIndexes.TextIndex.TextIndex import Or
import Splitter
from randid import randid
import re
import string
Classes   
GlobbingLexicon

Lexicon which supports basic globbing function (* and ?).

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016600000000000011570 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/GlobbingLexicon_GlobbingLexicon.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/GlobbingLexicon_Globb0100600000176200017510000003003607306455565033035 0ustar dhellmanndevel Class: GlobbingLexicon

Table of Contents

Class: GlobbingLexicon Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/GlobbingLexicon.py

Lexicon which supports basic globbing function (* and ?).

This lexicon keeps several data structures around that are useful for searching. They are:

_lexicon

Contains the mapping from word => word_id

_inverseLex

Contains the mapping from word_id => word

_digrams

Contains a mapping from digram => word_id

Before going further, it is necessary to understand what a digram is, as it is a core component of the structure of this lexicon. A digram is a two-letter sequence in a word. For example, the word zope would be converted into the digrams:

      ['$z', 'zo', 'op', 'pe', 'e$']

where the $ is a word marker. It is used at the beginning and end of the words. Those digrams are significant.

Base Classes   
Lexicon
Methods   
Splitter
__getitem__
__init__
_convertBTrees
assignWordId
clear
createDigrams
createRegex
get
getWord
 getWordId
query_hook
  Splitter  
Splitter (
        self,
        astring,
        words=None,
        )

wrap the splitter

  __getitem__  
__getitem__ ( self,  word )

  __init__  
__init__ ( self,  useSplitter=None )

  _convertBTrees  
_convertBTrees ( self,  threshold=200 )

  assignWordId  
assignWordId ( self,  word )

Assigns a new word id to the provided word, and return it.

  clear  
clear ( self )

  createDigrams  
createDigrams ( self,  word )

Returns a list with the set of digrams in the word.

  createRegex  
createRegex ( self,  pat )

Translate a PATTERN to a regular expression.

There is no way to quote meta-characters.

  get  
get ( self,  pattern )

Query the lexicon for words matching a pattern.

  getWord  
getWord ( self,  wid )

  getWordId  
getWordId ( self,  word )

Provided word, return the matching integer word id.

  query_hook  
query_hook ( self,  q )

expand wildcards

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Lexicon.py.html0100600000176200017510000000601707306455565031660 0ustar dhellmanndevel Module: Lexicon

Table of Contents

Module: Lexicon Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Lexicon.py

Imported modules   
from Acquisition import Implicit
from BTrees.IIBTree import IISet, IITreeSet
from BTrees.IOBTree import IOBTree
from BTrees.OIBTree import OIBTree
from Persistence import Persistent
import Splitter
from randid import randid
Classes   
Lexicon

Maps words to word ids and then some

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Lexicon_Lexicon.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Lexicon_Lexicon.py.ht0100600000176200017510000002707607306455565033020 0ustar dhellmanndevel Class: Lexicon

Table of Contents

Class: Lexicon Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Lexicon.py

Maps words to word ids and then some

The Lexicon object is an attempt to abstract vocabularies out of Text indexes. This abstraction is not totally cooked yet, this module still includes the parser for the Text Index Query Language and a few other hacks.

Base Classes   
Persistent
Implicit
Methods   
Splitter
__getitem__
__init__
__len__
_convertBTrees
assignWordId
clear
get
getWord
getWordId
 query_hook
set_stop_syn
  Splitter  
Splitter (
        self,
        astring,
        words=None,
        )

wrap the splitter

  __getitem__  
__getitem__ ( self,  key )

  __init__  
__init__ (
        self,
        stop_syn=None,
        useSplitter=None,
        )

  __len__  
__len__ ( self )

  _convertBTrees  
_convertBTrees ( self,  threshold=200 )

  assignWordId  
assignWordId ( self,  word )

Assigns a new word id to the provided word and returns it.

  clear  
clear ( self )

  get  
get (
        self,
        key,
        default=None,
        )

Return the matched word against the key.

  getWord  
getWord ( self,  wid )

post-2.3.1b2 method, will not work with unconverted lexicons

  getWordId  
getWordId ( self,  word )

return the word id of word

  query_hook  
query_hook ( self,  q )

we don't want to modify the query cuz we're dumb

  set_stop_syn  
set_stop_syn ( self,  stop_syn )

pass in a mapping of stopwords and synonyms. Format is:

{'word' : [syn1, syn2, ..., synx]}

Vocabularies do not necesarily need to implement this if their splitters do not support stemming or stoping.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/TextIndex.py.html0100600000176200017510000002261307306455565032173 0ustar dhellmanndevel Module: TextIndex

Table of Contents

Module: TextIndex Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/TextIndex.py

Text Index

The TextIndex falls under the I didnt have a better name for it excuse. It is an Un Text index because it stores a little bit of undo information so that objects can be unindexed when the old value is no longer known.

Imported modules   
from Acquisition import Implicit
from BTrees.IIBTree import IIBTree, IIBucket, IISet, IITreeSet, difference, weightedIntersection
from BTrees.IOBTree import IOBTree
from BTrees.OIBTree import OIBTree
from Globals import Persistent, DTMLFile
from Lexicon import Lexicon
from OFS.SimpleItem import SimpleItem
from Products.PluginIndexes import PluggableIndex
from Products.PluginIndexes.common.ResultList import ResultList
from Products.PluginIndexes.common.util import parseIndexRequest
import operator
import re
import string
from types import *
from zLOG import LOG, ERROR
Functions   
manage_addTextIndex
parens
parse
parse2
quotes
  manage_addTextIndex  
manage_addTextIndex (
        self,
        id,
        extra=None,
        REQUEST=None,
        RESPONSE=None,
        URL3=None,
        )

Add a text index

  parens  
parens ( s,  parens_re=re.compile( r'(\|)' ).search )

Exceptions   
QueryError, "Mismatched parentheses"
  parse  
parse ( s )

Parse parentheses and quotes

  parse2  
parse2 (
        q,
        default_operator,
        operator_dict={ AndNot : AndNot, And : And, Or : Or, Near : Near },
        )

Find operators and operands

  quotes  
quotes ( s,  ws=( string.whitespace, ) )

Exceptions   
QueryError, "Mismatched quotes"
Classes   
TextIndex

Full-text index.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/TextIndex_TextIndex.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/TextIndex_TextIndex.p0100600000176200017510000005475007306455565033042 0ustar dhellmanndevel Class: TextIndex

Table of Contents

Class: TextIndex Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/TextIndex.py

Full-text index.

There is a ZCatalog UML model that sheds some light on what is going on here. _index is a BTree which maps word ids to mapping from document id to score. Something like:

{'bob' : {1 : 5, 2 : 3, 42 : 9}} {'uncle' : {1 : 1}}

The _unindex attribute is a mapping from document id to word ids. This mapping allows the catalog to unindex an object:

{42 : (bob, is, your, uncle)

This isn't exactly how things are represented in memory, many optimizations happen along the way.

Base Classes   
PluggableIndex.PluggableIndex
Persistent
Implicit
SimpleItem
Methods   
__getitem__
__init__
__nonzero__
_apply_index
_convertBTrees
_subindex
clear
evaluate
getEntryForObject
getLexicon
 get_operands
histogram
index_object
insertForwardIndexEntry
manage_setPreferences
numObjects
positions
query
unindex_object
unindex_objectWids
  __getitem__  
__getitem__ ( self,  word )

Return an InvertedIndex-style result "list"

Note that this differentiates between being passed an Integer and a String. Strings are looked up in the lexicon, whereas Integers are assumed to be resolved word ids.

  __init__  
__init__ (
        self,
        id,
        ignore_ex=None,
        call_methods=None,
        lexicon=None,
        extra=None,
        )

Create an index

The arguments are:

id

the name of the item attribute to index. This is either an attribute name or a record key.

ignore_ex

Tells the indexer to ignore exceptions that are rasied when indexing an object.

call_methods

Tells the indexer to call methods instead of getattr or getitem to get an attribute.

lexicon is the lexicon object to specify, if None, the index will use a private lexicon.

  __nonzero__  
__nonzero__ ( self )

  _apply_index  
_apply_index (
        self,
        request,
        cid='',
        )

Apply the index to query parameters given in the argument, request

The argument should be a mapping object.

If the request does not contain the needed parameters, then None is returned.

Otherwise two objects are returned. The first object is a ResultSet containing the record numbers of the matching records. The second object is a tuple containing the names of all data fields used.

Exceptions   
exceptions.RuntimeError, "Invalid operator '%s' for a TextIndex" % query_operator
  _convertBTrees  
_convertBTrees ( self,  threshold=200 )

  _subindex  
_subindex (
        self,
        source,
        wordScores,
        last,
        splitter,
        )

Recursively handle multi-word synonyms

  clear  
clear ( self )

Reinitialize the text index.

  evaluate  
evaluate ( self,  query )

Evaluate a parsed query

Exceptions   
QueryError, "Malformed query"
  getEntryForObject  
getEntryForObject (
        self,
        rid,
        default=None,
        )

Get all information contained for a specific object.

This takes the objects record ID as it's main argument.

  getLexicon  
getLexicon ( self,  vocab_id=None )

Return the Lexicon in use. Removed lots of stinking code

  get_operands  
get_operands (
        self,
        q,
        i,
        )

Evaluate and return the left and right operands for an operator

Exceptions   
QueryError, "Malformed query"
  histogram  
histogram (
        self,
        type=type,
        TupleType=type(() ),
        )

Return a mapping which provides a histogram of the number of elements found at each point in the index.

  index_object  
index_object (
        self,
        documentId,
        obj,
        threshold=None,
        )

Index an object: documentId is the integer id of the document

obj is the objects to be indexed

threshold is the number of words to process between commiting subtransactions. If None subtransactions are disabled.

  insertForwardIndexEntry  
insertForwardIndexEntry (
        self,
        entry,
        documentId,
        score=1,
        )

Uses the information provided to update the indexes.

The basic logic for choice of data structure is based on the number of entries as follows:

1 tuple 2-4 dictionary 5+ bucket.

  manage_setPreferences  
manage_setPreferences (
        self,
        vocabulary,
        REQUEST=None,
        RESPONSE=None,
        URL2=None,
        )

preferences of TextIndex

  numObjects  
numObjects ( self )

return number of index objects

  positions  
positions (
        self,
        docid,
        words,
        )

Return the positions in the document for the given document id of the word, word.

  query  
query (
        self,
        s,
        default_operator=Or,
        ws=( string.whitespace, ),
        )

This is called by TextIndexes. A query term which is a string s is passed in, along with an index object. s is parsed, then the wildcards are parsed, then something is parsed again, then the whole thing is evaluated.

  unindex_object  
unindex_object ( self,  i )

carefully unindex document with integer id i from the text index and do not fail if it does not exist

  unindex_objectWids  
unindex_objectWids (
        self,
        i,
        wids,
        )

carefully unindex document with integer id i from the text index and do not fail if it does not exist

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Vocabulary.py.html0100600000176200017510000001073207306455565032365 0ustar dhellmanndevel Module: Vocabulary

Table of Contents

Module: Vocabulary Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Vocabulary.py

ZCatalog product

Imported modules   
import AccessControl.Role
from Acquisition import Implicit
import Globals
from Globals import DTMLFile, MessageDialog
from OFS.SimpleItem import Item
from Persistence import Persistent
from Products.PluginIndexes.TextIndex import Lexicon, GlobbingLexicon, Splitter
from Products.PluginIndexes.TextIndex.Lexicon import stop_word_dict
Functions   
manage_addVocabulary
  manage_addVocabulary  
manage_addVocabulary (
        self,
        id,
        title,
        globbing=None,
        splitter='',
        REQUEST=None,
        )

Add a Vocabulary object

Classes   
Vocabulary

A Vocabulary is a user-managable realization of a Lexicon object.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Vocabulary_Vocabulary.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Vocabulary_Vocabulary0100600000176200017510000001704507306455565033166 0ustar dhellmanndevel Class: Vocabulary

Table of Contents

Class: Vocabulary Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/Vocabulary.py

A Vocabulary is a user-managable realization of a Lexicon object.

Base Classes   
Item
Persistent
Implicit
AccessControl.Role.RoleManager
Methods   
__init__
getLexicon
insert
manage_insert
manage_stop_syn
query
words
  __init__  
__init__ (
        self,
        id,
        title='',
        globbing=None,
        splitter=None,
        )

create the lexicon to manage...

  getLexicon  
getLexicon ( self )

  insert  
insert ( self,  word='' )

  manage_insert  
manage_insert (
        self,
        word='',
        URL1=None,
        RESPONSE=None,
        )

doc string

  manage_stop_syn  
manage_stop_syn (
        self,
        stop_syn,
        REQUEST=None,
        )

  query  
query ( self,  pattern )

  words  
words ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/__init__.py.html0100600000176200017510000000247407306455565032021 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/randid.py.html0100600000176200017510000000642007306455565031516 0ustar dhellmanndevel Module: randid

Table of Contents

Module: randid Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/randid.py

Imported modules   
import whrandom
Functions   
randid
  randid  
randid (
        randint=whrandom.randint,
        choice=whrandom.choice,
        signs=( -1, 1 ),
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/tests/0040700000176200017510000000000007306455565030101 5ustar dhellmanndevel././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/tests/testSplitter.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/tests/testSplitter.py0100600000176200017510000001407407306455565033166 0ustar dhellmanndevel Module: testSplitter

Table of Contents

Module: testSplitter Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/tests/testSplitter.py

Imported modules   
import Splitter
import locale
import sys
import unittest
Functions   
debug
main
pdebug
test_suite
  debug  
debug ()

  main  
main ()

  pdebug  
pdebug ()

  test_suite  
test_suite ()

Classes   
TestCase

Test our Splitters

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016200000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/tests/testSplitter_TestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/tests/testSplitter_Te0100600000176200017510000001524307306455565033166 0ustar dhellmanndevel Class: TestCase

Table of Contents

Class: TestCase Zope-2-CVS-src/lib/python/Products/PluginIndexes/TextIndex/tests/testSplitter.py

Test our Splitters

Base Classes   
unittest.TestCase
Methods   
_test
setUp
tearDown
testAvailableSplitters
testISOSplitter
testZopeSplitter
  _test  
_test (
        self,
        sp_name,
        text,
        splitted,
        )

  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

  testAvailableSplitters  
testAvailableSplitters ( self )

Test available splitters

  testISOSplitter  
testISOSplitter ( self )

test ISOSplitter

  testZopeSplitter  
testZopeSplitter ( self )

test ZopeSplitter

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/0040700000176200017510000000000007306455565026313 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/index.html0100600000176200017510000000523507306455565030314 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PluginIndexes.common

Table of Contents

Zope2 CVS with ZEO: Products.PluginIndexes.common  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/

PluggableIndex

Pluggable Index Base Class

ResultList
UnIndex

Simple column indices

__init__
randid
util

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/PluggableIndex.py.html0100600000176200017510000000524307306455565032525 0ustar dhellmanndevel Module: PluggableIndex

Table of Contents

Module: PluggableIndex Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/PluggableIndex.py

Pluggable Index Base Class

Imported modules   
import Interface
Classes   
PluggableIndex

Base pluggable index class

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:28 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016100000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/PluggableIndex_PluggableIndex.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/PluggableIndex_Pluggable0100600000176200017510000001514307306455565033115 0ustar dhellmanndevel Class: PluggableIndex

Table of Contents

Class: PluggableIndex Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/PluggableIndex.py

Base pluggable index class

Methods   
_apply_index
getEntryForObject
index_object
unindex_object
uniqueValues
  _apply_index  
_apply_index (
        self,
        request,
        cid='',
        )

Apply the index to query parameters given in the argument, request.

The argument should be a mapping object.

If the request does not contain the needed parametrs, then None is returned.

If the request contains a parameter with the name of the column + "_usage", it is sniffed for information on how to handle applying the index.

Otherwise two objects are returned. The first object is a ResultSet containing the record numbers of the matching records. The second object is a tuple containing the names of all data fields used.

  getEntryForObject  
getEntryForObject (
        self,
        documentId,
        default=None,
        )

Get all information contained for a specific object by documentId

  index_object  
index_object (
        self,
        documentId,
        obj,
        threshold=None,
        )

Index an object:

documentId is the integer ID of the document

obj is the object to be indexed

threshold is the number of words to process between committing subtransactions. If None, subtransactions are disabled

  unindex_object  
unindex_object ( self,  documentId )

Remove the documentId from the index

  uniqueValues  
uniqueValues (
        self,
        name=None,
        withLengths=0,
        )

Returns the unique values for name.

If withLengths is true, returns a sequence of tuples of (value, length)

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/ResultList.py.html0100600000176200017510000000537207306455565031750 0ustar dhellmanndevel Module: ResultList

Table of Contents

Module: ResultList Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/ResultList.py

Imported modules   
from BTrees.IIBTree import IIBucket, weightedIntersection, weightedUnion, difference
from BTrees.OOBTree import OOSet, union
Classes   
ResultList

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:28 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/ResultList_ResultList.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/ResultList_ResultList.py0100600000176200017510000002156007306455565033174 0ustar dhellmanndevel Class: ResultList

Table of Contents

Class: ResultList Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/ResultList.py

Methods   
__and__
__init__
__nonzero__
__or__
and_not
bucket
has_key
items
keys
near
  __and__  
__and__ ( self,  x )

  __init__  
__init__ (
        self,
        d,
        words,
        index,
        TupleType=type(() ),
        )

  __nonzero__  
__nonzero__ ( self )

  __or__  
__or__ ( self,  x )

  and_not  
and_not ( self,  x )

  bucket  
bucket ( self )

  has_key  
has_key ( self,  key )

  items  
items ( self )

  keys  
keys ( self )

  near  
near ( self,  x )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/UnIndex.py.html0100600000176200017510000000700507306455565031203 0ustar dhellmanndevel Module: UnIndex

Table of Contents

Module: UnIndex Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/UnIndex.py

Simple column indices

Imported modules   
from Acquisition import Implicit
import BTree
from BTrees.IIBTree import IITreeSet, IISet, union, intersection
from BTrees.IOBTree import IOBTree
import BTrees.Length
from BTrees.OOBTree import OOBTree, OOSet
from Globals import Persistent
import IOBTree
from Products.PluginIndexes.common.util import parseIndexRequest
import exceptions
import string
import sys
from types import StringType, ListType, IntType, TupleType
from zLOG import LOG, ERROR
Classes   
UnIndex

UnIndex object interface

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/UnIndex_UnIndex.py.html0100600000176200017510000005012007306455565032631 0ustar dhellmanndevel Class: UnIndex

Table of Contents

Class: UnIndex Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/UnIndex.py

UnIndex object interface

Base Classes   
Persistent
Implicit
Methods   
__init__
__len__
__nonzero__
_apply_index
_convertBTrees
clear
getEntryForObject
hasUniqueValuesFor
histogram
index_object
 insertForwardIndexEntry
items
keyForDocument
numObjects
referencedObjects
removeForwardIndexEntry
unindex_object
uniqueValues
  __init__  
__init__ (
        self,
        id,
        ignore_ex=None,
        call_methods=None,
        )

Create an unindex

UnIndexes are indexes that contain two index components, the forward index (like plain index objects) and an inverted index. The inverted index is so that objects can be unindexed even when the old value of the object is not known.

e.g.

self._index = {datum:[documentId1, documentId2]} self._unindex = {documentId:datum}

If any item in self._index has a length-one value, the value is an integer, and not a set. There are special cases in the code to deal with this.

The arguments are:

id

the name of the item attribute to index. This is either an attribute name or a record key.

ignore_ex

should be set to true if you want the index to ignore exceptions raised while indexing instead of propagating them.

call_methods

should be set to true if you want the index to call the attribute id (note: id should be callable!) You will also need to pass in an object in the index and uninded methods for this to work.

  __len__  
__len__ ( self )

Return the number of objects indexed.

This method is only called for indexes which have "old" BTrees, and the only reason that UnIndexes maintain a __len__ is for the searching code in the catalog during sorting.

  __nonzero__  
__nonzero__ ( self )

  _apply_index  
_apply_index (
        self,
        request,
        cid='',
        type=type,
        None=None,
        )

Apply the index to query parameters given in the request arg.

The request argument should be a mapping object.

If the request does not have a key which matches the "id" of the index instance, then None is returned.

If the request does have a key which matches the "id" of the index instance, one of a few things can happen:

  • if the value is a blank string, None is returned (in order to support requests from web forms where you can't tell a blank string from empty).

  • if the value is a nonblank string, turn the value into a single-element sequence, and proceed.

  • if the value is a sequence, return a union search.

If the request contains a parameter with the name of the column + _usage, it is sniffed for information on how to handle applying the index.

If the request contains a parameter with the name of the column = _operator this overrides the default method (or) to combine search results. Valid values are "or" and "and".

If None is not returned as a result of the abovementioned constraints, two objects are returned. The first object is a ResultSet containing the record numbers of the matching records. The second object is a tuple containing the names of all data fields used.

FAQ answer: to search a Field Index for documents that have a blank string as their value, wrap the request value up in a tuple ala: request = {'id':('',)}

Exceptions   
exepctions.RuntimeError, "operator not valid: %s" % operator
  _convertBTrees  
_convertBTrees ( self,  threshold=200 )

  clear  
clear ( self )

  getEntryForObject  
getEntryForObject (
        self,
        documentId,
        default=_marker,
        )

Takes a document ID and returns all the information we have on that specific object.

  hasUniqueValuesFor  
hasUniqueValuesFor ( self,  name )

has unique values for column NAME

  histogram  
histogram ( self )

Return a mapping which provides a histogram of the number of elements found at each point in the index.

  index_object  
index_object (
        self,
        documentId,
        obj,
        threshold=None,
        )

index and object obj with integer id documentId

  insertForwardIndexEntry  
insertForwardIndexEntry (
        self,
        entry,
        documentId,
        )

Take the entry provided and put it in the correct place in the forward index.

This will also deal with creating the entire row if necessary.

  items  
items ( self )

  keyForDocument  
keyForDocument ( self,  id )

  numObjects  
numObjects ( self )

return number of indexed objects

  referencedObjects  
referencedObjects ( self )

Generate a list of IDs for which we have referenced objects.

  removeForwardIndexEntry  
removeForwardIndexEntry (
        self,
        entry,
        documentId,
        )

Take the entry provided and remove any reference to documentId in its entry in the index.

  unindex_object  
unindex_object ( self,  documentId )

Unindex the object with integer id documentId and don't raise an exception if we fail

  uniqueValues  
uniqueValues (
        self,
        name=None,
        withLengths=0,
        )

returns the unique values for name

if withLengths is true, returns a sequence of tuples of (value, length)

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/__init__.py.html0100600000176200017510000000247107306455565031372 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/randid.py.html0100600000176200017510000000641507306455565031076 0ustar dhellmanndevel Module: randid

Table of Contents

Module: randid Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/randid.py

Imported modules   
import whrandom
Functions   
randid
  randid  
randid (
        randint=whrandom.randint,
        choice=whrandom.choice,
        signs=( -1, 1 ),
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/util.py.html0100600000176200017510000001014007306455565030600 0ustar dhellmanndevel Module: util

Table of Contents

Module: util Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/util.py

Imported modules   
import re
from types import StringType, ListType, TupleType, DictType, InstanceType
Functions   
test
  test  
test ()

Classes   
parseIndexRequest

This class provides functionality to hide the internals of a request

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:28 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/util_parseIndexRequest.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/util_parseIndexRequest.p0100600000176200017510000001303107306455565033201 0ustar dhellmanndevel Class: parseIndexRequest

Table of Contents

Class: parseIndexRequest Zope-2-CVS-src/lib/python/Products/PluginIndexes/common/util.py

This class provides functionality to hide the internals of a request send from the Catalog/ZCatalog to an index._apply_index() method.

The class understands the following type of parameters:

  • old-style parameters where the query for an index as value inside the request directory where the index name is the name of the key. Additional parameters for an index could be passed as index+"_usage" ...

  • dictionary-style parameters specify a query for an index as an entry in the request dictionary where the key corresponds to the name of the index and the key is a dictionary with the parameters passed to the index.

    Allowed keys of the parameter dictionary:

    query - contains the query (either string, list or tuple) (required)

    other parameters depend on the the index

  • record-style parameters specify a query for an index as instance of the Record class. This happens usually when parameters from a web form use the "record" type e.g. <input type="text" name="path.query:record:string">. All restrictions of the dictionary-style parameters apply to the record-style parameters

Methods   
__init__
get
  __init__  
__init__ (
        self,
        request,
        iid,
        options=[],
        )

parse a request from the ZPublisher and return a uniform datastructure back to the _apply_index() method of the index

request

the request dictionary send from the ZPublisher iid -- Id of index options -- a list of options the index is interested in

Exceptions   
self.ParserException, "record for '%s' *must* contain a 'query' attribute" % self.id
  get  
get (
        self,
        k,
        default_v=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/0040700000176200017510000000000007306455566026166 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testFieldIndex.py.html0100600000176200017510000001425407306455566032423 0ustar dhellmanndevel Module: testFieldIndex

Table of Contents

Module: testFieldIndex Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testFieldIndex.py

Imported modules   
from Products.PluginIndexes.FieldIndex.FieldIndex import FieldIndex
import ZODB
import sys
import unittest
Functions   
debug
main
pdebug
test_suite
  debug  
debug ()

  main  
main ()

  pdebug  
pdebug ()

  test_suite  
test_suite ()

Classes   
Dummy
TestCase

Test FieldIndex objects.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testFieldIndex_Dummy.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testFieldIndex_Dummy.py.h0100600000176200017510000000754607306455565033066 0ustar dhellmanndevel Class: Dummy

Table of Contents

Class: Dummy Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testFieldIndex.py

Methods   
__init__
__str__
foo
  __init__  
__init__ ( self,  foo )

  __str__  
__str__ ( self )

  foo  
foo ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testFieldIndex_TestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testFieldIndex_TestCase.p0100600000176200017510000002115207306455566033055 0ustar dhellmanndevel Class: TestCase

Table of Contents

Class: TestCase Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testFieldIndex.py

Test FieldIndex objects.

Base Classes   
unittest.TestCase
Methods   
_checkApply
_populateIndex
setUp
tearDown
testEmpty
testNone
testPopulated
testRange
testZero
  _checkApply  
_checkApply (
        self,
        req,
        expectedValues,
        )

  _populateIndex  
_populateIndex ( self )

  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

  testEmpty  
testEmpty ( self )

Test an empty FieldIndex.

  testNone  
testNone ( self )

make sure None gets indexed

  testPopulated  
testPopulated ( self )

Test a populated FieldIndex

  testRange  
testRange ( self )

Test a range search

  testZero  
testZero ( self )

Make sure 0 gets indexed

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testKeywordIndex.py.html0100600000176200017510000001437307306455566033026 0ustar dhellmanndevel Module: testKeywordIndex

Table of Contents

Module: testKeywordIndex Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testKeywordIndex.py

Imported modules   
from Products.PluginIndexes.KeywordIndex.KeywordIndex import KeywordIndex
import ZODB
import os
import sys
Functions   
debug
main
pdebug
test_suite
  debug  
debug ()

  main  
main ()

  pdebug  
pdebug ()

  test_suite  
test_suite ()

Classes   
Dummy
TestCase

Test KeywordIndex objects.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testKeywordIndex_Dummy.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testKeywordIndex_Dummy.py0100600000176200017510000000755007306455566033235 0ustar dhellmanndevel Class: Dummy

Table of Contents

Class: Dummy Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testKeywordIndex.py

Methods   
__init__
__str__
foo
  __init__  
__init__ ( self,  foo )

  __str__  
__str__ ( self )

  foo  
foo ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testKeywordIndex_TestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testKeywordIndex_TestCase0100600000176200017510000002336707306455566033232 0ustar dhellmanndevel Class: TestCase

Table of Contents

Class: TestCase Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testKeywordIndex.py

Test KeywordIndex objects.

Base Classes   
unittest.TestCase
Methods   
_checkApply
_populateIndex
setUp
tearDown
testAddObjectWOKeywords
testEmpty
testPopulated
testReindexChange
testReindexNoChange
testZero
  _checkApply  
_checkApply (
        self,
        req,
        expectedValues,
        )

  _populateIndex  
_populateIndex ( self )

  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

  testAddObjectWOKeywords  
testAddObjectWOKeywords ( self )

  testEmpty  
testEmpty ( self )

  testPopulated  
testPopulated ( self )

  testReindexChange  
testReindexChange ( self )

  testReindexNoChange  
testReindexNoChange ( self )

  testZero  
testZero ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testPathIndex.py.html0100600000176200017510000001421407306455566032270 0ustar dhellmanndevel Module: testPathIndex

Table of Contents

Module: testPathIndex Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testPathIndex.py

Imported modules   
from Products.PluginIndexes.PathIndex.PathIndex import PathIndex
import sys
import unittest
Functions   
debug
main
pdebug
test_suite
  debug  
debug ()

  main  
main ()

  pdebug  
pdebug ()

  test_suite  
test_suite ()

Classes   
Dummy
TestCase

Test PathIndex objects.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testPathIndex_Dummy.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testPathIndex_Dummy.py.ht0100600000176200017510000000764207306455566033121 0ustar dhellmanndevel Class: Dummy

Table of Contents

Class: Dummy Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testPathIndex.py

Methods   
__init__
__str__
getPhysicalPath
  __init__  
__init__ ( self,  path )

  __str__  
__str__ ( self )

  getPhysicalPath  
getPhysicalPath ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testPathIndex_TestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testPathIndex_TestCase.py0100600000176200017510000001512507306455566033122 0ustar dhellmanndevel Class: TestCase

Table of Contents

Class: TestCase Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testPathIndex.py

Test PathIndex objects.

Base Classes   
unittest.TestCase
Methods   
_populateIndex
setUp
tearDown
testEmpty
testPopulateIndex
testUnIndex
  _populateIndex  
_populateIndex ( self )

  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

  testEmpty  
testEmpty ( self )

Test an empty PathIndex.

  testPopulateIndex  
testPopulateIndex ( self )

  testUnIndex  
testUnIndex ( self )

Test to UnIndex PathIndex.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testSplitter.py.html0100600000176200017510000001374607306455566032223 0ustar dhellmanndevel Module: testSplitter

Table of Contents

Module: testSplitter Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testSplitter.py

Imported modules   
from Products.PluginIndexes.TextIndex import Splitter
import sys
import unittest
Functions   
debug
main
pdebug
test_suite
  debug  
debug ()

  main  
main ()

  pdebug  
pdebug ()

  test_suite  
test_suite ()

Classes   
TestSplitter

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testSplitter_TestSplitter.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testSplitter_TestSplitter0100600000176200017510000001267107306455566033353 0ustar dhellmanndevel Class: TestSplitter

Table of Contents

Class: TestSplitter Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testSplitter.py

Base Classes   
unittest.TestCase
Methods   
testDropNumeric
testDropSingleLetterWords
testSplitNormalText
testSplitOnNonAlpha
  testDropNumeric  
testDropNumeric ( self )

  testDropSingleLetterWords  
testDropSingleLetterWords ( self )

  testSplitNormalText  
testSplitNormalText ( self )

  testSplitOnNonAlpha  
testSplitOnNonAlpha ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testTextIndex.py.html0100600000176200017510000001605707306455566032327 0ustar dhellmanndevel Module: testTextIndex

Table of Contents

Module: testTextIndex Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testTextIndex.py

Imported modules   
from Products.PluginIndexes.TextIndex import TextIndex, GlobbingLexicon
import ZODB
import ZODB.DemoStorage
import ZODB.FileStorage
import os
import sys
import zLOG
Functions   
debug
log_write
main
pdebug
test_suite
  debug  
debug ()

  log_write  
log_write (
        subsystem,
        severity,
        summary,
        detail,
        error,
        )

  main  
main ()

  pdebug  
pdebug ()

  test_suite  
test_suite ()

Classes   
Dummy
Tests

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testTextIndex_Dummy.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testTextIndex_Dummy.py.ht0100600000176200017510000000503407306455566033142 0ustar dhellmanndevel Class: Dummy

Table of Contents

Class: Dummy Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testTextIndex.py

Methods   
__init__
  __init__  
__init__ ( self,  **kw )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testTextIndex_Tests.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testTextIndex_Tests.py.ht0100600000176200017510000003413007306455566033150 0ustar dhellmanndevel Class: Tests

Table of Contents

Class: Tests Zope-2-CVS-src/lib/python/Products/PluginIndexes/tests/testTextIndex.py

Base Classes   
unittest.TestCase
Methods   
checkAndNotQuery
checkAndQuery
checkGlobQuery
checkNearQuery
checkNonExistentWord
checkOrQuery
checkParenMatchingQuery
checkPersistentUpdate1
checkPersistentUpdate2
checkQuoteMatchingQuery
 checkSimpleAddDelete
checkTextIndexOperatorQuery
dbclose
dbopen
setUp
tearDown
  checkAndNotQuery  
checkAndNotQuery ( self )

Check an ANDNOT query

  checkAndQuery  
checkAndQuery ( self )

Check an AND query

  checkGlobQuery  
checkGlobQuery ( self )

Check a glob query

  checkNearQuery  
checkNearQuery ( self )

Check a NEAR query.. (NOTE:ACTUALLY AN OR TEST!!)

  checkNonExistentWord  
checkNonExistentWord ( self )

Check for nonexistent word

  checkOrQuery  
checkOrQuery ( self )

Check an OR query

  checkParenMatchingQuery  
checkParenMatchingQuery ( self )

Check a query with parens

  checkPersistentUpdate1  
checkPersistentUpdate1 ( self )

Check simple persistent indexing

  checkPersistentUpdate2  
checkPersistentUpdate2 ( self )

Check less simple persistent indexing

  checkQuoteMatchingQuery  
checkQuoteMatchingQuery ( self )

Check a query with quotes.. this is known to fail under 2.3.1b3-

  checkSimpleAddDelete  
checkSimpleAddDelete ( self )

Check that we can add and delete an object without error

  checkTextIndexOperatorQuery  
checkTextIndexOperatorQuery ( self )

Check a query with textindex_operator in the request

  dbclose  
dbclose ( self )

  dbopen  
dbopen ( self )

  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PluginIndexes/README.txt.html0100600000176200017510000001321207306455566027463 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PluginIndexes

Table of Contents

Zope2 CVS with ZEO: Products.PluginIndexes  

Zope 2.4 introduces a new way to register customized indexes (see PluggableIndex interface).

Changes to Indexes:

New package structure

  • The indexes (TextIndex, FieldIndex, KeywordIndex, PathIndex) shipped with the Zope 2.4 distribution now live in lib/python/Products/PluginIndexes. Every index type has now its own package containing all dependent modules, DTML management files...

  • modules used by all index types reside in the common directory

  • all dependencies from the lib/python/SearchIndex directory were removed

  • lib/python/SearchIndex is deprecated and should no longer be used. It is kept for backward compatibility.

Changes to all indexes:

  • every index type implements the PluggableIndex interface

  • common/util.py provides functionality for handling the request parameter of the _apply_index() function. _apply_index() now handles old-style ZCatalog parameters, passing of Record instances and dictionary-like parameters. See common/util.py for details.

Changes to KeywordIndex:

  • default search operator or may be overridden by specifying a new one as operator (see below)

  • internal changes

Changes to FieldIndex:

  • internal changes

Changes for PathIndex:

  • new index type

Changes to TextIndex:

  • ZMI allows to select a different vocabulary. To use a vocabulary different from the ZCatalogs default vocabulary Vocabulary you must create a new Vocabulary through the ZMI of the ZCatalog. After creating the vocabulary you can choose the vocabulary on the ZMI management screen for the text index.

  • the default operator might be overridden by specifying a new one as operator (see below)

  • removed direct dependancy from Splitter module. Splitter is now aquired from used vocabulary

  • usage of the textindex_operator is deprecated

  • lots of internal rework

Changes to Vocabulary:

  • added Splitter selection on the add formular

Changes to ZCatalog

  • Vocabulary.py moved to Products/PluginIndexes/TextIndex. A wrapper for backward compatibility is in place

  • added ZCatalogIndexes.py to provide access to indexes with pluggable index interface

Parameter passing to the ZCatalog

Parameter passing to the ZCatalog/Catalog has been enhanced and unified and is now much more logical.

  • Method 1: The old way to pass a query including parameters to an index XXX was to specify the query as value in the request dictionary. Additional parameters were passed XXX_parameter : <value> in the request dictionary. (This method is deprecated).

  • Method 2: The query and all parameters to be passed to an index XXX are passed as dictionary inside the request dictionary. Example:

    old: <dtml-in myCatalog(myindex='xx yy',myindex_usage':'blabla') new: <dtml-in myCatalog(myindex={'query':'xx yy','usage':'....'})

  • Method 3: Inside a formular you can use Record as types for parameter passing. Example:

    <form action=...> <input type=text name="person.query:record" value=""> <input type=hidden name="person.operator:record" value="and"> ..</form>

    and in the DTML method:

    <dtml-in myCatalog(person=person)>

    This example will pass both parameters as a Record instance to the index person.

All index types of Zope support all three methods. On the DTML level only method 3 type parameter should be used.

Backward compatibility:

  • any existing pre-2.4 ZCatalog should work under 2.4

  • pre-2.4 indexes of a ZCatalog are marked as pre-2.4 Index in the Index view of the ZCatalog

  • # objects is set to not available for pre-2.4 indexes

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:25 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/0040700000176200017510000000000007306455573024666 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/index.html0100600000176200017510000000662307306455573026671 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PythonMethod

Table of Contents

Zope2 CVS with ZEO: Products.PythonMethod  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/PythonMethod/

CHANGES.txt.html

1999-12-13 Evan Simpson <evan@4-am.com>

README.txt.html

Python Methods

Bindings
ExternalMethod

External Python Method

Guarded
Method

Method module

ModuleSecurity
PythonMethod

Python Method Product

__init__
standard
zbytecodehacks

Welcome to the bytecodehacks!

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/0040700000176200017510000000000007306455572027667 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/index.html0100600000176200017510000001153307306455572031666 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PythonMethod.zbytecodehacks

Table of Contents

Zope2 CVS with ZEO: Products.PythonMethod.zbytecodehacks  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/

README.html

Welcome to the bytecodehacks!

TODO.html

polish attr_freeze.

VSExec

Safe execution of arbitrary code through bytecode munging

__init__
attr_freeze
closure

\

code_editor
code_gen

Zope2 CVS with ZEO: Products.PythonMethod.zbytecodehacks.code_gen

common
cyclehandle
dbc
find_function_call
iif
inline
label
macro
macros
opbases
ops
rationalize
tailr
tests

Zope2 CVS with ZEO: Products.PythonMethod.zbytecodehacks.tests

xapply

\

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_gen/0040700000176200017510000000000007306455567031436 5ustar dhellmanndevel././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_gen/index.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_gen/index.ht0100600000176200017510000000445707306455567033113 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PythonMethod.zbytecodehacks.code_gen

Table of Contents

Zope2 CVS with ZEO: Products.PythonMethod.zbytecodehacks.code_gen  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_gen/

__init__
opexfuncread
write_ops

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_gen/__init__.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_gen/__init__0100600000176200017510000000251707306455567033124 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_gen/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016000000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_gen/opexfuncread.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_gen/opexfunc0100600000176200017510000000412107306455567033205 0ustar dhellmanndevel Module: opexfuncread

Table of Contents

Module: opexfuncread Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_gen/opexfuncread.py

Imported modules   
import os
import string

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_gen/write_ops.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_gen/write_op0100600000176200017510000001041307306455567033207 0ustar dhellmanndevel Module: write_ops

Table of Contents

Module: write_ops Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_gen/write_ops.py

Imported modules   
from bytecodehacks.code_gen import opexfuncread
import dis
import os
import re
import string
import sys
Functions   
Main
main
  Main  
Main ()

  main  
main ( file=sys.stdout )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/0040700000176200017510000000000007306455567031035 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/index.html0100600000176200017510000000516707306455567033042 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PythonMethod.zbytecodehacks.tests

Table of Contents

Zope2 CVS with ZEO: Products.PythonMethod.zbytecodehacks.tests  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/

__init__
bench
inline_test
macro_test
test
utils

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/__init__.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/__init__.py0100600000176200017510000000251407306455567033147 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/bench.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/bench.py.ht0100600000176200017510000001507007306455567033102 0ustar dhellmanndevel Module: bench

Table of Contents

Module: bench Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/bench.py

Imported modules   
import closure
Functions   
func0
func01
func1
func2
test
timing
  func0  
func0 ( x )

  func01  
func01 ( x )

  func1  
func1 (
        x,
        g1=g1,
        g2=g2,
        g3=g3,
        g4=g4,
        g5=g5,
        )

  func2  
func2 ( x )

  test  
test ()

  timing  
timing (
        func,
        args,
        n=1,
        **keywords,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/inline_test.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/inline_test0100600000176200017510000002011207306455567033270 0ustar dhellmanndevel Module: inline_test

Table of Contents

Module: inline_test Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/inline_test.py

Imported modules   
from bytecodehacks import inline, macro
import profile
Functions   
f
f2
integ_global
integ_hand
integ_local
longt
p
test
  f  
f ( x,  y )

  f2  
f2 ( (  ( )

  integ_global  
integ_global (
        dx,
        x0,
        x1,
        y,
        )

  integ_hand  
integ_hand (
        dx,
        x0,
        x1,
        y,
        )

  integ_local  
integ_local (
        dx,
        f,
        x0,
        x1,
        y,
        )

  longt  
longt ( n )

  p  
p ( n )

  test  
test ( param=0.00001 )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/macro_test.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/macro_test.0100600000176200017510000001071607306455567033202 0ustar dhellmanndevel Module: macro_test

Table of Contents

Module: macro_test Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/macro_test.py

Imported modules   
from bytecodehacks import macro
Functions   
f
incr
postincr
  f  
f ( x )

  incr  
incr ( ( )

  postincr  
postincr ( ( )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/test.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/test.py.htm0100600000176200017510000000756007306455567033164 0ustar dhellmanndevel Module: test

Table of Contents

Module: test Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/test.py

Imported modules   
from bytecodehacks import code_editor, ops, attr_freeze
import sys
Functions   
f
ff
  f  
f ()

  ff  
ff ( x )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/utils.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/utils.py.ht0100600000176200017510000000674207306455567033171 0ustar dhellmanndevel Module: utils

Table of Contents

Module: utils Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tests/utils.py

Imported modules   
import dis
import os
import sys
import tempfile
Functions   
diff_funcs
  diff_funcs  
diff_funcs ( f1,  f2 )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec.py.html0100600000176200017510000004612507306455567032354 0ustar dhellmanndevel Module: VSExec

Table of Contents

Module: VSExec Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec.py

Safe execution of arbitrary code through bytecode munging

CodeBlock is a base class for bytecode munging of code strings. Derived classes should override forbid and Mungers. The class constructor takes a function name, a parameter string, and a function body string. It combines the name, parameters, and body into a function (indented one space), compiles it, and then examines its bytecode.

Any bytecode whose opcode is a key in forbid with a true value may not appear in the compiled code.

Each object in Mungers is called with the code window object (at start) and the variable name information for the function. Mungers can use this opportunity to examine the code and variables, and perform setup operations. The value returned from the call is discarded if false, otherwise it is assumed to be a collection of bytecode-specific functions.

The code window object is passed over the bytecodes, maintaining a stack of "responsible" opcodes. At any given position, the size of the stack should be the same as the size of the run-time stack would be when that part of the code is executing, and the top of the stack would have been put there by the "responsible" opcode.

At each position, the mungers are examined to see if they have a function corresponding to the current opcode. If so, the function is called with the code window object. The function can then use the code window object to examine or change the bytecode.

Once all processing is done, and if there have not been any errors, the compiled, edited function is converted into a pickleable tuple, which is stored as attribute t of the resulting instance. In order for this to work, mungers must not place unpickleable objects into the list of constants. In order for unpickling to be robust, they should not place any function objects there either. If a function must be provided for use in the bytecode, it should be loaded from the global dictionary, preferably with an illegal name.

Imported modules   
from closure import bind
import code_editor
import new
import ops
from string import replace, join
import sys
from types import FunctionType
Functions   
GuardedBinaryOps
PublicNames
RedirectReads
RedirectWrites
UntupleFunction
_ReadGuard
_SLICE
_WriteGuard
_WriteGuardWrapper
_get_call
 _join_printed
_print_handler
_wrap
test
  GuardedBinaryOps  
GuardedBinaryOps ( guards )

Allow operations to be Guarded, by replacing them with guard calls.

Construct a munging object which will replace specific opcodes with calls to methods of a guard object. The guard object must appear in the global dictionary as $guard.

  PublicNames  
PublicNames (
        cb,
        w,
        fc,
        )

Restrict access to all but public names

Forbid use of any multi-character name starting with _

Exceptions   
SyntaxError, ('Names starting with "_" are not allowed (%s).' % join( protected, ', ' ) )
  RedirectReads  
RedirectReads ()

Redirect LOAD_* on objects to methods

Construct a munging object which will wrap all objects which are the target of a LOAD op by passing them to a guard function. The guard function must appear in the global dictionary as $read_guard.

  RedirectWrites  
RedirectWrites ()

Redirect STORE_* and DELETE_* on objects to methods

Construct a munging object which will wrap all objects which are the target of a STORE or DELETE op by passing them to a guard function. The guard function must appear in the global dictionary as $write_guard.

  UntupleFunction  
UntupleFunction (
        t,
        special_globals,
        **globals,
        )

  _ReadGuard  
_ReadGuard ( ob )

  _SLICE  
_SLICE ( w )

  _WriteGuard  
_WriteGuard ( ob )

  _WriteGuardWrapper  
_WriteGuardWrapper ()

Exceptions   
TypeError, error_msg
  _get_call  
_get_call ( w )

  _join_printed  
_join_printed ( printlist )

  _print_handler  
_print_handler ( printlist,  *txt )

  _wrap  
_wrap ( w )

  test  
test ( p,  c )

Classes   
AllowMapBuild

Allow literal mappings to be constructed unmunged

CodeBlock

Compile a string containing Python code, with restrictions

ForbiddenOp
LoopLimits

Try to prevent "excessive" iteration and recursion

Munge_window
Printing

Intercept print statements

SafeBlock
Warning
_GuardedOps

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015700000000000011570 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec_AllowMapBuild.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec_AllowMapBu0100600000176200017510000000664407306455567033047 0ustar dhellmanndevel Class: AllowMapBuild

Table of Contents

Class: AllowMapBuild Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec.py

Allow literal mappings to be constructed unmunged

Optimize construction of literal dictionaries, which requires STORE_SUBSCR, by checking the stack.

Methods   
STORE_SUBSCR
__init__
  STORE_SUBSCR  
STORE_SUBSCR ( self,  w )

  __init__  
__init__ (
        self,
        cb,
        w,
        fc,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec_CodeBlock.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec_CodeBlock.0100600000176200017510000001137007306455567032737 0ustar dhellmanndevel Class: CodeBlock

Table of Contents

Class: CodeBlock Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec.py

Compile a string containing Python code, with restrictions

Methods   
__call__
__init__
munge
  __call__  
__call__ (
        self,
        *args,
        *kargs,
        )

  __init__  
__init__ (
        self,
        src,
        name='<function>',
        filename='<string>',
        )

Exceptions   
SyntaxError, 'string did not define a function'
  munge  
munge (
        self,
        fc,
        depth=0,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec_ForbiddenOp.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec_ForbiddenO0100600000176200017510000000371707306455567033055 0ustar dhellmanndevel Class: ForbiddenOp

Table of Contents

Class: ForbiddenOp Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec.py

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec_LoopLimits.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec_LoopLimits0100600000176200017510000001045107306455567033126 0ustar dhellmanndevel Class: LoopLimits

Table of Contents

Class: LoopLimits Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec.py

Try to prevent "excessive" iteration and recursion

Loop ends, continue statements, and function entry points all call a hook function, which can keep track of iteration and call depth, and raise an exception to terminate processing.

The hook function should be provided in the global dictionary as $loop_watcher

Methods   
JUMP_ABSOLUTE
__init__
finalize
  JUMP_ABSOLUTE  
JUMP_ABSOLUTE ( self,  w )

  __init__  
__init__ (
        self,
        cb,
        w,
        fc,
        )

  finalize  
finalize ( self,  w )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015600000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec_Munge_window.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec_Munge_wind0100600000176200017510000002052407306455567033131 0ustar dhellmanndevel Class: Munge_window

Table of Contents

Class: Munge_window Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec.py

Methods   
__init__
advance
after_code_for
assert_stack_size
clear_stack
do_op
insert_code
set_code
  __init__  
__init__ (
        self,
        code,
        use_stack,
        )

  advance  
advance ( self )

  after_code_for  
after_code_for ( self,  stack_idx )

  assert_stack_size  
assert_stack_size (
        self,
        size,
        ctxt,
        )

Exceptions   
Warning, ('PythonMethod Bug: %s objects were on the stack ' '%s when only %s should be.' %( len( self.stack ), ctxt, size ) )
  clear_stack  
clear_stack ( self )

  do_op  
do_op ( self )

  insert_code  
insert_code (
        self,
        rcode,
        at=None,
        )

  set_code  
set_code (
        self,
        rct=1,
        rcode=(),
        )

Replace "rct" bytecodes at current position with "rcode"

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec_Printing.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec_Printing.p0100600000176200017510000001465307306455567033073 0ustar dhellmanndevel Class: Printing

Table of Contents

Class: Printing Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec.py

Intercept print statements

Print statements are either converted to no-ops, or replaced with calls to a handler. The default handler _print_handler appends the intended output to a list. printed is made into a reserved name which can only be used to read the result of _join_printed.

_print_handler and _join_printed should be provided in the global dictionary as $print_handler and $join_printed

Methods   
LOAD_GLOBAL
PRINT_ITEM
PRINT_NEWLINE
__init__
finalize
  LOAD_GLOBAL  
LOAD_GLOBAL ( self,  w )

  PRINT_ITEM  
PRINT_ITEM ( self,  w )

  PRINT_NEWLINE  
PRINT_NEWLINE ( self,  w )

  __init__  
__init__ (
        self,
        cb,
        w,
        fc,
        )

Exceptions   
SyntaxError, '"printed" is a reserved word.'
  finalize  
finalize ( self,  w )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec_SafeBlock.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec_SafeBlock.0100600000176200017510000000376207306455567032751 0ustar dhellmanndevel Class: SafeBlock

Table of Contents

Class: SafeBlock Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec.py

Base Classes   
CodeBlock

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec_Warning.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec_Warning.py0100600000176200017510000000370707306455567033075 0ustar dhellmanndevel Class: Warning

Table of Contents

Class: Warning Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec.py

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec__GuardedOps.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec__GuardedOp0100600000176200017510000000512607306455567033047 0ustar dhellmanndevel Class: _GuardedOps

Table of Contents

Class: _GuardedOps Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/VSExec.py

Methods   
__call__
  __call__  
__call__ (
        self,
        cb,
        w,
        fc,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/__init__.py.html0100600000176200017510000000250007306455567032743 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/attr_freeze.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/attr_freeze.py.ht0100600000176200017510000001313307306455567033171 0ustar dhellmanndevel Module: attr_freeze

Table of Contents

Module: attr_freeze Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/attr_freeze.py

Imported modules   
from code_editor import Function
from ops import LOAD_GLOBAL, LOAD_ATTR, LOAD_CONST
Functions   
freeze_attrs
freeze_one_attr
  freeze_attrs  
freeze_attrs ( func,  *vars )

Exceptions   
TypeError, "wrong number of arguments"
  freeze_one_attr  
freeze_one_attr (
        cs,
        code,
        attr,
        value,
        )

Classes   
Ref

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/attr_freeze_Ref.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/attr_freeze_Ref.p0100600000176200017510000001112307306455567033157 0ustar dhellmanndevel Class: Ref

Table of Contents

Class: Ref Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/attr_freeze.py

Methods   
__call__
__getattr__
__init__
__repr__
  __call__  
__call__ ( self )

  __getattr__  
__getattr__ ( self,  attr )

  __init__  
__init__ ( self,  name=() )

  __repr__  
__repr__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/closure.py.html0100600000176200017510000002262207306455567032667 0ustar dhellmanndevel Module: closure

Table of Contents

Module: closure Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/closure.py

\ closure

implements a form of closures by abusing the co_consts field of a code object.

exports: bind, bind_locals, bind_now and contains two examples: make_adder, make_balance

Imported modules   
from code_editor import Function
from ops import *
Functions   
bind
bind_locals
bind_now
make_adder
make_balance
scan_for_STORE
  bind  
bind (
        function,
        newname=None,
        **vars,
        )

bind(function[,newname],var1=value1,var2=value2,...) -> function

returns a new function (optionally renamed) where every reference to one of var1, var2, etc is replaced by a reference to the respective valueN.

  bind_locals  
bind_locals ( func )

bind_locals(func) -> function

returns a new function where every global variable reference in func is replaced, if possible, by a reference to a local variable in the callers context.

Exceptions   
""
  bind_now  
bind_now ( func )

bind_now(func) -> function

returns a new function where every global variable reference in func is replaced, if possible, by a reference to a variable in the callers context.

Exceptions   
""
  make_adder  
make_adder ( n )

make_adder(n) -> function

return a monadic function that adds n to its argument.

  make_balance  
make_balance ( initial_amount )

make_balance(initial_amount) -> function

demonstrates an object with state, sicp style.

Exceptions   
"debt!"
  scan_for_STORE  
scan_for_STORE ( func,  name )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor.py.ht0100600000176200017510000001043207306455567033136 0ustar dhellmanndevel Module: code_editor

Table of Contents

Module: code_editor Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor.py

Imported modules   
import StringIO
from cyclehandle import CycleHandle
import new
import ops
import struct
import types
Classes   
CodeString
CodeStringWorker
EditableCode
EditableCodeWorker
Function
FunctionOrMethod
FunctionWorker
InstanceMethod
InstanceMethodWorker

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016100000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_CodeString.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_CodeS0100600000176200017510000000635607306455567033164 0ustar dhellmanndevel Class: CodeString

Table of Contents

Class: CodeString Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor.py

Base Classes   
CycleHandle
Methods   
__init__
  __init__  
__init__ (
        self,
        cs=None,
        bytecodes=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016700000000000011571 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_CodeStringWorker.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_CodeS0100600000176200017510000003551507306455567033163 0ustar dhellmanndevel Class: CodeStringWorker

Table of Contents

Class: CodeStringWorker Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor.py

Methods   
__delitem__
__delslice__
__getitem__
__getslice__
__init__
__len__
__setitem__
__setslice__
add_label
append
 assemble
disassemble
disassemble_no_code
find_labels
index
insert
remove
set_code
  __delitem__  
__delitem__ ( self,  index )

  __delslice__  
__delslice__ (
        self,
        lo,
        hi,
        )

  __getitem__  
__getitem__ ( self,  index )

  __getslice__  
__getslice__ (
        self,
        lo,
        hi,
        )

  __init__  
__init__ (
        self,
        cs,
        bytecodes,
        )

  __len__  
__len__ ( self )

  __setitem__  
__setitem__ (
        self,
        index,
        value,
        )

  __setslice__  
__setslice__ (
        self,
        lo,
        hi,
        values,
        )

  add_label  
add_label ( self,  label )

  append  
append ( self,  value )

  assemble  
assemble ( self )

  disassemble  
disassemble (
        self,
        code,
        bytecodes,
        )

  disassemble_no_code  
disassemble_no_code (
        self,
        codestring,
        bytecodes,
        )

  find_labels  
find_labels ( self,  index )

  index  
index ( self,  x )

  insert  
insert (
        self,
        index,
        value,
        )

  remove  
remove ( self,  x )

  set_code  
set_code ( self,  code )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016300000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_EditableCode.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_Edita0100600000176200017510000000630407306455567033206 0ustar dhellmanndevel Class: EditableCode

Table of Contents

Class: EditableCode Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor.py

Base Classes   
CycleHandle
Methods   
__init__
  __init__  
__init__ ( self,  code=None )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017100000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_EditableCodeWorker.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_Edita0100600000176200017510000002461707306455567033215 0ustar dhellmanndevel Class: EditableCodeWorker

Table of Contents

Class: EditableCodeWorker Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor.py

Methods   
__init__
as_tuple
init_code
init_defaults
init_tuple
local_index
make_code
name_index
rationalize
set_filename
 set_function
set_name
  __init__  
__init__ ( self,  code=None )

  as_tuple  
as_tuple ( self )

  init_code  
init_code ( self,  code )

  init_defaults  
init_defaults ( self )

  init_tuple  
init_tuple ( self,  tup )

  local_index  
local_index ( self,  name )

  make_code  
make_code ( self )

  name_index  
name_index ( self,  name )

  rationalize  
rationalize ( self )

  set_filename  
set_filename ( self,  filename )

  set_function  
set_function ( self,  function )

  set_name  
set_name ( self,  name )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015700000000000011570 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_Function.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_Funct0100600000176200017510000000627407306455567033245 0ustar dhellmanndevel Class: Function

Table of Contents

Class: Function Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor.py

Base Classes   
CycleHandle
Methods   
__init__
  __init__  
__init__ ( self,  func=None )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016700000000000011571 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_FunctionOrMethod.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_Funct0100600000176200017510000000650307306455567033240 0ustar dhellmanndevel Class: FunctionOrMethod

Table of Contents

Class: FunctionOrMethod Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor.py

Methods   
__init__
make_function_or_method
  __init__  
__init__ ( self,  functionormethod )

  make_function_or_method  
make_function_or_method ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016500000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_FunctionWorker.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_Funct0100600000176200017510000002333207306455567033237 0ustar dhellmanndevel Class: FunctionWorker

Table of Contents

Class: FunctionWorker Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor.py

Methods   
__call__
__getattr__
__init__
__setattr__
as_tuple
init_defaults
init_func
init_tuple
make_function
set_method
  __call__  
__call__ (
        self,
        *args,
        *kw,
        )

  __getattr__  
__getattr__ ( self,  attr )

Exceptions   
AttributeError, attr
  __init__  
__init__ ( self,  func )

  __setattr__  
__setattr__ (
        self,
        attr,
        value,
        )

  as_tuple  
as_tuple ( self )

  init_defaults  
init_defaults ( self )

  init_func  
init_func ( self,  func )

  init_tuple  
init_tuple ( self,  tup )

  make_function  
make_function ( self )

  set_method  
set_method ( self,  method )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016500000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_InstanceMethod.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_Insta0100600000176200017510000000631007306455567033233 0ustar dhellmanndevel Class: InstanceMethod

Table of Contents

Class: InstanceMethod Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor.py

Base Classes   
CycleHandle
Methods   
__init__
  __init__  
__init__ ( self,  meth=None )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017300000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_InstanceMethodWorker.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor_Insta0100600000176200017510000001127507306455567033241 0ustar dhellmanndevel Class: InstanceMethodWorker

Table of Contents

Class: InstanceMethodWorker Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/code_editor.py

Methods   
__init__
init_defaults
init_meth
make_instance_method
  __init__  
__init__ ( self,  meth )

  init_defaults  
init_defaults ( self )

  init_meth  
init_meth ( self,  meth )

  make_instance_method  
make_instance_method ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/common.py.html0100600000176200017510000000703007306455567032477 0ustar dhellmanndevel Module: common

Table of Contents

Module: common Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/common.py

Imported modules   
import new
Functions   
copy_code_with_changes
  copy_code_with_changes  
copy_code_with_changes (
        codeobject,
        argcount=None,
        nlocals=None,
        stacksize=None,
        flags=None,
        code=None,
        consts=None,
        names=None,
        varnames=None,
        filename=None,
        name=None,
        firstlineno=None,
        lnotab=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/cyclehandle.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/cyclehandle.py.ht0100600000176200017510000000645007306455567033136 0ustar dhellmanndevel Module: cyclehandle

Table of Contents

Module: cyclehandle Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/cyclehandle.py

Functions   
_test
  _test  
_test ()

Classes   
CycleHandle

CycleHandles are proxies for cycle roots

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016200000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/cyclehandle_CycleHandle.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/cyclehandle_Cycle0100600000176200017510000002015307306455567033210 0ustar dhellmanndevel Class: CycleHandle

Table of Contents

Class: CycleHandle Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/cyclehandle.py

CycleHandles are proxies for cycle roots

A CycleHandle subclass should create one or more workers, and pass them to _set_workers. These workers can then participate in cycles, as long as deleting all of the worker's attributes will break the cycle. When a CycleHandle instance goes away, it deletes all attributes of all of its workers. You could also explicitly call drop_workers.

For example, >>> class Ham: ... def __del__(self): ... print A ham has died! ... >>> ct = CycleHandle() >>> ct._set_workers(Ham(), Ham()) >>> ct._workers[0].ham2 = ct._workers[1] >>> ct._workers[1].ham1 = ct._workers[0] >>> del ct A ham has died! A ham has died!

Methods   
__del__
__getattr__
__setattr__
_drop_workers
_not_mutable
_set_workers
  __del__  
__del__ ( self,  drop_workers=_drop_workers )

  __getattr__  
__getattr__ ( self,  attr )

Exceptions   
AttributeError, attr
  __setattr__  
__setattr__ (
        self,
        attr,
        val,
        )

  _drop_workers  
_drop_workers ( self )

  _not_mutable  
_not_mutable ( self,  *x )

Exceptions   
TypeError, 'CycleHandle is not mutable'
  _set_workers  
_set_workers ( self,  *workers )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/dbc.py.html0100600000176200017510000000622707306455570031740 0ustar dhellmanndevel Module: dbc

Table of Contents

Module: dbc Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/dbc.py

Imported modules   
from code_editor import Function
import dis
import new
from ops import *
import string
Classes   
Contracts
Uncontracted

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/dbc_Contracts.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/dbc_Contracts.py.0100600000176200017510000000774107306455570033075 0ustar dhellmanndevel Class: Contracts

Table of Contents

Class: Contracts Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/dbc.py

Methods   
class_invariants
post_do
pre___init__
  class_invariants  
class_invariants ( self )

  post_do  
post_do ( self )

  pre___init__  
pre___init__ (
        self,
        x,
        y,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/dbc_Uncontracted.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/dbc_Uncontracted.0100600000176200017510000000633607306455570033136 0ustar dhellmanndevel Class: Uncontracted

Table of Contents

Class: Uncontracted Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/dbc.py

Methods   
__init__
do
  __init__  
__init__ (
        self,
        x,
        y,
        )

  do  
do ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/find_function_call.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/find_function_cal0100600000176200017510000001575607306455570033271 0ustar dhellmanndevel Module: find_function_call

Table of Contents

Module: find_function_call Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/find_function_call.py

Imported modules   
from code_editor import Function
from ops import *
Functions   
call_stack_length_usage
find_function_call
simulate_stack
simulate_stack_with_keywords
  call_stack_length_usage  
call_stack_length_usage ( arg )

  find_function_call  
find_function_call (
        infunc,
        calledfuncname,
        allowkeywords=0,
        startindex=0,
        )

  simulate_stack  
simulate_stack ( code,  index_start )

Exceptions   
"no call found!"
  simulate_stack_with_keywords  
simulate_stack_with_keywords ( code,  index_start )

Exceptions   
"no call found!"

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/iif.py.html0100600000176200017510000000666007306455570031760 0ustar dhellmanndevel Module: iif

Table of Contents

Module: iif Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/iif.py

Imported modules   
from code_editor import Function
from find_function_call import find_function_call
from ops import *
Functions   
iifize
  iifize  
iifize ( func )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/inline.py.html0100600000176200017510000001433307306455570032463 0ustar dhellmanndevel Module: inline

Table of Contents

Module: inline Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/inline.py

Imported modules   
from code_editor import Function
import dis
from find_function_call import find_function_call
from ops import LOAD_GLOBAL, RETURN_VALUE, SET_LINENO, CALL_FUNCTION, JUMP_FORWARD, STORE_FAST
Functions   
inline
inline1
munge_code
  inline  
inline ( func,  **funcs )

  inline1  
inline1 (
        func,
        funcname,
        function,
        )

Exceptions   
RuntimeError, "are we trying to inline a recursive function here?"
TypeError, "keyword parameter redefined"
TypeError, "not enough arguments; expected %d, got %d" %(ac, len( lf ) + len( posargs ) )
TypeError, "too many arguments; expected %d, got %d" %(ac, len( lf ) + len( posargs ) )
TypeError, "unexpected keyword argument: %s" % i
  munge_code  
munge_code ( function,  code )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/label.py.html0100600000176200017510000000524207306455570032263 0ustar dhellmanndevel Module: label

Table of Contents

Module: label Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/label.py

Imported modules   
import struct
Classes   
Label

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/label_Label.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/label_Label.py.ht0100600000176200017510000001656307306455570033041 0ustar dhellmanndevel Class: Label

Table of Contents

Class: Label Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/label.py

Methods   
__getattr__
__init__
__setattr__
add_absref
add_relref
resolve
write_refs
  __getattr__  
__getattr__ ( self,  attr )

Exceptions   
AttributeError, attr
  __init__  
__init__ ( self,  byte=None )

  __setattr__  
__setattr__ (
        self,
        attr,
        value,
        )

  add_absref  
add_absref ( self,  byte )

  add_relref  
add_relref ( self,  byte )

  resolve  
resolve ( self,  code )

  write_refs  
write_refs ( self,  cs )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/macro.py.html0100600000176200017510000002303407306455570032304 0ustar dhellmanndevel Module: macro

Table of Contents

Module: macro Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/macro.py

Imported modules   
from code_editor import Function
import dis
from find_function_call import find_function_call
from ops import *
Functions   
add_macro
expand
expand1
expand_these
global_to_local
munge_code
remove_epilogue
  add_macro  
add_macro ( arg1,  arg2=None )

  expand  
expand ( func,  macros=None )

Exceptions   
RuntimeError, "unbounded recursion?!"
  expand1  
expand1 (
        func,
        name,
        macro,
        )

Exceptions   
RuntimeError, "are we trying to expand a recursive macro here?"
TypeError, "imported arg must be local"
TypeError, "not enough arguments; expected %d, got %d" %( args_expected, args_got )
TypeError, "too many arguments; expected %d, got %d" %( args_expected, args_got )
  expand_these  
expand_these ( func,  **macros )

  global_to_local  
global_to_local ( code,  name )

internal function to make a global variable into a local one, for the case that setq is the first reference to a variable. Modifies a code object in-place. Return value is index into variable table

  munge_code  
munge_code (
        function,
        code,
        imported_locals,
        )

  remove_epilogue  
remove_epilogue ( cs )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/macros.py.html0100600000176200017510000000751407306455570032474 0ustar dhellmanndevel Module: macros

Table of Contents

Module: macros Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/macros.py

Imported modules   
from macro import add_macro
Functions   
main
test
  main  
main ()

  test  
test ()

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases.py.html0100600000176200017510000000775207306455570032650 0ustar dhellmanndevel Module: opbases

Table of Contents

Module: opbases Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases.py

Imported modules   
import dis
from label import Label
import new
import struct
Classes   
ByteCode
GenericOneByteCode
GenericThreeByteCode
JAbs
JRel
Jump
LocalOpcode
NameOpcode
_NamedOpcode

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases_ByteCode.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases_ByteCode.0100600000176200017510000000247507306455570033107 0ustar dhellmanndevel Class: ByteCode

Table of Contents

Class: ByteCode Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016500000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases_GenericOneByteCode.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases_GenericOn0100600000176200017510000001657307306455570033210 0ustar dhellmanndevel Class: GenericOneByteCode

Table of Contents

Class: GenericOneByteCode Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases.py

Base Classes   
ByteCode
Methods   
__init__
__repr__
assemble
has_local
has_name
has_name_or_local
is_jump
  __init__  
__init__ (
        self,
        cs,
        code,
        )

  __repr__  
__repr__ ( self )

  assemble  
assemble ( self,  code )

  has_local  
has_local ( self )

  has_name  
has_name ( self )

  has_name_or_local  
has_name_or_local ( self )

  is_jump  
is_jump ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016700000000000011571 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases_GenericThreeByteCode.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases_GenericTh0100600000176200017510000001262607306455570033202 0ustar dhellmanndevel Class: GenericThreeByteCode

Table of Contents

Class: GenericThreeByteCode Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases.py

Base Classes   
GenericOneByteCode
Methods   
__init__
__repr__
assemble
user_init
  __init__  
__init__ (
        self,
        cs,
        code,
        )

  __repr__  
__repr__ ( self )

  assemble  
assemble ( self,  code )

  user_init  
user_init ( self,  arg )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases_JAbs.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases_JAbs.py.h0100600000176200017510000001022507306455570033017 0ustar dhellmanndevel Class: JAbs

Table of Contents

Class: JAbs Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases.py

Base Classes   
Jump
Methods   
__init__
assemble
  __init__  
__init__ (
        self,
        cs,
        code,
        )

  assemble  
assemble ( self,  code )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases_JRel.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases_JRel.py.h0100600000176200017510000001022507306455570033034 0ustar dhellmanndevel Class: JRel

Table of Contents

Class: JRel Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases.py

Base Classes   
Jump
Methods   
__init__
assemble
  __init__  
__init__ (
        self,
        cs,
        code,
        )

  assemble  
assemble ( self,  code )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases_Jump.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases_Jump.py.h0100600000176200017510000001134407306455570033116 0ustar dhellmanndevel Class: Jump

Table of Contents

Class: Jump Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases.py

Base Classes   
GenericThreeByteCode
Methods   
__repr__
is_jump
user_init
  __repr__  
__repr__ ( self )

  is_jump  
is_jump ( self )

  user_init  
user_init ( self,  arg )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015600000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases_LocalOpcode.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases_LocalOpco0100600000176200017510000001155407306455570033204 0ustar dhellmanndevel Class: LocalOpcode

Table of Contents

Class: LocalOpcode Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases.py

Base Classes   
_NamedOpcode
Methods   
__init__
assemble
has_local
  __init__  
__init__ (
        self,
        cs,
        code,
        )

  assemble  
assemble ( self,  code )

  has_local  
has_local ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases_NameOpcode.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases_NameOpcod0100600000176200017510000001154507306455570033176 0ustar dhellmanndevel Class: NameOpcode

Table of Contents

Class: NameOpcode Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases.py

Base Classes   
_NamedOpcode
Methods   
__init__
assemble
has_name
  __init__  
__init__ (
        self,
        cs,
        code,
        )

  assemble  
assemble ( self,  code )

  has_name  
has_name ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015700000000000011570 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases__NamedOpcode.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases__NamedOpc0100600000176200017510000001010507306455570033145 0ustar dhellmanndevel Class: _NamedOpcode

Table of Contents

Class: _NamedOpcode Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/opbases.py

Base Classes   
GenericThreeByteCode
Methods   
__repr__
user_init
  __repr__  
__repr__ ( self )

  user_init  
user_init ( self,  arg )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py.html0100600000176200017510000003130507306455572032006 0ustar dhellmanndevel Module: ops

Table of Contents

Module: ops Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Imported modules   
from label import Label
import opbases
Classes   
BINARY_ADD
BINARY_AND
BINARY_DIVIDE
BINARY_LSHIFT
BINARY_MODULO
BINARY_MULTIPLY
BINARY_OR
BINARY_POWER
BINARY_RSHIFT
BINARY_SUBSCR
BINARY_SUBTRACT
BINARY_XOR
BREAK_LOOP
BUILD_CLASS
BUILD_LIST
BUILD_MAP
BUILD_SLICE
BUILD_TUPLE
CALL_FUNCTION
COMPARE_OP
DELETE_ATTR
DELETE_FAST
DELETE_GLOBAL
DELETE_NAME
DELETE_SLICE_0
DELETE_SLICE_1
DELETE_SLICE_2
DELETE_SLICE_3
DELETE_SUBSCR
DUP_TOP
END_FINALLY
EXEC_STMT
FOR_LOOP
IMPORT_FROM
IMPORT_NAME
JUMP_ABSOLUTE
JUMP_FORWARD
JUMP_IF_FALSE
JUMP_IF_TRUE
LOAD_ATTR
LOAD_CONST
LOAD_FAST
LOAD_GLOBAL
LOAD_LOCALS
LOAD_NAME
MAKE_FUNCTION
POP_BLOCK
POP_TOP
PRINT_EXPR
PRINT_ITEM
PRINT_NEWLINE
RAISE_VARARGS
RETURN_VALUE
ROT_THREE
ROT_TWO
SETUP_EXCEPT
SETUP_FINALLY
SETUP_LOOP
SET_LINENO
SLICE_0
SLICE_1
SLICE_2
SLICE_3
STOP_CODE
STORE_ATTR
STORE_FAST
STORE_GLOBAL
STORE_NAME
STORE_SLICE_0
STORE_SLICE_1
STORE_SLICE_2
STORE_SLICE_3
STORE_SUBSCR
UNARY_CONVERT
UNARY_INVERT
UNARY_NEGATIVE
UNARY_NOT
UNARY_POSITIVE
UNPACK_LIST
UNPACK_TUPLE

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_ADD.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_ADD.py0100600000176200017510000000765007306455570032563 0ustar dhellmanndevel Class: BINARY_ADD

Table of Contents

Class: BINARY_ADD Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_AND.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_AND.py0100600000176200017510000000765007306455570032575 0ustar dhellmanndevel Class: BINARY_AND

Table of Contents

Class: BINARY_AND Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_DIVIDE.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_DIVIDE0100600000176200017510000000765607306455570032516 0ustar dhellmanndevel Class: BINARY_DIVIDE

Table of Contents

Class: BINARY_DIVIDE Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_LSHIFT.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_LSHIFT0100600000176200017510000000765607306455570032543 0ustar dhellmanndevel Class: BINARY_LSHIFT

Table of Contents

Class: BINARY_LSHIFT Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_MODULO.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_MODULO0100600000176200017510000000765607306455570032551 0ustar dhellmanndevel Class: BINARY_MODULO

Table of Contents

Class: BINARY_MODULO Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015600000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_MULTIPLY.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_MULTIP0100600000176200017510000000766207306455570032561 0ustar dhellmanndevel Class: BINARY_MULTIPLY

Table of Contents

Class: BINARY_MULTIPLY Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_OR.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_OR.py.0100600000176200017510000000764607306455570032576 0ustar dhellmanndevel Class: BINARY_OR

Table of Contents

Class: BINARY_OR Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_POWER.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_POWER.0100600000176200017510000000765407306455570032522 0ustar dhellmanndevel Class: BINARY_POWER

Table of Contents

Class: BINARY_POWER Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_RSHIFT.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_RSHIFT0100600000176200017510000000765607306455570032551 0ustar dhellmanndevel Class: BINARY_RSHIFT

Table of Contents

Class: BINARY_RSHIFT Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_SUBSCR.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_SUBSCR0100600000176200017510000000765607306455570032553 0ustar dhellmanndevel Class: BINARY_SUBSCR

Table of Contents

Class: BINARY_SUBSCR Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015600000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_SUBTRACT.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_SUBTRA0100600000176200017510000000766207306455570032547 0ustar dhellmanndevel Class: BINARY_SUBTRACT

Table of Contents

Class: BINARY_SUBTRACT Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_XOR.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BINARY_XOR.py0100600000176200017510000000765007306455570032643 0ustar dhellmanndevel Class: BINARY_XOR

Table of Contents

Class: BINARY_XOR Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BREAK_LOOP.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BREAK_LOOP.py0100600000176200017510000001107007306455570032573 0ustar dhellmanndevel Class: BREAK_LOOP

Table of Contents

Class: BREAK_LOOP Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Exceptions   
"No jumps here!"

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BUILD_CLASS.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BUILD_CLASS.p0100600000176200017510000000765207306455570032524 0ustar dhellmanndevel Class: BUILD_CLASS

Table of Contents

Class: BUILD_CLASS Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BUILD_LIST.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BUILD_LIST.py0100600000176200017510000000765207306455570032623 0ustar dhellmanndevel Class: BUILD_LIST

Table of Contents

Class: BUILD_LIST Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericThreeByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BUILD_MAP.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BUILD_MAP.py.0100600000176200017510000000765007306455570032541 0ustar dhellmanndevel Class: BUILD_MAP

Table of Contents

Class: BUILD_MAP Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericThreeByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BUILD_SLICE.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BUILD_SLICE.p0100600000176200017510000000765407306455570032520 0ustar dhellmanndevel Class: BUILD_SLICE

Table of Contents

Class: BUILD_SLICE Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericThreeByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BUILD_TUPLE.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_BUILD_TUPLE.p0100600000176200017510000000765407306455570032552 0ustar dhellmanndevel Class: BUILD_TUPLE

Table of Contents

Class: BUILD_TUPLE Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericThreeByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_CALL_FUNCTION.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_CALL_FUNCTION0100600000176200017510000000766007306455570032521 0ustar dhellmanndevel Class: CALL_FUNCTION

Table of Contents

Class: CALL_FUNCTION Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericThreeByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_COMPARE_OP.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_COMPARE_OP.py0100600000176200017510000000765207306455570032615 0ustar dhellmanndevel Class: COMPARE_OP

Table of Contents

Class: COMPARE_OP Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericThreeByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_ATTR.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_ATTR.p0100600000176200017510000000764207306455570032533 0ustar dhellmanndevel Class: DELETE_ATTR

Table of Contents

Class: DELETE_ATTR Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.NameOpcode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_FAST.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_FAST.p0100600000176200017510000000764307306455570032517 0ustar dhellmanndevel Class: DELETE_FAST

Table of Contents

Class: DELETE_FAST Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.LocalOpcode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_GLOBAL.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_GLOBAL0100600000176200017510000000764607306455570032467 0ustar dhellmanndevel Class: DELETE_GLOBAL

Table of Contents

Class: DELETE_GLOBAL Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.NameOpcode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_NAME.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_NAME.p0100600000176200017510000000764207306455570032501 0ustar dhellmanndevel Class: DELETE_NAME

Table of Contents

Class: DELETE_NAME Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.NameOpcode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_SLICE_0.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_SLICE_0100600000176200017510000000766007306455570032521 0ustar dhellmanndevel Class: DELETE_SLICE_0

Table of Contents

Class: DELETE_SLICE_0 Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_SLICE_1.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_SLICE_0100600000176200017510000000766007306455570032521 0ustar dhellmanndevel Class: DELETE_SLICE_1

Table of Contents

Class: DELETE_SLICE_1 Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_SLICE_2.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_SLICE_0100600000176200017510000000766007306455570032521 0ustar dhellmanndevel Class: DELETE_SLICE_2

Table of Contents

Class: DELETE_SLICE_2 Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_SLICE_3.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_SLICE_0100600000176200017510000000766007306455571032522 0ustar dhellmanndevel Class: DELETE_SLICE_3

Table of Contents

Class: DELETE_SLICE_3 Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_SUBSCR.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DELETE_SUBSCR0100600000176200017510000000765607306455571032532 0ustar dhellmanndevel Class: DELETE_SUBSCR

Table of Contents

Class: DELETE_SUBSCR Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DUP_TOP.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_DUP_TOP.py.ht0100600000176200017510000000764207306455571032715 0ustar dhellmanndevel Class: DUP_TOP

Table of Contents

Class: DUP_TOP Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_END_FINALLY.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_END_FINALLY.p0100600000176200017510000000765207306455571032525 0ustar dhellmanndevel Class: END_FINALLY

Table of Contents

Class: END_FINALLY Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_EXEC_STMT.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_EXEC_STMT.py.0100600000176200017510000000764607306455571032606 0ustar dhellmanndevel Class: EXEC_STMT

Table of Contents

Class: EXEC_STMT Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_FOR_LOOP.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_FOR_LOOP.py.h0100600000176200017510000001104707306455571032630 0ustar dhellmanndevel Class: FOR_LOOP

Table of Contents

Class: FOR_LOOP Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.JRel
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Exceptions   
"loop alert"

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_IMPORT_FROM.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_IMPORT_FROM.p0100600000176200017510000000764207306455571032575 0ustar dhellmanndevel Class: IMPORT_FROM

Table of Contents

Class: IMPORT_FROM Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.NameOpcode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_IMPORT_NAME.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_IMPORT_NAME.p0100600000176200017510000000764207306455571032552 0ustar dhellmanndevel Class: IMPORT_NAME

Table of Contents

Class: IMPORT_NAME Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.NameOpcode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_JUMP_ABSOLUTE.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_JUMP_ABSOLUTE0100600000176200017510000001107607306455571032547 0ustar dhellmanndevel Class: JUMP_ABSOLUTE

Table of Contents

Class: JUMP_ABSOLUTE Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.JAbs
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Exceptions   
"jumps not handled here!"

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_JUMP_FORWARD.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_JUMP_FORWARD.0100600000176200017510000001107407306455571032511 0ustar dhellmanndevel Class: JUMP_FORWARD

Table of Contents

Class: JUMP_FORWARD Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.JRel
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Exceptions   
"jumps not handled here!"

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_JUMP_IF_FALSE.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_JUMP_IF_FALSE0100600000176200017510000001107607306455571032541 0ustar dhellmanndevel Class: JUMP_IF_FALSE

Table of Contents

Class: JUMP_IF_FALSE Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.JRel
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Exceptions   
"jumps not handled here!"

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_JUMP_IF_TRUE.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_JUMP_IF_TRUE.0100600000176200017510000001107407306455571032542 0ustar dhellmanndevel Class: JUMP_IF_TRUE

Table of Contents

Class: JUMP_IF_TRUE Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.JRel
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Exceptions   
"jumps not handled here!"

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_LOAD_ATTR.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_LOAD_ATTR.py.0100600000176200017510000000763607306455571032563 0ustar dhellmanndevel Class: LOAD_ATTR

Table of Contents

Class: LOAD_ATTR Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.NameOpcode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_LOAD_CONST.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_LOAD_CONST.py0100600000176200017510000000765207306455571032617 0ustar dhellmanndevel Class: LOAD_CONST

Table of Contents

Class: LOAD_CONST Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericThreeByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_LOAD_FAST.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_LOAD_FAST.py.0100600000176200017510000000763707306455571032547 0ustar dhellmanndevel Class: LOAD_FAST

Table of Contents

Class: LOAD_FAST Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.LocalOpcode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_LOAD_GLOBAL.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_LOAD_GLOBAL.p0100600000176200017510000000764207306455571032477 0ustar dhellmanndevel Class: LOAD_GLOBAL

Table of Contents

Class: LOAD_GLOBAL Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.NameOpcode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_LOAD_LOCALS.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_LOAD_LOCALS.p0100600000176200017510000000765207306455571032515 0ustar dhellmanndevel Class: LOAD_LOCALS

Table of Contents

Class: LOAD_LOCALS Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_LOAD_NAME.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_LOAD_NAME.py.0100600000176200017510000000763607306455571032531 0ustar dhellmanndevel Class: LOAD_NAME

Table of Contents

Class: LOAD_NAME Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.NameOpcode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_MAKE_FUNCTION.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_MAKE_FUNCTION0100600000176200017510000000766007306455571032524 0ustar dhellmanndevel Class: MAKE_FUNCTION

Table of Contents

Class: MAKE_FUNCTION Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericThreeByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_POP_BLOCK.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_POP_BLOCK.py.0100600000176200017510000000764607306455571032563 0ustar dhellmanndevel Class: POP_BLOCK

Table of Contents

Class: POP_BLOCK Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_POP_TOP.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_POP_TOP.py.ht0100600000176200017510000000764207306455571032723 0ustar dhellmanndevel Class: POP_TOP

Table of Contents

Class: POP_TOP Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_PRINT_EXPR.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_PRINT_EXPR.py0100600000176200017510000000765007306455571032662 0ustar dhellmanndevel Class: PRINT_EXPR

Table of Contents

Class: PRINT_EXPR Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_PRINT_ITEM.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_PRINT_ITEM.py0100600000176200017510000000765007306455571032642 0ustar dhellmanndevel Class: PRINT_ITEM

Table of Contents

Class: PRINT_ITEM Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_PRINT_NEWLINE.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_PRINT_NEWLINE0100600000176200017510000000765607306455571032564 0ustar dhellmanndevel Class: PRINT_NEWLINE

Table of Contents

Class: PRINT_NEWLINE Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_RAISE_VARARGS.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_RAISE_VARARGS0100600000176200017510000001107407306455571032524 0ustar dhellmanndevel Class: RAISE_VARARGS

Table of Contents

Class: RAISE_VARARGS Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericThreeByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Exceptions   
"Exception!"

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_RETURN_VALUE.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_RETURN_VALUE.0100600000176200017510000000765407306455571032536 0ustar dhellmanndevel Class: RETURN_VALUE

Table of Contents

Class: RETURN_VALUE Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_ROT_THREE.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_ROT_THREE.py.0100600000176200017510000000764607306455571032606 0ustar dhellmanndevel Class: ROT_THREE

Table of Contents

Class: ROT_THREE Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_ROT_TWO.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_ROT_TWO.py.ht0100600000176200017510000000764207306455571032740 0ustar dhellmanndevel Class: ROT_TWO

Table of Contents

Class: ROT_TWO Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_SETUP_EXCEPT.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_SETUP_EXCEPT.0100600000176200017510000000764307306455571032531 0ustar dhellmanndevel Class: SETUP_EXCEPT

Table of Contents

Class: SETUP_EXCEPT Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.JRel
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_SETUP_FINALLY.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_SETUP_FINALLY0100600000176200017510000000764507306455572032564 0ustar dhellmanndevel Class: SETUP_FINALLY

Table of Contents

Class: SETUP_FINALLY Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.JRel
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_SETUP_LOOP.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_SETUP_LOOP.py0100600000176200017510000001105407306455572032653 0ustar dhellmanndevel Class: SETUP_LOOP

Table of Contents

Class: SETUP_LOOP Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.JRel
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Exceptions   
"loop alert!"

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_SET_LINENO.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_SET_LINENO.py0100600000176200017510000000765207306455572032632 0ustar dhellmanndevel Class: SET_LINENO

Table of Contents

Class: SET_LINENO Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericThreeByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_SLICE_0.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_SLICE_0.py.ht0100600000176200017510000000764207306455572032622 0ustar dhellmanndevel Class: SLICE_0

Table of Contents

Class: SLICE_0 Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_SLICE_1.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_SLICE_1.py.ht0100600000176200017510000000764207306455572032623 0ustar dhellmanndevel Class: SLICE_1

Table of Contents

Class: SLICE_1 Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_SLICE_2.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_SLICE_2.py.ht0100600000176200017510000000764207306455572032624 0ustar dhellmanndevel Class: SLICE_2

Table of Contents

Class: SLICE_2 Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_SLICE_3.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_SLICE_3.py.ht0100600000176200017510000000764207306455572032625 0ustar dhellmanndevel Class: SLICE_3

Table of Contents

Class: SLICE_3 Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STOP_CODE.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STOP_CODE.py.0100600000176200017510000000764607306455572032573 0ustar dhellmanndevel Class: STOP_CODE

Table of Contents

Class: STOP_CODE Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_ATTR.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_ATTR.py0100600000176200017510000000764007306455572032656 0ustar dhellmanndevel Class: STORE_ATTR

Table of Contents

Class: STORE_ATTR Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.NameOpcode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_FAST.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_FAST.py0100600000176200017510000000764107306455572032642 0ustar dhellmanndevel Class: STORE_FAST

Table of Contents

Class: STORE_FAST Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.LocalOpcode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_GLOBAL.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_GLOBAL.0100600000176200017510000000764407306455572032477 0ustar dhellmanndevel Class: STORE_GLOBAL

Table of Contents

Class: STORE_GLOBAL Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.NameOpcode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_NAME.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_NAME.py0100600000176200017510000000764007306455572032624 0ustar dhellmanndevel Class: STORE_NAME

Table of Contents

Class: STORE_NAME Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.NameOpcode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_SLICE_0.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_SLICE_00100600000176200017510000000765607306455572032542 0ustar dhellmanndevel Class: STORE_SLICE_0

Table of Contents

Class: STORE_SLICE_0 Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_SLICE_1.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_SLICE_10100600000176200017510000000765607306455572032543 0ustar dhellmanndevel Class: STORE_SLICE_1

Table of Contents

Class: STORE_SLICE_1 Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_SLICE_2.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_SLICE_20100600000176200017510000000765607306455572032544 0ustar dhellmanndevel Class: STORE_SLICE_2

Table of Contents

Class: STORE_SLICE_2 Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_SLICE_3.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_SLICE_30100600000176200017510000000765607306455572032545 0ustar dhellmanndevel Class: STORE_SLICE_3

Table of Contents

Class: STORE_SLICE_3 Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_SUBSCR.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_STORE_SUBSCR.0100600000176200017510000000765407306455572032541 0ustar dhellmanndevel Class: STORE_SUBSCR

Table of Contents

Class: STORE_SUBSCR Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_UNARY_CONVERT.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_UNARY_CONVERT0100600000176200017510000000765607306455572032606 0ustar dhellmanndevel Class: UNARY_CONVERT

Table of Contents

Class: UNARY_CONVERT Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_UNARY_INVERT.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_UNARY_INVERT.0100600000176200017510000000765407306455572032551 0ustar dhellmanndevel Class: UNARY_INVERT

Table of Contents

Class: UNARY_INVERT Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_UNARY_NEGATIVE.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_UNARY_NEGATIV0100600000176200017510000000766007306455572032556 0ustar dhellmanndevel Class: UNARY_NEGATIVE

Table of Contents

Class: UNARY_NEGATIVE Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_UNARY_NOT.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_UNARY_NOT.py.0100600000176200017510000000764607306455572032632 0ustar dhellmanndevel Class: UNARY_NOT

Table of Contents

Class: UNARY_NOT Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_UNARY_POSITIVE.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_UNARY_POSITIV0100600000176200017510000000766007306455572032616 0ustar dhellmanndevel Class: UNARY_POSITIVE

Table of Contents

Class: UNARY_POSITIVE Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericOneByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        cs=None,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_UNPACK_LIST.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_UNPACK_LIST.p0100600000176200017510000000765407306455572032560 0ustar dhellmanndevel Class: UNPACK_LIST

Table of Contents

Class: UNPACK_LIST Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericThreeByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_UNPACK_TUPLE.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops_UNPACK_TUPLE.0100600000176200017510000000765607306455572032520 0ustar dhellmanndevel Class: UNPACK_TUPLE

Table of Contents

Class: UNPACK_TUPLE Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/ops.py

Base Classes   
_opbases.GenericThreeByteCode
Methods   
__init__
execute
  __init__  
__init__ (
        self,
        csorarg,
        code=None,
        )

  execute  
execute ( self,  stack )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/rationalize.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/rationalize.py.ht0100600000176200017510000001717107306455572033202 0ustar dhellmanndevel Module: rationalize

Table of Contents

Module: rationalize Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/rationalize.py

Imported modules   
import code_editor
import operator
from ops import *
Functions   
calculateConstants
eliminateUnusedLocals
eliminateUnusedNames
rationalize
removeconstjump
simplifyjumps
strip_setlineno
  calculateConstants  
calculateConstants ( co )

Precalculate results of operations involving constants.

  eliminateUnusedLocals  
eliminateUnusedLocals ( code )

  eliminateUnusedNames  
eliminateUnusedNames ( code )

  rationalize  
rationalize ( code )

  removeconstjump  
removeconstjump ( co )

  simplifyjumps  
simplifyjumps ( co )

  strip_setlineno  
strip_setlineno ( co )

Take in an EditableCode object and strip the SET_LINENO bytecodes

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tailr.py.html0100600000176200017510000001575407306455572032332 0ustar dhellmanndevel Module: tailr

Table of Contents

Module: tailr Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/tailr.py

Imported modules   
from code_editor import Function
from find_function_call import find_function_call
from ops import *
import time
Functions   
_facr
faci
facr
factr
make_tail_recursive
suite
  _facr  
_facr (
        n,
        c,
        p,
        )

  faci  
faci ( n )

  facr  
facr ( n,  _facr=_facr )

  factr  
factr ( n,  _factr=_factr )

  make_tail_recursive  
make_tail_recursive ( func )

  suite  
suite (
        n,
        c=10,
        T=time.time,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/xapply.py.html0100600000176200017510000001671107306455572032526 0ustar dhellmanndevel Module: xapply

Table of Contents

Module: xapply Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/xapply.py

\ xapply

Inspired by Don Beaudry's functor module.

xapply exports one public function, the eponymous xapply. xapply can be thought of as `lazy apply' or `partial argument resolution'.

It takes a function and part of it's argument list, and returns a function with the first parameters filled in. An example:

def f(x,y): return x+y

add1 = xapply(f,1)

add1(2) => 3

This xapply is not yet as general as that from the functor module, but the functions return are as fast as normal function, i.e. twice as fast as functors.

This may be generalised at some point in the future.

Imported modules   
from code_editor import Function, InstanceMethod
import new
from ops import LOAD_FAST, LOAD_CONST
import re
import string
import types
Functions   
xapply
xapply_func
xapply_meth
xapply_munge
  xapply  
xapply ( callable,  *args )

xapply(callable,arg1,arg2,...) -> callable

if

f=xapply(callable,arg1,arg2,...,argn)

then

f(arg<n+1>,....argm)

is equivalent to

callable(arg1,...,argn,arg<n+1>,..argm)

callable currently must be a function or instance method, and keyword arguments are currently not allowed.

Exceptions   
"nope"
  xapply_func  
xapply_func ( func,  args )

  xapply_meth  
xapply_meth ( meth,  args )

  xapply_munge  
xapply_munge (
        code,
        args,
        except0=0,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/README.html0100600000176200017510000000506107306455572031513 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PythonMethod.zbytecodehacks

Table of Contents

Zope2 CVS with ZEO: Products.PythonMethod.zbytecodehacks  

Welcome to the bytecodehacks!

There's docmentation in doc/; To build it you need an unpacked python source distribution somewhere, and for html output you also need latex2html.

Build docs like this:

$(path to Python source)/Doc/tools/mkhowto --$(format) (--a4) bch.tex

You can get built html docs at

ftp://starship.python.net/pub/crew/mwh/bytecodehacks-doc-$(VERSION).tar.gz.

The bytecodehacks rewrite the bytecode of functions to do unlikely things in Python.

The package (and that's how it's distributed) splits into two parts - the byte code editing routines and the "bytecodehacks" that are usuable without a degree in python arcanery, although one might help understand some of the consequences.

Some highlights:

bytecodehacks.closure - bind global references to constants bytecodehacks.xapply - a sort-of lazy apply bytecodehacks.setq - this one should interest people! bytecodehacks.inline - Python gets inline functions bytecodehacks.macro - Python gets semantic (hygenic) macros!

Please note that these modules are not really bullet-proof, more a proof-of-concept than anything else.

The are also public domain; do what you like with them. If you find bugs, or more imaginative uses for these techniques, I'd surely like to know!

Thanks for taking an interest.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/zbytecodehacks/TODO.html0100600000176200017510000000234307306455572031323 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PythonMethod.zbytecodehacks

Table of Contents

Zope2 CVS with ZEO: Products.PythonMethod.zbytecodehacks  

polish attr_freeze.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/Bindings.py.html0100600000176200017510000000634307306455572027744 0ustar dhellmanndevel Module: Bindings

Table of Contents

Module: Bindings Zope-2-CVS-src/lib/python/Products/PythonMethod/Bindings.py

Imported modules   
from DocumentTemplate.DT_Util import TemplateDict
import Globals
from Globals import Persistent, HTMLFile, package_home
import os
import re
from string import join, strip
Classes   
Bindings
NameAssignments

Note that instances of this class are intended to be immutable

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/Bindings_Bindings.py.html0100600000176200017510000003205107306455572031554 0ustar dhellmanndevel Class: Bindings

Table of Contents

Class: Bindings Zope-2-CVS-src/lib/python/Products/PythonMethod/Bindings.py

Base Classes   
Persistent
Methods   
ZBindingsHTML_editAction
ZBindings_edit
__before_publishing_traverse__
__call__
__render_with_namespace__
_bindAndExec
_createBindCode
_editedBindings
_getBindCount
_getNamespace
 _getTraverseSubpath
_prepareBindCode
_setupBindings
getBindingAssignments
  ZBindingsHTML_editAction  
ZBindingsHTML_editAction ( self,  REQUEST )

Changes binding names.

  ZBindings_edit  
ZBindings_edit ( self,  mapping )

  __before_publishing_traverse__  
__before_publishing_traverse__ (
        self,
        self2,
        request,
        )

  __call__  
__call__ (
        self,
        *args,
        *kw,
        )

Calls the method.

  __render_with_namespace__  
__render_with_namespace__ ( self,  namespace )

Calls the method with the specified namespace.

  _bindAndExec  
_bindAndExec (
        self,
        args,
        kw,
        caller_namespace,
        )

Prepares the bound information and calls _exec(), possibly with a namespace.

  _createBindCode  
_createBindCode ( self,  names )

  _editedBindings  
_editedBindings ( self )

  _getBindCount  
_getBindCount ( self )

  _getNamespace  
_getNamespace (
        self,
        caller_namespace,
        kw,
        )

  _getTraverseSubpath  
_getTraverseSubpath ( self )

  _prepareBindCode  
_prepareBindCode ( self )

  _setupBindings  
_setupBindings ( self,  names={} )

  getBindingAssignments  
getBindingAssignments ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/Bindings_NameAssignments.py.html0100600000176200017510000002230407306455572033113 0ustar dhellmanndevel Class: NameAssignments

Table of Contents

Class: NameAssignments Zope-2-CVS-src/lib/python/Products/PythonMethod/Bindings.py

Note that instances of this class are intended to be immutable and persistent but not inherit from ExtensionClass.

Methods   
__init__
_createCodeBlockForMapping
_createCodeBlockForTuple
_generateCodeBlock
getAssignedName
getAssignedNamesInOrder
isAnyNameAssigned
isNameAssigned
  __init__  
__init__ ( self,  mapping )

Exceptions   
ValueError, ( '"%s" is not a valid variable name.' % assigned_name )
  _createCodeBlockForMapping  
_createCodeBlockForMapping ( self )

  _createCodeBlockForTuple  
_createCodeBlockForTuple ( self,  argNames )

  _generateCodeBlock  
_generateCodeBlock (
        self,
        bindtext,
        assigned_names,
        )

  getAssignedName  
getAssignedName (
        self,
        name,
        default=_marker,
        )

Exceptions   
KeyError, name
  getAssignedNamesInOrder  
getAssignedNamesInOrder ( self )

  isAnyNameAssigned  
isAnyNameAssigned ( self )

  isNameAssigned  
isNameAssigned ( self,  name )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/ExternalMethod.py.html0100600000176200017510000001657007306455572031135 0ustar dhellmanndevel Module: ExternalMethod

Table of Contents

Module: ExternalMethod Zope-2-CVS-src/lib/python/Products/PythonMethod/ExternalMethod.py

External Python Method

This product provides support for external methods, which allow domain-specific customization of web environments.

Imported modules   
from AccessControl import getSecurityManager
import AccessControl.Role
import Acquisition
from App.Extensions import getObject, getPath
from Bindings import Bindings
from Globals import Persistent, HTMLFile, MessageDialog, HTML, package_home, DevelopmentMode
from Method import Method
from OFS.SimpleItem import SimpleItem
import os
import stat
from string import split, join, find, lower
import sys
import traceback
from urllib import quote
Functions   
isBoundToInstance
manage_addExternalMethod
null_f
  isBoundToInstance  
isBoundToInstance ( f )

  manage_addExternalMethod  
manage_addExternalMethod (
        self,
        id,
        REQUEST=None,
        )

Add an External Python method to a folder.

  null_f  
null_f ( self )

Exceptions   
"Undefined", 'Call of undefined external Python method'
Classes   
ExternalMethod

Web-callable functions that encapsulate external python functions.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/ExternalMethod_ExternalMethod.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/ExternalMethod_ExternalMethod.py0100600000176200017510000003055307306455572033172 0ustar dhellmanndevel Class: ExternalMethod

Table of Contents

Class: ExternalMethod Zope-2-CVS-src/lib/python/Products/PythonMethod/ExternalMethod.py

Web-callable functions that encapsulate external python functions.

The function is defined in an external file. This file is treated like a module, but is not a module. It is not imported directly, but is rather read and evaluated. The file must reside in the Extensions subdirectory of the Zope installation, or in an Extensions subdirectory of a product directory.

Due to the way ExternalMethods are loaded, it is not currently possible to use Python modules that reside in the Extensions directory. It is possible to load modules found in the lib/python directory of the Zope installation, or in packages that are in the lib/python directory.

Base Classes   
Method
Methods   
ZExternalMethodHTML_editAction
ZExternalMethod_edit
ZExternalMethod_setTitle
__init__
_createBindCode
_editedBindings
_exec
_getFunction
_storeFuncVarNames
filepath
 function
module
  ZExternalMethodHTML_editAction  
ZExternalMethodHTML_editAction (
        self,
        REQUEST,
        title,
        module,
        function,
        )

Change the external method

Note that calling this causes the "module" to be effectively reloaded. This is useful during debugging to see the effects of changes, but can lead to problems of functions rely on shared global data.

  ZExternalMethod_edit  
ZExternalMethod_edit (
        self,
        module,
        function,
        )

  ZExternalMethod_setTitle  
ZExternalMethod_setTitle ( self,  title )

  __init__  
__init__ ( self,  id )

  _createBindCode  
_createBindCode ( self,  names )

  _editedBindings  
_editedBindings ( self )

  _exec  
_exec (
        self,
        boundArgs,
        args,
        kw,
        )

  _getFunction  
_getFunction ( self,  reloadExternal=0 )

  _storeFuncVarNames  
_storeFuncVarNames ( self )

  filepath  
filepath ( self )

  function  
function ( self )

  module  
module ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/Guarded.py.html0100600000176200017510000004131607306455573027562 0ustar dhellmanndevel Module: Guarded

Table of Contents

Module: Guarded Zope-2-CVS-src/lib/python/Products/PythonMethod/Guarded.py

Imported modules   
from AccessControl import getSecurityManager, getModuleSecurity
from DocumentTemplate.DT_Util import TemplateDict, careful_pow, d, ValidationError
from DocumentTemplate.DT_Var import special_formats
from DocumentTemplate.VSEval import careful_mul
import standard
from string import split
import sys
from zbytecodehacks.VSExec import SafeBlock, GuardedBinaryOps, UntupleFunction, RedirectWrites, WriteGuard, RedirectReads, ReadGuard, LoopLimits, bind
Functions   
__careful_delattr__
__careful_filter__
__careful_getattr__
__careful_import__
__careful_list__
__careful_map__
__careful_setattr__
__careful_tuple__
aq_validate
load_module
 same_type
  __careful_delattr__  
__careful_delattr__ ( object,  name )

  __careful_filter__  
__careful_filter__ (
        f,
        seq,
        skip_unauthorized=0,
        )

Exceptions   
ValidationError, 'unauthorized access to element'
  __careful_getattr__  
__careful_getattr__ (
        inst,
        name,
        default=_marker,
        )

Exceptions   
ValidationError, name
  __careful_import__  
__careful_import__ (
        mname,
        globals={},
        locals={},
        fromlist=None,
        )

Exceptions   
"Unauthorized"
ImportError, 'import of "%s" is unauthorized' % mname
ImportError, ( '"from %s import *" is not allowed' % mname )
ImportError, ('import of "%s" from "%s" is unauthorized' %( name, mname ) )
  __careful_list__  
__careful_list__ ( seq )

Exceptions   
TypeError, 'cannot convert string to list'
  __careful_map__  
__careful_map__ ( f,  *seqs )

Exceptions   
TypeError, 'cannot map a string'
  __careful_setattr__  
__careful_setattr__ (
        object,
        name,
        value,
        )

  __careful_tuple__  
__careful_tuple__ ( seq )

Exceptions   
TypeError, 'cannot convert string to tuple'
  aq_validate  
aq_validate ( *args )

  load_module  
load_module (
        module,
        mname,
        mnameparts,
        validate,
        globals,
        locals,
        )

  same_type  
same_type ( arg1,  *args )

Compares the type of two or more objects.

Classes   
Guard
GuardedBlock
_ReadGuardWrapper

def validate(self, *args):

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/Guarded_Guard.py.html0100600000176200017510000000244207306455572030700 0ustar dhellmanndevel Class: Guard

Table of Contents

Class: Guard Zope-2-CVS-src/lib/python/Products/PythonMethod/Guarded.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/Guarded_GuardedBlock.py.html0100600000176200017510000000367507306455572032175 0ustar dhellmanndevel Class: GuardedBlock

Table of Contents

Class: GuardedBlock Zope-2-CVS-src/lib/python/Products/PythonMethod/Guarded.py

Base Classes   
SafeBlock

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/Guarded__ReadGuardWrapper.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/Guarded__ReadGuardWrapper.py.htm0100600000176200017510000000773707306455573033035 0ustar dhellmanndevel Class: _ReadGuardWrapper

Table of Contents

Class: _ReadGuardWrapper Zope-2-CVS-src/lib/python/Products/PythonMethod/Guarded.py

def validate(self, *args): return apply(getSecurityManager().validate, args[:4])

Methods   
__getattr__
__getitem__
  __getattr__  
__getattr__ ( self,  name )

  __getitem__  
__getitem__ ( self,  i )

Exceptions   
ValidationError, 'unauthorized access to element %s' % ` i `

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/Method.py.html0100600000176200017510000000641707306455573027432 0ustar dhellmanndevel Module: Method

Table of Contents

Module: Method Zope-2-CVS-src/lib/python/Products/PythonMethod/Method.py

Method module

This provides generic method support

Imported modules   
from Bindings import Bindings
from Globals import package_home, HTMLFile
from OFS.SimpleItem import SimpleItem
import os
from string import join
from urllib import quote
Classes   
FuncCode
Method

Web-callable function mixin

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/Method_FuncCode.py.html0100600000176200017510000000636307306455573031200 0ustar dhellmanndevel Class: FuncCode

Table of Contents

Class: FuncCode Zope-2-CVS-src/lib/python/Products/PythonMethod/Method.py

Methods   
__cmp__
__init__
  __cmp__  
__cmp__ ( self,  other )

  __init__  
__init__ (
        self,
        varnames,
        argcount,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/Method_Method.py.html0100600000176200017510000001133207306455573030722 0ustar dhellmanndevel Class: Method

Table of Contents

Class: Method Zope-2-CVS-src/lib/python/Products/PythonMethod/Method.py

Web-callable function mixin

Base Classes   
SimpleItem
Bindings
Methods   
ZMethodHTML_tryAction
_setFuncSignature
  ZMethodHTML_tryAction  
ZMethodHTML_tryAction (
        self,
        REQUEST,
        argvars,
        )

Apply the test parameters.

Exceptions   
"Redirect", "%s?%s" %(REQUEST [ 'URL1' ], join( vv, '&' ) )
  _setFuncSignature  
_setFuncSignature (
        self,
        defaults,
        varnames,
        argcount,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/ModuleSecurity.py.html0100600000176200017510000000762607306455573031172 0ustar dhellmanndevel Module: ModuleSecurity

Table of Contents

Module: ModuleSecurity Zope-2-CVS-src/lib/python/Products/PythonMethod/ModuleSecurity.py

Imported modules   
import AccessControl
Functions   
getModuleSecurity
  getModuleSecurity  
getModuleSecurity ()

Classes   
ModuleSecurityInfo

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/ModuleSecurity_ModuleSecurityInfo.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/ModuleSecurity_ModuleSecurityInf0100600000176200017510000000772107306455573033266 0ustar dhellmanndevel Class: ModuleSecurityInfo

Table of Contents

Class: ModuleSecurityInfo Zope-2-CVS-src/lib/python/Products/PythonMethod/ModuleSecurity.py

Methods   
__getattr__
__init__
stub
  __getattr__  
__getattr__ ( self,  name )

  __init__  
__init__ ( self,  module_name=None )

  stub  
stub (
        self,
        *args,
        *kwargs,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/PythonMethod.py.html0100600000176200017510000001263107306455573030627 0ustar dhellmanndevel Module: PythonMethod

Table of Contents

Module: PythonMethod Zope-2-CVS-src/lib/python/Products/PythonMethod/PythonMethod.py

Python Method Product

This product provides support for internal methods, which allow safe implementation in a large Python subset.

Imported modules   
import AccessControl
from AccessControl import getSecurityManager
from Bindings import Bindings, defaultBindings
from DateTime.DateTime import DateTime
from Globals import MessageDialog, HTMLFile, package_home
import Guarded
from Method import Method
import OFS
from OFS.History import Historical, html_diff
from OFS.SimpleItem import SimpleItem
import os
import re
from string import join, strip, rstrip, split, replace, lower
import sys
import traceback
from urllib import quote
from zLOG import LOG, ERROR
Functions   
manage_addPythonMethod
  manage_addPythonMethod  
manage_addPythonMethod (
        self,
        id,
        REQUEST=None,
        )

Add a Python method to a folder.

Classes   
PythonMethod

Web-callable functions written in a safe subset of Python.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/PythonMethod_PythonMethod.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/PythonMethod_PythonMethod.py.htm0100600000176200017510000005665107306455573033167 0ustar dhellmanndevel Class: PythonMethod

Table of Contents

Class: PythonMethod Zope-2-CVS-src/lib/python/Products/PythonMethod/PythonMethod.py

Web-callable functions written in a safe subset of Python.

The function may include standard python code, so long as it does not attempt to use the "exec" statement.

Base Classes   
Method
Historical
Methods   
PUT
PrincipiaSearchSource
ZMethodHTML_tryParams
ZPythonMethodHTML_changePrefs
ZPythonMethodHTML_editAction
ZPythonMethodHTML_upload
ZPythonMethod_edit
ZPythonMethod_setTitle
__init__
_checkCBlock
 _editedBindings
_exec
_makeFunction
_metadata_map
_newfun
_setText
_validateProxy
body
document_src
get_size
 manage_FTPget
manage_haveProxy
manage_historyCompare
manage_proxy
params
read
  PUT  
PUT (
        self,
        REQUEST,
        RESPONSE,
        )

Handle HTTP PUT requests

  PrincipiaSearchSource  
PrincipiaSearchSource ( self )

Support for searching - the document's contents are searched.

  ZMethodHTML_tryParams  
ZMethodHTML_tryParams ( self )

Parameters to test the method with.

  ZPythonMethodHTML_changePrefs  
ZPythonMethodHTML_changePrefs (
        self,
        REQUEST,
        height=None,
        width=None,
        dtpref_cols='50',
        dtpref_rows='20',
        )

Change editing preferences.

  ZPythonMethodHTML_editAction  
ZPythonMethodHTML_editAction (
        self,
        REQUEST,
        title,
        params,
        body,
        )

Change the method's main parameters.

  ZPythonMethodHTML_upload  
ZPythonMethodHTML_upload (
        self,
        REQUEST,
        file='',
        )

Replace the body of the method with the text in file.

  ZPythonMethod_edit  
ZPythonMethod_edit (
        self,
        params,
        body,
        )

  ZPythonMethod_setTitle  
ZPythonMethod_setTitle ( self,  title )

  __init__  
__init__ ( self,  id )

  _checkCBlock  
_checkCBlock ( self,  MakeBlock )

  _editedBindings  
_editedBindings ( self )

  _exec  
_exec (
        self,
        globals,
        args,
        kw,
        )

Call a Python Method

Calling a Python Method is an actual function invocation.

  _makeFunction  
_makeFunction ( self,  allowSideEffect=0 )

Exceptions   
"Python Method Error", ('
%s
' % join( self._v_errors, '\n' ) )
  _metadata_map  
_metadata_map ( self )

  _newfun  
_newfun (
        self,
        allowSideEffect,
        g,
        **kws,
        )

  _setText  
_setText ( self,  text )

  _validateProxy  
_validateProxy ( self,  roles=None )

Exceptions   
'Forbidden', ('You are not authorized to change %s ' 'because you do not have proxy roles.\n' %( self.id, u, roles ) )
  body  
body ( self )

  document_src  
document_src (
        self,
        REQUEST=None,
        RESPONSE=None,
        )

Return unprocessed document source.

  get_size  
get_size ( self )

  manage_FTPget  
manage_FTPget ( self )

Get source for FTP download

  manage_haveProxy  
manage_haveProxy ( self,  r )

  manage_historyCompare  
manage_historyCompare (
        self,
        rev1,
        rev2,
        REQUEST,
        historyComparisonResults='',
        )

  manage_proxy  
manage_proxy (
        self,
        roles=(),
        REQUEST=None,
        )

Change Proxy Roles

  params  
params ( self )

  read  
read ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/__init__.py.html0100600000176200017510000000654207306455573027750 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/PythonMethod/__init__.py

Imported modules   
import ExternalMethod
import ModuleSecurity
import PythonMethod
import standard
Functions   
initialize
  initialize  
initialize ( context )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/standard.py.html0100600000176200017510000000547507306455573030015 0ustar dhellmanndevel Module: standard

Table of Contents

Module: standard Zope-2-CVS-src/lib/python/Products/PythonMethod/standard.py

Imported modules   
from AccessControl import ModuleSecurityInfo, getSecurityManager
from DocumentTemplate.DT_Var import special_formats
from Globals import HTML
Classes   
DTML

DTML objects are DocumentTemplate.HTML objects that allow

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/standard_DTML.py.html0100600000176200017510000001016507306455573030625 0ustar dhellmanndevel Class: DTML

Table of Contents

Class: DTML Zope-2-CVS-src/lib/python/Products/PythonMethod/standard.py

DTML objects are DocumentTemplate.HTML objects that allow dynamic, temporary creation of restricted DTML.

Base Classes   
HTML
Methods   
__call__
validate
  __call__  
__call__ (
        self,
        client=None,
        REQUEST={},
        RESPONSE=None,
        **kw,
        )

Render the DTML given a client object, REQUEST mapping, Response, and key word arguments.

  validate  
validate (
        self,
        inst,
        parent,
        name,
        value,
        md,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/CHANGES.txt.html0100600000176200017510000001144007306455573027441 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PythonMethod

Table of Contents

Zope2 CVS with ZEO: Products.PythonMethod  

1999-12-13 Evan Simpson <evan@4-am.com>

  • Version 0.1.7 * Nested functions and lambdas are now supported, with full safety. * You can access all of the dtml-var format functions through a builtin dictionary called special_formats (eg: special_formats['html-quote']). * Handing off to Digital Creations for inclusion in CVS. * Packaged with packProduct script, which excludes parent directories and .pyc files. Makes for a smaller package, and doesn't step on ownership/permissions of lib/python/Products path elements.

1999-12-01 Evan Simpson <evan@4-am.com>

  • Added COPYRIGHT.txt, making Wide Open Source licence (BSD-style) explicit. (Mike Goldman provided the text, I provided the silly name). * Jeff Rush donated a PrincipiaSearchSource method, so that PythonMethod objects can be zcataloged to the same degree as DTML Methods. * Also from Jeff Rush, a document_src method, so that the source of PythonMethods can be viewed via a "View Source" link if desired. * If a PM has a traverse_subpath parameter, you can now directly traverse it. The elements of the subpath will then be put into a list in traverse_subpath. (thanks to Anthony Baxter)

1999-11-11 Evan Simpson <evan@4-am.com>

  • Version 0.1.6 * Fix to builtins messed up DTML Methods, so I re-fixed it.

1999-11-05 Evan Simpson <evan@4-am.com>

  • Version 0.1.5 * Killed *%#&$@ weird bug in which having add documents in www subdirectory prevented rename, paste, or import of existing PythonMethods! See use of _www. * Range, test, and several other Zope builtins had an unbound self argument unless called on _, but that's fixed. * Safe multiplication was utterly broken (thanks to the guard); now it works. Is anyone using the safe version??

1999-10-18 Evan Simpson <evan@4-am.com>

  • Eliminated bug which delayed stringification of printed values.

1999-10-08 Evan Simpson <evan@4-am.com>

  • Version 0.1.4 * Fixed mis-design noticed by Michel Pelletier, and refactored MakeFunction. Now both kinds of Python Method have the bugfix from 0.1.3, and shouldn't provoke a transaction when called.

1999-10-07 Evan Simpson <evan@4-am.com>

  • Version 0.1.3 * Fixed parameter bug with self and no defaults

1999-09-24 Evan Simpson <evan@4-am.com>

  • Version 0.1.2 * Added WebDAV/FTP access code donated by Michel Pelletier * Made parameters part of WebDAV/FTP text * Eliminated initialization of globals to None * Added global_exists global function instead * Killed bug with unused parameters * Put switch in Guarded.py to allow both regular and dangerous (XXX) PythonMethods to live side-by-side. This means that people who patched version 0.1.1 will have to re-create any unsafe PMs they use (Sorry).

1999-09-10 Evan Simpson <evan@4-am.com>

  • Version 0.1.1 * Incorporated DT_Util builtins and guards * Fixed direct access via URL * Fixed methodAdd.dtml * rstrip function body * Major changes to zbytecodehacks

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonMethod/README.txt.html0100600000176200017510000000252207306455573027327 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PythonMethod

Table of Contents

Zope2 CVS with ZEO: Products.PythonMethod  

Python Methods

The Python Method product provides support for internal Python methods, exposing them as callable objects within the Zope environment.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/0040700000176200017510000000000007306455574025076 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/index.html0100600000176200017510000000733307306455574027100 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PythonScripts

Table of Contents

Zope2 CVS with ZEO: Products.PythonScripts  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/PythonScripts/

CHANGES.txt.html

2001-04-26 Evan Simpson <evan@digicool.com>

README.txt.html

Python Scripts

Utility

Utility module for making simple security assertions for

__init__
module_access_examples

Examples for enabling Script import

standard

Python Scripts standard utility module

Zope-2-CVS-src/lib/python/Products/PythonScripts/Extensions/

RemotePS

RemotePS.py

Zope-2-CVS-src/lib/python/Products/PythonScripts/help/

PythonScript
Script

Script module

Zope-2-CVS-src/lib/python/Products/PythonScripts/tests/

testPythonScript

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/help/0040700000176200017510000000000007306455573026025 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/help/PythonScript.py.html0100600000176200017510000000664407306455573032021 0ustar dhellmanndevel Module: PythonScript

Table of Contents

Module: PythonScript Zope-2-CVS-src/lib/python/Products/PythonScripts/help/PythonScript.py

Functions   
manage_addPythonScript
  manage_addPythonScript  
manage_addPythonScript ( id,  REQUEST=None )

Add a Python script to a folder.

Classes   
PythonScript

Python Scripts contain python code that gets executed when you call the

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/help/PythonScript_PythonScript.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/help/PythonScript_PythonScript.0100600000176200017510000003271407306455573033230 0ustar dhellmanndevel Class: PythonScript

Table of Contents

Class: PythonScript Zope-2-CVS-src/lib/python/Products/PythonScripts/help/PythonScript.py

Python Scripts contain python code that gets executed when you call the script by:

  • Calling the script through the web by going to its location with a web browser.

  • Calling the script from another script object.

  • Calling the script from a method object, such as a DTML Method.

Python Scripts can contain a "safe" subset of the python language. Python Scripts must be safe because they can be potentially edited by many different users through an insecure medium like the web. The following safety issues drive the need for secure Python Scripts:

  • Because many users can use Zope, a Python Script must make sure it does not allow a user to do something they are not allowed to do, like deleting an object they do not have permission to delete. Because of this requirement, Python Scripts do many security checks in the course of their execution.

  • Because Python Scripts can be edited through the insecure medium of the web, they are not allowed access to the Zope server's file-system. Normal Python builtins like open are, therefore, not allowed.

  • Because many standard Python modules break the above two security restrictions, only a small subset of Python modules may be imported into a Python Scripts with the "import" statement unless they have been validated by Zope's security policy. Currently, the following standard python modules have been validated:

    • string

    • math

    • whrandom and random

    • Products.PythonScripts.standard

  • Because it allows you to execute arbitrary python code, the python "exec" statement is not allowed in Python methods.

  • Because they may represent or cause security violations, some Python builtin functions are not allowed. The following Python builtins are not allowed:

    • open

    • input

    • raw_input

    • eval

    • execfile

    • compile

    • type

    • coerce

    • intern

    • dir

    • globals

    • locals

    • vars

    • buffer

    • reduce

  • Other builtins are restricted in nature. The following builtins are restricted:

    range

    Due to possible memory denial of service attacks, the range builtin is restricted to creating ranges less than 10,000 elements long.

    filter, map, tuple, list

    For the same reason, builtins that construct lists from sequences do not operate on strings.

    getattr, setattr, delattr

    Because these may enable Python code to circumvent Zope's security system, they are replaced with custom, security constrained versions.

  • In order to be consistent with the Python expressions available to DTML, the builtin functions are augmented with a small number of functions and a class:

    • test

    • namespace

    • render

    • same_type

    • DateTime

  • Because the "print" statement cannot operate normally in Zope, its effect has been changed. Rather than sending text to stdout, "print" appends to an internal variable. The special builtin name "printed" evaluates to the concatenation of all text printed so far during the current execution of the script.

Methods   
ZPythonScriptHTML_editAction
ZPythonScriptHTML_upload
ZPythonScript_edit
ZPythonScript_setTitle
ZScriptHTML_tryParams
document_src
read
write
  ZPythonScriptHTML_editAction  
ZPythonScriptHTML_editAction (
        REQUEST,
        title,
        params,
        body,
        )

Change the script's main parameters. This method accepts the following arguments:

REQUEST

The current request.

title

The new value of the Python Script's title. This must be a string.

params

The new value of the Python Script's parameters. Must be a comma seperated list of values in valid python function signature syntax. If it does not contain a valid signature string, a SyntaxError is raised.

body

The new value of the Python Script's body. Must contain valid Python syntax. If it does not contain valid Python syntax, a SyntaxError is raised.

  ZPythonScriptHTML_upload  
ZPythonScriptHTML_upload ( REQUEST,  file='' )

Pass the text in file to the write method.

  ZPythonScript_edit  
ZPythonScript_edit ( params,  body )

Change the parameters and body of the script. This method accepts two arguments:

params

The new value of the Python Script's parameters. Must be a comma seperated list of values in valid python function signature syntax. If it does not contain a valid signature string, a SyntaxError is raised.

body

The new value of the Python Script's body. Must contain valid Python syntax. If it does not contain valid Python syntax, a SyntaxError is raised.

  ZPythonScript_setTitle  
ZPythonScript_setTitle ( title )

Change the script's title. This method accepts one argument, title which is the new value for the script's title and must be a string.

  ZScriptHTML_tryParams  
ZScriptHTML_tryParams ()

Return a list of the required parameters with which to test the script.

  document_src  
document_src ( REQUEST=None,  RESPONSE=None )

Return the text of the read method, with content type text/plain set on the RESPONSE.

  read  
read ()

Return the body of the Python Script, with a special comment block prepended. This block contains meta-data in the form of comment lines as expected by the write method.

  write  
write ( text )

Change the script by parsing the text argument into parts. Leading lines that begin with ## are stripped off, and if they are of the form ##name=value, they are used to set meta-data such as the title and parameters. The remainder of the text is set as the body of the Python Script.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/help/Script.py.html0100600000176200017510000000410007306455573030600 0ustar dhellmanndevel Module: Script

Table of Contents

Module: Script Zope-2-CVS-src/lib/python/Products/PythonScripts/help/Script.py

Script module

This provides generic script support

Classes   
Script

Web-callable script base interface.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/help/Script_Script.py.html0100600000176200017510000000533407306455573032136 0ustar dhellmanndevel Class: Script

Table of Contents

Class: Script Zope-2-CVS-src/lib/python/Products/PythonScripts/help/Script.py

Web-callable script base interface.

Methods   
ZScriptHTML_tryAction
  ZScriptHTML_tryAction  
ZScriptHTML_tryAction ( REQUEST,  argvars )

Apply the test parameters provided by the dictionary argvars. This will call the current script with the given arguments and return the result.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/Extensions/0040700000176200017510000000000007306455573027234 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/Extensions/RemotePS.py.html0100600000176200017510000000724007306455573032251 0ustar dhellmanndevel Module: RemotePS

Table of Contents

Module: RemotePS Zope-2-CVS-src/lib/python/Products/PythonScripts/Extensions/RemotePS.py

RemotePS.py

External Method that allows you to remotely (via XML-RPC, for instance) execute restricted Python code.

For example, create an External Method restricted_exec in your Zope root, and you can remotely call:

foobarsize = s.foo.bar.restricted_exec(len(context.objectIds()))

Imported modules   
from Products.PythonScripts.PythonScript import PythonScript
from string import join
Functions   
restricted_exec
  restricted_exec  
restricted_exec (
        self,
        body,
        varmap=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/Utility.py.html0100600000176200017510000001050707306455573030057 0ustar dhellmanndevel Module: Utility

Table of Contents

Module: Utility Zope-2-CVS-src/lib/python/Products/PythonScripts/Utility.py

Utility module for making simple security assertions for Python scripts.

Imported modules   
from AccessControl import ModuleSecurityInfo, ClassSecurityInfo
from Globals import InitializeClass
import string
Functions   
allow_class
allow_module
  allow_class  
allow_class ( Class )

Allow a class and all of its methods to be used from a restricted Script. The argument Class must be a class.

  allow_module  
allow_module ( module_name )

Allow a module and all its contents to be used from a restricted Script. The argument module_name may be a simple or dotted module or package name. Note that if a package path is given, all modules in the path will be available.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/__init__.py.html0100600000176200017510000000632207306455573030153 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/PythonScripts/__init__.py

Imported modules   
import PythonScript
from Shared.DC import Scripts
Functions   
initialize
  initialize  
initialize ( context )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/module_access_examples.py.html0100600000176200017510000000545407306455573033125 0ustar dhellmanndevel Module: module_access_examples

Table of Contents

Module: module_access_examples Zope-2-CVS-src/lib/python/Products/PythonScripts/module_access_examples.py

Examples for enabling Script import

This file contains example code that can be used to make various standard Python modules available to Scripts.

In order to use the example code, create a directory called "MyScriptModules", or something equally descriptive, in your Zope's "Products" directory. Copy this file to a file called "__init__.py" in the new directory. Edit the new file, uncommenting the block of code for each module that you want to make available for import by Scripts.

You can, of course, add your own code to your "__init__.py" for modules that are not listed below. The list is not comprehensive, but is provided as a decent cross-section of modules.

Imported modules   
from AccessControl import ModuleSecurityInfo, ClassSecurityInfo
from Globals import InitializeClass
from Products.PythonScripts.Utility import allow_module, allow_class

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/standard.py.html0100600000176200017510000000622007306455573030211 0ustar dhellmanndevel Module: standard

Table of Contents

Module: standard Zope-2-CVS-src/lib/python/Products/PythonScripts/standard.py

Python Scripts standard utility module

This module provides helpful functions and classes for use in Python Scripts. It can be accessed from Python with the statement "import Products.PythonScripts.standard"

Imported modules   
from AccessControl import ModuleSecurityInfo, getSecurityManager, full_read_guard
from DocumentTemplate.DT_Var import special_formats, whole_dollars, dollars_and_cents, structured_text, sql_quote, html_quote, url_quote, url_quote_plus, newline_to_br, thousands_commas
from Globals import HTML
Classes   
DTML

DTML objects are DocumentTemplate.HTML objects that allow

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/standard_DTML.py.html0100600000176200017510000001005507306455573031032 0ustar dhellmanndevel Class: DTML

Table of Contents

Class: DTML Zope-2-CVS-src/lib/python/Products/PythonScripts/standard.py

DTML objects are DocumentTemplate.HTML objects that allow dynamic, temporary creation of restricted DTML.

Base Classes   
HTML
Methods   
__call__
read_guard
  __call__  
__call__ (
        self,
        client=None,
        REQUEST={},
        RESPONSE=None,
        **kw,
        )

Render the DTML given a client object, REQUEST mapping, Response, and key word arguments.

  read_guard  
read_guard ( self,  ob )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/tests/0040700000176200017510000000000007306455573026237 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/tests/testPythonScript.py.html0100600000176200017510000001424207306455573033124 0ustar dhellmanndevel Module: testPythonScript

Table of Contents

Module: testPythonScript Zope-2-CVS-src/lib/python/Products/PythonScripts/tests/testPythonScript.py

Imported modules   
from AccessControl.SecurityManagement import newSecurityManager
from Products.PythonScripts.PythonScript import PythonScript
import sys
from unittest import TestCase, TestSuite, VerboseTextTestRunner, makeSuite
Functions   
debug
main
readf
test_suite
  debug  
debug ()

  main  
main ()

  readf  
readf ( name )

  test_suite  
test_suite ()

Classes   
TestPythonScriptNoAq

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017000000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/tests/testPythonScript_TestPythonScriptNoAq.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/tests/testPythonScript_TestPyth0100600000176200017510000004423507306455573033403 0ustar dhellmanndevel Class: TestPythonScriptNoAq

Table of Contents

Class: TestPythonScriptNoAq Zope-2-CVS-src/lib/python/Products/PythonScripts/tests/testPythonScript.py

Base Classes   
TestCase
Methods   
_newPS
fail
testArithmetic
testBigBoolean
testBooleanMap
testComplexPrint
testDoubleNegation
testEmpty
testFibonacci
testForLoop
 testImport
testMutateLiterals
testNSBind
testParam1
testParam2
testParam26
testReturn
testReturnNone
testSimplePrint
testTryExcept
 testTupleUnpackAssignment
testWhileLoop
  _newPS  
_newPS (
        self,
        txt,
        bind=None,
        )

  fail  
fail ( self )

Fail if called

  testArithmetic  
testArithmetic ( self )

  testBigBoolean  
testBigBoolean ( self )

  testBooleanMap  
testBooleanMap ( self )

  testComplexPrint  
testComplexPrint ( self )

  testDoubleNegation  
testDoubleNegation ( self )

  testEmpty  
testEmpty ( self )

  testFibonacci  
testFibonacci ( self )

  testForLoop  
testForLoop ( self )

  testImport  
testImport ( self )

  testMutateLiterals  
testMutateLiterals ( self )

  testNSBind  
testNSBind ( self )

  testParam1  
testParam1 ( self )

  testParam2  
testParam2 ( self )

  testParam26  
testParam26 ( self )

  testReturn  
testReturn ( self )

  testReturnNone  
testReturnNone ( self )

  testSimplePrint  
testSimplePrint ( self )

  testTryExcept  
testTryExcept ( self )

  testTupleUnpackAssignment  
testTupleUnpackAssignment ( self )

  testWhileLoop  
testWhileLoop ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/CHANGES.txt.html0100600000176200017510000001200507306455574027647 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PythonScripts

Table of Contents

Zope2 CVS with ZEO: Products.PythonScripts  

2001-04-26 Evan Simpson <evan@digicool.com>

  • Version 2.0.0 * Totally replaced zbytecodhacks engine with Zope's new RestrictedPython package, which it shares with DTML.

1999-12-13 Evan Simpson <evan@4-am.com>

  • Version 0.1.7 * Nested functions and lambdas are now supported, with full safety. * You can access all of the dtml-var format functions through a builtin dictionary called special_formats (eg: special_formats['html-quote']). * Handing off to Digital Creations for inclusion in CVS. * Packaged with packProduct script, which excludes parent directories and .pyc files. Makes for a smaller package, and doesn't step on ownership/permissions of lib/python/Products path elements.

1999-12-01 Evan Simpson <evan@4-am.com>

  • Added COPYRIGHT.txt, making Wide Open Source licence (BSD-style) explicit. (Mike Goldman provided the text, I provided the silly name). * Jeff Rush donated a PrincipiaSearchSource method, so that PythonMethod objects can be zcataloged to the same degree as DTML Methods. * Also from Jeff Rush, a document_src method, so that the source of PythonMethods can be viewed via a "View Source" link if desired. * If a PM has a traverse_subpath parameter, you can now directly traverse it. The elements of the subpath will then be put into a list in traverse_subpath. (thanks to Anthony Baxter)

1999-11-11 Evan Simpson <evan@4-am.com>

  • Version 0.1.6 * Fix to builtins messed up DTML Methods, so I re-fixed it.

1999-11-05 Evan Simpson <evan@4-am.com>

  • Version 0.1.5 * Killed *%#&$@ weird bug in which having add documents in www subdirectory prevented rename, paste, or import of existing PythonMethods! See use of _www. * Range, test, and several other Zope builtins had an unbound self argument unless called on _, but that's fixed. * Safe multiplication was utterly broken (thanks to the guard); now it works. Is anyone using the safe version??

1999-10-18 Evan Simpson <evan@4-am.com>

  • Eliminated bug which delayed stringification of printed values.

1999-10-08 Evan Simpson <evan@4-am.com>

  • Version 0.1.4 * Fixed mis-design noticed by Michel Pelletier, and refactored MakeFunction. Now both kinds of Python Method have the bugfix from 0.1.3, and shouldn't provoke a transaction when called.

1999-10-07 Evan Simpson <evan@4-am.com>

  • Version 0.1.3 * Fixed parameter bug with self and no defaults

1999-09-24 Evan Simpson <evan@4-am.com>

  • Version 0.1.2 * Added WebDAV/FTP access code donated by Michel Pelletier * Made parameters part of WebDAV/FTP text * Eliminated initialization of globals to None * Added global_exists global function instead * Killed bug with unused parameters * Put switch in Guarded.py to allow both regular and dangerous (XXX) PythonMethods to live side-by-side. This means that people who patched version 0.1.1 will have to re-create any unsafe PMs they use (Sorry).

1999-09-10 Evan Simpson <evan@4-am.com>

  • Version 0.1.1 * Incorporated DT_Util builtins and guards * Fixed direct access via URL * Fixed methodAdd.dtml * rstrip function body * Major changes to zbytecodehacks

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/PythonScripts/README.txt.html0100600000176200017510000000767507306455574027555 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.PythonScripts

Table of Contents

Zope2 CVS with ZEO: Products.PythonScripts  

Python Scripts

The Python Scripts product provides support for restricted execution of Python scripts, exposing them as callable objects within the Zope environment.

Providing access to extra modules

Python script objects have a limited number of "safe" modules available to them by default. In the course of working with Zope, you will probably wish to make other modules available to script objects.

The Utility.py module in the PythonScripts products provides a simple way to make modules available for use by script objects on a site-wide basis. Before making a module available to Python scripts, you should carefully consider the potential for abuse or misuse of the module, since all users with permission to create and edit Python scripts will be able to use any functions and classes defined in the module. In some cases, you may want to create a custom module that just imports a subset of names from another module and make that custom module available to reduce the risk of abuse.

The easiest way to make modules available to Python scripts on your site is to create a new directory in your Products directory containing an "__init__.py" file. At Zope startup time, this "product" will be imported, and any module assertions you make in the __init__.py will take effect. Here's how to do it:

  • In your Products directory (either in lib/python of your Zope installation or in the root of your Zope install, depending on your deployment model), create a new directory with a name like "GlobalModules".

  • In the new directory, create a file named "__init__.py".

  • Edit the __init__.py file, and add calls to the allow_module function (located in the Products.PythonScripts.Utility module), passing the names of modules to be enabled for use by scripts. For example:

    # Global module assertions for Python scripts from Products.PythonScripts.Utility import allow_module

    allow_module(base64) allow_module(re) allow_module(DateTime.DateTime)

    This example adds the modules base64, re and the DateTime module in the DateTime package for use by Python scripts. Note that for packages (dotted names), each module in the package path will become available to script objects.

  • Restart your Zope server. After restarting, the modules you enabled in your custom product will be available to Python scripts.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/SiteAccess/0040700000176200017510000000000007306455574024273 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/SiteAccess/index.html0100600000176200017510000000576107306455574026300 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.SiteAccess

Table of Contents

Zope2 CVS with ZEO: Products.SiteAccess  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/SiteAccess/

CHANGES.txt.html

2000-10-03 Evan Simpson <evan@digicool.com>

README.txt.html

SiteAccess

AccessRule

AccessRule module

SiteRoot

SiteRoot module

VirtualHostMonster

VirtualHostMonster module

__init__

Zope-2-CVS-src/lib/python/Products/SiteAccess/Extensions/

updata

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/SiteAccess/AccessRule.py.html0100600000176200017510000001326207306455574027644 0ustar dhellmanndevel Module: AccessRule

Table of Contents

Module: AccessRule Zope-2-CVS-src/lib/python/Products/SiteAccess/AccessRule.py

AccessRule module

Provide a simple method to set up Access Rules

Imported modules   
from Globals import DTMLFile, MessageDialog
from ZPublisher.BeforeTraverse import registerBeforeTraverse, unregisterBeforeTraverse, queryBeforeTraverse, NameCaller
import os
Functions   
_swallow
getAccessRule
manage_addAccessRule
  _swallow  
_swallow ( request,  prefix )

  getAccessRule  
getAccessRule ( self,  REQUEST=None )

Return the name of the current AccessRule, if any

  manage_addAccessRule  
manage_addAccessRule (
        self,
        method_id=None,
        REQUEST=None,
        **ignored,
        )

Point a __before_traverse__ entry at the specified method

Classes   
AccessRule

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/SiteAccess/AccessRule_AccessRule.py.html0100600000176200017510000000632007306455574031752 0ustar dhellmanndevel Class: AccessRule

Table of Contents

Class: AccessRule Zope-2-CVS-src/lib/python/Products/SiteAccess/AccessRule.py

Base Classes   
NameCaller
Methods   
__call__
  __call__  
__call__ (
        self,
        container,
        request,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/SiteAccess/SiteRoot.py.html0100600000176200017510000001151207306455574027357 0ustar dhellmanndevel Module: SiteRoot

Table of Contents

Module: SiteRoot Zope-2-CVS-src/lib/python/Products/SiteAccess/SiteRoot.py

SiteRoot module

Defines the Traverser base class and SiteRoot class

Imported modules   
from AccessRule import _swallow
from Acquisition import Implicit, ImplicitAcquisitionWrapper
from ExtensionClass import Base
from Globals import DTMLFile, MessageDialog, Persistent
from OFS.SimpleItem import Item
from ZPublisher import BeforeTraverse
import os
from string import split, strip
Functions   
manage_addSiteRoot
  manage_addSiteRoot  
manage_addSiteRoot (
        self,
        title='',
        base='',
        path='',
        REQUEST=None,
        **ignored,
        )

Classes   
SiteRoot

SiteAccess.SiteRoot object

Traverser

Class for overriding container's __before_traverse__

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/SiteAccess/SiteRoot_SiteRoot.py.html0100600000176200017510000001302507306455574031210 0ustar dhellmanndevel Class: SiteRoot

Table of Contents

Class: SiteRoot Zope-2-CVS-src/lib/python/Products/SiteAccess/SiteRoot.py

SiteAccess.SiteRoot object

A SiteRoot causes traversal of its container to replace the part of the Request path traversed so far with the request's SiteRootURL.

Base Classes   
Traverser
    Persistent
    Item
Implicit
Methods   
__call__
__init__
get_size
manage_edit
  __call__  
__call__ (
        self,
        client,
        request,
        response=None,
        )

Traversing

  __init__  
__init__ (
        self,
        title,
        base,
        path,
        )

Title

  get_size  
get_size ( self )

Make FTP happy

  manage_edit  
manage_edit (
        self,
        title,
        base,
        path,
        REQUEST=None,
        )

Set the title, base, and path

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/SiteAccess/SiteRoot_Traverser.py.html0100600000176200017510000001615607306455574031425 0ustar dhellmanndevel Class: Traverser

Table of Contents

Class: Traverser Zope-2-CVS-src/lib/python/Products/SiteAccess/SiteRoot.py

Class for overriding container's __before_traverse__

Containers are expected to have at most one instance of any particular subclass, with Id equal to the meta_type of the subclass.

Base Classes   
Persistent
Item
Methods   
_setId
addToContainer
manage_addToContainer
manage_afterAdd
manage_beforeDelete
  _setId  
_setId ( self,  id )

Exceptions   
Globals.MessageDialog( title = 'Invalid Id', message = 'Cannot change the id of a %s' % self.meta_type, action = './manage_main', )
  addToContainer  
addToContainer ( self,  container )

  manage_addToContainer  
manage_addToContainer (
        self,
        container,
        nextURL='',
        )

  manage_afterAdd  
manage_afterAdd (
        self,
        item,
        container,
        )

  manage_beforeDelete  
manage_beforeDelete (
        self,
        item,
        container,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/SiteAccess/VirtualHostMonster.py.html0100600000176200017510000001135607306455574031451 0ustar dhellmanndevel Module: VirtualHostMonster

Table of Contents

Module: VirtualHostMonster Zope-2-CVS-src/lib/python/Products/SiteAccess/VirtualHostMonster.py

VirtualHostMonster module

Defines the VirtualHostMonster class

Imported modules   
from AccessRule import _swallow
from Acquisition import Implicit, ImplicitAcquisitionWrapper
from ExtensionClass import Base
from Globals import DTMLFile, MessageDialog, Persistent
from OFS.SimpleItem import Item
from ZPublisher import BeforeTraverse
import os
from string import split, strip, join
Functions   
manage_addVirtualHostMonster
  manage_addVirtualHostMonster  
manage_addVirtualHostMonster (
        self,
        id,
        REQUEST=None,
        **ignored,
        )

Classes   
VirtualHostMonster

Provide a simple drop-in solution for virtual hosting.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015700000000000011570 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/SiteAccess/VirtualHostMonster_VirtualHostMonster.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/SiteAccess/VirtualHostMonster_VirtualHostMons0100600000176200017510000001734207306455574033261 0ustar dhellmanndevel Class: VirtualHostMonster

Table of Contents

Class: VirtualHostMonster Zope-2-CVS-src/lib/python/Products/SiteAccess/VirtualHostMonster.py

Provide a simple drop-in solution for virtual hosting.

Base Classes   
Persistent
Item
Implicit
Methods   
__bobo_traverse__
__call__
_setId
addToContainer
manage_addToContainer
manage_afterAdd
manage_beforeDelete
  __bobo_traverse__  
__bobo_traverse__ (
        self,
        request,
        name,
        )

Traversing away

  __call__  
__call__ (
        self,
        client,
        request,
        response=None,
        )

Traversing at home

  _setId  
_setId ( self,  id )

  addToContainer  
addToContainer ( self,  container )

  manage_addToContainer  
manage_addToContainer (
        self,
        container,
        nextURL='',
        )

  manage_afterAdd  
manage_afterAdd (
        self,
        item,
        container,
        )

  manage_beforeDelete  
manage_beforeDelete (
        self,
        item,
        container,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/SiteAccess/__init__.py.html0100600000176200017510000000643607306455574027357 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/SiteAccess/__init__.py

Imported modules   
import AccessRule
import SiteRoot
import VirtualHostMonster
Functions   
initialize
  initialize  
initialize ( context )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/SiteAccess/Extensions/0040700000176200017510000000000007306455574026432 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/SiteAccess/Extensions/updata.py.html0100600000176200017510000000767207306455574031240 0ustar dhellmanndevel Module: updata

Table of Contents

Module: updata Zope-2-CVS-src/lib/python/Products/SiteAccess/Extensions/updata.py

Imported modules   
from Products.SiteAccess.AccessRule import AccessRule
from ZPublisher.BeforeTraverse import NameCaller, rewriteBeforeTraverse
import Zope
Functions   
_cvt_btr
updata
  _cvt_btr  
_cvt_btr ( app )

  updata  
updata ( self )

Convert SiteAccess objects from 1.x to 2.x

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/SiteAccess/CHANGES.txt.html0100600000176200017510000001307107306455574027050 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.SiteAccess

Table of Contents

Zope2 CVS with ZEO: Products.SiteAccess  

2000-10-03 Evan Simpson <evan@digicool.com>

  • Final release * Added VirtualHostMonster, to make common virtual hosting cases easy.

2000-07-20 Evan Simpson <evan@digicool.com>

  • Beta 3 * Fixed bug with SiteRoot deletion * Added ability to turn off SiteRoots and AccessRules on a case-by-case basis, by adding _SUPPRESS_SITEROOT or _SUPPRESS_ACCESSRULE to a URL just after the container name. * Added crude beginnings of Help

2000-06-19 Evan Simpson <evan@digicool.com>

  • Beta 2 * Removed a chunk of code left from 1.0 which messed up SiteRoots

2000-06-09 Evan Simpson <evan@digicool.com>

  • Version 2.0.0 * Changed to use the new virtual hosting support in Zope 2.2 * INCOMPATIBLE with Zope versions prior to 2.2b1 * The tarball no longer includes lib/python/Products in file paths. It must be unpacked in the Products directory, for better compatibility with INSTANCE_HOME installations.

2000-03-21 Evan Simpson <evan@4-am.com>

  • Version 1.0.1 * Fix for FTP incompatibility * Match changes in Zope 2.1.5/6

2000-01-18 Evan Simpson <evan@4-am.com>

  • Version 1.0.0 * Decided that it's been long enough to call it stable * Eliminated stale _v_absolute_url attributes (thanks to Wade Simmons) * Killed peculiar and obscure interaction with ZCatalog

1999-12-15 Evan Simpson <evan@4-am.com>

  • Version 0.2.0 * Got absolute_url to do the right thing under both Zope 2.0 and 2.1. Note that this will change 2.0's behavior to match 2.1

1999-11-19 Evan Simpson <evan@4-am.com>

  • Added COPYRIGHT.txt, making Wide Open Source licence (BSD-style) explicit. (Mike Goldman provided the text, I provided the silly name).

1999-11-18 Evan Simpson <evan@4-am.com>

  • Version 0.1.4 * BASE tags generated for default pages should play nicely with setURL(base=...) * Setting the base but not the path works now. * Added ./doc/ directory with copies of documentation from Zope.org * SiteRoot* variables set in the environment are now seen.

1999-10-29 Evan Simpson <evan@4-am.com>

  • Version 0.1.3 * Using DTML Docs/Methods as Access Rules should work better, and allow normal acquisition. You won't have permissions for anything unless you give the rule a Proxy Role, though. * __no_before_traverse__ at the start of a URL path now persists in generated URLs, making debugging easier.

1999-10-27 Evan Simpson <evan@4-am.com>

  • Version 0.1.2 * Fixed absolute_url() of objects acquired from above the point at which setURL was called (usually by a SiteRoot). (thanks again to Bruce Perens and technocrat.net) * Added Base and Path properties to SiteRoot, with Path defaulting to /, the most commonly used value. If these are blank, it will search for SiteRootBASE and SiteRootPATH. * REQUEST.setURL now accepts either a string or sequence of strings for its path argument.

1999-10-24 Evan Simpson <evan@4-am.com>

  • Version 0.1.1 * Made Access Rules work on unadorned root path (thanks to Bruce Perens) * Reorganized REQUEST.traverse to better handle changes to the path within the loop. * Experimental change: Overrides icon of methods designated as Access Rules to provide visual feedback. This is a fragile hack, but relatively harmless if it fails. (suggested by Evan Gibson) * Fixed Acquisition of SiteRoot* values (thanks to Oleg Broytmann) * Rationalized file permissions (thanks to Joshua Brauer)

1999-10-19 Evan Simpson <evan@4-am.com>

  • Version 0.1.0 * First (apparently) working version * Implemented REQUEST.setURL(base, path) and made SiteRoot use it. * Put a link to existing AccessRule on "Add AccessRule" page.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/SiteAccess/README.txt.html0100600000176200017510000000305707306455574026740 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.SiteAccess

Table of Contents

Zope2 CVS with ZEO: Products.SiteAccess  

SiteAccess

The SiteAccess product provides support for pluggable pre- traversal methods, and supplies objects and methods which can be used to rewrite access URLs at the start of resolution and as folders are traversed.

The main intent is to provide for multi-site hosting in Zope.

More information is available at http://zope.org/Members/4am/SiteAccess

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/0040700000176200017510000000000007306455575026410 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/index.html0100600000176200017510000000466507306455575030417 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.StandardCacheManagers

Table of Contents

Zope2 CVS with ZEO: Products.StandardCacheManagers  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/

AcceleratedHTTPCacheManager

Accelerated HTTP cache manager --

RAMCacheManager

RAM cache manager --

__init__

Some standard Zope cache managers from Digital Creations.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:24 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016000000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/AcceleratedHTTPCacheManager.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/AcceleratedHTTPCacheMan0100600000176200017510000001230107306455574032602 0ustar dhellmanndevel Module: AcceleratedHTTPCacheManager

Table of Contents

Module: AcceleratedHTTPCacheManager Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/AcceleratedHTTPCacheManager.py

Accelerated HTTP cache manager -- Adds caching headers to the response so that downstream caches will cache according to a common policy.

$Id$

Imported modules   
from App.Common import rfc1123_date
import Globals
from Globals import DTMLFile
from OFS.Cache import Cache, CacheManager
from OFS.SimpleItem import SimpleItem
import httplib
from string import lower, join, split
import time
from urllib import quote
import urlparse
Functions   
manage_addAcceleratedHTTPCacheManager
  manage_addAcceleratedHTTPCacheManager  
manage_addAcceleratedHTTPCacheManager (
        self,
        id,
        REQUEST=None,
        )

Classes   
AcceleratedHTTPCache

Note the need to take thread safety into account.

AcceleratedHTTPCacheManager

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:24 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000020500000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/AcceleratedHTTPCacheManager_AcceleratedHTTPCache.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/AcceleratedHTTPCacheMan0100600000176200017510000001444107306455574032611 0ustar dhellmanndevel Class: AcceleratedHTTPCache

Table of Contents

Class: AcceleratedHTTPCache Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/AcceleratedHTTPCacheManager.py

Note the need to take thread safety into account. Also note that objects of this class are not persistent, nor do they use acquisition.

Base Classes   
Cache
Methods   
ZCache_get
ZCache_invalidate
ZCache_set
__init__
initSettings
  ZCache_get  
ZCache_get (
        self,
        ob,
        view_name,
        keywords,
        mtime_func,
        default,
        )

  ZCache_invalidate  
ZCache_invalidate ( self,  ob )

  ZCache_set  
ZCache_set (
        self,
        ob,
        data,
        view_name,
        keywords,
        mtime_func,
        )

  __init__  
__init__ ( self )

  initSettings  
initSettings ( self,  kw )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:24 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000021400000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/AcceleratedHTTPCacheManager_AcceleratedHTTPCacheManager.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/AcceleratedHTTPCacheMan0100600000176200017510000002053707306455574032614 0ustar dhellmanndevel Class: AcceleratedHTTPCacheManager

Table of Contents

Class: AcceleratedHTTPCacheManager Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/AcceleratedHTTPCacheManager.py

Base Classes   
CacheManager
SimpleItem
Methods   
ZCacheManager_getCache
__init__
_getSortInfo
getCacheReport
getId
getSettings
manage_editProps
sort_link
  ZCacheManager_getCache  
ZCacheManager_getCache ( self )

  __init__  
__init__ ( self,  ob_id )

  _getSortInfo  
_getSortInfo ( self )

Returns the value of sort_by and sort_reverse. If not found, returns default values.

  getCacheReport  
getCacheReport ( self )

Returns the list of objects in the cache, sorted according to the user's preferences.

  getId  
getId ( self )

  getSettings  
getSettings ( self )

  manage_editProps  
manage_editProps (
        self,
        title,
        settings=None,
        REQUEST=None,
        )

  sort_link  
sort_link (
        self,
        name,
        id,
        )

Utility for generating a sort link.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:24 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/RAMCacheManager.py.html0100600000176200017510000001231007306455575032557 0ustar dhellmanndevel Module: RAMCacheManager

Table of Contents

Module: RAMCacheManager Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/RAMCacheManager.py

RAM cache manager -- Caches the results of method calls in RAM.

$Id$

Imported modules   
import Globals
from Globals import DTMLFile
from OFS.Cache import Cache, CacheManager
from OFS.SimpleItem import SimpleItem
from string import join, split
from thread import allocate_lock
import time
Functions   
manage_addRAMCacheManager
  manage_addRAMCacheManager  
manage_addRAMCacheManager (
        self,
        id,
        REQUEST=None,
        )

Adds a RAM cache manager to the folder.

Classes   
CacheEntry

Represents a cached value.

CacheException

A cache-related exception.

ObjectCacheEntries

Represents the cache for one Zope object.

RAMCache
RAMCacheManager

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:24 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015700000000000011570 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/RAMCacheManager_CacheEntry.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/RAMCacheManager_CacheEn0100600000176200017510000000641507306455574032543 0ustar dhellmanndevel Class: CacheEntry

Table of Contents

Class: CacheEntry Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/RAMCacheManager.py

Represents a cached value.

Methods   
__init__
  __init__  
__init__ (
        self,
        index,
        data,
        view_name,
        )

Exceptions   
CacheException( 'The data for the cache is not pickleable.' )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:24 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016300000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/RAMCacheManager_CacheException.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/RAMCacheManager_CacheEx0100600000176200017510000000370407306455574032553 0ustar dhellmanndevel Class: CacheException

Table of Contents

Class: CacheException Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/RAMCacheManager.py

A cache-related exception.

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:24 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016700000000000011571 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/RAMCacheManager_ObjectCacheEntries.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/RAMCacheManager_ObjectC0100600000176200017510000001316707306455574032570 0ustar dhellmanndevel Class: ObjectCacheEntries

Table of Contents

Class: ObjectCacheEntries Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/RAMCacheManager.py

Represents the cache for one Zope object.

Methods   
__init__
aggregateIndex
delEntry
getEntry
setEntry
  __init__  
__init__ ( self,  path )

  aggregateIndex  
aggregateIndex (
        self,
        view_name,
        req,
        req_names,
        local_keys,
        )

Returns the index to be used when looking for or inserting a cache entry. view_name is a string. local_keys is a mapping or None.

  delEntry  
delEntry ( self,  index )

  getEntry  
getEntry (
        self,
        lastmod,
        index,
        )

  setEntry  
setEntry (
        self,
        lastmod,
        index,
        data,
        view_name,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:24 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/RAMCacheManager_RAMCache.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/RAMCacheManager_RAMCach0100600000176200017510000003053307306455575032452 0ustar dhellmanndevel Class: RAMCache

Table of Contents

Class: RAMCache Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/RAMCacheManager.py

Base Classes   
Cache
Methods   
ZCache_get
ZCache_invalidate
ZCache_set
__init__
cleanup
clearAccessCounters
countAccesses
countAllEntries
deleteEntriesAtOrBelowThreshold
deleteStaleEntries
 getCacheReport
getObjectCacheEntries
initSettings
  ZCache_get  
ZCache_get (
        self,
        ob,
        view_name='',
        keywords=None,
        mtime_func=None,
        default=None,
        )

Gets a cache entry or returns default.

  ZCache_invalidate  
ZCache_invalidate ( self,  ob )

Invalidates the cache entries that apply to ob.

  ZCache_set  
ZCache_set (
        self,
        ob,
        data,
        view_name='',
        keywords=None,
        mtime_func=None,
        )

Sets a cache entry.

  __init__  
__init__ ( self )

  cleanup  
cleanup ( self )

Removes cache entries.

  clearAccessCounters  
clearAccessCounters ( self )

Clears access_count for each cache entry.

  countAccesses  
countAccesses ( self )

Returns a mapping of (n) -> number of entries accessed (n) times

  countAllEntries  
countAllEntries ( self )

Returns the count of all cache entries.

  deleteEntriesAtOrBelowThreshold  
deleteEntriesAtOrBelowThreshold ( self,  threshold_access_count )

Deletes entries that haven't been accessed recently.

  deleteStaleEntries  
deleteStaleEntries ( self )

Deletes entries that have expired.

  getCacheReport  
getCacheReport ( self )

Reports on the contents of the cache.

  getObjectCacheEntries  
getObjectCacheEntries (
        self,
        ob,
        create=0,
        )

Finds or creates the associated ObjectCacheEntries object. Remember to lock writelock when calling with the create flag.

  initSettings  
initSettings ( self,  kw )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:24 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016400000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/RAMCacheManager_RAMCacheManager.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/RAMCacheManager_RAMCach0100600000176200017510000002045107306455575032450 0ustar dhellmanndevel Class: RAMCacheManager

Table of Contents

Class: RAMCacheManager Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/RAMCacheManager.py

Base Classes   
CacheManager
SimpleItem
Methods   
ZCacheManager_getCache
__init__
_getSortInfo
getCacheReport
getId
getSettings
manage_editProps
sort_link
  ZCacheManager_getCache  
ZCacheManager_getCache ( self )

  __init__  
__init__ ( self,  ob_id )

  _getSortInfo  
_getSortInfo ( self )

Returns the value of sort_by and sort_reverse. If not found, returns default values.

  getCacheReport  
getCacheReport ( self )

Returns the list of objects in the cache, sorted according to the user's preferences.

  getId  
getId ( self )

  getSettings  
getSettings ( self )

Returns the current cache settings.

  manage_editProps  
manage_editProps (
        self,
        title,
        settings=None,
        REQUEST=None,
        )

Changes the cache settings.

  sort_link  
sort_link (
        self,
        name,
        id,
        )

Utility for generating a sort link.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:24 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/__init__.py.html0100600000176200017510000000645307306455575031473 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/StandardCacheManagers/__init__.py

Some standard Zope cache managers from Digital Creations.

$Id$

Imported modules   
import AcceleratedHTTPCacheManager
import RAMCacheManager
Functions   
initialize
  initialize  
initialize ( context )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:24 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/0040700000176200017510000000000007306455577023754 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/index.html0100600000176200017510000000725507306455577025761 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.ZCatalog

Table of Contents

Zope2 CVS with ZEO: Products.ZCatalog  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/ZCatalog/

CHANGES.txt.html

Catalog Changes

README.txt.html

ZCatalog

Catalog
CatalogAwareness

ZCatalog Findable class

CatalogAwarenessInterface
CatalogBrains
CatalogPathAwareness

ZCatalog Findable class

Lazy
Vocabulary
ZCatalog

ZCatalog product

ZCatalogIndexes
__init__

ZCatalog product

tests

Zope2 CVS with ZEO: Products.ZCatalog.tests

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/0040700000176200017510000000000007306455575025114 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/index.html0100600000176200017510000000512707306455575027115 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.ZCatalog.tests

Table of Contents

Zope2 CVS with ZEO: Products.ZCatalog.tests  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/

__init__
keywords
loadmail

Test script for exercising various catalog features under load

testCatalog

Testsuite for testing Catalogs

testCatalogTiming

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/__init__.py.html0100600000176200017510000000246307306455575030174 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/keywords.py.html0100600000176200017510000000570607306455575030307 0ustar dhellmanndevel Module: keywords

Table of Contents

Module: keywords Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/keywords.py

Imported modules   
import cPickle
import mailbox
import rfc822
import string
Classes   
Keywords

stupid class to read a list of rfc822 messages and extract

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/keywords_Keywords.py.html0100600000176200017510000001125307306455575032170 0ustar dhellmanndevel Class: Keywords

Table of Contents

Class: Keywords Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/keywords.py

stupid class to read a list of rfc822 messages and extract all words from the subject header. We use this class for testing purposes only

Methods   
__init__
build
keywords
reload
  __init__  
__init__ ( self )

  build  
build (
        self,
        mbox,
        limit,
        )

  keywords  
keywords ( self )

  reload  
reload ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/loadmail.py.html0100600000176200017510000004322307306455575030216 0ustar dhellmanndevel Module: loadmail

Table of Contents

Module: loadmail Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/loadmail.py

Test script for exercising various catalog features under load

Usage: cd lib/python python Products/ZCatalog/tests/loadmail.py command args

where each command has it's own command-line arguments that it expects.

Note that all of the commands operate on the Zope database, typically var/Data.fs.

Note that this script uses the proc file system to get memory size.

Many of the commands output performance statisics on lines that look like:

      11.3585170507 0.06 2217781L 7212

where the numbers are:

  • clock time in seconds

  • cpu time used by the main thread, in seconds,

  • Database size growth over the test

  • Memory growth during the test (if the proc file system is available).

Commands:

base mbox max

Build a base database by:

  • Deleting ../../Data.fs

  • Starting Zope

  • Adding a top-level folder names mail

  • Reading up to max messages from the Unix mailbox file, mbox and adding them as documents to the mail folder.

index threshold

Index all of the DTML documents in the database, committing sub-transactions after each threshold objects.

If the threshold is less than the number of messages, then the size of the temporary sub-transaction commit file is output.

inc mbox start end [threads wait]

Incrementally index messages start to end in unix mailbox mbox.

If the threads argument is supplied, then it specifies the number of threads to use. For example, with:

python Products/ZCatalog/tests/loadmail.py inc mbox 0 200 2

One thread indexes messages 0 to 99 and another thread indexes messages 100 to 199.

If wait is specified, then after each document is indexed, the thread sleeps a random number of seconds between 0 and 2*wait. The default wait is 0.25 seconds.

For each thread, a line that looks like:

           3.41 (0, 1)

is output, containing:

  • The cpu time

  • The number of ZODB trabsaction conflicts detected when reading

  • The number of ZODB trabsaction conflicts detected when committing

edit edits deletes inserts threads wait

Incrementally edit edits messages from mail. For each message, do a random number of word deletes between 0 and deletes * 2 and do a random number of inserts between 0 and inserts * 2.

For each thread, a line that looks like:

           3.41 (0, 1)

as described above.

pdebug command args

Run one of the other commands in the Python debugger.

sample suite of tests:

    cd lib/python
    python Products/ZCatalog/tests/loadmail.py base ~/zope.mbox 1000
    python Products/ZCatalog/tests/loadmail.py index 100
    python Products/ZCatalog/tests/loadmail.py inc ~/python-dev.mbox 0 10 2
    python Products/ZCatalog/tests/loadmail.py edit 10 10 10 2
Imported modules   
from ZODB.utils import u64
import mailbox
import os
import string
from string import strip, find, split, lower, atoi
import sys
import time
from urllib import quote
import whrandom
Functions   
VmSize
base
buildbase
do
edit
hist
inc
incedit
index
indexf
 initmaili
loadinc
loadmail
loadmessage
pdebug
  VmSize  
VmSize ()

  base  
base ()

  buildbase  
buildbase ()

  do  
do (
        db,
        f,
        args,
        returnf=None,
        )

Do something and measure it's impact

  edit  
edit ()

  hist  
hist ( n )

  inc  
inc ()

  incedit  
incedit (
        edits,
        wait,
        ndel=20,
        nins=20,
        )

  index  
index ()

  indexf  
indexf ( app )

  initmaili  
initmaili ( n )

  loadinc  
loadinc (
        name,
        mb,
        printstat=0,
        max=99999999,
        wait=1,
        )

  loadmail  
loadmail (
        dest,
        name,
        mbox,
        printstat=0,
        max=99999999,
        )

  loadmessage  
loadmessage (
        dest,
        message,
        i,
        body=None,
        headers=None,
        )

  pdebug  
pdebug ()

Classes   
RE

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/loadmail_RE.py.html0100600000176200017510000000501407306455575030600 0ustar dhellmanndevel Class: RE

Table of Contents

Class: RE Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/loadmail.py

Methods   
redirect
  redirect  
redirect ( *args,  *kw )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog.py.html0100600000176200017510000003143607306455575030711 0ustar dhellmanndevel Module: testCatalog

Table of Contents

Module: testCatalog Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog.py

Testsuite for testing Catalogs $Id: testCatalog.py,v 1.5 2001/04/17 17:08:13 chrism Exp $

Andreas Jung, andreas@digicool.com

$Log: testCatalog.py,v $ Revision 1.5 2001/04/17 17:08:13 chrism Merging into trunk.

Revision 1.1.6.5 2001/04/17 17:01:21 chrism More tests.

Revision 1.1.6.4.2.1 2001/04/17 06:39:45 chrism added further tests for catalog object in test_suite.

Revision 1.1.6.4 2001/04/05 16:18:05 chrism Added test for empty mapping returns all.

Revision 1.4 2001/04/05 16:15:36 chrism added test for empty mapping returns all.

Revision 1.3 2001/03/23 23:34:14 chrism Merge from branch.

Revision 1.1.6.3 2001/03/23 23:32:02 chrism Added catalog length test.

Revision 1.1.6.2 2001/03/23 19:38:52 chrism added checkUncatalogTwice test.

Revision 1.1.6.1 2001/03/15 13:10:32 jim Merged changes from Catalog-BTrees-Integration branch.

Revision 1.1.4.11 2001/03/14 18:43:16 andreas rearranged source code

Revision 1.1.4.10 2001/03/14 15:12:24 andreas minor changes

Revision 1.1.4.9 2001/03/13 22:45:07 andreas yet another try/except clause (zope mbox file seems to contain some sloppy messages)

Revision 1.1.4.8 2001/03/13 22:04:20 andreas added try/except while reading and parsing the mbox file

Revision 1.1.4.7 2001/03/13 16:51:07 andreas code cleanup

Revision 1.1.4.6 2001/03/13 14:37:40 andreas prelimary version for integration into the Zope testsuites

Revision 1.1.4.5 2001/03/11 22:33:40 andreas commit

Revision 1.1.2.23 2001/03/09 16:06:10 andreas integrated chris unittestCatalog.py

Revision 1.1.2.22 2001/03/09 15:05:28 andreas rewrote testUpdates()

Revision 1.1.2.21 2001/03/08 18:42:28 andreas fixed typo

Revision 1.1.4.4 2001/03/08 12:14:27 andreas minor changes

Revision 1.1.2.20 2001/03/07 14:58:40 andreas *** empty log message ***

Revision 1.1.2.19 2001/03/07 14:07:51 andreas Code cleanup

Revision 1.1.2.18 2001/03/07 12:46:32 andreas added advanced tests

Revision 1.1.2.17 2001/03/07 10:28:27 andreas reworked version now using the new thread dispatcher

Revision 1.1.2.16 2001/03/05 15:14:51 andreas - minor changes in testing catalog/uncatalogObject - tests must now be started in the lib/python directory - older input sets are no longer valid (must be recreated)

Imported modules   
import ExtensionClass
import Persistence
from Products.ZCatalog import Catalog, ZCatalog, Vocabulary
from Products.ZCatalog.Catalog import CatalogError
from SearchIndex.Lexicon import Lexicon
from SearchIndex.UnIndex import UnIndex
from SearchIndex.UnKeywordIndex import UnKeywordIndex
from SearchIndex.UnTextIndex import UnTextIndex
from Testing import dispatcher, unittest
import ZODB
import ZODB.FileStorage
import Zope
import getopt
import keywords
import mailbox
import os
import rfc822
import string
import sys
import time
import whrandom
from zLOG import LOG
Functions   
debug
get_tests
main
pdebug
test_suite
usage
  debug  
debug ()

  get_tests  
get_tests ( what )

  main  
main ()

  pdebug  
pdebug ()

  test_suite  
test_suite ()

  usage  
usage ( program )

Classes   
BuildEnv

build environment

CatalogBase
TestAddDelColumn
TestAddDelIndexes
TestCatalogObject
TestZCatalogObject
objRS
testCatalog

Wrapper around the catalog stuff

testMessage
testRS
testSearches

test searches

testZODB

some wrapper stuff around ZODB

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_BuildEnv.py.html0100600000176200017510000001144107306455575032473 0ustar dhellmanndevel Class: BuildEnv

Table of Contents

Class: BuildEnv Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog.py

build environment

Base Classes   
dispatcher.Dispatcher
unittest.TestCase
Methods   
__init__
buildTestEnvironment
funcTestEnvironment
  __init__  
__init__ (
        self,
        func,
        *args,
        *kw,
        )

  buildTestEnvironment  
buildTestEnvironment (
        self,
        args,
        kw,
        )

  funcTestEnvironment  
funcTestEnvironment (
        self,
        dataDir,
        maxFiles,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_CatalogBase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_CatalogBase.py.htm0100600000176200017510000000627707306455575032767 0ustar dhellmanndevel Class: CatalogBase

Table of Contents

Class: CatalogBase Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog.py

Methods   
setUp
tearDown
  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_TestAddDelColumn.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_TestAddDelColumn.p0100600000176200017510000001242407306455575032764 0ustar dhellmanndevel Class: TestAddDelColumn

Table of Contents

Class: TestAddDelColumn Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog.py

Base Classes   
CatalogBase
unittest.TestCase
Methods   
checkAdd
checkAddBad
checkDel
  checkAdd  
checkAdd ( self )

  checkAddBad  
checkAddBad ( self )

Exceptions   
'invalid metadata column check failed'
  checkDel  
checkDel ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_TestAddDelIndexes.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_TestAddDelIndexes.0100600000176200017510000001566307306455575032756 0ustar dhellmanndevel Class: TestAddDelIndexes

Table of Contents

Class: TestAddDelIndexes Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog.py

Base Classes   
CatalogBase
unittest.TestCase
Methods   
checkAddFieldIndex
checkAddKeywordIndex
checkAddTextIndex
checkDelFieldIndex
checkDelKeywordIndex
checkDelTextIndex
  checkAddFieldIndex  
checkAddFieldIndex ( self )

  checkAddKeywordIndex  
checkAddKeywordIndex ( self )

  checkAddTextIndex  
checkAddTextIndex ( self )

  checkDelFieldIndex  
checkDelFieldIndex ( self )

  checkDelKeywordIndex  
checkDelKeywordIndex ( self )

  checkDelTextIndex  
checkDelTextIndex ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_TestCatalogObject.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_TestCatalogObject.0100600000176200017510000006055707306455575033024 0ustar dhellmanndevel Class: TestCatalogObject

Table of Contents

Class: TestCatalogObject Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog.py

Base Classes   
unittest.TestCase
Methods   
_second
badsortindex
checkBadSortIndex
checkBadUncatalog
checkCatalogLength
checkCombinedTextandKeywordQuery
checkEmptyMappingReturnsAll
checkFieldIndexLength
checkGoodSortIndex
checkKeywordIndexLength
 checkKeywordIndexWithMaxRange
checkKeywordIndexWithMinMaxRangeCorrectSyntax
checkKeywordIndexWithMinMaxRangeWrongSyntax
checkKeywordIndexWithMinRange
checkResultLength
checkTextIndexLength
checkTextIndexQWithSortOn
checkTextIndexQWithoutSortOn
checkUncatalogFieldIndex
checkUncatalogKeywordIndex
 checkUncatalogTextIndex
checkUncatalogTwice
checkUniqueValuesForContent
checkUniqueValuesForLength
checkWrongKindOfIndexForSort
setUp
tearDown
uncatalog
wrongsortindex
  _second  
_second ( self )

  badsortindex  
badsortindex ( self )

  checkBadSortIndex  
checkBadSortIndex ( self )

  checkBadUncatalog  
checkBadUncatalog ( self )

  checkCatalogLength  
checkCatalogLength ( self )

  checkCombinedTextandKeywordQuery  
checkCombinedTextandKeywordQuery ( self )

  checkEmptyMappingReturnsAll  
checkEmptyMappingReturnsAll ( self )

  checkFieldIndexLength  
checkFieldIndexLength ( self )

  checkGoodSortIndex  
checkGoodSortIndex ( self )

  checkKeywordIndexLength  
checkKeywordIndexLength ( self )

  checkKeywordIndexWithMaxRange  
checkKeywordIndexWithMaxRange ( self )

  checkKeywordIndexWithMinMaxRangeCorrectSyntax  
checkKeywordIndexWithMinMaxRangeCorrectSyntax ( self )

  checkKeywordIndexWithMinMaxRangeWrongSyntax  
checkKeywordIndexWithMinMaxRangeWrongSyntax ( self )

checkKeywordIndex with min/max range wrong syntax - known to fail

  checkKeywordIndexWithMinRange  
checkKeywordIndexWithMinRange ( self )

  checkResultLength  
checkResultLength ( self )

  checkTextIndexLength  
checkTextIndexLength ( self )

  checkTextIndexQWithSortOn  
checkTextIndexQWithSortOn ( self )

  checkTextIndexQWithoutSortOn  
checkTextIndexQWithoutSortOn ( self )

  checkUncatalogFieldIndex  
checkUncatalogFieldIndex ( self )

  checkUncatalogKeywordIndex  
checkUncatalogKeywordIndex ( self )

  checkUncatalogTextIndex  
checkUncatalogTextIndex ( self )

  checkUncatalogTwice  
checkUncatalogTwice ( self )

  checkUniqueValuesForContent  
checkUniqueValuesForContent ( self )

  checkUniqueValuesForLength  
checkUniqueValuesForLength ( self )

  checkWrongKindOfIndexForSort  
checkWrongKindOfIndexForSort ( self )

  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

  uncatalog  
uncatalog ( self )

  wrongsortindex  
wrongsortindex ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_TestZCatalogObject.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_TestZCatalogObject0100600000176200017510000001432207306455575033065 0ustar dhellmanndevel Class: TestZCatalogObject

Table of Contents

Class: TestZCatalogObject Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog.py

Base Classes   
unittest.TestCase
Methods   
checkInstantiateWithGlobbingVocab
checkInstantiateWithNormalVocab
checkInstantiateWithoutVocab
setUp
tearDown
  checkInstantiateWithGlobbingVocab  
checkInstantiateWithGlobbingVocab ( self )

  checkInstantiateWithNormalVocab  
checkInstantiateWithNormalVocab ( self )

  checkInstantiateWithoutVocab  
checkInstantiateWithoutVocab ( self )

  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_objRS.py.html0100600000176200017510000000625307306455575032007 0ustar dhellmanndevel Class: objRS

Table of Contents

Class: objRS Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog.py

Base Classes   
ExtensionClass.Base
Methods   
__init__
  __init__  
__init__ ( self,  num )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_testCatalog.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_testCatalog.py.htm0100600000176200017510000001253707306455575033070 0ustar dhellmanndevel Class: testCatalog

Table of Contents

Class: testCatalog Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog.py

Wrapper around the catalog stuff

Base Classes   
Persistence.Persistent
unittest.TestCase
Methods   
__init__
build_catalog
catMessage
uncatMessage
  __init__  
__init__ (
        self,
        mboxname,
        maxfiles,
        )

  build_catalog  
build_catalog ( self,  mboxname )

  catMessage  
catMessage ( self,  m )

  uncatMessage  
uncatMessage ( self,  uid )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_testMessage.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_testMessage.py.htm0100600000176200017510000001110707306455575033072 0ustar dhellmanndevel Class: testMessage

Table of Contents

Class: testMessage Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog.py

Base Classes   
ExtensionClass.Base
Methods   
__del__
__init__
reverse
  __del__  
__del__ ( self )

  __init__  
__init__ (
        self,
        msg,
        modify_doc=0,
        )

  reverse  
reverse ( self,  s )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_testRS.py.html0100600000176200017510000000755507306455575032222 0ustar dhellmanndevel Class: testRS

Table of Contents

Class: testRS Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog.py

Base Classes   
unittest.TestCase
Methods   
setUp
testRangeSearch
  setUp  
setUp ( self )

  testRangeSearch  
testRangeSearch ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_testSearches.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_testSearches.py.ht0100600000176200017510000005057007306455575033075 0ustar dhellmanndevel Class: testSearches

Table of Contents

Class: testSearches Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog.py

test searches

Base Classes   
dispatcher.Dispatcher
unittest.TestCase
Methods   
__init__
funcFieldIndex
funcFieldRangeIndex
funcFulltextIndex
funcKeywordIndex
funcKeywordRangeIndex
funcReindexing
funcUpdates
get_catalog
log_zodb_size
 setUp
setupUpdatesMethod
size2size
tearDown
testFieldIndex
testFieldRangeIndex
testFulltextIndex
testIncrementalIndexing
testKeywordIndex
testKeywordRangeIndex
 testReindexing
testReindexingAndModify
testUpdates
zodb_size
  __init__  
__init__ (
        self,
        func,
        *args,
        *kw,
        )

  funcFieldIndex  
funcFieldIndex ( self,  *args )

benchmark FieldIndex

  funcFieldRangeIndex  
funcFieldRangeIndex ( self,  *args )

benchmark FieldRangeIndex

  funcFulltextIndex  
funcFulltextIndex ( self,  *args )

benchmark FulltextIndex

  funcKeywordIndex  
funcKeywordIndex ( self,  *args )

benchmark KeywordIndex

  funcKeywordRangeIndex  
funcKeywordRangeIndex ( self,  *args )

benchmark Keyword & IndexRange search

  funcReindexing  
funcReindexing (
        self,
        mbox,
        numfiles=100,
        modify_doc=0,
        )

test reindexing of existing data

  funcUpdates  
funcUpdates (
        self,
        *args,
        *kw,
        )

benchmark concurrent catalog/uncatalog operations

  get_catalog  
get_catalog ( self )

return a catalog object

  log_zodb_size  
log_zodb_size (
        self,
        s,
        n,
        )

  setUp  
setUp ( self )

  setupUpdatesMethod  
setupUpdatesMethod ( self,  numUpdates )

this method prepares a datastructure for the updates test. we are reading the first n mails from the primary mailbox. they are used for the update test

  size2size  
size2size ( self,  n )

  tearDown  
tearDown ( self )

  testFieldIndex  
testFieldIndex (
        self,
        args,
        kw,
        )

benchmark field index

  testFieldRangeIndex  
testFieldRangeIndex (
        self,
        args,
        kw,
        )

benchmark field range index

  testFulltextIndex  
testFulltextIndex (
        self,
        args,
        kw,
        )

benchmark FulltextIndex

  testIncrementalIndexing  
testIncrementalIndexing (
        self,
        args,
        kw,
        )

testing incremental indexing

  testKeywordIndex  
testKeywordIndex (
        self,
        args,
        kw,
        )

benchmark Keyword index

  testKeywordRangeIndex  
testKeywordRangeIndex (
        self,
        args,
        kw,
        )

benchmark Keyword range index

  testReindexing  
testReindexing (
        self,
        args,
        kw,
        )

test reindexing of existing data

  testReindexingAndModify  
testReindexingAndModify (
        self,
        args,
        kw,
        )

test reindexing of existing data but with modifications

  testUpdates  
testUpdates (
        self,
        args,
        kw,
        )

benchmark concurrent catalog/uncatalog operations

  zodb_size  
zodb_size ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog_testZODB.py.html0100600000176200017510000001117607306455575032426 0ustar dhellmanndevel Class: testZODB

Table of Contents

Class: testZODB Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalog.py

some wrapper stuff around ZODB

Methods   
__del__
__init__
read
write
  __del__  
__del__ ( self )

  __init__  
__init__ (
        self,
        file="data/work/Data.fs",
        open=1,
        )

  read  
read ( self,  name )

  write  
write (
        self,
        name,
        obj,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalogTiming.py.html0100600000176200017510000002117207306455575032055 0ustar dhellmanndevel Module: testCatalogTiming

Table of Contents

Module: testCatalogTiming Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalogTiming.py

Imported modules   
from Products.ZCatalog import ZCatalog
from Testing.makerequest import makerequest
import Zope
import httplib
import mailbox
import os
from string import strip, find, split, lower, atoi, join
import sys
import time
from unittest import TestCase, TestSuite, JUnitTextTestRunner, VerboseTextTestRunner, makeSuite
from urllib import quote
Functions   
debug
loadmail
main
out
test_suite
  debug  
debug ()

  loadmail  
loadmail (
        folder,
        name,
        mbox,
        max=None,
        catalog=None,
        )

creates a folder inside object folder named name, opens filename mbox and adds max mail messages as DTML documents to the ZODB inside the folder named name. If catalog (which should be a ZCatalog object) is passed in, call catalog_object on it with the document while we're iterating. If max is not None, only do max messages, else do all messages in the mbox archive.

  main  
main ()

Exceptions   
"Error reading from host %s" % server
  out  
out ( s )

  test_suite  
test_suite ()

Classes   
TestTimeIndex

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalogTiming_TestTimeIndex.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalogTiming_TestTimeInde0100600000176200017510000001412207306455575033076 0ustar dhellmanndevel Class: TestTimeIndex

Table of Contents

Class: TestTimeIndex Zope-2-CVS-src/lib/python/Products/ZCatalog/tests/testCatalogTiming.py

Base Classes   
TestCase
Methods   
checkTimeBulkIndex
checkTimeIncrementalIndexAndQuery
checkTimeSubcommit
setUp
tearDown
  checkTimeBulkIndex  
checkTimeBulkIndex ( self )

  checkTimeIncrementalIndexAndQuery  
checkTimeIncrementalIndexAndQuery ( self )

  checkTimeSubcommit  
checkTimeSubcommit ( self )

  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:59 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/Catalog.py.html0100600000176200017510000000772107306455576026650 0ustar dhellmanndevel Module: Catalog

Table of Contents

Module: Catalog Zope-2-CVS-src/lib/python/Products/ZCatalog/Catalog.py

Imported modules   
import Acquisition
from BTrees.IIBTree import intersection, weightedIntersection
from BTrees.IOBTree import IOBTree
import BTrees.Length
from BTrees.OIBTree import OIBTree
from CatalogBrains import AbstractCatalogBrain, NoBrainer
import ExtensionClass
from Lazy import LazyMap, LazyFilter, LazyCat
from Missing import MV
from MultiMapping import MultiMapping
from Persistence import Persistent
from Products.PluginIndexes.TextIndex.Lexicon import Lexicon
from Products.PluginIndexes.common.randid import randid
import Record
from string import lower
import time
from zLOG import LOG, ERROR
Classes   
Catalog

An Object Catalog

CatalogError

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/Catalog_Catalog.py.html0100600000176200017510000006075407306455576030307 0ustar dhellmanndevel Class: Catalog

Table of Contents

Class: Catalog Zope-2-CVS-src/lib/python/Products/ZCatalog/Catalog.py

An Object Catalog

An Object Catalog maintains a table of object metadata, and a series of manageable indexes to quickly search for objects (references in the metadata) that satisfy a search query.

This class is not Zope specific, and can be used in any python program to build catalogs of objects. Note that it does require the objects to be Persistent, and thus must be used with ZODB3.

Base Classes   
Persistent
Acquisition.Implicit
ExtensionClass.Base
Methods   
__getitem__
__init__
__len__
__setstate__
_convertBTrees
_indexedSearch
addColumn
addIndex
catalogObject
clear
 delColumn
delIndex
getIndexDataForRID
getMetadataForRID
hasuid
instantiate
recordify
reindexIndex
searchResults
uncatalogObject
 uniqueValuesFor
updateBrains
useBrains
  __getitem__  
__getitem__ (
        self,
        index,
        ttype=type(() ),
        )

Returns instances of self._v_brains, or whatever is passed into self.useBrains.

  __init__  
__init__ (
        self,
        vocabulary=None,
        brains=None,
        )

  __len__  
__len__ ( self )

  __setstate__  
__setstate__ ( self,  state )

initialize your brains. This method is called when the catalog is first activated (from the persistent storage)

  _convertBTrees  
_convertBTrees ( self,  threshold=200 )

  _indexedSearch  
_indexedSearch (
        self,
        request,
        sort_index,
        append,
        used,
        )

Iterate through the indexes, applying the query to each one.

Exceptions   
ValueError, ( "Incorrect index name passed as" " 'sort_on' parameter. Note that you may only" " sort on values for which there is a matching" " index available." )
  addColumn  
addColumn (
        self,
        name,
        default_value=None,
        )

adds a row to the meta data schema

Exceptions   
'Column Exists', 'The column exists'
'Invalid Meta-Data Name', 'Cannot cache fields beginning with "_"'
  addIndex  
addIndex (
        self,
        name,
        index_type,
        )

Create a new index, given a name and a index_type.

Old format: index_type was a string, FieldIndex 'TextIndex' or KeywordIndex is no longer valid; the actual index must be instantiated and passed in to addIndex.

New format: index_type is the actual index object to be stored.

Exceptions   
'Index Exists', 'The index specified already exists'
'Invalid Index Name', 'Cannot index fields beginning with "_"'
'Invalid Index Name', 'Name of index is empty'
TypeError, """Catalog addIndex now requires the index type to be resolved prior to adding; create the proper index in the caller."""
  catalogObject  
catalogObject (
        self,
        object,
        uid,
        threshold=None,
        idxs=[],
        )

Adds an object to the Catalog by iteratively applying it all indexes.

object is the object to be cataloged

uid is the unique Catalog identifier for this object

  clear  
clear ( self )

clear catalog

  delColumn  
delColumn ( self,  name )

deletes a row from the meta data schema

  delIndex  
delIndex ( self,  name )

deletes an index

Exceptions   
'No Index', 'The index specified does not exist'
  getIndexDataForRID  
getIndexDataForRID ( self,  rid )

  getMetadataForRID  
getMetadataForRID ( self,  rid )

  hasuid  
hasuid ( self,  uid )

return the rid if catalog contains an object with uid

  instantiate  
instantiate ( self,  record )

  recordify  
recordify ( self,  object )

turns an object into a record tuple

  reindexIndex  
reindexIndex ( self,  name )

  searchResults  
searchResults (
        self,
        REQUEST=None,
        used=None,
        **kw,
        )

Exceptions   
CatalogError( 'The index chosen for sort_on is not capable of being' ' used as a sort index.' )
CatalogError, ( 'Unknown sort_on index %s' % sort_index )
  uncatalogObject  
uncatalogObject ( self,  uid )

Uncatalog and object from the Catalog. and uid is a unique Catalog identifier

Note, the uid must be the same as when the object was catalogued, otherwise it will not get removed from the catalog

This method should not raise an exception if the uid cannot be found in the catalog.

  uniqueValuesFor  
uniqueValuesFor ( self,  name )

return unique values for FieldIndex name

  updateBrains  
updateBrains ( self )

  useBrains  
useBrains ( self,  brains )

Sets up the Catalog to return an object (ala ZTables) that is created on the fly from the tuple stored in the self.data Btree.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/Catalog_CatalogError.py.html0100600000176200017510000000367107306455576031314 0ustar dhellmanndevel Class: CatalogError

Table of Contents

Class: CatalogError Zope-2-CVS-src/lib/python/Products/ZCatalog/Catalog.py

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogAwareness.py.html0100600000176200017510000000561007306455576030514 0ustar dhellmanndevel Module: CatalogAwareness

Table of Contents

Module: CatalogAwareness Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogAwareness.py

ZCatalog Findable class

Imported modules   
from Globals import DTMLFile
import string
import urllib
Classes   
CatalogAware

This is a Mix-In class to make objects automaticly catalog and

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogAwareness_CatalogAware.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogAwareness_CatalogAware.py.htm0100600000176200017510000002641707306455576032762 0ustar dhellmanndevel Class: CatalogAware

Table of Contents

Class: CatalogAware Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogAwareness.py

This is a Mix-In class to make objects automaticly catalog and uncatalog themselves in Zope, and to provide some other basic attributes that are useful to catalog. Note that if your class or ZClass subclasses CatalogAware, it will only catalog itself when it is added or copied in Zope. If you make changes to your own object, you are responsible for calling your object's index_object method.

Methods   
creator
index_object
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_editCataloger
onDeleteObject
reindex_all
reindex_object
summary
 unindex_object
url
  creator  
creator ( self )

Return a sequence of user names who have the local Owner role on an object. The name creator is used for this method to conform to Dublin Core.

  index_object  
index_object ( self )

A common method to allow Findables to index themselves.

  manage_afterAdd  
manage_afterAdd (
        self,
        item,
        container,
        )

  manage_afterClone  
manage_afterClone ( self,  item )

  manage_beforeDelete  
manage_beforeDelete (
        self,
        item,
        container,
        )

  manage_editCataloger  
manage_editCataloger (
        self,
        default,
        REQUEST=None,
        )

  onDeleteObject  
onDeleteObject ( self )

Object delete handler. I think this is obsoleted by manage_beforeDelete

  reindex_all  
reindex_all ( self,  obj=None )

  reindex_object  
reindex_object ( self )

Suprisingly useful

  summary  
summary ( self,  num=200 )

Return a summary of the text content of the object.

  unindex_object  
unindex_object ( self )

A common method to allow Findables to unindex themselves.

  url  
url (
        self,
        ftype=urllib.splittype,
        fhost=urllib.splithost,
        )

Return a SCRIPT_NAME-based url for an object.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogAwarenessInterface.py.html0100600000176200017510000000536307306455576032342 0ustar dhellmanndevel Module: CatalogAwarenessInterface

Table of Contents

Module: CatalogAwarenessInterface Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogAwarenessInterface.py

Imported modules   
from Zope.Interfaces.Interface import Interface
Classes   
CatalogAware

Description of the Item interface

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015600000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogAwarenessInterface_CatalogAware.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogAwarenessInterface_CatalogAwa0100600000176200017510000001343007306455576033025 0ustar dhellmanndevel Class: CatalogAware

Table of Contents

Class: CatalogAware Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogAwarenessInterface.py

Description of the Item interface

Methods   
creator
index_object
reindex_all
summary
unindex_object
  creator  
creator ( self )

Return a sequence of user names who have the local Owner role on an object. The name creator is used for this method to conform to Dublin Core.

  index_object  
index_object ( self )

This object will try and catalog itself when this method is called.

  reindex_all  
reindex_all ( self,  obj=None )

This method will cause this object to get reindexed. If this object is a container, then all child objects will try to be recursivly reindexed. obj can be passed as an alternative object to try and reindex.

  summary  
summary ( self,  num=200 )

Returns the summary of the text contents of the object (if text content is present). Summary length is num.

  unindex_object  
unindex_object ( self )

This object will try and uncatalog itself when this method is called.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogBrains.py.html0100600000176200017510000000565107306455576030007 0ustar dhellmanndevel Module: CatalogBrains

Table of Contents

Module: CatalogBrains Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogBrains.py

Imported modules   
import Acquisition
import Record
Classes   
AbstractCatalogBrain

Abstract base brain that handles looking up attributes as

NoBrainer

This is an empty class to use when no brain is specified.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogBrains_AbstractCatalogBrain.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogBrains_AbstractCatalogBrain.p0100600000176200017510000001406007306455576032737 0ustar dhellmanndevel Class: AbstractCatalogBrain

Table of Contents

Class: AbstractCatalogBrain Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogBrains.py

Abstract base brain that handles looking up attributes as required, and provides just enough smarts to let us get the URL, path, and cataloged object without having to ask the catalog directly.

Base Classes   
Record.Record
Acquisition.Implicit
Methods   
getObject
getPath
getRID
getURL
has_key
  getObject  
getObject ( self,  REQUEST=None )

Try to return the object for this record

  getPath  
getPath ( self )

Get the physical path for this record

  getRID  
getRID ( self )

Return the record ID for this object.

  getURL  
getURL ( self )

Try to generate a URL for this record

  has_key  
has_key ( self,  key )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogBrains_NoBrainer.py.html0100600000176200017510000000247507306455576031747 0ustar dhellmanndevel Class: NoBrainer

Table of Contents

Class: NoBrainer Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogBrains.py

This is an empty class to use when no brain is specified.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogPathAwareness.py.html0100600000176200017510000000571207306455576031334 0ustar dhellmanndevel Module: CatalogPathAwareness

Table of Contents

Module: CatalogPathAwareness Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogPathAwareness.py

ZCatalog Findable class

Imported modules   
from Acquisition import aq_base
from Globals import DTMLFile
import string
import urllib
Classes   
CatalogAware

This is a Mix-In class to make objects automaticly catalog and

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogPathAwareness_CatalogAware.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogPathAwareness_CatalogAware.py0100600000176200017510000002632007306455576033001 0ustar dhellmanndevel Class: CatalogAware

Table of Contents

Class: CatalogAware Zope-2-CVS-src/lib/python/Products/ZCatalog/CatalogPathAwareness.py

This is a Mix-In class to make objects automaticly catalog and uncatalog themselves in Zope, and to provide some other basic attributes that are useful to catalog. Note that if your class or ZClass subclasses CatalogAware, it will only catalog itself when it is added or copied in Zope. If you make changes to your own object, you are responsible for calling your object's index_object method.

Methods   
creator
getPath
index_object
manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_editCataloger
onDeleteObject
reindex_all
reindex_object
 summary
unindex_object
  creator  
creator ( self )

Return a sequence of user names who have the local Owner role on an object. The name creator is used for this method to conform to Dublin Core.

  getPath  
getPath ( self )

Return the physical path for an object.

  index_object  
index_object ( self )

A common method to allow Findables to index themselves.

  manage_afterAdd  
manage_afterAdd (
        self,
        item,
        container,
        )

  manage_afterClone  
manage_afterClone ( self,  item )

  manage_beforeDelete  
manage_beforeDelete (
        self,
        item,
        container,
        )

  manage_editCataloger  
manage_editCataloger (
        self,
        default,
        REQUEST=None,
        )

  onDeleteObject  
onDeleteObject ( self )

Object delete handler. I think this is obsoleted by manage_beforeDelete

  reindex_all  
reindex_all ( self,  obj=None )

  reindex_object  
reindex_object ( self )

Suprisingly useful

  summary  
summary ( self,  num=200 )

Return a summary of the text content of the object.

  unindex_object  
unindex_object ( self )

A common method to allow Findables to unindex themselves.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/Lazy.py.html0100600000176200017510000000534507306455576026215 0ustar dhellmanndevel Module: Lazy

Table of Contents

Module: Lazy Zope-2-CVS-src/lib/python/Products/ZCatalog/Lazy.py

Classes   
Lazy
LazyCat

Lazy concatenation of one or more sequences. Should be handy

LazyFilter

Act like a sequence, but get data from a filtering process.

LazyMap

Act like a sequence, but get data from a filtering process.

LazyMop

Act like a sequence, but get data from a filtering process.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/Lazy_Lazy.py.html0100600000176200017510000001244407306455576027212 0ustar dhellmanndevel Class: Lazy

Table of Contents

Class: Lazy Zope-2-CVS-src/lib/python/Products/ZCatalog/Lazy.py

Methods   
__add__
__getslice__
__len__
__repr__
  __add__  
__add__ ( self,  other )

Exceptions   
TypeError
TypeError, "Can not concatenate objects. Both must be lazy sequences."
  __getslice__  
__getslice__ (
        self,
        i1,
        i2,
        )

  __len__  
__len__ ( self )

  __repr__  
__repr__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/Lazy_LazyCat.py.html0100600000176200017510000001117507306455576027642 0ustar dhellmanndevel Class: LazyCat

Table of Contents

Class: LazyCat Zope-2-CVS-src/lib/python/Products/ZCatalog/Lazy.py

Lazy concatenation of one or more sequences. Should be handy for accessing small parts of big searches.

Base Classes   
Lazy
Methods   
__getitem__
__init__
  __getitem__  
__getitem__ ( self,  index )

Exceptions   
IndexError, index
  __init__  
__init__ (
        self,
        sequences,
        length=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/Lazy_LazyFilter.py.html0100600000176200017510000001115307306455576030354 0ustar dhellmanndevel Class: LazyFilter

Table of Contents

Class: LazyFilter Zope-2-CVS-src/lib/python/Products/ZCatalog/Lazy.py

Act like a sequence, but get data from a filtering process. Don't access data until necessary

Base Classes   
Lazy
Methods   
__getitem__
__init__
  __getitem__  
__getitem__ ( self,  index )

Exceptions   
IndexError, index
  __init__  
__init__ (
        self,
        test,
        seq,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/Lazy_LazyMap.py.html0100600000176200017510000001117207306455576027645 0ustar dhellmanndevel Class: LazyMap

Table of Contents

Class: LazyMap Zope-2-CVS-src/lib/python/Products/ZCatalog/Lazy.py

Act like a sequence, but get data from a filtering process. Don't access data until necessary

Base Classes   
Lazy
Methods   
__getitem__
__init__
  __getitem__  
__getitem__ ( self,  index )

Exceptions   
IndexError, index
  __init__  
__init__ (
        self,
        func,
        seq,
        length=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/Lazy_LazyMop.py.html0100600000176200017510000001114507306455576027663 0ustar dhellmanndevel Class: LazyMop

Table of Contents

Class: LazyMop Zope-2-CVS-src/lib/python/Products/ZCatalog/Lazy.py

Act like a sequence, but get data from a filtering process. Don't access data until necessary

Base Classes   
Lazy
Methods   
__getitem__
__init__
  __getitem__  
__getitem__ ( self,  index )

Exceptions   
IndexError, index
  __init__  
__init__ (
        self,
        test,
        seq,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/Vocabulary.py.html0100600000176200017510000000366707306455576027412 0ustar dhellmanndevel Module: Vocabulary

Table of Contents

Module: Vocabulary Zope-2-CVS-src/lib/python/Products/ZCatalog/Vocabulary.py

Imported modules   
from Products.PluginIndexes.TextIndex.Vocabulary import *

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/ZCatalog.py.html0100600000176200017510000002252207306455576026776 0ustar dhellmanndevel Module: ZCatalog

Table of Contents

Module: ZCatalog Zope-2-CVS-src/lib/python/Products/ZCatalog/ZCatalog.py

ZCatalog product

Imported modules   
from AccessControl import getSecurityManager, full_read_guard
from AccessControl.Permission import name_trans
from Acquisition import Implicit
from Catalog import Catalog, CatalogError
from DateTime import DateTime
from DocumentTemplate.DT_Util import InstanceDict, TemplateDict, Eval
import Globals
from Globals import DTMLFile, MessageDialog
from OFS.FindSupport import FindSupport
from OFS.Folder import Folder
from OFS.ObjectManager import ObjectManager
from Persistence import Persistent
from Products.PluginIndexes.TextIndex import Splitter
from Products.PluginIndexes.TextIndex.Vocabulary import Vocabulary
from Products.PluginIndexes.common.PluggableIndex import PluggableIndexInterface
from ZCatalogIndexes import ZCatalogIndexes
import os
import string
import sys
import time
import urllib
from zLOG import LOG, ERROR
Functions   
absattr
expr_match
manage_addZCatalog
mtime_match
p_name
role_match
  absattr  
absattr ( attr )

  expr_match  
expr_match (
        ob,
        ed,
        c=InstanceDict,
        r=0,
        )

  manage_addZCatalog  
manage_addZCatalog (
        self,
        id,
        title,
        vocab_id='create_default_catalog_',
        REQUEST=None,
        )

Add a ZCatalog object

  mtime_match  
mtime_match (
        ob,
        t,
        q,
        fn=hasattr,
        )

  p_name  
p_name ( name )

  role_match  
role_match (
        ob,
        permission,
        roles,
        lt=type([] ),
        tt=type(() ),
        )

Classes   
ZCatalog

ZCatalog object

td

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/ZCatalog_ZCatalog.py.html0100600000176200017510000011440507306455576030564 0ustar dhellmanndevel Class: ZCatalog

Table of Contents

Class: ZCatalog Zope-2-CVS-src/lib/python/Products/ZCatalog/ZCatalog.py

ZCatalog object

A ZCatalog contains arbirary index like references to Zope objects. ZCatalog's can index either Field values of object, or Text values.

ZCatalog does not store references to the objects themselves, but rather to a unique identifier that defines how to get to the object. In Zope, this unique idenfier is the object's relative path to the ZCatalog (since two Zope object's cannot have the same URL, this is an excellent unique qualifier in Zope).

Most of the dirty work is done in the _catalog object, which is an instance of the Catalog class. An interesting feature of this class is that it is not Zope specific. You can use it in any Python program to catalog objects.

Base Classes   
Folder
Persistent
Implicit
Methods   
ZopeFindAndApply
__init__
__len__
_searchable_arguments
_searchable_result_columns
addColumn
addIndex
catalog_object
clearIndex
delColumn
delIndex
getIndexDataForRID
getMetadataForRID
 getVocabulary
getobject
getpath
index_objects
indexes
manage_addColumn
manage_addIndex
manage_catalogClear
manage_catalogFoundItems
manage_catalogObject
manage_catalogReindex
manage_clearIndex
manage_convertBTrees
 manage_delColumns
manage_deleteIndex
manage_edit
manage_normalize_paths
manage_reindexIndex
manage_subbingToggle
manage_uncatalogObject
reindexIndex
resolve_path
resolve_url
schema
searchResults
uncatalog_object
  ZopeFindAndApply  
ZopeFindAndApply (
        self,
        obj,
        obj_ids=None,
        obj_metatypes=None,
        obj_searchterm=None,
        obj_expr=None,
        obj_mtime=None,
        obj_mspec=None,
        obj_permission=None,
        obj_roles=None,
        search_sub=0,
        REQUEST=None,
        result=None,
        pre='',
        apply_func=None,
        apply_path='',
        )

Zope Find interface and apply

This is a great hack. Zope find just doesn't do what we need here; the ability to apply a method to all the objects as they're found and the need to pass the object's path into that method.

Exceptions   
AttributeError, ` result `
  __init__  
__init__ (
        self,
        id,
        title='',
        vocab_id=None,
        container=None,
        )

Exceptions   
CatalogError, ( "You cannot specify a vocab_id without " "also specifying a container." )
  __len__  
__len__ ( self )

  _searchable_arguments  
_searchable_arguments ( self )

  _searchable_result_columns  
_searchable_result_columns ( self )

  addColumn  
addColumn (
        self,
        name,
        default_value=None,
        )

  addIndex  
addIndex (
        self,
        name,
        type,
        extra=None,
        )

Exceptions   
ValueError, "Index of type %s not found" % type
ValueError, "Index type %s does not support addIndex" % type
  catalog_object  
catalog_object (
        self,
        obj,
        uid=None,
        idxs=[],
        )

wrapper around catalog

Exceptions   
CatalogError( "A cataloged object must support the 'getPhysicalPath' " "method if no unique id is provided when cataloging" )
CatalogError( 'The object unique id must be a string.' )
  clearIndex  
clearIndex ( self,  name )

  delColumn  
delColumn ( self,  name )

  delIndex  
delIndex ( self,  name )

  getIndexDataForRID  
getIndexDataForRID ( self,  rid )

return the current index contents for the specific rid

  getMetadataForRID  
getMetadataForRID ( self,  rid )

return the correct metadata for the cataloged record id

  getVocabulary  
getVocabulary ( self )

more ack!

  getobject  
getobject (
        self,
        rid,
        REQUEST=None,
        )

Return a cataloged object given a data_record_id_

  getpath  
getpath ( self,  rid )

Return the path to a cataloged object given a data_record_id_

  index_objects  
index_objects ( self )

  indexes  
indexes ( self )

  manage_addColumn  
manage_addColumn (
        self,
        name,
        REQUEST=None,
        RESPONSE=None,
        URL1=None,
        )

add a column

  manage_addIndex  
manage_addIndex (
        self,
        name,
        type,
        extra=None,
        REQUEST=None,
        RESPONSE=None,
        URL1=None,
        )

add an index

  manage_catalogClear  
manage_catalogClear (
        self,
        REQUEST=None,
        RESPONSE=None,
        URL1=None,
        )

clears the whole enchelada

  manage_catalogFoundItems  
manage_catalogFoundItems (
        self,
        REQUEST,
        RESPONSE,
        URL2,
        URL1,
        obj_metatypes=None,
        obj_ids=None,
        obj_searchterm=None,
        obj_expr=None,
        obj_mtime=None,
        obj_mspec=None,
        obj_roles=None,
        obj_permission=None,
        )

Find object according to search criteria and Catalog them

  manage_catalogObject  
manage_catalogObject (
        self,
        REQUEST,
        RESPONSE,
        URL1,
        urls=None,
        )

index all Zope objects that urls point to

  manage_catalogReindex  
manage_catalogReindex (
        self,
        REQUEST,
        RESPONSE,
        URL1,
        )

clear the catalog, then re-index everything

  manage_clearIndex  
manage_clearIndex (
        self,
        ids=None,
        REQUEST=None,
        RESPONSE=None,
        URL1=None,
        )

del an index

  manage_convertBTrees  
manage_convertBTrees ( self,  threshold=200 )

Convert the catalog's data structures to use BTrees package

  manage_delColumns  
manage_delColumns (
        self,
        names,
        REQUEST=None,
        RESPONSE=None,
        URL1=None,
        )

del a column

  manage_deleteIndex  
manage_deleteIndex (
        self,
        ids=None,
        REQUEST=None,
        RESPONSE=None,
        URL1=None,
        )

del an index

  manage_edit  
manage_edit (
        self,
        RESPONSE,
        URL1,
        threshold=1000,
        REQUEST=None,
        )

edit the catalog

  manage_normalize_paths  
manage_normalize_paths ( self,  REQUEST )

Ensure that all catalog paths are full physical paths

This should only be used with ZCatalogs in which all paths can be resolved with unrestrictedTraverse.

  manage_reindexIndex  
manage_reindexIndex (
        self,
        ids=None,
        REQUEST=None,
        RESPONSE=None,
        URL1=None,
        )

Reindex indexes from a ZCatalog

  manage_subbingToggle  
manage_subbingToggle (
        self,
        REQUEST,
        RESPONSE,
        URL1,
        )

toggle subtransactions

  manage_uncatalogObject  
manage_uncatalogObject (
        self,
        REQUEST,
        RESPONSE,
        URL1,
        urls=None,
        )

removes Zope object urls from catalog

  reindexIndex  
reindexIndex (
        self,
        name,
        REQUEST,
        )

  resolve_path  
resolve_path ( self,  path )

Attempt to resolve a url into an object in the Zope namespace. The url may be absolute or a catalog path style url. If no object is found, None is returned. No exceptions are raised.

  resolve_url  
resolve_url (
        self,
        path,
        REQUEST,
        )

Attempt to resolve a url into an object in the Zope namespace. The url may be absolute or a catalog path style url. If no object is found, None is returned. No exceptions are raised.

  schema  
schema ( self )

  searchResults  
searchResults (
        self,
        REQUEST=None,
        used=None,
        **kw,
        )

Search the catalog according to the ZTables search interface. Search terms can be passed in the REQUEST or as keyword arguments.

  uncatalog_object  
uncatalog_object ( self,  uid )

wrapper around catalog

  uniqueValuesFor  
uniqueValuesFor ( self,  name )

returns the unique values for a given FieldIndex

  valid_roles  
valid_roles ( self )

Return list of valid roles

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/ZCatalog_td.py.html0100600000176200017510000000623007306455576027463 0ustar dhellmanndevel Class: td

Table of Contents

Class: td Zope-2-CVS-src/lib/python/Products/ZCatalog/ZCatalog.py

Base Classes   
TemplateDict
Methods   
read_guard
  read_guard  
read_guard ( self,  ob )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/ZCatalogIndexes.py.html0100600000176200017510000000745407306455576030325 0ustar dhellmanndevel Module: ZCatalogIndexes

Table of Contents

Module: ZCatalogIndexes Zope-2-CVS-src/lib/python/Products/ZCatalog/ZCatalogIndexes.py

Imported modules   
from Acquisition import Implicit
import Globals
from Globals import DTMLFile
from OFS.FindSupport import FindSupport
from OFS.Folder import Folder
from OFS.History import Historical
from OFS.ObjectManager import ObjectManager, IFAwareObjectManager
from OFS.SimpleItem import SimpleItem
from Persistence import Persistent
from Products.PluginIndexes.common.PluggableIndex import PluggableIndexInterface
import os
import string
import sys
import time
from zLOG import LOG, ERROR
Classes   
OldCatalogWrapperObject
ZCatalogIndexes

A mapping object, responding to getattr requests by looking up

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015700000000000011570 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/ZCatalogIndexes_OldCatalogWrapperObject.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/ZCatalogIndexes_OldCatalogWrapperObj0100600000176200017510000000631107306455576033007 0ustar dhellmanndevel Class: OldCatalogWrapperObject

Table of Contents

Class: OldCatalogWrapperObject Zope-2-CVS-src/lib/python/Products/ZCatalog/ZCatalogIndexes.py

Base Classes   
SimpleItem
Implicit
Methods   
__init__
  __init__  
__init__ ( self,  o )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/ZCatalogIndexes_ZCatalogIndexes.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/ZCatalogIndexes_ZCatalogIndexes.py.h0100600000176200017510000001571307306455576032711 0ustar dhellmanndevel Class: ZCatalogIndexes

Table of Contents

Class: ZCatalogIndexes Zope-2-CVS-src/lib/python/Products/ZCatalog/ZCatalogIndexes.py

A mapping object, responding to getattr requests by looking up the requested indexes in an object manager.

Base Classes   
IFAwareObjectManager
Folder
Persistent
Implicit
Methods   
__bobo_traverse__
_delOb
_getOb
_setOb
_setObject
objectIds
  __bobo_traverse__  
__bobo_traverse__ (
        self,
        REQUEST,
        name,
        )

  _delOb  
_delOb ( self,  id )

  _getOb  
_getOb (
        self,
        id,
        default=_marker,
        )

  _setOb  
_setOb (
        self,
        id,
        object,
        )

base accessors loop back through our dictionary interface

  _setObject  
_setObject (
        self,
        id,
        object,
        roles=None,
        user=None,
        set_owner=1,
        )

Eat _setObject calls

  objectIds  
objectIds ( self,  spec=None )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/__init__.py.html0100600000176200017510000000663207306455576027035 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/ZCatalog/__init__.py

ZCatalog product

Imported modules   
import Catalog
import CatalogAwareness
from Products.PluginIndexes.TextIndex import Vocabulary
import ZCatalog
import ZClasses
from ZClasses import createZClassForBase
Functions   
initialize
  initialize  
initialize ( context )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/CHANGES.txt.html0100600000176200017510000000312107306455577026524 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.ZCatalog

Table of Contents

Zope2 CVS with ZEO: Products.ZCatalog  

Catalog Changes

This file gives information about changes made to this product over time, things that need to be done before the next release and future plans.

Releases

Catalog 1.0.0a1

Features Added

  • Initial release

Bugs Fixed

  • Initial release

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZCatalog/README.txt.html0100600000176200017510000000326307306455577026420 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.ZCatalog

Table of Contents

Zope2 CVS with ZEO: Products.ZCatalog  

ZCatalog

Notes for Zope 2.0

Catalog now comes with the Zope core, there is no need to install it.

This is the ZCatalog product for the Z Object Publishing Environment.

****** IMPORTANT ******

This product contains no binaries, and should install identically on all platforms.

Installation

  • Extract the distribution file into the top-level directory of your Zope installation.

  • Restart your Zope installation.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:56 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/0040700000176200017510000000000007306455605024005 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/index.html0100600000176200017510000000632707306455605026011 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.ZGadflyDA

Table of Contents

Zope2 CVS with ZEO: Products.ZGadflyDA  

ZGadflyDA

The ZGadflyDA product provides support for Gadfly database adapter objects in the Zope environment.

Using Multiple Databases with ZGadflyDA

The ZGadflyDA is intended mainly for demonstration purposes.

It automatically creates a gadfly directory in your Zope var directory with a demo subdirectory, which provides a demo database.

To add or use additional databases, simply add (or link) additional directories to your var/gadfly directory.

Modules and Packages   

Zope-2-CVS-src/lib/python/Products/ZGadflyDA/

README.txt.html

ZGadflyDA

DA
DABase
__init__
db

$Id: db.py,v 1.11 1999/09/16 15:12:45 jim Exp $

gadfly

Zope2 CVS with ZEO: Products.ZGadflyDA.gadfly

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/0040700000176200017510000000000007306455605025253 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/index.html0100600000176200017510000001376307306455605027261 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.ZGadflyDA.gadfly

Table of Contents

Zope2 CVS with ZEO: Products.ZGadflyDA.gadfly  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/

DLispShort
DumbLispGen
SQLTESTG
__init__
gadfly

main entry point for gadfly sql.

gfclient

client access to gadfly server. (gfserve.py)

gfdb0

storage objects

gfinstall

Gadfly installation script.

gfintrospect

View based introspection and extension views

gfserve

gadfly server mode

gfsocket

socket interactions for gadfly client and server

gfstest

test script for gadfly client and server

gftest

test script for gadfly

idl
kjParseBuild
kjParser
kjSet
kjbuckets0
kjpylint

python lint using kwParsing

pygram
relalg

Simple relational algebra interpreter.

remotetest

Demonstration of the Remote View protocol for adding

sqlbind

rule bindings for sql grammar.

sqlgen

grammar generation stuff for sql.

sqlgram
sqlgtest

test parses for sql grammar

sqlmod

Database modification statement semantics

sqlsem

sql semantics

sqlwhere

this module indicates where the sql datastructures are marshalled

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/DLispShort.py.html0100600000176200017510000003341607306455577030641 0ustar dhellmanndevel Module: DLispShort

Table of Contents

Module: DLispShort Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/DLispShort.py

Imported modules   
import string
Functions   
AddToList
BindRules
DeclareTerminals
DoPrint
DoSetq
EchoValue
GrammarBuild
LoadLispG
MakeList
NilTail
 VarValue
echo
intInterp
stripQuotes
unMarshalLispG
  AddToList  
AddToList ( list,  Context )

  BindRules  
BindRules ( Grammar )

  DeclareTerminals  
DeclareTerminals ( Grammar )

  DoPrint  
DoPrint ( list,  Context )

  DoSetq  
DoSetq ( list,  Context )

  EchoValue  
EchoValue ( list,  Context )

declare the rule reduction interpretation functions.

  GrammarBuild  
GrammarBuild ()

This function generates the grammar and dumps it to a file.

  LoadLispG  
LoadLispG ()

this function initializes the compiled grammar from the generated file.

  MakeList  
MakeList ( list,  Context )

  NilTail  
NilTail ( list,  Context )

  VarValue  
VarValue ( list,  Context )

Exceptions   
NameError, "no such lisp variable in context " + varName
  echo  
echo ( string )

  intInterp  
intInterp ( str )

declare interpretation functions and regex's for terminals

  stripQuotes  
stripQuotes ( str )

  unMarshalLispG  
unMarshalLispG ()

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/DumbLispGen.py.html0100600000176200017510000003714407306455577030761 0ustar dhellmanndevel Module: DumbLispGen

Table of Contents

Module: DumbLispGen Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/DumbLispGen.py

Imported modules   
import string
Functions   
AddToList
BindRules
DeclareTerminals
DoSetq
EchoValue
GrammarBuild
LoadLispG
MakeList
NilTail
VarValue
 echo
intInterp
stripQuotes
  AddToList  
AddToList ( list,  Context )

For a full tail, add the new element to the front of the list

Parser delivers list of form [Value, TailValue]

  BindRules  
BindRules ( Grammar )

This function Binds the named rules of the Grammar string to their interpretation functions in a Grammar.

  DeclareTerminals  
DeclareTerminals ( Grammar )

This function declares the nonterminals both in the "grammar generation phase" and in loading the compiled grammar after generation

  DoSetq  
DoSetq ( list,  Context )

For a setq, declare a new variable in the Context dictionary

Parser delivers list of form # ["(", "setq", varName, Value, ")"]

Exceptions   
TypeError, "Bad reduction? (4)"
TypeError, "Bad var name? (5)"
  EchoValue  
EchoValue ( list,  Context )

EchoValue() serves for Intrule and Strrule, since we just want to echo the value returned by the respective terminal interpretation functions.

Parser delivers list of form [ interpreted_value ]

Exceptions   
TypeError, "this shouldn't happen! (1)"
  GrammarBuild  
GrammarBuild ()

This function generates the grammar and dumps it to a file. Since it will be used only once (after debugging), it probably should be put in another file save memory/load-time.

the result returned is a Grammar Object that can be used for testing/debugging purposes.

(maybe this should be made into a generic function?)

  LoadLispG  
LoadLispG ()

this function initializes the compiled grammar from generated file.

  MakeList  
MakeList ( list,  Context )

For a list, simply return the list determined by the tail

Parser delivers list of form ["(", TailValue ]

Exceptions   
TypeError, "Bad reduction? (3)"
  NilTail  
NilTail ( list,  Context )

for an empty tail, return the empty list

Parser delivers list of form [")"]

  VarValue  
VarValue ( list,  Context )

for Varrule interpreter must try to look up the value in the Context dictionary

Parser delivers list of form [ var_name ]

Exceptions   
NameError, "no such lisp variable in context " + varName
TypeError, "Huh? (2)"
  echo  
echo ( string )

interpretation function for vars just returns the recognized string

  intInterp  
intInterp ( str )

int interpretation function: translates string to int: Could use string.atoi without the extra level of indirection but for demo purposes here it is.

  stripQuotes  
stripQuotes ( str )

interpretation function for strings strips off the surrounding quotes.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/SQLTESTG.py.html0100600000176200017510000000624107306455577030050 0ustar dhellmanndevel Module: SQLTESTG

Table of Contents

Module: SQLTESTG Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/SQLTESTG.py

Functions   
BuildSQLG
LoadSQLG
  BuildSQLG  
BuildSQLG ()

test generation of the grammar

  LoadSQLG  
LoadSQLG ()

load function

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/__init__.py.html0100600000176200017510000000411107306455577030333 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/__init__.py

Imported modules   
from gadfly import *
import os
import sqlwhere

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gadfly.py.html0100600000176200017510000000555607306455577030060 0ustar dhellmanndevel Module: gadfly

Table of Contents

Module: gadfly Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gadfly.py

main entry point for gadfly sql.

Imported modules   
import sqlbind
import sqlgen
Classes   
GF_Cursor
gadfly

as per the DBAPI spec "gadfly" is the connection object.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gadfly_GF_Cursor.py.html0100600000176200017510000002723607306455577031770 0ustar dhellmanndevel Class: GF_Cursor

Table of Contents

Class: GF_Cursor Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gadfly.py

Methods   
__init__
close
execute
fetchall
fetchmany
fetchone
pp
reset_results
reshadow
setinputsizes
 setoutputsize
  __init__  
__init__ ( self,  gadfly_instance )

  close  
close ( self )

  execute  
execute (
        self,
        statement=None,
        params=None,
        )

execute operations, commit results if no error

Exceptions   
error, "cannot execute, statement not bound"
  fetchall  
fetchall ( self )

  fetchmany  
fetchmany ( self,  size=None )

  fetchone  
fetchone ( self )

Exceptions   
error, "no more results"
  pp  
pp ( self )

return pretty-print string rep of current results

  reset_results  
reset_results ( self )

Exceptions   
error, "cannot retrieve multiple results"
error, "must execute first"
  reshadow  
reshadow ( self )

  setinputsizes  
setinputsizes ( self,  *args )

  setoutputsize  
setoutputsize ( self,  *args )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gadfly_gadfly.py.html0100600000176200017510000003407107306455577031400 0ustar dhellmanndevel Class: gadfly

Table of Contents

Class: gadfly Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gadfly.py

as per the DBAPI spec "gadfly" is the connection object.

Methods   
DUMP_ALL
__init__
add_remote_view
checkpoint
close
commit
cursor
dumplog
open
restart
 rollback
startup
table_names
transaction_log
  DUMP_ALL  
DUMP_ALL ( self )

  __init__  
__init__ (
        self,
        databasename=None,
        directory=None,
        forscratch=0,
        autocheckpoint=1,
        verbose=0,
        )

  add_remote_view  
add_remote_view (
        self,
        name,
        definition,
        )

add a remote view to self. Must be redone on each reinitialization! Must not recursively reenter the query evaluation process for this database! "Tables" added in this manner cannot be update via SQL.

  checkpoint  
checkpoint ( self )

permanently record committed updates

  close  
close ( self )

checkpoint and clear the database

  commit  
commit ( self )

commit the working database+transaction, flush log, new transid

  cursor  
cursor ( self )

Exceptions   
error, "not bound to database"
  dumplog  
dumplog ( self )

  open  
open ( self )

(re)load existing database

  restart  
restart ( self )

reload and rerun committed updates from log, discard uncommitted

  rollback  
rollback ( self )

discard the working db, new transid, recreate working db

Exceptions   
error, "unbound, cannot rollback"
  startup  
startup (
        self,
        databasename,
        directory,
        scratch=0,
        verbose=0,
        )

Exceptions   
error, "cannot startup, database bound"
  table_names  
table_names ( self )

  transaction_log  
transaction_log ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfclient.py.html0100600000176200017510000001577107306455577030405 0ustar dhellmanndevel Module: gfclient

Table of Contents

Module: gfclient Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfclient.py

client access to gadfly server. (gfserve.py)

Imported as a module this module provides interfaces that remotely access a gadfly database server.

Remote connections: gfclient

connection = gfclient.gfclient( policy, # the name of the connection policy ["admin" for admin] port, # the port number the server is running on password,# the password of the policy [machine]) # (optional) the machine where server is running # (defaults to localhost)

methods for gfclient connections: gfclient.checkpoint() checkpoint the server (fails silently if connection is not "admin"). gfclient.restart() restart the server (fails silently if connection is not "admin"). gfclient.shutdown() shutdown the server (fails silently if connection is not "admin"). cursor = gfclient.cursor() returns a cursor on this connection

methods for cursor objects:

cursor.execute(statement, dynamic_parameters=None) execute the statement with optional dynamic parameters. Dynamic parameters can be a list of tuples for INSERT VALUES statements, otherwise they must be a tuple of values. cursor.execute_prepared(name, dynamic_parameters=None) execute a named statement configured for this connection policy, with optional dynamic parameters. Dynamic parameters permitted as for execute depending on the statement the name refers to. cursor.fetchall() return results of the last executed statement (None for non-queries, or list of tuples).

See gfstest.py for example usage.

SCRIPT INTERPRETATION:

Server maintenance utilities

COMMAND LINE: python gfclient.py action port admin_password [machine]

TEST EXAMPLE: python gfclient.py shutdown 2222 admin

action: one of shutdown: shut down the server with no checkpoint restart: restart the server (re-read the database and recover) checkpoint: force a database checkpoint now port: the port the server is running on admin_password: the administrative password for the server machine: [optional] the machine the server runs on.

Imported modules   
import gfsocket
Functions   
dosimple
main
  dosimple  
dosimple (
        action,
        port,
        pw,
        machine=None,
        )

  main  
main ()

Classes   
gfClientCursor
gfclient

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfclient_gfClientCursor.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfclient_gfClientCursor.py.h0100600000176200017510000001417107306455577032672 0ustar dhellmanndevel Class: gfClientCursor

Table of Contents

Class: gfClientCursor Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfclient.py

Methods   
__init__
execute
execute_prepared
fetchall
setinputsizes
setoutputsizes
  __init__  
__init__ ( self,  connection )

  execute  
execute (
        self,
        statement=None,
        params=None,
        )

  execute_prepared  
execute_prepared (
        self,
        name,
        params=None,
        )

  fetchall  
fetchall ( self )

should add fetchone fetchmany

  setinputsizes  
setinputsizes ( self )

  setoutputsizes  
setoutputsizes ( self,  *args )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfclient_gfclient.py.html0100600000176200017510000002337007306455577032252 0ustar dhellmanndevel Class: gfclient

Table of Contents

Class: gfclient Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfclient.py

Methods   
__init__
checkpoint
close
commit
cursor
open_connection
restart
send_action
shutdown
simple_action
  __init__  
__init__ (
        self,
        policy,
        port,
        password,
        machine=None,
        )

  checkpoint  
checkpoint ( self )

  close  
close ( self )

  commit  
commit ( self )

  cursor  
cursor ( self )

return a cursor to this policy

Exceptions   
ValueError, "connection is closed"
  open_connection  
open_connection ( self )

  restart  
restart ( self )

only valid for admin policy: force a server restart

  send_action  
send_action (
        self,
        action,
        arguments,
        socket,
        )

  shutdown  
shutdown ( self )

only valid for admin policy: shut down the server

  simple_action  
simple_action (
        self,
        action,
        args=(),
        )

only valid for admin policy: force a server checkpoint

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0.py.html0100600000176200017510000002353207306455600027551 0ustar dhellmanndevel Module: gfdb0

Table of Contents

Module: gfdb0 Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0.py

storage objects

Imported modules   
import os
Functions   
backup_file
checksum
checksum_dump
checksum_undump
del_file
recursive_dump
  backup_file  
backup_file ( filename,  backupname )

backup file, if unopenable ignore

  checksum  
checksum ( string )

use md5 checksum (stub if md5 unavailable?)

  checksum_dump  
checksum_dump ( data,  file )

checksum and dump marshallable data to file

  checksum_undump  
checksum_undump ( file )

undump marshallable data from file, checksum

Exceptions   
StorageError, "data load checksum fails"
  del_file  
del_file ( filename )

delete file, ignore errors

  recursive_dump  
recursive_dump ( data,  prefix="[" )

for debugging

Classes   
Add_Tuples

stored rel.add_tuples(tuples)

DB_Logger

quick and dirty global db logger.

Database0

quick and dirty in core database representation.

Erase_Tuples

stored rel.erase_tuples(seqnums)

File_Storage0

quick and dirty file storage mechanism.

Index

Index for tuples in relation. Tightly bound to relation rep.

Relation0

quick and dirty in core relation representation.

Reset_Tuples

stored rel.reset_tuples(tups, seqnums)

Transaction_Logger

quick and dirty Log implementation per transaction.

View

view object, acts like relation, with addl operations.

shadow_dict

shadow dictionary. defer & remember updates.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0_Add_Tuples.py.html0100600000176200017510000001654607306455577031701 0ustar dhellmanndevel Class: Add_Tuples

Table of Contents

Class: Add_Tuples Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0.py

stored rel.add_tuples(tuples)

stored mutations on relations

Methods   
__init__
__repr__
demarshal
eval
initargs
marshaldata
relbind
set_data
  __init__  
__init__ ( self,  name )

  __repr__  
__repr__ ( self )

  demarshal  
demarshal ( self,  data )

  eval  
eval ( self,  dyn=None )

apply operation to db

  initargs  
initargs ( self )

  marshaldata  
marshaldata ( self )

  relbind  
relbind ( self,  db )

  set_data  
set_data (
        self,
        tuples,
        rel,
        )

store self.data as tuple with tuple[-1] as to_rel, rest data

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0_DB_Logger.py.html0100600000176200017510000002457307306455577031440 0ustar dhellmanndevel Class: DB_Logger

Table of Contents

Class: DB_Logger Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0.py

quick and dirty global db logger.

Methods   
__init__
__repr__
clear
clear_log_file
commit
dump
log
read_records
recover
restart
 shutdown
startup
  __init__  
__init__ (
        self,
        filename,
        backupname,
        )

  __repr__  
__repr__ ( self )

  clear  
clear ( self )

  clear_log_file  
clear_log_file ( self )

  commit  
commit (
        self,
        verbose=0,
        transactionid=None,
        )

add commit, if appropriate, flush.

  dump  
dump ( self )

  log  
log (
        self,
        operation,
        transactionid=None,
        )

transactionid of None means no transaction: immediate.

  read_records  
read_records ( self,  file )

return log record as (index, (tid, op)) list

  recover  
recover (
        self,
        db,
        restart=1,
        )

  restart  
restart ( self )

  shutdown  
shutdown ( self )

  startup  
startup ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0_Database0.py.html0100600000176200017510000005072207306455577031433 0ustar dhellmanndevel Class: Database0

Table of Contents

Class: Database0 Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0.py

quick and dirty in core database representation.

Methods   
__delitem__
__getitem__
__init__
__repr__
__setitem__
add_datadef
add_index
bindings
clear
commit
 drop_datadef
drop_index
get_for_update
getdatadefs
has_datadef
has_relation
relations
reshadow
set_introspection
  __delitem__  
__delitem__ ( self,  name )

  __getitem__  
__getitem__ ( self,  name )

  __init__  
__init__ (
        self,
        shadowing=None,
        log=None,
        )

dictionary of relations.

Exceptions   
ValueError, "shadowing db requires log"
  __repr__  
__repr__ ( self )

  __setitem__  
__setitem__ (
        self,
        name,
        relation,
        )

bind a name (uppercased) to tuples as a relation.

Exceptions   
NameError, "cannot set index"
  add_datadef  
add_datadef (
        self,
        name,
        defn,
        logit=1,
        )

only log the datadef if logit is set, else ignore redefinitions

Exceptions   
KeyError, ` name ` + ": already defined"
  add_index  
add_index (
        self,
        name,
        index,
        )

Exceptions   
NameError, ` name ` + ": is relation"
  bindings  
bindings ( self,  fromlist )

return (attdict, reldict, amb, ambatts) from fromlist = [(name,alias)...] where reldict: alias > tuplelist attdict: attribute_name > unique_relation amb: dict of dottedname > (rel, att) ambatts: dict of ambiguous_name > witness_alias

Exceptions   
NameError, ` alias ` + ": bound twice in from list"
NameError, ` name ` + " no such relation in DB"
  clear  
clear ( self )

I'm not sure if database has circular structure, so this added

  commit  
commit ( self )

commit shadowed changes

  drop_datadef  
drop_datadef ( self,  name )

Exceptions   
KeyError, ` name ` + ": no such element"
  drop_index  
drop_index ( self,  name )

  get_for_update  
get_for_update ( self,  name )

note: does not imply updates, just possibility of them

Exceptions   
ValueError, "VIEW %s cannot be updated" % name
ValueError, "cannot update, db is read only"
  getdatadefs  
getdatadefs ( self )

  has_datadef  
has_datadef ( self,  name )

  has_relation  
has_relation ( self,  name )

  relations  
relations ( self )

  reshadow  
reshadow (
        self,
        db,
        dblog,
        )

(re)make self into shadow of db with dblog

  set_introspection  
set_introspection ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0_Erase_Tuples.py.html0100600000176200017510000001112307306455577032232 0ustar dhellmanndevel Class: Erase_Tuples

Table of Contents

Class: Erase_Tuples Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0.py

stored rel.erase_tuples(seqnums)

Base Classes   
Add_Tuples
Methods   
__repr__
eval
set_data
  __repr__  
__repr__ ( self )

  eval  
eval ( self,  dyn=None )

  set_data  
set_data (
        self,
        seqnums,
        rel,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0_File_Storage0.py.html0100600000176200017510000003775207306455577032302 0ustar dhellmanndevel Class: File_Storage0

Table of Contents

Class: File_Storage0 Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0.py

quick and dirty file storage mechanism. relation names in directory/dbname.gfd contains a white separated list of relation names relations in directory/relname.grl contains sequence of marshalled tuples reps prefixed by marshalled list of atts

Methods   
__init__
backup_dbfilename
backup_logfilename
backup_relfilename
dbfilename
dump
dumpdatadefs
dumprelation
get_initstat_file
get_initstatements
 get_relation
getfile_fallback
load
logfilename
relfile
relfilename
  __init__  
__init__ (
        self,
        dbname,
        directory,
        )

directory must exist.

  backup_dbfilename  
backup_dbfilename ( self )

  backup_logfilename  
backup_logfilename ( self )

  backup_relfilename  
backup_relfilename ( self,  name )

  dbfilename  
dbfilename ( self )

  dump  
dump ( self,  db )

perform a checkpoint (no active transactions!)

  dumpdatadefs  
dumpdatadefs (
        self,
        db,
        force=0,
        )

set force to ignore the touch flag

  dumprelation  
dumprelation (
        self,
        name,
        rel,
        force=0,
        )

set force to ignore the "touch" flag.

  get_initstat_file  
get_initstat_file ( self,  mode )

  get_initstatements  
get_initstatements ( self )

Exceptions   
StorageError, "could not unpack ddf backup or ddf file in recovery mode: " + self.dbname
  get_relation  
get_relation ( self,  name )

Exceptions   
StorageError, "fs: could not unpack backup rel file or rel file in recovery mode: " + name
  getfile_fallback  
getfile_fallback (
        self,
        first,
        second,
        mode,
        )

  load  
load (
        self,
        parser=None,
        forscratch=0,
        )

Exceptions   
StorageError, "load failure %s: %s" %( name, detail )
StorageError, "rel %s: atts %s don't match %s" %( name, attsin, attsout )
  logfilename  
logfilename ( self )

  relfile  
relfile (
        self,
        name,
        mode="rb",
        )

  relfilename  
relfilename ( self,  name )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0_Index.py.html0100600000176200017510000002032607306455577030713 0ustar dhellmanndevel Class: Index

Table of Contents

Class: Index Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0.py

Index for tuples in relation. Tightly bound to relation rep.

Methods   
__init__
__repr__
add_tuples
attributes
clear
copy
erase_tuples
matches
  __init__  
__init__ (
        self,
        name,
        attributes,
        unique=0,
        )

  __repr__  
__repr__ ( self )

  add_tuples  
add_tuples (
        self,
        tuples,
        seqnums,
        )

Exceptions   
StorageError, "uniqueness violation: %s %s" %( dump, self )
  attributes  
attributes ( self )

  clear  
clear ( self )

  copy  
copy ( self )

make a fast structural copy of self

  erase_tuples  
erase_tuples (
        self,
        seqnums,
        all_tuples,
        )

  matches  
matches (
        self,
        tuple,
        translate=None,
        )

return (tuples, seqnums) for tuples matching tuple (with possible translations

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0_Relation0.py.html0100600000176200017510000003563407306455577031511 0ustar dhellmanndevel Class: Relation0

Table of Contents

Class: Relation0 Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0.py

quick and dirty in core relation representation. self.tuples contains tuples or 0 if erased. tuples must not move (to preserve indices) unless indices regenerate.

Methods   
__init__
__repr__
add_index
add_tuples
attributes
choose_index
drop_index
drop_indices
dump
erase_tuples
 irepr
load
regenerate_indices
reset_tuples
rows
set_empty
shadow
unshadow
  __init__  
__init__ (
        self,
        attribute_names,
        tuples=None,
        filter=None,
        )

  __repr__  
__repr__ ( self )

  add_index  
add_index (
        self,
        index,
        recordtuples=1,
        )

unset recordtuples if the index is initialized already.

  add_tuples  
add_tuples ( self,  tuples )

  attributes  
attributes ( self )

  choose_index  
choose_index ( self,  attributes )

choose an index including subset of attributes or None

  drop_index  
drop_index ( self,  index )

  drop_indices  
drop_indices ( self,  db )

  dump  
dump ( self,  file )

  erase_tuples  
erase_tuples ( self,  seqnums )

  irepr  
irepr ( self )

  load  
load ( self,  file )

checksum must succeed.

  regenerate_indices  
regenerate_indices ( self )

  reset_tuples  
reset_tuples (
        self,
        tups,
        seqnums,
        )

  rows  
rows ( self,  andseqnums=0 )

  set_empty  
set_empty ( self )

  shadow  
shadow (
        self,
        otherrelation,
        log,
        name,
        inshadowdb,
        )

return structural replica of otherrelation (as self)

for non-updatable relation (eg, view) may return otherrelation

  unshadow  
unshadow ( self )

make self into a replacement for shadowed, return self.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0_Reset_Tuples.py.html0100600000176200017510000001114707306455577032263 0ustar dhellmanndevel Class: Reset_Tuples

Table of Contents

Class: Reset_Tuples Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0.py

stored rel.reset_tuples(tups, seqnums)

Base Classes   
Add_Tuples
Methods   
__repr__
eval
set_data
  __repr__  
__repr__ ( self )

  eval  
eval ( self,  dyn=None )

  set_data  
set_data (
        self,
        tups,
        seqnums,
        rel,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0_Transaction_Logger.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0_Transaction_Logger.py.0100600000176200017510000001373007306455600032527 0ustar dhellmanndevel Class: Transaction_Logger

Table of Contents

Class: Transaction_Logger Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0.py

quick and dirty Log implementation per transaction.

Methods   
__init__
__repr__
commit
flush
log
reset
  __init__  
__init__ (
        self,
        db_log,
        transactionid,
        is_scratch=0,
        )

  __repr__  
__repr__ ( self )

  commit  
commit ( self,  verbose=0 )

  flush  
flush ( self )

  log  
log ( self,  operation )

  reset  
reset ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0_View.py.html0100600000176200017510000002432407306455600030543 0ustar dhellmanndevel Class: View

Table of Contents

Class: View Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0.py

view object, acts like relation, with addl operations.

Base Classes   
Relation0
Methods   
UNDEFINED_OP_FOR_VIEW
__init__
__repr__
attributes
choose_index
ignore_op_for_view
relbind
rows
uncache
  UNDEFINED_OP_FOR_VIEW  
UNDEFINED_OP_FOR_VIEW ( *args,  *kw )

Exceptions   
ValueError, "operation explicitly undefined for view object"
  __init__  
__init__ (
        self,
        name,
        namelist,
        selection,
        indb,
        )

set namelist to None for implicit namelist

  __repr__  
__repr__ ( self )

  attributes  
attributes ( self )

  choose_index  
choose_index ( s,  a )

no indices on views (might change this?)

  ignore_op_for_view  
ignore_op_for_view ( *args,  *kw )

ignore this op when applied to view

  relbind  
relbind (
        self,
        db,
        atts,
        )

bind self to db, ignore atts

Exceptions   
"select list and namelist don't match in %s" % name
  rows  
rows ( self,  andseqs=0 )

  uncache  
uncache ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0_shadow_dict.py.html0100600000176200017510000002015407306455600032116 0ustar dhellmanndevel Class: shadow_dict

Table of Contents

Class: shadow_dict Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfdb0.py

shadow dictionary. defer & remember updates.

Methods   
__delitem__
__getitem__
__init__
__len__
__setitem__
commit
is_shadowed
  __delitem__  
__delitem__ ( self,  key )

  __getitem__  
__getitem__ ( self,  key )

  __init__  
__init__ (
        self,
        shadowing,
        value_transform=None,
        )

  __len__  
__len__ ( self )

  __setitem__  
__setitem__ (
        self,
        key,
        item,
        )

Exceptions   
"none set", ( key, item )
"nonstring", key
  commit  
commit ( self,  verbose=0 )

apply updates to shadowed.

Exceptions   
"transform fails", ( sys.exc_type, sys.exc_value, k, value )
  is_shadowed  
is_shadowed ( self,  name )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfinstall.py.html0100600000176200017510000000517207306455600030552 0ustar dhellmanndevel Module: gfinstall

Table of Contents

Module: gfinstall Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfinstall.py

Gadfly installation script.

Build the sql grammar.

usage python <thismodule> for a simple install or python <thismodule> force for a full rebuild (with grammar regeneration).

In the current directory find or create sql.mar and sqlwhere.py where sql.mar has the marshalled grammar data structures for parsing sql and sqlwhere.py is a module that indicates where the grammar file is as value of sqlwhere.filename.

Imported modules   
from os import getcwd, path
from sqlgen import BuildSQL, getSQL
import sys

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect.py.html0100600000176200017510000001003307306455600031266 0ustar dhellmanndevel Module: gfintrospect

Table of Contents

Module: gfintrospect Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect.py

View based introspection and extension views

Imported modules   
import gfdb0
Classes   
ColumnsView

table_names and columns therein.

DataDefsView

Data defs (of non-special views) and definition dumps.

DictKeyValueView

Less trivial example. Dict keys/values converted to strings

DualView

static one row one column view for testing.

IndexAttsView

indices and attributes.

IndicesView

list of indices and relations they index

RelationsView

list of relations and whether they are views.

RemoteView

Virtual superclass. See text for methods and members to define.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect_ColumnsView.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect_ColumnsView.py.0100600000176200017510000000770207306455600032745 0ustar dhellmanndevel Class: ColumnsView

Table of Contents

Class: ColumnsView Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect.py

table_names and columns therein.

Base Classes   
RemoteView
    gfdb0.View
Methods   
listing
relbind
  listing  
listing ( self )

  relbind  
relbind (
        self,
        db,
        atts,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect_DataDefsView.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect_DataDefsView.py0100600000176200017510000000660107306455600032717 0ustar dhellmanndevel Class: DataDefsView

Table of Contents

Class: DataDefsView Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect.py

Data defs (of non-special views) and definition dumps.

Base Classes   
DictKeyValueView
Methods   
relbind
  relbind  
relbind (
        self,
        db,
        atts,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect_DictKeyValueView.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect_DictKeyValueVie0100600000176200017510000000771507306455600032766 0ustar dhellmanndevel Class: DictKeyValueView

Table of Contents

Class: DictKeyValueView Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect.py

Less trivial example. Dict keys/values converted to strings

Base Classes   
RemoteView
    gfdb0.View
Methods   
__init__
listing
  __init__  
__init__ ( self,  dict=None )

  listing  
listing ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect_DualView.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect_DualView.py.htm0100600000176200017510000000643007306455600032720 0ustar dhellmanndevel Class: DualView

Table of Contents

Class: DualView Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect.py

static one row one column view for testing. (Inspired by Oracle DUAL relation).

Base Classes   
RemoteView
    gfdb0.View
Methods   
listing
  listing  
listing ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect_IndexAttsView.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect_IndexAttsView.p0100600000176200017510000000653207306455600032761 0ustar dhellmanndevel Class: IndexAttsView

Table of Contents

Class: IndexAttsView Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect.py

indices and attributes.

Base Classes   
ColumnsView
Methods   
relbind
  relbind  
relbind (
        self,
        db,
        atts,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect_IndicesView.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect_IndicesView.py.0100600000176200017510000001004007306455600032670 0ustar dhellmanndevel Class: IndicesView

Table of Contents

Class: IndicesView Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect.py

list of indices and relations they index

Base Classes   
DictKeyValueView
Methods   
listing
relbind
  listing  
listing ( self )

  relbind  
relbind (
        self,
        db,
        atts,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect_RelationsView.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect_RelationsView.p0100600000176200017510000000657207306455600033022 0ustar dhellmanndevel Class: RelationsView

Table of Contents

Class: RelationsView Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect.py

list of relations and whether they are views.

Base Classes   
DictKeyValueView
Methods   
relbind
  relbind  
relbind (
        self,
        db,
        atts,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect_RemoteView.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect_RemoteView.py.h0100600000176200017510000001663007306455600032730 0ustar dhellmanndevel Class: RemoteView

Table of Contents

Class: RemoteView Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfintrospect.py

Virtual superclass. See text for methods and members to define.

Base Classes   
gfdb0.View
Methods   
__init__
__repr__
attributes
listing
relbind
rows
uncache
  __init__  
__init__ ( self )

Usually redefine __init__

  __repr__  
__repr__ ( self )

possibly redefine __repr__ and irepr

  attributes  
attributes ( self )

  listing  
listing ( self )

return list of values (1 column) or list of tuples of values (>1 column). size of elts should match number of columns.

define the row generator

  relbind  
relbind (
        self,
        db,
        atts,
        )

for introspective methods possibly redefine relbind

  rows  
rows ( self,  andseqs=0 )

  uncache  
uncache ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfserve.py.html0100600000176200017510000001511507306455600030226 0ustar dhellmanndevel Module: gfserve

Table of Contents

Module: gfserve Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfserve.py

gadfly server mode

script usage

python gfserve.py port database directory password [startup]

test example

python gfserve.py 2222 test dbtest admin gfstest

port is the port to listen to database is the database to start up. (must exist!) directory is the directory the database is in. password is the administrative access password.

startup if present should be the name of a module to use for startup. The Startup module must contain a function

Dict = startup(admin_policy, connection, Server_instance)

which performs any startup actions on the database needed and returns either None or a Dictionary of

name > policy objects

where the policy objects describe policies beyond the admin policy. The startup function may also modify the admin_policy (disabling queries for example).

The arguments passed to startup are: admin_policy: the administrative policy eg you could turn queries off for admin, using admin only for server maintenance, or you could add prepared queries to the admin_policy. connection: the database connection eg you could perform some inserts before server start also needed to make policies. Server_instance Included for additional customization.

Create policies using P = gfserve.Policy(name, password, connection, queries=0) -- for a "secure" policy with only prepared queries allowed, or P = gfserve.Policy(name, password, connection, queries=1) -- for a policy with full access arbitrary statement execution.

add a "named prepared statement" to a policy using P[name] = statement for example P["updatenorm"] = ''' update frequents set bar=?, perweek=? where drinker='norm' ''' in this case updatenorm requires 2 dynamic parameters when invoked from a client.

Script stdout lists server logging information.

Some server administration services (eg shutdown) are implemented by the script interpretion of gfclient.py.

Imported modules   
import gadfly
from gfsocket import reply_exception, reply_success, Packet_Reader, certify
import socket
Functions   
main
  main  
main ()

start up the server.

Classes   
Policy

security policy

Server

database server: listen for commands

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfserve_Policy.py.html0100600000176200017510000004323007306455600031544 0ustar dhellmanndevel Class: Policy

Table of Contents

Class: Policy Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfserve.py

security policy

Methods   
__init__
__setitem__
action
certify
execute
execute_any_statement
execute_named
policy_CHECKPOINT
policy_EXECUTE_PREPARED
policy_EXECUTE_STATEMENT
 policy_RESTART
policy_SHUTDOWN
reply_exception
reply_success
  __init__  
__init__ (
        self,
        name,
        password,
        connection,
        queries=0,
        )

create a policy (name, password, connection)

name is the name of the policy password is the access policy (None for no password) connection is the database connection. set queries to allow general accesses (unrestricted)

  __setitem__  
__setitem__ (
        self,
        name,
        value,
        )

Exceptions   
ValueError, "cursor names and contents must be strings"
  action  
action (
        self,
        certificate,
        datastring,
        socket,
        )

perform a database/server action after checking certificate

Exceptions   
CHECKPOINT, detail
RESTART, detail
SHUTDOWN, detail
ServerError, "password certification failure"
ServerError, "unknown action: " + ` action `
ServerError, exceptiondata
  certify  
certify (
        self,
        datastring,
        certificate,
        password,
        )

  execute  
execute (
        self,
        cursor,
        statement,
        params=None,
        )

execute a statement in a cursor

  execute_any_statement  
execute_any_statement (
        self,
        statement,
        params=None,
        )

execute any statement.

  execute_named  
execute_named (
        self,
        name,
        params=None,
        )

execute a named (prepared) sql statement

Exceptions   
PreparedNameError, "unknown access name: %s" % name
  policy_CHECKPOINT  
policy_CHECKPOINT ( self,  socket )

Exceptions   
CHECKPOINT, "please checkpoint the server"
  policy_EXECUTE_PREPARED  
policy_EXECUTE_PREPARED (
        self,
        name,
        dyn,
        socket,
        )

  policy_EXECUTE_STATEMENT  
policy_EXECUTE_STATEMENT (
        self,
        stat,
        dyn,
        socket,
        )

Exceptions   
ServerError, "illegal statement attempt for: " + self.name
  policy_RESTART  
policy_RESTART ( self,  socket )

Exceptions   
RESTART, "please restart the server"
  policy_SHUTDOWN  
policy_SHUTDOWN ( self,  socket )

Exceptions   
SHUTDOWN, "please shut down the server"
  reply_exception  
reply_exception (
        self,
        exc,
        info,
        socket,
        )

  reply_success  
reply_success (
        self,
        data,
        socket,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfserve_Server.py.html0100600000176200017510000001655007306455600031560 0ustar dhellmanndevel Class: Server

Table of Contents

Class: Server Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfserve.py

database server: listen for commands

Methods   
__init__
get_admin_policy
getconnection
getsocket
init
start
startup_load
  __init__  
__init__ (
        self,
        port,
        db,
        dr,
        pw,
        startup=None,
        )

  get_admin_policy  
get_admin_policy ( self )

return the admin policy for priviledged access.

  getconnection  
getconnection ( self )

get the db connection

  getsocket  
getsocket ( self )

get the listening socket

  init  
init ( self )

  start  
start ( self )

after init, listen for commands.

Exceptions   
ServerError, "listening socket in error state: aborting"
  startup_load  
startup_load ( self )

setup the policies and load startup module

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfsocket.py.html0100600000176200017510000003303607306455600030374 0ustar dhellmanndevel Module: gfsocket

Table of Contents

Module: gfsocket Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfsocket.py

socket interactions for gadfly client and server

Imported modules   
from select import select
Functions   
certificate
certify
interpret_response
recv_data
reply
reply_exception
reply_success
send_certified_action
send_len
send_packet
 unpack_certified_data
  certificate  
certificate ( String,  password )

generate a certificate for a string, using a password

Exceptions   
ValueError, "cannot generate certificate for empty string"
  certify  
certify (
        String,
        cert,
        password,
        )

check a certificate for a string

  interpret_response  
interpret_response ( data )

interpret response data, raise exception if needed

Exceptions   
EXCEPTION, data
ValueError, "unknown indicator: " + ` indicator `
  recv_data  
recv_data ( socket,  timeout=10 )

receive data or time out

Exceptions   
IOError, "socket in error state"
IOError, "socket time out (1)"
IOError, "socket time out (2)"
  reply  
reply ( data,  socket )

  reply_exception  
reply_exception (
        exception,
        info,
        socket,
        )

send an exception back to the client

  reply_success  
reply_success ( data,  socket )

report success with data back to client

  send_certified_action  
send_certified_action (
        actor_name,
        action,
        arguments,
        password,
        socket,
        )

  send_len  
send_len ( data,  socket )

send length of data as cr terminated int rep

  send_packet  
send_packet ( socket,  data )

blast out a length marked packet

  unpack_certified_data  
unpack_certified_data ( data )

Classes   
Packet_Reader

nonblocking pseudo-packet reader.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfsocket_Packet_Reader.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfsocket_Packet_Reader.py.ht0100600000176200017510000002141707306455600032614 0ustar dhellmanndevel Class: Packet_Reader

Table of Contents

Class: Packet_Reader Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfsocket.py

nonblocking pseudo-packet reader.

Methods   
__init__
__len__
get_data
poll
read_data
read_len
  __init__  
__init__ ( self,  socket )

  __len__  
__len__ ( self )

Exceptions   
ValueError, "still reading length"
  get_data  
get_data ( self )

Exceptions   
ValueError, "still reading"
  poll  
poll ( self )

Exceptions   
ValueError, "data is ready"
ValueError, "socket error previously detected"
ValueError, "socket is in error state"
  read_data  
read_data ( self )

  read_len  
read_len ( self )

assume socket is readable now, read length

Exceptions   
ValueError, "Length too big: " + `( length, limit_len ) `
ValueError, "bad len string? " + ` len_list `
ValueError, "len_list too long: " + ` len_list `
ValueError, "socket in error state"

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfstest.py.html0100600000176200017510000002057607306455600030253 0ustar dhellmanndevel Module: gfstest

Table of Contents

Module: gfstest Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gfstest.py

test script for gadfly client and server

Usage: This script interacts with the test database generated by gftest.py. To start the server from the directory containing the dbtest directory use:

python gfstest.py start

THIS WILL ONLY WORK IF YOU CREATED THE test DATABASE IN DIRECTORY dbtest FIRST USING

python gftest.py dbtest

UNLESS YOU RUN THE SERVER IN THE BACKGROUND THE SERVER WILL HOG THE WINDOW YOU STARTED IT IN AND YOU WILL HAVE TO USE ANOTHER WINDOW UNTIL THE SERVER IS SHUT DOWN (SEE BELOW).

Then from anywhere (on the same machine) access the database using python gfstest.py restart - restart the server (reread the database) python gfstest.py checkpoint - force checkpoint the server python gfstest.py queries - run some example queries and updates python gfstest.py policy_test - test the policies test and test1 created by the startup function in this module. python gfstest.py bogusshutdown - attempt to shut down the server with a bogus password [should generate an exception]

...and finally python gfstest.py shutdown - shut down the server for real.

As mentioned the startup function of this module illustrates how to create a "startup" function for a server and initialize policy objects with named, prepared queries.

Imported modules   
import socket
import sys
Functions   
doqueries
dosimple
main
policy_test
startup
  doqueries  
doqueries ()

  dosimple  
dosimple ( command,  pw )

  main  
main ()

  policy_test  
policy_test ()

test the test1 and test policies

Exceptions   
"DAMN!", "illegal query apparently completed!!!"
"Damn!(2)", "illegal query apparently completed"
  startup  
startup (
        admin_policy,
        connection,
        Server_instance,
        )

example startup script.

add a policies test and test1 passwords same test1 is allowed to query the frequents table by name test is allowed to update likes where drinker='nan' also add prepared query dumpwork to admin_policy.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gftest.py.html0100600000176200017510000001253707306455600030066 0ustar dhellmanndevel Module: gftest

Table of Contents

Module: gftest Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/gftest.py

test script for gadfly

usage gftest.py <directory>

run in current directory creates a database in files test.dfs LIKES.grl SERVES.grl FREQUENTS.grl

Functions   
dataseq
retest
rollbacktest
test
  dataseq  
dataseq ( s )

  retest  
retest ( directory )

  rollbacktest  
rollbacktest ( directory )

  test  
test ( directory )

Exceptions   
"stop!", "unique index permits nonunique field"

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/idl.py.html0100600000176200017510000001234707306455600027341 0ustar dhellmanndevel Module: idl

Table of Contents

Module: idl Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/idl.py

Imported modules   
import kjParser
Functions   
DeclareTerminals
GrammarBuild
echo
  DeclareTerminals  
DeclareTerminals ( Grammar )

  GrammarBuild  
GrammarBuild ()

  echo  
echo ( str )

dummy interp fun for all terminals

Classes   
myLexDictionary

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/idl_myLexDictionary.py.html0100600000176200017510000000762307306455600032546 0ustar dhellmanndevel Class: myLexDictionary

Table of Contents

Class: myLexDictionary Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/idl.py

Base Classes   
kjParser.LexDictionary
Methods   
Token
__init__
  Token  
Token (
        self,
        String,
        StartPosition,
        )

  __init__  
__init__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild.py.html0100600000176200017510000004503707306455600031152 0ustar dhellmanndevel Module: kjParseBuild

Table of Contents

Module: kjParseBuild Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild.py

Imported modules   
import kjParser
from kjParser import TERMFLAG, NOMATCHFLAG, MOVETOFLAG, REDUCEFLAG, TRANSFLAG, KEYFLAG, NONTERMFLAG, EOFFLAG, ENDOFFILETOKEN
import kjSet
import re
import string
Functions   
FullBody
FullRuleList
GrammarDumpSequence
IdentFun
InterpNonTerm
InterpRule
InterpRuleName
NullBody
NullCGrammar
NullRuleList
 RootReduction
ruleGrammar
  FullBody  
FullBody ( list,  ObjectGram )

FullBody should receive [ string, Bodylist] must determine whether the string represents a keyword, a nonterminal, or a terminal of the object grammar. returns (KEYFLAG, string) (TERMFLAG, string) or (NONTERMFLAG, string) respectively

Exceptions   
FlowError, "unexpected body form"
TokenError, "Rule body contains unregistered string: " + Name
  FullRuleList  
FullRuleList ( list,  ObjectGram )

FullRuleList should receive list of form [ Rule, RuleList ]

Exceptions   
FlowError, "unexpected full RuleList form"
  GrammarDumpSequence  
GrammarDumpSequence ( ReconstructObj )

general procedure for different types of archiving for grammars

  IdentFun  
IdentFun ( string )

for identifiers simply return the string

  InterpNonTerm  
InterpNonTerm ( list,  ObjectGram )

InterpNonTerm should receive [ string ]

Exceptions   
FlowError, "unexpected rulename form"
TokenError, "LHS of Rule must be nonterminal: " + Name
  InterpRule  
InterpRule ( list,  ObjectGram )

InterpRule should receive list of form [keyword RSKEY, RuleNameStr, keyword COLKEY, Nontermtoken, keyword LTKEY, Bodylist]

Exceptions   
FlowError, "unexpected meta rule reduction form"
FlowError, "unexpected rule body member"
  InterpRuleName  
InterpRuleName ( list,  ObjectGram )

InterpRuleName should receive [ string ]

  NullBody  
NullBody ( list,  ObjectGram )

NullBody should receive []

Exceptions   
FlowError, "unexpected null Body form"
  NullCGrammar  
NullCGrammar ()

function to create a "null CGrammar"

  NullRuleList  
NullRuleList ( list,  ObjectGram )

NullRuleList should receive list of form []

Exceptions   
FlowError, "unexpected null RuleList form"
  RootReduction  
RootReduction ( list,  ObjectGram )

RootReduction should receive list of form [ nontermtoken, keyword COLKEY, RuleList ]

Exceptions   
FlowError, "unexpected metagrammar root reduction"
  ruleGrammar  
ruleGrammar ()

function to generate a grammar for parsing grammar rules

Classes   
CFSMachine

a derived FSM class, with closure computation methods defined

CGrammar

a derived grammar class (object oriented programming is cool!)

Reconstruct
utility classes

Grammar reconstruction objects

codeReconstruct

grammar reconstruction to a file

marshalReconstruct

reconstruction using marshalling to a file

ruleset

Ruleset class, used to compute NFA and then DFA for

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild_CFSMachine.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild_CFSMachine.py.h0100600000176200017510000001320107306455600032401 0ustar dhellmanndevel Class: CFSMachine

Table of Contents

Class: CFSMachine Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild.py

a derived FSM class, with closure computation methods defined (compilable FSMachine)

Base Classes   
kjParser.FSMachine
Methods   
Eclosure
NewSetState
__init__
  Eclosure  
Eclosure (
        self,
        Epsilon,
        DoNullMaps=0,
        )

return the epsilon closure of the FSM as a new FSM

DoNullMap, if set, will map unexpected tokens to the "empty" state (usually creating a really big fsm)

Exceptions   
TypeError, "unexpected map type in StateTokenMap"
TypeError, "unknown map type"
  NewSetState  
NewSetState (
        self,
        kind,
        InSet,
        )

add an set-marked state to self if not present uses self.States[s][1] as the set marking the state s

only used by Eclosure above

  __init__  
__init__ ( self,  nonterm )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild_CGrammar.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild_CGrammar.py.htm0100600000176200017510000002215307306455600032541 0ustar dhellmanndevel Class: CGrammar

Table of Contents

Class: CGrammar Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild.py

a derived grammar class (object oriented programming is cool!) this is a compilable grammar for automatic parser generation.

Base Classes   
kjParser.Grammar
Methods   
Compile
Declarerules
Keywords
MarshalDump
Nonterms
Reconstruct
comments
punct
  Compile  
Compile ( self,  MetaGrammar=RULEGRAM )

The compilation function assumes NonTermDict RuleString LexD TermDict have all been set up properly (at least if the default MetaGrammar is used). On successful completion it will set up DFA RuleL RuleNameToIndex

  Declarerules  
Declarerules ( self,  StringWithRules )

initialize or add more rules to the RuleString

  Keywords  
Keywords ( self,  Stringofkeys )

insert a white separated list of keywords into the LexD THIS SHOULD CHECK FOR KEYWORD/NONTERMINAL/PUNCT NAME COLLISIONS (BUT DOESN'T YET).

  MarshalDump  
MarshalDump ( self,  Tofile )

marshalling of a grammar to a file

  Nonterms  
Nonterms ( self,  StringofNonterms )

register a white separated list of nonterminal strings

  Reconstruct  
Reconstruct (
        self,
        VarName,
        Tofile,
        FName=None,
        indent="",
        )

Write a reconstructable representation for this grammar to a file EXCEPT: - rule associations to reduction functions will be lost (must be reset elsewhere) - terminals in the lexical dictionary will not be initialized

IND is used for indentation, should be whitespace (add check!)

FName if given will cause the reconstructed to be placed inside a function `FName`+"()" returning the grammar object

NOTE: this function violates information hiding principles; in particular it "knows" the guts of the FSM and LexD classes

  comments  
comments ( self,  listOfCommentStrings )

register a list of regular expression strings to represent comments in LexD

  punct  
punct ( self,  Stringofpuncts )

insert a string of punctuations into the LexD

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild_Reconstruct.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild_Reconstruct.py.0100600000176200017510000000527507306455600032660 0ustar dhellmanndevel Class: Reconstruct

Table of Contents

Class: Reconstruct Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild.py
utility classes

Grammar reconstruction objects encapsulate the process of grammar archiving.

Methods   
MakeTokenArchives
  MakeTokenArchives  
MakeTokenArchives ( self )

this "virtual class" is only for common behaviors of subclasses.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild_codeReconstruct.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild_codeReconstruct0100600000176200017510000001655507306455600033011 0ustar dhellmanndevel Class: codeReconstruct

Table of Contents

Class: codeReconstruct Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild.py

grammar reconstruction to a file

Base Classes   
Reconstruct
Methods   
Cleanup
PutLex
PutRules
PutTransitions
__init__
  Cleanup  
Cleanup ( self )

  PutLex  
PutLex ( self )

Exceptions   
FlowError, "unknown token type"
  PutRules  
PutRules ( self )

  PutTransitions  
PutTransitions ( self )

Exceptions   
FlowError, "unexpected else (2)"
  __init__  
__init__ (
        self,
        VarName,
        Tofile,
        Grammar,
        FName=None,
        indent="",
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015700000000000011570 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild_marshalReconstruct.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild_marshalReconstr0100600000176200017510000001546307306455600033007 0ustar dhellmanndevel Class: marshalReconstruct

Table of Contents

Class: marshalReconstruct Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild.py

reconstruction using marshalling to a file encodes internal structures for grammar using marshal-able objects. Final marshalling to the file is done at CleanUp() storing one big tuple.

Base Classes   
Reconstruct
Methods   
Cleanup
PutLex
PutRules
PutTransitions
__init__
  Cleanup  
Cleanup ( self )

this is the function that does the marshalling

  PutLex  
PutLex ( self )

  PutRules  
PutRules ( self )

  PutTransitions  
PutTransitions ( self )

Exceptions   
FlowError, "unexpected else"
  __init__  
__init__ (
        self,
        Grammar,
        Tofile,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild_ruleset.py.html0100600000176200017510000004013307306455600032705 0ustar dhellmanndevel Class: ruleset

Table of Contents

Class: ruleset Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParseBuild.py

Ruleset class, used to compute NFA and then DFA for parsing based on a list of rules.

Methods   
CompDFA
CompFirst
CompFollow
CompSLRNFA
DoSLRGeneration
DumpDFAsets
DumpFirstFollow
DumpItemSet
DumpSLRNFA
FirstOfTail
 ItemDump
SLRFixDFA
SLRItemIsFinal
__init__
  CompDFA  
CompDFA ( self )

compute DFA for ruleset by computing the E-closure of the NFA

  CompFirst  
CompFirst ( self )

method to compute prefixes and First sets for nonterminals

Exceptions   
TokenError, "unknown token type in rule body"
  CompFollow  
CompFollow ( self )

computing the Follow set for the ruleset the good news: I think it's correct. the bad news: It's slower than it needs to be for epsilon cases.

Exceptions   
TokenError, "unknown token type in rule body"
  CompSLRNFA  
CompSLRNFA ( self )

compute an SLR NFA for the ruleset with states for each SLR "item" and transitions, eg: X > .AB on A maps to X > A.B on epsilon maps to A > .ZC and A > .WK an item is a pair (rulenumber, bodyposition) where body position 0 is interpreted to point before the beginning of the body.

SLR = "simple LR" in Aho+Ullman terminology

Exceptions   
NotSLRError, "No derivation for root nonterminal."
  DoSLRGeneration  
DoSLRGeneration ( self )

do complete SLR DFA creation starting after initialization

  DumpDFAsets  
DumpDFAsets ( self )

  DumpFirstFollow  
DumpFirstFollow ( self )

  DumpItemSet  
DumpItemSet ( self,  State )

  DumpSLRNFA  
DumpSLRNFA ( self )

dump the NFA

  FirstOfTail  
FirstOfTail (
        self,
        Rule,
        TailIndex,
        Token=None,
        )

computing the "first" of the tail of a rule followed by an optional terminal doesn't include NULLTOKEN requires self.First to be computed

Exceptions   
TokenError, "unknown token type in rule body"
  ItemDump  
ItemDump ( self,  item )

dump an item

  SLRFixDFA  
SLRFixDFA ( self )

this function completes the computation of an SLR DFA by adding reduction states for each DFA state S containing item H > B. which reduces rule H > B for each token T in Follow of H. if S already has a transition for T then there is a conflict!

assumes DFA and SLRNFA and Follow have been computed.

Exceptions   
NotSLRError, Error
  SLRItemIsFinal  
SLRItemIsFinal ( self,  item )
utility function

returns true if an item is a final item

  __init__  
__init__ (
        self,
        StartNonterm,
        Rulelist,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser.py.html0100600000176200017510000002542307306455601030352 0ustar dhellmanndevel Module: kjParser

Table of Contents

Module: kjParser Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser.py

Imported modules   
import kjSet
import re
import string
Functions   
DefaultReductFun
DumpStringWindow
NullGrammar
PrintDefaultBindings
RMATCH
UnMarshalGram
nonterminal
termrep
  DefaultReductFun  
DefaultReductFun ( RuleResultsList,  Context )

the following function is used as a default reduction function for rules

  DumpStringWindow  
DumpStringWindow (
        Str,
        Pos,
        Offset=15,
        )

utility function for error diagnostics

  NullGrammar  
NullGrammar ()

function to create a "null grammar"

  PrintDefaultBindings  
PrintDefaultBindings ( rulelist )

for debugging: look through a rule list and print names of rules that have default binding

  RMATCH  
RMATCH (
        re,
        key,
        start=0,
        )

Utility function for match conversion from regex to re

  UnMarshalGram  
UnMarshalGram ( file )

unmarshalling a marshalled grammar created by buildmodule.CGrammar.MarshalDump(Tofile) tightly coupled with buildmodule code... file should be open and "pointing to" the marshalled rep.

warning: doesn't bind semantics!

  nonterminal  
nonterminal ( string )

function for declaring a variable to represent a nonterminal: eg Program = nonterminal("program") included for convenient autodocumentation

  termrep  
termrep ( string )

declaring a terminal WITHOUT INSTALLING IT IN A LexDict

Classes   
FSMachine

the FSM class

Grammar

the grammar class:

KeywordDict

a utility class: dictionary of prefixes

LexDictionary

lexical dictionary class

LexStringWalker

LexStringWalker walks through a string looking for

ParseRule
ParserObj
UnMarshaller

unmarshalling object for unmarshalling grammar from a file

lexdictionary

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser_FSMachine.py.html0100600000176200017510000002414607306455600032227 0ustar dhellmanndevel Class: FSMachine

Table of Contents

Class: FSMachine Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser.py

the FSM class

Methods   
DUMP
Expects
NewState
SetMap
SetReduction
__init__
map
  DUMP  
DUMP (
        self,
        DumpMapData=1,
        DumpStateData=1,
        ForbiddenMark={},
        )

ForbiddenMark is for filtering out maps to an error state

  Expects  
Expects ( self,  State )

what tokens does a state expect?

  NewState  
NewState (
        self,
        kind,
        AdditionalInfo=[],
        )

"allocate" a new state of specified kind kind must either be TRANSFLAG, TERMFLAG or a rule object returns the number of the new state

Exceptions   
TypeError, "unknown state kind"
  SetMap  
SetMap (
        self,
        fromState,
        TokenRep,
        toState,
        )

Install a "shift" or "goto transition in the FSM: supports nondeterminism by storing a sequence of possible transitions

Exceptions   
NondetError, "attempt to make inappropriate transition ambiguous"
  SetReduction  
SetReduction (
        self,
        fromState,
        TokenRep,
        Rulenum,
        )

Install a reduction transition in the FSM: a reduction is represented by mapping to a rule index no nondeterminism is allowed.

Exceptions   
ReductError, "attempt to set ambiguous reduction"
  __init__  
__init__ ( self,  rootNonTerm )

  map  
map (
        self,
        current_state,
        current_token,
        )

Find the action indicated by fsm on (current_state, current_token) input.

note: in the event of nondeterministic choice this chooses the first possibility listed. ParseObj.DoOneReduction() currently uses the internal structure of StateTokenMap directly, rather than using this function.

Exceptions   
FlowError, "unexpected else (2)"

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser_Grammar.py.html0100600000176200017510000002237607306455600032023 0ustar dhellmanndevel Class: Grammar

Table of Contents

Class: Grammar Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser.py

the grammar class: a grammar consists of - a LexDict lexical dictionary; - a deterministic FSMachine; - a Rulelist and optionally a dictionary that maps Rulenames to Rulelist indices (used for dumping and externally)

Methods   
AddNameDict
Addterm
Bind
CleanUp
DoParse
DoParse1
PrintDefaults
SetCaseSensitivity
__init__
  AddNameDict  
AddNameDict ( self,  RuleNameDict )

this method associates rules to names using a RuleNameDict dictionary which maps names to rule indices. after invocation self.RuleNameToIndex[ name ] gives the index in self.RuleL for the rule associated with name, and self.RuleL[index].Name gives the name associated with the rule self.RuleL[index]

  Addterm  
Addterm (
        self,
        termname,
        regexpstr,
        funct,
        )

bind a terminal to a regular expression and interp function in the lexical dictionary (convenience)

  Bind  
Bind (
        self,
        Rulename,
        NewFunction,
        )

if the Name dictionary has been initialized this method will (re)bind a reduction function to a rule associated with Rulename

  CleanUp  
CleanUp ( self )

this may be silly, but to save some space in construction a token dictionary may be used that facilitates sharing of token representations. This method either initializes the dictionary or disposes of it if it exists

  DoParse  
DoParse (
        self,
        String,
        Context=None,
        DoReductions=1,
        )

parse a string using the grammar, return result and context

  DoParse1  
DoParse1 (
        self,
        String,
        Context=None,
        DoReductions=1,
        )

parse a string using the grammar, but only return the result of the last reduction, without the context

  PrintDefaults  
PrintDefaults ( self )

look for default bindings

  SetCaseSensitivity  
SetCaseSensitivity ( self,  Boolean )

setting case sensitivity: must happen before keyword installation in LexD.

  __init__  
__init__ (
        self,
        LexD,
        DFA,
        RuleL,
        RuleNameDict=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser_KeywordDict.py.html0100600000176200017510000001576507306455600032671 0ustar dhellmanndevel Class: KeywordDict

Table of Contents

Class: KeywordDict Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser.py

a utility class: dictionary of prefixes should be generalized to allow upcasing of keyword matches

Methods   
Dump
__getitem__
__init__
__setitem__
hasPrefix
has_key
  Dump  
Dump ( self )

  __getitem__  
__getitem__ ( self,  key )

  __init__  
__init__ ( self,  caseInsensitive=0 )

  __setitem__  
__setitem__ (
        self,
        key,
        value,
        )

set item assumes value has correct case already, if case sensitive

Exceptions   
LexTokenError, "Keyword of length 0"
  hasPrefix  
hasPrefix (
        self,
        String,
        StartPosition,
        punctuationlist,
        )

if String has a registered keyword at start position return its canonical representation and offset, else 0 keywords that are not punctuations should be recognized only if followed by a punctuation or whitespace char

  has_key  
has_key ( self,  key )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser_LexDictionary.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser_LexDictionary.py.ht0100600000176200017510000004021207306455600032647 0ustar dhellmanndevel Class: LexDictionary

Table of Contents

Class: LexDictionary Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser.py

lexical dictionary class this data structure is used by lexical parser below.

basic operations: LD.punctuation(string) registers a string as a punctuation EG: LD.punctuation(":") Punctuations are treated as a special kind of keyword that is recognized even when not surrounded by whitespace. IE, "xend" will not be recognized as "x end", but "x;" will be recognized as "x ;" if "end" is a regular keyword but "; is a punctuation. Only single character punctuations are supported (now), ie, must be recognized as ":" "=" above the lexical level.

LD.comment(compiled_reg_expression) registers a comment pattern EG LD.comment(regex.compile("--.*\n")) asks to recognize ansi/sql comments like "-- correct?\n"

LD.keyword(keyword_string, canonicalstring) specifies a keyword string that should map to the canonicalstring when translated to the lexical stream. EG: LD.keyword("begin","BEGIN"); LD.keyword("BEGIN","BEGIN") will recognize upcase or downcase begins, not mixed case. (automatic upcasing is allowed below at parser level).

LD[compiled_reg_expression] = (TerminalFlag, Function) # assignment! specifies a regular expression that should be associated with the lexical terminal marker TerminalFlag EG: LD[regex.compile("[0-9]+")] = ("integer",string.atoi) the Function should be a function on one string argument that interprets the matching string as a value. if None is given, just the string itself will be used as the interpretation. (a better choice above would be a function which "tries" atoi first and uses atol on overflow). NOTE: ambiguity among regular expressions will be decided arbitrarily (fix?).

LD[string] # retrieval! returns ((KEYFLAG, Keywordstring), Keywordstring) if the (entire) string matches a keyword or a punctuation Keywordstring. otherwise returns ((TERMFLAG, Terminalname), value) if the (entire) string matches the regular expression for a terminal flaged by Terminalname; value is the interpreted value. TerminalFlag better be something other than KEYFLAG! otherwise raises an error! comments not filtered here!

the following additional functions are used for autodocumentation in declaring rules, etcetera. begin = LD.keyword("begin") sets variable "begin" to (KEYFLAG, "BEGIN") if "begin" maps to keyword "BEGIN" in LD integer = LD.terminal("integer") sets variable integer to ("integer", Function) if "integer" is a registered terminal Function is its associated interpretation function.

Methods   
Dump
SetCaseSensitivity
Token
__getitem__
__init__
__setitem__
comment
isCaseSensitive
keyword
punctuation
 terminal
  Dump  
Dump ( self )

  SetCaseSensitivity  
SetCaseSensitivity ( self,  Boolean )

setting case sensitivity MUST happen before keyword declarations!

  Token  
Token (
        self,
        String,
        StartPosition,
        )

function to do same as __getitem__ above but looking inside a string instead of at the whole string returns (token,skip) where token is one of ((KEYFLAG,name),name) or ((TERMFLAG,termname),value) and skip is the length of substring of string that matches thetoken

Exceptions   
LexTokenError, "Lexical parse failure " + info
LexTokenError, "zero length comment " + info
  __getitem__  
__getitem__ ( self,  key )

Exceptions   
LexTokenError, "no match for string: " + ` key `
  __init__  
__init__ ( self )

  __setitem__  
__setitem__ (
        self,
        key,
        value,
        )

  comment  
comment ( self,  string )

register a regular expression as a comment

  isCaseSensitive  
isCaseSensitive ( self )

testing and altering case sensitivity behavior

  keyword  
keyword ( self,  str )

LD.keyword("this") will make a new keyword "this" if not found

  punctuation  
punctuation ( self,  Instring )

register a string as a punctuation

Exceptions   
BadPunctError, "punctuation may not be whitespace"
BadPunctError, "punctuation must be string of length 1"
  terminal  
terminal (
        self,
        string,
        RegExpr=None,
        Function=None,
        )

LD.terminal("this") will just look for "this" LD.terminal("this", RE, F) will register a new terminal RE must be a compiled regular expression or string reg ex F must be an interpretation function

Exceptions   
UnkTermError, "no such terminal"

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser_LexStringWalker.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser_LexStringWalker.py.0100600000176200017510000001407407306455601032632 0ustar dhellmanndevel Class: LexStringWalker

Table of Contents

Class: LexStringWalker Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser.py

LexStringWalker walks through a string looking for substrings recognized by a lexical dictionary

ERROR REPORTING NEEDS IMPROVEMENT

Methods   
DUMP
__init__
getmember
more
next
  DUMP  
DUMP ( self )

  __init__  
__init__ (
        self,
        String,
        LexDict,
        )

  getmember  
getmember ( self )

  more  
more ( self )

  next  
next ( self )

Exceptions   
LexTokenError, "Lexical walker not advancing " + data
LexTokenError, "no next past end of file " + data

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser_ParseRule.py.html0100600000176200017510000001433307306455601032332 0ustar dhellmanndevel Class: ParseRule

Table of Contents

Class: ParseRule Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser.py

Methods   
__init__
__repr__
components
reduce
  __init__  
__init__ (
        self,
        goalNonTerm,
        BodyList,
        ReductFunction=DefaultReductFun,
        )

Exceptions   
TypeError, "goal of rule must be nonterminal"
TypeError, "invalid body form for rule"
  __repr__  
__repr__ ( self )

for dumping/reconstruction: LOSES THE INTERPRETATION FUNCTION!

  components  
components ( self )

marshal-able components of a rule

  reduce  
reduce (
        self,
        Stack,
        Context=None,
        )

rule.reduce(Stack) pops of the stack elements corresponding to the body of the rule and prepares the appropriate reduction object for evaluation (or not) at higher levels

Exceptions   
ReductError, " token names don't match"

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser_ParserObj.py.html0100600000176200017510000001761107306455601032321 0ustar dhellmanndevel Class: ParserObj

Table of Contents

Class: ParserObj Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser.py

Methods   
DoOneReduction
GO
GotoState
ParseError
StackDump
__init__
  DoOneReduction  
DoOneReduction ( self )

DoOneReduction accepts tokens from the stream and pushes them onto the stack until a reduction state is reached.

Resolve the reduction

Exceptions   
EOFError, 'end of stream during parse ' + data
FlowError, 'unexpected else ' + data
  GO  
GO ( self )

execute parsing until done:

  GotoState  
GotoState ( self,  rule )

compute the state to goto after a reduction is performed on a rule. Algorithm: determine the state at beginning of reduction and the next state indicated by the head nonterminal of the rule. special case: empty stack and root nonterminal > success.

  ParseError  
ParseError (
        self,
        State,
        Token,
        *rest,
        )

Exceptions   
SyntaxError, 'unexpected token sequence.' + data
  StackDump  
StackDump ( self,  N )

  __init__  
__init__ (
        self,
        Rulelist,
        Stream,
        FSM,
        Stack,
        Evaluate=1,
        Context=None,
        )

Evaluate determines whether rules should be evaluated after reductions. Context is an argument passed to the list reduction function

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser_UnMarshaller.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser_UnMarshaller.py.htm0100600000176200017510000001530607306455601032652 0ustar dhellmanndevel Class: UnMarshaller

Table of Contents

Class: UnMarshaller Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser.py

unmarshalling object for unmarshalling grammar from a file

Methods   
Cleanup
MakeLex
MakeRules
MakeTransitions
__init__
  Cleanup  
Cleanup ( self )

  MakeLex  
MakeLex ( self )

Exceptions   
FlowError, "unknown token type"
  MakeRules  
MakeRules ( self )

  MakeTransitions  
MakeTransitions ( self )

  __init__  
__init__ (
        self,
        file,
        Grammar,
        )

Exceptions   
FlowError, "bad type for unmarshalled list"
FlowError, "unmarshalled list of wrong size"

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser_lexdictionary.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser_lexdictionary.py.ht0100600000176200017510000002750107306455601032756 0ustar dhellmanndevel Class: lexdictionary

Table of Contents

Class: lexdictionary Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjParser.py

Methods   
Dump
SetCaseSensitivity
Token
__init__
comment
compile
isCaseSensitive
keyword
punctuation
terminal
  Dump  
Dump ( self,  *k )

Exceptions   
"sorry", "not implemented"
  SetCaseSensitivity  
SetCaseSensitivity ( self,  Boolean )

  Token  
Token (
        self,
        String,
        StartPosition,
        )

Exceptions   
LexTokenError, "Lexical token not found " + info
LexTokenError, "zero length whitespace or comment " + info
  __init__  
__init__ ( self )

  comment  
comment ( self,  str )

  compile  
compile ( self )

  isCaseSensitive  
isCaseSensitive ( self )

  keyword  
keyword ( self,  str )

  punctuation  
punctuation ( self,  Instring )

Exceptions   
BadPunctError, "punctuation may not be whitespace"
BadPunctError, "punctuation must be string of length 1"
  terminal  
terminal (
        self,
        str,
        regexstr=None,
        Function=None,
        )

Exceptions   
UnkTermError, "no such terminal"

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjSet.py.html0100600000176200017510000005150507306455601027651 0ustar dhellmanndevel Module: kjSet

Table of Contents

Module: kjSet Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjSet.py

Functions   
AddArc
AddComposition
Augment
BGadd
BGempty
BGgetdel
BGtest
Difference
Empty
GetPairs
 HasArc
Intersection
Mask
Neighbors
NewBG
NewDG
NewSet
Same
Sources
Subset
 TransClose
Union
addMember
get_elts
member
  AddArc  
AddArc (
        Graph,
        Source,
        Dest,
        )

  AddComposition  
AddComposition (
        G1,
        G2,
        G3,
        )

when G1, G2 and G3 are different graphs this results in G1 = G1 U ( G2 o G3 ) If G1 is identical to one of G2,G3 the result is somewhat nondeterministic (depends on dictionary implementation). However, guaranteed that AddComposition(G,G,G) returns G1 U (G1 o G1) <= G <= TC(G1) where G1 is G's original value and TC(G1) is its transitive closure hence this function can be used for brute force transitive closure

  Augment  
Augment ( Set,  OtherSet )

  BGadd  
BGadd ( elt,  B )

may return new, larger structure must be used with assignment... B = BGadd(e,B)

Exceptions   
IndexError, "can't insert?"
  BGempty  
BGempty ( B )

  BGgetdel  
BGgetdel ( B )

Exceptions   
IndexError, "delete from empty grabbag(?)"
  BGtest  
BGtest ( n )

  Difference  
Difference ( Set1,  Set2 )

  Empty  
Empty ( Set )

  GetPairs  
GetPairs ( Graph )

  HasArc  
HasArc (
        Graph,
        Source,
        Dest,
        )

  Intersection  
Intersection ( Set1,  Set2 )

  Mask  
Mask ( Set,  OtherSet )

  Neighbors  
Neighbors ( Graph,  Source )

  NewBG  
NewBG ()

  NewDG  
NewDG ( pairlist )

  NewSet  
NewSet ( Sequence )

  Same  
Same ( Set1,  Set2 )

  Sources  
Sources ( Graph )

  Subset  
Subset ( Set1,  Set2 )

  TransClose  
TransClose ( Graph )

in place transitive closure of a graph

  Union  
Union ( Set1,  Set2 )

  addMember  
addMember ( Elt,  Set )

  get_elts  
get_elts ( Set )

  member  
member ( Elt,  Set )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjbuckets0.py.html0100600000176200017510000002126607306455601030637 0ustar dhellmanndevel Module: kjbuckets0

Table of Contents

Module: kjbuckets0 Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjbuckets0.py

Functions   
kjUndump
kjtabletest
less_general
more_general
test
  kjUndump  
kjUndump ( t1,  t2 )

  kjtabletest  
kjtabletest ( x )

  less_general  
less_general ( t1,  t2 )

Exceptions   
ValueError, "cannot coerce, not kjtable"
t1
t2
  more_general  
more_general ( t1,  t2 )

Exceptions   
ValueError, "cannot coerce, not kjtable"
t1
t2
  test  
test ()

Exceptions   
"bad cmp!", ( X, Y )
"has_key fails 0", X
"has_key fails 999", X
"huh 1?"
"huh 2?", S
"huh 3?", S
"member test fails (0,1)", X
"member test fails (999,888)", X
"nonzero fails", X
"trivial cmp fails", X
 "trivial subset fails", X
Classes   
kjDict
kjGraph
kjSet

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjbuckets0_kjDict.py.html0100600000176200017510000007111207306455601032122 0ustar dhellmanndevel Class: kjDict

Table of Contents

Class: kjDict Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjbuckets0.py

Base Classes   
kjGraph
Methods   
__add__
__and__
__cmp__
__delitem__
__getitem__
__hash__
__init__
__invert__
__len__
__mul__
 __nonzero__
__setitem__
__sub__
_pairs
_setitems
add
choose_key
delete_arc
dump
has_key
 items
keys
member
neighbors
reachable
remap
subset
values
  __add__  
__add__ ( s,  o )

Exceptions   
ValueError, "kjDict unions only with kjTable"
  __and__  
__and__ ( s,  o )

  __cmp__  
__cmp__ ( s,  o )

  __delitem__  
__delitem__ ( self,  item )

Exceptions   
ValueError, "table has been hashed, it is immutable"
  __getitem__  
__getitem__ ( self,  item )

  __hash__  
__hash__ ( s )

  __init__  
__init__ ( self,  *args )

Exceptions   
ValueError, "kjDict initializes only from list, tuple, kjTable, or int"
  __invert__  
__invert__ ( self )

  __len__  
__len__ ( self )

  __mul__  
__mul__ ( s,  o )

Exceptions   
ValueError, "kjDict only composes with kjTable"
  __nonzero__  
__nonzero__ ( self )

  __setitem__  
__setitem__ (
        self,
        item,
        value,
        )

Exceptions   
ValueError, "table has been hashed, it is immutable"
  __sub__  
__sub__ ( s,  o )

Exceptions   
ValueError, "kjDict only diffs with kjGraph, kjDict"
  _pairs  
_pairs ( self,  justtot=0 )

  _setitems  
_setitems ( self,  thing )

Exceptions   
KeyError, "table hashed, cannot modify"
  add  
add (
        s,
        k,
        v,
        )

Exceptions   
ValueError, "table has been hashed, immutable"
  choose_key  
choose_key ( self )

  delete_arc  
delete_arc (
        self,
        k,
        v,
        )

Exceptions   
KeyError, "pair not in table"
  dump  
dump ( self,  dumper )

  has_key  
has_key ( self,  k )

  items  
items ( self )

  keys  
keys ( self )

  member  
member (
        self,
        k,
        v,
        )

  neighbors  
neighbors ( self,  k )

  reachable  
reachable ( self,  k )

  remap  
remap ( self,  X )

  subset  
subset ( s,  o )

Exceptions   
ValueError, "kjDict subset test only for kjTable"
  values  
values ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjbuckets0_kjGraph.py.html0100600000176200017510000007661507306455601032315 0ustar dhellmanndevel Class: kjGraph

Table of Contents

Class: kjGraph Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjbuckets0.py

Methods   
Clean
Soil
Wash
__add__
__and__
__cmp__
__coerce__
__delitem__
__getitem__
__hash__
__init__
 __invert__
__len__
__mul__
__nonzero__
__repr__
__setitem__
__sub__
_pairs
_setitems
add
choose_key
 delete_arc
dump
has_key
ident
items
keys
member
neighbors
reachable
remap
subset
  Clean  
Clean ( self )

  Soil  
Soil ( self )

  Wash  
Wash ( self )

  __add__  
__add__ ( self,  other )

Exceptions   
ValueError, "kjGraph adds only with kjTable"
  __and__  
__and__ ( self,  other )

Exceptions   
ValueError, "kjGraph intersects only with kjTable"
  __cmp__  
__cmp__ ( self,  other )

  __coerce__  
__coerce__ ( self,  other )

  __delitem__  
__delitem__ ( self,  item )

  __getitem__  
__getitem__ ( self,  item )

  __hash__  
__hash__ ( self )

in conformance with kjbuckets, permit unhashable keys

  __init__  
__init__ ( self,  *args )

Exceptions   
ValueError, "arg for kjGraph must be tuple, list, or kjTable"
ValueError, "only 1 or 0 argument supported"
  __invert__  
__invert__ ( self )

  __len__  
__len__ ( self )

  __mul__  
__mul__ ( self,  other )

Exceptions   
ValueError, "kjGraph composes only with kjTable"
  __nonzero__  
__nonzero__ ( self )

  __repr__  
__repr__ ( self )

  __setitem__  
__setitem__ (
        self,
        item,
        value,
        )

  __sub__  
__sub__ ( self,  other )

Exceptions   
ValueError, "kjGraph diffs only with kjTable"
  _pairs  
_pairs ( self,  justtot=0 )

  _setitems  
_setitems ( self,  thing )

Exceptions   
TypeError, "unhashable type"
ValueError, "cannot setitems with %s" % type( thing )
ValueError, "table has been hashed, it is immutable"
unhashable
  add  
add (
        self,
        k,
        v,
        )

  choose_key  
choose_key ( self )

  delete_arc  
delete_arc (
        self,
        k,
        v,
        )

Exceptions   
KeyError, "not in table"
ValueError, "table has been hashed, it is immutable"
  dump  
dump ( self,  seq )

  has_key  
has_key ( self,  k )

  ident  
ident ( self )

????

  items  
items ( self )

  keys  
keys ( self )

  member  
member (
        self,
        k,
        v,
        )

  neighbors  
neighbors ( self,  k )

  reachable  
reachable ( self,  k )

  remap  
remap ( self,  X )

  subset  
subset ( self,  other )

  tclosure  
tclosure ( self )

Exceptions   
ValueError, "tclosure only defined on graphs"
self
  values  
values ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjbuckets0_kjSet.py.html0100600000176200017510000003325007306455601031773 0ustar dhellmanndevel Class: kjSet

Table of Contents

Class: kjSet Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjbuckets0.py

Base Classes   
kjDict
Methods   
__add__
__and__
__getitem__
__init__
__mul__
__repr__
__setitem__
__sub__
_pairs
_setelts
 add
  __add__  
__add__ ( s,  o )

  __and__  
__and__ ( s,  o )

Exceptions   
ValueError, "kjSet only intersects with kjTable"
  __getitem__  
__getitem__ ( self,  item )

Exceptions   
KeyError, "item not in set"
  __init__  
__init__ ( self,  *args )

Exceptions   
ValueError, "at most one argument supported"
ValueError, "kjSet from kjTable, int, list, tuple only"
  __mul__  
__mul__ ( s,  o )

  __repr__  
__repr__ ( self )

  __setitem__  
__setitem__ (
        self,
        item,
        ignore,
        )

Exceptions   
ValueError, "table hashed, immutable"
  __sub__  
__sub__ ( s,  o )

  _pairs  
_pairs ( self,  justtot=0 )

  _setelts  
_setelts ( self,  items )

  add  
add ( self,  elt )

Exceptions   
ValueError, "table hashed, immutable"

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjpylint.py.html0100600000176200017510000011230207306455601030426 0ustar dhellmanndevel Module: kjpylint

Table of Contents

Module: kjpylint Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjpylint.py

python lint using kwParsing

The goal of this module/filter is to help find programming errors in python source files.

As a filter use thusly:

% python kjpylint.py source_file.py

As an internal tool use like this:

import kjpylint (pyg, context) = kjpylint.setup() kjpylint.lint(data, pyg, context)

where data is the text of a python program. You can build your own context structure by subclassing GlobalContext, and redefining GlobalContext.complain(string) for example. You could do a lot more than that too...

Also, to lint all *.py files recursively contained in a directory hierarchy use

kjpylint.lintdir("/usr/local/lib/python") # for example

FEATURES:

Lint expects 1) a newline or two at the end of the data; 2) consistent indenting (and inconsistency may be invisible) [eg " \t" and "\t" are not the same indent to Lint, but Python sees them the same.]

If (1) or (2) are not satisfied Lint will raise an exception.

Buglets: lambdas and for loops on one line generate extraneous warnings.

Notes: ====== The lint process works, in outline, like this. Scan over a python program

x = 1

def f(a): a = x d.x, y = b

z = w

and build annotations like

[ set("x", 1), [ get("x", 4) set("a", 4) get("b", 5) get("d", 5) set("y", 5) pop_local() ] get("w", 7) set("z", 7) ]

from this stream conclude warning on line 5: b used before set warning on line 5: d used before set warning on line 5: y set, never used etc. using simple one pass approximate flow analysis.

Imported modules   
from pygram import newlineresult
Functions   
BindRules
Class
all1
analyse_scope
aname
arg2
arg3
arg4
argd
assn
assn1
assn1c
assn1c2
assnn
assnnc
 class1
class2
default_reduction
dn1
except2
for1
for2
fpdef1
fpdef2
fplist1
global1
globaln
go
lint
lintdir
 mark
namearg
nlist1
nlistn
params1
params2
params3
params4
powera
rdef
rfrom
rfromc
setup
testlambda1
trailerlist0
  BindRules  
BindRules ( pyg )

first test

  Class  
Class (
        name,
        testlist,
        suite,
        context,
        )

  all1  
all1 ( list,  context )

the highest level reduction! all1 :: all >> file_input DEDENT

  analyse_scope  
analyse_scope (
        sname,
        var_accesses,
        context,
        unused_ok=0,
        )

  aname  
aname ( list,  context )

  arg2  
arg2 ( l,  c )

@R arg2 :: arg >> fpdef

  arg3  
arg3 ( l,  c )

@R arg3 :: arg >> * NAME

  arg4  
arg4 ( l,  c )

@R arg4 :: arg >> ** NAME

  argd  
argd ( l,  c )

@R argd :: arg >> NAME = test

  assn  
assn ( left,  right )

  assn1  
assn1 ( list,  context )

  assn1c  
assn1c ( list,  context )

@R assn1c :: assn >> testlist , = testlist

  assn1c2  
assn1c2 ( list,  context )

@R assn1c2 :: assn >> testlist , = testlist ,

  assnn  
assnn ( list,  context )

  assnnc  
assnnc ( list,  context )

@R assnnc :: assn >> testlist , = assn

  class1  
class1 ( list,  context )

@R class1 :: classdef >> class NAME : suite

  class2  
class2 ( list,  context )

@R class2 :: classdef >> class NAME ( testlist ) : suite

  default_reduction  
default_reduction ( list,  context )

Exceptions   
"oops", x
  dn1  
dn1 ( list,  context )

  except2  
except2 ( list,  context )

@R except2 :: except_clause >> except test , test

  for1  
for1 ( list,  context )

  for2  
for2 ( list,  context )

  fpdef1  
fpdef1 ( l,  c )

@R fpdef1 :: fpdef >> NAME

  fpdef2  
fpdef2 ( l,  c )

@R fpdef2 :: fpdef >> ( fplist )

  fplist1  
fplist1 ( l,  c )

31 @R fplist1 :: fplist >> fpdef

  global1  
global1 ( list,  context )

  globaln  
globaln ( list,  context )

  go  
go ()

  lint  
lint (
        data,
        pygin=None,
        contextin=None,
        )

  lintdir  
lintdir ( directory_name )

lint all files recursively in directory

  mark  
mark (
        kind,
        thing,
        context,
        )

  namearg  
namearg ( list,  context )

ignore lhs in calls with keywords. @R namearg :: argument >> test = test

  nlist1  
nlist1 ( list,  context )

  nlistn  
nlistn ( list,  context )

  params1  
params1 ( l,  c )

vararsglist requires special treatment. return (innerscope, outerscope) pair of lists @R params1 :: parameters >> ( varargslist )

  params2  
params2 ( l,  c )

@R params2 :: varargslist >>

  params3  
params3 ( l,  c )

@R params3 :: varargslist >> arg

  params4  
params4 ( l,  c )

@R params4 :: varargslist >> varargslist , arg

  powera  
powera ( list,  context )

  rdef  
rdef ( list,  context )

@R rdef :: funcdef >> def NAME parameters : suite

  rfrom  
rfrom ( list,  context )

  rfromc  
rfromc ( list,  context )

  setup  
setup ()

  testlambda1  
testlambda1 ( list,  context )

@R testlambda1 :: test >> lambda varargslist : test

  trailerlist0  
trailerlist0 ( list,  context )

@R trailerlist0 :: trailerlist >>

  trailerlistn  
trailerlistn ( list,  context )

@R trailerlistn :: trailerlist >> trailer trailerlist

Classes   
globalContext

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjpylint_globalContext.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjpylint_globalContext.py.ht0100600000176200017510000001250207306455601032763 0ustar dhellmanndevel Class: globalContext

Table of Contents

Class: globalContext Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/kjpylint.py

Methods   
__init__
complain
defer_globals
patch_globals
when_done
  __init__  
__init__ ( self,  lexd )

  complain  
complain ( self,  str )

  defer_globals  
defer_globals ( self,  globals )

  patch_globals  
patch_globals ( self )

  when_done  
when_done ( self,  list )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/pygram.py.html0100600000176200017510000002243107306455601030064 0ustar dhellmanndevel Module: pygram

Table of Contents

Module: pygram Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/pygram.py

Imported modules   
import kjParser
from kjParser import KEYFLAG, ENDOFFILETERM
import re
import string
Functions   
DeclareTerminals
GrammarBuild
RMATCH
echo
hackDoParse
test
unMarshalpygram
  DeclareTerminals  
DeclareTerminals ( Grammar )

  GrammarBuild  
GrammarBuild ()

  RMATCH  
RMATCH (
        re,
        key,
        start=0,
        )

  echo  
echo ( str )

  hackDoParse  
hackDoParse (
        String,
        Context=None,
        DoReductions=1,
        )

a HORRIBLE HACK! of a hack: override the DoParse of Grammar to give Python line numbers. RELIES ON GLOBAL pyg

Exceptions   
t, v
  test  
test (
        grammar,
        context=None,
        teststring=teststring,
        )

  unMarshalpygram  
unMarshalpygram ()

Classes   
pylexdict
pylexstringwalker

use a modified lexstringwalker

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/pygram_pylexdict.py.html0100600000176200017510000001303207306455601032146 0ustar dhellmanndevel Class: pylexdict

Table of Contents

Class: pylexdict Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/pygram.py

Base Classes   
kjParser.LexDictionary
Methods   
Token
__init__
endoffile
  Token  
Token (
        self,
        String,
        StartPosition,
        )

Exceptions   
ValueError, "python lexer can't skip tokens"
ValueError, "python lexical parsing must start at zero"
parseerror, "failed to terminate single quotes"
parseerror, "failed to terminate triple quotes"
parseerror, "identifier length<1 (!)"
parseerror, "invalid first: " + ` first `
parseerror, "number length<1 (!)"
  __init__  
__init__ ( self )

  endoffile  
endoffile ( self,  String )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/pygram_pylexstringwalker.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/pygram_pylexstringwalker.py.0100600000176200017510000000624107306455601033056 0ustar dhellmanndevel Class: pylexstringwalker

Table of Contents

Class: pylexstringwalker Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/pygram.py

use a modified lexstringwalker

Base Classes   
kjParser.LexStringWalker
Methods   
DUMP
  DUMP  
DUMP ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg.py.html0100600000176200017510000006632307306455602030044 0ustar dhellmanndevel Module: relalg

Table of Contents

Module: relalg Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg.py

Simple relational algebra interpreter.

usage:

To make the grammar

python relalg.py make

To run some relatoinal algebra expressions

python relalg.py < expressions_file

Imported modules   
import string
Functions   
BindRules
Buildrelalg
DeclareTerminals
assignment1
charstfn
check_compat
elt0
elt1
emptylist
factorexpr
 intersect
join
maxrep
minus
named
names11
names1n
numlitfn
projection
relationval
 reloadrelalg
rename
rown
runfile
selection
somerows1
somerowsn
statementexpr
union
userdeffn
  BindRules  
BindRules ( sqlg )

  Buildrelalg  
Buildrelalg ( filename=MARSHALFILE )

  DeclareTerminals  
DeclareTerminals ( Grammar )

  assignment1  
assignment1 ( l,  c )

  charstfn  
charstfn ( str )

  check_compat  
check_compat ( v1,  v2 )

Exceptions   
ValueError, "operands not union compatible " + `( names1, names2 ) `
  elt0  
elt0 ( l,  c )

  elt1  
elt1 ( l,  c )

  emptylist  
emptylist ( l,  c )

  factorexpr  
factorexpr ( l,  c )

  intersect  
intersect ( l,  c )

  join  
join ( l,  c )

  maxrep  
maxrep ( list )

  minus  
minus ( l,  c )

  named  
named ( l,  c )

  names11  
names11 ( l,  c )

  names1n  
names1n ( l,  c )

  numlitfn  
numlitfn ( str )

Note: this is "safe" because regex filters out dangerous things.

  projection  
projection ( l,  c )

  relationval  
relationval ( l,  c )

Exceptions   
ValueError, "names, vals don't match" + `( names, this ) `
  reloadrelalg  
reloadrelalg ( filename=MARSHALFILE )

  rename  
rename ( l,  c )

Exceptions   
ValueError, "names lengths must match" + `( names1, names2 ) `
ValueError, "old names not present" + `( names, val.names ) `
  rown  
rown ( l,  c )

  runfile  
runfile ( f )

  selection  
selection ( l,  c )

  somerows1  
somerows1 ( l,  c )

  somerowsn  
somerowsn ( l,  c )

  statementexpr  
statementexpr ( l,  c )

  union  
union ( l,  c )

  userdeffn  
userdeffn ( str )

Classes   
conditionor
expname
expvalue
factorand
notprimary
primaryeq
punter
relation
tracer

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg_conditionor.py.html0100600000176200017510000000635607306455601032452 0ustar dhellmanndevel Class: conditionor

Table of Contents

Class: conditionor Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg.py

Methods   
__init__
filter
  __init__  
__init__ (
        self,
        l,
        c,
        )

  filter  
filter ( self,  val )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg_expname.py.html0100600000176200017510000000634207306455601031553 0ustar dhellmanndevel Class: expname

Table of Contents

Class: expname Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg.py

Methods   
__init__
value
  __init__  
__init__ (
        self,
        l,
        c,
        )

  value  
value ( self,  rows )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg_expvalue.py.html0100600000176200017510000000627107306455602031751 0ustar dhellmanndevel Class: expvalue

Table of Contents

Class: expvalue Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg.py

Base Classes   
expname
Methods   
value
  value  
value ( self,  rows )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg_factorand.py.html0100600000176200017510000000630707306455602032061 0ustar dhellmanndevel Class: factorand

Table of Contents

Class: factorand Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg.py

Base Classes   
conditionor
Methods   
filter
  filter  
filter ( self,  val )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg_notprimary.py.html0100600000176200017510000000635407306455602032326 0ustar dhellmanndevel Class: notprimary

Table of Contents

Class: notprimary Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg.py

Methods   
__init__
filter
  __init__  
__init__ (
        self,
        l,
        c,
        )

  filter  
filter ( self,  val )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg_primaryeq.py.html0100600000176200017510000000635207306455602032131 0ustar dhellmanndevel Class: primaryeq

Table of Contents

Class: primaryeq Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg.py

Methods   
__init__
filter
  __init__  
__init__ (
        self,
        l,
        c,
        )

  filter  
filter ( self,  val )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg_punter.py.html0100600000176200017510000000637007306455602031435 0ustar dhellmanndevel Class: punter

Table of Contents

Class: punter Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg.py

Methods   
__call__
__init__
  __call__  
__call__ (
        self,
        list,
        context,
        )

  __init__  
__init__ ( self,  name )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg_relation.py.html0100600000176200017510000000764507306455602031743 0ustar dhellmanndevel Class: relation

Table of Contents

Class: relation Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg.py

Methods   
__init__
__repr__
  __init__  
__init__ (
        self,
        names,
        rows,
        )

Exceptions   
ValueError, "bad names: " + `(names, r.items() ) `
  __repr__  
__repr__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg_tracer.py.html0100600000176200017510000000643407306455602031401 0ustar dhellmanndevel Class: tracer

Table of Contents

Class: tracer Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/relalg.py

Methods   
__call__
__init__
  __call__  
__call__ (
        self,
        list,
        context,
        )

  __init__  
__init__ (
        self,
        name,
        fn,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/remotetest.py.html0100600000176200017510000000556007306455602030765 0ustar dhellmanndevel Module: remotetest

Table of Contents

Module: remotetest Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/remotetest.py

Demonstration of the Remote View protocol for adding specially implemented Views in an application.

Imported modules   
from gadfly import gadfly
import gfintrospect
Classes   
myTable

A remote view must define self.column_names

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/remotetest_myTable.py.html0100600000176200017510000001070707306455602032441 0ustar dhellmanndevel Class: myTable

Table of Contents

Class: myTable Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/remotetest.py

A remote view must define self.column_names to return a (fixed) list of string column names and self.listing() to return a possibly varying list of row values. If there is a single column the listing() list must return a list of values, but for multiple columns it must return a list of tuples with one entry for each column.

The remote view implementation may optionally redefine __init__ also, please see gfintrospect.py

Base Classes   
gfintrospect.RemoteView
Methods   
__init__
listing
  __init__  
__init__ (
        self,
        column_names=None,
        rowlist=None,
        )

do whatever needed for initialization

  listing  
listing ( self )

return list of tuples of right sizes to match column_names. for more interesting views this will do something more complex ;).

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlbind.py.html0100600000176200017510000020031407306455602030220 0ustar dhellmanndevel Module: sqlbind

Table of Contents

Module: sqlbind Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlbind.py

rule bindings for sql grammar.

Functions   
BindRules
ad0
addistinct
allset
assn
assn1
assnn
booln
coldef
columnname1
columnname2
countstar
createindex
createtable
createuniqueindex
createview
deletefrom
distinctset
dropindex
droptable
dropview
dynamic
elt0
elt1
elt2
except1
exists
expminus
expplus
 insert1
insert_query
insert_values
intersect1
listcommathing
literal
minusfactor
notbf
optord0
optorddesc
predbetween
predicateeq
predicatege
predicategt
predicatele
predicatelt
predicatene
predin
predinlits
prednotbetween
prednotin
prednotinlits
predqeq
predqge
predqgt
predqle
predqlt
predqne
returnNone
 searchn
select1
selectit
selectn
selectname
selectstar
selectx
set
sliterald
sliteralm
sliteralp
sliterals
sortcol
sortint
stat1
stringstring
subqexpr
subselect
termdiv
termtimes
thingcommalist
trl1
trl1a
trl1as
trln
trlna
trlnas
union1
update
  BindRules  
BindRules ( sqlg )

  ad0  
ad0 ( list,  context )

  addistinct  
addistinct ( list,  context )

  allset  
allset ( l,  c )

  assn  
assn ( l,  c )

  assn1  
assn1 ( l,  c )

  assnn  
assnn ( l,  c )

  booln  
booln ( list,  context )

  coldef  
coldef ( l,  c )

  columnname1  
columnname1 ( list,  context )

  columnname2  
columnname2 ( list,  context )

  countstar  
countstar ( l,  c )

  createindex  
createindex ( l,  c )

create index statement stuff

  createtable  
createtable ( list,  context )

  createuniqueindex  
createuniqueindex ( l,  c )

  createview  
createview ( l,  c )

create view statement stuff

  deletefrom  
deletefrom ( l,  c )

  distinctset  
distinctset ( l,  c )

  dropindex  
dropindex ( l,  c )

drop index statement stuff

  droptable  
droptable ( l,  c )

  dropview  
dropview ( l,  c )

drop view statement stuff

  dynamic  
dynamic ( list,  context )

  elt0  
elt0 ( list,  context )

return first member of reduction

  elt1  
elt1 ( list,  context )

return second member

  elt2  
elt2 ( list,  context )

  except1  
except1 ( l,  c )

  exists  
exists ( l,  c )

  expminus  
expminus ( list,  context )

  expplus  
expplus ( list,  context )

  insert1  
insert1 ( l,  c )

  insert_query  
insert_query ( l,  c )

  insert_values  
insert_values ( l,  c )

  intersect1  
intersect1 ( l,  c )

  listcommathing  
listcommathing ( l,  c )

  literal  
literal ( list,  context )

expression stuff

  minusfactor  
minusfactor ( list,  context )

  notbf  
notbf ( list,  context )

  optord0  
optord0 ( l,  c )

  optorddesc  
optorddesc ( l,  c )

  predbetween  
predbetween ( list,  context )

  predicateeq  
predicateeq ( list,  context )

  predicatege  
predicatege ( list,  context )

  predicategt  
predicategt ( list,  context )

  predicatele  
predicatele ( list,  context )

  predicatelt  
predicatelt ( list,  context )

  predicatene  
predicatene ( list,  context )

  predin  
predin ( list,  context )

  predinlits  
predinlits ( list,  context )

  prednotbetween  
prednotbetween ( list,  context )

  prednotin  
prednotin ( list,  context )

  prednotinlits  
prednotinlits ( list,  context )

  predqeq  
predqeq ( list,  context )

  predqge  
predqge ( list,  context )

  predqgt  
predqgt ( list,  context )

  predqle  
predqle ( list,  context )

  predqlt  
predqlt ( list,  context )

  predqne  
predqne ( list,  context )

  returnNone  
returnNone ( list,  context )

  searchn  
searchn ( list,  context )

  select1  
select1 ( list,  context )

  selectit  
selectit ( list,  context )

  selectn  
selectn ( list,  context )

  selectname  
selectname ( list,  context )

  selectstar  
selectstar ( l,  c )

select list stuff

  selectx  
selectx ( list,  context )

  set  
set (
        agg,
        exp,
        distinct,
        )

Exceptions   
NameError, ` agg ` + ": unknown aggregate"
  sliterald  
sliterald ( l,  c )

  sliteralm  
sliteralm ( l,  c )

  sliteralp  
sliteralp ( l,  c )

  sliterals  
sliterals ( l,  c )

  sortcol  
sortcol ( l,  c )

  sortint  
sortint ( l,  c )

Exceptions   
ValueError, ` num ` + ': col position not positive int'
  stat1  
stat1 ( list,  context )

return list of len 1 of statements

  stringstring  
stringstring ( l,  c )

two strings in sequence = apostrophe

  subqexpr  
subqexpr ( list,  context )

subquery expression

  subselect  
subselect ( list,  context )

  termdiv  
termdiv ( list,  context )

  termtimes  
termtimes ( list,  context )

  thingcommalist  
thingcommalist ( l,  c )

  trl1  
trl1 ( l,  c )

table reference list returns list of (name, name) or (name, alias)

  trl1a  
trl1a ( l,  c )

  trl1as  
trl1as ( l,  c )

  trln  
trln ( l,  c )

  trlna  
trlna ( l,  c )

  trlnas  
trlnas ( l,  c )

  union1  
union1 ( l,  c )

  update  
update ( l,  c )

  where0  
where0 ( list,  context )

Classes   
punter
tracer

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlbind_punter.py.html0100600000176200017510000000637107306455602031624 0ustar dhellmanndevel Class: punter

Table of Contents

Class: punter Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlbind.py

Methods   
__call__
__init__
  __call__  
__call__ (
        self,
        list,
        context,
        )

  __init__  
__init__ ( self,  name )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlbind_tracer.py.html0100600000176200017510000000643507306455602031570 0ustar dhellmanndevel Class: tracer

Table of Contents

Class: tracer Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlbind.py

Methods   
__call__
__init__
  __call__  
__call__ (
        self,
        list,
        context,
        )

  __init__  
__init__ (
        self,
        name,
        fn,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlgen.py.html0100600000176200017510000001667207306455602030071 0ustar dhellmanndevel Module: sqlgen

Table of Contents

Module: sqlgen Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlgen.py

grammar generation stuff for sql.

This module does not bind any rule semantics, it just generates the parser data structures.

Imported modules   
import string
Functions   
BuildSQL
DeclareTerminals
charstfn
getSQL
numlitfn
reloadSQLG
userdeffn
  BuildSQL  
BuildSQL ( filename=MARSHALFILE )

  DeclareTerminals  
DeclareTerminals ( Grammar )

  charstfn  
charstfn ( str )

  getSQL  
getSQL ()

  numlitfn  
numlitfn ( str )

Note: this is "safe" because regex filters out dangerous things.

  reloadSQLG  
reloadSQLG ( filename=MARSHALFILE )

does not bind any interpretation functions.

  userdeffn  
userdeffn ( str )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlgram.py.html0100600000176200017510000000246207306455602030236 0ustar dhellmanndevel Module: sqlgram

Table of Contents

Module: sqlgram Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlgram.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlgtest.py.html0100600000176200017510000000245007306455602030433 0ustar dhellmanndevel Module: sqlgtest

Table of Contents

Module: sqlgtest Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlgtest.py

test parses for sql grammar

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod.py.html0100600000176200017510000001465707306455603030101 0ustar dhellmanndevel Module: sqlmod

Table of Contents

Module: sqlmod Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod.py

Database modification statement semantics

Imported modules   
import sqlsem
Functions   
evalcond
  evalcond  
evalcond (
        cond,
        eqs,
        target,
        dyn,
        rassns,
        translate,
        invtrans,
        )

factored out shared op between Update and Delete.

Exceptions   
ValueError, "only one dynamic binding allowed for UPDATE"
Classes   
ColumnDef
CreateIndex

create index operation

CreateTable

create table operation

CreateView

CREATE VIEW name (namelist) AS selection

DeleteOp
DropIndex
DropTable
DropView

DROP VIEW name

InsertOp
InsertSubSelect
InsertValues
Ordered_DDF

mixin for DDF statement sorting, subclass defines s.cmp(o)

UpdateOp

optimize to use indices and single call to "cond

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod_ColumnDef.py.html0100600000176200017510000001115607306455602032023 0ustar dhellmanndevel Class: ColumnDef

Table of Contents

Class: ColumnDef Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod.py

Base Classes   
sqlsem.SimpleRecursive
Methods   
__init__
__repr__
initargs
  __init__  
__init__ (
        self,
        colid,
        datatype,
        defaults,
        constraints,
        )

  __repr__  
__repr__ ( self )

  initargs  
initargs ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod_CreateIndex.py.html0100600000176200017510000002146307306455602032344 0ustar dhellmanndevel Class: CreateIndex

Table of Contents

Class: CreateIndex Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod.py

create index operation

Base Classes   
sqlsem.SimpleRecursive
Ordered_DDF
Methods   
__cmp__
__coerce__
__init__
__repr__
eval
initargs
relbind
  __cmp__  
__cmp__ ( self,  other )

  __coerce__  
__coerce__ ( self,  other )

  __init__  
__init__ (
        self,
        name,
        tablename,
        atts,
        unique=0,
        )

  __repr__  
__repr__ ( self )

  eval  
eval ( self,  dyn=None )

Exceptions   
ValueError, "create index not bound to relation"
ValueError, "create index unbound or executed"
  initargs  
initargs ( self )

  relbind  
relbind ( self,  db )

Exceptions   
NameError, ` name ` + ": data def exists"
NameError, ` self.tablename ` + ": no such relation"

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod_CreateTable.py.html0100600000176200017510000002127507306455603032326 0ustar dhellmanndevel Class: CreateTable

Table of Contents

Class: CreateTable Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod.py

create table operation

Base Classes   
Ordered_DDF
Methods   
__init__
__repr__
demarshal
eval
initargs
marshaldata
relbind
  __init__  
__init__ (
        self,
        name,
        colelts,
        )

  __repr__  
__repr__ ( self )

  demarshal  
demarshal ( self,  args )

  eval  
eval ( self,  dyn=None )

create the relation now

Exceptions   
NameError, "relation %s exists, cannot create" %( self.name, )
ValueError, "unbound or executed"
  initargs  
initargs ( self )

  marshaldata  
marshaldata ( self )

  relbind  
relbind ( self,  db )

check that table doesn't already exist

Exceptions   
NameError, "cannot create %s, exists" %( self.name, )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod_CreateView.py.html0100600000176200017510000001656707306455603032221 0ustar dhellmanndevel Class: CreateView

Table of Contents

Class: CreateView Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod.py

CREATE VIEW name (namelist) AS selection

Base Classes   
sqlsem.SimpleRecursive
Ordered_DDF
Methods   
__init__
__repr__
eval
initargs
relbind
  __init__  
__init__ (
        self,
        name,
        namelist,
        selection,
        )

note: no check for cross-references on drops!

  __repr__  
__repr__ ( self )

  eval  
eval ( self,  dyn=None )

create the view

Exceptions   
ValueError, "create view %s unbound or executed" % name
ValueError, "create view %s, name exists" % name
  initargs  
initargs ( self )

  relbind  
relbind ( self,  db )

Exceptions   
NameError, "(view) datadef %s exists" % name

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod_DeleteOp.py.html0100600000176200017510000001364007306455603031651 0ustar dhellmanndevel Class: DeleteOp

Table of Contents

Class: DeleteOp Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod.py

Base Classes   
sqlsem.SimpleRecursive
Methods   
__init__
__repr__
eval
initargs
relbind
  __init__  
__init__ (
        self,
        name,
        where,
        )

  __repr__  
__repr__ ( self )

  eval  
eval ( self,  dyn=None )

  initargs  
initargs ( self )

  relbind  
relbind ( self,  db )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod_DropIndex.py.html0100600000176200017510000001632307306455603032045 0ustar dhellmanndevel Class: DropIndex

Table of Contents

Class: DropIndex Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod.py

Base Classes   
sqlsem.SimpleRecursive
Methods   
__init__
__repr__
eval
initargs
relbind
  __init__  
__init__ ( self,  name )

  __repr__  
__repr__ ( self )

  eval  
eval ( self,  dyn=None )

Exceptions   
ValueError, "drop index executed or unbound"
  initargs  
initargs ( self )

  relbind  
relbind ( self,  db )

Exceptions   
NameError, ` self.name ` + ": no such index"

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod_DropTable.py.html0100600000176200017510000002116107306455603032021 0ustar dhellmanndevel Class: DropTable

Table of Contents

Class: DropTable Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod.py

Base Classes   
sqlsem.SimpleRecursive
Methods   
__init__
__repr__
check_kind
eval
initargs
relbind
  __init__  
__init__ ( self,  name )

  __repr__  
__repr__ ( self )

  check_kind  
check_kind (
        self,
        name,
        db,
        )

Exceptions   
ValueError, "%s is VIEW, can't DROP TABLE" % name
  eval  
eval ( self,  dyn )

Exceptions   
ValueError, "unbound or executed"
  initargs  
initargs ( self )

  relbind  
relbind ( self,  db )

Exceptions   
NameError, ` self.name ` + ": cannot delete, no such table/view"

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod_DropView.py.html0100600000176200017510000001115507306455603031706 0ustar dhellmanndevel Class: DropView

Table of Contents

Class: DropView Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod.py

DROP VIEW name

Base Classes   
DropTable
    sqlsem.SimpleRecursive
Methods   
__repr__
check_kind
  __repr__  
__repr__ ( self )

  check_kind  
check_kind (
        self,
        name,
        db,
        )

Exceptions   
ValueError, "%s is TABLE, can't DROP VIEW" % name

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod_InsertOp.py.html0100600000176200017510000001542607306455603031717 0ustar dhellmanndevel Class: InsertOp

Table of Contents

Class: InsertOp Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod.py

Base Classes   
sqlsem.SimpleRecursive
Methods   
__init__
__repr__
eval
initargs
relbind
  __init__  
__init__ (
        self,
        name,
        optcolids,
        insertspec,
        )

  __repr__  
__repr__ ( self )

  eval  
eval ( self,  dyn=None )

  initargs  
initargs ( self )

  relbind  
relbind ( self,  db )

Exceptions   
NameError, "%s: no such attributes in %s" %( cdiff.items(), name )
NameError, "%s: not set in insert on %s" %( cdiff.items(), name )
ValueError, "result and colset of differing length %s:%s" %( colset, resultexps )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod_InsertSubSelect.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod_InsertSubSelect.py.ht0100600000176200017510000001510707306455603032675 0ustar dhellmanndevel Class: InsertSubSelect

Table of Contents

Class: InsertSubSelect Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod.py

Base Classes   
sqlsem.SimpleRecursive
Methods   
__init__
__repr__
eval
initargs
relbind
resultexps
  __init__  
__init__ ( self,  subsel )

  __repr__  
__repr__ ( self )

  eval  
eval ( self,  dyn=None )

  initargs  
initargs ( self )

  relbind  
relbind ( self,  db )

  resultexps  
resultexps ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod_InsertValues.py.html0100600000176200017510000001507707306455603032602 0ustar dhellmanndevel Class: InsertValues

Table of Contents

Class: InsertValues Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod.py

Base Classes   
sqlsem.SimpleRecursive
Methods   
__init__
__repr__
eval
initargs
relbind
resultexps
  __init__  
__init__ ( self,  List )

  __repr__  
__repr__ ( self )

  eval  
eval ( self,  dyn=None )

  initargs  
initargs ( self )

  relbind  
relbind ( self,  db )

  resultexps  
resultexps ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod_Ordered_DDF.py.html0100600000176200017510000000760607306455603032216 0ustar dhellmanndevel Class: Ordered_DDF

Table of Contents

Class: Ordered_DDF Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod.py

mixin for DDF statement sorting, subclass defines s.cmp(o)

Methods   
__cmp__
__coerce__
cmp
  __cmp__  
__cmp__ ( self,  other )

  __coerce__  
__coerce__ ( self,  other )

  cmp  
cmp ( self,  other )

redefine if no name field

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod_UpdateOp.py.html0100600000176200017510000001517707306455603031700 0ustar dhellmanndevel Class: UpdateOp

Table of Contents

Class: UpdateOp Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlmod.py

optimize to use indices and single call to "cond"

Base Classes   
sqlsem.SimpleRecursive
Methods   
__init__
__repr__
eval
initargs
relbind
  __init__  
__init__ (
        self,
        name,
        assns,
        condition,
        )

  __repr__  
__repr__ ( self )

  eval  
eval ( self,  dyn=None )

  initargs  
initargs ( self )

  relbind  
relbind ( self,  db )

Exceptions   
NameError, "%s lacks %s attributes" %(name, huh.items() )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py.html0100600000176200017510000005255207306455605030104 0ustar dhellmanndevel Module: sqlsem

Table of Contents

Module: sqlsem Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

sql semantics

Imported modules   
import gfdb0
import sqlmod
import sys
import traceback
Functions   
NamedSort
PositionedSort
aggregate
deserialize
dump_single_column
dynamic_binding
no_ints_nulls
order_tuples
orderbind_sequence
relbind_sequence
 serialize
  NamedSort  
NamedSort ( name,  ord )

  PositionedSort  
PositionedSort ( num,  ord )

  aggregate  
aggregate ( assignments,  exprlist )

aggregates are a assignments with special attribute None > list of subtuple

Exceptions   
ValueError, "aggregate on no expressions?"
  deserialize  
deserialize ( description )

simple protocol for generating a marshallable ob

  dump_single_column  
dump_single_column ( assigns,  att )

dump single column assignment

  dynamic_binding  
dynamic_binding ( ndynamic,  dynamic )

create bindings from dynamic tuple for ndynamic parameters if a tuple is given create one if a list is given create many

Exceptions   
TypeError, "dynamic parameters must be list or tuple"
ValueError, "%s,%s: wrong number of dynamics" %( ldyn, ndynamic )
ValueError, "dynamic parameters of inconsistent lengths"
ValueError, ` ndynamic ` + " dynamic parameters unbound"
  no_ints_nulls  
no_ints_nulls ( list )

in place remove all ints, Nones from a list (for null handling)

  order_tuples  
order_tuples ( order_list,  tuples )

Exceptions   
ValueError, "TUPLE LOST IN ORDERING COMPUTATION! (%s,%s)" %( ltuples, index )
ValueError, "order on empty list?"
  orderbind_sequence  
orderbind_sequence ( order_list,  order )

  relbind_sequence  
relbind_sequence (
        order_list,
        dict,
        db,
        )

  serialize  
serialize ( ob )

dual of deserialize.

Exceptions   
ValueError, "couldn't serialize %s %s" %( tt, ob.__class__ )
Classes   
Average

stuff for aggregation

BTPredicate

superclass for bound tuple predicates.

BTand_pred
BTnot_pred
BTor_pred
BetweenPredicate

e1 BETWEEN e2 AND e3

BoundAddition

promised addition.

BoundAttribute

bound attribute: initialize with relname=None if

BoundDivision

promised division.

BoundExpression

superclass for all bound expressions.

BoundMinus
BoundMultiplication

promised multiplication.

BoundSubtraction

promised subtraction.

BoundTuple
Constant
Count
DescExpr

special wrapper used only for order by descending

Except
ExistsPred

EXISTS subquery.

HashJoiner
InLits

expr IN literals, support dynamic bindings.

Intersect
LessEqPred
LessPred
Maximum
Median
Minimum
NontrivialEqPred

equation of nontrivial expressions.

NumberedColumn

order by column number

OrderExpr

order by expression.

Parse_Context

contextual information for parsing

QuantEQ

Quantified equal any predicate

QuantGE

Quantified greater equal any predicate

QuantGT

Quantified greater than any predicate

QuantLE

Quantified less equal any predicate

QuantLT

Quantified less than any predicate

QuantNE

Quantified not equal any predicate

Selector

For implementing, eg the SQL SELECT statement.

SimpleColumn

a simple column name for application to a list of tuples

SimpleRecursive

Simple Recursive structure, only requires initargs

SubQueryExpression

sub query expression (subq), must eval to single column, single value

Sum
TupleCollector

Translate a sequence of assignments to simple tuples.

Union

union clause.

descOb

special wrapper only used for sorting in descending order

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_Average.py.html0100600000176200017510000002316507306455603031532 0ustar dhellmanndevel Class: Average

Table of Contents

Class: Average Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

stuff for aggregation

Base Classes   
BoundMinus
Methods   
__init__
__repr__
agg_value
all_value
clean
dvalues
op
relbind
value
  __init__  
__init__ (
        self,
        expr,
        distinct=0,
        )

Exceptions   
ValueError, ` expr ` + ": aggregate in aggregate " + self.name
  __repr__  
__repr__ ( self )

  agg_value  
agg_value ( self,  contexts )

  all_value  
all_value ( self,  contexts )

  clean  
clean (
        self,
        values,
        contexts,
        )

  dvalues  
dvalues ( self,  values )

  op  
op ( self,  values )

  relbind  
relbind (
        self,
        dict,
        db,
        )

  value  
value ( self,  contexts )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BTPredicate.py.html0100600000176200017510000003155307306455603032306 0ustar dhellmanndevel Class: BTPredicate

Table of Contents

Class: BTPredicate Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

superclass for bound tuple predicates. Eventually should be modified to use "compile" for speed to generate an "inlined" evaluation function. self(bt) returns bt with additional equality constraints (possible) or None if predicate fails.

Base Classes   
SimpleRecursive
Methods   
__and__
__call__
__cmp__
__hash__
__init__
__invert__
__or__
__repr__
detrivialize
domain
 initargs
negated_constraints
relbind
uncache
  __and__  
__and__ ( self,  other )

NOTE: all subclasses must define an __and__!!!

  __call__  
__call__ (
        self,
        assignments,
        toplevel=0,
        )

apply self to sequence of assignments return copy of asssignments with false results replaced by 0! Input may have 0's!

  __cmp__  
__cmp__ ( self,  other )

  __hash__  
__hash__ ( self )

  __init__  
__init__ ( self,  constraints=None )

default interpretation: True.

  __invert__  
__invert__ ( self )

  __or__  
__or__ ( self,  other )

  __repr__  
__repr__ ( self )

  detrivialize  
detrivialize ( self )

hook added to allow elimination of trivialities return None if completely true, or simpler form or self, if no simplification is possible.

  domain  
domain ( self )

  initargs  
initargs ( self )

  negated_constraints  
negated_constraints ( self )

equality constraints always false of satisfactory tuple.

  relbind  
relbind (
        self,
        dict,
        db,
        )

  uncache  
uncache ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BTand_pred.py.html0100600000176200017510000003245407306455603032163 0ustar dhellmanndevel Class: BTand_pred

Table of Contents

Class: BTand_pred Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Base Classes   
BTPredicate
Methods   
__and__
__call__
__cmp__
__hash__
__init__
__invert__
__or__
__repr__
detrivialize
domain
 initargs
negated_constraints
relbind
uncache
  __and__  
__and__ ( self,  other )

push "and" down if other is an or

  __call__  
__call__ (
        self,
        boundtuples,
        toplevel=0,
        )

  __cmp__  
__cmp__ ( self,  other )

  __hash__  
__hash__ ( self )

  __init__  
__init__ (
        self,
        members,
        precondition=None,
        *othermembers,
        )

  __invert__  
__invert__ ( self )

translate to or-not

  __or__  
__or__ ( self,  other )

do the obvious thing.

  __repr__  
__repr__ ( self )

  detrivialize  
detrivialize ( self )

hook added to allow elimination of trivialities return None if completely true, or simpler form or self, if no simplification is possible.

Exceptions   
"what the?"
  domain  
domain ( self )

  initargs  
initargs ( self )

  negated_constraints  
negated_constraints ( self )

the negated constraints of an AND are the negated constraints of any member

  relbind  
relbind (
        self,
        dict,
        db,
        )

  uncache  
uncache ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BTnot_pred.py.html0100600000176200017510000003112107306455603032207 0ustar dhellmanndevel Class: BTnot_pred

Table of Contents

Class: BTnot_pred Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Base Classes   
BTPredicate
Methods   
__and__
__call__
__cmp__
__hash__
__init__
__invert__
__or__
__repr__
detrivialize
domain
 initargs
negated_constraints
relbind
uncache
  __and__  
__and__ ( self,  other )

do the obvious thing.

  __call__  
__call__ (
        self,
        boundtuples,
        toplevel=0,
        )

  __cmp__  
__cmp__ ( self,  other )

  __hash__  
__hash__ ( self )

  __init__  
__init__ ( self,  thing )

  __invert__  
__invert__ ( self )

  __or__  
__or__ ( self,  other )

do the obvious thing

  __repr__  
__repr__ ( self )

  detrivialize  
detrivialize ( self )

hook added to allow elimination of trivialities return None if completely true, or simpler form or self, if no simplification is possible.

  domain  
domain ( self )

  initargs  
initargs ( self )

  negated_constraints  
negated_constraints ( self )

the negated constraints of a NOT are the negated constraints of the thing negated.

  relbind  
relbind (
        self,
        dict,
        db,
        )

  uncache  
uncache ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BTor_pred.py.html0100600000176200017510000003121507306455603032033 0ustar dhellmanndevel Class: BTor_pred

Table of Contents

Class: BTor_pred Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Base Classes   
BTPredicate
Methods   
__and__
__call__
__cmp__
__hash__
__init__
__invert__
__or__
__repr__
detrivialize
domain
 initargs
negated_constraints
relbind
uncache
  __and__  
__and__ ( self,  other )

push "and" down

  __call__  
__call__ (
        self,
        boundtuples,
        toplevel=0,
        )

  __cmp__  
__cmp__ ( self,  other )

  __hash__  
__hash__ ( self )

  __init__  
__init__ (
        self,
        members,
        *othermembers,
        )

  __invert__  
__invert__ ( self )

translate to and-not

  __or__  
__or__ ( self,  other )

collapse two ors, otherwise just add new member

  __repr__  
__repr__ ( self )

  detrivialize  
detrivialize ( self )

hook added to allow elimination of trivialities return None if completely true, or simpler form or self, if no simplification is possible.

  domain  
domain ( self )

  initargs  
initargs ( self )

  negated_constraints  
negated_constraints ( self )

the negated constraints of an OR are the negated constraints of all members

  relbind  
relbind (
        self,
        dict,
        db,
        )

  uncache  
uncache ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BetweenPredicate.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BetweenPredicate.py.h0100600000176200017510000002162207306455603032651 0ustar dhellmanndevel Class: BetweenPredicate

Table of Contents

Class: BetweenPredicate Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

e1 BETWEEN e2 AND e3

Base Classes   
NontrivialEqPred
Methods   
__call__
__cmp__
__hash__
__init__
__repr__
domain
initargs
relbind
uncache
  __call__  
__call__ (
        self,
        assigns,
        toplevel=0,
        )

  __cmp__  
__cmp__ ( self,  other )

  __hash__  
__hash__ ( self )

  __init__  
__init__ (
        self,
        middle,
        lower,
        upper,
        )

  __repr__  
__repr__ ( self )

  domain  
domain ( self )

  initargs  
initargs ( self )

  relbind  
relbind (
        self,
        dict,
        db,
        )

  uncache  
uncache ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BoundAddition.py.html0100600000176200017510000000641707306455603032704 0ustar dhellmanndevel Class: BoundAddition

Table of Contents

Class: BoundAddition Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

promised addition.

Base Classes   
BoundExpression
Methods   
value
  value  
value ( self,  contexts )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BoundAttribute.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BoundAttribute.py.htm0100600000176200017510000002272507306455603032740 0ustar dhellmanndevel Class: BoundAttribute

Table of Contents

Class: BoundAttribute Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

bound attribute: initialize with relname=None if implicit.

Base Classes   
BoundExpression
Methods   
__init__
__repr__
attribute
domain
equate
initargs
relbind
uncache
value
  __init__  
__init__ (
        self,
        rel,
        name,
        )

  __repr__  
__repr__ ( self )

  attribute  
attribute ( self )

return (rename, attribute) for self.

  domain  
domain ( self )

  equate  
equate ( self,  other )

  initargs  
initargs ( self )

  relbind  
relbind (
        self,
        dict,
        db,
        )

Exceptions   
NameError, ` name ` + ": unknown or ambiguous"
  uncache  
uncache ( self )

  value  
value ( self,  contexts )

return value of self in context (bound tuple).

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BoundDivision.py.html0100600000176200017510000000641707306455603032735 0ustar dhellmanndevel Class: BoundDivision

Table of Contents

Class: BoundDivision Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

promised division.

Base Classes   
BoundExpression
Methods   
value
  value  
value ( self,  contexts )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BoundExpression.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BoundExpression.py.ht0100600000176200017510000003351207306455603032753 0ustar dhellmanndevel Class: BoundExpression

Table of Contents

Class: BoundExpression Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

superclass for all bound expressions. except where overloaded expressions are binary with self.left and self.right

Base Classes   
SimpleRecursive
Methods   
__add__
__coerce__
__div__
__init__
__mul__
__neg__
__repr__
__sub__
attribute
domain
 equate
initargs
le
lt
relbind
uncache
  __add__  
__add__ ( self,  other )

  __coerce__  
__coerce__ ( self,  other )

  __div__  
__div__ ( self,  other )

  __init__  
__init__ (
        self,
        left,
        right,
        )

  __mul__  
__mul__ ( self,  other )

  __neg__  
__neg__ ( self )

  __repr__  
__repr__ ( self )

  __sub__  
__sub__ ( self,  other )

  attribute  
attribute ( self )

  domain  
domain ( self )

  equate  
equate ( self,  other )

return predicate equating self and other. Overload for special cases, please!

eventually add converters...

  initargs  
initargs ( self )

  le  
le ( self,  other )

predicate self<=other

  lt  
lt ( self,  other )

predicate self<other

these should be overridden for 2 const case someday...

  relbind  
relbind (
        self,
        dict,
        db,
        )

  uncache  
uncache ( self )

prepare for execution, clear cached data.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BoundMinus.py.html0100600000176200017510000001666707306455603032254 0ustar dhellmanndevel Class: BoundMinus

Table of Contents

Class: BoundMinus Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Base Classes   
BoundExpression
SimpleRecursive
Methods   
__init__
__repr__
domain
initargs
relbind
uncache
value
  __init__  
__init__ ( self,  thing )

  __repr__  
__repr__ ( self )

  domain  
domain ( self )

  initargs  
initargs ( self )

  relbind  
relbind (
        self,
        dict,
        db,
        )

  uncache  
uncache ( self )

  value  
value ( self,  contexts )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BoundMultiplication.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BoundMultiplication.p0100600000176200017510000000644107306455603033007 0ustar dhellmanndevel Class: BoundMultiplication

Table of Contents

Class: BoundMultiplication Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

promised multiplication.

Base Classes   
BoundExpression
Methods   
value
  value  
value ( self,  contexts )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BoundSubtraction.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BoundSubtraction.py.h0100600000176200017510000000643007306455603032724 0ustar dhellmanndevel Class: BoundSubtraction

Table of Contents

Class: BoundSubtraction Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

promised subtraction.

Base Classes   
BoundExpression
Methods   
value
  value  
value ( self,  contexts )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_BoundTuple.py.html0100600000176200017510000003416407306455604032243 0ustar dhellmanndevel Class: BoundTuple

Table of Contents

Class: BoundTuple Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Methods   
__add__
__and__
__cmp__
__hash__
__init__
__repr__
close
demarshal
domain
equate
 initargs
marshaldata
relbind
relorder
share_eqs
  __add__  
__add__ ( self,  other )

combine self with other, return closure.

  __and__  
__and__ ( self,  other )

return closed constraints common to self and other.

  __cmp__  
__cmp__ ( self,  other )

  __hash__  
__hash__ ( self )

  __init__  
__init__ ( self,  **bindings )

bindings are name>simpletuple associations.

  __repr__  
__repr__ ( self )

  close  
close ( self )

infer equalities, if consistent. only recompute equality closure if not previously closed. return None on inconsistency.

  demarshal  
demarshal ( self,  args )

  domain  
domain ( self )

  equate  
equate ( self,  equalities )

add equalities to self, only if not closed. equalities should be seq of ( (name, att), (name, att) )

Exceptions   
ValueError, "cannot add equalities! Closed!"
  initargs  
initargs ( self )

  marshaldata  
marshaldata ( self )

  relbind  
relbind (
        self,
        dict,
        db,
        )

return bindings of self wrt dict rel>att

Exceptions   
NameError, ` b ` + ": ambiguous or unknown attribute"
NameError, ` d ` + ": ambiguous or unknown attribute"
  relorder  
relorder (
        self,
        db,
        allrels,
        )

based on known constraints, pick an ordering for materializing relations. db is database (ignored currently) allrels is names of all relations to include (list).

  share_eqs  
share_eqs ( self )

make clone of self that shares equalities, closure. note: will share future side effects to eqs too.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_Constant.py.html0100600000176200017510000003177407306455604031757 0ustar dhellmanndevel Class: Constant

Table of Contents

Class: Constant Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Base Classes   
BoundExpression
Methods   
__add__
__div__
__hash__
__init__
__mul__
__neg__
__repr__
__sub__
attribute
domain
 equate
initargs
relbind
uncache
value
  __add__  
__add__ ( self,  other )

  __div__  
__div__ ( self,  other )

  __hash__  
__hash__ ( self )

  __init__  
__init__ ( self,  value )

  __mul__  
__mul__ ( self,  other )

  __neg__  
__neg__ ( self )

  __repr__  
__repr__ ( self )

  __sub__  
__sub__ ( self,  other )

  attribute  
attribute ( self )

invent a pair to identify a constant

  domain  
domain ( self )

  equate  
equate ( self,  other )

  initargs  
initargs ( self )

  relbind  
relbind (
        self,
        dict,
        db,
        )

  uncache  
uncache ( self )

  value  
value ( self,  contexts )

return the constant value associated with self.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_Count.py.html0100600000176200017510000001564607306455604031256 0ustar dhellmanndevel Class: Count

Table of Contents

Class: Count Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Base Classes   
Average
Methods   
__init__
all_value
domain
op
relbind
uncache
  __init__  
__init__ (
        self,
        thing,
        distinct=0,
        )

  all_value  
all_value ( self,  contexts )

  domain  
domain ( self )

  op  
op ( self,  values )

  relbind  
relbind (
        self,
        dict,
        db,
        )

  uncache  
uncache ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_DescExpr.py.html0100600000176200017510000001444607306455604031700 0ustar dhellmanndevel Class: DescExpr

Table of Contents

Class: DescExpr Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

special wrapper used only for order by descending for things with no -thing operation (eg, strings)

stuff for order_by

Base Classes   
BoundMinus
Methods   
__init__
__repr__
orderbind
value
  __init__  
__init__ ( self,  thing )

  __repr__  
__repr__ ( self )

  orderbind  
orderbind ( self,  order )

order is list of (att, expr).

  value  
value ( self,  contexts )

Exceptions   
ValueError, "(%s, %s) cannot order desc" %( allnowrap, resulti )
ValueError, "(%s, %s) cannot order desc" %( allwrap, resulti )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_Except.py.html0100600000176200017510000000647107306455604031412 0ustar dhellmanndevel Class: Except

Table of Contents

Class: Except Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Base Classes   
Union
Methods   
eval
  eval  
eval (
        self,
        assns,
        dyn=None,
        outer=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_ExistsPred.py.html0100600000176200017510000002151207306455604032245 0ustar dhellmanndevel Class: ExistsPred

Table of Contents

Class: ExistsPred Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

EXISTS subquery.

Base Classes   
NontrivialEqPred
Methods   
__call__
__cmp__
__hash__
__init__
__repr__
domain
initargs
relbind
uncache
  __call__  
__call__ (
        self,
        assigns,
        toplevel=0,
        )

  __cmp__  
__cmp__ ( self,  other )

  __hash__  
__hash__ ( self )

  __init__  
__init__ ( self,  subq )

  __repr__  
__repr__ ( self )

  domain  
domain ( self )

  initargs  
initargs ( self )

  relbind  
relbind (
        self,
        dict,
        db,
        )

  uncache  
uncache ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_HashJoiner.py.html0100600000176200017510000001125407306455604032207 0ustar dhellmanndevel Class: HashJoiner

Table of Contents

Class: HashJoiner Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Methods   
__init__
join
relbind
uncache
  __init__  
__init__ (
        self,
        bt,
        relname,
        attributes,
        relation,
        witness,
        )

  join  
join ( self,  subseq )

  relbind  
relbind (
        self,
        db,
        atts,
        )

  uncache  
uncache ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_InLits.py.html0100600000176200017510000002347707306455604031371 0ustar dhellmanndevel Class: InLits

Table of Contents

Class: InLits Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

expr IN literals, support dynamic bindings.

Base Classes   
NontrivialEqPred
Methods   
__call__
__cmp__
__hash__
__init__
__repr__
compare
domain
initargs
relbind
uncache
  __call__  
__call__ (
        self,
        assigns,
        toplevel=0,
        )

  __cmp__  
__cmp__ ( self,  other )

  __hash__  
__hash__ ( self )

  __init__  
__init__ (
        self,
        expr,
        lits,
        )

  __repr__  
__repr__ ( self )

  compare  
compare (
        self,
        value,
        column,
        )

  domain  
domain ( self )

  initargs  
initargs ( self )

  relbind  
relbind (
        self,
        dict,
        db,
        )

  uncache  
uncache ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_Intersect.py.html0100600000176200017510000000776307306455604032127 0ustar dhellmanndevel Class: Intersect

Table of Contents

Class: Intersect Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Base Classes   
Union
Methods   
__repr__
eval
  __repr__  
__repr__ ( self )

  eval  
eval (
        self,
        assns,
        dyn=None,
        outer=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_LessEqPred.py.html0100600000176200017510000001022007306455604032154 0ustar dhellmanndevel Class: LessEqPred

Table of Contents

Class: LessEqPred Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Base Classes   
LessPred
Methods   
__call__
__inv__
  __call__  
__call__ (
        self,
        assigns,
        toplevel=0,
        )

  __inv__  
__inv__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_LessPred.py.html0100600000176200017510000001140007306455604031667 0ustar dhellmanndevel Class: LessPred

Table of Contents

Class: LessPred Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Base Classes   
NontrivialEqPred
Methods   
__call__
__hash__
__inv__
  __call__  
__call__ (
        self,
        assigns,
        toplevel=0,
        )

  __hash__  
__hash__ ( self )

  __inv__  
__inv__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_Maximum.py.html0100600000176200017510000000671307306455604031576 0ustar dhellmanndevel Class: Maximum

Table of Contents

Class: Maximum Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Base Classes   
Average
Methods   
op
  op  
op ( self,  values )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_Median.py.html0100600000176200017510000001015207306455604031346 0ustar dhellmanndevel Class: Median

Table of Contents

Class: Median Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Base Classes   
Average
Methods   
op
  op  
op ( self,  values )

Exceptions   
ValueError, "Median of empty set"

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_Minimum.py.html0100600000176200017510000000671307306455604031574 0ustar dhellmanndevel Class: Minimum

Table of Contents

Class: Minimum Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Base Classes   
Average
Methods   
op
  op  
op ( self,  values )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_NontrivialEqPred.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_NontrivialEqPred.py.h0100600000176200017510000003075307306455604032673 0ustar dhellmanndevel Class: NontrivialEqPred

Table of Contents

Class: NontrivialEqPred Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

equation of nontrivial expressions.

Base Classes   
BTPredicate
Methods   
__and__
__call__
__cmp__
__init__
__invert__
__or__
__repr__
detrivialize
domain
hash
 initargs
negated_constraints
relbind
uncache
  __and__  
__and__ ( self,  other )

  __call__  
__call__ (
        self,
        assigns,
        toplevel=0,
        )

  __cmp__  
__cmp__ ( self,  other )

  __init__  
__init__ (
        self,
        left,
        right,
        )

  __invert__  
__invert__ ( self )

  __or__  
__or__ ( self,  other )

  __repr__  
__repr__ ( self )

  detrivialize  
detrivialize ( self )

  domain  
domain ( self )

  hash  
hash ( self,  other )

  initargs  
initargs ( self )

  negated_constraints  
negated_constraints ( self )

  relbind  
relbind (
        self,
        dict,
        db,
        )

  uncache  
uncache ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_NumberedColumn.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_NumberedColumn.py.htm0100600000176200017510000001425107306455604032720 0ustar dhellmanndevel Class: NumberedColumn

Table of Contents

Class: NumberedColumn Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

order by column number

Base Classes   
BoundMinus
Methods   
__init__
__repr__
orderbind
relbind
  __init__  
__init__ ( self,  num )

  __repr__  
__repr__ ( self )

  orderbind  
orderbind ( self,  order )

  relbind  
relbind (
        self,
        dict,
        db,
        )

Exceptions   
ValueError, ` self.thing ` + ": not a numbered column"

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_OrderExpr.py.html0100600000176200017510000001141307306455604032064 0ustar dhellmanndevel Class: OrderExpr

Table of Contents

Class: OrderExpr Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

order by expression.

Base Classes   
BoundMinus
Methods   
__repr__
orderbind
  __repr__  
__repr__ ( self )

  orderbind  
orderbind ( self,  order )

Exceptions   
NameError, ` self ` + ": invalid ordering specification"

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_Parse_Context.py.html0100600000176200017510000000635107306455604032735 0ustar dhellmanndevel Class: Parse_Context

Table of Contents

Class: Parse_Context Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

contextual information for parsing p.param() returns a new sequence number for external parameter.

Methods   
ndynamic
param
  ndynamic  
ndynamic ( self )

  param  
param ( self )

no __init__ yet

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_QuantEQ.py.html0100600000176200017510000002477307306455604031505 0ustar dhellmanndevel Class: QuantEQ

Table of Contents

Class: QuantEQ Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Quantified equal any predicate

Base Classes   
NontrivialEqPred
Methods   
__call__
__cmp__
__hash__
__init__
__repr__
compare
domain
initargs
relbind
uncache
  __call__  
__call__ (
        self,
        assigns,
        toplevel=0,
        )

  __cmp__  
__cmp__ ( self,  other )

  __hash__  
__hash__ ( self )

  __init__  
__init__ (
        self,
        expr,
        subq,
        )

  __repr__  
__repr__ ( self )

  compare  
compare (
        self,
        value,
        column,
        )

  domain  
domain ( self )

  initargs  
initargs ( self )

  relbind  
relbind (
        self,
        dict,
        db,
        )

Exceptions   
ValueError, "Quantified predicate requires unit select list: %s" % atts
  uncache  
uncache ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_QuantGE.py.html0100600000176200017510000000701207306455604031456 0ustar dhellmanndevel Class: QuantGE

Table of Contents

Class: QuantGE Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Quantified greater equal any predicate

Base Classes   
QuantLT
Methods   
compare
  compare  
compare (
        self,
        value,
        column,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_QuantGT.py.html0100600000176200017510000000701107306455604031474 0ustar dhellmanndevel Class: QuantGT

Table of Contents

Class: QuantGT Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Quantified greater than any predicate

Base Classes   
QuantLT
Methods   
compare
  compare  
compare (
        self,
        value,
        column,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_QuantLE.py.html0100600000176200017510000000700707306455604031467 0ustar dhellmanndevel Class: QuantLE

Table of Contents

Class: QuantLE Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Quantified less equal any predicate

Base Classes   
QuantLT
Methods   
compare
  compare  
compare (
        self,
        value,
        column,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_QuantLT.py.html0100600000176200017510000001016707306455604031507 0ustar dhellmanndevel Class: QuantLT

Table of Contents

Class: QuantLT Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Quantified less than any predicate

Base Classes   
QuantEQ
Methods   
compare
uncache
  compare  
compare (
        self,
        value,
        column,
        )

  uncache  
uncache ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_QuantNE.py.html0100600000176200017510000000671007306455604031471 0ustar dhellmanndevel Class: QuantNE

Table of Contents

Class: QuantNE Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Quantified not equal any predicate

Base Classes   
QuantEQ
Methods   
compare
  compare  
compare (
        self,
        value,
        column,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_Selector.py.html0100600000176200017510000003302507306455604031735 0ustar dhellmanndevel Class: Selector

Table of Contents

Class: Selector Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

For implementing, eg the SQL SELECT statement.

Methods   
__init__
__repr__
attributes
check_domains
demarshal
eval
initargs
marshaldata
plan_query
relbind
 unbound
uncache
  __init__  
__init__ (
        self,
        alldistinct,
        select_list,
        table_reference_list,
        where_pred,
        group_list,
        having_cond,
        union_select=None,
        order_by_spec=None,
        ndynamic=0,
        )

Exceptions   
ValueError, "aggregate in WHERE"
  __repr__  
__repr__ ( self )

  attributes  
attributes ( self )

  check_domains  
check_domains ( self )

determine set of unbound names in self.

Exceptions   
IndexError, "outer %s, inner %s: union select lists lengths differ" %(len( myatts ), len( thoseatts ) )
NameError, "%s union names don't match" %( p, )
  demarshal  
demarshal ( self,  data )

  eval  
eval (
        self,
        dynamic=None,
        outerboundtuple=None,
        )

leaves a lot to be desired. dynamic and outerboundtuple are mutually exclusive. dynamic is only pertinent to top levels, outerboundtuple to subqueries

Exceptions   
KeyError, ` pair ` + ": unbound in selection"
ValueError, "only one dynamic subst for selection allowed"
  initargs  
initargs ( self )

  marshaldata  
marshaldata ( self )

  plan_query  
plan_query ( self )

generate a query plan (sequence of join operators).

  relbind  
relbind (
        self,
        db,
        outerbindings=None,
        )

  unbound  
unbound ( self )

Exceptions   
ValueError, "binding not available"
  uncache  
uncache ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_SimpleColumn.py.html0100600000176200017510000001525207306455604032566 0ustar dhellmanndevel Class: SimpleColumn

Table of Contents

Class: SimpleColumn Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

a simple column name for application to a list of tuples

Base Classes   
SimpleRecursive
Methods   
__init__
__repr__
initargs
orderbind
relbind
value
  __init__  
__init__ ( self,  name )

  __repr__  
__repr__ ( self )

  initargs  
initargs ( self )

  orderbind  
orderbind ( self,  whatever )

  relbind  
relbind (
        self,
        dict,
        db,
        )

  value  
value ( self,  simpletuples )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_SimpleRecursive.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_SimpleRecursive.py.ht0100600000176200017510000000637007306455604032750 0ustar dhellmanndevel Class: SimpleRecursive

Table of Contents

Class: SimpleRecursive Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Simple Recursive structure, only requires initargs

Methods   
demarshal
marshaldata
  demarshal  
demarshal ( self,  args )

  marshaldata  
marshaldata ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_SubQueryExpression.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_SubQueryExpression.py0100600000176200017510000002211207306455604033044 0ustar dhellmanndevel Class: SubQueryExpression

Table of Contents

Class: SubQueryExpression Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

sub query expression (subq), must eval to single column, single value

Base Classes   
BoundMinus
SimpleRecursive
Methods   
__init__
__repr__
domain
initargs
relbind
uncache
value
  __init__  
__init__ ( self,  subq )

  __repr__  
__repr__ ( self )

  domain  
domain ( self )

  initargs  
initargs ( self )

  relbind  
relbind (
        self,
        dict,
        db,
        )

Exceptions   
ValueError, "Quantified predicate requires unit select list: %s" % atts
  uncache  
uncache ( self )

  value  
value ( self,  contexts )

Exceptions   
ValueError, "const subquery expression must return 1 result: got %s" % lse
ValueError, "dynamic subquery expression must return 1 result: got %s" % lse

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_Sum.py.html0100600000176200017510000000670307306455604030724 0ustar dhellmanndevel Class: Sum

Table of Contents

Class: Sum Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Base Classes   
Average
Methods   
op
  op  
op ( self,  values )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_TupleCollector.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_TupleCollector.py.htm0100600000176200017510000002332507306455604032743 0ustar dhellmanndevel Class: TupleCollector

Table of Contents

Class: TupleCollector Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

Translate a sequence of assignments to simple tuples. (for implementing the select list of a SELECT).

Methods   
__init__
__repr__
addbinding
demarshal
domain
initargs
map
marshaldata
relbind
uncache
  __init__  
__init__ ( self )

  __repr__  
__repr__ ( self )

  addbinding  
addbinding (
        self,
        attribute,
        expression,
        )

bind att>expression.

  demarshal  
demarshal ( self,  args )

  domain  
domain ( self )

  initargs  
initargs ( self )

  map  
map ( self,  assnlist )

remap btlist by self. return (tuplelist, attorder)

  marshaldata  
marshaldata ( self )

  relbind  
relbind (
        self,
        dict,
        db,
        )

disambiguate missing rel names if possible. also choose output names appropriately.

Exceptions   
NameError, ` att ` + " ambiguous in select list"
  uncache  
uncache ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_Union.py.html0100600000176200017510000002012107306455604031236 0ustar dhellmanndevel Class: Union

Table of Contents

Class: Union Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

union clause.

Base Classes   
SimpleRecursive
Methods   
__init__
__repr__
attributes
check_domains
eval
initargs
relbind
unbound
  __init__  
__init__ (
        self,
        alldistinct,
        selection,
        )

  __repr__  
__repr__ ( self )

  attributes  
attributes ( self )

  check_domains  
check_domains ( self )

  eval  
eval (
        self,
        assns,
        dyn=None,
        outer=None,
        )

  initargs  
initargs ( self )

  relbind  
relbind (
        self,
        db,
        outer=None,
        )

  unbound  
unbound ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem_descOb.py.html0100600000176200017510000001264707306455605031364 0ustar dhellmanndevel Class: descOb

Table of Contents

Class: descOb Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlsem.py

special wrapper only used for sorting in descending order should only be compared with other descOb instances. should only wrap items that cannot be easily "order inverted", (eg, strings).

Methods   
__cmp__
__coerce__
__hash__
__init__
__repr__
  __cmp__  
__cmp__ ( self,  other )

  __coerce__  
__coerce__ ( self,  other )

  __hash__  
__hash__ ( self )

  __init__  
__init__ ( self,  ob )

  __repr__  
__repr__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlwhere.py.html0100600000176200017510000000257707306455605030434 0ustar dhellmanndevel Module: sqlwhere

Table of Contents

Module: sqlwhere Zope-2-CVS-src/lib/python/Products/ZGadflyDA/gadfly/sqlwhere.py

this module indicates where the sql datastructures are marshalled Auto generated on install: better not touch!

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/DA.py.html0100600000176200017510000001053007306455605025604 0ustar dhellmanndevel Module: DA

Table of Contents

Module: DA Zope-2-CVS-src/lib/python/Products/ZGadflyDA/DA.py

Imported modules   
import DABase
import Globals
import Shared.DC.ZRDB.Connection
import ThreadLock
from db import DB, manage_DataSources
import sys
Functions   
manage_addZGadflyConnection
  manage_addZGadflyConnection  
manage_addZGadflyConnection (
        self,
        id,
        title,
        connection,
        check=None,
        REQUEST=None,
        )

Add a DB connection to a folder

Classes   
Connection

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/DA_Connection.py.html0100600000176200017510000001373207306455605027772 0ustar dhellmanndevel Class: Connection

Table of Contents

Class: Connection Zope-2-CVS-src/lib/python/Products/ZGadflyDA/DA.py

Base Classes   
DABase.Connection
Methods   
connect
connected
title_and_id
title_or_id
  connect  
connect ( self,  s )

Exceptions   
'BadRequest', ('Invalid connection string: ' '%s
\n' '\n' %( s, t, v ) ), tb
  connected  
connected ( self )

  title_and_id  
title_and_id ( self )

  title_or_id  
title_or_id ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/DABase.py.html0100600000176200017510000000701507306455605026403 0ustar dhellmanndevel Module: DABase

Table of Contents

Module: DABase Zope-2-CVS-src/lib/python/Products/ZGadflyDA/DABase.py

Imported modules   
import Acquisition
from ExtensionClass import Base
from Globals import HTMLFile
import Shared.DC.ZRDB.Connection
from db import manage_DataSources
import sys
Classes   
Browser
ColumnBrowser
Connection
TableBrowser
TableBrowserCollection

Helper class for accessing tables via URLs

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/DABase_Browser.py.html0100600000176200017510000000746407306455605030116 0ustar dhellmanndevel Class: Browser

Table of Contents

Class: Browser Zope-2-CVS-src/lib/python/Products/ZGadflyDA/DABase.py

Base Classes   
Base
Methods   
__getattr__
  __getattr__  
__getattr__ ( self,  name )

Exceptions   
AttributeError, name

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/DABase_ColumnBrowser.py.html0100600000176200017510000001231507306455605031263 0ustar dhellmanndevel Class: ColumnBrowser

Table of Contents

Class: ColumnBrowser Zope-2-CVS-src/lib/python/Products/ZGadflyDA/DABase.py

Base Classes   
Browser
    Base
Methods   
Description
check
tpId
tpURL
  Description  
Description ( self )

  check  
check ( self )

  tpId  
tpId ( self )

  tpURL  
tpURL ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/DABase_Connection.py.html0100600000176200017510000001676207306455605030573 0ustar dhellmanndevel Class: Connection

Table of Contents

Class: Connection Zope-2-CVS-src/lib/python/Products/ZGadflyDA/DABase.py

Base Classes   
Shared.DC.ZRDB.Connection.Connection
Methods   
__getitem__
manage_insert
manage_join
manage_update
manage_wizard
tpValues
  __getitem__  
__getitem__ ( self,  name )

Exceptions   
KeyError, name
  manage_insert  
manage_insert (
        self,
        table,
        cols,
        REQUEST=None,
        )

Create an SQL insert

  manage_join  
manage_join (
        self,
        tables,
        select_cols,
        join_cols,
        REQUEST=None,
        )

Create an SQL join

  manage_update  
manage_update (
        self,
        table,
        keys,
        cols,
        REQUEST=None,
        )

Create an SQL update

  manage_wizard  
manage_wizard ( self,  tables )

  tpValues  
tpValues ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/DABase_TableBrowser.py.html0100600000176200017510000001654107306455605031062 0ustar dhellmanndevel Class: TableBrowser

Table of Contents

Class: TableBrowser Zope-2-CVS-src/lib/python/Products/ZGadflyDA/DABase.py

Base Classes   
Browser
    Base
Acquisition.Implicit
Methods   
Name
Type
manage_buildInput
tpId
tpURL
tpValues
  Name  
Name ( self )

  Type  
Type ( self )

  manage_buildInput  
manage_buildInput (
        self,
        id,
        source,
        default,
        REQUEST=None,
        )

Create a database method for an input form

Exceptions   
ValueError, ( 'no default was given for %s' % n )
  tpId  
tpId ( self )

  tpURL  
tpURL ( self )

  tpValues  
tpValues ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/DABase_TableBrowserCollection.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/DABase_TableBrowserCollection.py.ht0100600000176200017510000000373207306455605032543 0ustar dhellmanndevel Class: TableBrowserCollection

Table of Contents

Class: TableBrowserCollection Zope-2-CVS-src/lib/python/Products/ZGadflyDA/DABase.py

Helper class for accessing tables via URLs

Base Classes   
Acquisition.Implicit

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/__init__.py.html0100600000176200017510000001161107306455605027060 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/ZGadflyDA/__init__.py

Imported modules   
import Globals
import os
Functions   
getDA
manage_addZGadflyConnection
manage_addZGadflyConnectionForm
  getDA  
getDA ()

  manage_addZGadflyConnection  
manage_addZGadflyConnection (
        self,
        id,
        title,
        connection,
        check=None,
        REQUEST=None,
        )

  manage_addZGadflyConnectionForm  
manage_addZGadflyConnectionForm (
        self,
        REQUEST,
        *args,
        *kw,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/db.py.html0100600000176200017510000001234207306455605025710 0ustar dhellmanndevel Module: db

Table of Contents

Module: db Zope-2-CVS-src/lib/python/Products/ZGadflyDA/db.py

$Id: db.py,v 1.11 1999/09/16 15:12:45 jim Exp $

Imported modules   
from DateTime import DateTime
import Globals
import Shared.DC.ZRDB.THUNK
import gadfly
import os
from string import strip, split
Functions   
manage_DataSources
  manage_DataSources  
manage_DataSources ()

Exceptions   
'Gadfly Error', ( """ The Zope Gadfly Database Adapter requires the existence of the directory, %s. An error occurred while trying to create this directory. """ % data_dir )
'Gadfly Error', ( """ The Zope Gadfly Database Adapter requires the existence of the directory, %s. This exists, but is not a directory. """ % data_dir )
Classes   
DB

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/db_DB.py.html0100600000176200017510000002127507306455605026262 0ustar dhellmanndevel Class: DB

Table of Contents

Class: DB Zope-2-CVS-src/lib/python/Products/ZGadflyDA/db.py

Base Classes   
Shared.DC.ZRDB.THUNK.THUNKED_TM
Methods   
__init__
_abort
close
columns
open
query
tables
  __init__  
__init__ ( self,  connection )

  _abort  
_abort ( self )

Gadfly needs the extra checkpoint call.

  close  
close ( self )

  columns  
columns ( self,  table_name )

  open  
open ( self )

Exceptions   
self.database_error, 'invalid database error, ' + connection
  query  
query (
        self,
        query_string,
        max_rows=9999999,
        )

Exceptions   
'Query Error', 'empty query'
'Query Error', ( 'Multiple incompatible selects in ' 'multiple sql-statement query' )
  tables  
tables (
        self,
        *args,
        *kw,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZGadflyDA/README.txt.html0100600000176200017510000000332207306455605026445 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.ZGadflyDA

Table of Contents

Zope2 CVS with ZEO: Products.ZGadflyDA  

ZGadflyDA

The ZGadflyDA product provides support for Gadfly database adapter objects in the Zope environment.

Using Multiple Databases with ZGadflyDA

The ZGadflyDA is intended mainly for demonstration purposes.

It automatically creates a gadfly directory in your Zope var directory with a demo subdirectory, which provides a demo database.

To add or use additional databases, simply add (or link) additional directories to your var/gadfly directory.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:02 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZSQLMethods/0040700000176200017510000000000007306455606024356 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZSQLMethods/index.html0100600000176200017510000000517007306455606026355 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.ZSQLMethods

Table of Contents

Zope2 CVS with ZEO: Products.ZSQLMethods  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/ZSQLMethods/

CHANGES.txt.html

Aqueduct SQL Methods Changes

README.txt.html

ZSQLMethods

SQL
__init__

Zope-2-CVS-src/lib/python/Products/ZSQLMethods/help/

ZSQLMethod

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:21 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZSQLMethods/SQL.py.html0100600000176200017510000001261207306455605026332 0ustar dhellmanndevel Module: SQL

Table of Contents

Module: SQL Zope-2-CVS-src/lib/python/Products/ZSQLMethods/SQL.py

Imported modules   
import Globals
from Globals import DTMLFile
import Shared.DC.ZRDB.DA
from webdav.WriteLockInterface import WriteLockInterface
Functions   
SQLConnectionIDs
manage_addZSQLMethod
  SQLConnectionIDs  
SQLConnectionIDs ( self )

Find SQL database connections in the current folder and above

This function return a list of ids.

  manage_addZSQLMethod  
manage_addZSQLMethod (
        self,
        id,
        title,
        connection_id,
        arguments,
        template,
        REQUEST=None,
        submit=None,
        )

Add an SQL Method

The connection_id argument is the id of a database connection that resides in the current folder or in a folder above the current folder. The database should understand SQL.

The arguments argument is a string containing an arguments specification, as would be given in the SQL method cration form.

The template argument is a string containing the source for the SQL Template.

Classes   
SQL

SQL Database methods

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:21 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZSQLMethods/SQL_SQL.py.html0100600000176200017510000000640407306455605027053 0ustar dhellmanndevel Class: SQL

Table of Contents

Class: SQL Zope-2-CVS-src/lib/python/Products/ZSQLMethods/SQL.py

SQL Database methods

SQL Database methods are used to access external SQL databases.

They support three important abstractions:

  • Method

    SQL Methods behave like methods of the folders they are accessed in. In particular, they can be used from other methods, like Documents, ExternalMethods, and even other SQL Methods.

  • Searchability

    Database methods support the Searchable Object Interface. Search interface wizards can be used to build user interfaces to them. They can be used in joins and unions. They provide meta-data about their input parameters and result data.

    For more information, see the searchable-object interface specification.

  • Containment

    Database methods support URL traversal to access and invoke methods on individual record objects. For example, suppose you had an employees database method that took a single argument employee_id. Suppose that employees had a service_record method (defined in a record class or acquired from a folder). The service_record method could be accessed with a URL like:

               employees/employee_id/1234/service_record
Base Classes   
Shared.DC.ZRDB.DA.DA

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:21 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZSQLMethods/help/0040700000176200017510000000000007306455605025305 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZSQLMethods/help/ZSQLMethod.py.html0100600000176200017510000000762407306455605030564 0ustar dhellmanndevel Module: ZSQLMethod

Table of Contents

Module: ZSQLMethod Zope-2-CVS-src/lib/python/Products/ZSQLMethods/help/ZSQLMethod.py

Functions   
manage_addZSQLMethod
  manage_addZSQLMethod  
manage_addZSQLMethod (
        id,
        title,
        connection_id,
        arguments,
        template,
        )

Add an SQL Method to an ObjectManager.

The connection_id argument is the id of a database connection that resides in the current folder or in a folder above the current folder. The database should understand SQL.

The arguments argument is a string containing an arguments specification, as would be given in the SQL method cration form.

The template argument is a string containing the source for the SQL Template.

Classes   
ZSQLMethod

ZSQLMethods abstract SQL code in Zope.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:21 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZSQLMethods/help/ZSQLMethod_ZSQLMethod.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZSQLMethods/help/ZSQLMethod_ZSQLMethod.py.htm0100600000176200017510000001255107306455605032415 0ustar dhellmanndevel Class: ZSQLMethod

Table of Contents

Class: ZSQLMethod Zope-2-CVS-src/lib/python/Products/ZSQLMethods/help/ZSQLMethod.py

ZSQLMethods abstract SQL code in Zope.

SQL Methods behave like methods of the folders they are accessed in. In particular, they can be used from other methods, like Documents, ExternalMethods, and even other SQL Methods.

Database methods support the Searchable Object Interface. Search interface wizards can be used to build user interfaces to them. They can be used in joins and unions. They provide meta-data about their input parameters and result data.

For more information, see the searchable-object interface specification.

Database methods support URL traversal to access and invoke methods on individual record objects. For example, suppose you had an employees database method that took a single argument employee_id. Suppose that employees had a service_record method (defined in a record class or acquired from a folder). The service_record method could be accessed with a URL like:

       employees/employee_id/1234/service_record

Search results are returned as Record objects. The schema of a Record objects matches the schema of the table queried in the search.

Methods   
__call__
manage_edit
  __call__  
__call__ ( REQUEST=None,  **kw )

Call the ZSQLMethod.

The arguments to the method should be passed via keyword arguments, or in a single mapping object. If no arguments are given, and if the method was invoked through the Web, then the method will try to acquire and use the Web REQUEST object as the argument mapping.

The returned value is a sequence of record objects.

  manage_edit  
manage_edit (
        title,
        connection_id,
        arguments,
        template,
        )

Change database method properties.

The connection_id argument is the id of a database connection that resides in the current folder or in a folder above the current folder. The database should understand SQL.

The arguments argument is a string containing an arguments specification, as would be given in the SQL method creation form.

The template argument is a string containing the source for the SQL Template.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:21 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZSQLMethods/__init__.py.html0100600000176200017510000000671107306455605027435 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/ZSQLMethods/__init__.py

Imported modules   
import SQL
import Shared.DC.ZRDB.Aqueduct
import Shared.DC.ZRDB.RDB
import Shared.DC.ZRDB.Search
import Shared.DC.ZRDB.sqlgroup
import Shared.DC.ZRDB.sqltest
import Shared.DC.ZRDB.sqlvar
Functions   
initialize
  initialize  
initialize ( context )

This is the new way to initialize products. It is hoped that this more direct mechanism will be more understandable.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:21 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZSQLMethods/CHANGES.txt.html0100600000176200017510000001032307306455606027130 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.ZSQLMethods

Table of Contents

Zope2 CVS with ZEO: Products.ZSQLMethods  

Aqueduct SQL Methods Changes

AqueductSQLMethods 1.2.1

Bugs Fixed

  • The new Aqueduct.Results module was ommitted.

AqueductSQLMethods 1.2

Bugs Fixed

  • Source changes were lost when resizing the editing screen.

  • When testing, on DAs that use new DA protocol, non-select SQL is reported as such.

Features Added

  • Support for new Aqueduct DA protocol, providing much faster retrievals.

  • Edit screen size preferences are now distinct from Document size preferences.

AqueductSQLMethods 1.1.5

Features Added

  • Added permission settings to work with recent Principia versions.

Aqueduct SQL Methods 1.1.4

Bugs Fixed

  • Generated reports failed in cases where column names contained odd characters, as would be the case with::

              select salary*1.2 from payrole

Aqueduct SQL Methods 1.1.3

Bugs Fixed

  • Changed permission settings to be in line with principia 1.2

Aqueduct SQL Methods 1.1.2

Bugs Fixed

  • If strings contained backslashes but not backslash-t or backslash-n, then the backslashes were getting doubled.

Aqueduct SQL Methods 1.1.1

Bugs Fixed

  • The SQL string quoting done by the sqlvar and sqltest tags failed on non-ANSI-SQL databases like mySQL. Extra hooks were added to allow database adapters to provide custom quoting logic.

Aqueduct SQL Methods 1.1.0

Features

  • New DTML tags are available in SQLMethods that greatly improve the ease, safety, and flexibility of database methods.

  • SQL Templates are now rendered in the context of the containing folder, rather than the method itself.

  • Input arguments are shown in input forms in the order that they were defined, rather than in alphabetical order.

Aqueduct SQL Methods 1.0.5

Features Fixed

  • Database methods are slightly better about binding themselves to the correct object when acquired.

Aqueduct SQL Methods 1.0.4

Features Fixed

  • RDBMS transaction boundaries now coincide with Principia tranasaction boundaries. For example, if a Document runs 3 database methods and the third method raises an error, then the other methods are aborted.

Aqueduct SQL Methods 1.0.3

Bugs Fixed

  • Add permissions were not editable.

  • Methods on database records could not use acquired attributes.

AqueductSQLMethods 1.0.1

Bug Fixes

  • Error reporting was broken in test mode.

Features

  • Include generated SQL source in test output.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:21 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZSQLMethods/README.txt.html0100600000176200017510000000260307306455606027017 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.ZSQLMethods

Table of Contents

Zope2 CVS with ZEO: Products.ZSQLMethods  

ZSQLMethods

The ZSQLMethods product provides support for SQL Method objects which can be used in conjunction with any database adapter to use relational database data from within the Zope environment.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:21 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZopeTutorial/0040700000176200017510000000000007306455606024702 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZopeTutorial/index.html0100600000176200017510000000441307306455606026700 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.ZopeTutorial

Table of Contents

Zope2 CVS with ZEO: Products.ZopeTutorial  
Modules and Packages   

Zope-2-CVS-src/lib/python/Products/ZopeTutorial/

CHANGES.txt.html

Zope Tutorial 1.0a6

TutorialTopic
__init__

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZopeTutorial/TutorialTopic.py.html0100600000176200017510000001473007306455606031025 0ustar dhellmanndevel Module: TutorialTopic

Table of Contents

Module: TutorialTopic Zope-2-CVS-src/lib/python/Products/ZopeTutorial/TutorialTopic.py

Imported modules   
import DateTime
import DocumentTemplate
from Globals import HTML, DTMLFile, MessageDialog
from HelpSys.HelpTopic import TextTopic
import OFS.Folder
import StructuredText
import re
import string
Functions   
addTutorial
changeOwner
clean_pre
  addTutorial  
addTutorial (
        self,
        id,
        REQUEST=None,
        RESPONSE=None,
        )

Install tutorial examples.

Exceptions   
'Bad Request', 'The ZGadflyDA product must be installed!'
  changeOwner  
changeOwner ( obj,  owner )

Recursively changes the Owner of an object and all its subobjects.

  clean_pre  
clean_pre ( match )

Reformat a pre tag to get rid of extra indentation and extra blank lines.

Classes   
TutorialTopic

A Tutorial Help Topic

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZopeTutorial/TutorialTopic_TutorialTopic.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZopeTutorial/TutorialTopic_TutorialTopic.py.h0100600000176200017510000001267507306455606033200 0ustar dhellmanndevel Class: TutorialTopic

Table of Contents

Class: TutorialTopic Zope-2-CVS-src/lib/python/Products/ZopeTutorial/TutorialTopic.py

A Tutorial Help Topic

Base Classes   
TextTopic
Methods   
__init__
apiLink
lessonURL
tutorialShowLesson
  __init__  
__init__ (
        self,
        id,
        title,
        text,
        )

  apiLink  
apiLink (
        self,
        klass,
        REQUEST,
        )

Returns the URL to a API documentation for a given class.

  lessonURL  
lessonURL (
        self,
        id,
        REQUEST,
        )

URL of the examples for a lesson

  tutorialShowLesson  
tutorialShowLesson (
        self,
        id,
        REQUEST,
        )

Navigate management frame to a given lesson's screen.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZopeTutorial/__init__.py.html0100600000176200017510000001416707306455606027766 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/ZopeTutorial/__init__.py

Imported modules   
import App.Common
from DateTime import DateTime
from HelpSys import APIHelpTopic
import TutorialTopic
from cgi import escape
import os
import os.path
import re
import stat
import string
from urllib import quote_plus
Functions   
defineTerm
glossaryTerm
initialize
spacestrip
  defineTerm  
defineTerm ( match )

Define a glossary term

  glossaryTerm  
glossaryTerm ( match )

A linked glossary term

  initialize  
initialize ( context )

  spacestrip  
spacestrip ( txt )

dedent text by 2 spaces !

We need this to workaround a nasty bug in STXNG. STXNG creates empty <pre>..</pre> when then text start if a level > 1. This fix is lame. The problem should be fixed inside STXNG

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/ZopeTutorial/CHANGES.txt.html0100600000176200017510000000661707306455606027467 0ustar dhellmanndevel Zope2 CVS with ZEO: Products.ZopeTutorial

Table of Contents

Zope2 CVS with ZEO: Products.ZopeTutorial  

Zope Tutorial 1.0a6

Bug Fixes

  • Rearranged things a bit for 2.2 release.

  • Improved missing cookie behavior.

  • Improved descriptions of management screen navigation.

  • Many typos and nits fixed in lessons and examples.

Known Limitations

  • Requires Zope 2.1.6 or higher.

  • Works better with HTTP cookies.

Zope Tutorial 1.0a5

Features

  • Changed the way examples are installed. Now the examples are installed by adding a Zope object. This resolves a lot of security issues.

  • Added some preliminary API docs, and an API documentation infrastructure.

Bug Fixes

  • Miscellaneous restructuring and fixing.

Known Limitations

  • Requires Zope 2.1.6 or higher.

  • Requires HTTP cookies.

Zope Tutorial 1.0a4

Features

  • Added an introduction.

  • Improved installation location and verification.

Bug Fixes

  • More information about how to navigate between management screens.

  • Many typos fixed thanks to Karl Ulbrich.

Known Bugs

  • Requires Zope 2.1.6 or higher.

Zope Tutorial 1.0a3

Features

  • Glossary greatly improved and linked into lessons.

Bug Fixes

  • Install now correctly sets up gadfly database.

  • Some DTML typos fixed thanks to Didier Georgieff.

Known Bugs

  • Requires Zope 2.1.6 or higher.

Zope Tutorial 1.0a2

Features

  • Improved PRE formatting. Examples now look nice.

  • Improved examples navigation, no longer requires Javascript.

  • Added more information to the glossary.

  • Added feedback link.

Bug Fixes

  • Grammar and typo fixes.

Known Bugs

  • Requires Zope 2.1.6 or higher.

Zope Tutorial 1.0a1

Initial preview release.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:22 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Products/__init__.py.html0100600000176200017510000000243007306455606025313 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Products/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:45 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/0040700000176200017510000000000007306455613023746 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/index.html0100600000176200017510000000641307306455613025746 0ustar dhellmanndevel Zope2 CVS with ZEO: RestrictedPython

Table of Contents

Zope2 CVS with ZEO: RestrictedPython  
Modules and Packages   

Zope-2-CVS-src/lib/python/RestrictedPython/

Eval

Restricted Python Expressions

Limits
MutatingWalker
PrintCollector
RestrictionMutator

RestrictionMutator modifies a tree produced by

SafeMapping
Utilities
__init__

RestrictedPython package.

compiler

Package for parsing and compiling Python source code

tests

Python package.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/0040700000176200017510000000000007306455612025557 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/index.html0100600000176200017510000000555707306455612027567 0ustar dhellmanndevel Zope2 CVS with ZEO: RestrictedPython.compiler

Table of Contents

Zope2 CVS with ZEO: RestrictedPython.compiler  
Modules and Packages   

Zope-2-CVS-src/lib/python/RestrictedPython/compiler/

__init__

Package for parsing and compiling Python source code

ast

Python abstract syntax node definitions

consts
future

Parser for future statements

misc
pycodegen
transformer

Parse tree transformation module.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/__init__.py.html0100600000176200017510000000540307306455606030637 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/RestrictedPython/compiler/__init__.py

Package for parsing and compiling Python source code

There are several functions defined at the top level that are imported from modules contained in the package.

parse(buf) -> AST Converts a string containing Python source code to an abstract syntax tree (AST). The AST is defined in compiler.ast.

parseFile(path) -> AST The same as parse(open(path))

walk(ast, visitor, verbose=None) Does a pre-order walk over the ast using the visitor instance. See compiler.visitor for details.

compile(filename) Generates a .pyc file by compilining filename.

Imported modules   
from pycodegen import compile
from transformer import parse, parseFile
from visitor import walk

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py.html0100600000176200017510000003020407306455611027660 0ustar dhellmanndevel Module: ast

Table of Contents

Module: ast Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Python abstract syntax node definitions

This file is automatically generated.

Imported modules   
from consts import CO_VARARGS, CO_VARKEYWORDS
from types import TupleType, ListType
Functions   
asList
flatten
  asList  
asList ( nodes )

  flatten  
flatten ( list )

Classes   
Add
And
AssAttr
AssList
AssName
AssTuple
Assert
Assign
AugAssign
Backquote
Bitand
Bitor
Bitxor
Break
CallFunc
Class
Compare
Const
Continue
Dict
Discard
Div
Ellipsis
EmptyNode
Exec
For
From
Function
Getattr
Global
If
Import
Invert
Keyword
Lambda
LeftShift
List
ListComp
ListCompFor
ListCompIf
Mod
Module
Mul
Name
Node
Not
Or
Pass
Power
Print
Printnl
Raise
Return
RightShift
Slice
Sliceobj
Stmt
Sub
Subscript
TryExcept
TryFinally
Tuple
UnaryAdd
UnarySub
While

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Add.py.html0100600000176200017510000001104507306455606030436 0ustar dhellmanndevel Class: Add

Table of Contents

Class: Add Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  ( )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_And.py.html0100600000176200017510000001105107306455606030445 0ustar dhellmanndevel Class: And

Table of Contents

Class: And Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  nodes )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_AssAttr.py.html0100600000176200017510000001115107306455606031325 0ustar dhellmanndevel Class: AssAttr

Table of Contents

Class: AssAttr Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        expr,
        attrname,
        flags,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_AssList.py.html0100600000176200017510000001106107306455606031326 0ustar dhellmanndevel Class: AssList

Table of Contents

Class: AssList Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  nodes )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_AssName.py.html0100600000176200017510000001112707306455606031276 0ustar dhellmanndevel Class: AssName

Table of Contents

Class: AssName Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        name,
        flags,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_AssTuple.py.html0100600000176200017510000001106307306455606031506 0ustar dhellmanndevel Class: AssTuple

Table of Contents

Class: AssTuple Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  nodes )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Assert.py.html0100600000176200017510000001112407306455606031205 0ustar dhellmanndevel Class: Assert

Table of Contents

Class: Assert Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        test,
        fail,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Assign.py.html0100600000176200017510000001112507306455606031171 0ustar dhellmanndevel Class: Assign

Table of Contents

Class: Assign Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        nodes,
        expr,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_AugAssign.py.html0100600000176200017510000001114607306455606031631 0ustar dhellmanndevel Class: AugAssign

Table of Contents

Class: AugAssign Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        node,
        op,
        expr,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Backquote.py.html0100600000176200017510000001106407306455607031666 0ustar dhellmanndevel Class: Backquote

Table of Contents

Class: Backquote Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  expr )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Bitand.py.html0100600000176200017510000001105707306455607031153 0ustar dhellmanndevel Class: Bitand

Table of Contents

Class: Bitand Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  nodes )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Bitor.py.html0100600000176200017510000001105507306455607031027 0ustar dhellmanndevel Class: Bitor

Table of Contents

Class: Bitor Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  nodes )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Bitxor.py.html0100600000176200017510000001105707306455607031221 0ustar dhellmanndevel Class: Bitxor

Table of Contents

Class: Bitxor Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  nodes )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Break.py.html0100600000176200017510000001104507306455607030773 0ustar dhellmanndevel Class: Break

Table of Contents

Class: Break Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_CallFunc.py.html0100600000176200017510000001121107306455607031431 0ustar dhellmanndevel Class: CallFunc

Table of Contents

Class: CallFunc Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        node,
        args,
        star_args=None,
        dstar_args=None,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Class.py.html0100600000176200017510000001115607306455607031017 0ustar dhellmanndevel Class: Class

Table of Contents

Class: Class Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        name,
        bases,
        doc,
        code,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Compare.py.html0100600000176200017510000001112507306455607031334 0ustar dhellmanndevel Class: Compare

Table of Contents

Class: Compare Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        expr,
        ops,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Const.py.html0100600000176200017510000001105507306455607031036 0ustar dhellmanndevel Class: Const

Table of Contents

Class: Const Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  value )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Continue.py.html0100600000176200017510000001105307306455607031532 0ustar dhellmanndevel Class: Continue

Table of Contents

Class: Continue Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Dict.py.html0100600000176200017510000001105307306455607030631 0ustar dhellmanndevel Class: Dict

Table of Contents

Class: Dict Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  items )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Discard.py.html0100600000176200017510000001106007306455607031315 0ustar dhellmanndevel Class: Discard

Table of Contents

Class: Discard Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  expr )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Div.py.html0100600000176200017510000001104507306455607030471 0ustar dhellmanndevel Class: Div

Table of Contents

Class: Div Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  ( )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Ellipsis.py.html0100600000176200017510000001105307306455607031532 0ustar dhellmanndevel Class: Ellipsis

Table of Contents

Class: Ellipsis Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_EmptyNode.py.html0100600000176200017510000000626107306455607031657 0ustar dhellmanndevel Class: EmptyNode

Table of Contents

Class: EmptyNode Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
  __init__  
__init__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Exec.py.html0100600000176200017510000001114307306455607030632 0ustar dhellmanndevel Class: Exec

Table of Contents

Class: Exec Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        expr,
        locals,
        globals,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_For.py.html0100600000176200017510000001115507306455607030477 0ustar dhellmanndevel Class: For

Table of Contents

Class: For Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        assign,
        list,
        body,
        else_,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_From.py.html0100600000176200017510000001112407306455607030650 0ustar dhellmanndevel Class: From

Table of Contents

Class: From Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        modname,
        names,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Function.py.html0100600000176200017510000001123007306455607031530 0ustar dhellmanndevel Class: Function

Table of Contents

Class: Function Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        name,
        argnames,
        defaults,
        flags,
        doc,
        code,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Getattr.py.html0100600000176200017510000001113207306455607031356 0ustar dhellmanndevel Class: Getattr

Table of Contents

Class: Getattr Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        expr,
        attrname,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Global.py.html0100600000176200017510000001105707306455607031152 0ustar dhellmanndevel Class: Global

Table of Contents

Class: Global Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  names )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_If.py.html0100600000176200017510000001111607306455607030304 0ustar dhellmanndevel Class: If

Table of Contents

Class: If Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        tests,
        else_,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Import.py.html0100600000176200017510000001105707306455607031224 0ustar dhellmanndevel Class: Import

Table of Contents

Class: Import Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  names )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Invert.py.html0100600000176200017510000001105607306455607031220 0ustar dhellmanndevel Class: Invert

Table of Contents

Class: Invert Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  expr )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Keyword.py.html0100600000176200017510000001112607306455607031373 0ustar dhellmanndevel Class: Keyword

Table of Contents

Class: Keyword Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        name,
        expr,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Lambda.py.html0100600000176200017510000001117107306455607031127 0ustar dhellmanndevel Class: Lambda

Table of Contents

Class: Lambda Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        argnames,
        defaults,
        flags,
        code,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_LeftShift.py.html0100600000176200017510000001106107306455607031635 0ustar dhellmanndevel Class: LeftShift

Table of Contents

Class: LeftShift Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  ( )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_List.py.html0100600000176200017510000001105307306455607030661 0ustar dhellmanndevel Class: List

Table of Contents

Class: List Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  nodes )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_ListComp.py.html0100600000176200017510000001113107306455607031475 0ustar dhellmanndevel Class: ListComp

Table of Contents

Class: ListComp Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        expr,
        quals,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_ListCompFor.py.html0100600000176200017510000001115507306455607032152 0ustar dhellmanndevel Class: ListCompFor

Table of Contents

Class: ListCompFor Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        assign,
        list,
        ifs,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_ListCompIf.py.html0100600000176200017510000001106607306455610031755 0ustar dhellmanndevel Class: ListCompIf

Table of Contents

Class: ListCompIf Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  test )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Mod.py.html0100600000176200017510000001104507306455610030460 0ustar dhellmanndevel Class: Mod

Table of Contents

Class: Mod Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  ( )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Module.py.html0100600000176200017510000001112307306455610031163 0ustar dhellmanndevel Class: Module

Table of Contents

Class: Module Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        doc,
        node,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Mul.py.html0100600000176200017510000001104507306455610030476 0ustar dhellmanndevel Class: Mul

Table of Contents

Class: Mul Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  ( )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Name.py.html0100600000176200017510000001105207306455610030617 0ustar dhellmanndevel Class: Name

Table of Contents

Class: Name Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  name )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Node.py.html0100600000176200017510000000755007306455610030634 0ustar dhellmanndevel Class: Node

Table of Contents

Class: Node Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Methods   
asList
getChildren
getType
  asList  
asList ( self )

  getChildren  
getChildren ( self )

  getType  
getType ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Not.py.html0100600000176200017510000001105007306455610030475 0ustar dhellmanndevel Class: Not

Table of Contents

Class: Not Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  expr )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Or.py.html0100600000176200017510000001104707306455610030323 0ustar dhellmanndevel Class: Or

Table of Contents

Class: Or Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  nodes )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Pass.py.html0100600000176200017510000001104307306455610030645 0ustar dhellmanndevel Class: Pass

Table of Contents

Class: Pass Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Power.py.html0100600000176200017510000001105107306455610031032 0ustar dhellmanndevel Class: Power

Table of Contents

Class: Power Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  ( )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Print.py.html0100600000176200017510000001112307306455610031032 0ustar dhellmanndevel Class: Print

Table of Contents

Class: Print Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        nodes,
        dest,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Printnl.py.html0100600000176200017510000001112707306455610031370 0ustar dhellmanndevel Class: Printnl

Table of Contents

Class: Printnl Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        nodes,
        dest,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Raise.py.html0100600000176200017510000001114307306455610031003 0ustar dhellmanndevel Class: Raise

Table of Contents

Class: Raise Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        expr1,
        expr2,
        expr3,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Return.py.html0100600000176200017510000001105707306455610031223 0ustar dhellmanndevel Class: Return

Table of Contents

Class: Return Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  value )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_RightShift.py.html0100600000176200017510000001106307306455610032014 0ustar dhellmanndevel Class: RightShift

Table of Contents

Class: RightShift Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  ( )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Slice.py.html0100600000176200017510000001116107306455610030777 0ustar dhellmanndevel Class: Slice

Table of Contents

Class: Slice Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        expr,
        flags,
        lower,
        upper,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Sliceobj.py.html0100600000176200017510000001106307306455610031473 0ustar dhellmanndevel Class: Sliceobj

Table of Contents

Class: Sliceobj Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  nodes )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Stmt.py.html0100600000176200017510000001105307306455610030667 0ustar dhellmanndevel Class: Stmt

Table of Contents

Class: Stmt Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  nodes )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Sub.py.html0100600000176200017510000001104507306455610030472 0ustar dhellmanndevel Class: Sub

Table of Contents

Class: Sub Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  ( )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Subscript.py.html0100600000176200017510000001115107306455610031715 0ustar dhellmanndevel Class: Subscript

Table of Contents

Class: Subscript Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        expr,
        flags,
        subs,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_TryExcept.py.html0100600000176200017510000001115507306455610031672 0ustar dhellmanndevel Class: TryExcept

Table of Contents

Class: TryExcept Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        body,
        handlers,
        else_,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_TryFinally.py.html0100600000176200017510000001113507306455610032036 0ustar dhellmanndevel Class: TryFinally

Table of Contents

Class: TryFinally Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        body,
        final,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_Tuple.py.html0100600000176200017510000001105507306455610031033 0ustar dhellmanndevel Class: Tuple

Table of Contents

Class: Tuple Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  nodes )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_UnaryAdd.py.html0100600000176200017510000001106207306455610031447 0ustar dhellmanndevel Class: UnaryAdd

Table of Contents

Class: UnaryAdd Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  expr )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_UnarySub.py.html0100600000176200017510000001106207306455611031511 0ustar dhellmanndevel Class: UnarySub

Table of Contents

Class: UnarySub Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ ( self,  expr )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast_While.py.html0100600000176200017510000001114107306455611031007 0ustar dhellmanndevel Class: While

Table of Contents

Class: While Zope-2-CVS-src/lib/python/RestrictedPython/compiler/ast.py

Base Classes   
Node
Methods   
__init__
__repr__
_getChildren
  __init__  
__init__ (
        self,
        test,
        body,
        else_,
        )

  __repr__  
__repr__ ( self )

  _getChildren  
_getChildren ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/consts.py.html0100600000176200017510000000245107306455611030405 0ustar dhellmanndevel Module: consts

Table of Contents

Module: consts Zope-2-CVS-src/lib/python/RestrictedPython/compiler/consts.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/future.py.html0100600000176200017510000001150007306455611030401 0ustar dhellmanndevel Module: future

Table of Contents

Module: future Zope-2-CVS-src/lib/python/RestrictedPython/compiler/future.py

Parser for future statements

Imported modules   
import ast
from visitor import walk
Functions   
find_futures
is_future
  find_futures  
find_futures ( node )

  is_future  
is_future ( stmt )

Return true if statement is a well-formed future statement

Classes   
BadFutureParser

Check for invalid future statements

FutureParser

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/future_BadFutureParser.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/future_BadFutureParser.py.ht0100600000176200017510000000630707306455611033177 0ustar dhellmanndevel Class: BadFutureParser

Table of Contents

Class: BadFutureParser Zope-2-CVS-src/lib/python/RestrictedPython/compiler/future.py

Check for invalid future statements

Methods   
visitFrom
  visitFrom  
visitFrom ( self,  node )

Exceptions   
SyntaxError, "invalid future statement"

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/future_FutureParser.py.html0100600000176200017510000001245407306455611033121 0ustar dhellmanndevel Class: FutureParser

Table of Contents

Class: FutureParser Zope-2-CVS-src/lib/python/RestrictedPython/compiler/future.py

Methods   
__init__
check_stmt
get_features
visitModule
  __init__  
__init__ ( self )

  check_stmt  
check_stmt ( self,  stmt )

Exceptions   
SyntaxError, "future feature %s is not defined" % name
  get_features  
get_features ( self )

Return list of features enabled by future statements

  visitModule  
visitModule ( self,  node )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/misc.py.html0100600000176200017510000000773307306455611030037 0ustar dhellmanndevel Module: misc

Table of Contents

Module: misc Zope-2-CVS-src/lib/python/RestrictedPython/compiler/misc.py

Imported modules   
import types
Functions   
flatten
  flatten  
flatten ( tup )

Classes   
Set
Stack

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/misc_Set.py.html0100600000176200017510000001632607306455611030650 0ustar dhellmanndevel Class: Set

Table of Contents

Class: Set Zope-2-CVS-src/lib/python/RestrictedPython/compiler/misc.py

Methods   
__contains__
__init__
__len__
add
copy
elements
has_elt
remove
  __contains__  
__contains__ ( self,  elt )

  __init__  
__init__ ( self )

  __len__  
__len__ ( self )

  add  
add ( self,  elt )

  copy  
copy ( self )

  elements  
elements ( self )

  has_elt  
has_elt ( self,  elt )

  remove  
remove ( self,  elt )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/misc_Stack.py.html0100600000176200017510000001076307306455611031161 0ustar dhellmanndevel Class: Stack

Table of Contents

Class: Stack Zope-2-CVS-src/lib/python/RestrictedPython/compiler/misc.py

Methods   
__init__
__len__
push
top
  __init__  
__init__ ( self )

  __len__  
__len__ ( self )

  push  
push ( self,  elt )

  top  
top ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py.html0100600000176200017510000002534207306455612031056 0ustar dhellmanndevel Module: pycodegen

Table of Contents

Module: pycodegen Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Imported modules   
import ast
from cStringIO import StringIO
from consts import SC_LOCAL, SC_GLOBAL, SC_FREE, SC_CELL
import future
import imp
import marshal
import misc
import os
import pyassem
from pyassem import CO_VARARGS, CO_VARKEYWORDS, CO_NEWLOCALS, CO_NESTED, TupleArg
import stat
import string
import struct
import symbols
import sys
from transformer import parse
import types
from visitor import walk
Functions   
compile
findOp
generateArgList
wrap_aug
  compile  
compile ( filename,  display=0 )

  findOp  
findOp ( node )

Find the op (DELETE, LOAD, STORE) in an AssTuple tree

  generateArgList  
generateArgList ( arglist )

Generate an arg list marking TupleArgs

Exceptions   
ValueError, "unexpect argument type:", elt
  wrap_aug  
wrap_aug ( node )

Classes   
AbstractClassCode
AbstractFunctionCode
AugGetattr
AugName
AugSlice
AugSubscript
ClassCodeGenerator
CodeGenerator

Defines basic code generator for Python bytecode

Delegator

Base class to support delegation for augmented assignment nodes

FunctionCodeGenerator
LGBScopeMixin

Defines initClass() for Python 2.1-compatible scoping

LocalNameFinder

Find local names in scope

Module
ModuleCodeGenerator
NestedClassCodeGenerator
NestedFunctionCodeGenerator
NestedScopeCodeGenerator
NestedScopeMixin

Defines initClass() for nested scoping (Python 2.2-compatible)

NestedScopeModuleCodeGenerator
OpFinder

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_AbstractClassCode.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_AbstractClassCode.0100600000176200017510000000775207306455611033152 0ustar dhellmanndevel Class: AbstractClassCode

Table of Contents

Class: AbstractClassCode Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Methods   
__init__
_nameOp
finish
  __init__  
__init__ (
        self,
        klass,
        filename,
        scopes,
        )

  _nameOp  
_nameOp (
        self,
        prefix,
        name,
        )

  finish  
finish ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015600000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_AbstractFunctionCode.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_AbstractFunctionCo0100600000176200017510000001134307306455611033272 0ustar dhellmanndevel Class: AbstractFunctionCode

Table of Contents

Class: AbstractFunctionCode Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Methods   
__init__
finish
generateArgUnpack
unpackSequence
  __init__  
__init__ (
        self,
        func,
        filename,
        scopes,
        isLambda,
        )

  finish  
finish ( self )

  generateArgUnpack  
generateArgUnpack ( self,  args )

  unpackSequence  
unpackSequence ( self,  tup )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_AugGetattr.py.html0100600000176200017510000000375107306455611033204 0ustar dhellmanndevel Class: AugGetattr

Table of Contents

Class: AugGetattr Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Base Classes   
Delegator

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_AugName.py.html0100600000176200017510000000374307306455611032453 0ustar dhellmanndevel Class: AugName

Table of Contents

Class: AugName Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Base Classes   
Delegator

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_AugSlice.py.html0100600000176200017510000000374507306455611032634 0ustar dhellmanndevel Class: AugSlice

Table of Contents

Class: AugSlice Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Base Classes   
Delegator

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_AugSubscript.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_AugSubscript.py.ht0100600000176200017510000000375507306455611033223 0ustar dhellmanndevel Class: AugSubscript

Table of Contents

Class: AugSubscript Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Base Classes   
Delegator

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_ClassCodeGenerator.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_ClassCodeGenerator0100600000176200017510000000421107306455611033242 0ustar dhellmanndevel Class: ClassCodeGenerator

Table of Contents

Class: ClassCodeGenerator Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Base Classes   
LGBScopeMixin
AbstractClassCode
CodeGenerator

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_CodeGenerator.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_CodeGenerator.py.h0100600000176200017510000020361307306455611033140 0ustar dhellmanndevel Class: CodeGenerator

Table of Contents

Class: CodeGenerator Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Defines basic code generator for Python bytecode

This class is an abstract base class. Concrete subclasses must define an __init__() that defines self.graph and then calls the __init__() defined in this class.

The concrete class must also define the class attributes NameFinder, FunctionGen, and ClassGen. These attributes can be defined in the initClass() method, which is a hook for initializing these methods after all the classes have been defined.

Methods   
__init__
_implicitNameOp
_nameOp
_resolveDots
_setupGraphDelegation
_visitAssSequence
_visitFuncOrLambda
binaryOp
bitOp
checkClass
delName
fixDocstring
getCode
initClass
isLocalName
loadName
set_lineno
storeName
unaryOp
visitAdd
visitAnd
visitAssAttr
visitAssName
visitAssert
visitAssign
visitAugAssign
visitAugGetattr
visitAugName
 visitAugSlice
visitAugSubscript
visitBackquote
visitBitand
visitBitor
visitBitxor
visitBreak
visitCallFunc
visitClass
visitCompare
visitConst
visitContinue
visitDict
visitDiscard
visitDiv
visitEllipsis
visitExec
visitFor
visitFrom
visitFunction
visitGetattr
visitGlobal
visitIf
visitImport
visitInvert
visitKeyword
visitLambda
visitLeftShift
 visitList
visitListComp
visitListCompFor
visitListCompIf
visitMod
visitModule
visitMul
visitName
visitNot
visitOr
visitPass
visitPower
visitPrint
visitPrintnl
visitRaise
visitReturn
visitRightShift
visitSlice
visitSliceobj
visitSub
visitSubscript
visitTest
visitTryExcept
visitTryFinally
visitTuple
visitUnaryAdd
visitUnaryInvert
visitUnarySub
  __init__  
__init__ ( self,  filename )

  _implicitNameOp  
_implicitNameOp (
        self,
        prefix,
        name,
        )

Emit name ops for names generated implicitly by for loops

The interpreter generates names that start with a period or dollar sign. The symbol table ignores these names because they aren't present in the program text.

  _nameOp  
_nameOp (
        self,
        prefix,
        name,
        )

  _resolveDots  
_resolveDots ( self,  name )

  _setupGraphDelegation  
_setupGraphDelegation ( self )

  _visitAssSequence  
_visitAssSequence (
        self,
        node,
        op='UNPACK_SEQUENCE',
        )

  _visitFuncOrLambda  
_visitFuncOrLambda (
        self,
        node,
        isLambda=0,
        )

  binaryOp  
binaryOp (
        self,
        node,
        op,
        )

  bitOp  
bitOp (
        self,
        nodes,
        op,
        )

  checkClass  
checkClass ( self )

Verify that class is constructed correctly

Exceptions   
AssertionError, intro
  delName  
delName ( self,  name )

  fixDocstring  
fixDocstring ( self,  node )

Rewrite the ast for a class with a docstring.

The AST includes a Discard(Const(docstring)) node. Replace this with an Assign([AssName(__doc__, ...])

  getCode  
getCode ( self )

Return a code object

  initClass  
initClass ( self )

This method is called once for each class

  isLocalName  
isLocalName ( self,  name )

  loadName  
loadName ( self,  name )

  set_lineno  
set_lineno (
        self,
        node,
        force=0,
        )

Emit SET_LINENO if node has lineno attribute and it is different than the last lineno emitted.

Returns true if SET_LINENO was emitted.

There are no rules for when an AST node should have a lineno attribute. The transformer and AST code need to be reviewed and a consistent policy implemented and documented. Until then, this method works around missing line numbers.

  storeName  
storeName ( self,  name )

  unaryOp  
unaryOp (
        self,
        node,
        op,
        )

  visitAdd  
visitAdd ( self,  node )

  visitAnd  
visitAnd ( self,  node )

  visitAssAttr  
visitAssAttr ( self,  node )

  visitAssName  
visitAssName ( self,  node )

  visitAssert  
visitAssert ( self,  node )

  visitAssign  
visitAssign ( self,  node )

  visitAugAssign  
visitAugAssign ( self,  node )

  visitAugGetattr  
visitAugGetattr (
        self,
        node,
        mode,
        )

  visitAugName  
visitAugName (
        self,
        node,
        mode,
        )

  visitAugSlice  
visitAugSlice (
        self,
        node,
        mode,
        )

  visitAugSubscript  
visitAugSubscript (
        self,
        node,
        mode,
        )

Exceptions   
SyntaxError, "augmented assignment to tuple is not possible"
  visitBackquote  
visitBackquote ( self,  node )

  visitBitand  
visitBitand ( self,  node )

  visitBitor  
visitBitor ( self,  node )

  visitBitxor  
visitBitxor ( self,  node )

  visitBreak  
visitBreak ( self,  node )

Exceptions   
SyntaxError, "'break' outside loop (%s, %d)" %( self.filename, node.lineno )
  visitCallFunc  
visitCallFunc ( self,  node )

  visitClass  
visitClass ( self,  node )

  visitCompare  
visitCompare ( self,  node )

  visitConst  
visitConst ( self,  node )

  visitContinue  
visitContinue ( self,  node )

Exceptions   
SyntaxError, "'continue' outside loop (%s, %d)" %( self.filename, node.lineno )
  visitDict  
visitDict ( self,  node )

  visitDiscard  
visitDiscard ( self,  node )

  visitDiv  
visitDiv ( self,  node )

  visitEllipsis  
visitEllipsis ( self,  node )

  visitExec  
visitExec ( self,  node )

  visitFor  
visitFor ( self,  node )

  visitFrom  
visitFrom ( self,  node )

  visitFunction  
visitFunction ( self,  node )

  visitGetattr  
visitGetattr ( self,  node )

  visitGlobal  
visitGlobal ( self,  node )

  visitIf  
visitIf ( self,  node )

  visitImport  
visitImport ( self,  node )

  visitInvert  
visitInvert ( self,  node )

  visitKeyword  
visitKeyword ( self,  node )

  visitLambda  
visitLambda ( self,  node )

  visitLeftShift  
visitLeftShift ( self,  node )

  visitList  
visitList ( self,  node )

  visitListComp  
visitListComp ( self,  node )

  visitListCompFor  
visitListCompFor ( self,  node )

  visitListCompIf  
visitListCompIf (
        self,
        node,
        branch,
        )

  visitMod  
visitMod ( self,  node )

  visitModule  
visitModule ( self,  node )

  visitMul  
visitMul ( self,  node )

  visitName  
visitName ( self,  node )

  visitNot  
visitNot ( self,  node )

  visitOr  
visitOr ( self,  node )

  visitPass  
visitPass ( self,  node )

  visitPower  
visitPower ( self,  node )

  visitPrint  
visitPrint ( self,  node )

  visitPrintnl  
visitPrintnl ( self,  node )

  visitRaise  
visitRaise ( self,  node )

  visitReturn  
visitReturn ( self,  node )

  visitRightShift  
visitRightShift ( self,  node )

  visitSlice  
visitSlice (
        self,
        node,
        aug_flag=None,
        )

  visitSliceobj  
visitSliceobj ( self,  node )

  visitSub  
visitSub ( self,  node )

  visitSubscript  
visitSubscript (
        self,
        node,
        aug_flag=None,
        )

  visitTest  
visitTest (
        self,
        node,
        jump,
        )

  visitTryExcept  
visitTryExcept ( self,  node )

  visitTryFinally  
visitTryFinally ( self,  node )

  visitTuple  
visitTuple ( self,  node )

  visitUnaryAdd  
visitUnaryAdd ( self,  node )

  visitUnaryInvert  
visitUnaryInvert ( self,  node )

  visitUnarySub  
visitUnarySub ( self,  node )

  visitWhile  
visitWhile ( self,  node )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_Delegator.py.html0100600000176200017510000000731207306455611033040 0ustar dhellmanndevel Class: Delegator

Table of Contents

Class: Delegator Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Base class to support delegation for augmented assignment nodes

To generator code for augmented assignments, we use the following wrapper classes. In visitAugAssign, the left-hand expression node is visited twice. The first time the visit uses the normal method for that node . The second time the visit uses a different method that generates the appropriate code to perform the assignment. These delegator classes wrap the original AST nodes in order to support the variant visit methods.

Methods   
__getattr__
__init__
  __getattr__  
__getattr__ ( self,  attr )

  __init__  
__init__ ( self,  obj )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015700000000000011570 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_FunctionCodeGenerator.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_FunctionCodeGenera0100600000176200017510000000422507306455611033242 0ustar dhellmanndevel Class: FunctionCodeGenerator

Table of Contents

Class: FunctionCodeGenerator Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Base Classes   
LGBScopeMixin
AbstractFunctionCode
CodeGenerator

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_LGBScopeMixin.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_LGBScopeMixin.py.h0100600000176200017510000000505207306455611033017 0ustar dhellmanndevel Class: LGBScopeMixin

Table of Contents

Class: LGBScopeMixin Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Defines initClass() for Python 2.1-compatible scoping

Methods   
initClass
  initClass  
initClass ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_LocalNameFinder.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_LocalNameFinder.py0100600000176200017510000002176407306455611033161 0ustar dhellmanndevel Class: LocalNameFinder

Table of Contents

Class: LocalNameFinder Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Find local names in scope

Methods   
__init__
getLocals
visitAssName
visitClass
visitDict
visitFrom
visitFunction
visitGlobal
visitImport
visitLambda
  __init__  
__init__ ( self,  names=() )

  getLocals  
getLocals ( self )

  visitAssName  
visitAssName ( self,  node )

  visitClass  
visitClass ( self,  node )

  visitDict  
visitDict ( self,  node )

  visitFrom  
visitFrom ( self,  node )

  visitFunction  
visitFunction ( self,  node )

  visitGlobal  
visitGlobal ( self,  node )

  visitImport  
visitImport ( self,  node )

  visitLambda  
visitLambda ( self,  node )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_Module.py.html0100600000176200017510000001114407306455611032355 0ustar dhellmanndevel Class: Module

Table of Contents

Class: Module Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Methods   
__init__
compile
dump
getPycHeader
  __init__  
__init__ (
        self,
        source,
        filename,
        )

  compile  
compile ( self,  display=0 )

  dump  
dump ( self,  f )

  getPycHeader  
getPycHeader ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_ModuleCodeGenerator.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_ModuleCodeGenerato0100600000176200017510000000645607306455611033255 0ustar dhellmanndevel Class: ModuleCodeGenerator

Table of Contents

Class: ModuleCodeGenerator Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Base Classes   
LGBScopeMixin
CodeGenerator
Methods   
__init__
  __init__  
__init__ ( self,  filename )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016200000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_NestedClassCodeGenerator.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_NestedClassCodeGen0100600000176200017510000000704007306455611033173 0ustar dhellmanndevel Class: NestedClassCodeGenerator

Table of Contents

Class: NestedClassCodeGenerator Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Base Classes   
AbstractClassCode
NestedScopeMixin
NestedScopeCodeGenerator
Methods   
__init__
  __init__  
__init__ (
        self,
        klass,
        filename,
        scopes,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016500000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_NestedFunctionCodeGenerator.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_NestedFunctionCode0100600000176200017510000000707507306455611033271 0ustar dhellmanndevel Class: NestedFunctionCodeGenerator

Table of Contents

Class: NestedFunctionCodeGenerator Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Base Classes   
AbstractFunctionCode
NestedScopeMixin
NestedScopeCodeGenerator
Methods   
__init__
  __init__  
__init__ (
        self,
        func,
        filename,
        scopes,
        isLambda,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016200000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_NestedScopeCodeGenerator.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_NestedScopeCodeGen0100600000176200017510000001551707306455612033210 0ustar dhellmanndevel Class: NestedScopeCodeGenerator

Table of Contents

Class: NestedScopeCodeGenerator Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Base Classes   
CodeGenerator
Methods   
_nameOp
_visitFuncOrLambda
parseSymbols
visitClass
visitModule
  _nameOp  
_nameOp (
        self,
        prefix,
        name,
        )

Exceptions   
RuntimeError, "unsupported scope for var %s: %d" %( name, scope )
  _visitFuncOrLambda  
_visitFuncOrLambda (
        self,
        node,
        isLambda=0,
        )

  parseSymbols  
parseSymbols ( self,  tree )

  visitClass  
visitClass ( self,  node )

  visitModule  
visitModule ( self,  node )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_NestedScopeMixin.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_NestedScopeMixin.p0100600000176200017510000000507107306455612033220 0ustar dhellmanndevel Class: NestedScopeMixin

Table of Contents

Class: NestedScopeMixin Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Defines initClass() for nested scoping (Python 2.2-compatible)

Methods   
initClass
  initClass  
initClass ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017000000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_NestedScopeModuleCodeGenerator.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_NestedScopeModuleC0100600000176200017510000000665507306455612033237 0ustar dhellmanndevel Class: NestedScopeModuleCodeGenerator

Table of Contents

Class: NestedScopeModuleCodeGenerator Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Base Classes   
NestedScopeMixin
NestedScopeCodeGenerator
Methods   
__init__
  __init__  
__init__ ( self,  filename )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen_OpFinder.py.html0100600000176200017510000000757407306455612032653 0ustar dhellmanndevel Class: OpFinder

Table of Contents

Class: OpFinder Zope-2-CVS-src/lib/python/RestrictedPython/compiler/pycodegen.py

Methods   
__init__
visitAssName
  __init__  
__init__ ( self )

  visitAssName  
visitAssName ( self,  node )

Exceptions   
ValueError, "mixed ops in stmt"

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/transformer.py.html0100600000176200017510000002025607306455612031442 0ustar dhellmanndevel Module: transformer

Table of Contents

Module: transformer Zope-2-CVS-src/lib/python/RestrictedPython/compiler/transformer.py

Parse tree transformation module.

Transforms Python source code into an abstract syntax tree (AST) defined in the ast module.

The simplest ways to invoke this module are via parse and parseFile. parse(buf) -> AST parseFile(path) -> AST

Imported modules   
from ast import *
from consts import CO_VARARGS, CO_VARKEYWORDS, OP_ASSIGN, OP_DELETE, OP_APPLY
import parser
import string
import symbol
import sys
import token
import types
Functions   
Node
asList
debug_tree
parse
parseFile
  Node  
Node ( *args )

Exceptions   
error, "Can't find appropriate Node type: %s" % str( args )
  asList  
asList ( nodes )

  debug_tree  
debug_tree ( tree )

  parse  
parse ( buf )

  parseFile  
parseFile ( path )

Classes   
Transformer

Utility object for transforming Python parse trees.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/transformer_Transformer.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/compiler/transformer_Transformer.py.h0100600000176200017510000024007007306455612033305 0ustar dhellmanndevel Class: Transformer

Table of Contents

Class: Transformer Zope-2-CVS-src/lib/python/RestrictedPython/compiler/transformer.py

Utility object for transforming Python parse trees.

Exposes the following methods: tree = transform(ast_tree) tree = parsesuite(text) tree = parseexpr(text) tree = parsefile(fileob | filename)

Methods   
__init__
and_expr
and_test
argument
arith_expr
assert_stmt
atom
atom_backquote
atom_lbrace
atom_lpar
atom_lsqb
atom_name
atom_number
atom_string
break_stmt
classdef
com_NEWLINE
com_append_stmt
com_apply_trailer
com_arglist
com_argument
com_assign
com_assign_attr
com_assign_list
com_assign_name
com_assign_trailer
com_assign_tuple
com_augassign
com_augassign_op
com_bases
com_binary
 com_call_function
com_dictmaker
com_dotted_as_name
com_dotted_name
com_fpdef
com_fplist
com_import_as_name
com_node
com_select_member
com_slice
com_sliceobj
com_stmt
com_subscript
com_subscriptlist
com_try_except
com_try_finally
comp_op
comparison
compile_node
continue_stmt
del_stmt
dotted_name
eval_input
exec_stmt
expr
expr_stmt
factor
file_input
for_stmt
fpdef
fplist
 funcdef
get_docstring
global_stmt
if_stmt
import_stmt
lambdef
not_test
parameters
parseexpr
parsefile
parsesuite
pass_stmt
power
print_stmt
raise_stmt
return_stmt
shift_expr
simple_stmt
single_input
sliceop
stmt
suite
term
test
testlist
trailer
transform
try_stmt
varargslist
while_stmt
xor_expr
  __init__  
__init__ ( self )

  and_expr  
and_expr ( self,  nodelist )

  and_test  
and_test ( self,  nodelist )

  argument  
argument ( self,  nodelist )

Exceptions   
error
  arith_expr  
arith_expr ( self,  nodelist )

  assert_stmt  
assert_stmt ( self,  nodelist )

  atom  
atom ( self,  nodelist )

  atom_backquote  
atom_backquote ( self,  nodelist )

  atom_lbrace  
atom_lbrace ( self,  nodelist )

  atom_lpar  
atom_lpar ( self,  nodelist )

  atom_lsqb  
atom_lsqb ( self,  nodelist )

  atom_name  
atom_name ( self,  nodelist )

  atom_number  
atom_number ( self,  nodelist )

  atom_string  
atom_string ( self,  nodelist )

  break_stmt  
break_stmt ( self,  nodelist )

  classdef  
classdef ( self,  nodelist )

classdef: class NAME ['(' testlist ')'] : suite

  com_NEWLINE  
com_NEWLINE ( self,  *args )

  com_append_stmt  
com_append_stmt (
        self,
        stmts,
        node,
        )

  com_apply_trailer  
com_apply_trailer (
        self,
        primaryNode,
        nodelist,
        )

Exceptions   
SyntaxError, 'unknown node type: %s' % t
  com_arglist  
com_arglist ( self,  nodelist )

  com_argument  
com_argument (
        self,
        nodelist,
        kw,
        )

Exceptions   
SyntaxError, "keyword can't be an expression (%s)" % n [ 0 ]
SyntaxError, "non-keyword arg after keyword arg"
  com_assign  
com_assign (
        self,
        node,
        assigning,
        )

Exceptions   
SyntaxError, "bad assignment"
SyntaxError, "can't assign to ()"
SyntaxError, "can't assign to []"
SyntaxError, "can't assign to literal"
SyntaxError, "can't assign to operator"
  com_assign_attr  
com_assign_attr (
        self,
        primary,
        node,
        assigning,
        )

  com_assign_list  
com_assign_list (
        self,
        node,
        assigning,
        )

  com_assign_name  
com_assign_name (
        self,
        node,
        assigning,
        )

  com_assign_trailer  
com_assign_trailer (
        self,
        primary,
        node,
        assigning,
        )

Exceptions   
SyntaxError, "can't assign to function call"
SyntaxError, "unknown trailer type: %s" % t
  com_assign_tuple  
com_assign_tuple (
        self,
        node,
        assigning,
        )

  com_augassign  
com_augassign ( self,  node )

Return node suitable for lvalue of augmented assignment

Names, slices, and attributes are the only allowable nodes.

Exceptions   
SyntaxError, "can't assign to %s" % l.__class__.__name__
  com_augassign_op  
com_augassign_op ( self,  node )

  com_bases  
com_bases ( self,  node )

  com_binary  
com_binary (
        self,
        constructor,
        nodelist,
        )

Compile NODE (OP NODE)* into (type, [ node1, ..., nodeN ]).

  com_call_function  
com_call_function (
        self,
        primaryNode,
        nodelist,
        )

Exceptions   
SyntaxError, 'already have the kwargs indentifier'
SyntaxError, 'already have the varargs indentifier'
SyntaxError, 'unknown node type: %s' % tok
  com_dictmaker  
com_dictmaker ( self,  nodelist )

  com_dotted_as_name  
com_dotted_as_name ( self,  node )

  com_dotted_name  
com_dotted_name ( self,  node )

  com_fpdef  
com_fpdef ( self,  node )

  com_fplist  
com_fplist ( self,  node )

  com_import_as_name  
com_import_as_name ( self,  node )

  com_node  
com_node ( self,  node )

  com_select_member  
com_select_member (
        self,
        primaryNode,
        nodelist,
        )

Exceptions   
SyntaxError, "member must be a name"
  com_slice  
com_slice (
        self,
        primary,
        node,
        assigning,
        )

  com_sliceobj  
com_sliceobj ( self,  node )

proper_slice: short_slice | long_slice short_slice: [lower_bound] ":" [upper_bound] long_slice: short_slice ":" [stride] lower_bound: expression upper_bound: expression stride: expression

Note: a stride may be further slicing...

  com_stmt  
com_stmt ( self,  node )

  com_subscript  
com_subscript ( self,  node )

  com_subscriptlist  
com_subscriptlist (
        self,
        primary,
        nodelist,
        assigning,
        )

slicing: simple_slicing | extended_slicing simple_slicing: primary "[" short_slice "]" extended_slicing: primary "[" slice_list "]" slice_list: slice_item ("," slice_item)* [","]

  com_try_except  
com_try_except ( self,  nodelist )

  com_try_finally  
com_try_finally ( self,  nodelist )

  comp_op  
comp_op ( self,  nodelist )

Exceptions   
error
  comparison  
comparison ( self,  nodelist )

  compile_node  
compile_node ( self,  node )

Exceptions   
error, ( 'unexpected node type', n )
  continue_stmt  
continue_stmt ( self,  nodelist )

  del_stmt  
del_stmt ( self,  nodelist )

  dotted_name  
dotted_name ( self,  nodelist )

Exceptions   
error
  eval_input  
eval_input ( self,  nodelist )

  exec_stmt  
exec_stmt ( self,  nodelist )

  expr  
expr ( self,  nodelist )

  expr_stmt  
expr_stmt ( self,  nodelist )

  factor  
factor ( self,  nodelist )

  file_input  
file_input ( self,  nodelist )

  for_stmt  
for_stmt ( self,  nodelist )

for exprlist in exprlist : suite ['else' : suite]

  fpdef  
fpdef ( self,  nodelist )

Exceptions   
error
  fplist  
fplist ( self,  nodelist )

Exceptions   
error
  funcdef  
funcdef ( self,  nodelist )

funcdef: def NAME parameters : suite parameters: ( [varargslist] )

  get_docstring  
get_docstring (
        self,
        node,
        n=None,
        )

  global_stmt  
global_stmt ( self,  nodelist )

  if_stmt  
if_stmt ( self,  nodelist )

  import_stmt  
import_stmt ( self,  nodelist )

  lambdef  
lambdef ( self,  nodelist )

  not_test  
not_test ( self,  nodelist )

  parameters  
parameters ( self,  nodelist )

Exceptions   
error
  parseexpr  
parseexpr ( self,  text )

Return a modified parse tree for the given expression text.

  parsefile  
parsefile ( self,  file )

Return a modified parse tree for the contents of the given file.

  parsesuite  
parsesuite ( self,  text )

Return a modified parse tree for the given suite text.

  pass_stmt  
pass_stmt ( self,  nodelist )

  power  
power ( self,  nodelist )

  print_stmt  
print_stmt ( self,  nodelist )

  raise_stmt  
raise_stmt ( self,  nodelist )

  return_stmt  
return_stmt ( self,  nodelist )

  shift_expr  
shift_expr ( self,  nodelist )

  simple_stmt  
simple_stmt ( self,  nodelist )

  single_input  
single_input ( self,  node )

do we want to do anything about being "interactive" ?

  sliceop  
sliceop ( self,  nodelist )

Exceptions   
error
  stmt  
stmt ( self,  nodelist )

  suite  
suite ( self,  nodelist )

  term  
term ( self,  nodelist )

  test  
test ( self,  nodelist )

  testlist  
testlist ( self,  nodelist )

  trailer  
trailer ( self,  nodelist )

Exceptions   
error
  transform  
transform ( self,  tree )

Transform an AST into a modified parse tree.

  try_stmt  
try_stmt ( self,  nodelist )

  varargslist  
varargslist ( self,  nodelist )

Exceptions   
error
  while_stmt  
while_stmt ( self,  nodelist )

while test : suite ['else' : suite]

  xor_expr  
xor_expr ( self,  nodelist )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/tests/0040700000176200017510000000000007306455612025107 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/tests/index.html0100600000176200017510000000422507306455612027106 0ustar dhellmanndevel Zope2 CVS with ZEO: RestrictedPython.tests

Table of Contents

Zope2 CVS with ZEO: RestrictedPython.tests  
Modules and Packages   

Zope-2-CVS-src/lib/python/RestrictedPython/tests/

__init__

Python package.

security_in_syntax

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/tests/__init__.py.html0100600000176200017510000000242307306455612030163 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/RestrictedPython/tests/__init__.py

Python package.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/tests/security_in_syntax.py.html0100600000176200017510000002045507306455612032374 0ustar dhellmanndevel Module: security_in_syntax

Table of Contents

Module: security_in_syntax Zope-2-CVS-src/lib/python/RestrictedPython/tests/security_in_syntax.py

Functions   
bad_attr
bad_name
no_exec
overrideGuardWithArgument
overrideGuardWithClass
overrideGuardWithFunction
overrideGuardWithLambda
overrideGuardWithName
reserved_names
  bad_attr  
bad_attr ()

  bad_name  
bad_name ()

  no_exec  
no_exec ()

  overrideGuardWithArgument  
overrideGuardWithArgument ()

  overrideGuardWithClass  
overrideGuardWithClass ()

  overrideGuardWithFunction  
overrideGuardWithFunction ()

  overrideGuardWithLambda  
overrideGuardWithLambda ()

  overrideGuardWithName  
overrideGuardWithName ()

  reserved_names  
reserved_names ()

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/Eval.py.html0100600000176200017510000001012107306455612026143 0ustar dhellmanndevel Module: Eval

Table of Contents

Module: Eval Zope-2-CVS-src/lib/python/RestrictedPython/Eval.py

Restricted Python Expressions

Imported modules   
import string
from string import translate, strip
Functions   
default_read_guard
  default_read_guard  
default_read_guard ( ob )

Classes   
RestrictionCapableEval

A base class for restricted code.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/Eval_RestrictionCapableEval.py.html0100600000176200017510000001413407306455612032620 0ustar dhellmanndevel Class: RestrictionCapableEval

Table of Contents

Class: RestrictionCapableEval Zope-2-CVS-src/lib/python/RestrictedPython/Eval.py

A base class for restricted code.

Methods   
__call__
__init__
eval
prepRestrictedCode
prepUnrestrictedCode
  __call__  
__call__ ( self,  **kw )

  __init__  
__init__ ( self,  expr )

Create a restricted expression

where:

expr

a string containing the expression to be evaluated.

  eval  
eval ( self,  mapping )

  prepRestrictedCode  
prepRestrictedCode ( self )

Exceptions   
SyntaxError, err [ 0 ]
  prepUnrestrictedCode  
prepUnrestrictedCode ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/Limits.py.html0100600000176200017510000001401107306455613026520 0ustar dhellmanndevel Module: Limits

Table of Contents

Module: Limits Zope-2-CVS-src/lib/python/RestrictedPython/Limits.py

Functions   
limited_list
limited_range
limited_tuple
  limited_list  
limited_list ( seq )

Exceptions   
TypeError, 'cannot convert string to list'
  limited_range  
limited_range ( iFirst,  *args )

Exceptions   
AttributeError, 'range() requires 1-3 int arguments'
ValueError, 'range() too large'
ValueError, 'zero step for range()'
  limited_tuple  
limited_tuple ( seq )

Exceptions   
TypeError, 'cannot convert string to tuple'

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/MutatingWalker.py.html0100600000176200017510000000753507306455613030232 0ustar dhellmanndevel Module: MutatingWalker

Table of Contents

Module: MutatingWalker Zope-2-CVS-src/lib/python/RestrictedPython/MutatingWalker.py

Imported modules   
from compiler import ast
Functions   
walk
  walk  
walk ( tree,  visitor )

Classes   
MutatingWalker

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/MutatingWalker_MutatingWalker.py.html0100600000176200017510000001270607306455613033244 0ustar dhellmanndevel Class: MutatingWalker

Table of Contents

Class: MutatingWalker Zope-2-CVS-src/lib/python/RestrictedPython/MutatingWalker.py

Methods   
__init__
defaultVisitNode
dispatchNode
dispatchObject
visitSequence
  __init__  
__init__ ( self,  visitor )

  defaultVisitNode  
defaultVisitNode (
        self,
        node,
        walker=None,
        )

  dispatchNode  
dispatchNode ( self,  node )

  dispatchObject  
dispatchObject ( self,  ob )

Expected to return either ob or something that will take its place.

  visitSequence  
visitSequence ( self,  seq )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/PrintCollector.py.html0100600000176200017510000000412307306455613030225 0ustar dhellmanndevel Module: PrintCollector

Table of Contents

Module: PrintCollector Zope-2-CVS-src/lib/python/RestrictedPython/PrintCollector.py

Classes   
PrintCollector

Collect written text, and return it when called.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/PrintCollector_PrintCollector.py.html0100600000176200017510000000757007306455613033261 0ustar dhellmanndevel Class: PrintCollector

Table of Contents

Class: PrintCollector Zope-2-CVS-src/lib/python/RestrictedPython/PrintCollector.py

Collect written text, and return it when called.

Methods   
__call__
__init__
write
  __call__  
__call__ ( self )

  __init__  
__init__ ( self )

  write  
write ( self,  text )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/RestrictionMutator.py.html0100600000176200017510000001362107306455613031146 0ustar dhellmanndevel Module: RestrictionMutator

Table of Contents

Module: RestrictionMutator Zope-2-CVS-src/lib/python/RestrictedPython/RestrictionMutator.py

RestrictionMutator modifies a tree produced by compiler.transformer.Transformer, restricting and enhancing the code in various ways before sending it to pycodegen.

Imported modules   
from compiler import ast
from compiler.consts import OP_ASSIGN, OP_DELETE, OP_APPLY
from compiler.transformer import parse
Functions   
exprNode
rmLineno
stmtNode
  exprNode  
exprNode ( txt )

Make a "clean" expression node

  rmLineno  
rmLineno ( node )

Strip lineno attributes from a code tree

These utility functions allow us to generate AST subtrees without line number attributes. These trees can then be inserted into other trees without affecting line numbers shown in tracebacks, etc.

  stmtNode  
stmtNode ( txt )

Make a "clean" statement node

Classes   
FuncInfo

Keep track of which restrictions have been applied in a given scope.

RestrictionMutator

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/RestrictionMutator_FuncInfo.py.html0100600000176200017510000000250407306455613032733 0ustar dhellmanndevel Class: FuncInfo

Table of Contents

Class: FuncInfo Zope-2-CVS-src/lib/python/RestrictedPython/RestrictionMutator.py

Keep track of which restrictions have been applied in a given scope.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/RestrictionMutator_RestrictionMutator.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/RestrictionMutator_RestrictionMutator0100600000176200017510000003466107306455613033524 0ustar dhellmanndevel Class: RestrictionMutator

Table of Contents

Class: RestrictionMutator Zope-2-CVS-src/lib/python/RestrictedPython/RestrictionMutator.py

Methods   
__init__
checkAttrName
checkName
error
prepBody
visitAssAttr
visitAssName
visitAugAssign
visitClass
visitExec
 visitFunction
visitGetattr
visitLambda
visitModule
visitName
visitPrint
visitSubscript
  __init__  
__init__ ( self )

  checkAttrName  
checkAttrName ( self,  node )

  checkName  
checkName (
        self,
        node,
        name,
        )

  error  
error (
        self,
        node,
        info,
        )

  prepBody  
prepBody ( self,  body )

  visitAssAttr  
visitAssAttr (
        self,
        node,
        walker,
        )

  visitAssName  
visitAssName (
        self,
        node,
        walker,
        )

  visitAugAssign  
visitAugAssign (
        self,
        node,
        walker,
        )

  visitClass  
visitClass (
        self,
        node,
        walker,
        )

  visitExec  
visitExec (
        self,
        node,
        walker,
        )

  visitFunction  
visitFunction (
        self,
        node,
        walker,
        )

  visitGetattr  
visitGetattr (
        self,
        node,
        walker,
        )

  visitLambda  
visitLambda (
        self,
        node,
        walker,
        )

  visitModule  
visitModule (
        self,
        node,
        walker,
        )

  visitName  
visitName (
        self,
        node,
        walker,
        )

  visitPrint  
visitPrint (
        self,
        node,
        walker,
        )

  visitSubscript  
visitSubscript (
        self,
        node,
        walker,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/SafeMapping.py.html0100600000176200017510000000530607306455613027460 0ustar dhellmanndevel Module: SafeMapping

Table of Contents

Module: SafeMapping Zope-2-CVS-src/lib/python/RestrictedPython/SafeMapping.py

Imported modules   
from MultiMapping import MultiMapping
Classes   
SafeMapping

Mapping with security declarations and limited method exposure.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/SafeMapping_SafeMapping.py.html0100600000176200017510000001137107306455613031731 0ustar dhellmanndevel Class: SafeMapping

Table of Contents

Class: SafeMapping Zope-2-CVS-src/lib/python/RestrictedPython/SafeMapping.py

Mapping with security declarations and limited method exposure.

Since it subclasses MultiMapping, this class can be used to wrap one or more mapping objects. Restricted Python code will not be able to mutate the SafeMapping or the wrapped mappings, but will be able to read any value.

Base Classes   
MultiMapping
Methods   
_pop
_push
has_get
  _pop  
_pop ( self,  *args )

  _push  
_push ( self,  ob )

  has_get  
has_get ( self,  key )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/Utilities.py.html0100600000176200017510000001161507306455613027241 0ustar dhellmanndevel Module: Utilities

Table of Contents

Module: Utilities Zope-2-CVS-src/lib/python/RestrictedPython/Utilities.py

Imported modules   
import DocumentTemplate.sequence
import math
import random
import string
import whrandom
Functions   
reorder
same_type
test
  reorder  
reorder (
        s,
        with=None,
        without=(),
        )

  same_type  
same_type ( arg1,  *args )

Compares the class or type of two or more objects.

  test  
test ( *args )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/RestrictedPython/__init__.py.html0100600000176200017510000000424707306455613027030 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/RestrictedPython/__init__.py

RestrictedPython package. $Id: __init__.py,v 1.2 2001/04/27 20:27:51 shane Exp $

Imported modules   
from Compilers import compile_restricted, compile_restricted_function, compile_restricted_exec, compile_restricted_eval
from PrintCollector import PrintCollector

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:23 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/0040700000176200017510000000000007306455614022632 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/index.html0100600000176200017510000000670207306455614024633 0ustar dhellmanndevel Zope2 CVS with ZEO: SearchIndex

Table of Contents

Zope2 CVS with ZEO: SearchIndex  
Modules and Packages   

Zope-2-CVS-src/lib/python/SearchIndex/

GlobbingLexicon
Index

Simple column indices

Lexicon
PluggableIndex

Pluggable Index Base Class

ResultList
TextIndex

Text Index

UnIndex

Simple column indices

UnKeywordIndex
UnTextIndex

Text Index

__init__
randid
tests

Zope2 CVS with ZEO: SearchIndex.tests

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/tests/0040700000176200017510000000000007306455613023773 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/tests/index.html0100600000176200017510000000476107306455613025777 0ustar dhellmanndevel Zope2 CVS with ZEO: SearchIndex.tests

Table of Contents

Zope2 CVS with ZEO: SearchIndex.tests  
Modules and Packages   

Zope-2-CVS-src/lib/python/SearchIndex/tests/

__init__
testSplitter
testUnKeywordIndex
testUnTextIndex
test_UnIndex

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/tests/__init__.py.html0100600000176200017510000000244707306455613027055 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/SearchIndex/tests/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/tests/testSplitter.py.html0100600000176200017510000001371107306455613030020 0ustar dhellmanndevel Module: testSplitter

Table of Contents

Module: testSplitter Zope-2-CVS-src/lib/python/SearchIndex/tests/testSplitter.py

Imported modules   
from SearchIndex.Splitter import Splitter
import sys
import unittest
Functions   
debug
main
pdebug
test_suite
  debug  
debug ()

  main  
main ()

  pdebug  
pdebug ()

  test_suite  
test_suite ()

Classes   
TestSplitter

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/tests/testSplitter_TestSplitter.py.html0100600000176200017510000001265007306455613032547 0ustar dhellmanndevel Class: TestSplitter

Table of Contents

Class: TestSplitter Zope-2-CVS-src/lib/python/SearchIndex/tests/testSplitter.py

Base Classes   
unittest.TestCase
Methods   
testDropNumeric
testDropSingleLetterWords
testSplitNormalText
testSplitOnNonAlpha
  testDropNumeric  
testDropNumeric ( self )

  testDropSingleLetterWords  
testDropSingleLetterWords ( self )

  testSplitNormalText  
testSplitNormalText ( self )

  testSplitOnNonAlpha  
testSplitOnNonAlpha ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/tests/testUnKeywordIndex.py.html0100600000176200017510000001434007306455613031130 0ustar dhellmanndevel Module: testUnKeywordIndex

Table of Contents

Module: testUnKeywordIndex Zope-2-CVS-src/lib/python/SearchIndex/tests/testUnKeywordIndex.py

Imported modules   
from SearchIndex.UnKeywordIndex import UnKeywordIndex
import ZODB
import os
import sys
Functions   
debug
main
pdebug
test_suite
  debug  
debug ()

  main  
main ()

  pdebug  
pdebug ()

  test_suite  
test_suite ()

Classes   
Dummy
TestCase

Test KeywordIndex objects.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/tests/testUnKeywordIndex_Dummy.py.html0100600000176200017510000000753107306455613032307 0ustar dhellmanndevel Class: Dummy

Table of Contents

Class: Dummy Zope-2-CVS-src/lib/python/SearchIndex/tests/testUnKeywordIndex.py

Methods   
__init__
__str__
foo
  __init__  
__init__ ( self,  foo )

  __str__  
__str__ ( self )

  foo  
foo ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/tests/testUnKeywordIndex_TestCase.py.html0100600000176200017510000002335007306455613032724 0ustar dhellmanndevel Class: TestCase

Table of Contents

Class: TestCase Zope-2-CVS-src/lib/python/SearchIndex/tests/testUnKeywordIndex.py

Test KeywordIndex objects.

Base Classes   
unittest.TestCase
Methods   
_checkApply
_populateIndex
setUp
tearDown
testAddObjectWOKeywords
testEmpty
testPopulated
testReindexChange
testReindexNoChange
testZero
  _checkApply  
_checkApply (
        self,
        req,
        expectedValues,
        )

  _populateIndex  
_populateIndex ( self )

  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

  testAddObjectWOKeywords  
testAddObjectWOKeywords ( self )

  testEmpty  
testEmpty ( self )

  testPopulated  
testPopulated ( self )

  testReindexChange  
testReindexChange ( self )

  testReindexNoChange  
testReindexNoChange ( self )

  testZero  
testZero ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/tests/testUnTextIndex.py.html0100600000176200017510000001604607306455613030435 0ustar dhellmanndevel Module: testUnTextIndex

Table of Contents

Module: testUnTextIndex Zope-2-CVS-src/lib/python/SearchIndex/tests/testUnTextIndex.py

Imported modules   
import SearchIndex.GlobbingLexicon
import SearchIndex.UnTextIndex
import ZODB
import ZODB.DemoStorage
import ZODB.FileStorage
import os
import sys
import zLOG
Functions   
debug
log_write
main
pdebug
test_suite
  debug  
debug ()

  log_write  
log_write (
        subsystem,
        severity,
        summary,
        detail,
        error,
        )

  main  
main ()

  pdebug  
pdebug ()

  test_suite  
test_suite ()

Classes   
Dummy
Tests

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/tests/testUnTextIndex_Dummy.py.html0100600000176200017510000000501507306455613031602 0ustar dhellmanndevel Class: Dummy

Table of Contents

Class: Dummy Zope-2-CVS-src/lib/python/SearchIndex/tests/testUnTextIndex.py

Methods   
__init__
  __init__  
__init__ ( self,  **kw )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/tests/testUnTextIndex_Tests.py.html0100600000176200017510000003411107306455613031610 0ustar dhellmanndevel Class: Tests

Table of Contents

Class: Tests Zope-2-CVS-src/lib/python/SearchIndex/tests/testUnTextIndex.py

Base Classes   
unittest.TestCase
Methods   
checkAndNotQuery
checkAndQuery
checkGlobQuery
checkNearQuery
checkNonExistentWord
checkOrQuery
checkParenMatchingQuery
checkPersistentUpdate1
checkPersistentUpdate2
checkQuoteMatchingQuery
 checkSimpleAddDelete
checkTextIndexOperatorQuery
dbclose
dbopen
setUp
tearDown
  checkAndNotQuery  
checkAndNotQuery ( self )

Check an ANDNOT query

  checkAndQuery  
checkAndQuery ( self )

Check an AND query

  checkGlobQuery  
checkGlobQuery ( self )

Check a glob query

  checkNearQuery  
checkNearQuery ( self )

Check a NEAR query.. (NOTE:ACTUALLY AN OR TEST!!)

  checkNonExistentWord  
checkNonExistentWord ( self )

Check for nonexistent word

  checkOrQuery  
checkOrQuery ( self )

Check an OR query

  checkParenMatchingQuery  
checkParenMatchingQuery ( self )

Check a query with parens

  checkPersistentUpdate1  
checkPersistentUpdate1 ( self )

Check simple persistent indexing

  checkPersistentUpdate2  
checkPersistentUpdate2 ( self )

Check less simple persistent indexing

  checkQuoteMatchingQuery  
checkQuoteMatchingQuery ( self )

Check a query with quotes.. this is known to fail under 2.3.1b3-

  checkSimpleAddDelete  
checkSimpleAddDelete ( self )

Check that we can add and delete an object without error

  checkTextIndexOperatorQuery  
checkTextIndexOperatorQuery ( self )

Check a query with textindex_operator in the request

  dbclose  
dbclose ( self )

  dbopen  
dbopen ( self )

  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/tests/test_UnIndex.py.html0100600000176200017510000001416507306455613027727 0ustar dhellmanndevel Module: test_UnIndex

Table of Contents

Module: test_UnIndex Zope-2-CVS-src/lib/python/SearchIndex/tests/test_UnIndex.py

Imported modules   
from SearchIndex.UnIndex import UnIndex
import ZODB
import sys
import unittest
Functions   
debug
main
pdebug
test_suite
  debug  
debug ()

  main  
main ()

  pdebug  
pdebug ()

  test_suite  
test_suite ()

Classes   
Dummy
TestCase

Test FieldIndex objects.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/tests/test_UnIndex_Dummy.py.html0100600000176200017510000000752307306455613031102 0ustar dhellmanndevel Class: Dummy

Table of Contents

Class: Dummy Zope-2-CVS-src/lib/python/SearchIndex/tests/test_UnIndex.py

Methods   
__init__
__str__
foo
  __init__  
__init__ ( self,  foo )

  __str__  
__str__ ( self )

  foo  
foo ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/tests/test_UnIndex_TestCase.py.html0100600000176200017510000002112707306455613031516 0ustar dhellmanndevel Class: TestCase

Table of Contents

Class: TestCase Zope-2-CVS-src/lib/python/SearchIndex/tests/test_UnIndex.py

Test FieldIndex objects.

Base Classes   
unittest.TestCase
Methods   
_checkApply
_populateIndex
setUp
tearDown
testEmpty
testNone
testPopulated
testRange
testZero
  _checkApply  
_checkApply (
        self,
        req,
        expectedValues,
        )

  _populateIndex  
_populateIndex ( self )

  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

  testEmpty  
testEmpty ( self )

Test an empty FieldIndex.

  testNone  
testNone ( self )

make sure None gets indexed

  testPopulated  
testPopulated ( self )

Test a populated FieldIndex

  testRange  
testRange ( self )

Test a range search

  testZero  
testZero ( self )

Make sure 0 gets indexed

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/GlobbingLexicon.py.html0100600000176200017510000000665707306455613027230 0ustar dhellmanndevel Module: GlobbingLexicon

Table of Contents

Module: GlobbingLexicon Zope-2-CVS-src/lib/python/SearchIndex/GlobbingLexicon.py

Imported modules   
from BTrees.IIBTree import IISet, union, IITreeSet
from BTrees.IOBTree import IOBTree
from BTrees.OIBTree import OIBTree
from BTrees.OOBTree import OOBTree
from Lexicon import Lexicon
from Splitter import Splitter
from UnTextIndex import Or
from randid import randid
import re
import string
Classes   
GlobbingLexicon

Lexicon which supports basic globbing function (* and ?).

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/GlobbingLexicon_GlobbingLexicon.py.html0100600000176200017510000002775207306455613032354 0ustar dhellmanndevel Class: GlobbingLexicon

Table of Contents

Class: GlobbingLexicon Zope-2-CVS-src/lib/python/SearchIndex/GlobbingLexicon.py

Lexicon which supports basic globbing function (* and ?).

This lexicon keeps several data structures around that are useful for searching. They are:

_lexicon

Contains the mapping from word => word_id

_inverseLex

Contains the mapping from word_id => word

_digrams

Contains a mapping from digram => word_id

Before going further, it is necessary to understand what a digram is, as it is a core component of the structure of this lexicon. A digram is a two-letter sequence in a word. For example, the word zope would be converted into the digrams:

      ['$z', 'zo', 'op', 'pe', 'e$']

where the $ is a word marker. It is used at the beginning and end of the words. Those digrams are significant.

Base Classes   
Lexicon
Methods   
Splitter
__getitem__
__init__
_convertBTrees
assignWordId
clear
createDigrams
createRegex
get
getWord
 getWordId
query_hook
  Splitter  
Splitter (
        self,
        astring,
        words=None,
        )

wrap the splitter

  __getitem__  
__getitem__ ( self,  word )

  __init__  
__init__ ( self )

  _convertBTrees  
_convertBTrees ( self,  threshold=200 )

  assignWordId  
assignWordId ( self,  word )

Assigns a new word id to the provided word, and return it.

  clear  
clear ( self )

  createDigrams  
createDigrams ( self,  word )

Returns a list with the set of digrams in the word.

  createRegex  
createRegex ( self,  pat )

Translate a PATTERN to a regular expression.

There is no way to quote meta-characters.

  get  
get ( self,  pattern )

Query the lexicon for words matching a pattern.

  getWord  
getWord ( self,  wid )

  getWordId  
getWordId ( self,  word )

Provided word, return the matching integer word id.

  query_hook  
query_hook ( self,  q )

expand wildcards

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/Index.py.html0100600000176200017510000001014707306455613025217 0ustar dhellmanndevel Module: Index

Table of Contents

Module: Index Zope-2-CVS-src/lib/python/SearchIndex/Index.py

Simple column indices

Imported modules   
from BTrees.IIBTree import IITreeSet
from BTrees.OOBTree import OOBTree
from Missing import MV
from Persistence import Persistent
import operator
import string
Functions   
nonEmpty
  nonEmpty  
nonEmpty ( s )

returns true if a non-empty string or any other (nonstring) type

Classes   
Index

Index object interface

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/Index_Index.py.html0100600000176200017510000002301607306455613026345 0ustar dhellmanndevel Class: Index

Table of Contents

Class: Index Zope-2-CVS-src/lib/python/SearchIndex/Index.py

Index object interface

Base Classes   
Persistent
Methods   
__init__
_apply_index
_reindex
clear
dpHasUniqueValuesFor
dpUniqueValues
index_item
unindex_item
  __init__  
__init__ (
        self,
        data=None,
        schema=None,
        id=None,
        ignore_ex=None,
        call_methods=None,
        )

Create an index

The arguments are:

data

a mapping from integer object ids to objects or records,

schema

a mapping from item name to index into data records. If data is a mapping to objects, then schema should ne None.

id

the name of the item attribute to index. This is either an attribute name or a record key.

  _apply_index  
_apply_index (
        self,
        request,
        cid='',
        )

Apply the index to query parameters given in the argument, request

The argument should be a mapping object.

If the request does not contain the needed parameters, then None is returned.

If the request contains a parameter with the name of the column + _usage, it is sniffed for information on how to handle applying the index.

Otherwise two objects are returned. The first object is a ResultSet containing the record numbers of the matching records. The second object is a tuple containing the names of all data fields used.

  _reindex  
_reindex ( self,  start=0 )

Recompute index data for data with ids >= start.

  clear  
clear ( self )

  dpHasUniqueValuesFor  
dpHasUniqueValuesFor ( self,  name )

has unique values for column NAME

  dpUniqueValues  
dpUniqueValues (
        self,
        name=None,
        withLengths=0,
        )

returns the unique values for name

if withLengths is true, returns a sequence of tuples of (value, length)

  index_item  
index_item (
        self,
        i,
        obj=None,
        )

Recompute index data for data with ids >= start.

  unindex_item  
unindex_item (
        self,
        i,
        obj=None,
        )

Recompute index data for data with ids >= start.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/Lexicon.py.html0100600000176200017510000000600307306455613025545 0ustar dhellmanndevel Module: Lexicon

Table of Contents

Module: Lexicon Zope-2-CVS-src/lib/python/SearchIndex/Lexicon.py

Imported modules   
from Acquisition import Implicit
from BTrees.IIBTree import IISet, IITreeSet
from BTrees.IOBTree import IOBTree
from BTrees.OIBTree import OIBTree
from Persistence import Persistent
from Splitter import Splitter
from randid import randid
Classes   
Lexicon

Maps words to word ids and then some

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/Lexicon_Lexicon.py.html0100600000176200017510000002675307306455613027244 0ustar dhellmanndevel Class: Lexicon

Table of Contents

Class: Lexicon Zope-2-CVS-src/lib/python/SearchIndex/Lexicon.py

Maps words to word ids and then some

The Lexicon object is an attempt to abstract vocabularies out of Text indexes. This abstraction is not totally cooked yet, this module still includes the parser for the Text Index Query Language and a few other hacks.

Base Classes   
Persistent
Implicit
Methods   
Splitter
__getitem__
__init__
__len__
_convertBTrees
assignWordId
clear
get
getWord
getWordId
 query_hook
set_stop_syn
  Splitter  
Splitter (
        self,
        astring,
        words=None,
        )

wrap the splitter

  __getitem__  
__getitem__ ( self,  key )

  __init__  
__init__ ( self,  stop_syn=None )

  __len__  
__len__ ( self )

  _convertBTrees  
_convertBTrees ( self,  threshold=200 )

  assignWordId  
assignWordId ( self,  word )

Assigns a new word id to the provided word and returns it.

  clear  
clear ( self )

  get  
get (
        self,
        key,
        default=None,
        )

Return the matched word against the key.

  getWord  
getWord ( self,  wid )

post-2.3.1b2 method, will not work with unconverted lexicons

  getWordId  
getWordId ( self,  word )

return the word id of word

  query_hook  
query_hook ( self,  q )

we don't want to modify the query cuz we're dumb

  set_stop_syn  
set_stop_syn ( self,  stop_syn )

pass in a mapping of stopwords and synonyms. Format is:

{'word' : [syn1, syn2, ..., synx]}

Vocabularies do not necesarily need to implement this if their splitters do not support stemming or stoping.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/PluggableIndex.py.html0100600000176200017510000000520507306455613027041 0ustar dhellmanndevel Module: PluggableIndex

Table of Contents

Module: PluggableIndex Zope-2-CVS-src/lib/python/SearchIndex/PluggableIndex.py

Pluggable Index Base Class

Imported modules   
import Interface
Classes   
PluggableIndex

Base pluggable index class

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/PluggableIndex_PluggableIndex.py.html0100600000176200017510000001510507306455613032013 0ustar dhellmanndevel Class: PluggableIndex

Table of Contents

Class: PluggableIndex Zope-2-CVS-src/lib/python/SearchIndex/PluggableIndex.py

Base pluggable index class

Methods   
_apply_index
getEntryForObject
index_object
unindex_object
uniqueValues
  _apply_index  
_apply_index (
        self,
        request,
        cid='',
        )

Apply the index to query parameters given in the argument, request.

The argument should be a mapping object.

If the request does not contain the needed parametrs, then None is returned.

If the request contains a parameter with the name of the column + "_usage", it is sniffed for information on how to handle applying the index.

Otherwise two objects are returned. The first object is a ResultSet containing the record numbers of the matching records. The second object is a tuple containing the names of all data fields used.

  getEntryForObject  
getEntryForObject (
        self,
        documentId,
        default=None,
        )

Get all information contained for a specific object by documentId

  index_object  
index_object (
        self,
        documentId,
        obj,
        threshold=None,
        )

Index an object:

documentId is the integer ID of the document

obj is the object to be indexed

threshold is the number of words to process between committing subtransactions. If None, subtransactions are disabled

  unindex_object  
unindex_object ( self,  documentId )

Remove the documentId from the index

  uniqueValues  
uniqueValues (
        self,
        name=None,
        withLengths=0,
        )

Returns the unique values for name.

If withLengths is true, returns a sequence of tuples of (value, length)

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/ResultList.py.html0100600000176200017510000000533407306455613026264 0ustar dhellmanndevel Module: ResultList

Table of Contents

Module: ResultList Zope-2-CVS-src/lib/python/SearchIndex/ResultList.py

Imported modules   
from BTrees.IIBTree import IIBucket, weightedIntersection, weightedUnion, difference
from BTrees.OOBTree import OOSet, union
Classes   
ResultList

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/ResultList_ResultList.py.html0100600000176200017510000002152207306455613030453 0ustar dhellmanndevel Class: ResultList

Table of Contents

Class: ResultList Zope-2-CVS-src/lib/python/SearchIndex/ResultList.py

Methods   
__and__
__init__
__nonzero__
__or__
and_not
bucket
has_key
items
keys
near
  __and__  
__and__ ( self,  x )

  __init__  
__init__ (
        self,
        d,
        words,
        index,
        TupleType=type(() ),
        )

  __nonzero__  
__nonzero__ ( self )

  __or__  
__or__ ( self,  x )

  and_not  
and_not ( self,  x )

  bucket  
bucket ( self )

  has_key  
has_key ( self,  key )

  items  
items ( self )

  keys  
keys ( self )

  near  
near ( self,  x )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/TextIndex.py.html0100600000176200017510000003753707306455614026101 0ustar dhellmanndevel Module: TextIndex

Table of Contents

Module: TextIndex Zope-2-CVS-src/lib/python/SearchIndex/TextIndex.py

Text Index

Notes on a new text index design

The current inverted index algoirthm works well enough for our needs. Speed of the algorithm does not seem to be a problem, however, data management is a significant problem. In particular:

  • Process size grows unacceptably during mass indexing.

  • Data load and store seems to take too long. For example, clearing an inverted index and committing takes a significant amount of time.

  • The current trie data structure contributes significantly to the number of objects in the system.

  • Removal/update of documents is especially problematic. We have to either:

    • Unindex old version of an object before updating it. This is a real hassle for apps like sws.

    • Tool through entire index looking for object references. This is totally impractical.

Some observations of competition:

  • Xerox system can index "5-million word document in 256k". What does this mean?

    • Does the system save word positions as we do?

    • What is the index indexing?

    • What was the vocabulary of the system?

    Let\'s see. Assume a 10,000 word vocabulary. Then we use 25-bytes per entry. Hm.....

  • Verity has some sense of indexing in phases and packing index. Verity keeps the index in multiple chunks and a search may operate on multiple chunks. This means that we can add data without updating large records.

    This may be especially handy for mass updates, like we do in cv3. In a sense we do this in cv3 and sws. We index a large batch of documents to a temporary index and then merge changes in.

    If "temporary" index was integral to system, then maybe merger could be done as a background task....

Tree issues

Tree structures benefit small updates, because an update to an entry does not cause update of entire tree, however, each node in tree introduces overhead.

Trie structure currently introduces an excessive number of nodes. Typically, a node per two or three words. Trie has potential to reduce storage because key storage is shared between words.

Maybe an alternative to a Trie is some sort of nested BTree. Or maybe a Trie with some kind of binary-search-based indexing.

Suppose that:

  • database objects were at leaves of tree - vocabulary was finite - we don\'t remove a leaf when it becomes empty

Then:

  • After some point, tree objects no longer change

If this is case, then it doesn\'t make sense to optimize tree for change.

Additional notes

Stemming reduces the number of words substantially.

Proposal

new TextIndex

TextIndex

word -> textSearchResult

Implemented with:

InvertedIndex

word -> idSet

ResultIndex

id -> docData

where:

word

is a token, typically a word, but could be a name or a number

textSearchResult

id -> (score, positions)

id

integer, say 4-byte.

positions

sequence of integers.

score

numeric measure of relevence, f(numberOfWords, positions)

numberOfWords

number of words in source document.

idSet

set of ids

docData

numberOfWords, word->positions

Note that ids and positions are ints. We will build C extensions for efficiently storing and pickling structures with lots of ints. This should significantly improve space overhead and storage/retrieveal times, as well as storeage space.

Imported modules   
from BTrees.IIBTree import IISet, IIBucket
from BTrees.OOBTree import OOBTree
from Globals import Persistent
from Lexicon import Lexicon, stop_word_dict
from ResultList import ResultList
from Splitter import Splitter
import operator
import re
import string
from string import strip
Functions   
evaluate
get_operands
parens
parse
parse2
query
quotes
  evaluate  
evaluate (
        q,
        index,
        ListType=type([] ),
        )

Evaluate a parsed query

Exceptions   
QueryError, "Malformed query"
  get_operands  
get_operands (
        q,
        i,
        index,
        ListType=type([] ),
        StringType=type( '' ),
        )

Evaluate and return the left and right operands for an operator

Exceptions   
QueryError, "Malformed query"
  parens  
parens ( s,  parens_re=re.compile( r'(\|)' ).search )

Exceptions   
QueryError, "Mismatched parentheses"
  parse  
parse ( s )

Parse parentheses and quotes

  parse2  
parse2 (
        q,
        default_operator,
        operator_dict={ AndNot : AndNot, And : And, Or : Or, Near : Near },
        ListType=type([] ),
        )

Find operators and operands

  query  
query (
        s,
        index,
        default_operator=Or,
        ws=( string.whitespace, ),
        )

  quotes  
quotes ( s,  ws=( string.whitespace, ) )

Exceptions   
QueryError, "Mismatched quotes"
Classes   
TextIndex

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/TextIndex_TextIndex.py.html0100600000176200017510000002671407306455614030070 0ustar dhellmanndevel Class: TextIndex

Table of Contents

Class: TextIndex Zope-2-CVS-src/lib/python/SearchIndex/TextIndex.py

Base Classes   
Persistent
Methods   
__getitem__
__init__
_apply_index
_index_document
_reindex
_subindex
clear
index_item
positions
unindex_item
  __getitem__  
__getitem__ ( self,  word )

Return an InvertedIndex-style result "list"

  __init__  
__init__ (
        self,
        data=None,
        schema=None,
        id=None,
        ignore_ex=None,
        call_methods=None,
        )

Create an index

The arguments are:

data

a mapping from integer object ids to objects or records,

schema

a mapping from item name to index into data records. If data is a mapping to objects, then schema should ne None.

id

the name of the item attribute to index. This is either an attribute name or a record key.

ignore_ex

Tells the indexer to ignore exceptions that are rasied when indexing an object.

call_methods

Tells the indexer to call methods instead of getattr or getitem to get an attribute.

  _apply_index  
_apply_index (
        self,
        request,
        cid='',
        ListType=[],
        )

Apply the index to query parameters given in the argument, request

The argument should be a mapping object.

If the request does not contain the needed parameters, then None is returned.

Otherwise two objects are returned. The first object is a ResultSet containing the record numbers of the matching records. The second object is a tuple containing the names of all data fields used.

  _index_document  
_index_document (
        self,
        document_text,
        id,
        un=0,
        tupleType=type(() ),
        dictType=type({} ),
        )

  _reindex  
_reindex ( self,  start=0 )

Recompute index data for data with ids >= start.

  _subindex  
_subindex (
        self,
        isrc,
        d,
        old,
        last,
        )

  clear  
clear ( self )

  index_item  
index_item (
        self,
        i,
        obj=None,
        un=0,
        )

Recompute index data for data with ids >= start. if obj is passed in, it is indexed instead of _data[i]

  positions  
positions (
        self,
        docid,
        words,
        )

Return the positions in the document for the given document id of the word, word.

  unindex_item  
unindex_item (
        self,
        i,
        obj=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/UnIndex.py.html0100600000176200017510000000643607306455614025531 0ustar dhellmanndevel Module: UnIndex

Table of Contents

Module: UnIndex Zope-2-CVS-src/lib/python/SearchIndex/UnIndex.py

Simple column indices

Imported modules   
from Acquisition import Implicit
import BTree
from BTrees.IIBTree import IITreeSet, IISet, union
from BTrees.IOBTree import IOBTree
import BTrees.Length
from BTrees.OOBTree import OOBTree, OOSet
from Globals import Persistent
import IOBTree
import string
import sys
from types import StringType, ListType, IntType, TupleType
from zLOG import LOG, ERROR
Classes   
UnIndex

UnIndex object interface

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/UnIndex_UnIndex.py.html0100600000176200017510000004467207306455614027167 0ustar dhellmanndevel Class: UnIndex

Table of Contents

Class: UnIndex Zope-2-CVS-src/lib/python/SearchIndex/UnIndex.py

UnIndex object interface

Base Classes   
Persistent
Implicit
Methods   
__init__
__len__
__nonzero__
_apply_index
_convertBTrees
clear
getEntryForObject
hasUniqueValuesFor
histogram
index_object
 insertForwardIndexEntry
items
keyForDocument
referencedObjects
removeForwardIndexEntry
unindex_object
uniqueValues
  __init__  
__init__ (
        self,
        id,
        ignore_ex=None,
        call_methods=None,
        )

Create an unindex

UnIndexes are indexes that contain two index components, the forward index (like plain index objects) and an inverted index. The inverted index is so that objects can be unindexed even when the old value of the object is not known.

e.g.

self._index = {datum:[documentId1, documentId2]} self._unindex = {documentId:datum}

If any item in self._index has a length-one value, the value is an integer, and not a set. There are special cases in the code to deal with this.

The arguments are:

id

the name of the item attribute to index. This is either an attribute name or a record key.

ignore_ex

should be set to true if you want the index to ignore exceptions raised while indexing instead of propagating them.

call_methods

should be set to true if you want the index to call the attribute id (note: id should be callable!) You will also need to pass in an object in the index and uninded methods for this to work.

  __len__  
__len__ ( self )

Return the number of objects indexed.

This method is only called for indexes which have "old" BTrees, and the only reason that UnIndexes maintain a __len__ is for the searching code in the catalog during sorting.

  __nonzero__  
__nonzero__ ( self )

  _apply_index  
_apply_index (
        self,
        request,
        cid='',
        type=type,
        None=None,
        )

Apply the index to query parameters given in the request arg.

The request argument should be a mapping object.

If the request does not have a key which matches the "id" of the index instance, then None is returned.

If the request does have a key which matches the "id" of the index instance, one of a few things can happen:

  • if the value is a blank string, None is returned (in order to support requests from web forms where you can't tell a blank string from empty).

  • if the value is a nonblank string, turn the value into a single-element sequence, and proceed.

  • if the value is a sequence, return a union search.

If the request contains a parameter with the name of the column + _usage, it is sniffed for information on how to handle applying the index.

If None is not returned as a result of the abovementioned constraints, two objects are returned. The first object is a ResultSet containing the record numbers of the matching records. The second object is a tuple containing the names of all data fields used.

FAQ answer: to search a Field Index for documents that have a blank string as their value, wrap the request value up in a tuple ala: request = {'id':('',)}

  _convertBTrees  
_convertBTrees ( self,  threshold=200 )

  clear  
clear ( self )

  getEntryForObject  
getEntryForObject (
        self,
        documentId,
        default=_marker,
        )

Takes a document ID and returns all the information we have on that specific object.

  hasUniqueValuesFor  
hasUniqueValuesFor ( self,  name )

has unique values for column NAME

  histogram  
histogram ( self )

Return a mapping which provides a histogram of the number of elements found at each point in the index.

  index_object  
index_object (
        self,
        documentId,
        obj,
        threshold=None,
        )

index and object obj with integer id documentId

  insertForwardIndexEntry  
insertForwardIndexEntry (
        self,
        entry,
        documentId,
        )

Take the entry provided and put it in the correct place in the forward index.

This will also deal with creating the entire row if necessary.

  items  
items ( self )

  keyForDocument  
keyForDocument ( self,  id )

  referencedObjects  
referencedObjects ( self )

Generate a list of IDs for which we have referenced objects.

  removeForwardIndexEntry  
removeForwardIndexEntry (
        self,
        entry,
        documentId,
        )

Take the entry provided and remove any reference to documentId in its entry in the index.

  unindex_object  
unindex_object ( self,  documentId )

Unindex the object with integer id documentId and don't raise an exception if we fail

  uniqueValues  
uniqueValues (
        self,
        name=None,
        withLengths=0,
        )

returns the unique values for name

if withLengths is true, returns a sequence of tuples of (value, length)

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/UnKeywordIndex.py.html0100600000176200017510000000564707306455614027101 0ustar dhellmanndevel Module: UnKeywordIndex

Table of Contents

Module: UnKeywordIndex Zope-2-CVS-src/lib/python/SearchIndex/UnKeywordIndex.py

Imported modules   
from BTrees.OOBTree import OOSet, difference
from UnIndex import UnIndex
from types import StringType
from zLOG import LOG, ERROR
Classes   
UnKeywordIndex

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/UnKeywordIndex_UnKeywordIndex.py.html0100600000176200017510000001213707306455614032070 0ustar dhellmanndevel Class: UnKeywordIndex

Table of Contents

Class: UnKeywordIndex Zope-2-CVS-src/lib/python/SearchIndex/UnKeywordIndex.py

Base Classes   
UnIndex
Methods   
index_object
unindex_object
unindex_objectKeywords
  index_object  
index_object (
        self,
        documentId,
        obj,
        threshold=None,
        )

index an object obj with integer id i

Ideally, we've been passed a sequence of some sort that we can iterate over. If however, we haven't, we should do something useful with the results. In the case of a string, this means indexing the entire string as a keyword.

  unindex_object  
unindex_object ( self,  documentId )

carefully unindex the object with integer id documentId

  unindex_objectKeywords  
unindex_objectKeywords (
        self,
        documentId,
        keywords,
        )

carefully unindex the object with integer id documentId

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/UnTextIndex.py.html0100600000176200017510000002067207306455614026374 0ustar dhellmanndevel Module: UnTextIndex

Table of Contents

Module: UnTextIndex Zope-2-CVS-src/lib/python/SearchIndex/UnTextIndex.py

Text Index

The UnTextIndex falls under the I didnt have a better name for it excuse. It is an Un Text index because it stores a little bit of undo information so that objects can be unindexed when the old value is no longer known.

Imported modules   
from Acquisition import Implicit
from BTrees.IIBTree import IIBTree, IIBucket, IISet, IITreeSet, difference, weightedIntersection
from BTrees.IOBTree import IOBTree
from BTrees.OIBTree import OIBTree
from Globals import Persistent
from Lexicon import Lexicon
from ResultList import ResultList
from Splitter import Splitter
import operator
import re
import string
from types import *
from zLOG import LOG, ERROR
Functions   
parens
parse
parse2
quotes
  parens  
parens ( s,  parens_re=re.compile( r'(\|)' ).search )

Exceptions   
QueryError, "Mismatched parentheses"
  parse  
parse ( s )

Parse parentheses and quotes

  parse2  
parse2 (
        q,
        default_operator,
        operator_dict={ AndNot : AndNot, And : And, Or : Or, Near : Near },
        )

Find operators and operands

  quotes  
quotes ( s,  ws=( string.whitespace, ) )

Exceptions   
QueryError, "Mismatched quotes"
Classes   
UnTextIndex

Full-text index.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/UnTextIndex_UnTextIndex.py.html0100600000176200017510000005061507306455614030673 0ustar dhellmanndevel Class: UnTextIndex

Table of Contents

Class: UnTextIndex Zope-2-CVS-src/lib/python/SearchIndex/UnTextIndex.py

Full-text index.

There is a ZCatalog UML model that sheds some light on what is going on here. _index is a BTree which maps word ids to mapping from document id to score. Something like:

{'bob' : {1 : 5, 2 : 3, 42 : 9}} {'uncle' : {1 : 1}}

The _unindex attribute is a mapping from document id to word ids. This mapping allows the catalog to unindex an object:

{42 : (bob, is, your, uncle)

This isn't exactly how things are represented in memory, many optimizations happen along the way.

Base Classes   
Persistent
Implicit
Methods   
__getitem__
__init__
__nonzero__
_apply_index
_convertBTrees
_subindex
clear
evaluate
getEntryForObject
getLexicon
 get_operands
histogram
index_object
insertForwardIndexEntry
positions
query
unindex_object
unindex_objectWids
  __getitem__  
__getitem__ ( self,  word )

Return an InvertedIndex-style result "list"

Note that this differentiates between being passed an Integer and a String. Strings are looked up in the lexicon, whereas Integers are assumed to be resolved word ids.

  __init__  
__init__ (
        self,
        id,
        ignore_ex=None,
        call_methods=None,
        lexicon=None,
        )

Create an index

The arguments are:

id

the name of the item attribute to index. This is either an attribute name or a record key.

ignore_ex

Tells the indexer to ignore exceptions that are rasied when indexing an object.

call_methods

Tells the indexer to call methods instead of getattr or getitem to get an attribute.

lexicon is the lexicon object to specify, if None, the index will use a private lexicon.

  __nonzero__  
__nonzero__ ( self )

  _apply_index  
_apply_index (
        self,
        request,
        cid='',
        )

Apply the index to query parameters given in the argument, request

The argument should be a mapping object.

If the request does not contain the needed parameters, then None is returned.

Otherwise two objects are returned. The first object is a ResultSet containing the record numbers of the matching records. The second object is a tuple containing the names of all data fields used.

  _convertBTrees  
_convertBTrees ( self,  threshold=200 )

  _subindex  
_subindex (
        self,
        source,
        wordScores,
        last,
        splitter,
        )

Recursively handle multi-word synonyms

  clear  
clear ( self )

Reinitialize the text index.

  evaluate  
evaluate ( self,  query )

Evaluate a parsed query

Exceptions   
QueryError, "Malformed query"
  getEntryForObject  
getEntryForObject (
        self,
        rid,
        default=None,
        )

Get all information contained for a specific object.

This takes the objects record ID as it's main argument.

  getLexicon  
getLexicon ( self,  vocab_id )

Return the Lexicon in use.

Bit of a hack, indexes have been made acquirers so that they can acquire a vocabulary object from the object system in Zope. I don't think indexes were ever intended to participate in this way, but I don't see too much of a problem with it.

  get_operands  
get_operands (
        self,
        q,
        i,
        )

Evaluate and return the left and right operands for an operator

Exceptions   
QueryError, "Malformed query"
  histogram  
histogram (
        self,
        type=type,
        TupleType=type(() ),
        )

Return a mapping which provides a histogram of the number of elements found at each point in the index.

  index_object  
index_object (
        self,
        documentId,
        obj,
        threshold=None,
        )

Index an object: documentId is the integer id of the document

obj is the objects to be indexed

threshold is the number of words to process between commiting subtransactions. If None subtransactions are disabled.

  insertForwardIndexEntry  
insertForwardIndexEntry (
        self,
        entry,
        documentId,
        score=1,
        )

Uses the information provided to update the indexes.

The basic logic for choice of data structure is based on the number of entries as follows:

1 tuple 2-4 dictionary 5+ bucket.

  positions  
positions (
        self,
        docid,
        words,
        )

Return the positions in the document for the given document id of the word, word.

  query  
query (
        self,
        s,
        default_operator=Or,
        ws=( string.whitespace, ),
        )

This is called by TextIndexes. A query term which is a string s is passed in, along with an index object. s is parsed, then the wildcards are parsed, then something is parsed again, then the whole thing is evaluated.

  unindex_object  
unindex_object ( self,  i )

carefully unindex document with integer id i from the text index and do not fail if it does not exist

  unindex_objectWids  
unindex_objectWids (
        self,
        i,
        wids,
        )

carefully unindex document with integer id i from the text index and do not fail if it does not exist

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/__init__.py.html0100600000176200017510000000243307306455614025707 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/SearchIndex/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/SearchIndex/randid.py.html0100600000176200017510000000635707306455614025422 0ustar dhellmanndevel Module: randid

Table of Contents

Module: randid Zope-2-CVS-src/lib/python/SearchIndex/randid.py

Imported modules   
import whrandom
Functions   
randid
  randid  
randid (
        randint=whrandom.randint,
        choice=whrandom.choice,
        signs=( -1, 1 ),
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:30 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/0040700000176200017510000000000007306455617021646 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/index.html0100600000176200017510000000412607306455617023645 0ustar dhellmanndevel Zope2 CVS with ZEO: Shared

Table of Contents

Zope2 CVS with ZEO: Shared  
Modules and Packages   

Zope-2-CVS-src/lib/python/Shared/

DC

Zope2 CVS with ZEO: Shared.DC

__init__

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/0040700000176200017510000000000007306455617022134 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/index.html0100600000176200017510000000465007306455617024135 0ustar dhellmanndevel Zope2 CVS with ZEO: Shared.DC

Table of Contents

Zope2 CVS with ZEO: Shared.DC  
Modules and Packages   

Zope-2-CVS-src/lib/python/Shared/DC/

Scripts

Zope2 CVS with ZEO: Shared.DC.Scripts

ZRDB

Zope2 CVS with ZEO: Shared.DC.ZRDB

__init__
xml

Zope2 CVS with ZEO: Shared.DC.xml

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/Scripts/0040700000176200017510000000000007306455614023560 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/Scripts/index.html0100600000176200017510000000476007306455614025563 0ustar dhellmanndevel Zope2 CVS with ZEO: Shared.DC.Scripts

Table of Contents

Zope2 CVS with ZEO: Shared.DC.Scripts  
Modules and Packages   

Zope-2-CVS-src/lib/python/Shared/DC/Scripts/

Bindings
BindingsUI
Script

Script module

Signature

Signature module

__init__

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:41 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/Scripts/Bindings.py.html0100600000176200017510000000606507306455614026640 0ustar dhellmanndevel Module: Bindings

Table of Contents

Module: Bindings Zope-2-CVS-src/lib/python/Shared/DC/Scripts/Bindings.py

Imported modules   
import Globals
from Persistence import Persistent
import re
from string import join, strip
Classes   
Bindings
NameAssignments

Note that instances of this class are intended to be immutable

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:41 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/Scripts/Bindings_Bindings.py.html0100600000176200017510000003367007306455614030457 0ustar dhellmanndevel Class: Bindings

Table of Contents

Class: Bindings Zope-2-CVS-src/lib/python/Shared/DC/Scripts/Bindings.py

Methods   
ZBindings_edit
ZBindings_setClient
__before_publishing_traverse__
__call__
__render_with_namespace__
_bindAndExec
_createBindCode
_editedBindings
_getBindCount
_getContainer
 _getContext
_getNamespace
_getTraverseSubpath
_prepareBindCode
_setupBindings
getBindingAssignments
  ZBindings_edit  
ZBindings_edit ( self,  mapping )

  ZBindings_setClient  
ZBindings_setClient ( self,  clientname )

Name the binding to be used as the "client".

This is used by classes such as DTMLFile that want to choose an object on which to operate by default.

  __before_publishing_traverse__  
__before_publishing_traverse__ (
        self,
        self2,
        request,
        )

  __call__  
__call__ (
        self,
        *args,
        *kw,
        )

Calls the script.

  __render_with_namespace__  
__render_with_namespace__ ( self,  namespace )

Calls the script with the specified namespace.

  _bindAndExec  
_bindAndExec (
        self,
        args,
        kw,
        caller_namespace,
        )

Prepares the bound information and calls _exec(), possibly with a namespace.

  _createBindCode  
_createBindCode ( self,  names )

  _editedBindings  
_editedBindings ( self )

  _getBindCount  
_getBindCount ( self )

  _getContainer  
_getContainer ( self )

  _getContext  
_getContext ( self )

  _getNamespace  
_getNamespace (
        self,
        caller_namespace,
        kw,
        )

  _getTraverseSubpath  
_getTraverseSubpath ( self )

  _prepareBindCode  
_prepareBindCode ( self )

  _setupBindings  
_setupBindings ( self,  names={} )

  getBindingAssignments  
getBindingAssignments ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:41 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/Scripts/Bindings_NameAssignments.py.html0100600000176200017510000002364207306455614032014 0ustar dhellmanndevel Class: NameAssignments

Table of Contents

Class: NameAssignments Zope-2-CVS-src/lib/python/Shared/DC/Scripts/Bindings.py

Note that instances of this class are intended to be immutable and persistent but not inherit from ExtensionClass.

Methods   
__init__
_createCodeBlockForMapping
_createCodeBlockForTuple
_generateCodeBlock
getAssignedName
getAssignedNames
getAssignedNamesInOrder
isAnyNameAssigned
isNameAssigned
  __init__  
__init__ ( self,  mapping )

Exceptions   
ValueError, ( '"%s" is not a valid variable name.' % assigned_name )
  _createCodeBlockForMapping  
_createCodeBlockForMapping ( self )

  _createCodeBlockForTuple  
_createCodeBlockForTuple ( self,  argNames )

  _generateCodeBlock  
_generateCodeBlock (
        self,
        bindtext,
        assigned_names,
        )

  getAssignedName  
getAssignedName (
        self,
        name,
        default=_marker,
        )

Exceptions   
KeyError, name
  getAssignedNames  
getAssignedNames ( self )

  getAssignedNamesInOrder  
getAssignedNamesInOrder ( self )

  isAnyNameAssigned  
isAnyNameAssigned ( self )

  isNameAssigned  
isNameAssigned ( self,  name )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:41 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/Scripts/BindingsUI.py.html0100600000176200017510000000533607306455614027076 0ustar dhellmanndevel Module: BindingsUI

Table of Contents

Module: BindingsUI Zope-2-CVS-src/lib/python/Shared/DC/Scripts/BindingsUI.py

Imported modules   
from Bindings import Bindings
import Globals
Classes   
BindingsUI

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:41 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/Scripts/BindingsUI_BindingsUI.py.html0100600000176200017510000000634507306455614031152 0ustar dhellmanndevel Class: BindingsUI

Table of Contents

Class: BindingsUI Zope-2-CVS-src/lib/python/Shared/DC/Scripts/BindingsUI.py

Base Classes   
Bindings
Methods   
ZBindingsHTML_editAction
  ZBindingsHTML_editAction  
ZBindingsHTML_editAction ( self,  REQUEST )

Changes binding names.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:41 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/Scripts/Script.py.html0100600000176200017510000000651107306455614026343 0ustar dhellmanndevel Module: Script

Table of Contents

Module: Script Zope-2-CVS-src/lib/python/Shared/DC/Scripts/Script.py

Script module

This provides generic script support

Imported modules   
from Bindings import defaultBindings
from BindingsUI import BindingsUI
from DocumentTemplate.DT_Util import TemplateDict
from Globals import DTMLFile
from OFS.SimpleItem import SimpleItem
from Signature import FuncCode
from string import join
from urllib import quote
Classes   
Script

Web-callable script mixin

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:41 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/Scripts/Script_Script.py.html0100600000176200017510000000766407306455614027701 0ustar dhellmanndevel Class: Script

Table of Contents

Class: Script Zope-2-CVS-src/lib/python/Shared/DC/Scripts/Script.py

Web-callable script mixin

Base Classes   
SimpleItem
BindingsUI
Methods   
ZScriptHTML_tryAction
  ZScriptHTML_tryAction  
ZScriptHTML_tryAction (
        self,
        REQUEST,
        argvars,
        )

Apply the test parameters.

Exceptions   
"Redirect", "%s?%s" %(REQUEST [ 'URL1' ], join( vv, '&' ) )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:41 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/Scripts/Signature.py.html0100600000176200017510000000662407306455614027045 0ustar dhellmanndevel Module: Signature

Table of Contents

Module: Signature Zope-2-CVS-src/lib/python/Shared/DC/Scripts/Signature.py

Signature module

This provides support for simulating function signatures

Functions   
_setFuncSignature
  _setFuncSignature  
_setFuncSignature (
        self,
        defaults=None,
        varnames=(),
        argcount=-1,
        )

Classes   
FuncCode

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:41 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/Scripts/Signature_FuncCode.py.html0100600000176200017510000000637007306455614030611 0ustar dhellmanndevel Class: FuncCode

Table of Contents

Class: FuncCode Zope-2-CVS-src/lib/python/Shared/DC/Scripts/Signature.py

Methods   
__cmp__
__init__
  __cmp__  
__cmp__ ( self,  other )

  __init__  
__init__ (
        self,
        varnames,
        argcount,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:41 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/Scripts/__init__.py.html0100600000176200017510000000245507306455614026641 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Shared/DC/Scripts/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:41 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/0040700000176200017510000000000007306455615022673 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/index.html0100600000176200017510000000707407306455615024677 0ustar dhellmanndevel Zope2 CVS with ZEO: Shared.DC.ZRDB

Table of Contents

Zope2 CVS with ZEO: Shared.DC.ZRDB  
Modules and Packages   

Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/

Aqueduct
Connection
DA
RDB
Results
Search
THUNK
TM

Provide support for linking an external transaction manager with Zope's

__init__
dbi_db
sqlgroup

Inserting optional tests with sqlgroup

sqltest

Inserting optional tests with sqlgroup

sqlvar

Inserting values with the sqlvar tag

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Aqueduct.py.html0100600000176200017510000003325407306455614025770 0ustar dhellmanndevel Module: Aqueduct

Table of Contents

Module: Aqueduct Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Aqueduct.py

Imported modules   
from AccessControl.Role import RoleManager
import Acquisition
import DateTime
import DocumentTemplate
from DocumentTemplate import HTML
import Globals
from Globals import Persistent
from OFS import SimpleItem
import binascii
from cStringIO import StringIO
import os
import re
import string
from string import strip, replace
Functions   
custom_default_report
decapitate
decode
decodestring
default_input_form
delimited_output
detypify
nicify
parse
quotedHTML
  custom_default_report  
custom_default_report (
        id,
        result,
        action='',
        no_table=0,
        goofy=re.compile( '\W' ).search,
        )

  decapitate  
decapitate (
        html,
        RESPONSE=None,
        header_re=re.compile( r'((' r'[^\000- <>:]+:[^\n]*\n' r'|' r'[ \011]+[^\000- ][^\n]*\n' r')+)[ \t]*\n([\000-\377]+)' ),
        space_re=re.compile( r'([ \t]+)' ),
        name_re=re.compile( r'([^\000- <>:]+):([^\n]*)' ),
        )

Exceptions   
ValueError, 'Invalid Header (%d): %s ' %(i, headers [ i ] )
  decode  
decode ( input,  output )

  decodestring  
decodestring ( s )

  default_input_form  
default_input_form (
        id,
        arguments,
        action='query',
        tabs='',
        )

  delimited_output  
delimited_output (
        results,
        REQUEST,
        RESPONSE,
        )

  detypify  
detypify ( arg )

  nicify  
nicify ( name )

  parse  
parse (
        text,
        result=None,
        keys=None,
        unparmre=re.compile( r'([\000- ]*([^\000- ="]+))' ),
        parmre=re.compile( r'([\000- ]*([^\000- ="]+)=([^\000- ="]+))' ),
        qparmre=re.compile( r'([\000- ]*([^\000- ="]+)="([^"]*)")' ),
        )

Exceptions   
InvalidParameter, text
  quotedHTML  
quotedHTML ( text,  character_entities=(( '&', '&amp;' ), ( "<", '&lt;' ), ( ">", '&gt;' ), ( '"', '&quot;' ) ) )

Classes   
Args
BaseQuery
Composite
Searchable

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Aqueduct_Args.py.html0100600000176200017510000001777607306455614026757 0ustar dhellmanndevel Class: Args

Table of Contents

Class: Args Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Aqueduct.py

Methods   
__delitem__
__getitem__
__init__
__len__
__setitem__
has_key
items
keys
values
  __delitem__  
__delitem__ ( self,  key )

  __getitem__  
__getitem__ ( self,  key )

  __init__  
__init__ (
        self,
        data,
        keys,
        )

  __len__  
__len__ ( self )

  __setitem__  
__setitem__ (
        self,
        key,
        v,
        )

  has_key  
has_key ( self,  key )

  items  
items ( self )

  keys  
keys ( self )

  values  
values ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Aqueduct_BaseQuery.py.html0100600000176200017510000002000407306455614027735 0ustar dhellmanndevel Class: BaseQuery

Table of Contents

Class: BaseQuery Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Aqueduct.py

Base Classes   
Persistent
SimpleItem.Item
Acquisition.Implicit
RoleManager
Methods   
_argdata
_convert
query_day
query_month
query_year
quoted_input
quoted_report
  _argdata  
_argdata ( self,  REQUEST )

Exceptions   
self.MissingArgumentError, missing
  _convert  
_convert ( self )

  query_day  
query_day ( self )

  query_month  
query_month ( self )

  query_year  
query_year ( self )

  quoted_input  
quoted_input ( self )

  quoted_report  
quoted_report ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Aqueduct_Composite.py.html0100600000176200017510000000754407306455614030015 0ustar dhellmanndevel Class: Composite

Table of Contents

Class: Composite Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Aqueduct.py

Methods   
_getquery
myQueryIds
  _getquery  
_getquery ( self,  id )

Exceptions   
AttributeError, id
  myQueryIds  
myQueryIds ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Aqueduct_Searchable.py.html0100600000176200017510000001555007306455614030100 0ustar dhellmanndevel Class: Searchable

Table of Contents

Class: Searchable Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Aqueduct.py

Base Classes   
BaseQuery
    Persistent
    SimpleItem.Item
    Acquisition.Implicit
    RoleManager
Methods   
_searchable_arguments
_searchable_result_columns
index_html
manage_test
manage_testForm
  _searchable_arguments  
_searchable_arguments ( self )

  _searchable_result_columns  
_searchable_result_columns ( self )

  index_html  
index_html ( self,  URL1 )

Exceptions   
'Redirect', ( "%s/manage_testForm" % URL1 )
  manage_test  
manage_test ( self,  REQUEST )

Perform an actual query

  manage_testForm  
manage_testForm ( self,  REQUEST )

Provide testing interface

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Connection.py.html0100600000176200017510000000667607306455615026325 0ustar dhellmanndevel Module: Connection

Table of Contents

Module: Connection Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Connection.py

Imported modules   
import AccessControl.Role
import Acquisition
from App.Dialogs import MessageDialog
from Aqueduct import custom_default_report
from DateTime import DateTime
import DocumentTemplate
import Globals
from Globals import DTMLFile
import OFS.SimpleItem
import RDB
from Results import Results
from cStringIO import StringIO
from string import find, join, split
import sys
Classes   
Connection

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Connection_Connection.py.html0100600000176200017510000003314607306455615030474 0ustar dhellmanndevel Class: Connection

Table of Contents

Class: Connection Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Connection.py

Base Classes   
Globals.Persistent
AccessControl.Role.RoleManager
OFS.SimpleItem.Item
Acquisition.Implicit
Methods   
__call__
__init__
__setstate__
connect
connected
edit
manage_close_connection
manage_edit
manage_open_connection
manage_test
 sql_quote__
title_and_id
title_or_id
  __call__  
__call__ ( self,  v=None )

Exceptions   
'Database Not Connected', ( '''The database connection is not connected''' )
  __init__  
__init__ (
        self,
        id,
        title,
        connection_string,
        check=None,
        )

  __setstate__  
__setstate__ ( self,  state )

  connect  
connect ( self,  s )

Exceptions   
'BadRequest', ('Invalid connection string: %s
\n' '\n' %( s, t, v ) ), tb
  connected  
connected ( self )

  edit  
edit (
        self,
        title,
        connection_string,
        check=1,
        )

  manage_close_connection  
manage_close_connection ( self,  REQUEST )

  manage_edit  
manage_edit (
        self,
        title,
        connection_string,
        check=None,
        REQUEST=None,
        )

Change connection

  manage_open_connection  
manage_open_connection ( self,  REQUEST=None )

  manage_test  
manage_test (
        self,
        query,
        REQUEST=None,
        )

Executes the SQL in parameter query and returns results

  sql_quote__  
sql_quote__ ( self,  v )

  title_and_id  
title_and_id ( self )

  title_or_id  
title_or_id ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/DA.py.html0100600000176200017510000001236207306455615024477 0ustar dhellmanndevel Module: DA

Table of Contents

Module: DA Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/DA.py

Imported modules   
from AccessControl import getSecurityManager, full_read_guard
import AccessControl.Role
import Acquisition
from App.Extensions import getBrain
import Aqueduct
from Aqueduct import decodestring, parse, custom_default_report, default_input_form
from DateTime.DateTime import DateTime
import DocumentTemplate
import DocumentTemplate.DT_Util
import ExtensionClass
import Globals
from Globals import DTMLFile, MessageDialog
import OFS.SimpleItem
import RDB
from Results import Results
import base64
from cPickle import dumps, loads
from cStringIO import StringIO
import marshal
import md5
import os
import re
import sqlgroup
import sqltest
import sqlvar
from string import atoi, find, join, split, rstrip
import sys
from time import time
from webdav.Lockable import ResourceLockedError
from webdav.Resource import Resource
from zlib import compress, decompress
Classes   
DA

Database Adapter

SQL

Validating SQL template for Zope SQL Methods.

Traverse

Helper class for traversing searches during URL traversal

nvSQL

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/DA_DA.py.html0100600000176200017510000005507107306455615025047 0ustar dhellmanndevel Class: DA

Table of Contents

Class: DA Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/DA.py

Database Adapter

Base Classes   
Aqueduct.BaseQuery
Acquisition.Implicit
Globals.Persistent
AccessControl.Role.RoleManager
OFS.SimpleItem.Item
Resource
Methods   
PUT
PrincipiaSearchSource
__call__
__getitem__
__init__
_cached_result
_er
_searchable_arguments
_searchable_result_columns
connected
 connectionIsValid
da_has_single_argument
document_src
index_html
manage_FTPget
manage_advanced
manage_edit
manage_product_zclass_info
manage_test
manage_testForm
 test_url_
  PUT  
PUT (
        self,
        REQUEST,
        RESPONSE,
        )

Handle put requests

  PrincipiaSearchSource  
PrincipiaSearchSource ( self )

Return content for use by the Find machinery.

  __call__  
__call__ (
        self,
        REQUEST=None,
        __ick__=None,
        src__=0,
        test__=0,
        **kw,
        )

Call the database method

The arguments to the method should be passed via keyword arguments, or in a single mapping object. If no arguments are given, and if the method was invoked through the Web, then the method will try to acquire and use the Web REQUEST object as the argument mapping.

The returned value is a sequence of record objects.

Exceptions   
'Database Error', ( '%s is not connected to a database' % self.id )
AttributeError, ("The database connection %s cannot be found." %( self.connection_id ) )
  __getitem__  
__getitem__ ( self,  key )

Exceptions   
KeyError, key
  __init__  
__init__ (
        self,
        id,
        title,
        connection_id,
        arguments,
        template,
        )

  _cached_result  
_cached_result (
        self,
        DB__,
        query,
        )

  _er  
_er (
        self,
        title,
        connection_id,
        arguments,
        template,
        SUBMIT,
        sql_pref__cols,
        sql_pref__rows,
        REQUEST,
        )

  _searchable_arguments  
_searchable_arguments ( self )

  _searchable_result_columns  
_searchable_result_columns ( self )

  connected  
connected ( self )

  connectionIsValid  
connectionIsValid ( self )

  da_has_single_argument  
da_has_single_argument ( self )

  document_src  
document_src (
        self,
        REQUEST=None,
        RESPONSE=None,
        )

Return unprocessed document source.

  index_html  
index_html ( self,  REQUEST )

  manage_FTPget  
manage_FTPget ( self )

Get source for FTP download

  manage_advanced  
manage_advanced (
        self,
        max_rows,
        max_cache,
        cache_time,
        class_name,
        class_file,
        direct=None,
        REQUEST=None,
        zclass='',
        )

Change advanced properties

The arguments are:

max_rows

The maximum number of rows to be returned from a query.

max_cache

The maximum number of results to cache

cache_time

The maximum amound of time to use a cached result.

class_name

The name of a class that provides additional attributes for result record objects. This class will be a base class of the result record class.

class_file

The name of the file containing the class definition.

The class file normally resides in the Extensions directory, however, the file name may have a prefix of product., indicating that it should be found in a product directory.

For example, if the class file is: ACMEWidgets.foo, then an attempt will first be made to use the file lib/python/Products/ACMEWidgets/Extensions/foo.py. If this failes, then the file Extensions/ACMEWidgets.foo.py will be used.

  manage_edit  
manage_edit (
        self,
        title,
        connection_id,
        arguments,
        template,
        SUBMIT='Change',
        sql_pref__cols='50',
        sql_pref__rows='20',
        REQUEST=None,
        )

Change database method properties

The connection_id argument is the id of a database connection that resides in the current folder or in a folder above the current folder. The database should understand SQL.

The arguments argument is a string containing an arguments specification, as would be given in the SQL method cration form.

The template argument is a string containing the source for the SQL Template.

Exceptions   
ResourceLockedError, 'SQL Method is locked via WebDAV'
  manage_product_zclass_info  
manage_product_zclass_info ( self )

  manage_test  
manage_test ( self,  REQUEST )

Test an SQL method.

  manage_testForm  
manage_testForm ( self,  REQUEST )

  test_url_  
test_url_ ( self )

Method for testing server connection information

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/DA_SQL.py.html0100600000176200017510000000636307306455615025222 0ustar dhellmanndevel Class: SQL

Table of Contents

Class: SQL Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/DA.py

Validating SQL template for Zope SQL Methods.

Base Classes   
ExtensionClass.Base
nvSQL
    DocumentTemplate.HTML
Methods   
read_guard
  read_guard  
read_guard ( self,  ob )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/DA_Traverse.py.html0100600000176200017510000001256207306455615026354 0ustar dhellmanndevel Class: Traverse

Table of Contents

Class: Traverse Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/DA.py

Helper class for traversing searches during URL traversal

Base Classes   
ExtensionClass.Base
Methods   
__bobo_traverse__
__getattr__
__init__
  __bobo_traverse__  
__bobo_traverse__ (
        self,
        REQUEST,
        key,
        )

Exceptions   
AttributeError, v
KeyError, key
  __getattr__  
__getattr__ ( self,  name )

  __init__  
__init__ (
        self,
        da,
        args,
        name=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/DA_nvSQL.py.html0100600000176200017510000000366507306455615025570 0ustar dhellmanndevel Class: nvSQL

Table of Contents

Class: nvSQL Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/DA.py

Base Classes   
DocumentTemplate.HTML

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/RDB.py.html0100600000176200017510000001102607306455615024616 0ustar dhellmanndevel Module: RDB

Table of Contents

Module: RDB Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/RDB.py

Imported modules   
from Acquisition import Implicit
import DateTime
import ExtensionClass
from Missing import MV
from Record import Record
from array import array
from string import split, strip, lower, upper, atof, atoi, atol, find, join
Functions   
parse_text
  parse_text  
parse_text ( s )

Classes   
DatabaseResults

Class for reading RDB files

NoBrains
SQLAlias

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/RDB_DatabaseResults.py.html0100600000176200017510000002010407306455615027761 0ustar dhellmanndevel Class: DatabaseResults

Table of Contents

Class: DatabaseResults Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/RDB.py

Class for reading RDB files

Methods   
__getitem__
__init__
__len__
_searchable_result_columns
data_dictionary
names
  __getitem__  
__getitem__ ( self,  index )

Exceptions   
ValueError, ("""Invalid value, %s, for %s in record %s""" %( fields [ i ], self._names [ i ], index ) )
ValueError, ("""The number of items in record %s is invalid 
%s\n%s\n%s\n%s
""" %( index, ( '=' * 40 ), line, ( '=' * 40 ), fields ) )
  __init__  
__init__ (
        self,
        file,
        brains=NoBrains,
        parent=None,
        zbrains=None,
        )

Exceptions   
ValueError, 'Duplicate column name, %s' % name
ValueError, 'Empty column name, %s' % name
ValueError, 'No column definitions'
ValueError, 'No column names'
ValueError, ( """The number of column names and the number of column definitions are different.""" )
ValueError, ('Empty column definition for %s' % names [ i ] )
ValueError, ('Invalid column definition for, %s, for %s' % _def, names [ i ] )
  __len__  
__len__ ( self )

  _searchable_result_columns  
_searchable_result_columns ( self )

  data_dictionary  
data_dictionary ( self )

  names  
names ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/RDB_NoBrains.py.html0100600000176200017510000000244307306455615026414 0ustar dhellmanndevel Class: NoBrains

Table of Contents

Class: NoBrains Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/RDB.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/RDB_SQLAlias.py.html0100600000176200017510000000752407306455615026317 0ustar dhellmanndevel Class: SQLAlias

Table of Contents

Class: SQLAlias Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/RDB.py

Base Classes   
ExtensionClass.Base
Methods   
__init__
__of__
  __init__  
__init__ ( self,  name )

  __of__  
__of__ ( self,  parent )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Results.py.html0100600000176200017510000000633407306455615025656 0ustar dhellmanndevel Module: Results

Table of Contents

Module: Results Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Results.py

Imported modules   
from Acquisition import Implicit
import ExtensionClass
from Record import Record
import string
from string import strip, lower, upper, join
Classes   
NoBrains
Results

Class for providing a nice interface to DBI result data

SQLAlias

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Results_NoBrains.py.html0100600000176200017510000000244707306455615027452 0ustar dhellmanndevel Class: NoBrains

Table of Contents

Class: NoBrains Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Results.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Results_Results.py.html0100600000176200017510000002155407306455615027400 0ustar dhellmanndevel Class: Results

Table of Contents

Class: Results Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Results.py

Class for providing a nice interface to DBI result data

Methods   
__getitem__
__init__
__len__
_searchable_result_columns
asRDB
data_dictionary
dictionaries
names
tuples
  __getitem__  
__getitem__ ( self,  index )

  __init__  
__init__ (
        self,
        (,
        brains=NoBrains,
        parent=None,
        zbrains=None,
        )

Exceptions   
ValueError, 'Duplicate column name, %s' % name
ValueError, 'Empty column name, %s' % name
  __len__  
__len__ ( self )

  _searchable_result_columns  
_searchable_result_columns ( self )

  asRDB  
asRDB ( self )

  data_dictionary  
data_dictionary ( self )

  dictionaries  
dictionaries ( self )

  names  
names ( self )

  tuples  
tuples ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Results_SQLAlias.py.html0100600000176200017510000000753007306455615027346 0ustar dhellmanndevel Class: SQLAlias

Table of Contents

Class: SQLAlias Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Results.py

Base Classes   
ExtensionClass.Base
Methods   
__init__
__of__
  __init__  
__init__ ( self,  name )

  __of__  
__of__ ( self,  parent )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Search.py.html0100600000176200017510000001723707306455615025426 0ustar dhellmanndevel Module: Search

Table of Contents

Module: Search Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/Search.py

Imported modules   
from Aqueduct import custom_default_report, nicify, Args
from Globals import DTMLFile
from string import join
Functions   
ZQueryIds
_getquery
default_input_form
manage_addZSearch
  ZQueryIds  
ZQueryIds ( self )

  _getquery  
_getquery ( self,  id )

Exceptions   
AttributeError, id
  default_input_form  
default_input_form (
        arguments,
        action='query',
        tabs='',
        )

  manage_addZSearch  
manage_addZSearch (
        self,
        report_id,
        report_title,
        report_style,
        input_id,
        input_title,
        queries=[],
        REQUEST=None,
        )

add a report

Exceptions   
'Unusable Searchable Error', ("""The input searchable object, %s, has not been tested. Until it has been tested, it\'s output schema is unknown, and a report cannot be generated. Before creating a report from this query, you must try out the query. To try out the query, click here. """ %( q.title_and_id(), url ) )
ValueError, ( 'No input id were specified' )
ValueError, ( 'No report id were specified' )
ValueError, ( 'No searchable objects were selected' )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/THUNK.py.html0100600000176200017510000000544407306455615025107 0ustar dhellmanndevel Module: THUNK

Table of Contents

Module: THUNK Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/THUNK.py

Imported modules   
import TM
from TM import Surrogate
import ThreadLock
Classes   
THUNKED_TM

A big heavy hammer for handling non-thread safe DAs

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/THUNK_THUNKED_TM.py.html0100600000176200017510000001103307306455615026660 0ustar dhellmanndevel Class: THUNKED_TM

Table of Contents

Class: THUNKED_TM Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/THUNK.py

A big heavy hammer for handling non-thread safe DAs

Base Classes   
TM.TM
Methods   
_register
abort
tpc_finish
  _register  
_register ( self )

  abort  
abort ( self,  *ignored )

  tpc_finish  
tpc_finish ( self,  *ignored )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/TM.py.html0100600000176200017510000000427207306455615024534 0ustar dhellmanndevel Module: TM

Table of Contents

Module: TM Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/TM.py

Provide support for linking an external transaction manager with Zope's

Classes   
Surrogate
TM

Mix-in class that provides transaction management support

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/TM_Surrogate.py.html0100600000176200017510000000501107306455615026557 0ustar dhellmanndevel Class: Surrogate

Table of Contents

Class: Surrogate Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/TM.py

Methods   
__init__
  __init__  
__init__ ( self,  db )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/TM_TM.py.html0100600000176200017510000001562007306455615025133 0ustar dhellmanndevel Class: TM

Table of Contents

Class: TM Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/TM.py

Mix-in class that provides transaction management support

A sub class should call self._register() whenever it performs any transaction-dependent operations (e.g. sql statements).

The sub class will need to override _finish, to finallize work, _abort, to roll-back work, and perhaps _begin, if any work is needed at the start of a transaction.

Methods   
_abort
_begin
_finish
_register
abort
tpc_begin
tpc_finish
  _abort  
_abort ( self )

  _begin  
_begin ( self )

  _finish  
_finish ( self )

  _register  
_register ( self )

  abort  
abort ( self,  *ignored )

  tpc_begin  
tpc_begin ( self,  *ignored )

  tpc_finish  
tpc_finish ( self,  *ignored )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/__init__.py.html0100600000176200017510000000245207306455615025751 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/dbi_db.py.html0100600000176200017510000000555107306455615025420 0ustar dhellmanndevel Module: dbi_db

Table of Contents

Module: dbi_db Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/dbi_db.py

Imported modules   
import string
from string import strip, split, find, join
import sys
Classes   
DB

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/dbi_db_DB.py.html0100600000176200017510000002040707306455615025762 0ustar dhellmanndevel Class: DB

Table of Contents

Class: DB Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/dbi_db.py

Methods   
Database_Connection
__inform_abort__
__inform_commit__
__init__
query
register
str
  Database_Connection  
Database_Connection ( self,  string )

Exceptions   
'ImplementedBySubclass', ( 'attempt to create a database connection for an abstract dbi' )
  __inform_abort__  
__inform_abort__ ( self,  *ignored )

  __inform_commit__  
__inform_commit__ ( self,  *ignored )

  __init__  
__init__ ( self,  connection )

  query  
query (
        self,
        query_string,
        max_rows=9999999,
        )

Exceptions   
'Query Error', 'empty query'
'Query Error', ( 'select in multiple sql-statement query' )
sys.exc_info()
  register  
register ( self )

  str  
str (
        self,
        v,
        StringType=type( '' ),
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/sqlgroup.py.html0100600000176200017510000001237107306455615026067 0ustar dhellmanndevel Module: sqlgroup

Table of Contents

Module: sqlgroup Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/sqlgroup.py

Inserting optional tests with sqlgroup

It is sometimes useful to make inputs to an SQL statement optinal. Doing so can be difficult, because not only must the test be inserted conditionally, but SQL boolean operators may or may not need to be inserted depending on whether other, possibly optional, comparisons have been done. The sqlgroup tag automates the conditional insertion of boolean operators.

The sqlgroup tag is a block tag. It can have any number of and and or continuation tags.

The sqlgroup tag has an optional attribure, required to specify groups that must include at least one test. This is useful when you want to make sure that a query is qualified, but want to be very flexible about how it is qualified.

Suppose we want to find people with a given first or nick name, city or minimum and maximum age. Suppose we want all inputs to be optional, but want to require some input. We can use DTML source like the following:

      &lt;dtml-sqlgroup required&gt;
        &lt;dtml-sqlgroup&gt;
          &lt;dtml-sqltest name column=nick_name type=nb multiple optional&gt;
        &lt;dtml-or&gt;
          &lt;dtml-sqltest name column=first_name type=nb multiple optional&gt;
        &lt;/dtml-sqlgroup&gt;
      &lt;dtml-and&gt;
        &lt;dtml-sqltest home_town type=nb optional&gt;
      &lt;dtml-and&gt;
        &lt;dtml-if minimum_age&gt;
           age &gt;= &lt;dtml-sqlvar minimum_age type=int&gt;
        &lt;/dtml-if&gt;
      &lt;dtml-and&gt;
        &lt;dtml-if maximum_age&gt;
           age &lt;= &lt;dtml-sqlvar maximum_age type=int&gt;
        &lt;/dtml-if&gt;
      &lt;/dtml-sqlgroup&gt;

This example illustrates how groups can be nested to control boolean evaluation order. It also illustrates that the grouping facility can also be used with other DTML tags like if tags.

The sqlgroup tag checks to see if text to be inserted contains other than whitespace characters. If it does, then it is inserted with the appropriate boolean operator, as indicated by use of an and or or tag, otherwise, no text is inserted.

Imported modules   
from DocumentTemplate.DT_Util import parse_params
from string import strip, join
import sys
Classes   
SQLGroup

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/sqlgroup_SQLGroup.py.html0100600000176200017510000000756207306455615027631 0ustar dhellmanndevel Class: SQLGroup

Table of Contents

Class: SQLGroup Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/sqlgroup.py

Methods   
__init__
render
  __init__  
__init__ ( self,  blocks )

  render  
render ( self,  md )

Exceptions   
'Input Error', 'Not enough input was provided!

'

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/sqltest.py.html0100600000176200017510000001231207306455615025705 0ustar dhellmanndevel Module: sqltest

Table of Contents

Module: sqltest Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/sqltest.py

Inserting optional tests with sqlgroup

It is sometimes useful to make inputs to an SQL statement optinal. Doing so can be difficult, because not only must the test be inserted conditionally, but SQL boolean operators may or may not need to be inserted depending on whether other, possibly optional, comparisons have been done. The sqlgroup tag automates the conditional insertion of boolean operators.

The sqlgroup tag is a block tag that has no attributes. It can have any number of and and or continuation tags.

Suppose we want to find all people with a given first or nick name and optionally constrain the search by city and minimum and maximum age. Suppose we want all inputs to be optional. We can use DTML source like the following:

      &lt;dtml-sqlgroup&gt;
        &lt;dtml-sqlgroup&gt;
          &lt;dtml-sqltest name column=nick_name type=nb multiple optional&gt;
        &lt;dtml-or&gt;
          &lt;dtml-sqltest name column=first_name type=nb multiple optional&gt;
        &lt;/dtml-sqlgroup&gt;
      &lt;dtml-and&gt;
        &lt;dtml-sqltest home_town type=nb optional&gt;
      &lt;dtml-and&gt;
        &lt;dtml-if minimum_age&gt;
           age &gt;= &lt;dtml-sqlvar minimum_age type=int&gt;
        &lt;/dtml-if&gt;
      &lt;dtml-and&gt;
        &lt;dtml-if maximum_age&gt;
           age &lt;= &lt;dtml-sqlvar maximum_age type=int&gt;
        &lt;/dtml-if&gt;
      &lt;/dtml-sqlgroup&gt;

This example illustrates how groups can be nested to control boolean evaluation order. It also illustrates that the grouping facility can also be used with other DTML tags like if tags.

The sqlgroup tag checks to see if text to be inserted contains other than whitespace characters. If it does, then it is inserted with the appropriate boolean operator, as indicated by use of an and or or tag, otherwise, no text is inserted.

Imported modules   
from DocumentTemplate.DT_Util import ParseError, parse_params, name_param
from string import find, split, join, atoi, atof
import sys
from types import ListType, TupleType, StringType
Classes   
SQLTest

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/sqltest_SQLTest.py.html0100600000176200017510000001157007306455615027271 0ustar dhellmanndevel Class: SQLTest

Table of Contents

Class: SQLTest Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/sqltest.py

Methods   
__init__
render
  __init__  
__init__ ( self,  args )

Exceptions   
ParseError, ( 'invalid type, %s' % t, 'sqltest' )
ParseError, ( 'the type attribute is required', 'sqltest' )
  render  
render ( self,  md )

Exceptions   
'Missing Input', ( 'No input was provided for %s' % name )
'Multiple Values', ( 'multiple values are not allowed for %s' % name )
KeyError, key, sys.exc_info() [ 2 ]
ValueError, ( 'Invalid floating-point value for %s' % name )
ValueError, ( 'Invalid integer value for %s' % name )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/sqlvar.py.html0100600000176200017510000001036707306455615025526 0ustar dhellmanndevel Module: sqlvar

Table of Contents

Module: sqlvar Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/sqlvar.py

Inserting values with the sqlvar tag

The sqlvar tag is used to type-safely insert values into SQL text. The sqlvar tag is similar to the var tag, except that it replaces text formatting parameters with SQL type information.

The sqlvar tag has the following attributes:

name

The name of the variable to insert. As with other DTML tags, the name= prefix may be, and usually is, ommitted.

type

The data type of the value to be inserted. This attribute is required and may be one of string, int, float, or nb. The nb data type indicates a string that must have a length that is greater than 0.

optional

A flag indicating that a value is optional. If a value is optional and is not provided (or is blank when a non-blank value is expected), then the string null is inserted.

For example, given the tag:

      &lt;dtml-sqlvar x type=nb optional&gt;

if the value of x is:

      Let\'s do it

then the text inserted is:

'Let''s do it'

however, if x is ommitted or an empty string, then the value inserted is null.

Imported modules   
from DocumentTemplate.DT_Util import ParseError, parse_params, name_param
from string import find, split, join, atoi, atof
Classes   
SQLVar

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/sqlvar_SQLVar.py.html0100600000176200017510000001146707306455615026720 0ustar dhellmanndevel Class: SQLVar

Table of Contents

Class: SQLVar Zope-2-CVS-src/lib/python/Shared/DC/ZRDB/sqlvar.py

Methods   
__init__
render
  __init__  
__init__ ( self,  args )

Exceptions   
ParseError, ( 'invalid type, %s' % t, 'dtvar' )
ParseError, ( 'the type attribute is required', 'dtvar' )
  render  
render ( self,  md )

Exceptions   
'Missing Input', 'Missing input variable, %s' % name
ValueError, ( 'Invalid empty string value for %s' % name )
ValueError, ( 'Invalid floating-point value for %s' % name )
ValueError, ( 'Invalid integer value for %s' % name )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/0040700000176200017510000000000007306455617022734 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/index.html0100600000176200017510000000515107306455617024732 0ustar dhellmanndevel Zope2 CVS with ZEO: Shared.DC.xml

Table of Contents

Zope2 CVS with ZEO: Shared.DC.xml  
Modules and Packages   

Zope-2-CVS-src/lib/python/Shared/DC/xml/

__init__
ppml

Provide conversion between Python pickles and XML

pyexpat

Python Expat wrapper module, version 1.3, 15-Oct-98 ===================================================

xmllib
xyap

Yet another XML parser

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/pyexpat/0040700000176200017510000000000007306455616024425 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/pyexpat/index.html0100600000176200017510000000522407306455616026424 0ustar dhellmanndevel Zope2 CVS with ZEO: Shared.DC.xml.pyexpat

Table of Contents

Zope2 CVS with ZEO: Shared.DC.xml.pyexpat  
Modules and Packages   

Zope-2-CVS-src/lib/python/Shared/DC/xml/pyexpat/

README.html

Python Expat wrapper module, version 1.3, 15-Oct-98 ===================================================

__init__
_checkversion

This file (which is sourced, not imported) checks the version of the

pyexpat
pyexpattest

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/pyexpat/__init__.py.html0100600000176200017510000000367307306455615027510 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Shared/DC/xml/pyexpat/__init__.py

Imported modules   
from pyexpat import *

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/pyexpat/_checkversion.py.html0100600000176200017510000000405107306455615030562 0ustar dhellmanndevel Module: _checkversion

Table of Contents

Module: _checkversion Zope-2-CVS-src/lib/python/Shared/DC/xml/pyexpat/_checkversion.py

This file (which is sourced, not imported) checks the version of the "versioncheck" package. It is also an example of how to format your own _checkversion.py file

Imported modules   
import pyversioncheck

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/pyexpat/pyexpat.py.html0100600000176200017510000000363407306455615027440 0ustar dhellmanndevel Module: pyexpat

Table of Contents

Module: pyexpat Zope-2-CVS-src/lib/python/Shared/DC/xml/pyexpat/pyexpat.py

Imported modules   
from dcpyexpat import *

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/pyexpat/pyexpattest.py.html0100600000176200017510000000550307306455615030335 0ustar dhellmanndevel Module: pyexpattest

Table of Contents

Module: pyexpattest Zope-2-CVS-src/lib/python/Shared/DC/xml/pyexpat/pyexpattest.py

Imported modules   
import os
import pyexpat
import sys
Classes   
Outputter

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/pyexpat/pyexpattest_Outputter.py.html0100600000176200017510000001246407306455615032434 0ustar dhellmanndevel Class: Outputter

Table of Contents

Class: Outputter Zope-2-CVS-src/lib/python/Shared/DC/xml/pyexpat/pyexpattest.py

Methods   
__init__
cdata
endelt
inst
startelt
  __init__  
__init__ ( self,  verbose=0 )

  cdata  
cdata ( self,  data )

  endelt  
endelt ( self,  name )

  inst  
inst (
        self,
        target,
        data,
        )

  startelt  
startelt (
        self,
        name,
        attrs,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/pyexpat/README.html0100600000176200017510000001063407306455616026253 0ustar dhellmanndevel Zope2 CVS with ZEO: Shared.DC.xml.pyexpat

Table of Contents

Zope2 CVS with ZEO: Shared.DC.xml.pyexpat  

Python Expat wrapper module, version 1.3, 15-Oct-98 ===================================================

If you have downloaded the binary distribution for the macintosh you can skip the "building" sections and go straight to the "using" bit. If you are using a macintosh and do want to build from source you should get the pyexpat.tgz distribution (Stuffit Expander with Expander Enhancer will know how to unpack a gzipped tar file).

Changes since version 1.2 -------------------------

Minimal changes, really: a memory leak in the callback routine was plugged, and exceptions in the callback are now passed through to the mainline code. The module also exports a version attribute.

Building the pyexpat module under unix --------------------------------------

  • Build libexpat.a in expat. This version is very slightly different from the original by James Clark (the libexpat.a target was added, and a few C++ comments were replaced by C comments). - Edit Makefile.pre.in and set your installdir - make -f Makefile.pre.in VERSION=1.5.1 Makefile - make sharedmods - put the shared module somewhere in your sys.path

(if you want a static Python edit Setup.in, and replace the last line with "make").

Building the pyexpat module on the macintosh -------------------------------------------- - Unpack the various .hqx project files. - All the projects are linked, so building pyexpat.prj should build everything. If this doesn't work you will find the library subprojects to build in the expat folder. - Use EditPythonPrefs to add the current folder to sys.path.

Using the pyexpat module -----------------------

The pyexpat module exports two functions: ParserCreate(encoding) Creates a new parser object. The optional encoding arg (a string) specifies the encoding. ErrorString(number) Return a string corresponding to the given error number.

Parser objects have one method: Parse(data, isfinal) Parse some data. If the optional isfinal arg is 1 this is the last bit of data. Returns true if parsing succeeded (so far), otherwise the error attributes have information on the error.

Parser objects have the following attributes:

StartElementHandler, EndElementHandler, CharacterDataHandler, ProcessingInstructionHandler - The Python handlers called for various events. See below for the signatures. ErrorCode, ErrorLineNumber, ErrorColumnNumber, ErrorByteIndex - Readonly integers giving information on the current parse error.

Testing it ----------

There's a very minimal test script in expattest.py. It should be easy to adapt it to generate ESIS (but I'm not familiar enough with ESIS to do it). This module parsed Hamlet in 2 seconds on an 180 Mhz R5000 SGI O2.

Feedback --------

This module currently lives at ftp://ftp.cwi.nl/pub/jack/python/pyexpatsrc.tgz (source) and ftp://ftp.cwi.nl/pub/jack/python/pyexpat.hqx (macintosh binary-only).

The author is Jack Jansen, jack@cwi.nl. The expat proper was written by James Clark and can be found at http://www.jclark.com/xml/ .

Jack Jansen, CWI, Amsterdam jack@cwi.nl

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/__init__.py.html0100600000176200017510000000245107306455616026010 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Shared/DC/xml/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py.html0100600000176200017510000006567207306455616025237 0ustar dhellmanndevel Module: ppml

Table of Contents

Module: ppml Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Provide conversion between Python pickles and XML

Imported modules   
import base64
import marshal
import pickle
from pickle import *, mloads, mdumps
import string
from string import replace
import struct
import tempfile
import xyap
Functions   
ToXMLload
ToXMLloads
convert
end_dictionary
end_list
end_string
end_tuple
name
p64
save_dict
 save_float
save_global
save_int
save_list
save_object
save_persis
save_put
save_reference
save_string
save_tuple
 start_pickle
test
test1
test2
test3
u64
unconvert
xmlstr
  ToXMLload  
ToXMLload ( file )

  ToXMLloads  
ToXMLloads ( str )

  convert  
convert ( S,  find=string.find )

  end_dictionary  
end_dictionary (
        self,
        tag,
        data,
        )

  end_list  
end_list (
        self,
        tag,
        data,
        )

  end_string  
end_string (
        self,
        tag,
        data,
        )

  end_tuple  
end_tuple (
        self,
        tag,
        data,
        )

  name  
name (
        self,
        tag,
        data,
        join=string.join,
        strip=string.strip,
        )

  p64  
p64 ( v,  pack=struct.pack )

  save_dict  
save_dict (
        self,
        tag,
        data,
        )

  save_float  
save_float (
        self,
        tag,
        data,
        )

  save_global  
save_global (
        self,
        tag,
        data,
        )

  save_int  
save_int (
        self,
        tag,
        data,
        )

  save_list  
save_list (
        self,
        tag,
        data,
        )

  save_object  
save_object (
        self,
        tag,
        data,
        )

  save_persis  
save_persis (
        self,
        tag,
        data,
        )

  save_put  
save_put (
        self,
        v,
        attrs,
        )

  save_reference  
save_reference (
        self,
        tag,
        data,
        )

  save_string  
save_string (
        self,
        tag,
        data,
        )

  save_tuple  
save_tuple (
        self,
        tag,
        data,
        )

  start_pickle  
start_pickle (
        self,
        tag,
        attrs,
        )

  test  
test ()

  test1  
test1 ()

  test2  
test2 ()

  test3  
test3 ()

  u64  
u64 ( v,  unpack=struct.unpack )

  unconvert  
unconvert ( encoding,  S )

  xmlstr  
xmlstr ( v )

Classes   
C
Collection
Dictionary
Float
Global
Int
Key
Klass
List
Long
NoBlanks
Object
Persistent
Pickle
Reference
Scalar
Sequence
State
String
ToXMLUnpickler
Tuple
Value
Wrapper
none
xmlPickler
xmlUnpickler

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_C.py.html0100600000176200017510000000477007306455616025471 0ustar dhellmanndevel Class: C

Table of Contents

Class: C Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Methods   
__cmp__
  __cmp__  
__cmp__ ( self,  other )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_Collection.py.html0100600000176200017510000000501507306455616027373 0ustar dhellmanndevel Class: Collection

Table of Contents

Class: Collection Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Methods   
__str__
  __str__  
__str__ ( self,  indent=0 )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_Dictionary.py.html0100600000176200017510000001240207306455616027403 0ustar dhellmanndevel Class: Dictionary

Table of Contents

Class: Dictionary Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
Collection
Methods   
__init__
__len__
__setitem__
value
  __init__  
__init__ ( self )

  __len__  
__len__ ( self )

  __setitem__  
__setitem__ (
        self,
        k,
        v,
        )

  value  
value ( self,  indent )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_Float.py.html0100600000176200017510000000371107306455616026346 0ustar dhellmanndevel Class: Float

Table of Contents

Class: Float Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
Scalar

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_Global.py.html0100600000176200017510000000635007306455616026503 0ustar dhellmanndevel Class: Global

Table of Contents

Class: Global Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Methods   
__init__
__str__
  __init__  
__init__ (
        self,
        module,
        name,
        )

  __str__  
__str__ ( self,  indent=0 )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_Int.py.html0100600000176200017510000000370507306455616026036 0ustar dhellmanndevel Class: Int

Table of Contents

Class: Int Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
Scalar

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_Key.py.html0100600000176200017510000000370707306455616026036 0ustar dhellmanndevel Class: Key

Table of Contents

Class: Key Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
Wrapper

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_Klass.py.html0100600000176200017510000000371307306455616026360 0ustar dhellmanndevel Class: Klass

Table of Contents

Class: Klass Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
Wrapper

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_List.py.html0100600000176200017510000000401507306455616026212 0ustar dhellmanndevel Class: List

Table of Contents

Class: List Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
Sequence

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_Long.py.html0100600000176200017510000000623007306455616026177 0ustar dhellmanndevel Class: Long

Table of Contents

Class: Long Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
Scalar
Methods   
value
  value  
value ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_NoBlanks.py.html0100600000176200017510000000503107306455616027005 0ustar dhellmanndevel Class: NoBlanks

Table of Contents

Class: NoBlanks Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Methods   
handle_data
  handle_data  
handle_data ( self,  data )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_Object.py.html0100600000176200017510000000775307306455616026521 0ustar dhellmanndevel Class: Object

Table of Contents

Class: Object Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
Sequence
Methods   
__init__
__setstate__
  __init__  
__init__ (
        self,
        klass,
        args,
        )

  __setstate__  
__setstate__ ( self,  v )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_Persistent.py.html0100600000176200017510000000372507306455616027446 0ustar dhellmanndevel Class: Persistent

Table of Contents

Class: Persistent Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
Wrapper

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_Pickle.py.html0100600000176200017510000000371507306455616026514 0ustar dhellmanndevel Class: Pickle

Table of Contents

Class: Pickle Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
Wrapper

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_Reference.py.html0100600000176200017510000000755707306455616027213 0ustar dhellmanndevel Class: Reference

Table of Contents

Class: Reference Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
Scalar
Methods   
__init__
__str__
  __init__  
__init__ ( self,  v )

  __str__  
__str__ ( self,  indent=0 )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_Scalar.py.html0100600000176200017510000000754207306455616026514 0ustar dhellmanndevel Class: Scalar

Table of Contents

Class: Scalar Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Methods   
__init__
__str__
value
  __init__  
__init__ ( self,  v )

  __str__  
__str__ ( self,  indent=0 )

  value  
value ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_Sequence.py.html0100600000176200017510000001231307306455616027047 0ustar dhellmanndevel Class: Sequence

Table of Contents

Class: Sequence Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
Collection
Methods   
__init__
__len__
append
value
  __init__  
__init__ ( self,  v=None )

  __len__  
__len__ ( self )

  append  
append ( self,  v )

  value  
value ( self,  indent )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_State.py.html0100600000176200017510000000371307306455616026363 0ustar dhellmanndevel Class: State

Table of Contents

Class: State Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
Wrapper

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_String.py.html0100600000176200017510000000762607306455616026560 0ustar dhellmanndevel Class: String

Table of Contents

Class: String Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
Scalar
Methods   
__init__
__str__
  __init__  
__init__ (
        self,
        v,
        encoding='',
        )

  __str__  
__str__ ( self,  indent=0 )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_ToXMLUnpickler.py.html0100600000176200017510000005707107306455616030131 0ustar dhellmanndevel Class: ToXMLUnpickler

Table of Contents

Class: ToXMLUnpickler Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
Unpickler
Methods   
load
load_binfloat
load_binget
load_binint
load_binint1
load_binint2
load_binput
load_binstring
load_dict
load_empty_dictionary
 load_empty_list
load_empty_tuple
load_float
load_get
load_global
load_inst
load_int
load_list
load_long
load_long_binget
 load_long_binput
load_none
load_obj
load_persid
load_put
load_reduce
load_short_binstring
load_string
load_tuple
persistent_load
  load  
load ( self )

  load_binfloat  
load_binfloat ( self,  unpack=struct.unpack )

  load_binget  
load_binget ( self )

  load_binint  
load_binint ( self )

  load_binint1  
load_binint1 ( self )

  load_binint2  
load_binint2 ( self )

  load_binput  
load_binput ( self )

  load_binstring  
load_binstring ( self )

  load_dict  
load_dict ( self )

  load_empty_dictionary  
load_empty_dictionary ( self )

  load_empty_list  
load_empty_list ( self )

  load_empty_tuple  
load_empty_tuple ( self )

  load_float  
load_float ( self )

  load_get  
load_get ( self )

  load_global  
load_global ( self )

  load_inst  
load_inst ( self )

  load_int  
load_int ( self )

  load_list  
load_list ( self )

  load_long  
load_long ( self )

  load_long_binget  
load_long_binget ( self )

  load_long_binput  
load_long_binput ( self )

  load_none  
load_none ( self )

  load_obj  
load_obj ( self )

  load_persid  
load_persid ( self )

  load_put  
load_put ( self )

  load_reduce  
load_reduce ( self )

  load_short_binstring  
load_short_binstring ( self )

  load_string  
load_string ( self )

  load_tuple  
load_tuple ( self )

  persistent_load  
persistent_load ( self,  v )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_Tuple.py.html0100600000176200017510000000401707306455616026372 0ustar dhellmanndevel Class: Tuple

Table of Contents

Class: Tuple Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
Sequence

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_Value.py.html0100600000176200017510000000371307306455616026357 0ustar dhellmanndevel Class: Value

Table of Contents

Class: Value Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
Wrapper

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_Wrapper.py.html0100600000176200017510000000754407306455616026731 0ustar dhellmanndevel Class: Wrapper

Table of Contents

Class: Wrapper Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Methods   
__init__
__str__
value
  __init__  
__init__ ( self,  v )

  __str__  
__str__ ( self,  indent=0 )

  value  
value ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_none.py.html0100600000176200017510000000500107306455616026232 0ustar dhellmanndevel Class: none

Table of Contents

Class: none Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Methods   
__str__
  __str__  
__str__ ( self,  indent=0 )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_xmlPickler.py.html0100600000176200017510000000374007306455616027415 0ustar dhellmanndevel Class: xmlPickler

Table of Contents

Class: xmlPickler Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
NoBlanks
xyap

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml_xmlUnpickler.py.html0100600000176200017510000000374407306455616027764 0ustar dhellmanndevel Class: xmlUnpickler

Table of Contents

Class: xmlUnpickler Zope-2-CVS-src/lib/python/Shared/DC/xml/ppml.py

Base Classes   
NoBlanks
xyap

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/xmllib.py.html0100600000176200017510000001011407306455616025533 0ustar dhellmanndevel Module: xmllib

Table of Contents

Module: xmllib Zope-2-CVS-src/lib/python/Shared/DC/xml/xmllib.py

Imported modules   
import re
import string
Functions   
test
  test  
test ( args=None )

Classes   
TestXMLParser
XMLParser

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/xmllib_TestXMLParser.py.html0100600000176200017510000003301307306455616030273 0ustar dhellmanndevel Class: TestXMLParser

Table of Contents

Class: TestXMLParser Zope-2-CVS-src/lib/python/Shared/DC/xml/xmllib.py

Base Classes   
XMLParser
Methods   
__init__
close
flush
handle_cdata
handle_comment
handle_data
handle_doctype
handle_entity
handle_proc
handle_xml
 syntax_error
unknown_charref
unknown_endtag
unknown_entityref
unknown_starttag
  __init__  
__init__ ( self,  verbose=0 )

  close  
close ( self )

  flush  
flush ( self )

  handle_cdata  
handle_cdata ( self,  data )

  handle_comment  
handle_comment ( self,  data )

  handle_data  
handle_data ( self,  data )

  handle_doctype  
handle_doctype (
        self,
        tag,
        pubid,
        syslit,
        data,
        )

  handle_entity  
handle_entity (
        self,
        name,
        strval,
        pubid,
        syslit,
        ndata,
        )

  handle_proc  
handle_proc (
        self,
        name,
        data,
        )

  handle_xml  
handle_xml (
        self,
        encoding,
        standalone,
        )

  syntax_error  
syntax_error ( self,  message )

  unknown_charref  
unknown_charref ( self,  ref )

  unknown_endtag  
unknown_endtag ( self,  tag )

  unknown_entityref  
unknown_entityref ( self,  ref )

  unknown_starttag  
unknown_starttag (
        self,
        tag,
        attrs,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/xmllib_XMLParser.py.html0100600000176200017510000007441107306455616027442 0ustar dhellmanndevel Class: XMLParser

Table of Contents

Class: XMLParser Zope-2-CVS-src/lib/python/Shared/DC/xml/xmllib.py

Methods   
__init__
close
feed
finish_endtag
finish_starttag
goahead
handle_cdata
handle_charref
handle_comment
handle_data
 handle_doctype
handle_endtag
handle_entityref
handle_proc
handle_starttag
handle_xml
parse_attributes
parse_cdata
parse_comment
parse_doctype
 parse_endtag
parse_proc
parse_starttag
reset
setliteral
setnomoretags
syntax_error
translate_references
unknown_charref
unknown_endtag
  __init__  
__init__ ( self,  verbose=0 )
Interface

initialize and reset this instance

  close  
close ( self )
Interface

handle the remaining data

  feed  
feed ( self,  data )
Interface

feed some data to the parser. Call this as often as you want, with as little or as much text as you want (may include \n). (This just saves the text, all the processing is done by goahead().)

  finish_endtag  
finish_endtag ( self,  tag )
Internal

finish processing of end tag

  finish_starttag  
finish_starttag (
        self,
        tag,
        attrs,
        )
Internal

finish processing of start tag Return -1 for unknown tag, 1 for balanced tag

  goahead  
goahead ( self,  end )
Internal

handle data as far as reasonable. May leave state and data to be processed by a subsequent call. If end is true, force handling all data as if followed by EOF marker.

Exceptions   
RuntimeError, 'neither < nor & ??'
RuntimeError, 'only XML version 1.0 supported'
  handle_cdata  
handle_cdata ( self,  data )
Example

handle cdata, could be overridden

  handle_charref  
handle_charref ( self,  name )
Example

handle character reference, no need to override

  handle_comment  
handle_comment ( self,  data )
Example

handle comment, could be overridden

  handle_data  
handle_data ( self,  data )
Example

handle data, should be overridden

  handle_doctype  
handle_doctype (
        self,
        tag,
        pubid,
        syslit,
        data,
        )
Overridable

handle DOCTYPE

  handle_endtag  
handle_endtag (
        self,
        tag,
        method,
        )
Overridable

handle end tag

  handle_entityref  
handle_entityref ( self,  name )
Example

handle entity reference, no need to override

  handle_proc  
handle_proc (
        self,
        name,
        data,
        )
Example

handle processing instructions, could be overridden

  handle_starttag  
handle_starttag (
        self,
        tag,
        method,
        attrs,
        )
Overridable

handle start tag

  handle_xml  
handle_xml (
        self,
        encoding,
        standalone,
        )
Overridable

handle xml processing instruction

  parse_attributes  
parse_attributes (
        self,
        tag,
        k,
        j,
        attributes=None,
        )
Internal

parse attributes between i and j

  parse_cdata  
parse_cdata ( self,  i )
Internal

handle CDATA tag, return length or -1 if not terminated

Exceptions   
RuntimeError, 'unexpected call to parse_cdata'
  parse_comment  
parse_comment ( self,  i )
Internal

parse comment, return length or -1 if not terminated

Exceptions   
RuntimeError, 'unexpected call to handle_comment'
  parse_doctype  
parse_doctype ( self,  res )
Internal

handle DOCTYPE tag, return length or -1 if not terminated

  parse_endtag  
parse_endtag ( self,  i )
Internal

parse endtag

  parse_proc  
parse_proc ( self,  i )
Internal

handle a processing instruction tag

Exceptions   
RuntimeError, 'unexpected call to parse_proc'
  parse_starttag  
parse_starttag ( self,  i )
Internal

handle starttag, return length or -1 if not terminated

Exceptions   
RuntimeError, 'unexpected call to parse_starttag'
  reset  
reset ( self )
Interface

reset this instance. Loses all unprocessed data

  setliteral  
setliteral ( self,  *args )
For derived classes only

enter literal mode (CDATA)

  setnomoretags  
setnomoretags ( self )
For derived classes only

enter literal mode (CDATA) till EOF

  syntax_error  
syntax_error ( self,  message )
Example

handle relatively harmless syntax errors, could be overridden

Exceptions   
RuntimeError, 'Syntax error at line %d: %s' %( self.lineno, message )
  translate_references  
translate_references (
        self,
        data,
        all=1,
        )
Interface

translate references

  unknown_charref  
unknown_charref ( self,  ref )

  unknown_endtag  
unknown_endtag ( self,  tag )

  unknown_entityref  
unknown_entityref ( self,  ref )

  unknown_starttag  
unknown_starttag (
        self,
        tag,
        attrs,
        )
To be overridden

handlers for unknown objects

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/xyap.py.html0100600000176200017510000001652007306455617025235 0ustar dhellmanndevel Module: xyap

Table of Contents

Module: xyap Zope-2-CVS-src/lib/python/Shared/DC/xml/xyap.py

Yet another XML parser

This is meant to be very simple:

  • stack based

  • The parser has a table of start handlers and end handlers.

  • start tag handlers are called with the parser instance, tag names and attributes. The result is placed on the stack. The default handler places a special object on the stack (uh, a list, with the tag name and attributes as the first two elements. ;)

  • end tag handlers are called with the object on the parser, the tag name, and top of the stack right after it has been removed. The result is appended to the object on the top of the stack.

Note that namespace attributes should recieve some special handling. Oh well.

Imported modules   
from pickle import *
import string
from types import ListType
import xmllib
Functions   
name
struct
test
tuplef
  name  
name (
        self,
        tag,
        data,
        join=string.join,
        strip=string.strip,
        )

  struct  
struct (
        self,
        tag,
        data,
        )

  test  
test ()

  tuplef  
tuplef (
        self,
        tag,
        data,
        )

Classes   
NoBlanks
XYap
xmlrpc
xyap

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/xyap_NoBlanks.py.html0100600000176200017510000000503107306455617027017 0ustar dhellmanndevel Class: NoBlanks

Table of Contents

Class: NoBlanks Zope-2-CVS-src/lib/python/Shared/DC/xml/xyap.py

Methods   
handle_data
  handle_data  
handle_data ( self,  data )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/xyap_XYap.py.html0100600000176200017510000000627007306455617026177 0ustar dhellmanndevel Class: XYap

Table of Contents

Class: XYap Zope-2-CVS-src/lib/python/Shared/DC/xml/xyap.py

Base Classes   
xyap
xmllib.XMLParser
Methods   
__init__
  __init__  
__init__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/xyap_xmlrpc.py.html0100600000176200017510000000413007306455617026614 0ustar dhellmanndevel Class: xmlrpc

Table of Contents

Class: xmlrpc Zope-2-CVS-src/lib/python/Shared/DC/xml/xyap.py

Base Classes   
NoBlanks
XYap
    xyap
    xmllib.XMLParser
xmllib.XMLParser

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/xml/xyap_xyap.py.html0100600000176200017510000001124607306455617026276 0ustar dhellmanndevel Class: xyap

Table of Contents

Class: xyap Zope-2-CVS-src/lib/python/Shared/DC/xml/xyap.py

Methods   
__init__
handle_data
unknown_endtag
unknown_starttag
  __init__  
__init__ ( self )

  handle_data  
handle_data ( self,  data )

  unknown_endtag  
unknown_endtag ( self,  tag )

  unknown_starttag  
unknown_starttag (
        self,
        tag,
        attrs,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:39 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/DC/__init__.py.html0100600000176200017510000000243707306455617025215 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Shared/DC/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Shared/__init__.py.html0100600000176200017510000000242607306455617024725 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Shared/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:35 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/0040700000176200017510000000000007306455621023444 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/index.html0100600000176200017510000000734007306455621025444 0ustar dhellmanndevel Zope2 CVS with ZEO: StructuredText

Table of Contents

Zope2 CVS with ZEO: StructuredText  
Modules and Packages   

Zope-2-CVS-src/lib/python/StructuredText/

ClassicStructuredText

Structured Text Manipulation

DocBookClass
DocumentClass
DocumentWithImages
HTMLClass
HTMLWithImages
ST
STDOM

DOM implementation in StructuredText : Read-Only methods

STletters
StructuredText

Alias module for StructuredTextClassic compatibility which makes

Zwiki
__init__

Zope-2-CVS-src/lib/python/StructuredText/tests/

testStructuredText

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/ClassicStructuredText.py.html0100600000176200017510000004340207306455617031303 0ustar dhellmanndevel Module: ClassicStructuredText

Table of Contents

Module: ClassicStructuredText Zope-2-CVS-src/lib/python/StructuredText/ClassicStructuredText.py

Structured Text Manipulation

Parse a structured text string into a form that can be used with structured formats, like html.

Structured text is text that uses indentation and simple symbology to indicate the structure of a document.

A structured string consists of a sequence of paragraphs separated by one or more blank lines. Each paragraph has a level which is defined as the minimum indentation of the paragraph. A paragraph is a sub-paragraph of another paragraph if the other paragraph is the last preceding paragraph that has a lower level.

Special symbology is used to indicate special constructs:

  • A single-line paragraph whose immediately succeeding paragraphs are lower level is treated as a header.

  • A paragraph that begins with a -, *, or o is treated as an unordered list (bullet) element.

  • A paragraph that begins with a sequence of digits followed by a white-space character is treated as an ordered list element.

  • A paragraph that begins with a sequence of sequences, where each sequence is a sequence of digits or a sequence of letters followed by a period, is treated as an ordered list element.

  • A paragraph with a first line that contains some text, followed by some white-space and -- is treated as a descriptive list element. The leading text is treated as the element title.

  • Sub-paragraphs of a paragraph that ends in the word example or the word examples, or :: is treated as example code and is output as is.

  • Text enclosed single quotes (with white-space to the left of the first quote and whitespace or punctuation to the right of the second quote) is treated as example code.

  • Text surrounded by * characters (with white-space to the left of the first * and whitespace or punctuation to the right of the second *) is emphasized.

  • Text surrounded by ** characters (with white-space to the left of the first ** and whitespace or punctuation to the right of the second **) is made strong.

  • Text surrounded by _ underscore characters (with whitespace to the left and whitespace or punctuation to the right) is made underlined.

  • Text encloded by double quotes followed by a colon, a URL, and concluded by punctuation plus white space, or just white space, is treated as a hyper link. For example:

    Zope is ...

    Is interpreted as <a href="http://www.zope.org/">Zope</a> is .... Note: This works for relative as well as absolute URLs.

  • Text enclosed by double quotes followed by a comma, one or more spaces, an absolute URL and concluded by punctuation plus white space, or just white space, is treated as a hyper link. For example:

    "mail me", mailto:amos@digicool.com.

    Is interpreted as <a href="mailto:amos@digicool.com">mail me</a>.

  • Text enclosed in brackets which consists only of letters, digits, underscores and dashes is treated as hyper links within the document. For example:

    As demonstrated by Smith [12] this technique is quite effective.

    Is interpreted as ... by Smith <a href="#12">[12]</a> this .... Together with the next rule this allows easy coding of references or end notes.

  • Text enclosed in brackets which is preceded by the start of a line, two periods and a space is treated as a named link. For example:

    .. [12] "Effective Techniques" Smith, Joe ...

    Is interpreted as <a name="12">[12]</a> "Effective Techniques" .... Together with the previous rule this allows easy coding of references or end notes.

  • A paragraph that has blocks of text enclosed in || is treated as a table. The text blocks correspond to table cells and table rows are denoted by newlines. By default the cells are center aligned. A cell can span more than one column by preceding a block of text with an equivalent number of cell separators ||. Newlines and | cannot be a part of the cell text. For example:

    Ingredients
    Name Amount
    Spam 10
    Eggs 3

    is interpreted as:

        &lt;TABLE BORDER=1 CELLPADDING=2&gt;
     &lt;TR&gt;
      &lt;TD ALIGN=CENTER COLSPAN=2&gt; &lt;strong&gt;Ingredients&lt;/strong&gt; &lt;/TD&gt;
     &lt;/TR&gt;
     &lt;TR&gt;
      &lt;TD ALIGN=CENTER COLSPAN=1&gt; &lt;em&gt;Name&lt;/em&gt; &lt;/TD&gt;
      &lt;TD ALIGN=CENTER COLSPAN=1&gt; &lt;em&gt;Amount&lt;/em&gt; &lt;/TD&gt;
     &lt;/TR&gt;
     &lt;TR&gt;
      &lt;TD ALIGN=CENTER COLSPAN=1&gt;Spam&lt;/TD&gt;
      &lt;TD ALIGN=CENTER COLSPAN=1&gt;10&lt;/TD&gt;
     &lt;/TR&gt;
     &lt;TR&gt;
      &lt;TD ALIGN=CENTER COLSPAN=1&gt;Eggs&lt;/TD&gt;
      &lt;TD ALIGN=CENTER COLSPAN=1&gt;3&lt;/TD&gt;
     &lt;/TR&gt;
    &lt;/TABLE&gt;

Imported modules   
import re
import regex
import string
from string import split, join, strip, find
import ts_regex
from ts_regex import gsub
Functions   
ctag
html_quote
html_with_references
indent
indent_level
main
paragraphs
reindent
structure
untabify
  ctag  
ctag (
        s,
        em=re.compile( ctag_prefix +(ctag_middle %(( "*", ) * 6 ) ) + ctag_suffix ),
        strong=re.compile( ctag_prefix +(ctag_middl2 %(( "*", ) * 8 ) ) + ctag_suffix ),
        under=re.compile( ctag_prefix +(ctag_middle %(( "_", ) * 6 ) ) + ctag_suffix ),
        code=re.compile( ctag_prefix +(ctag_middle %(( "\'", ) * 6 ) ) + ctag_suffix ),
        )

  html_quote  
html_quote ( v,  character_entities=(( re.compile( '&' ), '&amp;' ), ( re.compile( "<" ), '&lt;' ), ( re.compile( ">" ), '&gt;' ), ( re.compile( '"' ), '&quot;' ) ) )

  html_with_references  
html_with_references ( text,  level=1 )

  indent  
indent ( aString,  indent=2 )

Indent a string the given number of spaces

  indent_level  
indent_level ( aString,  indent_space=ts_regex.compile( '\n\( *\)' ).search_group )

Find the minimum indentation for a string, not counting blank lines.

  main  
main ()

  paragraphs  
paragraphs ( list,  start )

  reindent  
reindent (
        aString,
        indent=2,
        already_untabified=0,
        )

reindent a block of text, so that the minimum indent is as given

  structure  
structure ( list )

  untabify  
untabify ( aString,  indent_tab=ts_regex.compile( '\(\n\|^\)\( *\)\t' ).search_group )

Convert indentation tabs to spaces.

Classes   
HTML

An HTML structured text formatter.

StructuredText

Model text as structured collection of paragraphs.

Table

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/ClassicStructuredText_HTML.py.html0100600000176200017510000002315207306455617032127 0ustar dhellmanndevel Class: HTML

Table of Contents

Class: HTML Zope-2-CVS-src/lib/python/StructuredText/ClassicStructuredText.py

An HTML structured text formatter.

Base Classes   
StructuredText
Methods   
__str__
_str
dl
head
normal
ol
pre
table
ul
  __str__  
__str__ (
        self,
        extra_dl=re.compile( "</dl>\n<dl>" ),
        extra_ul=re.compile( "</ul>\n<ul>" ),
        extra_ol=re.compile( "</ol>\n<ol>" ),
        )

Return an HTML string representation of the structured text data.

  _str  
_str (
        self,
        structure,
        level,
        bullet=ts_regex.compile( '[ \t\n]*[o*-][ \t\n]+\([^\0]*\)' ).match_group,
        example=ts_regex.compile( '[\0- ]examples?:[\0- ]*$' ).search,
        dl=ts_regex.compile( '\([^\n]+\)[ \t]+--[ \t\n]+\([^\0]*\)' ).match_group,
        nl=ts_regex.compile( '\n' ).search,
        ol=ts_regex.compile( '[ \t]*\(\([0-9]+\|[%s]+\)[.)]\)+[ \t\n]+\([^\0]*\|$\)' % string.letters ).match_group,
        olp=ts_regex.compile( '[ \t]*([0-9]+)[ \t\n]+\([^\0]*\|$\)' ).match_group,
        )

  dl  
dl (
        self,
        before,
        t,
        d,
        after,
        )

  head  
head (
        self,
        before,
        t,
        level,
        d,
        )

  normal  
normal (
        self,
        before,
        p,
        after,
        )

  ol  
ol (
        self,
        before,
        p,
        after,
        )

  pre  
pre (
        self,
        structure,
        tagged=0,
        )

  table  
table (
        self,
        before,
        table,
        after,
        )

  ul  
ul (
        self,
        before,
        p,
        after,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/ClassicStructuredText_StructuredText.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/ClassicStructuredText_StructuredText.py0100600000176200017510000000726507306455617033440 0ustar dhellmanndevel Class: StructuredText

Table of Contents

Class: StructuredText Zope-2-CVS-src/lib/python/StructuredText/ClassicStructuredText.py

Model text as structured collection of paragraphs.

Structure is implied by the indentation level.

This class is intended as a base classes that do actual text output formatting.

Methods   
__init__
__str__
  __init__  
__init__ (
        self,
        aStructuredString,
        level=0,
        paragraph_divider=regex.compile( '\(\r?\n *\)+\r?\n' ),
        )

Convert a structured text string into a structured text object.

Aguments:

aStructuredString

The string to be parsed. level -- The level of top level headings to be created.

  __str__  
__str__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/ClassicStructuredText_Table.py.html0100600000176200017510000000641607306455617032416 0ustar dhellmanndevel Class: Table

Table of Contents

Class: Table Zope-2-CVS-src/lib/python/StructuredText/ClassicStructuredText.py

Methods   
create
html
  create  
create (
        self,
        aPar,
        td_reg=re.compile( r'[ \t\n]*\|\|([^\0x00|]*)' ),
        )

parses a table and returns nested list representing the table

  html  
html ( self )

Creates an HTML representation of table

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocBookClass.py.html0100600000176200017510000001114107306455617027271 0ustar dhellmanndevel Module: DocBookClass

Table of Contents

Module: DocBookClass Zope-2-CVS-src/lib/python/StructuredText/DocBookClass.py

Imported modules   
import string
from string import join, split, find, lstrip
Functions   
prestrip
  prestrip  
prestrip ( v )

Classes   
DocBookArticle
DocBookBook
DocBookChapter
DocBookChapterWithFigures
DocBookClass

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocBookClass_DocBookArticle.py.html0100600000176200017510000000641107306455617032201 0ustar dhellmanndevel Class: DocBookArticle

Table of Contents

Class: DocBookArticle Zope-2-CVS-src/lib/python/StructuredText/DocBookClass.py

Base Classes   
DocBookClass
Methods   
document
  document  
document (
        self,
        doc,
        level,
        output,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocBookClass_DocBookBook.py.html0100600000176200017510000001105007306455617031503 0ustar dhellmanndevel Class: DocBookBook

Table of Contents

Class: DocBookBook Zope-2-CVS-src/lib/python/StructuredText/DocBookClass.py

Methods   
__init__
__str__
addChapter
read
  __init__  
__init__ ( self,  title='' )

  __str__  
__str__ ( self )

  addChapter  
addChapter ( self,  chapter )

  read  
read ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocBookClass_DocBookChapter.py.html0100600000176200017510000000641107306455617032204 0ustar dhellmanndevel Class: DocBookChapter

Table of Contents

Class: DocBookChapter Zope-2-CVS-src/lib/python/StructuredText/DocBookClass.py

Base Classes   
DocBookClass
Methods   
document
  document  
document (
        self,
        doc,
        level,
        output,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocBookClass_DocBookChapterWithFigures.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocBookClass_DocBookChapterWithFigures.0100600000176200017510000000654207306455617033056 0ustar dhellmanndevel Class: DocBookChapterWithFigures

Table of Contents

Class: DocBookChapterWithFigures Zope-2-CVS-src/lib/python/StructuredText/DocBookClass.py

Base Classes   
DocBookChapter
Methods   
image
  image  
image (
        self,
        doc,
        level,
        output,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocBookClass_DocBookClass.py.html0100600000176200017510000004001307306455617031657 0ustar dhellmanndevel Class: DocBookClass

Table of Contents

Class: DocBookClass Zope-2-CVS-src/lib/python/StructuredText/DocBookClass.py

Methods   
__call__
_text
bullet
description
descriptionBody
descriptionTitle
dispatch
document
emphasis
example
 link
literal
numbered
paragraph
section
sectionTitle
sgml
strong
xref
  __call__  
__call__ (
        self,
        doc,
        level=1,
        )

  _text  
_text (
        self,
        doc,
        level,
        output,
        )

  bullet  
bullet (
        self,
        doc,
        level,
        output,
        )

  description  
description (
        self,
        doc,
        level,
        output,
        )

  descriptionBody  
descriptionBody (
        self,
        doc,
        level,
        output,
        )

  descriptionTitle  
descriptionTitle (
        self,
        doc,
        level,
        output,
        )

  dispatch  
dispatch (
        self,
        doc,
        level,
        output,
        )

  document  
document (
        self,
        doc,
        level,
        output,
        )

  emphasis  
emphasis (
        self,
        doc,
        level,
        output,
        )

  example  
example (
        self,
        doc,
        level,
        output,
        )

  link  
link (
        self,
        doc,
        level,
        output,
        )

  literal  
literal (
        self,
        doc,
        level,
        output,
        )

  numbered  
numbered (
        self,
        doc,
        level,
        output,
        )

  paragraph  
paragraph (
        self,
        doc,
        level,
        output,
        )

  section  
section (
        self,
        doc,
        level,
        output,
        )

  sectionTitle  
sectionTitle (
        self,
        doc,
        level,
        output,
        )

  sgml  
sgml (
        self,
        doc,
        level,
        output,
        )

  strong  
strong (
        self,
        doc,
        level,
        output,
        )

  xref  
xref (
        self,
        doc,
        level,
        output,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py.html0100600000176200017510000002114007306455620027521 0ustar dhellmanndevel Module: DocumentClass

Table of Contents

Module: DocumentClass Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Imported modules   
import ST
import STDOM
from STletters import *
import re
from string import split, join, replace, expandtabs, strip, find, rstrip
Functions   
flatten
  flatten  
flatten ( obj,  append )

Classes   
DocumentClass

Class instance calls [ex.=> x()] require a structured text

StructuredTextBullet

Represents a section of a document with a title and a body

StructuredTextColumn

StructuredTextColumn is a cell/column in a table.

StructuredTextDescription

Represents a section of a document with a title and a body

StructuredTextDescriptionBody

Represents a section of a document with a title and a body

StructuredTextDescriptionTitle

Represents a section of a document with a title and a body

StructuredTextEmphasis
StructuredTextExample

Represents a section of document with literal text, as for examples

StructuredTextInnerLink
StructuredTextLink
StructuredTextLiteral
StructuredTextMarkup
StructuredTextNamedLink
StructuredTextNumbered

Represents a section of a document with a title and a body

StructuredTextRow

StructuredTextRow holds StructuredTextColumns

StructuredTextSGML
StructuredTextSection

Represents a section of a document with a title and a body

StructuredTextSectionTitle

Represents a section of a document with a title and a body

StructuredTextStrong
StructuredTextTable

rows is a list of lists containing tuples, which

StructuredTextTableData
StructuredTextTableHeader
StructuredTextUnderline
StructuredTextXref

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_DocumentClass.py.html0100600000176200017510000004250507306455617032363 0ustar dhellmanndevel Class: DocumentClass

Table of Contents

Class: DocumentClass Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Class instance calls [ex.=> x()] require a structured text structure. Doc will then parse each paragraph in the structure and will find the special structures within each paragraph. Each special structure will be stored as an instance. Special structures within another special structure are stored within the top structure EX : -underline this- => would be turned into an underline instance. -underline **this** would be stored as an underline instance with a strong instance stored in its string

Methods   
__call__
color_paragraphs
color_text
doc_bullet
doc_description
doc_emphasize
doc_header
doc_href
doc_inner_link
doc_literal
 doc_named_link
doc_numbered
doc_sgml
doc_strong
doc_table
doc_underline
doc_xref
parse
  __call__  
__call__ ( self,  doc )

  color_paragraphs  
color_paragraphs (
        self,
        raw_paragraphs,
        type=type,
        sequence_types=(type([] ), type(() ) ),
        st=type( '' ),
        )

  color_text  
color_text (
        self,
        str,
        types=None,
        )

Search the paragraph for each special structure

  doc_bullet  
doc_bullet (
        self,
        paragraph,
        expr=re.compile( r'\s*[-*o]\s+' ).match,
        )

  doc_description  
doc_description (
        self,
        paragraph,
        delim=re.compile( r'\s+--\s+' ).search,
        nb=re.compile( r'[^\000- ]' ).search,
        )

  doc_emphasize  
doc_emphasize (
        self,
        s,
        expr=re.compile( r'\s*\*([ \n%s0-9]+)\*(?!\*|-)' % lettpunc ).search,
        )

  doc_header  
doc_header (
        self,
        paragraph,
        expr=re.compile( r'[ %s0-9.:/,-_*<>\?\'\"]+' % letters ).match,
        )

  doc_href  
doc_href (
        self,
        s,
        expr1=re.compile( _DQUOTEDTEXT + "(:)" + _URL_AND_PUNC + _SPACES ).search,
        expr2=re.compile( _DQUOTEDTEXT + r'(\,\s+)' + _URL_AND_PUNC + _SPACES ).search,
        )

  doc_inner_link  
doc_inner_link (
        self,
        s,
        expr1=re.compile( r"\.\.\s*" ).search,
        expr2=re.compile( r"\[[%s0-9]+\]" % letters ).search,
        )

  doc_literal  
doc_literal (
        self,
        s,
        expr=re.compile( r"(?:\s|^)'" r"([^ \t\n\r\f\v']|[^ \t\n\r\f\v'][^\n']*[^ \t\n\r\f\v'])" r"'(?:\s|[,.;:!?]|$)" ).search,
        )

  doc_named_link  
doc_named_link (
        self,
        s,
        expr=re.compile( r"(\.\.\s)(\[[%s0-9]+\])" % letters ).search,
        )

  doc_numbered  
doc_numbered (
        self,
        paragraph,
        expr=re.compile( r'(\s*[%s]+\.)|(\s*[0-9]+\.)|(\s*[0-9]+\s+)' % letters ).match,
        )

  doc_sgml  
doc_sgml (
        self,
        s,
        expr=re.compile( r"\<[%s0-9\.\=\'\"\:\/\-\#\+\s\*]+\>" % letters ).search,
        )

SGML text is ignored and outputed as-is

  doc_strong  
doc_strong (
        self,
        s,
        expr=re.compile( r'\s*\*\*([ \n%s0-9]+)\*\*' % lettpunc ).search,
        )

  doc_table  
doc_table (
        self,
        paragraph,
        expr=re.compile( r'\s*\|[-]+\|' ).match,
        )

  doc_underline  
doc_underline (
        self,
        s,
        expr=re.compile( r"\s+\_([%s0-9\s]+)\_" % lettpunc ).search,
        )

  doc_xref  
doc_xref (
        self,
        s,
        expr=re.compile( '\[([%s0-9\-.:/;,\n\~]+)\]' % letters ).search,
        )

  parse  
parse (
        self,
        raw_string,
        text_type,
        type=type,
        st=type( '' ),
        lt=type([] ),
        )

Parse accepts a raw_string, an expr to test the raw_string, and the raw_string's subparagraphs.

Parse will continue to search through raw_string until all instances of expr in raw_string are found.

If no instances of expr are found, raw_string is returned. Otherwise a list of substrings and instances is returned

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextBullet.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextBullet.py.h0100600000176200017510000000375107306455617033263 0ustar dhellmanndevel Class: StructuredTextBullet

Table of Contents

Class: StructuredTextBullet Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Represents a section of a document with a title and a body

Base Classes   
ST.StructuredTextParagraph

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextColumn.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextColumn.py.h0100600000176200017510000002160607306455617033270 0ustar dhellmanndevel Class: StructuredTextColumn

Table of Contents

Class: StructuredTextColumn Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

StructuredTextColumn is a cell/column in a table. A cell can hold multiple paragraphs. The cell is either classified as a StructuredTextTableHeader or StructuredTextTableData.

this holds the text of a table cell

Base Classes   
ST.StructuredTextParagraph
Methods   
__init__
_getAlign
_getSpan
_getType
_getValign
getAlign
getSpan
getType
getValign
  __init__  
__init__ (
        self,
        text,
        span,
        align,
        valign,
        typ,
        kw,
        )

  _getAlign  
_getAlign ( self )

  _getSpan  
_getSpan ( self )

  _getType  
_getType ( self )

  _getValign  
_getValign ( self )

  getAlign  
getAlign ( self )

  getSpan  
getSpan ( self )

  getType  
getType ( self )

  getValign  
getValign ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextDescription.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextDescription0100600000176200017510000001267307306455617033445 0ustar dhellmanndevel Class: StructuredTextDescription

Table of Contents

Class: StructuredTextDescription Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Represents a section of a document with a title and a body

Base Classes   
ST.StructuredTextParagraph
Methods   
__init__
getChildren
getColorizableTexts
setColorizableTexts
  __init__  
__init__ (
        self,
        title,
        src,
        subs,
        **kw,
        )

  getChildren  
getChildren ( self )

  getColorizableTexts  
getColorizableTexts ( self )

  setColorizableTexts  
setColorizableTexts ( self,  src )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016000000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextDescriptionBody.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextDescription0100600000176200017510000000377307306455617033446 0ustar dhellmanndevel Class: StructuredTextDescriptionBody

Table of Contents

Class: StructuredTextDescriptionBody Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Represents a section of a document with a title and a body

Base Classes   
ST.StructuredTextParagraph

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016100000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextDescriptionTitle.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextDescription0100600000176200017510000000377507306455617033450 0ustar dhellmanndevel Class: StructuredTextDescriptionTitle

Table of Contents

Class: StructuredTextDescriptionTitle Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Represents a section of a document with a title and a body

Base Classes   
ST.StructuredTextParagraph

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextEmphasis.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextEmphasis.py0100600000176200017510000000405507306455617033355 0ustar dhellmanndevel Class: StructuredTextEmphasis

Table of Contents

Class: StructuredTextEmphasis Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Base Classes   
StructuredTextMarkup
    STDOM.Element

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextExample.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextExample.py.0100600000176200017510000001133507306455617033254 0ustar dhellmanndevel Class: StructuredTextExample

Table of Contents

Class: StructuredTextExample Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Represents a section of document with literal text, as for examples

Base Classes   
ST.StructuredTextParagraph
Methods   
__init__
getColorizableTexts
setColorizableTexts
  __init__  
__init__ (
        self,
        subs,
        **kw,
        )

  getColorizableTexts  
getColorizableTexts ( self )

  setColorizableTexts  
setColorizableTexts ( self,  src )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextInnerLink.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextInnerLink.p0100600000176200017510000000405707306455617033306 0ustar dhellmanndevel Class: StructuredTextInnerLink

Table of Contents

Class: StructuredTextInnerLink Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Base Classes   
StructuredTextMarkup
    STDOM.Element

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextLink.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextLink.py.htm0100600000176200017510000000404507306455617033267 0ustar dhellmanndevel Class: StructuredTextLink

Table of Contents

Class: StructuredTextLink Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Base Classes   
StructuredTextMarkup
    STDOM.Element

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextLiteral.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextLiteral.py.0100600000176200017510000001006107306455620033242 0ustar dhellmanndevel Class: StructuredTextLiteral

Table of Contents

Class: StructuredTextLiteral Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Base Classes   
StructuredTextMarkup
    STDOM.Element
Methods   
getColorizableTexts
setColorizableTexts
  getColorizableTexts  
getColorizableTexts ( self )

  setColorizableTexts  
setColorizableTexts ( self,  v )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextMarkup.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextMarkup.py.h0100600000176200017510000001413707306455620033265 0ustar dhellmanndevel Class: StructuredTextMarkup

Table of Contents

Class: StructuredTextMarkup Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Base Classes   
STDOM.Element
Methods   
__init__
__repr__
getChildren
getColorizableTexts
setColorizableTexts
  __init__  
__init__ (
        self,
        v,
        **kw,
        )

  __repr__  
__repr__ ( self )

  getChildren  
getChildren (
        self,
        type=type,
        lt=type([] ),
        )

  getColorizableTexts  
getColorizableTexts ( self )

  setColorizableTexts  
setColorizableTexts ( self,  v )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextNamedLink.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextNamedLink.p0100600000176200017510000000405707306455620033251 0ustar dhellmanndevel Class: StructuredTextNamedLink

Table of Contents

Class: StructuredTextNamedLink Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Base Classes   
StructuredTextMarkup
    STDOM.Element

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextNumbered.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextNumbered.py0100600000176200017510000000375507306455620033345 0ustar dhellmanndevel Class: StructuredTextNumbered

Table of Contents

Class: StructuredTextNumbered Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Represents a section of a document with a title and a body

Base Classes   
ST.StructuredTextParagraph

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextRow.py.html0100600000176200017510000001425307306455620033311 0ustar dhellmanndevel Class: StructuredTextRow

Table of Contents

Class: StructuredTextRow Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

StructuredTextRow holds StructuredTextColumns

Base Classes   
ST.StructuredTextParagraph
Methods   
__init__
_getColumns
_setColumns
getColumns
setColumns
  __init__  
__init__ (
        self,
        row,
        kw,
        )

row is a list of tuples, where each tuple is the raw text for a cell/column and the span of that cell/column. EX [(this is column one,1), (this is column two,1)]

  _getColumns  
_getColumns ( self )

  _setColumns  
_setColumns ( self,  columns )

  getColumns  
getColumns ( self )

  setColumns  
setColumns ( self,  columns )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextSGML.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextSGML.py.htm0100600000176200017510000000404507306455620033126 0ustar dhellmanndevel Class: StructuredTextSGML

Table of Contents

Class: StructuredTextSGML Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Base Classes   
StructuredTextMarkup
    STDOM.Element

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextSection.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextSection.py.0100600000176200017510000001134607306455620033261 0ustar dhellmanndevel Class: StructuredTextSection

Table of Contents

Class: StructuredTextSection Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Represents a section of a document with a title and a body

Base Classes   
ST.StructuredTextParagraph
Methods   
__init__
getColorizableTexts
setColorizableTexts
  __init__  
__init__ (
        self,
        src,
        subs=None,
        **kw,
        )

  getColorizableTexts  
getColorizableTexts ( self )

  setColorizableTexts  
setColorizableTexts ( self,  src )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextSectionTitle.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextSectionTitl0100600000176200017510000000376507306455620033417 0ustar dhellmanndevel Class: StructuredTextSectionTitle

Table of Contents

Class: StructuredTextSectionTitle Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Represents a section of a document with a title and a body

Base Classes   
ST.StructuredTextParagraph

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextStrong.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextStrong.py.h0100600000176200017510000000405107306455620033274 0ustar dhellmanndevel Class: StructuredTextStrong

Table of Contents

Class: StructuredTextStrong Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Base Classes   
StructuredTextMarkup
    STDOM.Element

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextTable.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextTable.py.ht0100600000176200017510000002602407306455620033237 0ustar dhellmanndevel Class: StructuredTextTable

Table of Contents

Class: StructuredTextTable Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

rows is a list of lists containing tuples, which represent the columns/cells in each rows. EX rows = [[(row 1:column1,1)],[(row2:column1,1)]]

a StructuredTextTable holds StructuredTextRows

Base Classes   
ST.StructuredTextParagraph
Methods   
__init__
_getColorizableTexts
_getColumns
_getRows
_setColorizableTexts
_setColumns
getColorizableTexts
getColumns
getRows
setColorizableTexts
 setColumns
  __init__  
__init__ (
        self,
        rows,
        src,
        subs,
        **kw,
        )

  _getColorizableTexts  
_getColorizableTexts ( self )

  _getColumns  
_getColumns ( self )

  _getRows  
_getRows ( self )

  _setColorizableTexts  
_setColorizableTexts ( self )

  _setColumns  
_setColumns ( self,  columns )

  getColorizableTexts  
getColorizableTexts ( self )

return a tuple where each item is a column/cell's contents. The tuple, result, will be of this format. ("r1 col1", "r1=col2", "r2 col1", "r2 col2")

  getColumns  
getColumns ( self )

  getRows  
getRows ( self )

  setColorizableTexts  
setColorizableTexts ( self,  texts )

texts is going to a tuple where each item is the result of being mapped to the colortext function. Need to insert the results appropriately into the individual columns/cells

  setColumns  
setColumns ( self,  columns )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextTableData.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextTableData.p0100600000176200017510000000373507306455620033232 0ustar dhellmanndevel Class: StructuredTextTableData

Table of Contents

Class: StructuredTextTableData Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Base Classes   
ST.StructuredTextParagraph

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextTableHeader.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextTableHeader0100600000176200017510000000374107306455620033310 0ustar dhellmanndevel Class: StructuredTextTableHeader

Table of Contents

Class: StructuredTextTableHeader Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Base Classes   
ST.StructuredTextParagraph

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextUnderline.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextUnderline.p0100600000176200017510000000405707306455620033334 0ustar dhellmanndevel Class: StructuredTextUnderline

Table of Contents

Class: StructuredTextUnderline Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Base Classes   
StructuredTextMarkup
    STDOM.Element

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014500000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextXref.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentClass_StructuredTextXref.py.htm0100600000176200017510000000404507306455620033270 0ustar dhellmanndevel Class: StructuredTextXref

Table of Contents

Class: StructuredTextXref Zope-2-CVS-src/lib/python/StructuredText/DocumentClass.py

Base Classes   
StructuredTextMarkup
    STDOM.Element

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentWithImages.py.html0100600000176200017510000000632407306455620030524 0ustar dhellmanndevel Module: DocumentWithImages

Table of Contents

Module: DocumentWithImages Zope-2-CVS-src/lib/python/StructuredText/DocumentWithImages.py

Imported modules   
from DocumentClass import *
import ST
import STDOM
import re
from string import split, join, replace, expandtabs, strip, find
Classes   
DocumentWithImages
StructuredTextImage

A simple embedded image

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015200000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentWithImages_DocumentWithImages.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentWithImages_DocumentWithImages.p0100600000176200017510000000667207306455620033216 0ustar dhellmanndevel Class: DocumentWithImages

Table of Contents

Class: DocumentWithImages Zope-2-CVS-src/lib/python/StructuredText/DocumentWithImages.py

Base Classes   
DocumentClass
Methods   
doc_img
  doc_img  
doc_img (
        self,
        s,
        expr1=re.compile( '\"([ _a-zA-Z0-9*.:/;,\-\n\~]+)\":img:([a-zA-Z0-9\-.:/;,\n\~]+)' ).search,
        expr2=re.compile( '\"([ _a-zA-Z0-9*.:/;,\-\n\~]+)\":img:([a-zA-Z0-9\-.:/;,\n\~]+):([a-zA-Z0-9\-.:/;,\n\~]+)' ).search,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015300000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentWithImages_StructuredTextImage.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/DocumentWithImages_StructuredTextImage.0100600000176200017510000000370307306455620033242 0ustar dhellmanndevel Class: StructuredTextImage

Table of Contents

Class: StructuredTextImage Zope-2-CVS-src/lib/python/StructuredText/DocumentWithImages.py

A simple embedded image

Base Classes   
StructuredTextMarkup

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/HTMLClass.py.html0100600000176200017510000000600307306455620026510 0ustar dhellmanndevel Module: HTMLClass

Table of Contents

Module: HTMLClass Zope-2-CVS-src/lib/python/StructuredText/HTMLClass.py

Imported modules   
import ST
from cgi import escape
import re
from string import join, split, find
import sys
Classes   
HTMLClass

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/HTMLClass_HTMLClass.py.html0100600000176200017510000004621407306455620030332 0ustar dhellmanndevel Class: HTMLClass

Table of Contents

Class: HTMLClass Zope-2-CVS-src/lib/python/StructuredText/HTMLClass.py

Methods   
__call__
_text
bullet
description
descriptionBody
descriptionTitle
dispatch
document
emphasis
example
 innerLink
link
literal
namedLink
numbered
paragraph
section
sectionTitle
sgml
strong
 table
underline
xref
  __call__  
__call__ (
        self,
        doc,
        level=1,
        )

  _text  
_text (
        self,
        doc,
        level,
        output,
        )

  bullet  
bullet (
        self,
        doc,
        level,
        output,
        )

  description  
description (
        self,
        doc,
        level,
        output,
        )

  descriptionBody  
descriptionBody (
        self,
        doc,
        level,
        output,
        )

  descriptionTitle  
descriptionTitle (
        self,
        doc,
        level,
        output,
        )

  dispatch  
dispatch (
        self,
        doc,
        level,
        output,
        )

  document  
document (
        self,
        doc,
        level,
        output,
        )

  emphasis  
emphasis (
        self,
        doc,
        level,
        output,
        )

  example  
example (
        self,
        doc,
        level,
        output,
        )

  innerLink  
innerLink (
        self,
        doc,
        level,
        output,
        )

  link  
link (
        self,
        doc,
        level,
        output,
        )

  literal  
literal (
        self,
        doc,
        level,
        output,
        )

  namedLink  
namedLink (
        self,
        doc,
        level,
        output,
        )

  numbered  
numbered (
        self,
        doc,
        level,
        output,
        )

  paragraph  
paragraph (
        self,
        doc,
        level,
        output,
        )

  section  
section (
        self,
        doc,
        level,
        output,
        )

  sectionTitle  
sectionTitle (
        self,
        doc,
        level,
        output,
        )

  sgml  
sgml (
        self,
        doc,
        level,
        output,
        )

  strong  
strong (
        self,
        doc,
        level,
        output,
        )

  table  
table (
        self,
        doc,
        level,
        output,
        )

A StructuredTextTable holds StructuredTextRow(s) which holds StructuredTextColumn(s). A StructuredTextColumn is a type of StructuredTextParagraph and thus holds the actual data.

  underline  
underline (
        self,
        doc,
        level,
        output,
        )

  xref  
xref (
        self,
        doc,
        level,
        output,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/HTMLWithImages.py.html0100600000176200017510000000621407306455620027510 0ustar dhellmanndevel Module: HTMLWithImages

Table of Contents

Module: HTMLWithImages Zope-2-CVS-src/lib/python/StructuredText/HTMLWithImages.py

Imported modules   
from HTMLClass import HTMLClass
import ST
import re
from string import join, split, find
import sys
import time
Classes   
HTMLWithImages

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/HTMLWithImages_HTMLWithImages.py.html0100600000176200017510000001122707306455620032316 0ustar dhellmanndevel Class: HTMLWithImages

Table of Contents

Class: HTMLWithImages Zope-2-CVS-src/lib/python/StructuredText/HTMLWithImages.py

Base Classes   
HTMLClass
Methods   
document
image
xref
  document  
document (
        self,
        doc,
        level,
        output,
        )

  image  
image (
        self,
        doc,
        level,
        output,
        )

  xref  
xref (
        self,
        doc,
        level,
        output,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/ST.py.html0100600000176200017510000002115307306455620025307 0ustar dhellmanndevel Module: ST

Table of Contents

Module: ST Zope-2-CVS-src/lib/python/StructuredText/ST.py

Imported modules   
import STDOM
import re
from string import split, join, replace, expandtabs, strip, find
Functions   
StructuredText
display
display2
findlevel
indention
insert
  StructuredText  
StructuredText ( paragraphs,  paragraph_delimiter=re.compile( '\n\s*\n' ) )

StructuredText accepts paragraphs, which is a list of lines to be parsed. StructuredText creates a structure which mimics the structure of the paragraphs. Structure => [paragraph,[sub-paragraphs]]

Golly, the capitalization of this function always makes me think it's a class

  display  
display ( struct )

runs through the structure and prints out the paragraphs. If the insertion works correctly, display's results should mimic the orignal paragraphs.

  display2  
display2 ( struct )

runs through the structure and prints out the paragraphs. If the insertion works correctly, display's results should mimic the orignal paragraphs.

  findlevel  
findlevel ( levels,  indent )

remove all level information of levels with a greater level of indentation. Then return which level should insert this paragraph

  indention  
indention ( str,  front=re.compile( "^\s+" ).match )

Convert all tabs to the appropriate number of spaces. Find the number of leading spaces. If none, return 0

  insert  
insert (
        struct,
        top,
        level,
        )

find what will be the parant paragraph of a sentence and return that paragraph's sub-paragraphs. The new paragraph will be appended to those sub-paragraphs

Classes   
StructuredTextDocument

A StructuredTextDocument holds StructuredTextParagraphs

StructuredTextParagraph

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/ST_StructuredTextDocument.py.html0100600000176200017510000002055007306455620032077 0ustar dhellmanndevel Class: StructuredTextDocument

Table of Contents

Class: StructuredTextDocument Zope-2-CVS-src/lib/python/StructuredText/ST.py

A StructuredTextDocument holds StructuredTextParagraphs as its subparagraphs.

Base Classes   
StructuredTextParagraph
    STDOM.Element
Methods   
__init__
__repr__
_get_Children
_get_ColorizableTexts
_set_ColorizableTexts
getChildren
getColorizableTexts
setColorizableTexts
  __init__  
__init__ (
        self,
        subs=None,
        **kw,
        )

  __repr__  
__repr__ ( self )

  _get_Children  
_get_Children ( self )

  _get_ColorizableTexts  
_get_ColorizableTexts ( self )

  _set_ColorizableTexts  
_set_ColorizableTexts ( self,  src )

  getChildren  
getChildren ( self )

  getColorizableTexts  
getColorizableTexts ( self )

  setColorizableTexts  
setColorizableTexts ( self,  src )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/ST_StructuredTextParagraph.py.html0100600000176200017510000003736307306455620032240 0ustar dhellmanndevel Class: StructuredTextParagraph

Table of Contents

Class: StructuredTextParagraph Zope-2-CVS-src/lib/python/StructuredText/ST.py

Base Classes   
STDOM.Element
Methods   
__init__
__repr__
_get_Attribute
_get_AttributeNode
_get_Attributes
_get_Children
_get_ColorizableTexts
_get_Subparagraphs
_set_ColorizableTexts
_set_Subparagraphs
 getAttribute
getAttributeNode
getAttributes
getChildren
getColorizableTexts
getSubparagraphs
setColorizableTexts
setSubparagraphs
  __init__  
__init__ (
        self,
        src,
        subs=None,
        **kw,
        )

  __repr__  
__repr__ ( self )

  _get_Attribute  
_get_Attribute ( self,  name )

  _get_AttributeNode  
_get_AttributeNode ( self,  name )

  _get_Attributes  
_get_Attributes ( self )

  _get_Children  
_get_Children (
        self,
        type=type,
        lt=type([] ),
        )

  _get_ColorizableTexts  
_get_ColorizableTexts ( self )

  _get_Subparagraphs  
_get_Subparagraphs ( self )

  _set_ColorizableTexts  
_set_ColorizableTexts ( self,  src )

  _set_Subparagraphs  
_set_Subparagraphs ( self,  subs )

  getAttribute  
getAttribute ( self,  name )

  getAttributeNode  
getAttributeNode ( self,  name )

  getAttributes  
getAttributes ( self )

  getChildren  
getChildren (
        self,
        type=type,
        lt=type([] ),
        )

  getColorizableTexts  
getColorizableTexts ( self )

  getSubparagraphs  
getSubparagraphs ( self )

  setColorizableTexts  
setColorizableTexts ( self,  src )

  setSubparagraphs  
setSubparagraphs ( self,  subs )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM.py.html0100600000176200017510000001314707306455621025654 0ustar dhellmanndevel Module: STDOM

Table of Contents

Module: STDOM Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

DOM implementation in StructuredText : Read-Only methods

All standard Zope objects support DOM to a limited extent.

Imported modules   
import string
Classes   
Attr

Attr interface - The Attr interface represents an attriubte in an

DOMException
DOMStringSizeException
Element

Element interface

HierarchyRequestException
InUseAttributeException
IndexSizeException
InvalidCharacterException
NamedNodeMap

NamedNodeMap interface - Is used to represent collections

NoDataAllowedException
NoModificationAllowedException
Node

Node Interface

NodeList

NodeList interface - Provides the abstraction of an ordered

NodeWrapper

This is an acquisition-like wrapper that provides parent access for

NotFoundException
NotSupportedException
ParentNode

A node that can have children, or, more precisely, that implements

TextNode
WrongDocumentException

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_Attr.py.html0100600000176200017510000002513607306455620026646 0ustar dhellmanndevel Class: Attr

Table of Contents

Class: Attr Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

Attr interface - The Attr interface represents an attriubte in an Element object. Attr objects inherit the Node Interface

Base Classes   
Node
Methods   
__init__
_get_Name
_get_NodeName
_get_NodeType
_get_NodeValue
_get_Specified
getName
getNodeName
getNodeType
getNodeValue
 getSpecified
  __init__  
__init__ (
        self,
        name,
        value,
        specified=1,
        )

  _get_Name  
_get_Name ( self )

  _get_NodeName  
_get_NodeName ( self )

  _get_NodeType  
_get_NodeType ( self )

  _get_NodeValue  
_get_NodeValue ( self )

  _get_Specified  
_get_Specified ( self )

  getName  
getName ( self )

Returns the name of this attribute.

  getNodeName  
getNodeName ( self )

The name of this node, depending on its type

  getNodeType  
getNodeType ( self )

A code representing the type of the node.

  getNodeValue  
getNodeValue ( self )

The value of this node, depending on its type

  getSpecified  
getSpecified ( self )

If this attribute was explicitly given a value in the original document, this is true; otherwise, it is false.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_DOMException.py.html0100600000176200017510000000365607306455620030235 0ustar dhellmanndevel Class: DOMException

Table of Contents

Class: DOMException Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_DOMStringSizeException.py.html0100600000176200017510000000401107306455620032241 0ustar dhellmanndevel Class: DOMStringSizeException

Table of Contents

Class: DOMStringSizeException Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_Element.py.html0100600000176200017510000003771607306455620027334 0ustar dhellmanndevel Class: Element

Table of Contents

Class: Element Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

Element interface

Base Classes   
Node
Methods   
_get_Attribute
_get_AttributeNode
_get_Attributes
_get_ElementsByTagName
_get_NodeName
_get_NodeType
_get_NodeValue
_get_ParentNode
_get_TagName
getAttribute
 getAttributeNode
getAttributes
getElementsByTagName
getNodeName
getNodeType
getNodeValue
getParentNode
getTagName
  _get_Attribute  
_get_Attribute ( self,  name )

  _get_AttributeNode  
_get_AttributeNode ( self,  name )

  _get_Attributes  
_get_Attributes ( self )

  _get_ElementsByTagName  
_get_ElementsByTagName ( self,  tagname )

  _get_NodeName  
_get_NodeName ( self )

  _get_NodeType  
_get_NodeType ( self )

  _get_NodeValue  
_get_NodeValue (
        self,
        type=type,
        st=type( '' ),
        )

  _get_ParentNode  
_get_ParentNode ( self )

  _get_TagName  
_get_TagName ( self )

  getAttribute  
getAttribute ( self,  name )

Retrieves an attribute value by name.

  getAttributeNode  
getAttributeNode ( self,  name )

Retrieves an Attr node by name or None if there is no such attribute.

  getAttributes  
getAttributes ( self )

  getElementsByTagName  
getElementsByTagName ( self,  tagname )

Returns a NodeList of all the Elements with a given tag name in the order in which they would be encountered in a preorder traversal of the Document tree. Parameter: tagname The name of the tag to match (* = all tags). Return Value: A new NodeList object containing all the matched Elements.

  getNodeName  
getNodeName ( self )

The name of this node, depending on its type

  getNodeType  
getNodeType ( self )

A code representing the type of the node.

  getNodeValue  
getNodeValue (
        self,
        type=type,
        st=type( '' ),
        )

  getParentNode  
getParentNode ( self )

The parent of this node. All nodes except Document DocumentFragment and Attr may have a parent

  getTagName  
getTagName ( self )

The name of the element

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_HierarchyRequestException.py.html0100600000176200017510000000401707306455620033075 0ustar dhellmanndevel Class: HierarchyRequestException

Table of Contents

Class: HierarchyRequestException Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_InUseAttributeException.py.html0100600000176200017510000000401307306455620032511 0ustar dhellmanndevel Class: InUseAttributeException

Table of Contents

Class: InUseAttributeException Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_IndexSizeException.py.html0100600000176200017510000000400107306455620031501 0ustar dhellmanndevel Class: IndexSizeException

Table of Contents

Class: IndexSizeException Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_InvalidCharacterException.py.html0100600000176200017510000000401707306455620033011 0ustar dhellmanndevel Class: InvalidCharacterException

Table of Contents

Class: InvalidCharacterException Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_NamedNodeMap.py.html0100600000176200017510000001615707306455620030227 0ustar dhellmanndevel Class: NamedNodeMap

Table of Contents

Class: NamedNodeMap Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

NamedNodeMap interface - Is used to represent collections of nodes that can be accessed by name. NamedNodeMaps are not maintained in any particular order.

Python extensions: can use sequence-style len, getitem, and for..in constructs, and mapping-style getitem.

Methods   
__getitem__
__init__
_get_Length
_get_NamedItem
getLength
getNamedItem
item
  __getitem__  
__getitem__ ( self,  key )

  __init__  
__init__ ( self,  data=None )

  _get_Length  
_get_Length ( self )

  _get_NamedItem  
_get_NamedItem ( self,  name )

  getLength  
getLength ( self )

The length of the NodeList

  getNamedItem  
getNamedItem ( self,  name )

Retrieves a node specified by name. Parameters: name Name of a node to retrieve. Return Value A Node (of any type) with the specified name, or None if the specified name did not identify any node in the map.

  item  
item ( self,  index )

Returns the index-th item in the map

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_NoDataAllowedException.py.html0100600000176200017510000000401107306455620032256 0ustar dhellmanndevel Class: NoDataAllowedException

Table of Contents

Class: NoDataAllowedException Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_NoModificationAllowedException.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_NoModificationAllowedException.py0100600000176200017510000000403107306455620033051 0ustar dhellmanndevel Class: NoModificationAllowedException

Table of Contents

Class: NoModificationAllowedException Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_Node.py.html0100600000176200017510000004125407306455620026620 0ustar dhellmanndevel Class: Node

Table of Contents

Class: Node Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

Node Interface

Base Classes   
ParentNode
Methods   
__of__
_get_Attributes
_get_Children
_get_NextSibling
_get_NodeName
_get_NodeValue
_get_OwnerDocument
_get_ParentNode
_get_PreviousSibling
_has_ChildNodes
 getAttributes
getChildren
getNextSibling
getNodeName
getNodeValue
getOwnerDocument
getParentNode
getPreviousSibling
hasChildNodes
  __of__  
__of__ ( self,  parent )

Get a DOM wrapper with a parent link

  _get_Attributes  
_get_Attributes ( self )

  _get_Children  
_get_Children ( self )

  _get_NextSibling  
_get_NextSibling (
        self,
        type=type,
        st=type( '' ),
        )

  _get_NodeName  
_get_NodeName ( self )

  _get_NodeValue  
_get_NodeValue ( self )

  _get_OwnerDocument  
_get_OwnerDocument ( self )

  _get_ParentNode  
_get_ParentNode ( self )

  _get_PreviousSibling  
_get_PreviousSibling (
        self,
        type=type,
        st=type( '' ),
        getattr=getattr,
        None=None,
        )

  _has_ChildNodes  
_has_ChildNodes ( self )

  getAttributes  
getAttributes ( self )

Returns a NamedNodeMap containing the attributes of this node (if it is an element) or None otherwise.

  getChildren  
getChildren ( self )

Get a Python sequence of children

  getNextSibling  
getNextSibling (
        self,
        type=type,
        st=type( '' ),
        )

The node immediately preceding this node. If there is no such node, this returns None.

  getNodeName  
getNodeName ( self )

The name of this node, depending on its type

  getNodeValue  
getNodeValue ( self )

The value of this node, depending on its type

  getOwnerDocument  
getOwnerDocument ( self )

The Document object associated with this node, if any.

  getParentNode  
getParentNode ( self )

The parent of this node. All nodes except Document DocumentFragment and Attr may have a parent

  getPreviousSibling  
getPreviousSibling (
        self,
        type=type,
        st=type( '' ),
        getattr=getattr,
        None=None,
        )

The node immediately preceding this node. If there is no such node, this returns None.

  hasChildNodes  
hasChildNodes ( self )

Returns true if the node has any children, false if it doesn't.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_NodeList.py.html0100600000176200017510000001431207306455620027447 0ustar dhellmanndevel Class: NodeList

Table of Contents

Class: NodeList Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

NodeList interface - Provides the abstraction of an ordered collection of nodes.

Python extensions: can use sequence-style len, getitem, and for..in constructs.

Methods   
__getitem__
__getslice__
__init__
_get_Length
getLength
item
  __getitem__  
__getitem__ (
        self,
        index,
        type=type,
        st=type( '' ),
        )

  __getslice__  
__getslice__ (
        self,
        i,
        j,
        )

  __init__  
__init__ ( self,  list=None )

  _get_Length  
_get_Length ( self )

  getLength  
getLength ( self )

The length of the NodeList

  item  
item ( self,  index )

Returns the index-th item in the collection

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_NodeWrapper.py.html0100600000176200017510000002767507306455620030174 0ustar dhellmanndevel Class: NodeWrapper

Table of Contents

Class: NodeWrapper Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

This is an acquisition-like wrapper that provides parent access for DOM sans circular references!

Base Classes   
ParentNode
Methods   
__getattr__
__init__
_getDOMIndex
_get_DOMIndex
_get_NextSibling
_get_OwnerDocument
_get_ParentNode
_get_PreviousSibling
getNextSibling
getOwnerDocument
 getParentNode
getPreviousSibling
  __getattr__  
__getattr__ ( self,  name )

  __init__  
__init__ (
        self,
        aq_self,
        aq_parent,
        )

  _getDOMIndex  
_getDOMIndex (
        self,
        children,
        getattr=getattr,
        )

  _get_DOMIndex  
_get_DOMIndex (
        self,
        children,
        getattr=getattr,
        )

  _get_NextSibling  
_get_NextSibling (
        self,
        type=type,
        st=type( '' ),
        )

  _get_OwnerDocument  
_get_OwnerDocument ( self )

  _get_ParentNode  
_get_ParentNode ( self )

  _get_PreviousSibling  
_get_PreviousSibling (
        self,
        type=type,
        st=type( '' ),
        getattr=getattr,
        None=None,
        )

  getNextSibling  
getNextSibling (
        self,
        type=type,
        st=type( '' ),
        )

The node immediately preceding this node. If there is no such node, this returns None.

  getOwnerDocument  
getOwnerDocument ( self )

The Document object associated with this node, if any.

  getParentNode  
getParentNode ( self )

The parent of this node. All nodes except Document DocumentFragment and Attr may have a parent

  getPreviousSibling  
getPreviousSibling (
        self,
        type=type,
        st=type( '' ),
        getattr=getattr,
        None=None,
        )

The node immediately preceding this node. If there is no such node, this returns None.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_NotFoundException.py.html0100600000176200017510000000377707306455620031356 0ustar dhellmanndevel Class: NotFoundException

Table of Contents

Class: NotFoundException Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_NotSupportedException.py.html0100600000176200017510000000400707306455620032253 0ustar dhellmanndevel Class: NotSupportedException

Table of Contents

Class: NotSupportedException Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_ParentNode.py.html0100600000176200017510000001515007306455620027766 0ustar dhellmanndevel Class: ParentNode

Table of Contents

Class: ParentNode Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

A node that can have children, or, more precisely, that implements the child access methods of the DOM.

Methods   
_get_ChildNodes
_get_FirstChild
_get_LastChild
getChildNodes
getFirstChild
getLastChild
  _get_ChildNodes  
_get_ChildNodes (
        self,
        type=type,
        st=type( '' ),
        )

  _get_FirstChild  
_get_FirstChild (
        self,
        type=type,
        st=type( '' ),
        )

  _get_LastChild  
_get_LastChild (
        self,
        type=type,
        st=type( '' ),
        )

  getChildNodes  
getChildNodes (
        self,
        type=type,
        st=type( '' ),
        )

Returns a NodeList that contains all children of this node. If there are no children, this is a empty NodeList

  getFirstChild  
getFirstChild (
        self,
        type=type,
        st=type( '' ),
        )

The first child of this node. If there is no such node this returns None

  getLastChild  
getLastChild (
        self,
        type=type,
        st=type( '' ),
        )

The last child of this node. If there is no such node this returns None.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_TextNode.py.html0100600000176200017510000001664507306455621027474 0ustar dhellmanndevel Class: TextNode

Table of Contents

Class: TextNode Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

Base Classes   
Node
Methods   
__init__
_get_NodeName
_get_NodeType
_get_NodeValue
getNodeName
getNodeType
getNodeValue
  __init__  
__init__ ( self,  str )

  _get_NodeName  
_get_NodeName ( self )

  _get_NodeType  
_get_NodeType ( self )

  _get_NodeValue  
_get_NodeValue ( self )

  getNodeName  
getNodeName ( self )

  getNodeType  
getNodeType ( self )

  getNodeValue  
getNodeValue ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STDOM_WrongDocumentException.py.html0100600000176200017510000000401107306455621032374 0ustar dhellmanndevel Class: WrongDocumentException

Table of Contents

Class: WrongDocumentException Zope-2-CVS-src/lib/python/StructuredText/STDOM.py

Base Classes   
DOMException
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/STletters.py.html0100600000176200017510000000367707306455621026726 0ustar dhellmanndevel Module: STletters

Table of Contents

Module: STletters Zope-2-CVS-src/lib/python/StructuredText/STletters.py

Imported modules   
import string

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/StructuredText.py.html0100600000176200017510000001406707306455621030001 0ustar dhellmanndevel Module: StructuredText

Table of Contents

Module: StructuredText Zope-2-CVS-src/lib/python/StructuredText/StructuredText.py

Alias module for StructuredTextClassic compatibility which makes use of StructuredTextNG

Imported modules   
import ClassicDocumentClass
import DocumentClass
import HTMLClass
from ST import Basic
from STletters import letters
import re
import string
import sys
Functions   
HTML
StructuredText
html_quote
html_with_references
  HTML  
HTML ( aStructuredString,  level=0 )

  StructuredText  
StructuredText ( aStructuredString,  level=0 )

  html_quote  
html_quote ( v,  character_entities=(( re.compile( '&' ), '&amp;' ), ( re.compile( "<" ), '&lt;' ), ( re.compile( ">" ), '&gt;' ), ( re.compile( '"' ), '&quot;' ) ) )

  html_with_references  
html_with_references ( text,  level=1 )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/Zwiki.py.html0100600000176200017510000000614007306455621026056 0ustar dhellmanndevel Module: Zwiki

Table of Contents

Module: Zwiki Zope-2-CVS-src/lib/python/StructuredText/Zwiki.py

Imported modules   
from Html import HTML
from ST import DOC
import re
from string import split
Classes   
Zwiki_Title
Zwiki_doc
Zwiki_parser

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/Zwiki_Zwiki_Title.py.html0100600000176200017510000001427407306455621030403 0ustar dhellmanndevel Class: Zwiki_Title

Table of Contents

Class: Zwiki_Title Zope-2-CVS-src/lib/python/StructuredText/Zwiki.py

Methods   
__call__
__getitem__
__init__
span
string
type
  __call__  
__call__ (
        self,
        raw_string,
        subs,
        )

The raw_string is checked to see if it matches the rules for this structured text expression. If the raw_string does, it is parsed for the sub-string which matches and a doc_inner_link instance is returned whose string is the matching substring. If raw_string does not match, nothing is returned.

  __getitem__  
__getitem__ ( self,  index )

  __init__  
__init__ ( self,  str='' )

  span  
span ( self )

  string  
string ( self )

  type  
type ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/Zwiki_Zwiki_doc.py.html0100600000176200017510000000620207306455621030057 0ustar dhellmanndevel Class: Zwiki_doc

Table of Contents

Class: Zwiki_doc Zope-2-CVS-src/lib/python/StructuredText/Zwiki.py

Base Classes   
DOC
Methods   
__init__
  __init__  
__init__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/Zwiki_Zwiki_parser.py.html0100600000176200017510000000752507306455621030617 0ustar dhellmanndevel Class: Zwiki_parser

Table of Contents

Class: Zwiki_parser Zope-2-CVS-src/lib/python/StructuredText/Zwiki.py

Base Classes   
HTML
Methods   
__init__
zwiki_title
  __init__  
__init__ ( self )

  zwiki_title  
zwiki_title ( self,  object )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/__init__.py.html0100600000176200017510000000751107306455621026523 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/StructuredText/__init__.py

Imported modules   
import ClassicDocumentClass
import DocBookClass
import DocumentClass
import DocumentWithImages
import HTMLClass
import HTMLWithImages
from ST import Basic
from StructuredText import html_with_references, HTML, html_quote
Functions   
HTML
  HTML  
HTML (
        src,
        level=0,
        type=type,
        StringType=type( '' ),
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/0040700000176200017510000000000007306455621024606 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py.html0100600000176200017510000002454307306455621032043 0ustar dhellmanndevel Module: testStructuredText

Table of Contents

Module: testStructuredText Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Imported modules   
from StructuredText import ST, DocumentClass, ClassicDocumentClass, StructuredText, HTMLClass
import os
from string import join
import sys
import unittest
Functions   
test_suite
  test_suite  
test_suite ()

Classes   
AcquisitionRegressionTestCase
ClassicDocumentClassAcquisitionTestCase
ClassicDocumentClassExamplesTestCase
ClassicDocumentClassExtensionClassTestCase
ClassicDocumentClassIndexTestCase
ClassicDocumentClassMultiMappingTestCase
ClassicHtmlAcquisitionTestCase
ClassicHtmlExamplesTestCase
ClassicHtmlExtensionClassTestCase
ClassicHtmlIndexTestCase
ClassicHtmlMultiMappingTestCase
DocumentClassAcquisitionTestCase
DocumentClassExamplesTestCase
DocumentClassExtensionClassTestCase
DocumentClassIndexTestCase
DocumentClassMultiMappingTestCase
ExamplesRegressionTestCase
ExtensionClassRegressionTestCase
HtmlAcquisitionTestCase
HtmlExamplesTestCase
HtmlExtensionClassTestCase
HtmlIndexTestCase
HtmlMultiMappingTestCase
IndexRegressionTestCase
MultiMappingRegressionTestCase
STNGAcquisitionTestCase
STNGExamplesTestCase
STNGExtensionClassTestCase
STNGIndexTestCase
STNGMultiMappingTestCase
StructuredTextAcquisitionTestCase
StructuredTextExamplesTestCase
StructuredTextExtensionClassTestCase
StructuredTextIndexTestCase
StructuredTextMultiMappingTestCase

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017300000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_AcquisitionRegressionTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_AcquisitionReg0100600000176200017510000000756107306455621033460 0ustar dhellmanndevel Class: AcquisitionRegressionTestCase

Table of Contents

Class: AcquisitionRegressionTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000020500000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicDocumentClassAcquisitionTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicDocumen0100600000176200017510000000760507306455621033425 0ustar dhellmanndevel Class: ClassicDocumentClassAcquisitionTestCase

Table of Contents

Class: ClassicDocumentClassAcquisitionTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000020200000000000011557 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicDocumentClassExamplesTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicDocumen0100600000176200017510000000757707306455621033435 0ustar dhellmanndevel Class: ClassicDocumentClassExamplesTestCase

Table of Contents

Class: ClassicDocumentClassExamplesTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000021000000000000011556 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicDocumentClassExtensionClassTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicDocumen0100600000176200017510000000761307306455621033424 0ustar dhellmanndevel Class: ClassicDocumentClassExtensionClassTestCase

Table of Contents

Class: ClassicDocumentClassExtensionClassTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017700000000000011572 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicDocumentClassIndexTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicDocumen0100600000176200017510000000757107306455621033427 0ustar dhellmanndevel Class: ClassicDocumentClassIndexTestCase

Table of Contents

Class: ClassicDocumentClassIndexTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000020600000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicDocumentClassMultiMappingTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicDocumen0100600000176200017510000000760707306455621033427 0ustar dhellmanndevel Class: ClassicDocumentClassMultiMappingTestCase

Table of Contents

Class: ClassicDocumentClassMultiMappingTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017400000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicHtmlAcquisitionTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicHtmlAcq0100600000176200017510000000756307306455621033367 0ustar dhellmanndevel Class: ClassicHtmlAcquisitionTestCase

Table of Contents

Class: ClassicHtmlAcquisitionTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017100000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicHtmlExamplesTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicHtmlExa0100600000176200017510000000755507306455621033401 0ustar dhellmanndevel Class: ClassicHtmlExamplesTestCase

Table of Contents

Class: ClassicHtmlExamplesTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017700000000000011572 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicHtmlExtensionClassTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicHtmlExt0100600000176200017510000000757107306455621033422 0ustar dhellmanndevel Class: ClassicHtmlExtensionClassTestCase

Table of Contents

Class: ClassicHtmlExtensionClassTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016600000000000011570 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicHtmlIndexTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicHtmlInd0100600000176200017510000000754707306455621033377 0ustar dhellmanndevel Class: ClassicHtmlIndexTestCase

Table of Contents

Class: ClassicHtmlIndexTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017500000000000011570 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicHtmlMultiMappingTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ClassicHtmlMul0100600000176200017510000000756507306455621033422 0ustar dhellmanndevel Class: ClassicHtmlMultiMappingTestCase

Table of Contents

Class: ClassicHtmlMultiMappingTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017600000000000011571 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_DocumentClassAcquisitionTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_DocumentClassA0100600000176200017510000000756707306455621033405 0ustar dhellmanndevel Class: DocumentClassAcquisitionTestCase

Table of Contents

Class: DocumentClassAcquisitionTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017300000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_DocumentClassExamplesTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_DocumentClassE0100600000176200017510000000756107306455621033403 0ustar dhellmanndevel Class: DocumentClassExamplesTestCase

Table of Contents

Class: DocumentClassExamplesTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000020100000000000011556 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_DocumentClassExtensionClassTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_DocumentClassE0100600000176200017510000000757507306455621033410 0ustar dhellmanndevel Class: DocumentClassExtensionClassTestCase

Table of Contents

Class: DocumentClassExtensionClassTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017000000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_DocumentClassIndexTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_DocumentClassI0100600000176200017510000000755307306455621033410 0ustar dhellmanndevel Class: DocumentClassIndexTestCase

Table of Contents

Class: DocumentClassIndexTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017700000000000011572 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_DocumentClassMultiMappingTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_DocumentClassM0100600000176200017510000000757107306455621033414 0ustar dhellmanndevel Class: DocumentClassMultiMappingTestCase

Table of Contents

Class: DocumentClassMultiMappingTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017000000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ExamplesRegressionTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ExamplesRegres0100600000176200017510000000755307306455621033461 0ustar dhellmanndevel Class: ExamplesRegressionTestCase

Table of Contents

Class: ExamplesRegressionTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017600000000000011571 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ExtensionClassRegressionTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_ExtensionClass0100600000176200017510000000756707306455621033502 0ustar dhellmanndevel Class: ExtensionClassRegressionTestCase

Table of Contents

Class: ExtensionClassRegressionTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016500000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_HtmlAcquisitionTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_HtmlAcquisitio0100600000176200017510000000754507306455621033473 0ustar dhellmanndevel Class: HtmlAcquisitionTestCase

Table of Contents

Class: HtmlAcquisitionTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016200000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_HtmlExamplesTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_HtmlExamplesTe0100600000176200017510000000753707306455621033431 0ustar dhellmanndevel Class: HtmlExamplesTestCase

Table of Contents

Class: HtmlExamplesTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017000000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_HtmlExtensionClassTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_HtmlExtensionC0100600000176200017510000000755307306455621033437 0ustar dhellmanndevel Class: HtmlExtensionClassTestCase

Table of Contents

Class: HtmlExtensionClassTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015700000000000011570 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_HtmlIndexTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_HtmlIndexTestC0100600000176200017510000000753107306455621033366 0ustar dhellmanndevel Class: HtmlIndexTestCase

Table of Contents

Class: HtmlIndexTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016600000000000011570 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_HtmlMultiMappingTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_HtmlMultiMappi0100600000176200017510000000754707306455621033444 0ustar dhellmanndevel Class: HtmlMultiMappingTestCase

Table of Contents

Class: HtmlMultiMappingTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016500000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_IndexRegressionTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_IndexRegressio0100600000176200017510000000754507306455621033466 0ustar dhellmanndevel Class: IndexRegressionTestCase

Table of Contents

Class: IndexRegressionTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017400000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_MultiMappingRegressionTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_MultiMappingRe0100600000176200017510000000756307306455621033431 0ustar dhellmanndevel Class: MultiMappingRegressionTestCase

Table of Contents

Class: MultiMappingRegressionTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016500000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_STNGAcquisitionTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_STNGAcquisitio0100600000176200017510000000754507306455621033342 0ustar dhellmanndevel Class: STNGAcquisitionTestCase

Table of Contents

Class: STNGAcquisitionTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016200000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_STNGExamplesTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_STNGExamplesTe0100600000176200017510000000753707306455621033300 0ustar dhellmanndevel Class: STNGExamplesTestCase

Table of Contents

Class: STNGExamplesTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017000000000000011563 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_STNGExtensionClassTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_STNGExtensionC0100600000176200017510000000755307306455621033306 0ustar dhellmanndevel Class: STNGExtensionClassTestCase

Table of Contents

Class: STNGExtensionClassTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015700000000000011570 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_STNGIndexTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_STNGIndexTestC0100600000176200017510000000753107306455621033235 0ustar dhellmanndevel Class: STNGIndexTestCase

Table of Contents

Class: STNGIndexTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016600000000000011570 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_STNGMultiMappingTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_STNGMultiMappi0100600000176200017510000000754707306455621033313 0ustar dhellmanndevel Class: STNGMultiMappingTestCase

Table of Contents

Class: STNGMultiMappingTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017700000000000011572 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_StructuredTextAcquisitionTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_StructuredText0100600000176200017510000000757107306455621033544 0ustar dhellmanndevel Class: StructuredTextAcquisitionTestCase

Table of Contents

Class: StructuredTextAcquisitionTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017400000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_StructuredTextExamplesTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_StructuredText0100600000176200017510000000756307306455621033545 0ustar dhellmanndevel Class: StructuredTextExamplesTestCase

Table of Contents

Class: StructuredTextExamplesTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000020200000000000011557 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_StructuredTextExtensionClassTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_StructuredText0100600000176200017510000000757707306455621033552 0ustar dhellmanndevel Class: StructuredTextExtensionClassTestCase

Table of Contents

Class: StructuredTextExtensionClassTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000017100000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_StructuredTextIndexTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_StructuredText0100600000176200017510000000755507306455621033546 0ustar dhellmanndevel Class: StructuredTextIndexTestCase

Table of Contents

Class: StructuredTextIndexTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000020000000000000011555 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_StructuredTextMultiMappingTestCase.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText_StructuredText0100600000176200017510000000757307306455621033546 0ustar dhellmanndevel Class: StructuredTextMultiMappingTestCase

Table of Contents

Class: StructuredTextMultiMappingTestCase Zope-2-CVS-src/lib/python/StructuredText/tests/testStructuredText.py

Base Classes   
unittest.TestCase
Methods   
runTest
setUp
  runTest  
runTest ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:42 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Testing/0040700000176200017510000000000007306455622022051 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Testing/index.html0100600000176200017510000000476407306455622024060 0ustar dhellmanndevel Zope2 CVS with ZEO: Testing

Table of Contents

Zope2 CVS with ZEO: Testing  
Modules and Packages   

Zope-2-CVS-src/lib/python/Testing/

__init__

Set up testing environment

dispatcher
makerequest

Facilitates unit tests which requires an acquirable REQUEST from

unittest

Python unit testing framework, based on Erich Gamma's JUnit and Kent Beck's

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:29 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Testing/__init__.py.html0100600000176200017510000000407007306455622025125 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Testing/__init__.py

Set up testing environment

$Id: __init__.py,v 1.2 2001/03/15 13:16:25 jim Exp $

Imported modules   
import os
import sys

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:29 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Testing/dispatcher.py.html0100600000176200017510000000652307306455622025521 0ustar dhellmanndevel Module: dispatcher

Table of Contents

Module: dispatcher Zope-2-CVS-src/lib/python/Testing/dispatcher.py

Imported modules   
import commands
import os
import profile
import re
import string
import sys
import threading
import time
Classes   
Dispatcher

a multi-purpose thread dispatcher

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:29 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Testing/dispatcher_Dispatcher.py.html0100600000176200017510000003076607306455622027675 0ustar dhellmanndevel Class: Dispatcher

Table of Contents

Class: Dispatcher Zope-2-CVS-src/lib/python/Testing/dispatcher.py

a multi-purpose thread dispatcher

Methods   
__init__
dispatcher
getmem
log
logn
mem_watcher
profiling_off
profiling_on
register_startup
register_teardown
 s2s
setlog
th_setup
th_teardown
worker
  __init__  
__init__ ( self,  func='' )

  dispatcher  
dispatcher (
        self,
        name='',
        *params,
        )

dispatcher for threads The dispatcher expects one or several tupels: (functionname, number of threads to start , args, keyword args)

  getmem  
getmem ( self )

try to determine the current memory usage

  log  
log ( self,  s )

  logn  
logn ( self,  s )

  mem_watcher  
mem_watcher ( self )

thread for watching memory usage

  profiling_off  
profiling_off ()

  profiling_on  
profiling_on ()

  register_startup  
register_startup ( self,  func )

  register_teardown  
register_teardown ( self,  func )

  s2s  
s2s ( self,  n )

  setlog  
setlog ( self,  fp )

  th_setup  
th_setup ( self )

initalize thread with some environment data

  th_teardown  
th_teardown (
        self,
        env,
        **kw,
        )

famous last actions of thread

  worker  
worker (
        self,
        *args,
        *kw,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:29 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Testing/makerequest.py.html0100600000176200017510000000752607306455622025725 0ustar dhellmanndevel Module: makerequest

Table of Contents

Module: makerequest Zope-2-CVS-src/lib/python/Testing/makerequest.py

Facilitates unit tests which requires an acquirable REQUEST from ZODB objects

Usage:

import makerequest app = makerequest.makerequest(Zope.app())

$Id: makerequest.py,v 1.3 2001/04/18 23:02:04 mj Exp $

Imported modules   
from ZPublisher.BaseRequest import RequestContainer
from ZPublisher.HTTPRequest import HTTPRequest
from ZPublisher.HTTPResponse import HTTPResponse
import os
from os import environ
from sys import stdin, stdout
Functions   
makerequest
  makerequest  
makerequest ( app,  stdout=stdout )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:29 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Testing/unittest.py.html0100600000176200017510000002743407306455622025256 0ustar dhellmanndevel Module: unittest

Table of Contents

Module: unittest Zope-2-CVS-src/lib/python/Testing/unittest.py

Python unit testing framework, based on Erich Gamma's JUnit and Kent Beck's Smalltalk testing framework.

Further information is available in the bundled documentation, and from

http://pyunit.sourceforge.net/

This module contains the core framework classes that form the basis of specific test cases and suites (TestCase, TestSuite etc.), and also a text-based utility class for running the tests and reporting the results (TextTestRunner).

Copyright (c) 1999, 2000, 2001 Steve Purcell This module is free software, and you may redistribute it and/or modify it under the same terms as Python itself, so long as this copyright message and disclaimer are retained in their original form.

IN NO EVENT SHALL THE AUTHOR BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

THE AUTHOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

Imported modules   
import os
import string
import sys
import time
import traceback
Functions   
createTestInstance
findTestCases
getTestCaseNames
makeSuite
  createTestInstance  
createTestInstance (
        name,
        module=None,
        suiteClass=TestSuite,
        )

Finds tests by their name, optionally only within the given module.

Return the newly-constructed test, ready to run. If the name contains a : then the portion of the name after the colon is used to find a specific test case within the test case class named before the colon.

Examples: findTest(examples.listtests.suite) -- returns result of calling suite findTest(examples.listtests.ListTestCase:checkAppend) -- returns result of calling ListTestCase(checkAppend) findTest(examples.listtests.ListTestCase:check-) -- returns result of calling makeSuite(ListTestCase, prefix="check")

Exceptions   
TypeError, "object %s found with spec %s is not a test" %( test, name )
ValueError, "%s is not a callable object" % constructor
ValueError, "illegal test name: %s" % name
ValueError, "incomplete test name: %s" % name
ValueError, "prefix too short: %s" % name
  findTestCases  
findTestCases (
        module,
        prefix='test',
        sortUsing=cmp,
        suiteClass=TestSuite,
        )

  getTestCaseNames  
getTestCaseNames (
        testCaseClass,
        prefix,
        sortUsing=cmp,
        )

Extracts all the names of functions in the given test case class and its base classes that start with the given prefix. This is used by makeSuite().

  makeSuite  
makeSuite (
        testCaseClass,
        prefix='test',
        sortUsing=cmp,
        suiteClass=TestSuite,
        )

Returns a TestSuite instance built from all of the test functions in the given test case class whose names begin with the given prefix. The cases are sorted by their function names using the supplied comparison function, which defaults to cmp.

Classes   
FunctionTestCase

A test case that wraps a test function.

JUnitTextTestRunner

A test runner class that displays results in textual form.

TestCase

A class whose instances are single test cases.

TestProgram

A command-line program that runs a set of tests; this is primarily

TestResult

Holder for test result information.

TestSuite

A test suite is a composite test consisting of a number of TestCases.

VerboseTextTestRunner

A test runner class that displays results in textual form.

_JUnitTextTestResult

A test result class that can print formatted text results to a stream.

_VerboseTextTestResult

A test result class that can print formatted text results to a stream.

_WritelnDecorator

Used to decorate file-like objects with a handy writeln method

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:29 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Testing/unittest_FunctionTestCase.py.html0100600000176200017510000002046707306455622030556 0ustar dhellmanndevel Class: FunctionTestCase

Table of Contents

Class: FunctionTestCase Zope-2-CVS-src/lib/python/Testing/unittest.py

A test case that wraps a test function.

This is useful for slipping pre-existing test functions into the PyUnit framework. Optionally, set-up and tidy-up functions can be supplied. As with TestCase, the tidy-up (tearDown) function will always be called if the set-up (setUp) function ran successfully.

Base Classes   
TestCase
Methods   
__init__
__repr__
__str__
id
runTest
setUp
shortDescription
tearDown
  __init__  
__init__ (
        self,
        testFunc,
        setUp=None,
        tearDown=None,
        description=None,
        )

  __repr__  
__repr__ ( self )

  __str__  
__str__ ( self )

  id  
id ( self )

  runTest  
runTest ( self )

  setUp  
setUp ( self )

  shortDescription  
shortDescription ( self )

  tearDown  
tearDown ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:29 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Testing/unittest_JUnitTextTestRunner.py.html0100600000176200017510000000656307306455622031266 0ustar dhellmanndevel Class: JUnitTextTestRunner

Table of Contents

Class: JUnitTextTestRunner Zope-2-CVS-src/lib/python/Testing/unittest.py

A test runner class that displays results in textual form.

The display format approximates that of JUnit's textui test runner. This test runner may be removed in a future version of PyUnit.

Methods   
__init__
run
  __init__  
__init__ ( self,  stream=sys.stderr )

  run  
run ( self,  test )

Run the given test case or test suite.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:29 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Testing/unittest_TestCase.py.html0100600000176200017510000004560607306455622027052 0ustar dhellmanndevel Class: TestCase

Table of Contents

Class: TestCase Zope-2-CVS-src/lib/python/Testing/unittest.py

A class whose instances are single test cases.

Test authors should subclass TestCase for their own tests. Construction and deconstruction of the test's environment (fixture) can be implemented by overriding the setUp and tearDown methods respectively.

By default, the test code itself should be placed in a method named runTest.

If the fixture may be used for many test cases, create as many test methods as are needed. When instantiating such a TestCase subclass, specify in the constructor arguments the name of the test method that the instance is to execute.

If it is necessary to override the __init__ method, the base class __init__ method must always be called.

Methods   
__call__
__exc_info
__init__
__repr__
__str__
assertEqual
assertRaises
assert_
countTestCases
debug
 defaultTestResult
fail
failIf
id
run
setUp
shortDescription
tearDown
  __call__  
__call__ ( self,  result=None )

  __exc_info  
__exc_info ( self )

Return a version of sys.exc_info() with the traceback frame minimised; usually the top level of the traceback frame is not needed.

  __init__  
__init__ (
        self,
        methodName='runTest',
        *args,
        *kw,
        )

Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.

Exceptions   
ValueError, "no such test method in %s: %s" %( self.__class__, methodName )
  __repr__  
__repr__ ( self )

  __str__  
__str__ ( self )

  assertEqual  
assertEqual (
        self,
        first,
        second,
        msg=None,
        )

Assert that the two objects are equal as determined by the == operator.

  assertRaises  
assertRaises (
        self,
        excClass,
        callableObj,
        *args,
        *kwargs,
        )

Assert that an exception of class excClass is thrown by callableObj when invoked with arguments args and keyword arguments kwargs. If a different type of exception is thrown, it will not be caught, and the test case will be deemed to have suffered an error, exactly as for an unexpected exception.

Exceptions   
AssertionError, excName
  assert_  
assert_ (
        self,
        expr,
        msg=None,
        )

Equivalent of built-in assert, but is not optimised out when __debug__ is false.

Exceptions   
AssertionError, msg
  countTestCases  
countTestCases ( self )

  debug  
debug ( self )

Run the test without collecting errors in a TestResult

  defaultTestResult  
defaultTestResult ( self )

  fail  
fail ( self,  msg=None )

Fail immediately, with the given message.

Exceptions   
AssertionError, msg
  failIf  
failIf (
        self,
        expr,
        msg=None,
        )

Fail the test if the expression is true.

  id  
id ( self )

  run  
run ( self,  result=None )

  setUp  
setUp ( self )

Hook method for setting up the test fixture before exercising it.

  shortDescription  
shortDescription ( self )

Returns a one-line description of the test, or None if no description has been provided.

The default implementation of this method returns the first line of the specified test method's docstring.

  tearDown  
tearDown ( self )

Hook method for deconstructing the test fixture after testing it.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:29 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Testing/unittest_TestProgram.py.html0100600000176200017510000001273007306455622027576 0ustar dhellmanndevel Class: TestProgram

Table of Contents

Class: TestProgram Zope-2-CVS-src/lib/python/Testing/unittest.py

A command-line program that runs a set of tests; this is primarily for making test modules conveniently executable.

Methods   
__init__
createTests
parseArgs
runTests
usageExit
  __init__  
__init__ (
        self,
        module='__main__',
        defaultTest=None,
        argv=None,
        testRunner=None,
        suiteClass=TestSuite,
        )

  createTests  
createTests ( self )

  parseArgs  
parseArgs ( self,  argv )

  runTests  
runTests ( self )

  usageExit  
usageExit ( self,  msg=None )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:29 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Testing/unittest_TestResult.py.html0100600000176200017510000001751007306455622027446 0ustar dhellmanndevel Class: TestResult

Table of Contents

Class: TestResult Zope-2-CVS-src/lib/python/Testing/unittest.py

Holder for test result information.

Test results are automatically managed by the TestCase and TestSuite classes, and do not need to be explicitly manipulated by writers of tests.

Each instance holds the total number of tests run, and collections of failures and errors that occurred among those test runs. The collections contain tuples of (testcase, exceptioninfo), where exceptioninfo is a tuple of values as returned by sys.exc_info().

Methods   
__init__
__repr__
addError
addFailure
startTest
stop
stopTest
wasSuccessful
  __init__  
__init__ (
        self,
        args=(),
        kw={},
        )

  __repr__  
__repr__ ( self )

  addError  
addError (
        self,
        test,
        err,
        )

Called when an error has occurred

  addFailure  
addFailure (
        self,
        test,
        err,
        )

Called when a failure has occurred

  startTest  
startTest ( self,  test )

Called when the given test is about to be run

  stop  
stop ( self )

Indicates that the tests should be aborted

  stopTest  
stopTest ( self,  test )

Called when the given test has been run

  wasSuccessful  
wasSuccessful ( self )

Tells whether or not this result was a success

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:29 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Testing/unittest_TestSuite.py.html0100600000176200017510000001723607306455622027266 0ustar dhellmanndevel Class: TestSuite

Table of Contents

Class: TestSuite Zope-2-CVS-src/lib/python/Testing/unittest.py

A test suite is a composite test consisting of a number of TestCases.

For use, create an instance of TestSuite, then add test case instances. When all tests have been added, the suite can be passed to a test runner, such as TextTestRunner. It will run the individual test cases in the order in which they were added, aggregating the results. When subclassing, do not forget to call the base class constructor.

Methods   
__call__
__init__
__repr__
addTest
addTests
countTestCases
debug
run
  __call__  
__call__ ( self,  result )

  __init__  
__init__ ( self,  tests=() )

  __repr__  
__repr__ ( self )

  addTest  
addTest ( self,  test )

  addTests  
addTests ( self,  tests )

  countTestCases  
countTestCases ( self )

  debug  
debug ( self )

Run the tests without collecting errors in a TestResult

  run  
run ( self,  result )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:29 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Testing/unittest_VerboseTextTestRunner.py.html0100600000176200017510000000663007306455622031635 0ustar dhellmanndevel Class: VerboseTextTestRunner

Table of Contents

Class: VerboseTextTestRunner Zope-2-CVS-src/lib/python/Testing/unittest.py

A test runner class that displays results in textual form.

It prints out the names of tests as they are run, errors as they occur, and a summary of the results at the end of the test run.

Methods   
__init__
run
  __init__  
__init__ (
        self,
        stream=sys.stderr,
        descriptions=1,
        )

  run  
run ( self,  test )

Run the given test case or test suite.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:29 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Testing/unittest__JUnitTextTestResult.py.html0100600000176200017510000002173307306455622031426 0ustar dhellmanndevel Class: _JUnitTextTestResult

Table of Contents

Class: _JUnitTextTestResult Zope-2-CVS-src/lib/python/Testing/unittest.py

A test result class that can print formatted text results to a stream.

Used by JUnitTextTestRunner.

Base Classes   
TestResult
Methods   
__init__
addError
addFailure
printErrors
printFailures
printHeader
printNumberedErrors
printResult
startTest
  __init__  
__init__ ( self,  stream )

  addError  
addError (
        self,
        test,
        error,
        )

  addFailure  
addFailure (
        self,
        test,
        error,
        )

  printErrors  
printErrors ( self )

  printFailures  
printFailures ( self )

  printHeader  
printHeader ( self )

  printNumberedErrors  
printNumberedErrors (
        self,
        errFlavour,
        errors,
        )

  printResult  
printResult ( self )

  startTest  
startTest ( self,  test )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:29 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Testing/unittest__VerboseTextTestResult.py.html0100600000176200017510000001562007306455622032000 0ustar dhellmanndevel Class: _VerboseTextTestResult

Table of Contents

Class: _VerboseTextTestResult Zope-2-CVS-src/lib/python/Testing/unittest.py

A test result class that can print formatted text results to a stream.

Used by VerboseTextTestRunner.

Base Classes   
TestResult
Methods   
__init__
_printError
addError
addFailure
startTest
stopTest
  __init__  
__init__ (
        self,
        stream,
        descriptions,
        )

  _printError  
_printError (
        self,
        flavour,
        test,
        err,
        )

  addError  
addError (
        self,
        test,
        err,
        )

  addFailure  
addFailure (
        self,
        test,
        err,
        )

  startTest  
startTest ( self,  test )

  stopTest  
stopTest ( self,  test )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:29 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Testing/unittest__WritelnDecorator.py.html0100600000176200017510000000766407306455622030767 0ustar dhellmanndevel Class: _WritelnDecorator

Table of Contents

Class: _WritelnDecorator Zope-2-CVS-src/lib/python/Testing/unittest.py

Used to decorate file-like objects with a handy writeln method

Methods   
__getattr__
__init__
writeln
  __getattr__  
__getattr__ ( self,  attr )

  __init__  
__init__ ( self,  stream )

  writeln  
writeln ( self,  *args )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:29 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/TreeDisplay/0040700000176200017510000000000007306455623022662 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/TreeDisplay/index.html0100600000176200017510000000416407306455623024663 0ustar dhellmanndevel Zope2 CVS with ZEO: TreeDisplay

Table of Contents

Zope2 CVS with ZEO: TreeDisplay  
Modules and Packages   

Zope-2-CVS-src/lib/python/TreeDisplay/

TreeTag

Rendering object hierarchies as Trees

__init__

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/TreeDisplay/TreeTag.py.html0100600000176200017510000003073207306455623025536 0ustar dhellmanndevel Module: TreeTag

Table of Contents

Module: TreeTag Zope-2-CVS-src/lib/python/TreeDisplay/TreeTag.py

Rendering object hierarchies as Trees

Imported modules   
from DocumentTemplate.DT_String import String
from DocumentTemplate.DT_Util import *
from binascii import b2a_base64, a2b_base64
import re
from string import join, split, rfind, find, translate, replace
from urllib import quote, unquote
from zlib import compress, decompress
Functions   
apply_diff
decode_seq
encode_seq
encode_str
oid
tpRender
tpRenderTABLE
tpStateLevel
tpValuesIds
  apply_diff  
apply_diff (
        state,
        diff,
        expand,
        )

  decode_seq  
decode_seq ( state )

Convert an encoded string to a sequence

Exceptions   
'Illegal State', state
  encode_seq  
encode_seq ( state )

Convert a sequence to an encoded string

  encode_str  
encode_str ( state )

Convert a sequence to an encoded string

  oid  
oid ( self )

  tpRender  
tpRender (
        self,
        md,
        section,
        args,
        simple_type={ type( '' ) : 0, type( 1 ) : 0, type( 1.0 ) : 0 }.has_key,
        )

Render data organized as a tree.

We keep track of open nodes using a cookie. The cookie stored the tree state. State should be a tree represented like:

[] # all closed ['eagle'], # eagle is open ['eagle'], ['jeep', [1983, 1985]] # eagle, jeep, 1983 jeep and 1985 jeep

where the items are object ids. The state will be converted to a compressed and base64ed string that gets unencoded, uncompressed, and evaluated on the other side.

Note that ids used in state need not be connected to urls, since state manipulation is internal to rendering logic.

Note that to make eval safe, we do not allow the character * in the state.

  tpRenderTABLE  
tpRenderTABLE (
        self,
        id,
        root_url,
        url,
        state,
        substate,
        diff,
        data,
        colspan,
        section,
        md,
        treeData,
        level=0,
        args=None,
        simple_type={ type( '' ) : 0, type( 1 ) : 0, type( 1.0 ) : 0 }.has_key,
        )

Render a tree as a table

Exceptions   
ValidationError, unauth
  tpStateLevel  
tpStateLevel ( state,  level=0 )

  tpValuesIds  
tpValuesIds (
        self,
        get_items,
        args,
        simple_type={ type( '' ) : 0, type( 1 ) : 0, type( 1.0 ) : 0 }.has_key,
        )

Classes   
Tree

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/TreeDisplay/TreeTag_Tree.py.html0100600000176200017510000000764707306455623026526 0ustar dhellmanndevel Class: Tree

Table of Contents

Class: Tree Zope-2-CVS-src/lib/python/TreeDisplay/TreeTag.py

Methods   
__init__
render
  __init__  
__init__ ( self,  blocks )

Exceptions   
ParseError, _tm( 'branches and and branches_expr given', 'tree' )
ParseError, _tm( 'prefix is not a simple name', 'tree' )
  render  
render ( self,  md )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/TreeDisplay/__init__.py.html0100600000176200017510000000362107306455623025737 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/TreeDisplay/__init__.py

Imported modules   
import TreeTag

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:49 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/0040700000176200017510000000000007306455624022165 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/index.html0100600000176200017510000000557507306455624024175 0ustar dhellmanndevel Zope2 CVS with ZEO: ZClasses

Table of Contents

Zope2 CVS with ZEO: ZClasses  
Modules and Packages   

Zope-2-CVS-src/lib/python/ZClasses/

Basic

Basic Item class and class manager

Method

Basic Item class and class manager

ObjectManager

Object-manager mix-in for ZClasses

Property

Provide management of common instance property sheets

ZClass

Zope Classes

ZClassOwner

Zope Classes

__init__

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/Basic.py.html0100600000176200017510000000640207306455623024523 0ustar dhellmanndevel Module: Basic

Table of Contents

Module: Basic Zope-2-CVS-src/lib/python/ZClasses/Basic.py

Basic Item class and class manager

Imported modules   
import Acquisition
import ExtensionClass
import Globals
import OFS.Image
import OFS.PropertySheets
import Products
from string import split, join, strip
Classes   
ZClassBasicSheet

Provide management view for item classes

ZClassPermissionsSheet

Manage class permissions

ZClassViewsSheet

Provide an options management view

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/Basic_ZClassBasicSheet.py.html0100600000176200017510000001545507306455623027745 0ustar dhellmanndevel Class: ZClassBasicSheet

Table of Contents

Class: ZClassBasicSheet Zope-2-CVS-src/lib/python/ZClasses/Basic.py

Provide management view for item classes

Base Classes   
OFS.PropertySheets.PropertySheet
OFS.PropertySheets.View
Methods   
classIcon
classMetaType
class_id
manage_edit
show_class_id
zClassTitle
  classIcon  
classIcon ( self )

  classMetaType  
classMetaType ( self )

  class_id  
class_id ( self )

  manage_edit  
manage_edit (
        self,
        meta_type='',
        icon='',
        file='',
        class_id=None,
        title=None,
        selected=(),
        REQUEST=None,
        )

Set basic item properties.

  show_class_id  
show_class_id ( self )

  zClassTitle  
zClassTitle ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/Basic_ZClassPermissionsSheet.py.html0100600000176200017510000000775107306455623031237 0ustar dhellmanndevel Class: ZClassPermissionsSheet

Table of Contents

Class: ZClassPermissionsSheet Zope-2-CVS-src/lib/python/ZClasses/Basic.py

Manage class permissions

Base Classes   
OFS.PropertySheets.PropertySheet
OFS.PropertySheets.View
Methods   
manage_edit
possible_permissions
  manage_edit  
manage_edit (
        self,
        selected=[],
        REQUEST=None,
        )

Remove some permissions

  possible_permissions  
possible_permissions ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/Basic_ZClassViewsSheet.py.html0100600000176200017510000002030707306455623030011 0ustar dhellmanndevel Class: ZClassViewsSheet

Table of Contents

Class: ZClassViewsSheet Zope-2-CVS-src/lib/python/ZClasses/Basic.py

Provide an options management view

Base Classes   
OFS.PropertySheets.PropertySheet
OFS.PropertySheets.View
Methods   
data
manage_add
manage_delete
manage_edit
manage_first
zclass_productid
  data  
data ( self )

  manage_add  
manage_add (
        self,
        label,
        action,
        help,
        REQUEST=None,
        )

Add a view

Exceptions   
'Bad Request', ( 'Please provide a new label.' )
  manage_delete  
manage_delete (
        self,
        selected=[],
        REQUEST=None,
        )

Delete one or more views

  manage_edit  
manage_edit (
        self,
        actions=[],
        helps=[],
        REQUEST=None,
        )

Change view actions

Exceptions   
'Bad Request', 'wrong number of actions'
  manage_first  
manage_first (
        self,
        selected=[],
        REQUEST=None,
        )

Make some views first

  zclass_productid  
zclass_productid ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/Method.py.html0100600000176200017510000001204507306455623024722 0ustar dhellmanndevel Module: Method

Table of Contents

Module: Method Zope-2-CVS-src/lib/python/ZClasses/Method.py

Basic Item class and class manager

Imported modules   
from AccessControl.Permission import pname
from AccessControl.PermissionMapping import aqwrap, PermissionMapper
import Acquisition
import App.Dialogs
import App.Factory
import App.Product
import App.ProductRegistry
import ExtensionClass
import Globals
from OFS.DTMLMethod import DTMLMethod
import OFS.Folder
import OFS.PropertySheets
import OFS.content_types
from Products.PythonScripts.PythonScript import PythonScript
import ZClassOwner
import ZClasses
import marshal
from string import strip
Functions   
findMethodIds
  findMethodIds  
findMethodIds ( klass,  methodTypes=( MWp, MW, W ) )

Classes   
MW
MWp
W

Backward compat. Waaaaa

ZClassMethodsSheet

Manage instance methods

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/Method_MW.py.html0100600000176200017510000000747107306455623025334 0ustar dhellmanndevel Class: MW

Table of Contents

Class: MW Zope-2-CVS-src/lib/python/ZClasses/Method.py

Base Classes   
ExtensionClass.Base
Methods   
__init__
__of__
  __init__  
__init__ ( self,  meth )

  __of__  
__of__ ( self,  parent )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/Method_MWp.py.html0100600000176200017510000001100207306455623025475 0ustar dhellmanndevel Class: MWp

Table of Contents

Class: MWp Zope-2-CVS-src/lib/python/ZClasses/Method.py

Base Classes   
Globals.Persistent
Methods   
__getstate__
__init__
__of__
  __getstate__  
__getstate__ ( self )

  __init__  
__init__ ( self,  meth )

  __of__  
__of__ ( self,  parent )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/Method_W.py.html0100600000176200017510000001102407306455623025204 0ustar dhellmanndevel Class: W

Table of Contents

Class: W Zope-2-CVS-src/lib/python/ZClasses/Method.py

Backward compat. Waaaaa

Base Classes   
Globals.Persistent
MW
    ExtensionClass.Base
Methods   
__getattr__
__of__
  __getattr__  
__getattr__ ( self,  name )

Exceptions   
AttributeError, name
  __of__  
__of__ ( self,  parent )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/Method_ZClassMethodsSheet.py.html0100600000176200017510000004356107306455623030525 0ustar dhellmanndevel Class: ZClassMethodsSheet

Table of Contents

Class: ZClassMethodsSheet Zope-2-CVS-src/lib/python/ZClasses/Method.py

Manage instance methods

Base Classes   
OFS.PropertySheets.PropertySheet
OFS.PropertySheets.View
OFS.Folder.Folder
App.ProductRegistry.ProductRegistryMixin
ZClassOwner.ZClassOwner
Methods   
PUT_factory
__bobo_traverse__
_checkId
_constructor_prefix_string
_delOb
_delObject
_getOb
_getProductRegistryMetaTypes
_isBeingUsedAsAMethod
_setOb
 _setProductRegistryMetaTypes
manage
manage_FTPstat
manage_addDTMLMethod
manage_addPrincipiaFactory
meta_type
permissionMappingPossibleValues
possible_permissions
tpURL
  PUT_factory  
PUT_factory (
        self,
        name,
        typ,
        body,
        )

Hook PUT creation to make objects of the right type when new item uploaded via FTP/WebDAV.

  __bobo_traverse__  
__bobo_traverse__ (
        self,
        request,
        name,
        )

  _checkId  
_checkId (
        self,
        id,
        allow_dup=0,
        _reserved=( 'propertysheets', 'manage_workspace' ),
        )

Exceptions   
'Bad Request', 'The id, %s, is reseverd' % id
'Bad Request', ( 'The id %s is invalid - it is already in use.' % id )
  _constructor_prefix_string  
_constructor_prefix_string ( self,  pid )

  _delOb  
_delOb ( self,  id )

  _delObject  
_delObject (
        self,
        id,
        dp=1,
        )

  _getOb  
_getOb (
        self,
        id,
        default=_marker,
        )

  _getProductRegistryMetaTypes  
_getProductRegistryMetaTypes ( self )

  _isBeingUsedAsAMethod  
_isBeingUsedAsAMethod (
        self,
        REQUEST=None,
        wannaBe=0,
        )

  _setOb  
_setOb (
        self,
        id,
        object,
        )

  _setProductRegistryMetaTypes  
_setProductRegistryMetaTypes ( self,  v )

  manage  
manage ( self,  REQUEST )

  manage_FTPstat  
manage_FTPstat ( self,  REQUEST )

Psuedo stat used for FTP listings

FTP support

  manage_addDTMLMethod  
manage_addDTMLMethod (
        self,
        id,
        title='',
        file='',
        REQUEST=None,
        submit=None,
        )

Add a DTML Method using a management template

  manage_addPrincipiaFactory  
manage_addPrincipiaFactory (
        self,
        id,
        title,
        object_type,
        initial,
        permission=None,
        REQUEST=None,
        )

  meta_type  
meta_type ( self )

  permissionMappingPossibleValues  
permissionMappingPossibleValues ( self )

  possible_permissions  
possible_permissions ( self )

  tpURL  
tpURL ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/ObjectManager.py.html0100600000176200017510000000631707306455623026210 0ustar dhellmanndevel Module: ObjectManager

Table of Contents

Module: ObjectManager Zope-2-CVS-src/lib/python/ZClasses/ObjectManager.py

Object-manager mix-in for ZClasses

Imported modules   
import Globals
import OFS.ObjectManager
import Products
Classes   
ObjectManager
SubobjectsSheet

Provide management view for selecting sub-objects.

ZObjectManager

Mix-in for Object Management

ZObjectManagerPropertySheets

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/ObjectManager_ObjectManager.py.html0100600000176200017510000000630607306455623030767 0ustar dhellmanndevel Class: ObjectManager

Table of Contents

Class: ObjectManager Zope-2-CVS-src/lib/python/ZClasses/ObjectManager.py

Base Classes   
OFS.ObjectManager.ObjectManager
Methods   
all_meta_types
  all_meta_types  
all_meta_types ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/ObjectManager_SubobjectsSheet.py.html0100600000176200017510000001271407306455623031362 0ustar dhellmanndevel Class: SubobjectsSheet

Table of Contents

Class: SubobjectsSheet Zope-2-CVS-src/lib/python/ZClasses/ObjectManager.py

Provide management view for selecting sub-objects.

Base Classes   
OFS.PropertySheets.PropertySheet
OFS.PropertySheets.View
Methods   
isFolderish
manage_edit
possible_meta_types
selected_meta_types
  isFolderish  
isFolderish ( self )

  manage_edit  
manage_edit (
        self,
        meta_types=(),
        isFolderish=None,
        REQUEST=None,
        )

Edit object management properties

  possible_meta_types  
possible_meta_types ( self )

  selected_meta_types  
selected_meta_types ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/ObjectManager_ZObjectManager.py.html0100600000176200017510000000243307306455623031116 0ustar dhellmanndevel Class: ZObjectManager

Table of Contents

Class: ZObjectManager Zope-2-CVS-src/lib/python/ZClasses/ObjectManager.py

Mix-in for Object Management

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/ObjectManager_ZObjectManagerPropertySheets.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/ObjectManager_ZObjectManagerPropertySheets.py0100600000176200017510000000375007306455623033077 0ustar dhellmanndevel Class: ZObjectManagerPropertySheets

Table of Contents

Class: ZObjectManagerPropertySheets Zope-2-CVS-src/lib/python/ZClasses/ObjectManager.py

Base Classes   
OFS.PropertySheets.PropertySheets

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/Property.py.html0100600000176200017510000001310207306455624025322 0ustar dhellmanndevel Module: Property

Table of Contents

Module: Property Zope-2-CVS-src/lib/python/ZClasses/Property.py

Provide management of common instance property sheets

Imported modules   
from AccessControl.Permission import pname
import Acquisition
import Globals
import OFS.PropertyManager
import OFS.PropertySheets
import OFS.SimpleItem
from string import join, upper
Functions   
klass_sequence
rclass
  klass_sequence  
klass_sequence (
        klass,
        attr,
        result=None,
        )

  rclass  
rclass ( klass )

Classes   
ClassCaretaker
ZCommonSheet

Property Sheet that has properties common to all instances

ZInstanceSheet

Waaa this is too hard

ZInstanceSheets
ZInstanceSheetsSheet

Manage common property sheets

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/Property_ClassCaretaker.py.html0100600000176200017510000001121307306455623030271 0ustar dhellmanndevel Class: ClassCaretaker

Table of Contents

Class: ClassCaretaker Zope-2-CVS-src/lib/python/ZClasses/Property.py

Methods   
__delattr__
__getattr__
__init__
__setattr__
  __delattr__  
__delattr__ ( self,  name )

  __getattr__  
__getattr__ ( self,  name )

  __init__  
__init__ ( self,  klass )

  __setattr__  
__setattr__ (
        self,
        name,
        v,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/Property_ZCommonSheet.py.html0100600000176200017510000003243407306455623027765 0ustar dhellmanndevel Class: ZCommonSheet

Table of Contents

Class: ZCommonSheet Zope-2-CVS-src/lib/python/ZClasses/Property.py

Property Sheet that has properties common to all instances

Base Classes   
OFS.PropertySheets.PropertySheet
OFS.SimpleItem.Item
Methods   
__init__
_edit_widget_for_type
_view_widget_for_type
manage_afterAdd
manage_beforeDelete
manage_createEditor
manage_createView
manage_getPermissionMapping
manage_setPermissionMapping
p_self
 permissionMappingPossibleValues
v_self
  __init__  
__init__ (
        self,
        id,
        title,
        )

  _edit_widget_for_type  
_edit_widget_for_type (
        self,
        t,
        id,
        p,
        )

  _view_widget_for_type  
_view_widget_for_type (
        self,
        t,
        id,
        )

  manage_afterAdd  
manage_afterAdd (
        self,
        item,
        container,
        )

Exceptions   
ValueError, ( 'Non-empty propertysheets cannot currently be ' 'added (or copied).

' )

  manage_beforeDelete  
manage_beforeDelete (
        self,
        item,
        container,
        )

  manage_createEditor  
manage_createEditor (
        self,
        id,
        title='',
        REQUEST=None,
        )

Create an edit interface for a property sheet

  manage_createView  
manage_createView (
        self,
        id,
        title='',
        ps_view_type=None,
        REQUEST=None,
        )

Create a view of a property sheet

  manage_getPermissionMapping  
manage_getPermissionMapping ( self )

  manage_setPermissionMapping  
manage_setPermissionMapping (
        self,
        permission_names=[],
        class_permissions=[],
        REQUEST=None,
        )

Change property sheet permissions

Exceptions   
'Invalid class permission'
  p_self  
p_self ( self )

  permissionMappingPossibleValues  
permissionMappingPossibleValues ( self )

  v_self  
v_self ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/Property_ZInstanceSheet.py.html0100600000176200017510000000624307306455624030301 0ustar dhellmanndevel Class: ZInstanceSheet

Table of Contents

Class: ZInstanceSheet Zope-2-CVS-src/lib/python/ZClasses/Property.py

Waaa this is too hard

Base Classes   
OFS.PropertySheets.FixedSchema
OFS.PropertySheets.View
Methods   
v_self
  v_self  
v_self ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/Property_ZInstanceSheets.py.html0100600000176200017510000000632407306455624030464 0ustar dhellmanndevel Class: ZInstanceSheets

Table of Contents

Class: ZInstanceSheets Zope-2-CVS-src/lib/python/ZClasses/Property.py

Base Classes   
OFS.PropertySheets.PropertySheets
Globals.Persistent
Methods   
__propsets__
  __propsets__  
__propsets__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/Property_ZInstanceSheetsSheet.py.html0100600000176200017510000001411507306455624031452 0ustar dhellmanndevel Class: ZInstanceSheetsSheet

Table of Contents

Class: ZInstanceSheetsSheet Zope-2-CVS-src/lib/python/ZClasses/Property.py

Manage common property sheets

Base Classes   
OFS.Traversable.Traversable
OFS.PropertySheets.View
OFS.ObjectManager.ObjectManager
Methods   
_delOb
_setOb
all_meta_types
manage_addCommonSheet
tpURL
  _delOb  
_delOb ( self,  id )

  _setOb  
_setOb (
        self,
        id,
        value,
        )

  all_meta_types  
all_meta_types ( self )

  manage_addCommonSheet  
manage_addCommonSheet (
        self,
        id,
        title,
        REQUEST=None,
        )

Add a property sheet

  tpURL  
tpURL ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/ZClass.py.html0100600000176200017510000002557707306455624024720 0ustar dhellmanndevel Module: ZClass

Table of Contents

Module: ZClass Zope-2-CVS-src/lib/python/ZClasses/ZClass.py

Zope Classes

Imported modules   
import AccessControl.Role
from App.FactoryDispatcher import FactoryDispatcher
import Basic
from ComputedAttribute import ComputedAttribute
from ExtensionClass import Base
import Globals
import Method
import OFS.PropertySheets
import OFS.SimpleItem
from OFS.misc_ import p_
import Products
import Property
from ZPublisher.mapply import mapply
import marshal
import re
import string
import webdav.Collection
Functions   
PersistentClassDict
createZClassForBase
dbVersionEquals
findActions
find_class
manage_addZClass
  PersistentClassDict  
PersistentClassDict ( doc=None,  meta_type=None )

  createZClassForBase  
createZClassForBase (
        base_class,
        pack,
        nice_name=None,
        meta_type=None,
        )

  • Create a ZClass for base_class in pack (before a ProductContext is available). pack may be either the module which is to contain the ZClass or its globals(). If nice_name is passed, use it as the name for the created class, and create the "ugly" _ZClass_for_... name as an alias; otherwise, just use the "ugly" name.

    • Register the ZClass under its meta_type in the Products registries.

  dbVersionEquals  
dbVersionEquals ( ver )

  findActions  
findActions ( klass,  found )

  find_class  
find_class ( ob,  name )

Exceptions   
AttributeError, name
  manage_addZClass  
manage_addZClass (
        self,
        id,
        title='',
        baseclasses=[],
        meta_type='',
        CreateAFactory=0,
        REQUEST=None,
        zope_object=0,
        )

Add a Z Class

Exceptions   
'Bad Request', ( 'The id %s is invalid as a class name.' % id )
'Invalid class', b
Classes   
PersistentClass
Template
ZClass

Zope Class

ZClassSheets

Manage a collection of property sheets that provide ZClass management

ZObject

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/ZClass_PersistentClass.py.html0100600000176200017510000000631107306455624030107 0ustar dhellmanndevel Class: PersistentClass

Table of Contents

Class: PersistentClass Zope-2-CVS-src/lib/python/ZClasses/ZClass.py

Base Classes   
Base
webdav.Collection.Collection
Methods   
__class_init__
  __class_init__  
__class_init__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/ZClass_Template.py.html0100600000176200017510000000242407306455624026535 0ustar dhellmanndevel Class: Template

Table of Contents

Class: Template Zope-2-CVS-src/lib/python/ZClasses/ZClass.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/ZClass_ZClass.py.html0100600000176200017510000006313707306455624026171 0ustar dhellmanndevel Class: ZClass

Table of Contents

Class: ZClass Zope-2-CVS-src/lib/python/ZClasses/ZClass.py

Zope Class

Base Classes   
Base
webdav.Collection.Collection
OFS.SimpleItem.SimpleItem
Methods   
ZClassBaseClassNames
__call__
__init__
_getZClass
_new_class_id
_register
_setBasesHoldOnToYourButts
_unregister
_waaa_getJar
cb_isCopyable
 changeClassId
classDefinedAndInheritedPermissions
classDefinedPermissions
classInheritedPermissions
createInObjectManager
delClassAttr
fromRequest
getClassAttr
manage_FTPlist
manage_FTPstat
 manage_afterAdd
manage_afterClone
manage_beforeDelete
manage_options
objectValues
setClassAttr
tpValues
zclass_candidate_view_actions
zclass_product_name
ziconImage
  ZClassBaseClassNames  
ZClassBaseClassNames ( self )

  __call__  
__call__ (
        self,
        *args,
        *kw,
        )

  __init__  
__init__ (
        self,
        id,
        title,
        bases,
        zope_object=1,
        )

Build a Zope class

A Zope class is really a meta-class that manages an actual extension class that is instantiated to create instances.

  _getZClass  
_getZClass ( self )

  _new_class_id  
_new_class_id ( self )

  _register  
_register ( self )

Exceptions   
'Duplicate Class Ids'
  _setBasesHoldOnToYourButts  
_setBasesHoldOnToYourButts ( self,  bases )

  _unregister  
_unregister ( self )

  _waaa_getJar  
_waaa_getJar ( self )

  cb_isCopyable  
cb_isCopyable ( self )

  changeClassId  
changeClassId ( self,  newid=None )

  classDefinedAndInheritedPermissions  
classDefinedAndInheritedPermissions ( self )

  classDefinedPermissions  
classDefinedPermissions ( self )

  classInheritedPermissions  
classInheritedPermissions ( self )

  createInObjectManager  
createInObjectManager (
        self,
        id,
        REQUEST,
        RESPONSE=None,
        )

Create Z instance. If called with a RESPONSE, the RESPONSE will be redirected to the management screen of the new instance's parent Folder. Otherwise, the instance will be returned.

  delClassAttr  
delClassAttr ( self,  name )

  fromRequest  
fromRequest (
        self,
        id=None,
        REQUEST={},
        )

  getClassAttr  
getClassAttr (
        self,
        name,
        default=_marker,
        inherit=0,
        )

  manage_FTPlist  
manage_FTPlist ( self,  REQUEST )

Directory listing for FTP

FTP support

  manage_FTPstat  
manage_FTPstat ( self,  REQUEST )

Psuedo stat used for FTP listings

  manage_afterAdd  
manage_afterAdd (
        self,
        item,
        container,
        )

  manage_afterClone  
manage_afterClone ( self,  item )

  manage_beforeDelete  
manage_beforeDelete (
        self,
        item,
        container,
        )

  manage_options  
manage_options ( self )

  objectValues  
objectValues ( self,  filter=None )

  setClassAttr  
setClassAttr (
        self,
        name,
        value,
        )

  tpValues  
tpValues ( self )

  zclass_candidate_view_actions  
zclass_candidate_view_actions ( self )

  zclass_product_name  
zclass_product_name ( self )

  ziconImage  
ziconImage (
        self,
        REQUEST,
        RESPONSE,
        )

Display a class icon

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/ZClass_ZClassSheets.py.html0100600000176200017510000001555207306455624027343 0ustar dhellmanndevel Class: ZClassSheets

Table of Contents

Class: ZClassSheets Zope-2-CVS-src/lib/python/ZClasses/ZClass.py

Manage a collection of property sheets that provide ZClass management

Base Classes   
OFS.PropertySheets.PropertySheets
Methods   
__init__
manage_FTPlist
manage_FTPstat
manage_workspace
objectValues
  __init__  
__init__ ( self )

  manage_FTPlist  
manage_FTPlist ( self,  REQUEST )

Directory listing for FTP

FTP support

  manage_FTPstat  
manage_FTPstat ( self,  REQUEST )

Psuedo stat used for FTP listings

  manage_workspace  
manage_workspace ( self,  URL2 )

Emulate standard interface for use with navigation

isPrincipiaFolderish=1 def tpValues(self): return self.methods, self.common def tpURL(self): return propertysheets

Exceptions   
'Redirect', URL2 + '/manage_workspace'
  objectValues  
objectValues ( self,  filter=None )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/ZClass_ZObject.py.html0100600000176200017510000000242207306455624026320 0ustar dhellmanndevel Class: ZObject

Table of Contents

Class: ZObject Zope-2-CVS-src/lib/python/ZClasses/ZClass.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/ZClassOwner.py.html0100600000176200017510000000777407306455624025732 0ustar dhellmanndevel Module: ZClassOwner

Table of Contents

Module: ZClassOwner Zope-2-CVS-src/lib/python/ZClasses/ZClassOwner.py

Zope Classes

Imported modules   
import ExtensionClass
import Globals
import Products
import ZClass
Functions   
manage_subclassableClassNames
  manage_subclassableClassNames  
manage_subclassableClassNames ( self )

Classes   
ZClassOwner

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/ZClassOwner_ZClassOwner.py.html0100600000176200017510000000650607306455624030214 0ustar dhellmanndevel Class: ZClassOwner

Table of Contents

Class: ZClassOwner Zope-2-CVS-src/lib/python/ZClasses/ZClassOwner.py

Base Classes   
ExtensionClass.Base
Methods   
manage_addZClass
  manage_addZClass  
manage_addZClass (
        self,
        id,
        title='',
        baseclasses=[],
        meta_type='',
        CreateAFactory=0,
        REQUEST=None,
        zope_object=0,
        )

Add a ZClass

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZClasses/__init__.py.html0100600000176200017510000000371407306455624025245 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/ZClasses/__init__.py

Imported modules   
import ZClass
import ZClassOwner

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:50 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/0040700000176200017510000000000007306455625021074 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/index.html0100600000176200017510000000666207306455625023102 0ustar dhellmanndevel Zope2 CVS with ZEO: ZEO

Table of Contents

Zope2 CVS with ZEO: ZEO  
Modules and Packages   

Zope-2-CVS-src/lib/python/ZEO/

ClientCache

Implement a client cache

ClientStorage

Network ZODB storage client

Invalidator

Facility for (roughly) atomically invalidating cache entries.

StorageServer
__init__
fap

ZEO depends on recent versions of asyncore and cPickle

smac

Sized message async connections

start

Start the server storage.

tests

Zope2 CVS with ZEO: ZEO.tests

trigger
zrpc

Simple rpc mechanisms

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/tests/0040700000176200017510000000000007306455624022235 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/tests/index.html0100600000176200017510000000467307306455624024243 0ustar dhellmanndevel Zope2 CVS with ZEO: ZEO.tests

Table of Contents

Zope2 CVS with ZEO: ZEO.tests  
Modules and Packages   

Zope-2-CVS-src/lib/python/ZEO/tests/

Cache

Tests of the ZEO cache

__init__
forker

Library for forking storage server and connecting client storage

testZEO

Test suite for ZEO based on ZODB.tests

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:32 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/tests/Cache.py.html0100600000176200017510000000557307306455624024566 0ustar dhellmanndevel Module: Cache

Table of Contents

Module: Cache Zope-2-CVS-src/lib/python/ZEO/tests/Cache.py

Tests of the ZEO cache

Imported modules   
from ZODB.Transaction import Transaction
from ZODB.tests.MinPO import MinPO
from ZODB.tests.StorageTestBase import zodb_unpickle
Classes   
StorageWithCache
TransUndoStorageWithCache

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:32 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/tests/Cache_StorageWithCache.py.html0100600000176200017510000001032007306455624030014 0ustar dhellmanndevel Class: StorageWithCache

Table of Contents

Class: StorageWithCache Zope-2-CVS-src/lib/python/ZEO/tests/Cache.py

Methods   
checkAbortVersionInvalidation
checkCommitEmptyVersionInvalidation
checkCommitVersionInvalidation
  checkAbortVersionInvalidation  
checkAbortVersionInvalidation ( self )

  checkCommitEmptyVersionInvalidation  
checkCommitEmptyVersionInvalidation ( self )

  checkCommitVersionInvalidation  
checkCommitVersionInvalidation ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:32 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/tests/Cache_TransUndoStorageWithCache.py.html0100600000176200017510000000513507306455624031662 0ustar dhellmanndevel Class: TransUndoStorageWithCache

Table of Contents

Class: TransUndoStorageWithCache Zope-2-CVS-src/lib/python/ZEO/tests/Cache.py

Methods   
checkUndoInvalidation
  checkUndoInvalidation  
checkUndoInvalidation ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:32 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/tests/__init__.py.html0100600000176200017510000000243707306455624025316 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/ZEO/tests/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:32 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/tests/forker.py.html0100600000176200017510000001620307306455624025043 0ustar dhellmanndevel Module: forker

Table of Contents

Module: forker Zope-2-CVS-src/lib/python/ZEO/tests/forker.py

Library for forking storage server and connecting client storage

Imported modules   
import ThreadedAsync
import ZEO.ClientStorage
import ZEO.StorageServer
import asyncore
import atexit
import os
import profile
import sys
import time
import types
Functions   
run_server
start_zeo
start_zeo_server
  run_server  
run_server (
        storage,
        addr,
        rd,
        wr,
        )

  start_zeo  
start_zeo (
        storage,
        cache=None,
        cleanup=None,
        domain="AF_INET",
        storage_id="1",
        cache_size=20000000,
        )

Setup ZEO client-server for storage.

Returns a ClientStorage instance and a ZEOClientExit instance.

XXX Don't know if os.pipe() will work on Windows.

Exceptions   
ValueError, "bad domain: %s" % domain
  start_zeo_server  
start_zeo_server ( storage,  addr )

Classes   
ZEOClientExit

Used by client to cause server to exit

ZEOServerExit

Used to exit ZEO.StorageServer when run is done

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:32 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/tests/forker_ZEOClientExit.py.html0100600000176200017510000000625707306455624027561 0ustar dhellmanndevel Class: ZEOClientExit

Table of Contents

Class: ZEOClientExit Zope-2-CVS-src/lib/python/ZEO/tests/forker.py

Used by client to cause server to exit

Methods   
__init__
close
  __init__  
__init__ ( self,  pipe )

  close  
close ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:32 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/tests/forker_ZEOServerExit.py.html0100600000176200017510000001234707306455624027606 0ustar dhellmanndevel Class: ZEOServerExit

Table of Contents

Class: ZEOServerExit Zope-2-CVS-src/lib/python/ZEO/tests/forker.py

Used to exit ZEO.StorageServer when run is done

Base Classes   
asyncore.file_dispatcher
Methods   
handle_close
handle_read
readable
writable
  handle_close  
handle_close ( self )

  handle_read  
handle_read ( self )

  readable  
readable ( self )

  writable  
writable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:32 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/tests/testZEO.py.html0100600000176200017510000001655107306455624025116 0ustar dhellmanndevel Module: testZEO

Table of Contents

Module: testZEO Zope-2-CVS-src/lib/python/ZEO/tests/testZEO.py

Test suite for ZEO based on ZODB.tests

Imported modules   
import ThreadedAsync
import ZEO.ClientStorage
import ZEO.StorageServer
from ZEO.smac import Disconnected
from ZEO.tests import forker, Cache
import ZEO.trigger
from ZODB.FileStorage import FileStorage
from ZODB.tests import StorageTestBase, BasicStorage, VersionStorage, TransactionalUndoStorage, TransactionalUndoVersionStorage, PackableStorage, Synchronization, ConflictResolution
from ZODB.tests.MinPO import MinPO
from ZODB.tests.StorageTestBase import zodb_unpickle
import asyncore
import os
import random
import sys
import tempfile
import thread
import time
import types
import unittest
Functions   
get_methods
main
makeTestSuite
  get_methods  
get_methods ( klass )

  main  
main ()

  makeTestSuite  
makeTestSuite ( testname='' )

Classes   
ConnectionTests

Tests that explicitly manage the server process.

DummyDB
GenericTests

An abstract base class for ZEO tests

PackWaitWrapper
ZEOFileStorageTests
ZEOTestBase

Version of the storage test class that supports ZEO.

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:32 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/tests/testZEO_ConnectionTests.py.html0100600000176200017510000002150407306455624030312 0ustar dhellmanndevel Class: ConnectionTests

Table of Contents

Class: ConnectionTests Zope-2-CVS-src/lib/python/ZEO/tests/testZEO.py

Tests that explicitly manage the server process.

To test the cache or re-connection, these test cases explicit start and stop a ZEO storage server.

Base Classes   
ZEOTestBase
    StorageTestBase.StorageTestBase
Methods   
_startServer
checkBasicPersistence
checkReconnection
checkRollover
openClientStorage
setUp
shutdownServer
tearDown
  _startServer  
_startServer ( self,  create=1 )

  checkBasicPersistence  
checkBasicPersistence ( self )

Verify cached data persists across client storage instances.

To verify that the cache is being used, the test closes the server and then starts a new client with the server down.

  checkReconnection  
checkReconnection ( self )

Check that the client reconnects when a server restarts.

  checkRollover  
checkRollover ( self )

Check that the cache works when the files are swapped.

In this case, only one object fits in a cache file. When the cache files swap, the first object is effectively uncached.

  openClientStorage  
openClientStorage (
        self,
        cache='',
        cache_size=200000,
        wait=1,
        )

  setUp  
setUp ( self )

Start a ZEO server using a Unix domain socket

The ZEO server uses the storage object returned by the getStorage() method.

  shutdownServer  
shutdownServer ( self )

  tearDown  
tearDown ( self )

Try to cause the tests to halt

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:32 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/tests/testZEO_DummyDB.py.html0100600000176200017510000000501407306455624026467 0ustar dhellmanndevel Class: DummyDB

Table of Contents

Class: DummyDB Zope-2-CVS-src/lib/python/ZEO/tests/testZEO.py

Methods   
invalidate
  invalidate  
invalidate ( self,  *args )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:32 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/tests/testZEO_GenericTests.py.html0100600000176200017510000001257507306455624027577 0ustar dhellmanndevel Class: GenericTests

Table of Contents

Class: GenericTests Zope-2-CVS-src/lib/python/ZEO/tests/testZEO.py

An abstract base class for ZEO tests

A specific ZEO test run depends on having a real storage that the StorageServer provides access to. The GenericTests must be subclassed to provide an implementation of getStorage() that returns a specific storage, e.g. FileStorage.

Base Classes   
ZEOTestBase
    StorageTestBase.StorageTestBase
Cache.StorageWithCache
Cache.TransUndoStorageWithCache
BasicStorage.BasicStorage
VersionStorage.VersionStorage
PackableStorage.PackableStorage
Synchronization.SynchronizedStorage
ConflictResolution.ConflictResolvingStorage
ConflictResolution.ConflictResolvingTransUndoStorage
TransactionalUndoStorage.TransactionalUndoStorage
TransactionalUndoVersionStorage.TransactionalUndoVersionStorage
Methods   
checkLargeUpdate
setUp
tearDown
  checkLargeUpdate  
checkLargeUpdate ( self )

  setUp  
setUp ( self )

Start a ZEO server using a Unix domain socket

The ZEO server uses the storage object returned by the getStorage() method.

  tearDown  
tearDown ( self )

Try to cause the tests to halt

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:32 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/tests/testZEO_PackWaitWrapper.py.html0100600000176200017510000000764507306455624030246 0ustar dhellmanndevel Class: PackWaitWrapper

Table of Contents

Class: PackWaitWrapper Zope-2-CVS-src/lib/python/ZEO/tests/testZEO.py

Methods   
__getattr__
__init__
pack
  __getattr__  
__getattr__ ( self,  attr )

  __init__  
__init__ ( self,  storage )

  pack  
pack (
        self,
        t,
        f,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:32 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/tests/testZEO_ZEOFileStorageTests.py.html0100600000176200017510000001214007306455624030771 0ustar dhellmanndevel Class: ZEOFileStorageTests

Table of Contents

Class: ZEOFileStorageTests Zope-2-CVS-src/lib/python/ZEO/tests/testZEO.py

Base Classes   
GenericTests
    ZEOTestBase
      StorageTestBase.StorageTestBase
    Cache.StorageWithCache
    Cache.TransUndoStorageWithCache
    BasicStorage.BasicStorage
    VersionStorage.VersionStorage
    PackableStorage.PackableStorage
    Synchronization.SynchronizedStorage
    ConflictResolution.ConflictResolvingStorage
    ConflictResolution.ConflictResolvingTransUndoStorage
    TransactionalUndoStorage.TransactionalUndoStorage
    TransactionalUndoVersionStorage.TransactionalUndoVersionStorage
Methods   
delStorage
getStorage
setUp
  delStorage  
delStorage ( self )

  getStorage  
getStorage ( self )

  setUp  
setUp ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:32 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/tests/testZEO_ZEOTestBase.py.html0100600000176200017510000001225607306455624027264 0ustar dhellmanndevel Class: ZEOTestBase

Table of Contents

Class: ZEOTestBase Zope-2-CVS-src/lib/python/ZEO/tests/testZEO.py

Version of the storage test class that supports ZEO.

For ZEO, we don't always get the serialno/exception for a particular store as the return value from the store. But we will get no later than the return value from vote.

Base Classes   
StorageTestBase.StorageTestBase
Methods   
_dostore
_get_serial
  _dostore  
_dostore (
        self,
        oid=None,
        revid=None,
        data=None,
        version=None,
        already_pickled=0,
        )

Do a complete storage transaction.

The defaults are: - oid=None, ask the storage for a new oid - revid=None, use a revid of ZERO - data=None, pickle up some arbitrary data (the integer 7) - version=None, use the empty string version

Returns the object's new revision id.

  _get_serial  
_get_serial ( self,  r )

Return oid -> serialno dict from sequence of ZEO replies.

Exceptions   
RuntimeError, "unexpected ZEO response: no oid"
serial

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:32 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/ClientCache.py.html0100600000176200017510000001732207306455624024556 0ustar dhellmanndevel Module: ClientCache

Table of Contents

Module: ClientCache Zope-2-CVS-src/lib/python/ZEO/ClientCache.py

Implement a client cache

The cache is managed as two files, var/c0.zec and var/c1.zec.

Each cache file is a sequence of records of the form:

oid

8-byte object id

status

1-byte status v: valid, n: non-version valid, i: invalid

tlen

4-byte (unsigned) record length

vlen

2-bute (unsigned) version length

dlen

4-byte length of non-version data

serial

8-byte non-version serial (timestamp)

data

non-version data

version

Version string (if vlen > 0)

vdlen

4-byte length of version data (if vlen > 0)

vdata

version data (if vlen > 0)

vserial

8-byte version serial (timestamp) (if vlen > 0)

tlen

4-byte (unsigned) record length (for redundancy and backward traversal)

There is a cache size limit.

The cache is managed as follows:

  • Data are written to file 0 until file 0 exceeds limit/2 in size.

  • Data are written to file 1 until file 1 exceeds limit/2 in size.

  • File 0 is truncated to size 0 (or deleted and recreated).

  • Data are written to file 0 until file 0 exceeds limit/2 in size.

  • File 1 is truncated to size 0 (or deleted and recreated).

  • Data are written to file 1 until file 1 exceeds limit/2 in size.

and so on.

On startup, index information is read from file 0 and file 1. Current serial numbers are sent to the server for verification. If any serial numbers are not valid, then the server will send back invalidation messages and the cache entries will be invalidated.

When a cache record is invalidated, the data length is overwritten with \0\0\0\0.

If var is not writable, then temporary files are used for file 0 and file 1.

Imported modules   
import os
from struct import pack, unpack
import tempfile
from thread import allocate_lock
import zLOG
Functions   
LOG
main
read_index
  LOG  
LOG ( msg,  level=zLOG.BLATHER )

  main  
main ( files )

  read_index  
read_index (
        index,
        serial,
        f,
        current,
        )

Classes   
ClientCache

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/ClientCache_ClientCache.py.html0100600000176200017510000002234207306455624026776 0ustar dhellmanndevel Class: ClientCache

Table of Contents

Class: ClientCache Zope-2-CVS-src/lib/python/ZEO/ClientCache.py

Methods   
__init__
_store
checkSize
close
invalidate
load
modifiedInVersion
open
store
update
  __init__  
__init__ (
        self,
        storage='',
        size=20000000,
        client=None,
        var=None,
        )

  _store  
_store (
        self,
        oid,
        p,
        s,
        version,
        pv,
        sv,
        )

  checkSize  
checkSize ( self,  size )

  close  
close ( self )

  invalidate  
invalidate (
        self,
        oid,
        version,
        )

  load  
load (
        self,
        oid,
        version,
        )

  modifiedInVersion  
modifiedInVersion ( self,  oid )

  open  
open ( self )

  store  
store (
        self,
        oid,
        p,
        s,
        version,
        pv,
        sv,
        )

  update  
update (
        self,
        oid,
        serial,
        version,
        data,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/ClientStorage.py.html0100600000176200017510000001313307306455625025154 0ustar dhellmanndevel Module: ClientStorage

Table of Contents

Module: ClientStorage Zope-2-CVS-src/lib/python/ZEO/ClientStorage.py

Network ZODB storage client

Imported modules   
import ClientCache
import ExtensionClass
import Invalidator
import Sync
import ThreadedAsync
from ZODB import POSException, BaseStorage
from ZODB.TimeStamp import TimeStamp
import os
import socket
import string
import struct
from struct import pack, unpack
import tempfile
import thread
import time
from zLOG import LOG, PROBLEM, INFO
import zrpc
Functions   
getWakeup
  getWakeup  
getWakeup ( _w=[] )

Classes   
ClientDisconnected

The database storage is disconnected from the storage.

ClientStorage
ClientStorageError

An error occured in the ZEO Client Storage

UnrecognizedResult

A server call returned an unrecognized result

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/ClientStorage_ClientDisconnected.py.html0100600000176200017510000000406007306455624030773 0ustar dhellmanndevel Class: ClientDisconnected

Table of Contents

Class: ClientDisconnected Zope-2-CVS-src/lib/python/ZEO/ClientStorage.py

The database storage is disconnected from the storage.

Base Classes   
ClientStorageError
    POSException.StorageError

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/ClientStorage_ClientStorage.py.html0100600000176200017510000007636507306455625030017 0ustar dhellmanndevel Class: ClientStorage

Table of Contents

Class: ClientStorage Zope-2-CVS-src/lib/python/ZEO/ClientStorage.py

Base Classes   
ExtensionClass.Base
BaseStorage.BaseStorage
Methods   
__init__
__len__
_startup
abortVersion
becomeAsync
close
commitVersion
getName
getSize
history
load
 loadSerial
modifiedInVersion
new_oid
notifyConnected
notifyDisconnected
pack
registerDB
store
supportsTransactionalUndo
supportsUndo
supportsVersions
 sync
tpc_abort
tpc_begin
tpc_finish
tpc_vote
transactionalUndo
undo
undoInfo
undoLog
versionEmpty
versions
  __init__  
__init__ (
        self,
        connection,
        storage='1',
        cache_size=20000000,
        name='',
        client='',
        debug=0,
        var=None,
        min_disconnect_poll=5,
        max_disconnect_poll=300,
        wait_for_server_on_startup=1,
        )

  __len__  
__len__ ( self )

  _startup  
_startup ( self )

  abortVersion  
abortVersion (
        self,
        src,
        transaction,
        )

Exceptions   
POSException.StorageTransactionError( self, transaction )
  becomeAsync  
becomeAsync ( self,  map )

  close  
close ( self )

  commitVersion  
commitVersion (
        self,
        src,
        dest,
        transaction,
        )

Exceptions   
POSException.StorageTransactionError( self, transaction )
  getName  
getName ( self )

  getSize  
getSize ( self )

  history  
history (
        self,
        oid,
        version,
        length=1,
        )

  load  
load (
        self,
        oid,
        version,
        _stuff=None,
        )

Exceptions   
KeyError, oid
  loadSerial  
loadSerial (
        self,
        oid,
        serial,
        )

  modifiedInVersion  
modifiedInVersion ( self,  oid )

  new_oid  
new_oid ( self,  last=None )

  notifyConnected  
notifyConnected ( self,  s )

  notifyDisconnected  
notifyDisconnected ( self,  ignored )

  pack  
pack (
        self,
        t=None,
        rf=None,
        wait=0,
        days=0,
        )

  registerDB  
registerDB (
        self,
        db,
        limit,
        )

Register that the storage is controlled by the given DB.

  store  
store (
        self,
        oid,
        serial,
        data,
        version,
        transaction,
        )

Exceptions   
POSException.StorageTransactionError( self, transaction )
  supportsTransactionalUndo  
supportsTransactionalUndo ( self )

  supportsUndo  
supportsUndo ( self )

  supportsVersions  
supportsVersions ( self )

  sync  
sync ( self )

  tpc_abort  
tpc_abort ( self,  transaction )

  tpc_begin  
tpc_begin ( self,  transaction )

Exceptions   
ClientDisconnected( "This action is temporarily unavailable.

" )

  tpc_finish  
tpc_finish (
        self,
        transaction,
        f=None,
        )

Exceptions   
ClientStorageError, ( "Unexpected end of file in client storage " "temporary file." )
  tpc_vote  
tpc_vote ( self,  transaction )

  transactionalUndo  
transactionalUndo (
        self,
        trans_id,
        trans,
        )

Exceptions   
POSException.StorageTransactionError( self, transaction )
  undo  
undo ( self,  transaction_id )

  undoInfo  
undoInfo (
        self,
        first=0,
        last=-20,
        specification=None,
        )

  undoLog  
undoLog (
        self,
        first,
        last,
        filter=None,
        )

  versionEmpty  
versionEmpty ( self,  version )

  versions  
versions ( self,  max=None )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/ClientStorage_ClientStorageError.py.html0100600000176200017510000000371107306455625031012 0ustar dhellmanndevel Class: ClientStorageError

Table of Contents

Class: ClientStorageError Zope-2-CVS-src/lib/python/ZEO/ClientStorage.py

An error occured in the ZEO Client Storage

Base Classes   
POSException.StorageError

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/ClientStorage_UnrecognizedResult.py.html0100600000176200017510000000404707306455625031073 0ustar dhellmanndevel Class: UnrecognizedResult

Table of Contents

Class: UnrecognizedResult Zope-2-CVS-src/lib/python/ZEO/ClientStorage.py

A server call returned an unrecognized result

Base Classes   
ClientStorageError
    POSException.StorageError

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/Invalidator.py.html0100600000176200017510000000543307306455625024671 0ustar dhellmanndevel Module: Invalidator

Table of Contents

Module: Invalidator Zope-2-CVS-src/lib/python/ZEO/Invalidator.py

Facility for (roughly) atomically invalidating cache entries.

Note that this is not really atomic, but it is close enough.

Imported modules   
import cPickle
import tempfile
Classes   
Invalidator

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/Invalidator_Invalidator.py.html0100600000176200017510000001237707306455625027232 0ustar dhellmanndevel Class: Invalidator

Table of Contents

Class: Invalidator Zope-2-CVS-src/lib/python/ZEO/Invalidator.py

Methods   
Invalidate
__init__
begin
end
invalidate
  Invalidate  
Invalidate ( self,  args )

  __init__  
__init__ (
        self,
        dinvalidate,
        cinvalidate,
        )

  begin  
begin ( self )

  end  
end ( self )

  invalidate  
invalidate ( self,  args )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/StorageServer.py.html0100600000176200017510000001723107306455625025207 0ustar dhellmanndevel Module: StorageServer

Table of Contents

Module: StorageServer Zope-2-CVS-src/lib/python/ZEO/StorageServer.py

Imported modules   
from ZODB import POSException
from ZODB.POSException import TransactionError, UndoError, VersionCommitError
from ZODB.Transaction import Transaction
from ZODB.referencesf import referencesf
import asyncore
import cPickle
from cPickle import Unpickler
from cStringIO import StringIO
import os
from smac import SizedMessageAsyncConnection
import socket
import string
import sys
from thread import start_new_thread
import traceback
from zLOG import LOG, INFO, ERROR, TRACE
Functions   
blather
find_global
init_storage
  blather  
blather ( *args )

  find_global  
find_global (
        module,
        name,
        global_dict=globals(),
        silly=( '__doc__', ),
        )

Exceptions   
StorageServerError, 'Unsafe global, %s.%s' %( module, name )
StorageServerError, ( "Couldn\'t import global module %s" % module )
StorageServerError, ("Couldn\'t find global %s in module %s" %( name, module ) )
  init_storage  
init_storage ( storage )

Classes   
StorageServer
StorageServerError
ZEOConnection

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/StorageServer_StorageServer.py.html0100600000176200017510000002374407306455625030070 0ustar dhellmanndevel Class: StorageServer

Table of Contents

Class: StorageServer Zope-2-CVS-src/lib/python/ZEO/StorageServer.py

Base Classes   
asyncore.dispatcher
Methods   
__init__
handle_accept
handle_connect
handle_read
invalidate
log_info
readable
register_connection
unregister_connection
writable
  __init__  
__init__ (
        self,
        connection,
        storages,
        )

  handle_accept  
handle_accept ( self )

  handle_connect  
handle_connect ( self )

  handle_read  
handle_read ( self )

  invalidate  
invalidate (
        self,
        connection,
        storage_id,
        invalidated=(),
        info=0,
        dump=dump,
        )

  log_info  
log_info (
        self,
        message,
        type='info',
        )

  readable  
readable ( self )

  register_connection  
register_connection (
        self,
        connection,
        storage_id,
        )

  unregister_connection  
unregister_connection (
        self,
        connection,
        storage_id,
        )

  writable  
writable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/StorageServer_StorageServerError.py.html0100600000176200017510000000370707306455625031077 0ustar dhellmanndevel Class: StorageServerError

Table of Contents

Class: StorageServerError Zope-2-CVS-src/lib/python/ZEO/StorageServer.py

Base Classes   
POSException.StorageError

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/StorageServer_ZEOConnection.py.html0100600000176200017510000006305407306455625027750 0ustar dhellmanndevel Class: ZEOConnection

Table of Contents

Class: ZEOConnection Zope-2-CVS-src/lib/python/ZEO/StorageServer.py

Base Classes   
SizedMessageAsyncConnection
Methods   
__init__
_pack
abortVersion
beginZeoVerify
close
commitVersion
endZeoVerify
get_info
get_size_info
message_input
 new_oids
pack
return_error
storea
tpc_abort
tpc_begin
tpc_begin_sync
tpc_finish
transactionalUndo
try_again_sync
 undo
unlock
vote
zeoLoad
zeoVerify
  __init__  
__init__ (
        self,
        server,
        sock,
        addr,
        )

  _pack  
_pack (
        self,
        t,
        wait=0,
        )

  abortVersion  
abortVersion (
        self,
        src,
        id,
        )

Exceptions   
POSException.StorageTransactionError( self, id )
  beginZeoVerify  
beginZeoVerify ( self )

  close  
close ( self )

  commitVersion  
commitVersion (
        self,
        src,
        dest,
        id,
        )

Exceptions   
POSException.StorageTransactionError( self, id )
  endZeoVerify  
endZeoVerify ( self )

  get_info  
get_info ( self )

  get_size_info  
get_size_info ( self )

  message_input  
message_input (
        self,
        message,
        dump=dump,
        Unpickler=Unpickler,
        StringIO=StringIO,
        None=None,
        )

Exceptions   
'Invalid Method Name', name
  new_oids  
new_oids ( self,  n=100 )

  pack  
pack (
        self,
        t,
        wait=0,
        )

  return_error  
return_error (
        self,
        err_type,
        err_value,
        type=type,
        dump=dump,
        )

  storea  
storea (
        self,
        oid,
        serial,
        data,
        version,
        id,
        dump=dump,
        )

Exceptions   
POSException.StorageTransactionError( self, id )
  tpc_abort  
tpc_abort ( self,  id )

  tpc_begin  
tpc_begin (
        self,
        id,
        user,
        description,
        ext,
        )

Exceptions   
StorageServerError( "Multiple simultaneous tpc_begin requests from the same " "client." )
  tpc_begin_sync  
tpc_begin_sync (
        self,
        id,
        user,
        description,
        ext,
        )

  tpc_finish  
tpc_finish (
        self,
        id,
        user,
        description,
        ext,
        )

  transactionalUndo  
transactionalUndo (
        self,
        trans_id,
        id,
        )

Exceptions   
POSException.StorageTransactionError( self, id )
  try_again_sync  
try_again_sync (
        self,
        id,
        user,
        description,
        ext,
        )

  undo  
undo ( self,  transaction_id )

  unlock  
unlock ( self )

  vote  
vote ( self,  id )

Exceptions   
POSException.StorageTransactionError( self, id )
  zeoLoad  
zeoLoad ( self,  oid )

  zeoVerify  
zeoVerify (
        self,
        oid,
        s,
        sv,
        dump=dump,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/__init__.py.html0100600000176200017510000000360107306455625024147 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/ZEO/__init__.py

Imported modules   
import fap

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/fap.py.html0100600000176200017510000001262207306455625023161 0ustar dhellmanndevel Module: fap

Table of Contents

Module: fap Zope-2-CVS-src/lib/python/ZEO/fap.py

ZEO depends on recent versions of asyncore and cPickle

Try to fix up the imports of these to make these dependencies work, localizing the hacks^H^H^H^H^Hchanges here.

Imported modules   
import os
import sys
Functions   
fap
package_home
whiff
  fap  
fap ()

Exceptions   
ImportError, 'Cannot import an up-to-date asyncore'
ImportError, 'Cannot import an up-to-date cPickle'
  package_home  
package_home ()

  whiff  
whiff ( where )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/smac.py.html0100600000176200017510000000634207306455625023340 0ustar dhellmanndevel Module: smac

Table of Contents

Module: smac Zope-2-CVS-src/lib/python/ZEO/smac.py

Sized message async connections

Imported modules   
import Acquisition
import asyncore
import string
import struct
import sys
import zLOG
from zLOG import LOG, TRACE, ERROR, INFO
Classes   
Disconnected

The client has become disconnected from the server

SizedMessageAsyncConnection

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/smac_Disconnected.py.html0100600000176200017510000000365407306455625026025 0ustar dhellmanndevel Class: Disconnected

Table of Contents

Class: Disconnected Zope-2-CVS-src/lib/python/ZEO/smac.py

The client has become disconnected from the server

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/smac_SizedMessageAsyncConnection.py.html0100600000176200017510000002325607306455625031024 0ustar dhellmanndevel Class: SizedMessageAsyncConnection

Table of Contents

Class: SizedMessageAsyncConnection Zope-2-CVS-src/lib/python/ZEO/smac.py

Base Classes   
Acquisition.Explicit
asyncore.dispatcher
Methods   
__init__
close
handle_close
handle_read
handle_write
log_info
message_output
readable
writable
  __init__  
__init__ (
        self,
        sock,
        addr,
        map=None,
        debug=None,
        )

  close  
close ( self )

  handle_close  
handle_close ( self )

  handle_read  
handle_read (
        self,
        join=string.join,
        StringType=type( '' ),
        _type=type,
        _None=None,
        )

  handle_write  
handle_write ( self )

  log_info  
log_info (
        self,
        message,
        type='info',
        )

  message_output  
message_output (
        self,
        message,
        pack=struct.pack,
        len=len,
        )

Exceptions   
Disconnected( "This action is temporarily unavailable.

" )

  readable  
readable ( self )

  writable  
writable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/start.py.html0100600000176200017510000001704007306455625023547 0ustar dhellmanndevel Module: start

Table of Contents

Module: start Zope-2-CVS-src/lib/python/ZEO/start.py

Start the server storage.

Imported modules   
import getopt
import os
import string
import sys
Functions   
directory
get_storage
main
rotate_logs
rotate_logs_handler
shutdown
  directory  
directory ( p,  n=1 )

  get_storage  
get_storage (
        m,
        n,
        cache={},
        )

  main  
main ( argv )

Exceptions   
KeyError
  rotate_logs  
rotate_logs ()

  rotate_logs_handler  
rotate_logs_handler ( signum,  frame )

  shutdown  
shutdown ( storages,  die=1 )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/trigger.py.html0100600000176200017510000000445207306455625024060 0ustar dhellmanndevel Module: trigger

Table of Contents

Module: trigger Zope-2-CVS-src/lib/python/ZEO/trigger.py

Imported modules   
import asyncore
import os
import socket
import string
import thread

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/zrpc.py.html0100600000176200017510000000735207306455625023375 0ustar dhellmanndevel Module: zrpc

Table of Contents

Module: zrpc Zope-2-CVS-src/lib/python/ZEO/zrpc.py

Simple rpc mechanisms

Imported modules   
import asyncore
import cPickle
from cPickle import loads
import select
from smac import SizedMessageAsyncConnection
import socket
import string
import struct
import sys
from thread import allocate_lock
import time
from zLOG import LOG, TRACE, DEBUG, INFO
Classes   
UnUnPickleableError

Couldn't unpickle a remote exception

asyncRPC

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/zrpc_UnUnPickleableError.py.html0100600000176200017510000000365407306455625027331 0ustar dhellmanndevel Class: UnUnPickleableError

Table of Contents

Class: UnUnPickleableError Zope-2-CVS-src/lib/python/ZEO/zrpc.py

Couldn't unpickle a remote exception

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZEO/zrpc_asyncRPC.py.html0100600000176200017510000004306407306455625025137 0ustar dhellmanndevel Class: asyncRPC

Table of Contents

Class: asyncRPC Zope-2-CVS-src/lib/python/ZEO/zrpc.py

Base Classes   
SizedMessageAsyncConnection
Methods   
__Wakeup
__call__
__getitem__
__init__
__len__
_read
close
closeIntensionally
connect
finishConnect
 items
keys
message_input
readLoop
sendMessage
setLoop
setOutOfBand
sync
values
  __Wakeup  
__Wakeup ( *args )

  __call__  
__call__ ( self,  *args )

Exceptions   
UnUnPickleableError(r [ 1 : ] )
UnrecognizedResult, r
r
r [ 0 ], r [ 1 ]
  __getitem__  
__getitem__ ( self,  key )

Exceptions   
KeyError, key
  __init__  
__init__ (
        self,
        connection,
        outOfBand=None,
        tmin=5,
        tmax=300,
        debug=0,
        )

  __len__  
__len__ ( self )

  _read  
_read ( self )

  close  
close ( self )

  closeIntensionally  
closeIntensionally ( self )

  connect  
connect (
        self,
        tryonce=1,
        log_type='client',
        )

  finishConnect  
finishConnect ( self,  s )

  items  
items ( self )

  keys  
keys ( self )

we are our own socket map!

  message_input  
message_input ( self,  m )

  readLoop  
readLoop ( self )

  sendMessage  
sendMessage ( self,  *args )

  setLoop  
setLoop (
        self,
        map=None,
        Wakeup=None,
        )

  setOutOfBand  
setOutOfBand ( self,  f )

Define a call-back function for handling out-of-band communication

Normal communications from the server consists of call returns and exception returns. The server may also send asynchronous messages to the client. For the client to recieve these messages, it must register an out-of-band callback function. The function will be called with a single-character message code and a message argument.

  sync  
sync ( self )

  values  
values ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:42:28 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZLogger/0040700000176200017510000000000007306455626022011 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZLogger/index.html0100600000176200017510000000532407306455626024011 0ustar dhellmanndevel Zope2 CVS with ZEO: ZLogger

Table of Contents

Zope2 CVS with ZEO: ZLogger  
Modules and Packages   

Zope-2-CVS-src/lib/python/ZLogger/

FileLogger
ZLogger
__init__
stupidFileLogger
syslog

socket interface to unix syslog.

syslogLogger
test_logger

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZLogger/FileLogger.py.html0100600000176200017510000000401707306455626025346 0ustar dhellmanndevel Module: FileLogger

Table of Contents

Module: FileLogger Zope-2-CVS-src/lib/python/ZLogger/FileLogger.py

Classes   
FileLogger

a File Logger

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZLogger/FileLogger_FileLogger.py.html0100600000176200017510000000656007306455626027452 0ustar dhellmanndevel Class: FileLogger

Table of Contents

Class: FileLogger Zope-2-CVS-src/lib/python/ZLogger/FileLogger.py

a File Logger

This is just a stub, FileLogger should be smarter than stupidFileLogger, but for the moment it's completely brain dead.

Methods   
__call__
__init__
  __call__  
__call__ (
        self,
        sub,
        sev,
        sum,
        det,
        err,
        )

  __init__  
__init__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZLogger/ZLogger.py.html0100600000176200017510000000667307306455626024712 0ustar dhellmanndevel Module: ZLogger

Table of Contents

Module: ZLogger Zope-2-CVS-src/lib/python/ZLogger/ZLogger.py

Imported modules   
import stupidFileLogger
import syslogLogger
from zLOG import *
Functions   
log_write
  log_write  
log_write (
        subsystem,
        severity,
        summary,
        detail,
        error,
        )

Hook into the logging system

The actual logic to determine what log messages go where will go here. For now, everything goes to all loggers.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZLogger/__init__.py.html0100600000176200017510000000361507306455626025071 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/ZLogger/__init__.py

Imported modules   
import ZLogger

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZLogger/stupidFileLogger.py.html0100600000176200017510000001077107306455626026603 0ustar dhellmanndevel Module: stupidFileLogger

Table of Contents

Module: stupidFileLogger Zope-2-CVS-src/lib/python/ZLogger/stupidFileLogger.py

Imported modules   
import os
import string
import sys
import thread
import time
from zLOG import severity_string, log_time, format_exception
Functions   
stupid_log_write
  stupid_log_write  
stupid_log_write (
        subsystem,
        severity,
        summary,
        detail,
        error,
        )

Classes   
stupidFileLogger

a stupid File Logger

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZLogger/stupidFileLogger_stupidFileLogger.py.html0100600000176200017510000000511307306455626032125 0ustar dhellmanndevel Class: stupidFileLogger

Table of Contents

Class: stupidFileLogger Zope-2-CVS-src/lib/python/ZLogger/stupidFileLogger.py

a stupid File Logger

Methods   
__call__
  __call__  
__call__ (
        self,
        sub,
        sev,
        sum,
        det,
        err,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZLogger/syslog.py.html0100600000176200017510000000720307306455626024647 0ustar dhellmanndevel Module: syslog

Table of Contents

Module: syslog Zope-2-CVS-src/lib/python/ZLogger/syslog.py

socket interface to unix syslog. On Unix, there are usually two ways of getting to syslog: via a local unix-domain socket, or via the TCP service.

Usually "/dev/log" is the unix domain socket. This may be different for other systems.

>>> my_client = syslog_client (/dev/log)

Otherwise, just use the UDP version, port 514.

>>> my_client = syslog_client ((my_log_host, 514))

On win32, you will have to use the UDP version. Note that you can use this to log to other hosts (and indeed, multiple hosts).

This module is not a drop-in replacement for the python <syslog> extension module - the interface is different.

Usage:

>>> c = syslog_client() >>> c = syslog_client (/strange/non_standard_log_location) >>> c = syslog_client ((other_host.com, 514)) >>> c.log (testing, facility='local0', priority='debug')

Imported modules   
import socket
Classes   
syslog_client

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZLogger/syslog_syslog_client.py.html0100600000176200017510000001126607306455626027611 0ustar dhellmanndevel Class: syslog_client

Table of Contents

Class: syslog_client Zope-2-CVS-src/lib/python/ZLogger/syslog.py

Methods   
__init__
close
encode_priority
log
  __init__  
__init__ ( self,  address='/dev/log' )

  close  
close ( self )

  encode_priority  
encode_priority (
        self,
        facility,
        priority,
        )

  log  
log (
        self,
        message,
        facility=LOG_USER,
        priority=LOG_INFO,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZLogger/syslogLogger.py.html0100600000176200017510000000606607306455626026015 0ustar dhellmanndevel Module: syslogLogger

Table of Contents

Module: syslogLogger Zope-2-CVS-src/lib/python/ZLogger/syslogLogger.py

Imported modules   
import os
import string
from syslog import syslog_client, LOG_ALERT, LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO, LOG_DEBUG
import traceback
Classes   
syslogLogger

a syslog Logger

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZLogger/syslogLogger_syslogLogger.py.html0100600000176200017510000000635607306455626030557 0ustar dhellmanndevel Class: syslogLogger

Table of Contents

Class: syslogLogger Zope-2-CVS-src/lib/python/ZLogger/syslogLogger.py

a syslog Logger

Methods   
__call__
__init__
  __call__  
__call__ (
        self,
        sub,
        sev,
        sum,
        det,
        err,
        )

  __init__  
__init__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZLogger/test_logger.py.html0100600000176200017510000000417007306455626025645 0ustar dhellmanndevel Module: test_logger

Table of Contents

Module: test_logger Zope-2-CVS-src/lib/python/ZLogger/test_logger.py

Imported modules   
import select
import socket
import sys

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/0040700000176200017510000000000007306455631021172 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/index.html0100600000176200017510000001266707306455631023202 0ustar dhellmanndevel Zope2 CVS with ZEO: ZODB

Table of Contents

Zope2 CVS with ZEO: ZODB  
Modules and Packages   

Zope-2-CVS-src/lib/python/ZODB/

BaseStorage

Handy standard storage machinery

ConflictResolution
Connection

Database connection support

DB

Database objects

DemoStorage

Demo ZODB storage

ExportImport

Support for database export and import.

FileStorage
MappingStorage

Very Simple Mapping ZODB storage

Mount

Mounted database support

POSException

BoboPOS-defined exceptions

PersistentMapping
TmpStore
Transaction

Transaction management

UndoLogCompatible

Provide backward compatability with storages that have undoLog, but not undoInfo.

ZApplication

Implement an bobo_application object that is BoboPOS3 aware

__init__
bpthread

Thread abstraction module

conversionhack
dbmStorage

Very Simple dbm-based ZODB storage

fsrecover

Simple script for repairing damaged FileStorage files.

lock_file
referencesf

Provide a function that can find object references in pickles

tests

Zope2 CVS with ZEO: ZODB.tests

utils

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/0040700000176200017510000000000007306455627022341 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/index.html0100600000176200017510000000724207306455627024342 0ustar dhellmanndevel Zope2 CVS with ZEO: ZODB.tests

Table of Contents

Zope2 CVS with ZEO: ZODB.tests  
Modules and Packages   

Zope-2-CVS-src/lib/python/ZODB/tests/

BasicStorage
ConflictResolution

Tests for application-level conflict resolution.

LocalStorage
MinPO

A minimal persistent object to use for tests

PackableStorage
TransactionalUndoStorage
TransactionalUndoVersionStorage
VersionStorage
__init__
speed
testFileStorage
testTransaction

High-level tests of the transaction interface

testZODB

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/BasicStorage.py.html0100600000176200017510000000546307306455626026232 0ustar dhellmanndevel Module: BasicStorage

Table of Contents

Module: BasicStorage Zope-2-CVS-src/lib/python/ZODB/tests/BasicStorage.py

Imported modules   
from ZODB import POSException
from ZODB.Transaction import Transaction
from ZODB.tests.MinPO import MinPO
from ZODB.tests.StorageTestBase import zodb_unpickle
Classes   
BasicStorage

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/BasicStorage_BasicStorage.py.html0100600000176200017510000001447607306455626030664 0ustar dhellmanndevel Class: BasicStorage

Table of Contents

Class: BasicStorage Zope-2-CVS-src/lib/python/ZODB/tests/BasicStorage.py

Methods   
checkBasics
checkConflicts
checkLoadSerial
checkNonVersionModifiedInVersion
checkNonVersionStore
checkNonVersionStoreAndLoad
  checkBasics  
checkBasics ( self )

  checkConflicts  
checkConflicts ( self )

  checkLoadSerial  
checkLoadSerial ( self )

  checkNonVersionModifiedInVersion  
checkNonVersionModifiedInVersion ( self )

  checkNonVersionStore  
checkNonVersionStore (
        self,
        oid=None,
        revid=None,
        version=None,
        )

  checkNonVersionStoreAndLoad  
checkNonVersionStoreAndLoad ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/ConflictResolution.py.html0100600000176200017510000000763507306455626027514 0ustar dhellmanndevel Module: ConflictResolution

Table of Contents

Module: ConflictResolution Zope-2-CVS-src/lib/python/ZODB/tests/ConflictResolution.py

Tests for application-level conflict resolution.

Imported modules   
from Persistence import Persistent
from ZODB.POSException import ConflictError, UndoError
from ZODB.Transaction import Transaction
from ZODB.tests.StorageTestBase import zodb_unpickle, zodb_pickle
from cPickle import Pickler, Unpickler
from cStringIO import StringIO
import sys
import types
Classes   
ConflictResolvingStorage
ConflictResolvingTransUndoStorage
PCounter
PCounter2
PCounter3
PCounter4

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015400000000000011565 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/ConflictResolution_ConflictResolvingStorage.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/ConflictResolution_ConflictResolvingStorage0100600000176200017510000001135107306455626033147 0ustar dhellmanndevel Class: ConflictResolvingStorage

Table of Contents

Class: ConflictResolvingStorage Zope-2-CVS-src/lib/python/ZODB/tests/ConflictResolution.py

Methods   
checkBuggyResolve1
checkBuggyResolve2
checkResolve
checkUnresolvable
  checkBuggyResolve1  
checkBuggyResolve1 ( self )

  checkBuggyResolve2  
checkBuggyResolve2 ( self )

  checkResolve  
checkResolve ( self )

  checkUnresolvable  
checkUnresolvable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016500000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/ConflictResolution_ConflictResolvingTransUndoStorage.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/ConflictResolution_ConflictResolvingTransUn0100600000176200017510000000721207306455626033136 0ustar dhellmanndevel Class: ConflictResolvingTransUndoStorage

Table of Contents

Class: ConflictResolvingTransUndoStorage Zope-2-CVS-src/lib/python/ZODB/tests/ConflictResolution.py

Methods   
checkUndoConflictResolution
checkUndoUnresolvable
  checkUndoConflictResolution  
checkUndoConflictResolution ( self )

This test is based on checkNotUndoable in the TransactionalUndoStorage test suite. Except here, conflict resolution should allow us to undo the transaction anyway.

  checkUndoUnresolvable  
checkUndoUnresolvable ( self )

This test is based on checkNotUndoable in the TransactionalUndoStorage test suite. Except here, conflict resolution should allow us to undo the transaction anyway.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/ConflictResolution_PCounter.py.html0100600000176200017510000001114007306455626031315 0ustar dhellmanndevel Class: PCounter

Table of Contents

Class: PCounter Zope-2-CVS-src/lib/python/ZODB/tests/ConflictResolution.py

Base Classes   
Persistent
Methods   
__repr__
_p_resolveConflict
inc
  __repr__  
__repr__ ( self )

  _p_resolveConflict  
_p_resolveConflict (
        self,
        oldState,
        savedState,
        newState,
        )

  inc  
inc ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/ConflictResolution_PCounter2.py.html0100600000176200017510000000775407306455626031417 0ustar dhellmanndevel Class: PCounter2

Table of Contents

Class: PCounter2 Zope-2-CVS-src/lib/python/ZODB/tests/ConflictResolution.py

Base Classes   
PCounter
    Persistent
Methods   
_p_resolveConflict
  _p_resolveConflict  
_p_resolveConflict (
        self,
        oldState,
        savedState,
        newState,
        )

Exceptions   
ConflictError

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/ConflictResolution_PCounter3.py.html0100600000176200017510000000777507306455626031423 0ustar dhellmanndevel Class: PCounter3

Table of Contents

Class: PCounter3 Zope-2-CVS-src/lib/python/ZODB/tests/ConflictResolution.py

Base Classes   
PCounter
    Persistent
Methods   
_p_resolveConflict
  _p_resolveConflict  
_p_resolveConflict (
        self,
        oldState,
        savedState,
        newState,
        )

Exceptions   
AttributeError, "no attribute"

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/ConflictResolution_PCounter4.py.html0100600000176200017510000000777407306455626031423 0ustar dhellmanndevel Class: PCounter4

Table of Contents

Class: PCounter4 Zope-2-CVS-src/lib/python/ZODB/tests/ConflictResolution.py

Base Classes   
PCounter
    Persistent
Methods   
_p_resolveConflict
  _p_resolveConflict  
_p_resolveConflict (
        self,
        oldState,
        savedState,
        )

Exceptions   
RuntimeError, "Can't get here; not enough args"

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/LocalStorage.py.html0100600000176200017510000000411507306455626026234 0ustar dhellmanndevel Module: LocalStorage

Table of Contents

Module: LocalStorage Zope-2-CVS-src/lib/python/ZODB/tests/LocalStorage.py

Classes   
LocalStorage

A single test that only make sense for local storages.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/LocalStorage_LocalStorage.py.html0100600000176200017510000000521007306455626030670 0ustar dhellmanndevel Class: LocalStorage

Table of Contents

Class: LocalStorage Zope-2-CVS-src/lib/python/ZODB/tests/LocalStorage.py

A single test that only make sense for local storages.

A local storage is one that doens't use ZEO. The __len__() implementation for ZEO is inexact.

Methods   
checkLen
  checkLen  
checkLen ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/MinPO.py.html0100600000176200017510000000513307306455626024640 0ustar dhellmanndevel Module: MinPO

Table of Contents

Module: MinPO Zope-2-CVS-src/lib/python/ZODB/tests/MinPO.py

A minimal persistent object to use for tests

Imported modules   
from Persistence import Persistent
Classes   
MinPO

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/MinPO_MinPO.py.html0100600000176200017510000001077407306455626025711 0ustar dhellmanndevel Class: MinPO

Table of Contents

Class: MinPO Zope-2-CVS-src/lib/python/ZODB/tests/MinPO.py

Base Classes   
Persistent
Methods   
__cmp__
__init__
__repr__
  __cmp__  
__cmp__ ( self,  aMinPO )

  __init__  
__init__ ( self,  value=None )

  __repr__  
__repr__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/PackableStorage.py.html0100600000176200017510000001220707306455626026705 0ustar dhellmanndevel Module: PackableStorage

Table of Contents

Module: PackableStorage Zope-2-CVS-src/lib/python/ZODB/tests/PackableStorage.py

Imported modules   
from ZODB.referencesf import referencesf
import time
Functions   
dumps
  dumps  
dumps ( obj )

Here's where all the magic occurs. Sadly, the pickle module is a bit underdocumented, but here's what happens: by setting the persistent_id attribute to getpersid() on the pickler, that function gets called for every object being pickled. By returning None when the object has no getoid attribute, it signals pickle to serialize the object as normal. That's how the Root instance gets pickled correctly. But, if the object has a getoid attribute, then by returning that method's value, we tell pickle to serialize the persistent id of the object instead of the object's state. That sets the pickle up for proper sniffing by the referencesf machinery. Fun, huh?

Classes   
Object

This is the persistent Object class. Because it has a getoid() method, the

PackableStorage
PackableStorageBase
Root

This class is for the root object. It must not contain a getoid() method

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/PackableStorage_Object.py.html0100600000176200017510000000657307306455626030204 0ustar dhellmanndevel Class: Object

Table of Contents

Class: Object Zope-2-CVS-src/lib/python/ZODB/tests/PackableStorage.py

This is the persistent Object class. Because it has a getoid() method, the persistent pickling machinery -- in the dumps() function below -- will pickle the oid string instead of the object's actual state. Yee haw, this stuff is deep. ;)

Methods   
__init__
getoid
  __init__  
__init__ ( self,  oid )

  getoid  
getoid ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/PackableStorage_PackableStorage.py.html0100600000176200017510000001005607306455626032014 0ustar dhellmanndevel Class: PackableStorage

Table of Contents

Class: PackableStorage Zope-2-CVS-src/lib/python/ZODB/tests/PackableStorage.py

Base Classes   
PackableStorageBase
Methods   
checkPackAllRevisions
checkPackJustOldRevisions
  checkPackAllRevisions  
checkPackAllRevisions ( self )

  checkPackJustOldRevisions  
checkPackJustOldRevisions ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/PackableStorage_PackableStorageBase.py.html0100600000176200017510000000753207306455626032614 0ustar dhellmanndevel Class: PackableStorageBase

Table of Contents

Class: PackableStorageBase Zope-2-CVS-src/lib/python/ZODB/tests/PackableStorage.py

Methods   
_makeloader
_newobj
  _makeloader  
_makeloader ( self )

This is the other side of the persistent pickling magic. We need a custom unpickler to mirror our custom pickler above. By setting the persistent_load function of the unpickler to self._cache.get(), whenever a persistent id is unpickled, it will actually return the Object instance out of the cache. As far as returning a function with an argument bound to an instance attribute method, we do it this way because it makes the code in the tests more succinct.

BUT! Be careful in your use of loads() vs. pickle.loads(). loads() should only be used on the Root object's pickle since it's the only special one. All the Object instances should use pickle.loads().

  _newobj  
_newobj ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/PackableStorage_Root.py.html0100600000176200017510000000333607306455626027713 0ustar dhellmanndevel Class: Root

Table of Contents

Class: Root Zope-2-CVS-src/lib/python/ZODB/tests/PackableStorage.py

This class is for the root object. It must not contain a getoid() method (really, attribute). The persistent pickling machinery -- in the dumps() function below -- will pickle Root objects as normal, but any attributes which reference persistent Object instances will get pickled as persistent ids, not as the object's state. This makes the referencesf stuff work, because it pickle sniffs for persistent ids (so we have to get those persistent ids into the root object's pickle).

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/TransactionalUndoStorage.py.html0100600000176200017510000000565307306455626030642 0ustar dhellmanndevel Module: TransactionalUndoStorage

Table of Contents

Module: TransactionalUndoStorage Zope-2-CVS-src/lib/python/ZODB/tests/TransactionalUndoStorage.py

Imported modules   
from ZODB import POSException
from ZODB.tests.MinPO import MinPO
from ZODB.tests.StorageTestBase import zodb_pickle, zodb_unpickle
import types
Classes   
TransactionalUndoStorage

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016200000000000011564 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/TransactionalUndoStorage_TransactionalUndoStorage.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/TransactionalUndoStorage_TransactionalUndoS0100600000176200017510000002611007306455626033072 0ustar dhellmanndevel Class: TransactionalUndoStorage

Table of Contents

Class: TransactionalUndoStorage Zope-2-CVS-src/lib/python/ZODB/tests/TransactionalUndoStorage.py

Methods   
_multi_obj_transaction
_transaction_begin
_transaction_newserial
_transaction_store
_transaction_vote
checkNotUndoable
checkSimpleTransactionalUndo
checkTwoObjectUndo
checkTwoObjectUndoAgain
checkTwoObjectUndoAtOnce
 checkUndoCreationBranch1
checkUndoCreationBranch2
  _multi_obj_transaction  
_multi_obj_transaction ( self,  objs )

  _transaction_begin  
_transaction_begin ( self )

  _transaction_newserial  
_transaction_newserial ( self,  oid )

  _transaction_store  
_transaction_store (
        self,
        oid,
        rev,
        data,
        vers,
        trans,
        )

  _transaction_vote  
_transaction_vote ( self,  trans )

  checkNotUndoable  
checkNotUndoable ( self )

  checkSimpleTransactionalUndo  
checkSimpleTransactionalUndo ( self )

  checkTwoObjectUndo  
checkTwoObjectUndo ( self )

  checkTwoObjectUndoAgain  
checkTwoObjectUndoAgain ( self )

  checkTwoObjectUndoAtOnce  
checkTwoObjectUndoAtOnce ( self )

  checkUndoCreationBranch1  
checkUndoCreationBranch1 ( self )

  checkUndoCreationBranch2  
checkUndoCreationBranch2 ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/TransactionalUndoVersionStorage.py.html0100600000176200017510000000555207306455626032206 0ustar dhellmanndevel Module: TransactionalUndoVersionStorage

Table of Contents

Module: TransactionalUndoVersionStorage Zope-2-CVS-src/lib/python/ZODB/tests/TransactionalUndoVersionStorage.py

Imported modules   
from ZODB import POSException
from ZODB.tests.MinPO import MinPO
from ZODB.tests.StorageTestBase import zodb_unpickle
Classes   
TransactionalUndoVersionStorage

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000020000000000000011555 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/TransactionalUndoVersionStorage_TransactionalUndoVersionStorage.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/TransactionalUndoVersionStorage_Transaction0100600000176200017510000000516507306455626033161 0ustar dhellmanndevel Class: TransactionalUndoVersionStorage

Table of Contents

Class: TransactionalUndoVersionStorage Zope-2-CVS-src/lib/python/ZODB/tests/TransactionalUndoVersionStorage.py

Methods   
checkUndoInVersion
  checkUndoInVersion  
checkUndoInVersion ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/VersionStorage.py.html0100600000176200017510000000540407306455626026631 0ustar dhellmanndevel Module: VersionStorage

Table of Contents

Module: VersionStorage Zope-2-CVS-src/lib/python/ZODB/tests/VersionStorage.py

Imported modules   
from ZODB import POSException
from ZODB.tests.MinPO import MinPO
from ZODB.tests.StorageTestBase import zodb_unpickle
Classes   
VersionStorage

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/VersionStorage_VersionStorage.py.html0100600000176200017510000002576607306455626031700 0ustar dhellmanndevel Class: VersionStorage

Table of Contents

Class: VersionStorage Zope-2-CVS-src/lib/python/ZODB/tests/VersionStorage.py

Methods   
_setup_version
checkAbortOneVersionCommitTheOther
checkAbortVersion
checkAbortVersionErrors
checkCommitToNonVersion
checkCommitToOtherVersion
checkModifyAfterAbortVersion
checkVersionEmpty
checkVersionLock
checkVersionedLoadErrors
 checkVersionedStoreAndLoad
checkVersions
  _setup_version  
_setup_version ( self,  version='test-version' )

  checkAbortOneVersionCommitTheOther  
checkAbortOneVersionCommitTheOther ( self )

  checkAbortVersion  
checkAbortVersion ( self )

  checkAbortVersionErrors  
checkAbortVersionErrors ( self )

  checkCommitToNonVersion  
checkCommitToNonVersion ( self )

  checkCommitToOtherVersion  
checkCommitToOtherVersion ( self )

  checkModifyAfterAbortVersion  
checkModifyAfterAbortVersion ( self )

  checkVersionEmpty  
checkVersionEmpty ( self )

  checkVersionLock  
checkVersionLock ( self )

  checkVersionedLoadErrors  
checkVersionedLoadErrors ( self )

  checkVersionedStoreAndLoad  
checkVersionedStoreAndLoad ( self )

  checkVersions  
checkVersions ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/__init__.py.html0100600000176200017510000000244007306455626025413 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/ZODB/tests/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/speed.py.html0100600000176200017510000001170107306455626024754 0ustar dhellmanndevel Module: speed

Table of Contents

Module: speed Zope-2-CVS-src/lib/python/ZODB/tests/speed.py

Imported modules   
import Persistence
import ZODB
import ZODB.FileStorage
import getopt
import os
import string
import sys
import time
Functions   
compress
main
  compress  
compress ( s )

  main  
main ( args )

Classes   
P

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/speed_P.py.html0100600000176200017510000000364707306455626025245 0ustar dhellmanndevel Class: P

Table of Contents

Class: P Zope-2-CVS-src/lib/python/ZODB/tests/speed.py

Base Classes   
Persistence.Persistent

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/testFileStorage.py.html0100600000176200017510000001507107306455626026764 0ustar dhellmanndevel Module: testFileStorage

Table of Contents

Module: testFileStorage Zope-2-CVS-src/lib/python/ZODB/tests/testFileStorage.py

Imported modules   
import BasicStorage
import ConflictResolution
import PackableStorage
import StorageTestBase
import Synchronization
import TransactionalUndoStorage
import TransactionalUndoVersionStorage
import VersionStorage
import ZODB.FileStorage
import os
import sys
import unittest
Functions   
debug
main
pdebug
test_suite
  debug  
debug ()

  main  
main ()

  pdebug  
pdebug ()

  test_suite  
test_suite ()

Classes   
FileStorageTests

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/testFileStorage_FileStorageTests.py.html0100600000176200017510000001022307306455626032265 0ustar dhellmanndevel Class: FileStorageTests

Table of Contents

Class: FileStorageTests Zope-2-CVS-src/lib/python/ZODB/tests/testFileStorage.py

Base Classes   
StorageTestBase.StorageTestBase
BasicStorage.BasicStorage
TransactionalUndoStorage.TransactionalUndoStorage
VersionStorage.VersionStorage
TransactionalUndoVersionStorage.TransactionalUndoVersionStorage
PackableStorage.PackableStorage
Synchronization.SynchronizedStorage
ConflictResolution.ConflictResolvingStorage
Methods   
setUp
tearDown
  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/testTransaction.py.html0100600000176200017510000001113707306455627027045 0ustar dhellmanndevel Module: testTransaction

Table of Contents

Module: testTransaction Zope-2-CVS-src/lib/python/ZODB/tests/testTransaction.py

High-level tests of the transaction interface

Imported modules   
import ZODB
from ZODB.DB import DB
from ZODB.FileStorage import FileStorage
from ZODB.tests.MinPO import MinPO
import os
import tempfile
import unittest
Functions   
main
  main  
main ()

Classes   
AllTests
BasicTests
SubtransTests
TransactionTestBase

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/testTransaction_AllTests.py.html0100600000176200017510000000423707306455626030662 0ustar dhellmanndevel Class: AllTests

Table of Contents

Class: AllTests Zope-2-CVS-src/lib/python/ZODB/tests/testTransaction.py

Base Classes   
TransactionTestBase
    unittest.TestCase
BasicTests
SubtransTests

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/testTransaction_BasicTests.py.html0100600000176200017510000001010107306455627031157 0ustar dhellmanndevel Class: BasicTests

Table of Contents

Class: BasicTests Zope-2-CVS-src/lib/python/ZODB/tests/testTransaction.py

Methods   
checkCommitAndAbort
checkMultipleCommits
checkSingleCommit
  checkCommitAndAbort  
checkCommitAndAbort ( self,  subtrans=None )

  checkMultipleCommits  
checkMultipleCommits ( self,  subtrans=None )

  checkSingleCommit  
checkSingleCommit ( self,  subtrans=None )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/testTransaction_SubtransTests.py.html0100600000176200017510000000510707306455627031751 0ustar dhellmanndevel Class: SubtransTests

Table of Contents

Class: SubtransTests Zope-2-CVS-src/lib/python/ZODB/tests/testTransaction.py

Methods   
wrap_test
  wrap_test  
wrap_test (
        self,
        klass,
        meth_name,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/testTransaction_TransactionTestBase.py.html0100600000176200017510000000752507306455627033053 0ustar dhellmanndevel Class: TransactionTestBase

Table of Contents

Class: TransactionTestBase Zope-2-CVS-src/lib/python/ZODB/tests/testTransaction.py

Base Classes   
unittest.TestCase
Methods   
setUp
tearDown
  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/testZODB.py.html0100600000176200017510000001433307306455627025317 0ustar dhellmanndevel Module: testZODB

Table of Contents

Module: testZODB Zope-2-CVS-src/lib/python/ZODB/tests/testZODB.py

Imported modules   
import ZODB
import ZODB.FileStorage
from ZODB.PersistentMapping import PersistentMapping
import os
import sys
import unittest
Functions   
debug
main
pdebug
test_suite
  debug  
debug ()

  main  
main ()

  pdebug  
pdebug ()

  test_suite  
test_suite ()

Classes   
ExportImportTests
ZODBTests

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/testZODB_ExportImportTests.py.html0100600000176200017510000000655307306455627031103 0ustar dhellmanndevel Class: ExportImportTests

Table of Contents

Class: ExportImportTests Zope-2-CVS-src/lib/python/ZODB/tests/testZODB.py

Methods   
checkDuplicate
checkDuplicateAborted
  checkDuplicate  
checkDuplicate (
        self,
        abort_it=0,
        dup_name='test_duplicate',
        )

  checkDuplicateAborted  
checkDuplicateAborted ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/tests/testZODB_ZODBTests.py.html0100600000176200017510000000760107306455627027160 0ustar dhellmanndevel Class: ZODBTests

Table of Contents

Class: ZODBTests Zope-2-CVS-src/lib/python/ZODB/tests/testZODB.py

Base Classes   
unittest.TestCase
ExportImportTests
Methods   
setUp
tearDown
  setUp  
setUp ( self )

  tearDown  
tearDown ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:03 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/BaseStorage.py.html0100600000176200017510000000600607306455627024714 0ustar dhellmanndevel Module: BaseStorage

Table of Contents

Module: BaseStorage Zope-2-CVS-src/lib/python/ZODB/BaseStorage.py

Handy standard storage machinery

Imported modules   
import POSException
import ThreadLock
from TimeStamp import TimeStamp
import UndoLogCompatible
import bpthread
import string
import time
Classes   
BaseStorage

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/BaseStorage_BaseStorage.py.html0100600000176200017510000006155707306455627027207 0ustar dhellmanndevel Class: BaseStorage

Table of Contents

Class: BaseStorage Zope-2-CVS-src/lib/python/ZODB/BaseStorage.py

Base Classes   
UndoLogCompatible.UndoLogCompatible
Methods   
__init__
_abort
_begin
_finish
_vote
abortVersion
close
commitVersion
copyTransactionsFrom
getName
 getSize
history
loadSerial
modifiedInVersion
new_oid
pack
registerDB
supportsUndo
supportsVersions
tpc_abort
 tpc_begin
tpc_finish
tpc_vote
undo
undoLog
versionEmpty
versions
  __init__  
__init__ (
        self,
        name,
        base=None,
        )

  _abort  
_abort ( self )

Subclasses should redefine this to supply abort actions

  _begin  
_begin (
        self,
        tid,
        u,
        d,
        e,
        )

Subclasses should redefine this to supply transaction start actions.

  _finish  
_finish (
        self,
        tid,
        u,
        d,
        e,
        )

Subclasses should redefine this to supply transaction finish actions

  _vote  
_vote ( self )

Subclasses should redefine this to supply transaction vote actions.

  abortVersion  
abortVersion (
        self,
        src,
        transaction,
        )

Exceptions   
POSException.StorageTransactionError( self, transaction )
  close  
close ( self )

  commitVersion  
commitVersion (
        self,
        src,
        dest,
        transaction,
        )

Exceptions   
POSException.StorageTransactionError( self, transaction )
  copyTransactionsFrom  
copyTransactionsFrom (
        self,
        other,
        verbose=0,
        )

Copy transactions from another storage.

This is typically used for converting data from one storage to another.

  getName  
getName ( self )

  getSize  
getSize ( self )

  history  
history (
        self,
        oid,
        version,
        length=1,
        )

  loadSerial  
loadSerial (
        self,
        oid,
        serial,
        )

Exceptions   
POSException.Unsupported, ( "Retrieval of historical revisions is not supported" )
  modifiedInVersion  
modifiedInVersion ( self,  oid )

  new_oid  
new_oid ( self,  last=None )

  pack  
pack (
        self,
        t,
        referencesf,
        )

  registerDB  
registerDB (
        self,
        db,
        limit,
        )

  supportsUndo  
supportsUndo ( self )

  supportsVersions  
supportsVersions ( self )

  tpc_abort  
tpc_abort ( self,  transaction )

  tpc_begin  
tpc_begin (
        self,
        transaction,
        tid=None,
        status=' ',
        )

  tpc_finish  
tpc_finish (
        self,
        transaction,
        f=None,
        )

  tpc_vote  
tpc_vote ( self,  transaction )

  undo  
undo ( self,  transaction_id )

Exceptions   
POSException.UndoError, 'non-undoable transaction'
  undoLog  
undoLog (
        self,
        first,
        last,
        filter=None,
        )

  versionEmpty  
versionEmpty ( self,  version )

  versions  
versions ( self,  max=None )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/ConflictResolution.py.html0100600000176200017510000001574607306455627026355 0ustar dhellmanndevel Module: ConflictResolution

Table of Contents

Module: ConflictResolution Zope-2-CVS-src/lib/python/ZODB/ConflictResolution.py

Imported modules   
from ZODB.POSException import ConflictError
from cPickle import Unpickler, Pickler
from cStringIO import StringIO
import sys
Functions   
_classFactory
persistent_id
state
tryToResolveConflict
  _classFactory  
_classFactory (
        location,
        name,
        _silly=( '__doc__', ),
        _globals={},
        )

  persistent_id  
persistent_id (
        object,
        PersistentReference=PersistentReference,
        getattr=getattr,
        )

  state  
state (
        self,
        oid,
        serial,
        prfactory,
        p='',
        )

  tryToResolveConflict  
tryToResolveConflict (
        self,
        oid,
        committedSerial,
        oldSerial,
        newpickle,
        committedData='',
        )

Classes   
ConflictResolvingStorage

Mix-in class that provides conflict resolution handling for storages

PersistentReference
PersistentReferenceFactory

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014600000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/ConflictResolution_ConflictResolvingStorage.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/ConflictResolution_ConflictResolvingStorage.py.ht0100600000176200017510000000253007306455627033046 0ustar dhellmanndevel Class: ConflictResolvingStorage

Table of Contents

Class: ConflictResolvingStorage Zope-2-CVS-src/lib/python/ZODB/ConflictResolution.py

Mix-in class that provides conflict resolution handling for storages

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/ConflictResolution_PersistentReference.py.html0100600000176200017510000000757407306455627032414 0ustar dhellmanndevel Class: PersistentReference

Table of Contents

Class: PersistentReference Zope-2-CVS-src/lib/python/ZODB/ConflictResolution.py

Methods   
__getstate__
__repr__
  __getstate__  
__getstate__ ( self )

Exceptions   
"Can't pickle PersistentReference"
  __repr__  
__repr__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015000000000000011561 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/ConflictResolution_PersistentReferenceFactory.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/ConflictResolution_PersistentReferenceFactory.py.0100600000176200017510000000515207306455627033045 0ustar dhellmanndevel Class: PersistentReferenceFactory

Table of Contents

Class: PersistentReferenceFactory Zope-2-CVS-src/lib/python/ZODB/ConflictResolution.py

Methods   
__call__
  __call__  
__call__ (
        self,
        oid,
        getattr=getattr,
        None=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/Connection.py.html0100600000176200017510000001314607306455627024617 0ustar dhellmanndevel Module: Connection

Table of Contents

Module: Connection Zope-2-CVS-src/lib/python/ZODB/Connection.py

Database connection support

$Id: Connection.py,v 1.57 2001/05/23 18:04:55 shane Exp $

Imported modules   
from ConflictResolution import ResolvedSerial
import ExportImport
from ExtensionClass import Base
from POSException import ConflictError, ExportError
import TmpStore
import Transaction
from cPickle import Unpickler, Pickler
from cPickleCache import PickleCache
from cStringIO import StringIO
from coptimizations import new_persistent_id
import string
import sys
from time import time
import traceback
from types import StringType
from zLOG import LOG, ERROR, BLATHER
Functions   
updateCodeTimestamp
  updateCodeTimestamp  
updateCodeTimestamp ()

Called after changes are made to persistence-based classes. Causes all connection caches to be re-created as the connections are reopened.

Classes   
Connection

Object managers for individual object space.

HelperClass
tConnection

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/Connection_Connection.py.html0100600000176200017510000007520607306455627027003 0ustar dhellmanndevel Class: Connection

Table of Contents

Class: Connection Zope-2-CVS-src/lib/python/ZODB/Connection.py

Object managers for individual object space.

An object space is a version of collection of objects. In a multi-threaded application, each thread get's it's own object space.

The Connection manages movement of objects in and out of object storage.

Base Classes   
ExportImport.ExportImport
Methods   
__getitem__
__init__
_breakcr
_handle_serial
_invalidate_creating
_invalidate_invalidating
_persistent_load
_resetCache
_setDB
abort
abort_sub
 cacheFullSweep
cacheMinimize
close
commit
commit_sub
db
exchange
getDebugInfo
getVersion
invalidate
modifiedInVersion
 oldstate
onCloseCallback
onCommitAction
root
setDebugInfo
setklassstate
setstate
sync
tpc_abort
tpc_begin
tpc_finish
  __getitem__  
__getitem__ (
        self,
        oid,
        tt=type(() ),
        )

Exceptions   
"Could not load oid %s, pickled data in traceback info may\ contain clues" %( oid )
  __init__  
__init__ (
        self,
        version='',
        cache_size=400,
        cache_deactivate_after=60,
        )

Create a new Connection

  _breakcr  
_breakcr ( self )

  _handle_serial  
_handle_serial (
        self,
        store_return,
        oid=None,
        change=1,
        )

Handle the returns from store() and tpc_vote() calls.

Exceptions   
serial
  _invalidate_creating  
_invalidate_creating ( self,  creating=None )

Dissown any objects newly saved in an uncommitted transaction.

  _invalidate_invalidating  
_invalidate_invalidating ( self )

  _persistent_load  
_persistent_load (
        self,
        oid,
        tt=type(() ),
        )

  _resetCache  
_resetCache ( self )

Creates a new cache, discarding the old.

  _setDB  
_setDB ( self,  odb )

Begin a new transaction.

Any objects modified since the last transaction are invalidated.

  abort  
abort (
        self,
        object,
        transaction,
        )

Abort the object in the transaction.

This just deactivates the thing.

  abort_sub  
abort_sub ( self,  t )

Abort work done in subtransactions

  cacheFullSweep  
cacheFullSweep ( self,  dt=0 )

  cacheMinimize  
cacheMinimize ( self,  dt=0 )

  close  
close ( self )

  commit  
commit (
        self,
        object,
        transaction,
        )

Exceptions   
ConflictError, ` oid `
  commit_sub  
commit_sub ( self,  t )

Commit all work done in subtransactions

  db  
db ( self )

  exchange  
exchange (
        self,
        old,
        new,
        )

Just plain weird. Don't try this at home kids.

  getDebugInfo  
getDebugInfo ( self )

  getVersion  
getVersion ( self )

  invalidate  
invalidate ( self,  oid )

Invalidate a particular oid

This marks the oid as invalid, but doesn't actually invalidate it. The object data will be actually invalidated at certain transaction boundaries.

  modifiedInVersion  
modifiedInVersion ( self,  oid )

  oldstate  
oldstate (
        self,
        object,
        serial,
        )

  onCloseCallback  
onCloseCallback ( self,  f )

  onCommitAction  
onCommitAction (
        self,
        method_name,
        *args,
        *kw,
        )

  root  
root ( self )

  setDebugInfo  
setDebugInfo ( self,  *args )

  setklassstate  
setklassstate ( self,  object )

  setstate  
setstate ( self,  object )

Exceptions   
ConflictError( ` oid `, ` object.__class__ ` )
  sync  
sync ( self )

  tpc_abort  
tpc_abort ( self,  transaction )

  tpc_begin  
tpc_begin (
        self,
        transaction,
        sub=None,
        )

Exceptions   
ConflictError, "transaction already invalidated"
  tpc_finish  
tpc_finish ( self,  transaction )

  tpc_vote  
tpc_vote ( self,  transaction )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/Connection_HelperClass.py.html0100600000176200017510000000243207306455627027100 0ustar dhellmanndevel Class: HelperClass

Table of Contents

Class: HelperClass Zope-2-CVS-src/lib/python/ZODB/Connection.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/Connection_tConnection.py.html0100600000176200017510000000632007306455627027156 0ustar dhellmanndevel Class: tConnection

Table of Contents

Class: tConnection Zope-2-CVS-src/lib/python/ZODB/Connection.py

Base Classes   
Connection
    ExportImport.ExportImport
Methods   
close
  close  
close ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/DB.py.html0100600000176200017510000001020707306455627023000 0ustar dhellmanndevel Module: DB

Table of Contents

Module: DB Zope-2-CVS-src/lib/python/ZODB/DB.py

Database objects

$Id: DB.py,v 1.32 2001/05/22 23:01:45 jeremy Exp $

Imported modules   
from Connection import Connection
import POSException
from Transaction import Transaction
import UndoLogCompatible
from bpthread import allocate_lock
import cPickle
import cStringIO
from referencesf import referencesf
import sys
from time import time, ctime
from types import StringType
from zLOG import LOG, ERROR
Classes   
AbortVersion

An object that will see to version abortion

CommitVersion

An object that will see to version commit

DB

The Object Database

TransactionalUndo

An object that will see to transactional undo

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/DB_AbortVersion.py.html0100600000176200017510000000641407306455627025502 0ustar dhellmanndevel Class: AbortVersion

Table of Contents

Class: AbortVersion Zope-2-CVS-src/lib/python/ZODB/DB.py

An object that will see to version abortion

in cooperation with a transaction manager.

Base Classes   
CommitVersion
Methods   
commit
  commit  
commit (
        self,
        reallyme,
        t,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/DB_CommitVersion.py.html0100600000176200017510000001003207306455627025652 0ustar dhellmanndevel Class: CommitVersion

Table of Contents

Class: CommitVersion Zope-2-CVS-src/lib/python/ZODB/DB.py

An object that will see to version commit

in cooperation with a transaction manager.

Methods   
__init__
abort
commit
  __init__  
__init__ (
        self,
        db,
        version,
        dest='',
        )

  abort  
abort (
        self,
        reallyme,
        t,
        )

  commit  
commit (
        self,
        reallyme,
        t,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/DB_DB.py.html0100600000176200017510000011447607306455627023362 0ustar dhellmanndevel Class: DB

Table of Contents

Class: DB Zope-2-CVS-src/lib/python/ZODB/DB.py

The Object Database

The Object database coordinates access to and interaction of one or more connections, which manage object spaces. Most of the actual work of managing objects is done by the connections.

Base Classes   
UndoLogCompatible.UndoLogCompatible
Methods   
__init__
_cacheMean
_classFactory
_closeConnection
_connectionMap
abortVersion
begin_invalidation
cacheDetail
cacheExtremeDetail
cacheFullSweep
cacheLastGCTime
cacheMeanAge
cacheMeanDeac
cacheMeanDeal
cacheMinimize
 cacheSize
cacheStatistics
close
commitVersion
connectionDebugInfo
exportFile
finish_invalidation
getCacheDeactivateAfter
getCacheSize
getName
getPoolSize
getSize
getVersionCacheDeactivateAfter
getVersionCacheSize
getVersionPoolSize
 importFile
invalidate
modifiedInVersion
objectCount
open
pack
setCacheDeactivateAfter
setCacheSize
setClassFactory
setPoolSize
setVersionCacheDeactivateAfter
setVersionCacheSize
setVersionPoolSize
undo
versionEmpty
  __init__  
__init__ (
        self,
        storage,
        pool_size=7,
        cache_size=400,
        cache_deactivate_after=60,
        version_pool_size=3,
        version_cache_size=100,
        version_cache_deactivate_after=10,
        )

Create an object database.

The storage for the object database must be passed in. Optional arguments are:

pool_size

The size of the pool of object spaces.

  _cacheMean  
_cacheMean ( self,  attr )

  _classFactory  
_classFactory (
        self,
        connection,
        location,
        name,
        _silly=( '__doc__', ),
        _globals={},
        )

  _closeConnection  
_closeConnection ( self,  connection )

Return a connection to the pool

  _connectionMap  
_connectionMap ( self,  f )

  abortVersion  
abortVersion ( self,  version )

  begin_invalidation  
begin_invalidation ( self )

  cacheDetail  
cacheDetail ( self )

Return information on objects in the various caches

Organized by class.

  cacheExtremeDetail  
cacheExtremeDetail ( self )

  cacheFullSweep  
cacheFullSweep ( self,  value )

  cacheLastGCTime  
cacheLastGCTime ( self )

  cacheMeanAge  
cacheMeanAge ( self )

  cacheMeanDeac  
cacheMeanDeac ( self )

  cacheMeanDeal  
cacheMeanDeal ( self )

  cacheMinimize  
cacheMinimize ( self,  value )

  cacheSize  
cacheSize ( self )

  cacheStatistics  
cacheStatistics ( self )

  close  
close ( self )

  commitVersion  
commitVersion (
        self,
        source,
        destination='',
        )

  connectionDebugInfo  
connectionDebugInfo ( self )

  exportFile  
exportFile (
        self,
        oid,
        file=None,
        )

Exceptions   
'Not yet implemented'
  finish_invalidation  
finish_invalidation ( self )

  getCacheDeactivateAfter  
getCacheDeactivateAfter ( self )

  getCacheSize  
getCacheSize ( self )

  getName  
getName ( self )

  getPoolSize  
getPoolSize ( self )

  getSize  
getSize ( self )

  getVersionCacheDeactivateAfter  
getVersionCacheDeactivateAfter ( self )

  getVersionCacheSize  
getVersionCacheSize ( self )

  getVersionPoolSize  
getVersionPoolSize ( self )

  importFile  
importFile ( self,  file )

Exceptions   
'Not yet implemented'
  invalidate  
invalidate (
        self,
        oid,
        connection=None,
        version='',
        rc=sys.getrefcount,
        )

Invalidate references to a given oid.

This is used to indicate that one of the connections has committed a change to the object. The connection commiting the change should be passed in to prevent useless (but harmless) messages to the connection.

  modifiedInVersion  
modifiedInVersion ( self,  oid )

  objectCount  
objectCount ( self )

  open  
open (
        self,
        version='',
        transaction=None,
        temporary=0,
        force=None,
        waitflag=1,
        )

Return a object space (AKA connection) to work in

The optional version argument can be used to specify that a version connection is desired.

The optional transaction argument can be provided to cause the connection to be automatically closed when a transaction is terminated. In addition, connections per transaction are reused, if possible.

Note that the connection pool is managed as a stack, to increate the likelihood that the connection's stack will include useful objects.

Exceptions   
POSException.Unimplemented, 'temporary versions'
  pack  
pack (
        self,
        t=None,
        days=0,
        )

  setCacheDeactivateAfter  
setCacheDeactivateAfter ( self,  v )

  setCacheSize  
setCacheSize ( self,  v )

  setClassFactory  
setClassFactory ( self,  factory )

  setPoolSize  
setPoolSize ( self,  v )

  setVersionCacheDeactivateAfter  
setVersionCacheDeactivateAfter ( self,  v )

  setVersionCacheSize  
setVersionCacheSize ( self,  v )

  setVersionPoolSize  
setVersionPoolSize ( self,  v )

  undo  
undo ( self,  id )

  versionEmpty  
versionEmpty ( self,  version )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/DB_TransactionalUndo.py.html0100600000176200017510000000643007306455627026513 0ustar dhellmanndevel Class: TransactionalUndo

Table of Contents

Class: TransactionalUndo Zope-2-CVS-src/lib/python/ZODB/DB.py

An object that will see to transactional undo

in cooperation with a transaction manager.

Base Classes   
CommitVersion
Methods   
commit
  commit  
commit (
        self,
        reallyme,
        t,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/DemoStorage.py.html0100600000176200017510000001224007306455627024723 0ustar dhellmanndevel Module: DemoStorage

Table of Contents

Module: DemoStorage Zope-2-CVS-src/lib/python/ZODB/DemoStorage.py

Demo ZODB storage

The Demo storage serves two purposes:

  • Provide an example implementation of a full storage without distracting storage details,

  • Provide a volatile storage that is useful for giving demonstrations.

The demo strorage can have a "base" storage that is used in a read-only fashion. The base storage must not not to contain version data.

There are three main data structures:

_data

Transaction logging information necessary for undo

This is a mapping from transaction id to transaction, where a transaction is simply a 5-tuple:

packed, user, description, extension_data, records

where extension_data is a dictionary or None and records are the actual records in chronological order. Packed is a flag indicating whethe the transaction has been packed or not

_index

A mapping from oid to record

_vindex

A mapping from version name to version data

where version data is a mapping from oid to record

A record is a tuple:

oid, serial, pre, vdata, p,

where:

oid

object id

serial

object serial number

pre

The previous record for this object (or None)

vdata

version data

None if not a version, ortherwise: version, non-version-record

p

the pickle data or None

The pickle data will be None for a record for an object created in an aborted version.

It is instructive to watch what happens to the internal data structures as changes are made. Foe example, in Zope, you can create an external method:

  import Zope

  def info(RESPONSE):
      RESPONSE['Content-type']= 'text/plain'

      return Zope.DB._storage._splat()

and call it to minotor the storage.

Imported modules   
import BTree
import BaseStorage
import POSException
from TimeStamp import TimeStamp
import base64
from cPickle import loads
import string
import time
import utils
Classes   
DemoStorage

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/DemoStorage_DemoStorage.py.html0100600000176200017510000005265407306455627027231 0ustar dhellmanndevel Class: DemoStorage

Table of Contents

Class: DemoStorage Zope-2-CVS-src/lib/python/ZODB/DemoStorage.py

Base Classes   
BaseStorage.BaseStorage
Methods   
__init__
__len__
_begin
_build_indexes
_clear_temp
_finish
_splat
abortVersion
commitVersion
getSize
 load
modifiedInVersion
pack
store
supportsUndo
supportsVersions
undo
undoLog
versionEmpty
versions
  __init__  
__init__ (
        self,
        name='Demo Storage',
        base=None,
        quota=None,
        )

Exceptions   
POSException.StorageError, ( "Demo base storage has version data" )
  __len__  
__len__ ( self )

  _begin  
_begin (
        self,
        tid,
        u,
        d,
        e,
        )

  _build_indexes  
_build_indexes ( self,  stop='\377\377\377\377\377\377\377\377' )

  _clear_temp  
_clear_temp ( self )

  _finish  
_finish (
        self,
        tid,
        user,
        desc,
        ext,
        )

  _splat  
_splat ( self )

Spit out a string showing state.

  abortVersion  
abortVersion (
        self,
        src,
        transaction,
        )

Exceptions   
POSException.StorageTransactionError( self, transaction )
  commitVersion  
commitVersion (
        self,
        src,
        dest,
        transaction,
        )

Exceptions   
POSException.StorageTransactionError( self, transaction )
  getSize  
getSize ( self )

  load  
load (
        self,
        oid,
        version,
        )

Exceptions   
KeyError, oid
  modifiedInVersion  
modifiedInVersion ( self,  oid )

  pack  
pack (
        self,
        t,
        referencesf,
        )

Packing is hard, at least when undo is supported. Even for a simple storage like this one, packing is pretty complex.

  store  
store (
        self,
        oid,
        serial,
        data,
        version,
        transaction,
        )

Exceptions   
POSException.ConflictError
POSException.StorageError, ( '''Quota Exceeded
The maximum quota for this demonstration storage has been exceeded.
Have a nice day.''' )
POSException.StorageTransactionError( self, transaction )
POSException.VersionLockError, oid
  supportsUndo  
supportsUndo ( self )

  supportsVersions  
supportsVersions ( self )

  undo  
undo ( self,  transaction_id )

Exceptions   
POSException.UndoError, 'non-undoable transaction'
UndoError, 'Invalid undo transaction id'
  undoLog  
undoLog (
        self,
        first,
        last,
        filter=None,
        )

  versionEmpty  
versionEmpty ( self,  version )

  versions  
versions ( self,  max=None )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/ExportImport.py.html0100600000176200017510000001225507306455627025174 0ustar dhellmanndevel Module: ExportImport

Table of Contents

Module: ExportImport Zope-2-CVS-src/lib/python/ZODB/ExportImport.py

Support for database export and import.

Imported modules   
import POSException
from cPickle import Pickler, Unpickler
from cStringIO import StringIO
from referencesf import referencesf
import string
from utils import p64, u64
Functions   
TemporaryFile
persistent_id
  TemporaryFile  
TemporaryFile ()

  persistent_id  
persistent_id ( object,  Ghost=Ghost )

Classes   
ExportImport
Ghost

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/ExportImport_ExportImport.py.html0100600000176200017510000001312107306455627027721 0ustar dhellmanndevel Class: ExportImport

Table of Contents

Class: ExportImport Zope-2-CVS-src/lib/python/ZODB/ExportImport.py

Methods   
_importDuringCommit
exportFile
importFile
  _importDuringCommit  
_importDuringCommit (
        self,
        transaction,
        file,
        return_oid_list,
        )

Invoked by the transaction manager mid commit. Appends one item, the OID of the first object created, to return_oid_list.

Exceptions   
POSException.ExportError, 'Truncated export file'
  exportFile  
exportFile (
        self,
        oid,
        file=None,
        )

  importFile  
importFile (
        self,
        file,
        clue='',
        customImporters=None,
        )

This is tricky, because we need to work in a transaction!

Exceptions   
POSException.ExportError, 'Invalid export header'

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/ExportImport_Ghost.py.html0100600000176200017510000000242007306455627026331 0ustar dhellmanndevel Class: Ghost

Table of Contents

Class: Ghost Zope-2-CVS-src/lib/python/ZODB/ExportImport.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/FileStorage.py.html0100600000176200017510000004543607306455630024725 0ustar dhellmanndevel Module: FileStorage

Table of Contents

Module: FileStorage Zope-2-CVS-src/lib/python/ZODB/FileStorage.py

Imported modules   
import BaseStorage
import ConflictResolution
import POSException
from POSException import UndoError
from TimeStamp import TimeStamp
import base64
import bpthread
from cPickle import loads, Pickler, Unpickler
from lock_file import lock_file
import os
import string
import struct
from struct import pack, unpack
import sys
import time
from types import StringType
from utils import t32, p64, U64, cp
from zLOG import LOG, WARNING, ERROR, PANIC, register_subsystem
Functions   
_loadBack
_loadBackPOS
_truncate
error
nearPanic
panic
read_index
recover
search_back
shift_transactions_forward
 warn
  _loadBack  
_loadBack (
        file,
        oid,
        back,
        )

Exceptions   
KeyError, oid
  _loadBackPOS  
_loadBackPOS (
        file,
        oid,
        back,
        )

Return the position of the record containing the data used by the record at the given position (back).

Exceptions   
KeyError, oid
  _truncate  
_truncate (
        file,
        name,
        pos,
        )

Exceptions   
POSException.StorageSystemError, ( "Couldn't save truncated data" )
  error  
error ( message,  *data )

  nearPanic  
nearPanic ( message,  *data )

  panic  
panic ( message,  *data )

Exceptions   
CorruptedTransactionError, message
  read_index  
read_index (
        file,
        name,
        index,
        vindex,
        tindex,
        stop='\377' * 8,
        ltid=z64,
        start=4L,
        maxoid=z64,
        recover=0,
        read_only=0,
        )

Exceptions   
FileStorageFormatError, file.name
FileStorageFormatError, name
  recover  
recover ( file_name )

  search_back  
search_back ( file,  pos )

  shift_transactions_forward  
shift_transactions_forward (
        index,
        vindex,
        tindex,
        file,
        pos,
        opos,
        )

Copy transactions forward in the data file

This might be done as part of a recovery effort

Exceptions   
'Pack Error', opos
  warn  
warn ( message,  *data )

Classes   
CorruptedDataError
CorruptedFileStorageError

Corrupted file storage

CorruptedTransactionError
FileIterator

Iterate over the transactions in a FileStorage file.

FileStorage
FileStorageError
FileStorageFormatError

Invalid file format

FileStorageQuotaError

File storage quota exceeded

Iterator

A General simple iterator that uses the Python for-loop index protocol

Record

An abstract database record

RecordIterator

Iterate over the transactions in a FileStorage file.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/FileStorage_CorruptedDataError.py.html0100600000176200017510000000424607306455630030552 0ustar dhellmanndevel Class: CorruptedDataError

Table of Contents

Class: CorruptedDataError Zope-2-CVS-src/lib/python/ZODB/FileStorage.py

Base Classes   
CorruptedFileStorageError

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/FileStorage_CorruptedFileStorageError.py.html0100600000176200017510000000407307306455630032103 0ustar dhellmanndevel Class: CorruptedFileStorageError

Table of Contents

Class: CorruptedFileStorageError Zope-2-CVS-src/lib/python/ZODB/FileStorage.py

Corrupted file storage

Base Classes   
FileStorageError
    POSException.StorageError
POSException.StorageSystemError

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/FileStorage_CorruptedTransactionError.py.html0100600000176200017510000000426407306455630032166 0ustar dhellmanndevel Class: CorruptedTransactionError

Table of Contents

Class: CorruptedTransactionError Zope-2-CVS-src/lib/python/ZODB/FileStorage.py

Base Classes   
CorruptedFileStorageError

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/FileStorage_FileIterator.py.html0100600000176200017510000001223607306455630027366 0ustar dhellmanndevel Class: FileIterator

Table of Contents

Class: FileIterator Zope-2-CVS-src/lib/python/ZODB/FileStorage.py

Iterate over the transactions in a FileStorage file.

Base Classes   
Iterator
Methods   
__init__
next
  __init__  
__init__ ( self,  file )

Exceptions   
FileStorageFormatError, name
  next  
next ( self,  index=0 )

Exceptions   
IndexError, index

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/FileStorage_FileStorage.py.html0100600000176200017510000012477707306455630027217 0ustar dhellmanndevel Class: FileStorage

Table of Contents

Class: FileStorage Zope-2-CVS-src/lib/python/ZODB/FileStorage.py

Base Classes   
BaseStorage.BaseStorage
ConflictResolution.ConflictResolvingStorage
Methods   
__init__
__len__
_abort
_begin
_clear_index
_clear_temp
_finish
_getSerial
_getVersion
_initIndex
_load
_loada
_newIndexes
 _redundant_pack
_restore_index
_sane
_save_index
_transactionalUndoRecord
_undoDataInfo
abortVersion
close
commitVersion
getSize
history
iterator
load
 loadSerial
modifiedInVersion
pack
store
supportsTransactionalUndo
supportsUndo
supportsVersions
tpc_vote
transactionalUndo
undo
undoLog
versionEmpty
versions
  __init__  
__init__ (
        self,
        file_name,
        create=0,
        read_only=0,
        stop=None,
        quota=None,
        )

Exceptions   
ValueError, "can\'t create a read-only file"
ValueError, "time-travel is only supported in read-only mode"
  __len__  
__len__ ( self )

  _abort  
_abort ( self )

  _begin  
_begin (
        self,
        tid,
        u,
        d,
        e,
        )

  _clear_index  
_clear_index ( self )

  _clear_temp  
_clear_temp ( self )

  _finish  
_finish (
        self,
        tid,
        u,
        d,
        e,
        )

  _getSerial  
_getSerial (
        self,
        oid,
        pos,
        )

  _getVersion  
_getVersion (
        self,
        oid,
        pos,
        )

  _initIndex  
_initIndex (
        self,
        index,
        vindex,
        tindex,
        tvindex,
        )

  _load  
_load (
        self,
        oid,
        version,
        _index,
        file,
        )

Exceptions   
CorruptedDataError, h
  _loada  
_loada (
        self,
        oid,
        _index,
        file,
        )

Read any version and return the version

  _newIndexes  
_newIndexes ( self )

  _redundant_pack  
_redundant_pack (
        self,
        file,
        pos,
        )

  _restore_index  
_restore_index ( self )

Load the database index from a file to support quick startup

  _sane  
_sane (
        self,
        index,
        pos,
        )

Sanity check saved index data by reading the last undone trans

Basically, we read the last not undone transaction and check to see that the included records are consistent with the index. Any invalid record records or inconsistent object positions cause zero to be returned.

  _save_index  
_save_index ( self )

Write the database index to a file to support quick startup

  _transactionalUndoRecord  
_transactionalUndoRecord (
        self,
        oid,
        pos,
        serial,
        pre,
        version,
        )

Get the indo information for a data record

Return a 5-tuple consisting of a pickle, data pointer, version, packed non-version data pointer, and current position. If the pickle is true, then the data pointer must be 0, but the pickle can be empty and the pointer 0.

Exceptions   
UndoError
UndoError( 'Current and undone versions differ' )
UndoError( 'Some data were modified by a later transaction' )
UndoError("_loadBack() failed for %s" % repr( oid ) )
  _undoDataInfo  
_undoDataInfo (
        self,
        oid,
        pos,
        tpos,
        )

Return the serial, data pointer, data, and version for the oid record at pos

Exceptions   
UndoError( 'Invalid undo transaction id' )
  abortVersion  
abortVersion (
        self,
        src,
        transaction,
        )

  close  
close ( self )

  commitVersion  
commitVersion (
        self,
        src,
        dest,
        transaction,
        abort=None,
        )

We are going to commit by simply storing back pointers.

Exceptions   
'VersionCommitError', ( 'Internal error, can\'t abort to a version' )
POSException.StorageTransactionError( self, transaction )
POSException.VersionCommitError( 'Invalid source version' )
  getSize  
getSize ( self )

  history  
history (
        self,
        oid,
        version=None,
        length=1,
        filter=None,
        )

  iterator  
iterator ( self )

  load  
load (
        self,
        oid,
        version,
        _stuff=None,
        )

  loadSerial  
loadSerial (
        self,
        oid,
        serial,
        )

Exceptions   
CorruptedDataError, h
KeyError, serial
  modifiedInVersion  
modifiedInVersion ( self,  oid )

Exceptions   
CorruptedDataError, pos
  pack  
pack (
        self,
        t,
        referencesf,
        )

Copy data from the current database file to a packed file

Non-current records from transactions with time-stamp strings less than packtss are ommitted. As are all undone records.

Also, data back pointers that point before packtss are resolved and the associated data are copied, since the old records are not copied.

Exceptions   
'Pack Error', opos
FileStorageError, 'Already packing'
FileStorageError, 'Invalid pack time'
FileStorageError, ( 'The database has already been packed to a later time\n' 'or no changes have been made since the last pack' )
  store  
store (
        self,
        oid,
        serial,
        data,
        version,
        transaction,
        )

Exceptions   
CorruptedDataError, h
FileStorageQuotaError, ( 'The storage quota has been exceeded.' )
POSException.ConflictError, ( serial, oserial )
POSException.StorageTransactionError( self, transaction )
POSException.VersionLockError, ( ` oid `, locked_version )
  supportsTransactionalUndo  
supportsTransactionalUndo ( self )

  supportsUndo  
supportsUndo ( self )

  supportsVersions  
supportsVersions ( self )

  tpc_vote  
tpc_vote ( self,  transaction )

Exceptions   
FileStorageError, 'description too long'
FileStorageError, 'too much extension data'
FileStorageError, 'user name too long'
  transactionalUndo  
transactionalUndo (
        self,
        transaction_id,
        transaction,
        )

Undo a transaction, given by transaction_id.

Do so by writing new data that reverses tyhe action taken by the transaction.

Exceptions   
POSException.StorageTransactionError( self, transaction )
UndoError( failures )
UndoError, 'Invalid undo transaction id'
UndoError, 'non-undoable transaction'
  undo  
undo ( self,  transaction_id )

Exceptions   
UndoError
UndoError( 'Invalid undo transaction id' )
UndoError, ( 'Undo is currently disabled for database maintenance.

' )

  undoLog  
undoLog (
        self,
        first=0,
        last=-20,
        filter=None,
        )

Exceptions   
UndoError( 'Undo is currently disabled for database maintenance.

' )

  versionEmpty  
versionEmpty ( self,  version )

Exceptions   
POSException.VersionError( 'The version must be an non-empty string' )
  versions  
versions ( self,  max=None )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/FileStorage_FileStorageError.py.html0100600000176200017510000000370207306455630030211 0ustar dhellmanndevel Class: FileStorageError

Table of Contents

Class: FileStorageError Zope-2-CVS-src/lib/python/ZODB/FileStorage.py

Base Classes   
POSException.StorageError

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/FileStorage_FileStorageFormatError.py.html0100600000176200017510000000410607306455630031361 0ustar dhellmanndevel Class: FileStorageFormatError

Table of Contents

Class: FileStorageFormatError Zope-2-CVS-src/lib/python/ZODB/FileStorage.py

Invalid file format

The format of the given file is not valid

Base Classes   
FileStorageError
    POSException.StorageError

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/FileStorage_FileStorageQuotaError.py.html0100600000176200017510000000407007306455630031222 0ustar dhellmanndevel Class: FileStorageQuotaError

Table of Contents

Class: FileStorageQuotaError Zope-2-CVS-src/lib/python/ZODB/FileStorage.py

File storage quota exceeded

Base Classes   
FileStorageError
    POSException.StorageError
POSException.StorageSystemError

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/FileStorage_Iterator.py.html0100600000176200017510000000504607306455630026567 0ustar dhellmanndevel Class: Iterator

Table of Contents

Class: Iterator Zope-2-CVS-src/lib/python/ZODB/FileStorage.py

A General simple iterator that uses the Python for-loop index protocol

Methods   
__getitem__
  __getitem__  
__getitem__ ( self,  i )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/FileStorage_Record.py.html0100600000176200017510000000475407306455630026221 0ustar dhellmanndevel Class: Record

Table of Contents

Class: Record Zope-2-CVS-src/lib/python/ZODB/FileStorage.py

An abstract database record

Methods   
__init__
  __init__  
__init__ ( self,  *args )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/FileStorage_RecordIterator.py.html0100600000176200017510000001116207306455630027722 0ustar dhellmanndevel Class: RecordIterator

Table of Contents

Class: RecordIterator Zope-2-CVS-src/lib/python/ZODB/FileStorage.py

Iterate over the transactions in a FileStorage file.

Base Classes   
Iterator
Methods   
__init__
next
  __init__  
__init__ (
        self,
        tid,
        status,
        user,
        desc,
        ext,
        pos,
        stuff,
        )

  next  
next ( self,  index=0 )

Exceptions   
IndexError, index

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/MappingStorage.py.html0100600000176200017510000001232407306455630025427 0ustar dhellmanndevel Module: MappingStorage

Table of Contents

Module: MappingStorage Zope-2-CVS-src/lib/python/ZODB/MappingStorage.py

Very Simple Mapping ZODB storage

The Mapping storage provides an extremely simple storage implementation that doesn't provide undo or version support.

It is meant to illustrate the simplest possible storage.

The Mapping storage uses a single data structure to map object ids to data.

The Demo storage serves two purposes:

  • Provide an example implementation of a full storage without distracting storage details,

  • Provide a volatile storage that is useful for giving demonstrations.

The demo strorage can have a "base" storage that is used in a read-only fashion. The base storage must not not to contain version data.

There are three main data structures:

_data

Transaction logging information necessary for undo

This is a mapping from transaction id to transaction, where a transaction is simply a 4-tuple:

packed, user, description, extension_data, records

where extension_data is a dictionary or None and records are the actual records in chronological order. Packed is a flag indicating whethe the transaction has been packed or not

_index

A mapping from oid to record

_vindex

A mapping from version name to version data

where version data is a mapping from oid to record

A record is a tuple:

oid, serial, pre, vdata, p,

where:

oid

object id

serial

object serial number

pre

The previous record for this object (or None)

vdata

version data

None if not a version, ortherwise: version, non-version-record

p

the pickle data or None

The pickle data will be None for a record for an object created in an aborted version.

It is instructive to watch what happens to the internal data structures as changes are made. Foe example, in Zope, you can create an external method:

  import Zope

  def info(RESPONSE):
      RESPONSE['Content-type']= 'text/plain'

      return Zope.DB._storage._splat()

and call it to minotor the storage.

Imported modules   
import BaseStorage
import POSException
from TimeStamp import TimeStamp
import string
import utils
Classes   
MappingStorage

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/MappingStorage_MappingStorage.py.html0100600000176200017510000002305207306455630030427 0ustar dhellmanndevel Class: MappingStorage

Table of Contents

Class: MappingStorage Zope-2-CVS-src/lib/python/ZODB/MappingStorage.py

Base Classes   
BaseStorage.BaseStorage
Methods   
__init__
__len__
_clear_temp
_finish
_splat
getSize
load
pack
store
  __init__  
__init__ ( self,  name='Mapping Storage' )

  __len__  
__len__ ( self )

  _clear_temp  
_clear_temp ( self )

  _finish  
_finish (
        self,
        tid,
        user,
        desc,
        ext,
        )

  _splat  
_splat ( self )

Spit out a string showing state.

  getSize  
getSize ( self )

  load  
load (
        self,
        oid,
        version,
        )

  pack  
pack (
        self,
        t,
        referencesf,
        )

  store  
store (
        self,
        oid,
        serial,
        data,
        version,
        transaction,
        )

Exceptions   
POSException.ConflictError
POSException.StorageTransactionError( self, transaction )
POSException.Unsupported, "Versions aren't supported"

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/Mount.py.html0100600000176200017510000000701407306455630023611 0ustar dhellmanndevel Module: Mount

Table of Contents

Module: Mount Zope-2-CVS-src/lib/python/ZODB/Mount.py

Mounted database support

$Id: Mount.py,v 1.10 2001/01/31 16:30:49 shane Exp $

Imported modules   
import Acquisition
import ExtensionClass
from POSException import MountedStorageError
import Persistence
import string
import sys
import thread
import time
from zLOG import LOG, ERROR, INFO, WARNING
Classes   
MountPoint

The base class for a Zope object which, when traversed,

MountedConnectionCloser

Closes the connection used by the mounted database

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/Mount_MountPoint.py.html0100600000176200017510000003423007306455630026005 0ustar dhellmanndevel Class: MountPoint

Table of Contents

Class: MountPoint Zope-2-CVS-src/lib/python/ZODB/Mount.py

The base class for a Zope object which, when traversed, accesses a different database.

Base Classes   
Persistence.Persistent
Acquisition.Implicit
Methods   
__init__
__of__
__repr__
_createDB
_getDB
_getMountParams
_getMountRoot
_getMountpointId
_getObjectFromConnection
_getOrOpenObject
 _logConnectException
_openMountableConnection
_test
  __init__  
__init__ (
        self,
        path,
        params=None,
        classDefsFromRoot=1,
        )

@arg path The path within the mounted database from which to derive the root.

@arg params The parameters used to connect to the database. No particular format required. If there is more than one mount point referring to a database, MountPoint will detect the matching params and use the existing database. Include the class name of the storage. For example, ZEO params might be "ZODB.ZEOClient localhost 1081".

@arg classDefsFromRoot If true (the default), MountPoint will try to get ZClass definitions from the root database rather than the mounted database.

  __of__  
__of__ ( self,  parent )

  __repr__  
__repr__ ( self )

  _createDB  
_createDB ( self )

Gets the database object, usually by creating a Storage object and returning ZODB.DB(storage).

Exceptions   
'NotImplemented'
  _getDB  
_getDB ( self )

Creates or opens a DB object.

  _getMountParams  
_getMountParams ( self )

  _getMountRoot  
_getMountRoot ( self,  root )

Gets the object to be mounted. Can be overridden to provide different behavior.

Exceptions   
MountedStorageError, ( "No 'Application' object exists in the mountable database." )
MountedStorageError, ( "The path '%s' was not found in the mountable database." % self._path )
  _getMountpointId  
_getMountpointId ( self )

  _getObjectFromConnection  
_getObjectFromConnection ( self,  conn )

  _getOrOpenObject  
_getOrOpenObject ( self,  parent )

  _logConnectException  
_logConnectException ( self )

Records info about the exception that just occurred.

  _openMountableConnection  
_openMountableConnection ( self,  parent )

  _test  
_test ( self,  parent )

Tests the database connection.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/Mount_MountedConnectionCloser.py.html0100600000176200017510000000774007306455630030502 0ustar dhellmanndevel Class: MountedConnectionCloser

Table of Contents

Class: MountedConnectionCloser Zope-2-CVS-src/lib/python/ZODB/Mount.py

Closes the connection used by the mounted database while performing other cleanup.

Methods   
__call__
__init__
setCloseDb
  __call__  
__call__ ( self )

  __init__  
__init__ (
        self,
        mountpoint,
        conn,
        )

  setCloseDb  
setCloseDb ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/POSException.py.html0100600000176200017510000001275507306455630025037 0ustar dhellmanndevel Module: POSException

Table of Contents

Module: POSException Zope-2-CVS-src/lib/python/ZODB/POSException.py

BoboPOS-defined exceptions

$Id: POSException.py,v 1.7 2001/04/12 20:47:00 jim Exp $

Imported modules   
from string import join
Classes   
ConflictError

Two transactions tried to modify the same object at once

ExportError

An export file doesn't have the right format.

InvalidObjectReference

An object contains an invalid reference to another object.

MountedStorageError

Unable to access mounted storage.

POSError

Persistent object system error

StorageError
StorageSystemError

Panic! Internal storage error!

StorageTransactionError

An operation was invoked for an invalid transaction or state

TransactionError

An error occured due to normal transaction processing

UndoError

An attempt was made to undo a non-undoable transaction.

Unimplemented

An unimplemented feature was used

Unsupported

An feature that is unsupported bt the storage was used.

VersionCommitError

An invalid combination of versions was used in a version commit

VersionError

An error in handling versions occurred

VersionLockError

An attempt was made to modify an object that has

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/POSException_ConflictError.py.html0100600000176200017510000000421707306455630027664 0ustar dhellmanndevel Class: ConflictError

Table of Contents

Class: ConflictError Zope-2-CVS-src/lib/python/ZODB/POSException.py

Two transactions tried to modify the same object at once

This transaction should be resubmitted.

Base Classes   
TransactionError

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/POSException_ExportError.py.html0100600000176200017510000000376407306455630027412 0ustar dhellmanndevel Class: ExportError

Table of Contents

Class: ExportError Zope-2-CVS-src/lib/python/ZODB/POSException.py

An export file doesn't have the right format.

Base Classes   
POSError
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/POSException_InvalidObjectReference.py.html0100600000176200017510000000433707306455630031450 0ustar dhellmanndevel Class: InvalidObjectReference

Table of Contents

Class: InvalidObjectReference Zope-2-CVS-src/lib/python/ZODB/POSException.py

An object contains an invalid reference to another object.

An invalid reference may be one of:

  • A reference to a wrapped persistent object.

  • A reference to an object in a different database connection.

Base Classes   
POSError
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/POSException_MountedStorageError.py.html0100600000176200017510000000410607306455630031060 0ustar dhellmanndevel Class: MountedStorageError

Table of Contents

Class: MountedStorageError Zope-2-CVS-src/lib/python/ZODB/POSException.py

Unable to access mounted storage.

Base Classes   
StorageError

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/POSException_POSError.py.html0100600000176200017510000000363107306455630026563 0ustar dhellmanndevel Class: POSError

Table of Contents

Class: POSError Zope-2-CVS-src/lib/python/ZODB/POSException.py

Persistent object system error

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/POSException_StorageError.py.html0100600000176200017510000000376107306455630027532 0ustar dhellmanndevel Class: StorageError

Table of Contents

Class: StorageError Zope-2-CVS-src/lib/python/ZODB/POSException.py

Base Classes   
POSError
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/POSException_StorageSystemError.py.html0100600000176200017510000000410107306455630030724 0ustar dhellmanndevel Class: StorageSystemError

Table of Contents

Class: StorageSystemError Zope-2-CVS-src/lib/python/ZODB/POSException.py

Panic! Internal storage error!

Base Classes   
StorageError

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/POSException_StorageTransactionError.py.html0100600000176200017510000000415107306455630031732 0ustar dhellmanndevel Class: StorageTransactionError

Table of Contents

Class: StorageTransactionError Zope-2-CVS-src/lib/python/ZODB/POSException.py

An operation was invoked for an invalid transaction or state

Base Classes   
StorageError

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/POSException_TransactionError.py.html0100600000176200017510000000400607306455630030404 0ustar dhellmanndevel Class: TransactionError

Table of Contents

Class: TransactionError Zope-2-CVS-src/lib/python/ZODB/POSException.py

An error occured due to normal transaction processing

Base Classes   
POSError
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/POSException_UndoError.py.html0100600000176200017510000000763007306455630027032 0ustar dhellmanndevel Class: UndoError

Table of Contents

Class: UndoError Zope-2-CVS-src/lib/python/ZODB/POSException.py

An attempt was made to undo a non-undoable transaction.

Base Classes   
POSError
    Exception
Methods   
__init__
__repr__
  __init__  
__init__ ( self,  *reason )

  __repr__  
__repr__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/POSException_Unimplemented.py.html0100600000176200017510000000375407306455630027724 0ustar dhellmanndevel Class: Unimplemented

Table of Contents

Class: Unimplemented Zope-2-CVS-src/lib/python/ZODB/POSException.py

An unimplemented feature was used

Base Classes   
POSError
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/POSException_Unsupported.py.html0100600000176200017510000000377607306455630027452 0ustar dhellmanndevel Class: Unsupported

Table of Contents

Class: Unsupported Zope-2-CVS-src/lib/python/ZODB/POSException.py

An feature that is unsupported bt the storage was used.

Base Classes   
POSError
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/POSException_VersionCommitError.py.html0100600000176200017510000000414207306455630030716 0ustar dhellmanndevel Class: VersionCommitError

Table of Contents

Class: VersionCommitError Zope-2-CVS-src/lib/python/ZODB/POSException.py

An invalid combination of versions was used in a version commit

Base Classes   
VersionError

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/POSException_VersionError.py.html0100600000176200017510000000375707306455630027560 0ustar dhellmanndevel Class: VersionError

Table of Contents

Class: VersionError Zope-2-CVS-src/lib/python/ZODB/POSException.py

An error in handling versions occurred

Base Classes   
POSError
    Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/POSException_VersionLockError.py.html0100600000176200017510000000444107306455630030360 0ustar dhellmanndevel Class: VersionLockError

Table of Contents

Class: VersionLockError Zope-2-CVS-src/lib/python/ZODB/POSException.py

An attempt was made to modify an object that has been modified in an unsaved version

Base Classes   
VersionError
TransactionError

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/PersistentMapping.py.html0100600000176200017510000000541407306455630026165 0ustar dhellmanndevel Module: PersistentMapping

Table of Contents

Module: PersistentMapping Zope-2-CVS-src/lib/python/ZODB/PersistentMapping.py

Imported modules   
import Persistence
import types
Classes   
PersistentMapping

A persistent wrapper for mapping objects.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/PersistentMapping_PersistentMapping.py.html0100600000176200017510000002731507306455630031725 0ustar dhellmanndevel Class: PersistentMapping

Table of Contents

Class: PersistentMapping Zope-2-CVS-src/lib/python/ZODB/PersistentMapping.py

A persistent wrapper for mapping objects.

This class allows wrapping of mapping objects so that object changes are registered. As a side effect, mapping objects may be subclassed.

Base Classes   
Persistence.Persistent
Methods   
__delitem__
__getitem__
__init__
__len__
__setitem__
clear
copy
get
has_key
items
 keys
update
values
  __delitem__  
__delitem__ ( self,  key )

  __getitem__  
__getitem__ ( self,  key )

  __init__  
__init__ ( self,  container=None )

  __len__  
__len__ ( self )

  __setitem__  
__setitem__ (
        self,
        key,
        v,
        )

  clear  
clear ( self )

  copy  
copy ( self )

  get  
get (
        self,
        key,
        default=_marker,
        )

  has_key  
has_key ( self,  key )

  items  
items ( self )

  keys  
keys ( self )

  update  
update ( self,  b )

  values  
values ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/TmpStore.py.html0100600000176200017510000000536307306455630024271 0ustar dhellmanndevel Module: TmpStore

Table of Contents

Module: TmpStore Zope-2-CVS-src/lib/python/ZODB/TmpStore.py

Imported modules   
import POSException
from utils import p64, u64
Classes   
TmpStore

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/TmpStore_TmpStore.py.html0100600000176200017510000003521207306455630026122 0ustar dhellmanndevel Class: TmpStore

Table of Contents

Class: TmpStore Zope-2-CVS-src/lib/python/ZODB/TmpStore.py

Methods   
__del__
__init__
close
getName
getSize
load
modifiedInVersion
new_oid
registerDB
store
 tpc_abort
tpc_begin
tpc_finish
tpc_vote
undoLog
versionEmpty
  __del__  
__del__ ( self )

  __init__  
__init__ (
        self,
        base_version,
        file=None,
        )

  close  
close ( self )

  getName  
getName ( self )

  getSize  
getSize ( self )

  load  
load (
        self,
        oid,
        version,
        )

Exceptions   
POSException.StorageSystemError, 'Bad temporary storage'
  modifiedInVersion  
modifiedInVersion ( self,  oid )

  new_oid  
new_oid ( self )

  registerDB  
registerDB (
        self,
        db,
        limit,
        )

  store  
store (
        self,
        oid,
        serial,
        data,
        version,
        transaction,
        )

Exceptions   
POSException.StorageTransactionError( self, transaction )
  tpc_abort  
tpc_abort ( self,  transaction )

  tpc_begin  
tpc_begin ( self,  transaction )

  tpc_finish  
tpc_finish (
        self,
        transaction,
        f=None,
        )

  tpc_vote  
tpc_vote ( self,  transaction )

  undoLog  
undoLog (
        self,
        first,
        last,
        filter=None,
        )

  versionEmpty  
versionEmpty ( self,  version )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/Transaction.py.html0100600000176200017510000000672607306455630025005 0ustar dhellmanndevel Module: Transaction

Table of Contents

Module: Transaction Zope-2-CVS-src/lib/python/ZODB/Transaction.py

Transaction management

$Id: Transaction.py,v 1.28 2001/03/29 17:43:19 jeremy Exp $

Imported modules   
import POSException
from POSException import ConflictError
import __main__
from string import split, strip, join
import struct
from struct import pack
import sys
import time
from zLOG import LOG, ERROR, PANIC
Classes   
Transaction

Simple transaction objects for single-threaded applications.

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/Transaction_Transaction.py.html0100600000176200017510000003114507306455630027343 0ustar dhellmanndevel Class: Transaction

Table of Contents

Class: Transaction Zope-2-CVS-src/lib/python/ZODB/Transaction.py

Simple transaction objects for single-threaded applications.

Methods   
__del__
__init__
__str__
_init
abort
begin
commit
note
register
setExtendedInfo
 setUser
sub
  __del__  
__del__ ( self )

  __init__  
__init__ ( self,  id=None )

  __str__  
__str__ ( self )

  _init  
_init ( self )

  abort  
abort (
        self,
        subtransaction=0,
        freeme=1,
        )

Abort the transaction.

This is called from the application. This means that we haven't entered two-phase commit yet, so no tpc_ messages are sent.

Exceptions   
POSException.TransactionError, ( """Attempted to abort a sub-transaction, but a participating data manager doesn't support partial abort. """ )
t, v, tb
  begin  
begin (
        self,
        info=None,
        subtransaction=None,
        )

Begin a new transaction.

This aborts any transaction in progres.

  commit  
commit ( self,  subtransaction=None )

Finalize the transaction

Exceptions   
POSException.TransactionError, ( """A serious error, which was probably a system error, occurred in a previous database transaction. This application may be in an invalid state and must be restarted before database updates can be allowed. Beware though that if the error was due to a serious system problem, such as a disk full condition, then the application may not come up until you deal with the system problem. See your application log for information on the error that lead to this problem. """ )
t, v, tb
  note  
note ( self,  text )

  register  
register ( self,  object )

Register the given object for transaction control.

  setExtendedInfo  
setExtendedInfo (
        self,
        name,
        value,
        )

  setUser  
setUser (
        self,
        user_name,
        path='/',
        )

  sub  
sub ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/UndoLogCompatible.py.html0100600000176200017510000000411107306455630026051 0ustar dhellmanndevel Module: UndoLogCompatible

Table of Contents

Module: UndoLogCompatible Zope-2-CVS-src/lib/python/ZODB/UndoLogCompatible.py

Provide backward compatability with storages that have undoLog, but not undoInfo.

Classes   
UndoLogCompatible

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/UndoLogCompatible_UndoLogCompatible.py.html0100600000176200017510000000513507306455630031507 0ustar dhellmanndevel Class: UndoLogCompatible

Table of Contents

Class: UndoLogCompatible Zope-2-CVS-src/lib/python/ZODB/UndoLogCompatible.py

Methods   
undoInfo
  undoInfo  
undoInfo (
        self,
        first=0,
        last=-20,
        specification=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/ZApplication.py.html0100600000176200017510000000446507306455631025114 0ustar dhellmanndevel Module: ZApplication

Table of Contents

Module: ZApplication Zope-2-CVS-src/lib/python/ZODB/ZApplication.py

Implement an bobo_application object that is BoboPOS3 aware

This module provides a wrapper that causes a database connection to be created and used when bobo publishes a bobo_application object.

Classes   
Cleanup
ZApplicationWrapper

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/ZApplication_Cleanup.py.html0100600000176200017510000000242407306455631026554 0ustar dhellmanndevel Class: Cleanup

Table of Contents

Class: Cleanup Zope-2-CVS-src/lib/python/ZODB/ZApplication.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/ZApplication_ZApplicationWrapper.py.html0100600000176200017510000001145607306455631031130 0ustar dhellmanndevel Class: ZApplicationWrapper

Table of Contents

Class: ZApplicationWrapper Zope-2-CVS-src/lib/python/ZODB/ZApplication.py

Methods   
__bobo_traverse__
__call__
__getattr__
__init__
  __bobo_traverse__  
__bobo_traverse__ (
        self,
        REQUEST=None,
        name=None,
        )

  __call__  
__call__ ( self,  connection=None )

  __getattr__  
__getattr__ ( self,  name )

This hack is to overcome a bug in Bobo!

  __init__  
__init__ (
        self,
        db,
        name,
        klass=None,
        klass_args=(),
        version_cookie_name=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/__init__.py.html0100600000176200017510000000445307306455631024253 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/ZODB/__init__.py

Imported modules   
from DB import DB
import ExtensionClass
import Persistence
import TimeStamp
import Transaction
import cPersistence
import cPickle
import cStringIO
import sys
from zLOG import register_subsystem

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/bpthread.py.html0100600000176200017510000000257107306455631024304 0ustar dhellmanndevel Module: bpthread

Table of Contents

Module: bpthread Zope-2-CVS-src/lib/python/ZODB/bpthread.py

Thread abstraction module

With this, we can run with or wothout threads.

$Id: bpthread.py,v 1.2 1999/05/10 23:15:56 jim Exp $

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/conversionhack.py.html0100600000176200017510000000776607306455631025542 0ustar dhellmanndevel Module: conversionhack

Table of Contents

Module: conversionhack Zope-2-CVS-src/lib/python/ZODB/conversionhack.py

Imported modules   
import PersistentMapping
Functions   
__basicnew__
  __basicnew__  
__basicnew__ ()

Classes   
fixer
hack

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/conversionhack_fixer.py.html0100600000176200017510000000476107306455631026727 0ustar dhellmanndevel Class: fixer

Table of Contents

Class: fixer Zope-2-CVS-src/lib/python/ZODB/conversionhack.py

Methods   
__of__
  __of__  
__of__ ( self,  parent )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/conversionhack_hack.py.html0100600000176200017510000000242007306455631026506 0ustar dhellmanndevel Class: hack

Table of Contents

Class: hack Zope-2-CVS-src/lib/python/ZODB/conversionhack.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/dbmStorage.py.html0100600000176200017510000000740207306455631024600 0ustar dhellmanndevel Module: dbmStorage

Table of Contents

Module: dbmStorage Zope-2-CVS-src/lib/python/ZODB/dbmStorage.py

Very Simple dbm-based ZODB storage

This storage provides for use of dbm files as storages that don't support versions or Undo. This may be useful when implementing objects like hit counters that don't need or want to participate in undo or versions.

Imported modules   
from BaseStorage import BaseStorage
from MappingStorage import MappingStorage
import POSException
import anydbm
import base64
import os
import string
import time
import utils
Classes   
anydbmStorage
gdbmStorage

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/dbmStorage_anydbmStorage.py.html0100600000176200017510000000760707306455631027466 0ustar dhellmanndevel Class: anydbmStorage

Table of Contents

Class: anydbmStorage Zope-2-CVS-src/lib/python/ZODB/dbmStorage.py

Base Classes   
MappingStorage
Methods   
__init__
getSize
  __init__  
__init__ (
        self,
        filename,
        flag='r',
        mode=0666,
        )

  getSize  
getSize ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/dbmStorage_gdbmStorage.py.html0100600000176200017510000001263007306455631027115 0ustar dhellmanndevel Class: gdbmStorage

Table of Contents

Class: gdbmStorage Zope-2-CVS-src/lib/python/ZODB/dbmStorage.py

Base Classes   
anydbmStorage
    MappingStorage
Methods   
__init__
_finish
getSize
pack
  __init__  
__init__ (
        self,
        filename,
        flag='r',
        mode=0666,
        )

  _finish  
_finish (
        self,
        tid,
        user,
        desc,
        ext,
        )

  getSize  
getSize ( self )

  pack  
pack (
        self,
        t,
        referencesf,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/fsrecover.py.html0100600000176200017510000000377607306455631024521 0ustar dhellmanndevel Module: fsrecover

Table of Contents

Module: fsrecover Zope-2-CVS-src/lib/python/ZODB/fsrecover.py

Simple script for repairing damaged FileStorage files.

Imported modules   
import FileStorage
import sys

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/lock_file.py.html0100600000176200017510000000362707306455631024445 0ustar dhellmanndevel Module: lock_file

Table of Contents

Module: lock_file Zope-2-CVS-src/lib/python/ZODB/lock_file.py

Imported modules   
import POSException

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/referencesf.py.html0100600000176200017510000000775007306455631025006 0ustar dhellmanndevel Module: referencesf

Table of Contents

Module: referencesf Zope-2-CVS-src/lib/python/ZODB/referencesf.py

Provide a function that can find object references in pickles

Imported modules   
import cPickle
import cStringIO
Functions   
referencesf
  referencesf  
referencesf (
        p,
        rootl=None,
        Unpickler=cPickle.Unpickler,
        StringIO=cStringIO.StringIO,
        tt=type(() ),
        type=type,
        None=None,
        )

Exceptions   
ValueError, 'Error unpickling, %s' % p

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZODB/utils.py.html0100600000176200017510000001413707306455631023654 0ustar dhellmanndevel Module: utils

Table of Contents

Module: utils Zope-2-CVS-src/lib/python/ZODB/utils.py

Imported modules   
import TimeStamp
import struct
import time
Functions   
U64
cp
newTimeStamp
p64
u64
  U64  
U64 ( v,  unpack=struct.unpack )

Same as u64 but always returns a long.

  cp  
cp (
        f1,
        f2,
        l,
        )

  newTimeStamp  
newTimeStamp (
        old=None,
        TimeStamp=TimeStamp.TimeStamp,
        time=time.time,
        gmtime=time.gmtime,
        )

  p64  
p64 ( v,  pack=struct.pack )

Pack an integer or long into a 8-byte string

  u64  
u64 ( v,  unpack=struct.unpack )

Unpack an 8-byte string into a 64-bit (or long) integer

Table of Contents

This document was automatically generated on Sun Jun 3 11:43:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/0040700000176200017510000000000007306455632022524 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/index.html0100600000176200017510000001021307306455632024515 0ustar dhellmanndevel Zope2 CVS with ZEO: ZPublisher

Table of Contents

Zope2 CVS with ZEO: ZPublisher  
Modules and Packages   

Zope-2-CVS-src/lib/python/ZPublisher/

BaseRequest
BaseResponse

CGI Response Output formatter

BeforeTraverse
Client

:"

Converters
HTTPRangeSupport

HTTP Range support utilities.

HTTPRequest
HTTPResponse

CGI Response Output formatter

Publish
Request
Response
Test

:"

__init__
mapply

Provide an apply-like facility that works with any mapping object

maybe_lock
tests

Zope2 CVS with ZEO: ZPublisher.tests

xmlrpc

XML-RPC support module

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/tests/0040700000176200017510000000000007306455631023665 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/tests/index.html0100600000176200017510000000415707306455631025670 0ustar dhellmanndevel Zope2 CVS with ZEO: ZPublisher.tests

Table of Contents

Zope2 CVS with ZEO: ZPublisher.tests  
Modules and Packages   

Zope-2-CVS-src/lib/python/ZPublisher/tests/

__init__
testHTTPRangeSupport

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/tests/__init__.py.html0100600000176200017510000000244607306455631026746 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/ZPublisher/tests/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/tests/testHTTPRangeSupport.py.html0100600000176200017510000001413407306455631031235 0ustar dhellmanndevel Module: testHTTPRangeSupport

Table of Contents

Module: testHTTPRangeSupport Zope-2-CVS-src/lib/python/ZPublisher/tests/testHTTPRangeSupport.py

Imported modules   
import sys
import unittest
Functions   
debug
main
pdebug
test_suite
  debug  
debug ()

  main  
main ()

  pdebug  
pdebug ()

  test_suite  
test_suite ()

Classes   
TestOptimizeRanges
TestRangeHeaderParse

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015600000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/tests/testHTTPRangeSupport_TestOptimizeRanges.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/tests/testHTTPRangeSupport_TestOptimizeRang0100600000176200017510000002550207306455631033174 0ustar dhellmanndevel Class: TestOptimizeRanges

Table of Contents

Class: TestOptimizeRanges Zope-2-CVS-src/lib/python/ZPublisher/tests/testHTTPRangeSupport.py

Base Classes   
unittest.TestCase
Methods   
expectSets
testAdjacentInOrder
testAdjacentOutOfOrder
testExpandOpenEnd
testMakeAbsolute
testNoOverlapInOrder
testNoOverlapOutOfOrder
testOverLapAndOverflow
testOverlapInOrder
testOverlapOutOfOrder
 testRemoveUnsatisfiable
  expectSets  
expectSets (
        self,
        sets,
        size,
        expect,
        )

  testAdjacentInOrder  
testAdjacentInOrder ( self )

  testAdjacentOutOfOrder  
testAdjacentOutOfOrder ( self )

  testExpandOpenEnd  
testExpandOpenEnd ( self )

  testMakeAbsolute  
testMakeAbsolute ( self )

  testNoOverlapInOrder  
testNoOverlapInOrder ( self )

  testNoOverlapOutOfOrder  
testNoOverlapOutOfOrder ( self )

  testOverLapAndOverflow  
testOverLapAndOverflow ( self )

  testOverlapInOrder  
testOverlapInOrder ( self )

  testOverlapOutOfOrder  
testOverlapOutOfOrder ( self )

  testRemoveUnsatisfiable  
testRemoveUnsatisfiable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000016000000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/tests/testHTTPRangeSupport_TestRangeHeaderParse.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/tests/testHTTPRangeSupport_TestRangeHeaderP0100600000176200017510000003541407306455631033054 0ustar dhellmanndevel Class: TestRangeHeaderParse

Table of Contents

Class: TestRangeHeaderParse Zope-2-CVS-src/lib/python/ZPublisher/tests/testHTTPRangeSupport.py

Base Classes   
unittest.TestCase
Methods   
expectNone
expectSets
testAlmostIntegers
testEmptySets
testEndLowerThanStart
testFirstByte
testGarbage
testIllegalRange
testIllegalSpec
testMultiple
 testNegativeZero
testNoSets
testOpenEnded
testSimpleRange
testSimpleRangeAndEmpty
testStartEqualsEnd
testSuffixRange
  expectNone  
expectNone ( self,  header )

Utility methods

  expectSets  
expectSets (
        self,
        header,
        sets,
        )

  testAlmostIntegers  
testAlmostIntegers ( self )

  testEmptySets  
testEmptySets ( self )

  testEndLowerThanStart  
testEndLowerThanStart ( self )

  testFirstByte  
testFirstByte ( self )

  testGarbage  
testGarbage ( self )

Syntactically incorrect headers

  testIllegalRange  
testIllegalRange ( self )

  testIllegalSpec  
testIllegalSpec ( self )

  testMultiple  
testMultiple ( self )

  testNegativeZero  
testNegativeZero ( self )

  testNoSets  
testNoSets ( self )

  testOpenEnded  
testOpenEnded ( self )

  testSimpleRange  
testSimpleRange ( self )

Correct headers

  testSimpleRangeAndEmpty  
testSimpleRangeAndEmpty ( self )

  testStartEqualsEnd  
testStartEqualsEnd ( self )

  testSuffixRange  
testSuffixRange ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/BaseRequest.py.html0100600000176200017510000001163307306455631026266 0ustar dhellmanndevel Module: BaseRequest

Table of Contents

Module: BaseRequest Zope-2-CVS-src/lib/python/ZPublisher/BaseRequest.py

Imported modules   
from string import join, split, find, rfind, lower, upper
from urllib import quote
Functions   
old_validation
  old_validation  
old_validation (
        groups,
        request,
        auth,
        roles=UNSPECIFIED_ROLES,
        )

Exceptions   
'Forbidden', ( """You are not authorized to access this resource""" )
Classes   
BaseRequest

Provide basic ZPublisher request management

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/BaseRequest_BaseRequest.py.html0100600000176200017510000003357307306455631030600 0ustar dhellmanndevel Class: BaseRequest

Table of Contents

Class: BaseRequest Zope-2-CVS-src/lib/python/ZPublisher/BaseRequest.py

Provide basic ZPublisher request management

This object provides access to request data. Request data may vary depending on the protocol used.

Request objects are created by the object publisher and will be passed to published objects through the argument name, REQUEST.

The request object is a mapping object that represents a collection of variable to value mappings.

Methods   
__getitem__
__init__
__len__
__setitem__
__str__
_hold
close
has_key
items
keys
 processInputs
supports_retry
traverse
values
  __getitem__  
__getitem__ (
        self,
        key,
        default=_marker,
        )

Get a variable value

Return a value for the required variable name. The value will be looked up from one of the request data categories. The search order is environment variables, other variables, form data, and then cookies.

Exceptions   
KeyError, key
  __init__  
__init__ (
        self,
        other=None,
        **kw,
        )

The constructor is not allowed to raise errors

  __len__  
__len__ ( self )

  __setitem__  
__setitem__ (
        self,
        key,
        value,
        )

Set application variables

This method is used to set a variable in the requests "other" category.

  __str__  
__str__ ( self )

  _hold  
_hold ( self,  object )

Hold a reference to an object to delay it's destruction until mine

  close  
close ( self )

  has_key  
has_key ( self,  key )

  items  
items ( self )

  keys  
keys ( self )

  processInputs  
processInputs ( self )

Do any input processing that could raise errors

  supports_retry  
supports_retry ( self )

  traverse  
traverse (
        self,
        path,
        response=None,
        validated_hook=None,
        )

Traverse the object space

The REQUEST must already have a PARENTS item with at least one object in it. This is typically the root object.

Exceptions   
AttributeError, entry_name
  values  
values ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/BaseResponse.py.html0100600000176200017510000000633407306455631026436 0ustar dhellmanndevel Module: BaseResponse

Table of Contents

Module: BaseResponse Zope-2-CVS-src/lib/python/ZPublisher/BaseResponse.py

CGI Response Output formatter

$Id: BaseResponse.py,v 1.8 2001/04/26 14:40:07 andreas Exp $

Imported modules   
import string
from string import find, rfind, lower, upper, strip, split, join, translate
import sys
import types
from types import StringType, InstanceType
Classes   
BaseResponse

Base Response Class

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/BaseResponse_BaseResponse.py.html0100600000176200017510000005221507306455631031106 0ustar dhellmanndevel Class: BaseResponse

Table of Contents

Class: BaseResponse Zope-2-CVS-src/lib/python/ZPublisher/BaseResponse.py

Base Response Class

What should be here?

Methods   
__getitem__
__init__
__repr__
__str__
appendBody
badRequestError
debugError
exception
flush
forbiddenError
 getBody
getHeader
getStatus
notFoundError
outputBody
setBody
setCookie
setHeader
setStatus
unauthorized
 write
  __getitem__  
__getitem__ ( self,  name )

Get the value of an output header

  __init__  
__init__ (
        self,
        stdout,
        stderr,
        body='',
        headers=None,
        status=None,
        cookies=None,
        )

  __repr__  
__repr__ ( self )

  __str__  
__str__ ( self )

  appendBody  
appendBody ( self,  body )

  badRequestError  
badRequestError ( self,  v='' )

Raise an error indicating something wrong with the request

Exceptions   
'Bad Request', v
  debugError  
debugError ( self,  v='' )

Raise an error with debigging info and in debugging mode

Exceptions   
'Debug Error', v
  exception  
exception (
        self,
        fatal=0,
        info=None,
        )

Handle an exception.

The fatal argument indicates whether the error is fatal.

The info argument, if given should be a tuple with an error type, value, and traceback.

  flush  
flush ( self )

  forbiddenError  
forbiddenError ( self,  v='' )

Raise an error indicating that the request cannot be done

Exceptions   
'Forbidden', v
  getBody  
getBody ( self )

Returns a string representing the currently set body.

  getHeader  
getHeader ( self,  name )

Get a header value

Returns the value associated with a HTTP return header, or "None" if no such header has been set in the response yet.

  getStatus  
getStatus ( self )

Returns the current HTTP status code as an integer.

  notFoundError  
notFoundError ( self,  v='' )

Generate an error indicating that an object was not found.

Exceptions   
'Not Found', v
  outputBody  
outputBody ( self )

Output the response body

  setBody  
setBody ( self,  body )

  setCookie  
setCookie (
        self,
        name,
        value,
        **kw,
        )

Set an HTTP cookie on the browser

The response will include an HTTP header that sets a cookie on cookie-enabled browsers with a key "name" and value "value". This overwrites any previously set value for the cookie in the Response object.

  setHeader  
setHeader (
        self,
        name,
        value,
        )

  setStatus  
setStatus (
        self,
        status,
        reason=None,
        )

  unauthorized  
unauthorized ( self )

Raise an eror indicating that the user was not authizated

Make sure to generate an appropriate challenge, as appropriate.

Exceptions   
'Unauthorized'
  write  
write ( self,  data )

Return data as a stream

HTML data may be returned using a stream-oriented interface. This allows the browser to display partial results while computation of a response to proceed.

The published object should first set any output headers or cookies on the response object.

Note that published objects must not generate any errors after beginning stream-oriented output.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/BeforeTraverse.py.html0100600000176200017510000001503007306455631026754 0ustar dhellmanndevel Module: BeforeTraverse

Table of Contents

Module: BeforeTraverse Zope-2-CVS-src/lib/python/ZPublisher/BeforeTraverse.py

Functions   
queryBeforeTraverse
registerBeforeTraverse
rewriteBeforeTraverse
unregisterBeforeTraverse
  queryBeforeTraverse  
queryBeforeTraverse ( container,  app_handle )

Find __before_traverse__ hook objects, given an app_handle.

Returns a list of (priority, object) pairs.

  registerBeforeTraverse  
registerBeforeTraverse (
        container,
        object,
        app_handle,
        priority=99,
        )

Register an object to be called before a container is traversed.

app_handle should be a string or other hashable value that distinguishes the application of this object, and which must be used in order to unregister the object.

If the container will be pickled, the object must be a callable class instance, not a function or method.

priority is optional, and determines the relative order in which registered objects will be called.

  rewriteBeforeTraverse  
rewriteBeforeTraverse ( container,  btr )

Rewrite the list of __before_traverse__ hook objects

  unregisterBeforeTraverse  
unregisterBeforeTraverse ( container,  app_handle )

Unregister a __before_traverse__ hook object, given its app_handle.

Returns a list of unregistered objects.

Classes   
MultiHook

Class used to multiplex hook.

NameCaller

Class used to proxy sibling objects by name.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/BeforeTraverse_MultiHook.py.html0100600000176200017510000001012207306455631030744 0ustar dhellmanndevel Class: MultiHook

Table of Contents

Class: MultiHook Zope-2-CVS-src/lib/python/ZPublisher/BeforeTraverse.py

Class used to multiplex hook.

MultiHook calls the named hook from the class of the container, then the prior hook, then all the hooks in its list.

Methods   
__call__
__init__
add
  __call__  
__call__ (
        self,
        container,
        request,
        )

  __init__  
__init__ (
        self,
        hookname,
        prior,
        defined_in_class,
        )

  add  
add ( self,  cob )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/BeforeTraverse_NameCaller.py.html0100600000176200017510000000702307306455631031042 0ustar dhellmanndevel Class: NameCaller

Table of Contents

Class: NameCaller Zope-2-CVS-src/lib/python/ZPublisher/BeforeTraverse.py

Class used to proxy sibling objects by name.

When called with a container and request object, it gets the named attribute from the container and calls it. If the name is not found, it fails silently.

>>> registerBeforeTraverse(folder, NameCaller(preop), XApp)

Methods   
__call__
__init__
  __call__  
__call__ (
        self,
        container,
        request,
        )

  __init__  
__init__ ( self,  name )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/Client.py.html0100600000176200017510000003165107306455631025263 0ustar dhellmanndevel Module: Client

Table of Contents

Module: Client Zope-2-CVS-src/lib/python/ZPublisher/Client.py

:" exec python $0 ${1+"$@"}

Imported modules   
from base64 import encodestring
from httplib import HTTP
import mimetools
from os import getpid
from random import random
import re
import socket
from string import strip, split, atoi, join, rfind, translate, maketrans, replace, lower
import sys
from time import time
from types import FileType, ListType, DictType, TupleType
from urllib import urlopen, quote
from urlparse import urlparse
Functions   
ErrorTypes
call
main
marshal_float
marshal_int
marshal_list
marshal_long
marshal_tuple
marshal_whatever
querify
  ErrorTypes  
ErrorTypes ( code )

  call  
call (
        url,
        username=None,
        password=None,
        **kw,
        )

  main  
main ()

  marshal_float  
marshal_float ( n,  f )

  marshal_int  
marshal_int ( n,  f )

  marshal_list  
marshal_list (
        n,
        l,
        tname='list',
        lt=type([] ),
        tt=type(() ),
        )

Exceptions   
TypeError, 'Invalid recursion in data to be marshaled.'
  marshal_long  
marshal_long ( n,  f )

  marshal_tuple  
marshal_tuple ( n,  l )

  marshal_whatever  
marshal_whatever ( k,  v )

  querify  
querify ( items )

Classes   
Function
MultiPart
Object

Surrogate object for an object on the web

RemoteException

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/Client_Function.py.html0100600000176200017510000001756207306455631027135 0ustar dhellmanndevel Class: Function

Table of Contents

Class: Function Zope-2-CVS-src/lib/python/ZPublisher/Client.py

Methods   
__call__
__init__
_mp_call
handleError
  __call__  
__call__ (
        self,
        *args,
        *kw,
        )

Exceptions   
NotAvailable, RemoteException( NotAvailable, sys.exc_info() [ 1 ], self.url, query )
TypeError, 'Keyword arg redefined'
TypeError, 'Too many arguments'
  __init__  
__init__ (
        self,
        url,
        arguments=(),
        method=None,
        username=None,
        password=None,
        timeout=None,
        **headers,
        )

Exceptions   
ValueError, url
  _mp_call  
_mp_call (
        self,
        kw,
        type2suffix={ type( 1.0 ) : ':float', type( 1 ) : ':int', type( 1L ) : ':long', type([] ) : ':list', type(() ) : ':tuple', },
        )

Exceptions   
'BadReply', 'Bad reply from server: ' + line
NotAvailable, (RemoteException( NotAvailable, sys.exc_info() [ 1 ], self.url, '' ) )
  handleError  
handleError (
        self,
        query,
        ec,
        em,
        headers,
        response,
        )

Exceptions   
t, RemoteException( t, v, f, l, self.url, query, ec, em, response )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/Client_MultiPart.py.html0100600000176200017510000001107007306455631027255 0ustar dhellmanndevel Class: MultiPart

Table of Contents

Class: MultiPart Zope-2-CVS-src/lib/python/ZPublisher/Client.py

Methods   
__init__
boundary
render
  __init__  
__init__ ( self,  *args )

Exceptions   
ValueError, 'Invalid arguments'
ValueError, 'Sorry, nested multipart is not done yet!'
  boundary  
boundary ( self )

  render  
render ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/Client_Object.py.html0100600000176200017510000000650707306455631026553 0ustar dhellmanndevel Class: Object

Table of Contents

Class: Object Zope-2-CVS-src/lib/python/ZPublisher/Client.py

Surrogate object for an object on the web

Methods   
__getattr__
__init__
  __getattr__  
__getattr__ ( self,  name )

  __init__  
__init__ (
        self,
        url,
        method=None,
        username=None,
        password=None,
        timeout=None,
        **headers,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/Client_RemoteException.py.html0100600000176200017510000000666607306455631030465 0ustar dhellmanndevel Class: RemoteException

Table of Contents

Class: RemoteException Zope-2-CVS-src/lib/python/ZPublisher/Client.py

Methods   
__init__
__repr__
  __init__  
__init__ (
        self,
        etype=None,
        evalue=None,
        efile=None,
        eline=None,
        url=None,
        query=None,
        http_code=None,
        http_msg=None,
        http_resp=None,
        )

Contains information about an exception which occurs in a remote method call

  __repr__  
__repr__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/Converters.py.html0100600000176200017510000003153607306455631026201 0ustar dhellmanndevel Module: Converters

Table of Contents

Module: Converters Zope-2-CVS-src/lib/python/ZPublisher/Converters.py

Imported modules   
import re
from string import atoi, atol, atof, join, split, strip
from types import ListType, TupleType
Functions   
field2boolean
field2date
field2float
field2int
field2lines
field2long
field2required
field2string
field2text
field2tokens
  field2boolean  
field2boolean ( v )

  field2date  
field2date ( v )

  field2float  
field2float ( v )

Exceptions   
ValueError, ( "A floating-point number was expected in the value '%s'" % v )
ValueError, ( 'Empty entry when floating-point number expected' )
  field2int  
field2int ( v )

Exceptions   
ValueError, 'Empty entry when integer expected'
ValueError, ( "An integer was expected in the value '%s'" % v )
  field2lines  
field2lines ( v )

  field2long  
field2long ( v )

Exceptions   
ValueError, 'Empty entry when integer expected'
ValueError, ( "A long integer was expected in the value '%s'" % v )
  field2required  
field2required ( v )

Exceptions   
ValueError, 'No input for required field

'

  field2string  
field2string ( v )

  field2text  
field2text ( v,  nl=re.compile( '\r\n\|\n\r' ).search )

  field2tokens  
field2tokens ( v )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/HTTPRangeSupport.py.html0100600000176200017510000001355707306455632027204 0ustar dhellmanndevel Module: HTTPRangeSupport

Table of Contents

Module: HTTPRangeSupport Zope-2-CVS-src/lib/python/ZPublisher/HTTPRangeSupport.py

HTTP Range support utilities.

The RFC 2616 specification defines the Range and If-Range headers for enabeling partial download of published resources. This module provides a flag-interface and some support functions for implementing this functionality.

For an implementation example, see the File class in OFS/Image.py.

Imported modules   
import Interface
import re
import string
import sys
Functions   
optimizeRanges
parseRange
  optimizeRanges  
optimizeRanges ( ranges,  size )

Optimize Range sets, given those sets and the length of the resource.

Optimisation is done by first expanding relative start values and open ends, then sorting and combining overlapping or adjacent ranges. We also remove unsatisfiable ranges (where the start lies beyond the size of the resource).

  parseRange  
parseRange ( header )

RFC 2616 (HTTP 1.1) Range header parsing.

Convert a range header to a list of slice indexes, returned as (start, end) tuples. If no end was given, end is None. Note that the RFC specifies the end offset to be inclusive, we return python convention indexes, where the end is exclusive. Syntactically incorrect headers are to be ignored, so if we encounter one we return None.

Classes   
HTTPRangeInterface

Objects implementing this Interface support the HTTP Range header.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/HTTPRangeSupport_HTTPRangeInterface.py.html0100600000176200017510000000461607306455632032635 0ustar dhellmanndevel Class: HTTPRangeInterface

Table of Contents

Class: HTTPRangeInterface Zope-2-CVS-src/lib/python/ZPublisher/HTTPRangeSupport.py

Objects implementing this Interface support the HTTP Range header.

Objects implementing support for the HTTP Range header will return partial content as specified in RFC 2616. Note that the'If-Range' header must either be implemented correctly or result in a normal 200 OK response at all times.

This interface specifies no methods, as this functionality can either be implemented in the index_html or __call__ methods of a published object.

Base Classes   
Interface.Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/HTTPRequest.py.html0100600000176200017510000001656407306455632026204 0ustar dhellmanndevel Module: HTTPRequest

Table of Contents

Module: HTTPRequest Zope-2-CVS-src/lib/python/ZPublisher/HTTPRequest.py

Imported modules   
from BaseRequest import BaseRequest
from Converters import get_converter
from HTTPResponse import HTTPResponse
from cgi import FieldStorage, escape
from maybe_lock import allocate_lock
import os
import re
import string
from string import lower, atoi, rfind, split, strip, join, upper, find
import sys
import time
import urllib
from urllib import quote, unquote, splittype, splitport
import whrandom
Functions   
parse_cookie
sane_environment
str_field
  parse_cookie  
parse_cookie (
        text,
        result=None,
        qparmre=re.compile( '([\x00- ]*([^\x00- ;,="]+)="([^"]*)"([\x00- ]*[;,])?[\x00- ]*)' ),
        parmre=re.compile( '([\x00- ]*([^\x00- ;,="]+)=([^\x00- ;,"]*)([\x00- ]*[;,])?[\x00- ]*)' ),
        acquire=parse_cookie_lock.acquire,
        release=parse_cookie_lock.release,
        )

  sane_environment  
sane_environment ( env )

  str_field  
str_field ( v )

Classes   
FileUpload

File upload objects

HTTPRequest

Model HTTP request data.

record

add class

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/HTTPRequest_FileUpload.py.html0100600000176200017510000000553007306455632030277 0ustar dhellmanndevel Class: FileUpload

Table of Contents

Class: FileUpload Zope-2-CVS-src/lib/python/ZPublisher/HTTPRequest.py

File upload objects

File upload objects are used to represent file-uploaded data.

File upload objects can be used just like files.

In addition, they have a headers attribute that is a dictionary containing the file-upload headers, and a filename attribute containing the name of the uploaded file.

Methods   
__init__
  __init__  
__init__ ( self,  aFieldStorage )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/HTTPRequest_HTTPRequest.py.html0100600000176200017510000005310107306455632030400 0ustar dhellmanndevel Class: HTTPRequest

Table of Contents

Class: HTTPRequest Zope-2-CVS-src/lib/python/ZPublisher/HTTPRequest.py

Model HTTP request data.

This object provides access to request data. This includes, the input headers, form data, server data, and cookies.

Request objects are created by the object publisher and will be passed to published objects through the argument name, REQUEST.

The request object is a mapping object that represents a collection of variable to value mappings. In addition, variables are divided into four categories:

  • Environment variables

    These variables include input headers, server data, and other request-related data. The variable names are as <a href="http://hoohoo.ncsa.uiuc.edu/cgi/env.html">specified</a> in the <a href="http://hoohoo.ncsa.uiuc.edu/cgi/interface.html">CGI specification</a>

  • Form data

    These are data extracted from either a URL-encoded query string or body, if present.

  • Cookies

    These are the cookie data, if present.

  • Other

    Data that may be set by an application object.

The form attribute of a request is actually a Field Storage object. When file uploads are used, this provides a richer and more complex interface than is provided by accessing form data as items of the request. See the FieldStorage class documentation for more details.

The request object may be used as a mapping object, in which case values will be looked up in the order: environment variables, other variables, form data, and then cookies.

Base Classes   
BaseRequest
Methods   
__getitem__
__init__
__str__
_authUserPW
_resetURLS
clone
get
get_header
has_key
keys
 physicalPathFromURL
physicalPathToURL
physicalPathToVirtualPath
processInputs
resolve_url
retry
setServerURL
setVirtualRoot
supports_retry
text
  __getitem__  
__getitem__ (
        self,
        key,
        default=_marker,
        URLmatch=re.compile( 'URL(PATH)?([0-9]+)$' ).match,
        BASEmatch=re.compile( 'BASE(PATH)?([0-9]+)$' ).match,
        )

Exceptions   
KeyError, key
  __init__  
__init__ (
        self,
        stdin,
        environ,
        response,
        clean=0,
        )

  __str__  
__str__ ( self )

  _authUserPW  
_authUserPW ( self )

  _resetURLS  
_resetURLS ( self )

  clone  
clone ( self )

  get  
get (
        self,
        key,
        default=None,
        )

  get_header  
get_header (
        self,
        name,
        default=None,
        )

Return the named HTTP header, or an optional default argument or None if the header is not found. Note that both original and CGI-ified header names are recognized, e.g. Content-Type, CONTENT_TYPE and HTTP_CONTENT_TYPE should all return the Content-Type header, if available.

  has_key  
has_key ( self,  key )

  keys  
keys ( self )

  physicalPathFromURL  
physicalPathFromURL ( self,  URL )

Convert a URL into a physical path in the current context. If the URL makes no sense in light of the current virtual hosting context, a ValueError is raised.

Exceptions   
ValueError, ( 'Url does not match virtual hosting context' )
  physicalPathToURL  
physicalPathToURL (
        self,
        path,
        relative=0,
        )

Convert a physical path into a URL in the current context

  physicalPathToVirtualPath  
physicalPathToVirtualPath ( self,  path )

Remove the path to the VirtualRoot from a physical path

  processInputs  
processInputs (
        self,
        SEQUENCE=1,
        DEFAULT=2,
        RECORD=4,
        RECORDS=8,
        REC=12,
        EMPTY=16,
        CONVERTED=32,
        hasattr=hasattr,
        getattr=getattr,
        setattr=setattr,
        search_type=re.compile( '(:[a-zA-Z][a-zA-Z0-9_]+|\\.[xy])$' ).search,
        rfind=string.rfind,
        )

Process request inputs

We need to delay input parsing so that it is done under publisher control for error handling purposes.

  resolve_url  
resolve_url ( self,  url )

Exceptions   
ValueError, 'Different namespace.'
rsp.errmsg, sys.exc_info() [ 1 ]
  retry  
retry ( self )

  setServerURL  
setServerURL (
        self,
        protocol=None,
        hostname=None,
        port=None,
        )

Set the parts of generated URLs.

  setVirtualRoot  
setVirtualRoot (
        self,
        path,
        hard=0,
        )

Treat the current publishing object as a VirtualRoot

  supports_retry  
supports_retry ( self )

  text  
text ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/HTTPRequest_record.py.html0100600000176200017510000001233207306455632027527 0ustar dhellmanndevel Class: record

Table of Contents

Class: record Zope-2-CVS-src/lib/python/ZPublisher/HTTPRequest.py

add class

Methods   
__getattr__
__getitem__
__repr__
__str__
  __getattr__  
__getattr__ (
        self,
        key,
        default=None,
        )

Exceptions   
AttributeError, key
  __getitem__  
__getitem__ ( self,  key )

  __repr__  
__repr__ ( self )

  __str__  
__str__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/HTTPResponse.py.html0100600000176200017510000000665607306455632026353 0ustar dhellmanndevel Module: HTTPResponse

Table of Contents

Module: HTTPResponse Zope-2-CVS-src/lib/python/ZPublisher/HTTPResponse.py

CGI Response Output formatter

$Id: HTTPResponse.py,v 1.46 2001/04/24 15:59:49 andreas Exp $

Imported modules   
from BaseResponse import BaseResponse
import re
import string
from string import find, rfind, lower, upper, strip, split, join, translate
import sys
import types
from types import StringType, InstanceType, LongType
Classes   
HTTPResponse

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/HTTPResponse_HTTPResponse.py.html0100600000176200017510000007303507306455632030724 0ustar dhellmanndevel Class: HTTPResponse

Table of Contents

Class: HTTPResponse Zope-2-CVS-src/lib/python/ZPublisher/HTTPResponse.py

Base Classes   
BaseResponse
Methods   
__init__
__str__
_cookie_list
_error_html
_html
_traceback
_unauthorized
addHeader
appendCookie
appendHeader
 badRequestError
debugError
exception
expireCookie
format_exception
insertBase
isHTML
notFoundError
quoteHTML
redirect
 retry
setBase
setBody
setCookie
setHeader
setStatus
unauthorized
write
  __init__  
__init__ (
        self,
        body='',
        status=200,
        headers=None,
        stdout=sys.stdout,
        stderr=sys.stderr,
        )

Creates a new response. In effect, the constructor calls "self.setBody(body); self.setStatus(status); for name in headers.keys(): self.setHeader(name, headers[name])"

  __str__  
__str__ ( self,  html_search=re.compile( '<html>', re.I ).search )

  _cookie_list  
_cookie_list ( self )

  _error_html  
_error_html (
        self,
        title,
        body,
        )

  _html  
_html (
        self,
        title,
        body,
        )

  _traceback  
_traceback (
        self,
        t,
        v,
        tb,
        )

  _unauthorized  
_unauthorized ( self )

  addHeader  
addHeader (
        self,
        name,
        value,
        )

Set a new HTTP return header with the given value, while retaining any previously set headers with the same name.

  appendCookie  
appendCookie (
        self,
        name,
        value,
        )

Returns an HTTP header that sets a cookie on cookie-enabled browsers with a key "name" and value "value". If a value for the cookie has previously been set in the response object, the new value is appended to the old one separated by a colon.

  appendHeader  
appendHeader (
        self,
        name,
        value,
        delimiter=",",
        )

Append a value to a cookie

Sets an HTTP return header "name" with value "value", appending it following a comma if there was a previous value set for the header.

  badRequestError  
badRequestError ( self,  name )

Exceptions   
'BadRequest', self._error_html( "Invalid request", "The parameter, %s, " % name + "was omitted from the request.

" + "Make sure to specify all required parameters, " + "and try the request again." )
'InternalError', self._error_html( "Internal Error", "Sorry, an internal error occurred in this resource." )

  debugError  
debugError ( self,  entry )

Exceptions   
'NotFound', self._error_html( "Debugging Notice", "Zope has encountered a problem publishing your object.

" "\n%s" % entry )

  exception  
exception (
        self,
        fatal=0,
        info=None,
        absuri_match=re.compile( r'\w+://[\w\.]+' ).match,
        tag_search=re.compile( '[a-zA-Z]>' ).search,
        abort=1,
        )

  expireCookie  
expireCookie (
        self,
        name,
        **kw,
        )

Cause an HTTP cookie to be removed from the browser

The response will include an HTTP header that will remove the cookie corresponding to "name" on the client, if one exists. This is accomplished by sending a new cookie with an expiration date that has already passed. Note that some clients require a path to be specified - this path must exactly match the path given when creating the cookie. The path can be specified as a keyword argument.

  format_exception  
format_exception (
        self,
        etype,
        value,
        tb,
        limit=None,
        )

  insertBase  
insertBase ( self,  base_re_search=re.compile( '(<base.*?>)', re.I ).search )

  isHTML  
isHTML ( self,  str )

  notFoundError  
notFoundError ( self,  entry='who knows!' )

Exceptions   
'NotFound', self._error_html( "Resource not found", "Sorry, the requested resource does not exist.

" + "Check the URL and try again.

" + "\n" % entry )

  quoteHTML  
quoteHTML (
        self,
        text,
        subs={ '&' : '&amp;', "<" : '&lt;', ">" : '&gt;', '\"' : '&quot;' },
        )

  redirect  
redirect (
        self,
        location,
        status=302,
        lock=0,
        )

Cause a redirection without raising an error

  retry  
retry ( self )

Return a response object to be used in a retry attempt

  setBase  
setBase ( self,  base )

Set the base URL for the returned document.

  setBody  
setBody (
        self,
        body,
        title='',
        is_error=0,
        bogus_str_search=re.compile( " [a-fA-F0-9]+>$" ).search,
        latin1_alias_match=re.compile( r'text/html(\s*;\s*charset=((latin)|(latin[-_]?1)|' r'(cp1252)|(cp819)|(csISOLatin1)|(IBM819)|(iso-ir-100)|' r'(iso[-_]8859[-_]1(:1987)?)))?$', re.I ).match,
        )

Set the body of the response

Sets the return body equal to the (string) argument "body". Also updates the "content-length" return header.

You can also specify a title, in which case the title and body will be wrapped up in html, head, title, and body tags.

If the body is a 2-element tuple, then it will be treated as (title,body)

If is_error is true then the HTML will be formatted as a Zope error message instead of a generic HTML page.

  setCookie  
setCookie (
        self,
        name,
        value,
        **kw,
        )

Set an HTTP cookie on the browser

The response will include an HTTP header that sets a cookie on cookie-enabled browsers with a key "name" and value "value". This overwrites any previously set value for the cookie in the Response object.

  setHeader  
setHeader (
        self,
        name,
        value,
        literal=0,
        )

Sets an HTTP return header "name" with value "value", clearing the previous value set for the header, if one exists. If the literal flag is true, the case of the header name is preserved, otherwise word-capitalization will be performed on the header name on output.

  setStatus  
setStatus (
        self,
        status,
        reason=None,
        )

Sets the HTTP status code of the response; the argument may either be an integer or a string from { OK, Created, Accepted, NoContent, MovedPermanently, MovedTemporarily, NotModified, BadRequest, Unauthorized, Forbidden, NotFound, InternalError, NotImplemented, BadGateway, ServiceUnavailable } that will be converted to the correct integer value.

  unauthorized  
unauthorized ( self )

Exceptions   
'Unauthorized', m
  write  
write ( self,  data )

Return data as a stream

HTML data may be returned using a stream-oriented interface. This allows the browser to display partial results while computation of a response to proceed.

The published object should first set any output headers or cookies on the response object.

Note that published objects must not generate any errors after beginning stream-oriented output.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/Publish.py.html0100600000176200017510000002523307306455632025453 0ustar dhellmanndevel Module: Publish

Table of Contents

Module: Publish Zope-2-CVS-src/lib/python/ZPublisher/Publish.py

Imported modules   
from Request import Request
from Response import Response
from mapply import mapply
from maybe_lock import allocate_lock
import os
from string import lower, atoi, rfind, strip
import sys
Functions   
call_object
dont_publish_class
get_module_info
missing_name
publish
publish_module
  call_object  
call_object (
        object,
        args,
        request,
        )

  dont_publish_class  
dont_publish_class ( klass,  request )

  get_module_info  
get_module_info (
        module_name,
        modules={},
        acquire=_l.acquire,
        release=_l.release,
        )

Exceptions   
ImportError, ( t, v ), tb
  missing_name  
missing_name ( name,  request )

  publish  
publish (
        request,
        module_name,
        after_list,
        debug=0,
        call_object=call_object,
        missing_name=missing_name,
        dont_publish_class=dont_publish_class,
        mapply=mapply,
        )

Exceptions   
'Redirect', cancel
  publish_module  
publish_module (
        module_name,
        stdin=sys.stdin,
        stdout=sys.stdout,
        stderr=sys.stderr,
        environ=os.environ,
        debug=0,
        request=None,
        response=None,
        )

Exceptions   
must_die [ 0 ], must_die [ 1 ], must_die [ 2 ]
Classes   
DefaultTransactionsManager
Retry

Raise this to retry a request

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/Publish_DefaultTransactionsManager.py.html0100600000176200017510000001113707306455632033001 0ustar dhellmanndevel Class: DefaultTransactionsManager

Table of Contents

Class: DefaultTransactionsManager Zope-2-CVS-src/lib/python/ZPublisher/Publish.py

Methods   
abort
begin
commit
recordMetaData
  abort  
abort ( self )

  begin  
begin ( self )

  commit  
commit ( self )

  recordMetaData  
recordMetaData (
        self,
        object,
        request,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/Publish_Retry.py.html0100600000176200017510000001076507306455632026644 0ustar dhellmanndevel Class: Retry

Table of Contents

Class: Retry Zope-2-CVS-src/lib/python/ZPublisher/Publish.py

Raise this to retry a request

Base Classes   
Exception
Methods   
__init__
reraise
  __init__  
__init__ (
        self,
        t=None,
        v=None,
        tb=None,
        )

  reraise  
reraise ( self )

Exceptions   
t, v
t, v, tb

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/Request.py.html0100600000176200017510000000362507306455632025476 0ustar dhellmanndevel Module: Request

Table of Contents

Module: Request Zope-2-CVS-src/lib/python/ZPublisher/Request.py

Imported modules   
import HTTPRequest

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/Response.py.html0100600000176200017510000000363207306455632025642 0ustar dhellmanndevel Module: Response

Table of Contents

Module: Response Zope-2-CVS-src/lib/python/ZPublisher/Response.py

Imported modules   
import HTTPResponse

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/Test.py.html0100600000176200017510000002345507306455632024770 0ustar dhellmanndevel Module: Test

Table of Contents

Module: Test Zope-2-CVS-src/lib/python/ZPublisher/Test.py

:" exec python $0 ${1+"$@"}

Imported modules   
import getopt
import os
import profile
import string
import sys
from time import clock
import traceback
Functions   
main
publish
publish_module
publish_module_pm
run
time
  main  
main ()

Exceptions   
'Invalid argument to -e', val
'Invalid options', 'only one of -p, -t, and -d are allowed'
TypeError, None
  publish  
publish (
        script=None,
        path_info='/',
        u=None,
        p=None,
        d=None,
        t=None,
        e=None,
        s=None,
        pm=0,
        extra=None,
        request_method='GET',
        stdin=sys.stdin,
        )

Exceptions   
TypeError, ''
  publish_module  
publish_module (
        module_name,
        stdin=sys.stdin,
        stdout=sys.stdout,
        stderr=sys.stderr,
        environ=os.environ,
        debug=0,
        request=None,
        response=None,
        extra={},
        )

Exceptions   
must_die [ 0 ], must_die [ 1 ], must_die [ 2 ]
  publish_module_pm  
publish_module_pm (
        module_name,
        stdin=sys.stdin,
        stdout=sys.stdout,
        stderr=sys.stderr,
        environ=os.environ,
        debug=0,
        extra={},
        )

  run  
run ( statement,  *args )

  time  
time (
        function,
        *args,
        *kwargs,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/__init__.py.html0100600000176200017510000001115507306455632025602 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/ZPublisher/__init__.py

Imported modules   
from Publish import publish_module, Retry
import sys
Functions   
Main
Zope
test
  Main  
Main ( *args,  *kw )

  Zope  
Zope ( *args,  *kw )

What can we say. ;/

  test  
test ( *args,  *kw )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/mapply.py.html0100600000176200017510000001450707306455632025351 0ustar dhellmanndevel Module: mapply

Table of Contents

Module: mapply Zope-2-CVS-src/lib/python/ZPublisher/mapply.py

Provide an apply-like facility that works with any mapping object

Functions   
default_call_object
default_handle_class
default_missing_name
mapply
  default_call_object  
default_call_object (
        object,
        args,
        context,
        )

  default_handle_class  
default_handle_class ( klass,  context )

  default_missing_name  
default_missing_name ( name,  context )

Exceptions   
TypeError, 'argument %s was ommitted' % name
  mapply  
mapply (
        object,
        positional=(),
        keyword={},
        debug=None,
        maybe=None,
        missing_name=default_missing_name,
        handle_class=default_handle_class,
        context=None,
        bind=0,
        )

Exceptions   
TypeError, 'too many arguments'

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/maybe_lock.py.html0100600000176200017510000000244007306455632026145 0ustar dhellmanndevel Module: maybe_lock

Table of Contents

Module: maybe_lock Zope-2-CVS-src/lib/python/ZPublisher/maybe_lock.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/xmlrpc.py.html0100600000176200017510000001100307306455632025340 0ustar dhellmanndevel Module: xmlrpc

Table of Contents

Module: xmlrpc Zope-2-CVS-src/lib/python/ZPublisher/xmlrpc.py

XML-RPC support module

Written by Eric Kidd at UserLand software, with much help from Jim Fulton at DC. This code hooks Zope up to Fredrik Lundh's Python XML-RPC library.

See http://www.xmlrpc.com/ and http://linux.userland.com/ for more information about XML-RPC and Zope.

Imported modules   
from HTTPResponse import HTTPResponse
from string import replace
import sys
import xmlrpclib
Functions   
parse_input
  parse_input  
parse_input ( data )

Parse input data and return a method path and argument tuple

The data is a string.

Classes   
Response

Customized Response that handles XML-RPC-specific details.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ZPublisher/xmlrpc_Response.py.html0100600000176200017510000001527307306455632027233 0ustar dhellmanndevel Class: Response

Table of Contents

Class: Response Zope-2-CVS-src/lib/python/ZPublisher/xmlrpc.py

Customized Response that handles XML-RPC-specific details.

We override setBody to marhsall Python objects into XML-RPC. We also override exception to convert errors to XML-RPC faults.

If these methods stop getting called, make sure that ZPublisher is using the xmlrpc.Response object created above and not the original HTTPResponse object from which it was cloned.

It's probably possible to improve the exception method quite a bit. The current implementation, however, should suffice for now.

Methods   
__delattr__
__getattr__
__init__
__setattr__
exception
setBody
  __delattr__  
__delattr__ ( self,  name )

  __getattr__  
__getattr__ ( self,  name )

  __init__  
__init__ ( self,  real )

  __setattr__  
__setattr__ (
        self,
        name,
        v,
        )

  exception  
exception (
        self,
        fatal=0,
        info=None,
        absuri_match=None,
        tag_search=None,
        )

  setBody  
setBody (
        self,
        body,
        title='',
        is_error=0,
        bogus_str_search=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:06 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Zope/0040700000176200017510000000000007306455641021352 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Zope/index.html0100600000176200017510000000424207306455641023350 0ustar dhellmanndevel Zope2 CVS with ZEO: Zope

Table of Contents

Zope2 CVS with ZEO: Zope  
Modules and Packages   

Zope-2-CVS-src/lib/python/Zope/

ClassFactory

Zope Framework Class Finder

__init__

Initialize the Zope Package and provide a published module

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:12 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Zope/ClassFactory.py.html0100600000176200017510000000650007306455640025263 0ustar dhellmanndevel Module: ClassFactory

Table of Contents

Module: ClassFactory Zope-2-CVS-src/lib/python/Zope/ClassFactory.py

Zope Framework Class Finder

Imported modules   
import OFS.Uninstalled
from string import strip
Functions   
ClassFactory
  ClassFactory  
ClassFactory (
        jar,
        module,
        name,
        _silly=( '__doc__', ),
        _globals={},
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:12 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Zope/__init__.py.html0100600000176200017510000001447007306455641024433 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/Zope/__init__.py

Initialize the Zope Package and provide a published module

Imported modules   
import AccessControl.SecurityManagement
import AccessControl.User
import App.FindHomes
import ClassFactory
import ExtensionClass
import Globals
import OFS.Application
import ZODB
import ZODB.POSException
import ZODB.ZApplication
import ZPublisher
import imp
import os
import string
import sys
from zLOG import LOG, INFO, WARNING
Functions   
debug
zpublisher_exception_hook
  debug  
debug ( *args,  *kw )

  zpublisher_exception_hook  
zpublisher_exception_hook (
        published,
        REQUEST,
        t,
        v,
        traceback,
        StringType=type( '' ),
        lower=string.lower,
        ConflictError=ZODB.POSException.ConflictError,
        ListType=type([] ),
        )

Exceptions   
ZPublisher.Retry( t, v, traceback )
Classes   
RequestContainer
TransactionsManager

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:12 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Zope/__init___RequestContainer.py.html0100600000176200017510000000623507306455641030006 0ustar dhellmanndevel Class: RequestContainer

Table of Contents

Class: RequestContainer Zope-2-CVS-src/lib/python/Zope/__init__.py

Base Classes   
ExtensionClass.Base
Methods   
__init__
  __init__  
__init__ ( self,  r )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:12 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Zope/__init___TransactionsManager.py.html0100600000176200017510000001152107306455641030450 0ustar dhellmanndevel Class: TransactionsManager

Table of Contents

Class: TransactionsManager Zope-2-CVS-src/lib/python/Zope/__init__.py

Methods   
abort
begin
commit
recordMetaData
  abort  
abort ( self,  get_transaction=get_transaction )

  begin  
begin ( self,  get_transaction=get_transaction )

  commit  
commit ( self,  get_transaction=get_transaction )

  recordMetaData  
recordMetaData (
        self,
        object,
        request,
        hasattr=hasattr,
        join=string.join,
        getattr=getattr,
        get_transaction=get_transaction,
        LOG=LOG,
        WARNING=WARNING,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:12 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/0040700000176200017510000000000007306455642021706 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/index.html0100600000176200017510000000743507306455642023713 0ustar dhellmanndevel Zope2 CVS with ZEO: webdav

Table of Contents

Zope2 CVS with ZEO: webdav  
Modules and Packages   

Zope-2-CVS-src/lib/python/webdav/

Collection

WebDAV support - collection objects.

EtagSupport
LockItem
Lockable
NullResource

WebDAV support - null resource objects.

Resource

WebDAV support - resource objects.

WriteLockInterface
__init__

The webdav package provides WebDAV capability for common Zope objects.

client

HTTP 1.1 / WebDAV client library.

common

Commonly used functions for WebDAV support modules.

davcmds

WebDAV xml request objects.

hookable_PUT
xmltools

WebDAV XML parsing tools. Note that this module does just

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/Collection.py.html0100600000176200017510000000726507306455641025326 0ustar dhellmanndevel Module: Collection

Table of Contents

Module: Collection Zope-2-CVS-src/lib/python/webdav/Collection.py

WebDAV support - collection objects.

Imported modules   
from AccessControl import getSecurityManager
import Globals
import Lockable
from Resource import Resource
from WriteLockInterface import WriteLockInterface
from common import urlfix, rfc1123_date
import davcmds
import os
import re
import string
import sys
from urllib import unquote
Classes   
Collection

The Collection class provides basic WebDAV support for

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/Collection_Collection.py.html0100600000176200017510000002013407306455641027467 0ustar dhellmanndevel Class: Collection

Table of Contents

Class: Collection Zope-2-CVS-src/lib/python/webdav/Collection.py

The Collection class provides basic WebDAV support for collection objects. It provides default implementations for all supported WebDAV HTTP methods. The behaviors of some WebDAV HTTP methods for collections are slightly different than those for non-collection resources.

Base Classes   
Resource
Methods   
DELETE
HEAD
PUT
dav__init
  DELETE  
DELETE (
        self,
        REQUEST,
        RESPONSE,
        )

Delete a collection resource. For collection resources, DELETE may return either 200 (OK) or 204 (No Content) to indicate total success, or may return 207 (Multistatus) to indicate partial success. Note that in Zope a DELETE currently never returns 207.

Exceptions   
'Locked'
'Precondition Failed'
  HEAD  
HEAD (
        self,
        REQUEST,
        RESPONSE,
        )

Retrieve resource information without a response body.

Exceptions   
'Method Not Allowed', ( 'Method not supported for this resource.' )
'Not Found', 'The requested resource does not exist.'
  PUT  
PUT (
        self,
        REQUEST,
        RESPONSE,
        )

The PUT method has no inherent meaning for collection resources, though collections are not specifically forbidden to handle PUT requests. The default response to a PUT request for collections is 405 (Method Not Allowed).

Exceptions   
'Method Not Allowed', 'Method not supported for collections.'
  dav__init  
dav__init (
        self,
        request,
        response,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/EtagSupport.py.html0100600000176200017510000000630207306455641025477 0ustar dhellmanndevel Module: EtagSupport

Table of Contents

Module: EtagSupport Zope-2-CVS-src/lib/python/webdav/EtagSupport.py

Imported modules   
import Interface
import re
from string import capitalize, split, join, strip
import time
Classes   
EtagBaseInterface

Basic Etag support interface, meaning the object supports generating

EtagSupport

This class is the basis for supporting Etags in Zope. It's main

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/EtagSupport_EtagBaseInterface.py.html0100600000176200017510000001242207306455641031053 0ustar dhellmanndevel Class: EtagBaseInterface

Table of Contents

Class: EtagBaseInterface Zope-2-CVS-src/lib/python/webdav/EtagSupport.py

Basic Etag support interface, meaning the object supports generating an Etag that can be used by certain HTTP and WebDAV Requests.

Base Classes   
Interface.Base
Methods   
http__etag
http__refreshEtag
  http__etag  
http__etag ( self )

Entity tags are used for comparing two or more entities from the same requested resource. Predominantly used for Caching, Etags can also be used to deal with the Lost Updates Problem. An HTTP Client such as Amaya that supports PUT for editing can use the Etag value returned in the head of a GET response in the if-match header submitted with a PUT request. If the Etag for the requested resource in the PUT request's if-match header is different from the current Etag value returned by this method, the PUT will fail (it means that the state of the resource has changed since the last copy the Client recieved) because the precondition (the if-match) fails (the submitted Etag does not match the current Etag).

  http__refreshEtag  
http__refreshEtag ( self )

While it may make sense to use the ZODB Object Id or bobobase_modification_time to generate an Etag, this could fail on certain REQUESTS because:

  • The object is not stored in the ZODB, or

  • A Request such as PUT changes the oid or bobobase_modification_time AFTER the Response has been written out, but the Etag needs to be updated and returned with the Response of the PUT request.

Thus, Etags need to be refreshed manually when an object changes.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/EtagSupport_EtagSupport.py.html0100600000176200017510000001375007306455641030041 0ustar dhellmanndevel Class: EtagSupport

Table of Contents

Class: EtagSupport Zope-2-CVS-src/lib/python/webdav/EtagSupport.py

This class is the basis for supporting Etags in Zope. It's main function right now is to support the Lost Updates Problem by allowing Etags and If-Match headers to be checked on PUT calls to provide a Seatbelt style functionality. The Etags is based on the bobobase_modification_time, and thus is updated whenever the object is updated. If a PUT request, or other HTTP or Dav request comes in with an Etag different than the current one, that request can be rejected according to the type of header (If-Match, If-None-Match).

Methods   
http__etag
http__parseMatchList
http__processMatchHeaders
http__refreshEtag
  http__etag  
http__etag ( self )

  http__parseMatchList  
http__parseMatchList (
        self,
        REQUEST,
        header="if-match",
        )

  http__processMatchHeaders  
http__processMatchHeaders ( self,  REQUEST=None )

Process if-match and if-none-match headers

Exceptions   
"Precondition Failed"
  http__refreshEtag  
http__refreshEtag ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/LockItem.py.html0100600000176200017510000001074407306455641024736 0ustar dhellmanndevel Module: LockItem

Table of Contents

Module: LockItem Zope-2-CVS-src/lib/python/webdav/LockItem.py

Imported modules   
from AccessControl import ClassSecurityInfo
from AccessControl.Owned import ownerInfo
from Globals import Persistent
from WriteLockInterface import LockItemInterface
from common import generateLockToken
from string import lower, split, join
import time
Functions   
validateTimeout
  validateTimeout  
validateTimeout ( timeout )

Classes   
LockItem

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/LockItem_LockItem.py.html0100600000176200017510000003630307306455641026524 0ustar dhellmanndevel Class: LockItem

Table of Contents

Class: LockItem Zope-2-CVS-src/lib/python/webdav/LockItem.py

Base Classes   
Persistent
Methods   
__init__
asLockDiscoveryProperty
asXML
getCreator
getCreatorPath
getDepth
getLockScope
getLockToken
getLockType
getModifiedTime
 getOwner
getTimeout
getTimeoutString
isValid
refresh
setTimeout
  __init__  
__init__ (
        self,
        creator,
        owner='',
        depth=0,
        timeout='Infinite',
        locktype='write',
        lockscope='exclusive',
        token=None,
        )

Exceptions   
ValueError, errors
  asLockDiscoveryProperty  
asLockDiscoveryProperty ( self,  ns='d' )

  asXML  
asXML ( self )

  getCreator  
getCreator ( self )

  getCreatorPath  
getCreatorPath ( self )

  getDepth  
getDepth ( self )

  getLockScope  
getLockScope ( self )

  getLockToken  
getLockToken ( self )

  getLockType  
getLockType ( self )

  getModifiedTime  
getModifiedTime ( self )

  getOwner  
getOwner ( self )

  getTimeout  
getTimeout ( self )

  getTimeoutString  
getTimeoutString ( self )

  isValid  
isValid ( self )

  refresh  
refresh ( self )

  setTimeout  
setTimeout ( self,  newtimeout )

Exceptions   
ValueError, errors

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/Lockable.py.html0100600000176200017510000001137507306455641024744 0ustar dhellmanndevel Module: Lockable

Table of Contents

Module: Lockable Zope-2-CVS-src/lib/python/webdav/Lockable.py

Imported modules   
from AccessControl import ClassSecurityInfo
import Acquisition
from EtagSupport import EtagSupport
import Globals
from Globals import PersistentMapping
from LockItem import LockItem
from WriteLockInterface import WriteLockInterface, LockItemInterface
Functions   
wl_isLocked
  wl_isLocked  
wl_isLocked ( ob )

Returns true if the object is locked, returns 0 if the object is not locked or does not implement the WriteLockInterface

Classes   
LockableItem

Implements the WriteLockInterface, and is inherited by Resource which

ResourceLockedError

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/Lockable_LockableItem.py.html0100600000176200017510000002556407306455641027364 0ustar dhellmanndevel Class: LockableItem

Table of Contents

Class: LockableItem Zope-2-CVS-src/lib/python/webdav/Lockable.py

Implements the WriteLockInterface, and is inherited by Resource which is then inherited by the majority of Zope objects. For an object to be lockable, however, it should have the WriteLockInterface in its __implements__ list, ie:

__implements__ = (WriteLockInterface,)

Base Classes   
EtagSupport
Methods   
wl_clearLocks
wl_delLock
wl_getLock
wl_hasLock
wl_isLocked
wl_lockItems
wl_lockTokens
wl_lockValues
wl_lockmapping
wl_setLock
  wl_clearLocks  
wl_clearLocks ( self )

  wl_delLock  
wl_delLock ( self,  locktoken )

  wl_getLock  
wl_getLock ( self,  locktoken )

  wl_hasLock  
wl_hasLock (
        self,
        token,
        killinvalids=0,
        )

  wl_isLocked  
wl_isLocked ( self )

  wl_lockItems  
wl_lockItems ( self,  killinvalids=0 )

  wl_lockTokens  
wl_lockTokens ( self,  killinvalids=0 )

  wl_lockValues  
wl_lockValues ( self,  killinvalids=0 )

  wl_lockmapping  
wl_lockmapping (
        self,
        killinvalids=0,
        create=0,
        )

if killinvalids is 1, locks who are no longer valid will be deleted

  wl_setLock  
wl_setLock (
        self,
        locktoken,
        lock,
        )

Exceptions   
ValueError, 'Lock does not implement the LockItem Interface'
ValueError, 'Lock tokens do not match'

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/Lockable_ResourceLockedError.py.html0100600000176200017510000000366707306455641030754 0ustar dhellmanndevel Class: ResourceLockedError

Table of Contents

Class: ResourceLockedError Zope-2-CVS-src/lib/python/webdav/Lockable.py

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/NullResource.py.html0100600000176200017510000001016207306455641025643 0ustar dhellmanndevel Module: NullResource

Table of Contents

Module: NullResource Zope-2-CVS-src/lib/python/webdav/NullResource.py

WebDAV support - null resource objects.

Imported modules   
from AccessControl import getSecurityManager
from AccessControl.Permission import Permission
import Acquisition
import Globals
from Globals import Persistent, DTMLFile
import OFS.SimpleItem
import OFS.content_types
from Resource import Resource
from WriteLockInterface import WriteLockInterface
from common import absattr, aq_base, urlfix, tokenFinder, IfParser
import davcmds
import mimetypes
import os
import string
import sys
Classes   
LockNullResource

A Lock-Null Resource is created when a LOCK command is succesfully

NullResource

Null resources are used to handle HTTP method calls on

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/NullResource_LockNullResource.py.html0100600000176200017510000002642207306455641031164 0ustar dhellmanndevel Class: LockNullResource

Table of Contents

Class: LockNullResource Zope-2-CVS-src/lib/python/webdav/NullResource.py

A Lock-Null Resource is created when a LOCK command is succesfully executed on a NullResource, essentially locking the Name. A PUT or MKCOL deletes the LockNull resource from its container and replaces it with the target object. An UNLOCK deletes it.

Base Classes   
NullResource
    Persistent
    Acquisition.Implicit
    Resource
OFS.SimpleItem.Item_w__name__
Methods   
LOCK
MKCOL
PUT
UNLOCK
__init__
__no_valid_write_locks__
title_or_id
  LOCK  
LOCK (
        self,
        REQUEST,
        RESPONSE,
        )

A Lock command on a LockNull resource should only be a refresh request (one without a body)

Exceptions   
'Precondition Failed'
  MKCOL  
MKCOL (
        self,
        REQUEST,
        RESPONSE,
        )

Create a new Collection (folder) resource. Since this is being done on a LockNull resource, this also involves removing the LockNull object and transferring its locks to the newly created Folder

Exceptions   
'Precondition Failed', 'No If-header'
'Precondition Failed', ( 'Condition failed against locknull resource' )
'Precondition Failed', ( 'Condition failed against resources parent' )
'Unsupported Media Type', 'Unknown request body.'
  PUT  
PUT (
        self,
        REQUEST,
        RESPONSE,
        )

Create a new non-collection resource, deleting the LockNull object from the container before putting the new object in.

Exceptions   
'Forbidden', sys.exc_info() [ 1 ]
'Method Not Allowed', ( 'The target object type cannot be locked' )
'Precondition Failed', 'No If-header'
'Precondition Failed', ( 'Condition failed against locknull resource' )
'Precondition Failed', ( 'Condition failed against resources parent' )
'Unauthorized', sys.exc_info() [ 1 ]
  UNLOCK  
UNLOCK (
        self,
        REQUEST,
        RESPONSE,
        )

Unlocking a Null Resource removes it from its parent

Exceptions   
'Bad Request', 'No lock token was submitted in the request'
  __init__  
__init__ ( self,  name )

  __no_valid_write_locks__  
__no_valid_write_locks__ ( self )

  title_or_id  
title_or_id ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/NullResource_NullResource.py.html0100600000176200017510000002664407306455641030361 0ustar dhellmanndevel Class: NullResource

Table of Contents

Class: NullResource Zope-2-CVS-src/lib/python/webdav/NullResource.py

Null resources are used to handle HTTP method calls on objects which do not yet exist in the url namespace.

Base Classes   
Persistent
Acquisition.Implicit
Resource
Methods   
HEAD
LOCK
MKCOL
PUT
__bobo_traverse__
__init__
_default_PUT_factory
  HEAD  
HEAD (
        self,
        REQUEST,
        RESPONSE,
        )

Retrieve resource information without a response message body.

Exceptions   
'Not Found', 'The requested resource does not exist.'
  LOCK  
LOCK (
        self,
        REQUEST,
        RESPONSE,
        )

LOCK on a Null Resource makes a LockNullResource instance

Exceptions   
'Bad Request', 'No body was in the request'
'Locked'
'Precondition Failed'
  MKCOL  
MKCOL (
        self,
        REQUEST,
        RESPONSE,
        )

Create a new collection resource.

Exceptions   
'Forbidden', 'Cannot create collection at this location.'
'Locked'
'Method Not Allowed', 'The name %s is in use.' % name
'Precondition Failed'
'Unsupported Media Type', 'Unknown request body.'
  PUT  
PUT (
        self,
        REQUEST,
        RESPONSE,
        )

Create a new non-collection resource.

Exceptions   
'Forbidden', sys.exc_info() [ 1 ]
'Locked'
'Precondition Failed'
'Unauthorized', sys.exc_info() [ 1 ]
  __bobo_traverse__  
__bobo_traverse__ (
        self,
        REQUEST,
        name=None,
        )

Exceptions   
'Conflict', 'Collection ancestors must already exist.'
'Not Found', 'The requested resource was not found.'
  __init__  
__init__ (
        self,
        parent,
        name,
        request=None,
        )

  _default_PUT_factory  
_default_PUT_factory (
        self,
        name,
        typ,
        body,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/Resource.py.html0100600000176200017510000000773607306455641025025 0ustar dhellmanndevel Module: Resource

Table of Contents

Module: Resource Zope-2-CVS-src/lib/python/webdav/Resource.py

WebDAV support - resource objects.

Imported modules   
from AccessControl import getSecurityManager
import ExtensionClass
import Globals
import Lockable
from WriteLockInterface import WriteLockInterface
from ZPublisher.HTTPRangeSupport import HTTPRangeInterface
from common import absattr, aq_base, urlfix, rfc1123_date, tokenFinder, urlbase, IfParser
import davcmds
import mimetypes
import os
import string
import sys
import time
from urllib import quote, unquote
Classes   
Resource

The Resource mixin class provides basic WebDAV support for

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/Resource_Resource.py.html0100600000176200017510000005662607306455641026676 0ustar dhellmanndevel Class: Resource

Table of Contents

Class: Resource Zope-2-CVS-src/lib/python/webdav/Resource.py

The Resource mixin class provides basic WebDAV support for non-collection objects. It provides default implementations for most supported WebDAV HTTP methods, however certain methods such as PUT should be overridden to ensure correct behavior in the context of the object type.

Base Classes   
ExtensionClass.Base
Lockable.LockableItem
Methods   
COPY
DELETE
HEAD
LOCK
MKCOL
MOVE
OPTIONS
PROPFIND
PROPPATCH
PUT
 TRACE
UNLOCK
dav__init
dav__simpleifhandler
dav__validate
  COPY  
COPY (
        self,
        REQUEST,
        RESPONSE,
        )

Create a duplicate of the source resource whose state and behavior match that of the source resource as closely as possible. Though we may later try to make a copy appear seamless across namespaces (e.g. from Zope to Apache), COPY is currently only supported within the Zope namespace.

Exceptions   
'Bad Request', 'Invalid Depth header.'
'Bad Request', 'Invalid Destination header'
'Bad Request', 'Invalid Destination header.'
'Bad Request', 'Invalid Overwrite header.'
'Conflict', 'Attempt to copy to an unknown namespace.'
'Conflict', 'Object ancestors must already exist.'
'Forbidden', sys.exc_info() [ 1 ]
'Locked', 'Destination is locked.'
'Method Not Allowed', 'This object may not be copied.'
'Precondition Failed', 'Destination resource exists.'
 'Preconditon Failed'
'Unauthorized', sys.exc_info() [ 1 ]
t, v
  DELETE  
DELETE (
        self,
        REQUEST,
        RESPONSE,
        )

Delete a resource. For non-collection resources, DELETE may return either 200 or 204 (No Content) to indicate success.

Exceptions   
'Locked', 'Resource is locked.'
'Precondition Failed', 'Resource is locked, and no ' 'condition was passed in.'
  HEAD  
HEAD (
        self,
        REQUEST,
        RESPONSE,
        )

Retrieve resource information without a response body.

WebDAV class 1 support

  LOCK  
LOCK (
        self,
        REQUEST,
        RESPONSE,
        )

Lock a resource

Exceptions   
'Precondition Failed', 'If Header Missing'
  MKCOL  
MKCOL (
        self,
        REQUEST,
        RESPONSE,
        )

Create a new collection resource. If called on an existing resource, MKCOL must fail with 405 (Method Not Allowed).

Exceptions   
'Method Not Allowed', 'The resource already exists.'
  MOVE  
MOVE (
        self,
        REQUEST,
        RESPONSE,
        )

Move a resource to a new location. Though we may later try to make a move appear seamless across namespaces (e.g. from Zope to Apache), MOVE is currently only supported within the Zope namespace.

Exceptions   
'Bad Request', 'No destination given'
'Conflict', 'Attempt to move to an unknown namespace.'
'Conflict', 'The resource %s must exist.' % parent_path
'Forbidden', sys.exc_info() [ 1 ]
'Locked', 'Destination is locked.'
'Method Not Allowed', 'This object may not be moved.'
'Precondition Failed'
'Precondition Failed', 'Condition failed.'
'Precondition Failed', 'Resource %s exists.' % dest
'Precondition Failed', 'Source is locked and no ' 'condition was passed in.'
 'Unauthorized', sys.exc_info() [ 1 ]
t, v
  OPTIONS  
OPTIONS (
        self,
        REQUEST,
        RESPONSE,
        )

Retrieve communication options.

  PROPFIND  
PROPFIND (
        self,
        REQUEST,
        RESPONSE,
        )

Retrieve properties defined on the resource.

  PROPPATCH  
PROPPATCH (
        self,
        REQUEST,
        RESPONSE,
        )

Set and/or remove properties defined on the resource.

Exceptions   
'Locked', 'Resource is locked.'
'Method Not Allowed', ( 'Method not supported for this resource.' )
  PUT  
PUT (
        self,
        REQUEST,
        RESPONSE,
        )

Replace the GET response entity of an existing resource. Because this is often object-dependent, objects which handle PUT should override the default PUT implementation with an object-specific implementation. By default, PUT requests fail with a 405 (Method Not Allowed).

Exceptions   
'Method Not Allowed', 'Method not supported for this resource.'
  TRACE  
TRACE (
        self,
        REQUEST,
        RESPONSE,
        )

Return the HTTP message received back to the client as the entity-body of a 200 (OK) response. This will often usually be intercepted by the web server in use. If not, the TRACE request will fail with a 405 (Method Not Allowed), since it is not often possible to reproduce the HTTP request verbatim from within the Zope environment.

Exceptions   
'Method Not Allowed', 'Method not supported for this resource.'
  UNLOCK  
UNLOCK (
        self,
        REQUEST,
        RESPONSE,
        )

Remove an existing lock on a resource.

  dav__init  
dav__init (
        self,
        request,
        response,
        )

  dav__simpleifhandler  
dav__simpleifhandler (
        self,
        request,
        response,
        method='PUT',
        col=0,
        url=None,
        refresh=0,
        )

Exceptions   
"Locked", "Resource is locked."
'Precondition Failed', 'Condition failed.'
  dav__validate  
dav__validate (
        self,
        object,
        methodname,
        REQUEST,
        )

Exceptions   
'Unauthorized', msg

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/WriteLockInterface.py.html0100600000176200017510000000566007306455642026755 0ustar dhellmanndevel Module: WriteLockInterface

Table of Contents

Module: WriteLockInterface Zope-2-CVS-src/lib/python/webdav/WriteLockInterface.py

Imported modules   
import Interface
Classes   
LockItemInterface

A LockItem contains information about a lock. This includes:

WriteLockInterface

This represents the basic protocol needed to support the write lock

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/WriteLockInterface_LockItemInterface.py.html0100600000176200017510000004166607306455642032373 0ustar dhellmanndevel Class: LockItemInterface

Table of Contents

Class: LockItemInterface Zope-2-CVS-src/lib/python/webdav/WriteLockInterface.py

A LockItem contains information about a lock. This includes:

  • The locktoken uri (used to identify the lock by WebDAV)

  • The lock owner (The string passed in the owner property by WebDAV)

  • The lock creator (the Zope user who physically owns the lock)

  • Depth

  • Timeout information

  • Modified time (for calculating timeouts)

  • LockType (only EXCLUSIVE is supported right now)

Base Classes   
Interface.Base
Methods   
__init__
asLockDiscoveryProperty
asXML
getCreator
getCreatorPath
getDepth
getLockScope
getLockToken
getLockType
getModifiedTime
 getOwner
getTimeout
getTimeoutString
isValid
refresh
setTimeout
  __init__  
__init__ (
        self,
        creator,
        owner,
        depth=0,
        timeout='Infinity',
        locktype='write',
        lockscope='exclusive',
        token=None,
        )

If any of the following are untrue, a ValueError exception will be raised.

  • creator MUST be a Zope user object or string to find a valid user object.

  • owner MUST be a nonempty string, or type that can be converted to a nonempty string.

  • depth MUST be in the set {0,'infinity'}

  • timeout MUST either be an integer, or a string in the form of Seconds-nnn where nnn is an integer. The timeout value MUST be less than (2^32)-1. IF timeout is the string value Infinite, the timeout value will be set to 1800 (30 minutes). (Timeout is the value in seconds from creation\modification time until the lock MAY time out).

  • locktype not in set {'write'} this may expand later

  • lockscope not in set {'exclusive'} this may expand later

If the value passed in to token is None, the a new locktoken will be generated during the construction process.

__init__ must generate the opaquelocktoken uri used to identify the lock (if token is None)and set all of the above attributes on the object.

  asLockDiscoveryProperty  
asLockDiscoveryProperty ( self,  ns='d' )

Return the lock rendered as an XML representation of a WebDAV lockdiscovery property. ns is the namespace identifier used on the XML elements.

  asXML  
asXML ( self )

Render a full XML representation of a lock for WebDAV, used when returning the value of a newly created lock.

  getCreator  
getCreator ( self )

Returns the Zope user who created the lock. This is returned in a tuple containing the Users ID and the path to the user folder they came from.

  getCreatorPath  
getCreatorPath ( self )

Returns a string of the path to the user object in the user folder they were found in.

  getDepth  
getDepth ( self )

returns the depth of the lock

  getLockScope  
getLockScope ( self )

returns the lock scope (exclusive)

  getLockToken  
getLockToken ( self )

returns the opaque lock token

  getLockType  
getLockType ( self )

returns the lock type (write)

  getModifiedTime  
getModifiedTime ( self )

returns a time.time value of the last time the Lock was modified. From RFC 2518:

The timeout counter SHOULD be restarted any time an owner of the lock sends a method to any member of the lock, including unsupported methods or methods which are unsucscessful. The lock MUST be refreshed if a refresh LOCK method is successfully received.

The modified time is used to calculate the refreshed value

  getOwner  
getOwner ( self )

Returns the string value of the owner property sent in by WebDAV

  getTimeout  
getTimeout ( self )

returns an integer value of the timeout setting

  getTimeoutString  
getTimeoutString ( self )

returns the timeout value in a form acceptable by WebDAV (ie - Seconds-40800)

  isValid  
isValid ( self )

Returns true if (self.getModifiedTime() + self.getTimeout()) is greater than the current time.time() value.

  refresh  
refresh ( self )

Tickles the locks modified time by setting it to the current time.time() value. (As stated in the RFC, the timeout counter SHOULD be restarted for any HTTP method called by the lock owner on the locked object).

  setTimeout  
setTimeout ( self,  newtimeout )

refreshes the timeout information

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/WriteLockInterface_WriteLockInterface.py.html0100600000176200017510000002524007306455642032555 0ustar dhellmanndevel Class: WriteLockInterface

Table of Contents

Class: WriteLockInterface Zope-2-CVS-src/lib/python/webdav/WriteLockInterface.py

This represents the basic protocol needed to support the write lock machinery.

It must be able to answer the questions:

  • Is the object locked?

  • Is the lock owned by the current user?

  • What lock tokens are associated with the current object?

  • What is their state (how long until they're supposed to time out?, what is their depth? what type are they?

And it must be able to do the following:

  • Grant a write lock on the object to a specified user.

    • If lock depth is infinite, this must also grant locks on all subobjects, or fail altogether

  • Revoke a lock on the object.

    • If lock depth is infinite, this must also revoke locks on all subobjects

All methods in the WriteLock interface that deal with checking valid locks MUST check the timeout values on the lockitem (ie, by calling lockitem.isValid()), and DELETE the lock if it is no longer valid

Base Classes   
Interface.Base
Methods   
wl_clearLocks
wl_delLock
wl_getLock
wl_hasLock
wl_isLocked
wl_lockItems
wl_lockTokens
wl_lockValues
wl_setLock
  wl_clearLocks  
wl_clearLocks ( self )

Deletes ALL DAV locks on the object - should only be called by lock management machinery.

  wl_delLock  
wl_delLock ( self,  locktoken )

Deletes the locktoken identified by the locktokenuri

  wl_getLock  
wl_getLock ( self,  locktoken )

Returns the locktoken identified by the locktokenuri

  wl_hasLock  
wl_hasLock (
        self,
        token,
        killinvalids=0,
        )

Returns true if the lock identified by the token is attached to the object.

  wl_isLocked  
wl_isLocked ( self )

Returns true if self is locked at all. If invalid locks still exist, they should be deleted.

  wl_lockItems  
wl_lockItems ( self,  killinvalids=0 )

Returns (key, value) pairs of locktoken, lock.

if killinvalids is true, invalid locks (locks whose timeout has been exceeded) will be deleted

  wl_lockTokens  
wl_lockTokens ( self,  killinvalids=0 )

Returns a sequence of lock tokens. if killinvalids is true, invalid locks will be deleted

  wl_lockValues  
wl_lockValues ( self,  killinvalids=0 )

Returns a sequence of locks. if killinvalids is true, invalid locks will be deleted

  wl_setLock  
wl_setLock (
        self,
        locktoken,
        lock,
        )

Store the LockItem, lock. The locktoken will be used to fetch and delete the lock. If the lock exists, this MUST overwrite it if all of the values except for the timeout on the old and new lock are the same.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/__init__.py.html0100600000176200017510000000500507306455642024761 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/lib/python/webdav/__init__.py

The webdav package provides WebDAV capability for common Zope objects.

Current WebDAV support in Zope provides for the correct handling of HTTP GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE, PROPFIND, PROPPATCH, MKCOL, COPY and MOVE methods, as appropriate for the object that is the target of the operation. Objects which do not support a given operation should respond appropriately with a "405 Method Not Allowed" response.

Note that the ability of a Zope installation to support WebDAV HTTP methods depends on the willingness of the web server to defer handling of those methods to the Zope process. In most cases, servers will allow the process to handle any request, so the Zope portion of your url namespace may well be able to handle WebDAV operations even though your web server software is not WebDAV-aware itself. Zope installations which use bundled server implementations such as ZopeHTTPServer or ZServer should fully support WebDAV functions.

References:

[WebDAV] Y. Y. Goland, E. J. Whitehead, Jr., A. Faizi, S. R. Carter, D. Jensen, "HTTP Extensions for Distributed Authoring - WebDAV." RFC 2518. Microsoft, U.C. Irvine, Netscape, Novell. February, 1999.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/client.py.html0100600000176200017510000002542107306455642024504 0ustar dhellmanndevel Module: client

Table of Contents

Module: client Zope-2-CVS-src/lib/python/webdav/client.py

HTTP 1.1 / WebDAV client library.

Imported modules   
from base64 import encodestring
from cStringIO import StringIO
from common import rfc1123_date
import httplib
import mimetools
from mimetypes import guess_type
import os
import re
import socket
import string
import sys
import time
import types
from types import FileType
from urllib import quote
from whrandom import random
Functions   
marshal_float
marshal_int
marshal_list
marshal_long
marshal_string
marshal_tuple
marshal_var
  marshal_float  
marshal_float ( name,  val )

  marshal_int  
marshal_int ( name,  val )

  marshal_list  
marshal_list (
        name,
        seq,
        tname='list',
        lt=type([] ),
        tt=type(() ),
        )

Exceptions   
TypeError, 'Invalid recursion in data to be marshaled.'
  marshal_long  
marshal_long ( name,  val )

  marshal_string  
marshal_string ( name,  val )

  marshal_tuple  
marshal_tuple ( name,  seq )

  marshal_var  
marshal_var ( name,  val )

Classes   
HTTP

A revised version of the HTTP class that can do basic

MultiPart
Resource

An object representing a web resource.

http_response

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/client_HTTP.py.html0100600000176200017510000001002107306455642025331 0ustar dhellmanndevel Class: HTTP

Table of Contents

Class: HTTP Zope-2-CVS-src/lib/python/webdav/client.py

A revised version of the HTTP class that can do basic HTTP 1.1 connections, and also compensates for a bug that occurs on some platforms in 1.5 and 1.5.1 with socket.makefile().read()

Base Classes   
httplib.HTTP
Methods   
getreply
putrequest
  getreply  
getreply ( self )

  putrequest  
putrequest (
        self,
        request,
        selector,
        ver='1.1',
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/client_MultiPart.py.html0100600000176200017510000001106407306455642026503 0ustar dhellmanndevel Class: MultiPart

Table of Contents

Class: MultiPart Zope-2-CVS-src/lib/python/webdav/client.py

Methods   
__init__
boundary
render
  __init__  
__init__ ( self,  *args )

Exceptions   
ValueError, 'Invalid arguments'
ValueError, 'Sorry, nested multipart is not done yet!'
  boundary  
boundary ( self )

  render  
render ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/client_Resource.py.html0100600000176200017510000006462307306455642026362 0ustar dhellmanndevel Class: Resource

Table of Contents

Class: Resource Zope-2-CVS-src/lib/python/webdav/client.py

An object representing a web resource.

Methods   
__enc_formdata
__enc_multipart
__get_headers
__getattr__
__init__
__set_authtoken
__snd_request
__str__
allprops
copy
 delete
delprops
get
getprops
head
lock
mkcol
move
options
post
 propfind
propnames
proppatch
put
setprops
trace
unlock
  __enc_formdata  
__enc_formdata ( self,  args={} )

  __enc_multipart  
__enc_multipart ( self,  args={} )

  __get_headers  
__get_headers ( self,  kw={} )

  __getattr__  
__getattr__ ( self,  name )

  __init__  
__init__ (
        self,
        url,
        username=None,
        password=None,
        )

Exceptions   
ValueError, url
  __set_authtoken  
__set_authtoken (
        self,
        headers,
        atype='Basic',
        )

Exceptions   
ValueError, 'Unknown authentication scheme: %s' % atype
  __snd_request  
__snd_request (
        self,
        method,
        uri,
        headers={},
        body='',
        eh=1,
        )

Exceptions   
'NotAvailable', sys.exc_value
  __str__  
__str__ ( self )

  allprops  
allprops ( self,  depth=0 )

  copy  
copy (
        self,
        dest,
        depth='infinity',
        overwrite=0,
        **kw,
        )

Copy a resource to the specified destination.

  delete  
delete ( self,  **kw )

  delprops  
delprops ( self,  *names )

Exceptions   
ValueError, 'No property names specified.'
  get  
get ( self,  **kw )

  getprops  
getprops ( self,  *names )

  head  
head ( self,  **kw )

  lock  
lock (
        self,
        scope='exclusive',
        type='write',
        owner='',
        depth='infinity',
        timeout='Infinite',
        **kw,
        )

Create a lock with the specified scope, type, owner, depth and timeout on the resource. A locked resource prevents a principal without the lock from executing a PUT, POST, PROPPATCH, LOCK, UNLOCK, MOVE, DELETE, or MKCOL on the locked resource.

Exceptions   
ValueError, 'Invalid depth.'
ValueError, 'Invalid lock scope.'
ValueError, 'Invalid lock type.'
  mkcol  
mkcol ( self,  **kw )

  move  
move (
        self,
        dest,
        depth='infinity',
        overwrite=0,
        **kw,
        )

Move a resource to the specified destination.

  options  
options ( self,  **kw )

  post  
post ( self,  **kw )

  propfind  
propfind (
        self,
        body='',
        depth=0,
        **kw,
        )

  propnames  
propnames ( self,  depth=0 )

  proppatch  
proppatch (
        self,
        body,
        **kw,
        )

  put  
put (
        self,
        file='',
        content_type='',
        content_enc='',
        isbin=re.compile( r'[\000-\006\177-\277]' ).search,
        **kw,
        )

Exceptions   
ValueError, 'File must be a filename, file or string.'
  setprops  
setprops ( self,  **props )

Exceptions   
ValueError, 'No properties specified.'
  trace  
trace ( self,  **kw )

  unlock  
unlock (
        self,
        token,
        **kw,
        )

Remove the lock identified by token from the resource and all other resources included in the lock. If all resources which have been locked under the submitted lock token can not be unlocked the unlock method will fail.

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/client_http_response.py.html0100600000176200017510000001404707306455642027463 0ustar dhellmanndevel Class: http_response

Table of Contents

Class: http_response Zope-2-CVS-src/lib/python/webdav/client.py

Methods   
__init__
__str__
get_body
get_header
get_headers
get_status
  __init__  
__init__ (
        self,
        ver,
        code,
        msg,
        headers,
        body,
        )

  __str__  
__str__ ( self )

  get_body  
get_body ( self )

  get_header  
get_header (
        self,
        name,
        val=None,
        )

  get_headers  
get_headers ( self )

  get_status  
get_status ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/common.py.html0100600000176200017510000002213107306455642024511 0ustar dhellmanndevel Module: common

Table of Contents

Module: common Zope-2-CVS-src/lib/python/webdav/common.py

Commonly used functions for WebDAV support modules.

Imported modules   
from App.Common import iso8601_date, rfc850_date, rfc1123_date, aq_base
import re
import string
import time
import urllib
Functions   
IfParser
ListParser
absattr
generateLockToken
is_acquired
tokenFinder
urlbase
urlfix
  IfParser  
IfParser ( hdr )

  ListParser  
ListParser ( listitem )

  absattr  
absattr ( attr )

  generateLockToken  
generateLockToken ()

  is_acquired  
is_acquired ( ob )

  tokenFinder  
tokenFinder ( token )

  urlbase  
urlbase (
        url,
        ftype=urllib.splittype,
        fhost=urllib.splithost,
        )

  urlfix  
urlfix ( url,  s )

Classes   
TagList

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/common_TagList.py.html0100600000176200017510000000476007306455642026150 0ustar dhellmanndevel Class: TagList

Table of Contents

Class: TagList Zope-2-CVS-src/lib/python/webdav/common.py

Methods   
__init__
  __init__  
__init__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/davcmds.py.html0100600000176200017510000001363607306455642024654 0ustar dhellmanndevel Module: davcmds

Table of Contents

Module: davcmds Zope-2-CVS-src/lib/python/webdav/davcmds.py

WebDAV xml request objects.

Imported modules   
from AccessControl import getSecurityManager
from Acquisition import aq_parent
from LockItem import LockItem
from OFS.PropertySheets import DAVProperties
from WriteLockInterface import WriteLockInterface
from cStringIO import StringIO
from common import absattr, aq_base, urlfix, urlbase
import os
import string
import sys
from urllib import quote
from xmltools import XmlParser
Functions   
safe_quote
  safe_quote  
safe_quote (
        url,
        mark=r'%',
        find=string.find,
        )

Classes   
DAVProps

Emulate required DAV properties for objects which do

DeleteCollection

With WriteLocks in the picture, deleting a collection involves

Lock

Model a LOCK request.

PropFind

Model a PROPFIND request.

PropPatch

Model a PROPPATCH request.

Unlock

Model an Unlock request

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/davcmds_DAVProps.py.html0100600000176200017510000000772107306455642026370 0ustar dhellmanndevel Class: DAVProps

Table of Contents

Class: DAVProps Zope-2-CVS-src/lib/python/webdav/davcmds.py

Emulate required DAV properties for objects which do not themselves support properties. This is mainly so that non-PropertyManagers can appear to support DAV PROPFIND requests.

Base Classes   
DAVProperties
Methods   
__init__
v_self
  __init__  
__init__ ( self,  obj )

  v_self  
v_self ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/davcmds_DeleteCollection.py.html0100600000176200017510000000660007306455642030143 0ustar dhellmanndevel Class: DeleteCollection

Table of Contents

Class: DeleteCollection Zope-2-CVS-src/lib/python/webdav/davcmds.py

With WriteLocks in the picture, deleting a collection involves checking all descendents (deletes on collections are always of depth infinite) for locks and if the locks match.

Methods   
apply
  apply  
apply (
        self,
        obj,
        token,
        user,
        url=None,
        result=None,
        top=1,
        )

Exceptions   
err

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/davcmds_Lock.py.html0100600000176200017510000001127207306455642025616 0ustar dhellmanndevel Class: Lock

Table of Contents

Class: Lock Zope-2-CVS-src/lib/python/webdav/davcmds.py

Model a LOCK request.

Methods   
__init__
apply
parse
  __init__  
__init__ ( self,  request )

  apply  
apply (
        self,
        obj,
        creator=None,
        depth='infinity',
        token=None,
        result=None,
        url=None,
        top=1,
        )

Apply, built for recursion (so that we may lock subitems of a collection if requested

Exceptions   
errmsg [ 4 : ]
  parse  
parse (
        self,
        data,
        dav='DAV:',
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/davcmds_PropFind.py.html0100600000176200017510000001255307306455642026452 0ustar dhellmanndevel Class: PropFind

Table of Contents

Class: PropFind Zope-2-CVS-src/lib/python/webdav/davcmds.py

Model a PROPFIND request.

Methods   
__init__
apply
parse
  __init__  
__init__ ( self,  request )

  apply  
apply (
        self,
        obj,
        url=None,
        depth=0,
        result=None,
        top=1,
        )

Exceptions   
'Bad Request', 'Invalid request'
  parse  
parse (
        self,
        request,
        dav='DAV:',
        )

Exceptions   
'Bad Request', 'Invalid Depth header.'
'Bad Request', 'Invalid xml request.'
'Bad Request', sys.exc_info() [ 1 ]

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/davcmds_PropPatch.py.html0100600000176200017510000001110407306455642026620 0ustar dhellmanndevel Class: PropPatch

Table of Contents

Class: PropPatch Zope-2-CVS-src/lib/python/webdav/davcmds.py

Model a PROPPATCH request.

Methods   
__init__
apply
parse
  __init__  
__init__ ( self,  request )

  apply  
apply ( self,  obj )

  parse  
parse (
        self,
        request,
        dav='DAV:',
        )

Exceptions   
'Bad Request', 'Invalid xml request.'
'Bad Request', sys.exc_info() [ 1 ]

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/davcmds_Unlock.py.html0100600000176200017510000000632707306455642026166 0ustar dhellmanndevel Class: Unlock

Table of Contents

Class: Unlock Zope-2-CVS-src/lib/python/webdav/davcmds.py

Model an Unlock request

Methods   
apply
  apply  
apply (
        self,
        obj,
        token,
        url=None,
        result=None,
        top=1,
        )

Exceptions   
"Forbidden"
"Precondition Failed"

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/hookable_PUT.py.html0100600000176200017510000000640607306455642025544 0ustar dhellmanndevel Module: hookable_PUT

Table of Contents

Module: hookable_PUT Zope-2-CVS-src/lib/python/webdav/hookable_PUT.py

Imported modules   
import OFS.DTMLMethod
import re
Functions   
PUT_factory
  PUT_factory  
PUT_factory (
        self,
        name,
        typ,
        body,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/xmltools.py.html0100600000176200017510000001452707306455642025114 0ustar dhellmanndevel Module: xmltools

Table of Contents

Module: xmltools Zope-2-CVS-src/lib/python/webdav/xmltools.py

WebDAV XML parsing tools. Note that this module does just enough for the purposes of DAV - it is not intended as a general xml toolkit, and will probably eventually go away in favor of a standard xml package once some issues are worked out.

Imported modules   
from Acquisition import Implicit
import Shared.DC.xml.xmllib
import os
import string
import sys
Functions   
escape
remap
  escape  
escape (
        data,
        rmap={},
        replace=string.replace,
        )

  remap  
remap ( data,  dict={ 'DAV:' : 'd' } )

Classes   
Attribute
CData
Comment
Document
Element
Entity
EntityRef
Node

Common base class for Node objects.

ProcInst
Text
XmlParser

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/xmltools_Attribute.py.html0100600000176200017510000001115507306455642027131 0ustar dhellmanndevel Class: Attribute

Table of Contents

Class: Attribute Zope-2-CVS-src/lib/python/webdav/xmltools.py

Base Classes   
Node
    Implicit
Methods   
__init__
remap
toxml
  __init__  
__init__ (
        self,
        name,
        val,
        )

  remap  
remap (
        self,
        dict,
        n=0,
        top=1,
        )

  toxml  
toxml ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/xmltools_CData.py.html0100600000176200017510000000753707306455642026153 0ustar dhellmanndevel Class: CData

Table of Contents

Class: CData Zope-2-CVS-src/lib/python/webdav/xmltools.py

Base Classes   
Node
    Implicit
Methods   
__init__
toxml
  __init__  
__init__ ( self,  val )

  toxml  
toxml ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/xmltools_Comment.py.html0100600000176200017510000000754307306455642026576 0ustar dhellmanndevel Class: Comment

Table of Contents

Class: Comment Zope-2-CVS-src/lib/python/webdav/xmltools.py

Base Classes   
Node
    Implicit
Methods   
__init__
toxml
  __init__  
__init__ ( self,  val )

  toxml  
toxml ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/xmltools_Document.py.html0100600000176200017510000000763707306455642026756 0ustar dhellmanndevel Class: Document

Table of Contents

Class: Document Zope-2-CVS-src/lib/python/webdav/xmltools.py

Base Classes   
Node
    Implicit
Methods   
__init__
toxml
  __init__  
__init__ (
        self,
        encoding='utf-8',
        stdalone='',
        )

  toxml  
toxml ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/xmltools_Element.py.html0100600000176200017510000002005607306455642026557 0ustar dhellmanndevel Class: Element

Table of Contents

Class: Element Zope-2-CVS-src/lib/python/webdav/xmltools.py

Base Classes   
Node
    Implicit
Methods   
__init__
del_attr
fixup
get_attr
ns_parse
remap
strval
toxml
  __init__  
__init__ (
        self,
        name,
        attrs={},
        )

  del_attr  
del_attr ( self,  name )

  fixup  
fixup ( self )

  get_attr  
get_attr (
        self,
        name,
        ns=None,
        default=None,
        )

  ns_parse  
ns_parse ( self )

  remap  
remap (
        self,
        dict,
        n=0,
        top=1,
        )

  strval  
strval ( self,  top=1 )

  toxml  
toxml ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/xmltools_Entity.py.html0100600000176200017510000000764707306455642026455 0ustar dhellmanndevel Class: Entity

Table of Contents

Class: Entity Zope-2-CVS-src/lib/python/webdav/xmltools.py

Base Classes   
Node
    Implicit
Methods   
__init__
toxml
  __init__  
__init__ (
        self,
        name,
        pubid,
        sysid,
        nname,
        )

  toxml  
toxml ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/xmltools_EntityRef.py.html0100600000176200017510000000754707306455642027111 0ustar dhellmanndevel Class: EntityRef

Table of Contents

Class: EntityRef Zope-2-CVS-src/lib/python/webdav/xmltools.py

Base Classes   
Node
    Implicit
Methods   
__init__
toxml
  __init__  
__init__ ( self,  val )

  toxml  
toxml ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/xmltools_Node.py.html0100600000176200017510000002537707306455642026066 0ustar dhellmanndevel Class: Node

Table of Contents

Class: Node Zope-2-CVS-src/lib/python/webdav/xmltools.py

Common base class for Node objects.

Base Classes   
Implicit
Methods   
__getitem__
addNode
attrs
elements
name
namespace
nodes
nskey
qname
strval
 toxml
value
  __getitem__  
__getitem__ ( self,  n )

  addNode  
addNode ( self,  node )

  attrs  
attrs ( self )

  elements  
elements (
        self,
        name=None,
        ns=None,
        lower=string.lower,
        )

  name  
name ( self )

  namespace  
namespace ( self )

  nodes  
nodes ( self )

  nskey  
nskey ( self )

  qname  
qname ( self )

  strval  
strval ( self )

  toxml  
toxml ( self )

  value  
value ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/xmltools_ProcInst.py.html0100600000176200017510000000761307306455642026733 0ustar dhellmanndevel Class: ProcInst

Table of Contents

Class: ProcInst Zope-2-CVS-src/lib/python/webdav/xmltools.py

Base Classes   
Node
    Implicit
Methods   
__init__
toxml
  __init__  
__init__ (
        self,
        name,
        val,
        )

  toxml  
toxml ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/xmltools_Text.py.html0100600000176200017510000000753507306455642026121 0ustar dhellmanndevel Class: Text

Table of Contents

Class: Text Zope-2-CVS-src/lib/python/webdav/xmltools.py

Base Classes   
Node
    Implicit
Methods   
__init__
toxml
  __init__  
__init__ ( self,  val )

  toxml  
toxml ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/webdav/xmltools_XmlParser.py.html0100600000176200017510000003255407306455642027111 0ustar dhellmanndevel Class: XmlParser

Table of Contents

Class: XmlParser Zope-2-CVS-src/lib/python/webdav/xmltools.py

Base Classes   
Shared.DC.xml.xmllib.XMLParser
Methods   
__init__
add
handle_cdata
handle_comment
handle_data
handle_doctype
handle_entity
handle_proc
handle_xml
parse
 pop
push
unknown_endtag
unknown_entityref
unknown_starttag
  __init__  
__init__ ( self )

  add  
add ( self,  node )

  handle_cdata  
handle_cdata ( self,  data )

  handle_comment  
handle_comment ( self,  data )

  handle_data  
handle_data ( self,  data )

  handle_doctype  
handle_doctype (
        self,
        tag,
        pubid,
        syslit,
        data,
        )

  handle_entity  
handle_entity (
        self,
        name,
        strval,
        pubid,
        syslit,
        ndata,
        )

  handle_proc  
handle_proc (
        self,
        name,
        data,
        )

  handle_xml  
handle_xml (
        self,
        encoding,
        stdalone,
        )

  parse  
parse ( self,  data )

  pop  
pop ( self )

  push  
push ( self,  node )

  unknown_endtag  
unknown_endtag ( self,  name )

  unknown_entityref  
unknown_entityref ( self,  data )

  unknown_starttag  
unknown_starttag (
        self,
        name,
        attrs,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:44:13 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Globals.py.html0100600000176200017510000000526207306455643023343 0ustar dhellmanndevel Module: Globals

Table of Contents

Module: Globals Zope-2-CVS-src/lib/python/Globals.py

Global definitions

Imported modules   
import Acquisition
from App.Common import package_home, attrget, Dictionary
from App.Dialogs import MessageDialog
from App.FindHomes import INSTANCE_HOME, SOFTWARE_HOME
from App.ImageFile import ImageFile
import App.PersistentExtra
from App.class_init import default__class_init__, ApplicationDefaultPermissions
from App.special_dtml import HTML, HTMLFile, DTMLFile
import ComputedAttribute
from DateTime import DateTime
from Persistence import Persistent, PersistentMapping
import TreeDisplay
import os
import string

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ImageFile.py.html0100600000176200017510000000357507306455643023607 0ustar dhellmanndevel Module: ImageFile

Table of Contents

Module: ImageFile Zope-2-CVS-src/lib/python/ImageFile.py

Image object that is stored in a file

Imported modules   
from App.ImageFile import ImageFile

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/LOG.py.html0100600000176200017510000000357007306455643022401 0ustar dhellmanndevel Module: LOG

Table of Contents

Module: LOG Zope-2-CVS-src/lib/python/LOG.py

Imported modules   
from zLOG import *

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Main.py.html0100600000176200017510000000512607306455643022643 0ustar dhellmanndevel Module: Main

Table of Contents

Module: Main Zope-2-CVS-src/lib/python/Main.py

Provide a Main application for the Zope framework

The Job of this module is to:

  • Configure and open the database

  • Establish the top-level object for ZPublisher

  • Perform very high-level configuration tasks

Imported modules   
from BoboPOS import SimpleDB, TJar, SingleThreadedTransaction
import BoboPOS.PickleJar
import Globals
import OFS.Application
import OFS.Uninstalled
import os
import string
import sys

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/Persistence.py.html0100600000176200017510000000275007306455643024243 0ustar dhellmanndevel Module: Persistence

Table of Contents

Module: Persistence Zope-2-CVS-src/lib/python/Persistence.py

Provide access to Persistent and PersistentMapping

This avoids dependency on the database package name.

While obviously there is nothing in this module, the correct names are inserted by the __init__.py in ZODB, jumpstarting the process.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ThreadedAsync.py.html0100600000176200017510000001600107306455643024467 0ustar dhellmanndevel Module: ThreadedAsync

Table of Contents

Module: ThreadedAsync Zope-2-CVS-src/lib/python/ThreadedAsync.py

Manage the asyncore mainloop in a multi-threaded app

In a multi-threaded application, only a single thread runs the asyncore mainloop. This thread (the "mainloop thread") may not start the mainloop before another thread needs to perform an async action that requires it. As a result, other threads need to coordinate with the mainloop thread to find out whether the mainloop is running.

This module implements a callback mechanism that allows other threads to be notified when the mainloop starts. A thread calls register_loop_callback() to register interest. When the mainloop thread calls loop(), each registered callback will be called with the socket map as its first argument.

This module rebinds loop() in the asyncore module; i.e. once this module is imported, any client of the asyncore module will get ThreadedAsync.loop() when it calls asyncore.loop().

Imported modules   
import asyncore
import select
import thread
Functions   
_start_loop
_stop_loop
loop
register_loop_callback
  _start_loop  
_start_loop ( map )

  _stop_loop  
_stop_loop ()

  loop  
loop (
        timeout=30.0,
        use_poll=0,
        map=None,
        )

Invoke asyncore mainloop

This function functions like the regular asyncore.loop() function except that it also triggers ThreadedAsync callback functions before starting the loop.

  register_loop_callback  
register_loop_callback (
        callback,
        args=(),
        kw=None,
        )

Register callback function to be called when mainloop starts

The callable object callback will be invokved when the mainloop starts. If the mainloop is currently running, the callback will be invoked immediately.

The callback will be called with a single argument, the mainloop socket map, unless the optional args or kw arguments are used. args defines a tuple of extra arguments to pass after the socket map. kw defines a dictionary of keyword arguments.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/dcdb.py.html0100600000176200017510000001407407306455643022655 0ustar dhellmanndevel Module: dcdb

Table of Contents

Module: dcdb Zope-2-CVS-src/lib/python/dcdb.py

Functions   
debug
  debug  
debug ()

Zope Public License (ZPL) Version 1.0 -------------------------------------

Copyright (c) Digital Creations. All rights reserved.

This license has been certified as Open Source(tm).

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions in source code must retain the above copyright notice, this list of conditions, and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution.

  3. Digital Creations requests that attribution be given to Zope in any manner possible. Zope includes a "Powered by Zope" button that is installed by default. While it is not a license violation to remove this button, it is requested that the attribution remain. A significant investment has been put into Zope, and this effort will continue if the Zope community continues to grow. This is one way to assure that growth.

  4. All advertising materials and documentation mentioning features derived from or use of this software must display the following acknowledgement:

    "This product includes software developed by Digital Creations for use in the Z Object Publishing Environment (http://www.zope.org/)."

    In the event that the product being advertised includes an intact Zope distribution (with copyright and license included) then this clause is waived.

  5. Names associated with Zope or Digital Creations must not be used to endorse or promote products derived from this software without prior written permission from Digital Creations.

  6. Modified redistributions of any form whatsoever must retain the following acknowledgment:

    "This product includes software developed by Digital Creations for use in the Z Object Publishing Environment (http://www.zope.org/)."

    Intact (re-)distributions of any official Zope release do not require an external acknowledgement.

  7. Modifications are encouraged but must be packaged separately as patches to official Zope releases. Distributions that do not clearly separate the patches from the original work must be clearly labeled as unofficial distributions. Modifications which do not carry the name Zope may be packaged in any form, as long as they conform to all of the clauses above.

Disclaimer

THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DIGITAL CREATIONS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This software consists of contributions made by Digital Creations and many individuals on behalf of Digital Creations. Specific attributions are listed in the accompanying credits file.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/tempfile.py.html0100600000176200017510000001635407306455644023572 0ustar dhellmanndevel Module: tempfile

Table of Contents

Module: tempfile Zope-2-CVS-src/lib/python/tempfile.py

Temporary files and filenames. This is r1.27 of the Python MAIN CVS branch that we're placing in lib/python so it overrides the PYTHONPATH's tempfile to fix a tempfile race condition in the Python 1.5.2 tempfile module implementation.

Imported modules   
import os
Functions   
TemporaryFile
gettempdir
gettempprefix
mktemp
  TemporaryFile  
TemporaryFile (
        mode='w+b',
        bufsize=-1,
        suffix="",
        )

Create and return a temporary file (opened read-write by default).

  gettempdir  
gettempdir ()

Function to calculate the directory to use.

Exceptions   
IOError, msg
  gettempprefix  
gettempprefix ()

Function to calculate a prefix of the filename to use.

This incorporates the current process id on systems that support such a notion, so that concurrent processes don't generate the same prefix.

  mktemp  
mktemp ( suffix="" )

User-callable function to return a unique temporary file name.

Classes   
TemporaryFileWrapper

Temporary file wrapper

_ThreadSafeCounter

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/tempfile_TemporaryFileWrapper.py.html0100600000176200017510000001135107306455644027765 0ustar dhellmanndevel Class: TemporaryFileWrapper

Table of Contents

Class: TemporaryFileWrapper Zope-2-CVS-src/lib/python/tempfile.py

Temporary file wrapper

This class provides a wrapper around files opened for temporary use. In particular, it seeks to automatically remove the file when it is no longer needed.

Methods   
__del__
__getattr__
__init__
close
  __del__  
__del__ ( self )

  __getattr__  
__getattr__ ( self,  name )

  __init__  
__init__ (
        self,
        file,
        path,
        )

  close  
close ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/tempfile__ThreadSafeCounter.py.html0100600000176200017510000000634707306455644027360 0ustar dhellmanndevel Class: _ThreadSafeCounter

Table of Contents

Class: _ThreadSafeCounter Zope-2-CVS-src/lib/python/tempfile.py

Methods   
__init__
get_next
  __init__  
__init__ (
        self,
        mutex,
        initialvalue=0,
        )

  get_next  
get_next ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ts_regex.py.html0100600000176200017510000000562507306455644023604 0ustar dhellmanndevel Module: ts_regex

Table of Contents

Module: ts_regex Zope-2-CVS-src/lib/python/ts_regex.py

Provide a thread-safe interface to regex

Imported modules   
from regex import *
from regsub import split, sub, gsub, splitx, capwords
Classes   
compile
symcomp

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ts_regex_compile.py.html0100600000176200017510000002027207306455644025307 0ustar dhellmanndevel Class: compile

Table of Contents

Class: compile Zope-2-CVS-src/lib/python/ts_regex.py

Methods   
__init__
_init
match
match_group
match_regs
search
search_group
search_regs
  __init__  
__init__ ( self,  *args )

  _init  
_init ( self,  r )

  match  
match (
        self,
        string,
        pos=0,
        )

  match_group  
match_group (
        self,
        str,
        group,
        pos=0,
        )

Match a pattern against a string

If the string does not match the pattern, then None is returned, otherwise, the length of the match, as well as any specified group are returned.

  match_regs  
match_regs (
        self,
        str,
        pos=0,
        )

Match a pattern against a string

If the string does not match the pattern, then None is returned, otherwise, the regs attribute of the expression is returned.

  search  
search (
        self,
        string,
        pos=0,
        )

  search_group  
search_group (
        self,
        str,
        group,
        pos=0,
        )

Search a string for a pattern.

If the pattern was not found, then None is returned, otherwise, the location where the pattern was found, as well as any specified group are returned.

  search_regs  
search_regs (
        self,
        str,
        pos=0,
        )

Search a string for a pattern.

If the pattern was not found, then None is returned, otherwise, the regs attribute of the expression is returned.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/ts_regex_symcomp.py.html0100600000176200017510000000623707306455644025353 0ustar dhellmanndevel Class: symcomp

Table of Contents

Class: symcomp Zope-2-CVS-src/lib/python/ts_regex.py

Base Classes   
compile
Methods   
__init__
  __init__  
__init__ ( self,  *args )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/unittest.py.html0100600000176200017510000002561607306455645023646 0ustar dhellmanndevel Module: unittest

Table of Contents

Module: unittest Zope-2-CVS-src/lib/python/unittest.py

Python unit testing framework, based on Erich Gamma's JUnit and Kent Beck's Smalltalk testing framework.

Further information is available in the bundled documentation, and from

http://pyunit.sourceforge.net/

This module contains the core framework classes that form the basis of specific test cases and suites (TestCase, TestSuite etc.), and also a text-based utility class for running the tests and reporting the results (TextTestRunner).

Copyright (c) 1999, 2000, 2001 Steve Purcell This module is free software, and you may redistribute it and/or modify it under the same terms as Python itself, so long as this copyright message and disclaimer are retained in their original form.

IN NO EVENT SHALL THE AUTHOR BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

THE AUTHOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

Imported modules   
import os
import string
import sys
import time
import traceback
Functions   
createTestInstance
getTestCaseNames
makeSuite
  createTestInstance  
createTestInstance ( name,  module=None )

Finds tests by their name, optionally only within the given module.

Return the newly-constructed test, ready to run. If the name contains a : then the portion of the name after the colon is used to find a specific test case within the test case class named before the colon.

Examples: findTest(examples.listtests.suite) -- returns result of calling suite findTest(examples.listtests.ListTestCase:checkAppend) -- returns result of calling ListTestCase(checkAppend) findTest(examples.listtests.ListTestCase:check-) -- returns result of calling makeSuite(ListTestCase, prefix="check")

Exceptions   
TypeError, "object %s found with spec %s is not a test" %( test, name )
ValueError, "%s is not a callable object" % constructor
ValueError, "illegal test name: %s" % name
ValueError, "incomplete test name: %s" % name
ValueError, "prefix too short: %s" % name
  getTestCaseNames  
getTestCaseNames (
        testCaseClass,
        prefix,
        sortUsing=cmp,
        )

Extracts all the names of functions in the given test case class and its base classes that start with the given prefix. This is used by makeSuite().

  makeSuite  
makeSuite (
        testCaseClass,
        prefix='test',
        sortUsing=cmp,
        )

Returns a TestSuite instance built from all of the test functions in the given test case class whose names begin with the given prefix. The cases are sorted by their function names using the supplied comparison function, which defaults to cmp.

Classes   
FunctionTestCase

A test case that wraps a test function.

JUnitTextTestRunner

A test runner class that displays results in textual form.

TestCase

A class whose instances are single test cases.

TestProgram

A command-line program that runs a set of tests; this is primarily

TestResult

Holder for test result information.

TestSuite

A test suite is a composite test consisting of a number of TestCases.

VerboseTextTestRunner

A test runner class that displays results in textual form.

_JUnitTextTestResult

A test result class that can print formatted text results to a stream.

_VerboseTextTestResult

A test result class that can print formatted text results to a stream.

_WritelnDecorator

Used to decorate file-like objects with a handy writeln method

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/unittest_FunctionTestCase.py.html0100600000176200017510000002045107306455644027136 0ustar dhellmanndevel Class: FunctionTestCase

Table of Contents

Class: FunctionTestCase Zope-2-CVS-src/lib/python/unittest.py

A test case that wraps a test function.

This is useful for slipping pre-existing test functions into the PyUnit framework. Optionally, set-up and tidy-up functions can be supplied. As with TestCase, the tidy-up (tearDown) function will always be called if the set-up (setUp) function ran successfully.

Base Classes   
TestCase
Methods   
__init__
__repr__
__str__
id
runTest
setUp
shortDescription
tearDown
  __init__  
__init__ (
        self,
        testFunc,
        setUp=None,
        tearDown=None,
        description=None,
        )

  __repr__  
__repr__ ( self )

  __str__  
__str__ ( self )

  id  
id ( self )

  runTest  
runTest ( self )

  setUp  
setUp ( self )

  shortDescription  
shortDescription ( self )

  tearDown  
tearDown ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/unittest_JUnitTextTestRunner.py.html0100600000176200017510000000654507306455644027655 0ustar dhellmanndevel Class: JUnitTextTestRunner

Table of Contents

Class: JUnitTextTestRunner Zope-2-CVS-src/lib/python/unittest.py

A test runner class that displays results in textual form.

The display format approximates that of JUnit's textui test runner. This test runner may be removed in a future version of PyUnit.

Methods   
__init__
run
  __init__  
__init__ ( self,  stream=sys.stderr )

  run  
run ( self,  test )

Run the given test case or test suite.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/unittest_TestCase.py.html0100600000176200017510000004360007306455644025431 0ustar dhellmanndevel Class: TestCase

Table of Contents

Class: TestCase Zope-2-CVS-src/lib/python/unittest.py

A class whose instances are single test cases.

Test authors should subclass TestCase for their own tests. Construction and deconstruction of the test's environment (fixture) can be implemented by overriding the setUp and tearDown methods respectively.

By default, the test code itself should be placed in a method named runTest.

If the fixture may be used for many test cases, create as many test methods as are needed. When instantiating such a TestCase subclass, specify in the constructor arguments the name of the test method that the instance is to execute.

Methods   
__call__
__exc_info
__init__
__repr__
__str__
assertRaises
assert_
countTestCases
debug
defaultTestResult
 fail
failIf
id
run
setUp
shortDescription
tearDown
  __call__  
__call__ ( self,  result=None )

  __exc_info  
__exc_info ( self )

Return a version of sys.exc_info() with the traceback frame minimised; usually the top level of the traceback frame is not needed.

  __init__  
__init__ ( self,  methodName='runTest' )

Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.

Exceptions   
ValueError, "no such test method in %s: %s" %( self.__class__, methodName )
  __repr__  
__repr__ ( self )

  __str__  
__str__ ( self )

  assertRaises  
assertRaises (
        self,
        excClass,
        callableObj,
        *args,
        *kwargs,
        )

Assert that an exception of class excClass is thrown by callableObj when invoked with arguments args and keyword arguments kwargs. If a different type of exception is thrown, it will not be caught, and the test case will be deemed to have suffered an error, exactly as for an unexpected exception.

Exceptions   
AssertionError, excName
  assert_  
assert_ (
        self,
        expr,
        msg=None,
        )

Equivalent of built-in assert, but is not optimised out when __debug__ is false.

Exceptions   
AssertionError, msg
  countTestCases  
countTestCases ( self )

  debug  
debug ( self )

  defaultTestResult  
defaultTestResult ( self )

  fail  
fail ( self,  msg=None )

Fail immediately, with the given message.

Exceptions   
AssertionError, msg
  failIf  
failIf (
        self,
        expr,
        msg=None,
        )

Fail the test if the expression is true.

  id  
id ( self )

  run  
run ( self,  result=None )

  setUp  
setUp ( self )

Hook method for setting up the test fixture before exercising it.

  shortDescription  
shortDescription ( self )

Returns a one-line description of the test, or None if no description has been provided.

The default implementation of this method returns the first line of the specified test method's docstring.

  tearDown  
tearDown ( self )

Hook method for deconstructing the test fixture after testing it.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/unittest_TestProgram.py.html0100600000176200017510000001412707306455644026167 0ustar dhellmanndevel Class: TestProgram

Table of Contents

Class: TestProgram Zope-2-CVS-src/lib/python/unittest.py

A command-line program that runs a set of tests; this is primarily for making test modules conveniently executable.

Methods   
__init__
createTests
parseArgs
runTests
usageExit
  __init__  
__init__ (
        self,
        module='__main__',
        defaultTest=None,
        argv=None,
        testRunner=None,
        )

  createTests  
createTests ( self )

  parseArgs  
parseArgs ( self,  argv )

Exceptions   
getopt.error, "No default test is defined."
  runTests  
runTests ( self )

  usageExit  
usageExit ( self,  msg=None )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/unittest_TestResult.py.html0100600000176200017510000001741107306455644026035 0ustar dhellmanndevel Class: TestResult

Table of Contents

Class: TestResult Zope-2-CVS-src/lib/python/unittest.py

Holder for test result information.

Test results are automatically managed by the TestCase and TestSuite classes, and do not need to be explicitly manipulated by writers of tests.

Each instance holds the total number of tests run, and collections of failures and errors that occurred among those test runs. The collections contain tuples of (testcase, exceptioninfo), where exceptioninfo is a tuple of values as returned by sys.exc_info().

Methods   
__init__
__repr__
addError
addFailure
startTest
stop
stopTest
wasSuccessful
  __init__  
__init__ ( self )

  __repr__  
__repr__ ( self )

  addError  
addError (
        self,
        test,
        err,
        )

Called when an error has occurred

  addFailure  
addFailure (
        self,
        test,
        err,
        )

Called when a failure has occurred

  startTest  
startTest ( self,  test )

Called when the given test is about to be run

  stop  
stop ( self )

Indicates that the tests should be aborted

  stopTest  
stopTest ( self,  test )

Called when the given test has been run

  wasSuccessful  
wasSuccessful ( self )

Tells whether or not this result was a success

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/unittest_TestSuite.py.html0100600000176200017510000001720107306455644025645 0ustar dhellmanndevel Class: TestSuite

Table of Contents

Class: TestSuite Zope-2-CVS-src/lib/python/unittest.py

A test suite is a composite test consisting of a number of TestCases.

For use, create an instance of TestSuite, then add test case instances. When all tests have been added, the suite can be passed to a test runner, such as TextTestRunner. It will run the individual test cases in the order in which they were added, aggregating the results. When subclassing, do not forget to call the base class constructor.

Methods   
__call__
__init__
__repr__
addTest
addTests
countTestCases
debug
run
  __call__  
__call__ ( self,  result )

  __init__  
__init__ ( self,  tests=() )

  __repr__  
__repr__ ( self )

  addTest  
addTest ( self,  test )

  addTests  
addTests ( self,  tests )

  countTestCases  
countTestCases ( self )

  debug  
debug ( self )

  run  
run ( self,  result )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/unittest_VerboseTextTestRunner.py.html0100600000176200017510000000661207306455644030224 0ustar dhellmanndevel Class: VerboseTextTestRunner

Table of Contents

Class: VerboseTextTestRunner Zope-2-CVS-src/lib/python/unittest.py

A test runner class that displays results in textual form.

It prints out the names of tests as they are run, errors as they occur, and a summary of the results at the end of the test run.

Methods   
__init__
run
  __init__  
__init__ (
        self,
        stream=sys.stderr,
        descriptions=1,
        )

  run  
run ( self,  test )

Run the given test case or test suite.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/unittest__JUnitTextTestResult.py.html0100600000176200017510000002171507306455644030015 0ustar dhellmanndevel Class: _JUnitTextTestResult

Table of Contents

Class: _JUnitTextTestResult Zope-2-CVS-src/lib/python/unittest.py

A test result class that can print formatted text results to a stream.

Used by JUnitTextTestRunner.

Base Classes   
TestResult
Methods   
__init__
addError
addFailure
printErrors
printFailures
printHeader
printNumberedErrors
printResult
startTest
  __init__  
__init__ ( self,  stream )

  addError  
addError (
        self,
        test,
        error,
        )

  addFailure  
addFailure (
        self,
        test,
        error,
        )

  printErrors  
printErrors ( self )

  printFailures  
printFailures ( self )

  printHeader  
printHeader ( self )

  printNumberedErrors  
printNumberedErrors (
        self,
        errFlavour,
        errors,
        )

  printResult  
printResult ( self )

  startTest  
startTest ( self,  test )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/unittest__VerboseTextTestResult.py.html0100600000176200017510000001560207306455645030370 0ustar dhellmanndevel Class: _VerboseTextTestResult

Table of Contents

Class: _VerboseTextTestResult Zope-2-CVS-src/lib/python/unittest.py

A test result class that can print formatted text results to a stream.

Used by VerboseTextTestRunner.

Base Classes   
TestResult
Methods   
__init__
_printError
addError
addFailure
startTest
stopTest
  __init__  
__init__ (
        self,
        stream,
        descriptions,
        )

  _printError  
_printError (
        self,
        flavour,
        test,
        err,
        )

  addError  
addError (
        self,
        test,
        err,
        )

  addFailure  
addFailure (
        self,
        test,
        err,
        )

  startTest  
startTest ( self,  test )

  stopTest  
stopTest ( self,  test )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/unittest__WritelnDecorator.py.html0100600000176200017510000000764607306455645027357 0ustar dhellmanndevel Class: _WritelnDecorator

Table of Contents

Class: _WritelnDecorator Zope-2-CVS-src/lib/python/unittest.py

Used to decorate file-like objects with a handy writeln method

Methods   
__getattr__
__init__
writeln
  __getattr__  
__getattr__ ( self,  attr )

  __init__  
__init__ ( self,  stream )

  writeln  
writeln ( self,  *args )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/xmlrpclib.py.html0100600000176200017510000001723407306455645023760 0ustar dhellmanndevel Module: xmlrpclib

Table of Contents

Module: xmlrpclib Zope-2-CVS-src/lib/python/xmlrpclib.py

Imported modules   
from cgi import escape
import string
import time
from types import *
import urllib
import xmllib
Functions   
dumps
getparser
loads
  dumps  
dumps (
        params,
        methodname=None,
        methodresponse=None,
        )

convert a tuple or a fault object to an XML-RPC packet

  getparser  
getparser ()

  loads  
loads ( data )

Classes   
Binary
Boolean
DateTime
Error
Fault

indicates a XML-RPC fault package

Marshaller

Generate an XML-RPC params chunk from a Python data structure

ProtocolError

indicates an HTTP protocol error

ResponseError
Server

Represents a connection to an XML-RPC server

SlowParser

slow but safe standard parser, based on the XML parser in

Transport

Handles an HTTP transaction to an XML-RPC server

Unmarshaller
_Method

some magic to bind an XML-RPC method to an RPC server.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/xmlrpclib_Binary.py.html0100600000176200017510000000752107306455645025262 0ustar dhellmanndevel Class: Binary

Table of Contents

Class: Binary Zope-2-CVS-src/lib/python/xmlrpclib.py

Methods   
__init__
decode
encode
  __init__  
__init__ ( self,  data=None )

  decode  
decode ( self,  data )

  encode  
encode ( self,  out )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/xmlrpclib_Boolean.py.html0100600000176200017510000001230607306455645025412 0ustar dhellmanndevel Class: Boolean

Table of Contents

Class: Boolean Zope-2-CVS-src/lib/python/xmlrpclib.py

Methods   
__init__
__int__
__nonzero__
__repr__
encode
  __init__  
__init__ ( self,  value=0 )

  __int__  
__int__ ( self )

  __nonzero__  
__nonzero__ ( self )

  __repr__  
__repr__ ( self )

  encode  
encode ( self,  out )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/xmlrpclib_DateTime.py.html0100600000176200017510000001100707306455645025524 0ustar dhellmanndevel Class: DateTime

Table of Contents

Class: DateTime Zope-2-CVS-src/lib/python/xmlrpclib.py

Methods   
__init__
__repr__
decode
encode
  __init__  
__init__ ( self,  value=0 )

  __repr__  
__repr__ ( self )

  decode  
decode ( self,  data )

  encode  
encode ( self,  out )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/xmlrpclib_Error.py.html0100600000176200017510000000240207306455645025120 0ustar dhellmanndevel Class: Error

Table of Contents

Class: Error Zope-2-CVS-src/lib/python/xmlrpclib.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/xmlrpclib_Fault.py.html0100600000176200017510000000761007306455645025110 0ustar dhellmanndevel Class: Fault

Table of Contents

Class: Fault Zope-2-CVS-src/lib/python/xmlrpclib.py

indicates a XML-RPC fault package

Base Classes   
Error
Methods   
__init__
__repr__
  __init__  
__init__ (
        self,
        faultCode,
        faultString,
        **extra,
        )

  __repr__  
__repr__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/xmlrpclib_Marshaller.py.html0100600000176200017510000002571407306455645026134 0ustar dhellmanndevel Class: Marshaller

Table of Contents

Class: Marshaller Zope-2-CVS-src/lib/python/xmlrpclib.py

Generate an XML-RPC params chunk from a Python data structure

Methods   
__dump
__init__
container
dump_array
dump_double
dump_instance
dump_int
dump_string
dump_struct
dumps
  __dump  
__dump ( self,  value )

Exceptions   
TypeError, "cannot marshal %s objects" % type( value )
  __init__  
__init__ ( self )

  container  
container ( self,  value )

Exceptions   
TypeError, "cannot marshal recursive data structures"
  dump_array  
dump_array ( self,  value )

  dump_double  
dump_double ( self,  value )

  dump_instance  
dump_instance ( self,  value )

  dump_int  
dump_int ( self,  value )

  dump_string  
dump_string ( self,  value )

  dump_struct  
dump_struct ( self,  value )

Exceptions   
TypeError, "dictionary key must be string"
  dumps  
dumps ( self,  values )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/xmlrpclib_ProtocolError.py.html0100600000176200017510000000763507306455645026657 0ustar dhellmanndevel Class: ProtocolError

Table of Contents

Class: ProtocolError Zope-2-CVS-src/lib/python/xmlrpclib.py

indicates an HTTP protocol error

Base Classes   
Error
Methods   
__init__
__repr__
  __init__  
__init__ (
        self,
        url,
        errcode,
        errmsg,
        headers,
        )

  __repr__  
__repr__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/xmlrpclib_ResponseError.py.html0100600000176200017510000000370107306455645026642 0ustar dhellmanndevel Class: ResponseError

Table of Contents

Class: ResponseError Zope-2-CVS-src/lib/python/xmlrpclib.py

Base Classes   
Error

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/xmlrpclib_Server.py.html0100600000176200017510000001246407306455645025306 0ustar dhellmanndevel Class: Server

Table of Contents

Class: Server Zope-2-CVS-src/lib/python/xmlrpclib.py

Represents a connection to an XML-RPC server

Methods   
__getattr__
__init__
__repr__
__request
  __getattr__  
__getattr__ ( self,  name )

  __init__  
__init__ (
        self,
        uri,
        transport=None,
        )

establish a "logical" server connection

Exceptions   
IOError, "unsupported XML-RPC protocol"
  __repr__  
__repr__ ( self )

  __request  
__request (
        self,
        methodname,
        params,
        )

call a method on the remote server

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/xmlrpclib_SlowParser.py.html0100600000176200017510000000626507306455645026143 0ustar dhellmanndevel Class: SlowParser

Table of Contents

Class: SlowParser Zope-2-CVS-src/lib/python/xmlrpclib.py

slow but safe standard parser, based on the XML parser in Python's standard library

Base Classes   
xmllib.XMLParser
Methods   
__init__
  __init__  
__init__ ( self,  target )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/xmlrpclib_Transport.py.html0100600000176200017510000000766207306455645026040 0ustar dhellmanndevel Class: Transport

Table of Contents

Class: Transport Zope-2-CVS-src/lib/python/xmlrpclib.py

Handles an HTTP transaction to an XML-RPC server

Methods   
parse_response
request
  parse_response  
parse_response ( self,  f )

read response from input file, and parse it

  request  
request (
        self,
        host,
        handler,
        request_body,
        )

issue XML-RPC request

Exceptions   
ProtocolError( host + handler, errcode, errmsg, headers )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/xmlrpclib_Unmarshaller.py.html0100600000176200017510000003744107306455645026477 0ustar dhellmanndevel Class: Unmarshaller

Table of Contents

Class: Unmarshaller Zope-2-CVS-src/lib/python/xmlrpclib.py

Methods   
__init__
close
data
end
end_array
end_base64
end_boolean
end_dateTime
end_double
end_fault
 end_int
end_methodName
end_params
end_string
end_struct
end_value
getmethodname
start
  __init__  
__init__ ( self )

  close  
close ( self )

Exceptions   
ResponseError()
apply(Fault, (), self._stack [ 0 ] )
  data  
data ( self,  text )

  end  
end ( self,  tag )

  end_array  
end_array ( self )

  end_base64  
end_base64 ( self,  join=string.join )

  end_boolean  
end_boolean ( self,  join=string.join )

Exceptions   
TypeError, "bad boolean value"
  end_dateTime  
end_dateTime ( self,  join=string.join )

  end_double  
end_double ( self,  join=string.join )

  end_fault  
end_fault ( self )

  end_int  
end_int ( self,  join=string.join )

  end_methodName  
end_methodName ( self,  join=string.join )

  end_params  
end_params ( self )

  end_string  
end_string ( self,  join=string.join )

  end_struct  
end_struct ( self )

  end_value  
end_value ( self )

  getmethodname  
getmethodname ( self )

  start  
start (
        self,
        tag,
        attrs,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/xmlrpclib__Method.py.html0100600000176200017510000000775107306455645025422 0ustar dhellmanndevel Class: _Method

Table of Contents

Class: _Method Zope-2-CVS-src/lib/python/xmlrpclib.py

some magic to bind an XML-RPC method to an RPC server. supports "nested" methods (e.g. examples.getStateName)

Methods   
__call__
__getattr__
__init__
  __call__  
__call__ ( self,  *args )

  __getattr__  
__getattr__ ( self,  name )

  __init__  
__init__ (
        self,
        send,
        name,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/zLOG.py.html0100600000176200017510000002762707306455645022606 0ustar dhellmanndevel Module: zLOG

Table of Contents

Module: zLOG Zope-2-CVS-src/lib/python/zLOG.py

General logging facility

This module attempts to provide a simple programming API for logging with a pluggable API for defining where log messages should go.

Programmers call the LOG function to log information.

The LOG function, in turn, calls the write_log method to actually write logging information somewhere. This module provides a very simple write_log implementation. It is intended that applications main programs will replace this method with a method more suited to their needs.

The module provides a register_subsystem method that does nothing, but provides a hook that logging management systems could use to collect information about subsystems being used.

The module defines several standard severities:

TRACE=-300

Trace messages

DEBUG=-200

Debugging messages

BLATHER=-100

Somebody shut this app up.

INFO=0

For things like startup and shutdown.

PROBLEM=100

This isn't causing any immediate problems, but deserves attention.

WARNING=100

A wishy-washy alias for PROBLEM.

ERROR=200

This is going to have adverse effects.

PANIC=300

We're dead!

Also, looging facilities will normally ignore negative severities.

To plug in a log handler, simply replace the log_write function with a callable object that takes 5 arguments:

subsystem

The subsystem generating the message (e.g. ZODB)

severity

The "severity" of the event. This may be an integer or a floating point number. Logging back ends may consider the int() of this valua to be significant. For example, a backend may consider any severity whos integer value is WARNING to be a warning.

summary

A short summary of the event

detail

A detailed description

error

A three-element tuple consisting of an error type, value, and traceback. If provided, then a summary of the error is added to the detail.

The callable object can provide a reinitialize method that may be called with no arguments to reopen the log files (if any) as part of a log-rotation facility.

There is a default stupid logging facility that:

  • swallows logging information by default,

  • outputs to sys.stderr if the environment variable STUPID_LOG_FILE is set to an empty string, and

  • outputs to file if the environment variable STUPID_LOG_FILE is set to a file name.

  • Ignores errors that have a severity < 0 by default. This can be overridden with the environment variable STUPID_LOG_SEVERITY

Imported modules   
import string
import sys
import time
Functions   
LOG
format_exception
log_time
register_subsystem
severity_string
  LOG  
LOG (
        subsystem,
        severity,
        summary,
        detail='',
        error=None,
        reraise=None,
        )

Log some information

The required arguments are:

subsystem

The subsystem generating the message (e.g. ZODB)

severity

The "severity" of the event. This may be an integer or a floating point number. Logging back ends may consider the int() of this valua to be significant. For example, a backend may consider any severity whos integer value is WARNING to be a warning.

summary

A short summary of the event

detail

A detailed description

error

A three-element tuple consisting of an error type, value, and traceback. If provided, then a summary of the error is added to the detail.

reraise

If provided with a true value, then the error given by error is reraised.

Exceptions   
error [ 0 ], error [ 1 ], error [ 2 ]
  format_exception  
format_exception (
        etype,
        value,
        tb,
        limit=None,
        delimiter='\n',
        header='',
        trailer='',
        )

  log_time  
log_time ()

Return a simple time string without spaces suitable for logging

  register_subsystem  
register_subsystem ( subsystem )

Register a subsystem name

A logging facility might replace this function to collect information about subsystems used in an application.

  severity_string  
severity_string ( severity,  mapping={ -300 : 'TRACE', -200 : 'DEBUG', -100 : 'BLATHER', 0 : 'INFO', 100 : 'PROBLEM', 200 : 'ERROR', 300 : 'PANIC', } )

Convert a severity code to a string

Classes   
stupid_log_write

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/zLOG_stupid_log_write.py.html0100600000176200017510000000644107306455645026240 0ustar dhellmanndevel Class: stupid_log_write

Table of Contents

Class: stupid_log_write Zope-2-CVS-src/lib/python/zLOG.py

Methods   
__call__
reinitialize
  __call__  
__call__ (
        self,
        subsystem,
        severity,
        summary,
        detail,
        error,
        )

  reinitialize  
reinitialize ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/zdaemon.py.html0100600000176200017510000002045707306455645023422 0ustar dhellmanndevel Module: zdaemon

Table of Contents

Module: zdaemon Zope-2-CVS-src/lib/python/zdaemon.py

zinit, slightly smarter server manager and ZServer startup script.

zinit will:

  • Fork a parent and a child

  • restart the child if it dies

  • write a pid file so you can kill (the parent)

  • reports the childs pid to stdout so you can kill that too

TODO

  • Have the parent reap the children when it dies

  • etc.

Imported modules   
import os
import posix
import signal
import sys
import time
import zLOG
Functions   
forkit
heartbeat
main
pstamp
run
  forkit  
forkit ( attempts=FORK_ATTEMPTS )

  heartbeat  
heartbeat ()

  main  
main ()

  pstamp  
pstamp ( message,  sev )

this is a bit of a hack so I dont have to change too much code

  run  
run ( argv,  pidfile='' )

Exceptions   
ForkError
KidDiedOnMeError
Classes   
ExecError
ForkError
KidDiedOnMeError

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/zdaemon_ExecError.py.html0100600000176200017510000000362507306455645025376 0ustar dhellmanndevel Class: ExecError

Table of Contents

Class: ExecError Zope-2-CVS-src/lib/python/zdaemon.py

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/zdaemon_ForkError.py.html0100600000176200017510000000362507306455645025413 0ustar dhellmanndevel Class: ForkError

Table of Contents

Class: ForkError Zope-2-CVS-src/lib/python/zdaemon.py

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/python/zdaemon_KidDiedOnMeError.py.html0100600000176200017510000000364307306455645026566 0ustar dhellmanndevel Class: KidDiedOnMeError

Table of Contents

Class: KidDiedOnMeError Zope-2-CVS-src/lib/python/zdaemon.py

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/0040700000176200017510000000000007306455643021243 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/0040700000176200017510000000000007306455645024207 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/Xaq.py.html0100600000176200017510000000355707306455643026264 0ustar dhellmanndevel Module: Xaq

Table of Contents

Module: Xaq Zope-2-CVS-src/lib/Components/ExtensionClass/Xaq.py

Imported modules   
import Acquisition

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/0040700000176200017510000000000007306455644025165 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/regrtest.py.html0100600000176200017510000000407507306455643030345 0ustar dhellmanndevel Module: regrtest

Table of Contents

Module: regrtest Zope-2-CVS-src/lib/Components/ExtensionClass/test/regrtest.py

Imported modules   
import os
import sys
import test.regrtest

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_AqAlg.py.html0100600000176200017510000001360707306455644030534 0ustar dhellmanndevel Module: test_AqAlg

Table of Contents

Module: test_AqAlg Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_AqAlg.py

Imported modules   
import Acquisition
import sys
Functions   
main
pretty
show
uid
  main  
main ()

  pretty  
pretty ( self,  indent=0 )

  show  
show ( s,  globals=globals() )

  uid  
uid ( obj,  uids={} )

Classes   
I

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_AqAlg_I.py.html0100600000176200017510000000751507306455644031005 0ustar dhellmanndevel Class: I

Table of Contents

Class: I Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_AqAlg.py

Base Classes   
Acquisition.Implicit
Methods   
__init__
__str__
  __init__  
__init__ ( self,  name )

  __str__  
__str__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_MultiMapping.py.html0100600000176200017510000000366307306455644032156 0ustar dhellmanndevel Module: test_MultiMapping

Table of Contents

Module: test_MultiMapping Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_MultiMapping.py

Imported modules   
from MultiMapping import *

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_Sync.py.html0100600000176200017510000001154007306455644030455 0ustar dhellmanndevel Module: test_Sync

Table of Contents

Module: test_Sync Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_Sync.py

Imported modules   
from Sync import Synchronized
from random import random
import thread
from time import sleep
Functions   
test
thread_finished
  test  
test ()

  thread_finished  
thread_finished ( lock=thread.allocate_lock() )

Classes   
P

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_Sync_P.py.html0100600000176200017510000001077207306455644030742 0ustar dhellmanndevel Class: P

Table of Contents

Class: P Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_Sync.py

Base Classes   
Synchronized
Methods   
__init__
inc
incn
  __init__  
__init__ (
        self,
        *args,
        *kw,
        )

  inc  
inc ( self )

  incn  
incn ( self,  n )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_ThreadLock.py.html0100600000176200017510000001162707306455644031567 0ustar dhellmanndevel Module: test_ThreadLock

Table of Contents

Module: test_ThreadLock Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_ThreadLock.py

Imported modules   
from ExtensionClass import Base
import ThreadLock
from random import random
import thread
from time import sleep
Functions   
test
thread_finished
  test  
test ()

  thread_finished  
thread_finished ( lock=thread.allocate_lock() )

Classes   
P

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_ThreadLock_P.py.html0100600000176200017510000001242307306455644032041 0ustar dhellmanndevel Class: P

Table of Contents

Class: P Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_ThreadLock.py

Base Classes   
Base
Methods   
__init__
__oldcall_method__
inc
incn
  __init__  
__init__ (
        self,
        *args,
        *kw,
        )

  __oldcall_method__  
__oldcall_method__ (
        self,
        f,
        a,
        k={},
        )

  inc  
inc ( self )

  incn  
incn ( self,  n )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_acquisition.py.html0100600000176200017510000000543507306455644032077 0ustar dhellmanndevel Module: test_acquisition

Table of Contents

Module: test_acquisition Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_acquisition.py

Imported modules   
import Acquisition
from ExtensionClass import Base
Classes   
A
B

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_acquisition_A.py.html0100600000176200017510000000617707306455644032343 0ustar dhellmanndevel Class: A

Table of Contents

Class: A Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_acquisition.py

Base Classes   
Acquisition.Implicit
Methods   
hi
  hi  
hi ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_acquisition_B.py.html0100600000176200017510000000365507306455644032342 0ustar dhellmanndevel Class: B

Table of Contents

Class: B Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_acquisition.py

Base Classes   
Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_add.py.html0100600000176200017510000000514607306455644030276 0ustar dhellmanndevel Module: test_add

Table of Contents

Module: test_add Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_add.py

Imported modules   
from ExtensionClass import *
Classes   
foo

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_add_foo.py.html0100600000176200017510000000621407306455644031136 0ustar dhellmanndevel Class: foo

Table of Contents

Class: foo Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_add.py

Base Classes   
Base
Methods   
__add__
  __add__  
__add__ ( self,  other )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_binding.py.html0100600000176200017510000000544507306455644031162 0ustar dhellmanndevel Module: test_binding

Table of Contents

Module: test_binding Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_binding.py

Imported modules   
from ExtensionClass import Base
from MethodObject import Method
Classes   
bar
foo

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_binding_bar.py.html0100600000176200017510000000621507306455644032002 0ustar dhellmanndevel Class: bar

Table of Contents

Class: bar Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_binding.py

Base Classes   
Base
Methods   
__repr__
  __repr__  
__repr__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_binding_foo.py.html0100600000176200017510000000631007306455644032015 0ustar dhellmanndevel Class: foo

Table of Contents

Class: foo Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_binding.py

Base Classes   
Method
Methods   
__call__
  __call__  
__call__ (
        self,
        ob,
        *args,
        *kw,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000014700000000000011567 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_explicit_acquisition.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_explicit_acquisition.py.h0100600000176200017510000000551207306455644033257 0ustar dhellmanndevel Module: test_explicit_acquisition

Table of Contents

Module: test_explicit_acquisition Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_explicit_acquisition.py

Imported modules   
import Acquisition
from ExtensionClass import Base
Classes   
A
B

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_explicit_acquisition_A.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_explicit_acquisition_A.py0100600000176200017510000000621007306455644033265 0ustar dhellmanndevel Class: A

Table of Contents

Class: A Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_explicit_acquisition.py

Base Classes   
Acquisition.Explicit
Methods   
hi
  hi  
hi ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015100000000000011562 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_explicit_acquisition_B.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_explicit_acquisition_B.py0100600000176200017510000000366607306455644033302 0ustar dhellmanndevel Class: B

Table of Contents

Class: B Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_explicit_acquisition.py

Base Classes   
Base

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_method_hook.py.html0100600000176200017510000000516407306455644032046 0ustar dhellmanndevel Module: test_method_hook

Table of Contents

Module: test_method_hook Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_method_hook.py

Imported modules   
import ExtensionClass
Classes   
C

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_method_hook_C.py.html0100600000176200017510000000767607306455644032322 0ustar dhellmanndevel Class: C

Table of Contents

Class: C Zope-2-CVS-src/lib/Components/ExtensionClass/test/test_method_hook.py

Base Classes   
ExtensionClass.Base
Methods   
__call_method__
hi
  __call_method__  
__call_method__ (
        self,
        meth,
        args,
        kw={},
        )

  hi  
hi (
        self,
        *args,
        *kw,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/setup.py.html0100600000176200017510000000645107306455644026670 0ustar dhellmanndevel Module: setup

Table of Contents

Module: setup Zope-2-CVS-src/lib/Components/ExtensionClass/setup.py

Support for Python classes implemented in C

A lightweight mechanism has been developed for making Python extension types more class-like. Classes can be developed in an extension language, such as C or C++, and these classes can be treated like other python classes:

  • They can be sub-classed in python,

  • They provide access to method documentation strings, and

  • They can be used to directly create new instances.

An example class shows how extension classes are implemented and how they differ from extension types.

Extension classes provide additional extensions to class and instance semantics, including:

  • A protocol for accessing subobjects "in the context of" their containers. This is used to implement custom method types and environmental acquisition.

  • A protocol for overriding method call semantics. This is used to implement "synchonized" classes and could be used to implement argument type checking.

  • A protocol for class initialization that supports execution of a special __class_init__ method after a class has been initialized.

Extension classes illustrate how the Python class mechanism can be extended and may provide a basis for improved or specialized class models.

Imported modules   
from distutils.core import setup
from distutils.extension import Extension

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/ExtensionClass/README.html0100600000176200017510000000333607306455645026036 0ustar dhellmanndevel Zope2 CVS with ZEO

Table of Contents

Zope2 CVS with ZEO  

See the file doc/ExtensionClass.stx or doc/ExtensionClass.html for a description of extension class.

This version of ExtensionClass uses Python distutils for installation. It requires Python version 1.5.2 or higher. To build, test, and install, do the following:

% python setup.py build % PYTHONPATH=build/lib-PLAT-VER python test/regrtest.py % python setup.py install

The build directory is created setup.py during the build. The exact name of the build subdirectory depends on the platform you are using and the version of Python.

For more information, contact info@digicool.com

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/cPickle/0040700000176200017510000000000007306455643022615 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/lib/Components/cPickle/copy_reg.py.html0100600000176200017510000000772307306455643025751 0ustar dhellmanndevel Module: copy_reg

Table of Contents

Module: copy_reg Zope-2-CVS-src/lib/Components/cPickle/copy_reg.py

Functions   
constructor
pickle
pickle_complex
  constructor  
constructor ( object )

  pickle  
pickle (
        ob_type,
        pickle_function,
        constructor_ob=None,
        )

  pickle_complex  
pickle_complex ( c )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/0040700000176200017510000000000007306455640017745 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/index.html0100600000176200017510000001034207306455640021741 0ustar dhellmanndevel Zope2 CVS with ZEO: ZServer

Table of Contents

Zope2 CVS with ZEO: ZServer  
Modules and Packages   

Zope-2-CVS-src/ZServer/

README.txt.html

ZServer README --------------

DebugLogger
FCGIServer

ZServer/Medusa FastCGI server, by Robin Dunn.

FTPRequest

FTP Request class for FTP server.

FTPResponse

Response class for the FTP Server.

FTPServer

ZServer FTP Channel for use the medusa's ftp server.

HTTPResponse

ZServer HTTPResponse

HTTPServer

Medusa HTTP server for Zope

PCGIServer

Medusa PCGI server.

Producers

ZServer pipe utils. These producers basically function as callbacks.

PubCore

Zope2 CVS with ZEO: ZServer.PubCore

WebDAVSrcHandler

Special HTTP handler which forces GET requests to return the "source"

ZService

ZServer as a NT service.

__init__
medusa

Zope2 CVS with ZEO: ZServer.medusa

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/PubCore/0040700000176200017510000000000007306455632021305 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/PubCore/index.html0100600000176200017510000000456507306455632023313 0ustar dhellmanndevel Zope2 CVS with ZEO: ZServer.PubCore

Table of Contents

Zope2 CVS with ZEO: ZServer.PubCore  
Modules and Packages   

Zope-2-CVS-src/ZServer/PubCore/

ZEvent

Simple Event Manager Based on Pipes

ZRendezvous
ZServerPublisher
__init__

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/PubCore/ZEvent.py.html0100600000176200017510000000361507306455632024041 0ustar dhellmanndevel Module: ZEvent

Table of Contents

Module: ZEvent Zope-2-CVS-src/ZServer/PubCore/ZEvent.py

Simple Event Manager Based on Pipes

Imported modules   
from ZServer.medusa.thread.select_trigger import trigger

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/PubCore/ZRendezvous.py.html0100600000176200017510000000546107306455632025125 0ustar dhellmanndevel Module: ZRendezvous

Table of Contents

Module: ZRendezvous Zope-2-CVS-src/ZServer/PubCore/ZRendezvous.py

Imported modules   
from ZServerPublisher import ZServerPublisher
import thread
Classes   
ZRendevous

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/PubCore/ZRendezvous_ZRendevous.py.html0100600000176200017510000000761707306455632027316 0ustar dhellmanndevel Class: ZRendevous

Table of Contents

Class: ZRendevous Zope-2-CVS-src/ZServer/PubCore/ZRendezvous.py

Methods   
__init__
accept
handle
  __init__  
__init__ ( self,  n=1 )

  accept  
accept ( self )

  handle  
handle (
        self,
        name,
        request,
        response,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/PubCore/ZServerPublisher.py.html0100600000176200017510000000521207306455632026077 0ustar dhellmanndevel Module: ZServerPublisher

Table of Contents

Module: ZServerPublisher Zope-2-CVS-src/ZServer/PubCore/ZServerPublisher.py

Imported modules   
from ZPublisher import publish_module
Classes   
ZServerPublisher

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/PubCore/ZServerPublisher_ZServerPublisher.py.html0100600000176200017510000000501507306455632031436 0ustar dhellmanndevel Class: ZServerPublisher

Table of Contents

Class: ZServerPublisher Zope-2-CVS-src/ZServer/PubCore/ZServerPublisher.py

Methods   
__init__
  __init__  
__init__ ( self,  accept )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/PubCore/__init__.py.html0100600000176200017510000000752007306455632024364 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/ZServer/PubCore/__init__.py

Imported modules   
import ZRendezvous
Functions   
handle
setNumberOfThreads
  handle  
handle ( *args,  *kw )

  setNumberOfThreads  
setNumberOfThreads ( n )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/0040700000176200017510000000000007306455637021231 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/index.html0100600000176200017510000002063507306455637023233 0ustar dhellmanndevel Zope2 CVS with ZEO: ZServer.medusa

Table of Contents

Zope2 CVS with ZEO: ZServer.medusa  
Modules and Packages   

Zope-2-CVS-src/ZServer/medusa/

ANNOUNCE.txt.html

-----BEGIN PGP SIGNED MESSAGE-----

ANNOUNCE_970922.txt.html

This is a major update of Medusa. Almost everything has been rewritten; the web server has been rewritten from scratch twice. [ain't Python nice. 8^) ]

__init__
auth_handler
chat_server
continuation
counter
default_handler
event_loop
fifo
filesys
ftp_server
http_bobo
http_date
http_server
logger
m_syslog

socket interface to unix syslog.

medusa_gif
mime_type_table
monitor
monitor_client
monitor_client_win32
producers

A collection of producers.

put_handler
redirecting_handler
resolver
rpc_client
rpc_server
script_handler
start_medusa
status_handler
test

Zope2 CVS with ZEO: ZServer.medusa.test

thread

Zope2 CVS with ZEO: ZServer.medusa.thread

unix_user_handler
virtual_handler
xmlrpc_handler

Zope-2-CVS-src/ZServer/medusa/contrib/

bobo_handler

Bobo handler module

sample_cgi

Zope-2-CVS-src/ZServer/medusa/demo/

publish

Zope-2-CVS-src/ZServer/medusa/misc/

async_mysql
recorder
syncsock

Zope-2-CVS-src/ZServer/medusa/script_handler_demo/

persistent
start_demo

Zope-2-CVS-src/ZServer/medusa/sendfile/

asynchat_sendfile
test_sendfile

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/0040700000176200017510000000000007306455633022204 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/index.html0100600000176200017510000000531207306455633024201 0ustar dhellmanndevel Zope2 CVS with ZEO: ZServer.medusa.test

Table of Contents

Zope2 CVS with ZEO: ZServer.medusa.test  
Modules and Packages   

Zope-2-CVS-src/ZServer/medusa/test/

__init__
asyn_http_bench
max_sockets
test_11
test_lb
test_medusa
test_single_11

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/__init__.py.html0100600000176200017510000000243007306455633025256 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/ZServer/medusa/test/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/asyn_http_bench.py.html0100600000176200017510000001225007306455633026670 0ustar dhellmanndevel Module: asyn_http_bench

Table of Contents

Module: asyn_http_bench Zope-2-CVS-src/ZServer/medusa/test/asyn_http_bench.py

Imported modules   
import asyncore
from asyncore import socket_map, poll
import socket
import string
import sys
import time
Functions   
blurt
loop
  blurt  
blurt ( thing )

  loop  
loop ( timeout=30.0 )

Classes   
http_client
timer

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/asyn_http_bench_http_client.py.html0100600000176200017510000001400107306455633031261 0ustar dhellmanndevel Class: http_client

Table of Contents

Class: http_client Zope-2-CVS-src/ZServer/medusa/test/asyn_http_bench.py

Base Classes   
asyncore.dispatcher_with_send
Methods   
__init__
handle_close
handle_connect
handle_read
log
  __init__  
__init__ (
        self,
        host='127.0.0.1',
        port=80,
        uri='/',
        num=10,
        )

  handle_close  
handle_close ( self )

  handle_connect  
handle_connect ( self )

  handle_read  
handle_read ( self )

  log  
log ( self,  *info )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/asyn_http_bench_timer.py.html0100600000176200017510000000622207306455633030072 0ustar dhellmanndevel Class: timer

Table of Contents

Class: timer Zope-2-CVS-src/ZServer/medusa/test/asyn_http_bench.py

Methods   
__init__
end
  __init__  
__init__ ( self )

  end  
end ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/max_sockets.py.html0100600000176200017510000001135707306455633026047 0ustar dhellmanndevel Module: max_sockets

Table of Contents

Module: max_sockets Zope-2-CVS-src/ZServer/medusa/test/max_sockets.py

Imported modules   
import select
import socket
Functions   
max_client_sockets
max_select_sockets
max_server_sockets
  max_client_sockets  
max_client_sockets ()

  max_select_sockets  
max_select_sockets ()

  max_server_sockets  
max_server_sockets ()

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/test_11.py.html0100600000176200017510000001073207306455633025003 0ustar dhellmanndevel Module: test_11

Table of Contents

Module: test_11 Zope-2-CVS-src/ZServer/medusa/test/test_11.py

Imported modules   
import asynchat
import asyncore
import socket
import string
import time
Functions   
build_request_chain
  build_request_chain  
build_request_chain (
        num,
        host,
        request_size,
        )

Classes   
test_client
timer

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/test_11_test_client.py.html0100600000176200017510000001656507306455633027412 0ustar dhellmanndevel Class: test_client

Table of Contents

Class: test_client Zope-2-CVS-src/ZServer/medusa/test/test_11.py

Base Classes   
asynchat.async_chat
Methods   
__init__
close
collect_incoming_data
found_terminator
handle_connect
handle_expt
log
  __init__  
__init__ (
        self,
        addr,
        chain,
        )

  close  
close ( self )

  collect_incoming_data  
collect_incoming_data ( self,  data )

  found_terminator  
found_terminator ( self )

  handle_connect  
handle_connect ( self )

  handle_expt  
handle_expt ( self )

  log  
log ( self,  *args )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/test_11_timer.py.html0100600000176200017510000000621207306455633026201 0ustar dhellmanndevel Class: timer

Table of Contents

Class: timer Zope-2-CVS-src/ZServer/medusa/test/test_11.py

Methods   
__init__
end
  __init__  
__init__ ( self )

  end  
end ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/test_lb.py.html0100600000176200017510000000676107306455633025166 0ustar dhellmanndevel Module: test_lb

Table of Contents

Module: test_lb Zope-2-CVS-src/ZServer/medusa/test/test_lb.py

Imported modules   
import asynchat
import asyncore
import select
import socket
import sys
import time
Classes   
test_channel
test_client
test_server
timer

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/test_lb_test_channel.py.html0100600000176200017510000001400407306455633027702 0ustar dhellmanndevel Class: test_channel

Table of Contents

Class: test_channel Zope-2-CVS-src/ZServer/medusa/test/test_lb.py

Base Classes   
asynchat.async_chat
Methods   
__init__
collect_incoming_data
found_terminator
handle_close
log
  __init__  
__init__ (
        self,
        conn,
        addr,
        )

  collect_incoming_data  
collect_incoming_data ( self,  data )

  found_terminator  
found_terminator ( self )

  handle_close  
handle_close ( self )

  log  
log ( self,  *args )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/test_lb_test_client.py.html0100600000176200017510000001131007306455633027545 0ustar dhellmanndevel Class: test_client

Table of Contents

Class: test_client Zope-2-CVS-src/ZServer/medusa/test/test_lb.py

Base Classes   
test_channel
    asynchat.async_chat
Methods   
__init__
found_terminator
handle_connect
  __init__  
__init__ (
        self,
        addr,
        packet,
        number,
        )

  found_terminator  
found_terminator ( self )

  handle_connect  
handle_connect ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/test_lb_test_server.py.html0100600000176200017510000000754607306455633027615 0ustar dhellmanndevel Class: test_server

Table of Contents

Class: test_server Zope-2-CVS-src/ZServer/medusa/test/test_lb.py

Base Classes   
asyncore.dispatcher
Methods   
__init__
handle_accept
  __init__  
__init__ ( self,  addr )

  handle_accept  
handle_accept ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/test_lb_timer.py.html0100600000176200017510000000621207306455633026355 0ustar dhellmanndevel Class: timer

Table of Contents

Class: timer Zope-2-CVS-src/ZServer/medusa/test/test_lb.py

Methods   
__init__
end
  __init__  
__init__ ( self )

  end  
end ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/test_medusa.py.html0100600000176200017510000001276507306455633026050 0ustar dhellmanndevel Module: test_medusa

Table of Contents

Module: test_medusa Zope-2-CVS-src/ZServer/medusa/test/test_medusa.py

Imported modules   
import http_date
import socket
import string
import time
Functions   
get
test_cache
test_nocache
  get  
get (
        request,
        host='',
        port=80,
        )

  test_cache  
test_cache ( n=1000 )

  test_nocache  
test_nocache ( n=1000 )

Classes   
timer

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/test_medusa_timer.py.html0100600000176200017510000000621607306455633027242 0ustar dhellmanndevel Class: timer

Table of Contents

Class: timer Zope-2-CVS-src/ZServer/medusa/test/test_medusa.py

Methods   
__init__
end
  __init__  
__init__ ( self )

  end  
end ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/test_single_11.py.html0100600000176200017510000001025107306455633026340 0ustar dhellmanndevel Module: test_single_11

Table of Contents

Module: test_single_11 Zope-2-CVS-src/ZServer/medusa/test/test_single_11.py

Imported modules   
import socket
import string
import time
Functions   
build_request_chain
  build_request_chain  
build_request_chain (
        num,
        host,
        request_size,
        )

Classes   
timer

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/test/test_single_11_timer.py.html0100600000176200017510000000622107306455633027542 0ustar dhellmanndevel Class: timer

Table of Contents

Class: timer Zope-2-CVS-src/ZServer/medusa/test/test_single_11.py

Methods   
__init__
end
  __init__  
__init__ ( self )

  end  
end ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/thread/0040700000176200017510000000000007306455633022474 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/thread/index.html0100600000176200017510000000514307306455633024473 0ustar dhellmanndevel Zope2 CVS with ZEO: ZServer.medusa.thread

Table of Contents

Zope2 CVS with ZEO: ZServer.medusa.thread  
Modules and Packages   

Zope-2-CVS-src/ZServer/medusa/thread/

__init__
pi_module
select_trigger
test_module
thread_channel
thread_handler

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/thread/__init__.py.html0100600000176200017510000000243207306455633025550 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/ZServer/medusa/thread/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/thread/pi_module.py.html0100600000176200017510000001236407306455633025773 0ustar dhellmanndevel Module: pi_module

Table of Contents

Module: pi_module Zope-2-CVS-src/ZServer/medusa/thread/pi_module.py

Imported modules   
import string
Functions   
go
main
  go  
go ( file )

Exceptions   
StopException
  main  
main (
        env,
        stdin,
        stdout,
        )

Classes   
line_writer

partition the endless line into 80-character ones

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/thread/pi_module_line_writer.py.html0100600000176200017510000000635607306455633030402 0ustar dhellmanndevel Class: line_writer

Table of Contents

Class: line_writer Zope-2-CVS-src/ZServer/medusa/thread/pi_module.py

partition the endless line into 80-character ones

Methods   
__init__
write
  __init__  
__init__ (
        self,
        file,
        digit_limit=10000,
        )

  write  
write ( self,  data )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/thread/select_trigger.py.html0100600000176200017510000000627307306455633027022 0ustar dhellmanndevel Module: select_trigger

Table of Contents

Module: select_trigger Zope-2-CVS-src/ZServer/medusa/thread/select_trigger.py

Imported modules   
import asynchat
import asyncore
import os
import socket
import string
import thread
Classes   
trigger_file

A triggered file object

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/thread/select_trigger_trigger_file.py.html0100600000176200017510000001642507306455633031544 0ustar dhellmanndevel Class: trigger_file

Table of Contents

Class: trigger_file Zope-2-CVS-src/ZServer/medusa/thread/select_trigger.py

A triggered file object

Methods   
__init__
close
flush
softspace
trigger_close
write
writeline
writelines
  __init__  
__init__ ( self,  parent )

  close  
close ( self )

  flush  
flush ( self )

  softspace  
softspace ( self,  *args )

  trigger_close  
trigger_close ( self )

  write  
write ( self,  data )

  writeline  
writeline ( self,  line )

  writelines  
writelines ( self,  lines )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/thread/test_module.py.html0100600000176200017510000000630007306455633026333 0ustar dhellmanndevel Module: test_module

Table of Contents

Module: test_module Zope-2-CVS-src/ZServer/medusa/thread/test_module.py

Imported modules   
import pprint
Functions   
main
  main  
main (
        env,
        stdin,
        stdout,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/thread/thread_channel.py.html0100600000176200017510000000651607306455633026757 0ustar dhellmanndevel Module: thread_channel

Table of Contents

Module: thread_channel Zope-2-CVS-src/ZServer/medusa/thread/thread_channel.py

Imported modules   
import FCNTL
import asynchat
import asyncore
import fcntl
import os
import socket
import string
import thread
Classes   
thread_channel

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/thread/thread_channel_thread_channel.py.html0100600000176200017510000001520107306455633031765 0ustar dhellmanndevel Class: thread_channel

Table of Contents

Class: thread_channel Zope-2-CVS-src/ZServer/medusa/thread/thread_channel.py

Base Classes   
asyncore.file_dispatcher
Methods   
__init__
handle_close
handle_read
readable
start
writable
  __init__  
__init__ (
        self,
        channel,
        function,
        *args,
        )

  handle_close  
handle_close ( self )

  handle_read  
handle_read ( self )

  readable  
readable ( self )

  start  
start ( self )

  writable  
writable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/thread/thread_handler.py.html0100600000176200017510000001032607306455633026756 0ustar dhellmanndevel Module: thread_handler

Table of Contents

Module: thread_handler Zope-2-CVS-src/ZServer/medusa/thread/thread_handler.py

Imported modules   
import StringIO
import counter
from default_handler import split_path, unquote, get_header
import fifo
import os
import producers
import re
import select_trigger
import string
import sys
import threading
import time
Classes   
collector

gathers input for PUT requests

header_scanning_file
request_loop_thread
request_queue
script_handler
thread_output_file

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/thread/thread_handler_collector.py.html0100600000176200017510000000646207306455633031032 0ustar dhellmanndevel Class: collector

Table of Contents

Class: collector Zope-2-CVS-src/ZServer/medusa/thread/thread_handler.py

gathers input for PUT requests

Methods   
__init__
collect_incoming_data
  __init__  
__init__ (
        self,
        handler,
        request,
        env,
        )

  collect_incoming_data  
collect_incoming_data ( self,  data )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/thread/thread_handler_header_scanning_file.py.html0100600000176200017510000001520207306455633033143 0ustar dhellmanndevel Class: header_scanning_file

Table of Contents

Class: header_scanning_file Zope-2-CVS-src/ZServer/medusa/thread/thread_handler.py

Methods   
__init__
_write
build_header
close
flush
write
writelines
  __init__  
__init__ (
        self,
        request,
        file,
        )

  _write  
_write ( self,  data )

  build_header  
build_header ( self,  lines )

  close  
close ( self )

  flush  
flush ( self )

  write  
write ( self,  data )

  writelines  
writelines ( self,  list )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/thread/thread_handler_request_loop_thread.py.html0100600000176200017510000000751307306455633033112 0ustar dhellmanndevel Class: request_loop_thread

Table of Contents

Class: request_loop_thread Zope-2-CVS-src/ZServer/medusa/thread/thread_handler.py

Base Classes   
threading.Thread
Methods   
__init__
run
  __init__  
__init__ ( self,  queue )

  run  
run ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/thread/thread_handler_request_queue.py.html0100600000176200017510000000750507306455633031737 0ustar dhellmanndevel Class: request_queue

Table of Contents

Class: request_queue Zope-2-CVS-src/ZServer/medusa/thread/thread_handler.py

Methods   
__init__
get
put
  __init__  
__init__ ( self )

  get  
get ( self )

  put  
put ( self,  item )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/thread/thread_handler_script_handler.py.html0100600000176200017510000001274207306455633032043 0ustar dhellmanndevel Class: script_handler

Table of Contents

Class: script_handler Zope-2-CVS-src/ZServer/medusa/thread/thread_handler.py

Methods   
__init__
add_module
continue_request
handle_request
match
  __init__  
__init__ (
        self,
        queue,
        document_root="",
        )

  add_module  
add_module (
        self,
        module,
        *names,
        )

  continue_request  
continue_request (
        self,
        stdin,
        request,
        env,
        )

  handle_request  
handle_request ( self,  request )

  match  
match ( self,  request )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/thread/thread_handler_thread_output_file.py.html0100600000176200017510000000624207306455633032726 0ustar dhellmanndevel Class: thread_output_file

Table of Contents

Class: thread_output_file Zope-2-CVS-src/ZServer/medusa/thread/thread_handler.py

Base Classes   
select_trigger.trigger_file
Methods   
close
  close  
close ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:54 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/__init__.py.html0100600000176200017510000000241507306455633024302 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/ZServer/medusa/__init__.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/misc/0040700000176200017510000000000007306455636022163 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/misc/async_mysql.py.html0100600000176200017510000002241207306455634026040 0ustar dhellmanndevel Module: async_mysql

Table of Contents

Module: async_mysql Zope-2-CVS-src/ZServer/medusa/misc/async_mysql.py

Imported modules   
import asynchat
import asyncore
from continuation import continuation
import exceptions
from fifo import fifo
import math
import socket
import string
import sys
Functions   
dump_hex
hash_password
n_byte_num
net_field_length
packet
scramble
unpacket
  dump_hex  
dump_hex ( s )

used to generate the dumps below

  hash_password  
hash_password ( password )

  n_byte_num  
n_byte_num ( data,  n )

  net_field_length  
net_field_length ( data,  pos=0 )

  packet  
packet ( data,  s=0 )

  scramble  
scramble ( message,  password )

  unpacket  
unpacket ( p )

Classes   
mysql_client
mysql_error
random_state
result_set

unpack a result set

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/misc/async_mysql_mysql_client.py.html0100600000176200017510000003435707306455633030635 0ustar dhellmanndevel Class: mysql_client

Table of Contents

Class: mysql_client Zope-2-CVS-src/ZServer/medusa/misc/async_mysql.py

Base Classes   
asynchat.async_chat
Methods   
__init__
_relogin
_relogin_use
build_login_packet
close
cmd_query
cmd_quit
cmd_use
collect_incoming_data
command
 handle_connect
handle_packet
login
push_query
  __init__  
__init__ (
        self,
        username,
        password,
        login_callback,
        address=( '127.0.0.1', 3306 ),
        )

  _relogin  
_relogin (
        self,
        (,
        ignore,
        result,
        )

Exceptions   
SystemError, "Couldn't reconnect to mysql server"
  _relogin_use  
_relogin_use (
        self,
        (,
        nfields,
        data,
        )

Exceptions   
SystemError, "Couldn't reconnect to current database"
  build_login_packet  
build_login_packet ( self,  challenge )

  close  
close ( self )

  cmd_query  
cmd_query (
        self,
        query,
        callback=None,
        )

  cmd_quit  
cmd_quit ( self,  callback=None )

  cmd_use  
cmd_use (
        self,
        database,
        callback=None,
        )

  collect_incoming_data  
collect_incoming_data ( self,  data )

  command  
command (
        self,
        command_type,
        command,
        callback,
        )

  handle_connect  
handle_connect ( self )

  handle_packet  
handle_packet (
        self,
        seq,
        data,
        )

  login  
login ( self,  callback )

  push_query  
push_query (
        self,
        query,
        callback=None,
        sequence=0,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/misc/async_mysql_mysql_error.py.html0100600000176200017510000000366707306455633030510 0ustar dhellmanndevel Class: mysql_error

Table of Contents

Class: mysql_error Zope-2-CVS-src/ZServer/medusa/misc/async_mysql.py

Base Classes   
exceptions.Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/misc/async_mysql_random_state.py.html0100600000176200017510000000631207306455633030600 0ustar dhellmanndevel Class: random_state

Table of Contents

Class: random_state Zope-2-CVS-src/ZServer/medusa/misc/async_mysql.py

Methods   
__init__
rnd
  __init__  
__init__ (
        self,
        seed,
        seed2,
        )

  rnd  
rnd ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/misc/async_mysql_result_set.py.html0100600000176200017510000000771607306455634030323 0ustar dhellmanndevel Class: result_set

Table of Contents

Class: result_set Zope-2-CVS-src/ZServer/medusa/misc/async_mysql.py

unpack a result set

Methods   
__call__
__init__
unpack_data
  __call__  
__call__ (
        self,
        seq,
        data,
        )

  __init__  
__init__ (
        self,
        callback,
        data_callback=None,
        )

  unpack_data  
unpack_data ( self,  d )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/misc/recorder.py.html0100600000176200017510000001027607306455636025312 0ustar dhellmanndevel Module: recorder

Table of Contents

Module: recorder Zope-2-CVS-src/ZServer/medusa/misc/recorder.py

Imported modules   
import asynchat
import asyncore
import socket
Functions   
shutdown
  shutdown  
shutdown ()

force a clean shutdown

Classes   
recorder_channel
recorder_server

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/misc/recorder_recorder_channel.py.html0100600000176200017510000000761507306455636030672 0ustar dhellmanndevel Class: recorder_channel

Table of Contents

Class: recorder_channel Zope-2-CVS-src/ZServer/medusa/misc/recorder.py

Base Classes   
asyncore.dispatcher
Methods   
__init__
handle_read
  __init__  
__init__ (
        self,
        sock,
        addr,
        )

  handle_read  
handle_read ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/misc/recorder_recorder_server.py.html0100600000176200017510000000756407306455636030573 0ustar dhellmanndevel Class: recorder_server

Table of Contents

Class: recorder_server Zope-2-CVS-src/ZServer/medusa/misc/recorder.py

Base Classes   
asyncore.dispatcher
Methods   
__init__
handle_accept
  __init__  
__init__ ( self,  port=8989 )

  handle_accept  
handle_accept ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/misc/syncsock.py.html0100600000176200017510000001240507306455636025335 0ustar dhellmanndevel Module: syncsock

Table of Contents

Module: syncsock Zope-2-CVS-src/ZServer/medusa/misc/syncsock.py

Imported modules   
import struct
import windll
import winerror
Functions   
set_sync_option
sync_off
sync_on
  set_sync_option  
set_sync_option ( on=1 )

Exceptions   
SystemError, "getsockopt: (%d)" %(wsock32.WSAGetLastError() )
  sync_off  
sync_off ()

  sync_on  
sync_on ()

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/sendfile/0040700000176200017510000000000007306455636023021 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/sendfile/asynchat_sendfile.py.html0100600000176200017510000000536307306455634030025 0ustar dhellmanndevel Module: asynchat_sendfile

Table of Contents

Module: asynchat_sendfile Zope-2-CVS-src/ZServer/medusa/sendfile/asynchat_sendfile.py

Imported modules   
import asynchat
import sendfile
Classes   
async_chat_with_sendfile

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 ././@LongLink0000000000000000000000000000015500000000000011566 Lustar rootrootZope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/sendfile/asynchat_sendfile_async_chat_with_sendfile.py.htmlZope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/sendfile/asynchat_sendfile_async_chat_with_sendfil0100600000176200017510000000775207306455634033372 0ustar dhellmanndevel Class: async_chat_with_sendfile

Table of Contents

Class: async_chat_with_sendfile Zope-2-CVS-src/ZServer/medusa/sendfile/asynchat_sendfile.py

Base Classes   
async_chat
Methods   
initiate_send
push_sendfile
  initiate_send  
initiate_send ( self )

  push_sendfile  
push_sendfile (
        self,
        fd,
        offset,
        bytes,
        callback=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/sendfile/test_sendfile.py.html0100600000176200017510000000434507306455636027173 0ustar dhellmanndevel Module: test_sendfile

Table of Contents

Module: test_sendfile Zope-2-CVS-src/ZServer/medusa/sendfile/test_sendfile.py

Imported modules   
import asyncore
import os
import socket
import string

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/auth_handler.py.html0100600000176200017510000000664107306455634025207 0ustar dhellmanndevel Module: auth_handler

Table of Contents

Module: auth_handler Zope-2-CVS-src/ZServer/medusa/auth_handler.py

Imported modules   
import base64
import counter
import default_handler
import http_server
import md5
import producers
import re
import string
import time
Classes   
auth_handler
dictionary_authorizer

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/auth_handler_auth_handler.py.html0100600000176200017510000001546007306455634027724 0ustar dhellmanndevel Class: auth_handler

Table of Contents

Class: auth_handler Zope-2-CVS-src/ZServer/medusa/auth_handler.py

Methods   
__init__
apply_hash
handle_request
handle_unauthorized
make_nonce
match
status
  __init__  
__init__ (
        self,
        dict,
        handler,
        realm='default',
        )

  apply_hash  
apply_hash ( self,  s )

Apply MD5 to a string <s>, then wrap it in base64 encoding.

  handle_request  
handle_request ( self,  request )

  handle_unauthorized  
handle_unauthorized ( self,  request )

  make_nonce  
make_nonce ( self,  request )

A digest-authentication <nonce>, constructed as suggested in RFC 2069

  match  
match ( self,  request )

  status  
status ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/auth_handler_dictionary_authorizer.py.html0100600000176200017510000000632507306455634031707 0ustar dhellmanndevel Class: dictionary_authorizer

Table of Contents

Class: dictionary_authorizer Zope-2-CVS-src/ZServer/medusa/auth_handler.py

Methods   
__init__
authorize
  __init__  
__init__ ( self,  dict )

  authorize  
authorize ( self,  auth_info )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/contrib/0040700000176200017510000000000007306455636022670 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/contrib/bobo_handler.py.html0100600000176200017510000001043407306455634026622 0ustar dhellmanndevel Module: bobo_handler

Table of Contents

Module: bobo_handler Zope-2-CVS-src/ZServer/medusa/contrib/bobo_handler.py

Bobo handler module For use with medusa & python object publisher

copyright 1997 amos latteier (code based on script_handler.py)

Use:

here is a sample fragment from a script to start medusa:

... hs = http_server.http_server (IP_ADDRESS, HTTP_PORT, rs, lg) ... sys.path.insert(0,'c:\\windows\\desktop\\medusa2\\www\\bobo') import bobotest bh=bobo_handler.bobo_handler(bobotest, debug=1) #create bobo handler hs.install_handler(bh) #install handler in http server ...

This will install the bobo handler on the http server and give you access to the bobotest module via urls like this:

http://myserver.com/bobotest/blah/blah

bobo_handler initalization options: * debug: If the debug flag is set then the published module will be reloaded whenever its source is changed on disk. This is very handy for developement. * uri_base: If the uri_base isn't specified it defaults to /<module_name>

Imported modules   
import cgi_module_publisher
import counter
import default_handler
import os
import producers
import regex
import string
import sys
Classes   
bobo_handler

publishes a module via bobo

input_collector

gathers input for put and post requests

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/contrib/bobo_handler_bobo_handler.py.html0100600000176200017510000001561307306455634031324 0ustar dhellmanndevel Class: bobo_handler

Table of Contents

Class: bobo_handler Zope-2-CVS-src/ZServer/medusa/contrib/bobo_handler.py

publishes a module via bobo

Methods   
__init__
_continue_request
continue_request
handle_request
match
module_mtime
status
  __init__  
__init__ (
        self,
        module,
        uri_base=None,
        debug=None,
        )

  _continue_request  
_continue_request (
        self,
        sin,
        request,
        )

continue handling request now that we have the stdin

  continue_request  
continue_request (
        self,
        sin,
        request,
        )

continue handling request now that we have the stdin

  handle_request  
handle_request ( self,  request )

  match  
match ( self,  request )

  module_mtime  
module_mtime ( self )

returns the last modified date for a given module's source file

  status  
status ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/contrib/bobo_handler_input_collector.py.html0100600000176200017510000000647107306455634032115 0ustar dhellmanndevel Class: input_collector

Table of Contents

Class: input_collector Zope-2-CVS-src/ZServer/medusa/contrib/bobo_handler.py

gathers input for put and post requests

Methods   
__init__
collect_incoming_data
  __init__  
__init__ (
        self,
        handler,
        request,
        )

  collect_incoming_data  
collect_incoming_data ( self,  data )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/contrib/sample_cgi.py.html0100600000176200017510000000627207306455636026316 0ustar dhellmanndevel Module: sample_cgi

Table of Contents

Module: sample_cgi Zope-2-CVS-src/ZServer/medusa/contrib/sample_cgi.py

Imported modules   
import time
Functions   
main
  main  
main (
        env,
        stdin,
        stdout,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/chat_server.py.html0100600000176200017510000000621407306455634025052 0ustar dhellmanndevel Module: chat_server

Table of Contents

Module: chat_server Zope-2-CVS-src/ZServer/medusa/chat_server.py

Imported modules   
import asynchat
import asyncore
import socket
import status_handler
import string
Classes   
chat_channel
chat_server

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/chat_server_chat_channel.py.html0100600000176200017510000002330207306455634027536 0ustar dhellmanndevel Class: chat_channel

Table of Contents

Class: chat_channel Zope-2-CVS-src/ZServer/medusa/chat_server.py

Base Classes   
asynchat.async_chat
Methods   
__init__
close
cmd_quit
collect_incoming_data
found_terminator
get_nick
greet
handle_close
handle_command
push_line
  __init__  
__init__ (
        self,
        server,
        sock,
        addr,
        )

  close  
close ( self )

  cmd_quit  
cmd_quit ( self,  args )

  collect_incoming_data  
collect_incoming_data ( self,  data )

  found_terminator  
found_terminator ( self )

  get_nick  
get_nick ( self )

  greet  
greet ( self )

  handle_close  
handle_close ( self )

  handle_command  
handle_command ( self,  command )

  push_line  
push_line (
        self,
        nick,
        line,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/chat_server_chat_server.py.html0100600000176200017510000001372707306455634027446 0ustar dhellmanndevel Class: chat_server

Table of Contents

Class: chat_server Zope-2-CVS-src/ZServer/medusa/chat_server.py

Base Classes   
asyncore.dispatcher
Methods   
__init__
handle_accept
push_line
status
writable
  __init__  
__init__ (
        self,
        ip='',
        port=8518,
        )

  handle_accept  
handle_accept ( self )

  push_line  
push_line (
        self,
        from_channel,
        line,
        )

  status  
status ( self )

  writable  
writable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/continuation.py.html0100600000176200017510000000405307306455634025256 0ustar dhellmanndevel Module: continuation

Table of Contents

Module: continuation Zope-2-CVS-src/ZServer/medusa/continuation.py

Classes   
continuation

Package up a continuation as an object.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/continuation_continuation.py.html0100600000176200017510000001113607306455634030050 0ustar dhellmanndevel Class: continuation

Table of Contents

Class: continuation Zope-2-CVS-src/ZServer/medusa/continuation.py

Package up a continuation as an object.

Methods   
__call__
__init__
abort
chain
  __call__  
__call__ ( self,  *args )

  __init__  
__init__ (
        self,
        fun,
        *args,
        )

  abort  
abort ( self,  *args )

  chain  
chain (
        self,
        fun,
        *args,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/counter.py.html0100600000176200017510000000377507306455634024235 0ustar dhellmanndevel Module: counter

Table of Contents

Module: counter Zope-2-CVS-src/ZServer/medusa/counter.py

Classes   
counter

general-purpose counter

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/counter_counter.py.html0100600000176200017510000001510407306455634025761 0ustar dhellmanndevel Class: counter

Table of Contents

Class: counter Zope-2-CVS-src/ZServer/medusa/counter.py

general-purpose counter

Methods   
__init__
__nonzero__
__repr__
__str__
as_long
decrement
increment
  __init__  
__init__ ( self,  initial_value=0 )

  __nonzero__  
__nonzero__ ( self )

  __repr__  
__repr__ ( self )

  __str__  
__str__ ( self )

  as_long  
as_long ( self )

  decrement  
decrement ( self,  delta=1 )

  increment  
increment ( self,  delta=1 )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/default_handler.py.html0100600000176200017510000001145607306455634025672 0ustar dhellmanndevel Module: default_handler

Table of Contents

Module: default_handler Zope-2-CVS-src/ZServer/medusa/default_handler.py

Imported modules   
from counter import counter
import http_date
import http_server
import mime_type_table
import os
import posixpath
import producers
import re
import stat
import status_handler
import string
import time
Functions   
get_extension
  get_extension  
get_extension ( path )

Classes   
default_handler

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/default_handler_default_handler.py.html0100600000176200017510000001377707306455634031103 0ustar dhellmanndevel Class: default_handler

Table of Contents

Class: default_handler Zope-2-CVS-src/ZServer/medusa/default_handler.py

Methods   
__init__
__repr__
handle_request
match
set_content_type
status
  __init__  
__init__ ( self,  filesystem )

  __repr__  
__repr__ ( self )

  handle_request  
handle_request ( self,  request )

  match  
match ( self,  request )

always match, since this is a default

  set_content_type  
set_content_type (
        self,
        path,
        request,
        )

  status  
status ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/event_loop.py.html0100600000176200017510000000570707306455634024725 0ustar dhellmanndevel Module: event_loop

Table of Contents

Module: event_loop Zope-2-CVS-src/ZServer/medusa/event_loop.py

Imported modules   
import asyncore
import bisect
import time
Classes   
event_loop
test

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/event_loop_event_loop.py.html0100600000176200017510000001113307306455634027145 0ustar dhellmanndevel Class: event_loop

Table of Contents

Class: event_loop Zope-2-CVS-src/ZServer/medusa/event_loop.py

Methods   
__init__
__len__
go
schedule
  __init__  
__init__ ( self )

  __len__  
__len__ ( self )

  go  
go (
        self,
        timeout=30.0,
        granularity=15,
        )

  schedule  
schedule (
        self,
        delta,
        callback,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/event_loop_test.py.html0100600000176200017510000001415307306455634025757 0ustar dhellmanndevel Class: test

Table of Contents

Class: test Zope-2-CVS-src/ZServer/medusa/event_loop.py

Base Classes   
asyncore.dispatcher
Methods   
__init__
connect_timeout_callback
handle_connect
periodic_thing_callback
writable
  __init__  
__init__ ( self )

  connect_timeout_callback  
connect_timeout_callback (
        self,
        event_loop,
        when,
        )

  handle_connect  
handle_connect ( self )

  periodic_thing_callback  
periodic_thing_callback (
        self,
        event_loop,
        when,
        )

  writable  
writable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/fifo.py.html0100600000176200017510000000671407306455634023475 0ustar dhellmanndevel Module: fifo

Table of Contents

Module: fifo Zope-2-CVS-src/ZServer/medusa/fifo.py

Functions   
test_embedded
  test_embedded  
test_embedded ()

Classes   
fifo
output_fifo
protected_fifo

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/fifo_fifo.py.html0100600000176200017510000002222507306455634024473 0ustar dhellmanndevel Class: fifo

Table of Contents

Class: fifo Zope-2-CVS-src/ZServer/medusa/fifo.py

Methods   
__getitem__
__init__
__len__
_nth
first
pop
push
push_front
  __getitem__  
__getitem__ ( self,  index )

Exceptions   
IndexError, "index out of range"
  __init__  
__init__ ( self )

  __len__  
__len__ ( self )

  _nth  
_nth ( self,  n )

  first  
first ( self )

Exceptions   
ValueError, "first() of an empty queue"
  pop  
pop ( self )

Exceptions   
ValueError, "pop() from an empty queue"
  push  
push ( self,  v )

  push_front  
push_front ( self,  thing )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/fifo_output_fifo.py.html0100600000176200017510000001770107306455634026116 0ustar dhellmanndevel Class: output_fifo

Table of Contents

Class: output_fifo Zope-2-CVS-src/ZServer/medusa/fifo.py

Methods   
__init__
__len__
empty
first
pop
push
push_embedded
push_eof
push_trigger
  __init__  
__init__ ( self )

  __len__  
__len__ ( self )

length is an inaccurate term. we should probably use an empty method instead.

  empty  
empty ( self )

  first  
first ( self )

  pop  
pop ( self )

  push  
push ( self,  item )

  push_embedded  
push_embedded ( self,  fifo )

  push_eof  
push_eof ( self )

  push_trigger  
push_trigger ( self,  thunk )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/fifo_protected_fifo.py.html0100600000176200017510000001076007306455634026545 0ustar dhellmanndevel Class: protected_fifo

Table of Contents

Class: protected_fifo Zope-2-CVS-src/ZServer/medusa/fifo.py

Methods   
__init__
__len__
pop
push
  __init__  
__init__ ( self,  lock=None )

  __len__  
__len__ ( self )

  pop  
pop ( self )

  push  
push ( self,  item )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/filesys.py.html0100600000176200017510000001721407306455634024225 0ustar dhellmanndevel Module: filesys

Table of Contents

Module: filesys Zope-2-CVS-src/ZServer/medusa/filesys.py

Imported modules   
import glob
import os
import re
import stat
import string
import time
Functions   
ls_date
msdos_date
msdos_longify
safe_stat
unix_longify
  ls_date  
ls_date ( now,  t )

  msdos_date  
msdos_date ( t )

  msdos_longify  
msdos_longify ( file,  stat_info )

  safe_stat  
safe_stat ( path )

  unix_longify  
unix_longify ( file,  stat_info )

Classes   
abstract_filesystem
list_producer
merged_filesystem
msdos_filesystem
os_filesystem

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/filesys_abstract_filesystem.py.html0100600000176200017510000002210107306455634030343 0ustar dhellmanndevel Class: abstract_filesystem

Table of Contents

Class: abstract_filesystem Zope-2-CVS-src/ZServer/medusa/filesys.py

Methods   
__init__
cdup
current_directory
cwd
isdir
isfile
listdir
longify
open
stat
  __init__  
__init__ ( self )

  cdup  
cdup ( self )

Change to the parent of the current directory.

  current_directory  
current_directory ( self )

Return a string representing the current directory.

  cwd  
cwd ( self,  path )

Change the working directory.

  isdir  
isdir ( self,  path )

Does the path represent a directory?

  isfile  
isfile ( self,  path )

Does the path represent a plain file?

  listdir  
listdir (
        self,
        path,
        long=0,
        )

Return a listing of the directory at path The empty string indicates the current directory. If long is set, instead return a list of (name, stat_info) tuples

  longify  
longify ( self,  path )

Return a long representation of the filename [for the output of the LIST command]

  open  
open (
        self,
        path,
        mode,
        )

Return an open file object

  stat  
stat ( self,  path )

Return the equivalent of os.stat() on the given path.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/filesys_list_producer.py.html0100600000176200017510000000755707306455634027174 0ustar dhellmanndevel Class: list_producer

Table of Contents

Class: list_producer Zope-2-CVS-src/ZServer/medusa/filesys.py

Methods   
__init__
more
ready
  __init__  
__init__ (
        self,
        file_list,
        long,
        longify,
        )

  more  
more ( self )

this should do a pushd/popd

  ready  
ready ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/filesys_merged_filesystem.py.html0100600000176200017510000000500407306455634030006 0ustar dhellmanndevel Class: merged_filesystem

Table of Contents

Class: merged_filesystem Zope-2-CVS-src/ZServer/medusa/filesys.py

Methods   
__init__
  __init__  
__init__ ( self,  *fsys )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/filesys_msdos_filesystem.py.html0100600000176200017510000000626607306455634027703 0ustar dhellmanndevel Class: msdos_filesystem

Table of Contents

Class: msdos_filesystem Zope-2-CVS-src/ZServer/medusa/filesys.py

Base Classes   
os_filesystem
Methods   
longify
  longify  
longify ( self,  ( )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/filesys_os_filesystem.py.html0100600000176200017510000003165507306455634027177 0ustar dhellmanndevel Class: os_filesystem

Table of Contents

Class: os_filesystem Zope-2-CVS-src/ZServer/medusa/filesys.py

Methods   
__init__
__repr__
cdup
current_directory
cwd
isdir
isfile
listdir
longify
mkdir
 normalize
open
rmdir
stat
translate
unlink
  __init__  
__init__ (
        self,
        root,
        wd='/',
        )

  __repr__  
__repr__ ( self )

  cdup  
cdup ( self )

  current_directory  
current_directory ( self )

  cwd  
cwd ( self,  path )

  isdir  
isdir ( self,  path )

  isfile  
isfile ( self,  path )

  listdir  
listdir (
        self,
        path,
        long=0,
        )

  longify  
longify ( self,  ( )

  mkdir  
mkdir ( self,  path )

  normalize  
normalize ( self,  path )

utility methods

  open  
open (
        self,
        path,
        mode,
        )

  rmdir  
rmdir ( self,  path )

  stat  
stat ( self,  path )

TODO: implement a cache w/timeout for stat()

  translate  
translate ( self,  path )

  unlink  
unlink ( self,  path )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/ftp_server.py.html0100600000176200017510000001501007306455635024717 0ustar dhellmanndevel Module: ftp_server

Table of Contents

Module: ftp_server Zope-2-CVS-src/ZServer/medusa/ftp_server.py

Imported modules   
import asynchat
import asyncore
from counter import counter
import filesys
import logger
import os
import producers
import socket
import stat
import status_handler
import string
import sys
import time
Functions   
get_vm_size
print_vm
  get_vm_size  
get_vm_size ()

debugging aid (linux)

  print_vm  
print_vm ()

Classes   
anon_authorizer
dummy_authorizer

not much of a doorman! 8^)

file_producer
ftp_channel
ftp_server
passive_acceptor
recv_channel
xmit_channel

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/ftp_server_anon_authorizer.py.html0100600000176200017510000000640507306455634030215 0ustar dhellmanndevel Class: anon_authorizer

Table of Contents

Class: anon_authorizer Zope-2-CVS-src/ZServer/medusa/ftp_server.py

Methods   
__init__
authorize
  __init__  
__init__ ( self,  root='/' )

  authorize  
authorize (
        self,
        channel,
        username,
        password,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/ftp_server_dummy_authorizer.py.html0100600000176200017510000000637107306455634030417 0ustar dhellmanndevel Class: dummy_authorizer

Table of Contents

Class: dummy_authorizer Zope-2-CVS-src/ZServer/medusa/ftp_server.py

not much of a doorman! 8^)

Methods   
__init__
authorize
  __init__  
__init__ ( self,  root='/' )

  authorize  
authorize (
        self,
        channel,
        username,
        password,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/ftp_server_file_producer.py.html0100600000176200017510000000632007306455634027624 0ustar dhellmanndevel Class: file_producer

Table of Contents

Class: file_producer Zope-2-CVS-src/ZServer/medusa/ftp_server.py

Methods   
__init__
more
  __init__  
__init__ (
        self,
        server,
        dc,
        fd,
        )

  more  
more ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/ftp_server_ftp_channel.py.html0100600000176200017510000010202107306455634027256 0ustar dhellmanndevel Class: ftp_channel

Table of Contents

Class: ftp_channel Zope-2-CVS-src/ZServer/medusa/ftp_server.py

Base Classes   
asynchat.async_chat
Methods   
__init__
cdup
check_command_authorization
close
cmd_abor
cmd_appe
cmd_cdup
cmd_cwd
cmd_dele
cmd_help
cmd_list
cmd_mdtm
cmd_mkd
cmd_mode
 cmd_nlst
cmd_noop
cmd_pass
cmd_pasv
cmd_port
cmd_pwd
cmd_quit
cmd_rest
cmd_retr
cmd_rmd
cmd_size
cmd_stor
cmd_stru
cmd_syst
 cmd_type
cmd_user
collect_incoming_data
command_not_authorized
command_not_understood
cwd
found_terminator
get_dir_list
handle_expt
listdir
log
make_recv_channel
make_xmit_channel
new_passive_acceptor
  __init__  
__init__ (
        self,
        server,
        conn,
        addr,
        )

  cdup  
cdup ( self,  line )

  check_command_authorization  
check_command_authorization ( self,  command )

  close  
close ( self )

  cmd_abor  
cmd_abor ( self,  line )

abort operation

  cmd_appe  
cmd_appe ( self,  line )

append to a file

  cmd_cdup  
cmd_cdup ( self,  line )

change to parent of current working directory

  cmd_cwd  
cmd_cwd ( self,  line )

change working directory

  cmd_dele  
cmd_dele ( self,  line )

  cmd_help  
cmd_help ( self,  line )

give help information

  cmd_list  
cmd_list ( self,  line )

give list files in a directory

  cmd_mdtm  
cmd_mdtm ( self,  line )

show last modification time of file

modification time example output: 213 19960301204320

  cmd_mkd  
cmd_mkd ( self,  line )

  cmd_mode  
cmd_mode ( self,  line )

obsolete - set file transfer mode

  cmd_nlst  
cmd_nlst ( self,  line )

give name list of files in directory

  cmd_noop  
cmd_noop ( self,  line )

do nothing

  cmd_pass  
cmd_pass ( self,  line )

specify password

  cmd_pasv  
cmd_pasv ( self,  line )

prepare for server-to-server transfer

  cmd_port  
cmd_port ( self,  line )

specify data connection port

  cmd_pwd  
cmd_pwd ( self,  line )

print the current working directory

  cmd_quit  
cmd_quit ( self,  line )

terminate session

  cmd_rest  
cmd_rest ( self,  line )

restart incomplete transfer

  cmd_retr  
cmd_retr ( self,  line )

retrieve a file

  cmd_rmd  
cmd_rmd ( self,  line )

  cmd_size  
cmd_size ( self,  line )

return size of file

  cmd_stor  
cmd_stor (
        self,
        line,
        mode='wb',
        )

store a file

  cmd_stru  
cmd_stru ( self,  line )

obsolete - set file transfer structure

  cmd_syst  
cmd_syst ( self,  line )

show operating system type of server system

  cmd_type  
cmd_type ( self,  line )

specify data transfer type

  cmd_user  
cmd_user ( self,  line )

specify user name

  collect_incoming_data  
collect_incoming_data ( self,  data )

  command_not_authorized  
command_not_authorized ( self,  command )

  command_not_understood  
command_not_understood ( self,  command )

  cwd  
cwd ( self,  line )

  found_terminator  
found_terminator ( self )

  get_dir_list  
get_dir_list (
        self,
        line,
        long=0,
        )

  handle_expt  
handle_expt ( self )

  listdir  
listdir (
        self,
        path,
        long=0,
        )

returns a producer

  log  
log ( self,  message )

  make_recv_channel  
make_recv_channel ( self,  fd )

pretty much the same as xmit, but only right on the verge of being worth a merge.

  make_xmit_channel  
make_xmit_channel ( self )

  new_passive_acceptor  
new_passive_acceptor ( self )

  open  
open (
        self,
        path,
        mode,
        )

  respond  
respond ( self,  resp )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/ftp_server_ftp_server.py.html0100600000176200017510000001537707306455634027175 0ustar dhellmanndevel Class: ftp_server

Table of Contents

Class: ftp_server Zope-2-CVS-src/ZServer/medusa/ftp_server.py

Base Classes   
asyncore.dispatcher
Methods   
__init__
handle_accept
handle_connect
handle_read
status
writable
  __init__  
__init__ (
        self,
        authorizer,
        hostname=None,
        ip='',
        port=21,
        resolver=None,
        logger_object=logger.file_logger( sys.stdout ),
        )

  handle_accept  
handle_accept ( self )

  handle_connect  
handle_connect ( self )

  handle_read  
handle_read ( self )

  status  
status ( self )

return a producer describing the state of the server

  writable  
writable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/ftp_server_passive_acceptor.py.html0100600000176200017510000001103007306455634030326 0ustar dhellmanndevel Class: passive_acceptor

Table of Contents

Class: passive_acceptor Zope-2-CVS-src/ZServer/medusa/ftp_server.py

Base Classes   
asyncore.dispatcher
Methods   
__init__
handle_accept
log
  __init__  
__init__ ( self,  control_channel )

  handle_accept  
handle_accept ( self )

  log  
log ( self,  *ignore )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/ftp_server_recv_channel.py.html0100600000176200017510000001644607306455635027444 0ustar dhellmanndevel Class: recv_channel

Table of Contents

Class: recv_channel Zope-2-CVS-src/ZServer/medusa/ftp_server.py

Base Classes   
asyncore.dispatcher
Methods   
__init__
handle_close
handle_connect
handle_read
log
recv
writable
  __init__  
__init__ (
        self,
        channel,
        client_addr,
        fd,
        )

  handle_close  
handle_close ( self )

  handle_connect  
handle_connect ( self )

  handle_read  
handle_read ( self )

  log  
log ( self,  *ignore )

  recv  
recv ( *args )

  writable  
writable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/ftp_server_xmit_channel.py.html0100600000176200017510000001634007306455635027457 0ustar dhellmanndevel Class: xmit_channel

Table of Contents

Class: xmit_channel Zope-2-CVS-src/ZServer/medusa/ftp_server.py

Base Classes   
asynchat.async_chat
Methods   
__init__
close
handle_error
log
readable
send
writable
  __init__  
__init__ (
        self,
        channel,
        client_addr=None,
        )

  close  
close ( self )

  handle_error  
handle_error ( self )

  log  
log ( *args )

  readable  
readable ( self )

  send  
send ( self,  data )

  writable  
writable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/http_bobo.py.html0100600000176200017510000000535707306455635024535 0ustar dhellmanndevel Module: http_bobo

Table of Contents

Module: http_bobo Zope-2-CVS-src/ZServer/medusa/http_bobo.py

Imported modules   
import regex
import string
Classes   
bobo_extension

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/http_bobo_bobo_extension.py.html0100600000176200017510000001235407306455635027625 0ustar dhellmanndevel Class: bobo_extension

Table of Contents

Class: bobo_extension Zope-2-CVS-src/ZServer/medusa/http_bobo.py

Methods   
__init__
__repr__
handle_request
match
status
  __init__  
__init__ ( self,  regexp )

  __repr__  
__repr__ ( self )

  handle_request  
handle_request ( self,  channel )

  match  
match ( self,  path_part )

  status  
status ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/http_date.py.html0100600000176200017510000001670207306455635024525 0ustar dhellmanndevel Module: http_date

Table of Contents

Module: http_date Zope-2-CVS-src/ZServer/medusa/http_date.py

Imported modules   
import re
import string
import time
Functions   
build_http_date
concat
group
join
parse_http_date
unpack_rfc822
unpack_rfc850
  build_http_date  
build_http_date ( when )

  concat  
concat ( *args )

  group  
group ( s )

  join  
join ( seq,  field=' ' )

  parse_http_date  
parse_http_date ( d )

  unpack_rfc822  
unpack_rfc822 ( m )

  unpack_rfc850  
unpack_rfc850 ( m )

they actually unpack the same way

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/http_server.py.html0100600000176200017510000002226307306455635025115 0ustar dhellmanndevel Module: http_server

Table of Contents

Module: http_server Zope-2-CVS-src/ZServer/medusa/http_server.py

Imported modules   
import asynchat
import asyncore
import base64
from counter import counter
import http_date
import logger
import os
import producers
import re
import socket
import stat
import status_handler
import string
import sys
import time
from urllib import unquote
Functions   
compute_timezone_for_log
crack_request
get_header
get_header_match
join_headers
maybe_status
  compute_timezone_for_log  
compute_timezone_for_log ()

  crack_request  
crack_request ( r )

  get_header  
get_header (
        head_reg,
        lines,
        group=1,
        )

  get_header_match  
get_header_match ( head_reg,  lines )

  join_headers  
join_headers ( headers )

merge multi-line headers [486dx2: ~500/sec]

  maybe_status  
maybe_status ( thing )

Classes   
fifo
http_channel
http_request
http_server

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/http_server_fifo.py.html0100600000176200017510000001351707306455635026122 0ustar dhellmanndevel Class: fifo

Table of Contents

Class: fifo Zope-2-CVS-src/ZServer/medusa/http_server.py

Methods   
__init__
__len__
first
pop
push
push_front
  __init__  
__init__ ( self,  list=None )

  __len__  
__len__ ( self )

  first  
first ( self )

  pop  
pop ( self )

  push  
push ( self,  data )

  push_front  
push_front ( self,  object )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/http_server_http_channel.py.html0100600000176200017510000003065207306455635027645 0ustar dhellmanndevel Class: http_channel

Table of Contents

Class: http_channel Zope-2-CVS-src/ZServer/medusa/http_server.py

Base Classes   
asynchat.async_chat
Methods   
__init__
__repr__
check_maintenance
collect_incoming_data
found_terminator
handle_error
kill_zombies
log
maintenance
recv
 send
writable
writable_for_proxy
  __init__  
__init__ (
        self,
        server,
        conn,
        addr,
        )

  __repr__  
__repr__ ( self )

  check_maintenance  
check_maintenance ( self )

  collect_incoming_data  
collect_incoming_data ( self,  data )

  found_terminator  
found_terminator ( self )

  handle_error  
handle_error ( self )

Exceptions   
t, v
  kill_zombies  
kill_zombies ( self )

  log  
log ( self,  *args )

  maintenance  
maintenance ( self )

  recv  
recv ( self,  buffer_size )

  send  
send ( self,  data )

this information needs to get into the request object, so that it may log correctly.

  writable  
writable ( self )

  writable_for_proxy  
writable_for_proxy ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/http_server_http_request.py.html0100600000176200017510000003374407306455635027732 0ustar dhellmanndevel Class: http_request

Table of Contents

Class: http_request Zope-2-CVS-src/ZServer/medusa/http_server.py

Methods   
__getitem__
__init__
__setitem__
build_reply_header
collect_incoming_data
done
error
found_terminator
get_header
get_header_with_regex
 has_key
log
log_date_string
push
response
split_uri
  __getitem__  
__getitem__ ( self,  key )

  __init__  
__init__ ( self,  *args )

  __setitem__  
__setitem__ (
        self,
        key,
        value,
        )

-------------------------------------------------- reply header management --------------------------------------------------

  build_reply_header  
build_reply_header ( self )

  collect_incoming_data  
collect_incoming_data ( self,  data )

  done  
done ( self )

finalize this transaction - send output to the http channel

  error  
error ( self,  code )

  found_terminator  
found_terminator ( self )

  get_header  
get_header ( self,  header )

  get_header_with_regex  
get_header_with_regex (
        self,
        head_reg,
        group,
        )

  has_key  
has_key ( self,  key )

  log  
log ( self,  bytes )

  log_date_string  
log_date_string ( self,  when )

  push  
push ( self,  thing )

  response  
response ( self,  code=200 )

  split_uri  
split_uri ( self )

Exceptions   
ValueError, "Broken URI"

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/http_server_http_server.py.html0100600000176200017510000002150207306455635027535 0ustar dhellmanndevel Class: http_server

Table of Contents

Class: http_server Zope-2-CVS-src/ZServer/medusa/http_server.py

Base Classes   
asyncore.dispatcher
Methods   
__init__
handle_accept
handle_connect
handle_read
install_handler
readable
remove_handler
status
writable
  __init__  
__init__ (
        self,
        ip,
        port,
        resolver=None,
        logger_object=None,
        )

  handle_accept  
handle_accept ( self )

  handle_connect  
handle_connect ( self )

  handle_read  
handle_read ( self )

  install_handler  
install_handler (
        self,
        handler,
        back=0,
        )

  readable  
readable ( self )

  remove_handler  
remove_handler ( self,  handler )

  status  
status ( self )

  writable  
writable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/logger.py.html0100600000176200017510000001237707306455635024034 0ustar dhellmanndevel Module: logger

Table of Contents

Module: logger Zope-2-CVS-src/ZServer/medusa/logger.py

Imported modules   
import asynchat
import m_syslog
import socket
import string
Functions   
strip_eol
  strip_eol  
strip_eol ( line )

Classes   
file_logger
multi_logger

log to multiple places

resolving_logger

Feed (ip, message) combinations into this logger to get a

rotating_file_logger
socket_logger
syslog_logger
tail_logger

Keep track of the last <size> log messages

unresolving_logger

Just in case you don't want to resolve

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/logger_file_logger.py.html0100600000176200017510000001774607306455635026377 0ustar dhellmanndevel Class: file_logger

Table of Contents

Class: file_logger Zope-2-CVS-src/ZServer/medusa/logger.py

Methods   
__init__
__repr__
flush
log
maybe_flush
softspace
write
writeline
writelines
  __init__  
__init__ (
        self,
        file,
        flush=1,
        mode='a',
        )

pass this either a path or a file object.

  __repr__  
__repr__ ( self )

  flush  
flush ( self )

  log  
log ( self,  message )

  maybe_flush  
maybe_flush ( self )

  softspace  
softspace ( self,  *args )

  write  
write ( self,  data )

  writeline  
writeline ( self,  line )

  writelines  
writelines ( self,  lines )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/logger_multi_logger.py.html0100600000176200017510000000750207306455635026577 0ustar dhellmanndevel Class: multi_logger

Table of Contents

Class: multi_logger Zope-2-CVS-src/ZServer/medusa/logger.py

log to multiple places

Methods   
__init__
__repr__
log
  __init__  
__init__ ( self,  loggers )

  __repr__  
__repr__ ( self )

  log  
log ( self,  message )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/logger_resolving_logger.py.html0100600000176200017510000000660407306455635027457 0ustar dhellmanndevel Class: resolving_logger

Table of Contents

Class: resolving_logger Zope-2-CVS-src/ZServer/medusa/logger.py

Feed (ip, message) combinations into this logger to get a resolved hostname in front of the message. The message will not be logged until the PTR request finishes (or fails).

Methods   
__init__
log
  __init__  
__init__ (
        self,
        resolver,
        logger,
        )

  log  
log (
        self,
        ip,
        message,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/logger_rotating_file_logger.py.html0100600000176200017510000001562107306455635030274 0ustar dhellmanndevel Class: rotating_file_logger

Table of Contents

Class: rotating_file_logger Zope-2-CVS-src/ZServer/medusa/logger.py

Base Classes   
file_logger
Methods   
__init__
__repr__
maybe_flush
maybe_rotate
next_backup
rotate
  __init__  
__init__ (
        self,
        file,
        freq=None,
        maxsize=None,
        flush=1,
        mode='a',
        )

If freq is non-None we back up "daily", "weekly", or "monthly". Else if maxsize is non-None we back up whenever the log gets to big. If both are None we never back up.

  __repr__  
__repr__ ( self )

  maybe_flush  
maybe_flush ( self )

  maybe_rotate  
maybe_rotate ( self )

  next_backup  
next_backup ( self,  freq )

We back up at midnight every 1) day, 2) monday, or 3) 1st of month

  rotate  
rotate ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/logger_socket_logger.py.html0100600000176200017510000001075507306455635026741 0ustar dhellmanndevel Class: socket_logger

Table of Contents

Class: socket_logger Zope-2-CVS-src/ZServer/medusa/logger.py

Base Classes   
asynchat.async_chat
Methods   
__init__
__repr__
log
  __init__  
__init__ ( self,  address )

  __repr__  
__repr__ ( self )

  log  
log ( self,  message )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/logger_syslog_logger.py.html0100600000176200017510000001104107306455635026756 0ustar dhellmanndevel Class: syslog_logger

Table of Contents

Class: syslog_logger Zope-2-CVS-src/ZServer/medusa/logger.py

Base Classes   
m_syslog.syslog_client
Methods   
__init__
__repr__
log
  __init__  
__init__ (
        self,
        address,
        facility='user',
        )

  __repr__  
__repr__ ( self )

  log  
log ( self,  message )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/logger_tail_logger.py.html0100600000176200017510000000631707306455635026401 0ustar dhellmanndevel Class: tail_logger

Table of Contents

Class: tail_logger Zope-2-CVS-src/ZServer/medusa/logger.py

Keep track of the last <size> log messages

Methods   
__init__
log
  __init__  
__init__ (
        self,
        logger,
        size=500,
        )

  log  
log ( self,  message )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/logger_unresolving_logger.py.html0100600000176200017510000000631507306455635030021 0ustar dhellmanndevel Class: unresolving_logger

Table of Contents

Class: unresolving_logger Zope-2-CVS-src/ZServer/medusa/logger.py

Just in case you don't want to resolve

Methods   
__init__
log
  __init__  
__init__ ( self,  logger )

  log  
log (
        self,
        ip,
        message,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/m_syslog.py.html0100600000176200017510000000720107306455635024377 0ustar dhellmanndevel Module: m_syslog

Table of Contents

Module: m_syslog Zope-2-CVS-src/ZServer/medusa/m_syslog.py

socket interface to unix syslog. On Unix, there are usually two ways of getting to syslog: via a local unix-domain socket, or via the TCP service.

Usually "/dev/log" is the unix domain socket. This may be different for other systems.

>>> my_client = syslog_client (/dev/log)

Otherwise, just use the UDP version, port 514.

>>> my_client = syslog_client ((my_log_host, 514))

On win32, you will have to use the UDP version. Note that you can use this to log to other hosts (and indeed, multiple hosts).

This module is not a drop-in replacement for the python <syslog> extension module - the interface is different.

Usage:

>>> c = syslog_client() >>> c = syslog_client (/strange/non_standard_log_location) >>> c = syslog_client ((other_host.com, 514)) >>> c.log (testing, facility='local0', priority='debug')

Imported modules   
import socket
Classes   
syslog_client

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/m_syslog_syslog_client.py.html0100600000176200017510000001125607306455635027342 0ustar dhellmanndevel Class: syslog_client

Table of Contents

Class: syslog_client Zope-2-CVS-src/ZServer/medusa/m_syslog.py

Methods   
__init__
close
encode_priority
log
  __init__  
__init__ ( self,  address='/dev/log' )

  close  
close ( self )

  encode_priority  
encode_priority (
        self,
        facility,
        priority,
        )

  log  
log (
        self,
        message,
        facility=LOG_USER,
        priority=LOG_INFO,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/medusa_gif.py.html0100600000176200017510000000242307306455635024647 0ustar dhellmanndevel Module: medusa_gif

Table of Contents

Module: medusa_gif Zope-2-CVS-src/ZServer/medusa/medusa_gif.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/mime_type_table.py.html0100600000176200017510000000244207306455635025704 0ustar dhellmanndevel Module: mime_type_table

Table of Contents

Module: mime_type_table Zope-2-CVS-src/ZServer/medusa/mime_type_table.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/monitor.py.html0100600000176200017510000001261307306455635024235 0ustar dhellmanndevel Module: monitor

Table of Contents

Module: monitor Zope-2-CVS-src/ZServer/medusa/monitor.py

Imported modules   
import asynchat
import asyncore
from counter import counter
import md5
import producers
import socket
import string
import sys
import time
Functions   
hex_digest
  hex_digest  
hex_digest ( s )

Classes   
monitor_channel
monitor_server
output_producer
secure_encrypted_monitor_channel

Wrap send() and recv() with a stream cipher

secure_monitor_channel
secure_monitor_server

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/monitor_monitor_channel.py.html0100600000176200017510000002024707306455635027476 0ustar dhellmanndevel Class: monitor_channel

Table of Contents

Class: monitor_channel Zope-2-CVS-src/ZServer/medusa/monitor.py

Base Classes   
asynchat.async_chat
Methods   
__init__
clean_line
close
collect_incoming_data
found_terminator
handle_connect
prompt
  __init__  
__init__ (
        self,
        server,
        sock,
        addr,
        )

  clean_line  
clean_line ( self,  line )

for now, we ignore any telnet option stuff sent to us, and we process the backspace key ourselves. gee, it would be fun to write a full-blown line-editing environment, etc...

  close  
close ( self )

  collect_incoming_data  
collect_incoming_data ( self,  data )

  found_terminator  
found_terminator ( self )

Exceptions   
SyntaxError
t, v
  handle_connect  
handle_connect ( self )

  prompt  
prompt ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/monitor_monitor_server.py.html0100600000176200017510000001237207306455635027374 0ustar dhellmanndevel Class: monitor_server

Table of Contents

Class: monitor_server Zope-2-CVS-src/ZServer/medusa/monitor.py

Base Classes   
asyncore.dispatcher
Methods   
__init__
handle_accept
status
writable
  __init__  
__init__ (
        self,
        hostname='127.0.0.1',
        port=8023,
        )

  handle_accept  
handle_accept ( self )

  status  
status ( self )

  writable  
writable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/monitor_output_producer.py.html0100600000176200017510000001771207306455635027565 0ustar dhellmanndevel Class: output_producer

Table of Contents

Class: output_producer Zope-2-CVS-src/ZServer/medusa/monitor.py

Methods   
__init__
check_data
flush
more
ready
softspace
write
writeline
writelines
  __init__  
__init__ (
        self,
        channel,
        real_stderr,
        )

  check_data  
check_data ( self )

  flush  
flush ( self )

  more  
more ( self )

  ready  
ready ( self )

  softspace  
softspace ( self,  *args )

  write  
write ( self,  data )

  writeline  
writeline ( self,  line )

  writelines  
writelines ( self,  lines )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/monitor_secure_encrypted_monitor_channel.py.html0100600000176200017510000001136107306455635033116 0ustar dhellmanndevel Class: secure_encrypted_monitor_channel

Table of Contents

Class: secure_encrypted_monitor_channel Zope-2-CVS-src/ZServer/medusa/monitor.py

Wrap send() and recv() with a stream cipher

Base Classes   
secure_monitor_channel
Methods   
__init__
recv
send
  __init__  
__init__ (
        self,
        server,
        conn,
        addr,
        )

  recv  
recv ( self,  block_size )

  send  
send ( self,  data )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/monitor_secure_monitor_channel.py.html0100600000176200017510000001000507306455635031033 0ustar dhellmanndevel Class: secure_monitor_channel

Table of Contents

Class: secure_monitor_channel Zope-2-CVS-src/ZServer/medusa/monitor.py

Base Classes   
monitor_channel
    asynchat.async_chat
Methods   
__init__
found_terminator
  __init__  
__init__ (
        self,
        server,
        sock,
        addr,
        )

  found_terminator  
found_terminator ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/monitor_secure_monitor_server.py.html0100600000176200017510000000773507306455635030751 0ustar dhellmanndevel Class: secure_monitor_server

Table of Contents

Class: secure_monitor_server Zope-2-CVS-src/ZServer/medusa/monitor.py

Base Classes   
monitor_server
    asyncore.dispatcher
Methods   
__init__
status
  __init__  
__init__ (
        self,
        password,
        hostname='',
        port=8023,
        )

  status  
status ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/monitor_client.py.html0100600000176200017510000001175207306455635025576 0ustar dhellmanndevel Module: monitor_client

Table of Contents

Module: monitor_client Zope-2-CVS-src/ZServer/medusa/monitor_client.py

Imported modules   
import asynchat
import asyncore
import md5
import os
import regsub
import socket
import string
import sys
import time
Functions   
hex_digest
  hex_digest  
hex_digest ( s )

Classes   
encrypted_monitor_client

Wrap push() and recv() with a stream cipher

monitor_client
stdin_channel

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/monitor_client_encrypted_monitor_client.py.html0100600000176200017510000001122007306455635032746 0ustar dhellmanndevel Class: encrypted_monitor_client

Table of Contents

Class: encrypted_monitor_client Zope-2-CVS-src/ZServer/medusa/monitor_client.py

Wrap push() and recv() with a stream cipher

Base Classes   
monitor_client
    asynchat.async_chat
Methods   
init_cipher
push
recv
  init_cipher  
init_cipher (
        self,
        cipher,
        key,
        )

  push  
push ( self,  data )

  recv  
recv ( self,  block_size )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/monitor_client_monitor_client.py.html0100600000176200017510000001407307306455635030702 0ustar dhellmanndevel Class: monitor_client

Table of Contents

Class: monitor_client Zope-2-CVS-src/ZServer/medusa/monitor_client.py

Base Classes   
asynchat.async_chat
Methods   
__init__
collect_incoming_data
found_terminator
handle_close
log
  __init__  
__init__ (
        self,
        password,
        addr=( '', 8023 ),
        socket_type=socket.AF_INET,
        )

  collect_incoming_data  
collect_incoming_data ( self,  data )

  found_terminator  
found_terminator ( self )

  handle_close  
handle_close ( self )

  log  
log ( self,  *ignore )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/monitor_client_stdin_channel.py.html0100600000176200017510000001077707306455635030475 0ustar dhellmanndevel Class: stdin_channel

Table of Contents

Class: stdin_channel Zope-2-CVS-src/ZServer/medusa/monitor_client.py

Base Classes   
asyncore.file_dispatcher
Methods   
handle_read
log
writable
  handle_read  
handle_read ( self )

  log  
log ( self,  *ignore )

  writable  
writable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/monitor_client_win32.py.html0100600000176200017510000001213307306455635026612 0ustar dhellmanndevel Module: monitor_client_win32

Table of Contents

Module: monitor_client_win32 Zope-2-CVS-src/ZServer/medusa/monitor_client_win32.py

Imported modules   
import md5
import regsub
import socket
import string
import sys
import thread
Functions   
hex_digest
reader
writer
  hex_digest  
hex_digest ( s )

  reader  
reader (
        lock,
        sock,
        password,
        )

  writer  
writer (
        lock,
        sock,
        barrel="just kidding",
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/script_handler_demo/0040700000176200017510000000000007306455636025235 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/script_handler_demo/persistent.py.html0100600000176200017510000000753107306455635030756 0ustar dhellmanndevel Module: persistent

Table of Contents

Module: persistent Zope-2-CVS-src/ZServer/medusa/script_handler_demo/persistent.py

Imported modules   
import string
Functions   
html_clean
main
  html_clean  
html_clean ( s )

  main  
main ( request )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/script_handler_demo/start_demo.py.html0100600000176200017510000000432407306455636030715 0ustar dhellmanndevel Module: start_demo

Table of Contents

Module: start_demo Zope-2-CVS-src/ZServer/medusa/script_handler_demo/start_demo.py

Imported modules   
import asyncore
import filesys
import http_server
import persistent
import script_handler

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/producers.py.html0100600000176200017510000001222607306455636024555 0ustar dhellmanndevel Module: producers

Table of Contents

Module: producers Zope-2-CVS-src/ZServer/medusa/producers.py

A collection of producers. Each producer implements a particular feature: They can be combined in various ways to get interesting and useful behaviors.

For example, you can feed dynamically-produced output into the compressing producer, then wrap this with the chunked transfer-encoding producer.

Imported modules   
import string
Classes   
buffer_list_producer

producer for a list of buffers

chunked_producer

A producer that implements the chunked transfer coding for HTTP/1.1.

composite_producer

combine a fifo of producers into one

compressed_producer

Compress another producer on-the-fly, using ZLIB

escaping_producer

A producer that escapes a sequence of characters

file_producer

producer wrapper for file[-like] objects

globbing_producer

glob' the output from a producer into a particular buffer size.

hooked_producer

A producer that will call <function> when it empties,.

lines_producer

producer for a list of lines

output_producer

Acts like an output file; suitable for capturing sys.stdout

scanning_producer

like simple_producer, but more efficient for large strings

simple_producer

producer for a string

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/producers_buffer_list_producer.py.html0100600000176200017510000000624407306455635031046 0ustar dhellmanndevel Class: buffer_list_producer

Table of Contents

Class: buffer_list_producer Zope-2-CVS-src/ZServer/medusa/producers.py

producer for a list of buffers

Methods   
__init__
more
  __init__  
__init__ ( self,  buffers )

  more  
more ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/producers_chunked_producer.py.html0100600000176200017510000000674507306455635030171 0ustar dhellmanndevel Class: chunked_producer

Table of Contents

Class: chunked_producer Zope-2-CVS-src/ZServer/medusa/producers.py

A producer that implements the chunked transfer coding for HTTP/1.1. Here is a sample usage: request['Transfer-Encoding'] = chunked request.push ( producers.chunked_producer (your_producer) ) request.done()

Methods   
__init__
more
  __init__  
__init__ (
        self,
        producer,
        footers=None,
        )

  more  
more ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/producers_composite_producer.py.html0100600000176200017510000000625007306455635030541 0ustar dhellmanndevel Class: composite_producer

Table of Contents

Class: composite_producer Zope-2-CVS-src/ZServer/medusa/producers.py

combine a fifo of producers into one

Methods   
__init__
more
  __init__  
__init__ ( self,  producers )

  more  
more ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/producers_compressed_producer.py.html0100600000176200017510000000644507306455635030711 0ustar dhellmanndevel Class: compressed_producer

Table of Contents

Class: compressed_producer Zope-2-CVS-src/ZServer/medusa/producers.py

Compress another producer on-the-fly, using ZLIB [Unfortunately, none of the current browsers seem to support this]

Methods   
__init__
more
  __init__  
__init__ (
        self,
        producer,
        level=5,
        )

  more  
more ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/producers_escaping_producer.py.html0100600000176200017510000000637407306455635030337 0ustar dhellmanndevel Class: escaping_producer

Table of Contents

Class: escaping_producer Zope-2-CVS-src/ZServer/medusa/producers.py

A producer that escapes a sequence of characters

Methods   
__init__
more
  __init__  
__init__ (
        self,
        producer,
        esc_from='\r\n.',
        esc_to='\r\n..',
        )

  more  
more ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/producers_file_producer.py.html0100600000176200017510000000623507306455635027461 0ustar dhellmanndevel Class: file_producer

Table of Contents

Class: file_producer Zope-2-CVS-src/ZServer/medusa/producers.py

producer wrapper for file[-like] objects

Methods   
__init__
more
  __init__  
__init__ ( self,  file )

  more  
more ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/producers_globbing_producer.py.html0100600000176200017510000000657507306455636030335 0ustar dhellmanndevel Class: globbing_producer

Table of Contents

Class: globbing_producer Zope-2-CVS-src/ZServer/medusa/producers.py

glob the output from a producer into a particular buffer size. helps reduce the number of calls to send(). [this appears to gain about 30% performance on requests to a single channel]

Methods   
__init__
more
  __init__  
__init__ (
        self,
        producer,
        buffer_size=1,
        )

  more  
more ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/producers_hooked_producer.py.html0100600000176200017510000000651307306455636030013 0ustar dhellmanndevel Class: hooked_producer

Table of Contents

Class: hooked_producer Zope-2-CVS-src/ZServer/medusa/producers.py

A producer that will call <function> when it empties,. with an argument of the number of bytes produced. Useful for logging/instrumentation purposes.

Methods   
__init__
more
  __init__  
__init__ (
        self,
        producer,
        function,
        )

  more  
more ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/producers_lines_producer.py.html0100600000176200017510000000747107306455636027660 0ustar dhellmanndevel Class: lines_producer

Table of Contents

Class: lines_producer Zope-2-CVS-src/ZServer/medusa/producers.py

producer for a list of lines

Methods   
__init__
more
ready
  __init__  
__init__ ( self,  lines )

  more  
more ( self )

  ready  
ready ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/producers_output_producer.py.html0100600000176200017510000001635207306455636030104 0ustar dhellmanndevel Class: output_producer

Table of Contents

Class: output_producer Zope-2-CVS-src/ZServer/medusa/producers.py

Acts like an output file; suitable for capturing sys.stdout

Methods   
__init__
flush
more
ready
softspace
write
writeline
writelines
  __init__  
__init__ ( self )

  flush  
flush ( self )

  more  
more ( self )

  ready  
ready ( self )

  softspace  
softspace ( self,  *args )

  write  
write ( self,  data )

  writeline  
writeline ( self,  line )

  writelines  
writelines ( self,  lines )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/producers_scanning_producer.py.html0100600000176200017510000000635107306455636030342 0ustar dhellmanndevel Class: scanning_producer

Table of Contents

Class: scanning_producer Zope-2-CVS-src/ZServer/medusa/producers.py

like simple_producer, but more efficient for large strings

Methods   
__init__
more
  __init__  
__init__ (
        self,
        data,
        buffer_size=1024,
        )

  more  
more ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/producers_simple_producer.py.html0100600000176200017510000000630007306455636030025 0ustar dhellmanndevel Class: simple_producer

Table of Contents

Class: simple_producer Zope-2-CVS-src/ZServer/medusa/producers.py

producer for a string

Methods   
__init__
more
  __init__  
__init__ (
        self,
        data,
        buffer_size=1024,
        )

  more  
more ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/demo/0040700000176200017510000000000007306455636022154 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/demo/publish.py.html0100600000176200017510000000441007306455636025135 0ustar dhellmanndevel Module: publish

Table of Contents

Module: publish Zope-2-CVS-src/ZServer/medusa/demo/publish.py

Imported modules   
import asyncore
import auth_handler
import default_handler
import filesys
import http_server
import put_handler

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/put_handler.py.html0100600000176200017510000000570007306455636025053 0ustar dhellmanndevel Module: put_handler

Table of Contents

Module: put_handler Zope-2-CVS-src/ZServer/medusa/put_handler.py

Imported modules   
import default_handler
import re
import string
Classes   
put_collector
put_handler

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/put_handler_put_collector.py.html0100600000176200017510000001004307306455636030005 0ustar dhellmanndevel Class: put_collector

Table of Contents

Class: put_collector Zope-2-CVS-src/ZServer/medusa/put_handler.py

Methods   
__init__
collect_incoming_data
found_terminator
  __init__  
__init__ (
        self,
        file,
        length,
        request,
        is_update,
        )

  collect_incoming_data  
collect_incoming_data ( self,  data )

  found_terminator  
found_terminator ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/put_handler_put_handler.py.html0100600000176200017510000000766707306455636027456 0ustar dhellmanndevel Class: put_handler

Table of Contents

Class: put_handler Zope-2-CVS-src/ZServer/medusa/put_handler.py

Methods   
__init__
handle_request
match
  __init__  
__init__ (
        self,
        filesystem,
        uri_regex,
        )

  handle_request  
handle_request ( self,  request )

  match  
match ( self,  request )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/redirecting_handler.py.html0100600000176200017510000000536307306455636026547 0ustar dhellmanndevel Module: redirecting_handler

Table of Contents

Module: redirecting_handler Zope-2-CVS-src/ZServer/medusa/redirecting_handler.py

Imported modules   
import counter
import re
Classes   
redirecting_handler

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/redirecting_handler_redirecting_handler.py.html0100600000176200017510000001251307306455636032616 0ustar dhellmanndevel Class: redirecting_handler

Table of Contents

Class: redirecting_handler Zope-2-CVS-src/ZServer/medusa/redirecting_handler.py

Methods   
__init__
__repr__
handle_request
match
status
  __init__  
__init__ (
        self,
        pattern,
        redirect,
        regex_flag=re.IGNORECASE,
        )

  __repr__  
__repr__ ( self )

  handle_request  
handle_request ( self,  request )

  match  
match ( self,  request )

  status  
status ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/resolver.py.html0100600000176200017510000002214307306455636024407 0ustar dhellmanndevel Module: resolver

Table of Contents

Module: resolver Zope-2-CVS-src/ZServer/medusa/resolver.py

Imported modules   
import asyncore
from counter import counter
import socket
import string
import sys
import time
Functions   
fast_address_request
fast_ptr_request
skip_name
unpack_address_reply
unpack_name
unpack_ptr_reply
unpack_ttl
  fast_address_request  
fast_address_request ( host,  id=0 )

build a DNS address request, quickly

  fast_ptr_request  
fast_ptr_request ( host,  id=0 )

  skip_name  
skip_name ( r,  pos )

  unpack_address_reply  
unpack_address_reply ( r )

  unpack_name  
unpack_name ( r,  pos )

  unpack_ptr_reply  
unpack_ptr_reply ( r )

  unpack_ttl  
unpack_ttl ( r,  pos )

Classes   
caching_resolver

Cache DNS queries. Will need to honor the TTL value in the replies

hooked_callback
rbl
resolver

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/resolver_caching_resolver.py.html0100600000176200017510000001416707306455636030013 0ustar dhellmanndevel Class: caching_resolver

Table of Contents

Class: caching_resolver Zope-2-CVS-src/ZServer/medusa/resolver.py

Cache DNS queries. Will need to honor the TTL value in the replies

Base Classes   
resolver
    asyncore.dispatcher
Methods   
__init__
callback_hook
resolve
resolve_ptr
status
  __init__  
__init__ ( *args )

  callback_hook  
callback_hook (
        self,
        host,
        ttl,
        answer,
        )

  resolve  
resolve (
        self,
        host,
        callback,
        )

  resolve_ptr  
resolve_ptr (
        self,
        host,
        callback,
        )

  status  
status ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/resolver_hooked_callback.py.html0100600000176200017510000000634607306455636027563 0ustar dhellmanndevel Class: hooked_callback

Table of Contents

Class: hooked_callback Zope-2-CVS-src/ZServer/medusa/resolver.py

Methods   
__call__
__init__
  __call__  
__call__ ( self,  *args )

  __init__  
__init__ (
        self,
        hook,
        callback,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/resolver_rbl.py.html0100600000176200017510000000770607306455636025256 0ustar dhellmanndevel Class: rbl

Table of Contents

Class: rbl Zope-2-CVS-src/ZServer/medusa/resolver.py

Base Classes   
resolver
    asyncore.dispatcher
Methods   
check_reply
resolve_maps
  check_reply  
check_reply ( self,  r )

  resolve_maps  
resolve_maps (
        self,
        host,
        callback,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/resolver_resolver.py.html0100600000176200017510000002307407306455636026334 0ustar dhellmanndevel Class: resolver

Table of Contents

Class: resolver Zope-2-CVS-src/ZServer/medusa/resolver.py

Base Classes   
asyncore.dispatcher
Methods   
__init__
get_id
handle_close
handle_error
handle_read
log
reap
resolve
resolve_ptr
writable
  __init__  
__init__ ( self,  server='127.0.0.1' )

  get_id  
get_id ( self )

  handle_close  
handle_close ( self )

  handle_error  
handle_error ( self )

  handle_read  
handle_read ( self )

  log  
log ( self,  *args )

  reap  
reap ( self )

  resolve  
resolve (
        self,
        host,
        callback,
        )

  resolve_ptr  
resolve_ptr (
        self,
        host,
        callback,
        )

  writable  
writable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/rpc_client.py.html0100600000176200017510000001401107306455636024663 0ustar dhellmanndevel Module: rpc_client

Table of Contents

Module: rpc_client Zope-2-CVS-src/ZServer/medusa/rpc_client.py

Imported modules   
import asynchat
import errno
import exceptions
import fifo
import marshal
import select
import socket
import string
import sys
import time
import types
Functions   
fastrpc_connect
rpc_connect
  fastrpc_connect  
fastrpc_connect ( address=( 'localhost', 8748 ) )

  rpc_connect  
rpc_connect ( address=( 'localhost', 8746 ) )

Classes   
RPC_Error
async_fastrpc_client
fastrpc_proxy
rpc_connection
rpc_proxy

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/rpc_client_RPC_Error.py.html0100600000176200017510000000365307306455636026552 0ustar dhellmanndevel Class: RPC_Error

Table of Contents

Class: RPC_Error Zope-2-CVS-src/ZServer/medusa/rpc_client.py

Base Classes   
exceptions.StandardError

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/rpc_client_async_fastrpc_client.py.html0100600000176200017510000002025407306455636031146 0ustar dhellmanndevel Class: async_fastrpc_client

Table of Contents

Class: async_fastrpc_client Zope-2-CVS-src/ZServer/medusa/rpc_client.py

Base Classes   
asynchat.async_chat
Methods   
__init__
call_method
close
collect_incoming_data
flush_pending_requests
found_terminator
handle_connect
log
  __init__  
__init__ ( self,  address=( 'idb', 3001 ) )

  call_method  
call_method (
        self,
        method,
        args,
        callback,
        )

  close  
close ( self )

  collect_incoming_data  
collect_incoming_data ( self,  data )

  flush_pending_requests  
flush_pending_requests ( self,  why )

  found_terminator  
found_terminator ( self )

  handle_connect  
handle_connect ( self )

  log  
log ( self,  *args )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/rpc_client_fastrpc_proxy.py.html0100600000176200017510000001243607306455636027657 0ustar dhellmanndevel Class: fastrpc_proxy

Table of Contents

Class: fastrpc_proxy Zope-2-CVS-src/ZServer/medusa/rpc_client.py

Methods   
__getattr__
__init__
__method_caller__
__repr__
  __getattr__  
__getattr__ ( self,  attr )

  __init__  
__init__ (
        self,
        conn,
        path=(),
        )

  __method_caller__  
__method_caller__ ( self,  *args )

Exceptions   
RPC_Error, error
  __repr__  
__repr__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/rpc_client_rpc_connection.py.html0100600000176200017510000001112007306455636027744 0ustar dhellmanndevel Class: rpc_connection

Table of Contents

Class: rpc_connection Zope-2-CVS-src/ZServer/medusa/rpc_client.py

Methods   
__init__
connect
receive_packet
send_packet
  __init__  
__init__ ( self,  address )

  connect  
connect ( self )

  receive_packet  
receive_packet ( self )

  send_packet  
send_packet ( self,  packet )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/rpc_client_rpc_proxy.py.html0100600000176200017510000002353507306455636027003 0ustar dhellmanndevel Class: rpc_proxy

Table of Contents

Class: rpc_proxy Zope-2-CVS-src/ZServer/medusa/rpc_client.py

Methods   
__del__
__getattr__
__init__
__remote_call__
__remote_getitem__
__remote_len__
__remote_repr__
__remote_setitem__
__send_request__
__setattr__
  __del__  
__del__ ( self )

  __getattr__  
__getattr__ ( self,  attr )

  __init__  
__init__ (
        self,
        conn,
        oid,
        )

  __remote_call__  
__remote_call__ ( self,  *args )

  __remote_getitem__  
__remote_getitem__ ( self,  key )

  __remote_len__  
__remote_len__ ( self )

  __remote_repr__  
__remote_repr__ ( self )

  __remote_setitem__  
__remote_setitem__ (
        self,
        key,
        value,
        )

  __send_request__  
__send_request__ ( self,  *args )

Exceptions   
RPC_Error, value
  __setattr__  
__setattr__ (
        self,
        attr,
        value,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/rpc_server.py.html0100600000176200017510000000776007306455636024730 0ustar dhellmanndevel Module: rpc_server

Table of Contents

Module: rpc_server Zope-2-CVS-src/ZServer/medusa/rpc_server.py

Imported modules   
import asynchat
import asyncore
from counter import counter
import marshal
from producers import scanning_producer
import socket
import string
import sys
import types
Classes   
fastrpc_channel

Simple RPC server

fastrpc_server
rpc_channel

Simple RPC server.

rpc_server
rpc_server_root

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/rpc_server_fastrpc_channel.py.html0100600000176200017510000001245407306455636030136 0ustar dhellmanndevel Class: fastrpc_channel

Table of Contents

Class: fastrpc_channel Zope-2-CVS-src/ZServer/medusa/rpc_server.py

Simple RPC server

Base Classes   
asynchat.async_chat
Methods   
__init__
collect_incoming_data
found_terminator
log
  __init__  
__init__ (
        self,
        root,
        conn,
        addr,
        )

  collect_incoming_data  
collect_incoming_data ( self,  data )

  found_terminator  
found_terminator ( self )

  log  
log ( *ignore )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/rpc_server_fastrpc_server.py.html0100600000176200017510000000763207306455636030036 0ustar dhellmanndevel Class: fastrpc_server

Table of Contents

Class: fastrpc_server Zope-2-CVS-src/ZServer/medusa/rpc_server.py

Base Classes   
asyncore.dispatcher
Methods   
__init__
handle_accept
  __init__  
__init__ (
        self,
        root,
        address=( '', 8748 ),
        )

  handle_accept  
handle_accept ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/rpc_server_rpc_channel.py.html0100600000176200017510000001534407306455636027261 0ustar dhellmanndevel Class: rpc_channel

Table of Contents

Class: rpc_channel Zope-2-CVS-src/ZServer/medusa/rpc_server.py

Simple RPC server.

Base Classes   
asynchat.async_chat
Methods   
__init__
collect_incoming_data
forget_reference
found_terminator
log
new_reference
  __init__  
__init__ (
        self,
        root,
        conn,
        addr,
        )

  collect_incoming_data  
collect_incoming_data ( self,  data )

  forget_reference  
forget_reference ( self,  oid )

  found_terminator  
found_terminator ( self )

  log  
log ( self,  *ignore )

  new_reference  
new_reference ( self,  object )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/rpc_server_rpc_server.py.html0100600000176200017510000000762207306455636027157 0ustar dhellmanndevel Class: rpc_server

Table of Contents

Class: rpc_server Zope-2-CVS-src/ZServer/medusa/rpc_server.py

Base Classes   
asyncore.dispatcher
Methods   
__init__
handle_accept
  __init__  
__init__ (
        self,
        root,
        address=( '', 8746 ),
        )

  handle_accept  
handle_accept ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/rpc_server_rpc_server_root.py.html0100600000176200017510000000243307306455636030215 0ustar dhellmanndevel Class: rpc_server_root

Table of Contents

Class: rpc_server_root Zope-2-CVS-src/ZServer/medusa/rpc_server.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/script_handler.py.html0100600000176200017510000000700507306455636025547 0ustar dhellmanndevel Module: script_handler

Table of Contents

Module: script_handler Zope-2-CVS-src/ZServer/medusa/script_handler.py

Imported modules   
import StringIO
import counter
import default_handler
import producers
import re
import rexec
import string
import sys
Classes   
collector
persistent_script_handler
script_handler

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/script_handler_collector.py.html0100600000176200017510000001001607306455636027611 0ustar dhellmanndevel Class: collector

Table of Contents

Class: collector Zope-2-CVS-src/ZServer/medusa/script_handler.py

Methods   
__init__
collect_incoming_data
found_terminator
  __init__  
__init__ (
        self,
        handler,
        length,
        request,
        )

  collect_incoming_data  
collect_incoming_data ( self,  data )

  found_terminator  
found_terminator ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/script_handler_persistent_script_handler.py.html0100600000176200017510000001414207306455636033110 0ustar dhellmanndevel Class: persistent_script_handler

Table of Contents

Class: persistent_script_handler Zope-2-CVS-src/ZServer/medusa/script_handler.py

Methods   
__init__
add_module
continue_request
del_module
handle_request
match
  __init__  
__init__ ( self )

  add_module  
add_module (
        self,
        name,
        module,
        )

  continue_request  
continue_request (
        self,
        request,
        input_data,
        )

  del_module  
del_module ( self,  name )

  handle_request  
handle_request ( self,  request )

  match  
match ( self,  request )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/script_handler_script_handler.py.html0100600000176200017510000001251407306455636030631 0ustar dhellmanndevel Class: script_handler

Table of Contents

Class: script_handler Zope-2-CVS-src/ZServer/medusa/script_handler.py

Methods   
__init__
continue_request
handle_request
match
status
  __init__  
__init__ ( self,  filesystem )

  continue_request  
continue_request (
        self,
        request,
        stdin,
        )

  handle_request  
handle_request ( self,  request )

  match  
match ( self,  request )

  status  
status ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/start_medusa.py.html0100600000176200017510000000523107306455636025240 0ustar dhellmanndevel Module: start_medusa

Table of Contents

Module: start_medusa Zope-2-CVS-src/ZServer/medusa/start_medusa.py

Imported modules   
import asyncore
import chat_server
import default_handler
import filesys
import ftp_server
import http_server
import logger
import monitor
import os
import resolver
import status_handler
import sys

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/status_handler.py.html0100600000176200017510000002235607306455636025574 0ustar dhellmanndevel Module: status_handler

Table of Contents

Module: status_handler Zope-2-CVS-src/ZServer/medusa/status_handler.py

Imported modules   
import asyncore
from counter import counter
import http_server
import logger
import medusa_gif
import producers
import re
import string
import time
Functions   
english_bytes
english_time
html_repr
html_reprs
progressive_divide
sanitize
split_by_units
  english_bytes  
english_bytes ( n )

  english_time  
english_time ( n )

  html_repr  
html_repr ( object )

  html_reprs  
html_reprs (
        list,
        front='',
        back='',
        )

  progressive_divide  
progressive_divide ( n,  parts )

  sanitize  
sanitize ( s )

this really needs a full-blown quoter...

  split_by_units  
split_by_units (
        n,
        units,
        dividers,
        format_string,
        )

b,k,m,g,t

Classes   
channel_list_producer
lines_producer
logger_for_status
status_extension

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/status_handler_channel_list_producer.py.html0100600000176200017510000000633507306455636032221 0ustar dhellmanndevel Class: channel_list_producer

Table of Contents

Class: channel_list_producer Zope-2-CVS-src/ZServer/medusa/status_handler.py

Base Classes   
lines_producer
Methods   
__init__
  __init__  
__init__ ( self,  statusdir )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/status_handler_lines_producer.py.html0100600000176200017510000000751207306455636030666 0ustar dhellmanndevel Class: lines_producer

Table of Contents

Class: lines_producer Zope-2-CVS-src/ZServer/medusa/status_handler.py

Methods   
__init__
more
ready
  __init__  
__init__ ( self,  lines )

  more  
more ( self )

  ready  
ready ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/status_handler_logger_for_status.py.html0100600000176200017510000000763007306455636031402 0ustar dhellmanndevel Class: logger_for_status

Table of Contents

Class: logger_for_status Zope-2-CVS-src/ZServer/medusa/status_handler.py

Base Classes   
logger.tail_logger
Methods   
hyper_respond
status
  hyper_respond  
hyper_respond (
        self,
        sh,
        path,
        request,
        )

  status  
status ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/status_handler_status_extension.py.html0100600000176200017510000001411007306455636031260 0ustar dhellmanndevel Class: status_extension

Table of Contents

Class: status_extension Zope-2-CVS-src/ZServer/medusa/status_handler.py

Methods   
__init__
__repr__
handle_request
match
register_hyper_object
status
  __init__  
__init__ (
        self,
        objects,
        statusdir='/status',
        allow_emergency_debug=0,
        )

  __repr__  
__repr__ ( self )

  handle_request  
handle_request ( self,  request )

  match  
match ( self,  request )

  register_hyper_object  
register_hyper_object ( self,  object )

  status  
status ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/unix_user_handler.py.html0100600000176200017510000000610107306455636026260 0ustar dhellmanndevel Module: unix_user_handler

Table of Contents

Module: unix_user_handler Zope-2-CVS-src/ZServer/medusa/unix_user_handler.py

Imported modules   
import default_handler
import filesys
import os
import pwd
import re
import string
Classes   
unix_user_handler

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/unix_user_handler_unix_user_handler.py.html0100600000176200017510000001240407306455636032061 0ustar dhellmanndevel Class: unix_user_handler

Table of Contents

Class: unix_user_handler Zope-2-CVS-src/ZServer/medusa/unix_user_handler.py

Base Classes   
default_handler.default_handler
Methods   
__init__
__repr__
handle_request
match
  __init__  
__init__ ( self,  public_html='public_html' )

  __repr__  
__repr__ ( self )

  handle_request  
handle_request ( self,  request )

  match  
match ( self,  request )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/virtual_handler.py.html0100600000176200017510000000620007306455636025725 0ustar dhellmanndevel Module: virtual_handler

Table of Contents

Module: virtual_handler Zope-2-CVS-src/ZServer/medusa/virtual_handler.py

Imported modules   
import default_handler
import re
import socket
Classes   
virtual_handler

HTTP request handler for an HTTP/1.0-style virtual host. Each

virtual_handler_with_host

HTTP request handler for HTTP/1.1-style virtual hosts. This

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/virtual_handler_virtual_handler.py.html0100600000176200017510000001261307306455636031175 0ustar dhellmanndevel Class: virtual_handler

Table of Contents

Class: virtual_handler Zope-2-CVS-src/ZServer/medusa/virtual_handler.py

HTTP request handler for an HTTP/1.0-style virtual host. Each Virtual host must have a different IP

Methods   
__init__
__repr__
handle_request
match
  __init__  
__init__ (
        self,
        handler,
        hostname,
        )

Exceptions   
ValueError, "Virtual Hostname %s does not appear to be registered in the DNS" % hostname
  __repr__  
__repr__ ( self )

  handle_request  
handle_request ( self,  request )

  match  
match ( self,  request )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/virtual_handler_virtual_handler_with_host.py.html0100600000176200017510000001160707306455636033267 0ustar dhellmanndevel Class: virtual_handler_with_host

Table of Contents

Class: virtual_handler_with_host Zope-2-CVS-src/ZServer/medusa/virtual_handler.py

HTTP request handler for HTTP/1.1-style virtual hosts. This matches by checking the value of the Host header in the request. You actually don't have to support HTTP/1.1 to use this, since many browsers now send the Host header. This is a Good Thing.

Methods   
__init__
__repr__
handle_request
match
  __init__  
__init__ (
        self,
        handler,
        hostname,
        )

  __repr__  
__repr__ ( self )

  handle_request  
handle_request ( self,  request )

  match  
match ( self,  request )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/xmlrpc_handler.py.html0100600000176200017510000000602307306455636025547 0ustar dhellmanndevel Module: xmlrpc_handler

Table of Contents

Module: xmlrpc_handler Zope-2-CVS-src/ZServer/medusa/xmlrpc_handler.py

Imported modules   
import http_server
import string
import sys
import xmlrpclib
Classes   
collector

gathers input for POST and PUT requests

xmlrpc_handler

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/xmlrpc_handler_collector.py.html0100600000176200017510000000777507306455636027634 0ustar dhellmanndevel Class: collector

Table of Contents

Class: collector Zope-2-CVS-src/ZServer/medusa/xmlrpc_handler.py

gathers input for POST and PUT requests

Methods   
__init__
collect_incoming_data
found_terminator
  __init__  
__init__ (
        self,
        handler,
        request,
        )

  collect_incoming_data  
collect_incoming_data ( self,  data )

  found_terminator  
found_terminator ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/xmlrpc_handler_xmlrpc_handler.py.html0100600000176200017510000001250407306455636030632 0ustar dhellmanndevel Class: xmlrpc_handler

Table of Contents

Class: xmlrpc_handler Zope-2-CVS-src/ZServer/medusa/xmlrpc_handler.py

Methods   
call
continue_request
handle_request
match
  call  
call (
        self,
        method,
        params,
        )

Exceptions   
"NotYetImplemented"
  continue_request  
continue_request (
        self,
        data,
        request,
        )

  handle_request  
handle_request ( self,  request )

  match  
match ( self,  request )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/ANNOUNCE.txt.html0100600000176200017510000000740607306455637024151 0ustar dhellmanndevel Zope2 CVS with ZEO: ZServer.medusa

Table of Contents

Zope2 CVS with ZEO: ZServer.medusa  

-----BEGIN PGP SIGNED MESSAGE-----

I am proud to announce the first alpha release of Medusa.

Medusa is a server platform - it provides a framework for implementing asynchronous socket-based servers (tcp/ip and on unix, unix domain sockets).

An asynchronous socket server is a server that can communicate with many other socket clients and servers simultaneously, by multiplexing I/O within a single process/thread. In the context of an HTTP server, this means a single process can serve hundreds or even thousands of clients, depending only on the operating system's configuration and limitations.

There are several advantages to this approach:

  • performance - no fork() or thread() start-up costs per hit.

  • scalability - the overhead per client can be kept rather small, on the order of several kilobytes of memory.

  • persistence - a single-process server can easily coordinate the actions of several different connections. This makes things like proxy servers and gateways easy to implement. It also makes it possible to share resources like database handles.

This first release of Medusa includes HTTP, FTP, and monitor (remote python interpreter) servers. Medusa can simultaneously support several instances of either the same or different server types - for example you could start up two HTTP servers, an FTP server, and a monitor server. Then you could connect to the monitor server to control and manipulate medusa while it is running.

Other servers and clients have been written (SMTP, POP3, NNTP), and several are in the planning stages. [One particularly interesting side-project is an integrated asynchronous mSQL client.]

I am distributing Medusa under a free for non-commercial use license. Python source code is included.

Medusa has not yet been placed under a real-world load, such an environment is difficult to simulate. I am very interested in all feedback about Medusa's performance, but especially so for high-load situations (greater than 1 hit/sec).

More information is available at:

http://www.nightmare.com/medusa/

  • -Sam rushing@nightmare.com

-----BEGIN PGP SIGNATURE----- Version: 2.6.2 Comment: Processed by Mailcrypt 3.4, an Emacs/PGP interface

iQCVAwUBMv/2OGys8OGgJmJxAQGUyAQAgL+LMgz1nVEDzYvx6NROcRU5oMSNMQPG 4aUdZ3lMthAgfCrQ9bipVMtR2ouUeluC8qlZeaaeoT+mnMi5svoURZpAfCv0tIc4 CYfO6Ih8B1xaXaGC/ygRgIqN2alUXmyZmVoVxtAj6uFczP27i8QQ/3mSWLv7OskL 9Qg6fNo2Zg4= =3anM -----END PGP SIGNATURE-----

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/medusa/ANNOUNCE_970922.txt.html0100600000176200017510000001530107306455637024776 0ustar dhellmanndevel Zope2 CVS with ZEO: ZServer.medusa

Table of Contents

Zope2 CVS with ZEO: ZServer.medusa  

This is a major update of Medusa. Almost everything has been rewritten; the web server has been rewritten from scratch twice. [ain't Python nice. 8^) ]

Here is a quick rundown of the improvements and new features:

HTTP Server:

Good support for persistent connections (HTTP/1.0 and 1.1) required a redesign of the request-handling mechanism. Requests are now separate objects, and as much as possible differences between the two protocol versions have been hidden from the user. [I should say 'extender'].

HTTP/1.0 persistence is provided via the Connection: Keep-Alive mechanism supported by most currently available browsers.

HTTP/1.1 default persistence is implemented, along with various features to support pipelining, including the chunked transfer encoding. [which is enabled by default in situations where the extension is providing data dynamically]

[a note on a change in terminology: extensions are now 'handlers']

Sample request handlers for the basic authentication scheme and the PUT method are provided, along with a demonstration of a publishing interface - this allows the server to support updatable web pages.

A sample handler for unix user directories (the familiar ~user/ URI) is included.

The new handler mechanism is quite general and powerful: It is easy to write handlers that wrap other handlers to provide combined behavior. (For example, the publishing demo wraps an authentication handler around a PUT handler to provide authentication for page updates).

Sophisticated Logging: A few different logging objects are implemented:

An implementation of the Unix syslog is included: it understands the syslog protocol natively, and can thus log asynchronously to either the local host, or to a remote host. This means it will also work on non-unix platforms.

A socket logger: send log info directly to a network connection. A file logger: log into any file object.

The above logging objects can be combined using the multi logger.

DNS resolver: A simple asynchronous caching DNS resolver is included - this piggybacks off of a known name server. The resolver is currently used to provide resolved hostnames for logging for the other servers.

Monitor server: This is a remote interpreter server. Server administrators can use this to get directly at the server WHILE IT IS RUNNING. I use it to upgrade pieces of the server, or to install or remove handlers `on the fly'. It is optionally protected by an MD5-based challenge- response authentication, and by a stream-cipher encryption. Encryption is available if you have access to the Python Cryptography Toolkit, or something like it.

It's been difficult to convey the power and convenience of this server: Anything that can be done from a python prompt can be done while connected to it. It is also a tremendous aid when debugging servers or extensions.

Chat server: For reasons I won't pretend to understand, servers supporting IRC-like chat rooms of various types are quite popular in the commercial world: This is a quick demonstration of how to write such a server, and how to integrate it with medusa. This simple example could easily be integrated into the web server to provide a web-navigated, web-administered chat server.

That was the good news, here's the bad : ==================================================

I've ditched the command-line interface for the time being. In order to make it sufficiently powerful I found myself inventing yet another configuration language. This seemed rather silly given python's innate ability to handle such things. So now medusa is driven by a user script. A sample script is provided with judicious commentary.

Probably the most glaring omission in Medusa is the lack of CGI support. I have dropped this for several reasons:

  1. it is unreasonably difficult to support in a portable fashion 2) it is clearly a hack in the worst sense of the word; insecure and inefficient. why not just use inetd? 3) much more powerful things can be done within the framework of Medusa with much less effort. 4) CGI can easily be provided using Apache or any other web server by running it in tandem with medusa [i.e., on another port].

If someone desperately needs the CGI support, I can explain how to integrate it with Medusa - the code is not very different from the module included with the Python library.

==================================================

Medusa is provided free of charge for non-commercial use. Commercial use requires a license (US$200). Source code is included (it's called "The Documentation"), and users are encouraged to develop and distribute their own extensions under their own terms.

Note that the core of Medusa is an asynchronous socket library that is distributed under a traditional Python copyright, so unless you're plugging directly into medusa's higher-level servers, and doing so for commercial purposes, you needn't worry about me getting Run Over By a Bus.

More information is available from:

http://www.nightmare.com/medusa/

Enjoy!

-Sam Rushing rushing@nightmare.com

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:46 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/DebugLogger.py.html0100600000176200017510000000777007306455637023470 0ustar dhellmanndevel Module: DebugLogger

Table of Contents

Module: DebugLogger Zope-2-CVS-src/ZServer/DebugLogger.py

Imported modules   
import thread
import time
Functions   
log
  log  
log ( *args )

Classes   
DebugLogger

Logs debugging information about how ZServer is handling requests

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/DebugLogger_DebugLogger.py.html0100600000176200017510000000771507306455637025735 0ustar dhellmanndevel Class: DebugLogger

Table of Contents

Class: DebugLogger Zope-2-CVS-src/ZServer/DebugLogger.py

Logs debugging information about how ZServer is handling requests and responses. This log can be used to help locate troublesome requests.

The format is:

<code> <request id> <time> <data>

where:

code is B for begin, I for received input, A for received output, E for sent output.

request id is a unique request id.

time is the time in GMT ISO format.

data is the HTTP method and the PATH INFO for B, the size of the input for I, the HTTP status code and the size of the output for A, or nothing for E.

Note: This facility will be probably be adapted to the zLOG framework.

Methods   
__init__
log
  __init__  
__init__ ( self,  filename )

  log  
log (
        self,
        code,
        request_id,
        data='',
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/FCGIServer.py.html0100600000176200017510000001312607306455637023171 0ustar dhellmanndevel Module: FCGIServer

Table of Contents

Module: FCGIServer Zope-2-CVS-src/ZServer/FCGIServer.py

ZServer/Medusa FastCGI server, by Robin Dunn.

Accepts connections from a FastCGI enabled webserver, receives request info using the FastCGi protocol, and then hands the request off to ZPublisher for processing. The response is then handed back to the webserver to send down to the browser.

See http://www.fastcgi.com/fcgi-devkit-2.1/doc/fcgi-spec.html for the protocol specificaition.

Imported modules   
import DebugLogger
from Producers import ShutdownProducer, LoggingProducer, file_part_producer, file_close_producer
from PubCore import handle
from PubCore.ZEvent import Wakeup
from ZPublisher.HTTPRequest import HTTPRequest
from ZPublisher.HTTPResponse import HTTPResponse
from ZServer import CONNECTION_LIMIT, requestCloseOnExec
import asynchat
import asyncore
from cStringIO import StringIO
from medusa import logger
from medusa.counter import counter
from medusa.http_server import compute_timezone_for_log
import os
import socket
import string
import sys
from tempfile import TemporaryFile
import thread
import time
from types import StringType
Classes   
FCGIChannel

Process a FastCGI connection. This class implements most of the

FCGIPipe

This class acts like a file and is used to catch stdout/stderr

FCGIRecord

This class represents the various record structures used in the

FCGIResponse
FCGIServer

Listens for and accepts FastCGI requests and hands them off to a

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/FCGIServer_FCGIChannel.py.html0100600000176200017510000003115607306455637025255 0ustar dhellmanndevel Class: FCGIChannel

Table of Contents

Class: FCGIChannel Zope-2-CVS-src/ZServer/FCGIServer.py

Process a FastCGI connection. This class implements most of the Application Server side of the protocol defined in http://www.fastcgi.com/fcgi-devkit-2.1/doc/fcgi-spec.html (which is the FastCGI Specification 1.0 from Open Market, Inc.) in a manner that is compatible with the asyncore medusa engine of ZServer.

The main ommission from the spec is support for multiplexing multiple requests on a single connection, but since none of the web servers support it (that I know of,) and since ZServer can easily multiplex multiple connections in the same process, it's no great loss.

Base Classes   
asynchat.async_chat
Methods   
__init__
close
collect_incoming_data
found_terminator
handleManagementTypes
log_request
push
readable
sendDataRecord
sendEndRecord
 sendStreamTerminator
send_response
setInitialState
  __init__  
__init__ (
        self,
        server,
        sock,
        addr,
        )

  close  
close ( self )

  collect_incoming_data  
collect_incoming_data ( self,  data )

  found_terminator  
found_terminator ( self )

  handleManagementTypes  
handleManagementTypes ( self,  rec )

The web server has asked us what features we support...

  log_request  
log_request ( self,  bytes )

  push  
push (
        self,
        producer,
        send=1,
        )

  readable  
readable ( self )

  sendDataRecord  
sendDataRecord (
        self,
        data,
        recType,
        )

  sendEndRecord  
sendEndRecord ( self,  appStatus=0 )

  sendStreamTerminator  
sendStreamTerminator ( self,  recType )

  send_response  
send_response ( self )

Create output pipes, request, and response objects. Give them to ZPublisher for processing.

  setInitialState  
setInitialState ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/FCGIServer_FCGIPipe.py.html0100600000176200017510000000774107306455637024605 0ustar dhellmanndevel Class: FCGIPipe

Table of Contents

Class: FCGIPipe Zope-2-CVS-src/ZServer/FCGIServer.py

This class acts like a file and is used to catch stdout/stderr from ZPublisher and create FCGI records out of the data stream to send back to the web server.

Methods   
__init__
close
write
  __init__  
__init__ (
        self,
        channel,
        recType,
        )

  close  
close ( self )

  write  
write ( self,  data )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/FCGIServer_FCGIRecord.py.html0100600000176200017510000002063707306455637025125 0ustar dhellmanndevel Class: FCGIRecord

Table of Contents

Class: FCGIRecord Zope-2-CVS-src/ZServer/FCGIServer.py

This class represents the various record structures used in the FastCGI protocol. It knows how to read and build itself bits at a time as they are read from the FCGIChannel. There are really several different record types but in this case subclassing for each type is probably overkill.

See the FastCGI spec for structure and other details for all these record types.

Methods   
__init__
getRecordAsString
gotPadding
needContent
needMore
needPadding
parseContent
readPair
writePair
  __init__  
__init__ ( self,  header=None )

  getRecordAsString  
getRecordAsString ( self )

Format the record to be sent back to the web server.

  gotPadding  
gotPadding ( self )

  needContent  
needContent ( self )

  needMore  
needMore ( self )

  needPadding  
needPadding ( self )

  parseContent  
parseContent ( self,  data )

  readPair  
readPair (
        self,
        st,
        pos,
        )

Read the next name-value pair from st at pos.

  writePair  
writePair ( name,  value )

Opposite of readPair

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/FCGIServer_FCGIResponse.py.html0100600000176200017510000001074707306455637025506 0ustar dhellmanndevel Class: FCGIResponse

Table of Contents

Class: FCGIResponse Zope-2-CVS-src/ZServer/FCGIServer.py

Base Classes   
HTTPResponse
Methods   
_finish
setChannel
write
  _finish  
_finish ( self )

  setChannel  
setChannel ( self,  channel )

  write  
write ( self,  data )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/FCGIServer_FCGIServer.py.html0100600000176200017510000001627007306455637025153 0ustar dhellmanndevel Class: FCGIServer

Table of Contents

Class: FCGIServer Zope-2-CVS-src/ZServer/FCGIServer.py

Listens for and accepts FastCGI requests and hands them off to a FCGIChannel for handling.

FCGIServer can be configured to listen on either a specific port (for inet sockets) or socket_file (for unix domain sockets.)

For inet sockets, the ip argument specifies the address from which the server will accept connections, '' indicates all addresses. If you only want to accept connections from the localhost, set ip to 127.0.0.1.

Base Classes   
asyncore.dispatcher
Methods   
__init__
create_socket
handle_accept
listen
readable
writable
  __init__  
__init__ (
        self,
        module='Main',
        ip='127.0.0.1',
        port=None,
        socket_file=None,
        resolver=None,
        logger_object=None,
        )

  create_socket  
create_socket (
        self,
        family,
        type,
        )

  handle_accept  
handle_accept ( self )

  listen  
listen ( self,  num )

  readable  
readable ( self )

  writable  
writable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/FTPRequest.py.html0100600000176200017510000000621307306455637023273 0ustar dhellmanndevel Module: FTPRequest

Table of Contents

Module: FTPRequest Zope-2-CVS-src/ZServer/FTPRequest.py

FTP Request class for FTP server.

The FTP Request does the dirty work of turning an FTP request into something that ZPublisher can understand.

Imported modules   
from ZPublisher.HTTPRequest import HTTPRequest
from base64 import encodestring
from cStringIO import StringIO
import os
import re
import string
Classes   
FTPRequest

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/FTPRequest_FTPRequest.py.html0100600000176200017510000001260707306455637025361 0ustar dhellmanndevel Class: FTPRequest

Table of Contents

Class: FTPRequest Zope-2-CVS-src/ZServer/FTPRequest.py

Base Classes   
HTTPRequest
Methods   
__init__
_get_env
_join_paths
retry
  __init__  
__init__ (
        self,
        path,
        command,
        channel,
        response,
        stdin=None,
        environ=None,
        globbing=None,
        recursive=0,
        )

  _get_env  
_get_env (
        self,
        path,
        command,
        channel,
        stdin,
        )

Returns a CGI style environment

  _join_paths  
_join_paths ( self,  *args )

  retry  
retry ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/FTPResponse.py.html0100600000176200017510000001041507306455637023440 0ustar dhellmanndevel Module: FTPResponse

Table of Contents

Module: FTPResponse Zope-2-CVS-src/ZServer/FTPResponse.py

Response class for the FTP Server.

Imported modules   
from PubCore.ZEvent import Wakeup
from ZServer.HTTPResponse import ZServerHTTPResponse
from cStringIO import StringIO
import marshal
Functions   
make_response
  make_response  
make_response (
        channel,
        callback,
        *args,
        )

Classes   
CallbackPipe

Sends response object to a callback. Doesn't write anything.

FTPResponse

Response to an FTP command

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/FTPResponse_CallbackPipe.py.html0100600000176200017510000001251207306455637026032 0ustar dhellmanndevel Class: CallbackPipe

Table of Contents

Class: CallbackPipe Zope-2-CVS-src/ZServer/FTPResponse.py

Sends response object to a callback. Doesn't write anything. The callback takes place in Medusa's thread, not the request thread.

Methods   
__init__
apply
close
finish
write
  __init__  
__init__ (
        self,
        callback,
        args,
        )

  apply  
apply ( self )

  close  
close ( self )

  finish  
finish ( self,  response )

  write  
write (
        self,
        text,
        l=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/FTPResponse_FTPResponse.py.html0100600000176200017510000002145607306455637025677 0ustar dhellmanndevel Class: FTPResponse

Table of Contents

Class: FTPResponse Zope-2-CVS-src/ZServer/FTPResponse.py

Response to an FTP command

Base Classes   
ZServerHTTPResponse
Methods   
__str__
_cookie_list
_marshalledBody
appendCookie
expireCookie
getMessage
outputBody
setCookie
setMessage
  __str__  
__str__ ( self )

  _cookie_list  
_cookie_list ( self )

  _marshalledBody  
_marshalledBody ( self )

  appendCookie  
appendCookie (
        self,
        name,
        value,
        )

  expireCookie  
expireCookie (
        self,
        name,
        **kw,
        )

  getMessage  
getMessage ( self )

  outputBody  
outputBody ( self )

  setCookie  
setCookie (
        self,
        name,
        value,
        **kw,
        )

  setMessage  
setMessage ( self,  message )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/FTPServer.py.html0100600000176200017510000001765207306455637023122 0ustar dhellmanndevel Module: FTPServer

Table of Contents

Module: FTPServer Zope-2-CVS-src/ZServer/FTPServer.py

ZServer FTP Channel for use the medusa's ftp server.

FTP Service for Zope.

This server allows FTP connections to Zope. In general FTP is used to manage content. You can:

  • Create and delete Folders, Documents, Files, and Images

  • Edit the contents of Documents, Files, Images

In the future, FTP may be used to edit object properties.

FTP Protocol

The FTP protocol for Zope gives Zope objects a way to make themselves available to FTP services. See the lib/python/OFS/FTPInterface.py for more details.

FTP Permissions

FTP access is controlled by one permission: FTP access if bound to a role, users of that role will be able to list directories, and cd to them. Creating and deleting and changing objects are all governed by existing Zope permissions.

Permissions are to a certain extent reflected in the permission bits listed in FTP file listings.

FTP Authorization

Zope supports both normal and anonymous logins. It can be difficult to authorize Zope users since they are defined in distributed user databases. Normally, all logins will be accepted and then the user must proceed to cd to a directory in which they are authorized. In this case for the purpose of FTP limits, the user is considered anonymous until they cd to an authorized directory.

Optionally, users can login with a special username which indicates where they are defined. Their login will then be authenticated in the indicated directory, and they will not be considered anonymous. The form of the name is <username>@<path> where path takes the form <folder id>[/<folder id>...] For example: amos@Foo/Bar This will authenticate the user amos in the directory /Foo/Bar. In addition the user's FTP session will be rooted in the authenticated directory, i.e. they will not be able to cd out of the directory.

The main reason to use the rooted FTP login, is to allow non-anonymous logins. This may be handy, if for example, you disallow anonymous logins, or if you set the limit for simultaneous anonymous logins very low.

Imported modules   
from FTPRequest import FTPRequest
from FTPResponse import make_response
from PubCore import handle
from ZServer import CONNECTION_LIMIT, requestCloseOnExec
import asynchat
import asyncore
from cStringIO import StringIO
import marshal
from medusa import filesys
from medusa.ftp_server import ftp_channel, ftp_server, recv_channel
from mimetypes import guess_type
import os
import stat
import string
import time
Functions   
handle_close
  handle_close  
handle_close ( self )

response and closure of channel is delayed.

Classes   
ContentReceiver

Write-only file object used to receive data from FTP

FTPLimiter

Rudimentary FTP limits. Helps prevent denial of service

FTPServer

FTP server for Zope.

zope_ftp_channel

Passes its commands to Zope, not a filesystem

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/FTPServer_ContentReceiver.py.html0100600000176200017510000000757407306455637026303 0ustar dhellmanndevel Class: ContentReceiver

Table of Contents

Class: ContentReceiver Zope-2-CVS-src/ZServer/FTPServer.py

Write-only file object used to receive data from FTP

Methods   
__init__
close
write
  __init__  
__init__ (
        self,
        callback,
        *args,
        )

  close  
close ( self )

  write  
write ( self,  data )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/FTPServer_FTPLimiter.py.html0100600000176200017510000000764607306455637025163 0ustar dhellmanndevel Class: FTPLimiter

Table of Contents

Class: FTPLimiter Zope-2-CVS-src/ZServer/FTPServer.py

Rudimentary FTP limits. Helps prevent denial of service attacks. It works by limiting the number of simultaneous connections by userid. There are three limits, one for anonymous connections, and one for authenticated logins. The total number of simultaneous anonymous logins my be less than or equal to the anonymous limit. Each authenticated user can have up to the user limit number of simultaneous connections. The total limit is the maximum number of simultaneous connections of any sort. Do not set the total limit lower than or equal to the anonymous limit.

Methods   
__init__
check_limit
  __init__  
__init__ (
        self,
        anon_limit=10,
        user_limit=4,
        total_limit=25,
        )

  check_limit  
check_limit ( self,  channel )

Check to see if the user has exhausted their limit or not. Check for existing channels with the same userid and the same ftp server.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/FTPServer_FTPServer.py.html0100600000176200017510000001526007306455637025013 0ustar dhellmanndevel Class: FTPServer

Table of Contents

Class: FTPServer Zope-2-CVS-src/ZServer/FTPServer.py

FTP server for Zope.

Base Classes   
ftp_server
Methods   
__init__
create_socket
handle_accept
listen
log_info
readable
  __init__  
__init__ (
        self,
        module,
        *args,
        *kw,
        )

  create_socket  
create_socket (
        self,
        family,
        type,
        )

  handle_accept  
handle_accept ( self )

  listen  
listen ( self,  num )

  log_info  
log_info (
        self,
        message,
        type='info',
        )

  readable  
readable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/FTPServer_zope_ftp_channel.py.html0100600000176200017510000006506307306455637026517 0ustar dhellmanndevel Class: zope_ftp_channel

Table of Contents

Class: zope_ftp_channel Zope-2-CVS-src/ZServer/FTPServer.py

Passes its commands to Zope, not a filesystem

Base Classes   
ftp_channel
Methods   
__init__
_join_paths
cmd_appe
cmd_cdup
cmd_cwd
cmd_dele
cmd_list
cmd_mdtm
cmd_mkd
cmd_nlst
cmd_pass
 cmd_pwd
cmd_retr
cmd_rmd
cmd_rnfr
cmd_rnto
cmd_size
cmd_stor
cmd_user
cwd_completion
dele_completion
get_dir_list
 listdir
listdir_completion
mdtm_completion
mkd_completion
pass_completion
push
retr_completion
rmd_completion
rnto_completion
size_completion
stor_callback
  __init__  
__init__ (
        self,
        server,
        conn,
        addr,
        module,
        )

  _join_paths  
_join_paths ( self,  *args )

  cmd_appe  
cmd_appe ( self,  line )

  cmd_cdup  
cmd_cdup ( self,  line )

change to parent of current working directory

  cmd_cwd  
cmd_cwd ( self,  line )

change working directory

  cmd_dele  
cmd_dele ( self,  line )

  cmd_list  
cmd_list ( self,  line )

give list files in a directory

  cmd_mdtm  
cmd_mdtm ( self,  line )

show last modification time of file

  cmd_mkd  
cmd_mkd ( self,  line )

  cmd_nlst  
cmd_nlst ( self,  line )

give name list of files in directory

  cmd_pass  
cmd_pass ( self,  line )

specify password

  cmd_pwd  
cmd_pwd ( self,  line )

print the current working directory

  cmd_retr  
cmd_retr ( self,  line )

  cmd_rmd  
cmd_rmd ( self,  line )

  cmd_rnfr  
cmd_rnfr ( self,  line )

rename from

  cmd_rnto  
cmd_rnto ( self,  line )

  cmd_size  
cmd_size ( self,  line )

return size of file

  cmd_stor  
cmd_stor (
        self,
        line,
        mode='wb',
        )

store a file

  cmd_user  
cmd_user ( self,  line )

specify user name

  cwd_completion  
cwd_completion (
        self,
        path,
        response,
        )

cwd completion callback

  dele_completion  
dele_completion ( self,  response )

  get_dir_list  
get_dir_list (
        self,
        line,
        long=0,
        )

  listdir  
listdir (
        self,
        path,
        long=0,
        )

  listdir_completion  
listdir_completion (
        self,
        long,
        response,
        )

  mdtm_completion  
mdtm_completion ( self,  response )

  mkd_completion  
mkd_completion ( self,  response )

  pass_completion  
pass_completion (
        self,
        path,
        response,
        )

  push  
push (
        self,
        producer,
        send=1,
        )

  retr_completion  
retr_completion (
        self,
        file,
        response,
        )

  rmd_completion  
rmd_completion ( self,  response )

  rnto_completion  
rnto_completion ( self,  response )

  size_completion  
size_completion ( self,  response )

  stor_callback  
stor_callback (
        self,
        path,
        data,
        )

callback to do the STOR, after we have the input

  stor_completion  
stor_completion ( self,  response )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/HTTPResponse.py.html0100600000176200017510000001337107306455640023564 0ustar dhellmanndevel Module: HTTPResponse

Table of Contents

Module: HTTPResponse Zope-2-CVS-src/ZServer/HTTPResponse.py

ZServer HTTPResponse

The HTTPResponse class takes care of server headers, response munging and logging duties.

Imported modules   
import DebugLogger
from Producers import ShutdownProducer, LoggingProducer, CallbackProducer, file_part_producer, file_close_producer
from PubCore.ZEvent import Wakeup
from ZPublisher.HTTPResponse import HTTPResponse
import asyncore
from cStringIO import StringIO
from medusa import http_server
from medusa.http_date import build_http_date
from medusa.producers import hooked_producer
import re
import string
import sys
import tempfile
import thread
import time
from types import LongType
Functions   
make_response
  make_response  
make_response ( request,  headers )

Simple http response factory

Classes   
ChannelPipe

Experimental pipe from ZPublisher to a ZServer Channel.

ZServerHTTPResponse

Used to push data into a channel's producer fifo

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/HTTPResponse_ChannelPipe.py.html0100600000176200017510000001261207306455640026027 0ustar dhellmanndevel Class: ChannelPipe

Table of Contents

Class: ChannelPipe Zope-2-CVS-src/ZServer/HTTPResponse.py

Experimental pipe from ZPublisher to a ZServer Channel. Should only be used by one thread at a time. Note also that the channel will be being handled by another thread, thus restrict access to channel to the push method only.

Methods   
__init__
close
finish
flush
write
  __init__  
__init__ ( self,  request )

  close  
close ( self )

  finish  
finish ( self,  response )

  flush  
flush ( self )

  write  
write (
        self,
        text,
        l=None,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/HTTPResponse_ZServerHTTPResponse.py.html0100600000176200017510000001315207306455640027460 0ustar dhellmanndevel Class: ZServerHTTPResponse

Table of Contents

Class: ZServerHTTPResponse Zope-2-CVS-src/ZServer/HTTPResponse.py

Used to push data into a channel's producer fifo

Base Classes   
HTTPResponse
Methods   
__str__
_finish
retry
write
  __str__  
__str__ ( self,  html_search=re.compile( '<html>', re.I ).search )

  _finish  
_finish ( self )

  retry  
retry ( self )

Return a request object to be used in a retry attempt

  write  
write ( self,  data )

Return data as a stream

HTML data may be returned using a stream-oriented interface. This allows the browser to display partial results while computation of a response to proceed.

The published object should first set any output headers or cookies on the response object.

Note that published objects must not generate any errors after beginning stream-oriented output.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/HTTPServer.py.html0100600000176200017510000001313207306455640023227 0ustar dhellmanndevel Module: HTTPServer

Table of Contents

Module: HTTPServer Zope-2-CVS-src/ZServer/HTTPServer.py

Medusa HTTP server for Zope

changes from Medusa's http_server

Request Threads

Requests are processed by threads from a thread pool.

Output Handling

Output is pushed directly into the producer fifo by the request-handling thread. The HTTP server does not do any post-processing such as chunking.

Pipelineable

This is needed for protocols such as HTTP/1.1 in which mutiple requests come in on the same channel, before responses are sent back. When requests are pipelined, the client doesn't wait for the response before sending another request. The server must ensure that responses are sent back in the same order as requests are received.

Imported modules   
import DebugLogger
from HTTPResponse import make_response
from PubCore import handle
from ZPublisher.HTTPRequest import HTTPRequest
from ZServer import CONNECTION_LIMIT, ZOPE_VERSION, ZSERVER_VERSION, requestCloseOnExec
import asyncore
from asyncore import compact_traceback, dispatcher
from cStringIO import StringIO
from medusa import counter, producers, logger
from medusa.default_handler import unquote
from medusa.http_server import http_server, get_header, http_channel, VERSION_STRING
from medusa.test import max_sockets
import os
import re
import socket
import string
import sys
import thread
import time
import types
from zLOG import LOG, register_subsystem, BLATHER, INFO, WARNING, ERROR
Classes   
zhttp_channel

http channel

zhttp_collector
zhttp_handler

A medusa style handler for zhttp_server

zhttp_server

http server

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/HTTPServer_zhttp_channel.py.html0100600000176200017510000001501607306455640026153 0ustar dhellmanndevel Class: zhttp_channel

Table of Contents

Class: zhttp_channel Zope-2-CVS-src/ZServer/HTTPServer.py

http channel

Base Classes   
http_channel
Methods   
__init__
close
done
kill_zombies
push
work
  __init__  
__init__ (
        self,
        server,
        conn,
        addr,
        )

  close  
close ( self )

  done  
done ( self )

Called when a publishing request is finished

  kill_zombies  
kill_zombies ( self )

  push  
push (
        self,
        producer,
        send=1,
        )

  work  
work ( self )

try to handle a request

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/HTTPServer_zhttp_collector.py.html0100600000176200017510000000777607306455640026547 0ustar dhellmanndevel Class: zhttp_collector

Table of Contents

Class: zhttp_collector Zope-2-CVS-src/ZServer/HTTPServer.py

Methods   
__init__
collect_incoming_data
found_terminator
  __init__  
__init__ (
        self,
        handler,
        request,
        size,
        )

  collect_incoming_data  
collect_incoming_data ( self,  data )

put and post collection methods

  found_terminator  
found_terminator ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/HTTPServer_zhttp_handler.py.html0100600000176200017510000001534507306455640026165 0ustar dhellmanndevel Class: zhttp_handler

Table of Contents

Class: zhttp_handler Zope-2-CVS-src/ZServer/HTTPServer.py

A medusa style handler for zhttp_server

Methods   
__init__
continue_request
get_environment
handle_request
match
status
  __init__  
__init__ (
        self,
        module,
        uri_base=None,
        env=None,
        )

Creates a zope_handler

module

string, the name of the module to publish uri_base -- string, the base uri of the published module defaults to /<module name> if not given. env -- dictionary, environment variables to be overridden. Replaces standard variables with supplied ones.

  continue_request  
continue_request (
        self,
        sin,
        request,
        )

continue handling request now that we have the stdin

  get_environment  
get_environment (
        self,
        request,
        split=string.split,
        strip=string.strip,
        join=string.join,
        upper=string.upper,
        lower=string.lower,
        h2ehas=header2env.has_key,
        h2eget=header2env.get,
        workdir=os.getcwd(),
        ospath=os.path,
        )

  handle_request  
handle_request ( self,  request )

  match  
match ( self,  request )

  status  
status ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/HTTPServer_zhttp_server.py.html0100600000176200017510000001400307306455640026044 0ustar dhellmanndevel Class: zhttp_server

Table of Contents

Class: zhttp_server Zope-2-CVS-src/ZServer/HTTPServer.py

http server

Base Classes   
http_server
Methods   
__init__
create_socket
listen
log_info
readable
  __init__  
__init__ (
        self,
        ip,
        port,
        resolver=None,
        logger_object=None,
        )

  create_socket  
create_socket (
        self,
        family,
        type,
        )

  listen  
listen ( self,  num )

  log_info  
log_info (
        self,
        message,
        type='info',
        )

  readable  
readable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/PCGIServer.py.html0100600000176200017510000001273207306455640023177 0ustar dhellmanndevel Module: PCGIServer

Table of Contents

Module: PCGIServer Zope-2-CVS-src/ZServer/PCGIServer.py

Medusa PCGI server.

This server functions as the PCGI publisher--it accepts the request from the PCGI wrapper CGI program, services the request, and sends back the response.

It should work with both inet and unix domain sockets.

Why would you want to use it? Using PCGI to connect to ZServer from another webserver is similar to using the web server as a proxy, with the difference, that the web server gets to control the environment and headers completely.

Note that ZServer can operate multiple PCGI servers.

Imported modules   
import DebugLogger
from Producers import ShutdownProducer, LoggingProducer, CallbackProducer
from PubCore import handle
from PubCore.ZEvent import Wakeup
from ZPublisher.HTTPRequest import HTTPRequest
from ZPublisher.HTTPResponse import HTTPResponse
from ZServer import CONNECTION_LIMIT, requestCloseOnExec
import asynchat
import asyncore
from asyncore import compact_traceback
from cStringIO import StringIO
from medusa import logger
from medusa.counter import counter
from medusa.http_server import compute_timezone_for_log
import os
import socket
import string
import sys
from tempfile import TemporaryFile
import time
from types import StringType, TupleType
Classes   
PCGIChannel

Processes a PCGI request by collecting the env and stdin and

PCGIPipe

Formats a HTTP response in PCGI format

PCGIResponse
PCGIServer

Accepts PCGI requests and hands them off to the PCGIChannel for

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/PCGIServer_PCGIChannel.py.html0100600000176200017510000002157207306455640025274 0ustar dhellmanndevel Class: PCGIChannel

Table of Contents

Class: PCGIChannel Zope-2-CVS-src/ZServer/PCGIServer.py

Processes a PCGI request by collecting the env and stdin and then passing them to ZPublisher. The result is wrapped in a producer and sent back.

Base Classes   
asynchat.async_chat
Methods   
__init__
__repr__
close
collect_incoming_data
found_terminator
log_request
push
readable
send_response
  __init__  
__init__ (
        self,
        server,
        sock,
        addr,
        )

  __repr__  
__repr__ ( self )

  close  
close ( self )

  collect_incoming_data  
collect_incoming_data ( self,  data )

  found_terminator  
found_terminator ( self )

  log_request  
log_request ( self,  bytes )

  push  
push (
        self,
        producer,
        send=1,
        )

  readable  
readable ( self )

  send_response  
send_response ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/PCGIServer_PCGIPipe.py.html0100600000176200017510000001125107306455640024612 0ustar dhellmanndevel Class: PCGIPipe

Table of Contents

Class: PCGIPipe Zope-2-CVS-src/ZServer/PCGIServer.py

Formats a HTTP response in PCGI format

10 digits indicating len of STDOUT STDOUT 10 digits indicating len of STDERR STDERR

Note that this implementation never sends STDERR

Methods   
__init__
close
finish
write
  __init__  
__init__ ( self,  channel )

  close  
close ( self )

  finish  
finish ( self,  response )

  write  
write ( self,  text )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/PCGIServer_PCGIResponse.py.html0100600000176200017510000000743707306455640025526 0ustar dhellmanndevel Class: PCGIResponse

Table of Contents

Class: PCGIResponse Zope-2-CVS-src/ZServer/PCGIServer.py

Base Classes   
HTTPResponse
Methods   
_finish
write
  _finish  
_finish ( self )

  write  
write ( self,  data )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/PCGIServer_PCGIServer.py.html0100600000176200017510000002122007306455640025160 0ustar dhellmanndevel Class: PCGIServer

Table of Contents

Class: PCGIServer Zope-2-CVS-src/ZServer/PCGIServer.py

Accepts PCGI requests and hands them off to the PCGIChannel for handling.

PCGIServer can be configured with either a PCGI info file or by directly specifying the module, pid_file, and either port (for inet sockets) or socket_file (for unix domain sockets.)

For inet sockets, the ip argument specifies the address from which the server will accept connections, '' indicates all addresses. If you only want to accept connections from the localhost, set ip to 127.0.0.1.

Base Classes   
asyncore.dispatcher
Methods   
__init__
create_socket
handle_accept
listen
read_info
readable
writable
  __init__  
__init__ (
        self,
        module='Main',
        ip='127.0.0.1',
        port=None,
        socket_file=None,
        pid_file=None,
        pcgi_file=None,
        resolver=None,
        logger_object=None,
        )

  create_socket  
create_socket (
        self,
        family,
        type,
        )

  handle_accept  
handle_accept ( self )

  listen  
listen ( self,  num )

  read_info  
read_info ( self,  info_file )

read configuration information from a PCGI info file

Exceptions   
'ParseError', 'Error parsing PCGI info file'
  readable  
readable ( self )

  writable  
writable ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/Producers.py.html0100600000176200017510000000675607306455640023245 0ustar dhellmanndevel Module: Producers

Table of Contents

Module: Producers Zope-2-CVS-src/ZServer/Producers.py

ZServer pipe utils. These producers basically function as callbacks.

Imported modules   
import asyncore
import sys
Classes   
CallbackProducer

Performs a callback in the channel's thread

LoggingProducer

logs request

ShutdownProducer

shuts down medusa

file_close_producer
file_part_producer

producer wrapper for part of a file[-like] objects

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/Producers_CallbackProducer.py.html0100600000176200017510000000623507306455640026515 0ustar dhellmanndevel Class: CallbackProducer

Table of Contents

Class: CallbackProducer Zope-2-CVS-src/ZServer/Producers.py

Performs a callback in the channel's thread

Methods   
__init__
more
  __init__  
__init__ ( self,  callback )

  more  
more ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/Producers_LoggingProducer.py.html0100600000176200017510000000626707306455640026414 0ustar dhellmanndevel Class: LoggingProducer

Table of Contents

Class: LoggingProducer Zope-2-CVS-src/ZServer/Producers.py

logs request

Methods   
__init__
more
  __init__  
__init__ (
        self,
        logger,
        bytes,
        method='log',
        )

  more  
more ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/Producers_ShutdownProducer.py.html0100600000176200017510000000470407306455640026633 0ustar dhellmanndevel Class: ShutdownProducer

Table of Contents

Class: ShutdownProducer Zope-2-CVS-src/ZServer/Producers.py

shuts down medusa

Methods   
more
  more  
more ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/Producers_file_close_producer.py.html0100600000176200017510000000623407306455640027323 0ustar dhellmanndevel Class: file_close_producer

Table of Contents

Class: file_close_producer Zope-2-CVS-src/ZServer/Producers.py

Methods   
__init__
more
  __init__  
__init__ ( self,  file )

  more  
more ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/Producers_file_part_producer.py.html0100600000176200017510000000634607306455640027170 0ustar dhellmanndevel Class: file_part_producer

Table of Contents

Class: file_part_producer Zope-2-CVS-src/ZServer/Producers.py

producer wrapper for part of a file[-like] objects

Methods   
__init__
more
  __init__  
__init__ (
        self,
        file,
        lock,
        start,
        end,
        )

  more  
more ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/WebDAVSrcHandler.py.html0100600000176200017510000000612407306455640024302 0ustar dhellmanndevel Module: WebDAVSrcHandler

Table of Contents

Module: WebDAVSrcHandler Zope-2-CVS-src/ZServer/WebDAVSrcHandler.py

Special HTTP handler which forces GET requests to return the "source" of documents (uses manage_FTPget). Works around current WebDAV clients' failure to implement the "source-link" feature of the spec.

Imported modules   
from HTTPServer import zhttp_handler
import os
import string
Classes   
WebDAVSrcHandler

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/WebDAVSrcHandler_WebDAVSrcHandler.py.html0100600000176200017510000000630307306455640027377 0ustar dhellmanndevel Class: WebDAVSrcHandler

Table of Contents

Class: WebDAVSrcHandler Zope-2-CVS-src/ZServer/WebDAVSrcHandler.py

Base Classes   
zhttp_handler
Methods   
get_environment
  get_environment  
get_environment ( self,  request )

Munge the request to ensure that we call manage_FTPGet.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/ZService.py.html0100600000176200017510000002042607306455640023017 0ustar dhellmanndevel Module: ZService

Table of Contents

Module: ZService Zope-2-CVS-src/ZServer/ZService.py

ZServer as a NT service.

The serice starts up and monitors a ZServer process.

Features:

  • When you start the service it starts ZServer * When you stop the serivice it stops ZServer * It monitors ZServer and restarts it if it exits abnormally * If ZServer is shutdown from the web, the service stops. * If ZServer cannot be restarted, the service stops.

Usage:

Installation

The ZServer service should be installed by the Zope Windows installer. You can manually install, uninstall the service from the commandline.

ZService.py [options] install|update|remove|start [...] |stop|restart [...]|debug [...]

Options for install and update commands only:

--username domain\username : The Username the service is to run under

--password password : The password for the username

--startup [manual|auto|disabled] : How the service starts, default = manual

Commands

install : Installs the service

update : Updates the service, use this when you change ZServer.py

remove : Removes the service

start : Starts the service, this can also be done from the services control panel

stop : Stops the service, this can also be done from the services control panel

restart : Restarts the service

debug : Runs the service in debug mode

You can view the usage options by running ZServer.py without any arguments.

Note: you may have to register the Python service program first,

win32\pythonservice.exe /register

Starting Zope

Start Zope by clicking the start button in the services control panel. You can set Zope to automatically start at boot time by choosing Auto startup by clicking the statup button.

Stopping Zope

Stop Zope by clicking the stop button in the services control panel. You can also stop Zope through the web by going to the Zope control panel and by clicking Shutdown.

Event logging

Zope events are logged to the NT application event log. Use the event viewer to keep track of Zope events.

Registry Settings

You can change how the service starts ZServer by editing a registry key.

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\ <Service Name>\Parameters\start

The value of this key is the command which the service uses to start ZServer. For example:

      &quot;C:\Program Files\Zope\bin\python.exe&quot;
        &quot;C:\Program Files\Zope\z2.py&quot; -w 8888

TODO:

  • Integrate it into the Windows installer. * Add ZLOG logging in addition to event log logging. * Make it easier to run multiple Zope services with one Zope install

This script does for NT the same sort of thing zdaemon.py does for UNIX. Requires Python win32api extensions.

Imported modules   
import imp
import os
import string
import sys
import time
import win32api
import win32event
import win32process
import win32service
import win32serviceutil
Functions   
magic_import
set_start_command
  magic_import  
magic_import ( modulename,  filename )

  set_start_command  
set_start_command ( value )

sets the ZServer start command if the start command is not already set

Classes   
ZServerService

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/ZService_ZServerService.py.html0100600000176200017510000001650607306455640026024 0ustar dhellmanndevel Class: ZServerService

Table of Contents

Class: ZServerService Zope-2-CVS-src/ZServer/ZService.py

Base Classes   
win32serviceutil.ServiceFramework
Methods   
SvcDoRun
SvcStop
__init__
get_start_command
restart_zserver
start_zserver
stop_zserver
  SvcDoRun  
SvcDoRun ( self )

  SvcStop  
SvcStop ( self )

  __init__  
__init__ ( self,  args )

  get_start_command  
get_start_command ( self )

  restart_zserver  
restart_zserver ( self )

  start_zserver  
start_zserver ( self )

  stop_zserver  
stop_zserver ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/__init__.py.html0100600000176200017510000000557507306455640023034 0ustar dhellmanndevel Module: __init__

Table of Contents

Module: __init__ Zope-2-CVS-src/ZServer/__init__.py

Imported modules   
from FCGIServer import FCGIServer
from FTPServer import FTPServer
from HTTPServer import zhttp_server, zhttp_handler
from PCGIServer import PCGIServer
from PubCore import setNumberOfThreads
import asyncore
from medusa import resolver, logger
from medusa.monitor import secure_monitor_server
from medusa.test import max_sockets
import os
import sys

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/ZServer/README.txt.html0100600000176200017510000002443007306455640022410 0ustar dhellmanndevel Zope2 CVS with ZEO: ZServer

Table of Contents

Zope2 CVS with ZEO: ZServer  

ZServer README --------------

What is ZServer?

ZServer is an integration of the Zope application server and the Medusa information server. See the ZServer architecture document for more information:

    http://www.zope.org/Documentation/Reference/ZServer

ZServer gives you HTTP, FTP, WebDAV, PCGI, and remote interactive Python access. In later releases it will probably offer more protocols such as FastCGI, etc.

What is Medusa?

Medusa is a Python server framework with uses a single threaded asynchronous sockets approach. For more information see:

    http://www.nightmare.com/medusa

There's also an interesting Medusa tutorial at:

    http://www.nightmare.com:8080/nm/apps/medusa/docs/programming.html

ZServer HTTP support

ZServer offers HTTP 1.1 publishing for Zope. It does not support publishing files from the file system. You can specify the HTTP port using the -w command line argument for the z2.py start script. You can also specify CGI environment variables on the command line using z2.py

ZServer FTP support

What you can do with FTP

FTP access to Zope allows you to FTP to the Zope object hierarchy in order to perform managerial tasks. You can:

  • Navigate the object hierarchy with cd

  • Replace the content of Documents, Images, and Files

  • Create Documents, Images, Files, Folders

  • Delete objects and Folders.

So basically you can do more than is possible with HTTP PUT. Also, unlike PUT, FTP gives you access to Document content. So when you download a Document you are getting its content, not what it looks like when it is rendered.

Using FTP

To FTP into Zope, ZServer must be configured to serve FTP. By default ZServer serves FTP on port 9221. So to connect to Zope you would issue a command like so:

      $ ftp localhost 9221

When logging in to FTP, you have some choices. You can connect anonymously by using a username of anonymous and any password. Or you can login as a Zope user. Since Zope users are defined at different locations in the object hierarchy, authentication can be problematic. There are two solutions:

  • login and then cd to the directory where you are defined.

  • login with a special name that indicates where you are defined.

The format of the special name is <username>@<path>. For example:

      joe@Marketing/Projects

FTP permissions

FTP support is provided for Folders, Documents, Images, and Files. You can control access to FTP via the new FTP access permission. This permission controls the ability to cd to a Folder and to download objects. Uploading and deleting and creating objects are controlled by existing permissions.

FTP limits

You can set limits for the number of simultaneous FTP connections. You can separately configure the number of anonymous and authenticated connections. Right now this setting is set in ZServerFTP.py. In the future, it may be more easy to configure.

Properties and FTP: The next step

The next phase of FTP support will allow you to edit properties of all Zope objects. Probably properties will be exposed via special files which will contain an XML representation of the object's properties. You could then download the file, edit the XML and upload it to change the object's properties.

We do not currently have a target date for FTP property support.

How does FTP work?

The ZServer's FTP channel object translates FTP requests into ZPublisher requests. The FTP channel then analyses the response and formulates an appropriate FTP response. The FTP channel stores some state such as the current working directory and the username and password.

On the Zope side of things, the lib/python/OFS/FTPInterface.py module defines the Zope FTP interface, for listing sub-items, stating, and getting content. The interface is implemented in SimpleItem, and in other Zope classes. Programmers will not need to implement the entire interface if they inherit from SimpleItem. All the other FTP functions are handled by existing methods like manage_delObjects, and PUT, etc.

ZServer PCGI support

ZServer will service PCGI requests with both inet and unix domain sockets. This means you can use ZServer instead of pcgi_publisher.py as your long running PCGI server process. In the future, PCGI may be able to activate ZServer.

Using PCGI instead of HTTP allows you to forward requests from another web server to ZServer. The CGI environment and HTTP headers are controlled by the web server, so you don't need to worry about managing the ZServer environment. However, this configuration will impose a larger overhead than simply using the web server as an HTTP proxy for ZServer.

To use PCGI, configure your PCGI info files to communicate with ZServer by setting the PCGI_PORT, PCGI_SOCKET_FILE, and PCGI_NAME. The other PCGI settings are currently ignored by ZServer.

ZServer's PCGI support will work with mod_pcgi.

ZServer monitor server

ZServer now includes the Medusa monitor server. This basically gives you a remote, secure Python prompt. You can interactively access Zope. This is a very powerful, but dangerous tool. Be careful.

To use the monitor server specify a monitor port number using the -m option with the z2.py start script. The default port is 9999.

To connect to the monitor server use the ZServer/medusa/monitor_client.py or ZServer/medusa/monitor_client_win32.py script. For example:

    $ python1.5.2 ZServer/medusa/monitor_client.py localhost 9999

You will then be asked to enter a password. This is the Zope super manager password which is stored in the access file.

Then you will be greeted with a Python prompt. To access Zope import the Zope module:

    &gt;&gt;&gt; import Zope

The Zope top level Zope object is available via the Zope.app function:

    &gt;&gt;&gt; a=Zope.app()

From this object you can reach all other Zope objects as subobjects.

Remember if you make changes to Zope objects and want those changes to be saved you need to commmit the transaction:

    &gt;&gt;&gt; get_transaction().commit()

ZServer WebDAV support

WebDAV is a new protocol for managing web resources. WebDAV operates over HTTP. Since WebDAV uses HTTP, ZServer doesn't really have to do anything special, except stay out of Zope's way when handling WebDAV requests.

The only major WebDAV client at this time is Internet Explorer 5. It works with Zope.

Differences between ZopeHTTPServer and ZServer

ZopeHTTPServer is old and no longer being actively maintained.

Both ZopeHTTPServer and ZServer are Python HTTP servers. ZopeHTTPServer is built on the standard Python SimpleHTTPServer framework. ZServer is built on Medusa.

ZopeHTTPServer is very limited. It can only publish one module at a time. It can only publish via HTTP. It has no support for thread pools.

ZServer on the other hand is more complex and supports publishing multiple modules, thread pools, and it uses a new threaded architecture for accessing ZPublisher.

Running ZServer as nobody

Normally ZServer will run with the userid of the user who starts it. However, if ZServer is started by root, it will attempt to become nobody or any userid you specify with the -u argument to the z2.py start script.

ZServer is similar to ZopeHTTPServer in these respects.

If you run Zope with different userids you must be aware of permission issues. Zope must be able to read and write to the var directory. If you change the userid Zope is running under you will probably need to change the permissions on the var directory and the files in it in order for Zope to run under a different userid.

Support

Questions and comments should go to support@digicool.com.

You can report bugs and check on the status of bugs using the Zope bug collector:

    http://www.zope.org/Resources/Collector/

License

ZServer is covered by the ZPL despite the fact that it comes with much of the Medusa source code. The portions of Medusa that come with ZServer are licensed under the ZPL.

Outstanding issues

The FTP interface for Zope objects may be changed.

HTTP 1.1 support is ZServer is incomplete, though it should work for most HTTP 1.1 clients.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/0040700000176200017510000000000007306455646020366 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/FS.py.html0100600000176200017510000002023107306455643022205 0ustar dhellmanndevel Module: FS

Table of Contents

Module: FS Zope-2-CVS-src/utilities/FS.py

Imported modules   
from cStringIO import StringIO
import os
import pickle
from pickle import INST, GLOBAL, MARK, BUILD, OBJ, REDUCE
import string
import struct
from struct import pack, unpack
import sys
import tempfile
import time
Functions   
_global
cp
fixpickle
p64
  _global  
_global ( m,  n )

Exceptions   
'Unexpected BoboPOS class', ( m, n )
  cp  
cp (
        f1,
        f2,
        l,
        )

  fixpickle  
fixpickle ( p,  oid )

  p64  
p64 ( v,  pack=struct.pack )

Classes   
FS

FileStorage report writer for converting BoboPOS to FileStorage

Ghost
Global
Inst
Pickler
Unpickler
ZEXP

Zope Export format report writer

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/FS_FS.py.html0100600000176200017510000001271507306455643022605 0ustar dhellmanndevel Class: FS

Table of Contents

Class: FS Zope-2-CVS-src/utilities/FS.py

FileStorage report writer for converting BoboPOS to FileStorage

Methods   
__init__
rpt
store
tpc_begin
tpc_finish
  __init__  
__init__ (
        self,
        fname,
        file,
        )

  rpt  
rpt (
        self,
        pos,
        oid,
        start,
        tname,
        user,
        t,
        p,
        first,
        newtrans,
        )

  store  
store (
        self,
        oid,
        data,
        )

  tpc_begin  
tpc_begin (
        self,
        tname,
        user,
        desc,
        )

  tpc_finish  
tpc_finish ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/FS_Ghost.py.html0100600000176200017510000000236407306455643023360 0ustar dhellmanndevel Class: Ghost

Table of Contents

Class: Ghost Zope-2-CVS-src/utilities/FS.py

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/FS_Global.py.html0100600000176200017510000000760107306455643023473 0ustar dhellmanndevel Class: Global

Table of Contents

Class: Global Zope-2-CVS-src/utilities/FS.py

Methods   
__basicnew__
__call__
__init__
  __basicnew__  
__basicnew__ ( self )

  __call__  
__call__ ( self,  *args )

  __init__  
__init__ (
        self,
        m,
        n,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/FS_Inst.py.html0100600000176200017510000000631407306455643023210 0ustar dhellmanndevel Class: Inst

Table of Contents

Class: Inst Zope-2-CVS-src/utilities/FS.py

Methods   
__init__
__setstate__
  __init__  
__init__ (
        self,
        c,
        args,
        )

  __setstate__  
__setstate__ ( self,  state )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/FS_Pickler.py.html0100600000176200017510000001116207306455643023661 0ustar dhellmanndevel Class: Pickler

Table of Contents

Class: Pickler Zope-2-CVS-src/utilities/FS.py

Base Classes   
pickle.Pickler
Methods   
persistent_id
save_global
save_inst
  persistent_id  
persistent_id (
        self,
        object,
        Ghost=Ghost,
        )

  save_global  
save_global (
        self,
        object,
        name=None,
        )

  save_inst  
save_inst ( self,  object )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/FS_Unpickler.py.html0100600000176200017510000001117207306455643024225 0ustar dhellmanndevel Class: Unpickler

Table of Contents

Class: Unpickler Zope-2-CVS-src/utilities/FS.py

Base Classes   
pickle.Unpickler
Methods   
load_global
load_inst
persistent_load
  load_global  
load_global ( self )

  load_inst  
load_inst ( self )

  persistent_load  
persistent_load (
        self,
        oid,
        TupleType=type(() ),
        Ghost=Ghost,
        p64=p64,
        )

Remap object ids from ZODB 2 stype to ZODB 3 style

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/FS_ZEXP.py.html0100600000176200017510000000645607306455643023070 0ustar dhellmanndevel Class: ZEXP

Table of Contents

Class: ZEXP Zope-2-CVS-src/utilities/FS.py

Zope Export format report writer

Methods   
__init__
rpt
  __init__  
__init__ (
        self,
        fname,
        file,
        )

  rpt  
rpt (
        self,
        pos,
        oid,
        start,
        tname,
        user,
        t,
        p,
        first,
        newtrans,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/bbb.py.html0100600000176200017510000002112207306455643022422 0ustar dhellmanndevel Module: bbb

Table of Contents

Module: bbb Zope-2-CVS-src/utilities/bbb.py

Read and (re-)format BoboPOS 2 database files

Imported modules   
import os
import string
import struct
import sys
import time
Functions   
_read_and_report
error
main
none
oids
positions
tab_delimited
undo_log
  _read_and_report  
_read_and_report (
        file,
        rpt=None,
        fromEnd=0,
        both=0,
        n=99999999,
        show=0,
        forgive=0,
        export=0,
        )

Read a file's index up to the given time.

  error  
error (
        message,
        fatal=0,
        exc=0,
        )

  main  
main ( argv )

  none  
none ( *ignored )

  oids  
oids (
        pos,
        oid,
        *ignored,
        )

  positions  
positions ( pos,  *ignored )

  tab_delimited  
tab_delimited ( *args )

  undo_log  
undo_log (
        pos,
        oid,
        start,
        tname,
        user,
        t,
        p,
        first,
        newtrans,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/fixbbbts.py.html0100600000176200017510000000744207306455643023511 0ustar dhellmanndevel Module: fixbbbts

Table of Contents

Module: fixbbbts Zope-2-CVS-src/utilities/fixbbbts.py

Imported modules   
import sys
Functions   
main
  main  
main ()

Exceptions   
Corrupted, pos
InvalidFormat, 'This is not a BoboPOS file'

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/load_site.py.html0100600000176200017510000002472207306455643023651 0ustar dhellmanndevel Module: load_site

Table of Contents

Module: load_site Zope-2-CVS-src/utilities/load_site.py

Load a Zope site from a collection of files or directories

Imported modules   
import getopt
import os
from sgmllib import SGMLParser
import string
import sys
Functions   
call
join_attrs
main
parse_html
upload_dir
upload_dtml
upload_file
upload_gif
upload_html
  call  
call (
        f,
        *args,
        *kw,
        )

Exceptions   
sys.exc_info() [ 0 ], sys.exc_info() [ 1 ], sys.exc_info() [ 2 ]
  join_attrs  
join_attrs ( attrs )

  main  
main ()

  parse_html  
parse_html ( infile )

  upload_dir  
upload_dir ( object,  f )

  upload_dtml  
upload_dtml ( object,  f )

  upload_file  
upload_file ( object,  f )

  upload_gif  
upload_gif ( object,  f )

  upload_html  
upload_html ( object,  f )

Classes   
HeadParser

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/load_site_HeadParser.py.html0100600000176200017510000003065407306455643025750 0ustar dhellmanndevel Class: HeadParser

Table of Contents

Class: HeadParser Zope-2-CVS-src/utilities/load_site.py

Base Classes   
SGMLParser
Methods   
__init__
end_body
end_head
end_html
end_title
handle_charref
handle_comment
handle_data
handle_entityref
start_body
 start_head
start_title
unknown_endtag
unknown_starttag
  __init__  
__init__ ( self )

  end_body  
end_body ( self )

  end_head  
end_head ( self )

  end_html  
end_html ( self )

  end_title  
end_title ( self )

  handle_charref  
handle_charref ( self,  ref )

  handle_comment  
handle_comment ( self,  data )

  handle_data  
handle_data ( self,  data )

  handle_entityref  
handle_entityref ( self,  ref )

  start_body  
start_body ( self,  attrs )

  start_head  
start_head ( self,  attrs )

  start_title  
start_title ( self,  attrs )

  unknown_endtag  
unknown_endtag ( self,  tag )

  unknown_starttag  
unknown_starttag (
        self,
        tag,
        attrs,
        )

Pass other tags unmodified

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/requestprofiler.py.html0100600000176200017510000002414307306455643025136 0ustar dhellmanndevel Module: requestprofiler

Table of Contents

Module: requestprofiler Zope-2-CVS-src/utilities/requestprofiler.py

Request log profiler script

Imported modules   
import getopt
import string
import sys
import tempfile
import time
Functions   
analyze
codesort
detailedusage
getdate
parsebigmlogline
usage
write
  analyze  
analyze (
        f,
        top,
        sortf,
        start=None,
        end=None,
        mode='cumulative',
        )

Exceptions   
"Invalid mode."
  codesort  
codesort ( v1,  v2 )

  detailedusage  
detailedusage ()

  getdate  
getdate ( val )

Exceptions   
ProfileException, "bad date %s" % val
  parsebigmlogline  
parsebigmlogline ( line )

  usage  
usage ( basic=1 )

  write  
write ( requests,  top=0 )

Classes   
Cumulative
ProfileException
Request
Sort

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/requestprofiler_Cumulative.py.html0100600000176200017510000002247307306455643027340 0ustar dhellmanndevel Class: Cumulative

Table of Contents

Class: Cumulative Zope-2-CVS-src/utilities/requestprofiler.py

Methods   
__init__
__str__
all
getheader
hits
max
mean
median
min
put
 total
  __init__  
__init__ ( self,  url )

  __str__  
__str__ ( self )

  all  
all ( self )

  getheader  
getheader ( self )

  hits  
hits ( self )

  max  
max ( self )

  mean  
mean ( self )

  median  
median ( self )

  min  
min ( self )

  put  
put ( self,  request )

  total  
total ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/requestprofiler_ProfileException.py.html0100600000176200017510000000364407306455643030500 0ustar dhellmanndevel Class: ProfileException

Table of Contents

Class: ProfileException Zope-2-CVS-src/utilities/requestprofiler.py

Base Classes   
Exception

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/requestprofiler_Request.py.html0100600000176200017510000003025207306455643026644 0ustar dhellmanndevel Class: Request

Table of Contents

Class: Request Zope-2-CVS-src/utilities/requestprofiler.py

Methods   
__init__
__str__
endstage
getheader
isfinished
prettyhttpcode
prettyisize
prettyosize
prettystart
put
 total
wend
win
wout
  __init__  
__init__ ( self )

  __str__  
__str__ ( self )

  endstage  
endstage ( self )

  getheader  
getheader ( self )

  isfinished  
isfinished ( self )

  prettyhttpcode  
prettyhttpcode ( self )

  prettyisize  
prettyisize ( self )

  prettyosize  
prettyosize ( self )

  prettystart  
prettystart ( self )

  put  
put (
        self,
        code,
        t,
        desc,
        )

Exceptions   
"unknown request code %s" % code
  total  
total ( self )

  wend  
wend ( self )

  win  
win ( self )

  wout  
wout ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/requestprofiler_Sort.py.html0100600000176200017510000000636107306455643026147 0ustar dhellmanndevel Class: Sort

Table of Contents

Class: Sort Zope-2-CVS-src/utilities/requestprofiler.py

Methods   
__call__
__init__
  __call__  
__call__ (
        self,
        i1,
        i2,
        )

  __init__  
__init__ (
        self,
        fname,
        ascending=0,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/testrunner.py.html0100600000176200017510000001421707306455644024116 0ustar dhellmanndevel Module: testrunner

Table of Contents

Module: testrunner Zope-2-CVS-src/utilities/testrunner.py

testrunner - a Zope test suite utility.

The testrunner utility is used to execute PyUnit test suites. You can find more information on PyUnit at http://pyunit.sourceforge.net. This utility should be run from the root of your Zope installation. It will set up the correct python path environment based on your installation directory so that test suites can import Zope modules in a way that is fairly independent of the location of the test suite. It does not import the Zope package, so a test thats depend on dynamic aspects of the Zope environment (such as SOFTWARE_HOME being defined) may need to import Zope as a part of the test suite.

Testrunner will look for and execute test suites that follow some simple conventions. Test modules should have a name prefixed with test, such as testMyModule.py, and test modules are expected to define a module function named test_suite that returns a PyUnit TestSuite object. By convention, we put test suites in tests subdirectories of the packages they test.

Testrunner is used to run all checked in test suites before (final) releases are made, and can be used to quickly run a particular suite or all suites in a particular directory.

Imported modules   
import getopt
import imp
import os
import string
import sys
import traceback
Functions   
err_exit
main
  err_exit  
err_exit ( message,  rc=2 )

  main  
main ( args )

Classes   
TestRunner

Test suite runner

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/testrunner_TestRunner.py.html0100600000176200017510000002020407306455644026300 0ustar dhellmanndevel Class: TestRunner

Table of Contents

Class: TestRunner Zope-2-CVS-src/utilities/testrunner.py

Test suite runner

Methods   
__init__
getSuiteFromFile
report
runAllTests
runFile
runPath
runSuite
smellsLikeATest
  __init__  
__init__ ( self,  basepath )

  getSuiteFromFile  
getSuiteFromFile ( self,  filepath )

Exceptions   
ValueError, '%s is not a file' % filepath
  report  
report ( self,  message )

  runAllTests  
runAllTests ( self )

Run all tests found in the current working directory and all subdirectories.

  runFile  
runFile ( self,  filename )

Run the test suite defined by filename.

  runPath  
runPath ( self,  pathname )

Run all tests found in the directory named by pathname and all subdirectories.

  runSuite  
runSuite ( self,  suite )

  smellsLikeATest  
smellsLikeATest (
        self,
        filepath,
        find=string.find,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/utilities/README.txt.html0100600000176200017510000000461407306455646023033 0ustar dhellmanndevel Zope2 CVS with ZEO

Table of Contents

Zope2 CVS with ZEO  

This directory contains utility scripts and modules that augment Zope.

To get detailed usage information, run any of these scripts without arguments:

load_site.py

Load a Zope site from files and directories

This script illustrates used of the Zope RPC mechanism, ZPublisher.Client. It provides some examples of pitfalls and their work-arounds.

testrunner.py

A Zope test suite utility.

The testrunner utility is used to execute PyUnit test suites. You can find more information on PyUnit at http://pyunit.sourceforge.net. This utility should be run from the root of your Zope installation.

The following scripts are for use with the old BoboPOS 2 fileformat.

fixbbbts.py

Fix database time stamps

Sometimes, problems with system clocks can cause invalid time stamps to be written to databases. The fixbbbts script can be used to shift invalid times in the database to make them valid.

bbb.py

Read and summarize a Zope database.

This script illustrates how to read a database file outside of Zope and provides a number of options for finding bad data and generating reports of data.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/inst/0040700000176200017510000000000007306455645017327 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/inst/binary_install.py.html0100600000176200017510000001031107306455643023647 0ustar dhellmanndevel Module: binary_install

Table of Contents

Module: binary_install Zope-2-CVS-src/inst/binary_install.py

Try to do all of the installation steps.

This must be run from the top-level directory of the installation. \(Yes, this is cheezy. We'll fix this when we have a chance.)

Imported modules   
from do import *
import getopt
import os
import sys
Functions   
main
setup
  main  
main ( args )

  setup  
setup ( me )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/inst/build_extensions.py.html0100600000176200017510000000370507306455643024224 0ustar dhellmanndevel Module: build_extensions

Table of Contents

Module: build_extensions Zope-2-CVS-src/inst/build_extensions.py

Build the Zope Extension Modules

You must be in the directory containing this script.

Imported modules   
from do import *

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/inst/build_pcgi.py.html0100600000176200017510000000363707306455643022753 0ustar dhellmanndevel Module: build_pcgi

Table of Contents

Module: build_pcgi Zope-2-CVS-src/inst/build_pcgi.py

Build a PCGI

You must be in the directory containing this script.

Imported modules   
from do import *

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/inst/compilezpy.py.html0100600000176200017510000000545707306455643023047 0ustar dhellmanndevel Module: compilezpy

Table of Contents

Module: compilezpy Zope-2-CVS-src/inst/compilezpy.py

Imported modules   
import compileall
import os
import sys
Classes   
Shutup

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/inst/compilezpy_Shutup.py.html0100600000176200017510000000471307306455643024411 0ustar dhellmanndevel Class: Shutup

Table of Contents

Class: Shutup Zope-2-CVS-src/inst/compilezpy.py

Methods   
write
  write  
write ( *args )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/inst/default_content.py.html0100600000176200017510000000635007306455643024023 0ustar dhellmanndevel Module: default_content

Table of Contents

Module: default_content Zope-2-CVS-src/inst/default_content.py

Imported modules   
from do import *
import os
Functions   
main
  main  
main (
        home,
        user='',
        group='',
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/inst/do.py.html0100600000176200017510000001550207306455643021246 0ustar dhellmanndevel Module: do

Table of Contents

Module: do Zope-2-CVS-src/inst/do.py

Shared routines used by the various scripts.

Imported modules   
import os
import string
import sys
Functions   
ch
do
error
make
wheres_Makefile_pre_in
  ch  
ch (
        path,
        user,
        group,
        mode=0600,
        quiet=0,
        )

  do  
do (
        command,
        picky=1,
        quiet=0,
        )

Exceptions   
SystemError, i
  error  
error ( message,  error )

  make  
make ( *args )

  wheres_Makefile_pre_in  
wheres_Makefile_pre_in ()

Identify Makefile.pre.in location (in much the same way it does).

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/inst/make_resource.py.html0100600000176200017510000000646307306455643023476 0ustar dhellmanndevel Module: make_resource

Table of Contents

Module: make_resource Zope-2-CVS-src/inst/make_resource.py

Build a PCGI resource file.

You must be in the directory containing this script.

Imported modules   
from do import *
import os
Functions   
main
  main  
main (
        cwd=os.getcwd(),
        name='Zope',
        user='',
        group='',
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/inst/make_start.py.html0100600000176200017510000000644307306455643023002 0ustar dhellmanndevel Module: make_start

Table of Contents

Module: make_start Zope-2-CVS-src/inst/make_start.py

Imported modules   
from do import *
import os
import sys
Functions   
sh
  sh  
sh (
        home,
        user,
        group,
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/inst/walkandscrub.py.html0100600000176200017510000000771207306455645023332 0ustar dhellmanndevel Module: walkandscrub

Table of Contents

Module: walkandscrub Zope-2-CVS-src/inst/walkandscrub.py

Imported modules   
import os
import sys
Functions   
scrub
walkandscrub
  scrub  
scrub (
        list,
        dirname,
        filelist,
        )

  walkandscrub  
walkandscrub ( path )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/0040700000176200017510000000000007306455646017275 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/MrCreosote/0040700000176200017510000000000007306455646021357 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/MrCreosote/creosote.py.html0100600000176200017510000001133607306455643024517 0ustar dhellmanndevel Module: creosote

Table of Contents

Module: creosote Zope-2-CVS-src/pcgi/MrCreosote/creosote.py

Imported modules   
import socket
import sys
Functions   
bucket
spew
  bucket  
bucket ( port=PORT,  logfile=None )

  spew  
spew (
        msg,
        host='localhost',
        port=PORT,
        )

Classes   
MrCreosote

lightweight message passing with datagrams

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/MrCreosote/creosote_MrCreosote.py.html0100600000176200017510000001117707306455643026664 0ustar dhellmanndevel Class: MrCreosote

Table of Contents

Class: MrCreosote Zope-2-CVS-src/pcgi/MrCreosote/creosote.py

lightweight message passing with datagrams

Methods   
__init__
bucket
redirector
spew
  __init__  
__init__ (
        self,
        host='localhost',
        port=PORT,
        )

  bucket  
bucket ( self,  logfile=None )

  redirector  
redirector (
        self,
        host,
        port=PORT,
        )

  spew  
spew ( self,  msg )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/MrCreosote/README.MrCreosote.html0100600000176200017510000000276607306455646025275 0ustar dhellmanndevel Zope2 CVS with ZEO

Table of Contents

Zope2 CVS with ZEO  

README.MrCreosote - JeffBauer@bigfoot.com - May 21, 1998

MrCreosote is a lightweight message-passing idiom I use to debug multi-processor/multi-user code sometimes.i It's basically just a matter of tossing out datagrams (connectionless sockets). I'll document it later, in case anyone finds it useful for debugging. For now, just ignore the contents of this directory.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/Util/0040700000176200017510000000000007306455646020212 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/Util/killpcgi.py.html0100600000176200017510000000627307306455643023331 0ustar dhellmanndevel Module: killpcgi

Table of Contents

Module: killpcgi Zope-2-CVS-src/pcgi/Util/killpcgi.py

Functions   
killpcgi
win32_kill
  killpcgi  
killpcgi ( pcgiInfoFile )

  win32_kill  
win32_kill ( pid )

posix-style kill command for the Win32 environment

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/Util/pcgifile.py.html0100600000176200017510000000654007306455643023312 0ustar dhellmanndevel Module: pcgifile

Table of Contents

Module: pcgifile Zope-2-CVS-src/pcgi/Util/pcgifile.py

Functions   
test
  test  
test ()

Classes   
PcgiFile
PcgiFileTest

CGI sanity check of the pcgi info file.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/Util/pcgifile_PcgiFile.py.html0100600000176200017510000004033207306455643025051 0ustar dhellmanndevel Class: PcgiFile

Table of Contents

Class: PcgiFile Zope-2-CVS-src/pcgi/Util/pcgifile.py

Methods   
__init__
checkImports
checkPCGIValues
checkRequiredKeys
checkSockets
checkWritePermissions
environList
getPcgiWrapperVersion
isexecutable
lookupPCGIPublisher
 pathperm
readInfoFile
  __init__  
__init__ ( self,  pcgifile )

  checkImports  
checkImports ( self )

Exceptions   
PcgiFileException
  checkPCGIValues  
checkPCGIValues ( self )

Exceptions   
PcgiFileException
  checkRequiredKeys  
checkRequiredKeys ( self )

Check for the required PCGI keys.

Exceptions   
PcgiFileException
  checkSockets  
checkSockets ( self )

Check for possible socket-related error conditions.

Exceptions   
PcgiFileException
  checkWritePermissions  
checkWritePermissions ( self )

Check write permissions for PCGI_SOCKET_FILE, PCGI_PID_FILE, and (if specified) PCGI_ERROR_LOG.

Exceptions   
PcgiFileException
  environList  
environList ( self )

return a sorted list of how the environment would likely appear if run through the pcgi-wrapper.

  getPcgiWrapperVersion  
getPcgiWrapperVersion ( self )

Execute pcgi-wrapper with no arguments and grab the version id.

  isexecutable  
isexecutable (
        self,
        path,
        real=None,
        )

  lookupPCGIPublisher  
lookupPCGIPublisher ( self )

The most efficient way for pcgi-wrapper to determine which pcgi_publisher to use is for the pcgi info file to specify it with the PCGI_PUBLISHER directive. Using the PCGI_PUBLISHER is arguably the best method, as pcgi-wrapper will find it quicker than otherwise. Still, in the interest of flexibility, pcgi-wrapper will attempt to locate pcgi_publisher using the following rules:

  1. PCGI_PUBLISHER (best)

Rules 2-5, look in the paths below for files named: pcgi_publisher.py, pcgi_publisher.pyc, pcgi_publisher.pyo, pcgi_publisher. 2. PCGI_INSERT_PATH, if available 3. PYTHONPATH, if available 4. Look in the directory of PCGI_MODULE_PATH 5. Look in the directory of the pcgi info file

Exceptions   
PcgiFileException
  pathperm  
pathperm (
        self,
        path,
        real=None,
        )

Returns a 3-tuple of booleans indicating whether the process has (read, write, execute) permission. A true value for the real argument indicates the test should occur for the real id rather than the effective id.

  readInfoFile  
readInfoFile ( self )

Exceptions   
PcgiFileException

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/Util/pcgifile_PcgiFileTest.py.html0100600000176200017510000000475507306455643025722 0ustar dhellmanndevel Class: PcgiFileTest

Table of Contents

Class: PcgiFileTest Zope-2-CVS-src/pcgi/Util/pcgifile.py

CGI sanity check of the pcgi info file.

Methods   
__init__
  __init__  
__init__ ( self )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/Util/README.html0100600000176200017510000000260407306455646022036 0ustar dhellmanndevel Zope2 CVS with ZEO

Table of Contents

Zope2 CVS with ZEO  

pcgifile.py - JeffBauer@bigfoot.com - May 21, 1998

The pcgifile.py is a sanity tester for pcgi info files and can be run as a stand-alone program or a CGI script. For more information, refer to:

http://starship.skyport.net/crew/jbauer/persistcgi/pcgifile/

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/pcgi_publisher.py.html0100600000176200017510000001127107306455643023607 0ustar dhellmanndevel Module: pcgi_publisher

Table of Contents

Module: pcgi_publisher Zope-2-CVS-src/pcgi/pcgi_publisher.py

Imported modules   
import os
import string
import sys
Functions   
main
stdlog
  main  
main ()

  stdlog  
stdlog ( name )

Classes   
PCGIPublisher

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/pcgi_publisher_PCGIPublisher.py.html0100600000176200017510000002036507306455643026273 0ustar dhellmanndevel Class: PCGIPublisher

Table of Contents

Class: PCGIPublisher Zope-2-CVS-src/pcgi/pcgi_publisher.py

Methods   
__init__
cleanup
fatalError
getResources
handler
initPCGI
initPrincipia
insertSysPath
listen
  __init__  
__init__ ( self,  resource=None )

  cleanup  
cleanup ( self )

  fatalError  
fatalError ( self,  errmsg='' )

  getResources  
getResources ( self )

Obtain the publisher resources from the environment. Done here in a separate method to make it easy to override, because we may not always and forever obtain our resources from the environment.

  handler  
handler ( self,  conn )

  initPCGI  
initPCGI ( self )

  initPrincipia  
initPrincipia ( self )

  insertSysPath  
insertSysPath ( self,  insertPath=None )

  listen  
listen ( self )

Note to sub-classes: Aside from the constructor, listen() should be the only method you must invoke.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/Example/0040700000176200017510000000000007306455643020665 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/Example/pcgitime.py.html0100600000176200017510000000627407306455643024013 0ustar dhellmanndevel Module: pcgitime

Table of Contents

Module: pcgitime Zope-2-CVS-src/pcgi/Example/pcgitime.py

Imported modules   
from time import asctime, localtime, time
Functions   
getTime
  getTime  
getTime ( arg=None )

It's later than you think (don't remove this docstring)

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/README.html0100600000176200017510000000416007306455646021120 0ustar dhellmanndevel Zope2 CVS with ZEO

Table of Contents

Zope2 CVS with ZEO  

README notes for Persistent CGI - version 2.0 alpha 4

What it is?

Persistent CGI is an architecture designed by Digital Creations http://www.digicool.com to publish web objects as long-running processes. The pcgi component is an integral part of DC's Principia product, but is also provided to Bobo developers under open software terms. Please review the copyright appearing in the source code for full details.

How to build?

Unix: ./configure make make install <-- only copies the binary, not the .py modules

Win32: cd Win32 nmake /f Makefile.nt

A Win32 binary (pcgi-wrapper.exe) is included with the source distribution.

How to use?

See the HOWTO section in notes I have published:

http://starship.skyport.net/crew/jbauer/persistcgi/

How to get help?

Subscribe to the Bobo mailing list: bobo@digicool.com Contact me: jeffbauer@bigfoot.com

Have fun.

-Jeff

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/Test/0040700000176200017510000000000007306455646020214 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/Test/README.parseinfo.html0100600000176200017510000000424007306455646024023 0ustar dhellmanndevel Zope2 CVS with ZEO

Table of Contents

Zope2 CVS with ZEO  

README.parseinfo - JeffBauer@bigfoot.com - May 21, 1998

parseinfo is an executable to test the parsing the pcgi info file. Although pcgifile.py can be used to test how the pcgi-wrapper is expected to react "in vitro" (i.e. as a CGI process) the parseinfo program actually runs the info file through the parser code (although it performs no further environment testing).

usage: parseinfo <pcgi-info-file>

sample output:

r->sw_info /export/home/jbauer/tmp/pcgiinfo r->sw_name r->sw_home r->sw_exe /usr/local/bin/python r->procpath /export/home/jbauer/var/pcgitime.pid r->sockpath /export/home/jbauer/var/pcgitime.socket r->modpath /export/home/jbauer/www/cgi-bin/pcgitime.py r->pubpath /export/home/jbauer/www/cgi-bin/pcgi_publisher.py r->procid 0 r->insertPath r->pythonPath .:/usr/local/lib/python1.5:/var/share/s0/python CloseFileDescriptors 0

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/Win32/0040700000176200017510000000000007306455646020177 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/pcgi/Win32/README.NT.html0100600000176200017510000001145607306455646022350 0ustar dhellmanndevel Zope2 CVS with ZEO

Table of Contents

Zope2 CVS with ZEO  

README.NT - one day this will grow up and become a real README file. PCGI 2.0a4 Win32 binary release (alpha 4) August 10, 1998 contact: jeffbauer@bigfoot.com What is this? The collection of files below is the first Win32 release of PCGI, the Persistent CGI wrapper for Bobo applications. For more information about Bobo, go to Digital Creations site: http://www.digicool.com Files (in relative order of importance): pcgi-wrapper.exe - the main program pcgi_publisher.py - modified to handle both Unix & Win32 pcgifile.py - indispensible for tracking down problems pcgitime.py - sample module pcgitest - sample PCGI info file killpcgi.py - handy for killing the running process parseinfo.exe - used only when necessary (to view the pcgi info file the way pcgi-wrapper sees it) For information about Persistent CGI, check out: http://starship.skyport.net/crew/jbauer/persistcgi/ (This information may soon move over to www.digicool.com) Platforms tested? Apache/Win32 1.3.1 running on NT 4.0. However, it should run on any Win32 platform running a server supporting http. Basic checklist to get the sample application up and running: 0. Install Python, Bobo, and a web server on your machine. If you haven't got these things already working, please see my notes on the subject: http://starship.skyport.net/crew/jbauer/apachenotes/ 1. Put pcgi-wrapper.exe where you normally place your binary executables, or in cgi-bin. 2. Put pcgi_publisher.py in a directory where you normally put your .py scripts -- cgi-bin is okay, but you will specify the path in your info file, regardless. 3. Put pcgitest & pcgitime.py in cgi-bin. You will have to modify the first #! she-bang line in pcgitest to match the path of where you put pcgi-wrapper.exe. Also, all directives must match your environment -- the examples included are for illustration purposes only. Please read the online (URL above) PCGI documentation for further information. 4. Run your setup against pcgifile.py, a sanity check described in: http://starship.skyport.net/crew/jbauer/persistcgi/pcgifile/ http://starship.skyport.net/crew/jbauer/persistcgi/howto 5. Give me feedback, please: jeffbauer@bigfoot.com ------------------- Microsoft IIS Notes: Amos Latteier notes that some web servers, notably Microsoft's IIS, cannot deal with the first line in a CGI program like Apache: #!C:\WINNT\system32\pcgi-wrapper.exe The solution is to use a .pcgi extension for your info file and create a file association between .pcgi and pcgi-wrapper.exe with an IIS script map registry entry, e.g.: .pcgi C:\winnt\system32\pcgi-wrapper.exe %s Now info files with the .pcgi extension will execute as cgi programs. [Amos further notes in a posting to the Bobo list:] IIS 4 by default sends a custom 404 error message which masks Bobo's 404 error information. This effectively keeps you from seeing what Bobo is trying to tell you about why it is not publishing your object. To get rid of this annoyance go to the web site properties dialog in the Microsoft Management Console application. Click on the "Custom Errors" tab. Choose the 404 error and change it to use "Default" error message. Voila, you're back in business, and can read Bobo information in the source of your 404 error messages now.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/w_pcgi.py.html0100600000176200017510000001000607306455645021133 0ustar dhellmanndevel Module: w_pcgi

Table of Contents

Module: w_pcgi Zope-2-CVS-src/w_pcgi.py

Try to do all of the installation steps.

This must be run from the top-level directory of the installation. (Yes, this is cheezy. We'll fix this when we have a chance.

Imported modules   
import os
import sys
Functions   
main
setup
  main  
main ( me )

  setup  
setup ( me )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/wo_pcgi.py.html0100600000176200017510000001001307306455645021310 0ustar dhellmanndevel Module: wo_pcgi

Table of Contents

Module: wo_pcgi Zope-2-CVS-src/wo_pcgi.py

Try to do all of the installation steps.

This must be run from the top-level directory of the installation. \(Yes, this is cheezy. We'll fix this when we have a chance.)

Imported modules   
import os
import sys
Functions   
main
setup
  main  
main ( me )

  setup  
setup ( me )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/z2.py.html0100600000176200017510000003133207306455645020223 0ustar dhellmanndevel Module: z2

Table of Contents

Module: z2 Zope-2-CVS-src/z2.py

Zope 2 ZServer start-up file

Usage: %(program)s [options] [environment settings]

Options:

-h

Output this text.

-z path

The location of the Zope installation. The default is the location of this script, %(here)s.

-Z path

Unix only! This option is ignored on windows.

If this option is specified, a separate managemnt process will be created that restarts Zope after a shutdown (or crash). The path must point to a pid file that the process will record its process id in. The path may be relative, in which case it will be relative to the Zope location.

To prevent use of a separate management process, provide an empty string: -Z ''

-t n

The number of threads to use, if ZODB3 is used. The default is %(NUMBER_OF_THREADS)s.

-i n

Set the interpreter check interval. This integer value determines how often the interpreter checks for periodic things such as thread switches and signal handlers. The Zope default is 120, but you may want to experiment with other values that may increase performance in your particular environment.

-D

Run in Zope debug mode. This causes the Zope process not to detach from the controlling terminal, and is equivalent to supplying the environment variable setting Z_DEBUG_MODE=1

-a ipaddress

The IP address to listen on. If this is an empty string (e.g. -a ''), then all addresses on the machine are used. The default is %(IP_ADDRESS)s.

-d ipaddress

IP address of your DNS server. If this is an empty string (e.g. -d ''), then IP addresses will not be logged. If you have DNS service on your local machine then you can set this to 127.0.0.1. The default is: %(DNS_IP)s.

-u username or uid number

The username to run ZServer as. You may want to run ZServer as nobody or some other user with limited resouces. The only works under Unix, and if ZServer is started by root. The default is: %(UID)s

-P [ipaddress:]number

Set the web, ftp and monitor port numbers simultaneously as offsets from the number. The web port number will be number+80. The FTP port number will be number+21. The monitor port number will be number+99.

The number can be preeceeded by an ip address follwed by a colon to specify an address to listen on. This allows different servers to listen on different addresses.

Multiple -P options can be provided to run multiple sets of servers.

-w port

The Web server (HTTP) port. This defaults to %(HTTP_PORT)s. The standard port for HTTP services is 80. If this is a dash (e.g. -w -), then HTTP is disabled.

The number can be preeceeded by an ip address follwed by a colon to specify an address to listen on. This allows different servers to listen on different addresses.

Multiple -w options can be provided to run multiple servers.

-W port

The "WebDAV source" port. If this is a dash (e.g. -w -), then "WebDAV source" is disabled. The default is disabled. Note that this feature is a workaround for the lack of "source-link" support in standard WebDAV clients.

The port can be preeceeded by an ip address follwed by a colon to specify an address to listen on. This allows different servers to listen on different addresses.

Multiple -W options can be provided to run multiple servers.

-f port

The FTP port. If this is a dash (e.g. -f -), then FTP is disabled. The standard port for FTP services is 21. The default is %(FTP_PORT)s.

The port can be preeceeded by an ip address follwed by a colon to specify an address to listen on. This allows different servers to listen on different addresses.

Multiple -f options can be provided to run multiple servers.

-p path

Path to the PCGI resource file. The default value is %(PCGI_FILE)s, relative to the Zope location. If this is a dash (-p -) or the file does not exist, then PCGI is disabled.

-F path_or_port

Either a port number (for inet sockets) or a path name (for unix domain sockets) for the FastCGI Server. If the flag and value are not specified then the FastCGI Server is disabled.

-m port

The secure monitor server port. If this is a dash (-m -), then the monitor server is disabled. The monitor server allows interactive Python style access to a running ZServer. To access the server see medusa/monitor_client.py or medusa/monitor_client_win32.py. The monitor server password is the same as the Zope emergency user password set in the access file. The default is to not start up a monitor server.

The port can be preeceeded by an ip address follwed by a colon to specify an address to listen on. This allows different servers to listen on different addresses.

Multiple -m options can be provided to run multiple servers.

-l path

Path to the ZServer log file. If this is a relative path then the log file will be written to the var directory. The default is %(LOG_FILE)s.

-r

Run ZServer is read-only mode. ZServer won't write anything to disk. No log files, no pid files, nothing. This means that you can't do a lot of stuff like use PCGI, and zdaemon. ZServer will log hits to STDOUT and zLOG will log to STDERR.

-L

Enable locale (internationalization) support. The value passed for this option should be the name of the locale to be used (see your operating system documentation for locale information specific to your system). If an empty string is passed for this option (-L ''), Zope will set the locale to the user's default setting (typically specified in the $LANG environment variable). If your Python installation does not support the locale module, the requested locale is not supported by your system or an empty string was passed but no default locale can be found, an error will be raised and Zope will not start.

-X

Disable servers. This might be used to effectively disable all default server settings or previous server settings in the option list before providing new settings. For example to provide just a web server:

%(program)s -X -w80

-M file

Save detailed logging information to the given file. This log includes separate entries for:

  • The start of a request, - The start of processing the request in an application thread, - The start of response output, and - The end of the request.

Environment settings are of the form: NAME=VALUE.

Note: you must use Python 2.1 or later!

Imported modules   
import ZServer
import getopt
import os
import string
import sys
Functions   
server_info
set_locale
  server_info  
server_info (
        old,
        v,
        offset=0,
        )

Exceptions   
'Invalid port', v
  set_locale  
set_locale ( val )

Exceptions   
SystemExit, ( 'The locale module could not be imported.\n' 'To use localization options, you must ensure\n' 'that the locale module is compiled into your\n' 'Python installation.' )
SystemExit, ( 'The specified locale is not supported by your system.\n' 'See your operating system documentation for more\n' 'information on locale support.' )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/zpasswd.py.html0100600000176200017510000002003207306455645021356 0ustar dhellmanndevel Module: zpasswd

Table of Contents

Module: zpasswd Zope-2-CVS-src/zpasswd.py

Zope user bootstrap system

Imported modules   
import binascii
import getopt
import getpass
import os
import sha
import string
import sys
import whrandom
Functions   
generate_passwd
generate_salt
main
write_access
write_generated_password
write_inituser
  generate_passwd  
generate_passwd ( password,  encoding )

  generate_salt  
generate_salt ()

Generate a salt value for the crypt function.

  main  
main ( argv )

Exceptions   
"CommandLineError"
  write_access  
write_access (
        home,
        user='',
        group='',
        )

  write_generated_password  
write_generated_password (
        home,
        ac_path,
        username,
        )

  write_inituser  
write_inituser (
        home,
        user='',
        group='',
        )

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/LICENSE.txt.html0100600000176200017510000001131207306455645021135 0ustar dhellmanndevel Zope2 CVS with ZEO

Table of Contents

Zope2 CVS with ZEO  

Zope Public License (ZPL) Version 1.0 -------------------------------------

Copyright (c) Digital Creations. All rights reserved.

This license has been certified as Open Source(tm).

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions in source code must retain the above copyright notice, this list of conditions, and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution.

  3. Digital Creations requests that attribution be given to Zope in any manner possible. Zope includes a "Powered by Zope" button that is installed by default. While it is not a license violation to remove this button, it is requested that the attribution remain. A significant investment has been put into Zope, and this effort will continue if the Zope community continues to grow. This is one way to assure that growth.

  4. All advertising materials and documentation mentioning features derived from or use of this software must display the following acknowledgement:

    "This product includes software developed by Digital Creations for use in the Z Object Publishing Environment (http://www.zope.org/)."

    In the event that the product being advertised includes an intact Zope distribution (with copyright and license included) then this clause is waived.

  5. Names associated with Zope or Digital Creations must not be used to endorse or promote products derived from this software without prior written permission from Digital Creations.

  6. Modified redistributions of any form whatsoever must retain the following acknowledgment:

    "This product includes software developed by Digital Creations for use in the Z Object Publishing Environment (http://www.zope.org/)."

    Intact (re-)distributions of any official Zope release do not require an external acknowledgement.

  7. Modifications are encouraged but must be packaged separately as patches to official Zope releases. Distributions that do not clearly separate the patches from the original work must be clearly labeled as unofficial distributions. Modifications which do not carry the name Zope may be packaged in any form, as long as they conform to all of the clauses above.

Disclaimer

THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DIGITAL CREATIONS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This software consists of contributions made by Digital Creations and many individuals on behalf of Digital Creations. Specific attributions are listed in the accompanying credits file.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/README.txt.html0100600000176200017510000000657107306455645021023 0ustar dhellmanndevel Zope2 CVS with ZEO

Table of Contents

Zope2 CVS with ZEO  

Welcome to the Zope source release

This document provides some general information about the Zope source release and provides links to other documents.

Installation information can be found in doc/INSTALL.txt. Other documentation is also in the doc directory.

Zope information is available at http://www.zope.org/

Report problems with this release on the Zope mailing list (zope@zope.org) To subscribe to the list send mail to zope-request@zope.org with "subscribe" in the subject line.

Introduction

The source release is intended for tinkerers, those who want to use Zope components separately, Bobo hackers, people who want to use their own Python, and people who work on obscure platforms because they love to compile everything from source.

If you just want to use Zope easily and aren't a programmer the binary release will probably suit you better. All are available at http://www.zope.org/Download

License

The Zope License is included in LICENSE.txt Send your feedback about the license to zope-license@zope.org.

Important

This release requires Python 1.5.2.

Installing Zope

Follow the instructions in doc/INSTALL.txt to install Zope.

Using Zope Components Separately

Zope consists of many Python packages which can be profitably used by themselves. For example you will find all your old friends from Bobo here:

  • ZPublisher - A packagized version of the Bobo ORB you know and love.

  • DocumentTemplate - This package includes cDocumentTemplate which speeds things up considerably.

  • BoboPOS - This is NOT ZODB 3. It a version of BoboPOS2 which include c code to make things faster.

You can find most of these packages in the lib/python directory. If you poke around, you might find other goodies too, like StructuredText.

ZPublisher and DocumentTemplate are also available separately.

Notes

  • Zope requires Python 1.5.2.

  • Lots more documentation is coming.

  • Don't forget to check the Zope web site and mailing list.

  • Read the source, have fun!

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/Extensions/0040700000176200017510000000000007306455645020511 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/Extensions/README.txt.html0100600000176200017510000000226607306455645023157 0ustar dhellmanndevel Zope2 CVS with ZEO

Table of Contents

Zope2 CVS with ZEO  

Place files containing code for External Method objects in this directory.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5 Zope-2-CVS-srcdocs/Zope-2-CVS-src/import/0040700000176200017510000000000007306455645017664 5ustar dhellmanndevelZope-2-CVS-srcdocs/Zope-2-CVS-src/import/README.txt.html0100600000176200017510000000252107306455645022324 0ustar dhellmanndevel Zope2 CVS with ZEO

Table of Contents

Zope2 CVS with ZEO  

This directory is used by the running Zope process to import objects into the ZODB. Please place any files that you wish to be able to import into this directy. For more information, please see the Zope Content Manager's Guide.

Table of Contents

This document was automatically generated on Sun Jun 3 11:41:40 2001 by HappyDoc version r1_5