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

Supplement Codacy with DeepSource #2454

Merged
merged 30 commits into from
May 27, 2021
Merged

Conversation

Bibo-Joshi
Copy link
Member

@Bibo-Joshi Bibo-Joshi commented Apr 6, 2021

Before merging:

  • Revert dd46c26
  • Change the DeepSource setting back to »Granular (recommended): Issues would be reported only for lines that have been added or modified across all the files affected.«
  • Check the settings tab and see if we can delete some of the ignore rules. I made a bunch of false-positive reports, so maybe some of them are already resolved.

Some notes:

  • DS complained about a bunch of methods not having docstrings. For some, which are actually just for internal usage and should not be part of the public API, i prefixed them with an underscore. This might break code if people rely on undocumented internal methods, but IMHO that's their fault.
  • removed the helper class Days in JobQueue, as we don't really use it.
  • as of 2021-04-15 Codacy complains about a line that it already complained about before - I just added a comment here …

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hey! Looks like you edited README.rst or README_RAW.rst. I'm just a friendly reminder to apply relevant changes to both of those files :)

@Bibo-Joshi
Copy link
Member Author

DeepSource indeed found a number of things that can be improved. Large parts of those are "just" documentation improvements according to the google style guide, but since actually "officially" adhere to those (meaning: we say so in the contrib guide), I think this is a good opportunity to actually do so. I'll try & make the corresponding changes in the near future.

@Bibo-Joshi Bibo-Joshi marked this pull request as draft April 8, 2021 19:20
@Bibo-Joshi Bibo-Joshi changed the title Replace Codacy with DeepSource WIP: Replace/Supplement Codacy with DeepSource Apr 8, 2021
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hey there. Relax, I am just a little warning for the maintainers to release directly after merging your PR, otherwise we have broken examples and people might get confused :)

@ghost
Copy link

ghost commented Apr 9, 2021

DeepCode failed to analyze this pull request

Something went wrong despite trying multiple times, sorry about that.
Please comment this pull request with "Retry DeepCode" to manually retry, or contact us so that a human can look into the issue.

Bibo-Joshi and others added 7 commits April 9, 2021 22:45
Resolved issues in the following files via DeepSource Autofix:
1. tests/conftest.py
2. tests/test_bot.py
3. tests/test_commandhandler.py
4. tests/test_conversationhandler.py
5. tests/test_dispatcher.py
6. tests/test_filters.py
7. tests/test_inputmedia.py
8. tests/test_messagehandler.py
9. tests/test_official.py
10. tests/test_persistence.py
@Bibo-Joshi Bibo-Joshi mentioned this pull request Apr 16, 2021
# Conflicts:
#	telegram/bot.py
#	telegram/ext/conversationhandler.py
#	telegram/ext/filters.py
#	telegram/utils/webhookhandler.py
@Bibo-Joshi Bibo-Joshi marked this pull request as ready for review May 25, 2021 14:36
@Bibo-Joshi Bibo-Joshi changed the title WIP: Replace/Supplement Codacy with DeepSource Supplement Codacy with DeepSource May 25, 2021
Copy link
Member

@starry-shivam starry-shivam left a comment

Choose a reason for hiding this comment

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

Changes looks good to me, great job for adding all those missing docs 👍

Copy link
Member

@harshil21 harshil21 left a comment

Choose a reason for hiding this comment

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

Good changes, specially the docs for TelegramError and TelegramObject, we needed that! The tests shall finally succeed

telegram/__main__.py Show resolved Hide resolved
telegram/base.py Outdated Show resolved Hide resolved
telegram/ext/callbackcontext.py Outdated Show resolved Hide resolved
telegram/ext/callbackcontext.py Outdated Show resolved Hide resolved
telegram/ext/callbackcontext.py Outdated Show resolved Hide resolved
telegram/ext/defaults.py Outdated Show resolved Hide resolved
telegram/ext/filters.py Outdated Show resolved Hide resolved
telegram/ext/updater.py Outdated Show resolved Hide resolved
telegram/files/file.py Show resolved Hide resolved
telegram/utils/deprecate.py Outdated Show resolved Hide resolved
Copy link
Member

@Poolitzer Poolitzer left a comment

Choose a reason for hiding this comment

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

I like this PR, changes look good

@Bibo-Joshi Bibo-Joshi merged commit 8bf88c3 into master May 27, 2021
@Bibo-Joshi Bibo-Joshi deleted the repace-codacy-by-deepsource branch May 27, 2021 07:38
@Bibo-Joshi Bibo-Joshi mentioned this pull request May 27, 2021
@github-actions github-actions bot locked and limited conversation to collaborators May 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants