Edit on GitHub

sqlglot.generators.python

View Source

  1from __future__ import annotations
  2
  3import itertools
  4
  5from sqlglot import exp, generator
  6from sqlglot.dialects.dialect import inline_array_sql
  7from sqlglot.helper import subclasses
  8
  9
 10def _ordered_py(self, expression):
 11    this = self.sql(expression, "this")
 12    desc = "True" if expression.args.get("desc") else "False"
 13    nulls_first = "True" if expression.args.get("nulls_first") else "False"
 14    return f"ORDERED({this}, {desc}, {nulls_first})"
 15
 16
 17def _rename(self, e):
 18    try:
 19        values = list(e.args.values())
 20
 21        if len(values) == 1:
 22            values = values[0]
 23            if not isinstance(values, list):
 24                return self.func(e.key, values)
 25            return self.func(e.key, *values)
 26
 27        if isinstance(e, exp.Func) and e.is_var_len_args:
 28            args = itertools.chain.from_iterable(x if isinstance(x, list) else [x] for x in values)
 29            return self.func(e.key, *args)
 30
 31        return self.func(e.key, *values)
 32    except Exception as ex:
 33        raise Exception(f"Could not rename {repr(e)}") from ex
 34
 35
 36def _case_sql(self, expression):
 37    this = self.sql(expression, "this")
 38    chain = self.sql(expression, "default") or "None"
 39
 40    for e in reversed(expression.args["ifs"]):
 41        true = self.sql(e, "true")
 42        condition = self.sql(e, "this")
 43        condition = f"{this} = ({condition})" if this else condition
 44        chain = f"{true} if {condition} else ({chain})"
 45
 46    return chain
 47
 48
 49def _lambda_sql(self, e: exp.Lambda) -> str:
 50    names = {e.name.lower() for e in e.expressions}
 51
 52    e = e.transform(
 53        lambda n: (
 54            exp.var(n.name) if isinstance(n, exp.Identifier) and n.name.lower() in names else n
 55        )
 56    ).assert_is(exp.Lambda)
 57
 58    return f"lambda {self.expressions(e, flat=True)}: {self.sql(e, 'this')}"
 59
 60
 61def _div_sql(self: generator.Generator, e: exp.Div) -> str:
 62    denominator = self.sql(e, "expression")
 63
 64    if e.args.get("safe"):
 65        denominator += " or None"
 66
 67    sql = f"DIV({self.sql(e, 'this')}, {denominator})"
 68
 69    if e.args.get("typed"):
 70        sql = f"int({sql})"
 71
 72    return sql
 73
 74
 75class PythonGenerator(generator.Generator):
 76    TRANSFORMS = {
 77        **{klass: _rename for klass in subclasses(exp.__name__, exp.Binary)},
 78        **{klass: _rename for klass in exp.ALL_FUNCTIONS},
 79        exp.Case: _case_sql,
 80        exp.Alias: lambda self, e: self.sql(e.this),
 81        exp.Array: inline_array_sql,
 82        exp.And: lambda self, e: self.binary(e, "and"),
 83        exp.Between: _rename,
 84        exp.Boolean: lambda self, e: "True" if e.this else "False",
 85        exp.Cast: lambda self, e: f"CAST({self.sql(e.this)}, exp.DType.{e.args['to']})",
 86        exp.Column: lambda self, e: f"scope[{self.sql(e, 'table') or None}][{self.sql(e.this)}]",
 87        exp.Concat: lambda self, e: self.func(
 88            "SAFECONCAT" if e.args.get("safe") else "CONCAT", *e.expressions
 89        ),
 90        exp.Distinct: lambda self, e: f"set({self.sql(e, 'this')})",
 91        exp.Div: _div_sql,
 92        exp.Extract: lambda self, e: f"EXTRACT('{e.name.lower()}', {self.sql(e, 'expression')})",
 93        exp.In: lambda self, e: f"{self.sql(e, 'this')} in {{{self.expressions(e, flat=True)}}}",
 94        exp.Interval: lambda self, e: f"INTERVAL({self.sql(e.this)}, '{self.sql(e.unit)}')",
 95        exp.Is: lambda self, e: (
 96            self.binary(e, "==") if isinstance(e.this, exp.Literal) else self.binary(e, "is")
 97        ),
 98        exp.JSONExtract: lambda self, e: self.func(e.key, e.this, e.expression, *e.expressions),
 99        exp.JSONPath: lambda self, e: f"[{','.join(self.sql(p) for p in e.expressions[1:])}]",
100        exp.JSONPathKey: lambda self, e: f"'{self.sql(e.this)}'",
101        exp.JSONPathSubscript: lambda self, e: f"'{e.this}'",
102        exp.Lambda: _lambda_sql,
103        exp.Not: lambda self, e: f"not {self.sql(e.this)}",
104        exp.Null: lambda *_: "None",
105        exp.Or: lambda self, e: self.binary(e, "or"),
106        exp.Ordered: _ordered_py,
107        exp.Star: lambda *_: "1",
108    }

