duckdb 1.5.0.dev37__cp312-cp312-win_amd64.whl → 1.5.0.dev94__cp312-cp312-win_amd64.whl

duckdb/__init__.py

@@ -1,475 +1,381 @@
-# Modules
-import duckdb.functional as functional
-import duckdb.typing as typing
-from _duckdb import __version__ as duckdb_version
-from importlib.metadata import version
+# ruff: noqa: F401
+"""The DuckDB Python Package.
 
-# duckdb.__version__ returns the version of the distribution package, i.e. the pypi version
-__version__ = version("duckdb")
+This module re-exports the DuckDB C++ extension (`_duckdb`) and provides DuckDB's public API.
 
-# version() is a more human friendly formatted version string of both the distribution package and the bundled duckdb
-def version():
-    return f"{__version__} (with duckdb {duckdb_version})"
+Note:
+- Some symbols exposed here are implementation details of DuckDB's C++ engine.
+- They are kept for backwards compatibility but are not considered stable API.
+- Future versions may move them into submodules with deprecation warnings.
+"""
 
-_exported_symbols = ['__version__', 'version']
-
-_exported_symbols.extend([
-    "typing",
-    "functional"
-])
-
-class DBAPITypeObject:
-    def __init__(self, types: list[typing.DuckDBPyType]) -> None:
-        self.types = types
-
-    def __eq__(self, other):
-        if isinstance(other, typing.DuckDBPyType):
-            return other in self.types
-        return False
-
-    def __repr__(self):
-        return f"<DBAPITypeObject [{','.join(str(x) for x in self.types)}]>"
-
-# Define the standard DBAPI sentinels
-STRING   = DBAPITypeObject([typing.VARCHAR])
-NUMBER   = DBAPITypeObject([
-    typing.TINYINT,
-    typing.UTINYINT,
-    typing.SMALLINT,
-    typing.USMALLINT,
-    typing.INTEGER,
-    typing.UINTEGER,
-    typing.BIGINT,
-    typing.UBIGINT,
-    typing.HUGEINT,
-    typing.UHUGEINT,
-    typing.DuckDBPyType("BIGNUM"),
-    typing.DuckDBPyType("DECIMAL"),
-    typing.FLOAT,
-    typing.DOUBLE
-])
-DATETIME = DBAPITypeObject([
-    typing.DATE,
-    typing.TIME,
-    typing.TIME_TZ,
-    typing.TIMESTAMP,
-    typing.TIMESTAMP_TZ,
-    typing.TIMESTAMP_NS,
-    typing.TIMESTAMP_MS,
-    typing.TIMESTAMP_S
-])
-BINARY   = DBAPITypeObject([typing.BLOB])
-ROWID    = None
-
-# Classes
 from _duckdb import (
-    DuckDBPyRelation,
-    DuckDBPyConnection,
-    Statement,
-    ExplainType,
-    StatementType,
-    ExpectedResultType,
-	CSVLineTerminator,
-    PythonExceptionHandling,
-    RenderMode,
-    Expression,
-    ConstantExpression,
+    BinderException,
+    CaseExpression,
+    CatalogException,
+    CoalesceOperator,
     ColumnExpression,
+    ConnectionException,
+    ConstantExpression,
+    ConstraintException,
+    ConversionException,
+    CSVLineTerminator,
+    DatabaseError,
+    DataError,
     DefaultExpression,
-    CoalesceOperator,
-    LambdaExpression,
-    StarExpression,
-    FunctionExpression,
-    CaseExpression,
-    SQLExpression
-)
-_exported_symbols.extend([
-    "DuckDBPyRelation",
-    "DuckDBPyConnection",
-    "ExplainType",
-    "PythonExceptionHandling",
-    "Expression",
-    "ConstantExpression",
-    "ColumnExpression",
-    "DefaultExpression",
-    "CoalesceOperator",
-    "LambdaExpression",
-    "StarExpression",
-    "FunctionExpression",
-    "CaseExpression",
-    "SQLExpression"
-])
-
-# These are overloaded twice, we define them inside of C++ so pybind can deal with it
-_exported_symbols.extend([
-    'df',
-    'arrow'
-])
-from _duckdb import (
-    df,
-    arrow
-)
-
-# NOTE: this section is generated by tools/pythonpkg/scripts/generate_connection_wrapper_methods.py.
-# Do not edit this section manually, your changes will be overwritten!
-
-# START OF CONNECTION WRAPPER
-
-from _duckdb import (
-	cursor,
-	register_filesystem,
-	unregister_filesystem,
-	list_filesystems,
-	filesystem_is_registered,
-	create_function,
-	remove_function,
-	sqltype,
-	dtype,
-	type,
-	array_type,
-	list_type,
-	union_type,
-	string_type,
-	enum_type,
-	decimal_type,
-	struct_type,
-	row_type,
-	map_type,
-	duplicate,
-	execute,
-	executemany,
-	close,
-	interrupt,
-	query_progress,
-	fetchone,
-	fetchmany,
-	fetchall,
-	fetchnumpy,
-	fetchdf,
-	fetch_df,
-	df,
-	fetch_df_chunk,
-	pl,
-	fetch_arrow_table,
-	arrow,
-	fetch_record_batch,
-	torch,
-	tf,
-	begin,
-	commit,
-	rollback,
-	checkpoint,
-	append,
-	register,
-	unregister,
-	table,
-	view,
-	values,
-	table_function,
-	read_json,
-	extract_statements,
-	sql,
-	query,
-	from_query,
-	read_csv,
-	from_csv_auto,
-	from_df,
-	from_arrow,
-	from_parquet,
-	read_parquet,
-	from_parquet,
-	read_parquet,
-	get_table_names,
-	install_extension,
-	load_extension,
-	project,
-	distinct,
-	write_csv,
-	aggregate,
-	alias,
-	filter,
-	limit,
-	order,
-	query_df,
-	description,
-	rowcount,
-)
-
-_exported_symbols.extend([
-	'cursor',
-	'register_filesystem',
-	'unregister_filesystem',
-	'list_filesystems',
-	'filesystem_is_registered',
-	'create_function',
-	'remove_function',
-	'sqltype',
-	'dtype',
-	'type',
-	'array_type',
-	'list_type',
-	'union_type',
-	'string_type',
-	'enum_type',
-	'decimal_type',
-	'struct_type',
-	'row_type',
-	'map_type',
-	'duplicate',
-	'execute',
-	'executemany',
-	'close',
-	'interrupt',
-	'query_progress',
-	'fetchone',
-	'fetchmany',
-	'fetchall',
-	'fetchnumpy',
-	'fetchdf',
-	'fetch_df',
-	'df',
-	'fetch_df_chunk',
-	'pl',
-	'fetch_arrow_table',
-	'arrow',
-	'fetch_record_batch',
-	'torch',
-	'tf',
-	'begin',
-	'commit',
-	'rollback',
-	'checkpoint',
-	'append',
-	'register',
-	'unregister',
-	'table',
-	'view',
-	'values',
-	'table_function',
-	'read_json',
-	'extract_statements',
-	'sql',
-	'query',
-	'from_query',
-	'read_csv',
-	'from_csv_auto',
-	'from_df',
-	'from_arrow',
-	'from_parquet',
-	'read_parquet',
-	'from_parquet',
-	'read_parquet',
-	'get_table_names',
-	'install_extension',
-	'load_extension',
-	'project',
-	'distinct',
-	'write_csv',
-	'aggregate',
-	'alias',
-	'filter',
-	'limit',
-	'order',
-	'query_df',
-	'description',
-	'rowcount',
-])
-
-# END OF CONNECTION WRAPPER
-
-# Enums
-from _duckdb import (
-    ANALYZE,
-    DEFAULT,
-    RETURN_NULL,
-    STANDARD,
-    COLUMNS,
-    ROWS
-)
-_exported_symbols.extend([
-    "ANALYZE",
-    "DEFAULT",
-    "RETURN_NULL",
-    "STANDARD"
-])
-
-
-# read-only properties
-from _duckdb import (
-    __standard_vector_size__,
-    __interactive__,
-    __jupyter__,
-    __formatted_python_version__,
-    apilevel,
-    comment,
-    identifier,
-    keyword,
-    numeric_const,
-    operator,
-    paramstyle,
-    string_const,
-    threadsafety,
-    token_type,
-    tokenize
-)
-_exported_symbols.extend([
-    "__standard_vector_size__",
-    "__interactive__",
-    "__jupyter__",
-    "__formatted_python_version__",
-    "apilevel",
-    "comment",
-    "identifier",
-    "keyword",
-    "numeric_const",
-    "operator",
-    "paramstyle",
-    "string_const",
-    "threadsafety",
-    "token_type",
-    "tokenize"
-])
-
-
-from _duckdb import (
-    connect,
-    default_connection,
-    set_default_connection,
-)
-
-_exported_symbols.extend([
-    "connect",
-    "default_connection",
-    "set_default_connection",
-])
-
-# Exceptions
-from _duckdb import (
+    DependencyException,
+    DuckDBPyConnection,
+    DuckDBPyRelation,
     Error,
-    DataError,
-    ConversionException,
-    OutOfRangeException,
-    TypeMismatchException,
+    ExpectedResultType,
+    ExplainType,
+    Expression,
     FatalException,
+    FunctionExpression,
+    HTTPException,
     IntegrityError,
-    ConstraintException,
     InternalError,
     InternalException,
     InterruptException,
-    NotSupportedError,
+    InvalidInputException,
+    InvalidTypeException,
+    IOException,
+    LambdaExpression,
     NotImplementedException,
+    NotSupportedError,
     OperationalError,
-    ConnectionException,
-    IOException,
-    HTTPException,
     OutOfMemoryException,
-    SerializationException,
-    TransactionException,
+    OutOfRangeException,
+    ParserException,
     PermissionException,
     ProgrammingError,
-    BinderException,
-    CatalogException,
-    InvalidInputException,
-    InvalidTypeException,
-    ParserException,
-    SyntaxException,
+    PythonExceptionHandling,
+    RenderMode,
     SequenceException,
-    Warning
+    SerializationException,
+    SQLExpression,
+    StarExpression,
+    Statement,
+    StatementType,
+    SyntaxException,
+    TransactionException,
+    TypeMismatchException,
+    Warning,
+    __formatted_python_version__,
+    __git_revision__,
+    __interactive__,
+    __jupyter__,
+    __standard_vector_size__,
+    _clean_default_connection,
+    aggregate,
+    alias,
+    apilevel,
+    append,
+    array_type,
+    arrow,
+    begin,
+    checkpoint,
+    close,
+    commit,
+    connect,
+    create_function,
+    cursor,
+    decimal_type,
+    default_connection,
+    description,
+    df,
+    distinct,
+    dtype,
+    duplicate,
+    enum_type,
+    execute,
+    executemany,
+    extract_statements,
+    fetch_arrow_table,
+    fetch_df,
+    fetch_df_chunk,
+    fetch_record_batch,
+    fetchall,
+    fetchdf,
+    fetchmany,
+    fetchnumpy,
+    fetchone,
+    filesystem_is_registered,
+    filter,
+    from_arrow,
+    from_csv_auto,
+    from_df,
+    from_parquet,
+    from_query,
+    get_table_names,
+    install_extension,
+    interrupt,
+    limit,
+    list_filesystems,
+    list_type,
+    load_extension,
+    map_type,
+    order,
+    paramstyle,
+    pl,
+    project,
+    query,
+    query_df,
+    query_progress,
+    read_csv,
+    read_json,
+    read_parquet,
+    register,
+    register_filesystem,
+    remove_function,
+    rollback,
+    row_type,
+    rowcount,
+    set_default_connection,
+    sql,
+    sqltype,
+    string_type,
+    struct_type,
+    table,
+    table_function,
+    tf,
+    threadsafety,
+    token_type,
+    tokenize,
+    torch,
+    type,
+    union_type,
+    unregister,
+    unregister_filesystem,
+    values,
+    view,
+    write_csv,
 )
-_exported_symbols.extend([
-    "Error",
-    "DataError",
-    "ConversionException",
-    "OutOfRangeException",
-    "TypeMismatchException",
-    "FatalException",
-    "IntegrityError",
-    "ConstraintException",
-    "InternalError",
-    "InternalException",
-    "InterruptException",
-    "NotSupportedError",
-    "NotImplementedException",
-    "OperationalError",
-    "ConnectionException",
-    "IOException",
-    "HTTPException",
-    "OutOfMemoryException",
-    "SerializationException",
-    "TransactionException",
-    "PermissionException",
-    "ProgrammingError",
-    "BinderException",
-    "CatalogException",
-    "InvalidInputException",
-    "InvalidTypeException",
-    "ParserException",
-    "SyntaxException",
-    "SequenceException",
-    "Warning"
-])
 
-# Value
+from duckdb._dbapi_type_object import (
+    BINARY,
+    DATETIME,
+    NUMBER,
+    ROWID,
+    STRING,
+    DBAPITypeObject,
+)
+from duckdb._version import (
+    __duckdb_version__,
+    __version__,
+    version,
+)
 from duckdb.value.constant import (
-    Value,
-    NullValue,
-    BooleanValue,
-    UnsignedBinaryValue,
-    UnsignedShortValue,
-    UnsignedIntegerValue,
-    UnsignedLongValue,
     BinaryValue,
-    ShortValue,
-    IntegerValue,
-    LongValue,
-    HugeIntegerValue,
-    FloatValue,
-    DoubleValue,
-    DecimalValue,
-    StringValue,
-    UUIDValue,
     BitValue,
     BlobValue,
+    BooleanValue,
     DateValue,
+    DecimalValue,
+    DoubleValue,
+    FloatValue,
+    HugeIntegerValue,
+    IntegerValue,
     IntervalValue,
-    TimestampValue,
-    TimestampSecondValue,
+    ListValue,
+    LongValue,
+    MapValue,
+    NullValue,
+    ShortValue,
+    StringValue,
+    StructValue,
     TimestampMilisecondValue,
     TimestampNanosecondValue,
+    TimestampSecondValue,
     TimestampTimeZoneValue,
-    TimeValue,
+    TimestampValue,
     TimeTimeZoneValue,
+    TimeValue,
+    UnionType,
+    UnsignedBinaryValue,
+    UnsignedHugeIntegerValue,
+    UnsignedIntegerValue,
+    UnsignedLongValue,
+    UnsignedShortValue,
+    UUIDValue,
+    Value,
 )
 
