Add warning for experimental functionality #12432
Labels
accepted
Ready for implementation
enhancement
New feature or an improvement of an existing feature
python
Related to Python Polars
Milestone
With 1.0.0 around the corner, we want to more officially indicate experimental functionality. Right now, it's just a comment in the docstring. This is not sufficient.
Definition
If functionality is considered experimental, this means:
Examples
Decimal
data type works in some parts of our API, but it is largely unimplemented (e.g. arithmetic). It may be fine to use in specific contexts, but is not yet as reliable as other numeric types.LazyFrame.collect(streaming=True)
works and will produce correct results, but it may not fully operate in streaming fashion and consume more memory than expected.The extent to which functionality is experimental will differ. We can elaborate in the docstring when warranted.
Proposal
PolarsExperimentalWarning
when using experimental functionality.Config.set_experimental_warning(False)
.Implementation
Comments welcome - especially looking for better names for the Warning / Config setting.
The text was updated successfully, but these errors were encountered: