[Subversion] / PEAK / CHANGES.txt  

Diff of /PEAK/CHANGES.txt

Parent Directory | Revision Log

version 1180, Tue Jun 10 20:21:26 2003 UTC version 1449, Fri Nov 14 22:54:16 2003 UTC
Line 1 
Line 1 
   Fixes and Enhancements since Version 0.5 alpha 2
   
    Changed, Enhanced, or Newly Deprecated Features
   
    - Added 'peak.util.mockdb', a "mock object" implementation of a DBAPI 2.0
      driver module.  'mockdb' connections can be told to 'expect()' queries
      and 'provide()' data to their callers, and will raise AssertionErrors when
      they are used in a way that doesn't conform to your supplied expectations.
      This is intended to be used for unit testing components that depend on
      a database connection: you can verify that they send the right SQL, and
      you can provide them with dummy data to use.  There is also a 'mockdb:' URL
      and peak.storage driver, so you can easily use a mock DB connection in place
      of a real one within a PEAK application, for testing purposes.  Note,
      however, that 'peak.util.mockdb' is a DBAPI 2.0 driver in itself, and thus
      can also be used to test DBAPI usage outside of PEAK.
   
    - SQL connection objects now provide an 'appConfig' attribute that is a
      driver-specific 'config.Namespace()'.  This allows you to easily set up
      configuration properties that are driver-specific.  For example, you could
      use properties to configure driver-specific SQL snippets, then access them
      via the connection's 'appConfig' namespace.  The namespaces are of the form
      'DRIVER.appConfig', where 'DRIVER' is the name of the DBAPI module for that
      connection type (e.g. 'pgdb', 'cx_Oracle', etc.).
   
    - Added 'config.Namespace()' convenience class for redirecting property
      lookups from one namespace to another.  See the docstring and 'peak.ini' for
      usage examples.  'PropertyName.of()' now returns 'Namespace' instances
      instead of 'PropertySet' instances.
   
    - DEPRECATED the 'config.PropertySet' class; please convert to using
      'config.Namespace', as it will disappear in the 0.5alpha4 release cycle.
   
    - SQL connection objects now get their type converters from a distinct
      property namespace for each DBAPI driver.  For example a driver using the
      'cx_Oracle' module will get its type converters from the
      'cx_Oracle.sql_types' property namespace, instead of 'peak.sql_types'.  For
      backward compatibility, these driver-specific namespaces are set up to
      fall back to 'peak.sql_types' for their defaults.  Type converter
      construction has also been improved, to eliminate conversion overhead
      completely when no conversions are required for a specific query.  Also,
      SQL connections now offer a method that will create a row conversion
      function for a given result description and optional postprocessing
      function.  This new method should now be used in place of direct access to
      the 'typeMap' attribute of connection objects.
   
    - Added 'binding.Require', 'binding.Obtain', 'binding.Make', and
      'binding.Delegate'.  *ALL* other binding types are now DEPRECATED, and will
      go away before 0.5 beta is released:
   
      'requireBinding("info")' -- use 'Require("info")'
   
      'delegateTo("attr")' -- use 'Delegate("attr")'
   
      'New(type)' -- use 'Make(type)'
   
      'New("module.type")' -- use 'Make("module.type")'
   
      'bindTo(key)' -- use 'Obtain(key)'
   
      'Constant(value)' -- use 'Make(lambda: value)'
   
      'Acquire(key)' -- use 'Obtain(key, offerAs=[key])'
   
      'Copy(value)' -- use 'Make(lambda: <expr to copy value>)'
   
      'whenAssembled(func)' -- use 'Make(func, uponAssembly=True)'
   
      'bindSequence(key1,key2,...)' -- use 'Obtain([key1,key,...])'
   
      'bindToProperty(x,y)' -- use 'Obtain(PropertyName(x),default=y)'
   
      'bindToParent()' -- use 'Obtain("..")'
   
      'bindToSelf()'  -- use 'Obtain(".")'
   
      'bindToUtilities()' -- no replacement; let me know if you're using this.
   
      Note that 'Make' and 'Obtain' also support sequences of recipes and keys,
      and in those cases will produce a sequence of the results from those recipes
      or keys.  Also, 'Make' will accept no-argument and one-argument callables,
      where 'Once' always required three-argument functions.  This should make it
      a lot easier to write short binding functions.
   
      Also, note that the 'activateUponAssembly' keyword is now 'uponAssembly',
      and 'isVolatile' is now 'noCache'.  (The old names will work as keyword
      arguments until the alpha 4 development cycle begins.)  The
      'binding.IActiveDescriptor' interface also changed as a result of this.
      Last, but not least, a 'binding.IRecipe' interface was added, to support the
      new 'binding.Make' type.
   
   
    - Added a 'lockName' attribute to 'runnning.AdaptiveTask', and a 'LockURL'
      setting to its ZConfig schema.  This allows a lockfile URL to be specified
      for adaptive tasks that need exclusive access to some resource while
      running.
   
    - A list or tuple of 'IComponentKey' instances is now treated as a single
      component key, that returns a tuple of the values returned by each
      constituent component key.  This means that 'binding.Obtain()' and
      'lookupComponent()' can now accept a list or tuple of component keys.  This
      makes 'bindSequence()' obsolete, so 'bindSequence()' is now DEPRECATED.
      'binding.bindSequence(key1,key2,...)' can now be replaced with
      'binding.Obtain([key1,key,...])', and will produce the same results.
   
    - 'naming.IBasicContext.lookup()' and 'naming.lookup()' now accept a 'default'
      argument, similar to that used by 'lookupComponent()' and most other
      lookup-like APIs in PEAK.  This change was made so that component lookups
      don't need to rely on catching 'exceptions.NameNotFound' errors to tell them
      when to use the default value.  This could hide 'NameNotFound' errors that
      were actually from a broken component somewhere in the lookup process.  (In
      general, it's probably a bad idea to have an exception that's used for both
      control flow and real errors!)
   
    - Added new 'version' tool that automatically edits files to update version
      information in them.  Just execute the 'version' file in the main PEAK
      source directory.  (Use '--help' for help.)  You can use this tool with your
      own projects by creating 'version' and 'version.dat' files in your project
      directory, similar to the ones used by PEAK.  The 'version' file is a ZConfig
      file that describes your project's version numbering scheme(s), formats,
      and the files that need to be edited, while the 'version.dat' file contains
      the current version number values.  Source for the tool, including the
      configuration file schema, is in the 'peak.running.tools.version' package.
      (Error handling and documentation, alas, are still minimal.)
   
    - Added new 'Alias' command in 'peak.running.commands'.  An 'Alias' instance
      can be used as a 'peak.running.shortcut' property that expands to another
      command with arbitrary arguments inserted before the original command's
      arguments.  Thus, one might alias 'mycommand' to 'runIni somefile --option',
      similar to command aliases in many shells.
   
    - 'naming.IName' is now derived from 'binding.IComponentKey', so names and
      addresses must now support the 'findComponent()' method.  All PEAK name and
      address types provide support for this.
   
    - The 'lookup()' method of 'binding.IComponentKey' is now called
      'findComponent()', to better distinguish it from 'lookup()' in
      'naming.IBasicContext', which does something very different.
   
    - 'binding.Obtain()' (formerly 'binding.bindTo()' and 'binding.bindSequence()')
      now pre-adapt their arguments to 'IComponentKey', to speed lookups at
      runtime, and to ensure that errors due to an unusable parameter type occur
      at class creation time instead of waiting until lookup time.
   
    - There's a new 'peak.storage.files' module, with handy classes like
      'EditableFile'.  'EditableFile' is a class that lets you edit the contents
      of a file "in place", with atomic replacement of the original at transaction
      commit.  If the transaction is aborted, the original file is left unchanged.
   
    - 'peak.running.scheduler.UntwistedReactor' now supports a configuration
      property ('peak.running.reactor.checkInterval') to determine how long it
      should run 'select()' calls for, when there are no scheduled tasks.
   
    - 'peak.running.scheduler.UntwistedReactor' now supports using a "signal
      manager" component (via the 'peak.running.signalManager' property) to
      process signals while a 'run()' loop is in progress.  Signal managers can
      also be added or removed at any time via the new 'peak.util.signal_stack'
      module.
   
    - 'peak.running.commands.AbstractCommand' now offers a '_run()' method that
      can be overridden in subclasses, instead of 'run()'.  If you override the
      new '_run()' method instead, you get the advantage of automatic handling
      for invocation errors and 'SystemExit' exceptions, provided for you by the
      'run()' method.
   
    - There is now a 'storage.DMFor(class)' function that returns a configuration
      key for registering or looking up data managers by class.  You can use the
      returned key in a binding's 'offerAs' list, or as the target of a 'bindTo()'
      or 'lookupComponent()'.  The key is constructed using
      'config.ProviderOf(storage.IDataManager,class)'.
   
    - You can now register utilities that are keyed by the combination of an
      interface and one or more classes, using 'config.ProviderOf(iface,*classes)'
      as a configuration key.  Providers are registered under an '(iface,klass)'
      tuple for each specified class, and looked up using the MRO order of the
      class specified for lookup.  In other words, searching for a provider will
      find a provider for the requested class, or one of its base classes, with
      precedence given to the more-specific provider.  This is primarily intended
      for services like data managers and Specialists.
   
    - It's now possible to extend .ini file parsing with custom section types,
      and PEAK defines its own built-in section types using this extension
      mechanism.  Custom section types must include at least one space, (e.g.
      '[My Section]') or they will be treated as a plain property name.
      See the 'peak.config.iniFile.sectionParsers' section in 'peak.ini' for
      more details, along with the 'config.ISettingParser' and 'config.IIniParser'
      interfaces.
   
    - When creating a 'PropertyName()', it's now possible to force conversion of
      invalid characters to '_', using the 'PropertyName.fromString()'
      constructor.  (Note that the input must be a plain-ASCII string.)  Unless
      you request that wildcards ('?' and '*') be kept, they will also be
      converted to '_' characters.  This can be convenient for converting things
      like filenames or text that might contain spaces, to property names.
   
    - It's now possible to declare an attribute as offering a wildcard property;
      such lookups now follow the same rules as other wildcard property lookups.
      The 'config.IConfigKey' interface has been changed to cleanly support
      implied keys at both registration and lookup time, so you can implement
      your own key types that work the way interfaces or property names do for
      configuration lookups.
   
    - The 'EigenRegistry' class has been moved from 'peak.util.EigenData' to
      'peak.config.registries', as it hasn't really been useful outside PEAK for
      a while now.
   
    - .ini files now support "smart property" objects ('config.ISmartProperty').
      If a property rule defined in an .ini file evaluates at runtime to an object
      that implements 'ISmartProperty', the object will be given a chance to
      compute a value for the property, in place of being used itself.  This helps
      to simplify definition of complex property rules in .ini files, by allowing
      the use of helper classes.  Also, 'naming.LinkRef' and 'naming.Reference'
      (indirectly) support this interface, so you can now use them in .ini files
      to refer to an object via the naming system.  (Previously, 'naming.LinkRef'
      wouldn't do the right thing unless the property was looked up via a
      'config:' URL, and 'naming.Reference' didn't exist.)
   
    - 'peak.util.imports.whenImported()' can now be used even when the specified
      module has already been loaded.
   
    - The naming system no longer has 'objectFactories' and 'stateFactories' as
      utilities; they have been replaced with new mechanisms involving adaptation.
      Previously, addresses had a 'retrieve()' method that could be used to
      retrieve the object defined by the address.  Now, to retrieve an object for
      an address, you must either define a context that processes the address, or
      the address must have a 'defaultFactory' attribute, which provides a name
      to be imported to get an 'IObjectFactory' that can construct the referenced
      object.  (This is simpler than it sounds; for URLs that reference
      ManagedConnections, for example, all you need to do is provide the fully
      qualified name of the connection class.)
   
      Meanwhile, writable naming contexts must have a 'serializationProtocol'
      attribute, specifying what interface an object should be adapted to before
      attempting to store it in that context.
   
      The naming system no longer processes the 'creationName' keyword argument;
      this is now considered the sole responsibility of 'peak.binding'.  The
      'IComponent.lookupComponent()' method still accepts the keyword argument,
      and attribute bindings still handle the creation name transparently.  It is
      just not available via naming system APIs, and naming contexts no longer
      have to deal with it.
   
      The naming system base classes no longer use 'attrs' as an input parameter
      or return value.  If you've subclassed anything from 'peak.naming.contexts',
      note that your '_get()' methods should now just return the lookup value,
      rather than a 'state,attrs' tuple.  For most naming contexts, this just
      means you should change 'return foo, None' statements to just 'return foo'.
   
    - Property definition rules in an .ini file can now refer to 'rulePrefix' and
      'ruleSuffix' variables.  'rulePrefix' is a '.'-terminated string,
      representing the name the rule was defined with.  For example, if the
      rule was defined for '"foo.bar.*"', then 'rulePrefix' will be '"foo.bar."'.
      The 'ruleSuffix' will be the portion of the 'propertyName' that follows
      'rulePrefix'.  So, if looking up property '"foo.bar.baz"', then the
      '"foo.bar.*"' rule will execute with a 'ruleSuffix' of '"baz"'.  This should
      make it easier to work with hierarchical property namespaces.
   
    - Added simple example scripts and small applications in the 'examples'
      directory.
   
    - There is a new command-line namespace introspection tool, 'n2', which
      can be accessed by running 'peak n2'.  Type 'peak n2 -h' for help.
   
    - The PEAK_CONFIG environment variable can now list multiple files, separated
      by the platform's 'os.pathsep' (e.g. ':' on Unix, ';' on Windows).
   
    - It's no longer necessary to provide a '_defaultState()' implementation
      for an EntityDM: a default implementation is now supplied.
   
    - Added automatic installation of 'datetime' package for Python < 2.3.
   
    - CGI support has been moved from 'peak.running.zpublish' into
      'peak.running.commands' (for "raw" CGI/FastCGI) and 'peak.web' (for the
      PEAK high-level publishing framework).  You can use 'peak CGI someName' to
      adapt 'someName' to a 'running.IRerunnableCGI' and run it as a CGI/FastCGI.
   
    - There is now a 'peak.security' package, available from 'peak.api' as
      'security'.  It provides permission management functions: you can define
      abstract permissions by subclassing 'security.Permission', then create
      permission checking rules by subclassing 'security.RuleSet', and declare
      the permissions needed to access attributes of a class with
      'security.allow()'.  The test suite demonstrates a complex application
      ruleset with dynamic, data-driven permissions.
   
    - There is now an interface for "Active Descriptors":
      'binding.IActiveDescriptor'.  'peak.binding' now uses this interface to
      identify active descriptors, so you can now create your own.  (Previously,
      'peak.binding' used 'isinstance()' to detect active descriptors.)
   
    - REMOVED 'naming.ParsedURL'; it was deprecated as of 0.5 alpha 2.
   
    - The 'provides' keyword argument to various 'peak.binding' APIs has been
      renamed to 'offerAs', and it must be a sequence of configuration keys.
      (Previously, it accepted either a single key or a tuple of keys.)
      The signature of 'binding.Constant()' was changed as well; the first
      positional argument is now the constant value, and 'offerAs' is now a
      keyword argument.  (Previously, 'provides' was the first positional argument
      of 'binding.Constant()'.)  The 'registerProvider()' method of
      'config.IConfigurable()' also now accepts only a single configuration key,
      as does 'EigenRegistry.register()'.
   
      Also, all 'peak.binding' APIs now only accept positional parameters for
      items unique to that API.  Items common to multiple APIs (such as 'offerAs',
      'doc', 'attrName', etc.) should now be supplied as keyword arguments.
   
      Bindings also now automatically "suggest" the containing object as a parent
      component for the contained object, whenever a value is assigned to them or
      computed.  If a non-None 'adaptTo' is set on the binding, the value assigned
      or computed will be adapted to the specified protocol before the parent
      component is suggested.  'binding.New()' no longer relies on the
      'IComponentFactory' interface, but instead uses the new adapt/suggest
      mechanisms.
   
      Previously, parent components were only "suggested" when a binding was set
      via component constructor keyword arguments.  Now, this is done at any time
      bindings are set, but *not* for non-binding keyword arguments.  In other
      words, ordinary attributes of a component do not receive "suggested parent"
      notices, even when set via constructor keyword arguments.  If you want an
      attribute to do this, you must define the attribute with the binding API;
      e.g. via 'requireBinding()' or 'binding.Constant()'.  If you do *not* want
      a binding to suggest a parent component, use 'suggestParent=False' in the
      binding definition.
   
    Corrected Problems
   
     - Fixed some problems with the test suite when running under Python 2.3.
       PEAK itself worked fine, but the test suite was bitten by two minor
       semantic changes that took effect in 2.3, resulting in lots of error
       messages about ModuleType needing a parameter, and a test failure for
       'checkClassInfo' in the 'FrameInfoTest' test class.
   
     - Transaction participants that raised an error in their 'abortTransaction()'
       method, would not receive a 'finishTransaction()' call, the error was
       passed through to the transaction service's caller, and later participants
       might not have received an 'abortTransaction()' message either.
   
     - SQL connections didn't close their cursors before aborting a transaction
   
     - The logging system would raise an error if a log message with no arguments
       contained a '%' sign.
   
     - There was a typo in peak.naming.arithmetic that caused homogeneous non-URL
       name subtraction to fail.
   
     - The default reactor supplied in 'peak.running.scheduler' would consume
       CPU continuously if it was waiting for I/O and no tasks were scheduled.
   
     - The 'peak.util.imports.whenImported' function didn't work.
   
   
   
   
 Fixes and Enhancements since Version 0.5 alpha 1  Fixes and Enhancements since Version 0.5 alpha 1
   
  Changed, Enhanced, or Newly Deprecated Features   Changed, Enhanced, or Newly Deprecated Features
Line 12 
Line 363 
    methods to them.     methods to them.
   
  - Added experimental 'invoke.c' script for POSIX-ish platforms with funky   - Added experimental 'invoke.c' script for POSIX-ish platforms with funky
    '#!' support, or lack thereof.  'invoke' is designed to be used like this::     '#!' support, or lack thereof.
   
      'invoke' is designed to be used like this::
   
      #!/usr/local/bin/invoke peak somearg otherarg...       #!/usr/local/bin/invoke peak somearg otherarg...
   
    This should work on most sane platforms with a long-enough commandline.     This should work on most sane platforms with a long-enough commandline.
    (See http://homepages.cwi.nl/~aeb/std/hashexclam-1.html for details on the     (See "this page":http://homepages.cwi.nl/~aeb/std/hashexclam-1.html for
    insanely incompatible ways different Unixes interpret #! lines.)     details on the insanely incompatible ways different Unixes interpret '#!'
      lines.)
   
    The script is not currently built or installed by setup.py.  On the     The script is not currently built or installed by setup.py.  On the
    platforms it's targeted at, you should be able to build it with::     platforms it's targeted at, you should be able to build it with::
Line 29 
Line 383 
   
  - Added a ZConfig schema for 'running.commands.EventDriven' applications,   - Added a ZConfig schema for 'running.commands.EventDriven' applications,
    a ZConfig component definition for adaptive tasks, and a running shortcut     a ZConfig component definition for adaptive tasks, and a running shortcut
    called 'EventDriven'.  It should now be possible to do this::     called 'EventDriven'.
   
      It should now be possible to do this::
   
      #!/usr/bin/env peak EventDriven       #!/usr/bin/env peak EventDriven
   
Line 46 
Line 402 
   
  - Added 'zconfig.schema' URL scheme that loads an enhanced ZConfig schema   - Added 'zconfig.schema' URL scheme that loads an enhanced ZConfig schema
    object that can act as a command line interpreter using the 'peak' script.     object that can act as a command line interpreter using the 'peak' script.
   
    To use it, run 'peak zconfig.schema:urlToSchema urlOfConfig'.  Or, add     To use it, run 'peak zconfig.schema:urlToSchema urlOfConfig'.  Or, add
    a line like this::     a line like this::
   


Generate output suitable for use with a patch program
Legend:
Removed from v.1180  
changed lines
  Added in v.1449

cvs-admin@eby-sarna.com

Powered by ViewCVS 1.0-dev

ViewCVS and CVS Help