Fixups

.github/workflows/pr-test.yml

@@ -16,7 +16,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-latest, ubuntu-latest, windows-latest]
-        python-version: [3.8, 3.9, "3.10", 3.11, 3.12, 3.13]
+        python-version: [3.9, "3.10", 3.11, 3.12, 3.13]
 
     steps:
     - uses: actions/checkout@v3
@@ -33,8 +33,10 @@ jobs:
         pip install --prefer-binary -r requirements_tests.txt
     - name: Doctest
       if: ${{ !contains(matrix.os, 'windows') }}
+      env:
+        PYTEST_SECRETS_KEY: ${{ secrets.PYTEST_SECRETS_KEY }}
       run: |
-        python -m pytest pyboy/ -n auto
+        python -m pytest pyboy/ -v
     - name: Build PyBoy
       run: |
         python setup.py build_ext -j $(getconf _NPROCESSORS_ONLN) --inplace
@@ -50,6 +52,13 @@ jobs:
         TEST_NO_UI: 1
       run: |
         python -m pytest tests/ -n auto -v
+    - name: Run PyTest Benchmark
+      env:
+        PYTEST_SECRETS_KEY: ${{ secrets.PYTEST_SECRETS_KEY }}
+        TEST_VERBOSE_IMAGES: 0
+        TEST_NO_UI: 1
+      run: |
+        python -m pytest tests/test_benchmark.py --benchmark-enable --benchmark-min-rounds=10
     - name: Build wheel
       run: |
         echo "Building wheel"
@@ -106,8 +115,10 @@ jobs:
         pypy3 -m pip install --prefer-binary -r requirements_tests.txt
     - name: Doctest
       if: ${{ !contains(matrix.os, 'windows') }}
+      env:
+        PYTEST_SECRETS_KEY: ${{ secrets.PYTEST_SECRETS_KEY }}
       run: |
-        pypy3 -m pytest pyboy/ -n auto
+        pypy3 -m pytest pyboy/ -v
     - name: Run PyTest
       env:
         PYTEST_SECRETS_KEY: ${{ secrets.PYTEST_SECRETS_KEY }}
@@ -122,7 +133,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['cp38-cp38', 'cp39-cp39', 'cp310-cp310', 'cp311-cp311', 'cp312-cp312', 'cp313-cp313']
+        python-version: ['cp39-cp39', 'cp310-cp310', 'cp311-cp311', 'cp312-cp312', 'cp313-cp313']
         manylinux-version: ['manylinux_2_28_x86_64', 'musllinux_1_2_x86_64'] # GHA doesn't support manylinux_2_24_aarch64
 
     steps:
@@ -145,16 +156,22 @@ jobs:
           fi
 
           cd /work
-          echo "Starting build"
+          echo "Preparing pip"
           python -m pip install --upgrade pip
           python -m pip install --upgrade setuptools
 
           echo "Starting tests"
           python -m pip install --prefer-binary -r requirements.txt
+          python -m pip install --prefer-binary -r requirements_tests.txt
+
+          echo "Starting Doctests"
+          PYTEST_SECRETS_KEY=${{ secrets.PYTEST_SECRETS_KEY }} python -m pytest pyboy/ -v
+
+          echo "Building PyBoy"
           python setup.py build_ext -j $(getconf _NPROCESSORS_ONLN) --inplace
 
-          python -m pip install --prefer-binary -r requirements_tests.txt
-          PYTEST_SECRETS_KEY=${{ secrets.PYTEST_SECRETS_KEY }} TEST_CI=1 TEST_NO_UI=1 python -m pytest tests/ -n2 -v
+          echo "Starting pytests"
+          PYTEST_SECRETS_KEY=${{ secrets.PYTEST_SECRETS_KEY }} TEST_NO_UI=1 python -m pytest tests/ -n2 -v
 
           echo "Building wheel"
           python -m pip install wheel
@@ -170,10 +187,10 @@ jobs:
           echo "Dists built:"
           ls -lah dist/
 
-    - name: Set up Python 3.8 (just for PyPi upload)
+    - name: Set up Python 3.11 (just for PyPi upload)
       uses: actions/setup-python@v3
       with:
-        python-version: 3.8
+        python-version: 3.11
     - name: Upload wheel
       if: ${{ github.event_name == 'release' && github.event.action == 'published' && !github.event.release.prerelease }}
       run: |

.pre-commit-config.yaml

@@ -1,18 +1,10 @@
 exclude: (opcodes.py|manager.py|manager.pxd)
 repos:
