pmdsky-debug-py 10.0.10__tar.gz

pmdsky_debug_py-10.0.10/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.1
+Name: pmdsky-debug-py
+Version: 10.0.10
+Summary: pmdsky-debug symbols for Python.
+Author-email: Marco 'Capypara' Köpcke <hello@capypara.de>
+License: MIT
+Project-URL: repository, https://github.com/SkyTemple/pmdsky-debug-py
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+
+pmdsky-debug-py
+===============
+
+Autogenerated and statically check-able pmdsky-debug_ symbol definitions
+for Python.
+
+To use the symbols in your projects, you can install the package from PyPi::
+
+    pip install pmdsky-debug-py
+
+Symbols are grouped by regions. Each region implements the
+``pmdsky_debug_py.SymbolsProtocol``.
+
+To get a symbol, you can query it like this::
+
+    pmdsky_debug_py.eu.functions.InitMemAllocTable.address
+
+See the source code and the symbol definitions of pmdsky-debug_ for more information.
+
+See the `README.rst`_ on the root of the repository for additional information.
+
+.. _pmdsky-debug: https://github.com/UsernameFodder/pmdsky-debug
+.. _README.rst: https://github.com/SkyTemple/pmdsky-debug-py

pmdsky_debug_py-10.0.10/README.rst

@@ -0,0 +1,23 @@
+pmdsky-debug-py
+===============
+
+Autogenerated and statically check-able pmdsky-debug_ symbol definitions
+for Python.
+
+To use the symbols in your projects, you can install the package from PyPi::
+
+    pip install pmdsky-debug-py
+
+Symbols are grouped by regions. Each region implements the
+``pmdsky_debug_py.SymbolsProtocol``.
+
+To get a symbol, you can query it like this::
+
+    pmdsky_debug_py.eu.functions.InitMemAllocTable.address
+
+See the source code and the symbol definitions of pmdsky-debug_ for more information.
+
+See the `README.rst`_ on the root of the repository for additional information.
+
+.. _pmdsky-debug: https://github.com/UsernameFodder/pmdsky-debug
+.. _README.rst: https://github.com/SkyTemple/pmdsky-debug-py

pmdsky_debug_py-10.0.10/pmdsky_debug_py/__init__.py

@@ -0,0 +1,49 @@
+# Re-exports (you can still access everything 'manually' in the submodules if needed):
+# mypy: ignore-errors
+#                     <- (see https://github.com/python/mypy/issues/5018#issuecomment-1165828654)
+
+from typing import TYPE_CHECKING
+
+from pmdsky_debug_py.eu import EuSections as _EuSections
+from pmdsky_debug_py.na import NaSections as _NaSections
+from pmdsky_debug_py.jp import JpSections as _JpSections
+from pmdsky_debug_py.eu_itcm import EuItcmSections as _EuItcmSections
+from pmdsky_debug_py.na_itcm import NaItcmSections as _NaItcmSections
+from pmdsky_debug_py.jp_itcm import JpItcmSections as _JpItcmSections
+from pmdsky_debug_py.protocol import AllSymbolsProtocol
+from ._release import RELEASE
+
+eu: AllSymbolsProtocol = _EuSections
+na: AllSymbolsProtocol = _NaSections
+jp: AllSymbolsProtocol = _JpSections
+eu_itcm: AllSymbolsProtocol = _EuItcmSections
+na_itcm: AllSymbolsProtocol = _NaItcmSections
+jp_itcm: AllSymbolsProtocol = _JpItcmSections
+# not needed but to clarify these are indeed re-exports:
+AllSymbolsProtocol = AllSymbolsProtocol
+RELEASE = RELEASE
+
+
+# mypy tests:
+if TYPE_CHECKING:
+    def ___():
+        # First a general check making sure mypy understands this concept.
+        from typing import Protocol
+
+        class AProtocol(Protocol):
+            a: str
+
+        class A:
+            a = "a"
+
+        a: AProtocol = A
+
+        # Now specific tests
+        from pmdsky_debug_py.eu import EuArm9Section, EuArm9Functions, EuArm9Data
+        from pmdsky_debug_py.protocol import SectionProtocol, Arm9FunctionsProtocol, Arm9DataProtocol
+        eu_arm9: SectionProtocol = EuArm9Section
+        eu_arm9_fn: Arm9FunctionsProtocol = EuArm9Functions
+        eu_arm9_dt: Arm9DataProtocol = EuArm9Data
+
+        # And if everything works, the lines where `eu`, etc. are defined
+        # will also not fail.

pmdsky_debug_py-10.0.10/pmdsky_debug_py/_release.py

@@ -0,0 +1 @@
+RELEASE = "v0.10.0+71542670fc"