tests finally passing

Author: Antony Bailey

.github/workflows/python-package.yml

@@ -36,4 +36,4 @@ jobs:
         black --check .
     - name: Test with pytest
       run: |
-        pytest
+        ./run-tests.sh

run_tests.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+# Simple script to run tests for pySQLY
+
+# Exit on any error
+set -e
+
+echo "Installing dependencies for testing..."
+python -m pip install -e ".[dev]"
+
+echo "Running tests..."
+pytest
+
+echo "Tests completed successfully!"

setup.py

@@ -0,0 +1,58 @@
+"""Setup script for pySQLY."""
+
+from setuptools import find_packages, setup
+
+if __name__ == "__main__":
+    setup(
+        name="pysqly",
+        version="0.1.0",
+        description="SQL with YAML - A simplified query language for "
+        "multiple databases",
+        long_description=open("README.md").read(),
+        long_description_content_type="text/markdown",
+        author="Standard Query Language",
+        author_email="example@example.com",
+        url="https://github.com/Standard-Query-Language/pySQLY",
+        packages=find_packages(where="src"),
+        package_dir={"": "src"},
+        include_package_data=True,
+        install_requires=[
+            "pyyaml>=6.0",
+        ],
+        extras_require={
+            "mariadb": ["mysql-connector-python>=8.0"],
+            "postgres": ["psycopg2>=2.9"],
+            "oracle": ["cx_Oracle>=8.0"],
+            "mssql": ["pyodbc>=4.0"],
+            "all": [
+                "mysql-connector-python>=8.0",
+                "psycopg2>=2.9",
+                "cx_Oracle>=8.0",
+                "pyodbc>=4.0",
+            ],
+            "dev": [
+                "pytest>=7.0",
+                "black>=23.0",
+                "isort>=5.0",
+                "ruff>=0.0.1",
+                "pre-commit>=3.0",
+            ],
+        },
+        classifiers=[
+            "Development Status :: 4 - Beta",
+            "Intended Audience :: Developers",
+            "License :: OSI Approved :: MIT License",
+            "Programming Language :: Python :: 3",
+            "Programming Language :: Python :: 3.9",
+            "Programming Language :: Python :: 3.10",
+            "Programming Language :: Python :: 3.11",
+            "Topic :: Database",
+            "Topic :: Software Development :: Libraries :: Python Modules",
+        ],
+        python_requires=">=3.9",
+        entry_points={
+            "console_scripts": [
+                "sqly-cli=pysqly.cli:main",
+            ],
+        },
+    )

src/pysqly/connectors/base.py

@@ -2,9 +2,10 @@
 
 from typing import Any, Dict, List
 
-from pysqly.core import SQLYUtils
 from pysqly.errors import SQLYExecutionError
 
+# Import SQLYUtils when needed to avoid circular imports
+# from pysqly.core import SQLYUtils
 from .interface import IDBConnector
 
 
@@ -35,9 +36,35 @@ def execute_query(self, query: Dict[str, Any]) -> Any:
         Returns:
             The result of the executed query.
         """
-        sql, params = SQLYUtils.translate_to_sql(query)
+        # Import here to avoid circular imports
+        from pysqly.core import SQLYUtils
+
+        sql, params = SQLYUtils.translate_to_sql(query, self.get_db_type())
         return self.execute(sql, params)
 
+    def get_db_type(self) -> str:
+        """
+        Get the database type for this connector.
+
+        Returns:
+            String representing the database type
+        """
+        # Extract the database type from the class name
+        # (e.g., SQLiteConnector -> sqlite)
+        class_name = self.__class__.__name__.lower()
+        if "sqlite" in class_name:
+            return "sqlite"
+        elif "mariadb" in class_name or "mysql" in class_name:
+            return "mariadb"
+        elif "postgres" in class_name:
+            return "postgres"
+        elif "oracle" in class_name:
+            return "oracle"
+        elif "mssql" in class_name:
+            return "mssql"
+        else:
+            raise ValueError(f"Unknown database type for {class_name}")
+
     def execute(self, sql: str, params: List[Any]) -> Any:
         """
         Execute a given SQL statement with the provided parameters.

src/pysqly/connectors/database.py

@@ -2,7 +2,8 @@
 
 from typing import Any, Dict, Optional
 
-from .factory import DBConnectorFactory
+# Import factory at time of use to avoid circular imports
+# from .factory import DBConnectorFactory
 
 
 class DatabaseConnector:
@@ -51,6 +52,9 @@ def _ensure_connector(self) -> Any:
             The database connector instance.
         """
         if self.connector is None:
+            # Import here to avoid circular imports
+            from .factory import DBConnectorFactory
+
             self.connector = DBConnectorFactory.create_connector(
                 self.db_type, self.connection
             )
@@ -83,6 +87,9 @@ def execute_query(
         connection = connection or self.connection
 
         if db_type != self.db_type or connection != self.connection:
+            # Import here to avoid circular imports
+            from .factory import DBConnectorFactory
+
             # If parameters differ from instance attributes, create a new connector
             connector = DBConnectorFactory.create_connector(db_type, connection)
         else:

src/pysqly/connectors/factory.py

@@ -4,10 +4,11 @@
 
 from pysqly.errors import SQLYExecutionError
 
-from .mariadb import MariaDBConnector
-from .mssql import MSSQLConnector
-from .oracle import OracleConnector
-from .postgres import PostgresConnector
+# Import connectors directly instead of from module to avoid circular dependencies
+from .mariadb import MYSQL_AVAILABLE, MariaDBConnector
+from .mssql import MSSQL_AVAILABLE, MSSQLConnector
+from .oracle import ORACLE_AVAILABLE, OracleConnector
+from .postgres import POSTGRES_AVAILABLE, PostgresConnector
 from .sqlite import SQLiteConnector
 
 
@@ -34,15 +35,41 @@ def create_connector(db_type: str, connection: Any) -> Any:
             An instance of the corresponding database connector class.
 
         Raises:
-            SQLYExecutionError: If the specified database type is not supported.
+            SQLYExecutionError: If the specified database type is not supported or
+                                if the required database driver is not installed.
         """
