pulse-framework 0.1.55__py3-none-any.whl → 0.1.57__py3-none-any.whl

pulse/js/__init__.py

@@ -1,29 +1,45 @@
 """JavaScript module bindings for use in @javascript decorated functions (transpiler).
 
-Usage:
-    # Import JS classes (for constructors and static methods):
-    from pulse.js import Set, Number, Array, Date, Promise, Map, Error
-    Set([1, 2, 3])         # -> new Set([1, 2, 3])
-    Number.isFinite(42)    # -> Number.isFinite(42)
-    Array.isArray(x)       # -> Array.isArray(x)
-
-    # Import JS namespace objects (function-only modules):
-    from pulse.js import Math, JSON, console, window, document, navigator
-    Math.floor(3.7)        # -> Math.floor(3.7)
-    JSON.stringify(obj)    # -> JSON.stringify(obj)
-    console.log("hi")      # -> console.log("hi")
-
-    # Alternative: import namespace modules for namespace access:
-    import pulse.js.json as JSON
-    JSON.stringify(obj)    # -> JSON.stringify(obj)
-
-    # Statement functions:
-    from pulse.js import throw
-    throw(Error("message"))  # -> throw Error("message");
-
-    # Object literals (plain JS objects instead of Map):
-    from pulse.js import obj
-    obj(a=1, b=2)          # -> { a: 1, b: 2 }
+## Usage
+
+Import JS classes (for constructors and static methods):
+
+```python
+from pulse.js import Set, Number, Array, Date, Promise, Map, Error
+Set([1, 2, 3])         # -> new Set([1, 2, 3])
+Number.isFinite(42)    # -> Number.isFinite(42)
+Array.isArray(x)       # -> Array.isArray(x)
+```
+
+Import JS namespace objects (function-only modules):
+
+```python
+from pulse.js import Math, JSON, console, window, document, navigator
+Math.floor(3.7)        # -> Math.floor(3.7)
+JSON.stringify(obj)    # -> JSON.stringify(obj)
+console.log("hi")      # -> console.log("hi")
+```
+
+Alternative: import namespace modules for namespace access:
+
+```python
+import pulse.js.json as JSON
+JSON.stringify(obj)    # -> JSON.stringify(obj)
+```
+
+Statement functions:
+
+```python
+from pulse.js import throw
+throw(Error("message"))  # -> throw Error("message");
+```
+
+Object literals (plain JS objects instead of Map):
+
+```python
+from pulse.js import obj
+obj(a=1, b=2)          # -> { a: 1, b: 2 }
+```
 """
 
 import importlib as _importlib

pulse/js/array.py

@@ -2,13 +2,16 @@
 JavaScript Array builtin module.
 
 Usage:
-    from pulse.js import Array
-    Array.isArray([1, 2, 3])      # -> Array.isArray([1, 2, 3])
-    Array.from_([1, 2, 3])        # -> Array.from([1, 2, 3])
-    Array(10)                     # -> new Array(10)
 
-    # Or import from module directly:
-    from pulse.js.array import Array
+```python
+from pulse.js import Array
+Array.isArray([1, 2, 3])      # -> Array.isArray([1, 2, 3])
+Array.from_([1, 2, 3])        # -> Array.from([1, 2, 3])
+Array(10)                     # -> new Array(10)
+
+# Or import from module directly:
+from pulse.js.array import Array
+```
 """
 
 from __future__ import annotations

pulse/js/console.py

@@ -2,18 +2,21 @@
 JavaScript Console builtin module.
 
 Usage:
-    import pulse.js.console as console
-    console.log("Hello")          # -> console.log("Hello")
-    console.error("Error")        # -> console.error("Error")
-    console.assert(True, "msg")   # -> console.assert(True, "msg")
-
-    # Note: For 'assert' (Python keyword), use namespace import:
-    # import pulse.js.console as console; console.assert(...)
-    # Or use the underscore version for direct import:
-    from pulse.js.console import log, error, warn, info, debug, assert_
-    log("Hello")                  # -> console.log("Hello")
-    error("Error")                # -> console.error("Error")
-    assert_(True, "msg")          # -> console.assert(True, "msg")
+
+```python
+import pulse.js.console as console
+console.log("Hello")          # -> console.log("Hello")
+console.error("Error")        # -> console.error("Error")
+console.assert(True, "msg")   # -> console.assert(True, "msg")
+
+# Note: For 'assert' (Python keyword), use namespace import:
+# import pulse.js.console as console; console.assert(...)
+# Or use the underscore version for direct import:
+from pulse.js.console import log, error, warn, info, debug, assert_
+log("Hello")                  # -> console.log("Hello")
+error("Error")                # -> console.error("Error")
+assert_(True, "msg")          # -> console.assert(True, "msg")
+```
 """
 
 from typing import Any as _Any

