feat: remove deprecated methods (#6)

feat: remove deprecated methods

---------

Co-authored-by: A.Shpak <aleksander.shpak.als@gmail.com>

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-# This file is autogenerated by maturin v1.4.0
+# This file is autogenerated by maturin v1.5.1
 # To update, run
 #
 #    maturin generate-ci github --pytest
@@ -20,40 +20,52 @@ permissions:
 
 jobs:
   linux:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.platform.runner }}
     strategy:
       matrix:
-        target: [x86_64, x86, aarch64, armv7, s390x, ppc64le]
+        platform:
+          - runner: ubuntu-latest
+            target: x86_64
+          - runner: ubuntu-latest
+            target: x86
+          - runner: ubuntu-latest
+            target: aarch64
+          - runner: ubuntu-latest
+            target: armv7
+          - runner: ubuntu-latest
+            target: s390x
+          - runner: ubuntu-latest
+            target: ppc64le
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.10'
       - name: Build wheels
         uses: PyO3/maturin-action@v1
         with:
-          target: ${{ matrix.target }}
-          args: --release --out dist --interpreter python3.10
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist --find-interpreter
           sccache: 'true'
           manylinux: auto
       - name: Upload wheels
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: wheels
+          name: wheels-linux-${{ matrix.platform.target }}
           path: dist
       - name: pytest
-        if: ${{ startsWith(matrix.target, 'x86_64') }}
+        if: ${{ startsWith(matrix.platform.target, 'x86_64') }}
         shell: bash
         run: |
           set -e
           pip install epyxid --find-links dist --force-reinstall
           pip install pytest
           pytest
       - name: pytest
-        if: ${{ !startsWith(matrix.target, 'x86') && matrix.target != 'ppc64' }}
+        if: ${{ !startsWith(matrix.platform.target, 'x86') && matrix.platform.target != 'ppc64' }}
         uses: uraimo/run-on-arch-action@v2.5.0
         with:
-          arch: ${{ matrix.target }}
+          arch: ${{ matrix.platform.target }}
           distro: ubuntu22.04
           githubToken: ${{ github.token }}
           install: |
@@ -66,29 +78,33 @@ jobs:
             pytest
 
   windows:
-    runs-on: windows-latest
+    runs-on: ${{ matrix.platform.runner }}
     strategy:
       matrix:
-        target: [x64, x86]
+        platform:
+          - runner: windows-latest
+            target: x64
+          - runner: windows-latest
+            target: x86
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.10'
-          architecture: ${{ matrix.target }}
+          architecture: ${{ matrix.platform.target }}
       - name: Build wheels
         uses: PyO3/maturin-action@v1
         with:
-          target: ${{ matrix.target }}
-          args: --release --out dist --interpreter python3.10
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist --find-interpreter
           sccache: 'true'
       - name: Upload wheels
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: wheels
+          name: wheels-windows-${{ matrix.platform.target }}
           path: dist
       - name: pytest
-        if: ${{ !startsWith(matrix.target, 'aarch64') }}
+        if: ${{ !startsWith(matrix.platform.target, 'aarch64') }}
         shell: bash
         run: |
           set -e
@@ -97,28 +113,32 @@ jobs:
           pytest
 
   macos:
-    runs-on: macos-latest
+    runs-on: ${{ matrix.platform.runner }}
     strategy:
       matrix:
-        target: [x86_64, aarch64]
+        platform:
+          - runner: macos-latest
+            target: x86_64
+          - runner: macos-14
+            target: aarch64
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.10'
       - name: Build wheels
         uses: PyO3/maturin-action@v1
         with:
-          target: ${{ matrix.target }}
-          args: --release --out dist --interpreter python3.10
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist --find-interpreter
           sccache: 'true'
       - name: Upload wheels
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: wheels
+          name: wheels-macos-${{ matrix.platform.target }}
           path: dist
       - name: pytest
-        if: ${{ !startsWith(matrix.target, 'aarch64') }}
+        if: ${{ !startsWith(matrix.platform.target, 'aarch64') }}
         shell: bash
         run: |
           set -e
