Skip to content

Commit c586d00

Browse files
committed
Update pydoc
1 parent dcc4fae commit c586d00

2 files changed

Lines changed: 97 additions & 17 deletions

File tree

doc/QueryableList.Base.html

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@
6464
&nbsp;<br>
6565
&nbsp;&nbsp;Returns&nbsp;a&nbsp;copy</tt></dd></dl>
6666

67+
<dl><dt><a name="QueryableListBase-__copy__"><strong>__copy__</strong></a>(self)</dt><dd><tt>__copy__&nbsp;-&nbsp;Make&nbsp;a&nbsp;copy&nbsp;of&nbsp;this&nbsp;collection</tt></dd></dl>
68+
6769
<dl><dt><a name="QueryableListBase-__getslice__"><strong>__getslice__</strong></a>(self, start, end)</dt><dd><tt>__getslice__&nbsp;-&nbsp;Return&nbsp;a&nbsp;"slice"&nbsp;(subset)&nbsp;of&nbsp;the&nbsp;current&nbsp;collection.<br>
6870
&nbsp;<br>
6971
Returns&nbsp;a&nbsp;copy</tt></dd></dl>
@@ -99,7 +101,7 @@
99101
&nbsp;<br>
100102
&nbsp;&nbsp;Returns&nbsp;a&nbsp;copy</tt></dd></dl>
101103

102-
<dl><dt><a name="QueryableListBase-all"><strong>all</strong></a>(self)</dt><dd><tt>all&nbsp;-&nbsp;Returns&nbsp;all&nbsp;items&nbsp;in&nbsp;this&nbsp;collection,&nbsp;as&nbsp;the&nbsp;collection&nbsp;type&nbsp;(aka&nbsp;returns&nbsp;"self").<br>
104+
<dl><dt><a name="QueryableListBase-all"><strong>all</strong></a>(self)</dt><dd><tt>all&nbsp;-&nbsp;Returns&nbsp;all&nbsp;items&nbsp;in&nbsp;this&nbsp;collection,&nbsp;as&nbsp;the&nbsp;collection&nbsp;type&nbsp;(aka&nbsp;returns&nbsp;a&nbsp;copy&nbsp;of&nbsp;"self").<br>
103105
&nbsp;<br>
104106
&nbsp;&nbsp;This&nbsp;method&nbsp;is&nbsp;provided&nbsp;for&nbsp;method&nbsp;parity&nbsp;with&nbsp;ORMs&nbsp;that&nbsp;build&nbsp;a&nbsp;filter&nbsp;set&nbsp;with&nbsp;filter&nbsp;calls,<br>
105107
&nbsp;&nbsp;&nbsp;&nbsp;and&nbsp;then&nbsp;execute&nbsp;with&nbsp;".all"&nbsp;(like&nbsp;django&nbsp;or&nbsp;IndexedRedis).<br>
@@ -109,6 +111,12 @@
109111
&nbsp;<br>
110112
@return&nbsp;&lt;self.<strong>__class__</strong>&gt;&nbsp;-&nbsp;self</tt></dd></dl>
111113

114+
<dl><dt><a name="QueryableListBase-count"><strong>count</strong></a>(self)</dt><dd><tt>count&nbsp;-&nbsp;Returns&nbsp;the&nbsp;number&nbsp;of&nbsp;items&nbsp;in&nbsp;this&nbsp;collection.<br>
115+
&nbsp;<br>
116+
&nbsp;&nbsp;&nbsp;&nbsp;This&nbsp;is&nbsp;the&nbsp;same&nbsp;as&nbsp;len(...),&nbsp;but&nbsp;is&nbsp;added&nbsp;to&nbsp;be&nbsp;compatible&nbsp;with&nbsp;many&nbsp;server-side&nbsp;ORMs&nbsp;which&nbsp;implement&nbsp;"count"&nbsp;as&nbsp;a&nbsp;function.<br>
117+
&nbsp;<br>
118+
&nbsp;&nbsp;@return&nbsp;&lt;int&gt;&nbsp;-&nbsp;Number&nbsp;of&nbsp;items&nbsp;in&nbsp;this&nbsp;collection</tt></dd></dl>
119+
112120
<dl><dt><a name="QueryableListBase-customFilter"><strong>customFilter</strong></a>(self, filterFunc)</dt><dd><tt>customFilter&nbsp;-&nbsp;Apply&nbsp;a&nbsp;custom&nbsp;filter&nbsp;to&nbsp;elements&nbsp;and&nbsp;return&nbsp;a&nbsp;QueryableList&nbsp;of&nbsp;matches<br>
113121
&nbsp;<br>
114122
@param&nbsp;filterFunc&nbsp;&lt;lambda/function&lt;&nbsp;-&nbsp;A&nbsp;lambda/function&nbsp;that&nbsp;is&nbsp;passed&nbsp;an&nbsp;item,&nbsp;and<br>
@@ -134,6 +142,16 @@
134142
&nbsp;<br>
135143
@return&nbsp;-&nbsp;A&nbsp;QueryableList&nbsp;object&nbsp;of&nbsp;the&nbsp;same&nbsp;type,&nbsp;with&nbsp;only&nbsp;the&nbsp;matching&nbsp;objects&nbsp;returned.</tt></dd></dl>
136144

