Merge pull request #1 from nohehf/feat/support-more-languages

Feat/support more languages

Author: nohehf

.github/workflows/CI.yml

@@ -12,6 +12,10 @@ on:
   pull_request:
   workflow_dispatch:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 permissions:
   contents: read
 
@@ -31,7 +35,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: '3.11'
       - name: Build wheels
         uses: PyO3/maturin-action@v1
         with:
@@ -58,7 +62,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: '3.11'
           architecture: ${{ matrix.platform.target }}
       - name: Build wheels
         uses: PyO3/maturin-action@v1
@@ -85,7 +89,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: '3.11'
       - name: Build wheels
         uses: PyO3/maturin-action@v1
         with:

Cargo.lock

@@ -12,5 +12,7 @@ crate-type = ["cdylib"]
 pyo3 = "0.20.0"
 stack-graphs = { version = "0.13.0", features = ["storage"] }
 tree-sitter-stack-graphs = { version = "0.8.1", features = ["cli"] }
+tree-sitter-stack-graphs-java = "0.3.0"
 tree-sitter-stack-graphs-javascript = "0.1.0"
 tree-sitter-stack-graphs-python = "0.1.0"
+tree-sitter-stack-graphs-typescript = "0.2.0"

Cargo.toml

@@ -0,0 +1,8 @@
+.PHONY: develop
+develop:
+	maturin develop
+
+
+test: develop
+    ## TODO: Add actual tests with pytest
+	python tests/test.py

Makefile

@@ -8,26 +8,35 @@ This is a proof of concept draft, to test scripting utilities using stack-graphs
 
 It uses pyo3 and maturin to generate the bindings.
 
-## Ressources
+## Installation & Usage
 
-https://pyo3.rs/v0.21.2/getting-started
-
-## Setup
+```bash
+pip install stack-graphs-python-bindings # or poetry, ...
+```
 
-TODO
+```python
+from stack_graphs_python import index, query_definition, Position
 
-```bash
-pipx install maturin
+# ...
 ```
 
+You can refer to the example in [test/test.py](https://github.com/nohehf/stack-graphs-python-bindings/blob/main/tests/test.py) for a concrete usage example.
+
 ## Development
 
-TODO
+### Ressources
+
+https://pyo3.rs/v0.21.2/getting-started
+
+### Setup
 
 ```bash
-maturin develop
+pipx install maturin # or pip, ...
 ```
 
-## Install
+### Testing
 
-TODO
+```bash
+maturin develop
+python tests/test.py
+```

README.md

@@ -4,7 +4,7 @@ build-backend = "maturin"
 
 [project]
 name = "stack-graphs-python-bindings"
-requires-python = ">=3.8"
+requires-python = ">=3.11"
 classifiers = [
     "Programming Language :: Rust",
     "Programming Language :: Python :: Implementation :: CPython",

pyproject.toml

@@ -0,0 +1,61 @@
+use std::fmt::Display;
+
+use pyo3::prelude::*;
+
+use tree_sitter_stack_graphs::cli::util::{SourcePosition, SourceSpan};
+
+#[pyclass]
+#[derive(Clone)]
+pub enum Language {
+    Python,
+    JavaScript,
+    TypeScript,
+    Java,
+}
+
+#[pyclass]
+#[derive(Clone)]
+pub struct Position {
+    #[pyo3(get, set)]
+    path: String,
+    #[pyo3(get, set)]
+    line: usize,
+    #[pyo3(get, set)]
+    column: usize,
+}
+
+#[pymethods]
+impl Position {
+    #[new]
+    fn new(path: String, line: usize, column: usize) -> Self {
+        Position { path, line, column }
+    }
+}
+
+impl Display for Position {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{}:{}:{}", self.path, self.line, self.column)
+    }
+}
+
+impl From<Position> for SourcePosition {
+    fn from(pos: Position) -> Self {
+        SourcePosition {
+            path: pos.path.into(),
+            line: pos.line,
+            column: pos.column,
+        }
+    }
+}
+
+impl Into<Position> for SourceSpan {
+    fn into(self) -> Position {
+        Position {
+            // TODO(@nohehf): Unwrap is unsafe
+            path: self.path.to_str().unwrap().to_string(),
+            line: self.span.start.line,
+            // TODO(@nohehf): Handle both utf8 and utf16
+            column: self.span.start.column.utf8_offset,
+        }
+    }
+}

src/classes.rs

@@ -1,10 +1,9 @@
-use core::fmt::Display;
-
 use pyo3::prelude::*;
 
+mod classes;
 mod stack_graphs_wrapper;
 
-use tree_sitter_stack_graphs::cli::util::{SourcePosition, SourceSpan};
+use classes::{Language, Position};
 
 /// Formats the sum of two numbers as string.
 #[pyfunction]
@@ -13,61 +12,19 @@ fn sum_as_string(a: usize, b: usize) -> PyResult<String> {
 }
 /// Indexes the given paths into stack graphs, and stores the results in the given database.
 #[pyfunction]
-fn index(paths: Vec<String>, db_path: String) -> PyResult<()> {
+fn index(paths: Vec<String>, db_path: String, language: Language) -> PyResult<()> {
+    // TODO(@nohehf): Add a verbose mode to toggle the logs
     println!("Indexing paths: {:?}", paths);
     println!("Database path: {:?}", db_path);
 
     let paths: Vec<std::path::PathBuf> =
         paths.iter().map(|p| std::path::PathBuf::from(p)).collect();
 
-    Ok(stack_graphs_wrapper::index(paths, &db_path)?)
-}
-
-#[pyclass]
-#[derive(Clone)]
-struct Position {
-    #[pyo3(get, set)]
-    path: String,
-    #[pyo3(get, set)]
-    line: usize,
-    #[pyo3(get, set)]
-    column: usize,
-}
-
-#[pymethods]
-impl Position {
-    #[new]
-    fn new(path: String, line: usize, column: usize) -> Self {
-        Position { path, line, column }
-    }
-}
-
-impl Display for Position {
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        write!(f, "{}:{}:{}", self.path, self.line, self.column)
-    }
-}
-
-impl From<Position> for SourcePosition {
-    fn from(pos: Position) -> Self {
-        SourcePosition {
-            path: pos.path.into(),
-            line: pos.line,
-            column: pos.column,
-        }
-    }
-}
-
-impl Into<Position> for SourceSpan {
-    fn into(self) -> Position {
-        Position {
-            // TODO(@nohehf): Unwrap is unsafe
-            path: self.path.to_str().unwrap().to_string(),
-            line: self.span.start.line,
-            // TODO(@nohehf): Handle both utf8 and utf16
-            column: self.span.start.column.utf8_offset,
-        }
-    }
+    Ok(stack_graphs_wrapper::index(
+        paths,
+        &db_path,
+        language.into(),
+    )?)
 }
 
 /// Indexes the given paths into stack graphs, and stores the results in the given database.
@@ -96,5 +53,6 @@ fn stack_graphs_python(_py: Python, m: &PyModule) -> PyResult<()> {
     m.add_function(wrap_pyfunction!(index, m)?)?;
     m.add_function(wrap_pyfunction!(query_definition, m)?)?;
     m.add_class::<Position>()?;
+    m.add_class::<Language>()?;
     Ok(())
 }