You can reach the developer(s) at the development list: - py-configparser-devel at common-lisp.net
+ py-configparser-devel at common-lisp.netFrom ehuelsmann at common-lisp.net Tue Jun 10 20:46:09 2008 From: ehuelsmann at common-lisp.net (ehuelsmann at common-lisp.net) Date: Tue, 10 Jun 2008 16:46:09 -0400 (EDT) Subject: [py-configparser-cvs] r39 - public_html Message-ID: <20080610204609.A8DCF6308A@common-lisp.net> Author: ehuelsmann Date: Tue Jun 10 16:46:08 2008 New Revision: 39 Added: public_html/api-docs.shtml (contents, props changed) Modified: public_html/index.shtml public_html/style.css (props changed) Log: Add API docs (with references from the project page) and a new style sheet. Added: public_html/api-docs.shtml ============================================================================== --- (empty file) +++ public_html/api-docs.shtml Tue Jun 10 16:46:08 2008 @@ -0,0 +1,208 @@ + + + + ++ +py-configparser API documentation + + + + + + +
$Id$
+ Work in progress.
Please note that we're committed to supporting the same + interface as the ConfigParser module, with exceptions. + The exceptions are mostly related to maintenance of ordering + of sections and options: whereas the Python module doesn't maintain + the order encountered in the file, this implementation does.
+ + +Creates a config structure used as in-memory storage of the + configuration.
+ +The default and sections arguments should not be + used and may + be removed in newer releases. The option-name-transform-fn and + section-name-transform-fn arguments are to be functions used to + normalise section and option names. The default value for the former + is #'string-downcase, while the default for the latter is #'identity. +
Returns a of dotted lists where the car is the key and the + cdr the associated value. +
Returns a list of section names, excluding the default section.
Returns NIL if the specified section is not contained in the + config object. A non-NIL value is returned otherwise.
+ +The transformation functions are applied to the section name.
Adds a new section to the config object.
+ +If the section already exists, a "duplicate-section-error" + is raised.
+The transformation functions are applied to the section name + before checking for duplicates.
Returns the list of options which are defined for the specified + section.
+The transformation functions are applied to section-name.
Returns NIL when the specified option does not exist within the + specified section of the config object. A non-NIL value is returned + otherwise.
+ +The transformation functions are applied to section-name and + option-name.
Returns the value of the specified option with type "type", + if specified. Values which contain interpolations are expanded by default, + but this behaviour can be turned off by passing NIL for "expand". +
+ +Defaults may be provided for interpolated values by passing an alist + for "defaults", where the car specifies the %()s argument + name and the cdr specifies the value to be used in its place.
+ +The transformation functions are applied to section-name and + option-name.
Sets the value of the specified option in the specified section + of the config object.
+ +If the section does not exist, a "no-section-error" is + raised. If the option does not exist, it's created.
Returns an alist of items of the specified section of the given config + object. By default, values are expanded, using "defaults" when + given. The format of defaults is the same as for get-option.
+ +The transformation functions are applied to the section name.
+ +To disable expansion of the values, you need to specify NIL for + "expand".
Removes the specified option from the given section of the config + object.
Removes the specified section from the config object.
+If the default section ("DEFAULT") is specified, + an error is raised, because it can't be removed.
Reads the files in the filenames list, incrementally adding and + overwriting values in the config object.
+ +Returns the list of files succesfully read. Note however that + files can only be succesfully skipped by non-existance. If an error + occurs while parsing one of the files, further reading will be + aborted, raising the error instead.
Returns the config object with the sections and options read from + the stream overwriting any pre-existing values.
+All characters on the stream are read. If an error occurs, + processing stops and the error is raised.
none
+ +none
+ +To be documented
+ +To be written
+ + +You can reach the developer(s) at the development list: py-configparser-devel at common-lisp.net
+There's a separate page describing the + package public API. + +
The sources for releases may be downloaded (see below); the + current (active) development may be browsed online + through the WebSVN service.
+From ehuelsmann at common-lisp.net Tue Jun 10 20:48:18 2008 From: ehuelsmann at common-lisp.net (ehuelsmann at common-lisp.net) Date: Tue, 10 Jun 2008 16:48:18 -0400 (EDT) Subject: [py-configparser-cvs] r40 - public_html Message-ID: <20080610204818.0CE736308A@common-lisp.net> Author: ehuelsmann Date: Tue Jun 10 16:48:17 2008 New Revision: 40 Modified: public_html/index.shtml Log: XHTML compliance fix. Modified: public_html/index.shtml ============================================================================== --- public_html/index.shtml (original) +++ public_html/index.shtml Tue Jun 10 16:48:17 2008 @@ -39,7 +39,7 @@API description
There's a separate page describing the - package public API. + package public API.
Source code online
From ehuelsmann at common-lisp.net Tue Jun 10 20:50:45 2008 From: ehuelsmann at common-lisp.net (ehuelsmann at common-lisp.net) Date: Tue, 10 Jun 2008 16:50:45 -0400 (EDT) Subject: [py-configparser-cvs] r41 - public_html Message-ID: <20080610205045.D5F4B6D07A@common-lisp.net> Author: ehuelsmann Date: Tue Jun 10 16:50:45 2008 New Revision: 41 Modified: public_html/api-docs.shtml Log: Another XHTML compliance fix. Modified: public_html/api-docs.shtml ============================================================================== --- public_html/api-docs.shtml (original) +++ public_html/api-docs.shtml Tue Jun 10 16:50:45 2008 @@ -53,7 +53,7 @@
Returns the value of the specified option with type "type", if specified. Values which contain interpolations are expanded by default, but this behaviour can be turned off by passing NIL for "expand". @@ -138,7 +138,7 @@
Returns an alist of items of the specified section of the given config object. By default, values are expanded, using "defaults" when given. The format of defaults is the same as for get-option.
@@ -173,7 +173,7 @@Returns the config object with the sections and options read from the stream overwriting any pre-existing values.
All characters on the stream are read. If an error occurs,
From ehuelsmann at common-lisp.net Sat Jun 14 08:11:02 2008
From: ehuelsmann at common-lisp.net (ehuelsmann at common-lisp.net)
Date: Sat, 14 Jun 2008 04:11:02 -0400 (EDT)
Subject: [py-configparser-cvs] r42 - trunk
Message-ID: <20080614081102.3B0C41B01A@common-lisp.net>
Author: ehuelsmann
Date: Sat Jun 14 04:11:01 2008
New Revision: 42
Modified:
trunk/parser.lisp
Log:
Fix missing files treatment (by ignoring them).
Found by: Ury Marshak The 1.0.3 release fixes the behaviour where READ-FILES was supposed to ignore non-existing files. The 1.0.2 release fixes a function name typo, a problem with (non-)expansion in the ITEMS function and the return value of ENSURE-SECTION. The 1.0.1 release fixes compilation problems with at least SBCL and a packaging problem. Next to that, it adds better error messages. The 1.0 release can be downloaded from http://common-lisp.net/project/py-configparser/releases/py-configparser-1.0.tar.gzReleases
+