vmcp.osc.channel.common

  1#!/usr/bin/env python3
  2# -*- coding: utf-8 -*-
  3# SPDX-License-Identifier: AGPL-3.0-or-later
  4
  5"""Common module of ``channel`` package."""
  6
  7from abc import ABCMeta, abstractmethod
  8from typing import TYPE_CHECKING
  9if TYPE_CHECKING:
 10    from .. import OSC
 11
 12
 13class AbstractChannel(metaclass=ABCMeta):
 14    """Abstract channel."""
 15
 16    @property
 17    def system(self) -> 'OSC':
 18        """OSC: Returns ``OSC`` system instance."""
 19        return self._system
 20
 21    @property
 22    def is_open(self) -> bool:
 23        """bool: Returns whether the channel is currently open."""
 24        return self._opened
 25
 26    @property
 27    def host(self) -> str:
 28        """str: Host DNS or IP address."""
 29        return str(self._host)
 30
 31    @property
 32    def port(self) -> int:
 33        """int: Host port."""
 34        return int(self._port)
 35
 36    @property
 37    def name(self) -> str:
 38        """str: Channel name."""
 39        return str(self._name)
 40
 41    def __init__(
 42        self,
 43        system: 'OSC',
 44        host: str,
 45        port: int,
 46        name: str
 47    ) -> None:
 48        """Channel constructor.
 49
 50        Args:
 51            system (OSC):
 52                OSC system instance.
 53            host (str):
 54                Host DNS or IP (recommended).
 55            port (int):
 56                Host port.
 57            name (str):
 58                Channel name (arbitrary, but needs to be unique).
 59
 60        Raises:
 61            ValueError:
 62                If ``name`` is already used.
 63
 64        """
 65        self._opened = False
 66        self._host, self._port, self._name = host, port, name
 67        self._system = system
 68
 69    @abstractmethod
 70    def open(self) -> 'AbstractChannel':
 71        """Open channel.
 72
 73        Returns:
 74            Class:
 75                Object instance.
 76
 77        """
 78        self._opened = True
 79        return self
 80
 81    def __eq__(self, other) -> bool:
 82        """Return ``True`` if an object is identical to ``other`` object.
 83
 84        Args:
 85            other (Client):
 86                Other object for comparison.
 87
 88        Returns:
 89            bool:
 90                ``True`` if identical, otherwise ``False``.
 91
 92        """
 93        return (
 94            self.host == other.host and
 95            self.port == other.port and
 96            self.name == other.name
 97        )
 98
 99    def __hash__(self) -> int:
100        """Return hash value to quickly compare keys for dictionary lookup.
101
102        Returns:
103            int:
104                Hash value.
105
106        """
107        return hash((self.host, self.port, self.name))
108
109    def __str__(self) -> str:
110        """Return string representation of the object.
111
112        Returns:
113            str:
114                Representation of the object.
115
116        """
117        return f"{self.host}, {self.port}, {self.name}"
118
119    @abstractmethod
120    def __repr__(self) -> str:
121        """Return a string, representing the object in a reconstructable way.
122
123        Returns:
124            str:
125                Representing the object in a reconstructable way.
126
127        """
128        return f"({self})"
129
130    @abstractmethod
131    def close(self) -> None:
132        """Close channel."""
133        self._opened = False