wirely 0.1.2__tar.gz → 0.1.4__tar.gz

{wirely-0.1.2 → wirely-0.1.4}/CHANGELOG.md

@@ -1,5 +1,96 @@
 # Changelog
 
+## 0.1.4 - 2026-10-24
+
+### Breaking changes and migration
+
+#### Optional parameters
+
+Replace `parameter_option(x)` with `optional(x)`.
+
+#### Type names
+
+Replace `String` with `string` and `ValueType` with `type`.
+Replace `Duration`, `TimeOfDay`, and `MonotonicTime` with `Std.Duration`,
+`Schedule.TimeOfDay`, and `Timer.MonotonicTime`, respectively, including
+in qualified function calls.
+
+#### Schedule.IsInDailyInterval
+
+The output is `Option[boolean]`. Handle `None` when wall time is unknown.
+
+#### Bindings
+
+Replace `temporary name: T;` with `binding name: value T;`, and
+`resource name: R;` with `binding name: resource R;`. The connection kind is
+required. The old declaration forms are no longer accepted.
+
+#### Enums
+
+Declare enums as `open` or `closed`. Open enums keep an explicit underlying
+type and member values and accept unnamed values of that type. Closed enums
+omit both and number their members from zero in declaration order:
+
+```wirely
+open enum type Protocol: uint8 {
+  TCP = 1,
+  UDP = 2,
+}
+
+closed enum type State {
+  Idle,
+  Running,
+}
+```
+
+Replace `enum type` with `open enum type` to keep existing numbering.
+
+#### Std.DelayOneStep
+
+Replace `Std.DelayOneStep` with state and read its previous value with
+`.old`:
+
+```wirely
+state delayed: boolean = false;
+connect source -> delayed;
+connect delayed.old -> target;
+```
+
+## 0.1.3 - 2026-10-12
+
+### Breaking changes and migration
+
+#### Schedule and Timer namespaces
+
+Replace `Time` with `Schedule` for `IsInDailyInterval`, `TriggerAt`,
+`TimeOfDayMinute`, and `IsValidDailyInterval`, and with `Timer` for
+`DebounceStable` and `MonotonicTimeReached`.
+
+### Added
+
+- `Timer.MonotonicTimestamp` emits the step's monotonic time while an input
+  event is present.
+- Bitwise operators `&`, `|`, `^`, `!`, `<<`, and `>>` for integers.
+- Procedure ports can be declared with a type and wired with `connect`.
+  Refer to a port as `procedure.port`, also in reference ports of other
+  procedures:
+
+  ```wirely
+  procedure invert
+    depends on value: value boolean
+    produces inverted: value boolean
+  {
+    inverted = !value;
+  }
+  connect default input -> invert.value;
+  connect invert.inverted -> default output;
+  ```
+- Connections can target temporaries and state; state takes its value from
+  a procedure output port. Reference output ports can target child inputs.
+- `wirely edit` edits programs as source text and as diagrams, kept in
+  sync. `wirely export-image` draws a diagram as a PDF or PNG file. Install
+  the `editor` extra to use them.
+
 ## 0.1.2 - 2026-10-10
 
 ### Breaking changes and migration
@@ -171,7 +262,7 @@ Replace integration-specific connector kinds in custom node declarations:
 | `two_n_device` | `resource TwoN.Device` |
 
 Custom libraries can declare their own opaque resources with
