Difference between revisions of "OPS435 Online Assignment 1"

From CDOT Wiki
Jump to: navigation, search
(Due Date and Final Submission requirement)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
[[Category:OPS435-Python]][[Category:rchan]]
 
[[Category:OPS435-Python]][[Category:rchan]]
 
= Overview =
 
= 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.
+
When applying for a bank account, accepting a job, or some other activity that is personal, it may involve the processing of someone's date of birth. It is critical for this type of data to be validated before being processed by a computation system.
  
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 two dates in the "DD-MM-YYYY" format and return the number of days from the first to the second date. That is, if the user enters "18-06-2020" and "25-06-2020", the script will return "7". Similarly, if the target date is in the past, the script will return a negative number.
+
The task for this assignment is to design an <b>algorithm</b> and write a python script to validate a given string in various forms as the date of birth of someone and convert it into a standard format. The DOB (date of birth) conversion script should take a date in one of the following four formats: "YYYYMMDD", "YYYY/MM/DD", "YYYY-MM-DD", and "YYYY.MM.DD" format and return the date in a standard format: 'mmm d, yyyy", where "mmm" is the three letter abbreviated month's name, 'd' is a one or two-digit day of the month, and 'yyyy' is the four-digit year. That is, if the user enters "20210604", or "2021-06-04", or "2021/06/04", or "2021.06.04", the script will return "Jun 4, 2021". More examples to follow.
 
 
In addition, if the user enters one date only, then the number returned should be the number of days between today's date and the specified date.  
 
  
 
= Assignment Requirements =
 
= Assignment Requirements =
== The First Milestone ==
+
== The First Checkpoint (Jun 9) ==
* Before you begin programming, it is important to plan your algorithm. Therefore your first task will be to complete and submit an algorithm document. This document should be named '''algorithm_[student_id].txt'''. This file should be plaintext. The document will contain two sections:
+
* Before you begin coding in Python, it is important to plan your algorithm. Therefore your first task will be to complete and submit an algorithm document. This document should be named '''algorithm_[Seneca_name].txt'''. This file should be plaintext. The document will contain two sections:
  * A description of how the "after()" function works. The "after()" function is provided to you in a1_template.py. Open the file, and use clear English to describe what line of code does in such a way that a competent programmer could reproduce the code without seeing it firsthand.
+
:* A description of how your main program works. The main program flow is provided to you in a1_template.py. Open the file, and use clear and simple English to describe what each line of code does in such a way that a competent Python coder could reproduce the code without seeing it first hand.
  * You will then apply the same principles to create an algorithm for "before()", and "dbda()". Inside the code, if you are calling another function like "leap_year", you may simply describe what the function will return, and not the operation of the function itself.  
+
:* You will then apply the same principles to create an <b>algorithm</b> for each validation function named in the a1_template.py file. Inside the code, if you are calling another function like "leap_year()", you may simply describe what the function will return, and not the operation of the function itself.  
* This file will be submitted to Blackboard a week after the assignment goes live, and should be your first priority. The object of the milestone is not to have a 100% perfect algorithm, but to plan ahead and anticipate challenges and issues with the assignment. The milestone will also give your professor an opportunity for feedback.
+
* This file should be submitted to Blackboard by Jun 9, 2021, and should be your first priority. The objective of the first checkpoint is not to have a 100% perfect algorithm, but to plan ahead and anticipate challenges and issues with the assignment. The first checkpoint will also allow your professor an opportunity to give you feedback before the assignment overall due date.
 
