diff options
| -rw-r--r-- | .coveragerc | 4 | ||||
| -rw-r--r-- | .github/workflows/python-package-ci.yml | 68 | ||||
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | CHANGELOG.rst | 27 | ||||
| -rw-r--r-- | README.rst | 105 | ||||
| -rw-r--r-- | docs/source/conf.py | 6 | ||||
| -rw-r--r-- | docs/source/configuring-system-lirc.rst | 7 | ||||
| -rw-r--r-- | docs/source/installation.rst | 13 | ||||
| -rw-r--r-- | docs/source/usage.rst | 73 | ||||
| -rw-r--r-- | lirc/__init__.py | 19 | ||||
| -rw-r--r-- | lirc/client.py | 218 | ||||
| -rw-r--r-- | lirc/connection/__init__.py | 0 | ||||
| -rw-r--r-- | lirc/connection/abstract_connection.py | 37 | ||||
| -rw-r--r-- | lirc/connection/default_connection.py | 28 | ||||
| -rw-r--r-- | lirc/connection/lircd_connection.py | 143 | ||||
| -rw-r--r-- | lirc/exceptions.py | 26 | ||||
| -rw-r--r-- | lirc/lirc.py | 252 | ||||
| -rw-r--r-- | lirc/reply_packet_parser.py | 168 | ||||
| -rw-r--r-- | lirc/response.py | 18 | ||||
| -rw-r--r-- | poetry.lock | 882 | ||||
| -rw-r--r-- | pyproject.toml | 130 | ||||
| -rw-r--r-- | tests/conftest.py | 18 | ||||
| -rw-r--r-- | tests/test_client.py | 68 | ||||
| -rw-r--r-- | tests/test_lirc.py | 135 | ||||
| -rw-r--r-- | tests/test_lircd_connection.py | 118 | ||||
| -rw-r--r-- | tests/test_reply_packet_parser.py | 66 |
26 files changed, 1646 insertions, 985 deletions
diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..d424987 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,4 @@ +[run] +branch = True +source = lirc/ +omit = lirc/connection/abstract_connection.py diff --git a/.github/workflows/python-package-ci.yml b/.github/workflows/python-package-ci.yml index 0ffbee7..81ec2e8 100644 --- a/.github/workflows/python-package-ci.yml +++ b/.github/workflows/python-package-ci.yml @@ -2,44 +2,50 @@ name: python package ci on: push: - branches: [ master, dev, test-ci ] + paths: + - "lirc/**" + - "tests/**" pull_request: - branches: [ master, dev, test-ci ] + paths: + - "lirc/**" + - "tests/**" jobs: build: - runs-on: ubuntu-latest strategy: matrix: python-version: [3.6, 3.7, 3.8] steps: - - uses: actions/checkout@v2 - - - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 - with: - python-version: ${{ matrix.python-version }} - - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install poetry - poetry install -vvv - - name: Run tests - run: | - poetry run task test_ci - - - name: Upload coverage to Codecov - uses: codecov/codecov-action@v1 - with: - token: ${{ secrets.CODECOV_TOKEN }} - file: ./coverage.xml - flags: unittests - name: codecov-umbrella - fail_ci_if_error: true - - - name: Build Package - run: | - poetry build
\ No newline at end of file + - uses: actions/checkout@v2 + + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install poetry + poetry install -v + + - name: Install system LIRC + run: | + sudo apt-get install lirc + + - name: Run tests + run: poetry run task test_ci + + - name: Upload coverage to Codecov + uses: codecov/codecov-action@v1 + with: + token: ${{ secrets.CODECOV_TOKEN }} + file: ./coverage.xml + flags: unittests + name: codecov-umbrella + fail_ci_if_error: true + + - name: Build Package + run: poetry build @@ -17,4 +17,4 @@ dist/ .coverage # Docs -docs/build/
\ No newline at end of file +docs/build/ diff --git a/CHANGELOG.rst b/CHANGELOG.rst index dac2803..58b5e31 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -8,7 +8,32 @@ Changelog <https://keepachangelog.com/en/1.0.0/>`_, and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_. +Unreleased +------------------ + +**Added** + +- ``LircdConnection`` to handle configuring the connection on ``Client``. + +**Changed** + +- ``Lirc`` is now named ``Client``. + +- ``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 ``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 ------------------ -- Initial Release
\ No newline at end of file +- Initial Release @@ -30,8 +30,10 @@ LIRC Python Package :alt: License This is a python package that allows you to interact with the daemon in the -`Linux Infrared Remote Control <https://lirc.org>`_ package. Interacting with -the daemon allows you to send IR signals from a computer. +`Linux Infrared Remote Control <https://lirc.org>`_ package. By interacting +with the daemon, it allows you to programmatically send IR signals from a +computer. This package is for emitting IR signals, but it does not support +listening to IR codes. More information on the lircd daemon, socket interface, reply packet format, etc. can be found at https://www.lirc.org/html/lircd.html @@ -53,42 +55,87 @@ system as well. More information on that can be found in the `installation <https://lirc.readthedocs.io/en/latest/installation.html>`_ portion of the documentation. -Using the Lirc Package ----------------------- +Usage Quick Start +----------------- + +Customizing the Client +^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: python + + import lirc + + client = lirc.Client() + + print(client.version()) + >>> '0.10.1' + +To use this package, we instantiate a ``Client``. When we initialize +the ``Client`` in the example above, we use the defaults by passing +it no arguments. + +The defaults use the ``LircdConnection`` class. These defaults depend +on your operating system and can be looked up in the full documentation. +However, we can customize these defaults if desired. + +.. code-block:: python + + import socket + import lirc + + client = lirc.Client( + connection=lirc.LircdConnection( + address="/var/run/lirc/lircd", + socket=socket.socket(socket.AF_UNIX, socket.SOCK_STREAM), + timeout = 5.0 + ) + ) + +The address specifies how to reach the lircd daemon. On Windows, we pass +a ``(hostname, port)`` tuple since we connect over TCP. However on Linux and +macOS, we pass in the socket path as a string. For the client in the example +above, we set it up using the defaults for a Linux machine. While it illustrates +what is customizable, it is not a practical example since you could just call +``Client()`` if you're on Linux and achieve the same outcome. + +Sending IR +^^^^^^^^^^ .. code-block:: python - from lirc import Lirc + import lirc + + client = lirc.Client() + client.send("my-remote-name", "KEY_POWER") + client.send("my-remote-name", "KEY_3", repeat_count=2) + + +With sending IR, we can use the `send` method and optionally, +send multiple by using the `repeat_count` keyword argument. + +Handling Errors +^^^^^^^^^^^^^^^ + +.. code-block:: python - lirc = Lirc() - response = lirc.version() + import lirc - print(response.command) - >>> 'VERSION' - print(response.success) - >>> True - print(response.data) - >>> ['0.10.1'] + client = lirc.Client() -To get started with the package, we import ``Lirc`` and can -initialize it with the defaults by passing it no arguments. + try: + client.send('some-remote', 'key_power') + except lirc.LircdCommandFailureError as error: + print('The command we sent failed! Check the error message') + print(error) -This will assume a socket path of ``/var/run/lirc/lircd``. -Furthermore, this will also then assume a socket connection -using ``AF_UNIX`` and ``SOCK_STREAM``. These are both the defaults -that should work on a Linux system. There are ports of LIRC -to Windows and macOS but using the package there is far less -common. However, both of these are configurable through options -passed to ``Lirc`` to allow it to be used on those operating systems -as well. +If the command was not successful, a ``LircdCommandFailureError`` exception will be thrown. +There are other errors that may be raised, which can be looked up in the full documentation, +but this is the most likely when sending commands. -After sending any command to the LIRC daemon, this package will create -a ``LircResponse`` for us that it returns. That response contains the -command we sent to LIRC, whether it was successful, and any data that -was returned back to us. Further Documentation --------------------- -More information on how to setup the system installed LIRC, how to use this python library, -and a full API specification can be found at https://lirc.readthedocs.io/ +More information on how to setup the system installed LIRC, how to use +this python library, and a full API specification can be found at +https://lirc.readthedocs.io/ diff --git a/docs/source/conf.py b/docs/source/conf.py index cd10b4c..1c5552c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -31,7 +31,11 @@ release = "0.1.0" # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ["sphinx.ext.autodoc", "sphinx.ext.autosectionlabel"] +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosectionlabel", + "sphinx.ext.napoleon", +] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] diff --git a/docs/source/configuring-system-lirc.rst b/docs/source/configuring-system-lirc.rst index 5c9d829..5122804 100644 --- a/docs/source/configuring-system-lirc.rst +++ b/docs/source/configuring-system-lirc.rst @@ -50,7 +50,12 @@ the device should just work on the default driver. Windows ------- -The Windows setup information is a work in progress. +You'll want to make sure you install WinLIRC at http://winlirc.sourceforge.net/. +This is the LIRC port for Windows which corresponds with version 0.9.0 of LIRC. Past that, +you can run the WinLIRC executable file and select the "Input Plugin" for your device. Then, +you can select the remote configuration and click OK. You should now be able to select your remote +and send key codes. As long as the program is running in the background (it minimizes to the tray), +this package will be able to connect to it. macOS ----- diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 3f74864..e8255de 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -19,9 +19,9 @@ through pip. System LIRC Package ------------------- -While there are ports of LIRC to macOS and Windows, -the original Linux version is generally easier to -get working and install. +While LIRC was originally created for Linux, there +are ports of LIRC to macOS and Windows which this +python package is compatibile with. Linux: @@ -36,8 +36,7 @@ Windows: * WinLIRC at http://winlirc.sourceforge.net/ is a port for Windows. It works a bit differently since it is just a collection of files - in a folder that you run so you'll have to adjust the ``socket`` - and ``socket_path`` parameter. More information on that can be found + in a folder that you run. More information on that can be found at `using LIRC on Windows <./using-lirc-on-windows.html>`_. macOS: @@ -46,6 +45,4 @@ macOS: with it's source code on GitHub at https://github.com/andyvand/LIRC. However, it doesn't appear to be maintained any longer and is not the latest LIRC version. You can then run ``port install lirc`` or build the package from source using - the instructions on the README of the GitHub repository. See - `using LIRC on macOS <./using-lirc-on-macos.html>`_ for more information on - getting LIRC setup on macOS and how to use this python package with it.
\ No newline at end of file + the instructions on the README of the GitHub repository.
\ No newline at end of file diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 588d2f7..b007fd0 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -6,33 +6,68 @@ of things you can now import from it to get started. .. code-block:: python - from lirc import ( - Lirc, - LircResponse, - LircError, - LircSocketError, - LircSocketTimeoutError, - InvalidReplyPacketFormatError - ) + from lirc import Client, LircdConnection -The most relevant of these is ``Lirc``, since this is the main class -you will be using. +The most relevant of these is ``Client``, since this is the main class +you will be using. ``LircdConnection`` is the object that is used to configure +the connection to LIRC when you initialize the ``Client``. Initializing Lirc ----------------- -The ``Lirc`` class takes in three separate options, which all have default -values, that we may pass into it to construct it and override those default -values. +The ``Client`` class takes in one optional keyword argument: connection. +This connection must be a ``LircdConnection``. This connection, if not +specified manually, will have default values that depend on the operating +system you are on. So the simplest way to construct ``Client`` is with no +arguments at all. + +.. code-block:: python + + from lirc import Client + + lirc_client = Client() + +Overriding LIRC Defaults on Initialization +------------------------------------------ -The simplest way to construct ``Lirc`` is with no arguments at all. +However, if we the defaults don't work for us? Let's say we're on Windows +and we want to connect over TCP to a remote LIRC server on another Windows +machine. So we've passed in an ``address`` to override the default so it doesn't +look for the daemon on the localhost. ``socket`` and ``timeout`` are passed in +just to show that we can, these are already the defaults on Windows. .. code-block:: python - from lirc import Lirc + import socket + from lirc import Client, LircdConnection + + client = Client( + connection=LircdConnection( + address=("10.16.30.2", 8765), + socket=socket.socket(socket.AF_INET, socket.SOCK_STREAM), + timeout=5.0 + ) + ) + +LIRC Initialization Defaults per Operating System +----------------------------------------------- + +From the options we may pass into the ``LircdConnection``, ``address`` +and ``socket`` will change depending on the operating system you are using. +The ``timeout`` always defaults to 5.0 (seconds). + +On Linux, this will attempt to connect to the lircd socket at +``/var/run/lirc/lircd`` and create a socket using ``AF_UNIX`` and +``SOCK_STREAM``. - lirc = Lirc() +On macOS, it will be almost identical to Linux except that all the paths +on macOS will be prefixed by ``/opt/local/`` so the connection to the lircd +socket will instead be at ``/opt/local/var/run/lirc/lircd``. The socket that +is created will be the same. -This will attempt to connect to the lircd socket at "/var/run/lirc/lircd" on -your system, create a socket using ``AF_UNIX`` and ``SOCK_STREAM``, and sets -a socket timeout of 5 seconds.
\ No newline at end of file +However if we are on Windows, we can't use unix domain sockets. Instead, +WinLIRC uses TCP to communicate with the lirc daemon. So instead of a string +for the address, it defaults to a tuple of ("localhost", 8765), which is the +default on WinLIRC. The first part contains the address whereas the second is +the port. Furthermore, the socket that is created uses ``AF_INET`` and +``SOCK_STREAM`` instead so we can connect over TCP. diff --git a/lirc/__init__.py b/lirc/__init__.py index fe8e829..a8dd85b 100644 --- a/lirc/__init__.py +++ b/lirc/__init__.py @@ -1,19 +1,6 @@ -from .exceptions import ( - InvalidReplyPacketFormatError, - LircError, - LircSocketError, - LircSocketTimeoutError, -) -from .lirc import Lirc -from .response import LircResponse +from lirc.client import Client +from lirc.connection.lircd_connection import LircdConnection __version__ = "0.1.0" -__all__ = [ - "Lirc", - "LircResponse", - "LircError", - "LircSocketError", - "LircSocketTimeoutError", - "InvalidReplyPacketFormatError", -] +__all__ = ["Client", "LircdConnection"] diff --git a/lirc/client.py b/lirc/client.py new file mode 100644 index 0000000..9b55fba --- /dev/null +++ b/lirc/client.py @@ -0,0 +1,218 @@ +from typing import List, Union + +from .connection.lircd_connection import LircdConnection +from .exceptions import LircdCommandFailureError +from .reply_packet_parser import ReplyPacketParser + + +class Client: + """Communicate with the lircd daemon.""" + + def __init__(self, connection: LircdConnection = LircdConnection()) -> None: + """ + Initialize the client by connecting to the lircd socket. + + Args: + connection: The connection to lircd. Created with defaults + depending on the operating system if one is not provided. + + Raises: + ValueError: If connection is not an instance of LircdConnection. + LircdConnectionError: If the socket cannot connect to the address. + """ + # Used for start_repeat and stop_repeat + self.__last_send_start_remote = None + self.__last_send_start_key = None + + if not isinstance(connection, LircdConnection): + raise ValueError("`connection` must be an instance of `LircdConnection`") + + self.__connection = connection + self.__connection.connect() + + def __send_command(self, command: str) -> Union[str, List[str]]: + """ + Send a command to lircd. + + Args: + command: A command from the lircd socket command interface. + + Returns: + The data from the lirc response packet. + """ + self.__connection.send(command) + + parser = ReplyPacketParser() + while not parser.is_finished: + line = self.__connection.readline() + parser.feed(line) + + parser_data = parser.data[0] if len(parser.data) == 1 else parser.data + + if not parser.success: + raise LircdCommandFailureError( + f"The `{command}` command sent to lircd failed: {parser_data}" + ) + + return parser_data + + def close(self): + """ + Close the connection to the socket. + """ + self.__connection.close() + + def send(self, remote: str, key: str, repeat_count: int = 1) -> None: + """ + Send an lircd SEND_ONCE command. + + Args: + key: The name of the key to send. + remote: The remote to use keys from. + repeat_count: The number of times to press this key. + + Raises: + LircdCommandFailure: If the command fails. + """ + self.__send_command(f"SEND_ONCE {remote} {key} {repeat_count}") + + def start_repeat(self, remote: str, key: str) -> None: + """ + Send an lircd SEND_START command. + + This will repeat the given key until + stop_repeat() is called. + + Args: + remote: The remote to use keys from. + key: The name of the key to start sending. + + Raises: + LircdCommandFailure: If the command fails. + """ + self.__last_send_start_remote = remote + self.__last_send_start_key = key + self.__send_command(f"SEND_START {remote} {key}") + + def stop_repeat(self, remote: str = "", key: str = "") -> None: + """ + Send an lircd SEND_STOP command. + + Args: + remote: The remote to stop. + key: The key to stop sending. + + These default to the remote and key + last used with send_start if not specified, + since the most likely use case is sending a + send_start and then a send_stop. + + Raises: + LircdCommandFailure: If the command fails. + """ + if self.__last_send_start_remote: + remote = self.__last_send_start_remote + + if self.__last_send_start_key: + key = self.__last_send_start_key + + self.__send_command(f"SEND_STOP {remote} {key}") + + def list_remotes(self) -> List[str]: + """ + List all the remotes that lirc has in + its `lircd.conf.d` folder. + + Raises: + LircdCommandFailure: If the command fails. + + Returns: + The list of all remotes. + """ + return self.__send_command("LIST") + + def list_remote_keys(self, remote: str) -> List[str]: + """ + List all the keys for a specific remote. + + Args: + remote: The remote to list the keys of. + + Raises: + LircdCommandFailure: If the command fails. + + Returns: + The list of keys from the remote. + """ + return self.__send_command(f"LIST {remote}") + + def start_logging(self, path: str) -> None: + """ + Send a lircd SET_INPUTLOG command which sets + the path to log all lircd received data to. + + Raises: + LircdCommandFailure: If the command fails. + """ + self.__send_command(f"SET_INPUTLOG {path}") + + def stop_logging(self) -> None: + """ + Stop logging to the inputlog path from start_logging. + + Raises: + LircdCommandFailure: If the command fails. + """ + # When calling SET_INPUTLOG without the path argument, + # it will stop logging and close the logfile. + self.__send_command("SET_INPUTLOG") + + def version(self) -> str: + """ + Retrieve the version of LIRC + + Raises: + LircdCommandFailure: If the command fails. + + Returns: + The version of LIRC being used. + """ + return self.__send_command("VERSION") + + def driver_option(self, key: str, value: str) -> None: + """ + Set driver-specific option named key to given value. + + Raises: + LircdCommandFailure: If the command fails. + """ + self.__send_command(f"DRV_OPTION {key} {value}") + + def simulate( + self, remote: str, key: str, repeat_count: int = 1, keycode: int = 0 + ) -> None: + """ + The --allow-simulate command line option to `lircd` must be active for this + command not to fail. + + Raises: + LircdCommandFailure: If the command fails. + """ + self.__send_command( + "SIMULATE %016d %02d %s %s\n" % (keycode, repeat_count, key, remote) + ) + + def set_transmitters(self, transmitters: Union[int, List[int]]) -> None: + """ + + Raises: + LircdCommandFailure: If the command fails. + """ + mask = transmitters + + if isinstance(transmitters, List): + mask = 0 + for transmitter in transmitters: + mask |= 1 << (int(transmitter) - 1) + + self.__send_command(f"SET_TRANSMITTERS {mask}") diff --git a/lirc/connection/__init__.py b/lirc/connection/__init__.py new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/lirc/connection/__init__.py diff --git a/lirc/connection/abstract_connection.py b/lirc/connection/abstract_connection.py new file mode 100644 index 0000000..ca855a6 --- /dev/null +++ b/lirc/connection/abstract_connection.py @@ -0,0 +1,37 @@ +import socket +from abc import ABC, abstractmethod +from typing import Union + + +class AbstractConnection(ABC): + @abstractmethod + def connect(self) -> None: + pass + + @abstractmethod + def readline(self) -> str: + pass + + @abstractmethod + def send(self, data: str): + pass + + @abstractmethod + def close(self) -> None: + pass + + @property + @abstractmethod + def socket(self) -> socket.socket: + pass + + @property + @abstractmethod + def address(self) -> Union[str, tuple]: + pass + + def __enter__(self): + return self + + def __exit__(self, exc_type, exc_val, exc_tb): + return self.close() diff --git a/lirc/connection/default_connection.py b/lirc/connection/default_connection.py new file mode 100644 index 0000000..4adb43f --- /dev/null +++ b/lirc/connection/default_connection.py @@ -0,0 +1,28 @@ +import platform +import socket as stdlib_socket +from typing import Tuple, Union + + +class DefaultConnection: + def __init__(self): + self.__operating_system = platform.system().capitalize() + + @property + def socket(self) -> stdlib_socket.socket: + if self.__operating_system == "Linux" or self.__operating_system == "Darwin": + return stdlib_socket.socket( + stdlib_socket.AF_UNIX, stdlib_socket.SOCK_STREAM + ) + + if self.__operating_system == "Windows": + return stdlib_socket.socket( + stdlib_socket.AF_INET, stdlib_socket.SOCK_STREAM + ) + + @property + def address(self) -> Union[str, Tuple[str, int]]: + return { + "Linux": "/var/run/lirc/lircd", + "Windows": ("localhost", 8765), + "Darwin": "/opt/run/var/run/lirc/lircd", + }[self.__operating_system] diff --git a/lirc/connection/lircd_connection.py b/lirc/connection/lircd_connection.py new file mode 100644 index 0000000..baa7d57 --- /dev/null +++ b/lirc/connection/lircd_connection.py @@ -0,0 +1,143 @@ +import socket as stdlib_socket +from collections import deque +from typing import Union + +from ..exceptions import LircdConnectionError, LircdSocketError +from .abstract_connection import AbstractConnection +from .default_connection import DefaultConnection + + +class LircdConnection(AbstractConnection): + def __init__( + self, + address: Union[str, tuple] = DefaultConnection().address, + socket: stdlib_socket.socket = DefaultConnection().socket, + timeout: float = 5.0, + ): + """ + Initialize the LircdConnection. This sets up state we'll + need, but it does not connect to that socket. To connect, + we can call connect() after initialization. + + Args: + address: The address to the socket. Defaults to different + values depending on the host operating system. + + Linux: "/var/run/lirc/lircd" + Windows: ("localhost", 8765) + Darwin: "/opt/run/var/run/lirc/lircd" + + socket: The socket to use to connect to lircd. The default + socket is determined using the host operating system. + + For Linux and Darwin, a unix domain socket connection is + used i.e. socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) + + However on Windows, a TCP socket is used. i.e. socket.socket( + socket.AF_INET, socket.SOCK_STREAM + ) + + timeout: The amount of time to wait for data from the socket before + we timeout. + """ + self.__buffer = deque() + self.__buffer_size = 4096 + self.__address = address + self.__socket = socket + self.__socket.settimeout(timeout) + + def connect(self): + """ + Connect to the socket at the address both specified on init. + + Raises: + LircdConnectionError: If the address is invalid or lircd + is not running. + """ + try: + self.__socket.connect(self.__address) + except FileNotFoundError: + raise LircdConnectionError( + f"Could not connect to lircd at {self.__address} with socket " + f"{self.__socket}. Did you start the `lircd` daemon?" + ) + except Exception as error: + raise LircdConnectionError(error) + + @property + def socket(self) -> stdlib_socket.socket: + return self.__socket + + @property + def address(self) -> str: + return self.__address + + def close(self): + """ + Closes the socket connection. + """ + self.__socket.close() + + def send(self, data: str): + """ + Send a commend to the lircd socket connection. + + Raises: + TypeError: if data is not a string. + """ + if not isinstance(data, str): + raise TypeError("data parameter to send() must be a string") + + if not data.endswith("\n"): + data += "\n" + + self.__socket.sendall(data.encode("utf-8")) + + def readline(self) -> str: + """ + Read a line of data from the lircd socket. + + We read 4096 bytes at a time as the buffer size. + Therefore after data is read from the socket, all + the lines are stored in a buffer if there is more than + 1 and subsequent calls grab a line that stored in that + buffer until it is empty. Then, another call to the + socket would be made. + + Raises: + TimeoutError: If we are not able to grab data from + the socket in a specified amount of time (the initial + timeout time on initialization). + + LircdSocketError: If some other error happened when + trying to read from the socket. + + Returns: + A line from the lircd socket. + """ + if len(self.__buffer) >= 1: + return self.__buffer.popleft() + + try: + packet = self.__socket.recv(self.__buffer_size) + + if packet.endswith(b"\n"): + packet = packet.strip() + + if b"\n" in packet: + self.__buffer.extend( + line.decode("utf-8") for line in packet.split(b"\n") + ) + else: + self.__buffer.append(packet.decode("utf-8")) + + return self.__buffer.popleft() + except stdlib_socket.timeout: + raise TimeoutError( + "could not find any data on the socket after " + f"{self.__socket.gettimeout()} seconds, socket timed out." + ) + except stdlib_socket.error as error: + raise LircdSocketError( + f"An error occurred while reading from the lircd socket: {error}" + ) diff --git a/lirc/exceptions.py b/lirc/exceptions.py index 063ca27..f16b61e 100644 --- a/lirc/exceptions.py +++ b/lirc/exceptions.py @@ -1,18 +1,26 @@ class LircError(Exception): - """A generic error that comes from this package.""" - + """ + A generic error that comes from this package. -class InvalidReplyPacketFormatError(LircError): - """The reply packet from LIRC was in an invalid format.""" + All errors are subclasses of this error so you + could catch all lirc errors by catching this one. + """ -class LircSocketError(LircError): +class LircdSocketError(LircError): """For when a generic error occurs with the lircd socket""" -class LircSocketTimeoutError(LircSocketError): +class LircdConnectionError(LircError): + """For when we are unable to connect to lircd.""" + + +class LircdInvalidReplyPacketError(LircError): + """The reply packet from lircd was in an invalid format.""" + + +class LircdCommandFailureError(LircError): """ - For when a timeout error occurs with the socket. - This can happen when recv does not find any data for - a given amount of time. + For when we send a command to the LIRC server + and that command fails to send, for whatever reason. """ diff --git a/lirc/lirc.py b/lirc/lirc.py deleted file mode 100644 index a60c869..0000000 --- a/lirc/lirc.py +++ /dev/null @@ -1,252 +0,0 @@ -import socket -import threading -from itertools import islice -from typing import List, Union - -from lirc.exceptions import ( - InvalidReplyPacketFormatError, - LircSocketError, - LircSocketTimeoutError, -) -from lirc.response import LircResponse - - -class Lirc: - """Communicate with the lircd daemon.""" - - DEFAULT_SOCKET_PATH = "/var/run/lirc/lircd" - ENCODING = "utf-8" - - def __init__( - self, - socket_path: str = DEFAULT_SOCKET_PATH, - socket: socket.socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM), - socket_timeout: int = 5, - ) -> None: - """ - Initialize Lirc by connecting to the lircd socket. - - :param socket_path: The path to the lircd socket. - :param socket: The socket.socket used to connect to the lircd socket. - :param socket_timeout: The amount of time to wait before timing out when - receiving data. - - :raises FileNotFoundError: If the socket path is not found. - """ - self.__lock = threading.Lock() - self.__socket = socket - self.__socket_timeout = socket_timeout - self.__socket.settimeout(self.__socket_timeout) - self.__socket.connect(socket_path) - - def __send_command(self, command: str) -> LircResponse: - """ - Send a command to lircd. - - :param command: A command from the lircd socket command interface. - See SOCKET COMMAND INTERFACE in https://www.lirc.org/html/lircd.html - for more information. - - :return: A LircResponse containing information on the command sent, - whether it was successful, and any other data, if any was sent. - """ - if not command.endswith("\n"): - command += "\n" - - try: - self.__lock.acquire() - self.__socket.sendall(command.encode(self.ENCODING)) - - reply_packet = self.__read_reply_packet() - return self.__parse_reply_packet(reply_packet) - finally: - self.__lock.release() - - def __read_reply_packet(self) -> str: - """ - Read the reply packet that lircd sends after a sent command. - - Reply packet format: - - BEGIN - <command> - [SUCCESS|ERROR] - [DATA - n - n lines of data] - END - - :return: The contents of the reply packet from BEGIN to END. - - :raises LircSocketTimeoutError: If recv does not find any data after - self.socket_timeout amount of seconds. - :raises LircSocketError: If something else went wrong with the socket. - """ - try: - BUFFER_LENGTH = 256 - buffer = "" - data = self.__socket.recv(BUFFER_LENGTH) - - # Ignore recieve requests that the socket caches - while "BEGIN" not in data.decode(self.ENCODING): - data = self.__socket.recv(BUFFER_LENGTH) - - buffer += data.decode(self.ENCODING) - - while not buffer.endswith("END\n"): - data = self.__socket.recv(BUFFER_LENGTH) - buffer += data.decode(self.ENCODING) - - return buffer - except (socket.timeout, socket.error) as e: - err = e.args[0] - if err == "timed out": - raise LircSocketTimeoutError( - f"could not find any data on the socket after " - f"{self.__socket_timeout} seconds, socket timed out." - ) - else: - raise LircSocketError(e) - - def __parse_reply_packet(self, packet: str) -> LircResponse: - """ - Parse the reply packet from lircd. - - :param packet: The reply packet from lirc. - - :return: An LircResponse containing the command sent, - whether it was successful, and any other data, if any was sent. - """ - lines = packet.split("\n") - current_index = 0 - response = LircResponse("", False, []) - - if lines[current_index] == "BEGIN": - current_index += 1 - else: - return response - - response.command = lines[current_index] - current_index += 1 - - response.success = True if lines[current_index] == "SUCCESS" else False - current_index += 1 - - if lines[current_index] == "END": - return response - elif lines[current_index] == "DATA": - current_index += 1 - data_length = int(lines[current_index]) - current_index += 1 - else: - raise InvalidReplyPacketFormatError( - f"Unknown format for reply packet: \n{lines}" - ) - - for line in islice(lines, current_index, current_index + data_length): - response.data.append(line) - - return response - - def send_once( - self, key: str, remote: str, repeat_count: int = 1 - ) -> Union[LircResponse, List[LircResponse]]: - """ - Send an LIRC SEND_ONCE command. - - Structure of the command: - * SEND_ONCE <remote-name> <key-name-from-remote-file> [repeat-count] - - :param key: The name of the key to send. - :param remote: The remote to use keys from. - :param repeat_count: The number of times to press this key. - - :return: a response from the command or a list of those responses - if repeat_count > 1. - """ - # The reason the optional repeat-count parameter isn't used in this - # implementaiton is because we want to be able to store all the - # responses from each command. - if repeat_count > 1: - responses = [] - - while repeat_count > 0: - responses.append(self.__send_command(f"SEND_ONCE {remote} {key}")) - repeat_count -= 1 - - return responses - - return self.__send_command(f"SEND_ONCE {remote} {key}") - - def send_start(self, key: str, remote: str) -> LircResponse: - """ - Send an LIRC SEND_START command. - - Structure of the command: - * SEND_START <remote-name> <key-name-from-remote-file> - - :param key: The name of the key to start sending. - :param remote: The remote to use keys from. - - :return: The response of the command. - """ - return self.__send_command(f"SEND_START {remote} {key}") - - def send_stop(self, key: str, remote: str) -> LircResponse: - """ - Send an LIRC SEND_STOP command. - - Structure of the command: - * SEND_STOP <remote-name> <key-name-from-remote-file> - - :param key: The name of the key to start sending. - :param remote: The remote to use keys from. - - :return: The response of the command. - """ - return self.__send_command(f"SEND_STOP") - - def list_remotes(self) -> LircResponse: - """ - List all the remotes in LIRC - - :return: The response of the command. - """ - return self.__send_command("LIST") - - def list_remote_keys(self, remote: str) -> LircResponse: - """ - List all the keys for a specific remote. - - :param remote: The remote to list the keys of. - - :return: The response of the command. - """ - return self.__send_command(f"LIST {remote}") - - def set_inputlog(self, path: str) -> LircResponse: - """ - Set the path to log all lircd received data to. - - :return: The response of the command. - """ - return self.__send_command(f"SET_INPUTLOG {path}") - - def stop_inputlog(self) -> LircResponse: - """ - Stop logging to the inputlog path from set_inputlog. - - :return: The response of the command. - """ - # When calling SET_INPUTLOG without the path argument, - # it will stop logging and close the logfile. - return self.__send_command("SET_INPUTLOG") - - def version(self) -> LircResponse: - """ - Retrieve the version of LIRC - - :return: The response of the command with - the version in the data field. - """ - return self.__send_command("VERSION") diff --git a/lirc/reply_packet_parser.py b/lirc/reply_packet_parser.py new file mode 100644 index 0000000..1db2527 --- /dev/null +++ b/lirc/reply_packet_parser.py @@ -0,0 +1,168 @@ +from enum import IntEnum, auto +from typing import List + +from .exceptions import LircdInvalidReplyPacketError + + +class ReplyPacketParser: + """ + Reads and parses reply packets sent from lircd. + + The reply packet is parsed by setting up a fsm + (finite state machine) and using an internal state + to keep track of where we are in the process. + + Reply packet format: + + BEGIN + <command> + [SUCCESS|ERROR] + [DATA + n + n lines of data] + END + + SIGHUP Format: + + BEGIN + SIGHUP + END + + The only other situation when lircd broadcasts to all + clients is when it receives the SIGHUP signal and + successfully re-reads its config file. Then it will + send a SIGHUP packet to its clients indicating that + its configuration might have changed. If we receive + this signal, we'll need to read in another packet. + """ + + class State(IntEnum): + BEGIN = auto() + COMMAND = auto() + RESULT = auto() + DATA = auto() + LINE_COUNT_LEFT = auto() + DATA_BODY = auto() + SIGHUP_END = auto() + END = auto() + FINISHED = auto() + + class Result(IntEnum): + SUCCESS = auto() + FAIL = auto() + UNDETERMINED = auto() + + def __init__(self): + self.__fsm = { + self.State.BEGIN: self.__begin, + self.State.COMMAND: self.__command, + self.State.RESULT: self.__result, + self.State.DATA: self.__data, + self.State.LINE_COUNT_LEFT: self.__line_count_left, + self.State.DATA_BODY: self.__data_body, + self.State.SIGHUP_END: self.__sighup_end, + self.State.END: self.__end, + } + self.__state = self.State.BEGIN + self.__command_result = self.Result.UNDETERMINED + self.__data_response = [] + self.__lines_left = None + + @property + def data(self) -> List: + return self.__data_response + + @property + def is_finished(self) -> bool: + return self.__state == self.State.FINISHED + + @property + def success(self) -> bool: + return self.__command_result == self.Result.SUCCESS + + def __begin(self, line: str) -> None: + if line == "BEGIN": + self.__state = self.State.COMMAND + else: + raise LircdInvalidReplyPacketError( + f"Expected a BEGIN line from lircd, got `{line}`." + ) + + def __command(self, line: str) -> None: + if line == "SIGHUP": + self.__state = self.State.SIGHUP_END + elif line: + self.__state = self.State.RESULT + else: + raise LircdInvalidReplyPacketError( + f"Expected a command line from lircd, got `{line}`." + ) + + def __result(self, line: str) -> None: + if line in ["SUCCESS", "ERROR"]: + self.__state = self.State.DATA + self.__command_result = ( + self.Result.SUCCESS if line == "SUCCESS" else self.Result.FAIL + ) + else: + raise LircdInvalidReplyPacketError( + f"Expected a result line from lircd, got `{line}`." + ) + + def __data(self, line: str) -> None: + if line == "END": + self.__state = self.State.FINISHED + elif line == "DATA": + self.__state = self.State.LINE_COUNT_LEFT + else: + raise LircdInvalidReplyPacketError( + f"Expected an END or DATA line from lircd, got `{line}`." + ) + + def __line_count_left(self, line: str) -> None: + try: + self.__lines_left = int(line) + except ValueError: + raise LircdInvalidReplyPacketError( + f"Expected a remaining line count line from lircd, got `{line}`." + ) + + self.__state = ( + self.State.END if self.__lines_left == 0 else self.State.DATA_BODY + ) + + def __data_body(self, line: str) -> None: + self.__data_response.append(line) + if len(self.__data_response) >= self.__lines_left: + self.__state = self.State.END + + def __sighup_end(self, line: str) -> None: + """ + SIGHUP packages may appear just after a command has been sent + to lircd, so this is to make sure they are not confused with + replies. If we encounter it, we reset and read in another packet. + """ + if line == "END": + self.__init__() + else: + raise LircdInvalidReplyPacketError( + "Expected an END line with the received SIGHUP packet from " + f"lircd, got `{line}` instead." + ) + + def __end(self, line: str) -> None: + if line == "END": + self.__state = self.State.FINISHED + else: + raise LircdInvalidReplyPacketError( + "Expected an END line from lircd's reply packet, " + f"got `{line}` instead." + ) + + def feed(self, line: str) -> None: + line = line.strip() + + if not line: + return + + self.__fsm[self.__state](line) diff --git a/lirc/response.py b/lirc/response.py deleted file mode 100644 index 3491037..0000000 --- a/lirc/response.py +++ /dev/null @@ -1,18 +0,0 @@ -class LircResponse: - """ - A response from the LIRC daemon. Stores the command that had - been sent, whether or not it was successful, and the parsed - reply packet data. - """ - - def __init__(self, command: str, success: bool, data: list) -> None: - self.command = command - self.success = success - self.data = data - - def __repr__(self) -> str: - return ( - f"LircResponse(command={self.command}, " - f"success={self.success}, " - f"data={self.data})" - ) diff --git a/poetry.lock b/poetry.lock index fe3fc7b..c3e16e5 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,290 +1,295 @@ [[package]] -category = "dev" -description = "A configurable sidebar-enabled Sphinx theme" name = "alabaster" +version = "0.7.12" +description = "A configurable sidebar-enabled Sphinx theme" +category = "dev" optional = false python-versions = "*" -version = "0.7.12" [[package]] -category = "dev" -description = "A small Python module for determining appropriate platform-specific dirs, e.g. a \"user data dir\"." name = "appdirs" +version = "1.4.4" +description = "A small Python module for determining appropriate platform-specific dirs, e.g. a \"user data dir\"." +category = "dev" optional = false python-versions = "*" -version = "1.4.4" [[package]] -category = "dev" -description = "Utilities for refactoring imports in python-like syntax." -marker = "python_version >= \"3.6.1\" and python_version < \"4.0.0\"" name = "aspy.refactor-imports" +version = "2.1.1" +description = "Utilities for refactoring imports in python-like syntax." +category = "dev" optional = false python-versions = ">=3.6.1" -version = "2.1.1" [package.dependencies] cached-property = "*" [[package]] -category = "dev" -description = "Atomic file writes." -marker = "sys_platform == \"win32\"" name = "atomicwrites" +version = "1.4.0" +description = "Atomic file writes." +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" -version = "1.4.0" [[package]] -category = "dev" -description = "Classes Without Boilerplate" name = "attrs" +version = "20.3.0" +description = "Classes Without Boilerplate" +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" -version = "19.3.0" [package.extras] -azure-pipelines = ["coverage", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "zope.interface", "pytest-azurepipelines"] -dev = ["coverage", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "zope.interface", "sphinx", "pre-commit"] -docs = ["sphinx", "zope.interface"] -tests = ["coverage", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "zope.interface"] +dev = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "zope.interface", "furo", "sphinx", "pre-commit"] +docs = ["furo", "sphinx", "zope.interface"] +tests = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "zope.interface"] +tests_no_zope = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six"] [[package]] -category = "dev" -description = "Internationalization utilities" name = "babel" +version = "2.9.0" +description = "Internationalization utilities" +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" -version = "2.8.0" [package.dependencies] pytz = ">=2015.7" [[package]] -category = "dev" -description = "The uncompromising code formatter." name = "black" +version = "20.8b1" +description = "The uncompromising code formatter." +category = "dev" optional = false python-versions = ">=3.6" -version = "19.10b0" [package.dependencies] appdirs = "*" -attrs = ">=18.1.0" -click = ">=6.5" +click = ">=7.1.2" +dataclasses = {version = ">=0.6", markers = "python_version < \"3.7\""} +mypy-extensions = ">=0.4.3" pathspec = ">=0.6,<1" -regex = "*" -toml = ">=0.9.4" +regex = ">=2020.1.8" +toml = ">=0.10.1" typed-ast = ">=1.4.0" +typing-extensions = ">=3.7.4" [package.extras] +colorama = ["colorama (>=0.4.3)"] d = ["aiohttp (>=3.3.2)", "aiohttp-cors"] [[package]] -category = "dev" -description = "Version-bump your software with a single command!" name = "bump2version" +version = "1.0.1" +description = "Version-bump your software with a single command!" +category = "dev" optional = false python-versions = ">=3.5" -version = "1.0.0" [[package]] -category = "dev" -description = "A decorator for caching properties in classes." -marker = "python_version >= \"3.6.1\" and python_version < \"4.0.0\"" name = "cached-property" +version = "1.5.2" +description = "A decorator for caching properties in classes." +category = "dev" optional = false python-versions = "*" -version = "1.5.1" [[package]] -category = "dev" -description = "Python package for providing Mozilla's CA Bundle." name = "certifi" +version = "2020.12.5" +description = "Python package for providing Mozilla's CA Bundle." +category = "dev" optional = false python-versions = "*" -version = "2020.6.20" [[package]] -category = "dev" -description = "Validate configuration and produce human readable error messages." -marker = "python_version >= \"3.6.1\" and python_version < \"4.0.0\"" name = "cfgv" +version = "3.2.0" +description = "Validate configuration and produce human readable error messages." +category = "dev" optional = false python-versions = ">=3.6.1" -version = "3.1.0" [[package]] -category = "dev" -description = "Universal encoding detector for Python 2 and 3" name = "chardet" +version = "3.0.4" +description = "Universal encoding detector for Python 2 and 3" +category = "dev" optional = false python-versions = "*" -version = "3.0.4" [[package]] -category = "dev" -description = "Composable command line interface toolkit" name = "click" +version = "7.1.2" +description = "Composable command line interface toolkit" +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" -version = "7.1.2" [[package]] -category = "dev" -description = "Hosted coverage reports for GitHub, Bitbucket and Gitlab" name = "codecov" +version = "2.1.10" +description = "Hosted coverage reports for GitHub, Bitbucket and Gitlab" +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" -version = "2.1.7" [package.dependencies] coverage = "*" requests = ">=2.7.9" [[package]] -category = "dev" -description = "Cross-platform colored terminal text." -marker = "sys_platform == \"win32\"" name = "colorama" +version = "0.4.4" +description = "Cross-platform colored terminal text." +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" -version = "0.4.3" [[package]] -category = "dev" -description = "Code coverage measurement for Python" name = "coverage" +version = "5.3" +description = "Code coverage measurement for Python" +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, <4" -version = "5.2" [package.extras] toml = ["toml"] [[package]] +name = "dataclasses" +version = "0.8" +description = "A backport of the dataclasses module for Python 3.6" category = "dev" -description = "Distribution utilities" -marker = "python_version >= \"3.6.1\" and python_version < \"4.0.0\"" +optional = false +python-versions = ">=3.6, <3.7" + +[[package]] name = "distlib" +version = "0.3.1" +description = "Distribution utilities" +category = "dev" optional = false python-versions = "*" -version = "0.3.1" [[package]] -category = "dev" -description = "Docutils -- Python Documentation Utilities" name = "docutils" +version = "0.16" +description = "Docutils -- Python Documentation Utilities" +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" -version = "0.16" [[package]] -category = "dev" -description = "A platform independent file lock." -marker = "python_version >= \"3.6.1\" and python_version < \"4.0.0\"" name = "filelock" +version = "3.0.12" +description = "A platform independent file lock." +category = "dev" optional = false python-versions = "*" -version = "3.0.12" [[package]] -category = "dev" -description = "the modular source code checker: pep8 pyflakes and co" name = "flake8" +version = "3.8.4" +description = "the modular source code checker: pep8 pyflakes and co" +category = "dev" optional = false python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7" -version = "3.8.3" [package.dependencies] +importlib-metadata = {version = "*", markers = "python_version < \"3.8\""} mccabe = ">=0.6.0,<0.7.0" pycodestyle = ">=2.6.0a1,<2.7.0" pyflakes = ">=2.2.0,<2.3.0" -[package.dependencies.importlib-metadata] -python = "<3.8" -version = "*" - [[package]] -category = "dev" -description = "File identification library for Python" -marker = "python_version >= \"3.6.1\" and python_version < \"4.0.0\"" name = "identify" +version = "1.5.10" +description = "File identification library for Python" +category = "dev" optional = false python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7" -version = "1.4.23" [package.extras] license = ["editdistance"] [[package]] -category = "dev" -description = "Internationalized Domain Names in Applications (IDNA)" name = "idna" +version = "2.10" +description = "Internationalized Domain Names in Applications (IDNA)" +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" -version = "2.10" [[package]] -category = "dev" -description = "Getting image size from png/jpeg/jpeg2000/gif file" name = "imagesize" +version = "1.2.0" +description = "Getting image size from png/jpeg/jpeg2000/gif file" +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" -version = "1.2.0" [[package]] -category = "dev" -description = "Read metadata from Python packages" -marker = "python_version >= \"3.6.1\" and python_version < \"3.8\" or python_version < \"3.8\"" name = "importlib-metadata" +version = "3.1.1" +description = "Read metadata from Python packages" +category = "dev" optional = false -python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7" -version = "1.7.0" +python-versions = ">=3.6" [package.dependencies] zipp = ">=0.5" [package.extras] -docs = ["sphinx", "rst.linker"] -testing = ["packaging", "pep517", "importlib-resources (>=1.3)"] +docs = ["sphinx", "jaraco.packaging (>=3.2)", "rst.linker (>=1.9)"] +testing = ["pytest (>=3.5,!=3.7.3)", "pytest-checkdocs (>=1.2.3)", "pytest-flake8", "pytest-cov", "jaraco.test (>=3.2.0)", "packaging", "pep517", "pyfakefs", "flufl.flake8", "pytest-black (>=0.3.7)", "pytest-mypy", "importlib-resources (>=1.3)"] [[package]] -category = "dev" -description = "Read resources from Python packages" -marker = "python_version >= \"3.6.1\" and python_version < \"3.7\"" name = "importlib-resources" +version = "3.3.0" +description = "Read resources from Python packages" +category = "dev" optional = false -python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7" -version = "3.0.0" +python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,>=2.7" [package.dependencies] -[package.dependencies.zipp] -python = "<3.8" -version = ">=0.4" +zipp = {version = ">=0.4", markers = "python_version < \"3.8\""} [package.extras] docs = ["sphinx", "rst.linker", "jaraco.packaging"] [[package]] +name = "iniconfig" +version = "1.1.1" +description = "iniconfig: brain-dead simple config-ini parsing" category = "dev" -description = "A Python utility / library to sort Python imports." +optional = false +python-versions = "*" + +[[package]] name = "isort" +version = "5.6.4" +description = "A Python utility / library to sort Python imports." +category = "dev" optional = false python-versions = ">=3.6,<4.0" -version = "5.0.9" [package.extras] -pipfile_deprecated_finder = ["pipreqs", "requirementslib", "tomlkit (>=0.5.3)"] +pipfile_deprecated_finder = ["pipreqs", "requirementslib"] requirements_deprecated_finder = ["pipreqs", "pip-api"] +colors = ["colorama (>=0.4.3,<0.5.0)"] [[package]] -category = "dev" -description = "A very fast and expressive template engine." name = "jinja2" +version = "2.11.2" +description = "A very fast and expressive template engine." +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" -version = "2.11.2" [package.dependencies] MarkupSafe = ">=0.23" @@ -293,187 +298,203 @@ MarkupSafe = ">=0.23" i18n = ["Babel (>=0.8)"] [[package]] -category = "dev" -description = "Safely add untrusted strings to HTML/XML markup." name = "markupsafe" +version = "1.1.1" +description = "Safely add untrusted strings to HTML/XML markup." +category = "dev" optional = false python-versions = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*" -version = "1.1.1" [[package]] -category = "dev" -description = "McCabe checker, plugin for flake8" name = "mccabe" +version = "0.6.1" +description = "McCabe checker, plugin for flake8" +category = "dev" optional = false python-versions = "*" -version = "0.6.1" [[package]] +name = "mslex" +version = "0.3.0" +description = "shlex for windows" category = "dev" -description = "More routines for operating on iterables, beyond itertools" -name = "more-itertools" optional = false python-versions = ">=3.5" -version = "8.4.0" [[package]] +name = "mypy-extensions" +version = "0.4.3" +description = "Experimental type system extensions for programs checked with the mypy typechecker." category = "dev" -description = "Node.js virtual environment builder" -marker = "python_version >= \"3.6.1\" and python_version < \"4.0.0\"" -name = "nodeenv" optional = false python-versions = "*" -version = "1.4.0" [[package]] +name = "nodeenv" +version = "1.5.0" +description = "Node.js virtual environment builder" category = "dev" -description = "Core utilities for Python packages" +optional = false +python-versions = "*" + +[[package]] name = "packaging" +version = "20.7" +description = "Core utilities for Python packages" +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" -version = "20.4" [package.dependencies] pyparsing = ">=2.0.2" -six = "*" [[package]] -category = "dev" -description = "Utility library for gitignore style pattern matching of file paths." name = "pathspec" +version = "0.8.1" +description = "Utility library for gitignore style pattern matching of file paths." +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" -version = "0.8.0" [[package]] -category = "dev" -description = "plugin and hook calling mechanisms for python" name = "pluggy" +version = "0.13.1" +description = "plugin and hook calling mechanisms for python" +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" -version = "0.13.1" [package.dependencies] -[package.dependencies.importlib-metadata] -python = "<3.8" -version = ">=0.12" +importlib-metadata = {version = ">=0.12", markers = "python_version < \"3.8\""} [package.extras] dev = ["pre-commit", "tox"] [[package]] +name = "pockets" +version = "0.9.1" +description = "A collection of helpful Python tools!" category = "dev" -description = "A framework for managing and maintaining multi-language pre-commit hooks." -marker = "python_version >= \"3.6.1\" and python_version < \"4.0.0\"" +optional = false +python-versions = "*" + +[package.dependencies] +six = ">=1.5.2" + +[[package]] name = "pre-commit" +version = "2.9.2" +description = "A framework for managing and maintaining multi-language pre-commit hooks." +category = "dev" optional = false python-versions = ">=3.6.1" -version = "2.6.0" [package.dependencies] cfgv = ">=2.0.0" identify = ">=1.0.0" +importlib-metadata = {version = "*", markers = "python_version < \"3.8\""} +importlib-resources = {version = "*", markers = "python_version < \"3.7\""} nodeenv = ">=0.11.1" pyyaml = ">=5.1" toml = "*" virtualenv = ">=20.0.8" -[package.dependencies.importlib-metadata] -python = "<3.8" -version = "*" +[[package]] +name = "psutil" +version = "5.7.3" +description = "Cross-platform lib for process and system monitoring in Python." +category = "dev" +optional = false +python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" -[package.dependencies.importlib-resources] -python = "<3.7" -version = "*" +[package.extras] +test = ["ipaddress", "mock", "unittest2", "enum34", "pywin32", "wmi"] [[package]] -category = "dev" -description = "library with cross-python path, ini-parsing, io, code, log facilities" name = "py" +version = "1.9.0" +description = "library with cross-python path, ini-parsing, io, code, log facilities" +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" -version = "1.9.0" [[package]] -category = "dev" -description = "Python style guide checker" name = "pycodestyle" +version = "2.6.0" +description = "Python style guide checker" +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" -version = "2.6.0" [[package]] -category = "dev" -description = "passive checker of Python programs" name = "pyflakes" +version = "2.2.0" +description = "passive checker of Python programs" +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" -version = "2.2.0" [[package]] -category = "dev" -description = "Pygments is a syntax highlighting package written in Python." name = "pygments" +version = "2.7.2" +description = "Pygments is a syntax highlighting package written in Python." +category = "dev" optional = false python-versions = ">=3.5" -version = "2.6.1" [[package]] -category = "dev" -description = "Python parsing module" name = "pyparsing" +version = "2.4.7" +description = "Python parsing module" +category = "dev" optional = false python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*" -version = "2.4.7" [[package]] -category = "dev" -description = "pytest: simple powerful testing with Python" name = "pytest" +version = "6.1.2" +description = "pytest: simple powerful testing with Python" +category = "dev" optional = false python-versions = ">=3.5" -version = "5.4.3" [package.dependencies] -atomicwrites = ">=1.0" +atomicwrites = {version = ">=1.0", markers = "sys_platform == \"win32\""} attrs = ">=17.4.0" -colorama = "*" -more-itertools = ">=4.0.0" +colorama = {version = "*", markers = "sys_platform == \"win32\""} +importlib-metadata = {version = ">=0.12", markers = "python_version < \"3.8\""} +iniconfig = "*" packaging = "*" pluggy = ">=0.12,<1.0" -py = ">=1.5.0" -wcwidth = "*" - -[package.dependencies.importlib-metadata] -python = "<3.8" -version = ">=0.12" +py = ">=1.8.2" +toml = "*" [package.extras] -checkqa-mypy = ["mypy (v0.761)"] +checkqa_mypy = ["mypy (==0.780)"] testing = ["argcomplete", "hypothesis (>=3.56)", "mock", "nose", "requests", "xmlschema"] [[package]] -category = "dev" -description = "Pytest plugin for measuring coverage." name = "pytest-cov" +version = "2.10.1" +description = "Pytest plugin for measuring coverage." +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" -version = "2.10.0" [package.dependencies] coverage = ">=4.4" pytest = ">=4.6" [package.extras] -testing = ["fields", "hunter", "process-tests (2.0.2)", "six", "pytest-xdist", "virtualenv"] +testing = ["fields", "hunter", "process-tests (==2.0.2)", "six", "pytest-xdist", "virtualenv"] [[package]] -category = "dev" -description = "pytest-sugar is a plugin for pytest that changes the default look and feel of pytest (e.g. progressbar, show tests that fail instantly)." name = "pytest-sugar" +version = "0.9.4" +description = "pytest-sugar is a plugin for pytest that changes the default look and feel of pytest (e.g. progressbar, show tests that fail instantly)." +category = "dev" optional = false python-versions = "*" -version = "0.9.4" [package.dependencies] packaging = ">=14.1" @@ -481,95 +502,92 @@ pytest = ">=2.9" termcolor = ">=1.1.0" [[package]] -category = "dev" -description = "World timezone definitions, modern and historical" name = "pytz" +version = "2020.4" +description = "World timezone definitions, modern and historical" +category = "dev" optional = false python-versions = "*" -version = "2020.1" [[package]] -category = "dev" -description = "YAML parser and emitter for Python" -marker = "python_version >= \"3.6.1\" and python_version < \"4.0.0\"" name = "pyyaml" +version = "5.3.1" +description = "YAML parser and emitter for Python" +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" -version = "5.3.1" [[package]] -category = "dev" -description = "Alternative regular expression module, to replace re." name = "regex" +version = "2020.11.13" +description = "Alternative regular expression module, to replace re." +category = "dev" optional = false python-versions = "*" -version = "2020.6.8" [[package]] -category = "dev" -description = "Python HTTP for Humans." name = "requests" +version = "2.25.0" +description = "Python HTTP for Humans." +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" -version = "2.24.0" [package.dependencies] certifi = ">=2017.4.17" chardet = ">=3.0.2,<4" idna = ">=2.5,<3" -urllib3 = ">=1.21.1,<1.25.0 || >1.25.0,<1.25.1 || >1.25.1,<1.26" +urllib3 = ">=1.21.1,<1.27" [package.extras] security = ["pyOpenSSL (>=0.14)", "cryptography (>=1.3.4)"] -socks = ["PySocks (>=1.5.6,<1.5.7 || >1.5.7)", "win-inet-pton"] +socks = ["PySocks (>=1.5.6,!=1.5.7)", "win-inet-pton"] [[package]] -category = "dev" -description = "Statically populate the `known_third_party` `isort` setting." -marker = "python_version >= \"3.6.1\" and python_version < \"4.0.0\"" name = "seed-isort-config" +version = "2.2.0" +description = "Statically populate the `known_third_party` `isort` setting." +category = "dev" optional = false python-versions = ">=3.6.1" -version = "2.2.0" [package.dependencies] "aspy.refactor-imports" = "*" [[package]] -category = "dev" -description = "Python 2 and 3 compatibility utilities" name = "six" +version = "1.15.0" +description = "Python 2 and 3 compatibility utilities" +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*" -version = "1.15.0" [[package]] -category = "dev" -description = "This package provides 26 stemmers for 25 languages generated from Snowball algorithms." name = "snowballstemmer" +version = "2.0.0" +description = "This package provides 26 stemmers for 25 languages generated from Snowball algorithms." +category = "dev" optional = false python-versions = "*" -version = "2.0.0" [[package]] -category = "dev" -description = "Python documentation generator" name = "sphinx" +version = "3.3.1" +description = "Python documentation generator" +category = "dev" optional = false python-versions = ">=3.5" -version = "3.1.2" [package.dependencies] -Jinja2 = ">=2.3" -Pygments = ">=2.0" alabaster = ">=0.7,<0.8" babel = ">=1.3" -colorama = ">=0.3.5" +colorama = {version = ">=0.3.5", markers = "sys_platform == \"win32\""} docutils = ">=0.12" imagesize = "*" +Jinja2 = ">=2.3" packaging = "*" +Pygments = ">=2.0" requests = ">=2.5.0" -setuptools = "*" snowballstemmer = ">=1.1" sphinxcontrib-applehelp = "*" sphinxcontrib-devhelp = "*" @@ -580,16 +598,16 @@ sphinxcontrib-serializinghtml = "*" [package.extras] docs = ["sphinxcontrib-websupport"] -lint = ["flake8 (>=3.5.0)", "flake8-import-order", "mypy (>=0.780)", "docutils-stubs"] +lint = ["flake8 (>=3.5.0)", "flake8-import-order", "mypy (>=0.790)", "docutils-stubs"] test = ["pytest", "pytest-cov", "html5lib", "typed-ast", "cython"] [[package]] -category = "dev" -description = "Read the Docs theme for Sphinx" name = "sphinx-rtd-theme" +version = "0.5.0" +description = "Read the Docs theme for Sphinx" +category = "dev" optional = false python-versions = "*" -version = "0.5.0" [package.dependencies] sphinx = "*" @@ -598,175 +616,182 @@ sphinx = "*" dev = ["transifex-client", "sphinxcontrib-httpdomain", "bump2version"] [[package]] -category = "dev" -description = "sphinxcontrib-applehelp is a sphinx extension which outputs Apple help books" name = "sphinxcontrib-applehelp" +version = "1.0.2" +description = "sphinxcontrib-applehelp is a sphinx extension which outputs Apple help books" +category = "dev" optional = false python-versions = ">=3.5" -version = "1.0.2" [package.extras] lint = ["flake8", "mypy", "docutils-stubs"] test = ["pytest"] [[package]] -category = "dev" -description = "sphinxcontrib-devhelp is a sphinx extension which outputs Devhelp document." name = "sphinxcontrib-devhelp" +version = "1.0.2" +description = "sphinxcontrib-devhelp is a sphinx extension which outputs Devhelp document." +category = "dev" optional = false python-versions = ">=3.5" -version = "1.0.2" [package.extras] lint = ["flake8", "mypy", "docutils-stubs"] test = ["pytest"] [[package]] -category = "dev" -description = "sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files" name = "sphinxcontrib-htmlhelp" +version = "1.0.3" +description = "sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files" +category = "dev" optional = false python-versions = ">=3.5" -version = "1.0.3" [package.extras] lint = ["flake8", "mypy", "docutils-stubs"] test = ["pytest", "html5lib"] [[package]] -category = "dev" -description = "A sphinx extension which renders display math in HTML via JavaScript" name = "sphinxcontrib-jsmath" +version = "1.0.1" +description = "A sphinx extension which renders display math in HTML via JavaScript" +category = "dev" optional = false python-versions = ">=3.5" -version = "1.0.1" [package.extras] test = ["pytest", "flake8", "mypy"] [[package]] +name = "sphinxcontrib-napoleon" +version = "0.7" +description = "Sphinx \"napoleon\" extension." category = "dev" -description = "sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp document." +optional = false +python-versions = "*" + +[package.dependencies] +pockets = ">=0.3" +six = ">=1.5.2" + +[[package]] name = "sphinxcontrib-qthelp" +version = "1.0.3" +description = "sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp document." +category = "dev" optional = false python-versions = ">=3.5" -version = "1.0.3" [package.extras] lint = ["flake8", "mypy", "docutils-stubs"] test = ["pytest"] [[package]] -category = "dev" -description = "sphinxcontrib-serializinghtml is a sphinx extension which outputs \"serialized\" HTML files (json and pickle)." name = "sphinxcontrib-serializinghtml" +version = "1.1.4" +description = "sphinxcontrib-serializinghtml is a sphinx extension which outputs \"serialized\" HTML files (json and pickle)." +category = "dev" optional = false python-versions = ">=3.5" -version = "1.1.4" [package.extras] lint = ["flake8", "mypy", "docutils-stubs"] test = ["pytest"] [[package]] -category = "dev" -description = "tasks runner for python projects" name = "taskipy" +version = "1.5.1" +description = "tasks runner for python projects" +category = "dev" optional = false python-versions = ">=3.6,<4.0" -version = "1.2.1" [package.dependencies] +mslex = ">=0.3.0,<0.4.0" +psutil = ">=5.7.2,<6.0.0" toml = ">=0.10.0,<0.11.0" [[package]] -category = "dev" -description = "ANSII Color formatting for output in terminal." name = "termcolor" +version = "1.1.0" +description = "ANSII Color formatting for output in terminal." +category = "dev" optional = false python-versions = "*" -version = "1.1.0" [[package]] -category = "dev" -description = "Python Library for Tom's Obvious, Minimal Language" name = "toml" +version = "0.10.2" +description = "Python Library for Tom's Obvious, Minimal Language" +category = "dev" optional = false -python-versions = "*" -version = "0.10.1" +python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*" [[package]] -category = "dev" -description = "a fork of Python 2 and 3 ast modules with type comment support" name = "typed-ast" +version = "1.4.1" +description = "a fork of Python 2 and 3 ast modules with type comment support" +category = "dev" optional = false python-versions = "*" -version = "1.4.1" [[package]] +name = "typing-extensions" +version = "3.7.4.3" +description = "Backported and Experimental Type Hints for Python 3.5+" category = "dev" -description = "HTTP library with thread-safe connection pooling, file post, and more." +optional = false +python-versions = "*" + +[[package]] name = "urllib3" +version = "1.26.2" +description = "HTTP library with thread-safe connection pooling, file post, and more." +category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, <4" -version = "1.25.9" [package.extras] brotli = ["brotlipy (>=0.6.0)"] -secure = ["certifi", "cryptography (>=1.3.4)", "idna (>=2.0.0)", "pyOpenSSL (>=0.14)", "ipaddress"] -socks = ["PySocks (>=1.5.6,<1.5.7 || >1.5.7,<2.0)"] +secure = ["pyOpenSSL (>=0.14)", "cryptography (>=1.3.4)", "idna (>=2.0.0)", "certifi", "ipaddress"] +socks = ["PySocks (>=1.5.6,!=1.5.7,<2.0)"] [[package]] -category = "dev" -description = "Virtual Python Environment builder" -marker = "python_version >= \"3.6.1\" and python_version < \"4.0.0\"" name = "virtualenv" +version = "20.2.1" +description = "Virtual Python Environment builder" +category = "dev" optional = false python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7" -version = "20.0.26" [package.dependencies] appdirs = ">=1.4.3,<2" distlib = ">=0.3.1,<1" filelock = ">=3.0.0,<4" +importlib-metadata = {version = ">=0.12", markers = "python_version < \"3.8\""} +importlib-resources = {version = ">=1.0", markers = "python_version < \"3.7\""} six = ">=1.9.0,<2" -[package.dependencies.importlib-metadata] -python = "<3.8" -version = ">=0.12,<2" - -[package.dependencies.importlib-resources] -python = "<3.7" -version = ">=1.0" - [package.extras] -docs = ["sphinx (>=3)", "sphinx-argparse (>=0.2.5)", "sphinx-rtd-theme (>=0.4.3)", "towncrier (>=19.9.0rc1)", "proselint (>=0.10.2)"] -testing = ["pytest (>=4)", "coverage (>=5)", "coverage-enable-subprocess (>=1)", "pytest-xdist (>=1.31.0)", "pytest-mock (>=2)", "pytest-env (>=0.6.2)", "pytest-randomly (>=1)", "pytest-timeout (>=1)", "pytest-freezegun (>=0.4.1)", "flaky (>=3)", "packaging (>=20.0)", "xonsh (>=0.9.16)"] +docs = ["proselint (>=0.10.2)", "sphinx (>=3)", "sphinx-argparse (>=0.2.5)", "sphinx-rtd-theme (>=0.4.3)", "towncrier (>=19.9.0rc1)"] +testing = ["coverage (>=4)", "coverage-enable-subprocess (>=1)", "flaky (>=3)", "pytest (>=4)", "pytest-env (>=0.6.2)", "pytest-freezegun (>=0.4.1)", "pytest-mock (>=2)", "pytest-randomly (>=1)", "pytest-timeout (>=1)", "pytest-xdist (>=1.31.0)", "packaging (>=20.0)", "xonsh (>=0.9.16)"] [[package]] -category = "dev" -description = "Measures the displayed width of unicode strings in a terminal" -name = "wcwidth" -optional = false -python-versions = "*" -version = "0.2.5" - -[[package]] -category = "dev" -description = "Backport of pathlib-compatible object wrapper for zip files" -marker = "python_version >= \"3.6.1\" and python_version < \"3.7\" or python_version >= \"3.6.1\" and python_version < \"3.8\" or python_version < \"3.8\"" name = "zipp" +version = "3.4.0" +description = "Backport of pathlib-compatible object wrapper for zip files" +category = "dev" optional = false python-versions = ">=3.6" -version = "3.1.0" [package.extras] docs = ["sphinx", "jaraco.packaging (>=3.2)", "rst.linker (>=1.9)"] -testing = ["jaraco.itertools", "func-timeout"] +testing = ["pytest (>=3.5,!=3.7.3)", "pytest-checkdocs (>=1.2.3)", "pytest-flake8", "pytest-cov", "jaraco.test (>=3.2.0)", "jaraco.itertools", "func-timeout", "pytest-black (>=0.3.7)", "pytest-mypy"] [metadata] -content-hash = "1a1721ff97e3865fb63f457df5be0323e4fc86f551c28a1fa819d9a9575921a6" +lock-version = "1.1" python-versions = "^3.6" +content-hash = "3272e93d8d04606d2b1a4700f29f57efadc01a4d037a4e13a5d3736991a1a46f" [metadata.files] alabaster = [ @@ -786,32 +811,31 @@ atomicwrites = [ {file = "atomicwrites-1.4.0.tar.gz", hash = "sha256:ae70396ad1a434f9c7046fd2dd196fc04b12f9e91ffb859164193be8b6168a7a"}, ] attrs = [ - {file = "attrs-19.3.0-py2.py3-none-any.whl", hash = "sha256:08a96c641c3a74e44eb59afb61a24f2cb9f4d7188748e76ba4bb5edfa3cb7d1c"}, - {file = "attrs-19.3.0.tar.gz", hash = "sha256:f7b7ce16570fe9965acd6d30101a28f62fb4a7f9e926b3bbc9b61f8b04247e72"}, + {file = "attrs-20.3.0-py2.py3-none-any.whl", hash = "sha256:31b2eced602aa8423c2aea9c76a724617ed67cf9513173fd3a4f03e3a929c7e6"}, + {file = "attrs-20.3.0.tar.gz", hash = "sha256:832aa3cde19744e49938b91fea06d69ecb9e649c93ba974535d08ad92164f700"}, ] babel = [ - {file = "Babel-2.8.0-py2.py3-none-any.whl", hash = "sha256:d670ea0b10f8b723672d3a6abeb87b565b244da220d76b4dba1b66269ec152d4"}, - {file = "Babel-2.8.0.tar.gz", hash = "sha256:1aac2ae2d0d8ea368fa90906567f5c08463d98ade155c0c4bfedd6a0f7160e38"}, + {file = "Babel-2.9.0-py2.py3-none-any.whl", hash = "sha256:9d35c22fcc79893c3ecc85ac4a56cde1ecf3f19c540bba0922308a6c06ca6fa5"}, + {file = "Babel-2.9.0.tar.gz", hash = "sha256:da031ab54472314f210b0adcff1588ee5d1d1d0ba4dbd07b94dba82bde791e05"}, ] black = [ - {file = "black-19.10b0-py36-none-any.whl", hash = "sha256:1b30e59be925fafc1ee4565e5e08abef6b03fe455102883820fe5ee2e4734e0b"}, - {file = "black-19.10b0.tar.gz", hash = "sha256:c2edb73a08e9e0e6f65a0e6af18b059b8b1cdd5bef997d7a0b181df93dc81539"}, + {file = "black-20.8b1.tar.gz", hash = "sha256:1c02557aa099101b9d21496f8a914e9ed2222ef70336404eeeac8edba836fbea"}, ] bump2version = [ - {file = "bump2version-1.0.0-py2.py3-none-any.whl", hash = "sha256:477f0e18a0d58e50bb3dbc9af7fcda464fd0ebfc7a6151d8888602d7153171a0"}, - {file = "bump2version-1.0.0.tar.gz", hash = "sha256:cd4f3a231305e405ed8944d8ff35bd742d9bc740ad62f483bd0ca21ce7131984"}, + {file = "bump2version-1.0.1-py2.py3-none-any.whl", hash = "sha256:37f927ea17cde7ae2d7baf832f8e80ce3777624554a653006c9144f8017fe410"}, + {file = "bump2version-1.0.1.tar.gz", hash = "sha256:762cb2bfad61f4ec8e2bdf452c7c267416f8c70dd9ecb1653fd0bbb01fa936e6"}, ] cached-property = [ - {file = "cached-property-1.5.1.tar.gz", hash = "sha256:9217a59f14a5682da7c4b8829deadbfc194ac22e9908ccf7c8820234e80a1504"}, - {file = "cached_property-1.5.1-py2.py3-none-any.whl", hash = "sha256:3a026f1a54135677e7da5ce819b0c690f156f37976f3e30c5430740725203d7f"}, + {file = "cached-property-1.5.2.tar.gz", hash = "sha256:9fa5755838eecbb2d234c3aa390bd80fbd3ac6b6869109bfc1b499f7bd89a130"}, + {file = "cached_property-1.5.2-py2.py3-none-any.whl", hash = "sha256:df4f613cf7ad9a588cc381aaf4a512d26265ecebd5eb9e1ba12f1319eb85a6a0"}, ] certifi = [ - {file = "certifi-2020.6.20-py2.py3-none-any.whl", hash = "sha256:8fc0819f1f30ba15bdb34cceffb9ef04d99f420f68eb75d901e9560b8749fc41"}, - {file = "certifi-2020.6.20.tar.gz", hash = "sha256:5930595817496dd21bb8dc35dad090f1c2cd0adfaf21204bf6732ca5d8ee34d3"}, + {file = "certifi-2020.12.5-py2.py3-none-any.whl", hash = "sha256:719a74fb9e33b9bd44cc7f3a8d94bc35e4049deebe19ba7d8e108280cfd59830"}, + {file = "certifi-2020.12.5.tar.gz", hash = "sha256:1a4995114262bffbc2413b159f2a1a480c969de6e6eb13ee966d470af86af59c"}, ] cfgv = [ - {file = "cfgv-3.1.0-py2.py3-none-any.whl", hash = "sha256:1ccf53320421aeeb915275a196e23b3b8ae87dea8ac6698b1638001d4a486d53"}, - {file = "cfgv-3.1.0.tar.gz", hash = "sha256:c8e8f552ffcc6194f4e18dd4f68d9aef0c0d58ae7e7be8c82bee3c5e9edfa513"}, + {file = "cfgv-3.2.0-py2.py3-none-any.whl", hash = "sha256:32e43d604bbe7896fe7c248a9c2276447dbef840feb28fe20494f62af110211d"}, + {file = "cfgv-3.2.0.tar.gz", hash = "sha256:cf22deb93d4bcf92f345a5c3cd39d3d41d6340adc60c78bbbd6588c384fda6a1"}, ] chardet = [ {file = "chardet-3.0.4-py2.py3-none-any.whl", hash = "sha256:fc323ffcaeaed0e0a02bf4d117757b98aed530d9ed4531e3e15460124c106691"}, @@ -822,49 +846,53 @@ click = [ {file = "click-7.1.2.tar.gz", hash = "sha256:d2b5255c7c6349bc1bd1e59e08cd12acbbd63ce649f2588755783aa94dfb6b1a"}, ] codecov = [ - {file = "codecov-2.1.7-py2.py3-none-any.whl", hash = "sha256:b67bb8029e8340a7bf22c71cbece5bd18c96261fdebc2f105ee4d5a005bc8728"}, - {file = "codecov-2.1.7-py3.8.egg", hash = "sha256:d8b8109f44edad03b24f5f189dac8de9b1e3dc3c791fa37eeaf8c7381503ec34"}, - {file = "codecov-2.1.7.tar.gz", hash = "sha256:491938ad774ea94a963d5d16354c7299e90422a33a353ba0d38d0943ed1d5091"}, + {file = "codecov-2.1.10-py2.py3-none-any.whl", hash = "sha256:61bc71b5f58be8000bf9235aa9d0112f8fd3acca00aa02191bb81426d22a8584"}, + {file = "codecov-2.1.10-py3.8.egg", hash = "sha256:a333626e6ff882db760ce71a1d84baf80ddff2cd459a3cc49b41fdac47d77ca5"}, + {file = "codecov-2.1.10.tar.gz", hash = "sha256:d30ad6084501224b1ba699cbf018a340bb9553eb2701301c14133995fdd84f33"}, ] colorama = [ - {file = "colorama-0.4.3-py2.py3-none-any.whl", hash = "sha256:7d73d2a99753107a36ac6b455ee49046802e59d9d076ef8e47b61499fa29afff"}, - {file = "colorama-0.4.3.tar.gz", hash = "sha256:e96da0d330793e2cb9485e9ddfd918d456036c7149416295932478192f4436a1"}, + {file = "colorama-0.4.4-py2.py3-none-any.whl", hash = "sha256:9f47eda37229f68eee03b24b9748937c7dc3868f906e8ba69fbcbdd3bc5dc3e2"}, + {file = "colorama-0.4.4.tar.gz", hash = "sha256:5941b2b48a20143d2267e95b1c2a7603ce057ee39fd88e7329b0c292aa16869b"}, ] coverage = [ - {file = "coverage-5.2-cp27-cp27m-macosx_10_13_intel.whl", hash = "sha256:d9ad0a988ae20face62520785ec3595a5e64f35a21762a57d115dae0b8fb894a"}, - {file = "coverage-5.2-cp27-cp27m-macosx_10_9_x86_64.whl", hash = "sha256:4bb385a747e6ae8a65290b3df60d6c8a692a5599dc66c9fa3520e667886f2e10"}, - {file = "coverage-5.2-cp27-cp27m-manylinux1_i686.whl", hash = "sha256:9702e2cb1c6dec01fb8e1a64c015817c0800a6eca287552c47a5ee0ebddccf62"}, - {file = "coverage-5.2-cp27-cp27m-manylinux1_x86_64.whl", hash = "sha256:42fa45a29f1059eda4d3c7b509589cc0343cd6bbf083d6118216830cd1a51613"}, - {file = "coverage-5.2-cp27-cp27m-win32.whl", hash = "sha256:41d88736c42f4a22c494c32cc48a05828236e37c991bd9760f8923415e3169e4"}, - {file = "coverage-5.2-cp27-cp27m-win_amd64.whl", hash = "sha256:bbb387811f7a18bdc61a2ea3d102be0c7e239b0db9c83be7bfa50f095db5b92a"}, - {file = "coverage-5.2-cp27-cp27mu-manylinux1_i686.whl", hash = "sha256:3740b796015b889e46c260ff18b84683fa2e30f0f75a171fb10d2bf9fb91fc70"}, - {file = "coverage-5.2-cp27-cp27mu-manylinux1_x86_64.whl", hash = "sha256:ebf2431b2d457ae5217f3a1179533c456f3272ded16f8ed0b32961a6d90e38ee"}, - {file = "coverage-5.2-cp35-cp35m-macosx_10_13_x86_64.whl", hash = "sha256:d54d7ea74cc00482a2410d63bf10aa34ebe1c49ac50779652106c867f9986d6b"}, - {file = "coverage-5.2-cp35-cp35m-manylinux1_i686.whl", hash = "sha256:87bdc8135b8ee739840eee19b184804e5d57f518578ffc797f5afa2c3c297913"}, - {file = "coverage-5.2-cp35-cp35m-manylinux1_x86_64.whl", hash = "sha256:ed9a21502e9223f563e071759f769c3d6a2e1ba5328c31e86830368e8d78bc9c"}, - {file = "coverage-5.2-cp35-cp35m-win32.whl", hash = "sha256:509294f3e76d3f26b35083973fbc952e01e1727656d979b11182f273f08aa80b"}, - {file = "coverage-5.2-cp35-cp35m-win_amd64.whl", hash = "sha256:ca63dae130a2e788f2b249200f01d7fa240f24da0596501d387a50e57aa7075e"}, - {file = "coverage-5.2-cp36-cp36m-macosx_10_13_x86_64.whl", hash = "sha256:5c74c5b6045969b07c9fb36b665c9cac84d6c174a809fc1b21bdc06c7836d9a0"}, - {file = "coverage-5.2-cp36-cp36m-manylinux1_i686.whl", hash = "sha256:c32aa13cc3fe86b0f744dfe35a7f879ee33ac0a560684fef0f3e1580352b818f"}, - {file = "coverage-5.2-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:1e58fca3d9ec1a423f1b7f2aa34af4f733cbfa9020c8fe39ca451b6071237405"}, - {file = "coverage-5.2-cp36-cp36m-win32.whl", hash = "sha256:3b2c34690f613525672697910894b60d15800ac7e779fbd0fccf532486c1ba40"}, - {file = "coverage-5.2-cp36-cp36m-win_amd64.whl", hash = "sha256:a4d511012beb967a39580ba7d2549edf1e6865a33e5fe51e4dce550522b3ac0e"}, - {file = "coverage-5.2-cp37-cp37m-macosx_10_13_x86_64.whl", hash = "sha256:32ecee61a43be509b91a526819717d5e5650e009a8d5eda8631a59c721d5f3b6"}, - {file = "coverage-5.2-cp37-cp37m-manylinux1_i686.whl", hash = "sha256:6f91b4492c5cde83bfe462f5b2b997cdf96a138f7c58b1140f05de5751623cf1"}, - {file = "coverage-5.2-cp37-cp37m-manylinux1_x86_64.whl", hash = "sha256:bfcc811883699ed49afc58b1ed9f80428a18eb9166422bce3c31a53dba00fd1d"}, - {file = "coverage-5.2-cp37-cp37m-win32.whl", hash = "sha256:60a3d36297b65c7f78329b80120f72947140f45b5c7a017ea730f9112b40f2ec"}, - {file = "coverage-5.2-cp37-cp37m-win_amd64.whl", hash = "sha256:12eaccd86d9a373aea59869bc9cfa0ab6ba8b1477752110cb4c10d165474f703"}, - {file = "coverage-5.2-cp38-cp38-macosx_10_13_x86_64.whl", hash = "sha256:d82db1b9a92cb5c67661ca6616bdca6ff931deceebb98eecbd328812dab52032"}, - {file = "coverage-5.2-cp38-cp38-manylinux1_i686.whl", hash = "sha256:214eb2110217f2636a9329bc766507ab71a3a06a8ea30cdeebb47c24dce5972d"}, - {file = "coverage-5.2-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:8a3decd12e7934d0254939e2bf434bf04a5890c5bf91a982685021786a08087e"}, - {file = "coverage-5.2-cp38-cp38-win32.whl", hash = "sha256:1dcebae667b73fd4aa69237e6afb39abc2f27520f2358590c1b13dd90e32abe7"}, - {file = "coverage-5.2-cp38-cp38-win_amd64.whl", hash = "sha256:f50632ef2d749f541ca8e6c07c9928a37f87505ce3a9f20c8446ad310f1aa87b"}, - {file = "coverage-5.2-cp39-cp39-macosx_10_13_x86_64.whl", hash = "sha256:7403675df5e27745571aba1c957c7da2dacb537c21e14007ec3a417bf31f7f3d"}, - {file = "coverage-5.2-cp39-cp39-manylinux1_i686.whl", hash = "sha256:0fc4e0d91350d6f43ef6a61f64a48e917637e1dcfcba4b4b7d543c628ef82c2d"}, - {file = "coverage-5.2-cp39-cp39-manylinux1_x86_64.whl", hash = "sha256:25fe74b5b2f1b4abb11e103bb7984daca8f8292683957d0738cd692f6a7cc64c"}, - {file = "coverage-5.2-cp39-cp39-win32.whl", hash = "sha256:d67599521dff98ec8c34cd9652cbcfe16ed076a2209625fca9dc7419b6370e5c"}, - {file = "coverage-5.2-cp39-cp39-win_amd64.whl", hash = "sha256:10f2a618a6e75adf64329f828a6a5b40244c1c50f5ef4ce4109e904e69c71bd2"}, - {file = "coverage-5.2.tar.gz", hash = "sha256:1874bdc943654ba46d28f179c1846f5710eda3aeb265ff029e0ac2b52daae404"}, + {file = "coverage-5.3-cp27-cp27m-macosx_10_13_intel.whl", hash = "sha256:bd3166bb3b111e76a4f8e2980fa1addf2920a4ca9b2b8ca36a3bc3dedc618270"}, + {file = "coverage-5.3-cp27-cp27m-macosx_10_9_x86_64.whl", hash = "sha256:9342dd70a1e151684727c9c91ea003b2fb33523bf19385d4554f7897ca0141d4"}, + {file = "coverage-5.3-cp27-cp27m-manylinux1_i686.whl", hash = "sha256:63808c30b41f3bbf65e29f7280bf793c79f54fb807057de7e5238ffc7cc4d7b9"}, + {file = "coverage-5.3-cp27-cp27m-manylinux1_x86_64.whl", hash = "sha256:4d6a42744139a7fa5b46a264874a781e8694bb32f1d76d8137b68138686f1729"}, + {file = "coverage-5.3-cp27-cp27m-win32.whl", hash = "sha256:86e9f8cd4b0cdd57b4ae71a9c186717daa4c5a99f3238a8723f416256e0b064d"}, + {file = "coverage-5.3-cp27-cp27m-win_amd64.whl", hash = "sha256:7858847f2d84bf6e64c7f66498e851c54de8ea06a6f96a32a1d192d846734418"}, + {file = "coverage-5.3-cp27-cp27mu-manylinux1_i686.whl", hash = "sha256:530cc8aaf11cc2ac7430f3614b04645662ef20c348dce4167c22d99bec3480e9"}, + {file = "coverage-5.3-cp27-cp27mu-manylinux1_x86_64.whl", hash = "sha256:381ead10b9b9af5f64646cd27107fb27b614ee7040bb1226f9c07ba96625cbb5"}, + {file = "coverage-5.3-cp35-cp35m-macosx_10_13_x86_64.whl", hash = "sha256:71b69bd716698fa62cd97137d6f2fdf49f534decb23a2c6fc80813e8b7be6822"}, + {file = "coverage-5.3-cp35-cp35m-manylinux1_i686.whl", hash = "sha256:1d44bb3a652fed01f1f2c10d5477956116e9b391320c94d36c6bf13b088a1097"}, + {file = "coverage-5.3-cp35-cp35m-manylinux1_x86_64.whl", hash = "sha256:1c6703094c81fa55b816f5ae542c6ffc625fec769f22b053adb42ad712d086c9"}, + {file = "coverage-5.3-cp35-cp35m-win32.whl", hash = "sha256:cedb2f9e1f990918ea061f28a0f0077a07702e3819602d3507e2ff98c8d20636"}, + {file = "coverage-5.3-cp35-cp35m-win_amd64.whl", hash = "sha256:7f43286f13d91a34fadf61ae252a51a130223c52bfefb50310d5b2deb062cf0f"}, + {file = "coverage-5.3-cp36-cp36m-macosx_10_13_x86_64.whl", hash = "sha256:c851b35fc078389bc16b915a0a7c1d5923e12e2c5aeec58c52f4aa8085ac8237"}, + {file = "coverage-5.3-cp36-cp36m-manylinux1_i686.whl", hash = "sha256:aac1ba0a253e17889550ddb1b60a2063f7474155465577caa2a3b131224cfd54"}, + {file = "coverage-5.3-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:2b31f46bf7b31e6aa690d4c7a3d51bb262438c6dcb0d528adde446531d0d3bb7"}, + {file = "coverage-5.3-cp36-cp36m-win32.whl", hash = "sha256:c5f17ad25d2c1286436761b462e22b5020d83316f8e8fcb5deb2b3151f8f1d3a"}, + {file = "coverage-5.3-cp36-cp36m-win_amd64.whl", hash = "sha256:aef72eae10b5e3116bac6957de1df4d75909fc76d1499a53fb6387434b6bcd8d"}, + {file = "coverage-5.3-cp37-cp37m-macosx_10_13_x86_64.whl", hash = "sha256:e8caf961e1b1a945db76f1b5fa9c91498d15f545ac0ababbe575cfab185d3bd8"}, + {file = "coverage-5.3-cp37-cp37m-manylinux1_i686.whl", hash = "sha256:29a6272fec10623fcbe158fdf9abc7a5fa032048ac1d8631f14b50fbfc10d17f"}, + {file = "coverage-5.3-cp37-cp37m-manylinux1_x86_64.whl", hash = "sha256:2d43af2be93ffbad25dd959899b5b809618a496926146ce98ee0b23683f8c51c"}, + {file = "coverage-5.3-cp37-cp37m-win32.whl", hash = "sha256:c3888a051226e676e383de03bf49eb633cd39fc829516e5334e69b8d81aae751"}, + {file = "coverage-5.3-cp37-cp37m-win_amd64.whl", hash = "sha256:9669179786254a2e7e57f0ecf224e978471491d660aaca833f845b72a2df3709"}, + {file = "coverage-5.3-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:0203acd33d2298e19b57451ebb0bed0ab0c602e5cf5a818591b4918b1f97d516"}, + {file = "coverage-5.3-cp38-cp38-manylinux1_i686.whl", hash = "sha256:582ddfbe712025448206a5bc45855d16c2e491c2dd102ee9a2841418ac1c629f"}, + {file = "coverage-5.3-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:0f313707cdecd5cd3e217fc68c78a960b616604b559e9ea60cc16795c4304259"}, + {file = "coverage-5.3-cp38-cp38-win32.whl", hash = "sha256:78e93cc3571fd928a39c0b26767c986188a4118edc67bc0695bc7a284da22e82"}, + {file = "coverage-5.3-cp38-cp38-win_amd64.whl", hash = "sha256:8f264ba2701b8c9f815b272ad568d555ef98dfe1576802ab3149c3629a9f2221"}, + {file = "coverage-5.3-cp39-cp39-macosx_10_13_x86_64.whl", hash = "sha256:50691e744714856f03a86df3e2bff847c2acede4c191f9a1da38f088df342978"}, + {file = "coverage-5.3-cp39-cp39-manylinux1_i686.whl", hash = "sha256:9361de40701666b034c59ad9e317bae95c973b9ff92513dd0eced11c6adf2e21"}, + {file = "coverage-5.3-cp39-cp39-manylinux1_x86_64.whl", hash = "sha256:c1b78fb9700fc961f53386ad2fd86d87091e06ede5d118b8a50dea285a071c24"}, + {file = "coverage-5.3-cp39-cp39-win32.whl", hash = "sha256:cb7df71de0af56000115eafd000b867d1261f786b5eebd88a0ca6360cccfaca7"}, + {file = "coverage-5.3-cp39-cp39-win_amd64.whl", hash = "sha256:47a11bdbd8ada9b7ee628596f9d97fbd3851bd9999d398e9436bd67376dbece7"}, + {file = "coverage-5.3.tar.gz", hash = "sha256:280baa8ec489c4f542f8940f9c4c2181f0306a8ee1a54eceba071a449fb870a0"}, +] +dataclasses = [ + {file = "dataclasses-0.8-py3-none-any.whl", hash = "sha256:0201d89fa866f68c8ebd9d08ee6ff50c0b255f8ec63a71c16fda7af82bb887bf"}, + {file = "dataclasses-0.8.tar.gz", hash = "sha256:8479067f342acf957dc82ec415d355ab5edb7e7646b90dc6e2fd1d96ad084c97"}, ] distlib = [ {file = "distlib-0.3.1-py2.py3-none-any.whl", hash = "sha256:8c09de2c67b3e7deef7184574fc060ab8a793e7adbb183d942c389c8b13c52fb"}, @@ -879,12 +907,12 @@ filelock = [ {file = "filelock-3.0.12.tar.gz", hash = "sha256:18d82244ee114f543149c66a6e0c14e9c4f8a1044b5cdaadd0f82159d6a6ff59"}, ] flake8 = [ - {file = "flake8-3.8.3-py2.py3-none-any.whl", hash = "sha256:15e351d19611c887e482fb960eae4d44845013cc142d42896e9862f775d8cf5c"}, - {file = "flake8-3.8.3.tar.gz", hash = "sha256:f04b9fcbac03b0a3e58c0ab3a0ecc462e023a9faf046d57794184028123aa208"}, + {file = "flake8-3.8.4-py2.py3-none-any.whl", hash = "sha256:749dbbd6bfd0cf1318af27bf97a14e28e5ff548ef8e5b1566ccfb25a11e7c839"}, + {file = "flake8-3.8.4.tar.gz", hash = "sha256:aadae8761ec651813c24be05c6f7b4680857ef6afaae4651a4eccaef97ce6c3b"}, ] identify = [ - {file = "identify-1.4.23-py2.py3-none-any.whl", hash = "sha256:882c4b08b4569517b5f2257ecca180e01f38400a17f429f5d0edff55530c41c7"}, - {file = "identify-1.4.23.tar.gz", hash = "sha256:f89add935982d5bc62913ceee16c9297d8ff14b226e9d3072383a4e38136b656"}, + {file = "identify-1.5.10-py2.py3-none-any.whl", hash = "sha256:cc86e6a9a390879dcc2976cef169dd9cc48843ed70b7380f321d1b118163c60e"}, + {file = "identify-1.5.10.tar.gz", hash = "sha256:943cd299ac7f5715fcb3f684e2fc1594c1e0f22a90d15398e5888143bd4144b5"}, ] idna = [ {file = "idna-2.10-py2.py3-none-any.whl", hash = "sha256:b97d804b1e9b523befed77c48dacec60e6dcb0b5391d57af6a65a312a90648c0"}, @@ -895,16 +923,20 @@ imagesize = [ {file = "imagesize-1.2.0.tar.gz", hash = "sha256:b1f6b5a4eab1f73479a50fb79fcf729514a900c341d8503d62a62dbc4127a2b1"}, ] importlib-metadata = [ - {file = "importlib_metadata-1.7.0-py2.py3-none-any.whl", hash = "sha256:dc15b2969b4ce36305c51eebe62d418ac7791e9a157911d58bfb1f9ccd8e2070"}, - {file = "importlib_metadata-1.7.0.tar.gz", hash = "sha256:90bb658cdbbf6d1735b6341ce708fc7024a3e14e99ffdc5783edea9f9b077f83"}, + {file = "importlib_metadata-3.1.1-py3-none-any.whl", hash = "sha256:6112e21359ef8f344e7178aa5b72dc6e62b38b0d008e6d3cb212c5b84df72013"}, + {file = "importlib_metadata-3.1.1.tar.gz", hash = "sha256:b0c2d3b226157ae4517d9625decf63591461c66b3a808c2666d538946519d170"}, ] importlib-resources = [ - {file = "importlib_resources-3.0.0-py2.py3-none-any.whl", hash = "sha256:d028f66b66c0d5732dae86ba4276999855e162a749c92620a38c1d779ed138a7"}, - {file = "importlib_resources-3.0.0.tar.gz", hash = "sha256:19f745a6eca188b490b1428c8d1d4a0d2368759f32370ea8fb89cad2ab1106c3"}, + {file = "importlib_resources-3.3.0-py2.py3-none-any.whl", hash = "sha256:a3d34a8464ce1d5d7c92b0ea4e921e696d86f2aa212e684451cb1482c8d84ed5"}, + {file = "importlib_resources-3.3.0.tar.gz", hash = "sha256:7b51f0106c8ec564b1bef3d9c588bc694ce2b92125bbb6278f4f2f5b54ec3592"}, +] +iniconfig = [ + {file = "iniconfig-1.1.1-py2.py3-none-any.whl", hash = "sha256:011e24c64b7f47f6ebd835bb12a743f2fbe9a26d4cecaa7f53bc4f35ee9da8b3"}, + {file = "iniconfig-1.1.1.tar.gz", hash = "sha256:bc3af051d7d14b2ee5ef9969666def0cd1a000e121eaea580d4a313df4b37f32"}, ] isort = [ - {file = "isort-5.0.9-py3-none-any.whl", hash = "sha256:3d8e0d7678b66af1e3a6936f2a380a5d4f3faf4b1b38c6aaa4bed6695c6bdcde"}, - {file = "isort-5.0.9.tar.gz", hash = "sha256:639b8084644ceb13a806f42d690273b9d844793ac2f515fbc575ba65dc044de0"}, + {file = "isort-5.6.4-py3-none-any.whl", hash = "sha256:dcab1d98b469a12a1a624ead220584391648790275560e1a43e54c5dceae65e7"}, + {file = "isort-5.6.4.tar.gz", hash = "sha256:dcaeec1b5f0eca77faea2a35ab790b4f3680ff75590bfcb7145986905aab2f58"}, ] jinja2 = [ {file = "Jinja2-2.11.2-py2.py3-none-any.whl", hash = "sha256:f0a4641d3cf955324a89c04f3d94663aa4d638abe8f733ecd3582848e1c37035"}, @@ -949,28 +981,50 @@ mccabe = [ {file = "mccabe-0.6.1-py2.py3-none-any.whl", hash = "sha256:ab8a6258860da4b6677da4bd2fe5dc2c659cff31b3ee4f7f5d64e79735b80d42"}, {file = "mccabe-0.6.1.tar.gz", hash = "sha256:dd8d182285a0fe56bace7f45b5e7d1a6ebcbf524e8f3bd87eb0f125271b8831f"}, ] -more-itertools = [ - {file = "more-itertools-8.4.0.tar.gz", hash = "sha256:68c70cc7167bdf5c7c9d8f6954a7837089c6a36bf565383919bb595efb8a17e5"}, - {file = "more_itertools-8.4.0-py3-none-any.whl", hash = "sha256:b78134b2063dd214000685165d81c154522c3ee0a1c0d4d113c80361c234c5a2"}, +mslex = [ + {file = "mslex-0.3.0-py2.py3-none-any.whl", hash = "sha256:380cb14abf8fabf40e56df5c8b21a6d533dc5cbdcfe42406bbf08dda8f42e42a"}, + {file = "mslex-0.3.0.tar.gz", hash = "sha256:4a1ac3f25025cad78ad2fe499dd16d42759f7a3801645399cce5c404415daa97"}, +] +mypy-extensions = [ + {file = "mypy_extensions-0.4.3-py2.py3-none-any.whl", hash = "sha256:090fedd75945a69ae91ce1303b5824f428daf5a028d2f6ab8a299250a846f15d"}, + {file = "mypy_extensions-0.4.3.tar.gz", hash = "sha256:2d82818f5bb3e369420cb3c4060a7970edba416647068eb4c5343488a6c604a8"}, ] nodeenv = [ - {file = "nodeenv-1.4.0-py2.py3-none-any.whl", hash = "sha256:4b0b77afa3ba9b54f4b6396e60b0c83f59eaeb2d63dc3cc7a70f7f4af96c82bc"}, + {file = "nodeenv-1.5.0-py2.py3-none-any.whl", hash = "sha256:5304d424c529c997bc888453aeaa6362d242b6b4631e90f3d4bf1b290f1c84a9"}, + {file = "nodeenv-1.5.0.tar.gz", hash = "sha256:ab45090ae383b716c4ef89e690c41ff8c2b257b85b309f01f3654df3d084bd7c"}, ] packaging = [ - {file = "packaging-20.4-py2.py3-none-any.whl", hash = "sha256:998416ba6962ae7fbd6596850b80e17859a5753ba17c32284f67bfff33784181"}, - {file = "packaging-20.4.tar.gz", hash = "sha256:4357f74f47b9c12db93624a82154e9b120fa8293699949152b22065d556079f8"}, + {file = "packaging-20.7-py2.py3-none-any.whl", hash = "sha256:eb41423378682dadb7166144a4926e443093863024de508ca5c9737d6bc08376"}, + {file = "packaging-20.7.tar.gz", hash = "sha256:05af3bb85d320377db281cf254ab050e1a7ebcbf5410685a9a407e18a1f81236"}, ] pathspec = [ - {file = "pathspec-0.8.0-py2.py3-none-any.whl", hash = "sha256:7d91249d21749788d07a2d0f94147accd8f845507400749ea19c1ec9054a12b0"}, - {file = "pathspec-0.8.0.tar.gz", hash = "sha256:da45173eb3a6f2a5a487efba21f050af2b41948be6ab52b6a1e3ff22bb8b7061"}, + {file = "pathspec-0.8.1-py2.py3-none-any.whl", hash = "sha256:aa0cb481c4041bf52ffa7b0d8fa6cd3e88a2ca4879c533c9153882ee2556790d"}, + {file = "pathspec-0.8.1.tar.gz", hash = "sha256:86379d6b86d75816baba717e64b1a3a3469deb93bb76d613c9ce79edc5cb68fd"}, ] pluggy = [ {file = "pluggy-0.13.1-py2.py3-none-any.whl", hash = "sha256:966c145cd83c96502c3c3868f50408687b38434af77734af1e9ca461a4081d2d"}, {file = "pluggy-0.13.1.tar.gz", hash = "sha256:15b2acde666561e1298d71b523007ed7364de07029219b604cf808bfa1c765b0"}, ] +pockets = [ + {file = "pockets-0.9.1-py2.py3-none-any.whl", hash = "sha256:68597934193c08a08eb2bf6a1d85593f627c22f9b065cc727a4f03f669d96d86"}, + {file = "pockets-0.9.1.tar.gz", hash = "sha256:9320f1a3c6f7a9133fe3b571f283bcf3353cd70249025ae8d618e40e9f7e92b3"}, +] pre-commit = [ - {file = "pre_commit-2.6.0-py2.py3-none-any.whl", hash = "sha256:e8b1315c585052e729ab7e99dcca5698266bedce9067d21dc909c23e3ceed626"}, - {file = "pre_commit-2.6.0.tar.gz", hash = "sha256:1657663fdd63a321a4a739915d7d03baedd555b25054449090f97bb0cb30a915"}, + {file = "pre_commit-2.9.2-py2.py3-none-any.whl", hash = "sha256:949b13efb7467ae27e2c8f9e83434dacf2682595124d8902554a4e18351e5781"}, + {file = "pre_commit-2.9.2.tar.gz", hash = "sha256:e31c04bc23741194a7c0b983fe512801e151a0638c6001c49f2bd034f8a664a1"}, +] +psutil = [ + {file = "psutil-5.7.3-cp27-none-win32.whl", hash = "sha256:1cd6a0c9fb35ece2ccf2d1dd733c1e165b342604c67454fd56a4c12e0a106787"}, + {file = "psutil-5.7.3-cp27-none-win_amd64.whl", hash = "sha256:e02c31b2990dcd2431f4524b93491941df39f99619b0d312dfe1d4d530b08b4b"}, + {file = "psutil-5.7.3-cp35-cp35m-win32.whl", hash = "sha256:56c85120fa173a5d2ad1d15a0c6e0ae62b388bfb956bb036ac231fbdaf9e4c22"}, + {file = "psutil-5.7.3-cp35-cp35m-win_amd64.whl", hash = "sha256:fa38ac15dbf161ab1e941ff4ce39abd64b53fec5ddf60c23290daed2bc7d1157"}, + {file = "psutil-5.7.3-cp36-cp36m-win32.whl", hash = "sha256:01bc82813fbc3ea304914581954979e637bcc7084e59ac904d870d6eb8bb2bc7"}, + {file = "psutil-5.7.3-cp36-cp36m-win_amd64.whl", hash = "sha256:6a3e1fd2800ca45083d976b5478a2402dd62afdfb719b30ca46cd28bb25a2eb4"}, + {file = "psutil-5.7.3-cp37-cp37m-win32.whl", hash = "sha256:fbcac492cb082fa38d88587d75feb90785d05d7e12d4565cbf1ecc727aff71b7"}, + {file = "psutil-5.7.3-cp37-cp37m-win_amd64.whl", hash = "sha256:5d9106ff5ec2712e2f659ebbd112967f44e7d33f40ba40530c485cc5904360b8"}, + {file = "psutil-5.7.3-cp38-cp38-win32.whl", hash = "sha256:ade6af32eb80a536eff162d799e31b7ef92ddcda707c27bbd077238065018df4"}, + {file = "psutil-5.7.3-cp38-cp38-win_amd64.whl", hash = "sha256:2cb55ef9591b03ef0104bedf67cc4edb38a3edf015cf8cf24007b99cb8497542"}, + {file = "psutil-5.7.3.tar.gz", hash = "sha256:af73f7bcebdc538eda9cc81d19db1db7bf26f103f91081d780bbacfcb620dee2"}, ] py = [ {file = "py-1.9.0-py2.py3-none-any.whl", hash = "sha256:366389d1db726cd2fcfc79732e75410e5fe4d31db13692115529d34069a043c2"}, @@ -985,27 +1039,27 @@ pyflakes = [ {file = "pyflakes-2.2.0.tar.gz", hash = "sha256:35b2d75ee967ea93b55750aa9edbbf72813e06a66ba54438df2cfac9e3c27fc8"}, ] pygments = [ - {file = "Pygments-2.6.1-py3-none-any.whl", hash = "sha256:ff7a40b4860b727ab48fad6360eb351cc1b33cbf9b15a0f689ca5353e9463324"}, - {file = "Pygments-2.6.1.tar.gz", hash = "sha256:647344a061c249a3b74e230c739f434d7ea4d8b1d5f3721bc0f3558049b38f44"}, + {file = "Pygments-2.7.2-py3-none-any.whl", hash = "sha256:88a0bbcd659fcb9573703957c6b9cff9fab7295e6e76db54c9d00ae42df32773"}, + {file = "Pygments-2.7.2.tar.gz", hash = "sha256:381985fcc551eb9d37c52088a32914e00517e57f4a21609f48141ba08e193fa0"}, ] pyparsing = [ {file = "pyparsing-2.4.7-py2.py3-none-any.whl", hash = "sha256:ef9d7589ef3c200abe66653d3f1ab1033c3c419ae9b9bdb1240a85b024efc88b"}, {file = "pyparsing-2.4.7.tar.gz", hash = "sha256:c203ec8783bf771a155b207279b9bccb8dea02d8f0c9e5f8ead507bc3246ecc1"}, ] pytest = [ - {file = "pytest-5.4.3-py3-none-any.whl", hash = "sha256:5c0db86b698e8f170ba4582a492248919255fcd4c79b1ee64ace34301fb589a1"}, - {file = "pytest-5.4.3.tar.gz", hash = "sha256:7979331bfcba207414f5e1263b5a0f8f521d0f457318836a7355531ed1a4c7d8"}, + {file = "pytest-6.1.2-py3-none-any.whl", hash = "sha256:4288fed0d9153d9646bfcdf0c0428197dba1ecb27a33bb6e031d002fa88653fe"}, + {file = "pytest-6.1.2.tar.gz", hash = "sha256:c0a7e94a8cdbc5422a51ccdad8e6f1024795939cc89159a0ae7f0b316ad3823e"}, ] pytest-cov = [ - {file = "pytest-cov-2.10.0.tar.gz", hash = "sha256:1a629dc9f48e53512fcbfda6b07de490c374b0c83c55ff7a1720b3fccff0ac87"}, - {file = "pytest_cov-2.10.0-py2.py3-none-any.whl", hash = "sha256:6e6d18092dce6fad667cd7020deed816f858ad3b49d5b5e2b1cc1c97a4dba65c"}, + {file = "pytest-cov-2.10.1.tar.gz", hash = "sha256:47bd0ce14056fdd79f93e1713f88fad7bdcc583dcd7783da86ef2f085a0bb88e"}, + {file = "pytest_cov-2.10.1-py2.py3-none-any.whl", hash = "sha256:45ec2d5182f89a81fc3eb29e3d1ed3113b9e9a873bcddb2a71faaab066110191"}, ] pytest-sugar = [ {file = "pytest-sugar-0.9.4.tar.gz", hash = "sha256:b1b2186b0a72aada6859bea2a5764145e3aaa2c1cfbb23c3a19b5f7b697563d3"}, ] pytz = [ - {file = "pytz-2020.1-py2.py3-none-any.whl", hash = "sha256:a494d53b6d39c3c6e44c3bec237336e14305e4f29bbf800b599253057fbb79ed"}, - {file = "pytz-2020.1.tar.gz", hash = "sha256:c35965d010ce31b23eeb663ed3cc8c906275d6be1a34393a1d73a41febf4a048"}, + {file = "pytz-2020.4-py2.py3-none-any.whl", hash = "sha256:5c55e189b682d420be27c6995ba6edce0c0a77dd67bfbe2ae6607134d5851ffd"}, + {file = "pytz-2020.4.tar.gz", hash = "sha256:3e6b7dd2d1e0a59084bcee14a17af60c5c562cdc16d828e8eba2e683d3a7e268"}, ] pyyaml = [ {file = "PyYAML-5.3.1-cp27-cp27m-win32.whl", hash = "sha256:74809a57b329d6cc0fdccee6318f44b9b8649961fa73144a98735b0aaf029f1f"}, @@ -1018,34 +1072,56 @@ pyyaml = [ {file = "PyYAML-5.3.1-cp37-cp37m-win_amd64.whl", hash = "sha256:73f099454b799e05e5ab51423c7bcf361c58d3206fa7b0d555426b1f4d9a3eaf"}, {file = "PyYAML-5.3.1-cp38-cp38-win32.whl", hash = "sha256:06a0d7ba600ce0b2d2fe2e78453a470b5a6e000a985dd4a4e54e436cc36b0e97"}, {file = "PyYAML-5.3.1-cp38-cp38-win_amd64.whl", hash = "sha256:95f71d2af0ff4227885f7a6605c37fd53d3a106fcab511b8860ecca9fcf400ee"}, + {file = "PyYAML-5.3.1-cp39-cp39-win32.whl", hash = "sha256:ad9c67312c84def58f3c04504727ca879cb0013b2517c85a9a253f0cb6380c0a"}, + {file = "PyYAML-5.3.1-cp39-cp39-win_amd64.whl", hash = "sha256:6034f55dab5fea9e53f436aa68fa3ace2634918e8b5994d82f3621c04ff5ed2e"}, {file = "PyYAML-5.3.1.tar.gz", hash = "sha256:b8eac752c5e14d3eca0e6dd9199cd627518cb5ec06add0de9d32baeee6fe645d"}, ] regex = [ - {file = "regex-2020.6.8-cp27-cp27m-win32.whl", hash = "sha256:fbff901c54c22425a5b809b914a3bfaf4b9570eee0e5ce8186ac71eb2025191c"}, - {file = "regex-2020.6.8-cp27-cp27m-win_amd64.whl", hash = "sha256:112e34adf95e45158c597feea65d06a8124898bdeac975c9087fe71b572bd938"}, - {file = "regex-2020.6.8-cp36-cp36m-manylinux1_i686.whl", hash = "sha256:92d8a043a4241a710c1cf7593f5577fbb832cf6c3a00ff3fc1ff2052aff5dd89"}, - {file = "regex-2020.6.8-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:bae83f2a56ab30d5353b47f9b2a33e4aac4de9401fb582b55c42b132a8ac3868"}, - {file = "regex-2020.6.8-cp36-cp36m-manylinux2010_i686.whl", hash = "sha256:b2ba0f78b3ef375114856cbdaa30559914d081c416b431f2437f83ce4f8b7f2f"}, - {file = "regex-2020.6.8-cp36-cp36m-manylinux2010_x86_64.whl", hash = "sha256:95fa7726d073c87141f7bbfb04c284901f8328e2d430eeb71b8ffdd5742a5ded"}, - {file = "regex-2020.6.8-cp36-cp36m-win32.whl", hash = "sha256:e3cdc9423808f7e1bb9c2e0bdb1c9dc37b0607b30d646ff6faf0d4e41ee8fee3"}, - {file = "regex-2020.6.8-cp36-cp36m-win_amd64.whl", hash = "sha256:c78e66a922de1c95a208e4ec02e2e5cf0bb83a36ceececc10a72841e53fbf2bd"}, - {file = "regex-2020.6.8-cp37-cp37m-manylinux1_i686.whl", hash = "sha256:08997a37b221a3e27d68ffb601e45abfb0093d39ee770e4257bd2f5115e8cb0a"}, - {file = "regex-2020.6.8-cp37-cp37m-manylinux1_x86_64.whl", hash = "sha256:2f6f211633ee8d3f7706953e9d3edc7ce63a1d6aad0be5dcee1ece127eea13ae"}, - {file = "regex-2020.6.8-cp37-cp37m-manylinux2010_i686.whl", hash = "sha256:55b4c25cbb3b29f8d5e63aeed27b49fa0f8476b0d4e1b3171d85db891938cc3a"}, - {file = "regex-2020.6.8-cp37-cp37m-manylinux2010_x86_64.whl", hash = "sha256:89cda1a5d3e33ec9e231ece7307afc101b5217523d55ef4dc7fb2abd6de71ba3"}, - {file = "regex-2020.6.8-cp37-cp37m-win32.whl", hash = "sha256:690f858d9a94d903cf5cada62ce069b5d93b313d7d05456dbcd99420856562d9"}, - {file = "regex-2020.6.8-cp37-cp37m-win_amd64.whl", hash = "sha256:1700419d8a18c26ff396b3b06ace315b5f2a6e780dad387e4c48717a12a22c29"}, - {file = "regex-2020.6.8-cp38-cp38-manylinux1_i686.whl", hash = "sha256:654cb773b2792e50151f0e22be0f2b6e1c3a04c5328ff1d9d59c0398d37ef610"}, - {file = "regex-2020.6.8-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:52e1b4bef02f4040b2fd547357a170fc1146e60ab310cdbdd098db86e929b387"}, - {file = "regex-2020.6.8-cp38-cp38-manylinux2010_i686.whl", hash = "sha256:cf59bbf282b627130f5ba68b7fa3abdb96372b24b66bdf72a4920e8153fc7910"}, - {file = "regex-2020.6.8-cp38-cp38-manylinux2010_x86_64.whl", hash = "sha256:5aaa5928b039ae440d775acea11d01e42ff26e1561c0ffcd3d805750973c6baf"}, - {file = "regex-2020.6.8-cp38-cp38-win32.whl", hash = "sha256:97712e0d0af05febd8ab63d2ef0ab2d0cd9deddf4476f7aa153f76feef4b2754"}, - {file = "regex-2020.6.8-cp38-cp38-win_amd64.whl", hash = "sha256:6ad8663c17db4c5ef438141f99e291c4d4edfeaacc0ce28b5bba2b0bf273d9b5"}, - {file = "regex-2020.6.8.tar.gz", hash = "sha256:e9b64e609d37438f7d6e68c2546d2cb8062f3adb27e6336bc129b51be20773ac"}, + {file = "regex-2020.11.13-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:8b882a78c320478b12ff024e81dc7d43c1462aa4a3341c754ee65d857a521f85"}, + {file = "regex-2020.11.13-cp36-cp36m-manylinux1_i686.whl", hash = "sha256:a63f1a07932c9686d2d416fb295ec2c01ab246e89b4d58e5fa468089cab44b70"}, + {file = "regex-2020.11.13-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:6e4b08c6f8daca7d8f07c8d24e4331ae7953333dbd09c648ed6ebd24db5a10ee"}, + {file = "regex-2020.11.13-cp36-cp36m-manylinux2010_i686.whl", hash = "sha256:bba349276b126947b014e50ab3316c027cac1495992f10e5682dc677b3dfa0c5"}, + {file = "regex-2020.11.13-cp36-cp36m-manylinux2010_x86_64.whl", hash = "sha256:56e01daca75eae420bce184edd8bb341c8eebb19dd3bce7266332258f9fb9dd7"}, + {file = "regex-2020.11.13-cp36-cp36m-manylinux2014_aarch64.whl", hash = "sha256:6a8ce43923c518c24a2579fda49f093f1397dad5d18346211e46f134fc624e31"}, + {file = "regex-2020.11.13-cp36-cp36m-manylinux2014_i686.whl", hash = "sha256:1ab79fcb02b930de09c76d024d279686ec5d532eb814fd0ed1e0051eb8bd2daa"}, + {file = "regex-2020.11.13-cp36-cp36m-manylinux2014_x86_64.whl", hash = "sha256:9801c4c1d9ae6a70aeb2128e5b4b68c45d4f0af0d1535500884d644fa9b768c6"}, + {file = "regex-2020.11.13-cp36-cp36m-win32.whl", hash = "sha256:49cae022fa13f09be91b2c880e58e14b6da5d10639ed45ca69b85faf039f7a4e"}, + {file = "regex-2020.11.13-cp36-cp36m-win_amd64.whl", hash = "sha256:749078d1eb89484db5f34b4012092ad14b327944ee7f1c4f74d6279a6e4d1884"}, + {file = "regex-2020.11.13-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:b2f4007bff007c96a173e24dcda236e5e83bde4358a557f9ccf5e014439eae4b"}, + {file = "regex-2020.11.13-cp37-cp37m-manylinux1_i686.whl", hash = "sha256:38c8fd190db64f513fe4e1baa59fed086ae71fa45083b6936b52d34df8f86a88"}, + {file = "regex-2020.11.13-cp37-cp37m-manylinux1_x86_64.whl", hash = "sha256:5862975b45d451b6db51c2e654990c1820523a5b07100fc6903e9c86575202a0"}, + {file = "regex-2020.11.13-cp37-cp37m-manylinux2010_i686.whl", hash = "sha256:262c6825b309e6485ec2493ffc7e62a13cf13fb2a8b6d212f72bd53ad34118f1"}, + {file = "regex-2020.11.13-cp37-cp37m-manylinux2010_x86_64.whl", hash = "sha256:bafb01b4688833e099d79e7efd23f99172f501a15c44f21ea2118681473fdba0"}, + {file = "regex-2020.11.13-cp37-cp37m-manylinux2014_aarch64.whl", hash = "sha256:e32f5f3d1b1c663af7f9c4c1e72e6ffe9a78c03a31e149259f531e0fed826512"}, + {file = "regex-2020.11.13-cp37-cp37m-manylinux2014_i686.whl", hash = "sha256:3bddc701bdd1efa0d5264d2649588cbfda549b2899dc8d50417e47a82e1387ba"}, + {file = "regex-2020.11.13-cp37-cp37m-manylinux2014_x86_64.whl", hash = "sha256:02951b7dacb123d8ea6da44fe45ddd084aa6777d4b2454fa0da61d569c6fa538"}, + {file = "regex-2020.11.13-cp37-cp37m-win32.whl", hash = "sha256:0d08e71e70c0237883d0bef12cad5145b84c3705e9c6a588b2a9c7080e5af2a4"}, + {file = "regex-2020.11.13-cp37-cp37m-win_amd64.whl", hash = "sha256:1fa7ee9c2a0e30405e21031d07d7ba8617bc590d391adfc2b7f1e8b99f46f444"}, + {file = "regex-2020.11.13-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:baf378ba6151f6e272824b86a774326f692bc2ef4cc5ce8d5bc76e38c813a55f"}, + {file = "regex-2020.11.13-cp38-cp38-manylinux1_i686.whl", hash = "sha256:e3faaf10a0d1e8e23a9b51d1900b72e1635c2d5b0e1bea1c18022486a8e2e52d"}, + {file = "regex-2020.11.13-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:2a11a3e90bd9901d70a5b31d7dd85114755a581a5da3fc996abfefa48aee78af"}, + {file = "regex-2020.11.13-cp38-cp38-manylinux2010_i686.whl", hash = "sha256:d1ebb090a426db66dd80df8ca85adc4abfcbad8a7c2e9a5ec7513ede522e0a8f"}, + {file = "regex-2020.11.13-cp38-cp38-manylinux2010_x86_64.whl", hash = "sha256:b2b1a5ddae3677d89b686e5c625fc5547c6e492bd755b520de5332773a8af06b"}, + {file = "regex-2020.11.13-cp38-cp38-manylinux2014_aarch64.whl", hash = "sha256:2c99e97d388cd0a8d30f7c514d67887d8021541b875baf09791a3baad48bb4f8"}, + {file = "regex-2020.11.13-cp38-cp38-manylinux2014_i686.whl", hash = "sha256:c084582d4215593f2f1d28b65d2a2f3aceff8342aa85afd7be23a9cad74a0de5"}, + {file = "regex-2020.11.13-cp38-cp38-manylinux2014_x86_64.whl", hash = "sha256:a3d748383762e56337c39ab35c6ed4deb88df5326f97a38946ddd19028ecce6b"}, + {file = "regex-2020.11.13-cp38-cp38-win32.whl", hash = "sha256:7913bd25f4ab274ba37bc97ad0e21c31004224ccb02765ad984eef43e04acc6c"}, + {file = "regex-2020.11.13-cp38-cp38-win_amd64.whl", hash = "sha256:6c54ce4b5d61a7129bad5c5dc279e222afd00e721bf92f9ef09e4fae28755683"}, + {file = "regex-2020.11.13-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:1862a9d9194fae76a7aaf0150d5f2a8ec1da89e8b55890b1786b8f88a0f619dc"}, + {file = "regex-2020.11.13-cp39-cp39-manylinux1_i686.whl", hash = "sha256:4902e6aa086cbb224241adbc2f06235927d5cdacffb2425c73e6570e8d862364"}, + {file = "regex-2020.11.13-cp39-cp39-manylinux1_x86_64.whl", hash = "sha256:7a25fcbeae08f96a754b45bdc050e1fb94b95cab046bf56b016c25e9ab127b3e"}, + {file = "regex-2020.11.13-cp39-cp39-manylinux2010_i686.whl", hash = "sha256:d2d8ce12b7c12c87e41123997ebaf1a5767a5be3ec545f64675388970f415e2e"}, + {file = "regex-2020.11.13-cp39-cp39-manylinux2010_x86_64.whl", hash = "sha256:f7d29a6fc4760300f86ae329e3b6ca28ea9c20823df123a2ea8693e967b29917"}, + {file = "regex-2020.11.13-cp39-cp39-manylinux2014_aarch64.whl", hash = "sha256:717881211f46de3ab130b58ec0908267961fadc06e44f974466d1887f865bd5b"}, + {file = "regex-2020.11.13-cp39-cp39-manylinux2014_i686.whl", hash = "sha256:3128e30d83f2e70b0bed9b2a34e92707d0877e460b402faca908c6667092ada9"}, + {file = "regex-2020.11.13-cp39-cp39-manylinux2014_x86_64.whl", hash = "sha256:8f6a2229e8ad946e36815f2a03386bb8353d4bde368fdf8ca5f0cb97264d3b5c"}, + {file = "regex-2020.11.13-cp39-cp39-win32.whl", hash = "sha256:f8f295db00ef5f8bae530fc39af0b40486ca6068733fb860b42115052206466f"}, + {file = "regex-2020.11.13-cp39-cp39-win_amd64.whl", hash = "sha256:a15f64ae3a027b64496a71ab1f722355e570c3fac5ba2801cafce846bf5af01d"}, + {file = "regex-2020.11.13.tar.gz", hash = "sha256:83d6b356e116ca119db8e7c6fc2983289d87b27b3fac238cfe5dca529d884562"}, ] requests = [ - {file = "requests-2.24.0-py2.py3-none-any.whl", hash = "sha256:fe75cc94a9443b9246fc7049224f75604b113c36acb93f87b80ed42c44cbb898"}, - {file = "requests-2.24.0.tar.gz", hash = "sha256:b3559a131db72c33ee969480840fff4bb6dd111de7dd27c8ee1f820f4f00231b"}, + {file = "requests-2.25.0-py2.py3-none-any.whl", hash = "sha256:e786fa28d8c9154e6a4de5d46a1d921b8749f8b74e28bde23768e5e16eece998"}, + {file = "requests-2.25.0.tar.gz", hash = "sha256:7f1a0b932f4a60a1a65caa4263921bb7d9ee911957e0ae4a23a6dd08185ad5f8"}, ] seed-isort-config = [ {file = "seed_isort_config-2.2.0-py2.py3-none-any.whl", hash = "sha256:8601fb715a5a4aac39256bbf73c2da6a81f964da9c9d9897ab9074db3663526f"}, @@ -1060,8 +1136,8 @@ snowballstemmer = [ {file = "snowballstemmer-2.0.0.tar.gz", hash = "sha256:df3bac3df4c2c01363f3dd2cfa78cce2840a79b9f1c2d2de9ce8d31683992f52"}, ] sphinx = [ - {file = "Sphinx-3.1.2-py3-none-any.whl", hash = "sha256:97dbf2e31fc5684bb805104b8ad34434ed70e6c588f6896991b2fdfd2bef8c00"}, - {file = "Sphinx-3.1.2.tar.gz", hash = "sha256:b9daeb9b39aa1ffefc2809b43604109825300300b987a24f45976c001ba1a8fd"}, + {file = "Sphinx-3.3.1-py3-none-any.whl", hash = "sha256:d4e59ad4ea55efbb3c05cde3bfc83bfc14f0c95aa95c3d75346fcce186a47960"}, + {file = "Sphinx-3.3.1.tar.gz", hash = "sha256:1e8d592225447104d1172be415bc2972bd1357e3e12fdc76edf2261105db4300"}, ] sphinx-rtd-theme = [ {file = "sphinx_rtd_theme-0.5.0-py2.py3-none-any.whl", hash = "sha256:373413d0f82425aaa28fb288009bf0d0964711d347763af2f1b65cafcb028c82"}, @@ -1083,6 +1159,10 @@ sphinxcontrib-jsmath = [ {file = "sphinxcontrib-jsmath-1.0.1.tar.gz", hash = "sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8"}, {file = "sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl", hash = "sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178"}, ] +sphinxcontrib-napoleon = [ + {file = "sphinxcontrib-napoleon-0.7.tar.gz", hash = "sha256:407382beed396e9f2d7f3043fad6afda95719204a1e1a231ac865f40abcbfcf8"}, + {file = "sphinxcontrib_napoleon-0.7-py2.py3-none-any.whl", hash = "sha256:711e41a3974bdf110a484aec4c1a556799eb0b3f3b897521a018ad7e2db13fef"}, +] sphinxcontrib-qthelp = [ {file = "sphinxcontrib-qthelp-1.0.3.tar.gz", hash = "sha256:4c33767ee058b70dba89a6fc5c1892c0d57a54be67ddd3e7875a18d14cba5a72"}, {file = "sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl", hash = "sha256:bd9fc24bcb748a8d51fd4ecaade681350aa63009a347a8c14e637895444dfab6"}, @@ -1092,15 +1172,15 @@ sphinxcontrib-serializinghtml = [ {file = "sphinxcontrib_serializinghtml-1.1.4-py2.py3-none-any.whl", hash = "sha256:f242a81d423f59617a8e5cf16f5d4d74e28ee9a66f9e5b637a18082991db5a9a"}, ] taskipy = [ - {file = "taskipy-1.2.1-py3-none-any.whl", hash = "sha256:99bdaf5b19791c2345806847147e0fc2d28e1ac9446058def5a8b6b3fc9f23e2"}, - {file = "taskipy-1.2.1.tar.gz", hash = "sha256:5eb2c3b1606c896c7fa799848e71e8883b880759224958d07ba760e5db263175"}, + {file = "taskipy-1.5.1-py3-none-any.whl", hash = "sha256:2cf0080a8a5b6eb182c26ce323412c8bd63ea5b3477bfb4d0407bb77924abd04"}, + {file = "taskipy-1.5.1.tar.gz", hash = "sha256:aa803322e6286e4ade8156366e0f846f79959447f4a9bcd7eac59c7705bd3f0d"}, ] termcolor = [ {file = "termcolor-1.1.0.tar.gz", hash = "sha256:1d6d69ce66211143803fbc56652b41d73b4a400a2891d7bf7a1cdf4c02de613b"}, ] toml = [ - {file = "toml-0.10.1-py2.py3-none-any.whl", hash = "sha256:bda89d5935c2eac546d648028b9901107a595863cb36bae0c73ac804a9b4ce88"}, - {file = "toml-0.10.1.tar.gz", hash = "sha256:926b612be1e5ce0634a2ca03470f95169cf16f939018233a670519cb4ac58b0f"}, + {file = "toml-0.10.2-py2.py3-none-any.whl", hash = "sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b"}, + {file = "toml-0.10.2.tar.gz", hash = "sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f"}, ] typed-ast = [ {file = "typed_ast-1.4.1-cp35-cp35m-manylinux1_i686.whl", hash = "sha256:73d785a950fc82dd2a25897d525d003f6378d1cb23ab305578394694202a58c3"}, @@ -1110,34 +1190,44 @@ typed-ast = [ {file = "typed_ast-1.4.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:269151951236b0f9a6f04015a9004084a5ab0d5f19b57de779f908621e7d8b75"}, {file = "typed_ast-1.4.1-cp36-cp36m-manylinux1_i686.whl", hash = "sha256:24995c843eb0ad11a4527b026b4dde3da70e1f2d8806c99b7b4a7cf491612652"}, {file = "typed_ast-1.4.1-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:fe460b922ec15dd205595c9b5b99e2f056fd98ae8f9f56b888e7a17dc2b757e7"}, + {file = "typed_ast-1.4.1-cp36-cp36m-manylinux2014_aarch64.whl", hash = "sha256:fcf135e17cc74dbfbc05894ebca928ffeb23d9790b3167a674921db19082401f"}, {file = "typed_ast-1.4.1-cp36-cp36m-win32.whl", hash = "sha256:4e3e5da80ccbebfff202a67bf900d081906c358ccc3d5e3c8aea42fdfdfd51c1"}, {file = "typed_ast-1.4.1-cp36-cp36m-win_amd64.whl", hash = "sha256:249862707802d40f7f29f6e1aad8d84b5aa9e44552d2cc17384b209f091276aa"}, {file = "typed_ast-1.4.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:8ce678dbaf790dbdb3eba24056d5364fb45944f33553dd5869b7580cdbb83614"}, {file = "typed_ast-1.4.1-cp37-cp37m-manylinux1_i686.whl", hash = "sha256:c9e348e02e4d2b4a8b2eedb48210430658df6951fa484e59de33ff773fbd4b41"}, {file = "typed_ast-1.4.1-cp37-cp37m-manylinux1_x86_64.whl", hash = "sha256:bcd3b13b56ea479b3650b82cabd6b5343a625b0ced5429e4ccad28a8973f301b"}, + {file = "typed_ast-1.4.1-cp37-cp37m-manylinux2014_aarch64.whl", hash = "sha256:f208eb7aff048f6bea9586e61af041ddf7f9ade7caed625742af423f6bae3298"}, {file = "typed_ast-1.4.1-cp37-cp37m-win32.whl", hash = "sha256:d5d33e9e7af3b34a40dc05f498939f0ebf187f07c385fd58d591c533ad8562fe"}, {file = "typed_ast-1.4.1-cp37-cp37m-win_amd64.whl", hash = "sha256:0666aa36131496aed8f7be0410ff974562ab7eeac11ef351def9ea6fa28f6355"}, {file = "typed_ast-1.4.1-cp38-cp38-macosx_10_15_x86_64.whl", hash = "sha256:d205b1b46085271b4e15f670058ce182bd1199e56b317bf2ec004b6a44f911f6"}, {file = "typed_ast-1.4.1-cp38-cp38-manylinux1_i686.whl", hash = "sha256:6daac9731f172c2a22ade6ed0c00197ee7cc1221aa84cfdf9c31defeb059a907"}, {file = "typed_ast-1.4.1-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:498b0f36cc7054c1fead3d7fc59d2150f4d5c6c56ba7fb150c013fbc683a8d2d"}, + {file = "typed_ast-1.4.1-cp38-cp38-manylinux2014_aarch64.whl", hash = "sha256:7e4c9d7658aaa1fc80018593abdf8598bf91325af6af5cce4ce7c73bc45ea53d"}, {file = "typed_ast-1.4.1-cp38-cp38-win32.whl", hash = "sha256:715ff2f2df46121071622063fc7543d9b1fd19ebfc4f5c8895af64a77a8c852c"}, {file = "typed_ast-1.4.1-cp38-cp38-win_amd64.whl", hash = "sha256:fc0fea399acb12edbf8a628ba8d2312f583bdbdb3335635db062fa98cf71fca4"}, {file = "typed_ast-1.4.1-cp39-cp39-macosx_10_15_x86_64.whl", hash = "sha256:d43943ef777f9a1c42bf4e552ba23ac77a6351de620aa9acf64ad54933ad4d34"}, + {file = "typed_ast-1.4.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:92c325624e304ebf0e025d1224b77dd4e6393f18aab8d829b5b7e04afe9b7a2c"}, + {file = "typed_ast-1.4.1-cp39-cp39-manylinux1_i686.whl", hash = "sha256:d648b8e3bf2fe648745c8ffcee3db3ff903d0817a01a12dd6a6ea7a8f4889072"}, + {file = "typed_ast-1.4.1-cp39-cp39-manylinux1_x86_64.whl", hash = "sha256:fac11badff8313e23717f3dada86a15389d0708275bddf766cca67a84ead3e91"}, + {file = "typed_ast-1.4.1-cp39-cp39-manylinux2014_aarch64.whl", hash = "sha256:0d8110d78a5736e16e26213114a38ca35cb15b6515d535413b090bd50951556d"}, + {file = "typed_ast-1.4.1-cp39-cp39-win32.whl", hash = "sha256:b52ccf7cfe4ce2a1064b18594381bccf4179c2ecf7f513134ec2f993dd4ab395"}, + {file = "typed_ast-1.4.1-cp39-cp39-win_amd64.whl", hash = "sha256:3742b32cf1c6ef124d57f95be609c473d7ec4c14d0090e5a5e05a15269fb4d0c"}, {file = "typed_ast-1.4.1.tar.gz", hash = "sha256:8c8aaad94455178e3187ab22c8b01a3837f8ee50e09cf31f1ba129eb293ec30b"}, ] +typing-extensions = [ + {file = "typing_extensions-3.7.4.3-py2-none-any.whl", hash = "sha256:dafc7639cde7f1b6e1acc0f457842a83e722ccca8eef5270af2d74792619a89f"}, + {file = "typing_extensions-3.7.4.3-py3-none-any.whl", hash = "sha256:7cb407020f00f7bfc3cb3e7881628838e69d8f3fcab2f64742a5e76b2f841918"}, + {file = "typing_extensions-3.7.4.3.tar.gz", hash = "sha256:99d4073b617d30288f569d3f13d2bd7548c3a7e4c8de87db09a9d29bb3a4a60c"}, +] urllib3 = [ - {file = "urllib3-1.25.9-py2.py3-none-any.whl", hash = "sha256:88206b0eb87e6d677d424843ac5209e3fb9d0190d0ee169599165ec25e9d9115"}, - {file = "urllib3-1.25.9.tar.gz", hash = "sha256:3018294ebefce6572a474f0604c2021e33b3fd8006ecd11d62107a5d2a963527"}, + {file = "urllib3-1.26.2-py2.py3-none-any.whl", hash = "sha256:d8ff90d979214d7b4f8ce956e80f4028fc6860e4431f731ea4a8c08f23f99473"}, + {file = "urllib3-1.26.2.tar.gz", hash = "sha256:19188f96923873c92ccb987120ec4acaa12f0461fa9ce5d3d0772bc965a39e08"}, ] virtualenv = [ - {file = "virtualenv-20.0.26-py2.py3-none-any.whl", hash = "sha256:c11a475400e98450403c0364eb3a2d25d42f71cf1493da64390487b666de4324"}, - {file = "virtualenv-20.0.26.tar.gz", hash = "sha256:e10cc66f40cbda459720dfe1d334c4dc15add0d80f09108224f171006a97a172"}, -] -wcwidth = [ - {file = "wcwidth-0.2.5-py2.py3-none-any.whl", hash = "sha256:beb4802a9cebb9144e99086eff703a642a13d6a0052920003a230f3294bbe784"}, - {file = "wcwidth-0.2.5.tar.gz", hash = "sha256:c4d647b99872929fdb7bdcaa4fbe7f01413ed3d98077df798530e5b04f116c83"}, + {file = "virtualenv-20.2.1-py2.py3-none-any.whl", hash = "sha256:07cff122e9d343140366055f31be4dcd61fd598c69d11cd33a9d9c8df4546dd7"}, + {file = "virtualenv-20.2.1.tar.gz", hash = "sha256:e0aac7525e880a429764cefd3aaaff54afb5d9f25c82627563603f5d7de5a6e5"}, ] zipp = [ - {file = "zipp-3.1.0-py3-none-any.whl", hash = "sha256:aa36550ff0c0b7ef7fa639055d797116ee891440eac1a56f378e2d3179e0320b"}, - {file = "zipp-3.1.0.tar.gz", hash = "sha256:c599e4d75c98f6798c509911d08a22e6c021d074469042177c8c86fb92eefd96"}, + {file = "zipp-3.4.0-py3-none-any.whl", hash = "sha256:102c24ef8f171fd729d46599845e95c7ab894a4cf45f5de11a44cc7444fb1108"}, + {file = "zipp-3.4.0.tar.gz", hash = "sha256:ed5eee1974372595f9e416cc7bbeeb12335201d8081ca8a0743c954d4446e5cb"}, ] diff --git a/pyproject.toml b/pyproject.toml index d5eacfe..49d1a85 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,64 +1,66 @@ -[tool.poetry] -name = "lirc" -version = "0.1.0" -description = "Interact with the daemon in the Linux Infrared Remote Control package" -authors = ["Eugene Triguba <eugenetriguba@gmail.com>"] -license = "MIT" -readme = "README.rst" -repository = "https://github.com/eugenetriguba/lirc" -keywords = [ - "LIRC", - "IR" -] -classifiers = [ - "Development Status :: 4 - Beta", - "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 3.6", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Topic :: System :: Hardware", - "Topic :: Software Development :: Libraries :: Python Modules", -] - -[tool.taskipy.tasks] -lint = "poetry run pre-commit run --all" -test = "task test_cov_missing" -test_unit = "poetry run pytest tests/" -test_cov = "task test_unit -- --cov=lirc/" -test_cov_missing = "task test_cov -- -v --cov-report term-missing" -test_ci = "task test_cov -- --cov-report=xml" -test_all = "export LIRC_RUN_LONG_TESTS=true && poetry run task test && unset LIRC_RUN_LONG_TESTS" - -[tool.poetry.dependencies] -python = "^3.6" - -[tool.poetry.dev-dependencies] -pre-commit = { version = "^2.6.0", python = "^3.6.1" } -flake8 = "^3.8.3" -isort = "^5.0.4" -seed-isort-config = { version = "^2.2.0", python = "^3.6.1" } -pytest = "^5.4.3" -pytest-cov = "^2.10.0" -pytest-sugar = "^0.9.4" -bump2version = "^1.0.0" -taskipy = "^1.2.1" -black = "^19.10b0" -sphinx = "^3.1.2" -sphinx_rtd_theme = "^0.5.0" -codecov = "^2.1.7" - -[tool.black] -line-length = 88 -target_version = ['py38'] -include = '\.pyi?$' - -[tool.isort] -line_length = 88 -multi_line_output = 3 -include_trailing_comma = true -known_first_party = ["lirc"] -known_third_party = ["pytest"] - -[build-system] -requires = ["poetry>=0.12"] -build-backend = "poetry.masonry.api" +[tool.poetry]
+name = "lirc"
+version = "0.1.0"
+description = "Interact with the daemon in the Linux Infrared Remote Control package"
+authors = ["Eugene Triguba <eugenetriguba@gmail.com>"]
+license = "MIT"
+readme = "README.rst"
+repository = "https://github.com/eugenetriguba/lirc"
+keywords = [
+ "LIRC",
+ "IR"
+]
+classifiers = [
+ "Development Status :: 4 - Beta",
+ "License :: OSI Approved :: MIT License",
+ "Programming Language :: Python :: 3.6",
+ "Programming Language :: Python :: 3.7",
+ "Programming Language :: Python :: 3.8",
+ "Topic :: System :: Hardware",
+ "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+packages = [
+ { include = "lirc" },
+ { include = "tests", format = "sdist" }
+]
+
+[tool.taskipy.tasks]
+lint = "poetry run pre-commit run --all"
+test = "task test_cov_missing"
+test_unit = "poetry run pytest tests/"
+test_cov = "task test_unit -- --cov=lirc/"
+test_cov_missing = "task test_cov -- -v --cov-report term-missing"
+test_ci = "task test_cov -- --cov-report=xml"
+
+[tool.poetry.dependencies]
+python = "^3.6"
+
+[tool.poetry.dev-dependencies]
+pre-commit = { version = "^2.6.0", python = "^3.6.1" }
+flake8 = "^3.8.3"
+isort = "^5.0.4"
+seed-isort-config = { version = "^2.2.0", python = "^3.6.1" }
+pytest = "^6.0"
+pytest-cov = "^2.10.0"
+pytest-sugar = "^0.9.4"
+bump2version = "^1.0.0"
+taskipy = "^1.2.1"
+black = "^20.8b1"
+sphinx = "^3.1.2"
+sphinx_rtd_theme = "^0.5.0"
+codecov = "^2.1.7"
+sphinxcontrib-napoleon = "^0.7"
+
+[tool.black]
+target_version = ['py38']
+include = '\.pyi?$'
+
+[tool.isort]
+profile = "black"
+known_first_party = ["lirc"]
+known_third_party = ["pytest"]
+
+[build-system]
+requires = ["poetry>=1.0"]
+build-backend = "poetry.masonry.api"
diff --git a/tests/conftest.py b/tests/conftest.py index 01e2460..4529cd7 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -3,14 +3,24 @@ from unittest import mock import pytest -from lirc import Lirc +from lirc import Client, LircdConnection @pytest.fixture def mock_socket(): - return mock.Mock(spec=socket.socket) + return mock.MagicMock(spec=socket.socket) @pytest.fixture -def mock_lirc(mock_socket): - return Lirc(socket=mock_socket) +def mock_connection(mock_socket): + return LircdConnection(socket=mock_socket) + + +@pytest.fixture +def mock_client(mock_connection): + return Client(connection=mock_connection) + + +@pytest.fixture +def mock_client_and_connection(mock_connection): + return Client(connection=mock_connection), mock_connection diff --git a/tests/test_client.py b/tests/test_client.py new file mode 100644 index 0000000..523119b --- /dev/null +++ b/tests/test_client.py @@ -0,0 +1,68 @@ +import pytest + +from lirc import Client, LircdConnection + + +def test_that_custom_connections_can_be_used(mock_socket): + connection = LircdConnection(socket=mock_socket) + client = Client(connection=connection) + + assert client._Client__connection == connection + + +def test_that_custom_connection_that_is_not_a_lircd_connection_raises_error(): + with pytest.raises(ValueError) as error: + Client(connection=Client()) + + assert "must be an instance of `LircdConnection`" in str(error) + + +def test_that_close_closes_the_socket(mock_client_and_connection): + client, connection = mock_client_and_connection + + client.close() + + connection.socket.close.assert_called() + + +@pytest.mark.parametrize( + "client_command, args, lircd_command", + [ + ("send", {"remote": "REMOTE", "key": "KEY"}, "SEND_ONCE REMOTE KEY 1"), + ( + "send", + {"remote": "REMOTE", "key": "KEY", "repeat_count": 5}, + "SEND_ONCE REMOTE KEY 5", + ), + ("start_repeat", {"remote": "REMOTE", "key": "KEY"}, "SEND_START REMOTE KEY"), + ("stop_repeat", {}, "SEND_STOP "), + ("stop_repeat", {"remote": "REMOTE", "key": "KEY"}, "SEND_STOP REMOTE KEY"), + ("list_remotes", {}, "LIST"), + ("list_remote_keys", {"remote": "REMOTE"}, "LIST REMOTE"), + ("start_logging", {"path": "PATH"}, "SET_INPUTLOG PATH"), + ("stop_logging", {}, "SET_INPUTLOG"), + ("version", {}, "VERSION"), + ("driver_option", {"key": "KEY", "value": "VALUE"}, "DRV_OPTION KEY VALUE"), + ( + "simulate", + {"remote": "REMOTE", "key": "KEY"}, + "SIMULATE 0000000000000000 01 KEY REMOTE", + ), + ( + "simulate", + {"remote": "REMOTE", "key": "KEY", "repeat_count": 4, "keycode": 53}, + "SIMULATE 0000000000000053 04 KEY REMOTE", + ), + ("set_transmitters", {"transmitters": 5}, "SET_TRANSMITTERS 5"), + ("set_transmitters", {"transmitters": [10, 1, 1]}, "SET_TRANSMITTERS 513"), + ], +) +def test_that_client_commands_send_the_correct_command( + mock_client_and_connection, client_command, args, lircd_command +): + client, connection = mock_client_and_connection + connection.socket.recv.return_value = b"BEGIN\nCOMMAND\nSUCCESS\nEND\n" + + getattr(client, client_command)(**args) + + connection.socket.sendall.assert_called_with((lircd_command + "\n").encode("utf-8")) diff --git a/tests/test_lirc.py b/tests/test_lirc.py deleted file mode 100644 index 348e785..0000000 --- a/tests/test_lirc.py +++ /dev/null @@ -1,135 +0,0 @@ -import os - -import pytest - -from lirc import ( - InvalidReplyPacketFormatError, - Lirc, - LircResponse, - LircSocketTimeoutError, -) - - -def test_default_lirc_init(mock_socket): - TIMEOUT = 5 - mock_lirc = Lirc(socket=mock_socket, socket_timeout=TIMEOUT) - - mock_socket.connect.assert_called_with(mock_lirc.DEFAULT_SOCKET_PATH) - mock_socket.settimeout.assert_called_with(TIMEOUT) - - -def test_lirc_custom_path(mock_socket): - CUSTOM_PATH = "CUSTOM" - Lirc(socket=mock_socket, socket_path=CUSTOM_PATH) - - mock_socket.connect.assert_called_with(CUSTOM_PATH) - - -def test_custom_path_lirc_init(mock_socket): - TEST_SOCKET_PATH = "test_path" - Lirc(socket=mock_socket, socket_path=TEST_SOCKET_PATH) - mock_socket.connect.assert_called_with(TEST_SOCKET_PATH) - - -@pytest.mark.parametrize( - "reply_packet", [b"BEGIN\nSEND_ONCE remote key\nSUCCESS\nEND\n"] -) -def test_read_reply_packet(mock_lirc, reply_packet): - mock_lirc._Lirc__socket.recv.return_value = reply_packet - retrieved_packet = mock_lirc._Lirc__read_reply_packet() - mock_lirc._Lirc__socket.recv.assert_called_with(256) - assert reply_packet == retrieved_packet.encode(mock_lirc.ENCODING) - - -@pytest.mark.skipif( - os.environ.get("LIRC_RUN_LONG_TESTS") is None, reason="Test takes too long" -) -@pytest.mark.parametrize("reply_packet", [b"INVALID PACKET"]) -def test_read_reply_packet_socket_timeout(mock_lirc, reply_packet): - with pytest.raises(LircSocketTimeoutError): - mock_lirc._Lirc__socket.recv.return_value = reply_packet - mock_lirc._Lirc__read_reply_packet() - - -@pytest.mark.parametrize( - "reply_packet, command, success, data, exception", - [ - ( - "BEGIN\nSEND_ONCE remote key\nSUCCESS\nEND\n", - "SEND_ONCE remote key", - True, - [], - None, - ), - ("INVALID PACKET", "", False, [], None), - ( - "BEGIN\nSEND_ONCE remote key\nERROR\nINVALID\n", - "SEND_ONCE remote key", - False, - [], - InvalidReplyPacketFormatError, - ), - ( - "BEGIN\nSEND_ONCE remote key\nERROR\nDATA\n1\nunknown remote: remote\n", - "SEND_ONCE remote key", - False, - ["unknown remote: remote"], - None, - ), - ( - "BEGIN\nSEND_ONCE remote key\nSUCCESS\nDATA\n3\nraa\nblah\nbhal\n", - "SEND_ONCE remote key", - True, - ["raa", "blah", "bhal"], - None, - ), - ], -) -def test_parse_reply_packet(mock_lirc, reply_packet, command, success, data, exception): - if exception: - with pytest.raises(exception): - mock_lirc._Lirc__parse_reply_packet(reply_packet) - else: - response = mock_lirc._Lirc__parse_reply_packet(reply_packet) - assert response.success == success - assert response.command == command - assert response.data == data - - -@pytest.mark.parametrize( - "reply_packet, repeat_count", - [ - (b"BEGIN\nSEND_ONCE remote key\nSUCCESS\nEND\n", 1), - (b"BEGIN\nSEND_ONCE remote key\nERROR\nEND\n", 1), - (b"BEGIN\nSEND_ONCE remote key\nSUCCESS\nEND\n", 5), - ], -) -def test_send_once(mock_lirc, reply_packet, repeat_count): - REMOTE = "remote" - KEY = "key" - COMMAND = f"SEND_ONCE {REMOTE} {KEY}" - SUCCESS = True if "SUCCESS" in reply_packet.decode(mock_lirc.ENCODING) else False - - mock_lirc._Lirc__socket.recv.return_value = reply_packet - response = mock_lirc.send_once(KEY, REMOTE, repeat_count=repeat_count) - mock_lirc._Lirc__socket.sendall.assert_called_with( - (COMMAND + "\n").encode(mock_lirc.ENCODING) - ) - - if repeat_count > 1: - assert type(response) == list - assert len(response) == repeat_count - - for r in response: - _ensure_lirc_response(r, COMMAND, SUCCESS) - else: - _ensure_lirc_response(response, COMMAND, SUCCESS) - - -def _ensure_lirc_response( - response: LircResponse, command: str, success: bool, data: list = [] -): - assert type(response) == LircResponse - assert response.command == command - assert response.success == success - assert response.data == data diff --git a/tests/test_lircd_connection.py b/tests/test_lircd_connection.py new file mode 100644 index 0000000..6c8679c --- /dev/null +++ b/tests/test_lircd_connection.py @@ -0,0 +1,118 @@ +import time +from collections import deque +from platform import system +from unittest import mock + +import pytest + +from lirc import LircdConnection +from lirc.exceptions import LircdConnectionError + + +@mock.patch("socket.socket") +@mock.patch("platform.system") +@pytest.mark.parametrize("os_name", ["Windows", "Darwin", "Linux"]) +def test_socket_and_address_have_correct_cross_platform_values( + mocked_system, mocked_socket, os_name +): + if system() != os_name: + return + + mocked_system.return_value = os_name + + connection = LircdConnection() + + expected_socket = connection._LircdConnection__socket + expected_address = connection._LircdConnection__address + + assert connection.socket.family == expected_socket.family + assert connection.socket.type == expected_socket.type + assert connection.address == expected_address + + +def test_close_closes_the_socket_connection(mock_connection): + mock_connection.close() + mock_connection.socket.close.assert_called() + + +def test_that_connection_error_is_raised_on_invalid_address(): + with pytest.raises(LircdConnectionError): + LircdConnection(address="invalid thing").connect() + + +def test_that_attribute_error_is_raised_on_invalid_socket(): + with pytest.raises(AttributeError): + LircdConnection(socket=5).connect() + + +@pytest.mark.parametrize("test_command", ["SEND_ONCE REMOTE KEY", ""]) +def test_that_send_adds_a_newline_to_the_end_if_not_present( + mock_connection, test_command +): + mock_connection.send(test_command) + mock_connection.socket.sendall.assert_called_with( + f"{test_command}\n".encode("utf-8") + ) + + +@pytest.mark.parametrize("test_command", [5, False, 0.1, b"hello"]) +def test_that_send_raises_a_type_error_for_parameters_that_are_not_strings( + mock_connection, test_command +): + with pytest.raises(TypeError) as error: + mock_connection.send(test_command) + + assert "data parameter to send() must be a string" in str(error) + + +@pytest.mark.parametrize("test_command", ["SEND_ONCE REMOTE KEY\n"]) +def test_that_send_sends_the_command_unaltered_to_the_socket_if_in_correct_format( + mock_connection, test_command +): + mock_connection.send(test_command) + mock_connection.socket.sendall.assert_called_with(test_command.encode("utf-8")) + + +@pytest.mark.parametrize( + "buffer_payload, expected_item", + [("BEGIN\nSIGHUP\nEND\n".split("\n"), "BEGIN"), ([""], "")], +) +def test_that_readline_uses_buffer_if_items_are_present_in_it( + mock_connection, buffer_payload, expected_item +): + mock_connection._LircdConnection__buffer.extend(buffer_payload) + assert mock_connection.readline() == expected_item + + +@pytest.mark.parametrize( + "socket_payload, expected_return, expected_buffer", + [ + (b"BEGIN\nTEST\nEND\n", "BEGIN", deque(["TEST", "END"])), + (b"BEGIN\nTEST\nEND", "BEGIN", deque(["TEST", "END"])), + (b"", "", deque()), + ], +) +def test_that_readline_retrieves_data_from_socket_and_adds_to_buffer( + mock_connection, socket_payload, expected_return, expected_buffer +): + mock_connection.socket.recv.return_value = socket_payload + + line = mock_connection.readline() + + assert line == expected_return + assert mock_connection._LircdConnection__buffer == expected_buffer + + +def test_that_readline_raises_timeout_error_if_no_data_from_socket(): + timeout = 0.001 + error_threshold = 0.01 + connection = LircdConnection(timeout=timeout) + + start_time = time.time() + with pytest.raises(TimeoutError) as error: + connection.readline() + end_time = time.time() + delta = abs(start_time - end_time) + + assert delta < timeout + error_threshold + assert f"could not find any data on the socket after {timeout}" in str(error) diff --git a/tests/test_reply_packet_parser.py b/tests/test_reply_packet_parser.py new file mode 100644 index 0000000..86ae311 --- /dev/null +++ b/tests/test_reply_packet_parser.py @@ -0,0 +1,66 @@ +# import pytest +# +# from lirc import ( +# LircdCommandFailureError, +# LircdInvalidReplyPacketError, +# LircdSocketTimeoutError, +# ) +# from lirc.reply_packet_parser import ReplyPacketParser +# from lirc.utils import ENCODING +# +# +# @pytest.mark.parametrize( +# "reply_packet", [b"BEGIN\nSEND_ONCE remote key\nSUCCESS\nEND\n"] +# ) +# def test_read_reply_packet(mock_socket, reply_packet): +# mock_socket.recv.return_value = reply_packet +# parser = ReplyPacketParser(mock_socket) +# parser.read() +# +# retrieved_packet = parser.feed() +# +# mock_socket.recv.assert_called_with(ReplyPacketParser.BUFFER_LENGTH) +# assert reply_packet == retrieved_packet.encode(ENCODING) +# +# +# @pytest.mark.skip(reason="Not working") +# @pytest.mark.parametrize("reply_packet", [b"INVALID PACKET"]) +# def test_read_reply_packet_socket_timeout(mock_lirc, reply_packet): +# with pytest.raises(LircdSocketTimeoutError): +# mock_lirc.socket.recv.return_value = reply_packet +# ReplyPacketParser.read(mock_lirc.socket) +# +# +# @pytest.mark.parametrize( +# "reply_packet, data, exception", +# [ +# (b"BEGIN\nSEND_ONCE remote key\nSUCCESS\nEND\n", [], None,), +# # ("INVALID PACKET", [], LircdInvalidReplyPacketError), +# ( +# b"BEGIN\nSEND_ONCE remote key\nERROR\nINVALID\n", +# [], +# LircdInvalidReplyPacketError, +# ), +# ( +# b"BEGIN\nSEND_ONCE remote key\nERROR\nDATA\n1\nunknown remote: remote\n", +# ["unknown remote: remote"], +# LircdCommandFailureError, +# ), +# ( +# b"BEGIN\nSEND_ONCE remote key\nSUCCESS\nDATA\n3\nraa\nblah\nbhal\n", +# ["raa", "blah", "bhal"], +# None, +# ), +# ], +# ) +# def test_parse_reply_packet(mock_socket, reply_packet, data, exception): +# mock_socket.recv.return_value = reply_packet +# parser = ReplyPacketParser(mock_socket) +# +# if exception: +# with pytest.raises(exception): +# parser.read() +# parser.feed() +# else: +# parser.read() +# assert parser.feed() == data |