pite-stubs 0.4.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
pite/__init__.py ADDED
@@ -0,0 +1,19 @@
1
+ # SPDX-License-Identifier: MIT OR Apache-2.0
2
+ """Type stubs for the Pite engine's embedded ``pite`` module.
3
+
4
+ The real module is native: the engine registers it from Rust through PyO3
5
+ inside the CPython interpreter it embeds. It cannot be installed or imported
6
+ from a normal Python environment, so this distribution (``pite-stubs`` on
7
+ PyPI) ships ``__init__.pyi`` only.
8
+
9
+ Install it as a development dependency so Pylance/Pyright resolve
10
+ ``import pite`` and offer autocomplete outside the Pite editor. Run the
11
+ project with ``pite edit`` / ``pite run``.
12
+ """
13
+
14
+ raise ImportError(
15
+ "The `pite` module is provided by the Pite engine's embedded interpreter, "
16
+ "not by pip. This package ships type stubs only: install it as a dev "
17
+ "dependency for autocomplete, and run the project with `pite edit` or "
18
+ "`pite run`. See https://github.com/piteengine/pite"
19
+ )
pite/__init__.pyi ADDED
@@ -0,0 +1,165 @@
1
+ # SPDX-License-Identifier: MIT OR Apache-2.0
2
+ # AUTO-GENERATED from pite_core::NODE_SCHEMAS — do not edit by hand.
3
+ # Regenerate by building pite-editor; source in crates/pite-editor/build.rs.
4
+ from __future__ import annotations
5
+
6
+ from typing import Any, Callable, Generic, Iterator, TypeVar, overload
7
+
8
+ _T = TypeVar("_T")
9
+
10
+ class Signal(Generic[_T]):
11
+ def emit(self, *values: _T) -> None: ...
12
+ def connect(self, handler: Callable[..., None]) -> None: ...
13
+
14
+ @overload
15
+ def signal() -> Signal[None]: ...
16
+ @overload
17
+ def signal(first: type[_T], *rest: type[object]) -> Signal[_T]: ...
18
+
19
+ class Vec2:
20
+ x: float
21
+ y: float
22
+ def __init__(self, x: float = 0.0, y: float = 0.0) -> None: ...
23
+ def __add__(self, other: Vec2 | tuple[float, float]) -> Vec2: ...
24
+ def __sub__(self, other: Vec2 | tuple[float, float]) -> Vec2: ...
25
+ def __mul__(self, scalar: float) -> Vec2: ...
26
+ def __rmul__(self, scalar: float) -> Vec2: ...
27
+ def __truediv__(self, scalar: float) -> Vec2: ...
28
+ def __iadd__(self, other: Vec2 | tuple[float, float]) -> Vec2: ...
29
+ def __isub__(self, other: Vec2 | tuple[float, float]) -> Vec2: ...
30
+ def __imul__(self, scalar: float) -> Vec2: ...
31
+ def __itruediv__(self, scalar: float) -> Vec2: ...
32
+ def __len__(self) -> int: ...
33
+ def __getitem__(self, idx: int) -> float: ...
34
+ def __setitem__(self, idx: int, val: float) -> None: ...
35
+ def __iter__(self) -> Iterator[float]: ...
36
+ def length(self) -> float: ...
37
+ def normalized(self) -> Vec2: ...
38
+ def to_tuple(self) -> tuple[float, float]: ...
39
+
40
+ class InputQuery:
41
+ def __getattr__(self, name: str) -> bool: ...
42
+
43
+ held: InputQuery
44
+ pressed: InputQuery
45
+ released: InputQuery
46
+
47
+ class ChildDescriptor:
48
+ def __get__(self, instance: object, owner: type[object] | None = None) -> Node: ...
49
+
50
+ class NodeDescriptor:
51
+ def __get__(self, instance: object, owner: type[object] | None = None) -> Node: ...
52
+
53
+ def mouse() -> Vec2: ...
54
+ def frames(atlas: str) -> list[str]: ...
55
+ def play(path: str, volume: float = ...) -> int: ...
56
+ def stop(id: int) -> None: ...
57
+ def set_volume(id: int, volume: float) -> None: ...
58
+ def is_playing(id: int) -> bool: ...
59
+ def child(name: str) -> ChildDescriptor: ...
60
+ def node(path: str) -> NodeDescriptor: ...
61
+ def raycast(from_pos: tuple[float, float] | Vec2, to_pos: tuple[float, float] | Vec2, mask: int = ...) -> dict[str, Any] | None: ...
62
+
63
+ class Node:
64
+ node_path: str
65
+ def get_node(self, path: str) -> Node: ...
66
+ def get_custom_property(self, key: str) -> Any: ...
67
+ def set_custom_property(self, key: str, value: Any) -> None: ...
68
+ def remove_custom_property(self, key: str) -> bool: ...
69
+ def _ready(self) -> None: ...
70
+ def _process(self, delta: float) -> None: ...
71
+ def _physics_process(self, delta: float) -> None: ...
72
+ def __getattr__(self, name: str) -> Any: ...
73
+ def __setattr__(self, name: str, value: Any) -> None: ...
74
+
75
+ class Node2D(Node):
76
+ position: Vec2
77
+ rotation: float
78
+
79
+ class Sprite2D(Node2D):
80
+ texture: str
81
+ atlas: str
82
+ frame: str
83
+
84
+ class AnimatedSprite2D(Node2D):
85
+ atlas: str
86
+ animation: str
87
+ frame: int
88
+ speed_scale: float
89
+ playing: bool
90
+ autoplay: str
91
+ animation_finished: Signal
92
+ animation_looped: Signal
93
+ def play(self, animation: str | None = None, loop_override: bool | None = None) -> None: ...
94
+ def pause(self) -> None: ...
95
+ def stop(self) -> None: ...
96
+ def is_playing(self) -> bool: ...
97
+
98
+ class Camera2D(Node2D):
99
+ zoom: float
100
+
101
+ class CollisionShape2D(Node2D):
102
+ shape: str
103
+ size: Vec2
104
+ radius: float
105
+ height: float
106
+ disabled: bool
107
+
108
+ class Area2D(Node2D):
109
+ collision_layer: int
110
+ collision_mask: int
111
+ body_entered: Signal
112
+ body_exited: Signal
113
+ area_entered: Signal
114
+ area_exited: Signal
115
+
116
+ class StaticBody2D(Node2D):
117
+ collision_layer: int
118
+ collision_mask: int
119
+ friction: float
120
+ restitution: float
121
+
122
+ class RigidBody2D(Node2D):
123
+ mass: float
124
+ gravity_scale: float
125
+ restitution: float
126
+ friction: float
127
+ lock_rotation: bool
128
+ collision_layer: int
129
+ collision_mask: int
130
+ def apply_impulse(self, impulse: tuple[float, float] | Vec2) -> None: ...
131
+ def apply_force(self, force: tuple[float, float] | Vec2) -> None: ...
132
+
133
+ class CharacterBody2D(Node2D):
134
+ velocity: Vec2
135
+ up_direction: Vec2
136
+ friction: float
137
+ restitution: float
138
+ collision_layer: int
139
+ collision_mask: int
140
+ is_on_floor: bool
141
+ is_on_wall: bool
142
+ is_on_ceiling: bool
143
+ def move_and_slide(self) -> bool: ...
144
+
145
+ class TileMap2D(Node2D):
146
+ ...
147
+
148
+ class Label(Node2D):
149
+ text: str
150
+ font_size: float
151
+ color: tuple[int, int, int, int]
152
+
153
+ class Button(Node2D):
154
+ text: str
155
+ size: Vec2
156
+ font_size: float
157
+ color: tuple[int, int, int, int]
158
+ disabled: bool
159
+ pressed: Signal
160
+
161
+ class Timer(Node):
162
+ wait_time: float
163
+ current_elapsed: float
164
+ timeout: Signal
165
+
pite/py.typed ADDED
File without changes
@@ -0,0 +1,84 @@
1
+ Metadata-Version: 2.5
2
+ Name: pite-stubs
3
+ Version: 0.4.0
4
+ Summary: Type stubs for the Pite engine's embedded Python API (PEP 561).
5
+ Project-URL: Homepage, https://github.com/piteengine/pite
6
+ Project-URL: Documentation, https://piteengine.github.io/pite/
7
+ Project-URL: Repository, https://github.com/piteengine/pite
8
+ Project-URL: Issues, https://github.com/piteengine/pite/issues
9
+ Author: Pite Contributors
10
+ License-Expression: MIT OR Apache-2.0
11
+ License-File: LICENSE-APACHE
12
+ License-File: LICENSE-MIT
13
+ Keywords: game-engine,gamedev,pylance,pyright,stubs,typing
14
+ Classifier: Development Status :: 4 - Beta
15
+ Classifier: Intended Audience :: Developers
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3 :: Only
18
+ Classifier: Topic :: Software Development :: Libraries
19
+ Classifier: Typing :: Stubs Only
20
+ Requires-Python: >=3.9
21
+ Description-Content-Type: text/markdown
22
+
23
+ # pite-stubs — type stubs for Pite
24
+
25
+ Type stubs (PEP 561) for the `pite` Python module, which the
26
+ [Pite](https://github.com/piteengine/pite) game engine embeds in its own
27
+ CPython interpreter.
28
+
29
+ The distribution is named `pite-stubs` because PyPI rejects `pite` as too
30
+ similar to existing projects. The import name is still `pite`: it is the
31
+ engine's native module, so `pip install pite-stubs` gives your editor types
32
+ for `import pite`.
33
+
34
+ The module is native (registered from Rust via PyO3), so it is **not
35
+ importable** from a normal Python environment. This package exists purely so
36
+ editors and type checkers — Pylance/Pyright — resolve `import pite` and offer
37
+ autocompletion and diagnostics when you work on a Pite project outside the
38
+ built-in editor.
39
+
40
+ ## Install
41
+
42
+ ```sh
43
+ pip install pite-stubs
44
+ ```
45
+
46
+ Add it to your project's development dependencies, not to the game's runtime
47
+ dependencies: scripts always execute inside the engine (`pite edit`,
48
+ `pite run`), never in the venv where the stubs are installed.
49
+
50
+ ## What you get
51
+
52
+ ```python
53
+ import pite
54
+
55
+
56
+ class Player(pite.Node2D):
57
+ hud = pite.child("HUD") # resolved lazily to a Node at access time
58
+ hit = pite.signal(int)
59
+
60
+ def _ready(self) -> None:
61
+ self.hit.connect(self._on_hit)
62
+
63
+ def _process(self, delta: float) -> None:
64
+ self.position += pite.Vec2(1.0, 0.0)
65
+
66
+ def _on_hit(self, amount: int) -> None:
67
+ self.hud.get_node("../ScoreLabel").text = f"Score: {amount}"
68
+ ```
69
+
70
+ Every node class, property, method, and free function from the engine's schema
71
+ is covered. Signal payloads are typed through `pite.signal(...)`, and
72
+ `pite.child(...)` / `pite.node(...)` resolve to `Node` through descriptor
73
+ typing.
74
+
75
+ ## Runtime behaviour
76
+
77
+ `import pite` raises `ImportError` in a normal interpreter, with a message
78
+ pointing back at the engine. That is intentional: the name belongs to the
79
+ engine's native module, and failing loudly beats an empty module that silently
80
+ does nothing.
81
+
82
+ ## License
83
+
84
+ MIT OR Apache-2.0, matching the engine.
@@ -0,0 +1,8 @@
1
+ pite/__init__.py,sha256=0r7bEXQRXCDea4CT1iwGr3KEqsnmWNeYNeUNvak9lQc,864
2
+ pite/__init__.pyi,sha256=4wTrhseUBJ61pGLTTpe4wDAiOhwS_wd4Djq3nJS0nug,4837
3
+ pite/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
4
+ pite_stubs-0.4.0.dist-info/METADATA,sha256=Afn8HkmLbTZLBW9W7UY51r0iHDM66DKNqRk91alLW-Q,2902
5
+ pite_stubs-0.4.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
6
+ pite_stubs-0.4.0.dist-info/licenses/LICENSE-APACHE,sha256=cUtNx6Fi7U4wA131cW8Ln-nOXfVuDe6YRBka6DaW0t0,10773
7
+ pite_stubs-0.4.0.dist-info/licenses/LICENSE-MIT,sha256=tJlGhvb_nmS767995U9aXa14lcaPpU3UjZZIIXCRuC0,1074
8
+ pite_stubs-0.4.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.33.0
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -0,0 +1,199 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ Use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. Please also get an
185
+ identifier for the file format in the following table, if available.
186
+
187
+ Copyright [yyyy] [name of copyright owner]
188
+
189
+ Licensed under the Apache License, Version 2.0 (the "License");
190
+ you may not use this file except in compliance with the License.
191
+ You may obtain a copy of the License at
192
+
193
+ http://www.apache.org/licenses/LICENSE-2.0
194
+
195
+ Unless required by applicable law or agreed to in writing, software
196
+ distributed under the License is distributed on an "AS IS" BASIS,
197
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
198
+ See the License for the specific language governing permissions and
199
+ limitations under the License.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Pite Contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.