I'm running a virtual environment with the latest Python from Homebrew on macOS:

python --version
Python 3.9.2

I'm taking the FastAPI Web App course and I'm trying to install fastapi-chameleon from both this repo and my fork both error out:

 silversaucer> pip install git+https://github.com/mikeckennedy/fastapi-chameleon

Collecting git+https://github.com/mikeckennedy/fastapi-chameleon
  Cloning https://github.com/mikeckennedy/fastapi-chameleon to /private/var/folders/y8/p92hytfj04b7_92zv1ppn1s00000gn/T/pip-req-build-mp91okuf
  Running command git clone -q https://github.com/mikeckennedy/fastapi-chameleon /private/var/folders/y8/p92hytfj04b7_92zv1ppn1s00000gn/T/pip-req-build-mp91okuf
    ERROR: Command errored out with exit status 1:
     command: /Users/prcutler/workspace/silversaucer/.venvfastapi/bin/python -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/private/var/folders/y8/p92hytfj04b7_92zv1ppn1s00000gn/T/pip-req-build-mp91okuf/setup.py'"'"'; __file__='"'"'/private/var/folders/y8/p92hytfj04b7_92zv1ppn1s00000gn/T/pip-req-build-mp91okuf/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' egg_info --egg-base /private/var/folders/y8/p92hytfj04b7_92zv1ppn1s00000gn/T/pip-pip-egg-info-z72h9h4o
         cwd: /private/var/folders/y8/p92hytfj04b7_92zv1ppn1s00000gn/T/pip-req-build-mp91okuf/
    Complete output (7 lines):
    Traceback (most recent call last):
      File "<string>", line 1, in <module>
      File "/Users/prcutler/workspace/silversaucer/.venvfastapi/lib/python3.9/site-packages/setuptools/__init__.py", line 14, in <module>
        from setuptools.dist import Distribution
      File "/Users/prcutler/workspace/silversaucer/.venvfastapi/lib/python3.9/site-packages/setuptools/dist.py", line 30, in <module>
        from . import SetuptoolsDeprecationWarning
    ImportError: cannot import name 'SetuptoolsDeprecationWarning' from partially initialized module 'setuptools' (most likely due to a circular import) (/Users/prcutler/workspace/silversaucer/.venvfastapi/lib/python3.9/site-packages/setuptools/__init__.py)
    ----------------------------------------
WARNING: Discarding git+https://github.com/mikeckennedy/fastapi-chameleon. Command errored out with exit status 1: python setup.py egg_info Check the logs for full command output.
ERROR: Command errored out with exit status 1: python setup.py egg_info Check the logs for full command output.

All my Python modules appear up to date:

Is there something I'm missing or I should try? Is there any other info needed?

Thanks!

Each specific rest requires global_init() to be ran before it can be run. The test_can_call_init_with_good_path() test does this, and that appears to enable all other tests to run.

def test_can_call_init_with_good_path():
    fc.global_init(folder, cache_init=False)

If you run various tests individually, they error out because global_init is not called. I am working on a fix for the fastapi-jinja library that uses a pytest fixture to make this work. I am basically creating a fixture that is like this:

@pytest.fixture
def call_global_init():
    here = os.path.dirname(__file__)
    folder = os.path.join(here, "templates")
    fc.global_init(folder, cache_init=False)

The fixture could then be added to any test that requires global init to be called. It should work, but I want to verify.

How can I add a custom response header when using fastapi-chameleon?

If I use chameleon "manually", the response header is added as expected:

@router.get("/headers-1/", response_class=HTMLResponse)
async def get_headers_1(request: Request, response: Response):
    response.headers["HX-Refresh"] = "true"
    template = templates["hello.pt"]
    return template.render(name="Alice")

But when I use the template decorator, the "HX-Refresh" header is not included in the response:

@router.get("/headers-2/")
@template(template_file='hello.pt')
async def get_headers_2(request: Request, response: Response):
    response.headers["HX-Refresh"] = "true"
    return {'name': "Bob"}

My hello.py contains

<div>Hello, ${name}.</div>

I have my templates folder within the same directory as my main.py file from which I am calling the templates folder.

The code in the main.py looks like this:

import fastapi
import uvicorn
import fastapi_chameleon
from fastapi_chameleon import template


app = fastapi.FastAPI()
fastapi_chameleon.global_init("templates")


@app.get("/")
@template(template_file="index.html")
def index():
    return {
        "user_name": "usernameExample"
    }


if __name__ == "__main__":
    uvicorn.run(app)
else:
    pass

I get an error message:

"c:/Users/username/OneDrive - Dynatrace/Pictures/pypi/application/venv/Scripts/python.exe" "c:/Users/username/OneDrive - Dynatrace/Pictures/pypi/application/main.py"
Traceback (most recent call last):
  File "c:\Users\username\OneDrive - Dynatrace\Pictures\pypi\application\main.py", line 8, in <module>
    fastapi_chameleon.global_init(".templates")
  File "C:\Users\username\OneDrive - Dynatrace\Pictures\pypi\application\venv\lib\site-packages\fastapi_chameleon\engine.py", line 27, in global_init
    raise FastAPIChameleonException(msg)
fastapi_chameleon.exceptions.FastAPIChameleonException: The specified template folder must be a folder, it's not: templates

On Windows

Hi Michael; thanks for creating this. Is there a checklist you may have around to understand what would be needed to release this package into the wild? even if it is a beta version for the time being?

Also, would you need help with that? I am happy to help.

From a student:

In ch4, when I try to run your main.py, I get this:

C:/Users/user/FS-FAPI/source/web-applications-with-fastapi-course/code/ch4-templates/main.py
Traceback (most recent call last):
  File "C:\Users\user\FS-FAPI\source\web-applications-with-fastapi-course\code\ch4-templates\main.py", line 7, in <module>
    from views import home
  File "C:\Users\user\FS-FAPI\source\web-applications-with-fastapi-course\code\ch4-templates\views\home.py", line 9, in <module>
    def index():
  File "C:\Users\user\FS-FAPI\venv\lib\site-packages\fastapi_chameleon\engine.py", line 72, in response_inner
    if not os.path.exists(os.path.join(template_path, template_file)):
  File "C:\Users\user\AppData\Local\Programs\Python\Python39\lib\ntpath.py", line 78, in join
    path = os.fspath(path)
TypeError: expected str, bytes or os.PathLike object, not NoneType

Process finished with exit code 1

Looks a timing issue between calling global init and "using" the decorator.

Hello, got this error trying to run using ch5-viewmodels from TalkPython Course... template_path is None.

I believe the problem is that fastapi_chameleon.global_init() is called after from fastapi_chameleon import template in home.py

Exception has occurred: TypeError       (note: full exception trace is shown but execution is paused at: _run_module_as_main)
expected str, bytes or os.PathLike object, not NoneType
  File "/home/cristiana/anaconda3/envs/fastapi/lib/python3.9/posixpath.py", line 76, in join
    a = os.fspath(a)
  File "/home/cristiana/anaconda3/envs/fastapi/lib/python3.9/site-packages/fastapi_chameleon/engine.py", line 72, in response_inner
    if not os.path.exists(os.path.join(template_path, template_file)):
  File "/home/cristiana/AAA-wip/Cursos-Programming/Curso-TalkPython-FastAPI-FullWeb/web-applications-with-fastapi-cris/views/home.py", line 13, in <module>
    def index(request: Request):
  File "/home/cristiana/AAA-wip/Cursos-Programming/Curso-TalkPython-FastAPI-FullWeb/web-applications-with-fastapi-cris/main.py", line 7, in <module>
    from views import home
  File "/home/cristiana/anaconda3/envs/fastapi/lib/python3.9/runpy.py", line 87, in _run_code
    exec(code, run_globals)
  File "/home/cristiana/anaconda3/envs/fastapi/lib/python3.9/runpy.py", line 97, in _run_module_code
    _run_code(code, mod_globals, init_globals,
  File "/home/cristiana/anaconda3/envs/fastapi/lib/python3.9/runpy.py", line 268, in run_path
    return _run_module_code(code, init_globals, run_name,
  File "/home/cristiana/anaconda3/envs/fastapi/lib/python3.9/runpy.py", line 87, in _run_code
    exec(code, run_globals)
  File "/home/cristiana/anaconda3/envs/fastapi/lib/python3.9/runpy.py", line 197, in _run_module_as_main (Current frame)
    return _run_code(code, main_globals, None,

With FastAPI requiring Python 3.6+ there isnt a need to test on Python 2.7 or the other older versions of Python. You could then remove the dev dependency on six.

Now each test is isolated and can be run on its own thanks to pytest fixtures as discussed in https://github.com/mikeckennedy/fastapi-chameleon/issues/13.

In what situation do you want to return an empty dict in this case? Seems like you'd more likely want to try to coerce to a dict and fail over to an empty dict? Though maybe you are just trying to account for None, in which case maybe it should be an elif response_val is None?

try:
    model = dict(response_val)
except TypeError:
    model = {}

https://github.com/mikeckennedy/fastapi-chameleon/blob/4ffff6b14e5467fd802940fb32dba6b1f35d6d85/fastapi_chameleon/engine.py#L89-L90

Currently, we guess at the template name if not supplied:

templates/module_name/view_method_name.pt

Let's also look for templates/module_name/view_method_name.html and use whichever one we find.

I'm trying to build a video collector similar to the one from your HTMX course. Mine uses FastAPI, Chameleon, Beanie. I'm having trouble rendering the search results due to the conditional partial render inside of the view method. I don't know how to render a template when it's inside the view method like that, only done it through the decorator on the view method function itself.

How would I implement something like this in fastapi-chameleon?

html = flask.render_template('videos/partials/search_results.html', videos=vm.videos)
return flask.make_response(html)

I have tried the following with from fastapi_chameleon import template imported

html = template(template_file="videos/partials/search_results.pt", videos=vm.videos)
return fastapi.responses.HTMLResponse(html)

I also tried getting creative and reading through your fastapi-chameleon source, so I tried

page: PageTemplate = "/usr/home/roller/Projects/coach-aaron/templates/videos/partials/search_results.pt"
return page.render(encoding='utf-8', videos=vm.videos)

That didn't work either.

At the moment I'm going to try following the FastAPI docs If I have to for now I'll do just this one partial using Jinja if I can get it to do that.. we'll see. I appreciate any help or suggestions you may have on this. I'll definitely submit this webapp I'm working on to the Student Creation Showcase once it's ready enough and is actually doing interesting things.

First of all, thanks for this great piece of code. Made my life a lot easier by eliminating a lot of boilerplate code. :) :+1:

I'm working o a project right now that requires me to perform certain authorization operations on various operations. Some operations are permitted only to a certain group of people. For example it would make sense to return a 401 to a user if they are not part of a specific privileged group. Or, maybe there is something specific about a request that makes it simply off-limits always. And in that case returning 403 would fit even better.

Please, take a look at this PR. It's introducing a new function generic_error() that allows the user to specify particular details about the error they want to return to the user. For the above examples I'd be able to e.g.:

return fastapi_chameleon.generic_error("errors/my_unauthorized_template.ts", 401)

Works just like not_found(), but allows to specify the status code.