-- repo: https://github.com/myint/unify
-  rev: v0.5
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.8.0
   hooks:
-    - id: unify
-      args: [--quote, '"', --in-place]
-      language: python
-      types: [python]
-- repo: https://github.com/google/yapf
-  rev: 'v0.40.2'
-  hooks:
-  - id: yapf
-    additional_dependencies: [toml]
-- repo: https://github.com/PyCQA/isort
-  rev: 5.12.0
-  hooks:
-  - id: isort
+    # Run the linter.
+    - id: ruff
+      args: [--select, I, --fix]
+    # Run the formatter.
+    - id: ruff-format

Makefile

@@ -1,5 +1,5 @@
 
-.PHONY: build clean run install test
+.PHONY: build clean run install test benchmark docs
 
 all: build
 
@@ -65,7 +65,7 @@ uninstall:
 	${PY} -m pip uninstall pyboy
 
 test: export DEBUG=1
-test: clean test_pypy test_cpython_doctest build test_cython
+test: clean test_pypy test_cpython_doctest build test_cython benchmark
 
 test_cpython_doctest:
 	${PY} -m pytest pyboy/ ${PYTEST_ARGS}
@@ -78,9 +78,13 @@ test_pypy:
 
 test_all: test
 
+benchmark:
+	${PY} -m pytest -m benchmark tests/test_benchmark.py --benchmark-enable --benchmark-min-rounds=10
+
 docs: clean
-	bash -O extglob -c 'rm -rf -- ${ROOT_DIR}/docs/!(templates|CNAME)'
+	find ./docs -type f ! -path "./docs/templates/*" ! -path "./docs/CNAME" ! -name "*.png" -exec rm -rf {} +
 	mkdir -p ${ROOT_DIR}/docs/templates
+	cd ${ROOT_DIR}/pyboy/plugins && ${PY} manager_gen.py
 	pdoc --html --force -c latex_math=True -c sort_identifiers=False -c show_type_annotations=True --template-dir docs/templates pyboy
 	cp -r html/pyboy/ ${ROOT_DIR}/docs/
 	rm -rf html

README.md

@@ -2,9 +2,9 @@
 <img src="extras/README/pyboy.svg" width="480">
 </p>
 
