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

chore: apply flake8 builtin rules #248

Merged
merged 10 commits into from
Jul 30, 2024
Merged

Conversation

tdstein
Copy link
Collaborator

@tdstein tdstein commented Jul 26, 2024

Adds formatting rule and fixes variable names that shadow Python builtins.

Copy link

github-actions bot commented Jul 26, 2024

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
1229 1162 95% 0% 🟢

New Files

No new covered files...

Modified Files

File Coverage Status
src/posit/connect/bundles.py 100% 🟢
src/posit/connect/cursors.py 100% 🟢
src/posit/connect/permissions.py 100% 🟢
src/posit/connect/tasks.py 100% 🟢
src/posit/connect/users.py 100% 🟢
TOTAL 100% 🟢

updated for commit: 00444ad by action🐍

@tdstein tdstein force-pushed the tdstein/add-import-organization-to-fmt branch from ceb3331 to 5acdd24 Compare July 29, 2024 14:11
Base automatically changed from tdstein/add-import-organization-to-fmt to main July 29, 2024 14:19
@tdstein tdstein force-pushed the tdstein/ruff-flake8-builtins branch from ddbae38 to 571177b Compare July 29, 2024 15:56
@tdstein tdstein requested a review from toph-allen July 29, 2024 15:58
pyproject.toml Outdated Show resolved Hide resolved
def create(self, input: io.BufferedReader | bytes | str) -> Bundle:
def create(self, archive: io.BufferedReader | bytes | str) -> Bundle:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this to avoid using input as an argument?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Correct. Since input is a builtin function.

Copy link
Collaborator

Choose a reason for hiding this comment

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

We might not need to worry cause this is internal enough or no one is yet using it, but does this change have user-facing implications?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, it does if anyone is using kwargs when calling this method. Since it's early and we are pre-1.0.0, I am ok releasing this under 0.4.0 along with documentation of the breaking changes.

Copy link
Collaborator

Choose a reason for hiding this comment

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

And for my own edification: documentation of those breaking changes isn't in this PR yeah? That'll be a follow on?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, I think release notes are the correct place to write them.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I started a migration guide in the changelog: https://github.com/posit-dev/posit-sdk-py/releases

@tdstein tdstein merged commit ddb1bd6 into main Jul 30, 2024
28 checks passed
@tdstein tdstein deleted the tdstein/ruff-flake8-builtins branch July 30, 2024 13:32
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

3 participants