universalasync 0.3.1.2__tar.gz → 0.4.0.0__tar.gz

universalasync-0.4.0.0/.circleci/config.yml

@@ -0,0 +1,124 @@
+version: 2.1
+
+orbs:
+  bitcart: bitcart/bitcart-shared@2
+
+executors:
+  main-executor:
+    parameters:
+      v:
+        type: string
+        default: "3.9"
+
+    docker:
+      - image: cimg/python:<< parameters.v >>
+
+    environment:
+      TEST_ARGS: "--junitxml test-results/pytest/coverage.xml --cov-report html:coverage"
+
+commands:
+  install_dependencies:
+    parameters:
+      cache_dir:
+        type: string
+        default: /home/circleci/.cache/uv
+
+    steps:
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ .Branch }}-{{ checksum "~/.pyenv/version" }}-{{ checksum "uv.lock" }}
+
+      - run:
+          name: Install library
+          command: |
+            curl -LsSf https://astral.sh/uv/install.sh | sh
+            mkdir -p "<<parameters.cache_dir>>" && \
+            uv sync --frozen --compile-bytecode --cache-dir <<parameters.cache_dir>>
+            uv cache prune --ci --cache-dir <<parameters.cache_dir>>
+            echo ". ~/repo/.venv/bin/activate" >> $BASH_ENV
+
+      - save_cache:
+          paths:
+            - "<<parameters.cache_dir>>"
+          key: v1-dependencies-{{ .Branch }}-{{ checksum "~/.pyenv/version" }}-{{ checksum "uv.lock" }}
+
+  upload-results:
+    steps:
+      - store_test_results:
+          path: test-results
+
+      - store_artifacts:
+          path: coverage
+
+      - store_artifacts:
+          path: test-results
+
+jobs:
+  test:
+    parameters:
+      v:
+        type: string
+
+    executor:
+      name: main-executor
+      v: << parameters.v >>
+
+    environment:
+      PYTHON: << parameters.v >>
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - install_dependencies
+
+      - run:
+          name: run fast tests
+          command: |
+            make ci
+
+      - bitcart/codecov
+
+      - upload-results
+
+  deploy:
+    executor: bitcart/docker-python
+    docker:
+      - image: cimg/python:3.8
+    steps:
+      - checkout
+
+      - run:
+          name: upload package
+          command: |
+            curl -LsSf https://astral.sh/uv/install.sh | sh
+            uv build
+            uv publish --token $PYPI_TOKEN
+
+workflows:
+  version: 2
+  test_and_deploy:
+    jobs:
+      - bitcart/lint:
+          name: lint
+      - test:
+          name: test-<< matrix.v >>
+          requires:
+            - lint
+          matrix:
+            parameters:
+              v:
+                - "3.9"
+                - "3.10"
+                - "3.11"
+                - "3.12"
+                - "3.13"
+
+      - deploy:
+          context: global
+          filters:
+            tags:
+              only: /[0-9]+(\.[0-9]+)*/
+            branches:
+              ignore: /.*/

universalasync-0.4.0.0/.editorconfig

@@ -0,0 +1,20 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[Makefile]
+indent_style = tab
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[*.md]
+indent_size = 2
+trim_trailing_whitespace = false

universalasync-0.4.0.0/.gitignore

@@ -0,0 +1,16 @@
+*.egg-info/
+.coverage
+.coverage.*
+.idea/
+.mypy_cache/
+.prettiercache
+.vscode/
+__pycache__/
+backup/
+backups/
+build/
+dist/
+docs/_build
+env/
+htmlcov/
+venv/

universalasync-0.4.0.0/.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-merge-conflict
+  - repo: https://github.com/asottile/yesqa
+    rev: v1.5.0
+    hooks:
+      - id: yesqa
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.3
+    hooks:
+      - id: ruff
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+      - id: file-contents-sorter
+        files: |
+          .gitignore|
+      - id: requirements-txt-fixer
+      - id: check-case-conflict
+      - id: check-shebang-scripts-are-executable
+      - id: check-json
+      - id: check-toml
+      - id: check-yaml
+      - id: check-symlinks
+      - id: debug-statements
+      - id: fix-byte-order-marker
+      - id: detect-private-key
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v4.0.0-alpha.8
+    hooks:
+      - id: prettier
+        require_serial: true
+        args: ["--cache-location=.prettiercache"]

universalasync-0.4.0.0/.readthedocs.yaml

