1,760
edits
Changes
→Create a private repository on github.com under your account by cloning the sample repo
[[Category:OPS435-Python]][[Category:rchan]]
= Overview =
When making back up of data files or log files, it is a very common practice to name the backup directories and/or files based on the date the backup was done. In order to restore or locate the directory/file, we often need to find out the backup date from today's date.
The computational task for this assignment is to design an algorithm and write a python script according to your algorithm with appropriate functions. The script should take a date in the "YYYYMMDDYYYY-MM-DD" format and the number of days before or after the given date as the command line arguments, calculate and output to the standard output data channel the targeted date which is the number of day before or after the given date in the same format.
== Coding Standard ==
== Command Line Argument to be supported ==
* Name your python script as a1_[student_id].py, where [student_id] is your Seneca email user name.
* Your python script must support two mandatory command line arguments : (1) any valid date in YYYYMMDD YYYY-MM-DD format, (2) number of days before or after the given date, and one option flag: "--step"* If there are less or more than two command line arguments given on data items provided at the command line, your script should display the correct usage message and exit.
= Computation Requirements =
== Algorithm Design ==
* [https://simple.m.wikipedia.org/wiki/Algorithm Here is an basic introduction to Algorithm]* Write a step-by-step instructions in English on how to compute a date in "YYYYMMDDYYYY-MM-DD" format which is n days before or after a given date also in "YYYYMMDDYYYY-MM-DD" format.
* While you are working on the step-by-step instructions, note that there are different number of days in each month and some years have 365 days and some years have 366 days.
* You should also do some research to find out when we started using the Calendar in the current form. (This will pose a limit on the validity of your algorithm.)
Based on the algorithm you have designed for this assignment, you should at least have the following three functions defined in your python script (see later section on the purpose of each function) in order to get a passing grade for this assignment:
* dbda()
* tomorrowafter()* yesterdaybefore()
You should also create additional functions to improved the re-usability of your python code by adding the following functions to earn the maximum possible mark for this assignment:
* days_in_mon()
== Documentation ==
* Please use python's docstring to document your python script (script level documentation) and each of the functions (function level documentation) you created for this assignment. The docstring should describle describe 'what' the function does, not 'how' it does.* The following shows the docstring that was added to the tomorrowafter() function which provides the following information when called with help(tomorrowafter) in the python interactive shell:
<pre>
Help on function tomorrow after() in module rchan:
(END)
</pre>
== Authorship Declaration ==
All your Python code for this assignment must be placed in a <font color='red'><b><u>single source python file</u></b></font>. Please include the following declaration <b><u>as part of the docstring</u></b> in your Python source code file (replace "Student Name" with your own name):
<source>OPS435 Assignment 1 - Summer 2019Winter 2020Program: a1_[student_id].py (replace student_id with your Seneca User name)
Author: "Student Name"
The python code in this file (a1_[Student_id].py) is original work written by
"Student Name". No code in this file is copied from any other source
except those provided by the course instructor, including any person,
== Tests and Test results ==
You must name your python 3 script as <code>a1_[Student_id].py</code>. The following examples assumes that the student_id is rchan.The script should accept two command line arguments, the first one is the date in "YYYYMMDDYYYY-MM-DD" format, and the second one is the number of day from the given date, a positive value indicates the number of days after the given date, and a negative value indicates the number of days before the given date. There is an optional flag called --step which can be provided at the command line that makes the program print out all dates until the target date. If the "YYYYMMDDYYYY-MM-DD" format is broken, your script should give an appropriate error message. Invalid months (>12) or invalid days of month(different for each month), should be detected and give appropriate error messages. For examples:* <b><code>python3 a1_rchan.py 20190101 2019-01-01 1</code></b>, and the output should be<br /> 201901022019-01-02* <b><code>python3 a1_rchan.py 20190101 2019-01-01 -1</code></b>, and the output should be<br /> 201812312018-12-31* <b><code>python3 a1_rchan.py 20190101 2019-01-01 2</code></b>, and the output should be<br /> 201901032019-01-03* <b><code>python3 a1_rchan.py --step 20190101 2019-01-01 3</code></b>, and the output should be<br /> 201901022019-01-02 201901032019-01-03 201901042019-01-04* <b><code>python3 a1_rchan.py 20180701 2018-07-01 500</code></b>, and the output should be<br /> 201911132019-11-13* <b><code>python3 a1_rchan.py 20189901 2018-99-01 2</code></b>, and the output should be<br />
Error: wrong month entered
* <b><code>python3 a1_rchan.py 20180199 2018-01-99 2</code></b>, and the output should be<br />
Error: wrong day entered
* <b><code>python3 a1_rchan.py 2018 2</code></b>, and the output should be<br />
If there is too few or too many command line arguments given, display the proper usage:
* <code>Usage: a1_rchan.py [--step] YYYYMMDD YYYY-MM-DD +/-n</code>
== Script structure and sample template ==
Your code should all be in a single python file with at least the functions mentioned above: dbda(), tomorrowafter(), and yesterdaybefore(). To earn the maximum mark, you should also create additional functions into your algorithm, e.g.: leap_year(), days_in_mon, valid_date(), usage(), etc
The following is a brief description of each function:
* The dbda() function should be the main function of your script. The dbda() function will take a date in "YYYYMMDDYYYY-MM-DD" format, a positive or negative integer, and return a date either before or after the given date according to the value of the given integer in the same format. Your dbda() function should delegate the actual calculation of the target date to either the tomorrowafter() function or the yesterdaybefore() function. * The yesterdaybefore() function will take a date in "YYYYMMDDYYYY-MM-DD" format and return the date of the previous day in the same format.* The tomorrowafter() function will take a date in "YYYYMMDDYYYY-MM-DD" format and return the date of the next day in the same format. Next paragraph is a sample python code for the tomorrowafter() function. To earn the maximum possible mark for the assignment, you should modify the sample tomorrowafter() function to make use of the days_in_mon() function.
* The leap_year() function will take a year in "YYYY" format, and return True if the given year is a leap year, otherwise return False.
* The valid_date() function will take a date in "YYYYMMDDYYYY-MM-DD" format, and return True if the given date is a valid date, otherwise return Falseplus an appropriate status message. The valid_date() function should make use of the days_in_mon() function.* The days_in_mon() function will take a year in "YYYY" format, and return a dictionary object which contains the total number of days in each month of for the given year. The days_in_mon() function should make use of the leap_year() function.
* The usage() function will take no argument and return a string describing the usage of the script.
<pre>
#!/usr/sbin/env python3
''' docstring
'''
import ...
def tomorrowafter(today):
....
return next_day
def yesterdaybefore(today):
....
return previous_day
....
def dbda(yyyymmdddate,days):
...
setup loop: call tomorrow after() or yesterday before() as appropriate
return target_day
.. call dbda()
...
.. output the expected dateresult
</pre>
=== Sample code for the tomorrowafter() function ===
<pre>
# Return the date in YYYYMMDD YYYY-MM-DD after the given day
#
def tomorrowafter(today): if len(today) != 810: return '000000000000-00-00'
else:
str_year, str_month, str_day = today.split('-') year = int(today[0:4]str_year) month = int(today[4:6]str_month) day = int(today[6:]str_day)
lyear = year % 4
feb_max = 29 # this is a leap year
tmp_day = day + 1 # tomorrow's next day
mon_max = { 1:31, 2:feb_max, 3:31, 4:30, 5:31, 6:30, 7:31, 8:31, 9:30, 10:31, 11:30, 12:31}
to_month = tmp_month + 0
next_date = str(year)+"-"+str(to_month).zfill(2)+"-"+str(to_day).zfill(2)
return next_date
= Bonus task =
There is 10% bonus if you your script can also take two dates both in "YYYYMMDDYYYY-MM-DD" format and output the number of days between the given two dates.
e.g.
* <code>Calculate the number of days between "2018-03-01" and "2019-03-01" python3 a1_rchan.py 2018-03-01 2019-03-01 365* Calculate the number of days between "2019-03-01" and "2018-03-01" python3 a1_rchan.py 20180301 201903012019-03-01 2018-03-01 365< = Deliverable === Create a private repository on github.com under your account by cloning the sample repo==* clone the repository https://github.com/rayfreeping/ops435-a1 for useful resource, sample code and test scripts for this assignment.* name the cloned repository under your github account as 'ops435-a1'* invite 'rayfreeping' as one of the collaborator to your 'ops435-a1' repository* use this repository for developing the and keeping track of the following text/source code>files:** the algorithm for assignment 1 named "a1_algorithm.txt"** the python script for assignment 1 named "a1_[seneca-id].py"** the test results produce by the assignment checking script "checkA1.py". Name it as a1_results.txt* double check and make sure your ops435-a1 on github is configured as a private repository.
= Rubric =
| Program Options --step || 5 ||
|-
| tomorrowafter() function || 5 ||
|-
| yesterdaybefore() function || 15 ||
|-
| dbda() function || 10 ||
| script level docstring || 5 ||
|-
| leap_year() function || 10 5 ||
|-
| valid_date() function || 10 5 ||
|-
| days_in_mon() function || 10 5 ||
|-
| usage() function || 5 ||
|-
| Algorithm ||15||
|-
| github.com repository||15||
|-
|'''Total''' || 100 ||
|}
= Due Date and Final Submission Procedure requirement =
Check with your professor for the the due date for your section.
Please submit the following files to blackboard by the due date:* your algorithm (step-by-step instruction for solving the computation problem for this assignment in the English language), name the file as 'a1_algorithm.txt'* your python script, required test and test results to blackboard under name the file as 'a1_[seneca-id].py'* the output of the checking script checkA1.py, name the assignments sectionfile as 'a1_results. Please refer to txt'* the detail submission instruction given 'git log' output for your own repository 'ops435-a1' on Blackboardgithub.com, name the file as 'a1_gitlog.txt'
