Inline text factory example

python · erlend-aasland · Aug 31, 2022 · Aug 30, 2022 · Aug 30, 2022 · Aug 30, 2022
commit 0566b42ecb2755ef7cdb037744c5fe5ad1d0f9df
@@ -640,7 +640,35 @@ Connection objects
 
       Example:
 
-      .. literalinclude:: ../includes/sqlite3/text_factory.py
+      .. testcode::
+
+         con = sqlite3.connect(":memory:")
+         cur = con.cursor()
+
+         AUSTRIA = "Österreich"
+
+         # by default, rows are returned as str
+         cur.execute("SELECT ?", (AUSTRIA,))
+         row = cur.fetchone()
+         assert row[0] == AUSTRIA
+
+         # but we can make sqlite3 always return bytestrings ...
+         con.text_factory = bytes
+         cur.execute("SELECT ?", (AUSTRIA,))
+         row = cur.fetchone()
+         assert type(row[0]) is bytes
+         # the bytestrings will be encoded in UTF-8, unless you stored garbage in the
+         # database ...
+         assert row[0] == AUSTRIA.encode("utf-8")
+
+         # we can also implement a custom text_factory ...
+         # here we implement one that appends "foo" to all strings
+         con.text_factory = lambda x: x.decode("utf-8") + "foo"
+         cur.execute("SELECT ?", ("bar",))
+             row = cur.fetchone()
+         assert row[0] == "barfoo"
+
+         con.close()
 
    .. attribute:: total_changes