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

Closed
itsvinayak opened this issue Jun 17, 2020 · 13 comments · May be fixed by #2392 or #3033
Closed

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

itsvinayak opened this issue Jun 17, 2020 · 13 comments · May be fixed by #2392 or #3033

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>
meysam81 added a commit to meysam81/Python that referenced this issue Sep 3, 2020
also modified the main script to be testable

I also had to change the line that handled `delete` section

Fixes TheAlgorithms#2128
meysam81 added a commit to meysam81/Python that referenced this issue Sep 3, 2020
also modified the main script to be testable

I also had to change the line that handled `delete` section

Fixes TheAlgorithms#2128
@meysam81 meysam81 mentioned this issue Sep 3, 2020
8 of 14 tasks complete
@NumberPiOso NumberPiOso mentioned this issue Sep 16, 2020
10 of 10 tasks complete
meysam81 added a commit to meysam81/Python that referenced this issue Sep 17, 2020
cclauss added a commit that referenced this issue Sep 18, 2020
… (#2335)

* Added static type checking to linear_algebra/src/polynom-for-points.py

* Fixed TravisCI errors

* Update polynom-for-points.py

Co-authored-by: Christian Clauss <cclauss@me.com>
@NumberPiOso NumberPiOso mentioned this issue Sep 22, 2020
12 of 14 tasks complete
NumberPiOso added a commit to NumberPiOso/Python that referenced this issue Oct 2, 2020
- Test lists were not ordered, this is required for Fibonacci search
- Place documentation of function inside function
- Create multiple different tests including, float, char and negatives
- Add type hints in line with TheAlgorithms#2128
@NumberPiOso NumberPiOso mentioned this issue Oct 2, 2020
12 of 12 tasks complete
@ronnydw
Copy link

@ronnydw ronnydw commented Oct 3, 2020

Concerning complexity and maintainability, I've run the repo through wily (https://github.com/tonybaloney/wily), a command-line application for tracking, reporting on the complexity of Python tests and applications.

Here are the results for maintainability index [0..100] per module. The scale considers anything lower than 25 as hard to maintain, and anything over 75 as easy to maintain.

│ File                                                                    │   Maintainability Index │
│ hashes                                                                  │                 60.1865 │
│ neural_network                                                          │                 67.4381 │
│ ciphers                                                                 │                 67.8471 │
│ graphs                                                                  │                 68.9013 │
│ bit_manipulation                                                        │                 69.5657 │
│ linear_algebra                                                          │                 69.6743 │
│ searches                                                                │                 70.5201 │
│ backtracking                                                            │                 71.0636 │
│ divide_and_conquer                                                      │                 71.504  │
│ blockchain                                                              │                 71.9272 │
│ data_structures                                                         │                 71.9902 │
│ matrix                                                                  │                 72.5374 │
│ scripts                                                                 │                 73.9013 │
│ strings                                                                 │                 74.1231 │
│ machine_learning                                                        │                 75.3904 │
│ sorts                                                                   │                 75.6606 │
│ maths                                                                   │                 75.6964 │
│ other                                                                   │                 75.6972 │
│ traversals                                                              │                 76.3276 │
│ geodesy                                                                 │                 76.5739 │
│ dynamic_programming                                                     │                 76.6071 │
│ conversions                                                             │                 77.2626 │
│ boolean_algebra                                                         │                 78.4325 │
│ scheduling                                                              │                 78.8933 │
│ greedy_method                                                           │                 79.298  │
│ compression                                                             │                 80.0726 │
│ networking_flow                                                         │                 81.1551 │
│ arithmetic_analysis                                                     │                 83.0291 │
│ genetic_algorithm                                                       │                 83.2064 │
│ project_euler                                                           │                 83.7122 │
│ web_programming                                                         │                 84.3123 │
│ graphics                                                                │                 84.6733 │
│ computer_vision                                                         │                 84.8111 │
│ digital_image_processing                                                │                 86.2331 │
│ cellular_automata                                                       │                 87.3411 │
│ fuzzy_logic                                                             │                 87.7142 │
│ file_transfer                                                           │                 96.1178 │
│ quantum                                                                 │                100      │
│ images                                                                  │                100      │
│ Total                                                                   │                 77.2957 │

This allows us to track the overall maintainability of the repo (=77.3) and focus improvements on the less maintainable files. For new files, a threshold of 75 could be set for the maintainability index.

@cclauss
Copy link
Member

@cclauss cclauss commented Oct 3, 2020

Please pick one directory (and ONLY one directory) [like hashes] and create a PR that demonstrates how we can improve.

dhruvmanila added a commit that referenced this issue Oct 8, 2020
* Fix: Multiple errors in fibonacci search.

- Test lists were not ordered, this is required for Fibonacci search
- Place documentation of function inside function
- Create multiple different tests including, float, char and negatives
- Add type hints in line with #2128

* Fix: sort of modules and delete typehint.

* Apply suggestions from code review

Co-authored-by: Dhruv <dhruvmanila@gmail.com>

* Correct invocation of lru_cache.

* Add check for input in fibonacci and doctest.

* Correct typehints to comply to numpy style.

* Correct ValueError to TypeError.

Co-authored-by: Dhruv <dhruvmanila@gmail.com>

* Correct doctest for TypeError.

* Rename  single letter names as mentioned in CONTRIBUTING.md.

* Fix: Bug in big lists.

* Remove print(.) in doctests.

* Refactor iterator to while loop.

* Update searches/fibonacci_search.py

Co-authored-by: Dhruv <dhruvmanila@gmail.com>
meysam81 added a commit to meysam81/Python that referenced this issue Oct 8, 2020
@poyea poyea closed this in c2a5033 Oct 8, 2020
meysam81 added a commit to meysam81/Python that referenced this issue Oct 9, 2020
this is a child of a previous PR TheAlgorithms#2443

its ancestor is TheAlgorithms#2128
cclauss pushed a commit that referenced this issue Oct 15, 2020
* graphs/kruskal: add doctest & type hints

this is a child of a previous PR #2443

its ancestor is #2128

* updating DIRECTORY.md

* graphs/kruskal: fix max-line-length violation

* fixup! Format Python code with psf/black push

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
@tanyonghe tanyonghe mentioned this issue Oct 19, 2020
14 of 16 tasks complete
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.

10 participants
You can’t perform that action at this time.