Merge pull request #10 from pomponchik/develop

0.0.9

Author: pomponchik

.github/ISSUE_TEMPLATE/question.md

@@ -2,7 +2,7 @@
 name: Question or consultation
 about: Ask anything about this project
 title: ''
-labels: guestion
+labels: question
 assignees: pomponchik
 
 ---

.github/workflows/lint.yml

@@ -1,36 +1,50 @@
 name: Lint
 
-on:
-  push
+on: push
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14", "3.14t"]
 
     steps:
-    - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
-      with:
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
           python-version: ${{ matrix.python-version }}
 
-    - name: Install dependencies
-      shell: bash
-      run: pip install -r requirements_dev.txt
-
-    - name: Install the library
-      shell: bash
-      run: pip install .
-
-    - name: Run ruff
-      shell: bash
-      run: ruff check transfunctions
-
-    - name: Run ruff for tests
-      shell: bash
-      run: ruff check tests
+      - name: Cache pip dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ github.workflow }}-${{ hashFiles('requirements_dev.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-${{ github.workflow }}-
+
+      - name: Install dependencies
+        shell: bash
+        run: pip install -r requirements_dev.txt
+
+      - name: Install the library
+        shell: bash
+        run: pip install .
+
+      - name: Run ruff
+        shell: bash
+        run: ruff check transfunctions
+
+      - name: Run ruff for tests
+        shell: bash
+        run: ruff check tests
+
+      - name: Run mypy
+        shell: bash
+        run: mypy --strict transfunctions
+
+      - name: Run mypy for tests
+        shell: bash
+        run: mypy tests --exclude typing

.github/workflows/release.yml

@@ -15,12 +15,12 @@ jobs:
       # IMPORTANT: this permission is mandatory for trusted publishing
       id-token: write
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
-            python-version: ${{ matrix.python-version }}
+          python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
         shell: bash

.github/workflows/tests_and_coverage.yml

@@ -1,49 +1,55 @@
 name: Tests
 
-on:
-  push
+on: push
 
 jobs:
   build:
-
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [macos-latest, ubuntu-latest, windows-latest]
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14", "3.14t"]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
-      with:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
           python-version: ${{ matrix.python-version }}
 
-    - name: Install the library
-      shell: bash
-      run: pip install .
-
-    - name: Install dependencies
-      shell: bash
-      run: pip install -r requirements_dev.txt
-
-    - name: Print all libs
-      shell: bash
-      run: pip list
-
-    - name: Run tests and show coverage on the command line
-      run: |
-        coverage run --source=transfunctions --omit="*tests*" -m pytest --cache-clear --assert=plain && coverage report -m --fail-under=90
-        coverage xml
-
-    - name: Upload coverage to Coveralls
-      if: runner.os == 'Linux'
-      env:
-        COVERALLS_REPO_TOKEN: ${{secrets.COVERALLS_REPO_TOKEN}}
-      uses: coverallsapp/github-action@v2
-      with:
-        format: cobertura
-        file: coverage.xml
-
-    - name: Run tests and show the branch coverage on the command line
-      run: coverage run --branch --source=transfunctions --omit="*tests*" -m pytest --cache-clear --assert=plain && coverage report -m --fail-under=90
+      - name: Install the library
+        shell: bash
+        run: pip install .
+
+      - name: Cache pip dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ github.workflow }}-${{ hashFiles('requirements_dev.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-${{ github.workflow }}-
+
+      - name: Install dependencies
+        shell: bash
+        run: pip install -r requirements_dev.txt
+
+      - name: Print all libs
+        shell: bash
+        run: pip list
+
+      - name: Run tests and show coverage on the command line
+        run: |
+          coverage run --source=transfunctions --omit="*tests*" -m pytest --cache-clear --assert=plain && coverage report -m --fail-under=94
+          coverage xml
+
+      - name: Upload coverage to Coveralls
+        if: runner.os == 'Linux'
+        env:
+          COVERALLS_REPO_TOKEN: ${{secrets.COVERALLS_REPO_TOKEN}}
+        uses: coverallsapp/github-action@v2
+        with:
+          format: cobertura
+          file: coverage.xml
+
+      - name: Run tests and show the branch coverage on the command line
+        run: coverage run --branch --source=transfunctions --omit="*tests*" -m pytest --cache-clear --assert=plain && coverage report -m --fail-under=94

.gitignore

@@ -6,6 +6,7 @@ test.py
 dist
 venv
 .venv
+venv3
 build
 .ruff_cache
 .mypy_cache
@@ -14,4 +15,5 @@ uv.lock
 .history
 .vscode/
 .idea/
-temp*
+.ropeproject
+node_modules

.ruff.toml

@@ -1,4 +1,5 @@
-![logo](https://raw.githubusercontent.com/pomponchik/transfunctions/develop/docs/assets/logo_2.svg)
+<details>
+  <summary>ⓘ</summary>
 
 [![Downloads](https://static.pepy.tech/badge/transfunctions/month)](https://pepy.tech/project/transfunctions)
 [![Downloads](https://static.pepy.tech/badge/transfunctions)](https://pepy.tech/project/transfunctions)
@@ -11,6 +12,10 @@
 [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
+</details>
+
+![logo](https://raw.githubusercontent.com/pomponchik/transfunctions/develop/docs/assets/logo_2.svg)
+
 This library is designed to solve one of the most important problems in python programming - dividing all written code into 2 camps: sync and async. We get rid of code duplication by using templates.
 
 
@@ -21,6 +26,7 @@ This library is designed to solve one of the most important problems in python p
 - [**Code generation**](#code-generation)
 - [**Markers**](#markers)
 - [**Superfunctions**](#superfunctions)
+- [**Typing**](#typing)
 
 
 ## Quick start
@@ -297,3 +303,34 @@ However, it is not completely free. The fact is that this mode uses a special tr
 - Exceptions will not work normally inside this function. Rather, they can be picked up and intercepted in [`sys.unraisablehook`](https://docs.python.org/3/library/sys.html#sys.unraisablehook), but they will not go up the stack above this function. This is due to a feature of CPython: exceptions that occur inside callbacks for finalizing objects are completely escaped.
 
 This mode is well suited for functions such as logging or sending statistics from your code: simple functions from which no exceptions or return values are expected. In all other cases, I recommend using the tilde syntax.
+
+
+## Typing
+
+Typing is the most difficult problem we faced when developing this library. In most situations, it has already been solved, but in some cases you may still notice flaws when using `mypy` or other static type analyzers. If you encounter similar problems, please [report](https://github.com/pomponchik/transfunctions/issues) them.
+
+There are 2 main difficulties in developing typing here:
+
+- Code generation creates code in runtime that is not in the source files of your project. Whereas most type analyzers look at your code statically, at what is actually present in your files.
+- We mix several types of syntax in a single template function, but the static analyzer does not know that this is a template and part of the code will be deleted from here. In its opinion, this is the final function that will continue to be used in your project.
+
+As you can see, typing in Python is not well suited for metaprogramming. However, in this project, almost all the problems with typing turned out to be solved in one way or another. The main reason why this is so is that we mostly *remove* code from functions, but hardly *add* it there during code generation. In other words, we almost never encounter the problem of how to type the *added* code. This makes the solution to most typing problems accessible. However! Unfortunately, we were not able to completely hide all the typing problems under the hood, but you should still be aware of some of them if you use `mypy` or another analyzer.
+
+If you use the keyword `yield from`, you need to call the function `yield_from_it` instead:
+
+```python
+from transfunctions import yield_it
+
+@superfunction
+def my_superfunction():
+    print('so, ', end='')
+    with sync_context:
+        print("it's just usual function!")
+    with async_context:
+        print("it's an async function!")
+    with generator_context:
+        print("it's a generator function!")
+        yield_from_it([1, 2, 3])
+```
+
+The keywords yield or yield from are available to you and work perfectly, but from the point of view of a static type checker, they turn the function into a generator, which should also mean a special type annotation. By replacing this fragment with a function call, we hack it.

README.md

@@ -4,15 +4,13 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "transfunctions"
-version = "0.0.8"
-authors = [
-  { name="Evgeniy Blinov", email="zheni-b@yandex.ru" },
-]
+version = "0.0.9"
+authors = [{ name = "Evgeniy Blinov", email = "zheni-b@yandex.ru" }]
 description = 'Say NO to Python fragmentation on sync and async'
 readme = "README.md"
 requires-python = ">=3.8"
 dependencies = [
-    'displayhooks>=0.0.4',
+    'displayhooks>=0.0.5',
     'dill==0.4.0',
     'typing_extensions ; python_version <= "3.10"',
 ]
@@ -30,6 +28,9 @@ classifiers = [
     'Programming Language :: Python :: 3.11',
     'Programming Language :: Python :: 3.12',
     'Programming Language :: Python :: 3.13',
+    'Programming Language :: Python :: 3.14',
+    'Programming Language :: Python :: Free Threading',
+    'Programming Language :: Python :: Free Threading :: 3 - Stable',
     'License :: OSI Approved :: MIT License',
     'Intended Audience :: Developers',
     'Topic :: Software Development :: Libraries',
@@ -50,13 +51,16 @@ keywords = [
 "transfunctions" = ["py.typed"]
 
 [tool.mutmut]
-paths_to_mutate="transfunctions"
-runner="pytest"
+paths_to_mutate = "transfunctions"
+runner = "pytest"
 
 [tool.pytest.ini_options]
-markers = [
-    "mypy_testing",
-]
+markers = ["mypy_testing"]
+
+[tool.ruff]
+lint.ignore = ['E501', 'E712', 'PTH123', 'PTH118', 'PLR2004', 'PTH107', 'SIM105', 'SIM102', 'RET503', 'PLR0912', 'C901', 'RUF001']
+lint.select = ["ERA001", "YTT", "ASYNC", "BLE", "B", "A", "COM", "INP", "PIE", "T20", "PT", "RSE", "RET", "SIM", "SLOT", "TID252", "ARG", "PTH", "I", "C90", "N", "E", "W", "D201", "D202", "D419", "F", "PL", "PLE", "PLR", "PLW", "RUF", "TRY201", "TRY400", "TRY401"]
+format.quote-style = "single"
 
 [project.urls]
 'Source' = 'https://github.com/pomponchik/transfunctions'

pyproject.toml

@@ -6,4 +6,4 @@ mypy==1.14.1
 pytest-mypy-testing==0.1.3
 ruff==0.9.9
 mutmut==3.2.3
-full_match==0.0.2
+full_match==0.0.3

requirements_dev.txt

@@ -3,23 +3,23 @@
 from contextlib import redirect_stdout
 
 from transfunctions import (
-    transfunction,
-    sync_context,
     async_context,
     generator_context,
+    sync_context,
+    transfunction,
 )
 
 
 def test_quick_start():
     @transfunction
     def template():
-        print('so, ', end='')
+        print('so, ', end='')  # noqa: T201
         with sync_context:
-            print("it's just usual function!")
+            print("it's just usual function!")  # noqa: T201
         with async_context:
-            print("it's an async function!")
+            print("it's an async function!")  # noqa: T201
         with generator_context:
-            print("it's a generator function!")
+            print("it's a generator function!")  # noqa: T201
             yield
 
     buffer = io.StringIO()