tinyflux 0.2.6__tar.gz → 0.3.0__tar.gz

{tinyflux-0.2.6/tinyflux.egg-info → tinyflux-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tinyflux
-Version: 0.2.6
+Version: 0.3.0
 Summary: The Tiny Time-Series Database Optimized for Your Happiness
 Home-page: https://github.com/citrusvanilla/tinyflux
 Author: Justin Fung
@@ -48,6 +48,17 @@ Quick Links
 - `Contributing`_
 
 
+Recent Updates
+**************
+
+v0.3.0 (2023-3-21)
+==================
+
+* Tag and field keys can be compacted when using CSVStorage, saving potentially many bytes per Point (resolves issue #32).
+* Fixed bug that causes tag values of '' to be serialized as "_none" (resolves issue #33).
+
+
+
 Installation
 ************
 
@@ -110,7 +121,7 @@ Writing to TinyFlux
     ...     tags={"room": "bedroom"},
     ...     fields={"temp": 72.0}
     ... )
-    >>> db.insert(p)
+    >>> db.insert(p, compact_key_prefixes=True)
 
 
 Querying TinyFlux
@@ -147,6 +158,11 @@ The `examples <https://github.com/citrusvanilla/tinyflux/tree/master/examples>`_
 2. `Local Analytics Workflow with a TinyFlux Database <https://github.com/citrusvanilla/tinyflux/blob/master/examples/2_analytics_workflow.ipynb>`_
 3. `TinyFlux as a MQTT Datastore for IoT Devices <https://github.com/citrusvanilla/tinyflux/blob/master/examples/3_iot_datastore_with_mqtt.py>`_
 
+Tips
+****
+
+Checkout some tips for working with TinyFlux `here <https://tinyflux.readthedocs.io/en/latest/tips.html>`_.
+
 
 TinyFlux Across the Internet
 ****************************
@@ -162,7 +178,7 @@ Contributing
 
 New ideas, new developer tools, improvements, and bugfixes are always welcome.  Follow these guidelines before getting started:
 
-1. Make sure to read `Getting Started <https://tinyflux.readthedocs.io/en/latest/getting-started.html>`_ and the `Contributing <https://tinyflux.readthedocs.io/en/latest/contributing-philosophy.html>`_ section of the documentation.
+1. Make sure to read `Getting Started <https://tinyflux.readthedocs.io/en/latest/getting-started.html>`_ and the `Contributing Tooling and Conventions <https://tinyflux.readthedocs.io/en/latest/contributing-tooling.html>`_ section of the documentation.
 2. Check GitHub for `existing open issues <https://github.com/citrusvanilla/tinyflux/issues>`_, `open a new issue <https://github.com/citrusvanilla/tinyflux/issues/new>`_ or `start a new discussion <https://github.com/citrusvanilla/tinyflux/discussions/new>`_.
 3. To get started on a pull request, fork the repository on GitHub, create a new branch, and make updates.
 4. Write unit tests, ensure the code is 100% covered, update documentation where necessary, and format and style the code correctly.

{tinyflux-0.2.6 → tinyflux-0.3.0}/README.rst

@@ -16,6 +16,17 @@ Quick Links
 - `Contributing`_
 
 
+Recent Updates
+**************
+
+v0.3.0 (2023-3-21)
+==================
+
+* Tag and field keys can be compacted when using CSVStorage, saving potentially many bytes per Point (resolves issue #32).
+* Fixed bug that causes tag values of '' to be serialized as "_none" (resolves issue #33).
+
+
+
 Installation
 ************
 
@@ -78,7 +89,7 @@ Writing to TinyFlux
     ...     tags={"room": "bedroom"},
     ...     fields={"temp": 72.0}
     ... )
-    >>> db.insert(p)
+    >>> db.insert(p, compact_key_prefixes=True)
 
 
 Querying TinyFlux
@@ -115,6 +126,11 @@ The `examples <https://github.com/citrusvanilla/tinyflux/tree/master/examples>`_
 2. `Local Analytics Workflow with a TinyFlux Database <https://github.com/citrusvanilla/tinyflux/blob/master/examples/2_analytics_workflow.ipynb>`_
 3. `TinyFlux as a MQTT Datastore for IoT Devices <https://github.com/citrusvanilla/tinyflux/blob/master/examples/3_iot_datastore_with_mqtt.py>`_
 
+Tips
+****
+
+Checkout some tips for working with TinyFlux `here <https://tinyflux.readthedocs.io/en/latest/tips.html>`_.
+
 
 TinyFlux Across the Internet
 ****************************
@@ -130,7 +146,7 @@ Contributing
 
 New ideas, new developer tools, improvements, and bugfixes are always welcome.  Follow these guidelines before getting started:
 
-1. Make sure to read `Getting Started <https://tinyflux.readthedocs.io/en/latest/getting-started.html>`_ and the `Contributing <https://tinyflux.readthedocs.io/en/latest/contributing-philosophy.html>`_ section of the documentation.
+1. Make sure to read `Getting Started <https://tinyflux.readthedocs.io/en/latest/getting-started.html>`_ and the `Contributing Tooling and Conventions <https://tinyflux.readthedocs.io/en/latest/contributing-tooling.html>`_ section of the documentation.
 2. Check GitHub for `existing open issues <https://github.com/citrusvanilla/tinyflux/issues>`_, `open a new issue <https://github.com/citrusvanilla/tinyflux/issues/new>`_ or `start a new discussion <https://github.com/citrusvanilla/tinyflux/discussions/new>`_.
 3. To get started on a pull request, fork the repository on GitHub, create a new branch, and make updates.
 4. Write unit tests, ensure the code is 100% covered, update documentation where necessary, and format and style the code correctly.

{tinyflux-0.2.6 → tinyflux-0.3.0}/pyproject.toml

@@ -1,5 +1,5 @@
 [tool.black]
-line-length = 79
+line-length = 80
 exclude = '(docs|\.ipynb$)'
 
 [build-system]

{tinyflux-0.2.6 → tinyflux-0.3.0}/setup.cfg

@@ -1,5 +1,5 @@
 [flake8]
-max-line-length = 79
+max-line-length = 80
 exclude = 
 	.git,
 	__pycache__,

{tinyflux-0.2.6 → tinyflux-0.3.0}/tests/test_point.py

@@ -180,6 +180,12 @@ def test_tags():
         {
             "key1": "value1",
         },
+        {
+            "key1": "",
+        },
+        {
+            "key1": None,
+        },
         {"key2": "value2", "key3": "value3"},
     ]
 
@@ -414,3 +420,73 @@ def test_serialize_zero_values():
         and new_p.fields["b"] == 0.0
         and new_p.fields["c"] is None
     )
+
+
+def test_serialize_none_values():
+    """Test serializing/deserializing None values."""
+    p = Point(fields={"a": None}, tags={"a": None})
+    s = p._serialize_to_list()
+    assert s[3] == p._none_str and s[5] == p._none_str
+
+    new_p = Point()._deserialize_from_list(s)
+
+    assert p == new_p
+
+    assert new_p.fields["a"] is None and new_p.tags["a"] is None
+
+
+def test_serialize_empty_strings():
+    """Test serializing/deserializing empty string tag values."""
+    p = Point(tags={"a": ""})
+    s = p._serialize_to_list()
+    assert s[3] == ""
+
+    new_p = Point()._deserialize_from_list(s)
+
+    assert p == new_p
+
+    assert new_p.tags["a"] == ""
+
+
+def test_compact_tag_keys():
+    """Test compact tag keys in CSV Storage."""
+    p = Point(fields={"a": 0, "b": 0.0, "c": None})
+    s = p._serialize_to_list(compact_key_prefixes=True)
+    s1 = p._serialize_to_list(compact_key_prefixes=False)
+
+    assert all(s[i].startswith(p._compact_field_key_prefix) for i in (2, 4, 6))
+
+    new_p = Point()._deserialize_from_list(s)
+    new_p1 = Point()._deserialize_from_list(s1)
+
+    assert p == new_p == new_p1
+
+    assert all(i in new_p.fields for i in ("a", "b", "c"))
+
+    assert (
+        new_p.fields["a"] == 0
+        and new_p.fields["b"] == 0.0
+        and new_p.fields["c"] is None
+    )
+
+
+def test_compact_field_keys():
+    """Test compact tag keys in CSV Storage."""
+    p = Point(tags={"a": "aa", "b": "bb", "c": None})
+    s = p._serialize_to_list(compact_key_prefixes=True)
+    s1 = p._serialize_to_list(compact_key_prefixes=False)
+
+    assert all(s[i].startswith(p._compact_tag_key_prefix) for i in (2, 4, 6))
+
+    new_p = Point()._deserialize_from_list(s)
+    new_p1 = Point()._deserialize_from_list(s1)
+
+    assert p == new_p == new_p1
+
+    assert all(i in new_p.tags for i in ("a", "b", "c"))
+
+    assert (
+        new_p.tags["a"] == "aa"
+        and new_p.tags["b"] == "bb"
+        and new_p.tags["c"] is None
+    )

{tinyflux-0.2.6 → tinyflux-0.3.0}/tests/test_queries.py

@@ -59,19 +59,11 @@ def test_repr():
     c5 = q2 | q4
     c6 = ~q3
 
-    rc1 = (
-        f"CompoundQuery({c1.operator.__name__}, 'SimpleQuery', 'SimpleQuery')"
-    )
-    rc2 = (
-        f"CompoundQuery({c2.operator.__name__}, 'SimpleQuery', 'SimpleQuery')"
-    )
+    rc1 = f"CompoundQuery({c1.operator.__name__}, 'SimpleQuery', 'SimpleQuery')"
+    rc2 = f"CompoundQuery({c2.operator.__name__}, 'SimpleQuery', 'SimpleQuery')"
     rc3 = f"CompoundQuery({c3.operator.__name__}, 'SimpleQuery')"
-    rc4 = (
-        f"CompoundQuery({c4.operator.__name__}, 'SimpleQuery', 'SimpleQuery')"
-    )
-    rc5 = (
-        f"CompoundQuery({c5.operator.__name__}, 'SimpleQuery', 'SimpleQuery')"
-    )
+    rc4 = f"CompoundQuery({c4.operator.__name__}, 'SimpleQuery', 'SimpleQuery')"
+    rc5 = f"CompoundQuery({c5.operator.__name__}, 'SimpleQuery', 'SimpleQuery')"
     rc6 = "CompoundQuery(not_, 'SimpleQuery')"
 
     assert repr(c1) == rc1
@@ -854,9 +846,7 @@ def test_basequery():
     ):
         q & (TagQuery().a == "b")
 
