Skip to content

Commit 01a1bfc

Browse files
committed
Improve var and class names
1 parent 2793f91 commit 01a1bfc

File tree

3 files changed

+27
-27
lines changed

3 files changed

+27
-27
lines changed

pandas/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@
347347
"wide_to_long",
348348
]
349349

350-
from pandas.core.accessor import DataFrameAccessorLoader
350+
from .core.accessor import AccessorEntryPointLoader
351351

352-
DataFrameAccessorLoader.load()
353-
del DataFrameAccessorLoader
352+
AccessorEntryPointLoader.load()
353+
del AccessorEntryPointLoader

pandas/core/accessor.py

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -398,31 +398,31 @@ def register_index_accessor(name: str) -> Callable[[TypeT], TypeT]:
398398
return _register_accessor(name, Index)
399399

400400

401-
class DataFrameAccessorLoader:
402-
"""Loader class for registering DataFrame accessors via entry points."""
401+
class AccessorEntryPointLoader: # is this a good name for the class?
402+
"""Loader class for registering accessors via entry points."""
403403

404-
ENTRY_POINT_GROUP: str = "pandas_dataframe_accessor"
404+
ENTRY_POINT_GROUP: str = "pandas_accessor"
405405

406406
@classmethod
407407
def load(cls) -> None:
408-
"""loads and registers accessors defined by 'pandas_dataframe_accessor'."""
409-
eps = entry_points(group=cls.ENTRY_POINT_GROUP)
410-
names: set[str] = set()
408+
"""loads and registers accessors defined by 'pandas_accessor'."""
409+
packages = entry_points(group=cls.ENTRY_POINT_GROUP)
410+
unique_packages_names: set[str] = set()
411411

412-
for ep in eps:
413-
name: str = ep.name
414-
415-
if name in names: # Verifies duplicated package names
412+
for package in packages:
413+
# Verifies duplicated package names
414+
if package.name in unique_packages_names:
416415
warnings.warn(
417-
f"Warning: you have two packages with the same name: '{name}'. "
416+
"Warning: you have two packages with the same name:"
417+
f" '{package.name}'\n"
418418
"Uninstall the package you don't want to use "
419419
"in order to remove this warning.\n",
420420
UserWarning,
421421
stacklevel=2,
422422
)
423423

424424
else:
425-
names.add(name)
425+
unique_packages_names.add(package.name)
426426

427427
def make_property(ep):
428428
def accessor(self) -> Any:
@@ -431,4 +431,4 @@ def accessor(self) -> Any:
431431

432432
return accessor
433433

434-
register_dataframe_accessor(name)(make_property(ep))
434+
register_dataframe_accessor(package.name)(make_property(package))

pandas/tests/test_plugis_entrypoint_loader.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import pandas as pd
22
import pandas._testing as tm
3-
from pandas.core.accessor import DataFrameAccessorLoader
3+
from pandas.core.accessor import AccessorEntryPointLoader
44

55

66
def test_no_accessors(monkeypatch):
@@ -13,7 +13,7 @@ def mock_entry_points(*, group):
1313
# Patch entry_points in the correct module
1414
monkeypatch.setattr("pandas.core.accessor.entry_points", mock_entry_points)
1515

16-
DataFrameAccessorLoader.load()
16+
AccessorEntryPointLoader.load()
1717

1818

1919
def test_load_dataframe_accessors(monkeypatch):
@@ -34,14 +34,14 @@ def test_method(self):
3434

3535
# Mock entry_points
3636
def mock_entry_points(*, group):
37-
if group == DataFrameAccessorLoader.ENTRY_POINT_GROUP:
37+
if group == AccessorEntryPointLoader.ENTRY_POINT_GROUP:
3838
return [MockEntryPoint()]
3939
return []
4040

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

44-
DataFrameAccessorLoader.load()
44+
AccessorEntryPointLoader.load()
4545

4646
# Create DataFrame and verify that the accessor was registered
4747
df = pd.DataFrame({"a": [1, 2, 3]})
@@ -80,18 +80,18 @@ def which(self):
8080
return Accessor2
8181

8282
def mock_entry_points(*, group):
83-
if group == DataFrameAccessorLoader.ENTRY_POINT_GROUP:
83+
if group == AccessorEntryPointLoader.ENTRY_POINT_GROUP:
8484
return [MockEntryPoint1(), MockEntryPoint2()]
8585
return []
8686

8787
monkeypatch.setattr("pandas.core.accessor.entry_points", mock_entry_points)
8888

8989
# Check that the UserWarning is raised
9090
with tm.assert_produces_warning(UserWarning, match="duplicate_accessor") as record:
91-
DataFrameAccessorLoader.load()
91+
AccessorEntryPointLoader.load()
9292

9393
messages = [str(w.message) for w in record]
94-
assert any("two packages with the same name" in msg for msg in messages)
94+
assert any("you have two packages with the same name:" in msg for msg in messages)
9595

9696
df = pd.DataFrame({"x": [1, 2, 3]})
9797
assert hasattr(df, "duplicate_accessor")
@@ -129,15 +129,15 @@ def which(self):
129129
return Accessor2
130130

131131
def mock_entry_points(*, group):
132-
if group == DataFrameAccessorLoader.ENTRY_POINT_GROUP:
132+
if group == AccessorEntryPointLoader.ENTRY_POINT_GROUP:
133133
return [MockEntryPoint1(), MockEntryPoint2()]
134134
return []
135135

136136
monkeypatch.setattr("pandas.core.accessor.entry_points", mock_entry_points)
137137

138138
# Check that no UserWarning is raised
139139
with tm.assert_produces_warning(None, check_stacklevel=False):
140-
DataFrameAccessorLoader.load()
140+
AccessorEntryPointLoader.load()
141141

142142
df = pd.DataFrame({"x": [1, 2, 3]})
143143
assert hasattr(df, "accessor1"), "Accessor1 not registered"
@@ -191,15 +191,15 @@ def which(self):
191191
return Accessor3
192192

193193
def mock_entry_points(*, group):
194-
if group == DataFrameAccessorLoader.ENTRY_POINT_GROUP:
194+
if group == AccessorEntryPointLoader.ENTRY_POINT_GROUP:
195195
return [MockEntryPoint1(), MockEntryPoint2(), MockEntryPoint3()]
196196
return []
197197

198198
monkeypatch.setattr("pandas.core.accessor.entry_points", mock_entry_points)
199199

200200
# Capture warnings
201201
with tm.assert_produces_warning(UserWarning, match="duplicate_accessor") as record:
202-
DataFrameAccessorLoader.load()
202+
AccessorEntryPointLoader.load()
203203

204204
messages = [str(w.message) for w in record]
205205

0 commit comments

Comments
 (0)