Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MAINT: Use new PEP8 compliant names #884

Merged
merged 15 commits into from May 22, 2022
Merged

Conversation

MartinThoma
Copy link
Member

No description provided.

@MartinThoma MartinThoma force-pushed the merge-deprecations branch 3 times, most recently from d8e35aa to 85aca8f Compare May 22, 2022 14:07
@codecov
Copy link

codecov bot commented May 22, 2022

Codecov Report

Merging #884 (e36def6) into 2.0.0-dev (adee9f0) will decrease coverage by 2.88%.
The diff coverage is 78.14%.

@@              Coverage Diff              @@
##           2.0.0-dev     #884      +/-   ##
=============================================
- Coverage      82.84%   79.96%   -2.89%     
=============================================
  Files             16       16              
  Lines           3790     4187     +397     
  Branches         808      813       +5     
=============================================
+ Hits            3140     3348     +208     
- Misses           471      664     +193     
+ Partials         179      175       -4     
Impacted Files Coverage Δ
PyPDF2/xmp.py 51.63% <66.66%> (ø)
PyPDF2/_writer.py 78.90% <68.32%> (-9.36%) ⬇️
PyPDF2/_merger.py 65.51% <72.41%> (-2.39%) ⬇️
PyPDF2/_page.py 80.19% <79.36%> (-4.50%) ⬇️
PyPDF2/_reader.py 79.54% <82.50%> (-2.39%) ⬇️
PyPDF2/generic.py 84.24% <82.54%> (-2.04%) ⬇️
PyPDF2/filters.py 75.00% <85.71%> (ø)
PyPDF2/__init__.py 100.00% <100.00%> (ø)
PyPDF2/_security.py 94.66% <100.00%> (+1.33%) ⬆️
PyPDF2/_utils.py 90.99% <100.00%> (ø)
... and 2 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 adee9f0...e36def6. Read the comment docs.

@MartinThoma MartinThoma merged commit e38b23d into 2.0.0-dev May 22, 2022
@MartinThoma MartinThoma deleted the merge-deprecations branch May 22, 2022 19:02
MartinThoma added a commit that referenced this pull request Jun 1, 2022
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](#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: 1.28.4...2.0.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants