🚚 move package to src directory (#110)

techouse · web-flow · commit 3a68bbb49a20 · 2024-04-13T10:43:04.000+01:00
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -24,10 +24,10 @@ jobs:
         id: compare
         run: |
           set -e
-          VERSION=$(awk -F'"' '/__version__/ {print $2}' sqlite3_to_mysql/__init__.py)
+          VERSION=$(awk -F'"' '/__version__/ {print $2}' src/sqlite3_to_mysql/__init__.py)
           TAG=${GITHUB_REF_NAME#v}
           if [[ "$VERSION" != "$TAG" ]]; then
-            echo "Version in sqlite3_to_mysql/__version__.py ($VERSION) does not match tag ($TAG)"
+            echo "Version in src/sqlite3_to_mysql/__version__.py ($VERSION) does not match tag ($TAG)"
             exit 1
           fi
           echo "VERSION=$VERSION" >> $GITHUB_ENV
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -508,6 +508,8 @@ jobs:
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4
         with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: techouse/sqlite3-to-mysql
           files: ./coverage.xml
           env_vars: OS,PYTHON
           verbose: true
diff --git a/pyproject.toml b/pyproject.toml
@@ -57,11 +57,11 @@ Sponsor = "https://github.com/sponsors/techouse"
 PayPal = "https://paypal.me/ktusar"
 
 [tool.hatch.version]
-path = "sqlite3_to_mysql/__init__.py"
+path = "src/sqlite3_to_mysql/__init__.py"
 
 [tool.hatch.build.targets.sdist]
 include = [
-    "sqlite3_to_mysql",
+    "src",
     "tests",
     "README.md",
     "CHANGELOG.md",
@@ -103,6 +103,7 @@ known_first_party = "sqlite3_to_mysql"
 skip_gitignore = true
 
 [tool.pytest.ini_options]
+pythonpath = ["src"]
 testpaths = ["tests"]
 norecursedirs = [".*", "venv", "env", "*.egg", "dist", "build"]
 minversion = "7.3.1"
@@ -115,6 +116,7 @@ markers = [
 ]
 
 [tool.mypy]
+mypy_path = "src"
 python_version = "3.8"
 exclude = [
     "tests",
diff --git a/src/sqlite3_to_mysql/__init__.py b/src/sqlite3_to_mysql/__init__.py
@@ -1,4 +1,5 @@
 """Utility to transfer data from SQLite 3 to MySQL."""
+
 __version__ = "2.1.7"
 
 from .transporter import SQLite3toMySQL
diff --git a/src/sqlite3_to_mysql/cli.py b/src/sqlite3_to_mysql/cli.py
@@ -1,4 +1,5 @@
 """The command line interface of SQLite3toMySQL."""
+
 import os
 import sys
 import typing as t
diff --git a/src/sqlite3_to_mysql/click_utils.py b/src/sqlite3_to_mysql/click_utils.py
diff --git a/src/sqlite3_to_mysql/debug_info.py b/src/sqlite3_to_mysql/debug_info.py
diff --git a/src/sqlite3_to_mysql/mysql_utils.py b/src/sqlite3_to_mysql/mysql_utils.py
@@ -1,4 +1,5 @@
 """MySQL helpers."""
+
 import re
 import typing as t
 
diff --git a/src/sqlite3_to_mysql/py.typed b/src/sqlite3_to_mysql/py.typed
diff --git a/src/sqlite3_to_mysql/sqlite_utils.py b/src/sqlite3_to_mysql/sqlite_utils.py
diff --git a/src/sqlite3_to_mysql/transporter.py b/src/sqlite3_to_mysql/transporter.py
@@ -273,7 +273,6 @@ def _translate_type_from_sqlite_to_mysql(self, column_type: str) -> str:
         if data_type == "UNSIGNED BIG INT":
             return f"BIGINT{self._column_type_length(column_type)} UNSIGNED"
         if data_type.startswith(("TINYINT", "INT1")):
-            print("length", self._column_type_length(column_type))
             return f"TINYINT{self._column_type_length(column_type)}{' UNSIGNED' if unsigned else ''}"
         if data_type.startswith(("SMALLINT", "INT2")):
             return f"SMALLINT{self._column_type_length(column_type)}{' UNSIGNED' if unsigned else ''}"
@@ -349,9 +348,13 @@ def _create_table(self, table_name: str, transfer_rowid: bool = False) -> None:
                 type=column_type,
                 notnull="NOT NULL" if column["notnull"] or column["pk"] else "NULL",
                 auto_increment="AUTO_INCREMENT" if auto_increment else "",
-                default="DEFAULT " + column["dflt_value"]
-                if column["dflt_value"] and column_type not in MYSQL_COLUMN_TYPES_WITHOUT_DEFAULT and not auto_increment
-                else "",
+                default=(
+                    "DEFAULT " + column["dflt_value"]
+                    if column["dflt_value"]
+                    and column_type not in MYSQL_COLUMN_TYPES_WITHOUT_DEFAULT
+                    and not auto_increment
+                    else ""
+                ),
             )
 
             if column["pk"] > 0:
@@ -438,9 +441,11 @@ def _add_indices(self, table_name: str) -> None:
                     index_columns = ", ".join(
                         "`{column}`{length}".format(
                             column=safe_identifier_length(index_info["name"]),
-                            length="(255)"
-                            if table_columns[index_info["name"]].upper() in MYSQL_TEXT_COLUMN_TYPES_WITH_JSON
-                            else "",
+                            length=(
+                                "(255)"
+                                if table_columns[index_info["name"]].upper() in MYSQL_TEXT_COLUMN_TYPES_WITH_JSON
+                                else ""
+                            ),
                         )
                         for index_info in index_infos
                     )
@@ -478,9 +483,11 @@ def _add_indices(self, table_name: str) -> None:
                         index_columns=", ".join(
                             "`{column}`{length}".format(
                                 column=safe_identifier_length(index_info["name"]),
-                                length="(255)"
-                                if table_columns[index_info["name"]].upper() in MYSQL_TEXT_COLUMN_TYPES_WITH_JSON
-                                else "",
+                                length=(
+                                    "(255)"
+                                    if table_columns[index_info["name"]].upper() in MYSQL_TEXT_COLUMN_TYPES_WITH_JSON
+                                    else ""
+                                ),
                             )
                             for index_info in index_infos
                         ),
@@ -498,16 +505,20 @@ def _add_index(
         index_infos: t.Tuple[t.Dict[str, t.Any], ...],
         index_iteration: int = 0,
     ) -> None:
-        sql: str = """
+        sql: str = (
+            """
             ALTER TABLE `{table}`
             ADD {index_type} `{name}`({columns})
         """.format(
-            table=safe_identifier_length(table_name),
-            index_type=index_type,
-            name=safe_identifier_length(index["name"])
-            if index_iteration == 0
-            else f'{safe_identifier_length(index["name"], max_length=60)}_{index_iteration}',
-            columns=index_columns,
+                table=safe_identifier_length(table_name),
+                index_type=index_type,
+                name=(
+                    safe_identifier_length(index["name"])
+                    if index_iteration == 0
+                    else f'{safe_identifier_length(index["name"], max_length=60)}_{index_iteration}'
+                ),
+                columns=index_columns,
+            )
         )
 
         try:
@@ -580,12 +591,16 @@ def _add_foreign_keys(self, table_name: str) -> None:
                 column=safe_identifier_length(foreign_key["from"]),
                 ref_table=safe_identifier_length(foreign_key["table"]),
                 ref_column=safe_identifier_length(foreign_key["to"]),
-                on_delete=foreign_key["on_delete"].upper()
-                if foreign_key["on_delete"].upper() != "SET DEFAULT"
-                else "NO ACTION",
-                on_update=foreign_key["on_update"].upper()
-                if foreign_key["on_update"].upper() != "SET DEFAULT"
-                else "NO ACTION",
+                on_delete=(
+                    foreign_key["on_delete"].upper()
+                    if foreign_key["on_delete"].upper() != "SET DEFAULT"
+                    else "NO ACTION"
+                ),
+                on_update=(
+                    foreign_key["on_update"].upper()
+                    if foreign_key["on_update"].upper() != "SET DEFAULT"
+                    else "NO ACTION"
+                ),
             )
 
             try:
@@ -686,18 +701,20 @@ def transfer(self) -> None:
                         safe_identifier_length(column[0]) for column in self._sqlite_cur.description
                     ]
                     if self._mysql_insert_method.upper() == "UPDATE":
-                        sql: str = """
+                        sql: str = (
+                            """
                             INSERT
                             INTO `{table}` ({fields})
                             VALUES ({placeholders}) AS `__new__`
                             ON DUPLICATE KEY UPDATE {field_updates}
                         """.format(
-                            table=safe_identifier_length(table["name"]),
-                            fields=("`{}`, " * len(columns)).rstrip(" ,").format(*columns),
-                            placeholders=("%s, " * len(columns)).rstrip(" ,"),
-                            field_updates=("`{}`=`__new__`.`{}`, " * len(columns))
-                            .rstrip(" ,")
-                            .format(*list(chain.from_iterable((column, column) for column in columns))),
+                                table=safe_identifier_length(table["name"]),
+                                fields=("`{}`, " * len(columns)).rstrip(" ,").format(*columns),
+                                placeholders=("%s, " * len(columns)).rstrip(" ,"),
+                                field_updates=("`{}`=`__new__`.`{}`, " * len(columns))
+                                .rstrip(" ,")
+                                .format(*list(chain.from_iterable((column, column) for column in columns))),
+                            )
                         )
                     else:
                         sql = """
diff --git a/src/sqlite3_to_mysql/types.py b/src/sqlite3_to_mysql/types.py
@@ -1,4 +1,5 @@
 """Types for sqlite3-to-mysql."""
+
 import os
 import typing as t
 from logging import Logger
diff --git a/tests/func/sqlite3_to_mysql_test.py b/tests/func/sqlite3_to_mysql_test.py
@@ -313,14 +313,14 @@ def test_transfer_transfers_all_tables_in_sqlite_file(
         mysql_inspect: Inspector = inspect(mysql_engine)
         mysql_tables: t.List[str] = mysql_inspect.get_table_names()
 
-        mysql_connector_connection: t.Union[
-            PooledMySQLConnection, MySQLConnection, CMySQLConnection
-        ] = mysql.connector.connect(
-            user=mysql_credentials.user,
-            password=mysql_credentials.password,
-            host=mysql_credentials.host,
-            port=mysql_credentials.port,
-            database=mysql_credentials.database,
+        mysql_connector_connection: t.Union[PooledMySQLConnection, MySQLConnection, CMySQLConnection] = (
+            mysql.connector.connect(
+                user=mysql_credentials.user,
+                password=mysql_credentials.password,
+                host=mysql_credentials.host,
+                port=mysql_credentials.port,
+                database=mysql_credentials.database,
+            )
         )
         server_version: t.Tuple[int, ...] = mysql_connector_connection.get_server_version()
 
@@ -370,9 +370,7 @@ def test_transfer_transfers_all_tables_in_sqlite_file(
                 AND i.CONSTRAINT_TYPE = :constraint_type
             """.format(
                     # MySQL 8.0.19 still works with "LEFT JOIN" everything above requires "JOIN"
-                    JOIN="JOIN"
-                    if (server_version[0] == 8 and server_version[2] > 19)
-                    else "LEFT JOIN"
+                    JOIN="JOIN" if (server_version[0] == 8 and server_version[2] > 19) else "LEFT JOIN"
                 )
             ).bindparams(
                 table_schema=mysql_credentials.database,
diff --git a/tests/func/test_cli.py b/tests/func/test_cli.py
@@ -540,7 +540,6 @@ def test_quiet(
             sqlite3mysql,
             arguments,
         )
-        print(result.output)
         assert result.exit_code == 0
         assert (
             f"{sqlite3mysql.name} version {package_version} Copyright (c) 2018-{datetime.now().year} Klemen Tusar"
diff --git a/tox.ini b/tox.ini
@@ -26,15 +26,15 @@ passenv =
 deps =
     -rrequirements_dev.txt
 commands =
-    pytest -v --cov=sqlite3_to_mysql --cov-report=xml
+    pytest -v --cov=src/sqlite3_to_mysql --cov-report=xml
 
 [testenv:black]
 basepython = python3
 skip_install = true
 deps =
     black
 commands =
-    black sqlite3_to_mysql tests/
+    black src/sqlite3_to_mysql tests/
 
 [testenv:isort]
 basepython = python3
@@ -54,7 +54,7 @@ deps =
     flake8-import-order
     flake8-typing-imports
     pep8-naming
-commands = flake8 sqlite3_to_mysql
+commands = flake8 src/sqlite3_to_mysql
 
 [testenv:pylint]
 basepython = python3
@@ -63,15 +63,15 @@ deps =
     pylint
     -rrequirements_dev.txt
 commands =
-    pylint --rcfile=tox.ini sqlite3_to_mysql
+    pylint --rcfile=tox.ini src/sqlite3_to_mysql
 
 [testenv:bandit]
 basepython = python3
 skip_install = true
 deps =
     bandit
 commands =
-    bandit -r sqlite3_to_mysql -c .bandit.yml
+    bandit -r src/sqlite3_to_mysql -c .bandit.yml
 
 [testenv:mypy]
 basepython = python3
@@ -80,7 +80,7 @@ deps =
     mypy>=1.3.0
     -rrequirements_dev.txt
 commands =
-    mypy sqlite3_to_mysql --enable-incomplete-feature=Unpack
+    mypy src/sqlite3_to_mysql
 
 [testenv:linters]
 basepython = python3

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`"""The command line interface of SQLite3toMySQL."""`
	`2`	`+`
`2`	`3`	`import os`
`3`	`4`	`import sys`
`4`	`5`	`import typing as t`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`"""MySQL helpers."""`
	`2`	`+`
`2`	`3`	`import re`
`3`	`4`	`import typing as t`
`4`	`5`