init repo

Author: 2bndy5

.gitattributes

@@ -0,0 +1,14 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Explicitly declare text files you want to always be normalized and converted
+# to native line endings on checkout.
+*.py text eol=lf
+*.rst text eol=lf
+.gitattributes text eol=lf
+.gitignore text eol=lf
+*.yaml text eol=lf
+*.yml text eol=lf
+LICENSE text eol=lf
+*.toml text eol=lf
+*.txt text eol=lf

.gitignore

@@ -0,0 +1,129 @@
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build*/
+bundles/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/social_cards_cache/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# VS Code folder
+.vscode

.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: requirements-txt-fixer
+      - id: mixed-line-ending
+        args: ["--fix=lf"]
+      - id: check-added-large-files
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.11.0
+    hooks:
+      - id: mypy
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.5.2
+    hooks:
+      # Run the python linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the python formatter.
+      - id: ruff-format

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Brendan Doherty
+
+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.

README.rst

@@ -0,0 +1,10 @@
+
+Read The Docs
+=============
+
+Documentation for this library is hosted at https://circuitpython-nrf24l01.rtfd.io/
+
+About this Library
+==================
+
+This is a library of mock data structures to be used in soft-testing Circuitpython code.

circuitpython_mocks/__init__.py

@@ -0,0 +1,8 @@
+from pathlib import Path
+import pytest
+
+
+@pytest.fixture(autouse=True)
+def monkey_patch_sys_paths(monkeypatch: pytest.MonkeyPatch):
+    root_pkg = Path(__file__).parent
+    monkeypatch.syspath_prepend(str(root_pkg))

circuitpython_mocks/_mixins.py

@@ -0,0 +1,56 @@
+from typing import Self
+from collections import deque
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from circuitpython_mocks.busio.operations import Read, Write, Transfer
+    from circuitpython_mocks.digitalio.operations import SetState, GetState
+
+
+class ContextManaged:
+    """An object that automatically deinitializes hardware with a context manager."""
+
+    def __enter__(self) -> Self:
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        self.deinit()
+
+    def deinit(self):
+        """Free any hardware used by the object."""
+        return
+
+
+class Lockable(ContextManaged):
+    """An object that must be locked to prevent collisions on a microcontroller resource."""
+
+    _locked = False
+
+    def try_lock(self):
+        """Attempt to grab the lock. Return True on success, False if the lock is already taken."""
+        if self._locked:
+            return False
+        self._locked = True
+        return True
+
+    def unlock(self):
+        """Release the lock so others may use the resource."""
+        if self._locked:
+            self._locked = False
+
+
+class Expecting:
+    def __init__(self, **kwargs) -> None:
+        self.expectations: deque[Read | Write | Transfer | SetState | GetState] = (
+            deque()
+        )
+        super().__init__(**kwargs)
+
+    def done(self):
+        assert not self.expectations, (
+            "Some expectations were unused:\n    "
+            + "\n    ".join([repr(x) for x in self.expectations])
+        )
+
+    def __del__(self):
+        self.done()

circuitpython_mocks/board.py

@@ -0,0 +1,128 @@
+"""Mock pins"""
+
+class Pin:
+    pass
+
+
+D0 = Pin()
+D1 = Pin()
+D2 = Pin()
+D3 = Pin()
+D4 = Pin()
+D5 = Pin()
+D6 = Pin()
+D7 = Pin()
+D8 = Pin()
+D9 = Pin()
+D10 = Pin()
+D11 = Pin()
+D12 = Pin()
+D13 = Pin()
+D14 = Pin()
+D15 = Pin()
+D16 = Pin()
+D17 = Pin()
+D18 = Pin()
+D19 = Pin()
+D20 = Pin()
+D21 = Pin()
+D22 = Pin()
+D23 = Pin()
+D24 = Pin()
+D25 = Pin()
+D26 = Pin()
+D27 = Pin()
+D28 = Pin()
+D29 = Pin()
+D30 = Pin()
+D31 = Pin()
+D32 = Pin()
+D33 = Pin()
+D34 = Pin()
+D35 = Pin()
+D36 = Pin()
+D37 = Pin()
+D38 = Pin()
+D39 = Pin()
+D40 = Pin()
+D41 = Pin()
+D42 = Pin()
+D43 = Pin()
+D44 = Pin()
+D45 = Pin()
+D46 = Pin()
+D47 = Pin()
+D48 = Pin()
+D49 = Pin()
+D50 = Pin()
+D51 = Pin()
+D52 = Pin()
+D53 = Pin()
+D54 = Pin()
+D55 = Pin()
+D56 = Pin()
+D57 = Pin()
+D58 = Pin()
+D59 = Pin()
+D60 = Pin()
+D61 = Pin()
+D62 = Pin()
+D63 = Pin()
+D64 = Pin()
+D65 = Pin()
+D66 = Pin()
+D67 = Pin()
+D68 = Pin()
+D69 = Pin()
+D70 = Pin()
+D71 = Pin()
+D72 = Pin()
+D73 = Pin()
+D74 = Pin()
+D75 = Pin()
+D76 = Pin()
+D77 = Pin()
+D78 = Pin()
+D79 = Pin()
+D80 = Pin()
+D81 = Pin()
+D82 = Pin()
+D83 = Pin()
+D84 = Pin()
+D85 = Pin()
+D86 = Pin()
+D87 = Pin()
+D88 = Pin()
+D89 = Pin()
+D90 = Pin()
+D91 = Pin()
+D92 = Pin()
+D93 = Pin()
+D94 = Pin()
+D95 = Pin()
+D96 = Pin()
+D97 = Pin()
+D98 = Pin()
+D99 = Pin()
+
+SDA = Pin()
+SCL = Pin()
+
+CE1 = Pin()
+CE0 = Pin()
+MISO = Pin()
+MOSI = Pin()
+SCLK = Pin()
+SCK = Pin()
+
+TXD = Pin()
+RXD = Pin()
+
+# create alias for most of the examples
+TX = Pin()
+RX = Pin()
+
+MISO_1 = Pin()
+MOSI_1 = Pin()
+SCLK_1 = Pin()
+SCK_1 = Pin()