Config - agate 1.13.0 documentation

Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
View this page
Toggle table of contents sidebar

# Config

This module contains the global configuration for agate. Users should use `get_option()` and `set_option()` to modify the global configuration.

Available configuation options:

Option | Description | Default value
--- | --- | ---
default_locale | Default locale for number formatting | default_locale(‘LC_NUMERIC’) or ‘en_US’
horizontal_line_char | Character to render for horizontal lines | ‘-’
vertical_line_char | Character to render for vertical lines | ‘|’
bar_char | Character to render for bar chart units | ‘░’
printable_bar_char | Printable character for bar chart units | ‘:’
zero_line_char | Character to render for zero line units | ‘▓’
printable_zero_line_char | Printable character for zero line units | ‘|’
tick_char | Character to render for axis ticks | ‘+’
ellipsis_chars | Characters to render for ellipsis | ‘…’
text_truncation_chars | Characters for truncated text values | ‘…’
number_truncation_chars | Characters for truncated number values | ‘…’

agate.config.get_option(key)

  Get a global configuration option for agate.

  Parameters:

    key – The name of the configuration option.

agate.config.set_option(key, value)

  Set a global configuration option for agate.

  Parameters:

    - key – The name of the configuration option.

    - value – The new value to set for the configuration option.

agate.config.set_options(options)

  Set a dictionary of options simultaneously.

  Parameters:

    hash – A dictionary of option names and values.