Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: rename Form to form_cls #1976

Merged
merged 1 commit into from
Dec 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/awkward/contents/bitmaskedarray.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
from awkward.contents.content import Content
from awkward.forms.bitmaskedform import BitMaskedForm
from awkward.index import Index
from awkward.typing import Self
from awkward.typing import Final, Self

np = ak._nplikes.NumpyMetadata.instance()
numpy = ak._nplikes.Numpy.instance()
Expand Down Expand Up @@ -114,7 +114,7 @@ def valid_when(self):
def lsb_order(self):
return self._lsb_order

Form = BitMaskedForm
form_cls: Final = BitMaskedForm

def copy(
self,
Expand Down Expand Up @@ -190,7 +190,7 @@ def simplified(

def _form_with_key(self, getkey):
form_key = getkey(self)
return self.Form(
return self.form_cls(
self._mask.form,
self._content._form_with_key(getkey),
self._valid_when,
Expand All @@ -200,7 +200,7 @@ def _form_with_key(self, getkey):
)

def _to_buffers(self, form, getkey, container, backend):
assert isinstance(form, self.Form)
assert isinstance(form, self.form_cls)
key = getkey(self, form, "mask")
container[key] = ak._util.little_endian(self._mask.raw(backend.index_nplike))
self._content._to_buffers(form.content, getkey, container, backend)
Expand Down
8 changes: 4 additions & 4 deletions src/awkward/contents/bytemaskedarray.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
from awkward.contents.content import Content
from awkward.forms.bytemaskedform import ByteMaskedForm
from awkward.index import Index
from awkward.typing import Self
from awkward.typing import Final, Self

np = ak._nplikes.NumpyMetadata.instance()
numpy = ak._nplikes.Numpy.instance()
Expand Down Expand Up @@ -84,7 +84,7 @@ def content(self):
def valid_when(self):
return self._valid_when

Form = ByteMaskedForm
form_cls: Final = ByteMaskedForm

def copy(self, mask=unset, content=unset, valid_when=unset, *, parameters=unset):
return ByteMaskedArray(
Expand Down Expand Up @@ -139,7 +139,7 @@ def simplified(

def _form_with_key(self, getkey):
form_key = getkey(self)
return self.Form(
return self.form_cls(
self._mask.form,
self._content._form_with_key(getkey),
self._valid_when,
Expand All @@ -148,7 +148,7 @@ def _form_with_key(self, getkey):
)

def _to_buffers(self, form, getkey, container, backend):
assert isinstance(form, self.Form)
assert isinstance(form, self.form_cls)
key = getkey(self, form, "mask")
container[key] = ak._util.little_endian(self._mask.raw(backend.index_nplike))
self._content._to_buffers(form.content, getkey, container, backend)
Expand Down
40 changes: 20 additions & 20 deletions src/awkward/contents/content.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
import awkward as ak
import awkward._reducers
from awkward._backends import Backend, TypeTracerBackend
from awkward.forms import form
from awkward.forms.form import Form, _parameters_equal
from awkward.typing import Any, Self, TypeAlias, TypeVar

np = ak._nplikes.NumpyMetadata.instance()
Expand Down Expand Up @@ -121,7 +121,7 @@ def backend(self) -> Backend:
return self._backend

@property
def form(self) -> form.Form:
def form(self) -> Form:
return self.form_with_key(None)

def form_with_key(self, form_key="node{id}", id_start=0):
Expand Down Expand Up @@ -159,12 +159,12 @@ def getkey(layout):

def _form_with_key(
self,
getkey: Callable[[Content], form.Form],
) -> form.Form:
getkey: Callable[[Content], Form],
) -> Form:
raise ak._errors.wrap_error(NotImplementedError)

@property
def Form(self) -> type[form.Form]:
def form_cls(self) -> type[Form]:
raise ak._errors.wrap_error(NotImplementedError)

@property
Expand All @@ -191,7 +191,7 @@ def to_buffers(
form_key: str | None = "node{id}",
id_start: Integral = 0,
backend: Backend = None,
) -> tuple[form.Form, int, Mapping[str, Any]]:
) -> tuple[Form, int, Mapping[str, Any]]:
if container is None:
container = {}
if backend is None:
Expand Down Expand Up @@ -240,11 +240,11 @@ def getkey(layout, form, attribute):

def _to_buffers(
self,
form: form.Form,
getkey: Callable[[Content, form.Form, str], str],
form: Form,
getkey: Callable[[Content, Form, str], str],
container: MutableMapping[str, Any] | None,
backend: Backend,
) -> tuple[form.Form, int, Mapping[str, Any]]:
) -> tuple[Form, int, Mapping[str, Any]]:
raise ak._errors.wrap_error(NotImplementedError)

def __len__(self) -> int:
Expand Down Expand Up @@ -775,7 +775,7 @@ def mergeable(self, other: Content, mergebool: bool = True) -> bool:
return True
# Otherwise, do the parameters match? If not, we can't merge.
elif not (
form._parameters_equal(
_parameters_equal(
self._parameters, other._parameters, only_array_record=True
)
):
Expand Down Expand Up @@ -1316,7 +1316,7 @@ def nbytes(self) -> int:
return self._nbytes_part()

def purelist_parameter(self, key: str):
return self.Form.purelist_parameter(self, key)
return self.form_cls.purelist_parameter(self, key)

def is_unique(self, axis: Integral | None = None) -> bool:
negaxis = axis if axis is None else -axis
Expand Down Expand Up @@ -1394,35 +1394,35 @@ def _unique(

@property
def is_identity_like(self) -> bool:
return self.Form.is_identity_like.__get__(self)
return self.form_cls.is_identity_like.__get__(self)

@property
def purelist_isregular(self) -> bool:
return self.Form.purelist_isregular.__get__(self)
return self.form_cls.purelist_isregular.__get__(self)

@property
def purelist_depth(self) -> int:
return self.Form.purelist_depth.__get__(self)
return self.form_cls.purelist_depth.__get__(self)

@property
def minmax_depth(self) -> tuple[int, int]:
return self.Form.minmax_depth.__get__(self)
return self.form_cls.minmax_depth.__get__(self)

@property
def branch_depth(self) -> tuple[bool, int]:
return self.Form.branch_depth.__get__(self)
return self.form_cls.branch_depth.__get__(self)

@property
def fields(self) -> list[str]:
return self.Form.fields.__get__(self)
return self.form_cls.fields.__get__(self)

@property
def is_tuple(self) -> bool:
return self.Form.is_tuple.__get__(self)
return self.form_cls.is_tuple.__get__(self)

@property
def dimension_optiontype(self) -> bool:
return self.Form.dimension_optiontype.__get__(self)
return self.form_cls.dimension_optiontype.__get__(self)

def pad_none_axis0(self, target: Integral, clip: bool) -> Content:
if not clip and target < self.length:
Expand Down Expand Up @@ -1748,7 +1748,7 @@ def layout_equal(
return (
self.__class__ is other.__class__
and len(self) == len(other)
and ak.forms.form._parameters_equal(
and _parameters_equal(
self.parameters, other.parameters, only_array_record=False
)
and self._layout_equal(other, index_dtype, numpyarray)
Expand Down
8 changes: 4 additions & 4 deletions src/awkward/contents/emptyarray.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from awkward._util import unset
from awkward.contents.content import Content
from awkward.forms.emptyform import EmptyForm
from awkward.typing import Self
from awkward.typing import Final, Self

np = ak._nplikes.NumpyMetadata.instance()
numpy = ak._nplikes.Numpy.instance()
Expand All @@ -22,7 +22,7 @@ def __init__(self, *, parameters=None, backend=None):
backend = ak._backends.NumpyBackend.instance()
self._init(parameters, backend)

Form = EmptyForm
form_cls: Final = EmptyForm

def copy(
self,
Expand All @@ -46,10 +46,10 @@ def simplified(cls, *, parameters=None, backend=None):
return cls(parameters=parameters, backend=backend)

def _form_with_key(self, getkey):
return self.Form(parameters=self._parameters, form_key=getkey(self))
return self.form_cls(parameters=self._parameters, form_key=getkey(self))

def _to_buffers(self, form, getkey, container, backend):
assert isinstance(form, self.Form)
assert isinstance(form, self.form_cls)

@property
def typetracer(self):
Expand Down
8 changes: 4 additions & 4 deletions src/awkward/contents/indexedarray.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
from awkward.contents.content import Content
from awkward.forms.indexedform import IndexedForm
from awkward.index import Index
from awkward.typing import Self
from awkward.typing import Final, Self

np = ak._nplikes.NumpyMetadata.instance()
numpy = ak._nplikes.Numpy.instance()
Expand Down Expand Up @@ -65,7 +65,7 @@ def index(self):
def content(self):
return self._content

Form = IndexedForm
form_cls: Final = IndexedForm

def copy(self, index=unset, content=unset, *, parameters=unset):
return IndexedArray(
Expand Down Expand Up @@ -137,15 +137,15 @@ def simplified(cls, index, content, *, parameters=None):

def _form_with_key(self, getkey):
form_key = getkey(self)
return self.Form(
return self.form_cls(
self._index.form,
self._content._form_with_key(getkey),
parameters=self._parameters,
form_key=form_key,
)

def _to_buffers(self, form, getkey, container, backend):
assert isinstance(form, self.Form)
assert isinstance(form, self.form_cls)
key = getkey(self, form, "index")
container[key] = ak._util.little_endian(self._index.raw(backend.index_nplike))
self._content._to_buffers(form.content, getkey, container, backend)
Expand Down
8 changes: 4 additions & 4 deletions src/awkward/contents/indexedoptionarray.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
from awkward.contents.content import Content
from awkward.forms.indexedoptionform import IndexedOptionForm
from awkward.index import Index
from awkward.typing import Self
from awkward.typing import Final, Self

np = ak._nplikes.NumpyMetadata.instance()
numpy = ak._nplikes.Numpy.instance()
Expand Down Expand Up @@ -65,7 +65,7 @@ def index(self):
def content(self):
return self._content

Form = IndexedOptionForm
form_cls: Final = IndexedOptionForm

def copy(self, index=unset, content=unset, *, parameters=unset):
return IndexedOptionArray(
Expand Down Expand Up @@ -124,15 +124,15 @@ def simplified(cls, index, content, *, parameters=None):

def _form_with_key(self, getkey):
form_key = getkey(self)
return self.Form(
return self.form_cls(
self._index.form,
self._content._form_with_key(getkey),
parameters=self._parameters,
form_key=form_key,
)

def _to_buffers(self, form, getkey, container, backend):
assert isinstance(form, self.Form)
assert isinstance(form, self.form_cls)
key = getkey(self, form, "index")
container[key] = ak._util.little_endian(self._index.raw(backend.index_nplike))
self._content._to_buffers(form.content, getkey, container, backend)
Expand Down
8 changes: 4 additions & 4 deletions src/awkward/contents/listarray.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
from awkward.contents.listoffsetarray import ListOffsetArray
from awkward.forms.listform import ListForm
from awkward.index import Index
from awkward.typing import Self
from awkward.typing import Final, Self

np = ak._nplikes.NumpyMetadata.instance()

Expand Down Expand Up @@ -98,7 +98,7 @@ def stops(self):
def content(self):
return self._content

Form = ListForm
form_cls: Final = ListForm

def copy(self, starts=unset, stops=unset, content=unset, *, parameters=unset):
return ListArray(
Expand All @@ -125,7 +125,7 @@ def simplified(cls, starts, stops, content, *, parameters=None):

def _form_with_key(self, getkey):
form_key = getkey(self)
return self.Form(
return self.form_cls(
self._starts.form,
self._stops.form,
self._content._form_with_key(getkey),
Expand All @@ -134,7 +134,7 @@ def _form_with_key(self, getkey):
)

def _to_buffers(self, form, getkey, container, backend):
assert isinstance(form, self.Form)
assert isinstance(form, self.form_cls)
key1 = getkey(self, form, "starts")
key2 = getkey(self, form, "stops")
container[key1] = ak._util.little_endian(self._starts.raw(backend.index_nplike))
Expand Down
8 changes: 4 additions & 4 deletions src/awkward/contents/listoffsetarray.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
from awkward.contents.content import Content
from awkward.forms.listoffsetform import ListOffsetForm
from awkward.index import Index
from awkward.typing import Self
from awkward.typing import Final, Self

np = ak._nplikes.NumpyMetadata.instance()
numpy = ak._nplikes.Numpy.instance()
Expand Down Expand Up @@ -79,7 +79,7 @@ def offsets(self):
def content(self):
return self._content

Form = ListOffsetForm
form_cls: Final = ListOffsetForm

def copy(self, offsets=unset, content=unset, *, parameters=unset):
return ListOffsetArray(
Expand Down Expand Up @@ -112,15 +112,15 @@ def stops(self):

def _form_with_key(self, getkey):
form_key = getkey(self)
return self.Form(
return self.form_cls(
self._offsets.form,
self._content._form_with_key(getkey),
parameters=self._parameters,
form_key=form_key,
)

def _to_buffers(self, form, getkey, container, backend):
assert isinstance(form, self.Form)
assert isinstance(form, self.form_cls)
key = getkey(self, form, "offsets")
container[key] = ak._util.little_endian(self._offsets.raw(backend.index_nplike))
self._content._to_buffers(form.content, getkey, container, backend)
Expand Down
Loading