The py-configparser Reference Manual

Table of Contents

The py-configparser Reference Manual

This is the py-configparser Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 18:58:22 2020 GMT+0.

1 Introduction

$URL: https://svn.common-lisp.net/py-configparser/trunk/README $
$Id: README 19 2008-03-14 20:17:12Z ehuelsmann $

py-configparser
===============

This package provides the same functionality as the Python configparser module,
implemented in pure Common Lisp.


Differences between the two
===========================

The CL version makes a strong distinction in the parser on one hand and the in-memory
storage management on the other hand.  Because of it, the CL version doesn't call its
objects 'Parser', but 'config' instead.

The parser/writer part of the package provides the three functions READ-STREAM,
READ-FILES and WRITE-STREAM, which map from the python variants 'readfp', 'read'
and 'write'.


API mapping
===========

The functions provided in the Python module (which are all methods of the ConfigParser
class):

ConfigParser() -> (make-config)
defaults() ->  (defaults )
sections() ->  (sections )
add_section(name) -> (add-section  name)
has_section(name) -> (has-section-p  name)
options(section_name) -> (options  section-name)
has_option(section_name, name) -> (has-option-p  section-name name)
read(filenames) -> (read-files  filenames)
readfd(fp) -> (read-stream  stream)
get(section, option[, raw[, vars]]) ->
          (get-option  section option &key expand defaults type)
getint(section, option) -> [folded into get-option using 'type' key]
getfloat(section, option) -> [folded into get-option using 'type' key]
getboolean(section, option) -> [folded into get-option using 'type' key]
items(section_name[, raw[, vars]]) -> (items  section-name &key expand defaults)
set(section, option, value) -> (set-option  section-name option-name value)
write(fp) -> (write-stream  stream)
remove_option(section, option) -> (remove-option  section-name option-name)
remove_section(section) -> (remove-section  section-name)

Note that the above is just a simple mapping table, but is all you need to get
you started.  Documentation from the ConfigParser module should sufficiently document
this package.  However minor differences in parameter and method naming may occur.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 py-configparser

Author

Erik Huelsmann

License

MIT

Description

Common Lisp implementation of the Python ConfigParser module

Dependency

parse-number

Source

py-configparser.asd (file)

Components

• package.lisp (file)
• config.lisp (file)
• parser.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 py-configparser.asd

Location

py-configparser.asd

Systems

py-configparser (system)

Packages

py-configparser-system

3.1.2 py-configparser/package.lisp

Parent

py-configparser (system)

Location

package.lisp

Packages

py-configparser

3.1.3 py-configparser/config.lisp

Dependency

package.lisp (file)

Parent

py-configparser (system)

Location

config.lisp

Exported Definitions

• 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)

Internal Definitions

• %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 (function)
• (setf config-defaults) (function)
• config-error (condition)
• config-option-name-transform-fn (function)
• (setf config-option-name-transform-fn) (function)
• config-p (function)
• config-section-name-transform-fn (function)
• (setf config-section-name-transform-fn) (function)
• config-sections (function)
• (setf config-sections) (function)
• copy-config (function)
• copy-section (function)
• make-section (function)
• norm-option-name (function)
• norm-section-name (function)
• section (structure)
• section-name (function)
• (setf section-name) (function)
• section-options (function)
• (setf section-options) (function)
• section-p (function)

3.1.4 py-configparser/parser.lisp

Dependency

config.lisp (file)

Parent

py-configparser (system)

Location

parser.lisp

Exported Definitions

• missing-section-header-error (condition)
• parsing-error (condition)
• read-files (function)
• read-stream (function)
• write-stream (function)

Internal Definitions

• %format-value (function)
• %read-char (function)
• ensure-section (function)
• expect-char (function)
• expect-one-of (function)
• extend-input (function)
• file (method)
• finalize-input (function)
• is-comment-char (function)
• is-whitespace (function)
• line (method)
• make-input-buffer (function)
• message (method)
• read-option-name (function)
• read-option-value (function)
• read-section-name (function)
• reading-driver (function)
• section (method)
• skip-empty-line (function)
• skip-to-eol (function)
• skip-whitespace (function)

