weasyprint 66.0__py3-none-any.whl → 68.0__py3-none-any.whl

weasyprint/__init__.py

@@ -5,7 +5,6 @@ importing sub-modules.
 
 """
 
-import contextlib
 from datetime import datetime
 from os.path import getctime, getmtime
 from pathlib import Path
@@ -15,9 +14,9 @@ import cssselect2
 import tinycss2
 import tinyhtml5
 
-VERSION = __version__ = '66.0'
+VERSION = __version__ = '68.0'
 
-#: Default values for command-line and Python API options. See
+#: Default values for command-line and Python API rendering options. See
 #: :func:`__main__.main` to learn more about specific options for
 #: command-line.
 #:
@@ -67,14 +66,15 @@ VERSION = __version__ = '66.0'
 #:     images are temporarily stored.
 DEFAULT_OPTIONS = {
     'stylesheets': None,
-    'media_type': 'print',
     'attachments': None,
+    'attachment_relationships': None,
     'pdf_identifier': None,
     'pdf_variant': None,
     'pdf_version': None,
     'pdf_forms': None,
     'pdf_tags': False,
     'uncompressed_pdf': False,
+    'xmp_metadata': None,
     'custom_metadata': False,
     'presentational_hints': False,
     'srgb': False,
@@ -92,8 +92,7 @@ __all__ = [
 
 
 # Import after setting the version, as the version is used in other modules
-from .urls import (  # noqa: I001, E402
-    fetch, default_url_fetcher, path2url, ensure_url, url_is_absolute)
+from .urls import URLFetcher, default_url_fetcher, select_source  # noqa: I001, E402
 from .logger import LOGGER, PROGRESS_LOGGER  # noqa: E402
 # Some imports are at the end of the file (after the CSS class)
 # to work around circular imports.
@@ -150,9 +149,7 @@ class HTML:
         :term:`file objects <file object>`.
     :type url_fetcher: :term:`callable`
     :param url_fetcher:
-        A function or other callable with the same signature as
-        :func:`default_url_fetcher` called to fetch external resources such as
-        stylesheets and images. (See :ref:`URL Fetchers`.)
+        An instance of :class:`urls.URLFetcher`. (See :ref:`URL Fetchers`.)
     :param str media_type:
         The media type to use for ``@media``. Defaults to ``'print'``.
         **Note:** In some cases like ``HTML(string=foo)`` relative URLs will be
@@ -161,25 +158,24 @@ class HTML:
     """
     def __init__(self, guess=None, filename=None, url=None, file_obj=None,
                  string=None, encoding=None, base_url=None,
-                 url_fetcher=default_url_fetcher, media_type='print'):
+                 url_fetcher=None, media_type='print'):
         PROGRESS_LOGGER.info(
             'Step 1 - Fetching and parsing HTML - %s',
             guess or filename or url or
             getattr(file_obj, 'name', 'HTML string'))
         if isinstance(base_url, Path):
             base_url = str(base_url)
-        result = _select_source(
+        if url_fetcher is None:
+            url_fetcher = URLFetcher()
+        result = select_source(
             guess, filename, url, file_obj, string, base_url, url_fetcher)
-        with result as (source_type, source, base_url, protocol_encoding):
-            if isinstance(source, str):
-                result = tinyhtml5.parse(source, namespace_html_elements=False)
-            else:
-                kwargs = {'namespace_html_elements': False}
-                if protocol_encoding is not None:
-                    kwargs['transport_encoding'] = protocol_encoding
-                if encoding is not None:
-                    kwargs['override_encoding'] = encoding
-                result = tinyhtml5.parse(source, **kwargs)
+        with result as (file_obj, base_url, protocol_encoding, _):
+            kwargs = {'namespace_html_elements': False}
+            if protocol_encoding is not None:
+                kwargs['transport_encoding'] = protocol_encoding
+            if encoding is not None:
+                kwargs['override_encoding'] = encoding
+            result = tinyhtml5.parse(file_obj, **kwargs)
         self.base_url = _find_base_url(result, base_url)
         self.url_fetcher = url_fetcher
         self.media_type = media_type
@@ -198,7 +194,8 @@ class HTML:
     def _ph_stylesheets(self):
         return [HTML5_PH_STYLESHEET]
 
-    def render(self, font_config=None, counter_style=None, **options):
+    def render(self, font_config=None, counter_style=None, color_profiles=None,
+               **options):
         """Lay out and paginate the document, but do not (yet) export it.
 
         This returns a :class:`document.Document` object which provides
@@ -222,10 +219,11 @@ class HTML:
         new_options = DEFAULT_OPTIONS.copy()
         new_options.update(options)
         options = new_options
-        return Document._render(self, font_config, counter_style, options)
+        return Document._render(
+            self, font_config, counter_style, color_profiles, options)
 
     def write_pdf(self, target=None, zoom=1, finisher=None,
-                  font_config=None, counter_style=None, **options):
+                  font_config=None, counter_style=None, color_profiles=None, **options):
         """Render the document to a PDF file.
 
         This is a shortcut for calling :meth:`render`, then
@@ -265,7 +263,7 @@ class HTML:
         new_options.update(options)
         options = new_options
         return (
-            self.render(font_config, counter_style, **options)
+            self.render(font_config, counter_style, color_profiles, **options)
             .write_pdf(target, zoom, finisher, **options))
 
 
@@ -284,35 +282,37 @@ class CSS:
     of :class:`HTML` objects.
 
     """
-    def __init__(self, guess=None, filename=None, url=None, file_obj=None,
-                 string=None, encoding=None, base_url=None,
-                 url_fetcher=default_url_fetcher, _check_mime_type=False,
+    def __init__(self, guess=None, filename=None, url=None, file_obj=None, string=None,
+                 encoding=None, base_url=None, url_fetcher=None, _check_mime_type=False,
                  media_type='print', font_config=None, counter_style=None,
-                 matcher=None, page_rules=None):
+                 color_profiles=None, matcher=None, page_rules=None, layers=None,
+                 layer=None):
         PROGRESS_LOGGER.info(
             'Step 2 - Fetching and parsing CSS - %s',
             filename or url or getattr(file_obj, 'name', 'CSS string'))
-        result = _select_source(
-            guess, filename, url, file_obj, string,
-            base_url=base_url, url_fetcher=url_fetcher,
-            check_css_mime_type=_check_mime_type)
-        with result as (source_type, source, base_url, protocol_encoding):
-            if source_type == 'file_obj':
-                source = source.read()
-            if isinstance(source, str):
-                # unicode, no encoding
-                stylesheet = tinycss2.parse_stylesheet(source)
+        if url_fetcher is None:
+            url_fetcher = URLFetcher()
+        result = select_source(
+            guess, filename, url, file_obj, string, base_url=base_url,
+            url_fetcher=url_fetcher, check_css_mime_type=_check_mime_type)
+        with result as (file_obj, base_url, protocol_encoding, mime_type):
+            css = file_obj.read()
+            if isinstance(css, str):
+                stylesheet = tinycss2.parse_stylesheet(css)
             else:
-                stylesheet, encoding = tinycss2.parse_stylesheet_bytes(
-                    source, environment_encoding=encoding,
+                stylesheet, _ = tinycss2.parse_stylesheet_bytes(
+                    css, environment_encoding=encoding,
                     protocol_encoding=protocol_encoding)
         self.base_url = base_url
         self.matcher = matcher or cssselect2.Matcher()
         self.page_rules = [] if page_rules is None else page_rules
+        self.layers = [] if layers is None else layers
         counter_style = {} if counter_style is None else counter_style
+        color_profiles = {} if color_profiles is None else color_profiles
         preprocess_stylesheet(
             media_type, base_url, stylesheet, url_fetcher, self.matcher,
-            self.page_rules, font_config, counter_style)
+            self.page_rules, self.layers, font_config, counter_style, color_profiles,
+            layer=layer)
 
 
 class Attachment:
@@ -341,10 +341,12 @@ class Attachment:
 
     """
     def __init__(self, guess=None, filename=None, url=None, file_obj=None,
-                 string=None, base_url=None, url_fetcher=default_url_fetcher,
-                 name=None, description=None, created=None, modified=None,
+                 string=None, base_url=None, url_fetcher=None, name=None,
+                 description=None, created=None, modified=None,
                  relationship='Unspecified'):
-        self.source = _select_source(
+        if url_fetcher is None:
+            url_fetcher = URLFetcher()
+        self.source = select_source(
             guess, filename, url, file_obj, string, base_url=base_url,
             url_fetcher=url_fetcher)
         self.name = name
@@ -366,69 +368,6 @@ class Attachment:
         self.modified = modified
 
 
-@contextlib.contextmanager
-def _select_source(guess=None, filename=None, url=None, file_obj=None,
-                   string=None, base_url=None, url_fetcher=default_url_fetcher,
-                   check_css_mime_type=False):
-    """If only one input is given, return it with normalized ``base_url``."""
-    if base_url is not None:
-        base_url = ensure_url(base_url)
-
-    selected_params = [
-        param for param in (guess, filename, url, file_obj, string) if
-        param is not None]
-    if len(selected_params) != 1:
-        source = ', '.join(selected_params) or 'nothing'
-        raise TypeError(f'Expected exactly one source, got {source}')
-    elif guess is not None:
-        if hasattr(guess, 'read'):
-            type_ = 'file_obj'
-        elif isinstance(guess, Path):
-            type_ = 'filename'
-        elif url_is_absolute(guess):
-            type_ = 'url'
-        else:
-            type_ = 'filename'
-        result = _select_source(
-            base_url=base_url, url_fetcher=url_fetcher,
-            check_css_mime_type=check_css_mime_type,
-            **{type_: guess})
-        with result as result:
-            yield result
-    elif filename is not None:
-        if base_url is None:
-            base_url = path2url(filename)
-        with open(filename, 'rb') as file_obj:
-            yield 'file_obj', file_obj, base_url, None
-    elif url is not None:
-        with fetch(url_fetcher, url) as result:
-            if check_css_mime_type and result['mime_type'] != 'text/css':
-                LOGGER.error(
-                    'Unsupported stylesheet type %s for %s',
-                    result['mime_type'], result['redirected_url'])
-                yield 'string', '', base_url, None
-            else:
-                proto_encoding = result.get('encoding')
-                if base_url is None:
-                    base_url = result.get('redirected_url', url)
-                if 'string' in result:
-                    yield 'string', result['string'], base_url, proto_encoding
-                else:
-                    yield (
-                        'file_obj', result['file_obj'], base_url,
-                        proto_encoding)
-    elif file_obj is not None:
-        if base_url is None:
-            # filesystem file-like objects have a 'name' attribute.
-            name = getattr(file_obj, 'name', None)
-            # Some streams have a .name like '<stdin>', not a filename.
-            if name and not name.startswith('<'):
-                base_url = ensure_url(name)
-        yield 'file_obj', file_obj, base_url, None
-    else:
-        assert string is not None
-        yield 'string', string, base_url, None
-
 # Work around circular imports.
 from .css import preprocess_stylesheet  # noqa: I001, E402
 from .html import (  # noqa: E402

weasyprint/__main__.py

@@ -4,141 +4,169 @@ import argparse
 import logging
 import platform
 import sys
-from functools import partial
 
 import pydyf
 
 from . import DEFAULT_OPTIONS, HTML, LOGGER, __version__
 from .pdf import VARIANTS
 from .text.ffi import pango
-from .urls import default_url_fetcher
+from .urls import URLFetcher
 
 
 class PrintInfo(argparse.Action):
     def __call__(*_, **__):
+        # TODO: ignore check at block-level when available.
+        # https://github.com/astral-sh/ruff/issues/3711
         uname = platform.uname()
-        print('System:', uname.system)
-        print('Machine:', uname.machine)
-        print('Version:', uname.version)
-        print('Release:', uname.release)
-        print()
-        print('WeasyPrint version:', __version__)
-        print('Python version:', sys.version.split()[0])
-        print('Pydyf version:', pydyf.__version__)
-        print('Pango version:', pango.pango_version())
+        print('System:', uname.system)  # noqa: T201
+        print('Machine:', uname.machine)  # noqa: T201
+        print('Version:', uname.version)  # noqa: T201
+        print('Release:', uname.release)  # noqa: T201
+        print()  # noqa: T201
+        print('WeasyPrint version:', __version__)  # noqa: T201
+        print('Python version:', sys.version.split()[0])  # noqa: T201
+        print('Pydyf version:', pydyf.__version__)  # noqa: T201
+        print('Pango version:', pango.pango_version())  # noqa: T201
         sys.exit()
 
 
 class Parser(argparse.ArgumentParser):
     def __init__(self, *args, **kwargs):
-        self._arguments = {}
+        self._groups = {None: {}}
         super().__init__(*args, **kwargs)
 
-    def add_argument(self, *args, **kwargs):
-        super().add_argument(*args, **kwargs)
+    def add_argument(self, *args, _group_name=None, **kwargs):
+        if _group_name is None:
+            super().add_argument(*args, **kwargs)
         key = args[-1].lstrip('-')
         kwargs['flags'] = args
         kwargs['positional'] = args[-1][0] != '-'
-        self._arguments[key] = kwargs
+        self._groups[_group_name][key] = kwargs
+
+    def add_argument_group(self, name, *args, **kwargs):
+        group = super().add_argument_group(name, *args, **kwargs)
+        self._groups[name] = {}
+        def add_argument(*args, **kwargs):
+            group._add_argument(*args, **kwargs)
+            self.add_argument(*args, _group_name=name, **kwargs)
+        group._add_argument = group.add_argument
+        group.add_argument = add_argument
+        return group
 
     @property
     def docstring(self):
-        self._arguments['help'] = self._arguments.pop('help')
+        self._groups[None].pop('help')
         data = []
-        for key, args in self._arguments.items():
-            data.append('.. option:: ')
-            action = args.get('action', 'store')
-            for flag in args['flags']:
-                data.append(flag)
-                if not args['positional'] and action in ('store', 'append'):
-                    data.append(f' <{key}>')
-                data.append(', ')
-            data[-1] = '\n\n'
-            data.append(f'  {args["help"][0].upper()}{args["help"][1:]}.\n\n')
-            if 'choices' in args:
-                choices = ", ".join(args['choices'])
-                data.append(f'  Possible choices: {choices}.\n\n')
-            if action == 'append':
-                data.append('  This option can be passed multiple times.\n\n')
+        for group, arguments in self._groups.items():
+            if not arguments:
+                continue
+            if group:
+                data.append(f'{group[0].title()}{group[1:]}\n')
+                data.append(f'{"~" * len(group)}\n\n')
+            for key, args in arguments.items():
+                data.append('.. option:: ')
+                action = args.get('action', 'store')
+                for flag in args['flags']:
+                    data.append(flag)
+                    if not args['positional'] and action in ('store', 'append'):
+                        data.append(f' <{key}>')
+                    data.append(', ')
+                data[-1] = '\n\n'
+                data.append(f'  {args["help"][0].upper()}{args["help"][1:]}.\n\n')
+                if 'choices' in args:
+                    choices = ", ".join(args['choices'])
+                    data.append(f'  Possible choices: {choices}.\n\n')
+                if action == 'append':
+                    data.append('  This option can be passed multiple times.\n\n')
         return ''.join(data)
 
 
 PARSER = Parser(prog='weasyprint', description='Render web pages to PDF.')
+PARSER.add_argument('input', help='URL or filename of the HTML input, or - for stdin')
+PARSER.add_argument('output', help='filename where output is written, or - for stdout')
 PARSER.add_argument(
-    'input', help='URL or filename of the HTML input, or - for stdin')
-PARSER.add_argument(
-    'output', help='filename where output is written, or - for stdout')
-PARSER.add_argument(
-    '-e', '--encoding', help='force the input character encoding')
+    '-i', '--info', action=PrintInfo, nargs=0, help='print system information and exit')
 PARSER.add_argument(
+    '--version', action='version', version=f'WeasyPrint version {__version__}',
+    help='print WeasyPrint’s version number and exit')
+
+group = PARSER.add_argument_group('rendering options')
+group.add_argument(
     '-s', '--stylesheet', action='append', dest='stylesheets',
     help='URL or filename for a user CSS stylesheet')
-PARSER.add_argument(
-    '-m', '--media-type',
-    help='media type to use for @media, defaults to print')
-PARSER.add_argument(
-    '-u', '--base-url',
-    help='base for relative URLs in the HTML input, defaults to the '
-    'input’s own filename or URL or the current directory for stdin')
-PARSER.add_argument(
+group.add_argument(
     '-a', '--attachment', action='append', dest='attachments',
     help='URL or filename of a file to attach to the PDF document')
-PARSER.add_argument('--pdf-identifier', help='PDF file identifier')
-PARSER.add_argument(
-    '--pdf-variant', choices=VARIANTS, help='PDF variant to generate')
-PARSER.add_argument('--pdf-version', help='PDF version number')
-PARSER.add_argument(
-    '--pdf-forms', action='store_true', help='include PDF forms')
-PARSER.add_argument(
-    '--pdf-tags', action='store_true', help='tag PDF for accessibility')
-PARSER.add_argument(
+group.add_argument(
+    '--attachment-relationship', action='append', dest='attachment_relationships',
+    help='Relationship of the attachment file to attach to the PDF')
+group.add_argument('--pdf-identifier', help='PDF file identifier')
+group.add_argument('--pdf-variant', choices=VARIANTS, help='PDF variant to generate')
+group.add_argument('--pdf-version', help='PDF version number')
+group.add_argument('--pdf-forms', action='store_true', help='include PDF forms')
+group.add_argument('--pdf-tags', action='store_true', help='tag PDF for accessibility')
+group.add_argument(
     '--uncompressed-pdf', action='store_true',
     help='do not compress PDF content, mainly for debugging purpose')
-PARSER.add_argument(
+group.add_argument(
+    '--xmp-metadata', action='append',
+    help='URL or filename of a file to include into the XMP metadata')
+group.add_argument(
     '--custom-metadata', action='store_true',
     help='include custom HTML meta tags in PDF metadata')
-PARSER.add_argument(
+group.add_argument(
     '-p', '--presentational-hints', action='store_true',
     help='follow HTML presentational hints')
-PARSER.add_argument(
-    '--srgb', action='store_true',
-    help='include sRGB color profile')
-PARSER.add_argument(
+group.add_argument('--srgb', action='store_true', help='include sRGB color profile')
+group.add_argument(
     '--optimize-images', action='store_true',
     help='optimize size of embedded images with no quality loss')
-PARSER.add_argument(
+group.add_argument(
     '-j', '--jpeg-quality', type=int,
     help='JPEG quality between 0 (worst) to 95 (best)')
-PARSER.add_argument(
+group.add_argument(
+    '-D', '--dpi', type=int,
+    help='set maximum resolution of images embedded in the PDF')
+group.add_argument(
     '--full-fonts', action='store_true',
     help='embed unmodified font files when possible')
-PARSER.add_argument(
-    '--hinting', action='store_true',
-    help='keep hinting information in embedded fonts')
-PARSER.add_argument(
+group.add_argument(
+    '--hinting', action='store_true', help='keep hinting information in embedded fonts')
+group.add_argument(
     '-c', '--cache-folder', dest='cache',
     help='store cache on disk instead of memory, folder is '
     'created if needed and cleaned after the PDF is generated')
-PARSER.add_argument(
-    '-D', '--dpi', type=int,
-    help='set maximum resolution of images embedded in the PDF')
-PARSER.add_argument(
+
+group = PARSER.add_argument_group('HTML options')
+group.add_argument('-e', '--encoding', help='force the input character encoding')
+group.add_argument(
+    '-m', '--media-type', help='media type to use for @media, defaults to print',
+    default='print')
+group.add_argument(
+    '-u', '--base-url',
+    help='base for relative URLs in the HTML input, defaults to the '
+    'input’s own filename or URL or the current directory for stdin')
+
+group = PARSER.add_argument_group('URL fetcher options')
+group.add_argument(
+    '-t', '--timeout', type=int, help='set timeout in seconds for HTTP requests')
+group.add_argument(
+    '--allowed-protocols', dest='allowed_protocols',
+    help='only authorize comma-separated list of protocols for fetching URLs')
+group.add_argument(
+    '--no-http-redirects', action='store_true', help='do not follow HTTP redirects')
+group.add_argument(
+    '--fail-on-http-errors', action='store_true',
+    help='abort document rendering on any HTTP error')
+
+group = PARSER.add_argument_group('command-line logging options')
+group.add_argument(
     '-v', '--verbose', action='store_true',
     help='show warnings and information messages')
-PARSER.add_argument(
+group.add_argument(
     '-d', '--debug', action='store_true', help='show debugging messages')
-PARSER.add_argument(
-    '-q', '--quiet', action='store_true', help='hide logging messages')
-PARSER.add_argument(
-    '--version', action='version',
-    version=f'WeasyPrint version {__version__}',
-    help='print WeasyPrint’s version number and exit')
-PARSER.add_argument(
-    '-i', '--info', action=PrintInfo, nargs=0,
-    help='print system information and exit')
-PARSER.add_argument(
-    '-t', '--timeout', type=int,
-    help='Set timeout in seconds for HTTP requests')
+group.add_argument('-q', '--quiet', action='store_true', help='hide logging messages')
+
 PARSER.set_defaults(**DEFAULT_OPTIONS)
 
 
@@ -166,9 +194,17 @@ def main(argv=None, stdout=None, stdin=None, HTML=HTML):  # noqa: N803
     else:
         output = args.output
 
-    url_fetcher = default_url_fetcher
+    fetcher_args = {}
     if args.timeout is not None:
-        url_fetcher = partial(default_url_fetcher, timeout=args.timeout)
+        fetcher_args['timeout'] = args.timeout
+    if args.allowed_protocols is not None:
+        fetcher_args['allowed_protocols'] = {
+            protocol.strip().lower() for protocol in args.allowed_protocols.split(',')}
+    if args.no_http_redirects:
+        fetcher_args['allow_redirects'] = False
+    if args.fail_on_http_errors:
+        fetcher_args['fail_on_errors'] = True
+    url_fetcher = URLFetcher(**fetcher_args)
 
     options = {
         key: value for key, value in vars(args).items() if key in DEFAULT_OPTIONS}

weasyprint/anchors.py

@@ -43,8 +43,8 @@ def gather_anchors(box, anchors, links, bookmarks, forms, parent_matrix=None,
         border_width = box.border_width()
         border_height = box.border_height()
         origin_x, origin_y = box.style['transform_origin']
-        offset_x = percentage(origin_x, border_width)
-        offset_y = percentage(origin_y, border_height)
+        offset_x = percentage(origin_x, box.style, border_width)
+        offset_y = percentage(origin_y, box.style, border_height)
         origin_x = box.border_box_x() + offset_x
         origin_y = box.border_box_y() + offset_y
 
@@ -58,8 +58,8 @@ def gather_anchors(box, anchors, links, bookmarks, forms, parent_matrix=None,
                 b = math.sin(args)
                 c = -b
             elif name == 'translate':
-                e = percentage(args[0], border_width)
-                f = percentage(args[1], border_height)
+                e = percentage(args[0], box.style, border_width)
+                f = percentage(args[1], box.style, border_height)
             elif name == 'skew':
                 b, c = math.tan(args[1]), math.tan(args[0])
             else: