diff options
| author | Eugene Triguba <eugenetriguba@gmail.com> | 2020-07-26 18:32:59 -0500 |
|---|---|---|
| committer | Eugene Triguba <eugenetriguba@gmail.com> | 2020-07-26 18:32:59 -0500 |
| commit | 4f421a532046aa30f6e8b104f3178ecb56a4d5a4 (patch) | |
| tree | 00f94e45e1be4ed66d9e02715862a3ce66f5723c | |
| parent | Only expose Client and LircdConnection to `lirc` import (diff) | |
| download | lirc-4f421a532046aa30f6e8b104f3178ecb56a4d5a4.zip | |
Add unreleased changes
| -rw-r--r-- | CHANGELOG.rst | 37 |
1 files changed, 13 insertions, 24 deletions
diff --git a/CHANGELOG.rst b/CHANGELOG.rst index ade2370..58b5e31 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -11,38 +11,27 @@ adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_. Unreleased ------------------ -**Changed** - -- ``socket_path`` in ``Lirc``'s constructor is now called ``address`` to better signify - what is it for (the address to reach lircd). This allows it to make more sense in a - cross-platform context such as with WinLIRC since TCP is used there and not a socket. - -- ``address`` in ``Lirc``'s constructor is now type hinted to be a tuple or a string. - A tuple is used for a TCP connection since you'd specify it as such: ("localhost", 8765). +**Added** -- ``socket_timeout`` has been renamed to just ``timeout`` in ``Lirc``'s constructor to clarify - that it may not necessarily be a socket (in the case of being on Windows). +- ``LircdConnection`` to handle configuring the connection on ``Client``. -- ``socket_timeout`` in ``Lirc``'s constructor is now type hinted as a float instead of an int. - This is the type that the socket will change it to anyway, and it makes more sense with time. - -- ``socket`` and ``address`` in ``Lirc``'s constructor is now defaulted to ``None`` in the ``__init__`` - method, but it does some calculations to determine the operating system that it is being run on and - sets up sensible defaults for them based on that. +**Changed** - - On Linux, it is "/var/run/lirc/lircd" as the address. - On macOS, it is "/opt/run/var/run/lirc/lircd". - And on Windows, it is ("localhost", 8765) to connect to localhost:8765, which is the default address for WinLIRC. +- ``Lirc`` is now named ``Client``. - - On Linux and macOS, the socket would end up being socket.socket(socket.AF_UNIX, socket.SOCK_STREAM). - On Windows, the socket would end up being socket.socket(socket.AF_INET, socket.SOCK_STREAM) since it is - connected over TCP with WinLIRC. +- ``Client`` now takes in a ``connection`` as the optional argument + to configure it's connection. That ``connection`` must be a ``LircdConnection`` + class if you would like to customize the connection. The ``LircdConnection`` takes + in an ``address``, ``socket``, and ``timeout`` with optional keyword arguments. + Anything not specified with use the defaults for that operating system. **Removed** -- ``DEFAULT_SOCKET_PATH`` constant on ``Lirc``. It no longer makes sense with cross-platform support. -- ``ENCODING`` constant on ``Lirc``. It is now a private part of the class. +- ``DEFAULT_SOCKET_PATH`` constant on ``Client``. It no longer makes sense with cross-platform support. + +- ``ENCODING`` constant on ``Client``. +- ``socket_path`` and ``socket_timeout`` on the ``Lirc`` constructor. 0.1.0 - 2020-07-13 ------------------ |