Drop the databases and users fields

We follow the names used by postgresql
(https://www.postgresql.org/docs/current/auth-pg-hba-conf.html).

Only the single variant is kept. It is the responsibility of the users of the
library to split the values if they want lists.

The serialized argument for `as_dict` is removed.

This is breaking change!

Author: pgiraud

pgtoolkit/hba.py

@@ -90,17 +90,13 @@ class HBARecord:
     """Holds a HBA record composed of fields and a comment.
 
     Common fields are accessible through attribute : ``conntype``,
-    ``databases``, ``users``, ``address``, ``netmask``, ``method``.
+    ``database``, ``user``, ``address``, ``netmask``, ``method``.
     Auth-options fields are also accessible through attribute like ``map``,
     ``ldapserver``, etc.
 
     ``address`` and ``netmask`` fields are not always defined. If not,
     accessing undefined attributes trigger an :exc:`AttributeError`.
 
-    ``databases`` and ``users`` have a single value variant respectively
-    :attr:`database` and :attr:`user`, computed after the list representation
-    of the field.
-
     .. automethod:: parse
     .. automethod:: __init__
     .. automethod:: __str__
@@ -112,8 +108,8 @@ class HBARecord:
 
     COMMON_FIELDS = [
         "conntype",
-        "databases",
-        "users",
+        "database",
+        "user",
         "address",
         "netmask",
         "method",
@@ -137,7 +133,7 @@ def parse(cls, line: str) -> HBARecord:
 
         """
         line = line.strip()
-        record_fields = ["conntype", "databases", "users"]
+        record_fields = ["conntype", "database", "user"]
 
         # What the regexp below does is finding all elements separated by spaces
         # unless they are enclosed in double-quotes
@@ -146,9 +142,7 @@ def parse(cls, line: str) -> HBARecord:
         #             double-quotes (alternative 1)
         # \S = any non-whitespace character (alternative 2)
         values = [p for p in re.findall(r"(?:\"+.*?\"+|\S)+", line) if p.strip()]
-        # Split databases and users lists.
-        values[1] = values[1].split(",")
-        values[2] = values[2].split(",")
+        assert len(values) > 2
         try:
             hash_pos = values.index("#")
         except ValueError:
@@ -173,8 +167,8 @@ def parse(cls, line: str) -> HBARecord:
         return cls(options, comment=comment)
 
     conntype: str | None
-    databases: list[str]
-    users: list[str]
+    database: str
+    user: str
 
     def __init__(
         self,
@@ -188,10 +182,6 @@ def __init__(
         :param comment:  Comment at the end of the line.
         """
         dict_values: dict[str, Any] = dict(values or {}, **kw_values)
-        if "database" in dict_values:
-            dict_values["databases"] = [dict_values.pop("database")]
-        if "user" in dict_values:
-            dict_values["users"] = [dict_values.pop("user")]
         self.__dict__.update(dict_values)
         self.fields = [k for k, _ in dict_values.items()]
         self.comment = comment
@@ -223,9 +213,7 @@ def __str__(self) -> str:
                 fmt += "%%(%s)-%ds " % (field, width - 1)
             else:
                 fmt += f"%({field})s "
-        # Serialize database and user list using property.
-        values = dict(self.__dict__, databases=self.database, users=self.user)
-        line = fmt.rstrip() % values
+        line = fmt.rstrip() % self.__dict__
 
         auth_options = ['%s="%s"' % i for i in self.auth_options]
         if auth_options:
@@ -241,17 +229,13 @@ def __str__(self) -> str:
     def __eq__(self, other: object) -> bool:
         return str(self) == str(other)
 
-    def as_dict(self, serialized: bool = False) -> dict[str, Any]:
+    def as_dict(self) -> dict[str, Any]:
         str_fields = self.COMMON_FIELDS[:]
-        if serialized:
-            str_fields[1:3] = ["database", "user"]
         return {f: getattr(self, f) for f in str_fields if hasattr(self, f)}
 
     @property
     def common_values(self) -> list[str]:
         str_fields = self.COMMON_FIELDS[:]
-        # Use serialized variant.
-        str_fields[1:3] = ["database", "user"]
         return [getattr(self, f) for f in str_fields if f in self.fields]
 
     @property
@@ -260,26 +244,6 @@ def auth_options(self) -> list[tuple[str, str]]:
             (f, getattr(self, f)) for f in self.fields if f not in self.COMMON_FIELDS
         ]
 
-    @property
-    def database(self) -> str:
-        """Hold database column as a single value.
-
-        Use `databases` attribute to get parsed database list. `database` is
-        guaranteed to be a string.
-
-        """
-        return ",".join(self.databases)
-
-    @property
-    def user(self) -> str:
-        """Hold user column as a single value.
-
-        Use ``users`` property to get parsed user list. ``user`` is guaranteed
-        to be a string.
-
-        """
-        return ",".join(self.users)
-
     def matches(self, **attrs: str) -> bool:
         """Tells if the current record is matching provided attributes.
 

tests/test_hba.py

@@ -40,9 +40,8 @@ def test_parse_host_line():
     assert "host" in repr(record)
     assert "host" == record.conntype
     assert "replication" == record.database
-    assert ["replication"] == record.databases
     assert "all" == record.user
-    assert ["all"] == record.users
+    assert "all" == record.user
     assert "::1/128" == record.address
     assert "trust" == record.method
 
@@ -57,7 +56,7 @@ def test_parse_local_line():
     record = HBARecord.parse("local    all     all     trust")
     assert "local" == record.conntype
     assert "all" == record.database
-    assert ["all"] == record.users
+    assert "all" == record.user
     assert "trust" == record.method
 
     with pytest.raises(AttributeError):
@@ -77,7 +76,7 @@ def test_parse_auth_option():
     )
     assert "local" == record.conntype
     assert "veryverylongdatabasenamethatdonotfit" == record.database
-    assert ["all"] == record.users
+    assert "all" == record.user
     assert "ident" == record.method
     assert "omicron" == record.map
 
@@ -97,7 +96,7 @@ def test_parse_record_with_comment():
     record = HBARecord.parse("local    all     all     trust  # My  comment")
     assert "local" == record.conntype
     assert "all" == record.database
-    assert ["all"] == record.users
+    assert "all" == record.user
     assert "trust" == record.method
     assert "My comment" == record.comment
 
@@ -172,7 +171,7 @@ def test_hba_create():
     assert 2 == len(hba.lines)
 
     r = hba.lines[1]
-    assert ["all"] == r.databases
+    assert "all" == r.database
 
     # Should be a list
     with pytest.raises(ValueError):
@@ -335,8 +334,8 @@ def r(hba):
     other_hba = HBA()
     record = HBARecord(
         conntype="host",
-        databases=["replication"],
-        users=["all"],
+        database="replication",
+        user="all",
         address="1.2.3.4",
         method="trust",
     )
@@ -355,12 +354,6 @@ def test_as_dict():
         method="trust",
     )
     assert r.as_dict() == {
-        "conntype": "local",
-        "databases": ["all"],
-        "users": ["all"],
-        "method": "trust",
-    }
-    assert r.as_dict(serialized=True) == {
         "conntype": "local",
         "database": "all",
         "user": "all",
@@ -369,21 +362,13 @@ def test_as_dict():
 
     r = HBARecord(
         conntype="local",
-        databases=["mydb", "mydb2"],
-        users=["bob", "alice"],
+        database="mydb,mydb2",
+        user="bob,alice",
         address="127.0.0.1",
         netmask="255.255.255.255",
         method="trust",
     )
     assert r.as_dict() == {
-        "address": "127.0.0.1",
-        "conntype": "local",
-        "databases": ["mydb", "mydb2"],
-        "users": ["bob", "alice"],
-        "method": "trust",
-        "netmask": "255.255.255.255",
-    }
-    assert r.as_dict(serialized=True) == {
         "address": "127.0.0.1",
         "conntype": "local",
         "database": "mydb,mydb2",
@@ -407,8 +392,8 @@ def test_hbarecord_equality():
 
     r = HBARecord(
         conntype="host",
-        databases=["all"],
-        users=["u0", "u1"],
+        database="all",
+        user="u0,u1",
         address="127.0.0.1/32",
         method="trust",
     )