DEV: Remove ignore Ruff rule RET503 #3209

j-t-1 · 2025-03-21T12:37:31Z

RET503: Missing explicit "return" at the end of function able to return non-"None" value.

codecov · 2025-03-21T12:45:21Z

Codecov Report

❌ Patch coverage is 66.66667% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 97.08%. Comparing base (56cf557) to head (73adce0).

Files with missing lines	Patch %	Lines
pypdf/_writer.py	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3209      +/-   ##
==========================================
- Coverage   97.09%   97.08%   -0.01%     
==========================================
  Files          56       56              
  Lines        9684     9687       +3     
  Branches     1754     1754              
==========================================
+ Hits         9403     9405       +2     
- Misses        168      169       +1     
  Partials      113      113

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

pypdf/_page.py

pypdf/_writer.py

RET503: Missing explicit "return" at the end of function able to return non-"None" value.

j-t-1 · 2025-07-18T07:45:30Z

@stefan6419846 could you fix the two Ruff errors (2 fixable with the --fix option)? I do not have Ruff installed.

stefan6419846 · 2025-07-18T08:05:51Z

could you fix the two Ruff errors

Just use return None instead of return in these cases if it is a correct detection (as indicated in the help for the violation). If the detection is wrong, we would have to check manually anyway.

Updated test cases for find_outline_item method.

Remove redundant return statement in get_next method.

j-t-1 · 2025-10-29T12:08:35Z

@stefan6419846 the return None is needed so we can remove RET503. Can you think of a way to reach this line, as otherwise code coverage is reduced.

stefan6419846 · 2025-10-29T13:31:28Z

I guess root = DictionaryObject({NameObject('/Next'): None}) could work, but AFAIK this branch should not be reachable with real PDF files as None is no PDF object. See #3209 (comment) as well.

j-t-1 · 2025-10-29T14:21:23Z

I have marked it as pragma: no cover, as agree with you, I think is unreachable with real PDFs. Outlines are conceptually not difficult, and maybe a refactor of them may be useful.

pypdf/_writer.py

tests/test_merger.py

stefan6419846 · 2025-11-05T12:36:13Z

pypdf/_writer.py


            clean(content, images, forms, text_filters)
            page.replace_contents(content)
+        return [], []  # type: ignore


Why do we need the ignore here?

stefan6419846 · 2025-11-05T12:36:49Z

pypdf/_writer.py

                o = cast(TreeObject, o["/Next"])
            else:
                return None
+        raise PyPdfError("This line is theoretically unreachable.")


We still need the pragma comment here.

Without, mypy gives this error:

pypdf/_writer.py:2235: error: No return value expected [return-value]

I think you commented on the wrong comment?

Apart from this: Please prefer ignoring specify mypy issues instead of all.

j-t-1 added 4 commits March 21, 2025 12:18

DEV: Remove ignore Ruff rule RET503

8fa9c9b

RET503: Missing explicit "return" at the end of function able to return non-"None" value.

DEV: Remove ignore Ruff rule RET503

96c92b9

RET503: Missing explicit "return" at the end of function able to return non-"None" value.

DEV: Remove ignore Ruff rule RET503

552cc82

RET503: Missing explicit "return" at the end of function able to return non-"None" value.

DEV: Remove ignore Ruff rule RET503

e1b86e3

RET503: Missing explicit "return" at the end of function able to return non-"None" value.

stefan6419846 reviewed Mar 21, 2025

View reviewed changes

pypdf/_page.py Outdated Show resolved Hide resolved

stefan6419846 reviewed Mar 21, 2025

View reviewed changes

pypdf/_writer.py Outdated Show resolved Hide resolved

stefan6419846 reviewed Mar 21, 2025

View reviewed changes

pypdf/_writer.py Outdated Show resolved Hide resolved

j-t-1 added 5 commits March 22, 2025 15:11

DEV: Remove ignore Ruff rule RET503

0696f2a

RET503: Missing explicit "return" at the end of function able to return non-"None" value.

DEV: Remove ignore Ruff rule RET503

95568ef

RET503: Missing explicit "return" at the end of function able to return non-"None" value.

DEV: Remove ignore Ruff rule RET503

f5c84e5

RET503: Missing explicit "return" at the end of function able to return non-"None" value.

DEV: Remove ignore Ruff rule RET503

d1d8ed6

RET503: Missing explicit "return" at the end of function able to return non-"None" value.

DEV: Remove ignore Ruff rule RET503

f672d30

RET503: Missing explicit "return" at the end of function able to return non-"None" value.

stefan6419846 added the needs-test A test should be added before this PR is merged. label Mar 24, 2025

stefan6419846 and others added 4 commits March 24, 2025 17:17

avoid noqa comment

6c2a441

Merge branch 'main' into RET503

a7f49ca

Fix errors

14c7d6b

Fix another error

8c49df4

j-t-1 added 10 commits July 18, 2025 08:14

Fix RET502 erros

fef0f08

Comment and fix error

dd7dd06

Code coverage

3c86e28

Merge branch 'main' into RET503

f05e3f7

Merge branch 'py-pdf:main' into RET503

c7955f0

Merge branch 'main' into RET503

7918589

Modify test cases in test_merger.py

9262797

Updated test cases for find_outline_item method.

Add test case for finding outline item with None

8bfe759

Merge branch 'main' into RET503

510b901

Remove comment

4a49005

j-t-1 added 4 commits October 29, 2025 10:19

Enhance test coverage for find_outline_item

d2d5d48

Remove test

b0867da

Remove unnecessary return None from get_next

5501e9b

Remove redundant return statement in get_next method.

Add return None

97c2524

Add pragma: no cover

26920b5

stefan6419846 reviewed Oct 29, 2025

View reviewed changes

pypdf/_writer.py Outdated Show resolved Hide resolved

stefan6419846 reviewed Oct 29, 2025

View reviewed changes

tests/test_merger.py Outdated Show resolved Hide resolved

stefan6419846 reviewed Oct 29, 2025

View reviewed changes

tests/test_merger.py Outdated Show resolved Hide resolved

j-t-1 and others added 5 commits October 29, 2025 16:26

Add comment to explain pragma

0050de8

Remove tests

d5ebefc

Replace unreachable return statement with exception

dce8ca9

Remove unused noqa directive

525971b

Merge branch 'main' into RET503

6003e03

stefan6419846 removed the needs-test A test should be added before this PR is merged. label Nov 5, 2025

stefan6419846 reviewed Nov 5, 2025

View reviewed changes

Remove type ignore

73adce0

DEV: Remove ignore Ruff rule RET503 #3209

Are you sure you want to change the base?

DEV: Remove ignore Ruff rule RET503 #3209

Conversation

j-t-1 commented Mar 21, 2025

Uh oh!

codecov bot commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

j-t-1 commented Jul 18, 2025

Uh oh!

stefan6419846 commented Jul 18, 2025

Uh oh!

j-t-1 commented Oct 29, 2025

Uh oh!

stefan6419846 commented Oct 29, 2025

Uh oh!

j-t-1 commented Oct 29, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stefan6419846 Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

stefan6419846 Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

j-t-1 Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

stefan6419846 Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

stefan6419846 Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Mar 21, 2025 •

edited

Loading