sortbydict 0.1.0__tar.gz

sortbydict-0.1.0/.gitignore

@@ -0,0 +1,5 @@
+\dist
+\__pycache__
+\.pytest_cache
+\.vscode
+PYPI_API_TOKEN

sortbydict-0.1.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2026 Tang Zhilin (https://github.com/lucas-linlin)
+
+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.

sortbydict-0.1.0/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: sortbydict
+Version: 0.1.0
+Summary: A Python sort algorithm to sort any types of objects.
+Project-URL: Homepage, https://github.com/Lucas-Linlin/sortbydict
+Project-URL: Issues, https://github.com/Lucas-Linlin/sortbydict/issues
+Author-email: Tang Zhilin <Lin_LUCAS@hotmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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.14

sortbydict-0.1.0/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["hatchling >= 1.26"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sortbydict"
+version = "0.1.0"
+authors = [
+  { name="Tang Zhilin", email="Lin_LUCAS@hotmail.com" },
+]
+description = "A Python sort algorithm to sort any types of objects."
+readme = "README.md"
+requires-python = ">=3.14"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "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",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+[project.urls]
+Homepage = "https://github.com/Lucas-Linlin/sortbydict"
+Issues = "https://github.com/Lucas-Linlin/sortbydict/issues"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+doctest_modules = true
+addopts = [
+    "--doctest-modules",
+    "-v",
+    "--strict-markers",
+]

sortbydict-0.1.0/src/sortbydict/__init__.py

@@ -0,0 +1,10 @@
+'''
+sortbydict: a dict-based linear time sort tool.
+The software has the capacity to provide a rapid sorting method and to support the sorting of lists containing any number of objects of the same type concurrently.
+'''
+
+__version__ = '0.1.0'
+from sortbydict.core import *
+from sortbydict.utils import *
+
+# __all__ = 

sortbydict-0.1.0/src/sortbydict/core.py

@@ -0,0 +1,35 @@
+from sortbydict.utils import *
+from typing import TypeVar,Callable
+T = TypeVar('T')
+BUILTIN_TYPES = (int,float,str,bytes)
+def sort_by_dict(data: list[T], func: None | Callable = None, /) -> list[T]:
+    """A function to sort a list of objects of any type.
+    Args:
+        data (list): List of objects to be sorted.
+        func (callable): A function to map each item in the list to an integer to use as the sort key.
+
+    Returns:
+        out (list): The new sorted list.
+
+        Note: **The sorted list is not the same object as the original list `data`.**
+    
+    Raises:
+        TypeError: If the object types in the list are not consistent.
+        TypeError: If the type of object is not supported by the `func` function.
+        SortError: If the `func` function raises an error except `TypeError`.
+    
+    Examples:
+        >>> l1 = [6,8,2,5,3]
+        >>> l2 = sort_by_dict(l1)
+        >>> l2
+        [2, 3, 5, 6, 8]
+        >>> l2 is l1
+        False"""
+    tp = type(data[0])
+    if func is None:
+        if tp not in BUILTIN_TYPES:
+            raise TypeError(f'the type {tp} is not supported because no functions are provided.')
+    
+
+    srtd = []
+    return srtd

sortbydict-0.1.0/src/sortbydict/utils.py

@@ -0,0 +1 @@
+class SortError(Exception):pass