[WIP] add python paper muncher package #87

Flotchet · 2025-08-28T13:20:52Z

No description provided.

Copilot

Pull Request Overview

This PR adds a comprehensive Python package for Paper Muncher, providing both synchronous and asynchronous interfaces for HTML-to-PDF rendering. The package includes framework integrations for Flask and WSGI applications, cross-platform I/O handling with timeout support, and comprehensive examples.

Key changes:

Removes the old simple papermuncher.py implementation and sample.py
Introduces a new structured package with synchronous and asynchronous rendering capabilities
Adds framework-specific integrations for Flask and WSGI applications

Reviewed Changes

Copilot reviewed 25 out of 26 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
meta/bindings/python/sample.py	Removed old sample implementation
meta/bindings/python/papermuncher.py	Removed old monolithic implementation
meta/bindings/python/paper_muncher/*.py	New package structure with typing definitions and binary utilities
meta/bindings/python/paper_muncher/synchronous/*.py	Synchronous rendering implementation with cross-platform I/O
meta/bindings/python/paper_muncher/asynchrous/*.py	Asynchronous rendering implementation
meta/bindings/python/paper_muncher/runners/*.py	WSGI runner utilities
meta/bindings/python/paper_muncher/frameworks/*.py	Flask and WSGI framework integrations
meta/bindings/python/examples/*.py	Usage examples for different scenarios

Copilot · 2025-09-01T14:14:01Z

meta/bindings/python/paper_muncher/asynchrous/request.py

@@ -0,0 +1,92 @@
+"""The :mod:`paper_muncher.synchronous.request`


The module docstring incorrectly references 'synchronous' instead of 'asynchronous' for an asynchronous module.

Suggested change

"""The :mod:`paper_muncher.synchronous.request`

"""The :mod:`paper_muncher.asynchrous.request`

Copilot · 2025-09-01T14:14:02Z

meta/bindings/python/paper_muncher/asynchrous/interface.py

@@ -0,0 +1,278 @@
+"""
+The :mod:`.paper_muncher.synchronous.interface` module provides


The module docstring incorrectly references 'synchronous' instead of 'asynchronous' for an asynchronous module.

Suggested change

The :mod:`.paper_muncher.synchronous.interface` module provides

The :mod:`.paper_muncher.asynchrous.interface` module provides

Copilot · 2025-09-01T14:14:02Z

meta/bindings/python/paper_muncher/asynchrous/__init__.py

@@ -0,0 +1,9 @@
+"""The :mod:`paper_muncher.asynchronous` module


The module docstring references 'asynchronous' but the actual directory name is 'asynchrous' (misspelled). Either fix the directory name to 'asynchronous' or update the docstring to match.

Suggested change

"""The :mod:`paper_muncher.asynchronous` module

"""The :mod:`paper_muncher.asynchrous` module

Copilot · 2025-09-01T14:14:03Z

meta/bindings/python/paper_muncher/runners/wsgi.py

+    response_iterable, http_status, http_response_headers = run_wsgi_app(
+        application, generate_environ(environ)


The function call passes 'environ' to 'generate_environ' but 'generate_environ' expects two parameters: 'path' and 'current_environ'. The 'request_path' parameter should be passed as the first argument.

Suggested change

response_iterable, http_status, http_response_headers = run_wsgi_app(

application, generate_environ(environ)

application, generate_environ(request_path, environ)

Copilot · 2025-09-01T14:14:03Z

meta/bindings/python/paper_muncher/synchronous/io_with_timeout/fallback/communications.py

+    timeout: int,
+) -> bytes:
+    """Read all data from a file-like object until EOF.
+
+    :param BinaryIO file_object: File-like object to read from.
+    :param int timeout: UNUSED timeout parameter.
+        (Fallback implementation does not support timeouts)


The function signature is inconsistent with other implementations. The POSIX and NT versions include a 'chunk_size' parameter, but the fallback version does not. This could cause issues when switching between implementations.

Suggested change

timeout: int,

) -> bytes:

"""Read all data from a file-like object until EOF.

:param BinaryIO file_object: File-like object to read from.

:param int timeout: UNUSED timeout parameter.

(Fallback implementation does not support timeouts)

timeout: int,

chunk_size: int = 4096,

) -> bytes:

"""Read all data from a file-like object until EOF.

:param BinaryIO file_object: File-like object to read from.

:param int timeout: UNUSED timeout parameter.

(Fallback implementation does not support timeouts)

:param int chunk_size: UNUSED chunk size parameter.

(Fallback implementation does not support chunked reading)

Copilot · 2025-09-01T14:14:03Z

meta/bindings/python/paper_muncher/synchronous/io_with_timeout/fallback/communications.py

+    _logger.warning(
+        "Using fallback readlines_with_timeout. "


The warning message mentions 'readlines_with_timeout' but the actual function name is 'read_all_with_timeout'.

Suggested change

_logger.warning(

"Using fallback readlines_with_timeout. "

"Using fallback read_all_with_timeout. "

Copilot · 2025-09-01T14:14:03Z

meta/bindings/python/paper_muncher/synchronous/interface.py

+        ) % {
+            b'length': len(content.encode()),
+            b'date':  format_datetime(now, usegmt=True).encode(),
+            b'server': SERVER_SOFTWARE,
+        }


The 'content' variable is expected to be a BytesIO object, but '.encode()' is being called on it. This will fail since BytesIO objects don't have an encode method. Use 'content.getvalue()' to get the bytes content, or ensure content is properly handled as bytes.

Copilot · 2025-09-01T14:14:04Z

meta/bindings/python/paper_muncher/synchronous/interface.py

+        )
+        write_with_timeout(
+            process.stdin,
+            content.encode(),


Same issue as above - 'content' is a BytesIO object and doesn't have an encode() method. Use 'content.getvalue()' instead.

Copilot · 2025-09-01T14:14:04Z

meta/bindings/python/paper_muncher/asynchrous/interface.py

+            b"Server: %(server)s\r\n"
+            b"\r\n"
+        ) % {
+            b'length': len(content.encode()),


Same issue - 'content' is a BytesIO object and doesn't have an encode() method. Use 'content.getvalue()' instead.

Copilot · 2025-09-01T14:14:04Z

meta/bindings/python/paper_muncher/asynchrous/interface.py

+        )
+        await write_with_timeout(
+            process.stdin,
+            content.encode(),


Same issue - 'content' is a BytesIO object and doesn't have an encode() method. Use 'content.getvalue()' instead.

Flotchet force-pushed the py-pack-mafl branch from e292a04 to deae482 Compare September 1, 2025 13:09

sleepy-monax requested a review from Copilot September 1, 2025 14:10

Copilot AI reviewed Sep 1, 2025

View reviewed changes

Flotchet force-pushed the py-pack-mafl branch 8 times, most recently from 2dae8f7 to 8dbf492 Compare September 4, 2025 09:33

add python paper muncher package

3bc9436

Flotchet force-pushed the py-pack-mafl branch from 8dbf492 to 3bc9436 Compare September 4, 2025 11:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[WIP] add python paper muncher package #87

[WIP] add python paper muncher package #87

Uh oh!

Flotchet commented Aug 28, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Sep 1, 2025

Uh oh!

Copilot AI Sep 1, 2025

Uh oh!

Copilot AI Sep 1, 2025

Uh oh!

Copilot AI Sep 1, 2025

Uh oh!

Copilot AI Sep 1, 2025

Uh oh!

Copilot AI Sep 1, 2025

Uh oh!

Copilot AI Sep 1, 2025

Uh oh!

Copilot AI Sep 1, 2025

Uh oh!

Copilot AI Sep 1, 2025

Uh oh!

Copilot AI Sep 1, 2025

Uh oh!

Uh oh!

		@@ -0,0 +1,92 @@
		"""The :mod:`paper_muncher.synchronous.request`

	"""The :mod:`paper_muncher.synchronous.request`
	"""The :mod:`paper_muncher.asynchrous.request`

		@@ -0,0 +1,278 @@
		"""
		The :mod:`.paper_muncher.synchronous.interface` module provides

	The :mod:`.paper_muncher.synchronous.interface` module provides
	The :mod:`.paper_muncher.asynchrous.interface` module provides

		@@ -0,0 +1,9 @@
		"""The :mod:`paper_muncher.asynchronous` module

	"""The :mod:`paper_muncher.asynchronous` module
	"""The :mod:`paper_muncher.asynchrous` module

		response_iterable, http_status, http_response_headers = run_wsgi_app(
		application, generate_environ(environ)

	response_iterable, http_status, http_response_headers = run_wsgi_app(
	application, generate_environ(environ)
	application, generate_environ(request_path, environ)

	_logger.warning(
	"Using fallback readlines_with_timeout. "
	"Using fallback read_all_with_timeout. "

[WIP] add python paper muncher package #87

Are you sure you want to change the base?

[WIP] add python paper muncher package #87

Uh oh!

Conversation

Flotchet commented Aug 28, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!