hat-util

Pre-release

This release is a pre-release and may not be stable for production use.

This library is part of Hat Open project - open-source framework of tools and libraries for developing applications used for remote monitoring, control and management of intelligent electronic devices such as IoT devices, PLCs, industrial automation or home automation systems.

Development of Hat Open and associated repositories is sponsored by Končar - Power Plant and Electric Traction Engineering Inc. (Končar KET - https://www.koncar-ket.hr).

For more information see:

hat-util documentation - https://core.hat-open.com/docs/libraries/util/python.html

Hat Core homepage - https://core.hat-open.com

Hat Core git repository - https://github.com/hat-open/hat-core.git

About

Common utility functions not available as part of standard library.

hat.util.first:

def first(xs: typing.Iterable[T],
          fn: typing.Callable[[T], typing.Any] = lambda _: True,
          default: typing.Optional[T] = None
          ) -> typing.Optional[T]:
    """Return the first element from iterable that satisfies predicate
       `fn`, or `default` if no such element exists.

    Result of predicate `fn` can be of any type. Predicate is satisfied if
    it's return value is truthy.

    Args:
        xs: collection
        fn: predicate
        default: default value

    Example::

        assert first(range(3)) == 0
        assert first(range(3), lambda x: x > 1) == 2
        assert first(range(3), lambda x: x > 2) is None
        assert first(range(3), lambda x: x > 2, 123) == 123
        assert first({1: 'a', 2: 'b', 3: 'c'}) == 1
        assert first([], default=123) == 123

    """

hat.util.CallbackRegistry:

class RegisterCallbackHandle(typing.NamedTuple):
    """Handle for canceling callback registration."""

    cancel: typing.Callable[[], None]
    """cancel callback registration"""

    def __enter__(self): ...

    def __exit__(self, *args): ...

ExceptionCb: typing.Type = typing.Callable[[Exception], None]
"""Exception callback"""

class CallbackRegistry:
    """Registry that enables callback registration and notification.

    Callbacks in the registry are notified sequentially with
    :meth:`CallbackRegistry.notify`. If a callback raises an exception, the
    exception is caught and `exception_cb` handler is called. Notification
    of subsequent callbacks is not interrupted. If handler is `None`, the
    exception is reraised and no subsequent callback is notified.

    Example::

        x = []
        y = []
        registry = CallbackRegistry()

        registry.register(x.append)
        registry.notify(1)

        with registry.register(y.append):
            registry.notify(2)

        registry.notify(3)

        assert x == [1, 2, 3]
        assert y == [2]

    """

    def __init__(self,
                 exception_cb: typing.Optional[ExceptionCb] = None): ...

    def register(self,
                 cb: typing.Callable
                 ) -> RegisterCallbackHandle:
        """Register a callback."""

    def notify(self, *args, **kwargs):
        """Notify all registered callbacks."""

hat.util.parse_url_query:

def parse_url_query(query: str) -> typing.Dict[str, str]:
    """Parse url query string.

    Returns a dictionary of field names and their values.

    Args:
        query: url query string

    Example::

        url = urllib.parse.urlparse('https://pypi.org/search/?q=hat-util')
        args = parse_url_query(url.query)
        assert args == {'q': 'hat-util'}

    """

hat.util.get_unused_tcp_port and hat.util.get_unused_udp_port:

def get_unused_tcp_port() -> int:
    """Search for unused TCP port"""

def get_unused_udp_port() -> int:
    """Search for unused UDP port"""

Metadata

Release files for hat-util 0.4.1.dev20210707

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for hat-util 0.4.1.dev20210707
File	Interpreter	ABI	Platform	Reset
hat_util-0.4.1.dev20210707-cp38.cp39-none-any.whl 4.7 kB Jul 7, 2021 Without provenance	CPython 3.8, CPython 3.9	none	any	Details

Release files / hat_util-0.4.1.dev20210707-cp38.cp39-none-any.whl

Download URL	hat_util-0.4.1.dev20210707-cp38.cp39-none-any.whl
Size	4.7 kB
Tags	CPython 3.8 CPython 3.9
SHA-256 checksum How to use checksums	`807c5fa73bf836147f747ed68e61e60dd2ff8a0980cb976a9d21256e8cdc9832`
BLAKE2b-256 checksum How to use checksums	`1f216ff066ee6677095e3df2d57c1dba902451d4e46b8d8cfc6fef28b365e4b4`
Upload date	Jul 7, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.5`

Security for hat-util 0.4.1.dev20210707

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.