DEV: Unify code between PdfReader and PdfWriter (#2497)

py-pdf · Mar 25, 2024 · 24709a3 · 24709a3
1 parent f8edf3c
commit 24709a3
Show file tree

Hide file tree

Showing 21 changed files with 1,683 additions and 1,433 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -66,7 +66,10 @@
 nitpick_ignore_regex = [
  # For reasons unclear at this stage the io module prefixes everything with _io
  # and this confuses sphinx
- (r"py:class", r"_io.(FileIO|BytesIO|Buffered(Reader|Writer))"),
+ (
+ r"py:class",
+ r"(_io.(FileIO|BytesIO|Buffered(Reader|Writer))|pypdf.*PdfDocCommon)",
+ ),
 ]
 
 autodoc_default_options = {

diff --git a/docs/index.rst b/docs/index.rst
@@ -56,14 +56,14 @@ You can contribute to `pypdf on GitHub <https://github.com/py-pdf/pypdf>`_.
  modules/PageObject
  modules/PageRange
  modules/PaperSize
- modules/PdfMerger
  modules/RectangleObject
  modules/Transformation
  modules/XmpInformation
  modules/annotations
  modules/constants
  modules/errors
  modules/generic
+ modules/PdfDocCommon
 
 .. toctree::
  :caption: Developer Guide

diff --git a/docs/modules/PdfDocCommon.md b/docs/modules/PdfDocCommon.md
@@ -0,0 +1,5 @@
+# The PdfDocCommon Class
+
+**PdfDocCommon** is an abstract class which is inherited by **PdfReader** and **PdfWriter**
+
+Where indentified in the API, you can use any of the derivated class.
diff --git a/docs/modules/PdfMerger.rst b/docs/modules/PdfMerger.rst
diff --git a/docs/modules/PdfReader.rst b/docs/modules/PdfReader.rst
@@ -3,6 +3,7 @@ The PdfReader Class
 
 .. autoclass:: pypdf.PdfReader
  :members:
+ :inherited-members:
  :undoc-members:
  :show-inheritance:
 

diff --git a/docs/modules/PdfWriter.rst b/docs/modules/PdfWriter.rst
@@ -3,6 +3,7 @@ The PdfWriter Class
 
 .. autoclass:: pypdf.PdfWriter
  :members:
+ :inherited-members:
  :undoc-members:
  :show-inheritance:
 

diff --git a/docs/modules/generic.rst b/docs/modules/generic.rst
@@ -7,12 +7,25 @@ Generic PDF objects
  :show-inheritance:
  :exclude-members: Destination, Field, Fit, RectangleObject
 
+
 .. autoclass:: pypdf._protocols.PdfObjectProtocol
  :members:
  :undoc-members:
  :show-inheritance:
 
 
+.. autoclass:: pypdf._protocols.XmpInformationProtocol
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+.. autoclass:: pypdf._protocols.PdfCommonDocProtocol
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
 .. autoclass:: pypdf._protocols.PdfReaderProtocol
  :members:
  :undoc-members:

diff --git a/docs/user/robustness.md b/docs/user/robustness.md
@@ -40,4 +40,4 @@ not follow the specification.
 
 Choosing `strict=False` means that pypdf will try to be forgiving and do
 something reasonable, but it will log a warning message. It is a best-effort
-approach.
+approach.
diff --git a/pypdf/__init__.py b/pypdf/__init__.py
@@ -8,10 +8,11 @@
 """
 
 from ._crypt_providers import crypt_provider
+from ._doc_common import DocumentInformation
 from ._encryption import PasswordType
 from ._merger import PdfMerger
 from ._page import PageObject, Transformation, mult
-from ._reader import DocumentInformation, PdfReader
+from ._reader import PdfReader
 from ._version import __version__
 from ._writer import ObjectDeletionFlag, PdfWriter
 from .constants import ImageType