145+
<dl><dt><a name="QueryableListBase-sort_by"><strong>sort_by</strong></a>(self, fieldName, reverse=False)</dt><dd><tt>sort_by&nbsp;-&nbsp;Return&nbsp;a&nbsp;copy&nbsp;of&nbsp;this&nbsp;collection,&nbsp;sorted&nbsp;by&nbsp;the&nbsp;given&nbsp;fieldName.<br>
146+
&nbsp;<br>
147+
&nbsp;&nbsp;The&nbsp;fieldName&nbsp;is&nbsp;accessed&nbsp;the&nbsp;same&nbsp;way&nbsp;as&nbsp;other&nbsp;filtering,&nbsp;so&nbsp;it&nbsp;supports&nbsp;custom&nbsp;properties,&nbsp;etc.<br>
148+
&nbsp;<br>
149+
&nbsp;&nbsp;@param&nbsp;fieldName&nbsp;&lt;str&gt;&nbsp;-&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;field&nbsp;on&nbsp;which&nbsp;to&nbsp;sort&nbsp;by<br>
150+
&nbsp;<br>
151+
&nbsp;&nbsp;@param&nbsp;reverse&nbsp;&lt;bool&gt;&nbsp;Default&nbsp;False&nbsp;-&nbsp;If&nbsp;True,&nbsp;<a href="builtins.html#list">list</a>&nbsp;will&nbsp;be&nbsp;in&nbsp;reverse&nbsp;order.<br>
152+
&nbsp;<br>
153+
&nbsp;&nbsp;@return&nbsp;&lt;QueryableList&gt;&nbsp;-&nbsp;A&nbsp;QueryableList&nbsp;of&nbsp;the&nbsp;same&nbsp;type&nbsp;with&nbsp;the&nbsp;elements&nbsp;sorted&nbsp;based&nbsp;on&nbsp;arguments.</tt></dd></dl>
154+
137155
<hr>
138156
Data descriptors defined here:<br>
139157
<dl><dt><strong>__dict__</strong></dt>
@@ -190,8 +208,6 @@
190208

191209
<dl><dt><a name="QueryableListBase-copy"><strong>copy</strong></a>(...)</dt><dd><tt>L.<a href="#QueryableListBase-copy">copy</a>()&nbsp;-&gt;&nbsp;<a href="builtins.html#list">list</a>&nbsp;--&nbsp;a&nbsp;shallow&nbsp;copy&nbsp;of&nbsp;L</tt></dd></dl>
192210

193-
<dl><dt><a name="QueryableListBase-count"><strong>count</strong></a>(...)</dt><dd><tt>L.<a href="#QueryableListBase-count">count</a>(value)&nbsp;-&gt;&nbsp;integer&nbsp;--&nbsp;return&nbsp;number&nbsp;of&nbsp;occurrences&nbsp;of&nbsp;value</tt></dd></dl>
194-
195211
<dl><dt><a name="QueryableListBase-extend"><strong>extend</strong></a>(...)</dt><dd><tt>L.<a href="#QueryableListBase-extend">extend</a>(iterable)&nbsp;-&gt;&nbsp;None&nbsp;--&nbsp;extend&nbsp;<a href="builtins.html#list">list</a>&nbsp;by&nbsp;appending&nbsp;elements&nbsp;from&nbsp;the&nbsp;iterable</tt></dd></dl>
196212

197213
<dl><dt><a name="QueryableListBase-index"><strong>index</strong></a>(...)</dt><dd><tt>L.<a href="#QueryableListBase-index">index</a>(value,&nbsp;[start,&nbsp;[stop]])&nbsp;-&gt;&nbsp;integer&nbsp;--&nbsp;return&nbsp;first&nbsp;index&nbsp;of&nbsp;value.<br>

0 commit comments

Comments
 (0)