From a3e41cc819b41c5f29aa53b2108bfbdfc54a26bf Mon Sep 17 00:00:00 2001 From: konstin Date: Fri, 30 Aug 2019 15:02:00 +0200 Subject: [PATCH] Release 0.8.0 --- CHANGELOG.md | 5 +++-- Cargo.toml | 4 ++-- README.md | 4 ++-- guide/src/advanced.md | 2 +- guide/src/class.md | 6 +++--- guide/src/conversions.md | 10 +++++----- guide/src/exception.md | 16 ++++++++-------- guide/src/get_started.md | 4 ++-- guide/src/parallelism.md | 2 +- pyo3-derive-backend/Cargo.toml | 2 +- pyo3cls/Cargo.toml | 4 ++-- src/lib.rs | 4 ++-- 12 files changed, 32 insertions(+), 31 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1f1dd0cc327..cb154cdd349 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). -## [0.8.0] +## [0.8.0] - 2018-09-05 ### Added @@ -317,7 +317,8 @@ Yanked * Initial release -[Unreleased]: https://github.com/pyo3/pyo3/compare/v0.7.0...HEAD +[Unreleased]: https://github.com/pyo3/pyo3/compare/v0.8.0...HEAD +[0.8.0]: https://github.com/pyo3/pyo3/compare/v0.7.0...v0.8.0 [0.7.0]: https://github.com/pyo3/pyo3/compare/v0.6.0...v0.7.0 [0.6.0]: https://github.com/pyo3/pyo3/compare/v0.5.3...v0.6.0 [0.5.3]: https://github.com/pyo3/pyo3/compare/v0.5.2...v0.5.3 diff --git a/Cargo.toml b/Cargo.toml index e6cb833d808..d42f8417896 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "pyo3" -version = "0.7.0" +version = "0.8.0" description = "Bindings to Python interpreter" authors = ["PyO3 Project and Contributors "] readme = "README.md" @@ -22,7 +22,7 @@ appveyor = { repository = "fafhrd91/pyo3" } libc = "0.2.62" spin = "0.5.1" num-traits = "0.2.8" -pyo3cls = { path = "pyo3cls", version = "=0.7.0" } +pyo3cls = { path = "pyo3cls", version = "=0.8.0" } num-complex = { version = "0.2.3", optional = true } inventory = "0.1.4" indoc = "0.3.4" diff --git a/README.md b/README.md index f8249437db3..5cd37589c5c 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ name = "string_sum" crate-type = ["cdylib"] [dependencies.pyo3] -version = "0.7.0" +version = "0.8.0" features = ["extension-module"] ``` @@ -91,7 +91,7 @@ Add `pyo3` to your `Cargo.toml` like this: ```toml [dependencies] -pyo3 = "0.7.0" +pyo3 = "0.8.0" ``` Example program displaying the value of `sys.version` and the current user name: diff --git a/guide/src/advanced.md b/guide/src/advanced.md index aa8950bf824..02ec165b9fb 100644 --- a/guide/src/advanced.md +++ b/guide/src/advanced.md @@ -12,7 +12,7 @@ Currently, [#341](https://github.com/PyO3/pyo3/issues/341) causes `cargo test` t ```toml [dependencies.pyo3] -version = "0.7.0" +version = "0.8.0" [features] extension-module = ["pyo3/extension-module"] diff --git a/guide/src/class.md b/guide/src/class.md index 383d8b2b6b1..c9ae7a5229d 100644 --- a/guide/src/class.md +++ b/guide/src/class.md @@ -477,7 +477,7 @@ each protocol implementation block has to be annotated with the `#[pyproto]` att ### Basic object customization -The [`PyObjectProtocol`](https://docs.rs/pyo3/0.7.0/pyo3/class/basic/trait.PyObjectProtocol.html) trait provides several basic customizations. +The [`PyObjectProtocol`](https://docs.rs/pyo3/0.8.0/pyo3/class/basic/trait.PyObjectProtocol.html) trait provides several basic customizations. #### Attribute access @@ -531,7 +531,7 @@ Each method corresponds to Python's `self.attr`, `self.attr = value` and `del se If your type owns references to other Python objects, you will need to integrate with Python's garbage collector so that the GC is aware of those references. -To do this, implement the [`PyGCProtocol`](https://docs.rs/pyo3/0.7.0/pyo3/class/gc/trait.PyGCProtocol.html) trait for your struct. +To do this, implement the [`PyGCProtocol`](https://docs.rs/pyo3/0.8.0/pyo3/class/gc/trait.PyGCProtocol.html) trait for your struct. It includes two methods `__traverse__` and `__clear__`. These correspond to the slots `tp_traverse` and `tp_clear` in the Python C API. `__traverse__` must call `visit.call()` for each reference to another Python object. @@ -587,7 +587,7 @@ struct GCTracked {} // Fails because it does not implement PyGCProtocol ### Iterator Types Iterators can be defined using the -[`PyIterProtocol`](https://docs.rs/pyo3/0.7.0/pyo3/class/iter/trait.PyIterProtocol.html) trait. +[`PyIterProtocol`](https://docs.rs/pyo3/0.8.0/pyo3/class/iter/trait.PyIterProtocol.html) trait. It includes two methods `__iter__` and `__next__`: * `fn __iter__(slf: PyRefMut) -> PyResult>` * `fn __next__(slf: PyRefMut) -> PyResult>>` diff --git a/guide/src/conversions.md b/guide/src/conversions.md index 4924f89b003..43d1b132c35 100644 --- a/guide/src/conversions.md +++ b/guide/src/conversions.md @@ -106,8 +106,8 @@ Many conversions in PyO3 can't use `std::convert::Into` because they need a GIL Eventually, traits such as `ToPyObject` will be replaced by this trait and a `FromPy` trait will be added that will implement `IntoPy`, just like with `From` and `Into`. -[`ToPyObject`]: https://docs.rs/pyo3/0.7.0/pyo3/trait.ToPyObject.html -[PyObject]: https://docs.rs/pyo3/0.7.0/pyo3/struct.PyObject.html -[PyTuple]: https://docs.rs/pyo3/0.7.0/pyo3/types/struct.PyTuple.html -[ObjectProtocol]: https://docs.rs/pyo3/0.7.0/pyo3/trait.ObjectProtocol.html -[IntoPyDict]: https://docs.rs/pyo3/0.7.0/pyo3/types/trait.IntoPyDict.html +[`ToPyObject`]: https://docs.rs/pyo3/0.8.0/pyo3/trait.ToPyObject.html +[PyObject]: https://docs.rs/pyo3/0.8.0/pyo3/struct.PyObject.html +[PyTuple]: https://docs.rs/pyo3/0.8.0/pyo3/types/struct.PyTuple.html +[ObjectProtocol]: https://docs.rs/pyo3/0.8.0/pyo3/trait.ObjectProtocol.html +[IntoPyDict]: https://docs.rs/pyo3/0.8.0/pyo3/types/trait.IntoPyDict.html diff --git a/guide/src/exception.md b/guide/src/exception.md index 0f3b07da3dc..d9341f0f0b3 100644 --- a/guide/src/exception.md +++ b/guide/src/exception.md @@ -35,7 +35,7 @@ fn main() { ## Raise an exception -To raise an exception, first you need to obtain an exception type and construct a new [`PyErr`](https://docs.rs/pyo3/0.7.0/pyo3/struct.PyErr.html), then call the [`PyErr::restore()`](https://docs.rs/pyo3/0.7.0/pyo3/struct.PyErr.html#method.restore) method to write the exception back to the Python interpreter's global state. +To raise an exception, first you need to obtain an exception type and construct a new [`PyErr`](https://docs.rs/pyo3/0.8.0/pyo3/struct.PyErr.html), then call the [`PyErr::restore()`](https://docs.rs/pyo3/0.8.0/pyo3/struct.PyErr.html#method.restore) method to write the exception back to the Python interpreter's global state. ```rust use pyo3::{Python, PyErr}; @@ -50,7 +50,7 @@ fn main() { } ``` -If you already have a Python exception instance, you can simply call [`PyErr::from_instance()`](https://docs.rs/pyo3/0.7.0/pyo3/struct.PyErr.html#method.from_instance). +If you already have a Python exception instance, you can simply call [`PyErr::from_instance()`](https://docs.rs/pyo3/0.8.0/pyo3/struct.PyErr.html#method.from_instance). ```rust,ignore PyErr::from_instance(py, err).restore(py); @@ -77,7 +77,7 @@ fn my_func(arg: PyObject) -> PyResult<()> { ## Check exception type Python has an [`isinstance`](https://docs.python.org/3/library/functions.html#isinstance) method to check an object's type, -in PyO3 there is a [`Python::is_instance()`](https://docs.rs/pyo3/0.7.0/pyo3/struct.Python.html#method.is_instance) method which does the same thing. +in PyO3 there is a [`Python::is_instance()`](https://docs.rs/pyo3/0.8.0/pyo3/struct.Python.html#method.is_instance) method which does the same thing. ```rust use pyo3::Python; @@ -93,7 +93,7 @@ fn main() { } ``` -[`Python::is_instance()`](https://docs.rs/pyo3/0.7.0/pyo3/struct.Python.html#method.is_instance) calls the underlying [`PyType::is_instance`](https://docs.rs/pyo3/0.7.0/pyo3/types/struct.PyType.html#method.is_instance) method to do the actual work. +[`Python::is_instance()`](https://docs.rs/pyo3/0.8.0/pyo3/struct.Python.html#method.is_instance) calls the underlying [`PyType::is_instance`](https://docs.rs/pyo3/0.8.0/pyo3/types/struct.PyType.html#method.is_instance) method to do the actual work. To check the type of an exception, you can simply do: @@ -110,10 +110,10 @@ err.is_instance::(py); ## Handle Rust Errors -The vast majority of operations in this library will return [`PyResult`](https://docs.rs/pyo3/0.7.0/pyo3/prelude/type.PyResult.html). +The vast majority of operations in this library will return [`PyResult`](https://docs.rs/pyo3/0.8.0/pyo3/prelude/type.PyResult.html). This is an alias for the type `Result`. -A [`PyErr`](https://docs.rs/pyo3/0.7.0/pyo3/struct.PyErr.html) represents a Python exception. +A [`PyErr`](https://docs.rs/pyo3/0.8.0/pyo3/struct.PyErr.html) represents a Python exception. Errors within the PyO3 library are also exposed as Python exceptions. The PyO3 library handles Python exceptions in two stages. During the first stage, a `PyErr` instance is @@ -124,7 +124,7 @@ In simple cases, for custom errors adding an implementation of `std::convert::Fr for this custom error is enough. `PyErr::new` accepts an argument in the form of `ToPyObject + 'static`. If the `'static` constraint can not be satisfied or more complex arguments are required, the -[`PyErrArguments`](https://docs.rs/pyo3/0.7.0/pyo3/trait.PyErrArguments.html) +[`PyErrArguments`](https://docs.rs/pyo3/0.8.0/pyo3/trait.PyErrArguments.html) trait can be implemented. In that case, actual exception argument creation is delayed until a `Python` object is available. @@ -202,5 +202,5 @@ fn tell(file: PyObject) -> PyResult { ``` -[`pyo3::exceptions`](https://docs.rs/pyo3/0.7.0/pyo3/exceptions/index.html) +[`pyo3::exceptions`](https://docs.rs/pyo3/0.8.0/pyo3/exceptions/index.html) defines exceptions for several standard library modules. diff --git a/guide/src/get_started.md b/guide/src/get_started.md index 883c89059a7..de1c1ae31f9 100644 --- a/guide/src/get_started.md +++ b/guide/src/get_started.md @@ -40,7 +40,7 @@ name = "string_sum" crate-type = ["cdylib"] [dependencies.pyo3] -version = "0.7.0" +version = "0.8.0" features = ["extension-module"] ``` @@ -85,7 +85,7 @@ Add `pyo3` to your `Cargo.toml` like this: ```toml [dependencies] -pyo3 = "0.7.0" +pyo3 = "0.8.0" ``` Example program displaying the value of `sys.version` and the current user name: diff --git a/guide/src/parallelism.md b/guide/src/parallelism.md index 9d07e722858..7127fc0ac7f 100644 --- a/guide/src/parallelism.md +++ b/guide/src/parallelism.md @@ -4,7 +4,7 @@ CPython has the infamous GIL (Global Interpreter Lock), which prevents developer from getting true parallelism when running pure Python code. With PyO3, you can release the GIL when executing Rust code to achieve true parallelism. -The [`Python::allow_threads`](https://docs.rs/pyo3/0.7.0/pyo3/struct.Python.html#method.allow_threads) +The [`Python::allow_threads`](https://docs.rs/pyo3/0.8.0/pyo3/struct.Python.html#method.allow_threads) method temporarily releases the GIL, thus allowing other Python threads to run. ```rust,ignore diff --git a/pyo3-derive-backend/Cargo.toml b/pyo3-derive-backend/Cargo.toml index ada5985161b..9df8142fcc7 100644 --- a/pyo3-derive-backend/Cargo.toml +++ b/pyo3-derive-backend/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "pyo3-derive-backend" -version = "0.7.0" +version = "0.8.0" description = "Code generation for PyO3 package" authors = ["PyO3 Project and Contributors "] keywords = ["pyo3", "python", "cpython", "ffi"] diff --git a/pyo3cls/Cargo.toml b/pyo3cls/Cargo.toml index a7c3017f01c..26760cbd96e 100644 --- a/pyo3cls/Cargo.toml +++ b/pyo3cls/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "pyo3cls" -version = "0.7.0" +version = "0.8.0" description = "Proc macros for PyO3 package" authors = ["PyO3 Project and Contributors "] keywords = ["pyo3", "python", "cpython", "ffi"] @@ -17,7 +17,7 @@ proc-macro = true quote = "1" proc-macro2 = "1" syn = { version = "1", features = ["full", "extra-traits"] } -pyo3-derive-backend = { path = "../pyo3-derive-backend", version = "=0.7.0" } +pyo3-derive-backend = { path = "../pyo3-derive-backend", version = "=0.8.0" } [features] unsound-subclass = ["pyo3-derive-backend/unsound-subclass"] diff --git a/src/lib.rs b/src/lib.rs index 48d5948571e..788ccd81f9c 100755 --- a/src/lib.rs +++ b/src/lib.rs @@ -48,7 +48,7 @@ //! crate-type = ["cdylib"] //! //! [dependencies.pyo3] -//! version = "0.7.0" +//! version = "0.8.0" //! features = ["extension-module"] //! ``` //! @@ -93,7 +93,7 @@ //! //! ```toml //! [dependencies] -//! pyo3 = "0.7.0" +//! pyo3 = "0.8.0" //! ``` //! //! Example program displaying the value of `sys.version`: