add example simple_page_setup.py

Author: mozman

docs/source/tutorials/psp_viewports.rst

@@ -73,6 +73,10 @@ applications may not print that content.
     paper size does shift the layout content, because all paper sizes are defined
     without margins. Maybe it's preferable to set all margins to zero.
 
+    I added the helper method :meth:`~ezdxf.document.Drawing.page_setup` to the
+    :class:`~ezdxf.document.Drawing` class and an example `simple_page_setup.py`_
+    how to use it.
+
 Adding Viewports
 ----------------
 
@@ -213,4 +217,5 @@ Supported property overrides:
 .. _About Plotting: https://help.autodesk.com/view/ACD/2018/ENU/?guid=GUID-2DB9EB8C-767C-4C91-B0A3-FFFEC4C5863A
 .. _About Setting the Plot Scale: https://help.autodesk.com/view/ACD/2018/ENU/?guid=GUID-89604826-0B55-4994-8214-1CA93FA66985
 .. _General Procedure for Printing: https://help.bricsys.com/document/_guides--BCAD_printing_and_plotting--GD_generalprocedureforprinting/V23/EN_US?id=165079156041
-.. _viewports_override_layer_attributes.py: https://github.com/mozman/ezdxf/blob/master/examples/viewports_override_layer_attributes.py
+.. _viewports_override_layer_attributes.py: https://github.com/mozman/ezdxf/blob/master/examples/viewports_override_layer_attributes.py
+.. _simple_page_setup.py: https://github.com/mozman/ezdxf/blob/master/examples/simple_page_setup.py

examples/simple_page_setup.py

@@ -0,0 +1,42 @@
+#  Copyright (c) 2022, Manfred Moitzi
+#  License: MIT License
+
+import pathlib
+import ezdxf
+from ezdxf.layouts import Paperspace
+
+CWD = pathlib.Path("~/Desktop/Outbox").expanduser()
+if not CWD.exists():
+    CWD = pathlib.Path(".")
+
+# ------------------------------------------------------------------------------
+# This example shows how to use the simple page setup method of the Drawing object.
+#
+# This setup creates simple layouts without margins and offset, this way changing
+# the output device is easy at least is BricsCAD.
+# ------------------------------------------------------------------------------
+
+
+def draw_crossings_lines(psp: Paperspace):
+    # These layouts have no margins and offset defined, so the drawing space is
+    # the whole sheet, but printers and plotters will not print to the
+    # border of the sheet! In real world files keep always a safety space between
+    # the sheet borders and the content. The size of that safety space cannot be
+    # known because it's different for each printer and plotter.
+    width = psp.dxf.paper_width
+    height = psp.dxf.paper_height
+    psp.add_line((0, 0), (width, height))
+    psp.add_line((0, height), (width, 0))
+
+
+def main():
+    doc = ezdxf.new()
+    layout1 = doc.page_setup("Layout1", "ISO A0", landscape=True)
+    layout2 = doc.page_setup("Layout2", "ISO A0", landscape=False)
+    draw_crossings_lines(layout1)
+    draw_crossings_lines(layout2)
+    doc.saveas(CWD / "simple_page_setup.dxf")
+
+
+if __name__ == "__main__":
+    main()

integration_tests/test_document_page_setup.py

@@ -5,13 +5,19 @@
 import ezdxf
 
 
+def test_simple_page_setup_is_not_supported_for_DXF_R12():
+    doc = ezdxf.new("R12")
+    with pytest.raises(ezdxf.DXFVersionError):
+        doc.page_setup("Layout1")
+
+
 def test_reset_layout1_landscape():
     doc = ezdxf.new()
     assert len(doc.layouts) == 2
     psp = doc.page_setup("Layout1", fmt="ISO A0")
     assert len(doc.layouts) == 2
-    assert psp.dxf_layout.dxf.paper_width == 1189
-    assert psp.dxf_layout.dxf.paper_height == 841
+    assert psp.dxf.paper_width == 1189
+    assert psp.dxf.paper_height == 841
 
 
 def test_invalid_paper_format_returns_A3():
@@ -25,8 +31,8 @@ def test_reset_layout1_portrait():
     assert len(doc.layouts) == 2
     psp = doc.page_setup("Layout1", fmt="ISO A0", landscape=False)
     assert len(doc.layouts) == 2
-    assert psp.dxf_layout.dxf.paper_width == 841
-    assert psp.dxf_layout.dxf.paper_height == 1189
+    assert psp.dxf.paper_width == 841
+    assert psp.dxf.paper_height == 1189
 
 
 def test_resetting_layout1_creates_a_new_main_viewport():
@@ -51,9 +57,9 @@ def test_new_layout2():
     assert len(doc.layouts) == 2
     psp = doc.page_setup("Layout2", fmt="ISO A0")
     assert len(doc.layouts) == 3
-    assert psp.dxf_layout.dxf.paper_width == 1189
-    assert psp.dxf_layout.dxf.paper_height == 841
+    assert psp.dxf.paper_width == 1189
+    assert psp.dxf.paper_height == 841
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     pytest.main([__file__])

src/ezdxf/document.py

@@ -947,8 +947,8 @@ def page_setup(
         landscape=True,
     ) -> Paperspace:
         """
-        Creates a new paperspace layout if `name` does not
-        exist or reset the existing layout.
+        Creates a new paperspace layout if `name` does not exist or reset the
+        existing layout.  This method requires DXF R2000 or newer.
         The paper format name `fmt` defines one of the following paper sizes,
         measures in landscape orientation:
 
@@ -986,6 +986,8 @@ def page_setup(
         """
         from ezdxf.tools.standards import PAGE_SIZES
 
+        if self.acad_release == "R12":
+            raise const.DXFVersionError("method call no supported for DXF R12")
         width: float
         height: float
         try:

src/ezdxf/layouts/layout.py

@@ -574,7 +574,7 @@ def add_new_main_viewport(self) -> Viewport:
     def page_setup(
         self,
         size: Tuple[float, float] = (297, 210),
-        margins: Tuple[float, float, float, float] = (10, 15, 10, 15),
+        margins: Tuple[float, float, float, float] = (0, 0, 0, 0),
         units: str = "mm",
         offset: Tuple[float, float] = (0, 0),
         rotation: int = 0,
@@ -713,10 +713,10 @@ def get_paper_limits(self) -> Tuple[Vec2, Vec2]:
 
     def page_setup_r12(
         self,
-        size: Tuple[int, int] = (297, 210),
-        margins: Tuple[int, int, int, int] = (0, 0, 0, 0),
+        size: Tuple[float, float] = (297, 210),
+        margins: Tuple[float, float, float, float] = (0, 0, 0, 0),
         units: str = "mm",
-        offset: Tuple[int, int] = (0, 0),
+        offset: Tuple[float, float] = (0, 0),
         rotation: float = 0,
         scale: Union[int, Tuple[float, float]] = 16,
     ) -> None: