DEP: PEP8 renaming

[MartinThoma]

PyPDF2 interface changes:

• getXmpMetadata / xmpMetadata ➔ xmp_metadata
• get_outlines ➔ _get_outlines (use outlines property instead)
• getXmpMetadata ➔ xmp_metadata
• getDestArray ➔ dest_array
• additionalActions ➔ additional_actions
• defaultValue ➔ default_value
• mappingName ➔ mapping_name
• altName ➔ alternate_name
• fieldType ➔ field_type
• ensureIsNumber ➔ _ensure_is_number
• decodedSelf : decoded_self
• addChild / removeChild ➔ add_child / remove_child
• flateEncode ➔ flate_encode
• getData / setData ➔ get_data / set_data

DOC: Use the new PyPDF2 interface
STY: Use reader/writer as variable names for PdfReader / PdfWriter

[codecov]

Codecov Report

Merging #900 (81e99e6) into main (e8513e7) will decrease coverage by 0.65%.
The diff coverage is 68.37%.

@@            Coverage Diff             @@
##             main     #900      +/-   ##
==========================================
- Coverage   78.55%   77.90%   -0.66%     
==========================================
  Files          16       16              
  Lines        4258     4317      +59     
  Branches      813      813              
==========================================
+ Hits         3345     3363      +18     
- Misses        738      780      +42     
+ Partials      175      174       -1     

Impacted Files	Coverage Δ
PyPDF2/xmp.py	52.06% <50.00%> (-1.04%)	⬇️
PyPDF2/generic.py	77.97% <61.53%> (-1.90%)	⬇️
PyPDF2/_reader.py	77.17% <88.88%> (-0.72%)	⬇️
PyPDF2/_merger.py	65.51% <100.00%> (-0.33%)	⬇️
PyPDF2/_page.py	79.23% <100.00%> (ø)
PyPDF2/_writer.py	78.90% <100.00%> (ø)
PyPDF2/filters.py	75.00% <100.00%> (ø)
... and 1 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e8513e7...81e99e6. Read the comment docs.

[MartinThoma]

I was curious if some of those attributes were actually used:

• decodedSelf:
  • https://github.com/vladislavgrisyuk/PdfVaccineHelper/blob/2ee49d34c093efa5e00d52ab25542f99bf6cb431/pdfhelper.py
  • https://github.com/prabalbhandari04/aaha-ecom/blob/02127a0b3a39e95a4e9ab1692d3cff976a7c709e/Backend/Order/tets.py#L69-L72
  • https://github.com/Trigo93/mailbot/blob/fac9157413235e27512e1a21d9003450aa02fbaa/src/pdf_helper.py#L24-L27
  • https://github.com/khanfarhan10/PythonCertificateGenerator/blob/976333d9a2bd97fb34a98351798201760cd6cbde/Gen2.py#L50-L53
  • Astonishingly many repositories that simply copied the PyPDF2 / pypdf code; openerp was shown often in the github search
• additionalActions: I didn't find a single script

[MartinThoma]

rotate_clockwise -> just rotate?

Pro rotate_clockwise:

• It's clear from the name in which direction the rotation goes

Pro rotate:

• Shorter
• PyMuPDF (Fitz) uses set_rotate - unclear in which direction
• PikePDF (qpdf) uses .Rotate. pdfrw as well

Other:

• OpenCV: cv2.rotate(src, cv2.cv2.ROTATE_90_CLOCKWISE)
• Nump: rot90(m, k)