lazyscribe-arrow 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

lazyscribe_arrow/__init__.py

@@ -1,5 +1,6 @@
 """Import the custom artifact handlers."""
 
 from lazyscribe_arrow.csv import CSVArtifact
+from lazyscribe_arrow.parquet import ParquetArtifact
 
-__all__: list[str] = ["CSVArtifact"]
+__all__: list[str] = ["CSVArtifact", "ParquetArtifact"]

lazyscribe_arrow/_meta.py

@@ -1,3 +1,3 @@
 """Version."""
 
-__version__ = "0.1.0"
+__version__ = "0.2.0"

lazyscribe_arrow/csv.py

@@ -9,6 +9,7 @@ from attrs import define
 from lazyscribe._utils import utcnow
 from lazyscribe.artifacts.base import Artifact
 from pyarrow import csv
+from pyarrow.interchange import from_dataframe
 from slugify import slugify
 
 LOG = logging.getLogger(__name__)
@@ -92,10 +93,13 @@ class CSVArtifact(Artifact):
             LOG.debug("Provided object is already a PyArrow table.")
         elif hasattr(obj, "__arrow_c_array__") or hasattr(obj, "__arrow_c_stream__"):
             obj = pa.table(obj)
+        elif hasattr(obj, "__dataframe__"):
+            obj = from_dataframe(obj)
         else:
             raise ValueError(
                 f"Object of type `{type(obj)}` cannot be easily coerced into a PyArrow Table. "
-                "Please provide an object that implements the Arrow PyCapsule Interface."
+                "Please provide an object that implements the Arrow PyCapsule Interface or the "
+                "Dataframe Interchange Protocol."
             )
 
         csv.write_csv(obj, buf, **kwargs)

lazyscribe_arrow/parquet.py

@@ -0,0 +1,107 @@
+"""Custom artifact handlers for parquets."""
+
+import logging
+from datetime import datetime
+from typing import Any, ClassVar
+
+import pyarrow as pa
+import pyarrow.parquet as pq
+from attrs import define
+from lazyscribe._utils import utcnow
+from lazyscribe.artifacts.base import Artifact
+from pyarrow.interchange import from_dataframe
+from slugify import slugify
+
+LOG = logging.getLogger(__name__)
+
+
+@define(auto_attribs=True)
+class ParquetArtifact(Artifact):
+    """Arrow-powered Parquet handler."""
+
+    alias: ClassVar[str] = "parquet"
+    suffix: ClassVar[str] = "parquet"
+    binary: ClassVar[bool] = True
+    output_only: ClassVar[bool] = False
+
+    @classmethod
+    def construct(
+        cls,
+        name: str,
+        value: Any | None = None,
+        fname: str | None = None,
+        created_at: datetime | None = None,
+        writer_kwargs: dict | None = None,
+        version: int = 0,
+        dirty: bool = True,
+        **kwargs,
+    ):
+        """Construct the handler class."""
+        created_at = created_at or utcnow()
+
+        return cls(  # type: ignore[call-arg]
+            name=name,
+            value=value,
+            fname=fname
+            or f"{slugify(name)}-{slugify(created_at.strftime('%Y%m%d%H%M%S'))}.{cls.suffix}",
+            writer_kwargs=writer_kwargs or {},
+            version=version,
+            created_at=created_at,
+            dirty=dirty,
+        )
+
+    @classmethod
+    def read(cls, buf, **kwargs) -> pa.Table:
+        """Read in the parquet file.
+
+        Parameters
+        ----------
+        buf : file-like object
+            The buffer from a ``fsspec`` filesystem.
+        **kwargs
+            Keyword arguments for the read method.
+
+        Returns
+        -------
+        pyarrow.lib.Table
+            A ``pyarrow`` table with the data.
+        """
+        return pq.read_table(buf, **kwargs)
+
+    @classmethod
+    def write(cls, obj, buf, **kwargs):
+        """Write the parquet file using pyarrow.
+
+        Parameters
+        ----------
+        obj : object
+            The object to write.
+        buf : file-like object
+            The buffer from a ``fsspec`` filesystem.
+        **kwargs
+            Keyword arguments for :py:meth:`pyarrow.parquet.write_table`.
+
+        Raises
+        ------
+        ValueError
+            Raised if the supplied object does not have ``__arrow_c_array__``
+            or ``__arrow_c_stream__`` attribute
+            or if the object does not
+            implement the dataframe interchange protocol. These attributes allow us to
+            perform a zero-copy transformation from the native obejct to a PyArrow
+            Table.
+        """
+        if isinstance(obj, pa.Table):
+            LOG.debug("Provided object is already a PyArrow table.")
+        elif hasattr(obj, "__arrow_c_array__") or hasattr(obj, "__arrow_c_stream__"):
+            obj = pa.table(obj)
+        elif hasattr(obj, "__dataframe__"):
+            obj = from_dataframe(obj)
+        else:
+            raise ValueError(
+                f"Object of type `{type(obj)}` cannot be easily coerced into a PyArrow Table. "
+                "Please provide an object that implements the Arrow PyCapsule Interface or the "
+                "Dataframe Interchange Protocol."
+            )
+
+        pq.write_table(obj, buf, **kwargs)

