e73c795967
docs: fix typos
2023-12-07 10:10:15 +01:00
07726aefc4
Merge pull request #3609 from wyfo/async_receiver
...
feat: allow async methods to accept `&self`/`&mut self`
2023-12-07 07:38:25 +00:00
f34c70c2da
feat: allow async methods to accept `&self`/`&mut self`
2023-12-07 07:42:10 +01:00
ed87637ebb
replace `PyTryFrom` by splitting `PyTypeInfo`
2023-12-05 08:01:30 +03:00
8a674c2bd3
feat: add `coroutine::CancelHandle`
2023-12-04 07:46:51 +01:00
5c6d49084f
remove all functionality deprecated in 0.19
2023-11-27 22:02:19 +00:00
1203921d5c
Merge pull request #3456 from aldanor/feature/either
...
Add conversion support for `either::Either`
2023-11-25 09:37:49 +00:00
bead83f4b0
docs: fixup docs for smallvec feature
2023-11-24 22:11:40 +00:00
a75464ee26
add conversion support for `either::Either`
2023-11-24 22:09:34 +00:00
627841f1e2
feat: support `async fn` in macros with coroutine implementation
2023-11-22 20:25:36 +01:00
bd0174aa5d
Change return types of `py.None()`, `py.NotImplemented()` and `py.Ellipsis()` to typed singletons
2023-11-17 16:16:19 +00:00
0ff84d250e
fix missing char conversion
2023-11-10 09:27:01 -05:00
2fbc02d06c
Finish rename
2023-10-26 19:02:06 -05:00
fc787eabd2
Update guide/src/class.md
...
Co-authored-by: Bruno Kolenbrander <59372212+mejrs@users.noreply.github.com>
2023-10-26 18:58:43 -05:00
48c90d9586
Add example of dynamic return type in the "Python classes" section of the guide.
2023-10-26 17:13:32 -05:00
7534c31a6d
Note about `pyenv activate` and `pyenv virtualenv` commands
...
Co-authored-by: Niko Matsakis <niko@alum.mit.edu>
2023-10-26 08:21:31 +01:00
98346dd137
docs: improve detail around pyenv install
2023-10-25 23:29:20 +01:00
2ca8e573a4
remove comparison to rust-cpython
2023-10-15 22:03:24 +01:00
e1d4173827
Fix bug in default implementation of `__ne__`
2023-10-11 09:48:06 +01:00
f335f42197
Merge pull request #3446 from davidhewitt/relax-import-check
...
relax multiple-import check to only prevent subinterpreters
2023-09-29 16:35:31 +00:00
25b2acb0eb
fix some dead links
2023-09-29 13:24:00 +08:00
f17e703167
return existing module on Python 3.9 and up
2023-09-23 11:13:39 +01:00
535a255bae
Fix a typo in a documentation page title
2023-09-21 21:11:27 +01:00
bcb01049cc
Merge pull request #3404 from davidhewitt/fix-dealloc
...
call PyObject_GC_Untrack before deallocating
2023-09-11 05:18:34 +00:00
e28403e772
call PyObject_GC_Untrack before deallocating
2023-09-09 22:29:58 +01:00
c7f834ad87
add migration guide entry for `PyDict::get_item`
2023-09-09 13:05:51 +01:00
6e24fb6643
guide: Add `playground.runnable` = false to book.toml
2023-09-05 22:28:43 +02:00
e67b283b25
Merge pull request #3358 from alex/ptr-unsafe-trait
...
fixes #3325 -- mark `AsPyPointer` as `unsafe trait`
2023-09-04 05:05:56 +00:00
4c46d81afd
simplify thread checker implementation
2023-09-03 14:15:26 +01:00
cc1aa598cd
Merge pull request #3411 from OliverFM/main
...
Update docs with fresher bazel example
2023-08-29 06:17:51 +00:00
9714f819f0
Update docs with fresher bazel example
2023-08-29 06:44:22 +01:00
2855b9d508
Mention no subclassing of Python classes in docs
2023-08-28 12:34:13 +02:00
df5aa77800
fixes #3325 -- mark `AsPyPointer` as `unsafe trait`
2023-08-18 10:16:34 -04:00
9363491d54
Merge pull request #3384 from DataTriny/pyclass_rename_variants
...
Add `rename_all` attribute to `#[pyclass]`
2023-08-16 19:06:37 +00:00
f02fe9478d
Make rename_all accept a renaming rule, allow applying it to classes as well
2023-08-15 10:15:48 +02:00
5ad55d2dc7
Revert "Fix typos and other minor touchups to guide"
...
This reverts commit 24eee46128
2023-08-15 08:55:41 +01:00
5061b501a9
Remove IntoPyPointer
...
it wasn't used in any public APIs following #3359
2023-08-14 16:28:20 -04:00
a9e9ec628d
Add attribute to
2023-08-13 18:25:07 +02:00
64adab1a76
add as_ptr and into_ptr inherent methods
2023-08-11 10:49:42 +01:00
1e5a49557d
Makes PathBuf FromPyObject implementation work on all os.PathLike
...
PyOS_FSPath is in abi3-py36
2023-08-08 22:15:56 +02:00
5bcb513add
Update outdated link in python_typing_hints.md and fix typos
2023-07-14 15:50:14 +02:00
f3d7cf6fac
Tiny grammar fix in error_handling.md
2023-07-12 15:51:18 +02:00
89b9bc384a
Merge pull request #3304 from PyO3/guide-perf-section
...
Start adding a performance section to the guide.
2023-07-11 19:36:56 +00:00
092b73aa48
Two is not three
2023-07-11 13:56:34 +02:00
bedb682d0e
Add another performance subsection on implicit access to GIL token.
2023-07-09 15:02:12 +02:00
ff78b92e77
Start adding a performance section to the guide.
2023-07-09 14:32:59 +02:00
23d1a6d307
add some missing type conversions to the guide
2023-07-03 21:36:17 +01:00
0b78bb851e
Allow `#[new]` to return existing instances
...
fixes #2384
2023-07-02 19:57:53 -04:00
23bdd4337f
Fix typos and add punctuation recommended by grammarly in Class.md
2023-06-28 13:46:13 +02:00
de9d760462
Add conversions between Rust Path/PathBuf and Python str / pathlib.Path
2023-06-25 20:40:51 +02:00
684002daf5
Format recently modified code example from the guide.
2023-06-16 12:46:26 +02:00
2996f92ade
Extend guide section on classes regarding free functions
...
It might not be obvious from the reading the sections on free functions and on
classes that they combine in a frictionless manner, i.e. class instances can be
parameters to free functions in the same manner that the self parameters of
instance methods are handled.
This also explicitly calls out the interaction between `Clone` and
`FromPyObject` for classes.
2023-06-16 08:44:34 +02:00
a0c85bb649
Merge pull request #3240 from davidhewitt/maturin-versions
...
bump maturin version in example files
2023-06-14 08:24:31 +00:00
5fd5dcba44
bump maturin version in example files
2023-06-14 08:45:32 +01:00
4f3fcdbf0f
remove all functionality deprecated in PyO3 0.18
2023-06-13 22:27:43 +01:00
0d30bb7d3d
Bump Rust edition to 2021 and make current Clippy happy.
2023-06-07 21:15:38 +02:00
dbf7b233aa
Merge #3203
...
3203: support ordering magic methods for `#[pyclass]` r=adamreichold a=davidhewitt
Closes #2089
This adds `__lt__`, `__le__`, `__eq__`, `__ne__`, `__gt__`, and `__ge__` as per the Python implementations of what we call `__richcmp__`.
There's a UI test confirming that the user cannot implement split forms and `__richcmp__` simultaneously.
There's also a benchmark comparing implementing these split methods against using `__richcmp__`. I couldn't see a meaningful performance difference, so I'm tempted to deprecate `__richcmp__`, given that's not a magic method which exists in Python. Potentially we can provide options such as the opt-in `#[pyclass(eq, ord)]` to avoid boilerplate for people who don't want to implement six different methods.
Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
2023-06-05 07:13:23 +00:00
5738edfdd4
Bump MSRV to 1.56
2023-06-04 23:02:30 +01:00
8850d5d384
support ordering magic methods for `#[pyclass]`
2023-06-04 13:58:18 +01:00
2500e22e13
release: 0.19.0
2023-05-31 13:53:37 +01:00
810ad00a76
Do not apply deferred ref count updates and prevent the GIL from being acquired inside of implementations.
2023-05-25 20:01:35 +02:00
248230b8e4
refactor PyAny::is_instance_of for performance
2023-05-18 22:25:27 +01:00
b9766cfa11
Add PyClass::get and Py::get for GIL-independent access to frozen classes.
2023-05-18 08:57:55 +02:00
20c5618160
Add support for combining the `#[new]` and `#[classmethod]` method types.
2023-05-16 15:51:14 -07:00
633b592ed5
Merge #2593
...
2593: docs: mention PyBuffer r=adamreichold a=davidhewitt
Uses PEP 688 `types.Buffer` to describe `PyBuffer<T>` in the conversion tables. Will leave as draft until PEP 688 is finalised.
Closes #954
Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
Co-authored-by: Adam Reichold <adam.reichold@t-online.de>
2023-05-09 20:24:37 +00:00
7c231a2372
docs: mention PyBuffer
2023-05-09 19:53:39 +01:00
1676100dfd
Added a few lines to document the main difference between maturin and setuptools-rust as far as building manylinux-compliant wheels is concerned.
...
Added newfragment
2023-05-09 14:54:30 +02:00
dd24c9ea71
remove `Python::acquire_gil`
2023-05-09 09:39:23 +02:00
3c634dd9a9
Add migration guide entry on replacing acquire_gil by with_gil.
2023-05-09 09:39:23 +02:00
fdd43d0685
feat: unwrap dyn Err when inner is simple PyErr
2023-05-09 07:17:10 +01:00
1cdac4fde4
Merge #2980
...
2980: support `text_signature` on `#[new]` r=adamreichold a=davidhewitt
Closes #2866
This is a breaking change for 0.19.0, because it starts autogenerating `text_signature` for `#[new]`. This could affect runtime behaviour if the user is relying on the class docs at runtime for some reason.
Guide & tests all updated accordingly.
`#[pyclass(text_signature = "...")]` is deprecated by this PR, however if it's set, it will be used in preference to `#[new]`.
(The signature / `text_signature` from `#[new]` will simply be ignored in this case. I figure that when users fix their deprecation warnings by removing `#[pyclass(text_signature = "...")]` then the `#[new]` signatures will start flowing properly, and this is good enough.)
Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
Co-authored-by: Adam Reichold <adam.reichold@t-online.de>
2023-05-04 16:51:54 +00:00
6356acb2f9
Merge #3120
...
3120: feat: add #[pyo3(from_item_all)] for FromPyObject r=davidhewitt a=BlueGlassBlock
This PR addresses #3112 by implementing ~~`#[pyo3(item_all)]`~~ `#[pyo3(from_item_all)]`.
Co-authored-by: BlueGlassBlock <blueglassblock@outlook.com>
2023-05-04 07:10:21 +00:00
8bd17f02c7
support `text_signature` on `#[new]`
2023-05-04 07:15:11 +01:00
559b540b5c
Fix a crate doc link for IterNextOutput
2023-05-02 15:05:53 +08:00
1d6ab21781
fix: change to from_item_all
2023-04-26 19:47:07 +08:00
30b2ed1d85
feat: add #[pyo3(item_all)] for FromPyObject
2023-04-25 19:37:05 +08:00
512847257e
Fix crate docs links in python_from_rust.md
2023-04-24 15:21:08 -07:00
24ab144a41
minor grammar fix in documentation
2023-04-23 02:05:51 -05:00
8e0bde14c9
implement Decimal to rust_decimal conversions
...
Implement conversion between rust_decimal::Decimal and decimal.Decimal
from Python's stdlib. The C API does not appear to be exposed on the
Python side so we need to call into it via Python.
2023-04-22 19:55:21 +02:00
3a9c6b175d
Update getting_started.md
...
Update Poetry command to Poetry groups syntax (1.2+).
https://python-poetry.org/docs/cli/#options-4
2023-04-21 23:19:57 +03:00
a0e285b497
Merge #3066 #3098
...
3066: Improve default value for `None` in `text_signature` r=davidhewitt a=messense
xref #2863
3098: readme: add new pyo3 article r=adamreichold a=davidhewitt
With thanks to `@ohadravid` for the great piece!
Co-authored-by: messense <messense@icloud.com>
Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
2023-04-12 07:40:50 +00:00
80d95f9134
docs: fix migration guide entry for pyproto
2023-04-11 21:23:05 +01:00
48f79718f9
Fix redundant imports in doc tests thereby fixing the careful CI job.
2023-04-10 08:09:06 +02:00
52a0378e56
docs: show pattern for self.__class__.__name__ in __repr__
...
Co-authored-by: Bruno Kolenbrander <59372212+mejrs@users.noreply.github.com>
2023-03-30 10:59:41 +02:00
57dbc94293
Improve default value for `None` in `text_signature`
2023-03-29 10:14:44 +08:00
ebedcfb8b2
Merge #3050
...
3050: Improve default values for str, numbers and bool in `text_signature` r=davidhewitt a=messense
xref #2863
Co-authored-by: messense <messense@icloud.com>
2023-03-25 07:07:06 +00:00
e5e8c7a6d0
Merge #2975 #3022 #3023
...
2975: RFC: Add GILProtected synchronization primitive and use it for LazyTypeObjectInner. r=davidhewitt a=adamreichold
I would also like to use that type in rust-numpy and it seems we can avoid ~~both a manual unsafe impl and~~ a full blown mutex if we apply it to `LazyTypeObjectInner`.
One downside might be that it ties us closer to the GIL when we want to enable nogil experimentation, but on the other hand, it may also help by reifying the GIL usage. (This is currently limited to comments in unsafe code in rust-numpy for example.)
3022: Fix function name shadowing r=davidhewitt a=mejrs
Fixes https://github.com/PyO3/pyo3/issues/3017
3023: Emit a better error for bad argument names r=davidhewitt a=mejrs
This will emit a better error for code like
```rust
#[pyfunction]
fn output([a,b,c]: [u8;3]) {}
```
Co-authored-by: Adam Reichold <adam.reichold@t-online.de>
Co-authored-by: mejrs <59372212+mejrs@users.noreply.github.com>
2023-03-23 08:04:11 +00:00
79a70f3923
Improve default values for str, numbers and bool in `text_signature`
2023-03-16 11:06:51 +08:00
626a67ca49
Add note about garbage collection on PyPy
2023-03-12 23:35:47 +00:00
a629e8267a
feat: add #[pyo3(get, set)] for Cell
2023-03-09 23:09:30 +00:00
410bb15d71
Merge #2982
...
2982: explain STATUS_DLL_NOT_FOUND r=adamreichold a=mejrs
I had someone ask me this today, and googling for it I found various other places where this was asked, with no (good) answers.
Co-authored-by: mejrs <59372212+mejrs@users.noreply.github.com>
2023-02-24 17:13:38 +00:00
db16580b63
Make changes
2023-02-23 12:36:54 +01:00
9534749d8b
Add GILProtected synchronization primitive replacement and use it for LazyTypeObjectInner.
2023-02-23 09:38:02 +01:00
90ce52175f
explain STATUS_DLL_NOT_FOUND
2023-02-22 23:30:19 +01:00
a16f2e45c8
Include conversions for bytes, bytearrays and Cow<[u8]> in the guide.
2023-02-22 22:07:59 +01:00
9f7368922f
docs: fix typo in method name
2023-02-18 22:02:05 +01:00
c7cc48f8e4
use PyO3 types within LazyTypeObject
2023-02-18 09:06:36 +00:00
00ddd21535
change PyModule::add_class to return an error if class creation fails
2023-02-14 22:08:35 +00:00
dbeb3b4453
move some private internals out of public implementation
2023-02-11 21:28:27 +00:00
9e5c845dee
Merge #2934
...
2934: guide: add documentation for trailing option arguments r=davidhewitt a=davidhewitt
Following the increased clarity around PyO3's handling of function signatures of 0.18.0, I wanted to add a section to the guide documenting the default-to-none behaviour for trailing `Option<T>` arguments.
Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
2023-02-07 08:15:57 +00:00
bc1a33f9fe
bump maturin version in getting_started.md
...
Latest maturin is 0.14.x
2023-02-04 00:09:04 -08:00
9306d56b27
docs: Precise the abscense of `py: Python` for the #[pyo3(signature)]
2023-02-03 20:57:23 +00:00
c709f30638
guide: add documentation for trailing option arguments
2023-02-03 20:54:51 +00:00
e83803e813
add link on how to obtain GIL to guide
2023-01-20 08:21:57 +00:00
586fed2c4b
send errors in `__releasebuffer__` to `sys.unraisablehook`
2023-01-19 19:10:06 +00:00
ca1bbe3d39
add migration notes for PyO3 0.18
2023-01-17 08:14:32 +00:00
20ca3be659
inspect: gate behind `experimental-inspect` feature
2023-01-15 12:41:23 +00:00
eea2a31bd3
adjust location and wording for extension module memory management
2023-01-10 07:42:39 +00:00
8af9d2a19a
Add a section on memory management for `extension`
...
Adding a special case of memory management when writing an extension.
This is a documentation of: https://github.com/PyO3/pyo3/issues/1056 and https://github.com/PyO3/pyo3/issues/2853
2023-01-10 07:37:21 +00:00
8651d3b0e8
address feedback in review #2678
2023-01-06 08:53:00 +00:00
e52dbc907d
GH-2649 example for inserting moulde in sys.dict
2023-01-05 21:26:47 +00:00
c722402e46
Fix links in `logging.md`
2023-01-03 20:03:51 +08:00
fefd224e4a
Update logging.md for logging->rust
...
Demonstrates how to register a rust log consumer with a pythong logging instance.
2023-01-03 10:22:54 +00:00
f2608a923c
remove functionality deprecated in 0.16
2022-12-28 12:23:53 +00:00
5039fd746a
add automatic text signature generation
2022-12-24 09:43:02 +00:00
97487ffbb5
add abi3-py311 feature
2022-11-23 08:08:12 +00:00
f1f1ffcdc7
More typos and grammar.
2022-11-23 07:42:53 +01:00
c91ed70bbc
Fix various typos/omissions in guide.
2022-11-23 07:42:17 +01:00
5f7d67615c
Use PYO3_DOCS_URL in guide-to-rustdoc links.
2022-11-23 07:42:17 +01:00
08423557d4
Merge #2739
...
2739: error when `#[pyo3(signature = ())]` used on invalid methods r=davidhewitt a=davidhewitt
A follow-up to #2702 to reject some invalid applications of `#[pyo3(signature = (...))]` attribute, specifically on magic methods and getters / setters / class attributes.
Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
2022-11-22 19:41:27 +00:00
b485199cfb
Merge #2762
...
2762: Add a nox task to rustfmt code in the guide r=birkenfeld a=birkenfeld
Also apply it. Two caveats:
1) needs nightly rustfmt to be available
2) not all reformat diffs have been applied; using best judgment for readability
Co-authored-by: Georg Brandl <georg@python.org>
2022-11-22 11:11:19 +00:00
a7a53d6c0d
Add a nox task to rustfmt code in the guide.
...
Also apply it. Two caveats:
1) needs nightly rustfmt to be available
2) not all reformat diffs have been applied; using best judgment for readability.
2022-11-22 09:19:40 +01:00
8a75352122
Add link to Python typing docs for type stubs
...
AFAIK there isn't currently a link to the article on ["Type Stubs"](https://typing.readthedocs.io/en/latest/source/stubs.html ) in the official Python static typing documentation. This PR adds a link to this documentation, which is the most comprehensive I have seen around type stubs.
2022-11-21 16:48:43 -05:00
b2014c30aa
guide: linkify "Method arguments" in class.md
2022-11-20 16:33:15 -05:00
8ca41be87b
Merge pull request #2749 from PyO3/2748-fix
...
Fix being able to call arg-less `#[new]` with any args from Python
2022-11-20 11:39:42 +00:00
51eeb6db96
guide: explain how #[new] works w.r.t. native base types
2022-11-20 08:25:42 +01:00
77f5fc107e
guide: better document negative index behavior w.r.t. PySequence
...
Fixes #2601
2022-11-20 08:09:50 +01:00
c489809938
Py/PyAny: deprecate cast_as() in favor of downcast()
...
They are (practically) identical on PyAny, and `downcast()` is the more
useful name.
2022-11-18 07:00:40 +01:00
00fc0358b9
error when `#[pyo3(signature = ())]` used on invalid methods
2022-11-17 08:28:34 +00:00
dee791de90
`pyo3-build-config`: rebuild when `PYO3_ENVIRONMENT_SIGNATURE` value changed
2022-11-09 20:28:18 +08:00
47490a7a31
Fix module name in getting started
2022-11-01 14:08:28 +07:00
8e8b484169
add `#[pyo3(signature = (...))]` attribute ( #2702 )
2022-10-25 07:23:21 +01:00
446c0e82f0
Merge pull request #2692 from mejrs/all
...
Implement get/set all on pyclass
2022-10-18 21:39:44 +01:00
676227d2a1
Make `is_instance()` and `is_subclass()` take `&PyAny` ( #2695 )
2022-10-18 19:22:23 +02:00
d254134154
Implement get/set all on pyclass
2022-10-17 02:37:43 +02:00
ca1c9c1dba
update per review
2022-10-16 11:04:15 -07:00
8e6bf1875f
Apply suggestions from code review
...
Co-authored-by: Georg Brandl <georg@python.org>
2022-10-16 11:01:15 -07:00
78e4130762
Update getting_started.md
2022-10-15 20:55:49 -07:00
b265ee7907
Point new users at specific source file for Rust code.
...
This was a minor confusion for me so I thought I'd suggest the change - it was the first place I looked, but I did have to think about it :)
2022-10-15 20:49:24 -07:00
c9b26f57cd
Merge pull request #2657 from mejrs/decorator_fix
...
Update decorator to use Cell counter
2022-10-10 19:55:36 +02:00
d8fa6be28a
is
2022-10-04 19:33:02 +02:00
e0602b641c
Just use Cell
2022-10-04 19:05:44 +02:00
611ea4db49
Update decorator to use atomics
2022-10-04 17:59:46 +02:00
bd40011e93
release: 0.17.2
2022-10-04 08:13:53 +01:00
372176630e
guide: doctest function/ subpages
2022-09-27 07:52:14 +01:00
fad5f6a07a
Merge pull request #2639 from mrob95/err-self-typo
...
docs: fixed typo in error_handling.md
2022-09-26 23:16:26 +02:00
2dd3c6c71f
Document needing resolve-config for pyo3 cfgs
2022-09-24 16:18:05 +02:00
a731c2ae60
Fix pyo3-build-config version in docs
2022-09-24 15:50:41 +02:00
4275abff0c
docs: fixed typo in error_handling.md
2022-09-24 14:03:13 +01:00
86ce4d1a13
Add git repository and edit urls to user guide ( #2635 )
2022-09-23 00:56:25 +00:00
Joseph Perez