sqlmesh.core.config.format

 1from __future__ import annotations
 2
 3import typing as t
 4
 5from sqlmesh.core.config.base import BaseConfig
 6
 7
 8class FormatConfig(BaseConfig):
 9    """The format configuration for SQL code.
10
11    Args:
12        normalize: Whether to normalize the SQL code or not.
13        pad: The number of spaces to use for padding.
14        indent: The number of spaces to use for indentation.
15        normalize_functions: Whether or not to normalize all function names. Possible values are: 'upper', 'lower'
16        leading_comma: Whether to use leading commas or not.
17        max_text_width: The maximum text width in a segment before creating new lines.
18        append_newline: Whether to append a newline to the end of the file or not.
19        no_rewrite_casts: Preserve the existing casts, without rewriting them to use the :: syntax.
20    """
21
22    normalize: bool = False
23    pad: int = 2
24    indent: int = 2
25    normalize_functions: t.Optional[str] = None
26    leading_comma: bool = False
27    max_text_width: int = 80
28    append_newline: bool = False
29    no_rewrite_casts: bool = False
30
31    @property
32    def generator_options(self) -> t.Dict[str, t.Any]:
33        """Options which can be passed through to the SQLGlot Generator class.
34
35        Returns:
36            The generator options.
37        """
38        return self.dict(exclude={"append_newline", "no_rewrite_casts"})