py-doubly-linked-list 0.1.1__tar.gz

py_doubly_linked_list-0.1.1/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2025 Joshua A. Morningstar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

py_doubly_linked_list-0.1.1/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: py-doubly-linked-list
+Version: 0.1.1
+Summary: A library adding doubly linked lists to python.
+Author-email: Joshua Morningstar <joshuam18745@gmail.com>
+Maintainer-email: Joshua Morningstar <joshuam18745@gmail.com>
+License-Expression: MIT
+Project-URL: Documentation, https://github.com/JoshuaM176/PyDoublyLinkedList/blob/main/README.MD
+Project-URL: Repository, https://github.com/JoshuaM176/PyDoublyLinkedList
+Project-URL: Issues, https://github.com/JoshuaM176/PyDoublyLinkedList/issues
+Project-URL: Changelog, https://github.com/JoshuaM176/PyDoublyLinkedList/blob/main/CHANGES
+Keywords: doubly linked list,data structure
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: README.MD
+Dynamic: license-file
+
+# py-doubly-linked-list
+## Description
+This library provides an implementation of a doubly linked list for python written with the c api. It is meant to be as close as possible to a regular list in its interface, meaning you can interact with it in almost all of the same ways you interact with a regular python list.
+## Methods
+- append  
+Append object to the end of the list. Set forward to false to append to the start.  
+```Python
+doubly_linked_list.append(object: Any, forward: bool = True)
+```
+- clear  
+Remove all items from the list.  
+```Python
+doubly_linked_list.clear()
+```
+- copy  
+Return a shallow copy of the list.  
+```Python
+doubly_linked_list.copy()
+```
+- count  
+Return number of occurrences of value in the list.  
+```Python
+doubly_linked_list.count(value: Any)
+```
+- extend  
+Extend list by appending elements from the iterable. Set forward to false to extend from the start.  
+```Python
+doubly_linked_list.extend(iterable: Iterable, forward: bool = True)
+```
+- index  
+Return first index of value. Raises ValueError if the value is not present.  
+```Python
+doubly_linked_list.index(value: Any, start: int, stop: int)
+```
+- insert  
+Insert object after index. Set forward to false to insert before index.  
+```Python
+doubly_linked_list.insert(object: Any, index: int, forward: bool = True)
+```
+- pop  
+Remove and return item at index (default last). Raises IndexError if list is empty or index is out of range.  
+```Python
+doubly_linked_list.pop(index: int = -1)
+```
+- remove  
+Remove first occurence of value. Raises ValueError if the value is not present.  
+```Python
+doubly_linked_list.remove(value: Any)
+```
+- reverse  
+Reverse the order of the list.  
+```Python
+doubly_linked_list.reverse()
+```
+- sort  
+In-place sort in ascending order, equal objects are not swapped. Key can be applied to values and the list will be sorted based on the result of applying the key. Reverse will reverse the sort order.
+```Python
+doubly_linked_list.sort(key: Callable = None, reverse: bool = False)
+```
+The DoublyLinkedList also supports:
+- concatenation with other iterables
+- in-place concatenation with other iterables
+- indexing and assignment by index
+- slicing
+- iterating  
+
+Things that are not currently supported but might be in the future:
+- assigning slices
+- repeating, i.e list = [1] * 5 create a list with 1 repeated 5 times
+
+# License
+Copyright (c) 2025 Joshua A. Morningstar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

py_doubly_linked_list-0.1.1/README.MD

@@ -0,0 +1,78 @@
+# py-doubly-linked-list
+## Description
+This library provides an implementation of a doubly linked list for python written with the c api. It is meant to be as close as possible to a regular list in its interface, meaning you can interact with it in almost all of the same ways you interact with a regular python list.
+## Methods
+- append  
+Append object to the end of the list. Set forward to false to append to the start.  
+```Python
+doubly_linked_list.append(object: Any, forward: bool = True)
+```
+- clear  
+Remove all items from the list.  
+```Python
+doubly_linked_list.clear()
+```
+- copy  
+Return a shallow copy of the list.  
+```Python
+doubly_linked_list.copy()
+```
+- count  
+Return number of occurrences of value in the list.  
+```Python
+doubly_linked_list.count(value: Any)
+```
+- extend  
+Extend list by appending elements from the iterable. Set forward to false to extend from the start.  
+```Python
+doubly_linked_list.extend(iterable: Iterable, forward: bool = True)
+```
+- index  
+Return first index of value. Raises ValueError if the value is not present.  
+```Python
+doubly_linked_list.index(value: Any, start: int, stop: int)
+```
+- insert  
+Insert object after index. Set forward to false to insert before index.  
+```Python
+doubly_linked_list.insert(object: Any, index: int, forward: bool = True)
+```
+- pop  
+Remove and return item at index (default last). Raises IndexError if list is empty or index is out of range.  
+```Python
+doubly_linked_list.pop(index: int = -1)
+```
+- remove  
+Remove first occurence of value. Raises ValueError if the value is not present.  
+```Python
+doubly_linked_list.remove(value: Any)
+```
+- reverse  
+Reverse the order of the list.  
+```Python
+doubly_linked_list.reverse()
+```
+- sort  
+In-place sort in ascending order, equal objects are not swapped. Key can be applied to values and the list will be sorted based on the result of applying the key. Reverse will reverse the sort order.
+```Python
+doubly_linked_list.sort(key: Callable = None, reverse: bool = False)
+```
+The DoublyLinkedList also supports:
+- concatenation with other iterables
+- in-place concatenation with other iterables
+- indexing and assignment by index
+- slicing
+- iterating  
+
+Things that are not currently supported but might be in the future:
+- assigning slices
+- repeating, i.e list = [1] * 5 create a list with 1 repeated 5 times
+
+# License
+Copyright (c) 2025 Joshua A. Morningstar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

py_doubly_linked_list-0.1.1/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["setuptools>=61.0.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "py-doubly-linked-list"
+version = "0.1.1"
+description = "A library adding doubly linked lists to python."
+readme = "README.MD"
+requires-python = ">=3.9"
+authors = [ {name = "Joshua Morningstar", email = "joshuam18745@gmail.com"} ]
+maintainers = [ {name = "Joshua Morningstar", email = "joshuam18745@gmail.com"} ]
+license = "MIT"
+license-files = [
+    "LICENSE",
+    "README.MD"
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+
+  "Intended Audience :: Developers",
+
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+]
+keywords = ["doubly linked list", "data structure"]
+
+
+[project.urls]
+Documentation = "https://github.com/JoshuaM176/PyDoublyLinkedList/blob/main/README.MD"
+Repository = "https://github.com/JoshuaM176/PyDoublyLinkedList"
+Issues = "https://github.com/JoshuaM176/PyDoublyLinkedList/issues"
+Changelog = "https://github.com/JoshuaM176/PyDoublyLinkedList/blob/main/CHANGES"
+
+
+
+[[tool.setuptools.ext-modules]]
+name = "py_doubly_linked_list.doubly_linked_list"
+sources = ["src/doubly_linked_list.c"]

py_doubly_linked_list-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

py_doubly_linked_list-0.1.1/src/doubly_linked_list.c

@@ -0,0 +1,778 @@
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+#include <structmember.h>
+#include <string.h>
+#include <stddef.h>
+#include <math.h>
+#if PY_MINOR_VERSION < 10
+    #define Py_IsNone(x) Py_Is((x), Py_None) // Define these so that we can use them on older versions
+    #define Py_Is(x,y) ((x) == (y))
+    static inline PyObject* Py_NewRef(PyObject *obj) {
+        Py_INCREF(obj);
+        return obj;
+    }
+#endif
+// - - - - - DoublyLinkedListNode - - - - - //
+
+typedef struct {
+	PyObject_HEAD
+	PyObject* value;
+    PyObject* next;
+    PyObject* prev;
+	PyObject* key;
+} DLLNode;
+
+static PyTypeObject DLLNodeType;
+
+// Initalization and Deallocation
+
+static void
+DLLNode_dealloc(PyObject *op)
+{
+    DLLNode* self = (DLLNode* )op;
+    Py_XDECREF(self->next);
+    Py_XDECREF(self->value);
+    Py_TYPE(self)->tp_free(self);
+}
+
+static PyObject *
+DLLNode_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
+{
+    DLLNode *self;
+    self = (DLLNode *) type->tp_alloc(type, 0);
+    if (self != NULL) {
+        self->value = Py_NewRef(Py_None);
+        if (self->value == NULL) {
+            Py_DECREF(self);
+            return NULL;
+        }
+        self->next = Py_NewRef(Py_None);
+        if (self->next == NULL) {
+            Py_DECREF(self);
+            return NULL;
+        }
+        self->prev = Py_None;
+        if (self->prev == NULL) {
+            Py_DECREF(self);
+            return NULL;
+        }
+    }
+    return (PyObject *) self;
+}
+
+// Getters and Setters
+
+static int DLLNode_set(PyObject* op, PyObject* value, void* closure){
+    PyErr_SetString(PyExc_TypeError, "Default DLLNode attributes cannot be manually altered");
+    return -1;
+}
+
+static PyObject* DLLNode_value_get(PyObject* op, void* closure){
+    DLLNode* self = (DLLNode* )op;
+    return Py_NewRef(self->value);
+}
+
+static PyObject* DLLNode_next_get(PyObject* op, void* closure){
+    DLLNode* self = (DLLNode* )op;
+    return Py_NewRef(self->next);
+}
+
+static PyObject* DLLNode_prev_get(PyObject* op, void* closure){
+    DLLNode* self = (DLLNode* )op;
+    return Py_NewRef(self->prev);
+}
+
+static PyGetSetDef DLLNode_getsetters[] = {
+    {"value", DLLNode_value_get, DLLNode_set,
+    "value held by node", NULL},
+    {"next", DLLNode_next_get, DLLNode_set, 
+    "next node", NULL},
+    {"prev", DLLNode_prev_get, DLLNode_set,
+    "prev node", NULL},
+    {NULL}
+};
+
+// __Methods__
+
+static PyObject* DLLNode_str(PyObject* op, PyObject* Py_UNUSED(dummy)){
+    DLLNode* self = (DLLNode* )op;
+    PyObject* rtn = PyUnicode_FromFormat("%S", self->value); if(!rtn) {return NULL;}
+    return rtn;
+}
+
+//Type Definition
+
+static PyTypeObject DLLNodeType = {
+    .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
+    .tp_name = "py_doubly_linked_list.doubly_linked_list.DLLNode",
+    .tp_doc = PyDoc_STR("Node for doubly linked list"),
+    .tp_basicsize = sizeof(DLLNode),
+    .tp_itemsize = 0,
+    .tp_flags = Py_TPFLAGS_DEFAULT,
+    .tp_new = DLLNode_new,
+    .tp_dealloc = DLLNode_dealloc,
+    .tp_getset = DLLNode_getsetters,
+    .tp_str = (reprfunc)DLLNode_str
+};
+
+static int dllnode_module_exec(PyObject *m)
+{
+    if (PyType_Ready(&DLLNodeType) < 0) {
+        return -1;
+    }
+
+    return 0;
+}
+
+// - - - - - DoublyLinkedList - - - - - //
+
+typedef struct {
+	PyObject_HEAD
+    PyObject* head;
+    PyObject* tail;
+    PyObject* cursor;
+    Py_ssize_t cursor_pos;
+    Py_ssize_t length;
+} DoublyLinkedList;
+
+static PyTypeObject DoublyLinkedListType;
+
+// Define internal helper methods
+
+static int DoublyLinkedList_locate(PyObject*, Py_ssize_t);
+static int DoublyLinkedList_cursor_insert(PyObject*, PyObject*, int);
+static int DoublyLinkedList_append_iterator(PyObject*, PyObject*, int);
+static int DoublyLinkedList_cursor_delete(PyObject*);
+
+// Initialization and deallocation
+
+static void
+DoublyLinkedList_dealloc(PyObject *op)
+{
+    DoublyLinkedList* self = (DoublyLinkedList* )op;
+    Py_XDECREF(self->head);
+    Py_XDECREF(self->tail);
+    Py_XDECREF(self->cursor);
+    Py_TYPE(self)->tp_free(self);
+}
+
+static PyObject *
+DoublyLinkedList_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
+{
+    DoublyLinkedList *self;
+    self = (DoublyLinkedList *) type->tp_alloc(type, 0);
+    if (self != NULL) {
+        self->head = Py_NewRef(Py_None);
+        if (self->head == NULL) {
+            Py_DECREF(self);
+            return NULL;
+        }
+        self->tail = Py_NewRef(Py_None);
+        if (self->tail == NULL) {
+            Py_DECREF(self);
+            return NULL;
+        }
+        self->cursor = Py_NewRef(Py_None);
+        if (self->cursor == NULL) {
+            Py_DECREF(self);
+            return NULL;
+        }
+        self->cursor_pos = 0;
+        self->length = 0;
+    }
+    return (PyObject *) self;
+}
+
+static int
+DoublyLinkedList_init(PyObject* op, PyObject *args)
+{
+    DoublyLinkedList* self = (DoublyLinkedList* )op;
+    PyObject* iterable = NULL;
+    if (!PyArg_ParseTuple(args, "|O", &iterable))
+        return -1;
+    if(iterable){
+        if(DoublyLinkedList_append_iterator((PyObject*)self, iterable, 1)) {return -1;}
+    }
+    return 0;
+}
+
+// Methods
+
+static PyObject* DoublyLinkedList_insert(PyObject* op, PyObject* args, PyObject* kwds){
+    DoublyLinkedList* self = (DoublyLinkedList*) op;
+    static char* kwlist[] = {"object", "index", "forward", NULL};
+    PyObject* object = NULL;
+    Py_ssize_t index;
+    int forward = 1;
+    if (!PyArg_ParseTupleAndKeywords(args, kwds, "On|i", kwlist,
+                                     &object, &index, &forward))
+        return NULL;
+    if(DoublyLinkedList_locate((PyObject*)self, index)) {return NULL;}
+    if(DoublyLinkedList_cursor_insert((PyObject*)self, object, forward)) {return NULL;}
+    return Py_NewRef(Py_None);
+}
+
+static PyObject* DoublyLinkedList_append(PyObject* op, PyObject* args, PyObject* kwds){
+    DoublyLinkedList* self = (DoublyLinkedList*) op;
+    static char* kwlist[] = {"object", "forward", NULL};
+    PyObject* object = NULL;
+    int forward = 1;
+    if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|i", kwlist,
+                                     &object, &forward))
+        return NULL;
+    if(forward) {Py_SETREF(self->cursor, Py_NewRef(self->tail));}
+    else {Py_SETREF(self->cursor, Py_NewRef(self->head));}
+    if(DoublyLinkedList_cursor_insert((PyObject*)self, object, forward)) {return NULL;}
+    return Py_NewRef(Py_None);
+}
+
+static PyObject* DoublyLinkedList_index(PyObject* op, PyObject* args, PyObject* kwds){
+    DoublyLinkedList* self = (DoublyLinkedList* )op;
+    static char* kwlist[] = {"value", "start", "stop", NULL};
+    PyObject* value; Py_ssize_t start = 0; Py_ssize_t stop = self->length;
+    DLLNode* cursor;
+    if(!PyArg_ParseTupleAndKeywords(args, kwds, "O|nn", kwlist, &value, &start, &stop)) {return NULL;}
+    for(Py_ssize_t i=start; i<stop; i++){
+        if(DoublyLinkedList_locate((PyObject*)self, i)) {return NULL;}
+        cursor = (DLLNode*)self->cursor;
+        if(cursor->value == value) {
+            PyObject* rtn = PyLong_FromSsize_t(i); if(!rtn) {return NULL;}
+            return rtn;}
+    }
+    PyObject* err_value = PyObject_Str(value); if(!err_value) {return NULL;}
+    PyObject* err_format = PyUnicode_FromFormat("%U not in list", err_value); if(!err_format) {return NULL;}
+    PyErr_SetString(PyExc_ValueError, PyUnicode_AsUTF8(err_format));
+    Py_DECREF(err_value); Py_DECREF(err_format);
+    return NULL;
+}
+
+static PyObject* DoublyLinkedList_pop(PyObject* op, PyObject* args, PyObject* kwds){
+    DoublyLinkedList* self = (DoublyLinkedList* ) op;
+    static char* kwlist[] = {"index", NULL};
+    Py_ssize_t index = self->length-1;
+    if(!PyArg_ParseTupleAndKeywords(args, kwds, "|n", kwlist, &index)) {return NULL;}
+    if(DoublyLinkedList_locate((PyObject*)self, index)) {return NULL;}
+    DLLNode* cursor = (DLLNode* )self->cursor;
+    PyObject* popped = Py_NewRef(cursor->value);
+    if(DoublyLinkedList_cursor_delete((PyObject*)self)) {return NULL;}
+    return popped;
+}
+
+static PyObject* DoublyLinkedList_remove(PyObject* op, PyObject* args, PyObject* kwds){
+    DoublyLinkedList* self = (DoublyLinkedList* )op;
+    if(!DoublyLinkedList_index((PyObject*)self, args, kwds)) {return NULL;}
+    if(DoublyLinkedList_cursor_delete((PyObject*)self)) {return NULL;}
+    return Py_NewRef(Py_None);
+}
+
+static PyObject* DoublyLinkedList_extend(PyObject* op, PyObject* args, PyObject* kwds){
+    DoublyLinkedList* self = (DoublyLinkedList* )op;
+    static char* kwlist[] = {"iterable", "forward", NULL};
+    PyObject* iterable;
+    int forward = 1;
+    if(!PyArg_ParseTupleAndKeywords(args, kwds, "O|i", kwlist, &iterable, &forward)) {return NULL;}
+    if(DoublyLinkedList_append_iterator((PyObject*)self, iterable, forward)) {return NULL;}
+    return Py_NewRef(Py_None);
+}
+
+static PyObject* DoublyLinkedList_copy(PyObject* op){
+    DoublyLinkedList* copy = (DoublyLinkedList*)DoublyLinkedList_new(&DoublyLinkedListType, NULL, NULL); if(!copy) {return NULL;}
+    if(DoublyLinkedList_append_iterator((PyObject*)copy, op, 1)) {return NULL;}
+    return (PyObject*)copy;
+}
+
+static PyObject* DoublyLinkedList_reverse(PyObject* op){
+    DoublyLinkedList* self = (DoublyLinkedList* )op;
+    Py_ssize_t middle = self->length / 2;
+    PyObject* temp;
+    DLLNode* node1 = (DLLNode*)self->head;
+    DLLNode* node2 = (DLLNode*)self->tail;
+    for(Py_ssize_t i = 0; i < middle; i++){
+        temp = (PyObject*)node1->value;
+        node1->value = node2->value;
+        node2->value = (PyObject*)temp;
+        node1 = (DLLNode*)node1->next;
+        node2 = (DLLNode*)node2->prev;
+    }
+    return Py_NewRef(Py_None);
+}
+
+static PyObject* DoublyLinkedList_count(PyObject* op, PyObject* args, PyObject* kwds) {
+    DoublyLinkedList* self = (DoublyLinkedList* )op;
+    static char* kwlist[] = {"value", NULL};
+    PyObject* value;
+    if(!PyArg_ParseTupleAndKeywords(args, kwds, "O", kwlist, &value)) {return NULL;}
+    DLLNode* temp = (DLLNode*)self->head;
+    Py_ssize_t count = 0;
+    for(Py_ssize_t i = 0; i<self->length; i++){
+        if(temp->value==value) {count += 1;}
+        temp = (DLLNode*)temp->next;
+    }
+    PyObject* rtn = PyLong_FromSsize_t(count); if(!rtn) {return NULL;}
+    return rtn;
+}
+
+static PyObject* DoublyLinkedList_clear_method(PyObject* op){
+    DoublyLinkedList* self = (DoublyLinkedList* )op;
+    if(self->length == 0){
+        return Py_NewRef(Py_None);
+    }
+    Py_DECREF(self->cursor); Py_DECREF(self->head); Py_DECREF(self->tail);
+    self->head = Py_NewRef(Py_None); self->tail = Py_NewRef(Py_None); self->cursor = Py_NewRef(Py_None);
+    self->length = 0; self->cursor_pos = 0;
+    return Py_NewRef(Py_None);
+}
+
+//Helper method for sort, swaps two nodes that are next to each
+static void swap(PyObject* op, PyObject* node1, PyObject* node2) {
+    DoublyLinkedList* self = (DoublyLinkedList*)op;
+    DLLNode* temp1 = (DLLNode*)node1;
+    DLLNode* temp2 = (DLLNode*)node2;
+    if(Py_IsNone(temp1->prev)) {
+        self->head = (PyObject*)temp2;
+    }
+    else{
+        ((DLLNode*)(temp1->prev))->next = (PyObject*)temp2;
+    }
+    if(Py_IsNone(temp2->next)){
+        Py_SETREF(self->tail, (PyObject*)temp1);
+    }
+    else{
+        ((DLLNode*)(temp2->next))->prev = (PyObject*)temp1;
+    }
+    temp1->next = temp2->next;
+    temp2->prev = temp1->prev;
+    temp2->next = (PyObject*)temp1;
+    temp1->prev = (PyObject*)temp2;
+}
+
+static PyObject* DoublyLinkedList_sort(PyObject* op, PyObject* args, PyObject* kwds) {
+    DoublyLinkedList* self = (DoublyLinkedList* )op;
+    char* kwlist[] = {"key", "reverse", NULL};
+    PyObject* key = NULL; int reverse = 0;
+    if(!PyArg_ParseTupleAndKeywords(args, kwds, "|Oi", kwlist, &key, &reverse)) { return NULL; }
+    int operator;
+    if(reverse) { operator = Py_GT; } else { operator = Py_LT; }
+    DLLNode* temp = (DLLNode*)self->head;
+    DLLNode* next = (DLLNode*)temp->next;
+    DLLNode* prev;
+    int comparison;
+
+    if(key) {
+		if(!PyCallable_Check(key)) {
+			PyErr_SetString(PyExc_TypeError, "Key must be a callable"); return NULL; }
+		for(int i = 0; i < self->length; i++) {
+			PyObject* value_key = PyObject_CallOneArg(key, temp->value);
+			if(!value_key) { return NULL; }
+			temp->key = value_key;
+			temp = (DLLNode*)temp->next;
+		}
+
+		temp = (DLLNode*)self->head;
+		for(int i = 1; i < self->length; i++) {
+        	temp = next;
+        	next = (DLLNode*)temp->next;
+            for(int j = i; j >= 1; j--) {
+                prev = (DLLNode*)temp->prev;
+                comparison = PyObject_RichCompareBool(temp->key, prev->key, operator);
+                if(comparison == -1) { return NULL; }
+                if(comparison){swap((PyObject*)self, (PyObject*)prev, (PyObject*)temp);}
+                else { break; }
+            }
+    	}
+		temp = (DLLNode*)self->head;
+		for(int i =0; i < self->length; i++) {
+			Py_DECREF(temp->key);
+			temp = (DLLNode*)temp->next;
+		}
+		self->cursor_pos = 0;
+    	Py_SETREF(self->cursor, Py_NewRef(self->head));
+    	return Py_NewRef(Py_None);
+	}
+	else{
+    	for(int i = 1; i < self->length; i++) {
+        	temp = next;
+        	next = (DLLNode*)temp->next;
+            for(int j = i; j >= 1; j--) {
+                prev = (DLLNode*)temp->prev;
+                comparison = PyObject_RichCompareBool(temp->value, prev->value, operator);
+                if(comparison == -1) { return NULL; }
+                if(comparison){swap((PyObject*)self, (PyObject*)prev, (PyObject*)temp);}
+                else { break; }
+        	}
+    	}
+    	self->cursor_pos = 0;
+    	Py_SETREF(self->cursor, Py_NewRef(self->head));
+    	return Py_NewRef(Py_None);
+	}
+}
+
+// Internal Methods
+
+// Takes in DoublyLinkedList and index, locates node at that index and sets cursor to it
+static int DoublyLinkedList_locate(PyObject* op, Py_ssize_t index){
+    DoublyLinkedList* self = (DoublyLinkedList* )op;
+    if(index < 0) {index = self->length + index;}
+    if(index >= self->length || index < 0){
+        PyErr_SetString(PyExc_IndexError, "Index out of bounds");
+        return -1;
+    }
+    DLLNode* search_node = (DLLNode*)self->cursor;
+    Py_ssize_t search_distance = index-self->cursor_pos;
+    const Py_ssize_t head_distance = index;
+    const Py_ssize_t tail_distance = index-(self->length-1);
+    if(abs(head_distance) < abs(search_distance)){
+        search_node = (DLLNode*)self->head;
+        search_distance = head_distance;
+    }
+    else if(abs(tail_distance) < abs(search_distance)){
+        search_node = (DLLNode*)self->tail;
+        search_distance = tail_distance;
+    }
+    if(search_distance>0){
+        for(Py_ssize_t i = 0; i<search_distance; i++){
+            search_node = (DLLNode*)search_node->next;
+        }
+    }
+    else if(search_distance<0){
+        for(Py_ssize_t i=0; i>search_distance; i--){
+            search_node = (DLLNode*)search_node->prev;
+        }
+    }
+    Py_SETREF(self->cursor, Py_NewRef((PyObject*)search_node));
+    self->cursor_pos = index;
+    return 0;
+}
+
+// Create a new node with value and inserts it forwards or backwards and sets cursor to it.
+// We don't create a reference to the prev node since we can guarentee that as long as it is in the list it will have a reference from its prev anyway.
+// This avoids cycles
+static int DoublyLinkedList_cursor_insert(PyObject* op, PyObject* object, int forward) {
+    DoublyLinkedList* self = (DoublyLinkedList*)op;
+    self->length += 1;
+    DLLNode* node = (DLLNode*)DLLNode_new(&DLLNodeType, NULL, NULL); if(!node) {return -1;}
+    Py_SETREF(node->value, Py_NewRef(object));
+    if(Py_IsNone(self->cursor)){
+        Py_SETREF(self->head, (PyObject*)node);
+        Py_SETREF(self->tail, Py_NewRef((PyObject*)node));
+        Py_SETREF(self->cursor, Py_NewRef((PyObject*)node));
+    }
+    else{
+        DLLNode* cursor = (DLLNode*)self->cursor;
+        if(forward){
+            self->cursor_pos += 1;
+            if(Py_IsNone(cursor->next)){
+                node->prev = (PyObject*)cursor;
+                Py_SETREF(self->tail, Py_NewRef((PyObject*)node));
+		        Py_SETREF(cursor->next, (PyObject*)node);
+
+            }
+            else{
+                DLLNode* temp = (DLLNode*)cursor->next;
+                node->prev = (PyObject*)cursor;
+                temp->prev = (PyObject*)node;
+                Py_SETREF(node->next, Py_NewRef((PyObject*)temp));
+                Py_SETREF(cursor->next, Py_NewRef((PyObject*)node));
+            }
+        }
+        else{
+            if(Py_IsNone(cursor->prev)){
+                cursor->prev = (PyObject*)node;
+                Py_SETREF(self->head, Py_NewRef((PyObject*)node));
+                Py_SETREF(node->next, Py_NewRef((PyObject*)cursor));
+            }
+            else{
+                DLLNode* temp = (DLLNode*)cursor->prev;
+                node->prev = (PyObject*)temp;
+                cursor->prev = (PyObject*)node;
+                Py_SETREF(temp->next, (PyObject*)node);
+                Py_SETREF(node->next, Py_NewRef((PyObject*)cursor));
+            }
+        }
+    }
+    Py_SETREF(self->cursor, Py_NewRef((PyObject*)node));
+    return 0;
+}
+
+static int DoublyLinkedList_cursor_delete(PyObject* op){
+    DoublyLinkedList* self = (DoublyLinkedList* )op;
+    self->length -= 1;
+    DLLNode* cursor = (DLLNode*)self->cursor;
+    if(Py_IsNone(cursor->next)){
+        if(Py_IsNone(cursor->prev)){
+            Py_SETREF(self->head, Py_NewRef(Py_None));
+            Py_SETREF(self->tail, Py_NewRef(Py_None));
+            Py_SETREF(self->cursor, Py_NewRef(Py_None));
+        }
+        else{
+            Py_SETREF(self->tail, Py_NewRef(cursor->prev));
+            Py_SETREF(self->cursor, Py_NewRef(cursor->prev));
+            Py_SETREF(((DLLNode*)(cursor->prev))->next, Py_NewRef(cursor->next));
+            self->cursor_pos-=1;
+        }
+    }
+    else{
+        ((DLLNode*)(cursor->next))->prev = cursor->prev;
+        Py_SETREF(self->cursor, Py_NewRef(cursor->next));
+        if(Py_IsNone(cursor->prev)){
+            Py_SETREF(self->head, Py_NewRef(cursor->next));
+        }
+        else{
+            Py_SETREF(((DLLNode*)(cursor->prev))->next, Py_NewRef(cursor->next));
+        }
+    }
+    return 0;
+}
+
+static int DoublyLinkedList_append_iterator(PyObject* op, PyObject* iterable, int forward){
+    DoublyLinkedList* self = (DoublyLinkedList* )op;
+    PyObject* iterator = PyObject_GetIter(iterable);
+    if(!iterator){
+        return -1;
+    }
+    if(forward) {Py_SETREF(self->cursor, Py_NewRef(self->tail));}
+    else {Py_SETREF(self->cursor, Py_NewRef(self->head));}
+    PyObject* item;
+    while((item = PyIter_Next(iterator)) != NULL){
+        if(DoublyLinkedList_cursor_insert((PyObject*)self, item, forward)) {return -1;}
+        Py_DECREF(item);
+    }
+    if(PyErr_Occurred()){
+        Py_XDECREF(iterator);
+        return -1;
+
+    }
+    Py_XDECREF(iterator);
+    return 0;
+}
+
+// Mapping Methods
+
+static PyObject* DoublyLinkedList_subscript(PyObject* op, PyObject* slice){
+    DoublyLinkedList* self = (DoublyLinkedList* )op;
+    if(PySlice_Check(slice)) {
+        Py_ssize_t start, stop, step;
+        DoublyLinkedList* list_slice = (DoublyLinkedList*)DoublyLinkedList_new(&DoublyLinkedListType, NULL, NULL); if(!list_slice) {return NULL;}
+        DLLNode* temp;
+        if (PySlice_Unpack(slice, &start, &stop, &step) == -1) {return NULL;}
+        if(start < 0) {start = self->length + start;}
+        if(stop < 0) {stop = self->length + stop;} if(stop > self->length) {stop = self->length;}
+        if(step > 0) {
+            for(Py_ssize_t i = start; i < stop; i+=step){
+                if(DoublyLinkedList_locate((PyObject*)self, i)) {return NULL;}
+                temp = (DLLNode*)self->cursor;
+                if(DoublyLinkedList_cursor_insert((PyObject*)list_slice, temp->value, 1)) {return NULL;}
+            }
+        }
+        if(step < 0) {
+            for(Py_ssize_t i = start; i > stop; i+=step){
+                if(DoublyLinkedList_locate((PyObject*)self, i)) {return NULL;}
+                temp = (DLLNode*)self->cursor;
+                if(DoublyLinkedList_cursor_insert((PyObject*)list_slice, temp->value, 1)) {return NULL;}
+            }
+        }
+        return (PyObject*)list_slice;
+    }
+    else if(PyLong_Check(slice)) {
+        Py_ssize_t index = PyLong_AsSsize_t(slice); if(index == -1 && PyErr_Occurred()) {return NULL;}
+        if(DoublyLinkedList_locate((PyObject*)self, index)) {return NULL;}
+        DLLNode* cursor = (DLLNode*)self->cursor;
+        return Py_NewRef(cursor->value);
+    }
+    else {PyErr_SetString(PyExc_TypeError, "Index must be an integer or slice"); return NULL;}
+
+}
+
+// Sequence Methods 
+
+static Py_ssize_t DoublyLinkedList_len(PyObject* op, PyObject* args, PyObject* kwds){
+    DoublyLinkedList* self = (DoublyLinkedList*)op;
+    return self->length;
+}
+
+static PyObject* DoublyLinkedList_item(PyObject* op, Py_ssize_t index){
+    DoublyLinkedList* self = (DoublyLinkedList* )op;
+    if(DoublyLinkedList_locate((PyObject*)self, index)) {return NULL;}
+    DLLNode* cursor = (DLLNode*)self->cursor;
+    return Py_NewRef(cursor->value);
+}
+
+static int DoublyLinkedList_ass_item(PyObject* op, Py_ssize_t index, PyObject* value) {
+    DoublyLinkedList* self = (DoublyLinkedList*)op;
+    if(DoublyLinkedList_locate((PyObject*)self, index)) {return -1;}
+    if(!value){
+        if(DoublyLinkedList_cursor_delete((PyObject*)self)) {return -1;}
+        return 0;
+    }
+    DLLNode* cursor = (DLLNode*)self->cursor;
+    Py_SETREF(cursor->value, Py_NewRef(value));
+    return 0;
+}
+
+static PyObject* DoublyLinkedList_concat(PyObject* op, PyObject* concat){
+    PyObject* new_list = DoublyLinkedList_new(&DoublyLinkedListType, NULL, NULL); if(new_list == NULL) {return NULL;}
+    if(DoublyLinkedList_append_iterator(new_list, op, 1)) {return NULL;}
+    if(DoublyLinkedList_append_iterator(new_list, concat, 1)) {return NULL;}
+    return new_list;
+}
+
+static PyObject* DoublyLinkedList_inplace_concat(PyObject* op, PyObject* concat){
+    if(DoublyLinkedList_append_iterator(op, concat, 1)) {return NULL;}
+    return Py_NewRef(op);
+}
+
+static int DoublyLinkedList_contains(PyObject* op, PyObject* value){
+    DoublyLinkedList* self = (DoublyLinkedList*)op;
+    DLLNode* temp = (DLLNode*)self->head;
+    for(Py_ssize_t i = 0; i<self->length; i++){
+        if(temp->value==value) {return 1;}
+        temp = (DLLNode*)temp->next;
+    }
+    return 0;
+}
+
+// __Methods__
+
+static PyObject* DoublyLinkedList_str(PyObject* op, PyObject* Py_UNUSED(dummy)){
+    DoublyLinkedList* self = (DoublyLinkedList*)op;
+    if(self->length == 0) {return PyUnicode_FromString("[]");}
+    PyObject* string = PyUnicode_FromString("["); if(!string) {return NULL;}
+    PyObject* new_string;
+    DLLNode* temp = (DLLNode*)self->head;
+    for(Py_ssize_t i = 1; i<self->length; i++){
+        PyObject* node_str = DLLNode_str((PyObject*)temp, NULL); if(!node_str) {return NULL;}
+        PyObject* format_node_str = PyUnicode_FromFormat("%U, ", node_str); if(!format_node_str) {return NULL;}
+        new_string = PyUnicode_Concat(string, format_node_str); if(!new_string) {return NULL;}
+        Py_DECREF(node_str); Py_DECREF(format_node_str); Py_DECREF(string);
+        string = new_string;
+        temp = (DLLNode*)temp->next;
+    }
+    new_string = PyUnicode_Concat(string, PyUnicode_FromFormat("%U]", DLLNode_str((PyObject*)temp, NULL)));
+    Py_DECREF(string);
+    string = new_string;
+    return string;
+}
+
+static PyMethodDef DoublyLinkedList_methods[] = {
+    {"append", (PyCFunction)DoublyLinkedList_append, METH_VARARGS|METH_KEYWORDS,
+    "Append object to the end of the list. Set forward to false to append to the start."},
+    {"clear", (PyCFunction)DoublyLinkedList_clear_method, METH_NOARGS,
+    "Remove all items from the list."},
+    {"copy", (PyCFunction)DoublyLinkedList_copy, METH_NOARGS,
+    "Return a shallow copy of the list."},
+    {"count", (PyCFunction)DoublyLinkedList_count, METH_VARARGS|METH_KEYWORDS,
+    "Return number of occurrences of value in the list."},
+    {"extend", (PyCFunction)DoublyLinkedList_extend, METH_VARARGS|METH_KEYWORDS,
+    "Extend list by appending elements from the iterable. Set forward to false to extend from the start."},
+    {"index", (PyCFunction)DoublyLinkedList_index, METH_VARARGS|METH_KEYWORDS,
+    "Return first index of value.\nRaises ValueError if the value is not present."},
+    {"insert", (PyCFunction)DoublyLinkedList_insert, METH_VARARGS|METH_KEYWORDS,
+     "Insert object after index. Set forward to false to insert before index."},
+    {"pop", (PyCFunction)DoublyLinkedList_pop, METH_VARARGS|METH_KEYWORDS,
+    "Remove and return item at index (default last).\nRaises IndexError if list is empty or index is out of range."},
+    {"remove", (PyCFunction)DoublyLinkedList_remove, METH_VARARGS|METH_KEYWORDS,
+    "Remove first occurence of value.\nRaises ValueError if the value is not present."},
+    {"reverse", (PyCFunction)DoublyLinkedList_reverse, METH_NOARGS,
+    "Reverse the order of the list."},
+    {"sort", (PyCFunction)DoublyLinkedList_sort, METH_VARARGS|METH_KEYWORDS,
+    "In-place sort in ascending order, equal objects are not swapped. Key can be applied to values and the list will be sorted based on the result of applying the key. Reverse will reverse the sort order."},
+    {NULL, NULL, 0, NULL}
+};
+
+static PyMappingMethods DoublyLinkedList_map = {
+    .mp_subscript = DoublyLinkedList_subscript
+};
+
+static PySequenceMethods DoublyLinkedList_sequence = {
+    .sq_length = (lenfunc)DoublyLinkedList_len,
+    .sq_item = DoublyLinkedList_item,
+    .sq_ass_item = DoublyLinkedList_ass_item,
+    .sq_concat = DoublyLinkedList_concat,
+    .sq_inplace_concat = DoublyLinkedList_inplace_concat,
+    .sq_contains = DoublyLinkedList_contains
+};
+
+//Member Definition
+
+#ifdef DEV
+
+static PyMemberDef DoublyLinkedList_members[] = {
+    {"head", T_OBJECT_EX, offsetof(DoublyLinkedList, head), 0,
+     "Head node."},
+    {"tail", T_OBJECT_EX, offsetof(DoublyLinkedList, tail), 0,
+     "Tail node."},
+    {"cursor", T_OBJECT_EX, offsetof(DoublyLinkedList, cursor), 0,
+     "Cursor tracking most recently accessed node."},
+    {"cursor_pos", T_INT, offsetof(DoublyLinkedList, cursor_pos), 0,
+     "Index of cursor"},
+    {"length", T_INT, offsetof(DoublyLinkedList, length), 0,
+     "Length of list"},
+    {NULL}
+};
+
+#else
+
+static PyMemberDef DoublyLinkedList_members[] = {{NULL}};
+
+#endif
+
+// Type Definition
+
+static PyTypeObject DoublyLinkedListType = {
+    .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
+    .tp_name = "py_doubly_linked_list.doubly_linked_list.DoublyLinkedList",
+    .tp_doc = PyDoc_STR("Node for doubly linked list"),
+    .tp_basicsize = sizeof(DoublyLinkedList),
+    .tp_itemsize = 0,
+    .tp_flags = Py_TPFLAGS_DEFAULT,
+    .tp_new = (newfunc)DoublyLinkedList_new,
+    .tp_init = (initproc)DoublyLinkedList_init,
+    .tp_dealloc = (destructor)DoublyLinkedList_dealloc,
+    .tp_str = (reprfunc)DoublyLinkedList_str,
+    .tp_methods = DoublyLinkedList_methods,
+    .tp_members = DoublyLinkedList_members,
+    .tp_as_sequence = &DoublyLinkedList_sequence,
+    .tp_as_mapping = &DoublyLinkedList_map
+};
+
+static int doubly_linked_list_module_exec(PyObject *m)
+{
+    if (PyType_Ready(&DoublyLinkedListType) < 0) {return -1;}
+    Py_INCREF(&DoublyLinkedListType);
+    if (PyModule_AddObject(m, "DoublyLinkedList", (PyObject *) &DoublyLinkedListType) < 0) {
+        Py_DECREF(&DoublyLinkedListType);
+        Py_DECREF(m);
+        return -1;
+    }
+    return 0;
+}
+
+#if PY_MINOR_VERSION >= 12
+
+static PyModuleDef_Slot py_doubly_linked_list_module_slots[] = {
+    {Py_mod_exec, dllnode_module_exec},
+    {Py_mod_exec, doubly_linked_list_module_exec},
+    {Py_mod_multiple_interpreters, Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED},
+    {0, NULL}
+};
+
+#else
+
+static PyModuleDef_Slot py_doubly_linked_list_module_slots[] = {
+    {Py_mod_exec, dllnode_module_exec},
+    {Py_mod_exec, doubly_linked_list_module_exec},
+    {0, NULL}
+};
+
+#endif
+
+static struct PyModuleDef py_doubly_linked_list_module = {
+	PyModuleDef_HEAD_INIT,
+	"py_doubly_linked_list.doubly_linked_list",
+	"A library implementing a doubly linked list for python",
+	.m_slots = py_doubly_linked_list_module_slots
+};
+
+PyMODINIT_FUNC PyInit_doubly_linked_list(void) {
+	return PyModuleDef_Init(&py_doubly_linked_list_module);
+}

py_doubly_linked_list-0.1.1/src/py_doubly_linked_list/__init__.py

@@ -0,0 +1 @@
+from .doubly_linked_list import DoublyLinkedList

py_doubly_linked_list-0.1.1/src/py_doubly_linked_list/__init__.pyi

@@ -0,0 +1,48 @@
+from typing import Iterable, Any, Self
+from collections.abc import Callable
+
+class DoublyLinkedList:
+    def __init__(self, Iterable: Iterable) -> None: ...
+    def append(self, object: Any, forward: bool = True)-> None:
+        """Append object to the end of the list. Set forward to false to append to the start."""
+        ...
+    def clear(self) -> None:
+        """Remove all items from the list."""
+        ...
+    def copy(self) -> DoublyLinkedList:
+        """Return a shallow copy of the list."""
+        ...
+    def count(self, value: Any) -> int:
+        """Return number of occurrences of value in the list."""
+        ...
+    def extend(self, iterable: Iterable, forward: bool = True) -> None:
+        """Extend list by appending elements from the iterable. Set forward to false to extend from the start."""
+        ...
+    def index(self, value: Any, start: int, stop: int) -> int:
+        """Return first index of value.  
+        Raises ValueError if the value is not present."""
+        ...
+    def insert(self, object: Any, index: int, forward: bool = True) -> None:
+        """Insert object after index. Set forward to false to insert before index."""
+        ...
+    def pop(self, index: int = -1) -> Any:
+        """Remove and return item at index (default last).  
+        Raises IndexError if list is empty or index is out of range."""
+        ...
+    def remove(self, value: Any) -> None:
+        """Remove first occurence of value.  
+        Raises ValueError if the value is not present."""
+        ...
+    def reverse(self) -> None:
+        """Reverse the order of the list."""
+        ...
+    def sort(self: DoublyLinkedList, key: Callable, reverse: bool = False) -> None:
+        """In-place sort in ascending order, equal objects are not swapped. Key can be applied to values and the list will be sorted based on the result of applying the key. Reverse will reverse the sort order."""
+        ...
+    def __add__(self, Iterable: Iterable) -> DoublyLinkedList: ...
+    def __contains__(self, Any: Any) -> bool: ...
+    def __delitem__(self, Any: Any) -> None: ...
+    def __getitem__(self, Index: int) -> Any: ...
+    def __iadd__(self, Iterable: Iterable) -> Self: ...
+    def __len__(self) -> int: ...
+    def __setitem__(self, Index: int, Object: Any) -> None: ...

py_doubly_linked_list-0.1.1/src/py_doubly_linked_list.egg-info/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: py-doubly-linked-list
+Version: 0.1.1
+Summary: A library adding doubly linked lists to python.
+Author-email: Joshua Morningstar <joshuam18745@gmail.com>
+Maintainer-email: Joshua Morningstar <joshuam18745@gmail.com>
+License-Expression: MIT
+Project-URL: Documentation, https://github.com/JoshuaM176/PyDoublyLinkedList/blob/main/README.MD
+Project-URL: Repository, https://github.com/JoshuaM176/PyDoublyLinkedList
+Project-URL: Issues, https://github.com/JoshuaM176/PyDoublyLinkedList/issues
+Project-URL: Changelog, https://github.com/JoshuaM176/PyDoublyLinkedList/blob/main/CHANGES
+Keywords: doubly linked list,data structure
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: README.MD
+Dynamic: license-file
+
+# py-doubly-linked-list
+## Description
+This library provides an implementation of a doubly linked list for python written with the c api. It is meant to be as close as possible to a regular list in its interface, meaning you can interact with it in almost all of the same ways you interact with a regular python list.
+## Methods
+- append  
+Append object to the end of the list. Set forward to false to append to the start.  
+```Python
+doubly_linked_list.append(object: Any, forward: bool = True)
+```
+- clear  
+Remove all items from the list.  
+```Python
+doubly_linked_list.clear()
+```
+- copy  
+Return a shallow copy of the list.  
+```Python
+doubly_linked_list.copy()
+```
+- count  
+Return number of occurrences of value in the list.  
+```Python
+doubly_linked_list.count(value: Any)
+```
+- extend  
+Extend list by appending elements from the iterable. Set forward to false to extend from the start.  
+```Python
+doubly_linked_list.extend(iterable: Iterable, forward: bool = True)
+```
+- index  
+Return first index of value. Raises ValueError if the value is not present.  
+```Python
+doubly_linked_list.index(value: Any, start: int, stop: int)
+```
+- insert  
+Insert object after index. Set forward to false to insert before index.  
+```Python
+doubly_linked_list.insert(object: Any, index: int, forward: bool = True)
+```
+- pop  
+Remove and return item at index (default last). Raises IndexError if list is empty or index is out of range.  
+```Python
+doubly_linked_list.pop(index: int = -1)
+```
+- remove  
+Remove first occurence of value. Raises ValueError if the value is not present.  
+```Python
+doubly_linked_list.remove(value: Any)
+```
+- reverse  
+Reverse the order of the list.  
+```Python
+doubly_linked_list.reverse()
+```
+- sort  
+In-place sort in ascending order, equal objects are not swapped. Key can be applied to values and the list will be sorted based on the result of applying the key. Reverse will reverse the sort order.
+```Python
+doubly_linked_list.sort(key: Callable = None, reverse: bool = False)
+```
+The DoublyLinkedList also supports:
+- concatenation with other iterables
+- in-place concatenation with other iterables
+- indexing and assignment by index
+- slicing
+- iterating  
+
+Things that are not currently supported but might be in the future:
+- assigning slices
+- repeating, i.e list = [1] * 5 create a list with 1 repeated 5 times
+
+# License
+Copyright (c) 2025 Joshua A. Morningstar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

py_doubly_linked_list-0.1.1/src/py_doubly_linked_list.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.MD
+pyproject.toml
+src/doubly_linked_list.c
+src/py_doubly_linked_list/__init__.py
+src/py_doubly_linked_list/__init__.pyi
+src/py_doubly_linked_list.egg-info/PKG-INFO
+src/py_doubly_linked_list.egg-info/SOURCES.txt
+src/py_doubly_linked_list.egg-info/dependency_links.txt
+src/py_doubly_linked_list.egg-info/top_level.txt
+tests/test_build.py

py_doubly_linked_list-0.1.1/src/py_doubly_linked_list.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

py_doubly_linked_list-0.1.1/src/py_doubly_linked_list.egg-info/top_level.txt

@@ -0,0 +1 @@
+py_doubly_linked_list

py_doubly_linked_list-0.1.1/tests/test_build.py

@@ -0,0 +1,30 @@
+from py_doubly_linked_list import DoublyLinkedList
+import sys
+import weakref
+
+class DummyClass():
+    def __init__(self, id: int):
+        self.id = id
+
+    def __str__(self):
+        return str(self.id)
+
+def create_test_list():
+    return DoublyLinkedList([DummyClass(0),DummyClass(1),DummyClass(2),DummyClass(3)])
+
+def test_length():
+    test_list = create_test_list()
+    assert len(test_list) == 4
+    test_list.pop()
+    assert len(test_list) == 3
+    test_list.clear()
+    assert len(test_list) == 0
+
+def test_dereferencing():
+    test_list = create_test_list()
+    reference = weakref.ref(test_list[0])
+    test_list.pop(0)
+    assert reference() is None
+    reference = weakref.ref(test_list[0])
+    test_list.clear()
+    assert reference() is None