datahold 4.0.0.dev0__tar.gz → 4.0.0.dev1__tar.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 (57) hide show
  1. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/PKG-INFO +1 -1
  2. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/docs/v1.1.rst +2 -2
  3. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/docs/v1.2.rst +6 -6
  4. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/docs/v2.1.rst +10 -10
  5. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/docs/v2.2.rst +9 -9
  6. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/docs/v2.3.rst +32 -32
  7. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/docs/v3.0.rst +27 -27
  8. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/pyproject.toml +2 -2
  9. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold.egg-info/PKG-INFO +1 -1
  10. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/LICENSE.txt +0 -0
  11. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/MANIFEST.in +0 -0
  12. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/README.rst +0 -0
  13. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/docs/v2.0.rst +0 -0
  14. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/setup.cfg +0 -0
  15. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/__init__.py +0 -0
  16. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/_utils/__init__.py +0 -0
  17. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/_utils/wrapping.py +0 -0
  18. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/BaseDataDict.py +0 -0
  19. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/BaseDataList.py +0 -0
  20. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/BaseDataObject.py +0 -0
  21. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/BaseDataSet.py +0 -0
  22. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/BaseHoldDict.py +0 -0
  23. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/BaseHoldList.py +0 -0
  24. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/BaseHoldObject.py +0 -0
  25. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/BaseHoldSet.py +0 -0
  26. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/DataDict.py +0 -0
  27. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/DataList.py +0 -0
  28. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/DataObject.py +0 -0
  29. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/DataSet.py +0 -0
  30. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/FrozenDataDict.py +0 -0
  31. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/FrozenDataList.py +0 -0
  32. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/FrozenDataObject.py +0 -0
  33. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/FrozenDataSet.py +0 -0
  34. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/FrozenHoldDict.py +0 -0
  35. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/FrozenHoldList.py +0 -0
  36. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/FrozenHoldObject.py +0 -0
  37. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/FrozenHoldSet.py +0 -0
  38. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/HoldDict.py +0 -0
  39. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/HoldList.py +0 -0
  40. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/HoldObject.py +0 -0
  41. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/HoldSet.py +0 -0
  42. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/core/__init__.py +0 -0
  43. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/tests/__init__.py +0 -0
  44. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/tests/test_0.py +0 -0
  45. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/tests/test_datahold_TestAbstractness.py +0 -0
  46. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/tests/test_datahold_TestCopy.py +0 -0
  47. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/tests/test_datahold_TestDataAttribute.py +0 -0
  48. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/tests/test_datahold_TestFrozenMutability.py +0 -0
  49. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/tests/test_datahold_TestInheritance.py +0 -0
  50. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/tests/test_datahold_TestMutableBehavior.py +0 -0
  51. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/tests/test_datahold_TestProtocols.py +0 -0
  52. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/tests/test_generic.py +0 -0
  53. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold/tests/test_object.py +0 -0
  54. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold.egg-info/SOURCES.txt +0 -0
  55. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold.egg-info/dependency_links.txt +0 -0
  56. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold.egg-info/requires.txt +0 -0
  57. {datahold-4.0.0.dev0 → datahold-4.0.0.dev1}/src/datahold.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: datahold
3
- Version: 4.0.0.dev0
3
+ Version: 4.0.0.dev1
4
4
  Summary: This project wraps common mutable datastructures for inheritance with modification.
5
5
  Author-email: Johannes <johannes.programming@gmail.com>
6
6
  License-Expression: MIT
@@ -27,7 +27,7 @@ Features
27
27
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
28
28
 
29
29
  .. code-block:: python
30
-
30
+
31
31
  class HoldABC(ABC):
32
32
 
33
33
  __slots__ = ("_data",)
@@ -35,7 +35,7 @@ Features
35
35
  __hash__ = unhash
36
36
 
37
37
  @abstractmethod
38
- def __init__(self: Self, *args: Any, **kwargs: Any) -> None:
38
+ def __init__(self: Self, *args: Any, **kwargs: Any) -> None:
39
39
  "This magic method initializes self."
40
40
  ...
41
41
 
@@ -27,28 +27,28 @@ Features
27
27
  ~~~~~~~~~~~~~~~~~~~~~~~~~~
28
28
 
29
29
  .. container:: versionadded
30
-
30
+
31
31
  **Added in version 1.2.**