@@ -0,0 +1,17 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+
+sphinx:
+  configuration: docs/conf.py
+
+formats: all
+
+python:
+  install:
+    - method: pip
+      path: .
+    - requirements: docs/requirements.txt

{universalasync-0.3.1.2 → universalasync-0.4.0.0}/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Latest changes
 
+# 0.4.0.0
+
+Drop python 3.8 support
+
+Use ruff & uv as tooling
+
+Support up to python 3.13
+
 ## 0.3.1.2
 
 Drop python 3.7 support

universalasync-0.4.0.0/Makefile

@@ -0,0 +1,17 @@
+all: ci
+
+lint:
+	ruff check
+	mypy universalasync
+
+checkformat:
+	ruff format --check
+
+format:
+	ruff format
+
+test:
+	pytest tests/ ${TEST_ARGS}
+	@coverage combine > /dev/null 2>&1 || true
+
+ci: checkformat lint test

{universalasync-0.3.1.2/universalasync.egg-info → universalasync-0.4.0.0}/PKG-INFO

@@ -1,26 +1,27 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: universalasync
-Version: 0.3.1.2
+Version: 0.4.0.0
 Summary: A library to help automate the creation of universal python libraries
-Home-page: https://github.com/bitcart/universalasync
-Author: MrNaif2018
-Author-email: chuff184@gmail.com
-License: MIT
-Keywords: async,await,bitcart,universal,sync,asyncio,asynctosync,synctoasync
+Project-URL: Homepage, https://github.com/bitcart/universalasync
+Project-URL: Source, https://github.com/bitcart/universalasync
+Project-URL: Changelog, https://github.com/bitcart/universalasync/blob/master/CHANGELOG.md
+Author-email: MrNaif2018 <chuff184@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: async,asyncio,asynctosync,await,bitcart,sync,synctoasync,universal
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Topic :: Utilities
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.8
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-License-File: LICENSE
 
 # universalasync
 

universalasync-0.4.0.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

universalasync-0.4.0.0/docs/api.rst

@@ -0,0 +1,7 @@
+API Reference
+=============
+
+.. automodule:: universalasync
+    :members:
+    :show-inheritance:
+    :undoc-members:

universalasync-0.4.0.0/docs/conf.py

@@ -0,0 +1,64 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# 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.
+#
+import os
+import sys
+
+import pkg_resources
+
+sys.path.insert(0, os.path.abspath(".."))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "universalasync"
+copyright = "2021, MrNaif2018"
+author = "MrNaif2018"
+
+# The full version, including alpha/beta/rc tags
+release = pkg_resources.get_distribution("universalasync").version
+
+
+# -- General configuration ---------------------------------------------------
+
+# 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.napoleon"]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+napoleon_use_rtype = 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 = "sphinx_rtd_theme"
+
+html_theme_options = {
+    "collapse_navigation": True,
+    "sticky_navigation": True,
+    "logo_only": True,
+    "display_version": True,
+    "style_external_links": True,
+}
+
+# readthedocs
+master_doc = "index"

universalasync-0.4.0.0/docs/index.rst

@@ -0,0 +1,88 @@
+.. universalasync documentation master file, created by
+   sphinx-quickstart on Sun Dec 19 21:37:48 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to universalasync's documentation!
+==========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   api
+
+
+A library to help automate the creation of universal python libraries
+
+Overview
+========
+
+Have you ever been frustrated that you need to maintain both sync and async versions of your library, even thought their code differs by just async and await?
+You might have came up to rewriting your code before release or other unreliable solutions.
+
+This library helps you to focus only on the main async implementation of your library: sync one will be created automatically
+
+Via decorating all your public methods, the wrapped functions automatically detect different conditions and run the functions accordingly.
+
+If user uses your library in async context, minimal overhead is added, it just returns the coroutine right away.
+
+Otherwise the library calls the coroutine via various loop methods, like as if you did it manually.
+
+There should be no issues at all, the only limitation is that signals and async subprocesses are supported only when running in the main thread.
+
+Also note that when run from a different os thread, the library will create a new event loop there and run coroutines.
+
+This means that you might need to adapt your code a bit in case you use some resources bound to a certain event loop (like ``aiohttp.ClientSession``).
+
+You can see an example of how this could be solved `here <https://github.com/bitcart/bitcart-sdk/blob/4a425f80f62a0c90f8c5fa19ccb7e578590dcead/bitcart/providers/jsonrpcrequests.py#L51-L58>`_
+
+Installation
+============
+
+``pip install universalasync``
+
+.. _example:
+
+Example of usage
+================
+
+
+.. code-block:: python
+
+        # wrap needed methods one by one
+        class Client:
+            @async_to_sync_wraps
+            async def help():
+                ...
+
+            @async_to_sync_wraps
+            @property
+            async def async_property():
+                ...
+
+        # or wrap whole classes
+        @wrap
+        class Client:
+            async def help(self):
+                ...
+
+            @property
+            async def async_property():
+                ...
+
+        client = Client()
+
+        def sync_call():
+            client.help()
+            client.async_property
+
+        async def async_call():
+            await client.help()
+            await client.async_property
+
+        # works in all cases
+        sync_call()
+        asyncio.run(async_call())
+        threading.Thread(target=sync_call).start()
+        threading.Thread(target=asyncio.run, args=(async_call(),)).start()

universalasync-0.4.0.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 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.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

universalasync-0.4.0.0/docs/requirements.txt

@@ -0,0 +1,6 @@
+commonmark
+mock
+pillow
+recommonmark
+sphinx
+sphinx-rtd-theme

universalasync-0.4.0.0/pyproject.toml

@@ -0,0 +1,88 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "universalasync"
+dynamic = ["version"]
+description = "A library to help automate the creation of universal python libraries"
+readme = "README.md"
+license = "MIT"
+authors = [{ name = "MrNaif2018", email = "chuff184@gmail.com" }]
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Utilities",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+keywords = [
+    "async",
+    "await",
+    "bitcart",
+    "universal",
+    "sync",
+    "asyncio",
+    "asynctosync",
+    "synctoasync",
+]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/bitcart/universalasync"
+Source = "https://github.com/bitcart/universalasync"
+Changelog = "https://github.com/bitcart/universalasync/blob/master/CHANGELOG.md"
+
+[dependency-groups]
+dev = ["pre-commit", "pytest", "pytest-cov", "ruff", "mypy"]
+
+[tool.uv]
+default-groups = ['dev']
+
+[tool.hatch.version]
+path = "universalasync/version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["universalasync"]
+
+[tool.ruff]
+target-version = "py39"
+line-length = 127
+
+[tool.ruff.lint]
+extend-select = ["UP", "B"]
+
+[tool.mypy]
+warn_redundant_casts = true
+warn_unused_ignores = true
+disallow_untyped_calls = true
+disallow_untyped_defs = true
+check_untyped_defs = true
+warn_return_any = true
+no_implicit_optional = true
+strict_optional = true
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+addopts = ["--cov=universalasync", "--cov-report", "term-missing"]
+filterwarnings = [
+    "error::DeprecationWarning",
+    "error::PendingDeprecationWarning",
+]
+
+[tool.coverage.run]
+omit = [
+    "*__init__.py",
+    "tests/*",
+    "venv/*",
+    "env/*",
+    "universalasync/version.py",
+    "setup.py",
+]

{universalasync-0.3.1.2 → universalasync-0.4.0.0}/tests/test_asyncgen.py

@@ -4,11 +4,11 @@ from universalasync import get_event_loop
 
 
 def test_asyncgen(client):
-    assert type(client.async_gen()) == GeneratorType
+    assert type(client.async_gen()) is GeneratorType
     assert list(client.async_gen()) == list(range(10))
 
     async def async_part():
-        assert type(client.async_gen()) == AsyncGeneratorType
+        assert type(client.async_gen()) is AsyncGeneratorType
         assert [i async for i in client.async_gen()] == list(range(10))
 
     loop = get_event_loop()

{universalasync-0.3.1.2 → universalasync-0.4.0.0}/tests/test_usage.py

@@ -72,6 +72,14 @@ async def async_work(client, called):
     called.value = await client.async_method() is True and isinstance(client.async_gen(), types.AsyncGeneratorType)
 
 
+def run_in_process(func, called):
+    obj = SampleClass()
+    result = globals()[func](obj, called)
+    if func.startswith("async_"):
+        result = asyncio.run(result)
+    return result
+
+
 @pytest.mark.parametrize(
     "func",
     [
@@ -86,13 +94,7 @@ async def async_work(client, called):
 def test_async_to_sync_usage(func):
     called = multiprocessing.Value("b", False)
 
-    def inner():
-        obj = SampleClass()
-        result = globals()[func](obj, called)
-        if func.startswith("async_"):
-            result = asyncio.run(result)
-
-    process = multiprocessing.Process(target=inner)
+    process = multiprocessing.Process(target=run_in_process, args=(func, called))
     process.start()
     total = 0
     while not called.value: