tinyflux 1.2.0__tar.gz → 1.3.0__tar.gz

{tinyflux-1.2.0/tinyflux.egg-info → tinyflux-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tinyflux
-Version: 1.2.0
+Version: 1.3.0
 Summary: The Tiny Time-Series Database Optimized for Your Happiness
 Home-page: https://github.com/citrusvanilla/tinyflux
 Author: Justin Fung
@@ -17,15 +17,16 @@ Classifier: Topic :: Database
 Classifier: Topic :: Database :: Database Engines/Servers
 Classifier: Topic :: Utilities
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Operating System :: OS Independent
 Classifier: Typing :: Typed
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: license-file
@@ -37,7 +38,7 @@ Dynamic: license-file
 
 TinyFlux is the tiny time series database optimized for your happiness 😎
 
-TinyFlux is the time series version of [TinyDB](https://tinydb.readthedocs.io/en/latest/index.html) that is written in Python and has no external dependencies. It consistently writes atomically to file at over 6,000 writes per second and supports greater than 100 queries per second for time-based range queries on datasets up to 100,000 points. It's a perfect companion for small analytics workflows and apps, as well as at-home IOT data stores. TinyFlux has 100% test coverage, over 150,000 downloads, and no open issues.
+TinyFlux is the time series version of [TinyDB](https://tinydb.readthedocs.io/en/latest/index.html) that is written in Python and has no external dependencies. It consistently writes atomically to file at over 6,000 writes per second and supports greater than 100 queries per second for time-based range queries on datasets up to 100,000 points. It's a perfect companion for small analytics workflows and apps, as well as at-home IOT data stores. TinyFlux has 100% test coverage, over 200,000 downloads, and no open issues.
 
 [![Documentation](https://readthedocs.org/projects/tinyflux/badge/?version=latest)](https://tinyflux.readthedocs.io/en/latest/?badge=latest)
 [![Version](https://img.shields.io/pypi/v/tinyflux.svg)](https://pypi.org/project/tinyflux/)
@@ -59,6 +60,8 @@ Install from PyPI:
 pip install tinyflux
 ```
 
+TinyFlux supports CPython 3.10 through 3.15.
+
 ## Quick Start
 
 ```python
@@ -238,13 +241,11 @@ TinyFlux automatic indexing provides:
 
 ## TinyFlux Across the Internet
 
-- **IoT Sensor Networks**: Collect and analyze device telemetry
-- **System Monitoring**: Track server metrics and application performance  
-- **Financial Data**: Store and query stock prices, trading volumes
-- **Scientific Research**: Log experimental measurements and observations
-- **Web Analytics**: Time-stamped user interaction data
+Articles, tutorials, and other instances of TinyFlux in the wild:
 
-*Perfect for prototyping, edge computing, embedded systems, and applications where simplicity matters.*
+- ["Introducing TinyFlux: The Tiny Time Series Database for Python-based IoT & Analytics Applications"](https://citrusvanilla.medium.com/introducing-tinyflux-the-tiny-time-series-database-for-python-based-iot-analytics-applications-c3ef3c3bedf): A Medium.com article announcing the release of TinyFlux
+- ["Storing Time Series Data in Python Using TinyFluxDB"](http://www.steves-internet-guide.com/storing-time-series-data-python-using-tinyflux-db/): A tutorial from [Steve's Internet Guide](http://www.steves-internet-guide.com/), a portal for learning MQTT and IoT development for Python
+- ["KaiCode 2024 Shortlist"](https://www.kaicode.org/2024.html): TinyFlux came in 10th place out of 412 entrants in the 7th edition of this open-source festival, a festival dedicated to recognizing projects with high-quality open-source principles
 
 ## Contributing
 

{tinyflux-1.2.0 → tinyflux-1.3.0}/README.md

@@ -5,7 +5,7 @@
 
 TinyFlux is the tiny time series database optimized for your happiness 😎
 
-TinyFlux is the time series version of [TinyDB](https://tinydb.readthedocs.io/en/latest/index.html) that is written in Python and has no external dependencies. It consistently writes atomically to file at over 6,000 writes per second and supports greater than 100 queries per second for time-based range queries on datasets up to 100,000 points. It's a perfect companion for small analytics workflows and apps, as well as at-home IOT data stores. TinyFlux has 100% test coverage, over 150,000 downloads, and no open issues.
+TinyFlux is the time series version of [TinyDB](https://tinydb.readthedocs.io/en/latest/index.html) that is written in Python and has no external dependencies. It consistently writes atomically to file at over 6,000 writes per second and supports greater than 100 queries per second for time-based range queries on datasets up to 100,000 points. It's a perfect companion for small analytics workflows and apps, as well as at-home IOT data stores. TinyFlux has 100% test coverage, over 200,000 downloads, and no open issues.
 
 [![Documentation](https://readthedocs.org/projects/tinyflux/badge/?version=latest)](https://tinyflux.readthedocs.io/en/latest/?badge=latest)
 [![Version](https://img.shields.io/pypi/v/tinyflux.svg)](https://pypi.org/project/tinyflux/)
@@ -27,6 +27,8 @@ Install from PyPI:
 pip install tinyflux
 ```
 
+TinyFlux supports CPython 3.10 through 3.15.
+
 ## Quick Start
 
 ```python
@@ -206,13 +208,11 @@ TinyFlux automatic indexing provides:
 
 ## TinyFlux Across the Internet
 
-- **IoT Sensor Networks**: Collect and analyze device telemetry
-- **System Monitoring**: Track server metrics and application performance  
-- **Financial Data**: Store and query stock prices, trading volumes
-- **Scientific Research**: Log experimental measurements and observations
-- **Web Analytics**: Time-stamped user interaction data
+Articles, tutorials, and other instances of TinyFlux in the wild:
 
-*Perfect for prototyping, edge computing, embedded systems, and applications where simplicity matters.*
+- ["Introducing TinyFlux: The Tiny Time Series Database for Python-based IoT & Analytics Applications"](https://citrusvanilla.medium.com/introducing-tinyflux-the-tiny-time-series-database-for-python-based-iot-analytics-applications-c3ef3c3bedf): A Medium.com article announcing the release of TinyFlux
+- ["Storing Time Series Data in Python Using TinyFluxDB"](http://www.steves-internet-guide.com/storing-time-series-data-python-using-tinyflux-db/): A tutorial from [Steve's Internet Guide](http://www.steves-internet-guide.com/), a portal for learning MQTT and IoT development for Python
+- ["KaiCode 2024 Shortlist"](https://www.kaicode.org/2024.html): TinyFlux came in 10th place out of 412 entrants in the 7th edition of this open-source festival, a festival dedicated to recognizing projects with high-quality open-source principles
 
 ## Contributing
 

{tinyflux-1.2.0 → tinyflux-1.3.0}/setup.cfg

@@ -30,18 +30,19 @@ classifiers =
 	Topic :: Database :: Database Engines/Servers
 	Topic :: Utilities
 	Programming Language :: Python :: 3
-	Programming Language :: Python :: 3.9
 	Programming Language :: Python :: 3.10
 	Programming Language :: Python :: 3.11
 	Programming Language :: Python :: 3.12
 	Programming Language :: Python :: 3.13
+	Programming Language :: Python :: 3.14
+	Programming Language :: Python :: 3.15
 	Programming Language :: Python :: Implementation :: CPython
 	Operating System :: OS Independent
 	Typing :: Typed
 
 [options]
 packages = tinyflux
-python_requires = >=3.9
+python_requires = >=3.10
 
 [options.package_data]
 tinyflux = py.typed

{tinyflux-1.2.0 → tinyflux-1.3.0}/tests/test_index.py

@@ -350,6 +350,23 @@ def test_search_field_query():
     assert rst.items == set({})
 
 
+def test_search_field_query_with_map():
+    """Test Index search applies map functions to field values."""
+    index = Index()
+    index._insert_fields(0, {"temp": 70.0})
+
+    rst = index.search(FieldQuery().temp.map(lambda x: x * 2) == 140.0)
+    assert rst.items == {0}
+
+    rst = index.search(
+        FieldQuery().map(lambda fields: fields["temp"] * 2) == 140.0
+    )
+    assert rst.items == {0}
+
+    rst = index.search(FieldQuery().temp.map(lambda _: 1 / 0) == 1)
+    assert rst.items == set({})
+
+
 def test_search_compound_query_not():
     """Test search_query of Index on compound 'not' queries."""
     # Some timestamps.

{tinyflux-1.2.0 → tinyflux-1.3.0}/tests/test_measurement.py

@@ -918,9 +918,9 @@ def test_update():
         m1.update(TagQuery().noop(), tags={"a": 1})
 
     with pytest.raises(
-        ValueError, match="Field set must contain only numeric values."
+        ValueError, match="Field set must contain only numeric, string, or bool"
     ):
-        m1.update(TagQuery().noop(), fields={"a": "a"})
+        m1.update(TagQuery().noop(), fields={"a": ["a"]})
 
     # Valid index, no index results.
     db.reindex()

{tinyflux-1.2.0 → tinyflux-1.3.0}/tests/test_point.py

@@ -2,7 +2,12 @@
 
 from datetime import datetime, timezone, timedelta
 import pytest
-from tinyflux.point import Point, validate_tags, validate_fields
+from tinyflux.point import (
+    Point,
+    _serialize_field_value,
+    validate_tags,
+    validate_fields,
+)
 
 
 @pytest.fixture
@@ -100,8 +105,13 @@ def test_args_and_kwargs_invalid(args, kwargs, exception_type):
         ),
         (
             validate_fields,
-            [3, {1: "A"}, {"a": "A"}],
-            [{"a": 1}, {"temp": 70.5}, {"count": 10, "avg": 25.3}],
+            [3, {1: "A"}, {"a": ["A"]}, {"a": b"A"}],
+            [
+                {"a": 1},
+                {"temp": 70.5},
+                {"count": 10, "avg": 25.3},
+                {"s": "A", "b": True, "n": None},
+            ],
         ),
     ],
 )
@@ -199,8 +209,8 @@ def invalid_field_values(test_times):
         {test_time: "all good"},
         {tuple((1, 2)): "ok"},
         {"key": {"a": "b"}},
-        {"a": True},  # Invalid for fields (should be numeric/None)
-        # Note: {"a": 123} is valid for fields, so not included
+        {"a": ["b"]},
+        # Note: {"a": 123}, {"a": "b"}, and {"a": True} are valid for fields.
     ]
 
 
@@ -533,3 +543,100 @@ def test_compact_keys(point_data, prefix_attr, key_indices, expected_values):
     # Check that values match expected
     for key, expected_value in expected_values.items():
         assert getattr(new_p_compact, data_attr)[key] == expected_value
+
+
+@pytest.mark.parametrize(
+    "value,serialized",
+    [
+        (True, "true"),
+        (False, "false"),
+        ("abc", '"abc"'),
+        ("", '""'),
+        ("true", '"true"'),
+        ("1.5", '"1.5"'),
+        ("_none", '"_none"'),
+        ("a,b", '"a,b"'),
+        ('say "hi"', '"say \\"hi\\""'),
+        ("back\\slash", '"back\\\\slash"'),
+        ("line1\nline2\r\n", '"line1\\nline2\\r\\n"'),
+        ("\\n", '"\\\\n"'),
+        ("\u00e9\u4e2d", '"\u00e9\u4e2d"'),
+        (1, "1.0"),
+        (-2.5, "-2.5"),
+        (None, "_none"),
+    ],
+)
+def test_serialize_string_and_bool_fields(value, serialized):
+    """Test the serialized form of, and round trip for, each field type."""
+    p = Point(
+        time=datetime(2022, 1, 1, tzinfo=timezone.utc), fields={"k": value}
+    )
+    row = p._serialize_to_list()
+
+    assert row[-2:] == ("_field_k", serialized)
+    assert not any("\n" in i or "\r" in i for i in row)
+
+    result = Point()._deserialize_from_list(row)
+
+    # Numbers always come back as floats, everything else as it went in.
+    expected = float(value) if type(value) is int else value
+    assert result.fields == {"k": expected}
+    assert type(result.fields["k"]) is type(expected)
+
+
+def test_serialize_numeric_field_subclasses():
+    """Test numeric subclasses keep the same serialized form as numbers."""
+
+    class MyInt(int):
+        pass
+
+    class MyFloat(float):
+        pass
+
+    p = Point(
+        time=datetime(2022, 1, 1, tzinfo=timezone.utc),
+        fields={"i": MyInt(1), "f": MyFloat(2.5)},
+    )
+    row = p._serialize_to_list()
+
+    assert row[-4:] == ("_field_i", "1.0", "_field_f", "2.5")
+
+
+def test_serialize_unsupported_field_value():
+    """Test the serializer rejects unsupported values defensively."""
+    with pytest.raises(TypeError, match="Unsupported field value type: list"):
+        _serialize_field_value([], "_none")
+
+
+def test_deserialize_legacy_and_unknown_field_values():
+    """Test that values written by earlier releases read back unchanged."""
+    row = [
+        "2022-01-01T00:00:00",
+        "m",
+        "_tag_t",
+        "true",
+        "_field_a",
+        "1.0",
+        "_field_b",
+        "-3",
+        "_field_c",
+        "2.5e-05",
+        "_field_d",
+        "_none",
+        "_field_e",
+        "nan",
+        "_field_f",
+        "garbage",
+        "_field_g",
+        '"unterminated',
+    ]
+    p = Point()._deserialize_from_list(row)
+
+    assert p.tags == {"t": "true"}
+    assert p.fields["a"] == 1.0 and isinstance(p.fields["a"], float)
+    assert p.fields["b"] == -3 and isinstance(p.fields["b"], int)
+    assert p.fields["c"] == 2.5e-05
+    assert p.fields["d"] is None
+    assert p.fields["e"] != p.fields["e"]
+    assert p.fields["f"] is None
+    assert p.fields["g"] is None

{tinyflux-1.2.0 → tinyflux-1.3.0}/tests/test_queries.py

@@ -625,6 +625,27 @@ def test_hash():
     assert not (~(q1 & q5)).is_hashable()
 
 
+def test_bool_numeric_field_query_hash_identity():
+    """Test bool field queries are distinct from numeric field queries."""
+    q_true = FieldQuery().a == True  # noqa: E712
+    q_one = FieldQuery().a == 1
+    q_one_float = FieldQuery().a == 1.0
+    q_false = FieldQuery().a == False  # noqa: E712
+    q_zero = FieldQuery().a == 0
+    q_zero_float = FieldQuery().a == 0.0
+
+    assert q_true != q_one
+    assert q_false != q_zero
+    assert q_one == q_one_float
+    assert q_zero == q_zero_float
+
+    assert q_true._hash[-1] != True  # noqa: E712
+    assert len({q_true, q_one, q_one_float, q_false, q_zero, q_zero_float}) == 4
+
+    assert (q_true & q_one) != (q_one & q_one)
+    assert (q_false | q_zero) != (q_zero | q_zero)
+
+
 def test_empty_query_evaluation():
     """Test calling an empty query raises Exception."""
     with pytest.raises(TypeError):
@@ -870,6 +891,61 @@ def test_bad_queries():
     with pytest.raises(TypeError):
         TagQuery().city == ["a", "b"]
 
-    # Test a non-numeric right hand side.
+    # Test a right hand side that is not numeric, string, or bool.
     with pytest.raises(TypeError):
-        FieldQuery().a == "a"
+        FieldQuery().a == ["a"]
+
+
+def test_string_and_bool_field_queries():
+    """Test queries against string and bool field values."""
+    s = Point(fields={"a": "abc"})
+    t = Point(fields={"a": True})
+    f = Point(fields={"a": False})
+    n = Point(fields={"a": 1})
+    z = Point(fields={"a": 0.0})
+    none = Point(fields={"a": None})
+    missing = Point(fields={"b": "abc"})
+    points = [s, t, f, n, z, none, missing]
+
+    yes, no = True, False
+
+    def matches(q):
+        return [p for p in points if q(p)]
+
+    # Equality is typed.
+    assert matches(FieldQuery().a == "abc") == [s]
+    assert matches(FieldQuery().a == "ABC") == []
+    assert matches(FieldQuery().a == "") == []
+    assert matches(FieldQuery().a == yes) == [t]
+    assert matches(FieldQuery().a == no) == [f]
+    assert matches(FieldQuery().a == 1) == [n]
+    assert matches(FieldQuery().a == 0) == [z]
+    assert matches(FieldQuery().a == "1") == []
+
+    # Inequality is typed too: a missing field is never a match.
+    assert matches(FieldQuery().a != "abc") == [t, f, n, z, none]
+    assert matches(FieldQuery().a != yes) == [s, f, n, z, none]
+    assert matches(FieldQuery().a != 1) == [s, t, f, z, none]
+
+    # Numeric comparisons skip strings and bools instead of raising.
+    assert matches(FieldQuery().a > 0) == [n]
+    assert matches(FieldQuery().a >= 0) == [n, z]
+    assert matches(FieldQuery().a < 1) == [z]
+    assert matches(FieldQuery().a <= 1) == [n, z]
+
+    # String comparisons are lexicographic and skip numbers and bools.
+    assert matches(FieldQuery().a > "abb") == [s]
+    assert matches(FieldQuery().a < "abd") == [s]
+    assert matches(FieldQuery().a >= "abc") == [s]
+    assert matches(FieldQuery().a <= "abc") == [s]
+
+    # Bools only order against bools.
+    assert matches(FieldQuery().a > no) == [t]
+    assert matches(FieldQuery().a <= yes) == [t, f]
+
+    # Compound queries work as for any other field value.
+    assert matches((FieldQuery().a == "abc") | (FieldQuery().a == yes)) == [
+        s,
+        t,
+    ]
+    assert matches(~(FieldQuery().a == "abc")) == [t, f, n, z, none, missing]

{tinyflux-1.2.0 → tinyflux-1.3.0}/tests/test_storages.py

@@ -352,7 +352,7 @@ def test_connect_to_existing_csv(tmpdir, csv_storage_with_counters):
 
     # Mock CSV store.  Insert points out of order.
     path = os.path.join(tmpdir, "test.csv")
-    with open(path, "w") as f:
+    with open(path, "w", newline="") as f:
         w = csv.writer(f)
         w.writerow(p2._serialize_to_list())
         w.writerow(p1._serialize_to_list())
@@ -478,7 +478,7 @@ def test_multiple_appends(
 
     # Mock CSV store.  Insert points out of order.
     path = os.path.join(tmpdir, "test.csv")
-    with open(path, "w") as f:
+    with open(path, "w", newline="") as f:
         w = csv.writer(f)
         w.writerow(p2._serialize_to_list())
         w.writerow(p1._serialize_to_list())
@@ -514,7 +514,7 @@ def test_multiple_reads(
     path = os.path.join(tmpdir, "test.csv")
     t = datetime.now(timezone.utc)
 
-    with open(path, "w") as f:
+    with open(path, "w", newline="") as f:
         w = csv.writer(f)
         for _ in range(10):
             w.writerow(Point(time=t)._serialize_to_list())
@@ -533,7 +533,7 @@ def test_multiple_reads(
 
     # Mock CSV store.  Insert points out-of-order.
     path = os.path.join(tmpdir, "test.csv")
-    with open(path, "w") as f:
+    with open(path, "w", newline="") as f:
         w = csv.writer(f)
         for _ in range(10):
             w.writerow(Point(time=t)._serialize_to_list())
@@ -667,3 +667,116 @@ def test_compact_key_prefixes(tmpdir):
     assert m._serialize_point(
         p, compact_key_prefixes=False
     ) == p._serialize_to_list(compact_key_prefixes=False)
+
+
+STRING_AND_BOOL_FIELDS = {
+    "s": "plain",
+    "empty": "",
+    "t": True,
+    "f": False,
+    "str_true": "true",
+    "str_num": "1.5",
+    "str_none": "_none",
+    "comma": "a,b",
+    "quote": 'she said "hi", then left',
+    "backslash": "C:\\temp\\new",
+    "newline": "line1\nline2\r\nline3\r",
+    "unicode": "caf\u00e9 \u4e2d\u6587",
+    "n": 1.5,
+    "i": 3,
+    "none": None,
+}
+
+
+@pytest.mark.parametrize("compact_key_prefixes", [False, True])
+def test_string_and_bool_fields_round_trip(tmpdir, compact_key_prefixes):
+    """Test writing, closing, reopening, and reading string/bool fields."""
+    path = os.path.join(tmpdir, "test.csv")
+    t = datetime(2022, 1, 1, tzinfo=timezone.utc)
+    points = [
+        Point(time=t, measurement="m", fields=STRING_AND_BOOL_FIELDS),
+        Point(
+            time=t + timedelta(seconds=1),
+            measurement="m",
+            tags={"tag": "true"},
+            fields={"s": "second", "t": False},
+        ),
+    ]
+
+    db = TinyFlux(path, encoding="utf-8")
+    db.insert_multiple(points, compact_key_prefixes=compact_key_prefixes)
+    db.close()
+
+    # Each point is still exactly one line in the file.
+    with open(path, encoding="utf-8", newline="") as f:
+        assert len(f.read().split("\n")) == len(points) + 1
+
+    db = TinyFlux(path, encoding="utf-8")
+    assert len(db) == 2
+    result = db.all()
+    assert result == points
+
+    # Types survive, in particular bool vs. int vs. str.
+    first = result[0].fields
+    for key, value in STRING_AND_BOOL_FIELDS.items():
+        assert first[key] == value
+        assert type(first[key]) is (float if key == "i" else type(value))
+
+    # The index built on reopen sees the typed values.
+    assert db.get_field_values("s") == ["plain", "second"]
+    assert db.get_field_values("t") == [True, False]
+    db.close()
+
+
+def test_string_and_bool_fields_memory_storage():
+    """Test string and bool fields in memory storage."""
+    db = TinyFlux(storage=MemoryStorage)
+    p = Point(fields=STRING_AND_BOOL_FIELDS)
+    db.insert(p)
+
+    assert db.all() == [p]
+    assert db.get_field_values("quote") == [STRING_AND_BOOL_FIELDS["quote"]]
+
+
+def test_numeric_only_files_from_earlier_releases_read_identically(tmpdir):
+    """Test that a file written before string/bool support reads unchanged."""
+    path = os.path.join(tmpdir, "legacy.csv")
+
+    with open(path, "w", newline="") as f:
+        f.write(
+            "2022-01-01T00:00:00,m,_tag_a,b,_field_x,1.0,_field_y,-2.5,"
+            "_field_z,_none\r\n"
+            "2022-01-01T00:00:01,m,t_a,c,f_x,3.0,f_y,1e-07\r\n"
+        )
+
+    db = TinyFlux(path)
+    assert db.all() == [
+        Point(
+            time=datetime(2022, 1, 1, tzinfo=timezone.utc),
+            measurement="m",
+            tags={"a": "b"},
+            fields={"x": 1.0, "y": -2.5, "z": None},
+        ),
+        Point(
+            time=datetime(2022, 1, 1, 0, 0, 1, tzinfo=timezone.utc),
+            measurement="m",
+            tags={"a": "c"},
+            fields={"x": 3.0, "y": 1e-07},
+        ),
+    ]
+
+    # New string/bool points can be appended to an old file.
+    db.insert(
+        Point(
+            time=datetime(2022, 1, 1, 0, 0, 2, tzinfo=timezone.utc),
+            measurement="m",
+            fields={"x": "on", "y": True},
+        )
+    )
+    db.close()
+
+    db = TinyFlux(path)
+    assert len(db) == 3
+    assert db.all()[0].fields == {"x": 1.0, "y": -2.5, "z": None}
+    assert db.all()[2].fields == {"x": "on", "y": True}
+    db.close()