chore: Improve DX configs (#16)

Author: achimnol

.github/workflows/ci.yml

@@ -25,29 +25,29 @@ jobs:
     steps:
     - name: Checkout the revision
       uses: actions/checkout@v4
-    - name: Set up Python as Runtime
-      uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python-version }}
-        allow-prereleases: true
     - name: Set up Rust toolchain
       uses: actions-rust-lang/setup-rust-toolchain@v1
       with:
         toolchain: stable
         override: true
     - name: Install protobuf compiler
-      run: |
-        sudo apt update
-        sudo apt install -y protobuf-compiler
+      uses: arduino/setup-protoc@v3
+      with:
+        version: "33.2"
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+    - name: Install uv and set the Python version
+      uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: true
+        python-version: ${{ matrix.python-version }}
     - name: Install dependencies and build the package
       run: |
-        python -m pip install --upgrade pip
-        python -m pip install -r requirements.txt
-        python -m maturin build
-        python -m pip install .
+        uv sync --locked --all-extras
+        uv run maturin build
+        uv pip install .
     - name: Test
       run: |
-        python -m pytest
+        uv run pytest
 
   release-linux:
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')

Makefile

@@ -1,15 +1,52 @@
+# Build targets
 build:
-	maturin build
+	uv run maturin build
 
 install:
-	maturin build
-	pip install .
+	uv sync --all-extras
+	uv run maturin develop
 
+# Test targets
+test:
+	uv run pytest
+
+# Utility targets
 etcd-clear:
 	etcdctl del "" --from-key=true
 
-fmt:
+# Python formatting and linting
+fmt-py:
+	uv run ruff format tests/ etcd_client.pyi
+
+lint-py:
+	uv run ruff check tests/ etcd_client.pyi
+
+fix-py:
+	uv run ruff format tests/ etcd_client.pyi
+	uv run ruff check --fix tests/ etcd_client.pyi
+
+typecheck:
+	uv run mypy tests/ etcd_client.pyi
+
+# Rust formatting and linting
+fmt-rust:
 	cargo fmt
 
-lint:
+lint-rust:
 	cargo clippy
+
+fix-rust:
+	cargo fmt
+	cargo clippy --fix --allow-dirty --allow-staged
+
+# Combined targets
+fmt: fmt-py fmt-rust
+
+lint: lint-py typecheck lint-rust
+
+fix: fix-py fix-rust
+
+check: lint
+	@echo "All checks passed!"
+
+.PHONY: build install test etcd-clear fmt-py lint-py fix-py typecheck fmt-rust lint-rust fix-rust fmt lint fix check

README.md

@@ -237,4 +237,63 @@ distributions under the `dist/` directory.
 
 ## How to develop and test
 
-(TODO: run maturin for an editable setup)
+### Setup development environment
+
+This project uses [uv](https://docs.astral.sh/uv/) for fast Python package management.
+
+```bash
+# Install uv (if not already installed)
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Install all dependencies and build the package
+make install
+
+# Or manually:
+uv sync --all-extras  # Installs all dependencies from pyproject.toml
+uv run maturin develop  # Builds and installs the Rust extension
+```
+
+### Code quality checks
+
+This project uses ruff for linting/formatting and mypy for type checking:
+
+```bash
+# Format Python code
+make fmt-py
+
+# Lint Python code
+make lint-py
+
+# Auto-fix Python issues (format + fixable lints)
+make fix-py
+
+# Type check Python code
+make typecheck
+
+# Auto-fix Rust issues (format + fixable clippy lints)
+make fix-rust
+
+# Auto-fix all issues (Python + Rust)
+make fix
+
+# Format all code (Python + Rust)
+make fmt
+
+# Lint all code (Python + Rust)
+make lint
+
+# Run all checks (Python + Rust)
+make check
+```
+
+### Running tests
+
+```bash
+# Run tests using uv
+make test
+
+# Or directly with uv
+uv run pytest
+
+# The tests use testcontainers to automatically spin up etcd
+```

etcd_client.pyi

@@ -123,7 +123,7 @@ class Client:
         """ """
     async def __aenter__(self) -> "Communicator":
         """ """
-    async def __aexit__(self, *args) -> None:
+    async def __aexit__(self, exc_type: object, exc_val: object, exc_tb: object) -> None:
         """ """
 
 class ConnectOptions:
@@ -242,14 +242,6 @@ class Communicator:
         last compaction revision.
         """
 
-class Watch:
-    """ """
-
-    async def __aiter__(self) -> AsyncIterator["Watch"]:
-        """ """
-    async def __anext__(self) -> "WatchEvent":
-        """ """
-
 class WatchEvent:
     """ """
 
@@ -259,6 +251,7 @@ class WatchEvent:
     prev_value: Optional[bytes]
 
     def __init__(
+        self,
         key: bytes,
         value: bytes,
         event: "WatchEventType",
@@ -275,16 +268,6 @@ class WatchEventType:
     """
     """
 
-class CondVar:
-    """ """
-
-    def __init__(self) -> None:
-        """ """
-    async def wait(self) -> None:
-        """ """
-    async def notify_waiters(self) -> None:
-        """ """
-
 class ClientError(Exception):
     """ """
 

pyproject.toml

@@ -21,11 +21,77 @@ classifiers = [
   "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: 3.14",
 ]
+dependencies = [
+  "maturin>=1.10.2",
+  "pytest>=8.4.1,<9",
+  "pytest-asyncio>=1.1.0,<2",
+  "trafaret>=2.1,<3",
+  "testcontainers>=4.12.0,<5",
+]
 
 [project.urls]
 homepage = "https://github.com/lablup/etcd-client-py"
 repository = "https://github.com/lablup/etcd-client-py"
 
+[project.optional-dependencies]
+dev = [
+    "ruff>=0.8.5",
+    "mypy>=1.13.0",
+]
+
 [build-system]
 requires = ["maturin>=1.7,<2.0"]
 build-backend = "maturin"
+
+# === Tool Configuration ===
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+extend-exclude = ["*.pyi"]
+preview = true
+
+[tool.ruff.lint]
+preview = true
+ignore = [
+    "E501",   # Line too long (formatter handles)
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["etcd_client", "tests"]
+section-order = ["future", "standard-library", "third-party", "first-party", "local-folder"]
+
+[tool.mypy]
+python_version = "3.11"
+warn_return_any = true
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+warn_unreachable = true
+strict_equality = true
+extra_checks = true
+check_untyped_defs = true
+disallow_untyped_calls = false
+disallow_untyped_defs = false
+disallow_incomplete_defs = true
+disallow_untyped_decorators = false
+show_error_codes = true
+show_column_numbers = true
+pretty = true
+explicit_package_bases = true
+namespace_packages = true
+
+[[tool.mypy.overrides]]
+module = [
+    "trafaret.*",
+    "testcontainers.*",
+    "pytest.*",
+]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+disallow_incomplete_defs = false
+no_implicit_optional = false
+disable_error_code = ["union-attr"]

requirements.txt

@@ -81,7 +81,7 @@ impl PyClient {
         connect_options: Option<PyConnectOptions>,
         lock_options: Option<PyEtcdLockOption>,
     ) -> Self {
-        let connect_options = connect_options.unwrap_or(PyConnectOptions::default());
+        let connect_options = connect_options.unwrap_or_default();
         Self {
             endpoints,
             connect_options,
@@ -147,7 +147,11 @@ impl PyClient {
     }
 
     #[pyo3(signature = (*_args))]
-    fn __aexit__<'a>(&'a self, py: Python<'a>, _args: &Bound<'a, PyTuple>) -> PyResult<Bound<'a, PyAny>> {
+    fn __aexit__<'a>(
+        &'a self,
+        py: Python<'a>,
+        _args: &Bound<'a, PyTuple>,
+    ) -> PyResult<Bound<'a, PyAny>> {
         let lock_options = self.lock_options.clone();
 
         let lock_manager = if lock_options.is_some() {

src/client.rs

@@ -55,7 +55,12 @@ impl PyCommunicator {
         })
     }
 
-    fn put<'a>(&'a self, py: Python<'a>, key: Vec<u8>, value: Vec<u8>) -> PyResult<Bound<'a, PyAny>> {
+    fn put<'a>(
+        &'a self,
+        py: Python<'a>,
+        key: Vec<u8>,
+        value: Vec<u8>,
+    ) -> PyResult<Bound<'a, PyAny>> {
         let client = self.0.clone();
         future_into_py(py, async move {
             let mut client = client.lock().await;

src/communicator.rs

@@ -27,7 +27,12 @@ impl PyCompareOp {
         }
     }
 
-    pub fn __richcmp__(&self, py: Python, rhs: &PyCompareOp, op: PyO3CompareOp) -> PyResult<Py<PyAny>> {
+    pub fn __richcmp__(
+        &self,
+        py: Python,
+        rhs: &PyCompareOp,
+        op: PyO3CompareOp,
+    ) -> PyResult<Py<PyAny>> {
         match op {
             PyO3CompareOp::Eq => (self.0 == rhs.0)
                 .into_pyobject(py)

src/compare.rs

@@ -1,4 +1,9 @@
-use pyo3::{create_exception, exceptions::PyException, types::{PyDict, PyDictMethods}, PyErr, Python, *};
+use pyo3::{
+    create_exception,
+    exceptions::PyException,
+    types::{PyDict, PyDictMethods},
+    PyErr, Python, *,
+};
 use std::fmt::Debug;
 
 create_exception!(etcd_client, ClientError, PyException);