[Zope3-checkins] CVS: Packages/ZConfig/doc - zconfig.tex:1.35.10.10
Fred L. Drake, Jr.
fred@zope.com
Wed, 25 Dec 2002 00:51:51 -0500
Update of /cvs-repository/Packages/ZConfig/doc
In directory cvs.zope.org:/tmp/cvs-serv16473
Modified Files:
Tag: zconfig-schema-devel-branch
zconfig.tex
Log Message:
Docs for additional data types; LaTeXized from text by Chris.
=== Packages/ZConfig/doc/zconfig.tex 1.35.10.9 => 1.35.10.10 ===
--- Packages/ZConfig/doc/zconfig.tex:1.35.10.9 Fri Dec 20 17:11:17 2002
+++ Packages/ZConfig/doc/zconfig.tex Wed Dec 25 00:51:51 2002
@@ -245,6 +245,33 @@
\constant{False}. Comparisons are case-insensitive. All other
input strings are disallowed.
+\term{constructor}
+ Parse value in the form \samp{fn('1', '2', kw1='a', kw2='b')} into a
+ 3-tuple where the first element is the string \code{'fn'}, the 2nd
+ element is the list \code{['1','2']}, and the 3rd element is the
+ dictionary \code{\{'kw1': 'a', 'kw2': 'b'\}}. This is useful when
+ representing a Python-style constructor as a value. Python syntax
+ rules are enforced, but only constants are allowed as positional and
+ keyword arguments. The 3-tuple is returned.
+
+\term{existing-dirpath}
+ Validates that the directory portion of a pathname exists. For
+ example, if the value provided is \file{/foo/bar}, \file{/foo} must
+ be an existing directory. No conversion is performed.
+
+\term{existing-directory}
+ Validates that a directory by the given name exists on
+ the local filesystem. No conversion is performed.
+
+\term{existing-file}
+ Validates that a file by the given name exists. No conversion
+ is performed.
+
+\term{existing-path}
+ Validates that a path (file, directory, or symlink) by the
+ given name exists on the local filesystem. No conversion
+ is performed.
+
\term{float}
A Python float. \code{Inf}, \code{-Inf}, and \code{NaN} are not
allowed.
@@ -262,6 +289,16 @@
Convert a value to an integer. This will be a Python \class{int} if
the value is in the range allowed by \class{int}, otherwise a Python
\class{long} is returned.
+
+\term{ipaddr-or-hostname}
+ Validates a valid IP address or hostname. If the first
+ character is a digit, the value is assumed to be an IP
+ address. If the first string is not a digit, the value
+ is assumed to be a hostname. No conversion is performed.
+
+\term{key-value}
+ Parse a value in the form \code{'A B'} into the list \code{['A',
+ 'B']}. Returns the list.
\term{locale}
Any valid locale specifier accepted by the available