Include object_store version and source in Python dist (#408)

* Include object_store version and source

* Add version information

Author: kylebarron

Cargo.lock

@@ -45,3 +45,6 @@ url = { workspace = true }
 reqwest = { version = "*", default-features = false, features = [
     "rustls-tls-native-roots",
 ] }
+
+[build-dependencies]
+cargo-lock = "10.1.0"

obstore/Cargo.toml

@@ -0,0 +1,47 @@
+use cargo_lock::{Lockfile, SourceId, Version};
+use std::ffi::OsString;
+use std::io::ErrorKind;
+use std::path::{Path, PathBuf};
+use std::{env, io};
+
+fn main() {
+    let lockfile_location = get_lockfile_location().unwrap();
+    let (version, source) = read_lockfile(&lockfile_location);
+
+    println!("cargo:rustc-env=OBJECT_STORE_VERSION={}", version);
+    println!(
+        "cargo:rustc-env=OBJECT_STORE_SOURCE={}",
+        source.map(|s| s.to_string()).unwrap_or("".to_string())
+    );
+}
+
+fn get_lockfile_location() -> io::Result<PathBuf> {
+    let path = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
+
+    let cargo_lock = OsString::from("Cargo.lock");
+
+    for ancestor in path.as_path().ancestors() {
+        for entry in ancestor.read_dir()? {
+            let entry = entry?;
+            if entry.file_name() == cargo_lock {
+                return Ok(entry.path());
+            }
+        }
+    }
+
+    Err(io::Error::new(
+        ErrorKind::NotFound,
+        "Ran out of places to find Cargo.toml",
+    ))
+}
+
+fn read_lockfile(path: &Path) -> (Version, Option<SourceId>) {
+    let lockfile = Lockfile::load(path).unwrap();
+    let idx = lockfile
+        .packages
+        .iter()
+        .position(|p| p.name.as_str() == "object_store")
+        .unwrap();
+    let package = &lockfile.packages[idx];
+    (package.version.clone(), package.source.clone())
+}

obstore/build.rs

@@ -2,12 +2,10 @@
 
 from . import _obstore, store
 from ._obstore import *  # noqa: F403
-from ._obstore import ___version
 
 if TYPE_CHECKING:
     from . import exceptions  # noqa: TC004
 
-__version__: str = ___version()
 
-__all__ = ["__version__", "exceptions", "store"]
+__all__ = ["exceptions", "store"]
 __all__ += _obstore.__all__

obstore/python/obstore/__init__.py

@@ -41,7 +41,9 @@ from ._rename import rename, rename_async
 from ._scheme import parse_scheme
 from ._sign import HTTP_METHOD, SignCapableStore, sign, sign_async
 
-def ___version() -> str: ...
+__version__: str
+_object_store_version: str
+_object_store_source: str
 
 __all__ = [
     "HTTP_METHOD",
@@ -65,6 +67,9 @@ __all__ = [
     "SuffixRange",
     "UpdateVersion",
     "WritableFile",
+    "__version__",
+    "_object_store_source",
+    "_object_store_version",
     "_store",
     "copy",
     "copy_async",

obstore/python/obstore/_obstore.pyi

@@ -20,11 +20,8 @@ mod utils;
 use pyo3::prelude::*;
 
 const VERSION: &str = env!("CARGO_PKG_VERSION");
-
-#[pyfunction]
-fn ___version() -> &'static str {
-    VERSION
-}
+const OBJECT_STORE_VERSION: &str = env!("OBJECT_STORE_VERSION");
+const OBJECT_STORE_SOURCE: &str = env!("OBJECT_STORE_SOURCE");
 
 /// Raise RuntimeWarning for debug builds
 #[pyfunction]
@@ -51,7 +48,9 @@ fn check_debug_build(_py: Python) -> PyResult<()> {
 fn _obstore(py: Python, m: &Bound<PyModule>) -> PyResult<()> {
     check_debug_build(py)?;
 
-    m.add_wrapped(wrap_pyfunction!(___version))?;
+    m.add("__version__", VERSION)?;
+    m.add("_object_store_version", OBJECT_STORE_VERSION)?;
+    m.add("_object_store_source", OBJECT_STORE_SOURCE)?;
 
     pyo3_object_store::register_store_module(py, m, "obstore", "_store")?;
     pyo3_object_store::register_exceptions_module(py, m, "obstore", "exceptions")?;

obstore/src/lib.rs

@@ -0,0 +1,7 @@
+from obstore import __version__, _object_store_source, _object_store_version
+
+
+def test_versions_are_str():
+    assert isinstance(__version__, str)
+    assert isinstance(_object_store_version, str)
+    assert isinstance(_object_store_source, str)