32
32
 
33
33
  ``class datahold.DataDict``
34
34
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~
35
35
 
36
36
  .. container:: versionadded
37
-
37
+
38
38
  **Added in version 1.2.**
39
39
 
40
40
  ``class datahold.DataList``
41
41
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~
42
42
 
43
43
  .. container:: versionadded
44
-
44
+
45
45
  **Added in version 1.2.**
46
46
 
47
47
  ``class datahold.DataSet``
48
48
  ~~~~~~~~~~~~~~~~~~~~~~~~~~
49
49
 
50
50
  .. container:: versionadded
51
-
51
+
52
52
  **Added in version 1.2.**
53
53
 
54
54
  ``class datahold.HoldABC(*args: Any, **kwargs: Any)``
@@ -63,7 +63,7 @@ Features
63
63
  __hash__ = unhash
64
64
 
65
65
  @abstractmethod
66
- def __init__(self: Self, *args: Any, **kwargs: Any) -> None:
66
+ def __init__(self: Self, *args: Any, **kwargs: Any) -> None:
67
67
  "This magic method initializes self."
68
68
  ...
69
69
 
@@ -323,7 +323,7 @@ A subclass of HoldSet with common-sense implementations for further inheritance,
323
323
  This project can be tested through its test function.
324
324
 
325
325
  .. code-block:: python
326
-
326
+
327
327
  import datahold
328
328
  datahold.test()
329
329
 
@@ -45,7 +45,7 @@ This abstract property acts as the linchpin of all decending classes.
45
45
  This class is a brute wrapper for dict. It inherits from DataABC and collections.abc.MutableMapping . Its constructor passes all arguments to the constructor of dict and the result is saved within the data property.
46
46
 
47
47
  .. container:: versionchanged
48
-
48
+
49
49
  **Changed in version 2.1:** The class was made generic.
50
50
 
51
51
  ``__contains__(key: Any, /) -> Any``
@@ -210,7 +210,7 @@ This method returns an iterator over the values. Its inner workings are analogou
210
210
  This class is analogous to DataDict. It implements the magic methods __add__, __contains__, __delitem__, __eq__, __format__, __ge__, __getitem__, __gt__, __iadd__, __imul__, __iter__, __le__, __len__, __lt__, __mul__, __repr__, __reversed__, __rmul__, __setitem__, and __str__. The other methods implemented are append, clear, copy, count, extend, index, insert, pop, remove, reverse, and sort. It is a child of DataABC and of collections.abc.MutableSequence , thereby also inheriting their members.
211
211
 
212
212
  .. container:: versionchanged
213
-
213
+
214
214
  **Changed in version 2.1:** The class was made generic.
215
215
 
216
216
  ``class datahold.DataSet[Item](*args: Any, **kwargs: Any)``
@@ -219,7 +219,7 @@ This class is analogous to DataDict. It implements the magic methods __add__, __
219
219
  This class is analogous to DataDict. It implements the magic methods __and__, __contains__, __eq__, __format__, __ge__, __gt__, __iand__, __ior__, __isub__, __iter__, __le__, __len__, __lt__, __or__, __rand__, __repr__, __ror__, __rsub__, __rxor__, __str__, __sub__, __rmul__, __sub__, and __xor__. The other methods implemented are add, clear, copy, difference, difference_update, discard, intersection, intersection_update, isdisjoint, issubset, issuperset, pop, remove, symmetric_difference, symmetric_difference_update, union, and update. It is a child of DataABC and of collections.abc.MutableSet , thereby also inheriting their members.
220
220
 
221
221
  .. container:: versionchanged
222
-
222
+
223
223
  **Changed in version 2.1:** The class was made generic.
224
224
 
225
225
  ``class datahold.HoldABC(*args: Any, **kwargs: Any)``
@@ -229,7 +229,7 @@ This class is analogous to DataDict. It implements the magic methods __and__, __
229
229
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
230
230
 
231
231
  .. container:: versionchanged
232
-
232
+
233
233
  **Changed in version 2.1:** The class was made generic.
234
234
 
235
235
  ``data: frozendict``
@@ -251,7 +251,7 @@ This property is implemented with the equivalent to the following code:
251
251
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
252
252
 
253
253
  .. container:: versionchanged
254
-
254
+
255
255
  **Changed in version 2.1:** The class was made generic.
256
256
 
257
257
  ``data: tuple``
@@ -273,7 +273,7 @@ This property is implemented with the equivalent to the following code:
273
273
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
274
274
 
275
275
  .. container:: versionchanged
276
-
276
+
277
277
  **Changed in version 2.1:** The class was made generic.
278
278
 
279
279
  ``data: frozenset``
@@ -305,7 +305,7 @@ All methods that cannot actually change the underlying object are now bound to _
305
305
  * __ne__ negates __eq__.
306
306
  * __ge__ returns ``type(self)(other) <= self`` (inherited from scaevola.Scaevola).
307
307
  * __gt__ returns ``not (self == other) and (self >= other)``.
308
- * __lt__ returns ``not (self == other) and (self <= other)``.
308
+ * __lt__ returns ``not (self == other) and (self <= other)``.
309
309
  * __le__ returns ``self._data <= type(self)(other)._data``.
310
310
 
311
311
  Modify __eq__ or __le__ as needed to change the behavior of the other comparison methods.
@@ -316,7 +316,7 @@ Modify __eq__ or __le__ as needed to change the behavior of the other comparison
316
316
  A subclass of HoldDict with common-sense implementations for further inheritance, just like OkayList for HoldList.
317
317
 
318
318
  .. container:: versionchanged
319
-
319
+
320
320
  **Changed in version 2.1:** The class was made generic.
321
321
 
322
322
  ``class datahold.OkayList[Item](data: Iterable = ())``
@@ -325,7 +325,7 @@ A subclass of HoldDict with common-sense implementations for further inheritance
325
325
  This class inherits from HoldList and OkayABC.
326
326
 
327
327
  .. container:: versionchanged
328
-
328
+
329
329
  **Changed in version 2.1:** The class was made generic.
330
330
 
331
331
  ``class datahold.OkaySet[Item](data: Iterable = ())``
@@ -334,7 +334,7 @@ This class inherits from HoldList and OkayABC.
334
334
  A subclass of HoldSet with common-sense implementations for further inheritance, just like OkayList for HoldList.
335
335
 
336
336
  .. container:: versionchanged
337
-
337
+
338
338
  **Changed in version 2.1:** The class was made generic.
339
339
 
340
340
  ``datahold.test() -> unittest.TextTestResult``
@@ -45,7 +45,7 @@ This abstract property acts as the linchpin of all decending classes.
45
45
  This class is a brute wrapper for dict. It inherits from DataABC and collections.abc.MutableMapping . Its constructor passes all arguments to the constructor of dict and the result is saved within the data property.
46
46
 
47
47
  .. container:: versionchanged
48
-
48
+
49
49
  **Changed in version 2.1:** The class was made generic.
50
50
 
51
51
  ``__contains__(key: Any, /) -> Any``
@@ -210,7 +210,7 @@ This method returns an iterator over the values. Its inner workings are analogou
210
210
  This class is analogous to DataDict. It implements the magic methods __add__, __contains__, __delitem__, __eq__, __format__, __ge__, __getitem__, __gt__, __iadd__, __imul__, __iter__, __le__, __len__, __lt__, __mul__, __repr__, __reversed__, __rmul__, __setitem__, and __str__. The other methods implemented are append, clear, copy, count, extend, index, insert, pop, remove, reverse, and sort. It is a child of DataABC and of collections.abc.MutableSequence , thereby also inheriting their members.
211
211
 
212
212
  .. container:: versionchanged
213
-
213
+
214
214
  **Changed in version 2.1:** The class was made generic.
215
215
 
216
216
  ``class datahold.DataSet[Item](*args: Any, **kwargs: Any)``
@@ -219,7 +219,7 @@ This class is analogous to DataDict. It implements the magic methods __add__, __
219
219
  This class is analogous to DataDict. It implements the magic methods __and__, __contains__, __eq__, __format__, __ge__, __gt__, __iand__, __ior__, __isub__, __iter__, __le__, __len__, __lt__, __or__, __rand__, __repr__, __ror__, __rsub__, __rxor__, __str__, __sub__, __rmul__, __sub__, and __xor__. The other methods implemented are add, clear, copy, difference, difference_update, discard, intersection, intersection_update, isdisjoint, issubset, issuperset, pop, remove, symmetric_difference, symmetric_difference_update, union, and update. It is a child of DataABC and of collections.abc.MutableSet , thereby also inheriting their members.
