"In this assessment, you'll implement, document, and test a variety of unrelated functions to demonstrate your ability to apply control structures and data structures to solve problems involving numbers, text, and files. There's no realistic data science motivation or context for this assignment: it's just a grab-bag of questions. Future assessments will have more context.\n",
"\n",
"For each question, you'll be asked to *write a function*, **document it** with a docstring, and **test** it with doctests added in the docstring. We've provided several input-output examples for each function.\n",
"\n",
"The `run_docstring_examples` function call will *not* print anything if the function *passes all* the doctests you defined. \n",
"\n",
"To fulfill the documentation requirements, use your own words to provide a brief description of only the details that a client needs to know to call the function. To fulfill testing requirements, convert each provided example into a doctest and **additionally write 2 more test cases of your own**. Be ready to justify and explain the design of all your work: how and why did you write each line of code?"
]
},
{
"cell_type": "code",
"execution_count": 1,
"id": "582de7ad-4a48-4ce6-9896-de32b31483d8",
"metadata": {},
"outputs": [],
"source": [
"import doctest"
]
},
{
"cell_type": "markdown",
"id": "31845b38-3323-4dee-b1a1-1734af326c9e",
"metadata": {},
"source": [
"## Collaboration and Conduct\n",
"\n",
"Students are expected to follow Washington state law on the [Student Conduct Code for the University of Washington](https://www.washington.edu/admin/rules/policies/WAC/478-121TOC.html). In this course, students must:\n",
"\n",
"- Indicate on your submission any assistance received, including materials distributed in this course.\n",
"- Not receive, generate, or otherwise acquire any substantial portion or walkthrough to an assessment.\n",
"- Not aid, assist, attempt, or tolerate prohibited academic conduct in others.\n",
"\n",
"Update the following code cell to include your name and list your sources. If you used any kind of computer technology to help prepare your assessment submission, include the queries and/or prompts. Submitted work that is not consistent with sources may be subject to the student conduct process."
]
},
{
"cell_type": "code",
"execution_count": 3,
"id": "1faa1411-4de6-4b17-99af-7586f56c1973",
"metadata": {},
"outputs": [],
"source": [
"your_name = \"\"\n",
"sources = [\n",
" ...\n",
"]\n",
"\n",
"assert your_name != \"\", \"your_name cannot be empty\"\n",
"assert ... not in sources, \"sources should not include the placeholder ellipsis\"\n",
"assert len(sources) >= 2, \"must include at least 2 sources, inclusive of lectures and sections\""
]
},
{
"cell_type": "markdown",
"id": "2696e23b-d964-4c2a-844b-602c69ed3952",
"metadata": {},
"source": [
"## Task: `is_relatively_prime`\n",
"\n",
"Write and test a function `is_relatively_prime` that takes two integer numbers `n` and `m` and returns `True` if and only if `n` and `m` are relatively prime to each other. Two numbers are relatively prime if they share no common factors besides 1. (1 is relatively prime with every number.) Assume the value of `n` and `m` are at least 1.\n",
"\n",
"- `is_relatively_prime(12, 13)` returns `True` since the factors of 12 are 1, 2, 3, 4, 6, 12 and the factors of 13 are 1, 13.\n",
"- `is_relatively_prime(12, 14)` returns `False` since the factors of 12 are 1, 2, 3, 4, 6, 12 and the factors of 14 are 1, 2, 7, 14.\n",
"- `is_relatively_prime(5, 9)` returns `True` since the factors of 5 are 1, 5 and the factors of 9 are 1, 3, 9.\n",
"- `is_relatively_prime(8, 9)` returns `True` since the factors of 8 are 1, 2, 4, 8 and the factors of 9 are 1, 3, 9.\n",
"- `is_relatively_prime(8, 1)` returns `True` since we define that 1 is relatively prime with every number.\n",
"\n",
"Do not use data structures to store factors during the execution of the algorithm, and use a single loop rather than nested loops."
"Write and test a function `travel` that takes a string of north/east/south/west directions and a `tuple` indicating the starting `x, y` location on a grid. This function should return a `tuple` that indicates the new position after following the directions starting from the starting `x, y` location. The returned tuple should be in the format `(x_new, y_new)`. Assume we use integer coordinates where each direction increments or decrements a coordinate by 1.\n",
"\n",
"The directions string will use `\"N\"` to indicate increasing the y-coordinate, `\"E\"` to indicate increasing the x-coordinate, `\"S\"` to indicate decreasing the y-coordinate, and `\"W\"` to indicate decreasing the x-coordinate. The case of the characters should be ignored. You can assume that `x` and `y` are both of type `int`. Any characters that are not `\"N\"`, `\"E\"`, `\"W\"`, or `\"S\"` (ignoring letter-casing) should be ignored.\n",
"\n",
"`travel(\"NW!ewnW\", (1, 2))` should return the tuple `(-1, 4)` following this sequence of movements:\n",
"\n",
"1. Start at `(1, 2)`.\n",
"1. Move `\"N\"` to `(1, 3)`.\n",
"1. Move `\"W\"` to `(0, 3)`.\n",
"1. Ignore `\"!\"` since it is not a valid direction.\n",
"Write and test a function `longest_token` that takes a string file path and returns a `tuple` of the longest token in the file and the line it appears on.\n",
"\n",
"A **token** is a sequence of characters separated by whitespace. If there are ties for the longest token, return the one that appears first in the file. If the file does not exist, the file is empty, or the file only contains whitespace, behavior is **undefined**: your program may do anything, including crash or throw an exception.\n",
"\n",
"For example, if we have a file `song.txt` with the following contents.\n",
"\n",
"```\n",
"Row, row, row your boat\n",
"Gently down the stream\n",
"Merrily, merrily, merrily, merrily\n",
"Life is but a dream!\n",
"```\n",
"\n",
"`longest_token(\"song.txt\")` should return `(\"Merrily,\", 3)`.\n",
"\n",
"To write additional test cases, create new text files. From the JupyterLab **File** menu, choose **New** and then **Text File**."
"Write and test a function `reformat_date` that takes three strings: a date string, an input date format, and an output date format. This function should return a new date string formatted according to the output date format.\n",
"\n",
"A **date string** is a non-empty string of numbers separated by `/`, such as `\"2/20/1991\"` or `\"1991/02/20\"`. The order of date fields (month, day, year) will depend on the date format, and the number of digits for each field can vary but there must be at least one digit for each field.\n",
"\n",
"A **date format** is a non-empty string of the date symbols `\"D\"`, `\"M\"`, `\"Y\"` separated by `/`. Assume the date string will match the date formats (share the same number of `/`s), that any date symbol in the output date format will also appear in the input date format, and that date formats do not duplicate date symbols.\n",
"The following calls do not satisfy the date string or date format requirements, so their behavior is undefined. You *do not* need to validate or test these cases.\n",
"\n",
"- `reformat_date(\"3/2\", \"M/D/Y\", \"Y/M/D\")` date string and input date format do not match.\n",
"- `reformat_date(\"3/2\", \"M/D\", \"Y/M/D\")` input date format missing a field present in the output date format.\n",
"- `reformat_date(\"1/2/3/4\", \"M/D/Y/S\", \"M/D\")` input date format contains a field that is not `\"D\"`, `\"M\"`, `\"Y\"`.\n",
"- `reformat_date(\"1/2/3\", \"M/M/Y\", \"M/Y\")` input date format contains a duplicate date symbol.\n",
"- `reformat_date(\"\", \"\", \"\")` date strings and date formats must be non-empty strings."
"Write and test a function `most_frequent` that takes a list of integers and returns the integer value that appears most frequently in the list. If there is more than one most frequent integer, return the one that appears first in the sequence. Assume the list has at least 1 value.\n",
"Double check that **each task has 2 of your own additional test cases**."
]
},
{
"cell_type": "code",
"execution_count": 24,
"id": "20b5051d-2f6c-440d-a44a-1b5911334eb6",
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"TestResults(failed=0, attempted=25)\n"
]
}
],
"source": [
"test_results = doctest.testmod()\n",
"print(test_results)\n",
"assert test_results.failed == 0, \"There are failed doctests.\"\n",
"assert test_results.attempted >= 25, \"Total number of doctests should be at least 25; less than 25 means you did not add two additional test cases per task.\""
In this assessment, you'll implement, document, and test a variety of unrelated functions to demonstrate your ability to apply control structures and data structures to solve problems involving numbers, text, and files. There's no realistic data science motivation or context for this assignment: it's just a grab-bag of questions. Future assessments will have more context.
For each question, you'll be asked to *write a function*, **document it** with a docstring, and **test** it with doctests added in the docstring. We've provided several input-output examples for each function.
The `run_docstring_examples` function call will *not* print anything if the function *passes all* the doctests you defined.
To fulfill the documentation requirements, use your own words to provide a brief description of only the details that a client needs to know to call the function. To fulfill testing requirements, convert each provided example into a doctest and **additionally write 2 more test cases of your own**. Be ready to justify and explain the design of all your work: how and why did you write each line of code?
Students are expected to follow Washington state law on the [Student Conduct Code for the University of Washington](https://www.washington.edu/admin/rules/policies/WAC/478-121TOC.html). In this course, students must:
- Indicate on your submission any assistance received, including materials distributed in this course.
- Not receive, generate, or otherwise acquire any substantial portion or walkthrough to an assessment.
- Not aid, assist, attempt, or tolerate prohibited academic conduct in others.
Update the following code cell to include your name and list your sources. If you used any kind of computer technology to help prepare your assessment submission, include the queries and/or prompts. Submitted work that is not consistent with sources may be subject to the student conduct process.
Write and test a function `is_relatively_prime` that takes two integer numbers `n` and `m` and returns `True` if and only if `n` and `m` are relatively prime to each other. Two numbers are relatively prime if they share no common factors besides 1. (1 is relatively prime with every number.) Assume the value of `n` and `m` are at least 1.
-`is_relatively_prime(12, 13)` returns `True` since the factors of 12 are 1, 2, 3, 4, 6, 12 and the factors of 13 are 1, 13.
-`is_relatively_prime(12, 14)` returns `False` since the factors of 12 are 1, 2, 3, 4, 6, 12 and the factors of 14 are 1, 2, 7, 14.
-`is_relatively_prime(5, 9)` returns `True` since the factors of 5 are 1, 5 and the factors of 9 are 1, 3, 9.
-`is_relatively_prime(8, 9)` returns `True` since the factors of 8 are 1, 2, 4, 8 and the factors of 9 are 1, 3, 9.
-`is_relatively_prime(8, 1)` returns `True` since we define that 1 is relatively prime with every number.
Do not use data structures to store factors during the execution of the algorithm, and use a single loop rather than nested loops.
Write and test a function `travel` that takes a string of north/east/south/west directions and a `tuple` indicating the starting `x, y` location on a grid. This function should return a `tuple` that indicates the new position after following the directions starting from the starting `x, y` location. The returned tuple should be in the format `(x_new, y_new)`. Assume we use integer coordinates where each direction increments or decrements a coordinate by 1.
The directions string will use `"N"` to indicate increasing the y-coordinate, `"E"` to indicate increasing the x-coordinate, `"S"` to indicate decreasing the y-coordinate, and `"W"` to indicate decreasing the x-coordinate. The case of the characters should be ignored. You can assume that `x` and `y` are both of type `int`. Any characters that are not `"N"`, `"E"`, `"W"`, or `"S"` (ignoring letter-casing) should be ignored.
`travel("NW!ewnW", (1, 2))` should return the tuple `(-1, 4)` following this sequence of movements:
1. Start at `(1, 2)`.
1. Move `"N"` to `(1, 3)`.
1. Move `"W"` to `(0, 3)`.
1. Ignore `"!"` since it is not a valid direction.
Write and test a function `longest_token` that takes a string file path and returns a `tuple` of the longest token in the file and the line it appears on.
A **token** is a sequence of characters separated by whitespace. If there are ties for the longest token, return the one that appears first in the file. If the file does not exist, the file is empty, or the file only contains whitespace, behavior is **undefined**: your program may do anything, including crash or throw an exception.
For example, if we have a file `song.txt` with the following contents.
```
Row, row, row your boat
Gently down the stream
Merrily, merrily, merrily, merrily
Life is but a dream!
```
`longest_token("song.txt")` should return `("Merrily,", 3)`.
To write additional test cases, create new text files. From the JupyterLab **File** menu, choose **New** and then **Text File**.
Write and test a function `reformat_date` that takes three strings: a date string, an input date format, and an output date format. This function should return a new date string formatted according to the output date format.
A **date string** is a non-empty string of numbers separated by `/`, such as `"2/20/1991"` or `"1991/02/20"`. The order of date fields (month, day, year) will depend on the date format, and the number of digits for each field can vary but there must be at least one digit for each field.
A **date format** is a non-empty string of the date symbols `"D"`, `"M"`, `"Y"` separated by `/`. Assume the date string will match the date formats (share the same number of `/`s), that any date symbol in the output date format will also appear in the input date format, and that date formats do not duplicate date symbols.
The following calls do not satisfy the date string or date format requirements, so their behavior is undefined. You *do not* need to validate or test these cases.
-`reformat_date("3/2", "M/D/Y", "Y/M/D")` date string and input date format do not match.
-`reformat_date("3/2", "M/D", "Y/M/D")` input date format missing a field present in the output date format.
-`reformat_date("1/2/3/4", "M/D/Y/S", "M/D")` input date format contains a field that is not `"D"`, `"M"`, `"Y"`.
-`reformat_date("1/2/3", "M/M/Y", "M/Y")` input date format contains a duplicate date symbol.
-`reformat_date("", "", "")` date strings and date formats must be non-empty strings.
Write and test a function `most_frequent` that takes a list of integers and returns the integer value that appears most frequently in the list. If there is more than one most frequent integer, return the one that appears first in the sequence. Assume the list has at least 1 value.
asserttest_results.failed==0,"There are failed doctests."
asserttest_results.attempted>=25,"Total number of doctests should be at least 25; less than 25 means you did not add two additional test cases per task."
