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

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

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier.
-_commit: 0.8.5
+_commit: 0.9.0
 _src_path: https://codeberg.org/margau/copier-python-uv.git
 code_dir: promtext_cli
 container: false

{promtext_cli-0.1.2.dev98 → promtext_cli-0.1.2.dev100}/.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
         stages: [commit-msg]
         args: []
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.15.13
+    rev: v0.15.14
     hooks:
       # Run the linter.
       - id: ruff-check

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: promtext-cli
-Version: 0.1.2.dev98
+Version: 0.1.2.dev100
 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-0.1.2.dev100}/promtext_cli/main.py

@@ -1,10 +1,10 @@
-"""This module takes care of entrypoints"""
+"""Provide the Entrypoints"""
 
 from .promtext import Promtext
 
 
 def main():
-    """main method invoking the core class"""
+    """Main method invoking the core class"""
     Promtext().cli_entrypoint()
 
 

{promtext_cli-0.1.2.dev98 → promtext_cli-0.1.2.dev100}/promtext_cli/promtext.py

@@ -1,12 +1,12 @@
-"""this is the module providing the core functionality"""
+"""module providing the core functionality"""
 
 import argparse
-from pathlib import Path
 import logging
 import sys
+from pathlib import Path
 
-from prometheus_client.parser import text_string_to_metric_families
 from prometheus_client import CollectorRegistry, Gauge, write_to_textfile
+from prometheus_client.parser import text_string_to_metric_families
 
 
 class Promtext:
@@ -21,7 +21,7 @@ class Promtext:
         self.metrics = {}
 
     def _arguments(self):
-        """load every input item from arguments & define cli"""
+        """Load every input item from arguments & define cli"""
         # required file first
         parser = argparse.ArgumentParser(description="Prometheus textfile helper")
         parser.add_argument(
@@ -70,13 +70,11 @@ class Promtext:
         # 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")
+                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)
+                samples = list(f.samples)
                 if len(samples) > 0:
                     # if we have samples, use the labelnames from them
                     labelnames = list(samples[0].labels.keys())
@@ -92,7 +90,8 @@ class Promtext:
                     else:
                         # we don't support other types yet, continue in these cases
                         self.logger.warning(
-                            "unsupported metric type %s, dropping", f.type
+                            "unsupported metric type %s, dropping",
+                            f.type,
                         )
                         continue
                     for s in samples:
@@ -109,7 +108,8 @@ class Promtext:
                     )
                 else:
                     self.logger.warning(
-                        "got empty metric %s from old file, dropping", f.name
+                        "got empty metric %s from old file, dropping",
+                        f.name,
                     )
 
     def _build_metrics(self):
@@ -139,19 +139,21 @@ class Promtext:
 
             # There is no way to access existing labelnames directly
             # pylint: disable=W0212
-            old_labelnames = list(m._labelnames)
+            old_labelnames = list(m._labelnames)  # noqa: SLF001
             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
+                        "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",
+                    """labelnames for metric %s not the same, cannot update!
+                    Old: %s, New: %s""",
                     self.args.metric,
                     old_labelnames,
                     list(labels.keys()),

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

@@ -45,4 +45,26 @@ cache-keys = [{ file = "pyproject.toml" }, { git = { commit = true, tags = true
 [tool.coverage.run]
 source = ["promtext_cli", "tests"]
 
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "D104",
+    "D107",
+    "D200",
+    "D203",
+    "D205",
+    "D213",
+    "D400",
+    "D401",
+    "D415", # TODO: Remove later
+    "FIX002", # TODO: Remove later
+    "TD002", # TODO: Remove later
+    "TD003", # TODO: Remove later
+    "ANN", # TODO: Remove later
+    "COM812",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**.py" = ["S101", "INP001", "PLR2004"]
+
 # TODO: Dev/CI scripts for lint & co.

{promtext_cli-0.1.2.dev98 → promtext_cli-0.1.2.dev100}/tests/test_blackbox.py

@@ -1,39 +1,32 @@
 # pylint: disable=R0801
-"""This script does blackbox-like testing of the promtext cli tool"""
+"""Blackbox-like testing of the promtext cli tool"""
 
 import shutil
+
 from cli_test_helpers import shell
 
 
 def test_entrypoint():
-    """
-    Is entrypoint script installed? (pyproject.toml)
-    """
+    """Is entrypoint script installed? (pyproject.toml)"""
     assert shutil.which("promtext")
 
 
 def test_help():
-    """
-    Does the help command work?
-    """
+    """Does the help command work?"""
     result = shell("promtext --help")
     assert result.exit_code == 0
     assert "usage:" in result.stdout
 
 
 def test_empty():
-    """
-    Does the command fails with no arguments?
-    """
+    """Does the command fails with no arguments?"""
     result = shell("promtext")
     assert result.exit_code == 2
     assert "usage:" in result.stderr
 
 
 def test_new_file(tmp_path):
-    """
-    Does the command create a new file with metrics content?
-    """
+    """Does the command create a new file with metrics content?"""
     promfile = tmp_path / "new_file.prom"
     result = shell(f"promtext {promfile} test_metric 0")
     assert result.exit_code == 0

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

@@ -1,16 +1,14 @@
 # pylint: disable=R0801,W0511
-"""This script does functional testing by calling the methods directly"""
+"""Functional testing by calling the methods directly"""
 
-from cli_test_helpers import ArgvContext
 import pytest
+from cli_test_helpers import ArgvContext
 
 from promtext_cli.main import main as promtext_main
 
 
 def test_new_file(tmp_path):
-    """
-    Does the command create a new file with metrics content?
-    """
+    """Does the command create a new file with metrics content?"""
     promfile = tmp_path / "new_file.prom"
     with ArgvContext("promtext", str(promfile), "test_metric", "0"):
         promtext_main()
@@ -26,12 +24,15 @@ def test_new_file(tmp_path):
 
 
 def test_labels(tmp_path):
-    """
-    Does the command create a new file with metrics content?
-    """
+    """Does the command create a new file with metrics content?"""
     promfile = tmp_path / "label_file.prom"
     with ArgvContext(
-        "promtext", "--label", "testlabel=testvalue", str(promfile), "test_metric", 0
+        "promtext",
+        "--label",
+        "testlabel=testvalue",
+        str(promfile),
+        "test_metric",
+        0,
     ):
         promtext_main()
     assert promfile.exists()
@@ -46,8 +47,7 @@ def test_labels(tmp_path):
 
 
 def test_existing_metric_append_metric(tmp_path):
-    """
-    Does the command append a new metric to an existing file
+    """Does the command append a new metric to an existing file
     with metrics content and preserve existing metrics?
     """
     promfile = tmp_path / "existing_file.prom"
@@ -57,10 +57,15 @@ def test_existing_metric_append_metric(tmp_path):
         "# TYPE existing_metric gauge"
         "\n"
         'existing_metric{testlabel="testvalue"} 0.0'
-        "\n"
+        "\n",
     )
     with ArgvContext(
-        "promtext", "--label", "testlabel=testvalue", str(promfile), "new_metric", 0
+        "promtext",
+        "--label",
+        "testlabel=testvalue",
+        str(promfile),
+        "new_metric",
+        0,
     ):
         promtext_main()
     assert promfile.exists()
@@ -81,8 +86,7 @@ def test_existing_metric_append_metric(tmp_path):
 
 
 def test_existing_metric_append_labelvalue(tmp_path):
-    """
-    Does the command append a new metric to an existing file
+    """Does the command append a new metric to an existing file
     with metrics content and preserve existing metrics?
     """
     promfile = tmp_path / "existing_file.prom"
@@ -92,10 +96,15 @@ def test_existing_metric_append_labelvalue(tmp_path):
         "# TYPE existing_metric gauge"
         "\n"
         'existing_metric{testlabel="existing"} 0.0'
-        "\n"
+        "\n",
     )
     with ArgvContext(
-        "promtext", "--label", "testlabel=new", str(promfile), "existing_metric", 0
+        "promtext",
+        "--label",
+        "testlabel=new",
+        str(promfile),
+        "existing_metric",
+        0,
     ):
         promtext_main()
     assert promfile.exists()
@@ -112,8 +121,7 @@ def test_existing_metric_append_labelvalue(tmp_path):
 
 
 def test_existing_metric_multilabel(tmp_path):
-    """
-    Does the command append a new metric to an existing file
+    """Does the command append a new metric to an existing file
     with metrics content and preserve existing metrics?
     """
     promfile = tmp_path / "existing_file.prom"
@@ -123,7 +131,7 @@ def test_existing_metric_multilabel(tmp_path):
         "# TYPE existing_metric gauge"
         "\n"
         'existing_metric{first="existing", second="existing"} 0.0'
-        "\n"
+        "\n",
     )
     with ArgvContext(
         "promtext",
@@ -150,9 +158,7 @@ def test_existing_metric_multilabel(tmp_path):
 
 
 def test_existing_metric_overwrite(tmp_path):
-    """
-    Does the command overwrite a metric/labelset
-    """
+    """Does the command overwrite a metric/labelset"""
     promfile = tmp_path / "existing_file.prom"
     promfile.write_text(
         "# HELP existing_metric metric appended by promtext-cli"
@@ -160,7 +166,7 @@ def test_existing_metric_overwrite(tmp_path):
         "# TYPE existing_metric gauge"
         "\n"
         'existing_metric{testlabel="existing"} 0.0'
-        "\n"
+        "\n",
     )
     with ArgvContext(
         "promtext",
@@ -183,9 +189,7 @@ def test_existing_metric_overwrite(tmp_path):
 
 
 def test_existing_metric_plain(tmp_path):
-    """
-    Does the command overwrite a metric without a label?
-    """
+    """Does the command overwrite a metric without a label?"""
     promfile = tmp_path / "existing_file.prom"
     promfile.write_text(
         "# HELP existing_metric metric appended by promtext-cli"
@@ -193,7 +197,7 @@ def test_existing_metric_plain(tmp_path):
         "# TYPE existing_metric gauge"
         "\n"
         "existing_metric 0.0"
-        "\n"
+        "\n",
     )
     with ArgvContext("promtext", str(promfile), "existing_metric", "42"):
         promtext_main()
@@ -209,9 +213,7 @@ def test_existing_metric_plain(tmp_path):
 
 
 def test_existing_metric_labeldrop(tmp_path, capsys):
-    """
-    missing labels are not possible, promtext should fail
-    """
+    """Missing labels are not possible, promtext should fail"""
     promfile = tmp_path / "existing_file.prom"
     promfile.write_text(
         "# HELP existing_metric metric appended by promtext-cli"
@@ -219,7 +221,7 @@ def test_existing_metric_labeldrop(tmp_path, capsys):
         "# TYPE existing_metric gauge"
         "\n"
         'existing_metric{testlabel="existing"} 0.0'
-        "\n"
+        "\n",
     )
 
     with (
@@ -244,9 +246,7 @@ def test_existing_metric_labeldrop(tmp_path, capsys):
 
 
 def test_existing_metric_labelchange(tmp_path, capsys):
-    """
-    changing labels are not possible, promtext should fail
-    """
+    """Changing labels are not possible, promtext should fail"""
     promfile = tmp_path / "existing_file.prom"
     promfile.write_text(
         "# HELP existing_metric metric appended by promtext-cli"
@@ -254,7 +254,7 @@ def test_existing_metric_labelchange(tmp_path, capsys):
         "# TYPE existing_metric gauge"
         "\n"
         'existing_metric{existinglabel="existing"} 0.0'
-        "\n"
+        "\n",
     )
 
     with (
@@ -288,9 +288,7 @@ def test_existing_metric_labelchange(tmp_path, capsys):
 
 
 def test_existing_metric_labeladd(tmp_path, capsys):
-    """
-    adding new labels are not possible, promtext should fail
-    """
+    """Adding new labels are not possible, promtext should fail"""
     promfile = tmp_path / "existing_file.prom"
     promfile.write_text(
         "# HELP existing_metric metric appended by promtext-cli"
@@ -298,7 +296,7 @@ def test_existing_metric_labeladd(tmp_path, capsys):
         "# TYPE existing_metric gauge"
         "\n"
         'existing_metric{existinglabel="existing"} 0.0'
-        "\n"
+        "\n",
     )
 
     with (