-_exported_symbols.extend([
-    "Value",
-    "NullValue",
-    "BooleanValue",
-    "UnsignedBinaryValue",
-    "UnsignedShortValue",
-    "UnsignedIntegerValue",
-    "UnsignedLongValue",
+__all__: list[str] = [
     "BinaryValue",
-    "ShortValue",
-    "IntegerValue",
-    "LongValue",
-    "HugeIntegerValue",
-    "FloatValue",
-    "DoubleValue",
-    "DecimalValue",
-    "StringValue",
-    "UUIDValue",
+    "BinderException",
     "BitValue",
     "BlobValue",
+    "BooleanValue",
+    "CSVLineTerminator",
+    "CaseExpression",
+    "CatalogException",
+    "CoalesceOperator",
+    "ColumnExpression",
+    "ConnectionException",
+    "ConstantExpression",
+    "ConstraintException",
+    "ConversionException",
+    "DataError",
+    "DatabaseError",
     "DateValue",
+    "DecimalValue",
+    "DefaultExpression",
+    "DependencyException",
+    "DoubleValue",
+    "DuckDBPyConnection",
+    "DuckDBPyRelation",
+    "Error",
+    "ExpectedResultType",
+    "ExplainType",
+    "Expression",
+    "FatalException",
+    "FloatValue",
+    "FunctionExpression",
+    "HTTPException",
+    "HugeIntegerValue",
+    "IOException",
+    "IntegerValue",
+    "IntegrityError",
+    "InternalError",
+    "InternalException",
+    "InterruptException",
     "IntervalValue",
-    "TimestampValue",
-    "TimestampSecondValue",
+    "InvalidInputException",
+    "InvalidTypeException",
+    "LambdaExpression",
+    "ListValue",
+    "LongValue",
+    "MapValue",
+    "NotImplementedException",
+    "NotSupportedError",
+    "NullValue",
+    "OperationalError",
+    "OutOfMemoryException",
+    "OutOfRangeException",
+    "ParserException",
+    "PermissionException",
+    "ProgrammingError",
+    "PythonExceptionHandling",
+    "RenderMode",
+    "SQLExpression",
+    "SequenceException",
+    "SerializationException",
+    "ShortValue",
+    "StarExpression",
+    "Statement",
+    "StatementType",
+    "StringValue",
+    "StructValue",
+    "SyntaxException",
+    "TimeTimeZoneValue",
+    "TimeValue",
     "TimestampMilisecondValue",
     "TimestampNanosecondValue",
+    "TimestampSecondValue",
     "TimestampTimeZoneValue",
-    "TimeValue",
-    "TimeTimeZoneValue",
-])
-
-__all__ = _exported_symbols
+    "TimestampValue",
+    "TransactionException",
+    "TypeMismatchException",
+    "UUIDValue",
+    "UnionType",
+    "UnsignedBinaryValue",
+    "UnsignedHugeIntegerValue",
+    "UnsignedIntegerValue",
+    "UnsignedLongValue",
+    "UnsignedShortValue",
+    "Value",
+    "Warning",
+    "__formatted_python_version__",
+    "__git_revision__",
+    "__interactive__",
+    "__jupyter__",
+    "__standard_vector_size__",
+    "__version__",
+    "_clean_default_connection",
+    "aggregate",
+    "alias",
+    "apilevel",
+    "append",
+    "array_type",
+    "arrow",
+    "begin",
+    "checkpoint",
+    "close",
+    "commit",
+    "connect",
+    "create_function",
+    "cursor",
+    "decimal_type",
+    "default_connection",
+    "description",
+    "df",
+    "distinct",
+    "dtype",
+    "duplicate",
+    "enum_type",
+    "execute",
+    "executemany",
+    "extract_statements",
+    "fetch_arrow_table",
+    "fetch_df",
+    "fetch_df_chunk",
+    "fetch_record_batch",
+    "fetchall",
+    "fetchdf",
+    "fetchmany",
+    "fetchnumpy",
+    "fetchone",
+    "filesystem_is_registered",
+    "filter",
+    "from_arrow",
+    "from_csv_auto",
+    "from_df",
+    "from_parquet",
+    "from_query",
+    "get_table_names",
+    "install_extension",
+    "interrupt",
+    "limit",
+    "list_filesystems",
+    "list_type",
+    "load_extension",
+    "map_type",
+    "order",
+    "paramstyle",
+    "paramstyle",
+    "pl",
+    "project",
+    "query",
+    "query_df",
+    "query_progress",
+    "read_csv",
+    "read_json",
+    "read_parquet",
+    "register",
+    "register_filesystem",
+    "remove_function",
+    "rollback",
+    "row_type",
+    "rowcount",
+    "set_default_connection",
+    "sql",
+    "sqltype",
+    "string_type",
+    "struct_type",
+    "table",
+    "table_function",
+    "tf",
+    "threadsafety",
+    "threadsafety",
+    "token_type",
+    "tokenize",
+    "torch",
+    "type",
+    "union_type",
+    "unregister",
+    "unregister_filesystem",
+    "values",
+    "view",
+    "write_csv",
+]