pylatex.config

This module implements the ability to use of different configurations.

The current active configuration is pylatex.config.active. This variable can simply be changed to another configuration and that will be used.

It is also possible to use the use method to do this temporarily in a specific context.

class Version1(**kwargs)

Bases: object

The config used to get the behaviour of v1.x.y of the library.

The default attributes are:

indent = True
booktabs = False
microtype = False
row_height = None

Parameters:kwargs – Key value pairs of the default attributes that should be overridden

indent = True

booktabs = False

microtype = False

row_height = None

use()

Use the config temporarily in specific context.

A simple usage example:

with Version1(indent=False).use():
    # Do stuff where indent should be False
    ...

change(**kwargs)

Override some attributes of the config in a specific context.

A simple usage example:

with pylatex.config.active.change(indent=False):
    # Do stuff where indent should be False
    ...

Parameters:kwargs – Key value pairs of the default attributes that should be overridden

Default

The default configuration in this release. Currently the same as Version1

alias of Version1

class Version2(**kwargs)

Bases: pylatex.config.Version1

The config used to get the behaviour of v2.x.y of the library.

The default attributes are:

indent = False
booktabs = True
microtype = True
row_height = 1.3

Parameters:kwargs – Key value pairs of the default attributes that should be overridden

indent = False

booktabs = True

microtype = True

row_height = 1.3

change(**kwargs)

Override some attributes of the config in a specific context.

A simple usage example:

with pylatex.config.active.change(indent=False):
    # Do stuff where indent should be False
    ...

Parameters:kwargs – Key value pairs of the default attributes that should be overridden

use()

Use the config temporarily in specific context.

A simple usage example:

with Version1(indent=False).use():
    # Do stuff where indent should be False
    ...

NextMajor

The default configuration in the nxt major release. Currently the same as Version2.

alias of Version2

active = <pylatex.config.Version1 object>

The current active configuration