hive-common 0.0.1__tar.gz

hive_common-0.0.1/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.1
+Name: hive-common
+Version: 0.0.1
+Summary: Common code for Hive libraries and services
+Author-email: Gary Benson <gary@gbenson.net>
+Project-URL: Homepage, https://github.com/gbenson/hive/tree/main/libs/common
+Project-URL: Source, https://github.com/gbenson/hive
+Description-Content-Type: text/markdown
+
+[![version badge]](https://pypi.org/project/hive-common/)
+
+[version badge]: https://img.shields.io/pypi/v/hive-common?color=limegreen
+
+# hive-common
+
+Common code for Hive libraries and services
+
+## Installation
+
+### With PIP
+
+```sh
+pip install hive-common
+```
+
+### From source
+
+```sh
+git clone https://github.com/gbenson/hive.git
+cd hive/libs/common
+python3 -m venv .venv
+. .venv/bin/activate
+pip install --upgrade pip
+pip install -r requirements.txt
+pip install -e .
+flake8 && pytest
+```

hive_common-0.0.1/README.md

@@ -0,0 +1,28 @@
+[![version badge]](https://pypi.org/project/hive-common/)
+
+[version badge]: https://img.shields.io/pypi/v/hive-common?color=limegreen
+
+# hive-common
+
+Common code for Hive libraries and services
+
+## Installation
+
+### With PIP
+
+```sh
+pip install hive-common
+```
+
+### From source
+
+```sh
+git clone https://github.com/gbenson/hive.git
+cd hive/libs/common
+python3 -m venv .venv
+. .venv/bin/activate
+pip install --upgrade pip
+pip install -r requirements.txt
+pip install -e .
+flake8 && pytest
+```

hive_common-0.0.1/hive/common/__init__.py

@@ -0,0 +1 @@
+from .argument_parser import HiveArgumentParser as ArgumentParser

hive_common-0.0.1/hive/common/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"

hive_common-0.0.1/hive/common/argument_parser.py

@@ -0,0 +1,17 @@
+import logging
+
+from argparse import ArgumentParser
+
+from .logging import getenv_log_level
+
+logger = logging.getLogger(__name__)
+
+
+class HiveArgumentParser(ArgumentParser):
+    def parse_args(self, *args, **kwargs):
+        if (log_level := getenv_log_level()):
+            try:
+                logging.basicConfig(level=log_level)
+            except ValueError:
+                logger.warning(f"Ignoring LL={log_level!r}")
+        return super().parse_args(*args, *kwargs)

hive_common-0.0.1/hive/common/logging.py

@@ -0,0 +1,13 @@
+import os
+
+from typing import Optional
+
+
+def getenv_log_level() -> Optional[int | str]:
+    level = os.environ.get("LL", None)
+    if not level:
+        return None
+    try:
+        return int(level)
+    except ValueError:
+        return level.upper()

hive_common-0.0.1/hive/common/testing.py

@@ -0,0 +1,16 @@
+try:
+    from pep440_version_utils import Version
+except ImportError:
+    pass
+
+
+def assert_is_valid_version(version: str):
+    try:
+        assert str(Version(version)) == version
+    except Exception as e:
+        raise AssertionError(f"Invalid version {version!r}") from e
+
+
+def want_to_see(caplog, msg):
+    failure_detail = f"didn't see: {msg}"
+    assert any(r.getMessage() == msg for r in caplog.records), failure_detail

hive_common-0.0.1/hive/common/units.py

@@ -0,0 +1,12 @@
+BYTE = BYTES = 1
+KiB = BYTE << 10
+MiB = KiB << 10
+GiB = MiB << 10
+TiB = GiB << 10
+
+SECOND = SECONDS = 1
+MINUTE = MINUTES = 60 * SECONDS
+HOUR = HOURS = 60 * MINUTES
+
+MILLISECOND = MILLISECONDS = SECOND / 1000
+MICROSECOND = MICROSECONDS = MILLISECOND / 1000

hive_common-0.0.1/hive_common.egg-info/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.1
+Name: hive-common
+Version: 0.0.1
+Summary: Common code for Hive libraries and services
+Author-email: Gary Benson <gary@gbenson.net>
+Project-URL: Homepage, https://github.com/gbenson/hive/tree/main/libs/common
+Project-URL: Source, https://github.com/gbenson/hive
+Description-Content-Type: text/markdown
+
+[![version badge]](https://pypi.org/project/hive-common/)
+
+[version badge]: https://img.shields.io/pypi/v/hive-common?color=limegreen
+
+# hive-common
+
+Common code for Hive libraries and services
+
+## Installation
+
+### With PIP
+
+```sh
+pip install hive-common
+```
+
+### From source
+
+```sh
+git clone https://github.com/gbenson/hive.git
+cd hive/libs/common
+python3 -m venv .venv
+. .venv/bin/activate
+pip install --upgrade pip
+pip install -r requirements.txt
+pip install -e .
+flake8 && pytest
+```

hive_common-0.0.1/hive_common.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+README.md
+pyproject.toml
+hive/common/__init__.py
+hive/common/__version__.py
+hive/common/argument_parser.py
+hive/common/logging.py
+hive/common/testing.py
+hive/common/units.py
+hive_common.egg-info/PKG-INFO
+hive_common.egg-info/SOURCES.txt
+hive_common.egg-info/dependency_links.txt
+hive_common.egg-info/top_level.txt
+tests/test_argument_parser.py
+tests/test_is_valid_version.py
+tests/test_units.py
+tests/test_version.py

hive_common-0.0.1/hive_common.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

hive_common-0.0.1/hive_common.egg-info/top_level.txt

@@ -0,0 +1 @@
+hive

hive_common-0.0.1/pyproject.toml

@@ -0,0 +1,26 @@
+[project]
+name = "hive-common"
+dynamic = ["version"]
+authors = [{ name = "Gary Benson", email = "gary@gbenson.net" }]
+description = "Common code for Hive libraries and services"
+readme = "README.md"
+
+[project.urls]
+Homepage = "https://github.com/gbenson/hive/tree/main/libs/common"
+Source = "https://github.com/gbenson/hive"
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.dynamic]
+version = {attr = "hive.common.__version__.__version__"}
+
+[tool.pytest.ini_options]
+addopts = "--cov=hive.common"
+
+[tool.coverage.run]
+omit = [
+    "*/venv/*",
+    "*/.venv/*",
+]

hive_common-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

hive_common-0.0.1/tests/test_argument_parser.py

@@ -0,0 +1,63 @@
+import logging
+
+import pytest
+
+from hive.common import ArgumentParser
+from hive.common.testing import want_to_see
+
+
+def test_default_log_level(monkeypatch):
+    def mock_bc(*args, **kwargs):
+        pytest.fail("logging.basicConfig() was called")
+
+    with monkeypatch.context() as mp:
+        mp.setattr(logging, "basicConfig", mock_bc)
+        mp.delenv("LL", raising=False)
+        _ = ArgumentParser().parse_args()
+
+
+@pytest.mark.parametrize(
+    ("user_level", "expect_level"),
+    (("debug", logging.DEBUG),
+     ("DEBUG", logging.DEBUG),
+     ("10", logging.DEBUG),
+     ("11", 11),
+     ("WARNING", logging.WARNING),
+     ("critical", logging.CRITICAL),
+     ))
+def test_getenv_log_level(user_level, expect_level, monkeypatch):
+    loggers = []
+
+    def logger_name(i):
+        return f"{__name__}.test_getenv_log_level.{i}"
+
+    def mock_bc(level):
+        logger = logging.getLogger(logger_name(len(loggers)))
+        logger.setLevel(level)
+        loggers.append(logger)
+
+    with monkeypatch.context() as mp:
+        mp.setattr(logging, "basicConfig", mock_bc)
+        mp.setenv("LL", user_level)
+        _ = ArgumentParser().parse_args()
+
+    assert len(loggers) == 1
+    logger = loggers[0]
+    assert logger.name == logger_name(0)
+    assert logger.level == expect_level
+
+
+def test_unknown_log_level(monkeypatch, caplog):
+    def mock_bc(level):
+        logger = logging.getLogger(f"{__name__}.test_unknown_log_level")
+        logger.setLevel(level)
+        pytest.fail(f"logger.setLevel({level!r}) didn't raise")
+
+    with monkeypatch.context() as mp:
+        mp.setattr(logging, "basicConfig", mock_bc)
+        mp.setenv("LL", "gonk")
+
+        with caplog.at_level(logging.WARNING):
+            _ = ArgumentParser().parse_args()
+
+    want_to_see(caplog, "Ignoring LL='GONK'")

hive_common-0.0.1/tests/test_is_valid_version.py

@@ -0,0 +1,13 @@
+import pytest
+
+from hive.common.testing import assert_is_valid_version
+
+
+@pytest.mark.parametrize(
+    "invalid_version",
+    (("1.2-3"),
+     ("1.2-3-final"),
+     ))
+def test_is_valid_version(invalid_version):
+    with pytest.raises(AssertionError):
+        assert_is_valid_version(invalid_version)

hive_common-0.0.1/tests/test_units.py

@@ -0,0 +1,26 @@
+from hive.common import units
+
+
+def test_units():
+    assert (
+        ("BYTE", 1),
+        ("BYTES", 1),
+        ("GiB", 1_073_741_824),
+        ("HOUR", 3600),
+        ("HOURS", 3600),
+        ("KiB", 1024),
+        ("MICROSECOND", 1e-6),
+        ("MICROSECONDS", 1e-6),
+        ("MILLISECOND", 0.001),
+        ("MILLISECONDS", 0.001),
+        ("MINUTE", 60),
+        ("MINUTES", 60),
+        ("MiB", 1_048_576),
+        ("SECOND", 1),
+        ("SECONDS", 1),
+        ("TiB", 1099511627776),
+    ) == tuple(
+        (attr, getattr(units, attr))
+        for attr in sorted(dir(units))
+        if attr[0].isupper()
+    )

hive_common-0.0.1/tests/test_version.py

@@ -0,0 +1,6 @@
+from hive.common.__version__ import __version__
+from hive.common.testing import assert_is_valid_version
+
+
+def test_version():
+    assert_is_valid_version(__version__)