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

Dev sprint ideas: More tests, type hints and less complexity #2128

Open
itsvinayak opened this issue Jun 17, 2020 · 7 comments
Open

Dev sprint ideas: More tests, type hints and less complexity #2128

itsvinayak opened this issue Jun 17, 2020 · 7 comments

Comments

@itsvinayak
Copy link
Member

@itsvinayak itsvinayak commented Jun 17, 2020

currently, some of the programs use static type checking like this program but some of the programs did not use static typing.

it's a good practice to use static typing as it makes code more clear and readable, should we make it a standard for this repository.we can use mypy for testing code

more on static typing

thank you

Dev sprint ideas:

@cclauss
Copy link
Member

@cclauss cclauss commented Jun 17, 2020

We push all new contributions to use type hints as discussed in CONTRIBUTING.md.
All efforts to add type hints to existing algorithms would be warmly received.

We can use mypy for testing code

We do this already https://github.com/TheAlgorithms/Python/blob/master/.travis.yml#L17

@onlinejudge95
Copy link
Collaborator

@onlinejudge95 onlinejudge95 commented Jun 17, 2020

@cclauss How about a dev sprint kind of thing where we go about adding all such improvements?

@cclauss
Copy link
Member

@cclauss cclauss commented Jun 17, 2020

Cool idea! Another thing (a sprint topic?) that is bugging me is code complexity which we currently set to 25 but I would be much happier to see it at 15. We would need to ensure that the files have strong type hints and tests before modifying them to reduce their cyclomatic complexity.

@cclauss
Copy link
Member

@cclauss cclauss commented Jun 17, 2020

Another cool sprint topic would be to add doctests to Python files that have <10% test coverage. Some files like file_transfer/send_file.py and the web programming files are difficult to write tests for but others should be fair game.

@cclauss cclauss changed the title Static typing standard for repository Dev sprint ideas: More tests, type hints and less cyclomatic complexity Jun 17, 2020
@cclauss cclauss changed the title Dev sprint ideas: More tests, type hints and less cyclomatic complexity Dev sprint ideas: More tests, type hints and less code complexity Jun 17, 2020
@cclauss cclauss changed the title Dev sprint ideas: More tests, type hints and less code complexity Dev sprint ideas: More tests, type hints and less complexity Jun 17, 2020
@cclauss
Copy link
Member

@cclauss cclauss commented Jun 20, 2020

Should we have a short sprint or a long one? One idea would be 24 hour sprint — given that tomorrow is summer solstice (longest day of the year) — the sprint could start at midnight tonight (in whatever timezone the contributer is in) and last for 24 hours. #2128 could be our tracking issue for keeping track of tasks and accomplishments. Thoughts on this Summer Solstice Special Sprint idea.

@onlinejudge95
Copy link
Collaborator

@onlinejudge95 onlinejudge95 commented Jun 20, 2020

Seems awesome, we can gain some attention by Summer Solstice Special Sprint, I am up on gitter if you want to discuss

cclauss added a commit that referenced this issue Jun 21, 2020
Work In Progress Draft: Do not merge if test are not passing!!

Related to #2128, find all files that contain algorithms with > 15% McCabe complexity.
cclauss added a commit that referenced this issue Jun 21, 2020
As discussed in #2128
@cclauss cclauss mentioned this issue Jun 21, 2020
0 of 14 tasks complete
cclauss added a commit that referenced this issue Jun 21, 2020
As discussed in #2128
@cclauss cclauss removed the question label Jun 21, 2020
@mateuszz0000
Copy link
Member

@mateuszz0000 mateuszz0000 commented Jun 22, 2020

Another cool sprint topic would be to add doctests to Python files that have <10% test coverage. Some files like file_transfer/send_file.py and the web programming files are difficult to write tests for but others should be fair game.

Difficult but not impossible. We can create issue with some labels. Perhaps we find someone who will write tests or even code (for example simple server for response) for testing it 😃

cclauss added a commit that referenced this issue Jun 22, 2020
* Euler problem 551 sol 1: Reduce McCabe code complexity

As discussed in #2128

* fixup! Format Python code with psf/black push

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
cclauss added a commit that referenced this issue Jun 22, 2020
* hamming_code.py: Reduce McCabe code complexity

As discussed in #2128

* fixup! Format Python code with psf/black push

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
peRFectBeliever added a commit to peRFectBeliever/Python that referenced this issue Jun 30, 2020
…#2141)

* Euler problem 551 sol 1: Reduce McCabe code complexity

As discussed in TheAlgorithms#2128

* fixup! Format Python code with psf/black push

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
peRFectBeliever added a commit to peRFectBeliever/Python that referenced this issue Jun 30, 2020
* hamming_code.py: Reduce McCabe code complexity

As discussed in TheAlgorithms#2128

* fixup! Format Python code with psf/black push

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
7 participants
@cclauss @AnupKumarPanwar @poyea @mateuszz0000 @itsvinayak @onlinejudge95 and others
You can’t perform that action at this time.