CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Fixed

• Close of TTY client causing TypeError to be raised in receive task

[0.7.3] - 2024-10-31

Fixed

• Invalid unpack of date and time from ChainPack for dates before 2018-02-02

[0.7.2] - 2024-09-10

Fixed

• Re-release due to error in this file causing deployment failure

[0.7.1] - 2024-09-10

Fixed

• RpcMethodDesc now correctly handles null for the signal parameter
• CancelledError raised from login task when reset is received before login is finished

[0.7.0] - 2024-08-22

Added

• Support for WebSockets transport
• NixOS module for pyshvbroker
• RpcLogin now provides password validation algorithm and conversion from and to SHV login parameter
• RPC servers now have terminate and wait_terminated method that terminates not server but also its clients
• Support for string arguments in places where RpcUrl is being used

Changed

• Broker's configuration format changed from INI to TOML as well as the concept of the configuractuion changed. Please update your configuration according to the new documentation.
• Broker now filters signals based on the source method not signal name
• RpcBrokerConfig completely rewritten
• RpcBroker client are now registered only if they are active
• RpcProtocol.SERIAL renamed to RpcProtocol.TTY
• RpcInvalidParamsError was renamed to RpcInvalidParamError
• RpcErrorCode.INVALID_PARAMS was renamed to RpcErrorCode.INVALID_PARAM

Removed

• RpcRI in favor of using strings and rpcri_* functions

Fixed

• SimpleBase.ping now uses .broker/app instead of .broker/currentClient on pre-SHV3 brokers
• is_shvlist now excludes strings and bytes to not invalidly classify them as lists
• shvarg and shvargt now correctly manages single values and provides them only as for zero index (was for all indexes)
• RpcServerTTY no longer raise asyncio.CancelledError when its being closed

[0.6.1] - 2024-04-12

Added

• is_shvtype and is_shvlist functions that validates Python object as being SHVType and SHVListType respectively

Changed

• is_shvmap and is_shvimap now inspect also values with is_shvtype

Fixed

• Compatibility for RpcSubscription when all methods are requested
• SimpleBase sometimes causing error on exit due to not having any task to finish

[0.6.0] - 2024-04-06

Added

• Automatic reconnects for SimpleClient
• init_rpc_client that only initializes RpcClient without connecting it
• RpcMessage.make_response now accepts result as argument so you can use it as initializator
• Support for Access Level for RPC messages
• Support for Client's ID in SimpleBase as well as in RpcBroker.
• New RPC error RpcUserIDRequiredError
• RPC Broker configuration option config.name
• SHV value getting utilities for common parameter formats (shvarg, shvgett)
• SimpleBase.dir_exists that is consistent with SimpleBase.ls_has_child
• RpcNotImplementedError

Changed

• SimpleBase and thus SimpleClient method _method_call has new argument user_id and order of old arguments changes. Please update your code!
• RpcUrl login specific options were moved to RpcLogin
• .app/broker and .app/device were moved to .broker and .device according to the SHV 3.0 standard
• RpcMethodDesc.SIGNAL renamed to RpcMethodDesc.NOT_CALLABLE and should not be used and at the same time new field RpcMethodDesc.signals was added. Signals now should be specified there and not as a separate items.
• SimpleClient has now new base SimpleBase
• RpcClient.reset no longer disconnects and instead sends reset signal to peer. The RpcClient.receive now receives not only messages but also these control signals.
• RpcBroker now lowers access level instead of overwriting it
• Command pycp2cp renamed to more appropriate pycpconv
• RpcBroker.Client and RpcBroker API changed to center mount point management in RpcBroker.
• RpcSubscription has now different fields due to subscription changes
• The format of logging changed to identify different clients from each other
• Access level numerical values adjusted to match SHV standard
• SimpleBase and thus SimpleClient no longer provides public ability to send messages and signals. Instead it is now implemented as protected methods and implementations based on it must expose them appropriately if that is required.
• .app:date SHV RPC method to SimpleBase

Fixed

• Failing import on Windows
• Subscription are now compared case sensitive (as it should have been)
• ValueClient documentation for prop_change_wait timeout parameter
• ValueClient.prop_get now uses max_age for get and correctly uses local cache

Removed

• rpc_login and rpc_login_url in favor of RpcLogin
• SimpleClient.dir_description that is replaced with SimpleBase.dir_exists
• RpcMethodDesc.signal as it is invalid with latest changes
• RpcMethodDesc.description that was replaced with RpcMethodDesc.extra["description"]
• Broker no longer provides .app/broker/clientInfo
• Broker no longer provides method .app/broker/currentClient:rejectNotSubscribed
• RpcMessage.chng because that is now default for RpcMessage.signal

[0.5.0] - 2024-01-18

Added

• Broker now has ability to establish connection on its own instead of just listening for them
• RpcClientPipe that supports working with Unix pipes
• RpcServerTTY that waits for TTY to appear

Changed

• RpcUrl.password is now expected to be only string and default value is empty string. RpcUrl.login_type is now PLAIN to be valid for default password value.
• rpclogin replaces PLAIN login with SHA1 for increased security. The new parameter force_plain was added to actually use PLAIN anyway.
• connect_rpc_client now uses RpcProtocolSerialCRC instead of RpcProtocolSerial for RpcProtocol.SERIAL.
• RpcUrl.parse now enforces that shapass must have 40 characters.
• .app/broker:mountPoints renamed to .app/bnroker:mounts according to the standard update.
• All methods working with subscription in .app/broker/currentClient now use keyword paths instead of pattern (change in SHV standard)
• Methods in .app/broker now have access level Super-Service according to the SHV standard
• Methods in .app/broker/currentClient are now reported with Browse access level but on access the level is not verified at all and thus access is not limited

