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

Python word count #132

Merged
merged 6 commits into from
Jun 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,4 @@
- [cater-waiter](./cater-waiter/README.md)
- [locomotive-engineer](./locomotive-engineer/README.md)
- [ellens-alien-game](./ellens-alien-game/README.md)
- [word-count](./word-count/README.md)
1 change: 1 addition & 0 deletions python/card-games
1 change: 1 addition & 0 deletions python/cater-waiter
1 change: 1 addition & 0 deletions python/chaitanas-colossal-coaster
1 change: 1 addition & 0 deletions python/currency-exchange
1 change: 1 addition & 0 deletions python/ellens-alien-game
1 change: 1 addition & 0 deletions python/for_each
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ declare pkg_name
declare d

time for d in ./*; do
[[ ${d} =~ .*-.* ]] && continue
[[ -d ${d} ]] || continue
cd "${d}" || continue
printf "[dir: %s]\n\n" "${PWD}"
Expand Down
1 change: 1 addition & 0 deletions python/ghost-gobble-arcade-game
1 change: 1 addition & 0 deletions python/guidos-gorgeous-lasagna
1 change: 1 addition & 0 deletions python/inventory-management
1 change: 1 addition & 0 deletions python/little-sisters-essay
1 change: 1 addition & 0 deletions python/little-sisters-vocab
1 change: 1 addition & 0 deletions python/making-the-grade
1 change: 1 addition & 0 deletions python/meltdown-mitigation
1 change: 1 addition & 0 deletions python/tisbury-treasure-hunt
7 changes: 3 additions & 4 deletions python/update_readmes
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,8 @@ printf "\n"
git add __init__.py .coveragerc
printf "\n"

git mv -v "../${project_dir}" "../${project_dir//-/_}"
printf "\n"
cd ..

project_dir="${project_dir//-/_}"
cd "../${project_dir//-/_}" || exit
ln -sv "${project_dir//_/-}" "${project_dir}"
git add "./${project_dir//_/-}"
printf "\n"
1 change: 1 addition & 0 deletions python/word-count
Binary file added python/wordcount/.coverage
Binary file not shown.
35 changes: 35 additions & 0 deletions python/wordcount/.coverage.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<?xml version="1.0" ?>
<coverage version="7.2.3" timestamp="1687762285141" lines-valid="16" lines-covered="16" line-rate="1" branches-valid="6" branches-covered="6" branch-rate="1" complexity="0">
<!-- Generated by coverage.py: https://coverage.readthedocs.io/en/7.2.3 -->
<!-- Based on https://raw.githubusercontent.com/cobertura/web/master/htdocs/xml/coverage-04.dtd -->
<sources>
<source>/home/vpayno/git_vpayno/exercism-workspace/python/wordcount</source>
</sources>
<packages>
<package name="." line-rate="1" branch-rate="1" complexity="0">
<classes>
<class name="word_count.py" filename="word_count.py" complexity="0" line-rate="1" branch-rate="1">
<methods/>
<lines>
<line number="4" hits="1"/>
<line number="5" hits="1"/>
<line number="6" hits="1"/>
<line number="9" hits="1"/>
<line number="15" hits="1"/>
<line number="18" hits="1"/>
<line number="21" hits="1"/>
<line number="24" hits="1"/>
<line number="26" hits="1" branch="true" condition-coverage="100% (2/2)"/>
<line number="27" hits="1" branch="true" condition-coverage="100% (2/2)"/>
<line number="29" hits="1" branch="true" condition-coverage="100% (2/2)"/>
<line number="30" hits="1"/>
<line number="33" hits="1"/>
<line number="36" hits="1"/>
<line number="39" hits="1"/>
<line number="41" hits="1"/>
</lines>
</class>
</classes>
</package>
</packages>
</coverage>
2 changes: 2 additions & 0 deletions python/wordcount/.coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[run]
omit = __init__.py, *_test.py
38 changes: 38 additions & 0 deletions python/wordcount/.exercism/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"authors": [],
"contributors": [
"behrtam",
"c4llmeco4ch",
"cmccandless",
"Dog",
"gabriel376",
"Grociu",
"guygastineau",
"ikhadykin",
"jackattack24",
"kytrinyx",
"lowks",
"N-Parsons",
"pheanex",
"rivergillis",
"samdec11",
"sjakobi",
"tqa236",
"wobh",
"yawpitch",
"ZacharyRSmith"
],
"files": {
"solution": [
"word_count.py"
],
"test": [
"word_count_test.py"
],
"example": [
".meta/example.py"
]
},
"blurb": "Given a phrase, count the occurrences of each word in that phrase.",
"source": "This is a classic toy problem, but we were reminded of it by seeing it in the Go Tour."
}
1 change: 1 addition & 0 deletions python/wordcount/.exercism/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"track":"python","exercise":"word-count","id":"5c663edf31b64941a3930befca2c34dc","url":"https://exercism.org/tracks/python/exercises/word-count","handle":"vpayno","is_requester":true,"auto_approve":false}
129 changes: 129 additions & 0 deletions python/wordcount/HELP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
# 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 word_count.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)
- [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.
44 changes: 44 additions & 0 deletions python/wordcount/HINTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Hints

## General

This exercise has many potential solutions and many paths you can take along the way.
No path is manifestly "better" than another, although a particular path may be more interesting or better suited to what you want to learn or explore right now.
Some paths may trade speed for clarity, others might take up more memory but be more scalable or maintainable.
We encourage you to try out more than one strategy to see what happens.

_______
- Python has a robust set of tools to work with strings. [`str.split`][str.split] [`str.replace`][str.replace] [`str.lower`][str.lower] and [`str.strip`][str.strip] can be particularly helpful with this challenge.
- String methods can be chained together (_as long as the method returns a `str`_))
- While `str.split()` is very _specific_, `str.strip()` behaves differently, and allows multiple combinations.
- The [`string`][string] module (as opposed to `str`) has some constants that can be useful for filtering and comparison when processing strings.
________

- [Dictionaries][dict] can be helpful for tabulating when items (keys) appear more than once in a string.
- [`dict.setdefault()`][dict.setdefault] can help in processing when a key might be missing from a dictionary.
- The [Collections][collections] module implements some really useful subtypes to the core `dict` (dictionary), purpose-built to do things like [tally][collections.counter].
________
- Exploring the [`re`][re] module and regular expressions can be fun, but is by no means necessary to solve this challenge.
- [Regex101][regex101] is very helpful for experimenting with regular expression logic.
- Both [`re.sub`][re.sub] and [`re.findall`][re.findall] can be interesting strategies to employ.
________
- [Comprehensions][comprehensions] can often "flatten" loops where items are being appended to a list or inserted into a dictionary.
- [Generator expressions][generator expressions] can often "stand in" for a list comprehension when an iterable is needed.
Generator expressions are evaluated in a "lazy" fashion, and take up less space in memory than a corresponding list comprehension.


[collections.counter]: https://docs.python.org/3/library/collections.html#collections.Counter
[collections]: https://docs.python.org/3/library/collections.html#module-collections
[comprehensions]: https://treyhunner.com/2015/12/python-list-comprehensions-now-in-color/
[dict.setdefault]: https://docs.python.org/3/library/stdtypes.html#dict.setdefault
[dict]: https://docs.python.org/3/library/stdtypes.html#mapping-types-dict
[generator expressions]: https://dbader.org/blog/python-generator-expressions
[re.findall]: https://docs.python.org/3/library/re.html?highlight=re#re.findall
[re.sub]: https://docs.python.org/3/library/re.html?highlight=re#re.sub
[re]: https://docs.python.org/3/library/re.html?highlight=re#module-re
[regex101]: https://regex101.com/
[str.lower]: https://docs.python.org/3/library/stdtypes.html#str.lower
[str.replace]: https://docs.python.org/3/library/stdtypes.html#str.replace
[str.split]: https://docs.python.org/3/library/stdtypes.html#str.split
[str.strip]: https://docs.python.org/3/library/stdtypes.html#str.strip
[string]: https://docs.python.org/3/library/string.html
Loading