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

Validate only submitted Project Euler solution #3977

Merged

Conversation

dhruvmanila
Copy link
Member

@dhruvmanila dhruvmanila commented Nov 28, 2020

Messing around with GitHub Actions, trying to see if this is possible:
We will run checks only on the submitted Project Euler solution and not all.

Describe your change:

  • Improve Project Euler validate solutions script
  • 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}.

@dhruvmanila dhruvmanila requested a review from cclauss as a code owner November 28, 2020 05:28
@ghost ghost added awaiting reviews This PR is ready to be reviewed require tests Tests [doctest/unittest/pytest] are required require type hints https://docs.python.org/3/library/typing.html and removed awaiting reviews This PR is ready to be reviewed labels Nov 28, 2020
@dhruvmanila dhruvmanila marked this pull request as draft November 28, 2020 05:29
@dhruvmanila dhruvmanila changed the title Validate one pe solution Validate only submitted Project Euler solution Nov 28, 2020
@dhruvmanila dhruvmanila removed the request for review from cclauss November 28, 2020 05:32
@TheAlgorithms TheAlgorithms deleted a comment Nov 28, 2020
@dhruvmanila
Copy link
Member Author

Is this useful? @cclauss

I was messing around with GitHub Actions and wrote some functions so that the validate_solutions script only checks for the submitted solution and if there are none, it will default to check all solutions. Also, I have scheduled this to be run every day for all solutions in case we break something.

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.

Draft usually means not yet ready for review.

@dhruvmanila dhruvmanila force-pushed the validate-one-pe-solution branch from 1b5eaf9 to 21db7cf Compare November 29, 2020 17:06
@dhruvmanila dhruvmanila force-pushed the validate-one-pe-solution branch from 30b3cc7 to fbe7cd6 Compare November 29, 2020 17:26
@dhruvmanila dhruvmanila marked this pull request as ready for review November 29, 2020 17:27
@ghost
Copy link

ghost commented Nov 29, 2020

Pull Request Report

@dhruvmanila Hello! I'm a bot made to check all the pull request Python files. First of all, I want to say thank you for your time and interest in this project and for opening a pull request. There seems to be missing requirements in some of the Python files submitted in this pull request. Please read through the report and make the necessary changes. You can take a look at the relevant links provided after the report.

What are node paths? 🔽

The report contains headings and a checklist where the items are paths to the class/function/parameter where the requirement is missing. Node paths are double colon :: separated names and can be in any of the following format:

  • Class path: [file_name]::[class_name]
  • Function path: [file_name]::[function_name]
  • Function parameter path: [file_name]::[function_name]::[parameter_name]
  • Method path: [file_name]::[class_name]::[function_name]
  • Method parameter path: [file_name]::[class_name]::[function_name]::[parameter_name]

Following functions require tests [doctest/unittest/pytest]:

  • scripts/validate_solutions.py::convert_path_to_module
  • scripts/validate_solutions.py::all_solution_file_paths
  • scripts/validate_solutions.py::get_files_url
  • scripts/validate_solutions.py::added_solution_file_path
  • scripts/validate_solutions.py::collect_solution_file_paths
  • scripts/validate_solutions.py::test_project_euler
Relevant links 🔽

@ghost ghost removed the require type hints https://docs.python.org/3/library/typing.html label Nov 29, 2020
@dhruvmanila
Copy link
Member Author

Note to me: Configure the bot to ignore the scripts/ directory.

@dhruvmanila
Copy link
Member Author

Draft usually means not yet ready for review.

Sorry for that, I just wanted you to a second opinion on whether this was worth doing.

@dhruvmanila dhruvmanila removed the require tests Tests [doctest/unittest/pytest] are required label Nov 29, 2020
@ghost ghost added the awaiting reviews This PR is ready to be reviewed label Nov 29, 2020
@dhruvmanila dhruvmanila merged commit ba6310b into TheAlgorithms:master Nov 29, 2020
@ghost ghost removed the awaiting reviews This PR is ready to be reviewed label Nov 29, 2020
@dhruvmanila dhruvmanila deleted the validate-one-pe-solution branch November 29, 2020 17:42
stokhos pushed a commit to stokhos/Python that referenced this pull request Jan 3, 2021
* Update validate solution script to fetch only submitted solution
* Update workflow file with the updated PE script
* Fix: do not fetch `validate_solutions.py` script
* Update script to use the requests package for API calls
* Fix: install requests module
* Pytest ignore scripts/ directory
peRFectBeliever pushed a commit to peRFectBeliever/Python that referenced this pull request Apr 1, 2021
* Update validate solution script to fetch only submitted solution
* Update workflow file with the updated PE script
* Fix: do not fetch `validate_solutions.py` script
* Update script to use the requests package for API calls
* Fix: install requests module
* Pytest ignore scripts/ directory
Panquesito7 pushed a commit to Panquesito7/Python that referenced this pull request May 13, 2021
* Update validate solution script to fetch only submitted solution
* Update workflow file with the updated PE script
* Fix: do not fetch `validate_solutions.py` script
* Update script to use the requests package for API calls
* Fix: install requests module
* Pytest ignore scripts/ directory
shermanhui pushed a commit to shermanhui/Python that referenced this pull request Oct 22, 2021
* Update validate solution script to fetch only submitted solution
* Update workflow file with the updated PE script
* Fix: do not fetch `validate_solutions.py` script
* Update script to use the requests package for API calls
* Fix: install requests module
* Pytest ignore scripts/ directory
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants