pylatex.basic

This module implements several classes that represent basic latex commands.

class NewPage(arguments=None, options=None, *, extra_arguments=None)

Bases: pylatex.base_classes.command.CommandBase

A command that adds a new page to the document.

Parameters:

• arguments (None, str, list or Arguments) – The main arguments of the command.
• options (None, str, list or Options) – Options of the command. These are placed in front of the arguments.
• extra_arguments (None, str, list or Arguments) – Extra arguments for the command. When these are supplied the options will be placed before them instead of before the normal arguments. This allows for a way of having one or more arguments before the options.

class LineBreak(arguments=None, options=None, *, extra_arguments=None)

Bases: pylatex.basic.NewPage

A command that adds a line break to the document.

Parameters:

• arguments (None, str, list or Arguments) – The main arguments of the command.
• options (None, str, list or Options) – Options of the command. These are placed in front of the arguments.
• extra_arguments (None, str, list or Arguments) – Extra arguments for the command. When these are supplied the options will be placed before them instead of before the normal arguments. This allows for a way of having one or more arguments before the options.

class NewLine(arguments=None, options=None, *, extra_arguments=None)

Bases: pylatex.basic.NewPage

A command that adds a new line to the document.

Parameters:

• arguments (None, str, list or Arguments) – The main arguments of the command.
• options (None, str, list or Options) – Options of the command. These are placed in front of the arguments.
• extra_arguments (None, str, list or Arguments) – Extra arguments for the command. When these are supplied the options will be placed before them instead of before the normal arguments. This allows for a way of having one or more arguments before the options.

class HFill(arguments=None, options=None, *, extra_arguments=None)

Bases: pylatex.basic.NewPage

A command that fills the current line in the document.

Parameters:

• arguments (None, str, list or Arguments) – The main arguments of the command.
• options (None, str, list or Options) – Options of the command. These are placed in front of the arguments.
• extra_arguments (None, str, list or Arguments) – Extra arguments for the command. When these are supplied the options will be placed before them instead of before the normal arguments. This allows for a way of having one or more arguments before the options.

class HugeText(data=None)

Bases: pylatex.base_classes.containers.Environment

An environment which makes the text size ‘Huge’.

Parameters:data (str or LatexObject) – The string or LatexObject to be formatted.

omit_if_empty = False

class LargeText(data=None)

Bases: pylatex.basic.HugeText

An environment which makes the text size ‘Large’.

Parameters:data (str or LatexObject) – The string or LatexObject to be formatted.

omit_if_empty = False

class MediumText(data=None)

Bases: pylatex.basic.HugeText

An environment which makes the text size ‘large’.

Parameters:data (str or LatexObject) – The string or LatexObject to be formatted.

omit_if_empty = False

class SmallText(data=None)

Bases: pylatex.basic.HugeText

An environment which makes the text size ‘small’.

Parameters:data (str or LatexObject) – The string or LatexObject to be formatted.

omit_if_empty = False

class FootnoteText(data=None)

Bases: pylatex.basic.HugeText

An environment which makes the text size ‘footnotesize’.

Parameters:data (str or LatexObject) – The string or LatexObject to be formatted.

omit_if_empty = False

class TextColor(color, data)

Bases: pylatex.base_classes.containers.ContainerCommand

An environment which changes the text color of the data.

Parameters:

• color (str) – The color to set for the data inside of the environment.
• data (str or LatexObject) – The string or LatexObject to be formatted.

omit_if_empty = False