Update homepage for v0.10.0 [skip ci] (#189)

Author: tfpf

docs/changelog.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [0.10.0](https://github.com/tfpf/pysorteddict/compare/v0.9.0...v0.10.0)
+
+<ul class="change-new">
+  <li><a href="https://github.com/tfpf/pysorteddict/pull/184">#184</a> Define <code>SortedDictValues</code> as a view
+  over the values of a sorted dictionary. Define <code>SortedDictValues.__repr__</code>,
+  <code>SortedDictValues.__len__</code>, <code>SortedDictValues.__getitem__</code> and
+  <code>SortedDictValues.__iter__</code>. Define <code>SortedDictValuesIter</code> as an iterator over the values of a
+  sorted dictionary. Define <code>SortedDictValuesIter.__iter__</code> and <code>SortedDictValuesIter.__next__</code>.
+  Update <code>SortedDict.values</code> to return the aforementioned view.</li>
+  <li><a href="https://github.com/tfpf/pysorteddict/pull/187">#187</a> Define <code>SortedDictItems</code> as a view
+  over the items of a sorted dictionary. Define <code>SortedDictItems.__repr__</code>,
+  <code>SortedDictItems.__len__</code>, <code>SortedDictItems.__getitem__</code> and
+  <code>SortedDictItems.__iter__</code>. Define <code>SortedDictItemsIter</code> as an iterator over the items of a
+  sorted dictionary. Define <code>SortedDictItemsIter.__iter__</code> and <code>SortedDictItemsIter.__next__</code>.
+  Update <code>SortedDict.items</code> to return the aforementioned view.</li>
+</ul>
+
 ## [0.9.0](https://github.com/tfpf/pysorteddict/compare/v0.8.2...v0.9.0)
 
 <ul class="change-new">

docs/documentation.md

@@ -4,6 +4,7 @@
 
 <summary>Documentation of older versions is available on GitHub.</summary>
 
+▸ [0.9.0](https://github.com/tfpf/pysorteddict/blob/v0.9.0/docs/documentation.md)  
 ▸ [0.8.2](https://github.com/tfpf/pysorteddict/blob/v0.8.2/docs/documentation.md)
 ▸ [0.8.1](https://github.com/tfpf/pysorteddict/blob/v0.8.1/docs/documentation.md)
 ▸ [0.8.0](https://github.com/tfpf/pysorteddict/blob/v0.8.0/docs/documentation.md)  
@@ -527,10 +528,29 @@ Uncommenting the commented line runs any required destructors and makes this err
 
 Return a shallow copy of the sorted dictionary `d`.
 
-#### `d.items() -> list[tuple[object, object]]`
+#### `d.items() -> SortedDictItems`
 
-Return the key-value pairs in the sorted dictionary `d`. The list will be sorted. It will exist independently of `d`;
-it won't be a view on its items.
+Return a dynamic view on the items in the sorted dictionary `d`.
+
+```python
+from pysorteddict import *
+d = SortedDict()
+items = d.items()
+d["foo"] = ()
+print(items)
+d["bar"] = [100]
+print(items)
+d["baz"] = 3.14
+print(items)
+```
+
+```text
+SortedDictItems([('foo', ())])
+SortedDictItems([('bar', [100]), ('foo', ())])
+SortedDictItems([('bar', [100]), ('baz', 3.14), ('foo', ())])
+```
+
+See [sorted dictionary views](#sorted-dictionary-views).
 
 #### `d.keys() -> SortedDictKeys`
 
@@ -554,21 +574,42 @@ SortedDictKeys(['bar', 'foo'])
 SortedDictKeys(['bar', 'baz', 'foo'])
 ```
 
-See the documentation of [sorted dictionary views](#sorted-dictionary-views).
+See [sorted dictionary views](#sorted-dictionary-views).
+
+#### `d.values() -> SortedDictValues`
 
-#### `d.values() -> list[object]`
+Return a dynamic view on the values in the sorted dictionary `d`.
 
-Return the values in the sorted dictionary `d`. The list will be sorted by the keys the values are mapped to. It will
-exist independently of `d`; it won't be a view on its values.
+```python
+from pysorteddict import *
+d = SortedDict()
+values = d.values()
+d["foo"] = ()
+print(values)
+d["bar"] = [100]
+print(values)
+d["baz"] = 3.14
+print(values)
+```
+
+```text
+SortedDictValues([()])
+SortedDictValues([[100], ()])
+SortedDictValues([[100], 3.14, ()])
+```
+
+See [sorted dictionary views](#sorted-dictionary-views).
 
 ## Sorted Dictionary Views
 
 Sorted dictionary views are dynamic views on a sorted dictionary: they are immutable and cannot be used to mutate the
 sorted dictionary, but always reflect its current state.
 
-As of the current version, there is only one view type.
+There are three view types:
 
-* `SortedDictKeys`: the return type of `SortedDict.keys`.
+* `SortedDictItems`, the return type of [`SortedDict.items`](#ditems---sorteddictitems);
+* `SortedDictKeys`, the return type of [`SortedDict.keys`](#dkeys---sorteddictkeys); and
+* `SortedDictValues`, the return type of [`SortedDict.values`](#dvalues---sorteddictvalues).
 
 ### Magic Methods
 
@@ -601,26 +642,28 @@ like when slicing a `list`.
 ```python
 from pysorteddict import *
 d = SortedDict()
-keys = d.keys()
+items, keys, values = d.items(), d.keys(), d.values()
 d["foo"] = ()
 d["bar"] = [100]
 d["baz"] = 3.14
 d["spam"] = {}
 d["eggs"] = ""
-print(keys[0], keys[2], keys[4])
+print(d)
+print(keys[0], keys[2], values[4])
 print(keys[:3])
-print(keys[1:])
-print(keys[-3:3])
-print(keys[-5:4:2])
+print(items[1:])
+print(values[-3:3])
+print(items[-5:4:2])
 print(keys[::-1])
 ```
 
 ```text
-bar eggs spam
+SortedDict({'bar': [100], 'baz': 3.14, 'eggs': '', 'foo': (), 'spam': {}})
+bar eggs {}
 ['bar', 'baz', 'eggs']
-['baz', 'eggs', 'foo', 'spam']
-['eggs']
-['bar', 'eggs']
+[('baz', 3.14), ('eggs', ''), ('foo', ()), ('spam', {})]
+['']
+[('bar', [100]), ('eggs', '')]
 ['spam', 'foo', 'eggs', 'baz', 'bar']
 ```
 

docs/source_code.md

@@ -16,13 +16,24 @@ Implementation of the Python `SortedDict` type.
 
 ### `sorted_dict_view_type.cc`
 
-Implementation of views over `SortedDict` objects—superclasses of `SortedDictKeys` and `SortedDictKeysIter`.
+Implementation of views over `SortedDict` objects—superclasses of `SortedDictItems`, `SortedDictItemsIter`,
+`SortedDictKeys`,  `SortedDictKeysIter`, `SortedDictValues` and `SortedDictValuesIter`.
+
+### `sorted_dict_items_type.cc`
+
+Implementation of the Python `SortedDictItems` and `SortedDictItemsIter` types. Exposed to users only indirectly via
+`SortedDict.items`.
 
 ### `sorted_dict_keys_type.cc`
 
 Implementation of the Python `SortedDictKeys` and `SortedDictKeysIter` types. Exposed to users only indirectly via
 `SortedDict.keys`.
 
+### `sorted_dict_values_type.cc`
+
+Implementation of the Python `SortedDictValues` and `SortedDictValuesIter` types. Exposed to users only indirectly via
+`SortedDict.values`.
+
 ### `sorted_dict_module.cc`
 
 Implementation of the Python `pysorteddict` module. Glue between Python methods and C++ methods.

pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pysorteddict"
-version = "0.9.0"
+version = "0.10.0"
 authors = [
     {name = "Vishal Pankaj Chandratreya"},
 ]

src/pysorteddict/sorted_dict_module.cc

@@ -547,7 +547,9 @@ static PyTypeObject sorted_dict_type = {
     .tp_hash = PyObject_HashNotImplemented,
     .tp_getattro = PyObject_GenericGetAttr,
     .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_DICT_SUBCLASS,
-    .tp_doc = "Sorted dictionary: a dictionary in which the keys are always in ascending order.",
+    .tp_doc = "Sorted dictionary: a dictionary in which the keys are always in ascending order.\n\n"
+              "SortedDict(*args, **kwargs) -> SortedDict\n"
+              "Create an empty sorted dictionary. ``args`` and ``kwargs`` are ignored.",
     .tp_iter = sorted_dict_type_iter,
     .tp_methods = sorted_dict_type_methods,
     .tp_getset = sorted_dict_type_getset,
@@ -560,7 +562,7 @@ static PyTypeObject sorted_dict_type = {
 static PyModuleDef sorted_dict_module = {
     .m_base = PyModuleDef_HEAD_INIT,
     .m_name = "pysorteddict",
-    .m_doc = "Enriches Python with a sorted dictionary.\n\nSee https://tfpf.github.io/pysorteddict/.",
+    .m_doc = "enriches Python with a sorted dictionary\n\nSee https://tfpf.github.io/pysorteddict/.",
     .m_size = -1,
 };