Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[RFC] Render typed iterators in docstrings (alternative) #2371

Draft
wants to merge 8 commits into
base: master
Choose a base branch
from
Draft

[RFC] Render typed iterators in docstrings (alternative) #2371

wants to merge 8 commits into from

Commits on Aug 7, 2020

  1. Render typed iterators (e.g. Iterator[int]) in docstrings 

    This commit introduces minor breaking change: `make_iterator` and `make_key_iterator`
now return `iterator_state` instance instead of `py::iterator`.
It doesn't affect regular use of those functions (immediate return from __iter__ lambda),
but requires changes in user code with implicit assignments/conversions, e.g.:

py::iterator it = make_iterator(...); # requires explicit py::cast()
    @sizmailov
    sizmailov committed Aug 7, 2020
    Configuration menu
    Copy the full SHA
    91ca4e6 View commit details
    Browse the repository at this point in the history

  2. Introduce make_iterator_ng/make_key_iterator_ng, 

    deprecate make_iterator,make_key_iterator
    @sizmailov
    sizmailov committed Aug 7, 2020
    Configuration menu
    Copy the full SHA
    8bbfeea View commit details
    Browse the repository at this point in the history

  3. Revert iterator_passthrough test change

    @sizmailov
    sizmailov committed Aug 7, 2020
    Configuration menu
    Copy the full SHA
    0e360b7 View commit details
    Browse the repository at this point in the history

  4. Use make_iterator_ng/make_key_iterator_ng in tests

    @sizmailov
    sizmailov committed Aug 7, 2020
    Configuration menu
    Copy the full SHA
    036add2 View commit details
    Browse the repository at this point in the history

  5. Use concrete return types instead of auto

    @sizmailov
    sizmailov committed Aug 7, 2020
    Configuration menu
    Copy the full SHA
    96bdc5f View commit details
    Browse the repository at this point in the history

  6. fix: typo

    @sizmailov
    sizmailov committed Aug 7, 2020
    Configuration menu
    Copy the full SHA
    b1dbc30 View commit details
    Browse the repository at this point in the history

  7. Avoid deprecation warning in iterator_passthrough

    @sizmailov
    sizmailov committed Aug 7, 2020
    Configuration menu
    Copy the full SHA
    98763aa View commit details
    Browse the repository at this point in the history

  8. Make use of PYBIND11_DEPRECATED macro

    @sizmailov
    sizmailov committed Aug 7, 2020
    Configuration menu
    Copy the full SHA
    c5500d8 View commit details
    Browse the repository at this point in the history