-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
CHANGELOG
1280 lines (888 loc) · 40.6 KB
/
CHANGELOG
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
Version 2.1.0, 2022-06-06
-------------------------
The highlight of the 2.1.0 release is the most massive improvement to the
text extraction capabilities of PyPDF2 since 2016 🥳🎊 A very big thank you goes
to [pubpub-zz](https://github.com/pubpub-zz) who took a lot of time and
knowledge about the PDF format to finally get those improvements into PyPDF2.
Thank you 🤗💚
In case the new function causes any issues, you can use `_extract_text_old`
for the old functionality. Please also open a bug ticket in that case.
There were several people who have attempted to bring similar improvements to
PyPDF2. All of those were valuable. The main reason why they didn't get merged
is the big amount of open PRs / issues. pubpub-zz was the most comprehensive
PR which also incorporated the latest changes of PyPDF2 2.0.0.
Thank you to [VictorCarlquist](https://github.com/VictorCarlquist) for #858 and
[asabramo](https://github.com/asabramo) for #464 🤗
New Features (ENH):
- Massive text extraction improvement (#924). Closed many open issues:
- Exceptions / missing spaces in extract_text() method (#17) 🕺
- Whitespace issues in extract_text() (#42) 💃
- pypdf2 reads the hifenated words in a new line (#246)
- PyPDF2 failing to read unicode character (#37)
- Unable to read bullets (#230)
- ExtractText yields nothing for apparently good PDF (#168) 🎉
- Encoding issue in extract_text() (#235)
- extractText() doesn't work on Chinese PDF (#252)
- encoding error (#260)
- Trouble with apostophes in names in text "O'Doul" (#384)
- extract_text works for some PDF files, but not the others (#437)
- Euro sign not being recognized by extractText (#443)
- Failed extracting text from French texts (#524)
- extract_text doesn't extract ligatures correctly (#598)
- reading spanish text - mark convert issue (#635)
- Read PDF changed from text to random symbols (#654)
- .extractText() reads / as 1. (#789)
- Update glyphlist (#947) - inspired by #464
- Allow adding PageRange objects (#948)
Bug Fixes (BUG):
- Delete .python-version file (#944)
- Compare StreamObject.decoded_self with None (#931)
Robustness (ROB):
- Fix some conversion errors on non conform PDF (#932)
Documentation (DOC):
- Elaborate on PDF text extraction difficulties (#939)
- Add logo (#942)
- rotate vs Transformation().rotate (#937)
- Example how to use PyPDF2 with AWS S3 (#938)
- How to deprecate (#930)
- Fix typos on robustness page (#935)
- Remove scripts (pdfcat) from docs (#934)
Developer Experience (DEV):
- Ignore .python-version file
- Mark deprecated code with no-cover (#943)
- Automatically create Github releases from tags (#870)
Testing (TST):
- Text extraction for non-latin alphabets (#954)
- Ignore PdfReadWarning in benchmark (#949)
- writer.remove_text (#946)
- Add test for Tree and _security (#945)
Code Style (STY):
- black, isort, Flake8, splitting buildCharMap (#950)
Full Changelog: https://github.com/py-pdf/PyPDF2/compare/2.0.0...2.1.0
Version 2.0.0, 2022-06-01
-------------------------
The 2.0.0 release of PyPDF2 includes three core changes:
1. Dropping support for Python 3.5 and older.
2. Introducing type annotations.
3. Interface changes, mostly to have PEP8-compliant names
We introduced a [deprecation process](https://github.com/py-pdf/PyPDF2/pull/930)
that hopefully helps users to avoid unexpected breaking changes.
Breaking Changes(DEP):
- PyPDF2 2.0 requires Python 3.6+. Python 2.7 and 3.5 support were dropped.
- PdfFileReader: The "warndest" parameter was removed
- PdfFileReader and PdfFileMerger no longer have the `overwriteWarnings`
parameter. The new behavior is `overwriteWarnings=False`.
- merger: OutlinesObject was removed without replacement.
- merger.py ➔ _merger.py: You must import PdfFileMerger from PyPDF2 directly.
- utils:
* `ConvertFunctionsToVirtualList` was removed
* `formatWarning` was removed
* `isInt(obj)`: Use `instance(obj, int)` instead
* `u_(s)`: Use `s` directly
* `chr_(c)`: Use `chr(c)` instead
* `barray(b)`: Use `bytearray(b)` instead
* `isBytes(b)`: Use `instance(b, type(bytes()))` instead
* `xrange_fn`: Use `range` instead
* `string_type`: Use `str` instead
* `isString(s)`: Use `instance(s, str)` instead
* `_basestring`: Use `str` instead
* All Exceptions are now in `PyPDF2.errors`:
- PageSizeNotDefinedError
- PdfReadError
- PdfReadWarning
- PyPdfError
- `PyPDF2.pdf` (the `pdf` module) no longer exists. The contents were moved with
the library. You should most likely import directly from `PyPDF2` instead.
The `RectangleObject` is in `PyPDF2.generic`.
- The `Resources`, `Scripts`, and `Tests` will no longer be part of the distribution
files on PyPI. This should have little to no impact on most people. The
`Tests` are renamed to `tests`, the `Resources` are renamed to `resources`.
Both are still in the git repository. The `Scripts` are now in
https://github.com/py-pdf/cpdf. `Sample_Code` was moved to the `docs`.
For a full list of deprecated functions, please see the changelog of version
1.28.0.
New Features (ENH):
- Improve space setting for text extraction (#922)
- Allow setting the decryption password in PdfReader.__init__ (#920)
- Add Page.add_transformation (#883)
Bug Fixes (BUG):
- Fix error adding transformation to page without /Contents (#908)
Robustness (ROB):
- Cope with invalid length in streams (#861)
Documentation (DOC):
- Fix style of 1.25 and 1.27 patch notes (#927)
- Transformation (#907)
Developer Experience (DEV):
- Create flake8 config file (#916)
- Use relative imports (#875)
Maintenance (MAINT):
- Use Python 3.6 language features (#849)
- Add wrapper function for PendingDeprecationWarnings (#928)
- Use new PEP8 compliant names (#884)
- Explicitly represent transformation matrix (#878)
- Inline PAGE_RANGE_HELP string (#874)
- Remove unnecessary generics imports (#873)
- Remove star imports (#865)
- merger.py ➔ _merger.py (#864)
- Type annotations for all functions/methods (#854)
- Add initial type support with mypy (#853)
Testing (TST):
- Regression test for xmp_metadata converter (#923)
- Checkout submodule sample-files for benchmark
- Add text extracting performance benchmark
- Use new PyPDF2 API in benchmark (#902)
- Make test suite fail for uncaught warnings (#892)
- Remove -OO testrun from CI (#901)
- Improve tests for convert_to_int (#899)
Full Changelog: https://github.com/py-pdf/PyPDF2/compare/1.28.4...2.0.0
Version 1.28.4, 2022-05-29
--------------------------
Bug Fixes (BUG):
- XmpInformation._converter_date was unusable (#921)
Full Changelog: https://github.com/py-pdf/PyPDF2/compare/1.28.3...1.28.4
Version 1.28.3, 2022-05-28
--------------------------
Deprecations (DEP):
- PEP8 renaming (#905)
Bug Fixes (BUG):
- XmpInformation missing method _getText (#917)
- Fix PendingDeprecationWarning on _merge_page (#904)
Full Changelog: https://github.com/py-pdf/PyPDF2/compare/1.28.2...1.28.3
Version 1.28.2, 2022-05-23
--------------------------
Bug Fixes (BUG):
- PendingDeprecationWarning for getContents (#893)
- PendingDeprecationWarning on using PdfMerger (#891)
Full Changelog: https://github.com/py-pdf/PyPDF2/compare/1.28.1...1.28.2
Version 1.28.1, 2022-05-22
--------------------------
Bug Fixes (BUG):
- Incorrectly show deprecation warnings on internal usage (#887)
Maintenance (MAINT):
- Add stacklevel=2 to deprecation warnings (#889)
- Remove duplicate warnings imports (#888)
Full Changelog: https://github.com/py-pdf/PyPDF2/compare/1.28.0...1.28.1
Version 1.28.0, 2022-05-22
--------------------------
This release adds a lot of deprecation warnings in preparation of the
PyPDF2 2.0.0 release. The changes are mostly using snake_case function-, method-,
and variable-names as well as using properties instead of getter-methods.
Maintenance (MAINT):
- Remove IronPython Fallback for zlib (#868)
Full Changelog: https://github.com/py-pdf/PyPDF2/compare/1.27.12...1.27.13
### Deprecations (DEP)
* Make the `PyPDF2.utils` module private
* Rename of core classes:
* PdfFileReader ➔ PdfReader
* PdfFileWriter ➔ PdfWriter
* PdfFileMerger ➔ PdfMerger
* Use PEP8 conventions for function names and parameters
* If a property and a getter-method are both present, use the property
#### Details
In many places:
- getObject ➔ get_object
- writeToStream ➔ write_to_stream
- readFromStream ➔ read_from_stream
PyPDF2.generic
- readObject ➔ read_object
- convertToInt ➔ convert_to_int
- DocumentInformation.getText ➔ DocumentInformation._get_text :
This method should typically not be used; please let me know if you need it.
PdfReader class:
- `reader.getPage(pageNumber)` ➔ `reader.pages[page_number]`
- `reader.getNumPages()` / `reader.numPages` ➔ `len(reader.pages)`
- getDocumentInfo ➔ metadata
- flattenedPages attribute ➔ flattened_pages
- resolvedObjects attribute ➔ resolved_objects
- xrefIndex attribute ➔ xref_index
- getNamedDestinations / namedDestinations attribute ➔ named_destinations
- getPageLayout / pageLayout ➔ page_layout attribute
- getPageMode / pageMode ➔ page_mode attribute
- getIsEncrypted / isEncrypted ➔ is_encrypted attribute
- getOutlines ➔ get_outlines
- readObjectHeader ➔ read_object_header
- cacheGetIndirectObject ➔ cache_get_indirect_object
- cacheIndirectObject ➔ cache_indirect_object
- getDestinationPageNumber ➔ get_destination_page_number
- readNextEndLine ➔ read_next_end_line
- _zeroXref ➔ _zero_xref
- _authenticateUserPassword ➔ _authenticate_user_password
- _pageId2Num attribute ➔ _page_id2num
- _buildDestination ➔ _build_destination
- _buildOutline ➔ _build_outline
- _getPageNumberByIndirect(indirectRef) ➔ _get_page_number_by_indirect(indirect_ref)
- _getObjectFromStream ➔ _get_object_from_stream
- _decryptObject ➔ _decrypt_object
- _flatten(..., indirectRef) ➔ _flatten(..., indirect_ref)
- _buildField ➔ _build_field
- _checkKids ➔ _check_kids
- _writeField ➔ _write_field
- _write_field(..., fieldAttributes) ➔ _write_field(..., field_attributes)
- _read_xref_subsections(..., getEntry, ...) ➔ _read_xref_subsections(..., get_entry, ...)
PdfWriter class:
- `writer.getPage(pageNumber)` ➔ `writer.pages[page_number]`
- `writer.getNumPages()` ➔ `len(writer.pages)`
- addMetadata ➔ add_metadata
- addPage ➔ add_page
- addBlankPage ➔ add_blank_page
- addAttachment(fname, fdata) ➔ add_attachment(filename, data)
- insertPage ➔ insert_page
- insertBlankPage ➔ insert_blank_page
- appendPagesFromReader ➔ append_pages_from_reader
- updatePageFormFieldValues ➔ update_page_form_field_values
- cloneReaderDocumentRoot ➔ clone_reader_document_root
- cloneDocumentFromReader ➔ clone_document_from_reader
- getReference ➔ get_reference
- getOutlineRoot ➔ get_outline_root
- getNamedDestRoot ➔ get_named_dest_root
- addBookmarkDestination ➔ add_bookmark_destination
- addBookmarkDict ➔ add_bookmark_dict
- addBookmark ➔ add_bookmark
- addNamedDestinationObject ➔ add_named_destination_object
- addNamedDestination ➔ add_named_destination
- removeLinks ➔ remove_links
- removeImages(ignoreByteStringObject) ➔ remove_images(ignore_byte_string_object)
- removeText(ignoreByteStringObject) ➔ remove_text(ignore_byte_string_object)
- addURI ➔ add_uri
- addLink ➔ add_link
- getPage(pageNumber) ➔ get_page(page_number)
- getPageLayout / setPageLayout / pageLayout ➔ page_layout attribute
- getPageMode / setPageMode / pageMode ➔ page_mode attribute
- _addObject ➔ _add_object
- _addPage ➔ _add_page
- _sweepIndirectReferences ➔ _sweep_indirect_references
PdfMerger class
- `__init__` parameter: strict=True ➔ strict=False (the PdfFileMerger still has the old default)
- addMetadata ➔ add_metadata
- addNamedDestination ➔ add_named_destination
- setPageLayout ➔ set_page_layout
- setPageMode ➔ set_page_mode
Page class:
- artBox / bleedBox/ cropBox/ mediaBox / trimBox ➔ artbox / bleedbox/ cropbox/ mediabox / trimbox
- getWidth, getHeight ➔ width / height
- getLowerLeft_x / getUpperLeft_x ➔ left
- getUpperRight_x / getLowerRight_x ➔ right
- getLowerLeft_y / getLowerRight_y ➔ bottom
- getUpperRight_y / getUpperLeft_y ➔ top
- getLowerLeft / setLowerLeft ➔ lower_left property
- upperRight ➔ upper_right
- mergePage ➔ merge_page
- rotateClockwise / rotateCounterClockwise ➔ rotate_clockwise
- _mergeResources ➔ _merge_resources
- _contentStreamRename ➔ _content_stream_rename
- _pushPopGS ➔ _push_pop_gs
- _addTransformationMatrix ➔ _add_transformation_matrix
- _mergePage ➔ _merge_page
XmpInformation class:
- getElement(..., aboutUri, ...) ➔ get_element(..., about_uri, ...)
- getNodesInNamespace(..., aboutUri, ...) ➔ get_nodes_in_namespace(..., aboutUri, ...)
- _getText ➔ _get_text
utils.py:
- matrixMultiply ➔ matrix_multiply
- RC4_encrypt is moved to the security module
Version 1.27.12, 2022-05-02
---------------------------
Bug Fixes (BUG):
- _rebuild_xref_table expects trailer to be a dict (#857)
Documentation (DOC):
- Security Policy
Full Changelog: https://github.com/py-pdf/PyPDF2/compare/1.27.11...1.27.12
Version 1.27.11, 2022-05-02
---------------------------
Bug Fixes (BUG):
- Incorrectly issued xref warning/exception (#855)
Full Changelog: https://github.com/py-pdf/PyPDF2/compare/1.27.10...1.27.11
Version 1.27.10, 2022-05-01
---------------------------
Robustness (ROB):
- Handle missing destinations in reader (#840)
- warn-only in readStringFromStream (#837)
- Fix corruption in startxref or xref table (#788 and #830)
Documentation (DOC):
- Project Governance (#799)
- History of PyPDF2
- PDF feature/version support (#816)
- More details on text parsing issues (#815)
Developer Experience (DEV):
- Add benchmark command to Makefile
- Ignore IronPython parts for code coverage (#826)
Maintenance (MAINT):
- Split pdf module (#836)
- Separated CCITTFax param parsing/decoding (#841)
- Update requirements files
Testing (TST):
- Use external repository for larger/more PDFs for testing (#820)
- Swap incorrect test names (#838)
- Add test for PdfFileReader and page properties (#835)
- Add tests for PyPDF2.generic (#831)
- Add tests for utils, form fields, PageRange (#827)
- Add test for ASCII85Decode (#825)
- Add test for FlateDecode (#823)
- Add test for filters.ASCIIHexDecode (#822)
Code Style (STY):
- Apply pre-commit (black, isort) + use snake_case variables (#832)
- Remove debug code (#828)
- Documentation, Variable names (#839)
Full Changelog: https://github.com/py-pdf/PyPDF2/compare/1.27.9...1.27.10
Version 1.27.9, 2022-04-24
--------------------------
A change I would like to highlight is the performance improvement for
large PDF files (#808) 🎉
New Features (ENH):
- Add papersizes (#800)
- Allow setting permission flags when encrypting (#803)
- Allow setting form field flags (#802)
Bug Fixes (BUG):
- TypeError in xmp._converter_date (#813)
- Improve spacing for text extraction (#806)
- Fix PDFDocEncoding Character Set (#809)
Robustness (ROB):
- Use null ID when encrypted but no ID given (#812)
- Handle recursion error (#804)
Documentation (DOC):
- CMaps (#811)
- The PDF Format + commit prefixes (#810)
- Add compression example (#792)
Developer Experience (DEV):
- Add Benchmark for Performance Testing (#781)
Maintenance (MAINT):
- Validate PDF magic byte in strict mode (#814)
- Make PdfFileMerger.addBookmark() behave life PdfFileWriters\' (#339)
- Quadratic runtime while parsing reduced to linear (#808)
Testing (TST):
- Newlines in text extraction (#807)
Full Changelog: https://github.com/py-pdf/PyPDF2/compare/1.27.8...1.27.9
Version 1.27.8, 2022-04-21
--------------------------
Bug Fixes (BUG):
- Use 1MB as offset for readNextEndLine (#321)
- 'PdfFileWriter' object has no attribute 'stream' (#787)
Robustness (ROB):
- Invalid float object; use 0 as fallback (#782)
Documentation (DOC):
- Robustness (#785)
Full Changelog: https://github.com/py-pdf/PyPDF2/compare/1.27.7...1.27.8
Version 1.27.7, 2022-04-19
--------------------------
Bug Fixes (BUG):
- Import exceptions from PyPDF2.errors in PyPDF2.utils (#780)
Code Style (STY):
- Naming in 'make_changelog.py'
Version 1.27.6, 2022-04-18
--------------------------
Deprecations (DEP):
- Remove support for Python 2.6 and older (#776)
New Features (ENH):
- Extract document permissions (#320)
Bug Fixes (BUG):
- Clip by trimBox when merging pages, which would otherwise be ignored (#240)
- Add overwriteWarnings parameter PdfFileMerger (#243)
- IndexError for getPage() of decryped file (#359)
- Handle cases where decodeParms is an ArrayObject (#405)
- Updated PDF fields don't show up when page is written (#412)
- Set Linked Form Value (#414)
- Fix zlib -5 error for corrupt files (#603)
- Fix reading more than last1K for EOF (#642)
- Acciental import
Robustness (ROB):
- Allow extra whitespace before "obj" in readObjectHeader (#567)
Documentation (DOC):
- Link to pdftoc in Sample_Code (#628)
- Working with annotations (#764)
- Structure history
Developer Experience (DEV):
- Add issue templates (#765)
- Add tool to generate changelog
Maintenance (MAINT):
- Use grouped constants instead of string literals (#745)
- Add error module (#768)
- Use decorators for @staticmethod (#775)
- Split long functions (#777)
Testing (TST):
- Run tests in CI once with -OO Flags (#770)
- Filling out forms (#771)
- Add tests for Writer (#772)
- Error cases (#773)
- Check Error messages (#769)
- Regression test for issue #88
- Regression test for issue #327
Code Style (STY):
- Make variable naming more consistent in tests
All changes: https://github.com/py-pdf/PyPDF2/compare/1.27.5...1.27.6
Version 1.27.5, 2022-04-15
--------------------------
Security (SEC):
- ContentStream_readInlineImage had potential infinite loop (#740)
Bug fixes (BUG):
- Fix merging encrypted files (#757)
- CCITTFaxDecode decodeParms can be an ArrayObject (#756)
Robustness improvements (ROBUST):
- title sometimes None (#744)
Documentation (DOC):
- Adjust short description of the package
Tests and Test setup (TST):
- Rewrite JS tests from unittest to pytest (#746)
- Increase Test coverage, mainly with filters (#756)
- Add test for inline images (#758)
Developer Experience Improvements (DEV):
- Remove unused Travis-CI configuration (#747)
- Show code coverage (#754, #755)
- Add mutmut (#760)
Miscellaneous:
- STY: Closing file handles, explicit exports, ... (#743)
All changes: https://github.com/py-pdf/PyPDF2/compare/1.27.4...1.27.5
Version 1.27.4, 2022-04-12
--------------------------
Bug fixes (BUG):
- Guard formatting of __init__.__doc__ string (#738)
Packaging (PKG):
- Add more precise license field to setup (#733)
Testing (TST):
- Add test for issue #297
Miscellaneous:
- DOC: Miscallenious ➔ Miscellaneous (Typo)
- TST: Fix CI triggering (master ➔ main) (#739)
- STY: Fix various style issues (#742)
All changes: https://github.com/py-pdf/PyPDF2/compare/1.27.3...1.27.4
Version 1.27.3, 2022-04-10
--------------------------
- PKG: Make Tests not a subpackage (#728)
- BUG: Fix ASCII85Decode.decode assertion (#729)
- BUG: Error in Chinese character encoding (#463)
- BUG: Code duplication in Scripts/2-up.py
- ROBUST: Guard 'obj.writeToStream' with 'if obj is not None'
- ROBUST: Ignore a /Prev entry with the value 0 in the trailer
- MAINT: Remove Sample_Code (#726)
- TST: Close file handle in test_writer (#722)
- TST: Fix test_get_images (#730)
- DEV: Make tox use pytest and add more Python versions (#721)
- DOC: Many (#720, #723-725, #469)
All changes: https://github.com/py-pdf/PyPDF2/compare/1.27.2...1.27.3
Version 1.27.2, 2022-04-09
--------------------------
- Add Scripts (including `pdfcat`), Resources, Tests, and Sample_Code back to
PyPDF2. It was removed by accident in 1.27.0, but might get removed with 2.0.0
See https://github.com/py-pdf/PyPDF2/discussions/718 for discussion
All changes: https://github.com/py-pdf/PyPDF2/compare/1.27.1...1.27.2
Version 1.27.1, 2022-04-08
--------------------------
- Fixed project links on PyPI page after migration from mstamy2
to MartinThoma to the py-pdf organization on GitHub
- Documentation is now at https://pypdf2.readthedocs.io/en/latest/
All changes: https://github.com/py-pdf/PyPDF2/compare/1.27.0...1.27.1
Version 1.27.0, 2022-04-07
--------------------------
Features:
- Add alpha channel support for png files in Script (#614)
Bug fixes (BUG):
- Fix formatWarning for filename without slash (#612)
- Add whitespace between words for extractText() (#569, #334)
- "invalid escape sequence" SyntaxError (#522)
- Avoid error when printing warning in pythonw (#486)
- Stream operations can be List or Dict (#665)
Documentation (DOC):
- Added Scripts/pdf-image-extractor.py
- Documentation improvements (#550, #538, #324, #426, #394)
Tests and Test setup (TST):
- Add Github Action which automatically run unit tests via pytest and
static code analysis with Flake8 (#660)
- Add several unit tests (#661, #663)
- Add .coveragerc to create coverage reports
Developer Experience Improvements (DEV):
- Pre commit: Developers can now `pre-commit install` to avoid tiny issues
like trailing whitespaces
Miscellaneous:
- Add the LICENSE file to the distributed packages (#288)
- Use setuptools instead of distutils (#599)
- Improvements for the PyPI page (#644)
- Python 3 changes (#504, #366)
You can see the full changelog at: https://github.com/py-pdf/PyPDF2/compare/1.26.0...1.27.0
Version 1.26.0, 2016-05-18
--------------------------
- NOTE: Active maintenance on PyPDF2 is resuming after a hiatus
- Fixed a bug where image resources where incorrectly
overwritten when merging pages
- Added dictionary for JavaScript actions to the root (louib)
- Added unit tests for the JS functionality (louib)
- Add more Python 3 compatibility when reading inline images (im2703
and (VyacheslavHashov)
- Return NullObject instead of raising error when failing to resolve
object (ctate)
- Don't output warning for non-zeroed xref table when strict=False
(BenRussert)
- Remove extraneous zeroes from output formatting (speedplane)
- Fix bug where reading an inline image would cut off prematurely
in certain cases (speedplane)
Version 1.25.1, 2015-07-20
--------------------------
- Fix bug when parsing inline images. Occurred when merging
certain pages with inline images
- Fixed type error when creating outlines by utilizing the
isString() test
Version 1.25, 2015-07-07
------------------------
BUGFIXES:
- Added Python 3 algorithm for ASCII85Decode. Fixes issue when
reading reportlab-generated files with Py 3 (jerickbixly)
- Recognize more escape sequence which would otherwise throw an
exception (manuelzs, robertsoakes)
- Fixed overflow error in generic.py. Occurred
when reading a too-large int in Python 2 (by Raja Jamwal)
- Allow access to files which were encrypted with an empty
password. Previously threw a "File has not been decrypted"
exception (Elena Williams)
- Do not attempt to decode an empty data stream. Previously
would cause an error in decode algorithms (vladir)
- Fixed some type issues specific to Py 2 or Py 3
- Fix issue when stream data begins with whitespace (soloma83)
- Recognize abbreviated filter names (AlmightyOatmeal and
Matthew Weiss)
- Copy decryption key from PdfFileReader to PdfFileMerger.
Allows usage of PdfFileMerger with encrypted files (twolfson)
- Fixed bug which occurred when a NameObject is present at end
of a file stream. Threw a "Stream has ended unexpectedly"
exception (speedplane)
FEATURES:
- Initial work on a test suite; to be expanded in future.
Tests and Resources directory added, README updated (robertsoakes)
- Added document cloning methods to PdfFileWriter:
appendPagesFromReader, cloneReaderDocumentRoot, and
cloneDocumentFromReader. See official documentation (robertsoakes)
- Added method for writing to form fields: updatePageFormFieldValues.
This will be enhanced in the future. See official documentation
(robertsoakes)
- New addAttachment method. See documentation. Support for adding
and extracting embedded files to be enhanced in the future
(moshekaplan)
- Added methods to get page number of given PageObject or
Destination: getPageNumber and getDestinationPageNumber.
See documentation (mozbugbox)
OTHER ENHANCEMENTS:
- Enhanced type handling (Brent Amrhein)
- Enhanced exception handling in NameObject (sbywater)
- Enhanced extractText method output (peircej)
- Better exception handling
- Enhanced regex usage in NameObject class (speedplane)
Version 1.24, 2014-12-31
------------------------
- Bugfixes for reading files in Python 3 (by Anthony Tuininga and
pqqp)
- Appropriate errors are now raised instead of infinite loops (by
naure and Cyrus Vafadari)
- Bugfix for parsing number tokens with leading spaces (by Maxim
Kamenkov)
- Don't crash on bad /Outlines reference (by eshellman)
- Conform tabs/spaces and blank lines to PEP 8 standards
- Utilize the readUntilRegex method when reading Number Objects
(by Brendan Jurd)
- More bugfixes for Python 3 and clearer exception handling
- Fixed encoding issue in merger (with eshellman)
- Created separate folder for scripts
Version 1.23, 2014-08-11
------------------------
- Documentation now available at http://pythonhosted.org//PyPDF2
- Bugfix in pagerange.py for when __init__.__doc__ has no value (by
Vladir Cruz)
- Fix typos in OutlinesObject().add() (by shilluc)
- Re-added a missing return statement in a utils.py method
- Corrected viewing mode names (by Jason Scheirer)
- New PdfFileWriter method: addJS() (by vfigueiro)
- New bookmark features: color, boldness, italics, and page fit
(by Joshua Arnott)
- New PdfFileReader method: getFields(). Used to extract field
information from PDFs with interactive forms. See documentation
for details
- Converted README file to markdown format (by Stephen Bussard)
- Several improvements to overall performance and efficiency
(by mozbugbox)
- Fixed a bug where geospatial information was not scaling along with
its page
- Fixed a type issue and a Python 3 issue in the decryption algorithms
(with Francisco Vieira and koba-ninkigumi)
- Fixed a bug causing an infinite loop in the ASCII 85 decoding
algorithm (by madmaardigan)
- Annotations (links, comment windows, etc.) are now preserved when
pages are merged together
- Used the Destination class in addLink() and addBookmark() so that
the page fit option could be properly customized
Version 1.22, 2014-05-29
------------------------
- Added .DS_Store to .gitignore (for Mac users) (by Steve Witham)
- Removed __init__() implementation in NameObject (by Steve Witham)
- Fixed bug (inf. loop) when merging pages in Python 3 (by commx)
- Corrected error when calculating height in scaleTo()
- Removed unnecessary code from DictionaryObject (by Georges Dubus)
- Fixed bug where an exception was thrown upon reading a NULL string
(by speedplane)
- Allow string literals (non-unicode strings in Python 2) to be passed
to PdfFileReader
- Allow ConvertFunctionsToVirtualList to be indexed with slices and
longs (in Python 2) (by Matt Gilson)
- Major improvements and bugfixes to addLink() method (see documentation
in source code) (by Henry Keiter)
- General code clean-up and improvements (with Steve Witham and Henry Keiter)
- Fixed bug that caused crash when comments are present at end of
dictionary
Version 1.21, 2014-04-21
------------------------
- Fix for when /Type isn't present in the Pages dictionary (by Rob1080)
- More tolerance for extra whitespace in Indirect Objects
- Improved Exception handling
- Fixed error in getHeight() method (by Simon Kaempflein)
- implement use of utils.string_type to resolve Py2-3 compatibility issues
- Prevent exception for multiple definitions in a dictionary (with carlosfunk)
(only when strict = False)
- Fixed errors when parsing a slice using pdfcat on command line (by
Steve Witham)
- Tolerance for EOF markers within 1024 bytes of the actual end of the
file (with David Wolever)
- Added overwriteWarnings parameter to PdfFileReader constructor, if False
PyPDF2 will NOT overwrite methods from Python's warnings.py module with
a custom implementation.
- Fix NumberObject and NameObject constructors for compatibility with PyPy
(Rüdiger Jungbeck, Xavier Dupré, shezadkhan137, Steven Witham)
- Utilize utils.Str in pdf.py and pagerange.py to resolve type issues (by
egbutter)
- Improvements in implementing StringIO for Python 2 and BytesIO for
Python 3 (by Xavier Dupré)
- Added /x00 to Whitespaces, defined utils.WHITESPACES to clarify code (by
Maxim Kamenkov)
- Bugfix for merging 3 or more resources with the same name (by lucky-user)
- Improvements to Xref parsing algorithm (by speedplane)
Version 1.20, 2014-01-27
------------------------
- Official Python 3+ support (with contributions from TWAC and cgammans)
Support for Python versions 2.6 and 2.7 will be maintained
- Command line concatenation (see pdfcat in sample code) (by Steve Witham)
- New FAQ; link included in README
- Allow more (although unnecessary) escape sequences
- Prevent exception when reading a null object in decoding parameters
- Corrected error in reading destination types (added a slash since they
are name objects)
- Corrected TypeError in scaleTo() method
- addBookmark() method in PdfFileMerger now returns bookmark (so nested
bookmarks can be created)
- Additions to Sample Code and Sample PDFs
- changes to allow 2up script to work (see sample code) (by Dylan McNamee)
- changes to metadata encoding (by Chris Hiestand)
- New methods for links: addLink() (by Enrico Lambertini) and removeLinks()
- Bugfix to handle nested bookmarks correctly (by Jamie Lentin)
- New methods removeImages() and removeText() available for PdfFileWriter
(by Tien Haï)
- Exception handling for illegal characters in Name Objects
Version 1.19, 2013-10-08
------------------------
BUGFIXES:
- Removed pop in sweepIndirectReferences to prevent infinite loop
(provided by ian-su-sirca)
- Fixed bug caused by whitespace when parsing PDFs generated by AutoCad
- Fixed a bug caused by reading a 'null' ASCII value in a dictionary
object (primarily in PDFs generated by AutoCad).
FEATURES:
- Added new folders for PyPDF2 sample code and example PDFs; see README
for each folder
- Added a method for debugging purposes to show current location while
parsing
- Ability to create custom metadata (by jamma313)
- Ability to access and customize document layout and view mode
(by Joshua Arnott)
OTHER:
- Added and corrected some documentation
- Added some more warnings and exception messages
- Removed old test/debugging code
UPCOMING:
- More bugfixes (We have received many problematic PDFs via email, we
will work with them)
- Documentation - It's time for PyPDF2 to get its own documentation
since it has grown much since the original pyPdf
- A FAQ to answer common questions
Version 1.18, 2013-08-19
------------------------
- Fixed a bug where older verions of objects were incorrectly added to the
cache, resulting in outdated or missing pages, images, and other objects
(from speedplane)
- Fixed a bug in parsing the xref table where new xref values were
overwritten; also cleaned up code (from speedplane)
- New method mergeRotatedAroundPointPage which merges a page while rotating
it around a point (from speedplane)
- Updated Destination syntax to respect PDF 1.6 specifications (from
jamma313)
- Prevented infinite loop when a PdfFileReader object was instantiated
with an empty file (from Jerome Nexedi)
Other Changes:
- Downloads now available via PyPI
https://pypi.python.org/pypi?:action=display&name=PyPDF2