fastapi/fastapiPublic

NotificationsYou must be signed in to change notification settings
Fork8.7k
Star95.4k

♻️ Move duplicated code portion to a static method in the`APIKeyBase` super class#3142

Merged

tiangolo merged 8 commits intofastapi:masterfrom

ShahriyarR:apikey-duplicated-code-refactoring

Jan 30, 2025

Merged

♻️ Move duplicated code portion to a static method in the`APIKeyBase` super class#3142
tiangolo merged 8 commits intofastapi:masterfrom
ShahriyarR:apikey-duplicated-code-refactoring

Conversation

Copy link

Contributor

ShahriyarR commentedApr 29, 2021

The code block below was used 3 times:

        if not api_key:            if auto_error:                raise HTTPException(                    status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"                )            else:                return None        return api_key

I have moved this portion to thestaticmethod into the super class as it will be shared by inheritance to all 3 subclasses.

Moved duplicated code portion to the staticmethod in the super class

4a80d02

Copy link

Contributor

github-actionsbot commentedMay 1, 2021

📝 Docs preview for commit4a80d02 at:https://608d27c61facd91cca0729bf--fastapi.netlify.app

Passed mypy and black checks

3016d7a

cikay suggested changes

Feb 3, 2022

View reviewed changes

fastapi/security/api_key.py OutdatedShow resolvedHide resolved

Removed redundant else statement

8ce0578

Copy link

codecovbot commentedMay 13, 2022•
edited
Loading

Codecov Report

Merging#3142 (8ce0578) intomaster (ce0ec06) willnot change coverage.
The diff coverage is100.00%.

@@             Coverage Diff             @@##            master     #3142     +/-   ##===========================================  Coverage   100.00%   100.00%             ===========================================  Files          243       531    +288       Lines         7419     13623   +6204     ===========================================+ Hits          7419     13623   +6204

Impacted Files	Coverage Δ
fastapi/security/api_key.py	`100.00% <100.00%> (ø)`
fastapi/params.py	`100.00% <0.00%> (ø)`
fastapi/routing.py	`100.00% <0.00%> (ø)`
fastapi/encoders.py	`100.00% <0.00%> (ø)`
fastapi/responses.py	`100.00% <0.00%> (ø)`
fastapi/exceptions.py	`100.00% <0.00%> (ø)`
fastapi/concurrency.py	`100.00% <0.00%> (ø)`
fastapi/applications.py	`100.00% <0.00%> (ø)`
fastapi/openapi/docs.py	`100.00% <0.00%> (ø)`
tests/test_ws_router.py	`100.00% <0.00%> (ø)`
... and318 more

Continue to review full report at Codecov.

Legend -Click here to learn more
Δ = absolute <relative> (impact),ø = not affected,? = missing data
Powered byCodecov. Last update2252837...8ce0578. Read thecomment docs.

Copy link

Contributor

github-actionsbot commentedMay 13, 2022

📝 Docs preview for commit8ce0578 at:https://627e2fec25b877508f6395dc--fastapi.netlify.app

yezz123 approved these changes

May 13, 2022

View reviewed changes

BilalAlpaslan approved these changes

May 15, 2022

View reviewed changes

tiangolo added the refactor label

Oct 2, 2023

patrick91 approved these changes

Aug 9, 2024

View reviewed changes

Copy link

Contributor

patrick91 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Nice!

Merge branch 'master' into apikey-duplicated-code-refactoring

bea3df4

Copy link

Member

svlandeg commentedAug 14, 2024•
edited
Loading

@patrick91 : could you have another look at this PR, as it's not succeeding the linting step? 🙏

[Update]: I've gone in and fixed it 😉

svlandeg self-assigned this

Sep 3, 2024

svlandegand others added2 commits

September 3, 2024 14:59

Merge branch 'master' into apikey-duplicated-code-refactoring

8efb8fa

remove type indications that do not pass mypy check

f180e15

svlandeg changed the title~~Moved duplicated code portion to the staticmethod in the super class~~♻️ Move duplicated code portion to a static method in theAPIKeyBase super class

Sep 3, 2024