Added doc at extending.rst

- Improved accessor.py docstr

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

Author: PedroM4rques

doc/source/development/extending.rst

@@ -69,6 +69,62 @@ For a ``Series`` accessor, you should validate the ``dtype`` if the accessor
 applies only to certain dtypes.
 
 
+Registering accessors via entry points
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can create a custom accessor for a pandas object and expose it via Python's
+entry point system. Once installed using pip, the accessor can be automatically
+discovered and registered by pandas at runtime, without requiring manual import.
+
+To register the entry point for your accessor, follow the format shown below:
+
+.. code-block:: python
+
+    # setup.py
+    entry_points={
+        'pandas.DataFrame.accessor': [ '<name> = <module>:<AccessorClass>', ... ],
+        'pandas.Series.accessor':    [ '<name> = <module>:<AccessorClass>', ... ],
+        'pandas.Index.accessor':     [ '<name> = <module>:<AccessorClass>', ... ],
+    }
+
+Alternatively, if you are using a ``pyproject.toml``-based build:
+
+.. code-block:: toml
+
+    # pyproject.toml
+    [project.entry-points."pandas.DataFrame.accessor"]
+    <name> = "<module>:<AccessorClass>"
+
+    [project.entry-points."pandas.Series.accessor"]
+    <name> = "<module>:<AccessorClass>"
+
+    [project.entry-points."pandas.Index.accessor"]
+    <name> = "<module>:<AccessorClass>"
+
+
+Assuming the accessor class ``GeoAccessor`` is defined in the module
+``geoPlugin.geo_accessor``, and using the accessor name ``geo`` as in the
+example above:
+
+.. code-block:: python
+
+    # setup.py
+    entry_points={
+        'pandas.DataFrame.accessor': [ 'geo = geoPlugin.geo_accessor:GeoAccessor' ],
+    }
+
+Or, for a ``pyproject.toml``-based build:
+
+.. code-block:: toml
+
+    # pyproject.toml
+    [project.entry-points."pandas.DataFrame.accessor"]
+    geo = "geoPlugin.geo_accessor:GeoAccessor"
+
+
+For background on Python's Entry Point system and Plugins:
+https://packaging.python.org/en/latest/guides/creating-and-discovering-plugins/#plugin-entry-points
+
 .. _extending.extension-types:
 
 Extension types

pandas/core/accessor.py

@@ -405,8 +405,10 @@ def accessor_entry_point_loader() -> None:
     Load and register pandas accessors declared via entry points.
 
     This function scans the 'pandas.<pd_obj>.accessor' entry point group for
-    accessors registered by third-party packages. Each entry point is expected
-    to follow the format:
+    accessors registered by third-party packages. These accessors extend
+    core pandas objects (`DataFrame`, `Series`, `Index`).
+
+    Each entry point is expected to follow the format:
 
         # setup.py
         entry_points={
@@ -415,7 +417,7 @@ def accessor_entry_point_loader() -> None:
             'pandas.Index.accessor':     [ <name> = <module>:<AccessorClass>, ... ],
         }
 
-    OR for pyproject.toml file:
+    OR using pyproject.toml file:
 
         # pyproject.toml
         [project.entry-points."pandas.DataFrame.accessor"]
@@ -427,9 +429,6 @@ def accessor_entry_point_loader() -> None:
         [project.entry-points."pandas.Index.accessor"]
         <name> = "<module>:<AccessorClass>"
 
-    For more information about entrypoints:
-    https://packaging.python.org/en/latest/guides/creating-and-discovering-plugins/#plugin-entry-points
-
 
     For each valid entry point:
     - The accessor class is dynamically imported and registered using
@@ -441,7 +440,16 @@ def accessor_entry_point_loader() -> None:
     Notes
     -----
     - This function is only intended to be called at pandas startup.
-    - For more information about accessors read their documentation.
+    - For more information about accessors, refer to:
+        - Pandas documentation on extending accessors:
+          https://pandas.pydata.org/docs/development/extending.html#registering-custom-accessors
+        - Series accessor API reference:
+          https://pandas.pydata.org/docs/reference/series.html#accessors
+        - Note: DataFrame and Index accessors (e.g., `.sparse`, `.str`) use the same
+          mechanism but are not listed in separate reference pages as of now.
+
+    - For background on Python plugin entry points:
+    https://packaging.python.org/en/latest/guides/creating-and-discovering-plugins/#plugin-entry-points
 
     Raises
     ------