Fixed

• Login to RPC Broker with PLAIN password when server has SHA1 configured for that user
• .app/broker:mountedClientInfo is now reported by .app/broker:dir
• RpcUrl now correctly escapes options when converting to URL string and supports user option

[0.4.0] - 2023-11-10

pySHV now conforms with work in progress SHV standard 3.0!

Added

• SimpleClient.ls_has_child to query if child node exists
• SimpleClient.dir_description to get description of a single method
• SimpleClient now supports multiple call attempts
• SimpleDevice that should be used with devices

Changed

• RpcMessage API to now use properties instead of methods
• Removed unused argument login_options for SimpleClient.connect
• SimpleClient.dir_details is now SimpleClient.dir and old dir implementation is removed
• RpcClientStream is replaced with RpcClientTCP and RpcClientUnix
• RpcClientSerial is replaced with RpcClientTTY
• RpcServerStream is not replaced with RpcServerTCP and RpcServerUnix
• Broker configuration now no longer contains rules sections and instead we specify methods in roles sections. Methods are combination of path and method that is used to identify methods this role is applied to.
• RpcClient.connected is not property instead of plain method
• Broker now allows all users browse access to the .app and read access to the .app/broker/currentClient.
• Received invalid messages are now skipped instead of raising exception.
• SimpleClient.login and SimpleClient.urllogin renamed and moved to rpclogin and rpclogin_url respectively

Removed

• SimpleClient.ls_with_children as that is now invalid with SHV 3.0
• Support of UDP (not part of standard)

[0.3.0] - 2023-09-19

Added

• ValueClient.wait_for_change that blocks task until value change is detected.
• ValueClient.prop_change_wait that simplifies a common operation of waiting for a new value.
• ValueClient.get_snapshot is now able to snapshot multiple paths or subscribed paths if no path is given.
• ValueClient.clean_cache method to remove old entried for no longer subscribed paths.
• ValueClient.prop_get now supports max_age parameter
• Support for UDP/IP protocol
• Initial support for Serial protocol
• Ability to reset the client connection (RpcClient.reset)

Changed

• URL now uses field location instead of host as it is more descriptive considering the usage.
• Login is now allowed for local socket because it can be used to elevate access rights of some clients without need to have multiple sockets.
• ValueClient now caches new value for subscribed paths when prop_get is used and optionally right on prop_set.
• ValueClient.unsubscribe now calls ValueClient.clean_cache on successful unsubscribe (this can be suppressed with argument).
• create_rpc_server returns RpcServer instead of asyncio.Server

Fixed

• Running pyshvbroker as a standalone application not working
• Packing of Decimal in ChainPack that in some cases packed invalid value
• Unpacking of strings in Cpon that mangled UTF-8 encoding.
• Packing of str in Cpon that invalidly escaped some characters.
• ValueClient.get_snapshot no longer fails when node is not implementing ls method.
• ValueClient.is_subscribed now correctly matches only paths for subscribed nodes and its children instead of just generic string prefix.
• ValueClient.prop_get reports value change only when it really happened.
• ValueClient.prop_change_wait implementation
• RpcUrl uses local user's name instead of empty string
• Handling of idle ping for SimpleClient when used only to listen
• pycp2cp invocation with file

[0.2.0] - 2023-06-16

Added

• SimpleClient that provides simple API to connect to the broker and perform calls as well as to handle requests and signals
• RpcError that represents SHV RPC errors
• SHVMeta and variation on SHV types based on it with companion functions to manage these custom extended types
• Small broker implemented purely in Python

Changed

• RpcMessage.ErrorCode moved and renamed to RpcErrorCode
• RpcClient.read_rpc_message now raises RpcError instead of RpcClient.MethodCallError
• ChainPackWriter, ChainPackReader, CponWriter and CponReader now require io.BytesIO instead of UnpackContext and PackContext
• RpcMessage has now attribute value instead of rpcValue (this is intentional break to force users to review their code due to the type change)
• RpcClient methods for sending and receiving RPC messages were replaced with send and receive methods.
• rpcclient.get_next_rpc_request_id was moved to RpcMessage.next_request_id

Removed

• ClinetConnection, please use SimpleClient or ValueClient instead
• RpcClient.LoginType.NONE as login needs to be always performed even when any authentication is accepted to actually pass options
• RpcValue and instead native types or SHVMeta based types are used
• cpcontext and ctx attributes of ChainPackWriter, ChainPackReader, CponWriter and CponReader
• ChainPack.is_little_endian as it can be easilly done directly

[0.1.1] - 2023-05-22

Fixed

• Handler lookup in ClientConnection now correctly selects longest match rather than shortest

[0.1.0] - 2023-04-10

Added

• The original implementation under name libshv-py
• Methods shverror and set_shverror to RpcMessage with an appropriate SHV error format
• RpcServer that listens for new client connections
• RpcClient.disconnect method to disconnect the connection

Changed

• Top-level package chainpack renamed to shv
• RpcValue now explicitly converts Python representation to its internal one and also back
• Tags and Keys in RpcMessage are now in Enum instead of being constants
• RpcClient's method connect is now class method that creates new instance
• RpcClient now has to he initialized with writter and reader
• RpcClient.LoginType are now capitalized to match Python paradigm
• RpcClient.State is removed

Fixed

• Terminate loop of RpcClient on EOF
• Packing of empty string