pulse/js/date.py

@@ -2,13 +2,16 @@
 JavaScript Date builtin module.
 
 Usage:
-    from pulse.js import Date
-    Date()                        # -> new Date()
-    Date.now()                    # -> Date.now()
-    Date.parse("2023-01-01")      # -> Date.parse("2023-01-01")
 
-    # Or import from module directly:
-    from pulse.js.date import Date
+```python
+from pulse.js import Date
+Date()                        # -> new Date()
+Date.now()                    # -> Date.now()
+Date.parse("2023-01-01")      # -> Date.parse("2023-01-01")
+
+# Or import from module directly:
+from pulse.js.date import Date
+```
 """
 
 from typing import Any as _Any

pulse/js/document.py

@@ -1,8 +1,11 @@
 """Browser document global object.
 
 Usage:
-    from pulse.js import document
-    document.querySelector("#app")      # -> document.querySelector("#app")
+
+```python
+from pulse.js import document
+document.querySelector("#app")      # -> document.querySelector("#app")
+```
 """
 
 from collections.abc import Callable as _Callable

pulse/js/error.py

@@ -2,11 +2,14 @@
 JavaScript Error builtin module.
 
 Usage:
-    from pulse.js import Error
-    Error("message")              # -> new Error("message")
 
-    from pulse.js.error import TypeError, RangeError, ReferenceError
-    TypeError("message")         # -> new TypeError("message")
+```python
+from pulse.js import Error
+Error("message")              # -> new Error("message")
+
+from pulse.js.error import TypeError, RangeError, ReferenceError
+TypeError("message")         # -> new TypeError("message")
+```
 """
 
 from pulse.transpiler.js_module import JsModule

pulse/js/json.py

@@ -2,13 +2,16 @@
 JavaScript JSON builtin module.
 
 Usage:
-    import pulse.js.json as JSON
-    JSON.stringify({"a": 1})      # -> JSON.stringify({"a": 1})
-    JSON.parse('{"a": 1}')        # -> JSON.parse('{"a": 1}')
 
-    from pulse.js.json import stringify, parse
-    stringify({"a": 1})           # -> JSON.stringify({"a": 1})
-    parse('{"a": 1}')             # -> JSON.parse('{"a": 1}')
+```python
+import pulse.js.json as JSON
+JSON.stringify({"a": 1})      # -> JSON.stringify({"a": 1})
+JSON.parse('{"a": 1}')        # -> JSON.parse('{"a": 1}')
+
+from pulse.js.json import stringify, parse
+stringify({"a": 1})           # -> JSON.stringify({"a": 1})
+parse('{"a": 1}')             # -> JSON.parse('{"a": 1}')
+```
 """
 
 from collections.abc import Callable as _Callable

pulse/js/map.py

@@ -2,12 +2,15 @@
 JavaScript Map builtin module.
 
 Usage:
-    from pulse.js import Map
-    Map()                         # -> new Map()
-    Map([["a", 1]])              # -> new Map([["a", 1]])
 
-    # Or import from module directly:
-    from pulse.js.map import Map
+```python
+from pulse.js import Map
+Map()                         # -> new Map()
+Map([["a", 1]])              # -> new Map([["a", 1]])
+
+# Or import from module directly:
+from pulse.js.map import Map
+```
 """
 
 from collections.abc import Callable as _Callable

pulse/js/math.py

@@ -2,13 +2,16 @@
 JavaScript Math builtin module.
 
 Usage:
-    import pulse.js.math as Math
-    Math.PI           # -> Math.PI
-    Math.floor(3.7)   # -> Math.floor(3.7)
 
-    from pulse.js.math import PI, floor
-    PI                # -> Math.PI
-    floor(3.7)        # -> Math.floor(3.7)
+```python
+import pulse.js.math as Math
+Math.PI           # -> Math.PI
+Math.floor(3.7)   # -> Math.floor(3.7)
+
+from pulse.js.math import PI, floor
+PI                # -> Math.PI
+floor(3.7)        # -> Math.floor(3.7)
+```
 """
 
 from pulse.transpiler.js_module import JsModule

pulse/js/navigator.py

@@ -1,8 +1,11 @@
 """Browser navigator global object.
 
 Usage:
-    from pulse.js import navigator, console
-    console.log(navigator.userAgent)
+
+```python
+from pulse.js import navigator, console
+console.log(navigator.userAgent)
+```
 """
 
 from typing import Any as _Any

pulse/js/number.py

@@ -2,13 +2,16 @@
 JavaScript Number builtin module.
 
 Usage:
-    from pulse.js import Number
-    Number.isFinite(42)       # -> Number.isFinite(42)
-    Number.MAX_SAFE_INTEGER   # -> Number.MAX_SAFE_INTEGER
-    Number(x)                 # -> new Number(x)
 
-    # Or import from module directly:
-    from pulse.js.number import Number
+```python
+from pulse.js import Number
+Number.isFinite(42)       # -> Number.isFinite(42)
+Number.MAX_SAFE_INTEGER   # -> Number.MAX_SAFE_INTEGER
+Number(x)                 # -> new Number(x)
+
+# Or import from module directly:
+from pulse.js.number import Number
+```
 """
 
 from typing import Any as _Any

pulse/js/obj.py

@@ -2,19 +2,22 @@
 JavaScript object literal creation.
 
 Usage:
-    from pulse.js import obj
 
-    # Create plain JS objects (not Maps):
-    obj(a=1, b=2)          # -> { a: 1, b: 2 }
+```python
+from pulse.js import obj
 
-    # With spread syntax:
-    obj(**base, c=3)       # -> { ...base, c: 3 }
-    obj(a=1, **base)       # -> { a: 1, ...base }
+# Create plain JS objects (not Maps):
+obj(a=1, b=2)          # -> { a: 1, b: 2 }
 
-    # Empty object:
-    obj()                  # -> {}
+# With spread syntax:
+obj(**base, c=3)       # -> { ...base, c: 3 }
+obj(a=1, **base)       # -> { a: 1, ...base }
 
-Unlike dict() which transpiles to new Map(), obj() creates plain JavaScript
+# Empty object:
+obj()                  # -> {}
+```
+
+Unlike `dict()` which transpiles to `new Map()`, `obj()` creates plain JavaScript
 object literals. Use this for React props, style objects, and anywhere you
 need a plain JS object.
 """
@@ -36,13 +39,13 @@ if TYPE_CHECKING:
 
 @dataclass(slots=True)
 class ObjTransformer(Expr):
-	"""Transformer for obj() with **spread support.
+	"""Transformer for `obj()` with `**spread` support.
 
-	obj(key=value, ...) -> { key: value, ... }
-	obj(**base, key=value) -> { ...base, key: value }
+	- `obj(key=value, ...)` -> `{ key: value, ... }`
+	- `obj(**base, key=value)` -> `{ ...base, key: value }`
 
 	Creates a plain JavaScript object literal.
-	Use this instead of dict() when you need a plain object (e.g., for React props).
+	Use this instead of `dict()` when you need a plain object (e.g., for React props).
 	"""
 
 	@override

pulse/js/object.py

@@ -2,13 +2,16 @@
 JavaScript Object builtin module.
 
 Usage:
-    from pulse.js import Object
-    Object.keys({"a": 1})         # -> Object.keys({"a": 1})
-    Object.assign({}, {"a": 1})   # -> Object.assign({}, {"a": 1})
-    Object.is_(x, y)              # -> Object.is(x, y)
 
