Skip to content

Commit 176f874

Browse files
committed
updates for 1.1.0 release
1 parent 4b39ccf commit 176f874

File tree

2 files changed

+10
-55
lines changed

2 files changed

+10
-55
lines changed

docs/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
author = 'Craig Barratt'
2424

2525
# The full version, including alpha/beta/rc tags
26-
release = '1.0.0'
26+
release = '1.1.0'
2727

2828
master_doc = 'index'
2929

docs/new_features.rst

+9-54
Original file line numberDiff line numberDiff line change
@@ -5,61 +5,16 @@ The releases and release notes are available on `GitHub <https://github.com/cust
55
Use HACS to install different versions of pyscript.
66

77
You can also install the master (head of tree) version from GitHub, either using HACS or manually.
8-
Because pyscript has quite a few unit tests, generally master should work ok. But it's not guaranteed
9-
to work at any random time.
8+
Because pyscript has quite a few unit tests, generally the master version should work ok. But it's not
9+
guaranteed to work at any random time, and newly-added features might change.
1010

11-
The latest release is 1.0.0, released on November 9, 2020. Here is the `stable documentation <https://hacs-pyscript.readthedocs.io/en/stable>`__
12-
for that release.
11+
The latest release is 1.1.0, released on December 10, 2020. Here is the `stable documentation
12+
<https://hacs-pyscript.readthedocs.io/en/stable>`__ for that release.
1313

1414
Over time, the master (head of tree) version in GitHub will include new features and bug fixes.
15-
Here is the master `latest documentation <https://hacs-pyscript.readthedocs.io/en/latest>`__
16-
if you want to see the new features or bug fixes.
15+
Here is the `latest documentation <https://hacs-pyscript.readthedocs.io/en/latest>`__ if you want
16+
to see the development version of the documentation.
1717

18-
Planned new features post 1.0.0 include:
19-
20-
- support mqtt triggers (#98, #105)
21-
- use ``aionofity`` to auto-reload newly written script files, at least on linux (#74)
22-
- consider allowing native Python functions inside pyscript (#71)
23-
- consider implementing function decorators (#43)
24-
- consider supporting the built-in functions that do I/O, such as ``open``, ``read`` and ``write``, which
25-
are not currently supported to avoid I/O in the main event loop, and also to avoid security issues if people
26-
share pyscripts. The ``print`` function only logs a message, rather than implements the real ``print`` features,
27-
such as specifying an output file handle. Support might be added in the future using an executor job, perhaps
28-
enabled when ``allow_all_imports`` is set.
29-
30-
The new features since 1.0.0 in master include:
31-
32-
- Adding new decorator ``@mqtt_trigger`` by @dlashua (#98, #105).
33-
- ``pyscript.reload`` only reloads changed files (changed contents, mtime, or an app's yaml configuration).
34-
All files in an app or module are reloaded if any one has changed, and any script, app or module that
35-
imports a changed modules (directly or indirectly) is also reloaded. Setting the optional ``global_ctx``
36-
service parameter to ``*`` forces reloading all files (which is the behavior in 1.0.0 and earlier). See #106.
37-
- Added ``state_hold_false=None`` optional period in seconds to ``@state_trigger()`` and ``task.wait_until()``.
38-
This requires the trigger expression to be ``False`` for at least that period (including 0) before
39-
a successful trigger. Setting this optional parameter makes state triggers edge triggered (ie,
40-
triggers only on transition from ``False`` to ``True``), instead of the default level trigger
41-
(ie, only has to evaluate to ``True``). Proposed by @tchef69 (#89), with suggestions from @dlashua (#95).
42-
- ``@time_trigger`` now supports a ``"shutdown"`` trigger, which occurs on HASS shutdown or whenever
43-
the trigger function is no longer referenced (eg: during reload, or redefinition in Jupyter),
44-
requested by @dlashua (#103).
45-
- All .py files below the ``pyscript/scripts`` directory are autoloaded, recursively. Also, any
46-
file name or directory starting with ``#`` is skipped (including top-level and ``apps``), which is
47-
an in-place way of disabling a specific script, app or directory tree (#97).
48-
- ``del`` and new function ``state.delete()`` can delete state variables and state variable attributes.
49-
50-
Breaking changes since 1.0.0 include:
51-
52-
- The ``pyscript.reload`` service only reloads changed files; prior behavior of reloading all files can be
53-
requested by setting the optional ``global_ctx`` service parameter to ``*``.
54-
- The ``trigger_time`` trigger function argument is now set to ``startup`` for a startup trigger,
55-
rather than ``None``. This was done to be consistent with the new ``shutdown`` trigger, which
56-
calls the trigger function with `trigger_time="shutdown"``.
57-
58-
Bug fixes since 1.0.0 in master include:
59-
60-
- State setting now copies the attributes, to avoid a strange ``MappingProxyType`` recursion error
61-
inside HASS, reported by @github392 (#87).
62-
- The deprecated function ``state.get_attr`` was missing an ``await``, which causes an exception; in 1.0.0 use
63-
``state.getattr``, reported and fixed by @dlashua (#88).
64-
- The ``packaging`` module is installed if not found, since certain HASS configurations might not include it;
65-
fixed by @raman325 (#90, #91).
18+
If you want to see development progress since 1.1.0, see
19+
`new features <https://hacs-pyscript.readthedocs.io/en/latest/new_features.html>`__
20+
in the latest documentation.

0 commit comments

Comments
 (0)