Feat/main/ws sqlalchemy

.github/workflows/taos-ws-py-compatibility.yml

@@ -111,5 +111,5 @@ jobs:
           WS_CLOUD_TOKEN: ${{ secrets.WS_CLOUD_TOKEN }}
           TEST_TD_3360: "true"
         run: |
-          pip3 install pytest toml
+          pip3 install pytest toml sqlalchemy
           pytest ./taos-ws-py/tests/

.github/workflows/taos-ws-py-enterprise.yml

@@ -117,5 +117,5 @@ jobs:
           WS_CLOUD_TOKEN: ${{ secrets.WS_CLOUD_TOKEN }}
           TEST_TD_ENTERPRISE: "true"
         run: |
-          pip3 install pytest toml
+          pip3 install pytest toml sqlalchemy
           pytest ./taos-ws-py/tests/

.github/workflows/taos-ws-py.yml

@@ -225,7 +225,7 @@ jobs:
           WS_CLOUD_TOKEN: ${{ secrets.WS_CLOUD_TOKEN }}
         run: |
           curl -L -u "$TDENGINE_TEST_USERNAME:$TDENGINE_TEST_PASSWORD" -d "show databases" localhost:6041/rest/sql
-          pip3 install pytest toml
+          pip3 install pytest toml sqlalchemy
           pip3 install ./
           pytest ./taos-ws-py/tests/
 

examples/pandas-read-sql.py

@@ -3,7 +3,7 @@
 
 protocol_and_port = {"taos": 6030, "taosrest": 6041, "taosws": 6041}
 
-for (protocol, port) in protocol_and_port.items():
+for protocol, port in protocol_and_port.items():
     engine = create_engine(f"{protocol}://root:taosdata@localhost")
     conn = engine.connect()
     res = pandas.read_sql(text("show databases"), conn)

pyproject.toml

@@ -12,7 +12,6 @@ packages = [{ include = "taos" }, { include = "taosrest" }]
 [tool.poetry.plugins."sqlalchemy.dialects"]
 "taos" = "taos.sqlalchemy:TaosDialect"
 "taosrest" = "taosrest.sqlalchemy:TaosRestDialect"
-"taosws" = "taos.sqlalchemy:TaosWsDialect"
 
 [tool.poetry.dependencies]
 python = ">=3.7,<4.0"

taos-ws-py/Cargo.toml

@@ -6,7 +6,7 @@ publish = false
 license = "MIT"
 
 [lib]
-name = "taosws"
+name = "_taosws"
 crate-type = ["cdylib"]
 
 [dependencies]

taos-ws-py/examples/schemaless_example.py

@@ -1,6 +1,6 @@
 #!
 import taosws
-from taosws.taosws import PySchemalessProtocol, PySchemalessPrecision
+from taosws import PySchemalessProtocol, PySchemalessPrecision
 
 import taos
 

taos-ws-py/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["maturin>=1.8,<2.0"]
+build-backend = "maturin"
+
+[project]
+name = "taos-ws-py"
+dynamic = ["version"]
+description = "The official TDengine Python websocket connector"
+readme = "README.md"
+requires-python = ">=3.7"
+license = { text = "MIT" }
+classifiers = [
+    "Programming Language :: Python",
+    "Programming Language :: Rust",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+]
+
+[project.optional-dependencies]
+sqlalchemy = ["sqlalchemy>=2.0.0"]
+
+[project.entry-points."sqlalchemy.dialects"]
+taosws = "taosws.sqlalchemy:TaosWsDialect"
+
+[tool.maturin]
+python-source = "."
+module-name = "taosws._taosws"

taos-ws-py/src/lib.rs

@@ -39,37 +39,37 @@ shadow_rs::shadow!(build);
 // ```
 
 create_exception!(
-    taosws,
+    _taosws,
     Warning,
     PyException,
     "Calling some methods will produce warning."
 );
-create_exception!(taosws, Error, PyException, "The root error exception");
+create_exception!(_taosws, Error, PyException, "The root error exception");
 create_exception!(
-    taosws,
+    _taosws,
     InterfaceError,
     PyException,
     "The low-level api caused exception"
 );
-create_exception!(taosws, DatabaseError, Error);
-create_exception!(taosws, DataError, DatabaseError);
-create_exception!(taosws, OperationalError, DatabaseError);
-create_exception!(taosws, IntegrityError, DatabaseError);
-create_exception!(taosws, InternalError, DatabaseError);
-create_exception!(taosws, ProgrammingError, DatabaseError);
-create_exception!(taosws, NotSupportedError, DatabaseError);
-
-create_exception!(taosws, QueryError, DatabaseError);
-create_exception!(taosws, FetchError, DatabaseError);
-
-create_exception!(taosws, ConnectionError, Error, "Connection error");
+create_exception!(_taosws, DatabaseError, Error);
+create_exception!(_taosws, DataError, DatabaseError);
+create_exception!(_taosws, OperationalError, DatabaseError);
+create_exception!(_taosws, IntegrityError, DatabaseError);
+create_exception!(_taosws, InternalError, DatabaseError);
+create_exception!(_taosws, ProgrammingError, DatabaseError);
+create_exception!(_taosws, NotSupportedError, DatabaseError);
+
+create_exception!(_taosws, QueryError, DatabaseError);
+create_exception!(_taosws, FetchError, DatabaseError);
+
+create_exception!(_taosws, ConnectionError, Error, "Connection error");
 create_exception!(
-    taosws,
+    _taosws,
     AlreadyClosedError,
     ConnectionError,
     "Connection error"
 );
-create_exception!(taosws, ConsumerException, Error);
+create_exception!(_taosws, ConsumerException, Error);
 
 mod common;
 mod consumer;
@@ -1020,7 +1020,7 @@ fn blob_to_column(values: Vec<Option<Vec<u8>>>) -> PyColumnView {
 }
 
 #[pymodule]
-fn taosws(py: Python<'_>, m: &PyModule) -> PyResult<()> {
+fn _taosws(py: Python<'_>, m: &PyModule) -> PyResult<()> {
     if std::env::var("RUST_LOG").is_ok() {
         let _ = pretty_env_logger::try_init();
     }

taos-ws-py/taosws/__init__.py

@@ -0,0 +1,34 @@
+import importlib
+import importlib.util
+import pkgutil
+
+
+__path__ = pkgutil.extend_path(__path__, __name__)
+
+
+def _load_native_module():
+    for module_name in ("_taosws", "taosws"):
+        full_name = f"{__name__}.{module_name}"
+        if importlib.util.find_spec(full_name) is None:
+            continue
+        return importlib.import_module(full_name)
+
+    raise ImportError(
+        "Failed to import native extension 'taosws._taosws' or 'taosws.taosws'. "
+        "Ensure taos-ws-py is built and installed correctly."
+    )
+
+
+_native = _load_native_module()
+
+if hasattr(_native, "__all__"):
+    for name in _native.__all__:
+        globals()[name] = getattr(_native, name)
+else:
+    for name in dir(_native):
+        if not name.startswith("_"):
+            globals()[name] = getattr(_native, name)
+
+__doc__ = _native.__doc__
+if hasattr(_native, "__all__"):
+    __all__ = _native.__all__