Skip to content

ENH: Support plugin DataFrame accessor via entry points (#29076) #61499

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
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
1 change: 1 addition & 0 deletions doc/source/whatsnew/v3.0.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ Other enhancements
- Improved deprecation message for offset aliases (:issue:`60820`)
- Multiplying two :class:`DateOffset` objects will now raise a ``TypeError`` instead of a ``RecursionError`` (:issue:`59442`)
- Restore support for reading Stata 104-format and enable reading 103-format dta files (:issue:`58554`)
- Support :class:`DataFrame` plugin accessor via entry points (:issue:`29076`)
- Support passing a :class:`Iterable[Hashable]` input to :meth:`DataFrame.drop_duplicates` (:issue:`59237`)
- Support reading Stata 102-format (Stata 1) dta files (:issue:`58978`)
- Support reading Stata 110-format (Stata 7) dta files (:issue:`47176`)
Expand Down
5 changes: 5 additions & 0 deletions pandas/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -346,3 +346,8 @@
"unique",
"wide_to_long",
]

from pandas.core.accessor import DataFrameAccessorLoader

DataFrameAccessorLoader.load()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why a class with a single method?

And why only doing this for DataFrame, not for Series?

del DataFrameAccessorLoader
26 changes: 26 additions & 0 deletions pandas/core/accessor.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import functools
from typing import (
TYPE_CHECKING,
Any,
final,
)
import warnings
Expand All @@ -25,6 +26,8 @@
from pandas import Index
from pandas.core.generic import NDFrame

from importlib.metadata import entry_points


class DirNamesMixin:
_accessors: set[str] = set()
Expand Down Expand Up @@ -393,3 +396,26 @@ def register_index_accessor(name: str) -> Callable[[TypeT], TypeT]:
from pandas import Index

return _register_accessor(name, Index)


class DataFrameAccessorLoader:
"""Loader class for registering DataFrame accessors via entry points."""

ENTRY_POINT_GROUP: str = "pandas_dataframe_accessor"

@classmethod
def load(cls) -> None:
"""loads and registers accessors defined by 'pandas_dataframe_accessor'."""
eps = entry_points(group=cls.ENTRY_POINT_GROUP)

for ep in eps:
name: str = ep.name

def make_property(ep):
def accessor(self) -> Any:
cls_ = ep.load()
return cls_(self)

return accessor

register_dataframe_accessor(name)(make_property(ep))
35 changes: 35 additions & 0 deletions pandas/tests/test_plugis_entrypoint_loader.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import pandas as pd
from pandas.core.accessor import DataFrameAccessorLoader


def test_load_dataframe_accessors(monkeypatch):
# GH29076
# Mocked EntryPoint to simulate a plugin
class MockEntryPoint:
name = "test_accessor"

def load(self):
class TestAccessor:
def __init__(self, df):
self._df = df

def test_method(self):
return "success"

return TestAccessor

# Mock entry_points
def mock_entry_points(*, group):
if group == DataFrameAccessorLoader.ENTRY_POINT_GROUP:
return [MockEntryPoint()]
return []

# Patch entry_points in the correct module
monkeypatch.setattr("pandas.core.accessor.entry_points", mock_entry_points)

DataFrameAccessorLoader.load()

# Create DataFrame and verify that the accessor was registered
df = pd.DataFrame({"a": [1, 2, 3]})
assert hasattr(df, "test_accessor")
assert df.test_accessor.test_method() == "success"
Loading