Skip to content

Conversation

Shay2Shay
Copy link

Describe your change:

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • 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 include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@algorithms-keeper algorithms-keeper bot added require descriptive names This PR needs descriptive function and/or variable names require tests Tests [doctest/unittest/pytest] are required require type hints https://docs.python.org/3/library/typing.html labels Oct 13, 2024
Copy link

@algorithms-keeper algorithms-keeper bot left a comment

Choose a reason for hiding this comment

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

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.

algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

  • @algorithms-keeper review to trigger the checks for only added pull request files
  • @algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

import random

class Utils:
def primeGenerator(bit_size):

Choose a reason for hiding this comment

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

As there is no test file in this pull request nor any test function or class in the file ciphers/paillier_cryptosystem.py, please provide doctest for the function primeGenerator

Please provide return type hint for the function: primeGenerator. If the function does not return a value, please provide the type hint as: def function() -> None:

Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: primeGenerator

Please provide type hint for the parameter: bit_size

high = (2**bit_size) - 1
return sympy.randprime(low, high)

def GCD(a, b):

Choose a reason for hiding this comment

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

As there is no test file in this pull request nor any test function or class in the file ciphers/paillier_cryptosystem.py, please provide doctest for the function GCD

Please provide return type hint for the function: GCD. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide descriptive name for the parameter: a

Please provide type hint for the parameter: a

Please provide descriptive name for the parameter: b

Please provide type hint for the parameter: b

a, b = b, a % b
return a

def LCM(a, b):

Choose a reason for hiding this comment

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

As there is no test file in this pull request nor any test function or class in the file ciphers/paillier_cryptosystem.py, please provide doctest for the function LCM

Please provide return type hint for the function: LCM. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide descriptive name for the parameter: a

Please provide type hint for the parameter: a

Please provide descriptive name for the parameter: b

Please provide type hint for the parameter: b

"""
return a * b // Utils.GCD(a, b)

def getInverse(a, n):

Choose a reason for hiding this comment

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

As there is no test file in this pull request nor any test function or class in the file ciphers/paillier_cryptosystem.py, please provide doctest for the function getInverse

Please provide return type hint for the function: getInverse. If the function does not return a value, please provide the type hint as: def function() -> None:

Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: getInverse

Please provide descriptive name for the parameter: a

Please provide type hint for the parameter: a

Please provide descriptive name for the parameter: n

Please provide type hint for the parameter: n

"""
return pow(a, -1, n)

def L(x, n):

Choose a reason for hiding this comment

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

Please provide descriptive name for the function: L

As there is no test file in this pull request nor any test function or class in the file ciphers/paillier_cryptosystem.py, please provide doctest for the function L

Please provide return type hint for the function: L. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide descriptive name for the parameter: x

Please provide type hint for the parameter: x

Please provide descriptive name for the parameter: n

Please provide type hint for the parameter: n

"""
return self.publicKey

def getPrivateKey(self):

Choose a reason for hiding this comment

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

As there is no test file in this pull request nor any test function or class in the file ciphers/paillier_cryptosystem.py, please provide doctest for the function getPrivateKey

Please provide return type hint for the function: getPrivateKey. If the function does not return a value, please provide the type hint as: def function() -> None:

Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: getPrivateKey

"""
return self.privateKey

def encrypt(pubKey : dict, msg : int):

Choose a reason for hiding this comment

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

As there is no test file in this pull request nor any test function or class in the file ciphers/paillier_cryptosystem.py, please provide doctest for the function encrypt

Please provide return type hint for the function: encrypt. If the function does not return a value, please provide the type hint as: def function() -> None:

Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: pubKey

b = pow(r, n, n2)
return (a*b) % n2

def decrypt(prvKey : dict, cypher : int):

Choose a reason for hiding this comment

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

As there is no test file in this pull request nor any test function or class in the file ciphers/paillier_cryptosystem.py, please provide doctest for the function decrypt

Please provide return type hint for the function: decrypt. If the function does not return a value, please provide the type hint as: def function() -> None:

Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: prvKey

msg = (t * mu) % n # (lambda * message) * mu == (lambda * message) * (lambda^-1) == msg (mod n)
return msg

def homomorphicADD(pubKey : dict, cypher1 : int, cypher2 : int):

Choose a reason for hiding this comment

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

As there is no test file in this pull request nor any test function or class in the file ciphers/paillier_cryptosystem.py, please provide doctest for the function homomorphicADD

Please provide return type hint for the function: homomorphicADD. If the function does not return a value, please provide the type hint as: def function() -> None:

Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: homomorphicADD

Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: pubKey

n2 = pubKey['n2']
return (cypher1*cypher2) % n2

def homomorphicMUL(pubKey : dict, cypher1 : int, msg2 : int):

Choose a reason for hiding this comment

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

As there is no test file in this pull request nor any test function or class in the file ciphers/paillier_cryptosystem.py, please provide doctest for the function homomorphicMUL

Please provide return type hint for the function: homomorphicMUL. If the function does not return a value, please provide the type hint as: def function() -> None:

Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: homomorphicMUL

Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: pubKey

@algorithms-keeper algorithms-keeper bot added the awaiting reviews This PR is ready to be reviewed label Oct 13, 2024
@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 13, 2024
@cclauss
Copy link
Member

cclauss commented Oct 22, 2024

Closing require_type_hints PRs to prepare for Hacktoberfest

@cclauss cclauss closed this Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting reviews This PR is ready to be reviewed require descriptive names This PR needs descriptive function and/or variable names require tests Tests [doctest/unittest/pytest] are required require type hints https://docs.python.org/3/library/typing.html tests are failing Do not merge until tests pass

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants