Merge branch 'master' of https://git.dms-serwis.com.pl/smokserwis/satella

.github/workflows/ci.yml

@@ -7,7 +7,7 @@ jobs:
     environment: Env1
     strategy:
       matrix:
-        python-version: [ "3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "pypy3.9" ]
+        python-version: [ "3.7", "3.8", "3.9", "3.10", "3.11", "3.12" ]
     steps:
       - uses: actions/checkout@main
       - uses: actions/setup-python@main

.gitlab-ci.yml

+stages:
+  - test
+  - build
+
+pages:
+  image: zoo.smok.co/build/build:latest
+  stage: build
+  script:
+    - cd docs
+    - make html
+    - cd ..
+    - mv docs/_build/html public
+  artifacts:
+    paths:
+      - public
+
+.test:
+  stage: test
+  before_script:
+    - pip install --break-system-packages --upgrade pytest setuptools pip coverage nose2
+    - pip install ".[dev,test]"
+  script:
+    - pytest -n 8 -vv --cov=satella
+    - coverage xml
+    - coverage report
+  coverage: /TOTAL.*\s+(\d+\%)/
+
+test_python37:
+  extends: .test
+  image: python:3.7
+
+test_python38:
+  extends: .test
+  image: python:3.8
+
+test_python39:
+  extends: .test
+  image: python:3.9
+
+test_pypy310:
+  extends: .test
+  image: pypy:3.10
+  when: manual
+
+test_pypy39:
+  extends: .test
+  image: pypy:3.9
+  when: manual
+
+test_python310:
+  extends: .test
+  image: python:3.10
+
+
+test_python311:
+  extends: .test
+  image: python:3.11
+
+
+build_python:
+  stage: build
+  before_script:
+    - pip install --break-system-packages --upgrade Cython setuptools pip twine
+  script:
+    - python setup.py bdist_wheel
+    - mv dist/*.whl .
+  artifacts:
+    paths:
+      - "*.whl"
+  after_script:
+    - TWINE_PASSWORD=${CI_JOB_TOKEN} TWINE_USERNAME=gitlab-ci-token python3 -m twine upload --repository-url ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi *.whl
+  only:
+    - tags
+  except:
+    - branches
+

CHANGELOG.md

+# v2.25.5
+
+* slight optimization for Heap.push_many
+* bugfix for Heap.push and a deprecation
+
 # v2.25.4
 
 * add JSONAbleDataObject

satella/__init__.py

-__version__ = '2.25.4'
+__version__ = '2.25.5'

satella/coding/structures/heaps/base.py

@@ -7,14 +7,6 @@ from satella.coding.decorators.decorators import wraps
 from satella.coding.typing import T, Predicate
 
 
-def _extras_to_one(fun):
-    @wraps(fun)
-    def inner(self, a, *args, **kwargs):
-        return fun(self, ((a,) + args) if len(args) > 0 else a, **kwargs)
-
-    return inner
-
-
 class Heap(collections.UserList, tp.Generic[T]):
     """
     Sane heap as object - not like heapq.
@@ -30,8 +22,17 @@ class Heap(collections.UserList, tp.Generic[T]):
         heapq.heapify(self.data)
 
     def push_many(self, items: tp.Iterable[T]) -> None:
-        for item in items:
-            self.push(item)
+        """
+        Put multiple items on the heap.
+        Faster than
+
+        >>> for item in items:
+        >>>     heap.push(item)
+
+        :param: an iterable with items to put
+        """
+        self.data.extend(items)
+        heapq.heapify(self.data)
 
     def pop_item(self, item: T) -> T:
         """
@@ -43,8 +44,7 @@ class Heap(collections.UserList, tp.Generic[T]):
         heapq.heapify(self.data)
         return item
 
-    @_extras_to_one
-    def push(self, item: T) -> None:
+    def push(self, item: T, *args) -> None:
         """
         Use it like:
 
@@ -53,7 +53,14 @@ class Heap(collections.UserList, tp.Generic[T]):
         or:
 
         >>> heap.push(4, myobject)
+
+        However this syntax is
+
+        .. deprecated:: 2.25.5
+            It's not legible
         """
+        if args:
+            item = (item, *args)
         heapq.heappush(self.data, item)
 
     def __deepcopy__(self, memo={}) -> 'Heap':
@@ -138,6 +145,13 @@ class SetHeap(Heap):
     #notthreadsafe
     """
 
+    def push_many(self, items: tp.Iterable[T]) -> None:
+        """
+        Not that much faster than inserting anything by hand
+        """
+        for item in items:
+            self.push(item)
+
     def __init__(self, from_list: tp.Optional[tp.Iterable[T]] = None):
         super().__init__(from_list=from_list)
         self.set = set(self.data)

tests/test_coding/test_structures.py

@@ -37,6 +37,13 @@ def continue_testing_omni(self, omni_class):
 
 class TestStructures(unittest.TestCase):
 
+    def test_heap_bugfix(self):
+        heap = Heap()
+
+        heap.push_many([(1, object()), (2, object())])
+        item = heap.pop()
+        self.assertEqual(item[0], 1)
+
     def test_onstronlyname(self):
 
         class MyEnum(OnStrOnlyName, Enum):