Module pyreport.base.environment

This module contains the Environment class, which is the abstract base class for all environments.

Classes

class Environment (name)

Abstract base class for all environments.

Constructor for Environment. Note that this class cannot not be instantiated.

Parameters

name : str

Name of environment.

Ancestors

• abc.ABC

Subclasses

• Document
• Segment

Methods

def add_to_content(self, obj)

Adds an object to the environment.

Parameters

obj : Environment, LaTeXObject

Object to add to environment.

def get_structure(self, indent_level=0)

Returns the structure of the environment as a string.

Parameters

indent_level : int, optional

Indentation level, by default 0.

def texify(self, file, indent_level=0)

Writes the environment to a .tex-file.

Parameters

file : file

File to write to.

indent_level : int, optional

Indentation level, by default 0.