Skip to content

Commit cc8e078

Browse files
even more unstable
1 parent 5963368 commit cc8e078

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

Diff for: py-polars/polars/catalog.py

+21-3
Original file line numberDiff line numberDiff line change
@@ -492,7 +492,7 @@ class SchemaInfo:
492492
Information for a schema within a catalog.
493493
494494
Note: This does not refer to a table schema. It can instead be understood
495-
as a subdirectory underneath a catalog.
495+
as a subdirectory within a catalog.
496496
"""
497497

498498
name: str
@@ -523,7 +523,16 @@ class TableInfo:
523523
updated_by: str | None
524524

525525
def get_polars_schema(self) -> Schema | None:
526-
"""Get the native polars schema of this table."""
526+
"""
527+
Get the native polars schema of this table.
528+
529+
.. warning::
530+
This functionality is considered **unstable**. It may be changed
531+
at any point without it being considered a breaking change.
532+
"""
533+
issue_unstable_warning(
534+
"`get_polars_schema` functionality is considered unstable."
535+
)
527536
if self.columns is None:
528537
return None
529538

@@ -551,7 +560,16 @@ class ColumnInfo:
551560
partition_index: int | None
552561

553562
def get_polars_dtype(self) -> DataType:
554-
"""Get the native polars datatype of this column."""
563+
"""
564+
Get the native polars datatype of this column.
565+
566+
.. warning::
567+
This functionality is considered **unstable**. It may be changed
568+
at any point without it being considered a breaking change.
569+
"""
570+
issue_unstable_warning(
571+
"`get_polars_schema` functionality is considered unstable."
572+
)
555573
return PyCatalogClient.type_json_to_polars_type(self.type_json)
556574

557575

0 commit comments

Comments
 (0)