Skip to content

Conversation

GustavRamirez
Copy link

@GustavRamirez GustavRamirez commented Oct 12, 2021

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}.
A class for the implementation of DES algorithm
Made changes to conform with the given guidelines
@ghost ghost added 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 labels Oct 12, 2021
Copy link

@ghost ghost 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.

[2, 1, 14, 7, 4, 10, 8, 13, 15, 12, 9, 0, 3, 5, 6, 11]
]]

def single_string(self, s: str) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function single_string

Please provide descriptive name for the parameter: s

return '0' * (16 - len(temp)) + temp

# constructs the str by looking up the corresponding table
def crank(self, msg, table: list(int)) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function crank

Please provide type hint for the parameter: msg

return s

# makes long str presentable
def pretty(self, s: str) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function pretty

Please provide descriptive name for the parameter: s

ans += str(int(s1[i]) ^ int(s2[i]))
return ans

def s_box(self, msg: str) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function s_box

n += 1
return ans

def bits_shuffle(self, msg: str) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function bits_shuffle

def bits_shuffle(self, msg: str) -> str:
return self.crank(self.single_string(msg), self.bit_shuffle)

def generate_keys(self, key: str) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function generate_keys

self.shifted_keys.append(key)
self.keys.append(self.pc2(key))

def solve(self, msg: str, key: str, rnd: int) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function solve

print("Now applying PC-1 we get: ")
key = self.pc1(key)
print(self.pretty(key))
print("Rotating {} bit to the left we get:".format(self.shifts[rnd]))
Copy link

Choose a reason for hiding this comment

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

As mentioned in the Contributing Guidelines, please do not use printf style formatting or str.format(). Use f-string instead to be more readable and efficient.

Copy link

@ghost ghost 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.

[2, 1, 14, 7, 4, 10, 8, 13, 15, 12, 9, 0, 3, 5, 6, 11]
]]

def single_string(self, s: str) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function single_string

Please provide descriptive name for the parameter: s

def single_string(self, s: str) -> str:
return ''.join(s.split())

def hex_to_bin(self, n) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function hex_to_bin

Please provide type hint for the parameter: n

Please provide descriptive name for the parameter: n

def hex_to_bin(self, n) -> str:
return bin(int(n, 16))

def bin_to_hex(self, n) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function bin_to_hex

Please provide type hint for the parameter: n

Please provide descriptive name for the parameter: n

return '0' * (16 - len(temp)) + temp

# constructs the str by looking up the corresponding table
def crank(self, msg, table: list(int)) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function crank

Please provide type hint for the parameter: msg

return s

# makes long str presentable
def pretty(self, s: str) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function pretty

Please provide descriptive name for the parameter: s

def pc2(self, key):
return self.crank(self.single_string(key), self.pc2_table)

def xor(self, s1: str, s2: str) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function xor

ans += str(int(s1[i]) ^ int(s2[i]))
return ans

def s_box(self, msg: str) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function s_box

n += 1
return ans

def bits_shuffle(self, msg: str) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function bits_shuffle

def bits_shuffle(self, msg: str) -> str:
return self.crank(self.single_string(msg), self.bit_shuffle)

def generate_keys(self, key: str) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function generate_keys

self.shifted_keys.append(key)
self.keys.append(self.pc2(key))

def solve(self, msg: str, key: str, rnd: int) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function solve

Copy link

@ghost ghost 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.

[2, 1, 14, 7, 4, 10, 8, 13, 15, 12, 9, 0, 3, 5, 6, 11]
]]

def single_string(self, s: str) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function single_string

Please provide descriptive name for the parameter: s

return '0' * (16 - len(temp)) + temp

# constructs the str by looking up the corresponding table
def crank(self, msg, table: list(int)) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function crank

Please provide type hint for the parameter: msg

return s

# makes long str presentable
def pretty(self, s: str) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function pretty

Please provide descriptive name for the parameter: s

def pc2(self, key):
return self.crank(self.single_string(key), self.pc2_table)

def xor(self, s1: str, s2: str) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function xor

ans += str(int(s1[i]) ^ int(s2[i]))
return ans

def s_box(self, msg: str) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function s_box

n += 1
return ans

def bits_shuffle(self, msg: str) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function bits_shuffle

def bits_shuffle(self, msg: str) -> str:
return self.crank(self.single_string(msg), self.bit_shuffle)

def generate_keys(self, key: str) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function generate_keys

self.shifted_keys.append(key)
self.keys.append(self.pc2(key))

def solve(self, msg: str, key: str, rnd: int) -> str:
Copy link

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/des_algorithm.py, please provide doctest for the function solve

Copy link
Author

@GustavRamirez GustavRamirez left a comment

Choose a reason for hiding this comment

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

Updated type hints and some other issues

@ghost ghost added the tests are failing Do not merge until tests pass label Oct 14, 2021
@stale
Copy link

stale bot commented Jul 10, 2022

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale Used to mark an issue or pull request stale. label Jul 10, 2022
@cclauss
Copy link
Member

cclauss commented Oct 1, 2022

In preparation for that denial-of-service attack that is Hacktoberfest, I am closing all pull requests that do not have passing tests.

@cclauss cclauss closed this Oct 1, 2022
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 stale Used to mark an issue or pull request stale. tests are failing Do not merge until tests pass

2 participants