From 176f87478dcd0efafd095b16a8aeff59cdce6c92 Mon Sep 17 00:00:00 2001 From: Craig Barratt <19445341+craigbarratt@users.noreply.github.com> Date: Thu, 10 Dec 2020 20:12:08 +1100 Subject: [PATCH] updates for 1.1.0 release --- docs/conf.py | 2 +- docs/new_features.rst | 63 +++++++------------------------------------ 2 files changed, 10 insertions(+), 55 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 01db1a3..61f562a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,7 +23,7 @@ author = 'Craig Barratt' # The full version, including alpha/beta/rc tags -release = '1.0.0' +release = '1.1.0' master_doc = 'index' diff --git a/docs/new_features.rst b/docs/new_features.rst index 9378fee..bc7fdda 100644 --- a/docs/new_features.rst +++ b/docs/new_features.rst @@ -5,61 +5,16 @@ The releases and release notes are available on `GitHub `__ -for that release. +The latest release is 1.1.0, released on December 10, 2020. Here is the `stable documentation +`__ for that release. Over time, the master (head of tree) version in GitHub will include new features and bug fixes. -Here is the master `latest documentation `__ -if you want to see the new features or bug fixes. +Here is the `latest documentation `__ if you want +to see the development version of the documentation. -Planned new features post 1.0.0 include: - -- support mqtt triggers (#98, #105) -- use ``aionofity`` to auto-reload newly written script files, at least on linux (#74) -- consider allowing native Python functions inside pyscript (#71) -- consider implementing function decorators (#43) -- consider supporting the built-in functions that do I/O, such as ``open``, ``read`` and ``write``, which - are not currently supported to avoid I/O in the main event loop, and also to avoid security issues if people - share pyscripts. The ``print`` function only logs a message, rather than implements the real ``print`` features, - such as specifying an output file handle. Support might be added in the future using an executor job, perhaps - enabled when ``allow_all_imports`` is set. - -The new features since 1.0.0 in master include: - -- Adding new decorator ``@mqtt_trigger`` by @dlashua (#98, #105). -- ``pyscript.reload`` only reloads changed files (changed contents, mtime, or an app's yaml configuration). - All files in an app or module are reloaded if any one has changed, and any script, app or module that - imports a changed modules (directly or indirectly) is also reloaded. Setting the optional ``global_ctx`` - service parameter to ``*`` forces reloading all files (which is the behavior in 1.0.0 and earlier). See #106. -- Added ``state_hold_false=None`` optional period in seconds to ``@state_trigger()`` and ``task.wait_until()``. - This requires the trigger expression to be ``False`` for at least that period (including 0) before - a successful trigger. Setting this optional parameter makes state triggers edge triggered (ie, - triggers only on transition from ``False`` to ``True``), instead of the default level trigger - (ie, only has to evaluate to ``True``). Proposed by @tchef69 (#89), with suggestions from @dlashua (#95). -- ``@time_trigger`` now supports a ``"shutdown"`` trigger, which occurs on HASS shutdown or whenever - the trigger function is no longer referenced (eg: during reload, or redefinition in Jupyter), - requested by @dlashua (#103). -- All .py files below the ``pyscript/scripts`` directory are autoloaded, recursively. Also, any - file name or directory starting with ``#`` is skipped (including top-level and ``apps``), which is - an in-place way of disabling a specific script, app or directory tree (#97). -- ``del`` and new function ``state.delete()`` can delete state variables and state variable attributes. - -Breaking changes since 1.0.0 include: - -- The ``pyscript.reload`` service only reloads changed files; prior behavior of reloading all files can be - requested by setting the optional ``global_ctx`` service parameter to ``*``. -- The ``trigger_time`` trigger function argument is now set to ``startup`` for a startup trigger, - rather than ``None``. This was done to be consistent with the new ``shutdown`` trigger, which - calls the trigger function with `trigger_time="shutdown"``. - -Bug fixes since 1.0.0 in master include: - -- State setting now copies the attributes, to avoid a strange ``MappingProxyType`` recursion error - inside HASS, reported by @github392 (#87). -- The deprecated function ``state.get_attr`` was missing an ``await``, which causes an exception; in 1.0.0 use - ``state.getattr``, reported and fixed by @dlashua (#88). -- The ``packaging`` module is installed if not found, since certain HASS configurations might not include it; - fixed by @raman325 (#90, #91). +If you want to see development progress since 1.1.0, see +`new features `__ +in the latest documentation.