Skip to content

fix(mypy): type annotations for cipher algorithms #4306

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

Merged
merged 4 commits into from
Apr 4, 2021

Conversation

dhruvmanila
Copy link
Member

Issue: #4052

mypy --ignore-missing-imports --strict ciphers/
Success: no issues found in 39 source files

Describe your change:

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

@ghost ghost added awaiting reviews This PR is ready to be reviewed enhancement This PR modified some existing files labels Apr 3, 2021
@dhruvmanila dhruvmanila requested a review from cclauss April 3, 2021 10:43
@cclauss
Copy link
Member

cclauss commented Apr 3, 2021

Don’t we want the GitHub Action updated to prove that the directory is fixed?

Should we use mypy —strict in our tests?

@ghost ghost added tests are failing Do not merge until tests pass and removed tests are failing Do not merge until tests pass labels Apr 4, 2021
@dhruvmanila
Copy link
Member Author

Don’t we want the GitHub Action updated to prove that the directory is fixed?

Done

Should we use mypy —strict in our tests?

I prefer to be strict in type checking but we should take it gradually. The --strict flag include the following checks:

    --strict                  Strict mode; enables the following flags: --warn-
                              unused-configs, --disallow-any-generics,
                              --disallow-subclassing-any, --disallow-untyped-
                              calls, --disallow-untyped-defs, --disallow-
                              incomplete-defs, --check-untyped-defs, --disallow-
                              untyped-decorators, --no-implicit-optional,
                              --warn-redundant-casts, --warn-unused-ignores,
                              --warn-return-any, --no-implicit-reexport,
                              --strict-equality

In short, it won't allow any variable, function, decorators or class to be untyped. Most of the options should be configured via mypy.ini file which I will add in the upcoming PR. We can then gradually add options to make mypy stricter.

@ghost ghost added the tests are failing Do not merge until tests pass label Apr 4, 2021
@ghost ghost removed the tests are failing Do not merge until tests pass label Apr 4, 2021
Copy link
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

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

Awesome work! Thanks for doing this.

@cclauss cclauss merged commit 6089536 into TheAlgorithms:master Apr 4, 2021
@ghost ghost removed the awaiting reviews This PR is ready to be reviewed label Apr 4, 2021
@dhruvmanila dhruvmanila deleted the fix-cipher-mypy branch April 4, 2021 12:37
Panquesito7 pushed a commit to Panquesito7/Python that referenced this pull request May 13, 2021
* fix(mypy): type annotations for cipher algorithms

* Update mypy workflow to include cipher directory

* fix: mypy errors in hill_cipher.py

* fix build errors
shermanhui pushed a commit to shermanhui/Python that referenced this pull request Oct 22, 2021
* fix(mypy): type annotations for cipher algorithms

* Update mypy workflow to include cipher directory

* fix: mypy errors in hill_cipher.py

* fix build errors
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This PR modified some existing files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants