1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
|
from enum import Enum, auto
import pytest
from psycopg import errors as e
from psycopg import pq, sql
from psycopg.adapt import PyFormat
from psycopg.types import TypeInfo
from psycopg.types.enum import EnumInfo, register_enum
from ..fix_crdb import crdb_encoding
class PureTestEnum(Enum):
FOO = auto()
BAR = auto()
BAZ = auto()
class StrTestEnum(str, Enum):
ONE = "ONE"
TWO = "TWO"
THREE = "THREE"
NonAsciiEnum = Enum(
"NonAsciiEnum",
{"X\xe0": "x\xe0", "X\xe1": "x\xe1", "COMMA": "foo,bar"},
type=str,
)
class IntTestEnum(int, Enum):
ONE = 1
TWO = 2
THREE = 3
enum_cases = [PureTestEnum, StrTestEnum, IntTestEnum]
encodings = ["utf8", crdb_encoding("latin1")]
@pytest.fixture(scope="session", autouse=True)
def make_test_enums(request, svcconn):
for enum in enum_cases + [NonAsciiEnum]:
ensure_enum(enum, svcconn)
def ensure_enum(enum, conn):
name = enum.__name__.lower()
labels = list(enum.__members__)
conn.execute(
sql.SQL(
"""
drop type if exists {name};
create type {name} as enum ({labels});
"""
).format(name=sql.Identifier(name), labels=sql.SQL(",").join(labels))
)
return name, enum, labels
def test_fetch_info(conn):
info = EnumInfo.fetch(conn, "StrTestEnum")
assert info.name == "strtestenum"
assert info.oid > 0
assert info.oid != info.array_oid > 0
assert len(info.labels) == len(StrTestEnum)
assert info.labels == list(StrTestEnum.__members__)
async def test_fetch_info_async(aconn):
info = await EnumInfo.fetch(aconn, "PureTestEnum")
assert info.name == "puretestenum"
assert info.oid > 0
assert info.oid != info.array_oid > 0
assert len(info.labels) == len(PureTestEnum)
assert info.labels == list(PureTestEnum.__members__)
def test_register_makes_a_type(conn):
info = EnumInfo.fetch(conn, "IntTestEnum")
assert info
assert info.enum is None
register_enum(info, context=conn)
assert info.enum is not None
assert [e.name for e in info.enum] == list(IntTestEnum.__members__)
@pytest.mark.parametrize("enum", enum_cases)
@pytest.mark.parametrize("fmt_in", PyFormat)
@pytest.mark.parametrize("fmt_out", pq.Format)
def test_enum_loader(conn, enum, fmt_in, fmt_out):
info = EnumInfo.fetch(conn, enum.__name__)
register_enum(info, conn, enum=enum)
for label in info.labels:
cur = conn.execute(
f"select %{fmt_in.value}::{enum.__name__}", [label], binary=fmt_out
)
assert cur.fetchone()[0] == enum[label]
@pytest.mark.parametrize("encoding", encodings)
@pytest.mark.parametrize("fmt_in", PyFormat)
@pytest.mark.parametrize("fmt_out", pq.Format)
def test_enum_loader_nonascii(conn, encoding, fmt_in, fmt_out):
enum = NonAsciiEnum
conn.execute(f"set client_encoding to {encoding}")
info = EnumInfo.fetch(conn, enum.__name__)
register_enum(info, conn, enum=enum)
for label in info.labels:
cur = conn.execute(
f"select %{fmt_in.value}::{info.name}", [label], binary=fmt_out
)
assert cur.fetchone()[0] == enum[label]
@pytest.mark.crdb_skip("encoding")
@pytest.mark.parametrize("enum", enum_cases)
@pytest.mark.parametrize("fmt_in", PyFormat)
@pytest.mark.parametrize("fmt_out", pq.Format)
def test_enum_loader_sqlascii(conn, enum, fmt_in, fmt_out):
info = EnumInfo.fetch(conn, enum.__name__)
register_enum(info, conn, enum)
conn.execute("set client_encoding to sql_ascii")
for label in info.labels:
cur = conn.execute(
f"select %{fmt_in.value}::{info.name}", [label], binary=fmt_out
)
assert cur.fetchone()[0] == enum[label]
@pytest.mark.parametrize("enum", enum_cases)
@pytest.mark.parametrize("fmt_in", PyFormat)
@pytest.mark.parametrize("fmt_out", pq.Format)
def test_enum_dumper(conn, enum, fmt_in, fmt_out):
info = EnumInfo.fetch(conn, enum.__name__)
register_enum(info, conn, enum)
for item in enum:
cur = conn.execute(f"select %{fmt_in.value}", [item], binary=fmt_out)
assert cur.fetchone()[0] == item
@pytest.mark.parametrize("encoding", encodings)
@pytest.mark.parametrize("fmt_in", PyFormat)
@pytest.mark.parametrize("fmt_out", pq.Format)
def test_enum_dumper_nonascii(conn, encoding, fmt_in, fmt_out):
enum = NonAsciiEnum
conn.execute(f"set client_encoding to {encoding}")
info = EnumInfo.fetch(conn, enum.__name__)
register_enum(info, conn, enum)
for item in enum:
cur = conn.execute(f"select %{fmt_in.value}", [item], binary=fmt_out)
assert cur.fetchone()[0] == item
@pytest.mark.crdb_skip("encoding")
@pytest.mark.parametrize("enum", enum_cases)
@pytest.mark.parametrize("fmt_in", PyFormat)
@pytest.mark.parametrize("fmt_out", pq.Format)
def test_enum_dumper_sqlascii(conn, enum, fmt_in, fmt_out):
info = EnumInfo.fetch(conn, enum.__name__)
register_enum(info, conn, enum)
conn.execute("set client_encoding to sql_ascii")
for item in enum:
cur = conn.execute(f"select %{fmt_in.value}", [item], binary=fmt_out)
assert cur.fetchone()[0] == item
@pytest.mark.parametrize("enum", enum_cases)
@pytest.mark.parametrize("fmt_in", PyFormat)
@pytest.mark.parametrize("fmt_out", pq.Format)
def test_generic_enum_dumper(conn, enum, fmt_in, fmt_out):
for item in enum:
if enum is PureTestEnum:
want = item.name
else:
want = item.value
cur = conn.execute(f"select %{fmt_in.value}", [item], binary=fmt_out)
assert cur.fetchone()[0] == want
@pytest.mark.parametrize("encoding", encodings)
@pytest.mark.parametrize("fmt_in", PyFormat)
@pytest.mark.parametrize("fmt_out", pq.Format)
def test_generic_enum_dumper_nonascii(conn, encoding, fmt_in, fmt_out):
conn.execute(f"set client_encoding to {encoding}")
for item in NonAsciiEnum:
cur = conn.execute(f"select %{fmt_in.value}", [item.value], binary=fmt_out)
assert cur.fetchone()[0] == item.value
@pytest.mark.parametrize("enum", enum_cases)
@pytest.mark.parametrize("fmt_in", PyFormat)
@pytest.mark.parametrize("fmt_out", pq.Format)
def test_generic_enum_loader(conn, enum, fmt_in, fmt_out):
for label in enum.__members__:
cur = conn.execute(
f"select %{fmt_in.value}::{enum.__name__}", [label], binary=fmt_out
)
want = enum[label].name
if fmt_out == pq.Format.BINARY:
want = want.encode()
assert cur.fetchone()[0] == want
@pytest.mark.parametrize("encoding", encodings)
@pytest.mark.parametrize("fmt_in", PyFormat)
@pytest.mark.parametrize("fmt_out", pq.Format)
def test_generic_enum_loader_nonascii(conn, encoding, fmt_in, fmt_out):
conn.execute(f"set client_encoding to {encoding}")
for label in NonAsciiEnum.__members__:
cur = conn.execute(
f"select %{fmt_in.value}::nonasciienum", [label], binary=fmt_out
)
if fmt_out == pq.Format.TEXT:
assert cur.fetchone()[0] == label
else:
assert cur.fetchone()[0] == label.encode(encoding)
@pytest.mark.parametrize("fmt_in", PyFormat)
@pytest.mark.parametrize("fmt_out", pq.Format)
def test_enum_array_loader(conn, fmt_in, fmt_out):
enum = PureTestEnum
info = EnumInfo.fetch(conn, enum.__name__)
register_enum(info, conn, enum)
labels = list(enum.__members__)
cur = conn.execute(
f"select %{fmt_in.value}::{info.name}[]", [labels], binary=fmt_out
)
assert cur.fetchone()[0] == list(enum)
@pytest.mark.parametrize("fmt_in", PyFormat)
@pytest.mark.parametrize("fmt_out", pq.Format)
def test_enum_array_dumper(conn, fmt_in, fmt_out):
enum = StrTestEnum
info = EnumInfo.fetch(conn, enum.__name__)
register_enum(info, conn, enum)
cur = conn.execute(f"select %{fmt_in.value}::text[]", [list(enum)], binary=fmt_out)
assert cur.fetchone()[0] == list(enum.__members__)
@pytest.mark.parametrize("fmt_in", PyFormat)
@pytest.mark.parametrize("fmt_out", pq.Format)
def test_generic_enum_array_loader(conn, fmt_in, fmt_out):
enum = IntTestEnum
info = TypeInfo.fetch(conn, enum.__name__)
info.register(conn)
labels = list(enum.__members__)
cur = conn.execute(
f"select %{fmt_in.value}::{info.name}[]", [labels], binary=fmt_out
)
if fmt_out == pq.Format.TEXT:
assert cur.fetchone()[0] == labels
else:
assert cur.fetchone()[0] == [item.encode() for item in labels]
def test_enum_error(conn):
conn.autocommit = True
info = EnumInfo.fetch(conn, "puretestenum")
register_enum(info, conn, StrTestEnum)
with pytest.raises(e.DataError):
conn.execute("select %s::text", [StrTestEnum.ONE]).fetchone()
with pytest.raises(e.DataError):
conn.execute("select 'BAR'::puretestenum").fetchone()
@pytest.mark.parametrize("fmt_in", PyFormat)
@pytest.mark.parametrize("fmt_out", pq.Format)
@pytest.mark.parametrize(
"mapping",
[
{StrTestEnum.ONE: "FOO", StrTestEnum.TWO: "BAR", StrTestEnum.THREE: "BAZ"},
[
(StrTestEnum.ONE, "FOO"),
(StrTestEnum.TWO, "BAR"),
(StrTestEnum.THREE, "BAZ"),
],
],
)
def test_remap(conn, fmt_in, fmt_out, mapping):
info = EnumInfo.fetch(conn, "puretestenum")
register_enum(info, conn, StrTestEnum, mapping=mapping)
for member, label in [("ONE", "FOO"), ("TWO", "BAR"), ("THREE", "BAZ")]:
cur = conn.execute(f"select %{fmt_in.value}::text", [StrTestEnum[member]])
assert cur.fetchone()[0] == label
cur = conn.execute(f"select '{label}'::puretestenum", binary=fmt_out)
assert cur.fetchone()[0] is StrTestEnum[member]
def test_remap_rename(conn):
RenamedEnum = Enum("RenamedEnum", "FOO BAR QUX")
enum = RenamedEnum
info = EnumInfo.fetch(conn, "puretestenum")
register_enum(info, conn, enum, mapping={enum.QUX: "BAZ"})
for member, label in [("FOO", "FOO"), ("BAR", "BAR"), ("QUX", "BAZ")]:
cur = conn.execute("select %s::text", [enum[member]])
assert cur.fetchone()[0] == label
cur = conn.execute(f"select '{label}'::puretestenum")
assert cur.fetchone()[0] is enum[member]
def test_remap_more_python(conn):
LargerEnum = Enum("LargerEnum", "FOO BAR BAZ QUX QUUX QUUUX")
enum = LargerEnum
info = EnumInfo.fetch(conn, "puretestenum")
mapping = {enum[m]: "BAZ" for m in ["QUX", "QUUX", "QUUUX"]}
register_enum(info, conn, enum, mapping=mapping)
for member, label in [("FOO", "FOO"), ("BAZ", "BAZ"), ("QUUUX", "BAZ")]:
cur = conn.execute("select %s::text", [enum[member]])
assert cur.fetchone()[0] == label
for member, label in [("FOO", "FOO"), ("QUUUX", "BAZ")]:
cur = conn.execute(f"select '{label}'::puretestenum")
assert cur.fetchone()[0] is enum[member]
def test_remap_more_postgres(conn):
SmallerEnum = Enum("SmallerEnum", "FOO")
enum = SmallerEnum
info = EnumInfo.fetch(conn, "puretestenum")
mapping = [(enum.FOO, "BAR"), (enum.FOO, "BAZ")]
register_enum(info, conn, enum, mapping=mapping)
cur = conn.execute("select %s::text", [enum.FOO])
assert cur.fetchone()[0] == "BAZ"
for label in PureTestEnum.__members__:
cur = conn.execute(f"select '{label}'::puretestenum")
assert cur.fetchone()[0] is enum.FOO
def test_remap_by_value(conn):
enum = Enum( # type: ignore
"ByValue",
{m.lower(): m for m in PureTestEnum.__members__},
)
info = EnumInfo.fetch(conn, "puretestenum")
register_enum(info, conn, enum, mapping={m: m.value for m in enum})
for label in PureTestEnum.__members__:
cur = conn.execute("select %s::text", [enum[label.lower()]])
assert cur.fetchone()[0] == label
cur = conn.execute(f"select '{label}'::puretestenum")
assert cur.fetchone()[0] is enum[label.lower()]
|