0.0.9

.github/workflows/code_review.yml

@@ -0,0 +1,50 @@
+# This workflow runs a locally‑hosted LLM inside the runner to generate critical comments on pull requests
+# Based on: https://remarkablemark.org/blog/2025/02/23/run-ollama-large-language-models-on-github-actions/
+name: A very stupid code review
+
+on:
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+  pull-requests: write
+
+env:
+  MODEL: kirito1/qwen3-coder:4b
+  BOT_NAME: Stupid bot
+
+jobs:
+  code-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Restore the model cache
+        uses: actions/cache@v4
+        with:
+          path: ~/.ollama
+          key: ${{ runner.os }}-${{ env.MODEL }}
+          restore-keys: |
+            ${{ runner.os }}-${{ env.MODEL }}
+
+      # Install ollama
+      - name: Setup ollama
+        uses: ai-action/setup-ollama@v1
+
+      # Pull the model if it hasn't been cached yet
+      - name: Download the model
+        run: ollama pull ${{ env.MODEL }}
+
+      # Checkout repository
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Run code review and comment on PR
+      - name: Code review comment
+        run: |
+          PROMPT="you are given a code (diff from github to be exact). Assume that it's ok by default and answer with 'No problems has been found' if you don't see any critical problems. If you are sure that you spotted a 100% problem, please double-check if you are correct, then give a short answer as to what the problem is. Rarely, you may spot multiple problems. If so, use markdown blocks for each item. Specify extra details only if critically nesseccery. Here's the code given:"
+          RESPONSE=$(ollama run ${{ env.MODEL }} "$PROMPT\n$(gh pr diff $PR_NUMBER)")
+          gh pr comment $PR_NUMBER --body "$RESPONSE"
+        env:
+          GH_TOKEN: ${{ github.token }}
+          PR_NUMBER: ${{ github.event.pull_request.number }}

.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"]
 
     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 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"]
 
     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

@@ -14,4 +14,5 @@ uv.lock
 .history
 .vscode/
 .idea/
-temp*
+.ropeproject
+node_modules

README.md

@@ -21,6 +21,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 +298,15 @@ 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.

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "transfunctions"
-version = "0.0.8"
+version = "0.0.9"
 authors = [
   { name="Evgeniy Blinov", email="zheni-b@yandex.ru" },
 ]

tests/typing/decorators/test_superfunction_typing.py

@@ -16,6 +16,7 @@
 Что нужно проверить:
 
 1. Что await_it, yield_from_it и yield_it типизированы.
+2. Нельзя сохранять возвращаемое значение суперфункции в переменную.
 
 Что проверено:
 

tests/units/decorators/test_superfunction.py

@@ -763,3 +763,21 @@ def function(number=global_variable):
         yield number
 
     assert list(function()) == ['kek']
+
+
+def test_use_decorator_without_at():
+    def template():
+        pass
+
+    with pytest.raises(WrongDecoratorSyntaxError, match=full_match("The @superfunction decorator can only be used with the '@' symbol. Don't use it as a regular function. Also, don't rename it.")):
+        function = superfunction(template)
+        ~function()
+
+
+    with pytest.raises(WrongDecoratorSyntaxError, match=full_match("The @superfunction decorator can only be used with the '@' symbol. Don't use it as a regular function. Also, don't rename it.")):
+        function = superfunction(template)
+        run(function())
+
+    with pytest.raises(WrongDecoratorSyntaxError, match=full_match("The @superfunction decorator can only be used with the '@' symbol. Don't use it as a regular function. Also, don't rename it.")):
+        function = superfunction(template)
+        list(function())

tests/units/decorators/test_transfunction.py

@@ -1532,3 +1532,19 @@ def template(number=SOME_GLOBAL):
     function = template.get_generator_function()
 
     assert list(function()) == ['kek']
