Skip to content

Commit

Permalink
python/pangram: download exercise
Browse files Browse the repository at this point in the history
  • Loading branch information
vpayno committed Apr 23, 2024
1 parent c50f2d2 commit 85f8e6d
Show file tree
Hide file tree
Showing 6 changed files with 277 additions and 0 deletions.
34 changes: 34 additions & 0 deletions python/pangram/.exercism/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"authors": [
"behrtam"
],
"contributors": [
"cmccandless",
"Dog",
"Grociu",
"helenst",
"ikhadykin",
"luoken",
"mtroiani",
"N-Parsons",
"olufotebig",
"patricksjackson",
"pheanex",
"thomasjpfan",
"tqa236"
],
"files": {
"solution": [
"pangram.py"
],
"test": [
"pangram_test.py"
],
"example": [
".meta/example.py"
]
},
"blurb": "Determine if a sentence is a pangram.",
"source": "Wikipedia",
"source_url": "https://en.wikipedia.org/wiki/Pangram"
}
1 change: 1 addition & 0 deletions python/pangram/.exercism/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"track":"python","exercise":"pangram","id":"99f1d39a04ee4c74a6d3933f6ecb6e0c","url":"https://exercism.org/tracks/python/exercises/pangram","handle":"vpayno","is_requester":true,"auto_approve":false}
130 changes: 130 additions & 0 deletions python/pangram/HELP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
# Help

## Running the tests

We use [pytest][pytest: Getting Started Guide] as our website test runner.
You will need to install `pytest` on your development machine if you want to run tests for the Python track locally.
You should also install the following `pytest` plugins:

- [pytest-cache][pytest-cache]
- [pytest-subtests][pytest-subtests]

Extended information can be found in our website [Python testing guide][Python track tests page].


### Running Tests

To run the included tests, navigate to the folder where the exercise is stored using `cd` in your terminal (_replace `{exercise-folder-location}` below with your path_).
Test files usually end in `_test.py`, and are the same tests that run on the website when a solution is uploaded.

Linux/MacOS
```bash
$ cd {path/to/exercise-folder-location}
```

Windows
```powershell
PS C:\Users\foobar> cd {path\to\exercise-folder-location}
```

<br>

Next, run the `pytest` command in your terminal, replacing `{exercise_test.py}` with the name of the test file:

Linux/MacOS
```bash
$ python3 -m pytest -o markers=task {exercise_test.py}
==================== 7 passed in 0.08s ====================
```

Windows
```powershell
PS C:\Users\foobar> py -m pytest -o markers=task {exercise_test.py}
==================== 7 passed in 0.08s ====================
```


### Common options
- `-o` : override default `pytest.ini` (_you can use this to avoid marker warnings_)
- `-v` : enable verbose output.
- `-x` : stop running tests on first failure.
- `--ff` : run failures from previous test before running other test cases.

For additional options, use `python3 -m pytest -h` or `py -m pytest -h`.


### Fixing warnings

If you do not use `pytest -o markers=task` when invoking `pytest`, you might receive a `PytestUnknownMarkWarning` for tests that use our new syntax:

```bash
PytestUnknownMarkWarning: Unknown pytest.mark.task - is this a typo? You can register custom marks to avoid this warning - for details, see https://docs.pytest.org/en/stable/mark.html
```

To avoid typing `pytest -o markers=task` for every test you run, you can use a `pytest.ini` configuration file.
We have made one that can be downloaded from the top level of the Python track directory: [pytest.ini][pytest.ini].

You can also create your own `pytest.ini` file with the following content:

```ini
[pytest]
markers =
task: A concept exercise task.
```

Placing the `pytest.ini` file in the _root_ or _working_ directory for your Python track exercises will register the marks and stop the warnings.
More information on pytest marks can be found in the `pytest` documentation on [marking test functions][pytest: marking test functions with attributes] and the `pytest` documentation on [working with custom markers][pytest: working with custom markers].

Information on customizing pytest configurations can be found in the `pytest` documentation on [configuration file formats][pytest: configuration file formats].


### Extending your IDE or Code Editor

Many IDEs and code editors have built-in support for using `pytest` and other code quality tools.
Some community-sourced options can be found on our [Python track tools page][Python track tools page].

[Pytest: Getting Started Guide]: https://docs.pytest.org/en/latest/getting-started.html
[Python track tools page]: https://exercism.org/docs/tracks/python/tools
[Python track tests page]: https://exercism.org/docs/tracks/python/tests
[pytest-cache]:http://pythonhosted.org/pytest-cache/
[pytest-subtests]:https://github.com/pytest-dev/pytest-subtests
[pytest.ini]: https://github.com/exercism/python/blob/main/pytest.ini
[pytest: configuration file formats]: https://docs.pytest.org/en/6.2.x/customize.html#configuration-file-formats
[pytest: marking test functions with attributes]: https://docs.pytest.org/en/6.2.x/mark.html#raising-errors-on-unknown-marks
[pytest: working with custom markers]: https://docs.pytest.org/en/6.2.x/example/markers.html#working-with-custom-markers

## Submitting your solution

You can submit your solution using the `exercism submit pangram.py` command.
This command will upload your solution to the Exercism website and print the solution page's URL.

It's possible to submit an incomplete solution which allows you to:

- See how others have completed the exercise
- Request help from a mentor

## Need to get help?

If you'd like help solving the exercise, check the following pages:

- The [Python track's documentation](https://exercism.org/docs/tracks/python)
- The [Python track's programming category on the forum](https://forum.exercism.org/c/programming/python)
- [Exercism's programming category on the forum](https://forum.exercism.org/c/programming/5)
- The [Frequently Asked Questions](https://exercism.org/docs/using/faqs)

Should those resources not suffice, you could submit your (incomplete) solution to request mentoring.

Below are some resources for getting help if you run into trouble:

- [The PSF](https://www.python.org) hosts Python downloads, documentation, and community resources.
- [The Exercism Community on Discord](https://exercism.org/r/discord)
- [Python Community on Discord](https://pythondiscord.com/) is a very helpful and active community.
- [/r/learnpython/](https://www.reddit.com/r/learnpython/) is a subreddit designed for Python learners.
- [#python on Libera.chat](https://www.python.org/community/irc/) this is where the core developers for the language hang out and get work done.
- [Python Community Forums](https://discuss.python.org/)
- [Free Code Camp Community Forums](https://forum.freecodecamp.org/)
- [CodeNewbie Community Help Tag](https://community.codenewbie.org/t/help)
- [Pythontutor](http://pythontutor.com/) for stepping through small code snippets visually.

Additionally, [StackOverflow](http://stackoverflow.com/questions/tagged/python) is a good spot to search for your problem/question to see if it has been answered already.
If not - you can always [ask](https://stackoverflow.com/help/how-to-ask) or [answer](https://stackoverflow.com/help/how-to-answer) someone else's question.
56 changes: 56 additions & 0 deletions python/pangram/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Pangram

Welcome to Pangram on Exercism's Python Track.
If you need help running the tests or submitting your code, check out `HELP.md`.

## Introduction

You work for a company that sells fonts through their website.
They'd like to show a different sentence each time someone views a font on their website.
To give a comprehensive sense of the font, the random sentences should use **all** the letters in the English alphabet.

They're running a competition to get suggestions for sentences that they can use.
You're in charge of checking the submissions to see if they are valid.

~~~~exercism/note
Pangram comes from Greek, παν γράμμα, pan gramma, which means "every letter".
The best known English pangram is:
> The quick brown fox jumps over the lazy dog.
~~~~

## Instructions

Your task is to figure out if a sentence is a pangram.

A pangram is a sentence using every letter of the alphabet at least once.
It is case insensitive, so it doesn't matter if a letter is lower-case (e.g. `k`) or upper-case (e.g. `K`).

For this exercise, a sentence is a pangram if it contains each of the 26 letters in the English alphabet.

## Source

### Created by

- @behrtam

### Contributed to by

- @cmccandless
- @Dog
- @Grociu
- @helenst
- @ikhadykin
- @luoken
- @mtroiani
- @N-Parsons
- @olufotebig
- @patricksjackson
- @pheanex
- @thomasjpfan
- @tqa236

### Based on

Wikipedia - https://en.wikipedia.org/wiki/Pangram
2 changes: 2 additions & 0 deletions python/pangram/pangram.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
def is_pangram(sentence):
pass
54 changes: 54 additions & 0 deletions python/pangram/pangram_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# These tests are auto-generated with test data from:
# https://github.com/exercism/problem-specifications/tree/main/exercises/pangram/canonical-data.json
# File last updated on 2023-07-19

import unittest

from pangram import (
is_pangram,
)


class PangramTest(unittest.TestCase):
def test_empty_sentence(self):
self.assertIs(is_pangram(""), False)

def test_perfect_lower_case(self):
self.assertIs(is_pangram("abcdefghijklmnopqrstuvwxyz"), True)

def test_only_lower_case(self):
self.assertIs(is_pangram("the quick brown fox jumps over the lazy dog"), True)

def test_missing_the_letter_x(self):
self.assertIs(
is_pangram("a quick movement of the enemy will jeopardize five gunboats"),
False,
)

def test_missing_the_letter_h(self):
self.assertIs(is_pangram("five boxing wizards jump quickly at it"), False)

def test_with_underscores(self):
self.assertIs(is_pangram("the_quick_brown_fox_jumps_over_the_lazy_dog"), True)

def test_with_numbers(self):
self.assertIs(
is_pangram("the 1 quick brown fox jumps over the 2 lazy dogs"), True
)

def test_missing_letters_replaced_by_numbers(self):
self.assertIs(is_pangram("7h3 qu1ck brown fox jumps ov3r 7h3 lazy dog"), False)

def test_mixed_case_and_punctuation(self):
self.assertIs(is_pangram('"Five quacking Zephyrs jolt my wax bed."'), True)

def test_a_m_and_a_m_are_26_different_characters_but_not_a_pangram(self):
self.assertIs(is_pangram("abcdefghijklm ABCDEFGHIJKLM"), False)

# Additional tests for this track

def test_sentence_without_lower_bound(self):
self.assertIs(is_pangram("bcdefghijklmnopqrstuvwxyz"), False)

def test_sentence_without_upper_bound(self):
self.assertIs(is_pangram("abcdefghijklmnopqrstuvwxy"), False)

0 comments on commit 85f8e6d

Please sign in to comment.