jx 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

jx/__init__.py

@@ -1,5 +1,6 @@
 """
-Jx | Copyright (c) Juan-Pablo Scaletti <juanpablo@jpscaletti.com>
+Jx | Copyright (c) Juan-Pablo Scaletti
 """
+
 from .catalog import CData, Catalog  # noqa
 from .exceptions import *  # noqa

jx/attrs.py

@@ -1,7 +1,7 @@
 """
-Jx | Copyright (c) Juan-Pablo Scaletti <juanpablo@jpscaletti.com>
+Jx | Copyright (c) Juan-Pablo Scaletti
 """
-import re
+
 import typing as t
 from collections import UserString
 from functools import cached_property
@@ -14,10 +14,6 @@ CLASS_ALT_KEY = "classes"
 CLASS_KEYS = (CLASS_KEY, CLASS_ALT_KEY)
 
 
-def split(ssl: str) -> list[str]:
-    return re.split(r"\s+", ssl.strip())
-
-
 def quote(text: str) -> str:
     if '"' in text:
         if "'" in text:
@@ -45,6 +41,10 @@ class LazyString(UserString):
 
 
 class Attrs:
+    __classes: tuple[str, ...]
+    __attributes: dict[str, str | LazyString]
+    __properties: set[str]
+
     def __init__(self, attrs: "dict[str, t.Any| LazyString]") -> None:
         """
         Contains all the HTML attributes/properties (a property is an
@@ -62,11 +62,15 @@ class Attrs:
         attributes: "dict[str, str | LazyString]" = {}
         properties: set[str] = set()
 
-        class_names = split(" ".join([
+        class_names = (" ".join([
             str(attrs.pop(CLASS_KEY, "")),
             str(attrs.get(CLASS_ALT_KEY, "")),
-        ]))
-        self.__classes = {name for name in class_names if name}
+        ])).strip().split()
+        classes = []
+        for name in class_names:
+            if name and name not in classes:
+                classes.append(name)
+        self.__classes = tuple(classes)
 
         for name, value in attrs.items():
             if name.startswith("_"):
@@ -83,7 +87,7 @@ class Attrs:
     @property
     def classes(self) -> str:
         """
-        All the HTML classes alphabetically sorted and separated by a space.
+        All the HTML classes separated by a space.
 
         Example:
 
@@ -91,11 +95,11 @@ class Attrs:
             attrs = Attrs({"class": "italic bold bg-blue wide abcde"})
             attrs.set(class="bold text-white")
             print(attrs.classes)
-            abcde bg-blue bold italic text-white wide
+            italic bold bg-blue wide abcde text-white
             ```
 
         """
-        return " ".join(sorted((self.__classes)))
+        return " ".join(self.__classes)
 
     @property
     def as_dict(self) -> dict[str, t.Any]:
@@ -116,7 +120,7 @@ class Attrs:
             attrs.as_dict
             {
                 "aria_label": "hello",
-                "class": "ipsum lorem",
+                "class": "lorem ipsum",
                 "id": "world",
                 "data_test": True,
                 "hidden": True
@@ -155,8 +159,6 @@ class Attrs:
         - The underscores in the names will be translated automatically to dashes,
           so `aria_selected` becomes the attribute `aria-selected`.
 
-        TODO: vue-style
-
         Example:
 
             ```python
@@ -172,7 +174,7 @@ class Attrs:
             attrs = Attrs({"class": "b c a"})
             attrs.set(class="c b f d e")
             attrs.as_dict
-            {"class": "a b c d e f"}
+            {"class": "b c a f d e"}
             ```
 
         """
@@ -212,7 +214,9 @@ class Attrs:
                 continue
 
             if name in CLASS_KEYS:
-                self.add_class(value)
+                if not self.__classes:
+                    self.add_class(value)
+                continue
 
             name = name.replace("_", "-")
             if name not in self.__attributes:
@@ -220,10 +224,10 @@ class Attrs:
 
     def add_class(self, *values: str) -> None:
         """
-        Adds one or more classes to the list of classes, if not already present.
+        Adds one or more classes to the end of the list of classes,
+        if not already present.
 
         Arguments:
-
             values:
                 One or more class names to add, separated by spaces.
 
@@ -231,15 +235,44 @@ class Attrs:
 
             ```python
             attrs = Attrs({"class": "a b c"})
-            attrs.add_class("c", "d")
+            attrs.add_class("c d")
             attrs.as_dict
             {"class": "a b c d"}
             ```
 
         """
         for names in values:
-            for name in split(names):
-                self.__classes.add(name)
+            for name in names.strip().split():
+                if name not in self.__classes:
+                    self.__classes += (name,)
+
+    def prepend_class(self, *values: str) -> None:
+        """
+        Adds one or more classes to the beginning of the list of classes,
+        if not already present.
+
+        Arguments:
+            values:
+                One or more class names to add, separated by spaces.
+
+        Example:
+
+            ```python
+            attrs = Attrs({"class": "a b c"})
+            attrs.add_class("c d |")
+            attrs.as_dict
+            {"class": "d | a b c"}
+            ```
+
+        """
+        new_classes = [
+            name
+            for names in values
+            for name in names.strip().split()
+            if name not in self.__classes
+        ]
+
+        self.__classes = tuple(new_classes) + self.__classes
 
     def remove_class(self, *names: str) -> None:
         """
@@ -255,8 +288,7 @@ class Attrs:
             ```
 
         """
-        for name in names:
-            self.__classes.remove(name)
+        self.__classes = tuple(c for c in self.__classes if c not in names)
 
     def get(self, name: str, default: t.Any = None) -> t.Any:
         """
@@ -358,7 +390,7 @@ class Attrs:
         Removes an attribute or property.
         """
         if name in CLASS_KEYS:
-            self.__classes = set()
+            self.__classes = ()
         if name in self.__attributes:
             del self.__attributes[name]
         if name in self.__properties:

jx/catalog.py

@@ -1,6 +1,7 @@
 """
-Jx | Copyright (c) Juan-Pablo Scaletti <juanpablo@jpscaletti.com>
+Jx | Copyright (c) Juan-Pablo Scaletti
 """
+
 import typing as t
 from dataclasses import dataclass, field
 from pathlib import Path
@@ -23,7 +24,7 @@ class CData:
     mtime: float
     code: CodeType | None = None
     required: tuple[str, ...] = ()
-    optional: dict[str, t.Any] = field(default_factory=dict) # { attr: default_value }
+    optional: dict[str, t.Any] = field(default_factory=dict)  # { attr: default_value }
     imports: dict[str, str] = field(default_factory=dict)  # { name: relpath }
     css: tuple[str, ...] = ()
     js: tuple[str, ...] = ()
@@ -31,8 +32,9 @@ class CData:
 
 
 class Catalog:
+
     # IDEA: This dict could be replaced by a dict-like object
-    # that usesa LRU cache (to limit the memory used)
+    # that uses a LRU cache (to limit the memory used)
     # or even a shared Redis/Memcache cache.
     components: dict[str, CData]
 
@@ -40,11 +42,11 @@ class Catalog:
         self,
         folder: str | Path | None = None,
         *,
-        auto_reload: bool = True,
         jinja_env: jinja2.Environment | None = None,
+        extensions: list | None = None,
         filters: dict[str, t.Any] | None = None,
         tests: dict[str, t.Any] | None = None,
-        extensions: list | None = None,
+        auto_reload: bool = True,
         **globals: t.Any,
     ) -> None:
         """
@@ -54,19 +56,19 @@ class Catalog:
             folder:
                 Optional folder path to scan for components. It's a shortcut to
                 calling `add_folder` when only one is used.
-            auto_reload:
-                Whether to check the last-modified time of the components files and
-                automatically re-process them if they change. The performance impact of
-                leaving it on is minimal, but *might* be noticeable when rendering a page
-                that uses a large number of different components.
             jinja_env:
                 Optional Jinja2 environment to use for rendering.
-            filters:
-                Optional extra Jinja2 filters to add to the environment.
             extensions:
                 Optional extra Jinja2 extensions to add to the environment.
+            filters:
+                Optional extra Jinja2 filters to add to the environment.
             tests:
                 Optional extra Jinja2 tests to add to the environment.
+            auto_reload:
+                Whether to check the last-modified time of the components files and
+                automatically re-process them if they change. The performance impact of
+                leaving it on is minimal, but *might* be noticeable when rendering a
+                component that uses a large number of child components.
             **globals:
                 Variables to make available to all components by default.
 
@@ -84,11 +86,7 @@ class Catalog:
             self.add_folder(folder)
 
     def add_folder(
-        self,
-        path: str | Path,
-        *,
-        prefix: str = "",
-        preload: bool = True
+        self, path: str | Path, *, prefix: str = "", preload: bool = True
     ) -> None:
         """
         Add a folder path from which to search for components, optionally under a prefix.
@@ -141,9 +139,7 @@ class Catalog:
                 logger.debug(f"Component already exists: {relpath}")
                 continue
             cdata = CData(
-                base_path=base_path,
-                path=filepath,
-                mtime=filepath.stat().st_mtime
+                base_path=base_path, path=filepath, mtime=filepath.stat().st_mtime
             )
             self.components[relpath] = cdata
 
@@ -151,7 +147,9 @@ class Catalog:
             for relpath in self.components:
                 self.components[relpath] = self.get_component_data(relpath)
 
-    def render(self, relpath: str, globals: dict[str, t.Any] | None = None, **kwargs) -> str:
+    def render(
+        self, relpath: str, globals: dict[str, t.Any] | None = None, **kwargs
+    ) -> str:
         """
         Render a component with the given relative path and context.
 
@@ -173,6 +171,64 @@ class Catalog:
         relpath = relpath.replace("\\", "/").strip("/")
         co = self.get_component(relpath)
 
+        globals = globals or {}
+        globals.update(
+            {
+                "assets": {
+                    "css": co.collect_css,
+                    "js": co.collect_js,
+                    "render_css": co.render_css,
+                    "render_js": co.render_js,
+                    "render": co.render_assets,
+                },
+            }
+        )
+        co.globals = globals
+
+        return co.render(**kwargs)
+
+    def render_string(
+        self, source: str, globals: dict[str, t.Any] | None = None, **kwargs
+    ) -> str:
+        """
+        Render a component from a string source.
+        Works like `render`, but the component is not cached and cannot do relative imports.
+
+        Arguments:
+            source:
+                The Jinja2 source code of the component to render.
+            globals:
+                Optional global variables to make available to the component and all its
+                imported components.
+            **kwargs:
+                Keyword arguments to pass to the component.
+                They will be available in the component's context but not to its imported components.
+
+        Returns:
+            The rendered component as a string.
+
+        """
+        meta = extract_metadata(source, base_path=Path(), fullpath=Path())
+        name = "<string>"
+
+        parser = JxParser(name=name, source=source, components=list(meta.imports.keys()))
+        parsed_source, slots = parser.parse()
+
+        code = self.jinja_env.compile(source=parsed_source, name=name, filename=name)
+        tmpl = jinja2.Template.from_code(self.jinja_env, code, self.jinja_env.globals)
+
+        co = Component(
+            relpath=name,
+            tmpl=tmpl,
+            get_component=self.get_component,
+            required=meta.required,
+            optional=meta.optional,
+            imports=meta.imports,
+            css=meta.css,
+            js=meta.js,
+            slots=slots,
+        )
+
         globals = globals or {}
         globals.update({
             "assets": {
@@ -181,7 +237,7 @@ class Catalog:
                 "render_css": co.render_css,
                 "render_js": co.render_js,
                 "render": co.render_assets,
-            },
+            }
         })
         co.globals = globals
 
@@ -189,8 +245,8 @@ class Catalog:
 
     def get_component_data(self, relpath: str) -> CData:
         """
-        Get the component data from the cache, or load it from the file system
-        if needed.
+        Get the component data from the cache.
+        If the file has been updated, the component is re-processed.
 
         Arguments:
             relpath:
@@ -214,15 +270,11 @@ class Catalog:
         meta = extract_metadata(source, base_path=cdata.base_path, fullpath=cdata.path)
 
         parser = JxParser(
-            name=relpath,
-            source=source,
-            components=list(meta.imports.keys())
+            name=relpath, source=source, components=list(meta.imports.keys())
         )
         parsed_source, slots = parser.parse()
         code = self.jinja_env.compile(
-            source=parsed_source,
-            name=relpath,
-            filename=cdata.path.as_posix()
+            source=parsed_source, name=relpath, filename=cdata.path.as_posix()
         )
 
         cdata.code = code
@@ -247,9 +299,7 @@ class Catalog:
         cdata = self.get_component_data(relpath)
         assert cdata.code is not None
         tmpl = jinja2.Template.from_code(
-            self.jinja_env,
-            cdata.code,
-            self.jinja_env.globals
+            self.jinja_env, cdata.code, self.jinja_env.globals
         )
 
         co = Component(
@@ -279,9 +329,6 @@ class Catalog:
         """
         Create a new Jinja2 environment with the specified settings.
 
-        If an existing environment is provided, an "overlay" of it will
-        be created and used.
-
         Arguments:
             jinja_env:
                 Optional Jinja2 environment to use as a base.
@@ -297,16 +344,21 @@ class Catalog:
         """
         jinja_env = jinja_env or getattr(self, "jinja_env", None)
         if jinja_env:
-            env = jinja_env.overlay()
+            # It could be `jinja_env.overlay()` instead, but that might
+            # might lead to confusion if the user expects changes
+            # to the original environment to be reflected here.
+            env = jinja_env
         else:
             env = jinja2.Environment()
 
         globals = globals or {}
-        globals.update({
-            # A unique ID generator for HTML elements, see `utils.get_random_id`
-            # docstring for more information.
-            "_get_random_id": utils.get_random_id,
-        })
+        globals.update(
+            {
+                # A unique ID generator for HTML elements, see `utils.get_random_id`
+                # docstring for more information.
+                "_get_random_id": utils.get_random_id,
+            }
+        )
         env.globals.update(globals)
 
         filters = filters or {}

jx/component.py

@@ -1,7 +1,7 @@
 """
-Jx | Copyright (c) Juan-Pablo Scaletti <juanpablo@jpscaletti.com>
+Jx | Copyright (c) Juan-Pablo Scaletti
 """
-import re
+
 import typing as t
 from collections.abc import Callable
 
@@ -12,9 +12,6 @@ from .attrs import Attrs
 from .exceptions import MissingRequiredArgument
 
 
-rx_external_url = re.compile(r"^[a-z]+://", re.IGNORECASE)
-
-
 class Component:
     __slots__ = (
         "relpath",
@@ -85,7 +82,7 @@ class Component:
         content: str | None = None,
         attrs: Attrs | dict[str, t.Any] | None = None,
         caller: Callable[[str], str] | None = None,
-        **params: t.Any
+        **params: t.Any,
     ) -> Markup:
         content = content if content is not None else caller("") if caller else ""
         attrs = attrs.as_dict if isinstance(attrs, Attrs) else attrs or {}

jx/exceptions.py

@@ -1,7 +1,8 @@
 """
-Jx | Copyright (c) Juan-Pablo Scaletti <juanpablo@jpscaletti.com>
+Jx | Copyright (c) Juan-Pablo Scaletti
 """
 
+
 class JxException(Exception):
     """Base class for all Jx exceptions."""
 
@@ -18,6 +19,7 @@ class ImportError(JxException):
     Raised when an import fails.
     This is usually caused by a missing or inaccessible component.
     """
+
     def __init__(self, relpath: str, **kw) -> None:
         msg = f"Component not found: {relpath}"
         super().__init__(msg, **kw)

jx/meta.py

@@ -1,6 +1,7 @@
 """
-Jx | Copyright (c) Juan-Pablo Scaletti <juanpablo@jpscaletti.com>
+Jx | Copyright (c) Juan-Pablo Scaletti
 """
+
 import ast
 import re
 import typing as t
@@ -56,9 +57,9 @@ def extract_metadata(source: str, base_path: Path, fullpath: Path) -> Meta:
         source:
             The template source code.
         base_path:
-            Absolute base path for all the template files
+            Absolute base path for all the template files, for relative imports.
         fullpath:
-            The absolute full path of the current template.
+            The absolute full path of the current template, for relative imports.
 
     Returns:
         A `Meta` object containing the extracted metadata.

jx/parser.py

@@ -1,5 +1,5 @@
 """
-Jx | Copyright (c) Juan-Pablo Scaletti <juanpablo@jpscaletti.com>
+Jx | Copyright (c) Juan-Pablo Scaletti
 """
 
 import re

jx/utils.py

@@ -1,6 +1,7 @@
 """
-Jx | Copyright (c) Juan-Pablo Scaletti <juanpablo@jpscaletti.com>
+Jx | Copyright (c) Juan-Pablo Scaletti
 """
+
 import logging
 import uuid
 

{jx-0.2.0.dist-info → jx-0.3.0.dist-info}/METADATA

@@ -1,11 +1,10 @@
 Metadata-Version: 2.4
 Name: jx
-Version: 0.2.0
+Version: 0.3.0
 Summary: Replace your HTML templates with Python server-Side components
 Author-email: Juan Pablo Scaletti <juanpablo@jpscaletti.com>
-Project-URL: homepage, https://jx.scaletti.dev/
-Project-URL: repository, https://github.com/jpsca/jx
-Project-URL: documentation, https://jx.scaletti.dev/
+Project-URL: Homepage, https://jx.scaletti.dev/
+Project-URL: GitHub, https://github.com/jpsca/jx
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Web Environment
 Classifier: Intended Audience :: Developers
@@ -19,23 +18,21 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: User Interfaces
 Classifier: Topic :: Text Processing :: Markup :: HTML
 Classifier: Typing :: Typed
