Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitdfee31f

Browse files
committed
Improve self-documentation of IterableObj and related classes
- Fill in the missing part of the explanation of why to favor iter_items over list_items in IterableObj and Iterable (#1775).- Move the explanation of how subclasses must treat arguments from the list_items methods to the iter_items methods, because the iter_items methdos are the ones that are abstract and must be overridden by a well-behaved subclass, and also because, since the iter_items methods are preferred for use, they should be the place where less duplicated shared documentation resides.- Subtantially reword the existing documentation for clarity, especially regarding the signifance of extra args and kwargs.- Put the iter_items method before (i.e. above) the list_items method (in each of the IterableObj and Iterable classes), because that method is the one that should be used more often, and because it is also now the one with the more detailed docstring.- Remove and old comment on a return type that said exactly the exact same thing as the annotation.- In Iterable, note deprecation more consistently (and thus in more places).- Rewrite the IterableClassWatcher class docstring to explain exactly what that metaclass achieves.
1 parentc3c008c commitdfee31f

File tree

1 file changed

+51
-33
lines changed

1 file changed

+51
-33
lines changed

‎git/util.py

Lines changed: 51 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1183,7 +1183,8 @@ def __delitem__(self, index: Union[SupportsIndex, int, slice, str]) -> None:
11831183

11841184

11851185
classIterableClassWatcher(type):
1186-
"""Metaclass that watches."""
1186+
"""Metaclass that issues :class:`DeprecationWarning` when :class:`git.util.Iterable`
1187+
is subclassed."""
11871188

11881189
def__init__(cls,name:str,bases:Tuple,clsdict:Dict)->None:
11891190
forbaseinbases:
@@ -1199,39 +1200,49 @@ def __init__(cls, name: str, bases: Tuple, clsdict: Dict) -> None:
11991200

12001201

12011202
classIterable(metaclass=IterableClassWatcher):
1202-
"""Defines an interface for iterable items, so there is a uniform way to retrieve
1203-
and iterate items within the git repository."""
1203+
"""Deprecated, use :class:`IterableObj` instead.
1204+
1205+
Defines an interface for iterable items, so there is a uniform way to retrieve
1206+
and iterate items within the git repository.
1207+
"""
12041208

12051209
__slots__= ()
12061210

12071211
_id_attribute_="attribute that most suitably identifies your instance"
12081212

12091213
@classmethod
1210-
deflist_items(cls,repo:"Repo",*args:Any,**kwargs:Any)->Any:
1214+
defiter_items(cls,repo:"Repo",*args:Any,**kwargs:Any)->Any:
1215+
# return typed to be compatible with subtypes e.g. Remote
1216+
"""Deprecated, use :class:`IterableObj` instead.
1217+
1218+
Find (all) items of this type.
1219+
1220+
Subclasses can specify ``args`` and ``kwargs`` differently, and may use them for
1221+
filtering. However, when the method is called with no additional positional or
1222+
keyword arguments, subclasses are obliged to to yield all items.
1223+
1224+
:return: Iterator yielding Items
12111225
"""
1212-
Deprecated, use IterableObj instead.
1226+
raiseNotImplementedError("To be implemented by Subclass")
1227+
1228+
@classmethod
1229+
deflist_items(cls,repo:"Repo",*args:Any,**kwargs:Any)->Any:
1230+
"""Deprecated, use :class:`IterableObj` instead.
1231+
1232+
Find (all) items of this type and collect them into a list.
12131233
1214-
Find all items of this type - subclasses can specify args and kwargs differently.
1215-
If no args are given, subclasses are obliged to return all items if no additional
1216-
arguments arg given.
1234+
For more information about the arguments, see :meth:`list_items`.
12171235
1218-
:note: Favor the iter_items method as it will
1236+
:note: Favor the :meth:`iter_items` method as it will avoid eagerly collecting
1237+
all items. When there are many items, that can slow performance and increase
1238+
memory usage.
12191239
12201240
:return: list(Item,...) list of item instances
12211241
"""
12221242
out_list:Any=IterableList(cls._id_attribute_)
12231243
out_list.extend(cls.iter_items(repo,*args,**kwargs))
12241244
returnout_list
12251245

1226-
@classmethod
1227-
defiter_items(cls,repo:"Repo",*args:Any,**kwargs:Any)->Any:
1228-
# return typed to be compatible with subtypes e.g. Remote
1229-
"""For more information about the arguments, see list_items.
1230-
1231-
:return: Iterator yielding Items
1232-
"""
1233-
raiseNotImplementedError("To be implemented by Subclass")
1234-
12351246

12361247
@runtime_checkable
12371248
classIterableObj(Protocol):
@@ -1246,30 +1257,37 @@ class IterableObj(Protocol):
12461257
_id_attribute_:str
12471258

12481259
@classmethod
1249-
deflist_items(cls,repo:"Repo",*args:Any,**kwargs:Any)->IterableList[T_IterableObj]:
1260+
@abstractmethod
1261+
defiter_items(cls,repo:"Repo",*args:Any,**kwargs:Any)->Iterator[T_IterableObj]:
1262+
# Return-typed to be compatible with subtypes e.g. Remote.
1263+
"""Find (all) items of this type.
1264+
1265+
Subclasses can specify ``args`` and ``kwargs`` differently, and may use them for
1266+
filtering. However, when the method is called with no additional positional or
1267+
keyword arguments, subclasses are obliged to to yield all items.
1268+
1269+
For more information about the arguments, see list_items.
1270+
1271+
:return: Iterator yielding Items
12501272
"""
1251-
Find all items of this type - subclasses can specify args and kwargs differently.
1252-
If no args are given, subclasses are obliged to return all items if no additional
1253-
arguments arg given.
1273+
raiseNotImplementedError("To be implemented by Subclass")
1274+
1275+
@classmethod
1276+
deflist_items(cls,repo:"Repo",*args:Any,**kwargs:Any)->IterableList[T_IterableObj]:
1277+
"""Find (all) items of this type and collect them into a list.
1278+
1279+
For more information about the arguments, see :meth:`list_items`.
12541280
1255-
:note: Favor the iter_items method as it will
1281+
:note: Favor the :meth:`iter_items` method as it will avoid eagerly collecting
1282+
all items. When there are many items, that can slow performance and increase
1283+
memory usage.
12561284
12571285
:return: list(Item,...) list of item instances
12581286
"""
12591287
out_list:IterableList=IterableList(cls._id_attribute_)
12601288
out_list.extend(cls.iter_items(repo,*args,**kwargs))
12611289
returnout_list
12621290

1263-
@classmethod
1264-
@abstractmethod
1265-
defiter_items(cls,repo:"Repo",*args:Any,**kwargs:Any)->Iterator[T_IterableObj]:# Iterator[T_IterableObj]:
1266-
# Return-typed to be compatible with subtypes e.g. Remote.
1267-
"""For more information about the arguments, see list_items.
1268-
1269-
:return: Iterator yielding Items
1270-
"""
1271-
raiseNotImplementedError("To be implemented by Subclass")
1272-
12731291

12741292
# } END classes
12751293

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp