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

Remove references to gen.coroutine from docs and update without_document_lock decorator #12010

Merged
merged 5 commits into from Feb 18, 2022
Merged

Remove references to gen.coroutine from docs and update without_document_lock decorator #12010

merged 5 commits into from Feb 18, 2022

Conversation

benrussell80
Copy link
Contributor

Changes

Remove references to tornado.gen.coroutine in docs in favor of async functions.
Change bokeh.document.locking.without_document_lock to work for async functions and functions decorated with asyncio.coroutine.

@benrussell80 benrussell80 changed the title 11716 remove gen coroutine from docs Remove references to gen.coroutine from docs and update without_document_lock decorator Feb 17, 2022
@bryevdv
Copy link
Member

bryevdv commented Feb 17, 2022

@benrussell80 this is great, do you have any more bandwidth to continue a little further on this? Ideally there would be a minimal test of without_document_lock acting on a coroutine, and an update to the docstring to make it clear that coroutines are acceptable.

@benrussell80
Copy link
Contributor Author

@bryevdv Yeah can do

@benrussell80
Copy link
Contributor Author

Test and docstring modification added. Let me know if they are up to snuff.

I got this warning from pytest when using asyncio.

DeprecationWarning: The 'asyncio_mode' default value will change to 'strict' in future, please explicitly use 'asyncio_mode=strict' or 'asyncio_mode=auto' in pytest configuration file.
    config.issue_config_time_warning(LEGACY_MODE, stacklevel=2)

@mattpap mattpap added this to the 3.0 milestone Feb 17, 2022
@bryevdv bryevdv merged commit 329c98f into bokeh:branch-3.0 Feb 18, 2022
@bryevdv
Copy link
Member

bryevdv commented Feb 18, 2022

Thanks for the PR @benrussell80 !

@benrussell80 benrussell80 deleted the 11716_remove_gen_coroutine_from_docs branch February 18, 2022 20:59
@benrussell80
Copy link
Contributor Author

No problem @bryevdv! I love bokeh, and I'm hoping to be able to contribute more

bryevdv pushed a commit that referenced this pull request May 16, 2022
@benrussell80 @bryevdv
Remove references to gen.coroutine from docs and update without_docum…
2efe2cd 
…ent_lock decorator (#12010)

* Update without_document_lock to decorate async functions and asyncio.coroutines as well

* Update docs to use async functions instead of tornado.gen.coroutines

* Add fact that async funcs are accepted in docstring

* Add test for async func decorated by without_document_lock

* Remove trailing whitespace
@bryevdv bryevdv mentioned this pull request May 16, 2022
Merged
@bryevdv bryevdv modified the milestones: 3.0, 2.4.3 May 16, 2022
bryevdv added a commit that referenced this pull request May 16, 2022
@bryevdv @tcmetzger
@g-parki @roadswitcher @eltociear @ArchaeotheriumSapienter @code-review-doctor @graingert @girolamodaschio @xaptronic @mattpap @benrussell80 @EfremBraun
More 2.4.3 backports (#12130)
1b29f0b 
* Update CONTRIBUTING.MD (#11957)

* track modified files in release build more carefully (#11972)

* Remove katex example (#11894)

* Remove katex example

* Remove test based on katex example

* Revert "Remove test based on katex example"

This reverts commit f0df5ed.

* Cleaner white space/indentation in templates (#11866)

* Enable block trimming, add initial test

* Add test for script start/stops

* Trim comment blocks in templates

* Remove hard-coded white space in templates

* Minimize manual trimming/indenting

* Clean up indentation, standardize CSS/JS

* Simplify new template test

* Expand new test to cover multiple resource modes

* Reduce whitespace around title and scripts

* isort, lint test_templates

* Combine JS/CSS resource defs in test_templates

* Reduce indent of plot script

* Consistent indentation in template itself

* Update template in docs

* 11726 Updated links to visjs.org Graph3d examples (#11728)

* Add sphinx_copybutton (#11993)

* Add sphinx_copybutton

* Update CI environments

* Move sphinx-copybutton to pip dependencies

* Fix typo in tools.py (#11935)

perfrom -> perform

* Fixed a few typos and changed wordings (#11698)

* Fix issue probably-meant-fstring found at https://codereview.doctor (#12097)

* add functools.wraps to _needs_document_lock_wrapper (#11976)

dask.distributed intermittently logs:
`RuntimeWarning: coroutine '_needs_document_lock.<locals>._needs_document_lock_wrapper' was never awaited`
with this wrapper it will be possible to see which method wasn't
awaited

* Md files checking and updating (#11903)

* Update readme

Resolving issue [#11868] (#11868)

* Update README.md

* Update README.md

* Update README.md

* Update commits with comments from #11903

* Update according to #1193 comments

* Update readme to comply code quality test

* update readme to comply code quality issues

* Elaborate on git commit/push process in docs (#11758)

* Add more git instructions

* Fix typo in models contributor guide

* Update sphinx/source/docs/dev_guide/pull_requests.rst

Co-authored-by: Timo Cornelius Metzger <39711796+tcmetzger@users.noreply.github.com>

Co-authored-by: Timo Cornelius Metzger <39711796+tcmetzger@users.noreply.github.com>

* Hover tooltips for Patch and Areas (#11992)

* Initial functioning WIP

* WIP Patch and HArea

* check for potentially null value

* Remove commented out code

* remove unnecessary to_screen call

* break after successful polygon hit test

* Add a comment regarding selection.is_empty()

Co-authored-by: Mateusz Paprocki <mattpap@gmail.com>

* Remove references to gen.coroutine from docs and update without_document_lock decorator (#12010)

* Update without_document_lock to decorate async functions and asyncio.coroutines as well

* Update docs to use async functions instead of tornado.gen.coroutines

* Add fact that async funcs are accepted in docstring

* Add test for async func decorated by without_document_lock

* Remove trailing whitespace

* simplify CI jobs with composite action (#11833)

* simplfy CI jobs with composite action

* lower verbosity on unpack

* Removed unnecessary calls to _recompute_all_models() to speed up adding roots (#11739)

* Removed unnecessary calls to _recompute_all_models() to speed up adding roots

* Corrected last commit so that general calls to add_root() still call recompute_all_models(), and that is only worked around in special situations.

* Wrapping calls to add_root() within push_all_models_freeze()

* Made last commit more elegant by getting rid of loop

Co-authored-by: Efrem Braun <efrem.braun@gmail.comm>

Co-authored-by: Timo Cornelius Metzger <39711796+tcmetzger@users.noreply.github.com>
Co-authored-by: g-parki <61096711+g-parki@users.noreply.github.com>
Co-authored-by: Bill <35750915+roadswitcher@users.noreply.github.com>
Co-authored-by: Ikko Ashimine <eltociear@gmail.com>
Co-authored-by: Harold <eldrickmargarejo@gmail.com>
Co-authored-by: code-review-doctor <72647856+code-review-doctor@users.noreply.github.com>
Co-authored-by: Thomas Grainger <tagrain@gmail.com>
Co-authored-by: girolamo <58935223+girolamodaschio@users.noreply.github.com>
Co-authored-by: Alex Pilon <alex.pilon@gmail.com>
Co-authored-by: Mateusz Paprocki <mattpap@gmail.com>
Co-authored-by: Ben Russell <bprussell80@protonmail.com>
Co-authored-by: Efrem Braun <efrem.braun@gmail.com>
Co-authored-by: Efrem Braun <efrem.braun@gmail.comm>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bryevdv bryevdv bryevdv approved these changes

Assignees
No one assigned
Labels
status: accepted
Projects
None yet
Milestone
2.4.3
Development

Successfully merging this pull request may close these issues.

[BUG] Docs still mention @gen.coroutine
3 participants
@benrussell80 @bryevdv @mattpap