Repository navigation
Expand file tree
/
Copy path__init__.py
More file actions
153 lines (130 loc) · 3.72 KB
/
Copy path__init__.py
File metadata and controls
153 lines (130 loc) · 3.72 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
"""DataFusion python package.
This is a Python library that binds to Apache Arrow in-memory query engine DataFusion.
See https://datafusion.apache.org/python for more information.
"""
from __future__ import annotations
from typing import Any
try:
import importlib.metadata as importlib_metadata
except ImportError:
import importlib_metadata
from . import functions, object_store, substrait, unparser
# The following imports are okay to remain as opaque to the user.
from ._internal import Config
from .catalog import Catalog, Database, Table
from .col import col, column
from .common import (
DFSchema,
)
from .context import (
RuntimeEnvBuilder,
SessionConfig,
SessionContext,
SQLOptions,
)
from .dataframe import DataFrame, ParquetColumnOptions, ParquetWriterOptions
from .dataframe_formatter import configure_formatter
from .expr import (
Expr,
WindowFrame,
)
from .io import read_avro, read_csv, read_json, read_parquet
from .plan import ExecutionPlan, LogicalPlan
from .record_batch import RecordBatch, RecordBatchStream
from .user_defined import (
Accumulator,
AggregateUDF,
ScalarUDF,
TableFunction,
WindowUDF,
udaf,
udf,
udtf,
udwf,
)
__version__ = importlib_metadata.version(__name__)
__all__ = [
"Accumulator",
"AggregateUDF",
"Catalog",
"Config",
"DFSchema",
"DataFrame",
"Database",
"ExecutionPlan",
"Expr",
"LogicalPlan",
"ParquetColumnOptions",
"ParquetWriterOptions",
"RecordBatch",
"RecordBatchStream",
"RuntimeEnvBuilder",
"SQLOptions",
"ScalarUDF",
"SessionConfig",
"SessionContext",
"Table",
"TableFunction",
"WindowFrame",
"WindowUDF",
"catalog",
"col",
"column",
"common",
"configure_formatter",
"expr",
"functions",
"lit",
"literal",
"object_store",
"read_avro",
"read_csv",
"read_json",
"read_parquet",
"substrait",
"udaf",
"udf",
"udtf",
"udwf",
"unparser",
]
def literal(value) -> Expr:
"""Create a literal expression."""
return Expr.literal(value)
def string_literal(value):
"""Create a UTF8 literal expression.
It differs from `literal` which creates a UTF8view literal.
"""
return Expr.string_literal(value)
def str_lit(value):
"""Alias for `string_literal`."""
return string_literal(value)
def lit(value) -> Expr:
"""Create a literal expression."""
return Expr.literal(value)
def literal_with_metadata(value: Any, metadata: dict[str, str]) -> Expr:
"""Creates a new expression representing a scalar value with metadata.
Args:
value: A valid PyArrow scalar value or easily castable to one.
metadata: Metadata to attach to the expression.
"""
return Expr.literal_with_metadata(value, metadata)
def lit_with_metadata(value: Any, metadata: dict[str, str]) -> Expr:
"""Alias for literal_with_metadata."""
return literal_with_metadata(value, metadata)