Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

The error message from PackageLoader could be more helpful #1705

Open
LilyFoote opened this issue Aug 11, 2022 · 1 comment · May be fixed by #1706
Open

The error message from PackageLoader could be more helpful #1705

LilyFoote opened this issue Aug 11, 2022 · 1 comment · May be fixed by #1706

Comments

@LilyFoote
Copy link

When following the basics of setting up jinja2, if you don't create the appropriate templates directory in your package, you get this error message:

ValueError: The 'mypackage' package was not installed in a way that PackageLoader understands.

This could be significantly improved by explaining the actual problem: The PackageLoader could not find a suitable "templates" directory.

To replicate, add this to mypackage.py:

from jinja2 import Environment, PackageLoader


env = Environment(loader=PackageLoader("mypackage"))

If you run python mypackage.py you will see a traceback similar to this:

Traceback (most recent call last):
  File "mypackage/mypackage.py", line 4, in <module>
    env = Environment(loader=PackageLoader("mypackage"))
  File ".virtualenvs/mypackage/lib/python3.10/site-packages/jinja2/loaders.py", line 291, in __init__
    import_module(package_name)
  File ".pyenv/versions/3.10.3/lib/python3.10/importlib/__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1050, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1027, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1006, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 688, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 883, in exec_module
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "mypackage/mypackage.py", line 4, in <module>
    env = Environment(loader=PackageLoader("mypackage"))
  File ".virtualenvs/mypackage/lib/python3.10/site-packages/jinja2/loaders.py", line 323, in __init__
    raise ValueError(
ValueError: The 'mypackage' package was not installed in a way that PackageLoader understands.

Seeing an error message that explained that jinja2 couldn't find an appropriate "templates" directory would be much better.

Environment:

  • Python version: 3.10.3
  • Jinja version: 3.1.2
@davidism
Copy link
Member

Happy to review a PR.

@LilyFoote LilyFoote linked a pull request Aug 11, 2022 that will close this issue
Open
6 tasks
@davidism davidism mentioned this issue Sep 26, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve the PackageLoader error message LilyFoote/jinja
2 participants
@davidism @LilyFoote