Add Flask 2.x compatibility + fix line number detection under python <= 3.8 and python 3.11 #72

ValentinFrancois · 2023-02-17T11:53:28Z

Issue 1

Cause

When installing Flask 2.0 with python > 3.6, the chosen version of its Jinja2 dependency is >= 3.1.0:

$ docker run -it --rm python:3.7 bash
root@44ff1cecc27d:/# pip3 install Flask==2.0
Collecting Flask==2.0
  Downloading Flask-2.0.0-py3-none-any.whl (93 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.2/93.2 KB 2.5 MB/s eta 0:00:00
Collecting Jinja2>=3.0
  Downloading Jinja2-3.1.2-py3-none-any.whl (133 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.1/133.1 KB 7.5 MB/s eta 0:00:00

With python 3.6, the installed Jinja2 dependency seems to be < 3.1.0 which should not be problematic as I'll explain next.

$ docker run -it --rm python:3.6 bash
root@7a7dccf967f2:/# pip3 install Flask==2.0
Collecting Flask==2.0
  Downloading Flask-2.0.0-py3-none-any.whl (93 kB)
     |████████████████████████████████| 93 kB 1.6 MB/s 
Collecting Jinja2>=3.0
  Downloading Jinja2-3.0.3-py3-none-any.whl (133 kB)
     |████████████████████████████████| 133 kB 6.4 MB/s

Consequences

import flask_selfdoc will then raise an ImportError because it tries to import the follow function and class that were deprecated in Jinja2 3.0 and removed in Jinja2 3.1:

jinja2.evalcontextfilter -> moved to jinja2.pass_eval_context
jinja2.Markup -> moved to jinja2.utils.markupsafe.Markup

Issue 2

Cause

The way that the line number of a decorator is detected changed across python versions:

python <= 3.8: stack()[1].lineno points to the line above the decorated function (= to the closest decorator, not necessarily the one that did the call to stack())
python 3.9 and 3.10: stack()[1].lineno points to the line of the decorated function
python 3.11: stack()[1].lineno points to the exact line of the decorator that did the call to stack()

Example:

    1   |def call_stack_and_get_lineno():
    2   |
    3   |    def decorator(func):
    4   |        calling_frame = stack()[1]
    5   |        print(calling_frame.lineno)
    6   |        return func
    7   |
    8   |    return decorator
    9   |
    10  |
    11  |@decorator1
    12  |@call_stack_and_get_lineno
    13  |@decorator2
    14  |def func():
    15  |    pass

python <= 3.8: will print line 13
python 3.9 and 3.10: will print line 14 (desired behaviour)
python 3.11: will print line 12

Consequences

unit tests don't pass for python 3.11
unit tests pass for python <= 3.8 but only because we adjust them (add a -1 offset to the detected line number)

What this PR does

Issue 1

Avoid Jinja2-related ImportError by trying the old and the new import for each Jinja function/class that is now deprecated
Remove the check Flask < 2.0 from the package dependencies
Adapt the ranges of tested python and Flask versions in the unit tests (WIP)
- minimal-test.yml: remove python 3.7 (security support ends in 4 months), add python 3.10
- test.yml: add Flask 2.1 (not compatible with python 3.6), add python 3.10 and 3.11 (not compatible with Flask 1.0)
Adapt the import of the Flask app context to version 2.3 where _app_ctx_stack is removed
Install target Flask version for tests using pip3 (easier than with poetry) and manually override its dependency versions when they're too recent (itsdangerous, Jinja2 and MarkupSafe for Flask 1.X)
List all installed packages before running tests

Issue 2

Fix line number detection by reading the source file and finding the next line starting with def

jwg4 · 2023-02-17T13:36:47Z

Thanks for this.

I am very in favour in principle; I want to make sure that we do this correctly and that we don't needlessly limit compatibility with older versions.

ValentinFrancois · 2023-02-17T17:29:55Z

@jwg4 cool, I clarified the PR description a bit.

I think I spotted an issue in minimal-test.yml and test.yml that was overwriting the target Flask version from the matrix.

I also added python 3.10 to see which is the oldest supported version of Flask (I already excluded 1.0 based on your README.md).

jwg4 · 2023-02-17T21:02:30Z

looks good in principle
thank you for sorting out the jinja2 mess which I was dreading!
removing Python 3.7 from the quick test matrix seems fine.
adding flask and python versions to the main test matrix and specifying not to run certain toxic combinations also seems like the right decision.
I wonder if we should add 'latest' to the Python version specs, any thoughts?
as you can see above, some of the combinations fail - it seems that poetry will not allow you to specify a version which has a more restrictive Python version than what you have set for your own project, even if your Python version matches both specs. This seems right in principle, but I wonder if there's a way of overriding it for these purposes?
the fact that 6 has only now come up suggests that you are right about the flask versions not actually being correct before your fix.
I think this should be merged as soon as we can find a solution or a workaround for 6.

jwg4 · 2023-02-19T11:02:11Z

thank you so much for this, I have left several comments. let me know if any that don't make sense or you don't think belong to this change.

as you will see, some of them relate to the failing tests which include several causes

ValentinFrancois · 2023-02-20T09:23:35Z

.github/workflows/minimal-test.yml

    runs-on: ${{ matrix.os }}
    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v3


GitHub was encouraging us to update to the most recent action versions, seems harmless

ValentinFrancois · 2023-02-20T09:24:33Z

.github/workflows/minimal-test.yml

+      - name: Force Python version (linux/macOS)
+        if: matrix.os != 'windows-latest'
+        # sed command for macOS: https://stackoverflow.com/a/44864004
+        run: sed -i.bak 's/python = "^3.6"/python = "~${{ matrix.python-version }}"/' pyproject.toml


I couldn't find a better way than sed-replacing the python version in pyproject.toml to the fixed, desired 3.X version.

ValentinFrancois · 2023-02-20T09:24:58Z

.github/workflows/minimal-test.yml

      - name: Install requirements
        run: poetry install
+
+      - name: List installed package versions for manual inspection
+        run: poetry --version && poetry show


just to control what packages we exactly installed in the end

ValentinFrancois · 2023-02-20T09:25:58Z

.github/workflows/test.yml

+        run: poetry add Flask==${{ matrix.flask-version }}
+
+      - name: Overwrite Flask dependencies for legacy install
+        if: matrix.flask-version < '2.0' && matrix.flask-version != 'latest'


some packages that are now too recent when installed via the Flask 1.X dependencies

ValentinFrancois · 2023-02-20T09:27:20Z

.github/workflows/test.yml

      - name: Run doctests
        run: poetry run doctest
+
+  check_pip_install:


add a different test strategy:

given a specific Python runtime version

given a specific Flask version installed

try installing flask-selfdoc via pip and check that we can use it without ImportError
=> this basically tests the dependency configuration in pyproject.toml

ValentinFrancois · 2023-02-20T09:27:55Z

.github/workflows/test.yml

+
+      - name: Install current flask-selfdoc from GitHub
+        run: |
+          git_url=$(echo "${{ github.repositoryUrl }}@${{ github.head_ref }}" | sed "s/git:/git+https:/")


nice way to install from the latest commit of the current PR branch

ValentinFrancois · 2023-02-20T09:28:23Z

.github/workflows/test.yml

+        run: pip3 install werkzeug==2.0.3
+
+      - name: List installed package versions for manual inspection
+        run: python3 --version && pip3 list


control what package versions we exactly installed

ValentinFrancois · 2023-02-20T09:29:02Z

.github/workflows/test.yml

+      - name: List installed package versions for manual inspection
+        run: python3 --version && pip3 list
+
+      - name: Check that Flask version did not change


control that pip's dependency solver didn't need to update the already installed version of Flask

ValentinFrancois · 2023-02-20T09:30:20Z

pyproject.toml

@@ -7,7 +7,11 @@ license = "MIT"

 [tool.poetry.dependencies]
 python = "^3.6"
-Flask = "^1.0"
+Flask = [


express Flask dependency conditionally (depending on the installed version of Python)

I think this solves point 6 that you mentioned here: #72 (comment)

However it is still not possible to rely on the own dependencies config of Flask 1.X because it accepts too recent versions of itsdangerous, Jinja2 and MarkupSafe that cause ImportError etc.
So these have to be manually overwritten with older, compatible versions like I did in test.yml

ValentinFrancois · 2023-02-20T09:35:13Z

@jwg4 sorry I didn't see your previous comments while I was still struggling to solve the issues with poetry & dependency handling.
I think I've come to a good solution, I left a few comments explaining my recent changes.

The only thing I'm not sure about is why the output of flask_selfdoc gets different line numbers depending on the installed python/Flask versions. For now I added some pre-processing function to remove the line numbers from the compared outputs in test_check_example.py but maybe you'll want to investigate this deeper.

ValentinFrancois · 2023-02-20T13:30:54Z

I tried adding tests for latest python as you suggested (3.x, currently evaluating to 3.11.2) but under this version, the unit tests for line numbers don't pass:

So I think there's something defninitely weird with inspect and how it calculates line numbers of caller frames.
Even with a specific python version, the tests can fail depending on the OS because of different line numbers:

I'm removing the code I had added to ignore these line number differences, because it seems to be more important than I first thought.
By the way, I rewrote test.yml to install the target Flask version with pip3, which in the end was easier to use (especially under windows).

jwg4 · 2023-02-20T22:48:19Z

My understanding is that the code which retrieves the line number where a function is defined has changed to take decorators into account in a different way. I believe this is a change in a python built-in which flask uses and does not have control over. I don't know how OS type affects this.

ValentinFrancois · 2023-02-21T13:16:45Z

Interesting, now python 3.11 seems to have changed again the way line number is calculated.

In this unit test, the frame now points to this line:

I suppose this is related to this: https://docs.python.org/3/whatsnew/3.11.html#whatsnew311-inspect but they didn't detail this behavior.

Anyway I figured out we could actually just read the source file and offset the line number by 1 as long as we don't find a line starting with def . Do you think it's a good idea? I suppose it won't work for cythonized code but it's probably ok since this package is meant to document source files, and not files optimized for production?

ValentinFrancois · 2023-02-21T13:18:47Z

flask_selfdoc/autodoc.py


 try:
-    from flask import _app_ctx_stack as stack


With python 3.11 and Flask 2.2.3 I was getting _app_ctx_stack' is deprecated and will be removed in Flask 2.3.
See pallets/flask#4682

ValentinFrancois · 2023-02-21T13:20:35Z

flask_selfdoc/autodoc.py

@@ -153,7 +254,7 @@ def generate(self, groups='all', sort=None):
                    methods=sorted(list(rule.methods)),
                    rule="%s" % rule,
                    endpoint=rule.endpoint,
-                    docstring=func.__doc__,
+                    docstring=func.__doc__.strip(' ') if func.__doc__ else None,


I thought this could be more practical for teams where some developers have an IDE that automatically strips the trailing whitespaces

ValentinFrancois · 2023-02-21T13:21:56Z

flask_selfdoc/autodoc.py

+    def json(self,
+             groups='all',
+             indent: Optional[int] = None,
+             separators: Optional[Tuple] = (',', ':')):


I'm adding some options that are passed to json.dumps, I found it practical to debug the JSON output comparisons in the unit tests. Default options produce the same output as jsonify (i.e. minified JSON)

ValentinFrancois · 2023-02-21T13:24:14Z

tests/config.py

-# The old version chooses the location of the first decorator,
-# the new version chooses the location of the 'def' keyword.
-# We detect the version and support both.
-NEW_FN_OFFSETS = sys.version_info >= (3, 8)


we wouldn't need this anymore because I now try to add some offset if stack()[1].lineno doesn't point to a line starting by def

ValentinFrancois · 2023-02-21T13:24:43Z

tests/files/builtin.json

@@ -1 +1,126 @@
-{"endpoints":[{"args":[],"docstring":"Return all posts.","methods":["GET","HEAD","OPTIONS"],"rule":"/"},{"args":[],"docstring":"Admin interface.","methods":["GET","HEAD","OPTIONS"],"rule":"/admin"},{"args":[["greeting","Hello"],["id",null]],"docstring":"Return the user for the given id.","methods":["GET","HEAD","OPTIONS"],"rule":"/greet/<greeting>/user/<int:id>"},{"args":[["id",-1]],"docstring":"Return the user for the given id.","methods":["GET","HEAD","OPTIONS"],"rule":"/hello/user/<int:id>"},{"args":[],"docstring":"Create a new post.\n    Form Data: title, content, authorid.\n    ","methods":["OPTIONS","POST"],"rule":"/post"},{"args":[["id",null]],"docstring":"Return the post for the given id.","methods":["GET","HEAD","OPTIONS"],"rule":"/post/<int:id>"},{"args":[],"docstring":"Return all posts.","methods":["GET","HEAD","OPTIONS"],"rule":"/posts"},{"args":[["id",null]],"docstring":"Return the user for the given id.","methods":["GET","HEAD","OPTIONS"],"rule":"/user/<int:id>"},{"args":[],"docstring":"Return all users.","methods":["GET","HEAD","OPTIONS"],"rule":"/users"},{"args":[],"docstring":"Creates a new user.\n    Form Data: username.\n    ","methods":["OPTIONS","POST"],"rule":"/users"}]}
+{


this was to debug the unit tests, we can re-minify the output if you prefer

ValentinFrancois · 2023-02-21T13:25:54Z

tests/files/custom.json

-    "rule": "/users"
-  }
-]
+    {


here I just replaced tabs by 2 spaces and removed the trailing whitespaces (more common format imo)

ValentinFrancois · 2023-02-21T13:26:55Z

tests/files/simple.json

@@ -1 +1,185 @@
-[{"args":["None"],"defaults":{},"docstring":"Return all posts.","endpoint":"get_posts","location":{"filename":"%PATH%/examples/simple/blog.py","line":45},"methods":["GET","HEAD","OPTIONS"],"rule":"/"},{"args":["None"],"defaults":{},"docstring":"Admin interface.","endpoint":"admin","location":{"filename":"%PATH%/examples/simple/blog.py","line":113},"methods":["GET","HEAD","OPTIONS"],"rule":"/admin"},{"args":["greeting","id"],"defaults":{"greeting":"Hello"},"docstring":"Return the user for the given id.","endpoint":"greet_user","location":{"filename":"%PATH%/examples/simple/blog.py","line":96},"methods":["GET","HEAD","OPTIONS"],"rule":"/greet/<greeting>/user/<int:id>"},{"args":["id"],"defaults":{"id":-1},"docstring":"Return the user for the given id.","endpoint":"hello_to_user","location":{"filename":"%PATH%/examples/simple/blog.py","line":86},"methods":["GET","HEAD","OPTIONS"],"rule":"/hello/user/<int:id>"},{"args":["None"],"defaults":{},"docstring":"Create a new post.\n    Form Data: title, content, authorid.\n    ","endpoint":"post_post","location":{"filename":"%PATH%/examples/simple/blog.py","line":59},"methods":["OPTIONS","POST"],"rule":"/post"},{"args":["id"],"defaults":{},"docstring":"Return the post for the given id.","endpoint":"get_post","location":{"filename":"%PATH%/examples/simple/blog.py","line":52},"methods":["GET","HEAD","OPTIONS"],"rule":"/post/<int:id>"},{"args":["None"],"defaults":{},"docstring":"Return all posts.","endpoint":"get_posts","location":{"filename":"%PATH%/examples/simple/blog.py","line":45},"methods":["GET","HEAD","OPTIONS"],"rule":"/posts"},{"args":["id"],"defaults":{},"docstring":"Return the user for the given id.","endpoint":"get_user","location":{"filename":"%PATH%/examples/simple/blog.py","line":79},"methods":["GET","HEAD","OPTIONS"],"rule":"/user/<int:id>"},{"args":["None"],"defaults":{},"docstring":"Return all users.","endpoint":"get_users","location":{"filename":"%PATH%/examples/simple/blog.py","line":72},"methods":["GET","HEAD","OPTIONS"],"rule":"/users"},{"args":["None"],"defaults":{},"docstring":"Creates a new user.\n    Form Data: username.\n    ","endpoint":"post_user","location":{"filename":"%PATH%/examples/simple/blog.py","line":103},"methods":["OPTIONS","POST"],"rule":"/users"}]
+[


same as above, it was easier to debug like this but we can re-minify the output

ValentinFrancois · 2023-02-21T13:29:31Z

flask_selfdoc/autodoc.py

+    return response
+
+
+def get_decorator_frame_info(frame) -> dict:


this is the fix for the line numbers that should work with any python version >= 3.6, with some documentation

ValentinFrancois · 2023-02-21T13:30:51Z

flask_selfdoc/autodoc.py

@@ -44,7 +145,10 @@ def init_app(self, app):
        self.add_custom_template_filters(app)

    def teardown(self, exception):
-        ctx = stack.top  # noqa: F841
+        if _cv_app is not None:


I suppose this is some hack to avoid destroying the context or something like that?
I tried to do the same with the new app context object from Flask 2.3.

ValentinFrancois · 2023-02-21T14:07:07Z

In the end the PR got bigger than I first planned, but all tests are green now! I updated the PR description to my latest changes

ValentinFrancois · 2023-02-21T18:57:45Z

just made it work again with pytest, I suppose it didn't like the double inheritance trick

ValentinFrancois · 2023-02-22T18:02:51Z

Sorry I didn't realize that
"${{ github.repositoryUrl }}@${{ github.head_ref }}" would not work on your side,
because ${{ github.repositoryUrl }} points to the repository where the action is running, and not the repository where the PR comes from.

I switched to "${{ github.event.pull_request.head.repo.git_url }}@${{ github.event.pull_request.head.ref }}",
based on https://stackoverflow.com/a/65027014.

Now the check_pip_install tests should always install from the branch in the source repo (forked or not), which should work on your side too.

ValentinFrancois · 2023-02-23T13:28:50Z

My bad, I forgot to do the same in the install step for Windows. Hoping it's the last iteration

ValentinFrancois · 2023-02-26T17:35:02Z

Anything still blocking the merge?

I see one job that seems to be stuck for some reason

ValentinFrancois · 2023-03-17T10:57:58Z

ping

jwg4 · 2023-03-18T12:10:09Z

hi, sorry for delay, I've been very busy with some other work.

ValentinFrancois · 2023-03-31T11:18:09Z

No worries, just let me know if there's anything else I can help with.
I don't really understand why a single job has stayed stuck this whole time:

jwg4 · 2023-04-03T09:43:39Z

do you think that you could rebase and squash your changes?

either into a single commit, into a small number of commits (if it's easy to separate the different changes like that), or failing that, just to remove the changes which were later rolled back or made obsolete by other changes.

after that's done I will give a final review and merge quickly.

jwaxy · 2023-05-05T13:41:19Z

is there any progress in merging this?

- increase range of python and Flask versions tested - test correct install via pip

ValentinFrancois · 2023-05-05T21:20:49Z

Oh thanks for the reminder! Just rebased into a few commits.

jwaxy · 2023-05-06T17:23:34Z

And btw is this library compatible with flask-restful?

ValentinFrancois · 2023-05-07T10:42:32Z

No, the auto documentation logic relies on the Flask.route decorator which is not used in flask-restful.

jwg4

looks good

jwg4 · 2023-02-19T10:51:48Z

.github/workflows/minimal-test.yml

-        run: poetry add flask==${{ matrix.flask-version }}
+        run: pip3 install poetry
+      - name: Force the Flask & python versions
+        run: poetry add Flask==${{ matrix.flask-version }} --python ${{ matrix.python-version }}


this looks good, thank you for finding how to solve this

jwg4 · 2023-02-19T10:52:05Z

.github/workflows/minimal-test.yml

      - name: Install requirements
        run: poetry install
+      - name: List installed package versions for manual inspection
+        run: poetry --version && poetry show


jwg4 · 2023-02-19T10:52:57Z

.github/workflows/test.yml

-        run: poetry add flask==${{ matrix.flask-version }}
+        run: pip3 install poetry
+      - name: Overwrite Flask dependencies for legacy install
+        if: matrix.flask-version < '2.0' && matrix.flask-version != 'latest'


is this a typo? you are checking flask-version twice

(Sorry, just seeing this now)

I wasn't sure how matrix.flask-version < 2.0 would behave in the case where matrix.flask-version == 'latest'.
Now I think matrix.flask-version < '2.0' would be sufficient.

jwg4 · 2023-02-19T10:54:20Z

.github/workflows/test.yml

+      - name: Overwrite Flask dependencies for legacy install
+        if: matrix.flask-version < '2.0' && matrix.flask-version != 'latest'
+        run: |
+          poetry add Jinja2=^2.0 --python ${{ matrix.python-version }}


this is making me think that we have to configure these Flask + deps correctly in pyproject.toml. otherwise the tests will run correctly but people who install it themselves will come up against the jinja2 problems.

jwg4 · 2023-02-19T10:54:49Z

.github/workflows/test.yml

      - name: Run unit tests
        run: poetry run test
      - name: Run doctests
        run: poetry run doctest
+
+  check_pip_install:


Let's put this in a different workflow file?

jwg4 · 2023-02-19T10:55:34Z

.github/workflows/test.yml

+        os: [ubuntu-18.04, macos-latest]
+        exclude:
+          # starting from Flask 2.1.0, python 3.6 is no longer supported:
+          - flask-version: '2.1'


perhaps we should just allow all runs with python 3.6 to fail (or skip them), since it's EOL?

I guess now that python 3.6 is EOL we can indeed simplify the logic and stop testing on it

jwg4 · 2023-02-19T10:56:06Z

.github/workflows/test.yml

+      - name: Install current flask-selfdoc from GitHub
+        run: |
+          git_url=$(echo "${{ github.repositoryUrl }}@${{ github.head_ref }}" | sed "s/git:/git+https:/")
+          pip3 install ${git_url}


this is currently failing

jwg4 · 2023-02-19T10:57:22Z

.github/workflows/test.yml

+            exit 1
+          fi
+      - name: Try importing flask_selfdoc
+        run: python3 -c "import flask_selfdoc"


arguably we could run some tests or an example after importing this way?

If I remember correctly the issue I fixed happened only at import time, but yes running an example is a good idea.

jwg4 · 2023-02-19T10:58:41Z

tests/test_check_example.py

-        return data.replace(file_path, "%PATH%")        
+        return data.replace(file_path, "%PATH%")
+
+    def remove_line_info(self, data):


this is currently failing, I think it the cases where location already isn't a dict?

jwg4 · 2023-02-19T11:00:54Z

tests/test_check_example.py

-        self.assertEqual(data, expected)
+        data = self.remove_line_info(data)
+        try:
+            self.assertEqual(data, expected)


I believe you can pass in a 3rd argument to assertEqual which is an error message. if we do that here, with the error message containing the data and the expected data, we can avoid the try/except

jwg4 mentioned this pull request Feb 17, 2023

Use pip to install a not necessarily fully compatible flask. #73

Open

ValentinFrancois commented Feb 20, 2023

View reviewed changes

ValentinFrancois commented Feb 21, 2023

View reviewed changes

ValentinFrancois changed the title ~~Add Flask 2.x compatibility~~ Add Flask 2.x compatibility + fix line number detection under python <= 3.8 and python 3.11 Feb 21, 2023

ValentinFrancois added 5 commits May 5, 2023 23:06

fix Jinja imports

c56ad25

fix Flask compatibility

688d3a0

fix decorator line number

baa41e9

Add optional JSON doc formatting options and adapt unit tests

e381d32

adapt CI actions

d7f1317

- increase range of python and Flask versions tested - test correct install via pip

ValentinFrancois force-pushed the flask-2.X-compatibility branch from c3d60cf to d7f1317 Compare May 5, 2023 21:17

jwg4 mentioned this pull request May 6, 2023

And btw is this library compatible with flask-restful? #74

Open

jwg4 approved these changes May 21, 2023

View reviewed changes

jwg4 merged commit d594157 into jwg4:main May 21, 2023

ValentinFrancois mentioned this pull request Sep 11, 2023

Make it work on Python 3.10 #61

Open

		@@ -1 +1,126 @@
		{"endpoints":[{"args":[],"docstring":"Return all posts.","methods":["GET","HEAD","OPTIONS"],"rule":"/"},{"args":[],"docstring":"Admin interface.","methods":["GET","HEAD","OPTIONS"],"rule":"/admin"},{"args":[["greeting","Hello"],["id",null]],"docstring":"Return the user for the given id.","methods":["GET","HEAD","OPTIONS"],"rule":"/greet/<greeting>/user/<int:id>"},{"args":[["id",-1]],"docstring":"Return the user for the given id.","methods":["GET","HEAD","OPTIONS"],"rule":"/hello/user/<int:id>"},{"args":[],"docstring":"Create a new post.\n Form Data: title, content, authorid.\n ","methods":["OPTIONS","POST"],"rule":"/post"},{"args":[["id",null]],"docstring":"Return the post for the given id.","methods":["GET","HEAD","OPTIONS"],"rule":"/post/<int:id>"},{"args":[],"docstring":"Return all posts.","methods":["GET","HEAD","OPTIONS"],"rule":"/posts"},{"args":[["id",null]],"docstring":"Return the user for the given id.","methods":["GET","HEAD","OPTIONS"],"rule":"/user/<int:id>"},{"args":[],"docstring":"Return all users.","methods":["GET","HEAD","OPTIONS"],"rule":"/users"},{"args":[],"docstring":"Creates a new user.\n Form Data: username.\n ","methods":["OPTIONS","POST"],"rule":"/users"}]}
		{

		@@ -1 +1,185 @@
		[{"args":["None"],"defaults":{},"docstring":"Return all posts.","endpoint":"get_posts","location":{"filename":"%PATH%/examples/simple/blog.py","line":45},"methods":["GET","HEAD","OPTIONS"],"rule":"/"},{"args":["None"],"defaults":{},"docstring":"Admin interface.","endpoint":"admin","location":{"filename":"%PATH%/examples/simple/blog.py","line":113},"methods":["GET","HEAD","OPTIONS"],"rule":"/admin"},{"args":["greeting","id"],"defaults":{"greeting":"Hello"},"docstring":"Return the user for the given id.","endpoint":"greet_user","location":{"filename":"%PATH%/examples/simple/blog.py","line":96},"methods":["GET","HEAD","OPTIONS"],"rule":"/greet/<greeting>/user/<int:id>"},{"args":["id"],"defaults":{"id":-1},"docstring":"Return the user for the given id.","endpoint":"hello_to_user","location":{"filename":"%PATH%/examples/simple/blog.py","line":86},"methods":["GET","HEAD","OPTIONS"],"rule":"/hello/user/<int:id>"},{"args":["None"],"defaults":{},"docstring":"Create a new post.\n Form Data: title, content, authorid.\n ","endpoint":"post_post","location":{"filename":"%PATH%/examples/simple/blog.py","line":59},"methods":["OPTIONS","POST"],"rule":"/post"},{"args":["id"],"defaults":{},"docstring":"Return the post for the given id.","endpoint":"get_post","location":{"filename":"%PATH%/examples/simple/blog.py","line":52},"methods":["GET","HEAD","OPTIONS"],"rule":"/post/<int:id>"},{"args":["None"],"defaults":{},"docstring":"Return all posts.","endpoint":"get_posts","location":{"filename":"%PATH%/examples/simple/blog.py","line":45},"methods":["GET","HEAD","OPTIONS"],"rule":"/posts"},{"args":["id"],"defaults":{},"docstring":"Return the user for the given id.","endpoint":"get_user","location":{"filename":"%PATH%/examples/simple/blog.py","line":79},"methods":["GET","HEAD","OPTIONS"],"rule":"/user/<int:id>"},{"args":["None"],"defaults":{},"docstring":"Return all users.","endpoint":"get_users","location":{"filename":"%PATH%/examples/simple/blog.py","line":72},"methods":["GET","HEAD","OPTIONS"],"rule":"/users"},{"args":["None"],"defaults":{},"docstring":"Creates a new user.\n Form Data: username.\n ","endpoint":"post_user","location":{"filename":"%PATH%/examples/simple/blog.py","line":103},"methods":["OPTIONS","POST"],"rule":"/users"}]
		[

Add Flask 2.x compatibility + fix line number detection under python <= 3.8 and python 3.11 #72

Add Flask 2.x compatibility + fix line number detection under python <= 3.8 and python 3.11 #72

Conversation

ValentinFrancois commented Feb 17, 2023 • edited Loading

Issue 1

Cause

Consequences

Issue 2

Cause

Example:

Consequences

What this PR does

Issue 1

Issue 2

jwg4 commented Feb 17, 2023

ValentinFrancois commented Feb 17, 2023

jwg4 commented Feb 17, 2023

jwg4 commented Feb 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ValentinFrancois commented Feb 20, 2023

ValentinFrancois commented Feb 20, 2023

jwg4 commented Feb 20, 2023

ValentinFrancois commented Feb 21, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ValentinFrancois commented Feb 21, 2023

ValentinFrancois commented Feb 21, 2023

ValentinFrancois commented Feb 22, 2023

ValentinFrancois commented Feb 23, 2023

ValentinFrancois commented Feb 26, 2023

ValentinFrancois commented Mar 17, 2023

jwg4 commented Mar 18, 2023

ValentinFrancois commented Mar 31, 2023

jwg4 commented Apr 3, 2023

jwaxy commented May 5, 2023

ValentinFrancois commented May 5, 2023

jwaxy commented May 6, 2023

ValentinFrancois commented May 7, 2023

jwg4 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ValentinFrancois commented Feb 17, 2023 •

edited

Loading

jwg4 commented Feb 19, 2023 •

edited

Loading