-    # Or import from module directly:
-    from pulse.js.object import Object
+```python
+from pulse.js import Object
+Object.keys({"a": 1})         # -> Object.keys({"a": 1})
+Object.assign({}, {"a": 1})   # -> Object.assign({}, {"a": 1})
+Object.is_(x, y)              # -> Object.is(x, y)
+
+# Or import from module directly:
+from pulse.js.object import Object
+```
 """
 
 from collections.abc import Iterable as _Iterable

pulse/js/promise.py

@@ -2,15 +2,18 @@
 JavaScript Promise builtin module.
 
 Usage:
-    from pulse.js import Promise
-    Promise(executor)             # -> new Promise(executor)
-    Promise.resolve(value)        # -> Promise.resolve(value)
-    Promise.reject(reason)        # -> Promise.reject(reason)
 
-    # Or import from module directly:
-    from pulse.js.promise import Promise
+```python
+from pulse.js import Promise
+Promise(executor)             # -> new Promise(executor)
+Promise.resolve(value)        # -> Promise.resolve(value)
+Promise.reject(reason)        # -> Promise.reject(reason)
 
-The Promise class is generic and supports async/await via the Awaitable protocol.
+# Or import from module directly:
+from pulse.js.promise import Promise
+```
+
+The `Promise` class is generic and supports async/await via the Awaitable protocol.
 """
 
 from collections.abc import Callable as _Callable
@@ -36,16 +39,19 @@ PromiseSettledResult = PromiseFulfilledResult[T] | PromiseRejectedResult
 class Promise(_Generic[T_co]):
 	"""JavaScript Promise - a thenable that represents an async operation.
 
-	Promise is both generic over its resolved type and implements Awaitable,
+	`Promise` is both generic over its resolved type and implements `Awaitable`,
 	allowing it to be used with Python's async/await syntax which transpiles
 	to JavaScript async/await.
 
 	Example:
-	    @javascript
-	    async def fetch_data() -> str:
-	        response: Promise[Response] = fetch("/api/data")
-	        data = await response  # Awaits the promise
-	        return data.text()
+
+	```python
+	@javascript
+	async def fetch_data() -> str:
+	    response: Promise[Response] = fetch("/api/data")
+	    data = await response  # Awaits the promise
+	    return data.text()
+	```
 	"""
 
 	def __init__(

pulse/js/pulse.py

@@ -2,31 +2,34 @@
 Pulse UI client bindings for channel communication.
 
 Usage:
-    from pulse.js.pulse import usePulseChannel, ChannelBridge, PulseChannelResetError
-
-    @ps.javascript(jsx=True)
-    def MyChannelComponent(*, channel_id: str):
-        bridge = usePulseChannel(channel_id)
-
-        # Subscribe to events
-        useEffect(
-            lambda: bridge.on("server:notify", lambda payload: console.log(payload)),
-            [bridge],
-        )
-
-        # Emit events to server
-        def send_ping():
-            bridge.emit("client:ping", {"message": "hello"})
-
-        # Make requests to server
-        async def send_request():
-            response = await bridge.request("client:request", {"data": 123})
-            console.log(response)
-
-        return ps.div()[
-            ps.button(onClick=send_ping)["Send Ping"],
-            ps.button(onClick=send_request)["Send Request"],
-        ]
+
+```python
+from pulse.js.pulse import usePulseChannel, ChannelBridge, PulseChannelResetError
+
+@ps.javascript(jsx=True)
+def MyChannelComponent(*, channel_id: str):
+    bridge = usePulseChannel(channel_id)
+
+    # Subscribe to events
+    useEffect(
+        lambda: bridge.on("server:notify", lambda payload: console.log(payload)),
+        [bridge],
+    )
+
+    # Emit events to server
+    def send_ping():
+        bridge.emit("client:ping", {"message": "hello"})
+
+    # Make requests to server
+    async def send_request():
+        response = await bridge.request("client:request", {"data": 123})
+        console.log(response)
+
+    return ps.div()[
+        ps.button(onClick=send_ping)["Send Ping"],
+        ps.button(onClick=send_request)["Send Request"],
+    ]
+```
 """
 
 from collections.abc import Awaitable as _Awaitable