circuitpython-functools 1.0.2__tar.gz → 2.0.0__tar.gz

{circuitpython-functools-1.0.2 → circuitpython_functools-2.0.0}/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md

@@ -8,6 +8,6 @@ Make sure any changes you're submitting are in line with the CircuitPython Desig
 
 If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs
 
-Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code
+Before submitting the pull request, make sure you've run pre-commit locally on your code. Instructions are available here: https://adafru.it/check-your-code
 
 Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues.

circuitpython_functools-2.0.0/.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
+# SPDX-FileCopyrightText: 2025 Alec Delaney
+#
+# SPDX-License-Identifier: Unlicense
+
+repos:
+  - repo: https://github.com/fsfe/reuse-tool
+    rev: v5.0.2
+    hooks:
+      - id: reuse
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.11
+    hooks:
+      - id: ruff
+        name: Lint via ruff
+        args: [--fix]
+      - id: ruff-format
+        name: Format via ruff

{circuitpython-functools-1.0.2 → circuitpython_functools-2.0.0}/.readthedocs.yaml

@@ -9,11 +9,14 @@
 version: 2
 
 build:
-  os: ubuntu-20.04
-  tools:
-    python: "3"
+    os: ubuntu-24.04
+    tools:
+        python: "3"
+
+sphinx:
+    configuration: docs/conf.py
 
 python:
-  install:
-    - requirements: docs/requirements.txt
-    - requirements: requirements.txt
+    install:
+        - requirements: docs/requirements.txt
+        - requirements: requirements.txt

circuitpython_functools-2.0.0/LICENSE-PSF

@@ -0,0 +1,47 @@
+PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
+
+1. This LICENSE AGREEMENT is between the Python Software Foundation
+("PSF"), and the Individual or Organization ("Licensee") accessing and
+otherwise using this software ("Python") in source or binary form and
+its associated documentation.
+
+2. Subject to the terms and conditions of this License Agreement, PSF hereby
+grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
+analyze, test, perform and/or display publicly, prepare derivative works,
+distribute, and otherwise use Python alone or in any derivative version,
+provided, however, that PSF's License Agreement and PSF's notice of copyright,
+i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
+2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Python Software Foundation;
+All Rights Reserved" are retained in Python alone or in any derivative version
+prepared by Licensee.
+
+3. In the event Licensee prepares a derivative work that is based on
+or incorporates Python or any part thereof, and wants to make
+the derivative work available to others as provided herein, then
+Licensee hereby agrees to include in any such work a brief summary of
+the changes made to Python.
+
+4. PSF is making Python available to Licensee on an "AS IS"
+basis.  PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
+IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
+INFRINGE ANY THIRD PARTY RIGHTS.
+
+5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
+FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
+A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
+OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
+
+6. This License Agreement will automatically terminate upon a material
+breach of its terms and conditions.
+
+7. Nothing in this License Agreement shall be deemed to create any
+relationship of agency, partnership, or joint venture between PSF and
+Licensee.  This License Agreement does not grant permission to use PSF
+trademarks or trade name in a trademark sense to endorse or promote
+products or services of Licensee, or any third party.
+
+8. By copying, installing or otherwise using Python, Licensee
+agrees to be bound by the terms and conditions of this License
+Agreement.

{circuitpython-functools-1.0.2/circuitpython_functools.egg-info → circuitpython_functools-2.0.0}/PKG-INFO

@@ -1,21 +1,22 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: circuitpython-functools
-Version: 1.0.2
+Version: 2.0.0
 Summary: A CircuitPython implementation of CPython's functools library
 Author-email: Alec Delaney <tekktrik@gmail.com>
-License: MIT
+License-Expression: MIT AND PSF-2.0
 Project-URL: Homepage, https://github.com/tekktrik/CircuitPython_functools
 Keywords: adafruit,blinka,circuitpython,micropython,functools,cache,functions,decorators
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Embedded Systems
 Classifier: Topic :: System :: Hardware
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Description-Content-Type: text/x-rst
-License-File: LICENSE
+License-File: LICENSE-MIT
+License-File: LICENSE-PSF
 Requires-Dist: Adafruit-Blinka
 Provides-Extra: optional
+Dynamic: license-file
 
 Introduction
 ============
@@ -36,9 +37,9 @@ Introduction
     :alt: Build Status
 
 
-.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/psf/black
-    :alt: Code Style: Black
+.. image:: https://img.shields.io/badge/code%20style-ruff-2a1833.svg
+    :target: https://github.com/astral-sh/ruff
+    :alt: Code Style: ruff
 
 A CircuitPython implementation of CPython's functools library
 

{circuitpython-functools-1.0.2 → circuitpython_functools-2.0.0}/README.rst

@@ -17,9 +17,9 @@ Introduction
     :alt: Build Status
 
 
-.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/psf/black
-    :alt: Code Style: Black
+.. image:: https://img.shields.io/badge/code%20style-ruff-2a1833.svg
+    :target: https://github.com/astral-sh/ruff
+    :alt: Code Style: ruff
 
 A CircuitPython implementation of CPython's functools library
 

{circuitpython-functools-1.0.2 → circuitpython_functools-2.0.0/circuitpython_functools.egg-info}/PKG-INFO

@@ -1,21 +1,22 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: circuitpython-functools
-Version: 1.0.2
+Version: 2.0.0
 Summary: A CircuitPython implementation of CPython's functools library
 Author-email: Alec Delaney <tekktrik@gmail.com>
-License: MIT
+License-Expression: MIT AND PSF-2.0
 Project-URL: Homepage, https://github.com/tekktrik/CircuitPython_functools
 Keywords: adafruit,blinka,circuitpython,micropython,functools,cache,functions,decorators
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Embedded Systems
 Classifier: Topic :: System :: Hardware
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Description-Content-Type: text/x-rst
-License-File: LICENSE
+License-File: LICENSE-MIT
+License-File: LICENSE-PSF
 Requires-Dist: Adafruit-Blinka
 Provides-Extra: optional
+Dynamic: license-file
 
 Introduction
 ============
@@ -36,9 +37,9 @@ Introduction
     :alt: Build Status
 
 
-.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/psf/black
-    :alt: Code Style: Black
+.. image:: https://img.shields.io/badge/code%20style-ruff-2a1833.svg
+    :target: https://github.com/astral-sh/ruff
+    :alt: Code Style: ruff
 
 A CircuitPython implementation of CPython's functools library
 

{circuitpython-functools-1.0.2 → circuitpython_functools-2.0.0}/circuitpython_functools.egg-info/SOURCES.txt

@@ -1,9 +1,9 @@
 .gitignore
 .pre-commit-config.yaml
-.pylintrc
 .readthedocs.yaml
 CODE_OF_CONDUCT.md
-LICENSE
+LICENSE-MIT
+LICENSE-PSF
 README.rst
 README.rst.license
 circuitpython_functools.py

circuitpython_functools-2.0.0/circuitpython_functools.py

@@ -0,0 +1,167 @@
+# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+# SPDX-FileCopyrightText: Copyright (c) 2022 Alec Delaney
+# SPDX-FileCopyrightText: Python Software Foundation
+# SPDX-FileCopyrightText: MicroPython Developers
+#
+# SPDX-License-Identifier: MIT
+# SPDX-License-Identifier: PSF-2.0
+
+"""CircuitPython implementation of CPython's functools library.
+
+* Author(s): Alec Delaney
+
+Implementation Notes
+--------------------
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware for the supported boards:
+  https://circuitpython.org/downloads
+
+"""
+
+import gc
+from collections import OrderedDict
+
+__version__ = "2.0.0"
+__repo__ = "https://github.com/tekktrik/CircuitPython_functools.git"
+
+_cache_records = {}
+_lru_cache_records = {}
+
+
+class _ObjectMark:
+    pass
+
+
+# Cache-related code ported from CPython
+
+# As a general note, some weird things are happening here due to internal differences between
+# CPython and CircuitPython, such as the fact that closures can't have things added to them,
+# hence the need to create objects so that cache_clear can be called from the returned "wrapped"
+# functions.
+
+
+def _make_key(args, kwargs, kwd_mark=(_ObjectMark(),)):
+    """Make a key for the cache records."""
+    key = tuple(args)
+    if kwargs:
+        key += kwd_mark
+        for item in kwargs.items():
+            key += tuple(item)
+    return hash(key)
+
+
+class CachedFunc:
+    """Wrapped unbounded cache function."""
+
+    def __init__(self, maxsize, user_func):
+        """Initialize the wrapped cache function."""
+        self._maxsize = maxsize
+        checked_records = _cache_records if maxsize < 0 else _lru_cache_records
+
+        def cache_wrapper(*args, **kwargs):
+            sentinel = object()
+
+            # Make the key for the inner dictionary
+            key = _make_key(args, kwargs)
+
+            # if there is no inner dictionary yet, make one
+            if checked_records.get(user_func) is None:
+                checked_records[user_func] = OrderedDict()
+
+            # Attempt to get an existing entry, updating its location in the queue
+            # and returning it if so
+            result = checked_records[user_func].get(key, sentinel)
+            if result is not sentinel:
+                checked_records[user_func].move_to_end(key)
+                return result
+
+            # Calculate the actual value
+            result = user_func(*args, **kwargs)
+
+            # If the cache is bounded and too full to store the new result, eject the
+            # least-recently-use entry
+            if maxsize >= 0 and len(checked_records[user_func]) >= maxsize:
+                first_key = next(iter(checked_records[user_func]))
+                del checked_records[user_func][first_key]
+
+            # Store the result
+            checked_records[user_func][key] = result
+
+            # Return the new result
+            return result
+
+        self._user_func = user_func
+        self._wrapped_func = cache_wrapper
+
+    def __call__(self, *args, **kwargs):
+        """Call the wrapped function."""
+        return self._wrapped_func(*args, **kwargs)
+
+    def cache_clear(self):
+        """Clear the cache."""
+        checked_records = _cache_records if self._maxsize < 0 else _lru_cache_records
+        if self._user_func in checked_records:
+            checked_records[self._user_func].clear()
+            gc.collect()
+
+
+class LRUCachedFunc:
+    """Wrapped LRU cache function."""
+
+    def __init__(self, wrapped_func, maxsize):
+        """Initialize the wrapped LRU cache function."""
+        self._maxsize = maxsize
+        self._wrapped_func = wrapped_func
+
+    def __call__(self, *args, **kwargs):
+        """Call the wrapped function."""
+        print(type(self._wrapped_func))
+        return self._wrapped_func(*args, **kwargs)
+
+    def cache_clear(self):
+        """Clear the LRU cache."""
+        return self.cache_clear()
+
+
+def cache(user_function):
+    """Create an unbounded cache."""
+    return CachedFunc(-1, user_function)
+
+
+def lru_cache(*args, **kwargs):
+    """Create a bounded cache which ejects the least recently used entry."""
+    cpython_max_args = 2
+    if len(args) == cpython_max_args or "typed" in kwargs:
+        raise NotImplementedError("Using typed is not supported")
+
+    if len(args) == 1 and isinstance(args[0], int):
+        maxsize = args[0]
+    elif len(args) == 1 and str(type(args[0]) == "<class 'function'>"):
+        return CachedFunc(128, args[0])
+    elif "maxsize" in kwargs:
+        maxsize = kwargs["maxsize"]
+    else:
+        raise SyntaxError("lru_cache syntax incorrect")
+
+    return partial(CachedFunc, maxsize)
+
+
+# Partial ported from the MicroPython library
+def partial(func, *args, **kwargs):
+    """Create a partial of the function."""
+
+    def _partial(*more_args, **more_kwargs):
+        local_kwargs = kwargs.copy()
+        local_kwargs.update(more_kwargs)
+        return func(*(args + more_args), **local_kwargs)
+
+    return _partial
+
+
+# Thank you to the MicroPython Development team for
+# their simplified implementation of the wraps function!
+def wraps(wrapped, assigned=None, updated=None):
+    """Define a wrapper function when writing function decorators."""
+    return wrapped

{circuitpython-functools-1.0.2 → circuitpython_functools-2.0.0}/docs/conf.py

@@ -4,6 +4,8 @@
 #
 # SPDX-License-Identifier: MIT
 
+"""Sphinx configuration file."""
+
 import os
 import sys
 
@@ -101,10 +103,8 @@ napoleon_numpy_docstring = False
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-import sphinx_rtd_theme
 
 html_theme = "sphinx_rtd_theme"
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

circuitpython_functools-2.0.0/examples/functools_simpletest.py

@@ -0,0 +1,35 @@
+# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+# SPDX-FileCopyrightText: Copyright (c) 2022 Alec Delaney
+#
+# SPDX-License-Identifier: Unlicense
+
+"""Example usage of the circuitpython_functools module."""
+
+from circuitpython_functools import cache
+
+
+@cache
+def add(a, b, *, c=1, d=2):
+    """Perform addition."""
+    return a + b + c + d
+
+
+@cache
+def subtract(first_value, second_value):
+    """Perform subtraction."""
+    return first_value - second_value
+
+
+print(add(1, 1, c=2, d=3))
+print(add(1, 1, c=2, d=3))  # Repeat call, will use cached result
+print(add(1, 0, c=3, d=4))
+print(subtract(42, 20))
+print(add(1, b=1, c=2, d=3))
+print(add(1, b=0, c=2, d=3))
+
+# Clear all the caches so we don't use too much memory
+add.cache_clear()
+subtract.cache_clear()
+
+print(add(1, 0, c=3, d=4))  # Cache was cleared, so this is caclulated again
+print(subtract(18, 4))

{circuitpython-functools-1.0.2 → circuitpython_functools-2.0.0}/pyproject.toml

@@ -12,7 +12,7 @@ requires = [
 [project]
 name = "circuitpython-functools"
 description = "A CircuitPython implementation of CPython's functools library"
-version = "1.0.2"
+version = "2.0.0"
 readme = "README.rst"
 authors = [
     {name = "Alec Delaney", email = "tekktrik@gmail.com"}
@@ -28,13 +28,12 @@ keywords = [
     "functions",
     "decorators",
 ]
-license = {text = "MIT"}
+license = "MIT AND PSF-2.0"
 classifiers = [
     "Intended Audience :: Developers",
     "Topic :: Software Development :: Libraries",
     "Topic :: Software Development :: Embedded Systems",
     "Topic :: System :: Hardware",
-    "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
 ]
 dynamic = ["dependencies", "optional-dependencies"]
@@ -45,3 +44,7 @@ py-modules = ["circuitpython_functools"]
 [tool.setuptools.dynamic]
 dependencies = {file = ["requirements.txt"]}
 optional-dependencies = {optional = {file = ["optional_requirements.txt"]}}
+
+[tool.ruff.lint]
+select = ["D", "PL", "I"]
+ignore = ["D213", "D203"]

circuitpython-functools-1.0.2/.pre-commit-config.yaml

@@ -1,42 +0,0 @@
-# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
-#
-# SPDX-License-Identifier: Unlicense
-
-repos:
-  - repo: https://github.com/python/black
-    rev: 23.12.1
-    hooks:
-      - id: black
-  - repo: https://github.com/fsfe/reuse-tool
-    rev: v2.1.0
-    hooks:
-      - id: reuse
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
-    hooks:
-      - id: check-yaml
-      - id: end-of-file-fixer
-      - id: trailing-whitespace
-  - repo: https://github.com/pycqa/pylint
-    rev: v3.0.3
-    hooks:
-      - id: pylint
-        name: pylint (library code)
-        types: [python]
-        args:
-          - --disable=consider-using-f-string
-        exclude: "^(docs/|examples/|tests/|setup.py$)"
-      - id: pylint
-        name: pylint (example code)
-        description: Run pylint rules on "examples/*.py" files
-        types: [python]
-        files: "^examples/"
-        args:
-          - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code
-      - id: pylint
-        name: pylint (test code)
-        description: Run pylint rules on "tests/*.py" files
-        types: [python]
-        files: "^tests/"
-        args:
-          - --disable=missing-docstring,consider-using-f-string,duplicate-code