{lazyscribe_arrow-0.1.0.dist-info → lazyscribe_arrow-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lazyscribe-arrow
-Version: 0.1.0
+Version: 0.2.0
 Summary: Arrow-based artifact handlers for Lazyscribe
 Author-email: Akshay Gupta <akgcodes@gmail.com>
 License: MIT license
@@ -17,6 +17,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10.0
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: attrs<=25.1.0,>=21.2.0
 Requires-Dist: lazyscribe<=1.1.0,>=1.0.0
 Requires-Dist: pyarrow<=19.0.1,>=14.0.1
@@ -42,3 +43,46 @@ Provides-Extra: dev
 Requires-Dist: lazyscribe-arrow[build]; extra == "dev"
 Requires-Dist: lazyscribe-arrow[qa]; extra == "dev"
 Requires-Dist: lazyscribe-arrow[tests]; extra == "dev"
+Dynamic: license-file
+
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![PyPI](https://img.shields.io/pypi/v/lazyscribe-arrow)](https://pypi.org/project/lazyscribe-arrow/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/lazyscribe-arrow)](https://pypi.org/project/lazyscrib-arrow/) [![codecov](https://codecov.io/gh/lazyscribe/lazyscribe-arrow/graph/badge.svg?token=W5TPK7GX7G)](https://codecov.io/gh/lazyscribe/lazyscribe-arrow)
+
+# Arrow-based artifact handling for lazyscribe
+
+`lazyscribe-arrow` is a lightweight package that adds the following artifact handlers for `lazyscribe`:
+
+* `csv`
+
+Any data structure that implements the [Arrow PyCapsule Interface](https://arrow.apache.org/docs/format/CDataInterface/PyCapsuleInterface.html)
+will be compatible with the handlers in this library. Popular compatible open source data structures include
+
+* `pandas.DataFrame`
+* `polars.DataFrame`
+* `polars.LazyFrame`
+
+# Installation
+
+Python 3.10 and above is required. use `pip` to install:
+
+```console
+$ python -m pip install lazyscribe-arrow
+```
+
+# Usage
+
+To use this library, simply log an artifact to a `lazyscribe` experiment or repository with
+
+* `handler="csv"` for a CSV output
+
+
+```python
+import pyarrow as pa
+from lazyscribe import Project
+
+project = Project("project.json", mode="w")
+with project.log("My experiment") as exp:
+    data = pa.Table.from_arrays([[0, 1, 2]], names=["a"])
+    exp.log_artifact(name="data", value=data, handler="csv")
+
+project.save()
+```

lazyscribe_arrow-0.2.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+lazyscribe_arrow/__init__.py,sha256=YwnXVqIllCJKZakHtTtDsWh_raw0HGqG8lgsUfCH9FQ,199
+lazyscribe_arrow/_meta.py,sha256=tkM0F11odKeRd4ewZf6_GEIFshm_W68xXAjlwEu59xQ,38
+lazyscribe_arrow/csv.py,sha256=cyMcFC9S0tR2U7C5EWTsvQZETgU54fronafmn2LQbSA,3158
+lazyscribe_arrow/parquet.py,sha256=J3AqMvV77wSDW8FQYJE8xjidC5v8Zg4tvgCYh11_1LM,3293
+lazyscribe_arrow-0.2.0.dist-info/licenses/LICENSE,sha256=CbVwVKAq7TtkHhzCxwB5N86wxbkcn2VMP5UTxj3NgZo,1067
+lazyscribe_arrow-0.2.0.dist-info/METADATA,sha256=TqG43wfVq499R4vLnaNUjs5wnEhga6NOcl5BLoN33a0,3347
+lazyscribe_arrow-0.2.0.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+lazyscribe_arrow-0.2.0.dist-info/entry_points.txt,sha256=GBZx4whc5e9t2mDuCxaBlYX0yHJKmnNwqczLob2TFfI,105
+lazyscribe_arrow-0.2.0.dist-info/top_level.txt,sha256=C_ElBcqIKkSjUmMQPDECDhhP54M7muep1KLnEiFJ61I,17
+lazyscribe_arrow-0.2.0.dist-info/RECORD,,

{lazyscribe_arrow-0.1.0.dist-info → lazyscribe_arrow-0.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.3.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{lazyscribe_arrow-0.1.0.dist-info → lazyscribe_arrow-0.2.0.dist-info}/entry_points.txt

@@ -1,2 +1,3 @@
 [lazyscribe.artifact_type]
 csv = lazyscribe_arrow:CSVArtifact
+parquet = lazyscribe_arrow:ParquetArtifact

lazyscribe_arrow-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 lazyscribe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

lazyscribe_arrow-0.1.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-lazyscribe_arrow/__init__.py,sha256=nZR8SxoxZjsGSVwdMFTI9l582H0M-77iec3NXzCeziU,127
-lazyscribe_arrow/_meta.py,sha256=FT4J4aKqWfsY7SJy-yg7R1ebCnARJzh_OZjkyUpF0NQ,38
-lazyscribe_arrow/csv.py,sha256=mFgYkntabK65KDguS5wuWe3vd7IG0dznKi01EEGf5QY,2972
-lazyscribe_arrow-0.1.0.dist-info/METADATA,sha256=7IcYyuWzrkgeRsxJVH-Erz0fYb-Kaxy7lQZbCf7T6rQ,1813
-lazyscribe_arrow-0.1.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-lazyscribe_arrow-0.1.0.dist-info/entry_points.txt,sha256=4ymVC3yTTvMs2iOibuw9pt7goZ0zWWhgdjJ6NzMS_cw,62
-lazyscribe_arrow-0.1.0.dist-info/top_level.txt,sha256=C_ElBcqIKkSjUmMQPDECDhhP54M7muep1KLnEiFJ61I,17
-lazyscribe_arrow-0.1.0.dist-info/RECORD,,