Refactor: class to fn && Fix: warning

- Added DocStrs
- Fixed small typo in test file name

Co-authored-by: Afonso Antunes <[email protected]>

Author: PedroM4rques

pandas/__init__.py

@@ -347,7 +347,7 @@
     "wide_to_long",
 ]
 
-from .core.accessor import AccessorEntryPointLoader
+from .core.accessor import accessor_entry_point_loader
 
-AccessorEntryPointLoader.load()
-del AccessorEntryPointLoader
+accessor_entry_point_loader()
+del accessor_entry_point_loader

pandas/core/accessor.py

@@ -26,7 +26,10 @@
     from pandas import Index
     from pandas.core.generic import NDFrame
 
-from importlib.metadata import entry_points
+from importlib.metadata import (
+    EntryPoints,
+    entry_points,
+)
 
 
 class DirNamesMixin:
@@ -398,44 +401,78 @@ def register_index_accessor(name: str) -> Callable[[TypeT], TypeT]:
     return _register_accessor(name, Index)
 
 
-class AccessorEntryPointLoader:  # is this a good name for the class?
-    """Loader class for registering accessors via entry points."""
+def accessor_entry_point_loader() -> None:
+    """
+    Load and register pandas accessors declared via entry points.
 
-    ENTRY_POINT_GROUP: str = "pandas_accessor"
+    This function scans the 'pandas.accessor' entry point group for accessors
+    registered by third-party packages. Each entry point is expected to follow
+    the format:
 
-    @classmethod
-    def load(cls) -> None:
-        """loads and registers accessors defined by 'pandas_accessor'."""
-        accessors = entry_points(group=cls.ENTRY_POINT_GROUP)
-        unique_accessors_names: set[str] = set()
-
-        for accessor in accessors:
-            # Verifies duplicated accessor names
-            if accessor.name in unique_accessors_names:
-                try:
-                    pkg_name: str = accessor.dist.name
-                except Exception:
-                    pkg_name = "unknown"
-                warnings.warn(
-                    "Warning: you have two accessors with the same name:"
-                    f" '{accessor.name}' has already been registered"
-                    f" by the package '{pkg_name}'. So the '{accessor.name}' "
-                    f"provided by the package '{pkg_name}' is not "
-                    f"being used. Uninstall the package you don't want"
-                    "to use if you want to get rid of this warning.\n",
-                    UserWarning,
-                    stacklevel=2,
-                )
+        TODO
 
-            else:
-                unique_accessors_names.add(accessor.name)
+    For example:
+
+        TODO
+        TODO
+        TODO
+
+
+    For each valid entry point:
+    - The accessor class is dynamically imported and registered using
+      the appropriate registration decorator function
+      (e.g. register_dataframe_accessor).
+    - If two packages declare the same accessor name, a warning is issued,
+      and only the first one is used.
+
+    Notes
+    -----
+    - This function is only intended to be called at pandas startup.
+
+    Raises
+    ------
+    UserWarning
+        If two accessors share the same name, the second one is ignored.
+
+    Examples
+    --------
+    >>> df.myplugin.do_something()  # Assuming such accessor was registered
+    """
+
+    ENTRY_POINT_GROUP: str = "pandas.accessor"
+
+    accessors: EntryPoints = entry_points(group=ENTRY_POINT_GROUP)
+    accessor_package_dict: dict[str, str] = {}
+
+    for new_accessor in accessors:
+        try:
+            new_pkg_name: str = new_accessor.dist.name
+        except AttributeError:
+            new_pkg_name: str = "Unknown"
+
+        # Verifies duplicated accessor names
+        if new_accessor.name in accessor_package_dict:
+            loaded_pkg_name: str = accessor_package_dict.get(new_accessor.name)
+
+            warnings.warn(
+                "Warning: you have two accessors with the same name:"
+                f" '{new_accessor.name}' has already been registered"
+                f" by the package '{new_pkg_name}'. So the "
+                f"'{new_accessor.name}' provided by the package "
+                f"'{loaded_pkg_name}' is not being used. "
+                "Uninstall the package you don't want"
+                "to use if you want to get rid of this warning.\n",
+                UserWarning,
+                stacklevel=2,
+            )
+
+        accessor_package_dict.update({new_accessor.name: new_pkg_name})
 
-            def make_property(ep):
-                def accessor(self) -> Any:
-                    cls_ = ep.load()
-                    return cls_(self)
+        def make_accessor(ep):
+            def accessor(self) -> Any:
+                cls_ = ep.load()
+                return cls_(self)
 
-                return accessor
+            return accessor
 
-            # _register_accessor()
-            register_dataframe_accessor(accessor.name)(make_property(accessor))
+        register_dataframe_accessor(new_accessor.name)(make_accessor(new_accessor))

pandas/tests/test_plugis_entrypoint_loader.py renamed to pandas/tests/test_plugins_entrypoint_loader.py

@@ -1,9 +1,11 @@
 import pandas as pd
 import pandas._testing as tm
-from pandas.core.accessor import AccessorEntryPointLoader
+from pandas.core.accessor import accessor_entry_point_loader
 
 # TODO: test for pkg names
 
+PANDAS_ENTRY_POINT_GROUP: str = "pandas.accessor"
+
 
 def test_no_accessors(monkeypatch):
     # GH29076
@@ -15,7 +17,7 @@ def mock_entry_points(*, group):
     # Patch entry_points in the correct module
     monkeypatch.setattr("pandas.core.accessor.entry_points", mock_entry_points)
 
-    AccessorEntryPointLoader.load()
+    accessor_entry_point_loader()
 
 
 def test_load_dataframe_accessors(monkeypatch):
@@ -36,14 +38,14 @@ def test_method(self):
 
     # Mock entry_points
     def mock_entry_points(*, group):
-        if group == AccessorEntryPointLoader.ENTRY_POINT_GROUP:
+        if group == PANDAS_ENTRY_POINT_GROUP:
             return [MockEntryPoint()]
         return []
 
     # Patch entry_points in the correct module
     monkeypatch.setattr("pandas.core.accessor.entry_points", mock_entry_points)
 
-    AccessorEntryPointLoader.load()
+    accessor_entry_point_loader()
 
     # Create DataFrame and verify that the accessor was registered
     df = pd.DataFrame({"a": [1, 2, 3]})
@@ -82,15 +84,15 @@ def which(self):
             return Accessor2
 
     def mock_entry_points(*, group):
-        if group == AccessorEntryPointLoader.ENTRY_POINT_GROUP:
+        if group == PANDAS_ENTRY_POINT_GROUP:
             return [MockEntryPoint1(), MockEntryPoint2()]
         return []
 
     monkeypatch.setattr("pandas.core.accessor.entry_points", mock_entry_points)
 
     # Check that the UserWarning is raised
     with tm.assert_produces_warning(UserWarning, match="duplicate_accessor") as record:
-        AccessorEntryPointLoader.load()
+        accessor_entry_point_loader()
 
     messages = [str(w.message) for w in record]
     assert any("you have two accessors with the same name:" in msg for msg in messages)
@@ -131,15 +133,15 @@ def which(self):
             return Accessor2
 
     def mock_entry_points(*, group):
-        if group == AccessorEntryPointLoader.ENTRY_POINT_GROUP:
+        if group == PANDAS_ENTRY_POINT_GROUP:
             return [MockEntryPoint1(), MockEntryPoint2()]
         return []
 
     monkeypatch.setattr("pandas.core.accessor.entry_points", mock_entry_points)
 
     # Check that no UserWarning is raised
     with tm.assert_produces_warning(None, check_stacklevel=False):
-        AccessorEntryPointLoader.load()
+        accessor_entry_point_loader()
 
     df = pd.DataFrame({"x": [1, 2, 3]})
     assert hasattr(df, "accessor1"), "Accessor1 not registered"
@@ -193,15 +195,15 @@ def which(self):
             return Accessor3
 
     def mock_entry_points(*, group):
-        if group == AccessorEntryPointLoader.ENTRY_POINT_GROUP:
+        if group == PANDAS_ENTRY_POINT_GROUP:
             return [MockEntryPoint1(), MockEntryPoint2(), MockEntryPoint3()]
         return []
 
     monkeypatch.setattr("pandas.core.accessor.entry_points", mock_entry_points)
 
     # Capture warnings
     with tm.assert_produces_warning(UserWarning, match="duplicate_accessor") as record:
-        AccessorEntryPointLoader.load()
+        accessor_entry_point_loader()
 
     messages = [str(w.message) for w in record]