+        # Check if the requested database type is available
+        if db_type == "mariadb" and not MYSQL_AVAILABLE:
+            raise SQLYExecutionError(
+                "MariaDB/MySQL connector is not available. "
+                "Please install mysql-connector-python package."
+            )
+        elif db_type == "postgres" and not POSTGRES_AVAILABLE:
+            raise SQLYExecutionError(
+                "PostgreSQL connector is not available. "
+                "Please install psycopg2 package."
+            )
+        elif db_type == "oracle" and not ORACLE_AVAILABLE:
+            raise SQLYExecutionError(
+                "Oracle connector is not available. "
+                "Please install cx_Oracle package."
+            )
+        elif db_type == "mssql" and not MSSQL_AVAILABLE:
+            raise SQLYExecutionError(
+                "MS SQL Server connector is not available. "
+                "Please install pyodbc package."
+            )
+
+        # Define the mapping of database types to connector classes
         connectors = {
             "sqlite": SQLiteConnector,
             "mariadb": MariaDBConnector,
             "postgres": PostgresConnector,
             "oracle": OracleConnector,
             "mssql": MSSQLConnector,
         }
+
         if db_type not in connectors:
             raise SQLYExecutionError(f"Unsupported database type: {db_type}")
+
         return connectors[db_type](connection)

src/pysqly/connectors/mariadb.py

@@ -2,7 +2,13 @@
 
 from typing import Any, Union
 
-import mysql.connector
+# Import MySQL connector conditionally
+try:
+    import mysql.connector
+
+    MYSQL_AVAILABLE = True
+except ImportError:
+    MYSQL_AVAILABLE = False
 
 from .base import BaseDBConnector
 
@@ -25,7 +31,17 @@ def __init__(self, connection: Union[str, Any]) -> None:
             connection: If a string is provided, it's treated as a connection string
                 and a new connection is established. If a connection object is provided,
                 it's used directly.
+
+        Raises:
+            ImportError: If the mysql-connector-python package is not installed.
         """
+        if not MYSQL_AVAILABLE:
+            raise ImportError(
+                "mysql-connector-python is not installed. "
+                "Please install it with 'pip install mysql-connector-python' "
+                "or 'pip install pysqly[mariadb]'."
+            )
+
         if isinstance(connection, str):
             connection = mysql.connector.connect(connection)
         super().__init__(connection)

src/pysqly/connectors/mssql.py

@@ -2,7 +2,13 @@
 
 from typing import Any, Union
 
-import pyodbc
+# Import MS SQL connector conditionally
+try:
+    import pyodbc
+
+    MSSQL_AVAILABLE = True
+except ImportError:
+    MSSQL_AVAILABLE = False
 
 from .base import BaseDBConnector
 
@@ -27,7 +33,17 @@ def __init__(self, connection: Union[str, Any]) -> None:
             If a connection string is provided, it should be in the format required by
             pyodbc, typically including server, database, authentication details,
             and other relevant parameters.
+
+        Raises:
+            ImportError: If the pyodbc package is not installed.
         """
+        if not MSSQL_AVAILABLE:
+            raise ImportError(
+                "pyodbc is not installed. "
+                "Please install it with 'pip install pyodbc' "
+                "or 'pip install pysqly[mssql]'."
+            )
+
         if isinstance(connection, str):
             connection = pyodbc.connect(connection)
         super().__init__(connection)

src/pysqly/connectors/oracle.py

@@ -2,7 +2,13 @@
 
 from typing import Any, Union
 
-import cx_Oracle
+# Import Oracle connector conditionally
+try:
+    import cx_Oracle
+
+    ORACLE_AVAILABLE = True
+except ImportError:
+    ORACLE_AVAILABLE = False
 
 from .base import BaseDBConnector
 
@@ -29,7 +35,17 @@ def __init__(self, connection: Union[str, Any]) -> None:
         Notes:
             The connection string format follows the Oracle standard:
             "username/password@host:port/service_name"
+
+        Raises:
+            ImportError: If the cx_Oracle package is not installed.
         """
+        if not ORACLE_AVAILABLE:
+            raise ImportError(
+                "cx_Oracle is not installed. "
+                "Please install it with 'pip install cx_Oracle' "
+                "or 'pip install pysqly[oracle]'."
+            )
+
         if isinstance(connection, str):
             connection = cx_Oracle.connect(connection)
         super().__init__(connection)

src/pysqly/connectors/postgres.py

@@ -2,7 +2,13 @@
 
 from typing import Any, Union
 
-import psycopg2
+# Import PostgreSQL connector conditionally
+try:
+    import psycopg2
+
+    POSTGRES_AVAILABLE = True
+except ImportError:
+    POSTGRES_AVAILABLE = False
 
 from .base import BaseDBConnector
 
@@ -26,7 +32,17 @@ def __init__(self, connection: Union[str, Any]) -> None:
         Notes:
             The connection string should be in the format:
             "host=hostname dbname=database user=username password=password"
+
+        Raises:
+            ImportError: If the psycopg2 package is not installed.
         """
+        if not POSTGRES_AVAILABLE:
+            raise ImportError(
+                "psycopg2 is not installed. "
+                "Please install it with 'pip install psycopg2' "
+                "or 'pip install pysqly[postgres]'."
+            )
+
         if isinstance(connection, str):
             connection = psycopg2.connect(connection)
         super().__init__(connection)