* [https://simple.m.wikipedia.org/wiki/Algorithm Here is an basic introduction to Algorithm]
 
* [https://simple.m.wikipedia.org/wiki/Algorithm Here is an basic introduction to Algorithm]
 
* 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.
 
* 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.)
+
* Since we don't think we are going to encounter someone who is 120 years or older, your algorithm can consider a date of birth before year 1900 as invalid. Could you think of other limits you should impose on someone's date of birth?
  
== The Assignment ==
+
== The 2nd Checkpoint - your drafted Python Script (Jun 16) ==
* As stated before, your code will be inside the file "a1_[studentid].py". The first step will be to clone the Assignment 1 repository. The invite link will be provided to you by your professor. Once you clone the repository, you will rename "a1_template.py" and begin writing the content that is required. Additional requirements are outlined below.
+
* As stated before, your code will be inside the file "a1_[Seneca_name].py". The first step will be to clone the Assignment 1 template repository (https://github.com/rayfreeping/ops435-a1). Once you clone the repository, run this command: "cp a1_template.py a1_[Seneca_name].py". (Replace Seneca_name with your Seneca account user name). Begin coding your algorithm into Python code that is required. Additional requirements are outlined below.
 +
* Your should update the author and date information in your Python script.
 +
* Your Python script file a1_[Seneca_name].py should be submitted to Blackboard by Jun 16, 2021. * The script doesn't have to be perfect and error free. However, it shouldn't contain any syntax errors when executed.
 +
* This intern submission is just to show that you are actively working on your assignment.
  
== The Debrief ==
+
== The Final submission with preliminary test results (Jun 21) ==
This document, like the algorithm document, will be submitted to Blackboard one week after the assignment. Answer the following questions:
+
* Run the preliminary test script named "checkA1.py" in the "tests" sub-folder of the ops435-a1 repository mentioned above.
* Research Python modules that you could have used to accomplish the same goals as the today() and leap_year() functions.  
+
* Please read the readme.txt in the tests sub-folder for more information on the purpose of the preliminary test script.
* Which solution is preferable, in terms of performance? Which solution is preferable, in terms of programmer hours? (which solution would take longer for a programmer to implement?)
+
* When your are satisfy with the test result, capture the test result to a file named a1_pretest.txt and submit it together with your Python script a1_[Seneca_name].py to Blackboard by Jun 21, 2021.
* Which approach would be preferable in the "real world"? Why is it useful to try creating our own algorithm?
 
* What challenges did you encounter during the assignment, and what resources did you use to solve your issues? (help from classmates, help from Stackoverflow, debuggers, etc.)
 
* Additionally, your professor may have questions specific to your submission. You should answer these questions as well.
 
  
== Assignment Requirements ==
+
== Python Coding Requirements ==
 
=== Required Modules and Functions ===
 
=== Required Modules and Functions ===
<b><font color='blue'>Your python script is allowed to import only the <u>os, subprocess and sys</u> modules from the standard library and all the built-in functions.</font></b>
+
<b><font color='blue'>Your python script is allowed to call all the built-in functions and the functions imported from the <u>os, subprocess and sys</u> modules from the standard library.</font></b>
 
 
Based on the algorithm you have designed for this assignment, you should at least have the following four 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()
 
* after()
 
* before()
 
* today()
 
  
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:
+
Based on the algorithm you have designed for this assignment, you should at least have the following five functions defined in your python script (see later section on the purpose of each function):
* days_in_mon()
 
 
* leap_year()
 
* leap_year()
* valid_date()
+
* range_check()
 +
* sanitize()
 +
* size_check()
 
* usage()
 
* usage()
  
Line 49: Line 42:
  
 
=== Command Line Argument to be supported ===
 
=== Command Line Argument to be supported ===
* You will provided with a file called a1_template.py.
+
* Your Python script must accept only one command line argument: date. Input date in the following format with correct values of YYYY, MM, and DD should be considered as valid input data:
* Rename this python script as a1_[student_id].py, where [student_id] is your Seneca email user name.
+
** <code>YYYYMMDD</code>
* Your python script must support one or two command line arguments only: both should be valid dates in DD-MM-YYYY format.  
+
** <code>YYYY/MM/DD</code>
* If there are no arguments, more than two arguments, or an invalid date, your script should display the correct usage message and exit.
+
** <code>YYYY-MM-DD</code>
 +
** <code>YYYY.MM.DD</code>
 +
* If there are no argument, more than one argument, or an invalid year, month, or day, your script should display the appropriate usage message, error code, and exit.
  
 
=== Documentation ===
 
=== 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 describe 'what' the function does, not 'how' it does.
+
* Please use python's docstring to document your python script  
* Refer to the docstring for after() to get an idea of the function docstrings required.
+
** script level documentation, and  
 +
** function level documention for each function you created for this assignment.  
 +
* The docstring should describe 'what' the function does, not 'how' it does.
  
 
=== Authorship Declaration ===
 
=== Authorship Declaration ===
Line 62: Line 59:
  
 
=== Github Commits ===  
 
=== Github Commits ===  
You will be graded partly on the quality of your Github commits. Professionals generally follow these guidelines:
+
You will be graded partly on the quality and transaction activities of your Github commits. Professionals generally follow these guidelines:
 
* commit their code after every significant change,  
 
* commit their code after every significant change,  
* the code should run without errors after each commit, and
+
* the code should run without syntax errors after each commit, and
 
* every commit has a descriptive commit message.
 
* every commit has a descriptive commit message.
These guidelines are not always possible, but you will be expected to follow these guidelines as much as possible. Break your problem into smaller pieces, and work iteratively to solve each small problem. Test your code after each small change you make, and address errors as soon as they arise. It will make your life easier!  
+
These guidelines are not always possible, but you are expected to follow these guidelines as much as possible. Break the assigned task into smaller pieces, and work iteratively to solve each small task. Test your code after each small change you made, and address errors as soon as they arise. It will make your coding life easier!
  
 
== Tests and Test results ==
 
== 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 "YYYY-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 "YYYY-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:
+
You must name your python 3 script as <code>a1_[Seneca_name].py</code>. The following examples assumes that the Seneca_name is rchan. The script should accept one command line argument, the argument can be either in "YYYYMMDD", "YYYY/MM/DD", "YYYY-MM-DD", or "YYYY.MM.DD" format. If the input data does not represent a real date, your script should give an appropriate error message. Invalid months (>12) or invalid days of month(different for each month, and if the month is February, the year matter too), should be detected and give appropriate error messages. For examples:
* <b><code>python3 a1_rchan.py 01-01-2019 02-01-2019</code></b>, and the output should be<br />
+
* <b><code>python3 a1_rchan.py 2020-10-10</code></b>, and the output should be<br />
     1
+
     Oct 10, 2020
* <b><code>python3 a1_rchan.py 01-01-2019 31-12-2018</code></b>, and the output should be<br />
+
* <b><code>python3 a1_rchan.py 2020-10-09</code></b>, and the output should be<br />
     -1
+
     Oct 9, 2020
* <b><code>python3 a1_rchan.py 01-06-2020</code></b>, and since today is June 3, the output should be<br />
+
* <b><code>python3 a1_rchan.py 2020-06-30</code></b>, and the output should be<br />
     2
+
    Jun 30, 2020
* <b><code>python3 a1_rchan.py 01-01-2019 01-01-2020</code></b>, and the output should be<br />
+
* <b><code>python3 a1_rchan.py 20201010</code></b>, and the output should be<br />
     365
+
    Oct 10, 2020
* <b><code>python3 a1_rchan.py 01-01-2021 01-01-2020 </code></b>, and the output should be<br />
+
* <b><code>python3 a1_rchan.py 2020/10/10</code></b>, and the output should be<br />
     -366
+
     Oct 10, 2020
* <b><code>python3 a1_rchan.py 01-13-2018</code></b>, and the output should be<br />
+
* <b><code>python3 a1_rchan.py 2020.02.29</code></b>, and the output should be<br />
     Error: wrong month entered
+
     Feb 29, 2020
* <b><code>python3 a1_rchan.py 99-01-2020 01-01-2020</code></b>, and the output should be<br />
+
* <b><code>python3 a1_rchan.py 2019.02.29</code></b>, and the output should be<br />
     Error: wrong day entered
+
     Error 03: wrong day entered
* <b><code>python3 a1_rchan.py 2018 2</code></b>, and the output should be<br />
+
* <b><code>python3 a1_rchan.py 2019.13.12</code></b>, and the output should be<br />
     Error: wrong date entered
+
     Error 02: wrong month entered
 +
* <b><code>python3 a1_rchan.py 2019.06.31</code></b>, and the output should be<br />
 +
     Error 03: wrong day entered
 +
* <b><code>python3 a1_rchan.py 201802</code></b>, and the output should be<br />
 +
    Error 09: wrong date entered
 +
* <b><code>python3 a1_rchan.py 18981225</code></b>, and the output should be <br />
 +
    Error 10: year out of range, must be 1900 or later
 +
* <b><code>python3 a1_rchan.py 18981299</code></b>, and the output should be <br />
 +
     Error 10: year out of range, must be 1900 or later
 +
* <b><code>python3 a1_rchan.py 189802</code></b>, and the output should be<br />
 +
    Error 09: wrong date entered
 +
 
  
If there is too few or too many command line arguments given, display the proper usage:
+
If there is too few or too many command line argument given, display the proper usage:
* <code>Usage: a1_rchan.py DD-MM-YYYY [DD-MM-YYYY] >/code>
+
* <code>Usage: a1_rchan.py YYYYMMDD|YYYY/MM/DD|YYYY-MM-DD|YYYY.MM.DD </code>
  
 
== Script structure and sample template ==
 
== Script structure and sample template ==
  
 
The following is a brief description of each function:
 
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 "YYYY-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 after() function or the before() function.
 
* The today() function will be called if the user has not specified a second argument. It will return '''your Linux computer's local time''' in the format DD-MM-YYYY. Hint: you may need to read man pages for a shell command in order to return a usable date. You may also use string formatting to modify output.
 
* The before() function will take a date in "YYYY-MM-DD" format and return the date of the previous day in the same format.
 
* The after() function will take a date in "YYYY-MM-DD" format and return the date of the next day in the same format. Next paragraph is a sample python code for the after() function. To earn the maximum possible mark for the assignment, you should modify the sample after() 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 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 "YYYY-MM-DD" format, and return True if the given date is a valid date, otherwise return False plus an appropriate status message. The valid_date() function should make use of the days_in_mon() function.
+
* The range_check() function will take an integer object and a tuple with two integer values, the first value indicates the lower bound and the second one indicates the upper bound of a integer range. If the integer object falls in between the range given in the tuple, return 'True', otherwise return 'False'.
* 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 for the given year. The days_in_mon() function should make use of the leap_year() function.
+
* The sanitize() function will take two string objects, the first string object is the object to be sanitized, and the 2nd string object contains letters that are allowed. This function will return the first object with letters not in the 2nd string object removed.
 +
* The size_check() function will take an collection data type object and expected number of items as an integer and will return either 'True' or 'False'. If the number of items in the data object match the integer value given, return 'True', otherwise return 'False'
 
* The usage() function will take no argument and return a string describing the usage of the script.
 
* The usage() function will take no argument and return a string describing the usage of the script.
 
=== Sample code for the after() function ===
 
<pre>
 
# Return the date in YYYY-MM-DD after the given day
 
#
 
def after(today):
 
    if len(today) != 10:
 
      return '0000-00-00'
 
    else:
 
      str_year, str_month, str_day = today.split('-')
 
      year = int(str_year)
 
      month = int(str_month)
 
      day = int(str_day)
 
 
      lyear = year % 4
 
      if lyear == 0:
 
          feb_max = 29 # this is a leap year
 
      else:
 
          feb_max = 28 # this is not a leap year
 
 
      lyear = year % 100
 
      if lyear == 0:
 
          feb_max = 28 # this is not a leap year
 
 
      lyear = year % 400
 
      if lyear == 0:
 
          feb_max = 29 # this is a leap year
 
 
      tmp_day = day + 1 # 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}
 
      if tmp_day > mon_max[month]:
 
          to_day = tmp_day % mon_max[month] # if tmp_day > this month's max, reset to 1
 
          tmp_month = month + 1
 
      else:
 
          to_day = tmp_day
 
          tmp_month = month + 0
 
 
      if tmp_month > 12:
 
          to_month = 1
 
          year = year + 1
 
      else:
 
          to_month = tmp_month + 0
 
 
      next_date = str(year)+"-"+str(to_month).zfill(2)+"-"+str(to_day).zfill(2)
 
   
 
      return next_date
 
</pre>
 
  
 
= Rubric =
 
= Rubric =
Line 160: Line 116:
 
| Check script passed || 30 ||
 
| Check script passed || 30 ||
 
|-
 
|-
| today() function design || 2 ||
+
| size_check() function design || 4 ||
 
|-
 
|-
| before() function design || 5 ||
+
| sanitize() function design || 4 ||
 
|-
 
|-
| dbda() function design || 10 ||
+
| leap_year() function design || 4 ||
 
|-
 
|-
| script level docstring || 5 ||
+
| range_check() function design || 4 ||
 
|-
 
|-
| leap_year() function design || 2 ||
+
| usage() function design || 4 ||
 
|-
 
|-
| valid_date() function design || 5 ||
+
| script level docstring || 5 ||
 
|-
 
|-
| usage() function design || 1 ||
+
| function level docstring || 5 ||
 
|-
 
|-
| First Milestone ||10||
+
| First Checkpoint ||10||
 
|-
 
|-
| Reflection Essay || 10 ||
+
| Second Checkpoint || 10 ||
 
|-
 
|-
 
| github.com repository: Commit messages and use ||15||
 
| github.com repository: Commit messages and use ||15||
Line 189: Line 145:
  
 
Please submit the following files by the due date:
 
Please submit the following files by the due date:
* [ ] your algorithm document, named as 'algorithm_username.txt', to Blackboard.
+
* [ ] your algorithm document, named as 'algorithm_[Seneca_name].txt', to Blackboard.
* [ ] your python script, named as 'a1_[seneca-id].py', should be included in your repository, and also '''submitted to Blackboard.'''
+
* [ ] your python script, named as 'a1_[Seneca_name].py', should be included in your repository, and also '''submitted to Blackboard.'''
* [ ] the output of the checking script checkA1.py, named as 'a1_output.txt', should be included in your repository.
+
* [ ] the output of the checking script checkA1.py, named as 'a1_pretest.txt', should be included in your repository, and also '''submitted to Blackboard.'''
* [ ] your debrief document should be submitted to Blackboard.
 

Latest revision as of 10:45, 3 June 2021

Overview

When applying for a bank account, accepting a job, or some other activity that is personal, it may involve the processing of someone's date of birth. It is critical for this type of data to be validated before being processed by a computation system.

The task for this assignment is to design an algorithm and write a python script to validate a given string in various forms as the date of birth of someone and convert it into a standard format. The DOB (date of birth) conversion script should take a date in one of the following four formats: "YYYYMMDD", "YYYY/MM/DD", "YYYY-MM-DD", and "YYYY.MM.DD" format and return the date in a standard format: 'mmm d, yyyy", where "mmm" is the three letter abbreviated month's name, 'd' is a one or two-digit day of the month, and 'yyyy' is the four-digit year. That is, if the user enters "20210604", or "2021-06-04", or "2021/06/04", or "2021.06.04", the script will return "Jun 4, 2021". More examples to follow.

Assignment Requirements

The First Checkpoint (Jun 9)

  • Before you begin coding in Python, it is important to plan your algorithm. Therefore your first task will be to complete and submit an algorithm document. This document should be named algorithm_[Seneca_name].txt. This file should be plaintext. The document will contain two sections:
  • A description of how your main program works. The main program flow is provided to you in a1_template.py. Open the file, and use clear and simple English to describe what each line of code does in such a way that a competent Python coder could reproduce the code without seeing it first hand.
  • You will then apply the same principles to create an algorithm for each validation function named in the a1_template.py file. Inside the code, if you are calling another function like "leap_year()", you may simply describe what the function will return, and not the operation of the function itself.
  • This file should be submitted to Blackboard by Jun 9, 2021, and should be your first priority. The objective of the first checkpoint is not to have a 100% perfect algorithm, but to plan ahead and anticipate challenges and issues with the assignment. The first checkpoint will also allow your professor an opportunity to give you feedback before the assignment overall due date.
  • Here is an basic introduction to Algorithm
  • 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.
  • Since we don't think we are going to encounter someone who is 120 years or older, your algorithm can consider a date of birth before year 1900 as invalid. Could you think of other limits you should impose on someone's date of birth?

The 2nd Checkpoint - your drafted Python Script (Jun 16)

  • As stated before, your code will be inside the file "a1_[Seneca_name].py". The first step will be to clone the Assignment 1 template repository (https://github.com/rayfreeping/ops435-a1). Once you clone the repository, run this command: "cp a1_template.py a1_[Seneca_name].py". (Replace Seneca_name with your Seneca account user name). Begin coding your algorithm into Python code that is required. Additional requirements are outlined below.
  • Your should update the author and date information in your Python script.
  • Your Python script file a1_[Seneca_name].py should be submitted to Blackboard by Jun 16, 2021. * The script doesn't have to be perfect and error free. However, it shouldn't contain any syntax errors when executed.
  • This intern submission is just to show that you are actively working on your assignment.

The Final submission with preliminary test results (Jun 21)

  • Run the preliminary test script named "checkA1.py" in the "tests" sub-folder of the ops435-a1 repository mentioned above.
  • Please read the readme.txt in the tests sub-folder for more information on the purpose of the preliminary test script.
  • When your are satisfy with the test result, capture the test result to a file named a1_pretest.txt and submit it together with your Python script a1_[Seneca_name].py to Blackboard by Jun 21, 2021.

Python Coding Requirements

Required Modules and Functions

Your python script is allowed to call all the built-in functions and the functions imported from the os, subprocess and sys modules from the standard library.

Based on the algorithm you have designed for this assignment, you should at least have the following five functions defined in your python script (see later section on the purpose of each function):

  • leap_year()
  • range_check()
  • sanitize()
  • size_check()
  • usage()

Coding Standard

Your python script must follow the following coding guide:

Command Line Argument to be supported

  • Your Python script must accept only one command line argument: date. Input date in the following format with correct values of YYYY, MM, and DD should be considered as valid input data:
    • YYYYMMDD
    • YYYY/MM/DD
    • YYYY-MM-DD
    • YYYY.MM.DD
  • If there are no argument, more than one argument, or an invalid year, month, or day, your script should display the appropriate usage message, error code, and exit.

Documentation

  • Please use python's docstring to document your python script
    • script level documentation, and
    • function level documention for each function you created for this assignment.
  • The docstring should describe 'what' the function does, not 'how' it does.

Authorship Declaration

All your Python code for this assignment must be placed in a single source python file. Please complete the declaration as part of the docstring in your Python source code file (replace "Student Name" with your own name).

Github Commits

You will be graded partly on the quality and transaction activities of your Github commits. Professionals generally follow these guidelines:

  • commit their code after every significant change,
  • the code should run without syntax errors after each commit, and
  • every commit has a descriptive commit message.

These guidelines are not always possible, but you are expected to follow these guidelines as much as possible. Break the assigned task into smaller pieces, and work iteratively to solve each small task. Test your code after each small change you made, and address errors as soon as they arise. It will make your coding life easier!

Tests and Test results

You must name your python 3 script as a1_[Seneca_name].py. The following examples assumes that the Seneca_name is rchan. The script should accept one command line argument, the argument can be either in "YYYYMMDD", "YYYY/MM/DD", "YYYY-MM-DD", or "YYYY.MM.DD" format. If the input data does not represent a real date, your script should give an appropriate error message. Invalid months (>12) or invalid days of month(different for each month, and if the month is February, the year matter too), should be detected and give appropriate error messages. For examples:

  • python3 a1_rchan.py 2020-10-10, and the output should be
    Oct 10, 2020
  • python3 a1_rchan.py 2020-10-09, and the output should be
    Oct 9, 2020
  • python3 a1_rchan.py 2020-06-30, and the output should be
    Jun 30, 2020
  • python3 a1_rchan.py 20201010, and the output should be
    Oct 10, 2020
  • python3 a1_rchan.py 2020/10/10, and the output should be
    Oct 10, 2020
  • python3 a1_rchan.py 2020.02.29, and the output should be
    Feb 29, 2020
  • python3 a1_rchan.py 2019.02.29, and the output should be
    Error 03: wrong day entered
  • python3 a1_rchan.py 2019.13.12, and the output should be
    Error 02: wrong month entered
  • python3 a1_rchan.py 2019.06.31, and the output should be
    Error 03: wrong day entered
  • python3 a1_rchan.py 201802, and the output should be
    Error 09: wrong date entered
  • python3 a1_rchan.py 18981225, and the output should be
    Error 10: year out of range, must be 1900 or later
  • python3 a1_rchan.py 18981299, and the output should be
    Error 10: year out of range, must be 1900 or later
  • python3 a1_rchan.py 189802, and the output should be
    Error 09: wrong date entered


If there is too few or too many command line argument given, display the proper usage:

  • Usage: a1_rchan.py YYYYMMDD|YYYY/MM/DD|YYYY-MM-DD|YYYY.MM.DD

Script structure and sample template

The following is a brief description of each 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 range_check() function will take an integer object and a tuple with two integer values, the first value indicates the lower bound and the second one indicates the upper bound of a integer range. If the integer object falls in between the range given in the tuple, return 'True', otherwise return 'False'.
  • The sanitize() function will take two string objects, the first string object is the object to be sanitized, and the 2nd string object contains letters that are allowed. This function will return the first object with letters not in the 2nd string object removed.
  • The size_check() function will take an collection data type object and expected number of items as an integer and will return either 'True' or 'False'. If the number of items in the data object match the integer value given, return 'True', otherwise return 'False'
  • The usage() function will take no argument and return a string describing the usage of the script.

Rubric

Task Maximum mark Actual mark
Program Authorship Declaration 5
Check script passed 30
size_check() function design 4
sanitize() function design 4
leap_year() function design 4
range_check() function design 4
usage() function design 4
script level docstring 5
function level docstring 5
First Checkpoint 10
Second Checkpoint 10
github.com repository: Commit messages and use 15
Total 100

Due Date and Final Submission requirement

Check with your professor for the due date for your section.

Please submit the following files by the due date:

  • [ ] your algorithm document, named as 'algorithm_[Seneca_name].txt', to Blackboard.
  • [ ] your python script, named as 'a1_[Seneca_name].py', should be included in your repository, and also submitted to Blackboard.
  • [ ] the output of the checking script checkA1.py, named as 'a1_pretest.txt', should be included in your repository, and also submitted to Blackboard.