class PythonGenerator(sqlglot.generator.Generator): View Source

 76class PythonGenerator(generator.Generator):
 77    TRANSFORMS = {
 78        **{klass: _rename for klass in subclasses(exp.__name__, exp.Binary)},
 79        **{klass: _rename for klass in exp.ALL_FUNCTIONS},
 80        exp.Case: _case_sql,
 81        exp.Alias: lambda self, e: self.sql(e.this),
 82        exp.Array: inline_array_sql,
 83        exp.And: lambda self, e: self.binary(e, "and"),
 84        exp.Between: _rename,
 85        exp.Boolean: lambda self, e: "True" if e.this else "False",
 86        exp.Cast: lambda self, e: f"CAST({self.sql(e.this)}, exp.DType.{e.args['to']})",
 87        exp.Column: lambda self, e: f"scope[{self.sql(e, 'table') or None}][{self.sql(e.this)}]",
 88        exp.Concat: lambda self, e: self.func(
 89            "SAFECONCAT" if e.args.get("safe") else "CONCAT", *e.expressions
 90        ),
 91        exp.Distinct: lambda self, e: f"set({self.sql(e, 'this')})",
 92        exp.Div: _div_sql,
 93        exp.Extract: lambda self, e: f"EXTRACT('{e.name.lower()}', {self.sql(e, 'expression')})",
 94        exp.In: lambda self, e: f"{self.sql(e, 'this')} in {{{self.expressions(e, flat=True)}}}",
 95        exp.Interval: lambda self, e: f"INTERVAL({self.sql(e.this)}, '{self.sql(e.unit)}')",
 96        exp.Is: lambda self, e: (
 97            self.binary(e, "==") if isinstance(e.this, exp.Literal) else self.binary(e, "is")
 98        ),
 99        exp.JSONExtract: lambda self, e: self.func(e.key, e.this, e.expression, *e.expressions),
100        exp.JSONPath: lambda self, e: f"[{','.join(self.sql(p) for p in e.expressions[1:])}]",
101        exp.JSONPathKey: lambda self, e: f"'{self.sql(e.this)}'",
102        exp.JSONPathSubscript: lambda self, e: f"'{e.this}'",
103        exp.Lambda: _lambda_sql,
104        exp.Not: lambda self, e: f"not {self.sql(e.this)}",
105        exp.Null: lambda *_: "None",
106        exp.Or: lambda self, e: self.binary(e, "or"),
107        exp.Ordered: _ordered_py,
108        exp.Star: lambda *_: "1",
109    }

Generator converts a given syntax tree to the corresponding SQL string.

Arguments:

pretty: Whether to format the produced SQL string. Default: False.
identify: Determines when an identifier should be quoted. Possible values are: False (default): Never quote, except in cases where it's mandatory by the dialect. True: Always quote except for specials cases. 'safe': Only quote identifiers that are case insensitive.
normalize: Whether to normalize identifiers to lowercase. Default: False.
pad: The pad size in a formatted string. For example, this affects the indentation of a projection in a query, relative to its nesting level. Default: 2.
indent: The indentation size in a formatted string. For example, this affects the indentation of subqueries and filters under a WHERE clause. Default: 2.
normalize_functions: How to normalize function names. Possible values are: "upper" or True (default): Convert names to uppercase. "lower": Convert names to lowercase. False: Disables function name normalization.
unsupported_level: Determines the generator's behavior when it encounters unsupported expressions. Default ErrorLevel.WARN.
max_unsupported: Maximum number of unsupported messages to include in a raised UnsupportedError. This is only relevant if unsupported_level is ErrorLevel.RAISE. Default: 3
leading_comma: Whether the comma is leading or trailing in select expressions. This is only relevant when generating in pretty mode. Default: False
max_text_width: The max number of characters in a segment before creating new lines in pretty mode. The default is on the smaller end because the length only represents a segment and not the true line length. Default: 80
comments: Whether to preserve comments in the output SQL code. Default: True

Inherited Members

