CPSC 217: Mini-Assignment 4a
Due at 4 PM. For assignment due dates see the
main schedule on the course webpage.
The program must be written and run under python version 3.X.
New Concepts to be applied for the assignment
Functional requirements
To get
credit for this assignment you must use the starting
code in the program '6creatingARandomList_listParameterAndReturn'
(covered in tutorial the week of May 31- June 6). Augment the starting program
by adding two additional functions (you will awarded no credit if you don't
define and use the functions as specified).
-
getFindAndReplaceCharacters(): prompts the user
to enter two characters 'findChar'
,'replaceChar'
(strings of length one) and returns them back to the caller which is the
start() function.
You can assume that the user entered strings of the correct length so your
program doesn't need to verify. (Worth
1.0 GPA)
-
findAndReplace():
Takes the two characters entered by the user and traverses the list and
replaces all instances of the "find character" with the "replacement
character" in the list called 'aList'.(Worth
3.0 GPA) To get credit for this feature the
program must call the display()
function before calling this function as well as immediately afterward so
the marker can quickly verify that your program is correct. [Example output
showing the display of the list before and after the replacement].
You should still practice applying good style in your solution as
well as writing documentation. Unlike the full assignments you will be just
graded on program functionality for the mini-assignments.
- Header documentation (very top in the form of
Python documentation):
- Contact information (your name,
student identification number and tutorial number).
- What does the program do.
- What are its limitations e.g. the program doesn't
perform type checking (crashes when non-numeric information is entered).
- The version number of the program (dates are
acceptable).
- Inline documentation: list the features of each
room that were implemented in a particular function e.g. living room:
display menu options continuously, can pick up the string
- Naming conventions: You should employ good naming conventions for
identifiers (variables, constants, function names, program file names).
- Named constants should be used as appropriate.
- The program code should have appropriate white
space (specified in the "Intro to programming lecture') and alignment
(specified throughout the lecture notes).
-
Code is self documenting e.g. Clear expressions (e.g. mathematical,
Boolean).
-
Of course if a student implements an extreme case
of inefficient code (e.g. multiple loops or branches are used when one will
do) then penalties may be applied but this is generally rare.
- Your program should follow the 5 rules of
thumb for designing user friendly software (Jakob
Nielsen's 10 usability heuristics) which were
included at the notes on 'Repetition' e.g. good error handling (such as
prompts to the user to enter the required information clearly indicate what
is required, good error messages should be provided for erroneous input)
minimizing the user's memory load, being consistent, providing clearly
marked exit & providing feedback as appropriate.
- Function specific:
Functions are one screen in length (normal screen resolution say ~30 lines
max of code (excludes whitespace and documentation).
- Function specific: Functions implement one well
defined task (e.g. processLivingRoomCommands() vs. processlivingRoomRunIntroductionRunConclusion()).
- Function specific: Code in one function is not
duplicated in another function (not in the notes but this is just common
sense that you don't write two functions where there's overlapping code -
the overlap should likely be taken out of both functions and moved to
another separate function).
- Function specific: No global variables (unless you
have a compelling reason that you have justified to the course instructor or
something explicitly allowed such as a debugging flag).
Submitting your work:
- The document must be electronically submitted
using D2L. This
applies to on-time or late submissions.
- D2L configuration for this course
- Multiple submissions are allowed for this assignment: You can (and
really should) submit work as many times as you wish before the due
date. Due dates are strict, only what is in D2L by the deadline is what
will be marked. Other methods of verifying that your work was completed
on time (e.g. checking timestamps, emailed files etc.) will NOT be
accepted.
- Multiple files can be submitted for this assignment (e.g.
A1_version1_May7, A1_version2_May8 etc.) Consequently all versions of
your submissions will be retained. However only the latest versions of
each individual document (for assignments that require multiple files to
be submitted) are the ones that will be marked, everything else will be
ignored (because it is not fair to your marker to sort through multiple
versions of your files).
- Do not use compression utilities (such as zip) or archiving utilities
(such as tar) otherwise your submission may not be marked.
- Make sure that you [check
the contents of your submitted files] (e.g., is the file okay or was it
corrupted, is it the correct version etc.). It's your responsibility to do
this! (Make sure that your submit your assignment with enough time before it
comes due for you to do a check)
Marking
-
Assignments will be marked by your tutorial instructor (the "Teaching
Assistant" or "TA") for your
tutorial section. When you have questions about marking this is the first
person that you should be directing your questions towards. If you still
have question after you have talked to your TA, then you can talk to your
course (lecture) instructor.
-
Because this is a simple mini-assignment there isn't a marking spreadsheet.
If you were awarded full marks then you will see your grade point in D2L
(4.0). If you were awarded less than full credit then your marker will enter
some brief comments that described where you went wrong into the D2L Dropbox
for this component.
Points to keep in mind:
-
Due time:
All assignments are due at 4 PM on the
due dates
listed on the course web page. Late assignments or components of
assignments will not be accepted for marking without approval for an
extension beforehand. Alternate submission mechanisms (non exhaustive list
of examples: email, uploads to cloud-based systems such as Google drive,
time-stamps, TA memories) cannot be used as alternatives if you have
forgotten to submit work or otherwise have not properly submitted into D2L.
Only files submitted into D2L by the due date is what will be
marked, everything else will be awarded no credit.
-
Method of submission:
You are to submit your assignment using D2L [help
link].
Make sure that you [check
the contents of your submitted files]
(e.g., is the file okay or was it corrupted, is it the correct version
etc.). It's your responsibility to do this! (Make sure that you submit your
assignment with enough time before it comes due for you to do a check).
-
Identifying information:
All assignments should include contact information (full name, student ID
number and tutorial section) at the very top of your program in the class where the 'main()'
method resides (starting execution point). (Note other documentation is also required for most
assignments).
-
Collaboration:
Assignments must reflect individual work;
group work is not allowed in this class nor can you copy the work of
others. For more detailed information as to what constitutes academic
misconduct (i.e., cheating) for this course please read the following [link].
- Execution:
programs must run on the computer science network (if applicable during that
particular semester) running Python 3.x. If you
write you code in the lab and work remotely using a remote login program
such as Putty or SSH then you should be okay (assuming you don't login to a
non-Linux computer). If you choose to install Python on your own computer
then it is your responsibility to ensure that your program will run properly
here. If it won't run using Python 3.x then it
won't be awarded credit. It's up to you if you wish use the graphical
program builder IDLE to write/run your programs but if you do you submit your program in the form of
text ".py" file or files.
-
Use of pre-created Python
libraries:
unless otherwise told you are to write the code yourself and not use any
pre-created functions. For this assignment the usual
acceptable functions include:
print(),
input()
and the 'conversion' functions such as
int(),
float(),
str(). Look at the particular assignment description for a list of other
classes that you are allowed to use and still get credit in an assignment
submission.
-
Extensions
may be granted for reasonable cases by the course instructor with the
receipt of the appropriate documentation (e.g., a sworn declaration with a
commissioner of oaths). Typical
examples of reasonable cases for an extension include: illness or a death in
the family. Example cases where extensions will not be granted include situations
that are typical of student life: having multiple due dates, work
commitments etc. Tutorial instructors (TAs) will not be able to provide
extension on their own and must receive permission from the course
instructor first.
-
Questions about marking: Your Teaching
Assistants will be marking the assignments so I will first direct your
questions to them regarding the marking
-
Late submissions (no extension granted):
|
Submission received: |
On time |
Hours late : >0 and <=24 |
Hours
late: >24
and <=48 |
Hours
late: >48
and <=72 |
Hours
late: >72
and <=96 |
Hours
late: >96 |
|
Penalty: |
None |
-1
GPA |
-2
GPA |
-3
GPA |
-4
GPA |
No |