Skip to content

Commit

Permalink
docs: add brief comment
Browse files Browse the repository at this point in the history
  • Loading branch information
agoose77 committed Oct 4, 2023
1 parent dc8e93e commit 0a746d3
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/dask_awkward/lib/io/columnar.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,14 @@ def behavior(self) -> dict | None:


class ColumnProjectionMixin:
"""A mixin to add column-centric buffer projection to an IO function.
Classes that inherit from this mixin are assumed to be able to read at the
granularity of _fields_ in a form. As such, the buffer projection is performed
such that the smallest possible number of fields (columns) are read, even
when only metadata buffers are required.
"""

def mock(self: ImplementsColumnProjectionImpl) -> AwkwardArray:
return ak.typetracer.typetracer_from_form(self.form, behavior=self.behavior)

Expand Down

0 comments on commit 0a746d3

Please sign in to comment.