sqlglot.generator.Generator: Generator; NULL_ORDERING_SUPPORTED; WINDOW_FUNCS_WITH_NULL_ORDERING; IGNORE_NULLS_IN_FUNC; IGNORE_NULLS_BEFORE_ORDER; LOCKING_READS_SUPPORTED; EXCEPT_INTERSECT_SUPPORT_ALL_CLAUSE; WRAP_DERIVED_VALUES; CREATE_FUNCTION_RETURN_AS; MATCHED_BY_SOURCE; SUPPORTS_MERGE_WHERE; SINGLE_STRING_INTERVAL; INTERVAL_ALLOWS_PLURAL_FORM; LIMIT_FETCH; LIMIT_ONLY_LITERALS; RENAME_TABLE_WITH_DB; GROUPINGS_SEP; INDEX_ON; INOUT_SEPARATOR; JOIN_HINTS; DIRECTED_JOINS; TABLE_HINTS; QUERY_HINTS; QUERY_HINT_SEP; IS_BOOL_ALLOWED; DUPLICATE_KEY_UPDATE_WITH_SET; LIMIT_IS_TOP; RETURNING_END; EXTRACT_ALLOWS_QUOTES; TZ_TO_WITH_TIME_ZONE; NVL2_SUPPORTED; SELECT_KINDS; VALUES_AS_TABLE; ALTER_TABLE_INCLUDE_COLUMN_KEYWORD; UNNEST_WITH_ORDINALITY; AGGREGATE_FILTER_SUPPORTED; SEMI_ANTI_JOIN_WITH_SIDE; COMPUTED_COLUMN_WITH_TYPE; SUPPORTS_TABLE_COPY; TABLESAMPLE_REQUIRES_PARENS; TABLESAMPLE_SIZE_IS_ROWS; TABLESAMPLE_KEYWORDS; TABLESAMPLE_WITH_METHOD; TABLESAMPLE_SEED_KEYWORD; COLLATE_IS_FUNC; DATA_TYPE_SPECIFIERS_ALLOWED; ENSURE_BOOLS; CTE_RECURSIVE_KEYWORD_REQUIRED; SUPPORTS_SINGLE_ARG_CONCAT; LAST_DAY_SUPPORTS_DATE_PART; SUPPORTS_TABLE_ALIAS_COLUMNS; UNPIVOT_ALIASES_ARE_IDENTIFIERS; JSON_KEY_VALUE_PAIR_SEP; INSERT_OVERWRITE; SUPPORTS_SELECT_INTO; SUPPORTS_UNLOGGED_TABLES; SUPPORTS_CREATE_TABLE_LIKE; LIKE_PROPERTY_INSIDE_SCHEMA; MULTI_ARG_DISTINCT; JSON_TYPE_REQUIRED_FOR_EXTRACTION; JSON_PATH_BRACKETED_KEY_SUPPORTED; JSON_PATH_SINGLE_QUOTE_ESCAPE; SUPPORTED_JSON_PATH_PARTS; CAN_IMPLEMENT_ARRAY_ANY; SUPPORTS_TO_NUMBER; SUPPORTS_WINDOW_EXCLUDE; SET_OP_MODIFIERS; COPY_PARAMS_ARE_WRAPPED; COPY_PARAMS_EQ_REQUIRED; COPY_HAS_INTO_KEYWORD; TRY_SUPPORTED; SUPPORTS_UESCAPE; UNICODE_SUBSTITUTE; STAR_EXCEPT; HEX_FUNC; WITH_PROPERTIES_PREFIX; QUOTE_JSON_PATH; PAD_FILL_PATTERN_IS_REQUIRED; SUPPORTS_EXPLODING_PROJECTIONS; ARRAY_CONCAT_IS_VAR_LEN; SUPPORTS_CONVERT_TIMEZONE; SUPPORTS_MEDIAN; SUPPORTS_UNIX_SECONDS; ALTER_SET_WRAPPED; NORMALIZE_EXTRACT_DATE_PARTS; PARSE_JSON_NAME; ARRAY_SIZE_NAME; ALTER_SET_TYPE; ARRAY_SIZE_DIM_REQUIRED; SUPPORTS_DECODE_CASE; SUPPORTS_BETWEEN_FLAGS; SUPPORTS_LIKE_QUANTIFIERS; MATCH_AGAINST_TABLE_PREFIX; SET_ASSIGNMENT_REQUIRES_VARIABLE_KEYWORD; DECLARE_DEFAULT_ASSIGNMENT; UPDATE_STATEMENT_SUPPORTS_FROM; STAR_EXCLUDE_REQUIRES_DERIVED_TABLE; SUPPORTS_DROP_ALTER_ICEBERG_PROPERTY; TYPE_MAPPING; UNSUPPORTED_TYPES; TIME_PART_SINGULARS; AFTER_HAVING_MODIFIER_TRANSFORMS; TOKEN_MAPPING; STRUCT_DELIMITER; PARAMETER_TOKEN; NAMED_PLACEHOLDER_TOKEN; EXPRESSION_PRECEDES_PROPERTIES_CREATABLES; PROPERTIES_LOCATION; RESERVED_KEYWORDS; WITH_SEPARATED_COMMENTS; EXCLUDE_COMMENTS; UNWRAPPED_INTERVAL_VALUES; PARAMETERIZABLE_TEXT_TYPES; EXPRESSIONS_WITHOUT_NESTED_CTES; RESPECT_IGNORE_NULLS_UNSUPPORTED_EXPRESSIONS; SAFE_JSON_PATH_KEY_RE; SENTINEL_LINE_BREAK; pretty; identify; normalize; pad; unsupported_level; max_unsupported; leading_comma; max_text_width; comments; dialect; normalize_functions; unsupported_messages; generate; preprocess; unsupported; sep; seg; sanitize_comment; maybe_comment; wrap; no_identify; normalize_func; indent; sql; uncache_sql; cache_sql; characterset_sql; column_parts; column_sql; pseudocolumn_sql; columnposition_sql; columndef_sql; columnconstraint_sql; computedcolumnconstraint_sql; autoincrementcolumnconstraint_sql; compresscolumnconstraint_sql; generatedasidentitycolumnconstraint_sql; generatedasrowcolumnconstraint_sql; periodforsystemtimeconstraint_sql; notnullcolumnconstraint_sql; primarykeycolumnconstraint_sql; uniquecolumnconstraint_sql; inoutcolumnconstraint_sql; createable_sql; create_sql; sequenceproperties_sql; triggerproperties_sql; triggerreferencing_sql; triggerevent_sql; clone_sql; describe_sql; heredoc_sql; prepend_ctes; with_sql; cte_sql; tablealias_sql; bitstring_sql; hexstring_sql; bytestring_sql; unicodestring_sql; rawstring_sql; datatypeparam_sql; datatype_sql; directory_sql; delete_sql; drop_sql; set_operation; set_operations; fetch_sql; limitoptions_sql; filter_sql; hint_sql; indexparameters_sql; index_sql; identifier_sql; hex_sql; lowerhex_sql; inputoutputformat_sql; national_sql; partition_sql; properties_sql; root_properties; properties; with_properties; locate_properties; property_name; property_sql; uuidproperty_sql; likeproperty_sql; fallbackproperty_sql; journalproperty_sql; freespaceproperty_sql; checksumproperty_sql; mergeblockratioproperty_sql; moduleproperty_sql; datablocksizeproperty_sql; blockcompressionproperty_sql; isolatedloadingproperty_sql; partitionboundspec_sql; partitionedofproperty_sql; lockingproperty_sql; withdataproperty_sql; withsystemversioningproperty_sql; insert_sql; introducer_sql; kill_sql; pseudotype_sql; objectidentifier_sql; onconflict_sql; returning_sql; rowformatdelimitedproperty_sql; withtablehint_sql; indextablehint_sql; historicaldata_sql; table_parts; table_sql; tablefromrows_sql; tablesample_sql; pivot_sql; version_sql; tuple_sql; update_sql; values_sql; var_sql; into_sql; from_sql; groupingsets_sql; rollup_sql; rollupindex_sql; rollupproperty_sql; cube_sql; group_sql; having_sql; connect_sql; prior_sql; join_sql; lambda_sql; lateral_op; lateral_sql; limit_sql; offset_sql; setitem_sql; set_sql; queryband_sql; pragma_sql; lock_sql; literal_sql; escape_str; loaddata_sql; null_sql; boolean_sql; booland_sql; boolor_sql; order_sql; withfill_sql; cluster_sql; distribute_sql; sort_sql; ordered_sql; matchrecognizemeasure_sql; matchrecognize_sql; query_modifiers; options_modifier; for_modifiers; queryoption_sql; offset_limit_modifiers; after_limit_modifiers; select_sql; schema_sql; schema_columns_sql; star_sql; parameter_sql; sessionparameter_sql; placeholder_sql; subquery_sql; qualify_sql; unnest_sql; prewhere_sql; where_sql; window_sql; partition_by_sql; windowspec_sql; withingroup_sql; between_sql; bracket_offset_expressions; bracket_sql; all_sql; any_sql; exists_sql; case_sql; constraint_sql; nextvaluefor_sql; extract_sql; trim_sql; convert_concat_args; concat_sql; concatws_sql; check_sql; foreignkey_sql; primarykey_sql; if_sql; matchagainst_sql; jsonkeyvalue_sql; jsonpath_sql; json_path_part; formatjson_sql; formatphrase_sql; jsonarray_sql; jsonarrayagg_sql; jsoncolumndef_sql; jsonschema_sql; jsontable_sql; openjsoncolumndef_sql; openjson_sql; in_sql; in_unnest_op; interval_sql; return_sql; reference_sql; anonymous_sql; paren_sql; neg_sql; not_sql; alias_sql; pivotalias_sql; aliases_sql; atindex_sql; attimezone_sql; fromtimezone_sql; add_sql; and_sql; or_sql; xor_sql; connector_sql; bitwiseand_sql; bitwiseleftshift_sql; bitwisenot_sql; bitwiseor_sql; bitwiserightshift_sql; bitwisexor_sql; cast_sql; strtotime_sql; currentdate_sql; collate_sql; command_sql; comment_sql; mergetreettlaction_sql; mergetreettl_sql; transaction_sql; commit_sql; rollback_sql; altercolumn_sql; alterindex_sql; alterdiststyle_sql; altersortkey_sql; alterrename_sql; renamecolumn_sql; alterset_sql; alter_sql; altersession_sql; add_column_sql; droppartition_sql; addconstraint_sql; addpartition_sql; distinct_sql; ignorenulls_sql; respectnulls_sql; havingmax_sql; intdiv_sql; dpipe_sql; div_sql; safedivide_sql; overlaps_sql; distance_sql; dot_sql; eq_sql; propertyeq_sql; escape_sql; glob_sql; gt_sql; gte_sql; is_sql; like_sql; ilike_sql; match_sql; similarto_sql; lt_sql; lte_sql; mod_sql; mul_sql; neq_sql; nullsafeeq_sql; nullsafeneq_sql; sub_sql; trycast_sql; jsoncast_sql; try_sql; log_sql; use_sql; binary; ceil_floor; function_fallback_sql; func; format_args; too_wide; format_time; expressions; op_expressions; naked_property; tag_sql; token_sql; userdefinedfunction_sql; joinhint_sql; kwarg_sql; when_sql; whens_sql; merge_sql; tochar_sql; tonumber_sql; dictproperty_sql; dictrange_sql; dictsubproperty_sql; duplicatekeyproperty_sql; uniquekeyproperty_sql; distributedbyproperty_sql; oncluster_sql; clusteredbyproperty_sql; anyvalue_sql; querytransform_sql; indexconstraintoption_sql; checkcolumnconstraint_sql; indexcolumnconstraint_sql; nvl2_sql; comprehension_sql; columnprefix_sql; opclass_sql; predict_sql; generateembedding_sql; generatetext_sql; generatetable_sql; generatebool_sql; generateint_sql; generatedouble_sql; mltranslate_sql; mlforecast_sql; aiforecast_sql; featuresattime_sql; vectorsearch_sql; forin_sql; refresh_sql; toarray_sql; tsordstotime_sql; tsordstotimestamp_sql; tsordstodatetime_sql; tsordstodate_sql; unixdate_sql; lastday_sql; dateadd_sql; arrayany_sql; struct_sql; partitionrange_sql; truncatetable_sql; convert_sql; copyparameter_sql; credentials_sql; copy_sql; semicolon_sql; datadeletionproperty_sql; maskingpolicycolumnconstraint_sql; gapfill_sql; scope_resolution; scoperesolution_sql; parsejson_sql; rand_sql; changes_sql; pad_sql; summarize_sql; explodinggenerateseries_sql; converttimezone_sql; json_sql; jsonvalue_sql; skipjsoncolumn_sql; conditionalinsert_sql; multitableinserts_sql; oncondition_sql; jsonextractquote_sql; jsonexists_sql; arrayagg_sql; slice_sql; apply_sql; grant_sql; revoke_sql; grantprivilege_sql; grantprincipal_sql; columns_sql; overlay_sql; todouble_sql; string_sql; median_sql; overflowtruncatebehavior_sql; unixseconds_sql; arraysize_sql; attach_sql; detach_sql; attachoption_sql; watermarkcolumnconstraint_sql; encodeproperty_sql; includeproperty_sql; xmlelement_sql; xmlkeyvalueoption_sql; partitionbyrangeproperty_sql; partitionbyrangepropertydynamic_sql; unpivotcolumns_sql; analyzesample_sql; analyzestatistics_sql; analyzehistogram_sql; analyzedelete_sql; analyzelistchainedrows_sql; analyzevalidate_sql; analyze_sql; xmltable_sql; xmlnamespace_sql; export_sql; declare_sql; declareitem_sql; recursivewithsearch_sql; parameterizedagg_sql; anonymousaggfunc_sql; combinedaggfunc_sql; combinedparameterizedagg_sql; show_sql; install_sql; get_put_sql; translatecharacters_sql; decodecase_sql; semanticview_sql; getextract_sql; datefromunixdate_sql; space_sql; buildproperty_sql; refreshtriggerproperty_sql; modelattribute_sql; directorystage_sql; uuid_sql; initcap_sql; localtime_sql; localtimestamp_sql; weekstart_sql; chr_sql; block_sql; storedprocedure_sql; ifblock_sql; whileblock_sql; execute_sql; executesql_sql; altermodifysqlsecurity_sql; usingproperty_sql; renameindex_sql