-Requires-Python: <4,>=3.11
+Requires-Python: <4,>=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: jinja2>=3.0
-Requires-Dist: markupsafe>=2.0
-Requires-Dist: ty>=0.0.1a15
 Dynamic: license-file
 
 <h1>
-  <img src="https://github.com/jpsca/jx/raw/main/docs/logo-jx.png" height="100" align="top">
+  <img src="./docs/logo-jx.png" height="100" align="top">
 </h1>
 
 Super components powers for your Jinja templates.
 
 <p>
-  <img alt="python: 3.11, 3.12, 3.13, 3.14" src="https://github.com/jpsca/jx/raw/main/docs/python.svg">
-  <img alt="license: MIT" src="https://github.com/jpsca/jx/raw/main/docs/license.svg">
+  <img alt="python: 3.11, 3.12, 3.13, 3.14" src="./docs/python.svg">
+  <img alt="license: MIT" src="./docs/license.svg">
 </p>
 
 From chaos to clarity: The power of components in your server-side-rendered Python web app.

jx-0.3.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+jx/__init__.py,sha256=f05q3I3xvO72xqVOhtWI_KMSVa0vACbGsK2eMrhzO1g,126
+jx/attrs.py,sha256=3cSSJb-idpD2CdhA_BZLX-OId1t8c2nzJp0jSJpTjvs,11344
+jx/catalog.py,sha256=6NxK88krwH0Aw86SeRSW4Ws7pVENNu9dCtrAFYVKg5o,13512
+jx/component.py,sha256=04Ic7wGm65uUPAiVGhz8YbD2orBbasKd1dFo4FtbIv4,7004
+jx/exceptions.py,sha256=eQVCjt49FOgOjdGPPAhU4eIgBvumQ6BXmTh_siYpyIg,1493
+jx/meta.py,sha256=nKSeZzgdtJEjPoc7PaYGhBkBbwFRC97XZc_GUMBndPI,5167
+jx/parser.py,sha256=fLDIBqt1hAzCOkRMZoOsAJOswtrw7PE3EV9ztw1K358,12841
+jx/utils.py,sha256=BTxDPhiWuKHRcVCND07OGkYLhzPp9G6iDgDC7H2o4Lo,643
+jx-0.3.0.dist-info/licenses/LICENSE,sha256=RHwNifuIFfQM9QUhA2FQfnqlBcnhBHlJEVp8QcRllew,1076
+jx-0.3.0.dist-info/METADATA,sha256=Dt5KJ7rJoGa7UXVRDq1ZEf_1LZQQO_BIbuDHoeIYAGo,2540
+jx-0.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+jx-0.3.0.dist-info/top_level.txt,sha256=P61YQxqfmzVpxTMe3C48gt0vc6fnHLF8Ml0JXC-QuEI,3
+jx-0.3.0.dist-info/RECORD,,

jx-0.2.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-jx/__init__.py,sha256=MZ7KbNZkQx2D5CJpccSKuyJi179iAff3a9jG7DwEBAE,152
-jx/attrs.py,sha256=_Cj1s4PEHiq_TiG2IvKiUkTqyThH4YgS4HwUn09zzGU,10414
-jx/catalog.py,sha256=EaG0jNqf4JJkif9Nrnp72vEr8kX1BslJGRig9pOGgC8,11567
-jx/component.py,sha256=9TkyX10brWRCDw6AC0tEJ70DWaDmkl_UE8i_Uqfta6M,7100
-jx/exceptions.py,sha256=rDWxkgOqeMPptmQ21joB2ujfpIU5EwMKtAL-ImB9nuA,1518
-jx/meta.py,sha256=lh3EFyp2_Y0R80aXaT3kVPNPcB3CREdHHePdQP4ZnR4,5148
-jx/parser.py,sha256=LW1iHh5_Ac8B368RhfiBPe3w7_1tdLf5LjCl3rfNKu8,12868
-jx/utils.py,sha256=dZMIAdVLdmkyPsiX14a9aIkZRfgAnf0SNEnvfyg8K98,669
-jx-0.2.0.dist-info/licenses/LICENSE,sha256=RHwNifuIFfQM9QUhA2FQfnqlBcnhBHlJEVp8QcRllew,1076
-jx-0.2.0.dist-info/METADATA,sha256=F0kiqI8PoNntEX_EuiOkdu9OzHbHiaYZ8eWsvAWZptA,2761
-jx-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-jx-0.2.0.dist-info/top_level.txt,sha256=P61YQxqfmzVpxTMe3C48gt0vc6fnHLF8Ml0JXC-QuEI,3
-jx-0.2.0.dist-info/RECORD,,