Welcome to ExpandObjects’s documentation!

Model Documentation

Exception Classes

expandobjects.main.main()

This is the main command line entry point to this library. After a pip install, a binary will be available on the Python bin path called “expand_objects”, which provides an entry point into this function.

Currently this function accepts two positional arguments: 1. The name of the file to be expanded 2. An optional output name. If not provided, the output file will be expanded.idf (in the input file directory)

Example usage: $ expand_objects /path/to/my.idf /path/to/expanded_file_name.idf

expandobjects.main.sub_worker(these_argv, raise_exceptions=False, print_error_messages=True)

This does the heavy lifting of processing command line args and preparing for an actual expansion

expandobjects.main.usage(binary_name)

Provides a usage string that can be printed to terminal or otherwise

Exception Classes

exception expandobjects.exceptions.BasePyExpandObjectsException

Base class for all PyExpandObjects related exceptions

exception expandobjects.exceptions.FileIOProblem

Raised when there is a file IO problem, such as a file getting deleted

exception expandobjects.exceptions.InvalidCommandLineArguments

Raised when there is a problem with the command line arguments

exception expandobjects.exceptions.VirtualMethodUse(base_class_name, method_name)

Raised when a pure virtual method is called instead of calling the derived class method

Expansion Classes

class expandobjects.expansions.expansion_base.BaseExpansion

The base ExpandObjects rule class, to be derived for each expansion rule

do_idf_expansion(input_context)

Virtual method for performing an expansion on IDF, should take some form of IDF object and return ...

do_json_expansion(input_context)

Virtual method for performing an expansion on JSON, should take an object and return one

IO Classes

class expandobjects.io.input_base.BaseInputProcessor

The base input processor class, to be derived for IDF and JSON classes

read_file()

Base read_file definition; will need to add arguments and such

Indices and tables

• Index
• Module Index
• Search Page