PyPI - istr-python - Versions diffs - 1.1.44__tar.gz → 1.2.0__tar.gz - Mend

istr-python 1.1.44tar.gz → 1.2.0tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

{istr_python-1.1.44 → istr_python-1.2.0}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: istr-python
-Version: 1.1.44
+Version: 1.2.0
 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
@@ -339,17 +339,16 @@ several other types:
     istr({0, 1, 4}) ==> {istr('4'), istr('0'), istr('1')}  # or similar
   ```
-- if a range, an istr.range instance will be returned
+- if a range, a generator that yields istr-s will be returned
 ```
-  istr(range(3)) ==> istr.range(3)
-  list(istr(range(3))) ==> [istr('0'), istr('1'), istr('2')]
-  len(istr(range(3))) ==> 3
+  list(istr(range(3))) ==> [istr('0', istr('1', istr('2')]
 ```
-- if an istr.range instance, the same istr.range will be returned
+- if an istr.range instance, the generator will be propagated
 ```
-  istr(istr.range(5)) ==> istr.range(5)
+  list(istr(istr.range(3))) ==> [istr('0', istr('1', istr('2')]
 ```
@@ -370,14 +369,29 @@ a, b, c = istr(*range(3)) ==> a=istr('0') , b=istr('1'), c=istr('2')
   ```
 #### Alternative way of range specification
-Instead of `istr(range(..))` it is possible to use `istr,range(..)` instead, like
+Instead of `istr(range(..))` it is possible to use `istr.range(..)` instead, like
 `list(istr.range(3,6))` ==> `[istr('3'), istr('4'), istr('5')]`
-In contrast to the builtin `range`, `istr.range` supports a non keyword parameter `length`:
+In contrast to the builtin `range`, `istr.range` supports a keyword parameter `length`:
 `list(istr.range(length=3))` is equivalent to `istr.range(100, 1000)`
+On top of this, `istr.range` support a keyword parameter `distinct`, to return a generator that yields only numbers with distinct numbers:
+`list(istr.range(98,104,distinct=True))` is `[istr('98'), istr('102'), istr('103')]`
+For `istr.range(length=..., distict=True)` the generation is optimized (not just checking each possible value).
+It is also possible to specify an exclude parameter, with which any generated value will be discarded if it contains a character in exclude. E.g:
+```
+for i in istr.range(length=5, distinct=True):
+    if ...:
+        for j in istr.range(length=2, distinct=True, exclude=i):
+            ...
+```
 #### square root, cubic root and nth root
 The methods `sqrt`, `cbrt`, `nth_root`provide the square root, cubic root and nth root of an istr. If there is no integer root, the fallback value (default `istr('0')` will be returned.
 ```
@@ -547,15 +561,15 @@ istr.divisors(18, False) ==> [istr('1'), istr('18'), istr('2'), istr('9'), istr(
 #### test whether all characters are distinct
-With the `all_distinct` method, it is possible to test whether all characters are distinct (i.e. no character appears more than once).
+With the `is_distinct` method, it is possible to test whether all characters are distinct (i.e. no character appears more than once).
 ```
-istr('01234').all_distict() ==> True
-istr('012340').all_distict() ==> False
+istr('01234').is_distict() ==> True
+istr('012340').is_distict() ==> False
 n98 = istr(98)
 n100 = n98 + 2
-istr(n98).all_distinct() ==> True
-istr(n100).all_distinct() ==> False
+istr(n98).is_distinct() ==> True
+istr(n100).is_distinct() ==> False
 ```
 #### test if characters are consecutive
@@ -824,8 +838,17 @@ Alternatively, it is possible to get a list of all squares, cubes, power_ofs or
 `istr.squares (length=2)` returns a list of all squares of length 2, so between 10 and 99.
+If the keyword `distinct` is True, all values that are not distinct, will be excluded, like:
+`list(istr.primes(list(istr.primes(100,132,distinct=True))` is `[istr('103'), istr('107'), istr('109'), istr('127')]`, thus leaving out 101, 113 and 131
 Unless `cache=False` is specified, the query result is cached.
+#### filter distinct_only
+With `istr.distinct_only` any iterable can skip values that are not distinct:
+`list(istr.distinct_only([10, 11, 100, 123, 'abc', 'aaa']))` is `[istr('10'), istr('123'), istr('abc')]`
 #### Safe indexing (getitem)
 The `istr.getitem` method is essentially, a safe version of indexing an istr.
@@ -1127,11 +1150,8 @@ This will print
 ?
 ```
-##### Note
 >
-> The way an `istr` is represented is determined at initialization.
-It is also possible to set the repr mode without a context manager:
+> It is also possible to set the repr mode without a context manager:
 ```
 istr.repr_mode('str')
@@ -1148,48 +1168,6 @@ print(repr(istr.repr_mode()))
 ```
 will output `istr`.
-#### Changing the base system
-By default, `istr` works in base 10. However it is possible to change the base system with the `istr.base()` context manager / method.
-Any base between 2 and 36 may be used.
-Note that the integer is **always** stored in base 10 mode, but the string
-representation will reflect the chosen base (at time of initialization).
-Some examples:
-```
-with istr.base(16):
-    a = istr('7fff')
-    print(int(a))
-    b = istr(127)
-    print(repr(b))
-```
-This will result in
-```
-32767
-istr('7F')
-```
-All calculations are done in the decimal 10 base system.
-Note that the way an `istr` is interpreted is determined at initialization.
-It is also possible to set the repr mode without a context manager:
-```
-istr.base(16)
-print(int(istr('7fff')))
-```
-This will print
-```
-32767
-```
-Finally, the current base can be queried with `istr.base()`, so upon start:
-```
-print(istr.base())
-```
-will result in `10`.
 #### Changing the format of the string
 When an  istr is initialized with a string the istr will be always stored as such.
@@ -1240,9 +1218,8 @@ istr('123')
 istr('1234')
 ```
-##### Note
->
-> For bases other than 10, the string will never be reformatted!
 ### Overview of operations
@@ -1254,32 +1231,31 @@ operator/function   int  str   Example
 +                    x         istr(20) + 3 ==> istr('23')
 _                    x         istr(20) - 3 ==> istr('17')
 *                    x         istr(20) * 3 ==> istr('60')
-                     /                    x         istr(20) / 3 ==> istr('6')
-                     //                   x         istr(20) // 3 ==> istr('6')
-                     %                    x         istr(20) % 3 ==> istr('2')
-                     divmod               x         divmod(istr(20), 3) ==> (istr('6'), istr('2'))
-                     **                   x         istr(2) ** 3 ==> istr('8')
-                     <=, <, >, >=         x         istr('100') > istr('2') ==> True
-                     abs                  x         abs(istr(-20)) ==> istr('20')
-                     int                  x         int(istr("20")) ==> 20
-                     float                x         float(istr("20")) ==> 20.0
-                     complex              x         complex(istr("20")) ==> (20+0j)
-                     ==                   x    x    istr(20) == 20 ==> True | istr(20) == '20' ==> True
-                     bool                 x    x *) bool(istr(' 0 ')) ==> False | bool(istr('')) ==> False
-                     @                         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')]
-                     len                       x    len(istr(' 20 ')) ==> 4
-                     count                     x    istr(100).count(0) ==> 2
-                               istr.count(100) ==> istr('100'), istr('101'). istr('102'), ...
-                     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  |'
-                     other string methods      x    istr('aAbBcC').lower() ==> istr('aabbcc')
+/                    x         istr(20) / 3 ==> istr('6')
+//                   x         istr(20) // 3 ==> istr('6')
+%                    x         istr(20) % 3 ==> istr('2')
+divmod               x         divmod(istr(20), 3) ==> (istr('6'), istr('2'))
+**                   x         istr(2) ** 3 ==> istr('8')
+<=, <, >, >=         x         istr('100') > istr('2') ==> True
+abs                  x         abs(istr(-20)) ==> istr('20')
+int                  x         int(istr("20")) ==> 20
+float                x         float(istr("20")) ==> 20.0
+complex              x         complex(istr("20")) ==> (20+0j)
+==                   x    x    istr(20) == 20 ==> True | istr(20) == '20' ==> True
+bool                 x    x *) bool(istr(' 0 ')) ==> False | bool(istr('')) ==> False
+@                         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')]
+len                       x    len(istr(' 20 ')) ==> 4
+count                     x    istr(100).count(0) ==> 2
+                               istr.count(100) ==> istr('100'), istr('101'). ...
+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  |'
+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
 ```

{istr_python-1.1.44 → istr_python-1.2.0}/README.md RENAMED Viewed

@@ -326,17 +326,16 @@ several other types:
     istr({0, 1, 4}) ==> {istr('4'), istr('0'), istr('1')}  # or similar
   ```
-- if a range, an istr.range instance will be returned
+- if a range, a generator that yields istr-s will be returned
 ```
-  istr(range(3)) ==> istr.range(3)
-  list(istr(range(3))) ==> [istr('0'), istr('1'), istr('2')]
-  len(istr(range(3))) ==> 3
+  list(istr(range(3))) ==> [istr('0', istr('1', istr('2')]
 ```
-- if an istr.range instance, the same istr.range will be returned
+- if an istr.range instance, the generator will be propagated
 ```
-  istr(istr.range(5)) ==> istr.range(5)
+  list(istr(istr.range(3))) ==> [istr('0', istr('1', istr('2')]
 ```
@@ -357,14 +356,29 @@ a, b, c = istr(*range(3)) ==> a=istr('0') , b=istr('1'), c=istr('2')
   ```
 #### Alternative way of range specification
-Instead of `istr(range(..))` it is possible to use `istr,range(..)` instead, like
+Instead of `istr(range(..))` it is possible to use `istr.range(..)` instead, like
 `list(istr.range(3,6))` ==> `[istr('3'), istr('4'), istr('5')]`
-In contrast to the builtin `range`, `istr.range` supports a non keyword parameter `length`:
+In contrast to the builtin `range`, `istr.range` supports a keyword parameter `length`:
 `list(istr.range(length=3))` is equivalent to `istr.range(100, 1000)`
+On top of this, `istr.range` support a keyword parameter `distinct`, to return a generator that yields only numbers with distinct numbers:
+`list(istr.range(98,104,distinct=True))` is `[istr('98'), istr('102'), istr('103')]`
+For `istr.range(length=..., distict=True)` the generation is optimized (not just checking each possible value).
+It is also possible to specify an exclude parameter, with which any generated value will be discarded if it contains a character in exclude. E.g:
+```
+for i in istr.range(length=5, distinct=True):
+    if ...:
+        for j in istr.range(length=2, distinct=True, exclude=i):
+            ...
+```
 #### square root, cubic root and nth root
 The methods `sqrt`, `cbrt`, `nth_root`provide the square root, cubic root and nth root of an istr. If there is no integer root, the fallback value (default `istr('0')` will be returned.
 ```
@@ -534,15 +548,15 @@ istr.divisors(18, False) ==> [istr('1'), istr('18'), istr('2'), istr('9'), istr(
 #### test whether all characters are distinct
-With the `all_distinct` method, it is possible to test whether all characters are distinct (i.e. no character appears more than once).
+With the `is_distinct` method, it is possible to test whether all characters are distinct (i.e. no character appears more than once).
 ```
-istr('01234').all_distict() ==> True
-istr('012340').all_distict() ==> False
+istr('01234').is_distict() ==> True
+istr('012340').is_distict() ==> False
 n98 = istr(98)
 n100 = n98 + 2
-istr(n98).all_distinct() ==> True
-istr(n100).all_distinct() ==> False
+istr(n98).is_distinct() ==> True
+istr(n100).is_distinct() ==> False
 ```
 #### test if characters are consecutive
@@ -811,8 +825,17 @@ Alternatively, it is possible to get a list of all squares, cubes, power_ofs or
 `istr.squares (length=2)` returns a list of all squares of length 2, so between 10 and 99.
+If the keyword `distinct` is True, all values that are not distinct, will be excluded, like:
+`list(istr.primes(list(istr.primes(100,132,distinct=True))` is `[istr('103'), istr('107'), istr('109'), istr('127')]`, thus leaving out 101, 113 and 131
 Unless `cache=False` is specified, the query result is cached.
+#### filter distinct_only
+With `istr.distinct_only` any iterable can skip values that are not distinct:
+`list(istr.distinct_only([10, 11, 100, 123, 'abc', 'aaa']))` is `[istr('10'), istr('123'), istr('abc')]`
 #### Safe indexing (getitem)
 The `istr.getitem` method is essentially, a safe version of indexing an istr.
@@ -1114,11 +1137,8 @@ This will print
 ?
 ```
-##### Note
 >
-> The way an `istr` is represented is determined at initialization.
-It is also possible to set the repr mode without a context manager:
+> It is also possible to set the repr mode without a context manager:
 ```
 istr.repr_mode('str')
@@ -1135,48 +1155,6 @@ print(repr(istr.repr_mode()))
 ```
 will output `istr`.
-#### Changing the base system
-By default, `istr` works in base 10. However it is possible to change the base system with the `istr.base()` context manager / method.
-Any base between 2 and 36 may be used.
-Note that the integer is **always** stored in base 10 mode, but the string
-representation will reflect the chosen base (at time of initialization).
-Some examples:
-```
-with istr.base(16):
-    a = istr('7fff')
-    print(int(a))
-    b = istr(127)
-    print(repr(b))
-```
-This will result in
-```
-32767
-istr('7F')
-```
-All calculations are done in the decimal 10 base system.
-Note that the way an `istr` is interpreted is determined at initialization.
-It is also possible to set the repr mode without a context manager:
-```
-istr.base(16)
-print(int(istr('7fff')))
-```
-This will print
-```
-32767
-```
-Finally, the current base can be queried with `istr.base()`, so upon start:
-```
-print(istr.base())
-```
-will result in `10`.
 #### Changing the format of the string
 When an  istr is initialized with a string the istr will be always stored as such.
@@ -1227,9 +1205,8 @@ istr('123')
 istr('1234')
 ```
-##### Note
->
-> For bases other than 10, the string will never be reformatted!
 ### Overview of operations
@@ -1241,32 +1218,31 @@ operator/function   int  str   Example
 +                    x         istr(20) + 3 ==> istr('23')
 _                    x         istr(20) - 3 ==> istr('17')
 *                    x         istr(20) * 3 ==> istr('60')
-                     /                    x         istr(20) / 3 ==> istr('6')
-                     //                   x         istr(20) // 3 ==> istr('6')
-                     %                    x         istr(20) % 3 ==> istr('2')
-                     divmod               x         divmod(istr(20), 3) ==> (istr('6'), istr('2'))
-                     **                   x         istr(2) ** 3 ==> istr('8')
-                     <=, <, >, >=         x         istr('100') > istr('2') ==> True
-                     abs                  x         abs(istr(-20)) ==> istr('20')
-                     int                  x         int(istr("20")) ==> 20
-                     float                x         float(istr("20")) ==> 20.0
-                     complex              x         complex(istr("20")) ==> (20+0j)
-                     ==                   x    x    istr(20) == 20 ==> True | istr(20) == '20' ==> True
-                     bool                 x    x *) bool(istr(' 0 ')) ==> False | bool(istr('')) ==> False
-                     @                         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')]
-                     len                       x    len(istr(' 20 ')) ==> 4
-                     count                     x    istr(100).count(0) ==> 2
-                               istr.count(100) ==> istr('100'), istr('101'). istr('102'), ...
-                     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  |'
-                     other string methods      x    istr('aAbBcC').lower() ==> istr('aabbcc')
+/                    x         istr(20) / 3 ==> istr('6')
+//                   x         istr(20) // 3 ==> istr('6')
+%                    x         istr(20) % 3 ==> istr('2')
+divmod               x         divmod(istr(20), 3) ==> (istr('6'), istr('2'))
+**                   x         istr(2) ** 3 ==> istr('8')
+<=, <, >, >=         x         istr('100') > istr('2') ==> True
+abs                  x         abs(istr(-20)) ==> istr('20')
+int                  x         int(istr("20")) ==> 20
+float                x         float(istr("20")) ==> 20.0
+complex              x         complex(istr("20")) ==> (20+0j)
+==                   x    x    istr(20) == 20 ==> True | istr(20) == '20' ==> True
+bool                 x    x *) bool(istr(' 0 ')) ==> False | bool(istr('')) ==> False
+@                         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')]
+len                       x    len(istr(' 20 ')) ==> 4
+count                     x    istr(100).count(0) ==> 2
+                               istr.count(100) ==> istr('100'), istr('101'). ...
+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  |'
+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
 ```

istr-python 1.1.44__tar.gz → 1.2.0__tar.gz

istr-python 1.1.44tar.gz → 1.2.0tar.gz