istr-python 1.0.4__tar.gz → 1.0.6__tar.gz

{istr_python-1.0.4/istr_python.egg-info → istr_python-1.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: istr-python
-Version: 1.0.4
+Version: 1.0.6
 Summary: istr - strings you can count on
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/istr
@@ -399,6 +399,58 @@ istr('0') a
 istr('1') b
 istr('2') c
 ```
+#### itertools with istrs
+All methods in itertools are also available directly from istr.
+Note that the result is istr-ed (apart from groupby and tee).
+
+The following class methods are supported (provided their counterpart exists in the installed Python version's itertools):
+
+- istr.accumulate
+- istr.chain
+- istr.combinations
+- istr.combinations_with_replacement
+- istr.compress
+- istr.count
+- istr.cycle
+- istr.dropwhile
+- istr.filterfalse
+- istr.groupby (not istr-ed)
+- istr.islice
+- istr.pairwise
+- istr.permutations
+- istr.product
+- istr.repeat
+- istr.starmap
+- istr.takewhile
+- istr.tee (not istr-ed)
+- istr.zip_longest
+
+This can be handy as these methods don't have to be imported from itertools anymore.
+
+All methods have exactly the same (optional) parameters as their itertools counterpart.
+
+For example:
+
+```
+list(istr.repeat(1, 4)) ==> [istr('1'), istr('1'), istr('1'), istr('1')]
+next(istr.count(3)) ==> istr('3')
+```
+
+One more example:
+
+```
+for t in istr.permutations(range(3)):
+    print(t)
+```
+results in
+```
+(istr('0'), istr('1'), istr('2'))
+(istr('0'), istr('2'), istr('1'))
+(istr('1'), istr('0'), istr('2'))
+(istr('1'), istr('2'), istr('0'))
+(istr('2'), istr('0'), istr('1'))
+(istr('2'), istr('1'), istr('0'))
+```
 
 #### concatenate an iterable
 
@@ -638,22 +690,23 @@ _                    x         istr(20) - 3 ==> istr('17')
 %                    x         istr(20) % 3 ==> istr('2')
 divmod               x         divmod(istr(20), 3) ==> (istr('6'), istr('2'))
 **                   x         istr(2) ** 3 ==> istr('8')
-@                         x    istr(20) @ 3 ==> istr('202020')
-==                   x    x    istr(20) == 20 ==> True | istr(20) == '20' ==> True
-|                         x    istr(20) | 5 ==> istr('205')
+<=, <, >, >=         x         istr('100') > istr('2') ==> True
 abs                  x         abs(istr(-20)) ==> istr('20')
+==                   x    x    istr(20) == 20 ==> True | istr(20) == '20' ==> True
 bool                 x    x *) bool(istr(' 0 ')) ==> False | istr('') ==> False
-<=, <, >, >=         x         istr('100') > istr('2') ==> True
+@                         x    istr(20) @ 3 ==> istr('202020')
+|                         x    istr(20) | '5' ==> istr('205')
 slicing                   x    istr(12345)[1:3] ==> istr('23')
-iterate                   x    [x for x in istr(20)] ==> [istr('2'), istr('0')
+iterate                   x    [x for x in istr(20)] ==> [istr('2'), istr('0')]
 len                       x    len(istr(' 20 ')) ==> 4
-count                     x    istr(100),count('0') ==> 2
+count                     x    istr(100).count('0') ==> 2
 index                     x    istr(' 100 ').index('0') ==> 2
 split                     x    istr('1 2').split() ==> (istr('1'), istr('2'))
-string format             x    f"|{istr((1234):6}|" ==> '|1234  |'
+string format             x    f"|{istr(1234):6}|" ==> '|1234  |'
 other string methods      x    istr('aAbBcC').lower() ==> istr('aabbcc')
                                istr('aAbBcC').islower() ==> False
                                istr('  abc   ').strip() ==> istr('abc')
+                               ...
 -----------------------------------------------------------------------------------------
 *) str is applied if is_int() is False