Skip to content
Open
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
11 changes: 5 additions & 6 deletions pyiceberg/io/fileformat.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

from abc import ABC, abstractmethod
from dataclasses import dataclass
from typing import TYPE_CHECKING, Any
from typing import TYPE_CHECKING, Any, Protocol, runtime_checkable

from pyiceberg.io import OutputFile
from pyiceberg.manifest import FileFormat
Expand Down Expand Up @@ -143,28 +143,27 @@ def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
self._result = self.close()


class FileFormatModel(ABC):
@runtime_checkable
class FileFormatModel(Protocol):
"""Represents a file format's capabilities. Creates writers."""

@property
@abstractmethod
def format(self) -> FileFormat: ...

@abstractmethod
def file_extension(self) -> str:
"""Return file extension without dot, e.g. 'parquet', 'orc'."""
...

@abstractmethod
def create_writer(
self,
output_file: OutputFile,
file_schema: Schema,
properties: Properties,
) -> FileFormatWriter: ...

@abstractmethod
def add_field_metadata(self, field: NestedField, metadata: dict[bytes, bytes], include_field_ids: bool) -> None:
"""Add format-specific Arrow field metadata."""
...


class FileFormatFactory:
Expand Down
33 changes: 33 additions & 0 deletions tests/io/test_fileformat.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,36 @@ def close(self) -> DataFileStatistics:
writer = _DummyWriter()
with pytest.raises(RuntimeError, match="Writer has not been closed yet"):
writer.result()


class _StructuralModel:
"""Non-inheriting class that structurally conforms to the FileFormatModel Protocol."""

@property
def format(self) -> FileFormat:
return FileFormat.ORC

def file_extension(self) -> str:
return "orc"

def create_writer(self, output_file: Any, file_schema: Any, properties: Any) -> Any:
raise NotImplementedError

def add_field_metadata(self, field: Any, metadata: Any, include_field_ids: bool) -> None:
pass


def test_file_format_model_is_protocol() -> None:
"""A structurally-conforming class (no inheritance) passes isinstance() against FileFormatModel."""
assert isinstance(_StructuralModel(), FileFormatModel)


def test_structural_model_works_with_factory() -> None:
"""A structurally-conforming class (no inheritance) can be registered and retrieved via FileFormatFactory."""
original = dict(FileFormatFactory._registry)
try:
model = _StructuralModel()
FileFormatFactory.register(model)
assert FileFormatFactory.get(FileFormat.ORC) is model
finally:
FileFormatFactory._registry = original