ENH: Add --layout parameter to up2

[mulla028]

Closes #64

Overview

This PR introduces an optional --layout parameter to the up2 command, allowing users to arrange PDF pages in configurable grid layouts. Supported layouts include:

• 2x2: 2 columns, 2 rows per page
• 3x3: 3 columns, 3 rows per page
• 1x2: 1 column, 2 rows per page
• 2x1: 2 columns, 1 row per page

If --layout is not specified, the command defaults to the original behavior, ensuring full backward compatibility.

Changes

1. up2.py:

   • Added a new up2_main function to manage both default behavior and specified layouts.
   • Updated page dimension access to mediabox for compatibility with recent versions of pypdf.
   • Retained the original main function for backward compatibility, though future calls should use up2_main.

2. cli.py:

   • Modified the up2 command to call up2_main with an optional --layout parameter for layout configurations.
   • Retained all original commands and functionality to ensure no changes to existing CLI behavior.

Testing

To test each layout configuration, run the following commands:

# Default behavior (no layout specified)
python cli.py up2 path/to/input.pdf path/to/output_default.pdf

# 2x2 layout
python cli.py up2 path/to/input.pdf path/to/output_2x2.pdf --layout 2x2

# 3x3 layout
python cli.py up2 path/to/input.pdf path/to/output_3x3.pdf --layout 3x3

# 1x2 layout
python cli.py up2 path/to/input.pdf path/to/output_1x2.pdf --layout 1x2

# 2x1 layout
python cli.py up2 path/to/input.pdf path/to/output_2x1.pdf --layout 2x1

[mulla028]

@Lucas-C
I have written yesterday a test for --layout feature, but wasn't sure if you need it. According to your recent feedback in Issue #63, I found that you would like to see some tests. Eventually, I just pushed it 😆

[MartinThoma]

We use pytest as a test suite to automatically run the tests and check if they succeeded.

Pytest looks for functions starting with "test_"

Suggested change

	# File paths for the input and output PDFs
	input_pdf = Path("test_input.pdf")
	output_pdf = Path("test_output.pdf")
	# Create the test PDF
	create_test_pdf(input_pdf)
	# List of layouts to test
	layouts = ["2x2", "3x3", "1x2", "2x1"]
	for layout in layouts:
	print(f"\nTesting layout: {layout}")
	up2_main(input_pdf, output_pdf, layout=layout)
	# Read the output PDF and print the number of pages
	reader = PdfReader(str(output_pdf))
	print(f"Output PDF for layout {layout} has {len(reader.pages)} pages.")
	# Clean up
	if output_pdf.exists():
	os.remove(output_pdf)
	if input_pdf.exists():
	os.remove(input_pdf)
	def test_layout_option():
	# File paths for the input and output PDFs
	input_pdf = Path("test_input.pdf")
	output_pdf = Path("test_output.pdf")
	# Create the test PDF
	create_test_pdf(input_pdf)
	# List of layouts to test
	layouts = ["2x2", "3x3", "1x2", "2x1"]
	for layout in layouts:
	print(f"\nTesting layout: {layout}")
	up2_main(input_pdf, output_pdf, layout=layout)
	# Read the output PDF and print the number of pages
	reader = PdfReader(str(output_pdf))
	print(f"Output PDF for layout {layout} has {len(reader.pages)} pages.")
	# Clean up
	if output_pdf.exists():
	os.remove(output_pdf)
	if input_pdf.exists():
	os.remove(input_pdf)

[MartinThoma]

Suggested change

	writer.write(f_out)
	writer.write(f_out)

[MartinThoma]

What is the reason to restrict the layout options? Wouldn't any XxY with X and Y being positive integers work?

[MartinThoma]

Thank you for your contribution!

[MartinThoma]

Could you please run black . (an auto-formatter; you might need to install it via pip install black first)?

[MartinThoma]

You could add this test to test_up2.py

[MartinThoma]

@mulla028 Sorry that it took me a month to review 🙈 If you want, I would clean-up the remaining parts. Just let me know if you want to finish it yourself or not :-)