Remvoe escape_* functions from pymysql.__all__ (PyMySQL#931)

* .travis -> ci

* remove initializedb.sh

* Remvoe escape functions from __all__

* fix test

* don't use deprecated keyword

* fix tests

* fix tests

* black

Author: methane

.github/workflows/test.yaml

@@ -70,7 +70,7 @@ jobs:
           mysql -h127.0.0.1 -uroot -e 'create database test2 DEFAULT CHARACTER SET utf8mb4'
           mysql -h127.0.0.1 -uroot -e "create user test2           identified ${WITH_PLUGIN} by 'some password'; grant all on test2.* to test2;"
           mysql -h127.0.0.1 -uroot -e "create user test2@localhost identified ${WITH_PLUGIN} by 'some password'; grant all on test2.* to test2@localhost;"
-          cp .travis/docker.json pymysql/tests/databases.json
+          cp ci/docker.json pymysql/tests/databases.json
 
       - name: Run test
         run: |

.travis/database.json

@@ -0,0 +1,4 @@
+[
+    {"host": "localhost", "unix_socket": "/var/run/mysqld/mysqld.sock", "user": "root", "password": "", "database": "test1",  "use_unicode": true, "local_infile": true},
+    {"host": "127.0.0.1", "port": 3306, "user": "test2", "password": "some password", "database": "test2" }
+]

.travis/docker.json

@@ -0,0 +1,4 @@
+[
+    {"host": "127.0.0.1", "port": 3306, "user": "root",  "password": "", "database": "test1",  "use_unicode": true, "local_infile": true},
+    {"host": "127.0.0.1", "port": 3306, "user": "test2", "password": "some password", "database": "test2" }
+]

.travis/initializedb.sh

@@ -22,10 +22,10 @@ If you would like to run the test suite, create a database for testing like this
     mysql -e 'create database test_pymysql  DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;'
     mysql -e 'create database test_pymysql2 DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;'
 
-Then, copy the file ``.travis/database.json`` to ``pymysql/tests/databases.json``
+Then, copy the file ``ci/database.json`` to ``pymysql/tests/databases.json``
 and edit the new file to match your MySQL configuration::
 
-    $ cp .travis/database.json pymysql/tests/databases.json
+    $ cp ci/database.json pymysql/tests/databases.json
     $ $EDITOR pymysql/tests/databases.json
 
 To run all the tests, execute the script ``runtests.py``::

ci/database.json

@@ -24,7 +24,6 @@
 import sys
 
 from .constants import FIELD_TYPE
-from .converters import escape_dict, escape_sequence, escape_string
 from .err import (
     Warning,
     Error,
@@ -177,14 +176,10 @@ def install_as_MySQLdb():
     "constants",
     "converters",
     "cursors",
-    "escape_dict",
-    "escape_sequence",
-    "escape_string",
     "get_client_info",
     "paramstyle",
     "threadsafety",
     "version_info",
     "install_as_MySQLdb",
-    "NULL",
     "__version__",
 ]

ci/docker.json

@@ -21,11 +21,11 @@ class PyMySQLTestCase(unittest.TestCase):
                 "host": "localhost",
                 "user": "root",
                 "passwd": "",
-                "db": "test1",
+                "database": "test1",
                 "use_unicode": True,
                 "local_infile": True,
             },
-            {"host": "localhost", "user": "root", "passwd": "", "db": "test2"},
+            {"host": "localhost", "user": "root", "passwd": "", "database": "test2"},
         ]
 
     def mysql_server_is(self, conn, version_tuple):

docs/source/user/development.rst

@@ -142,7 +142,7 @@ def realtestSocketAuth(self):
         with TempUser(
             self.connect().cursor(),
             TestAuthentication.osuser + "@localhost",
-            self.databases[0]["db"],
+            self.databases[0]["database"],
             self.socket_plugin_name,
         ) as u:
             c = pymysql.connect(user=TestAuthentication.osuser, **self.db)
@@ -216,7 +216,7 @@ def realTestDialogAuthTwoQuestions(self):
         with TempUser(
             self.connect().cursor(),
             "pymysql_2q@localhost",
-            self.databases[0]["db"],
+            self.databases[0]["database"],
             "two_questions",
             "notverysecret",
         ) as u:
@@ -258,7 +258,7 @@ def realTestDialogAuthThreeAttempts(self):
         with TempUser(
             self.connect().cursor(),
             "pymysql_3a@localhost",
-            self.databases[0]["db"],
+            self.databases[0]["database"],
             "three_attempts",
             "stillnotverysecret",
         ) as u:
@@ -353,7 +353,7 @@ def realTestPamAuth(self):
         with TempUser(
             cur,
             TestAuthentication.osuser + "@localhost",
-            self.databases[0]["db"],
+            self.databases[0]["database"],
             "pam",
             os.environ.get("PAMSERVICE"),
         ) as u:
@@ -392,7 +392,10 @@ def testAuthSHA256(self):
         conn = self.connect()
         c = conn.cursor()
         with TempUser(
-            c, "pymysql_sha256@localhost", self.databases[0]["db"], "sha256_password"
+            c,
+            "pymysql_sha256@localhost",
+            self.databases[0]["database"],
+            "sha256_password",
         ) as u:
             if self.mysql_server_is(conn, (5, 7, 0)):
                 c.execute("SET PASSWORD FOR 'pymysql_sha256'@'localhost' ='Sh@256Pa33'")
@@ -442,8 +445,8 @@ def test_autocommit(self):
 
     def test_select_db(self):
         con = self.connect()
-        current_db = self.databases[0]["db"]
-        other_db = self.databases[1]["db"]
+        current_db = self.databases[0]["database"]
+        other_db = self.databases[1]["database"]
 
         cur = con.cursor()
         cur.execute("SELECT database()")
@@ -754,7 +757,7 @@ def test_escape_fallback_encoder(self):
         class Custom(str):
             pass
 
-        mapping = {str: pymysql.escape_string}
+        mapping = {str: pymysql.converters.escape_string}
         self.assertEqual(con.escape(Custom("foobar"), mapping), "'foobar'")
 
     def test_escape_no_default(self):

pymysql/__init__.py

@@ -66,7 +66,7 @@ def test_issue_6(self):
         """ exception: TypeError: ord() expected a character, but string of length 0 found """
         # ToDo: this test requires access to db 'mysql'.
         kwargs = self.databases[0].copy()
-        kwargs["db"] = "mysql"
+        kwargs["database"] = "mysql"
         conn = pymysql.connect(**kwargs)
         c = conn.cursor()
         c.execute("select * from user")
@@ -152,7 +152,7 @@ def test_issue_17(self):
         """could not connect mysql use passwod"""
         conn = self.connect()
         host = self.databases[0]["host"]
-        db = self.databases[0]["db"]
+        db = self.databases[0]["database"]
         c = conn.cursor()
 
         # grant access to a table to a user with a password