@@ -129,16 +149,16 @@ jobs:
   sdist:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Build sdist
         uses: PyO3/maturin-action@v1
         with:
           command: sdist
           args: --out dist
       - name: Upload sdist
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: wheels
+          name: wheels-sdist
           path: dist
 
   release:
@@ -147,13 +167,11 @@ jobs:
     if: "startsWith(github.ref, 'refs/tags/')"
     needs: [linux, windows, macos, sdist]
     steps:
-      - uses: actions/download-artifact@v3
-        with:
-          name: wheels
+      - uses: actions/download-artifact@v4
       - name: Publish to PyPI
         uses: PyO3/maturin-action@v1
         env:
           MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
         with:
           command: upload
-          args: --non-interactive --skip-existing *
+          args: --non-interactive --skip-existing wheels-*/*

Cargo.toml

@@ -1,6 +1,7 @@
 [package]
 name = "epyxid"
 edition = "2021"
+version = "0.2.0"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [lib]

epyxid.pyi

@@ -1,5 +1,7 @@
 from datetime import datetime
 
+__version__: str
+
 
 class XID:
     """
@@ -40,6 +42,8 @@ class XID:
         Extract the incrementing counter.
         """
 
+    def __hash__(self) -> int: ...
+
     def __bytes__(self) -> bytes: ...
 
     def __str__(self) -> str: ...

justfile

@@ -1,9 +1,10 @@
 #!/usr/bin/env just --justfile
 
-build:
-  maturin build \
-    --interpreter python3.8
+venv:
+  source venv/bin/activate
 
 tests:
-  maturin develop
-  pytest -v test_xid.py
+  maturin build --out dist --interpreter python
+  python3.8 -m pip install --no-index --find-links dist/ --force-reinstall epyxid
+  python3.8 -m pip install pytest
+  python3.8 -m pytest -v test_xid.py

pyproject.toml

@@ -5,7 +5,7 @@ requires-python = ">=3.8"
 authors = [
   {name = "Aleksandr Shpak", email = "shpaker@gmail.com"},
 ]
-version = "0.1.4"
+version = "0.2.0"
 readme = "README.md"
 license = { file = "LICENSE.txt" }
 keywords = [

src/lib.rs

@@ -1,22 +1,22 @@
-use std::str::FromStr;
-
-use pyo3::prelude::{pymodule, PyModule, PyResult, Python};
-use pyo3::wrap_pyfunction;
+use pyo3::prelude::{pymodule, wrap_pyfunction, Bound, PyModule, PyResult, Python};
 
 use crate::errors::XIDError;
 use crate::utils::{xid_create, xid_from_bytes, xid_from_str};
 use crate::wrapper::XID;
 
+const PY_MODULE_VERSION: &str = "0.2.0";
+
 mod errors;
 mod utils;
 mod wrapper;
 
 #[pymodule]
-fn epyxid(_py: Python, m: &PyModule) -> PyResult<()> {
+fn epyxid(py: Python<'_>, m: &Bound<'_, PyModule>) -> PyResult<()> {
     m.add_class::<XID>()?;
     m.add_function(wrap_pyfunction!(xid_create, m)?)?;
     m.add_function(wrap_pyfunction!(xid_from_str, m)?)?;
     m.add_function(wrap_pyfunction!(xid_from_bytes, m)?)?;
-    m.add("XIDError", _py.get_type::<XIDError>())?;
+    m.add("XIDError", py.get_type_bound::<XIDError>())?;
+    m.add("__version__", PY_MODULE_VERSION)?;
     Ok(())
 }

src/utils.rs

@@ -1,29 +1,30 @@
 use std::str::FromStr;
 
+use pyo3::prelude::PyBytesMethods;
 use pyo3::types::PyBytes;
-use pyo3::{pyfunction, PyResult};
+use pyo3::{pyfunction, Bound, PyResult};
 use xid::{Id, ParseIdError};
 
 use crate::errors::XIDError;
 use crate::wrapper::XID;
 
 #[pyfunction]
 pub fn xid_create() -> PyResult<XID> {
-    Ok(XID { inner: xid::new() })
+    Ok(XID(xid::new()))
 }
 
 #[pyfunction]
 pub fn xid_from_str(s: &str) -> PyResult<XID> {
     match Id::from_str(s) {
-        Ok(id) => Ok(XID { inner: id }),
+        Ok(id) => Ok(XID(id)),
         Err(error) => Err(XIDError::new_err(error.to_string())),
     }
 }
 
 #[pyfunction]
-pub fn xid_from_bytes(b: &PyBytes) -> PyResult<XID> {
+pub fn xid_from_bytes(b: Bound<PyBytes>) -> PyResult<XID> {
     match id_from_bytes(b.as_bytes()) {
-        Ok(value) => Ok(XID { inner: value }),
+        Ok(value) => Ok(XID(value)),
         Err(error) => Err(XIDError::new_err(error.to_string())),
     }
 }

src/wrapper.rs

@@ -1,47 +1,45 @@
-use std::str::FromStr;
+use std::hash::{DefaultHasher, Hash, Hasher};
 
 use pyo3::types::{PyBytes, PyDateTime};
-use pyo3::{pyclass, pymethods, PyResult, Python};
+use pyo3::{pyclass, pymethods, Bound, PyResult, Python};
 use xid::Id;
 
 #[pyclass]
-pub struct XID {
-    pub inner: Id,
-}
+pub struct XID(pub Id);
 
 #[pymethods]
 impl XID {
-    fn as_bytes<'p>(&self, _py: Python<'p>) -> &'p PyBytes {
-        PyBytes::new(_py, self.inner.as_bytes())
+    fn as_bytes<'p>(&self, _py: Python<'p>) -> Bound<'p, PyBytes> {
+        PyBytes::new_bound(_py, self.0.as_bytes())
     }
 
     fn to_str(&self) -> String {
-        self.inner.to_string()
+        self.0.to_string()
     }
 
     #[getter]
-    fn machine<'p>(&self, _py: Python<'p>) -> &'p PyBytes {
-        PyBytes::new(_py, &self.inner.machine())
+    fn machine<'p>(&self, _py: Python<'p>) -> Bound<'p, PyBytes> {
+        PyBytes::new_bound(_py, &self.0.machine())
     }
 
     #[getter]
     fn pid(&self) -> u16 {
-        self.inner.pid()
+        self.0.pid()
     }
 
     #[getter]
-    fn time<'p>(&self, _py: Python<'p>) -> PyResult<&'p PyDateTime> {
-        let raw = self.inner.as_bytes();
+    fn time<'p>(&self, _py: Python<'p>) -> PyResult<Bound<'p, PyDateTime>> {
+        let raw = self.0.as_bytes();
         let unix_ts = u32::from_be_bytes([raw[0], raw[1], raw[2], raw[3]]);
-        PyDateTime::from_timestamp(_py, unix_ts as f64, None)
+        PyDateTime::from_timestamp_bound(_py, unix_ts as f64, None)
     }
 
     #[getter]
     fn counter(&self) -> u32 {
-        self.inner.counter()
+        self.0.counter()
     }
 
-    fn __bytes__<'p>(&self, _py: Python<'p>) -> &'p PyBytes {
+    fn __bytes__<'p>(&self, _py: Python<'p>) -> Bound<'p, PyBytes> {
         self.as_bytes(_py)
     }
 
@@ -76,4 +74,10 @@ impl XID {
     fn __ge__(&self, object: &XID) -> bool {
         self.to_str() >= object.to_str()
     }
+
+    fn __hash__(&self) -> u64 {
+        let mut hasher = DefaultHasher::new();
+        self.0.hash(&mut hasher);
+        hasher.finish()
+    }
 }

test_xid.py

@@ -30,6 +30,11 @@ def test_from_bytes_valid() -> None:
     assert str(xid) == XID_STR
 
 
+def test_hash() -> None:
+    xid = xid_from_bytes(XID_BYTES)
+    assert isinstance(hash(xid), int)
+
+
 def test_from_bytes_invalid_length() -> None:
     with raises(ValueError):
         xid_from_bytes(bytes([0x4d, 0x88, 0xe1, 0x5b, 0x60, 0xf4, 0x86, 0xe4, 0x28, 0x41, 0x2d]))