-__If you have any questions, or just want to chat, [join us on Discord](https://discord.gg/Zrf2nyH).__
+__If you have any questions, or just want to chat, [join us on Discord](https://discord.gg/wUbag3KNqQ).__
 
-[![Discord](https://img.shields.io/discord/584149554132418570?style=for-the-badge&logo=Discord&label=PyBoy)](https://discord.gg/Zrf2nyH)
+[![Discord](https://img.shields.io/discord/584149554132418570?style=for-the-badge&logo=Discord&label=PyBoy)](https://discord.gg/wUbag3KNqQ)
 
 <!---
 Generate GIF with the layout and captions
@@ -98,7 +98,7 @@ If you are looking to make a bot or AI, then these resources are a good place to
    * [Example: Tetris](https://github.com/Baekalfen/PyBoy/wiki/Example-Tetris)
    * [Example: Super Mario Land](https://github.com/Baekalfen/PyBoy/wiki/Example-Super-Mario-Land)
    * [Code Examples](https://github.com/Baekalfen/PyBoy/tree/master/extras/examples)
- * [Discord](https://discord.gg/Zrf2nyH)
+ * [Discord](https://discord.gg/wUbag3KNqQ)
 
 
 When the emulator is running, you can easily access [PyBoy's API](https://baekalfen.github.io/PyBoy/index.html):
@@ -186,9 +186,9 @@ do 3160 hours of gameplay in 1 hour.
 
 Contributing
 ============
-Any contribution is appreciated. The currently known problems are tracked in [the Issues tab](https://github.com/Baekalfen/PyBoy/issues). Feel free to take a swing at any one of them. If you have something original in mind, come and [discuss it on on Discord](https://discord.gg/Zrf2nyH).
+Any contribution is appreciated. The currently known problems are tracked in [the Issues tab](https://github.com/Baekalfen/PyBoy/issues). Feel free to take a swing at any one of them. If you have something original in mind, come and [discuss it on on Discord](https://discord.gg/wUbag3KNqQ).
 
-[![Discord](https://img.shields.io/discord/584149554132418570?style=for-the-badge&logo=Discord&label=PyBoy)](https://discord.gg/Zrf2nyH)
+[![Discord](https://img.shields.io/discord/584149554132418570?style=for-the-badge&logo=Discord&label=PyBoy)](https://discord.gg/wUbag3KNqQ)
 
 For the more major features, there are the following that you can give a try. They are also described in more detail in the [project list in the Wiki](https://github.com/Baekalfen/PyBoy/wiki/Student-Projects):
 * Hacking games

docs/api/gameshark.html

@@ -46,7 +46,7 @@ <h1 class="title">Module <code>pyboy.api.gameshark</code></h1>
         self.enabled = False
 
     def _convert_cheat(self, gameshark_code):
-        &#39;&#39;&#39;
+        &#34;&#34;&#34;
         A GameShark code for these consoles is written in the format ttvvaaaa. tt specifies the type, which is usually 01.
         vv specifies the hexadecimal value the code will write into the game&#39;s memory. aaaa specifies the memory address
         that will be modified, with the low byte first (e.g. address C056 is written as 56C0).
@@ -59,18 +59,18 @@ <h1 class="title">Module <code>pyboy.api.gameshark</code></h1>
         https://doc.kodewerx.org/hacking_gb.html
 
         There seems to be conflicting information about the presence of other types than 01.
-        &#39;&#39;&#39;
+        &#34;&#34;&#34;
         # Check if the input cheat code has the correct length (8 characters)
         if len(gameshark_code) != 8:
             raise ValueError(&#34;Invalid cheat code length. Cheat code must be 8 characters long.&#34;)
 
         # Extract components from the cheat code
         _type = int(gameshark_code[:2], 16)
-        value = int(gameshark_code[2:4], 16) # Convert hexadecimal value to an integer
-        unconverted_address = gameshark_code[4:] # Ex:   1ED1
-        lower = unconverted_address[:2] # Ex:  1E
-        upper = unconverted_address[2:] # Ex:  D1
-        address_converted = upper + lower # Ex: 0xD11E   # Converting to Ram Readable address
+        value = int(gameshark_code[2:4], 16)  # Convert hexadecimal value to an integer
+        unconverted_address = gameshark_code[4:]  # Ex:   1ED1
+        lower = unconverted_address[:2]  # Ex:  1E
+        upper = unconverted_address[2:]  # Ex:  D1
+        address_converted = upper + lower  # Ex: 0xD11E   # Converting to Ram Readable address
         address = int(address_converted, 16)
 
         if not 0x8000 &lt;= address:
@@ -210,7 +210,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         self.enabled = False
 
     def _convert_cheat(self, gameshark_code):
-        &#39;&#39;&#39;
+        &#34;&#34;&#34;
         A GameShark code for these consoles is written in the format ttvvaaaa. tt specifies the type, which is usually 01.
         vv specifies the hexadecimal value the code will write into the game&#39;s memory. aaaa specifies the memory address
         that will be modified, with the low byte first (e.g. address C056 is written as 56C0).
@@ -223,18 +223,18 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         https://doc.kodewerx.org/hacking_gb.html
 
         There seems to be conflicting information about the presence of other types than 01.
-        &#39;&#39;&#39;
+        &#34;&#34;&#34;
         # Check if the input cheat code has the correct length (8 characters)
         if len(gameshark_code) != 8:
             raise ValueError(&#34;Invalid cheat code length. Cheat code must be 8 characters long.&#34;)
 
         # Extract components from the cheat code
         _type = int(gameshark_code[:2], 16)
-        value = int(gameshark_code[2:4], 16) # Convert hexadecimal value to an integer
-        unconverted_address = gameshark_code[4:] # Ex:   1ED1
-        lower = unconverted_address[:2] # Ex:  1E
-        upper = unconverted_address[2:] # Ex:  D1
-        address_converted = upper + lower # Ex: 0xD11E   # Converting to Ram Readable address
+        value = int(gameshark_code[2:4], 16)  # Convert hexadecimal value to an integer
+        unconverted_address = gameshark_code[4:]  # Ex:   1ED1
+        lower = unconverted_address[:2]  # Ex:  1E
+        upper = unconverted_address[2:]  # Ex:  D1
+        address_converted = upper + lower  # Ex: 0xD11E   # Converting to Ram Readable address
         address = int(address_converted, 16)
 
         if not 0x8000 &lt;= address:

docs/api/index.html

@@ -42,8 +42,10 @@ <h1 class="title">Module <code>pyboy.api</code></h1>
 from .tilemap import TileMap
 
 # __pdoc__ = {
-#     &#34;gameshark.GameShark.tick&#34;: False,
-# }</code></pre>
+#     &#34;constants&#34;: False,
+#     &#34;manager&#34;: False,
+# }
+# __all__ = [&#34;API&#34;]</code></pre>
 </details>
 </section>
 <section>