-    with pytest.raises(
-        RuntimeError, match="Cannot logical-OR an empty query."
-    ):
+    with pytest.raises(RuntimeError, match="Cannot logical-OR an empty query."):
         q | (TagQuery().a == "b")
 
     with pytest.raises(

{tinyflux-0.2.6 → tinyflux-0.3.0}/tests/test_storages.py

@@ -5,6 +5,7 @@ import os
 import random
 import re
 import tempfile
+from typing import Any
 
 import pytest
 
@@ -238,7 +239,9 @@ def test_subclassing_storage():
             """Deserialize storage."""
             ...
 
-        def _serialize_point(self, Point) -> None:
+        def _serialize_point(
+            self, point: Point, *args: Any, **kwargs: Any
+        ) -> None:
             """Serialize Point."""
             ...
 
@@ -639,3 +642,26 @@ def test_temporary_storage(tmpdir):
     # Exception should be thrown if temp storage not initialized.
     with pytest.raises(IOError):
         storage.append([], temporary=True)
+
+
+def test_compact_key_prefixes(tmpdir):
+    """Test compact keys option."""
+    # Memory.
+    m = MemoryStorage()
+    p = Point(tags={"a": "aa"}, fields={"a": 1})
+    assert (
+        m._serialize_point(p, compact_key_prefixes=True)
+        == m._serialize_point(p, compact_key_prefixes=False)
+        == m._serialize_point(p)
+        == p
+    )
+
+    # CSV.
+    path = os.path.join(tmpdir, "test.csv")
+    m = CSVStorage(path)
+    assert m._serialize_point(
+        p, compact_key_prefixes=True
+    ) == p._serialize_to_list(compact_key_prefixes=True)
+    assert m._serialize_point(
+        p, compact_key_prefixes=False
+    ) == p._serialize_to_list(compact_key_prefixes=False)

{tinyflux-0.2.6 → tinyflux-0.3.0}/tests/test_tinyflux.py

@@ -897,9 +897,9 @@ def test_update():
     db = TinyFlux(storage=MemoryStorage, auto_index=False)
 
     # Insert some points.
-    t1, t2 = datetime.now(timezone.utc), datetime.now(
-        timezone.utc
-    ) + timedelta(days=1)
+    t1, t2 = datetime.now(timezone.utc), datetime.now(timezone.utc) + timedelta(
+        days=1
+    )
 
     p1 = Point(
         time=t1,
@@ -1027,13 +1027,9 @@ def test_update():
     with pytest.raises(
         ValueError, match="Measurement must update to a string."
     ):
-        db.update(
-            FieldQuery().fk2 == 2, measurement=lambda _: {"golden bears"}
-        )
+        db.update(FieldQuery().fk2 == 2, measurement=lambda _: {"golden bears"})
 
-    with pytest.raises(
-        ValueError, match="Tags must update to a valid TagSet."
-    ):
+    with pytest.raises(ValueError, match="Tags must update to a valid TagSet."):
         db.update(FieldQuery().fk2 == 2, tags=lambda _: {"golden bears"})
 
     with pytest.raises(
@@ -1174,3 +1170,61 @@ def test_open_unindexed_storage_with_autoindex_OFF(tmpdir):
     db.all()
     assert not db._index.valid
     assert db.index.empty
+
+
+def test_insert_compact_keys(tmpdir):
+    """Test insert method."""
+    # Memory storage.
+    db = TinyFlux(storage=MemoryStorage)
+    p = Point(tags={"a": "aa"}, fields={"a": 1})
+    p1 = Point(tags={"a": "aa"}, fields={"a": 1})
+    p2 = Point(tags={"a": "aa"}, fields={"a": 1})
+
+    # Insert into empty db.
+    assert db.insert(p, compact_key_prefixes=True) == 1
+    assert db.index.valid and not db.index.empty
+    assert len(db.index) == 1
+    assert len(db) == 1
+
+    assert db.all()[0] == p
+
+    assert db.insert_multiple([p1, p2], compact_key_prefixes=True) == 2
+    assert db.index.valid and not db.index.empty
+    assert len(db.index) == 3
+    assert len(db) == 3
+
+    assert db.all() == [p, p1, p2]
+
+    # CSVStorage
+    path = os.path.join(tmpdir, "test.csv")
+
+    db = TinyFlux(path)
+    assert db.index.valid
+    assert db.index.empty
+
+    assert db.insert(p, compact_key_prefixes=True) == 1
+    assert db.index.valid and not db.index.empty
+    assert len(db.index) == 1
+    assert len(db) == 1
+
+    f = open(path, "r+")
+    rows = list(csv.reader(f))
+
+    assert rows[0][2].startswith(p._compact_tag_key_prefix)
+    assert rows[0][4].startswith(p._compact_field_key_prefix)
+
+    assert db.all()[0] == p
+
+    assert db.insert_multiple([p1, p2], compact_key_prefixes=True) == 2
+    assert db.index.valid and not db.index.empty
+    assert len(db.index) == 3
+    assert len(db) == 3
+
+    f = open(path, "r+")
+    rows = list(csv.reader(f))
+
+    for row in rows:
+        assert row[2].startswith(p._compact_tag_key_prefix)
+        assert row[4].startswith(p._compact_field_key_prefix)
+
+    assert db.all() == [p, p1, p2]

{tinyflux-0.2.6 → tinyflux-0.3.0}/tinyflux/database.py

@@ -153,9 +153,7 @@ class TinyFlux:
     _measurements: Dict[str, Measurement]
     _open: bool
 
-    def __init__(
-        self: Any, *args: Any, auto_index: bool = True, **kwargs: Any
-    ):
+    def __init__(self: Any, *args: Any, auto_index: bool = True, **kwargs: Any):
         """Initialize a new instance of TinyFlux.
 
         If 'auto_index' is set to True, an index will be built in-memory for
@@ -281,9 +279,7 @@ class TinyFlux:
         return
 
     @read_op
-    def contains(
-        self, query: Query, measurement: Optional[str] = None
-    ) -> bool:
+    def contains(self, query: Query, measurement: Optional[str] = None) -> bool:
         """Check whether the database contains a point matching a query.
 
         Defines a function that iterates over storage items and submits it to
@@ -674,12 +670,18 @@ class TinyFlux:
         return rst
 
     @append_op
-    def insert(self, point: Point, measurement: Optional[str] = None) -> int:
+    def insert(
+        self,
+        point: Point,
+        measurement: Optional[str] = None,
+        compact_key_prefixes: bool = False,
+    ) -> int:
         """Insert a Point into the database.
 
         Args:
             point: A Point object.
             measurement: An optional measurement to filter by.
+            compact_key_prefixes: Use compact key prefixes in relevant storages.
 
         Returns:
             1 if success.
@@ -688,17 +690,21 @@ class TinyFlux:
             OSError if storage cannot be appendex to.
             TypeError if point is not a Point instance.
         """
-        return self._insert_helper([point], measurement)
+        return self._insert_helper([point], measurement, compact_key_prefixes)
 
     @append_op
     def insert_multiple(
-        self, points: Iterable[Any], measurement: Optional[str] = None
+        self,
+        points: Iterable[Any],
+        measurement: Optional[str] = None,
+        compact_key_prefixes: bool = False,
     ) -> int:
         """Insert Points into the database.
 
         Args:
             points: An iterable of Point objects.
             measurement: An optional measurement to insert Points into.
+            compact_key_prefixes: Use compact key prefixes in relevant storages.
 
         Returns:
             The count of inserted points.
@@ -707,7 +713,7 @@ class TinyFlux:
             OSError if storage cannot be appendex to.
             TypeError if point is not a Point instance.
         """
-        return self._insert_helper(points, measurement)
+        return self._insert_helper(points, measurement, compact_key_prefixes)
 
     def measurement(self, name: str, **kwargs: Any) -> Measurement:
         """Return a reference to a measurement in this database.
@@ -905,9 +911,7 @@ class TinyFlux:
             raise ValueError("'keys' must be a string or iterable of strings.")
 
         keys: List[Any] = (
-            [select_keys]
-            if isinstance(select_keys, str)
-            else list(select_keys)
+            [select_keys] if isinstance(select_keys, str) else list(select_keys)
         )
 
         # Validate bad keys.
@@ -1067,9 +1071,7 @@ class TinyFlux:
             datetime, Callable[[Optional[datetime]], datetime], None
         ] = None,
         measurement: Union[str, Callable[[Optional[str]], str], None] = None,
-        tags: Union[
-            TagSet, Callable[[Mapping[Any, Any]], TagSet], None
-        ] = None,
+        tags: Union[TagSet, Callable[[Mapping[Any, Any]], TagSet], None] = None,
         fields: Union[
             FieldSet, Callable[[Mapping[Any, Any]], FieldSet], None
         ] = None,
@@ -1172,9 +1174,7 @@ class TinyFlux:
                     try:
                         point.measurement = measurement(point.measurement)
                     except ValueError:
-                        raise ValueError(
-                            "Measurement must update to a string."
-                        )
+                        raise ValueError("Measurement must update to a string.")
                 else:
                     point.measurement = measurement
 
@@ -1204,13 +1204,17 @@ class TinyFlux:
         return perform_update
 
     def _insert_helper(
-        self, points: Iterable[Any], measurement: Optional[str]
+        self,
+        points: Iterable[Any],
+        measurement: Optional[str],
+        compact_key_prefixes: bool = False,
     ) -> int:
         """Insert point helper.
 
         Args:
             updater: Update function.
             measurement: Optional measurement to insert into.
+            compact_key_prefixes: Use compact key prefixes in relevant storages.
 
         Returns:
             Count of number of updates made.
@@ -1233,7 +1237,13 @@ class TinyFlux:
                 point.time = t
 
             # Insert the points into storage.
-            self._storage.append([self._storage._serialize_point(point)])
+            self._storage.append(
+                [
+                    self._storage._serialize_point(
+                        point, compact_key_prefixes=compact_key_prefixes
+                    )
+                ]
+            )
 
             # Check index.
             if self._auto_index and self._index.valid:

{tinyflux-0.2.6 → tinyflux-0.3.0}/tinyflux/point.py

@@ -47,7 +47,7 @@ def validate_tags(tags: Any) -> None:
 
     # Check values.
     if not all(i is None or isinstance(i, str) for i in tags.values()):
-        raise ValueError("Tag set must contain only string values.")
+        raise ValueError("Tag set must contain only string values or None.")
 
     return
 
@@ -74,7 +74,9 @@ def validate_fields(fields: Any) -> None:
             continue
 
         if isinstance(i, bool) or not isinstance(i, (int, float)):
-            raise ValueError("Field set must contain only numeric values.")
+            raise ValueError(
+                "Field set must contain only numeric values or None."
+            )
 
     return
 
@@ -99,6 +101,11 @@ class Point:
     _valid_kwargs = set(["time", "measurement", "tags", "fields"])
     __slots__ = ("_time", "_measurement", "_tags", "_fields")
 
+    _default_tag_key_prefix = "_tag_"
+    _default_field_key_prefix = "_field_"
+    _compact_tag_key_prefix = "t_"
+    _compact_field_key_prefix = "f_"
+
     _time: Optional[datetime]
     _measurement: str
     _tags: TagSet
@@ -205,18 +212,14 @@ class Point:
         repr_str = "Point("
 
         # Add time.
-        repr_str += (
-            f"time={self._time.isoformat() if self._time else 'None'}, "
-        )
+        repr_str += f"time={self._time.isoformat() if self._time else 'None'}, "
 
         # Add measurement.
         repr_str += f"measurement={self._measurement}"
 
         # Add tags.
         if self._tags:
-            tags_str = "; ".join(
-                f"{k}:{str(v)}" for k, v in self._tags.items()
-            )
+            tags_str = "; ".join(f"{k}:{str(v)}" for k, v in self._tags.items())
             repr_str += f", tags={tags_str}"
 
         # Add fields.
@@ -239,10 +242,6 @@ class Point:
 
         Returns:
             A Point object.
-
-        Raises:
-            ValueError: Deserializing encounters a bad type.
-            RuntimeError: Deserializing encounters an unexpected column.
         """
         p_time = datetime.fromisoformat(row[0]).replace(tzinfo=timezone.utc)
         p_measurement = row[1]
@@ -254,14 +253,31 @@ class Point:
         i = 2
 
         # Check for tag key/values.
-        while i < row_len and row[i][1] == "t":
-            t_key, t_value = row[i][5:], row[i + 1]
+        while i < row_len:
+            # Default tag key prefix is "_tag_" (most-used case).
+            if row[i][1] == "t":
+                t_key = row[i][len(self._default_tag_key_prefix) :]
+            # Compact tag key prefix is "t_".
+            elif row[i][0] == "t":
+                t_key = row[i][len(self._compact_tag_key_prefix) :]
+            # Otherwise, its a field -> continue.
+            else:
+                break
+
+            t_value = None if row[i + 1] == self._none_str else str(row[i + 1])
             p_tags[t_key] = t_value
             i += 2
 
         # Check for field key/values.
         while i < row_len:
-            f_key, f_value = row[i][7:], row[i + 1]
+            # Default field key prefix is "_field_" (most-used case).
+            if row[i][1] == "f":
+                f_key = row[i][len(self._default_field_key_prefix) :]
+            # Compact field key prefix is "f_".
+            else:
+                f_key = row[i][len(self._compact_field_key_prefix) :]
+
+            f_value = row[i + 1]
 
             # Value is an integer.
             if f_value.isdigit() or (
@@ -288,27 +304,55 @@ class Point:
 
         return self
 
-    def _serialize_to_list(self) -> Sequence[str]:
+    def _serialize_to_list(
+        self, compact_key_prefixes: bool = False
+    ) -> Sequence[str]:
         """Serialize a Point to a tuple of strings.
 
+        Args:
+            compact_key_prefixes: Use compact key prefixes.
+
         Returns:
             A well-formed tuple of strings, representing a Point.
 
         Usage:
             >>> sp = Point()._serialize_to_list()
         """
+        # Time.
         t = (
             self._time.replace(tzinfo=None).isoformat()
             if self._time
             else self._none_str
         )
+
+        # Measurement.
         m = str(self._measurement or self._none_str)
+
+        # Tags.
+        tag_key_prefix = (
+            self._compact_tag_key_prefix
+            if compact_key_prefixes
+            else self._default_tag_key_prefix
+        )
         tags = (
-            (f"_tag_{k}", str(v) or self._none_str)
+            (
+                f"{tag_key_prefix}{k}",
+                self._none_str if v is None else str(v),
+            )
             for k, v in self._tags.items()
         )
+
+        # Fields.
+        field_key_prefix = (
+            self._compact_field_key_prefix
+            if compact_key_prefixes
+            else self._default_field_key_prefix
+        )
         fields = (
-            (f"_field_{k}", self._none_str if v is None else str(float(v)))
+            (
+                f"{field_key_prefix}{k}",
+                self._none_str if v is None else str(float(v)),
+            )
             for k, v in self._fields.items()
         )
 

{tinyflux-0.2.6 → tinyflux-0.3.0}/tinyflux/queries.py

@@ -453,9 +453,7 @@ class BaseQuery:
             and rhs
             and not isinstance(rhs, str)
         ):
-            raise TypeError(
-                "MeasurementQuery comparison value must be string."
-            )
+            raise TypeError("MeasurementQuery comparison value must be string.")
 
         # Validation for tags.
         if self._point_attr == "_tags" and rhs and not isinstance(rhs, str):

{tinyflux-0.2.6 → tinyflux-0.3.0}/tinyflux/storages.py

@@ -144,7 +144,7 @@ class Storage(ABC):  # pragma: no cover
         ...
 
     @abstractmethod
-    def _serialize_point(self, point: Point) -> Any:
+    def _serialize_point(self, point: Point, *args: Any, **kwargs: Any) -> Any:
         """Serialize a point to an item for storage."""
         ...
 
@@ -372,10 +372,12 @@ class CSVStorage(Storage):
         return
 
     def _serialize_point(
-        self, point: Point
+        self, point: Point, *args: Any, **kwargs: Any
     ) -> Sequence[Union[str, float, int]]:
         """Serialize a point to an item for storage."""
-        return point._serialize_to_list()
+        return point._serialize_to_list(
+            compact_key_prefixes=kwargs.pop("compact_key_prefixes", False)
+        )
 
     def _swap_temp_with_primary(self) -> None:
         """Swap primary data store with temporary data store."""
@@ -525,7 +527,9 @@ class MemoryStorage(Storage):
         """Initialize temporary storage."""
         self._temp_memory = []
 
-    def _serialize_point(self, point: Point) -> MemStorageItem:
+    def _serialize_point(
+        self, point: Point, *args: Any, **kwargs: Any
+    ) -> MemStorageItem:
         """Serialize a point to an item for storage."""
         return point
 

{tinyflux-0.2.6 → tinyflux-0.3.0/tinyflux.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tinyflux
-Version: 0.2.6
+Version: 0.3.0
 Summary: The Tiny Time-Series Database Optimized for Your Happiness
 Home-page: https://github.com/citrusvanilla/tinyflux
 Author: Justin Fung
@@ -48,6 +48,17 @@ Quick Links
 - `Contributing`_
 
 
+Recent Updates
+**************
+
+v0.3.0 (2023-3-21)
+==================
+
+* Tag and field keys can be compacted when using CSVStorage, saving potentially many bytes per Point (resolves issue #32).
+* Fixed bug that causes tag values of '' to be serialized as "_none" (resolves issue #33).
+
+
+
 Installation
 ************
 
@@ -110,7 +121,7 @@ Writing to TinyFlux
     ...     tags={"room": "bedroom"},
     ...     fields={"temp": 72.0}
     ... )
-    >>> db.insert(p)
+    >>> db.insert(p, compact_key_prefixes=True)
 
 
 Querying TinyFlux
@@ -147,6 +158,11 @@ The `examples <https://github.com/citrusvanilla/tinyflux/tree/master/examples>`_
 2. `Local Analytics Workflow with a TinyFlux Database <https://github.com/citrusvanilla/tinyflux/blob/master/examples/2_analytics_workflow.ipynb>`_
 3. `TinyFlux as a MQTT Datastore for IoT Devices <https://github.com/citrusvanilla/tinyflux/blob/master/examples/3_iot_datastore_with_mqtt.py>`_
 
+Tips
+****
+
+Checkout some tips for working with TinyFlux `here <https://tinyflux.readthedocs.io/en/latest/tips.html>`_.
+
 
 TinyFlux Across the Internet
 ****************************
@@ -162,7 +178,7 @@ Contributing
 
 New ideas, new developer tools, improvements, and bugfixes are always welcome.  Follow these guidelines before getting started:
 
-1. Make sure to read `Getting Started <https://tinyflux.readthedocs.io/en/latest/getting-started.html>`_ and the `Contributing <https://tinyflux.readthedocs.io/en/latest/contributing-philosophy.html>`_ section of the documentation.
+1. Make sure to read `Getting Started <https://tinyflux.readthedocs.io/en/latest/getting-started.html>`_ and the `Contributing Tooling and Conventions <https://tinyflux.readthedocs.io/en/latest/contributing-tooling.html>`_ section of the documentation.
 2. Check GitHub for `existing open issues <https://github.com/citrusvanilla/tinyflux/issues>`_, `open a new issue <https://github.com/citrusvanilla/tinyflux/issues/new>`_ or `start a new discussion <https://github.com/citrusvanilla/tinyflux/discussions/new>`_.
 3. To get started on a pull request, fork the repository on GitHub, create a new branch, and make updates.
 4. Write unit tests, ensure the code is 100% covered, update documentation where necessary, and format and style the code correctly.

tinyflux-0.3.0/version.txt

@@ -0,0 +1 @@
+v0.3.0

tinyflux-0.2.6/version.txt

@@ -1 +0,0 @@
-v0.2.6