Source code for pyrolab.utils

# Copyright © PyroLab Project Contributors
# Licensed under the terms of the GNU GPLv3+ License
# (see pyrolab/__init__.py for details)

"""
Utils
=====

Convenience functions for working with the pyrolab package.
"""

import secrets
import socket

try:
    import importlib.resources as pkg_resources
except ImportError:
    import pkg_resources

import pyrolab




def get_ip() -> str:
    """
    Get the IP address of the local machine.

    Returns
    -------
    str
        The IP address of the local machine.
    """
    s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
    s.connect(("8.8.8.8", 80))
    ip = s.getsockname()[0]
    s.close()
    return ip





def generate_random_name(count: int = 3) -> str:
    """
    Concatenates ``count`` random words as a hyphenated string.

    Wordlist is located in pyrolab/data/wordlist.txt.

    Parameters
    ----------
    count : int, optional
        How many words to use in the hyphenated string.

    Returns
    -------
    str
        A hyphenated string of ``count`` random words.
    """
    from pathlib import Path

    try:
        path = pkg_resources.files(pyrolab) / "data/wordlist.txt"
    except AttributeError:
        path = Path(pkg_resources.resource_filename("pyrolab", "data/wordlist.txt"))
    with open(path, "r") as f:
        wordlist = f.read().splitlines()

    return "-".join([secrets.choice(wordlist) for _ in range(count)])