././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1622847799.1497161 syncer-1.3.0/0002755000174500001730000000000000000000000012535 5ustar00janitorsbuild././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622847734.0 syncer-1.3.0/LICENSE0000644000174500001730000000207200000000000013541 0ustar00janitorsbuildThe MIT License (MIT) Copyright (c) 2016 Hiroyuki Takagi Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622847734.0 syncer-1.3.0/MANIFEST.in0000644000174500001730000000026300000000000014272 0ustar00janitorsbuildinclude LICENSE include README.rst recursive-include tests * recursive-exclude * __pycache__ recursive-exclude * *.py[co] recursive-include docs *.rst conf.py Makefile make.bat ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1622847799.1497161 syncer-1.3.0/PKG-INFO0000644000174500001730000001012400000000000013626 0ustar00janitorsbuildMetadata-Version: 1.1 Name: syncer Version: 1.3.0 Summary: Async to sync converter Home-page: https://github.com/miyakogi/syncer Author: Hiroyuki Takagi Author-email: miyako.dev@gmail.com License: MIT Description: Syncer ====== .. image:: https://img.shields.io/pypi/v/syncer.svg :target: https://pypi.python.org/pypi/syncer .. image:: https://img.shields.io/pypi/pyversions/syncer.svg :target: https://pypi.python.org/pypi/syncer .. image:: https://img.shields.io/travis/miyakogi/syncer.svg :target: https://travis-ci.org/miyakogi/syncer .. image:: https://codecov.io/github/miyakogi/syncer/coverage.svg?branch=master :target: https://codecov.io/github/miyakogi/syncer?branch=master Syncer is an async-to-sync converter for python. * PyPI: https://pypi.python.org/pypi/syncer/ * Documentation: https://miyakogi.github.io/syncer/ * Source code: https://github.com/miyakogi/syncer/ Features ======== Sometimes (mainly in test) we need to convert asynchronous functions to normal, synchronous functions and run them synchronously. It can be done by ``ayncio.get_event_loop().run_until_complete()``, but it's quite long... Syncer makes this conversion easy. * Convert coroutine-function (defined by ``aync def``) to normal (synchronous) function * Run coroutines synchronously * Support both ``async def`` and decorator (``@asyncio.coroutine``) style Install ======= At the command line:: $ pip install syncer Usage ===== This module has only one function: ``syncer.sync``. .. code-block:: py from syncer import sync async def async_fun(): ... return 1 b = sync(async_fun) # now b is synchronous assert 1 == b() To test the above ``async_fun`` in asynchronous test functions: .. code-block:: py import unittest class TestA(unittest.TestCase): # ``sync`` can be used as decorator. # The decorated function becomes synchronous. @sync async def test_async_fun(self): self.assertEqual(await async_fun(), 1) Or, keep test functions synchronous and get results synchronously: .. code-block:: py class TestA(unittest.TestCase): def test_async_fun(self): # run coroutine and return the result self.assertEqual(sync(async_fun()), 1) # This is equivalent to below, just a shortcut self.assertEqual( asyncio.get_event_loop().run_until_complete(async_fun()), 1) More examples/use-cases will be found in `test `_. License ======= `MIT license `_ Credits ======= This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. .. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage Keywords: syncer Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: MIT License Classifier: Natural Language :: English Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3 :: Only Classifier: Programming Language :: Python :: 3.4 Classifier: Programming Language :: Python :: 3.5 Classifier: Programming Language :: Python :: 3.6 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622847734.0 syncer-1.3.0/README.rst0000644000174500001730000000524500000000000014230 0ustar00janitorsbuildSyncer ====== .. image:: https://img.shields.io/pypi/v/syncer.svg :target: https://pypi.python.org/pypi/syncer .. image:: https://img.shields.io/pypi/pyversions/syncer.svg :target: https://pypi.python.org/pypi/syncer .. image:: https://img.shields.io/travis/miyakogi/syncer.svg :target: https://travis-ci.org/miyakogi/syncer .. image:: https://codecov.io/github/miyakogi/syncer/coverage.svg?branch=master :target: https://codecov.io/github/miyakogi/syncer?branch=master Syncer is an async-to-sync converter for python. * PyPI: https://pypi.python.org/pypi/syncer/ * Documentation: https://miyakogi.github.io/syncer/ * Source code: https://github.com/miyakogi/syncer/ Features ======== Sometimes (mainly in test) we need to convert asynchronous functions to normal, synchronous functions and run them synchronously. It can be done by ``ayncio.get_event_loop().run_until_complete()``, but it's quite long... Syncer makes this conversion easy. * Convert coroutine-function (defined by ``aync def``) to normal (synchronous) function * Run coroutines synchronously * Support both ``async def`` and decorator (``@asyncio.coroutine``) style Install ======= At the command line:: $ pip install syncer Usage ===== This module has only one function: ``syncer.sync``. .. code-block:: py from syncer import sync async def async_fun(): ... return 1 b = sync(async_fun) # now b is synchronous assert 1 == b() To test the above ``async_fun`` in asynchronous test functions: .. code-block:: py import unittest class TestA(unittest.TestCase): # ``sync`` can be used as decorator. # The decorated function becomes synchronous. @sync async def test_async_fun(self): self.assertEqual(await async_fun(), 1) Or, keep test functions synchronous and get results synchronously: .. code-block:: py class TestA(unittest.TestCase): def test_async_fun(self): # run coroutine and return the result self.assertEqual(sync(async_fun()), 1) # This is equivalent to below, just a shortcut self.assertEqual( asyncio.get_event_loop().run_until_complete(async_fun()), 1) More examples/use-cases will be found in `test `_. License ======= `MIT license `_ Credits ======= This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. .. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1622847799.1497161 syncer-1.3.0/docs/0002755000174500001730000000000000000000000013465 5ustar00janitorsbuild././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622847734.0 syncer-1.3.0/docs/Makefile0000644000174500001730000001515200000000000015127 0ustar00janitorsbuild# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) endif # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" @echo " text to make text files" @echo " man to make manual pages" @echo " texinfo to make Texinfo files" @echo " info to make Texinfo files and run them through makeinfo" @echo " gettext to make PO message catalogs" @echo " changes to make an overview of all changed/added/deprecated items" @echo " xml to make Docutils-native XML files" @echo " pseudoxml to make pseudoxml-XML files for display purposes" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/syncer.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/syncer.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/syncer" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/syncer" @echo "# devhelp" epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." latexpdfja: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through platex and dvipdfmx..." $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." texinfo: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." gettext: $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." xml: $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml @echo @echo "Build finished. The XML files are in $(BUILDDIR)/xml." pseudoxml: $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622847734.0 syncer-1.3.0/docs/conf.py0000644000174500001730000002175600000000000014775 0ustar00janitorsbuild#!/usr/bin/env python # -*- coding: utf-8 -*- # # syncer documentation build configuration file, created by # sphinx-quickstart on Tue Jul 9 22:26:36 2013. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys import os # If extensions (or modules to document with autodoc) are in another # directory, add these directories to sys.path here. If the directory is # relative to the documentation root, use os.path.abspath to make it # absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) # Get the project root dir, which is the parent dir of this cwd = os.getcwd() project_root = os.path.dirname(cwd) # Insert the project root dir as the first element in the PYTHONPATH. # This lets us ensure that the source package is imported, and that its # version is used. sys.path.insert(0, project_root) # -- General configuration --------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = 'Syncer' copyright = '2016, Hiroyuki Takagi' # The version info for the project you're documenting, acts as replacement # for |version| and |release|, also used in various other places throughout # the built documents. # # The short X.Y version. version = '1.3.0' # The full version, including alpha/beta/rc tags. release = '1.3.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to # some non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all # documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built # documents. #keep_warnings = False # -- Options for HTML output ------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'alabaster' # Theme options are theme-specific and customize the look and feel of a # theme further. For a list of options available for each theme, see the # documentation. font_family = ', '.join(['"goudy old style"', '"minion pro"', '"bell mt"', 'Georgia', '"Hiragino Mincho Pro"', 'serif', ]) head_font_family = ', '.join(['Garamond', 'Georgia', 'serif']) code_font_family = ', '.join(['Consolas','Menlo', '"Deja Vu Sans Mono"', '"Bitstream Vera Sans Mono"', 'monospace', ]) html_theme_options = { 'description': 'async to sync converter', 'github_user': 'miyakogi', 'github_repo': 'syncer', 'font_family': ', '.join(['"PT Serif"', font_family]), 'head_font_family': ', '.join(['"PT Serif"', head_font_family, ]), 'code_font_family': ', '.join(['"PT Mono"', code_font_family]), } # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as # html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the # top of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon # of the docs. This file should be a Windows icon file (.ico) being # 16x16 or 32x32 pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) # here, relative to this directory. They are copied after the builtin # static files, so a file named "default.css" will overwrite the builtin # "default.css". html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page # bottom, using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. html_sidebars = { '**': [ 'about.html', 'localtoc.html', ] } # Additional templates that should be rendered to pages, maps page names # to template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. # Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. # Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages # will contain a tag referring to it. The value of this option # must be the base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'syncerdoc' # -- Options for LaTeX output ------------------------------------------ latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass # [howto/manual]). latex_documents = [ ('index', 'syncer.tex', 'Syncer Documentation', 'Hiroyuki Takagi', 'manual'), ] # The name of an image file (relative to this directory) to place at # the top of the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings # are parts, not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output ------------------------------------ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'Syncer', 'Syncer Documentation', ['Hiroyuki Takagi'], 1) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ---------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'Syncer', 'Syncer Documentation', 'Hiroyuki Takagi', 'Syncer', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622847734.0 syncer-1.3.0/docs/index.rst0000644000174500001730000000045300000000000015326 0ustar00janitorsbuild.. syncer documentation master file, created by sphinx-quickstart on Tue Jul 9 22:26:36 2013. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. ================= Syncer's Document ================= .. include:: ../README.rst ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622847734.0 syncer-1.3.0/docs/make.bat0000644000174500001730000001447300000000000015101 0ustar00janitorsbuild@ECHO OFF REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set BUILDDIR=_build set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . set I18NSPHINXOPTS=%SPHINXOPTS% . if NOT "%PAPER%" == "" ( set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% ) if "%1" == "" goto help if "%1" == "help" ( :help echo.Please use `make ^` where ^ is one of echo. html to make standalone HTML files echo. dirhtml to make HTML files named index.html in directories echo. singlehtml to make a single large HTML file echo. pickle to make pickle files echo. json to make JSON files echo. htmlhelp to make HTML files and a HTML help project echo. qthelp to make HTML files and a qthelp project echo. devhelp to make HTML files and a Devhelp project echo. epub to make an epub echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter echo. text to make text files echo. man to make manual pages echo. texinfo to make Texinfo files echo. gettext to make PO message catalogs echo. changes to make an overview over all changed/added/deprecated items echo. xml to make Docutils-native XML files echo. pseudoxml to make pseudoxml-XML files for display purposes echo. linkcheck to check all external links for integrity echo. doctest to run all doctests embedded in the documentation if enabled goto end ) if "%1" == "clean" ( for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i del /q /s %BUILDDIR%\* goto end ) %SPHINXBUILD% 2> nul if errorlevel 9009 ( echo. echo.The 'sphinx-build' command was not found. Make sure you have Sphinx echo.installed, then set the SPHINXBUILD environment variable to point echo.to the full path of the 'sphinx-build' executable. Alternatively you echo.may add the Sphinx directory to PATH. echo. echo.If you don't have Sphinx installed, grab it from echo.http://sphinx-doc.org/ exit /b 1 ) if "%1" == "html" ( %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/html. goto end ) if "%1" == "dirhtml" ( %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. goto end ) if "%1" == "singlehtml" ( %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. goto end ) if "%1" == "pickle" ( %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the pickle files. goto end ) if "%1" == "json" ( %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the JSON files. goto end ) if "%1" == "htmlhelp" ( %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run HTML Help Workshop with the ^ .hhp project file in %BUILDDIR%/htmlhelp. goto end ) if "%1" == "qthelp" ( %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: echo.^> qcollectiongenerator %BUILDDIR%\qthelp\syncer.qhcp echo.To view the help file: echo.^> assistant -collectionFile %BUILDDIR%\qthelp\syncer.ghc goto end ) if "%1" == "devhelp" ( %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp if errorlevel 1 exit /b 1 echo. echo.Build finished. goto end ) if "%1" == "epub" ( %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub if errorlevel 1 exit /b 1 echo. echo.Build finished. The epub file is in %BUILDDIR%/epub. goto end ) if "%1" == "latex" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex if errorlevel 1 exit /b 1 echo. echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. goto end ) if "%1" == "latexpdf" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex cd %BUILDDIR%/latex make all-pdf cd %BUILDDIR%/.. echo. echo.Build finished; the PDF files are in %BUILDDIR%/latex. goto end ) if "%1" == "latexpdfja" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex cd %BUILDDIR%/latex make all-pdf-ja cd %BUILDDIR%/.. echo. echo.Build finished; the PDF files are in %BUILDDIR%/latex. goto end ) if "%1" == "text" ( %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text if errorlevel 1 exit /b 1 echo. echo.Build finished. The text files are in %BUILDDIR%/text. goto end ) if "%1" == "man" ( %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man if errorlevel 1 exit /b 1 echo. echo.Build finished. The manual pages are in %BUILDDIR%/man. goto end ) if "%1" == "texinfo" ( %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo if errorlevel 1 exit /b 1 echo. echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. goto end ) if "%1" == "gettext" ( %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale if errorlevel 1 exit /b 1 echo. echo.Build finished. The message catalogs are in %BUILDDIR%/locale. goto end ) if "%1" == "changes" ( %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes if errorlevel 1 exit /b 1 echo. echo.The overview file is in %BUILDDIR%/changes. goto end ) if "%1" == "linkcheck" ( %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck if errorlevel 1 exit /b 1 echo. echo.Link check complete; look for any errors in the above output ^ or in %BUILDDIR%/linkcheck/output.txt. goto end ) if "%1" == "doctest" ( %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest if errorlevel 1 exit /b 1 echo. echo.Testing of doctests in the sources finished, look at the ^ results in %BUILDDIR%/doctest/output.txt. goto end ) if "%1" == "xml" ( %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml if errorlevel 1 exit /b 1 echo. echo.Build finished. The XML files are in %BUILDDIR%/xml. goto end ) if "%1" == "pseudoxml" ( %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml if errorlevel 1 exit /b 1 echo. echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. goto end ) :end ././@PaxHeader0000000000000000000000000000003300000000000010211 xustar0027 mtime=1622847799.153716 syncer-1.3.0/setup.cfg0000644000174500001730000000032400000000000014353 0ustar00janitorsbuild[bumpversion] current_version = 1.3.0 commit = True tag = True [bumpversion:file:setup.py] [bumpversion:file:docs/conf.py] [wheel] universal = 1 [flake8] exclude = docs [egg_info] tag_build = tag_date = 0 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622847734.0 syncer-1.3.0/setup.py0000755000174500001730000000237300000000000014255 0ustar00janitorsbuild#!/usr/bin/env python # -*- coding: utf-8 -*- import sys from os import path from setuptools import setup readme_file = path.join(path.dirname(path.abspath(__file__)), 'README.rst') with open(readme_file) as readme_file: readme = readme_file.read() install_requires = ['typing'] if sys.version_info < (3, 6) else [] test_requirements = ['xfail'] setup( name='syncer', version='1.3.0', description='Async to sync converter', long_description=readme, author='Hiroyuki Takagi', author_email='miyako.dev@gmail.com', url='https://github.com/miyakogi/syncer', py_modules=['syncer'], include_package_data=True, license="MIT", zip_safe=False, keywords='syncer', classifiers=[ 'Development Status :: 5 - Production/Stable', 'Intended Audience :: Developers', 'License :: OSI Approved :: MIT License', 'Natural Language :: English', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3 :: Only', 'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', ], install_requires=install_requires, test_suite='tests', tests_require=test_requirements, ) ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1622847799.1497161 syncer-1.3.0/syncer.egg-info/0002755000174500001730000000000000000000000015532 5ustar00janitorsbuild././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622847799.0 syncer-1.3.0/syncer.egg-info/PKG-INFO0000644000174500001730000001012400000000000016623 0ustar00janitorsbuildMetadata-Version: 1.1 Name: syncer Version: 1.3.0 Summary: Async to sync converter Home-page: https://github.com/miyakogi/syncer Author: Hiroyuki Takagi Author-email: miyako.dev@gmail.com License: MIT Description: Syncer ====== .. image:: https://img.shields.io/pypi/v/syncer.svg :target: https://pypi.python.org/pypi/syncer .. image:: https://img.shields.io/pypi/pyversions/syncer.svg :target: https://pypi.python.org/pypi/syncer .. image:: https://img.shields.io/travis/miyakogi/syncer.svg :target: https://travis-ci.org/miyakogi/syncer .. image:: https://codecov.io/github/miyakogi/syncer/coverage.svg?branch=master :target: https://codecov.io/github/miyakogi/syncer?branch=master Syncer is an async-to-sync converter for python. * PyPI: https://pypi.python.org/pypi/syncer/ * Documentation: https://miyakogi.github.io/syncer/ * Source code: https://github.com/miyakogi/syncer/ Features ======== Sometimes (mainly in test) we need to convert asynchronous functions to normal, synchronous functions and run them synchronously. It can be done by ``ayncio.get_event_loop().run_until_complete()``, but it's quite long... Syncer makes this conversion easy. * Convert coroutine-function (defined by ``aync def``) to normal (synchronous) function * Run coroutines synchronously * Support both ``async def`` and decorator (``@asyncio.coroutine``) style Install ======= At the command line:: $ pip install syncer Usage ===== This module has only one function: ``syncer.sync``. .. code-block:: py from syncer import sync async def async_fun(): ... return 1 b = sync(async_fun) # now b is synchronous assert 1 == b() To test the above ``async_fun`` in asynchronous test functions: .. code-block:: py import unittest class TestA(unittest.TestCase): # ``sync`` can be used as decorator. # The decorated function becomes synchronous. @sync async def test_async_fun(self): self.assertEqual(await async_fun(), 1) Or, keep test functions synchronous and get results synchronously: .. code-block:: py class TestA(unittest.TestCase): def test_async_fun(self): # run coroutine and return the result self.assertEqual(sync(async_fun()), 1) # This is equivalent to below, just a shortcut self.assertEqual( asyncio.get_event_loop().run_until_complete(async_fun()), 1) More examples/use-cases will be found in `test `_. License ======= `MIT license `_ Credits ======= This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. .. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage Keywords: syncer Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: MIT License Classifier: Natural Language :: English Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3 :: Only Classifier: Programming Language :: Python :: 3.4 Classifier: Programming Language :: Python :: 3.5 Classifier: Programming Language :: Python :: 3.6 ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622847799.0 syncer-1.3.0/syncer.egg-info/SOURCES.txt0000644000174500001730000000050000000000000017407 0ustar00janitorsbuildLICENSE MANIFEST.in README.rst setup.cfg setup.py syncer.py docs/Makefile docs/conf.py docs/index.rst docs/make.bat syncer.egg-info/PKG-INFO syncer.egg-info/SOURCES.txt syncer.egg-info/dependency_links.txt syncer.egg-info/not-zip-safe syncer.egg-info/top_level.txt tests/__init__.py tests/test_py34.py tests/test_py35.py././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622847799.0 syncer-1.3.0/syncer.egg-info/dependency_links.txt0000644000174500001730000000000100000000000021576 0ustar00janitorsbuild ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622847799.0 syncer-1.3.0/syncer.egg-info/not-zip-safe0000644000174500001730000000000100000000000017756 0ustar00janitorsbuild ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622847799.0 syncer-1.3.0/syncer.egg-info/top_level.txt0000644000174500001730000000000700000000000020257 0ustar00janitorsbuildsyncer ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622847734.0 syncer-1.3.0/syncer.py0000644000174500001730000000240600000000000014412 0ustar00janitorsbuild#!/usr/bin/env python3 # -*- coding: utf-8 -*- import sys from functools import singledispatch, wraps import asyncio import inspect import types from typing import Any, Callable, Generator PY35 = sys.version_info >= (3, 5) def _is_awaitable(co: Generator[Any, None, Any]) -> bool: if PY35: return inspect.isawaitable(co) else: return (isinstance(co, types.GeneratorType) or isinstance(co, asyncio.Future)) @singledispatch def sync(co: Any): raise TypeError('Called with unsupported argument: {}'.format(co)) @sync.register(asyncio.Future) @sync.register(types.GeneratorType) def sync_co(co: Generator[Any, None, Any]) -> Any: if not _is_awaitable(co): raise TypeError('Called with unsupported argument: {}'.format(co)) return asyncio.get_event_loop().run_until_complete(co) @sync.register(types.FunctionType) @sync.register(types.MethodType) def sync_fu(f: Callable[..., Any]) -> Callable[..., Any]: if not asyncio.iscoroutinefunction(f): raise TypeError('Called with unsupported argument: {}'.format(f)) @wraps(f) def run(*args, **kwargs): return asyncio.get_event_loop().run_until_complete(f(*args, **kwargs)) return run if PY35: sync.register(types.CoroutineType)(sync_co) ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1622847799.1497161 syncer-1.3.0/tests/0002755000174500001730000000000000000000000013677 5ustar00janitorsbuild././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622847734.0 syncer-1.3.0/tests/__init__.py0000644000174500001730000000000000000000000015774 0ustar00janitorsbuild././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622847734.0 syncer-1.3.0/tests/test_py34.py0000644000174500001730000000643400000000000016114 0ustar00janitorsbuild#!/usr/bin/env python # -*- coding: utf-8 -*- """ test_syncer ---------------------------------- Tests and examples """ import asyncio import unittest from xfail import xfail from syncer import sync class TestSyncerPY34(unittest.TestCase): def test_wrap_aioco(self): @asyncio.coroutine def a(): yield from asyncio.sleep(0) return 1 b = sync(a) self.assertEqual(b(), 1) self.assertEqual(sync(a()), 1) def test_wrap_aioco_args(self): @asyncio.coroutine def a(b, c, d=2): yield from asyncio.sleep(0) return d b = sync(a) self.assertEqual(b(1, 2), 2) self.assertEqual(b(1, 2, 3), 3) def test_deco_aioco(self): @sync @asyncio.coroutine def a(): yield from asyncio.sleep(0) return 1 self.assertEqual(a(), 1) def test_deco_aioco_args(self): @sync @asyncio.coroutine def a(b, c, d=2): yield from asyncio.sleep(0.0) return d self.assertEqual(a(1, 2), 2) self.assertEqual(a(1, 2, 3), 3) @sync @asyncio.coroutine def test_deco_testmethod(self): @asyncio.coroutine def a(): yield from asyncio.sleep(0) return 1 b = yield from a() self.assertEqual(b, 1) @xfail(AssertionError, strict=True) @sync @asyncio.coroutine def test_failure(self): '''This test must fail. Without the @sync decorator, this test passes unexpectedly. ''' assert False def test_wrap_method(self): class A: @asyncio.coroutine def a(self): yield from asyncio.sleep(0) return 1 a = A() sync_a = sync(a.a) self.assertEqual(sync_a(), 1) def test_wrap_method_args(self): class A: @asyncio.coroutine def a(self, b, c, d=2): yield from asyncio.sleep(0) return d a = A() sync_a = sync(a.a) self.assertEqual(sync_a(1, 2), 2) self.assertEqual(sync_a(1, 2, 3), 3) def test_deco_method(self): class A: @sync @asyncio.coroutine def a(self): yield from asyncio.sleep(0) return 1 a = A() self.assertEqual(a.a(), 1) def test_deco_method_args(self): class A: @sync @asyncio.coroutine def a(self, b, c, d=2): yield from asyncio.sleep(0) return d a = A() self.assertEqual(a.a(1, 2), 2) self.assertEqual(a.a(1, 2, 3), 3) def test_future(self): f = asyncio.Future() f.set_result(1) self.assertEqual(sync(f), 1) def test_func_error(self): def a(): return 1 with self.assertRaises(TypeError): sync(a) with self.assertRaises(TypeError): sync(a()) def test_gen_error(self): def a(): yield 1 with self.assertRaises(TypeError): sync(a) # Py34 can't check invalid generator # with self.assertRaises(TypeError): # sync(a()) if __name__ == '__main__': unittest.main() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1622847734.0 syncer-1.3.0/tests/test_py35.py0000644000174500001730000000436300000000000016114 0ustar00janitorsbuild#!/usr/bin/env python # -*- coding: utf-8 -*- """ test_syncer ---------------------------------- Tests and examples """ import asyncio import unittest from xfail import xfail from syncer import sync class TestSyncerPY35(unittest.TestCase): def test_wrap_async(self): async def a(): return 1 b = sync(a) self.assertEqual(b(), 1) self.assertEqual(sync(a()), 1) def test_wrap_async_args(self): async def a(b, c, d=2): return d b = sync(a) self.assertEqual(b(1, 2), 2) self.assertEqual(b(1, 2, 3), 3) def test_deco_async(self): @sync async def a(): return 1 self.assertEqual(a(), 1) def test_deco_async_args(self): @sync async def a(b, c, d=2): return d self.assertEqual(a(1, 2), 2) self.assertEqual(a(1, 2, 3), 3) @sync async def test_deco_testmethod(self): async def a(): return 1 b = await a() self.assertEqual(b, 1) @xfail(AssertionError, strict=True) @sync async def test_failure(self): '''This test must fail. Without the @sync decorator, this test passes unexpectedly. ''' assert False def test_wrap_method(self): class A: async def a(self): return 1 a = A() sync_a = sync(a.a) self.assertEqual(sync_a(), 1) def test_wrap_method_args(self): class A: async def a(self, b, c, d=2): return d a = A() sync_a = sync(a.a) self.assertEqual(sync_a(1, 2), 2) self.assertEqual(sync_a(1, 2, 3), 3) def test_deco_method(self): class A: @sync async def a(self): return 1 a = A() self.assertEqual(a.a(), 1) def test_deco_method_args(self): class A: @sync async def a(self, b, c, d=2): return d a = A() self.assertEqual(a.a(1, 2), 2) self.assertEqual(a.a(1, 2, 3), 3) def test_future(self): f = asyncio.Future() f.set_result(1) self.assertEqual(sync(f), 1) if __name__ == '__main__': unittest.main()