python-liquid 1.13.0__tar.gz → 2.0.0__tar.gz

python_liquid-2.0.0/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.4
+Name: python-liquid
+Version: 2.0.0
+Summary: A Python engine for the Liquid template language.
+Project-URL: Change Log, https://github.com/jg-rp/liquid/blob/main/CHANGES.md
+Project-URL: Documentation, https://jg-rp.github.io/liquid/
+Project-URL: Homepage, https://jg-rp.github.io/liquid/
+Project-URL: Issue Tracker, https://github.com/jg-rp/liquid/issues
+Project-URL: Source Code, https://github.com/jg-rp/liquid
+Author-email: James Prior <jamesgr.prior@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.7
+Requires-Dist: babel>=2
+Requires-Dist: markupsafe>=3
+Requires-Dist: python-dateutil>=2.8.1
+Requires-Dist: pytz
+Description-Content-Type: text/markdown
+
+<h1 align="center">Python Liquid</h1>
+
+<p align="center">
+Python Liquid is a Python engine for <a href="https://shopify.github.io/liquid/">Liquid</a>, the safe, customer-facing template language.
+<br>
+We follow <a href="https://github.com/Shopify/liquid">Shopify/Liquid</a> closely and test against the <a href="https://github.com/jg-rp/golden-liquid">Golden Liquid</a> test suite.
+</p>
+<p align="center">
+  <a href="https://github.com/jg-rp/liquid/blob/main/LICENSE">
+    <img src="https://img.shields.io/pypi/l/python-liquid.svg?style=flat-square" alt="License">
+  </a>
+  <br>
+  <a href="https://pypi.org/project/python-liquid/">
+    <img src="https://img.shields.io/pypi/v/python-liquid.svg?style=flat-square" alt="PyPi - Version">
+  </a>
+  <a href="https://anaconda.org/conda-forge/python-liquid">
+    <img src="https://img.shields.io/conda/vn/conda-forge/python-liquid?style=flat-square" alt="conda-forge">
+  </a>
+  <br>
+  <a href="https://pypi.org/project/python-liquid/">
+    <img src="https://img.shields.io/pypi/pyversions/python-liquid.svg?style=flat-square" alt="Python versions">
+  </a>
+  <a href="https://github.com/jg-rp/liquid/actions/workflows/coverage.yaml">
+    <img src="https://img.shields.io/badge/pypy-3.7%20%7C%203.8%20%7C%203.9-blue?style=flat-square" alt="PyPy versions">
+  </a>
+  <br>
+  <a href="https://github.com/jg-rp/liquid/actions/workflows/tests.yaml">
+    <img src="https://img.shields.io/github/actions/workflow/status/jg-rp/liquid/tests.yaml?branch=main&label=tests&style=flat-square" alt="Tests">
+  </a>
+  <a href="https://github.com/jg-rp/liquid/actions/workflows/coverage.yaml">
+    <img src="https://img.shields.io/github/actions/workflow/status/jg-rp/liquid/coverage.yaml?branch=main&label=coverage&style=flat-square" alt="Coverage">
+  </a>
+  <br>
+  <a href="https://pypi.org/project/python-liquid/">
+    <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/python-liquid?style=flat-square">
+  </a>
+</p>
+
+---
+
+**Table of Contents**
+
+- [Install](#install)
+- [Links](#links)
+- [Related Projects](#related-projects)
+- [Quick Start](#example)
+- [Contributing](#contributing)
+
+## Install
+
+Install Python Liquid using [Pipenv](https://pipenv.pypa.io/en/latest/):
+
+```shell
+$ pipenv install -u python-liquid
+```
+
+Or [pip](https://pip.pypa.io/en/stable/getting-started/):
+
+```shell
+$ pip install python-liquid
+```
+
+Or from [conda-forge](https://anaconda.org/conda-forge/python-liquid):
+
+```shell
+$ conda install -c conda-forge python-liquid
+```
+
+## Links
+
+- Documentation: https://jg-rp.github.io/liquid/
+- Documentation for Python Liquid version 1.x: https://jg-rp.github.io/python-liquid-docs-archive/
+- Change Log: https://github.com/jg-rp/liquid/blob/main/CHANGES.md
+- PyPi: https://pypi.org/project/python-liquid/
+- Source Code: https://github.com/jg-rp/liquid
+- Issue Tracker: https://github.com/jg-rp/liquid/issues
+
+## Related Projects
+
+- [Python Liquid2](https://github.com/jg-rp/python-liquid2): A new Python engine for Liquid with [extra features](https://jg-rp.github.io/python-liquid2/migration/#new-features).
+- [LiquidScript](https://github.com/jg-rp/liquidscript): A JavaScript engine for Liquid with a similar high-level API to Python Liquid.
+
+## Quick Start
+
+### `render()`
+
+This example renders a template from a string of text with the package-level `render()` function. The template has just one placeholder variable `you`, which we've given the value `"World"`.
+
+```python
+from liquid import render
+
+print(render("Hello, {{ you }}!", you="World"))
+# Hello, World!
+```
+
+### `parse()`
+
+Often you'll want to render the same template several times with different variables. We can parse source text without immediately rendering it using the `parse()` function. `parse()` returns a `BoundTemplate` instance with a `render()` method.
+
+```python
+from liquid import parse
+
+template = parse("Hello, {{ you }}!")
+print(template.render(you="World"))  # Hello, World!
+print(template.render(you="Liquid"))  # Hello, Liquid!
+```
+
+### Configure
+
+Both `parse()` and `render()` are convenience functions that use the default Liquid environment. For all but the simplest cases, you'll want to configure an instance of `Environment`, then load and render templates from that.
+
+```python
+from liquid import CachingFileSystemLoader
+from liquid import Environment
+
+env = Environment(
+    autoescape=True,
+    loader=CachingFileSystemLoader("./templates"),
+)
+```
+
+Then, using `env.parse()` or `env.get_template()`, we can create a `BoundTemplate` from a string or read from the file system, respectively.
+
+```python
+# ... continued from above
+template = env.parse("Hello, {{ you }}!")
+print(template.render(you="World"))  # Hello, World!
+
+# Try to load "./templates/index.html"
+another_template = env.get_template("index.html")
+data = {"some": {"thing": [1, 2, 3]}}
+result = another_template.render(**data)
+```
+
+Unless you happen to have a relative folder called `templates` with a file called `index.html` within it, we would expect a `TemplateNotFoundError` to be raised when running the example above.
+
+## Contributing
+
+Please see [Contributing to Python Liquid](https://github.com/jg-rp/liquid/blob/main/contributing.md).

python_liquid-2.0.0/README.md

@@ -0,0 +1,139 @@
+<h1 align="center">Python Liquid</h1>
+
+<p align="center">
+Python Liquid is a Python engine for <a href="https://shopify.github.io/liquid/">Liquid</a>, the safe, customer-facing template language.
+<br>
+We follow <a href="https://github.com/Shopify/liquid">Shopify/Liquid</a> closely and test against the <a href="https://github.com/jg-rp/golden-liquid">Golden Liquid</a> test suite.
+</p>
+<p align="center">
+  <a href="https://github.com/jg-rp/liquid/blob/main/LICENSE">
+    <img src="https://img.shields.io/pypi/l/python-liquid.svg?style=flat-square" alt="License">
+  </a>
+  <br>
+  <a href="https://pypi.org/project/python-liquid/">
+    <img src="https://img.shields.io/pypi/v/python-liquid.svg?style=flat-square" alt="PyPi - Version">
+  </a>
+  <a href="https://anaconda.org/conda-forge/python-liquid">
+    <img src="https://img.shields.io/conda/vn/conda-forge/python-liquid?style=flat-square" alt="conda-forge">
+  </a>
+  <br>
+  <a href="https://pypi.org/project/python-liquid/">
+    <img src="https://img.shields.io/pypi/pyversions/python-liquid.svg?style=flat-square" alt="Python versions">
+  </a>
+  <a href="https://github.com/jg-rp/liquid/actions/workflows/coverage.yaml">
+    <img src="https://img.shields.io/badge/pypy-3.7%20%7C%203.8%20%7C%203.9-blue?style=flat-square" alt="PyPy versions">
+  </a>
+  <br>
+  <a href="https://github.com/jg-rp/liquid/actions/workflows/tests.yaml">
+    <img src="https://img.shields.io/github/actions/workflow/status/jg-rp/liquid/tests.yaml?branch=main&label=tests&style=flat-square" alt="Tests">
+  </a>
+  <a href="https://github.com/jg-rp/liquid/actions/workflows/coverage.yaml">
+    <img src="https://img.shields.io/github/actions/workflow/status/jg-rp/liquid/coverage.yaml?branch=main&label=coverage&style=flat-square" alt="Coverage">
+  </a>
+  <br>
+  <a href="https://pypi.org/project/python-liquid/">
+    <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/python-liquid?style=flat-square">
+  </a>
+</p>
+
+---
+
+**Table of Contents**
+
+- [Install](#install)
+- [Links](#links)
+- [Related Projects](#related-projects)
+- [Quick Start](#example)
+- [Contributing](#contributing)
+
+## Install
+
+Install Python Liquid using [Pipenv](https://pipenv.pypa.io/en/latest/):
+
+```shell
+$ pipenv install -u python-liquid
+```
+
+Or [pip](https://pip.pypa.io/en/stable/getting-started/):
+
+```shell
+$ pip install python-liquid
+```
+
+Or from [conda-forge](https://anaconda.org/conda-forge/python-liquid):
+
+```shell
+$ conda install -c conda-forge python-liquid
+```
+
+## Links
+
+- Documentation: https://jg-rp.github.io/liquid/
+- Documentation for Python Liquid version 1.x: https://jg-rp.github.io/python-liquid-docs-archive/
+- Change Log: https://github.com/jg-rp/liquid/blob/main/CHANGES.md
+- PyPi: https://pypi.org/project/python-liquid/
+- Source Code: https://github.com/jg-rp/liquid
+- Issue Tracker: https://github.com/jg-rp/liquid/issues
+
+## Related Projects
+
+- [Python Liquid2](https://github.com/jg-rp/python-liquid2): A new Python engine for Liquid with [extra features](https://jg-rp.github.io/python-liquid2/migration/#new-features).
+- [LiquidScript](https://github.com/jg-rp/liquidscript): A JavaScript engine for Liquid with a similar high-level API to Python Liquid.
+
+## Quick Start
+
+### `render()`
+
+This example renders a template from a string of text with the package-level `render()` function. The template has just one placeholder variable `you`, which we've given the value `"World"`.
+
+```python
+from liquid import render
+
+print(render("Hello, {{ you }}!", you="World"))
+# Hello, World!
+```
+
+### `parse()`
+
+Often you'll want to render the same template several times with different variables. We can parse source text without immediately rendering it using the `parse()` function. `parse()` returns a `BoundTemplate` instance with a `render()` method.
+
+```python
+from liquid import parse
+
+template = parse("Hello, {{ you }}!")
+print(template.render(you="World"))  # Hello, World!
+print(template.render(you="Liquid"))  # Hello, Liquid!
+```
+
+### Configure
+
+Both `parse()` and `render()` are convenience functions that use the default Liquid environment. For all but the simplest cases, you'll want to configure an instance of `Environment`, then load and render templates from that.
+
+```python
+from liquid import CachingFileSystemLoader
+from liquid import Environment
+
+env = Environment(
+    autoescape=True,
+    loader=CachingFileSystemLoader("./templates"),
+)
+```
+
+Then, using `env.parse()` or `env.get_template()`, we can create a `BoundTemplate` from a string or read from the file system, respectively.
+
+```python
+# ... continued from above
+template = env.parse("Hello, {{ you }}!")
+print(template.render(you="World"))  # Hello, World!
+
+# Try to load "./templates/index.html"
+another_template = env.get_template("index.html")
+data = {"some": {"thing": [1, 2, 3]}}
+result = another_template.render(**data)
+```
+
+Unless you happen to have a relative folder called `templates` with a file called `index.html` within it, we would expect a `TemplateNotFoundError` to be raised when running the example above.
+
+## Contributing
+
+Please see [Contributing to Python Liquid](https://github.com/jg-rp/liquid/blob/main/contributing.md).

python_liquid-2.0.0/liquid/__init__.py

@@ -0,0 +1,246 @@
+from pathlib import Path
+from typing import Iterable
+from typing import Iterator
+from typing import Optional
+from typing import TextIO
+from typing import Union
+
+from markupsafe import Markup
+from markupsafe import escape
+from markupsafe import soft_str
+
+from .mode import Mode
+from .token import Token
+from .expression import Expression
+
+from .context import RenderContext
+from .context import FutureContext
+from .undefined import DebugUndefined
+from .undefined import is_undefined
+from .undefined import FalsyStrictUndefined
+from .undefined import StrictDefaultUndefined
+from .undefined import StrictUndefined
+from .undefined import Undefined
+
+from .environment import Environment
+from .environment import Template
+
+from .template import AwareBoundTemplate
+from .template import BoundTemplate
+from .template import FutureAwareBoundTemplate
+from .template import FutureBoundTemplate
+
+from .builtin import CachingDictLoader
+from .builtin import DictLoader
+from .builtin import ChoiceLoader
+from .builtin import CachingChoiceLoader
+from .builtin import CachingFileSystemLoader
+from .builtin import FileSystemLoader
+from .builtin import PackageLoader
+from .builtin import CachingLoaderMixin
+from .loader import BaseLoader
+
+from .ast import Node
+from .ast import BlockNode
+from .ast import ConditionalBlockNode
+
+from .analyze_tags import TagAnalysis
+from .analyze_tags import DEFAULT_INNER_TAG_MAP
+
+from .messages import MessageTuple
+from .messages import Translations
+from .messages import extract_from_template
+
+from .stream import TokenStream
+from .tag import Tag
+
+from . import future
+
+__version__ = "2.0.0"
+
+__all__ = (
+    "AwareBoundTemplate",
+    "BlockNode",
+    "BoundTemplate",
+    "CachingChoiceLoader",
+    "CachingDictLoader",
+    "CachingFileSystemLoader",
+    "CachingLoaderMixin",
+    "ChoiceLoader",
+    "ConditionalBlockNode",
+    "DebugUndefined",
+    "DEFAULT_INNER_TAG_MAP",
+    "DictLoader",
+    "Environment",
+    "escape",
+    "Expression",
+    "extract_from_template",
+    "FalsyStrictUndefined",
+    "FileSystemLoader",
+    "future",
+    "FutureAwareBoundTemplate",
+    "FutureBoundTemplate",
+    "FutureContext",
+    "is_undefined",
+    "make_choice_loader",
+    "make_file_system_loader",
+    "Markup",
+    "MessageTuple",
+    "Mode",
+    "Node",
+    "PackageLoader",
+    "parse",
+    "render_async",
+    "render",
+    "RenderContext",
+    "soft_str",
+    "StrictDefaultUndefined",
+    "StrictUndefined",
+    "Tag",
+    "TagAnalysis",
+    "Template",
+    "Token",
+    "TokenStream",
+    "Translations",
+    "Undefined",
+)
+
+DEFAULT_ENVIRONMENT = Environment()
+
+
+def parse(source: str) -> BoundTemplate:
+    """Parse template source text using the default environment."""
+    return DEFAULT_ENVIRONMENT.from_string(source)
+
+
+def render(source: str, **data: object) -> str:
+    """Parse and render source text using the default environment."""
+    return DEFAULT_ENVIRONMENT.render(source, **data)
+
+
+async def render_async(source: str, **data: object) -> str:
+    """Parse and render source text using the default environment."""
+    return await DEFAULT_ENVIRONMENT.render_async(source, **data)
+
+
+def make_file_system_loader(
+    search_path: Union[str, Path, Iterable[Union[str, Path]]],
+    *,
+    encoding: str = "utf-8",
+    ext: str = ".liquid",
+    auto_reload: bool = True,
+    namespace_key: str = "",
+    cache_size: int = 300,
+) -> BaseLoader:
+    """A _file system_ template loader factory.
+
+    Returns one of `CachingFileSystemLoader` or `FileSystemLoader` depending in
+    the given arguments.
+
+    A `CachingFileSystemLoader` is returned if _cache_size_ is greater than 0.
+    Otherwise a `FileExtensionLoader` is returned if _ext_ is not empty.
+    If _ext_ is empty, a `FileSystemLoader` is returned.
+
+    _auto_reload_ and _namespace_key_ are ignored if _cache_key_ is less than 1.
+
+    Args:
+        search_path: One or more paths to search.
+        encoding: Open template files with the given encoding.
+        ext: A default file extension. Should include a leading period.
+        auto_reload: If `True`, automatically reload a cached template if it has been
+            updated.
+        namespace_key: The name of a global render context variable or loader keyword
+            argument that resolves to the current loader "namespace" or "scope".
+
+            If you're developing a multi-user application, a good namespace might be
+            `uid`, where `uid` is a unique identifier for a user and templates are
+            arranged in folders named for each `uid` inside the search path.
+        cache_size: The maximum number of templates to hold in the cache before removing
+            the least recently used template.
+
+    _New in version 1.12.0_
+    """
+    if cache_size > 0:
+        return CachingFileSystemLoader(
+            search_path=search_path,
+            encoding=encoding,
+            ext=ext,
+            auto_reload=auto_reload,
+            namespace_key=namespace_key,
+            capacity=cache_size,
+        )
+
+    return FileSystemLoader(search_path=search_path, encoding=encoding, ext=ext)
+
+
+def make_choice_loader(
+    loaders: list[BaseLoader],
+    *,
+    auto_reload: bool = True,
+    namespace_key: str = "",
+    cache_size: int = 300,
+) -> BaseLoader:
+    """A _choice loader_ factory.
+
+    Returns one of `CachingChoiceLoader` or `ChoiceLoader` depending on the
+    given arguments.
+
+    A `CachingChoiceLoader` is returned if _cache_size_ > 0, otherwise a
+    `ChoiceLoader` is returned.
+
+    _auto_reload_ and _namespace_key_ are ignored if _cache_key_ is less than 1.
+
+    Args:
+        loaders: A list of loaders implementing `liquid.loaders.BaseLoader`.
+        auto_reload: If `True`, automatically reload a cached template if it
+            has been updated.
+        namespace_key: The name of a global render context variable or loader
+            keyword argument that resolves to the current loader "namespace" or
+            "scope".
+        cache_size: The maximum number of templates to hold in the cache before
+            removing the least recently used template.
+
+    _New in version 1.12.0_
+    """
+    if cache_size > 0:
+        return CachingChoiceLoader(
+            loaders=loaders,
+            auto_reload=auto_reload,
+            namespace_key=namespace_key,
+            capacity=cache_size,
+        )
+
+    return ChoiceLoader(loaders=loaders)
+
+
+def extract_liquid(
+    fileobj: TextIO,
+    keywords: list[str],
+    comment_tags: Optional[list[str]] = None,
+    options: Optional[dict[object, object]] = None,  # noqa: ARG001
+) -> Iterator[MessageTuple]:
+    """A babel compatible translation message extraction method for Liquid templates.
+
+    See https://babel.pocoo.org/en/latest/messages.html
+
+    Keywords are the names of Liquid filters or tags operating on translatable
+    strings. For a filter to contribute to message extraction, it must also
+    appear as a child of a `FilteredExpression` and be a `TranslatableFilter`.
+    Similarly, tags must produce a node that is a `TranslatableTag`.
+
+    Where a Liquid comment contains a prefix in `comment_tags`, the comment
+    will be attached to the translatable filter or tag immediately following
+    the comment. Python Liquid's non-standard shorthand comments are not
+    supported.
+
+    Options are arguments passed to the `liquid.Template` constructor with the
+    contents of `fileobj` as the template's source. Use `extract_from_template`
+    to extract messages from an existing template bound to an existing
+    environment.
+    """
+    template = Environment(extra=True).parse(fileobj.read())
+    return extract_from_template(
+        template=template,
+        keywords=keywords,
+        comment_tags=comment_tags,
+    )