This is the py-configparser Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Mar 15 07:20:30 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
py-configparserCommon Lisp implementation of the Python ConfigParser module
Erik Huelsmann
MIT
parse-number (system).
package.lisp (file).
config.lisp (file).
parser.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
py-configparser/py-configparser.asdpy-configparser/package.lisppy-configparser/config.lisppy-configparser/parser.lisppy-configparser/py-configparser.asdpy-configparser (system).
py-configparser/config.lisppackage.lisp (file).
py-configparser (system).
add-section (function).
config (structure).
configparser-error (condition).
defaults (function).
duplicate-section-error (condition).
get-option (function).
has-option-p (function).
has-section-p (function).
interpolation-depth-error (condition).
interpolation-error (condition).
interpolation-missing-option-error (condition).
interpolation-syntax-error (condition).
items (function).
make-config (function).
no-option-error (condition).
no-section-error (condition).
options (function).
remove-option (function).
remove-section (function).
sections (function).
set-option (function).
%expand-option-value (function).
%extract-replacement (function).
%get-option (function).
%get-section (function).
%option-value (function).
%validate-option-name (function).
%validate-section-name (function).
config-defaults (reader).
(setf config-defaults) (writer).
config-error (condition).
config-option-name-transform-fn (reader).
(setf config-option-name-transform-fn) (writer).
config-p (function).
config-section-name-transform-fn (reader).
(setf config-section-name-transform-fn) (writer).
config-sections (reader).
(setf config-sections) (writer).
copy-config (function).
copy-section (function).
make-section (function).
norm-option-name (function).
norm-section-name (function).
section (structure).
section-name (reader).
(setf section-name) (writer).
section-options (reader).
(setf section-options) (writer).
section-p (function).
py-configparser/parser.lispconfig.lisp (file).
py-configparser (system).
missing-section-header-error (condition).
parsing-error (condition).
read-files (function).
read-stream (function).
write-stream (function).
%format-value (function).
%read-char (function).
ensure-section (function).
expect-char (function).
expect-one-of (function).
extend-input (function).
file (reader method).
finalize-input (function).
is-comment-char (function).
is-whitespace (function).
line (reader method).
make-input-buffer (function).
message (reader method).
read-option-name (function).
read-option-value (function).
read-section-name (function).
reading-driver (function).
section (reader method).
skip-empty-line (function).
skip-to-eol (function).
skip-whitespace (function).
Packages are listed by definition order.
py-configparsercommon-lisp.
add-section (function).
config (structure).
configparser-error (condition).
defaults (function).
duplicate-section-error (condition).
get-option (function).
has-option-p (function).
has-section-p (function).
interpolation-depth-error (condition).
interpolation-error (condition).
interpolation-missing-option-error (condition).
interpolation-syntax-error (condition).
items (function).
make-config (function).
missing-section-header-error (condition).
no-option-error (condition).
no-section-error (condition).
options (function).
parsing-error (condition).
read-files (function).
read-stream (function).
remove-option (function).
remove-section (function).
sections (function).
set-option (function).
write-stream (function).
%expand-option-value (function).
%extract-replacement (function).
%format-value (function).
%get-option (function).
%get-section (function).
%option-value (function).
%read-char (function).
%validate-option-name (function).
%validate-section-name (function).
*current-input* (special variable).
*current-section* (special variable).
*file-name* (special variable).
*line-no* (special variable).
config-defaults (reader).
(setf config-defaults) (writer).
config-error (condition).
config-option-name-transform-fn (reader).
(setf config-option-name-transform-fn) (writer).
config-p (function).
config-section-name-transform-fn (reader).
(setf config-section-name-transform-fn) (writer).
config-sections (reader).
(setf config-sections) (writer).
copy-config (function).
copy-section (function).
ensure-section (function).
expect-char (function).
expect-one-of (function).
extend-input (function).
file (generic reader).
finalize-input (function).
is-comment-char (function).
is-whitespace (function).
line (generic reader).
make-input-buffer (function).
make-section (function).
message (generic reader).
norm-option-name (function).
norm-section-name (function).
read-option-name (function).
read-option-value (function).
read-section-name (function).
reading-driver (function).
section (generic reader).
section (structure).
section-name (reader).
(setf section-name) (writer).
section-options (reader).
(setf section-options) (writer).
section-p (function).
skip-empty-line (function).
skip-to-eol (function).
skip-whitespace (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Adds a new section to the config.
If the section exists, the ‘duplicate-section-error’ is raised.
Returns an alist containing instance wide defaults, where the elements are 2-element dotted lists: the CDR is the value associated with the key.
Returns the value of the specified option in the specified section.
If ‘expand’ is ‘NIL’, any options which depend on other options
won’t be expanded and the raw configuration value is returned.
When ‘defaults’ is an alist of which the elements are dotted lists of key/value pairs, these values are used in the expansion of option values.
‘type’ may be one of ‘:boolean’, ‘:number’ or it may remain unspecified.
Returns a generalised boolean with a value of ‘NIL’ when the specified option does not exist in the specified section and some other value otherwise.
Returns ‘NIL’ when the section is not added to the config yet, some other value if it is.
Returns an alist of which the items are dotted lists of key/value pairs being the option names and values specified in the given section.
When ‘expand’ is ‘NIL’, options are returned in raw form. Otherwise
option values are expanded.
The definition of ‘defaults’ is the same as for ‘get-option’.
Returns a list of option names which are defined in the given section.
Parses the files given in the list ‘filenames’, if they exist.
The list is processed first to last, overwriting any pre-existing
values with the last value read.
The results are stored in ‘config’ which is modified destructively.
Returns as values the configuration and the list of files actually read.
Parses the content of ‘stream’ as a configuration file, storing any values in ‘config’ which is modified destructively.
This function maps from the python ’readfp()’ function.
Remove the specified option from the given section.
Remove the specified section.
In case the section name equals the magic name ‘DEFAULT’, an error is raised, since this section can’t be removed.
Returns a list of names of defined sections.
Sets the value of the specified option in the specified section.
If the section does not exist, a ‘no-section-error’ is raised. If the option does not exist, it is created.
Writes the configuration file corresponding to the
in-memory config state. Reloading the file
with ‘read-stream’ or ‘read-files’ will restore config state.
error.
(quote py-configparser::*line-no*)
:line-no
line.
This slot is read-only.
(quote py-configparser::*file-name*)
:file
file.
This slot is read-only.
(quote py-configparser::*current-section*)
:section
This slot is read-only.
structure-object.
(py-configparser::make-section :name "default")
(function string-downcase)
(function identity)
name.
parsing-error)) ¶file.
parsing-error)) ¶parsing-error)) ¶parsing-error)) ¶| Jump to: | %
(
A C D E F G H I L M N O R S W |
|---|
| Jump to: | %
(
A C D E F G H I L M N O R S W |
|---|
| Jump to: | *
D F L M N O S |
|---|
| Jump to: | *
D F L M N O S |
|---|
| Jump to: | C D F I M N P S |
|---|
| Jump to: | C D F I M N P S |
|---|