Overview

This section of the documentation is an introduction to the practical use of spec_classes. If you are interested in deeply understanding spec-classes, it is recommended you read the following subsections in order, as each subsection assumes knowledge introduced previously. If you only want a quick sense of what spec-classes look like, please refer to the Examples section.

Note

This documentation is predominantly targeted at developers integrating spec-classes into their project(s). Spec classes are designed to be intuitive, and generated helper methods have fairly thorough documentation that users can access using help(<class/instance>.<helper_method>). As such, while users of classes generated using spec-classes may find this documentation useful, they are likely to get nearly as much value out of just inspecting the spec class instances interactively.

Once you are familiar with how spec classes work in practice, feel free to move on to the Implementation Details section if you are interested in understanding how things are implemented under the hood, tips for integrating it into your projects, and/or the performance considerations of doing so.