-`resource type Name;`. See [resource connectors](doc/language.md#opaque-resource-connectors).
+`resource type Name;`. See [resource connectors](doc/language.md#opaque-resource-ports).
 
 #### Runtime types
 

{wirely-0.1.2 → wirely-0.1.4}/MANIFEST.in

@@ -1,9 +1,10 @@
 include CHANGELOG.md
 recursive-include doc *.md
 recursive-include examples *.wrl
-recursive-include test *.py *.wrl
-include test/wrl/username_password.txt
+recursive-include tests *.py *.wrl
+include tests/wrl/username_password.txt
 include tools/build-pex
+include tools/generate-native-types
 include tools/git_write_wd_tree.py
 include tools/run-tests
 include tools/run-tests-dependencies

{wirely-0.1.2/wirely.egg-info → wirely-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wirely
-Version: 0.1.2
+Version: 0.1.4
 Summary: Node-based language and runtime for low-level home automation
 Author: Steffen Kieß
 License: MIT
@@ -13,7 +13,7 @@ Requires-Dist: lark>=1.1.5
 Requires-Dist: sdnotify>=0.3.0
 Requires-Dist: cbor2>=5.4.5
 Provides-Extra: knx
-Requires-Dist: xknx<4,>=3.0; extra == "knx"
+Requires-Dist: xknx<4,>=3.4; extra == "knx"
 Provides-Extra: mqtt
 Requires-Dist: aiomqtt<3,>=2.3; extra == "mqtt"
 Provides-Extra: two-n
@@ -23,10 +23,13 @@ Provides-Extra: graphviz
 Requires-Dist: graphviz>=0.20.1; extra == "graphviz"
 Provides-Extra: gpio
 Requires-Dist: gpiod<3,>=2.1; extra == "gpio"
+Provides-Extra: editor
+Requires-Dist: PySide6-Essentials>=6.8; extra == "editor"
 Provides-Extra: all
 Requires-Dist: wirely[gpio,graphviz,knx,mqtt,two-n]; extra == "all"
 Provides-Extra: test
 Requires-Dist: pyOpenSSL>=23.0.0; extra == "test"
+Requires-Dist: mypy>=2.0; extra == "test"
 Provides-Extra: pex
 Requires-Dist: pex; extra == "pex"
 Provides-Extra: dev
@@ -69,6 +72,10 @@ python3 -m wirely compile program.wrl
 
 Use `wirely compile --dump-program program.wrl` to print the compiled
 runtime program, including its variables, configuration, and procedures.
+Add `--timings` to print the duration of each compiler stage.
+Set `WIRELY_COMPILER_CACHE_LARK=1` to keep the parser tables in
+`$XDG_CACHE_HOME/wirely/` (by default `~/.cache/wirely/`), which saves
+about 0.7 s on each start.
 
 Install optional integrations as needed:
 
@@ -79,8 +86,38 @@ python3 -m pip install 'wirely[two-n]'         # 2N devices
 python3 -m pip install 'wirely[graphviz]'      # show-graph
 python3 -m pip install 'wirely[gpio]'          # GPIO
 python3 -m pip install 'wirely[all]'           # all optional integrations
+python3 -m pip install 'wirely[editor]'        # graphical editor
 ```
 
+Set `WIRELY_VERBOSE=1` to print node creation, connection setup, and each
+value sent or received by the KNX, MQTT, 2N, CSV, and Process nodes.
+
+`wirely edit program.wrl` opens a program in a graphical editor with tabs
+for its source files and diagrams. Edits in either view update the other.
+Right-click a tab to split the view, move it to another pane, or detach it
+into a window. You can also drag tabs between panes, onto pane edges to
+split, or outside the editor to detach. Closing a detached window returns
+its tabs to the main window. Layouts last for the current session.
+A diagram is read-only while its source has syntax errors. In a diagram:
+
+- Drag a node to store its position in the source; right-click it and choose
+  Reset to Automatic Position to remove it again. Use View → Snap to Grid
+  to toggle snapping for all diagrams. A selected group snaps its movement
+  while keeping its relative positions.
+- Drag from a port to another port to connect them. Drag a connection away
+  from an input to move or remove it.
+- Press Delete to remove the selection and F2 to rename it.
+- Right-click the background to add nodes and declarations.
+- Double-click a node to open the diagram of its node type.
+- Press Ctrl+E to show the source of the selection, and Ctrl+Shift+E in the
+  source to show the element at the cursor in its diagram.
+
+`wirely export-image program.wrl -o diagram.pdf` draws the program diagram as
+the editor shows it, as a PDF or PNG file. Use `--scope Name` for the diagram
+of a node type and `--scale` for the PNG resolution. Diagrams use the DejaVu
+Sans font, or a fallback font if it is not installed. See
+[diagram layout](doc/diagram-layout.md) for how layouts are stored.
+
 The `test` extra adds dependencies used only by the test suite. Install
 `wirely[all,test]` to include both integrations and test dependencies.
 
@@ -92,7 +129,7 @@ checkout launchers:
 
 ```
 tools/setup-venv
-tools/wirely compile test/wrl/simple.wrl
+tools/wirely compile tests/compiler/simple.wrl
 tools/run-tests
 ```
 
@@ -105,16 +142,19 @@ Pass test names to run a selection, and add `--timings` to list durations
 slowest first:
 
 ```
-tools/run-tests --timings unit/types unit/equality
+tools/run-tests --timings unit/types wrl/equality
 ```
 
+Add `--processes 4` to run the tests in four worker processes; see the
+[test guide](doc/tests.md) for the options.
+
 To check that compilation does not depend on declaration order, set
 `WIRELY_COMPILER_SHUFFLE_SEED` to an integer. The compiler then shuffles
-declarations, node parameters, struct literal fields, and procedure
-bindings with that seed; connections keep their relative order. Also set
-`WIRELY_COMPILER_SHUFFLE_LAYOUT=1` to shuffle struct fields and enum
-members, which changes serialization and enum default values. Negative
-tests may report different diagnostics in this mode.
+declarations, node parameters, procedure ports, `uses` bindings, and open
+enum members with that seed; connections keep their relative order. Also set `WIRELY_COMPILER_SHUFFLE_LAYOUT=1` to shuffle
+fields of structs and members of closed enums that are not native, which
+changes the runtime representation.
+Negative tests may report different diagnostics in this mode.
 
 ```
 WIRELY_COMPILER_SHUFFLE_SEED=1 tools/run-tests
@@ -138,3 +178,9 @@ compatible patch of the oldest supported CPython minor; `max` selects the
 newest compatible stable CPython available through the installed uv.
 uv can download missing interpreters. `tools/run-tests --python PATH` runs
 tests using a specified Python executable.
+
+Test names, `--timings`, and `--keep-going` work as for `tools/run-tests`:
+
+```
+tools/run-tests-dependencies --versions min --python min misc/type_check
+```

{wirely-0.1.2 → wirely-0.1.4}/README.md

@@ -33,6 +33,10 @@ python3 -m wirely compile program.wrl
 
 Use `wirely compile --dump-program program.wrl` to print the compiled
 runtime program, including its variables, configuration, and procedures.
+Add `--timings` to print the duration of each compiler stage.
+Set `WIRELY_COMPILER_CACHE_LARK=1` to keep the parser tables in
+`$XDG_CACHE_HOME/wirely/` (by default `~/.cache/wirely/`), which saves
+about 0.7 s on each start.
 
 Install optional integrations as needed:
 
@@ -43,8 +47,38 @@ python3 -m pip install 'wirely[two-n]'         # 2N devices
 python3 -m pip install 'wirely[graphviz]'      # show-graph
 python3 -m pip install 'wirely[gpio]'          # GPIO
 python3 -m pip install 'wirely[all]'           # all optional integrations
+python3 -m pip install 'wirely[editor]'        # graphical editor
 ```
 
+Set `WIRELY_VERBOSE=1` to print node creation, connection setup, and each
+value sent or received by the KNX, MQTT, 2N, CSV, and Process nodes.
+
+`wirely edit program.wrl` opens a program in a graphical editor with tabs
+for its source files and diagrams. Edits in either view update the other.
+Right-click a tab to split the view, move it to another pane, or detach it
+into a window. You can also drag tabs between panes, onto pane edges to
+split, or outside the editor to detach. Closing a detached window returns
+its tabs to the main window. Layouts last for the current session.
+A diagram is read-only while its source has syntax errors. In a diagram:
+
+- Drag a node to store its position in the source; right-click it and choose
+  Reset to Automatic Position to remove it again. Use View → Snap to Grid
+  to toggle snapping for all diagrams. A selected group snaps its movement
+  while keeping its relative positions.
+- Drag from a port to another port to connect them. Drag a connection away
+  from an input to move or remove it.
+- Press Delete to remove the selection and F2 to rename it.
+- Right-click the background to add nodes and declarations.
+- Double-click a node to open the diagram of its node type.
+- Press Ctrl+E to show the source of the selection, and Ctrl+Shift+E in the
+  source to show the element at the cursor in its diagram.
+
+`wirely export-image program.wrl -o diagram.pdf` draws the program diagram as
+the editor shows it, as a PDF or PNG file. Use `--scope Name` for the diagram
+of a node type and `--scale` for the PNG resolution. Diagrams use the DejaVu
+Sans font, or a fallback font if it is not installed. See
+[diagram layout](doc/diagram-layout.md) for how layouts are stored.
+
 The `test` extra adds dependencies used only by the test suite. Install
 `wirely[all,test]` to include both integrations and test dependencies.
 
@@ -56,7 +90,7 @@ checkout launchers:
 
 ```
 tools/setup-venv
-tools/wirely compile test/wrl/simple.wrl
+tools/wirely compile tests/compiler/simple.wrl
 tools/run-tests
 ```
 
@@ -69,16 +103,19 @@ Pass test names to run a selection, and add `--timings` to list durations
 slowest first:
 
 ```
-tools/run-tests --timings unit/types unit/equality
+tools/run-tests --timings unit/types wrl/equality
 ```
 
+Add `--processes 4` to run the tests in four worker processes; see the
+[test guide](doc/tests.md) for the options.
+
 To check that compilation does not depend on declaration order, set
 `WIRELY_COMPILER_SHUFFLE_SEED` to an integer. The compiler then shuffles
-declarations, node parameters, struct literal fields, and procedure
-bindings with that seed; connections keep their relative order. Also set
-`WIRELY_COMPILER_SHUFFLE_LAYOUT=1` to shuffle struct fields and enum
-members, which changes serialization and enum default values. Negative
-tests may report different diagnostics in this mode.
+declarations, node parameters, procedure ports, `uses` bindings, and open
+enum members with that seed; connections keep their relative order. Also set `WIRELY_COMPILER_SHUFFLE_LAYOUT=1` to shuffle
+fields of structs and members of closed enums that are not native, which
+changes the runtime representation.
+Negative tests may report different diagnostics in this mode.
 
 ```
 WIRELY_COMPILER_SHUFFLE_SEED=1 tools/run-tests
@@ -102,3 +139,9 @@ compatible patch of the oldest supported CPython minor; `max` selects the
 newest compatible stable CPython available through the installed uv.
 uv can download missing interpreters. `tools/run-tests --python PATH` runs
 tests using a specified Python executable.
+
+Test names, `--timings`, and `--keep-going` work as for `tools/run-tests`:
+
+```
+tools/run-tests-dependencies --versions min --python min misc/type_check
+```

{wirely-0.1.2 → wirely-0.1.4}/doc/README.md

@@ -4,14 +4,18 @@ Wirely programs are graphs of typed nodes written in `.wrl` files. Start with
 the [language guide](language.md) to learn how to declare nodes and connect
 them. Then use the [library reference](libraries.md) to find the nodes supplied
 with Wirely. The [value type reference](value-types.md) describes the types
-used by parameters, connectors, and state.
+used by parameters, ports, and state.
 
 The [binary program format proposal](bytecode-format.md) describes program
 tables, value encodings, and optional debugging information.
 
 For `.wrl` formatting and naming, follow the
-[Wirely style guide](wirely-style.md).
+[Wirely style guide](wirely-style.md). The [diagram layout](diagram-layout.md)
+document defines how diagrams of programs are laid out and stored.
 
 To implement nodes and procedures in Python, use the
 [native Python implementation guide](native-python.md). For Python
 contributions, follow the [Python style guide](python-style.md).
+
+For compiler development, read the [compiler stages guide](compiler-stages.md).
+For test categories, execution, and authoring, read the [test guide](tests.md).