+
+
+def test_use_decorator_without_at():
+    def template():
+        pass
+
+    template = transfunction(template)
+
+    with pytest.raises(WrongDecoratorSyntaxError, match=full_match("The @transfunction decorator can only be used with the '@' symbol. Don't use it as a regular function. Also, don't rename it.")):
+        template.get_usual_function()
+
+    with pytest.raises(WrongDecoratorSyntaxError, match=full_match("The @transfunction decorator can only be used with the '@' symbol. Don't use it as a regular function. Also, don't rename it.")):
+        template.get_async_function()
+
+    with pytest.raises(WrongDecoratorSyntaxError, match=full_match("The @transfunction decorator can only be used with the '@' symbol. Don't use it as a regular function. Also, don't rename it.")):
+        template.get_generator_function()

transfunctions/decorators/superfunction.py

@@ -2,7 +2,8 @@
 from ast import AST, NodeTransformer, Return
 from functools import wraps
 from inspect import currentframe
-from typing import Any, Dict, Generic, List, Optional, Union, overload
+from typing import Any, Dict, Generic, List, Optional, Union, Type, overload, cast
+from types import FrameType, TracebackType
 
 from displayhooks import not_display
 
@@ -60,7 +61,7 @@ def __invert__(self) -> ReturnType:
     def send(self, value: Any) -> Any:
         return self.coroutine.send(value)
 
-    def throw(self, exception_type: Any, value: Any = None, traceback: Any = None) -> None:  # pragma: no cover
+    def throw(self, exception_type: Type[BaseException], value: Optional[BaseException] = None, traceback: Optional[TracebackType] = None) -> None:  # type: ignore[override] # pragma: no cover
         pass
 
     def close(self) -> None:  # pragma: no cover
@@ -111,13 +112,12 @@ def superfunction(  # type: ignore[misc]
     def decorator(function: Callable[FunctionParams, ReturnType]) -> Callable[FunctionParams, UsageTracer[FunctionParams, ReturnType]]:
         transformer = FunctionTransformer(
             function,
-            currentframe().f_back.f_lineno,  # type: ignore[union-attr]
+            cast(FrameType, cast(FrameType, currentframe()).f_back).f_lineno,
             "superfunction",
-            currentframe().f_back,
+            cast(FrameType, cast(FrameType, currentframe()).f_back),
         )
 
         if not tilde_syntax:
-
             class NoReturns(NodeTransformer):
                 def visit_Return(self, node: Return) -> Optional[Union[AST, List[AST]]]:
                     raise WrongTransfunctionSyntaxError('A superfunction cannot contain a return statement.')

transfunctions/decorators/transfunction.py

@@ -1,4 +1,6 @@
 from inspect import currentframe
+from typing import cast
+from types import FrameType
 
 from transfunctions.transformer import FunctionTransformer
 from transfunctions.typing import Callable, FunctionParams, ReturnType
@@ -7,4 +9,9 @@
 def transfunction(
     function: Callable[FunctionParams, ReturnType],
 ) -> FunctionTransformer[FunctionParams, ReturnType]:
-    return FunctionTransformer(function, currentframe().f_back.f_lineno, "transfunction", currentframe().f_back)  # type: ignore[union-attr]
+    return FunctionTransformer(
+        function,
+        cast(FrameType, cast(FrameType, currentframe()).f_back).f_lineno,
+        "transfunction",
+        cast(FrameType, cast(FrameType, currentframe()).f_back),
+    )

transfunctions/markers.py

@@ -25,6 +25,6 @@ def create_generator_context() -> Generator[NoReturn, None, None]:
 def await_it(some_expression: Any) -> Any:
     pass   # pragma: no cover
 
-def yield_from_it(some_iterable: IterableWithResults) -> NoReturn:  # type: ignore[misc]
+def yield_from_it(some_iterable: IterableWithResults) -> NoReturn:  # type: ignore[misc, type-arg]
     for value in some_iterable:  # pragma: no cover
         return value  # type: ignore[misc]