Module includer

Introduction

Include Syntax

   %include "/absolute/path/to/file"
   %include "../relative/path/to/file"
   %include "local_reference"
   %include "http://localhost/path/to/my.config"

Relative and local file references are relative to the including file or URL. That, if an Includer is processing file "/home/bmc/foo.txt" and encounters an attempt to include file "bar.txt", it will assume "bar.txt" is to be found in "/home/bmc".

Similarly, if an Includer is processing URL "http://localhost/bmc/foo.txt" and encounters an attempt to include file "bar.txt", it will assume "bar.txt" is to be found at "http://localhost/bmc/bar.txt".

Nested includes are permitted; that is, an included file may, itself, include other files. The maximum recursion level is configurable and defaults to 100.

Usage

This module provides an Includer class, which processes include directives in a file and behaves like a file-like object. See the class documentation for more details.

Examples

   import includer
   import sys

   inc = includer.Includer(path)
   for line in inc:
       sys.stdout.write(line)

   import logging
   import includer

   logging.fileConfig(includer.preprocess("mylog.cfg"))