4 Packages

Packages are listed by definition order.

4.1 py-configparser-system

Source

py-configparser.asd

Use List

• asdf/interface
• common-lisp

4.2 py-configparser

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• 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)

Internal Definitions

• %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 (function)
• (setf config-defaults) (function)
• config-error (condition)
• config-option-name-transform-fn (function)
• (setf config-option-name-transform-fn) (function)
• config-p (function)
• config-section-name-transform-fn (function)
• (setf config-section-name-transform-fn) (function)
• config-sections (function)
• (setf config-sections) (function)
• copy-config (function)
• copy-section (function)
• ensure-section (function)
• expect-char (function)
• expect-one-of (function)
• extend-input (function)
• file (generic function)
• file (method)
• finalize-input (function)
• is-comment-char (function)
• is-whitespace (function)
• line (generic function)
• line (method)
• make-input-buffer (function)
• make-section (function)
• message (generic function)
• message (method)
• 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 function)
• section (method)
• section (structure)
• section-name (function)
• (setf section-name) (function)
• section-options (function)
• (setf section-options) (function)
• section-p (function)
• skip-empty-line (function)
• skip-to-eol (function)
• skip-whitespace (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: add-section CONFIG SECTION-NAME

Adds a new section to the config.

If the section exists, the ‘duplicate-section-error’ is raised.

Package

py-configparser

Source

config.lisp (file)

Function: defaults CONFIG

Returns an alist containing instance wide defaults, where the elements are 2-element dotted lists: the CDR is the value associated with the key.

Package

py-configparser

Source

config.lisp (file)

Function: get-option CONFIG SECTION-NAME OPTION-NAME &key EXPAND DEFAULTS TYPE

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.

Package

py-configparser

Source

config.lisp (file)

Function: has-option-p CONFIG SECTION-NAME OPTION-NAME

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.

Package

py-configparser

Source

config.lisp (file)

Function: has-section-p CONFIG SECTION-NAME

Returns ‘NIL’ when the section is not added to the config yet, some other value if it is.

Package

py-configparser

Source

config.lisp (file)

Function: items CONFIG SECTION-NAME &key EXPAND DEFAULTS

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’.

Package

py-configparser

Source

config.lisp (file)

Function: make-config &key (DEFAULTS DEFAULTS) (SECTIONS SECTIONS) (OPTION-NAME-TRANSFORM-FN OPTION-NAME-TRANSFORM-FN) (SECTION-NAME-TRANSFORM-FN SECTION-NAME-TRANSFORM-FN)

Package

py-configparser

Source

config.lisp (file)

Function: options CONFIG SECTION-NAME

Returns a list of option names which are defined in the given section.

Package

py-configparser

Source

config.lisp (file)

Function: read-files CONFIG FILENAMES

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.

Package

py-configparser

Source

parser.lisp (file)

Function: read-stream CONFIG STREAM &key STREAM-NAME

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.

Package

py-configparser

Source

parser.lisp (file)

Function: remove-option CONFIG SECTION-NAME OPTION-NAME

Remove the specified option from the given section.

Package

py-configparser

Source

config.lisp (file)

Function: remove-section CONFIG SECTION-NAME

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.

Package

py-configparser

Source

config.lisp (file)

Function: sections CONFIG

Returns a list of names of defined sections.

Package

py-configparser

Source

config.lisp (file)

Function: set-option CONFIG SECTION-NAME OPTION-NAME VALUE

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.

Package

py-configparser

Source

config.lisp (file)

Function: write-stream CONFIG STREAM

Writes the configuration file corresponding to the in-memory config state. Reloading the file
with ‘read-stream’ or ‘read-files’ will restore config state.

Package

py-configparser

Source

parser.lisp (file)

5.1.2 Conditions

Condition: configparser-error ()

Package

py-configparser

Source

config.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• config-error (condition)
• parsing-error (condition)

Condition: duplicate-section-error ()

Package

py-configparser

Source

config.lisp (file)

Direct superclasses

config-error (condition)

Condition: interpolation-depth-error ()

Package

py-configparser

Source

config.lisp (file)

Direct superclasses

interpolation-error (condition)

Condition: interpolation-error ()

Package

py-configparser

Source

config.lisp (file)

Direct superclasses

config-error (condition)

Direct subclasses

• interpolation-depth-error (condition)
• interpolation-missing-option-error (condition)
• interpolation-syntax-error (condition)

Condition: interpolation-missing-option-error ()

Package

py-configparser

Source

config.lisp (file)

Direct superclasses

interpolation-error (condition)

Condition: interpolation-syntax-error ()

Package

py-configparser

Source

config.lisp (file)

Direct superclasses

interpolation-error (condition)

Condition: missing-section-header-error ()

Package

py-configparser

Source

parser.lisp (file)

Direct superclasses

parsing-error (condition)

Condition: no-option-error ()

Package

py-configparser

Source

config.lisp (file)

Direct superclasses

config-error (condition)

Condition: no-section-error ()

Package

py-configparser

Source

config.lisp (file)

Direct superclasses

config-error (condition)

Condition: parsing-error ()

Package

py-configparser

Source

parser.lisp (file)

Direct superclasses

configparser-error (condition)

Direct subclasses

missing-section-header-error (condition)

Direct methods

• message (method)
• section (method)
• file (method)
• line (method)

Direct slots

Slot: line-no

Initargs

:line-no

Initform

(quote py-configparser::*line-no*)

Readers

line (generic function)

Slot: file

Initargs

:file

Initform

(quote py-configparser::*file-name*)

Readers

file (generic function)

Slot: section

Initargs

:section

Initform

(quote py-configparser::*current-section*)

Readers

section (generic function)

Slot: message

Initargs

:text

Readers

message (generic function)

5.1.3 Structures

Structure: config ()

Package

py-configparser

Source

config.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: defaults

Initform

(py-configparser::make-section :name "default")

Readers

config-defaults (function)

Writers

(setf config-defaults) (function)

Slot: sections

Readers

config-sections (function)

Writers

(setf config-sections) (function)

Slot: option-name-transform-fn

Initform

(function string-downcase)

Readers

config-option-name-transform-fn (function)

Writers

(setf config-option-name-transform-fn) (function)

Slot: section-name-transform-fn

Initform

(function identity)

Readers

config-section-name-transform-fn (function)

Writers

(setf config-section-name-transform-fn) (function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *current-input*

Package

py-configparser

Special Variable: *current-section*

Package

py-configparser

Special Variable: *file-name*

Package

py-configparser

Special Variable: *line-no*

Package

py-configparser

5.2.2 Functions

Function: %expand-option-value CONFIG SECTION OPTION-VALUE DEFAULTS &optional DEPENDEES

Package

py-configparser

Source

config.lisp (file)

Function: %extract-replacement OPTION-VALUE

Package

py-configparser

Source

config.lisp (file)

Function: %format-value VALUE

Package

py-configparser

Source

parser.lisp (file)

Function: %get-option CONFIG SECTION-NAME OPTION-NAME IF-DOES-NOT-EXIST

Package

py-configparser

Source

config.lisp (file)

Function: %get-section CONFIG SECTION-NAME

Package

py-configparser

Source

config.lisp (file)

Function: %option-value CONFIG SECTION OPTION-NAME &key DEFAULTS

Package

py-configparser

Source

config.lisp (file)

Function: %read-char STREAM

Package

py-configparser

Source

parser.lisp (file)

Function: %validate-option-name NAME

Package

py-configparser

Source

config.lisp (file)

Function: %validate-section-name NAME

Package

py-configparser

Source

config.lisp (file)

Function: config-defaults INSTANCE

Function: (setf config-defaults) VALUE INSTANCE

Package

py-configparser

Source

config.lisp (file)

Function: config-option-name-transform-fn INSTANCE

Function: (setf config-option-name-transform-fn) VALUE INSTANCE

Package

py-configparser

Source

config.lisp (file)

Function: config-p OBJECT

Package

py-configparser

Source

config.lisp (file)

Function: config-section-name-transform-fn INSTANCE

Function: (setf config-section-name-transform-fn) VALUE INSTANCE

Package

py-configparser

Source

config.lisp (file)

Function: config-sections INSTANCE

Function: (setf config-sections) VALUE INSTANCE

Package

py-configparser

Source

config.lisp (file)

Function: copy-config INSTANCE

Package

py-configparser

Source

config.lisp (file)

Function: copy-section INSTANCE

Package

py-configparser

Source

config.lisp (file)

Function: ensure-section CONFIG SECTION-NAME

Package

py-configparser

Source

parser.lisp (file)

Function: expect-char S EXPECT &key SKIP-WHITESPACE

Package

py-configparser

Source

parser.lisp (file)

Function: expect-one-of S EXPECT-BAG &key SKIP-WHITESPACE

Package

py-configparser

Source

parser.lisp (file)

Function: extend-input P C

Package

py-configparser

Source

parser.lisp (file)

Function: finalize-input P

Package

py-configparser

Source

parser.lisp (file)

Function: is-comment-char C

Package

py-configparser

Source

parser.lisp (file)

Function: is-whitespace C

Package

py-configparser

Source

parser.lisp (file)

Function: make-input-buffer P

Package

py-configparser

Source

parser.lisp (file)

Function: make-section &key (NAME NAME) (OPTIONS OPTIONS)

Package

py-configparser

Source

config.lisp (file)

Function: norm-option-name CONFIG OPTION-NAME

Package

py-configparser

Source

config.lisp (file)

Function: norm-section-name CONFIG SECTION-NAME

Package

py-configparser

Source

config.lisp (file)

Function: read-option-name P S

Package

py-configparser

Source

parser.lisp (file)

Function: read-option-value P S &key LEADING-WHITE

Package

py-configparser

Source

parser.lisp (file)

Function: read-section-name P S

Package

py-configparser

Source

parser.lisp (file)

Function: reading-driver P S

Package

py-configparser

Source

parser.lisp (file)

Function: section-name INSTANCE

Function: (setf section-name) VALUE INSTANCE

Package

py-configparser

Source

config.lisp (file)

Function: section-options INSTANCE

Function: (setf section-options) VALUE INSTANCE

Package

py-configparser

Source

config.lisp (file)

Function: section-p OBJECT

Package

py-configparser

Source

config.lisp (file)

Function: skip-empty-line S

Package

py-configparser

Source

parser.lisp (file)

Function: skip-to-eol S

Package

py-configparser

Source

parser.lisp (file)

Function: skip-whitespace S

Package

py-configparser

Source

parser.lisp (file)

5.2.3 Generic functions

Generic Function: file CONDITION

Package

py-configparser

Methods

Method: file (CONDITION parsing-error)

Source

parser.lisp (file)

Generic Function: line CONDITION

Package

py-configparser

Methods

Method: line (CONDITION parsing-error)

Source

parser.lisp (file)

Generic Function: message CONDITION

Package

py-configparser

Methods

Method: message (CONDITION parsing-error)

Source

parser.lisp (file)

Generic Function: section CONDITION

Package

py-configparser

Methods

Method: section (CONDITION parsing-error)

Source

parser.lisp (file)

5.2.4 Conditions

Condition: config-error ()

Package

py-configparser

Source

config.lisp (file)

Direct superclasses

configparser-error (condition)

Direct subclasses

• no-section-error (condition)
• duplicate-section-error (condition)
• no-option-error (condition)
• interpolation-error (condition)

5.2.5 Structures

Structure: section ()

Package

py-configparser

Source

config.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: name

Readers

section-name (function)

Writers

(setf section-name) (function)

Slot: options

Readers

section-options (function)

Writers

(setf section-options) (function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types