220
220
 
221
221
  .. container:: versionchanged
222
-
222
+
223
223
  **Changed in version 2.1:** The class was made generic.
224
224
 
225
225
  ``class datahold.HoldABC(*args: Any, **kwargs: Any)``
@@ -229,7 +229,7 @@ This class is analogous to DataDict. It implements the magic methods __and__, __
229
229
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
230
230
 
231
231
  .. container:: versionchanged
232
-
232
+
233
233
  **Changed in version 2.1:** The class was made generic.
234
234
 
235
235
  ``data: frozendict``
@@ -251,7 +251,7 @@ This property is implemented with the equivalent to the following code:
251
251
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
252
252
 
253
253
  .. container:: versionchanged
254
-
254
+
255
255
  **Changed in version 2.1:** The class was made generic.
256
256
 
257
257
  ``data: tuple``
@@ -273,7 +273,7 @@ This property is implemented with the equivalent to the following code:
273
273
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
274
274
 
275
275
  .. container:: versionchanged
276
-
276
+
277
277
  **Changed in version 2.1:** The class was made generic.
278
278
 
279
279
  ``data: frozenset``
@@ -315,7 +315,7 @@ Modify __eq__ or __le__ as needed to change the behavior of the other comparison
315
315
  A subclass of HoldDict with common-sense implementations for further inheritance, just like OkayList for HoldList.
316
316
 
317
317
  .. container:: versionchanged
318
-
318
+
319
319
  **Changed in version 2.1:** The class was made generic.
320
320
 
321
321
  ``class datahold.OkayList[Item](data: Iterable = ())``
@@ -324,7 +324,7 @@ A subclass of HoldDict with common-sense implementations for further inheritance
324
324
  This class inherits from HoldList and OkayABC.
325
325
 
326
326
  .. container:: versionchanged
327
-
327
+
328
328
  **Changed in version 2.1:** The class was made generic.
329
329
 
330
330
  ``class datahold.OkaySet[Item](data: Iterable = ())``
@@ -333,7 +333,7 @@ This class inherits from HoldList and OkayABC.
333
333
  A subclass of HoldSet with common-sense implementations for further inheritance, just like OkayList for HoldList.
334
334
 
335
335
  .. container:: versionchanged
336
-
336
+
337
337
  **Changed in version 2.1:** The class was made generic.
338
338
 
339
339
  ``datahold.test() -> unittest.TextTestResult``
@@ -29,7 +29,7 @@ Features
29
29
  This abstract base class inherits from BaseDataObject . It implements all methods and classmethods of dict that cannot change the underlying instance (and that are not already present in object).
30
30
 
31
31
  .. container:: versionadded
32
-
32
+
33
33
  **Added in version 2.3.**
34
34
 
35
35
  ``__slots__ = ()``
@@ -163,7 +163,7 @@ See BaseDataDict and __format__ for more information.
163
163
  This abstract base class inherits from BaseDataObject. It works analogously to BaseDataDict . It data property is annotated as tuple[Item, ...]. It implements the methods __add__, __contains__, __eq__, __format__, __ge__, __getitem__, __gt__, __iter__, __le__, __len__, __lt__, __mul__, __repr__, __reversed__, __rmul__, __str__, count, and index accordingly. It has no classmethod to implement.
164
164
 
165
165
  .. container:: versionadded
166
-
166
+
167
167
  **Added in version 2.3.**
168
168
 
169
169
  ``class datahold.BaseDataObject(*args: Any, **kwargs: Any)``
@@ -172,7 +172,7 @@ This abstract base class inherits from BaseDataObject. It works analogously to B
172
172
  This abstract base class is the ancestor of all other classes in datahold.
173
173
 
174
174
  .. container:: versionadded
175
-
175
+
176
176
  **Added in version 2.3.**
177
177
 
178
178
  ``data: Any``
@@ -186,7 +186,7 @@ This property is abstract.
186
186
  This abstract base class inherits from BaseDataObject . It works analogously to BaseDataDict . It implements the methods __and__, __contains__, __eq__, __format__, __ge__, __gt__, __iter__, __le__, __len__, __lt__, __or__, __rand__, __repr__, __ror__, __rsub__, __rxor__, __str__, __sub__, __xor__, difference, intersection, isdisjoint, issubset, issuperset, symmetric_difference, and union accordingly. It has no classmethod to implement.
187
187
 
188
188
  .. container:: versionadded
189
-
189
+
190
190
  **Added in version 2.3.**
191
191
 
192
192
  ``class datahold.BaseHoldDict[Key, Value](*args: Any, **kwargs: Any)``
@@ -195,7 +195,7 @@ This abstract base class inherits from BaseDataObject . It works analogously to
195
195
  This abstract class inherits from BaseHoldObject and from BaseDataDict[Key, Value] .
196
196
 
197
197
  .. container:: versionadded
198
-
198
+
199
199
  **Added in version 2.3.**
200
200
 
201
201
  ``__slots__ = ()``
@@ -214,7 +214,7 @@ This abstract property is inherited from both parent classes.
214
214
  This abstract class inherits from BaseHoldObject and from BaseDataList[Item].
215
215
 
216
216
  .. container:: versionadded
217
-
217
+
218
218
  **Added in version 2.3.**
219
219
 
220
220
  ``__slots__ = ()``
@@ -233,7 +233,7 @@ This abstract property is inherited from both parent classes.
233
233
  This abstract class inherits from BaseDataObject . It sets __slots__ to ("_data",).
234
234
 
235
235
  .. container:: versionadded
236
-
236
+
237
237
  **Added in version 2.3.**
238
238
 
239
239
  ``class datahold.BaseHoldSet[Item](*args: Any, **kwargs: Any)``
@@ -242,7 +242,7 @@ This abstract class inherits from BaseDataObject . It sets __slots__ to ("_data"
242
242
  This abstract class inherits from BaseHoldObject and from BaseDataSet[Item].
243
243
 
244
244
  .. container:: versionadded
245
-
245
+
246
246
  **Added in version 2.3.**
247
247
 
248
248
  ``__slots__ = ()``
@@ -259,7 +259,7 @@ This abstract property is inherited from both parent classes.
259
259
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
260
260
 
261
261
  .. container:: versionchanged
262
-
262
+
263
263
  **Changed in version 2.3:** The class was renamed to DataObject. DataABC was changed into an alias for DataObject for legacy.
264
264
 
265
265
  ``class datahold.DataDict[Key, Value](*args: Any, **kwargs: Any)``
@@ -283,21 +283,21 @@ Docsting and signature are somewhat imprecise because they mimic the original me
283
283
  return dict[Key, Value].fromkeys(*args, **kwargs)
284
284
 
285
285
  .. container:: versionchanged
286
-
286
+
287
287
  **Changed in version 2.1:** The class was made generic.
288
288
 
289
289
  ``class datahold.DataList[Item](*args: Any, **kwargs: Any)``
290
290
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
291
291
 
292
292
  .. container:: versionchanged
293
-
293
+
294
294
  **Changed in version 2.1:** The class was made generic.
295
295
 
296
296
  ``class datahold.DataObject(*args: Any, **kwargs: Any)``
297
297
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
298
298
 
299
299
  .. container:: versionadded
300
-
300
+
301
301
  **Added in version 2.3.**
302
302
 
303
303
  ``copy() -> Self``
@@ -309,133 +309,133 @@ This method returns ``type(self)(self.data)``.
309
309
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
310
310
 
311
311
  .. container:: versionchanged
312
-
312
+
313
313
  **Changed in version 2.1:** The class was made generic.
314
314
 
315
315
  ``class datahold.FrozenDataDict[Key, Value](*args: Any, **kwargs: Any)``
316
316
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
317
317
 
318
318
  .. container:: versionadded
319
-
319
+
320
320
  **Added in version 2.3.**
321
321
 
322
322
  ``class datahold.FrozenDataList[Item](*args: Any, **kwargs: Any)``
323
323
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
324
324
 
325
325
  .. container:: versionadded
326
-
326
+
327
327
  **Added in version 2.3.**
328
328
 
329
329
  ``class datahold.FrozenDataObject(*args: Any, **kwargs: Any)``
330
330
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
331
331
 
332
332
  .. container:: versionadded
333
-
333
+
334
334
  **Added in version 2.3.**
335
335
 
336
336
  ``class datahold.FrozenDataSet[Item](*args: Any, **kwargs: Any)``
337
337
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
338
338
 
339
339
  .. container:: versionadded
340
-
340
+
341
341
  **Added in version 2.3.**
342
342
 
343
343
  ``class datahold.FrozenHoldDict[Key, Value](*args: Any, **kwargs: Any)``
344
344
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
345
345
 
346
346
  .. container:: versionadded
347
-
347
+
348
348
  **Added in version 2.3.**
349
349
 
350
350
  ``class datahold.FrozenHoldList[Item](*args: Any, **kwargs: Any)``
351
351
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
352
352
 
353
353
  .. container:: versionadded
354
-
354
+
355
355
  **Added in version 2.3.**
356
356
 
357
357
  ``class datahold.FrozenHoldObject(*args: Any, **kwargs: Any)``
358
358
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
359
359
 
360
360
  .. container:: versionadded
361
-
361
+
362
362
  **Added in version 2.3.**
363
363
 
364
364
  ``class datahold.FrozenHoldSet[Item](*args: Any, **kwargs: Any)``
365
365
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
366
366
 
367
367
  .. container:: versionadded
368
-
368
+
369
369
  **Added in version 2.3.**
370
370
 
371
371
  ``datahold.HoldABC = datahold.HoldObject``
372
372
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
373
373
 
374
374
  .. container:: versionchanged
375
-
375
+
376
376
  **Changed in version 2.3:** The class was renamed to HoldObject. HoldABC was changed into an alias for HoldObject for legacy.
377
377
 
378
378
  ``class datahold.HoldDict[Key, Value](*args: Any, **kwargs: Any)``
379
379
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
380
380
 
381
381
  .. container:: versionchanged
382
-
382
+
383
383
  **Changed in version 2.1:** The class was made generic.
384
384
 
385
385
  ``class datahold.HoldList[Item](*args: Any, **kwargs: Any)``
386
386
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
387
387
 
388
388
  .. container:: versionchanged
389
-
389
+
390
390
  **Changed in version 2.1:** The class was made generic.
391
391
 
392
392
  ``class datahold.HoldObject(*args: Any, **kwargs: Any)``
393
393
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
394
394
 
395
395
  .. container:: versionadded
396
-
396
+
397
397
  **Added in version 2.3.**
398
398
 
399
399
  ``class datahold.HoldSet[Item](*args: Any, **kwargs: Any)``
400
400
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
401
401
 
402
402
  .. container:: versionchanged
403
-
403
+
404
404
  **Changed in version 2.1:** The class was made generic.
405
405
 
406
406
  ``datahold.OkayABC = datahold.OkayObject``
407
407
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
408
408
 
409
409
  .. container:: versionchanged
410
-
410
+
411
411
  **Changed in version 2.3:** The class was renamed to OkayObject. OkayABC was changed into an alias for OkayObject for legacy.
412
412
 
413
413
  ``class datahold.OkayDict[Key, Value](data: Iterable = (), /, **kwargs: Any)``
414
414
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
415
415
 
416
416
  .. container:: versionchanged
417
-
417
+
418
418
  **Changed in version 2.1:** The class was made generic.
419
419
 
420
420
  ``class datahold.OkayList[Item](data: Iterable = ())``
421
421
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
422
422
 
423
423
  .. container:: versionchanged
424
-
424
+
425
425
  **Changed in version 2.1:** The class was made generic.
426
426
 
427
427
  ``class datahold.OkayObject(*args: Any, **kwargs: Any)``
428
428
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
429
429
 
430
430
  .. container:: versionadded
431
-
431
+
432
432
  **Added in version 2.3.**
433
433
 
434
434
  ``class datahold.OkaySet[Item](data: Iterable = ())``
435
435
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
436
436
 
437
437
  .. container:: versionchanged
438
-
438
+
439
439
  **Changed in version 2.1:** The class was made generic.
440
440
 
441
441
  ``datahold.test() -> unittest.TextTestResult``
@@ -444,7 +444,7 @@ This method returns ``type(self)(self.data)``.
444
444
  This project can be tested through its test function.
445
445
 
446
446
  .. code-block:: python
447
-
447
+
448
448
  import datahold
449
449
  datahold.test()
450
450
 
@@ -18,8 +18,8 @@ Features
18
18
  ``class datahold.BaseDataDict[Key, Value](*args: Any, **kwargs: Any)``
19
19
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20
20
 
21
- This abstract base class inherits from ``BaseDataObject``.
22
- It implements all methods and classmethods of ``dict`` that cannot change the underlying instance
21
+ This abstract base class inherits from ``BaseDataObject``.
22
+ It implements all methods and classmethods of ``dict`` that cannot change the underlying instance
23
23
  (and that are not already present in ``object``).
24
24
 
25
25
  ``__slots__ = ()``
@@ -31,11 +31,11 @@ It implements all methods and classmethods of ``dict`` that cannot change the un
31
31
  This magic method implements ``key in self``. It works as follows:
32
32
 
33
33
  .. code-block:: python
34
-
34
+
35
35
  def __contains__(self: Self, key: Any, /) -> Any:
36
36
  "True if the dictionary has the specified key, else False."
37
37
  return dict[Key, Value](self.data).__contains__(key)
38
-
38
+
39
39
  Docsting and signature are somewhat imprecise because they mimic the original method of ``dict``.
40
40
 
41
41
  ``__ge__(value: Any, /) -> Any``
@@ -101,8 +101,8 @@ This abstract property is inherited from ``BaseDataObject`` and reannotated.
101
101
  ``fromkeys(iterable: Any, value: Any = None, /) -> Any``
102
102
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
103
103
 
104
- ``fromkeys`` is the only ``classmethod`` of ``dict``
105
- and therefore also of ``BaseDataDict``.
104
+ ``fromkeys`` is the only ``classmethod`` of ``dict``
105
+ and therefore also of ``BaseDataDict``.
106
106
  It works as follows:
107
107
 
108
108
  .. code-block:: python
@@ -137,10 +137,10 @@ See ``BaseDataDict`` and ``__contains__`` for more information.
137
137
  ``class datahold.BaseDataList[Item](data: Iterable, /)``
138
138
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
139
139
 
140
- This abstract base class inherits from ``BaseDataObject``.
141
- It works analogously to ``BaseDataDict``.
142
- It data property is annotated as ``tuple[Item, ...]``.
143
- It implements the methods ``__add__``, ``__contains__``, ``__ge__``, ``__getitem__``, ``__gt__``, ``__iter__``, ``__le__``, ``__len__``, ``__lt__``, ``__mul__``, ``__repr__``, ``__reversed__``, ``__rmul__``, ``count``, and ``index`` accordingly.
140
+ This abstract base class inherits from ``BaseDataObject``.
141
+ It works analogously to ``BaseDataDict``.
142
+ It data property is annotated as ``tuple[Item, ...]``.
143
+ It implements the methods ``__add__``, ``__contains__``, ``__ge__``, ``__getitem__``, ``__gt__``, ``__iter__``, ``__le__``, ``__len__``, ``__lt__``, ``__mul__``, ``__repr__``, ``__reversed__``, ``__rmul__``, ``count``, and ``index`` accordingly.
144
144
  It has no classmethod to implement.
145
145
 
146
146
  ``__slots__ = ()``
@@ -158,7 +158,7 @@ This abstract base class is the ancestor of all other classes in datahold.
158
158
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
159
159
 
160
160
  This magic method implements ``self == other``.
161
- Here, it establishes a standard for all its descendents.
161
+ Here, it establishes a standard for all its descendents.
162
162
  It should only ever be overwritten with an extensional equivalent.
163
163
 
164
164
  .. code-block:: python
@@ -178,9 +178,9 @@ This property is abstract.
178
178
  ``class datahold.BaseDataSet[Item](*args: Any, **kwargs: Any)``
179
179
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
180
180
 
181
- This abstract base class inherits from ``BaseDataObject``.
182
- It works analogously to ``BaseDataDict``.
183
- It implements the methods ``__and__``, ``__contains__``, ``__ge__``, ``__gt__``, ``__iter__``, ``__le__``, ``__len__``, ``__lt__``, ``__or__``, ``__rand__``, ``__repr__``, ``__ror__``, ``__rsub__``, ``__rxor__``, ``__sub__``, ``__xor__``, ``difference``, ``intersection``, ``isdisjoint``, ``issubset``, ``issuperset``, ``symmetric_difference``, and ``union`` accordingly.
181
+ This abstract base class inherits from ``BaseDataObject``.
182
+ It works analogously to ``BaseDataDict``.
183
+ It implements the methods ``__and__``, ``__contains__``, ``__ge__``, ``__gt__``, ``__iter__``, ``__le__``, ``__len__``, ``__lt__``, ``__or__``, ``__rand__``, ``__repr__``, ``__ror__``, ``__rsub__``, ``__rxor__``, ``__sub__``, ``__xor__``, ``difference``, ``intersection``, ``isdisjoint``, ``issubset``, ``issuperset``, ``symmetric_difference``, and ``union`` accordingly.
184
184
  It has no classmethod to implement.
185
185
 
186
186
  ``__slots__ = ()``
@@ -242,28 +242,28 @@ This abstract property is inherited from both parent classes.
242
242
  ``class datahold.DataDict[Key, Value](*args: Any, **kwargs: Any)``
243
243
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
244
244
 
245
- This abstract base class inherits
246
- from DataObject, ``BaseDataDict[Key, Value]``, and ``collections.abc.MutableMapping[Key, Value]``.
247
- It implements all methods and classmethods of ``dict``
248
- that can change the underlying instance
249
- (and that are not already present in ``object``).
245
+ This abstract base class inherits
246
+ from DataObject, ``BaseDataDict[Key, Value]``, and ``collections.abc.MutableMapping[Key, Value]``.
247
+ It implements all methods and classmethods of ``dict``
248
+ that can change the underlying instance
249
+ (and that are not already present in ``object``).
250
250
  The implementation of ``__contains__`` works like this:
251
251
 
252
252
  .. code-block:: python
253
-
253
+
254
254
  def __contains__(self: Self, key: Any, /) -> Any:
255
255
  "True if the dictionary has the specified key, else False."
256
256
  return dict[Key, Value](self.data).__contains__(key)
257
257
 
258
- Docsting and signature are somewhat imprecise because they mimic the original method of ``dict``.
259
- The other methods -
260
- ``__contains__``, ``__ge__``, ``__getitem__``, ``__gt__``, ``__iter__``, ``__le__``, ``__len__``, ``__lt__``,
261
- ``__or__``, ``__repr__``, ``__reversed__``, ``__ror__``,
262
- ``get``, ``items``, ``keys``, and ``values`` - work analogously.
258
+ Docsting and signature are somewhat imprecise because they mimic the original method of ``dict``.
259
+ The other methods -
260
+ ``__contains__``, ``__ge__``, ``__getitem__``, ``__gt__``, ``__iter__``, ``__le__``, ``__len__``, ``__lt__``,
261
+ ``__or__``, ``__repr__``, ``__reversed__``, ``__ror__``,
262
+ ``get``, ``items``, ``keys``, and ``values`` - work analogously.
263
263
  ``fromkeys`` - the only ``classmethod`` - works as follows:
264
264
 
265
265
  .. code-block:: python
266
-
266
+
267
267
  @classmethod
268
268
  def fromkeys(cls: type, iterable: Any, value: Any = None, /) -> Any:
269
269
  "Create a new dictionary with keys from iterable and values set to value."
@@ -389,7 +389,7 @@ The slot layout of the class is dictated by ``BaseHoldObject``.
389
389
  This project can be tested through its ``test`` function.
390
390
 
391
391
  .. code-block:: python
392
-
392
+
393
393
  import datahold.tests
394
394
  datahold.tests.test()
395
395
 
@@ -33,10 +33,10 @@ license-files = [
33
33
  name = "datahold"
34
34
  readme = "README.rst"
35
35
  requires-python = ">=3.11"
36
- version = "4.0.0.dev0"
36
+ version = "4.0.0.dev1"
37
37
 
38
38
  [project.urls]
39
39
  Download = "https://pypi.org/project/datahold/#files"
40
40
  Index = "https://pypi.org/project/datahold/"
41
41
  Source = "https://github.com/johannes-programming/datahold/"
42
- Website = "http://datahold.johannes-programming.online/"
42
+ Website = "http://datahold.johannes-programming.online/"
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: datahold
3
- Version: 4.0.0.dev0
3
+ Version: 4.0.0.dev1
4
4
  Summary: This project wraps common mutable datastructures for inheritance with modification.
5
5
  Author-email: Johannes <johannes.programming@gmail.com>
6
6
  License-Expression: MIT
File without changes
File without changes
File without changes
File without changes