Commit 20bc4be1 authored by Jeremy Hylton's avatar Jeremy Hylton

Add html version of .stx files, since StructuredText generator is not

necessarily available.
parent d6cc08ec
This diff is collapsed.
This diff is collapsed.
<h1>Installation</h1>
<p> <a href="COPYRIGHT.html">Copyright (C) 1996-1998, Digital Creations</a>.</p>
<p> The ExtensionClass distribution now uses the "Universal Unix
Makefile for Python extensions", <code>Makefile.pre.in</code>, which was
introduced as part of Python1.4. Copies of this file for Python
1.4 and Python 1.5 are included with this release. See the
instructions in the make file, itself. Note that you will need to
copy or rename the the file for the Python version you're using to
Makefile.pre.in.</p>
<h1>Files</h1>
<dl><dt> ExtensionClass.stx </dt><dd><p>This file in structured text format</p>
</dd>
<dt> ExtensionClass.html </dt><dd><p>This file in HTML format</p>
</dd>
<dt> Installation </dt><dd><p>Installation instructions in structured text
format. </p>
</dd>
<dt> Installation.html </dt><dd><p>Installation instructions in HTML
format. </p>
</dd>
<dt> Acquisition.stx </dt><dd><p>Acquisition documentation in structured text
format. </p>
</dd>
<dt> Acquisition.html </dt><dd><p>Acquisition documentation in HTML
format. </p>
</dd>
<dt> MultiMapping.stx </dt><dd><p>The MultiMapping example in structured text
format. </p>
</dd>
<dt> MultiMapping.html </dt><dd><p>The MultiMapping example in structured text
format. </p>
</dd>
<dt> release.notes </dt><dd><p>Release notes in structured text
format. </p>
</dd>
<dt> release.html </dt><dd><p>Release notes in HTML format. </p>
</dd>
<dt> README </dt><dd><p>A file that says to read this file.</p>
</dd>
<dt> Makefile.pre.in-1.4 </dt><dd><p>The Universal Unix Makefile for Python
extensions. This is the Python 1.4
version. Copy this to Makefile.pre.in
before using it.</p>
</dd>
<dt> Makefile.pre.in-1.5 </dt><dd><p>The Universal Unix Makefile for Python
extensions. This is the Python 1.5
version. Copy this to Makefile.pre.in
before using it.</p>
</dd>
<dt> Setup </dt><dd><p>a configuration file used by the Universal
Unix Makefile for Python extensions </p>
</dd>
<dt> ExtensionClass.c </dt><dd><p>The ExtensionClass source</p>
</dd>
<dt> ExtensionClass.h </dt><dd><p>The ExtensionClass header file</p>
</dd>
<dt> Acquisition.c </dt><dd><p>The source for the <code>Acquisition</code> module
that provides mix-in classes to support
environmental acquisition</p>
</dd>
<dt> MethodObject.c </dt><dd><p>The source for the <code>MethodObject</code> module
that provides a mix-in class for
user-defined method types. To create a
user-defined method type, just create an
extension subclass of
<code>MethodObject.MethodObject</code> that has an
<code>__call__</code> method.</p>
</dd>
<dt> Missing.c </dt><dd><p>The source for the <code>Missing</code> module
that provides a class for objects that
model "missing" or unknown data. Missing
objects have the property that all
mathematical operations yield a missing
value. This is included mainly as an
example (and test) of a numeric extension
base class.</p>
</dd>
<dt> MultiMapping.c </dt><dd><p>The source for a slightly enhanced
<code>MultiMapping</code> module that is based on the
<code>MultiMapping</code> example given in this
paper. If present, document templates <a href="#2">[2]</a>
will take advantage of this module to
significantly increase rendering
performance. </p>
</dd>
<dt> Sync.py </dt><dd><p>A Python module that provides a
<code>Synchonized</code> mix-in class that limits access
to an object's methods to one thread at a
time. This requires the installation of
the ThreadLock module.</p>
</dd>
<dt> ThreadLock.c </dt><dd><p>The source for the <code>ThreadLock</code> module that
provides <code>ThreadLock</code> objects. These are
similar to the lock objects provided by
the <code>thread</code> modules. Unlike normal
Python lock objects, <code>ThreadLock</code> objects
can be acquired (and released) more than
once by the same thread.</p>
</dd></dl>
<p> In addition to the files listed above, several "test" modules are
included. These are modules that I used to test ExtensionClass.
They do not constitute a regression testing suit and I've made
little effort to assure that they actually work, although that
would be a good thing to do if time permits.
</p>
This diff is collapsed.
<p>
Extension Class</p>
<p> <a href="COPYRIGHT.html">Copyright (C) 1996-1998, Digital Creations</a>.</p>
<p> 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:</p>
<ul><li><p>They can be sub-classed in python,</p>
</li>
<li><p>They provide access to method documentation strings, and</p>
</li>
<li><p>They can be used to directly create new instances.</p>
</li></ul>
<p> Extension classes provide additional extensions to class and
instance semantics, including:</p>
<ul><li><p>A protocol for accessing subobjects "in the context of" their
containers. This is used to implement custom method types
and <a href="Acquisition.html">environmental acquisition</a>.</p>
</li>
<li><p>A protocol for overriding method call semantics. This is used
to implement "synchonized" classes and could be used to
implement argument type checking.</p>
</li>
<li><p>A protocol for class initialization that supports execution of a
special <code>__class_init__</code> method after a class has been
initialized.</p>
</li></ul>
<p> Extension classes illustrate how the Python class mechanism can be
extended and may provide a basis for improved or specialized class
models. </p>
<h1>Releases</h1>
<p> The current release is <a href="ExtensionClass-1.2.tar.gz">1.2</a>
To find out what's changed in this release,
see the <a href="release.html">release notes</a>.</p>
<p> Documentation is available <a href="ExtensionClass.html">on-line</a>.</p>
<h1>Windows Binaries</h1>
<p> A win32 binary release, <a href="ec12.zip">ec12.zip</a> is available. This
release includes all of the ExtensionClass modules built as
Windows extension modules (.pyd) files. These were built for
Python 1.5.1 using Microsoft Visual C++ 5.0 in "Release" mode.</p>
<p>
<TABLE BORDER=1 CELLPADDING=2>
</TABLE></p>
<h1>Release Notes</h1>
<h2>1.2</h2>
<p> This release provides some important bug fixes, some new features,
and a new copyright.</p>
<p> New functionality:</p>
<ul><li><p>One or more mapping objects can be passed to the MultiMapping
constructor.</p>
</li>
<li><p>MultiMapping objects implement the has_key and get methods as
defined for Python 1.5 dictionaries.</p>
</li></ul>
<p> Bugs fixed:</p>
<ul><li><p>When support was added for passing acquisition wrappers to
methods of data-less C mix-in classes, C-based __call_method__
hooks were broken. The most notable example of this was the
breaking of the Synchronized class.</p>
</li>
<li><p>Calling C-base-class special methods from overriding methods,
as in::</p>
<PRE>
class LowerMultiMapping(MultiMapping):
def __getitem__(self, key):
return MultiMapping.__getitem__(self, lower(key))
caused infinite loops.
</PRE>
</li>
<li><p>A typo in the Acquisition probably caused __delitem__
calls on wrapped mapping objects to fail.</p>
</li></ul>
<h2>1.1</h2>
<p> New functionality:</p>
<ul><li><p>Changed the way that methods in pure mix-in classes are
constructed. Now methods are wrapped in such a way that
tricky wrapper objects (like Acquisition wrappers) can
bind them to wrapped objects.</p>
</li>
<li><p>An "is subclass" test is provided via the macros
<code>ExtensionClassSubclass_Check</code>, and
<code>ExtensionClassSubclassInstance_Check</code>, which are
documented in <code>ExtensionClass.h</code>.</p>
</li>
<li><p>Methods and Acquisition wrappers use free list to improve
allocation and deallocation performance.</p>
</li>
<li><p>Bound methods have attributes who's values are stored in
their instances.</p>
</li>
<li><p>Added <code>__module__</code> attribute to ExtensionClasses to be
consistent with Python 1.5 classes and to work correctly
with 1.5 pickling.</p>
</li>
<li><p>Added the <code>__basic__</code> new class method to allow
ExtensionClass instances to be unpickled without calling
their constructors.</p>
</li>
<li><p>Acquired acquiring objects can nor acquire from the object
they were accessed in, in addition to the object they were
acquired from.</p>
</li>
<li><p>Added new <code>Acquisition</code> variable, <code>Acquired</code>, to support
"Controlled Acquisition'.</p>
</li>
<li><p>Added a new <code>aq_acquire</code> method for objects that subclass
<code>Acquisition.Implicit</code> or <code>Acquisition.Explicit</code>. This
supports explicit acquisition and provides an option
filter function to support "Filtered Acquisiition".</p>
<p> The <code>acquire</code> method available in earlier releases is still
available, but is deprecated.</p>
</li></ul>
<p> Bugs fixed:</p>
<ul><li><p>There were some incorrect C-level error return values.</p>
</li>
<li><p>A bug in handling method chains caused "C inheritence"
to fail. This only affected extension types that
inherited from extension types using method chains, <em>not</em>
extension subclasses defined in Python inheriting from
extension base classes defined in C.</p>
</li>
<li><p>Expressions like <code>not foo</code> or statements like::</p>
<PRE>
if foo:
...
often failed for non-collection types because of an
incorrect attempt to take the 'len' of an object.
</PRE>
</li>
<li><p>Comparisons of objects with different classes didn't work
correctly.</p>
</li>
<li><p>Instances provided access to their class <code>__bases__</code>
attribute.</p>
</li></ul>
<h2>1.0.2</h2>
<p> Bugs fixed:</p>
<ul><li><p>Fixed bug in handling subclasses of Sequence objects.</p>
</li>
<li><p>Fixed comparison bug in Missing objects.</p>
</li></ul>
<h2>1.0.1</h2>
<p> Added functionality to and fixed bug in Missing module</p>
<ul><li><p>Fixed horible reference-counting bug</p>
</li>
<li><p>Changed so that <code>Missing.Value.spam(a1,a2,whatever)</code>
returns <code>Missing.Value</code> for any method name (except
<code>__reduce__</code>) and any arguments.</p>
</li>
<li><p>Changed so that missing values are picklable. Note that
the special global, Missing.Value, is pickled in a
slightly more efficient manner than other missing values.</p>
</li></ul>
<h2>1.0</h2>
<p> First non-beta release</p>
<p> This release is the result of a major rewrite and "hardening"
effort to increase performance and reliability. This version
is being used in several Digital Creations products, so if
parts are broken, we probably don't use them. :-)</p>
<p> This release also contains several new features and example
modules, including:</p>
<ul><li><p>Acquisition,</p>
</li>
<li><p>Custom method calls,</p>
</li>
<li><p>Class initialization protocol,</p>
</li>
<li><p>A class method that makes it possible to explicitly call
Python base-class methods.</p>
</li>
<li><p>A sample application of custom method calls that provides
Java-like synchronized classes that prevent more than one
thread from accessing an object's methods at one time.</p>
</li></ul>
<p> Note that there is one known incompatibility with previous
releases. In previouse releases, the method used to support
context wrapping was named <code>__bind_to_object__</code>. The name of
this method was changed to <code>__of__</code> in this release and I do
not expect this name to change in the future.
</p>
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment