9ab7b1fad1
Rewrite `module.md` for clarity and add tip on code organization ( #1693 )
...
* Rewrite `module.md` for clarity and add tip on code organization
* Add section on how to build the guide + add workaround proposed by David
* Make more clear references to #1709
2021-07-22 08:10:32 +01:00
6e0fb9e3a1
guide: bump mdbook to 0.4.10
2021-07-20 08:54:21 +01:00
b5b9a480cd
Add `wrap_pyfunction` macro to prelude
2021-06-24 22:34:55 +08:00
13cd092c4e
Update class.md - add example of `new` returning a `PyResult` ( #1688 )
...
* Update class.md - add example of `new` returning a `PyResult`
* Update class.md
2021-06-23 17:40:01 +08:00
f916867375
pyclass: refactor initialization, call native type dealloc
2021-06-23 07:45:51 +01:00
d5d2cf9fda
document + refactor numcomplex/bigint dependencies
2021-06-07 22:16:23 +02:00
18e0aa17e0
pymodule: accept `#[pyo3(name = "...")]` option
2021-06-06 08:41:20 +01:00
9b8b133905
pyfunction: document `#[pyo3(pass_module)]`
2021-06-05 17:36:50 +01:00
cec4c2d2e9
text_signature: move to `#[pyo3(text_signature = "...")]`
2021-06-05 16:33:03 +01:00
3e8d003faf
Implement METH_FASTCALL for pyfunctions and pymethods.
2021-06-05 12:57:22 +02:00
d011467e63
pyclass: allow `#[pyo3(get, set, name = "foo")]`
2021-06-04 11:30:40 +01:00
dbf9a91a8b
mark toml field as toml
2021-05-31 21:05:52 +02:00
e2cb176f6c
mark non-rust code as text fields
2021-05-31 20:58:38 +02:00
161f1bd678
faq: add section about pyo3(get) cloning fields
2021-05-31 17:16:25 +02:00
d680fbee0a
Merge pull request #1643 from mejrs/main
2021-05-31 15:14:31 +02:00
d86559b163
move manual builds to its own header
2021-05-31 12:39:00 +02:00
ce3b0d1dc0
add renaming method to guide
2021-05-30 14:13:24 +02:00
1ba32178dd
Method and slot visitors accept slices instead of individual items
2021-05-29 09:38:15 +01:00
9a4e7b5877
Merge pull request #1622 from davidhewitt/pyo3-build-config
...
pyo3-build-config: new crate to re-use build.rs across crates
2021-05-25 07:11:24 +01:00
1e1605f0db
pyo3-build-config: finish docs
2021-05-24 08:44:20 +01:00
825ec08681
pyo3-build-config: docs wip
2021-05-21 08:34:51 +01:00
a109640850
pyfn: deprecate name argument
2021-05-20 08:54:29 +01:00
735a9a1156
Update for_each_proto_slot for consistency
2021-05-13 17:32:59 +01:00
c3b935f06c
Reduce size of compiled code for class initialization
2021-05-13 13:08:58 +01:00
4d46abde73
macros: support `#[pyo3(name = "...")]`
2021-05-07 22:35:52 +01:00
7536554ceb
type_object: remove layout and base type from PyTypeInfo
2021-05-04 21:39:42 +01:00
48823e22d6
pyproto: deprecate py_methods
2021-04-20 00:21:19 +01:00
2b9085abdb
build: avoid rebuilds when using clippy in a virtualenv
2021-04-19 09:45:01 +01:00
355df5a37f
auto-initialize: better error messages and embedding docs
2021-04-12 01:29:03 +01:00
e8a277e1ff
Apply suggestions from code review
...
- Style
Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
2021-04-07 08:23:43 +03:00
88849bd96b
Add `PyMappingProtocol` description to the guide
...
References:
[1]: https://docs.python.org/3/reference/datamodel.html#emulating-container-types
[2]: https://docs.python.org/3/c-api/mapping.html
[3]: https://docs.python.org/3/c-api/typeobj.html#c.PyMappingMethods
2021-04-05 14:19:18 +03:00
b1aae93645
Add `PySequenceProtocol` description to the guide
...
References:
[1]: https://docs.python.org/3/reference/datamodel.html#emulating-container-types
[2]: https://docs.python.org/3/c-api/sequence.html
[3]: https://docs.python.org/3/c-api/typeobj.html#c.PySequenceMethods
2021-04-05 14:18:48 +03:00
4b675cc364
Insert missing `impl` keywords
...
Updates the class customization guide.
2021-04-05 12:02:46 +03:00
0c0214690f
Remove issue #844 mention from the guide
...
Supposedly resolved by https://github.com/PyO3/pyo3/pull/1107
Fix a typo in the subsection header.
2021-04-05 08:35:02 +03:00
f953059880
guide: fixups to build
2021-04-03 10:50:57 +01:00
31eeb86e98
guide: automatically set pyo3 version in links and cargo toml
2021-04-03 07:05:10 +01:00
80c747d2c0
Remove `pyconfig.h` header parsing
...
The config header parsing code was supposed to be only invoked when
cross-compiling for Windows, but in reality it fails to correctly parse
the config header files shipped with the upstream Python for Windows.
Given that there are now better options for reliable cross-compiling
for Windows such as `PYO3_CROSS_PYTHON_VERSION` or the `abi3-py3*` features,
it should be OK to remove this config for v0.14.
Update the cross-compilation instructions section of the user guide.
Fixes https://github.com/PyO3/pyo3/issues/1337
2021-03-26 09:57:18 +03:00
aedd6352e3
Use with_gil instead of acquire_gil in examples
2021-03-20 19:02:50 +09:00
f22fb423cb
Merge pull request #1503 from davidhewitt/main-tweaks
...
main: tweaks from rename
2021-03-17 21:07:58 +00:00
971b48f091
Update guide/src/parallelism.md
...
Co-authored-by: Yuji Kanagawa <yuji.kngw.80s.revive@gmail.com>
2021-03-17 07:02:29 +00:00
6137e3a726
Merge pull request #1456 from davidhewitt/pyclass-impl-flags
...
pyclass: move flags to PyClassImpl
2021-03-17 12:50:49 +09:00
4d2913dc06
main: tweaks from rename
2021-03-16 22:14:57 +00:00
b10cefdca2
pymodule: remove call_function etc.
2021-03-14 11:19:55 +00:00
d9fe404d69
[review] kngwyu
2021-03-14 00:50:59 +00:00
e24f29dbf5
Add context manager example to user guide ( #1476 )
...
* Add context manager example
A simple illustrative example on how to use context managers. I required this to use pymc3, which relies heavily on the context stack for modelling.
* Clippy changes to context example
* Extend context manager example with exit exceptions
* Context manager, s/call1/call_method1/ and comments for clarity
* Add newline to context manager section to avoid horizontal scrolling
* Change generic, potentially confusing label.
s/objects.py/house.py/
* Use call_function1 rather than call_method1.
* Missed a call_method0, change to call_function0
* Update guide/src/python_from_rust.md
Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
* Update guide/src/python_from_rust.md
Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
2021-03-13 22:54:13 +00:00
31c7af2ac7
pyclass: move flags to PyClassImpl
2021-03-13 22:44:53 +00:00
a45f520ec1
Merge pull request #1457 from davidhewitt/multiple-pymethods
...
pymethods: make inventory optional
2021-03-06 23:09:02 +00:00
bb6d4df497
multiple-pymethods: documentation updates
2021-03-04 23:03:26 +00:00
977735db20
pymethods: make inventory optional
2021-03-04 19:52:58 +00:00
1dcda8809d
docs: deny warnings in ci
2021-03-04 19:41:11 +00:00
e065f9b517
PyModule: rename call* to call_function*
...
For consistency with PyObject/PyAny, where call() means to call the
object itself.
2021-03-04 09:29:28 +01:00
7dfb4c353d
Update setuptools-rust/maturin comparison
...
I tried to make differences clearer and make it a bit less biased towards maturin
2021-03-03 11:40:21 +01:00
a7528ee690
guide: correct documentation on default features
2021-02-27 14:55:40 +00:00
c4bd9335fc
Merge pull request #1446 from davidhewitt/no-pyproto-inventory
...
pyproto: don't use inventory for methods
2021-02-26 09:09:23 +00:00
aa2855b6a0
pyproto: don't use inventory for methods
2021-02-25 00:17:22 +00:00
9e4e0dbbe0
auto-initialize: remove from default features
2021-02-22 22:34:34 +00:00
1e134aa0de
pyclass-impl: use impl Trait arguments
...
Co-authored-by: Yuji Kanagawa <yuji.kngw.80s.revive@gmail.com>
2021-02-19 07:45:14 +00:00
7b99e391fa
pyclass-impl: merge implementation traits
2021-02-18 08:19:07 +00:00
fe9b4625d1
Implement conversions for Path/PathBuf
2021-02-13 20:22:16 +00:00
db3668898a
Updated guide after merging attributes branch into pyo3-asyncio
2021-02-09 18:26:14 -06:00
80d4c5b3ad
rebased on #1401
2021-02-08 22:43:21 +00:00
411e97643a
Changed overview paragraphs at the top, added some of my own changes to (hopefully) improve the flow
2021-02-08 22:43:21 +00:00
e1b2bd20d0
Added sleep in the initialization example as suggested
2021-02-08 22:43:21 +00:00
bc87c57f7c
Updated guide to address some issues brought up in the PR
2021-02-08 22:43:21 +00:00
3b82cf475a
Changed instance of Asyncio to `asyncio`
...
Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
2021-02-08 22:43:21 +00:00
b4f338c68d
Update guide/src/async-await.md
...
Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
2021-02-08 22:43:21 +00:00
8140dc99ec
Fixed typo in README, flattened sections in Cargo Test portion of guide
2021-02-08 22:43:01 +00:00
946460caeb
Added async/await example to the guide, added pyo3-asyncio to list of tools and libraries
2021-02-08 22:41:42 +00:00
0a7aee14fe
guide: organise more chapters into sublevels
2021-01-26 22:09:02 +00:00
dc7bcdaf9b
gil: move finalization from prepare_freethreaded_python to
...
with_embedded_python_interpreter
2021-01-12 07:44:37 +00:00
7c61c9b7f9
gil: tidy ups to finalization
2021-01-12 07:42:47 +00:00
abb5829e9c
implement Serialize, Deserialize for Py<T>
2021-01-11 22:19:10 +00:00
a8d8003b31
guide: document PYO3_NO_PYTHON on Windows
2021-01-10 10:16:37 +00:00
c1c4a5ffa5
readme/faq: document `rlib` crate type better
2021-01-06 06:54:44 +00:00
8e37d378b5
Merge pull request #1347 from davidhewitt/embedding
...
auto-initialize: new feature to control initializing Python
2021-01-04 21:31:22 +00:00
e0c35d17dd
auto-initialize: add CHANGELOG and docs
2021-01-04 21:08:08 +00:00
74a8b3257d
Fix #[pyclass] arguments description
2021-01-02 19:03:29 +03:00
a350dd2c20
build: make include dir optional when targeting Windows
2020-12-31 22:02:29 +00:00
7572962828
abi3: add support for dict and weakref from Python 3.9
2020-12-28 10:22:46 +00:00
26ca1f5bca
Release 0.13
2020-12-22 15:42:04 +00:00
9e7fa408d4
pyproto: use buffer slots on Python 3.9 and up
2020-12-22 13:33:42 +00:00
4e650d939d
pyproto: remove inventory from implementation
2020-12-20 10:01:30 +00:00
a689ab42c6
macros: rename crates for consistency
2020-12-20 06:39:28 +00:00
3d6356223e
docs: fix warnings
2020-12-18 23:11:10 +00:00
3edd961fa3
Clearly document the limitations of abi3
...
closes #1288
2020-12-13 10:26:37 -05:00
9aa70f7c89
Merge pull request #1263 from PyO3/abi3-min-python
...
Add abi3-py* features
2020-12-08 12:52:00 +09:00
49143724d5
Rename PYO3_NO_INTERPRETER by PYO3_NO_PYTHON
2020-12-07 17:30:04 +09:00
6da6bc9461
Apply suggestions from @davidhewitt
...
Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
2020-12-06 16:06:10 +09:00
1b838504b7
Introduce PYO3_NO_INTERPRETER variable for build script
2020-12-01 23:40:49 +09:00
bba1cf19b3
Add section about Python::check_signals to the FAQ
2020-11-30 11:38:40 +11:00
fc34e41163
pyany: add is_instance
2020-11-22 19:24:59 +00:00
93282e9a70
Note abi3-py* features in the guide and Add CHANGELOG
2020-11-16 00:47:24 +09:00
9617edfca9
msrv: bump to 1.45
2020-11-12 11:33:08 +00:00
3b3ba4e3ab
Merge pull request #1152 from PyO3/abi3
...
Complete abi3 support
2020-10-27 23:30:36 +09:00
eb0e6f6b55
Note the minimum required version of maturin supporting abi3
2020-10-27 13:19:01 +09:00
6627658127
Renew proc-macros for new `#[pyproto]` backend
2020-10-21 01:29:28 +09:00
ba6f0ecdfa
Merge branch 'master' into abi3-merge-master
2020-10-18 10:47:06 -04:00
84b893b261
guide: improve "calling Python from Rust" section
2020-10-18 10:08:11 +01:00
27f2d0ee3b
Merge pull request #1212 from Askaholic/issue/#1055-add-arg-name-to-conversion-error
...
Enhance error messages of conversion errors
2020-10-18 09:15:42 +01:00
4a916eb3ed
guide: fix broken link
2020-10-16 09:00:46 +01:00
6724783395
Change wording of PyDowncastError display implementation
...
Displays type(obj) instead of repr(obj) and uses `cannot` instead of
`can't`
to be more consistent with existing python error messages.
See discussion at #1212 .
2020-10-14 17:32:00 -08:00
9e34835b76
Merge branch 'master' into abi3-merge-master
2020-10-12 18:03:14 -04:00
aabad7cf7f
Assorted updates to the abi3 branch from review
2020-10-11 19:51:27 -04:00
877667a1c6
Improved documentation
2020-10-11 15:18:05 -04:00
140790b15f
Merge branch 'master' into abi3-merge-master
2020-10-10 10:11:49 -04:00
23d9d259a7
migration guide: tiny typo fix
2020-10-10 06:24:57 +01:00
41c2f5a748
Use &'static CStr for representing method names and docs
2020-10-08 17:26:55 +09:00
e615ce8c05
Start documenting abi3 support
2020-09-23 18:42:49 -04:00
1985578bb7
Don't compile extends=PyDict test in class.md with abi3
2020-09-20 16:20:08 +09:00
0a346dfa7c
Add documentation for raw_pycfuntion
2020-09-17 09:47:53 +02:00
ba1056006a
Get all the tests building, everythign except doctests passes!
2020-09-16 08:42:22 -04:00
5bfb4674b1
Merge branch 'master' into abi3-merge-master
2020-09-10 17:01:13 -04:00
151af7a0b7
Merge pull request #1115 from davidhewitt/std-py-err
...
Implement std::error::Error for PyErr
2020-09-10 21:17:11 +01:00
73507dbf5e
Merge pull request #1163 from sebpuetz/pyfunction
...
Add native Function types.
2020-09-10 19:05:57 +01:00
b9e95dc7c9
Implement std::error::Error for PyErr
2020-09-10 19:04:24 +01:00
7a4c5e2960
Merge branch 'master' into abi3
2020-09-10 00:48:20 +09:00
22881a3c2f
Change add_function, ensure static docstrings.
...
Change add_function to take `&PyCFunction` instead of a wrapper
fn and ensure that dostrings of functions are `&'static str`.
2020-09-09 12:37:37 +02:00
117f60bed0
Make PyType::name abi3 compatible
...
The implementation is more complex, because there's no equivalent to tp_name in the limited API
2020-09-08 12:22:59 -04:00
16fe583b82
Merge pull request #1143 from sebpuetz/pyfunction-modules
...
PyModule in #[pyfunction]
2020-09-06 20:55:29 +01:00
a1d6c7a838
Merge pull request #1157 from davidhewitt/conversion-detail
...
docs: add detail to wrapper type conversions
2020-09-06 20:52:34 +01:00
192c2c2b2c
docs: add detail to wrapper type conversions
2020-09-06 10:21:08 +01:00
64b06ea9ec
Change `add_submodule()` to take `&PyModule`.
...
The C-exported wrapper generated through `#[pymodule]` is only
required for the top-level module.
2020-09-05 15:54:57 +02:00
2b0b853912
Add CHANGELOG to the guide
2020-09-05 14:44:39 +01:00
06cd7c7d5a
Fix some more docs.
2020-09-05 11:24:12 +02:00
e65b849ab6
Doc fixes, changelog and rename.
2020-09-05 10:20:22 +02:00
9137855e81
Add documentation for accessing PyModule in #[pyfunction]s.
2020-09-04 10:02:40 +02:00
4aae523e54
Rename add_module to add_submodule, documentation fixes.
2020-09-04 09:02:49 +02:00
3214249010
Make python function wrapper creation fallible.
...
Wrapping a function can fail if we can't get the module name.
Based on suggestion by @kngwyu
2020-09-03 15:48:32 +02:00
5bbca1a052
Set the module of `#[pyfunction]`s.
...
Previously neither the module nor the name of the module of
pyfunctions were registered. This commit passes the module and
its name when creating a new pyfunction.
PyModule::add_function and PyModule::add_module have been added and are
set to replace `add_wrapped` in a future release. `add_wrapped` is kept
for compatibility reasons during the transition.
Depending on whether a `PyModule` or `Python` is the argument for the
Python function-wrapper, the module will be registered with the function.
2020-09-03 14:49:28 +02:00
400462063d
Proof of concept of using PEP384s PyType_Spec
2020-09-02 16:54:39 -04:00
81afdaf6cd
Start splitting long guide pages into subchapters
2020-09-01 22:44:27 +01:00
f0650ebd94
Add doc for extracting Union via FromPyObject
2020-09-01 22:04:57 +01:00
729f2f42e7
Merge pull request #1065 from sebpuetz/union
...
FromPyObject derivation for structs and enums
2020-08-31 21:28:49 +09:00
0f32f886b8
More FromPyObject derive suggestions by @davidhewitt
2020-08-30 19:16:59 +02:00
21cdb8ab7e
Add introduction to guide
2020-08-30 13:03:28 +01:00
53a858c5c1
Add documentation for FromPyObject derivation.
2020-08-30 13:35:06 +02:00
608aea726c
Allow other Result types in `#[pyfunction]` ( #1118 )
...
* Added a couple basic tests
* Implemented suggested change
* Fixed type inference
* cargo fmt
* Finished tests and removed warnings
* Include in CHANGELOG.md
* Moved test into separate file
* &'static str and function rename
* Mention in the book
2020-08-29 08:25:20 +01:00
16ef96904a
Merge pull request #1114 from mtreinish/hashbrown
...
Add optional support for conversion from Hashbrown types
2020-08-26 12:48:21 +01:00
659d24e1a9
Add CHANGELOG entry and update conversions guide
2020-08-26 06:37:02 -04:00
37d23da7d5
Add link to Bazel rules
2020-08-25 23:02:20 +01:00
441d7f52b1
apply symlink use case, change variable name
2020-08-19 12:11:14 -04:00
7beb272075
find within general lib dir, with new optional env variable
2020-08-18 22:05:29 -04:00
5dc907bc5d
apply suggestions from review
2020-08-17 18:14:05 -04:00
0cd1e5bf19
change documentation
2020-08-17 15:17:34 -04:00
aef159d4ee
appy suggestions from PR
2020-08-17 11:26:30 -04:00
565e36d989
Merge pull request #1098 from davidhewitt/py-as-into-ref
...
Py::as_ref and Py::into_ref (remove AsPyRef)
2020-08-11 20:44:53 +01:00
b17d4fffe2
Merge pull request #1093 from kngwyu/iterator-example
...
Improve lifetime insertions for #[pyproto]
2020-08-11 18:16:53 +09:00
6b3c6fdeee
Improve docs for Py::as_ref() and Py::into_ref()
...
Co-authored-by: Georg Brandl <georg@python.org>
2020-08-11 08:36:31 +01:00
4467cf51db
guide: show exporting create_exception! exceptions in a module
2020-08-10 17:08:52 +02:00
c4d9ab227e
Merge branch 'master' into iterator-example
2020-08-10 17:11:00 +09:00
Eric Arellano