python docs, do not compile

.github/workflows/docs.yaml

@@ -25,7 +25,6 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -r py-polars/build.requirements.txt
-          cd py-polars && ./tasks.sh test-install
       - name: Build python reference
         run: |
           cd py-polars/docs

py-polars/docs/source/conf.py

@@ -10,10 +10,11 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
 
+# add polars directory
+sys.path.insert(0, os.path.abspath("../.."))
 
 # -- Project information -----------------------------------------------------
 

py-polars/polars/__init__.py

@@ -1,8 +1,12 @@
 # flake8: noqa
+import warnings
+
 try:
     from polars.polars import version
 except ImportError as e:
-    raise ImportError("Polars binary files missing!") from e
+    version = lambda: ""
+    # this is only useful for documentation
+    warnings.warn("polars binary missing!")
 
 # mypy needs these imported explicitly
 from polars.eager.frame import DataFrame, wrap_df

py-polars/polars/datatypes.py

@@ -6,7 +6,12 @@
 import pyarrow as pa
 from _ctypes import _SimpleCData
 
-from polars.polars import PySeries
+try:
+    from polars.polars import PySeries
+
+    _DOCUMENTING = False
+except ImportError:
+    _DOCUMENTING = True
 
 __all__ = [
     "DataType",
@@ -258,23 +263,24 @@ def pytype_to_polars_type(data_type: Type[Any]) -> Type[DataType]:
     return polars_type
 
 
-_POLARS_TYPE_TO_CONSTRUCTOR = {
-    Float32: PySeries.new_opt_f32,
-    Float64: PySeries.new_opt_f64,
-    Int8: PySeries.new_opt_i8,
-    Int16: PySeries.new_opt_i16,
-    Int32: PySeries.new_opt_i32,
-    Int64: PySeries.new_opt_i64,
-    UInt8: PySeries.new_opt_u8,
-    UInt16: PySeries.new_opt_u16,
-    UInt32: PySeries.new_opt_u32,
-    UInt64: PySeries.new_opt_u64,
-    Date32: PySeries.new_opt_i32,
-    Date64: PySeries.new_opt_i32,
-    Boolean: PySeries.new_opt_bool,
-    Utf8: PySeries.new_str,
-    Object: PySeries.new_object,
-}
+if not _DOCUMENTING:
+    _POLARS_TYPE_TO_CONSTRUCTOR = {
+        Float32: PySeries.new_opt_f32,
+        Float64: PySeries.new_opt_f64,
+        Int8: PySeries.new_opt_i8,
+        Int16: PySeries.new_opt_i16,
+        Int32: PySeries.new_opt_i32,
+        Int64: PySeries.new_opt_i64,
+        UInt8: PySeries.new_opt_u8,
+        UInt16: PySeries.new_opt_u16,
+        UInt32: PySeries.new_opt_u32,
+        UInt64: PySeries.new_opt_u64,
+        Date32: PySeries.new_opt_i32,
+        Date64: PySeries.new_opt_i32,
+        Boolean: PySeries.new_opt_bool,
+        Utf8: PySeries.new_str,
+        Object: PySeries.new_object,
+    }
 
 
 def polars_type_to_constructor(
@@ -289,20 +295,21 @@ def polars_type_to_constructor(
         raise ValueError(f"Cannot construct PySeries for type {dtype}.")
 
 
-_NUMPY_TYPE_TO_CONSTRUCTOR = {
-    np.float32: PySeries.new_f32,
-    np.float64: PySeries.new_f64,
-    np.int8: PySeries.new_i8,
-    np.int16: PySeries.new_i16,
-    np.int32: PySeries.new_i32,
-    np.int64: PySeries.new_i64,
-    np.uint8: PySeries.new_u8,
-    np.uint16: PySeries.new_u16,
-    np.uint32: PySeries.new_u32,
-    np.uint64: PySeries.new_u64,
-    np.str_: PySeries.new_str,
-    bool: PySeries.new_bool,
-}
+if not _DOCUMENTING:
+    _NUMPY_TYPE_TO_CONSTRUCTOR = {
+        np.float32: PySeries.new_f32,
+        np.float64: PySeries.new_f64,
+        np.int8: PySeries.new_i8,
+        np.int16: PySeries.new_i16,
+        np.int32: PySeries.new_i32,
+        np.int64: PySeries.new_i64,
+        np.uint8: PySeries.new_u8,
+        np.uint16: PySeries.new_u16,
+        np.uint32: PySeries.new_u32,
+        np.uint64: PySeries.new_u64,
+        np.str_: PySeries.new_str,
+        bool: PySeries.new_bool,
+    }
 
 
 def numpy_type_to_constructor(dtype: Type[np.dtype]) -> Callable[..., "PySeries"]:
@@ -315,12 +322,13 @@ def numpy_type_to_constructor(dtype: Type[np.dtype]) -> Callable[..., "PySeries"
         return PySeries.new_object
 
 
-_PY_TYPE_TO_CONSTRUCTOR = {
-    float: PySeries.new_opt_f64,
-    int: PySeries.new_opt_i64,
-    str: PySeries.new_str,
-    bool: PySeries.new_opt_bool,
-}
+if not _DOCUMENTING:
+    _PY_TYPE_TO_CONSTRUCTOR = {
+        float: PySeries.new_opt_f64,
+        int: PySeries.new_opt_i64,
+        str: PySeries.new_str,
+        bool: PySeries.new_opt_bool,
+    }
 
 
 def py_type_to_constructor(dtype: Type[Any]) -> Callable[..., "PySeries"]:
@@ -333,12 +341,13 @@ def py_type_to_constructor(dtype: Type[Any]) -> Callable[..., "PySeries"]:
         return PySeries.new_object
 
 
-_PY_TYPE_TO_ARROW_TYPE = {
-    float: pa.float64(),
-    int: pa.int64(),
-    str: pa.large_utf8(),
-    bool: pa.bool_(),
-}
+if not _DOCUMENTING:
+    _PY_TYPE_TO_ARROW_TYPE = {
+        float: pa.float64(),
+        int: pa.int64(),
+        str: pa.large_utf8(),
+        bool: pa.bool_(),
+    }
 
 
 def py_type_to_arrow_type(dtype: Type[Any]) -> pa.lib.DataType:

py-polars/polars/eager/frame.py

@@ -35,7 +35,13 @@
     sequence_to_pydf,
     series_to_pydf,
 )
-from polars.polars import PyDataFrame, PySeries
+
+try:
+    from polars.polars import PyDataFrame, PySeries
+
+    _DOCUMENTING = False
+except ImportError:
+    _DOCUMENTING = True
 
 from .._html import NotebookFormatter
 from ..datatypes import DTYPES, Boolean, DataType, UInt32, pytype_to_polars_type

py-polars/polars/eager/series.py

@@ -14,7 +14,13 @@
     sequence_to_pyseries,
     series_to_pyseries,
 )
-from polars.polars import PyDataFrame, PySeries
+
+try:
+    from polars.polars import PyDataFrame, PySeries
+
+    _DOCUMENTING = False
+except ImportError:
+    _DOCUMENTING = True
 
 from ..datatypes import (
     DTYPE_TO_FFINAME,

py-polars/polars/internals/construction.py

@@ -17,7 +17,13 @@
     py_type_to_arrow_type,
     py_type_to_constructor,
 )
-from polars.polars import PyDataFrame, PySeries
+
+try:
+    from polars.polars import PyDataFrame, PySeries
+
+    _DOCUMENTING = False
+except ImportError:
+    _DOCUMENTING = True
 from polars.utils import coerce_arrow
 
 if TYPE_CHECKING:

py-polars/polars/io.py

@@ -328,8 +328,7 @@ def scan_csv(
         Start reading after `skip_rows`.
     stop_after_n_rows
         After n rows are read from the CSV, it stops reading.
-        During multi-threaded parsing, an upper bound of `n` rows
-        cannot be guaranteed.
+        During multi-threaded parsing, an upper bound of `n` rows cannot be guaranteed.
     cache
         Cache the result after reading.
     dtype

py-polars/polars/lazy/expr.py

@@ -3,7 +3,13 @@
 from typing import Any, Callable, Optional, Sequence, Type, Union
 
 import polars as pl
-from polars.polars import PyExpr
+
+try:
+    from polars.polars import PyExpr
+
+    _DOCUMENTING = False
+except ImportError:
+    _DOCUMENTING = True
 
 from ..datatypes import Boolean, DataType, Date32, Date64, Float64, Int64, Utf8
 from .functions import UDF, col, lit

py-polars/polars/lazy/frame.py

@@ -9,7 +9,13 @@
 from typing import Any, Callable, Dict, Optional, Sequence, Tuple, Type, Union
 
 import polars as pl
-from polars.polars import PyExpr, PyLazyFrame, PyLazyGroupBy
+
+try:
+    from polars.polars import PyExpr, PyLazyFrame, PyLazyGroupBy
+
+    _DOCUMENTING = False
+except ImportError:
+    _DOCUMENTING = True
 
 from ..datatypes import DataType, pytype_to_polars_type
 from ..utils import _process_null_values

py-polars/polars/lazy/functions.py

@@ -5,16 +5,22 @@
 import numpy as np
 
 import polars as pl
-from polars.polars import argsort_by as pyargsort_by
-from polars.polars import binary_function as pybinary_function
-from polars.polars import col as pycol
-from polars.polars import concat_str as _concat_str
-from polars.polars import cov as pycov
-from polars.polars import except_ as pyexcept
-from polars.polars import fold as pyfold
-from polars.polars import lit as pylit
-from polars.polars import pearson_corr as pypearson_corr
-from polars.polars import series_from_range as _series_from_range
+
+try:
+    from polars.polars import argsort_by as pyargsort_by
+    from polars.polars import binary_function as pybinary_function
+    from polars.polars import col as pycol
+    from polars.polars import concat_str as _concat_str
+    from polars.polars import cov as pycov
+    from polars.polars import except_ as pyexcept
+    from polars.polars import fold as pyfold
+    from polars.polars import lit as pylit
+    from polars.polars import pearson_corr as pypearson_corr
+    from polars.polars import series_from_range as _series_from_range
+
+    _DOCUMENTING = False
+except ImportError:
+    _DOCUMENTING = True
 
 from ..datatypes import DataType, Date64, Int64
 

py-polars/polars/lazy/whenthen.py

@@ -1,7 +1,13 @@
 from typing import Any, Union
 
 import polars as pl
-from polars.polars import when as pywhen
+
+try:
+    from polars.polars import when as pywhen
+
+    _DOCUMENTING = False
+except ImportError:
+    _DOCUMENTING = True
 
 from .expr import expr_to_lit_or_expr
 

py-polars/polars/string_cache.py

@@ -1,7 +1,12 @@
 from types import TracebackType
 from typing import Optional, Type
 
-from polars.polars import toggle_string_cache as pytoggle_string_cache
+try:
+    from polars.polars import toggle_string_cache as pytoggle_string_cache
+
+    _DOCUMENTING = False
+except ImportError:
+    _DOCUMENTING = True
 
 __all__ = [
     "StringCache",