promtext-cli 0.1.2.dev97__tar.gz → 0.1.2.dev98__tar.gz

{promtext_cli-0.1.2.dev97 → promtext_cli-0.1.2.dev98}/.copier-answers.yml

@@ -14,4 +14,4 @@ project_name: promtext-cli
 pypi_publish: true
 pypi_publish_dev: true
 scripts:
-    promtext: promtext_cli.main:promtext
+    promtext: promtext_cli:main.main

{promtext_cli-0.1.2.dev97 → promtext_cli-0.1.2.dev98}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: promtext-cli
-Version: 0.1.2.dev97
+Version: 0.1.2.dev98
 Summary: Prometheus Textfile Tooling
 Project-URL: Documentation, https://codeberg.org/margau/promtext-cli/src/branch/main#readme
 Project-URL: Issues, https://codeberg.org/margau/promtext-cli/issues

promtext_cli-0.1.2.dev98/promtext_cli/main.py

@@ -0,0 +1,12 @@
+"""This module takes care of entrypoints"""
+
+from .promtext import Promtext
+
+
+def main():
+    """main method invoking the core class"""
+    Promtext().cli_entrypoint()
+
+
+if __name__ == "__main__":
+    main()

promtext_cli-0.1.2.dev98/promtext_cli/promtext.py

@@ -0,0 +1,182 @@
+"""this is the module providing the core functionality"""
+
+import argparse
+from pathlib import Path
+import logging
+import sys
+
+from prometheus_client.parser import text_string_to_metric_families
+from prometheus_client import CollectorRegistry, Gauge, write_to_textfile
+
+
+class Promtext:
+    """Class for the core functionality"""
+
+    def __init__(self):
+        self.textfile = None
+        self.logger = None
+        self.args = None
+        self.registry = CollectorRegistry()
+
+        self.metrics = {}
+
+    def _arguments(self):
+        """load every input item from arguments & define cli"""
+        # required file first
+        parser = argparse.ArgumentParser(description="Prometheus textfile helper")
+        parser.add_argument(
+            "filename",
+            type=str,
+            help="Path to existing or new prometheus textfile, will be updated",
+        )
+
+        # metric name, required
+        parser.add_argument("metric", type=str, help="metric name (new or updated)")
+
+        # metric value as int/float, required
+        parser.add_argument("value", type=float, help="metric value")
+
+        # metric documentation as optional argument
+        parser.add_argument(
+            "--docs",
+            type=str,
+            help="metric documentation",
+            default="metric appended by promtext-cli",
+        )
+
+        # labels, key-value, minimum 0, repeatable
+        parser.add_argument(
+            "--label",
+            metavar="KEY=VALUE",
+            help="label key=value pairs",
+            action="append",
+        )
+
+        # log level from argparse
+        parser.add_argument(
+            "-v",
+            "--verbose",
+            action="store_const",
+            dest="loglevel",
+            const=logging.INFO,
+        )
+        self.args = parser.parse_args()
+
+        # processing: check if file is available, if yes, parse
+        self.textfile = Path(self.args.filename)
+
+    def parse_file(self):
+        """If possible, convert the input textfile to metrics in the registry"""
+        # check if self.args.filename exists with pathlib
+        if self.textfile.is_file():
+            for f in text_string_to_metric_families(
+                self.textfile.read_text(encoding="utf-8")
+            ):
+                # per metric: iterate over samples, create metric in registry
+                m = False
+                samples = []
+                for s in f.samples:
+                    samples.append(s)
+                if len(samples) > 0:
+                    # if we have samples, use the labelnames from them
+                    labelnames = list(samples[0].labels.keys())
+                    # metric-type specific init
+                    if f.type == "gauge":
+                        m = Gauge(
+                            f.name,
+                            f.documentation,
+                            unit=f.unit,
+                            labelnames=labelnames,
+                            registry=self.registry,
+                        )
+                    else:
+                        # we don't support other types yet, continue in these cases
+                        self.logger.warning(
+                            "unsupported metric type %s, dropping", f.type
+                        )
+                        continue
+                    for s in samples:
+                        if len(labelnames) > 0:
+                            labelvalues = list(s.labels.values())
+                            m.labels(*labelvalues).set(s.value)
+                        else:
+                            m.set(s.value)
+                    self.metrics[f.name] = m
+                    self.logger.info(
+                        "copy gauge metric %s with labels %s from old file",
+                        f.name,
+                        ", ".join(labelnames),
+                    )
+                else:
+                    self.logger.warning(
+                        "got empty metric %s from old file, dropping", f.name
+                    )
+
+    def _build_metrics(self):
+        # add new metric from commandline
+        m = False
+
+        # figure out labelkey- and values
+        labels = {}
+        if self.args.label:
+            for lpair in self.args.label:
+                k, v = lpair.split("=")
+                labels[k] = v
+
+        labelvalues = []
+        # here, we use a new metric
+        if self.args.metric not in self.metrics:
+            self.logger.info("adding new metric %s", self.args.metric)
+            m = Gauge(
+                self.args.metric,
+                self.args.docs,
+                registry=self.registry,
+                labelnames=labels.keys(),
+            )
+            labelvalues = labels.values()
+        else:
+            m = self.metrics[self.args.metric]
+
+            # There is no way to access existing labelnames directly
+            # pylint: disable=W0212
+            old_labelnames = list(m._labelnames)
+            for la in old_labelnames:
+                self.logger.info("processing label %s", la)
+                if la in labels:  # labelvalues are needed in order!
+                    labelvalues.append(labels[la])
+                else:
+                    self.logger.error(
+                        "previously known label '%s' missing, cannot update!", la
+                    )
+                    sys.exit(1)
+            if len(old_labelnames) != len(labels.keys()):
+                self.logger.error(
+                    "labelnames for metric %s not the same, cannot update! Old: %s, New: %s",
+                    self.args.metric,
+                    old_labelnames,
+                    list(labels.keys()),
+                )
+                sys.exit(1)
+            self.logger.info("updating metric %s", self.args.metric)
+
+        # actually set the value
+        if len(labelvalues) > 0:
+            m.labels(*labelvalues).set(self.args.value)
+        else:
+            m.set(self.args.value)
+
+    def output_file(self):
+        """Output to a textfile"""
+        write_to_textfile(self.textfile, self.registry)
+        self.logger.info("wrote to %s", self.textfile)
+
+    def cli_entrypoint(self):
+        """Main method called from the CLI"""
+        self._arguments()
+
+        logging.basicConfig(level=self.args.loglevel)
+        self.logger = logging.getLogger(__name__)
+
+        self.parse_file()
+        self._build_metrics()
+        self.output_file()

{promtext_cli-0.1.2.dev97 → promtext_cli-0.1.2.dev98}/pyproject.toml

@@ -28,7 +28,7 @@ Source = "https://codeberg.org/margau/promtext-cli.git"
 
 # Scripts
 [project.scripts]
-promtext = "promtext_cli.main:promtext"
+promtext = "promtext_cli:main.main"
 
 [dependency-groups]
 dev = [
@@ -43,6 +43,6 @@ dev = [
 cache-keys = [{ file = "pyproject.toml" }, { git = { commit = true, tags = true } }]
 
 [tool.coverage.run]
-source = ["src", "tests"]
+source = ["promtext_cli", "tests"]
 
 # TODO: Dev/CI scripts for lint & co.

{promtext_cli-0.1.2.dev97 → promtext_cli-0.1.2.dev98}/tests/test_functional.py

@@ -4,7 +4,7 @@
 from cli_test_helpers import ArgvContext
 import pytest
 
-import promtext_cli.main
+from promtext_cli.main import main as promtext_main
 
 
 def test_new_file(tmp_path):
@@ -13,7 +13,7 @@ def test_new_file(tmp_path):
     """
     promfile = tmp_path / "new_file.prom"
     with ArgvContext("promtext", str(promfile), "test_metric", "0"):
-        promtext_cli.main.promtext()
+        promtext_main()
     assert promfile.exists()
     assert promfile.read_text() == (
         "# HELP test_metric metric appended by promtext-cli"
@@ -33,7 +33,7 @@ def test_labels(tmp_path):
     with ArgvContext(
         "promtext", "--label", "testlabel=testvalue", str(promfile), "test_metric", 0
     ):
-        promtext_cli.main.promtext()
+        promtext_main()
     assert promfile.exists()
     assert promfile.read_text() == (
         "# HELP test_metric metric appended by promtext-cli"
@@ -62,7 +62,7 @@ def test_existing_metric_append_metric(tmp_path):
     with ArgvContext(
         "promtext", "--label", "testlabel=testvalue", str(promfile), "new_metric", 0
     ):
-        promtext_cli.main.promtext()
+        promtext_main()
     assert promfile.exists()
     assert promfile.read_text() == (
         "# HELP existing_metric metric appended by promtext-cli"
@@ -97,7 +97,7 @@ def test_existing_metric_append_labelvalue(tmp_path):
     with ArgvContext(
         "promtext", "--label", "testlabel=new", str(promfile), "existing_metric", 0
     ):
-        promtext_cli.main.promtext()
+        promtext_main()
     assert promfile.exists()
     assert promfile.read_text() == (
         "# HELP existing_metric metric appended by promtext-cli"
@@ -135,7 +135,7 @@ def test_existing_metric_multilabel(tmp_path):
         "existing_metric",
         "42",
     ):
-        promtext_cli.main.promtext()
+        promtext_main()
     assert promfile.exists()
     assert promfile.read_text() == (
         "# HELP existing_metric metric appended by promtext-cli"
@@ -170,7 +170,7 @@ def test_existing_metric_overwrite(tmp_path):
         "existing_metric",
         "42",
     ):
-        promtext_cli.main.promtext()
+        promtext_main()
     assert promfile.exists()
     assert promfile.read_text() == (
         "# HELP existing_metric metric appended by promtext-cli"
@@ -196,7 +196,7 @@ def test_existing_metric_plain(tmp_path):
         "\n"
     )
     with ArgvContext("promtext", str(promfile), "existing_metric", "42"):
-        promtext_cli.main.promtext()
+        promtext_main()
     assert promfile.exists()
     assert promfile.read_text() == (
         "# HELP existing_metric metric appended by promtext-cli"
@@ -226,7 +226,7 @@ def test_existing_metric_labeldrop(tmp_path, capsys):
         ArgvContext("promtext", str(promfile), "existing_metric", "42"),
         pytest.raises(SystemExit) as pytest_wrapped_e,
     ):
-        promtext_cli.main.promtext()
+        promtext_main()
     assert promfile.exists()
     assert promfile.read_text() == (
         "# HELP existing_metric metric appended by promtext-cli"
@@ -240,10 +240,7 @@ def test_existing_metric_labeldrop(tmp_path, capsys):
     assert pytest_wrapped_e.type is SystemExit
     assert pytest_wrapped_e.value.code == 1
     captured = capsys.readouterr()
-    assert (
-        "ERROR:promtext_cli.main:previously known label 'testlabel' missing, cannot update!"
-        in captured.err
-    )
+    assert "previously known label 'testlabel' missing, cannot update!" in captured.err
 
 
 def test_existing_metric_labelchange(tmp_path, capsys):
@@ -271,7 +268,7 @@ def test_existing_metric_labelchange(tmp_path, capsys):
         ),
         pytest.raises(SystemExit) as pytest_wrapped_e,
     ):
-        promtext_cli.main.promtext()
+        promtext_main()
     assert promfile.exists()
     assert promfile.read_text() == (
         "# HELP existing_metric metric appended by promtext-cli"
@@ -286,8 +283,7 @@ def test_existing_metric_labelchange(tmp_path, capsys):
     assert pytest_wrapped_e.value.code == 1
     captured = capsys.readouterr()
     assert (
-        "ERROR:promtext_cli.main:previously known label 'existinglabel' missing, cannot update!"
-        in captured.err
+        "previously known label 'existinglabel' missing, cannot update!" in captured.err
     )
 
 
@@ -318,7 +314,7 @@ def test_existing_metric_labeladd(tmp_path, capsys):
         ),
         pytest.raises(SystemExit) as pytest_wrapped_e,
     ):
-        promtext_cli.main.promtext()
+        promtext_main()
     assert promfile.exists()
     assert promfile.read_text() == (
         "# HELP existing_metric metric appended by promtext-cli"
@@ -333,7 +329,7 @@ def test_existing_metric_labeladd(tmp_path, capsys):
     assert pytest_wrapped_e.value.code == 1
     captured = capsys.readouterr()
     assert (
-        "ERROR:promtext_cli.main:labelnames for metric existing_metric not the same, cannot update"
+        "labelnames for metric existing_metric not the same, cannot update"
         in captured.err
     )
 

promtext_cli-0.1.2.dev97/promtext_cli/main.py

@@ -1,152 +0,0 @@
-"""promtext_cli is providing a CLI to cleanly update prometheus textfiles from scripts"""
-
-# pylint: disable=C0116,R0914,R0912,R0915
-# this rules will be fixed by a object-oriented refactoring
-
-import argparse
-from pathlib import Path
-import logging
-import sys
-
-from prometheus_client.parser import text_string_to_metric_families
-from prometheus_client import CollectorRegistry, Gauge, write_to_textfile
-
-
-def promtext():
-    # setup argpars
-    # required file first
-    parser = argparse.ArgumentParser(description="Prometheus textfile helper")
-    parser.add_argument(
-        "filename",
-        type=str,
-        help="Path to existing or new prometheus textfile, will be updated",
-    )
-
-    # metric name, required
-    parser.add_argument("metric", type=str, help="metric name (new or updated)")
-
-    # metric value as int/float, required
-    parser.add_argument("value", type=float, help="metric value")
-
-    # metric documentation as optional argument
-    parser.add_argument(
-        "--docs",
-        type=str,
-        help="metric documentation",
-        default="metric appended by promtext-cli",
-    )
-
-    # labels, key-value, minimum 0, repeatable
-    parser.add_argument(
-        "--label", metavar="KEY=VALUE", help="label key=value pairs", action="append"
-    )
-
-    # log level from argparse
-    parser.add_argument(
-        "-v",
-        "--verbose",
-        action="store_const",
-        dest="loglevel",
-        const=logging.INFO,
-    )
-    args = parser.parse_args()
-    logging.basicConfig(level=args.loglevel)
-    logger = logging.getLogger(__name__)
-
-    # processing: check if file is available, if yes, parse
-    textfile = Path(args.filename)
-
-    registry = CollectorRegistry()
-    metrics = {}
-
-    # check if args.filename exists with pathlib
-    if textfile.is_file():
-        for f in text_string_to_metric_families(textfile.read_text(encoding="utf-8")):
-            # per metric: iterate over samples, create metric in registry
-            m = False
-            samples = []
-            for s in f.samples:
-                samples.append(s)
-            if len(samples) > 0:
-                # if we have samples, use the labelnames from them
-                labelnames = list(samples[0].labels.keys())
-                # metric-type specific init
-                if f.type == "gauge":
-                    m = Gauge(
-                        f.name,
-                        f.documentation,
-                        unit=f.unit,
-                        labelnames=labelnames,
-                        registry=registry,
-                    )
-                else:
-                    # we don't support other types yet, continue in these cases
-                    logger.warning("unsupported metric type %s, dropping", f.type)
-                    continue
-                for s in samples:
-                    if len(labelnames) > 0:
-                        labelvalues = list(s.labels.values())
-                        m.labels(*labelvalues).set(s.value)
-                    else:
-                        m.set(s.value)
-                metrics[f.name] = m
-                logger.info(
-                    "copy gauge metric %s with labels %s from old file",
-                    f.name,
-                    ", ".join(labelnames),
-                )
-            else:
-                logger.warning("got empty metric %s from old file, dropping", f.name)
-
-    # add new metric from commandline
-    m = False
-
-    # figure out labelkey- and values
-    labels = {}
-    if args.label:
-        for lpair in args.label:
-            k, v = lpair.split("=")
-            labels[k] = v
-
-    labelvalues = []
-    # here, we use a new metric
-    if args.metric not in metrics:
-        logger.info("adding new metric %s", args.metric)
-        m = Gauge(args.metric, args.docs, registry=registry, labelnames=labels.keys())
-        labelvalues = labels.values()
-    else:
-        m = metrics[args.metric]
-
-        # There is no way to access existing labelnames directly
-        # pylint: disable=W0212
-        old_labelnames = list(m._labelnames)
-        for la in old_labelnames:
-            logger.info("processing label %s", la)
-            if la in labels:  # labelvalues are needed in order!
-                labelvalues.append(labels[la])
-            else:
-                logger.error("previously known label '%s' missing, cannot update!", la)
-                sys.exit(1)
-        if len(old_labelnames) != len(labels.keys()):
-            logger.error(
-                "labelnames for metric %s not the same, cannot update! Old: %s, New: %s",
-                args.metric,
-                old_labelnames,
-                list(labels.keys()),
-            )
-            sys.exit(1)
-        logger.info("updating metric %s", args.metric)
-
-    # actually set the value
-    if len(labelvalues) > 0:
-        m.labels(*labelvalues).set(args.value)
-    else:
-        m.set(args.value)
-
-    # write to file
-    write_to_textfile(args.filename, registry)
-    logger.info("wrote to %s", args.filename)
-
-
-if __name__ == "__main__":
-    promtext()