CPSC 217: Mini-Assignment 2B
Due at 4 PM. For assignment due dates see the main
schedule on
the course webpage.
New Concepts to be applied for the assignment
Function return values
If you want credit for your work: Do not
use any pre-created functions/methods unless you are given explicit
permission to do so. [Generic
list of allowable pre-created code in the form of python libraries]
Only new concepts that need to be applied in the assignment are
listed, concepts previously applied in other assignments may need to used in the
implementation of your solution.
Similar to the previous program knowing
your terminology is essential before starting this assignment. Write a
program that consists of 4 functions.
1) start():
the starting execution point of the program. All instructions not defined in the
other functions must be contained in the body of this function. The only
executable instruction outside the body of a function is the
call to run start
function. This is similar to how the
[second
example] functional decomposition lecture example redesigned the [first
example]. (Worth 1 GPA)
2) getInput():
the first function called by start().
It prompts and gets from the user a floating point number e.g. 5.59. This number is then returned back to the caller (the start
function). (Worth 1 GPA)
3) doubleIt():
the second function called by start().
Its input/parameter is the number returned by getInput() and
it returns a double of the parameter. The doubled number is returned to start(). (Worth
1 GPA)
3) display():
the third function called by start().
Its input/parameter is the number returned by doubleIt() and
this function displays that number to the console (text-based output) with two places of
precision for the rational portion using a format specifier. (Worth 1 GPA)
Summary of functions to define:
Function name |
Inputs/parameters |
Return values |
Responsibility of
the function |
getInput() |
None |
Float (numeric
assumed) |
Prompt for and gets
the user to enter a number, return that number back to the caller of the
function. |
doubleIt() |
Float (numeric
assumed) |
Float (numeric
assumed) |
Takes a number as a
parameter, return the double of that number. |
display() |
Float (numeric
assumed) |
None |
Takes a number as a
parameter, display the number to the console (screen) with 2 places
of precision. In mathematics the precision of a number specifies
the number of digits to right of the decimal. |
start() |
None |
None |
Starting execution
point of the program, contains the calls to the other 3 functions in the
following order: getInput(),
doubleIt(),
display().
For this program the only function that calls the other 3
functions is start.
(This may not be the case with the other programs that you write). |
How to do determine 'how you
did' on an assignment?
Program functionality (implementing working
program features)
-
Test your program: Because the
assignment description (along with required features) is posted ahead of
time if you test your program thoroughly before submitting the final
version then you should get a pretty clear idea of "how you will do".
Although it won't affect your grade for mini-assignments you should still
practice applying good style in your solution as well as writing
documentation. It will keep your skills for the full assignments (when you will
be graded on these things) and get you used to having good habits.
- Naming conventions: You should employ
good naming conventions for identifiers (variables and constants) as covered
in the "Introduction to programming" section of the course.
- Named constants should be used as
appropriate.
- Python documentation: This should be
specified in the header of the program (very top of your program in the form
of Python documentation). The basics of documentation were covered in the
"Intro to programming" section of the course. Later sections may include
additional details.
- Identifying
information:
All assignments should include contact information (full name, student
ID number and tutorial section [Here's
a Link
if you don't know how to find this information])
at the very top of your program.
- Program version.
(version date or version number).
- Under the
version you should specify which assignment features were
implemented in that version. An example covering the use of program
versioning and documentation was covered in the "Introduction to
programming" lectures.
-
Any program limitations or weaknesses.
- In general: The program output and the
program code itself (python program) must be properly aligned and formatted
including whitespace as needed to group related parts and separate sections
(which again was covered in the "Intro to programming" lectures of the
course. Additional requirements in the formatting of output may be included
in the "Functional requirements"
section of the assignment.
- Finally your program should follow
the 6 rules of thumb for designing software (Jakob
Nielsen's 10 usability heuristics)
which were included at the final set of notes on 'Repetition' e.g. prompts to the user to
enter the required information should be clear to the user as to what is
required, good error messages should be provided for erroneous input etc.
.
Failing to use this exact name will affect your grade by -0.2 GPA.
What to submit:
If your submission won't run using Python 3.x on any computer then it won't be
awarded credit.
It's up to you if you wish use a graphical program builder other than IDLE (or another development
environment rather than a simple text editor) to write/run your programs but
regardless you must submit your program in the form of a text ".py"
file or files. Also if you run into problems using another
editor then you may be "on your own" because we only have the ability to
support one development tool which is IDLE.
-
All computer users: Be careful that you actually
submit the file containing your program and not a related file, here's one
example of a problem: operating systems sometimes create a "lock file"
[Description of a lock file for Windows users] [Description for UNIX users -
may apply to MAC-OS].
- Tam's brief explanation of a lock file: These files are created when
a file is being edited to prevent multiple users or programs from trying to
edit that file. (Names of lock files typically include the file being edited
but include a tilde character in the name e.g. the file being edited is 'a1.py' so
the lock file is named '~a1.py'. Because the lock files do not contain the
actual data take care that you don't accidentally submit the lock file
instead of the file (some students have actually done this).
Windows users: take care that you don't accidentally submit a
[shortcut to a
file] instead of the actual file. (Check the file name and compare the file
size to your original file. Simply downloading the shortcut file as a test
won't work because that shortcut will work on your computer but not on
anyone else's machine and this may mean your work won't be graded.)
MAC-users: this
operating system has an equivalency to Windows shortcuts (e.g. symbolic
links but since creating them is a little more involved, typing at a command
line "ln
-s <target file name>" it's
less likely that this problem will come up).
Before the due
date, late assignments or
components of assignments/assignment extensions: Due dates/due
times are
strict and extensions require documentation (e.g. a note from a medical
doctor) in order to get permission from
the [course
instructor]. If/when permission is awarded for a late submission then I
will let the marker know that the regular penalty will not be applied.
When you ask for an extension you need to specify the name of the
TA in the tutorial that you are officially registered.
Alternate submission mechanisms to D2L (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/time is
what will be marked,
everything else will be awarded no credit. The final cut off date after
which full assignments will not be accepted is after the [maximum
progressive penalty (listed below)] can
be applied.
Questions or
concerns about grades after they have been released: Assignments will be
marked by your tutorial instructor (the "Teaching Assistant" or "TA") in the
[tutorial
section] you are officially registered in. If
you don't know which tutorial section you are officially registered in then
you can find this information in the Student Center in the [PeopleSoft
university portal]. 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 of
course talk to your [course
(lecture) instructor] but please indicate in your
email that you first contacted your TA before going into your concerns.
How you will be graded for mini-assignments.
Similar to many mini-assignments the grading is simple and doesn't require
a separate spreadsheet. Instead you can look in D2L
under Assessments->Dropbox and
then clicking on the appropriate assignment link.
Collaboration:
Assignments must reflect individual work;
group work is not allowed in this class nor can you copy the work of
others. Some obviously "do nots" for your solution:
don't publically post
it, don't email it out, don't show it to other students nor should you verbally
discuss it. For more detailed information as to what constitutes academic
misconduct (i.e., cheating) for this course please read the following [link].
Method of submission:
Reminder: You are to submit your assignment using D2L Here's a UC-IT
created [D2L
help resource] .
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, it is
the correct file 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). If don't check and there were problems with the submission then you
should not expect that you can "learn your lesson" and simply resubmit Whatever
you submitted into D2L by the final due date (and due time) is what will be marked.
-
Do not use compression utilities (such as zip) or archiving utilities
(such as tar) otherwise your submission may not be marked. The space savings
in D2L is not worth the extra time required by the marker to process each
submission.
-
How often can you submit: Multiple
submissions are allowed for this assignment: You can (and really should)
submit work as many times as you wish before the due date. However
only the latest file submitted is the one 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).
-
What to submit: Python programs only (file name ends in .py)
Any other type of file will be rejected by D2L.
Late
submissions for full assignments when there is no extension granted: Make
sure you give yourself enough time to complete the submission process so
you don't get cut off by D2L's deadline (or your submission will be
automatically flagged as late by D2L and it will be graded appropriately)..
Submission received: |
On time |
Hours late : >0 and <=24 |
Hours
late: >24
and <=48 |
Penalty: |
None |
-1 GPA |
-No
credit (not accepted) |
Unless otherwise told you
are to write the code yourself and not use any pre-created functions (or
methods). For most assignments the usual acceptable functions include: print(), input() and
the 'conversion' functions such as int(), float(), str(),
in(), range().
Look at the particular assignment description for a list of other
functions/methods that you are allowed to use and still get credit in an
assignment submission. If it's not listed then you should assume that you won't
be able use the function and still be awarded credit.